diff --git a/internal/protocoltest/awsrestjson/api_client.go b/internal/protocoltest/awsrestjson/api_client.go index 3054ef4ef8d..d9dadb572a2 100644 --- a/internal/protocoltest/awsrestjson/api_client.go +++ b/internal/protocoltest/awsrestjson/api_client.go @@ -112,7 +112,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/awsrestjson/api_op_ConstantQueryString.go b/internal/protocoltest/awsrestjson/api_op_ConstantQueryString.go index dee24cd0c39..f0012b014d1 100644 --- a/internal/protocoltest/awsrestjson/api_op_ConstantQueryString.go +++ b/internal/protocoltest/awsrestjson/api_op_ConstantQueryString.go @@ -11,8 +11,8 @@ import ( // This example uses a constant query string parameters and a label. This simply // tests that labels and query string parameters are compatible. The fixed query -// string parameter named "hello" should in no way conflict with the label, -// {hello}. +// string parameter named "hello" should in no way conflict with the label, {hello} +// . func (c *Client) ConstantQueryString(ctx context.Context, params *ConstantQueryStringInput, optFns ...func(*Options)) (*ConstantQueryStringOutput, error) { if params == nil { params = &ConstantQueryStringInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go index a7000795b36..cae0c6e2b00 100644 --- a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go @@ -10,20 +10,13 @@ import ( ) // This operation has four possible return values: +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A BadRequest error. +// - A FooError. // -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A BadRequest -// error. -// -// * A FooError. -// -// Implementations must be able to successfully take a -// response and properly (de)serialize successful and error responses based on the -// the presence of the +// Implementations must be able to successfully take a response and properly +// (de)serialize successful and error responses based on the the presence of the func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go index c2107bb7a63..d9b52bc46a4 100644 --- a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go @@ -143,8 +143,8 @@ func TestClient_GreetingWithErrors_FooError_awsRestjson1Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on ':' - // and take only the first half of the string. For example, + // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on + // ':' and take only the first half of the string. For example, // 'ValidationException:http://internal.amazon.com/coral/com.amazon.coral.validate/' // is to be interpreted as 'ValidationException'. For an example service see Amazon // Polly. @@ -155,9 +155,9 @@ func TestClient_GreetingWithErrors_FooError_awsRestjson1Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // X-Amzn-Errortype might contain a URL and a namespace. Client should extract only - // the shape name. This is a pathalogical case that might not actually happen in - // any deployed AWS service. + // X-Amzn-Errortype might contain a URL and a namespace. Client should extract + // only the shape name. This is a pathalogical case that might not actually happen + // in any deployed AWS service. "RestJsonFooErrorUsingXAmznErrorTypeWithUriAndNamespace": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/awsrestjson/api_op_IgnoreQueryParamsInResponse_test.go b/internal/protocoltest/awsrestjson/api_op_IgnoreQueryParamsInResponse_test.go index 41c2eda1277..e64101ffd6d 100644 --- a/internal/protocoltest/awsrestjson/api_op_IgnoreQueryParamsInResponse_test.go +++ b/internal/protocoltest/awsrestjson/api_op_IgnoreQueryParamsInResponse_test.go @@ -27,8 +27,8 @@ func TestClient_IgnoreQueryParamsInResponse_awsRestjson1Deserialize(t *testing.T Body []byte ExpectResult *IgnoreQueryParamsInResponseOutput }{ - // Query parameters must be ignored when serializing the output of an operation. As - // of January 2021, server implementations are expected to respond with a JSON + // Query parameters must be ignored when serializing the output of an operation. + // As of January 2021, server implementations are expected to respond with a JSON // object regardless of if the output parameters are empty. "RestJsonIgnoreQueryParamsInResponse": { StatusCode: 200, @@ -39,9 +39,9 @@ func TestClient_IgnoreQueryParamsInResponse_awsRestjson1Deserialize(t *testing.T Body: []byte(`{}`), ExpectResult: &IgnoreQueryParamsInResponseOutput{}, }, - // This test is similar to RestJsonIgnoreQueryParamsInResponse, but it ensures that - // clients gracefully handle responses from the server that do not serialize an - // empty JSON object. + // This test is similar to RestJsonIgnoreQueryParamsInResponse, but it ensures + // that clients gracefully handle responses from the server that do not serialize + // an empty JSON object. "RestJsonIgnoreQueryParamsInResponseNoPayload": { StatusCode: 200, Body: []byte(``), diff --git a/internal/protocoltest/awsrestjson/api_op_JsonLists.go b/internal/protocoltest/awsrestjson/api_op_JsonLists.go index 23c04548eb2..f06e94a5233 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonLists.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonLists.go @@ -13,15 +13,10 @@ import ( // This test case serializes JSON lists for the following cases for both input and // output: -// -// * Normal JSON lists. -// -// * Normal JSON sets. -// -// * JSON lists of lists. -// -// * -// Lists of structures. +// - Normal JSON lists. +// - Normal JSON sets. +// - JSON lists of lists. +// - Lists of structures. func (c *Client) JsonLists(ctx context.Context, params *JsonListsInput, optFns ...func(*Options)) (*JsonListsOutput, error) { if params == nil { params = &JsonListsInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_JsonMaps_test.go b/internal/protocoltest/awsrestjson/api_op_JsonMaps_test.go index f694a165fef..f1dee2997a7 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonMaps_test.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonMaps_test.go @@ -525,8 +525,8 @@ func TestClient_JsonMaps_awsRestjson1Deserialize(t *testing.T) { }, }, }, - // Clients SHOULD tolerate seeing a null value in a dense map, and they SHOULD drop - // the null key-value pair. + // Clients SHOULD tolerate seeing a null value in a dense map, and they SHOULD + // drop the null key-value pair. "RestJsonDeserializesDenseSetMapAndSkipsNull": { StatusCode: 200, Header: http.Header{ diff --git a/internal/protocoltest/awsrestjson/api_op_NoInputAndNoOutput_test.go b/internal/protocoltest/awsrestjson/api_op_NoInputAndNoOutput_test.go index d3fd42da5de..d6f5edf130c 100644 --- a/internal/protocoltest/awsrestjson/api_op_NoInputAndNoOutput_test.go +++ b/internal/protocoltest/awsrestjson/api_op_NoInputAndNoOutput_test.go @@ -136,8 +136,8 @@ func TestClient_NoInputAndNoOutput_awsRestjson1Deserialize(t *testing.T) { Body []byte ExpectResult *NoInputAndNoOutputOutput }{ - // When an operation does not define output, the service will respond with an empty - // payload, and may optionally include the content-type header. + // When an operation does not define output, the service will respond with an + // empty payload, and may optionally include the content-type header. "RestJsonNoInputAndNoOutput": { StatusCode: 200, Body: []byte(``), diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go index 78304b99417..803ba7d7a5c 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go @@ -10,8 +10,8 @@ import ( "io" ) -// This examples serializes a streaming media-typed blob shape in the request body. -// This examples uses a @mediaType trait on the payload to force a custom +// This examples serializes a streaming media-typed blob shape in the request +// body. This examples uses a @mediaType trait on the payload to force a custom // content-type to be serialized. func (c *Client) StreamingTraitsWithMediaType(ctx context.Context, params *StreamingTraitsWithMediaTypeInput, optFns ...func(*Options)) (*StreamingTraitsWithMediaTypeOutput, error) { if params == nil { diff --git a/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go b/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go index 34719de714f..023aa3c1acd 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go +++ b/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example operation serializes a structure in the HTTP body. It should ensure -// Content-Type: application/json is used in all requests and that an "empty" body -// is an empty JSON document ({}). +// This example operation serializes a structure in the HTTP body. It should +// ensure Content-Type: application/json is used in all requests and that an +// "empty" body is an empty JSON document ({}). func (c *Client) TestBodyStructure(ctx context.Context, params *TestBodyStructureInput, optFns ...func(*Options)) (*TestBodyStructureOutput, error) { if params == nil { params = &TestBodyStructureInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go b/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go index 1eb34a51f0a..6542ea783fd 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go +++ b/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example operation serializes a payload targeting a structure. This enforces -// the same requirements as TestBodyStructure but with the body specified by the -// @httpPayload trait. +// This example operation serializes a payload targeting a structure. This +// enforces the same requirements as TestBodyStructure but with the body specified +// by the @httpPayload trait. func (c *Client) TestPayloadStructure(ctx context.Context, params *TestPayloadStructureInput, optFns ...func(*Options)) (*TestPayloadStructureOutput, error) { if params == nil { params = &TestPayloadStructureInput{} diff --git a/internal/protocoltest/awsrestjson/doc.go b/internal/protocoltest/awsrestjson/doc.go index a72780ac446..75637e8d2d6 100644 --- a/internal/protocoltest/awsrestjson/doc.go +++ b/internal/protocoltest/awsrestjson/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package awsrestjson provides the API client, operations, and parameter types for -// the API. +// Package awsrestjson provides the API client, operations, and parameter types +// for the API. // // A REST JSON service that sends JSON requests and responses. package awsrestjson diff --git a/internal/protocoltest/awsrestjson/document/document.go b/internal/protocoltest/awsrestjson/document/document.go index ceef9b1c75b..263d1aa2a20 100644 --- a/internal/protocoltest/awsrestjson/document/document.go +++ b/internal/protocoltest/awsrestjson/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/internal/protocoltest/ec2query/api_client.go b/internal/protocoltest/ec2query/api_client.go index 9ecd396150a..48a5837bc21 100644 --- a/internal/protocoltest/ec2query/api_client.go +++ b/internal/protocoltest/ec2query/api_client.go @@ -112,7 +112,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go b/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go index 76ad12414c8..d14b979adf4 100644 --- a/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go @@ -10,14 +10,9 @@ import ( ) // This operation has three possible return values: -// -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A BadRequest -// error. +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A BadRequest error. func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go index 3d3da6ab88e..1217627d25d 100644 --- a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go @@ -11,15 +11,10 @@ import ( ) // This test serializes timestamps. -// -// * Timestamps are serialized as RFC 3339 -// date-time values by default. -// -// * A timestampFormat trait on a member changes the -// format. -// -// * A timestampFormat trait on the shape targeted by the member changes -// the format. +// - Timestamps are serialized as RFC 3339 date-time values by default. +// - A timestampFormat trait on a member changes the format. +// - A timestampFormat trait on the shape targeted by the member changes the +// format. func (c *Client) QueryTimestamps(ctx context.Context, params *QueryTimestampsInput, optFns ...func(*Options)) (*QueryTimestampsOutput, error) { if params == nil { params = &QueryTimestampsInput{} diff --git a/internal/protocoltest/ec2query/api_op_XmlLists.go b/internal/protocoltest/ec2query/api_op_XmlLists.go index ed72d427445..ac8589472d5 100644 --- a/internal/protocoltest/ec2query/api_op_XmlLists.go +++ b/internal/protocoltest/ec2query/api_op_XmlLists.go @@ -13,25 +13,14 @@ import ( // This test case serializes XML lists for the following cases for both input and // output: -// -// * Normal XML lists. -// -// * Normal XML sets. -// -// * XML lists of lists. -// -// * XML -// lists with @xmlName on its members -// -// * Flattened XML lists. -// -// * Flattened XML -// lists with @xmlName. -// -// * Flattened XML lists with @xmlNamespace. -// -// * Lists of -// structures. +// - Normal XML lists. +// - Normal XML sets. +// - XML lists of lists. +// - XML lists with @xmlName on its members +// - Flattened XML lists. +// - Flattened XML lists with @xmlName. +// - Flattened XML lists with @xmlNamespace. +// - Lists of structures. func (c *Client) XmlLists(ctx context.Context, params *XmlListsInput, optFns ...func(*Options)) (*XmlListsOutput, error) { if params == nil { params = &XmlListsInput{} diff --git a/internal/protocoltest/jsonrpc/api_client.go b/internal/protocoltest/jsonrpc/api_client.go index 0d68d0ca43e..2a9d005ef78 100644 --- a/internal/protocoltest/jsonrpc/api_client.go +++ b/internal/protocoltest/jsonrpc/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/jsonrpc/api_op_EmptyOperation_test.go b/internal/protocoltest/jsonrpc/api_op_EmptyOperation_test.go index aa3c159cbf5..b5ce4eddead 100644 --- a/internal/protocoltest/jsonrpc/api_op_EmptyOperation_test.go +++ b/internal/protocoltest/jsonrpc/api_op_EmptyOperation_test.go @@ -61,9 +61,9 @@ func TestClient_EmptyOperation_awsAwsjson11Serialize(t *testing.T) { }, }, // Clients must always send an empty JSON object payload for operations with no - // input (that is, {}). While AWS service implementations support requests with no - // payload or requests that send {}, always sending {} from the client is preferred - // for forward compatibility in case input is ever added to an operation. + // input (that is, {} ). While AWS service implementations support requests with no + // payload or requests that send {} , always sending {} from the client is + // preferred for forward compatibility in case input is ever added to an operation. "json_1_1_client_sends_empty_payload_for_no_input_shape": { Params: &EmptyOperationInput{}, ExpectMethod: "POST", diff --git a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go index 304a2e0ff60..e6057b2de7a 100644 --- a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go @@ -11,17 +11,12 @@ import ( ) // This operation has three possible return values: +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A ComplexError error. // -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A ComplexError -// error. -// -// Implementations must be able to successfully take a response and -// properly deserialize successful and error responses. +// Implementations must be able to successfully take a response and properly +// deserialize successful and error responses. func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go index 879df6c65f7..dbed9a61231 100644 --- a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go @@ -274,8 +274,8 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson11Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on ':' - // and take only the first half of the string. For example, + // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on + // ':' and take only the first half of the string. For example, // 'ValidationException:http://internal.amazon.com/coral/com.amazon.coral.validate/' // is to be interpreted as 'ValidationException'. For an example service see Amazon // Polly. @@ -286,9 +286,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson11Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // X-Amzn-Errortype might contain a URL and a namespace. Client should extract only - // the shape name. This is a pathalogical case that might not actually happen in - // any deployed AWS service. + // X-Amzn-Errortype might contain a URL and a namespace. Client should extract + // only the shape name. This is a pathalogical case that might not actually happen + // in any deployed AWS service. "AwsJson11FooErrorUsingXAmznErrorTypeWithUriAndNamespace": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/jsonrpc/document/document.go b/internal/protocoltest/jsonrpc/document/document.go index dda2067cbab..46b2e73318a 100644 --- a/internal/protocoltest/jsonrpc/document/document.go +++ b/internal/protocoltest/jsonrpc/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/internal/protocoltest/jsonrpc10/api_client.go b/internal/protocoltest/jsonrpc10/api_client.go index c5fa1379e89..6547ce90488 100644 --- a/internal/protocoltest/jsonrpc10/api_client.go +++ b/internal/protocoltest/jsonrpc10/api_client.go @@ -104,7 +104,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go index 14f3ea872ea..abab0579eaa 100644 --- a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go @@ -10,17 +10,12 @@ import ( ) // This operation has three possible return values: +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A ComplexError error. // -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A ComplexError -// error. -// -// Implementations must be able to successfully take a response and -// properly deserialize successful and error responses. +// Implementations must be able to successfully take a response and properly +// deserialize successful and error responses. func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go index 71b411900da..69eb0a11e5e 100644 --- a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go @@ -147,8 +147,8 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson10Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on ':' - // and take only the first half of the string. For example, + // Some X-Amzn-Errortype headers contain URLs. Clients need to split the URL on + // ':' and take only the first half of the string. For example, // 'ValidationException:http://internal.amazon.com/coral/com.amazon.coral.validate/' // is to be interpreted as 'ValidationException'. For an example service see Amazon // Polly. @@ -159,9 +159,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson10Deserialize(t *testing.T }, ExpectError: &types.FooError{}, }, - // X-Amzn-Errortype might contain a URL and a namespace. Client should extract only - // the shape name. This is a pathalogical case that might not actually happen in - // any deployed AWS service. + // X-Amzn-Errortype might contain a URL and a namespace. Client should extract + // only the shape name. This is a pathalogical case that might not actually happen + // in any deployed AWS service. "AwsJson10FooErrorUsingXAmznErrorTypeWithUriAndNamespace": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/jsonrpc10/api_op_NoInputAndNoOutput_test.go b/internal/protocoltest/jsonrpc10/api_op_NoInputAndNoOutput_test.go index ee340db191f..27e293d825c 100644 --- a/internal/protocoltest/jsonrpc10/api_op_NoInputAndNoOutput_test.go +++ b/internal/protocoltest/jsonrpc10/api_op_NoInputAndNoOutput_test.go @@ -39,9 +39,9 @@ func TestClient_NoInputAndNoOutput_awsAwsjson10Serialize(t *testing.T) { BodyAssert func(io.Reader) error }{ // Clients must always send an empty JSON object payload for operations with no - // input (that is, {}). While AWS service implementations support requests with no - // payload or requests that send {}, always sending {} from the client is preferred - // for forward compatibility in case input is ever added to an operation. + // input (that is, {} ). While AWS service implementations support requests with no + // payload or requests that send {} , always sending {} from the client is + // preferred for forward compatibility in case input is ever added to an operation. "AwsJson10MustAlwaysSendEmptyJsonPayload": { Params: &NoInputAndNoOutputInput{}, ExpectMethod: "POST", diff --git a/internal/protocoltest/query/api_client.go b/internal/protocoltest/query/api_client.go index 3221675fb66..98f82b8cd1d 100644 --- a/internal/protocoltest/query/api_client.go +++ b/internal/protocoltest/query/api_client.go @@ -112,7 +112,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/query/api_op_FlattenedXmlMapWithXmlNamespace_test.go b/internal/protocoltest/query/api_op_FlattenedXmlMapWithXmlNamespace_test.go index 2ab8bbd41a5..f7f47da033d 100644 --- a/internal/protocoltest/query/api_op_FlattenedXmlMapWithXmlNamespace_test.go +++ b/internal/protocoltest/query/api_op_FlattenedXmlMapWithXmlNamespace_test.go @@ -27,8 +27,8 @@ func TestClient_FlattenedXmlMapWithXmlNamespace_awsAwsqueryDeserialize(t *testin Body []byte ExpectResult *FlattenedXmlMapWithXmlNamespaceOutput }{ - // Serializes flattened XML maps in responses that have xmlNamespace and xmlName on - // members + // Serializes flattened XML maps in responses that have xmlNamespace and xmlName + // on members "QueryQueryFlattenedXmlMapWithXmlNamespace": { StatusCode: 200, Header: http.Header{ diff --git a/internal/protocoltest/query/api_op_GreetingWithErrors.go b/internal/protocoltest/query/api_op_GreetingWithErrors.go index e6eaafed7e1..4974700ad00 100644 --- a/internal/protocoltest/query/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/query/api_op_GreetingWithErrors.go @@ -10,14 +10,9 @@ import ( ) // This operation has three possible return values: -// -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A BadRequest -// error. +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A BadRequest error. func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/query/api_op_QueryTimestamps.go b/internal/protocoltest/query/api_op_QueryTimestamps.go index beffd4e8fc8..f64c359c9b5 100644 --- a/internal/protocoltest/query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/query/api_op_QueryTimestamps.go @@ -11,15 +11,10 @@ import ( ) // This test serializes timestamps. -// -// * Timestamps are serialized as RFC 3339 -// date-time values by default. -// -// * A timestampFormat trait on a member changes the -// format. -// -// * A timestampFormat trait on the shape targeted by the member changes -// the format. +// - Timestamps are serialized as RFC 3339 date-time values by default. +// - A timestampFormat trait on a member changes the format. +// - A timestampFormat trait on the shape targeted by the member changes the +// format. func (c *Client) QueryTimestamps(ctx context.Context, params *QueryTimestampsInput, optFns ...func(*Options)) (*QueryTimestampsOutput, error) { if params == nil { params = &QueryTimestampsInput{} diff --git a/internal/protocoltest/query/api_op_XmlLists.go b/internal/protocoltest/query/api_op_XmlLists.go index b00e312597e..83fddcbc3d4 100644 --- a/internal/protocoltest/query/api_op_XmlLists.go +++ b/internal/protocoltest/query/api_op_XmlLists.go @@ -13,22 +13,13 @@ import ( // This test case serializes XML lists for the following cases for both input and // output: -// -// * Normal XML lists. -// -// * Normal XML sets. -// -// * XML lists of lists. -// -// * XML -// lists with @xmlName on its members -// -// * Flattened XML lists. -// -// * Flattened XML -// lists with @xmlName. -// -// * Lists of structures. +// - Normal XML lists. +// - Normal XML sets. +// - XML lists of lists. +// - XML lists with @xmlName on its members +// - Flattened XML lists. +// - Flattened XML lists with @xmlName. +// - Lists of structures. func (c *Client) XmlLists(ctx context.Context, params *XmlListsInput, optFns ...func(*Options)) (*XmlListsOutput, error) { if params == nil { params = &XmlListsInput{} diff --git a/internal/protocoltest/restxml/api_client.go b/internal/protocoltest/restxml/api_client.go index 95d8d8f549c..c43e4a43964 100644 --- a/internal/protocoltest/restxml/api_client.go +++ b/internal/protocoltest/restxml/api_client.go @@ -112,7 +112,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/internal/protocoltest/restxml/api_op_ConstantQueryString.go b/internal/protocoltest/restxml/api_op_ConstantQueryString.go index ca3cd4f26b5..22415204880 100644 --- a/internal/protocoltest/restxml/api_op_ConstantQueryString.go +++ b/internal/protocoltest/restxml/api_op_ConstantQueryString.go @@ -11,8 +11,8 @@ import ( // This example uses a constant query string parameters and a label. This simply // tests that labels and query string parameters are compatible. The fixed query -// string parameter named "hello" should in no way conflict with the label, -// {hello}. +// string parameter named "hello" should in no way conflict with the label, {hello} +// . func (c *Client) ConstantQueryString(ctx context.Context, params *ConstantQueryStringInput, optFns ...func(*Options)) (*ConstantQueryStringOutput, error) { if params == nil { params = &ConstantQueryStringInput{} diff --git a/internal/protocoltest/restxml/api_op_FlattenedXmlMapWithXmlNamespace_test.go b/internal/protocoltest/restxml/api_op_FlattenedXmlMapWithXmlNamespace_test.go index 0fec63519ca..0f3dd3af0db 100644 --- a/internal/protocoltest/restxml/api_op_FlattenedXmlMapWithXmlNamespace_test.go +++ b/internal/protocoltest/restxml/api_op_FlattenedXmlMapWithXmlNamespace_test.go @@ -27,8 +27,8 @@ func TestClient_FlattenedXmlMapWithXmlNamespace_awsRestxmlDeserialize(t *testing Body []byte ExpectResult *FlattenedXmlMapWithXmlNamespaceOutput }{ - // Serializes flattened XML maps in responses that have xmlNamespace and xmlName on - // members + // Serializes flattened XML maps in responses that have xmlNamespace and xmlName + // on members "RestXmlFlattenedXmlMapWithXmlNamespace": { StatusCode: 200, Header: http.Header{ diff --git a/internal/protocoltest/restxml/api_op_GreetingWithErrors.go b/internal/protocoltest/restxml/api_op_GreetingWithErrors.go index 0e76e7e3a16..0c815b1fa46 100644 --- a/internal/protocoltest/restxml/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/restxml/api_op_GreetingWithErrors.go @@ -10,18 +10,12 @@ import ( ) // This operation has three possible return values: +// - A successful response in the form of GreetingWithErrorsOutput +// - An InvalidGreeting error. +// - A BadRequest error. // -// * A successful response in the -// form of GreetingWithErrorsOutput -// -// * An InvalidGreeting error. -// -// * A BadRequest -// error. -// -// Implementations must be able to successfully take a response and -// properly (de)serialize successful and error responses based on the the presence -// of the +// Implementations must be able to successfully take a response and properly +// (de)serialize successful and error responses based on the the presence of the func (c *Client) GreetingWithErrors(ctx context.Context, params *GreetingWithErrorsInput, optFns ...func(*Options)) (*GreetingWithErrorsOutput, error) { if params == nil { params = &GreetingWithErrorsInput{} diff --git a/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go b/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go index 7dcea240e0f..b2e59bc9f18 100644 --- a/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go +++ b/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go @@ -322,11 +322,11 @@ func TestClient_SimpleScalarProperties_awsRestxmlDeserialize(t *testing.T) { DoubleValue: ptr.Float64(6.5), }, }, - // Serializes string with escaping. This validates the three escape types: literal, - // decimal and hexadecimal. It also validates that unescaping properly handles the - // case where unescaping an & produces a newly formed escape sequence (this should - // not be re-unescaped). Servers may produce different output, this test is - // designed different unescapes clients must handle + // Serializes string with escaping. This validates the three escape types: + // literal, decimal and hexadecimal. It also validates that unescaping properly + // handles the case where unescaping an & produces a newly formed escape sequence + // (this should not be re-unescaped). Servers may produce different output, this + // test is designed different unescapes clients must handle "SimpleScalarPropertiesComplexEscapes": { StatusCode: 200, Header: http.Header{ diff --git a/internal/protocoltest/restxml/api_op_XmlLists.go b/internal/protocoltest/restxml/api_op_XmlLists.go index 062016bd47e..0414a5e1d20 100644 --- a/internal/protocoltest/restxml/api_op_XmlLists.go +++ b/internal/protocoltest/restxml/api_op_XmlLists.go @@ -13,27 +13,15 @@ import ( // This test case serializes XML lists for the following cases for both input and // output: -// -// * Normal XML lists. -// -// * Normal XML sets. -// -// * XML lists of lists. -// -// * XML -// lists with @xmlName on its members -// -// * Flattened XML lists. -// -// * Flattened XML -// lists with @xmlName. -// -// * Flattened XML lists with @xmlNamespace. -// -// * Lists of -// structures. -// -// * Flattened XML list of structures +// - Normal XML lists. +// - Normal XML sets. +// - XML lists of lists. +// - XML lists with @xmlName on its members +// - Flattened XML lists. +// - Flattened XML lists with @xmlName. +// - Flattened XML lists with @xmlNamespace. +// - Lists of structures. +// - Flattened XML list of structures func (c *Client) XmlLists(ctx context.Context, params *XmlListsInput, optFns ...func(*Options)) (*XmlListsOutput, error) { if params == nil { params = &XmlListsInput{} diff --git a/internal/protocoltest/restxml/doc.go b/internal/protocoltest/restxml/doc.go index 7a848cde6db..b2840030e98 100644 --- a/internal/protocoltest/restxml/doc.go +++ b/internal/protocoltest/restxml/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package restxml provides the API client, operations, and parameter types for the -// API. +// Package restxml provides the API client, operations, and parameter types for +// the API. // // A REST XML service that sends XML requests and responses. package restxml diff --git a/internal/protocoltest/restxmlwithnamespace/api_client.go b/internal/protocoltest/restxmlwithnamespace/api_client.go index 4136adf6e12..89999931b2d 100644 --- a/internal/protocoltest/restxmlwithnamespace/api_client.go +++ b/internal/protocoltest/restxmlwithnamespace/api_client.go @@ -104,7 +104,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/accessanalyzer/api_client.go b/service/accessanalyzer/api_client.go index 41f8de64372..35b15d23838 100644 --- a/service/accessanalyzer/api_client.go +++ b/service/accessanalyzer/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/accessanalyzer/api_op_CancelPolicyGeneration.go b/service/accessanalyzer/api_op_CancelPolicyGeneration.go index fd65bfcb99f..b092fde080d 100644 --- a/service/accessanalyzer/api_op_CancelPolicyGeneration.go +++ b/service/accessanalyzer/api_op_CancelPolicyGeneration.go @@ -28,9 +28,9 @@ func (c *Client) CancelPolicyGeneration(ctx context.Context, params *CancelPolic type CancelPolicyGenerationInput struct { - // The JobId that is returned by the StartPolicyGeneration operation. The JobId can - // be used with GetGeneratedPolicy to retrieve the generated policies or used with - // CancelPolicyGeneration to cancel the policy generation request. + // The JobId that is returned by the StartPolicyGeneration operation. The JobId + // can be used with GetGeneratedPolicy to retrieve the generated policies or used + // with CancelPolicyGeneration to cancel the policy generation request. // // This member is required. JobId *string diff --git a/service/accessanalyzer/api_op_CreateAccessPreview.go b/service/accessanalyzer/api_op_CreateAccessPreview.go index 1c79f6ebc37..5fd943c78c5 100644 --- a/service/accessanalyzer/api_op_CreateAccessPreview.go +++ b/service/accessanalyzer/api_op_CreateAccessPreview.go @@ -31,8 +31,7 @@ func (c *Client) CreateAccessPreview(ctx context.Context, params *CreateAccessPr type CreateAccessPreviewInput struct { - // The ARN of the account analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the account analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // used to generate the access preview. You can only create an access preview for // analyzers with an Account type and Active status. // diff --git a/service/accessanalyzer/api_op_CreateAnalyzer.go b/service/accessanalyzer/api_op_CreateAnalyzer.go index 229c2282e6a..ccf76c618f4 100644 --- a/service/accessanalyzer/api_op_CreateAnalyzer.go +++ b/service/accessanalyzer/api_op_CreateAnalyzer.go @@ -43,8 +43,8 @@ type CreateAnalyzerInput struct { // This member is required. Type types.Type - // Specifies the archive rules to add for the analyzer. Archive rules automatically - // archive findings that meet the criteria you define for the rule. + // Specifies the archive rules to add for the analyzer. Archive rules + // automatically archive findings that meet the criteria you define for the rule. ArchiveRules []types.InlineArchiveRule // A client token. diff --git a/service/accessanalyzer/api_op_CreateArchiveRule.go b/service/accessanalyzer/api_op_CreateArchiveRule.go index 74c1948df02..3836bd31941 100644 --- a/service/accessanalyzer/api_op_CreateArchiveRule.go +++ b/service/accessanalyzer/api_op_CreateArchiveRule.go @@ -15,8 +15,7 @@ import ( // Creates an archive rule for the specified analyzer. Archive rules automatically // archive new findings that meet the criteria you define when you create the rule. // To learn about filter keys that you can use to create an archive rule, see IAM -// Access Analyzer filter keys -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) +// Access Analyzer filter keys (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) // in the IAM User Guide. func (c *Client) CreateArchiveRule(ctx context.Context, params *CreateArchiveRuleInput, optFns ...func(*Options)) (*CreateArchiveRuleOutput, error) { if params == nil { diff --git a/service/accessanalyzer/api_op_DeleteAnalyzer.go b/service/accessanalyzer/api_op_DeleteAnalyzer.go index 825b65598f6..d88e7cef953 100644 --- a/service/accessanalyzer/api_op_DeleteAnalyzer.go +++ b/service/accessanalyzer/api_op_DeleteAnalyzer.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer -// is disabled for the account or organization in the current or specific Region. -// All findings that were generated by the analyzer are deleted. You cannot undo -// this action. +// Deletes the specified analyzer. When you delete an analyzer, IAM Access +// Analyzer is disabled for the account or organization in the current or specific +// Region. All findings that were generated by the analyzer are deleted. You cannot +// undo this action. func (c *Client) DeleteAnalyzer(ctx context.Context, params *DeleteAnalyzerInput, optFns ...func(*Options)) (*DeleteAnalyzerOutput, error) { if params == nil { params = &DeleteAnalyzerInput{} diff --git a/service/accessanalyzer/api_op_GetAccessPreview.go b/service/accessanalyzer/api_op_GetAccessPreview.go index 89143d88948..4a73eae5a3f 100644 --- a/service/accessanalyzer/api_op_GetAccessPreview.go +++ b/service/accessanalyzer/api_op_GetAccessPreview.go @@ -34,8 +34,7 @@ type GetAccessPreviewInput struct { // This member is required. AccessPreviewId *string - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // used to generate the access preview. // // This member is required. diff --git a/service/accessanalyzer/api_op_GetAnalyzedResource.go b/service/accessanalyzer/api_op_GetAnalyzedResource.go index fc6b097496c..8113588f27d 100644 --- a/service/accessanalyzer/api_op_GetAnalyzedResource.go +++ b/service/accessanalyzer/api_op_GetAnalyzedResource.go @@ -30,8 +30,7 @@ func (c *Client) GetAnalyzedResource(ctx context.Context, params *GetAnalyzedRes // Retrieves an analyzed resource. type GetAnalyzedResourceInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // to retrieve information from. // // This member is required. diff --git a/service/accessanalyzer/api_op_GetArchiveRule.go b/service/accessanalyzer/api_op_GetArchiveRule.go index 71cebcf3e0f..aa335464c91 100644 --- a/service/accessanalyzer/api_op_GetArchiveRule.go +++ b/service/accessanalyzer/api_op_GetArchiveRule.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about an archive rule. To learn about filter keys that you -// can use to create an archive rule, see IAM Access Analyzer filter keys -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) +// Retrieves information about an archive rule. To learn about filter keys that +// you can use to create an archive rule, see IAM Access Analyzer filter keys (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) // in the IAM User Guide. func (c *Client) GetArchiveRule(ctx context.Context, params *GetArchiveRuleInput, optFns ...func(*Options)) (*GetArchiveRuleOutput, error) { if params == nil { diff --git a/service/accessanalyzer/api_op_GetFinding.go b/service/accessanalyzer/api_op_GetFinding.go index bc7ed9cb62a..df503ab3507 100644 --- a/service/accessanalyzer/api_op_GetFinding.go +++ b/service/accessanalyzer/api_op_GetFinding.go @@ -30,8 +30,7 @@ func (c *Client) GetFinding(ctx context.Context, params *GetFindingInput, optFns // Retrieves a finding. type GetFindingInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // that generated the finding. // // This member is required. diff --git a/service/accessanalyzer/api_op_GetGeneratedPolicy.go b/service/accessanalyzer/api_op_GetGeneratedPolicy.go index 1d581694f18..5bca7cf054c 100644 --- a/service/accessanalyzer/api_op_GetGeneratedPolicy.go +++ b/service/accessanalyzer/api_op_GetGeneratedPolicy.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the policy that was generated using StartPolicyGeneration. +// Retrieves the policy that was generated using StartPolicyGeneration . func (c *Client) GetGeneratedPolicy(ctx context.Context, params *GetGeneratedPolicyInput, optFns ...func(*Options)) (*GetGeneratedPolicyOutput, error) { if params == nil { params = &GetGeneratedPolicyInput{} @@ -29,9 +29,9 @@ func (c *Client) GetGeneratedPolicy(ctx context.Context, params *GetGeneratedPol type GetGeneratedPolicyInput struct { - // The JobId that is returned by the StartPolicyGeneration operation. The JobId can - // be used with GetGeneratedPolicy to retrieve the generated policies or used with - // CancelPolicyGeneration to cancel the policy generation request. + // The JobId that is returned by the StartPolicyGeneration operation. The JobId + // can be used with GetGeneratedPolicy to retrieve the generated policies or used + // with CancelPolicyGeneration to cancel the policy generation request. // // This member is required. JobId *string @@ -40,7 +40,7 @@ type GetGeneratedPolicyInput struct { // generate policies with placeholders for resource ARNs for actions that support // resource level granularity in policies. For example, in the resource section of // a policy, you can receive a placeholder such as - // "Resource":"arn:aws:s3:::${BucketName}" instead of "*". + // "Resource":"arn:aws:s3:::${BucketName}" instead of "*" . IncludeResourcePlaceholders *bool // The level of detail that you want to generate. You can specify whether to diff --git a/service/accessanalyzer/api_op_ListAccessPreviewFindings.go b/service/accessanalyzer/api_op_ListAccessPreviewFindings.go index 80c09535d8b..baeae1e1c35 100644 --- a/service/accessanalyzer/api_op_ListAccessPreviewFindings.go +++ b/service/accessanalyzer/api_op_ListAccessPreviewFindings.go @@ -36,8 +36,7 @@ type ListAccessPreviewFindingsInput struct { // This member is required. AccessPreviewId *string - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // used to generate the access. // // This member is required. diff --git a/service/accessanalyzer/api_op_ListAccessPreviews.go b/service/accessanalyzer/api_op_ListAccessPreviews.go index da219571213..dd990eacb58 100644 --- a/service/accessanalyzer/api_op_ListAccessPreviews.go +++ b/service/accessanalyzer/api_op_ListAccessPreviews.go @@ -30,8 +30,7 @@ func (c *Client) ListAccessPreviews(ctx context.Context, params *ListAccessPrevi type ListAccessPreviewsInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // used to generate the access preview. // // This member is required. diff --git a/service/accessanalyzer/api_op_ListAnalyzedResources.go b/service/accessanalyzer/api_op_ListAnalyzedResources.go index 34a1a84458a..a4602bad64f 100644 --- a/service/accessanalyzer/api_op_ListAnalyzedResources.go +++ b/service/accessanalyzer/api_op_ListAnalyzedResources.go @@ -32,8 +32,7 @@ func (c *Client) ListAnalyzedResources(ctx context.Context, params *ListAnalyzed // Retrieves a list of resources that have been analyzed. type ListAnalyzedResourcesInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // to retrieve a list of analyzed resources from. // // This member is required. diff --git a/service/accessanalyzer/api_op_ListFindings.go b/service/accessanalyzer/api_op_ListFindings.go index 49d8c40d395..1fa8355a9bd 100644 --- a/service/accessanalyzer/api_op_ListFindings.go +++ b/service/accessanalyzer/api_op_ListFindings.go @@ -12,10 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of findings generated by the specified analyzer. To learn about -// filter keys that you can use to retrieve a list of findings, see IAM Access -// Analyzer filter keys -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) +// Retrieves a list of findings generated by the specified analyzer. To learn +// about filter keys that you can use to retrieve a list of findings, see IAM +// Access Analyzer filter keys (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) // in the IAM User Guide. func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error) { if params == nil { @@ -35,8 +34,7 @@ func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, op // Retrieves a list of findings generated by the specified analyzer. type ListFindingsInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // to retrieve findings from. // // This member is required. diff --git a/service/accessanalyzer/api_op_StartPolicyGeneration.go b/service/accessanalyzer/api_op_StartPolicyGeneration.go index ed71b91b98d..ee9aafdb45f 100644 --- a/service/accessanalyzer/api_op_StartPolicyGeneration.go +++ b/service/accessanalyzer/api_op_StartPolicyGeneration.go @@ -30,8 +30,8 @@ func (c *Client) StartPolicyGeneration(ctx context.Context, params *StartPolicyG type StartPolicyGenerationInput struct { - // Contains the ARN of the IAM entity (user or role) for which you are generating a - // policy. + // Contains the ARN of the IAM entity (user or role) for which you are generating + // a policy. // // This member is required. PolicyGenerationDetails *types.PolicyGenerationDetails @@ -54,9 +54,9 @@ type StartPolicyGenerationInput struct { type StartPolicyGenerationOutput struct { - // The JobId that is returned by the StartPolicyGeneration operation. The JobId can - // be used with GetGeneratedPolicy to retrieve the generated policies or used with - // CancelPolicyGeneration to cancel the policy generation request. + // The JobId that is returned by the StartPolicyGeneration operation. The JobId + // can be used with GetGeneratedPolicy to retrieve the generated policies or used + // with CancelPolicyGeneration to cancel the policy generation request. // // This member is required. JobId *string diff --git a/service/accessanalyzer/api_op_StartResourceScan.go b/service/accessanalyzer/api_op_StartResourceScan.go index 3af36dc1e87..53ab2e61456 100644 --- a/service/accessanalyzer/api_op_StartResourceScan.go +++ b/service/accessanalyzer/api_op_StartResourceScan.go @@ -29,8 +29,7 @@ func (c *Client) StartResourceScan(ctx context.Context, params *StartResourceSca // Starts a scan of the policies applied to the specified resource. type StartResourceScanInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // to use to scan the policies applied to the specified resource. // // This member is required. diff --git a/service/accessanalyzer/api_op_UpdateFindings.go b/service/accessanalyzer/api_op_UpdateFindings.go index fdfd1184336..9cde2c96955 100644 --- a/service/accessanalyzer/api_op_UpdateFindings.go +++ b/service/accessanalyzer/api_op_UpdateFindings.go @@ -31,16 +31,15 @@ func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput // Updates findings with the new values provided in the request. type UpdateFindingsInput struct { - // The ARN of the analyzer - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) + // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) // that generated the findings to update. // // This member is required. AnalyzerArn *string // The state represents the action to take to update the finding Status. Use - // ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change - // an Archived finding to an Active finding. + // ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to + // change an Archived finding to an Active finding. // // This member is required. Status types.FindingStatusUpdate diff --git a/service/accessanalyzer/api_op_ValidatePolicy.go b/service/accessanalyzer/api_op_ValidatePolicy.go index a981579942a..5c2ec688e90 100644 --- a/service/accessanalyzer/api_op_ValidatePolicy.go +++ b/service/accessanalyzer/api_op_ValidatePolicy.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests the validation of a policy and returns a list of findings. The findings -// help you identify issues and provide actionable recommendations to resolve the -// issue and enable you to author functional policies that meet security best -// practices. +// Requests the validation of a policy and returns a list of findings. The +// findings help you identify issues and provide actionable recommendations to +// resolve the issue and enable you to author functional policies that meet +// security best practices. func (c *Client) ValidatePolicy(ctx context.Context, params *ValidatePolicyInput, optFns ...func(*Options)) (*ValidatePolicyOutput, error) { if params == nil { params = &ValidatePolicyInput{} @@ -61,7 +61,7 @@ type ValidatePolicyInput struct { NextToken *string // The type of resource to attach to your resource policy. Specify a value for the - // policy validation resource type only if the policy type is RESOURCE_POLICY. For + // policy validation resource type only if the policy type is RESOURCE_POLICY . For // example, to validate a resource policy to attach to an Amazon S3 bucket, you can // choose AWS::S3::Bucket for the policy validation resource type. For resource // types not supported as valid values, IAM Access Analyzer runs policy checks that diff --git a/service/accessanalyzer/doc.go b/service/accessanalyzer/doc.go index b024a8bca2c..8567f53d30e 100644 --- a/service/accessanalyzer/doc.go +++ b/service/accessanalyzer/doc.go @@ -13,8 +13,7 @@ // cross-account access to your resources before deploying permissions changes. // This guide describes the Identity and Access Management Access Analyzer // operations that you can call programmatically. For general information about IAM -// Access Analyzer, see Identity and Access Management Access Analyzer -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) +// Access Analyzer, see Identity and Access Management Access Analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html) // in the IAM User Guide. To start using IAM Access Analyzer, you first need to // create an analyzer. package accessanalyzer diff --git a/service/accessanalyzer/types/enums.go b/service/accessanalyzer/types/enums.go index 002a83cb3b5..a7ae42b723c 100644 --- a/service/accessanalyzer/types/enums.go +++ b/service/accessanalyzer/types/enums.go @@ -177,9 +177,9 @@ const ( JobErrorCodeServiceError JobErrorCode = "SERVICE_ERROR" ) -// Values returns all known values for JobErrorCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for JobErrorCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (JobErrorCode) Values() []JobErrorCode { return []JobErrorCode{ "AUTHORIZATION_ERROR", @@ -199,9 +199,9 @@ const ( JobStatusCanceled JobStatus = "CANCELED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "IN_PROGRESS", @@ -366,9 +366,9 @@ const ( ResourceTypeAwsSnsTopic ResourceType = "AWS::SNS::Topic" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "AWS::S3::Bucket", diff --git a/service/accessanalyzer/types/types.go b/service/accessanalyzer/types/types.go index a423d5788b5..ca09c9ab686 100644 --- a/service/accessanalyzer/types/types.go +++ b/service/accessanalyzer/types/types.go @@ -31,15 +31,10 @@ type AccessPreview struct { Id *string // The status of the access preview. - // - // * Creating - The access preview creation is - // in progress. - // - // * Completed - The access preview is complete. You can preview - // findings for external access to the resource. - // - // * Failed - The access preview - // creation has failed. + // - Creating - The access preview creation is in progress. + // - Completed - The access preview is complete. You can preview findings for + // external access to the resource. + // - Failed - The access preview creation has failed. // // This member is required. Status AccessPreviewStatus @@ -58,19 +53,14 @@ type AccessPreviewFinding struct { // Provides context on how the access preview finding compares to existing access // identified in IAM Access Analyzer. - // - // * New - The finding is for newly-introduced - // access. - // - // * Unchanged - The preview finding is an existing finding that would - // remain unchanged. - // - // * Changed - The preview finding is an existing finding with a - // change in status. - // - // For example, a Changed finding with preview status Resolved - // and existing status Active indicates the existing Active finding would become - // Resolved as a result of the proposed permissions change. + // - New - The finding is for newly-introduced access. + // - Unchanged - The preview finding is an existing finding that would remain + // unchanged. + // - Changed - The preview finding is an existing finding with a change in + // status. + // For example, a Changed finding with preview status Resolved and existing status + // Active indicates the existing Active finding would become Resolved as a result + // of the proposed permissions change. // // This member is required. ChangeType FindingChangeType @@ -80,8 +70,8 @@ type AccessPreviewFinding struct { // This member is required. CreatedAt *time.Time - // The ID of the access preview finding. This ID uniquely identifies the element in - // the list of access preview findings and is not related to the finding ID in + // The ID of the access preview finding. This ID uniquely identifies the element + // in the list of access preview findings and is not related to the finding ID in // Access Analyzer. // // This member is required. @@ -101,8 +91,8 @@ type AccessPreviewFinding struct { // The preview status of the finding. This is what the status of the finding would // be after permissions deployment. For example, a Changed finding with preview - // status Resolved and existing status Active indicates the existing Active finding - // would become Resolved as a result of the proposed permissions change. + // status Resolved and existing status Active indicates the existing Active + // finding would become Resolved as a result of the proposed permissions change. // // This member is required. Status FindingStatus @@ -175,15 +165,10 @@ type AccessPreviewSummary struct { Id *string // The status of the access preview. - // - // * Creating - The access preview creation is - // in progress. - // - // * Completed - The access preview is complete and previews the - // findings for external access to the resource. - // - // * Failed - The access preview - // creation has failed. + // - Creating - The access preview creation is in progress. + // - Completed - The access preview is complete and previews the findings for + // external access to the resource. + // - Failed - The access preview creation has failed. // // This member is required. Status AccessPreviewStatus @@ -198,8 +183,8 @@ type AccessPreviewSummary struct { } // You specify each grantee as a type-value pair using one of these types. You can -// specify only one type of grantee. For more information, see PutBucketAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAcl.html). +// specify only one type of grantee. For more information, see PutBucketAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAcl.html) +// . // // The following types satisfy this interface: // @@ -344,10 +329,10 @@ type AnalyzerSummary struct { // The time at which the most recently analyzed resource was analyzed. LastResourceAnalyzedAt *time.Time - // The statusReason provides more details about the current status of the analyzer. - // For example, if the creation for the analyzer fails, a Failed status is - // returned. For an analyzer with organization as the type, this failure can be due - // to an issue with creating the service-linked roles required in the member + // The statusReason provides more details about the current status of the + // analyzer. For example, if the creation for the analyzer fails, a Failed status + // is returned. For an analyzer with organization as the type, this failure can be + // due to an issue with creating the service-linked roles required in the member // accounts of the Amazon Web Services organization. StatusReason *StatusReason @@ -560,8 +545,8 @@ type ConfigurationMemberSqsQueue struct { func (*ConfigurationMemberSqsQueue) isConfiguration() {} // The criteria to use in the filter that defines the archive rule. For more -// information on available filter keys, see IAM Access Analyzer filter keys -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html). +// information on available filter keys, see IAM Access Analyzer filter keys (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) +// . type Criterion struct { // A "contains" operator to match for the filter used to create the rule. @@ -579,55 +564,42 @@ type Criterion struct { noSmithyDocumentSerde } -// The proposed access control configuration for an Amazon EBS volume snapshot. You -// can propose a configuration for a new Amazon EBS volume snapshot or an Amazon -// EBS volume snapshot that you own by specifying the user IDs, groups, and -// optional KMS encryption key. For more information, see ModifySnapshotAttribute -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySnapshotAttribute.html). +// The proposed access control configuration for an Amazon EBS volume snapshot. +// You can propose a configuration for a new Amazon EBS volume snapshot or an +// Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and +// optional KMS encryption key. For more information, see ModifySnapshotAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySnapshotAttribute.html) +// . type EbsSnapshotConfiguration struct { // The groups that have access to the Amazon EBS volume snapshot. If the value all // is specified, then the Amazon EBS volume snapshot is public. - // - // * If the - // configuration is for an existing Amazon EBS volume snapshot and you do not - // specify the groups, then the access preview uses the existing shared groups for - // the snapshot. - // - // * If the access preview is for a new resource and you do not - // specify the groups, then the access preview considers the snapshot without any - // groups. - // - // * To propose deletion of existing shared groups, you can specify an - // empty list for groups. + // - If the configuration is for an existing Amazon EBS volume snapshot and you + // do not specify the groups , then the access preview uses the existing shared + // groups for the snapshot. + // - If the access preview is for a new resource and you do not specify the + // groups , then the access preview considers the snapshot without any groups . + // - To propose deletion of existing shared groups , you can specify an empty + // list for groups . Groups []string // The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key // identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. - // - // * - // If the configuration is for an existing Amazon EBS volume snapshot and you do - // not specify the kmsKeyId, or you specify an empty string, then the access - // preview uses the existing kmsKeyId of the snapshot. - // - // * If the access preview is - // for a new resource and you do not specify the kmsKeyId, the access preview - // considers the snapshot as unencrypted. + // - If the configuration is for an existing Amazon EBS volume snapshot and you + // do not specify the kmsKeyId , or you specify an empty string, then the access + // preview uses the existing kmsKeyId of the snapshot. + // - If the access preview is for a new resource and you do not specify the + // kmsKeyId , the access preview considers the snapshot as unencrypted. KmsKeyId *string // The IDs of the Amazon Web Services accounts that have access to the Amazon EBS // volume snapshot. - // - // * If the configuration is for an existing Amazon EBS volume - // snapshot and you do not specify the userIds, then the access preview uses the - // existing shared userIds for the snapshot. - // - // * If the access preview is for a new - // resource and you do not specify the userIds, then the access preview considers - // the snapshot without any userIds. - // - // * To propose deletion of existing shared - // accountIds, you can specify an empty list for userIds. + // - If the configuration is for an existing Amazon EBS volume snapshot and you + // do not specify the userIds , then the access preview uses the existing shared + // userIds for the snapshot. + // - If the access preview is for a new resource and you do not specify the + // userIds , then the access preview considers the snapshot without any userIds . + // - To propose deletion of existing shared accountIds , you can specify an empty + // list for userIds . UserIds []string noSmithyDocumentSerde @@ -636,54 +608,45 @@ type EbsSnapshotConfiguration struct { // The proposed access control configuration for an Amazon ECR repository. You can // propose a configuration for a new Amazon ECR repository or an existing Amazon // ECR repository that you own by specifying the Amazon ECR policy. For more -// information, see Repository -// (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Repository.html). -// -// * -// If the configuration is for an existing Amazon ECR repository and you do not -// specify the Amazon ECR policy, then the access preview uses the existing Amazon -// ECR policy for the repository. -// -// * If the access preview is for a new resource -// and you do not specify the policy, then the access preview assumes an Amazon ECR -// repository without a policy. -// -// * To propose deletion of an existing Amazon ECR -// repository policy, you can specify an empty string for the Amazon ECR policy. +// information, see Repository (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Repository.html) +// . +// - If the configuration is for an existing Amazon ECR repository and you do +// not specify the Amazon ECR policy, then the access preview uses the existing +// Amazon ECR policy for the repository. +// - If the access preview is for a new resource and you do not specify the +// policy, then the access preview assumes an Amazon ECR repository without a +// policy. +// - To propose deletion of an existing Amazon ECR repository policy, you can +// specify an empty string for the Amazon ECR policy. type EcrRepositoryConfiguration struct { // The JSON repository policy text to apply to the Amazon ECR repository. For more - // information, see Private repository policy examples - // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) + // information, see Private repository policy examples (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) // in the Amazon ECR User Guide. RepositoryPolicy *string noSmithyDocumentSerde } -// The proposed access control configuration for an Amazon EFS file system. You can -// propose a configuration for a new Amazon EFS file system or an existing Amazon -// EFS file system that you own by specifying the Amazon EFS policy. For more -// information, see Using file systems in Amazon EFS -// (https://docs.aws.amazon.com/efs/latest/ug/using-fs.html). -// -// * If the -// configuration is for an existing Amazon EFS file system and you do not specify -// the Amazon EFS policy, then the access preview uses the existing Amazon EFS -// policy for the file system. -// -// * If the access preview is for a new resource and -// you do not specify the policy, then the access preview assumes an Amazon EFS -// file system without a policy. -// -// * To propose deletion of an existing Amazon EFS -// file system policy, you can specify an empty string for the Amazon EFS policy. +// The proposed access control configuration for an Amazon EFS file system. You +// can propose a configuration for a new Amazon EFS file system or an existing +// Amazon EFS file system that you own by specifying the Amazon EFS policy. For +// more information, see Using file systems in Amazon EFS (https://docs.aws.amazon.com/efs/latest/ug/using-fs.html) +// . +// - If the configuration is for an existing Amazon EFS file system and you do +// not specify the Amazon EFS policy, then the access preview uses the existing +// Amazon EFS policy for the file system. +// - If the access preview is for a new resource and you do not specify the +// policy, then the access preview assumes an Amazon EFS file system without a +// policy. +// - To propose deletion of an existing Amazon EFS file system policy, you can +// specify an empty string for the Amazon EFS policy. type EfsFileSystemConfiguration struct { // The JSON policy definition to apply to the Amazon EFS file system. For more // information on the elements that make up a file system policy, see Amazon EFS - // Resource-based policies - // (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). + // Resource-based policies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies) + // . FileSystemPolicy *string noSmithyDocumentSerde @@ -858,8 +821,7 @@ type FindingSummary struct { type GeneratedPolicy struct { // The text to use as the content for the new policy. The policy is created using - // the CreatePolicy - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) + // the CreatePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) // action. // // This member is required. @@ -897,8 +859,7 @@ type GeneratedPolicyResult struct { Properties *GeneratedPolicyProperties // The text to use as the content for the new policy. The policy is created using - // the CreatePolicy - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) + // the CreatePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) // action. GeneratedPolicies []GeneratedPolicy @@ -912,8 +873,8 @@ type GeneratedPolicyResult struct { // that you own and you do not propose the trust policy, the access preview uses // the existing trust policy for the role. The proposed trust policy cannot be an // empty string. For more information about role trust policy limits, see IAM and -// STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html). +// STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// . type IamRoleConfiguration struct { // The proposed trust policy for the IAM role. @@ -940,7 +901,7 @@ type InlineArchiveRule struct { } // This configuration sets the network origin for the Amazon S3 access point or -// multi-region access point to Internet. +// multi-region access point to Internet . type InternetConfiguration struct { noSmithyDocumentSerde } @@ -948,9 +909,9 @@ type InternetConfiguration struct { // Contains details about the policy generation request. type JobDetails struct { - // The JobId that is returned by the StartPolicyGeneration operation. The JobId can - // be used with GetGeneratedPolicy to retrieve the generated policies or used with - // CancelPolicyGeneration to cancel the policy generation request. + // The JobId that is returned by the StartPolicyGeneration operation. The JobId + // can be used with GetGeneratedPolicy to retrieve the generated policies or used + // with CancelPolicyGeneration to cancel the policy generation request. // // This member is required. JobId *string @@ -992,8 +953,8 @@ type JobError struct { } // A proposed grant configuration for a KMS key. For more information, see -// CreateGrant -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html). +// CreateGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) +// . type KmsGrantConfiguration struct { // The principal that is given permission to perform the operations that the grant @@ -1002,8 +963,9 @@ type KmsGrantConfiguration struct { // This member is required. GranteePrincipal *string - // The Amazon Web Services account under which the grant was issued. The account is - // used to propose KMS grants issued by accounts other than the owner of the key. + // The Amazon Web Services account under which the grant was issued. The account + // is used to propose KMS grants issued by accounts other than the owner of the + // key. // // This member is required. IssuingAccount *string @@ -1013,41 +975,35 @@ type KmsGrantConfiguration struct { // This member is required. Operations []KmsGrantOperation - // Use this structure to propose allowing cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // Use this structure to propose allowing cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // in the grant only when the operation request includes the specified encryption - // context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). + // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // . Constraints *KmsGrantConstraints - // The principal that is given permission to retire the grant by using RetireGrant - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html) + // The principal that is given permission to retire the grant by using RetireGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html) // operation. RetiringPrincipal *string noSmithyDocumentSerde } -// Use this structure to propose allowing cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// Use this structure to propose allowing cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // in the grant only when the operation request includes the specified encryption -// context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). -// You can specify only one type of encryption context. An empty map is treated as -// not specified. For more information, see GrantConstraints -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html). +// context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// . You can specify only one type of encryption context. An empty map is treated +// as not specified. For more information, see GrantConstraints (https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html) +// . type KmsGrantConstraints struct { // A list of key-value pairs that must match the encryption context in the - // cryptographic operation - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // request. The grant allows the operation only when the encryption context in the // request is the same as the encryption context specified in this constraint. EncryptionContextEquals map[string]string - // A list of key-value pairs that must be included in the encryption context of the - // cryptographic operation - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // A list of key-value pairs that must be included in the encryption context of + // the cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // request. The grant allows the cryptographic operation only when the encryption // context in the request includes the key-value pairs specified in this // constraint, although it can include additional key-value pairs. @@ -1063,10 +1019,9 @@ type KmsGrantConstraints struct { // uses the existing policy for the key. If the access preview is for a new // resource and you do not specify the key policy, then the access preview uses the // default key policy. The proposed key policy cannot be an empty string. For more -// information, see Default key policy -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default). -// For more information about key policy limits, see Resource quotas -// (https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html). +// information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) +// . For more information about key policy limits, see Resource quotas (https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html) +// . type KmsKeyConfiguration struct { // A list of proposed grant configurations for the KMS key. If the proposed grant @@ -1075,9 +1030,9 @@ type KmsKeyConfiguration struct { // preview uses the existing grants for the key. Grants []KmsGrantConfiguration - // Resource policy configuration for the KMS key. The only valid value for the name - // of the key policy is default. For more information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default). + // Resource policy configuration for the KMS key. The only valid value for the + // name of the key policy is default . For more information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) + // . KeyPolicies map[string]string noSmithyDocumentSerde @@ -1100,13 +1055,13 @@ type Location struct { noSmithyDocumentSerde } -// The proposed InternetConfiguration or VpcConfiguration to apply to the Amazon S3 -// access point. VpcConfiguration does not apply to multi-region access points. You -// can make the access point accessible from the internet, or you can specify that -// all requests made through that access point must originate from a specific +// The proposed InternetConfiguration or VpcConfiguration to apply to the Amazon +// S3 access point. VpcConfiguration does not apply to multi-region access points. +// You can make the access point accessible from the internet, or you can specify +// that all requests made through that access point must originate from a specific // virtual private cloud (VPC). You can specify only one type of network -// configuration. For more information, see Creating access points -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html). +// configuration. For more information, see Creating access points (https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html) +// . // // The following types satisfy this interface: // @@ -1128,8 +1083,8 @@ func (*NetworkOriginConfigurationMemberInternetConfiguration) isNetworkOriginCon // The proposed virtual private cloud (VPC) configuration for the Amazon S3 access // point. VPC configuration does not apply to multi-region access points. For more -// information, see VpcConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html). +// information, see VpcConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html) +// . type NetworkOriginConfigurationMemberVpcConfiguration struct { Value VpcConfiguration @@ -1189,9 +1144,9 @@ func (*PathElementMemberValue) isPathElement() {} // Contains details about the policy generation status and properties. type PolicyGeneration struct { - // The JobId that is returned by the StartPolicyGeneration operation. The JobId can - // be used with GetGeneratedPolicy to retrieve the generated policies or used with - // CancelPolicyGeneration to cancel the policy generation request. + // The JobId that is returned by the StartPolicyGeneration operation. The JobId + // can be used with GetGeneratedPolicy to retrieve the generated policies or used + // with CancelPolicyGeneration to cancel the policy generation request. // // This member is required. JobId *string @@ -1258,24 +1213,18 @@ type RdsDbClusterSnapshotAttributeValue interface { isRdsDbClusterSnapshotAttributeValue() } -// The Amazon Web Services account IDs that have access to the manual Amazon RDS DB -// cluster snapshot. If the value all is specified, then the Amazon RDS DB cluster -// snapshot is public and can be copied or restored by all Amazon Web Services -// accounts. -// -// * If the configuration is for an existing Amazon RDS DB cluster -// snapshot and you do not specify the accountIds in -// RdsDbClusterSnapshotAttributeValue, then the access preview uses the existing -// shared accountIds for the snapshot. -// -// * If the access preview is for a new -// resource and you do not specify the specify the accountIds in -// RdsDbClusterSnapshotAttributeValue, then the access preview considers the -// snapshot without any attributes. -// -// * To propose deletion of existing shared -// accountIds, you can specify an empty list for accountIds in the -// RdsDbClusterSnapshotAttributeValue. +// The Amazon Web Services account IDs that have access to the manual Amazon RDS +// DB cluster snapshot. If the value all is specified, then the Amazon RDS DB +// cluster snapshot is public and can be copied or restored by all Amazon Web +// Services accounts. +// - If the configuration is for an existing Amazon RDS DB cluster snapshot and +// you do not specify the accountIds in RdsDbClusterSnapshotAttributeValue , then +// the access preview uses the existing shared accountIds for the snapshot. +// - If the access preview is for a new resource and you do not specify the +// specify the accountIds in RdsDbClusterSnapshotAttributeValue , then the access +// preview considers the snapshot without any attributes. +// - To propose deletion of existing shared accountIds , you can specify an empty +// list for accountIds in the RdsDbClusterSnapshotAttributeValue . type RdsDbClusterSnapshotAttributeValueMemberAccountIds struct { Value []string @@ -1284,31 +1233,29 @@ type RdsDbClusterSnapshotAttributeValueMemberAccountIds struct { func (*RdsDbClusterSnapshotAttributeValueMemberAccountIds) isRdsDbClusterSnapshotAttributeValue() {} -// The proposed access control configuration for an Amazon RDS DB cluster snapshot. -// You can propose a configuration for a new Amazon RDS DB cluster snapshot or an -// Amazon RDS DB cluster snapshot that you own by specifying the +// The proposed access control configuration for an Amazon RDS DB cluster +// snapshot. You can propose a configuration for a new Amazon RDS DB cluster +// snapshot or an Amazon RDS DB cluster snapshot that you own by specifying the // RdsDbClusterSnapshotAttributeValue and optional KMS encryption key. For more -// information, see ModifyDBClusterSnapshotAttribute -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBClusterSnapshotAttribute.html). +// information, see ModifyDBClusterSnapshotAttribute (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBClusterSnapshotAttribute.html) +// . type RdsDbClusterSnapshotConfiguration struct { - // The names and values of manual DB cluster snapshot attributes. Manual DB cluster - // snapshot attributes are used to authorize other Amazon Web Services accounts to - // restore a manual DB cluster snapshot. The only valid value for AttributeName for - // the attribute map is restore + // The names and values of manual DB cluster snapshot attributes. Manual DB + // cluster snapshot attributes are used to authorize other Amazon Web Services + // accounts to restore a manual DB cluster snapshot. The only valid value for + // AttributeName for the attribute map is restore Attributes map[string]RdsDbClusterSnapshotAttributeValue // The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS - // key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS - // key. - // - // * If the configuration is for an existing Amazon RDS DB cluster snapshot - // and you do not specify the kmsKeyId, or you specify an empty string, then the - // access preview uses the existing kmsKeyId of the snapshot. - // - // * If the access - // preview is for a new resource and you do not specify the specify the kmsKeyId, - // then the access preview considers the snapshot as unencrypted. + // key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + // + // - If the configuration is for an existing Amazon RDS DB cluster snapshot and + // you do not specify the kmsKeyId , or you specify an empty string, then the + // access preview uses the existing kmsKeyId of the snapshot. + // - If the access preview is for a new resource and you do not specify the + // specify the kmsKeyId , then the access preview considers the snapshot as + // unencrypted. KmsKeyId *string noSmithyDocumentSerde @@ -1325,22 +1272,17 @@ type RdsDbSnapshotAttributeValue interface { isRdsDbSnapshotAttributeValue() } -// The Amazon Web Services account IDs that have access to the manual Amazon RDS DB -// snapshot. If the value all is specified, then the Amazon RDS DB snapshot is +// The Amazon Web Services account IDs that have access to the manual Amazon RDS +// DB snapshot. If the value all is specified, then the Amazon RDS DB snapshot is // public and can be copied or restored by all Amazon Web Services accounts. -// -// * If -// the configuration is for an existing Amazon RDS DB snapshot and you do not -// specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview -// uses the existing shared accountIds for the snapshot. -// -// * If the access preview -// is for a new resource and you do not specify the specify the accountIds in -// RdsDbSnapshotAttributeValue, then the access preview considers the snapshot -// without any attributes. -// -// * To propose deletion of an existing shared accountIds, -// you can specify an empty list for accountIds in the RdsDbSnapshotAttributeValue. +// - If the configuration is for an existing Amazon RDS DB snapshot and you do +// not specify the accountIds in RdsDbSnapshotAttributeValue , then the access +// preview uses the existing shared accountIds for the snapshot. +// - If the access preview is for a new resource and you do not specify the +// specify the accountIds in RdsDbSnapshotAttributeValue , then the access +// preview considers the snapshot without any attributes. +// - To propose deletion of an existing shared accountIds , you can specify an +// empty list for accountIds in the RdsDbSnapshotAttributeValue . type RdsDbSnapshotAttributeValueMemberAccountIds struct { Value []string @@ -1349,46 +1291,42 @@ type RdsDbSnapshotAttributeValueMemberAccountIds struct { func (*RdsDbSnapshotAttributeValueMemberAccountIds) isRdsDbSnapshotAttributeValue() {} -// The proposed access control configuration for an Amazon RDS DB snapshot. You can -// propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB -// snapshot that you own by specifying the RdsDbSnapshotAttributeValue and optional -// KMS encryption key. For more information, see ModifyDBSnapshotAttribute -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html). +// The proposed access control configuration for an Amazon RDS DB snapshot. You +// can propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB +// snapshot that you own by specifying the RdsDbSnapshotAttributeValue and +// optional KMS encryption key. For more information, see ModifyDBSnapshotAttribute (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBSnapshotAttribute.html) +// . type RdsDbSnapshotConfiguration struct { // The names and values of manual DB snapshot attributes. Manual DB snapshot // attributes are used to authorize other Amazon Web Services accounts to restore a - // manual DB snapshot. The only valid value for attributeName for the attribute map - // is restore. + // manual DB snapshot. The only valid value for attributeName for the attribute + // map is restore. Attributes map[string]RdsDbSnapshotAttributeValue // The KMS key identifier for an encrypted Amazon RDS DB snapshot. The KMS key // identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. - // - // * - // If the configuration is for an existing Amazon RDS DB snapshot and you do not - // specify the kmsKeyId, or you specify an empty string, then the access preview - // uses the existing kmsKeyId of the snapshot. - // - // * If the access preview is for a - // new resource and you do not specify the specify the kmsKeyId, then the access - // preview considers the snapshot as unencrypted. + // - If the configuration is for an existing Amazon RDS DB snapshot and you do + // not specify the kmsKeyId , or you specify an empty string, then the access + // preview uses the existing kmsKeyId of the snapshot. + // - If the access preview is for a new resource and you do not specify the + // specify the kmsKeyId , then the access preview considers the snapshot as + // unencrypted. KmsKeyId *string noSmithyDocumentSerde } -// The configuration for an Amazon S3 access point or multi-region access point for -// the bucket. You can propose up to 10 access points or multi-region access points -// per bucket. If the proposed Amazon S3 access point configuration is for an -// existing bucket, the access preview uses the proposed access point configuration -// in place of the existing access points. To propose an access point without a -// policy, you can provide an empty string as the access point policy. For more -// information, see Creating access points -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html). -// For more information about access point policy limits, see Access points -// restrictions and limitations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points-restrictions-limitations.html). +// The configuration for an Amazon S3 access point or multi-region access point +// for the bucket. You can propose up to 10 access points or multi-region access +// points per bucket. If the proposed Amazon S3 access point configuration is for +// an existing bucket, the access preview uses the proposed access point +// configuration in place of the existing access points. To propose an access point +// without a policy, you can provide an empty string as the access point policy. +// For more information, see Creating access points (https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html) +// . For more information about access point policy limits, see Access points +// restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points-restrictions-limitations.html) +// . type S3AccessPointConfiguration struct { // The access point or multi-region access point policy. @@ -1402,16 +1340,16 @@ type S3AccessPointConfiguration struct { // network origin. NetworkOrigin NetworkOriginConfiguration - // The proposed S3PublicAccessBlock configuration to apply to this Amazon S3 access - // point or multi-region access point. + // The proposed S3PublicAccessBlock configuration to apply to this Amazon S3 + // access point or multi-region access point. PublicAccessBlock *S3PublicAccessBlockConfiguration noSmithyDocumentSerde } // A proposed access control list grant configuration for an Amazon S3 bucket. For -// more information, see How to Specify an ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#setting-acls). +// more information, see How to Specify an ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#setting-acls) +// . type S3BucketAclGrantConfiguration struct { // The grantee to whom you’re assigning access rights. @@ -1427,8 +1365,8 @@ type S3BucketAclGrantConfiguration struct { noSmithyDocumentSerde } -// Proposed access control configuration for an Amazon S3 bucket. You can propose a -// configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that +// Proposed access control configuration for an Amazon S3 bucket. You can propose +// a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that // you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA // settings, Amazon S3 access points, and multi-region access points attached to // the bucket. If the configuration is for an existing Amazon S3 bucket and you do @@ -1437,8 +1375,8 @@ type S3BucketAclGrantConfiguration struct { // you do not specify the Amazon S3 bucket policy, the access preview assumes a // bucket without a policy. To propose deletion of an existing bucket policy, you // can specify an empty string. For more information about bucket policy limits, -// see Bucket Policy Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html). +// see Bucket Policy Examples (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) +// . type S3BucketConfiguration struct { // The configuration of Amazon S3 access points or multi-region access points for @@ -1465,11 +1403,11 @@ type S3BucketConfiguration struct { // proposed configuration is for an existing Amazon S3 bucket and the configuration // is not specified, the access preview uses the existing setting. If the proposed // configuration is for a new bucket and the configuration is not specified, the -// access preview uses false. If the proposed configuration is for a new access +// access preview uses false . If the proposed configuration is for a new access // point or multi-region access point and the access point BPA configuration is not -// specified, the access preview uses true. For more information, see -// PublicAccessBlockConfiguration -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html). +// specified, the access preview uses true . For more information, see +// PublicAccessBlockConfiguration (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html) +// . type S3PublicAccessBlockConfiguration struct { // Specifies whether Amazon S3 should ignore public ACLs for this bucket and @@ -1488,21 +1426,20 @@ type S3PublicAccessBlockConfiguration struct { } // The configuration for a Secrets Manager secret. For more information, see -// CreateSecret -// (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html). -// You can propose a configuration for a new secret or an existing secret that you -// own by specifying the secret policy and optional KMS encryption key. If the +// CreateSecret (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html) +// . You can propose a configuration for a new secret or an existing secret that +// you own by specifying the secret policy and optional KMS encryption key. If the // configuration is for an existing secret and you do not specify the secret // policy, the access preview uses the existing policy for the secret. If the // access preview is for a new resource and you do not specify the policy, the // access preview assumes a secret without a policy. To propose deletion of an // existing policy, you can specify an empty string. If the proposed configuration // is for a new secret and you do not specify the KMS key ID, the access preview -// uses the Amazon Web Services managed key aws/secretsmanager. If you specify an +// uses the Amazon Web Services managed key aws/secretsmanager . If you specify an // empty string for the KMS key ID, the access preview uses the Amazon Web Services // managed key of the Amazon Web Services account. For more information about -// secret policy limits, see Quotas for Secrets Manager. -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html). +// secret policy limits, see Quotas for Secrets Manager. (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html) +// . type SecretsManagerSecretConfiguration struct { // The proposed ARN, key ID, or alias of the KMS key. @@ -1522,14 +1459,13 @@ type SecretsManagerSecretConfiguration struct { // preview is for a new resource and you do not specify the policy, then the access // preview assumes an Amazon SNS topic without a policy. To propose deletion of an // existing Amazon SNS topic policy, you can specify an empty string for the Amazon -// SNS policy. For more information, see Topic -// (https://docs.aws.amazon.com/sns/latest/api/API_Topic.html). +// SNS policy. For more information, see Topic (https://docs.aws.amazon.com/sns/latest/api/API_Topic.html) +// . type SnsTopicConfiguration struct { // The JSON policy text that defines who can access an Amazon SNS topic. For more - // information, see Example cases for Amazon SNS access control - // (https://docs.aws.amazon.com/sns/latest/dg/sns-access-policy-use-cases.html) in - // the Amazon SNS Developer Guide. + // information, see Example cases for Amazon SNS access control (https://docs.aws.amazon.com/sns/latest/dg/sns-access-policy-use-cases.html) + // in the Amazon SNS Developer Guide. TopicPolicy *string noSmithyDocumentSerde @@ -1573,8 +1509,8 @@ type Span struct { // access preview assumes an Amazon SQS queue without a policy. To propose deletion // of an existing Amazon SQS queue policy, you can specify an empty string for the // Amazon SQS policy. For more information about Amazon SQS policy limits, see -// Quotas related to policies -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-policies.html). +// Quotas related to policies (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-policies.html) +// . type SqsQueueConfiguration struct { // The proposed resource policy for the Amazon SQS queue. @@ -1618,13 +1554,13 @@ type Substring struct { type Trail struct { // Specifies the ARN of the trail. The format of a trail ARN is - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail. + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail . // // This member is required. CloudTrailArn *string - // Possible values are true or false. If set to true, IAM Access Analyzer retrieves - // CloudTrail data from all regions to analyze and generate a policy. + // Possible values are true or false . If set to true , IAM Access Analyzer + // retrieves CloudTrail data from all regions to analyze and generate a policy. AllRegions *bool // A list of regions to get CloudTrail data from and analyze to generate a policy. @@ -1637,13 +1573,13 @@ type Trail struct { type TrailProperties struct { // Specifies the ARN of the trail. The format of a trail ARN is - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail. + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail . // // This member is required. CloudTrailArn *string - // Possible values are true or false. If set to true, IAM Access Analyzer retrieves - // CloudTrail data from all regions to analyze and generate a policy. + // Possible values are true or false . If set to true , IAM Access Analyzer + // retrieves CloudTrail data from all regions to analyze and generate a policy. AllRegions *bool // A list of regions to get CloudTrail data from and analyze to generate a policy. @@ -1708,8 +1644,8 @@ type ValidationExceptionField struct { // The proposed virtual private cloud (VPC) configuration for the Amazon S3 access // point. VPC configuration does not apply to multi-region access points. For more -// information, see VpcConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html). +// information, see VpcConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html) +// . type VpcConfiguration struct { // If this field is specified, this access point will only allow connections from diff --git a/service/account/api_client.go b/service/account/api_client.go index 7dfa4c3d694..4b2940708f1 100644 --- a/service/account/api_client.go +++ b/service/account/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/account/api_op_DeleteAlternateContact.go b/service/account/api_op_DeleteAlternateContact.go index de4f59519c2..e468ac2fea3 100644 --- a/service/account/api_op_DeleteAlternateContact.go +++ b/service/account/api_op_DeleteAlternateContact.go @@ -11,16 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified alternate contact from an Amazon Web Services account. For -// complete details about how to use the alternate contact operations, see Access -// or updating the alternate contacts -// (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html). -// Before you can update the alternate contact information for an Amazon Web +// Deletes the specified alternate contact from an Amazon Web Services account. +// For complete details about how to use the alternate contact operations, see +// Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html) +// . Before you can update the alternate contact information for an Amazon Web // Services account that is managed by Organizations, you must first enable // integration between Amazon Web Services Account Management and Organizations. // For more information, see Enabling trusted access for Amazon Web Services -// Account Management -// (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html). +// Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html) +// . func (c *Client) DeleteAlternateContact(ctx context.Context, params *DeleteAlternateContactInput, optFns ...func(*Options)) (*DeleteAlternateContactOutput, error) { if params == nil { params = &DeleteAlternateContactInput{} @@ -43,21 +42,17 @@ type DeleteAlternateContactInput struct { // This member is required. AlternateContactType types.AlternateContactType - // Specifies the 12 digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you do not specify this - // parameter, it defaults to the Amazon Web Services account of the identity used - // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // Specifies the 12 digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you do not specify + // this parameter, it defaults to the Amazon Web Services account of the identity + // used to call the operation. To use this parameter, the caller must be an + // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId; it + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId ; it // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, then don't specify this parameter, and call the operation using an diff --git a/service/account/api_op_DisableRegion.go b/service/account/api_op_DisableRegion.go index b2abd93cfa3..3ed15a26144 100644 --- a/service/account/api_op_DisableRegion.go +++ b/service/account/api_op_DisableRegion.go @@ -28,7 +28,7 @@ func (c *Client) DisableRegion(ctx context.Context, params *DisableRegionInput, type DisableRegionInput struct { - // Specifies the Region-code for a given Region name (for example, af-south-1). + // Specifies the Region-code for a given Region name (for example, af-south-1 ). // When you disable a Region, Amazon Web Services performs actions to deactivate // that Region in your account, such as destroying IAM resources in the Region. // This process takes a few minutes for most accounts, but this can take several @@ -38,21 +38,17 @@ type DisableRegionInput struct { // This member is required. RegionName *string - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an diff --git a/service/account/api_op_EnableRegion.go b/service/account/api_op_EnableRegion.go index 3993a2f1775..ee805dea042 100644 --- a/service/account/api_op_EnableRegion.go +++ b/service/account/api_op_EnableRegion.go @@ -28,7 +28,7 @@ func (c *Client) EnableRegion(ctx context.Context, params *EnableRegionInput, op type EnableRegionInput struct { - // Specifies the Region-code for a given Region name (for example, af-south-1). + // Specifies the Region-code for a given Region name (for example, af-south-1 ). // When you enable a Region, Amazon Web Services performs actions to prepare your // account in that Region, such as distributing your IAM resources to the Region. // This process takes a few minutes for most accounts, but it can take several @@ -38,21 +38,17 @@ type EnableRegionInput struct { // This member is required. RegionName *string - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an diff --git a/service/account/api_op_GetAlternateContact.go b/service/account/api_op_GetAlternateContact.go index 73d553f8949..3eb2cb7a678 100644 --- a/service/account/api_op_GetAlternateContact.go +++ b/service/account/api_op_GetAlternateContact.go @@ -13,14 +13,13 @@ import ( // Retrieves the specified alternate contact attached to an Amazon Web Services // account. For complete details about how to use the alternate contact operations, -// see Access or updating the alternate contacts -// (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html). -// Before you can update the alternate contact information for an Amazon Web +// see Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html) +// . Before you can update the alternate contact information for an Amazon Web // Services account that is managed by Organizations, you must first enable // integration between Amazon Web Services Account Management and Organizations. // For more information, see Enabling trusted access for Amazon Web Services -// Account Management -// (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html). +// Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html) +// . func (c *Client) GetAlternateContact(ctx context.Context, params *GetAlternateContactInput, optFns ...func(*Options)) (*GetAlternateContactOutput, error) { if params == nil { params = &GetAlternateContactInput{} @@ -43,21 +42,17 @@ type GetAlternateContactInput struct { // This member is required. AlternateContactType types.AlternateContactType - // Specifies the 12 digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you do not specify this - // parameter, it defaults to the Amazon Web Services account of the identity used - // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // Specifies the 12 digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you do not specify + // this parameter, it defaults to the Amazon Web Services account of the identity + // used to call the operation. To use this parameter, the caller must be an + // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId; it + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId ; it // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, then don't specify this parameter, and call the operation using an diff --git a/service/account/api_op_GetContactInformation.go b/service/account/api_op_GetContactInformation.go index 60757d035b9..bc8cc9247fc 100644 --- a/service/account/api_op_GetContactInformation.go +++ b/service/account/api_op_GetContactInformation.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the primary contact information of an Amazon Web Services account. For -// complete details about how to use the primary contact operations, see Update the -// primary and alternate contact information -// (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html). +// Retrieves the primary contact information of an Amazon Web Services account. +// For complete details about how to use the primary contact operations, see +// Update the primary and alternate contact information (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html) +// . func (c *Client) GetContactInformation(ctx context.Context, params *GetContactInformationInput, optFns ...func(*Options)) (*GetContactInformationOutput, error) { if params == nil { params = &GetContactInformationInput{} @@ -32,21 +32,17 @@ func (c *Client) GetContactInformation(ctx context.Context, params *GetContactIn type GetContactInformationInput struct { - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an diff --git a/service/account/api_op_GetRegionOptStatus.go b/service/account/api_op_GetRegionOptStatus.go index ce941180a46..8ca66e15f38 100644 --- a/service/account/api_op_GetRegionOptStatus.go +++ b/service/account/api_op_GetRegionOptStatus.go @@ -29,28 +29,24 @@ func (c *Client) GetRegionOptStatus(ctx context.Context, params *GetRegionOptSta type GetRegionOptStatusInput struct { - // Specifies the Region-code for a given Region name (for example, af-south-1). + // Specifies the Region-code for a given Region name (for example, af-south-1 ). // This function will return the status of whatever Region you pass into this // parameter. // // This member is required. RegionName *string - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an @@ -65,8 +61,8 @@ type GetRegionOptStatusOutput struct { // The Region code that was passed in. RegionName *string - // One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, - // Disabling, Enabled_By_Default). + // One of the potential statuses a Region can undergo (Enabled, Enabling, + // Disabled, Disabling, Enabled_By_Default). RegionOptStatus types.RegionOptStatus // Metadata pertaining to the operation's result. diff --git a/service/account/api_op_ListRegions.go b/service/account/api_op_ListRegions.go index c3b3027928a..af9c269dbc2 100644 --- a/service/account/api_op_ListRegions.go +++ b/service/account/api_op_ListRegions.go @@ -32,41 +32,35 @@ func (c *Client) ListRegions(ctx context.Context, params *ListRegionsInput, optF type ListRegionsInput struct { - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an // identity belonging to the account whose contacts you wish to retrieve or modify. AccountId *string - // The total number of items to return in the command’s output. If the total number - // of items available is more than the value specified, a NextToken is provided in - // the command’s output. To resume pagination, provide the NextToken value in the - // starting-token argument of a subsequent command. Do not use the NextToken - // response element directly outside of the Amazon Web Services CLI. For usage - // examples, see Pagination - // (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the Amazon - // Web Services Command Line Interface User Guide. + // The total number of items to return in the command’s output. If the total + // number of items available is more than the value specified, a NextToken is + // provided in the command’s output. To resume pagination, provide the NextToken + // value in the starting-token argument of a subsequent command. Do not use the + // NextToken response element directly outside of the Amazon Web Services CLI. For + // usage examples, see Pagination (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // in the Amazon Web Services Command Line Interface User Guide. MaxResults *int32 // A token used to specify where to start paginating. This is the NextToken from a - // previously truncated response. For usage examples, see Pagination - // (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the Amazon - // Web Services Command Line Interface User Guide. + // previously truncated response. For usage examples, see Pagination (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // in the Amazon Web Services Command Line Interface User Guide. NextToken *string // A list of Region statuses (Enabling, Enabled, Disabling, Disabled, @@ -81,7 +75,7 @@ type ListRegionsInput struct { type ListRegionsOutput struct { // If there is more data to be returned, this will be populated. It should be - // passed into the next-token request parameter of list-regions. + // passed into the next-token request parameter of list-regions . NextToken *string // This is a list of Regions for a given account, or if the filtered parameter was @@ -164,14 +158,13 @@ var _ ListRegionsAPIClient = (*Client)(nil) // ListRegionsPaginatorOptions is the paginator options for ListRegions type ListRegionsPaginatorOptions struct { - // The total number of items to return in the command’s output. If the total number - // of items available is more than the value specified, a NextToken is provided in - // the command’s output. To resume pagination, provide the NextToken value in the - // starting-token argument of a subsequent command. Do not use the NextToken - // response element directly outside of the Amazon Web Services CLI. For usage - // examples, see Pagination - // (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the Amazon - // Web Services Command Line Interface User Guide. + // The total number of items to return in the command’s output. If the total + // number of items available is more than the value specified, a NextToken is + // provided in the command’s output. To resume pagination, provide the NextToken + // value in the starting-token argument of a subsequent command. Do not use the + // NextToken response element directly outside of the Amazon Web Services CLI. For + // usage examples, see Pagination (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // in the Amazon Web Services Command Line Interface User Guide. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/account/api_op_PutAlternateContact.go b/service/account/api_op_PutAlternateContact.go index bc1b1c3efe8..f9c862430da 100644 --- a/service/account/api_op_PutAlternateContact.go +++ b/service/account/api_op_PutAlternateContact.go @@ -13,14 +13,13 @@ import ( // Modifies the specified alternate contact attached to an Amazon Web Services // account. For complete details about how to use the alternate contact operations, -// see Access or updating the alternate contacts -// (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html). -// Before you can update the alternate contact information for an Amazon Web +// see Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html) +// . Before you can update the alternate contact information for an Amazon Web // Services account that is managed by Organizations, you must first enable // integration between Amazon Web Services Account Management and Organizations. // For more information, see Enabling trusted access for Amazon Web Services -// Account Management -// (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html). +// Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html) +// . func (c *Client) PutAlternateContact(ctx context.Context, params *PutAlternateContactInput, optFns ...func(*Options)) (*PutAlternateContactOutput, error) { if params == nil { params = &PutAlternateContactInput{} @@ -63,21 +62,17 @@ type PutAlternateContactInput struct { // This member is required. Title *string - // Specifies the 12 digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you do not specify this - // parameter, it defaults to the Amazon Web Services account of the identity used - // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // Specifies the 12 digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you do not specify + // this parameter, it defaults to the Amazon Web Services account of the identity + // used to call the operation. To use this parameter, the caller must be an + // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId; it + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId ; it // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, then don't specify this parameter, and call the operation using an diff --git a/service/account/api_op_PutContactInformation.go b/service/account/api_op_PutContactInformation.go index 024fd89edba..0ee8b641998 100644 --- a/service/account/api_op_PutContactInformation.go +++ b/service/account/api_op_PutContactInformation.go @@ -12,9 +12,9 @@ import ( ) // Updates the primary contact information of an Amazon Web Services account. For -// complete details about how to use the primary contact operations, see Update the -// primary and alternate contact information -// (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html). +// complete details about how to use the primary contact operations, see Update +// the primary and alternate contact information (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html) +// . func (c *Client) PutContactInformation(ctx context.Context, params *PutContactInformationInput, optFns ...func(*Options)) (*PutContactInformationOutput, error) { if params == nil { params = &PutContactInformationInput{} @@ -38,21 +38,17 @@ type PutContactInformationInput struct { // This member is required. ContactInformation *types.ContactInformation - // Specifies the 12-digit account ID number of the Amazon Web Services account that - // you want to access or modify with this operation. If you don't specify this + // Specifies the 12-digit account ID number of the Amazon Web Services account + // that you want to access or modify with this operation. If you don't specify this // parameter, it defaults to the Amazon Web Services account of the identity used // to call the operation. To use this parameter, the caller must be an identity in - // the organization's management account - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) + // the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must also be a - // member account in the same organization. The organization must have all features - // enabled - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), - // and the organization must have trusted access - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) - // enabled for the Account Management service, and optionally a delegated admin - // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) - // account assigned. The management account can't specify its own AccountId. It + // member account in the same organization. The organization must have all + // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // , and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) + // enabled for the Account Management service, and optionally a delegated admin (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) + // account assigned. The management account can't specify its own AccountId . It // must call the operation in standalone context by not including the AccountId // parameter. To call this operation on an account that is not a member of an // organization, don't specify this parameter. Instead, call the operation using an diff --git a/service/account/doc.go b/service/account/doc.go index b547c324667..2c482eb6af1 100644 --- a/service/account/doc.go +++ b/service/account/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package account provides the API client, operations, and parameter types for AWS -// Account. +// Package account provides the API client, operations, and parameter types for +// AWS Account. // // Operations for Amazon Web Services Account Management package account diff --git a/service/account/types/types.go b/service/account/types/types.go index 2649f6e1c94..adb6347e575 100644 --- a/service/account/types/types.go +++ b/service/account/types/types.go @@ -6,8 +6,8 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// A structure that contains the details of an alternate contact associated with an -// Amazon Web Services account +// A structure that contains the details of an alternate contact associated with +// an Amazon Web Services account type AlternateContact struct { // The type of alternate contact. @@ -85,11 +85,11 @@ type ContactInformation struct { noSmithyDocumentSerde } -// This is a structure that expresses the Region for a given account, consisting of -// a name and opt-in status. +// This is a structure that expresses the Region for a given account, consisting +// of a name and opt-in status. type Region struct { - // The Region code of a given Region (for example, us-east-1). + // The Region code of a given Region (for example, us-east-1 ). RegionName *string // One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, diff --git a/service/acm/api_client.go b/service/acm/api_client.go index 1564f356048..0ba270e3578 100644 --- a/service/acm/api_client.go +++ b/service/acm/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/acm/api_op_AddTagsToCertificate.go b/service/acm/api_op_AddTagsToCertificate.go index 0e03887dd6e..8d56e36ceee 100644 --- a/service/acm/api_op_AddTagsToCertificate.go +++ b/service/acm/api_op_AddTagsToCertificate.go @@ -11,22 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to an ACM certificate. Tags are labels that you can use to -// identify and organize your Amazon Web Services resources. Each tag consists of a -// key and an optional value. You specify the certificate on input by its Amazon -// Resource Name (ARN). You specify the tag by using a key-value pair. You can -// apply a tag to just one certificate if you want to identify a specific +// Adds one or more tags to an ACM certificate. Tags are labels that you can use +// to identify and organize your Amazon Web Services resources. Each tag consists +// of a key and an optional value . You specify the certificate on input by its +// Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You +// can apply a tag to just one certificate if you want to identify a specific // characteristic of that certificate, or you can apply the same tag to multiple // certificates if you want to filter for a common relationship among those // certificates. Similarly, you can apply the same tag to multiple resources if you // want to specify a relationship among those resources. For example, you can add // the same tag to an ACM certificate and an Elastic Load Balancing load balancer // to indicate that they are both used by the same website. For more information, -// see Tagging ACM certificates -// (https://docs.aws.amazon.com/acm/latest/userguide/tags.html). To remove one or -// more tags, use the RemoveTagsFromCertificate action. To view all of the tags -// that have been applied to the certificate, use the ListTagsForCertificate -// action. +// see Tagging ACM certificates (https://docs.aws.amazon.com/acm/latest/userguide/tags.html) +// . To remove one or more tags, use the RemoveTagsFromCertificate action. To view +// all of the tags that have been applied to the certificate, use the +// ListTagsForCertificate action. func (c *Client) AddTagsToCertificate(ctx context.Context, params *AddTagsToCertificateInput, optFns ...func(*Options)) (*AddTagsToCertificateOutput, error) { if params == nil { params = &AddTagsToCertificateInput{} @@ -47,8 +46,8 @@ type AddTagsToCertificateInput struct { // String that contains the ARN of the ACM certificate to which the tag is to be // applied. This must be of the form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_DeleteCertificate.go b/service/acm/api_op_DeleteCertificate.go index 65db3f55eee..c46121bc274 100644 --- a/service/acm/api_op_DeleteCertificate.go +++ b/service/acm/api_op_DeleteCertificate.go @@ -37,8 +37,8 @@ type DeleteCertificateInput struct { // String that contains the ARN of the ACM certificate to be deleted. This must be // of the form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_DescribeCertificate.go b/service/acm/api_op_DescribeCertificate.go index 15ab763303b..3d1a8c231f3 100644 --- a/service/acm/api_op_DescribeCertificate.go +++ b/service/acm/api_op_DescribeCertificate.go @@ -40,8 +40,8 @@ type DescribeCertificateInput struct { // The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the // following form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string @@ -123,8 +123,8 @@ func (c *Client) addOperationDescribeCertificateMiddlewares(stack *middleware.St return nil } -// DescribeCertificateAPIClient is a client that implements the DescribeCertificate -// operation. +// DescribeCertificateAPIClient is a client that implements the +// DescribeCertificate operation. type DescribeCertificateAPIClient interface { DescribeCertificate(context.Context, *DescribeCertificateInput, ...func(*Options)) (*DescribeCertificateOutput, error) } @@ -145,9 +145,10 @@ type CertificateValidatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CertificateValidatedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CertificateValidatedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/acm/api_op_ExportCertificate.go b/service/acm/api_op_ExportCertificate.go index e60bd8fad14..c96966a57c3 100644 --- a/service/acm/api_op_ExportCertificate.go +++ b/service/acm/api_op_ExportCertificate.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a private certificate issued by a private certificate authority (CA) for -// use anywhere. The exported file contains the certificate, the certificate chain, -// and the encrypted private 2048-bit RSA key associated with the public key that -// is embedded in the certificate. For security, you must assign a passphrase for -// the private key when exporting it. For information about exporting and +// Exports a private certificate issued by a private certificate authority (CA) +// for use anywhere. The exported file contains the certificate, the certificate +// chain, and the encrypted private 2048-bit RSA key associated with the public key +// that is embedded in the certificate. For security, you must assign a passphrase +// for the private key when exporting it. For information about exporting and // formatting a certificate using the ACM console or CLI, see Export a Private -// Certificate -// (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-export-private.html). +// Certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-export-private.html) +// . func (c *Client) ExportCertificate(ctx context.Context, params *ExportCertificateInput, optFns ...func(*Options)) (*ExportCertificateOutput, error) { if params == nil { params = &ExportCertificateInput{} @@ -64,8 +64,8 @@ type ExportCertificateOutput struct { // that you are exporting. CertificateChain *string - // The encrypted private key associated with the public key in the certificate. The - // key is output in PKCS #8 format and is base64 PEM-encoded. + // The encrypted private key associated with the public key in the certificate. + // The key is output in PKCS #8 format and is base64 PEM-encoded. PrivateKey *string // Metadata pertaining to the operation's result. diff --git a/service/acm/api_op_GetAccountConfiguration.go b/service/acm/api_op_GetAccountConfiguration.go index 28bbd847fbc..31d2e21ae7e 100644 --- a/service/acm/api_op_GetAccountConfiguration.go +++ b/service/acm/api_op_GetAccountConfiguration.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the account configuration options associated with an Amazon Web Services -// account. +// Returns the account configuration options associated with an Amazon Web +// Services account. func (c *Client) GetAccountConfiguration(ctx context.Context, params *GetAccountConfigurationInput, optFns ...func(*Options)) (*GetAccountConfigurationOutput, error) { if params == nil { params = &GetAccountConfigurationInput{} diff --git a/service/acm/api_op_GetCertificate.go b/service/acm/api_op_GetCertificate.go index 733fe763216..b5161f5eda2 100644 --- a/service/acm/api_op_GetCertificate.go +++ b/service/acm/api_op_GetCertificate.go @@ -34,8 +34,8 @@ type GetCertificateInput struct { // String that contains a certificate ARN in the following format: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_ImportCertificate.go b/service/acm/api_op_ImportCertificate.go index 83aaa8dcbdd..64410a29d31 100644 --- a/service/acm/api_op_ImportCertificate.go +++ b/service/acm/api_op_ImportCertificate.go @@ -12,70 +12,45 @@ import ( ) // Imports a certificate into Certificate Manager (ACM) to use with services that -// are integrated with ACM. Note that integrated services -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html) allow only -// certificate types and keys they support to be associated with their resources. -// Further, their support differs depending on whether the certificate is imported -// into IAM or into ACM. For more information, see the documentation for each -// service. For more information about importing certificates into ACM, see -// Importing Certificates -// (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in -// the Certificate Manager User Guide. ACM does not provide managed renewal -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for -// certificates that you import. Note the following guidelines when importing third -// party certificates: +// are integrated with ACM. Note that integrated services (https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html) +// allow only certificate types and keys they support to be associated with their +// resources. Further, their support differs depending on whether the certificate +// is imported into IAM or into ACM. For more information, see the documentation +// for each service. For more information about importing certificates into ACM, +// see Importing Certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) +// in the Certificate Manager User Guide. ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) +// for certificates that you import. Note the following guidelines when importing +// third party certificates: +// - You must enter the private key that matches the certificate you are +// importing. +// - The private key must be unencrypted. You cannot import a private key that +// is protected by a password or a passphrase. +// - The private key must be no larger than 5 KB (5,120 bytes). +// - If the certificate you are importing is not self-signed, you must enter its +// certificate chain. +// - If a certificate chain is included, the issuer must be the subject of one +// of the certificates in the chain. +// - The certificate, private key, and certificate chain must be PEM-encoded. +// - The current time must be between the Not Before and Not After certificate +// fields. +// - The Issuer field must not be empty. +// - The OCSP authority URL, if present, must not exceed 1000 characters. +// - To import a new certificate, omit the CertificateArn argument. Include this +// argument only when you want to replace a previously imported certificate. +// - When you import a certificate by using the CLI, you must specify the +// certificate, the certificate chain, and the private key by their file names +// preceded by fileb:// . For example, you can specify a certificate saved in the +// C:\temp folder as fileb://C:\temp\certificate_to_import.pem . If you are +// making an HTTP or HTTPS Query request, include these arguments as BLOBs. +// - When you import a certificate by using an SDK, you must specify the +// certificate, the certificate chain, and the private key files in the manner +// required by the programming language you're using. +// - The cryptographic algorithm of an imported certificate must match the +// algorithm of the signing CA. For example, if the signing CA key type is RSA, +// then the certificate key type must also be RSA. // -// * You must enter the private key that matches the -// certificate you are importing. -// -// * The private key must be unencrypted. You -// cannot import a private key that is protected by a password or a passphrase. -// -// * -// The private key must be no larger than 5 KB (5,120 bytes). -// -// * If the certificate -// you are importing is not self-signed, you must enter its certificate chain. -// -// * -// If a certificate chain is included, the issuer must be the subject of one of the -// certificates in the chain. -// -// * The certificate, private key, and certificate -// chain must be PEM-encoded. -// -// * The current time must be between the Not Before -// and Not After certificate fields. -// -// * The Issuer field must not be empty. -// -// * The -// OCSP authority URL, if present, must not exceed 1000 characters. -// -// * To import a -// new certificate, omit the CertificateArn argument. Include this argument only -// when you want to replace a previously imported certificate. -// -// * When you import a -// certificate by using the CLI, you must specify the certificate, the certificate -// chain, and the private key by their file names preceded by fileb://. For -// example, you can specify a certificate saved in the C:\temp folder as -// fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS -// Query request, include these arguments as BLOBs. -// -// * When you import a -// certificate by using an SDK, you must specify the certificate, the certificate -// chain, and the private key files in the manner required by the programming -// language you're using. -// -// * The cryptographic algorithm of an imported certificate -// must match the algorithm of the signing CA. For example, if the signing CA key -// type is RSA, then the certificate key type must also be RSA. -// -// This operation -// returns the Amazon Resource Name (ARN) -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of -// the imported certificate. +// This operation returns the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// of the imported certificate. func (c *Client) ImportCertificate(ctx context.Context, params *ImportCertificateInput, optFns ...func(*Options)) (*ImportCertificateOutput, error) { if params == nil { params = &ImportCertificateInput{} @@ -103,9 +78,8 @@ type ImportCertificateInput struct { // This member is required. PrivateKey []byte - // The Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an imported certificate to replace. To import a new certificate, omit this + // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an imported certificate to replace. To import a new certificate, omit this // field. CertificateArn *string @@ -121,9 +95,8 @@ type ImportCertificateInput struct { type ImportCertificateOutput struct { - // The Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the imported certificate. + // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the imported certificate. CertificateArn *string // Metadata pertaining to the operation's result. diff --git a/service/acm/api_op_ListCertificates.go b/service/acm/api_op_ListCertificates.go index fb5472b97f8..9daa4cc0810 100644 --- a/service/acm/api_op_ListCertificates.go +++ b/service/acm/api_op_ListCertificates.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of certificate ARNs and domain names. You can request that only -// certificates that match a specific status be listed. You can also filter by +// Retrieves a list of certificate ARNs and domain names. You can request that +// only certificates that match a specific status be listed. You can also filter by // specific attributes of the certificate. Default filtering returns only RSA_2048 -// certificates. For more information, see Filters. +// certificates. For more information, see Filters . func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error) { if params == nil { params = &ListCertificatesInput{} @@ -41,21 +41,21 @@ type ListCertificatesInput struct { // Use this parameter when paginating results to specify the maximum number of // items to return in the response. If additional items exist beyond the number you - // specify, the NextToken element is sent in the response. Use this NextToken value - // in a subsequent request to retrieve additional items. + // specify, the NextToken element is sent in the response. Use this NextToken + // value in a subsequent request to retrieve additional items. MaxItems *int32 - // Use this parameter only when paginating results and only in a subsequent request - // after you receive a response with truncated results. Set it to the value of - // NextToken from the response you just received. + // Use this parameter only when paginating results and only in a subsequent + // request after you receive a response with truncated results. Set it to the value + // of NextToken from the response you just received. NextToken *string - // Specifies the field to sort results by. If you specify SortBy, you must also - // specify SortOrder. + // Specifies the field to sort results by. If you specify SortBy , you must also + // specify SortOrder . SortBy types.SortBy - // Specifies the order of sorted results. If you specify SortOrder, you must also - // specify SortBy. + // Specifies the order of sorted results. If you specify SortOrder , you must also + // specify SortBy . SortOrder types.SortOrder noSmithyDocumentSerde @@ -148,8 +148,8 @@ var _ ListCertificatesAPIClient = (*Client)(nil) type ListCertificatesPaginatorOptions struct { // Use this parameter when paginating results to specify the maximum number of // items to return in the response. If additional items exist beyond the number you - // specify, the NextToken element is sent in the response. Use this NextToken value - // in a subsequent request to retrieve additional items. + // specify, the NextToken element is sent in the response. Use this NextToken + // value in a subsequent request to retrieve additional items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/acm/api_op_ListTagsForCertificate.go b/service/acm/api_op_ListTagsForCertificate.go index 2fedb2549b9..fd6d2770533 100644 --- a/service/acm/api_op_ListTagsForCertificate.go +++ b/service/acm/api_op_ListTagsForCertificate.go @@ -13,8 +13,8 @@ import ( // Lists the tags that have been applied to the ACM certificate. Use the // certificate's Amazon Resource Name (ARN) to specify the certificate. To add a -// tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, -// use the RemoveTagsFromCertificate action. +// tag to an ACM certificate, use the AddTagsToCertificate action. To delete a +// tag, use the RemoveTagsFromCertificate action. func (c *Client) ListTagsForCertificate(ctx context.Context, params *ListTagsForCertificateInput, optFns ...func(*Options)) (*ListTagsForCertificateOutput, error) { if params == nil { params = &ListTagsForCertificateInput{} @@ -35,8 +35,8 @@ type ListTagsForCertificateInput struct { // String that contains the ARN of the ACM certificate for which you want to list // the tags. This must have the following form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_PutAccountConfiguration.go b/service/acm/api_op_PutAccountConfiguration.go index 770e58861a4..3301230ba29 100644 --- a/service/acm/api_op_PutAccountConfiguration.go +++ b/service/acm/api_op_PutAccountConfiguration.go @@ -12,7 +12,7 @@ import ( ) // Adds or modifies account-level configurations in ACM. The supported -// configuration option is DaysBeforeExpiry. This option specifies the number of +// configuration option is DaysBeforeExpiry . This option specifies the number of // days prior to certificate expiration when ACM starts generating EventBridge // events. ACM sends one event per day per certificate until the certificate // expires. By default, accounts receive events starting 45 days before certificate @@ -35,8 +35,8 @@ func (c *Client) PutAccountConfiguration(ctx context.Context, params *PutAccount type PutAccountConfigurationInput struct { // Customer-chosen string used to distinguish between calls to - // PutAccountConfiguration. Idempotency tokens time out after one hour. If you call - // PutAccountConfiguration multiple times with the same unexpired idempotency + // PutAccountConfiguration . Idempotency tokens time out after one hour. If you + // call PutAccountConfiguration multiple times with the same unexpired idempotency // token, ACM treats it as the same request and returns the original result. If you // change the idempotency token for each call, ACM treats each call as a new // request. diff --git a/service/acm/api_op_RemoveTagsFromCertificate.go b/service/acm/api_op_RemoveTagsFromCertificate.go index 6338e1f47b0..fcaaeb50fb5 100644 --- a/service/acm/api_op_RemoveTagsFromCertificate.go +++ b/service/acm/api_op_RemoveTagsFromCertificate.go @@ -38,8 +38,8 @@ type RemoveTagsFromCertificateInput struct { // String that contains the ARN of the ACM Certificate with one or more tags that // you want to remove. This must be of the form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_RenewCertificate.go b/service/acm/api_op_RenewCertificate.go index f273b7b3afa..10502b697c3 100644 --- a/service/acm/api_op_RenewCertificate.go +++ b/service/acm/api_op_RenewCertificate.go @@ -13,11 +13,9 @@ import ( // Renews an eligible ACM certificate. At this time, only exported private // certificates can be renewed with this operation. In order to renew your Amazon // Web Services Private CA certificates with ACM, you must first grant the ACM -// service principal permission to do so -// (https://docs.aws.amazon.com/privateca/latest/userguide/PcaPermissions.html). -// For more information, see Testing Managed Renewal -// (https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html) in the -// ACM User Guide. +// service principal permission to do so (https://docs.aws.amazon.com/privateca/latest/userguide/PcaPermissions.html) +// . For more information, see Testing Managed Renewal (https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html) +// in the ACM User Guide. func (c *Client) RenewCertificate(ctx context.Context, params *RenewCertificateInput, optFns ...func(*Options)) (*RenewCertificateOutput, error) { if params == nil { params = &RenewCertificateInput{} @@ -38,8 +36,8 @@ type RenewCertificateInput struct { // String that contains the ARN of the ACM certificate to be renewed. This must be // of the form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. CertificateArn *string diff --git a/service/acm/api_op_RequestCertificate.go b/service/acm/api_op_RequestCertificate.go index 64c2d580586..f2159dfba5c 100644 --- a/service/acm/api_op_RequestCertificate.go +++ b/service/acm/api_op_RequestCertificate.go @@ -13,21 +13,19 @@ import ( // Requests an ACM certificate for use with other Amazon Web Services services. To // request an ACM certificate, you must specify a fully qualified domain name -// (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the -// SubjectAlternativeNames parameter. If you are requesting a private certificate, -// domain validation is not required. If you are requesting a public certificate, -// each domain name that you specify must be validated to verify that you own or -// control the domain. You can use DNS validation -// (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or -// email validation -// (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). -// We recommend that you use DNS validation. ACM issues public certificates after -// receiving approval from the domain owner. ACM behavior differs from the RFC 6125 -// (https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2) specification of -// the certificate validation process. ACM first checks for a Subject Alternative -// Name, and, if it finds one, ignores the common name (CN). After successful -// completion of the RequestCertificate action, there is a delay of several seconds -// before you can retrieve information about the new certificate. +// (FQDN) in the DomainName parameter. You can also specify additional FQDNs in +// the SubjectAlternativeNames parameter. If you are requesting a private +// certificate, domain validation is not required. If you are requesting a public +// certificate, each domain name that you specify must be validated to verify that +// you own or control the domain. You can use DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) +// or email validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html) +// . We recommend that you use DNS validation. ACM issues public certificates after +// receiving approval from the domain owner. ACM behavior differs from the RFC 6125 (https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2) +// specification of the certificate validation process. ACM first checks for a +// Subject Alternative Name, and, if it finds one, ignores the common name (CN). +// After successful completion of the RequestCertificate action, there is a delay +// of several seconds before you can retrieve information about the new +// certificate. func (c *Client) RequestCertificate(ctx context.Context, params *RequestCertificateInput, optFns ...func(*Options)) (*RequestCertificateOutput, error) { if params == nil { params = &RequestCertificateInput{} @@ -49,11 +47,11 @@ type RequestCertificateInput struct { // secure with an ACM certificate. Use an asterisk (*) to create a wildcard // certificate that protects several sites in the same domain. For example, // *.example.com protects www.example.com, site.example.com, and - // images.example.com. In compliance with RFC 5280 - // (https://datatracker.ietf.org/doc/html/rfc5280), the length of the domain name - // (technically, the Common Name) that you provide cannot exceed 64 octets - // (characters), including periods. To add a longer domain name, specify it in the - // Subject Alternative Name field, which supports names up to 253 octets in length. + // images.example.com. In compliance with RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280) + // , the length of the domain name (technically, the Common Name) that you provide + // cannot exceed 64 octets (characters), including periods. To add a longer domain + // name, specify it in the Subject Alternative Name field, which supports names up + // to 253 octets in length. // // This member is required. DomainName *string @@ -61,10 +59,9 @@ type RequestCertificateInput struct { // The Amazon Resource Name (ARN) of the private certificate authority (CA) that // will be used to issue the certificate. If you do not provide an ARN and you are // trying to request a private certificate, ACM will attempt to issue a public - // certificate. For more information about private CAs, see the Amazon Web Services - // Private Certificate Authority - // (https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user - // guide. The ARN must have the following form: + // certificate. For more information about private CAs, see the Amazon Web + // Services Private Certificate Authority (https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) + // user guide. The ARN must have the following form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 CertificateAuthorityArn *string @@ -73,22 +70,22 @@ type RequestCertificateInput struct { DomainValidationOptions []types.DomainValidationOption // Customer chosen string that can be used to distinguish between calls to - // RequestCertificate. Idempotency tokens time out after one hour. Therefore, if + // RequestCertificate . Idempotency tokens time out after one hour. Therefore, if // you call RequestCertificate multiple times with the same idempotency token // within one hour, ACM recognizes that you are requesting only one certificate and // will issue only one. If you change the idempotency token for each call, ACM // recognizes that you are requesting multiple certificates. IdempotencyToken *string - // Specifies the algorithm of the public and private key pair that your certificate - // uses to encrypt data. RSA is the default key algorithm for ACM certificates. - // Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering - // security comparable to RSA keys but with greater computing efficiency. However, - // ECDSA is not supported by all network clients. Some AWS services may require RSA - // keys, or only support ECDSA keys of a particular size, while others allow the - // use of either RSA and ECDSA keys to ensure that compatibility is not broken. - // Check the requirements for the AWS service where you plan to deploy your - // certificate. Default: RSA_2048 + // Specifies the algorithm of the public and private key pair that your + // certificate uses to encrypt data. RSA is the default key algorithm for ACM + // certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are + // smaller, offering security comparable to RSA keys but with greater computing + // efficiency. However, ECDSA is not supported by all network clients. Some AWS + // services may require RSA keys, or only support ECDSA keys of a particular size, + // while others allow the use of either RSA and ECDSA keys to ensure that + // compatibility is not broken. Check the requirements for the AWS service where + // you plan to deploy your certificate. Default: RSA_2048 KeyAlgorithm types.KeyAlgorithm // Currently, you can use this parameter to specify whether to add the certificate @@ -96,43 +93,36 @@ type RequestCertificateInput struct { // detect SSL/TLS certificates that have been mistakenly or maliciously issued. // Certificates that have not been logged typically produce an error message in a // browser. For more information, see Opting Out of Certificate Transparency - // Logging - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). + // Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency) + // . Options *types.CertificateOptions - // Additional FQDNs to be included in the Subject Alternative Name extension of the - // ACM certificate. For example, add the name www.example.net to a certificate for - // which the DomainName field is www.example.com if users can reach your site by - // using either name. The maximum number of domain names that you can add to an ACM - // certificate is 100. However, the initial quota is 10 domain names. If you need - // more than 10 names, you must request a quota increase. For more information, see - // Quotas (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html). The - // maximum length of a SAN DNS name is 253 octets. The name is made up of multiple - // labels separated by periods. No label can be longer than 63 octets. Consider the - // following examples: - // - // * (63 octets).(63 octets).(63 octets).(61 octets) is legal - // because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds - // 63 octets. - // - // * (64 octets).(63 octets).(63 octets).(61 octets) is not legal - // because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first - // label exceeds 63 octets. - // - // * (63 octets).(63 octets).(63 octets).(62 octets) is - // not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds - // 253 octets. + // Additional FQDNs to be included in the Subject Alternative Name extension of + // the ACM certificate. For example, add the name www.example.net to a certificate + // for which the DomainName field is www.example.com if users can reach your site + // by using either name. The maximum number of domain names that you can add to an + // ACM certificate is 100. However, the initial quota is 10 domain names. If you + // need more than 10 names, you must request a quota increase. For more + // information, see Quotas (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html) + // . The maximum length of a SAN DNS name is 253 octets. The name is made up of + // multiple labels separated by periods. No label can be longer than 63 octets. + // Consider the following examples: + // - (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total + // length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. + // - (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the + // total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds + // 63 octets. + // - (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the + // total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets. SubjectAlternativeNames []string // One or more resource tags to associate with the certificate. Tags []types.Tag // The method you want to use if you are requesting a public certificate to - // validate that you own or control domain. You can validate with DNS - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or - // validate with email - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). - // We recommend that you use DNS validation. + // validate that you own or control domain. You can validate with DNS (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) + // or validate with email (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html) + // . We recommend that you use DNS validation. ValidationMethod types.ValidationMethod noSmithyDocumentSerde diff --git a/service/acm/api_op_ResendValidationEmail.go b/service/acm/api_op_ResendValidationEmail.go index 43cc4c8c393..f5cc5c27bb5 100644 --- a/service/acm/api_op_ResendValidationEmail.go +++ b/service/acm/api_op_ResendValidationEmail.go @@ -10,17 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Resends the email that requests domain ownership validation. The domain owner or -// an authorized representative must approve the ACM certificate before it can be -// issued. The certificate can be approved by clicking a link in the mail to +// Resends the email that requests domain ownership validation. The domain owner +// or an authorized representative must approve the ACM certificate before it can +// be issued. The certificate can be approved by clicking a link in the mail to // navigate to the Amazon certificate approval website and then clicking I Approve. // However, the validation email can be blocked by spam filters. Therefore, if you // do not receive the original mail, you can request that the mail be resent within // 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed // since your original request or since your last attempt to resend validation // mail, you must request a new certificate. For more information about setting up -// your contact email addresses, see Configure Email for your Domain -// (https://docs.aws.amazon.com/acm/latest/userguide/setup-email.html). +// your contact email addresses, see Configure Email for your Domain (https://docs.aws.amazon.com/acm/latest/userguide/setup-email.html) +// . func (c *Client) ResendValidationEmail(ctx context.Context, params *ResendValidationEmailInput, optFns ...func(*Options)) (*ResendValidationEmailOutput, error) { if params == nil { params = &ResendValidationEmailInput{} @@ -55,24 +55,16 @@ type ResendValidationEmailInput struct { Domain *string // The base validation domain that will act as the suffix of the email addresses - // that are used to send the emails. This must be the same as the Domain value or a - // superdomain of the Domain value. For example, if you requested a certificate for - // site.subdomain.example.com and specify a ValidationDomain of - // subdomain.example.com, ACM sends email to the domain registrant, technical - // contact, and administrative contact in WHOIS and the following five - // addresses: - // - // * admin@subdomain.example.com - // - // * - // administrator@subdomain.example.com - // - // * hostmaster@subdomain.example.com - // - // * - // postmaster@subdomain.example.com - // - // * webmaster@subdomain.example.com + // that are used to send the emails. This must be the same as the Domain value or + // a superdomain of the Domain value. For example, if you requested a certificate + // for site.subdomain.example.com and specify a ValidationDomain of + // subdomain.example.com , ACM sends email to the domain registrant, technical + // contact, and administrative contact in WHOIS and the following five addresses: + // - admin@subdomain.example.com + // - administrator@subdomain.example.com + // - hostmaster@subdomain.example.com + // - postmaster@subdomain.example.com + // - webmaster@subdomain.example.com // // This member is required. ValidationDomain *string diff --git a/service/acm/api_op_UpdateCertificateOptions.go b/service/acm/api_op_UpdateCertificateOptions.go index bbfebd1907f..eda32ccd35a 100644 --- a/service/acm/api_op_UpdateCertificateOptions.go +++ b/service/acm/api_op_UpdateCertificateOptions.go @@ -13,8 +13,8 @@ import ( // Updates a certificate. Currently, you can use this function to specify whether // to opt in to or out of recording your certificate in a certificate transparency -// log. For more information, see Opting Out of Certificate Transparency Logging -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). +// log. For more information, see Opting Out of Certificate Transparency Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency) +// . func (c *Client) UpdateCertificateOptions(ctx context.Context, params *UpdateCertificateOptionsInput, optFns ...func(*Options)) (*UpdateCertificateOptionsOutput, error) { if params == nil { params = &UpdateCertificateOptionsInput{} diff --git a/service/acm/doc.go b/service/acm/doc.go index ff37eb4b2f5..9574960e2f9 100644 --- a/service/acm/doc.go +++ b/service/acm/doc.go @@ -5,6 +5,6 @@ // // Certificate Manager You can use Certificate Manager (ACM) to manage SSL/TLS // certificates for your Amazon Web Services-based websites and applications. For -// more information about using ACM, see the Certificate Manager User Guide -// (https://docs.aws.amazon.com/acm/latest/userguide/). +// more information about using ACM, see the Certificate Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/) +// . package acm diff --git a/service/acm/types/enums.go b/service/acm/types/enums.go index 181c1e5440b..40a2198d6ec 100644 --- a/service/acm/types/enums.go +++ b/service/acm/types/enums.go @@ -78,9 +78,9 @@ const ( DomainStatusFailed DomainStatus = "FAILED" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "PENDING_VALIDATION", @@ -188,9 +188,9 @@ const ( KeyAlgorithmEcSecp521r1 KeyAlgorithm = "EC_secp521r1" ) -// Values returns all known values for KeyAlgorithm. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for KeyAlgorithm. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (KeyAlgorithm) Values() []KeyAlgorithm { return []KeyAlgorithm{ "RSA_1024", @@ -220,9 +220,9 @@ const ( KeyUsageNameCustom KeyUsageName = "CUSTOM" ) -// Values returns all known values for KeyUsageName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for KeyUsageName. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (KeyUsageName) Values() []KeyUsageName { return []KeyUsageName{ "DIGITAL_SIGNATURE", @@ -353,9 +353,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/acm/types/errors.go b/service/acm/types/errors.go index c7804217171..c5220af3f47 100644 --- a/service/acm/types/errors.go +++ b/service/acm/types/errors.go @@ -193,7 +193,7 @@ func (e *InvalidStateException) ErrorCode() string { func (e *InvalidStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // One or both of the values that make up the key-value pair is not valid. For -// example, you cannot specify a tag value that begins with aws:. +// example, you cannot specify a tag value that begins with aws: . type InvalidTagException struct { Message *string @@ -272,8 +272,8 @@ func (e *RequestInProgressException) ErrorCode() string { } func (e *RequestInProgressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The certificate is in use by another Amazon Web Services service in the caller's -// account. Remove the association and try again. +// The certificate is in use by another Amazon Web Services service in the +// caller's account. Remove the association and try again. type ResourceInUseException struct { Message *string diff --git a/service/acm/types/types.go b/service/acm/types/types.go index 70023b393c9..254a816bb9d 100644 --- a/service/acm/types/types.go +++ b/service/acm/types/types.go @@ -12,9 +12,8 @@ import ( type CertificateDetail struct { // The Amazon Resource Name (ARN) of the certificate. For more information about - // ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. CertificateArn *string // The Amazon Resource Name (ARN) of the private certificate authority (CA) that @@ -31,7 +30,7 @@ type CertificateDetail struct { // Contains information about the initial validation of each domain name that // occurs as a result of the RequestCertificate request. This field exists only - // when the certificate type is AMAZON_ISSUED. + // when the certificate type is AMAZON_ISSUED . DomainValidationOptions []DomainValidation // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object @@ -40,14 +39,13 @@ type CertificateDetail struct { ExtendedKeyUsages []ExtendedKeyUsage // The reason the certificate request failed. This value exists only when the - // certificate status is FAILED. For more information, see Certificate Request - // Failed - // (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed) + // certificate status is FAILED . For more information, see Certificate Request + // Failed (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed) // in the Certificate Manager User Guide. FailureReason FailureReason - // The date and time when the certificate was imported. This value exists only when - // the certificate type is IMPORTED. + // The date and time when the certificate was imported. This value exists only + // when the certificate type is IMPORTED . ImportedAt *time.Time // A list of ARNs for the Amazon Web Services resources that are using the @@ -56,7 +54,7 @@ type CertificateDetail struct { InUseBy []string // The time at which the certificate was issued. This value exists only when the - // certificate type is AMAZON_ISSUED. + // certificate type is AMAZON_ISSUED . IssuedAt *time.Time // The name of the certificate authority that issued and signed the certificate. @@ -88,17 +86,17 @@ type CertificateDetail struct { // exported private certificates can be renewed with the RenewCertificate command. RenewalEligibility RenewalEligibility - // Contains information about the status of ACM's managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for the - // certificate. This field exists only when the certificate type is AMAZON_ISSUED. + // Contains information about the status of ACM's managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) + // for the certificate. This field exists only when the certificate type is + // AMAZON_ISSUED . RenewalSummary *RenewalSummary // The reason the certificate was revoked. This value exists only when the - // certificate status is REVOKED. + // certificate status is REVOKED . RevocationReason RevocationReason // The time at which the certificate was revoked. This value exists only when the - // certificate status is REVOKED. + // certificate status is REVOKED . RevokedAt *time.Time // The serial number of the certificate. @@ -109,15 +107,12 @@ type CertificateDetail struct { // The status of the certificate. A certificate enters status PENDING_VALIDATION // upon being requested, unless it fails for any of the reasons given in the - // troubleshooting topic Certificate request fails - // (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html). - // ACM makes repeated attempts to validate a certificate for 72 hours and then + // troubleshooting topic Certificate request fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html) + // . ACM makes repeated attempts to validate a certificate for 72 hours and then // times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete - // the request, correct the issue with DNS validation - // (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) or Email - // validation - // (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html), and - // try again. If validation succeeds, the certificate enters status ISSUED. + // the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) + // or Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html) + // , and try again. If validation succeeds, the certificate enters status ISSUED. Status CertificateStatus // The name of the entity that is associated with the public key contained in the @@ -132,13 +127,12 @@ type CertificateDetail struct { SubjectAlternativeNames []string // The source of the certificate. For certificates provided by ACM, this value is - // AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this - // value is IMPORTED. ACM does not provide managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for imported - // certificates. For more information about the differences between certificates - // that you import and those that ACM provides, see Importing Certificates - // (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in - // the Certificate Manager User Guide. + // AMAZON_ISSUED . For certificates that you imported with ImportCertificate , this + // value is IMPORTED . ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) + // for imported certificates. For more information about the differences between + // certificates that you import and those that ACM provides, see Importing + // Certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) + // in the Certificate Manager User Guide. Type CertificateType noSmithyDocumentSerde @@ -150,12 +144,12 @@ type CertificateDetail struct { // be recorded in a log. Certificates that are not logged typically generate a // browser error. Transparency makes it possible for you to detect SSL/TLS // certificates that have been mistakenly or maliciously issued for your domain. -// For general information, see Certificate Transparency Logging -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency). +// For general information, see Certificate Transparency Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) +// . type CertificateOptions struct { // You can opt out of certificate transparency logging by specifying the DISABLED - // option. Opt in by specifying ENABLED. + // option. Opt in by specifying ENABLED . CertificateTransparencyLoggingPreference CertificateTransparencyLoggingPreference noSmithyDocumentSerde @@ -166,8 +160,8 @@ type CertificateSummary struct { // Amazon Resource Name (ARN) of the certificate. This is of the form: // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . CertificateArn *string // The time at which the certificate was requested. @@ -177,8 +171,8 @@ type CertificateSummary struct { // the certificate. DomainName *string - // Indicates whether the certificate has been exported. This value exists only when - // the certificate type is PRIVATE. + // Indicates whether the certificate has been exported. This value exists only + // when the certificate type is PRIVATE . Exported *bool // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object @@ -186,26 +180,25 @@ type CertificateSummary struct { // consists of a name and an object identifier (OID). ExtendedKeyUsages []ExtendedKeyUsageName - // When called by ListCertificates - // (https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html), - // indicates whether the full list of subject alternative names has been included + // When called by ListCertificates (https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html) + // , indicates whether the full list of subject alternative names has been included // in the response. If false, the response includes all of the subject alternative // names included in the certificate. If true, the response only includes the first // 100 subject alternative names included in the certificate. To display the full - // list of subject alternative names, use DescribeCertificate - // (https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html). + // list of subject alternative names, use DescribeCertificate (https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html) + // . HasAdditionalSubjectAlternativeNames *bool - // The date and time when the certificate was imported. This value exists only when - // the certificate type is IMPORTED. + // The date and time when the certificate was imported. This value exists only + // when the certificate type is IMPORTED . ImportedAt *time.Time - // Indicates whether the certificate is currently in use by any Amazon Web Services - // resources. + // Indicates whether the certificate is currently in use by any Amazon Web + // Services resources. InUse *bool // The time at which the certificate was issued. This value exists only when the - // certificate type is AMAZON_ISSUED. + // certificate type is AMAZON_ISSUED . IssuedAt *time.Time // The algorithm that was used to generate the public-private key pair. @@ -228,42 +221,37 @@ type CertificateSummary struct { RenewalEligibility RenewalEligibility // The time at which the certificate was revoked. This value exists only when the - // certificate status is REVOKED. + // certificate status is REVOKED . RevokedAt *time.Time // The status of the certificate. A certificate enters status PENDING_VALIDATION // upon being requested, unless it fails for any of the reasons given in the - // troubleshooting topic Certificate request fails - // (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html). - // ACM makes repeated attempts to validate a certificate for 72 hours and then + // troubleshooting topic Certificate request fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html) + // . ACM makes repeated attempts to validate a certificate for 72 hours and then // times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete - // the request, correct the issue with DNS validation - // (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) or Email - // validation - // (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html), and - // try again. If validation succeeds, the certificate enters status ISSUED. + // the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) + // or Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html) + // , and try again. If validation succeeds, the certificate enters status ISSUED. Status CertificateStatus // One or more domain names (subject alternative names) included in the // certificate. This list contains the domain names that are bound to the public // key that is contained in the certificate. The subject alternative names include // the canonical domain name (CN) of the certificate and additional domain names - // that can be used to connect to the website. When called by ListCertificates - // (https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html), - // this parameter will only return the first 100 subject alternative names included - // in the certificate. To display the full list of subject alternative names, use - // DescribeCertificate - // (https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html). + // that can be used to connect to the website. When called by ListCertificates (https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html) + // , this parameter will only return the first 100 subject alternative names + // included in the certificate. To display the full list of subject alternative + // names, use DescribeCertificate (https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html) + // . SubjectAlternativeNameSummaries []string // The source of the certificate. For certificates provided by ACM, this value is - // AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this - // value is IMPORTED. ACM does not provide managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for imported - // certificates. For more information about the differences between certificates - // that you import and those that ACM provides, see Importing Certificates - // (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in - // the Certificate Manager User Guide. + // AMAZON_ISSUED . For certificates that you imported with ImportCertificate , this + // value is IMPORTED . ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) + // for imported certificates. For more information about the differences between + // certificates that you import and those that ACM provides, see Importing + // Certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) + // in the Certificate Manager User Guide. Type CertificateType noSmithyDocumentSerde @@ -274,15 +262,14 @@ type CertificateSummary struct { type DomainValidation struct { // A fully qualified domain name (FQDN) in the certificate. For example, - // www.example.com or example.com. + // www.example.com or example.com . // // This member is required. DomainName *string // Contains the CNAME record that you add to your DNS database for domain - // validation. For more information, see Use DNS to Validate Domain Ownership - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html). - // Note: The CNAME information that you need does not include the name of your + // validation. For more information, see Use DNS to Validate Domain Ownership (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) + // . Note: The CNAME information that you need does not include the name of your // domain. If you include
 your domain name in the DNS database CNAME record, // validation fails.
 For example, if the name is // "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only @@ -300,19 +287,16 @@ type DomainValidation struct { // The validation status of the domain name. This can be one of the following // values: - // - // * PENDING_VALIDATION - // - // * SUCCESS - // - // * FAILED + // - PENDING_VALIDATION + // - SUCCESS + // - FAILED ValidationStatus DomainStatus noSmithyDocumentSerde } -// Contains information about the domain names that you want ACM to use to send you -// emails that enable you to validate domain ownership. +// Contains information about the domain names that you want ACM to use to send +// you emails that enable you to validate domain ownership. type DomainValidationOption struct { // A fully qualified domain name (FQDN) in the certificate request. @@ -323,21 +307,14 @@ type DomainValidationOption struct { // The domain name that you want ACM to use to send you validation emails. This // domain name is the suffix of the email addresses that you want ACM to use. This // must be the same as the DomainName value or a superdomain of the DomainName - // value. For example, if you request a certificate for testing.example.com, you + // value. For example, if you request a certificate for testing.example.com , you // can specify example.com for this value. In that case, ACM sends domain // validation emails to the following five addresses: - // - // * admin@example.com - // - // * - // administrator@example.com - // - // * hostmaster@example.com - // - // * postmaster@example.com - // - // * - // webmaster@example.com + // - admin@example.com + // - administrator@example.com + // - hostmaster@example.com + // - postmaster@example.com + // - webmaster@example.com // // This member is required. ValidationDomain *string @@ -350,47 +327,33 @@ type DomainValidationOption struct { type ExpiryEventsConfiguration struct { // Specifies the number of days prior to certificate expiration when ACM starts - // generating EventBridge events. ACM sends one event per day per certificate until - // the certificate expires. By default, accounts receive events starting 45 days - // before certificate expiration. + // generating EventBridge events. ACM sends one event per day per certificate + // until the certificate expires. By default, accounts receive events starting 45 + // days before certificate expiration. DaysBeforeExpiry *int32 noSmithyDocumentSerde } -// The Extended Key Usage X.509 v3 extension defines one or more purposes for which -// the public key can be used. This is in addition to or in place of the basic -// purposes specified by the Key Usage extension. +// The Extended Key Usage X.509 v3 extension defines one or more purposes for +// which the public key can be used. This is in addition to or in place of the +// basic purposes specified by the Key Usage extension. type ExtendedKeyUsage struct { // The name of an Extended Key Usage value. Name ExtendedKeyUsageName // An object identifier (OID) for the extension value. OIDs are strings of numbers - // separated by periods. The following OIDs are defined in RFC 3280 and RFC - // 5280. - // - // * 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION) - // - // * 1.3.6.1.5.5.7.3.2 - // (TLS_WEB_CLIENT_AUTHENTICATION) - // - // * 1.3.6.1.5.5.7.3.3 (CODE_SIGNING) - // - // * - // 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION) - // - // * 1.3.6.1.5.5.7.3.8 (TIME_STAMPING) - // - // * - // 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING) - // - // * 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM) - // - // * - // 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL) - // - // * 1.3.6.1.5.5.7.3.7 (IPSEC_USER) + // separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. + // - 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION) + // - 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION) + // - 1.3.6.1.5.5.7.3.3 (CODE_SIGNING) + // - 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION) + // - 1.3.6.1.5.5.7.3.8 (TIME_STAMPING) + // - 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING) + // - 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM) + // - 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL) + // - 1.3.6.1.5.5.7.3.7 (IPSEC_USER) OID *string noSmithyDocumentSerde @@ -404,10 +367,10 @@ type Filters struct { ExtendedKeyUsage []ExtendedKeyUsageName // Specify one or more algorithms that can be used to generate key pairs. Default - // filtering returns only RSA_1024 and RSA_2048 certificates that have at least one - // domain. To return other certificate types, provide the desired type signatures - // in a comma-separated list. For example, "keyTypes": ["RSA_2048","RSA_4096"] - // returns both RSA_2048 and RSA_4096 certificates. + // filtering returns only RSA_1024 and RSA_2048 certificates that have at least + // one domain. To return other certificate types, provide the desired type + // signatures in a comma-separated list. For example, "keyTypes": + // ["RSA_2048","RSA_4096"] returns both RSA_2048 and RSA_4096 certificates. KeyTypes []KeyAlgorithm // Specify one or more KeyUsage extension values. @@ -416,8 +379,8 @@ type Filters struct { noSmithyDocumentSerde } -// The Key Usage X.509 v3 extension defines the purpose of the public key contained -// in the certificate. +// The Key Usage X.509 v3 extension defines the purpose of the public key +// contained in the certificate. type KeyUsage struct { // A string value that contains a Key Usage extension name. @@ -426,25 +389,22 @@ type KeyUsage struct { noSmithyDocumentSerde } -// Contains information about the status of ACM's managed renewal -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for the -// certificate. This structure exists only when the certificate type is -// AMAZON_ISSUED. +// Contains information about the status of ACM's managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) +// for the certificate. This structure exists only when the certificate type is +// AMAZON_ISSUED . type RenewalSummary struct { // Contains information about the validation of each domain name in the - // certificate, as it pertains to ACM's managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html). This is - // different from the initial validation that occurs as a result of the + // certificate, as it pertains to ACM's managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) + // . This is different from the initial validation that occurs as a result of the // RequestCertificate request. This field exists only when the certificate type is - // AMAZON_ISSUED. + // AMAZON_ISSUED . // // This member is required. DomainValidationOptions []DomainValidation - // The status of ACM's managed renewal - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) of the - // certificate. + // The status of ACM's managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) + // of the certificate. // // This member is required. RenewalStatus RenewalStatus @@ -460,8 +420,8 @@ type RenewalSummary struct { noSmithyDocumentSerde } -// Contains a DNS record value that you can use to validate ownership or control of -// a domain. This is used by the DescribeCertificate action. +// Contains a DNS record value that you can use to validate ownership or control +// of a domain. This is used by the DescribeCertificate action. type ResourceRecord struct { // The name of the DNS record to create in your domain. This is supplied by ACM. @@ -469,7 +429,7 @@ type ResourceRecord struct { // This member is required. Name *string - // The type of DNS record. Currently this can be CNAME. + // The type of DNS record. Currently this can be CNAME . // // This member is required. Type RecordType diff --git a/service/acmpca/api_client.go b/service/acmpca/api_client.go index 096a0d808f3..10bf2ba325d 100644 --- a/service/acmpca/api_client.go +++ b/service/acmpca/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/acmpca/api_op_CreateCertificateAuthority.go b/service/acmpca/api_op_CreateCertificateAuthority.go index 44fe8af024b..d55222ed4e7 100644 --- a/service/acmpca/api_op_CreateCertificateAuthority.go +++ b/service/acmpca/api_op_CreateCertificateAuthority.go @@ -26,11 +26,10 @@ import ( // principal must have permission to write to the S3 bucket that you specify. If // the IAM principal making the call does not have permission to write to the // bucket, then an exception is thrown. For more information, see Access policies -// for CRLs in Amazon S3 -// (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies). -// Amazon Web Services Private CA assets that are stored in Amazon S3 can be -// protected with encryption. For more information, see Encrypting Your CRLs -// (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption). +// for CRLs in Amazon S3 (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies) +// . Amazon Web Services Private CA assets that are stored in Amazon S3 can be +// protected with encryption. For more information, see Encrypting Your CRLs (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption) +// . func (c *Client) CreateCertificateAuthority(ctx context.Context, params *CreateCertificateAuthorityInput, optFns ...func(*Options)) (*CreateCertificateAuthorityOutput, error) { if params == nil { params = &CreateCertificateAuthorityInput{} @@ -72,53 +71,39 @@ type CreateCertificateAuthorityInput struct { // Specifies a cryptographic key management compliance standard used for handling // CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: // FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in the following Regions: - // - // * - // ap-northeast-3 - // - // * ap-southeast-3 - // - // When creating a CA in these Regions, you must - // provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for - // KeyStorageSecurityStandard. Failure to do this results in an - // InvalidArgsException with the message, "A certificate authority cannot be - // created in this region with the specified security standard." + // - ap-northeast-3 + // - ap-southeast-3 + // When creating a CA in these Regions, you must provide + // FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . + // Failure to do this results in an InvalidArgsException with the message, "A + // certificate authority cannot be created in this region with the specified + // security standard." KeyStorageSecurityStandard types.KeyStorageSecurityStandard // Contains information to enable Online Certificate Status Protocol (OCSP) // support, to enable a certificate revocation list (CRL), to enable both, or to // enable neither. The default is for both certificate validation mechanisms to be // disabled. The following requirements apply to revocation configurations. - // - // * A - // configuration disabling CRLs or OCSP must contain only the Enabled=False - // parameter, and will fail if other parameters such as CustomCname or - // ExpirationInDays are included. - // - // * In a CRL configuration, the S3BucketName - // parameter must conform to Amazon S3 bucket naming rules - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). - // - // * - // A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or - // OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) restrictions - // on the use of special characters in a CNAME. - // - // * In a CRL or OCSP configuration, - // the value of a CNAME parameter must not include a protocol prefix such as - // "http://" or "https://". - // - // For more information, see the OcspConfiguration - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html) - // and CrlConfiguration - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html) + // - A configuration disabling CRLs or OCSP must contain only the Enabled=False + // parameter, and will fail if other parameters such as CustomCname or + // ExpirationInDays are included. + // - In a CRL configuration, the S3BucketName parameter must conform to Amazon + // S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) + // . + // - A configuration containing a custom Canonical Name (CNAME) parameter for + // CRLs or OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) + // restrictions on the use of special characters in a CNAME. + // - In a CRL or OCSP configuration, the value of a CNAME parameter must not + // include a protocol prefix such as "http://" or "https://". + // For more information, see the OcspConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html) + // and CrlConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html) // types. RevocationConfiguration *types.RevocationConfiguration // Key-value pairs that will be attached to the new private CA. You can associate // up to 50 tags with a private CA. For information using tags with IAM to manage - // permissions, see Controlling Access Using IAM Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). + // permissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) + // . Tags []types.Tag // Specifies whether the CA issues general-purpose certificates that typically @@ -132,8 +117,8 @@ type CreateCertificateAuthorityInput struct { type CreateCertificateAuthorityOutput struct { - // If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). - // This is of the form: + // If successful, the Amazon Resource Name (ARN) of the certificate authority + // (CA). This is of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go b/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go index 06384486916..c070984e106 100644 --- a/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go @@ -13,21 +13,17 @@ import ( // Creates an audit report that lists every time that your CA private key is used. // The report is saved in the Amazon S3 bucket that you specify on input. The -// IssueCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) -// and RevokeCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) +// IssueCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) +// and RevokeCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) // actions use the private key. Both Amazon Web Services Private CA and the IAM // principal must have permission to write to the S3 bucket that you specify. If // the IAM principal making the call does not have permission to write to the // bucket, then an exception is thrown. For more information, see Access policies -// for CRLs in Amazon S3 -// (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies). -// Amazon Web Services Private CA assets that are stored in Amazon S3 can be +// for CRLs in Amazon S3 (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies) +// . Amazon Web Services Private CA assets that are stored in Amazon S3 can be // protected with encryption. For more information, see Encrypting Your Audit -// Reports -// (https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption). -// You can generate a maximum of one report every 30 minutes. +// Reports (https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption) +// . You can generate a maximum of one report every 30 minutes. func (c *Client) CreateCertificateAuthorityAuditReport(ctx context.Context, params *CreateCertificateAuthorityAuditReportInput, optFns ...func(*Options)) (*CreateCertificateAuthorityAuditReportOutput, error) { if params == nil { params = &CreateCertificateAuthorityAuditReportInput{} diff --git a/service/acmpca/api_op_CreatePermission.go b/service/acmpca/api_op_CreatePermission.go index 52233e10dc2..07d19fd06eb 100644 --- a/service/acmpca/api_op_CreatePermission.go +++ b/service/acmpca/api_op_CreatePermission.go @@ -12,28 +12,22 @@ import ( ) // Grants one or more permissions on a private CA to the Certificate Manager (ACM) -// service principal (acm.amazonaws.com). These permissions allow ACM to issue and -// renew ACM certificates that reside in the same Amazon Web Services account as -// the CA. You can list current permissions with the ListPermissions -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) -// action and revoke them with the DeletePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) +// service principal ( acm.amazonaws.com ). These permissions allow ACM to issue +// and renew ACM certificates that reside in the same Amazon Web Services account +// as the CA. You can list current permissions with the ListPermissions (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) +// action and revoke them with the DeletePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) // action. About Permissions -// -// * If the private CA and the certificates it issues -// reside in the same account, you can use CreatePermission to grant permissions -// for ACM to carry out automatic certificate renewals. -// -// * For automatic -// certificate renewal to succeed, the ACM service principal needs permissions to -// create, retrieve, and list certificates. -// -// * If the private CA and the ACM -// certificates reside in different accounts, then permissions cannot be used to -// enable automatic renewals. Instead, the ACM certificate owner must set up a -// resource-based policy to enable cross-account issuance and renewals. For more -// information, see Using a Resource Based Policy with Amazon Web Services Private -// CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). +// - If the private CA and the certificates it issues reside in the same +// account, you can use CreatePermission to grant permissions for ACM to carry +// out automatic certificate renewals. +// - For automatic certificate renewal to succeed, the ACM service principal +// needs permissions to create, retrieve, and list certificates. +// - If the private CA and the ACM certificates reside in different accounts, +// then permissions cannot be used to enable automatic renewals. Instead, the ACM +// certificate owner must set up a resource-based policy to enable cross-account +// issuance and renewals. For more information, see Using a Resource Based +// Policy with Amazon Web Services Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionInput, optFns ...func(*Options)) (*CreatePermissionOutput, error) { if params == nil { params = &CreatePermissionInput{} @@ -52,14 +46,13 @@ func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionI type CreatePermissionInput struct { // The actions that the specified Amazon Web Services service principal can use. - // These include IssueCertificate, GetCertificate, and ListPermissions. + // These include IssueCertificate , GetCertificate , and ListPermissions . // // This member is required. Actions []types.ActionType // The Amazon Resource Name (ARN) of the CA that grants the permissions. You can - // find the ARN by calling the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // find the ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. This must have the following form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . @@ -68,7 +61,7 @@ type CreatePermissionInput struct { CertificateAuthorityArn *string // The Amazon Web Services service or identity that receives the permission. At - // this time, the only valid principal is acm.amazonaws.com. + // this time, the only valid principal is acm.amazonaws.com . // // This member is required. Principal *string diff --git a/service/acmpca/api_op_DeleteCertificateAuthority.go b/service/acmpca/api_op_DeleteCertificateAuthority.go index 2c2085f0aa9..c945d48988b 100644 --- a/service/acmpca/api_op_DeleteCertificateAuthority.go +++ b/service/acmpca/api_op_DeleteCertificateAuthority.go @@ -12,28 +12,24 @@ import ( // Deletes a private certificate authority (CA). You must provide the Amazon // Resource Name (ARN) of the private CA that you want to delete. You can find the -// ARN by calling the ListCertificateAuthorities -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) +// ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. Deleting a CA will invalidate other CAs and certificates below it in // your CA hierarchy. Before you can delete a CA that you have created and -// activated, you must disable it. To do this, call the UpdateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) -// action and set the CertificateAuthorityStatus parameter to DISABLED. +// activated, you must disable it. To do this, call the UpdateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) +// action and set the CertificateAuthorityStatus parameter to DISABLED . // Additionally, you can delete a CA if you are waiting for it to be created (that -// is, the status of the CA is CREATING). You can also delete it if the CA has been -// created but you haven't yet imported the signed certificate into Amazon Web -// Services Private CA (that is, the status of the CA is PENDING_CERTIFICATE). When -// you successfully call DeleteCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html), -// the CA's status changes to DELETED. However, the CA won't be permanently deleted -// until the restoration period has passed. By default, if you do not set the -// PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. -// You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html) +// is, the status of the CA is CREATING ). You can also delete it if the CA has +// been created but you haven't yet imported the signed certificate into Amazon Web +// Services Private CA (that is, the status of the CA is PENDING_CERTIFICATE ). +// When you successfully call DeleteCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html) +// , the CA's status changes to DELETED . However, the CA won't be permanently +// deleted until the restoration period has passed. By default, if you do not set +// the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 +// days. You can set the parameter from 7 to 30 days. The +// DescribeCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html) // action returns the time remaining in the restoration window of a private CA in // the DELETED state. To restore an eligible CA, call the -// RestoreCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html) +// RestoreCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html) // action. func (c *Client) DeleteCertificateAuthority(ctx context.Context, params *DeleteCertificateAuthorityInput, optFns ...func(*Options)) (*DeleteCertificateAuthorityOutput, error) { if params == nil { @@ -53,9 +49,8 @@ func (c *Client) DeleteCertificateAuthority(ctx context.Context, params *DeleteC type DeleteCertificateAuthorityInput struct { // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must have the following form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must have the following form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // diff --git a/service/acmpca/api_op_DeletePermission.go b/service/acmpca/api_op_DeletePermission.go index c01b59357f6..99b471e9d8c 100644 --- a/service/acmpca/api_op_DeletePermission.go +++ b/service/acmpca/api_op_DeletePermission.go @@ -14,26 +14,20 @@ import ( // service principal (acm.amazonaws.com). These permissions allow ACM to issue and // renew ACM certificates that reside in the same Amazon Web Services account as // the CA. If you revoke these permissions, ACM will no longer renew the affected -// certificates automatically. Permissions can be granted with the CreatePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) -// action and listed with the ListPermissions -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) +// certificates automatically. Permissions can be granted with the CreatePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) +// action and listed with the ListPermissions (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) // action. About Permissions -// -// * If the private CA and the certificates it issues -// reside in the same account, you can use CreatePermission to grant permissions -// for ACM to carry out automatic certificate renewals. -// -// * For automatic -// certificate renewal to succeed, the ACM service principal needs permissions to -// create, retrieve, and list certificates. -// -// * If the private CA and the ACM -// certificates reside in different accounts, then permissions cannot be used to -// enable automatic renewals. Instead, the ACM certificate owner must set up a -// resource-based policy to enable cross-account issuance and renewals. For more -// information, see Using a Resource Based Policy with Amazon Web Services Private -// CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). +// - If the private CA and the certificates it issues reside in the same +// account, you can use CreatePermission to grant permissions for ACM to carry +// out automatic certificate renewals. +// - For automatic certificate renewal to succeed, the ACM service principal +// needs permissions to create, retrieve, and list certificates. +// - If the private CA and the ACM certificates reside in different accounts, +// then permissions cannot be used to enable automatic renewals. Instead, the ACM +// certificate owner must set up a resource-based policy to enable cross-account +// issuance and renewals. For more information, see Using a Resource Based +// Policy with Amazon Web Services Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionInput, optFns ...func(*Options)) (*DeletePermissionOutput, error) { if params == nil { params = &DeletePermissionInput{} @@ -52,8 +46,7 @@ func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionI type DeletePermissionInput struct { // The Amazon Resource Number (ARN) of the private CA that issued the permissions. - // You can find the CA's ARN by calling the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // You can find the CA's ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. This must have the following form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . diff --git a/service/acmpca/api_op_DeletePolicy.go b/service/acmpca/api_op_DeletePolicy.go index 388b5327823..8630eb209b5 100644 --- a/service/acmpca/api_op_DeletePolicy.go +++ b/service/acmpca/api_op_DeletePolicy.go @@ -10,40 +10,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the resource-based policy attached to a private CA. Deletion will remove -// any access that the policy has granted. If there is no policy attached to the -// private CA, this action will return successful. If you delete a policy that was -// applied through Amazon Web Services Resource Access Manager (RAM), the CA will -// be removed from all shares in which it was included. The Certificate Manager -// Service Linked Role that the policy supports is not affected when you delete the -// policy. The current policy can be shown with GetPolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html) -// and updated with PutPolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html). -// About Policies -// -// * A policy grants access on a private CA to an Amazon Web -// Services customer account, to Amazon Web Services Organizations, or to an Amazon -// Web Services Organizations unit. Policies are under the control of a CA -// administrator. For more information, see Using a Resource Based Policy with -// Amazon Web Services Private CA -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). -// -// * A -// policy permits a user of Certificate Manager (ACM) to issue ACM certificates -// signed by a CA in another account. -// -// * For ACM to manage automatic renewal of -// these certificates, the ACM user must configure a Service Linked Role (SLR). The -// SLR allows the ACM service to assume the identity of the user, subject to -// confirmation against the Amazon Web Services Private CA policy. For more -// information, see Using a Service Linked Role with ACM -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). -// -// * Updates made -// in Amazon Web Services Resource Manager (RAM) are reflected in policies. For -// more information, see Attach a Policy for Cross-Account Access -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html). +// Deletes the resource-based policy attached to a private CA. Deletion will +// remove any access that the policy has granted. If there is no policy attached to +// the private CA, this action will return successful. If you delete a policy that +// was applied through Amazon Web Services Resource Access Manager (RAM), the CA +// will be removed from all shares in which it was included. The Certificate +// Manager Service Linked Role that the policy supports is not affected when you +// delete the policy. The current policy can be shown with GetPolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html) +// and updated with PutPolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html) +// . About Policies +// - A policy grants access on a private CA to an Amazon Web Services customer +// account, to Amazon Web Services Organizations, or to an Amazon Web Services +// Organizations unit. Policies are under the control of a CA administrator. For +// more information, see Using a Resource Based Policy with Amazon Web Services +// Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . +// - A policy permits a user of Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// - For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service to +// assume the identity of the user, subject to confirmation against the Amazon Web +// Services Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html) +// . +// - Updates made in Amazon Web Services Resource Manager (RAM) are reflected in +// policies. For more information, see Attach a Policy for Cross-Account Access (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html) +// . func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} @@ -62,10 +54,10 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { // The Amazon Resource Number (ARN) of the private CA that will have its policy - // deleted. You can find the CA's ARN by calling the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // deleted. You can find the CA's ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. The ARN value must have the form - // arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab. + // arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab + // . // // This member is required. ResourceArn *string diff --git a/service/acmpca/api_op_DescribeCertificateAuthority.go b/service/acmpca/api_op_DescribeCertificateAuthority.go index e2f8ab69796..1ddead86b00 100644 --- a/service/acmpca/api_op_DescribeCertificateAuthority.go +++ b/service/acmpca/api_op_DescribeCertificateAuthority.go @@ -15,31 +15,20 @@ import ( // been shared with you. You specify the private CA on input by its ARN (Amazon // Resource Name). The output contains the status of your CA. This can be any of // the following: -// -// * CREATING - Amazon Web Services Private CA is creating your -// private certificate authority. -// -// * PENDING_CERTIFICATE - The certificate is -// pending. You must use your Amazon Web Services Private CA-hosted or on-premises -// root or subordinate CA to sign your private CA CSR and then import it into -// Amazon Web Services Private CA. -// -// * ACTIVE - Your private CA is active. -// -// * -// DISABLED - Your private CA has been disabled. -// -// * EXPIRED - Your private CA -// certificate has expired. -// -// * FAILED - Your private CA has failed. Your CA can -// fail because of problems such a network outage or back-end Amazon Web Services -// failure or other errors. A failed CA can never return to the pending state. You -// must create a new CA. -// -// * DELETED - Your private CA is within the restoration -// period, after which it is permanently deleted. The length of time remaining in -// the CA's restoration period is also included in this action's output. +// - CREATING - Amazon Web Services Private CA is creating your private +// certificate authority. +// - PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon +// Web Services Private CA-hosted or on-premises root or subordinate CA to sign +// your private CA CSR and then import it into Amazon Web Services Private CA. +// - ACTIVE - Your private CA is active. +// - DISABLED - Your private CA has been disabled. +// - EXPIRED - Your private CA certificate has expired. +// - FAILED - Your private CA has failed. Your CA can fail because of problems +// such a network outage or back-end Amazon Web Services failure or other errors. A +// failed CA can never return to the pending state. You must create a new CA. +// - DELETED - Your private CA is within the restoration period, after which it +// is permanently deleted. The length of time remaining in the CA's restoration +// period is also included in this action's output. func (c *Client) DescribeCertificateAuthority(ctx context.Context, params *DescribeCertificateAuthorityInput, optFns ...func(*Options)) (*DescribeCertificateAuthorityOutput, error) { if params == nil { params = &DescribeCertificateAuthorityInput{} @@ -58,9 +47,8 @@ func (c *Client) DescribeCertificateAuthority(ctx context.Context, params *Descr type DescribeCertificateAuthorityInput struct { // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // @@ -72,8 +60,7 @@ type DescribeCertificateAuthorityInput struct { type DescribeCertificateAuthorityOutput struct { - // A CertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html) + // A CertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html) // structure that contains information about your private CA. CertificateAuthority *types.CertificateAuthority diff --git a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go index 75d1f84f41e..fe375439bab 100644 --- a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go @@ -17,13 +17,10 @@ import ( ) // Lists information about a specific audit report created by calling the -// CreateCertificateAuthorityAuditReport -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) +// CreateCertificateAuthorityAuditReport (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) // action. Audit information is created every time the certificate authority (CA) -// private key is used. The private key is used when you call the IssueCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) -// action or the RevokeCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) +// private key is used. The private key is used when you call the IssueCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) +// action or the RevokeCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) // action. func (c *Client) DescribeCertificateAuthorityAuditReport(ctx context.Context, params *DescribeCertificateAuthorityAuditReportInput, optFns ...func(*Options)) (*DescribeCertificateAuthorityAuditReportOutput, error) { if params == nil { @@ -42,8 +39,7 @@ func (c *Client) DescribeCertificateAuthorityAuditReport(ctx context.Context, pa type DescribeCertificateAuthorityAuditReportInput struct { - // The report ID returned by calling the CreateCertificateAuthorityAuditReport - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) + // The report ID returned by calling the CreateCertificateAuthorityAuditReport (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) // action. // // This member is required. @@ -142,8 +138,8 @@ func (c *Client) addOperationDescribeCertificateAuthorityAuditReportMiddlewares( return nil } -// DescribeCertificateAuthorityAuditReportAPIClient is a client that implements the -// DescribeCertificateAuthorityAuditReport operation. +// DescribeCertificateAuthorityAuditReportAPIClient is a client that implements +// the DescribeCertificateAuthorityAuditReport operation. type DescribeCertificateAuthorityAuditReportAPIClient interface { DescribeCertificateAuthorityAuditReport(context.Context, *DescribeCertificateAuthorityAuditReportInput, ...func(*Options)) (*DescribeCertificateAuthorityAuditReportOutput, error) } @@ -163,8 +159,8 @@ type AuditReportCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AuditReportCreatedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AuditReportCreatedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/acmpca/api_op_GetCertificate.go b/service/acmpca/api_op_GetCertificate.go index 35956612b97..b08e52af3ca 100644 --- a/service/acmpca/api_op_GetCertificate.go +++ b/service/acmpca/api_op_GetCertificate.go @@ -17,13 +17,11 @@ import ( ) // Retrieves a certificate from your private CA or one that has been shared with -// you. The ARN of the certificate is returned when you call the IssueCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) +// you. The ARN of the certificate is returned when you call the IssueCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) // action. You must specify both the ARN of your private CA and the ARN of the // issued certificate when calling the GetCertificate action. You can retrieve the // certificate if it is in the ISSUED state. You can call the -// CreateCertificateAuthorityAuditReport -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) +// CreateCertificateAuthorityAuditReport (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) // action to create a report that contains information about all of the // certificates issued and revoked by your private CA. func (c *Client) GetCertificate(ctx context.Context, params *GetCertificateInput, optFns ...func(*Options)) (*GetCertificateOutput, error) { @@ -51,9 +49,8 @@ type GetCertificateInput struct { CertificateArn *string // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // @@ -162,9 +159,9 @@ type CertificateIssuedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CertificateIssuedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CertificateIssuedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -212,10 +209,10 @@ func (w *CertificateIssuedWaiter) Wait(ctx context.Context, params *GetCertifica return err } -// WaitForOutput calls the waiter function for CertificateIssued waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for CertificateIssued waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *CertificateIssuedWaiter) WaitForOutput(ctx context.Context, params *GetCertificateInput, maxWaitDur time.Duration, optFns ...func(*CertificateIssuedWaiterOptions)) (*GetCertificateOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go index ef93f71b53d..333f6660223 100644 --- a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go @@ -46,10 +46,10 @@ type GetCertificateAuthorityCertificateOutput struct { // Base64-encoded certificate authority (CA) certificate. Certificate *string - // Base64-encoded certificate chain that includes any intermediate certificates and - // chains up to root certificate that you used to sign your private CA certificate. - // The chain does not include your private CA certificate. If this is a root CA, - // the value will be null. + // Base64-encoded certificate chain that includes any intermediate certificates + // and chains up to root certificate that you used to sign your private CA + // certificate. The chain does not include your private CA certificate. If this is + // a root CA, the value will be null. CertificateChain *string // Metadata pertaining to the operation's result. diff --git a/service/acmpca/api_op_GetCertificateAuthorityCsr.go b/service/acmpca/api_op_GetCertificateAuthorityCsr.go index 630d251ce9b..f78d65e53bd 100644 --- a/service/acmpca/api_op_GetCertificateAuthorityCsr.go +++ b/service/acmpca/api_op_GetCertificateAuthorityCsr.go @@ -17,13 +17,11 @@ import ( ) // Retrieves the certificate signing request (CSR) for your private certificate -// authority (CA). The CSR is created when you call the CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// authority (CA). The CSR is created when you call the CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. Sign the CSR with your Amazon Web Services Private CA-hosted or // on-premises root or subordinate CA. Then import the signed certificate back into // Amazon Web Services Private CA by calling the -// ImportCertificateAuthorityCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) +// ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) // action. The CSR is returned as a base64 PEM-encoded string. func (c *Client) GetCertificateAuthorityCsr(ctx context.Context, params *GetCertificateAuthorityCsrInput, optFns ...func(*Options)) (*GetCertificateAuthorityCsrOutput, error) { if params == nil { @@ -43,8 +41,7 @@ func (c *Client) GetCertificateAuthorityCsr(ctx context.Context, params *GetCert type GetCertificateAuthorityCsrInput struct { // The Amazon Resource Name (ARN) that was returned when you called the - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // @@ -152,10 +149,10 @@ type CertificateAuthorityCSRCreatedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CertificateAuthorityCSRCreatedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CertificateAuthorityCSRCreatedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/acmpca/api_op_GetPolicy.go b/service/acmpca/api_op_GetPolicy.go index b3149c1cb7a..0e19b729608 100644 --- a/service/acmpca/api_op_GetPolicy.go +++ b/service/acmpca/api_op_GetPolicy.go @@ -12,34 +12,26 @@ import ( // Retrieves the resource-based policy attached to a private CA. If either the // private CA resource or the policy cannot be found, this action returns a -// ResourceNotFoundException. The policy can be attached or updated with PutPolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html) -// and removed with DeletePolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html). -// About Policies -// -// * A policy grants access on a private CA to an Amazon Web -// Services customer account, to Amazon Web Services Organizations, or to an Amazon -// Web Services Organizations unit. Policies are under the control of a CA -// administrator. For more information, see Using a Resource Based Policy with -// Amazon Web Services Private CA -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). -// -// * A -// policy permits a user of Certificate Manager (ACM) to issue ACM certificates -// signed by a CA in another account. -// -// * For ACM to manage automatic renewal of -// these certificates, the ACM user must configure a Service Linked Role (SLR). The -// SLR allows the ACM service to assume the identity of the user, subject to -// confirmation against the Amazon Web Services Private CA policy. For more -// information, see Using a Service Linked Role with ACM -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). -// -// * Updates made -// in Amazon Web Services Resource Manager (RAM) are reflected in policies. For -// more information, see Attach a Policy for Cross-Account Access -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html). +// ResourceNotFoundException . The policy can be attached or updated with PutPolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html) +// and removed with DeletePolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html) +// . About Policies +// - A policy grants access on a private CA to an Amazon Web Services customer +// account, to Amazon Web Services Organizations, or to an Amazon Web Services +// Organizations unit. Policies are under the control of a CA administrator. For +// more information, see Using a Resource Based Policy with Amazon Web Services +// Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . +// - A policy permits a user of Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// - For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service to +// assume the identity of the user, subject to confirmation against the Amazon Web +// Services Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html) +// . +// - Updates made in Amazon Web Services Resource Manager (RAM) are reflected in +// policies. For more information, see Attach a Policy for Cross-Account Access (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html) +// . func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { params = &GetPolicyInput{} diff --git a/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go b/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go index e949310b418..5beb542da5e 100644 --- a/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go @@ -14,111 +14,62 @@ import ( // This action is used when you are using a chain of trust whose root is located // outside Amazon Web Services Private CA. Before you can call this action, the // following preparations must in place: -// -// * In Amazon Web Services Private CA, call -// the CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) -// action to create the private CA that you plan to back with the imported -// certificate. -// -// * Call the GetCertificateAuthorityCsr -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html) -// action to generate a certificate signing request (CSR). -// -// * Sign the CSR using a -// root or intermediate CA hosted by either an on-premises PKI hierarchy or by a -// commercial CA. -// -// * Create a certificate chain and copy the signed certificate and -// the certificate chain to your working directory. -// -// Amazon Web Services Private CA -// supports three scenarios for installing a CA certificate: -// -// * Installing a -// certificate for a root CA hosted by Amazon Web Services Private CA. -// -// * -// Installing a subordinate CA certificate whose parent authority is hosted by -// Amazon Web Services Private CA. -// -// * Installing a subordinate CA certificate whose -// parent authority is externally hosted. -// -// The following additional requirements -// apply when you import a CA certificate. -// -// * Only a self-signed certificate can be -// imported as a root CA. -// -// * A self-signed certificate cannot be imported as a -// subordinate CA. -// -// * Your certificate chain must not include the private CA -// certificate that you are importing. -// -// * Your root CA must be the last certificate -// in your chain. The subordinate certificate, if any, that your root CA signed -// must be next to last. The subordinate certificate signed by the preceding -// subordinate CA must come next, and so on until your chain is built. -// -// * The chain -// must be PEM-encoded. -// -// * The maximum allowed size of a certificate is 32 KB. -// -// * -// The maximum allowed size of a certificate chain is 2 MB. -// -// Enforcement of -// Critical Constraints Amazon Web Services Private CA allows the following -// extensions to be marked critical in the imported CA certificate or chain. -// -// * -// Basic constraints (must be marked critical) -// -// * Subject alternative names -// -// * Key -// usage -// -// * Extended key usage -// -// * Authority key identifier -// -// * Subject key -// identifier -// -// * Issuer alternative name -// -// * Subject directory attributes -// -// * Subject -// information access -// -// * Certificate policies -// -// * Policy mappings -// -// * Inhibit -// anyPolicy -// -// Amazon Web Services Private CA rejects the following extensions when -// they are marked critical in an imported CA certificate or chain. -// -// * Name -// constraints -// -// * Policy constraints -// -// * CRL distribution points -// -// * Authority -// information access -// -// * Freshest CRL -// -// * Any other extension +// - In Amazon Web Services Private CA, call the CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// action to create the private CA that you plan to back with the imported +// certificate. +// - Call the GetCertificateAuthorityCsr (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html) +// action to generate a certificate signing request (CSR). +// - Sign the CSR using a root or intermediate CA hosted by either an +// on-premises PKI hierarchy or by a commercial CA. +// - Create a certificate chain and copy the signed certificate and the +// certificate chain to your working directory. +// +// Amazon Web Services Private CA supports three scenarios for installing a CA +// certificate: +// - Installing a certificate for a root CA hosted by Amazon Web Services +// Private CA. +// - Installing a subordinate CA certificate whose parent authority is hosted by +// Amazon Web Services Private CA. +// - Installing a subordinate CA certificate whose parent authority is +// externally hosted. +// +// The following additional requirements apply when you import a CA certificate. +// - Only a self-signed certificate can be imported as a root CA. +// - A self-signed certificate cannot be imported as a subordinate CA. +// - Your certificate chain must not include the private CA certificate that you +// are importing. +// - Your root CA must be the last certificate in your chain. The subordinate +// certificate, if any, that your root CA signed must be next to last. The +// subordinate certificate signed by the preceding subordinate CA must come next, +// and so on until your chain is built. +// - The chain must be PEM-encoded. +// - The maximum allowed size of a certificate is 32 KB. +// - The maximum allowed size of a certificate chain is 2 MB. +// +// Enforcement of Critical Constraints Amazon Web Services Private CA allows the +// following extensions to be marked critical in the imported CA certificate or +// chain. +// - Basic constraints (must be marked critical) +// - Subject alternative names +// - Key usage +// - Extended key usage +// - Authority key identifier +// - Subject key identifier +// - Issuer alternative name +// - Subject directory attributes +// - Subject information access +// - Certificate policies +// - Policy mappings +// - Inhibit anyPolicy +// +// Amazon Web Services Private CA rejects the following extensions when they are +// marked critical in an imported CA certificate or chain. +// - Name constraints +// - Policy constraints +// - CRL distribution points +// - Authority information access +// - Freshest CRL +// - Any other extension func (c *Client) ImportCertificateAuthorityCertificate(ctx context.Context, params *ImportCertificateAuthorityCertificateInput, optFns ...func(*Options)) (*ImportCertificateAuthorityCertificateOutput, error) { if params == nil { params = &ImportCertificateAuthorityCertificateInput{} @@ -144,9 +95,8 @@ type ImportCertificateAuthorityCertificateInput struct { Certificate []byte // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. diff --git a/service/acmpca/api_op_IssueCertificate.go b/service/acmpca/api_op_IssueCertificate.go index a4a1079b838..011fdaf79fe 100644 --- a/service/acmpca/api_op_IssueCertificate.go +++ b/service/acmpca/api_op_IssueCertificate.go @@ -14,8 +14,7 @@ import ( // Uses your private certificate authority (CA), or one that has been shared with // you, to issue a client certificate. This action returns the Amazon Resource Name // (ARN) of the certificate. You can retrieve the certificate by calling the -// GetCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) +// GetCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) // action and specifying the ARN. You cannot use the ACM ListCertificateAuthorities // action to retrieve the ARNs of the certificates that you issue by using Amazon // Web Services Private CA. @@ -37,9 +36,8 @@ func (c *Client) IssueCertificate(ctx context.Context, params *IssueCertificateI type IssueCertificateInput struct { // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. @@ -50,11 +48,11 @@ type IssueCertificateInput struct { // 2048 bit RSA private key. openssl req -new -newkey rsa:2048 -days 365 -keyout // private/test_cert_priv_key.pem -out csr/test_cert_.csr If you have a // configuration file, you can then use the following OpenSSL command. The usr_cert - // block in the configuration file contains your X509 version 3 extensions. openssl - // req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 - // -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr Note: A CSR must - // provide either a subject name or a subject alternative name or the request will - // be rejected. + // block in the configuration file contains your X509 version 3 extensions. + // openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 + // -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr Note: A + // CSR must provide either a subject name or a subject alternative name or the + // request will be rejected. // // This member is required. Csr []byte @@ -73,13 +71,12 @@ type IssueCertificateInput struct { // the period of time during which a certificate is valid. Validity can be // expressed as an explicit date and time when the certificate expires, or as a // span of time after issuance, stated in days, months, or years. For more - // information, see Validity - // (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5) in RFC 5280. - // This value is unaffected when ValidityNotBefore is also specified. For example, - // if Validity is set to 20 days in the future, the certificate will expire 20 days - // from issuance time regardless of the ValidityNotBefore value. The end of the - // validity period configured on a certificate must not exceed the limit set on its - // parents in the CA hierarchy. + // information, see Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5) + // in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. + // For example, if Validity is set to 20 days in the future, the certificate will + // expire 20 days from issuance time regardless of the ValidityNotBefore value. + // The end of the validity period configured on a certificate must not exceed the + // limit set on its parents in the CA hierarchy. // // This member is required. Validity *types.Validity @@ -87,11 +84,10 @@ type IssueCertificateInput struct { // Specifies X.509 certificate information to be included in the issued // certificate. An APIPassthrough or APICSRPassthrough template variant must be // selected, or else this parameter is ignored. For more information about using - // these templates, see Understanding Certificate Templates - // (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html). If - // conflicting or duplicate certificate information is supplied during certificate - // issuance, Amazon Web Services Private CA applies order of operation rules - // (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) + // these templates, see Understanding Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html) + // . If conflicting or duplicate certificate information is supplied during + // certificate issuance, Amazon Web Services Private CA applies order of operation + // rules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) // to determine what information is used. ApiPassthrough *types.ApiPassthrough @@ -108,27 +104,25 @@ type IssueCertificateInput struct { // this parameter is not provided, Amazon Web Services Private CA defaults to the // EndEntityCertificate/V1 template. For CA certificates, you should choose the // shortest path length that meets your needs. The path length is indicated by the - // PathLenN portion of the ARN, where N is the CA depth - // (https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth). - // Note: The CA depth configured on a subordinate CA certificate must not exceed + // PathLenN portion of the ARN, where N is the CA depth (https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth) + // . Note: The CA depth configured on a subordinate CA certificate must not exceed // the limit set by its parents in the CA hierarchy. For a list of TemplateArn // values supported by Amazon Web Services Private CA, see Understanding - // Certificate Templates - // (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html). + // Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html) + // . TemplateArn *string - // Information describing the start of the validity period of the certificate. This - // parameter sets the “Not Before" date for the certificate. By default, when + // Information describing the start of the validity period of the certificate. + // This parameter sets the “Not Before" date for the certificate. By default, when // issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date // to the issuance time minus 60 minutes. This compensates for clock // inconsistencies across computer systems. The ValidityNotBefore parameter can be // used to customize the “Not Before” value. Unlike the Validity parameter, the // ValidityNotBefore parameter is optional. The ValidityNotBefore value is - // expressed as an explicit date and time, using the Validity type value ABSOLUTE. - // For more information, see Validity - // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html) in - // this API reference and Validity - // (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5) in RFC 5280. + // expressed as an explicit date and time, using the Validity type value ABSOLUTE . + // For more information, see Validity (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html) + // in this API reference and Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5) + // in RFC 5280. ValidityNotBefore *types.Validity noSmithyDocumentSerde diff --git a/service/acmpca/api_op_ListCertificateAuthorities.go b/service/acmpca/api_op_ListCertificateAuthorities.go index a9b6631a9cd..2d971d43d14 100644 --- a/service/acmpca/api_op_ListCertificateAuthorities.go +++ b/service/acmpca/api_op_ListCertificateAuthorities.go @@ -13,8 +13,7 @@ import ( ) // Lists the private certificate authorities that you created by using the -// CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. func (c *Client) ListCertificateAuthorities(ctx context.Context, params *ListCertificateAuthoritiesInput, optFns ...func(*Options)) (*ListCertificateAuthoritiesOutput, error) { if params == nil { diff --git a/service/acmpca/api_op_ListPermissions.go b/service/acmpca/api_op_ListPermissions.go index 17343d53281..a4f61102101 100644 --- a/service/acmpca/api_op_ListPermissions.go +++ b/service/acmpca/api_op_ListPermissions.go @@ -12,29 +12,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all permissions on a private CA, if any, granted to the Certificate Manager -// (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to -// issue and renew ACM certificates that reside in the same Amazon Web Services -// account as the CA. Permissions can be granted with the CreatePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) -// action and revoked with the DeletePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) +// List all permissions on a private CA, if any, granted to the Certificate +// Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM +// to issue and renew ACM certificates that reside in the same Amazon Web Services +// account as the CA. Permissions can be granted with the CreatePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) +// action and revoked with the DeletePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) // action. About Permissions -// -// * If the private CA and the certificates it issues -// reside in the same account, you can use CreatePermission to grant permissions -// for ACM to carry out automatic certificate renewals. -// -// * For automatic -// certificate renewal to succeed, the ACM service principal needs permissions to -// create, retrieve, and list certificates. -// -// * If the private CA and the ACM -// certificates reside in different accounts, then permissions cannot be used to -// enable automatic renewals. Instead, the ACM certificate owner must set up a -// resource-based policy to enable cross-account issuance and renewals. For more -// information, see Using a Resource Based Policy with Amazon Web Services Private -// CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). +// - If the private CA and the certificates it issues reside in the same +// account, you can use CreatePermission to grant permissions for ACM to carry +// out automatic certificate renewals. +// - For automatic certificate renewal to succeed, the ACM service principal +// needs permissions to create, retrieve, and list certificates. +// - If the private CA and the ACM certificates reside in different accounts, +// then permissions cannot be used to enable automatic renewals. Instead, the ACM +// certificate owner must set up a resource-based policy to enable cross-account +// issuance and renewals. For more information, see Using a Resource Based +// Policy with Amazon Web Services Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) { if params == nil { params = &ListPermissionsInput{} @@ -53,12 +47,10 @@ func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInp type ListPermissionsInput struct { // The Amazon Resource Number (ARN) of the private CA to inspect. You can find the - // ARN by calling the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 - // You can get a private CA's ARN by running the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // You can get a private CA's ARN by running the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. // // This member is required. diff --git a/service/acmpca/api_op_ListTags.go b/service/acmpca/api_op_ListTags.go index fef9fb968e0..4265d3fdf97 100644 --- a/service/acmpca/api_op_ListTags.go +++ b/service/acmpca/api_op_ListTags.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags, if any, that are associated with your private CA or one that has -// been shared with you. Tags are labels that you can use to identify and organize -// your CAs. Each tag consists of a key and an optional value. Call the -// TagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) -// action to add one or more tags to your CA. Call the UntagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) +// Lists the tags, if any, that are associated with your private CA or one that +// has been shared with you. Tags are labels that you can use to identify and +// organize your CAs. Each tag consists of a key and an optional value. Call the +// TagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) +// action to add one or more tags to your CA. Call the UntagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) // action to remove tags. func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { @@ -38,8 +36,7 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { // The Amazon Resource Name (ARN) that was returned when you called the - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // diff --git a/service/acmpca/api_op_PutPolicy.go b/service/acmpca/api_op_PutPolicy.go index ee318a7e3d4..4d9f8f31dc8 100644 --- a/service/acmpca/api_op_PutPolicy.go +++ b/service/acmpca/api_op_PutPolicy.go @@ -12,36 +12,27 @@ import ( // Attaches a resource-based policy to a private CA. A policy can also be applied // by sharing a private CA through Amazon Web Services Resource Access Manager -// (RAM). For more information, see Attach a Policy for Cross-Account Access -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html). The -// policy can be displayed with GetPolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html) -// and removed with DeletePolicy -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html). -// About Policies -// -// * A policy grants access on a private CA to an Amazon Web -// Services customer account, to Amazon Web Services Organizations, or to an Amazon -// Web Services Organizations unit. Policies are under the control of a CA -// administrator. For more information, see Using a Resource Based Policy with -// Amazon Web Services Private CA -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html). -// -// * A -// policy permits a user of Certificate Manager (ACM) to issue ACM certificates -// signed by a CA in another account. -// -// * For ACM to manage automatic renewal of -// these certificates, the ACM user must configure a Service Linked Role (SLR). The -// SLR allows the ACM service to assume the identity of the user, subject to -// confirmation against the Amazon Web Services Private CA policy. For more -// information, see Using a Service Linked Role with ACM -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). -// -// * Updates made -// in Amazon Web Services Resource Manager (RAM) are reflected in policies. For -// more information, see Attach a Policy for Cross-Account Access -// (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html). +// (RAM). For more information, see Attach a Policy for Cross-Account Access (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html) +// . The policy can be displayed with GetPolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html) +// and removed with DeletePolicy (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html) +// . About Policies +// - A policy grants access on a private CA to an Amazon Web Services customer +// account, to Amazon Web Services Organizations, or to an Amazon Web Services +// Organizations unit. Policies are under the control of a CA administrator. For +// more information, see Using a Resource Based Policy with Amazon Web Services +// Private CA (https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html) +// . +// - A policy permits a user of Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// - For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service to +// assume the identity of the user, subject to confirmation against the Amazon Web +// Services Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html) +// . +// - Updates made in Amazon Web Services Resource Manager (RAM) are reflected in +// policies. For more information, see Attach a Policy for Cross-Account Access (https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html) +// . func (c *Client) PutPolicy(ctx context.Context, params *PutPolicyInput, optFns ...func(*Options)) (*PutPolicyOutput, error) { if params == nil { params = &PutPolicyInput{} @@ -59,19 +50,18 @@ func (c *Client) PutPolicy(ctx context.Context, params *PutPolicyInput, optFns . type PutPolicyInput struct { - // The path and file name of a JSON-formatted IAM policy to attach to the specified - // private CA resource. If this policy does not contain all required statements or - // if it includes any statement that is not allowed, the PutPolicy action returns - // an InvalidPolicyException. For information about IAM policy and statement - // structure, see Overview of JSON Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). + // The path and file name of a JSON-formatted IAM policy to attach to the + // specified private CA resource. If this policy does not contain all required + // statements or if it includes any statement that is not allowed, the PutPolicy + // action returns an InvalidPolicyException . For information about IAM policy and + // statement structure, see Overview of JSON Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) + // . // // This member is required. Policy *string - // The Amazon Resource Number (ARN) of the private CA to associate with the policy. - // The ARN of the CA can be found by calling the ListCertificateAuthorities - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) + // The Amazon Resource Number (ARN) of the private CA to associate with the + // policy. The ARN of the CA can be found by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // action. // // This member is required. diff --git a/service/acmpca/api_op_RestoreCertificateAuthority.go b/service/acmpca/api_op_RestoreCertificateAuthority.go index a355a6aa110..586055429fb 100644 --- a/service/acmpca/api_op_RestoreCertificateAuthority.go +++ b/service/acmpca/api_op_RestoreCertificateAuthority.go @@ -12,22 +12,17 @@ import ( // Restores a certificate authority (CA) that is in the DELETED state. You can // restore a CA during the period that you defined in the -// PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html) +// PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html) // action. Currently, you can specify 7 to 30 days. If you did not specify a // PermanentDeletionTimeInDays value, by default you can restore the CA at any time // in a 30 day period. You can check the time remaining in the restoration period -// of a private CA in the DELETED state by calling the DescribeCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html) -// or ListCertificateAuthorities -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) +// of a private CA in the DELETED state by calling the DescribeCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html) +// or ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) // actions. The status of a restored CA is set to its pre-deletion status when the -// RestoreCertificateAuthority action returns. To change its status to ACTIVE, call -// the UpdateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) +// RestoreCertificateAuthority action returns. To change its status to ACTIVE , +// call the UpdateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) // action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you -// must use the ImportCertificateAuthorityCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) +// must use the ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) // action to import a certificate authority into the private CA before it can be // activated. You cannot restore a CA after the restoration period has ended. func (c *Client) RestoreCertificateAuthority(ctx context.Context, params *RestoreCertificateAuthorityInput, optFns ...func(*Options)) (*RestoreCertificateAuthorityOutput, error) { @@ -48,8 +43,7 @@ func (c *Client) RestoreCertificateAuthority(ctx context.Context, params *Restor type RestoreCertificateAuthorityInput struct { // The Amazon Resource Name (ARN) that was returned when you called the - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // diff --git a/service/acmpca/api_op_RevokeCertificate.go b/service/acmpca/api_op_RevokeCertificate.go index cff858b7125..61f1c2cc85d 100644 --- a/service/acmpca/api_op_RevokeCertificate.go +++ b/service/acmpca/api_op_RevokeCertificate.go @@ -18,18 +18,15 @@ import ( // specify. A CRL is typically updated approximately 30 minutes after a certificate // is revoked. If for any reason the CRL update fails, Amazon Web Services Private // CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you -// can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For -// more information, see Supported CloudWatch Metrics -// (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html). -// Both Amazon Web Services Private CA and the IAM principal must have permission +// can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket . For +// more information, see Supported CloudWatch Metrics (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html) +// . Both Amazon Web Services Private CA and the IAM principal must have permission // to write to the S3 bucket that you specify. If the IAM principal making the call // does not have permission to write to the bucket, then an exception is thrown. -// For more information, see Access policies for CRLs in Amazon S3 -// (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies). -// Amazon Web Services Private CA also writes revocation information to the audit -// report. For more information, see CreateCertificateAuthorityAuditReport -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html). -// You cannot revoke a root CA self-signed certificate. +// For more information, see Access policies for CRLs in Amazon S3 (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies) +// . Amazon Web Services Private CA also writes revocation information to the audit +// report. For more information, see CreateCertificateAuthorityAuditReport (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) +// . You cannot revoke a root CA self-signed certificate. func (c *Client) RevokeCertificate(ctx context.Context, params *RevokeCertificateInput, optFns ...func(*Options)) (*RevokeCertificateOutput, error) { if params == nil { params = &RevokeCertificateInput{} @@ -55,15 +52,13 @@ type RevokeCertificateInput struct { CertificateAuthorityArn *string // Serial number of the certificate to be revoked. This must be in hexadecimal - // format. You can retrieve the serial number by calling GetCertificate - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) + // format. You can retrieve the serial number by calling GetCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html) // with the Amazon Resource Name (ARN) of the certificate you want and the ARN of // your private CA. The GetCertificate action retrieves the certificate in the PEM // format. You can use the following OpenSSL command to list the certificate in // text format and copy the hexadecimal serial number. openssl x509 -in file_path // -text -noout You can also copy the serial number from the console or use the - // DescribeCertificate - // (https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) + // DescribeCertificate (https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) // action in the Certificate Manager API Reference. // // This member is required. diff --git a/service/acmpca/api_op_TagCertificateAuthority.go b/service/acmpca/api_op_TagCertificateAuthority.go index bbc173b51c5..7e34da89de8 100644 --- a/service/acmpca/api_op_TagCertificateAuthority.go +++ b/service/acmpca/api_op_TagCertificateAuthority.go @@ -18,16 +18,14 @@ import ( // apply a tag to just one private CA if you want to identify a specific // characteristic of that CA, or you can apply the same tag to multiple private CAs // if you want to filter for a common relationship among those CAs. To remove one -// or more tags, use the UntagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) -// action. Call the ListTags -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) +// or more tags, use the UntagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) +// action. Call the ListTags (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) // action to see what tags are associated with your CA. To attach tags to a private // CA during the creation procedure, a CA administrator must first associate an // inline IAM policy with the CreateCertificateAuthority action and explicitly // allow tagging. For more information, see Attaching tags to a CA at the time of -// creation -// (https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca). +// creation (https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca) +// . func (c *Client) TagCertificateAuthority(ctx context.Context, params *TagCertificateAuthorityInput, optFns ...func(*Options)) (*TagCertificateAuthorityOutput, error) { if params == nil { params = &TagCertificateAuthorityInput{} @@ -46,9 +44,8 @@ func (c *Client) TagCertificateAuthority(ctx context.Context, params *TagCertifi type TagCertificateAuthorityInput struct { // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. diff --git a/service/acmpca/api_op_UntagCertificateAuthority.go b/service/acmpca/api_op_UntagCertificateAuthority.go index a29ab94c072..5d72bad3f8e 100644 --- a/service/acmpca/api_op_UntagCertificateAuthority.go +++ b/service/acmpca/api_op_UntagCertificateAuthority.go @@ -15,10 +15,8 @@ import ( // pair. If you do not specify the value portion of the tag when calling this // action, the tag will be removed regardless of value. If you specify a value, the // tag is removed only if it is associated with the specified value. To add tags to -// a private CA, use the TagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html). -// Call the ListTags -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) +// a private CA, use the TagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) +// . Call the ListTags (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html) // action to see what tags are associated with your CA. func (c *Client) UntagCertificateAuthority(ctx context.Context, params *UntagCertificateAuthorityInput, optFns ...func(*Options)) (*UntagCertificateAuthorityOutput, error) { if params == nil { @@ -38,9 +36,8 @@ func (c *Client) UntagCertificateAuthority(ctx context.Context, params *UntagCer type UntagCertificateAuthorityInput struct { // The Amazon Resource Name (ARN) that was returned when you called - // CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html). - // This must be of the form: + // CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // . This must be of the form: // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. diff --git a/service/acmpca/api_op_UpdateCertificateAuthority.go b/service/acmpca/api_op_UpdateCertificateAuthority.go index 447f10b559f..76ba1a70078 100644 --- a/service/acmpca/api_op_UpdateCertificateAuthority.go +++ b/service/acmpca/api_op_UpdateCertificateAuthority.go @@ -18,8 +18,8 @@ import ( // the IAM principal must have permission to write to the S3 bucket that you // specify. If the IAM principal making the call does not have permission to write // to the bucket, then an exception is thrown. For more information, see Access -// policies for CRLs in Amazon S3 -// (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies). +// policies for CRLs in Amazon S3 (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies) +// . func (c *Client) UpdateCertificateAuthority(ctx context.Context, params *UpdateCertificateAuthorityInput, optFns ...func(*Options)) (*UpdateCertificateAuthorityOutput, error) { if params == nil { params = &UpdateCertificateAuthorityInput{} @@ -47,29 +47,20 @@ type UpdateCertificateAuthorityInput struct { // Contains information to enable Online Certificate Status Protocol (OCSP) // support, to enable a certificate revocation list (CRL), to enable both, or to // enable neither. If this parameter is not supplied, existing capibilites remain - // unchanged. For more information, see the OcspConfiguration - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html) - // and CrlConfiguration - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html) + // unchanged. For more information, see the OcspConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html) + // and CrlConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html) // types. The following requirements apply to revocation configurations. - // - // * A - // configuration disabling CRLs or OCSP must contain only the Enabled=False - // parameter, and will fail if other parameters such as CustomCname or - // ExpirationInDays are included. - // - // * In a CRL configuration, the S3BucketName - // parameter must conform to Amazon S3 bucket naming rules - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). - // - // * - // A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or - // OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) restrictions - // on the use of special characters in a CNAME. - // - // * In a CRL or OCSP configuration, - // the value of a CNAME parameter must not include a protocol prefix such as - // "http://" or "https://". + // - A configuration disabling CRLs or OCSP must contain only the Enabled=False + // parameter, and will fail if other parameters such as CustomCname or + // ExpirationInDays are included. + // - In a CRL configuration, the S3BucketName parameter must conform to Amazon + // S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) + // . + // - A configuration containing a custom Canonical Name (CNAME) parameter for + // CRLs or OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) + // restrictions on the use of special characters in a CNAME. + // - In a CRL or OCSP configuration, the value of a CNAME parameter must not + // include a protocol prefix such as "http://" or "https://". RevocationConfiguration *types.RevocationConfiguration // Status of your private CA. diff --git a/service/acmpca/doc.go b/service/acmpca/doc.go index 0f9648708c7..6d3896d88ad 100644 --- a/service/acmpca/doc.go +++ b/service/acmpca/doc.go @@ -10,18 +10,17 @@ // request parameters and the JSON response. Alternatively, you can use one of the // Amazon Web Services SDKs to access an API that is tailored to the programming // language or platform that you prefer. For more information, see Amazon Web -// Services SDKs (https://aws.amazon.com/tools/#SDKs). Each Amazon Web Services +// Services SDKs (https://aws.amazon.com/tools/#SDKs) . Each Amazon Web Services // Private CA API operation has a quota that determines the number of times the // operation can be called per second. Amazon Web Services Private CA throttles API // requests at different rates depending on the operation. Throttling means that // Amazon Web Services Private CA rejects an otherwise valid request because the // request exceeds the operation's quota for the number of requests per second. // When a request is throttled, Amazon Web Services Private CA returns a -// ThrottlingException -// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html) +// ThrottlingException (https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html) // error. Amazon Web Services Private CA does not guarantee a minimum request rate // for APIs. To see an up-to-date list of your Amazon Web Services Private CA // quotas, or to request a quota increase, log into your Amazon Web Services -// account and visit the Service Quotas -// (https://console.aws.amazon.com/servicequotas/) console. +// account and visit the Service Quotas (https://console.aws.amazon.com/servicequotas/) +// console. package acmpca diff --git a/service/acmpca/types/enums.go b/service/acmpca/types/enums.go index 2bd6649c8f2..9642a845335 100644 --- a/service/acmpca/types/enums.go +++ b/service/acmpca/types/enums.go @@ -116,9 +116,9 @@ const ( CertificateAuthorityTypeSubordinate CertificateAuthorityType = "SUBORDINATE" ) -// Values returns all known values for CertificateAuthorityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CertificateAuthorityType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateAuthorityType) Values() []CertificateAuthorityType { return []CertificateAuthorityType{ "ROOT", @@ -207,9 +207,9 @@ const ( KeyAlgorithmEcSecp384r1 KeyAlgorithm = "EC_secp384r1" ) -// Values returns all known values for KeyAlgorithm. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for KeyAlgorithm. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (KeyAlgorithm) Values() []KeyAlgorithm { return []KeyAlgorithm{ "RSA_2048", diff --git a/service/acmpca/types/errors.go b/service/acmpca/types/errors.go index 31cf11438bb..ab30395a7c5 100644 --- a/service/acmpca/types/errors.go +++ b/service/acmpca/types/errors.go @@ -113,8 +113,8 @@ func (e *InvalidArnException) ErrorCode() string { func (e *InvalidArnException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The token specified in the NextToken argument is not valid. Use the token -// returned from your previous call to ListCertificateAuthorities -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html). +// returned from your previous call to ListCertificateAuthorities (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html) +// . type InvalidNextTokenException struct { Message *string @@ -142,8 +142,8 @@ func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault { return smit // The resource policy is invalid or is missing a required statement. For general // information about IAM policy and statement structure, see Overview of JSON -// Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). +// Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) +// . type InvalidPolicyException struct { Message *string @@ -459,8 +459,8 @@ func (e *RequestInProgressException) ErrorCode() string { } func (e *RequestInProgressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A resource such as a private CA, S3 bucket, certificate, audit report, or policy -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. type ResourceNotFoundException struct { Message *string diff --git a/service/acmpca/types/types.go b/service/acmpca/types/types.go index 1a124fc07e6..63f9a278045 100644 --- a/service/acmpca/types/types.go +++ b/service/acmpca/types/types.go @@ -8,8 +8,8 @@ import ( ) // Provides access information used by the authorityInfoAccess and -// subjectInfoAccess extensions described in RFC 5280 -// (https://datatracker.ietf.org/doc/html/rfc5280). +// subjectInfoAccess extensions described in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280) +// . type AccessDescription struct { // The location of AccessDescription information. @@ -27,26 +27,26 @@ type AccessDescription struct { // Describes the type and format of extension access. Only one of // CustomObjectIdentifier or AccessMethodType may be provided. Providing both -// results in InvalidArgsException. +// results in InvalidArgsException . type AccessMethod struct { - // Specifies the AccessMethod. + // Specifies the AccessMethod . AccessMethodType AccessMethodType - // An object identifier (OID) specifying the AccessMethod. The OID must satisfy the - // regular expression shown below. For more information, see NIST's definition of - // Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). + // An object identifier (OID) specifying the AccessMethod . The OID must satisfy + // the regular expression shown below. For more information, see NIST's definition + // of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier) + // . CustomObjectIdentifier *string noSmithyDocumentSerde } -// Contains X.509 certificate information to be placed in an issued certificate. An -// APIPassthrough or APICSRPassthrough template variant must be selected, or else -// this parameter is ignored. If conflicting or duplicate certificate information -// is supplied from other sources, Amazon Web Services Private CA applies order of -// operation rules -// (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) +// Contains X.509 certificate information to be placed in an issued certificate. +// An APIPassthrough or APICSRPassthrough template variant must be selected, or +// else this parameter is ignored. If conflicting or duplicate certificate +// information is supplied from other sources, Amazon Web Services Private CA +// applies order of operation rules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) // to determine what information is used. type ApiPassthrough struct { @@ -55,9 +55,10 @@ type ApiPassthrough struct { // Contains information about the certificate subject. The Subject field in the // certificate identifies the entity that owns or controls the public key in the - // certificate. The entity can be a user, computer, device, or service. The Subject - // must contain an X.500 distinguished name (DN). A DN is a sequence of relative - // distinguished names (RDNs). The RDNs are separated by commas in the certificate. + // certificate. The entity can be a user, computer, device, or service. The + // Subject must contain an X.500 distinguished name (DN). A DN is a sequence of + // relative distinguished names (RDNs). The RDNs are separated by commas in the + // certificate. Subject *ASN1Subject noSmithyDocumentSerde @@ -65,14 +66,15 @@ type ApiPassthrough struct { // Contains information about the certificate subject. The Subject field in the // certificate identifies the entity that owns or controls the public key in the -// certificate. The entity can be a user, computer, device, or service. The Subject -// must contain an X.500 distinguished name (DN). A DN is a sequence of relative -// distinguished names (RDNs). The RDNs are separated by commas in the certificate. +// certificate. The entity can be a user, computer, device, or service. The +// Subject must contain an X.500 distinguished name (DN). A DN is a sequence of +// relative distinguished names (RDNs). The RDNs are separated by commas in the +// certificate. type ASN1Subject struct { - // For CA and end-entity certificates in a private PKI, the common name (CN) can be - // any string within the length limit. Note: In publicly trusted certificates, the - // common name must be a fully qualified domain name (FQDN) associated with the + // For CA and end-entity certificates in a private PKI, the common name (CN) can + // be any string within the length limit. Note: In publicly trusted certificates, + // the common name must be a fully qualified domain name (FQDN) associated with the // certificate subject. CommonName *string @@ -82,9 +84,8 @@ type ASN1Subject struct { // Contains a sequence of one or more X.500 relative distinguished names (RDNs), // each of which consists of an object identifier (OID) and a value. For more - // information, see NIST’s definition of Object Identifier (OID) - // (https://csrc.nist.gov/glossary/term/Object_Identifier). Custom attributes - // cannot be used in combination with standard attributes. + // information, see NIST’s definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier) + // . Custom attributes cannot be used in combination with standard attributes. CustomAttributes []CustomAttribute // Disambiguating information for the certificate subject. @@ -127,31 +128,28 @@ type ASN1Subject struct { // ordered last. In Asian cultures the surname is typically ordered first. Surname *string - // A title such as Mr. or Ms., which is pre-pended to the name to refer formally to - // the certificate subject. + // A title such as Mr. or Ms., which is pre-pended to the name to refer formally + // to the certificate subject. Title *string noSmithyDocumentSerde } -// Contains information about your private certificate authority (CA). Your private -// CA can issue and revoke X.509 digital certificates. Digital certificates verify -// that the entity named in the certificate Subject field owns or controls the -// public key contained in the Subject Public Key Info field. Call the -// CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// Contains information about your private certificate authority (CA). Your +// private CA can issue and revoke X.509 digital certificates. Digital certificates +// verify that the entity named in the certificate Subject field owns or controls +// the public key contained in the Subject Public Key Info field. Call the +// CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action to create your private CA. You must then call the -// GetCertificateAuthorityCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html) +// GetCertificateAuthorityCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html) // action to retrieve a private CA certificate signing request (CSR). Sign the CSR // with your Amazon Web Services Private CA-hosted or on-premises root or -// subordinate CA certificate. Call the ImportCertificateAuthorityCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) +// subordinate CA certificate. Call the ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) // action to import the signed certificate into Certificate Manager (ACM). type CertificateAuthority struct { // Amazon Resource Name (ARN) for your private certificate authority (CA). The - // format is 12345678-1234-1234-1234-123456789012 . + // format is 12345678-1234-1234-1234-123456789012 . Arn *string // Your private CA configuration. @@ -186,13 +184,12 @@ type CertificateAuthority struct { // The period during which a deleted CA can be restored. For more information, see // the PermanentDeletionTimeInDays parameter of the - // DeleteCertificateAuthorityRequest - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html) + // DeleteCertificateAuthorityRequest (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html) // action. RestorableUntil *time.Time - // Information about the Online Certificate Status Protocol (OCSP) configuration or - // certificate revocation list (CRL) created and maintained by your private CA. + // Information about the Online Certificate Status Protocol (OCSP) configuration + // or certificate revocation list (CRL) created and maintained by your private CA. RevocationConfiguration *RevocationConfiguration // Serial number of your private CA. @@ -218,14 +215,13 @@ type CertificateAuthority struct { // pair that your private CA creates when it issues a certificate. It also includes // the signature algorithm that it uses when issuing certificates, and its X.500 // distinguished name. You must specify this information when you call the -// CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) // action. type CertificateAuthorityConfiguration struct { - // Type of the public key algorithm and size, in bits, of the key pair that your CA - // creates when it issues a certificate. When you create a subordinate CA, you must - // use a key algorithm supported by the parent CA. + // Type of the public key algorithm and size, in bits, of the key pair that your + // CA creates when it issues a certificate. When you create a subordinate CA, you + // must use a key algorithm supported by the parent CA. // // This member is required. KeyAlgorithm KeyAlgorithm @@ -250,19 +246,18 @@ type CertificateAuthorityConfiguration struct { noSmithyDocumentSerde } -// Contains configuration information for a certificate revocation list (CRL). Your -// private certificate authority (CA) creates base CRLs. Delta CRLs are not +// Contains configuration information for a certificate revocation list (CRL). +// Your private certificate authority (CA) creates base CRLs. Delta CRLs are not // supported. You can enable CRLs for your new or an existing private CA by setting -// the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that +// the Enabled parameter to true . Your private CA writes CRLs to an S3 bucket that // you specify in the S3BucketName parameter. You can hide the name of your bucket // by specifying a value for the CustomCname parameter. Your private CA copies the // CNAME or the S3 bucket name to the CRL Distribution Points extension of each // certificate it issues. Your S3 bucket policy must give write permission to // Amazon Web Services Private CA. Amazon Web Services Private CA assets that are // stored in Amazon S3 can be protected with encryption. For more information, see -// Encrypting Your CRLs -// (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption). -// Your private CA uses the value in the ExpirationInDays parameter to calculate +// Encrypting Your CRLs (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption) +// . Your private CA uses the value in the ExpirationInDays parameter to calculate // the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's // expiration date or when a certificate is revoked. When a certificate is revoked, // it appears in the CRL until the certificate expires, and then in one additional @@ -270,66 +265,38 @@ type CertificateAuthorityConfiguration struct { // typically updated approximately 30 minutes after a certificate is revoked. If // for any reason a CRL update fails, Amazon Web Services Private CA makes further // attempts every 15 minutes. CRLs contain the following fields: +// - Version: The current version number defined in RFC 5280 is V2. The integer +// value is 0x1. +// - Signature Algorithm: The name of the algorithm used to sign the CRL. +// - Issuer: The X.500 distinguished name of your private CA that issued the +// CRL. +// - Last Update: The issue date and time of this CRL. +// - Next Update: The day and time by which the next CRL will be issued. +// - Revoked Certificates: List of revoked certificates. Each list item contains +// the following information. +// - Serial Number: The serial number, in hexadecimal format, of the revoked +// certificate. +// - Revocation Date: Date and time the certificate was revoked. +// - CRL Entry Extensions: Optional extensions for the CRL entry. +// - X509v3 CRL Reason Code: Reason the certificate was revoked. +// - CRL Extensions: Optional extensions for the CRL. +// - X509v3 Authority Key Identifier: Identifies the public key associated with +// the private key used to sign the certificate. +// - X509v3 CRL Number:: Decimal sequence number for the CRL. +// - Signature Algorithm: Algorithm used by your private CA to sign the CRL. +// - Signature Value: Signature computed over the CRL. // -// * Version: The -// current version number defined in RFC 5280 is V2. The integer value is 0x1. -// -// * -// Signature Algorithm: The name of the algorithm used to sign the CRL. -// -// * Issuer: -// The X.500 distinguished name of your private CA that issued the CRL. -// -// * Last -// Update: The issue date and time of this CRL. -// -// * Next Update: The day and time by -// which the next CRL will be issued. -// -// * Revoked Certificates: List of revoked -// certificates. Each list item contains the following information. -// -// * Serial -// Number: The serial number, in hexadecimal format, of the revoked certificate. -// -// * -// Revocation Date: Date and time the certificate was revoked. -// -// * CRL Entry -// Extensions: Optional extensions for the CRL entry. -// -// * X509v3 CRL Reason Code: -// Reason the certificate was revoked. -// -// * CRL Extensions: Optional extensions for -// the CRL. -// -// * X509v3 Authority Key Identifier: Identifies the public key -// associated with the private key used to sign the certificate. -// -// * X509v3 CRL -// Number:: Decimal sequence number for the CRL. -// -// * Signature Algorithm: Algorithm -// used by your private CA to sign the CRL. -// -// * Signature Value: Signature computed -// over the CRL. -// -// Certificate revocation lists created by Amazon Web Services -// Private CA are DER-encoded. You can use the following OpenSSL command to list a -// CRL. openssl crl -inform DER -text -in crl_path -noout For more information, see -// Planning a certificate revocation list (CRL) -// (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html) in -// the Amazon Web Services Private Certificate Authority User Guide +// Certificate revocation lists created by Amazon Web Services Private CA are +// DER-encoded. You can use the following OpenSSL command to list a CRL. openssl +// crl -inform DER -text -in crl_path -noout For more information, see Planning a +// certificate revocation list (CRL) (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html) +// in the Amazon Web Services Private Certificate Authority User Guide type CrlConfiguration struct { // Boolean value that specifies whether certificate revocation lists (CRLs) are // enabled. You can use this value to enable certificate revocation for a new CA - // when you call the CreateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) - // action or for an existing CA when you call the UpdateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) + // when you call the CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) + // action or for an existing CA when you call the UpdateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) // action. // // This member is required. @@ -338,10 +305,9 @@ type CrlConfiguration struct { // Name inserted into the certificate CRL Distribution Points extension that // enables the use of an alias for the CRL distribution point. Use this value if // you don't want the name of your S3 bucket to be public. The content of a - // Canonical Name (CNAME) record must conform to RFC2396 - // (https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special - // characters in URIs. Additionally, the value of the CNAME must not include a - // protocol prefix such as "http://" or "https://". + // Canonical Name (CNAME) record must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) + // restrictions on the use of special characters in URIs. Additionally, the value + // of the CNAME must not include a protocol prefix such as "http://" or "https://". CustomCname *string // Validity period of the CRL in days. @@ -350,13 +316,11 @@ type CrlConfiguration struct { // Name of the S3 bucket that contains the CRL. If you do not provide a value for // the CustomCname argument, the name of your S3 bucket is placed into the CRL // Distribution Points extension of the issued certificate. You can change the name - // of your bucket by calling the UpdateCertificateAuthority - // (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) - // operation. You must specify a bucket policy - // (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) + // of your bucket by calling the UpdateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) + // operation. You must specify a bucket policy (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) // that allows Amazon Web Services Private CA to write the CRL to your bucket. The - // S3BucketName parameter must conform to the S3 bucket naming rules - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). + // S3BucketName parameter must conform to the S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) + // . S3BucketName *string // Determines whether the CRL will be publicly readable or privately held in the @@ -364,14 +328,14 @@ type CrlConfiguration struct { // the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of // the CRL S3 bucket can access the CRL, and your PKI clients may need an // alternative method of access. If no value is specified, the default is - // PUBLIC_READ. Note: This default can cause CA creation to fail in some + // PUBLIC_READ . Note: This default can cause CA creation to fail in some // circumstances. If you have have enabled the Block Public Access (BPA) feature in // your S3 account, then you must specify the value of this parameter as - // BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have + // BUCKET_OWNER_FULL_CONTROL , and not doing so results in an error. If you have // disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or // PUBLIC_READ as the value. For more information, see Blocking public access to - // the S3 bucket - // (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa). + // the S3 bucket (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa) + // . S3ObjectAcl S3ObjectAcl noSmithyDocumentSerde @@ -385,10 +349,10 @@ type CsrExtensions struct { // certificate. KeyUsage *KeyUsage - // For CA certificates, provides a path to additional information pertaining to the - // CA, such as revocation and policy. For more information, see Subject Information - // Access (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC - // 5280. + // For CA certificates, provides a path to additional information pertaining to + // the CA, such as revocation and policy. For more information, see Subject + // Information Access (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) + // in RFC 5280. SubjectInformationAccess []AccessDescription noSmithyDocumentSerde @@ -412,8 +376,8 @@ type CustomAttribute struct { } // Specifies the X.509 extension information for a certificate. Extensions present -// in CustomExtensions follow the ApiPassthroughtemplate rules -// (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). +// in CustomExtensions follow the ApiPassthrough template rules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) +// . type CustomExtension struct { // Specifies the object identifier (OID) of the X.509 extension. For more @@ -433,9 +397,9 @@ type CustomExtension struct { noSmithyDocumentSerde } -// Describes an Electronic Data Interchange (EDI) entity as described in as defined -// in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280) in -// RFC 5280. +// Describes an Electronic Data Interchange (EDI) entity as described in as +// defined in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280) +// in RFC 5280. type EdiPartyName struct { // Specifies the party name. @@ -456,8 +420,8 @@ type ExtendedKeyUsage struct { // Specifies a custom ExtendedKeyUsage with an object identifier (OID). ExtendedKeyUsageObjectIdentifier *string - // Specifies a standard ExtendedKeyUsage as defined as in RFC 5280 - // (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12). + // Specifies a standard ExtendedKeyUsage as defined as in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12) + // . ExtendedKeyUsageType ExtendedKeyUsageType noSmithyDocumentSerde @@ -468,18 +432,16 @@ type Extensions struct { // Contains a sequence of one or more policy information terms, each of which // consists of an object identifier (OID) and optional qualifiers. For more - // information, see NIST's definition of Object Identifier (OID) - // (https://csrc.nist.gov/glossary/term/Object_Identifier). In an end-entity - // certificate, these terms indicate the policy under which the certificate was - // issued and the purposes for which it may be used. In a CA certificate, these - // terms limit the set of policies for certification paths that include this - // certificate. + // information, see NIST's definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier) + // . In an end-entity certificate, these terms indicate the policy under which the + // certificate was issued and the purposes for which it may be used. In a CA + // certificate, these terms limit the set of policies for certification paths that + // include this certificate. CertificatePolicies []PolicyInformation // Contains a sequence of one or more X.509 extensions, each of which consists of // an object identifier (OID), a base64-encoded value, and the critical flag. For - // more information, see the Global OID reference database. - // (https://oidref.com/2.5.29) + // more information, see the Global OID reference database. (https://oidref.com/2.5.29) CustomExtensions []CustomExtension // Specifies additional purposes for which the certified public key may be used @@ -498,17 +460,17 @@ type Extensions struct { noSmithyDocumentSerde } -// Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 -// (https://datatracker.ietf.org/doc/html/rfc5280). Only one of the following -// naming options should be provided. Providing more than one option results in an -// InvalidArgsException error. +// Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280) +// . Only one of the following naming options should be provided. Providing more +// than one option results in an InvalidArgsException error. type GeneralName struct { // Contains information about the certificate subject. The Subject field in the // certificate identifies the entity that owns or controls the public key in the - // certificate. The entity can be a user, computer, device, or service. The Subject - // must contain an X.500 distinguished name (DN). A DN is a sequence of relative - // distinguished names (RDNs). The RDNs are separated by commas in the certificate. + // certificate. The entity can be a user, computer, device, or service. The + // Subject must contain an X.500 distinguished name (DN). A DN is a sequence of + // relative distinguished names (RDNs). The RDNs are separated by commas in the + // certificate. DirectoryName *ASN1Subject // Represents GeneralName as a DNS name. @@ -526,8 +488,8 @@ type GeneralName struct { // Represents GeneralName as an object identifier (OID). RegisteredId *string - // Represents GeneralName as an RFC 822 - // (https://datatracker.ietf.org/doc/html/rfc822) email address. + // Represents GeneralName as an RFC 822 (https://datatracker.ietf.org/doc/html/rfc822) + // email address. Rfc822Name *string // Represents GeneralName as a URI. @@ -581,16 +543,15 @@ type OcspConfiguration struct { // This member is required. Enabled *bool - // By default, Amazon Web Services Private CA injects an Amazon Web Services domain - // into certificates being validated by the Online Certificate Status Protocol - // (OCSP). A customer can alternatively use this object to define a CNAME + // By default, Amazon Web Services Private CA injects an Amazon Web Services + // domain into certificates being validated by the Online Certificate Status + // Protocol (OCSP). A customer can alternatively use this object to define a CNAME // specifying a customized OCSP domain. The content of a Canonical Name (CNAME) // record must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt) // restrictions on the use of special characters in URIs. Additionally, the value // of the CNAME must not include a protocol prefix such as "http://" or "https://". - // For more information, see Customizing Online Certificate Status Protocol (OCSP) - // (https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html) in - // the Amazon Web Services Private Certificate Authority User Guide. + // For more information, see Customizing Online Certificate Status Protocol (OCSP) (https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html) + // in the Amazon Web Services Private Certificate Authority User Guide. OcspCustomCname *string noSmithyDocumentSerde @@ -598,8 +559,8 @@ type OcspConfiguration struct { // Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and // value. The OID must satisfy the regular expression shown below. For more -// information, see NIST's definition of Object Identifier (OID) -// (https://csrc.nist.gov/glossary/term/Object_Identifier). +// information, see NIST's definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier) +// . type OtherName struct { // Specifies an OID. @@ -615,16 +576,13 @@ type OtherName struct { noSmithyDocumentSerde } -// Permissions designate which private CA actions can be performed by an Amazon Web -// Services service or entity. In order for ACM to automatically renew private +// Permissions designate which private CA actions can be performed by an Amazon +// Web Services service or entity. In order for ACM to automatically renew private // certificates, you must give the ACM service principal all available permissions -// (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be -// assigned with the CreatePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) -// action, removed with the DeletePermission -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) -// action, and listed with the ListPermissions -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) +// ( IssueCertificate , GetCertificate , and ListPermissions ). Permissions can be +// assigned with the CreatePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html) +// action, removed with the DeletePermission (https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html) +// action, and listed with the ListPermissions (https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html) // action. type Permission struct { @@ -632,8 +590,8 @@ type Permission struct { // Services service. Actions []ActionType - // The Amazon Resource Number (ARN) of the private CA from which the permission was - // issued. + // The Amazon Resource Number (ARN) of the private CA from which the permission + // was issued. CertificateAuthorityArn *string // The time at which the permission was created. @@ -643,7 +601,7 @@ type Permission struct { Policy *string // The Amazon Web Services service or entity that holds the permission. At this - // time, the only valid principal is acm.amazonaws.com. + // time, the only valid principal is acm.amazonaws.com . Principal *string // The ID of the account that assigned the permission. @@ -657,30 +615,30 @@ type PolicyInformation struct { // Specifies the object identifier (OID) of the certificate policy under which the // certificate was issued. For more information, see NIST's definition of Object - // Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). + // Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier) . // // This member is required. CertPolicyId *string - // Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA - // supports the certification practice statement (CPS) qualifier. + // Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private + // CA supports the certification practice statement (CPS) qualifier. PolicyQualifiers []PolicyQualifierInfo noSmithyDocumentSerde } -// Modifies the CertPolicyId of a PolicyInformation object with a qualifier. Amazon -// Web Services Private CA supports the certification practice statement (CPS) -// qualifier. +// Modifies the CertPolicyId of a PolicyInformation object with a qualifier. +// Amazon Web Services Private CA supports the certification practice statement +// (CPS) qualifier. type PolicyQualifierInfo struct { - // Identifies the qualifier modifying a CertPolicyId. + // Identifies the qualifier modifying a CertPolicyId . // // This member is required. PolicyQualifierId PolicyQualifierId - // Defines the qualifier type. Amazon Web Services Private CA supports the use of a - // URI for a CPS qualifier in this field. + // Defines the qualifier type. Amazon Web Services Private CA supports the use of + // a URI for a CPS qualifier in this field. // // This member is required. Qualifier *Qualifier @@ -689,9 +647,8 @@ type PolicyQualifierInfo struct { } // Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports -// the certification practice statement (CPS) qualifier -// (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC -// 5280. +// the certification practice statement (CPS) qualifier (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) +// defined in RFC 5280. type Qualifier struct { // Contains a pointer to a certification practice statement (CPS) published by the @@ -703,18 +660,14 @@ type Qualifier struct { noSmithyDocumentSerde } -// Certificate revocation information used by the CreateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) -// and UpdateCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) +// Certificate revocation information used by the CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) +// and UpdateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) // actions. Your private certificate authority (CA) can configure Online // Certificate Status Protocol (OCSP) support and/or maintain a certificate // revocation list (CRL). OCSP returns validation information about certificates as // requested by clients, and a CRL contains an updated list of certificates revoked -// by your CA. For more information, see RevokeCertificate -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) -// and Setting up a certificate revocation method -// (https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) +// by your CA. For more information, see RevokeCertificate (https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) +// and Setting up a certificate revocation method (https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) // in the Amazon Web Services Private Certificate Authority User Guide. type RevocationConfiguration struct { @@ -732,13 +685,11 @@ type RevocationConfiguration struct { noSmithyDocumentSerde } -// Tags are labels that you can use to identify and organize your private CAs. Each -// tag consists of a key and an optional value. You can associate up to 50 tags -// with a private CA. To add one or more tags to a private CA, call the -// TagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) -// action. To remove a tag, call the UntagCertificateAuthority -// (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) +// Tags are labels that you can use to identify and organize your private CAs. +// Each tag consists of a key and an optional value. You can associate up to 50 +// tags with a private CA. To add one or more tags to a private CA, call the +// TagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html) +// action. To remove a tag, call the UntagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html) // action. type Tag struct { @@ -756,56 +707,41 @@ type Tag struct { // Validity specifies the period of time during which a certificate is valid. // Validity can be expressed as an explicit date and time when the validity of a // certificate starts or expires, or as a span of time after issuance, stated in -// days, months, or years. For more information, see Validity -// (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) in RFC 5280. Amazon Web -// Services Private CA API consumes the Validity data type differently in two -// distinct parameters of the IssueCertificate action. The required parameter -// IssueCertificate:Validity specifies the end of a certificate's validity period. -// The optional parameter IssueCertificate:ValidityNotBefore specifies a customized -// starting time for the validity period. +// days, months, or years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) +// in RFC 5280. Amazon Web Services Private CA API consumes the Validity data type +// differently in two distinct parameters of the IssueCertificate action. The +// required parameter IssueCertificate : Validity specifies the end of a +// certificate's validity period. The optional parameter IssueCertificate : +// ValidityNotBefore specifies a customized starting time for the validity period. type Validity struct { - // Determines how Amazon Web Services Private CA interprets the Value parameter, an - // integer. Supported validity types include those listed below. Type definitions - // with values include a sample input value and the resulting output. END_DATE: The - // specific date and time when the certificate will expire, expressed using UTCTime - // (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, - // if the year field (YY) is greater than or equal to 50, the year is interpreted - // as 19YY. If the year field is less than 50, the year is interpreted as 20YY. - // - // * - // Sample input value: 491231235959 (UTCTime format) - // - // * Output expiration - // date/time: 12/31/2049 23:59:59 - // - // ABSOLUTE: The specific date and time when the - // validity of a certificate will start or expire, expressed in seconds since the - // Unix Epoch. - // - // * Sample input value: 2524608000 - // - // * Output expiration date/time: - // 01/01/2050 00:00:00 - // - // DAYS, MONTHS, YEARS: The relative time from the moment of - // issuance until the certificate will expire, expressed in days, months, or years. - // Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC: - // - // * Sample input value: - // 90 - // - // * Output expiration date: 01/10/2020 12:34:54 UTC - // - // The minimum validity - // duration for a certificate using relative time (DAYS) is one day. The minimum - // validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one - // second. + // Determines how Amazon Web Services Private CA interprets the Value parameter, + // an integer. Supported validity types include those listed below. Type + // definitions with values include a sample input value and the resulting output. + // END_DATE : The specific date and time when the certificate will expire, + // expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) + // format. When UTCTime is used, if the year field (YY) is greater than or equal to + // 50, the year is interpreted as 19YY. If the year field is less than 50, the year + // is interpreted as 20YY. + // - Sample input value: 491231235959 (UTCTime format) + // - Output expiration date/time: 12/31/2049 23:59:59 + // ABSOLUTE : The specific date and time when the validity of a certificate will + // start or expire, expressed in seconds since the Unix Epoch. + // - Sample input value: 2524608000 + // - Output expiration date/time: 01/01/2050 00:00:00 + // DAYS , MONTHS , YEARS : The relative time from the moment of issuance until the + // certificate will expire, expressed in days, months, or years. Example if DAYS , + // issued on 10/12/2020 at 12:34:54 UTC: + // - Sample input value: 90 + // - Output expiration date: 01/10/2020 12:34:54 UTC + // The minimum validity duration for a certificate using relative time ( DAYS ) is + // one day. The minimum validity for a certificate using absolute time ( ABSOLUTE + // or END_DATE ) is one second. // // This member is required. Type ValidityPeriodType - // A long integer interpreted according to the value of Type, below. + // A long integer interpreted according to the value of Type , below. // // This member is required. Value *int64 diff --git a/service/alexaforbusiness/api_client.go b/service/alexaforbusiness/api_client.go index bb65eb53aa1..40d37e3f064 100644 --- a/service/alexaforbusiness/api_client.go +++ b/service/alexaforbusiness/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go b/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go index dd4c7c857b9..3e154c260ec 100644 --- a/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go +++ b/service/alexaforbusiness/api_op_ListBusinessReportSchedules.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the details of the schedules that a user configured. A download URL of the -// report associated with each schedule is returned every time this action is +// Lists the details of the schedules that a user configured. A download URL of +// the report associated with each schedule is returned every time this action is // called. A new download URL is returned each time, and is valid for 24 hours. func (c *Client) ListBusinessReportSchedules(ctx context.Context, params *ListBusinessReportSchedulesInput, optFns ...func(*Options)) (*ListBusinessReportSchedulesOutput, error) { if params == nil { diff --git a/service/alexaforbusiness/api_op_ListDeviceEvents.go b/service/alexaforbusiness/api_op_ListDeviceEvents.go index d4207332eea..dba51f714eb 100644 --- a/service/alexaforbusiness/api_op_ListDeviceEvents.go +++ b/service/alexaforbusiness/api_op_ListDeviceEvents.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the device event history, including device connection status, for up to 30 -// days. +// Lists the device event history, including device connection status, for up to +// 30 days. func (c *Client) ListDeviceEvents(ctx context.Context, params *ListDeviceEventsInput, optFns ...func(*Options)) (*ListDeviceEventsOutput, error) { if params == nil { params = &ListDeviceEventsInput{} diff --git a/service/alexaforbusiness/api_op_ListSkills.go b/service/alexaforbusiness/api_op_ListSkills.go index a101d1895d5..9a421097fb9 100644 --- a/service/alexaforbusiness/api_op_ListSkills.go +++ b/service/alexaforbusiness/api_op_ListSkills.go @@ -34,13 +34,13 @@ type ListSkillsInput struct { EnablementType types.EnablementTypeFilter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The ARN of the skill group for which to list enabled skills. @@ -136,8 +136,8 @@ var _ ListSkillsAPIClient = (*Client)(nil) // ListSkillsPaginatorOptions is the paginator options for ListSkills type ListSkillsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_ListTags.go b/service/alexaforbusiness/api_op_ListTags.go index 3d0b2101835..ff49b1a8ad4 100644 --- a/service/alexaforbusiness/api_op_ListTags.go +++ b/service/alexaforbusiness/api_op_ListTags.go @@ -36,13 +36,13 @@ type ListTagsInput struct { Arn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string noSmithyDocumentSerde @@ -135,8 +135,8 @@ var _ ListTagsAPIClient = (*Client)(nil) // ListTagsPaginatorOptions is the paginator options for ListTags type ListTagsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_PutConferencePreference.go b/service/alexaforbusiness/api_op_PutConferencePreference.go index 31b6f63c7f3..6e4eaf71d18 100644 --- a/service/alexaforbusiness/api_op_PutConferencePreference.go +++ b/service/alexaforbusiness/api_op_PutConferencePreference.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the conference preferences on a specific conference provider at the account -// level. +// Sets the conference preferences on a specific conference provider at the +// account level. func (c *Client) PutConferencePreference(ctx context.Context, params *PutConferencePreferenceInput, optFns ...func(*Options)) (*PutConferencePreferenceOutput, error) { if params == nil { params = &PutConferencePreferenceInput{} diff --git a/service/alexaforbusiness/api_op_PutSkillAuthorization.go b/service/alexaforbusiness/api_op_PutSkillAuthorization.go index ad634737b6f..b271bef7255 100644 --- a/service/alexaforbusiness/api_op_PutSkillAuthorization.go +++ b/service/alexaforbusiness/api_op_PutSkillAuthorization.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Links a user's account to a third-party skill provider. If this API operation is -// called by an assumed IAM role, the skill being linked must be a private skill. -// Also, the skill must be owned by the AWS account that assumed the IAM role. +// Links a user's account to a third-party skill provider. If this API operation +// is called by an assumed IAM role, the skill being linked must be a private +// skill. Also, the skill must be owned by the AWS account that assumed the IAM +// role. func (c *Client) PutSkillAuthorization(ctx context.Context, params *PutSkillAuthorizationInput, optFns ...func(*Options)) (*PutSkillAuthorizationOutput, error) { if params == nil { params = &PutSkillAuthorizationInput{} diff --git a/service/alexaforbusiness/api_op_ResolveRoom.go b/service/alexaforbusiness/api_op_ResolveRoom.go index eea118c6e45..f5271cc38b2 100644 --- a/service/alexaforbusiness/api_op_ResolveRoom.go +++ b/service/alexaforbusiness/api_op_ResolveRoom.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Determines the details for the room from which a skill request was invoked. This -// operation is used by skill developers. To query ResolveRoom from an Alexa skill, -// the skill ID needs to be authorized. When the skill is using an AWS Lambda -// function, the skill is automatically authorized when you publish your skill as a -// private skill to your AWS account. Skills that are hosted using a custom web -// service must be manually authorized. To get your skill authorized, contact AWS -// Support with your AWS account ID that queries the ResolveRoom API and skill ID. +// Determines the details for the room from which a skill request was invoked. +// This operation is used by skill developers. To query ResolveRoom from an Alexa +// skill, the skill ID needs to be authorized. When the skill is using an AWS +// Lambda function, the skill is automatically authorized when you publish your +// skill as a private skill to your AWS account. Skills that are hosted using a +// custom web service must be manually authorized. To get your skill authorized, +// contact AWS Support with your AWS account ID that queries the ResolveRoom API +// and skill ID. func (c *Client) ResolveRoom(ctx context.Context, params *ResolveRoomInput, optFns ...func(*Options)) (*ResolveRoomOutput, error) { if params == nil { params = &ResolveRoomInput{} diff --git a/service/alexaforbusiness/api_op_SearchDevices.go b/service/alexaforbusiness/api_op_SearchDevices.go index 8a2dbfabd33..592f74dfa36 100644 --- a/service/alexaforbusiness/api_op_SearchDevices.go +++ b/service/alexaforbusiness/api_op_SearchDevices.go @@ -30,20 +30,20 @@ func (c *Client) SearchDevices(ctx context.Context, params *SearchDevicesInput, type SearchDevicesInput struct { - // The filters to use to list a specified set of devices. Supported filter keys are - // DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, + // The filters to use to list a specified set of devices. Supported filter keys + // are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, // DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), // NetworkProfileName, NetworkProfileArn, Feature, and FailureCode. Filters []types.Filter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The sort order to use in listing the specified set of devices. Supported sort @@ -145,8 +145,8 @@ var _ SearchDevicesAPIClient = (*Client)(nil) // SearchDevicesPaginatorOptions is the paginator options for SearchDevices type SearchDevicesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_SearchProfiles.go b/service/alexaforbusiness/api_op_SearchProfiles.go index 79ed3cabeaf..6d9b9f1616a 100644 --- a/service/alexaforbusiness/api_op_SearchProfiles.go +++ b/service/alexaforbusiness/api_op_SearchProfiles.go @@ -35,13 +35,13 @@ type SearchProfilesInput struct { Filters []types.Filter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The sort order to use in listing the specified set of room profiles. Supported @@ -142,8 +142,8 @@ var _ SearchProfilesAPIClient = (*Client)(nil) // SearchProfilesPaginatorOptions is the paginator options for SearchProfiles type SearchProfilesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_SearchRooms.go b/service/alexaforbusiness/api_op_SearchRooms.go index b1d82714a71..26e304c846d 100644 --- a/service/alexaforbusiness/api_op_SearchRooms.go +++ b/service/alexaforbusiness/api_op_SearchRooms.go @@ -35,13 +35,13 @@ type SearchRoomsInput struct { Filters []types.Filter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The sort order to use in listing the specified set of rooms. The supported sort @@ -141,8 +141,8 @@ var _ SearchRoomsAPIClient = (*Client)(nil) // SearchRoomsPaginatorOptions is the paginator options for SearchRooms type SearchRoomsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_SearchSkillGroups.go b/service/alexaforbusiness/api_op_SearchSkillGroups.go index 7838ab5b6ae..0c2e5891440 100644 --- a/service/alexaforbusiness/api_op_SearchSkillGroups.go +++ b/service/alexaforbusiness/api_op_SearchSkillGroups.go @@ -31,19 +31,19 @@ func (c *Client) SearchSkillGroups(ctx context.Context, params *SearchSkillGroup type SearchSkillGroupsInput struct { - // The filters to use to list a specified set of skill groups. The supported filter - // key is SkillGroupName. + // The filters to use to list a specified set of skill groups. The supported + // filter key is SkillGroupName. Filters []types.Filter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. - // Required. + // includes only results beyond the token, up to the value specified by MaxResults + // . Required. NextToken *string // The sort order to use in listing the specified set of skill groups. The @@ -144,8 +144,8 @@ var _ SearchSkillGroupsAPIClient = (*Client)(nil) // SearchSkillGroupsPaginatorOptions is the paginator options for SearchSkillGroups type SearchSkillGroupsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_SearchUsers.go b/service/alexaforbusiness/api_op_SearchUsers.go index 3872e22d9b4..6a7843972ca 100644 --- a/service/alexaforbusiness/api_op_SearchUsers.go +++ b/service/alexaforbusiness/api_op_SearchUsers.go @@ -35,14 +35,14 @@ type SearchUsersInput struct { Filters []types.Filter // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. Required. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Required. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. - // Required. + // includes only results beyond the token, up to the value specified by MaxResults + // . Required. NextToken *string // The sort order to use in listing the filtered set of users. Required. Supported @@ -142,8 +142,8 @@ var _ SearchUsersAPIClient = (*Client)(nil) // SearchUsersPaginatorOptions is the paginator options for SearchUsers type SearchUsersPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. Required. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Required. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/alexaforbusiness/api_op_StartDeviceSync.go b/service/alexaforbusiness/api_op_StartDeviceSync.go index 3b2be2c2f8b..114447010f4 100644 --- a/service/alexaforbusiness/api_op_StartDeviceSync.go +++ b/service/alexaforbusiness/api_op_StartDeviceSync.go @@ -13,23 +13,14 @@ import ( // Resets a device and its account to the known default settings. This clears all // information and settings set by previous users in the following ways: -// -// * -// Bluetooth - This unpairs all bluetooth devices paired with your echo device. -// -// * -// Volume - This resets the echo device's volume to the default value. -// -// * -// Notifications - This clears all notifications from your echo device. -// -// * Lists - -// This clears all to-do items from your echo device. -// -// * Settings - This internally -// syncs the room's profile (if the device is assigned to a room), contacts, -// address books, delegation access for account linking, and communications (if -// enabled on the room profile). +// - Bluetooth - This unpairs all bluetooth devices paired with your echo +// device. +// - Volume - This resets the echo device's volume to the default value. +// - Notifications - This clears all notifications from your echo device. +// - Lists - This clears all to-do items from your echo device. +// - Settings - This internally syncs the room's profile (if the device is +// assigned to a room), contacts, address books, delegation access for account +// linking, and communications (if enabled on the room profile). func (c *Client) StartDeviceSync(ctx context.Context, params *StartDeviceSyncInput, optFns ...func(*Options)) (*StartDeviceSyncOutput, error) { if params == nil { params = &StartDeviceSyncInput{} diff --git a/service/alexaforbusiness/api_op_UpdateContact.go b/service/alexaforbusiness/api_op_UpdateContact.go index 07066f52165..7ae11e0e066 100644 --- a/service/alexaforbusiness/api_op_UpdateContact.go +++ b/service/alexaforbusiness/api_op_UpdateContact.go @@ -43,9 +43,10 @@ type UpdateContactInput struct { // The updated last name of the contact. LastName *string - // The updated phone number of the contact. The phone number type defaults to WORK. - // You can either specify PhoneNumber or PhoneNumbers. We recommend that you use - // PhoneNumbers, which lets you specify the phone number type and multiple numbers. + // The updated phone number of the contact. The phone number type defaults to + // WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you + // use PhoneNumbers, which lets you specify the phone number type and multiple + // numbers. PhoneNumber *string // The list of phone numbers for the contact. diff --git a/service/alexaforbusiness/types/enums.go b/service/alexaforbusiness/types/enums.go index eaaa4ec5818..0bfda4060cd 100644 --- a/service/alexaforbusiness/types/enums.go +++ b/service/alexaforbusiness/types/enums.go @@ -181,9 +181,9 @@ const ( DeviceStatusFailed DeviceStatus = "FAILED" ) -// Values returns all known values for DeviceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeviceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DeviceStatus) Values() []DeviceStatus { return []DeviceStatus{ "READY", @@ -266,9 +266,9 @@ const ( DistanceUnitImperial DistanceUnit = "IMPERIAL" ) -// Values returns all known values for DistanceUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DistanceUnit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DistanceUnit) Values() []DistanceUnit { return []DistanceUnit{ "METRIC", @@ -322,9 +322,9 @@ const ( EndOfMeetingReminderTypeKnock EndOfMeetingReminderType = "KNOCK" ) -// Values returns all known values for EndOfMeetingReminderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndOfMeetingReminderType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EndOfMeetingReminderType) Values() []EndOfMeetingReminderType { return []EndOfMeetingReminderType{ "ANNOUNCEMENT_TIME_CHECK", @@ -508,9 +508,9 @@ const ( SkillTypePrivate SkillType = "PRIVATE" ) -// Values returns all known values for SkillType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SkillType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SkillType) Values() []SkillType { return []SkillType{ "PUBLIC", @@ -546,9 +546,9 @@ const ( SortValueDesc SortValue = "DESC" ) -// Values returns all known values for SortValue. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortValue. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortValue) Values() []SortValue { return []SortValue{ "ASC", diff --git a/service/alexaforbusiness/types/types.go b/service/alexaforbusiness/types/types.go index 3aa1222ad5b..fa2a7060dfc 100644 --- a/service/alexaforbusiness/types/types.go +++ b/service/alexaforbusiness/types/types.go @@ -41,7 +41,7 @@ type AddressBookData struct { // supported format is MP3. To convert your MP3 audio files to an Alexa-friendly, // required codec version (MPEG version 2) and bit rate (48 kbps), you might use // converter software. One option for this is a command-line tool, FFmpeg. For more -// information, see FFmpeg (https://www.ffmpeg.org/). The following command +// information, see FFmpeg (https://www.ffmpeg.org/) . The following command // converts the provided to an MP3 file that is played in the announcement: ffmpeg // -i -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 type Audio struct { @@ -52,9 +52,9 @@ type Audio struct { Locale Locale // The location of the audio file. Currently, S3 URLs are supported. Only S3 - // locations comprised of safe characters are valid. For more information, see Safe - // Characters - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters). + // locations comprised of safe characters are valid. For more information, see + // Safe Characters (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters) + // . // // This member is required. Location *string @@ -211,8 +211,8 @@ type Contact struct { // The last name of the contact, used to call the contact on the device. LastName *string - // The phone number of the contact. The phone number type defaults to WORK. You can - // either specify PhoneNumber or PhoneNumbers. We recommend that you use + // The phone number of the contact. The phone number type defaults to WORK. You + // can either specify PhoneNumber or PhoneNumbers. We recommend that you use // PhoneNumbers, which lets you specify the phone number type and multiple numbers. PhoneNumber *string @@ -240,8 +240,8 @@ type ContactData struct { // The last name of the contact, used to call the contact on the device. LastName *string - // The phone number of the contact. The phone number type defaults to WORK. You can - // specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, + // The phone number of the contact. The phone number type defaults to WORK. You + // can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, // which lets you specify the phone number type and multiple numbers. PhoneNumber *string @@ -298,8 +298,8 @@ type CreateEndOfMeetingReminder struct { // the room for the configured duration if the room is available. type CreateInstantBooking struct { - // Duration between 15 and 240 minutes at increments of 15 that determines how long - // to book an available room when a meeting is started with Alexa. + // Duration between 15 and 240 minutes at increments of 15 that determines how + // long to book an available room when a meeting is started with Alexa. // // This member is required. DurationInMinutes *int32 @@ -625,8 +625,8 @@ type GatewaySummary struct { // for the configured duration if the room is available. type InstantBooking struct { - // Duration between 15 and 240 minutes at increments of 15 that determines how long - // to book an available room when a meeting is started with Alexa. + // Duration between 15 and 240 minutes at increments of 15 that determines how + // long to book an available room when a meeting is started with Alexa. DurationInMinutes *int32 // Whether instant booking is enabled or not. @@ -677,15 +677,10 @@ type MeetingRoomConfiguration struct { // The values that indicate whether a pin is always required (YES), never required // (NO), or OPTIONAL. -// -// * If YES, Alexa will always ask for a meeting pin. -// -// * If NO, -// Alexa will never ask for a meeting pin. -// -// * If OPTIONAL, Alexa will ask if you -// have a meeting pin and if the customer responds with yes, it will ask for the -// meeting pin. +// - If YES, Alexa will always ask for a meeting pin. +// - If NO, Alexa will never ask for a meeting pin. +// - If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer +// responds with yes, it will ask for the meeting pin. type MeetingSetting struct { // The values that indicate whether the pin is always required. @@ -1091,8 +1086,8 @@ type SkillsStoreSkill struct { // The summary of skills. type SkillSummary struct { - // Whether the skill is enabled under the user's account, or if it requires linking - // to be used. + // Whether the skill is enabled under the user's account, or if it requires + // linking to be used. EnablementType EnablementType // The ARN of the skill summary. @@ -1110,8 +1105,8 @@ type SkillSummary struct { noSmithyDocumentSerde } -// A smart home appliance that can connect to a central system. Any domestic device -// can be a smart appliance. +// A smart home appliance that can connect to a central system. Any domestic +// device can be a smart appliance. type SmartHomeAppliance struct { // The description of the smart home appliance. @@ -1142,8 +1137,8 @@ type Sort struct { noSmithyDocumentSerde } -// The SSML message. For more information, see SSML Reference -// (https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html). +// The SSML message. For more information, see SSML Reference (https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html) +// . type Ssml struct { // The locale of the SSML message. Currently, en-US is supported. @@ -1216,8 +1211,8 @@ type UpdateEndOfMeetingReminder struct { // it is free when a user joins a meeting with Alexa. type UpdateInstantBooking struct { - // Duration between 15 and 240 minutes at increments of 15 that determines how long - // to book an available room when a meeting is started with Alexa. + // Duration between 15 and 240 minutes at increments of 15 that determines how + // long to book an available room when a meeting is started with Alexa. DurationInMinutes *int32 // Whether instant booking is enabled or not. diff --git a/service/amp/api_client.go b/service/amp/api_client.go index 6c8ebcec886..c2b1e1b4b97 100644 --- a/service/amp/api_client.go +++ b/service/amp/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/amp/api_op_DescribeWorkspace.go b/service/amp/api_op_DescribeWorkspace.go index 3d248b6942e..8a953019005 100644 --- a/service/amp/api_op_DescribeWorkspace.go +++ b/service/amp/api_op_DescribeWorkspace.go @@ -142,9 +142,9 @@ type WorkspaceActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, WorkspaceActiveWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, WorkspaceActiveWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -184,9 +184,9 @@ func NewWorkspaceActiveWaiter(client DescribeWorkspaceAPIClient, optFns ...func( } } -// Wait calls the waiter function for WorkspaceActive waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for WorkspaceActive waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *WorkspaceActiveWaiter) Wait(ctx context.Context, params *DescribeWorkspaceInput, maxWaitDur time.Duration, optFns ...func(*WorkspaceActiveWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -336,9 +336,9 @@ type WorkspaceDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, WorkspaceDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, WorkspaceDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/amp/api_op_ListWorkspaces.go b/service/amp/api_op_ListWorkspaces.go index b67256f0d65..f40f658150b 100644 --- a/service/amp/api_op_ListWorkspaces.go +++ b/service/amp/api_op_ListWorkspaces.go @@ -31,8 +31,8 @@ func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesInput // Represents the input of a ListWorkspaces operation. type ListWorkspacesInput struct { - // Optional filter for workspace alias. Only the workspaces with aliases that begin - // with this value will be returned. + // Optional filter for workspace alias. Only the workspaces with aliases that + // begin with this value will be returned. Alias *string // Maximum results to return in response (default=100, maximum=1000). diff --git a/service/amplify/api_client.go b/service/amplify/api_client.go index 195d622663e..7f02d8c8e95 100644 --- a/service/amplify/api_client.go +++ b/service/amplify/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/amplify/api_op_CreateApp.go b/service/amplify/api_op_CreateApp.go index 51aae1f8e4c..8b03b00f99a 100644 --- a/service/amplify/api_op_CreateApp.go +++ b/service/amplify/api_op_CreateApp.go @@ -39,12 +39,11 @@ type CreateAppInput struct { // personal access token is used to authorize access to a GitHub repository using // the Amplify GitHub App. The token is not stored. Use accessToken for GitHub // repositories only. To authorize access to a repository provider such as - // Bitbucket or CodeCommit, use oauthToken. You must specify either accessToken or - // oauthToken when you create a new app. Existing Amplify apps deployed from a + // Bitbucket or CodeCommit, use oauthToken . You must specify either accessToken + // or oauthToken when you create a new app. Existing Amplify apps deployed from a // GitHub repository using OAuth continue to work with CI/CD. However, we strongly // recommend that you migrate these apps to use the GitHub App. For more - // information, see Migrating an existing OAuth app to the Amplify GitHub App - // (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // information, see Migrating an existing OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) // in the Amplify User Guide . AccessToken *string @@ -56,7 +55,7 @@ type CreateAppInput struct { // The credentials for basic authorization for an Amplify app. You must // base64-encode the authorization credentials and provide them in the format - // user:password. + // user:password . BasicAuthCredentials *string // The build specification (build spec) for an Amplify app. @@ -95,20 +94,19 @@ type CreateAppInput struct { // OAuth token is used to create a webhook and a read-only deploy key using SSH // cloning. The OAuth token is not stored. Use oauthToken for repository providers // other than GitHub, such as Bitbucket or CodeCommit. To authorize access to - // GitHub as your repository provider, use accessToken. You must specify either + // GitHub as your repository provider, use accessToken . You must specify either // oauthToken or accessToken when you create a new app. Existing Amplify apps // deployed from a GitHub repository using OAuth continue to work with CI/CD. // However, we strongly recommend that you migrate these apps to use the GitHub // App. For more information, see Migrating an existing OAuth app to the Amplify - // GitHub App - // (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) // in the Amplify User Guide . OauthToken *string - // The platform for the Amplify app. For a static app, set the platform type to - // WEB. For a dynamic server-side rendered (SSR) app, set the platform type to - // WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, - // set the platform type to WEB_DYNAMIC. + // The platform for the Amplify app. For a static app, set the platform type to WEB + // . For a dynamic server-side rendered (SSR) app, set the platform type to + // WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, + // set the platform type to WEB_DYNAMIC . Platform types.Platform // The repository for an Amplify app. diff --git a/service/amplify/api_op_CreateBranch.go b/service/amplify/api_op_CreateBranch.go index e3539c97653..3f21dde3a24 100644 --- a/service/amplify/api_op_CreateBranch.go +++ b/service/amplify/api_op_CreateBranch.go @@ -45,7 +45,7 @@ type CreateBranchInput struct { BackendEnvironmentArn *string // The basic authorization credentials for the branch. You must base64-encode the - // authorization credentials and provide them in the format user:password. + // authorization credentials and provide them in the format user:password . BasicAuthCredentials *string // The build specification (build spec) for the branch. diff --git a/service/amplify/api_op_CreateDeployment.go b/service/amplify/api_op_CreateDeployment.go index 9cac5c77cd4..8f3c003cba2 100644 --- a/service/amplify/api_op_CreateDeployment.go +++ b/service/amplify/api_op_CreateDeployment.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a deployment for a manually deployed Amplify app. Manually deployed apps -// are not connected to a repository. +// Creates a deployment for a manually deployed Amplify app. Manually deployed +// apps are not connected to a repository. func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { params = &CreateDeploymentInput{} @@ -40,10 +40,10 @@ type CreateDeploymentInput struct { // This member is required. BranchName *string - // An optional file map that contains the file name as the key and the file content - // md5 hash as the value. If this argument is provided, the service will generate a - // unique upload URL per file. Otherwise, the service will only generate a single - // upload URL for the zipped files. + // An optional file map that contains the file name as the key and the file + // content md5 hash as the value. If this argument is provided, the service will + // generate a unique upload URL per file. Otherwise, the service will only generate + // a single upload URL for the zipped files. FileMap map[string]string noSmithyDocumentSerde diff --git a/service/amplify/api_op_ListArtifacts.go b/service/amplify/api_op_ListArtifacts.go index 794b4693ee7..d2fdffe4e5a 100644 --- a/service/amplify/api_op_ListArtifacts.go +++ b/service/amplify/api_op_ListArtifacts.go @@ -64,8 +64,8 @@ type ListArtifactsOutput struct { // This member is required. Artifacts []types.Artifact - // A pagination token. If a non-null pagination token is returned in a result, pass - // its value in another request to retrieve more entries. + // A pagination token. If a non-null pagination token is returned in a result, + // pass its value in another request to retrieve more entries. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/amplify/api_op_ListBackendEnvironments.go b/service/amplify/api_op_ListBackendEnvironments.go index 46fc7a0d1a9..a6268ceea82 100644 --- a/service/amplify/api_op_ListBackendEnvironments.go +++ b/service/amplify/api_op_ListBackendEnvironments.go @@ -57,8 +57,8 @@ type ListBackendEnvironmentsOutput struct { // This member is required. BackendEnvironments []types.BackendEnvironment - // A pagination token. If a non-null pagination token is returned in a result, pass - // its value in another request to retrieve more entries. + // A pagination token. If a non-null pagination token is returned in a result, + // pass its value in another request to retrieve more entries. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/amplify/api_op_ListBranches.go b/service/amplify/api_op_ListBranches.go index c4050d2ea1c..bdf4253903d 100644 --- a/service/amplify/api_op_ListBranches.go +++ b/service/amplify/api_op_ListBranches.go @@ -54,8 +54,8 @@ type ListBranchesOutput struct { // This member is required. Branches []types.Branch - // A pagination token. If a non-null pagination token is returned in a result, pass - // its value in another request to retrieve more entries. + // A pagination token. If a non-null pagination token is returned in a result, + // pass its value in another request to retrieve more entries. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/amplify/api_op_StartJob.go b/service/amplify/api_op_StartJob.go index f4fab8d8cf7..37ea6196176 100644 --- a/service/amplify/api_op_StartJob.go +++ b/service/amplify/api_op_StartJob.go @@ -44,7 +44,7 @@ type StartJobInput struct { // Describes the type for the job. The job type RELEASE starts a new job with the // latest change from the specified branch. This value is available only for apps // that are connected to a repository. The job type RETRY retries an existing job. - // If the job type value is RETRY, the jobId is also required. + // If the job type value is RETRY , the jobId is also required. // // This member is required. JobType types.JobType @@ -59,7 +59,7 @@ type StartJobInput struct { CommitTime *time.Time // The unique ID for an existing job. This is required if the value of jobType is - // RETRY. + // RETRY . JobId *string // A descriptive reason for starting this job. diff --git a/service/amplify/api_op_UpdateApp.go b/service/amplify/api_op_UpdateApp.go index 7fc405cdbb9..8e9ae3f44b0 100644 --- a/service/amplify/api_op_UpdateApp.go +++ b/service/amplify/api_op_UpdateApp.go @@ -39,12 +39,11 @@ type UpdateAppInput struct { // personal access token is used to authorize access to a GitHub repository using // the Amplify GitHub App. The token is not stored. Use accessToken for GitHub // repositories only. To authorize access to a repository provider such as - // Bitbucket or CodeCommit, use oauthToken. You must specify either accessToken or - // oauthToken when you update an app. Existing Amplify apps deployed from a GitHub - // repository using OAuth continue to work with CI/CD. However, we strongly + // Bitbucket or CodeCommit, use oauthToken . You must specify either accessToken + // or oauthToken when you update an app. Existing Amplify apps deployed from a + // GitHub repository using OAuth continue to work with CI/CD. However, we strongly // recommend that you migrate these apps to use the GitHub App. For more - // information, see Migrating an existing OAuth app to the Amplify GitHub App - // (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // information, see Migrating an existing OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) // in the Amplify User Guide . AccessToken *string @@ -55,7 +54,7 @@ type UpdateAppInput struct { AutoBranchCreationPatterns []string // The basic authorization credentials for an Amplify app. You must base64-encode - // the authorization credentials and provide them in the format user:password. + // the authorization credentials and provide them in the format user:password . BasicAuthCredentials *string // The build specification (build spec) for an Amplify app. @@ -96,19 +95,19 @@ type UpdateAppInput struct { // OAuth token is used to create a webhook and a read-only deploy key using SSH // cloning. The OAuth token is not stored. Use oauthToken for repository providers // other than GitHub, such as Bitbucket or CodeCommit. To authorize access to - // GitHub as your repository provider, use accessToken. You must specify either - // oauthToken or accessToken when you update an app. Existing Amplify apps deployed - // from a GitHub repository using OAuth continue to work with CI/CD. However, we - // strongly recommend that you migrate these apps to use the GitHub App. For more - // information, see Migrating an existing OAuth app to the Amplify GitHub App - // (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // GitHub as your repository provider, use accessToken . You must specify either + // oauthToken or accessToken when you update an app. Existing Amplify apps + // deployed from a GitHub repository using OAuth continue to work with CI/CD. + // However, we strongly recommend that you migrate these apps to use the GitHub + // App. For more information, see Migrating an existing OAuth app to the Amplify + // GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) // in the Amplify User Guide . OauthToken *string - // The platform for the Amplify app. For a static app, set the platform type to - // WEB. For a dynamic server-side rendered (SSR) app, set the platform type to - // WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, - // set the platform type to WEB_DYNAMIC. + // The platform for the Amplify app. For a static app, set the platform type to WEB + // . For a dynamic server-side rendered (SSR) app, set the platform type to + // WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, + // set the platform type to WEB_DYNAMIC . Platform types.Platform // The name of the repository for an Amplify app diff --git a/service/amplify/api_op_UpdateBranch.go b/service/amplify/api_op_UpdateBranch.go index 32f4ef44a31..92694814e6e 100644 --- a/service/amplify/api_op_UpdateBranch.go +++ b/service/amplify/api_op_UpdateBranch.go @@ -45,7 +45,7 @@ type UpdateBranchInput struct { BackendEnvironmentArn *string // The basic authorization credentials for the branch. You must base64-encode the - // authorization credentials and provide them in the format user:password. + // authorization credentials and provide them in the format user:password . BasicAuthCredentials *string // The build specification (build spec) for the branch. diff --git a/service/amplify/api_op_UpdateDomainAssociation.go b/service/amplify/api_op_UpdateDomainAssociation.go index 910bf65bcd3..0f4f978dd57 100644 --- a/service/amplify/api_op_UpdateDomainAssociation.go +++ b/service/amplify/api_op_UpdateDomainAssociation.go @@ -59,8 +59,8 @@ type UpdateDomainAssociationInput struct { // The result structure for the update domain association request. type UpdateDomainAssociationOutput struct { - // Describes a domain association, which associates a custom domain with an Amplify - // app. + // Describes a domain association, which associates a custom domain with an + // Amplify app. // // This member is required. DomainAssociation *types.DomainAssociation diff --git a/service/amplify/doc.go b/service/amplify/doc.go index 85a47e5f0d9..c80ef1b1d34 100644 --- a/service/amplify/doc.go +++ b/service/amplify/doc.go @@ -1,13 +1,12 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package amplify provides the API client, operations, and parameter types for AWS -// Amplify. +// Package amplify provides the API client, operations, and parameter types for +// AWS Amplify. // // Amplify enables developers to develop and deploy cloud-powered mobile and web // apps. The Amplify Console provides a continuous delivery and hosting service for -// web applications. For more information, see the Amplify Console User Guide -// (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). The Amplify -// Framework is a comprehensive set of SDKs, libraries, tools, and documentation -// for client app development. For more information, see the Amplify Framework. -// (https://docs.amplify.aws/) +// web applications. For more information, see the Amplify Console User Guide (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html) +// . The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and +// documentation for client app development. For more information, see the Amplify +// Framework. (https://docs.amplify.aws/) package amplify diff --git a/service/amplify/types/enums.go b/service/amplify/types/enums.go index 59dbb9dbbb9..97f08744a89 100644 --- a/service/amplify/types/enums.go +++ b/service/amplify/types/enums.go @@ -16,9 +16,9 @@ const ( DomainStatusUpdating DomainStatus = "UPDATING" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "PENDING_VERIFICATION", @@ -45,9 +45,9 @@ const ( JobStatusCancelled JobStatus = "CANCELLED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "PENDING", @@ -111,8 +111,8 @@ const ( RepositoryCloneMethodSigv4 RepositoryCloneMethod = "SIGV4" ) -// Values returns all known values for RepositoryCloneMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RepositoryCloneMethod. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RepositoryCloneMethod) Values() []RepositoryCloneMethod { return []RepositoryCloneMethod{ @@ -133,8 +133,8 @@ const ( StagePullRequest Stage = "PULL_REQUEST" ) -// Values returns all known values for Stage. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Stage. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Stage) Values() []Stage { return []Stage{ diff --git a/service/amplify/types/types.go b/service/amplify/types/types.go index 6c2781bdec7..f1083a85141 100644 --- a/service/amplify/types/types.go +++ b/service/amplify/types/types.go @@ -56,10 +56,10 @@ type App struct { // This member is required. Name *string - // The platform for the Amplify app. For a static app, set the platform type to - // WEB. For a dynamic server-side rendered (SSR) app, set the platform type to - // WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, - // set the platform type to WEB_DYNAMIC. + // The platform for the Amplify app. For a static app, set the platform type to WEB + // . For a dynamic server-side rendered (SSR) app, set the platform type to + // WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, + // set the platform type to WEB_DYNAMIC . // // This member is required. Platform Platform @@ -82,7 +82,7 @@ type App struct { // The basic authorization credentials for branches for the Amplify app. You must // base64-encode the authorization credentials and provide them in the format - // user:password. + // user:password . BasicAuthCredentials *string // Describes the content of the build specification (build spec) for the Amplify @@ -109,9 +109,9 @@ type App struct { // Describes the information about a production branch of the Amplify app. ProductionBranch *ProductionBranch - // This is for internal use. The Amplify service uses this parameter to specify the - // authentication protocol to use to access the Git repository for an Amplify app. - // Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web + // This is for internal use. The Amplify service uses this parameter to specify + // the authentication protocol to use to access the Git repository for an Amplify + // app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web // Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories. RepositoryCloneMethod RepositoryCloneMethod @@ -142,7 +142,7 @@ type AutoBranchCreationConfig struct { // The basic authorization credentials for the autocreated branch. You must // base64-encode the authorization credentials and provide them in the format - // user:password. + // user:password . BasicAuthCredentials *string // The build specification (build spec) for the autocreated branch. @@ -310,7 +310,7 @@ type Branch struct { // The basic authorization credentials for a branch of an Amplify app. You must // base64-encode the authorization credentials and provide them in the format - // user:password. + // user:password . BasicAuthCredentials *string // The build specification (build spec) content for the branch of an Amplify app. @@ -356,11 +356,11 @@ type CustomRule struct { // The condition for a URL rewrite or redirect rule, such as a country code. Condition *string - // The status code for a URL rewrite or redirect rule. 200 Represents a 200 rewrite - // rule. 301 Represents a 301 (moved pemanently) redirect rule. This and all future - // requests should be directed to the target URL. 302 Represents a 302 temporary - // redirect rule. 404 Represents a 404 redirect rule. 404-200 Represents a 404 - // rewrite rule. + // The status code for a URL rewrite or redirect rule. 200 Represents a 200 + // rewrite rule. 301 Represents a 301 (moved pemanently) redirect rule. This and + // all future requests should be directed to the target URL. 302 Represents a 302 + // temporary redirect rule. 404 Represents a 404 redirect rule. 404-200 Represents + // a 404 rewrite rule. Status *string noSmithyDocumentSerde @@ -457,9 +457,9 @@ type JobSummary struct { // This member is required. JobId *string - // The type for the job. If the value is RELEASE, the job was manually released - // from its source by using the StartJob API. If the value is RETRY, the job was - // manually retried using the StartJob API. If the value is WEB_HOOK, the job was + // The type for the job. If the value is RELEASE , the job was manually released + // from its source by using the StartJob API. If the value is RETRY , the job was + // manually retried using the StartJob API. If the value is WEB_HOOK , the job was // automatically triggered by webhooks. // // This member is required. diff --git a/service/amplifybackend/api_client.go b/service/amplifybackend/api_client.go index e2b97c91198..8f66b75bf55 100644 --- a/service/amplifybackend/api_client.go +++ b/service/amplifybackend/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/amplifybackend/types/enums.go b/service/amplifybackend/types/enums.go index 9fa69d21fb2..e1c606e2966 100644 --- a/service/amplifybackend/types/enums.go +++ b/service/amplifybackend/types/enums.go @@ -12,9 +12,10 @@ const ( AdditionalConstraintsElementRequireUppercase AdditionalConstraintsElement = "REQUIRE_UPPERCASE" ) -// Values returns all known values for AdditionalConstraintsElement. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AdditionalConstraintsElement. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AdditionalConstraintsElement) Values() []AdditionalConstraintsElement { return []AdditionalConstraintsElement{ "REQUIRE_DIGIT", @@ -295,9 +296,9 @@ const ( SignInMethodUsername SignInMethod = "USERNAME" ) -// Values returns all known values for SignInMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SignInMethod. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SignInMethod) Values() []SignInMethod { return []SignInMethod{ "EMAIL", diff --git a/service/amplifybackend/types/types.go b/service/amplifybackend/types/types.go index 3ade25fd97c..7d36b05aeba 100644 --- a/service/amplifybackend/types/types.go +++ b/service/amplifybackend/types/types.go @@ -10,8 +10,8 @@ import ( // Amplify project. type BackendAPIAppSyncAuthSettings struct { - // The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication - // setting to access your data models. + // The Amazon Cognito user pool ID, if Amazon Cognito was used as an + // authentication setting to access your data models. CognitoUserPoolId *string // The API key description for API_KEY, if it was used as an authentication @@ -32,8 +32,8 @@ type BackendAPIAppSyncAuthSettings struct { // The expiry time for the OpenID authentication mechanism. OpenIDIatTTL *string - // The openID issuer URL, if openID was used as an authentication setting to access - // your data models. + // The openID issuer URL, if openID was used as an authentication setting to + // access your data models. OpenIDIssueURL *string // The OpenID provider name, if OpenID was used as an authentication mechanism to @@ -188,12 +188,12 @@ type CreateBackendAuthForgotPasswordConfig struct { // This member is required. DeliveryMethod DeliveryMethod - // (DEPRECATED) The configuration for the email sent when an app user forgets their - // password. + // (DEPRECATED) The configuration for the email sent when an app user forgets + // their password. EmailSettings *EmailSettings - // (DEPRECATED) The configuration for the SMS message sent when an app user forgets - // their password. + // (DEPRECATED) The configuration for the SMS message sent when an app user + // forgets their password. SmsSettings *SmsSettings noSmithyDocumentSerde @@ -288,8 +288,8 @@ type CreateBackendAuthPasswordPolicyConfig struct { // Amplify project. type CreateBackendAuthResourceConfig struct { - // Defines whether you want to configure only authentication or both authentication - // and authorization settings. + // Defines whether you want to configure only authentication or both + // authentication and authorization settings. // // This member is required. AuthResources AuthResources @@ -313,8 +313,8 @@ type CreateBackendAuthResourceConfig struct { noSmithyDocumentSerde } -// Describes the Amazon Cognito user pool configuration for the auth resource to be -// configured for your Amplify project. +// Describes the Amazon Cognito user pool configuration for the auth resource to +// be configured for your Amplify project. type CreateBackendAuthUserPoolConfig struct { // The required attributes to sign up new users in the user pool. @@ -345,8 +345,8 @@ type CreateBackendAuthUserPoolConfig struct { // configured as a part of your Amplify project. OAuth *CreateBackendAuthOAuthConfig - // Describes the password policy for your Amazon Cognito user pool, configured as a - // part of your Amplify project. + // Describes the password policy for your Amazon Cognito user pool, configured as + // a part of your Amplify project. PasswordPolicy *CreateBackendAuthPasswordPolicyConfig // Describes the email or SMS verification message for your Amazon Cognito user @@ -515,12 +515,12 @@ type UpdateBackendAuthForgotPasswordConfig struct { // messages to app users that want to recover their password. DeliveryMethod DeliveryMethod - // (DEPRECATED) The configuration for the email sent when an app user forgets their - // password. + // (DEPRECATED) The configuration for the email sent when an app user forgets + // their password. EmailSettings *EmailSettings - // (DEPRECATED) The configuration for the SMS message sent when an Amplify app user - // forgets their password. + // (DEPRECATED) The configuration for the SMS message sent when an Amplify app + // user forgets their password. SmsSettings *SmsSettings noSmithyDocumentSerde @@ -580,8 +580,8 @@ type UpdateBackendAuthOAuthConfig struct { // part of your Amplify project. type UpdateBackendAuthPasswordPolicyConfig struct { - // Describes additional constraints on password requirements to sign in to the auth - // resource, configured as a part of your Amplify project. + // Describes additional constraints on password requirements to sign in to the + // auth resource, configured as a part of your Amplify project. AdditionalConstraints []AdditionalConstraintsElement // Describes the minimum length of the password required to sign in to the auth @@ -636,8 +636,8 @@ type UpdateBackendAuthUserPoolConfig struct { // configured as a part of your Amplify project. OAuth *UpdateBackendAuthOAuthConfig - // Describes the password policy for your Amazon Cognito user pool, configured as a - // part of your Amplify project. + // Describes the password policy for your Amazon Cognito user pool, configured as + // a part of your Amplify project. PasswordPolicy *UpdateBackendAuthPasswordPolicyConfig // Describes the email or SMS verification message for your Amazon Cognito user diff --git a/service/amplifyuibuilder/api_client.go b/service/amplifyuibuilder/api_client.go index cbf0e7062b0..c05603c3583 100644 --- a/service/amplifyuibuilder/api_client.go +++ b/service/amplifyuibuilder/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go b/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go index db1c0e0d46f..cc4c111c447 100644 --- a/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go +++ b/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go @@ -29,7 +29,7 @@ func (c *Client) ExchangeCodeForToken(ctx context.Context, params *ExchangeCodeF type ExchangeCodeForTokenInput struct { - // The third-party provider for the token. The only valid value is figma. + // The third-party provider for the token. The only valid value is figma . // // This member is required. Provider types.TokenProviders diff --git a/service/amplifyuibuilder/api_op_RefreshToken.go b/service/amplifyuibuilder/api_op_RefreshToken.go index 330020dcbb0..6298d6bb922 100644 --- a/service/amplifyuibuilder/api_op_RefreshToken.go +++ b/service/amplifyuibuilder/api_op_RefreshToken.go @@ -29,7 +29,7 @@ func (c *Client) RefreshToken(ctx context.Context, params *RefreshTokenInput, op type RefreshTokenInput struct { - // The third-party provider for the token. The only valid value is figma. + // The third-party provider for the token. The only valid value is figma . // // This member is required. Provider types.TokenProviders diff --git a/service/amplifyuibuilder/doc.go b/service/amplifyuibuilder/doc.go index eac1809378f..2e6a010087d 100644 --- a/service/amplifyuibuilder/doc.go +++ b/service/amplifyuibuilder/doc.go @@ -8,11 +8,11 @@ // Amplify applications. You can then connect these UI components to an // application's backend Amazon Web Services resources. You can also use the // Amplify Studio visual designer to create UI components and model data for an -// app. For more information, see Introduction -// (https://docs.amplify.aws/console/adminui/intro) in the Amplify Docs. The -// Amplify Framework is a comprehensive set of SDKs, libraries, tools, and -// documentation for client app development. For more information, see the Amplify -// Framework (https://docs.amplify.aws/). For more information about deploying an -// Amplify application to Amazon Web Services, see the Amplify User Guide -// (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). +// app. For more information, see Introduction (https://docs.amplify.aws/console/adminui/intro) +// in the Amplify Docs. The Amplify Framework is a comprehensive set of SDKs, +// libraries, tools, and documentation for client app development. For more +// information, see the Amplify Framework (https://docs.amplify.aws/) . For more +// information about deploying an Amplify application to Amazon Web Services, see +// the Amplify User Guide (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html) +// . package amplifyuibuilder diff --git a/service/amplifyuibuilder/types/errors.go b/service/amplifyuibuilder/types/errors.go index c4abb511819..60df53d4a6c 100644 --- a/service/amplifyuibuilder/types/errors.go +++ b/service/amplifyuibuilder/types/errors.go @@ -111,8 +111,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You exceeded your service quota. Service quotas, also referred to as limits, are -// the maximum number of service resources or operations for your Amazon Web +// You exceeded your service quota. Service quotas, also referred to as limits, +// are the maximum number of service resources or operations for your Amazon Web // Services account. type ServiceQuotaExceededException struct { Message *string diff --git a/service/amplifyuibuilder/types/types.go b/service/amplifyuibuilder/types/types.go index 7e492953791..b8ffae0440b 100644 --- a/service/amplifyuibuilder/types/types.go +++ b/service/amplifyuibuilder/types/types.go @@ -8,7 +8,7 @@ import ( ) // Represents the event action configuration for an element of a Component or -// ComponentChild. Use for the workflow feature in Amplify Studio that allows you +// ComponentChild . Use for the workflow feature in Amplify Studio that allows you // to bind events and actions to components. ActionParameters defines the action // that is performed when an event occurs on the component. type ActionParameters struct { @@ -17,13 +17,13 @@ type ActionParameters struct { // navigation action. Anchor *ComponentProperty - // A dictionary of key-value pairs mapping Amplify Studio properties to fields in a - // data model. Use when the action performs an operation on an Amplify DataStore + // A dictionary of key-value pairs mapping Amplify Studio properties to fields in + // a data model. Use when the action performs an operation on an Amplify DataStore // model. Fields map[string]ComponentProperty - // Specifies whether the user should be signed out globally. Specify this value for - // an auth sign out action. + // Specifies whether the user should be signed out globally. Specify this value + // for an auth sign out action. Global *ComponentProperty // The unique ID of the component that the ActionParameters apply to. @@ -39,7 +39,7 @@ type ActionParameters struct { // The element within the same component to modify when the action occurs. Target *ComponentProperty - // The type of navigation action. Valid values are url and anchor. This value is + // The type of navigation action. Valid values are url and anchor . This value is // required for a navigation action. Type *ComponentProperty @@ -51,8 +51,8 @@ type ActionParameters struct { // Contains the configuration settings for a user interface (UI) element for an // Amplify app. A component is configured as a primary, stand-alone UI element. Use -// ComponentChild to configure an instance of a Component. A ComponentChild -// instance inherits the configuration of the main Component. +// ComponentChild to configure an instance of a Component . A ComponentChild +// instance inherits the configuration of the main Component . type Component struct { // The unique ID of the Amplify app associated with the component. @@ -61,13 +61,13 @@ type Component struct { AppId *string // The information to connect a component's properties to data at runtime. You - // can't specify tags as a valid property for bindingProperties. + // can't specify tags as a valid property for bindingProperties . // // This member is required. BindingProperties map[string]ComponentBindingPropertiesValue - // The type of the component. This can be an Amplify custom UI component or another - // custom component. + // The type of the component. This can be an Amplify custom UI component or + // another custom component. // // This member is required. ComponentType *string @@ -94,19 +94,19 @@ type Component struct { // Describes the component's properties that can be overriden in a customized // instance of the component. You can't specify tags as a valid property for - // overrides. + // overrides . // // This member is required. Overrides map[string]map[string]string - // Describes the component's properties. You can't specify tags as a valid property - // for properties. + // Describes the component's properties. You can't specify tags as a valid + // property for properties . // // This member is required. Properties map[string]ComponentProperty - // A list of the component's variants. A variant is a unique style configuration of - // a main component. + // A list of the component's variants. A variant is a unique style configuration + // of a main component. // // This member is required. Variants []ComponentVariant @@ -116,7 +116,7 @@ type Component struct { // The data binding configuration for the component's properties. Use this for a // collection component. You can't specify tags as a valid property for - // collectionProperties. + // collectionProperties . CollectionProperties map[string]ComponentDataConfiguration // Describes the events that can be raised on the component. Use for the workflow @@ -190,7 +190,7 @@ type ComponentBindingPropertiesValueProperties struct { noSmithyDocumentSerde } -// A nested UI configuration within a parent Component. +// A nested UI configuration within a parent Component . type ComponentChild struct { // The type of the child component. @@ -204,7 +204,7 @@ type ComponentChild struct { Name *string // Describes the properties of the child component. You can't specify tags as a - // valid property for properties. + // valid property for properties . // // This member is required. Properties map[string]ComponentProperty @@ -276,15 +276,15 @@ type ComponentDataConfiguration struct { } // Describes the configuration of an event. You can bind an event and a -// corresponding action to a Component or a ComponentChild. A button click is an +// corresponding action to a Component or a ComponentChild . A button click is an // example of an event. type ComponentEvent struct { // The action to perform when a specific event is raised. Action *string - // Binds an event to an action on a component. When you specify a bindingEvent, the - // event is called when the action is performed. + // Binds an event to an action on a component. When you specify a bindingEvent , + // the event is called when the action is performed. BindingEvent *string // Describes information about the action. @@ -367,7 +367,7 @@ type ComponentPropertyBindingProperties struct { } // Contains a summary of a component. This is a read-only data type that is -// returned by ListComponents. +// returned by ListComponents . type ComponentSummary struct { // The unique ID of the Amplify app associated with the component. @@ -403,11 +403,11 @@ type ComponentVariant struct { // The properties of the component variant that can be overriden when customizing // an instance of the component. You can't specify tags as a valid property for - // overrides. + // overrides . Overrides map[string]map[string]string // The combination of variants that comprise this variant. You can't specify tags - // as a valid property for variantValues. + // as a valid property for variantValues . VariantValues map[string]string noSmithyDocumentSerde @@ -421,8 +421,8 @@ type CreateComponentData struct { // This member is required. BindingProperties map[string]ComponentBindingPropertiesValue - // The component type. This can be an Amplify custom UI component or another custom - // component. + // The component type. This can be an Amplify custom UI component or another + // custom component. // // This member is required. ComponentType *string @@ -499,8 +499,8 @@ type CreateFormData struct { // This member is required. SchemaVersion *string - // The configuration information for the visual helper elements for the form. These - // elements are not associated with any data. + // The configuration information for the visual helper elements for the form. + // These elements are not associated with any data. // // This member is required. SectionalElements map[string]SectionalElement @@ -710,17 +710,16 @@ type FileUploaderFieldConfig struct { AcceptedFileTypes []string // The access level to assign to the uploaded files in the Amazon S3 bucket where - // they are stored. The valid values for this property are private, protected, or - // public. For detailed information about the permissions associated with each - // access level, see File access levels - // (https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/) in the - // Amplify documentation. + // they are stored. The valid values for this property are private , protected , or + // public . For detailed information about the permissions associated with each + // access level, see File access levels (https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/) + // in the Amplify documentation. // // This member is required. AccessLevel StorageAccessLevel // Allows the file upload operation to be paused and resumed. The default value is - // false. When isResumable is set to true, the file uploader uses a multipart + // false . When isResumable is set to true , the file uploader uses a multipart // upload to break the files into chunks before upload. The progress of the upload // isn't continuous, because the file uploader uploads a chunk at a time. IsResumable *bool @@ -875,8 +874,8 @@ type FormDataTypeConfig struct { } // Represents the data binding configuration for a form's input fields at -// runtime.You can use FormInputBindingPropertiesValue to add exposed properties to -// a form to allow different values to be entered when a form is reused in +// runtime.You can use FormInputBindingPropertiesValue to add exposed properties +// to a form to allow different values to be entered when a form is reused in // different places in an app. type FormInputBindingPropertiesValue struct { @@ -1013,8 +1012,8 @@ type FormSummary struct { noSmithyDocumentSerde } -// Represents the state configuration when an action modifies a property of another -// element within the same component. +// Represents the state configuration when an action modifies a property of +// another element within the same component. type MutationActionSetStateParameter struct { // The name of the component that is being modified. @@ -1091,7 +1090,7 @@ type RefreshTokenRequestBody struct { // are static and not associated with any data. type SectionalElement struct { - // The type of sectional element. Valid values are Heading, Text, and Divider. + // The type of sectional element. Valid values are Heading , Text , and Divider . // // This member is required. Type *string @@ -1100,12 +1099,12 @@ type SectionalElement struct { // model. Excluded *bool - // Specifies the size of the font for a Heading sectional element. Valid values are - // 1 | 2 | 3 | 4 | 5 | 6. + // Specifies the size of the font for a Heading sectional element. Valid values + // are 1 | 2 | 3 | 4 | 5 | 6 . Level *int32 // Specifies the orientation for a Divider sectional element. Valid values are - // horizontal or vertical. + // horizontal or vertical . Orientation *string // Specifies the position of the text in a field for a Text sectional element. @@ -1239,12 +1238,12 @@ type UpdateComponentData struct { // The components that are instances of the main component. Children []ComponentChild - // The configuration for binding a component's properties to a data model. Use this - // for a collection component. + // The configuration for binding a component's properties to a data model. Use + // this for a collection component. CollectionProperties map[string]ComponentDataConfiguration - // The type of the component. This can be an Amplify custom UI component or another - // custom component. + // The type of the component. This can be an Amplify custom UI component or + // another custom component. ComponentType *string // The event configuration for the component. Use for the workflow feature in @@ -1299,8 +1298,8 @@ type UpdateFormData struct { // The schema version of the form. SchemaVersion *string - // The configuration information for the visual helper elements for the form. These - // elements are not associated with any data. + // The configuration information for the visual helper elements for the form. + // These elements are not associated with any data. SectionalElements map[string]SectionalElement // The configuration for the form's style. diff --git a/service/apigateway/api_client.go b/service/apigateway/api_client.go index 63f7168f1bc..ac68cf3ff9b 100644 --- a/service/apigateway/api_client.go +++ b/service/apigateway/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/apigateway/api_op_CreateApiKey.go b/service/apigateway/api_op_CreateApiKey.go index f332623f9fa..3d13351701b 100644 --- a/service/apigateway/api_op_CreateApiKey.go +++ b/service/apigateway/api_op_CreateApiKey.go @@ -41,8 +41,8 @@ type CreateApiKeyInput struct { // Specifies whether the ApiKey can be used by callers. Enabled bool - // Specifies whether (true) or not (false) the key identifier is distinct from the - // created API key value. This parameter is deprecated and should not be used. + // Specifies whether ( true ) or not ( false ) the key identifier is distinct from + // the created API key value. This parameter is deprecated and should not be used. GenerateDistinctId bool // The name of the ApiKey. @@ -52,7 +52,7 @@ type CreateApiKeyInput struct { StageKeys []types.StageKey // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string diff --git a/service/apigateway/api_op_CreateAuthorizer.go b/service/apigateway/api_op_CreateAuthorizer.go index 4657610fb62..7b5dc118b1e 100644 --- a/service/apigateway/api_op_CreateAuthorizer.go +++ b/service/apigateway/api_op_CreateAuthorizer.go @@ -40,10 +40,10 @@ type CreateAuthorizerInput struct { // This member is required. RestApiId *string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. + // The authorizer type. Valid values are TOKEN for a Lambda function using a + // single authorization token submitted in a custom header, REQUEST for a Lambda + // function using incoming request parameters, and COGNITO_USER_POOLS for using an + // Amazon Cognito user pool. // // This member is required. Type types.AuthorizerType @@ -67,25 +67,25 @@ type CreateAuthorizerInput struct { // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations + // . In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. + // including the initial / . For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations . AuthorizerUri *string // The identity source for which authorization is requested. For a TOKEN or // COGNITO_USER_POOLS authorizer, this is required and specifies the request header // mapping expression for the custom header holding the authorization token - // submitted by the client. For example, if the token header name is Auth, the - // header mapping expression is method.request.header.Auth. For the REQUEST + // submitted by the client. For example, if the token header name is Auth , the + // header mapping expression is method.request.header.Auth . For the REQUEST // authorizer, this is required when authorization caching is enabled. The value is // a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string // parameter are defined as identity sources, this value is - // method.request.header.Auth, method.request.querystring.Name. These parameters + // method.request.header.Auth, method.request.querystring.Name . These parameters // will be used to derive the authorization caching key and to perform runtime // validation of the REQUEST authorizer by verifying all of the identity-related // request parameters are present, not null and non-empty. Only when this is true @@ -107,7 +107,7 @@ type CreateAuthorizerInput struct { // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []string @@ -137,13 +137,13 @@ type CreateAuthorizerOutput struct { // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations + // . In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. + // including the initial / . For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations . AuthorizerUri *string // The identifier for the authorizer resource. @@ -152,13 +152,13 @@ type CreateAuthorizerOutput struct { // The identity source for which authorization is requested. For a TOKEN or // COGNITO_USER_POOLS authorizer, this is required and specifies the request header // mapping expression for the custom header holding the authorization token - // submitted by the client. For example, if the token header name is Auth, the - // header mapping expression is method.request.header.Auth. For the REQUEST + // submitted by the client. For example, if the token header name is Auth , the + // header mapping expression is method.request.header.Auth . For the REQUEST // authorizer, this is required when authorization caching is enabled. The value is // a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string // parameter are defined as identity sources, this value is - // method.request.header.Auth, method.request.querystring.Name. These parameters + // method.request.header.Auth , method.request.querystring.Name . These parameters // will be used to derive the authorization caching key and to perform runtime // validation of the REQUEST authorizer by verifying all of the identity-related // request parameters are present, not null and non-empty. Only when this is true @@ -183,14 +183,14 @@ type CreateAuthorizerOutput struct { // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. + // The authorizer type. Valid values are TOKEN for a Lambda function using a + // single authorization token submitted in a custom header, REQUEST for a Lambda + // function using incoming request parameters, and COGNITO_USER_POOLS for using an + // Amazon Cognito user pool. Type types.AuthorizerType // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_CreateBasePathMapping.go b/service/apigateway/api_op_CreateBasePathMapping.go index 107f4ffab3d..43cf88980e4 100644 --- a/service/apigateway/api_op_CreateBasePathMapping.go +++ b/service/apigateway/api_op_CreateBasePathMapping.go @@ -39,9 +39,9 @@ type CreateBasePathMappingInput struct { // This member is required. RestApiId *string - // The base path name that callers of the API must provide as part of the URL after - // the domain name. This value must be unique for all of the mappings across a - // single API. Specify '(none)' if you do not want callers to specify a base path + // The base path name that callers of the API must provide as part of the URL + // after the domain name. This value must be unique for all of the mappings across + // a single API. Specify '(none)' if you do not want callers to specify a base path // name after the domain name. BasePath *string @@ -53,12 +53,12 @@ type CreateBasePathMappingInput struct { noSmithyDocumentSerde } -// Represents the base path that callers of the API must provide as part of the URL -// after the domain name. +// Represents the base path that callers of the API must provide as part of the +// URL after the domain name. type CreateBasePathMappingOutput struct { - // The base path name that callers of the API must provide as part of the URL after - // the domain name. + // The base path name that callers of the API must provide as part of the URL + // after the domain name. BasePath *string // The string identifier of the associated RestApi. diff --git a/service/apigateway/api_op_CreateDeployment.go b/service/apigateway/api_op_CreateDeployment.go index 92bad85cd19..fc6543bcd80 100644 --- a/service/apigateway/api_op_CreateDeployment.go +++ b/service/apigateway/api_op_CreateDeployment.go @@ -12,8 +12,8 @@ import ( "time" ) -// Creates a Deployment resource, which makes a specified RestApi callable over the -// internet. +// Creates a Deployment resource, which makes a specified RestApi callable over +// the internet. func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { params = &CreateDeploymentInput{} @@ -41,8 +41,8 @@ type CreateDeploymentInput struct { CacheClusterEnabled *bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize types.CacheClusterSize // The input configuration for the canary deployment when the deployment is a @@ -61,9 +61,9 @@ type CreateDeploymentInput struct { // Specifies whether active tracing with X-ray is enabled for the Stage. TracingEnabled *bool - // A map that defines the stage variables for the Stage resource that is associated - // with the new deployment. Variable names can have alphanumeric and underscore - // characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. + // A map that defines the stage variables for the Stage resource that is + // associated with the new deployment. Variable names can have alphanumeric and + // underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_CreateDocumentationPart.go b/service/apigateway/api_op_CreateDocumentationPart.go index cdc2c22f3e2..3364dbeae4a 100644 --- a/service/apigateway/api_op_CreateDocumentationPart.go +++ b/service/apigateway/api_op_CreateDocumentationPart.go @@ -35,9 +35,9 @@ type CreateDocumentationPartInput struct { // This member is required. Location *types.DocumentationPartLocation - // The new documentation content map of the targeted API entity. Enclosed key-value - // pairs are API-specific, but only OpenAPI-compliant key-value pairs can be - // exported and, hence, published. + // The new documentation content map of the targeted API entity. Enclosed + // key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can + // be exported and, hence, published. // // This member is required. Properties *string @@ -66,10 +66,10 @@ type CreateDocumentationPartOutput struct { // A content map of API-specific key-value pairs describing the targeted API // entity. The map must be encoded as a JSON string, e.g., "{ \"description\": - // \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields + // \"The API does ...\" }" . Only OpenAPI-compliant documentation-related fields // from the properties map are exported and, hence, published as part of the API // entity definitions, while the original documentation parts are exported in a - // OpenAPI extension of x-amazon-apigateway-documentation. + // OpenAPI extension of x-amazon-apigateway-documentation . Properties *string // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_CreateDomainName.go b/service/apigateway/api_op_CreateDomainName.go index 83956f452f8..7922c132608 100644 --- a/service/apigateway/api_op_CreateDomainName.go +++ b/service/apigateway/api_op_CreateDomainName.go @@ -82,16 +82,16 @@ type CreateDomainNameInput struct { // source. RegionalCertificateArn *string - // The user-friendly name of the certificate that will be used by regional endpoint - // for this domain name. + // The user-friendly name of the certificate that will be used by regional + // endpoint for this domain name. RegionalCertificateName *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. - // The valid values are TLS_1_0 and TLS_1_2. + // The valid values are TLS_1_0 and TLS_1_2 . SecurityPolicy types.SecurityPolicy // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string @@ -128,12 +128,12 @@ type CreateDomainNameOutput struct { // Endpoints for API Gateway. DistributionHostedZoneId *string - // The custom domain name as an API host name, for example, my-api.example.com. + // The custom domain name as an API host name, for example, my-api.example.com . DomainName *string // The status of the DomainName migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be + // UPDATING . If the status is UPDATING , the domain cannot be modified further + // until the existing operation is complete. If it is AVAILABLE , the domain can be // updated. DomainNameStatus types.DomainNameStatus @@ -155,12 +155,12 @@ type CreateDomainNameOutput struct { // imported or private CA certificate ARN as the regionalCertificateArn. OwnershipVerificationCertificateArn *string - // The reference to an AWS-managed certificate that will be used for validating the - // regional domain name. AWS Certificate Manager is the only supported source. + // The reference to an AWS-managed certificate that will be used for validating + // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The name of the certificate that will be used for validating the regional domain - // name. + // The name of the certificate that will be used for validating the regional + // domain name. RegionalCertificateName *string // The domain name associated with the regional endpoint for this custom domain @@ -169,13 +169,13 @@ type CreateDomainNameOutput struct { // by API Gateway when you create a regional endpoint. RegionalDomainName *string - // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For - // more information, see Set up a Regional Custom Domain Name and AWS Regions and - // Endpoints for API Gateway. + // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. + // For more information, see Set up a Regional Custom Domain Name and AWS Regions + // and Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. - // The valid values are TLS_1_0 and TLS_1_2. + // The valid values are TLS_1_0 and TLS_1_2 . SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. diff --git a/service/apigateway/api_op_CreateRequestValidator.go b/service/apigateway/api_op_CreateRequestValidator.go index 8eae98907ee..cacb2bdf5f7 100644 --- a/service/apigateway/api_op_CreateRequestValidator.go +++ b/service/apigateway/api_op_CreateRequestValidator.go @@ -38,11 +38,11 @@ type CreateRequestValidatorInput struct { Name *string // A Boolean flag to indicate whether to validate request body according to the - // configured model schema for the method (true) or not (false). + // configured model schema for the method ( true ) or not ( false ). ValidateRequestBody bool - // A Boolean flag to indicate whether to validate request parameters, true, or not - // false. + // A Boolean flag to indicate whether to validate request parameters, true , or not + // false . ValidateRequestParameters bool noSmithyDocumentSerde @@ -61,8 +61,8 @@ type CreateRequestValidatorOutput struct { // configured Model schema. ValidateRequestBody bool - // A Boolean flag to indicate whether to validate request parameters (true) or not - // (false). + // A Boolean flag to indicate whether to validate request parameters ( true ) or + // not ( false ). ValidateRequestParameters bool // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_CreateRestApi.go b/service/apigateway/api_op_CreateRestApi.go index 40dd5b4274c..2e030033387 100644 --- a/service/apigateway/api_op_CreateRestApi.go +++ b/service/apigateway/api_op_CreateRestApi.go @@ -36,14 +36,14 @@ type CreateRestApiInput struct { // This member is required. Name *string - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The ID of the RestApi that you want to clone from. @@ -63,10 +63,10 @@ type CreateRestApiInput struct { // API. EndpointConfiguration *types.EndpointConfiguration - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 @@ -75,7 +75,7 @@ type CreateRestApiInput struct { Policy *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string @@ -88,14 +88,14 @@ type CreateRestApiInput struct { // Represents a REST API. type CreateRestApiOutput struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -119,10 +119,10 @@ type CreateRestApiOutput struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 diff --git a/service/apigateway/api_op_CreateStage.go b/service/apigateway/api_op_CreateStage.go index 2d1c804c4a7..34071ab168e 100644 --- a/service/apigateway/api_op_CreateStage.go +++ b/service/apigateway/api_op_CreateStage.go @@ -52,8 +52,8 @@ type CreateStageInput struct { CacheClusterEnabled bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize types.CacheClusterSize // The canary deployment settings of this stage. @@ -66,7 +66,7 @@ type CreateStageInput struct { DocumentationVersion *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string @@ -75,7 +75,7 @@ type CreateStageInput struct { // A map that defines the stage variables for the new Stage resource. Variable // names can have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. + // [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string noSmithyDocumentSerde @@ -92,8 +92,8 @@ type CreateStageOutput struct { CacheClusterEnabled bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. @@ -120,8 +120,8 @@ type CreateStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // A map that defines the method settings for a Stage resource. Keys (designated as - // /{method_setting_key below) are method paths defined as + // A map that defines the method settings for a Stage resource. Keys (designated + // as /{method_setting_key below) are method paths defined as // {resource_path}/{http_method} for an individual method override, or /\*/\* for // overriding all methods in the stage. MethodSettings map[string]types.MethodSetting @@ -140,7 +140,7 @@ type CreateStageOutput struct { // A map that defines the stage variables for a Stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. + // [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string // The ARN of the WebAcl associated with the Stage. diff --git a/service/apigateway/api_op_CreateUsagePlan.go b/service/apigateway/api_op_CreateUsagePlan.go index 5709e68e93c..5e9b2dbc0c4 100644 --- a/service/apigateway/api_op_CreateUsagePlan.go +++ b/service/apigateway/api_op_CreateUsagePlan.go @@ -48,7 +48,7 @@ type CreateUsagePlanInput struct { Quota *types.QuotaSettings // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string @@ -61,11 +61,9 @@ type CreateUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using Amazon Web Services Budgets -// (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. +// control costs. Consider using Amazon Web Services Budgets (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) +// to monitor costs and WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// to manage API requests. type CreateUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -80,8 +78,8 @@ type CreateUsagePlanOutput struct { // The name of a usage plan. Name *string - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS - // product on AWS Marketplace. + // The AWS Markeplace product identifier to associate with the usage plan as a + // SaaS product on AWS Marketplace. ProductCode *string // The target maximum number of permitted requests per a given unit time interval. diff --git a/service/apigateway/api_op_CreateUsagePlanKey.go b/service/apigateway/api_op_CreateUsagePlanKey.go index 3b9c6bbc806..5ea48328723 100644 --- a/service/apigateway/api_op_CreateUsagePlanKey.go +++ b/service/apigateway/api_op_CreateUsagePlanKey.go @@ -58,7 +58,7 @@ type CreateUsagePlanKeyOutput struct { // The name of a usage plan key. Name *string - // The type of a usage plan key. Currently, the valid key type is API_KEY. + // The type of a usage plan key. Currently, the valid key type is API_KEY . Type *string // The value of a usage plan key. diff --git a/service/apigateway/api_op_CreateVpcLink.go b/service/apigateway/api_op_CreateVpcLink.go index 45dd09c5a49..aa83f00a161 100644 --- a/service/apigateway/api_op_CreateVpcLink.go +++ b/service/apigateway/api_op_CreateVpcLink.go @@ -51,7 +51,7 @@ type CreateVpcLinkInput struct { Description *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string @@ -72,9 +72,9 @@ type CreateVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, - // or FAILED. Deploying an API will wait if the status is PENDING and will fail if - // the status is DELETING. + // The status of the VPC link. The valid values are AVAILABLE , PENDING , DELETING + // , or FAILED . Deploying an API will wait if the status is PENDING and will fail + // if the status is DELETING . Status types.VpcLinkStatus // A description about the VPC link status. diff --git a/service/apigateway/api_op_DeleteBasePathMapping.go b/service/apigateway/api_op_DeleteBasePathMapping.go index f2b940fd75c..a29cf31bebf 100644 --- a/service/apigateway/api_op_DeleteBasePathMapping.go +++ b/service/apigateway/api_op_DeleteBasePathMapping.go @@ -30,7 +30,7 @@ func (c *Client) DeleteBasePathMapping(ctx context.Context, params *DeleteBasePa type DeleteBasePathMappingInput struct { // The base path name of the BasePathMapping resource to delete. To specify an - // empty base path, set this parameter to '(none)'. + // empty base path, set this parameter to '(none)' . // // This member is required. BasePath *string diff --git a/service/apigateway/api_op_GenerateClientCertificate.go b/service/apigateway/api_op_GenerateClientCertificate.go index 62264a2384d..746885bf8da 100644 --- a/service/apigateway/api_op_GenerateClientCertificate.go +++ b/service/apigateway/api_op_GenerateClientCertificate.go @@ -34,15 +34,15 @@ type GenerateClientCertificateInput struct { Description *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. Tags map[string]string noSmithyDocumentSerde } -// Represents a client certificate used to configure client-side SSL authentication -// while sending requests to the integration endpoint. +// Represents a client certificate used to configure client-side SSL +// authentication while sending requests to the integration endpoint. type GenerateClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_GetAccount.go b/service/apigateway/api_op_GetAccount.go index b5290ed75a3..068bdc54653 100644 --- a/service/apigateway/api_op_GetAccount.go +++ b/service/apigateway/api_op_GetAccount.go @@ -42,7 +42,7 @@ type GetAccountOutput struct { CloudwatchRoleArn *string // A list of features supported for the account. When usage plans are enabled, the - // features list will include an entry of "UsagePlans". + // features list will include an entry of "UsagePlans" . Features []string // Specifies the API request limits configured for the current Account. diff --git a/service/apigateway/api_op_GetApiKey.go b/service/apigateway/api_op_GetApiKey.go index c7cb479f382..cf65a7e23b4 100644 --- a/service/apigateway/api_op_GetApiKey.go +++ b/service/apigateway/api_op_GetApiKey.go @@ -35,8 +35,8 @@ type GetApiKeyInput struct { // This member is required. ApiKey *string - // A boolean flag to specify whether (true) or not (false) the result contains the - // key value. + // A boolean flag to specify whether ( true ) or not ( false ) the result contains + // the key value. IncludeValue *bool noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetApiKeys.go b/service/apigateway/api_op_GetApiKeys.go index 1a29a2de221..0e203a74e50 100644 --- a/service/apigateway/api_op_GetApiKeys.go +++ b/service/apigateway/api_op_GetApiKeys.go @@ -31,16 +31,16 @@ func (c *Client) GetApiKeys(ctx context.Context, params *GetApiKeysInput, optFns // A request to get information about the current ApiKeys resource. type GetApiKeysInput struct { - // The identifier of a customer in AWS Marketplace or an external system, such as a - // developer portal. + // The identifier of a customer in AWS Marketplace or an external system, such as + // a developer portal. CustomerId *string - // A boolean flag to specify whether (true) or not (false) the result contains key - // values. + // A boolean flag to specify whether ( true ) or not ( false ) the result contains + // key values. IncludeValues *bool - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The name of queried API keys. @@ -143,8 +143,8 @@ var _ GetApiKeysAPIClient = (*Client)(nil) // GetApiKeysPaginatorOptions is the paginator options for GetApiKeys type GetApiKeysPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetAuthorizer.go b/service/apigateway/api_op_GetAuthorizer.go index a248e4999bc..0bd69080869 100644 --- a/service/apigateway/api_op_GetAuthorizer.go +++ b/service/apigateway/api_op_GetAuthorizer.go @@ -66,13 +66,13 @@ type GetAuthorizerOutput struct { // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations + // . In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. + // including the initial / . For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations . AuthorizerUri *string // The identifier for the authorizer resource. @@ -81,13 +81,13 @@ type GetAuthorizerOutput struct { // The identity source for which authorization is requested. For a TOKEN or // COGNITO_USER_POOLS authorizer, this is required and specifies the request header // mapping expression for the custom header holding the authorization token - // submitted by the client. For example, if the token header name is Auth, the - // header mapping expression is method.request.header.Auth. For the REQUEST + // submitted by the client. For example, if the token header name is Auth , the + // header mapping expression is method.request.header.Auth . For the REQUEST // authorizer, this is required when authorization caching is enabled. The value is // a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string // parameter are defined as identity sources, this value is - // method.request.header.Auth, method.request.querystring.Name. These parameters + // method.request.header.Auth , method.request.querystring.Name . These parameters // will be used to derive the authorization caching key and to perform runtime // validation of the REQUEST authorizer by verifying all of the identity-related // request parameters are present, not null and non-empty. Only when this is true @@ -112,14 +112,14 @@ type GetAuthorizerOutput struct { // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. + // The authorizer type. Valid values are TOKEN for a Lambda function using a + // single authorization token submitted in a custom header, REQUEST for a Lambda + // function using incoming request parameters, and COGNITO_USER_POOLS for using an + // Amazon Cognito user pool. Type types.AuthorizerType // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetAuthorizers.go b/service/apigateway/api_op_GetAuthorizers.go index b6a23ef631d..67da54c3f73 100644 --- a/service/apigateway/api_op_GetAuthorizers.go +++ b/service/apigateway/api_op_GetAuthorizers.go @@ -35,8 +35,8 @@ type GetAuthorizersInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. diff --git a/service/apigateway/api_op_GetBasePathMapping.go b/service/apigateway/api_op_GetBasePathMapping.go index debbfce9825..54c98a3ec93 100644 --- a/service/apigateway/api_op_GetBasePathMapping.go +++ b/service/apigateway/api_op_GetBasePathMapping.go @@ -29,10 +29,10 @@ func (c *Client) GetBasePathMapping(ctx context.Context, params *GetBasePathMapp // Request to describe a BasePathMapping resource. type GetBasePathMappingInput struct { - // The base path name that callers of the API must provide as part of the URL after - // the domain name. This value must be unique for all of the mappings across a - // single API. Specify '(none)' if you do not want callers to specify any base path - // name after the domain name. + // The base path name that callers of the API must provide as part of the URL + // after the domain name. This value must be unique for all of the mappings across + // a single API. Specify '(none)' if you do not want callers to specify any base + // path name after the domain name. // // This member is required. BasePath *string @@ -45,12 +45,12 @@ type GetBasePathMappingInput struct { noSmithyDocumentSerde } -// Represents the base path that callers of the API must provide as part of the URL -// after the domain name. +// Represents the base path that callers of the API must provide as part of the +// URL after the domain name. type GetBasePathMappingOutput struct { - // The base path name that callers of the API must provide as part of the URL after - // the domain name. + // The base path name that callers of the API must provide as part of the URL + // after the domain name. BasePath *string // The string identifier of the associated RestApi. diff --git a/service/apigateway/api_op_GetBasePathMappings.go b/service/apigateway/api_op_GetBasePathMappings.go index a7f144e15e4..24ae601f90c 100644 --- a/service/apigateway/api_op_GetBasePathMappings.go +++ b/service/apigateway/api_op_GetBasePathMappings.go @@ -36,8 +36,8 @@ type GetBasePathMappingsInput struct { // This member is required. DomainName *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -127,8 +127,8 @@ func (c *Client) addOperationGetBasePathMappingsMiddlewares(stack *middleware.St return nil } -// GetBasePathMappingsAPIClient is a client that implements the GetBasePathMappings -// operation. +// GetBasePathMappingsAPIClient is a client that implements the +// GetBasePathMappings operation. type GetBasePathMappingsAPIClient interface { GetBasePathMappings(context.Context, *GetBasePathMappingsInput, ...func(*Options)) (*GetBasePathMappingsOutput, error) } @@ -138,8 +138,8 @@ var _ GetBasePathMappingsAPIClient = (*Client)(nil) // GetBasePathMappingsPaginatorOptions is the paginator options for // GetBasePathMappings type GetBasePathMappingsPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetClientCertificate.go b/service/apigateway/api_op_GetClientCertificate.go index 624dca7b99b..01a0d078bdf 100644 --- a/service/apigateway/api_op_GetClientCertificate.go +++ b/service/apigateway/api_op_GetClientCertificate.go @@ -38,8 +38,8 @@ type GetClientCertificateInput struct { noSmithyDocumentSerde } -// Represents a client certificate used to configure client-side SSL authentication -// while sending requests to the integration endpoint. +// Represents a client certificate used to configure client-side SSL +// authentication while sending requests to the integration endpoint. type GetClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_GetClientCertificates.go b/service/apigateway/api_op_GetClientCertificates.go index 7308a8af97b..b2af08869b8 100644 --- a/service/apigateway/api_op_GetClientCertificates.go +++ b/service/apigateway/api_op_GetClientCertificates.go @@ -31,8 +31,8 @@ func (c *Client) GetClientCertificates(ctx context.Context, params *GetClientCer // A request to get information about a collection of ClientCertificate resources. type GetClientCertificatesInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -130,8 +130,8 @@ var _ GetClientCertificatesAPIClient = (*Client)(nil) // GetClientCertificatesPaginatorOptions is the paginator options for // GetClientCertificates type GetClientCertificatesPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetDeployment.go b/service/apigateway/api_op_GetDeployment.go index 7d28274e8c8..77b196b8120 100644 --- a/service/apigateway/api_op_GetDeployment.go +++ b/service/apigateway/api_op_GetDeployment.go @@ -44,12 +44,12 @@ type GetDeploymentInput struct { // A query parameter to retrieve the specified embedded resources of the returned // Deployment resource in the response. In a REST API call, this embed parameter // value is a list of comma-separated strings, as in GET - // /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and + // /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2 . The SDK and // other platform-dependent libraries might use a different format for the list. // Currently, this request supports only retrieval of the embedded API summary this // way. Hence, the parameter value must be a single-valued list containing only the // "apisummary" string. For example, GET - // /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. + // /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary . Embed []string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetDeployments.go b/service/apigateway/api_op_GetDeployments.go index 463b065d686..8e77936a838 100644 --- a/service/apigateway/api_op_GetDeployments.go +++ b/service/apigateway/api_op_GetDeployments.go @@ -36,8 +36,8 @@ type GetDeploymentsInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -139,8 +139,8 @@ var _ GetDeploymentsAPIClient = (*Client)(nil) // GetDeploymentsPaginatorOptions is the paginator options for GetDeployments type GetDeploymentsPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetDocumentationPart.go b/service/apigateway/api_op_GetDocumentationPart.go index bb7d86d02ae..d2ed5f85f5f 100644 --- a/service/apigateway/api_op_GetDocumentationPart.go +++ b/service/apigateway/api_op_GetDocumentationPart.go @@ -59,10 +59,10 @@ type GetDocumentationPartOutput struct { // A content map of API-specific key-value pairs describing the targeted API // entity. The map must be encoded as a JSON string, e.g., "{ \"description\": - // \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields + // \"The API does ...\" }" . Only OpenAPI-compliant documentation-related fields // from the properties map are exported and, hence, published as part of the API // entity definitions, while the original documentation parts are exported in a - // OpenAPI extension of x-amazon-apigateway-documentation. + // OpenAPI extension of x-amazon-apigateway-documentation . Properties *string // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetDocumentationParts.go b/service/apigateway/api_op_GetDocumentationParts.go index 57e8051ffab..1aad796fa80 100644 --- a/service/apigateway/api_op_GetDocumentationParts.go +++ b/service/apigateway/api_op_GetDocumentationParts.go @@ -36,8 +36,8 @@ type GetDocumentationPartsInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The status of the API documentation parts to retrieve. Valid values are diff --git a/service/apigateway/api_op_GetDocumentationVersions.go b/service/apigateway/api_op_GetDocumentationVersions.go index d2b170bbd36..b61f55a71ef 100644 --- a/service/apigateway/api_op_GetDocumentationVersions.go +++ b/service/apigateway/api_op_GetDocumentationVersions.go @@ -35,8 +35,8 @@ type GetDocumentationVersionsInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. diff --git a/service/apigateway/api_op_GetDomainName.go b/service/apigateway/api_op_GetDomainName.go index fcb6e44cdd3..6bbe19ee2da 100644 --- a/service/apigateway/api_op_GetDomainName.go +++ b/service/apigateway/api_op_GetDomainName.go @@ -12,8 +12,8 @@ import ( "time" ) -// Represents a domain name that is contained in a simpler, more intuitive URL that -// can be called. +// Represents a domain name that is contained in a simpler, more intuitive URL +// that can be called. func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, optFns ...func(*Options)) (*GetDomainNameOutput, error) { if params == nil { params = &GetDomainNameInput{} @@ -70,12 +70,12 @@ type GetDomainNameOutput struct { // Endpoints for API Gateway. DistributionHostedZoneId *string - // The custom domain name as an API host name, for example, my-api.example.com. + // The custom domain name as an API host name, for example, my-api.example.com . DomainName *string // The status of the DomainName migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be + // UPDATING . If the status is UPDATING , the domain cannot be modified further + // until the existing operation is complete. If it is AVAILABLE , the domain can be // updated. DomainNameStatus types.DomainNameStatus @@ -97,12 +97,12 @@ type GetDomainNameOutput struct { // imported or private CA certificate ARN as the regionalCertificateArn. OwnershipVerificationCertificateArn *string - // The reference to an AWS-managed certificate that will be used for validating the - // regional domain name. AWS Certificate Manager is the only supported source. + // The reference to an AWS-managed certificate that will be used for validating + // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The name of the certificate that will be used for validating the regional domain - // name. + // The name of the certificate that will be used for validating the regional + // domain name. RegionalCertificateName *string // The domain name associated with the regional endpoint for this custom domain @@ -111,13 +111,13 @@ type GetDomainNameOutput struct { // by API Gateway when you create a regional endpoint. RegionalDomainName *string - // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For - // more information, see Set up a Regional Custom Domain Name and AWS Regions and - // Endpoints for API Gateway. + // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. + // For more information, see Set up a Regional Custom Domain Name and AWS Regions + // and Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. - // The valid values are TLS_1_0 and TLS_1_2. + // The valid values are TLS_1_0 and TLS_1_2 . SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. diff --git a/service/apigateway/api_op_GetDomainNames.go b/service/apigateway/api_op_GetDomainNames.go index 7089e62fc3b..f027e325636 100644 --- a/service/apigateway/api_op_GetDomainNames.go +++ b/service/apigateway/api_op_GetDomainNames.go @@ -31,8 +31,8 @@ func (c *Client) GetDomainNames(ctx context.Context, params *GetDomainNamesInput // Request to describe a collection of DomainName resources. type GetDomainNamesInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -129,8 +129,8 @@ var _ GetDomainNamesAPIClient = (*Client)(nil) // GetDomainNamesPaginatorOptions is the paginator options for GetDomainNames type GetDomainNamesPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetExport.go b/service/apigateway/api_op_GetExport.go index 4573e0de076..fefd8796c08 100644 --- a/service/apigateway/api_op_GetExport.go +++ b/service/apigateway/api_op_GetExport.go @@ -45,18 +45,18 @@ type GetExportInput struct { // This member is required. StageName *string - // The content-type of the export, for example application/json. Currently - // application/json and application/yaml are supported for exportType ofoas30 and - // swagger. This should be specified in the Accept header for direct API requests. + // The content-type of the export, for example application/json . Currently + // application/json and application/yaml are supported for exportType of oas30 and + // swagger . This should be specified in the Accept header for direct API requests. Accepts *string // A key-value map of query string parameters that specify properties of the - // export, depending on the requested exportType. For exportTypeoas30 and swagger, - // any combination of the following parameters are supported: + // export, depending on the requested exportType . For exportType oas30 and swagger + // , any combination of the following parameters are supported: // extensions='integrations' or extensions='apigateway' will export the API with - // x-amazon-apigateway-integration extensions. extensions='authorizers' will export - // the API with x-amazon-apigateway-authorizer extensions. postman will export the - // API with Postman extensions, allowing for import to the Postman tool + // x-amazon-apigateway-integration extensions. extensions='authorizers' will + // export the API with x-amazon-apigateway-authorizer extensions. postman will + // export the API with Postman extensions, allowing for import to the Postman tool Parameters map[string]string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetGatewayResponse.go b/service/apigateway/api_op_GetGatewayResponse.go index 84397af03c9..9ac6ebd54a9 100644 --- a/service/apigateway/api_op_GetGatewayResponse.go +++ b/service/apigateway/api_op_GetGatewayResponse.go @@ -48,16 +48,16 @@ type GetGatewayResponseInput struct { type GetGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway - // response (true) or not (false). A default gateway response is one generated by - // API Gateway without any customization by an API developer. + // response ( true ) or not ( false ). A default gateway response is one generated + // by API Gateway without any customization by an API developer. DefaultResponse bool - // Response parameters (paths, query strings and headers) of the GatewayResponse as - // a string-to-string map of key-value pairs. + // Response parameters (paths, query strings and headers) of the GatewayResponse + // as a string-to-string map of key-value pairs. ResponseParameters map[string]string - // Response templates of the GatewayResponse as a string-to-string map of key-value - // pairs. + // Response templates of the GatewayResponse as a string-to-string map of + // key-value pairs. ResponseTemplates map[string]string // The response type of the associated GatewayResponse. diff --git a/service/apigateway/api_op_GetGatewayResponses.go b/service/apigateway/api_op_GetGatewayResponses.go index fe4d9a34c11..bd758a7f0c1 100644 --- a/service/apigateway/api_op_GetGatewayResponses.go +++ b/service/apigateway/api_op_GetGatewayResponses.go @@ -41,8 +41,8 @@ type GetGatewayResponsesInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. The GatewayResponses collection does not support + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. The GatewayResponses collection does not support // pagination and the limit does not apply here. Limit *int32 @@ -53,9 +53,9 @@ type GetGatewayResponsesInput struct { noSmithyDocumentSerde } -// The collection of the GatewayResponse instances of a RestApi as a -// responseType-to-GatewayResponse object map of key-value pairs. As such, -// pagination is not supported for querying this collection. +// The collection of the GatewayResponse instances of a RestApi as a responseType +// -to-GatewayResponse object map of key-value pairs. As such, pagination is not +// supported for querying this collection. type GetGatewayResponsesOutput struct { // Returns the entire collection, because of no pagination support. diff --git a/service/apigateway/api_op_GetIntegration.go b/service/apigateway/api_op_GetIntegration.go index 3c46b5c97b4..24f195c7013 100644 --- a/service/apigateway/api_op_GetIntegration.go +++ b/service/apigateway/api_op_GetIntegration.go @@ -51,13 +51,13 @@ type GetIntegrationInput struct { // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. type GetIntegrationOutput struct { - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters , these parameters must also be specified for + // Method requestParameters . CacheKeyParameters []string - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace . You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string @@ -67,13 +67,13 @@ type GetIntegrationOutput struct { ConnectionId *string // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. + // is INTERNET for connections through the public routable internet or VPC_LINK + // for private connections between API Gateway and a network load balancer in a + // VPC. The default value is INTERNET . ConnectionType types.ConnectionType // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the request payload will be passed through from // the method request to integration request without modification, provided that // the passthroughBehavior is configured to support payload pass-through. @@ -83,7 +83,7 @@ type GetIntegrationOutput struct { // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS // services, specify null. Credentials *string @@ -93,23 +93,23 @@ type GetIntegrationOutput struct { // Specifies the integration's responses. IntegrationResponses map[string]types.IntegrationResponse - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A + // Specifies how the method request body of an unmapped content type will be + // passed through the integration request to the back end without transformation. A // content type is unmapped if no mapping template is defined in the integration or // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes - // the method request body through the integration request to the back end without - // transformation when the method request content type does not match any content - // type associated with the mapping templates defined in the integration request. - // WHEN_NO_TEMPLATES: passes the method request body through the integration - // request to the back end without transformation when no mapping template is - // defined in the integration request. If a template is defined when this option is - // selected, the method request of an unmapped content-type will be rejected with - // an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request - // with an HTTP 415 Unsupported Media Type response when either the method request - // content type does not match any content type associated with the mapping - // templates defined in the integration request or no mapping template is defined - // in the integration request. + // requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. WHEN_NO_TEMPLATES : passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the + // method request with an HTTP 415 Unsupported Media Type response when either the + // method request content type does not match any content type associated with the + // mapping templates defined in the integration request or no mapping template is + // defined in the integration request. PassthroughBehavior *string // A key-value map specifying request parameters that are passed from the method @@ -117,8 +117,8 @@ type GetIntegrationOutput struct { // the associated value is a method request parameter value or static value that // must be enclosed within single quotes and pre-encoded as required by the back // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. + // method.request.{location}.{name} , where location is querystring , path , or + // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -135,20 +135,20 @@ type GetIntegrationOutput struct { // Specifies an API method integration type. The valid value is one of the // following: For the HTTP and HTTP proxy integrations, each integration can - // specify a protocol (http/https), port and path. Standard 80 and 443 ports are + // specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are // supported as well as custom ports above 1024. An HTTP or HTTP proxy integration // with a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType // Specifies Uniform Resource Identifier (URI) of the integration endpoint. For - // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) - // URL according to the RFC-3986 specification, for either standard integration, - // where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification, for either standard + // integration, where connectionType is not VPC_LINK , or private integration, + // where connectionType is VPC_LINK . For a private HTTP integration, the URI is + // not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} + // . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain Amazon Web Services service for // fast host-name lookup. action can be used for an Amazon Web Services service diff --git a/service/apigateway/api_op_GetIntegrationResponse.go b/service/apigateway/api_op_GetIntegrationResponse.go index 20cf52dfda4..06ef4ce2244 100644 --- a/service/apigateway/api_op_GetIntegrationResponse.go +++ b/service/apigateway/api_op_GetIntegrationResponse.go @@ -59,7 +59,7 @@ type GetIntegrationResponseInput struct { type GetIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy @@ -69,10 +69,10 @@ type GetIntegrationResponseOutput struct { // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of - // method.response.header.{name}, where name is a valid and unique header name. The - // mapped non-static value must match the pattern of + // method.response.header.{name} , where name is a valid and unique header name. + // The mapped non-static value must match the pattern of // integration.response.header.{name} or - // integration.response.body.{JSON-expression}, where name is a valid and unique + // integration.response.body.{JSON-expression} , where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]string @@ -86,9 +86,9 @@ type GetIntegrationResponseOutput struct { // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could // use the .+ regex to match error response. However, make sure that the error - // response does not contain any newline (\n) character in such cases. If the back - // end is an AWS Lambda function, the AWS Lambda function error header is matched. - // For all other HTTP and AWS back ends, the HTTP status code is matched. + // response does not contain any newline ( \n ) character in such cases. If the + // back end is an AWS Lambda function, the AWS Lambda function error header is + // matched. For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string // Specifies the status code that is used to map the integration response to an diff --git a/service/apigateway/api_op_GetMethod.go b/service/apigateway/api_op_GetMethod.go index dd45fc2c1f7..1a21c18d258 100644 --- a/service/apigateway/api_op_GetMethod.go +++ b/service/apigateway/api_op_GetMethod.go @@ -48,8 +48,8 @@ type GetMethodInput struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to access -// back-end resources. A Method resource is integrated with an Integration +// Represents a client-facing interface by which the client calls the API to +// access back-end resources. A Method resource is integrated with an Integration // resource. Both consist of a request and one or more responses. The method // request takes the client input that is passed to the back end through the // integration request. A method response returns the output from the back end to @@ -80,7 +80,7 @@ type GetMethodOutput struct { AuthorizationType *string // The identifier of an Authorizer to use on this method. The authorizationType - // must be CUSTOM. + // must be CUSTOM . AuthorizerId *string // The method's HTTP verb. @@ -99,19 +99,19 @@ type GetMethodOutput struct { // example. OperationName *string - // A key-value map specifying data schemas, represented by Model resources, (as the - // mapped value) of the request payloads of given content types (as the mapping + // A key-value map specifying data schemas, represented by Model resources, (as + // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]string - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration to be mapped to integration request parameters - // or templates. + // A key-value map defining required or optional method request parameters that + // can be accepted by API Gateway. A key is a method request parameter name + // matching the pattern of method.request.{location}.{name} , where location is + // querystring , path , or header and name is a valid and unique parameter name. + // The value associated with the key is a Boolean flag indicating whether the + // parameter is required ( true ) or optional ( false ). The method request + // parameter names defined here are available in Integration to be mapped to + // integration request parameters or templates. RequestParameters map[string]bool // The identifier of a RequestValidator for request validation. diff --git a/service/apigateway/api_op_GetMethodResponse.go b/service/apigateway/api_op_GetMethodResponse.go index 5125e4634ef..bb70bb5e184 100644 --- a/service/apigateway/api_op_GetMethodResponse.go +++ b/service/apigateway/api_op_GetMethodResponse.go @@ -52,8 +52,8 @@ type GetMethodResponseInput struct { noSmithyDocumentSerde } -// Represents a method response of a given HTTP status code returned to the client. -// The method response is passed from the back end through the associated +// Represents a method response of a given HTTP status code returned to the +// client. The method response is passed from the back end through the associated // integration response that can be transformed using a mapping template. type GetMethodResponseOutput struct { @@ -66,14 +66,14 @@ type GetMethodResponseOutput struct { // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or // not. The expression of the key must match the pattern - // method.response.header.{name}, where name is a valid and unique header name. API - // Gateway passes certain integration response data to the method response headers - // specified here according to the mapping you prescribe in the API's + // method.response.header.{name} , where name is a valid and unique header name. + // API Gateway passes certain integration response data to the method response + // headers specified here according to the mapping you prescribe in the API's // IntegrationResponse. The integration response data that can be mapped include an - // integration response header expressed in integration.response.header.{name}, a - // static value enclosed within a pair of single quotes (e.g., 'application/json'), - // or a JSON expression from the back-end response payload in the form of - // integration.response.body.{JSON-expression}, where JSON-expression is a valid + // integration response header expressed in integration.response.header.{name} , a + // static value enclosed within a pair of single quotes (e.g., 'application/json' + // ), or a JSON expression from the back-end response payload in the form of + // integration.response.body.{JSON-expression} , where JSON-expression is a valid // JSON expression without the $ prefix.) ResponseParameters map[string]bool diff --git a/service/apigateway/api_op_GetModel.go b/service/apigateway/api_op_GetModel.go index b871f89465d..367cfc60e96 100644 --- a/service/apigateway/api_op_GetModel.go +++ b/service/apigateway/api_op_GetModel.go @@ -39,9 +39,9 @@ type GetModelInput struct { // This member is required. RestApiId *string - // A query parameter of a Boolean value to resolve (true) all external model - // references and returns a flattened model schema or not (false) The default is - // false. + // A query parameter of a Boolean value to resolve ( true ) all external model + // references and returns a flattened model schema or not ( false ) The default is + // false . Flatten bool noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetModelTemplate.go b/service/apigateway/api_op_GetModelTemplate.go index c6e098bcaf9..bc9433ff353 100644 --- a/service/apigateway/api_op_GetModelTemplate.go +++ b/service/apigateway/api_op_GetModelTemplate.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates a sample mapping template that can be used to transform a payload into -// the structure of a model. +// Generates a sample mapping template that can be used to transform a payload +// into the structure of a model. func (c *Client) GetModelTemplate(ctx context.Context, params *GetModelTemplateInput, optFns ...func(*Options)) (*GetModelTemplateOutput, error) { if params == nil { params = &GetModelTemplateInput{} diff --git a/service/apigateway/api_op_GetModels.go b/service/apigateway/api_op_GetModels.go index 3b07640e674..c1cbc16fef5 100644 --- a/service/apigateway/api_op_GetModels.go +++ b/service/apigateway/api_op_GetModels.go @@ -36,8 +36,8 @@ type GetModelsInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -136,8 +136,8 @@ var _ GetModelsAPIClient = (*Client)(nil) // GetModelsPaginatorOptions is the paginator options for GetModels type GetModelsPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetRequestValidator.go b/service/apigateway/api_op_GetRequestValidator.go index a633ffe6b8e..8b545d3fb2f 100644 --- a/service/apigateway/api_op_GetRequestValidator.go +++ b/service/apigateway/api_op_GetRequestValidator.go @@ -55,8 +55,8 @@ type GetRequestValidatorOutput struct { // configured Model schema. ValidateRequestBody bool - // A Boolean flag to indicate whether to validate request parameters (true) or not - // (false). + // A Boolean flag to indicate whether to validate request parameters ( true ) or + // not ( false ). ValidateRequestParameters bool // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_GetRequestValidators.go b/service/apigateway/api_op_GetRequestValidators.go index 44c98f8c2f7..2bc76fe33a8 100644 --- a/service/apigateway/api_op_GetRequestValidators.go +++ b/service/apigateway/api_op_GetRequestValidators.go @@ -35,8 +35,8 @@ type GetRequestValidatorsInput struct { // This member is required. RestApiId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. diff --git a/service/apigateway/api_op_GetResource.go b/service/apigateway/api_op_GetResource.go index 36c1e8dfa7a..df611ffff6c 100644 --- a/service/apigateway/api_op_GetResource.go +++ b/service/apigateway/api_op_GetResource.go @@ -41,11 +41,11 @@ type GetResourceInput struct { RestApiId *string // A query parameter to retrieve the specified resources embedded in the returned - // Resource representation in the response. This embed parameter value is a list of - // comma-separated strings. Currently, the request supports only retrieval of the - // embedded Method resources this way. The query parameter value must be a + // Resource representation in the response. This embed parameter value is a list + // of comma-separated strings. Currently, the request supports only retrieval of + // the embedded Method resources this way. The query parameter value must be a // single-valued list and contain the "methods" string. For example, GET - // /restapis/{restapi_id}/resources/{resource_id}?embed=methods. + // /restapis/{restapi_id}/resources/{resource_id}?embed=methods . Embed []string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetResources.go b/service/apigateway/api_op_GetResources.go index 3c89034772b..264bf91f89a 100644 --- a/service/apigateway/api_op_GetResources.go +++ b/service/apigateway/api_op_GetResources.go @@ -41,11 +41,11 @@ type GetResourcesInput struct { // list of comma-separated strings. Currently, the request supports only retrieval // of the embedded Method resources this way. The query parameter value must be a // single-valued list and contain the "methods" string. For example, GET - // /restapis/{restapi_id}/resources?embed=methods. + // /restapis/{restapi_id}/resources?embed=methods . Embed []string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -144,8 +144,8 @@ var _ GetResourcesAPIClient = (*Client)(nil) // GetResourcesPaginatorOptions is the paginator options for GetResources type GetResourcesPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetRestApi.go b/service/apigateway/api_op_GetRestApi.go index 8b725839541..e70a7336501 100644 --- a/service/apigateway/api_op_GetRestApi.go +++ b/service/apigateway/api_op_GetRestApi.go @@ -42,14 +42,14 @@ type GetRestApiInput struct { // Represents a REST API. type GetRestApiOutput struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -73,10 +73,10 @@ type GetRestApiOutput struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 diff --git a/service/apigateway/api_op_GetRestApis.go b/service/apigateway/api_op_GetRestApis.go index 1511a553d6f..8baf7af4e23 100644 --- a/service/apigateway/api_op_GetRestApis.go +++ b/service/apigateway/api_op_GetRestApis.go @@ -31,8 +31,8 @@ func (c *Client) GetRestApis(ctx context.Context, params *GetRestApisInput, optF // The GET request to list existing RestApis defined for your collection. type GetRestApisInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -129,8 +129,8 @@ var _ GetRestApisAPIClient = (*Client)(nil) // GetRestApisPaginatorOptions is the paginator options for GetRestApis type GetRestApisPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetSdk.go b/service/apigateway/api_op_GetSdk.go index 6d62079264f..84f70cf765a 100644 --- a/service/apigateway/api_op_GetSdk.go +++ b/service/apigateway/api_op_GetSdk.go @@ -34,7 +34,7 @@ type GetSdkInput struct { // This member is required. RestApiId *string - // The language for the generated SDK. Currently java, javascript, android, + // The language for the generated SDK. Currently java , javascript , android , // objectivec (for iOS), swift (for iOS), and ruby are supported. // // This member is required. @@ -45,11 +45,11 @@ type GetSdkInput struct { // This member is required. StageName *string - // A string-to-string key-value map of query parameters sdkType-dependent - // properties of the SDK. For sdkType of objectivec or swift, a parameter named - // classPrefix is required. For sdkType of android, parameters named groupId, - // artifactId, artifactVersion, and invokerPackage are required. For sdkType of - // java, parameters named serviceName and javaPackageName are required. + // A string-to-string key-value map of query parameters sdkType -dependent + // properties of the SDK. For sdkType of objectivec or swift , a parameter named + // classPrefix is required. For sdkType of android , parameters named groupId , + // artifactId , artifactVersion , and invokerPackage are required. For sdkType of + // java , parameters named serviceName and javaPackageName are required. Parameters map[string]string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_GetSdkTypes.go b/service/apigateway/api_op_GetSdkTypes.go index 6f9e4e1b417..2dbca71dd94 100644 --- a/service/apigateway/api_op_GetSdkTypes.go +++ b/service/apigateway/api_op_GetSdkTypes.go @@ -30,8 +30,8 @@ func (c *Client) GetSdkTypes(ctx context.Context, params *GetSdkTypesInput, optF // Get the SdkTypes collection. type GetSdkTypesInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. diff --git a/service/apigateway/api_op_GetStage.go b/service/apigateway/api_op_GetStage.go index b3ea3f3a312..5a8068269ce 100644 --- a/service/apigateway/api_op_GetStage.go +++ b/service/apigateway/api_op_GetStage.go @@ -55,8 +55,8 @@ type GetStageOutput struct { CacheClusterEnabled bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. @@ -83,8 +83,8 @@ type GetStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // A map that defines the method settings for a Stage resource. Keys (designated as - // /{method_setting_key below) are method paths defined as + // A map that defines the method settings for a Stage resource. Keys (designated + // as /{method_setting_key below) are method paths defined as // {resource_path}/{http_method} for an individual method override, or /\*/\* for // overriding all methods in the stage. MethodSettings map[string]types.MethodSetting @@ -103,7 +103,7 @@ type GetStageOutput struct { // A map that defines the stage variables for a Stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. + // [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string // The ARN of the WebAcl associated with the Stage. diff --git a/service/apigateway/api_op_GetUsage.go b/service/apigateway/api_op_GetUsage.go index 6136aa38f02..b665e2f3483 100644 --- a/service/apigateway/api_op_GetUsage.go +++ b/service/apigateway/api_op_GetUsage.go @@ -49,8 +49,8 @@ type GetUsageInput struct { // The Id of the API key associated with the resultant usage data. KeyId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -67,9 +67,9 @@ type GetUsageOutput struct { // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., - // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} + // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]} , where {api_key} // stands for an API key value and the daily log entry is of the format [used - // quota, remaining quota]. + // quota, remaining quota] . Items map[string][][]int64 // The current pagination position in the paged result set. @@ -162,8 +162,8 @@ var _ GetUsageAPIClient = (*Client)(nil) // GetUsagePaginatorOptions is the paginator options for GetUsage type GetUsagePaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetUsagePlan.go b/service/apigateway/api_op_GetUsagePlan.go index 7785720e1bd..fb982c88fe0 100644 --- a/service/apigateway/api_op_GetUsagePlan.go +++ b/service/apigateway/api_op_GetUsagePlan.go @@ -41,11 +41,9 @@ type GetUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using Amazon Web Services Budgets -// (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. +// control costs. Consider using Amazon Web Services Budgets (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) +// to monitor costs and WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// to manage API requests. type GetUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -60,8 +58,8 @@ type GetUsagePlanOutput struct { // The name of a usage plan. Name *string - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS - // product on AWS Marketplace. + // The AWS Markeplace product identifier to associate with the usage plan as a + // SaaS product on AWS Marketplace. ProductCode *string // The target maximum number of permitted requests per a given unit time interval. diff --git a/service/apigateway/api_op_GetUsagePlanKey.go b/service/apigateway/api_op_GetUsagePlanKey.go index b8ce8fb5869..7622b8f0cdd 100644 --- a/service/apigateway/api_op_GetUsagePlanKey.go +++ b/service/apigateway/api_op_GetUsagePlanKey.go @@ -53,7 +53,7 @@ type GetUsagePlanKeyOutput struct { // The name of a usage plan key. Name *string - // The type of a usage plan key. Currently, the valid key type is API_KEY. + // The type of a usage plan key. Currently, the valid key type is API_KEY . Type *string // The value of a usage plan key. diff --git a/service/apigateway/api_op_GetUsagePlanKeys.go b/service/apigateway/api_op_GetUsagePlanKeys.go index 245aa8a4741..d596a346610 100644 --- a/service/apigateway/api_op_GetUsagePlanKeys.go +++ b/service/apigateway/api_op_GetUsagePlanKeys.go @@ -39,8 +39,8 @@ type GetUsagePlanKeysInput struct { // This member is required. UsagePlanId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // A query parameter specifying the name of the to-be-returned usage plan keys. @@ -144,8 +144,8 @@ var _ GetUsagePlanKeysAPIClient = (*Client)(nil) // GetUsagePlanKeysPaginatorOptions is the paginator options for GetUsagePlanKeys type GetUsagePlanKeysPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetUsagePlans.go b/service/apigateway/api_op_GetUsagePlans.go index e10714d0151..a7225b8fe98 100644 --- a/service/apigateway/api_op_GetUsagePlans.go +++ b/service/apigateway/api_op_GetUsagePlans.go @@ -34,8 +34,8 @@ type GetUsagePlansInput struct { // The identifier of the API key associated with the usage plans. KeyId *string - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -131,8 +131,8 @@ var _ GetUsagePlansAPIClient = (*Client)(nil) // GetUsagePlansPaginatorOptions is the paginator options for GetUsagePlans type GetUsagePlansPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_GetVpcLink.go b/service/apigateway/api_op_GetVpcLink.go index 9b4559cbc45..4aaa4de10c9 100644 --- a/service/apigateway/api_op_GetVpcLink.go +++ b/service/apigateway/api_op_GetVpcLink.go @@ -53,9 +53,9 @@ type GetVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, - // or FAILED. Deploying an API will wait if the status is PENDING and will fail if - // the status is DELETING. + // The status of the VPC link. The valid values are AVAILABLE , PENDING , DELETING + // , or FAILED . Deploying an API will wait if the status is PENDING and will fail + // if the status is DELETING . Status types.VpcLinkStatus // A description about the VPC link status. diff --git a/service/apigateway/api_op_GetVpcLinks.go b/service/apigateway/api_op_GetVpcLinks.go index b22b1ff1eee..c74a80501b0 100644 --- a/service/apigateway/api_op_GetVpcLinks.go +++ b/service/apigateway/api_op_GetVpcLinks.go @@ -31,8 +31,8 @@ func (c *Client) GetVpcLinks(ctx context.Context, params *GetVpcLinksInput, optF // Gets the VpcLinks collection under the caller's account in a selected region. type GetVpcLinksInput struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit *int32 // The current pagination position in the paged result set. @@ -128,8 +128,8 @@ var _ GetVpcLinksAPIClient = (*Client)(nil) // GetVpcLinksPaginatorOptions is the paginator options for GetVpcLinks type GetVpcLinksPaginatorOptions struct { - // The maximum number of returned results per page. The default value is 25 and the - // maximum value is 500. + // The maximum number of returned results per page. The default value is 25 and + // the maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apigateway/api_op_ImportApiKeys.go b/service/apigateway/api_op_ImportApiKeys.go index 0917db712b7..9677867f74c 100644 --- a/service/apigateway/api_op_ImportApiKeys.go +++ b/service/apigateway/api_op_ImportApiKeys.go @@ -43,8 +43,8 @@ type ImportApiKeysInput struct { // This member is required. Format types.ApiKeysFormat - // A query parameter to indicate whether to rollback ApiKey importation (true) or - // not (false) when error is encountered. + // A query parameter to indicate whether to rollback ApiKey importation ( true ) or + // not ( false ) when error is encountered. FailOnWarnings bool noSmithyDocumentSerde diff --git a/service/apigateway/api_op_ImportDocumentationParts.go b/service/apigateway/api_op_ImportDocumentationParts.go index c742a85bc31..3b2bea273a6 100644 --- a/service/apigateway/api_op_ImportDocumentationParts.go +++ b/service/apigateway/api_op_ImportDocumentationParts.go @@ -41,13 +41,14 @@ type ImportDocumentationPartsInput struct { // This member is required. RestApiId *string - // A query parameter to specify whether to rollback the documentation importation - // (true) or not (false) when a warning is encountered. The default value is false. + // A query parameter to specify whether to rollback the documentation importation ( + // true ) or not ( false ) when a warning is encountered. The default value is + // false . FailOnWarnings bool - // A query parameter to indicate whether to overwrite (OVERWRITE) any existing - // DocumentationParts definition or to merge (MERGE) the new definition into the - // existing one. The default value is MERGE. + // A query parameter to indicate whether to overwrite ( OVERWRITE ) any existing + // DocumentationParts definition or to merge ( MERGE ) the new definition into the + // existing one. The default value is MERGE . Mode types.PutMode noSmithyDocumentSerde diff --git a/service/apigateway/api_op_ImportRestApi.go b/service/apigateway/api_op_ImportRestApi.go index 42d9a160966..40e3d33061c 100644 --- a/service/apigateway/api_op_ImportRestApi.go +++ b/service/apigateway/api_op_ImportRestApi.go @@ -40,20 +40,20 @@ type ImportRestApiInput struct { // This member is required. Body []byte - // A query parameter to indicate whether to rollback the API creation (true) or not - // (false) when a warning is encountered. The default value is false. + // A query parameter to indicate whether to rollback the API creation ( true ) or + // not ( false ) when a warning is encountered. The default value is false . FailOnWarnings bool // A key-value map of context-specific query string parameters specifying the // behavior of different API importing operations. The following shows // operation-specific parameters and their supported values. To exclude - // DocumentationParts from the import, set parameters as ignore=documentation. To - // configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, - // endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The - // default endpoint type is EDGE. To handle imported basepath, set parameters as - // basepath=ignore, basepath=prepend or basepath=split. For example, the AWS CLI - // command to exclude documentation from the imported API is: The AWS CLI command - // to set the regional endpoint on the imported API is: + // DocumentationParts from the import, set parameters as ignore=documentation . To + // configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE , + // endpointConfigurationTypes=REGIONAL , or endpointConfigurationTypes=PRIVATE . + // The default endpoint type is EDGE . To handle imported basepath , set parameters + // as basepath=ignore , basepath=prepend or basepath=split . For example, the AWS + // CLI command to exclude documentation from the imported API is: The AWS CLI + // command to set the regional endpoint on the imported API is: Parameters map[string]string noSmithyDocumentSerde @@ -62,14 +62,14 @@ type ImportRestApiInput struct { // Represents a REST API. type ImportRestApiOutput struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -93,10 +93,10 @@ type ImportRestApiOutput struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 diff --git a/service/apigateway/api_op_PutGatewayResponse.go b/service/apigateway/api_op_PutGatewayResponse.go index cf140b2f2ae..1d9d062e015 100644 --- a/service/apigateway/api_op_PutGatewayResponse.go +++ b/service/apigateway/api_op_PutGatewayResponse.go @@ -42,12 +42,12 @@ type PutGatewayResponseInput struct { // This member is required. RestApiId *string - // Response parameters (paths, query strings and headers) of the GatewayResponse as - // a string-to-string map of key-value pairs. + // Response parameters (paths, query strings and headers) of the GatewayResponse + // as a string-to-string map of key-value pairs. ResponseParameters map[string]string - // Response templates of the GatewayResponse as a string-to-string map of key-value - // pairs. + // Response templates of the GatewayResponse as a string-to-string map of + // key-value pairs. ResponseTemplates map[string]string // The HTTP status code of the GatewayResponse. @@ -61,16 +61,16 @@ type PutGatewayResponseInput struct { type PutGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway - // response (true) or not (false). A default gateway response is one generated by - // API Gateway without any customization by an API developer. + // response ( true ) or not ( false ). A default gateway response is one generated + // by API Gateway without any customization by an API developer. DefaultResponse bool - // Response parameters (paths, query strings and headers) of the GatewayResponse as - // a string-to-string map of key-value pairs. + // Response parameters (paths, query strings and headers) of the GatewayResponse + // as a string-to-string map of key-value pairs. ResponseParameters map[string]string - // Response templates of the GatewayResponse as a string-to-string map of key-value - // pairs. + // Response templates of the GatewayResponse as a string-to-string map of + // key-value pairs. ResponseTemplates map[string]string // The response type of the associated GatewayResponse. diff --git a/service/apigateway/api_op_PutIntegration.go b/service/apigateway/api_op_PutIntegration.go index e02b431a12f..e9593303dfa 100644 --- a/service/apigateway/api_op_PutIntegration.go +++ b/service/apigateway/api_op_PutIntegration.go @@ -50,13 +50,13 @@ type PutIntegrationInput struct { // This member is required. Type types.IntegrationType - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters , these parameters must also be specified for + // Method requestParameters . CacheKeyParameters []string - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace . You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string @@ -66,13 +66,13 @@ type PutIntegrationInput struct { ConnectionId *string // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. + // is INTERNET for connections through the public routable internet or VPC_LINK + // for private connections between API Gateway and a network load balancer in a + // VPC. The default value is INTERNET . ConnectionType types.ConnectionType // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the request payload will be passed through from // the method request to integration request without modification, provided that // the passthroughBehavior is configured to support payload pass-through. @@ -87,7 +87,7 @@ type PutIntegrationInput struct { // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There - // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. + // are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . PassthroughBehavior *string // A key-value map specifying request parameters that are passed from the method @@ -95,8 +95,8 @@ type PutIntegrationInput struct { // the associated value is a method request parameter value or static value that // must be enclosed within single quotes and pre-encoded as required by the back // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. + // method.request.{location}.{name} , where location is querystring , path , or + // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -112,13 +112,13 @@ type PutIntegrationInput struct { TlsConfig *types.TlsConfig // Specifies Uniform Resource Identifier (URI) of the integration endpoint. For - // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) - // URL according to the RFC-3986 specification, for either standard integration, - // where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification, for either standard + // integration, where connectionType is not VPC_LINK , or private integration, + // where connectionType is VPC_LINK . For a private HTTP integration, the URI is + // not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api + // }. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain Amazon Web Services service for // fast host-name lookup. action can be used for an Amazon Web Services service @@ -128,9 +128,9 @@ type PutIntegrationInput struct { // service path-based API. The ensuing service_api refers to the path to an Amazon // Web Services service resource, including the region of the integrated Amazon Web // Services service, if applicable. For example, for integration with the S3 API of - // GetObject, the uri can be either + // GetObject , the uri can be either // arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or - // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}. + // arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key} . Uri *string noSmithyDocumentSerde @@ -139,13 +139,13 @@ type PutIntegrationInput struct { // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. type PutIntegrationOutput struct { - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters , these parameters must also be specified for + // Method requestParameters . CacheKeyParameters []string - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace . You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string @@ -155,13 +155,13 @@ type PutIntegrationOutput struct { ConnectionId *string // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. + // is INTERNET for connections through the public routable internet or VPC_LINK + // for private connections between API Gateway and a network load balancer in a + // VPC. The default value is INTERNET . ConnectionType types.ConnectionType // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the request payload will be passed through from // the method request to integration request without modification, provided that // the passthroughBehavior is configured to support payload pass-through. @@ -171,7 +171,7 @@ type PutIntegrationOutput struct { // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS // services, specify null. Credentials *string @@ -181,23 +181,23 @@ type PutIntegrationOutput struct { // Specifies the integration's responses. IntegrationResponses map[string]types.IntegrationResponse - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A + // Specifies how the method request body of an unmapped content type will be + // passed through the integration request to the back end without transformation. A // content type is unmapped if no mapping template is defined in the integration or // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes - // the method request body through the integration request to the back end without - // transformation when the method request content type does not match any content - // type associated with the mapping templates defined in the integration request. - // WHEN_NO_TEMPLATES: passes the method request body through the integration - // request to the back end without transformation when no mapping template is - // defined in the integration request. If a template is defined when this option is - // selected, the method request of an unmapped content-type will be rejected with - // an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request - // with an HTTP 415 Unsupported Media Type response when either the method request - // content type does not match any content type associated with the mapping - // templates defined in the integration request or no mapping template is defined - // in the integration request. + // requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. WHEN_NO_TEMPLATES : passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the + // method request with an HTTP 415 Unsupported Media Type response when either the + // method request content type does not match any content type associated with the + // mapping templates defined in the integration request or no mapping template is + // defined in the integration request. PassthroughBehavior *string // A key-value map specifying request parameters that are passed from the method @@ -205,8 +205,8 @@ type PutIntegrationOutput struct { // the associated value is a method request parameter value or static value that // must be enclosed within single quotes and pre-encoded as required by the back // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. + // method.request.{location}.{name} , where location is querystring , path , or + // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -223,20 +223,20 @@ type PutIntegrationOutput struct { // Specifies an API method integration type. The valid value is one of the // following: For the HTTP and HTTP proxy integrations, each integration can - // specify a protocol (http/https), port and path. Standard 80 and 443 ports are + // specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are // supported as well as custom ports above 1024. An HTTP or HTTP proxy integration // with a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType // Specifies Uniform Resource Identifier (URI) of the integration endpoint. For - // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) - // URL according to the RFC-3986 specification, for either standard integration, - // where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification, for either standard + // integration, where connectionType is not VPC_LINK , or private integration, + // where connectionType is VPC_LINK . For a private HTTP integration, the URI is + // not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} + // . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain Amazon Web Services service for // fast host-name lookup. action can be used for an Amazon Web Services service diff --git a/service/apigateway/api_op_PutIntegrationResponse.go b/service/apigateway/api_op_PutIntegrationResponse.go index 9de12ba328c..479462979f3 100644 --- a/service/apigateway/api_op_PutIntegrationResponse.go +++ b/service/apigateway/api_op_PutIntegrationResponse.go @@ -52,7 +52,7 @@ type PutIntegrationResponseInput struct { StatusCode *string // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy @@ -62,10 +62,10 @@ type PutIntegrationResponseInput struct { // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of - // method.response.header.{name}, where name is a valid and unique header name. The - // mapped non-static value must match the pattern of + // method.response.header.{name} , where name is a valid and unique header name. + // The mapped non-static value must match the pattern of // integration.response.header.{name} or - // integration.response.body.{JSON-expression}, where name must be a valid and + // integration.response.body.{JSON-expression} , where name must be a valid and // unique response header name and JSON-expression a valid JSON expression without // the $ prefix. ResponseParameters map[string]string @@ -85,7 +85,7 @@ type PutIntegrationResponseInput struct { type PutIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy @@ -95,10 +95,10 @@ type PutIntegrationResponseOutput struct { // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of - // method.response.header.{name}, where name is a valid and unique header name. The - // mapped non-static value must match the pattern of + // method.response.header.{name} , where name is a valid and unique header name. + // The mapped non-static value must match the pattern of // integration.response.header.{name} or - // integration.response.body.{JSON-expression}, where name is a valid and unique + // integration.response.body.{JSON-expression} , where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]string @@ -112,9 +112,9 @@ type PutIntegrationResponseOutput struct { // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could // use the .+ regex to match error response. However, make sure that the error - // response does not contain any newline (\n) character in such cases. If the back - // end is an AWS Lambda function, the AWS Lambda function error header is matched. - // For all other HTTP and AWS back ends, the HTTP status code is matched. + // response does not contain any newline ( \n ) character in such cases. If the + // back end is an AWS Lambda function, the AWS Lambda function error header is + // matched. For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string // Specifies the status code that is used to map the integration response to an diff --git a/service/apigateway/api_op_PutMethod.go b/service/apigateway/api_op_PutMethod.go index e1ff8c6ac70..2a10c0a006f 100644 --- a/service/apigateway/api_op_PutMethod.go +++ b/service/apigateway/api_op_PutMethod.go @@ -80,14 +80,14 @@ type PutMethodInput struct { // Model name as the value. RequestModels map[string]string - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key defines a method request parameter name - // matching the pattern of method.request.{location}.{name}, where location is - // querystring, path, or header and name is a valid and unique parameter name. The - // value associated with the key is a Boolean flag indicating whether the parameter - // is required (true) or optional (false). The method request parameter names - // defined here are available in Integration to be mapped to integration request - // parameters or body-mapping templates. + // A key-value map defining required or optional method request parameters that + // can be accepted by API Gateway. A key defines a method request parameter name + // matching the pattern of method.request.{location}.{name} , where location is + // querystring , path , or header and name is a valid and unique parameter name. + // The value associated with the key is a Boolean flag indicating whether the + // parameter is required ( true ) or optional ( false ). The method request + // parameter names defined here are available in Integration to be mapped to + // integration request parameters or body-mapping templates. RequestParameters map[string]bool // The identifier of a RequestValidator for validating the method request. @@ -96,8 +96,8 @@ type PutMethodInput struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to access -// back-end resources. A Method resource is integrated with an Integration +// Represents a client-facing interface by which the client calls the API to +// access back-end resources. A Method resource is integrated with an Integration // resource. Both consist of a request and one or more responses. The method // request takes the client input that is passed to the back end through the // integration request. A method response returns the output from the back end to @@ -128,7 +128,7 @@ type PutMethodOutput struct { AuthorizationType *string // The identifier of an Authorizer to use on this method. The authorizationType - // must be CUSTOM. + // must be CUSTOM . AuthorizerId *string // The method's HTTP verb. @@ -147,19 +147,19 @@ type PutMethodOutput struct { // example. OperationName *string - // A key-value map specifying data schemas, represented by Model resources, (as the - // mapped value) of the request payloads of given content types (as the mapping + // A key-value map specifying data schemas, represented by Model resources, (as + // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]string - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration to be mapped to integration request parameters - // or templates. + // A key-value map defining required or optional method request parameters that + // can be accepted by API Gateway. A key is a method request parameter name + // matching the pattern of method.request.{location}.{name} , where location is + // querystring , path , or header and name is a valid and unique parameter name. + // The value associated with the key is a Boolean flag indicating whether the + // parameter is required ( true ) or optional ( false ). The method request + // parameter names defined here are available in Integration to be mapped to + // integration request parameters or templates. RequestParameters map[string]bool // The identifier of a RequestValidator for request validation. diff --git a/service/apigateway/api_op_PutMethodResponse.go b/service/apigateway/api_op_PutMethodResponse.go index e2f43d59520..a7d602064b2 100644 --- a/service/apigateway/api_op_PutMethodResponse.go +++ b/service/apigateway/api_op_PutMethodResponse.go @@ -58,21 +58,21 @@ type PutMethodResponseInput struct { // Gateway can send back to the caller. A key defines a method response header name // and the associated value is a Boolean flag indicating whether the method // response parameter is required or not. The method response header names must - // match the pattern of method.response.header.{name}, where name is a valid and + // match the pattern of method.response.header.{name} , where name is a valid and // unique header name. The response parameter names defined here are available in // the integration response to be mapped from an integration response header - // expressed in integration.response.header.{name}, a static value enclosed within - // a pair of single quotes (e.g., 'application/json'), or a JSON expression from + // expressed in integration.response.header.{name} , a static value enclosed within + // a pair of single quotes (e.g., 'application/json' ), or a JSON expression from // the back-end response payload in the form of - // integration.response.body.{JSON-expression}, where JSON-expression is a valid + // integration.response.body.{JSON-expression} , where JSON-expression is a valid // JSON expression without the $ prefix.) ResponseParameters map[string]bool noSmithyDocumentSerde } -// Represents a method response of a given HTTP status code returned to the client. -// The method response is passed from the back end through the associated +// Represents a method response of a given HTTP status code returned to the +// client. The method response is passed from the back end through the associated // integration response that can be transformed using a mapping template. type PutMethodResponseOutput struct { @@ -85,14 +85,14 @@ type PutMethodResponseOutput struct { // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or // not. The expression of the key must match the pattern - // method.response.header.{name}, where name is a valid and unique header name. API - // Gateway passes certain integration response data to the method response headers - // specified here according to the mapping you prescribe in the API's + // method.response.header.{name} , where name is a valid and unique header name. + // API Gateway passes certain integration response data to the method response + // headers specified here according to the mapping you prescribe in the API's // IntegrationResponse. The integration response data that can be mapped include an - // integration response header expressed in integration.response.header.{name}, a - // static value enclosed within a pair of single quotes (e.g., 'application/json'), - // or a JSON expression from the back-end response payload in the form of - // integration.response.body.{JSON-expression}, where JSON-expression is a valid + // integration response header expressed in integration.response.header.{name} , a + // static value enclosed within a pair of single quotes (e.g., 'application/json' + // ), or a JSON expression from the back-end response payload in the form of + // integration.response.body.{JSON-expression} , where JSON-expression is a valid // JSON expression without the $ prefix.) ResponseParameters map[string]bool diff --git a/service/apigateway/api_op_PutRestApi.go b/service/apigateway/api_op_PutRestApi.go index b130867a2c5..287f0a9ba34 100644 --- a/service/apigateway/api_op_PutRestApi.go +++ b/service/apigateway/api_op_PutRestApi.go @@ -30,8 +30,8 @@ func (c *Client) PutRestApi(ctx context.Context, params *PutRestApiInput, optFns return out, nil } -// A PUT request to update an existing API, with external API definitions specified -// as the request body. +// A PUT request to update an existing API, with external API definitions +// specified as the request body. type PutRestApiInput struct { // The PUT request body containing external API definitions. Currently, only @@ -46,8 +46,8 @@ type PutRestApiInput struct { // This member is required. RestApiId *string - // A query parameter to indicate whether to rollback the API update (true) or not - // (false) when a warning is encountered. The default value is false. + // A query parameter to indicate whether to rollback the API update ( true ) or not + // ( false ) when a warning is encountered. The default value is false . FailOnWarnings bool // The mode query parameter to specify the update mode. Valid values are "merge" @@ -58,7 +58,7 @@ type PutRestApiInput struct { // DocumentationParts from an imported API, set ignore=documentation as a // parameters value, as in the AWS CLI command of aws apigateway import-rest-api // --parameters ignore=documentation --body - // 'file:///path/to/imported-api-body.json'. + // 'file:///path/to/imported-api-body.json' . Parameters map[string]string noSmithyDocumentSerde @@ -67,14 +67,14 @@ type PutRestApiInput struct { // Represents a REST API. type PutRestApiOutput struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -98,10 +98,10 @@ type PutRestApiOutput struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 diff --git a/service/apigateway/api_op_TagResource.go b/service/apigateway/api_op_TagResource.go index 592325a8fc9..02180c8e400 100644 --- a/service/apigateway/api_op_TagResource.go +++ b/service/apigateway/api_op_TagResource.go @@ -35,7 +35,7 @@ type TagResourceInput struct { ResourceArn *string // The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The - // tag key can be up to 128 characters and must not start with aws:. The tag value + // tag key can be up to 128 characters and must not start with aws: . The tag value // can be up to 256 characters. // // This member is required. diff --git a/service/apigateway/api_op_UpdateAccount.go b/service/apigateway/api_op_UpdateAccount.go index ea261e2aace..f87afeca72e 100644 --- a/service/apigateway/api_op_UpdateAccount.go +++ b/service/apigateway/api_op_UpdateAccount.go @@ -30,8 +30,8 @@ func (c *Client) UpdateAccount(ctx context.Context, params *UpdateAccountInput, // Requests API Gateway to change information about the current Account resource. type UpdateAccountInput struct { - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -47,7 +47,7 @@ type UpdateAccountOutput struct { CloudwatchRoleArn *string // A list of features supported for the account. When usage plans are enabled, the - // features list will include an entry of "UsagePlans". + // features list will include an entry of "UsagePlans" . Features []string // Specifies the API request limits configured for the current Account. diff --git a/service/apigateway/api_op_UpdateApiKey.go b/service/apigateway/api_op_UpdateApiKey.go index 7fd799a1e64..5d03cafba74 100644 --- a/service/apigateway/api_op_UpdateApiKey.go +++ b/service/apigateway/api_op_UpdateApiKey.go @@ -36,8 +36,8 @@ type UpdateApiKeyInput struct { // This member is required. ApiKey *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateAuthorizer.go b/service/apigateway/api_op_UpdateAuthorizer.go index f03710ca5f0..226b8a52b26 100644 --- a/service/apigateway/api_op_UpdateAuthorizer.go +++ b/service/apigateway/api_op_UpdateAuthorizer.go @@ -40,8 +40,8 @@ type UpdateAuthorizerInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -70,13 +70,13 @@ type UpdateAuthorizerOutput struct { // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations + // . In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. + // including the initial / . For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations . AuthorizerUri *string // The identifier for the authorizer resource. @@ -85,13 +85,13 @@ type UpdateAuthorizerOutput struct { // The identity source for which authorization is requested. For a TOKEN or // COGNITO_USER_POOLS authorizer, this is required and specifies the request header // mapping expression for the custom header holding the authorization token - // submitted by the client. For example, if the token header name is Auth, the - // header mapping expression is method.request.header.Auth. For the REQUEST + // submitted by the client. For example, if the token header name is Auth , the + // header mapping expression is method.request.header.Auth . For the REQUEST // authorizer, this is required when authorization caching is enabled. The value is // a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string // parameter are defined as identity sources, this value is - // method.request.header.Auth, method.request.querystring.Name. These parameters + // method.request.header.Auth , method.request.querystring.Name . These parameters // will be used to derive the authorization caching key and to perform runtime // validation of the REQUEST authorizer by verifying all of the identity-related // request parameters are present, not null and non-empty. Only when this is true @@ -116,14 +116,14 @@ type UpdateAuthorizerOutput struct { // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. + // The authorizer type. Valid values are TOKEN for a Lambda function using a + // single authorization token submitted in a custom header, REQUEST for a Lambda + // function using incoming request parameters, and COGNITO_USER_POOLS for using an + // Amazon Cognito user pool. Type types.AuthorizerType // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_UpdateBasePathMapping.go b/service/apigateway/api_op_UpdateBasePathMapping.go index 6b195fc143c..b7eb86831f5 100644 --- a/service/apigateway/api_op_UpdateBasePathMapping.go +++ b/service/apigateway/api_op_UpdateBasePathMapping.go @@ -31,7 +31,7 @@ func (c *Client) UpdateBasePathMapping(ctx context.Context, params *UpdateBasePa type UpdateBasePathMappingInput struct { // The base path of the BasePathMapping resource to change. To specify an empty - // base path, set this parameter to '(none)'. + // base path, set this parameter to '(none)' . // // This member is required. BasePath *string @@ -41,19 +41,19 @@ type UpdateBasePathMappingInput struct { // This member is required. DomainName *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents the base path that callers of the API must provide as part of the URL -// after the domain name. +// Represents the base path that callers of the API must provide as part of the +// URL after the domain name. type UpdateBasePathMappingOutput struct { - // The base path name that callers of the API must provide as part of the URL after - // the domain name. + // The base path name that callers of the API must provide as part of the URL + // after the domain name. BasePath *string // The string identifier of the associated RestApi. diff --git a/service/apigateway/api_op_UpdateClientCertificate.go b/service/apigateway/api_op_UpdateClientCertificate.go index f6bd1a3eaac..2d2ded6dbed 100644 --- a/service/apigateway/api_op_UpdateClientCertificate.go +++ b/service/apigateway/api_op_UpdateClientCertificate.go @@ -36,15 +36,15 @@ type UpdateClientCertificateInput struct { // This member is required. ClientCertificateId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents a client certificate used to configure client-side SSL authentication -// while sending requests to the integration endpoint. +// Represents a client certificate used to configure client-side SSL +// authentication while sending requests to the integration endpoint. type UpdateClientCertificateOutput struct { // The identifier of the client certificate. diff --git a/service/apigateway/api_op_UpdateDeployment.go b/service/apigateway/api_op_UpdateDeployment.go index 1dcdb8420bb..3ce60f275aa 100644 --- a/service/apigateway/api_op_UpdateDeployment.go +++ b/service/apigateway/api_op_UpdateDeployment.go @@ -42,8 +42,8 @@ type UpdateDeploymentInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateDocumentationPart.go b/service/apigateway/api_op_UpdateDocumentationPart.go index 8f7c43799fd..5481b755d02 100644 --- a/service/apigateway/api_op_UpdateDocumentationPart.go +++ b/service/apigateway/api_op_UpdateDocumentationPart.go @@ -40,8 +40,8 @@ type UpdateDocumentationPartInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -63,10 +63,10 @@ type UpdateDocumentationPartOutput struct { // A content map of API-specific key-value pairs describing the targeted API // entity. The map must be encoded as a JSON string, e.g., "{ \"description\": - // \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields + // \"The API does ...\" }" . Only OpenAPI-compliant documentation-related fields // from the properties map are exported and, hence, published as part of the API // entity definitions, while the original documentation parts are exported in a - // OpenAPI extension of x-amazon-apigateway-documentation. + // OpenAPI extension of x-amazon-apigateway-documentation . Properties *string // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_UpdateDocumentationVersion.go b/service/apigateway/api_op_UpdateDocumentationVersion.go index 12fd6e65aca..d0890d25964 100644 --- a/service/apigateway/api_op_UpdateDocumentationVersion.go +++ b/service/apigateway/api_op_UpdateDocumentationVersion.go @@ -41,8 +41,8 @@ type UpdateDocumentationVersionInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateDomainName.go b/service/apigateway/api_op_UpdateDomainName.go index fb7a3cf9081..aaaff90124c 100644 --- a/service/apigateway/api_op_UpdateDomainName.go +++ b/service/apigateway/api_op_UpdateDomainName.go @@ -36,8 +36,8 @@ type UpdateDomainNameInput struct { // This member is required. DomainName *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -73,12 +73,12 @@ type UpdateDomainNameOutput struct { // Endpoints for API Gateway. DistributionHostedZoneId *string - // The custom domain name as an API host name, for example, my-api.example.com. + // The custom domain name as an API host name, for example, my-api.example.com . DomainName *string // The status of the DomainName migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be + // UPDATING . If the status is UPDATING , the domain cannot be modified further + // until the existing operation is complete. If it is AVAILABLE , the domain can be // updated. DomainNameStatus types.DomainNameStatus @@ -100,12 +100,12 @@ type UpdateDomainNameOutput struct { // imported or private CA certificate ARN as the regionalCertificateArn. OwnershipVerificationCertificateArn *string - // The reference to an AWS-managed certificate that will be used for validating the - // regional domain name. AWS Certificate Manager is the only supported source. + // The reference to an AWS-managed certificate that will be used for validating + // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The name of the certificate that will be used for validating the regional domain - // name. + // The name of the certificate that will be used for validating the regional + // domain name. RegionalCertificateName *string // The domain name associated with the regional endpoint for this custom domain @@ -114,13 +114,13 @@ type UpdateDomainNameOutput struct { // by API Gateway when you create a regional endpoint. RegionalDomainName *string - // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For - // more information, see Set up a Regional Custom Domain Name and AWS Regions and - // Endpoints for API Gateway. + // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. + // For more information, see Set up a Regional Custom Domain Name and AWS Regions + // and Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. - // The valid values are TLS_1_0 and TLS_1_2. + // The valid values are TLS_1_0 and TLS_1_2 . SecurityPolicy types.SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. diff --git a/service/apigateway/api_op_UpdateGatewayResponse.go b/service/apigateway/api_op_UpdateGatewayResponse.go index cba0883e845..c5acf58f10b 100644 --- a/service/apigateway/api_op_UpdateGatewayResponse.go +++ b/service/apigateway/api_op_UpdateGatewayResponse.go @@ -40,8 +40,8 @@ type UpdateGatewayResponseInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -52,16 +52,16 @@ type UpdateGatewayResponseInput struct { type UpdateGatewayResponseOutput struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway - // response (true) or not (false). A default gateway response is one generated by - // API Gateway without any customization by an API developer. + // response ( true ) or not ( false ). A default gateway response is one generated + // by API Gateway without any customization by an API developer. DefaultResponse bool - // Response parameters (paths, query strings and headers) of the GatewayResponse as - // a string-to-string map of key-value pairs. + // Response parameters (paths, query strings and headers) of the GatewayResponse + // as a string-to-string map of key-value pairs. ResponseParameters map[string]string - // Response templates of the GatewayResponse as a string-to-string map of key-value - // pairs. + // Response templates of the GatewayResponse as a string-to-string map of + // key-value pairs. ResponseTemplates map[string]string // The response type of the associated GatewayResponse. diff --git a/service/apigateway/api_op_UpdateIntegration.go b/service/apigateway/api_op_UpdateIntegration.go index caa0ce45cfe..af2b3bf4dc2 100644 --- a/service/apigateway/api_op_UpdateIntegration.go +++ b/service/apigateway/api_op_UpdateIntegration.go @@ -45,8 +45,8 @@ type UpdateIntegrationInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -55,13 +55,13 @@ type UpdateIntegrationInput struct { // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. type UpdateIntegrationOutput struct { - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters , these parameters must also be specified for + // Method requestParameters . CacheKeyParameters []string - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace . You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string @@ -71,13 +71,13 @@ type UpdateIntegrationOutput struct { ConnectionId *string // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. + // is INTERNET for connections through the public routable internet or VPC_LINK + // for private connections between API Gateway and a network load balancer in a + // VPC. The default value is INTERNET . ConnectionType types.ConnectionType // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the request payload will be passed through from // the method request to integration request without modification, provided that // the passthroughBehavior is configured to support payload pass-through. @@ -87,7 +87,7 @@ type UpdateIntegrationOutput struct { // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS // services, specify null. Credentials *string @@ -97,23 +97,23 @@ type UpdateIntegrationOutput struct { // Specifies the integration's responses. IntegrationResponses map[string]types.IntegrationResponse - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A + // Specifies how the method request body of an unmapped content type will be + // passed through the integration request to the back end without transformation. A // content type is unmapped if no mapping template is defined in the integration or // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes - // the method request body through the integration request to the back end without - // transformation when the method request content type does not match any content - // type associated with the mapping templates defined in the integration request. - // WHEN_NO_TEMPLATES: passes the method request body through the integration - // request to the back end without transformation when no mapping template is - // defined in the integration request. If a template is defined when this option is - // selected, the method request of an unmapped content-type will be rejected with - // an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request - // with an HTTP 415 Unsupported Media Type response when either the method request - // content type does not match any content type associated with the mapping - // templates defined in the integration request or no mapping template is defined - // in the integration request. + // requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. WHEN_NO_TEMPLATES : passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the + // method request with an HTTP 415 Unsupported Media Type response when either the + // method request content type does not match any content type associated with the + // mapping templates defined in the integration request or no mapping template is + // defined in the integration request. PassthroughBehavior *string // A key-value map specifying request parameters that are passed from the method @@ -121,8 +121,8 @@ type UpdateIntegrationOutput struct { // the associated value is a method request parameter value or static value that // must be enclosed within single quotes and pre-encoded as required by the back // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. + // method.request.{location}.{name} , where location is querystring , path , or + // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -139,20 +139,20 @@ type UpdateIntegrationOutput struct { // Specifies an API method integration type. The valid value is one of the // following: For the HTTP and HTTP proxy integrations, each integration can - // specify a protocol (http/https), port and path. Standard 80 and 443 ports are + // specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are // supported as well as custom ports above 1024. An HTTP or HTTP proxy integration // with a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type types.IntegrationType // Specifies Uniform Resource Identifier (URI) of the integration endpoint. For - // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) - // URL according to the RFC-3986 specification, for either standard integration, - // where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification, for either standard + // integration, where connectionType is not VPC_LINK , or private integration, + // where connectionType is VPC_LINK . For a private HTTP integration, the URI is + // not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} + // . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain Amazon Web Services service for // fast host-name lookup. action can be used for an Amazon Web Services service diff --git a/service/apigateway/api_op_UpdateIntegrationResponse.go b/service/apigateway/api_op_UpdateIntegrationResponse.go index becaf6ac851..2a9a40d0e0d 100644 --- a/service/apigateway/api_op_UpdateIntegrationResponse.go +++ b/service/apigateway/api_op_UpdateIntegrationResponse.go @@ -50,8 +50,8 @@ type UpdateIntegrationResponseInput struct { // This member is required. StatusCode *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -63,7 +63,7 @@ type UpdateIntegrationResponseInput struct { type UpdateIntegrationResponseOutput struct { // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling types.ContentHandlingStrategy @@ -73,10 +73,10 @@ type UpdateIntegrationResponseOutput struct { // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of - // method.response.header.{name}, where name is a valid and unique header name. The - // mapped non-static value must match the pattern of + // method.response.header.{name} , where name is a valid and unique header name. + // The mapped non-static value must match the pattern of // integration.response.header.{name} or - // integration.response.body.{JSON-expression}, where name is a valid and unique + // integration.response.body.{JSON-expression} , where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]string @@ -90,9 +90,9 @@ type UpdateIntegrationResponseOutput struct { // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could // use the .+ regex to match error response. However, make sure that the error - // response does not contain any newline (\n) character in such cases. If the back - // end is an AWS Lambda function, the AWS Lambda function error header is matched. - // For all other HTTP and AWS back ends, the HTTP status code is matched. + // response does not contain any newline ( \n ) character in such cases. If the + // back end is an AWS Lambda function, the AWS Lambda function error header is + // matched. For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string // Specifies the status code that is used to map the integration response to an diff --git a/service/apigateway/api_op_UpdateMethod.go b/service/apigateway/api_op_UpdateMethod.go index d0281867896..08a4c58e0f8 100644 --- a/service/apigateway/api_op_UpdateMethod.go +++ b/service/apigateway/api_op_UpdateMethod.go @@ -45,15 +45,15 @@ type UpdateMethodInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to access -// back-end resources. A Method resource is integrated with an Integration +// Represents a client-facing interface by which the client calls the API to +// access back-end resources. A Method resource is integrated with an Integration // resource. Both consist of a request and one or more responses. The method // request takes the client input that is passed to the back end through the // integration request. A method response returns the output from the back end to @@ -84,7 +84,7 @@ type UpdateMethodOutput struct { AuthorizationType *string // The identifier of an Authorizer to use on this method. The authorizationType - // must be CUSTOM. + // must be CUSTOM . AuthorizerId *string // The method's HTTP verb. @@ -103,19 +103,19 @@ type UpdateMethodOutput struct { // example. OperationName *string - // A key-value map specifying data schemas, represented by Model resources, (as the - // mapped value) of the request payloads of given content types (as the mapping + // A key-value map specifying data schemas, represented by Model resources, (as + // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]string - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration to be mapped to integration request parameters - // or templates. + // A key-value map defining required or optional method request parameters that + // can be accepted by API Gateway. A key is a method request parameter name + // matching the pattern of method.request.{location}.{name} , where location is + // querystring , path , or header and name is a valid and unique parameter name. + // The value associated with the key is a Boolean flag indicating whether the + // parameter is required ( true ) or optional ( false ). The method request + // parameter names defined here are available in Integration to be mapped to + // integration request parameters or templates. RequestParameters map[string]bool // The identifier of a RequestValidator for request validation. diff --git a/service/apigateway/api_op_UpdateMethodResponse.go b/service/apigateway/api_op_UpdateMethodResponse.go index 583354eba03..4851ddc8851 100644 --- a/service/apigateway/api_op_UpdateMethodResponse.go +++ b/service/apigateway/api_op_UpdateMethodResponse.go @@ -50,15 +50,15 @@ type UpdateMethodResponseInput struct { // This member is required. StatusCode *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde } -// Represents a method response of a given HTTP status code returned to the client. -// The method response is passed from the back end through the associated +// Represents a method response of a given HTTP status code returned to the +// client. The method response is passed from the back end through the associated // integration response that can be transformed using a mapping template. type UpdateMethodResponseOutput struct { @@ -71,14 +71,14 @@ type UpdateMethodResponseOutput struct { // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or // not. The expression of the key must match the pattern - // method.response.header.{name}, where name is a valid and unique header name. API - // Gateway passes certain integration response data to the method response headers - // specified here according to the mapping you prescribe in the API's + // method.response.header.{name} , where name is a valid and unique header name. + // API Gateway passes certain integration response data to the method response + // headers specified here according to the mapping you prescribe in the API's // IntegrationResponse. The integration response data that can be mapped include an - // integration response header expressed in integration.response.header.{name}, a - // static value enclosed within a pair of single quotes (e.g., 'application/json'), - // or a JSON expression from the back-end response payload in the form of - // integration.response.body.{JSON-expression}, where JSON-expression is a valid + // integration response header expressed in integration.response.header.{name} , a + // static value enclosed within a pair of single quotes (e.g., 'application/json' + // ), or a JSON expression from the back-end response payload in the form of + // integration.response.body.{JSON-expression} , where JSON-expression is a valid // JSON expression without the $ prefix.) ResponseParameters map[string]bool diff --git a/service/apigateway/api_op_UpdateModel.go b/service/apigateway/api_op_UpdateModel.go index 5464dcc876e..897ac24af9e 100644 --- a/service/apigateway/api_op_UpdateModel.go +++ b/service/apigateway/api_op_UpdateModel.go @@ -40,8 +40,8 @@ type UpdateModelInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateRequestValidator.go b/service/apigateway/api_op_UpdateRequestValidator.go index 658b520e34c..ec7069a873e 100644 --- a/service/apigateway/api_op_UpdateRequestValidator.go +++ b/service/apigateway/api_op_UpdateRequestValidator.go @@ -40,8 +40,8 @@ type UpdateRequestValidatorInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -60,8 +60,8 @@ type UpdateRequestValidatorOutput struct { // configured Model schema. ValidateRequestBody bool - // A Boolean flag to indicate whether to validate request parameters (true) or not - // (false). + // A Boolean flag to indicate whether to validate request parameters ( true ) or + // not ( false ). ValidateRequestParameters bool // Metadata pertaining to the operation's result. diff --git a/service/apigateway/api_op_UpdateResource.go b/service/apigateway/api_op_UpdateResource.go index f945bf64c24..d6a5fa4f8d0 100644 --- a/service/apigateway/api_op_UpdateResource.go +++ b/service/apigateway/api_op_UpdateResource.go @@ -40,8 +40,8 @@ type UpdateResourceInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateRestApi.go b/service/apigateway/api_op_UpdateRestApi.go index d81a47a3992..d49a0495781 100644 --- a/service/apigateway/api_op_UpdateRestApi.go +++ b/service/apigateway/api_op_UpdateRestApi.go @@ -36,8 +36,8 @@ type UpdateRestApiInput struct { // This member is required. RestApiId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -46,14 +46,14 @@ type UpdateRestApiInput struct { // Represents a REST API. type UpdateRestApiOutput struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource types.ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -77,10 +77,10 @@ type UpdateRestApiOutput struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 diff --git a/service/apigateway/api_op_UpdateStage.go b/service/apigateway/api_op_UpdateStage.go index f8f8dfa5189..0cd7f39ca82 100644 --- a/service/apigateway/api_op_UpdateStage.go +++ b/service/apigateway/api_op_UpdateStage.go @@ -41,8 +41,8 @@ type UpdateStageInput struct { // This member is required. StageName *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -59,8 +59,8 @@ type UpdateStageOutput struct { CacheClusterEnabled bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize types.CacheClusterSize // The status of the cache cluster for the stage, if enabled. @@ -87,8 +87,8 @@ type UpdateStageOutput struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // A map that defines the method settings for a Stage resource. Keys (designated as - // /{method_setting_key below) are method paths defined as + // A map that defines the method settings for a Stage resource. Keys (designated + // as /{method_setting_key below) are method paths defined as // {resource_path}/{http_method} for an individual method override, or /\*/\* for // overriding all methods in the stage. MethodSettings map[string]types.MethodSetting @@ -107,7 +107,7 @@ type UpdateStageOutput struct { // A map that defines the stage variables for a Stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. + // [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string // The ARN of the WebAcl associated with the Stage. diff --git a/service/apigateway/api_op_UpdateUsage.go b/service/apigateway/api_op_UpdateUsage.go index e9fb9ef2b0b..f6017968d57 100644 --- a/service/apigateway/api_op_UpdateUsage.go +++ b/service/apigateway/api_op_UpdateUsage.go @@ -43,8 +43,8 @@ type UpdateUsageInput struct { // This member is required. UsagePlanId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -58,9 +58,9 @@ type UpdateUsageOutput struct { // The usage data, as daily logs of used and remaining quotas, over the specified // time interval indexed over the API keys in a usage plan. For example, {..., - // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} + // "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]} , where {api_key} // stands for an API key value and the daily log entry is of the format [used - // quota, remaining quota]. + // quota, remaining quota] . Items map[string][][]int64 // The current pagination position in the paged result set. diff --git a/service/apigateway/api_op_UpdateUsagePlan.go b/service/apigateway/api_op_UpdateUsagePlan.go index 4ad5f53a052..d14f1478387 100644 --- a/service/apigateway/api_op_UpdateUsagePlan.go +++ b/service/apigateway/api_op_UpdateUsagePlan.go @@ -35,8 +35,8 @@ type UpdateUsagePlanInput struct { // This member is required. UsagePlanId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -45,11 +45,9 @@ type UpdateUsagePlanInput struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using Amazon Web Services Budgets -// (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. +// control costs. Consider using Amazon Web Services Budgets (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) +// to monitor costs and WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// to manage API requests. type UpdateUsagePlanOutput struct { // The associated API stages of a usage plan. @@ -64,8 +62,8 @@ type UpdateUsagePlanOutput struct { // The name of a usage plan. Name *string - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS - // product on AWS Marketplace. + // The AWS Markeplace product identifier to associate with the usage plan as a + // SaaS product on AWS Marketplace. ProductCode *string // The target maximum number of permitted requests per a given unit time interval. diff --git a/service/apigateway/api_op_UpdateVpcLink.go b/service/apigateway/api_op_UpdateVpcLink.go index 2b424e5721d..d7b377cf711 100644 --- a/service/apigateway/api_op_UpdateVpcLink.go +++ b/service/apigateway/api_op_UpdateVpcLink.go @@ -36,8 +36,8 @@ type UpdateVpcLinkInput struct { // This member is required. VpcLinkId *string - // For more information about supported patch operations, see Patch Operations - // (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). + // For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) + // . PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -57,9 +57,9 @@ type UpdateVpcLinkOutput struct { // The name used to label and identify the VPC link. Name *string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, - // or FAILED. Deploying an API will wait if the status is PENDING and will fail if - // the status is DELETING. + // The status of the VPC link. The valid values are AVAILABLE , PENDING , DELETING + // , or FAILED . Deploying an API will wait if the status is PENDING and will fail + // if the status is DELETING . Status types.VpcLinkStatus // A description about the VPC link status. diff --git a/service/apigateway/types/enums.go b/service/apigateway/types/enums.go index add9b37ffc0..5677c782e7a 100644 --- a/service/apigateway/types/enums.go +++ b/service/apigateway/types/enums.go @@ -164,8 +164,8 @@ const ( DocumentationPartTypeResponseBody DocumentationPartType = "RESPONSE_BODY" ) -// Values returns all known values for DocumentationPartType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DocumentationPartType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DocumentationPartType) Values() []DocumentationPartType { return []DocumentationPartType{ @@ -217,9 +217,9 @@ const ( EndpointTypePrivate EndpointType = "PRIVATE" ) -// Values returns all known values for EndpointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndpointType) Values() []EndpointType { return []EndpointType{ "REGIONAL", @@ -417,9 +417,9 @@ const ( UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader UnauthorizedCacheControlHeaderStrategy = "SUCCEED_WITHOUT_RESPONSE_HEADER" ) -// Values returns all known values for UnauthorizedCacheControlHeaderStrategy. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for UnauthorizedCacheControlHeaderStrategy. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (UnauthorizedCacheControlHeaderStrategy) Values() []UnauthorizedCacheControlHeaderStrategy { return []UnauthorizedCacheControlHeaderStrategy{ diff --git a/service/apigateway/types/errors.go b/service/apigateway/types/errors.go index 6cb3d9146bf..e690493c6f0 100644 --- a/service/apigateway/types/errors.go +++ b/service/apigateway/types/errors.go @@ -34,8 +34,8 @@ func (e *BadRequestException) ErrorCode() string { } func (e *BadRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request configuration has conflicts. For details, see the accompanying error -// message. +// The request configuration has conflicts. For details, see the accompanying +// error message. type ConflictException struct { Message *string diff --git a/service/apigateway/types/types.go b/service/apigateway/types/types.go index cda18036c5d..ac1fd2a06cc 100644 --- a/service/apigateway/types/types.go +++ b/service/apigateway/types/types.go @@ -13,11 +13,11 @@ type AccessLogSettings struct { // The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data // Firehose delivery stream to receive access logs. If you specify a Kinesis Data - // Firehose delivery stream, the stream name must begin with amazon-apigateway-. + // Firehose delivery stream, the stream name must begin with amazon-apigateway- . DestinationArn *string // A single line format of the access logs of data, as specified by selected - // $context variables. The format must include at least $context.requestId. + // $context variables. The format must include at least $context.requestId . Format *string noSmithyDocumentSerde @@ -102,13 +102,13 @@ type Authorizer struct { // Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or // REQUEST authorizers, this must be a well-formed Lambda function URI, for // example, - // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. - // In general, the URI has this form - // arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the + // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations + // . In general, the URI has this form + // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, - // including the initial /. For Lambda functions, this is usually of the form - // /2015-03-31/functions/[FunctionARN]/invocations. + // including the initial / . For Lambda functions, this is usually of the form + // /2015-03-31/functions/[FunctionARN]/invocations . AuthorizerUri *string // The identifier for the authorizer resource. @@ -117,13 +117,13 @@ type Authorizer struct { // The identity source for which authorization is requested. For a TOKEN or // COGNITO_USER_POOLS authorizer, this is required and specifies the request header // mapping expression for the custom header holding the authorization token - // submitted by the client. For example, if the token header name is Auth, the - // header mapping expression is method.request.header.Auth. For the REQUEST + // submitted by the client. For example, if the token header name is Auth , the + // header mapping expression is method.request.header.Auth . For the REQUEST // authorizer, this is required when authorization caching is enabled. The value is // a comma-separated string of one or more mapping expressions of the specified // request parameters. For example, if an Auth header, a Name query string // parameter are defined as identity sources, this value is - // method.request.header.Auth, method.request.querystring.Name. These parameters + // method.request.header.Auth , method.request.querystring.Name . These parameters // will be used to derive the authorization caching key and to perform runtime // validation of the REQUEST authorizer by verifying all of the identity-related // request parameters are present, not null and non-empty. Only when this is true @@ -148,25 +148,25 @@ type Authorizer struct { // A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS // authorizer. Each element is of this format: - // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN + // arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN // or REQUEST authorizer, this is not defined. ProviderARNs []string - // The authorizer type. Valid values are TOKEN for a Lambda function using a single - // authorization token submitted in a custom header, REQUEST for a Lambda function - // using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon - // Cognito user pool. + // The authorizer type. Valid values are TOKEN for a Lambda function using a + // single authorization token submitted in a custom header, REQUEST for a Lambda + // function using incoming request parameters, and COGNITO_USER_POOLS for using an + // Amazon Cognito user pool. Type AuthorizerType noSmithyDocumentSerde } -// Represents the base path that callers of the API must provide as part of the URL -// after the domain name. +// Represents the base path that callers of the API must provide as part of the +// URL after the domain name. type BasePathMapping struct { - // The base path name that callers of the API must provide as part of the URL after - // the domain name. + // The base path name that callers of the API must provide as part of the URL + // after the domain name. BasePath *string // The string identifier of the associated RestApi. @@ -192,15 +192,15 @@ type CanarySettings struct { // string-to-string map between stage variable names and their values. StageVariableOverrides map[string]string - // A Boolean flag to indicate whether the canary deployment uses the stage cache or - // not. + // A Boolean flag to indicate whether the canary deployment uses the stage cache + // or not. UseStageCache bool noSmithyDocumentSerde } -// Represents a client certificate used to configure client-side SSL authentication -// while sending requests to the integration endpoint. +// Represents a client certificate used to configure client-side SSL +// authentication while sending requests to the integration endpoint. type ClientCertificate struct { // The identifier of the client certificate. @@ -281,10 +281,10 @@ type DocumentationPart struct { // A content map of API-specific key-value pairs describing the targeted API // entity. The map must be encoded as a JSON string, e.g., "{ \"description\": - // \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields + // \"The API does ...\" }" . Only OpenAPI-compliant documentation-related fields // from the properties map are exported and, hence, published as part of the API // entity definitions, while the original documentation parts are exported in a - // OpenAPI extension of x-amazon-apigateway-documentation. + // OpenAPI extension of x-amazon-apigateway-documentation . Properties *string noSmithyDocumentSerde @@ -294,41 +294,42 @@ type DocumentationPart struct { type DocumentationPartLocation struct { // The type of API entity to which the documentation content applies. Valid values - // are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, - // REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. - // Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, - // MODEL, REQUEST_BODY, or RESOURCE type. + // are API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , + // QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , + // and RESPONSE_BODY . Content inheritance does not apply to any entity of the API + // , AUTHORIZER , METHOD , MODEL , REQUEST_BODY , or RESOURCE type. // // This member is required. Type DocumentationPartType // The HTTP verb of a method. It is a valid field for the API entity types of - // METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, - // RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When - // an applicable child entity inherits the content of an entity of the same type - // with more general specifications of the other location attributes, the child - // entity's method attribute must match that of the parent entity exactly. + // METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , + // RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any + // method. When an applicable child entity inherits the content of an entity of the + // same type with more general specifications of the other location attributes, + // the child entity's method attribute must match that of the parent entity + // exactly. Method *string // The name of the targeted API entity. It is a valid and required field for the - // API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, - // REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any - // other entity type. + // API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , + // REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for + // any other entity type. Name *string // The URL path of the target. It is a valid field for the API entity types of - // RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, - // RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the - // root resource. When an applicable child entity inherits the content of another - // entity of the same type with more general specifications of the other location - // attributes, the child entity's path attribute must match that of the parent - // entity as a prefix. + // RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , + // REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default + // value is / for the root resource. When an applicable child entity inherits the + // content of another entity of the same type with more general specifications of + // the other location attributes, the child entity's path attribute must match + // that of the parent entity as a prefix. Path *string - // The HTTP status code of a response. It is a valid field for the API entity types - // of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any - // status code. When an applicable child entity inherits the content of an entity - // of the same type with more general specifications of the other location + // The HTTP status code of a response. It is a valid field for the API entity + // types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * + // for any status code. When an applicable child entity inherits the content of an + // entity of the same type with more general specifications of the other location // attributes, the child entity's statusCode attribute must match that of the // parent entity exactly. StatusCode *string @@ -381,12 +382,12 @@ type DomainName struct { // Endpoints for API Gateway. DistributionHostedZoneId *string - // The custom domain name as an API host name, for example, my-api.example.com. + // The custom domain name as an API host name, for example, my-api.example.com . DomainName *string // The status of the DomainName migration. The valid values are AVAILABLE and - // UPDATING. If the status is UPDATING, the domain cannot be modified further until - // the existing operation is complete. If it is AVAILABLE, the domain can be + // UPDATING . If the status is UPDATING , the domain cannot be modified further + // until the existing operation is complete. If it is AVAILABLE , the domain can be // updated. DomainNameStatus DomainNameStatus @@ -408,12 +409,12 @@ type DomainName struct { // imported or private CA certificate ARN as the regionalCertificateArn. OwnershipVerificationCertificateArn *string - // The reference to an AWS-managed certificate that will be used for validating the - // regional domain name. AWS Certificate Manager is the only supported source. + // The reference to an AWS-managed certificate that will be used for validating + // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string - // The name of the certificate that will be used for validating the regional domain - // name. + // The name of the certificate that will be used for validating the regional + // domain name. RegionalCertificateName *string // The domain name associated with the regional endpoint for this custom domain @@ -422,13 +423,13 @@ type DomainName struct { // by API Gateway when you create a regional endpoint. RegionalDomainName *string - // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For - // more information, see Set up a Regional Custom Domain Name and AWS Regions and - // Endpoints for API Gateway. + // The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. + // For more information, see Set up a Regional Custom Domain Name and AWS Regions + // and Endpoints for API Gateway. RegionalHostedZoneId *string // The Transport Layer Security (TLS) version + cipher suite for this DomainName. - // The valid values are TLS_1_0 and TLS_1_2. + // The valid values are TLS_1_0 and TLS_1_2 . SecurityPolicy SecurityPolicy // The collection of tags. Each tag element is associated with a given resource. @@ -443,8 +444,8 @@ type EndpointConfiguration struct { // A list of endpoint types of an API (RestApi) or its custom domain name // (DomainName). For an edge-optimized API and its custom domain name, the endpoint - // type is "EDGE". For a regional API and its custom domain name, the endpoint type - // is REGIONAL. For a private API, the endpoint type is PRIVATE. + // type is "EDGE" . For a regional API and its custom domain name, the endpoint + // type is REGIONAL . For a private API, the endpoint type is PRIVATE . Types []EndpointType // A list of VpcEndpointIds of an API (RestApi) against which to create Route53 @@ -459,16 +460,16 @@ type EndpointConfiguration struct { type GatewayResponse struct { // A Boolean flag to indicate whether this GatewayResponse is the default gateway - // response (true) or not (false). A default gateway response is one generated by - // API Gateway without any customization by an API developer. + // response ( true ) or not ( false ). A default gateway response is one generated + // by API Gateway without any customization by an API developer. DefaultResponse bool - // Response parameters (paths, query strings and headers) of the GatewayResponse as - // a string-to-string map of key-value pairs. + // Response parameters (paths, query strings and headers) of the GatewayResponse + // as a string-to-string map of key-value pairs. ResponseParameters map[string]string - // Response templates of the GatewayResponse as a string-to-string map of key-value - // pairs. + // Response templates of the GatewayResponse as a string-to-string map of + // key-value pairs. ResponseTemplates map[string]string // The response type of the associated GatewayResponse. @@ -483,13 +484,13 @@ type GatewayResponse struct { // Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration. type Integration struct { - // A list of request parameters whose values API Gateway caches. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters , these parameters must also be specified for + // Method requestParameters . CacheKeyParameters []string - // Specifies a group of related cached parameters. By default, API Gateway uses the - // resource ID as the cacheNamespace. You can specify the same cacheNamespace + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace . You can specify the same cacheNamespace // across resources to return the same cached data for requests to different // resources. CacheNamespace *string @@ -499,13 +500,13 @@ type Integration struct { ConnectionId *string // The type of the network connection to the integration endpoint. The valid value - // is INTERNET for connections through the public routable internet or VPC_LINK for - // private connections between API Gateway and a network load balancer in a VPC. - // The default value is INTERNET. + // is INTERNET for connections through the public routable internet or VPC_LINK + // for private connections between API Gateway and a network load balancer in a + // VPC. The default value is INTERNET . ConnectionType ConnectionType // Specifies how to handle request payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the request payload will be passed through from // the method request to integration request without modification, provided that // the passthroughBehavior is configured to support payload pass-through. @@ -515,7 +516,7 @@ type Integration struct { // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string - // arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS + // arn:aws:iam::\*:user/\* . To use resource-based permissions on supported AWS // services, specify null. Credentials *string @@ -525,23 +526,23 @@ type Integration struct { // Specifies the integration's responses. IntegrationResponses map[string]IntegrationResponse - // Specifies how the method request body of an unmapped content type will be passed - // through the integration request to the back end without transformation. A + // Specifies how the method request body of an unmapped content type will be + // passed through the integration request to the back end without transformation. A // content type is unmapped if no mapping template is defined in the integration or // the content type does not match any of the mapped content types, as specified in - // requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes - // the method request body through the integration request to the back end without - // transformation when the method request content type does not match any content - // type associated with the mapping templates defined in the integration request. - // WHEN_NO_TEMPLATES: passes the method request body through the integration - // request to the back end without transformation when no mapping template is - // defined in the integration request. If a template is defined when this option is - // selected, the method request of an unmapped content-type will be rejected with - // an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request - // with an HTTP 415 Unsupported Media Type response when either the method request - // content type does not match any content type associated with the mapping - // templates defined in the integration request or no mapping template is defined - // in the integration request. + // requestTemplates . The valid value is one of the following: WHEN_NO_MATCH : + // passes the method request body through the integration request to the back end + // without transformation when the method request content type does not match any + // content type associated with the mapping templates defined in the integration + // request. WHEN_NO_TEMPLATES : passes the method request body through the + // integration request to the back end without transformation when no mapping + // template is defined in the integration request. If a template is defined when + // this option is selected, the method request of an unmapped content-type will be + // rejected with an HTTP 415 Unsupported Media Type response. NEVER : rejects the + // method request with an HTTP 415 Unsupported Media Type response when either the + // method request content type does not match any content type associated with the + // mapping templates defined in the integration request or no mapping template is + // defined in the integration request. PassthroughBehavior *string // A key-value map specifying request parameters that are passed from the method @@ -549,8 +550,8 @@ type Integration struct { // the associated value is a method request parameter value or static value that // must be enclosed within single quotes and pre-encoded as required by the back // end. The method request parameter value must match the pattern of - // method.request.{location}.{name}, where location is querystring, path, or header - // and name must be a valid and unique method request parameter name. + // method.request.{location}.{name} , where location is querystring , path , or + // header and name must be a valid and unique method request parameter name. RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -567,20 +568,20 @@ type Integration struct { // Specifies an API method integration type. The valid value is one of the // following: For the HTTP and HTTP proxy integrations, each integration can - // specify a protocol (http/https), port and path. Standard 80 and 443 ports are + // specify a protocol ( http/https ), port and path. Standard 80 and 443 ports are // supported as well as custom ports above 1024. An HTTP or HTTP proxy integration // with a connectionType of VPC_LINK is referred to as a private integration and // uses a VpcLink to connect API Gateway to a network load balancer of a VPC. Type IntegrationType // Specifies Uniform Resource Identifier (URI) of the integration endpoint. For - // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) - // URL according to the RFC-3986 specification, for either standard integration, - // where connectionType is not VPC_LINK, or private integration, where - // connectionType is VPC_LINK. For a private HTTP integration, the URI is not used - // for routing. For AWS or AWS_PROXY integrations, the URI is of the form - // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. - // Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the + // HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded + // HTTP(S) URL according to the RFC-3986 specification, for either standard + // integration, where connectionType is not VPC_LINK , or private integration, + // where connectionType is VPC_LINK . For a private HTTP integration, the URI is + // not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form + // arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} + // . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the // name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} // is a designated subdomain supported by certain Amazon Web Services service for // fast host-name lookup. action can be used for an Amazon Web Services service @@ -604,7 +605,7 @@ type Integration struct { type IntegrationResponse struct { // Specifies how to handle response payload content type conversions. Supported - // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: // If this property is not defined, the response payload will be passed through // from the integration response to the method response without modification. ContentHandling ContentHandlingStrategy @@ -614,10 +615,10 @@ type IntegrationResponse struct { // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of - // method.response.header.{name}, where name is a valid and unique header name. The - // mapped non-static value must match the pattern of + // method.response.header.{name} , where name is a valid and unique header name. + // The mapped non-static value must match the pattern of // integration.response.header.{name} or - // integration.response.body.{JSON-expression}, where name is a valid and unique + // integration.response.body.{JSON-expression} , where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]string @@ -631,9 +632,9 @@ type IntegrationResponse struct { // response based on the response from the back end. For example, if the success // response returns nothing and the error response returns some string, you could // use the .+ regex to match error response. However, make sure that the error - // response does not contain any newline (\n) character in such cases. If the back - // end is an AWS Lambda function, the AWS Lambda function error header is matched. - // For all other HTTP and AWS back ends, the HTTP status code is matched. + // response does not contain any newline ( \n ) character in such cases. If the + // back end is an AWS Lambda function, the AWS Lambda function error header is + // matched. For all other HTTP and AWS back ends, the HTTP status code is matched. SelectionPattern *string // Specifies the status code that is used to map the integration response to an @@ -643,8 +644,8 @@ type IntegrationResponse struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to access -// back-end resources. A Method resource is integrated with an Integration +// Represents a client-facing interface by which the client calls the API to +// access back-end resources. A Method resource is integrated with an Integration // resource. Both consist of a request and one or more responses. The method // request takes the client input that is passed to the back end through the // integration request. A method response returns the output from the back end to @@ -675,7 +676,7 @@ type Method struct { AuthorizationType *string // The identifier of an Authorizer to use on this method. The authorizationType - // must be CUSTOM. + // must be CUSTOM . AuthorizerId *string // The method's HTTP verb. @@ -694,19 +695,19 @@ type Method struct { // example. OperationName *string - // A key-value map specifying data schemas, represented by Model resources, (as the - // mapped value) of the request payloads of given content types (as the mapping + // A key-value map specifying data schemas, represented by Model resources, (as + // the mapped value) of the request payloads of given content types (as the mapping // key). RequestModels map[string]string - // A key-value map defining required or optional method request parameters that can - // be accepted by API Gateway. A key is a method request parameter name matching - // the pattern of method.request.{location}.{name}, where location is querystring, - // path, or header and name is a valid and unique parameter name. The value - // associated with the key is a Boolean flag indicating whether the parameter is - // required (true) or optional (false). The method request parameter names defined - // here are available in Integration to be mapped to integration request parameters - // or templates. + // A key-value map defining required or optional method request parameters that + // can be accepted by API Gateway. A key is a method request parameter name + // matching the pattern of method.request.{location}.{name} , where location is + // querystring , path , or header and name is a valid and unique parameter name. + // The value associated with the key is a Boolean flag indicating whether the + // parameter is required ( true ) or optional ( false ). The method request + // parameter names defined here are available in Integration to be mapped to + // integration request parameters or templates. RequestParameters map[string]bool // The identifier of a RequestValidator for request validation. @@ -715,8 +716,8 @@ type Method struct { noSmithyDocumentSerde } -// Represents a method response of a given HTTP status code returned to the client. -// The method response is passed from the back end through the associated +// Represents a method response of a given HTTP status code returned to the +// client. The method response is passed from the back end through the associated // integration response that can be transformed using a mapping template. type MethodResponse struct { @@ -729,14 +730,14 @@ type MethodResponse struct { // Gateway can send back to the caller. A key defines a method response header and // the value specifies whether the associated method response header is required or // not. The expression of the key must match the pattern - // method.response.header.{name}, where name is a valid and unique header name. API - // Gateway passes certain integration response data to the method response headers - // specified here according to the mapping you prescribe in the API's + // method.response.header.{name} , where name is a valid and unique header name. + // API Gateway passes certain integration response data to the method response + // headers specified here according to the mapping you prescribe in the API's // IntegrationResponse. The integration response data that can be mapped include an - // integration response header expressed in integration.response.header.{name}, a - // static value enclosed within a pair of single quotes (e.g., 'application/json'), - // or a JSON expression from the back-end response payload in the form of - // integration.response.body.{JSON-expression}, where JSON-expression is a valid + // integration response header expressed in integration.response.header.{name} , a + // static value enclosed within a pair of single quotes (e.g., 'application/json' + // ), or a JSON expression from the back-end response payload in the form of + // integration.response.body.{JSON-expression} , where JSON-expression is a valid // JSON expression without the $ prefix.) ResponseParameters map[string]bool @@ -750,57 +751,58 @@ type MethodResponse struct { type MethodSetting struct { // Specifies whether the cached responses are encrypted. The PATCH path for this - // setting is /{method_setting_key}/caching/dataEncrypted, and the value is a + // setting is /{method_setting_key}/caching/dataEncrypted , and the value is a // Boolean. CacheDataEncrypted bool // Specifies the time to live (TTL), in seconds, for cached responses. The higher // the TTL, the longer the response will be cached. The PATCH path for this setting - // is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. + // is /{method_setting_key}/caching/ttlInSeconds , and the value is an integer. CacheTtlInSeconds int32 // Specifies whether responses should be cached and returned for requests. A cache // cluster must be enabled on the stage for responses to be cached. The PATCH path - // for this setting is /{method_setting_key}/caching/enabled, and the value is a + // for this setting is /{method_setting_key}/caching/enabled , and the value is a // Boolean. CachingEnabled bool // Specifies whether data trace logging is enabled for this method, which affects // the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this - // setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. + // setting is /{method_setting_key}/logging/dataTrace , and the value is a Boolean. DataTraceEnabled bool // Specifies the logging level for this method, which affects the log entries // pushed to Amazon CloudWatch Logs. The PATCH path for this setting is - // /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, - // and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or - // choose INFO to include all ERROR events as well as extra informational events. + // /{method_setting_key}/logging/loglevel , and the available levels are OFF , + // ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch + // Logs, or choose INFO to include all ERROR events as well as extra informational + // events. LoggingLevel *string // Specifies whether Amazon CloudWatch metrics are enabled for this method. The - // PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the + // PATCH path for this setting is /{method_setting_key}/metrics/enabled , and the // value is a Boolean. MetricsEnabled bool // Specifies whether authorization is required for a cache invalidation request. // The PATCH path for this setting is - // /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value - // is a Boolean. + // /{method_setting_key}/caching/requireAuthorizationForCacheControl , and the + // value is a Boolean. RequireAuthorizationForCacheControl bool // Specifies the throttling burst limit. The PATCH path for this setting is - // /{method_setting_key}/throttling/burstLimit, and the value is an integer. + // /{method_setting_key}/throttling/burstLimit , and the value is an integer. ThrottlingBurstLimit int32 // Specifies the throttling rate limit. The PATCH path for this setting is - // /{method_setting_key}/throttling/rateLimit, and the value is a double. + // /{method_setting_key}/throttling/rateLimit , and the value is a double. ThrottlingRateLimit float64 // Specifies how to handle unauthorized requests for cache invalidation. The PATCH // path for this setting is - // /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the - // available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, - // SUCCEED_WITHOUT_RESPONSE_HEADER. + // /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy , and the + // available values are FAIL_WITH_403 , SUCCEED_WITH_RESPONSE_HEADER , + // SUCCEED_WITHOUT_RESPONSE_HEADER . UnauthorizedCacheControlHeaderStrategy UnauthorizedCacheControlHeaderStrategy noSmithyDocumentSerde @@ -851,7 +853,7 @@ type Model struct { type MutualTlsAuthentication struct { // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, - // for example s3://bucket-name/key-name. The truststore can contain certificates + // for example s3://bucket-name/key-name . The truststore can contain certificates // from public or private certificate authorities. To update the truststore, upload // a new version to S3, and then update your custom domain name to use the new // version. To update the truststore, you must have permissions to access the S3 @@ -877,7 +879,7 @@ type MutualTlsAuthentication struct { type MutualTlsAuthenticationInput struct { // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, - // for example s3://bucket-name/key-name. The truststore can contain certificates + // for example s3://bucket-name/key-name . The truststore can contain certificates // from public or private certificate authorities. To update the truststore, upload // a new version to S3, and then update your custom domain name to use the new // version. To update the truststore, you must have permissions to access the S3 @@ -891,8 +893,8 @@ type MutualTlsAuthenticationInput struct { noSmithyDocumentSerde } -// For more information about supported patch operations, see Patch Operations -// (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html). +// For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html) +// . type PatchOperation struct { // The copy update operation's source as identified by a JSON-Pointer value @@ -903,18 +905,18 @@ type PatchOperation struct { // "path":"/deploymentId". From *string - // An update operation to be performed with this PATCH request. The valid value can - // be add, remove, replace or copy. Not all valid operations are supported for a - // given resource. Support of the operations depends on specific operational + // An update operation to be performed with this PATCH request. The valid value + // can be add, remove, replace or copy. Not all valid operations are supported for + // a given resource. Support of the operations depends on specific operational // contexts. Attempts to apply an unsupported operation on a resource will return // an error message.. Op Op - // The op operation's target, as identified by a JSON Pointer value that references - // a location within the targeted resource. For example, if the target resource has - // an updateable property of {"name":"value"}, the path for this property is /name. - // If the name property value is a JSON object (e.g., {"name": {"child/name": - // "child-value"}}), the path for the child/name property will be + // The op operation's target, as identified by a JSON Pointer value that + // references a location within the targeted resource. For example, if the target + // resource has an updateable property of {"name":"value"}, the path for this + // property is /name. If the name property value is a JSON object (e.g., {"name": + // {"child/name": "child-value"}}), the path for the child/name property will be // /name/child~1name. Any slash ("/") character appearing in path names must be // escaped with "~1", as shown in the example above. Each op operation can have // only one path associated with it. @@ -959,8 +961,8 @@ type RequestValidator struct { // configured Model schema. ValidateRequestBody bool - // A Boolean flag to indicate whether to validate request parameters (true) or not - // (false). + // A Boolean flag to indicate whether to validate request parameters ( true ) or + // not ( false ). ValidateRequestParameters bool noSmithyDocumentSerde @@ -990,14 +992,14 @@ type Resource struct { // Represents a REST API. type RestApi struct { - // The source of the API key for metering requests according to a usage plan. Valid - // values are: >HEADER to read the API key from the X-API-Key header of a request. - // AUTHORIZER to read the API key from the UsageIdentifierKey from a custom - // authorizer. + // The source of the API key for metering requests according to a usage plan. + // Valid values are: > HEADER to read the API key from the X-API-Key header of a + // request. AUTHORIZER to read the API key from the UsageIdentifierKey from a + // custom authorizer. ApiKeySource ApiKeySourceType - // The list of binary media types supported by the RestApi. By default, the RestApi - // supports only UTF-8-encoded text payloads. + // The list of binary media types supported by the RestApi. By default, the + // RestApi supports only UTF-8-encoded text payloads. BinaryMediaTypes []string // The timestamp when the API was created. @@ -1021,10 +1023,10 @@ type RestApi struct { // Gateway. Id *string - // A nullable integer that is used to enable compression (with non-negative between - // 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null - // value) on an API. When compression is enabled, compression or decompression is - // not applied on the payload if the payload size is smaller than this value. + // A nullable integer that is used to enable compression (with non-negative + // between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a + // null value) on an API. When compression is enabled, compression or decompression + // is not applied on the payload if the payload size is smaller than this value. // Setting it to zero allows compression for any payload size. MinimumCompressionSize *int32 @@ -1064,7 +1066,7 @@ type SdkConfigurationProperty struct { Name *string // A boolean flag of an SdkType configuration property to indicate if the - // associated SDK configuration property is required (true) or not (false). + // associated SDK configuration property is required ( true ) or not ( false ). Required bool noSmithyDocumentSerde @@ -1099,8 +1101,8 @@ type Stage struct { CacheClusterEnabled bool // The stage's cache capacity in GB. For more information about choosing a cache - // size, see Enabling API caching to enhance responsiveness - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). + // size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) + // . CacheClusterSize CacheClusterSize // The status of the cache cluster for the stage, if enabled. @@ -1127,8 +1129,8 @@ type Stage struct { // The timestamp when the stage last updated. LastUpdatedDate *time.Time - // A map that defines the method settings for a Stage resource. Keys (designated as - // /{method_setting_key below) are method paths defined as + // A map that defines the method settings for a Stage resource. Keys (designated + // as /{method_setting_key below) are method paths defined as // {resource_path}/{http_method} for an individual method override, or /\*/\* for // overriding all methods in the stage. MethodSettings map[string]MethodSetting @@ -1147,7 +1149,7 @@ type Stage struct { // A map that defines the stage variables for a Stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match - // [A-Za-z0-9-._~:/?#&=,]+. + // [A-Za-z0-9-._~:/?#&=,]+ . Variables map[string]string // The ARN of the WebAcl associated with the Stage. @@ -1156,7 +1158,7 @@ type Stage struct { noSmithyDocumentSerde } -// A reference to a unique stage identified in the format {restApiId}/{stage}. +// A reference to a unique stage identified in the format {restApiId}/{stage} . type StageKey struct { // The string identifier of the associated RestApi. @@ -1171,8 +1173,8 @@ type StageKey struct { // The API request rate limits. type ThrottleSettings struct { - // The API target request burst rate limit. This allows more requests through for a - // period of time than the target rate limit. + // The API target request burst rate limit. This allows more requests through for + // a period of time than the target rate limit. BurstLimit int32 // The API target request rate limit. @@ -1184,16 +1186,16 @@ type ThrottleSettings struct { // Specifies the TLS configuration for an integration. type TlsConfig struct { - // Specifies whether or not API Gateway skips verification that the certificate for - // an integration endpoint is issued by a supported certificate authority. This + // Specifies whether or not API Gateway skips verification that the certificate + // for an integration endpoint is issued by a supported certificate authority. This // isn’t recommended, but it enables you to use certificates that are signed by // private certificate authorities, or certificates that are self-signed. If // enabled, API Gateway still performs basic certificate validation, which includes // checking the certificate's expiration date, hostname, and presence of a root // certificate authority. Supported only for HTTP and HTTP_PROXY integrations. - // Enabling insecureSkipVerification isn't recommended, especially for integrations - // with public HTTPS endpoints. If you enable insecureSkipVerification, you - // increase the risk of man-in-the-middle attacks. + // Enabling insecureSkipVerification isn't recommended, especially for + // integrations with public HTTPS endpoints. If you enable insecureSkipVerification + // , you increase the risk of man-in-the-middle attacks. InsecureSkipVerification bool noSmithyDocumentSerde @@ -1202,11 +1204,9 @@ type TlsConfig struct { // Represents a usage plan used to specify who can assess associated API stages. // Optionally, target request rate and quota limits can be set. In some cases // clients can exceed the targets that you set. Don’t rely on usage plans to -// control costs. Consider using Amazon Web Services Budgets -// (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) -// to monitor costs and WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to -// manage API requests. +// control costs. Consider using Amazon Web Services Budgets (https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) +// to monitor costs and WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// to manage API requests. type UsagePlan struct { // The associated API stages of a usage plan. @@ -1221,8 +1221,8 @@ type UsagePlan struct { // The name of a usage plan. Name *string - // The AWS Markeplace product identifier to associate with the usage plan as a SaaS - // product on AWS Marketplace. + // The AWS Markeplace product identifier to associate with the usage plan as a + // SaaS product on AWS Marketplace. ProductCode *string // The target maximum number of permitted requests per a given unit time interval. @@ -1247,7 +1247,7 @@ type UsagePlanKey struct { // The name of a usage plan key. Name *string - // The type of a usage plan key. Currently, the valid key type is API_KEY. + // The type of a usage plan key. Currently, the valid key type is API_KEY . Type *string // The value of a usage plan key. @@ -1270,9 +1270,9 @@ type VpcLink struct { // The name used to label and identify the VPC link. Name *string - // The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, - // or FAILED. Deploying an API will wait if the status is PENDING and will fail if - // the status is DELETING. + // The status of the VPC link. The valid values are AVAILABLE , PENDING , DELETING + // , or FAILED . Deploying an API will wait if the status is PENDING and will fail + // if the status is DELETING . Status VpcLinkStatus // A description about the VPC link status. diff --git a/service/apigatewaymanagementapi/api_client.go b/service/apigatewaymanagementapi/api_client.go index a055adb2d81..aef7a3ad78f 100644 --- a/service/apigatewaymanagementapi/api_client.go +++ b/service/apigatewaymanagementapi/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/apigatewayv2/api_client.go b/service/apigatewayv2/api_client.go index 133be3f143d..2f91d86da93 100644 --- a/service/apigatewayv2/api_client.go +++ b/service/apigatewayv2/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/apigatewayv2/api_op_CreateApi.go b/service/apigatewayv2/api_op_CreateApi.go index 49ac9304d57..cb3c6974958 100644 --- a/service/apigatewayv2/api_op_CreateApi.go +++ b/service/apigatewayv2/api_op_CreateApi.go @@ -42,22 +42,21 @@ type CreateApiInput struct { ProtocolType types.ProtocolType // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string - // A CORS configuration. Supported only for HTTP APIs. See Configuring CORS - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) + // A CORS configuration. Supported only for HTTP APIs. See Configuring CORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. CorsConfiguration *types.Cors - // This property is part of quick create. It specifies the credentials required for - // the integration, if any. For a Lambda integration, three options are available. - // To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource - // Name (ARN). To require that the caller's identity be passed through from the - // request, specify arn:aws:iam::*:user/*. To use resource-based permissions on - // supported AWS services, specify null. Currently, this property is not used for - // HTTP integrations. Supported only for HTTP APIs. + // This property is part of quick create. It specifies the credentials required + // for the integration, if any. For a Lambda integration, three options are + // available. To specify an IAM Role for API Gateway to assume, use the role's + // Amazon Resource Name (ARN). To require that the caller's identity be passed + // through from the request, specify arn:aws:iam::*:user/*. To use resource-based + // permissions on supported AWS services, specify null. Currently, this property is + // not used for HTTP integrations. Supported only for HTTP APIs. CredentialsArn *string // The description of the API. @@ -70,15 +69,15 @@ type CreateApiInput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // This property is part of quick create. If you don't specify a routeKey, a - // default route of $default is created. The $default route acts as a catch-all for - // any request made to your API, for a particular stage. The $default route key - // can't be modified. You can add routes after creating the API, and you can update - // the route keys of additional routes. Supported only for HTTP APIs. + // default route of $default is created. The $default route acts as a catch-all + // for any request made to your API, for a particular stage. The $default route + // key can't be modified. You can add routes after creating the API, and you can + // update the route keys of additional routes. Supported only for HTTP APIs. RouteKey *string // The route selection expression for the API. For HTTP APIs, the @@ -106,22 +105,22 @@ type CreateApiInput struct { type CreateApiOutput struct { - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -140,8 +139,8 @@ type CreateApiOutput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular diff --git a/service/apigatewayv2/api_op_CreateAuthorizer.go b/service/apigatewayv2/api_op_CreateAuthorizer.go index 1c4997dc970..ed7d562298e 100644 --- a/service/apigatewayv2/api_op_CreateAuthorizer.go +++ b/service/apigatewayv2/api_op_CreateAuthorizer.go @@ -57,11 +57,11 @@ type CreateAuthorizerInput struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. // // This member is required. IdentitySource []string @@ -79,8 +79,8 @@ type CreateAuthorizerInput struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -105,8 +105,7 @@ type CreateAuthorizerInput struct { // default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda // authorizer can return a boolean value instead of an IAM policy. Supported only // for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP - // APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // This parameter is not used. @@ -132,8 +131,8 @@ type CreateAuthorizerOutput struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -161,9 +160,8 @@ type CreateAuthorizerOutput struct { // Specifies whether a Lambda authorizer returns a response in a simple format. If // enabled, the Lambda authorizer can return a boolean value instead of an IAM - // policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda - // authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // policy. Supported only for HTTP APIs. To learn more, see Working with AWS + // Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // The identity source for which authorization is requested. For a REQUEST @@ -181,11 +179,11 @@ type CreateAuthorizerOutput struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. IdentitySource []string // The validation expression does not apply to the REQUEST authorizer. diff --git a/service/apigatewayv2/api_op_CreateIntegration.go b/service/apigatewayv2/api_op_CreateIntegration.go index e8206331304..e42ce8256e7 100644 --- a/service/apigatewayv2/api_op_CreateIntegration.go +++ b/service/apigatewayv2/api_op_CreateIntegration.go @@ -57,10 +57,10 @@ type CreateIntegrationInput struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -88,8 +88,8 @@ type CreateIntegrationInput struct { IntegrationMethod *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // For a Lambda integration, specify the URI of a Lambda function. For an HTTP @@ -98,9 +98,8 @@ type CreateIntegrationInput struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -131,16 +130,15 @@ type CreateIntegrationInput struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API integrations without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API integrations without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to the backend. The key should follow the pattern // :. where action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -157,16 +155,16 @@ type CreateIntegrationInput struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS @@ -187,10 +185,10 @@ type CreateIntegrationOutput struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -221,13 +219,13 @@ type CreateIntegrationOutput struct { IntegrationMethod *string // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + // only for WebSocket APIs. See Integration Response Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) + // . IntegrationResponseSelectionExpression *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // The integration type of an integration. One of the following: AWS: for @@ -252,9 +250,8 @@ type CreateIntegrationOutput struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -285,16 +282,15 @@ type CreateIntegrationOutput struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API itegrations, without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API itegrations, without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to backend integrations. The key should follow the pattern // :.. The action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -311,17 +307,17 @@ type CreateIntegrationOutput struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS diff --git a/service/apigatewayv2/api_op_CreateRoute.go b/service/apigatewayv2/api_op_CreateRoute.go index 0a131d6b4f0..c90c4bce269 100644 --- a/service/apigatewayv2/api_op_CreateRoute.go +++ b/service/apigatewayv2/api_op_CreateRoute.go @@ -83,17 +83,17 @@ type CreateRouteInput struct { type CreateRouteOutput struct { - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. + // Specifies whether a route is managed by API Gateway. If you created an API + // using quick create, the $default route is managed by API Gateway. You can't + // modify the $default route key. ApiGatewayManaged bool // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired bool - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by + // A list of authorization scopes configured on a route. The scopes are used with + // a JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not diff --git a/service/apigatewayv2/api_op_CreateStage.go b/service/apigatewayv2/api_op_CreateStage.go index 37e8dd9c66b..e0f479236c2 100644 --- a/service/apigatewayv2/api_op_CreateStage.go +++ b/service/apigatewayv2/api_op_CreateStage.go @@ -48,8 +48,8 @@ type CreateStageInput struct { // default value is false. AutoDeploy bool - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. + // The identifier of a client certificate for a Stage. Supported only for + // WebSocket APIs. ClientCertificateId *string // The default route settings for the stage. @@ -80,17 +80,17 @@ type CreateStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings - // Specifies whether a stage is managed by API Gateway. If you created an API using - // quick create, the $default stage is managed by API Gateway. You can't modify the - // $default stage. + // Specifies whether a stage is managed by API Gateway. If you created an API + // using quick create, the $default stage is managed by API Gateway. You can't + // modify the $default stage. ApiGatewayManaged bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy bool - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. + // The identifier of a client certificate for a Stage. Supported only for + // WebSocket APIs. ClientCertificateId *string // The timestamp when the stage was created. diff --git a/service/apigatewayv2/api_op_ExportApi.go b/service/apigatewayv2/api_op_ExportApi.go index 7c24273360d..2d7e165ca20 100644 --- a/service/apigatewayv2/api_op_ExportApi.go +++ b/service/apigatewayv2/api_op_ExportApi.go @@ -37,8 +37,8 @@ type ExportApiInput struct { // This member is required. OutputType *string - // The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only - // supported value. + // The version of the API specification to use. OAS30, for OpenAPI 3.0, is the + // only supported value. // // This member is required. Specification *string @@ -47,8 +47,7 @@ type ExportApiInput struct { // version by default. Currently, the only supported version is 1.0. ExportVersion *string - // Specifies whether to include API Gateway extensions - // (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) + // Specifies whether to include API Gateway extensions (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) // in the exported API definition. API Gateway extensions are included by default. IncludeExtensions bool diff --git a/service/apigatewayv2/api_op_GetApi.go b/service/apigatewayv2/api_op_GetApi.go index 3e4ec0ff236..c4a8ed4e402 100644 --- a/service/apigatewayv2/api_op_GetApi.go +++ b/service/apigatewayv2/api_op_GetApi.go @@ -40,22 +40,22 @@ type GetApiInput struct { type GetApiOutput struct { - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -74,8 +74,8 @@ type GetApiOutput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular diff --git a/service/apigatewayv2/api_op_GetAuthorizer.go b/service/apigatewayv2/api_op_GetAuthorizer.go index 3af6bf9db64..3d3bd81d727 100644 --- a/service/apigatewayv2/api_op_GetAuthorizer.go +++ b/service/apigatewayv2/api_op_GetAuthorizer.go @@ -55,8 +55,8 @@ type GetAuthorizerOutput struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -84,9 +84,8 @@ type GetAuthorizerOutput struct { // Specifies whether a Lambda authorizer returns a response in a simple format. If // enabled, the Lambda authorizer can return a boolean value instead of an IAM - // policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda - // authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // policy. Supported only for HTTP APIs. To learn more, see Working with AWS + // Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // The identity source for which authorization is requested. For a REQUEST @@ -104,11 +103,11 @@ type GetAuthorizerOutput struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. IdentitySource []string // The validation expression does not apply to the REQUEST authorizer. diff --git a/service/apigatewayv2/api_op_GetIntegration.go b/service/apigatewayv2/api_op_GetIntegration.go index 9bc4bbf67e2..4b6d0caae1c 100644 --- a/service/apigatewayv2/api_op_GetIntegration.go +++ b/service/apigatewayv2/api_op_GetIntegration.go @@ -52,10 +52,10 @@ type GetIntegrationOutput struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -86,13 +86,13 @@ type GetIntegrationOutput struct { IntegrationMethod *string // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + // only for WebSocket APIs. See Integration Response Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) + // . IntegrationResponseSelectionExpression *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // The integration type of an integration. One of the following: AWS: for @@ -117,9 +117,8 @@ type GetIntegrationOutput struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -150,16 +149,15 @@ type GetIntegrationOutput struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API itegrations, without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API itegrations, without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to backend integrations. The key should follow the pattern // :.. The action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -176,17 +174,17 @@ type GetIntegrationOutput struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS diff --git a/service/apigatewayv2/api_op_GetRoute.go b/service/apigatewayv2/api_op_GetRoute.go index ffead02787c..5708b59e9d8 100644 --- a/service/apigatewayv2/api_op_GetRoute.go +++ b/service/apigatewayv2/api_op_GetRoute.go @@ -44,17 +44,17 @@ type GetRouteInput struct { type GetRouteOutput struct { - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. + // Specifies whether a route is managed by API Gateway. If you created an API + // using quick create, the $default route is managed by API Gateway. You can't + // modify the $default route key. ApiGatewayManaged bool // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired bool - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by + // A list of authorization scopes configured on a route. The scopes are used with + // a JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not diff --git a/service/apigatewayv2/api_op_GetStage.go b/service/apigatewayv2/api_op_GetStage.go index c4b9f078877..dbfab9e15d1 100644 --- a/service/apigatewayv2/api_op_GetStage.go +++ b/service/apigatewayv2/api_op_GetStage.go @@ -49,17 +49,17 @@ type GetStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings - // Specifies whether a stage is managed by API Gateway. If you created an API using - // quick create, the $default stage is managed by API Gateway. You can't modify the - // $default stage. + // Specifies whether a stage is managed by API Gateway. If you created an API + // using quick create, the $default stage is managed by API Gateway. You can't + // modify the $default stage. ApiGatewayManaged bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy bool - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. + // The identifier of a client certificate for a Stage. Supported only for + // WebSocket APIs. ClientCertificateId *string // The timestamp when the stage was created. diff --git a/service/apigatewayv2/api_op_ImportApi.go b/service/apigatewayv2/api_op_ImportApi.go index 906f333a429..977cbb6c6d1 100644 --- a/service/apigatewayv2/api_op_ImportApi.go +++ b/service/apigatewayv2/api_op_ImportApi.go @@ -37,13 +37,12 @@ type ImportApiInput struct { // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see - // Set the OpenAPI basePath Property - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). - // Supported only for HTTP APIs. + // Set the OpenAPI basePath Property (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html) + // . Supported only for HTTP APIs. Basepath *string - // Specifies whether to rollback the API creation when a warning is encountered. By - // default, API creation continues if a warning is encountered. + // Specifies whether to rollback the API creation when a warning is encountered. + // By default, API creation continues if a warning is encountered. FailOnWarnings bool noSmithyDocumentSerde @@ -51,22 +50,22 @@ type ImportApiInput struct { type ImportApiOutput struct { - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -85,8 +84,8 @@ type ImportApiOutput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular diff --git a/service/apigatewayv2/api_op_ReimportApi.go b/service/apigatewayv2/api_op_ReimportApi.go index 4defdc5babb..ea5676c68bf 100644 --- a/service/apigatewayv2/api_op_ReimportApi.go +++ b/service/apigatewayv2/api_op_ReimportApi.go @@ -42,13 +42,12 @@ type ReimportApiInput struct { // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see - // Set the OpenAPI basePath Property - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). - // Supported only for HTTP APIs. + // Set the OpenAPI basePath Property (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html) + // . Supported only for HTTP APIs. Basepath *string - // Specifies whether to rollback the API creation when a warning is encountered. By - // default, API creation continues if a warning is encountered. + // Specifies whether to rollback the API creation when a warning is encountered. + // By default, API creation continues if a warning is encountered. FailOnWarnings bool noSmithyDocumentSerde @@ -56,22 +55,22 @@ type ReimportApiInput struct { type ReimportApiOutput struct { - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -90,8 +89,8 @@ type ReimportApiOutput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular diff --git a/service/apigatewayv2/api_op_UpdateApi.go b/service/apigatewayv2/api_op_UpdateApi.go index cb8e1c457d3..f6084492e21 100644 --- a/service/apigatewayv2/api_op_UpdateApi.go +++ b/service/apigatewayv2/api_op_UpdateApi.go @@ -37,22 +37,22 @@ type UpdateApiInput struct { ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors - // This property is part of quick create. It specifies the credentials required for - // the integration, if any. For a Lambda integration, three options are available. - // To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource - // Name (ARN). To require that the caller's identity be passed through from the - // request, specify arn:aws:iam::*:user/*. To use resource-based permissions on - // supported AWS services, don't specify this parameter. Currently, this property - // is not used for HTTP integrations. If provided, this value replaces the - // credentials associated with the quick create integration. Supported only for - // HTTP APIs. + // This property is part of quick create. It specifies the credentials required + // for the integration, if any. For a Lambda integration, three options are + // available. To specify an IAM Role for API Gateway to assume, use the role's + // Amazon Resource Name (ARN). To require that the caller's identity be passed + // through from the request, specify arn:aws:iam::*:user/*. To use resource-based + // permissions on supported AWS services, don't specify this parameter. Currently, + // this property is not used for HTTP integrations. If provided, this value + // replaces the credentials associated with the quick create integration. Supported + // only for HTTP APIs. CredentialsArn *string // The description of the API. @@ -65,17 +65,17 @@ type UpdateApiInput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The name of the API. Name *string - // This property is part of quick create. If not specified, the route created using - // quick create is kept. Otherwise, this value replaces the route key of the quick - // create route. Additional routes may still be added after the API is updated. - // Supported only for HTTP APIs. + // This property is part of quick create. If not specified, the route created + // using quick create is kept. Otherwise, this value replaces the route key of the + // quick create route. Additional routes may still be added after the API is + // updated. Supported only for HTTP APIs. RouteKey *string // The route selection expression for the API. For HTTP APIs, the @@ -99,22 +99,22 @@ type UpdateApiInput struct { type UpdateApiOutput struct { - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -133,8 +133,8 @@ type UpdateApiOutput struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular diff --git a/service/apigatewayv2/api_op_UpdateAuthorizer.go b/service/apigatewayv2/api_op_UpdateAuthorizer.go index 7026127b661..a1f476219c4 100644 --- a/service/apigatewayv2/api_op_UpdateAuthorizer.go +++ b/service/apigatewayv2/api_op_UpdateAuthorizer.go @@ -48,8 +48,8 @@ type UpdateAuthorizerInput struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -79,8 +79,7 @@ type UpdateAuthorizerInput struct { // default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda // authorizer can return a boolean value instead of an IAM policy. Supported only // for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP - // APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // The identity source for which authorization is requested. For a REQUEST @@ -98,11 +97,11 @@ type UpdateAuthorizerInput struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. IdentitySource []string // This parameter is not used. @@ -131,8 +130,8 @@ type UpdateAuthorizerOutput struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -160,9 +159,8 @@ type UpdateAuthorizerOutput struct { // Specifies whether a Lambda authorizer returns a response in a simple format. If // enabled, the Lambda authorizer can return a boolean value instead of an IAM - // policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda - // authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // policy. Supported only for HTTP APIs. To learn more, see Working with AWS + // Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // The identity source for which authorization is requested. For a REQUEST @@ -180,11 +178,11 @@ type UpdateAuthorizerOutput struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. IdentitySource []string // The validation expression does not apply to the REQUEST authorizer. diff --git a/service/apigatewayv2/api_op_UpdateIntegration.go b/service/apigatewayv2/api_op_UpdateIntegration.go index 98551225fb7..6d985108f29 100644 --- a/service/apigatewayv2/api_op_UpdateIntegration.go +++ b/service/apigatewayv2/api_op_UpdateIntegration.go @@ -43,10 +43,10 @@ type UpdateIntegrationInput struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -74,8 +74,8 @@ type UpdateIntegrationInput struct { IntegrationMethod *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // The integration type of an integration. One of the following: AWS: for @@ -101,9 +101,8 @@ type UpdateIntegrationInput struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -134,16 +133,15 @@ type UpdateIntegrationInput struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API integrations, without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API integrations, without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to the backend. The key should follow the pattern // :. where action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -160,16 +158,16 @@ type UpdateIntegrationInput struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS @@ -190,10 +188,10 @@ type UpdateIntegrationOutput struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -224,13 +222,13 @@ type UpdateIntegrationOutput struct { IntegrationMethod *string // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + // only for WebSocket APIs. See Integration Response Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) + // . IntegrationResponseSelectionExpression *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // The integration type of an integration. One of the following: AWS: for @@ -255,9 +253,8 @@ type UpdateIntegrationOutput struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -288,16 +285,15 @@ type UpdateIntegrationOutput struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API itegrations, without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API itegrations, without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to backend integrations. The key should follow the pattern // :.. The action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -314,17 +310,17 @@ type UpdateIntegrationOutput struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS diff --git a/service/apigatewayv2/api_op_UpdateRoute.go b/service/apigatewayv2/api_op_UpdateRoute.go index de549e5c989..0d7b725488d 100644 --- a/service/apigatewayv2/api_op_UpdateRoute.go +++ b/service/apigatewayv2/api_op_UpdateRoute.go @@ -86,17 +86,17 @@ type UpdateRouteInput struct { type UpdateRouteOutput struct { - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. + // Specifies whether a route is managed by API Gateway. If you created an API + // using quick create, the $default route is managed by API Gateway. You can't + // modify the $default route key. ApiGatewayManaged bool // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired bool - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by + // A list of authorization scopes configured on a route. The scopes are used with + // a JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not diff --git a/service/apigatewayv2/api_op_UpdateStage.go b/service/apigatewayv2/api_op_UpdateStage.go index a5582630376..0e23dc0cb0d 100644 --- a/service/apigatewayv2/api_op_UpdateStage.go +++ b/service/apigatewayv2/api_op_UpdateStage.go @@ -78,17 +78,17 @@ type UpdateStageOutput struct { // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings - // Specifies whether a stage is managed by API Gateway. If you created an API using - // quick create, the $default stage is managed by API Gateway. You can't modify the - // $default stage. + // Specifies whether a stage is managed by API Gateway. If you created an API + // using quick create, the $default stage is managed by API Gateway. You can't + // modify the $default stage. ApiGatewayManaged bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy bool - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. + // The identifier of a client certificate for a Stage. Supported only for + // WebSocket APIs. ClientCertificateId *string // The timestamp when the stage was created. diff --git a/service/apigatewayv2/types/enums.go b/service/apigatewayv2/types/enums.go index 5e1e5734fed..8a25b3479cd 100644 --- a/service/apigatewayv2/types/enums.go +++ b/service/apigatewayv2/types/enums.go @@ -128,9 +128,9 @@ const ( EndpointTypeEdge EndpointType = "EDGE" ) -// Values returns all known values for EndpointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndpointType) Values() []EndpointType { return []EndpointType{ "REGIONAL", @@ -171,9 +171,9 @@ const ( LoggingLevelOff LoggingLevel = "OFF" ) -// Values returns all known values for LoggingLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LoggingLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LoggingLevel) Values() []LoggingLevel { return []LoggingLevel{ "ERROR", @@ -210,9 +210,9 @@ const ( ProtocolTypeHttp ProtocolType = "HTTP" ) -// Values returns all known values for ProtocolType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProtocolType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProtocolType) Values() []ProtocolType { return []ProtocolType{ "WEBSOCKET", diff --git a/service/apigatewayv2/types/errors.go b/service/apigatewayv2/types/errors.go index 9ee51572fa3..2fa2c0d340a 100644 --- a/service/apigatewayv2/types/errors.go +++ b/service/apigatewayv2/types/errors.go @@ -32,8 +32,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request is not valid, for example, the input is incomplete or incorrect. See -// the accompanying error message for details. +// The request is not valid, for example, the input is incomplete or incorrect. +// See the accompanying error message for details. type BadRequestException struct { Message *string diff --git a/service/apigatewayv2/types/types.go b/service/apigatewayv2/types/types.go index a622d6f553b..d384bb1f8e5 100644 --- a/service/apigatewayv2/types/types.go +++ b/service/apigatewayv2/types/types.go @@ -41,22 +41,22 @@ type Api struct { // This member is required. RouteSelectionExpression *string - // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The - // stage name is typically appended to this URI to form a complete path to a + // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. + // The stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string - // Specifies whether an API is managed by API Gateway. You can't update or delete a - // managed API by using API Gateway. A managed API can be deleted only through the - // tooling or service that created it. + // Specifies whether an API is managed by API Gateway. You can't update or delete + // a managed API by using API Gateway. A managed API can be deleted only through + // the tooling or service that created it. ApiGatewayManaged bool // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key - // Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). + // Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions) + // . ApiKeySelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. @@ -75,8 +75,8 @@ type Api struct { // endpoint. DisableExecuteApiEndpoint bool - // Avoid validating models when creating a deployment. Supported only for WebSocket - // APIs. + // Avoid validating models when creating a deployment. Supported only for + // WebSocket APIs. DisableSchemaValidation bool // The validation information during API import. This may include particular @@ -138,8 +138,8 @@ type Authorizer struct { // Specifies the format of the payload sent to an HTTP API Lambda authorizer. // Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To - // learn more, see Working with AWS Lambda authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + // learn more, see Working with AWS Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . AuthorizerPayloadFormatVersion *string // The time to live (TTL) for cached authorizer results, in seconds. If it equals @@ -167,9 +167,8 @@ type Authorizer struct { // Specifies whether a Lambda authorizer returns a response in a simple format. If // enabled, the Lambda authorizer can return a boolean value instead of an IAM - // policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda - // authorizers for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // policy. Supported only for HTTP APIs. To learn more, see Working with AWS + // Lambda authorizers for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) EnableSimpleResponses bool // The identity source for which authorization is requested. For a REQUEST @@ -187,11 +186,11 @@ type Authorizer struct { // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For HTTP APIs, identity sources are also used as the cache key when // caching is enabled. To learn more, see Working with AWS Lambda authorizers for - // HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). - // For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) - // from inbound requests. Currently only header-based and query parameter-based - // selections are supported, for example $request.header.Authorization. + // HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) + // . For JWT, a single entry that specifies where to extract the JSON Web Token + // (JWT) from inbound requests. Currently only header-based and query + // parameter-based selections are supported, for example + // $request.header.Authorization. IdentitySource []string // The validation expression does not apply to the REQUEST authorizer. @@ -205,8 +204,7 @@ type Authorizer struct { } // Represents a CORS configuration. Supported only for HTTP APIs. See Configuring -// CORS -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) +// CORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. type Cors struct { @@ -338,10 +336,10 @@ type Integration struct { // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string - // The type of the network connection to the integration endpoint. Specify INTERNET - // for connections through the public routable internet or VPC_LINK for private - // connections between API Gateway and resources in a VPC. The default value is - // INTERNET. + // The type of the network connection to the integration endpoint. Specify + // INTERNET for connections through the public routable internet or VPC_LINK for + // private connections between API Gateway and resources in a VPC. The default + // value is INTERNET. ConnectionType ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload @@ -372,13 +370,13 @@ type Integration struct { IntegrationMethod *string // The integration response selection expression for the integration. Supported - // only for WebSocket APIs. See Integration Response Selection Expressions - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). + // only for WebSocket APIs. See Integration Response Selection Expressions (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions) + // . IntegrationResponseSelectionExpression *string // Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service - // action to invoke. To learn more, see Integration subtype reference - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html). + // action to invoke. To learn more, see Integration subtype reference (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html) + // . IntegrationSubtype *string // The integration type of an integration. One of the following: AWS: for @@ -403,9 +401,8 @@ type Integration struct { // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see - // DiscoverInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). - // For private integrations, all resources must be owned by the same AWS account. + // DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) + // . For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the pass-through behavior for incoming requests based on the @@ -436,16 +433,15 @@ type Integration struct { // parameters are a key-value map specifying parameters that are passed to // AWS_PROXY integrations. You can provide static values, or map request data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Working with AWS service integrations for HTTP APIs - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html). - // For HTTP API itegrations, without a specified integrationSubtype request + // more, see Working with AWS service integrations for HTTP APIs (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html) + // . For HTTP API itegrations, without a specified integrationSubtype request // parameters are a key-value map specifying how to transform HTTP requests before // sending them to backend integrations. The key should follow the pattern // :.. The action can be append, // overwrite or remove. For values, you can provide static values, or map request // data, stage variables, or context variables that are evaluated at runtime. To - // learn more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // learn more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . RequestParameters map[string]string // Represents a map of Velocity templates that are applied on the request payload @@ -462,17 +458,17 @@ type Integration struct { // :
. or overwrite.statuscode. The action can be append, // overwrite or remove. The value can be a static value, or map to response data, // stage variables, or context variables that are evaluated at runtime. To learn - // more, see Transforming API requests and responses - // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html). + // more, see Transforming API requests and responses (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) + // . ResponseParameters map[string]map[string]string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string - // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between - // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for - // WebSocket APIs and 30 seconds for HTTP APIs. + // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and + // between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 + // seconds for WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis int32 // The TLS configuration for a private integration. If you specify a TLS @@ -533,9 +529,8 @@ type IntegrationResponse struct { type JWTConfiguration struct { // A list of the intended recipients of the JWT. A valid JWT must provide an aud - // that matches at least one entry in this list. See RFC 7519 - // (https://tools.ietf.org/html/rfc7519#section-4.1.3). Supported only for HTTP - // APIs. + // that matches at least one entry in this list. See RFC 7519 (https://tools.ietf.org/html/rfc7519#section-4.1.3) + // . Supported only for HTTP APIs. Audience []string // The base domain of the identity provider that issues JSON Web Tokens. For @@ -548,8 +543,8 @@ type JWTConfiguration struct { } // Represents a data model for an API. Supported only for WebSocket APIs. See -// Create Models and Mapping Templates for Request and Response Mappings -// (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html). +// Create Models and Mapping Templates for Request and Response Mappings (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html) +// . type Model struct { // The name of the model. Must be alphanumeric. @@ -631,17 +626,17 @@ type Route struct { // This member is required. RouteKey *string - // Specifies whether a route is managed by API Gateway. If you created an API using - // quick create, the $default route is managed by API Gateway. You can't modify the - // $default route key. + // Specifies whether a route is managed by API Gateway. If you created an API + // using quick create, the $default route is managed by API Gateway. You can't + // modify the $default route key. ApiGatewayManaged bool // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired bool - // A list of authorization scopes configured on a route. The scopes are used with a - // JWT authorizer to authorize the method invocation. The authorization works by + // A list of authorization scopes configured on a route. The scopes are used with + // a JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not @@ -746,17 +741,17 @@ type Stage struct { // Settings for logging access in this stage. AccessLogSettings *AccessLogSettings - // Specifies whether a stage is managed by API Gateway. If you created an API using - // quick create, the $default stage is managed by API Gateway. You can't modify the - // $default stage. + // Specifies whether a stage is managed by API Gateway. If you created an API + // using quick create, the $default stage is managed by API Gateway. You can't + // modify the $default stage. ApiGatewayManaged bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy bool - // The identifier of a client certificate for a Stage. Supported only for WebSocket - // APIs. + // The identifier of a client certificate for a Stage. Supported only for + // WebSocket APIs. ClientCertificateId *string // The timestamp when the stage was created. diff --git a/service/appconfig/api_client.go b/service/appconfig/api_client.go index e3720796277..63c5c3b01f1 100644 --- a/service/appconfig/api_client.go +++ b/service/appconfig/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appconfig/api_op_CreateApplication.go b/service/appconfig/api_op_CreateApplication.go index ed315c439bb..c011deb99d9 100644 --- a/service/appconfig/api_op_CreateApplication.go +++ b/service/appconfig/api_op_CreateApplication.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an application. In AppConfig, an application is simply an organizational -// construct like a folder. This organizational construct has a relationship with -// some unit of executable code. For example, you could create an application -// called MyMobileApp to organize and manage configuration data for a mobile -// application installed by your users. +// Creates an application. In AppConfig, an application is simply an +// organizational construct like a folder. This organizational construct has a +// relationship with some unit of executable code. For example, you could create an +// application called MyMobileApp to organize and manage configuration data for a +// mobile application installed by your users. func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} diff --git a/service/appconfig/api_op_CreateConfigurationProfile.go b/service/appconfig/api_op_CreateConfigurationProfile.go index c699154e167..8120f1ba234 100644 --- a/service/appconfig/api_op_CreateConfigurationProfile.go +++ b/service/appconfig/api_op_CreateConfigurationProfile.go @@ -14,40 +14,25 @@ import ( // Creates a configuration profile, which is information that enables AppConfig to // access the configuration source. Valid configuration sources include the // following: -// -// * Configuration data in YAML, JSON, and other formats stored in the -// AppConfig hosted configuration store -// -// * Configuration data stored as objects in -// an Amazon Simple Storage Service (Amazon S3) bucket -// -// * Pipelines stored in -// CodePipeline -// -// * Secrets stored in Secrets Manager -// -// * Standard and secure string -// parameters stored in Amazon Web Services Systems Manager Parameter Store -// -// * -// Configuration data in SSM documents stored in the Systems Manager document -// store +// - Configuration data in YAML, JSON, and other formats stored in the AppConfig +// hosted configuration store +// - Configuration data stored as objects in an Amazon Simple Storage Service +// (Amazon S3) bucket +// - Pipelines stored in CodePipeline +// - Secrets stored in Secrets Manager +// - Standard and secure string parameters stored in Amazon Web Services Systems +// Manager Parameter Store +// - Configuration data in SSM documents stored in the Systems Manager document +// store // // A configuration profile includes the following information: +// - The URI location of the configuration data. +// - The Identity and Access Management (IAM) role that provides access to the +// configuration data. +// - A validator for the configuration data. Available validators include either +// a JSON Schema or an Amazon Web Services Lambda function. // -// * The URI -// location of the configuration data. -// -// * The Identity and Access Management (IAM) -// role that provides access to the configuration data. -// -// * A validator for the -// configuration data. Available validators include either a JSON Schema or an -// Amazon Web Services Lambda function. -// -// For more information, see Create a -// Configuration and a Configuration Profile -// (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) +// For more information, see Create a Configuration and a Configuration Profile (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) // in the AppConfig User Guide. func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateConfigurationProfileInput, optFns ...func(*Options)) (*CreateConfigurationProfileOutput, error) { if params == nil { @@ -72,25 +57,16 @@ type CreateConfigurationProfileInput struct { ApplicationId *string // A URI to locate the configuration. You can specify the following: - // - // * For the - // AppConfig hosted configuration store and for feature flags, specify hosted. - // - // * - // For an Amazon Web Services Systems Manager Parameter Store parameter, specify - // either the parameter name in the format ssm-parameter:// or the ARN. - // - // * For an - // Secrets Manager secret, specify the URI in the following format: - // secrets-manager://. - // - // * For an Amazon S3 object, specify the URI in the following - // format: s3:/// . Here is an example: - // s3://my-bucket/my-app/us-east-1/my-config.json - // - // * For an SSM document, specify - // either the document name in the format ssm-document:// or the Amazon Resource - // Name (ARN). + // - For the AppConfig hosted configuration store and for feature flags, specify + // hosted . + // - For an Amazon Web Services Systems Manager Parameter Store parameter, + // specify either the parameter name in the format ssm-parameter:// or the ARN. + // - For an Secrets Manager secret, specify the URI in the following format: + // secrets-manager ://. + // - For an Amazon S3 object, specify the URI in the following format: s3:/// . + // Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json + // - For an SSM document, specify either the document name in the format + // ssm-document:// or the Amazon Resource Name (ARN). // // This member is required. LocationUri *string @@ -104,7 +80,7 @@ type CreateConfigurationProfileInput struct { Description *string // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. A retrieval role ARN is not required for configurations + // specified LocationUri . A retrieval role ARN is not required for configurations // stored in the AppConfig hosted configuration store. It is required for all other // sources that store your configuration. RetrievalRoleArn *string @@ -118,7 +94,7 @@ type CreateConfigurationProfileInput struct { // flags and freeform configurations. We recommend you create feature flag // configurations to enable or disable new features and freeform configurations to // distribute configurations to an application. When calling this API, enter one of - // the following values for Type: AWS.AppConfig.FeatureFlags + // the following values for Type : AWS.AppConfig.FeatureFlags // AWS.Freeform Type *string @@ -146,14 +122,14 @@ type CreateConfigurationProfileOutput struct { Name *string // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. + // specified LocationUri . RetrievalRoleArn *string // The type of configurations contained in the profile. AppConfig supports feature // flags and freeform configurations. We recommend you create feature flag // configurations to enable or disable new features and freeform configurations to // distribute configurations to an application. When calling this API, enter one of - // the following values for Type: AWS.AppConfig.FeatureFlags + // the following values for Type : AWS.AppConfig.FeatureFlags // AWS.Freeform Type *string diff --git a/service/appconfig/api_op_CreateDeploymentStrategy.go b/service/appconfig/api_op_CreateDeploymentStrategy.go index f10493bab55..4aebf2bddaf 100644 --- a/service/appconfig/api_op_CreateDeploymentStrategy.go +++ b/service/appconfig/api_op_CreateDeploymentStrategy.go @@ -57,37 +57,34 @@ type CreateDeploymentStrategyInput struct { // considering the deployment to be complete. If an alarm is triggered during this // time, AppConfig rolls back the deployment. You must configure permissions for // AppConfig to roll back based on CloudWatch alarms. For more information, see - // Configuring permissions for rollback based on Amazon CloudWatch alarms - // (https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) + // Configuring permissions for rollback based on Amazon CloudWatch alarms (https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) // in the AppConfig User Guide. FinalBakeTimeInMinutes int32 // The algorithm used to define how percentage grows over time. AppConfig supports // the following growth types: Linear: For this type, AppConfig processes the // deployment by dividing the total number of targets by the value specified for - // Step percentage. For example, a linear deployment that uses a Step percentage of - // 10 deploys the configuration to 10 percent of the hosts. After those deployments - // are complete, the system deploys the configuration to the next 10 percent. This - // continues until 100% of the targets have successfully received the + // Step percentage . For example, a linear deployment that uses a Step percentage + // of 10 deploys the configuration to 10 percent of the hosts. After those + // deployments are complete, the system deploys the configuration to the next 10 + // percent. This continues until 100% of the targets have successfully received the // configuration. Exponential: For this type, AppConfig processes the deployment - // exponentially using the following formula: G*(2^N). In this formula, G is the + // exponentially using the following formula: G*(2^N) . In this formula, G is the // growth factor specified by the user and N is the number of steps until the // configuration is deployed to all targets. For example, if you specify a growth // factor of 2, then the system rolls out the configuration as follows: 2*(2^0) - // - // 2*(2^1) - // - // 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% - // of the targets, 4% of the targets, 8% of the targets, and continues until the + // 2*(2^1) + // 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the + // targets, 4% of the targets, 8% of the targets, and continues until the // configuration has been deployed to all targets. GrowthType types.GrowthType // Save the deployment strategy to a Systems Manager (SSM) document. ReplicateTo types.ReplicateTo - // Metadata to assign to the deployment strategy. Tags help organize and categorize - // your AppConfig resources. Each tag consists of a key and an optional value, both - // of which you define. + // Metadata to assign to the deployment strategy. Tags help organize and + // categorize your AppConfig resources. Each tag consists of a key and an optional + // value, both of which you define. Tags map[string]string noSmithyDocumentSerde diff --git a/service/appconfig/api_op_CreateEnvironment.go b/service/appconfig/api_op_CreateEnvironment.go index 32cf1375680..25c6245483f 100644 --- a/service/appconfig/api_op_CreateEnvironment.go +++ b/service/appconfig/api_op_CreateEnvironment.go @@ -14,7 +14,7 @@ import ( // Creates an environment. For each application, you define one or more // environments. An environment is a deployment group of AppConfig targets, such as // applications in a Beta or Production environment. You can also define -// environments for application subcomponents such as the Web, Mobile and Back-end +// environments for application subcomponents such as the Web , Mobile and Back-end // components for your application. You can configure Amazon CloudWatch alarms for // each environment. The system monitors alarms during a configuration deployment. // If an alarm is triggered, the system rolls back the configuration. @@ -77,7 +77,7 @@ type CreateEnvironmentOutput struct { Name *string // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + // states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK State types.EnvironmentState // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_CreateExtension.go b/service/appconfig/api_op_CreateExtension.go index 021e872b9c0..f38ab2dc6f6 100644 --- a/service/appconfig/api_op_CreateExtension.go +++ b/service/appconfig/api_op_CreateExtension.go @@ -17,8 +17,7 @@ import ( // Amazon Web Services authored extensions provided by AppConfig. For most use // cases, to create your own extension, you must create an Lambda function to // perform any computation and processing defined in the extension. For more -// information about extensions, see Working with AppConfig extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// information about extensions, see Working with AppConfig extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) CreateExtension(ctx context.Context, params *CreateExtensionInput, optFns ...func(*Options)) (*CreateExtensionOutput, error) { if params == nil { diff --git a/service/appconfig/api_op_CreateExtensionAssociation.go b/service/appconfig/api_op_CreateExtensionAssociation.go index fea7b6550d5..0826867cd43 100644 --- a/service/appconfig/api_op_CreateExtensionAssociation.go +++ b/service/appconfig/api_op_CreateExtensionAssociation.go @@ -20,8 +20,7 @@ import ( // extension association is a specified relationship between an extension and an // AppConfig resource, such as an application or a configuration profile. For more // information about extensions and associations, see Working with AppConfig -// extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) CreateExtensionAssociation(ctx context.Context, params *CreateExtensionAssociationInput, optFns ...func(*Options)) (*CreateExtensionAssociationOutput, error) { if params == nil { @@ -58,10 +57,10 @@ type CreateExtensionAssociationInput struct { // marked Required must be entered for this field. Parameters map[string]string - // Adds one or more tags for the specified extension association. Tags are metadata - // that help you categorize resources in different ways, for example, by purpose, - // owner, or environment. Each tag consists of a key and an optional value, both of - // which you define. + // Adds one or more tags for the specified extension association. Tags are + // metadata that help you categorize resources in different ways, for example, by + // purpose, owner, or environment. Each tag consists of a key and an optional + // value, both of which you define. Tags map[string]string noSmithyDocumentSerde @@ -84,8 +83,8 @@ type CreateExtensionAssociationOutput struct { // The parameter names and values defined in the association. Parameters map[string]string - // The ARNs of applications, configuration profiles, or environments defined in the - // association. + // The ARNs of applications, configuration profiles, or environments defined in + // the association. ResourceArn *string // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_CreateHostedConfigurationVersion.go b/service/appconfig/api_op_CreateHostedConfigurationVersion.go index 862d5b7700d..29871b197fc 100644 --- a/service/appconfig/api_op_CreateHostedConfigurationVersion.go +++ b/service/appconfig/api_op_CreateHostedConfigurationVersion.go @@ -44,8 +44,8 @@ type CreateHostedConfigurationVersionInput struct { Content []byte // A standard MIME type describing the format of the configuration content. For - // more information, see Content-Type - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) + // . // // This member is required. ContentType *string @@ -80,8 +80,8 @@ type CreateHostedConfigurationVersionOutput struct { Content []byte // A standard MIME type describing the format of the configuration content. For - // more information, see Content-Type - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) + // . ContentType *string // A description of the configuration. diff --git a/service/appconfig/api_op_DeleteExtension.go b/service/appconfig/api_op_DeleteExtension.go index 8d4d9a43c7e..37a3c8ec026 100644 --- a/service/appconfig/api_op_DeleteExtension.go +++ b/service/appconfig/api_op_DeleteExtension.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppConfig extension. You must delete all associations to an extension -// before you delete the extension. +// Deletes an AppConfig extension. You must delete all associations to an +// extension before you delete the extension. func (c *Client) DeleteExtension(ctx context.Context, params *DeleteExtensionInput, optFns ...func(*Options)) (*DeleteExtensionOutput, error) { if params == nil { params = &DeleteExtensionInput{} @@ -34,8 +34,8 @@ type DeleteExtensionInput struct { // This member is required. ExtensionIdentifier *string - // A specific version of an extension to delete. If omitted, the highest version is - // deleted. + // A specific version of an extension to delete. If omitted, the highest version + // is deleted. VersionNumber *int32 noSmithyDocumentSerde diff --git a/service/appconfig/api_op_GetConfiguration.go b/service/appconfig/api_op_GetConfiguration.go index 28ca01c4663..58b54073f30 100644 --- a/service/appconfig/api_op_GetConfiguration.go +++ b/service/appconfig/api_op_GetConfiguration.go @@ -12,16 +12,12 @@ import ( // (Deprecated) Retrieves the latest deployed configuration. Note the following // important information. -// -// * This API action is deprecated. Calls to receive -// configuration data should use the StartConfigurationSession -// (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html) -// and GetLatestConfiguration -// (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) -// APIs instead. -// -// * GetConfiguration is a priced call. For more information, see -// Pricing (https://aws.amazon.com/systems-manager/pricing/). +// - This API action is deprecated. Calls to receive configuration data should +// use the StartConfigurationSession (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html) +// and GetLatestConfiguration (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) +// APIs instead. +// - GetConfiguration is a priced call. For more information, see Pricing (https://aws.amazon.com/systems-manager/pricing/) +// . // // Deprecated: This API has been deprecated in favor of the GetLatestConfiguration // API used in conjunction with StartConfigurationSession. @@ -67,24 +63,21 @@ type GetConfigurationInput struct { // This member is required. Environment *string - // The configuration version returned in the most recent GetConfiguration response. - // AppConfig uses the value of the ClientConfigurationVersion parameter to identify - // the configuration version on your clients. If you don’t send - // ClientConfigurationVersion with each call to GetConfiguration, your clients + // The configuration version returned in the most recent GetConfiguration + // response. AppConfig uses the value of the ClientConfigurationVersion parameter + // to identify the configuration version on your clients. If you don’t send + // ClientConfigurationVersion with each call to GetConfiguration , your clients // receive the current configuration. You are charged each time your clients // receive a configuration. To avoid excess charges, we recommend you use the - // StartConfigurationSession - // (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html) - // and GetLatestConfiguration - // (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html) + // StartConfigurationSession (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html) + // and GetLatestConfiguration (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html) // APIs, which track the client configuration version on your behalf. If you choose - // to continue using GetConfiguration, we recommend that you include the - // ClientConfigurationVersion value with every call to GetConfiguration. The value + // to continue using GetConfiguration , we recommend that you include the + // ClientConfigurationVersion value with every call to GetConfiguration . The value // to use for ClientConfigurationVersion comes from the ConfigurationVersion // attribute returned by GetConfiguration when there is new or updated data, and - // should be saved for subsequent calls to GetConfiguration. For more information - // about working with configurations, see Retrieving the Configuration - // (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html) + // should be saved for subsequent calls to GetConfiguration . For more information + // about working with configurations, see Retrieving the Configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html) // in the AppConfig User Guide. ClientConfigurationVersion *string @@ -104,8 +97,8 @@ type GetConfigurationOutput struct { Content []byte // A standard MIME type describing the format of the configuration content. For - // more information, see Content-Type - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // more information, see Content-Type (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) + // . ContentType *string // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_GetConfigurationProfile.go b/service/appconfig/api_op_GetConfigurationProfile.go index 99738ed27b3..37d301099aa 100644 --- a/service/appconfig/api_op_GetConfigurationProfile.go +++ b/service/appconfig/api_op_GetConfigurationProfile.go @@ -61,14 +61,14 @@ type GetConfigurationProfileOutput struct { Name *string // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. + // specified LocationUri . RetrievalRoleArn *string // The type of configurations contained in the profile. AppConfig supports feature // flags and freeform configurations. We recommend you create feature flag // configurations to enable or disable new features and freeform configurations to // distribute configurations to an application. When calling this API, enter one of - // the following values for Type: AWS.AppConfig.FeatureFlags + // the following values for Type : AWS.AppConfig.FeatureFlags // AWS.Freeform Type *string diff --git a/service/appconfig/api_op_GetDeployment.go b/service/appconfig/api_op_GetDeployment.go index 2787fac75db..94ff14bc49e 100644 --- a/service/appconfig/api_op_GetDeployment.go +++ b/service/appconfig/api_op_GetDeployment.go @@ -88,8 +88,8 @@ type GetDeploymentOutput struct { // The ID of the environment that was deployed. EnvironmentId *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. + // A list containing all events related to a deployment. The most recent events + // are displayed first. EventLog []types.DeploymentEvent // The amount of time that AppConfig monitored for alarms before considering the diff --git a/service/appconfig/api_op_GetDeploymentStrategy.go b/service/appconfig/api_op_GetDeploymentStrategy.go index 6a3b621412a..098355749ee 100644 --- a/service/appconfig/api_op_GetDeploymentStrategy.go +++ b/service/appconfig/api_op_GetDeploymentStrategy.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a deployment strategy. A deployment strategy defines -// important criteria for rolling out your configuration to the designated targets. -// A deployment strategy includes the overall duration required, a percentage of -// targets to receive the deployment during each interval, an algorithm that -// defines how percentage grows, and bake time. +// Retrieves information about a deployment strategy. A deployment strategy +// defines important criteria for rolling out your configuration to the designated +// targets. A deployment strategy includes the overall duration required, a +// percentage of targets to receive the deployment during each interval, an +// algorithm that defines how percentage grows, and bake time. func (c *Client) GetDeploymentStrategy(ctx context.Context, params *GetDeploymentStrategyInput, optFns ...func(*Options)) (*GetDeploymentStrategyOutput, error) { if params == nil { params = &GetDeploymentStrategyInput{} diff --git a/service/appconfig/api_op_GetEnvironment.go b/service/appconfig/api_op_GetEnvironment.go index 59c8ce813fd..ed33d1b3e90 100644 --- a/service/appconfig/api_op_GetEnvironment.go +++ b/service/appconfig/api_op_GetEnvironment.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about an environment. An environment is a deployment group -// of AppConfig applications, such as applications in a Production environment or -// in an EU_Region environment. Each configuration deployment targets an -// environment. You can enable one or more Amazon CloudWatch alarms for an -// environment. If an alarm is triggered during a deployment, AppConfig roles back -// the configuration. +// Retrieves information about an environment. An environment is a deployment +// group of AppConfig applications, such as applications in a Production +// environment or in an EU_Region environment. Each configuration deployment +// targets an environment. You can enable one or more Amazon CloudWatch alarms for +// an environment. If an alarm is triggered during a deployment, AppConfig roles +// back the configuration. func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error) { if params == nil { params = &GetEnvironmentInput{} @@ -65,7 +65,7 @@ type GetEnvironmentOutput struct { Name *string // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + // states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK State types.EnvironmentState // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_GetExtensionAssociation.go b/service/appconfig/api_op_GetExtensionAssociation.go index b2c0b8fb477..3f4b7e843ec 100644 --- a/service/appconfig/api_op_GetExtensionAssociation.go +++ b/service/appconfig/api_op_GetExtensionAssociation.go @@ -12,8 +12,7 @@ import ( // Returns information about an AppConfig extension association. For more // information about extensions and associations, see Working with AppConfig -// extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) GetExtensionAssociation(ctx context.Context, params *GetExtensionAssociationInput, optFns ...func(*Options)) (*GetExtensionAssociationOutput, error) { if params == nil { @@ -57,8 +56,8 @@ type GetExtensionAssociationOutput struct { // The parameter names and values defined in the association. Parameters map[string]string - // The ARNs of applications, configuration profiles, or environments defined in the - // association. + // The ARNs of applications, configuration profiles, or environments defined in + // the association. ResourceArn *string // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_GetHostedConfigurationVersion.go b/service/appconfig/api_op_GetHostedConfigurationVersion.go index be3374119e3..fc8cca3c652 100644 --- a/service/appconfig/api_op_GetHostedConfigurationVersion.go +++ b/service/appconfig/api_op_GetHostedConfigurationVersion.go @@ -58,8 +58,8 @@ type GetHostedConfigurationVersionOutput struct { Content []byte // A standard MIME type describing the format of the configuration content. For - // more information, see Content-Type - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) + // . ContentType *string // A description of the configuration. diff --git a/service/appconfig/api_op_ListExtensionAssociations.go b/service/appconfig/api_op_ListExtensionAssociations.go index c3dee3aebd1..0486a7b3e02 100644 --- a/service/appconfig/api_op_ListExtensionAssociations.go +++ b/service/appconfig/api_op_ListExtensionAssociations.go @@ -13,8 +13,7 @@ import ( ) // Lists all AppConfig extension associations in the account. For more information -// about extensions and associations, see Working with AppConfig extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// about extensions and associations, see Working with AppConfig extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) ListExtensionAssociations(ctx context.Context, params *ListExtensionAssociationsInput, optFns ...func(*Options)) (*ListExtensionAssociationsOutput, error) { if params == nil { @@ -43,8 +42,8 @@ type ListExtensionAssociationsInput struct { // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 - // A token to start the list. Use this token to get the next set of results or pass - // null to get the first set of results. + // A token to start the list. Use this token to get the next set of results or + // pass null to get the first set of results. NextToken *string // The ARN of an application, configuration profile, or environment. diff --git a/service/appconfig/api_op_ListExtensions.go b/service/appconfig/api_op_ListExtensions.go index b3e1070cb68..92724c7d43f 100644 --- a/service/appconfig/api_op_ListExtensions.go +++ b/service/appconfig/api_op_ListExtensions.go @@ -14,8 +14,7 @@ import ( // Lists all custom and Amazon Web Services authored AppConfig extensions in the // account. For more information about extensions, see Working with AppConfig -// extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) ListExtensions(ctx context.Context, params *ListExtensionsInput, optFns ...func(*Options)) (*ListExtensionsOutput, error) { if params == nil { @@ -49,8 +48,8 @@ type ListExtensionsInput struct { type ListExtensionsOutput struct { - // The list of available extensions. The list includes Amazon Web Services authored - // and user-created extensions. + // The list of available extensions. The list includes Amazon Web Services + // authored and user-created extensions. Items []types.ExtensionSummary // The token for the next set of items to return. Use this token to get the next diff --git a/service/appconfig/api_op_ListHostedConfigurationVersions.go b/service/appconfig/api_op_ListHostedConfigurationVersions.go index 41408ce841d..a9927786315 100644 --- a/service/appconfig/api_op_ListHostedConfigurationVersions.go +++ b/service/appconfig/api_op_ListHostedConfigurationVersions.go @@ -48,10 +48,10 @@ type ListHostedConfigurationVersionsInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string - // An optional filter that can be used to specify the version label of an AppConfig - // hosted configuration version. This parameter supports filtering by prefix using - // a wildcard, for example "v2*". If you don't specify an asterisk at the end of - // the value, only an exact match is returned. + // An optional filter that can be used to specify the version label of an + // AppConfig hosted configuration version. This parameter supports filtering by + // prefix using a wildcard, for example "v2*". If you don't specify an asterisk at + // the end of the value, only an exact match is returned. VersionLabel *string noSmithyDocumentSerde diff --git a/service/appconfig/api_op_StartDeployment.go b/service/appconfig/api_op_StartDeployment.go index f84459ae916..b3178896bcb 100644 --- a/service/appconfig/api_op_StartDeployment.go +++ b/service/appconfig/api_op_StartDeployment.go @@ -112,8 +112,8 @@ type StartDeploymentOutput struct { // The ID of the environment that was deployed. EnvironmentId *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. + // A list containing all events related to a deployment. The most recent events + // are displayed first. EventLog []types.DeploymentEvent // The amount of time that AppConfig monitored for alarms before considering the diff --git a/service/appconfig/api_op_StopDeployment.go b/service/appconfig/api_op_StopDeployment.go index 14f5e9ad6e3..2251336f0d8 100644 --- a/service/appconfig/api_op_StopDeployment.go +++ b/service/appconfig/api_op_StopDeployment.go @@ -12,8 +12,9 @@ import ( "time" ) -// Stops a deployment. This API action works only on deployments that have a status -// of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK. +// Stops a deployment. This API action works only on deployments that have a +// status of DEPLOYING . This action moves the deployment to a status of +// ROLLED_BACK . func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput, optFns ...func(*Options)) (*StopDeploymentOutput, error) { if params == nil { params = &StopDeploymentInput{} @@ -89,8 +90,8 @@ type StopDeploymentOutput struct { // The ID of the environment that was deployed. EnvironmentId *string - // A list containing all events related to a deployment. The most recent events are - // displayed first. + // A list containing all events related to a deployment. The most recent events + // are displayed first. EventLog []types.DeploymentEvent // The amount of time that AppConfig monitored for alarms before considering the diff --git a/service/appconfig/api_op_TagResource.go b/service/appconfig/api_op_TagResource.go index d81629ea9db..4ec7f84e60a 100644 --- a/service/appconfig/api_op_TagResource.go +++ b/service/appconfig/api_op_TagResource.go @@ -36,7 +36,7 @@ type TagResourceInput struct { ResourceArn *string // The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag - // key can be up to 128 characters and must not start with aws:. The tag value can + // key can be up to 128 characters and must not start with aws: . The tag value can // be up to 256 characters. // // This member is required. diff --git a/service/appconfig/api_op_UpdateConfigurationProfile.go b/service/appconfig/api_op_UpdateConfigurationProfile.go index 1ed15b449fc..74e19219629 100644 --- a/service/appconfig/api_op_UpdateConfigurationProfile.go +++ b/service/appconfig/api_op_UpdateConfigurationProfile.go @@ -46,7 +46,7 @@ type UpdateConfigurationProfileInput struct { Name *string // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. + // specified LocationUri . RetrievalRoleArn *string // A list of methods for validating the configuration. @@ -73,14 +73,14 @@ type UpdateConfigurationProfileOutput struct { Name *string // The ARN of an IAM role with permission to access the configuration at the - // specified LocationUri. + // specified LocationUri . RetrievalRoleArn *string // The type of configurations contained in the profile. AppConfig supports feature // flags and freeform configurations. We recommend you create feature flag // configurations to enable or disable new features and freeform configurations to // distribute configurations to an application. When calling this API, enter one of - // the following values for Type: AWS.AppConfig.FeatureFlags + // the following values for Type : AWS.AppConfig.FeatureFlags // AWS.Freeform Type *string diff --git a/service/appconfig/api_op_UpdateDeploymentStrategy.go b/service/appconfig/api_op_UpdateDeploymentStrategy.go index 077a5c4643f..be770adde7e 100644 --- a/service/appconfig/api_op_UpdateDeploymentStrategy.go +++ b/service/appconfig/api_op_UpdateDeploymentStrategy.go @@ -56,16 +56,15 @@ type UpdateDeploymentStrategyInput struct { // After 1/5th of the deployment time has passed, the system updates the percentage // to 40 percent. This continues until 100% of the targets are set to receive the // deployed configuration. Exponential: For this type, AppConfig processes the - // deployment exponentially using the following formula: G*(2^N). In this formula, + // deployment exponentially using the following formula: G*(2^N) . In this formula, // G is the growth factor specified by the user and N is the number of steps until // the configuration is deployed to all targets. For example, if you specify a // growth factor of 2, then the system rolls out the configuration as follows: // 2*(2^0) // 2*(2^1) - // - // 2*(2^2) Expressed numerically, the deployment rolls out as - // follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues - // until the configuration has been deployed to all targets. + // 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the + // targets, 4% of the targets, 8% of the targets, and continues until the + // configuration has been deployed to all targets. GrowthType types.GrowthType noSmithyDocumentSerde diff --git a/service/appconfig/api_op_UpdateEnvironment.go b/service/appconfig/api_op_UpdateEnvironment.go index 84035cfc325..cd8eedcf0b6 100644 --- a/service/appconfig/api_op_UpdateEnvironment.go +++ b/service/appconfig/api_op_UpdateEnvironment.go @@ -69,7 +69,7 @@ type UpdateEnvironmentOutput struct { Name *string // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + // states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK State types.EnvironmentState // Metadata pertaining to the operation's result. diff --git a/service/appconfig/api_op_UpdateExtension.go b/service/appconfig/api_op_UpdateExtension.go index 5d23b952f73..1229abfde3c 100644 --- a/service/appconfig/api_op_UpdateExtension.go +++ b/service/appconfig/api_op_UpdateExtension.go @@ -12,8 +12,7 @@ import ( ) // Updates an AppConfig extension. For more information about extensions, see -// Working with AppConfig extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// Working with AppConfig extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) UpdateExtension(ctx context.Context, params *UpdateExtensionInput, optFns ...func(*Options)) (*UpdateExtensionOutput, error) { if params == nil { diff --git a/service/appconfig/api_op_UpdateExtensionAssociation.go b/service/appconfig/api_op_UpdateExtensionAssociation.go index 756772d54d9..c07d4068628 100644 --- a/service/appconfig/api_op_UpdateExtensionAssociation.go +++ b/service/appconfig/api_op_UpdateExtensionAssociation.go @@ -11,8 +11,7 @@ import ( ) // Updates an association. For more information about extensions and associations, -// see Working with AppConfig extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// see Working with AppConfig extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. func (c *Client) UpdateExtensionAssociation(ctx context.Context, params *UpdateExtensionAssociationInput, optFns ...func(*Options)) (*UpdateExtensionAssociationOutput, error) { if params == nil { @@ -59,8 +58,8 @@ type UpdateExtensionAssociationOutput struct { // The parameter names and values defined in the association. Parameters map[string]string - // The ARNs of applications, configuration profiles, or environments defined in the - // association. + // The ARNs of applications, configuration profiles, or environments defined in + // the association. ResourceArn *string // Metadata pertaining to the operation's result. diff --git a/service/appconfig/doc.go b/service/appconfig/doc.go index 13be2a04c73..d5d2c84eed2 100644 --- a/service/appconfig/doc.go +++ b/service/appconfig/doc.go @@ -23,22 +23,15 @@ // monitor. Similar to error monitoring, if a deployment triggers an alarm, // AppConfig automatically rolls back to the previous version. AppConfig supports // multiple use cases. Here are some examples: +// - Feature flags: Use AppConfig to turn on new features that require a timely +// deployment, such as a product launch or announcement. +// - Application tuning: Use AppConfig to carefully introduce changes to your +// application that can only be tested with production traffic. +// - Allow list: Use AppConfig to allow premium subscribers to access paid +// content. +// - Operational issues: Use AppConfig to reduce stress on your application when +// a dependency or other external factor impacts the system. // -// * Feature flags: Use AppConfig to -// turn on new features that require a timely deployment, such as a product launch -// or announcement. -// -// * Application tuning: Use AppConfig to carefully introduce -// changes to your application that can only be tested with production traffic. -// -// * -// Allow list: Use AppConfig to allow premium subscribers to access paid -// content. -// -// * Operational issues: Use AppConfig to reduce stress on your -// application when a dependency or other external factor impacts the system. -// -// This -// reference is intended to be used with the AppConfig User Guide -// (http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html). +// This reference is intended to be used with the AppConfig User Guide (http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) +// . package appconfig diff --git a/service/appconfig/types/enums.go b/service/appconfig/types/enums.go index 33c4d9b64b0..4063199362e 100644 --- a/service/appconfig/types/enums.go +++ b/service/appconfig/types/enums.go @@ -53,9 +53,9 @@ const ( BytesMeasureKilobytes BytesMeasure = "KILOBYTES" ) -// Values returns all known values for BytesMeasure. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BytesMeasure. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BytesMeasure) Values() []BytesMeasure { return []BytesMeasure{ "KILOBYTES", diff --git a/service/appconfig/types/types.go b/service/appconfig/types/types.go index 108ebe79ce5..ca6c5c15e89 100644 --- a/service/appconfig/types/types.go +++ b/service/appconfig/types/types.go @@ -9,28 +9,18 @@ import ( // An action defines the tasks that the extension performs during the AppConfig // workflow. Each action includes an action point such as -// ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT. Each action +// ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action // also includes a name, a URI to an Lambda function, and an Amazon Resource Name // (ARN) for an Identity and Access Management assume role. You specify the name, // URI, and ARN for each action point defined in the extension. You can specify the // following actions for an extension: -// -// * -// PRE_CREATE_HOSTED_CONFIGURATION_VERSION -// -// * PRE_START_DEPLOYMENT -// -// * -// ON_DEPLOYMENT_START -// -// * ON_DEPLOYMENT_STEP -// -// * ON_DEPLOYMENT_BAKING -// -// * -// ON_DEPLOYMENT_COMPLETE -// -// * ON_DEPLOYMENT_ROLLED_BACK +// - PRE_CREATE_HOSTED_CONFIGURATION_VERSION +// - PRE_START_DEPLOYMENT +// - ON_DEPLOYMENT_START +// - ON_DEPLOYMENT_STEP +// - ON_DEPLOYMENT_BAKING +// - ON_DEPLOYMENT_COMPLETE +// - ON_DEPLOYMENT_ROLLED_BACK type Action struct { // Information about the action. @@ -152,7 +142,7 @@ type ConfigurationProfileSummary struct { // flags and freeform configurations. We recommend you create feature flag // configurations to enable or disable new features and freeform configurations to // distribute configurations to an application. When calling this API, enter one of - // the following values for Type: AWS.AppConfig.FeatureFlags + // the following values for Type : AWS.AppConfig.FeatureFlags // AWS.Freeform Type *string @@ -168,14 +158,14 @@ type DeploymentEvent struct { // The list of extensions that were invoked as part of the deployment. ActionInvocations []ActionInvocation - // A description of the deployment event. Descriptions include, but are not limited - // to, the user account or the Amazon CloudWatch alarm ARN that initiated a + // A description of the deployment event. Descriptions include, but are not + // limited to, the user account or the Amazon CloudWatch alarm ARN that initiated a // rollback, the percentage of hosts that received the deployment, or in the case // of an internal error, a recommendation to attempt a new deployment. Description *string - // The type of deployment event. Deployment event types include the start, stop, or - // completion of a deployment; a percentage update; the start or stop of a bake + // The type of deployment event. Deployment event types include the start, stop, + // or completion of a deployment; a percentage update; the start or stop of a bake // period; and the start or completion of a rollback. EventType DeploymentEventType @@ -279,7 +269,7 @@ type Environment struct { Name *string // The state of the environment. An environment can be in one of the following - // states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK + // states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK State EnvironmentState noSmithyDocumentSerde @@ -294,11 +284,11 @@ type ExtensionAssociationSummary struct { ExtensionArn *string // The extension association ID. This ID is used to call other ExtensionAssociation - // API actions such as GetExtensionAssociation or DeleteExtensionAssociation. + // API actions such as GetExtensionAssociation or DeleteExtensionAssociation . Id *string - // The ARNs of applications, configuration profiles, or environments defined in the - // association. + // The ARNs of applications, configuration profiles, or environments defined in + // the association. ResourceArn *string noSmithyDocumentSerde @@ -336,8 +326,8 @@ type HostedConfigurationVersionSummary struct { ConfigurationProfileId *string // A standard MIME type describing the format of the configuration content. For - // more information, see Content-Type - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) + // . ContentType *string // A description of the configuration. @@ -386,7 +376,7 @@ type Monitor struct { AlarmArn *string // ARN of an Identity and Access Management (IAM) role for AppConfig to monitor - // AlarmArn. + // AlarmArn . AlarmRoleArn *string noSmithyDocumentSerde @@ -395,8 +385,7 @@ type Monitor struct { // A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification // Service topic entered in an extension when invoked. Parameter values are // specified in an extension association. For more information about extensions, -// see Working with AppConfig extensions -// (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) +// see Working with AppConfig extensions (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) // in the AppConfig User Guide. type Parameter struct { diff --git a/service/appconfigdata/api_client.go b/service/appconfigdata/api_client.go index f419aec2854..7b6887c8ed9 100644 --- a/service/appconfigdata/api_client.go +++ b/service/appconfigdata/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appconfigdata/api_op_GetLatestConfiguration.go b/service/appconfigdata/api_op_GetLatestConfiguration.go index db54f6bf062..7059c7d41ca 100644 --- a/service/appconfigdata/api_op_GetLatestConfiguration.go +++ b/service/appconfigdata/api_op_GetLatestConfiguration.go @@ -14,18 +14,14 @@ import ( // configuration data if the client already has the latest version. For more // information about this API action and to view example CLI commands that show how // to use it with the StartConfigurationSession API action, see Retrieving the -// configuration -// (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) +// configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) // in the AppConfig User Guide. Note the following important information. -// -// * Each -// configuration token is only valid for one call to GetLatestConfiguration. The -// GetLatestConfiguration response includes a NextPollConfigurationToken that -// should always replace the token used for the just-completed call in preparation -// for the next one. -// -// * GetLatestConfiguration is a priced call. For more -// information, see Pricing (https://aws.amazon.com/systems-manager/pricing/). +// - Each configuration token is only valid for one call to +// GetLatestConfiguration . The GetLatestConfiguration response includes a +// NextPollConfigurationToken that should always replace the token used for the +// just-completed call in preparation for the next one. +// - GetLatestConfiguration is a priced call. For more information, see Pricing (https://aws.amazon.com/systems-manager/pricing/) +// . func (c *Client) GetLatestConfiguration(ctx context.Context, params *GetLatestConfigurationInput, optFns ...func(*Options)) (*GetLatestConfigurationOutput, error) { if params == nil { params = &GetLatestConfigurationInput{} @@ -45,12 +41,12 @@ type GetLatestConfigurationInput struct { // Token describing the current state of the configuration session. To obtain a // token, first call the StartConfigurationSession API. Note that every call to - // GetLatestConfiguration will return a new ConfigurationToken - // (NextPollConfigurationToken in the response) and must be provided to subsequent + // GetLatestConfiguration will return a new ConfigurationToken ( + // NextPollConfigurationToken in the response) and must be provided to subsequent // GetLatestConfiguration API calls. This token should only be used once. To // support long poll use cases, the token is valid for up to 24 hours. If a // GetLatestConfiguration call uses an expired token, the system returns - // BadRequestException. + // BadRequestException . // // This member is required. ConfigurationToken *string @@ -67,11 +63,11 @@ type GetLatestConfigurationOutput struct { // A standard MIME type describing the format of the configuration content. ContentType *string - // The latest token describing the current state of the configuration session. This - // must be provided to the next call to GetLatestConfiguration. This token should - // only be used once. To support long poll use cases, the token is valid for up to - // 24 hours. If a GetLatestConfiguration call uses an expired token, the system - // returns BadRequestException. + // The latest token describing the current state of the configuration session. + // This must be provided to the next call to GetLatestConfiguration. This token + // should only be used once. To support long poll use cases, the token is valid for + // up to 24 hours. If a GetLatestConfiguration call uses an expired token, the + // system returns BadRequestException . NextPollConfigurationToken *string // The amount of time the client should wait before polling for configuration diff --git a/service/appconfigdata/api_op_StartConfigurationSession.go b/service/appconfigdata/api_op_StartConfigurationSession.go index 30efb4469b0..463badb9d2f 100644 --- a/service/appconfigdata/api_op_StartConfigurationSession.go +++ b/service/appconfigdata/api_op_StartConfigurationSession.go @@ -13,8 +13,7 @@ import ( // Starts a configuration session used to retrieve a deployed configuration. For // more information about this API action and to view example CLI commands that // show how to use it with the GetLatestConfiguration API action, see Retrieving -// the configuration -// (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) +// the configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) // in the AppConfig User Guide. func (c *Client) StartConfigurationSession(ctx context.Context, params *StartConfigurationSessionInput, optFns ...func(*Options)) (*StartConfigurationSessionOutput, error) { if params == nil { @@ -58,14 +57,15 @@ type StartConfigurationSessionInput struct { type StartConfigurationSessionOutput struct { - // Token encapsulating state about the configuration session. Provide this token to - // the GetLatestConfiguration API to retrieve configuration data. This token should - // only be used once in your first call to GetLatestConfiguration. You must use the - // new token in the GetLatestConfiguration response (NextPollConfigurationToken) in - // each subsequent call to GetLatestConfiguration. The InitialConfigurationToken - // and NextPollConfigurationToken should only be used once. To support long poll - // use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration - // call uses an expired token, the system returns BadRequestException. + // Token encapsulating state about the configuration session. Provide this token + // to the GetLatestConfiguration API to retrieve configuration data. This token + // should only be used once in your first call to GetLatestConfiguration . You must + // use the new token in the GetLatestConfiguration response ( + // NextPollConfigurationToken ) in each subsequent call to GetLatestConfiguration . + // The InitialConfigurationToken and NextPollConfigurationToken should only be + // used once. To support long poll use cases, the tokens are valid for up to 24 + // hours. If a GetLatestConfiguration call uses an expired token, the system + // returns BadRequestException . InitialConfigurationToken *string // Metadata pertaining to the operation's result. diff --git a/service/appconfigdata/doc.go b/service/appconfigdata/doc.go index 1fd832cea7f..70a95261b9c 100644 --- a/service/appconfigdata/doc.go +++ b/service/appconfigdata/doc.go @@ -8,45 +8,36 @@ // configuration data by first establishing a configuration session using the // AppConfig Data StartConfigurationSession API action. Your session's client then // makes periodic calls to GetLatestConfiguration to check for and retrieve the -// latest data available. When calling StartConfigurationSession, your code sends +// latest data available. When calling StartConfigurationSession , your code sends // the following information: -// -// * Identifiers (ID or name) of an AppConfig -// application, environment, and configuration profile that the session tracks. -// -// * -// (Optional) The minimum amount of time the session's client must wait between -// calls to GetLatestConfiguration. -// -// In response, AppConfig provides an -// InitialConfigurationToken to be given to the session's client and used the first -// time it calls GetLatestConfiguration for that session. This token should only be -// used once in your first call to GetLatestConfiguration. You must use the new -// token in the GetLatestConfiguration response (NextPollConfigurationToken) in -// each subsequent call to GetLatestConfiguration. When calling -// GetLatestConfiguration, your client code sends the most recent -// ConfigurationToken value it has and receives in response: -// -// * -// NextPollConfigurationToken: the ConfigurationToken value to use on the next call -// to GetLatestConfiguration. -// -// * NextPollIntervalInSeconds: the duration the client -// should wait before making its next call to GetLatestConfiguration. This duration -// may vary over the course of the session, so it should be used instead of the -// value sent on the StartConfigurationSession call. -// -// * The configuration: the -// latest data intended for the session. This may be empty if the client already -// has the latest version of the configuration. -// -// The InitialConfigurationToken and -// NextPollConfigurationToken should only be used once. To support long poll use -// cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call -// uses an expired token, the system returns BadRequestException. For more -// information and to view example CLI commands that show how to retrieve a -// configuration using the AppConfig Data StartConfigurationSession and -// GetLatestConfiguration API actions, see Retrieving the configuration -// (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) +// - Identifiers (ID or name) of an AppConfig application, environment, and +// configuration profile that the session tracks. +// - (Optional) The minimum amount of time the session's client must wait +// between calls to GetLatestConfiguration . +// +// In response, AppConfig provides an InitialConfigurationToken to be given to the +// session's client and used the first time it calls GetLatestConfiguration for +// that session. This token should only be used once in your first call to +// GetLatestConfiguration . You must use the new token in the +// GetLatestConfiguration response ( NextPollConfigurationToken ) in each +// subsequent call to GetLatestConfiguration . When calling GetLatestConfiguration +// , your client code sends the most recent ConfigurationToken value it has and +// receives in response: +// - NextPollConfigurationToken : the ConfigurationToken value to use on the next +// call to GetLatestConfiguration . +// - NextPollIntervalInSeconds : the duration the client should wait before +// making its next call to GetLatestConfiguration . This duration may vary over +// the course of the session, so it should be used instead of the value sent on the +// StartConfigurationSession call. +// - The configuration: the latest data intended for the session. This may be +// empty if the client already has the latest version of the configuration. +// +// The InitialConfigurationToken and NextPollConfigurationToken should only be +// used once. To support long poll use cases, the tokens are valid for up to 24 +// hours. If a GetLatestConfiguration call uses an expired token, the system +// returns BadRequestException . For more information and to view example CLI +// commands that show how to retrieve a configuration using the AppConfig Data +// StartConfigurationSession and GetLatestConfiguration API actions, see +// Retrieving the configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) // in the AppConfig User Guide. package appconfigdata diff --git a/service/appconfigdata/types/enums.go b/service/appconfigdata/types/enums.go index 6e3cdc4fd69..897bef4d417 100644 --- a/service/appconfigdata/types/enums.go +++ b/service/appconfigdata/types/enums.go @@ -59,9 +59,9 @@ const ( ResourceTypeConfiguration ResourceType = "Configuration" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "Application", diff --git a/service/appflow/api_client.go b/service/appflow/api_client.go index a54401a9091..be5fecad9b9 100644 --- a/service/appflow/api_client.go +++ b/service/appflow/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appflow/api_op_DeleteFlow.go b/service/appflow/api_op_DeleteFlow.go index 230b0b88a0b..13c800ba23d 100644 --- a/service/appflow/api_op_DeleteFlow.go +++ b/service/appflow/api_op_DeleteFlow.go @@ -36,8 +36,8 @@ type DeleteFlowInput struct { // This member is required. FlowName *string - // Indicates whether Amazon AppFlow should delete the flow, even if it is currently - // in use. + // Indicates whether Amazon AppFlow should delete the flow, even if it is + // currently in use. ForceDelete bool noSmithyDocumentSerde diff --git a/service/appflow/api_op_DescribeConnectorProfiles.go b/service/appflow/api_op_DescribeConnectorProfiles.go index 12f9d6c5b54..a3857bb2fba 100644 --- a/service/appflow/api_op_DescribeConnectorProfiles.go +++ b/service/appflow/api_op_DescribeConnectorProfiles.go @@ -13,7 +13,7 @@ import ( ) // Returns a list of connector-profile details matching the provided -// connector-profile names and connector-types. Both input lists are optional, and +// connector-profile names and connector-types . Both input lists are optional, and // you can use them to filter the result. If no names or connector-types are // provided, returns all connector profiles in a paginated form. If there is no // match, this operation returns an empty list. @@ -46,8 +46,8 @@ type DescribeConnectorProfilesInput struct { // The type of connector, such as Salesforce, Amplitude, and so on. ConnectorType types.ConnectorType - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). MaxResults *int32 // The pagination token for the next page of data. @@ -61,7 +61,7 @@ type DescribeConnectorProfilesOutput struct { // Returns information about the connector profiles associated with the flow. ConnectorProfileDetails []types.ConnectorProfile - // The pagination token for the next page of data. If nextToken=null, this means + // The pagination token for the next page of data. If nextToken=null , this means // that all records have been fetched. NextToken *string @@ -142,8 +142,8 @@ var _ DescribeConnectorProfilesAPIClient = (*Client)(nil) // DescribeConnectorProfilesPaginatorOptions is the paginator options for // DescribeConnectorProfiles type DescribeConnectorProfilesPaginatorOptions struct { - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appflow/api_op_DescribeConnectors.go b/service/appflow/api_op_DescribeConnectors.go index 137aac37b22..1e7f11d3729 100644 --- a/service/appflow/api_op_DescribeConnectors.go +++ b/service/appflow/api_op_DescribeConnectors.go @@ -12,11 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the connectors vended by Amazon AppFlow for specified connector types. -// If you don't specify a connector type, this operation describes all connectors -// vended by Amazon AppFlow. If there are more connectors than can be returned in -// one page, the response contains a nextToken object, which can be be passed in to -// the next call to the DescribeConnectors API operation to retrieve the next page. +// Describes the connectors vended by Amazon AppFlow for specified connector +// types. If you don't specify a connector type, this operation describes all +// connectors vended by Amazon AppFlow. If there are more connectors than can be +// returned in one page, the response contains a nextToken object, which can be be +// passed in to the next call to the DescribeConnectors API operation to retrieve +// the next page. func (c *Client) DescribeConnectors(ctx context.Context, params *DescribeConnectorsInput, optFns ...func(*Options)) (*DescribeConnectorsOutput, error) { if params == nil { params = &DescribeConnectorsInput{} diff --git a/service/appflow/api_op_DescribeFlow.go b/service/appflow/api_op_DescribeFlow.go index 01553c0eb69..370cd128e64 100644 --- a/service/appflow/api_op_DescribeFlow.go +++ b/service/appflow/api_op_DescribeFlow.go @@ -95,13 +95,9 @@ type DescribeFlowOutput struct { // The version number of your data schema. Amazon AppFlow assigns this version // number. The version number increases by one when you change any of the following // settings in your flow configuration: - // - // * Source-to-destination field mappings - // - // * - // Field data types - // - // * Partition keys + // - Source-to-destination field mappings + // - Field data types + // - Partition keys SchemaVersion *int64 // The configuration that controls how Amazon AppFlow retrieves data from the diff --git a/service/appflow/api_op_DescribeFlowExecutionRecords.go b/service/appflow/api_op_DescribeFlowExecutionRecords.go index cc1a96f6d24..1657aebbc7e 100644 --- a/service/appflow/api_op_DescribeFlowExecutionRecords.go +++ b/service/appflow/api_op_DescribeFlowExecutionRecords.go @@ -36,8 +36,8 @@ type DescribeFlowExecutionRecordsInput struct { // This member is required. FlowName *string - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). MaxResults *int32 // The pagination token for the next page of data. @@ -134,8 +134,8 @@ var _ DescribeFlowExecutionRecordsAPIClient = (*Client)(nil) // DescribeFlowExecutionRecordsPaginatorOptions is the paginator options for // DescribeFlowExecutionRecords type DescribeFlowExecutionRecordsPaginatorOptions struct { - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appflow/api_op_ListConnectorEntities.go b/service/appflow/api_op_ListConnectorEntities.go index a60b8129cbe..b62e29255eb 100644 --- a/service/appflow/api_op_ListConnectorEntities.go +++ b/service/appflow/api_op_ListConnectorEntities.go @@ -42,12 +42,12 @@ type ListConnectorEntitiesInput struct { // The type of connector, such as Salesforce, Amplitude, and so on. ConnectorType types.ConnectorType - // This optional parameter is specific to connector implementation. Some connectors - // support multiple levels or categories of entities. You can find out the list of - // roots for such providers by sending a request without the entitiesPath - // parameter. If the connector supports entities at different roots, this initial - // request returns the list of roots. Otherwise, this request returns all entities - // supported by the provider. + // This optional parameter is specific to connector implementation. Some + // connectors support multiple levels or categories of entities. You can find out + // the list of roots for such providers by sending a request without the + // entitiesPath parameter. If the connector supports entities at different roots, + // this initial request returns the list of roots. Otherwise, this request returns + // all entities supported by the provider. EntitiesPath *string // The maximum number of items that the operation returns in the response. @@ -70,9 +70,9 @@ type ListConnectorEntitiesOutput struct { // This member is required. ConnectorEntityMap map[string][]types.ConnectorEntity - // A token that you specify in your next ListConnectorEntities operation to get the - // next page of results in paginated response. The ListConnectorEntities operation - // provides this token if the response is too big for the page size. + // A token that you specify in your next ListConnectorEntities operation to get + // the next page of results in paginated response. The ListConnectorEntities + // operation provides this token if the response is too big for the page size. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_ListConnectors.go b/service/appflow/api_op_ListConnectors.go index 84723482767..38b3339c6dd 100644 --- a/service/appflow/api_op_ListConnectors.go +++ b/service/appflow/api_op_ListConnectors.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of all registered custom connectors in your Amazon Web Services -// account. This API lists only custom connectors registered in this account, not -// the Amazon Web Services authored connectors. +// Returns the list of all registered custom connectors in your Amazon Web +// Services account. This API lists only custom connectors registered in this +// account, not the Amazon Web Services authored connectors. func (c *Client) ListConnectors(ctx context.Context, params *ListConnectorsInput, optFns ...func(*Options)) (*ListConnectorsOutput, error) { if params == nil { params = &ListConnectorsInput{} @@ -32,8 +32,8 @@ func (c *Client) ListConnectors(ctx context.Context, params *ListConnectorsInput type ListConnectorsInput struct { - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). MaxResults *int32 // The pagination token for the next page of data. @@ -127,8 +127,8 @@ var _ ListConnectorsAPIClient = (*Client)(nil) // ListConnectorsPaginatorOptions is the paginator options for ListConnectors type ListConnectorsPaginatorOptions struct { - // Specifies the maximum number of items that should be returned in the result set. - // The default for maxResults is 20 (for all paginated API operations). + // Specifies the maximum number of items that should be returned in the result + // set. The default for maxResults is 20 (for all paginated API operations). Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appflow/api_op_StartFlow.go b/service/appflow/api_op_StartFlow.go index 8030723ee10..8c03919ac3b 100644 --- a/service/appflow/api_op_StartFlow.go +++ b/service/appflow/api_op_StartFlow.go @@ -42,8 +42,8 @@ type StartFlowInput struct { type StartFlowOutput struct { - // Returns the internal execution ID of an on-demand flow when the flow is started. - // For scheduled or event-triggered flows, this value is null. + // Returns the internal execution ID of an on-demand flow when the flow is + // started. For scheduled or event-triggered flows, this value is null. ExecutionId *string // The flow's Amazon Resource Name (ARN). diff --git a/service/appflow/api_op_UpdateConnectorProfile.go b/service/appflow/api_op_UpdateConnectorProfile.go index 7ff028d4700..768217b2009 100644 --- a/service/appflow/api_op_UpdateConnectorProfile.go +++ b/service/appflow/api_op_UpdateConnectorProfile.go @@ -39,8 +39,8 @@ type UpdateConnectorProfileInput struct { // This member is required. ConnectorProfileConfig *types.ConnectorProfileConfig - // The name of the connector profile and is unique for each ConnectorProfile in the - // Amazon Web Services account. + // The name of the connector profile and is unique for each ConnectorProfile in + // the Amazon Web Services account. // // This member is required. ConnectorProfileName *string diff --git a/service/appflow/api_op_UpdateConnectorRegistration.go b/service/appflow/api_op_UpdateConnectorRegistration.go index 3f0cfd2935f..9b5960faf7d 100644 --- a/service/appflow/api_op_UpdateConnectorRegistration.go +++ b/service/appflow/api_op_UpdateConnectorRegistration.go @@ -13,12 +13,9 @@ import ( // Updates a custom connector that you've previously registered. This operation // updates the connector with one of the following: -// -// * The latest version of the -// AWS Lambda function that's assigned to the connector -// -// * A new AWS Lambda -// function that you specify +// - The latest version of the AWS Lambda function that's assigned to the +// connector +// - A new AWS Lambda function that you specify func (c *Client) UpdateConnectorRegistration(ctx context.Context, params *UpdateConnectorRegistrationInput, optFns ...func(*Options)) (*UpdateConnectorRegistrationOutput, error) { if params == nil { params = &UpdateConnectorRegistrationInput{} @@ -36,8 +33,8 @@ func (c *Client) UpdateConnectorRegistration(ctx context.Context, params *Update type UpdateConnectorRegistrationInput struct { - // The name of the connector. The name is unique for each connector registration in - // your AWS account. + // The name of the connector. The name is unique for each connector registration + // in your AWS account. // // This member is required. ConnectorLabel *string diff --git a/service/appflow/api_op_UpdateFlow.go b/service/appflow/api_op_UpdateFlow.go index 6fd328acab7..1de6c5be6c3 100644 --- a/service/appflow/api_op_UpdateFlow.go +++ b/service/appflow/api_op_UpdateFlow.go @@ -41,8 +41,8 @@ type UpdateFlowInput struct { // This member is required. FlowName *string - // Contains information about the configuration of the source connector used in the - // flow. + // Contains information about the configuration of the source connector used in + // the flow. // // This member is required. SourceFlowConfig *types.SourceFlowConfig diff --git a/service/appflow/doc.go b/service/appflow/doc.go index 744bfe693ce..1e786cee619 100644 --- a/service/appflow/doc.go +++ b/service/appflow/doc.go @@ -10,31 +10,21 @@ // like Salesforce, Marketo, Slack, and ServiceNow, and Amazon Web Services like // Amazon S3 and Amazon Redshift. Use the following links to get started on the // Amazon AppFlow API: +// - Actions (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html) +// : An alphabetical list of all Amazon AppFlow API operations. +// - Data types (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html) +// : An alphabetical list of all Amazon AppFlow data types. +// - Common parameters (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html) +// : Parameters that all Query operations can use. +// - Common errors (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html) +// : Client and server errors that all operations can return. // -// * Actions -// (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html): An -// alphabetical list of all Amazon AppFlow API operations. -// -// * Data types -// (https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html): An -// alphabetical list of all Amazon AppFlow data types. -// -// * Common parameters -// (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html): -// Parameters that all Query operations can use. -// -// * Common errors -// (https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html): Client -// and server errors that all operations can return. -// -// If you're new to Amazon -// AppFlow, we recommend that you review the Amazon AppFlow User Guide -// (https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html). -// Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and -// include applicable OAuth attributes (such as auth-code and redirecturi) with the -// connector-specific ConnectorProfileProperties when creating a new connector +// If you're new to Amazon AppFlow, we recommend that you review the Amazon +// AppFlow User Guide (https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html) +// . Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and +// include applicable OAuth attributes (such as auth-code and redirecturi ) with +// the connector-specific ConnectorProfileProperties when creating a new connector // profile using Amazon AppFlow API operations. For example, Salesforce users can -// refer to the Authorize Apps with OAuth -// (https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm) +// refer to the Authorize Apps with OAuth (https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm) // documentation. package appflow diff --git a/service/appflow/types/enums.go b/service/appflow/types/enums.go index 6c05148c2cd..348e7924eff 100644 --- a/service/appflow/types/enums.go +++ b/service/appflow/types/enums.go @@ -191,9 +191,9 @@ const ( DatadogConnectorOperatorNoOp DatadogConnectorOperator = "NO_OP" ) -// Values returns all known values for DatadogConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DatadogConnectorOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DatadogConnectorOperator) Values() []DatadogConnectorOperator { return []DatadogConnectorOperator{ "PROJECTION", @@ -222,9 +222,9 @@ const ( DataPullModeComplete DataPullMode = "Complete" ) -// Values returns all known values for DataPullMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DataPullMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DataPullMode) Values() []DataPullMode { return []DataPullMode{ "Incremental", @@ -427,9 +427,9 @@ const ( MarketoConnectorOperatorNoOp MarketoConnectorOperator = "NO_OP" ) -// Values returns all known values for MarketoConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MarketoConnectorOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MarketoConnectorOperator) Values() []MarketoConnectorOperator { return []MarketoConnectorOperator{ "PROJECTION", @@ -618,9 +618,9 @@ const ( OperatorsNoOp Operators = "NO_OP" ) -// Values returns all known values for Operators. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operators. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operators) Values() []Operators { return []Operators{ "PROJECTION", @@ -718,9 +718,9 @@ const ( PrefixFormatMinute PrefixFormat = "MINUTE" ) -// Values returns all known values for PrefixFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PrefixFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PrefixFormat) Values() []PrefixFormat { return []PrefixFormat{ "YEAR", @@ -1013,8 +1013,8 @@ const ( ScheduleFrequencyTypeOnce ScheduleFrequencyType = "ONCE" ) -// Values returns all known values for ScheduleFrequencyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ScheduleFrequencyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ScheduleFrequencyType) Values() []ScheduleFrequencyType { return []ScheduleFrequencyType{ @@ -1371,9 +1371,9 @@ const ( ZendeskConnectorOperatorNoOp ZendeskConnectorOperator = "NO_OP" ) -// Values returns all known values for ZendeskConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ZendeskConnectorOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ZendeskConnectorOperator) Values() []ZendeskConnectorOperator { return []ZendeskConnectorOperator{ "PROJECTION", diff --git a/service/appflow/types/errors.go b/service/appflow/types/errors.go index 656175c71c5..7fd2ba5cb21 100644 --- a/service/appflow/types/errors.go +++ b/service/appflow/types/errors.go @@ -194,8 +194,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// API calls have exceeded the maximum allowed API request rate per account and per -// Region. +// API calls have exceeded the maximum allowed API request rate per account and +// per Region. type ThrottlingException struct { Message *string diff --git a/service/appflow/types/types.go b/service/appflow/types/types.go index fb1b43bd2c7..8e318811521 100644 --- a/service/appflow/types/types.go +++ b/service/appflow/types/types.go @@ -7,18 +7,18 @@ import ( "time" ) -// The aggregation settings that you can use to customize the output format of your -// flow data. +// The aggregation settings that you can use to customize the output format of +// your flow data. type AggregationConfig struct { - // Specifies whether Amazon AppFlow aggregates the flow records into a single file, - // or leave them unaggregated. + // Specifies whether Amazon AppFlow aggregates the flow records into a single + // file, or leave them unaggregated. AggregationType AggregationType - // The desired file size, in MB, for each output file that Amazon AppFlow writes to - // the flow destination. For each file, Amazon AppFlow attempts to achieve the size - // that you specify. The actual file sizes might differ from this target based on - // the number and size of the records that each file contains. + // The desired file size, in MB, for each output file that Amazon AppFlow writes + // to the flow destination. For each file, Amazon AppFlow attempts to achieve the + // size that you specify. The actual file sizes might differ from this target based + // on the number and size of the records that each file contains. TargetFileSize *int64 noSmithyDocumentSerde @@ -163,8 +163,8 @@ type ConnectorConfiguration struct { // The label used for registering the connector. ConnectorLabel *string - // Specifies connector-specific metadata such as oAuthScopes, supportedRegions, - // privateLinkServiceUrl, and so on. + // Specifies connector-specific metadata such as oAuthScopes , supportedRegions , + // privateLinkServiceUrl , and so on. ConnectorMetadata *ConnectorMetadata // The connection modes that the connector supports. @@ -278,7 +278,7 @@ type ConnectorEntity struct { // Specifies whether the connector entity is a parent or a category and has more // entities nested underneath it. If another call is made with entitiesPath = - // "the_current_entity_name_with_hasNestedEntities_true", then it returns the + // "the_current_entity_name_with_hasNestedEntities_true" , then it returns the // nested entities underneath it. This provides a way to retrieve all supported // entities in a recursive fashion. HasNestedEntities bool @@ -327,15 +327,15 @@ type ConnectorEntityField struct { // as a source. SourceProperties *SourceFieldProperties - // Contains details regarding the supported FieldType, including the corresponding - // filterOperators and supportedValues. + // Contains details regarding the supported FieldType , including the corresponding + // filterOperators and supportedValues . SupportedFieldTypeDetails *SupportedFieldTypeDetails noSmithyDocumentSerde } -// A structure to specify connector-specific metadata such as oAuthScopes, -// supportedRegions, privateLinkServiceUrl, and so on. +// A structure to specify connector-specific metadata such as oAuthScopes , +// supportedRegions , privateLinkServiceUrl , and so on. type ConnectorMetadata struct { // The connector metadata specific to Amplitude. @@ -809,8 +809,8 @@ type CustomConnectorSourceProperties struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon Connect Customer Profiles is used as -// a destination. +// The properties that are applied when Amazon Connect Customer Profiles is used +// as a destination. type CustomerProfilesDestinationProperties struct { // The unique name of the Amazon Connect Customer Profiles domain. @@ -938,8 +938,8 @@ type DestinationFieldProperties struct { // operation. IsUpdatable bool - // Specifies if the flow run can either insert new rows in the destination field if - // they do not already exist, or update them if they do. + // Specifies if the flow run can either insert new rows in the destination field + // if they do not already exist, or update them if they do. IsUpsertable bool // A list of supported write operations. For each write operation listed, this @@ -1088,8 +1088,8 @@ type ExecutionDetails struct { // Specifies information about the past flow run instances for a given flow. type ExecutionRecord struct { - // The timestamp that indicates the last new or updated record to be transferred in - // the flow run. + // The timestamp that indicates the last new or updated record to be transferred + // in the flow run. DataPullEndTime *time.Time // The timestamp that determines the first new or updated record to be transferred @@ -1219,7 +1219,7 @@ type FlowDefinition struct { // The tags used to organize, track, or control access for your flow. Tags map[string]string - // Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event. + // Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event . TriggerType TriggerType noSmithyDocumentSerde @@ -1245,8 +1245,8 @@ type GlueDataCatalogConfig struct { // The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the // permissions it needs to create Data Catalog tables, databases, and partitions. // For an example IAM policy that has the required permissions, see Identity-based - // policy examples for Amazon AppFlow - // (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html). + // policy examples for Amazon AppFlow (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html) + // . // // This member is required. RoleArn *string @@ -1514,8 +1514,9 @@ type MarketoSourceProperties struct { noSmithyDocumentSerde } -// Specifies the configuration that Amazon AppFlow uses when it catalogs your data. -// When Amazon AppFlow catalogs your data, it stores metadata in a data catalog. +// Specifies the configuration that Amazon AppFlow uses when it catalogs your +// data. When Amazon AppFlow catalogs your data, it stores metadata in a data +// catalog. type MetadataCatalogConfig struct { // Specifies the configuration that Amazon AppFlow uses when it catalogs your data @@ -1547,9 +1548,9 @@ type MetadataCatalogDetail struct { // AppFlow stores the table in the metadata catalog. TableName *string - // Describes the status of the attempt from Amazon AppFlow to register the metadata - // table with the metadata catalog. Amazon AppFlow creates or updates this table - // for the associated flow run. + // Describes the status of the attempt from Amazon AppFlow to register the + // metadata table with the metadata catalog. Amazon AppFlow creates or updates this + // table for the associated flow run. TableRegistrationOutput *RegistrationOutput noSmithyDocumentSerde @@ -1761,17 +1762,13 @@ type PrefixConfig struct { // run. SCHEMA_VERSION The version number of your data schema. Amazon AppFlow // assigns this version number. The version number increases by one when you change // any of the following settings in your flow configuration: - // - // * - // Source-to-destination field mappings - // - // * Field data types - // - // * Partition keys + // - Source-to-destination field mappings + // - Field data types + // - Partition keys PathPrefixHierarchy []PathPrefix - // Determines the level of granularity for the date and time that's included in the - // prefix. + // Determines the level of granularity for the date and time that's included in + // the prefix. PrefixFormat PrefixFormat // Determines the format of the prefix, and whether it applies to the file name, @@ -1828,11 +1825,11 @@ type RedshiftConnectorProfileProperties struct { // This member is required. BucketName *string - // The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only - // access to Amazon S3. For more information, and for the polices that you attach - // to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in - // Amazon S3 - // (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3). + // The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift + // read-only access to Amazon S3. For more information, and for the polices that + // you attach to this role, see Allow Amazon Redshift to access your Amazon + // AppFlow data in Amazon S3 (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3) + // . // // This member is required. RoleArn *string @@ -1847,8 +1844,8 @@ type RedshiftConnectorProfileProperties struct { // The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to // access your Amazon Redshift database through the Data API. For more information, // and for the polices that you attach to this role, see Allow Amazon AppFlow to - // access Amazon Redshift databases with the Data API - // (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift). + // access Amazon Redshift databases with the Data API (https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift) + // . DataApiRoleArn *string // The name of an Amazon Redshift database. @@ -1960,8 +1957,8 @@ type S3Metadata struct { // output data when Amazon S3 is used as the destination. type S3OutputFormatConfig struct { - // The aggregation settings that you can use to customize the output format of your - // flow data. + // The aggregation settings that you can use to customize the output format of + // your flow data. AggregationConfig *AggregationConfig // Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. @@ -1974,14 +1971,12 @@ type S3OutputFormatConfig struct { // If your file output format is Parquet, use this parameter to set whether Amazon // AppFlow preserves the data types in your source data when it writes the output // to Amazon S3. - // - // * true: Amazon AppFlow preserves the data types when it writes to - // Amazon S3. For example, an integer or 1 in your source data is still an integer - // in your output. - // - // * false: Amazon AppFlow converts all of the source data into - // strings when it writes to Amazon S3. For example, an integer of 1 in your source - // data becomes the string "1" in the output. + // - true : Amazon AppFlow preserves the data types when it writes to Amazon S3. + // For example, an integer or 1 in your source data is still an integer in your + // output. + // - false : Amazon AppFlow converts all of the source data into strings when it + // writes to Amazon S3. For example, an integer of 1 in your source data becomes + // the string "1" in the output. PreserveSourceDataTyping *bool noSmithyDocumentSerde @@ -2035,37 +2030,24 @@ type SalesforceConnectorProfileProperties struct { // environment. IsSandboxEnvironment bool - // If the connection mode for the connector profile is private, this parameter sets - // whether Amazon AppFlow uses the private network to send metadata and + // If the connection mode for the connector profile is private, this parameter + // sets whether Amazon AppFlow uses the private network to send metadata and // authorization calls to Salesforce. Amazon AppFlow sends private calls through // Amazon Web Services PrivateLink. These calls travel through Amazon Web Services // infrastructure without being exposed to the public internet. Set either of the // following values: true Amazon AppFlow sends all calls to Salesforce over the // private network. These private calls are: - // - // * Calls to get metadata about your - // Salesforce records. This metadata describes your Salesforce objects and their - // fields. - // - // * Calls to get or refresh access tokens that allow Amazon AppFlow to - // access your Salesforce records. - // - // * Calls to transfer your Salesforce records as - // part of a flow run. - // - // false The default value. Amazon AppFlow sends some calls to - // Salesforce privately and other calls over the public internet. The public calls - // are: - // - // * Calls to get metadata about your Salesforce records. - // - // * Calls to get or - // refresh access tokens. - // + // - Calls to get metadata about your Salesforce records. This metadata + // describes your Salesforce objects and their fields. + // - Calls to get or refresh access tokens that allow Amazon AppFlow to access + // your Salesforce records. + // - Calls to transfer your Salesforce records as part of a flow run. + // false The default value. Amazon AppFlow sends some calls to Salesforce + // privately and other calls over the public internet. The public calls are: + // - Calls to get metadata about your Salesforce records. + // - Calls to get or refresh access tokens. // The private calls are: - // - // * Calls to transfer your - // Salesforce records as part of a flow run. + // - Calls to transfer your Salesforce records as part of a flow run. UsePrivateLinkForMetadataAndAuthorization bool noSmithyDocumentSerde @@ -2118,7 +2100,7 @@ type SalesforceDestinationProperties struct { IdFieldNames []string // This specifies the type of write operation to be performed in Salesforce. When - // the value is UPSERT, then idFieldNames is required. + // the value is UPSERT , then idFieldNames is required. WriteOperationType WriteOperationType noSmithyDocumentSerde @@ -2248,10 +2230,10 @@ type SAPODataDestinationProperties struct { // operation. IdFieldNames []string - // Determines how Amazon AppFlow handles the success response that it gets from the - // connector after placing data. For example, this setting would determine where to - // write the response from a destination connector upon a successful insert - // operation. + // Determines how Amazon AppFlow handles the success response that it gets from + // the connector after placing data. For example, this setting would determine + // where to write the response from a destination connector upon a successful + // insert operation. SuccessResponseHandlingConfig *SuccessResponseHandlingConfig // The possible write operations in the destination connector. When this value is @@ -2280,7 +2262,7 @@ type SAPODataSourceProperties struct { type ScheduledTriggerProperties struct { // The scheduling expression that determines the rate at which the schedule will - // run, for example rate(5minutes). + // run, for example rate(5minutes) . // // This member is required. ScheduleExpression *string @@ -2298,7 +2280,7 @@ type ScheduledTriggerProperties struct { FlowErrorDeactivationThreshold *int32 // The time at which the scheduled flow ends. The time is formatted as a timestamp - // that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00. + // that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00 . ScheduleEndTime *time.Time // Specifies the optional offset that is added to the time interval for a @@ -2306,16 +2288,16 @@ type ScheduledTriggerProperties struct { ScheduleOffset *int64 // The time at which the scheduled flow starts. The time is formatted as a - // timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00. + // timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00 . ScheduleStartTime *time.Time // Specifies the time zone used when referring to the dates and times of a - // scheduled flow, such as America/New_York. This time zone is only a descriptive + // scheduled flow, such as America/New_York . This time zone is only a descriptive // label. It doesn't affect how Amazon AppFlow interprets the timestamps that you // specify to schedule the flow. If you want to schedule a flow by using times in a // particular time zone, indicate the time zone as a UTC offset in your timestamps. // For example, the UTC offsets for the America/New_York timezone are -04:00 EDT - // and -05:00 EST. + // and -05:00 EST . Timezone *string noSmithyDocumentSerde @@ -2614,8 +2596,8 @@ type SourceFieldProperties struct { noSmithyDocumentSerde } -// Contains information about the configuration of the source connector used in the -// flow. +// Contains information about the configuration of the source connector used in +// the flow. type SourceFlowConfig struct { // The type of connector, such as Salesforce, Amplitude, and so on. @@ -2644,10 +2626,10 @@ type SourceFlowConfig struct { noSmithyDocumentSerde } -// Determines how Amazon AppFlow handles the success response that it gets from the -// connector after placing data. For example, this setting would determine where to -// write the response from the destination connector upon a successful insert -// operation. +// Determines how Amazon AppFlow handles the success response that it gets from +// the connector after placing data. For example, this setting would determine +// where to write the response from the destination connector upon a successful +// insert operation. type SuccessResponseHandlingConfig struct { // The name of the Amazon S3 bucket. @@ -2660,10 +2642,10 @@ type SuccessResponseHandlingConfig struct { } // Contains details regarding all the supported FieldTypes and their corresponding -// filterOperators and supportedValues. +// filterOperators and supportedValues . type SupportedFieldTypeDetails struct { - // The initial supported version for fieldType. If this is later changed to a + // The initial supported version for fieldType . If this is later changed to a // different version, v2 will be introduced. // // This member is required. @@ -2673,7 +2655,7 @@ type SupportedFieldTypeDetails struct { } // A class for modeling different type of tasks. Task implementation varies based -// on the TaskType. +// on the TaskType . type Task struct { // The source fields to which a particular task is applied. @@ -2694,7 +2676,7 @@ type Task struct { DestinationField *string // A map used to store task-related information. The execution service looks for - // particular information based on the TaskType. + // particular information based on the TaskType . TaskProperties map[string]string noSmithyDocumentSerde @@ -2736,7 +2718,7 @@ type TrendmicroSourceProperties struct { // specified flow. type TriggerConfig struct { - // Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event. + // Specifies the type of flow trigger. This can be OnDemand , Scheduled , or Event . // // This member is required. TriggerType TriggerType @@ -2768,8 +2750,8 @@ type UpsolverDestinationProperties struct { // This member is required. BucketName *string - // The configuration that determines how data is formatted when Upsolver is used as - // the flow destination. + // The configuration that determines how data is formatted when Upsolver is used + // as the flow destination. // // This member is required. S3OutputFormatConfig *UpsolverS3OutputFormatConfig @@ -2796,8 +2778,8 @@ type UpsolverS3OutputFormatConfig struct { // This member is required. PrefixConfig *PrefixConfig - // The aggregation settings that you can use to customize the output format of your - // flow data. + // The aggregation settings that you can use to customize the output format of + // your flow data. AggregationConfig *AggregationConfig // Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 diff --git a/service/appintegrations/api_client.go b/service/appintegrations/api_client.go index 70df3ef366d..fc2a9b530f4 100644 --- a/service/appintegrations/api_client.go +++ b/service/appintegrations/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appintegrations/api_op_CreateDataIntegration.go b/service/appintegrations/api_op_CreateDataIntegration.go index 0bb0ca8d926..f21cfc5a801 100644 --- a/service/appintegrations/api_op_CreateDataIntegration.go +++ b/service/appintegrations/api_op_CreateDataIntegration.go @@ -56,8 +56,8 @@ type CreateDataIntegrationInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A description of the DataIntegration. @@ -84,8 +84,8 @@ type CreateDataIntegrationOutput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A description of the DataIntegration. diff --git a/service/appintegrations/api_op_CreateEventIntegration.go b/service/appintegrations/api_op_CreateEventIntegration.go index 566aa84dee1..e69e42de09f 100644 --- a/service/appintegrations/api_op_CreateEventIntegration.go +++ b/service/appintegrations/api_op_CreateEventIntegration.go @@ -51,8 +51,8 @@ type CreateEventIntegrationInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The description of the event integration. diff --git a/service/appintegrations/api_op_DeleteDataIntegration.go b/service/appintegrations/api_op_DeleteDataIntegration.go index 5592e798315..03278ef3853 100644 --- a/service/appintegrations/api_op_DeleteDataIntegration.go +++ b/service/appintegrations/api_op_DeleteDataIntegration.go @@ -15,8 +15,7 @@ import ( // deletes the underlying Amazon AppFlow flow and service linked role. You cannot // create a DataIntegration association for a DataIntegration that has been // previously associated. Use a different DataIntegration, or recreate the -// DataIntegration using the CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // API. func (c *Client) DeleteDataIntegration(ctx context.Context, params *DeleteDataIntegrationInput, optFns ...func(*Options)) (*DeleteDataIntegrationOutput, error) { if params == nil { diff --git a/service/appintegrations/api_op_GetDataIntegration.go b/service/appintegrations/api_op_GetDataIntegration.go index 99a7797ea5a..e6bff1aaedb 100644 --- a/service/appintegrations/api_op_GetDataIntegration.go +++ b/service/appintegrations/api_op_GetDataIntegration.go @@ -14,8 +14,7 @@ import ( // Returns information about the DataIntegration. You cannot create a // DataIntegration association for a DataIntegration that has been previously // associated. Use a different DataIntegration, or recreate the DataIntegration -// using the CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // API. func (c *Client) GetDataIntegration(ctx context.Context, params *GetDataIntegrationInput, optFns ...func(*Options)) (*GetDataIntegrationOutput, error) { if params == nil { diff --git a/service/appintegrations/api_op_ListDataIntegrationAssociations.go b/service/appintegrations/api_op_ListDataIntegrationAssociations.go index c8ba4527f14..c36993c83f1 100644 --- a/service/appintegrations/api_op_ListDataIntegrationAssociations.go +++ b/service/appintegrations/api_op_ListDataIntegrationAssociations.go @@ -14,8 +14,7 @@ import ( // Returns a paginated list of DataIntegration associations in the account. You // cannot create a DataIntegration association for a DataIntegration that has been // previously associated. Use a different DataIntegration, or recreate the -// DataIntegration using the CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// DataIntegration using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // API. func (c *Client) ListDataIntegrationAssociations(ctx context.Context, params *ListDataIntegrationAssociationsInput, optFns ...func(*Options)) (*ListDataIntegrationAssociationsOutput, error) { if params == nil { diff --git a/service/appintegrations/api_op_ListDataIntegrations.go b/service/appintegrations/api_op_ListDataIntegrations.go index a318c8d496e..4fd64d8bf4b 100644 --- a/service/appintegrations/api_op_ListDataIntegrations.go +++ b/service/appintegrations/api_op_ListDataIntegrations.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a paginated list of DataIntegrations in the account. You cannot create a -// DataIntegration association for a DataIntegration that has been previously +// Returns a paginated list of DataIntegrations in the account. You cannot create +// a DataIntegration association for a DataIntegration that has been previously // associated. Use a different DataIntegration, or recreate the DataIntegration -// using the CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // API. func (c *Client) ListDataIntegrations(ctx context.Context, params *ListDataIntegrationsInput, optFns ...func(*Options)) (*ListDataIntegrationsOutput, error) { if params == nil { diff --git a/service/appintegrations/api_op_UpdateDataIntegration.go b/service/appintegrations/api_op_UpdateDataIntegration.go index 95c838d7c2f..a080dc4ce2f 100644 --- a/service/appintegrations/api_op_UpdateDataIntegration.go +++ b/service/appintegrations/api_op_UpdateDataIntegration.go @@ -13,8 +13,7 @@ import ( // Updates the description of a DataIntegration. You cannot create a // DataIntegration association for a DataIntegration that has been previously // associated. Use a different DataIntegration, or recreate the DataIntegration -// using the CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // API. func (c *Client) UpdateDataIntegration(ctx context.Context, params *UpdateDataIntegrationInput, optFns ...func(*Options)) (*UpdateDataIntegrationOutput, error) { if params == nil { diff --git a/service/appintegrations/doc.go b/service/appintegrations/doc.go index e8707c21ae6..eca3f2a18a2 100644 --- a/service/appintegrations/doc.go +++ b/service/appintegrations/doc.go @@ -1,13 +1,11 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package appintegrations provides the API client, operations, and parameter types -// for Amazon AppIntegrations Service. +// Package appintegrations provides the API client, operations, and parameter +// types for Amazon AppIntegrations Service. // // The Amazon AppIntegrations service enables you to configure and reuse // connections to external applications. For information about how you can use -// external applications with Amazon Connect, see Set up pre-built integrations -// (https://docs.aws.amazon.com/connect/latest/adminguide/crm.html) and Deliver -// information to agents using Amazon Connect Wisdom -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-wisdom.html) +// external applications with Amazon Connect, see Set up pre-built integrations (https://docs.aws.amazon.com/connect/latest/adminguide/crm.html) +// and Deliver information to agents using Amazon Connect Wisdom (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-wisdom.html) // in the Amazon Connect Administrator Guide. package appintegrations diff --git a/service/applicationautoscaling/api_client.go b/service/applicationautoscaling/api_client.go index 407b7b07f44..ba646c85199 100644 --- a/service/applicationautoscaling/api_client.go +++ b/service/applicationautoscaling/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go index a7e884dfd6a..c9eb2d3f7de 100644 --- a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go +++ b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go @@ -15,10 +15,8 @@ import ( // target. Deleting a step scaling policy deletes the underlying alarm action, but // does not delete the CloudWatch alarm associated with the scaling policy, even if // it no longer has an associated action. For more information, see Delete a step -// scaling policy -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy) -// and Delete a target tracking scaling policy -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html#delete-target-tracking-policy) +// scaling policy (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy) +// and Delete a target tracking scaling policy (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html#delete-target-tracking-policy) // in the Application Auto Scaling User Guide. func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingPolicyInput, optFns ...func(*Options)) (*DeleteScalingPolicyOutput, error) { if params == nil { @@ -44,160 +42,103 @@ type DeleteScalingPolicyInput struct { // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. diff --git a/service/applicationautoscaling/api_op_DeleteScheduledAction.go b/service/applicationautoscaling/api_op_DeleteScheduledAction.go index 50b4fdba796..41357cab475 100644 --- a/service/applicationautoscaling/api_op_DeleteScheduledAction.go +++ b/service/applicationautoscaling/api_op_DeleteScheduledAction.go @@ -12,8 +12,7 @@ import ( ) // Deletes the specified scheduled action for an Application Auto Scaling scalable -// target. For more information, see Delete a scheduled action -// (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html#delete-scheduled-action) +// target. For more information, see Delete a scheduled action (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html#delete-scheduled-action) // in the Application Auto Scaling User Guide. func (c *Client) DeleteScheduledAction(ctx context.Context, params *DeleteScheduledActionInput, optFns ...func(*Options)) (*DeleteScheduledActionOutput, error) { if params == nil { @@ -32,156 +31,99 @@ func (c *Client) DeleteScheduledAction(ctx context.Context, params *DeleteSchedu type DeleteScheduledActionInput struct { - // The identifier of the resource associated with the scheduled action. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource associated with the scheduled action. This + // string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension @@ -191,8 +133,8 @@ type DeleteScheduledActionInput struct { // This member is required. ScheduledActionName *string - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. diff --git a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go index a477a4a38dc..332a2775b31 100644 --- a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go @@ -13,9 +13,8 @@ import ( // Deregisters an Application Auto Scaling scalable target when you have finished // using it. To see which resources have been registered, use -// DescribeScalableTargets -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html). -// Deregistering a scalable target deletes the scaling policies and the scheduled +// DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html) +// . Deregistering a scalable target deletes the scaling policies and the scheduled // actions that are associated with it. func (c *Client) DeregisterScalableTarget(ctx context.Context, params *DeregisterScalableTargetInput, optFns ...func(*Options)) (*DeregisterScalableTargetOutput, error) { if params == nil { @@ -36,160 +35,103 @@ type DeregisterScalableTargetInput struct { // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string - // The scalable dimension associated with the scalable target. This string consists - // of the service namespace, resource type, and scaling property. - // - // * - // ecs:service:DesiredCount - The desired task count of an ECS service. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity - // of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of an - // AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. - // - // * sagemaker:variant:DesiredInstanceCount - The - // number of EC2 instances for a SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // * - // comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend entity recognizer endpoint. - // - // * - // lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * cassandra:table:WriteCapacityUnits - - // The provisioned write capacity for an Amazon Keyspaces table. - // - // * - // kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for - // brokers in an Amazon MSK cluster. - // - // * elasticache:replication-group:NodeGroups - - // The number of node groups for an Amazon ElastiCache replication group. - // - // * - // elasticache:replication-group:Replicas - The number of replicas per node group - // for an Amazon ElastiCache replication group. - // - // * neptune:cluster:ReadReplicaCount - // - The count of read replicas in an Amazon Neptune DB cluster. + // The scalable dimension associated with the scalable target. This string + // consists of the service namespace, resource type, and scaling property. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. diff --git a/service/applicationautoscaling/api_op_DescribeScalableTargets.go b/service/applicationautoscaling/api_op_DescribeScalableTargets.go index 20f176c0735..691b8da6a8e 100644 --- a/service/applicationautoscaling/api_op_DescribeScalableTargets.go +++ b/service/applicationautoscaling/api_op_DescribeScalableTargets.go @@ -13,7 +13,7 @@ import ( ) // Gets information about the scalable targets in the specified namespace. You can -// filter the results using ResourceIds and ScalableDimension. +// filter the results using ResourceIds and ScalableDimension . func (c *Client) DescribeScalableTargets(ctx context.Context, params *DescribeScalableTargetsInput, optFns ...func(*Options)) (*DescribeScalableTargetsOutput, error) { if params == nil { params = &DescribeScalableTargetsInput{} @@ -31,8 +31,8 @@ func (c *Client) DescribeScalableTargets(ctx context.Context, params *DescribeSc type DescribeScalableTargetsInput struct { - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -51,153 +51,96 @@ type DescribeScalableTargetsInput struct { // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . ResourceIds []string - // The scalable dimension associated with the scalable target. This string consists - // of the service namespace, resource type, and scaling property. If you specify a - // scalable dimension, you must also specify a resource ID. - // - // * - // ecs:service:DesiredCount - The desired task count of an ECS service. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity - // of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of an - // AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. - // - // * sagemaker:variant:DesiredInstanceCount - The - // number of EC2 instances for a SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // * - // comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend entity recognizer endpoint. - // - // * - // lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * cassandra:table:WriteCapacityUnits - - // The provisioned write capacity for an Amazon Keyspaces table. - // - // * - // kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for - // brokers in an Amazon MSK cluster. - // - // * elasticache:replication-group:NodeGroups - - // The number of node groups for an Amazon ElastiCache replication group. - // - // * - // elasticache:replication-group:Replicas - The number of replicas per node group - // for an Amazon ElastiCache replication group. - // - // * neptune:cluster:ReadReplicaCount - // - The count of read replicas in an Amazon Neptune DB cluster. + // The scalable dimension associated with the scalable target. This string + // consists of the service namespace, resource type, and scaling property. If you + // specify a scalable dimension, you must also specify a resource ID. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. ScalableDimension types.ScalableDimension noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_DescribeScalingActivities.go b/service/applicationautoscaling/api_op_DescribeScalingActivities.go index fb63e945eeb..a477907f11b 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingActivities.go +++ b/service/applicationautoscaling/api_op_DescribeScalingActivities.go @@ -14,10 +14,10 @@ import ( // Provides descriptive information about the scaling activities in the specified // namespace from the previous six weeks. You can filter the results using -// ResourceId and ScalableDimension. For information about viewing scaling +// ResourceId and ScalableDimension . For information about viewing scaling // activities using the Amazon Web Services CLI, see Scaling activities for -// Application Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html). +// Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) +// . func (c *Client) DescribeScalingActivities(ctx context.Context, params *DescribeScalingActivitiesInput, optFns ...func(*Options)) (*DescribeScalingActivitiesOutput, error) { if params == nil { params = &DescribeScalingActivitiesInput{} @@ -35,8 +35,8 @@ func (c *Client) DescribeScalingActivities(ctx context.Context, params *Describe type DescribeScalingActivitiesInput struct { - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -46,8 +46,8 @@ type DescribeScalingActivitiesInput struct { // activities) in the response. Not scaled activities are activities that aren't // completed or started for various reasons, such as preventing infinite scaling // loops. For help interpreting the not scaled reason details in the response, see - // Scaling activities for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html). + // Scaling activities for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) + // . IncludeNotScaledActivities *bool // The maximum number of scalable targets. This value can be between 1 and 50. The @@ -61,155 +61,98 @@ type DescribeScalingActivitiesInput struct { // The token for the next set of results. NextToken *string - // The identifier of the resource associated with the scaling activity. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource associated with the scaling activity. This + // string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. If you specify a scalable dimension, you must also // specify a resource ID. - // - // * ecs:service:DesiredCount - The desired task count of - // an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The instance - // count of an EMR Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The - // target capacity of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The - // desired capacity of an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - // - The provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. ScalableDimension types.ScalableDimension noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_DescribeScalingPolicies.go b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go index 894bfe2856e..b5bae99f014 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingPolicies.go +++ b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go @@ -13,12 +13,10 @@ import ( ) // Describes the Application Auto Scaling scaling policies for the specified -// service namespace. You can filter the results using ResourceId, -// ScalableDimension, and PolicyNames. For more information, see Target tracking -// scaling policies -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) -// and Step scaling policies -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) +// service namespace. You can filter the results using ResourceId , +// ScalableDimension , and PolicyNames . For more information, see Target tracking +// scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) +// and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) // in the Application Auto Scaling User Guide. func (c *Client) DescribeScalingPolicies(ctx context.Context, params *DescribeScalingPoliciesInput, optFns ...func(*Options)) (*DescribeScalingPoliciesOutput, error) { if params == nil { @@ -37,8 +35,8 @@ func (c *Client) DescribeScalingPolicies(ctx context.Context, params *DescribeSc type DescribeScalingPoliciesInput struct { - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -60,153 +58,96 @@ type DescribeScalingPoliciesInput struct { // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. If you specify a scalable dimension, you must also // specify a resource ID. - // - // * ecs:service:DesiredCount - The desired task count of - // an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The instance - // count of an EMR Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The - // target capacity of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The - // desired capacity of an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - // - The provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. ScalableDimension types.ScalableDimension noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_DescribeScheduledActions.go b/service/applicationautoscaling/api_op_DescribeScheduledActions.go index 52781e8eb6b..cab8fd78ec7 100644 --- a/service/applicationautoscaling/api_op_DescribeScheduledActions.go +++ b/service/applicationautoscaling/api_op_DescribeScheduledActions.go @@ -13,12 +13,10 @@ import ( ) // Describes the Application Auto Scaling scheduled actions for the specified -// service namespace. You can filter the results using the ResourceId, -// ScalableDimension, and ScheduledActionNames parameters. For more information, -// see Scheduled scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) -// and Managing scheduled scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html) +// service namespace. You can filter the results using the ResourceId , +// ScalableDimension , and ScheduledActionNames parameters. For more information, +// see Scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) +// and Managing scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html) // in the Application Auto Scaling User Guide. func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeScheduledActionsInput, optFns ...func(*Options)) (*DescribeScheduledActionsOutput, error) { if params == nil { @@ -37,8 +35,8 @@ func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeS type DescribeScheduledActionsInput struct { - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -55,155 +53,98 @@ type DescribeScheduledActionsInput struct { // The token for the next set of results. NextToken *string - // The identifier of the resource associated with the scheduled action. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource associated with the scheduled action. This + // string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. If you specify a scalable dimension, you must also // specify a resource ID. - // - // * ecs:service:DesiredCount - The desired task count of - // an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The instance - // count of an EMR Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The - // target capacity of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The - // desired capacity of an AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - // - The provisioned read capacity for a DynamoDB table. - // - // * - // dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. ScalableDimension types.ScalableDimension // The names of the scheduled actions to describe. diff --git a/service/applicationautoscaling/api_op_ListTagsForResource.go b/service/applicationautoscaling/api_op_ListTagsForResource.go index 4708df06fc9..eee83300586 100644 --- a/service/applicationautoscaling/api_op_ListTagsForResource.go +++ b/service/applicationautoscaling/api_op_ListTagsForResource.go @@ -11,10 +11,9 @@ import ( ) // Returns all the tags on the specified Application Auto Scaling scalable target. -// For general information about tags, including the format and syntax, see Tagging -// Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. +// For general information about tags, including the format and syntax, see +// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -34,7 +33,7 @@ type ListTagsForResourceInput struct { // Specify the ARN of the scalable target. For example: // arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 - // To get the ARN for a scalable target, use DescribeScalableTargets. + // To get the ARN for a scalable target, use DescribeScalableTargets . // // This member is required. ResourceARN *string diff --git a/service/applicationautoscaling/api_op_PutScalingPolicy.go b/service/applicationautoscaling/api_op_PutScalingPolicy.go index 92ee4ed70c9..5ea7e58e033 100644 --- a/service/applicationautoscaling/api_op_PutScalingPolicy.go +++ b/service/applicationautoscaling/api_op_PutScalingPolicy.go @@ -31,10 +31,8 @@ import ( // policy is ready to scale in, the scale-in activity will not be blocked. After // the scale-in activity completes, the target tracking policy could instruct the // scalable target to scale out again. For more information, see Target tracking -// scaling policies -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) -// and Step scaling policies -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) +// scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) +// and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) // in the Application Auto Scaling User Guide. If a scalable target is // deregistered, the scalable target is no longer available to use scaling // policies. Any scaling policies that were specified for the scalable target are @@ -65,184 +63,124 @@ type PutScalingPolicyInput struct { // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. ServiceNamespace types.ServiceNamespace // The scaling policy type. This parameter is required if you are creating a - // scaling policy. The following policy types are supported: - // TargetTrackingScaling—Not supported for Amazon EMR StepScaling—Not supported for - // DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon - // ElastiCache, or Neptune. For more information, see Target tracking scaling - // policies - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) - // and Step scaling policies - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) + // scaling policy. The following policy types are supported: TargetTrackingScaling + // —Not supported for Amazon EMR StepScaling —Not supported for DynamoDB, Amazon + // Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or + // Neptune. For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) + // and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) // in the Application Auto Scaling User Guide. PolicyType types.PolicyType // A step scaling policy. This parameter is required if you are creating a policy - // and the policy type is StepScaling. + // and the policy type is StepScaling . StepScalingPolicyConfiguration *types.StepScalingPolicyConfiguration // A target tracking scaling policy. Includes support for predefined or customized // metrics. This parameter is required if you are creating a policy and the policy - // type is TargetTrackingScaling. + // type is TargetTrackingScaling . TargetTrackingScalingPolicyConfiguration *types.TargetTrackingScalingPolicyConfiguration noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_PutScheduledAction.go b/service/applicationautoscaling/api_op_PutScheduledAction.go index c245810ebb8..033651ed2ee 100644 --- a/service/applicationautoscaling/api_op_PutScheduledAction.go +++ b/service/applicationautoscaling/api_op_PutScheduledAction.go @@ -21,8 +21,7 @@ import ( // form the boundaries for when the recurring action starts and stops. To update a // scheduled action, specify the parameters that you want to change. If you don't // specify start and end times, the old values are deleted. For more information, -// see Scheduled scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) +// see Scheduled scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) // in the Application Auto Scaling User Guide. If a scalable target is // deregistered, the scalable target is no longer available to run scheduled // actions. Any scheduled actions that were specified for the scalable target are @@ -44,156 +43,99 @@ func (c *Client) PutScheduledAction(ctx context.Context, params *PutScheduledAct type PutScheduledActionInput struct { - // The identifier of the resource associated with the scheduled action. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource associated with the scheduled action. This + // string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension @@ -204,8 +146,8 @@ type PutScheduledActionInput struct { // This member is required. ScheduledActionName *string - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -222,25 +164,18 @@ type PutScheduledActionInput struct { ScalableTargetAction *types.ScalableTargetAction // The schedule for this action. The following formats are supported: - // - // * At - // expressions - "at(yyyy-mm-ddThh:mm:ss)" - // - // * Rate expressions - "rate(value - // unit)" - // - // * Cron expressions - "cron(fields)" - // - // At expressions are useful for - // one-time schedules. Cron expressions are useful for scheduled actions that run - // periodically at a specified date and time, and rate expressions are useful for - // scheduled actions that run at a regular interval. At and cron expressions use - // Universal Coordinated Time (UTC) by default. The cron format consists of six - // fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] - // [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit - // is minute | minutes | hour | hours | day | days. For more information and - // examples, see Example scheduled actions for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html) + // - At expressions - " at(yyyy-mm-ddThh:mm:ss) " + // - Rate expressions - " rate(value unit) " + // - Cron expressions - " cron(fields) " + // At expressions are useful for one-time schedules. Cron expressions are useful + // for scheduled actions that run periodically at a specified date and time, and + // rate expressions are useful for scheduled actions that run at a regular + // interval. At and cron expressions use Universal Coordinated Time (UTC) by + // default. The cron format consists of six fields separated by white spaces: + // [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate + // expressions, value is a positive integer and unit is minute | minutes | hour | + // hours | day | days . For more information and examples, see Example scheduled + // actions for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html) // in the Application Auto Scaling User Guide. Schedule *string @@ -250,9 +185,9 @@ type PutScheduledActionInput struct { // Specifies the time zone used when setting a scheduled action by using an at or // cron expression. If a time zone is not provided, UTC is used by default. Valid // values are the canonical names of the IANA time zones supported by Joda-Time - // (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see - // https://www.joda.org/joda-time/timezones.html - // (https://www.joda.org/joda-time/timezones.html). + // (such as Etc/GMT+9 or Pacific/Tahiti ). For more information, see + // https://www.joda.org/joda-time/timezones.html (https://www.joda.org/joda-time/timezones.html) + // . Timezone *string noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_RegisterScalableTarget.go b/service/applicationautoscaling/api_op_RegisterScalableTarget.go index f05d9229f82..01c4e7c0b06 100644 --- a/service/applicationautoscaling/api_op_RegisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_RegisterScalableTarget.go @@ -24,30 +24,26 @@ import ( // are outside of the minimum and maximum range. After you register a scalable // target, you do not need to register it again to use other Application Auto // Scaling operations. To see which resources have been registered, use -// DescribeScalableTargets -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html). -// You can also view the scaling policies for a service namespace by using -// DescribeScalableTargets -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html). -// If you no longer need a scalable target, you can deregister it by using -// DeregisterScalableTarget -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html). -// To update a scalable target, specify the parameters that you want to change. +// DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html) +// . You can also view the scaling policies for a service namespace by using +// DescribeScalableTargets (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html) +// . If you no longer need a scalable target, you can deregister it by using +// DeregisterScalableTarget (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html) +// . To update a scalable target, specify the parameters that you want to change. // Include the parameters that identify the scalable target: resource ID, scalable // dimension, and namespace. Any parameters that you don't specify are not changed // by this update request. If you call the RegisterScalableTarget API operation to // create a scalable target, there might be a brief delay until the operation -// achieves eventual consistency -// (https://en.wikipedia.org/wiki/Eventual_consistency). You might become aware of -// this brief delay if you get unexpected errors when performing sequential -// operations. The typical strategy is to retry the request, and some Amazon Web -// Services SDKs include automatic backoff and retry logic. If you call the -// RegisterScalableTarget API operation to update an existing scalable target, -// Application Auto Scaling retrieves the current capacity of the resource. If it's -// below the minimum capacity or above the maximum capacity, Application Auto -// Scaling adjusts the capacity of the scalable target to place it within these -// bounds, even if you don't include the MinCapacity or MaxCapacity request -// parameters. +// achieves eventual consistency (https://en.wikipedia.org/wiki/Eventual_consistency) +// . You might become aware of this brief delay if you get unexpected errors when +// performing sequential operations. The typical strategy is to retry the request, +// and some Amazon Web Services SDKs include automatic backoff and retry logic. If +// you call the RegisterScalableTarget API operation to update an existing +// scalable target, Application Auto Scaling retrieves the current capacity of the +// resource. If it's below the minimum capacity or above the maximum capacity, +// Application Auto Scaling adjusts the capacity of the scalable target to place it +// within these bounds, even if you don't include the MinCapacity or MaxCapacity +// request parameters. func (c *Client) RegisterScalableTarget(ctx context.Context, params *RegisterScalableTargetInput, optFns ...func(*Options)) (*RegisterScalableTargetOutput, error) { if params == nil { params = &RegisterScalableTargetInput{} @@ -65,162 +61,105 @@ func (c *Client) RegisterScalableTarget(ctx context.Context, params *RegisterSca type RegisterScalableTargetInput struct { - // The identifier of the resource that is associated with the scalable target. This - // string consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource that is associated with the scalable target. + // This string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string - // The scalable dimension associated with the scalable target. This string consists - // of the service namespace, resource type, and scaling property. - // - // * - // ecs:service:DesiredCount - The desired task count of an ECS service. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity - // of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of an - // AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. - // - // * sagemaker:variant:DesiredInstanceCount - The - // number of EC2 instances for a SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // * - // comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend entity recognizer endpoint. - // - // * - // lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * cassandra:table:WriteCapacityUnits - - // The provisioned write capacity for an Amazon Keyspaces table. - // - // * - // kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for - // brokers in an Amazon MSK cluster. - // - // * elasticache:replication-group:NodeGroups - - // The number of node groups for an Amazon ElastiCache replication group. - // - // * - // elasticache:replication-group:Replicas - The number of replicas per node group - // for an Amazon ElastiCache replication group. - // - // * neptune:cluster:ReadReplicaCount - // - The count of read replicas in an Amazon Neptune DB cluster. + // The scalable dimension associated with the scalable target. This string + // consists of the service namespace, resource type, and scaling property. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension types.ScalableDimension - // The namespace of the Amazon Web Services service that provides the resource. For - // a resource provided by your own application or service, use custom-resource + // The namespace of the Amazon Web Services service that provides the resource. + // For a resource provided by your own application or service, use custom-resource // instead. // // This member is required. @@ -234,9 +173,8 @@ type RegisterScalableTargetInput struct { // its own default quotas for the maximum capacity of the resource. If you want to // specify a higher limit, you can request an increase. For more information, // consult the documentation for that service. For information about the default - // quotas for each service, see Service endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html) in - // the Amazon Web Services General Reference. + // quotas for each service, see Service endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html) + // in the Amazon Web Services General Reference. MaxCapacity *int32 // The minimum value that you plan to scale in to. When a scaling policy is in @@ -244,64 +182,43 @@ type RegisterScalableTargetInput struct { // minimum capacity limit in response to changing demand. This property is required // when registering a new scalable target. For the following resources, the minimum // value allowed is 0. - // - // * AppStream 2.0 fleets - // - // * Aurora DB clusters - // - // * ECS - // services - // - // * EMR clusters - // - // * Lambda provisioned concurrency - // - // * SageMaker endpoint - // variants - // - // * Spot Fleets - // - // * custom resources - // - // It's strongly recommended that you - // specify a value greater than 0. A value greater than 0 means that data points - // are continuously reported to CloudWatch that scaling policies can use to scale - // on a metric like average CPU utilization. For all other resources, the minimum - // allowed value depends on the type of resource that you are using. If you provide - // a value that is lower than what a resource can accept, an error occurs. In which - // case, the error message will provide the minimum value that the resource can - // accept. + // - AppStream 2.0 fleets + // - Aurora DB clusters + // - ECS services + // - EMR clusters + // - Lambda provisioned concurrency + // - SageMaker endpoint variants + // - Spot Fleets + // - custom resources + // It's strongly recommended that you specify a value greater than 0. A value + // greater than 0 means that data points are continuously reported to CloudWatch + // that scaling policies can use to scale on a metric like average CPU utilization. + // For all other resources, the minimum allowed value depends on the type of + // resource that you are using. If you provide a value that is lower than what a + // resource can accept, an error occurs. In which case, the error message will + // provide the minimum value that the resource can accept. MinCapacity *int32 - // This parameter is required for services that do not support service-linked roles - // (such as Amazon EMR), and it must specify the ARN of an IAM role that allows - // Application Auto Scaling to modify the scalable target on your behalf. If the - // service supports service-linked roles, Application Auto Scaling uses a + // This parameter is required for services that do not support service-linked + // roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + // allows Application Auto Scaling to modify the scalable target on your behalf. If + // the service supports service-linked roles, Application Auto Scaling uses a // service-linked role, which it creates if it does not yet exist. For more - // information, see Application Auto Scaling IAM roles - // (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles). + // information, see Application Auto Scaling IAM roles (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles) + // . RoleARN *string // An embedded object that contains attributes and attribute values that are used // to suspend and resume automatic scaling. Setting the value of an attribute to // true suspends the specified scaling activities. Setting it to false (default) // resumes the specified scaling activities. Suspension Outcomes - // - // * For - // DynamicScalingInSuspended, while a suspension is in effect, all scale-in - // activities that are triggered by a scaling policy are suspended. - // - // * For - // DynamicScalingOutSuspended, while a suspension is in effect, all scale-out - // activities that are triggered by a scaling policy are suspended. - // - // * For - // ScheduledScalingSuspended, while a suspension is in effect, all scaling - // activities that involve scheduled actions are suspended. - // - // For more information, - // see Suspending and resuming scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) + // - For DynamicScalingInSuspended , while a suspension is in effect, all + // scale-in activities that are triggered by a scaling policy are suspended. + // - For DynamicScalingOutSuspended , while a suspension is in effect, all + // scale-out activities that are triggered by a scaling policy are suspended. + // - For ScheduledScalingSuspended , while a suspension is in effect, all scaling + // activities that involve scheduled actions are suspended. + // For more information, see Suspending and resuming scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) // in the Application Auto Scaling User Guide. SuspendedState *types.SuspendedState @@ -310,8 +227,7 @@ type RegisterScalableTargetInput struct { // TagResource operation. Each tag consists of a tag key and a tag value. Both the // tag key and the tag value are required. You cannot have more than one tag on a // scalable target with the same tag key. Use tags to control access to a scalable - // target. For more information, see Tagging support for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) + // target. For more information, see Tagging support for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) // in the Application Auto Scaling User Guide. Tags map[string]string diff --git a/service/applicationautoscaling/api_op_TagResource.go b/service/applicationautoscaling/api_op_TagResource.go index 78bea527d98..97b6d7c64be 100644 --- a/service/applicationautoscaling/api_op_TagResource.go +++ b/service/applicationautoscaling/api_op_TagResource.go @@ -16,12 +16,12 @@ import ( // existing tag key and a new tag value. You can use this operation to tag an // Application Auto Scaling scalable target, but you cannot tag a scaling policy or // scheduled action. You can also add tags to an Application Auto Scaling scalable -// target while creating it (RegisterScalableTarget). For general information about -// tags, including the format and syntax, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. Use tags to control access to a scalable target. -// For more information, see Tagging support for Application Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) +// target while creating it ( RegisterScalableTarget ). For general information +// about tags, including the format and syntax, see Tagging Amazon Web Services +// resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in +// the Amazon Web Services General Reference. Use tags to control access to a +// scalable target. For more information, see Tagging support for Application Auto +// Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html) // in the Application Auto Scaling User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -43,7 +43,7 @@ type TagResourceInput struct { // Identifies the Application Auto Scaling scalable target that you want to apply // tags to. For example: // arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 - // To get the ARN for a scalable target, use DescribeScalableTargets. + // To get the ARN for a scalable target, use DescribeScalableTargets . // // This member is required. ResourceARN *string @@ -54,8 +54,7 @@ type TagResourceInput struct { // key. If you specify an existing tag key with a different tag value, Application // Auto Scaling replaces the current tag value with the specified one. For // information about the rules that apply to tag keys and tag values, see - // User-defined tag restrictions - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) + // User-defined tag restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) // in the Amazon Web Services Billing and Cost Management User Guide. // // This member is required. diff --git a/service/applicationautoscaling/api_op_UntagResource.go b/service/applicationautoscaling/api_op_UntagResource.go index 7507e08372e..a510c99d507 100644 --- a/service/applicationautoscaling/api_op_UntagResource.go +++ b/service/applicationautoscaling/api_op_UntagResource.go @@ -32,7 +32,7 @@ type UntagResourceInput struct { // Identifies the Application Auto Scaling scalable target from which to remove // tags. For example: // arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 - // To get the ARN for a scalable target, use DescribeScalableTargets. + // To get the ARN for a scalable target, use DescribeScalableTargets . // // This member is required. ResourceARN *string diff --git a/service/applicationautoscaling/doc.go b/service/applicationautoscaling/doc.go index e9aef28f892..7f6b68584db 100644 --- a/service/applicationautoscaling/doc.go +++ b/service/applicationautoscaling/doc.go @@ -5,65 +5,37 @@ // // With Application Auto Scaling, you can configure automatic scaling for the // following resources: -// -// * Amazon AppStream 2.0 fleets -// -// * Amazon Aurora Replicas -// -// * -// Amazon Comprehend document classification and entity recognizer endpoints -// -// * -// Amazon DynamoDB tables and global secondary indexes throughput capacity -// -// * -// Amazon ECS services -// -// * Amazon ElastiCache for Redis clusters (replication -// groups) -// -// * Amazon EMR clusters -// -// * Amazon Keyspaces (for Apache Cassandra) -// tables -// -// * Lambda function provisioned concurrency -// -// * Amazon Managed Streaming -// for Apache Kafka broker storage -// -// * Amazon Neptune clusters -// -// * Amazon SageMaker -// endpoint variants -// -// * Spot Fleets (Amazon EC2) -// -// * Custom resources provided by -// your own applications or services -// -// To learn more about Application Auto Scaling, -// see the Application Auto Scaling User Guide -// (https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html). -// API Summary The Application Auto Scaling service API includes three key sets of -// actions: -// -// * Register and manage scalable targets - Register Amazon Web Services -// or custom resources as scalable targets (a resource that Application Auto -// Scaling can scale), set minimum and maximum capacity limits, and retrieve -// information on existing scalable targets. -// -// * Configure and manage automatic -// scaling - Define scaling policies to dynamically scale your resources in -// response to CloudWatch alarms, schedule one-time or recurring scaling actions, -// and retrieve your recent scaling activity history. -// -// * Suspend and resume scaling -// - Temporarily suspend and later resume automatic scaling by calling the -// RegisterScalableTarget -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) -// API action for any Application Auto Scaling scalable target. You can suspend and -// resume (individually or in combination) scale-out activities that are triggered -// by a scaling policy, scale-in activities that are triggered by a scaling policy, -// and scheduled scaling. +// - Amazon AppStream 2.0 fleets +// - Amazon Aurora Replicas +// - Amazon Comprehend document classification and entity recognizer endpoints +// - Amazon DynamoDB tables and global secondary indexes throughput capacity +// - Amazon ECS services +// - Amazon ElastiCache for Redis clusters (replication groups) +// - Amazon EMR clusters +// - Amazon Keyspaces (for Apache Cassandra) tables +// - Lambda function provisioned concurrency +// - Amazon Managed Streaming for Apache Kafka broker storage +// - Amazon Neptune clusters +// - Amazon SageMaker endpoint variants +// - Spot Fleets (Amazon EC2) +// - Custom resources provided by your own applications or services +// +// To learn more about Application Auto Scaling, see the Application Auto Scaling +// User Guide (https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html) +// . API Summary The Application Auto Scaling service API includes three key sets +// of actions: +// - Register and manage scalable targets - Register Amazon Web Services or +// custom resources as scalable targets (a resource that Application Auto Scaling +// can scale), set minimum and maximum capacity limits, and retrieve information on +// existing scalable targets. +// - Configure and manage automatic scaling - Define scaling policies to +// dynamically scale your resources in response to CloudWatch alarms, schedule +// one-time or recurring scaling actions, and retrieve your recent scaling activity +// history. +// - Suspend and resume scaling - Temporarily suspend and later resume automatic +// scaling by calling the RegisterScalableTarget (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) +// API action for any Application Auto Scaling scalable target. You can suspend and +// resume (individually or in combination) scale-out activities that are triggered +// by a scaling policy, scale-in activities that are triggered by a scaling policy, +// and scheduled scaling. package applicationautoscaling diff --git a/service/applicationautoscaling/types/enums.go b/service/applicationautoscaling/types/enums.go index 979ef766659..c37fc547957 100644 --- a/service/applicationautoscaling/types/enums.go +++ b/service/applicationautoscaling/types/enums.go @@ -31,8 +31,8 @@ const ( MetricAggregationTypeMaximum MetricAggregationType = "Maximum" ) -// Values returns all known values for MetricAggregationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MetricAggregationType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MetricAggregationType) Values() []MetricAggregationType { return []MetricAggregationType{ diff --git a/service/applicationautoscaling/types/errors.go b/service/applicationautoscaling/types/errors.go index 2df8d5ae0d7..4e2f251afaa 100644 --- a/service/applicationautoscaling/types/errors.go +++ b/service/applicationautoscaling/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// Concurrent updates caused an exception, for example, if you request an update to -// an Application Auto Scaling resource that already has a pending update. +// Concurrent updates caused an exception, for example, if you request an update +// to an Application Auto Scaling resource that already has a pending update. type ConcurrentUpdateException struct { Message *string @@ -37,8 +37,7 @@ func (e *ConcurrentUpdateException) ErrorFault() smithy.ErrorFault { return smit // Failed access to resources caused an exception. This exception is thrown when // Application Auto Scaling is unable to retrieve the alarms associated with a // scaling policy due to a client error, for example, if the role ARN specified for -// a scalable target does not have permission to call the CloudWatch DescribeAlarms -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) +// a scalable target does not have permission to call the CloudWatch DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) // on your behalf. type FailedResourceAccessException struct { Message *string @@ -118,8 +117,8 @@ func (e *InvalidNextTokenException) ErrorCode() string { func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // A per-account resource limit is exceeded. For more information, see Application -// Auto Scaling service quotas -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html). +// Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html) +// . type LimitExceededException struct { Message *string diff --git a/service/applicationautoscaling/types/types.go b/service/applicationautoscaling/types/types.go index 757aded369e..5ea7b8a8412 100644 --- a/service/applicationautoscaling/types/types.go +++ b/service/applicationautoscaling/types/types.go @@ -26,27 +26,21 @@ type Alarm struct { // Represents a CloudWatch metric of your choosing for a target tracking scaling // policy to use with Application Auto Scaling. For information about the available // metrics for a service, see Amazon Web Services services that publish CloudWatch -// metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) +// metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. To create your customized metric // specification: +// - Add values for each required parameter from CloudWatch. You can use an +// existing metric, or a new metric that you create. To use your own metric, you +// must first publish the metric to CloudWatch. For more information, see +// Publish custom metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) +// in the Amazon CloudWatch User Guide. +// - Choose a metric that changes proportionally with capacity. The value of the +// metric should increase or decrease in inverse proportion to the number of +// capacity units. That is, the value of the metric should decrease when capacity +// increases, and increase when capacity decreases. // -// * Add values for each required parameter from CloudWatch. You -// can use an existing metric, or a new metric that you create. To use your own -// metric, you must first publish the metric to CloudWatch. For more information, -// see Publish custom metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) -// in the Amazon CloudWatch User Guide. -// -// * Choose a metric that changes -// proportionally with capacity. The value of the metric should increase or -// decrease in inverse proportion to the number of capacity units. That is, the -// value of the metric should decrease when capacity increases, and increase when -// capacity decreases. -// -// For more information about the CloudWatch terminology -// below, see Amazon CloudWatch concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// For more information about the CloudWatch terminology below, see Amazon +// CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. type CustomizedMetricSpecification struct { @@ -54,11 +48,10 @@ type CustomizedMetricSpecification struct { // dimensions, you must specify the same dimensions in your scaling policy. Dimensions []MetricDimension - // The name of the metric. To get the exact metric name, namespace, and dimensions, - // inspect the Metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) - // object that's returned by a call to ListMetrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + // The name of the metric. To get the exact metric name, namespace, and + // dimensions, inspect the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) + // object that's returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) + // . MetricName *string // The metrics to include in the target tracking scaling policy, as a metric data @@ -72,8 +65,7 @@ type CustomizedMetricSpecification struct { Statistic MetricStatistic // The unit of the metric. For a complete list of the units that CloudWatch - // supports, see the MetricDatum - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) // data type in the Amazon CloudWatch API Reference. Unit *string @@ -96,25 +88,18 @@ type MetricDimension struct { noSmithyDocumentSerde } -// Describes the reason for an activity that isn't scaled (not scaled activity), in -// machine-readable format. For help interpreting the not scaled reason details, -// see Scaling activities for Application Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html). +// Describes the reason for an activity that isn't scaled (not scaled activity), +// in machine-readable format. For help interpreting the not scaled reason details, +// see Scaling activities for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html) +// . type NotScaledReason struct { // A code that represents the reason for not scaling. Valid values: - // - // * - // AutoScalingAnticipatedFlapping - // - // * TargetServicePutResourceAsUnscalable - // - // * - // AlreadyAtMaxCapacity - // - // * AlreadyAtMinCapacity - // - // * AlreadyAtDesiredCapacity + // - AutoScalingAnticipatedFlapping + // - TargetServicePutResourceAsUnscalable + // - AlreadyAtMaxCapacity + // - AlreadyAtMinCapacity + // - AlreadyAtDesiredCapacity // // This member is required. Code *string @@ -136,8 +121,7 @@ type NotScaledReason struct { // metrics to Amazon CloudWatch. To determine whether a desired metric already // exists by looking up its namespace and dimension using the CloudWatch metrics // dashboard in the console, follow the procedure in Building dashboards with -// CloudWatch -// (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) +// CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) // in the Application Auto Scaling User Guide. type PredefinedMetricSpecification struct { @@ -148,25 +132,18 @@ type PredefinedMetricSpecification struct { PredefinedMetricType MetricType // Identifies the resource associated with the metric type. You can't specify a - // resource label unless the metric type is ALBRequestCountPerTarget and there is a - // target group attached to the Spot Fleet or ECS service. You create the resource - // label by appending the final portion of the load balancer ARN and the final - // portion of the target group ARN into a single value, separated by a forward - // slash (/). The format of the resource label is: - // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. + // resource label unless the metric type is ALBRequestCountPerTarget and there is + // a target group attached to the Spot Fleet or ECS service. You create the + // resource label by appending the final portion of the load balancer ARN and the + // final portion of the target group ARN into a single value, separated by a + // forward slash (/). The format of the resource label is: + // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff . // Where: - // - // * app// is the final portion of the load balancer ARN - // - // * targetgroup// - // is the final portion of the target group ARN. - // - // To find the ARN for an - // Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string @@ -193,78 +170,52 @@ type ScalableTarget struct { // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string @@ -275,84 +226,53 @@ type ScalableTarget struct { // This member is required. RoleARN *string - // The scalable dimension associated with the scalable target. This string consists - // of the service namespace, resource type, and scaling property. - // - // * - // ecs:service:DesiredCount - The desired task count of an ECS service. - // - // * - // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR - // Instance Group. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity - // of a Spot Fleet. - // - // * appstream:fleet:DesiredCapacity - The desired capacity of an - // AppStream 2.0 fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. - // - // * sagemaker:variant:DesiredInstanceCount - The - // number of EC2 instances for a SageMaker model endpoint variant. - // - // * - // custom-resource:ResourceType:Property - The scalable dimension for a custom - // resource provided by your own application or service. - // - // * - // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend document classification endpoint. - // - // * - // comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of - // inference units for an Amazon Comprehend entity recognizer endpoint. - // - // * - // lambda:function:ProvisionedConcurrency - The provisioned concurrency for a - // Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The provisioned read - // capacity for an Amazon Keyspaces table. - // - // * cassandra:table:WriteCapacityUnits - - // The provisioned write capacity for an Amazon Keyspaces table. - // - // * - // kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for - // brokers in an Amazon MSK cluster. - // - // * elasticache:replication-group:NodeGroups - - // The number of node groups for an Amazon ElastiCache replication group. - // - // * - // elasticache:replication-group:Replicas - The number of replicas per node group - // for an Amazon ElastiCache replication group. - // - // * neptune:cluster:ReadReplicaCount - // - The count of read replicas in an Amazon Neptune DB cluster. + // The scalable dimension associated with the scalable target. This string + // consists of the service namespace, resource type, and scaling property. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or - // a custom-resource. + // a custom-resource . // // This member is required. ServiceNamespace ServiceNamespace @@ -375,9 +295,8 @@ type ScalableTargetAction struct { // quotas for the maximum capacity of the resource. If you want to specify a higher // limit, you can request an increase. For more information, consult the // documentation for that service. For information about the default quotas for - // each service, see Service endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html) in - // the Amazon Web Services General Reference. + // each service, see Service endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html) + // in the Amazon Web Services General Reference. MaxCapacity *int32 // The minimum capacity. When the scheduled action runs, the resource will have at @@ -406,162 +325,105 @@ type ScalingActivity struct { // This member is required. Description *string - // The identifier of the resource associated with the scaling activity. This string - // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // The identifier of the resource associated with the scaling activity. This + // string consists of the resource type and unique identifier. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or - // a custom-resource. + // a custom-resource . // // This member is required. ServiceNamespace ServiceNamespace @@ -583,8 +445,7 @@ type ScalingActivity struct { EndTime *time.Time // Machine-readable data that describes the reason for a not scaled activity. Only - // available when DescribeScalingActivities - // (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalingActivities.html) + // available when DescribeScalingActivities (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalingActivities.html) // includes not scaled activities. NotScaledReasons []NotScaledReason @@ -596,8 +457,7 @@ type ScalingActivity struct { // Represents a scaling policy to use with Application Auto Scaling. For more // information about configuring scaling policies for a specific service, see -// Amazon Web Services services that you can use with Application Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) +// Amazon Web Services services that you can use with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html) // in the Application Auto Scaling User Guide. type ScalingPolicy struct { @@ -617,8 +477,8 @@ type ScalingPolicy struct { PolicyName *string // The scaling policy type. The following policy types are supported: - // TargetTrackingScaling—Not supported for Amazon EMR StepScaling—Not supported for - // DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon + // TargetTrackingScaling —Not supported for Amazon EMR StepScaling —Not supported + // for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon // ElastiCache, or Neptune. // // This member is required. @@ -626,160 +486,103 @@ type ScalingPolicy struct { // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or - // a custom-resource. + // a custom-resource . // // This member is required. ServiceNamespace ServiceNamespace @@ -806,102 +609,69 @@ type ScheduledAction struct { // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. - // - // * ECS service - The - // resource type is service and the unique identifier is the cluster name and - // service name. Example: service/default/sample-webapp. - // - // * Spot Fleet - The - // resource type is spot-fleet-request and the unique identifier is the Spot Fleet - // request ID. Example: - // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * EMR cluster - - // The resource type is instancegroup and the unique identifier is the cluster ID - // and instance group ID. Example: - // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - // - // * AppStream 2.0 fleet - The - // resource type is fleet and the unique identifier is the fleet name. Example: - // fleet/sample-fleet. - // - // * DynamoDB table - The resource type is table and the - // unique identifier is the table name. Example: table/my-table. - // - // * DynamoDB global - // secondary index - The resource type is index and the unique identifier is the - // index name. Example: table/my-table/index/my-table-index. - // - // * Aurora DB cluster - - // The resource type is cluster and the unique identifier is the cluster name. - // Example: cluster:my-db-cluster. - // - // * SageMaker endpoint variant - The resource - // type is variant and the unique identifier is the resource ID. Example: - // endpoint/my-end-point/variant/KMeansClustering. - // - // * Custom resources are not - // supported with a resource type. This parameter must specify the OutputValue from - // the CloudFormation template stack used to access the resources. The unique - // identifier is defined by the service provider. More information is available in - // our GitHub repository - // (https://github.com/aws/aws-auto-scaling-custom-resource). - // - // * Amazon Comprehend - // document classification endpoint - The resource type and unique identifier are - // specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - // - // * - // Amazon Comprehend entity recognizer endpoint - The resource type and unique - // identifier are specified using the endpoint ARN. Example: - // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - // - // * - // Lambda provisioned concurrency - The resource type is function and the unique - // identifier is the function name with a function version or alias name suffix - // that is not $LATEST. Example: function:my-function:prod or - // function:my-function:1. - // - // * Amazon Keyspaces table - The resource type is table - // and the unique identifier is the table name. Example: - // keyspace/mykeyspace/table/mytable. - // - // * Amazon MSK cluster - The resource type and - // unique identifier are specified using the cluster ARN. Example: - // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - // - // * - // Amazon ElastiCache replication group - The resource type is replication-group - // and the unique identifier is the replication group name. Example: - // replication-group/mycluster. - // - // * Neptune cluster - The resource type is cluster - // and the unique identifier is the cluster name. Example: cluster:mycluster. + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - EMR cluster - The resource type is instancegroup and the unique identifier + // is the cluster ID and instance group ID. Example: + // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 . + // - AppStream 2.0 fleet - The resource type is fleet and the unique identifier + // is the fleet name. Example: fleet/sample-fleet . + // - DynamoDB table - The resource type is table and the unique identifier is the + // table name. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the index name. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . + // - SageMaker endpoint variant - The resource type is variant and the unique + // identifier is the resource ID. Example: + // endpoint/my-end-point/variant/KMeansClustering . + // - Custom resources are not supported with a resource type. This parameter + // must specify the OutputValue from the CloudFormation template stack used to + // access the resources. The unique identifier is defined by the service provider. + // More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource) + // . + // - Amazon Comprehend document classification endpoint - The resource type and + // unique identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE + // . + // - Amazon Comprehend entity recognizer endpoint - The resource type and unique + // identifier are specified using the endpoint ARN. Example: + // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE . + // - Lambda provisioned concurrency - The resource type is function and the + // unique identifier is the function name with a function version or alias name + // suffix that is not $LATEST . Example: function:my-function:prod or + // function:my-function:1 . + // - Amazon Keyspaces table - The resource type is table and the unique + // identifier is the table name. Example: keyspace/mykeyspace/table/mytable . + // - Amazon MSK cluster - The resource type and unique identifier are specified + // using the cluster ARN. Example: + // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 + // . + // - Amazon ElastiCache replication group - The resource type is + // replication-group and the unique identifier is the replication group name. + // Example: replication-group/mycluster . + // - Neptune cluster - The resource type is cluster and the unique identifier is + // the cluster name. Example: cluster:mycluster . // // This member is required. ResourceId *string // The schedule for this action. The following formats are supported: - // - // * At - // expressions - "at(yyyy-mm-ddThh:mm:ss)" - // - // * Rate expressions - "rate(value - // unit)" - // - // * Cron expressions - "cron(fields)" - // - // At expressions are useful for - // one-time schedules. Cron expressions are useful for scheduled actions that run - // periodically at a specified date and time, and rate expressions are useful for - // scheduled actions that run at a regular interval. At and cron expressions use - // Universal Coordinated Time (UTC) by default. The cron format consists of six - // fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] - // [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit - // is minute | minutes | hour | hours | day | days. For more information and - // examples, see Example scheduled actions for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html) + // - At expressions - " at(yyyy-mm-ddThh:mm:ss) " + // - Rate expressions - " rate(value unit) " + // - Cron expressions - " cron(fields) " + // At expressions are useful for one-time schedules. Cron expressions are useful + // for scheduled actions that run periodically at a specified date and time, and + // rate expressions are useful for scheduled actions that run at a regular + // interval. At and cron expressions use Universal Coordinated Time (UTC) by + // default. The cron format consists of six fields separated by white spaces: + // [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate + // expressions, value is a positive integer and unit is minute | minutes | hour | + // hours | day | days . For more information and examples, see Example scheduled + // actions for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html) // in the Application Auto Scaling User Guide. // // This member is required. @@ -918,7 +688,7 @@ type ScheduledAction struct { ScheduledActionName *string // The namespace of the Amazon Web Services service that provides the resource, or - // a custom-resource. + // a custom-resource . // // This member is required. ServiceNamespace ServiceNamespace @@ -928,76 +698,45 @@ type ScheduledAction struct { // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. - // - // * ecs:service:DesiredCount - The desired task count - // of an ECS service. - // - // * elasticmapreduce:instancegroup:InstanceCount - The - // instance count of an EMR Instance Group. - // - // * - // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. - // - // * - // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 - // fleet. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a - // DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The provisioned write - // capacity for a DynamoDB table. - // - // * dynamodb:index:ReadCapacityUnits - The - // provisioned read capacity for a DynamoDB global secondary index. - // - // * - // dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a - // DynamoDB global secondary index. - // - // * rds:cluster:ReadReplicaCount - The count of - // Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible - // edition and Aurora PostgreSQL-compatible edition. - // - // * - // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a - // SageMaker model endpoint variant. - // - // * custom-resource:ResourceType:Property - The - // scalable dimension for a custom resource provided by your own application or - // service. - // - // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend document classification - // endpoint. - // - // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The - // number of inference units for an Amazon Comprehend entity recognizer - // endpoint. - // - // * lambda:function:ProvisionedConcurrency - The provisioned - // concurrency for a Lambda function. - // - // * cassandra:table:ReadCapacityUnits - The - // provisioned read capacity for an Amazon Keyspaces table. - // - // * - // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an - // Amazon Keyspaces table. - // - // * kafka:broker-storage:VolumeSize - The provisioned - // volume size (in GiB) for brokers in an Amazon MSK cluster. - // - // * - // elasticache:replication-group:NodeGroups - The number of node groups for an - // Amazon ElastiCache replication group. - // - // * elasticache:replication-group:Replicas - // - The number of replicas per node group for an Amazon ElastiCache replication - // group. - // - // * neptune:cluster:ReadReplicaCount - The count of read replicas in an - // Amazon Neptune DB cluster. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR + // Instance Group. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. + // - appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 + // fleet. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. + // - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a + // SageMaker model endpoint variant. + // - custom-resource:ResourceType:Property - The scalable dimension for a custom + // resource provided by your own application or service. + // - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number + // of inference units for an Amazon Comprehend document classification endpoint. + // - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of + // inference units for an Amazon Comprehend entity recognizer endpoint. + // - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a + // Lambda function. + // - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an + // Amazon Keyspaces table. + // - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an + // Amazon Keyspaces table. + // - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for + // brokers in an Amazon MSK cluster. + // - elasticache:replication-group:NodeGroups - The number of node groups for an + // Amazon ElastiCache replication group. + // - elasticache:replication-group:Replicas - The number of replicas per node + // group for an Amazon ElastiCache replication group. + // - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon + // Neptune DB cluster. ScalableDimension ScalableDimension // The new minimum and maximum capacity. You can set both values or just one. At @@ -1017,41 +756,30 @@ type ScheduledAction struct { noSmithyDocumentSerde } -// Represents a step adjustment for a StepScalingPolicyConfiguration -// (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html). -// Describes an adjustment based on the difference between the value of the +// Represents a step adjustment for a StepScalingPolicyConfiguration (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html) +// . Describes an adjustment based on the difference between the value of the // aggregated CloudWatch metric and the breach threshold that you've defined for // the alarm. For the following examples, suppose that you have an alarm with a // breach threshold of 50: -// -// * To initiate the adjustment when the metric is greater -// than or equal to 50 and less than 60, specify a lower bound of 0 and an upper -// bound of 10. -// -// * To initiate the adjustment when the metric is greater than 40 -// and less than or equal to 50, specify a lower bound of -10 and an upper bound of -// 0. +// - To initiate the adjustment when the metric is greater than or equal to 50 +// and less than 60, specify a lower bound of 0 and an upper bound of 10 . +// - To initiate the adjustment when the metric is greater than 40 and less than +// or equal to 50, specify a lower bound of -10 and an upper bound of 0 . // // There are a few rules for the step adjustments for your step policy: -// -// * The -// ranges of your step adjustments can't overlap or have a gap. -// -// * At most one step -// adjustment can have a null lower bound. If one step adjustment has a negative -// lower bound, then there must be a step adjustment with a null lower bound. -// -// * At -// most one step adjustment can have a null upper bound. If one step adjustment has -// a positive upper bound, then there must be a step adjustment with a null upper -// bound. -// -// * The upper and lower bound can't be null in the same step adjustment. +// - The ranges of your step adjustments can't overlap or have a gap. +// - At most one step adjustment can have a null lower bound. If one step +// adjustment has a negative lower bound, then there must be a step adjustment with +// a null lower bound. +// - At most one step adjustment can have a null upper bound. If one step +// adjustment has a positive upper bound, then there must be a step adjustment with +// a null upper bound. +// - The upper and lower bound can't be null in the same step adjustment. type StepAdjustment struct { - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. For exact capacity, you must specify a positive value. + // The amount by which to scale, based on the specified adjustment type. A + // positive value adds to the current capacity while a negative number removes from + // the current capacity. For exact capacity, you must specify a positive value. // // This member is required. ScalingAdjustment *int32 @@ -1079,10 +807,9 @@ type StepAdjustment struct { // Scaling. type StepScalingPolicyConfiguration struct { - // Specifies how the ScalingAdjustment value in a StepAdjustment - // (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) + // Specifies how the ScalingAdjustment value in a StepAdjustment (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) // is interpreted (for example, an absolute number or a percentage). The valid - // values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. + // values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity . // AdjustmentType is required if you are adding a new step scaling policy // configuration. AdjustmentType AdjustmentType @@ -1108,49 +835,29 @@ type StepScalingPolicyConfiguration struct { // activity stops and doesn't complete. Application Auto Scaling provides a default // value of 600 for Amazon ElastiCache replication groups and a default value of // 300 for the following scalable targets: - // - // * AppStream 2.0 fleets - // - // * Aurora DB - // clusters - // - // * ECS services - // - // * EMR clusters - // - // * Neptune clusters - // - // * SageMaker - // endpoint variants - // - // * Spot Fleets - // - // * Custom resources - // - // For all other scalable - // targets, the default value is 0: - // - // * Amazon Comprehend document classification - // and entity recognizer endpoints - // - // * DynamoDB tables and global secondary - // indexes - // - // * Amazon Keyspaces tables - // - // * Lambda provisioned concurrency - // - // * Amazon - // MSK broker storage + // - AppStream 2.0 fleets + // - Aurora DB clusters + // - ECS services + // - EMR clusters + // - Neptune clusters + // - SageMaker endpoint variants + // - Spot Fleets + // - Custom resources + // For all other scalable targets, the default value is 0: + // - Amazon Comprehend document classification and entity recognizer endpoints + // - DynamoDB tables and global secondary indexes + // - Amazon Keyspaces tables + // - Lambda provisioned concurrency + // - Amazon MSK broker storage Cooldown *int32 - // The aggregation type for the CloudWatch metrics. Valid values are Minimum, - // Maximum, and Average. If the aggregation type is null, the value is treated as - // Average. + // The aggregation type for the CloudWatch metrics. Valid values are Minimum , + // Maximum , and Average . If the aggregation type is null, the value is treated as + // Average . MetricAggregationType MetricAggregationType // The minimum value to scale by when the adjustment type is - // PercentChangeInCapacity. For example, suppose that you create a step scaling + // PercentChangeInCapacity . For example, suppose that you create a step scaling // policy to scale out an Amazon ECS service by 25 percent and you specify a // MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy // is performed, 25 percent of 4 is 1. However, because you specified a @@ -1170,19 +877,19 @@ type StepScalingPolicyConfiguration struct { // suspended state. type SuspendedState struct { - // Whether scale in by a target tracking scaling policy or a step scaling policy is - // suspended. Set the value to true if you don't want Application Auto Scaling to - // remove capacity when a scaling policy is triggered. The default is false. + // Whether scale in by a target tracking scaling policy or a step scaling policy + // is suspended. Set the value to true if you don't want Application Auto Scaling + // to remove capacity when a scaling policy is triggered. The default is false . DynamicScalingInSuspended *bool // Whether scale out by a target tracking scaling policy or a step scaling policy // is suspended. Set the value to true if you don't want Application Auto Scaling - // to add capacity when a scaling policy is triggered. The default is false. + // to add capacity when a scaling policy is triggered. The default is false . DynamicScalingOutSuspended *bool // Whether scheduled scaling is suspended. Set the value to true if you don't want // Application Auto Scaling to add or remove capacity by initiating scheduled - // actions. The default is false. + // actions. The default is false . ScheduledScalingSuspended *bool noSmithyDocumentSerde @@ -1194,8 +901,7 @@ type TargetTrackingMetric struct { // The dimensions for the metric. For the list of available dimensions, see the // Amazon Web Services documentation available from the table in Amazon Web - // Services services that publish CloudWatch metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) + // Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. Conditional: If you published your metric // with dimensions, you must specify the same dimensions in your scaling policy. Dimensions []TargetTrackingMetricDimension @@ -1204,8 +910,7 @@ type TargetTrackingMetric struct { MetricName *string // The namespace of the metric. For more information, see the table in Amazon Web - // Services services that publish CloudWatch metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) + // Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. Namespace *string @@ -1217,8 +922,7 @@ type TargetTrackingMetric struct { // returned metric statistics to create a new time series. A time series is a // series of data points, each of which is associated with a timestamp. For more // information and examples, see Create a target tracking scaling policy for -// Application Auto Scaling using metric math -// (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) +// Application Auto Scaling using metric math (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) // in the Application Auto Scaling User Guide. type TargetTrackingMetricDataQuery struct { @@ -1237,7 +941,7 @@ type TargetTrackingMetricDataQuery struct { // metrics to refer to those metrics, and can also use the Id of other expressions // to use the result of those expressions. Conditional: Within each // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat, but not both. + // MetricStat , but not both. Expression *string // A human-readable label for this metric or expression. This is especially useful @@ -1245,7 +949,7 @@ type TargetTrackingMetricDataQuery struct { Label *string // Information about the metric data to return. Conditional: Within each - // MetricDataQuery object, you must specify either Expression or MetricStat, but + // MetricDataQuery object, you must specify either Expression or MetricStat , but // not both. MetricStat *TargetTrackingMetricStat @@ -1254,8 +958,8 @@ type TargetTrackingMetricDataQuery struct { // math expression that the metric specification is based on. You must specify // false for ReturnData for all the other metrics and expressions used in the // metric specification. If you are only retrieving metrics and not performing any - // math expressions, do not specify anything for ReturnData. This sets it to its - // default (true). + // math expressions, do not specify anything for ReturnData . This sets it to its + // default ( true ). ReturnData *bool noSmithyDocumentSerde @@ -1279,33 +983,29 @@ type TargetTrackingMetricDimension struct { // This structure defines the CloudWatch metric to return, along with the // statistic, period, and unit. For more information about the CloudWatch -// terminology below, see Amazon CloudWatch concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. type TargetTrackingMetricStat struct { // The CloudWatch metric to return, including the metric name, namespace, and // dimensions. To get the exact metric name, namespace, and dimensions, inspect the - // Metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) - // object that is returned by a call to ListMetrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + // Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) + // object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) + // . // // This member is required. Metric *TargetTrackingMetric // The statistic to return. It can include any CloudWatch statistic or extended - // statistic. For a list of valid values, see the table in Statistics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) + // statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) // in the Amazon CloudWatch User Guide. The most commonly used metric for scaling - // is Average. + // is Average . // // This member is required. Stat *string // The unit to use for the returned data points. For a complete list of the units - // that CloudWatch supports, see the MetricDatum - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) // data type in the Amazon CloudWatch API Reference. Unit *string @@ -1332,11 +1032,11 @@ type TargetTrackingScalingPolicyConfiguration struct { // metric. CustomizedMetricSpecification *CustomizedMetricSpecification - // Indicates whether scale in by the target tracking scaling policy is disabled. If - // the value is true, scale in is disabled and the target tracking scaling policy - // won't remove capacity from the scalable target. Otherwise, scale in is enabled - // and the target tracking scaling policy can remove capacity from the scalable - // target. The default value is false. + // Indicates whether scale in by the target tracking scaling policy is disabled. + // If the value is true , scale in is disabled and the target tracking scaling + // policy won't remove capacity from the scalable target. Otherwise, scale in is + // enabled and the target tracking scaling policy can remove capacity from the + // scalable target. The default value is false . DisableScaleIn *bool // A predefined metric. You can specify either a predefined metric or a customized @@ -1353,39 +1053,20 @@ type TargetTrackingScalingPolicyConfiguration struct { // complete. Application Auto Scaling provides a default value of 600 for Amazon // ElastiCache replication groups and a default value of 300 for the following // scalable targets: - // - // * AppStream 2.0 fleets - // - // * Aurora DB clusters - // - // * ECS - // services - // - // * EMR clusters - // - // * Neptune clusters - // - // * SageMaker endpoint variants - // - // * - // Spot Fleets - // - // * Custom resources - // - // For all other scalable targets, the default - // value is 0: - // - // * Amazon Comprehend document classification and entity recognizer - // endpoints - // - // * DynamoDB tables and global secondary indexes - // - // * Amazon Keyspaces - // tables - // - // * Lambda provisioned concurrency - // - // * Amazon MSK broker storage + // - AppStream 2.0 fleets + // - Aurora DB clusters + // - ECS services + // - EMR clusters + // - Neptune clusters + // - SageMaker endpoint variants + // - Spot Fleets + // - Custom resources + // For all other scalable targets, the default value is 0: + // - Amazon Comprehend document classification and entity recognizer endpoints + // - DynamoDB tables and global secondary indexes + // - Amazon Keyspaces tables + // - Lambda provisioned concurrency + // - Amazon MSK broker storage ScaleInCooldown *int32 // The amount of time, in seconds, to wait for a previous scale-out activity to @@ -1399,39 +1080,20 @@ type TargetTrackingScalingPolicyConfiguration struct { // the next scale-out activity. Application Auto Scaling provides a default value // of 600 for Amazon ElastiCache replication groups and a default value of 300 for // the following scalable targets: - // - // * AppStream 2.0 fleets - // - // * Aurora DB clusters - // - // * - // ECS services - // - // * EMR clusters - // - // * Neptune clusters - // - // * SageMaker endpoint - // variants - // - // * Spot Fleets - // - // * Custom resources - // - // For all other scalable targets, the - // default value is 0: - // - // * Amazon Comprehend document classification and entity - // recognizer endpoints - // - // * DynamoDB tables and global secondary indexes - // - // * Amazon - // Keyspaces tables - // - // * Lambda provisioned concurrency - // - // * Amazon MSK broker storage + // - AppStream 2.0 fleets + // - Aurora DB clusters + // - ECS services + // - EMR clusters + // - Neptune clusters + // - SageMaker endpoint variants + // - Spot Fleets + // - Custom resources + // For all other scalable targets, the default value is 0: + // - Amazon Comprehend document classification and entity recognizer endpoints + // - DynamoDB tables and global secondary indexes + // - Amazon Keyspaces tables + // - Lambda provisioned concurrency + // - Amazon MSK broker storage ScaleOutCooldown *int32 noSmithyDocumentSerde diff --git a/service/applicationcostprofiler/api_client.go b/service/applicationcostprofiler/api_client.go index df0107aadd3..f177076a170 100644 --- a/service/applicationcostprofiler/api_client.go +++ b/service/applicationcostprofiler/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/applicationcostprofiler/api_op_PutReportDefinition.go b/service/applicationcostprofiler/api_op_PutReportDefinition.go index 44008738167..f934acd9471 100644 --- a/service/applicationcostprofiler/api_op_PutReportDefinition.go +++ b/service/applicationcostprofiler/api_op_PutReportDefinition.go @@ -50,8 +50,8 @@ type PutReportDefinitionInput struct { // This member is required. ReportFrequency types.ReportFrequency - // Required. ID of the report. You can choose any valid string matching the pattern - // for the ID. + // Required. ID of the report. You can choose any valid string matching the + // pattern for the ID. // // This member is required. ReportId *string diff --git a/service/applicationcostprofiler/doc.go b/service/applicationcostprofiler/doc.go index a8ea9278893..7efae0a5c0b 100644 --- a/service/applicationcostprofiler/doc.go +++ b/service/applicationcostprofiler/doc.go @@ -7,7 +7,7 @@ // The AWS Application Cost Profiler API provides programmatic access to view, // create, update, and delete application cost report definitions, as well as to // import your usage data into the Application Cost Profiler service. For more -// information about using this service, see the AWS Application Cost Profiler User -// Guide -// (https://docs.aws.amazon.com/application-cost-profiler/latest/userguide/introduction.html). +// information about using this service, see the AWS Application Cost Profiler +// User Guide (https://docs.aws.amazon.com/application-cost-profiler/latest/userguide/introduction.html) +// . package applicationcostprofiler diff --git a/service/applicationcostprofiler/types/types.go b/service/applicationcostprofiler/types/types.go index 4ee92b0e6e8..a5277463658 100644 --- a/service/applicationcostprofiler/types/types.go +++ b/service/applicationcostprofiler/types/types.go @@ -67,9 +67,8 @@ type SourceS3Location struct { Key *string // Region of the bucket. Only required for Regions that are disabled by default. - // For more infomration about Regions that are disabled by default, see Enabling a - // Region - // (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) + // For more infomration about Regions that are disabled by default, see Enabling a + // Region (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) // in the AWS General Reference guide. Region S3BucketRegion diff --git a/service/applicationdiscoveryservice/api_client.go b/service/applicationdiscoveryservice/api_client.go index 280a1755d09..6f7ffc77719 100644 --- a/service/applicationdiscoveryservice/api_client.go +++ b/service/applicationdiscoveryservice/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/applicationdiscoveryservice/api_op_DescribeAgents.go b/service/applicationdiscoveryservice/api_op_DescribeAgents.go index 811731f03ed..cf1beb47062 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeAgents.go +++ b/service/applicationdiscoveryservice/api_op_DescribeAgents.go @@ -31,9 +31,9 @@ func (c *Client) DescribeAgents(ctx context.Context, params *DescribeAgentsInput type DescribeAgentsInput struct { - // The agent or the Connector IDs for which you want information. If you specify no - // IDs, the system returns information about all agents/Connectors associated with - // your Amazon Web Services user account. + // The agent or the Connector IDs for which you want information. If you specify + // no IDs, the system returns information about all agents/Connectors associated + // with your Amazon Web Services user account. AgentIds []string // You can filter the request using various logical operators and a key-value @@ -62,9 +62,9 @@ type DescribeAgentsOutput struct { // and the version number of each agent/Connector. AgentsInfo []types.AgentInfo - // Token to retrieve the next set of results. For example, if you specified 100 IDs - // for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to - // 10, you received a set of 10 results along with this token. Use this token in + // Token to retrieve the next set of results. For example, if you specified 100 + // IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults + // to 10, you received a set of 10 results along with this token. Use this token in // the next query to retrieve the next set of 10. NextToken *string diff --git a/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go b/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go index 0d6931368e3..51b0263e15f 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go @@ -12,22 +12,16 @@ import ( // Retrieves attributes for a list of configuration item IDs. All of the supplied // IDs must be for the same asset type from one of the following: +// - server +// - application +// - process +// - connection // -// * server -// -// * -// application -// -// * process -// -// * connection -// -// Output fields are specific to the asset -// type specified. For example, the output for a server configuration item includes -// a list of attributes about the server, such as host name, operating system, -// number of network cards, etc. For a complete list of outputs for each asset -// type, see Using the DescribeConfigurations Action -// (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations) +// Output fields are specific to the asset type specified. For example, the output +// for a server configuration item includes a list of attributes about the server, +// such as host name, operating system, number of network cards, etc. For a +// complete list of outputs for each asset type, see Using the +// DescribeConfigurations Action (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations) // in the Amazon Web Services Application Discovery Service User Guide. func (c *Client) DescribeConfigurations(ctx context.Context, params *DescribeConfigurationsInput, optFns ...func(*Options)) (*DescribeConfigurationsOutput, error) { if params == nil { diff --git a/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go b/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go index 75b775d233f..8c5a4affb02 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go +++ b/service/applicationdiscoveryservice/api_op_DescribeContinuousExports.go @@ -39,7 +39,7 @@ type DescribeContinuousExportsInput struct { // descriptions returned. MaxResults *int32 - // The token from the previous call to DescribeExportTasks. + // The token from the previous call to DescribeExportTasks . NextToken *string noSmithyDocumentSerde @@ -50,7 +50,7 @@ type DescribeContinuousExportsOutput struct { // A list of continuous export descriptions. Descriptions []types.ContinuousExportDescription - // The token from the previous call to DescribeExportTasks. + // The token from the previous call to DescribeExportTasks . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go index 9a710a8acad..4bb57cac5bf 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// DescribeExportConfigurations is deprecated. Use DescribeExportTasks -// (https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html), -// instead. +// DescribeExportConfigurations is deprecated. Use DescribeExportTasks (https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html) +// , instead. // // Deprecated: This operation has been deprecated. func (c *Client) DescribeExportConfigurations(ctx context.Context, params *DescribeExportConfigurationsInput, optFns ...func(*Options)) (*DescribeExportConfigurationsOutput, error) { diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go index 2ff36499811..f58cb98843e 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go @@ -34,9 +34,7 @@ type DescribeExportTasksInput struct { ExportIds []string // One or more filters. - // - // * AgentId - ID of the agent whose collected data will be - // exported + // - AgentId - ID of the agent whose collected data will be exported Filters []types.ExportFilter // The maximum number of volume results returned by DescribeExportTasks in @@ -57,14 +55,14 @@ type DescribeExportTasksInput struct { type DescribeExportTasksOutput struct { // Contains one or more sets of export request details. When the status of a - // request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where + // request is SUCCEEDED , the response includes a URL for an Amazon S3 bucket where // you can view the data in a CSV file. ExportsInfo []types.ExportInfo - // The nextToken value to include in a future DescribeExportTasks request. When the - // results of a DescribeExportTasks request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future DescribeExportTasks request. When + // the results of a DescribeExportTasks request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go b/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go index 3dd3afb6f2f..c240deb6ddc 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go +++ b/service/applicationdiscoveryservice/api_op_DescribeImportTasks.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array of import tasks for your account, including status information, -// times, IDs, the Amazon S3 Object URL for the import file, and more. +// Returns an array of import tasks for your account, including status +// information, times, IDs, the Amazon S3 Object URL for the import file, and more. func (c *Client) DescribeImportTasks(ctx context.Context, params *DescribeImportTasksInput, optFns ...func(*Options)) (*DescribeImportTasksOutput, error) { if params == nil { params = &DescribeImportTasksInput{} @@ -120,8 +120,8 @@ func (c *Client) addOperationDescribeImportTasksMiddlewares(stack *middleware.St return nil } -// DescribeImportTasksAPIClient is a client that implements the DescribeImportTasks -// operation. +// DescribeImportTasksAPIClient is a client that implements the +// DescribeImportTasks operation. type DescribeImportTasksAPIClient interface { DescribeImportTasks(context.Context, *DescribeImportTasksInput, ...func(*Options)) (*DescribeImportTasksOutput, error) } diff --git a/service/applicationdiscoveryservice/api_op_DescribeTags.go b/service/applicationdiscoveryservice/api_op_DescribeTags.go index e8796b6e969..f72a1f38812 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeTags.go +++ b/service/applicationdiscoveryservice/api_op_DescribeTags.go @@ -12,19 +12,14 @@ import ( ) // Retrieves a list of configuration items that have tags as specified by the -// key-value pairs, name and value, passed to the optional parameter filters. There -// are three valid tag filter names: +// key-value pairs, name and value, passed to the optional parameter filters . +// There are three valid tag filter names: +// - tagKey +// - tagValue +// - configurationId // -// * tagKey -// -// * tagValue -// -// * -// configurationId -// -// Also, all configuration items associated with your user account -// that have tags can be listed if you call DescribeTags as is without passing any -// parameters. +// Also, all configuration items associated with your user account that have tags +// can be listed if you call DescribeTags as is without passing any parameters. func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { params = &DescribeTagsInput{} @@ -43,8 +38,8 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op type DescribeTagsInput struct { // You can filter the list using a key-value format. You can separate these items - // by using logical operators. Allowed filters include tagKey, tagValue, and - // configurationId. + // by using logical operators. Allowed filters include tagKey , tagValue , and + // configurationId . Filters []types.TagFilter // The total number of items to return in a single page of output. The maximum diff --git a/service/applicationdiscoveryservice/api_op_ListConfigurations.go b/service/applicationdiscoveryservice/api_op_ListConfigurations.go index 3d66d5c936a..48d43790597 100644 --- a/service/applicationdiscoveryservice/api_op_ListConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_ListConfigurations.go @@ -12,7 +12,7 @@ import ( ) // Retrieves a list of configuration items as specified by the value passed to the -// required parameter configurationType. Optional filtering may be applied to +// required parameter configurationType . Optional filtering may be applied to // refine search results. func (c *Client) ListConfigurations(ctx context.Context, params *ListConfigurationsInput, optFns ...func(*Options)) (*ListConfigurationsOutput, error) { if params == nil { @@ -38,9 +38,8 @@ type ListConfigurationsInput struct { // You can filter the request using various logical operators and a key-value // format. For example: {"key": "serverType", "value": "webServer"} For a complete - // list of filter options and guidance about using them with this action, see Using - // the ListConfigurations Action - // (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) + // list of filter options and guidance about using them with this action, see + // Using the ListConfigurations Action (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) // in the Amazon Web Services Application Discovery Service User Guide. Filters []types.Filter @@ -55,8 +54,7 @@ type ListConfigurationsInput struct { // Certain filter criteria return output that can be sorted in ascending or // descending order. For a list of output characteristics for each filter, see - // Using the ListConfigurations Action - // (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) + // Using the ListConfigurations Action (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) // in the Amazon Web Services Application Discovery Service User Guide. OrderBy []types.OrderByElement diff --git a/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go b/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go index 3d8207cf295..0ba9503652f 100644 --- a/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go +++ b/service/applicationdiscoveryservice/api_op_ListServerNeighbors.go @@ -65,8 +65,8 @@ type ListServerNeighborsOutput struct { // Count of distinct servers that are one hop away from the given server. KnownDependencyCount int64 - // Token to retrieve the next set of results. For example, if you specified 100 IDs - // for ListServerNeighborsRequest$neighborConfigurationIds but set + // Token to retrieve the next set of results. For example, if you specified 100 + // IDs for ListServerNeighborsRequest$neighborConfigurationIds but set // ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results // along with this token. Use this token in the next query to retrieve the next set // of 10. diff --git a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go index b812c4c6d62..1efbbdc862a 100644 --- a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go +++ b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go @@ -45,9 +45,7 @@ type StartContinuousExportOutput struct { S3Bucket *string // A dictionary which describes how the data is stored. - // - // * databaseName - the name - // of the Glue database used to store the schema. + // - databaseName - the name of the Glue database used to store the schema. SchemaStorageConfig map[string]string // The timestamp representing when the continuous export was started. diff --git a/service/applicationdiscoveryservice/api_op_StartExportTask.go b/service/applicationdiscoveryservice/api_op_StartExportTask.go index 0ffb43db476..3ac876fc89b 100644 --- a/service/applicationdiscoveryservice/api_op_StartExportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartExportTask.go @@ -12,11 +12,11 @@ import ( "time" ) -// Begins the export of discovered data to an S3 bucket. If you specify agentIds in -// a filter, the task exports up to 72 hours of detailed data collected by the +// Begins the export of discovered data to an S3 bucket. If you specify agentIds +// in a filter, the task exports up to 72 hours of detailed data collected by the // identified Application Discovery Agent, including network, process, and // performance details. A time range for exported agent data may be set by using -// startTime and endTime. Export of detailed agent data is limited to five +// startTime and endTime . Export of detailed agent data is limited to five // concurrently running exports. If you do not include an agentIds filter, summary // data is exported that includes both Amazon Web Services Agentless Discovery // Connector data and summary data from Amazon Web Services Discovery Agents. @@ -43,14 +43,14 @@ type StartExportTaskInput struct { // most recent data collected by the agent. EndTime *time.Time - // The file format for the returned export data. Default value is CSV. Note: The + // The file format for the returned export data. Default value is CSV . Note: The // GRAPHML option has been deprecated. ExportDataFormat []types.ExportDataFormat // If a filter is present, it selects the single agentId of the Application // Discovery Agent for which data is exported. The agentId can be found in the - // results of the DescribeAgents API or CLI. If no filter is present, startTime and - // endTime are ignored and exported data includes both Agentless Discovery + // results of the DescribeAgents API or CLI. If no filter is present, startTime + // and endTime are ignored and exported data includes both Agentless Discovery // Connector data and summary data from Application Discovery agents. Filters []types.ExportFilter diff --git a/service/applicationdiscoveryservice/api_op_StartImportTask.go b/service/applicationdiscoveryservice/api_op_StartImportTask.go index a0f18d285cc..9785ff5c12a 100644 --- a/service/applicationdiscoveryservice/api_op_StartImportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartImportTask.go @@ -19,31 +19,22 @@ import ( // assessment and planning directly from your imported data, including the ability // to group your devices as applications and track their migration status. To start // an import request, do this: +// - Download the specially formatted comma separated value (CSV) import +// template, which you can find here: +// https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv (https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv) +// . +// - Fill out the template with your server and application data. +// - Upload your import file to an Amazon S3 bucket, and make a note of it's +// Object URL. Your import file must be in the CSV format. +// - Use the console or the StartImportTask command with the Amazon Web Services +// CLI or one of the Amazon Web Services SDKs to import the records from your file. // -// * Download the specially formatted comma separated -// value (CSV) import template, which you can find here: -// https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv -// (https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv). -// -// * -// Fill out the template with your server and application data. -// -// * Upload your -// import file to an Amazon S3 bucket, and make a note of it's Object URL. Your -// import file must be in the CSV format. -// -// * Use the console or the StartImportTask -// command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs -// to import the records from your file. -// -// For more information, including -// step-by-step procedures, see Migration Hub Import -// (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html) +// For more information, including step-by-step procedures, see Migration Hub +// Import (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html) // in the Amazon Web Services Application Discovery Service User Guide. There are // limits to the number of import tasks you can create (and delete) in an Amazon // Web Services account. For more information, see Amazon Web Services Application -// Discovery Service Limits -// (https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html) +// Discovery Service Limits (https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html) // in the Amazon Web Services Application Discovery Service User Guide. func (c *Client) StartImportTask(ctx context.Context, params *StartImportTaskInput, optFns ...func(*Options)) (*StartImportTaskOutput, error) { if params == nil { @@ -77,8 +68,8 @@ type StartImportTaskInput struct { // This member is required. Name *string - // Optional. A unique token that you can provide to prevent the same import request - // from occurring more than once. If you don't provide a token, a token is + // Optional. A unique token that you can provide to prevent the same import + // request from occurring more than once. If you don't provide a token, a token is // automatically generated. Sending more than one StartImportTask request with the // same client request token will return information about the original import task // with that client request token. diff --git a/service/applicationdiscoveryservice/doc.go b/service/applicationdiscoveryservice/doc.go index 261418ecb03..5e1ae7f8655 100644 --- a/service/applicationdiscoveryservice/doc.go +++ b/service/applicationdiscoveryservice/doc.go @@ -7,85 +7,70 @@ // Application Discovery Service helps you plan application migration projects. It // automatically identifies servers, virtual machines (VMs), and network // dependencies in your on-premises data centers. For more information, see the -// Amazon Web Services Application Discovery Service FAQ -// (http://aws.amazon.com/application-discovery/faqs/). Application Discovery -// Service offers three ways of performing discovery and collecting data about your -// on-premises servers: -// -// * Agentless discovery is recommended for environments that -// use VMware vCenter Server. This mode doesn't require you to install an agent on -// each host. It does not work in non-VMware environments. -// -// * Agentless discovery -// gathers server information regardless of the operating systems, which minimizes -// the time required for initial on-premises infrastructure assessment. -// -// * -// Agentless discovery doesn't collect information about network dependencies, only -// agent-based discovery collects that information. -// -// * Agent-based discovery -// collects a richer set of data than agentless discovery by using the Amazon Web -// Services Application Discovery Agent, which you install on one or more hosts in -// your data center. -// -// * The agent captures infrastructure and application -// information, including an inventory of running processes, system performance -// information, resource utilization, and network dependencies. -// -// * The information -// collected by agents is secured at rest and in transit to the Application -// Discovery Service database in the cloud. -// -// * Amazon Web Services Partner Network -// (APN) solutions integrate with Application Discovery Service, enabling you to -// import details of your on-premises environment directly into Migration Hub -// without using the discovery connector or discovery agent. -// -// * Third-party -// application discovery tools can query Amazon Web Services Application Discovery -// Service, and they can write to the Application Discovery Service database using -// the public API. -// -// * In this way, you can import data into Migration Hub and view -// it, so that you can associate applications with servers and track -// migrations. -// -// Recommendations We recommend that you use agent-based discovery for -// non-VMware environments, and whenever you want to collect information about -// network dependencies. You can run agent-based and agentless discovery -// simultaneously. Use agentless discovery to complete the initial infrastructure -// assessment quickly, and then install agents on select hosts to collect -// additional information. Working With This Guide This API reference provides -// descriptions, syntax, and usage examples for each of the actions and data types -// for Application Discovery Service. The topic for each action shows the API -// request parameters and the response. Alternatively, you can use one of the -// Amazon Web Services SDKs to access an API that is tailored to the programming -// language or platform that you're using. For more information, see Amazon Web -// Services SDKs (http://aws.amazon.com/tools/#SDKs). -// -// * Remember that you must set -// your Migration Hub home region before you call any of these APIs. -// -// * You must -// make API calls for write actions (create, notify, associate, disassociate, -// import, or put) while in your home region, or a HomeRegionNotSetException error -// is returned. -// -// * API calls for read actions (list, describe, stop, and delete) -// are permitted outside of your home region. -// -// * Although it is unlikely, the -// Migration Hub home region could change. If you call APIs outside the home -// region, an InvalidInputException is returned. -// -// * You must call GetHomeRegion to -// obtain the latest Migration Hub home region. -// -// This guide is intended for use -// with the Amazon Web Services Application Discovery Service User Guide -// (http://docs.aws.amazon.com/application-discovery/latest/userguide/). All data -// is handled according to the Amazon Web Services Privacy Policy -// (http://aws.amazon.com/privacy/). You can operate Application Discovery Service -// offline to inspect collected data before it is shared with the service. +// Amazon Web Services Application Discovery Service FAQ (http://aws.amazon.com/application-discovery/faqs/) +// . Application Discovery Service offers three ways of performing discovery and +// collecting data about your on-premises servers: +// +// - Agentless discovery is recommended for environments that use VMware vCenter +// Server. This mode doesn't require you to install an agent on each host. It does +// not work in non-VMware environments. +// +// - Agentless discovery gathers server information regardless of the operating +// systems, which minimizes the time required for initial on-premises +// infrastructure assessment. +// +// - Agentless discovery doesn't collect information about network dependencies, +// only agent-based discovery collects that information. +// +// - Agent-based discovery collects a richer set of data than agentless +// discovery by using the Amazon Web Services Application Discovery Agent, which +// you install on one or more hosts in your data center. +// +// - The agent captures infrastructure and application information, including an +// inventory of running processes, system performance information, resource +// utilization, and network dependencies. +// +// - The information collected by agents is secured at rest and in transit to +// the Application Discovery Service database in the cloud. +// +// - Amazon Web Services Partner Network (APN) solutions integrate with +// Application Discovery Service, enabling you to import details of your +// on-premises environment directly into Migration Hub without using the discovery +// connector or discovery agent. +// +// - Third-party application discovery tools can query Amazon Web Services +// Application Discovery Service, and they can write to the Application Discovery +// Service database using the public API. +// +// - In this way, you can import data into Migration Hub and view it, so that +// you can associate applications with servers and track migrations. +// +// Recommendations We recommend that you use agent-based discovery for non-VMware +// environments, and whenever you want to collect information about network +// dependencies. You can run agent-based and agentless discovery simultaneously. +// Use agentless discovery to complete the initial infrastructure assessment +// quickly, and then install agents on select hosts to collect additional +// information. Working With This Guide This API reference provides descriptions, +// syntax, and usage examples for each of the actions and data types for +// Application Discovery Service. The topic for each action shows the API request +// parameters and the response. Alternatively, you can use one of the Amazon Web +// Services SDKs to access an API that is tailored to the programming language or +// platform that you're using. For more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs) +// . +// - Remember that you must set your Migration Hub home region before you call +// any of these APIs. +// - You must make API calls for write actions (create, notify, associate, +// disassociate, import, or put) while in your home region, or a +// HomeRegionNotSetException error is returned. +// - API calls for read actions (list, describe, stop, and delete) are permitted +// outside of your home region. +// - Although it is unlikely, the Migration Hub home region could change. If you +// call APIs outside the home region, an InvalidInputException is returned. +// - You must call GetHomeRegion to obtain the latest Migration Hub home region. +// +// This guide is intended for use with the Amazon Web Services Application +// Discovery Service User Guide (http://docs.aws.amazon.com/application-discovery/latest/userguide/) +// . All data is handled according to the Amazon Web Services Privacy Policy (http://aws.amazon.com/privacy/) +// . You can operate Application Discovery Service offline to inspect collected +// data before it is shared with the service. package applicationdiscoveryservice diff --git a/service/applicationdiscoveryservice/types/enums.go b/service/applicationdiscoveryservice/types/enums.go index af6e1a77da0..3697a195708 100644 --- a/service/applicationdiscoveryservice/types/enums.go +++ b/service/applicationdiscoveryservice/types/enums.go @@ -59,8 +59,8 @@ const ( ConfigurationItemTypeApplication ConfigurationItemType = "APPLICATION" ) -// Values returns all known values for ConfigurationItemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ConfigurationItemType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationItemType) Values() []ConfigurationItemType { return []ConfigurationItemType{ @@ -142,9 +142,9 @@ const ( ExportStatusInProgress ExportStatus = "IN_PROGRESS" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "FAILED", @@ -170,9 +170,9 @@ const ( ImportStatusInternalError ImportStatus = "INTERNAL_ERROR" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "IMPORT_IN_PROGRESS", diff --git a/service/applicationdiscoveryservice/types/errors.go b/service/applicationdiscoveryservice/types/errors.go index 12d775e5a5a..f59c719d048 100644 --- a/service/applicationdiscoveryservice/types/errors.go +++ b/service/applicationdiscoveryservice/types/errors.go @@ -168,7 +168,7 @@ func (e *OperationNotPermittedException) ErrorFault() smithy.ErrorFault { return // StartImportTask action, but with different parameters. For example, you use the // same request token but have two different import URLs, you can encounter this // issue. If the import tasks are meant to be different, use a different -// clientRequestToken, and try again. +// clientRequestToken , and try again. type ResourceInUseException struct { Message *string diff --git a/service/applicationdiscoveryservice/types/types.go b/service/applicationdiscoveryservice/types/types.go index 5c048367ef3..502d5c35dc5 100644 --- a/service/applicationdiscoveryservice/types/types.go +++ b/service/applicationdiscoveryservice/types/types.go @@ -131,119 +131,78 @@ type ContinuousExportDescription struct { S3Bucket *string // An object which describes how the data is stored. - // - // * databaseName - the name of - // the Glue database used to store the schema. + // - databaseName - the name of the Glue database used to store the schema. SchemaStorageConfig map[string]string // The timestamp representing when the continuous export was started. StartTime *time.Time // Describes the status of the export. Can be one of the following values: - // - // * - // START_IN_PROGRESS - setting up resources to start continuous export. - // - // * - // START_FAILED - an error occurred setting up continuous export. To recover, call - // start-continuous-export again. - // - // * ACTIVE - data is being exported to the - // customer bucket. - // - // * ERROR - an error occurred during export. To fix the issue, - // call stop-continuous-export and start-continuous-export. - // - // * STOP_IN_PROGRESS - - // stopping the export. - // - // * STOP_FAILED - an error occurred stopping the export. To - // recover, call stop-continuous-export again. - // - // * INACTIVE - the continuous export - // has been stopped. Data is no longer being exported to the customer bucket. + // - START_IN_PROGRESS - setting up resources to start continuous export. + // - START_FAILED - an error occurred setting up continuous export. To recover, + // call start-continuous-export again. + // - ACTIVE - data is being exported to the customer bucket. + // - ERROR - an error occurred during export. To fix the issue, call + // stop-continuous-export and start-continuous-export. + // - STOP_IN_PROGRESS - stopping the export. + // - STOP_FAILED - an error occurred stopping the export. To recover, call + // stop-continuous-export again. + // - INACTIVE - the continuous export has been stopped. Data is no longer being + // exported to the customer bucket. Status ContinuousExportStatus // Contains information about any errors that have occurred. This data type can // have the following values: - // - // * ACCESS_DENIED - You don’t have permission to start - // Data Exploration in Amazon Athena. Contact your Amazon Web Services - // administrator for help. For more information, see Setting Up Amazon Web Services - // Application Discovery Service - // (http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html) - // in the Application Discovery Service User Guide. - // - // * - // DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data - // Firehose delivery streams. Reduce the number of streams or request a limit - // increase and try again. For more information, see Kinesis Data Streams Limits - // (http://docs.aws.amazon.com/streams/latest/dev/service-sizes-and-limits.html) in - // the Amazon Kinesis Data Streams Developer Guide. - // - // * FIREHOSE_ROLE_MISSING - The - // Data Exploration feature is in an error state because your IAM User is missing - // the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in - // Amazon Athena and try again. For more information, see Step 3: Provide - // Application Discovery Service Access to Non-Administrator Users by Attaching - // Policies - // (http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html#setting-up-user-policy) - // in the Application Discovery Service User Guide. - // - // * - // FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error - // state because your IAM User is missing one or more of the Kinesis data delivery - // streams. - // - // * INTERNAL_FAILURE - The Data Exploration feature is in an error state - // because of an internal failure. Try again later. If this problem persists, - // contact Amazon Web Services Support. - // - // * LAKE_FORMATION_ACCESS_DENIED - You don't - // have sufficient lake formation permissions to start continuous export. For more - // information, see Upgrading Amazon Web Services Glue Data Permissions to the - // Amazon Web Services Lake Formation Model - // (http://docs.aws.amazon.com/lake-formation/latest/dg/upgrade-glue-lake-formation.html) - // in the Amazon Web Services Lake Formation Developer Guide. You can use one of - // the following two ways to resolve this issue. - // - // * If you don’t want to use the - // Lake Formation permission model, you can change the default Data Catalog - // settings to use only Amazon Web Services Identity and Access Management (IAM) - // access control for new databases. For more information, see Change Data Catalog - // Settings - // (https://docs.aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#setup-change-cat-settings) - // in the Lake Formation Developer Guide. - // - // * You can give the service-linked IAM - // roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and - // AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. - // For more information, see Granting Database Permissions - // (https://docs.aws.amazon.com/lake-formation/latest/dg/granting-database-permissions.html) - // in the Lake Formation Developer Guide. - // - // * - // AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database - // creator permissions, which gives the role database creation ability and implicit - // permissions for any created tables. For more information, see Implicit Lake - // Formation Permissions - // (https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html) - // in the Lake Formation Developer Guide. - // - // * AWSApplicationDiscoveryServiceFirehose - // - Grant describe permissions for all tables in the database. - // - // * - // S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce - // the number of S3 buckets or request a limit increase and try again. For more - // information, see Bucket Restrictions and Limitations - // (http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) in the - // Amazon Simple Storage Service Developer Guide. - // - // * S3_NOT_SIGNED_UP - Your - // account is not signed up for the Amazon S3 service. You must sign up before you - // can use Amazon S3. You can sign up at the following URL: - // https://aws.amazon.com/s3 (https://aws.amazon.com/s3). + // - ACCESS_DENIED - You don’t have permission to start Data Exploration in + // Amazon Athena. Contact your Amazon Web Services administrator for help. For more + // information, see Setting Up Amazon Web Services Application Discovery Service (http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html) + // in the Application Discovery Service User Guide. + // - DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis + // Data Firehose delivery streams. Reduce the number of streams or request a limit + // increase and try again. For more information, see Kinesis Data Streams Limits (http://docs.aws.amazon.com/streams/latest/dev/service-sizes-and-limits.html) + // in the Amazon Kinesis Data Streams Developer Guide. + // - FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state + // because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose + // role. Turn on Data Exploration in Amazon Athena and try again. For more + // information, see Step 3: Provide Application Discovery Service Access to + // Non-Administrator Users by Attaching Policies (http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html#setting-up-user-policy) + // in the Application Discovery Service User Guide. + // - FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an + // error state because your IAM User is missing one or more of the Kinesis data + // delivery streams. + // - INTERNAL_FAILURE - The Data Exploration feature is in an error state + // because of an internal failure. Try again later. If this problem persists, + // contact Amazon Web Services Support. + // - LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation + // permissions to start continuous export. For more information, see Upgrading + // Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake + // Formation Model (http://docs.aws.amazon.com/lake-formation/latest/dg/upgrade-glue-lake-formation.html) + // in the Amazon Web Services Lake Formation Developer Guide. You can use one of + // the following two ways to resolve this issue. + // - If you don’t want to use the Lake Formation permission model, you can + // change the default Data Catalog settings to use only Amazon Web Services + // Identity and Access Management (IAM) access control for new databases. For more + // information, see Change Data Catalog Settings (https://docs.aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#setup-change-cat-settings) + // in the Lake Formation Developer Guide. + // - You can give the service-linked IAM roles + // AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and + // AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. + // For more information, see Granting Database Permissions (https://docs.aws.amazon.com/lake-formation/latest/dg/granting-database-permissions.html) + // in the Lake Formation Developer Guide. + // - AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant + // database creator permissions, which gives the role database creation ability and + // implicit permissions for any created tables. For more information, see + // Implicit Lake Formation Permissions (https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html) + // in the Lake Formation Developer Guide. + // - AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all + // tables in the database. + // - S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. + // Reduce the number of S3 buckets or request a limit increase and try again. For + // more information, see Bucket Restrictions and Limitations (http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) + // in the Amazon Simple Storage Service Developer Guide. + // - S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. + // You must sign up before you can use Amazon S3. You can sign up at the following + // URL: https://aws.amazon.com/s3 (https://aws.amazon.com/s3) . StatusDetail *string // The timestamp that represents when this continuous export was stopped. @@ -402,8 +361,7 @@ type CustomerMeCollectorInfo struct { } // Used to select which agent's data is to be exported. A single agent ID may be -// selected for export using the StartExportTask -// (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html) +// selected for export using the StartExportTask (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html) // action. type ExportFilter struct { @@ -412,15 +370,14 @@ type ExportFilter struct { // This member is required. Condition *string - // A single ExportFilter name. Supported filters: agentIds. + // A single ExportFilter name. Supported filters: agentIds . // // This member is required. Name *string // A single agent ID for a Discovery Agent. An agent ID can be found using the - // DescribeAgents - // (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeAgents.html) - // action. Typically an ADS agent ID is in the form o-0123456789abcdef0. + // DescribeAgents (http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeAgents.html) + // action. Typically an ADS agent ID is in the form o-0123456789abcdef0 . // // This member is required. Values []string @@ -452,30 +409,29 @@ type ExportInfo struct { // This member is required. StatusMessage *string - // A URL for an Amazon S3 bucket where you can review the exported data. The URL is - // displayed only if the export succeeded. + // A URL for an Amazon S3 bucket where you can review the exported data. The URL + // is displayed only if the export succeeded. ConfigurationsDownloadUrl *string // If true, the export of agent information exceeded the size limit for a single // export and the exported data is incomplete for the requested time range. To // address this, select a smaller time range for the export by using startDate and - // endDate. + // endDate . IsTruncated bool // The endTime used in the StartExportTask request. If no endTime was requested, - // this result does not appear in ExportInfo. + // this result does not appear in ExportInfo . RequestedEndTime *time.Time // The value of startTime parameter in the StartExportTask request. If no startTime - // was requested, this result does not appear in ExportInfo. + // was requested, this result does not appear in ExportInfo . RequestedStartTime *time.Time noSmithyDocumentSerde } -// A filter that can use conditional operators. For more information about filters, -// see Querying Discovered Configuration Items -// (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html) +// A filter that can use conditional operators. For more information about +// filters, see Querying Discovered Configuration Items (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html) // in the Amazon Web Services Application Discovery Service User Guide. type Filter struct { @@ -520,8 +476,8 @@ type ImportTask struct { // the import task request was sent. ClientRequestToken *string - // A link to a compressed archive folder (in the ZIP format) that contains an error - // log and a file of failed records. You can use these two files to quickly + // A link to a compressed archive folder (in the ZIP format) that contains an + // error log and a file of failed records. You can use these two files to quickly // identify records that failed, why they failed, and correct those records. // Afterward, you can upload the corrected file to your Amazon S3 bucket and create // another import task request. This field also includes authorization information @@ -532,16 +488,16 @@ type ImportTask struct { // file and attempt importing it again. ErrorsAndFailedEntriesZip *string - // The time that the import task request finished, presented in the Unix time stamp - // format. + // The time that the import task request finished, presented in the Unix time + // stamp format. ImportCompletionTime *time.Time // The time that the import task request was deleted, presented in the Unix time // stamp format. ImportDeletedTime *time.Time - // The time that the import task request was made, presented in the Unix time stamp - // format. + // The time that the import task request was made, presented in the Unix time + // stamp format. ImportRequestTime *time.Time // The unique ID for a specific import task. These IDs aren't globally unique, but @@ -647,7 +603,7 @@ type Tag struct { noSmithyDocumentSerde } -// The tag filter. Valid names are: tagKey, tagValue, configurationId. +// The tag filter. Valid names are: tagKey , tagValue , configurationId . type TagFilter struct { // A name of the tag filter. diff --git a/service/applicationinsights/api_client.go b/service/applicationinsights/api_client.go index 733e3e503e0..1e39b0f73fc 100644 --- a/service/applicationinsights/api_client.go +++ b/service/applicationinsights/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/applicationinsights/api_op_CreateApplication.go b/service/applicationinsights/api_op_CreateApplication.go index 3bf3bdb4314..0f2ebc008a2 100644 --- a/service/applicationinsights/api_op_CreateApplication.go +++ b/service/applicationinsights/api_op_CreateApplication.go @@ -38,27 +38,27 @@ type CreateApplicationInput struct { AutoCreate *bool // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and + // application resources, such as instance terminated , failed deployment , and // others. CWEMonitorEnabled *bool // Application Insights can create applications based on a resource group or on an // account. To create an account-based application using all of the resources in - // the account, set this parameter to ACCOUNT_BASED. + // the account, set this parameter to ACCOUNT_BASED . GroupingType types.GroupingType - // When set to true, creates opsItems for any problems detected on an application. + // When set to true , creates opsItems for any problems detected on an application. OpsCenterEnabled *bool - // The SNS topic provided to Application Insights that is associated to the created - // opsItem. Allows you to receive notifications for updates to the opsItem. + // The SNS topic provided to Application Insights that is associated to the + // created opsItem. Allows you to receive notifications for updates to the opsItem. OpsItemSNSTopicArn *string // The name of the resource group. ResourceGroupName *string - // List of tags to add to the application. tag key (Key) and an associated tag - // value (Value). The maximum length of a tag key is 128 characters. The maximum + // List of tags to add to the application. tag key ( Key ) and an associated tag + // value ( Value ). The maximum length of a tag key is 128 characters. The maximum // length of a tag value is 256 characters. Tags []types.Tag diff --git a/service/applicationinsights/api_op_CreateLogPattern.go b/service/applicationinsights/api_op_CreateLogPattern.go index c35d424ae6f..83c31c58d9b 100644 --- a/service/applicationinsights/api_op_CreateLogPattern.go +++ b/service/applicationinsights/api_op_CreateLogPattern.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds an log pattern to a LogPatternSet. +// Adds an log pattern to a LogPatternSet . func (c *Client) CreateLogPattern(ctx context.Context, params *CreateLogPatternInput, optFns ...func(*Options)) (*CreateLogPatternOutput, error) { if params == nil { params = &CreateLogPatternInput{} @@ -45,14 +45,14 @@ type CreateLogPatternInput struct { // This member is required. PatternSetName *string - // Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns + // Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns // are sorted by rank, so we recommend that you set your highest priority patterns // with the lowest rank. A pattern of rank 1 will be the first to get matched to a // log line. A pattern of rank 1,000,000 will be last to get matched. When you // configure custom log patterns from the console, a Low severity pattern // translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 - // rank. And a High severity pattern translates to a 250,000 rank. Rank values less - // than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. + // rank. And a High severity pattern translates to a 250,000 rank. Rank values + // less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. // // This member is required. Rank int32 diff --git a/service/applicationinsights/api_op_DeleteLogPattern.go b/service/applicationinsights/api_op_DeleteLogPattern.go index 6f164b64d74..57f63e34a7e 100644 --- a/service/applicationinsights/api_op_DeleteLogPattern.go +++ b/service/applicationinsights/api_op_DeleteLogPattern.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified log pattern from a LogPatternSet. +// Removes the specified log pattern from a LogPatternSet . func (c *Client) DeleteLogPattern(ctx context.Context, params *DeleteLogPatternInput, optFns ...func(*Options)) (*DeleteLogPatternOutput, error) { if params == nil { params = &DeleteLogPatternInput{} diff --git a/service/applicationinsights/api_op_DescribeComponentConfiguration.go b/service/applicationinsights/api_op_DescribeComponentConfiguration.go index 5a8a89ac01b..2a2296841fe 100644 --- a/service/applicationinsights/api_op_DescribeComponentConfiguration.go +++ b/service/applicationinsights/api_op_DescribeComponentConfiguration.go @@ -51,8 +51,8 @@ type DescribeComponentConfigurationOutput struct { // Indicates whether the application component is monitored. Monitor *bool - // The tier of the application component. Supported tiers include DOT_NET_CORE, - // DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT + // The tier of the application component. Supported tiers include DOT_NET_CORE , + // DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , and DEFAULT Tier types.Tier // Metadata pertaining to the operation's result. diff --git a/service/applicationinsights/api_op_DescribeLogPattern.go b/service/applicationinsights/api_op_DescribeLogPattern.go index 73f37b0b770..06b712e0539 100644 --- a/service/applicationinsights/api_op_DescribeLogPattern.go +++ b/service/applicationinsights/api_op_DescribeLogPattern.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe a specific log pattern from a LogPatternSet. +// Describe a specific log pattern from a LogPatternSet . func (c *Client) DescribeLogPattern(ctx context.Context, params *DescribeLogPatternInput, optFns ...func(*Options)) (*DescribeLogPatternOutput, error) { if params == nil { params = &DescribeLogPatternInput{} diff --git a/service/applicationinsights/api_op_ListConfigurationHistory.go b/service/applicationinsights/api_op_ListConfigurationHistory.go index 4cb67b7bd2b..7e66d0301d5 100644 --- a/service/applicationinsights/api_op_ListConfigurationHistory.go +++ b/service/applicationinsights/api_op_ListConfigurationHistory.go @@ -15,15 +15,10 @@ import ( // Lists the INFO, WARN, and ERROR events for periodic configuration updates // performed by Application Insights. Examples of events represented are: -// -// * INFO: -// creating a new alarm or updating an alarm threshold. -// -// * WARN: alarm not created -// due to insufficient data points used to predict thresholds. -// -// * ERROR: alarm not -// created due to permission errors or exceeding quotas. +// - INFO: creating a new alarm or updating an alarm threshold. +// - WARN: alarm not created due to insufficient data points used to predict +// thresholds. +// - ERROR: alarm not created due to permission errors or exceeding quotas. func (c *Client) ListConfigurationHistory(ctx context.Context, params *ListConfigurationHistoryInput, optFns ...func(*Options)) (*ListConfigurationHistoryOutput, error) { if params == nil { params = &ListConfigurationHistoryInput{} @@ -78,7 +73,7 @@ type ListConfigurationHistoryOutput struct { EventList []types.ConfigurationEvent // The NextToken value to include in a future ListConfigurationHistory request. - // When the results of a ListConfigurationHistory request exceed MaxResults, this + // When the results of a ListConfigurationHistory request exceed MaxResults , this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string diff --git a/service/applicationinsights/api_op_ListLogPatterns.go b/service/applicationinsights/api_op_ListLogPatterns.go index 9dfded2578a..2925289dd53 100644 --- a/service/applicationinsights/api_op_ListLogPatterns.go +++ b/service/applicationinsights/api_op_ListLogPatterns.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the log patterns in the specific log LogPatternSet. +// Lists the log patterns in the specific log LogPatternSet . func (c *Client) ListLogPatterns(ctx context.Context, params *ListLogPatternsInput, optFns ...func(*Options)) (*ListLogPatternsOutput, error) { if params == nil { params = &ListLogPatternsInput{} diff --git a/service/applicationinsights/api_op_ListProblems.go b/service/applicationinsights/api_op_ListProblems.go index abc782d7aee..7b198424af0 100644 --- a/service/applicationinsights/api_op_ListProblems.go +++ b/service/applicationinsights/api_op_ListProblems.go @@ -48,8 +48,8 @@ type ListProblemsInput struct { // The name of the resource group. ResourceGroupName *string - // The time when the problem was detected, in epoch seconds. If you don't specify a - // time frame for the request, problems within the past seven days are returned. + // The time when the problem was detected, in epoch seconds. If you don't specify + // a time frame for the request, problems within the past seven days are returned. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/applicationinsights/api_op_ListTagsForResource.go b/service/applicationinsights/api_op_ListTagsForResource.go index 68a985ea7e4..b72446eb81b 100644 --- a/service/applicationinsights/api_op_ListTagsForResource.go +++ b/service/applicationinsights/api_op_ListTagsForResource.go @@ -45,7 +45,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // An array that lists all the tags that are associated with the application. Each - // tag consists of a required tag key (Key) and an associated tag value (Value). + // tag consists of a required tag key ( Key ) and an associated tag value ( Value ). Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/applicationinsights/api_op_TagResource.go b/service/applicationinsights/api_op_TagResource.go index 9efca34858c..9f0f9221381 100644 --- a/service/applicationinsights/api_op_TagResource.go +++ b/service/applicationinsights/api_op_TagResource.go @@ -42,8 +42,8 @@ type TagResourceInput struct { ResourceARN *string // A list of tags that to add to the application. A tag consists of a required tag - // key (Key) and an associated tag value (Value). The maximum length of a tag key - // is 128 characters. The maximum length of a tag value is 256 characters. + // key ( Key ) and an associated tag value ( Value ). The maximum length of a tag + // key is 128 characters. The maximum length of a tag value is 256 characters. // // This member is required. Tags []types.Tag diff --git a/service/applicationinsights/api_op_UntagResource.go b/service/applicationinsights/api_op_UntagResource.go index c0e9f198341..a0f25a7402d 100644 --- a/service/applicationinsights/api_op_UntagResource.go +++ b/service/applicationinsights/api_op_UntagResource.go @@ -28,8 +28,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the application that you want to remove one or - // more tags from. + // The Amazon Resource Name (ARN) of the application that you want to remove one + // or more tags from. // // This member is required. ResourceARN *string diff --git a/service/applicationinsights/api_op_UpdateApplication.go b/service/applicationinsights/api_op_UpdateApplication.go index bfbbc756baf..a099d199a96 100644 --- a/service/applicationinsights/api_op_UpdateApplication.go +++ b/service/applicationinsights/api_op_UpdateApplication.go @@ -38,15 +38,15 @@ type UpdateApplicationInput struct { AutoConfigEnabled *bool // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and + // application resources, such as instance terminated , failed deployment , and // others. CWEMonitorEnabled *bool - // When set to true, creates opsItems for any problems detected on an application. + // When set to true , creates opsItems for any problems detected on an application. OpsCenterEnabled *bool - // The SNS topic provided to Application Insights that is associated to the created - // opsItem. Allows you to receive notifications for updates to the opsItem. + // The SNS topic provided to Application Insights that is associated to the + // created opsItem. Allows you to receive notifications for updates to the opsItem. OpsItemSNSTopicArn *string // Disassociates the SNS topic from the opsItem created for detected problems. diff --git a/service/applicationinsights/api_op_UpdateComponentConfiguration.go b/service/applicationinsights/api_op_UpdateComponentConfiguration.go index a0fbab309f8..b6b9d01404f 100644 --- a/service/applicationinsights/api_op_UpdateComponentConfiguration.go +++ b/service/applicationinsights/api_op_UpdateComponentConfiguration.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the monitoring configurations for the component. The configuration input -// parameter is an escaped JSON of the configuration and should match the schema of -// what is returned by DescribeComponentConfigurationRecommendation. +// Updates the monitoring configurations for the component. The configuration +// input parameter is an escaped JSON of the configuration and should match the +// schema of what is returned by DescribeComponentConfigurationRecommendation . func (c *Client) UpdateComponentConfiguration(ctx context.Context, params *UpdateComponentConfigurationInput, optFns ...func(*Options)) (*UpdateComponentConfigurationOutput, error) { if params == nil { params = &UpdateComponentConfigurationInput{} @@ -47,12 +47,11 @@ type UpdateComponentConfigurationInput struct { // The configuration settings of the component. The value is the escaped JSON of // the configuration. For more information about the JSON format, see Working with - // JSON - // (https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html). - // You can send a request to DescribeComponentConfigurationRecommendation to see + // JSON (https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html) + // . You can send a request to DescribeComponentConfigurationRecommendation to see // the recommended configuration for a component. For the complete format of the - // component configuration file, see Component Configuration - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html). + // component configuration file, see Component Configuration (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html) + // . ComponentConfiguration *string // Indicates whether the application component is monitored. diff --git a/service/applicationinsights/api_op_UpdateLogPattern.go b/service/applicationinsights/api_op_UpdateLogPattern.go index b74a1251d0f..ddf3be8dffb 100644 --- a/service/applicationinsights/api_op_UpdateLogPattern.go +++ b/service/applicationinsights/api_op_UpdateLogPattern.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a log pattern to a LogPatternSet. +// Adds a log pattern to a LogPatternSet . func (c *Client) UpdateLogPattern(ctx context.Context, params *UpdateLogPatternInput, optFns ...func(*Options)) (*UpdateLogPatternOutput, error) { if params == nil { params = &UpdateLogPatternInput{} @@ -48,14 +48,14 @@ type UpdateLogPatternInput struct { // forward lookahead or backreference constructions are not supported. Pattern *string - // Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns + // Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns // are sorted by rank, so we recommend that you set your highest priority patterns // with the lowest rank. A pattern of rank 1 will be the first to get matched to a // log line. A pattern of rank 1,000,000 will be last to get matched. When you // configure custom log patterns from the console, a Low severity pattern // translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 - // rank. And a High severity pattern translates to a 250,000 rank. Rank values less - // than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. + // rank. And a High severity pattern translates to a 250,000 rank. Rank values + // less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. Rank int32 noSmithyDocumentSerde diff --git a/service/applicationinsights/doc.go b/service/applicationinsights/doc.go index e88cab779a7..5e5c2d967ee 100644 --- a/service/applicationinsights/doc.go +++ b/service/applicationinsights/doc.go @@ -3,8 +3,8 @@ // Package applicationinsights provides the API client, operations, and parameter // types for Amazon CloudWatch Application Insights. // -// Amazon CloudWatch Application Insights Amazon CloudWatch Application Insights is -// a service that helps you detect common problems with your applications. It +// Amazon CloudWatch Application Insights Amazon CloudWatch Application Insights +// is a service that helps you detect common problems with your applications. It // enables you to pinpoint the source of issues in your applications (built with // technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by // providing key insights into detected problems. After you onboard your diff --git a/service/applicationinsights/types/enums.go b/service/applicationinsights/types/enums.go index b9076887502..16de3ef1b4f 100644 --- a/service/applicationinsights/types/enums.go +++ b/service/applicationinsights/types/enums.go @@ -12,8 +12,8 @@ const ( CloudWatchEventSourceRds CloudWatchEventSource = "RDS" ) -// Values returns all known values for CloudWatchEventSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CloudWatchEventSource. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchEventSource) Values() []CloudWatchEventSource { return []CloudWatchEventSource{ @@ -56,9 +56,9 @@ const ( ConfigurationEventStatusError ConfigurationEventStatus = "ERROR" ) -// Values returns all known values for ConfigurationEventStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConfigurationEventStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationEventStatus) Values() []ConfigurationEventStatus { return []ConfigurationEventStatus{ "INFO", @@ -128,9 +128,9 @@ const ( GroupingTypeAccountBased GroupingType = "ACCOUNT_BASED" ) -// Values returns all known values for GroupingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for GroupingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (GroupingType) Values() []GroupingType { return []GroupingType{ "ACCOUNT_BASED", @@ -146,9 +146,9 @@ const ( LogFilterInfo LogFilter = "INFO" ) -// Values returns all known values for LogFilter. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LogFilter. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LogFilter) Values() []LogFilter { return []LogFilter{ "ERROR", diff --git a/service/applicationinsights/types/errors.go b/service/applicationinsights/types/errors.go index 05d92c74d24..1b510d612b2 100644 --- a/service/applicationinsights/types/errors.go +++ b/service/applicationinsights/types/errors.go @@ -163,8 +163,8 @@ func (e *TagsAlreadyExistException) ErrorCode() string { } func (e *TagsAlreadyExistException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of the provided tags is beyond the limit, or the number of total tags -// you are trying to attach to the specified resource exceeds the limit. +// The number of the provided tags is beyond the limit, or the number of total +// tags you are trying to attach to the specified resource exceeds the limit. type TooManyTagsException struct { Message *string diff --git a/service/applicationinsights/types/types.go b/service/applicationinsights/types/types.go index 96352a31c29..e3d209206ac 100644 --- a/service/applicationinsights/types/types.go +++ b/service/applicationinsights/types/types.go @@ -44,7 +44,7 @@ type ApplicationInfo struct { AutoConfigEnabled *bool // Indicates whether Application Insights can listen to CloudWatch events for the - // application resources, such as instance terminated, failed deployment, and + // application resources, such as instance terminated , failed deployment , and // others. CWEMonitorEnabled *bool @@ -58,18 +58,14 @@ type ApplicationInfo struct { // detected by Application Insights for an application. OpsCenterEnabled *bool - // The SNS topic provided to Application Insights that is associated to the created - // opsItems to receive SNS notifications for opsItem updates. + // The SNS topic provided to Application Insights that is associated to the + // created opsItems to receive SNS notifications for opsItem updates. OpsItemSNSTopicArn *string // The issues on the user side that block Application Insights from successfully // monitoring an application. Example remarks include: - // - // * “Configuring application, - // detected 1 Errors, 3 Warnings” - // - // * “Configuring application, detected 1 - // Unconfigured Components” + // - “Configuring application, detected 1 Errors, 3 Warnings” + // - “Configuring application, detected 1 Unconfigured Components” Remarks *string // The name of the resource group used for the application. @@ -87,8 +83,8 @@ type ConfigurationEvent struct { // The name of the resource Application Insights attempted to configure. EventResourceName *string - // The resource type that Application Insights attempted to configure, for example, - // CLOUDWATCH_ALARM. + // The resource type that Application Insights attempted to configure, for + // example, CLOUDWATCH_ALARM. EventResourceType ConfigurationEventResourceType // The status of the configuration update event. Possible values include INFO, @@ -104,7 +100,7 @@ type ConfigurationEvent struct { noSmithyDocumentSerde } -// An object that defines the log patterns that belongs to a LogPatternSet. +// An object that defines the log patterns that belongs to a LogPatternSet . type LogPattern struct { // A regular expression that defines the log pattern. A log pattern can contain as @@ -123,14 +119,14 @@ type LogPattern struct { // digits, or one of the following symbols: period, dash, underscore. PatternSetName *string - // Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns + // Rank of the log pattern. Must be a value between 1 and 1,000,000 . The patterns // are sorted by rank, so we recommend that you set your highest priority patterns // with the lowest rank. A pattern of rank 1 will be the first to get matched to a // log line. A pattern of rank 1,000,000 will be last to get matched. When you // configure custom log patterns from the console, a Low severity pattern // translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 - // rank. And a High severity pattern translates to a 250,000 rank. Rank values less - // than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. + // rank. And a High severity pattern translates to a 250,000 rank. Rank values + // less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns. Rank int32 noSmithyDocumentSerde @@ -140,7 +136,7 @@ type LogPattern struct { type Observation struct { // The detail type of the CloudWatch Event-based observation, for example, EC2 - // Instance State-change Notification. + // Instance State-change Notification . CloudWatchEventDetailType *string // The ID of the CloudWatch Event-based observation related to the detected @@ -163,23 +159,23 @@ type Observation struct { // The instance group to which the CodeDeploy instance belongs. CodeDeployInstanceGroupId *string - // The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. + // The status of the CodeDeploy deployment, for example SUCCESS or FAILURE . CodeDeployState *string // The cause of an EBS CloudWatch event. EbsCause *string - // The type of EBS CloudWatch event, such as createVolume, deleteVolume or - // attachVolume. + // The type of EBS CloudWatch event, such as createVolume , deleteVolume or + // attachVolume . EbsEvent *string // The request ID of an EBS CloudWatch event. EbsRequestId *string - // The result of an EBS CloudWatch event, such as failed or succeeded. + // The result of an EBS CloudWatch event, such as failed or succeeded . EbsResult *string - // The state of the instance, such as STOPPING or TERMINATING. + // The state of the instance, such as STOPPING or TERMINATING . Ec2State *string // The time when the observation ended, in epoch seconds. @@ -192,10 +188,10 @@ type Observation struct { // EC2. HealthEventDescription *string - // The category of the AWS Health event, such as issue. + // The category of the AWS Health event, such as issue . HealthEventTypeCategory *string - // The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE. + // The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE . HealthEventTypeCode *string // The service to which the AWS Health Event belongs, such as EC2. @@ -304,8 +300,8 @@ type Problem struct { // The last time that the problem reoccurred after its last resolution. LastRecurrenceTime *time.Time - // The number of times that the same problem reoccurred after the first time it was - // resolved. + // The number of times that the same problem reoccurred after the first time it + // was resolved. RecurringCount *int64 // The name of the resource group affected by the problem. @@ -335,30 +331,26 @@ type RelatedObservations struct { noSmithyDocumentSerde } -// An object that defines the tags associated with an application. A tag is a label -// that you optionally define and associate with an application. Tags can help you -// categorize and manage resources in different ways, such as by purpose, owner, -// environment, or other criteria. Each tag consists of a required tag key and an -// associated tag value, both of which you define. A tag key is a general label -// that acts as a category for a more specific tag value. A tag value acts as a -// descriptor within a tag key. A tag key can contain as many as 128 characters. A -// tag value can contain as many as 256 characters. The characters can be Unicode +// An object that defines the tags associated with an application. A tag is a +// label that you optionally define and associate with an application. Tags can +// help you categorize and manage resources in different ways, such as by purpose, +// owner, environment, or other criteria. Each tag consists of a required tag key +// and an associated tag value, both of which you define. A tag key is a general +// label that acts as a category for a more specific tag value. A tag value acts as +// a descriptor within a tag key. A tag key can contain as many as 128 characters. +// A tag value can contain as many as 256 characters. The characters can be Unicode // letters, digits, white space, or one of the following symbols: _ . : / = + -. // The following additional restrictions apply to tags: -// -// * Tag keys and values are -// case sensitive. -// -// * For each associated resource, each tag key must be unique and -// it can have only one value. -// -// * The aws: prefix is reserved for use by AWS; you -// can’t use it in any tag keys or values that you define. In addition, you can't -// edit or remove tag keys or values that use this prefix. +// - Tag keys and values are case sensitive. +// - For each associated resource, each tag key must be unique and it can have +// only one value. +// - The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys +// or values that you define. In addition, you can't edit or remove tag keys or +// values that use this prefix. type Tag struct { - // One part of a key-value pair that defines a tag. The maximum length of a tag key - // is 128 characters. The minimum length is 1 character. + // One part of a key-value pair that defines a tag. The maximum length of a tag + // key is 128 characters. The minimum length is 1 character. // // This member is required. Key *string diff --git a/service/appmesh/api_client.go b/service/appmesh/api_client.go index 7259c80c59d..ef6a05300c0 100644 --- a/service/appmesh/api_client.go +++ b/service/appmesh/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appmesh/api_op_CreateGatewayRoute.go b/service/appmesh/api_op_CreateGatewayRoute.go index 519a2d2eef1..e3768a87b7d 100644 --- a/service/appmesh/api_op_CreateGatewayRoute.go +++ b/service/appmesh/api_op_CreateGatewayRoute.go @@ -15,8 +15,8 @@ import ( // Creates a gateway route. A gateway route is attached to a virtual gateway and // routes traffic to an existing virtual service. If a route matches a request, it // can distribute traffic to a target virtual service. For more information about -// gateway routes, see Gateway routes -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html). +// gateway routes, see Gateway routes (https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html) +// . func (c *Client) CreateGatewayRoute(ctx context.Context, params *CreateGatewayRouteInput, optFns ...func(*Options)) (*CreateGatewayRouteOutput, error) { if params == nil { params = &CreateGatewayRouteInput{} @@ -60,11 +60,11 @@ type CreateGatewayRouteInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the gateway route to assist with diff --git a/service/appmesh/api_op_CreateMesh.go b/service/appmesh/api_op_CreateMesh.go index 00c773f48f4..2b1da686504 100644 --- a/service/appmesh/api_op_CreateMesh.go +++ b/service/appmesh/api_op_CreateMesh.go @@ -12,12 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a service mesh. A service mesh is a logical boundary for network traffic -// between services that are represented by resources within the mesh. After you -// create your service mesh, you can create virtual services, virtual nodes, -// virtual routers, and routes to distribute traffic between the applications in -// your mesh. For more information about service meshes, see Service meshes -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html). +// Creates a service mesh. A service mesh is a logical boundary for network +// traffic between services that are represented by resources within the mesh. +// After you create your service mesh, you can create virtual services, virtual +// nodes, virtual routers, and routes to distribute traffic between the +// applications in your mesh. For more information about service meshes, see +// Service meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) +// . func (c *Client) CreateMesh(ctx context.Context, params *CreateMeshInput, optFns ...func(*Options)) (*CreateMeshOutput, error) { if params == nil { params = &CreateMeshInput{} diff --git a/service/appmesh/api_op_CreateRoute.go b/service/appmesh/api_op_CreateRoute.go index 559815ff5a6..1b864627e86 100644 --- a/service/appmesh/api_op_CreateRoute.go +++ b/service/appmesh/api_op_CreateRoute.go @@ -14,8 +14,8 @@ import ( // Creates a route that is associated with a virtual router. You can route several // different protocols and define a retry policy for a route. Traffic can be routed -// to one or more virtual nodes. For more information about routes, see Routes -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html). +// to one or more virtual nodes. For more information about routes, see Routes (https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) +// . func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error) { if params == nil { params = &CreateRouteInput{} @@ -59,11 +59,11 @@ type CreateRouteInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the route to assist with categorization diff --git a/service/appmesh/api_op_CreateVirtualGateway.go b/service/appmesh/api_op_CreateVirtualGateway.go index 89cb87ea2b8..4a1c9aab743 100644 --- a/service/appmesh/api_op_CreateVirtualGateway.go +++ b/service/appmesh/api_op_CreateVirtualGateway.go @@ -18,8 +18,8 @@ import ( // service, or on an Amazon EC2 instance. Unlike a virtual node, which represents // an Envoy running with an application, a virtual gateway represents Envoy // deployed by itself. For more information about virtual gateways, see Virtual -// gateways -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html). +// gateways (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html) +// . func (c *Client) CreateVirtualGateway(ctx context.Context, params *CreateVirtualGatewayInput, optFns ...func(*Options)) (*CreateVirtualGatewayOutput, error) { if params == nil { params = &CreateVirtualGatewayInput{} @@ -56,11 +56,11 @@ type CreateVirtualGatewayInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the virtual gateway to assist with diff --git a/service/appmesh/api_op_CreateVirtualNode.go b/service/appmesh/api_op_CreateVirtualNode.go index 2ddd05f0e63..c967d6cffb7 100644 --- a/service/appmesh/api_op_CreateVirtualNode.go +++ b/service/appmesh/api_op_CreateVirtualNode.go @@ -19,22 +19,20 @@ import ( // in a task group will communicate with other proxies using Transport Layer // Security (TLS). You define a listener for any inbound traffic that your virtual // node expects. Any virtual service that your virtual node expects to communicate -// to is specified as a backend. The response metadata for your new virtual node -// contains the arn that is associated with the virtual node. Set this value to the -// full ARN; for example, -// arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the +// to is specified as a backend . The response metadata for your new virtual node +// contains the arn that is associated with the virtual node. Set this value to +// the full ARN; for example, +// arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp ) as the // APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy // container in your task definition or pod spec. This is then mapped to the -// node.id and node.cluster Envoy parameters. By default, App Mesh uses the name of -// the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to -// itself in metrics and traces. You can override this behavior by setting the +// node.id and node.cluster Envoy parameters. By default, App Mesh uses the name +// of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring +// to itself in metrics and traces. You can override this behavior by setting the // APPMESH_RESOURCE_CLUSTER environment variable with your own name. For more -// information about virtual nodes, see Virtual nodes -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html). You -// must be using 1.15.0 or later of the Envoy image when setting these variables. -// For more information aboutApp Mesh Envoy variables, see Envoy image -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html) in the App -// Mesh User Guide. +// information about virtual nodes, see Virtual nodes (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html) +// . You must be using 1.15.0 or later of the Envoy image when setting these +// variables. For more information aboutApp Mesh Envoy variables, see Envoy image (https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html) +// in the App Mesh User Guide. func (c *Client) CreateVirtualNode(ctx context.Context, params *CreateVirtualNodeInput, optFns ...func(*Options)) (*CreateVirtualNodeOutput, error) { if params == nil { params = &CreateVirtualNodeInput{} @@ -71,11 +69,11 @@ type CreateVirtualNodeInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the virtual node to assist with diff --git a/service/appmesh/api_op_CreateVirtualRouter.go b/service/appmesh/api_op_CreateVirtualRouter.go index 7312e432d7b..f2da9b6fe40 100644 --- a/service/appmesh/api_op_CreateVirtualRouter.go +++ b/service/appmesh/api_op_CreateVirtualRouter.go @@ -18,8 +18,8 @@ import ( // for one or more virtual services within your mesh. After you create your virtual // router, create and associate routes for your virtual router that direct incoming // requests to different virtual nodes. For more information about virtual routers, -// see Virtual routers -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html). +// see Virtual routers (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html) +// . func (c *Client) CreateVirtualRouter(ctx context.Context, params *CreateVirtualRouterInput, optFns ...func(*Options)) (*CreateVirtualRouterOutput, error) { if params == nil { params = &CreateVirtualRouterInput{} @@ -56,11 +56,11 @@ type CreateVirtualRouterInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the virtual router to assist with diff --git a/service/appmesh/api_op_CreateVirtualService.go b/service/appmesh/api_op_CreateVirtualService.go index c453d194a97..38a907e91ef 100644 --- a/service/appmesh/api_op_CreateVirtualService.go +++ b/service/appmesh/api_op_CreateVirtualService.go @@ -15,10 +15,10 @@ import ( // Creates a virtual service within a service mesh. A virtual service is an // abstraction of a real service that is provided by a virtual node directly or // indirectly by means of a virtual router. Dependent services call your virtual -// service by its virtualServiceName, and those requests are routed to the virtual +// service by its virtualServiceName , and those requests are routed to the virtual // node or virtual router that is specified as the provider for the virtual -// service. For more information about virtual services, see Virtual services -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html). +// service. For more information about virtual services, see Virtual services (https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html) +// . func (c *Client) CreateVirtualService(ctx context.Context, params *CreateVirtualServiceInput, optFns ...func(*Options)) (*CreateVirtualServiceOutput, error) { if params == nil { params = &CreateVirtualServiceInput{} @@ -55,11 +55,11 @@ type CreateVirtualServiceInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then the account that you specify must share the mesh with - // your account before you can create the resource in the service mesh. For more - // information about mesh sharing, see Working with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then the account that you specify must share the + // mesh with your account before you can create the resource in the service mesh. + // For more information about mesh sharing, see Working with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // Optional metadata that you can apply to the virtual service to assist with diff --git a/service/appmesh/api_op_DeleteGatewayRoute.go b/service/appmesh/api_op_DeleteGatewayRoute.go index 766309d2061..35fb410f5ce 100644 --- a/service/appmesh/api_op_DeleteGatewayRoute.go +++ b/service/appmesh/api_op_DeleteGatewayRoute.go @@ -44,10 +44,11 @@ type DeleteGatewayRouteInput struct { // This member is required. VirtualGatewayName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DeleteRoute.go b/service/appmesh/api_op_DeleteRoute.go index 492f598480e..1dedad5f71d 100644 --- a/service/appmesh/api_op_DeleteRoute.go +++ b/service/appmesh/api_op_DeleteRoute.go @@ -44,10 +44,11 @@ type DeleteRouteInput struct { // This member is required. VirtualRouterName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DeleteVirtualGateway.go b/service/appmesh/api_op_DeleteVirtualGateway.go index d9a83ca3535..b8b48d1d3c4 100644 --- a/service/appmesh/api_op_DeleteVirtualGateway.go +++ b/service/appmesh/api_op_DeleteVirtualGateway.go @@ -40,10 +40,11 @@ type DeleteVirtualGatewayInput struct { // This member is required. VirtualGatewayName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DeleteVirtualNode.go b/service/appmesh/api_op_DeleteVirtualNode.go index d1a2a572660..8f34165939a 100644 --- a/service/appmesh/api_op_DeleteVirtualNode.go +++ b/service/appmesh/api_op_DeleteVirtualNode.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing virtual node. You must delete any virtual services that list -// a virtual node as a service provider before you can delete the virtual node +// Deletes an existing virtual node. You must delete any virtual services that +// list a virtual node as a service provider before you can delete the virtual node // itself. func (c *Client) DeleteVirtualNode(ctx context.Context, params *DeleteVirtualNodeInput, optFns ...func(*Options)) (*DeleteVirtualNodeOutput, error) { if params == nil { @@ -42,10 +42,11 @@ type DeleteVirtualNodeInput struct { // This member is required. VirtualNodeName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DeleteVirtualRouter.go b/service/appmesh/api_op_DeleteVirtualRouter.go index 4ed81e95660..6d78e4ba892 100644 --- a/service/appmesh/api_op_DeleteVirtualRouter.go +++ b/service/appmesh/api_op_DeleteVirtualRouter.go @@ -40,10 +40,11 @@ type DeleteVirtualRouterInput struct { // This member is required. VirtualRouterName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DeleteVirtualService.go b/service/appmesh/api_op_DeleteVirtualService.go index 313a1e7d3e7..e2e87fdc9b3 100644 --- a/service/appmesh/api_op_DeleteVirtualService.go +++ b/service/appmesh/api_op_DeleteVirtualService.go @@ -39,10 +39,11 @@ type DeleteVirtualServiceInput struct { // This member is required. VirtualServiceName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeGatewayRoute.go b/service/appmesh/api_op_DescribeGatewayRoute.go index 2620469749e..adddffe2760 100644 --- a/service/appmesh/api_op_DescribeGatewayRoute.go +++ b/service/appmesh/api_op_DescribeGatewayRoute.go @@ -44,10 +44,11 @@ type DescribeGatewayRouteInput struct { // This member is required. VirtualGatewayName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeMesh.go b/service/appmesh/api_op_DescribeMesh.go index e96a9ab2458..252c2970523 100644 --- a/service/appmesh/api_op_DescribeMesh.go +++ b/service/appmesh/api_op_DescribeMesh.go @@ -34,10 +34,11 @@ type DescribeMeshInput struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeRoute.go b/service/appmesh/api_op_DescribeRoute.go index cb5f2f2d2a6..f0f68a62916 100644 --- a/service/appmesh/api_op_DescribeRoute.go +++ b/service/appmesh/api_op_DescribeRoute.go @@ -44,10 +44,11 @@ type DescribeRouteInput struct { // This member is required. VirtualRouterName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeVirtualGateway.go b/service/appmesh/api_op_DescribeVirtualGateway.go index 5abb8837489..a47de4b9eed 100644 --- a/service/appmesh/api_op_DescribeVirtualGateway.go +++ b/service/appmesh/api_op_DescribeVirtualGateway.go @@ -39,10 +39,11 @@ type DescribeVirtualGatewayInput struct { // This member is required. VirtualGatewayName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeVirtualNode.go b/service/appmesh/api_op_DescribeVirtualNode.go index 223e9b22da3..303a0f0d5fe 100644 --- a/service/appmesh/api_op_DescribeVirtualNode.go +++ b/service/appmesh/api_op_DescribeVirtualNode.go @@ -39,10 +39,11 @@ type DescribeVirtualNodeInput struct { // This member is required. VirtualNodeName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeVirtualRouter.go b/service/appmesh/api_op_DescribeVirtualRouter.go index 752cb7b5da6..03a050fe057 100644 --- a/service/appmesh/api_op_DescribeVirtualRouter.go +++ b/service/appmesh/api_op_DescribeVirtualRouter.go @@ -39,10 +39,11 @@ type DescribeVirtualRouterInput struct { // This member is required. VirtualRouterName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_DescribeVirtualService.go b/service/appmesh/api_op_DescribeVirtualService.go index 7cacdda990d..501ce6ee002 100644 --- a/service/appmesh/api_op_DescribeVirtualService.go +++ b/service/appmesh/api_op_DescribeVirtualService.go @@ -39,10 +39,11 @@ type DescribeVirtualServiceInput struct { // This member is required. VirtualServiceName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_ListGatewayRoutes.go b/service/appmesh/api_op_ListGatewayRoutes.go index 90f61f83917..cac964b5714 100644 --- a/service/appmesh/api_op_ListGatewayRoutes.go +++ b/service/appmesh/api_op_ListGatewayRoutes.go @@ -41,25 +41,26 @@ type ListGatewayRoutesInput struct { // This member is required. VirtualGatewayName *string - // The maximum number of results returned by ListGatewayRoutes in paginated output. - // When you use this parameter, ListGatewayRoutes returns only limit results in a - // single page along with a nextToken response element. You can see the remaining - // results of the initial request by sending another ListGatewayRoutes request with - // the returned nextToken value. This value can be between 1 and 100. If you don't - // use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken - // value if applicable. + // The maximum number of results returned by ListGatewayRoutes in paginated + // output. When you use this parameter, ListGatewayRoutes returns only limit + // results in a single page along with a nextToken response element. You can see + // the remaining results of the initial request by sending another + // ListGatewayRoutes request with the returned nextToken value. This value can be + // between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns + // up to 100 results and a nextToken value if applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string - // The nextToken value returned from a previous paginated ListGatewayRoutes request - // where limit was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. + // The nextToken value returned from a previous paginated ListGatewayRoutes + // request where limit was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. NextToken *string noSmithyDocumentSerde @@ -74,7 +75,7 @@ type ListGatewayRoutesOutput struct { GatewayRoutes []types.GatewayRouteRef // The nextToken value to include in a future ListGatewayRoutes request. When the - // results of a ListGatewayRoutes request exceed limit, you can use this value to + // results of a ListGatewayRoutes request exceed limit , you can use this value to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string @@ -158,13 +159,13 @@ var _ ListGatewayRoutesAPIClient = (*Client)(nil) // ListGatewayRoutesPaginatorOptions is the paginator options for ListGatewayRoutes type ListGatewayRoutesPaginatorOptions struct { - // The maximum number of results returned by ListGatewayRoutes in paginated output. - // When you use this parameter, ListGatewayRoutes returns only limit results in a - // single page along with a nextToken response element. You can see the remaining - // results of the initial request by sending another ListGatewayRoutes request with - // the returned nextToken value. This value can be between 1 and 100. If you don't - // use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken - // value if applicable. + // The maximum number of results returned by ListGatewayRoutes in paginated + // output. When you use this parameter, ListGatewayRoutes returns only limit + // results in a single page along with a nextToken response element. You can see + // the remaining results of the initial request by sending another + // ListGatewayRoutes request with the returned nextToken value. This value can be + // between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns + // up to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appmesh/api_op_ListMeshes.go b/service/appmesh/api_op_ListMeshes.go index 3df43cf2c74..18ad1c143cd 100644 --- a/service/appmesh/api_op_ListMeshes.go +++ b/service/appmesh/api_op_ListMeshes.go @@ -57,7 +57,7 @@ type ListMeshesOutput struct { Meshes []types.MeshRef // The nextToken value to include in a future ListMeshes request. When the results - // of a ListMeshes request exceed limit, you can use this value to retrieve the + // of a ListMeshes request exceed limit , you can use this value to retrieve the // next page of results. This value is null when there are no more results to // return. NextToken *string diff --git a/service/appmesh/api_op_ListRoutes.go b/service/appmesh/api_op_ListRoutes.go index f8797fc0e77..2713d4c8781 100644 --- a/service/appmesh/api_op_ListRoutes.go +++ b/service/appmesh/api_op_ListRoutes.go @@ -49,10 +49,11 @@ type ListRoutesInput struct { // applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // The nextToken value returned from a previous paginated ListRoutes request where @@ -72,7 +73,7 @@ type ListRoutesOutput struct { Routes []types.RouteRef // The nextToken value to include in a future ListRoutes request. When the results - // of a ListRoutes request exceed limit, you can use this value to retrieve the + // of a ListRoutes request exceed limit , you can use this value to retrieve the // next page of results. This value is null when there are no more results to // return. NextToken *string diff --git a/service/appmesh/api_op_ListTagsForResource.go b/service/appmesh/api_op_ListTagsForResource.go index f8fac30b03a..2716d2d7fad 100644 --- a/service/appmesh/api_op_ListTagsForResource.go +++ b/service/appmesh/api_op_ListTagsForResource.go @@ -40,9 +40,9 @@ type ListTagsForResourceInput struct { // output. When this parameter is used, ListTagsForResource returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListTagsForResource request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListTagsForResource returns - // up to 100 results and a nextToken value if applicable. + // ListTagsForResource request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListTagsForResource + // returns up to 100 results and a nextToken value if applicable. Limit *int32 // The nextToken value returned from a previous paginated ListTagsForResource @@ -61,10 +61,10 @@ type ListTagsForResourceOutput struct { // This member is required. Tags []types.TagRef - // The nextToken value to include in a future ListTagsForResource request. When the - // results of a ListTagsForResource request exceed limit, you can use this value to - // retrieve the next page of results. This value is null when there are no more - // results to return. + // The nextToken value to include in a future ListTagsForResource request. When + // the results of a ListTagsForResource request exceed limit , you can use this + // value to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -136,8 +136,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -151,9 +151,9 @@ type ListTagsForResourcePaginatorOptions struct { // output. When this parameter is used, ListTagsForResource returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListTagsForResource request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListTagsForResource returns - // up to 100 results and a nextToken value if applicable. + // ListTagsForResource request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListTagsForResource + // returns up to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appmesh/api_op_ListVirtualGateways.go b/service/appmesh/api_op_ListVirtualGateways.go index 30f60d4368c..b88f9137490 100644 --- a/service/appmesh/api_op_ListVirtualGateways.go +++ b/service/appmesh/api_op_ListVirtualGateways.go @@ -39,15 +39,16 @@ type ListVirtualGatewaysInput struct { // output. When you use this parameter, ListVirtualGateways returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListVirtualGateways request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListVirtualGateways returns - // up to 100 results and a nextToken value if applicable. + // ListVirtualGateways request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListVirtualGateways + // returns up to 100 results and a nextToken value if applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // The nextToken value returned from a previous paginated ListVirtualGateways @@ -66,10 +67,10 @@ type ListVirtualGatewaysOutput struct { // This member is required. VirtualGateways []types.VirtualGatewayRef - // The nextToken value to include in a future ListVirtualGateways request. When the - // results of a ListVirtualGateways request exceed limit, you can use this value to - // retrieve the next page of results. This value is null when there are no more - // results to return. + // The nextToken value to include in a future ListVirtualGateways request. When + // the results of a ListVirtualGateways request exceed limit , you can use this + // value to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -141,8 +142,8 @@ func (c *Client) addOperationListVirtualGatewaysMiddlewares(stack *middleware.St return nil } -// ListVirtualGatewaysAPIClient is a client that implements the ListVirtualGateways -// operation. +// ListVirtualGatewaysAPIClient is a client that implements the +// ListVirtualGateways operation. type ListVirtualGatewaysAPIClient interface { ListVirtualGateways(context.Context, *ListVirtualGatewaysInput, ...func(*Options)) (*ListVirtualGatewaysOutput, error) } @@ -156,9 +157,9 @@ type ListVirtualGatewaysPaginatorOptions struct { // output. When you use this parameter, ListVirtualGateways returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListVirtualGateways request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListVirtualGateways returns - // up to 100 results and a nextToken value if applicable. + // ListVirtualGateways request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListVirtualGateways + // returns up to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appmesh/api_op_ListVirtualNodes.go b/service/appmesh/api_op_ListVirtualNodes.go index 72d6c5d8b36..48cf57b7cf6 100644 --- a/service/appmesh/api_op_ListVirtualNodes.go +++ b/service/appmesh/api_op_ListVirtualNodes.go @@ -44,10 +44,11 @@ type ListVirtualNodesInput struct { // value if applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // The nextToken value returned from a previous paginated ListVirtualNodes request @@ -67,7 +68,7 @@ type ListVirtualNodesOutput struct { VirtualNodes []types.VirtualNodeRef // The nextToken value to include in a future ListVirtualNodes request. When the - // results of a ListVirtualNodes request exceed limit, you can use this value to + // results of a ListVirtualNodes request exceed limit , you can use this value to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/appmesh/api_op_ListVirtualRouters.go b/service/appmesh/api_op_ListVirtualRouters.go index 177c4cebba4..bced273f000 100644 --- a/service/appmesh/api_op_ListVirtualRouters.go +++ b/service/appmesh/api_op_ListVirtualRouters.go @@ -44,10 +44,11 @@ type ListVirtualRoutersInput struct { // up to 100 results and a nextToken value if applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // The nextToken value returned from a previous paginated ListVirtualRouters @@ -67,7 +68,7 @@ type ListVirtualRoutersOutput struct { VirtualRouters []types.VirtualRouterRef // The nextToken value to include in a future ListVirtualRouters request. When the - // results of a ListVirtualRouters request exceed limit, you can use this value to + // results of a ListVirtualRouters request exceed limit , you can use this value to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/appmesh/api_op_ListVirtualServices.go b/service/appmesh/api_op_ListVirtualServices.go index 9d01845ce67..57261c89192 100644 --- a/service/appmesh/api_op_ListVirtualServices.go +++ b/service/appmesh/api_op_ListVirtualServices.go @@ -39,15 +39,16 @@ type ListVirtualServicesInput struct { // output. When you use this parameter, ListVirtualServices returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListVirtualServices request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListVirtualServices returns - // up to 100 results and a nextToken value if applicable. + // ListVirtualServices request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListVirtualServices + // returns up to 100 results and a nextToken value if applicable. Limit *int32 - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string // The nextToken value returned from a previous paginated ListVirtualServices @@ -66,10 +67,10 @@ type ListVirtualServicesOutput struct { // This member is required. VirtualServices []types.VirtualServiceRef - // The nextToken value to include in a future ListVirtualServices request. When the - // results of a ListVirtualServices request exceed limit, you can use this value to - // retrieve the next page of results. This value is null when there are no more - // results to return. + // The nextToken value to include in a future ListVirtualServices request. When + // the results of a ListVirtualServices request exceed limit , you can use this + // value to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -141,8 +142,8 @@ func (c *Client) addOperationListVirtualServicesMiddlewares(stack *middleware.St return nil } -// ListVirtualServicesAPIClient is a client that implements the ListVirtualServices -// operation. +// ListVirtualServicesAPIClient is a client that implements the +// ListVirtualServices operation. type ListVirtualServicesAPIClient interface { ListVirtualServices(context.Context, *ListVirtualServicesInput, ...func(*Options)) (*ListVirtualServicesOutput, error) } @@ -156,9 +157,9 @@ type ListVirtualServicesPaginatorOptions struct { // output. When you use this parameter, ListVirtualServices returns only limit // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another - // ListVirtualServices request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListVirtualServices returns - // up to 100 results and a nextToken value if applicable. + // ListVirtualServices request with the returned nextToken value. This value can + // be between 1 and 100. If you don't use this parameter, ListVirtualServices + // returns up to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appmesh/api_op_TagResource.go b/service/appmesh/api_op_TagResource.go index 063d432cf7d..018ce33b444 100644 --- a/service/appmesh/api_op_TagResource.go +++ b/service/appmesh/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource aren't specified in the request parameters, they // aren't changed. When a resource is deleted, the tags associated with that // resource are also deleted. diff --git a/service/appmesh/api_op_UpdateGatewayRoute.go b/service/appmesh/api_op_UpdateGatewayRoute.go index 7f5f0bc8b61..fc63864d932 100644 --- a/service/appmesh/api_op_UpdateGatewayRoute.go +++ b/service/appmesh/api_op_UpdateGatewayRoute.go @@ -55,10 +55,11 @@ type UpdateGatewayRouteInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_UpdateRoute.go b/service/appmesh/api_op_UpdateRoute.go index 9b3c7c7463f..c49df8e22b6 100644 --- a/service/appmesh/api_op_UpdateRoute.go +++ b/service/appmesh/api_op_UpdateRoute.go @@ -54,10 +54,11 @@ type UpdateRouteInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_UpdateVirtualGateway.go b/service/appmesh/api_op_UpdateVirtualGateway.go index 9caf890a42a..f7880f5e2dd 100644 --- a/service/appmesh/api_op_UpdateVirtualGateway.go +++ b/service/appmesh/api_op_UpdateVirtualGateway.go @@ -50,10 +50,11 @@ type UpdateVirtualGatewayInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_UpdateVirtualNode.go b/service/appmesh/api_op_UpdateVirtualNode.go index bb72bfbc4b0..1e2ccf8288a 100644 --- a/service/appmesh/api_op_UpdateVirtualNode.go +++ b/service/appmesh/api_op_UpdateVirtualNode.go @@ -49,10 +49,11 @@ type UpdateVirtualNodeInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_UpdateVirtualRouter.go b/service/appmesh/api_op_UpdateVirtualRouter.go index 10fd99f34a1..754610b05f6 100644 --- a/service/appmesh/api_op_UpdateVirtualRouter.go +++ b/service/appmesh/api_op_UpdateVirtualRouter.go @@ -50,10 +50,11 @@ type UpdateVirtualRouterInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/api_op_UpdateVirtualService.go b/service/appmesh/api_op_UpdateVirtualService.go index 1f63f9fdbb8..1be090d27b6 100644 --- a/service/appmesh/api_op_UpdateVirtualService.go +++ b/service/appmesh/api_op_UpdateVirtualService.go @@ -50,10 +50,11 @@ type UpdateVirtualServiceInput struct { // the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. ClientToken *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . MeshOwner *string noSmithyDocumentSerde diff --git a/service/appmesh/doc.go b/service/appmesh/doc.go index ae356996e18..2917689c601 100644 --- a/service/appmesh/doc.go +++ b/service/appmesh/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package appmesh provides the API client, operations, and parameter types for AWS -// App Mesh. +// Package appmesh provides the API client, operations, and parameter types for +// AWS App Mesh. // // App Mesh is a service mesh based on the Envoy proxy that makes it easy to // monitor and control microservices. App Mesh standardizes how your microservices @@ -11,10 +11,8 @@ // App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on // Amazon Web Services, and Amazon EC2. App Mesh supports microservice applications // that use service discovery naming for their components. For more information -// about service discovery on Amazon ECS, see Service Discovery -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) -// in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and -// coredns are supported. For more information, see DNS for Services and Pods -// (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) in -// the Kubernetes documentation. +// about service discovery on Amazon ECS, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) +// in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns +// and coredns are supported. For more information, see DNS for Services and Pods (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/) +// in the Kubernetes documentation. package appmesh diff --git a/service/appmesh/types/enums.go b/service/appmesh/types/enums.go index ec7feb94e93..b94f71072c0 100644 --- a/service/appmesh/types/enums.go +++ b/service/appmesh/types/enums.go @@ -46,9 +46,9 @@ const ( DurationUnitMs DurationUnit = "ms" ) -// Values returns all known values for DurationUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DurationUnit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DurationUnit) Values() []DurationUnit { return []DurationUnit{ "s", @@ -178,9 +178,9 @@ const ( IpPreferenceIPv6Only IpPreference = "IPv6_ONLY" ) -// Values returns all known values for IpPreference. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IpPreference. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IpPreference) Values() []IpPreference { return []IpPreference{ "IPv6_PREFERRED", @@ -240,9 +240,9 @@ const ( PortProtocolGrpc PortProtocol = "grpc" ) -// Values returns all known values for PortProtocol. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PortProtocol. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PortProtocol) Values() []PortProtocol { return []PortProtocol{ "http", @@ -338,9 +338,9 @@ const ( VirtualGatewayStatusCodeDeleted VirtualGatewayStatusCode = "DELETED" ) -// Values returns all known values for VirtualGatewayStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VirtualGatewayStatusCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualGatewayStatusCode) Values() []VirtualGatewayStatusCode { return []VirtualGatewayStatusCode{ "ACTIVE", @@ -358,8 +358,8 @@ const ( VirtualNodeStatusCodeDeleted VirtualNodeStatusCode = "DELETED" ) -// Values returns all known values for VirtualNodeStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VirtualNodeStatusCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VirtualNodeStatusCode) Values() []VirtualNodeStatusCode { return []VirtualNodeStatusCode{ @@ -398,9 +398,9 @@ const ( VirtualServiceStatusCodeDeleted VirtualServiceStatusCode = "DELETED" ) -// Values returns all known values for VirtualServiceStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VirtualServiceStatusCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualServiceStatusCode) Values() []VirtualServiceStatusCode { return []VirtualServiceStatusCode{ "ACTIVE", diff --git a/service/appmesh/types/errors.go b/service/appmesh/types/errors.go index 506ed1ca219..865ce200197 100644 --- a/service/appmesh/types/errors.go +++ b/service/appmesh/types/errors.go @@ -33,9 +33,9 @@ func (e *BadRequestException) ErrorCode() string { } func (e *BadRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request contains a client token that was used for a previous update resource -// call with different specifications. Try the request again with a new client -// token. +// The request contains a client token that was used for a previous update +// resource call with different specifications. Try the request again with a new +// client token. type ConflictException struct { Message *string @@ -115,9 +115,8 @@ func (e *InternalServerErrorException) ErrorCode() string { func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // You have exceeded a service limit for your account. For more information, see -// Service Limits -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html) in -// the App Mesh User Guide. +// Service Limits (https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html) +// in the App Mesh User Guide. type LimitExceededException struct { Message *string @@ -250,9 +249,9 @@ func (e *TooManyRequestsException) ErrorCode() string { } func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request exceeds the maximum allowed number of tags allowed per resource. The -// current limit is 50 user tags per resource. You must reduce the number of tags -// in the request. None of the tags in this request were applied. +// The request exceeds the maximum allowed number of tags allowed per resource. +// The current limit is 50 user tags per resource. You must reduce the number of +// tags in the request. None of the tags in this request were applied. type TooManyTagsException struct { Message *string diff --git a/service/appmesh/types/types.go b/service/appmesh/types/types.go index 8d837b1fe5e..449d7f9a061 100644 --- a/service/appmesh/types/types.go +++ b/service/appmesh/types/types.go @@ -103,15 +103,15 @@ type BackendDefaults struct { // An object that represents a client policy. type ClientPolicy struct { - // A reference to an object that represents a Transport Layer Security (TLS) client - // policy. + // A reference to an object that represents a Transport Layer Security (TLS) + // client policy. Tls *ClientPolicyTls noSmithyDocumentSerde } -// A reference to an object that represents a Transport Layer Security (TLS) client -// policy. +// A reference to an object that represents a Transport Layer Security (TLS) +// client policy. type ClientPolicyTls struct { // A reference to an object that represents a TLS validation context. @@ -122,7 +122,7 @@ type ClientPolicyTls struct { // A reference to an object that represents a client's TLS certificate. Certificate ClientTlsCertificate - // Whether the policy is enforced. The default is True, if a value isn't specified. + // Whether the policy is enforced. The default is True , if a value isn't specified. Enforce *bool // One or more ports that the policy is enforced for. @@ -143,8 +143,8 @@ type ClientTlsCertificate interface { // An object that represents a local file certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more -// information, see Transport Layer Security (TLS) -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html). +// information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// . type ClientTlsCertificateMemberFile struct { Value ListenerTlsFileCertificate @@ -153,8 +153,8 @@ type ClientTlsCertificateMemberFile struct { func (*ClientTlsCertificateMemberFile) isClientTlsCertificate() {} -// A reference to an object that represents a client's TLS Secret Discovery Service -// certificate. +// A reference to an object that represents a client's TLS Secret Discovery +// Service certificate. type ClientTlsCertificateMemberSds struct { Value ListenerTlsSdsCertificate @@ -163,8 +163,8 @@ type ClientTlsCertificateMemberSds struct { func (*ClientTlsCertificateMemberSds) isClientTlsCertificate() {} -// An object that represents the DNS service discovery information for your virtual -// node. +// An object that represents the DNS service discovery information for your +// virtual node. type DnsServiceDiscovery struct { // Specifies the DNS service discovery hostname for the virtual node. @@ -198,7 +198,7 @@ type Duration struct { // An object that represents the egress filter rules for a service mesh. type EgressFilter struct { - // The egress filter type. By default, the type is DROP_ALL, which allows egress + // The egress filter type. By default, the type is DROP_ALL , which allows egress // only from virtual nodes to other defined resources in the service mesh (and any // traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the // egress filter type to ALLOW_ALL to allow egress to any endpoint inside or @@ -215,7 +215,7 @@ type FileAccessLog struct { // The file path to write access logs to. You can use /dev/stdout to send access // logs to standard out and configure your Envoy container to use a log driver, - // such as awslogs, to export the access logs to a log storage service such as + // such as awslogs , to export the access logs to a log storage service such as // Amazon CloudWatch Logs. You can also specify a path in the Envoy container's // file system to write the files to disk. The Envoy process must have write // permissions to the path that you specify here. Otherwise, Envoy fails to @@ -225,7 +225,7 @@ type FileAccessLog struct { Path *string // The specified format for the logs. The format is either json_format or - // text_format. + // text_format . Format LoggingFormat noSmithyDocumentSerde @@ -316,10 +316,11 @@ type GatewayRouteRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -327,8 +328,8 @@ type GatewayRouteRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -460,7 +461,7 @@ type GrpcGatewayRouteMetadata struct { Name *string // Specify True to match anything except the match criteria. The default value is - // False. + // False . Invert *bool // The criteria for determining a metadata match. @@ -539,11 +540,11 @@ type GrpcMetadataMatchMethodMemberSuffix struct { func (*GrpcMetadataMatchMethodMemberSuffix) isGrpcMetadataMatchMethod() {} // An object that represents a retry policy. Specify at least one value for at -// least one of the types of RetryEvents, a value for maxRetries, and a value for -// perRetryTimeout. Both server-error and gateway-error under httpRetryEvents +// least one of the types of RetryEvents , a value for maxRetries , and a value for +// perRetryTimeout . Both server-error and gateway-error under httpRetryEvents // include the Envoy reset policy. For more information on the reset policy, see -// the Envoy documentation -// (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on). +// the Envoy documentation (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on) +// . type GrpcRetryPolicy struct { // The maximum number of retry attempts. @@ -560,17 +561,11 @@ type GrpcRetryPolicy struct { GrpcRetryEvents []GrpcRetryPolicyEvent // Specify at least one of the following values. - // - // * server-error – HTTP status - // codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 - // - // * gateway-error - // – HTTP status codes 502, 503, and 504 - // - // * client-error – HTTP status code 409 - // - // * - // stream-error – Retry on refused stream + // - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, + // 508, 510, and 511 + // - gateway-error – HTTP status codes 502, 503, and 504 + // - client-error – HTTP status code 409 + // - stream-error – Retry on refused stream HttpRetryEvents []string // Specify a valid value. The event occurs before any processing of a request has @@ -622,7 +617,7 @@ type GrpcRouteMatch struct { Metadata []GrpcRouteMetadata // The method name to match from the request. If you specify a name, you must also - // specify a serviceName. + // specify a serviceName . MethodName *string // The port number to match on. @@ -643,7 +638,7 @@ type GrpcRouteMetadata struct { Name *string // Specify True to match anything except the match criteria. The default value is - // False. + // False . Invert *bool // An object that represents the data to match from the request. @@ -801,9 +796,9 @@ type HealthCheckPolicy struct { // This member is required. IntervalMillis *int64 - // The protocol for the health check request. If you specify grpc, then your - // service must conform to the GRPC Health Checking Protocol - // (https://github.com/grpc/grpc/blob/master/doc/health-checking.md). + // The protocol for the health check request. If you specify grpc , then your + // service must conform to the GRPC Health Checking Protocol (https://github.com/grpc/grpc/blob/master/doc/health-checking.md) + // . // // This member is required. Protocol PortProtocol @@ -825,8 +820,8 @@ type HealthCheckPolicy struct { // ignored. Path *string - // The destination port for the health check request. This port must match the port - // defined in the PortMapping for the listener. + // The destination port for the health check request. This port must match the + // port defined in the PortMapping for the listener. Port int32 noSmithyDocumentSerde @@ -872,7 +867,7 @@ type HttpGatewayRouteHeader struct { Name *string // Specify True to match anything except the match criteria. The default value is - // False. + // False . Invert *bool // An object that represents the method and value to match with the header value @@ -900,11 +895,11 @@ type HttpGatewayRouteMatch struct { // The port number to match on. Port *int32 - // Specifies the path to match requests with. This parameter must always start with - // /, which by itself matches all requests to the virtual service name. You can - // also match for path-based routing of requests. For example, if your virtual + // Specifies the path to match requests with. This parameter must always start + // with / , which by itself matches all requests to the virtual service name. You + // can also match for path-based routing of requests. For example, if your virtual // service name is my-service.local and you want the route to match requests to - // my-service.local/metrics, your prefix should be /metrics. + // my-service.local/metrics , your prefix should be /metrics . Prefix *string // The query parameter to match on. @@ -976,11 +971,11 @@ type HttpQueryParameter struct { } // An object that represents a retry policy. Specify at least one value for at -// least one of the types of RetryEvents, a value for maxRetries, and a value for -// perRetryTimeout. Both server-error and gateway-error under httpRetryEvents +// least one of the types of RetryEvents , a value for maxRetries , and a value for +// perRetryTimeout . Both server-error and gateway-error under httpRetryEvents // include the Envoy reset policy. For more information on the reset policy, see -// the Envoy documentation -// (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on). +// the Envoy documentation (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on) +// . type HttpRetryPolicy struct { // The maximum number of retry attempts. @@ -994,17 +989,11 @@ type HttpRetryPolicy struct { PerRetryTimeout *Duration // Specify at least one of the following values. - // - // * server-error – HTTP status - // codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511 - // - // * gateway-error - // – HTTP status codes 502, 503, and 504 - // - // * client-error – HTTP status code 409 - // - // * - // stream-error – Retry on refused stream + // - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, + // 508, 510, and 511 + // - gateway-error – HTTP status codes 502, 503, and 504 + // - client-error – HTTP status code 409 + // - stream-error – Retry on refused stream HttpRetryEvents []string // Specify a valid value. The event occurs before any processing of a request has @@ -1058,7 +1047,7 @@ type HttpRouteHeader struct { Name *string // Specify True to match anything except the match criteria. The default value is - // False. + // False . Invert *bool // The HeaderMatchMethod object. @@ -1083,11 +1072,11 @@ type HttpRouteMatch struct { // The port number to match on. Port *int32 - // Specifies the path to match requests with. This parameter must always start with - // /, which by itself matches all requests to the virtual service name. You can - // also match for path-based routing of requests. For example, if your virtual + // Specifies the path to match requests with. This parameter must always start + // with / , which by itself matches all requests to the virtual service name. You + // can also match for path-based routing of requests. For example, if your virtual // service name is my-service.local and you want the route to match requests to - // my-service.local/metrics, your prefix should be /metrics. + // my-service.local/metrics , your prefix should be /metrics . Prefix *string // The client request query parameters to match on. @@ -1220,15 +1209,9 @@ type ListenerTls struct { Certificate ListenerTlsCertificate // Specify one of the following modes. - // - // * STRICT – Listener only accepts - // connections with TLS enabled. - // - // * PERMISSIVE – Listener accepts connections with - // or without TLS enabled. - // - // * DISABLED – Listener only accepts connections without - // TLS. + // - STRICT – Listener only accepts connections with TLS enabled. + // - PERMISSIVE – Listener accepts connections with or without TLS enabled. + // - DISABLED – Listener only accepts connections without TLS. // // This member is required. Mode ListenerTlsMode @@ -1245,8 +1228,8 @@ type ListenerTlsAcmCertificate struct { // The Amazon Resource Name (ARN) for the certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more - // information, see Transport Layer Security (TLS) - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites). + // information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites) + // . // // This member is required. CertificateArn *string @@ -1296,8 +1279,8 @@ func (*ListenerTlsCertificateMemberSds) isListenerTlsCertificate() {} // An object that represents a local file certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more -// information, see Transport Layer Security (TLS) -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites). +// information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites) +// . type ListenerTlsFileCertificate struct { // The certificate chain for the certificate. @@ -1316,8 +1299,8 @@ type ListenerTlsFileCertificate struct { // An object that represents the listener's Secret Discovery Service certificate. // The proxy must be configured with a local SDS provider via a Unix Domain Socket. -// See App Mesh TLS documentation -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info. +// See App Mesh TLS documentation (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// for more info. type ListenerTlsSdsCertificate struct { // A reference to an object that represents the name of the secret requested from @@ -1330,8 +1313,8 @@ type ListenerTlsSdsCertificate struct { noSmithyDocumentSerde } -// An object that represents a listener's Transport Layer Security (TLS) validation -// context. +// An object that represents a listener's Transport Layer Security (TLS) +// validation context. type ListenerTlsValidationContext struct { // A reference to where to retrieve the trust chain when validating a peer’s @@ -1347,8 +1330,8 @@ type ListenerTlsValidationContext struct { noSmithyDocumentSerde } -// An object that represents a listener's Transport Layer Security (TLS) validation -// context trust. +// An object that represents a listener's Transport Layer Security (TLS) +// validation context trust. // // The following types satisfy this interface: // @@ -1480,10 +1463,11 @@ type MeshRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -1491,8 +1475,8 @@ type MeshRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -1549,8 +1533,8 @@ type OutlierDetection struct { // This member is required. Interval *Duration - // Maximum percentage of hosts in load balancing pool for upstream service that can - // be ejected. Will eject at least one host regardless of the value. + // Maximum percentage of hosts in load balancing pool for upstream service that + // can be ejected. Will eject at least one host regardless of the value. // // This member is required. MaxEjectionPercent *int32 @@ -1606,10 +1590,11 @@ type ResourceMetadata struct { // This member is required. LastUpdatedAt *time.Time - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -1617,8 +1602,8 @@ type ResourceMetadata struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -1696,10 +1681,11 @@ type RouteRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -1707,8 +1693,8 @@ type RouteRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -1817,10 +1803,10 @@ type SubjectAlternativeNames struct { noSmithyDocumentSerde } -// Optional metadata that you apply to a resource to assist with categorization and -// organization. Each tag consists of a key and an optional value, both of which -// you define. Tag keys can have a maximum character length of 128 characters, and -// tag values can have a maximum length of 256 characters. +// Optional metadata that you apply to a resource to assist with categorization +// and organization. Each tag consists of a key and an optional value, both of +// which you define. Tag keys can have a maximum character length of 128 +// characters, and tag values can have a maximum length of 256 characters. type TagRef struct { // One part of a key-value pair that make up a tag. A key is a general label that @@ -1896,14 +1882,14 @@ type TlsValidationContext struct { // This member is required. Trust TlsValidationContextTrust - // A reference to an object that represents the SANs for a Transport Layer Security - // (TLS) validation context. If you don't specify SANs on the terminating mesh - // endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client - // certificate. If you don't specify SANs on the originating mesh endpoint, the SAN - // on the certificate provided by the terminating endpoint must match the mesh - // endpoint service discovery configuration. Since SPIRE vended certificates have a - // SPIFFE ID as a name, you must set the SAN since the name doesn't match the - // service discovery name. + // A reference to an object that represents the SANs for a Transport Layer + // Security (TLS) validation context. If you don't specify SANs on the terminating + // mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer + // client certificate. If you don't specify SANs on the originating mesh endpoint, + // the SAN on the certificate provided by the terminating endpoint must match the + // mesh endpoint service discovery configuration. Since SPIRE vended certificates + // have a SPIFFE ID as a name, you must set the SAN since the name doesn't match + // the service discovery name. SubjectAlternativeNames *SubjectAlternativeNames noSmithyDocumentSerde @@ -1936,8 +1922,8 @@ type TlsValidationContextFileTrust struct { // An object that represents a Transport Layer Security (TLS) Secret Discovery // Service validation context trust. The proxy must be configured with a local SDS -// provider via a Unix Domain Socket. See App Mesh TLS documentation -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info. +// provider via a Unix Domain Socket. See App Mesh TLS documentation (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// for more info. type TlsValidationContextSdsTrust struct { // A reference to an object that represents the name of the secret for a Transport @@ -1981,8 +1967,8 @@ type TlsValidationContextTrustMemberFile struct { func (*TlsValidationContextTrustMemberFile) isTlsValidationContextTrust() {} -// A reference to an object that represents a Transport Layer Security (TLS) Secret -// Discovery Service validation context trust. +// A reference to an object that represents a Transport Layer Security (TLS) +// Secret Discovery Service validation context trust. type TlsValidationContextTrustMemberSds struct { Value TlsValidationContextSdsTrust @@ -2021,8 +2007,8 @@ type VirtualGatewayBackendDefaults struct { // An object that represents a client policy. type VirtualGatewayClientPolicy struct { - // A reference to an object that represents a Transport Layer Security (TLS) client - // policy. + // A reference to an object that represents a Transport Layer Security (TLS) + // client policy. Tls *VirtualGatewayClientPolicyTls noSmithyDocumentSerde @@ -2041,7 +2027,7 @@ type VirtualGatewayClientPolicyTls struct { // Layer Security (TLS) certificate. Certificate VirtualGatewayClientTlsCertificate - // Whether the policy is enforced. The default is True, if a value isn't specified. + // Whether the policy is enforced. The default is True , if a value isn't specified. Enforce *bool // One or more ports that the policy is enforced for. @@ -2063,8 +2049,8 @@ type VirtualGatewayClientTlsCertificate interface { // An object that represents a local file certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more -// information, see Transport Layer Security (TLS) -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html). +// information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// . type VirtualGatewayClientTlsCertificateMemberFile struct { Value VirtualGatewayListenerTlsFileCertificate @@ -2086,7 +2072,7 @@ func (*VirtualGatewayClientTlsCertificateMemberSds) isVirtualGatewayClientTlsCer // An object that represents the type of virtual gateway connection pool. Only one // protocol is used at a time and should be the same protocol as the one chosen // under port mapping. If not present the default value for maxPendingRequests is -// 2147483647. +// 2147483647 . // // The following types satisfy this interface: // @@ -2160,7 +2146,7 @@ type VirtualGatewayFileAccessLog struct { // The file path to write access logs to. You can use /dev/stdout to send access // logs to standard out and configure your Envoy container to use a log driver, - // such as awslogs, to export the access logs to a log storage service such as + // such as awslogs , to export the access logs to a log storage service such as // Amazon CloudWatch Logs. You can also specify a path in the Envoy container's // file system to write the files to disk. // @@ -2168,7 +2154,7 @@ type VirtualGatewayFileAccessLog struct { Path *string // The specified format for the virtual gateway access logs. It can be either - // json_format or text_format. + // json_format or text_format . Format LoggingFormat noSmithyDocumentSerde @@ -2201,9 +2187,9 @@ type VirtualGatewayHealthCheckPolicy struct { // This member is required. IntervalMillis *int64 - // The protocol for the health check request. If you specify grpc, then your - // service must conform to the GRPC Health Checking Protocol - // (https://github.com/grpc/grpc/blob/master/doc/health-checking.md). + // The protocol for the health check request. If you specify grpc , then your + // service must conform to the GRPC Health Checking Protocol (https://github.com/grpc/grpc/blob/master/doc/health-checking.md) + // . // // This member is required. Protocol VirtualGatewayPortProtocol @@ -2225,8 +2211,8 @@ type VirtualGatewayHealthCheckPolicy struct { // ignored. Path *string - // The destination port for the health check request. This port must match the port - // defined in the PortMapping for the listener. + // The destination port for the health check request. This port must match the + // port defined in the PortMapping for the listener. Port int32 noSmithyDocumentSerde @@ -2247,8 +2233,8 @@ type VirtualGatewayHttp2ConnectionPool struct { // An object that represents a type of connection pool. type VirtualGatewayHttpConnectionPool struct { - // Maximum number of outbound TCP connections Envoy can establish concurrently with - // all hosts in upstream cluster. + // Maximum number of outbound TCP connections Envoy can establish concurrently + // with all hosts in upstream cluster. // // This member is required. MaxConnections int32 @@ -2291,15 +2277,9 @@ type VirtualGatewayListenerTls struct { Certificate VirtualGatewayListenerTlsCertificate // Specify one of the following modes. - // - // * STRICT – Listener only accepts - // connections with TLS enabled. - // - // * PERMISSIVE – Listener accepts connections with - // or without TLS enabled. - // - // * DISABLED – Listener only accepts connections without - // TLS. + // - STRICT – Listener only accepts connections with TLS enabled. + // - PERMISSIVE – Listener accepts connections with or without TLS enabled. + // - DISABLED – Listener only accepts connections without TLS. // // This member is required. Mode VirtualGatewayListenerTlsMode @@ -2316,8 +2296,8 @@ type VirtualGatewayListenerTlsAcmCertificate struct { // The Amazon Resource Name (ARN) for the certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more - // information, see Transport Layer Security (TLS) - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites). + // information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites) + // . // // This member is required. CertificateArn *string @@ -2367,8 +2347,8 @@ func (*VirtualGatewayListenerTlsCertificateMemberSds) isVirtualGatewayListenerTl // An object that represents a local file certificate. The certificate must meet // specific requirements and you must have proxy authorization enabled. For more -// information, see Transport Layer Security (TLS) -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites). +// information, see Transport Layer Security (TLS) (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites) +// . type VirtualGatewayListenerTlsFileCertificate struct { // The certificate chain for the certificate. @@ -2376,8 +2356,8 @@ type VirtualGatewayListenerTlsFileCertificate struct { // This member is required. CertificateChain *string - // The private key for a certificate stored on the file system of the mesh endpoint - // that the proxy is running on. + // The private key for a certificate stored on the file system of the mesh + // endpoint that the proxy is running on. // // This member is required. PrivateKey *string @@ -2387,13 +2367,13 @@ type VirtualGatewayListenerTlsFileCertificate struct { // An object that represents the virtual gateway's listener's Secret Discovery // Service certificate.The proxy must be configured with a local SDS provider via a -// Unix Domain Socket. See App MeshTLS documentation -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info. +// Unix Domain Socket. See App Mesh TLS documentation (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// for more info. type VirtualGatewayListenerTlsSdsCertificate struct { - // A reference to an object that represents the name of the secret secret requested - // from the Secret Discovery Service provider representing Transport Layer Security - // (TLS) materials like a certificate or certificate chain. + // A reference to an object that represents the name of the secret secret + // requested from the Secret Discovery Service provider representing Transport + // Layer Security (TLS) materials like a certificate or certificate chain. // // This member is required. SecretName *string @@ -2500,10 +2480,11 @@ type VirtualGatewayRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -2511,8 +2492,8 @@ type VirtualGatewayRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -2604,8 +2585,8 @@ type VirtualGatewayTlsValidationContextFileTrust struct { // An object that represents a virtual gateway's listener's Transport Layer // Security (TLS) Secret Discovery Service validation context trust. The proxy must // be configured with a local SDS provider via a Unix Domain Socket. See App Mesh -// TLS documentation -// (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) for more info. +// TLS documentation (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) +// for more info. type VirtualGatewayTlsValidationContextSdsTrust struct { // A reference to an object that represents the name of the secret for a virtual @@ -2666,7 +2647,7 @@ func (*VirtualGatewayTlsValidationContextTrustMemberSds) isVirtualGatewayTlsVali // An object that represents the type of virtual node connection pool. Only one // protocol is used at a time and should be the same protocol as the one chosen // under port mapping. If not present the default value for maxPendingRequests is -// 2147483647. +// 2147483647 . // // The following types satisfy this interface: // @@ -2772,8 +2753,8 @@ type VirtualNodeHttp2ConnectionPool struct { // An object that represents a type of connection pool. type VirtualNodeHttpConnectionPool struct { - // Maximum number of outbound TCP connections Envoy can establish concurrently with - // all hosts in upstream cluster. + // Maximum number of outbound TCP connections Envoy can establish concurrently + // with all hosts in upstream cluster. // // This member is required. MaxConnections int32 @@ -2808,10 +2789,11 @@ type VirtualNodeRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -2819,8 +2801,8 @@ type VirtualNodeRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -2868,7 +2850,7 @@ type VirtualNodeSpec struct { // The service discovery information for the virtual node. If your virtual node // does not expect ingress traffic, you can omit this parameter. If you specify a - // listener, then you must specify service discovery information. + // listener , then you must specify service discovery information. ServiceDiscovery ServiceDiscovery noSmithyDocumentSerde @@ -2888,8 +2870,8 @@ type VirtualNodeStatus struct { // An object that represents a type of connection pool. type VirtualNodeTcpConnectionPool struct { - // Maximum number of outbound TCP connections Envoy can establish concurrently with - // all hosts in upstream cluster. + // Maximum number of outbound TCP connections Envoy can establish concurrently + // with all hosts in upstream cluster. // // This member is required. MaxConnections int32 @@ -2962,10 +2944,11 @@ type VirtualRouterRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -2973,8 +2956,8 @@ type VirtualRouterRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string @@ -3121,10 +3104,11 @@ type VirtualServiceRef struct { // This member is required. MeshName *string - // The Amazon Web Services IAM account ID of the service mesh owner. If the account - // ID is not your own, then it's the ID of the account that shared the mesh with - // your account. For more information about mesh sharing, see Working with shared - // meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // The Amazon Web Services IAM account ID of the service mesh owner. If the + // account ID is not your own, then it's the ID of the account that shared the mesh + // with your account. For more information about mesh sharing, see Working with + // shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. MeshOwner *string @@ -3132,8 +3116,8 @@ type VirtualServiceRef struct { // The Amazon Web Services IAM account ID of the resource owner. If the account ID // is not your own, then it's the ID of the mesh owner or of another account that // the mesh is shared with. For more information about mesh sharing, see Working - // with shared meshes - // (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). + // with shared meshes (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) + // . // // This member is required. ResourceOwner *string diff --git a/service/apprunner/api_client.go b/service/apprunner/api_client.go index 8fdfd5491bb..14b16591cac 100644 --- a/service/apprunner/api_client.go +++ b/service/apprunner/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/apprunner/api_op_AssociateCustomDomain.go b/service/apprunner/api_op_AssociateCustomDomain.go index e5af9d0622e..63764378482 100644 --- a/service/apprunner/api_op_AssociateCustomDomain.go +++ b/service/apprunner/api_op_AssociateCustomDomain.go @@ -18,8 +18,8 @@ import ( // a mapping to the target App Runner subdomain and one or more certificate // validation records. App Runner then performs DNS validation to verify that you // own or control the domain name that you associated. App Runner tracks domain -// validity in a certificate stored in AWS Certificate Manager (ACM) -// (https://docs.aws.amazon.com/acm/latest/userguide). +// validity in a certificate stored in AWS Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide) +// . func (c *Client) AssociateCustomDomain(ctx context.Context, params *AssociateCustomDomainInput, optFns ...func(*Options)) (*AssociateCustomDomainOutput, error) { if params == nil { params = &AssociateCustomDomainInput{} @@ -38,8 +38,8 @@ func (c *Client) AssociateCustomDomain(ctx context.Context, params *AssociateCus type AssociateCustomDomainInput struct { // A custom domain endpoint to associate. Specify a root domain (for example, - // example.com), a subdomain (for example, login.example.com or - // admin.login.example.com), or a wildcard (for example, *.example.com). + // example.com ), a subdomain (for example, login.example.com or + // admin.login.example.com ), or a wildcard (for example, *.example.com ). // // This member is required. DomainName *string diff --git a/service/apprunner/api_op_CreateAutoScalingConfiguration.go b/service/apprunner/api_op_CreateAutoScalingConfiguration.go index bb207a11e3d..1ce59974db1 100644 --- a/service/apprunner/api_op_CreateAutoScalingConfiguration.go +++ b/service/apprunner/api_op_CreateAutoScalingConfiguration.go @@ -16,7 +16,7 @@ import ( // require non-default auto scaling settings. You can share an auto scaling // configuration across multiple services. Create multiple revisions of a // configuration by calling this action multiple times using the same -// AutoScalingConfigurationName. The call returns incremental +// AutoScalingConfigurationName . The call returns incremental // AutoScalingConfigurationRevision values. When you create a service and configure // an auto scaling configuration resource, the service uses the latest active // revision of the auto scaling configuration by default. You can optionally @@ -42,8 +42,8 @@ func (c *Client) CreateAutoScalingConfiguration(ctx context.Context, params *Cre type CreateAutoScalingConfigurationInput struct { - // A name for the auto scaling configuration. When you use it for the first time in - // an Amazon Web Services Region, App Runner creates revision number 1 of this + // A name for the auto scaling configuration. When you use it for the first time + // in an Amazon Web Services Region, App Runner creates revision number 1 of this // name. When you use the same name in subsequent calls, App Runner creates // incremental revisions of the configuration. The name DefaultConfiguration is // reserved (it's the configuration that App Runner uses if you don't provide a @@ -64,14 +64,14 @@ type CreateAutoScalingConfigurationInput struct { // instances actively serve traffic for your service. Default: 25 MaxSize *int32 - // The minimum number of instances that App Runner provisions for your service. The - // service always has at least MinSize provisioned instances. Some of them actively - // serve traffic. The rest of them (provisioned and inactive instances) are a - // cost-effective compute capacity reserve and are ready to be quickly activated. - // You pay for memory usage of all the provisioned instances. You pay for CPU usage - // of only the active subset. App Runner temporarily doubles the number of - // provisioned instances during deployments, to maintain the same capacity for both - // old and new code. Default: 1 + // The minimum number of instances that App Runner provisions for your service. + // The service always has at least MinSize provisioned instances. Some of them + // actively serve traffic. The rest of them (provisioned and inactive instances) + // are a cost-effective compute capacity reserve and are ready to be quickly + // activated. You pay for memory usage of all the provisioned instances. You pay + // for CPU usage of only the active subset. App Runner temporarily doubles the + // number of provisioned instances during deployments, to maintain the same + // capacity for both old and new code. Default: 1 MinSize *int32 // A list of metadata items that you can associate with your auto scaling diff --git a/service/apprunner/api_op_CreateConnection.go b/service/apprunner/api_op_CreateConnection.go index 14b08e46ef0..81a54f6b980 100644 --- a/service/apprunner/api_op_CreateConnection.go +++ b/service/apprunner/api_op_CreateConnection.go @@ -46,8 +46,8 @@ type CreateConnectionInput struct { // This member is required. ProviderType types.ProviderType - // A list of metadata items that you can associate with your connection resource. A - // tag is a key-value pair. + // A list of metadata items that you can associate with your connection resource. + // A tag is a key-value pair. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/apprunner/api_op_CreateObservabilityConfiguration.go b/service/apprunner/api_op_CreateObservabilityConfiguration.go index 0582477eca1..edd823439d7 100644 --- a/service/apprunner/api_op_CreateObservabilityConfiguration.go +++ b/service/apprunner/api_op_CreateObservabilityConfiguration.go @@ -16,14 +16,14 @@ import ( // enable non-default observability features. You can share an observability // configuration across multiple services. Create multiple revisions of a // configuration by calling this action multiple times using the same -// ObservabilityConfigurationName. The call returns incremental +// ObservabilityConfigurationName . The call returns incremental // ObservabilityConfigurationRevision values. When you create a service and // configure an observability configuration resource, the service uses the latest // active revision of the observability configuration by default. You can // optionally configure the service to use a specific revision. The observability // configuration resource is designed to configure multiple features (currently one // feature, tracing). This action takes optional parameters that describe the -// configuration of these features (currently one parameter, TraceConfiguration). +// configuration of these features (currently one parameter, TraceConfiguration ). // If you don't specify a feature parameter, App Runner doesn't enable the feature. func (c *Client) CreateObservabilityConfiguration(ctx context.Context, params *CreateObservabilityConfigurationInput, optFns ...func(*Options)) (*CreateObservabilityConfigurationOutput, error) { if params == nil { diff --git a/service/apprunner/api_op_CreateService.go b/service/apprunner/api_op_CreateService.go index 38d667b1b7a..80de7d7f7c6 100644 --- a/service/apprunner/api_op_CreateService.go +++ b/service/apprunner/api_op_CreateService.go @@ -13,9 +13,8 @@ import ( // Create an App Runner service. After the service is created, the action also // automatically starts a deployment. This is an asynchronous operation. On a -// successful call, you can use the returned OperationId and the ListOperations -// (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) call -// to track the operation's progress. +// successful call, you can use the returned OperationId and the ListOperations (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) +// call to track the operation's progress. func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -61,8 +60,8 @@ type CreateServiceInput struct { // Runner uses an Amazon Web Services managed key. EncryptionConfiguration *types.EncryptionConfiguration - // The settings for the health check that App Runner performs to monitor the health - // of the App Runner service. + // The settings for the health check that App Runner performs to monitor the + // health of the App Runner service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration of instances (scaling units) of your service. @@ -85,9 +84,8 @@ type CreateServiceInput struct { type CreateServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations - // (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) call - // to track the operation's progress. + // use it combined with the ListOperations (https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html) + // call to track the operation's progress. // // This member is required. OperationId *string diff --git a/service/apprunner/api_op_CreateVpcConnector.go b/service/apprunner/api_op_CreateVpcConnector.go index 06c75fe3c92..2f52854c1ce 100644 --- a/service/apprunner/api_op_CreateVpcConnector.go +++ b/service/apprunner/api_op_CreateVpcConnector.go @@ -44,10 +44,10 @@ type CreateVpcConnectorInput struct { // This member is required. VpcConnectorName *string - // A list of IDs of security groups that App Runner should use for access to Amazon - // Web Services resources under the specified subnets. If not specified, App Runner - // uses the default security group of the Amazon VPC. The default security group - // allows all outbound traffic. + // A list of IDs of security groups that App Runner should use for access to + // Amazon Web Services resources under the specified subnets. If not specified, App + // Runner uses the default security group of the Amazon VPC. The default security + // group allows all outbound traffic. SecurityGroups []string // A list of metadata items that you can associate with your VPC connector diff --git a/service/apprunner/api_op_CreateVpcIngressConnection.go b/service/apprunner/api_op_CreateVpcIngressConnection.go index 4b499bd9b42..7d35e42b8f0 100644 --- a/service/apprunner/api_op_CreateVpcIngressConnection.go +++ b/service/apprunner/api_op_CreateVpcIngressConnection.go @@ -31,9 +31,9 @@ func (c *Client) CreateVpcIngressConnection(ctx context.Context, params *CreateV type CreateVpcIngressConnectionInput struct { - // Specifications for the customer’s Amazon VPC and the related Amazon Web Services - // PrivateLink VPC endpoint that are used to create the VPC Ingress Connection - // resource. + // Specifications for the customer’s Amazon VPC and the related Amazon Web + // Services PrivateLink VPC endpoint that are used to create the VPC Ingress + // Connection resource. // // This member is required. IngressVpcConfiguration *types.IngressVpcConfiguration @@ -44,9 +44,9 @@ type CreateVpcIngressConnectionInput struct { // This member is required. ServiceArn *string - // A name for the VPC Ingress Connection resource. It must be unique across all the - // active VPC Ingress Connections in your Amazon Web Services account in the Amazon - // Web Services Region. + // A name for the VPC Ingress Connection resource. It must be unique across all + // the active VPC Ingress Connections in your Amazon Web Services account in the + // Amazon Web Services Region. // // This member is required. VpcIngressConnectionName *string diff --git a/service/apprunner/api_op_DeleteAutoScalingConfiguration.go b/service/apprunner/api_op_DeleteAutoScalingConfiguration.go index dec240ea5c1..1f202139c09 100644 --- a/service/apprunner/api_op_DeleteAutoScalingConfiguration.go +++ b/service/apprunner/api_op_DeleteAutoScalingConfiguration.go @@ -31,10 +31,10 @@ func (c *Client) DeleteAutoScalingConfiguration(ctx context.Context, params *Del type DeleteAutoScalingConfigurationInput struct { - // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that - // you want to delete. The ARN can be a full auto scaling configuration ARN, or a - // partial ARN ending with either .../name or .../name/revision . If a revision - // isn't specified, the latest active revision is deleted. + // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration + // that you want to delete. The ARN can be a full auto scaling configuration ARN, + // or a partial ARN ending with either .../name or .../name/revision . If a + // revision isn't specified, the latest active revision is deleted. // // This member is required. AutoScalingConfigurationArn *string diff --git a/service/apprunner/api_op_DeleteConnection.go b/service/apprunner/api_op_DeleteConnection.go index cc8468cd741..5ddbdb879e7 100644 --- a/service/apprunner/api_op_DeleteConnection.go +++ b/service/apprunner/api_op_DeleteConnection.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an App Runner connection. You must first ensure that there are no running -// App Runner services that use this connection. If there are any, the +// Delete an App Runner connection. You must first ensure that there are no +// running App Runner services that use this connection. If there are any, the // DeleteConnection action fails. func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionInput, optFns ...func(*Options)) (*DeleteConnectionOutput, error) { if params == nil { diff --git a/service/apprunner/api_op_DeleteService.go b/service/apprunner/api_op_DeleteService.go index 464c47a64ab..35fe2d892a9 100644 --- a/service/apprunner/api_op_DeleteService.go +++ b/service/apprunner/api_op_DeleteService.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an App Runner service. This is an asynchronous operation. On a successful -// call, you can use the returned OperationId and the ListOperations call to track -// the operation's progress. Make sure that you don't have any active +// Delete an App Runner service. This is an asynchronous operation. On a +// successful call, you can use the returned OperationId and the ListOperations +// call to track the operation's progress. Make sure that you don't have any active // VPCIngressConnections associated with the service you want to delete. func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error) { if params == nil { diff --git a/service/apprunner/api_op_DeleteVpcConnector.go b/service/apprunner/api_op_DeleteVpcConnector.go index 43f359ccb3e..668d8409684 100644 --- a/service/apprunner/api_op_DeleteVpcConnector.go +++ b/service/apprunner/api_op_DeleteVpcConnector.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an App Runner VPC connector resource. You can't delete a connector that's -// used by one or more App Runner services. +// Delete an App Runner VPC connector resource. You can't delete a connector +// that's used by one or more App Runner services. func (c *Client) DeleteVpcConnector(ctx context.Context, params *DeleteVpcConnectorInput, optFns ...func(*Options)) (*DeleteVpcConnectorOutput, error) { if params == nil { params = &DeleteVpcConnectorInput{} diff --git a/service/apprunner/api_op_DeleteVpcIngressConnection.go b/service/apprunner/api_op_DeleteVpcIngressConnection.go index 8a57e638191..0a5e88b08ff 100644 --- a/service/apprunner/api_op_DeleteVpcIngressConnection.go +++ b/service/apprunner/api_op_DeleteVpcIngressConnection.go @@ -14,15 +14,10 @@ import ( // Delete an App Runner VPC Ingress Connection resource that's associated with an // App Runner service. The VPC Ingress Connection must be in one of the following // states to be deleted: -// -// * AVAILABLE -// -// * FAILED_CREATION -// -// * FAILED_UPDATE -// -// * -// FAILED_DELETION +// - AVAILABLE +// - FAILED_CREATION +// - FAILED_UPDATE +// - FAILED_DELETION func (c *Client) DeleteVpcIngressConnection(ctx context.Context, params *DeleteVpcIngressConnectionInput, optFns ...func(*Options)) (*DeleteVpcIngressConnectionOutput, error) { if params == nil { params = &DeleteVpcIngressConnectionInput{} @@ -40,8 +35,8 @@ func (c *Client) DeleteVpcIngressConnection(ctx context.Context, params *DeleteV type DeleteVpcIngressConnectionInput struct { - // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you - // want to delete. + // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that + // you want to delete. // // This member is required. VpcIngressConnectionArn *string diff --git a/service/apprunner/api_op_DescribeAutoScalingConfiguration.go b/service/apprunner/api_op_DescribeAutoScalingConfiguration.go index 26b42936aef..5749dd35c74 100644 --- a/service/apprunner/api_op_DescribeAutoScalingConfiguration.go +++ b/service/apprunner/api_op_DescribeAutoScalingConfiguration.go @@ -30,10 +30,11 @@ func (c *Client) DescribeAutoScalingConfiguration(ctx context.Context, params *D type DescribeAutoScalingConfigurationInput struct { - // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that - // you want a description for. The ARN can be a full auto scaling configuration - // ARN, or a partial ARN ending with either .../name or .../name/revision . If a - // revision isn't specified, the latest active revision is described. + // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration + // that you want a description for. The ARN can be a full auto scaling + // configuration ARN, or a partial ARN ending with either .../name or + // .../name/revision . If a revision isn't specified, the latest active revision + // is described. // // This member is required. AutoScalingConfigurationArn *string diff --git a/service/apprunner/api_op_DescribeCustomDomains.go b/service/apprunner/api_op_DescribeCustomDomains.go index 271463d7ac5..d2823f5a971 100644 --- a/service/apprunner/api_op_DescribeCustomDomains.go +++ b/service/apprunner/api_op_DescribeCustomDomains.go @@ -37,15 +37,15 @@ type DescribeCustomDomainsInput struct { // This member is required. ServiceArn *string - // The maximum number of results that each response (result page) can include. It's - // used for a paginated request. If you don't specify MaxResults, the request + // The maximum number of results that each response (result page) can include. + // It's used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't - // specify NextToken, the request retrieves the first result page. + // specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -60,14 +60,14 @@ type DescribeCustomDomainsOutput struct { // This member is required. CustomDomains []types.CustomDomain - // The App Runner subdomain of the App Runner service. The associated custom domain - // names are mapped to this target name. + // The App Runner subdomain of the App Runner service. The associated custom + // domain names are mapped to this target name. // // This member is required. DNSTarget *string - // The Amazon Resource Name (ARN) of the App Runner service whose associated custom - // domain names you want to describe. + // The Amazon Resource Name (ARN) of the App Runner service whose associated + // custom domain names you want to describe. // // This member is required. ServiceArn *string @@ -77,8 +77,8 @@ type DescribeCustomDomainsOutput struct { // This member is required. VpcDNSTargets []types.VpcDNSTarget - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -161,8 +161,8 @@ var _ DescribeCustomDomainsAPIClient = (*Client)(nil) // DescribeCustomDomainsPaginatorOptions is the paginator options for // DescribeCustomDomains type DescribeCustomDomainsPaginatorOptions struct { - // The maximum number of results that each response (result page) can include. It's - // used for a paginated request. If you don't specify MaxResults, the request + // The maximum number of results that each response (result page) can include. + // It's used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_DescribeObservabilityConfiguration.go b/service/apprunner/api_op_DescribeObservabilityConfiguration.go index bad1984d3f8..cb2efd4fe9b 100644 --- a/service/apprunner/api_op_DescribeObservabilityConfiguration.go +++ b/service/apprunner/api_op_DescribeObservabilityConfiguration.go @@ -32,8 +32,8 @@ type DescribeObservabilityConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner observability configuration // that you want a description for. The ARN can be a full observability // configuration ARN, or a partial ARN ending with either .../name or - // .../name/revision . If a revision isn't specified, the latest active revision is - // described. + // .../name/revision . If a revision isn't specified, the latest active revision + // is described. // // This member is required. ObservabilityConfigurationArn *string diff --git a/service/apprunner/api_op_DescribeVpcIngressConnection.go b/service/apprunner/api_op_DescribeVpcIngressConnection.go index 8ffb08f50aa..fdee482494b 100644 --- a/service/apprunner/api_op_DescribeVpcIngressConnection.go +++ b/service/apprunner/api_op_DescribeVpcIngressConnection.go @@ -29,8 +29,8 @@ func (c *Client) DescribeVpcIngressConnection(ctx context.Context, params *Descr type DescribeVpcIngressConnectionInput struct { - // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you - // want a description for. + // The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that + // you want a description for. // // This member is required. VpcIngressConnectionArn *string diff --git a/service/apprunner/api_op_DisassociateCustomDomain.go b/service/apprunner/api_op_DisassociateCustomDomain.go index bb0e87299c2..a4f7c1c9a24 100644 --- a/service/apprunner/api_op_DisassociateCustomDomain.go +++ b/service/apprunner/api_op_DisassociateCustomDomain.go @@ -13,10 +13,10 @@ import ( // Disassociate a custom domain name from an App Runner service. Certificates // tracking domain validity are associated with a custom domain and are stored in -// AWS Certificate Manager (ACM) -// (https://docs.aws.amazon.com/acm/latest/userguide). These certificates aren't -// deleted as part of this action. App Runner delays certificate deletion for 30 -// days after a domain is disassociated from your service. +// AWS Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide) +// . These certificates aren't deleted as part of this action. App Runner delays +// certificate deletion for 30 days after a domain is disassociated from your +// service. func (c *Client) DisassociateCustomDomain(ctx context.Context, params *DisassociateCustomDomainInput, optFns ...func(*Options)) (*DisassociateCustomDomainOutput, error) { if params == nil { params = &DisassociateCustomDomainInput{} diff --git a/service/apprunner/api_op_ListAutoScalingConfigurations.go b/service/apprunner/api_op_ListAutoScalingConfigurations.go index 1e1de6ba1b6..667e6fa5207 100644 --- a/service/apprunner/api_op_ListAutoScalingConfigurations.go +++ b/service/apprunner/api_op_ListAutoScalingConfigurations.go @@ -17,7 +17,7 @@ import ( // configuration name or the revisions for all active configurations in your // account. You can optionally query only the latest revision of each requested // name. To retrieve a full description of a particular configuration revision, -// call and provide one of the ARNs returned by ListAutoScalingConfigurations. +// call and provide one of the ARNs returned by ListAutoScalingConfigurations . func (c *Client) ListAutoScalingConfigurations(ctx context.Context, params *ListAutoScalingConfigurationsInput, optFns ...func(*Options)) (*ListAutoScalingConfigurationsOutput, error) { if params == nil { params = &ListAutoScalingConfigurationsInput{} @@ -46,14 +46,14 @@ type ListAutoScalingConfigurationsInput struct { LatestOnly bool // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't - // specify NextToken, the request retrieves the first result page. + // specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -67,8 +67,8 @@ type ListAutoScalingConfigurationsOutput struct { // This member is required. AutoScalingConfigurationSummaryList []types.AutoScalingConfigurationSummary - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -149,7 +149,7 @@ var _ ListAutoScalingConfigurationsAPIClient = (*Client)(nil) // ListAutoScalingConfigurations type ListAutoScalingConfigurationsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListConnections.go b/service/apprunner/api_op_ListConnections.go index cb534541846..27aa879dc15 100644 --- a/service/apprunner/api_op_ListConnections.go +++ b/service/apprunner/api_op_ListConnections.go @@ -36,13 +36,13 @@ type ListConnectionsInput struct { ConnectionName *string // The maximum number of results to include in each response (result page). Used - // for a paginated request. If you don't specify MaxResults, the request retrieves + // for a paginated request. If you don't specify MaxResults , the request retrieves // all available results in a single response. MaxResults *int32 // A token from a previous result page. Used for a paginated request. The request // retrieves the next result page. All other parameter values must be identical to - // the ones specified in the initial request. If you don't specify NextToken, the + // the ones specified in the initial request. If you don't specify NextToken , the // request retrieves the first result page. NextToken *string @@ -57,8 +57,8 @@ type ListConnectionsOutput struct { // This member is required. ConnectionSummaryList []types.ConnectionSummary - // The token that you can pass in a subsequent request to get the next result page. - // Returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. Returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -138,7 +138,7 @@ var _ ListConnectionsAPIClient = (*Client)(nil) // ListConnectionsPaginatorOptions is the paginator options for ListConnections type ListConnectionsPaginatorOptions struct { // The maximum number of results to include in each response (result page). Used - // for a paginated request. If you don't specify MaxResults, the request retrieves + // for a paginated request. If you don't specify MaxResults , the request retrieves // all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListObservabilityConfigurations.go b/service/apprunner/api_op_ListObservabilityConfigurations.go index fecfeae1db5..db39157a70d 100644 --- a/service/apprunner/api_op_ListObservabilityConfigurations.go +++ b/service/apprunner/api_op_ListObservabilityConfigurations.go @@ -17,7 +17,7 @@ import ( // name or the revisions for all active configurations in your account. You can // optionally query only the latest revision of each requested name. To retrieve a // full description of a particular configuration revision, call and provide one of -// the ARNs returned by ListObservabilityConfigurations. +// the ARNs returned by ListObservabilityConfigurations . func (c *Client) ListObservabilityConfigurations(ctx context.Context, params *ListObservabilityConfigurationsInput, optFns ...func(*Options)) (*ListObservabilityConfigurationsOutput, error) { if params == nil { params = &ListObservabilityConfigurationsInput{} @@ -41,18 +41,18 @@ type ListObservabilityConfigurationsInput struct { LatestOnly bool // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't - // specify NextToken, the request retrieves the first result page. + // specify NextToken , the request retrieves the first result page. NextToken *string - // The name of the App Runner observability configuration that you want to list. If - // specified, App Runner lists revisions that share this name. If not specified, + // The name of the App Runner observability configuration that you want to list. + // If specified, App Runner lists revisions that share this name. If not specified, // App Runner returns revisions of all active configurations. ObservabilityConfigurationName *string @@ -67,8 +67,8 @@ type ListObservabilityConfigurationsOutput struct { // This member is required. ObservabilityConfigurationSummaryList []types.ObservabilityConfigurationSummary - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -149,7 +149,7 @@ var _ ListObservabilityConfigurationsAPIClient = (*Client)(nil) // ListObservabilityConfigurations type ListObservabilityConfigurationsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListOperations.go b/service/apprunner/api_op_ListOperations.go index 13592f11c26..74bd247d26a 100644 --- a/service/apprunner/api_op_ListOperations.go +++ b/service/apprunner/api_op_ListOperations.go @@ -32,21 +32,21 @@ func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput type ListOperationsInput struct { - // The Amazon Resource Name (ARN) of the App Runner service that you want a list of - // operations for. + // The Amazon Resource Name (ARN) of the App Runner service that you want a list + // of operations for. // // This member is required. ServiceArn *string // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones specified in the initial request. If you don't specify - // NextToken, the request retrieves the first result page. + // NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -54,8 +54,8 @@ type ListOperationsInput struct { type ListOperationsOutput struct { - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // A list of operation summary information records. In a paginated request, the @@ -142,7 +142,7 @@ var _ ListOperationsAPIClient = (*Client)(nil) // ListOperationsPaginatorOptions is the paginator options for ListOperations type ListOperationsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListServices.go b/service/apprunner/api_op_ListServices.go index 70f0125df44..2dd67edc90a 100644 --- a/service/apprunner/api_op_ListServices.go +++ b/service/apprunner/api_op_ListServices.go @@ -32,13 +32,13 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op type ListServicesInput struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. Used for a paginated request. The request // retrieves the next result page. All other parameter values must be identical to - // the ones specified in the initial request. If you don't specify NextToken, the + // the ones specified in the initial request. If you don't specify NextToken , the // request retrieves the first result page. NextToken *string @@ -53,8 +53,8 @@ type ListServicesOutput struct { // This member is required. ServiceSummaryList []types.ServiceSummary - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -133,7 +133,7 @@ var _ ListServicesAPIClient = (*Client)(nil) // ListServicesPaginatorOptions is the paginator options for ListServices type ListServicesPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListTagsForResource.go b/service/apprunner/api_op_ListTagsForResource.go index f18db7ef2bd..56f4f2d4cb3 100644 --- a/service/apprunner/api_op_ListTagsForResource.go +++ b/service/apprunner/api_op_ListTagsForResource.go @@ -30,8 +30,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that a tag list is requested for. - // It must be the ARN of an App Runner resource. + // The Amazon Resource Name (ARN) of the resource that a tag list is requested + // for. It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string diff --git a/service/apprunner/api_op_ListVpcConnectors.go b/service/apprunner/api_op_ListVpcConnectors.go index 480bfb571ab..f0c680072e7 100644 --- a/service/apprunner/api_op_ListVpcConnectors.go +++ b/service/apprunner/api_op_ListVpcConnectors.go @@ -31,14 +31,14 @@ func (c *Client) ListVpcConnectors(ctx context.Context, params *ListVpcConnector type ListVpcConnectorsInput struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't - // specify NextToken, the request retrieves the first result page. + // specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -52,8 +52,8 @@ type ListVpcConnectorsOutput struct { // This member is required. VpcConnectors []types.VpcConnector - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -133,7 +133,7 @@ var _ ListVpcConnectorsAPIClient = (*Client)(nil) // ListVpcConnectorsPaginatorOptions is the paginator options for ListVpcConnectors type ListVpcConnectorsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_ListVpcIngressConnections.go b/service/apprunner/api_op_ListVpcIngressConnections.go index 03cada0f854..aa3431d250f 100644 --- a/service/apprunner/api_op_ListVpcIngressConnections.go +++ b/service/apprunner/api_op_ListVpcIngressConnections.go @@ -36,14 +36,14 @@ type ListVpcIngressConnectionsInput struct { Filter *types.ListVpcIngressConnectionsFilter // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. MaxResults *int32 // A token from a previous result page. It's used for a paginated request. The // request retrieves the next result page. All other parameter values must be // identical to the ones that are specified in the initial request. If you don't - // specify NextToken, the request retrieves the first result page. + // specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -57,8 +57,8 @@ type ListVpcIngressConnectionsOutput struct { // This member is required. VpcIngressConnectionSummaryList []types.VpcIngressConnectionSummary - // The token that you can pass in a subsequent request to get the next result page. - // It's returned in a paginated request. + // The token that you can pass in a subsequent request to get the next result + // page. It's returned in a paginated request. NextToken *string // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListVpcIngressConnectionsAPIClient = (*Client)(nil) // ListVpcIngressConnections type ListVpcIngressConnectionsPaginatorOptions struct { // The maximum number of results to include in each response (result page). It's - // used for a paginated request. If you don't specify MaxResults, the request + // used for a paginated request. If you don't specify MaxResults , the request // retrieves all available results in a single response. Limit int32 diff --git a/service/apprunner/api_op_StartDeployment.go b/service/apprunner/api_op_StartDeployment.go index cc286ae1fa9..266a51b8a3b 100644 --- a/service/apprunner/api_op_StartDeployment.go +++ b/service/apprunner/api_op_StartDeployment.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiate a manual deployment of the latest commit in a source code repository or -// the latest image in a source image repository to an App Runner service. For a +// Initiate a manual deployment of the latest commit in a source code repository +// or the latest image in a source image repository to an App Runner service. For a // source code repository, App Runner retrieves the commit and builds a Docker // image. For a source image repository, App Runner retrieves the latest Docker // image. In both cases, App Runner then deploys the new image to your service and diff --git a/service/apprunner/api_op_TagResource.go b/service/apprunner/api_op_TagResource.go index 4d24ba0d5ed..460f3e75c76 100644 --- a/service/apprunner/api_op_TagResource.go +++ b/service/apprunner/api_op_TagResource.go @@ -30,15 +30,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that you want to update tags for. - // It must be the ARN of an App Runner resource. + // The Amazon Resource Name (ARN) of the resource that you want to update tags + // for. It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string - // A list of tag key-value pairs to add or update. If a key is new to the resource, - // the tag is added with the provided value. If a key is already associated with - // the resource, the value of the tag is updated. + // A list of tag key-value pairs to add or update. If a key is new to the + // resource, the tag is added with the provided value. If a key is already + // associated with the resource, the value of the tag is updated. // // This member is required. Tags []types.Tag diff --git a/service/apprunner/api_op_UpdateService.go b/service/apprunner/api_op_UpdateService.go index a2a6aee36f0..340ac898b5a 100644 --- a/service/apprunner/api_op_UpdateService.go +++ b/service/apprunner/api_op_UpdateService.go @@ -16,7 +16,7 @@ import ( // scaling configuration resource that's associated with the service. However, you // can't change the name or the encryption configuration of the service. These can // be set only when you create the service. To update the tags applied to your -// service, use the separate actions TagResource and UntagResource. This is an +// service, use the separate actions TagResource and UntagResource . This is an // asynchronous operation. On a successful call, you can use the returned // OperationId and the ListOperations call to track the operation's progress. func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { @@ -46,8 +46,8 @@ type UpdateServiceInput struct { // resource that you want to associate with the App Runner service. AutoScalingConfigurationArn *string - // The settings for the health check that App Runner performs to monitor the health - // of the App Runner service. + // The settings for the health check that App Runner performs to monitor the + // health of the App Runner service. HealthCheckConfiguration *types.HealthCheckConfiguration // The runtime configuration to apply to instances (scaling units) of your service. @@ -65,7 +65,7 @@ type UpdateServiceInput struct { // you can't switch from code to image or the other way around. This means that you // must provide the same structure member of SourceConfiguration that you // originally included when you created the service. Specifically, you can include - // either CodeRepository or ImageRepository. To update the source configuration, + // either CodeRepository or ImageRepository . To update the source configuration, // set the values to members of the structure that you include. SourceConfiguration *types.SourceConfiguration diff --git a/service/apprunner/api_op_UpdateVpcIngressConnection.go b/service/apprunner/api_op_UpdateVpcIngressConnection.go index 0a4919d9d86..e77d57d523e 100644 --- a/service/apprunner/api_op_UpdateVpcIngressConnection.go +++ b/service/apprunner/api_op_UpdateVpcIngressConnection.go @@ -13,13 +13,9 @@ import ( // Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress // Connection must be in one of the following states to be updated: -// -// * AVAILABLE -// -// * -// FAILED_CREATION -// -// * FAILED_UPDATE +// - AVAILABLE +// - FAILED_CREATION +// - FAILED_UPDATE func (c *Client) UpdateVpcIngressConnection(ctx context.Context, params *UpdateVpcIngressConnectionInput, optFns ...func(*Options)) (*UpdateVpcIngressConnectionOutput, error) { if params == nil { params = &UpdateVpcIngressConnectionInput{} @@ -37,9 +33,9 @@ func (c *Client) UpdateVpcIngressConnection(ctx context.Context, params *UpdateV type UpdateVpcIngressConnectionInput struct { - // Specifications for the customer’s Amazon VPC and the related Amazon Web Services - // PrivateLink VPC endpoint that are used to update the VPC Ingress Connection - // resource. + // Specifications for the customer’s Amazon VPC and the related Amazon Web + // Services PrivateLink VPC endpoint that are used to update the VPC Ingress + // Connection resource. // // This member is required. IngressVpcConfiguration *types.IngressVpcConfiguration diff --git a/service/apprunner/doc.go b/service/apprunner/doc.go index 9ee68cf769e..84d46f9a765 100644 --- a/service/apprunner/doc.go +++ b/service/apprunner/doc.go @@ -11,14 +11,12 @@ // Runner connects directly to your container registry or source code repository. // It provides an automatic delivery pipeline with fully managed operations, high // performance, scalability, and security. For more information about App Runner, -// see the App Runner Developer Guide -// (https://docs.aws.amazon.com/apprunner/latest/dg/). For release information, see -// the App Runner Release Notes -// (https://docs.aws.amazon.com/apprunner/latest/relnotes/). To install the -// Software Development Kits (SDKs), Integrated Development Environment (IDE) -// Toolkits, and command line tools that you can use to access the API, see Tools -// for Amazon Web Services (http://aws.amazon.com/tools/). Endpoints For a list of -// Region-specific endpoints that App Runner supports, see App Runner endpoints and -// quotas (https://docs.aws.amazon.com/general/latest/gr/apprunner.html) in the -// Amazon Web Services General Reference. +// see the App Runner Developer Guide (https://docs.aws.amazon.com/apprunner/latest/dg/) +// . For release information, see the App Runner Release Notes (https://docs.aws.amazon.com/apprunner/latest/relnotes/) +// . To install the Software Development Kits (SDKs), Integrated Development +// Environment (IDE) Toolkits, and command line tools that you can use to access +// the API, see Tools for Amazon Web Services (http://aws.amazon.com/tools/) . +// Endpoints For a list of Region-specific endpoints that App Runner supports, see +// App Runner endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/apprunner.html) +// in the Amazon Web Services General Reference. package apprunner diff --git a/service/apprunner/types/enums.go b/service/apprunner/types/enums.go index 17e1fb6f94a..af60f4a7918 100644 --- a/service/apprunner/types/enums.go +++ b/service/apprunner/types/enums.go @@ -30,8 +30,8 @@ const ( CertificateValidationRecordStatusFailed CertificateValidationRecordStatus = "FAILED" ) -// Values returns all known values for CertificateValidationRecordStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for CertificateValidationRecordStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (CertificateValidationRecordStatus) Values() []CertificateValidationRecordStatus { @@ -245,9 +245,9 @@ const ( ProviderTypeGithub ProviderType = "GITHUB" ) -// Values returns all known values for ProviderType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProviderType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProviderType) Values() []ProviderType { return []ProviderType{ "GITHUB", @@ -321,8 +321,8 @@ const ( SourceCodeVersionTypeBranch SourceCodeVersionType = "BRANCH" ) -// Values returns all known values for SourceCodeVersionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SourceCodeVersionType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SourceCodeVersionType) Values() []SourceCodeVersionType { return []SourceCodeVersionType{ diff --git a/service/apprunner/types/errors.go b/service/apprunner/types/errors.go index 6e8e84f3879..04db49b2fec 100644 --- a/service/apprunner/types/errors.go +++ b/service/apprunner/types/errors.go @@ -114,9 +114,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // App Runner can't create this resource. You've reached your account quota for -// this resource type. For App Runner per-resource quotas, see App Runner endpoints -// and quotas (https://docs.aws.amazon.com/general/latest/gr/apprunner.html) in the -// Amazon Web Services General Reference. +// this resource type. For App Runner per-resource quotas, see App Runner +// endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/apprunner.html) +// in the Amazon Web Services General Reference. type ServiceQuotaExceededException struct { Message *string diff --git a/service/apprunner/types/types.go b/service/apprunner/types/types.go index 10ae952b1b6..6052487d41a 100644 --- a/service/apprunner/types/types.go +++ b/service/apprunner/types/types.go @@ -16,9 +16,9 @@ type AuthenticationConfiguration struct { // (but not for ECR Public repositories). AccessRoleArn *string - // The Amazon Resource Name (ARN) of the App Runner connection that enables the App - // Runner service to connect to a source repository. It's required for GitHub code - // repositories. + // The Amazon Resource Name (ARN) of the App Runner connection that enables the + // App Runner service to connect to a source repository. It's required for GitHub + // code repositories. ConnectionArn *string noSmithyDocumentSerde @@ -41,8 +41,8 @@ type AutoScalingConfiguration struct { AutoScalingConfigurationName *string // The revision of this auto scaling configuration. It's unique among all the - // active configurations ("Status": "ACTIVE") that share the same - // AutoScalingConfigurationName. + // active configurations ( "Status": "ACTIVE" ) that share the same + // AutoScalingConfigurationName . AutoScalingConfigurationRevision int32 // The time when the auto scaling configuration was created. It's in Unix time @@ -54,7 +54,7 @@ type AutoScalingConfiguration struct { DeletedAt *time.Time // It's set to true for the configuration with the highest Revision among all - // configurations that share the same AutoScalingConfigurationName. It's set to + // configurations that share the same AutoScalingConfigurationName . It's set to // false otherwise. Latest bool @@ -68,17 +68,17 @@ type AutoScalingConfiguration struct { MaxSize int32 // The minimum number of instances that App Runner provisions for a service. The - // service always has at least MinSize provisioned instances. Some of them actively - // serve traffic. The rest of them (provisioned and inactive instances) are a - // cost-effective compute capacity reserve and are ready to be quickly activated. - // You pay for memory usage of all the provisioned instances. You pay for CPU usage - // of only the active subset. App Runner temporarily doubles the number of - // provisioned instances during deployments, to maintain the same capacity for both - // old and new code. + // service always has at least MinSize provisioned instances. Some of them + // actively serve traffic. The rest of them (provisioned and inactive instances) + // are a cost-effective compute capacity reserve and are ready to be quickly + // activated. You pay for memory usage of all the provisioned instances. You pay + // for CPU usage of only the active subset. App Runner temporarily doubles the + // number of provisioned instances during deployments, to maintain the same + // capacity for both old and new code. MinSize int32 // The current state of the auto scaling configuration. If the status of a - // configuration revision is INACTIVE, it was deleted and can't be used. Inactive + // configuration revision is INACTIVE , it was deleted and can't be used. Inactive // configuration revisions are permanently removed some time after they are // deleted. Status AutoScalingConfigurationStatus @@ -86,12 +86,12 @@ type AutoScalingConfiguration struct { noSmithyDocumentSerde } -// Provides summary information about an App Runner automatic scaling configuration -// resource. This type contains limited information about an auto scaling -// configuration. It includes only identification information, without +// Provides summary information about an App Runner automatic scaling +// configuration resource. This type contains limited information about an auto +// scaling configuration. It includes only identification information, without // configuration details. It's returned by the ListAutoScalingConfigurations // action. Complete configuration information is returned by the -// CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and +// CreateAutoScalingConfiguration , DescribeAutoScalingConfiguration , and // DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type. type AutoScalingConfigurationSummary struct { @@ -103,16 +103,16 @@ type AutoScalingConfigurationSummary struct { AutoScalingConfigurationName *string // The revision of this auto scaling configuration. It's unique among all the - // active configurations ("Status": "ACTIVE") with the same - // AutoScalingConfigurationName. + // active configurations ( "Status": "ACTIVE" ) with the same + // AutoScalingConfigurationName . AutoScalingConfigurationRevision int32 noSmithyDocumentSerde } // Describes a certificate CNAME record to add to your DNS. For more information, -// see AssociateCustomDomain -// (https://docs.aws.amazon.com/apprunner/latest/api/API_AssociateCustomDomain.html). +// see AssociateCustomDomain (https://docs.aws.amazon.com/apprunner/latest/api/API_AssociateCustomDomain.html) +// . type CertificateValidationRecord struct { // The certificate CNAME record name. @@ -122,7 +122,7 @@ type CertificateValidationRecord struct { // to SUCCESS after App Runner completes validation with your DNS. Status CertificateValidationRecordStatus - // The record type, always CNAME. + // The record type, always CNAME . Type *string // The certificate CNAME record value. @@ -135,16 +135,12 @@ type CertificateValidationRecord struct { // service from a source code repository. type CodeConfiguration struct { - // The source of the App Runner configuration. Values are interpreted as - // follows: - // - // * REPOSITORY – App Runner reads configuration values from the - // apprunner.yaml file in the source code repository and ignores - // CodeConfigurationValues. - // - // * API – App Runner uses configuration values provided - // in CodeConfigurationValues and ignores the apprunner.yaml file in the source - // code repository. + // The source of the App Runner configuration. Values are interpreted as follows: + // - REPOSITORY – App Runner reads configuration values from the apprunner.yaml + // file in the source code repository and ignores CodeConfigurationValues . + // - API – App Runner uses configuration values provided in + // CodeConfigurationValues and ignores the apprunner.yaml file in the source code + // repository. // // This member is required. ConfigurationSource ConfigurationSource @@ -180,19 +176,16 @@ type CodeConfigurationValues struct { // either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the // full ARN of the parameter in the Amazon Web Services Systems Manager Parameter // Store. - // - // * If the Amazon Web Services Systems Manager Parameter Store parameter - // exists in the same Amazon Web Services Region as the service that you're - // launching, you can use either the full ARN or name of the secret. If the - // parameter exists in a different Region, then the full ARN must be specified. - // - // * - // Currently, cross account referencing of Amazon Web Services Systems Manager - // Parameter Store parameter is not supported. + // - If the Amazon Web Services Systems Manager Parameter Store parameter exists + // in the same Amazon Web Services Region as the service that you're launching, you + // can use either the full ARN or name of the secret. If the parameter exists in a + // different Region, then the full ARN must be specified. + // - Currently, cross account referencing of Amazon Web Services Systems Manager + // Parameter Store parameter is not supported. RuntimeEnvironmentSecrets map[string]string - // The environment variables that are available to your running App Runner service. - // An array of key-value pairs. + // The environment variables that are available to your running App Runner + // service. An array of key-value pairs. RuntimeEnvironmentVariables map[string]string // The command App Runner runs to start your application. @@ -236,8 +229,8 @@ type Connection struct { // The source repository provider. ProviderType ProviderType - // The current state of the App Runner connection. When the state is AVAILABLE, you - // can use the connection to create an App Runner service. + // The current state of the App Runner connection. When the state is AVAILABLE , + // you can use the connection to create an App Runner service. Status ConnectionStatus noSmithyDocumentSerde @@ -258,8 +251,8 @@ type ConnectionSummary struct { // The source repository provider. ProviderType ProviderType - // The current state of the App Runner connection. When the state is AVAILABLE, you - // can use the connection to create an App Runner service. + // The current state of the App Runner connection. When the state is AVAILABLE , + // you can use the connection to create an App Runner service. Status ConnectionStatus noSmithyDocumentSerde @@ -269,13 +262,13 @@ type ConnectionSummary struct { type CustomDomain struct { // An associated custom domain endpoint. It can be a root domain (for example, - // example.com), a subdomain (for example, login.example.com or - // admin.login.example.com), or a wildcard (for example, *.example.com). + // example.com ), a subdomain (for example, login.example.com or + // admin.login.example.com ), or a wildcard (for example, *.example.com ). // // This member is required. DomainName *string - // When true, the subdomain www.DomainName is associated with the App Runner + // When true , the subdomain www.DomainName is associated with the App Runner // service in addition to the base domain. // // This member is required. @@ -298,11 +291,11 @@ type EgressConfiguration struct { // The type of egress configuration. Set to DEFAULT for access to resources hosted // on public networks. Set to VPC to associate your service to a custom VPC - // specified by VpcConnectorArn. + // specified by VpcConnectorArn . EgressType EgressType // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to - // associate with your App Runner service. Only valid when EgressType = VPC. + // associate with your App Runner service. Only valid when EgressType = VPC . VpcConnectorArn *string noSmithyDocumentSerde @@ -331,13 +324,13 @@ type HealthCheckConfiguration struct { // The time interval, in seconds, between health checks. Default: 5 Interval *int32 - // The URL that health check requests are sent to. Path is only applicable when you - // set Protocol to HTTP. Default: "/" + // The URL that health check requests are sent to. Path is only applicable when + // you set Protocol to HTTP . Default: "/" Path *string // The IP protocol that App Runner uses to perform health checks for your service. - // If you set Protocol to HTTP, App Runner sends health check requests to the HTTP - // path specified by Path. Default: TCP + // If you set Protocol to HTTP , App Runner sends health check requests to the HTTP + // path specified by Path . Default: TCP Protocol HealthCheckProtocol // The time, in seconds, to wait for a health check response before deciding it @@ -363,15 +356,12 @@ type ImageConfiguration struct { // either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the // full ARN of the parameter in the Amazon Web Services Systems Manager Parameter // Store. - // - // * If the Amazon Web Services Systems Manager Parameter Store parameter - // exists in the same Amazon Web Services Region as the service that you're - // launching, you can use either the full ARN or name of the secret. If the - // parameter exists in a different Region, then the full ARN must be specified. - // - // * - // Currently, cross account referencing of Amazon Web Services Systems Manager - // Parameter Store parameter is not supported. + // - If the Amazon Web Services Systems Manager Parameter Store parameter exists + // in the same Amazon Web Services Region as the service that you're launching, you + // can use either the full ARN or name of the secret. If the parameter exists in a + // different Region, then the full ARN must be specified. + // - Currently, cross account referencing of Amazon Web Services Systems Manager + // Parameter Store parameter is not supported. RuntimeEnvironmentSecrets map[string]string // Environment variables that are available to your running App Runner service. An @@ -391,8 +381,7 @@ type ImageRepository struct { // The identifier of an image. For an image in Amazon Elastic Container Registry // (Amazon ECR), this is an image name. For the image name format, see Pulling an - // image - // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) + // image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) // in the Amazon ECR User Guide. // // This member is required. @@ -414,8 +403,8 @@ type ImageRepository struct { type IngressConfiguration struct { // Specifies whether your App Runner service is publicly accessible. To make the - // service publicly accessible set it to True. To make the service privately - // accessible, from only within an Amazon VPC set it to False. + // service publicly accessible set it to True . To make the service privately + // accessible, from only within an Amazon VPC set it to False . IsPubliclyAccessible bool noSmithyDocumentSerde @@ -448,15 +437,15 @@ type InstanceConfiguration struct { // Amazon Web Services APIs. InstanceRoleArn *string - // The amount of memory, in MB or GB, reserved for each instance of your App Runner - // service. Default: 2 GB + // The amount of memory, in MB or GB, reserved for each instance of your App + // Runner service. Default: 2 GB Memory *string noSmithyDocumentSerde } // Returns a list of VPC Ingress Connections based on the filter provided. It can -// return either ServiceArn or VpcEndpointId, or both. +// return either ServiceArn or VpcEndpointId , or both. type ListVpcIngressConnectionsFilter struct { // The Amazon Resource Name (ARN) of a service to filter by. @@ -481,13 +470,13 @@ type NetworkConfiguration struct { noSmithyDocumentSerde } -// Describes an App Runner observability configuration resource. Multiple revisions -// of a configuration have the same ObservabilityConfigurationName and different -// ObservabilityConfigurationRevision values. The resource is designed to configure -// multiple features (currently one feature, tracing). This type contains optional -// members that describe the configuration of these features (currently one member, -// TraceConfiguration). If a feature member isn't specified, the feature isn't -// enabled. +// Describes an App Runner observability configuration resource. Multiple +// revisions of a configuration have the same ObservabilityConfigurationName and +// different ObservabilityConfigurationRevision values. The resource is designed +// to configure multiple features (currently one feature, tracing). This type +// contains optional members that describe the configuration of these features +// (currently one member, TraceConfiguration ). If a feature member isn't +// specified, the feature isn't enabled. type ObservabilityConfiguration struct { // The time when the observability configuration was created. It's in Unix time @@ -499,7 +488,7 @@ type ObservabilityConfiguration struct { DeletedAt *time.Time // It's set to true for the configuration with the highest Revision among all - // configurations that share the same ObservabilityConfigurationName. It's set to + // configurations that share the same ObservabilityConfigurationName . It's set to // false otherwise. Latest bool @@ -511,12 +500,12 @@ type ObservabilityConfiguration struct { ObservabilityConfigurationName *string // The revision of this observability configuration. It's unique among all the - // active configurations ("Status": "ACTIVE") that share the same - // ObservabilityConfigurationName. + // active configurations ( "Status": "ACTIVE" ) that share the same + // ObservabilityConfigurationName . ObservabilityConfigurationRevision int32 // The current state of the observability configuration. If the status of a - // configuration revision is INACTIVE, it was deleted and can't be used. Inactive + // configuration revision is INACTIVE , it was deleted and can't be used. Inactive // configuration revisions are permanently removed some time after they are // deleted. Status ObservabilityConfigurationStatus @@ -533,7 +522,7 @@ type ObservabilityConfiguration struct { // configuration. It includes only identification information, without // configuration details. It's returned by the ListObservabilityConfigurations // action. Complete configuration information is returned by the -// CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and +// CreateObservabilityConfiguration , DescribeObservabilityConfiguration , and // DeleteObservabilityConfiguration actions using the ObservabilityConfiguration // type. type ObservabilityConfigurationSummary struct { @@ -546,8 +535,8 @@ type ObservabilityConfigurationSummary struct { ObservabilityConfigurationName *string // The revision of this observability configuration. It's unique among all the - // active configurations ("Status": "ACTIVE") that share the same - // ObservabilityConfigurationName. + // active configurations ( "Status": "ACTIVE" ) that share the same + // ObservabilityConfigurationName . ObservabilityConfigurationRevision int32 noSmithyDocumentSerde @@ -586,16 +575,12 @@ type OperationSummary struct { // Describes an App Runner service. It can describe a service in any state, // including deleted services. This type contains the full information about a -// service, including configuration details. It's returned by the CreateService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html), -// DescribeService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html), and -// DeleteService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html) -// actions. A subset of this information is returned by the ListServices -// (https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html) action -// using the ServiceSummary -// (https://docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html) type. +// service, including configuration details. It's returned by the CreateService (https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html) +// , DescribeService (https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html) +// , and DeleteService (https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html) +// actions. A subset of this information is returned by the ListServices (https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html) +// action using the ServiceSummary (https://docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html) +// type. type Service struct { // Summary information for the App Runner automatic scaling configuration resource @@ -645,16 +630,14 @@ type Service struct { // The current state of the App Runner service. These particular values mean the // following. - // - // * CREATE_FAILED – The service failed to create. To troubleshoot this - // failure, read the failure events and logs, change any parameters that need to be - // fixed, and retry the call to create the service. The failed service isn't - // usable, and still counts towards your service quota. When you're done analyzing - // the failure, delete the service. - // - // * DELETE_FAILED – The service failed to delete - // and can't be successfully recovered. Retry the service deletion call to ensure - // that all related resources are removed. + // - CREATE_FAILED – The service failed to create. To troubleshoot this failure, + // read the failure events and logs, change any parameters that need to be fixed, + // and retry the call to create the service. The failed service isn't usable, and + // still counts towards your service quota. When you're done analyzing the failure, + // delete the service. + // - DELETE_FAILED – The service failed to delete and can't be successfully + // recovered. Retry the service deletion call to ensure that all related resources + // are removed. // // This member is required. Status ServiceStatus @@ -669,20 +652,21 @@ type Service struct { // format. DeletedAt *time.Time - // The encryption key that App Runner uses to encrypt the service logs and the copy - // of the source repository that App Runner maintains for the service. It can be - // either a customer-provided encryption key or an Amazon Web Services managed key. + // The encryption key that App Runner uses to encrypt the service logs and the + // copy of the source repository that App Runner maintains for the service. It can + // be either a customer-provided encryption key or an Amazon Web Services managed + // key. EncryptionConfiguration *EncryptionConfiguration - // The settings for the health check that App Runner performs to monitor the health - // of this service. + // The settings for the health check that App Runner performs to monitor the + // health of this service. HealthCheckConfiguration *HealthCheckConfiguration // The observability configuration of this service. ObservabilityConfiguration *ServiceObservabilityConfiguration - // A subdomain URL that App Runner generated for this service. You can use this URL - // to access your service web application. + // A subdomain URL that App Runner generated for this service. You can use this + // URL to access your service web application. ServiceUrl *string noSmithyDocumentSerde @@ -693,14 +677,14 @@ type Service struct { // They're configured in a separate resource that you associate with your service. type ServiceObservabilityConfiguration struct { - // When true, an observability configuration resource is associated with the + // When true , an observability configuration resource is associated with the // service, and an ObservabilityConfigurationArn is specified. // // This member is required. ObservabilityEnabled bool // The Amazon Resource Name (ARN) of the observability configuration that is - // associated with the service. Specified only when ObservabilityEnabled is true. + // associated with the service. Specified only when ObservabilityEnabled is true . // Specify an ARN with a name and a revision number to associate that revision. For // example: // arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3 @@ -713,16 +697,12 @@ type ServiceObservabilityConfiguration struct { // Provides summary information for an App Runner service. This type contains // limited information about a service. It doesn't include configuration details. -// It's returned by the ListServices -// (https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html) action. -// Complete service information is returned by the CreateService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html), -// DescribeService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html), and -// DeleteService -// (https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html) -// actions using the Service -// (https://docs.aws.amazon.com/apprunner/latest/api/API_Service.html) type. +// It's returned by the ListServices (https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html) +// action. Complete service information is returned by the CreateService (https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html) +// , DescribeService (https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html) +// , and DeleteService (https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html) +// actions using the Service (https://docs.aws.amazon.com/apprunner/latest/api/API_Service.html) +// type. type ServiceSummary struct { // The time when the App Runner service was created. It's in the Unix time stamp @@ -739,22 +719,19 @@ type ServiceSummary struct { // The customer-provided service name. ServiceName *string - // A subdomain URL that App Runner generated for this service. You can use this URL - // to access your service web application. + // A subdomain URL that App Runner generated for this service. You can use this + // URL to access your service web application. ServiceUrl *string // The current state of the App Runner service. These particular values mean the // following. - // - // * CREATE_FAILED – The service failed to create. Read the failure - // events and logs, change any parameters that need to be fixed, and retry the call - // to create the service. The failed service isn't usable, and still counts towards - // your service quota. When you're done analyzing the failure, delete the - // service. - // - // * DELETE_FAILED – The service failed to delete and can't be - // successfully recovered. Retry the service deletion call to ensure that all - // related resources are removed. + // - CREATE_FAILED – The service failed to create. Read the failure events and + // logs, change any parameters that need to be fixed, and retry the call to create + // the service. The failed service isn't usable, and still counts towards your + // service quota. When you're done analyzing the failure, delete the service. + // - DELETE_FAILED – The service failed to delete and can't be successfully + // recovered. Retry the service deletion call to ensure that all related resources + // are removed. Status ServiceStatus // The time when the App Runner service was last updated. It's in theUnix time @@ -791,7 +768,7 @@ type SourceConfiguration struct { // repositories. AuthenticationConfiguration *AuthenticationConfiguration - // If true, continuous integration from the source repository is enabled for the + // If true , continuous integration from the source repository is enabled for the // App Runner service. Each repository change (including any source code commit or // new image version) starts a deployment. Default: App Runner sets to false for a // source image that uses an ECR Public repository or an ECR repository that's in @@ -800,8 +777,8 @@ type SourceConfiguration struct { // repository or a source image using a same-account ECR repository). AutoDeploymentsEnabled *bool - // The description of a source code repository. You must provide either this member - // or ImageRepository (but not both). + // The description of a source code repository. You must provide either this + // member or ImageRepository (but not both). CodeRepository *CodeRepository // The description of a source image repository. You must provide either this @@ -839,8 +816,8 @@ type TraceConfiguration struct { // Describes an App Runner VPC connector resource. A VPC connector describes the // Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is // associated with, and the subnets and security group that are used. Multiple -// revisions of a connector might have the same Name and different Revision values. -// At this time, App Runner supports only one revision per name. +// revisions of a connector might have the same Name and different Revision +// values. At this time, App Runner supports only one revision per name. type VpcConnector struct { // The time when the VPC connector was created. It's in Unix time stamp format. @@ -855,8 +832,8 @@ type VpcConnector struct { // allows all outbound traffic. SecurityGroups []string - // The current state of the VPC connector. If the status of a connector revision is - // INACTIVE, it was deleted and can't be used. Inactive connector revisions are + // The current state of the VPC connector. If the status of a connector revision + // is INACTIVE , it was deleted and can't be used. Inactive connector revisions are // permanently removed some time after they are deleted. Status VpcConnectorStatus @@ -871,8 +848,8 @@ type VpcConnector struct { VpcConnectorName *string // The revision of this VPC connector. It's unique among all the active connectors - // ("Status": "ACTIVE") that share the same Name. At this time, App Runner supports - // only one revision per name. + // ( "Status": "ACTIVE" ) that share the same Name . At this time, App Runner + // supports only one revision per name. VpcConnectorRevision int32 noSmithyDocumentSerde @@ -906,18 +883,14 @@ type VpcIngressConnection struct { // The time when the VPC Ingress Connection was created. It's in the Unix time // stamp format. - // - // * Type: Timestamp - // - // * Required: Yes + // - Type: Timestamp + // - Required: Yes CreatedAt *time.Time // The time when the App Runner service was deleted. It's in the Unix time stamp // format. - // - // * Type: Timestamp - // - // * Required: No + // - Type: Timestamp + // - Required: No DeletedAt *time.Time // The domain name associated with the VPC Ingress Connection resource. @@ -932,9 +905,9 @@ type VpcIngressConnection struct { ServiceArn *string // The current status of the VPC Ingress Connection. The VPC Ingress Connection - // displays one of the following statuses: AVAILABLE, PENDING_CREATION, - // PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, - // FAILED_DELETION, and DELETED.. + // displays one of the following statuses: AVAILABLE , PENDING_CREATION , + // PENDING_UPDATE , PENDING_DELETION , FAILED_CREATION , FAILED_UPDATE , + // FAILED_DELETION , and DELETED .. Status VpcIngressConnectionStatus // The Amazon Resource Name (ARN) of the VPC Ingress Connection. @@ -946,8 +919,8 @@ type VpcIngressConnection struct { noSmithyDocumentSerde } -// Provides summary information about an VPC Ingress Connection, which includes its -// VPC Ingress Connection ARN and its associated Service ARN. +// Provides summary information about an VPC Ingress Connection, which includes +// its VPC Ingress Connection ARN and its associated Service ARN. type VpcIngressConnectionSummary struct { // The Amazon Resource Name (ARN) of the service associated with the VPC Ingress diff --git a/service/appstream/api_client.go b/service/appstream/api_client.go index f5cc8317f00..3187cf62482 100644 --- a/service/appstream/api_client.go +++ b/service/appstream/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appstream/api_op_CreateApplication.go b/service/appstream/api_op_CreateApplication.go index 58bcde2899e..7758d6e6e84 100644 --- a/service/appstream/api_op_CreateApplication.go +++ b/service/appstream/api_op_CreateApplication.go @@ -45,8 +45,8 @@ type CreateApplicationInput struct { // This member is required. IconS3Location *types.S3Location - // The instance families the application supports. Valid values are GENERAL_PURPOSE - // and GRAPHICS_G4. + // The instance families the application supports. Valid values are + // GENERAL_PURPOSE and GRAPHICS_G4. // // This member is required. InstanceFamilies []string diff --git a/service/appstream/api_op_CreateFleet.go b/service/appstream/api_op_CreateFleet.go index cf3ef770505..de38fd4f0e1 100644 --- a/service/appstream/api_op_CreateFleet.go +++ b/service/appstream/api_op_CreateFleet.go @@ -32,105 +32,47 @@ type CreateFleetInput struct { // The instance type to use when launching fleet instances. The following instance // types are available: - // - // * stream.standard.small - // - // * stream.standard.medium - // - // * - // stream.standard.large - // - // * stream.standard.xlarge - // - // * stream.standard.2xlarge - // - // * - // stream.compute.large - // - // * stream.compute.xlarge - // - // * stream.compute.2xlarge - // - // * - // stream.compute.4xlarge - // - // * stream.compute.8xlarge - // - // * stream.memory.large - // - // * - // stream.memory.xlarge - // - // * stream.memory.2xlarge - // - // * stream.memory.4xlarge - // - // * - // stream.memory.8xlarge - // - // * stream.memory.z1d.large - // - // * stream.memory.z1d.xlarge - // - // * - // stream.memory.z1d.2xlarge - // - // * stream.memory.z1d.3xlarge - // - // * - // stream.memory.z1d.6xlarge - // - // * stream.memory.z1d.12xlarge - // - // * - // stream.graphics-design.large - // - // * stream.graphics-design.xlarge - // - // * - // stream.graphics-design.2xlarge - // - // * stream.graphics-design.4xlarge - // - // * - // stream.graphics-desktop.2xlarge - // - // * stream.graphics.g4dn.xlarge - // - // * - // stream.graphics.g4dn.2xlarge - // - // * stream.graphics.g4dn.4xlarge - // - // * - // stream.graphics.g4dn.8xlarge - // - // * stream.graphics.g4dn.12xlarge - // - // * - // stream.graphics.g4dn.16xlarge - // - // * stream.graphics-pro.4xlarge - // - // * - // stream.graphics-pro.8xlarge - // - // * stream.graphics-pro.16xlarge - // - // The following - // instance types are available for Elastic fleets: - // - // * stream.standard.small - // - // * - // stream.standard.medium - // - // * stream.standard.large - // - // * stream.standard.xlarge - // - // * - // stream.standard.2xlarge + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.standard.xlarge + // - stream.standard.2xlarge + // - stream.compute.large + // - stream.compute.xlarge + // - stream.compute.2xlarge + // - stream.compute.4xlarge + // - stream.compute.8xlarge + // - stream.memory.large + // - stream.memory.xlarge + // - stream.memory.2xlarge + // - stream.memory.4xlarge + // - stream.memory.8xlarge + // - stream.memory.z1d.large + // - stream.memory.z1d.xlarge + // - stream.memory.z1d.2xlarge + // - stream.memory.z1d.3xlarge + // - stream.memory.z1d.6xlarge + // - stream.memory.z1d.12xlarge + // - stream.graphics-design.large + // - stream.graphics-design.xlarge + // - stream.graphics-design.2xlarge + // - stream.graphics-design.4xlarge + // - stream.graphics-desktop.2xlarge + // - stream.graphics.g4dn.xlarge + // - stream.graphics.g4dn.2xlarge + // - stream.graphics.g4dn.4xlarge + // - stream.graphics.g4dn.8xlarge + // - stream.graphics.g4dn.12xlarge + // - stream.graphics.g4dn.16xlarge + // - stream.graphics-pro.4xlarge + // - stream.graphics-pro.8xlarge + // - stream.graphics-pro.16xlarge + // The following instance types are available for Elastic fleets: + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.standard.xlarge + // - stream.standard.2xlarge // // This member is required. InstanceType *string @@ -178,8 +120,7 @@ type CreateFleetInput struct { // session with temporary credentials. AppStream 2.0 retrieves the temporary // credentials and creates the appstream_machine_role credential profile on the // instance. For more information, see Using an IAM Role to Grant Permissions to - // Applications and Scripts Running on AppStream 2.0 Streaming Instances - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) + // Applications and Scripts Running on AppStream 2.0 Streaming Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string @@ -225,14 +166,14 @@ type CreateFleetInput struct { // Elastic fleets. Platform types.PlatformType - // The S3 location of the session scripts configuration zip file. This only applies - // to Elastic fleets. + // The S3 location of the session scripts configuration zip file. This only + // applies to Elastic fleets. SessionScriptS3Location *types.S3Location - // The AppStream 2.0 view that is displayed to your users when they stream from the - // fleet. When APP is specified, only the windows of applications opened by users - // display. When DESKTOP is specified, the standard desktop that is provided by the - // operating system displays. The default value is APP. + // The AppStream 2.0 view that is displayed to your users when they stream from + // the fleet. When APP is specified, only the windows of applications opened by + // users display. When DESKTOP is specified, the standard desktop that is provided + // by the operating system displays. The default value is APP . StreamView types.StreamView // The tags to associate with the fleet. A tag is a key-value pair, and the value @@ -240,14 +181,13 @@ type CreateFleetInput struct { // Environment=. If you do not specify a value, the value is set to an empty // string. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ - // For more information, see Tagging Your Resources - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) + // For more information, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string - // The USB device filter strings that specify which USB devices a user can redirect - // to the fleet streaming session, when using the Windows native client. This is - // allowed but not required for Elastic fleets. + // The USB device filter strings that specify which USB devices a user can + // redirect to the fleet streaming session, when using the Windows native client. + // This is allowed but not required for Elastic fleets. UsbDeviceFilterStrings []string // The VPC configuration for the fleet. This is required for Elastic fleets, but diff --git a/service/appstream/api_op_CreateImageBuilder.go b/service/appstream/api_op_CreateImageBuilder.go index b5df23c352f..acd36cbed19 100644 --- a/service/appstream/api_op_CreateImageBuilder.go +++ b/service/appstream/api_op_CreateImageBuilder.go @@ -12,8 +12,8 @@ import ( ) // Creates an image builder. An image builder is a virtual machine that is used to -// create an image. The initial state of the builder is PENDING. When it is ready, -// the state is RUNNING. +// create an image. The initial state of the builder is PENDING . When it is ready, +// the state is RUNNING . func (c *Client) CreateImageBuilder(ctx context.Context, params *CreateImageBuilderInput, optFns ...func(*Options)) (*CreateImageBuilderOutput, error) { if params == nil { params = &CreateImageBuilderInput{} @@ -33,86 +33,39 @@ type CreateImageBuilderInput struct { // The instance type to use when launching the image builder. The following // instance types are available: - // - // * stream.standard.small - // - // * - // stream.standard.medium - // - // * stream.standard.large - // - // * stream.compute.large - // - // * - // stream.compute.xlarge - // - // * stream.compute.2xlarge - // - // * stream.compute.4xlarge - // - // * - // stream.compute.8xlarge - // - // * stream.memory.large - // - // * stream.memory.xlarge - // - // * - // stream.memory.2xlarge - // - // * stream.memory.4xlarge - // - // * stream.memory.8xlarge - // - // * - // stream.memory.z1d.large - // - // * stream.memory.z1d.xlarge - // - // * - // stream.memory.z1d.2xlarge - // - // * stream.memory.z1d.3xlarge - // - // * - // stream.memory.z1d.6xlarge - // - // * stream.memory.z1d.12xlarge - // - // * - // stream.graphics-design.large - // - // * stream.graphics-design.xlarge - // - // * - // stream.graphics-design.2xlarge - // - // * stream.graphics-design.4xlarge - // - // * - // stream.graphics-desktop.2xlarge - // - // * stream.graphics.g4dn.xlarge - // - // * - // stream.graphics.g4dn.2xlarge - // - // * stream.graphics.g4dn.4xlarge - // - // * - // stream.graphics.g4dn.8xlarge - // - // * stream.graphics.g4dn.12xlarge - // - // * - // stream.graphics.g4dn.16xlarge - // - // * stream.graphics-pro.4xlarge - // - // * - // stream.graphics-pro.8xlarge - // - // * stream.graphics-pro.16xlarge + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.compute.large + // - stream.compute.xlarge + // - stream.compute.2xlarge + // - stream.compute.4xlarge + // - stream.compute.8xlarge + // - stream.memory.large + // - stream.memory.xlarge + // - stream.memory.2xlarge + // - stream.memory.4xlarge + // - stream.memory.8xlarge + // - stream.memory.z1d.large + // - stream.memory.z1d.xlarge + // - stream.memory.z1d.2xlarge + // - stream.memory.z1d.3xlarge + // - stream.memory.z1d.6xlarge + // - stream.memory.z1d.12xlarge + // - stream.graphics-design.large + // - stream.graphics-design.xlarge + // - stream.graphics-design.2xlarge + // - stream.graphics-design.4xlarge + // - stream.graphics-desktop.2xlarge + // - stream.graphics.g4dn.xlarge + // - stream.graphics.g4dn.2xlarge + // - stream.graphics.g4dn.4xlarge + // - stream.graphics.g4dn.8xlarge + // - stream.graphics.g4dn.12xlarge + // - stream.graphics.g4dn.16xlarge + // - stream.graphics-pro.4xlarge + // - stream.graphics-pro.8xlarge + // - stream.graphics-pro.16xlarge // // This member is required. InstanceType *string @@ -126,8 +79,8 @@ type CreateImageBuilderInput struct { // can connect to the image builder only through the specified endpoints. AccessEndpoints []types.AccessEndpoint - // The version of the AppStream 2.0 agent to use for this image builder. To use the - // latest version of the AppStream 2.0 agent, specify [LATEST]. + // The version of the AppStream 2.0 agent to use for this image builder. To use + // the latest version of the AppStream 2.0 agent, specify [LATEST]. AppstreamAgentVersion *string // The description to display. @@ -143,15 +96,14 @@ type CreateImageBuilderInput struct { // Enables or disables default internet access for the image builder. EnableDefaultInternetAccess *bool - // The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To - // assume a role, the image builder calls the AWS Security Token Service (STS) + // The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. + // To assume a role, the image builder calls the AWS Security Token Service (STS) // AssumeRole API operation and passes the ARN of the role to use. The operation // creates a new session with temporary credentials. AppStream 2.0 retrieves the // temporary credentials and creates the appstream_machine_role credential profile // on the instance. For more information, see Using an IAM Role to Grant // Permissions to Applications and Scripts Running on AppStream 2.0 Streaming - // Instances - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) + // Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string @@ -161,13 +113,12 @@ type CreateImageBuilderInput struct { // The name of the image used to create the image builder. ImageName *string - // The tags to associate with the image builder. A tag is a key-value pair, and the - // value is optional. For example, Environment=Test. If you do not specify a value, - // Environment=. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following special characters: _ . : / = + \ - @ - // If you do not specify a value, the value is set to an empty string. For more - // information about tags, see Tagging Your Resources - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) + // The tags to associate with the image builder. A tag is a key-value pair, and + // the value is optional. For example, Environment=Test. If you do not specify a + // value, Environment=. Generally allowed characters are: letters, numbers, and + // spaces representable in UTF-8, and the following special characters: _ . : / = + + // \ - @ If you do not specify a value, the value is set to an empty string. For + // more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string diff --git a/service/appstream/api_op_CreateStack.go b/service/appstream/api_op_CreateStack.go index 66ee2c86697..5de19e7c1b3 100644 --- a/service/appstream/api_op_CreateStack.go +++ b/service/appstream/api_op_CreateStack.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a stack to start streaming applications to users. A stack consists of an -// associated fleet, user access policies, and storage configurations. +// Creates a stack to start streaming applications to users. A stack consists of +// an associated fleet, user access policies, and storage configurations. func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error) { if params == nil { params = &CreateStackInput{} @@ -50,13 +50,13 @@ type CreateStackInput struct { // The stack name to display. DisplayName *string - // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. - // You must approve the domains that you want to host embedded AppStream 2.0 - // streaming sessions. + // The domains where AppStream 2.0 streaming sessions can be embedded in an + // iframe. You must approve the domains that you want to host embedded AppStream + // 2.0 streaming sessions. EmbedHostDomains []string - // The URL that users are redirected to after they click the Send Feedback link. If - // no URL is specified, no Send Feedback link is displayed. + // The URL that users are redirected to after they click the Send Feedback link. + // If no URL is specified, no Send Feedback link is displayed. FeedbackURL *string // The URL that users are redirected to after their streaming session ends. @@ -74,8 +74,7 @@ type CreateStackInput struct { // Environment=. If you do not specify a value, the value is set to an empty // string. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ - // For more information about tags, see Tagging Your Resources - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) + // For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. Tags map[string]string diff --git a/service/appstream/api_op_CreateStreamingURL.go b/service/appstream/api_op_CreateStreamingURL.go index 5ae8ff79545..66ec0ed999b 100644 --- a/service/appstream/api_op_CreateStreamingURL.go +++ b/service/appstream/api_op_CreateStreamingURL.go @@ -46,14 +46,13 @@ type CreateStreamingURLInput struct { // This member is required. UserId *string - // The name of the application to launch after the session starts. This is the name - // that you specified as Name in the Image Assistant. If your fleet is enabled for - // the Desktop stream view, you can also choose to launch directly to the operating - // system desktop. To do so, specify Desktop. + // The name of the application to launch after the session starts. This is the + // name that you specified as Name in the Image Assistant. If your fleet is enabled + // for the Desktop stream view, you can also choose to launch directly to the + // operating system desktop. To do so, specify Desktop. ApplicationId *string - // The session context. For more information, see Session Context - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters) + // The session context. For more information, see Session Context (https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters) // in the Amazon AppStream 2.0 Administration Guide. SessionContext *string diff --git a/service/appstream/api_op_CreateUpdatedImage.go b/service/appstream/api_op_CreateUpdatedImage.go index fc25c569eea..1dba7f27638 100644 --- a/service/appstream/api_op_CreateUpdatedImage.go +++ b/service/appstream/api_op_CreateUpdatedImage.go @@ -14,9 +14,8 @@ import ( // Creates a new image with the latest Windows operating system updates, driver // updates, and AppStream 2.0 agent software. For more information, see the "Update // an Image by Using Managed AppStream 2.0 Image Updates" section in Administer -// Your AppStream 2.0 Images -// (https://docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html), -// in the Amazon AppStream 2.0 Administration Guide. +// Your AppStream 2.0 Images (https://docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html) +// , in the Amazon AppStream 2.0 Administration Guide. func (c *Client) CreateUpdatedImage(ctx context.Context, params *CreateUpdatedImageInput, optFns ...func(*Options)) (*CreateUpdatedImageOutput, error) { if params == nil { params = &CreateUpdatedImageInput{} @@ -47,9 +46,9 @@ type CreateUpdatedImageInput struct { // Indicates whether to display the status of image update availability before // AppStream 2.0 initiates the process of creating a new updated image. If this - // value is set to true, AppStream 2.0 displays whether image updates are - // available. If this value is set to false, AppStream 2.0 initiates the process of - // creating a new updated image without displaying whether image updates are + // value is set to true , AppStream 2.0 displays whether image updates are + // available. If this value is set to false , AppStream 2.0 initiates the process + // of creating a new updated image without displaying whether image updates are // available. DryRun bool @@ -64,8 +63,7 @@ type CreateUpdatedImageInput struct { // Environment=. Generally allowed characters are: letters, numbers, and spaces // representable in UTF-8, and the following special characters: _ . : / = + \ - @ // If you do not specify a value, the value is set to an empty string. For more - // information about tags, see Tagging Your Resources - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) + // information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. NewImageTags map[string]string diff --git a/service/appstream/api_op_CreateUser.go b/service/appstream/api_op_CreateUser.go index 18fde2439bb..18d60a4c0e6 100644 --- a/service/appstream/api_op_CreateUser.go +++ b/service/appstream/api_op_CreateUser.go @@ -34,10 +34,10 @@ type CreateUserInput struct { // This member is required. AuthenticationType types.AuthenticationType - // The email address of the user. Users' email addresses are case-sensitive. During - // login, if they specify an email address that doesn't use the same capitalization - // as the email address specified when their user pool account was created, a "user - // does not exist" error message displays. + // The email address of the user. Users' email addresses are case-sensitive. + // During login, if they specify an email address that doesn't use the same + // capitalization as the email address specified when their user pool account was + // created, a "user does not exist" error message displays. // // This member is required. UserName *string diff --git a/service/appstream/api_op_DeleteImage.go b/service/appstream/api_op_DeleteImage.go index d88928f7a4b..ce05cec9b76 100644 --- a/service/appstream/api_op_DeleteImage.go +++ b/service/appstream/api_op_DeleteImage.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified image. You cannot delete an image when it is in use. After -// you delete an image, you cannot provision new capacity using the image. +// Deletes the specified image. You cannot delete an image when it is in use. +// After you delete an image, you cannot provision new capacity using the image. func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error) { if params == nil { params = &DeleteImageInput{} diff --git a/service/appstream/api_op_DescribeFleets.go b/service/appstream/api_op_DescribeFleets.go index 96803b0bb93..b33bbee8b79 100644 --- a/service/appstream/api_op_DescribeFleets.go +++ b/service/appstream/api_op_DescribeFleets.go @@ -16,8 +16,8 @@ import ( "time" ) -// Retrieves a list that describes one or more specified fleets, if the fleet names -// are provided. Otherwise, all fleets in the account are described. +// Retrieves a list that describes one or more specified fleets, if the fleet +// names are provided. Otherwise, all fleets in the account are described. func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput, optFns ...func(*Options)) (*DescribeFleetsOutput, error) { if params == nil { params = &DescribeFleetsInput{} @@ -141,9 +141,9 @@ type FleetStartedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FleetStartedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FleetStartedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -363,9 +363,9 @@ type FleetStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FleetStoppedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FleetStoppedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/appstream/api_op_DescribeImages.go b/service/appstream/api_op_DescribeImages.go index 9eedcb4826d..abb48eddd37 100644 --- a/service/appstream/api_op_DescribeImages.go +++ b/service/appstream/api_op_DescribeImages.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list that describes one or more specified images, if the image names -// or image ARNs are provided. Otherwise, all images in the account are described. +// Retrieves a list that describes one or more specified images, if the image +// names or image ARNs are provided. Otherwise, all images in the account are +// described. func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) { if params == nil { params = &DescribeImagesInput{} diff --git a/service/appstream/api_op_DescribeSessions.go b/service/appstream/api_op_DescribeSessions.go index b94a48b5ab1..ca69eac4ed2 100644 --- a/service/appstream/api_op_DescribeSessions.go +++ b/service/appstream/api_op_DescribeSessions.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list that describes the streaming sessions for a specified stack and -// fleet. If a UserId is provided for the stack and fleet, only streaming sessions -// for that user are described. If an authentication type is not provided, the -// default is to authenticate users using a streaming URL. +// Retrieves a list that describes the streaming sessions for a specified stack +// and fleet. If a UserId is provided for the stack and fleet, only streaming +// sessions for that user are described. If an authentication type is not provided, +// the default is to authenticate users using a streaming URL. func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error) { if params == nil { params = &DescribeSessionsInput{} diff --git a/service/appstream/api_op_DescribeStacks.go b/service/appstream/api_op_DescribeStacks.go index afeaa4c7c81..cfd51a1ec03 100644 --- a/service/appstream/api_op_DescribeStacks.go +++ b/service/appstream/api_op_DescribeStacks.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list that describes one or more specified stacks, if the stack names -// are provided. Otherwise, all stacks in the account are described. +// Retrieves a list that describes one or more specified stacks, if the stack +// names are provided. Otherwise, all stacks in the account are described. func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error) { if params == nil { params = &DescribeStacksInput{} diff --git a/service/appstream/api_op_DescribeUserStackAssociations.go b/service/appstream/api_op_DescribeUserStackAssociations.go index b91faa23f26..d085c521787 100644 --- a/service/appstream/api_op_DescribeUserStackAssociations.go +++ b/service/appstream/api_op_DescribeUserStackAssociations.go @@ -13,12 +13,9 @@ import ( // Retrieves a list that describes the UserStackAssociation objects. You must // specify either or both of the following: -// -// * The stack name -// -// * The user name -// (email address of the user associated with the stack) and the authentication -// type for the user +// - The stack name +// - The user name (email address of the user associated with the stack) and the +// authentication type for the user func (c *Client) DescribeUserStackAssociations(ctx context.Context, params *DescribeUserStackAssociationsInput, optFns ...func(*Options)) (*DescribeUserStackAssociationsOutput, error) { if params == nil { params = &DescribeUserStackAssociationsInput{} diff --git a/service/appstream/api_op_EnableUser.go b/service/appstream/api_op_EnableUser.go index 38908e83fd1..8af5b880454 100644 --- a/service/appstream/api_op_EnableUser.go +++ b/service/appstream/api_op_EnableUser.go @@ -35,10 +35,10 @@ type EnableUserInput struct { // This member is required. AuthenticationType types.AuthenticationType - // The email address of the user. Users' email addresses are case-sensitive. During - // login, if they specify an email address that doesn't use the same capitalization - // as the email address specified when their user pool account was created, a "user - // does not exist" error message displays. + // The email address of the user. Users' email addresses are case-sensitive. + // During login, if they specify an email address that doesn't use the same + // capitalization as the email address specified when their user pool account was + // created, a "user does not exist" error message displays. // // This member is required. UserName *string diff --git a/service/appstream/api_op_ListTagsForResource.go b/service/appstream/api_op_ListTagsForResource.go index 1cabdabac32..3f0e61ea352 100644 --- a/service/appstream/api_op_ListTagsForResource.go +++ b/service/appstream/api_op_ListTagsForResource.go @@ -12,8 +12,7 @@ import ( // Retrieves a list of all tags for the specified AppStream 2.0 resource. You can // tag AppStream 2.0 image builders, images, fleets, and stacks. For more -// information about tags, see Tagging Your Resources -// (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) +// information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/appstream/api_op_StartImageBuilder.go b/service/appstream/api_op_StartImageBuilder.go index 6880b86f976..a7660a14160 100644 --- a/service/appstream/api_op_StartImageBuilder.go +++ b/service/appstream/api_op_StartImageBuilder.go @@ -34,8 +34,8 @@ type StartImageBuilderInput struct { // This member is required. Name *string - // The version of the AppStream 2.0 agent to use for this image builder. To use the - // latest version of the AppStream 2.0 agent, specify [LATEST]. + // The version of the AppStream 2.0 agent to use for this image builder. To use + // the latest version of the AppStream 2.0 agent, specify [LATEST]. AppstreamAgentVersion *string noSmithyDocumentSerde diff --git a/service/appstream/api_op_TagResource.go b/service/appstream/api_op_TagResource.go index a6a975f24c7..7f141b3595c 100644 --- a/service/appstream/api_op_TagResource.go +++ b/service/appstream/api_op_TagResource.go @@ -14,10 +14,9 @@ import ( // You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag // consists of a key and an optional value. If a resource already has a tag with // the same key, this operation updates its value. To list the current tags for -// your resources, use ListTagsForResource. To disassociate tags from your -// resources, use UntagResource. For more information about tags, see Tagging Your -// Resources -// (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) +// your resources, use ListTagsForResource . To disassociate tags from your +// resources, use UntagResource . For more information about tags, see Tagging +// Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -41,11 +40,11 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The tags to associate. A tag is a key-value pair, and the value is optional. For - // example, Environment=Test. If you do not specify a value, Environment=. If you - // do not specify a value, the value is set to an empty string. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following special characters: _ . : / = + \ - @ + // The tags to associate. A tag is a key-value pair, and the value is optional. + // For example, Environment=Test. If you do not specify a value, Environment=. If + // you do not specify a value, the value is set to an empty string. Generally + // allowed characters are: letters, numbers, and spaces representable in UTF-8, and + // the following special characters: _ . : / = + \ - @ // // This member is required. Tags map[string]string diff --git a/service/appstream/api_op_UntagResource.go b/service/appstream/api_op_UntagResource.go index d01fbe92091..07b94815715 100644 --- a/service/appstream/api_op_UntagResource.go +++ b/service/appstream/api_op_UntagResource.go @@ -11,9 +11,8 @@ import ( ) // Disassociates one or more specified tags from the specified AppStream 2.0 -// resource. To list the current tags for your resources, use ListTagsForResource. -// For more information about tags, see Tagging Your Resources -// (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) +// resource. To list the current tags for your resources, use ListTagsForResource . +// For more information about tags, see Tagging Your Resources (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html) // in the Amazon AppStream 2.0 Administration Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/appstream/api_op_UpdateFleet.go b/service/appstream/api_op_UpdateFleet.go index e541fd46dcc..d1915dbfb54 100644 --- a/service/appstream/api_op_UpdateFleet.go +++ b/service/appstream/api_op_UpdateFleet.go @@ -14,19 +14,15 @@ import ( // Updates the specified fleet. If the fleet is in the STOPPED state, you can // update any attribute except the fleet name. If the fleet is in the RUNNING // state, you can update the following based on the fleet type: +// - Always-On and On-Demand fleet types You can update the DisplayName , +// ComputeCapacity , ImageARN , ImageName , IdleDisconnectTimeoutInSeconds , and +// DisconnectTimeoutInSeconds attributes. +// - Elastic fleet type You can update the DisplayName , +// IdleDisconnectTimeoutInSeconds , DisconnectTimeoutInSeconds , +// MaxConcurrentSessions , SessionScriptS3Location and UsbDeviceFilterStrings +// attributes. // -// * Always-On and -// On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, -// ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds -// attributes. -// -// * Elastic fleet type You can update the DisplayName, -// IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, -// MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings -// attributes. -// -// If the fleet is in the STARTING or STOPPED state, you can't update -// it. +// If the fleet is in the STARTING or STOPPED state, you can't update it. func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error) { if params == nil { params = &UpdateFleetInput{} @@ -81,8 +77,7 @@ type UpdateFleetInput struct { // session with temporary credentials. AppStream 2.0 retrieves the temporary // credentials and creates the appstream_machine_role credential profile on the // instance. For more information, see Using an IAM Role to Grant Permissions to - // Applications and Scripts Running on AppStream 2.0 Streaming Instances - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) + // Applications and Scripts Running on AppStream 2.0 Streaming Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string @@ -115,105 +110,47 @@ type UpdateFleetInput struct { // The instance type to use when launching fleet instances. The following instance // types are available: - // - // * stream.standard.small - // - // * stream.standard.medium - // - // * - // stream.standard.large - // - // * stream.standard.xlarge - // - // * stream.standard.2xlarge - // - // * - // stream.compute.large - // - // * stream.compute.xlarge - // - // * stream.compute.2xlarge - // - // * - // stream.compute.4xlarge - // - // * stream.compute.8xlarge - // - // * stream.memory.large - // - // * - // stream.memory.xlarge - // - // * stream.memory.2xlarge - // - // * stream.memory.4xlarge - // - // * - // stream.memory.8xlarge - // - // * stream.memory.z1d.large - // - // * stream.memory.z1d.xlarge - // - // * - // stream.memory.z1d.2xlarge - // - // * stream.memory.z1d.3xlarge - // - // * - // stream.memory.z1d.6xlarge - // - // * stream.memory.z1d.12xlarge - // - // * - // stream.graphics-design.large - // - // * stream.graphics-design.xlarge - // - // * - // stream.graphics-design.2xlarge - // - // * stream.graphics-design.4xlarge - // - // * - // stream.graphics-desktop.2xlarge - // - // * stream.graphics.g4dn.xlarge - // - // * - // stream.graphics.g4dn.2xlarge - // - // * stream.graphics.g4dn.4xlarge - // - // * - // stream.graphics.g4dn.8xlarge - // - // * stream.graphics.g4dn.12xlarge - // - // * - // stream.graphics.g4dn.16xlarge - // - // * stream.graphics-pro.4xlarge - // - // * - // stream.graphics-pro.8xlarge - // - // * stream.graphics-pro.16xlarge - // - // The following - // instance types are available for Elastic fleets: - // - // * stream.standard.small - // - // * - // stream.standard.medium - // - // * stream.standard.large - // - // * stream.standard.xlarge - // - // * - // stream.standard.2xlarge + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.standard.xlarge + // - stream.standard.2xlarge + // - stream.compute.large + // - stream.compute.xlarge + // - stream.compute.2xlarge + // - stream.compute.4xlarge + // - stream.compute.8xlarge + // - stream.memory.large + // - stream.memory.xlarge + // - stream.memory.2xlarge + // - stream.memory.4xlarge + // - stream.memory.8xlarge + // - stream.memory.z1d.large + // - stream.memory.z1d.xlarge + // - stream.memory.z1d.2xlarge + // - stream.memory.z1d.3xlarge + // - stream.memory.z1d.6xlarge + // - stream.memory.z1d.12xlarge + // - stream.graphics-design.large + // - stream.graphics-design.xlarge + // - stream.graphics-design.2xlarge + // - stream.graphics-design.4xlarge + // - stream.graphics-desktop.2xlarge + // - stream.graphics.g4dn.xlarge + // - stream.graphics.g4dn.2xlarge + // - stream.graphics.g4dn.4xlarge + // - stream.graphics.g4dn.8xlarge + // - stream.graphics.g4dn.12xlarge + // - stream.graphics.g4dn.16xlarge + // - stream.graphics-pro.4xlarge + // - stream.graphics-pro.8xlarge + // - stream.graphics-pro.16xlarge + // The following instance types are available for Elastic fleets: + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.standard.xlarge + // - stream.standard.2xlarge InstanceType *string // The maximum number of concurrent sessions for a fleet. @@ -233,19 +170,19 @@ type UpdateFleetInput struct { // for Elastic fleets. Platform types.PlatformType - // The S3 location of the session scripts configuration zip file. This only applies - // to Elastic fleets. + // The S3 location of the session scripts configuration zip file. This only + // applies to Elastic fleets. SessionScriptS3Location *types.S3Location - // The AppStream 2.0 view that is displayed to your users when they stream from the - // fleet. When APP is specified, only the windows of applications opened by users - // display. When DESKTOP is specified, the standard desktop that is provided by the - // operating system displays. The default value is APP. + // The AppStream 2.0 view that is displayed to your users when they stream from + // the fleet. When APP is specified, only the windows of applications opened by + // users display. When DESKTOP is specified, the standard desktop that is provided + // by the operating system displays. The default value is APP . StreamView types.StreamView - // The USB device filter strings that specify which USB devices a user can redirect - // to the fleet streaming session, when using the Windows native client. This is - // allowed but not required for Elastic fleets. + // The USB device filter strings that specify which USB devices a user can + // redirect to the fleet streaming session, when using the Windows native client. + // This is allowed but not required for Elastic fleets. UsbDeviceFilterStrings []string // The VPC configuration for the fleet. This is required for Elastic fleets, but diff --git a/service/appstream/api_op_UpdateStack.go b/service/appstream/api_op_UpdateStack.go index 2ed834c1919..4992d27e2ae 100644 --- a/service/appstream/api_op_UpdateStack.go +++ b/service/appstream/api_op_UpdateStack.go @@ -57,9 +57,9 @@ type UpdateStackInput struct { // The stack name to display. DisplayName *string - // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. - // You must approve the domains that you want to host embedded AppStream 2.0 - // streaming sessions. + // The domains where AppStream 2.0 streaming sessions can be embedded in an + // iframe. You must approve the domains that you want to host embedded AppStream + // 2.0 streaming sessions. EmbedHostDomains []string // The URL that users are redirected to after they choose the Send Feedback link. diff --git a/service/appstream/doc.go b/service/appstream/doc.go index c995b7072ab..4b3e2647efb 100644 --- a/service/appstream/doc.go +++ b/service/appstream/doc.go @@ -12,14 +12,9 @@ // access to your users on demand. You can call the AppStream 2.0 API operations by // using an interface VPC endpoint (interface endpoint). For more information, see // Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC -// Endpoint -// (https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html) +// Endpoint (https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html) // in the Amazon AppStream 2.0 Administration Guide. To learn more about AppStream // 2.0, see the following resources: -// -// * Amazon AppStream 2.0 product page -// (http://aws.amazon.com/appstream2) -// -// * Amazon AppStream 2.0 documentation -// (http://aws.amazon.com/documentation/appstream2) +// - Amazon AppStream 2.0 product page (http://aws.amazon.com/appstream2) +// - Amazon AppStream 2.0 documentation (http://aws.amazon.com/documentation/appstream2) package appstream diff --git a/service/appstream/types/enums.go b/service/appstream/types/enums.go index dff73b7a464..f68a49df0b3 100644 --- a/service/appstream/types/enums.go +++ b/service/appstream/types/enums.go @@ -255,9 +255,9 @@ const ( FleetTypeElastic FleetType = "ELASTIC" ) -// Values returns all known values for FleetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FleetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FleetType) Values() []FleetType { return []FleetType{ "ALWAYS_ON", @@ -310,8 +310,8 @@ const ( ImageBuilderStateChangeReasonCodeImageUnavailable ImageBuilderStateChangeReasonCode = "IMAGE_UNAVAILABLE" ) -// Values returns all known values for ImageBuilderStateChangeReasonCode. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for ImageBuilderStateChangeReasonCode. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (ImageBuilderStateChangeReasonCode) Values() []ImageBuilderStateChangeReasonCode { @@ -415,9 +415,9 @@ const ( PlatformTypeAmazonLinux2 PlatformType = "AMAZON_LINUX2" ) -// Values returns all known values for PlatformType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PlatformType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PlatformType) Values() []PlatformType { return []PlatformType{ "WINDOWS", @@ -472,9 +472,9 @@ const ( SessionStateExpired SessionState = "EXPIRED" ) -// Values returns all known values for SessionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SessionState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SessionState) Values() []SessionState { return []SessionState{ "ACTIVE", diff --git a/service/appstream/types/types.go b/service/appstream/types/types.go index a6e15b64e8e..fd8fdf7e7ef 100644 --- a/service/appstream/types/types.go +++ b/service/appstream/types/types.go @@ -265,8 +265,8 @@ type DomainJoinInfo struct { noSmithyDocumentSerde } -// The application associated to an entitlement. Access is controlled based on user -// attributes. +// The application associated to an entitlement. Access is controlled based on +// user attributes. type EntitledApplication struct { // The identifier of the application. @@ -325,21 +325,13 @@ type EntitlementAttribute struct { // A supported AWS IAM SAML PrincipalTag attribute that is matched to the // associated value when a user identity federates into an Amazon AppStream 2.0 // SAML application. The following are valid values: - // - // * roles - // - // * department - // - // * - // organization - // - // * groups - // - // * title - // - // * costCenter - // - // * userType + // - roles + // - department + // - organization + // - groups + // - title + // - costCenter + // - userType // // This member is required. Name *string @@ -368,86 +360,39 @@ type Fleet struct { // The instance type to use when launching fleet instances. The following instance // types are available: - // - // * stream.standard.small - // - // * stream.standard.medium - // - // * - // stream.standard.large - // - // * stream.compute.large - // - // * stream.compute.xlarge - // - // * - // stream.compute.2xlarge - // - // * stream.compute.4xlarge - // - // * stream.compute.8xlarge - // - // * - // stream.memory.large - // - // * stream.memory.xlarge - // - // * stream.memory.2xlarge - // - // * - // stream.memory.4xlarge - // - // * stream.memory.8xlarge - // - // * stream.memory.z1d.large - // - // * - // stream.memory.z1d.xlarge - // - // * stream.memory.z1d.2xlarge - // - // * - // stream.memory.z1d.3xlarge - // - // * stream.memory.z1d.6xlarge - // - // * - // stream.memory.z1d.12xlarge - // - // * stream.graphics-design.large - // - // * - // stream.graphics-design.xlarge - // - // * stream.graphics-design.2xlarge - // - // * - // stream.graphics-design.4xlarge - // - // * stream.graphics-desktop.2xlarge - // - // * - // stream.graphics.g4dn.xlarge - // - // * stream.graphics.g4dn.2xlarge - // - // * - // stream.graphics.g4dn.4xlarge - // - // * stream.graphics.g4dn.8xlarge - // - // * - // stream.graphics.g4dn.12xlarge - // - // * stream.graphics.g4dn.16xlarge - // - // * - // stream.graphics-pro.4xlarge - // - // * stream.graphics-pro.8xlarge - // - // * - // stream.graphics-pro.16xlarge + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.compute.large + // - stream.compute.xlarge + // - stream.compute.2xlarge + // - stream.compute.4xlarge + // - stream.compute.8xlarge + // - stream.memory.large + // - stream.memory.xlarge + // - stream.memory.2xlarge + // - stream.memory.4xlarge + // - stream.memory.8xlarge + // - stream.memory.z1d.large + // - stream.memory.z1d.xlarge + // - stream.memory.z1d.2xlarge + // - stream.memory.z1d.3xlarge + // - stream.memory.z1d.6xlarge + // - stream.memory.z1d.12xlarge + // - stream.graphics-design.large + // - stream.graphics-design.xlarge + // - stream.graphics-design.2xlarge + // - stream.graphics-design.4xlarge + // - stream.graphics-desktop.2xlarge + // - stream.graphics.g4dn.xlarge + // - stream.graphics.g4dn.2xlarge + // - stream.graphics.g4dn.4xlarge + // - stream.graphics.g4dn.8xlarge + // - stream.graphics.g4dn.12xlarge + // - stream.graphics.g4dn.16xlarge + // - stream.graphics-pro.4xlarge + // - stream.graphics-pro.8xlarge + // - stream.graphics-pro.16xlarge // // This member is required. InstanceType *string @@ -502,8 +447,7 @@ type Fleet struct { // session with temporary credentials. AppStream 2.0 retrieves the temporary // credentials and creates the appstream_machine_role credential profile on the // instance. For more information, see Using an IAM Role to Grant Permissions to - // Applications and Scripts Running on AppStream 2.0 Streaming Instances - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) + // Applications and Scripts Running on AppStream 2.0 Streaming Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string @@ -547,14 +491,14 @@ type Fleet struct { // The platform of the fleet. Platform PlatformType - // The S3 location of the session scripts configuration zip file. This only applies - // to Elastic fleets. + // The S3 location of the session scripts configuration zip file. This only + // applies to Elastic fleets. SessionScriptS3Location *S3Location - // The AppStream 2.0 view that is displayed to your users when they stream from the - // fleet. When APP is specified, only the windows of applications opened by users - // display. When DESKTOP is specified, the standard desktop that is provided by the - // operating system displays. The default value is APP. + // The AppStream 2.0 view that is displayed to your users when they stream from + // the fleet. When APP is specified, only the windows of applications opened by + // users display. When DESKTOP is specified, the standard desktop that is provided + // by the operating system displays. The default value is APP . StreamView StreamView // The USB device filter strings associated with the fleet. @@ -630,7 +574,7 @@ type Image struct { PublicBaseImageReleasedDate *time.Time // The image starts in the PENDING state. If image creation succeeds, the state is - // AVAILABLE. If image creation fails, the state is FAILED. + // AVAILABLE . If image creation fails, the state is FAILED . State ImageState // The reason why the last state change occurred. @@ -655,8 +599,8 @@ type ImageBuilder struct { // endpoints. AccessEndpoints []AccessEndpoint - // The version of the AppStream 2.0 agent that is currently being used by the image - // builder. + // The version of the AppStream 2.0 agent that is currently being used by the + // image builder. AppstreamAgentVersion *string // The ARN for the image builder. @@ -684,8 +628,7 @@ type ImageBuilder struct { // session with temporary credentials. AppStream 2.0 retrieves the temporary // credentials and creates the appstream_machine_role credential profile on the // instance. For more information, see Using an IAM Role to Grant Permissions to - // Applications and Scripts Running on AppStream 2.0 Streaming Instances - // (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) + // Applications and Scripts Running on AppStream 2.0 Streaming Instances (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html) // in the Amazon AppStream 2.0 Administration Guide. IamRoleArn *string @@ -697,86 +640,39 @@ type ImageBuilder struct { // The instance type for the image builder. The following instance types are // available: - // - // * stream.standard.small - // - // * stream.standard.medium - // - // * - // stream.standard.large - // - // * stream.compute.large - // - // * stream.compute.xlarge - // - // * - // stream.compute.2xlarge - // - // * stream.compute.4xlarge - // - // * stream.compute.8xlarge - // - // * - // stream.memory.large - // - // * stream.memory.xlarge - // - // * stream.memory.2xlarge - // - // * - // stream.memory.4xlarge - // - // * stream.memory.8xlarge - // - // * stream.memory.z1d.large - // - // * - // stream.memory.z1d.xlarge - // - // * stream.memory.z1d.2xlarge - // - // * - // stream.memory.z1d.3xlarge - // - // * stream.memory.z1d.6xlarge - // - // * - // stream.memory.z1d.12xlarge - // - // * stream.graphics-design.large - // - // * - // stream.graphics-design.xlarge - // - // * stream.graphics-design.2xlarge - // - // * - // stream.graphics-design.4xlarge - // - // * stream.graphics-desktop.2xlarge - // - // * - // stream.graphics.g4dn.xlarge - // - // * stream.graphics.g4dn.2xlarge - // - // * - // stream.graphics.g4dn.4xlarge - // - // * stream.graphics.g4dn.8xlarge - // - // * - // stream.graphics.g4dn.12xlarge - // - // * stream.graphics.g4dn.16xlarge - // - // * - // stream.graphics-pro.4xlarge - // - // * stream.graphics-pro.8xlarge - // - // * - // stream.graphics-pro.16xlarge + // - stream.standard.small + // - stream.standard.medium + // - stream.standard.large + // - stream.compute.large + // - stream.compute.xlarge + // - stream.compute.2xlarge + // - stream.compute.4xlarge + // - stream.compute.8xlarge + // - stream.memory.large + // - stream.memory.xlarge + // - stream.memory.2xlarge + // - stream.memory.4xlarge + // - stream.memory.8xlarge + // - stream.memory.z1d.large + // - stream.memory.z1d.xlarge + // - stream.memory.z1d.2xlarge + // - stream.memory.z1d.3xlarge + // - stream.memory.z1d.6xlarge + // - stream.memory.z1d.12xlarge + // - stream.graphics-design.large + // - stream.graphics-design.xlarge + // - stream.graphics-design.2xlarge + // - stream.graphics-design.4xlarge + // - stream.graphics-desktop.2xlarge + // - stream.graphics.g4dn.xlarge + // - stream.graphics.g4dn.2xlarge + // - stream.graphics.g4dn.4xlarge + // - stream.graphics.g4dn.8xlarge + // - stream.graphics.g4dn.12xlarge + // - stream.graphics.g4dn.16xlarge + // - stream.graphics-pro.4xlarge + // - stream.graphics-pro.8xlarge + // - stream.graphics-pro.16xlarge InstanceType *string // Describes the network details of the fleet or image builder instance. @@ -964,8 +860,8 @@ type Session struct { // This member is required. UserId *string - // The authentication method. The user is authenticated using a streaming URL (API) - // or SAML 2.0 federation (SAML). + // The authentication method. The user is authenticated using a streaming URL ( API + // ) or SAML 2.0 federation ( SAML ). AuthenticationType AuthenticationType // Specifies whether a user is connected to the streaming session. @@ -974,7 +870,7 @@ type Session struct { // The time when the streaming session is set to expire. This time is based on the // MaxUserDurationinSeconds value, which determines the maximum length of time that // a streaming session can run. A streaming session might end earlier than the time - // specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds + // specified in SessionMaxExpirationTime , when the DisconnectTimeOutInSeconds // elapses or the user chooses to end his or her session. If the // DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her // session, the streaming instance is terminated and the streaming session ends. @@ -1014,8 +910,8 @@ type Stack struct { // This member is required. Name *string - // The list of virtual private cloud (VPC) interface endpoint objects. Users of the - // stack can connect to AppStream 2.0 only through the specified endpoints. + // The list of virtual private cloud (VPC) interface endpoint objects. Users of + // the stack can connect to AppStream 2.0 only through the specified endpoints. AccessEndpoints []AccessEndpoint // The persistent application settings for users of the stack. @@ -1033,13 +929,13 @@ type Stack struct { // The stack name to display. DisplayName *string - // The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. - // You must approve the domains that you want to host embedded AppStream 2.0 - // streaming sessions. + // The domains where AppStream 2.0 streaming sessions can be embedded in an + // iframe. You must approve the domains that you want to host embedded AppStream + // 2.0 streaming sessions. EmbedHostDomains []string - // The URL that users are redirected to after they click the Send Feedback link. If - // no URL is specified, no Send Feedback link is displayed. + // The URL that users are redirected to after they click the Send Feedback link. + // If no URL is specified, no Send Feedback link is displayed. FeedbackURL *string // The URL that users are redirected to after their streaming session ends. @@ -1150,19 +1046,11 @@ type User struct { // The status of the user in the user pool. The status can be one of the // following: - // - // * UNCONFIRMED – The user is created but not confirmed. - // - // * CONFIRMED - // – The user is confirmed. - // - // * ARCHIVED – The user is no longer active. - // - // * - // COMPROMISED – The user is disabled because of a potential security threat. - // - // * - // UNKNOWN – The user status is not known. + // - UNCONFIRMED – The user is created but not confirmed. + // - CONFIRMED – The user is confirmed. + // - ARCHIVED – The user is no longer active. + // - COMPROMISED – The user is disabled because of a potential security threat. + // - UNKNOWN – The user status is not known. Status *string // The email address of the user. Users' email addresses are case-sensitive. @@ -1207,8 +1095,8 @@ type UserStackAssociation struct { // This member is required. UserName *string - // Specifies whether a welcome email is sent to a user after the user is created in - // the user pool. + // Specifies whether a welcome email is sent to a user after the user is created + // in the user pool. SendEmailNotification bool noSmithyDocumentSerde @@ -1222,8 +1110,8 @@ type UserStackAssociationError struct { // with or disassociated from a stack. ErrorCode UserStackAssociationErrorCode - // The error message for the error that is returned when a user can’t be associated - // with or disassociated from a stack. + // The error message for the error that is returned when a user can’t be + // associated with or disassociated from a stack. ErrorMessage *string // Information about the user and associated stack. @@ -1238,8 +1126,8 @@ type VpcConfig struct { // The identifiers of the security groups for the fleet or image builder. SecurityGroupIds []string - // The identifiers of the subnets to which a network interface is attached from the - // fleet instance or image builder instance. Fleet instances use one or more + // The identifiers of the subnets to which a network interface is attached from + // the fleet instance or image builder instance. Fleet instances use one or more // subnets. Image builder instances use one subnet. SubnetIds []string diff --git a/service/appsync/api_client.go b/service/appsync/api_client.go index f665f07a2d2..70980320d28 100644 --- a/service/appsync/api_client.go +++ b/service/appsync/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/appsync/api_op_CreateApiCache.go b/service/appsync/api_op_CreateApiCache.go index 3b985b35917..48413c959a8 100644 --- a/service/appsync/api_op_CreateApiCache.go +++ b/service/appsync/api_op_CreateApiCache.go @@ -31,11 +31,8 @@ func (c *Client) CreateApiCache(ctx context.Context, params *CreateApiCacheInput type CreateApiCacheInput struct { // Caching behavior. - // - // * FULL_REQUEST_CACHING: All requests are fully cached. - // - // * - // PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. + // - FULL_REQUEST_CACHING: All requests are fully cached. + // - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. // // This member is required. ApiCachingBehavior types.ApiCachingBehavior @@ -51,46 +48,24 @@ type CreateApiCacheInput struct { Ttl int64 // The cache instance type. Valid values are - // - // * SMALL - // - // * MEDIUM - // - // * LARGE - // - // * - // XLARGE - // - // * LARGE_2X - // - // * LARGE_4X - // - // * LARGE_8X (not available in all regions) - // - // * - // LARGE_12X - // - // Historically, instance types were identified by an EC2-style value. - // As of July 2020, this is deprecated, and the generic identifiers above should be - // used. The following legacy instance types are available, but their use is - // discouraged: - // - // * T2_SMALL: A t2.small instance type. - // - // * T2_MEDIUM: A t2.medium - // instance type. - // - // * R4_LARGE: A r4.large instance type. - // - // * R4_XLARGE: A r4.xlarge - // instance type. - // - // * R4_2XLARGE: A r4.2xlarge instance type. - // - // * R4_4XLARGE: A - // r4.4xlarge instance type. - // - // * R4_8XLARGE: A r4.8xlarge instance type. + // - SMALL + // - MEDIUM + // - LARGE + // - XLARGE + // - LARGE_2X + // - LARGE_4X + // - LARGE_8X (not available in all regions) + // - LARGE_12X + // Historically, instance types were identified by an EC2-style value. As of July + // 2020, this is deprecated, and the generic identifiers above should be used. The + // following legacy instance types are available, but their use is discouraged: + // - T2_SMALL: A t2.small instance type. + // - T2_MEDIUM: A t2.medium instance type. + // - R4_LARGE: A r4.large instance type. + // - R4_XLARGE: A r4.xlarge instance type. + // - R4_2XLARGE: A r4.2xlarge instance type. + // - R4_4XLARGE: A r4.4xlarge instance type. + // - R4_8XLARGE: A r4.8xlarge instance type. // // This member is required. Type types.ApiCacheType @@ -99,8 +74,8 @@ type CreateApiCacheInput struct { // creation. AtRestEncryptionEnabled bool - // Transit encryption flag when connecting to cache. You cannot update this setting - // after creation. + // Transit encryption flag when connecting to cache. You cannot update this + // setting after creation. TransitEncryptionEnabled bool noSmithyDocumentSerde diff --git a/service/appsync/api_op_CreateDataSource.go b/service/appsync/api_op_CreateDataSource.go index 443c70c3568..900a57f3233 100644 --- a/service/appsync/api_op_CreateDataSource.go +++ b/service/appsync/api_op_CreateDataSource.go @@ -29,22 +29,22 @@ func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceI type CreateDataSourceInput struct { - // The API ID for the GraphQL API for the DataSource. + // The API ID for the GraphQL API for the DataSource . // // This member is required. ApiId *string - // A user-supplied name for the DataSource. + // A user-supplied name for the DataSource . // // This member is required. Name *string - // The type of the DataSource. + // The type of the DataSource . // // This member is required. Type types.DataSourceType - // A description of the DataSource. + // A description of the DataSource . Description *string // Amazon DynamoDB settings. @@ -71,8 +71,8 @@ type CreateDataSourceInput struct { // Relational database settings. RelationalDatabaseConfig *types.RelationalDatabaseDataSourceConfig - // The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) - // for the data source. The system assumes this role when accessing the data + // The Identity and Access Management (IAM) service role Amazon Resource Name + // (ARN) for the data source. The system assumes this role when accessing the data // source. ServiceRoleArn *string diff --git a/service/appsync/api_op_CreateDomainName.go b/service/appsync/api_op_CreateDomainName.go index ab4d9663d0b..d1ab4ab9620 100644 --- a/service/appsync/api_op_CreateDomainName.go +++ b/service/appsync/api_op_CreateDomainName.go @@ -41,7 +41,7 @@ type CreateDomainNameInput struct { // This member is required. DomainName *string - // A description of the DomainName. + // A description of the DomainName . Description *string noSmithyDocumentSerde @@ -49,7 +49,7 @@ type CreateDomainNameInput struct { type CreateDomainNameOutput struct { - // The configuration for the DomainName. + // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_CreateFunction.go b/service/appsync/api_op_CreateFunction.go index 8280d3a60c1..364d0f47f4c 100644 --- a/service/appsync/api_op_CreateFunction.go +++ b/service/appsync/api_op_CreateFunction.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Function object. A function is a reusable entity. You can use multiple -// functions to compose the resolver logic. +// Creates a Function object. A function is a reusable entity. You can use +// multiple functions to compose the resolver logic. func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error) { if params == nil { params = &CreateFunctionInput{} @@ -35,7 +35,7 @@ type CreateFunctionInput struct { // This member is required. ApiId *string - // The FunctionDataSource name. + // The Function DataSource name. // // This member is required. DataSourceName *string @@ -45,8 +45,8 @@ type CreateFunctionInput struct { // This member is required. Name *string - // The function code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The function code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string // The Function description. diff --git a/service/appsync/api_op_CreateGraphqlApi.go b/service/appsync/api_op_CreateGraphqlApi.go index 80511d3384d..d6176422858 100644 --- a/service/appsync/api_op_CreateGraphqlApi.go +++ b/service/appsync/api_op_CreateGraphqlApi.go @@ -35,7 +35,7 @@ type CreateGraphqlApiInput struct { // This member is required. AuthenticationType types.AuthenticationType - // A user-supplied name for the GraphqlApi. + // A user-supplied name for the GraphqlApi . // // This member is required. Name *string @@ -58,7 +58,7 @@ type CreateGraphqlApiInput struct { // The Amazon Cognito user pool configuration. UserPoolConfig *types.UserPoolConfig - // A flag indicating whether to use X-Ray tracing for the GraphqlApi. + // A flag indicating whether to use X-Ray tracing for the GraphqlApi . XrayEnabled bool noSmithyDocumentSerde @@ -66,7 +66,7 @@ type CreateGraphqlApiInput struct { type CreateGraphqlApiOutput struct { - // The GraphqlApi. + // The GraphqlApi . GraphqlApi *types.GraphqlApi // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_CreateResolver.go b/service/appsync/api_op_CreateResolver.go index 7bb389d3ee6..2e657fbc339 100644 --- a/service/appsync/api_op_CreateResolver.go +++ b/service/appsync/api_op_CreateResolver.go @@ -41,7 +41,7 @@ type CreateResolverInput struct { // This member is required. FieldName *string - // The name of the Type. + // The name of the Type . // // This member is required. TypeName *string @@ -49,29 +49,26 @@ type CreateResolverInput struct { // The caching configuration for the resolver. CachingConfig *types.CachingConfig - // The resolver code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The resolver code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string // The name of the data source for which the resolver is being created. DataSourceName *string // The resolver type. + // - UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. + // You can use a UNIT resolver to run a GraphQL query against a single data source. // - // * UNIT: A UNIT resolver type. A UNIT resolver is the default - // resolver type. You can use a UNIT resolver to run a GraphQL query against a - // single data source. - // - // * PIPELINE: A PIPELINE resolver type. You can use a - // PIPELINE resolver to invoke a series of Function objects in a serial manner. You - // can use a pipeline resolver to run a GraphQL query against multiple data - // sources. + // - PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to + // invoke a series of Function objects in a serial manner. You can use a pipeline + // resolver to run a GraphQL query against multiple data sources. Kind types.ResolverKind // The maximum batching size for a resolver. MaxBatchSize int32 - // The PipelineConfig. + // The PipelineConfig . PipelineConfig *types.PipelineConfig // The mapping template to use for requests. A resolver uses a request mapping diff --git a/service/appsync/api_op_CreateType.go b/service/appsync/api_op_CreateType.go index 13488fc97bc..89e8c309cdb 100644 --- a/service/appsync/api_op_CreateType.go +++ b/service/appsync/api_op_CreateType.go @@ -35,8 +35,8 @@ type CreateTypeInput struct { ApiId *string // The type definition, in GraphQL Schema Definition Language (SDL) format. For - // more information, see the GraphQL SDL documentation - // (http://graphql.org/learn/schema/). + // more information, see the GraphQL SDL documentation (http://graphql.org/learn/schema/) + // . // // This member is required. Definition *string diff --git a/service/appsync/api_op_DeleteFunction.go b/service/appsync/api_op_DeleteFunction.go index b820fcb9e62..d0158a411d9 100644 --- a/service/appsync/api_op_DeleteFunction.go +++ b/service/appsync/api_op_DeleteFunction.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Function. +// Deletes a Function . func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error) { if params == nil { params = &DeleteFunctionInput{} diff --git a/service/appsync/api_op_EvaluateCode.go b/service/appsync/api_op_EvaluateCode.go index accba2842c9..ea0b2e5331a 100644 --- a/service/appsync/api_op_EvaluateCode.go +++ b/service/appsync/api_op_EvaluateCode.go @@ -36,7 +36,7 @@ func (c *Client) EvaluateCode(ctx context.Context, params *EvaluateCodeInput, op type EvaluateCodeInput struct { // The code definition to be evaluated. Note that code and runtime are both - // required for this action. The runtime value must be APPSYNC_JS. + // required for this action. The runtime value must be APPSYNC_JS . // // This member is required. Code *string @@ -54,7 +54,7 @@ type EvaluateCodeInput struct { Runtime *types.AppSyncRuntime // The function within the code to be evaluated. If provided, the valid values are - // request and response. + // request and response . Function *string noSmithyDocumentSerde diff --git a/service/appsync/api_op_EvaluateMappingTemplate.go b/service/appsync/api_op_EvaluateMappingTemplate.go index 1f8b8155a16..4e71196def1 100644 --- a/service/appsync/api_op_EvaluateMappingTemplate.go +++ b/service/appsync/api_op_EvaluateMappingTemplate.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Evaluates a given template and returns the response. The mapping template can be -// a request or response template. Request templates take the incoming request +// Evaluates a given template and returns the response. The mapping template can +// be a request or response template. Request templates take the incoming request // after a GraphQL operation is parsed and convert it into a request configuration // for the selected data source operation. Response templates interpret responses // from the data source and map it to the shape of the GraphQL field output type. diff --git a/service/appsync/api_op_GetDomainName.go b/service/appsync/api_op_GetDomainName.go index e872e7d0b07..addd8b659bd 100644 --- a/service/appsync/api_op_GetDomainName.go +++ b/service/appsync/api_op_GetDomainName.go @@ -39,7 +39,7 @@ type GetDomainNameInput struct { type GetDomainNameOutput struct { - // The configuration for the DomainName. + // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_GetFunction.go b/service/appsync/api_op_GetFunction.go index aff855c9e41..437537241d3 100644 --- a/service/appsync/api_op_GetFunction.go +++ b/service/appsync/api_op_GetFunction.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get a Function. +// Get a Function . func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optFns ...func(*Options)) (*GetFunctionOutput, error) { if params == nil { params = &GetFunctionInput{} diff --git a/service/appsync/api_op_GetIntrospectionSchema.go b/service/appsync/api_op_GetIntrospectionSchema.go index ef35ecb9f2a..f2db84f6f19 100644 --- a/service/appsync/api_op_GetIntrospectionSchema.go +++ b/service/appsync/api_op_GetIntrospectionSchema.go @@ -49,8 +49,8 @@ type GetIntrospectionSchemaInput struct { type GetIntrospectionSchemaOutput struct { // The schema, in GraphQL Schema Definition Language (SDL) format. For more - // information, see the GraphQL SDL documentation - // (http://graphql.org/learn/schema/). + // information, see the GraphQL SDL documentation (http://graphql.org/learn/schema/) + // . Schema []byte // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_UpdateApiCache.go b/service/appsync/api_op_UpdateApiCache.go index 25611699122..c93af0b5e3e 100644 --- a/service/appsync/api_op_UpdateApiCache.go +++ b/service/appsync/api_op_UpdateApiCache.go @@ -31,11 +31,8 @@ func (c *Client) UpdateApiCache(ctx context.Context, params *UpdateApiCacheInput type UpdateApiCacheInput struct { // Caching behavior. - // - // * FULL_REQUEST_CACHING: All requests are fully cached. - // - // * - // PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. + // - FULL_REQUEST_CACHING: All requests are fully cached. + // - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. // // This member is required. ApiCachingBehavior types.ApiCachingBehavior @@ -51,46 +48,24 @@ type UpdateApiCacheInput struct { Ttl int64 // The cache instance type. Valid values are - // - // * SMALL - // - // * MEDIUM - // - // * LARGE - // - // * - // XLARGE - // - // * LARGE_2X - // - // * LARGE_4X - // - // * LARGE_8X (not available in all regions) - // - // * - // LARGE_12X - // - // Historically, instance types were identified by an EC2-style value. - // As of July 2020, this is deprecated, and the generic identifiers above should be - // used. The following legacy instance types are available, but their use is - // discouraged: - // - // * T2_SMALL: A t2.small instance type. - // - // * T2_MEDIUM: A t2.medium - // instance type. - // - // * R4_LARGE: A r4.large instance type. - // - // * R4_XLARGE: A r4.xlarge - // instance type. - // - // * R4_2XLARGE: A r4.2xlarge instance type. - // - // * R4_4XLARGE: A - // r4.4xlarge instance type. - // - // * R4_8XLARGE: A r4.8xlarge instance type. + // - SMALL + // - MEDIUM + // - LARGE + // - XLARGE + // - LARGE_2X + // - LARGE_4X + // - LARGE_8X (not available in all regions) + // - LARGE_12X + // Historically, instance types were identified by an EC2-style value. As of July + // 2020, this is deprecated, and the generic identifiers above should be used. The + // following legacy instance types are available, but their use is discouraged: + // - T2_SMALL: A t2.small instance type. + // - T2_MEDIUM: A t2.medium instance type. + // - R4_LARGE: A r4.large instance type. + // - R4_XLARGE: A r4.xlarge instance type. + // - R4_2XLARGE: A r4.2xlarge instance type. + // - R4_4XLARGE: A r4.4xlarge instance type. + // - R4_8XLARGE: A r4.8xlarge instance type. // // This member is required. Type types.ApiCacheType diff --git a/service/appsync/api_op_UpdateDataSource.go b/service/appsync/api_op_UpdateDataSource.go index bbbeedeaa5e..87f685bb7d9 100644 --- a/service/appsync/api_op_UpdateDataSource.go +++ b/service/appsync/api_op_UpdateDataSource.go @@ -52,8 +52,8 @@ type UpdateDataSourceInput struct { // The new OpenSearch configuration. As of September 2021, Amazon Elasticsearch // service is Amazon OpenSearch Service. This configuration is deprecated. Instead, - // use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data - // source. + // use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch + // data source. ElasticsearchConfig *types.ElasticsearchDataSourceConfig // The new Amazon EventBridge settings. diff --git a/service/appsync/api_op_UpdateDomainName.go b/service/appsync/api_op_UpdateDomainName.go index 853354d3bae..673955ef27c 100644 --- a/service/appsync/api_op_UpdateDomainName.go +++ b/service/appsync/api_op_UpdateDomainName.go @@ -34,7 +34,7 @@ type UpdateDomainNameInput struct { // This member is required. DomainName *string - // A description of the DomainName. + // A description of the DomainName . Description *string noSmithyDocumentSerde @@ -42,7 +42,7 @@ type UpdateDomainNameInput struct { type UpdateDomainNameOutput struct { - // The configuration for the DomainName. + // The configuration for the DomainName . DomainNameConfig *types.DomainNameConfig // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_UpdateFunction.go b/service/appsync/api_op_UpdateFunction.go index 3034fc15a71..7a0e68ab2bf 100644 --- a/service/appsync/api_op_UpdateFunction.go +++ b/service/appsync/api_op_UpdateFunction.go @@ -34,7 +34,7 @@ type UpdateFunctionInput struct { // This member is required. ApiId *string - // The FunctionDataSource name. + // The Function DataSource name. // // This member is required. DataSourceName *string @@ -49,8 +49,8 @@ type UpdateFunctionInput struct { // This member is required. Name *string - // The function code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The function code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string // The Function description. diff --git a/service/appsync/api_op_UpdateGraphqlApi.go b/service/appsync/api_op_UpdateGraphqlApi.go index b7252beba02..10183f1702d 100644 --- a/service/appsync/api_op_UpdateGraphqlApi.go +++ b/service/appsync/api_op_UpdateGraphqlApi.go @@ -57,7 +57,7 @@ type UpdateGraphqlApiInput struct { // The new Amazon Cognito user pool configuration for the ~GraphqlApi object. UserPoolConfig *types.UserPoolConfig - // A flag indicating whether to use X-Ray tracing for the GraphqlApi. + // A flag indicating whether to use X-Ray tracing for the GraphqlApi . XrayEnabled bool noSmithyDocumentSerde diff --git a/service/appsync/api_op_UpdateResolver.go b/service/appsync/api_op_UpdateResolver.go index c30e5049197..567bb63369f 100644 --- a/service/appsync/api_op_UpdateResolver.go +++ b/service/appsync/api_op_UpdateResolver.go @@ -47,29 +47,26 @@ type UpdateResolverInput struct { // The caching configuration for the resolver. CachingConfig *types.CachingConfig - // The resolver code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The resolver code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string // The new data source name. DataSourceName *string // The resolver type. + // - UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. + // You can use a UNIT resolver to run a GraphQL query against a single data source. // - // * UNIT: A UNIT resolver type. A UNIT resolver is the default - // resolver type. You can use a UNIT resolver to run a GraphQL query against a - // single data source. - // - // * PIPELINE: A PIPELINE resolver type. You can use a - // PIPELINE resolver to invoke a series of Function objects in a serial manner. You - // can use a pipeline resolver to run a GraphQL query against multiple data - // sources. + // - PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to + // invoke a series of Function objects in a serial manner. You can use a pipeline + // resolver to run a GraphQL query against multiple data sources. Kind types.ResolverKind // The maximum batching size for a resolver. MaxBatchSize int32 - // The PipelineConfig. + // The PipelineConfig . PipelineConfig *types.PipelineConfig // The new request mapping template. A resolver uses a request mapping template to diff --git a/service/appsync/doc.go b/service/appsync/doc.go index 9326f02ccc7..2379bb151cb 100644 --- a/service/appsync/doc.go +++ b/service/appsync/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package appsync provides the API client, operations, and parameter types for AWS -// AppSync. +// Package appsync provides the API client, operations, and parameter types for +// AWS AppSync. // // AppSync provides API actions for creating and interacting with data sources // using GraphQL from your application. diff --git a/service/appsync/types/enums.go b/service/appsync/types/enums.go index 160a7c24114..ed06e7e1055 100644 --- a/service/appsync/types/enums.go +++ b/service/appsync/types/enums.go @@ -47,9 +47,9 @@ const ( ApiCacheTypeLarge12x ApiCacheType = "LARGE_12X" ) -// Values returns all known values for ApiCacheType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ApiCacheType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ApiCacheType) Values() []ApiCacheType { return []ApiCacheType{ "T2_SMALL", @@ -172,8 +172,8 @@ const ( ConflictDetectionTypeNone ConflictDetectionType = "NONE" ) -// Values returns all known values for ConflictDetectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ConflictDetectionType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ConflictDetectionType) Values() []ConflictDetectionType { return []ConflictDetectionType{ @@ -297,9 +297,10 @@ const ( RelationalDatabaseSourceTypeRdsHttpEndpoint RelationalDatabaseSourceType = "RDS_HTTP_ENDPOINT" ) -// Values returns all known values for RelationalDatabaseSourceType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RelationalDatabaseSourceType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RelationalDatabaseSourceType) Values() []RelationalDatabaseSourceType { return []RelationalDatabaseSourceType{ "RDS_HTTP_ENDPOINT", @@ -314,9 +315,9 @@ const ( ResolverKindPipeline ResolverKind = "PIPELINE" ) -// Values returns all known values for ResolverKind. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResolverKind. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResolverKind) Values() []ResolverKind { return []ResolverKind{ "UNIT", @@ -352,9 +353,9 @@ const ( SchemaStatusNotApplicable SchemaStatus = "NOT_APPLICABLE" ) -// Values returns all known values for SchemaStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SchemaStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SchemaStatus) Values() []SchemaStatus { return []SchemaStatus{ "PROCESSING", diff --git a/service/appsync/types/errors.go b/service/appsync/types/errors.go index ab032791efd..e7323bc7da1 100644 --- a/service/appsync/types/errors.go +++ b/service/appsync/types/errors.go @@ -60,7 +60,7 @@ func (e *ApiKeyLimitExceededException) ErrorCode() string { func (e *ApiKeyLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The API key expiration must be set to a value between 1 and 365 days from -// creation (for CreateApiKey) or from update (for UpdateApiKey). +// creation (for CreateApiKey ) or from update (for UpdateApiKey ). type ApiKeyValidityOutOfBoundsException struct { Message *string @@ -144,8 +144,8 @@ func (e *BadRequestException) ErrorCode() string { } func (e *BadRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Another modification is in progress at this time and it must complete before you -// can make your change. +// Another modification is in progress at this time and it must complete before +// you can make your change. type ConcurrentModificationException struct { Message *string diff --git a/service/appsync/types/types.go b/service/appsync/types/types.go index c80ed668709..7bf12f56eec 100644 --- a/service/appsync/types/types.go +++ b/service/appsync/types/types.go @@ -32,16 +32,12 @@ type ApiAssociation struct { ApiId *string // Identifies the status of an association. - // - // * PROCESSING: The API association is - // being created. You cannot modify association requests during processing. - // - // * - // SUCCESS: The API association was successful. You can modify associations after - // success. - // - // * FAILED: The API association has failed. You can modify associations - // after failure. + // - PROCESSING: The API association is being created. You cannot modify + // association requests during processing. + // - SUCCESS: The API association was successful. You can modify associations + // after success. + // - FAILED: The API association has failed. You can modify associations after + // failure. AssociationStatus AssociationStatus // Details about the last deployment status. @@ -57,11 +53,8 @@ type ApiAssociation struct { type ApiCache struct { // Caching behavior. - // - // * FULL_REQUEST_CACHING: All requests are fully cached. - // - // * - // PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. + // - FULL_REQUEST_CACHING: All requests are fully cached. + // - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. ApiCachingBehavior ApiCachingBehavior // At-rest encryption flag for cache. You cannot update this setting after @@ -69,69 +62,39 @@ type ApiCache struct { AtRestEncryptionEnabled bool // The cache instance status. - // - // * AVAILABLE: The instance is available for use. - // - // * - // CREATING: The instance is currently creating. - // - // * DELETING: The instance is - // currently deleting. - // - // * MODIFYING: The instance is currently modifying. - // - // * - // FAILED: The instance has failed creation. + // - AVAILABLE: The instance is available for use. + // - CREATING: The instance is currently creating. + // - DELETING: The instance is currently deleting. + // - MODIFYING: The instance is currently modifying. + // - FAILED: The instance has failed creation. Status ApiCacheStatus - // Transit encryption flag when connecting to cache. You cannot update this setting - // after creation. + // Transit encryption flag when connecting to cache. You cannot update this + // setting after creation. TransitEncryptionEnabled bool // TTL in seconds for cache entries. Valid values are 1–3,600 seconds. Ttl int64 // The cache instance type. Valid values are - // - // * SMALL - // - // * MEDIUM - // - // * LARGE - // - // * - // XLARGE - // - // * LARGE_2X - // - // * LARGE_4X - // - // * LARGE_8X (not available in all regions) - // - // * - // LARGE_12X - // - // Historically, instance types were identified by an EC2-style value. - // As of July 2020, this is deprecated, and the generic identifiers above should be - // used. The following legacy instance types are available, but their use is - // discouraged: - // - // * T2_SMALL: A t2.small instance type. - // - // * T2_MEDIUM: A t2.medium - // instance type. - // - // * R4_LARGE: A r4.large instance type. - // - // * R4_XLARGE: A r4.xlarge - // instance type. - // - // * R4_2XLARGE: A r4.2xlarge instance type. - // - // * R4_4XLARGE: A - // r4.4xlarge instance type. - // - // * R4_8XLARGE: A r4.8xlarge instance type. + // - SMALL + // - MEDIUM + // - LARGE + // - XLARGE + // - LARGE_2X + // - LARGE_4X + // - LARGE_8X (not available in all regions) + // - LARGE_12X + // Historically, instance types were identified by an EC2-style value. As of July + // 2020, this is deprecated, and the generic identifiers above should be used. The + // following legacy instance types are available, but their use is discouraged: + // - T2_SMALL: A t2.small instance type. + // - T2_MEDIUM: A t2.medium instance type. + // - R4_LARGE: A r4.large instance type. + // - R4_XLARGE: A r4.xlarge instance type. + // - R4_2XLARGE: A r4.2xlarge instance type. + // - R4_4XLARGE: A r4.4xlarge instance type. + // - R4_8XLARGE: A r4.8xlarge instance type. Type ApiCacheType noSmithyDocumentSerde @@ -142,48 +105,30 @@ type ApiCache struct { // this version at launch in November 2017. These keys always expire after 7 days. // Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after // February 21, 2018, and they should no longer be used. +// - ListApiKeys returns the expiration time in milliseconds. +// - CreateApiKey returns the expiration time in milliseconds. +// - UpdateApiKey is not available for this key version. +// - DeleteApiKey deletes the item from the table. +// - Expiration is stored in DynamoDB as milliseconds. This results in a bug +// where keys are not automatically deleted because DynamoDB expects the TTL to be +// stored in seconds. As a one-time action, we deleted these keys from the table on +// February 21, 2018. // -// * ListApiKeys returns the -// expiration time in milliseconds. -// -// * CreateApiKey returns the expiration time in -// milliseconds. -// -// * UpdateApiKey is not available for this key version. -// -// * -// DeleteApiKey deletes the item from the table. -// -// * Expiration is stored in -// DynamoDB as milliseconds. This results in a bug where keys are not automatically -// deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time -// action, we deleted these keys from the table on February 21, 2018. -// -// da2: We -// introduced this version in February 2018 when AppSync added support to extend -// key expiration. -// -// * ListApiKeys returns the expiration time and deletion time in -// seconds. -// -// * CreateApiKey returns the expiration time and deletion time in -// seconds and accepts a user-provided expiration time in seconds. -// -// * UpdateApiKey -// returns the expiration time and and deletion time in seconds and accepts a -// user-provided expiration time in seconds. Expired API keys are kept for 60 days -// after the expiration time. You can update the key expiration time as long as the -// key isn't deleted. -// -// * DeleteApiKey deletes the item from the table. -// -// * -// Expiration is stored in DynamoDB as seconds. After the expiration time, using -// the key to authenticate will fail. However, you can reinstate the key before -// deletion. -// -// * Deletion is stored in DynamoDB as seconds. The key is deleted after -// deletion time. +// da2: We introduced this version in February 2018 when AppSync added support to +// extend key expiration. +// - ListApiKeys returns the expiration time and deletion time in seconds. +// - CreateApiKey returns the expiration time and deletion time in seconds and +// accepts a user-provided expiration time in seconds. +// - UpdateApiKey returns the expiration time and and deletion time in seconds +// and accepts a user-provided expiration time in seconds. Expired API keys are +// kept for 60 days after the expiration time. You can update the key expiration +// time as long as the key isn't deleted. +// - DeleteApiKey deletes the item from the table. +// - Expiration is stored in DynamoDB as seconds. After the expiration time, +// using the key to authenticate will fail. However, you can reinstate the key +// before deletion. +// - Deletion is stored in DynamoDB as seconds. The key is deleted after +// deletion time. type ApiKey struct { // The time after which the API key is deleted. The date is represented as seconds @@ -209,12 +154,12 @@ type ApiKey struct { // specified. type AppSyncRuntime struct { - // The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS. + // The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS . // // This member is required. Name RuntimeName - // The version of the runtime to use. Currently, the only allowed version is 1.0.0. + // The version of the runtime to use. Currently, the only allowed version is 1.0.0 . // // This member is required. RuntimeVersion *string @@ -227,9 +172,7 @@ type AppSyncRuntime struct { type AuthorizationConfig struct { // The authorization type that the HTTP endpoint requires. - // - // * AWS_IAM: The - // authorization type is Signature Version 4 (SigV4). + // - AWS_IAM: The authorization type is Signature Version 4 (SigV4). // // This member is required. AuthorizationType AuthorizationType @@ -253,7 +196,7 @@ type AwsIamConfig struct { } // Provides further details for the reason behind the bad request. For reason type -// CODE_ERROR, the detail will contain a list of code errors. +// CODE_ERROR , the detail will contain a list of code errors. type BadRequestDetail struct { // Contains the list of errors in the request. @@ -272,7 +215,7 @@ type CachingConfig struct { Ttl int64 // The caching keys for a resolver that has caching activated. Valid values are - // entries from the $context.arguments, $context.source, and $context.identity + // entries from the $context.arguments , $context.source , and $context.identity // maps. CachingKeys []string @@ -282,15 +225,15 @@ type CachingConfig struct { // Describes an AppSync error. type CodeError struct { - // The type of code error. Examples include, but aren't limited to: LINT_ERROR, - // PARSER_ERROR. + // The type of code error. Examples include, but aren't limited to: LINT_ERROR , + // PARSER_ERROR . ErrorType *string // The line, column, and span location of the error in the code. Location *CodeErrorLocation // A user presentable error. Examples include, but aren't limited to: Parsing - // error: Unterminated string literal. + // error: Unterminated string literal . Value *string noSmithyDocumentSerde @@ -364,37 +307,25 @@ type DataSource struct { // Relational database settings. RelationalDatabaseConfig *RelationalDatabaseDataSourceConfig - // The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) - // for the data source. The system assumes this role when accessing the data + // The Identity and Access Management (IAM) service role Amazon Resource Name + // (ARN) for the data source. The system assumes this role when accessing the data // source. ServiceRoleArn *string // The type of the data source. - // - // * AWS_LAMBDA: The data source is an Lambda - // function. - // - // * AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. - // - // * - // AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain. - // - // * - // AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service - // domain. - // - // * AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge - // configuration. - // - // * NONE: There is no data source. Use this type when you want to - // invoke a GraphQL operation without connecting to a data source, such as when - // you're performing data transformation with resolvers or invoking a subscription - // from a mutation. - // - // * HTTP: The data source is an HTTP endpoint. - // - // * - // RELATIONAL_DATABASE: The data source is a relational database. + // - AWS_LAMBDA: The data source is an Lambda function. + // - AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. + // - AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service + // domain. + // - AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service + // domain. + // - AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration. + // - NONE: There is no data source. Use this type when you want to invoke a + // GraphQL operation without connecting to a data source, such as when you're + // performing data transformation with resolvers or invoking a subscription from a + // mutation. + // - HTTP: The data source is an HTTP endpoint. + // - RELATIONAL_DATABASE: The data source is a relational database. Type DataSourceType noSmithyDocumentSerde @@ -483,8 +414,8 @@ type ElasticsearchDataSourceConfig struct { noSmithyDocumentSerde } -// Contains the list of errors generated. When using JavaScript, this will apply to -// the request or response function evaluation. +// Contains the list of errors generated. When using JavaScript, this will apply +// to the request or response function evaluation. type ErrorDetail struct { // The error payload. @@ -509,8 +440,8 @@ type EvaluateCodeErrorDetail struct { type EventBridgeDataSourceConfig struct { // The ARN of the event bus. For more information about event buses, see Amazon - // EventBridge event buses - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html). + // EventBridge event buses (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html) + // . // // This member is required. EventBusArn *string @@ -522,11 +453,11 @@ type EventBridgeDataSourceConfig struct { // resolver logic. type FunctionConfiguration struct { - // The function code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The function code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string - // The name of the DataSource. + // The name of the DataSource . DataSourceName *string // The Function description. @@ -604,11 +535,11 @@ type GraphqlApi struct { // The Amazon Cognito user pool configuration. UserPoolConfig *UserPoolConfig - // The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if - // one exists. + // The ARN of the WAF access control list (ACL) associated with this GraphqlApi , + // if one exists. WafWebAclArn *string - // A flag indicating whether to use X-Ray tracing for this GraphqlApi. + // A flag indicating whether to use X-Ray tracing for this GraphqlApi . XrayEnabled bool noSmithyDocumentSerde @@ -631,16 +562,16 @@ type HttpDataSourceConfig struct { } // A LambdaAuthorizerConfig specifies how to authorize AppSync API access when -// using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only -// one Lambda authorizer configured at a time. +// using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have +// only one Lambda authorizer configured at a time. type LambdaAuthorizerConfig struct { // The Amazon Resource Name (ARN) of the Lambda function to be called for - // authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an - // alias ARN. Note: This Lambda function must have the following resource-based + // authorization. This can be a standard Lambda ARN, a version ARN ( .../v3 ), or + // an alias ARN. Note: This Lambda function must have the following resource-based // policy assigned to it. When configuring Lambda authorizers in the console, this - // is done for you. To use the Command Line Interface (CLI), run the following: aws - // lambda add-permission --function-name + // is done for you. To use the Command Line Interface (CLI), run the following: + // aws lambda add-permission --function-name // "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id // "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction // @@ -691,28 +622,16 @@ type LogConfig struct { CloudWatchLogsRoleArn *string // The field logging level. Values can be NONE, ERROR, or ALL. - // - // * NONE: No - // field-level logs are captured. - // - // * ERROR: Logs the following information only for - // the fields that are in error: - // - // * The error section in the server response. - // - // * - // Field-level errors. - // - // * The generated request/response functions that got - // resolved for error fields. - // - // * ALL: The following information is logged for all - // fields in the query: - // - // * Field-level tracing information. - // - // * The generated - // request/response functions that got resolved for each field. + // - NONE: No field-level logs are captured. + // - ERROR: Logs the following information only for the fields that are in + // error: + // - The error section in the server response. + // - Field-level errors. + // - The generated request/response functions that got resolved for error + // fields. + // - ALL: The following information is logged for all fields in the query: + // - Field-level tracing information. + // - The generated request/response functions that got resolved for each field. // // This member is required. FieldLogLevel FieldLogLevel @@ -736,10 +655,10 @@ type OpenIDConnectConfig struct { // The number of milliseconds that a token is valid after being authenticated. AuthTTL int64 - // The client identifier of the relying party at the OpenID identity provider. This - // identifier is typically obtained when the relying party is registered with the - // OpenID identity provider. You can specify a regular expression so that AppSync - // can validate against multiple client identifiers at a time. + // The client identifier of the relying party at the OpenID identity provider. + // This identifier is typically obtained when the relying party is registered with + // the OpenID identity provider. You can specify a regular expression so that + // AppSync can validate against multiple client identifiers at a time. ClientId *string // The number of milliseconds that a token is valid after it's issued to a user. @@ -764,7 +683,7 @@ type OpenSearchServiceDataSourceConfig struct { noSmithyDocumentSerde } -// The pipeline configuration for a resolver of kind PIPELINE. +// The pipeline configuration for a resolver of kind PIPELINE . type PipelineConfig struct { // A list of Function objects. @@ -802,10 +721,8 @@ type RelationalDatabaseDataSourceConfig struct { RdsHttpEndpointConfig *RdsHttpEndpointConfig // Source type for the relational database. - // - // * RDS_HTTP_ENDPOINT: The relational - // database source type is an Amazon Relational Database Service (Amazon RDS) HTTP - // endpoint. + // - RDS_HTTP_ENDPOINT: The relational database source type is an Amazon + // Relational Database Service (Amazon RDS) HTTP endpoint. RelationalDatabaseSourceType RelationalDatabaseSourceType noSmithyDocumentSerde @@ -817,8 +734,8 @@ type Resolver struct { // The caching configuration for the resolver. CachingConfig *CachingConfig - // The resolver code that contains the request and response functions. When code is - // used, the runtime is required. The runtime value must be APPSYNC_JS. + // The resolver code that contains the request and response functions. When code + // is used, the runtime is required. The runtime value must be APPSYNC_JS . Code *string // The resolver data source name. @@ -828,21 +745,18 @@ type Resolver struct { FieldName *string // The resolver type. + // - UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. + // You can use a UNIT resolver to run a GraphQL query against a single data source. // - // * UNIT: A UNIT resolver type. A UNIT resolver is the default - // resolver type. You can use a UNIT resolver to run a GraphQL query against a - // single data source. - // - // * PIPELINE: A PIPELINE resolver type. You can use a - // PIPELINE resolver to invoke a series of Function objects in a serial manner. You - // can use a pipeline resolver to run a GraphQL query against multiple data - // sources. + // - PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to + // invoke a series of Function objects in a serial manner. You can use a pipeline + // resolver to run a GraphQL query against multiple data sources. Kind ResolverKind // The maximum batching size for a resolver. MaxBatchSize int32 - // The PipelineConfig. + // The PipelineConfig . PipelineConfig *PipelineConfig // The request mapping template. @@ -874,25 +788,17 @@ type Resolver struct { type SyncConfig struct { // The Conflict Detection strategy to use. - // - // * VERSION: Detect conflicts based on - // object versions for this resolver. - // - // * NONE: Do not detect conflicts when - // invoking this resolver. + // - VERSION: Detect conflicts based on object versions for this resolver. + // - NONE: Do not detect conflicts when invoking this resolver. ConflictDetection ConflictDetectionType // The Conflict Resolution strategy to perform in the event of a conflict. - // - // * - // OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions - // don't match the latest version at the server. - // - // * AUTOMERGE: Resolve conflicts - // with the Automerge conflict resolution strategy. - // - // * LAMBDA: Resolve conflicts - // with an Lambda function supplied in the LambdaConflictHandlerConfig. + // - OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when + // versions don't match the latest version at the server. + // - AUTOMERGE: Resolve conflicts with the Automerge conflict resolution + // strategy. + // - LAMBDA: Resolve conflicts with an Lambda function supplied in the + // LambdaConflictHandlerConfig . ConflictHandler ConflictHandlerType // The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler. diff --git a/service/arczonalshift/api_client.go b/service/arczonalshift/api_client.go index c07c3d64ca4..16aa63f97be 100644 --- a/service/arczonalshift/api_client.go +++ b/service/arczonalshift/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/arczonalshift/api_op_CancelZonalShift.go b/service/arczonalshift/api_op_CancelZonalShift.go index 3d574b9dc5a..af0550f078f 100644 --- a/service/arczonalshift/api_op_CancelZonalShift.go +++ b/service/arczonalshift/api_op_CancelZonalShift.go @@ -83,14 +83,9 @@ type CancelZonalShiftOutput struct { // A status for a zonal shift. The Status for a zonal shift can have one of the // following values: - // - // * ACTIVE: The zonal shift is started and active. - // - // * EXPIRED: - // The zonal shift has expired (the expiry time was exceeded). - // - // * CANCELED: The - // zonal shift was canceled. + // - ACTIVE: The zonal shift is started and active. + // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // - CANCELED: The zonal shift was canceled. // // This member is required. Status types.ZonalShiftStatus diff --git a/service/arczonalshift/api_op_ListZonalShifts.go b/service/arczonalshift/api_op_ListZonalShifts.go index 3bc06b19217..e89b32cc5fe 100644 --- a/service/arczonalshift/api_op_ListZonalShifts.go +++ b/service/arczonalshift/api_op_ListZonalShifts.go @@ -42,14 +42,9 @@ type ListZonalShiftsInput struct { // A status for a zonal shift. The Status for a zonal shift can have one of the // following values: - // - // * ACTIVE: The zonal shift is started and active. - // - // * EXPIRED: - // The zonal shift has expired (the expiry time was exceeded). - // - // * CANCELED: The - // zonal shift was canceled. + // - ACTIVE: The zonal shift is started and active. + // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // - CANCELED: The zonal shift was canceled. Status types.ZonalShiftStatus noSmithyDocumentSerde diff --git a/service/arczonalshift/api_op_StartZonalShift.go b/service/arczonalshift/api_op_StartZonalShift.go index 9c462f8de5b..ad42e16b85d 100644 --- a/service/arczonalshift/api_op_StartZonalShift.go +++ b/service/arczonalshift/api_op_StartZonalShift.go @@ -24,9 +24,8 @@ import ( // to the Availability Zone. The zonal shift is created immediately in Route 53 // ARC. However, it can take a short time, typically up to a few minutes, for // existing, in-progress connections in the Availability Zone to complete. For more -// information, see Zonal shift -// (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html) in the -// Amazon Route 53 Application Recovery Controller Developer Guide. +// information, see Zonal shift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. func (c *Client) StartZonalShift(ctx context.Context, params *StartZonalShiftInput, optFns ...func(*Options)) (*StartZonalShiftOutput, error) { if params == nil { params = &StartZonalShiftInput{} @@ -66,16 +65,10 @@ type StartZonalShiftInput struct { // before it expires, for example, if you're ready to restore traffic to the // Availability Zone. To set a length of time for a zonal shift to be active, // specify a whole number, and then one of the following, with no space: - // - // * A - // lowercase letter m: To specify that the value is in minutes. - // - // * A lowercase - // letter h: To specify that the value is in hours. - // - // For example: 20h means the - // zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 - // minutes (2 hours). + // - A lowercase letter m: To specify that the value is in minutes. + // - A lowercase letter h: To specify that the value is in hours. + // For example: 20h means the zonal shift expires in 20 hours. 120m means the + // zonal shift expires in 120 minutes (2 hours). // // This member is required. ExpiresIn *string @@ -135,14 +128,9 @@ type StartZonalShiftOutput struct { // A status for a zonal shift. The Status for a zonal shift can have one of the // following values: - // - // * ACTIVE: The zonal shift is started and active. - // - // * EXPIRED: - // The zonal shift has expired (the expiry time was exceeded). - // - // * CANCELED: The - // zonal shift was canceled. + // - ACTIVE: The zonal shift is started and active. + // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // - CANCELED: The zonal shift was canceled. // // This member is required. Status types.ZonalShiftStatus diff --git a/service/arczonalshift/api_op_UpdateZonalShift.go b/service/arczonalshift/api_op_UpdateZonalShift.go index 3c7c4f6e3ea..8cc33927b41 100644 --- a/service/arczonalshift/api_op_UpdateZonalShift.go +++ b/service/arczonalshift/api_op_UpdateZonalShift.go @@ -50,16 +50,10 @@ type UpdateZonalShiftInput struct { // before it expires, for example, if you're ready to restore traffic to the // Availability Zone. To set a length of time for a zonal shift to be active, // specify a whole number, and then one of the following, with no space: - // - // * A - // lowercase letter m: To specify that the value is in minutes. - // - // * A lowercase - // letter h: To specify that the value is in hours. - // - // For example: 20h means the - // zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 - // minutes (2 hours). + // - A lowercase letter m: To specify that the value is in minutes. + // - A lowercase letter h: To specify that the value is in hours. + // For example: 20h means the zonal shift expires in 20 hours. 120m means the + // zonal shift expires in 120 minutes (2 hours). ExpiresIn *string noSmithyDocumentSerde @@ -109,14 +103,9 @@ type UpdateZonalShiftOutput struct { // A status for a zonal shift. The Status for a zonal shift can have one of the // following values: - // - // * ACTIVE: The zonal shift is started and active. - // - // * EXPIRED: - // The zonal shift has expired (the expiry time was exceeded). - // - // * CANCELED: The - // zonal shift was canceled. + // - ACTIVE: The zonal shift is started and active. + // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // - CANCELED: The zonal shift was canceled. // // This member is required. Status types.ZonalShiftStatus diff --git a/service/arczonalshift/doc.go b/service/arczonalshift/doc.go index 5851c4e281c..6b95fdfe44a 100644 --- a/service/arczonalshift/doc.go +++ b/service/arczonalshift/doc.go @@ -23,6 +23,6 @@ // expiration. You can also cancel a zonal shift, before it expires, for example, // if you're ready to restore traffic to the Availability Zone. For more // information about using zonal shift, see the Amazon Route 53 Application -// Recovery Controller Developer Guide -// (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html). +// Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html) +// . package arczonalshift diff --git a/service/arczonalshift/types/types.go b/service/arczonalshift/types/types.go index bf24d907562..8b28bf260b1 100644 --- a/service/arczonalshift/types/types.go +++ b/service/arczonalshift/types/types.go @@ -30,12 +30,12 @@ type ManagedResourceSummary struct { noSmithyDocumentSerde } -// A complex structure that lists the zonal shifts for a managed resource and their -// statuses for the resource. +// A complex structure that lists the zonal shifts for a managed resource and +// their statuses for the resource. type ZonalShiftInResource struct { // An appliedStatus for a zonal shift for a resource can have one of two values: - // APPLIED or NOT_APPLIED. + // APPLIED or NOT_APPLIED . // // This member is required. AppliedStatus AppliedStatus @@ -144,14 +144,9 @@ type ZonalShiftSummary struct { // A status for a zonal shift. The Status for a zonal shift can have one of the // following values: - // - // * ACTIVE: The zonal shift is started and active. - // - // * EXPIRED: - // The zonal shift has expired (the expiry time was exceeded). - // - // * CANCELED: The - // zonal shift was canceled. + // - ACTIVE: The zonal shift is started and active. + // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // - CANCELED: The zonal shift was canceled. // // This member is required. Status ZonalShiftStatus diff --git a/service/athena/api_client.go b/service/athena/api_client.go index b8472da98ec..48b043c07cf 100644 --- a/service/athena/api_client.go +++ b/service/athena/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/athena/api_op_BatchGetNamedQuery.go b/service/athena/api_op_BatchGetNamedQuery.go index 415fe44c0cb..ed4afff435b 100644 --- a/service/athena/api_op_BatchGetNamedQuery.go +++ b/service/athena/api_op_BatchGetNamedQuery.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the details of a single named query or a list of up to 50 queries, which -// you provide as an array of query ID strings. Requires you to have access to the -// workgroup in which the queries were saved. Use ListNamedQueriesInput to get the -// list of named query IDs in the specified workgroup. If information could not be -// retrieved for a submitted query ID, information about the query ID submitted is -// listed under UnprocessedNamedQueryId. Named queries differ from executed -// queries. Use BatchGetQueryExecutionInput to get details about each unique query -// execution, and ListQueryExecutionsInput to get a list of query execution IDs. +// Returns the details of a single named query or a list of up to 50 queries, +// which you provide as an array of query ID strings. Requires you to have access +// to the workgroup in which the queries were saved. Use ListNamedQueriesInput to +// get the list of named query IDs in the specified workgroup. If information could +// not be retrieved for a submitted query ID, information about the query ID +// submitted is listed under UnprocessedNamedQueryId . Named queries differ from +// executed queries. Use BatchGetQueryExecutionInput to get details about each +// unique query execution, and ListQueryExecutionsInput to get a list of query +// execution IDs. func (c *Client) BatchGetNamedQuery(ctx context.Context, params *BatchGetNamedQueryInput, optFns ...func(*Options)) (*BatchGetNamedQueryOutput, error) { if params == nil { params = &BatchGetNamedQueryInput{} diff --git a/service/athena/api_op_BatchGetPreparedStatement.go b/service/athena/api_op_BatchGetPreparedStatement.go index d8ed6fa4014..9505db6eb6d 100644 --- a/service/athena/api_op_BatchGetPreparedStatement.go +++ b/service/athena/api_op_BatchGetPreparedStatement.go @@ -15,7 +15,7 @@ import ( // prepared statements for the array of prepared statement names that you provide. // Requires you to have access to the workgroup to which the prepared statements // belong. If a prepared statement cannot be retrieved for the name specified, the -// statement is listed in UnprocessedPreparedStatementNames. +// statement is listed in UnprocessedPreparedStatementNames . func (c *Client) BatchGetPreparedStatement(ctx context.Context, params *BatchGetPreparedStatementInput, optFns ...func(*Options)) (*BatchGetPreparedStatementOutput, error) { if params == nil { params = &BatchGetPreparedStatementInput{} diff --git a/service/athena/api_op_BatchGetQueryExecution.go b/service/athena/api_op_BatchGetQueryExecution.go index ef053b75651..f1b5145bb32 100644 --- a/service/athena/api_op_BatchGetQueryExecution.go +++ b/service/athena/api_op_BatchGetQueryExecution.go @@ -14,9 +14,9 @@ import ( // Returns the details of a single query execution or a list of up to 50 query // executions, which you provide as an array of query execution ID strings. // Requires you to have access to the workgroup in which the queries ran. To get a -// list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query -// executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get -// details about named queries. +// list of query execution IDs, use ListQueryExecutionsInput$WorkGroup . Query +// executions differ from named (saved) queries. Use BatchGetNamedQueryInput to +// get details about named queries. func (c *Client) BatchGetQueryExecution(ctx context.Context, params *BatchGetQueryExecutionInput, optFns ...func(*Options)) (*BatchGetQueryExecutionOutput, error) { if params == nil { params = &BatchGetQueryExecutionInput{} diff --git a/service/athena/api_op_CreateDataCatalog.go b/service/athena/api_op_CreateDataCatalog.go index 0a4832c1d49..d69da9e23d4 100644 --- a/service/athena/api_op_CreateDataCatalog.go +++ b/service/athena/api_op_CreateDataCatalog.go @@ -48,42 +48,30 @@ type CreateDataCatalogInput struct { // A description of the data catalog to be created. Description *string - // Specifies the Lambda function or functions to use for creating the data catalog. - // This is a mapping whose values depend on the catalog type. - // - // * For the HIVE data - // catalog type, use the following syntax. The metadata-function parameter is - // required. The sdk-version parameter is optional and defaults to the currently - // supported version. metadata-function=lambda_arn, sdk-version=version_number - // - // * - // For the LAMBDA data catalog type, use one of the following sets of required - // parameters, but not both. - // - // * If you have one Lambda function that processes - // metadata and another for reading the actual data, use the following syntax. Both - // parameters are required. metadata-function=lambda_arn, - // record-function=lambda_arn - // - // * If you have a composite Lambda function that - // processes both metadata and data, use the following syntax to specify your - // Lambda function. function=lambda_arn - // - // * The GLUE type takes a catalog ID - // parameter and is required. The catalog_id is the account ID of the Amazon Web - // Services account to which the Glue Data Catalog belongs. - // catalog-id=catalog_id - // - // * The GLUE data catalog type also applies to the default - // AwsDataCatalog that already exists in your account, of which you can have only - // one and cannot modify. - // - // * Queries that specify a Glue Data Catalog other than - // the default AwsDataCatalog must be run on Athena engine version 2. - // - // * In Regions - // where Athena engine version 2 is not available, creating new Glue data catalogs - // results in an INVALID_INPUT error. + // Specifies the Lambda function or functions to use for creating the data + // catalog. This is a mapping whose values depend on the catalog type. + // - For the HIVE data catalog type, use the following syntax. The + // metadata-function parameter is required. The sdk-version parameter is optional + // and defaults to the currently supported version. + // metadata-function=lambda_arn, sdk-version=version_number + // - For the LAMBDA data catalog type, use one of the following sets of required + // parameters, but not both. + // - If you have one Lambda function that processes metadata and another for + // reading the actual data, use the following syntax. Both parameters are required. + // metadata-function=lambda_arn, record-function=lambda_arn + // - If you have a composite Lambda function that processes both metadata and + // data, use the following syntax to specify your Lambda function. + // function=lambda_arn + // - The GLUE type takes a catalog ID parameter and is required. The catalog_id + // is the account ID of the Amazon Web Services account to which the Glue Data + // Catalog belongs. catalog-id=catalog_id + // - The GLUE data catalog type also applies to the default AwsDataCatalog that + // already exists in your account, of which you can have only one and cannot + // modify. + // - Queries that specify a Glue Data Catalog other than the default + // AwsDataCatalog must be run on Athena engine version 2. + // - In Regions where Athena engine version 2 is not available, creating new + // Glue data catalogs results in an INVALID_INPUT error. Parameters map[string]string // A list of comma separated tags to add to the data catalog that is created. diff --git a/service/athena/api_op_CreateNamedQuery.go b/service/athena/api_op_CreateNamedQuery.go index 03017dd116c..45d1681c8a5 100644 --- a/service/athena/api_op_CreateNamedQuery.go +++ b/service/athena/api_op_CreateNamedQuery.go @@ -13,9 +13,8 @@ import ( // Creates a named query in the specified workgroup. Requires that you have access // to the workgroup. For code samples using the Amazon Web Services SDK for Java, -// see Examples and Code Samples -// (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon -// Athena User Guide. +// see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) +// in the Amazon Athena User Guide. func (c *Client) CreateNamedQuery(ctx context.Context, params *CreateNamedQueryInput, optFns ...func(*Options)) (*CreateNamedQueryOutput, error) { if params == nil { params = &CreateNamedQueryInput{} @@ -48,10 +47,10 @@ type CreateNamedQueryInput struct { // This member is required. QueryString *string - // A unique case-sensitive string used to ensure the request to create the query is - // idempotent (executes only once). If another CreateNamedQuery request is + // A unique case-sensitive string used to ensure the request to create the query + // is idempotent (executes only once). If another CreateNamedQuery request is // received, the same response is returned and another query is not created. If a - // parameter has changed, for example, the QueryString, an error is returned. This + // parameter has changed, for example, the QueryString , an error is returned. This // token is listed as not required because Amazon Web Services SDKs (for example // the Amazon Web Services SDK for Java) auto-generate the token for users. If you // are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you diff --git a/service/athena/api_op_CreateNotebook.go b/service/athena/api_op_CreateNotebook.go index 7bc8d6afb20..018f2339f83 100644 --- a/service/athena/api_op_CreateNotebook.go +++ b/service/athena/api_op_CreateNotebook.go @@ -40,12 +40,12 @@ type CreateNotebookInput struct { // This member is required. WorkGroup *string - // A unique case-sensitive string used to ensure the request to create the notebook - // is idempotent (executes only once). This token is listed as not required because - // Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) - // auto-generate the token for you. If you are not using the Amazon Web Services - // SDK or the Amazon Web Services CLI, you must provide this token or the action - // will fail. + // A unique case-sensitive string used to ensure the request to create the + // notebook is idempotent (executes only once). This token is listed as not + // required because Amazon Web Services SDKs (for example the Amazon Web Services + // SDK for Java) auto-generate the token for you. If you are not using the Amazon + // Web Services SDK or the Amazon Web Services CLI, you must provide this token or + // the action will fail. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/athena/api_op_CreatePresignedNotebookUrl.go b/service/athena/api_op_CreatePresignedNotebookUrl.go index 0616f9242e4..0245e065c9b 100644 --- a/service/athena/api_op_CreatePresignedNotebookUrl.go +++ b/service/athena/api_op_CreatePresignedNotebookUrl.go @@ -13,8 +13,8 @@ import ( // Gets an authentication token and the URL at which the notebook can be accessed. // During programmatic access, CreatePresignedNotebookUrl must be called every 10 // minutes to refresh the authentication token. For information about granting -// programmatic access, see Grant programmatic access -// (https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access). +// programmatic access, see Grant programmatic access (https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access) +// . func (c *Client) CreatePresignedNotebookUrl(ctx context.Context, params *CreatePresignedNotebookUrlInput, optFns ...func(*Options)) (*CreatePresignedNotebookUrlOutput, error) { if params == nil { params = &CreatePresignedNotebookUrlInput{} diff --git a/service/athena/api_op_CreateWorkGroup.go b/service/athena/api_op_CreateWorkGroup.go index 44da066e5fd..6cc5b21378f 100644 --- a/service/athena/api_op_CreateWorkGroup.go +++ b/service/athena/api_op_CreateWorkGroup.go @@ -35,15 +35,15 @@ type CreateWorkGroupInput struct { // This member is required. Name *string - // Contains configuration information for creating an Athena SQL workgroup or Spark - // enabled Athena workgroup. Athena SQL workgroup configuration includes the + // Contains configuration information for creating an Athena SQL workgroup or + // Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the // location in Amazon S3 where query and calculation results are stored, the // encryption configuration, if any, used for encrypting query results, whether the // Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the // amount of bytes scanned (cutoff) per query, if it is specified, and whether - // workgroup's settings (specified with EnforceWorkGroupConfiguration) in the + // workgroup's settings (specified with EnforceWorkGroupConfiguration ) in the // WorkGroupConfiguration override client-side settings. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // WorkGroupConfiguration$EnforceWorkGroupConfiguration . Configuration *types.WorkGroupConfiguration // The workgroup description. diff --git a/service/athena/api_op_DeleteNamedQuery.go b/service/athena/api_op_DeleteNamedQuery.go index 5b0db16bc10..beedb45edb7 100644 --- a/service/athena/api_op_DeleteNamedQuery.go +++ b/service/athena/api_op_DeleteNamedQuery.go @@ -13,9 +13,8 @@ import ( // Deletes the named query if you have access to the workgroup in which the query // was saved. For code samples using the Amazon Web Services SDK for Java, see -// Examples and Code Samples -// (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon -// Athena User Guide. +// Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) +// in the Amazon Athena User Guide. func (c *Client) DeleteNamedQuery(ctx context.Context, params *DeleteNamedQueryInput, optFns ...func(*Options)) (*DeleteNamedQueryOutput, error) { if params == nil { params = &DeleteNamedQueryInput{} diff --git a/service/athena/api_op_GetQueryResults.go b/service/athena/api_op_GetQueryResults.go index f050c8048e5..ac424058da3 100644 --- a/service/athena/api_op_GetQueryResults.go +++ b/service/athena/api_op_GetQueryResults.go @@ -14,17 +14,16 @@ import ( // Streams the results of a single query execution specified by QueryExecutionId // from the Athena query results location in Amazon S3. For more information, see -// Working with query results, recent queries, and output files -// (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the Amazon -// Athena User Guide. This request does not execute the query but returns results. -// Use StartQueryExecution to run a query. To stream query results successfully, -// the IAM principal with permission to call GetQueryResults also must have -// permissions to the Amazon S3 GetObject action for the Athena query results -// location. IAM principals with permission to the Amazon S3 GetObject action for -// the query results location are able to retrieve query results from Amazon S3 -// even if permission to the GetQueryResults action is denied. To restrict user or -// role access, ensure that Amazon S3 permissions to the Athena query location are -// denied. +// Working with query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html) +// in the Amazon Athena User Guide. This request does not execute the query but +// returns results. Use StartQueryExecution to run a query. To stream query +// results successfully, the IAM principal with permission to call GetQueryResults +// also must have permissions to the Amazon S3 GetObject action for the Athena +// query results location. IAM principals with permission to the Amazon S3 +// GetObject action for the query results location are able to retrieve query +// results from Amazon S3 even if permission to the GetQueryResults action is +// denied. To restrict user or role access, ensure that Amazon S3 permissions to +// the Athena query location are denied. func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error) { if params == nil { params = &GetQueryResultsInput{} diff --git a/service/athena/api_op_GetSession.go b/service/athena/api_op_GetSession.go index 912439e5878..26bbea04c8b 100644 --- a/service/athena/api_op_GetSession.go +++ b/service/athena/api_op_GetSession.go @@ -46,8 +46,8 @@ type GetSessionOutput struct { // Contains engine configuration information like DPU usage. EngineConfiguration *types.EngineConfiguration - // The engine version used by the session (for example, PySpark engine version 3). - // You can get a list of engine versions by calling ListEngineVersions. + // The engine version used by the session (for example, PySpark engine version 3 ). + // You can get a list of engine versions by calling ListEngineVersions . EngineVersion *string // The notebook version. diff --git a/service/athena/api_op_ImportNotebook.go b/service/athena/api_op_ImportNotebook.go index 0054918dc30..1cca4c157ed 100644 --- a/service/athena/api_op_ImportNotebook.go +++ b/service/athena/api_op_ImportNotebook.go @@ -41,7 +41,7 @@ type ImportNotebookInput struct { // This member is required. Payload *string - // The notebook content type. Currently, the only valid type is IPYNB. + // The notebook content type. Currently, the only valid type is IPYNB . // // This member is required. Type types.NotebookType @@ -51,12 +51,12 @@ type ImportNotebookInput struct { // This member is required. WorkGroup *string - // A unique case-sensitive string used to ensure the request to import the notebook - // is idempotent (executes only once). This token is listed as not required because - // Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) - // auto-generate the token for you. If you are not using the Amazon Web Services - // SDK or the Amazon Web Services CLI, you must provide this token or the action - // will fail. + // A unique case-sensitive string used to ensure the request to import the + // notebook is idempotent (executes only once). This token is listed as not + // required because Amazon Web Services SDKs (for example the Amazon Web Services + // SDK for Java) auto-generate the token for you. If you are not using the Amazon + // Web Services SDK or the Amazon Web Services CLI, you must provide this token or + // the action will fail. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/athena/api_op_ListApplicationDPUSizes.go b/service/athena/api_op_ListApplicationDPUSizes.go index 54b842dcc95..75b7a4e9126 100644 --- a/service/athena/api_op_ListApplicationDPUSizes.go +++ b/service/athena/api_op_ListApplicationDPUSizes.go @@ -13,7 +13,7 @@ import ( ) // Returns the supported DPU sizes for the supported application runtimes (for -// example, Athena notebook version 1). +// example, Athena notebook version 1 ). func (c *Client) ListApplicationDPUSizes(ctx context.Context, params *ListApplicationDPUSizesInput, optFns ...func(*Options)) (*ListApplicationDPUSizesOutput, error) { if params == nil { params = &ListApplicationDPUSizesInput{} diff --git a/service/athena/api_op_ListCalculationExecutions.go b/service/athena/api_op_ListCalculationExecutions.go index a8a74f82ffc..2127dbfe5e8 100644 --- a/service/athena/api_op_ListCalculationExecutions.go +++ b/service/athena/api_op_ListCalculationExecutions.go @@ -44,14 +44,15 @@ type ListCalculationExecutionsInput struct { // pass in the NextToken from the response object of the previous page call. NextToken *string - // A filter for a specific calculation execution state. A description of each state - // follows. CREATING - The calculation is in the process of being created. CREATED - // - The calculation has been created and is ready to run. QUEUED - The calculation - // has been queued for processing. RUNNING - The calculation is running. CANCELING - // - A request to cancel the calculation has been received and the system is - // working to stop it. CANCELED - The calculation is no longer running as the - // result of a cancel request. COMPLETED - The calculation has completed without - // error. FAILED - The calculation failed and is no longer running. + // A filter for a specific calculation execution state. A description of each + // state follows. CREATING - The calculation is in the process of being created. + // CREATED - The calculation has been created and is ready to run. QUEUED - The + // calculation has been queued for processing. RUNNING - The calculation is + // running. CANCELING - A request to cancel the calculation has been received and + // the system is working to stop it. CANCELED - The calculation is no longer + // running as the result of a cancel request. COMPLETED - The calculation has + // completed without error. FAILED - The calculation failed and is no longer + // running. StateFilter types.CalculationExecutionState noSmithyDocumentSerde diff --git a/service/athena/api_op_ListExecutors.go b/service/athena/api_op_ListExecutors.go index c1b8092f0e2..b678058cfb0 100644 --- a/service/athena/api_op_ListExecutors.go +++ b/service/athena/api_op_ListExecutors.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists, in descending order, the executors that joined a session. Newer executors -// are listed first; older executors are listed later. The result can be optionally -// filtered by state. +// Lists, in descending order, the executors that joined a session. Newer +// executors are listed first; older executors are listed later. The result can be +// optionally filtered by state. func (c *Client) ListExecutors(ctx context.Context, params *ListExecutorsInput, optFns ...func(*Options)) (*ListExecutorsOutput, error) { if params == nil { params = &ListExecutorsInput{} diff --git a/service/athena/api_op_ListNotebookSessions.go b/service/athena/api_op_ListNotebookSessions.go index 89646cdd36b..feb8f114ebb 100644 --- a/service/athena/api_op_ListNotebookSessions.go +++ b/service/athena/api_op_ListNotebookSessions.go @@ -12,8 +12,8 @@ import ( ) // Lists, in descending order, the sessions that have been created in a notebook -// that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions -// are listed first; older sessions are listed later. +// that are in an active state like CREATING , CREATED , IDLE or BUSY . Newer +// sessions are listed first; older sessions are listed later. func (c *Client) ListNotebookSessions(ctx context.Context, params *ListNotebookSessionsInput, optFns ...func(*Options)) (*ListNotebookSessionsOutput, error) { if params == nil { params = &ListNotebookSessionsInput{} diff --git a/service/athena/api_op_ListQueryExecutions.go b/service/athena/api_op_ListQueryExecutions.go index 6002b32664b..002ca814c8a 100644 --- a/service/athena/api_op_ListQueryExecutions.go +++ b/service/athena/api_op_ListQueryExecutions.go @@ -15,9 +15,8 @@ import ( // specified workgroup. If a workgroup is not specified, returns a list of query // execution IDs for the primary workgroup. Requires you to have access to the // workgroup in which the queries ran. For code samples using the Amazon Web -// Services SDK for Java, see Examples and Code Samples -// (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon -// Athena User Guide. +// Services SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) +// in the Amazon Athena User Guide. func (c *Client) ListQueryExecutions(ctx context.Context, params *ListQueryExecutionsInput, optFns ...func(*Options)) (*ListQueryExecutionsOutput, error) { if params == nil { params = &ListQueryExecutionsInput{} @@ -125,8 +124,8 @@ func (c *Client) addOperationListQueryExecutionsMiddlewares(stack *middleware.St return nil } -// ListQueryExecutionsAPIClient is a client that implements the ListQueryExecutions -// operation. +// ListQueryExecutionsAPIClient is a client that implements the +// ListQueryExecutions operation. type ListQueryExecutionsAPIClient interface { ListQueryExecutions(context.Context, *ListQueryExecutionsInput, ...func(*Options)) (*ListQueryExecutionsOutput, error) } diff --git a/service/athena/api_op_ListSessions.go b/service/athena/api_op_ListSessions.go index 3133e8e8d78..e971327ec1e 100644 --- a/service/athena/api_op_ListSessions.go +++ b/service/athena/api_op_ListSessions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the sessions in a workgroup that are in an active state like CREATING, -// CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are +// Lists the sessions in a workgroup that are in an active state like CREATING , +// CREATED , IDLE , or BUSY . Newer sessions are listed first; older sessions are // listed later. func (c *Client) ListSessions(ctx context.Context, params *ListSessionsInput, optFns ...func(*Options)) (*ListSessionsOutput, error) { if params == nil { diff --git a/service/athena/api_op_ListTagsForResource.go b/service/athena/api_op_ListTagsForResource.go index 9b812fb1e76..b94bef358ef 100644 --- a/service/athena/api_op_ListTagsForResource.go +++ b/service/athena/api_op_ListTagsForResource.go @@ -35,8 +35,8 @@ type ListTagsForResourceInput struct { // This member is required. ResourceARN *string - // The maximum number of results to be returned per request that lists the tags for - // the resource. + // The maximum number of results to be returned per request that lists the tags + // for the resource. MaxResults *int32 // The token for the next set of results, or null if there are no additional @@ -124,8 +124,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -135,8 +135,8 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) // ListTagsForResourcePaginatorOptions is the paginator options for // ListTagsForResource type ListTagsForResourcePaginatorOptions struct { - // The maximum number of results to be returned per request that lists the tags for - // the resource. + // The maximum number of results to be returned per request that lists the tags + // for the resource. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/athena/api_op_StartQueryExecution.go b/service/athena/api_op_StartQueryExecution.go index 6ce7683a123..6057a038ca5 100644 --- a/service/athena/api_op_StartQueryExecution.go +++ b/service/athena/api_op_StartQueryExecution.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs the SQL query statements contained in the Query. Requires you to have +// Runs the SQL query statements contained in the Query . Requires you to have // access to the workgroup in which the query ran. Running queries against an // external catalog requires GetDataCatalog permission to the catalog. For code // samples using the Amazon Web Services SDK for Java, see Examples and Code @@ -40,10 +40,10 @@ type StartQueryExecutionInput struct { // This member is required. QueryString *string - // A unique case-sensitive string used to ensure the request to create the query is - // idempotent (executes only once). If another StartQueryExecution request is + // A unique case-sensitive string used to ensure the request to create the query + // is idempotent (executes only once). If another StartQueryExecution request is // received, the same response is returned and another query is not created. If a - // parameter has changed, for example, the QueryString, an error is returned. This + // parameter has changed, for example, the QueryString , an error is returned. This // token is listed as not required because Amazon Web Services SDKs (for example // the Amazon Web Services SDK for Java) auto-generate the token for users. If you // are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you @@ -63,7 +63,7 @@ type StartQueryExecutionInput struct { // override query settings. This affects the query results location. The workgroup // settings override is specified in EnforceWorkGroupConfiguration (true/false) in // the WorkGroupConfiguration. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // WorkGroupConfiguration$EnforceWorkGroupConfiguration . ResultConfiguration *types.ResultConfiguration // Specifies the query result reuse behavior for the query. diff --git a/service/athena/api_op_StartSession.go b/service/athena/api_op_StartSession.go index 11186188bae..61593ff7fb5 100644 --- a/service/athena/api_op_StartSession.go +++ b/service/athena/api_op_StartSession.go @@ -54,11 +54,11 @@ type StartSessionInput struct { // The session description. Description *string - // The notebook version. This value is supplied automatically for notebook sessions - // in the Athena console and is not required for programmatic session access. The - // only valid notebook version is Athena notebook version 1. If you specify a value - // for NotebookVersion, you must also specify a value for NotebookId. See - // EngineConfiguration$AdditionalConfigs. + // The notebook version. This value is supplied automatically for notebook + // sessions in the Athena console and is not required for programmatic session + // access. The only valid notebook version is Athena notebook version 1 . If you + // specify a value for NotebookVersion , you must also specify a value for + // NotebookId . See EngineConfiguration$AdditionalConfigs . NotebookVersion *string // The idle timeout in minutes for the session. @@ -74,8 +74,8 @@ type StartSessionOutput struct { // The state of the session. A description of each state follows. CREATING - The // session is being started, including acquiring resources. CREATED - The session - // has been started. IDLE - The session is able to accept a calculation. BUSY - The - // session is processing another task and is unable to accept a calculation. + // has been started. IDLE - The session is able to accept a calculation. BUSY - + // The session is processing another task and is unable to accept a calculation. // TERMINATING - The session is in the process of shutting down. TERMINATED - The // session and its resources are no longer running. DEGRADED - The session has no // healthy coordinators. FAILED - Due to a failure, the session and its resources diff --git a/service/athena/api_op_StopCalculationExecution.go b/service/athena/api_op_StopCalculationExecution.go index de7490a8d69..208fbb074b2 100644 --- a/service/athena/api_op_StopCalculationExecution.go +++ b/service/athena/api_op_StopCalculationExecution.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests the cancellation of a calculation. A StopCalculationExecution call on a -// calculation that is already in a terminal state (for example, STOPPED, FAILED, -// or COMPLETED) succeeds but has no effect. Cancelling a calculation is done on a -// best effort basis. If a calculation cannot be cancelled, you can be charged for -// its completion. If you are concerned about being charged for a calculation that -// cannot be cancelled, consider terminating the session in which the calculation -// is running. +// Requests the cancellation of a calculation. A StopCalculationExecution call on +// a calculation that is already in a terminal state (for example, STOPPED , FAILED +// , or COMPLETED ) succeeds but has no effect. Cancelling a calculation is done on +// a best effort basis. If a calculation cannot be cancelled, you can be charged +// for its completion. If you are concerned about being charged for a calculation +// that cannot be cancelled, consider terminating the session in which the +// calculation is running. func (c *Client) StopCalculationExecution(ctx context.Context, params *StopCalculationExecutionInput, optFns ...func(*Options)) (*StopCalculationExecutionOutput, error) { if params == nil { params = &StopCalculationExecutionInput{} diff --git a/service/athena/api_op_StopQueryExecution.go b/service/athena/api_op_StopQueryExecution.go index 4388d133386..772d6900232 100644 --- a/service/athena/api_op_StopQueryExecution.go +++ b/service/athena/api_op_StopQueryExecution.go @@ -13,9 +13,8 @@ import ( // Stops a query execution. Requires you to have access to the workgroup in which // the query ran. For code samples using the Amazon Web Services SDK for Java, see -// Examples and Code Samples -// (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon -// Athena User Guide. +// Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) +// in the Amazon Athena User Guide. func (c *Client) StopQueryExecution(ctx context.Context, params *StopQueryExecutionInput, optFns ...func(*Options)) (*StopQueryExecutionOutput, error) { if params == nil { params = &StopQueryExecutionInput{} diff --git a/service/athena/api_op_TagResource.go b/service/athena/api_op_TagResource.go index 2bcc6522a29..4ac06be1f99 100644 --- a/service/athena/api_op_TagResource.go +++ b/service/athena/api_op_TagResource.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to an Athena resource. A tag is a label that you assign to -// a resource. In Athena, a resource can be a workgroup or data catalog. Each tag -// consists of a key and an optional value, both of which you define. For example, -// you can use tags to categorize Athena workgroups or data catalogs by purpose, -// owner, or environment. Use a consistent set of tag keys to make it easier to -// search and filter workgroups or data catalogs in your account. For best -// practices, see Tagging Best Practices -// (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). -// Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be +// Adds one or more tags to an Athena resource. A tag is a label that you assign +// to a resource. In Athena, a resource can be a workgroup or data catalog. Each +// tag consists of a key and an optional value, both of which you define. For +// example, you can use tags to categorize Athena workgroups or data catalogs by +// purpose, owner, or environment. Use a consistent set of tag keys to make it +// easier to search and filter workgroups or data catalogs in your account. For +// best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) +// . Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be // from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers // representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys // and values are case-sensitive. Tag keys must be unique per resource. If you diff --git a/service/athena/api_op_TerminateSession.go b/service/athena/api_op_TerminateSession.go index bfb2ad14b18..c1b4cb969a4 100644 --- a/service/athena/api_op_TerminateSession.go +++ b/service/athena/api_op_TerminateSession.go @@ -12,10 +12,10 @@ import ( ) // Terminates an active session. A TerminateSession call on a session that is -// already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) +// already inactive (for example, in a FAILED , TERMINATED or TERMINATING state) // succeeds but has no effect. Calculations running in the session when // TerminateSession is called are forcefully stopped, but may display as FAILED -// instead of STOPPED. +// instead of STOPPED . func (c *Client) TerminateSession(ctx context.Context, params *TerminateSessionInput, optFns ...func(*Options)) (*TerminateSessionOutput, error) { if params == nil { params = &TerminateSessionInput{} @@ -45,8 +45,8 @@ type TerminateSessionOutput struct { // The state of the session. A description of each state follows. CREATING - The // session is being started, including acquiring resources. CREATED - The session - // has been started. IDLE - The session is able to accept a calculation. BUSY - The - // session is processing another task and is unable to accept a calculation. + // has been started. IDLE - The session is able to accept a calculation. BUSY - + // The session is processing another task and is unable to accept a calculation. // TERMINATING - The session is in the process of shutting down. TERMINATED - The // session and its resources are no longer running. DEGRADED - The session has no // healthy coordinators. FAILED - Due to a failure, the session and its resources diff --git a/service/athena/api_op_UntagResource.go b/service/athena/api_op_UntagResource.go index 9e66d17425c..4cfdcb73032 100644 --- a/service/athena/api_op_UntagResource.go +++ b/service/athena/api_op_UntagResource.go @@ -33,8 +33,8 @@ type UntagResourceInput struct { // This member is required. ResourceARN *string - // A comma-separated list of one or more tag keys whose tags are to be removed from - // the specified resource. + // A comma-separated list of one or more tag keys whose tags are to be removed + // from the specified resource. // // This member is required. TagKeys []string diff --git a/service/athena/api_op_UpdateDataCatalog.go b/service/athena/api_op_UpdateDataCatalog.go index e9791ab09d5..049000e1fb4 100644 --- a/service/athena/api_op_UpdateDataCatalog.go +++ b/service/athena/api_op_UpdateDataCatalog.go @@ -46,26 +46,20 @@ type UpdateDataCatalogInput struct { // New or modified text that describes the data catalog. Description *string - // Specifies the Lambda function or functions to use for updating the data catalog. - // This is a mapping whose values depend on the catalog type. - // - // * For the HIVE data - // catalog type, use the following syntax. The metadata-function parameter is - // required. The sdk-version parameter is optional and defaults to the currently - // supported version. metadata-function=lambda_arn, sdk-version=version_number - // - // * - // For the LAMBDA data catalog type, use one of the following sets of required - // parameters, but not both. - // - // * If you have one Lambda function that processes - // metadata and another for reading the actual data, use the following syntax. Both - // parameters are required. metadata-function=lambda_arn, - // record-function=lambda_arn - // - // * If you have a composite Lambda function that - // processes both metadata and data, use the following syntax to specify your - // Lambda function. function=lambda_arn + // Specifies the Lambda function or functions to use for updating the data + // catalog. This is a mapping whose values depend on the catalog type. + // - For the HIVE data catalog type, use the following syntax. The + // metadata-function parameter is required. The sdk-version parameter is optional + // and defaults to the currently supported version. + // metadata-function=lambda_arn, sdk-version=version_number + // - For the LAMBDA data catalog type, use one of the following sets of required + // parameters, but not both. + // - If you have one Lambda function that processes metadata and another for + // reading the actual data, use the following syntax. Both parameters are required. + // metadata-function=lambda_arn, record-function=lambda_arn + // - If you have a composite Lambda function that processes both metadata and + // data, use the following syntax to specify your Lambda function. + // function=lambda_arn Parameters map[string]string noSmithyDocumentSerde diff --git a/service/athena/api_op_UpdateNotebook.go b/service/athena/api_op_UpdateNotebook.go index d602bda721b..ed2b775f117 100644 --- a/service/athena/api_op_UpdateNotebook.go +++ b/service/athena/api_op_UpdateNotebook.go @@ -39,17 +39,17 @@ type UpdateNotebookInput struct { // This member is required. Payload *string - // The notebook content type. Currently, the only valid type is IPYNB. + // The notebook content type. Currently, the only valid type is IPYNB . // // This member is required. Type types.NotebookType - // A unique case-sensitive string used to ensure the request to create the notebook - // is idempotent (executes only once). This token is listed as not required because - // Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) - // auto-generate the token for you. If you are not using the Amazon Web Services - // SDK or the Amazon Web Services CLI, you must provide this token or the action - // will fail. + // A unique case-sensitive string used to ensure the request to create the + // notebook is idempotent (executes only once). This token is listed as not + // required because Amazon Web Services SDKs (for example the Amazon Web Services + // SDK for Java) auto-generate the token for you. If you are not using the Amazon + // Web Services SDK or the Amazon Web Services CLI, you must provide this token or + // the action will fail. ClientRequestToken *string // The active notebook session ID. Required if the notebook has an active session. diff --git a/service/athena/api_op_UpdateNotebookMetadata.go b/service/athena/api_op_UpdateNotebookMetadata.go index 49b8077f356..f385553dd8c 100644 --- a/service/athena/api_op_UpdateNotebookMetadata.go +++ b/service/athena/api_op_UpdateNotebookMetadata.go @@ -38,12 +38,12 @@ type UpdateNotebookMetadataInput struct { // This member is required. NotebookId *string - // A unique case-sensitive string used to ensure the request to create the notebook - // is idempotent (executes only once). This token is listed as not required because - // Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) - // auto-generate the token for you. If you are not using the Amazon Web Services - // SDK or the Amazon Web Services CLI, you must provide this token or the action - // will fail. + // A unique case-sensitive string used to ensure the request to create the + // notebook is idempotent (executes only once). This token is listed as not + // required because Amazon Web Services SDKs (for example the Amazon Web Services + // SDK for Java) auto-generate the token for you. If you are not using the Amazon + // Web Services SDK or the Amazon Web Services CLI, you must provide this token or + // the action will fail. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/athena/doc.go b/service/athena/doc.go index 1ddf55f904d..e87fb867107 100644 --- a/service/athena/doc.go +++ b/service/athena/doc.go @@ -13,9 +13,8 @@ // in the Amazon Athena User Guide. If you connect to Athena using the JDBC driver, // use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier // version drivers do not support the API. For more information and to download the -// driver, see Accessing Amazon Athena with JDBC -// (https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html). For code -// samples using the Amazon Web Services SDK for Java, see Examples and Code -// Samples (https://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the -// Amazon Athena User Guide. +// driver, see Accessing Amazon Athena with JDBC (https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html) +// . For code samples using the Amazon Web Services SDK for Java, see Examples and +// Code Samples (https://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in +// the Amazon Athena User Guide. package athena diff --git a/service/athena/types/enums.go b/service/athena/types/enums.go index c3fe52a0673..e5ef8422bc4 100644 --- a/service/athena/types/enums.go +++ b/service/athena/types/enums.go @@ -127,9 +127,9 @@ const ( ExecutorTypeWorker ExecutorType = "WORKER" ) -// Values returns all known values for ExecutorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExecutorType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExecutorType) Values() []ExecutorType { return []ExecutorType{ "COORDINATOR", @@ -145,9 +145,9 @@ const ( NotebookTypeIpynb NotebookType = "IPYNB" ) -// Values returns all known values for NotebookType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for NotebookType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (NotebookType) Values() []NotebookType { return []NotebookType{ "IPYNB", @@ -208,9 +208,9 @@ const ( SessionStateFailed SessionState = "FAILED" ) -// Values returns all known values for SessionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SessionState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SessionState) Values() []SessionState { return []SessionState{ "CREATING", diff --git a/service/athena/types/errors.go b/service/athena/types/errors.go index 13fadbcdbf7..bae8640191e 100644 --- a/service/athena/types/errors.go +++ b/service/athena/types/errors.go @@ -63,10 +63,10 @@ func (e *InvalidRequestException) ErrorCode() string { func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An exception that Athena received when it called a custom metastore. Occurs if -// the error is not caused by user input (InvalidRequestException) or from the -// Athena platform (InternalServerException). For example, if a user-created Lambda -// function is missing permissions, the Lambda 4XX exception is returned in a -// MetadataException. +// the error is not caused by user input ( InvalidRequestException ) or from the +// Athena platform ( InternalServerException ). For example, if a user-created +// Lambda function is missing permissions, the Lambda 4XX exception is returned in +// a MetadataException . type MetadataException struct { Message *string diff --git a/service/athena/types/types.go b/service/athena/types/types.go index 24fef0e285f..8e0549deae1 100644 --- a/service/athena/types/types.go +++ b/service/athena/types/types.go @@ -10,18 +10,16 @@ import ( // Indicates that an Amazon S3 canned ACL should be set to control ownership of // stored query results. When Athena stores query results in Amazon S3, the canned // ACL is set with the x-amz-acl request header. For more information about S3 -// Object Ownership, see Object Ownership settings -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview) +// Object Ownership, see Object Ownership settings (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview) // in the Amazon S3 User Guide. type AclConfiguration struct { // The Amazon S3 canned ACL that Athena should specify when storing query results. - // Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query - // runs in a workgroup and the workgroup overrides client-side settings, then the - // Amazon S3 canned ACL specified in the workgroup's settings is used for all + // Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a + // query runs in a workgroup and the workgroup overrides client-side settings, then + // the Amazon S3 canned ACL specified in the workgroup's settings is used for all // queries that run in the workgroup. For more information about Amazon S3 canned - // ACLs, see Canned ACL - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) + // ACLs, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) // in the Amazon S3 User Guide. // // This member is required. @@ -34,7 +32,7 @@ type AclConfiguration struct { type ApplicationDPUSizes struct { // The name of the supported application runtime (for example, Athena notebook - // version 1). + // version 1 ). ApplicationRuntimeId *string // A list of the supported DPU sizes that the application runtime supports. @@ -58,9 +56,8 @@ type AthenaError struct { // Contains a short description of the error that occurred. ErrorMessage *string - // An integer value that provides specific information about an Athena query error. - // For the meaning of specific values, see the Error Type Reference - // (https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference) + // An integer value that provides specific information about an Athena query + // error. For the meaning of specific values, see the Error Type Reference (https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference) // in the Amazon Athena User Guide. ErrorType *int32 @@ -242,10 +239,10 @@ type Database struct { // sources page under the Data source name column. type DataCatalog struct { - // The name of the data catalog. The catalog name must be unique for the Amazon Web - // Services account and can use a maximum of 127 alphanumeric, underscore, at sign, - // or hyphen characters. The remainder of the length constraint of 256 is reserved - // for use by Athena. + // The name of the data catalog. The catalog name must be unique for the Amazon + // Web Services account and can use a maximum of 127 alphanumeric, underscore, at + // sign, or hyphen characters. The remainder of the length constraint of 256 is + // reserved for use by Athena. // // This member is required. Name *string @@ -261,35 +258,26 @@ type DataCatalog struct { // Specifies the Lambda function or functions to use for the data catalog. This is // a mapping whose values depend on the catalog type. - // - // * For the HIVE data catalog - // type, use the following syntax. The metadata-function parameter is required. The - // sdk-version parameter is optional and defaults to the currently supported - // version. metadata-function=lambda_arn, sdk-version=version_number - // - // * For the - // LAMBDA data catalog type, use one of the following sets of required parameters, - // but not both. - // - // * If you have one Lambda function that processes metadata and - // another for reading the actual data, use the following syntax. Both parameters - // are required. metadata-function=lambda_arn, record-function=lambda_arn - // - // * If you - // have a composite Lambda function that processes both metadata and data, use the - // following syntax to specify your Lambda function. function=lambda_arn - // - // * The - // GLUE type takes a catalog ID parameter and is required. The catalog_id is the - // account ID of the Amazon Web Services account to which the Glue catalog belongs. - // catalog-id=catalog_id - // - // * The GLUE data catalog type also applies to the default - // AwsDataCatalog that already exists in your account, of which you can have only - // one and cannot modify. - // - // * Queries that specify a Glue Data Catalog other than - // the default AwsDataCatalog must be run on Athena engine version 2. + // - For the HIVE data catalog type, use the following syntax. The + // metadata-function parameter is required. The sdk-version parameter is optional + // and defaults to the currently supported version. + // metadata-function=lambda_arn, sdk-version=version_number + // - For the LAMBDA data catalog type, use one of the following sets of required + // parameters, but not both. + // - If you have one Lambda function that processes metadata and another for + // reading the actual data, use the following syntax. Both parameters are required. + // metadata-function=lambda_arn, record-function=lambda_arn + // - If you have a composite Lambda function that processes both metadata and + // data, use the following syntax to specify your Lambda function. + // function=lambda_arn + // - The GLUE type takes a catalog ID parameter and is required. The catalog_id + // is the account ID of the Amazon Web Services account to which the Glue catalog + // belongs. catalog-id=catalog_id + // - The GLUE data catalog type also applies to the default AwsDataCatalog that + // already exists in your account, of which you can have only one and cannot + // modify. + // - Queries that specify a Glue Data Catalog other than the default + // AwsDataCatalog must be run on Athena engine version 2. Parameters map[string]string noSmithyDocumentSerde @@ -320,20 +308,20 @@ type Datum struct { } // If query and calculation results are encrypted in Amazon S3, indicates the -// encryption option used (for example, SSE_KMS or CSE_KMS) and key information. +// encryption option used (for example, SSE_KMS or CSE_KMS ) and key information. type EncryptionConfiguration struct { - // Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys - // (SSE_S3), server-side encryption with KMS-managed keys (SSE_KMS), or client-side - // encryption with KMS-managed keys (CSE_KMS) is used. If a query runs in a - // workgroup and the workgroup overrides client-side settings, then the workgroup's - // setting for encryption is used. It specifies whether query results must be - // encrypted, for all queries that run in this workgroup. + // Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( + // SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or + // client-side encryption with KMS-managed keys ( CSE_KMS ) is used. If a query + // runs in a workgroup and the workgroup overrides client-side settings, then the + // workgroup's setting for encryption is used. It specifies whether query results + // must be encrypted, for all queries that run in this workgroup. // // This member is required. EncryptionOption EncryptionOption - // For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID. + // For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID. KmsKey *string noSmithyDocumentSerde @@ -367,8 +355,8 @@ type EngineConfiguration struct { noSmithyDocumentSerde } -// The Athena engine version for running queries, or the PySpark engine version for -// running sessions. +// The Athena engine version for running queries, or the PySpark engine version +// for running sessions. type EngineVersion struct { // Read only. The engine version on which the query runs. If the user requests a @@ -380,7 +368,7 @@ type EngineVersion struct { EffectiveEngineVersion *string // The engine version requested by the user. Possible values are determined by the - // output of ListEngineVersions, including AUTO. The default is AUTO. + // output of ListEngineVersions , including AUTO. The default is AUTO. SelectedEngineVersion *string noSmithyDocumentSerde @@ -407,7 +395,8 @@ type ExecutorsSummary struct { // longer running. ExecutorState ExecutorState - // The type of executor used for the application (COORDINATOR, GATEWAY, or WORKER). + // The type of executor used for the application ( COORDINATOR , GATEWAY , or + // WORKER ). ExecutorType ExecutorType // The date and time that the executor started. @@ -474,7 +463,7 @@ type NotebookMetadata struct { // The notebook ID. NotebookId *string - // The type of notebook. Currently, the only valid type is IPYNB. + // The type of notebook. Currently, the only valid type is IPYNB . Type NotebookType // The name of the Spark enabled workgroup to which the notebook belongs. @@ -548,8 +537,8 @@ type QueryExecution struct { // The unique identifier for each query execution. QueryExecutionId *string - // The location in Amazon S3 where query and calculation results are stored and the - // encryption option, if any, used for query results. These are known as + // The location in Amazon S3 where query and calculation results are stored and + // the encryption option, if any, used for query results. These are known as // "client-side settings". If workgroup settings override client-side settings, // then the query uses the location for the query results and the encryption // configuration that are specified for the workgroup. @@ -560,16 +549,16 @@ type QueryExecution struct { // The type of query statement that was run. DDL indicates DDL query statements. // DML indicates DML (Data Manipulation Language) query statements, such as CREATE - // TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such - // as SHOW CREATE TABLE, or DESCRIBE TABLE. + // TABLE AS SELECT . UTILITY indicates query statements other than DDL and DML, + // such as SHOW CREATE TABLE , or DESCRIBE TABLE . StatementType StatementType // Query execution statistics, such as the amount of data scanned, the amount of // time that the query took to process, and the type of statement that was run. Statistics *QueryExecutionStatistics - // The completion date, current state, submission time, and state change reason (if - // applicable) for the query execution. + // The completion date, current state, submission time, and state change reason + // (if applicable) for the query execution. Status *QueryExecutionStatus // The kind of query statement that was run. @@ -587,8 +576,8 @@ type QueryExecutionContext struct { // The name of the data catalog used in the query execution. Catalog *string - // The name of the database used in the query execution. The database must exist in - // the catalog. + // The name of the database used in the query execution. The database must exist + // in the catalog. Database *string noSmithyDocumentSerde @@ -603,9 +592,8 @@ type QueryExecutionStatistics struct { // files that the query wrote to Amazon S3. If the query fails, the manifest file // also tracks files that the query intended to write. The manifest is useful for // identifying orphaned files resulting from a failed query. For more information, - // see Working with Query Results, Output Files, and Query History - // (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the Amazon - // Athena User Guide. + // see Working with Query Results, Output Files, and Query History (https://docs.aws.amazon.com/athena/latest/ug/querying.html) + // in the Amazon Athena User Guide. DataManifestLocation *string // The number of bytes in the data that was queried. @@ -639,8 +627,8 @@ type QueryExecutionStatistics struct { noSmithyDocumentSerde } -// The completion date, current state, submission time, and state change reason (if -// applicable) for the query execution. +// The completion date, current state, submission time, and state change reason +// (if applicable) for the query execution. type QueryExecutionStatus struct { // Provides information about an Athena query error. @@ -649,14 +637,14 @@ type QueryExecutionStatus struct { // The date and time that the query completed. CompletionDateTime *time.Time - // The state of query execution. QUEUED indicates that the query has been submitted - // to the service, and Athena will execute the query as soon as resources are - // available. RUNNING indicates that the query is in execution phase. SUCCEEDED + // The state of query execution. QUEUED indicates that the query has been + // submitted to the service, and Athena will execute the query as soon as resources + // are available. RUNNING indicates that the query is in execution phase. SUCCEEDED // indicates that the query completed without errors. FAILED indicates that the // query experienced an error and did not complete processing. CANCELLED indicates // that a user input interrupted query execution. Athena automatically retries your // queries in cases of certain transient errors. As a result, you may see the query - // state transition from RUNNING or FAILED to QUEUED. + // state transition from RUNNING or FAILED to QUEUED . State QueryExecutionState // Further detail about the status of the query. @@ -668,16 +656,16 @@ type QueryExecutionStatus struct { noSmithyDocumentSerde } -// The query execution timeline, statistics on input and output rows and bytes, and -// the different query stages that form the query execution plan. +// The query execution timeline, statistics on input and output rows and bytes, +// and the different query stages that form the query execution plan. type QueryRuntimeStatistics struct { // Stage statistics such as input and output rows and bytes, execution time, and // stage state. This information also includes substages and the query stage plan. OutputStage *QueryStage - // Statistics such as input rows and bytes read by the query, rows and bytes output - // by the query, and the number of rows written by the query. + // Statistics such as input rows and bytes read by the query, rows and bytes + // output by the query, and the number of rows written by the query. Rows *QueryRuntimeStatisticsRows // Timeline statistics such as query queue time, planning time, execution time, @@ -687,8 +675,8 @@ type QueryRuntimeStatistics struct { noSmithyDocumentSerde } -// Statistics such as input rows and bytes read by the query, rows and bytes output -// by the query, and the number of rows written by the query. +// Statistics such as input rows and bytes read by the query, rows and bytes +// output by the query, and the number of rows written by the query. type QueryRuntimeStatisticsRows struct { // The number of bytes read to execute the query. @@ -788,58 +776,57 @@ type QueryStagePlanNode struct { noSmithyDocumentSerde } -// The location in Amazon S3 where query and calculation results are stored and the -// encryption option, if any, used for query and calculation results. These are +// The location in Amazon S3 where query and calculation results are stored and +// the encryption option, if any, used for query and calculation results. These are // known as "client-side settings". If workgroup settings override client-side // settings, then the query uses the workgroup settings. type ResultConfiguration struct { // Indicates that an Amazon S3 canned ACL should be set to control ownership of // stored query results. Currently the only supported canned ACL is - // BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings + // BUCKET_OWNER_FULL_CONTROL . This is a client-side setting. If workgroup settings // override client-side settings, then the query uses the ACL configuration that is // specified for the workgroup, and also uses the location for storing query // results specified in the workgroup. For more information, see // WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings - // Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . AclConfiguration *AclConfiguration // If query and calculation results are encrypted in Amazon S3, indicates the - // encryption option used (for example, SSE_KMS or CSE_KMS) and key information. + // encryption option used (for example, SSE_KMS or CSE_KMS ) and key information. // This is a client-side setting. If workgroup settings override client-side // settings, then the query uses the encryption configuration that is specified for // the workgroup, and also uses the location for storing query results specified in // the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . EncryptionConfiguration *EncryptionConfiguration - // The Amazon Web Services account ID that you expect to be the owner of the Amazon - // S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses - // the value for ExpectedBucketOwner when it makes Amazon S3 calls to your - // specified output location. If the ExpectedBucketOwner Amazon Web Services + // The Amazon Web Services account ID that you expect to be the owner of the + // Amazon S3 bucket specified by ResultConfiguration$OutputLocation . If set, + // Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to + // your specified output location. If the ExpectedBucketOwner Amazon Web Services // account ID does not match the actual owner of the Amazon S3 bucket, the call // fails with a permissions error. This is a client-side setting. If workgroup // settings override client-side settings, then the query uses the // ExpectedBucketOwner setting that is specified for the workgroup, and also uses // the location for storing query results specified in the workgroup. See // WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings - // Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . ExpectedBucketOwner *string // The location in Amazon S3 where your query and calculation results are stored, - // such as s3://path/to/query/bucket/. To run the query, you must specify the query - // results location using one of the ways: either for individual queries using - // either this setting (client-side), or in the workgroup, using - // WorkGroupConfiguration. If none of them is set, Athena issues an error that no + // such as s3://path/to/query/bucket/ . To run the query, you must specify the + // query results location using one of the ways: either for individual queries + // using either this setting (client-side), or in the workgroup, using + // WorkGroupConfiguration . If none of them is set, Athena issues an error that no // output location is provided. For more information, see Working with query - // results, recent queries, and output files - // (https://docs.aws.amazon.com/athena/latest/ug/querying.html). If workgroup - // settings override client-side settings, then the query uses the settings - // specified for the workgroup. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html) + // . If workgroup settings override client-side settings, then the query uses the + // settings specified for the workgroup. See + // WorkGroupConfiguration$EnforceWorkGroupConfiguration . OutputLocation *string noSmithyDocumentSerde @@ -855,38 +842,37 @@ type ResultConfigurationUpdates struct { // The encryption configuration for query and calculation results. EncryptionConfiguration *EncryptionConfiguration - // The Amazon Web Services account ID that you expect to be the owner of the Amazon - // S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses - // the value for ExpectedBucketOwner when it makes Amazon S3 calls to your - // specified output location. If the ExpectedBucketOwner Amazon Web Services + // The Amazon Web Services account ID that you expect to be the owner of the + // Amazon S3 bucket specified by ResultConfiguration$OutputLocation . If set, + // Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to + // your specified output location. If the ExpectedBucketOwner Amazon Web Services // account ID does not match the actual owner of the Amazon S3 bucket, the call // fails with a permissions error. If workgroup settings override client-side // settings, then the query uses the ExpectedBucketOwner setting that is specified // for the workgroup, and also uses the location for storing query results // specified in the workgroup. See // WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings - // Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . ExpectedBucketOwner *string // The location in Amazon S3 where your query and calculation results are stored, - // such as s3://path/to/query/bucket/. For more information, see Working with query - // results, recent queries, and output files - // (https://docs.aws.amazon.com/athena/latest/ug/querying.html). If workgroup - // settings override client-side settings, then the query uses the location for the - // query results and the encryption configuration that are specified for the - // workgroup. The "workgroup settings override" is specified in - // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // such as s3://path/to/query/bucket/ . For more information, see Working with + // query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html) + // . If workgroup settings override client-side settings, then the query uses the + // location for the query results and the encryption configuration that are + // specified for the workgroup. The "workgroup settings override" is specified in + // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration . See + // WorkGroupConfiguration$EnforceWorkGroupConfiguration . OutputLocation *string - // If set to true, indicates that the previously-specified ACL configuration for + // If set to true , indicates that the previously-specified ACL configuration for // queries in this workgroup should be ignored and set to null. If set to false or // not set, and a value is present in the AclConfiguration of - // ResultConfigurationUpdates, the AclConfiguration in the workgroup's + // ResultConfigurationUpdates , the AclConfiguration in the workgroup's // ResultConfiguration is updated with the new value. For more information, see - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . RemoveAclConfiguration *bool // If set to "true", indicates that the previously-specified encryption @@ -895,27 +881,27 @@ type ResultConfigurationUpdates struct { // value is present in the EncryptionConfiguration in ResultConfigurationUpdates // (the client-side setting), the EncryptionConfiguration in the workgroup's // ResultConfiguration will be updated with the new value. For more information, - // see Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // see Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . RemoveEncryptionConfiguration *bool // If set to "true", removes the Amazon Web Services account ID previously - // specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not + // specified for ResultConfiguration$ExpectedBucketOwner . If set to "false" or not // set, and a value is present in the ExpectedBucketOwner in - // ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in - // the workgroup's ResultConfiguration is updated with the new value. For more - // information, see Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner + // in the workgroup's ResultConfiguration is updated with the new value. For more + // information, see Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . RemoveExpectedBucketOwner *bool - // If set to "true", indicates that the previously-specified query results location - // (also known as a client-side setting) for queries in this workgroup should be - // ignored and set to null. If set to "false" or not set, and a value is present in - // the OutputLocation in ResultConfigurationUpdates (the client-side setting), the - // OutputLocation in the workgroup's ResultConfiguration will be updated with the - // new value. For more information, see Workgroup Settings Override Client-Side - // Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // If set to "true", indicates that the previously-specified query results + // location (also known as a client-side setting) for queries in this workgroup + // should be ignored and set to null. If set to "false" or not set, and a value is + // present in the OutputLocation in ResultConfigurationUpdates (the client-side + // setting), the OutputLocation in the workgroup's ResultConfiguration will be + // updated with the new value. For more information, see Workgroup Settings + // Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . RemoveOutputLocation *bool noSmithyDocumentSerde @@ -962,7 +948,7 @@ type ResultReuseInformation struct { // The metadata and rows that make up a query result set. The metadata describes // the column structure and data types. To return a ResultSet object, use -// GetQueryResults. +// GetQueryResults . type ResultSet struct { // The metadata that describes the column structure and data types of a table of @@ -976,7 +962,7 @@ type ResultSet struct { } // The metadata that describes the column structure and data types of a table of -// query results. To return a ResultSetMetadata object, use GetQueryResults. +// query results. To return a ResultSetMetadata object, use GetQueryResults . type ResultSetMetadata struct { // Information about the columns returned in a query result metadata. @@ -998,7 +984,7 @@ type Row struct { type SessionConfiguration struct { // If query and calculation results are encrypted in Amazon S3, indicates the - // encryption option used (for example, SSE_KMS or CSE_KMS) and key information. + // encryption option used (for example, SSE_KMS or CSE_KMS ) and key information. EncryptionConfiguration *EncryptionConfiguration // The ARN of the execution role used for the session. @@ -1028,8 +1014,8 @@ type SessionStatus struct { // The date and time that the session ended. EndDateTime *time.Time - // The date and time starting at which the session became idle. Can be empty if the - // session is not currently idle. + // The date and time starting at which the session became idle. Can be empty if + // the session is not currently idle. IdleSinceDateTime *time.Time // The most recent date and time that the session was modified. @@ -1040,8 +1026,8 @@ type SessionStatus struct { // The state of the session. A description of each state follows. CREATING - The // session is being started, including acquiring resources. CREATED - The session - // has been started. IDLE - The session is able to accept a calculation. BUSY - The - // session is processing another task and is unable to accept a calculation. + // has been started. IDLE - The session is able to accept a calculation. BUSY - + // The session is processing another task and is unable to accept a calculation. // TERMINATING - The session is in the process of shutting down. TERMINATED - The // session and its resources are no longer running. DEGRADED - The session has no // healthy coordinators. FAILED - Due to a failure, the session and its resources @@ -1061,7 +1047,7 @@ type SessionSummary struct { // The session description. Description *string - // The engine version used by the session (for example, PySpark engine version 3). + // The engine version used by the session (for example, PySpark engine version 3 ). EngineVersion *EngineVersion // The notebook version. @@ -1110,9 +1096,8 @@ type TableMetadata struct { // you define. For example, you can use tags to categorize Athena workgroups or // data catalogs by purpose, owner, or environment. Use a consistent set of tag // keys to make it easier to search and filter workgroups or data catalogs in your -// account. For best practices, see Tagging Best Practices -// (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html). -// Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be +// account. For best practices, see Tagging Best Practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) +// . Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be // from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers // representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys // and values are case-sensitive. Tag keys must be unique per resource. If you @@ -1158,16 +1143,12 @@ type UnprocessedPreparedStatementName struct { // The error message containing the reason why the prepared statement could not be // returned. The following error messages are possible: - // - // * INVALID_INPUT - The name - // of the prepared statement that was provided is not valid (for example, the name - // is too long). - // - // * STATEMENT_NOT_FOUND - A prepared statement with the name - // provided could not be found. - // - // * UNAUTHORIZED - The requester does not have - // permission to access the workgroup that contains the prepared statement. + // - INVALID_INPUT - The name of the prepared statement that was provided is not + // valid (for example, the name is too long). + // - STATEMENT_NOT_FOUND - A prepared statement with the name provided could not + // be found. + // - UNAUTHORIZED - The requester does not have permission to access the + // workgroup that contains the prepared statement. ErrorMessage *string // The name of a prepared statement that could not be returned due to an error. @@ -1193,15 +1174,15 @@ type UnprocessedQueryExecutionId struct { noSmithyDocumentSerde } -// A workgroup, which contains a name, description, creation time, state, and other -// configuration, listed under WorkGroup$Configuration. Each workgroup enables you -// to isolate queries for you or your group of users from other queries in the same -// account, to configure the query results location and the encryption +// A workgroup, which contains a name, description, creation time, state, and +// other configuration, listed under WorkGroup$Configuration . Each workgroup +// enables you to isolate queries for you or your group of users from other queries +// in the same account, to configure the query results location and the encryption // configuration (known as workgroup settings), to enable sending query metrics to // Amazon CloudWatch, and to establish per-query data usage control limits for all // queries in a workgroup. The workgroup settings override is specified in -// EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See -// WorkGroupConfiguration$EnforceWorkGroupConfiguration. +// EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration . See +// WorkGroupConfiguration$EnforceWorkGroupConfiguration . type WorkGroup struct { // The workgroup name. @@ -1215,8 +1196,8 @@ type WorkGroup struct { // Metrics are enabled for the workgroup; whether workgroup settings override // client-side settings; and the data usage limits for the amount of data scanned // per query or per workgroup. The workgroup settings override is specified in - // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration . See + // WorkGroupConfiguration$EnforceWorkGroupConfiguration . Configuration *WorkGroupConfiguration // The date and time the workgroup was created. @@ -1237,8 +1218,8 @@ type WorkGroup struct { // are enabled for the workgroup and whether workgroup settings override query // settings, and the data usage limits for the amount of data scanned per query or // per workgroup. The workgroup settings override is specified in -// EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See -// WorkGroupConfiguration$EnforceWorkGroupConfiguration. +// EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration . See +// WorkGroupConfiguration$EnforceWorkGroupConfiguration . type WorkGroupConfiguration struct { // Specifies a user defined JSON string that is passed to the notebook engine. @@ -1263,13 +1244,13 @@ type WorkGroupConfiguration struct { // If set to "true", the settings for the workgroup override client-side settings. // If set to "false", client-side settings are used. For more information, see - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . EnforceWorkGroupConfiguration *bool - // The engine version that all queries running on the workgroup use. Queries on the - // AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless - // of this setting. + // The engine version that all queries running on the workgroup use. Queries on + // the AmazonAthenaPreviewFunctionality workgroup run on the preview engine + // regardless of this setting. EngineVersion *EngineVersion // Role used in a session for accessing the user's resources. @@ -1278,13 +1259,12 @@ type WorkGroupConfiguration struct { // Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. PublishCloudWatchMetricsEnabled *bool - // If set to true, allows members assigned to a workgroup to reference Amazon S3 - // Requester Pays buckets in queries. If set to false, workgroup members cannot + // If set to true , allows members assigned to a workgroup to reference Amazon S3 + // Requester Pays buckets in queries. If set to false , workgroup members cannot // query data from Requester Pays buckets, and queries that retrieve data from - // Requester Pays buckets cause an error. The default is false. For more - // information about Requester Pays buckets, see Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in - // the Amazon Simple Storage Service Developer Guide. + // Requester Pays buckets cause an error. The default is false . For more + // information about Requester Pays buckets, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) + // in the Amazon Simple Storage Service Developer Guide. RequesterPaysEnabled *bool // The configuration for the workgroup, which includes the location in Amazon S3 @@ -1292,10 +1272,10 @@ type WorkGroupConfiguration struct { // any, used for query and calculation results. To run the query, you must specify // the query results location using one of the ways: either in the workgroup using // this setting, or for individual queries (client-side), using - // ResultConfiguration$OutputLocation. If none of them is set, Athena issues an + // ResultConfiguration$OutputLocation . If none of them is set, Athena issues an // error that no output location is provided. For more information, see Working - // with query results, recent queries, and output files - // (https://docs.aws.amazon.com/athena/latest/ug/querying.html). + // with query results, recent queries, and output files (https://docs.aws.amazon.com/athena/latest/ug/querying.html) + // . ResultConfiguration *ResultConfiguration noSmithyDocumentSerde @@ -1331,8 +1311,8 @@ type WorkGroupConfigurationUpdates struct { // If set to "true", the settings for the workgroup override client-side settings. // If set to "false" client-side settings are used. For more information, see - // Workgroup Settings Override Client-Side Settings - // (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). + // Workgroup Settings Override Client-Side Settings (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) + // . EnforceWorkGroupConfiguration *bool // The engine version requested when a workgroup is updated. After the update, all @@ -1356,13 +1336,12 @@ type WorkGroupConfigurationUpdates struct { // Removes content encryption configuration for a workgroup. RemoveCustomerContentEncryptionConfiguration *bool - // If set to true, allows members assigned to a workgroup to specify Amazon S3 - // Requester Pays buckets in queries. If set to false, workgroup members cannot + // If set to true , allows members assigned to a workgroup to specify Amazon S3 + // Requester Pays buckets in queries. If set to false , workgroup members cannot // query data from Requester Pays buckets, and queries that retrieve data from - // Requester Pays buckets cause an error. The default is false. For more - // information about Requester Pays buckets, see Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in - // the Amazon Simple Storage Service Developer Guide. + // Requester Pays buckets cause an error. The default is false . For more + // information about Requester Pays buckets, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) + // in the Amazon Simple Storage Service Developer Guide. RequesterPaysEnabled *bool // The result configuration information about the queries in this workgroup that diff --git a/service/auditmanager/api_client.go b/service/auditmanager/api_client.go index 75c1cb78ef8..ca6d7c9c008 100644 --- a/service/auditmanager/api_client.go +++ b/service/auditmanager/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go b/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go index 49f316772da..9b218211285 100644 --- a/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go +++ b/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go @@ -15,25 +15,18 @@ import ( // assessment. You can upload manual evidence from any Amazon Simple Storage // Service (Amazon S3) bucket by specifying the S3 URI of the evidence. You must // upload manual evidence to your S3 bucket before you can upload it to your -// assessment. For instructions, see CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) and -// PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// assessment. For instructions, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// and PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // in the Amazon Simple Storage Service API Reference. The following restrictions // apply to this action: +// - Maximum size of an individual evidence file: 100 MB +// - Number of daily manual evidence uploads per control: 100 +// - Supported file formats: See Supported file types for manual evidence (https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files) +// in the Audit Manager User Guide // -// * Maximum size of an individual evidence file: 100 MB -// -// * -// Number of daily manual evidence uploads per control: 100 -// -// * Supported file -// formats: See Supported file types for manual evidence -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files) -// in the Audit Manager User Guide -// -// For more information about Audit Manager -// service restrictions, see Quotas and restrictions for Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). +// For more information about Audit Manager service restrictions, see Quotas and +// restrictions for Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html) +// . func (c *Client) BatchImportEvidenceToAssessmentControl(ctx context.Context, params *BatchImportEvidenceToAssessmentControlInput, optFns ...func(*Options)) (*BatchImportEvidenceToAssessmentControlOutput, error) { if params == nil { params = &BatchImportEvidenceToAssessmentControlInput{} diff --git a/service/auditmanager/api_op_CreateAssessment.go b/service/auditmanager/api_op_CreateAssessment.go index ce405e932a6..19fea5f69d0 100644 --- a/service/auditmanager/api_op_CreateAssessment.go +++ b/service/auditmanager/api_op_CreateAssessment.go @@ -50,8 +50,8 @@ type CreateAssessmentInput struct { // This member is required. Roles []types.Role - // The wrapper that contains the Amazon Web Services accounts and services that are - // in scope for the assessment. + // The wrapper that contains the Amazon Web Services accounts and services that + // are in scope for the assessment. // // This member is required. Scope *types.Scope diff --git a/service/auditmanager/api_op_CreateAssessmentReport.go b/service/auditmanager/api_op_CreateAssessmentReport.go index 48941b00dc3..aec5292bae6 100644 --- a/service/auditmanager/api_op_CreateAssessmentReport.go +++ b/service/auditmanager/api_op_CreateAssessmentReport.go @@ -42,20 +42,16 @@ type CreateAssessmentReportInput struct { // The description of the assessment report. Description *string - // A SQL statement that represents an evidence finder query. Provide this parameter - // when you want to generate an assessment report from the results of an evidence - // finder search query. When you use this parameter, Audit Manager generates a - // one-time report using only the evidence from the query output. This report does - // not include any assessment evidence that was manually added to a report using - // the console - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence), - // or associated with a report using the API - // (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html). - // To use this parameter, the enablementStatus - // (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus) - // of evidence finder must be ENABLED. For examples and help resolving - // queryStatement validation exceptions, see Troubleshooting evidence finder issues - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions) + // A SQL statement that represents an evidence finder query. Provide this + // parameter when you want to generate an assessment report from the results of an + // evidence finder search query. When you use this parameter, Audit Manager + // generates a one-time report using only the evidence from the query output. This + // report does not include any assessment evidence that was manually added to a + // report using the console (https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence) + // , or associated with a report using the API (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html) + // . To use this parameter, the enablementStatus (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus) + // of evidence finder must be ENABLED . For examples and help resolving + // queryStatement validation exceptions, see Troubleshooting evidence finder issues (https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions) // in the Audit Manager User Guide. QueryStatement *string diff --git a/service/auditmanager/api_op_DeleteAssessmentReport.go b/service/auditmanager/api_op_DeleteAssessmentReport.go index 1dd128f7b83..a5af4face27 100644 --- a/service/auditmanager/api_op_DeleteAssessmentReport.go +++ b/service/auditmanager/api_op_DeleteAssessmentReport.go @@ -13,27 +13,21 @@ import ( // Deletes an assessment report in Audit Manager. When you run the // DeleteAssessmentReport operation, Audit Manager attempts to delete the following // data: +// - The specified assessment report that’s stored in your S3 bucket +// - The associated metadata that’s stored in Audit Manager // -// * The specified assessment report that’s stored in your S3 bucket -// -// * The -// associated metadata that’s stored in Audit Manager -// -// If Audit Manager can’t -// access the assessment report in your S3 bucket, the report isn’t deleted. In -// this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it -// proceeds to delete the associated metadata only. You must then delete the -// assessment report from the S3 bucket yourself. This scenario happens when Audit -// Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To -// avoid this, make sure that your S3 bucket is available, and that you configured -// the correct permissions for Audit Manager to delete resources in your S3 bucket. -// For an example permissions policy that you can use, see Assessment report -// destination permissions -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination) +// If Audit Manager can’t access the assessment report in your S3 bucket, the +// report isn’t deleted. In this event, the DeleteAssessmentReport operation +// doesn’t fail. Instead, it proceeds to delete the associated metadata only. You +// must then delete the assessment report from the S3 bucket yourself. This +// scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not +// Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is +// available, and that you configured the correct permissions for Audit Manager to +// delete resources in your S3 bucket. For an example permissions policy that you +// can use, see Assessment report destination permissions (https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination) // in the Audit Manager User Guide. For information about the issues that could -// cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of -// Error Codes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) +// cause a 403 (Forbidden) or 404 (Not Found ) error from Amazon S3, see List of +// Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) // in the Amazon Simple Storage Service API Reference. func (c *Client) DeleteAssessmentReport(ctx context.Context, params *DeleteAssessmentReportInput, optFns ...func(*Options)) (*DeleteAssessmentReportOutput, error) { if params == nil { diff --git a/service/auditmanager/api_op_DeregisterAccount.go b/service/auditmanager/api_op_DeregisterAccount.go index 92a04566590..5349eef8107 100644 --- a/service/auditmanager/api_op_DeregisterAccount.go +++ b/service/auditmanager/api_op_DeregisterAccount.go @@ -12,13 +12,11 @@ import ( ) // Deregisters an account in Audit Manager. Before you deregister, you can use the -// UpdateSettings -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html) +// UpdateSettings (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html) // API operation to set your preferred data retention policy. By default, Audit // Manager retains your data. If you want to delete your data, you can use the // DeregistrationPolicy attribute to request the deletion of your data. For more -// information about data retention, see Data Protection -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) +// information about data retention, see Data Protection (https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) // in the Audit Manager User Guide. func (c *Client) DeregisterAccount(ctx context.Context, params *DeregisterAccountInput, optFns ...func(*Options)) (*DeregisterAccountOutput, error) { if params == nil { diff --git a/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go b/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go index 6947c1ed6ef..682e5e9fb8d 100644 --- a/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go +++ b/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go @@ -24,9 +24,8 @@ import ( // account when they enabled evidence finder. If this task isn’t completed, the // event data store remains in their account. In this case, we recommend that the // original delegated administrator goes to CloudTrail Lake and manually deletes -// the event data store -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html). -// This cleanup task is necessary to ensure that you don't end up with multiple +// the event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html) +// . This cleanup task is necessary to ensure that you don't end up with multiple // event data stores. Audit Manager ignores an unused event data store after you // remove or change a delegated administrator account. However, the unused event // data store continues to incur storage costs from CloudTrail Lake if you don't @@ -37,41 +36,26 @@ import ( // Audit Manager console. Or, you can use one of the delete API operations that are // provided by Audit Manager. To delete your Audit Manager resource data, see the // following instructions: +// - DeleteAssessment (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html) +// (see also: Deleting an assessment (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html) +// in the Audit Manager User Guide) +// - DeleteAssessmentFramework (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html) +// (see also: Deleting a custom framework (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html) +// in the Audit Manager User Guide) +// - DeleteAssessmentFrameworkShare (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html) +// (see also: Deleting a share request (https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html) +// in the Audit Manager User Guide) +// - DeleteAssessmentReport (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html) +// (see also: Deleting an assessment report (https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps) +// in the Audit Manager User Guide) +// - DeleteControl (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html) +// (see also: Deleting a custom control (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html) +// in the Audit Manager User Guide) // -// * DeleteAssessment -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html) -// (see also: Deleting an assessment -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html) -// in the Audit Manager User Guide) -// -// * DeleteAssessmentFramework -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html) -// (see also: Deleting a custom framework -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html) -// in the Audit Manager User Guide) -// -// * DeleteAssessmentFrameworkShare -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html) -// (see also: Deleting a share request -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html) -// in the Audit Manager User Guide) -// -// * DeleteAssessmentReport -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html) -// (see also: Deleting an assessment report -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps) -// in the Audit Manager User Guide) -// -// * DeleteControl -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html) -// (see also: Deleting a custom control -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html) -// in the Audit Manager User Guide) -// -// At this time, Audit Manager doesn't provide an -// option to delete evidence for a specific delegated administrator. Instead, when -// your management account deregisters Audit Manager, we perform a cleanup for the -// current delegated administrator account at the time of deregistration. +// At this time, Audit Manager doesn't provide an option to delete evidence for a +// specific delegated administrator. Instead, when your management account +// deregisters Audit Manager, we perform a cleanup for the current delegated +// administrator account at the time of deregistration. func (c *Client) DeregisterOrganizationAdminAccount(ctx context.Context, params *DeregisterOrganizationAdminAccountInput, optFns ...func(*Options)) (*DeregisterOrganizationAdminAccountOutput, error) { if params == nil { params = &DeregisterOrganizationAdminAccountInput{} diff --git a/service/auditmanager/api_op_GetServicesInScope.go b/service/auditmanager/api_op_GetServicesInScope.go index e170b12184a..6e3e224aadd 100644 --- a/service/auditmanager/api_op_GetServicesInScope.go +++ b/service/auditmanager/api_op_GetServicesInScope.go @@ -12,11 +12,10 @@ import ( ) // Returns a list of all of the Amazon Web Services that you can choose to include -// in your assessment. When you create an assessment -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html), -// specify which of these services you want to include to narrow the assessment's -// scope -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html). +// in your assessment. When you create an assessment (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html) +// , specify which of these services you want to include to narrow the assessment's +// scope (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html) +// . func (c *Client) GetServicesInScope(ctx context.Context, params *GetServicesInScopeInput, optFns ...func(*Options)) (*GetServicesInScopeOutput, error) { if params == nil { params = &GetServicesInScopeInput{} diff --git a/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go b/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go index ebef81ae2c6..282953b4f4d 100644 --- a/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go +++ b/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go @@ -16,7 +16,7 @@ import ( // and a specific active assessment. Control insights are listed only if the // control belongs to the control domain and assessment that was specified. // Moreover, the control must have collected evidence on the lastUpdated date of -// controlInsightsByAssessment. If neither of these conditions are met, no data is +// controlInsightsByAssessment . If neither of these conditions are met, no data is // listed for that control. func (c *Client) ListAssessmentControlInsightsByControlDomain(ctx context.Context, params *ListAssessmentControlInsightsByControlDomainInput, optFns ...func(*Options)) (*ListAssessmentControlInsightsByControlDomainOutput, error) { if params == nil { diff --git a/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go b/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go index c039f0a5ceb..a6fd33ff3da 100644 --- a/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go +++ b/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of sent or received share requests for custom frameworks in Audit -// Manager. +// Returns a list of sent or received share requests for custom frameworks in +// Audit Manager. func (c *Client) ListAssessmentFrameworkShareRequests(ctx context.Context, params *ListAssessmentFrameworkShareRequestsInput, optFns ...func(*Options)) (*ListAssessmentFrameworkShareRequestsOutput, error) { if params == nil { params = &ListAssessmentFrameworkShareRequestsInput{} diff --git a/service/auditmanager/api_op_ListControlDomainInsights.go b/service/auditmanager/api_op_ListControlDomainInsights.go index 37e638b3d73..fdc31c9b504 100644 --- a/service/auditmanager/api_op_ListControlDomainInsights.go +++ b/service/auditmanager/api_op_ListControlDomainInsights.go @@ -15,7 +15,7 @@ import ( // Lists the latest analytics data for control domains across all of your active // assessments. A control domain is listed only if at least one of the controls // within that domain collected evidence on the lastUpdated date of -// controlDomainInsights. If this condition isn’t met, no data is listed for that +// controlDomainInsights . If this condition isn’t met, no data is listed for that // control domain. func (c *Client) ListControlDomainInsights(ctx context.Context, params *ListControlDomainInsightsInput, optFns ...func(*Options)) (*ListControlDomainInsightsOutput, error) { if params == nil { diff --git a/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go b/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go index 5f6e7d8a8d7..865d8a815d7 100644 --- a/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go +++ b/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists analytics data for control domains within a specified active assessment. A -// control domain is listed only if at least one of the controls within that domain -// collected evidence on the lastUpdated date of controlDomainInsights. If this -// condition isn’t met, no data is listed for that domain. +// Lists analytics data for control domains within a specified active assessment. +// A control domain is listed only if at least one of the controls within that +// domain collected evidence on the lastUpdated date of controlDomainInsights . If +// this condition isn’t met, no data is listed for that domain. func (c *Client) ListControlDomainInsightsByAssessment(ctx context.Context, params *ListControlDomainInsightsByAssessmentInput, optFns ...func(*Options)) (*ListControlDomainInsightsByAssessmentOutput, error) { if params == nil { params = &ListControlDomainInsightsByAssessmentInput{} diff --git a/service/auditmanager/api_op_ListControlInsightsByControlDomain.go b/service/auditmanager/api_op_ListControlInsightsByControlDomain.go index fdc05d52b9a..b808480dd4f 100644 --- a/service/auditmanager/api_op_ListControlInsightsByControlDomain.go +++ b/service/auditmanager/api_op_ListControlInsightsByControlDomain.go @@ -15,8 +15,8 @@ import ( // Lists the latest analytics data for controls within a specific control domain // across all active assessments. Control insights are listed only if the control // belongs to the control domain that was specified and the control collected -// evidence on the lastUpdated date of controlInsightsMetadata. If neither of these -// conditions are met, no data is listed for that control. +// evidence on the lastUpdated date of controlInsightsMetadata . If neither of +// these conditions are met, no data is listed for that control. func (c *Client) ListControlInsightsByControlDomain(ctx context.Context, params *ListControlInsightsByControlDomainInput, optFns ...func(*Options)) (*ListControlInsightsByControlDomainOutput, error) { if params == nil { params = &ListControlInsightsByControlDomainInput{} diff --git a/service/auditmanager/api_op_StartAssessmentFrameworkShare.go b/service/auditmanager/api_op_StartAssessmentFrameworkShare.go index f46f0dd29cd..7e2ada5d083 100644 --- a/service/auditmanager/api_op_StartAssessmentFrameworkShare.go +++ b/service/auditmanager/api_op_StartAssessmentFrameworkShare.go @@ -20,21 +20,14 @@ import ( // same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager // deletes the snapshot and the backup snapshot when one of the following events // occurs: +// - The sender revokes the share request. +// - The recipient declines the share request. +// - The recipient encounters an error and doesn't successfully accept the share +// request. +// - The share request expires before the recipient responds to the request. // -// * The sender revokes the share request. -// -// * The recipient declines the -// share request. -// -// * The recipient encounters an error and doesn't successfully -// accept the share request. -// -// * The share request expires before the recipient -// responds to the request. -// -// When a sender resends a share request -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend), -// the snapshot is replaced with an updated version that corresponds with the +// When a sender resends a share request (https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend) +// , the snapshot is replaced with an updated version that corresponds with the // latest version of the custom framework. When a recipient accepts a share // request, the snapshot is replicated into their Amazon Web Services account under // the Amazon Web Services Region that was specified in the share request. When you @@ -44,8 +37,7 @@ import ( // designated as not eligible for sharing by Amazon Web Services, unless you have // obtained permission to do so from the owner of the standard framework. To learn // more about which standard frameworks are eligible for sharing, see Framework -// sharing eligibility -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) +// sharing eligibility (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) // in the Audit Manager User Guide. func (c *Client) StartAssessmentFrameworkShare(ctx context.Context, params *StartAssessmentFrameworkShareInput, optFns ...func(*Options)) (*StartAssessmentFrameworkShareOutput, error) { if params == nil { diff --git a/service/auditmanager/api_op_UpdateSettings.go b/service/auditmanager/api_op_UpdateSettings.go index 899bbbf6f71..f93a100a00a 100644 --- a/service/auditmanager/api_op_UpdateSettings.go +++ b/service/auditmanager/api_op_UpdateSettings.go @@ -44,10 +44,8 @@ type UpdateSettingsInput struct { // to enable or disable evidence finder. When you use this attribute to disable // evidence finder, Audit Manager deletes the event data store that’s used to query // your evidence data. As a result, you can’t re-enable evidence finder and use the - // feature again. Your only alternative is to deregister - // (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html) - // and then re-register - // (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html) + // feature again. Your only alternative is to deregister (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html) + // and then re-register (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html) // Audit Manager. EvidenceFinderEnabled *bool diff --git a/service/auditmanager/doc.go b/service/auditmanager/doc.go index 3fc1a1f115c..37d37ad9e70 100644 --- a/service/auditmanager/doc.go +++ b/service/auditmanager/doc.go @@ -15,24 +15,16 @@ // standard or regulation. You can also customize frameworks and controls to // support internal audits with specific requirements. Use the following links to // get started with the Audit Manager API: +// - Actions (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html) +// : An alphabetical list of all Audit Manager API operations. +// - Data types (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html) +// : An alphabetical list of all Audit Manager data types. +// - Common parameters (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html) +// : Parameters that all operations can use. +// - Common errors (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html) +// : Client and server errors that all operations can return. // -// * Actions -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html): -// An alphabetical list of all Audit Manager API operations. -// -// * Data types -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html): -// An alphabetical list of all Audit Manager data types. -// -// * Common parameters -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html): -// Parameters that all operations can use. -// -// * Common errors -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html): -// Client and server errors that all operations can return. -// -// If you're new to Audit -// Manager, we recommend that you review the Audit Manager User Guide -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html). +// If you're new to Audit Manager, we recommend that you review the Audit Manager +// User Guide (https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html) +// . package auditmanager diff --git a/service/auditmanager/types/enums.go b/service/auditmanager/types/enums.go index f523fcb6e5b..879cc4ef8b9 100644 --- a/service/auditmanager/types/enums.go +++ b/service/auditmanager/types/enums.go @@ -234,9 +234,10 @@ const ( EvidenceFinderBackfillStatusCompleted EvidenceFinderBackfillStatus = "COMPLETED" ) -// Values returns all known values for EvidenceFinderBackfillStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EvidenceFinderBackfillStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (EvidenceFinderBackfillStatus) Values() []EvidenceFinderBackfillStatus { return []EvidenceFinderBackfillStatus{ "NOT_STARTED", diff --git a/service/auditmanager/types/errors.go b/service/auditmanager/types/errors.go index 35c9bd10f37..73e1c5d86f8 100644 --- a/service/auditmanager/types/errors.go +++ b/service/auditmanager/types/errors.go @@ -91,11 +91,10 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You've reached your account quota for this resource type. To perform the -// requested action, delete some existing resources or request a quota increase -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) from the -// Service Quotas console. For a list of Audit Manager service quotas, see Quotas -// and restrictions for Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html). +// requested action, delete some existing resources or request a quota increase (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// from the Service Quotas console. For a list of Audit Manager service quotas, see +// Quotas and restrictions for Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html) +// . type ServiceQuotaExceededException struct { Message *string diff --git a/service/auditmanager/types/types.go b/service/auditmanager/types/types.go index 8ae110cd961..5fc00881857 100644 --- a/service/auditmanager/types/types.go +++ b/service/auditmanager/types/types.go @@ -123,8 +123,8 @@ type AssessmentEvidenceFolder struct { // The date when the first evidence was added to the evidence folder. Date *time.Time - // The total number of Amazon Web Services resources that were assessed to generate - // the evidence. + // The total number of Amazon Web Services resources that were assessed to + // generate the evidence. EvidenceAwsServiceSourceCount int32 // The number of evidence that falls under the compliance check category. This @@ -460,14 +460,8 @@ type AWSAccount struct { // An Amazon Web Service such as Amazon S3 or CloudTrail. For an example of how to // find an Amazon Web Service name and how to define it in your assessment scope, // see the following: -// -// * Finding an Amazon Web Service name to use in your -// assessment scope -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_2) -// -// * -// Defining an Amazon Web Service name in your assessment scope -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_3) +// - Finding an Amazon Web Service name to use in your assessment scope (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_2) +// - Defining an Amazon Web Service name in your assessment scope (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_3) type AWSService struct { // The name of the Amazon Web Service. @@ -508,8 +502,8 @@ type BatchDeleteDelegationByAssessmentError struct { noSmithyDocumentSerde } -// An error entity for the BatchImportEvidenceToAssessmentControl API. This is used -// to provide more meaningful errors than a simple string message. +// An error entity for the BatchImportEvidenceToAssessmentControl API. This is +// used to provide more meaningful errors than a simple string message. type BatchImportEvidenceToAssessmentControlError struct { // The error code that the BatchImportEvidenceToAssessmentControl API returned. @@ -599,8 +593,8 @@ type Control struct { noSmithyDocumentSerde } -// A comment that's posted by a user on a control. This includes the author's name, -// the comment text, and a timestamp. +// A comment that's posted by a user on a control. This includes the author's +// name, the comment text, and a timestamp. type ControlComment struct { // The name of the user who authored the comment. @@ -702,25 +696,14 @@ type ControlMappingSource struct { // The unique identifier for the source. SourceId *string - // The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, - // and Amazon Web Services API names. To learn more about the supported keywords - // that you can use when mapping a control data source, see the following pages in - // the Audit Manager User Guide: - // - // * Config rules supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) - // - // * - // Security Hub controls supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) - // - // * - // API calls supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) - // - // * - // CloudTrail event names supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) + // The keyword to search for in CloudTrail logs, Config rules, Security Hub + // checks, and Amazon Web Services API names. To learn more about the supported + // keywords that you can use when mapping a control data source, see the following + // pages in the Audit Manager User Guide: + // - Config rules supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) + // - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) + // - API calls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) + // - CloudTrail event names supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) SourceKeyword *SourceKeyword // The name of the source. @@ -809,7 +792,7 @@ type CreateAssessmentFrameworkControlSet struct { } // The control mapping fields that represent the source for evidence collection, -// along with related parameters and metadata. This doesn't contain mappingID. +// along with related parameters and metadata. This doesn't contain mappingID . type CreateControlMappingSource struct { // The description of the data source that determines where Audit Manager collects @@ -819,25 +802,14 @@ type CreateControlMappingSource struct { // The frequency of evidence collection for the control mapping source. SourceFrequency SourceFrequency - // The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, - // and Amazon Web Services API names. To learn more about the supported keywords - // that you can use when mapping a control data source, see the following pages in - // the Audit Manager User Guide: - // - // * Config rules supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) - // - // * - // Security Hub controls supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) - // - // * - // API calls supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) - // - // * - // CloudTrail event names supported by Audit Manager - // (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) + // The keyword to search for in CloudTrail logs, Config rules, Security Hub + // checks, and Amazon Web Services API names. To learn more about the supported + // keywords that you can use when mapping a control data source, see the following + // pages in the Audit Manager User Guide: + // - Config rules supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) + // - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) + // - API calls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) + // - CloudTrail event names supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) SourceKeyword *SourceKeyword // The name of the control mapping data source. @@ -869,9 +841,9 @@ type CreateDelegationRequest struct { // The Amazon Resource Name (ARN) of the IAM role. RoleArn *string - // The type of customer persona. In CreateAssessment, roleType can only be - // PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In - // BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. + // The type of customer persona. In CreateAssessment , roleType can only be + // PROCESS_OWNER . In UpdateSettings , roleType can only be PROCESS_OWNER . In + // BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER . RoleType RoleType noSmithyDocumentSerde @@ -907,9 +879,9 @@ type Delegation struct { // The Amazon Resource Name (ARN) of the IAM role. RoleArn *string - // The type of customer persona. In CreateAssessment, roleType can only be - // PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In - // BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. + // The type of customer persona. In CreateAssessment , roleType can only be + // PROCESS_OWNER . In UpdateSettings , roleType can only be PROCESS_OWNER . In + // BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER . RoleType RoleType // The status of the delegation. @@ -947,15 +919,12 @@ type DelegationMetadata struct { // The deregistration policy for the data that's stored in Audit Manager. You can // use this attribute to determine how your data is handled when you deregister -// Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html). -// By default, Audit Manager retains evidence data for two years from the time of +// Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html) +// . By default, Audit Manager retains evidence data for two years from the time of // its creation. Other Audit Manager resources (including assessments, custom // controls, and custom frameworks) remain in Audit Manager indefinitely, and are -// available if you re-register Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html) -// in the future. For more information about data retention, see Data Protection -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) +// available if you re-register Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html) +// in the future. For more information about data retention, see Data Protection (https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html) // in the Audit Manager User Guide. If you choose to delete all data, this action // permanently deletes all evidence data in your account within seven days. It also // deletes all of the Audit Manager resources that you created, including @@ -965,22 +934,20 @@ type DeregistrationPolicy struct { // Specifies which Audit Manager data will be deleted when you deregister Audit // Manager. - // - // * If you set the value to ALL, all of your data is deleted within - // seven days of deregistration. - // - // * If you set the value to DEFAULT, none of your - // data is deleted at the time of deregistration. However, keep in mind that the - // Audit Manager data retention policy still applies. As a result, any evidence - // data will be deleted two years after its creation date. Your other Audit Manager - // resources will continue to exist indefinitely. + // - If you set the value to ALL , all of your data is deleted within seven days + // of deregistration. + // - If you set the value to DEFAULT , none of your data is deleted at the time + // of deregistration. However, keep in mind that the Audit Manager data retention + // policy still applies. As a result, any evidence data will be deleted two years + // after its creation date. Your other Audit Manager resources will continue to + // exist indefinitely. DeleteResources DeleteResources noSmithyDocumentSerde } -// A record that contains the information needed to demonstrate compliance with the -// requirements specified by a control. Examples of evidence include change +// A record that contains the information needed to demonstrate compliance with +// the requirements specified by a control. Examples of evidence include change // activity invoked by a user, or a system configuration snapshot. type Evidence struct { @@ -988,8 +955,8 @@ type Evidence struct { AssessmentReportSelection *string // The names and values that are used by the evidence event. This includes an - // attribute name (such as allowUsersToChangePassword) and value (such as true or - // false). + // attribute name (such as allowUsersToChangePassword ) and value (such as true or + // false ). Attributes map[string]string // The identifier for the Amazon Web Services account. @@ -1001,20 +968,16 @@ type Evidence struct { // The evaluation status for automated evidence that falls under the compliance // check category. - // - // * Audit Manager classes evidence as non-compliant if Security - // Hub reports a Fail result, or if Config reports a Non-compliant result. - // - // * Audit - // Manager classes evidence as compliant if Security Hub reports a Pass result, or - // if Config reports a Compliant result. - // - // * If a compliance check isn't available - // or applicable, then no compliance evaluation can be made for that evidence. This - // is the case if the evidence uses Config or Security Hub as the underlying data - // source type, but those services aren't enabled. This is also the case if the - // evidence uses an underlying data source type that doesn't support compliance - // checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). + // - Audit Manager classes evidence as non-compliant if Security Hub reports a + // Fail result, or if Config reports a Non-compliant result. + // - Audit Manager classes evidence as compliant if Security Hub reports a Pass + // result, or if Config reports a Compliant result. + // - If a compliance check isn't available or applicable, then no compliance + // evaluation can be made for that evidence. This is the case if the evidence uses + // Config or Security Hub as the underlying data source type, but those services + // aren't enabled. This is also the case if the evidence uses an underlying data + // source type that doesn't support compliance checks (such as manual evidence, + // Amazon Web Services API calls, or CloudTrail). ComplianceCheck *string // The data source where the evidence was collected from. @@ -1059,37 +1022,27 @@ type EvidenceFinderEnablement struct { // after you enable evidence finder. During this task, Audit Manager populates an // event data store with your past two years’ worth of evidence data so that your // evidence can be queried. - // - // * NOT_STARTED means that the backfill hasn’t started - // yet. - // - // * IN_PROGRESS means that the backfill is in progress. This can take up to - // 7 days to complete, depending on the amount of evidence data. - // - // * COMPLETED means - // that the backfill is complete. All of your past evidence is now queryable. + // - NOT_STARTED means that the backfill hasn’t started yet. + // - IN_PROGRESS means that the backfill is in progress. This can take up to 7 + // days to complete, depending on the amount of evidence data. + // - COMPLETED means that the backfill is complete. All of your past evidence is + // now queryable. BackfillStatus EvidenceFinderBackfillStatus // The current status of the evidence finder feature and the related event data // store. - // - // * ENABLE_IN_PROGRESS means that you requested to enable evidence finder. - // An event data store is currently being created to support evidence finder - // queries. - // - // * ENABLED means that an event data store was successfully created and - // evidence finder is enabled. We recommend that you wait 7 days until the event - // data store is backfilled with your past two years’ worth of evidence data. You - // can use evidence finder in the meantime, but not all data might be available - // until the backfill is complete. - // - // * DISABLE_IN_PROGRESS means that you requested - // to disable evidence finder, and your request is pending the deletion of the - // event data store. - // - // * DISABLED means that you have permanently disabled evidence - // finder and the event data store has been deleted. You can't re-enable evidence - // finder after this point. + // - ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An + // event data store is currently being created to support evidence finder queries. + // - ENABLED means that an event data store was successfully created and evidence + // finder is enabled. We recommend that you wait 7 days until the event data store + // is backfilled with your past two years’ worth of evidence data. You can use + // evidence finder in the meantime, but not all data might be available until the + // backfill is complete. + // - DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and + // your request is pending the deletion of the event data store. + // - DISABLED means that you have permanently disabled evidence finder and the + // event data store has been deleted. You can't re-enable evidence finder after + // this point. EnablementStatus EvidenceFinderEnablementStatus // Represents any errors that occurred when enabling or disabling evidence finder. @@ -1103,8 +1056,8 @@ type EvidenceFinderEnablement struct { noSmithyDocumentSerde } -// A breakdown of the latest compliance check status for the evidence in your Audit -// Manager assessments. +// A breakdown of the latest compliance check status for the evidence in your +// Audit Manager assessments. type EvidenceInsights struct { // The number of compliance check evidence that Audit Manager classified as @@ -1202,20 +1155,18 @@ type FrameworkMetadata struct { // summary is a snapshot of the data that your active assessments collected on the // lastUpdated date. It’s important to understand that the following totals are // daily counts based on this date — they aren’t a total sum to date. The Insights -// data is eventually consistent. This means that, when you read data from -// Insights, the response might not instantly reflect the results of a recently -// completed write or update operation. If you repeat your read request after a few -// hours, the response should return the latest data. If you delete an assessment -// or change its status to inactive, InsightsByAssessment includes data for that +// data is eventually consistent. This means that, when you read data from Insights +// , the response might not instantly reflect the results of a recently completed +// write or update operation. If you repeat your read request after a few hours, +// the response should return the latest data. If you delete an assessment or +// change its status to inactive, InsightsByAssessment includes data for that // assessment as follows. -// -// * Inactive assessments - If Audit Manager collected -// evidence for your assessment before you changed it inactive, that evidence is -// included in the InsightsByAssessment counts for that day. -// -// * Deleted assessments -// - If Audit Manager collected evidence for your assessment before you deleted it, -// that evidence isn't included in the InsightsByAssessment counts for that day. +// - Inactive assessments - If Audit Manager collected evidence for your +// assessment before you changed it inactive, that evidence is included in the +// InsightsByAssessment counts for that day. +// - Deleted assessments - If Audit Manager collected evidence for your +// assessment before you deleted it, that evidence isn't included in the +// InsightsByAssessment counts for that day. type Insights struct { // The number of active assessments in Audit Manager. @@ -1243,8 +1194,8 @@ type Insights struct { LastUpdated *time.Time // The number of compliance check evidence that Audit Manager classified as - // non-compliant on the lastUpdated date. This includes evidence that was collected - // from Security Hub with a Fail ruling, or collected from Config with a + // non-compliant on the lastUpdated date. This includes evidence that was + // collected from Security Hub with a Fail ruling, or collected from Config with a // Non-compliant ruling. NoncompliantEvidenceCount *int32 @@ -1259,20 +1210,17 @@ type Insights struct { // It’s important to understand that the totals in InsightsByAssessment are daily // counts based on this date — they aren’t a total sum to date. The // InsightsByAssessment data is eventually consistent. This means that when you -// read data from InsightsByAssessment, the response might not instantly reflect +// read data from InsightsByAssessment , the response might not instantly reflect // the results of a recently completed write or update operation. If you repeat // your read request after a few hours, the response returns the latest data. If // you delete an assessment or change its status to inactive, InsightsByAssessment // includes data for that assessment as follows. -// -// * Inactive assessments - If Audit -// Manager collected evidence for your assessment before you changed it inactive, -// that evidence is included in the InsightsByAssessment counts for that day. -// -// * -// Deleted assessments - If Audit Manager collected evidence for your assessment -// before you deleted it, that evidence isn't included in the InsightsByAssessment -// counts for that day. +// - Inactive assessments - If Audit Manager collected evidence for your +// assessment before you changed it inactive, that evidence is included in the +// InsightsByAssessment counts for that day. +// - Deleted assessments - If Audit Manager collected evidence for your +// assessment before you deleted it, that evidence isn't included in the +// InsightsByAssessment counts for that day. type InsightsByAssessment struct { // The number of assessment controls that collected non-compliant evidence on the @@ -1315,9 +1263,9 @@ type ManualEvidence struct { noSmithyDocumentSerde } -// The notification that informs a user of an update in Audit Manager. For example, -// this includes the notification that's sent when a control set is delegated for -// review. +// The notification that informs a user of an update in Audit Manager. For +// example, this includes the notification that's sent when a control set is +// delegated for review. type Notification struct { // The identifier for the assessment. @@ -1355,21 +1303,16 @@ type Resource struct { // The evaluation status for a resource that was assessed when collecting // compliance check evidence. - // - // * Audit Manager classes the resource as - // non-compliant if Security Hub reports a Fail result, or if Config reports a - // Non-compliant result. - // - // * Audit Manager classes the resource as compliant if - // Security Hub reports a Pass result, or if Config reports a Compliant result. - // - // * - // If a compliance check isn't available or applicable, then no compliance - // evaluation can be made for that resource. This is the case if a resource - // assessment uses Config or Security Hub as the underlying data source type, but - // those services aren't enabled. This is also the case if the resource assessment - // uses an underlying data source type that doesn't support compliance checks (such - // as manual evidence, Amazon Web Services API calls, or CloudTrail). + // - Audit Manager classes the resource as non-compliant if Security Hub reports + // a Fail result, or if Config reports a Non-compliant result. + // - Audit Manager classes the resource as compliant if Security Hub reports a + // Pass result, or if Config reports a Compliant result. + // - If a compliance check isn't available or applicable, then no compliance + // evaluation can be made for that resource. This is the case if a resource + // assessment uses Config or Security Hub as the underlying data source type, but + // those services aren't enabled. This is also the case if the resource assessment + // uses an underlying data source type that doesn't support compliance checks (such + // as manual evidence, Amazon Web Services API calls, or CloudTrail). ComplianceCheck *string // The value of the resource. @@ -1387,9 +1330,9 @@ type Role struct { // This member is required. RoleArn *string - // The type of customer persona. In CreateAssessment, roleType can only be - // PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In - // BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. + // The type of customer persona. In CreateAssessment , roleType can only be + // PROCESS_OWNER . In UpdateSettings , roleType can only be PROCESS_OWNER . In + // BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER . // // This member is required. RoleType RoleType @@ -1397,8 +1340,8 @@ type Role struct { noSmithyDocumentSerde } -// The wrapper that contains the Amazon Web Services accounts and services that are -// in scope for the assessment. +// The wrapper that contains the Amazon Web Services accounts and services that +// are in scope for the assessment. type Scope struct { // The Amazon Web Services accounts that are included in the scope of the @@ -1460,25 +1403,14 @@ type Settings struct { noSmithyDocumentSerde } -// The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, -// and Amazon Web Services API names. To learn more about the supported keywords -// that you can use when mapping a control data source, see the following pages in -// the Audit Manager User Guide: -// -// * Config rules supported by Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) -// -// * -// Security Hub controls supported by Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) -// -// * -// API calls supported by Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) -// -// * -// CloudTrail event names supported by Audit Manager -// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) +// The keyword to search for in CloudTrail logs, Config rules, Security Hub +// checks, and Amazon Web Services API names. To learn more about the supported +// keywords that you can use when mapping a control data source, see the following +// pages in the Audit Manager User Guide: +// - Config rules supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) +// - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) +// - API calls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) +// - CloudTrail event names supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html) type SourceKeyword struct { // The input method for the keyword. @@ -1489,39 +1421,25 @@ type SourceKeyword struct { // Hub control, or the name of an Amazon Web Services API call. If you’re mapping a // data source to a rule in Config, the keywordValue that you specify depends on // the type of rule: - // - // * For managed rules - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html), - // you can use the rule identifier as the keywordValue. You can find the rule - // identifier from the list of Config managed rules - // (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). - // - // * - // Managed rule name: s3-bucket-acl-prohibited - // (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html)keywordValue: - // S3_BUCKET_ACL_PROHIBITED - // - // * For custom rules - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html), - // you form the keywordValue by adding the Custom_ prefix to the rule name. This - // prefix distinguishes the rule from a managed rule. - // - // * Custom rule name: - // my-custom-config-rule keywordValue: Custom_my-custom-config-rule - // - // * For - // service-linked rules - // (https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html), - // you form the keywordValue by adding the Custom_ prefix to the rule name. In - // addition, you remove the suffix ID that appears at the end of the rule name. - // - // * - // Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w - // keywordValue: Custom_CustomRuleForAccount-conformance-pack - // - // * Service-linked - // rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue: - // Custom_OrgConfigRule-s3-bucket-versioning-enabled + // - For managed rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) + // , you can use the rule identifier as the keywordValue . You can find the rule + // identifier from the list of Config managed rules (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) + // . + // - Managed rule name: s3-bucket-acl-prohibited (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html) + // keywordValue : S3_BUCKET_ACL_PROHIBITED + // - For custom rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) + // , you form the keywordValue by adding the Custom_ prefix to the rule name. + // This prefix distinguishes the rule from a managed rule. + // - Custom rule name: my-custom-config-rule keywordValue : + // Custom_my-custom-config-rule + // - For service-linked rules (https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html) + // , you form the keywordValue by adding the Custom_ prefix to the rule name. In + // addition, you remove the suffix ID that appears at the end of the rule name. + // - Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w + // keywordValue : Custom_CustomRuleForAccount-conformance-pack + // - Service-linked rule name: + // OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : + // Custom_OrgConfigRule-s3-bucket-versioning-enabled KeywordValue *string noSmithyDocumentSerde diff --git a/service/autoscaling/api_client.go b/service/autoscaling/api_client.go index cd7db1d2232..be2b6c4fa38 100644 --- a/service/autoscaling/api_client.go +++ b/service/autoscaling/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/autoscaling/api_op_AttachInstances.go b/service/autoscaling/api_op_AttachInstances.go index 779b6d3406a..14b18f545b0 100644 --- a/service/autoscaling/api_op_AttachInstances.go +++ b/service/autoscaling/api_op_AttachInstances.go @@ -10,16 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches one or more EC2 instances to the specified Auto Scaling group. When you -// attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the -// group by the number of instances being attached. If the number of instances +// Attaches one or more EC2 instances to the specified Auto Scaling group. When +// you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of +// the group by the number of instances being attached. If the number of instances // being attached plus the desired capacity of the group exceeds the maximum size // of the group, the operation fails. If there is a Classic Load Balancer attached // to your Auto Scaling group, the instances are also registered with the load // balancer. If there are target groups attached to your Auto Scaling group, the // instances are also registered with the target groups. For more information, see -// Attach EC2 instances to your Auto Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html) +// Attach EC2 instances to your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) AttachInstances(ctx context.Context, params *AttachInstancesInput, optFns ...func(*Options)) (*AttachInstancesOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go b/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go index 65d0b7837a2..5d4c289f12a 100644 --- a/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go @@ -10,32 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by AttachTrafficSources, which can attach +// This API operation is superseded by AttachTrafficSources , which can attach // multiple traffic sources types. We recommend using AttachTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// AttachLoadBalancerTargetGroups. You can use both the original +// AttachLoadBalancerTargetGroups . You can use both the original // AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the // same Auto Scaling group. Attaches one or more target groups to the specified // Auto Scaling group. This operation is used with the following load balancer // types: +// - Application Load Balancer - Operates at the application layer (layer 7) and +// supports HTTP and HTTPS. +// - Network Load Balancer - Operates at the transport layer (layer 4) and +// supports TCP, TLS, and UDP. +// - Gateway Load Balancer - Operates at the network layer (layer 3). // -// * Application Load Balancer - Operates at the application layer (layer -// 7) and supports HTTP and HTTPS. -// -// * Network Load Balancer - Operates at the -// transport layer (layer 4) and supports TCP, TLS, and UDP. -// -// * Gateway Load -// Balancer - Operates at the network layer (layer 3). -// -// To describe the target -// groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. -// To detach the target group from the Auto Scaling group, call the -// DetachLoadBalancerTargetGroups API. This operation is additive and does not -// detach existing target groups or Classic Load Balancers from the Auto Scaling -// group. For more information, see Use Elastic Load Balancing to distribute -// traffic across the instances in your Auto Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) +// To describe the target groups for an Auto Scaling group, call the +// DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto +// Scaling group, call the DetachLoadBalancerTargetGroups API. This operation is +// additive and does not detach existing target groups or Classic Load Balancers +// from the Auto Scaling group. For more information, see Use Elastic Load +// Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) AttachLoadBalancerTargetGroups(ctx context.Context, params *AttachLoadBalancerTargetGroupsInput, optFns ...func(*Options)) (*AttachLoadBalancerTargetGroupsOutput, error) { if params == nil { @@ -61,8 +55,7 @@ type AttachLoadBalancerTargetGroupsInput struct { // The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 // target groups. To get the ARN of a target group, use the Elastic Load Balancing - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. // // This member is required. diff --git a/service/autoscaling/api_op_AttachLoadBalancers.go b/service/autoscaling/api_op_AttachLoadBalancers.go index b72d4b0ce5e..6826b348e0e 100644 --- a/service/autoscaling/api_op_AttachLoadBalancers.go +++ b/service/autoscaling/api_op_AttachLoadBalancers.go @@ -10,20 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by AttachTrafficSources, which can attach +// This API operation is superseded by AttachTrafficSources , which can attach // multiple traffic sources types. We recommend using AttachTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// AttachLoadBalancers. You can use both the original AttachLoadBalancers API +// AttachLoadBalancers . You can use both the original AttachLoadBalancers API // operation and AttachTrafficSources on the same Auto Scaling group. Attaches one // or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 // Auto Scaling registers the running instances with these Classic Load Balancers. // To describe the load balancers for an Auto Scaling group, call the // DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling -// group, call the DetachLoadBalancers API. This operation is additive and does not -// detach existing Classic Load Balancers or target groups from the Auto Scaling -// group. For more information, see Use Elastic Load Balancing to distribute -// traffic across the instances in your Auto Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) +// group, call the DetachLoadBalancers API. This operation is additive and does +// not detach existing Classic Load Balancers or target groups from the Auto +// Scaling group. For more information, see Use Elastic Load Balancing to +// distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) AttachLoadBalancers(ctx context.Context, params *AttachLoadBalancersInput, optFns ...func(*Options)) (*AttachLoadBalancersOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_AttachTrafficSources.go b/service/autoscaling/api_op_AttachTrafficSources.go index ac74a58b85b..d241b1dff3f 100644 --- a/service/autoscaling/api_op_AttachTrafficSources.go +++ b/service/autoscaling/api_op_AttachTrafficSources.go @@ -13,25 +13,17 @@ import ( // Attaches one or more traffic sources to the specified Auto Scaling group. You // can use any of the following as traffic sources for an Auto Scaling group: +// - Application Load Balancer +// - Classic Load Balancer +// - Gateway Load Balancer +// - Network Load Balancer +// - VPC Lattice // -// * -// Application Load Balancer -// -// * Classic Load Balancer -// -// * Gateway Load Balancer -// -// * -// Network Load Balancer -// -// * VPC Lattice -// -// This operation is additive and does not -// detach existing traffic sources from the Auto Scaling group. After the operation -// completes, use the DescribeTrafficSources API to return details about the state -// of the attachments between traffic sources and your Auto Scaling group. To -// detach a traffic source from the Auto Scaling group, call the -// DetachTrafficSources API. +// This operation is additive and does not detach existing traffic sources from +// the Auto Scaling group. After the operation completes, use the +// DescribeTrafficSources API to return details about the state of the attachments +// between traffic sources and your Auto Scaling group. To detach a traffic source +// from the Auto Scaling group, call the DetachTrafficSources API. func (c *Client) AttachTrafficSources(ctx context.Context, params *AttachTrafficSourcesInput, optFns ...func(*Options)) (*AttachTrafficSourcesOutput, error) { if params == nil { params = &AttachTrafficSourcesInput{} diff --git a/service/autoscaling/api_op_BatchDeleteScheduledAction.go b/service/autoscaling/api_op_BatchDeleteScheduledAction.go index 30c06c9a3ec..d0cef51081d 100644 --- a/service/autoscaling/api_op_BatchDeleteScheduledAction.go +++ b/service/autoscaling/api_op_BatchDeleteScheduledAction.go @@ -44,8 +44,8 @@ type BatchDeleteScheduledActionInput struct { type BatchDeleteScheduledActionOutput struct { - // The names of the scheduled actions that could not be deleted, including an error - // message. + // The names of the scheduled actions that could not be deleted, including an + // error message. FailedScheduledActions []types.FailedScheduledUpdateGroupActionRequest // Metadata pertaining to the operation's result. diff --git a/service/autoscaling/api_op_CancelInstanceRefresh.go b/service/autoscaling/api_op_CancelInstanceRefresh.go index 5dcc340eab4..f50eafbb79b 100644 --- a/service/autoscaling/api_op_CancelInstanceRefresh.go +++ b/service/autoscaling/api_op_CancelInstanceRefresh.go @@ -12,8 +12,7 @@ import ( // Cancels an instance refresh or rollback that is in progress. If an instance // refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error -// occurs. This operation is part of the instance refresh feature -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) +// occurs. This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) // in Amazon EC2 Auto Scaling, which helps you update instances in your Auto // Scaling group after you make configuration changes. When you cancel an instance // refresh, this does not roll back any changes that it made. Use the diff --git a/service/autoscaling/api_op_CompleteLifecycleAction.go b/service/autoscaling/api_op_CompleteLifecycleAction.go index 1c93f2e8ba7..34a8f8d7060 100644 --- a/service/autoscaling/api_op_CompleteLifecycleAction.go +++ b/service/autoscaling/api_op_CompleteLifecycleAction.go @@ -13,34 +13,24 @@ import ( // Completes the lifecycle action for the specified token or instance with the // specified result. This step is a part of the procedure for adding a lifecycle // hook to an Auto Scaling group: +// - (Optional) Create a launch template or launch configuration with a user +// data script that runs while an instance is in a wait state due to a lifecycle +// hook. +// - (Optional) Create a Lambda function and a rule that allows Amazon +// EventBridge to invoke your Lambda function when an instance is put into a wait +// state due to a lifecycle hook. +// - (Optional) Create a notification target and an IAM role. The target can be +// either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 +// Auto Scaling to publish lifecycle notifications to the target. +// - Create the lifecycle hook. Specify whether the hook is used when the +// instances launch or terminate. +// - If you need more time, record the lifecycle action heartbeat to keep the +// instance in a wait state. +// - If you finish before the timeout period ends, send a callback by using the +// CompleteLifecycleAction API call. // -// * (Optional) Create a launch template or launch -// configuration with a user data script that runs while an instance is in a wait -// state due to a lifecycle hook. -// -// * (Optional) Create a Lambda function and a rule -// that allows Amazon EventBridge to invoke your Lambda function when an instance -// is put into a wait state due to a lifecycle hook. -// -// * (Optional) Create a -// notification target and an IAM role. The target can be either an Amazon SQS -// queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish -// lifecycle notifications to the target. -// -// * Create the lifecycle hook. Specify -// whether the hook is used when the instances launch or terminate. -// -// * If you need -// more time, record the lifecycle action heartbeat to keep the instance in a wait -// state. -// -// * If you finish before the timeout period ends, send a callback by using -// the CompleteLifecycleAction API call. -// -// For more information, see Amazon EC2 Auto -// Scaling lifecycle hooks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in -// the Amazon EC2 Auto Scaling User Guide. +// For more information, see Amazon EC2 Auto Scaling lifecycle hooks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) +// in the Amazon EC2 Auto Scaling User Guide. func (c *Client) CompleteLifecycleAction(ctx context.Context, params *CompleteLifecycleActionInput, optFns ...func(*Options)) (*CompleteLifecycleActionOutput, error) { if params == nil { params = &CompleteLifecycleActionInput{} @@ -63,7 +53,7 @@ type CompleteLifecycleActionInput struct { // This member is required. AutoScalingGroupName *string - // The action for the group to take. You can specify either CONTINUE or ABANDON. + // The action for the group to take. You can specify either CONTINUE or ABANDON . // // This member is required. LifecycleActionResult *string diff --git a/service/autoscaling/api_op_CreateAutoScalingGroup.go b/service/autoscaling/api_op_CreateAutoScalingGroup.go index be026440cea..0fb8943bc66 100644 --- a/service/autoscaling/api_op_CreateAutoScalingGroup.go +++ b/service/autoscaling/api_op_CreateAutoScalingGroup.go @@ -16,21 +16,17 @@ import ( // Auto Scaling group with the specified name and attributes. If you exceed your // maximum limit of Auto Scaling groups, the call fails. To query this limit, call // the DescribeAccountLimits API. For information about updating this limit, see -// Quotas for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) +// Quotas for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) // in the Amazon EC2 Auto Scaling User Guide. For introductory exercises for -// creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html) -// and Tutorial: Set up a scaled and load-balanced application -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html) +// creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html) +// and Tutorial: Set up a scaled and load-balanced application (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html) // in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto -// Scaling groups -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) in -// the Amazon EC2 Auto Scaling User Guide. Every Auto Scaling group has three size -// properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes -// based on a specific number of instances. However, if you configure a mixed -// instances policy that defines weights for the instance types, you must specify -// these sizes with the same units that you use for weighting instances. +// Scaling groups (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) +// in the Amazon EC2 Auto Scaling User Guide. Every Auto Scaling group has three +// size properties ( DesiredCapacity , MaxSize , and MinSize ). Usually, you set +// these sizes based on a specific number of instances. However, if you configure a +// mixed instances policy that defines weights for the instance types, you must +// specify these sizes with the same units that you use for weighting instances. func (c *Client) CreateAutoScalingGroup(ctx context.Context, params *CreateAutoScalingGroupInput, optFns ...func(*Options)) (*CreateAutoScalingGroupOutput, error) { if params == nil { params = &CreateAutoScalingGroupInput{} @@ -59,8 +55,8 @@ type CreateAutoScalingGroupInput struct { // The maximum size of the group. With a mixed instances policy that uses instance // weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your // capacity requirements. In this event, Amazon EC2 Auto Scaling will never go - // above MaxSize by more than your largest instance weight (weights that define how - // many units each instance contributes to the desired capacity of the group). + // above MaxSize by more than your largest instance weight (weights that define + // how many units each instance contributes to the desired capacity of the group). // // This member is required. MaxSize *int32 @@ -82,8 +78,7 @@ type CreateAutoScalingGroupInput struct { // Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a // Spot Instance is at an elevated risk of interruption. After launching a new // instance, it then terminates an old instance. For more information, see Use - // Capacity Rebalancing to handle Amazon EC2 Spot Interruptions - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) + // Capacity Rebalancing to handle Amazon EC2 Spot Interruptions (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) // in the in the Amazon EC2 Auto Scaling User Guide. CapacityRebalance *bool @@ -93,9 +88,8 @@ type CreateAutoScalingGroupInput struct { // Only needed if you use simple scaling policies. The amount of time, in seconds, // between one scaling activity ending and another one starting due to simple // scaling policies. For more information, see Scaling cooldowns for Amazon EC2 - // Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the - // Amazon EC2 Auto Scaling User Guide. Default: 300 seconds + // Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) + // in the Amazon EC2 Auto Scaling User Guide. Default: 300 seconds DefaultCooldown *int32 // The amount of time, in seconds, until a new instance is considered to have @@ -106,8 +100,7 @@ type CreateAutoScalingGroupInput struct { // period before aggregating the metrics for new instances with existing instances // in the Amazon CloudWatch metrics that are used for scaling, resulting in more // reliable usage data. For more information, see Set the default instance warmup - // for an Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) + // for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) // in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at // the group level, we recommend that you set the default instance warmup, even if // it is set to 0 seconds. To remove a value that you previously set, include the @@ -124,13 +117,12 @@ type CreateAutoScalingGroupInput struct { // is the minimum size of the group. DesiredCapacity *int32 - // The unit of measurement for the value specified for desired capacity. Amazon EC2 - // Auto Scaling supports DesiredCapacityType for attribute-based instance type + // The unit of measurement for the value specified for desired capacity. Amazon + // EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type // selection only. For more information, see Creating an Auto Scaling group using - // attribute-based instance type selection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) + // attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) // in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling - // specifies units, which translates into number of instances. Valid values: units + // specifies units , which translates into number of instances. Valid values: units // | vcpu | memory-mib DesiredCapacityType *string @@ -138,44 +130,40 @@ type CreateAutoScalingGroupInput struct { // checking the health status of an EC2 instance that has come into service and // marking it unhealthy due to a failed health check. This is useful if your // instances do not immediately pass their health checks after they enter the - // InService state. For more information, see Set the health check grace period for - // an Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) + // InService state. For more information, see Set the health check grace period + // for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) // in the Amazon EC2 Auto Scaling User Guide. Default: 0 seconds HealthCheckGracePeriod *int32 // A comma-separated value string of one or more health check types. The valid - // values are EC2, ELB, and VPC_LATTICE. EC2 is the default health check and cannot - // be disabled. For more information, see Health checks for Auto Scaling instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the - // Amazon EC2 Auto Scaling User Guide. Only specify EC2 if you must clear a value - // that was previously set. + // values are EC2 , ELB , and VPC_LATTICE . EC2 is the default health check and + // cannot be disabled. For more information, see Health checks for Auto Scaling + // instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) + // in the Amazon EC2 Auto Scaling User Guide. Only specify EC2 if you must clear a + // value that was previously set. HealthCheckType *string // The ID of the instance used to base the launch configuration on. If specified, // Amazon EC2 Auto Scaling uses the configuration values from the specified // instance to create a new launch configuration. To get the instance ID, use the - // Amazon EC2 DescribeInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) - // API operation. For more information, see Creating an Auto Scaling group using an - // EC2 instance - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) + // Amazon EC2 DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) + // API operation. For more information, see Creating an Auto Scaling group using + // an EC2 instance (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) // in the Amazon EC2 Auto Scaling User Guide. InstanceId *string // The name of the launch configuration to use to launch instances. Conditional: - // You must specify either a launch template (LaunchTemplate or - // MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or - // InstanceId). + // You must specify either a launch template ( LaunchTemplate or + // MixedInstancesPolicy ) or a launch configuration ( LaunchConfigurationName or + // InstanceId ). LaunchConfigurationName *string // Information used to specify the launch template and version to use to launch - // instances. Conditional: You must specify either a launch template - // (LaunchTemplate or MixedInstancesPolicy) or a launch configuration - // (LaunchConfigurationName or InstanceId). The launch template that is specified + // instances. Conditional: You must specify either a launch template ( + // LaunchTemplate or MixedInstancesPolicy ) or a launch configuration ( + // LaunchConfigurationName or InstanceId ). The launch template that is specified // must be configured for use with an Auto Scaling group. For more information, see - // Creating a launch template for an Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) + // Creating a launch template for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) // in the Amazon EC2 Auto Scaling User Guide. LaunchTemplate *types.LaunchTemplateSpecification @@ -190,29 +178,25 @@ type CreateAutoScalingGroupInput struct { // The maximum amount of time, in seconds, that an instance can be in service. The // default is null. If specified, the value must be either 0 or a number equal to - // or greater than 86,400 seconds (1 day). For more information, see Replacing Auto - // Scaling instances based on maximum instance lifetime - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) + // or greater than 86,400 seconds (1 day). For more information, see Replacing + // Auto Scaling instances based on maximum instance lifetime (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) // in the Amazon EC2 Auto Scaling User Guide. MaxInstanceLifetime *int32 // The mixed instances policy. For more information, see Auto Scaling groups with - // multiple instance types and purchase options - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) + // multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) // in the Amazon EC2 Auto Scaling User Guide. MixedInstancesPolicy *types.MixedInstancesPolicy // Indicates whether newly launched instances are protected from termination by // Amazon EC2 Auto Scaling when scaling in. For more information about preventing - // instances from terminating on scale in, see Using instance scale-in protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) + // instances from terminating on scale in, see Using instance scale-in protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) // in the Amazon EC2 Auto Scaling User Guide. NewInstancesProtectedFromScaleIn *bool // The name of the placement group into which to launch your instances. For more - // information, see Placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. A cluster placement group is a + // information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) + // in the Amazon EC2 User Guide for Linux Instances. A cluster placement group is a // logical grouping of instances within a single Availability Zone. You cannot // specify multiple Availability Zones and a cluster placement group. PlacementGroup *string @@ -220,9 +204,8 @@ type CreateAutoScalingGroupInput struct { // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling // group uses to call other Amazon Web Services service on your behalf. By default, // Amazon EC2 Auto Scaling uses a service-linked role named - // AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more - // information, see Service-linked roles - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) + // AWSServiceRoleForAutoScaling , which it creates if it does not exist. For more + // information, see Service-linked roles (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) // in the Amazon EC2 Auto Scaling User Guide. ServiceLinkedRoleARN *string @@ -232,8 +215,7 @@ type CreateAutoScalingGroupInput struct { // template but use caution. If the launch template specifies an instance tag with // a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling // overrides the value of that instance tag with the value specified by the Auto - // Scaling group. For more information, see Tag Auto Scaling groups and instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) + // Scaling group. For more information, see Tag Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) // in the Amazon EC2 Auto Scaling User Guide. Tags []types.Tag @@ -241,15 +223,13 @@ type CreateAutoScalingGroupInput struct { // associate with the Auto Scaling group. Instances are registered as targets with // the target groups. The target groups receive incoming traffic and route requests // to one or more registered targets. For more information, see Use Elastic Load - // Balancing to distribute traffic across the instances in your Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) + // Balancing to distribute traffic across the instances in your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. TargetGroupARNs []string // A policy or a list of policies that are used to select the instance to // terminate. These policies are executed in the order that you list them. For more - // information, see Work with Amazon EC2 Auto Scaling termination policies - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) + // information, see Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) // in the Amazon EC2 Auto Scaling User Guide. Valid values: Default | // AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance // | OldestLaunchConfiguration | OldestLaunchTemplate | @@ -264,7 +244,7 @@ type CreateAutoScalingGroupInput struct { // A comma-separated list of subnet IDs for a virtual private cloud (VPC) where // instances in the Auto Scaling group can be created. If you specify - // VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must + // VPCZoneIdentifier with AvailabilityZones , the subnets that you specify must // reside in those Availability Zones. VPCZoneIdentifier *string diff --git a/service/autoscaling/api_op_CreateLaunchConfiguration.go b/service/autoscaling/api_op_CreateLaunchConfiguration.go index 638d71c75cc..42c18a23a6b 100644 --- a/service/autoscaling/api_op_CreateLaunchConfiguration.go +++ b/service/autoscaling/api_op_CreateLaunchConfiguration.go @@ -13,20 +13,17 @@ import ( // Creates a launch configuration. If you exceed your maximum limit of launch // configurations, the call fails. To query this limit, call the -// DescribeAccountLimits API. For information about updating this limit, see Quotas -// for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) +// DescribeAccountLimits API. For information about updating this limit, see +// Quotas for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) // in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch -// configurations -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html) +// configurations (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html) // in the Amazon EC2 Auto Scaling User Guide. Amazon EC2 Auto Scaling configures // instances launched as part of an Auto Scaling group using either a launch // template or a launch configuration. We strongly recommend that you do not use // launch configurations. They do not provide full functionality for Amazon EC2 // Auto Scaling or Amazon EC2. For information about using launch templates, see -// Launch templates -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html) in -// the Amazon EC2 Auto Scaling User Guide. +// Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html) +// in the Amazon EC2 Auto Scaling User Guide. func (c *Client) CreateLaunchConfiguration(ctx context.Context, params *CreateLaunchConfigurationInput, optFns ...func(*Options)) (*CreateLaunchConfigurationOutput, error) { if params == nil { params = &CreateLaunchConfigurationInput{} @@ -55,18 +52,17 @@ type CreateLaunchConfigurationInput struct { // public IPv4 address, unless you disabled the option to assign a public IPv4 // address on the subnet. If the instance is launched into a nondefault subnet, the // default is not to assign a public IPv4 address, unless you enabled the option to - // assign a public IPv4 address on the subnet. If you specify true, each instance + // assign a public IPv4 address on the subnet. If you specify true , each instance // in the Auto Scaling group receives a unique public IPv4 address. For more - // information, see Launching Auto Scaling instances in a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the - // Amazon EC2 Auto Scaling User Guide. If you specify this property, you must - // specify at least one subnet for VPCZoneIdentifier when you create your group. + // information, see Launching Auto Scaling instances in a VPC (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) + // in the Amazon EC2 Auto Scaling User Guide. If you specify this property, you + // must specify at least one subnet for VPCZoneIdentifier when you create your + // group. AssociatePublicIpAddress *bool // The block device mapping entries that define the block devices to attach to the // instances at launch. By default, the block devices specified in the block device - // mapping for the AMI are used. For more information, see Block device mappings - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) + // mapping for the AMI are used. For more information, see Block device mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) // in the Amazon EC2 User Guide for Linux Instances. BlockDeviceMappings []types.BlockDeviceMapping @@ -76,108 +72,95 @@ type CreateLaunchConfigurationInput struct { // Available for backward compatibility. ClassicLinkVPCSecurityGroups []string - // Specifies whether the launch configuration is optimized for EBS I/O (true) or - // not (false). The optimization provides dedicated throughput to Amazon EBS and an - // optimized configuration stack to provide optimal I/O performance. This + // Specifies whether the launch configuration is optimized for EBS I/O ( true ) or + // not ( false ). The optimization provides dedicated throughput to Amazon EBS and + // an optimized configuration stack to provide optimal I/O performance. This // optimization is not available with all instance types. Additional fees are // incurred when you enable EBS optimization for an instance type that is not // EBS-optimized by default. For more information, see Amazon EBS-optimized - // instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the - // Amazon EC2 User Guide for Linux Instances. The default value is false. + // instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) + // in the Amazon EC2 User Guide for Linux Instances. The default value is false . EbsOptimized *bool // The name or the Amazon Resource Name (ARN) of the instance profile associated // with the IAM role for the instance. The instance profile contains the IAM role. // For more information, see IAM role for applications that run on Amazon EC2 - // instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the - // Amazon EC2 Auto Scaling User Guide. + // instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) + // in the Amazon EC2 Auto Scaling User Guide. IamInstanceProfile *string // The ID of the Amazon Machine Image (AMI) that was assigned during registration. - // For more information, see Finding a Linux AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the - // Amazon EC2 User Guide for Linux Instances. If you specify InstanceId, an ImageId - // is not required. + // For more information, see Finding a Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) + // in the Amazon EC2 User Guide for Linux Instances. If you specify InstanceId , an + // ImageId is not required. ImageId *string - // The ID of the instance to use to create the launch configuration. The new launch - // configuration derives attributes from the instance, except for the block device - // mapping. To create a launch configuration with a block device mapping or + // The ID of the instance to use to create the launch configuration. The new + // launch configuration derives attributes from the instance, except for the block + // device mapping. To create a launch configuration with a block device mapping or // override any other instance attributes, specify them as part of the same // request. For more information, see Creating a launch configuration using an EC2 - // instance - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html) + // instance (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html) // in the Amazon EC2 Auto Scaling User Guide. InstanceId *string - // Controls whether instances in this group are launched with detailed (true) or - // basic (false) monitoring. The default value is true (enabled). When detailed + // Controls whether instances in this group are launched with detailed ( true ) or + // basic ( false ) monitoring. The default value is true (enabled). When detailed // monitoring is enabled, Amazon CloudWatch generates metrics every minute and your // account is charged a fee. When you disable detailed monitoring, CloudWatch // generates metrics every 5 minutes. For more information, see Configure - // Monitoring for Auto Scaling Instances - // (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) + // Monitoring for Auto Scaling Instances (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) // in the Amazon EC2 Auto Scaling User Guide. InstanceMonitoring *types.InstanceMonitoring - // Specifies the instance type of the EC2 instance. For information about available - // instance types, see Available instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) - // in the Amazon EC2 User Guide for Linux Instances. If you specify InstanceId, an + // Specifies the instance type of the EC2 instance. For information about + // available instance types, see Available instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) + // in the Amazon EC2 User Guide for Linux Instances. If you specify InstanceId , an // InstanceType is not required. InstanceType *string // The ID of the kernel associated with the AMI. We recommend that you use PV-GRUB // instead of kernels and RAM disks. For more information, see User provided - // kernels - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) + // kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) // in the Amazon EC2 User Guide for Linux Instances. KernelId *string // The name of the key pair. For more information, see Amazon EC2 key pairs and - // Linux instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the - // Amazon EC2 User Guide for Linux Instances. + // Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) + // in the Amazon EC2 User Guide for Linux Instances. KeyName *string // The metadata options for the instances. For more information, see Configuring - // the Instance Metadata Options - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) + // the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) // in the Amazon EC2 Auto Scaling User Guide. MetadataOptions *types.InstanceMetadataOptions - // The tenancy of the instance, either default or dedicated. An instance with + // The tenancy of the instance, either default or dedicated . An instance with // dedicated tenancy runs on isolated, single-tenant hardware and can only be // launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a - // VPC with the instance placement tenancy attribute set to default), you must set - // the value of this property to dedicated. For more information, see Configuring - // instance tenancy with Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) - // in the Amazon EC2 Auto Scaling User Guide. If you specify PlacementTenancy, you + // VPC with the instance placement tenancy attribute set to default ), you must set + // the value of this property to dedicated . For more information, see Configuring + // instance tenancy with Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) + // in the Amazon EC2 Auto Scaling User Guide. If you specify PlacementTenancy , you // must specify at least one subnet for VPCZoneIdentifier when you create your // group. Valid values: default | dedicated PlacementTenancy *string // The ID of the RAM disk to select. We recommend that you use PV-GRUB instead of - // kernels and RAM disks. For more information, see User provided kernels - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) + // kernels and RAM disks. For more information, see User provided kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) // in the Amazon EC2 User Guide for Linux Instances. RamdiskId *string // A list that contains the security group IDs to assign to the instances in the - // Auto Scaling group. For more information, see Control traffic to resources using - // security groups - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) + // Auto Scaling group. For more information, see Control traffic to resources + // using security groups (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) // in the Amazon Virtual Private Cloud User Guide. SecurityGroups []string // The maximum hourly price to be paid for any Spot Instance launched to fulfill // the request. Spot Instances are launched when the price you specify exceeds the // current Spot price. For more information, see Request Spot Instances for - // fault-tolerant and flexible applications - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html) + // fault-tolerant and flexible applications (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html) // in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 0.001 // When you change your maximum price by creating a new launch configuration, // running instances will continue to run as long as the maximum price for those @@ -185,10 +168,8 @@ type CreateLaunchConfigurationInput struct { SpotPrice *string // The user data to make available to the launched EC2 instances. For more - // information, see Instance metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // (Linux) and Instance metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) + // information, see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) // (Windows). If you are using a command line tool, base64-encoding is performed // for you, and you can load the text from a file. Otherwise, you must provide // base64-encoded text. User data is limited to 16 KB. diff --git a/service/autoscaling/api_op_CreateOrUpdateTags.go b/service/autoscaling/api_op_CreateOrUpdateTags.go index 7f3e1d7fd1b..9b1f366a178 100644 --- a/service/autoscaling/api_op_CreateOrUpdateTags.go +++ b/service/autoscaling/api_op_CreateOrUpdateTags.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates tags for the specified Auto Scaling group. When you specify a -// tag with a key that already exists, the operation overwrites the previous tag +// Creates or updates tags for the specified Auto Scaling group. When you specify +// a tag with a key that already exists, the operation overwrites the previous tag // definition, and you do not get an error message. For more information, see Tag -// Auto Scaling groups and instances -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) +// Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) CreateOrUpdateTags(ctx context.Context, params *CreateOrUpdateTagsInput, optFns ...func(*Options)) (*CreateOrUpdateTagsOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DeleteAutoScalingGroup.go b/service/autoscaling/api_op_DeleteAutoScalingGroup.go index c485e7acb01..36196ea74f6 100644 --- a/service/autoscaling/api_op_DeleteAutoScalingGroup.go +++ b/service/autoscaling/api_op_DeleteAutoScalingGroup.go @@ -18,12 +18,11 @@ import ( // it, call the DetachInstances API with the list of instances and the option to // decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does // not launch replacement instances. To terminate all instances before deleting the -// Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size -// and desired capacity of the Auto Scaling group to zero. If the group has scaling -// policies, deleting the group deletes the policies, the underlying alarm actions, -// and any alarm that no longer has an associated action. For more information, see -// Delete your Auto Scaling infrastructure -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) +// Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum +// size and desired capacity of the Auto Scaling group to zero. If the group has +// scaling policies, deleting the group deletes the policies, the underlying alarm +// actions, and any alarm that no longer has an associated action. For more +// information, see Delete your Auto Scaling infrastructure (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DeleteAutoScalingGroup(ctx context.Context, params *DeleteAutoScalingGroupInput, optFns ...func(*Options)) (*DeleteAutoScalingGroupOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DeleteLaunchConfiguration.go b/service/autoscaling/api_op_DeleteLaunchConfiguration.go index 9ef0b4f8059..b65d27f016d 100644 --- a/service/autoscaling/api_op_DeleteLaunchConfiguration.go +++ b/service/autoscaling/api_op_DeleteLaunchConfiguration.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified launch configuration. The launch configuration must not be -// attached to an Auto Scaling group. When this call completes, the launch +// Deletes the specified launch configuration. The launch configuration must not +// be attached to an Auto Scaling group. When this call completes, the launch // configuration is no longer available for use. func (c *Client) DeleteLaunchConfiguration(ctx context.Context, params *DeleteLaunchConfigurationInput, optFns ...func(*Options)) (*DeleteLaunchConfigurationOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DeleteLifecycleHook.go b/service/autoscaling/api_op_DeleteLifecycleHook.go index c04846835e9..0fc18521623 100644 --- a/service/autoscaling/api_op_DeleteLifecycleHook.go +++ b/service/autoscaling/api_op_DeleteLifecycleHook.go @@ -11,8 +11,8 @@ import ( ) // Deletes the specified lifecycle hook. If there are any outstanding lifecycle -// actions, they are completed first (ABANDON for launching instances, CONTINUE for -// terminating instances). +// actions, they are completed first ( ABANDON for launching instances, CONTINUE +// for terminating instances). func (c *Client) DeleteLifecycleHook(ctx context.Context, params *DeleteLifecycleHookInput, optFns ...func(*Options)) (*DeleteLifecycleHookOutput, error) { if params == nil { params = &DeleteLifecycleHookInput{} diff --git a/service/autoscaling/api_op_DeletePolicy.go b/service/autoscaling/api_op_DeletePolicy.go index f57f01469a7..7e8dff40c50 100644 --- a/service/autoscaling/api_op_DeletePolicy.go +++ b/service/autoscaling/api_op_DeletePolicy.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified scaling policy. Deleting either a step scaling policy or a -// simple scaling policy deletes the underlying alarm action, but does not delete +// Deletes the specified scaling policy. Deleting either a step scaling policy or +// a simple scaling policy deletes the underlying alarm action, but does not delete // the alarm, even if it no longer has an associated action. For more information, -// see Deleting a scaling policy -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html) +// see Deleting a scaling policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DeleteWarmPool.go b/service/autoscaling/api_op_DeleteWarmPool.go index b169624b74e..0ce4e62f47d 100644 --- a/service/autoscaling/api_op_DeleteWarmPool.go +++ b/service/autoscaling/api_op_DeleteWarmPool.go @@ -11,8 +11,7 @@ import ( ) // Deletes the warm pool for the specified Auto Scaling group. For more -// information, see Warm pools for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) +// information, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DeleteWarmPool(ctx context.Context, params *DeleteWarmPoolInput, optFns ...func(*Options)) (*DeleteWarmPoolOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DescribeAccountLimits.go b/service/autoscaling/api_op_DescribeAccountLimits.go index 14b2a30c774..9c31c5ea488 100644 --- a/service/autoscaling/api_op_DescribeAccountLimits.go +++ b/service/autoscaling/api_op_DescribeAccountLimits.go @@ -14,8 +14,7 @@ import ( // When you establish an Amazon Web Services account, the account has initial // quotas on the maximum number of Auto Scaling groups and launch configurations // that you can create in a given Region. For more information, see Quotas for -// Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) +// Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type DescribeAccountLimitsInput struct { type DescribeAccountLimitsOutput struct { - // The maximum number of groups allowed for your account. The default is 200 groups - // per Region. + // The maximum number of groups allowed for your account. The default is 200 + // groups per Region. MaxNumberOfAutoScalingGroups *int32 // The maximum number of launch configurations allowed for your account. The diff --git a/service/autoscaling/api_op_DescribeAdjustmentTypes.go b/service/autoscaling/api_op_DescribeAdjustmentTypes.go index d0cfc9efb68..f9ac7c9f9bb 100644 --- a/service/autoscaling/api_op_DescribeAdjustmentTypes.go +++ b/service/autoscaling/api_op_DescribeAdjustmentTypes.go @@ -13,13 +13,9 @@ import ( // Describes the available adjustment types for step scaling and simple scaling // policies. The following adjustment types are supported: -// -// * ChangeInCapacity -// -// * -// ExactCapacity -// -// * PercentChangeInCapacity +// - ChangeInCapacity +// - ExactCapacity +// - PercentChangeInCapacity func (c *Client) DescribeAdjustmentTypes(ctx context.Context, params *DescribeAdjustmentTypesInput, optFns ...func(*Options)) (*DescribeAdjustmentTypesOutput, error) { if params == nil { params = &DescribeAdjustmentTypesInput{} diff --git a/service/autoscaling/api_op_DescribeAutoScalingGroups.go b/service/autoscaling/api_op_DescribeAutoScalingGroups.go index 63fbf84869f..a31cc986d7a 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingGroups.go +++ b/service/autoscaling/api_op_DescribeAutoScalingGroups.go @@ -17,9 +17,9 @@ import ( "time" ) -// Gets information about the Auto Scaling groups in the account and Region. If you -// specify Auto Scaling group names, the output includes information for only the -// specified Auto Scaling groups. If you specify filters, the output includes +// Gets information about the Auto Scaling groups in the account and Region. If +// you specify Auto Scaling group names, the output includes information for only +// the specified Auto Scaling groups. If you specify filters, the output includes // information for only those Auto Scaling groups that meet the filter criteria. If // you do not specify group names or filters, the output includes information for // all Auto Scaling groups. This operation also returns information about instances @@ -51,7 +51,7 @@ type DescribeAutoScalingGroupsInput struct { Filters []types.Filter // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -152,7 +152,7 @@ var _ DescribeAutoScalingGroupsAPIClient = (*Client)(nil) // DescribeAutoScalingGroups type DescribeAutoScalingGroupsPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -246,9 +246,9 @@ type GroupExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, GroupExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, GroupExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -430,9 +430,9 @@ type GroupInServiceWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, GroupInServiceWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, GroupInServiceWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -615,9 +615,9 @@ type GroupNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, GroupNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, GroupNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/autoscaling/api_op_DescribeAutoScalingInstances.go b/service/autoscaling/api_op_DescribeAutoScalingInstances.go index 0cac85db48d..59690117256 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingInstances.go +++ b/service/autoscaling/api_op_DescribeAutoScalingInstances.go @@ -36,7 +36,7 @@ type DescribeAutoScalingInstancesInput struct { InstanceIds []string // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 50. + // and the maximum value is 50 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -135,7 +135,7 @@ var _ DescribeAutoScalingInstancesAPIClient = (*Client)(nil) // DescribeAutoScalingInstances type DescribeAutoScalingInstancesPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 50. + // and the maximum value is 50 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeInstanceRefreshes.go b/service/autoscaling/api_op_DescribeInstanceRefreshes.go index b8e79d1d077..158c4f8a497 100644 --- a/service/autoscaling/api_op_DescribeInstanceRefreshes.go +++ b/service/autoscaling/api_op_DescribeInstanceRefreshes.go @@ -12,8 +12,7 @@ import ( ) // Gets information about the instance refreshes for the specified Auto Scaling -// group. This operation is part of the instance refresh feature -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) +// group. This operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) // in Amazon EC2 Auto Scaling, which helps you update instances in your Auto // Scaling group after you make configuration changes. To help you determine the // status of an instance refresh, Amazon EC2 Auto Scaling returns information about @@ -49,7 +48,7 @@ type DescribeInstanceRefreshesInput struct { InstanceRefreshIds []string // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a diff --git a/service/autoscaling/api_op_DescribeLaunchConfigurations.go b/service/autoscaling/api_op_DescribeLaunchConfigurations.go index b8effb5a4b2..f4f1c5121b3 100644 --- a/service/autoscaling/api_op_DescribeLaunchConfigurations.go +++ b/service/autoscaling/api_op_DescribeLaunchConfigurations.go @@ -35,7 +35,7 @@ type DescribeLaunchConfigurationsInput struct { LaunchConfigurationNames []string // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -136,7 +136,7 @@ var _ DescribeLaunchConfigurationsAPIClient = (*Client)(nil) // DescribeLaunchConfigurations type DescribeLaunchConfigurationsPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeLifecycleHookTypes.go b/service/autoscaling/api_op_DescribeLifecycleHookTypes.go index efa9d260ccf..772532f93bf 100644 --- a/service/autoscaling/api_op_DescribeLifecycleHookTypes.go +++ b/service/autoscaling/api_op_DescribeLifecycleHookTypes.go @@ -12,11 +12,8 @@ import ( // Describes the available types of lifecycle hooks. The following hook types are // supported: -// -// * autoscaling:EC2_INSTANCE_LAUNCHING -// -// * -// autoscaling:EC2_INSTANCE_TERMINATING +// - autoscaling:EC2_INSTANCE_LAUNCHING +// - autoscaling:EC2_INSTANCE_TERMINATING func (c *Client) DescribeLifecycleHookTypes(ctx context.Context, params *DescribeLifecycleHookTypesInput, optFns ...func(*Options)) (*DescribeLifecycleHookTypesOutput, error) { if params == nil { params = &DescribeLifecycleHookTypesInput{} diff --git a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go index 5ff3d60b9b8..fd6bd895ee3 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go @@ -11,36 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by DescribeTrafficSources, which can describe +// This API operation is superseded by DescribeTrafficSources , which can describe // multiple traffic sources types. We recommend using DetachTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// DescribeLoadBalancerTargetGroups. You can use both the original -// DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the -// same Auto Scaling group. Gets information about the Elastic Load Balancing +// DescribeLoadBalancerTargetGroups . You can use both the original +// DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on +// the same Auto Scaling group. Gets information about the Elastic Load Balancing // target groups for the specified Auto Scaling group. To determine the attachment // status of the target group, use the State element in the response. When you // attach a target group to an Auto Scaling group, the initial State value is -// Adding. The state transitions to Added after all Auto Scaling instances are +// Adding . The state transitions to Added after all Auto Scaling instances are // registered with the target group. If Elastic Load Balancing health checks are // enabled for the Auto Scaling group, the state transitions to InService after at // least one Auto Scaling instance passes the health check. When the target group -// is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any -// instances that are reported as unhealthy. If no registered instances pass the -// health checks, the target group doesn't enter the InService state. Target groups -// also have an InService state if you attach them in the CreateAutoScalingGroup -// API call. If your target group state is InService, but it is not working -// properly, check the scaling activities by calling DescribeScalingActivities and -// take any corrective actions necessary. For help with failed health checks, see -// Troubleshooting Amazon EC2 Auto Scaling: Health checks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) -// in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic -// Load Balancing to distribute traffic across the instances in your Auto Scaling -// group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) +// is in the InService state, Amazon EC2 Auto Scaling can terminate and replace +// any instances that are reported as unhealthy. If no registered instances pass +// the health checks, the target group doesn't enter the InService state. Target +// groups also have an InService state if you attach them in the +// CreateAutoScalingGroup API call. If your target group state is InService , but +// it is not working properly, check the scaling activities by calling +// DescribeScalingActivities and take any corrective actions necessary. For help +// with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health +// checks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) +// in the Amazon EC2 Auto Scaling User Guide. For more information, see Use +// Elastic Load Balancing to distribute traffic across the instances in your Auto +// Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. You can use this operation to // describe target groups that were attached by using -// AttachLoadBalancerTargetGroups, but not for target groups that were attached by -// using AttachTrafficSources. +// AttachLoadBalancerTargetGroups , but not for target groups that were attached by +// using AttachTrafficSources . func (c *Client) DescribeLoadBalancerTargetGroups(ctx context.Context, params *DescribeLoadBalancerTargetGroupsInput, optFns ...func(*Options)) (*DescribeLoadBalancerTargetGroupsOutput, error) { if params == nil { params = &DescribeLoadBalancerTargetGroupsInput{} @@ -64,7 +63,7 @@ type DescribeLoadBalancerTargetGroupsInput struct { AutoScalingGroupName *string // The maximum number of items to return with this call. The default value is 100 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a diff --git a/service/autoscaling/api_op_DescribeLoadBalancers.go b/service/autoscaling/api_op_DescribeLoadBalancers.go index 869ecd3cd27..ea693e3287e 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancers.go +++ b/service/autoscaling/api_op_DescribeLoadBalancers.go @@ -11,34 +11,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by DescribeTrafficSources, which can describe +// This API operation is superseded by DescribeTrafficSources , which can describe // multiple traffic sources types. We recommend using DescribeTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API +// DescribeLoadBalancers . You can use both the original DescribeLoadBalancers API // operation and DescribeTrafficSources on the same Auto Scaling group. Gets // information about the load balancers for the specified Auto Scaling group. This // operation describes only Classic Load Balancers. If you have Application Load // Balancers, Network Load Balancers, or Gateway Load Balancers, use the // DescribeLoadBalancerTargetGroups API instead. To determine the attachment status // of the load balancer, use the State element in the response. When you attach a -// load balancer to an Auto Scaling group, the initial State value is Adding. The +// load balancer to an Auto Scaling group, the initial State value is Adding . The // state transitions to Added after all Auto Scaling instances are registered with // the load balancer. If Elastic Load Balancing health checks are enabled for the // Auto Scaling group, the state transitions to InService after at least one Auto // Scaling instance passes the health check. When the load balancer is in the // InService state, Amazon EC2 Auto Scaling can terminate and replace any instances // that are reported as unhealthy. If no registered instances pass the health -// checks, the load balancer doesn't enter the InService state. Load balancers also -// have an InService state if you attach them in the CreateAutoScalingGroup API -// call. If your load balancer state is InService, but it is not working properly, -// check the scaling activities by calling DescribeScalingActivities and take any -// corrective actions necessary. For help with failed health checks, see -// Troubleshooting Amazon EC2 Auto Scaling: Health checks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) -// in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic -// Load Balancing to distribute traffic across the instances in your Auto Scaling -// group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) +// checks, the load balancer doesn't enter the InService state. Load balancers +// also have an InService state if you attach them in the CreateAutoScalingGroup +// API call. If your load balancer state is InService , but it is not working +// properly, check the scaling activities by calling DescribeScalingActivities and +// take any corrective actions necessary. For help with failed health checks, see +// Troubleshooting Amazon EC2 Auto Scaling: Health checks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html) +// in the Amazon EC2 Auto Scaling User Guide. For more information, see Use +// Elastic Load Balancing to distribute traffic across the instances in your Auto +// Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeLoadBalancers(ctx context.Context, params *DescribeLoadBalancersInput, optFns ...func(*Options)) (*DescribeLoadBalancersOutput, error) { if params == nil { @@ -63,7 +61,7 @@ type DescribeLoadBalancersInput struct { AutoScalingGroupName *string // The maximum number of items to return with this call. The default value is 100 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a diff --git a/service/autoscaling/api_op_DescribeNotificationConfigurations.go b/service/autoscaling/api_op_DescribeNotificationConfigurations.go index 934654a1c83..4737bb3c1b8 100644 --- a/service/autoscaling/api_op_DescribeNotificationConfigurations.go +++ b/service/autoscaling/api_op_DescribeNotificationConfigurations.go @@ -35,7 +35,7 @@ type DescribeNotificationConfigurationsInput struct { AutoScalingGroupNames []string // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -136,7 +136,7 @@ var _ DescribeNotificationConfigurationsAPIClient = (*Client)(nil) // DescribeNotificationConfigurations type DescribeNotificationConfigurationsPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribePolicies.go b/service/autoscaling/api_op_DescribePolicies.go index 684171ed801..1d438ff4715 100644 --- a/service/autoscaling/api_op_DescribePolicies.go +++ b/service/autoscaling/api_op_DescribePolicies.go @@ -34,7 +34,7 @@ type DescribePoliciesInput struct { AutoScalingGroupName *string // The maximum number of items to be returned with each call. The default value is - // 50 and the maximum value is 100. + // 50 and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -47,8 +47,8 @@ type DescribePoliciesInput struct { // Members: Maximum number of 50 items. PolicyNames []string - // One or more policy types. The valid values are SimpleScaling, StepScaling, - // TargetTrackingScaling, and PredictiveScaling. + // One or more policy types. The valid values are SimpleScaling , StepScaling , + // TargetTrackingScaling , and PredictiveScaling . PolicyTypes []string noSmithyDocumentSerde @@ -142,7 +142,7 @@ var _ DescribePoliciesAPIClient = (*Client)(nil) // DescribePoliciesPaginatorOptions is the paginator options for DescribePolicies type DescribePoliciesPaginatorOptions struct { // The maximum number of items to be returned with each call. The default value is - // 50 and the maximum value is 100. + // 50 and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeScalingActivities.go b/service/autoscaling/api_op_DescribeScalingActivities.go index 87b9ff94fbe..de842ec738a 100644 --- a/service/autoscaling/api_op_DescribeScalingActivities.go +++ b/service/autoscaling/api_op_DescribeScalingActivities.go @@ -15,14 +15,13 @@ import ( // Gets information about the scaling activities in the account and Region. When // scaling events occur, you see a record of the scaling activity in the scaling // activities. For more information, see Verifying a scaling activity for an Auto -// Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) +// Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) // in the Amazon EC2 Auto Scaling User Guide. If the scaling event succeeds, the -// value of the StatusCode element in the response is Successful. If an attempt to +// value of the StatusCode element in the response is Successful . If an attempt to // launch instances failed, the StatusCode value is Failed or Cancelled and the // StatusMessage element in the response indicates the cause of the failure. For -// help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html) +// help interpreting the StatusMessage , see Troubleshooting Amazon EC2 Auto +// Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeScalingActivities(ctx context.Context, params *DescribeScalingActivitiesInput, optFns ...func(*Options)) (*DescribeScalingActivitiesOutput, error) { if params == nil { @@ -54,7 +53,7 @@ type DescribeScalingActivitiesInput struct { IncludeDeletedGroups *bool // The maximum number of items to return with this call. The default value is 100 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -66,8 +65,8 @@ type DescribeScalingActivitiesInput struct { type DescribeScalingActivitiesOutput struct { - // The scaling activities. Activities are sorted by start time. Activities still in - // progress are described first. + // The scaling activities. Activities are sorted by start time. Activities still + // in progress are described first. // // This member is required. Activities []types.Activity @@ -156,7 +155,7 @@ var _ DescribeScalingActivitiesAPIClient = (*Client)(nil) // DescribeScalingActivities type DescribeScalingActivitiesPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 100 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeScheduledActions.go b/service/autoscaling/api_op_DescribeScheduledActions.go index 9b75d9a6f8e..f49123980e8 100644 --- a/service/autoscaling/api_op_DescribeScheduledActions.go +++ b/service/autoscaling/api_op_DescribeScheduledActions.go @@ -41,7 +41,7 @@ type DescribeScheduledActionsInput struct { EndTime *time.Time // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -149,7 +149,7 @@ var _ DescribeScheduledActionsAPIClient = (*Client)(nil) // DescribeScheduledActions type DescribeScheduledActionsPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeTags.go b/service/autoscaling/api_op_DescribeTags.go index 1973b282ea0..56194409b43 100644 --- a/service/autoscaling/api_op_DescribeTags.go +++ b/service/autoscaling/api_op_DescribeTags.go @@ -18,8 +18,7 @@ import ( // specified values for it to be included in the results. You can also specify // multiple filters. The result includes information for a particular tag only if // it matches all the filters. If there's no match, no special message is returned. -// For more information, see Tag Auto Scaling groups and instances -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) +// For more information, see Tag Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { @@ -39,11 +38,11 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op type DescribeTagsInput struct { // One or more filters to scope the tags to return. The maximum number of filters - // per filter type (for example, auto-scaling-group) is 1000. + // per filter type (for example, auto-scaling-group ) is 1000. Filters []types.Filter // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a @@ -140,7 +139,7 @@ var _ DescribeTagsAPIClient = (*Client)(nil) // DescribeTagsPaginatorOptions is the paginator options for DescribeTags type DescribeTagsPaginatorOptions struct { // The maximum number of items to return with this call. The default value is 50 - // and the maximum value is 100. + // and the maximum value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go b/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go index 226a8681e39..4e3dc615230 100644 --- a/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go +++ b/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go @@ -11,8 +11,7 @@ import ( ) // Describes the termination policies supported by Amazon EC2 Auto Scaling. For -// more information, see Work with Amazon EC2 Auto Scaling termination policies -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) +// more information, see Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeTerminationPolicyTypes(ctx context.Context, params *DescribeTerminationPolicyTypesInput, optFns ...func(*Options)) (*DescribeTerminationPolicyTypesOutput, error) { if params == nil { @@ -35,9 +34,9 @@ type DescribeTerminationPolicyTypesInput struct { type DescribeTerminationPolicyTypesOutput struct { - // The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, - // OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, - // OldestLaunchTemplate, and AllocationStrategy. + // The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance , + // OldestLaunchConfiguration , NewestInstance , ClosestToNextInstanceHour , Default + // , OldestLaunchTemplate , and AllocationStrategy . TerminationPolicyTypes []string // Metadata pertaining to the operation's result. diff --git a/service/autoscaling/api_op_DescribeTrafficSources.go b/service/autoscaling/api_op_DescribeTrafficSources.go index cf64b756854..2d68092fa09 100644 --- a/service/autoscaling/api_op_DescribeTrafficSources.go +++ b/service/autoscaling/api_op_DescribeTrafficSources.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the traffic sources for the specified Auto Scaling group. -// You can optionally provide a traffic source type. If you provide a traffic -// source type, then the results only include that traffic source type. If you do -// not provide a traffic source type, then the results include all the traffic -// sources for the specified Auto Scaling group. +// Gets information about the traffic sources for the specified Auto Scaling +// group. You can optionally provide a traffic source type. If you provide a +// traffic source type, then the results only include that traffic source type. If +// you do not provide a traffic source type, then the results include all the +// traffic sources for the specified Auto Scaling group. func (c *Client) DescribeTrafficSources(ctx context.Context, params *DescribeTrafficSourcesInput, optFns ...func(*Options)) (*DescribeTrafficSourcesOutput, error) { if params == nil { params = &DescribeTrafficSourcesInput{} @@ -39,23 +39,19 @@ type DescribeTrafficSourcesInput struct { // This member is required. AutoScalingGroupName *string - // The maximum number of items to return with this call. The maximum value is 50. + // The maximum number of items to return with this call. The maximum value is 50 . MaxRecords *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string - // The traffic source type that you want to describe. The following lists the valid - // values: - // - // * elb if the traffic source is a Classic Load Balancer. - // - // * elbv2 if the - // traffic source is a Application Load Balancer, Gateway Load Balancer, or Network - // Load Balancer. - // - // * vpc-lattice if the traffic source is VPC Lattice. + // The traffic source type that you want to describe. The following lists the + // valid values: + // - elb if the traffic source is a Classic Load Balancer. + // - elbv2 if the traffic source is a Application Load Balancer, Gateway Load + // Balancer, or Network Load Balancer. + // - vpc-lattice if the traffic source is VPC Lattice. TrafficSourceType *string noSmithyDocumentSerde @@ -63,10 +59,10 @@ type DescribeTrafficSourcesInput struct { type DescribeTrafficSourcesOutput struct { - // This string indicates that the response contains more items than can be returned - // in a single response. To receive additional items, specify this string for the - // NextToken value when requesting the next set of items. This value is null when - // there are no more items to return. + // This string indicates that the response contains more items than can be + // returned in a single response. To receive additional items, specify this string + // for the NextToken value when requesting the next set of items. This value is + // null when there are no more items to return. NextToken *string // Information about the traffic sources. @@ -152,7 +148,7 @@ var _ DescribeTrafficSourcesAPIClient = (*Client)(nil) // DescribeTrafficSourcesPaginatorOptions is the paginator options for // DescribeTrafficSources type DescribeTrafficSourcesPaginatorOptions struct { - // The maximum number of items to return with this call. The maximum value is 50. + // The maximum number of items to return with this call. The maximum value is 50 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/autoscaling/api_op_DescribeWarmPool.go b/service/autoscaling/api_op_DescribeWarmPool.go index e8ea56112fd..782e5921ef9 100644 --- a/service/autoscaling/api_op_DescribeWarmPool.go +++ b/service/autoscaling/api_op_DescribeWarmPool.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a warm pool and its instances. For more information, see -// Warm pools for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) +// Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DescribeWarmPool(ctx context.Context, params *DescribeWarmPoolInput, optFns ...func(*Options)) (*DescribeWarmPoolOutput, error) { if params == nil { @@ -38,11 +37,11 @@ type DescribeWarmPoolInput struct { AutoScalingGroupName *string // The maximum number of instances to return with this call. The maximum value is - // 50. + // 50 . MaxRecords *int32 - // The token for the next set of instances to return. (You received this token from - // a previous call.) + // The token for the next set of instances to return. (You received this token + // from a previous call.) NextToken *string noSmithyDocumentSerde @@ -53,10 +52,10 @@ type DescribeWarmPoolOutput struct { // The instances that are currently in the warm pool. Instances []types.Instance - // This string indicates that the response contains more items than can be returned - // in a single response. To receive additional items, specify this string for the - // NextToken value when requesting the next set of items. This value is null when - // there are no more items to return. + // This string indicates that the response contains more items than can be + // returned in a single response. To receive additional items, specify this string + // for the NextToken value when requesting the next set of items. This value is + // null when there are no more items to return. NextToken *string // The warm pool configuration details. diff --git a/service/autoscaling/api_op_DetachInstances.go b/service/autoscaling/api_op_DetachInstances.go index a4959b1f07f..f571090593d 100644 --- a/service/autoscaling/api_op_DetachInstances.go +++ b/service/autoscaling/api_op_DetachInstances.go @@ -18,9 +18,8 @@ import ( // detached. If there is a Classic Load Balancer attached to the Auto Scaling // group, the instances are deregistered from the load balancer. If there are // target groups attached to the Auto Scaling group, the instances are deregistered -// from the target groups. For more information, see Detach EC2 instances from your -// Auto Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html) +// from the target groups. For more information, see Detach EC2 instances from +// your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) DetachInstances(ctx context.Context, params *DetachInstancesInput, optFns ...func(*Options)) (*DetachInstancesOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go index 7ffc7beea24..31411f27465 100644 --- a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go @@ -10,19 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by DetachTrafficSources, which can detach +// This API operation is superseded by DetachTrafficSources , which can detach // multiple traffic sources types. We recommend using DetachTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// DetachLoadBalancerTargetGroups. You can use both the original +// DetachLoadBalancerTargetGroups . You can use both the original // DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the // same Auto Scaling group. Detaches one or more target groups from the specified -// Auto Scaling group. When you detach a target group, it enters the Removing state -// while deregistering the instances in the group. When all instances are +// Auto Scaling group. When you detach a target group, it enters the Removing +// state while deregistering the instances in the group. When all instances are // deregistered, then you can no longer describe the target group using the // DescribeLoadBalancerTargetGroups API call. The instances remain running. You can // use this operation to detach target groups that were attached by using -// AttachLoadBalancerTargetGroups, but not for target groups that were attached by -// using AttachTrafficSources. +// AttachLoadBalancerTargetGroups , but not for target groups that were attached by +// using AttachTrafficSources . func (c *Client) DetachLoadBalancerTargetGroups(ctx context.Context, params *DetachLoadBalancerTargetGroupsInput, optFns ...func(*Options)) (*DetachLoadBalancerTargetGroupsOutput, error) { if params == nil { params = &DetachLoadBalancerTargetGroupsInput{} diff --git a/service/autoscaling/api_op_DetachLoadBalancers.go b/service/autoscaling/api_op_DetachLoadBalancers.go index 88963c99efe..29c7ae2515f 100644 --- a/service/autoscaling/api_op_DetachLoadBalancers.go +++ b/service/autoscaling/api_op_DetachLoadBalancers.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API operation is superseded by DetachTrafficSources, which can detach +// This API operation is superseded by DetachTrafficSources , which can detach // multiple traffic sources types. We recommend using DetachTrafficSources to // simplify how you manage traffic sources. However, we continue to support -// DetachLoadBalancers. You can use both the original DetachLoadBalancers API +// DetachLoadBalancers . You can use both the original DetachLoadBalancers API // operation and DetachTrafficSources on the same Auto Scaling group. Detaches one // or more Classic Load Balancers from the specified Auto Scaling group. This // operation detaches only Classic Load Balancers. If you have Application Load diff --git a/service/autoscaling/api_op_DetachTrafficSources.go b/service/autoscaling/api_op_DetachTrafficSources.go index 85ede7fd13b..9a53089f830 100644 --- a/service/autoscaling/api_op_DetachTrafficSources.go +++ b/service/autoscaling/api_op_DetachTrafficSources.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches one or more traffic sources from the specified Auto Scaling group. When -// you detach a taffic, it enters the Removing state while deregistering the +// Detaches one or more traffic sources from the specified Auto Scaling group. +// When you detach a taffic, it enters the Removing state while deregistering the // instances in the group. When all instances are deregistered, then you can no // longer describe the traffic source using the DescribeTrafficSources API call. // The instances continue to run. diff --git a/service/autoscaling/api_op_DisableMetricsCollection.go b/service/autoscaling/api_op_DisableMetricsCollection.go index c3641e5fa0c..65711df2bae 100644 --- a/service/autoscaling/api_op_DisableMetricsCollection.go +++ b/service/autoscaling/api_op_DisableMetricsCollection.go @@ -35,57 +35,28 @@ type DisableMetricsCollectionInput struct { // Identifies the metrics to disable. You can specify one or more of the following // metrics: - // - // * GroupMinSize - // - // * GroupMaxSize - // - // * GroupDesiredCapacity - // - // * - // GroupInServiceInstances - // - // * GroupPendingInstances - // - // * GroupStandbyInstances - // - // * - // GroupTerminatingInstances - // - // * GroupTotalInstances - // - // * GroupInServiceCapacity - // - // * - // GroupPendingCapacity - // - // * GroupStandbyCapacity - // - // * GroupTerminatingCapacity - // - // * - // GroupTotalCapacity - // - // * WarmPoolDesiredCapacity - // - // * WarmPoolWarmedCapacity - // - // * - // WarmPoolPendingCapacity - // - // * WarmPoolTerminatingCapacity - // - // * - // WarmPoolTotalCapacity - // - // * GroupAndWarmPoolDesiredCapacity - // - // * - // GroupAndWarmPoolTotalCapacity - // - // If you omit this property, all metrics are - // disabled. For more information, see Auto Scaling group metrics - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) + // - GroupMinSize + // - GroupMaxSize + // - GroupDesiredCapacity + // - GroupInServiceInstances + // - GroupPendingInstances + // - GroupStandbyInstances + // - GroupTerminatingInstances + // - GroupTotalInstances + // - GroupInServiceCapacity + // - GroupPendingCapacity + // - GroupStandbyCapacity + // - GroupTerminatingCapacity + // - GroupTotalCapacity + // - WarmPoolDesiredCapacity + // - WarmPoolWarmedCapacity + // - WarmPoolPendingCapacity + // - WarmPoolTerminatingCapacity + // - WarmPoolTotalCapacity + // - GroupAndWarmPoolDesiredCapacity + // - GroupAndWarmPoolTotalCapacity + // If you omit this property, all metrics are disabled. For more information, see + // Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) // in the Amazon EC2 Auto Scaling User Guide. Metrics []string diff --git a/service/autoscaling/api_op_EnableMetricsCollection.go b/service/autoscaling/api_op_EnableMetricsCollection.go index b70e6a23cae..bb6d746a64f 100644 --- a/service/autoscaling/api_op_EnableMetricsCollection.go +++ b/service/autoscaling/api_op_EnableMetricsCollection.go @@ -14,8 +14,7 @@ import ( // use these metrics to track changes in an Auto Scaling group and to set alarms on // threshold values. You can view group metrics using the Amazon EC2 Auto Scaling // console or the CloudWatch console. For more information, see Monitor CloudWatch -// metrics for your Auto Scaling groups and instances -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html) +// metrics for your Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) EnableMetricsCollection(ctx context.Context, params *EnableMetricsCollectionInput, optFns ...func(*Options)) (*EnableMetricsCollectionOutput, error) { if params == nil { @@ -40,65 +39,35 @@ type EnableMetricsCollectionInput struct { AutoScalingGroupName *string // The frequency at which Amazon EC2 Auto Scaling sends aggregated data to - // CloudWatch. The only valid value is 1Minute. + // CloudWatch. The only valid value is 1Minute . // // This member is required. Granularity *string // Identifies the metrics to enable. You can specify one or more of the following // metrics: - // - // * GroupMinSize - // - // * GroupMaxSize - // - // * GroupDesiredCapacity - // - // * - // GroupInServiceInstances - // - // * GroupPendingInstances - // - // * GroupStandbyInstances - // - // * - // GroupTerminatingInstances - // - // * GroupTotalInstances - // - // * GroupInServiceCapacity - // - // * - // GroupPendingCapacity - // - // * GroupStandbyCapacity - // - // * GroupTerminatingCapacity - // - // * - // GroupTotalCapacity - // - // * WarmPoolDesiredCapacity - // - // * WarmPoolWarmedCapacity - // - // * - // WarmPoolPendingCapacity - // - // * WarmPoolTerminatingCapacity - // - // * - // WarmPoolTotalCapacity - // - // * GroupAndWarmPoolDesiredCapacity - // - // * - // GroupAndWarmPoolTotalCapacity - // - // If you specify Granularity and don't specify any - // metrics, all metrics are enabled. For more information, see Auto Scaling group - // metrics - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) + // - GroupMinSize + // - GroupMaxSize + // - GroupDesiredCapacity + // - GroupInServiceInstances + // - GroupPendingInstances + // - GroupStandbyInstances + // - GroupTerminatingInstances + // - GroupTotalInstances + // - GroupInServiceCapacity + // - GroupPendingCapacity + // - GroupStandbyCapacity + // - GroupTerminatingCapacity + // - GroupTotalCapacity + // - WarmPoolDesiredCapacity + // - WarmPoolWarmedCapacity + // - WarmPoolPendingCapacity + // - WarmPoolTerminatingCapacity + // - WarmPoolTotalCapacity + // - GroupAndWarmPoolDesiredCapacity + // - GroupAndWarmPoolTotalCapacity + // If you specify Granularity and don't specify any metrics, all metrics are + // enabled. For more information, see Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) // in the Amazon EC2 Auto Scaling User Guide. Metrics []string diff --git a/service/autoscaling/api_op_EnterStandby.go b/service/autoscaling/api_op_EnterStandby.go index a01fabeaeb5..ddaec1d4a44 100644 --- a/service/autoscaling/api_op_EnterStandby.go +++ b/service/autoscaling/api_op_EnterStandby.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves the specified instances into the standby state. If you choose to decrement -// the desired capacity of the Auto Scaling group, the instances can enter standby -// as long as the desired capacity of the Auto Scaling group after the instances -// are placed into standby is equal to or greater than the minimum capacity of the -// group. If you choose not to decrement the desired capacity of the Auto Scaling -// group, the Auto Scaling group launches new instances to replace the instances on -// standby. For more information, see Temporarily removing instances from your Auto -// Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) +// Moves the specified instances into the standby state. If you choose to +// decrement the desired capacity of the Auto Scaling group, the instances can +// enter standby as long as the desired capacity of the Auto Scaling group after +// the instances are placed into standby is equal to or greater than the minimum +// capacity of the group. If you choose not to decrement the desired capacity of +// the Auto Scaling group, the Auto Scaling group launches new instances to replace +// the instances on standby. For more information, see Temporarily removing +// instances from your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) EnterStandby(ctx context.Context, params *EnterStandbyInput, optFns ...func(*Options)) (*EnterStandbyOutput, error) { if params == nil { @@ -43,8 +42,8 @@ type EnterStandbyInput struct { // This member is required. AutoScalingGroupName *string - // Indicates whether to decrement the desired capacity of the Auto Scaling group by - // the number of instances moved to Standby mode. + // Indicates whether to decrement the desired capacity of the Auto Scaling group + // by the number of instances moved to Standby mode. // // This member is required. ShouldDecrementDesiredCapacity *bool diff --git a/service/autoscaling/api_op_ExecutePolicy.go b/service/autoscaling/api_op_ExecutePolicy.go index ffc20a313c2..d8ebc5c56bb 100644 --- a/service/autoscaling/api_op_ExecutePolicy.go +++ b/service/autoscaling/api_op_ExecutePolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Executes the specified policy. This can be useful for testing the design of your -// scaling policy. +// Executes the specified policy. This can be useful for testing the design of +// your scaling policy. func (c *Client) ExecutePolicy(ctx context.Context, params *ExecutePolicyInput, optFns ...func(*Options)) (*ExecutePolicyOutput, error) { if params == nil { params = &ExecutePolicyInput{} @@ -43,12 +43,12 @@ type ExecutePolicyInput struct { // Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to // complete before executing the policy. Valid only if the policy type is - // SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto + // SimpleScaling . For more information, see Scaling cooldowns for Amazon EC2 Auto // Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in // the Amazon EC2 Auto Scaling User Guide. HonorCooldown *bool - // The metric value to compare to BreachThreshold. This enables you to execute a + // The metric value to compare to BreachThreshold . This enables you to execute a // policy of type StepScaling and determine which step adjustment to use. For // example, if the breach threshold is 50 and you want to use a step adjustment // with a lower bound of 0 and an upper bound of 10, you can set the metric value diff --git a/service/autoscaling/api_op_ExitStandby.go b/service/autoscaling/api_op_ExitStandby.go index 9c090d4220f..8b9cf4226e7 100644 --- a/service/autoscaling/api_op_ExitStandby.go +++ b/service/autoscaling/api_op_ExitStandby.go @@ -13,8 +13,7 @@ import ( // Moves the specified instances out of the standby state. After you put the // instances back in service, the desired capacity is incremented. For more -// information, see Temporarily removing instances from your Auto Scaling group -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) +// information, see Temporarily removing instances from your Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) ExitStandby(ctx context.Context, params *ExitStandbyInput, optFns ...func(*Options)) (*ExitStandbyOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_GetPredictiveScalingForecast.go b/service/autoscaling/api_op_GetPredictiveScalingForecast.go index e9d58e57622..e0fe089a886 100644 --- a/service/autoscaling/api_op_GetPredictiveScalingForecast.go +++ b/service/autoscaling/api_op_GetPredictiveScalingForecast.go @@ -18,9 +18,8 @@ import ( // predicted values for the minimum capacity that is needed on an hourly basis, // based on the hourly load forecast. A minimum of 24 hours of data is required to // create the initial forecasts. However, having a full 14 days of historical data -// results in more accurate forecasts. For more information, see Predictive scaling -// for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) +// results in more accurate forecasts. For more information, see Predictive +// scaling for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) GetPredictiveScalingForecast(ctx context.Context, params *GetPredictiveScalingForecastInput, optFns ...func(*Options)) (*GetPredictiveScalingForecastOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_PutLifecycleHook.go b/service/autoscaling/api_op_PutLifecycleHook.go index 4a654c49448..9c82f9b98dd 100644 --- a/service/autoscaling/api_op_PutLifecycleHook.go +++ b/service/autoscaling/api_op_PutLifecycleHook.go @@ -15,35 +15,24 @@ import ( // Scaling instance lifecycle, and then perform a custom action on instances when // the corresponding lifecycle event occurs. This step is a part of the procedure // for adding a lifecycle hook to an Auto Scaling group: +// - (Optional) Create a launch template or launch configuration with a user +// data script that runs while an instance is in a wait state due to a lifecycle +// hook. +// - (Optional) Create a Lambda function and a rule that allows Amazon +// EventBridge to invoke your Lambda function when an instance is put into a wait +// state due to a lifecycle hook. +// - (Optional) Create a notification target and an IAM role. The target can be +// either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 +// Auto Scaling to publish lifecycle notifications to the target. +// - Create the lifecycle hook. Specify whether the hook is used when the +// instances launch or terminate. +// - If you need more time, record the lifecycle action heartbeat to keep the +// instance in a wait state using the RecordLifecycleActionHeartbeat API call. +// - If you finish before the timeout period ends, send a callback by using the +// CompleteLifecycleAction API call. // -// * (Optional) Create a -// launch template or launch configuration with a user data script that runs while -// an instance is in a wait state due to a lifecycle hook. -// -// * (Optional) Create a -// Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda -// function when an instance is put into a wait state due to a lifecycle hook. -// -// * -// (Optional) Create a notification target and an IAM role. The target can be -// either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 -// Auto Scaling to publish lifecycle notifications to the target. -// -// * Create the -// lifecycle hook. Specify whether the hook is used when the instances launch or -// terminate. -// -// * If you need more time, record the lifecycle action heartbeat to -// keep the instance in a wait state using the RecordLifecycleActionHeartbeat API -// call. -// -// * If you finish before the timeout period ends, send a callback by using -// the CompleteLifecycleAction API call. -// -// For more information, see Amazon EC2 Auto -// Scaling lifecycle hooks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in -// the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of +// For more information, see Amazon EC2 Auto Scaling lifecycle hooks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) +// in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of // lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. // You can view the lifecycle hooks for an Auto Scaling group using the // DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, @@ -76,7 +65,7 @@ type PutLifecycleHookInput struct { LifecycleHookName *string // The action the Auto Scaling group takes when the lifecycle hook timeout elapses - // or if an unexpected failure occurs. The default value is ABANDON. Valid values: + // or if an unexpected failure occurs. The default value is ABANDON . Valid values: // CONTINUE | ABANDON DefaultResult *string @@ -85,21 +74,17 @@ type PutLifecycleHookInput struct { // hour). HeartbeatTimeout *int32 - // The lifecycle transition. For Auto Scaling groups, there are two major lifecycle - // transitions. - // - // * To create a lifecycle hook for scale-out events, specify - // autoscaling:EC2_INSTANCE_LAUNCHING. - // - // * To create a lifecycle hook for scale-in - // events, specify autoscaling:EC2_INSTANCE_TERMINATING. - // - // Required for new - // lifecycle hooks, but optional when updating existing hooks. + // The lifecycle transition. For Auto Scaling groups, there are two major + // lifecycle transitions. + // - To create a lifecycle hook for scale-out events, specify + // autoscaling:EC2_INSTANCE_LAUNCHING . + // - To create a lifecycle hook for scale-in events, specify + // autoscaling:EC2_INSTANCE_TERMINATING . + // Required for new lifecycle hooks, but optional when updating existing hooks. LifecycleTransition *string - // Additional information that you want to include any time Amazon EC2 Auto Scaling - // sends a message to the notification target. + // Additional information that you want to include any time Amazon EC2 Auto + // Scaling sends a message to the notification target. NotificationMetadata *string // The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto @@ -109,8 +94,8 @@ type PutLifecycleHookInput struct { // JSON format when sending notifications to an Amazon SQS queue, and an email // key-value pair format when sending notifications to an Amazon SNS topic. When // you specify a notification target, Amazon EC2 Auto Scaling sends it a test - // message. Test messages contain the following additional key-value pair: "Event": - // "autoscaling:TEST_NOTIFICATION". + // message. Test messages contain the following additional key-value pair: + // "Event": "autoscaling:TEST_NOTIFICATION" . NotificationTargetARN *string // The ARN of the IAM role that allows the Auto Scaling group to publish to the diff --git a/service/autoscaling/api_op_PutNotificationConfiguration.go b/service/autoscaling/api_op_PutNotificationConfiguration.go index 32f6efa3240..596fbe8d581 100644 --- a/service/autoscaling/api_op_PutNotificationConfiguration.go +++ b/service/autoscaling/api_op_PutNotificationConfiguration.go @@ -14,8 +14,7 @@ import ( // take place. Subscribers to the specified topic can have messages delivered to an // endpoint such as a web server or an email address. This configuration overwrites // any existing configuration. For more information, see Getting Amazon SNS -// notifications when your Auto Scaling group scales -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) +// notifications when your Auto Scaling group scales (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) // in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of // SNS topics, which is 10 per Auto Scaling group, the call fails. func (c *Client) PutNotificationConfiguration(ctx context.Context, params *PutNotificationConfigurationInput, optFns ...func(*Options)) (*PutNotificationConfigurationOutput, error) { diff --git a/service/autoscaling/api_op_PutScalingPolicy.go b/service/autoscaling/api_op_PutScalingPolicy.go index be44ea165bd..f0e20893d53 100644 --- a/service/autoscaling/api_op_PutScalingPolicy.go +++ b/service/autoscaling/api_op_PutScalingPolicy.go @@ -15,13 +15,10 @@ import ( // are used to scale an Auto Scaling group based on configurable metrics. If no // policies are defined, the dynamic scaling and predictive scaling features are // not used. For more information about using dynamic scaling, see Target tracking -// scaling policies -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) -// and Step and simple scaling policies -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) +// scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) +// and Step and simple scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) // in the Amazon EC2 Auto Scaling User Guide. For more information about using -// predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) +// predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) // in the Amazon EC2 Auto Scaling User Guide. You can view the scaling policies for // an Auto Scaling group using the DescribePolicies API call. If you are no longer // using a scaling policy, you can delete it by calling the DeletePolicy API. @@ -53,25 +50,22 @@ type PutScalingPolicyInput struct { PolicyName *string // Specifies how the scaling adjustment is interpreted (for example, an absolute - // number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, - // and PercentChangeInCapacity. Required if the policy type is StepScaling or - // SimpleScaling. For more information, see Scaling adjustment types - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) + // number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , + // and PercentChangeInCapacity . Required if the policy type is StepScaling or + // SimpleScaling . For more information, see Scaling adjustment types (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) // in the Amazon EC2 Auto Scaling User Guide. AdjustmentType *string - // A cooldown period, in seconds, that applies to a specific simple scaling policy. - // When a cooldown period is specified here, it overrides the default cooldown. - // Valid only if the policy type is SimpleScaling. For more information, see - // Scaling cooldowns for Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the - // Amazon EC2 Auto Scaling User Guide. Default: None + // A cooldown period, in seconds, that applies to a specific simple scaling + // policy. When a cooldown period is specified here, it overrides the default + // cooldown. Valid only if the policy type is SimpleScaling . For more information, + // see Scaling cooldowns for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) + // in the Amazon EC2 Auto Scaling User Guide. Default: None Cooldown *int32 // Indicates whether the scaling policy is enabled or disabled. The default is // enabled. For more information, see Disabling a scaling policy for an Auto - // Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html) + // Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html) // in the Amazon EC2 Auto Scaling User Guide. Enabled *bool @@ -80,26 +74,25 @@ type PutScalingPolicyInput struct { // the CloudWatch metrics. This warm-up period applies to instances launched due to // a specific target tracking or step scaling policy. When a warm-up period is // specified here, it overrides the default instance warmup. Valid only if the - // policy type is TargetTrackingScaling or StepScaling. The default is to use the + // policy type is TargetTrackingScaling or StepScaling . The default is to use the // value for the default instance warmup defined for the group. If default instance // warmup is null, then EstimatedInstanceWarmup falls back to the value of default // cooldown. EstimatedInstanceWarmup *int32 - // The aggregation type for the CloudWatch metrics. The valid values are Minimum, - // Maximum, and Average. If the aggregation type is null, the value is treated as - // Average. Valid only if the policy type is StepScaling. + // The aggregation type for the CloudWatch metrics. The valid values are Minimum , + // Maximum , and Average . If the aggregation type is null, the value is treated as + // Average . Valid only if the policy type is StepScaling . MetricAggregationType *string // The minimum value to scale by when the adjustment type is - // PercentChangeInCapacity. For example, suppose that you create a step scaling + // PercentChangeInCapacity . For example, suppose that you create a step scaling // policy to scale out an Auto Scaling group by 25 percent and you specify a // MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy // is performed, 25 percent of 4 is 1. However, because you specified a // MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 - // instances. Valid only if the policy type is StepScaling or SimpleScaling. For - // more information, see Scaling adjustment types - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) + // instances. Valid only if the policy type is StepScaling or SimpleScaling . For + // more information, see Scaling adjustment types (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) // in the Amazon EC2 Auto Scaling User Guide. Some Auto Scaling groups use instance // weights. In this case, set the MinAdjustmentMagnitude to a value that is at // least as large as your largest instance weight. @@ -111,58 +104,43 @@ type PutScalingPolicyInput struct { MinAdjustmentStep *int32 // One of the following policy types: - // - // * TargetTrackingScaling - // - // * StepScaling - // - // * - // SimpleScaling (default) - // - // * PredictiveScaling + // - TargetTrackingScaling + // - StepScaling + // - SimpleScaling (default) + // - PredictiveScaling PolicyType *string - // A predictive scaling policy. Provides support for predefined and custom metrics. - // Predefined metrics include CPU utilization, network in/out, and the Application - // Load Balancer request count. For more information, see - // PredictiveScalingConfiguration - // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html) + // A predictive scaling policy. Provides support for predefined and custom + // metrics. Predefined metrics include CPU utilization, network in/out, and the + // Application Load Balancer request count. For more information, see + // PredictiveScalingConfiguration (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html) // in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is - // PredictiveScaling. + // PredictiveScaling . PredictiveScalingConfiguration *types.PredictiveScalingConfiguration - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. For exact capacity, you must specify a positive value. - // Required if the policy type is SimpleScaling. (Not used with any other policy + // The amount by which to scale, based on the specified adjustment type. A + // positive value adds to the current capacity while a negative number removes from + // the current capacity. For exact capacity, you must specify a positive value. + // Required if the policy type is SimpleScaling . (Not used with any other policy // type.) ScalingAdjustment *int32 // A set of adjustments that enable you to scale based on the size of the alarm - // breach. Required if the policy type is StepScaling. (Not used with any other + // breach. Required if the policy type is StepScaling . (Not used with any other // policy type.) StepAdjustments []types.StepAdjustment // A target tracking scaling policy. Provides support for predefined or custom // metrics. The following predefined metrics are available: - // - // * - // ASGAverageCPUUtilization - // - // * ASGAverageNetworkIn - // - // * ASGAverageNetworkOut - // - // * - // ALBRequestCountPerTarget - // - // If you specify ALBRequestCountPerTarget for the - // metric, you must specify the ResourceLabel property with the - // PredefinedMetricSpecification. For more information, see - // TargetTrackingConfiguration - // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html) + // - ASGAverageCPUUtilization + // - ASGAverageNetworkIn + // - ASGAverageNetworkOut + // - ALBRequestCountPerTarget + // If you specify ALBRequestCountPerTarget for the metric, you must specify the + // ResourceLabel property with the PredefinedMetricSpecification . For more + // information, see TargetTrackingConfiguration (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html) // in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is - // TargetTrackingScaling. + // TargetTrackingScaling . TargetTrackingConfiguration *types.TargetTrackingConfiguration noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go index 21cf96f1138..24bd4351f38 100644 --- a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go +++ b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go @@ -12,11 +12,10 @@ import ( ) // Creates or updates a scheduled scaling action for an Auto Scaling group. For -// more information, see Scheduled scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html) in -// the Amazon EC2 Auto Scaling User Guide. You can view the scheduled actions for -// an Auto Scaling group using the DescribeScheduledActions API call. If you are no -// longer using a scheduled action, you can delete it by calling the +// more information, see Scheduled scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html) +// in the Amazon EC2 Auto Scaling User Guide. You can view the scheduled actions +// for an Auto Scaling group using the DescribeScheduledActions API call. If you +// are no longer using a scheduled action, you can delete it by calling the // DeleteScheduledAction API. If you try to schedule your action in the past, // Amazon EC2 Auto Scaling returns an error message. func (c *Client) PutScheduledUpdateGroupAction(ctx context.Context, params *PutScheduledUpdateGroupActionInput, optFns ...func(*Options)) (*PutScheduledUpdateGroupActionOutput, error) { @@ -46,14 +45,14 @@ type PutScheduledUpdateGroupActionInput struct { // This member is required. ScheduledActionName *string - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. It can scale + // The desired capacity is the initial capacity of the Auto Scaling group after + // the scheduled action runs and the capacity it attempts to maintain. It can scale // beyond this capacity if you add more scaling conditions. You must specify at - // least one of the following properties: MaxSize, MinSize, or DesiredCapacity. + // least one of the following properties: MaxSize , MinSize , or DesiredCapacity . DesiredCapacity *int32 // The date and time for the recurring schedule to end, in UTC. For example, - // "2021-06-01T00:00:00Z". + // "2021-06-01T00:00:00Z" . EndTime *time.Time // The maximum size of the Auto Scaling group. @@ -64,17 +63,17 @@ type PutScheduledUpdateGroupActionInput struct { // The recurring schedule for this action. This format consists of five fields // separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] - // [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For - // more information about this format, see Crontab (http://crontab.org). When - // StartTime and EndTime are specified with Recurrence, they form the boundaries of - // when the recurring action starts and stops. Cron expressions use Universal + // [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *" ). + // For more information about this format, see Crontab (http://crontab.org) . When + // StartTime and EndTime are specified with Recurrence , they form the boundaries + // of when the recurring action starts and stops. Cron expressions use Universal // Coordinated Time (UTC) by default. Recurrence *string // The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in - // UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z"). If you specify - // Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this - // time, and then performs the action based on the specified recurrence. + // UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z" ). If you + // specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action + // at this time, and then performs the action based on the specified recurrence. StartTime *time.Time // This property is no longer used. @@ -83,9 +82,9 @@ type PutScheduledUpdateGroupActionInput struct { // Specifies the time zone for a cron expression. If a time zone is not provided, // UTC is used by default. Valid values are the canonical names of the IANA time // zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or - // Pacific/Tahiti). For more information, see - // https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - // (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + // Pacific/Tahiti ). For more information, see + // https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + // . TimeZone *string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_PutWarmPool.go b/service/autoscaling/api_op_PutWarmPool.go index c6d515bad4b..d395499601d 100644 --- a/service/autoscaling/api_op_PutWarmPool.go +++ b/service/autoscaling/api_op_PutWarmPool.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates a warm pool for the specified Auto Scaling group. A warm pool -// is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling -// group. Whenever your application needs to scale out, the Auto Scaling group can -// draw on the warm pool to meet its new desired capacity. For more information and -// example configurations, see Warm pools for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) +// Creates or updates a warm pool for the specified Auto Scaling group. A warm +// pool is a pool of pre-initialized EC2 instances that sits alongside the Auto +// Scaling group. Whenever your application needs to scale out, the Auto Scaling +// group can draw on the warm pool to meet its new desired capacity. For more +// information and example configurations, see Warm pools for Amazon EC2 Auto +// Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) // in the Amazon EC2 Auto Scaling User Guide. This operation must be called from // the Region in which the Auto Scaling group was created. This operation cannot be // called on an Auto Scaling group that has a mixed instances policy or a launch @@ -57,12 +57,12 @@ type PutWarmPoolInput struct { // desired capacity. If a value for MaxGroupPreparedCapacity is not specified, // Amazon EC2 Auto Scaling launches and maintains the difference between the // group's maximum capacity and its desired capacity. If you specify a value for - // MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between + // MaxGroupPreparedCapacity , Amazon EC2 Auto Scaling uses the difference between // the MaxGroupPreparedCapacity and the desired capacity instead. The size of the // warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to // the same value does the warm pool have an absolute size. If the desired capacity - // of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the - // capacity of the warm pool is 0, unless you specify a value for MinSize. To + // of the Auto Scaling group is higher than the MaxGroupPreparedCapacity , the + // capacity of the warm pool is 0, unless you specify a value for MinSize . To // remove a value that you previously set, include the property but specify -1 for // the value. MaxGroupPreparedCapacity *int32 @@ -73,7 +73,7 @@ type PutWarmPoolInput struct { MinSize *int32 // Sets the instance state to transition to after the lifecycle actions are - // complete. Default is Stopped. + // complete. Default is Stopped . PoolState types.WarmPoolState noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go index 69090b40e5d..14198c2940b 100644 --- a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go +++ b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go @@ -10,38 +10,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Records a heartbeat for the lifecycle action associated with the specified token -// or instance. This extends the timeout by the length of time defined using the -// PutLifecycleHook API call. This step is a part of the procedure for adding a -// lifecycle hook to an Auto Scaling group: +// Records a heartbeat for the lifecycle action associated with the specified +// token or instance. This extends the timeout by the length of time defined using +// the PutLifecycleHook API call. This step is a part of the procedure for adding +// a lifecycle hook to an Auto Scaling group: +// - (Optional) Create a launch template or launch configuration with a user +// data script that runs while an instance is in a wait state due to a lifecycle +// hook. +// - (Optional) Create a Lambda function and a rule that allows Amazon +// EventBridge to invoke your Lambda function when an instance is put into a wait +// state due to a lifecycle hook. +// - (Optional) Create a notification target and an IAM role. The target can be +// either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 +// Auto Scaling to publish lifecycle notifications to the target. +// - Create the lifecycle hook. Specify whether the hook is used when the +// instances launch or terminate. +// - If you need more time, record the lifecycle action heartbeat to keep the +// instance in a wait state. +// - If you finish before the timeout period ends, send a callback by using the +// CompleteLifecycleAction API call. // -// * (Optional) Create a launch template -// or launch configuration with a user data script that runs while an instance is -// in a wait state due to a lifecycle hook. -// -// * (Optional) Create a Lambda function -// and a rule that allows Amazon EventBridge to invoke your Lambda function when an -// instance is put into a wait state due to a lifecycle hook. -// -// * (Optional) Create -// a notification target and an IAM role. The target can be either an Amazon SQS -// queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish -// lifecycle notifications to the target. -// -// * Create the lifecycle hook. Specify -// whether the hook is used when the instances launch or terminate. -// -// * If you need -// more time, record the lifecycle action heartbeat to keep the instance in a wait -// state. -// -// * If you finish before the timeout period ends, send a callback by using -// the CompleteLifecycleAction API call. -// -// For more information, see Amazon EC2 Auto -// Scaling lifecycle hooks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in -// the Amazon EC2 Auto Scaling User Guide. +// For more information, see Amazon EC2 Auto Scaling lifecycle hooks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) +// in the Amazon EC2 Auto Scaling User Guide. func (c *Client) RecordLifecycleActionHeartbeat(ctx context.Context, params *RecordLifecycleActionHeartbeatInput, optFns ...func(*Options)) (*RecordLifecycleActionHeartbeatOutput, error) { if params == nil { params = &RecordLifecycleActionHeartbeatInput{} diff --git a/service/autoscaling/api_op_ResumeProcesses.go b/service/autoscaling/api_op_ResumeProcesses.go index 488e5b79c10..a7cdaa24ffb 100644 --- a/service/autoscaling/api_op_ResumeProcesses.go +++ b/service/autoscaling/api_op_ResumeProcesses.go @@ -12,8 +12,7 @@ import ( // Resumes the specified suspended auto scaling processes, or all suspended // process, for the specified Auto Scaling group. For more information, see -// Suspending and resuming scaling processes -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) +// Suspending and resuming scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) ResumeProcesses(ctx context.Context, params *ResumeProcessesInput, optFns ...func(*Options)) (*ResumeProcessesOutput, error) { if params == nil { @@ -38,29 +37,16 @@ type ResumeProcessesInput struct { AutoScalingGroupName *string // One or more of the following processes: - // - // * Launch - // - // * Terminate - // - // * - // AddToLoadBalancer - // - // * AlarmNotification - // - // * AZRebalance - // - // * HealthCheck - // - // * - // InstanceRefresh - // - // * ReplaceUnhealthy - // - // * ScheduledActions - // - // If you omit this - // property, all processes are specified. + // - Launch + // - Terminate + // - AddToLoadBalancer + // - AlarmNotification + // - AZRebalance + // - HealthCheck + // - InstanceRefresh + // - ReplaceUnhealthy + // - ScheduledActions + // If you omit this property, all processes are specified. ScalingProcesses []string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_RollbackInstanceRefresh.go b/service/autoscaling/api_op_RollbackInstanceRefresh.go index 3404c52f85b..c83f13b2141 100644 --- a/service/autoscaling/api_op_RollbackInstanceRefresh.go +++ b/service/autoscaling/api_op_RollbackInstanceRefresh.go @@ -14,26 +14,20 @@ import ( // it made. Amazon EC2 Auto Scaling replaces any instances that were replaced // during the instance refresh. This restores your Auto Scaling group to the // configuration that it was using before the start of the instance refresh. This -// operation is part of the instance refresh feature -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) +// operation is part of the instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) // in Amazon EC2 Auto Scaling, which helps you update instances in your Auto // Scaling group after you make configuration changes. A rollback is not supported // in the following situations: +// - There is no desired configuration specified for the instance refresh. +// - The Auto Scaling group has a launch template that uses an Amazon Web +// Services Systems Manager parameter instead of an AMI ID for the ImageId +// property. +// - The Auto Scaling group uses the launch template's $Latest or $Default +// version. // -// * There is no desired configuration specified for -// the instance refresh. -// -// * The Auto Scaling group has a launch template that uses -// an Amazon Web Services Systems Manager parameter instead of an AMI ID for the -// ImageId property. -// -// * The Auto Scaling group uses the launch template's $Latest -// or $Default version. -// -// When you receive a successful response from this -// operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You -// can check the status of this operation through the DescribeInstanceRefreshes API -// operation. +// When you receive a successful response from this operation, Amazon EC2 Auto +// Scaling immediately begins replacing instances. You can check the status of this +// operation through the DescribeInstanceRefreshes API operation. func (c *Client) RollbackInstanceRefresh(ctx context.Context, params *RollbackInstanceRefreshInput, optFns ...func(*Options)) (*RollbackInstanceRefreshOutput, error) { if params == nil { params = &RollbackInstanceRefreshInput{} diff --git a/service/autoscaling/api_op_SetDesiredCapacity.go b/service/autoscaling/api_op_SetDesiredCapacity.go index f4aff6f332a..e89426231e1 100644 --- a/service/autoscaling/api_op_SetDesiredCapacity.go +++ b/service/autoscaling/api_op_SetDesiredCapacity.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the size of the specified Auto Scaling group. If a scale-in activity occurs -// as a result of a new DesiredCapacity value that is lower than the current size -// of the group, the Auto Scaling group uses its termination policy to determine -// which instances to terminate. For more information, see Manual scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html) +// Sets the size of the specified Auto Scaling group. If a scale-in activity +// occurs as a result of a new DesiredCapacity value that is lower than the +// current size of the group, the Auto Scaling group uses its termination policy to +// determine which instances to terminate. For more information, see Manual scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) SetDesiredCapacity(ctx context.Context, params *SetDesiredCapacityInput, optFns ...func(*Options)) (*SetDesiredCapacityOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_SetInstanceHealth.go b/service/autoscaling/api_op_SetInstanceHealth.go index fb39c375e83..72f2ee5fad9 100644 --- a/service/autoscaling/api_op_SetInstanceHealth.go +++ b/service/autoscaling/api_op_SetInstanceHealth.go @@ -11,9 +11,8 @@ import ( ) // Sets the health status of the specified instance. For more information, see -// Health checks for Auto Scaling instances -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the -// Amazon EC2 Auto Scaling User Guide. +// Health checks for Auto Scaling instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) +// in the Amazon EC2 Auto Scaling User Guide. func (c *Client) SetInstanceHealth(ctx context.Context, params *SetInstanceHealthInput, optFns ...func(*Options)) (*SetInstanceHealthOutput, error) { if params == nil { params = &SetInstanceHealthInput{} @@ -31,8 +30,8 @@ func (c *Client) SetInstanceHealth(ctx context.Context, params *SetInstanceHealt type SetInstanceHealthInput struct { - // The health status of the instance. Set to Healthy to have the instance remain in - // service. Set to Unhealthy to have the instance be out of service. Amazon EC2 + // The health status of the instance. Set to Healthy to have the instance remain + // in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 // Auto Scaling terminates and replaces the unhealthy instance. // // This member is required. @@ -45,10 +44,9 @@ type SetInstanceHealthInput struct { // If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod // specified for the group, by default, this call respects the grace period. Set - // this to False, to have the call not respect the grace period associated with the - // group. For more information about the health check grace period, see - // CreateAutoScalingGroup - // (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html) + // this to False , to have the call not respect the grace period associated with + // the group. For more information about the health check grace period, see + // CreateAutoScalingGroup (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html) // in the Amazon EC2 Auto Scaling API Reference. ShouldRespectGracePeriod *bool diff --git a/service/autoscaling/api_op_SetInstanceProtection.go b/service/autoscaling/api_op_SetInstanceProtection.go index 156a51d5a09..63ffdea7110 100644 --- a/service/autoscaling/api_op_SetInstanceProtection.go +++ b/service/autoscaling/api_op_SetInstanceProtection.go @@ -13,8 +13,7 @@ import ( // Updates the instance protection settings of the specified instances. This // operation cannot be called on instances in a warm pool. For more information // about preventing instances that are part of an Auto Scaling group from -// terminating on scale in, see Using instance scale-in protection -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) +// terminating on scale in, see Using instance scale-in protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) // in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of // instance IDs, which is 50 per Auto Scaling group, the call fails. func (c *Client) SetInstanceProtection(ctx context.Context, params *SetInstanceProtectionInput, optFns ...func(*Options)) (*SetInstanceProtectionOutput, error) { diff --git a/service/autoscaling/api_op_StartInstanceRefresh.go b/service/autoscaling/api_op_StartInstanceRefresh.go index 266a1a42203..d13d2dacb56 100644 --- a/service/autoscaling/api_op_StartInstanceRefresh.go +++ b/service/autoscaling/api_op_StartInstanceRefresh.go @@ -14,9 +14,8 @@ import ( // Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling // performs a rolling update of instances in an Auto Scaling group. Instances are // terminated first and then replaced, which temporarily reduces the capacity -// available within your Auto Scaling group. This operation is part of the instance -// refresh feature -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) +// available within your Auto Scaling group. This operation is part of the +// instance refresh feature (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html) // in Amazon EC2 Auto Scaling, which helps you update instances in your Auto // Scaling group. This feature is helpful, for example, when you have a new AMI or // a new user data script. You just need to create a new launch template that @@ -31,12 +30,12 @@ import ( // misconfigured health checks, or not ignoring or allowing the termination of // instances that are in Standby state or protected from scale in. You can monitor // for failed EC2 launches using the scaling activities. To find the scaling -// activities, call the DescribeScalingActivities API. If you enable auto rollback, -// your Auto Scaling group will be rolled back automatically when the instance -// refresh fails. You can enable this feature before starting an instance refresh -// by specifying the AutoRollback property in the instance refresh preferences. -// Otherwise, to roll back an instance refresh before it finishes, use the -// RollbackInstanceRefresh API. +// activities, call the DescribeScalingActivities API. If you enable auto +// rollback, your Auto Scaling group will be rolled back automatically when the +// instance refresh fails. You can enable this feature before starting an instance +// refresh by specifying the AutoRollback property in the instance refresh +// preferences. Otherwise, to roll back an instance refresh before it finishes, use +// the RollbackInstanceRefresh API. func (c *Client) StartInstanceRefresh(ctx context.Context, params *StartInstanceRefreshInput, optFns ...func(*Options)) (*StartInstanceRefreshOutput, error) { if params == nil { params = &StartInstanceRefreshInput{} @@ -75,16 +74,12 @@ type StartInstanceRefreshInput struct { // percentage, and the behaviors that you want Amazon EC2 Auto Scaling to use if // instances that are in Standby state or protected from scale in are found. You // can also choose to enable additional features, such as the following: - // - // * Auto - // rollback - // - // * Checkpoints - // - // * Skip matching + // - Auto rollback + // - Checkpoints + // - Skip matching Preferences *types.RefreshPreferences - // The strategy to use for the instance refresh. The only valid value is Rolling. + // The strategy to use for the instance refresh. The only valid value is Rolling . Strategy types.RefreshStrategy noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_SuspendProcesses.go b/service/autoscaling/api_op_SuspendProcesses.go index b2e19f87348..b8517c16735 100644 --- a/service/autoscaling/api_op_SuspendProcesses.go +++ b/service/autoscaling/api_op_SuspendProcesses.go @@ -13,8 +13,7 @@ import ( // Suspends the specified auto scaling processes, or all processes, for the // specified Auto Scaling group. If you suspend either the Launch or Terminate // process types, it can prevent other process types from functioning properly. For -// more information, see Suspending and resuming scaling processes -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) +// more information, see Suspending and resuming scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) // in the Amazon EC2 Auto Scaling User Guide. To resume processes that have been // suspended, call the ResumeProcesses API. func (c *Client) SuspendProcesses(ctx context.Context, params *SuspendProcessesInput, optFns ...func(*Options)) (*SuspendProcessesOutput, error) { @@ -40,29 +39,16 @@ type SuspendProcessesInput struct { AutoScalingGroupName *string // One or more of the following processes: - // - // * Launch - // - // * Terminate - // - // * - // AddToLoadBalancer - // - // * AlarmNotification - // - // * AZRebalance - // - // * HealthCheck - // - // * - // InstanceRefresh - // - // * ReplaceUnhealthy - // - // * ScheduledActions - // - // If you omit this - // property, all processes are specified. + // - Launch + // - Terminate + // - AddToLoadBalancer + // - AlarmNotification + // - AZRebalance + // - HealthCheck + // - InstanceRefresh + // - ReplaceUnhealthy + // - ScheduledActions + // If you omit this property, all processes are specified. ScalingProcesses []string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go b/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go index bdfef0135e7..6f2be9ad97c 100644 --- a/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go +++ b/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go @@ -11,19 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Terminates the specified instance and optionally adjusts the desired group size. -// This operation cannot be called on instances in a warm pool. This call simply -// makes a termination request. The instance is not terminated immediately. When an -// instance is terminated, the instance status changes to terminated. You can't -// connect to or start an instance after you've terminated it. If you do not +// Terminates the specified instance and optionally adjusts the desired group +// size. This operation cannot be called on instances in a warm pool. This call +// simply makes a termination request. The instance is not terminated immediately. +// When an instance is terminated, the instance status changes to terminated . You +// can't connect to or start an instance after you've terminated it. If you do not // specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling // launches instances to replace the ones that are terminated. By default, Amazon // EC2 Auto Scaling balances instances across all Availability Zones. If you // decrement the desired capacity, your Auto Scaling group can become unbalanced // between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the // group, and rebalancing might terminate instances in other zones. For more -// information, see Rebalancing activities -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage) +// information, see Rebalancing activities (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) TerminateInstanceInAutoScalingGroup(ctx context.Context, params *TerminateInstanceInAutoScalingGroupInput, optFns ...func(*Options)) (*TerminateInstanceInAutoScalingGroupOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_UpdateAutoScalingGroup.go b/service/autoscaling/api_op_UpdateAutoScalingGroup.go index c0f53bf0b6a..92c0c1b0cda 100644 --- a/service/autoscaling/api_op_UpdateAutoScalingGroup.go +++ b/service/autoscaling/api_op_UpdateAutoScalingGroup.go @@ -28,27 +28,22 @@ import ( // gradually terminated and relaunched as Spot Instances. When replacing instances, // Amazon EC2 Auto Scaling launches new instances before terminating the old ones, // so that updating your group does not compromise the performance or availability -// of your application. Note the following about changing DesiredCapacity, MaxSize, -// or MinSize: +// of your application. Note the following about changing DesiredCapacity , MaxSize +// , or MinSize : +// - If a scale-in activity occurs as a result of a new DesiredCapacity value +// that is lower than the current size of the group, the Auto Scaling group uses +// its termination policy to determine which instances to terminate. +// - If you specify a new value for MinSize without specifying a value for +// DesiredCapacity , and the new MinSize is larger than the current size of the +// group, this sets the group's DesiredCapacity to the new MinSize value. +// - If you specify a new value for MaxSize without specifying a value for +// DesiredCapacity , and the new MaxSize is smaller than the current size of the +// group, this sets the group's DesiredCapacity to the new MaxSize value. // -// * If a scale-in activity occurs as a result of a new -// DesiredCapacity value that is lower than the current size of the group, the Auto -// Scaling group uses its termination policy to determine which instances to -// terminate. -// -// * If you specify a new value for MinSize without specifying a value -// for DesiredCapacity, and the new MinSize is larger than the current size of the -// group, this sets the group's DesiredCapacity to the new MinSize value. -// -// * If you -// specify a new value for MaxSize without specifying a value for DesiredCapacity, -// and the new MaxSize is smaller than the current size of the group, this sets the -// group's DesiredCapacity to the new MaxSize value. -// -// To see which properties have -// been set, call the DescribeAutoScalingGroups API. To view the scaling policies -// for an Auto Scaling group, call the DescribePolicies API. If the group has -// scaling policies, you can update them by calling the PutScalingPolicy API. +// To see which properties have been set, call the DescribeAutoScalingGroups API. +// To view the scaling policies for an Auto Scaling group, call the +// DescribePolicies API. If the group has scaling policies, you can update them by +// calling the PutScalingPolicy API. func (c *Client) UpdateAutoScalingGroup(ctx context.Context, params *UpdateAutoScalingGroupInput, optFns ...func(*Options)) (*UpdateAutoScalingGroupOutput, error) { if params == nil { params = &UpdateAutoScalingGroupInput{} @@ -74,9 +69,8 @@ type UpdateAutoScalingGroupInput struct { // One or more Availability Zones for the group. AvailabilityZones []string - // Enables or disables Capacity Rebalancing. For more information, see Use Capacity - // Rebalancing to handle Amazon EC2 Spot Interruptions - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) + // Enables or disables Capacity Rebalancing. For more information, see Use + // Capacity Rebalancing to handle Amazon EC2 Spot Interruptions (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) // in the Amazon EC2 Auto Scaling User Guide. CapacityRebalance *bool @@ -86,9 +80,8 @@ type UpdateAutoScalingGroupInput struct { // Only needed if you use simple scaling policies. The amount of time, in seconds, // between one scaling activity ending and another one starting due to simple // scaling policies. For more information, see Scaling cooldowns for Amazon EC2 - // Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the - // Amazon EC2 Auto Scaling User Guide. + // Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) + // in the Amazon EC2 Auto Scaling User Guide. DefaultCooldown *int32 // The amount of time, in seconds, until a new instance is considered to have @@ -99,8 +92,7 @@ type UpdateAutoScalingGroupInput struct { // period before aggregating the metrics for new instances with existing instances // in the Amazon CloudWatch metrics that are used for scaling, resulting in more // reliable usage data. For more information, see Set the default instance warmup - // for an Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) + // for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) // in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at // the group level, we recommend that you set the default instance warmup, even if // it is set to 0 seconds. To remove a value that you previously set, include the @@ -115,13 +107,12 @@ type UpdateAutoScalingGroupInput struct { // equal to the maximum size of the group. DesiredCapacity *int32 - // The unit of measurement for the value specified for desired capacity. Amazon EC2 - // Auto Scaling supports DesiredCapacityType for attribute-based instance type + // The unit of measurement for the value specified for desired capacity. Amazon + // EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type // selection only. For more information, see Creating an Auto Scaling group using - // attribute-based instance type selection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) + // attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) // in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling - // specifies units, which translates into number of instances. Valid values: units + // specifies units , which translates into number of instances. Valid values: units // | vcpu | memory-mib DesiredCapacityType *string @@ -129,41 +120,39 @@ type UpdateAutoScalingGroupInput struct { // checking the health status of an EC2 instance that has come into service and // marking it unhealthy due to a failed health check. This is useful if your // instances do not immediately pass their health checks after they enter the - // InService state. For more information, see Set the health check grace period for - // an Auto Scaling group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) + // InService state. For more information, see Set the health check grace period + // for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) // in the Amazon EC2 Auto Scaling User Guide. HealthCheckGracePeriod *int32 // A comma-separated value string of one or more health check types. The valid - // values are EC2, ELB, and VPC_LATTICE. EC2 is the default health check and cannot - // be disabled. For more information, see Health checks for Auto Scaling instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the - // Amazon EC2 Auto Scaling User Guide. Only specify EC2 if you must clear a value - // that was previously set. + // values are EC2 , ELB , and VPC_LATTICE . EC2 is the default health check and + // cannot be disabled. For more information, see Health checks for Auto Scaling + // instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) + // in the Amazon EC2 Auto Scaling User Guide. Only specify EC2 if you must clear a + // value that was previously set. HealthCheckType *string // The name of the launch configuration. If you specify LaunchConfigurationName in - // your update request, you can't specify LaunchTemplate or MixedInstancesPolicy. + // your update request, you can't specify LaunchTemplate or MixedInstancesPolicy . LaunchConfigurationName *string // The launch template and version to use to specify the updates. If you specify // LaunchTemplate in your update request, you can't specify LaunchConfigurationName - // or MixedInstancesPolicy. + // or MixedInstancesPolicy . LaunchTemplate *types.LaunchTemplateSpecification // The maximum amount of time, in seconds, that an instance can be in service. The // default is null. If specified, the value must be either 0 or a number equal to // or greater than 86,400 seconds (1 day). To clear a previously set value, specify // a new value of 0. For more information, see Replacing Auto Scaling instances - // based on maximum instance lifetime - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) + // based on maximum instance lifetime (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) // in the Amazon EC2 Auto Scaling User Guide. MaxInstanceLifetime *int32 // The maximum size of the Auto Scaling group. With a mixed instances policy that - // uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to - // meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will + // uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize + // to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will // never go above MaxSize by more than your largest instance weight (weights that // define how many units each instance contributes to the desired capacity of the // group). @@ -173,37 +162,32 @@ type UpdateAutoScalingGroupInput struct { MinSize *int32 // The mixed instances policy. For more information, see Auto Scaling groups with - // multiple instance types and purchase options - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) + // multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) // in the Amazon EC2 Auto Scaling User Guide. MixedInstancesPolicy *types.MixedInstancesPolicy // Indicates whether newly launched instances are protected from termination by // Amazon EC2 Auto Scaling when scaling in. For more information about preventing - // instances from terminating on scale in, see Using instance scale-in protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) + // instances from terminating on scale in, see Using instance scale-in protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) // in the Amazon EC2 Auto Scaling User Guide. NewInstancesProtectedFromScaleIn *bool - // The name of an existing placement group into which to launch your instances. For - // more information, see Placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. A cluster placement group is a + // The name of an existing placement group into which to launch your instances. + // For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) + // in the Amazon EC2 User Guide for Linux Instances. A cluster placement group is a // logical grouping of instances within a single Availability Zone. You cannot // specify multiple Availability Zones and a cluster placement group. PlacementGroup *string // The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling // group uses to call other Amazon Web Services on your behalf. For more - // information, see Service-linked roles - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) + // information, see Service-linked roles (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) // in the Amazon EC2 Auto Scaling User Guide. ServiceLinkedRoleARN *string // A policy or a list of policies that are used to select the instances to // terminate. The policies are executed in the order that you list them. For more - // information, see Work with Amazon EC2 Auto Scaling termination policies - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) + // information, see Work with Amazon EC2 Auto Scaling termination policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) // in the Amazon EC2 Auto Scaling User Guide. Valid values: Default | // AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance // | OldestLaunchConfiguration | OldestLaunchTemplate | @@ -211,7 +195,7 @@ type UpdateAutoScalingGroupInput struct { TerminationPolicies []string // A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you - // specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify + // specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify // must reside in those Availability Zones. VPCZoneIdentifier *string diff --git a/service/autoscaling/doc.go b/service/autoscaling/doc.go index 99737cecef0..27a42792e23 100644 --- a/service/autoscaling/doc.go +++ b/service/autoscaling/doc.go @@ -1,12 +1,12 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package autoscaling provides the API client, operations, and parameter types for -// Auto Scaling. +// Package autoscaling provides the API client, operations, and parameter types +// for Auto Scaling. // // Amazon EC2 Auto Scaling Amazon EC2 Auto Scaling is designed to automatically // launch and terminate EC2 instances based on user-defined scaling policies, // scheduled actions, and health checks. For more information, see the Amazon EC2 // Auto Scaling User Guide (https://docs.aws.amazon.com/autoscaling/ec2/userguide/) -// and the Amazon EC2 Auto Scaling API Reference -// (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html). +// and the Amazon EC2 Auto Scaling API Reference (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html) +// . package autoscaling diff --git a/service/autoscaling/types/enums.go b/service/autoscaling/types/enums.go index af3895ca2bc..c93c221f21a 100644 --- a/service/autoscaling/types/enums.go +++ b/service/autoscaling/types/enums.go @@ -81,9 +81,9 @@ const ( BareMetalRequired BareMetal = "required" ) -// Values returns all known values for BareMetal. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BareMetal. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BareMetal) Values() []BareMetal { return []BareMetal{ "included", @@ -203,8 +203,8 @@ const ( InstanceRefreshStatusRollbackSuccessful InstanceRefreshStatus = "RollbackSuccessful" ) -// Values returns all known values for InstanceRefreshStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceRefreshStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceRefreshStatus) Values() []InstanceRefreshStatus { return []InstanceRefreshStatus{ @@ -289,9 +289,9 @@ const ( LocalStorageRequired LocalStorage = "required" ) -// Values returns all known values for LocalStorage. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LocalStorage. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LocalStorage) Values() []LocalStorage { return []LocalStorage{ "included", @@ -374,9 +374,9 @@ const ( PredefinedLoadMetricTypeALBTargetGroupRequestCount PredefinedLoadMetricType = "ALBTargetGroupRequestCount" ) -// Values returns all known values for PredefinedLoadMetricType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PredefinedLoadMetricType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PredefinedLoadMetricType) Values() []PredefinedLoadMetricType { return []PredefinedLoadMetricType{ "ASGTotalCPUUtilization", @@ -396,9 +396,9 @@ const ( PredefinedMetricPairTypeALBRequestCount PredefinedMetricPairType = "ALBRequestCount" ) -// Values returns all known values for PredefinedMetricPairType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PredefinedMetricPairType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PredefinedMetricPairType) Values() []PredefinedMetricPairType { return []PredefinedMetricPairType{ "ASGCPUUtilization", @@ -457,8 +457,8 @@ const ( PredictiveScalingModeForecastOnly PredictiveScalingMode = "ForecastOnly" ) -// Values returns all known values for PredictiveScalingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PredictiveScalingMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PredictiveScalingMode) Values() []PredictiveScalingMode { return []PredictiveScalingMode{ diff --git a/service/autoscaling/types/errors.go b/service/autoscaling/types/errors.go index 0ef0c1159f4..948d6242c6a 100644 --- a/service/autoscaling/types/errors.go +++ b/service/autoscaling/types/errors.go @@ -117,7 +117,7 @@ func (e *InvalidNextToken) ErrorFault() smithy.ErrorFault { return smithy.FaultC // The request failed because a desired configuration was not found or an // incompatible launch template (uses a Systems Manager parameter instead of an AMI -// ID) or launch template version ($Latest or $Default) is present on the Auto +// ID) or launch template version ( $Latest or $Default ) is present on the Auto // Scaling group. type IrreversibleInstanceRefreshFault struct { Message *string @@ -144,10 +144,9 @@ func (e *IrreversibleInstanceRefreshFault) ErrorCode() string { } func (e *IrreversibleInstanceRefreshFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have already reached a limit for your Amazon EC2 Auto Scaling resources (for -// example, Auto Scaling groups, launch configurations, or lifecycle hooks). For -// more information, see DescribeAccountLimits -// (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) +// You have already reached a limit for your Amazon EC2 Auto Scaling resources +// (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). +// For more information, see DescribeAccountLimits (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html) // in the Amazon EC2 Auto Scaling API Reference. type LimitExceededFault struct { Message *string diff --git a/service/autoscaling/types/types.go b/service/autoscaling/types/types.go index 5a645bf1182..00b6492ee8a 100644 --- a/service/autoscaling/types/types.go +++ b/service/autoscaling/types/types.go @@ -66,7 +66,7 @@ type Activity struct { // The Amazon Resource Name (ARN) of the Auto Scaling group. AutoScalingGroupARN *string - // The state of the Auto Scaling group, which is either InService or Deleted. + // The state of the Auto Scaling group, which is either InService or Deleted . AutoScalingGroupState *string // A friendly, more verbose description of the activity. @@ -90,8 +90,8 @@ type Activity struct { // Describes a policy adjustment type. type AdjustmentType struct { - // The policy adjustment type. The valid values are ChangeInCapacity, - // ExactCapacity, and PercentChangeInCapacity. + // The policy adjustment type. The valid values are ChangeInCapacity , + // ExactCapacity , and PercentChangeInCapacity . AdjustmentType *string noSmithyDocumentSerde @@ -164,8 +164,8 @@ type AutoScalingGroup struct { // The duration of the default instance warmup, in seconds. DefaultInstanceWarmup *int32 - // The unit of measurement for the value specified for desired capacity. Amazon EC2 - // Auto Scaling supports DesiredCapacityType for attribute-based instance type + // The unit of measurement for the value specified for desired capacity. Amazon + // EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type // selection only. DesiredCapacityType *string @@ -266,8 +266,7 @@ type AutoScalingInstanceDetails struct { InstanceId *string // The lifecycle state for the instance. The Quarantined state is not used. For - // information about lifecycle states, see Instance lifecycle - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) + // information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) // in the Amazon EC2 Auto Scaling User Guide. Valid values: Pending | Pending:Wait // | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | // Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | @@ -317,12 +316,11 @@ type BaselineEbsBandwidthMbpsRequest struct { // Describes a block device mapping. type BlockDeviceMapping struct { - // The device name assigned to the volume (for example, /dev/sdh or xvdh). For more - // information, see Device naming on Linux instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) in the - // Amazon EC2 User Guide for Linux Instances. To define a block device mapping, set - // the device name and exactly one of the following properties: Ebs, NoDevice, or - // VirtualName. + // The device name assigned to the volume (for example, /dev/sdh or xvdh ). For + // more information, see Device naming on Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) + // in the Amazon EC2 User Guide for Linux Instances. To define a block device + // mapping, set the device name and exactly one of the following properties: Ebs , + // NoDevice , or VirtualName . // // This member is required. DeviceName *string @@ -339,7 +337,7 @@ type BlockDeviceMapping struct { // The name of the instance store volume (virtual device) to attach to an instance // at launch. The name must be in the form ephemeralX where X is a number starting - // from zero (0), for example, ephemeral0. + // from zero (0), for example, ephemeral0 . VirtualName *string noSmithyDocumentSerde @@ -366,27 +364,21 @@ type CapacityForecast struct { // Represents a CloudWatch metric of your choosing for a target tracking scaling // policy to use with Amazon EC2 Auto Scaling. To create your customized metric // specification: +// - Add values for each required property from CloudWatch. You can use an +// existing metric, or a new metric that you create. To use your own metric, you +// must first publish the metric to CloudWatch. For more information, see +// Publish custom metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) +// in the Amazon CloudWatch User Guide. +// - Choose a metric that changes proportionally with capacity. The value of the +// metric should increase or decrease in inverse proportion to the number of +// capacity units. That is, the value of the metric should decrease when capacity +// increases. // -// * Add values for each required property from CloudWatch. You can -// use an existing metric, or a new metric that you create. To use your own metric, -// you must first publish the metric to CloudWatch. For more information, see -// Publish custom metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) -// in the Amazon CloudWatch User Guide. -// -// * Choose a metric that changes -// proportionally with capacity. The value of the metric should increase or -// decrease in inverse proportion to the number of capacity units. That is, the -// value of the metric should decrease when capacity increases. -// -// For more -// information about the CloudWatch terminology below, see Amazon CloudWatch -// concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). -// Each individual service provides information about the metrics, namespace, and -// dimensions they use. For more information, see Amazon Web Services services that -// publish CloudWatch metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) +// For more information about the CloudWatch terminology below, see Amazon +// CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// . Each individual service provides information about the metrics, namespace, and +// dimensions they use. For more information, see Amazon Web Services services +// that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. type CustomizedMetricSpecification struct { @@ -394,11 +386,10 @@ type CustomizedMetricSpecification struct { // dimensions, you must specify the same dimensions in your scaling policy. Dimensions []MetricDimension - // The name of the metric. To get the exact metric name, namespace, and dimensions, - // inspect the Metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) - // object that is returned by a call to ListMetrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + // The name of the metric. To get the exact metric name, namespace, and + // dimensions, inspect the Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) + // object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) + // . MetricName *string // The metrics to include in the target tracking scaling policy, as a metric data @@ -412,8 +403,7 @@ type CustomizedMetricSpecification struct { Statistic MetricStatistic // The unit of the metric. For a complete list of the units that CloudWatch - // supports, see the MetricDatum - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) // data type in the Amazon CloudWatch API Reference. Unit *string @@ -422,22 +412,20 @@ type CustomizedMetricSpecification struct { // Describes the desired configuration for an instance refresh. If you specify a // desired configuration, you must specify either a LaunchTemplate or a -// MixedInstancesPolicy. +// MixedInstancesPolicy . type DesiredConfiguration struct { - // Describes the launch template and the version of the launch template that Amazon - // EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about - // launch templates, see Launch templates - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) in - // the Amazon EC2 Auto Scaling User Guide. + // Describes the launch template and the version of the launch template that + // Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more + // information about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) + // in the Amazon EC2 Auto Scaling User Guide. LaunchTemplate *LaunchTemplateSpecification - // Use this structure to launch multiple instance types and On-Demand Instances and - // Spot Instances within a single Auto Scaling group. A mixed instances policy + // Use this structure to launch multiple instance types and On-Demand Instances + // and Spot Instances within a single Auto Scaling group. A mixed instances policy // contains information that Amazon EC2 Auto Scaling can use to launch instances - // and help optimize your costs. For more information, see Auto Scaling groups with - // multiple instance types and purchase options - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) + // and help optimize your costs. For more information, see Auto Scaling groups + // with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) // in the Amazon EC2 Auto Scaling User Guide. MixedInstancesPolicy *MixedInstancesPolicy @@ -449,72 +437,59 @@ type DesiredConfiguration struct { type Ebs struct { // Indicates whether the volume is deleted on instance termination. For Amazon EC2 - // Auto Scaling, the default value is true. + // Auto Scaling, the default value is true . DeleteOnTermination *bool - // Specifies whether the volume should be encrypted. Encrypted EBS volumes can only - // be attached to instances that support Amazon EBS encryption. For more - // information, see Supported instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). - // If your AMI uses encrypted volumes, you can also only launch it on supported + // Specifies whether the volume should be encrypted. Encrypted EBS volumes can + // only be attached to instances that support Amazon EBS encryption. For more + // information, see Supported instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) + // . If your AMI uses encrypted volumes, you can also only launch it on supported // instance types. If you are creating a volume from a snapshot, you cannot create // an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS // key ID when using a launch configuration. If you enable encryption by default, // the EBS volumes that you create are always encrypted, either using the Amazon // Web Services managed KMS key or a customer-managed KMS key, regardless of // whether the snapshot was encrypted. For more information, see Use Amazon Web - // Services KMS keys to encrypt Amazon EBS volumes - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption) + // Services KMS keys to encrypt Amazon EBS volumes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption) // in the Amazon EC2 Auto Scaling User Guide. Encrypted *bool // The number of input/output (I/O) operations per second (IOPS) to provision for - // the volume. For gp3 and io1 volumes, this represents the number of IOPS that are - // provisioned for the volume. For gp2 volumes, this represents the baseline + // the volume. For gp3 and io1 volumes, this represents the number of IOPS that + // are provisioned for the volume. For gp2 volumes, this represents the baseline // performance of the volume and the rate at which the volume accumulates I/O // credits for bursting. The following are the supported values for each volume // type: - // - // * gp3: 3,000-16,000 IOPS - // - // * io1: 100-64,000 IOPS - // - // For io1 volumes, we - // guarantee 64,000 IOPS only for Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families guarantee performance up to 32,000 IOPS. Iops is + // - gp3 : 3,000-16,000 IOPS + // - io1 : 100-64,000 IOPS + // For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro + // System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // . Other instance families guarantee performance up to 32,000 IOPS. Iops is // supported when the volume type is gp3 or io1 and required only when the volume - // type is io1. (Not used with standard, gp2, st1, or sc1 volumes.) + // type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.) Iops *int32 // The snapshot ID of the volume to use. You must specify either a VolumeSize or a - // SnapshotId. + // SnapshotId . SnapshotId *string // The throughput (MiBps) to provision for a gp3 volume. Throughput *int32 - // The volume size, in GiBs. The following are the supported volumes sizes for each - // volume type: - // - // * gp2 and gp3: 1-16,384 - // - // * io1: 4-16,384 - // - // * st1 and sc1: - // 125-16,384 - // - // * standard: 1-1,024 - // - // You must specify either a SnapshotId or a - // VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must - // be equal or greater than the size of the snapshot. + // The volume size, in GiBs. The following are the supported volumes sizes for + // each volume type: + // - gp2 and gp3 : 1-16,384 + // - io1 : 4-16,384 + // - st1 and sc1 : 125-16,384 + // - standard : 1-1,024 + // You must specify either a SnapshotId or a VolumeSize . If you specify both + // SnapshotId and VolumeSize , the volume size must be equal or greater than the + // size of the snapshot. VolumeSize *int32 - // The volume type. For more information, see Amazon EBS volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon EC2 User Guide for Linux Instances. Valid values: standard | io1 | gp2 | - // st1 | sc1 | gp3 + // The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon EC2 User Guide for Linux Instances. Valid values: standard | io1 + // | gp2 | st1 | sc1 | gp3 VolumeType *string noSmithyDocumentSerde @@ -523,61 +498,31 @@ type Ebs struct { // Describes an enabled Auto Scaling group metric. type EnabledMetric struct { - // The granularity of the metric. The only valid value is 1Minute. + // The granularity of the metric. The only valid value is 1Minute . Granularity *string // One of the following metrics: - // - // * GroupMinSize - // - // * GroupMaxSize - // - // * - // GroupDesiredCapacity - // - // * GroupInServiceInstances - // - // * GroupPendingInstances - // - // * - // GroupStandbyInstances - // - // * GroupTerminatingInstances - // - // * GroupTotalInstances - // - // * - // GroupInServiceCapacity - // - // * GroupPendingCapacity - // - // * GroupStandbyCapacity - // - // * - // GroupTerminatingCapacity - // - // * GroupTotalCapacity - // - // * WarmPoolDesiredCapacity - // - // * - // WarmPoolWarmedCapacity - // - // * WarmPoolPendingCapacity - // - // * - // WarmPoolTerminatingCapacity - // - // * WarmPoolTotalCapacity - // - // * - // GroupAndWarmPoolDesiredCapacity - // - // * GroupAndWarmPoolTotalCapacity - // - // For more - // information, see Auto Scaling group metrics - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) + // - GroupMinSize + // - GroupMaxSize + // - GroupDesiredCapacity + // - GroupInServiceInstances + // - GroupPendingInstances + // - GroupStandbyInstances + // - GroupTerminatingInstances + // - GroupTotalInstances + // - GroupInServiceCapacity + // - GroupPendingCapacity + // - GroupStandbyCapacity + // - GroupTerminatingCapacity + // - GroupTotalCapacity + // - WarmPoolDesiredCapacity + // - WarmPoolWarmedCapacity + // - WarmPoolPendingCapacity + // - WarmPoolTerminatingCapacity + // - WarmPoolTotalCapacity + // - GroupAndWarmPoolDesiredCapacity + // - GroupAndWarmPoolTotalCapacity + // For more information, see Auto Scaling group metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) // in the Amazon EC2 Auto Scaling User Guide. Metric *string @@ -601,55 +546,41 @@ type FailedScheduledUpdateGroupActionRequest struct { noSmithyDocumentSerde } -// Describes a filter that is used to return a more specific list of results from a -// describe operation. If you specify multiple filters, the filters are -// automatically logically joined with an AND, and the request returns only the +// Describes a filter that is used to return a more specific list of results from +// a describe operation. If you specify multiple filters, the filters are +// automatically logically joined with an AND , and the request returns only the // results that match all of the specified filters. For more information, see Tag -// Auto Scaling groups and instances -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) +// Auto Scaling groups and instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) // in the Amazon EC2 Auto Scaling User Guide. type Filter struct { // The name of the filter. The valid values for Name depend on which API operation - // you're using with the filter (DescribeAutoScalingGroups or DescribeTags). + // you're using with the filter ( DescribeAutoScalingGroups or DescribeTags ). // DescribeAutoScalingGroups Valid values for Name include the following: - // - // * - // tag-key - Accepts tag keys. The results only include information about the Auto - // Scaling groups associated with these tag keys. - // - // * tag-value - Accepts tag - // values. The results only include information about the Auto Scaling groups - // associated with these tag values. - // - // * tag: - Accepts the key/value combination of - // the tag. Use the tag key in the filter name and the tag value as the filter - // value. The results only include information about the Auto Scaling groups - // associated with the specified key/value combination. - // - // DescribeTags Valid values - // for Name include the following: - // - // * auto-scaling-group - Accepts the names of - // Auto Scaling groups. The results only include information about the tags - // associated with these Auto Scaling groups. - // - // * key - Accepts tag keys. The - // results only include information about the tags associated with these tag - // keys. - // - // * value - Accepts tag values. The results only include information about - // the tags associated with these tag values. - // - // * propagate-at-launch - Accepts a - // Boolean value, which specifies whether tags propagate to instances at launch. - // The results only include information about the tags associated with the - // specified Boolean value. + // - tag-key - Accepts tag keys. The results only include information about the + // Auto Scaling groups associated with these tag keys. + // - tag-value - Accepts tag values. The results only include information about + // the Auto Scaling groups associated with these tag values. + // - tag: - Accepts the key/value combination of the tag. Use the tag key in the + // filter name and the tag value as the filter value. The results only include + // information about the Auto Scaling groups associated with the specified + // key/value combination. + // DescribeTags Valid values for Name include the following: + // - auto-scaling-group - Accepts the names of Auto Scaling groups. The results + // only include information about the tags associated with these Auto Scaling + // groups. + // - key - Accepts tag keys. The results only include information about the tags + // associated with these tag keys. + // - value - Accepts tag values. The results only include information about the + // tags associated with these tag values. + // - propagate-at-launch - Accepts a Boolean value, which specifies whether tags + // propagate to instances at launch. The results only include information about the + // tags associated with the specified Boolean value. Name *string // One or more filter values. Filter values are case-sensitive. If you specify // multiple values for a filter, the values are automatically logically joined with - // an OR, and the request returns all results that match any of the specified + // an OR , and the request returns all results that match any of the specified // values. For example, specify "tag:environment" for the filter name and // "production,development" for the filter values to find Auto Scaling groups with // the tag "environment=production" or "environment=development". @@ -666,9 +597,10 @@ type Instance struct { // This member is required. AvailabilityZone *string - // The last reported health status of the instance. Healthy means that the instance - // is healthy and should remain in service. Unhealthy means that the instance is - // unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it. + // The last reported health status of the instance. Healthy means that the + // instance is healthy and should remain in service. Unhealthy means that the + // instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and + // replace it. // // This member is required. HealthStatus *string @@ -678,9 +610,8 @@ type Instance struct { // This member is required. InstanceId *string - // A description of the current lifecycle state. The Quarantined state is not used. - // For information about lifecycle states, see Instance lifecycle - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) + // A description of the current lifecycle state. The Quarantined state is not + // used. For information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) // in the Amazon EC2 Auto Scaling User Guide. // // This member is required. @@ -709,14 +640,14 @@ type Instance struct { } // The metadata options for the instances. For more information, see Configuring -// the Instance Metadata Options -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) +// the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) // in the Amazon EC2 Auto Scaling User Guide. type InstanceMetadataOptions struct { - // This parameter enables or disables the HTTP metadata endpoint on your instances. - // If the parameter is not specified, the default state is enabled. If you specify - // a value of disabled, you will not be able to access your instance metadata. + // This parameter enables or disables the HTTP metadata endpoint on your + // instances. If the parameter is not specified, the default state is enabled . If + // you specify a value of disabled , you will not be able to access your instance + // metadata. HttpEndpoint InstanceMetadataEndpointState // The desired HTTP PUT response hop limit for instance metadata requests. The @@ -724,14 +655,14 @@ type InstanceMetadataOptions struct { HttpPutResponseHopLimit *int32 // The state of token usage for your instance metadata requests. If the parameter - // is not specified in the request, the default state is optional. If the state is - // optional, you can choose to retrieve instance metadata with or without a signed + // is not specified in the request, the default state is optional . If the state is + // optional , you can choose to retrieve instance metadata with or without a signed // token header on your request. If you retrieve the IAM role credentials without a // token, the version 1.0 role credentials are returned. If you retrieve the IAM // role credentials using a valid signed token, the version 2.0 role credentials - // are returned. If the state is required, you must send a signed token header with - // any instance metadata retrieval requests. In this state, retrieving the IAM role - // credentials always returns the version 2.0 credentials; the version 1.0 + // are returned. If the state is required , you must send a signed token header + // with any instance metadata retrieval requests. In this state, retrieving the IAM + // role credentials always returns the version 2.0 credentials; the version 1.0 // credentials are not available. HttpTokens InstanceMetadataHttpTokensState @@ -741,7 +672,7 @@ type InstanceMetadataOptions struct { // Describes whether detailed monitoring is enabled for the Auto Scaling instances. type InstanceMonitoring struct { - // If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled. + // If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Enabled *bool noSmithyDocumentSerde @@ -763,8 +694,8 @@ type InstanceRefresh struct { InstanceRefreshId *string // The number of instances remaining to update before the instance refresh is - // complete. If you roll back the instance refresh, InstancesToUpdate shows you the - // number of instances that were not yet updated by the instance refresh. + // complete. If you roll back the instance refresh, InstancesToUpdate shows you + // the number of instances that were not yet updated by the instance refresh. // Therefore, these instances don't need to be replaced as part of the rollback. InstancesToUpdate *int32 @@ -790,33 +721,17 @@ type InstanceRefresh struct { StartTime *time.Time // The current status for the instance refresh operation: - // - // * Pending - The request - // was created, but the instance refresh has not started. - // - // * InProgress - An - // instance refresh is in progress. - // - // * Successful - An instance refresh completed - // successfully. - // - // * Failed - An instance refresh failed to complete. You can - // troubleshoot using the status reason and the scaling activities. - // - // * Cancelling - - // An ongoing instance refresh is being cancelled. - // - // * Cancelled - The instance - // refresh is cancelled. - // - // * RollbackInProgress - An instance refresh is being - // rolled back. - // - // * RollbackFailed - The rollback failed to complete. You can - // troubleshoot using the status reason and the scaling activities. - // - // * - // RollbackSuccessful - The rollback completed successfully. + // - Pending - The request was created, but the instance refresh has not started. + // - InProgress - An instance refresh is in progress. + // - Successful - An instance refresh completed successfully. + // - Failed - An instance refresh failed to complete. You can troubleshoot using + // the status reason and the scaling activities. + // - Cancelling - An ongoing instance refresh is being cancelled. + // - Cancelled - The instance refresh is cancelled. + // - RollbackInProgress - An instance refresh is being rolled back. + // - RollbackFailed - The rollback failed to complete. You can troubleshoot using + // the status reason and the scaling activities. + // - RollbackSuccessful - The rollback completed successfully. Status InstanceRefreshStatus // The explanation for the specific status assigned to this operation. @@ -841,8 +756,8 @@ type InstanceRefreshLivePoolProgress struct { noSmithyDocumentSerde } -// Reports progress on replacing instances in an Auto Scaling group that has a warm -// pool. This includes separate details for instances in the warm pool and +// Reports progress on replacing instances in an Auto Scaling group that has a +// warm pool. This includes separate details for instances in the warm pool and // instances in the Auto Scaling group (the live pool). type InstanceRefreshProgressDetails struct { @@ -880,24 +795,17 @@ type InstanceRefreshWarmPoolProgress struct { // specified values. To limit the list of instance types from which Amazon EC2 Auto // Scaling can identify matching instance types, you can use one of the following // parameters, but not both in the same request: +// - AllowedInstanceTypes - The instance types to include in the list. All other +// instance types are ignored, even if they match your specified attributes. +// - ExcludedInstanceTypes - The instance types to exclude from the list, even if +// they match your specified attributes. // -// * AllowedInstanceTypes - The -// instance types to include in the list. All other instance types are ignored, -// even if they match your specified attributes. -// -// * ExcludedInstanceTypes - The -// instance types to exclude from the list, even if they match your specified -// attributes. -// -// You must specify VCpuCount and MemoryMiB. All other attributes are -// optional. Any unspecified optional attribute is set to its default. For more -// information, see Creating an Auto Scaling group using attribute-based instance -// type selection -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) +// You must specify VCpuCount and MemoryMiB . All other attributes are optional. +// Any unspecified optional attribute is set to its default. For more information, +// see Creating an Auto Scaling group using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) // in the Amazon EC2 Auto Scaling User Guide. For help determining which instance // types match your attributes before you apply them to your Auto Scaling group, -// see Preview instance types with specified attributes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) +// see Preview instance types with specified attributes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) // in the Amazon EC2 User Guide for Linux Instances. type InstanceRequirements struct { @@ -913,48 +821,27 @@ type InstanceRequirements struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web // Services Inferentia chips) for an instance type. To exclude accelerator-enabled - // instance types, set Max to 0. Default: No minimum or maximum limits + // instance types, set Max to 0 . Default: No minimum or maximum limits AcceleratorCount *AcceleratorCountRequest // Indicates whether instance types must have accelerators by specific // manufacturers. - // - // * For instance types with NVIDIA devices, specify nvidia. - // - // * For - // instance types with AMD devices, specify amd. - // - // * For instance types with Amazon - // Web Services devices, specify amazon-web-services. - // - // * For instance types with - // Xilinx devices, specify xilinx. - // + // - For instance types with NVIDIA devices, specify nvidia . + // - For instance types with AMD devices, specify amd . + // - For instance types with Amazon Web Services devices, specify + // amazon-web-services . + // - For instance types with Xilinx devices, specify xilinx . // Default: Any manufacturer AcceleratorManufacturers []AcceleratorManufacturer // Lists the accelerators that must be on an instance type. - // - // * For instance types - // with NVIDIA A100 GPUs, specify a100. - // - // * For instance types with NVIDIA V100 - // GPUs, specify v100. - // - // * For instance types with NVIDIA K80 GPUs, specify k80. - // - // * - // For instance types with NVIDIA T4 GPUs, specify t4. - // - // * For instance types with - // NVIDIA M60 GPUs, specify m60. - // - // * For instance types with AMD Radeon Pro V520 - // GPUs, specify radeon-pro-v520. - // - // * For instance types with Xilinx VU9P FPGAs, - // specify vu9p. - // + // - For instance types with NVIDIA A100 GPUs, specify a100 . + // - For instance types with NVIDIA V100 GPUs, specify v100 . + // - For instance types with NVIDIA K80 GPUs, specify k80 . + // - For instance types with NVIDIA T4 GPUs, specify t4 . + // - For instance types with NVIDIA M60 GPUs, specify m60 . + // - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . + // - For instance types with Xilinx VU9P FPGAs, specify vu9p . // Default: Any accelerator AcceleratorNames []AcceleratorName @@ -963,104 +850,78 @@ type InstanceRequirements struct { AcceleratorTotalMemoryMiB *AcceleratorTotalMemoryMiBRequest // Lists the accelerator types that must be on an instance type. - // - // * For instance - // types with GPU accelerators, specify gpu. - // - // * For instance types with FPGA - // accelerators, specify fpga. - // - // * For instance types with inference accelerators, - // specify inference. - // + // - For instance types with GPU accelerators, specify gpu . + // - For instance types with FPGA accelerators, specify fpga . + // - For instance types with inference accelerators, specify inference . // Default: Any accelerator type AcceleratorTypes []AcceleratorType // The instance types to apply your specified attributes against. All other // instance types are ignored, even if they match your specified attributes. You - // can use strings with one or more wild cards, represented by an asterisk (*), to - // allow an instance type, size, or generation. The following are examples: - // m5.8xlarge, c5*.*, m5a.*, r*, *3*. For example, if you specify c5*, Amazon EC2 - // Auto Scaling will allow the entire C5 instance family, which includes all C5a - // and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow - // all the M5a instance types, but not the M5n instance types. If you specify - // AllowedInstanceTypes, you can't specify ExcludedInstanceTypes. Default: All + // can use strings with one or more wild cards, represented by an asterisk ( * ), + // to allow an instance type, size, or generation. The following are examples: + // m5.8xlarge , c5*.* , m5a.* , r* , *3* . For example, if you specify c5* , Amazon + // EC2 Auto Scaling will allow the entire C5 instance family, which includes all + // C5a and C5n instance types. If you specify m5a.* , Amazon EC2 Auto Scaling will + // allow all the M5a instance types, but not the M5n instance types. If you specify + // AllowedInstanceTypes , you can't specify ExcludedInstanceTypes . Default: All // instance types AllowedInstanceTypes []string - // Indicates whether bare metal instance types are included, excluded, or required. - // Default: excluded + // Indicates whether bare metal instance types are included, excluded, or + // required. Default: excluded BareMetal BareMetal // The minimum and maximum baseline bandwidth performance for an instance type, in - // Mbps. For more information, see Amazon EBS–optimized instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the - // Amazon EC2 User Guide for Linux Instances. Default: No minimum or maximum limits + // Mbps. For more information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) + // in the Amazon EC2 User Guide for Linux Instances. Default: No minimum or maximum + // limits BaselineEbsBandwidthMbps *BaselineEbsBandwidthMbpsRequest // Indicates whether burstable performance instance types are included, excluded, - // or required. For more information, see Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // or required. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide for Linux Instances. Default: excluded BurstablePerformance BurstablePerformance // Lists which specific CPU manufacturers to include. - // - // * For instance types with - // Intel CPUs, specify intel. - // - // * For instance types with AMD CPUs, specify amd. - // - // * - // For instance types with Amazon Web Services CPUs, specify - // amazon-web-services. - // - // Don't confuse the CPU hardware manufacturer with the CPU - // hardware architecture. Instances will be launched with a compatible CPU - // architecture based on the Amazon Machine Image (AMI) that you specify in your - // launch template. Default: Any manufacturer + // - For instance types with Intel CPUs, specify intel . + // - For instance types with AMD CPUs, specify amd . + // - For instance types with Amazon Web Services CPUs, specify + // amazon-web-services . + // Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. + // Instances will be launched with a compatible CPU architecture based on the + // Amazon Machine Image (AMI) that you specify in your launch template. Default: + // Any manufacturer CpuManufacturers []CpuManufacturer // The instance types to exclude. You can use strings with one or more wild cards, - // represented by an asterisk (*), to exclude an instance family, type, size, or - // generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*. For - // example, if you specify c5*, you are excluding the entire C5 instance family, - // which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 - // Auto Scaling will exclude all the M5a instance types, but not the M5n instance - // types. If you specify ExcludedInstanceTypes, you can't specify - // AllowedInstanceTypes. Default: No excluded instance types + // represented by an asterisk ( * ), to exclude an instance family, type, size, or + // generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* . + // For example, if you specify c5* , you are excluding the entire C5 instance + // family, which includes all C5a and C5n instance types. If you specify m5a.* , + // Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n + // instance types. If you specify ExcludedInstanceTypes , you can't specify + // AllowedInstanceTypes . Default: No excluded instance types ExcludedInstanceTypes []string // Indicates whether current or previous generation instance types are included. - // - // * - // For current generation instance types, specify current. The current generation - // includes EC2 instance types currently recommended for use. This typically - // includes the latest two to three generations in each instance family. For more - // information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide for Linux Instances. - // - // * For previous generation instance - // types, specify previous. - // + // - For current generation instance types, specify current . The current + // generation includes EC2 instance types currently recommended for use. This + // typically includes the latest two to three generations in each instance family. + // For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide for Linux Instances. + // - For previous generation instance types, specify previous . // Default: Any current or previous generation InstanceGenerations []InstanceGeneration // Indicates whether instance types with instance store volumes are included, - // excluded, or required. For more information, see Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide for Linux Instances. Default: included + // excluded, or required. For more information, see Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide for Linux Instances. Default: included LocalStorage LocalStorage // Indicates the type of local storage that is required. - // - // * For instance types with - // hard disk drive (HDD) storage, specify hdd. - // - // * For instance types with solid - // state drive (SSD) storage, specify ssd. - // + // - For instance types with hard disk drive (HDD) storage, specify hdd . + // - For instance types with solid state drive (SSD) storage, specify ssd . // Default: Any local storage type LocalStorageTypes []LocalStorageType @@ -1083,8 +944,8 @@ type InstanceRequirements struct { // attributes, we will exclude instance types whose price is higher than your // threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling // interprets as a percentage. To turn off price protection, specify a high value, - // such as 999999. If you set DesiredCapacityType to vcpu or memory-mib, the price - // protection threshold is applied based on the per vCPU or per memory price + // such as 999999 . If you set DesiredCapacityType to vcpu or memory-mib , the + // price protection threshold is applied based on the per vCPU or per memory price // instead of the per instance price. Default: 20 OnDemandMaxPricePercentageOverLowestPrice *int32 @@ -1099,8 +960,8 @@ type InstanceRequirements struct { // attributes, we will exclude instance types whose price is higher than your // threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling // interprets as a percentage. To turn off price protection, specify a high value, - // such as 999999. If you set DesiredCapacityType to vcpu or memory-mib, the price - // protection threshold is applied based on the per vCPU or per memory price + // such as 999999 . If you set DesiredCapacityType to vcpu or memory-mib , the + // price protection threshold is applied based on the per vCPU or per memory price // instead of the per instance price. Default: 100 SpotMaxPricePercentageOverLowestPrice *int32 @@ -1112,8 +973,7 @@ type InstanceRequirements struct { } // Describes an instance reuse policy for a warm pool. For more information, see -// Warm pools for Amazon EC2 Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) +// Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html) // in the Amazon EC2 Auto Scaling User Guide. type InstanceReusePolicy struct { @@ -1134,7 +994,7 @@ type InstancesDistribution struct { // overrides that you specify. The following lists the valid values: lowest-price // Uses price to determine which instance types are the highest priority, launching // the lowest priced instance types within an Availability Zone first. This is the - // default value for Auto Scaling groups that specify InstanceRequirements. + // default value for Auto Scaling groups that specify InstanceRequirements . // prioritized You set the order of instance types for the launch template // overrides from highest to lowest priority (from first to last in the list). // Amazon EC2 Auto Scaling launches your highest priority instance types first. If @@ -1155,7 +1015,7 @@ type InstancesDistribution struct { OnDemandBaseCapacity *int32 // Controls the percentages of On-Demand Instances and Spot Instances for your - // additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for + // additional capacity beyond OnDemandBaseCapacity . Expressed as a number (for // example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to // 100, only On-Demand Instances are used. Default: 100 OnDemandPercentageAboveBaseCapacity *int32 @@ -1166,39 +1026,39 @@ type InstancesDistribution struct { // Instances using pools that are optimally chosen based on the available Spot // capacity. This strategy has the lowest risk of interruption. To give certain // instance types a higher chance of launching first, use - // capacity-optimized-prioritized. capacity-optimized-prioritized You set the order - // of instance types for the launch template overrides from highest to lowest + // capacity-optimized-prioritized . capacity-optimized-prioritized You set the + // order of instance types for the launch template overrides from highest to lowest // priority (from first to last in the list). Amazon EC2 Auto Scaling honors the // instance type priorities on a best effort basis but optimizes for capacity - // first. Note that if the On-Demand allocation strategy is set to prioritized, the - // same priority is applied when fulfilling On-Demand capacity. This is not a valid - // value for Auto Scaling groups that specify InstanceRequirements. lowest-price - // Requests Spot Instances using the lowest priced pools within an Availability - // Zone, across the number of Spot pools that you specify for the SpotInstancePools - // property. To ensure that your desired capacity is met, you might receive Spot - // Instances from several pools. This is the default value, but it might lead to - // high interruption rates because this strategy only considers instance price and - // not available capacity. price-capacity-optimized (recommended) The price and - // capacity optimized allocation strategy looks at both price and capacity to - // select the Spot Instance pools that are the least likely to be interrupted and - // have the lowest possible price. + // first. Note that if the On-Demand allocation strategy is set to prioritized , + // the same priority is applied when fulfilling On-Demand capacity. This is not a + // valid value for Auto Scaling groups that specify InstanceRequirements . + // lowest-price Requests Spot Instances using the lowest priced pools within an + // Availability Zone, across the number of Spot pools that you specify for the + // SpotInstancePools property. To ensure that your desired capacity is met, you + // might receive Spot Instances from several pools. This is the default value, but + // it might lead to high interruption rates because this strategy only considers + // instance price and not available capacity. price-capacity-optimized + // (recommended) The price and capacity optimized allocation strategy looks at both + // price and capacity to select the Spot Instance pools that are the least likely + // to be interrupted and have the lowest possible price. SpotAllocationStrategy *string // The number of Spot Instance pools across which to allocate your Spot Instances. // The Spot pools are determined from the different instance types in the - // overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value + // overrides. Valid only when the SpotAllocationStrategy is lowest-price . Value // must be in the range of 1–20. Default: 2 SpotInstancePools *int32 - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // If your maximum price is lower than the Spot price for the instance types that - // you selected, your Spot Instances are not launched. We do not recommend - // specifying a maximum price because it can lead to increased interruptions. When - // Spot Instances launch, you pay the current Spot price. To remove a maximum price - // that you previously set, include the property but specify an empty string ("") - // for the value. If you specify a maximum price, your instances will be - // interrupted more frequently than if you do not specify one. Valid Range: Minimum - // value of 0.001 + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. If your maximum price is lower than the Spot price for the instance + // types that you selected, your Spot Instances are not launched. We do not + // recommend specifying a maximum price because it can lead to increased + // interruptions. When Spot Instances launch, you pay the current Spot price. To + // remove a maximum price that you previously set, include the property but specify + // an empty string ("") for the value. If you specify a maximum price, your + // instances will be interrupted more frequently than if you do not specify one. + // Valid Range: Minimum value of 0.001 SpotMaxPrice *string noSmithyDocumentSerde @@ -1213,16 +1073,14 @@ type LaunchConfiguration struct { CreatedTime *time.Time // The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. - // For more information, see Find a Linux AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the - // Amazon EC2 User Guide for Linux Instances. + // For more information, see Find a Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) + // in the Amazon EC2 User Guide for Linux Instances. // // This member is required. ImageId *string // The instance type for the instances. For information about available instance - // types, see Available instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) + // types, see Available instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) // in the Amazon EC2 User Guide for Linux Instances. // // This member is required. @@ -1239,15 +1097,13 @@ type LaunchConfiguration struct { // address on the subnet. If the instance is launched into a nondefault subnet, the // default is not to assign a public IPv4 address, unless you enabled the option to // assign a public IPv4 address on the subnet. For more information, see Launching - // Auto Scaling instances in a VPC - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the - // Amazon EC2 Auto Scaling User Guide. + // Auto Scaling instances in a VPC (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) + // in the Amazon EC2 Auto Scaling User Guide. AssociatePublicIpAddress *bool // The block device mapping entries that define the block devices to attach to the // instances at launch. By default, the block devices specified in the block device - // mapping for the AMI are used. For more information, see Block Device Mapping - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) + // mapping for the AMI are used. For more information, see Block Device Mapping (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) // in the Amazon EC2 User Guide for Linux Instances. BlockDeviceMappings []BlockDeviceMapping @@ -1257,49 +1113,43 @@ type LaunchConfiguration struct { // Available for backward compatibility. ClassicLinkVPCSecurityGroups []string - // Specifies whether the launch configuration is optimized for EBS I/O (true) or - // not (false). For more information, see Amazon EBS-Optimized Instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the - // Amazon EC2 User Guide for Linux Instances. + // Specifies whether the launch configuration is optimized for EBS I/O ( true ) or + // not ( false ). For more information, see Amazon EBS-Optimized Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) + // in the Amazon EC2 User Guide for Linux Instances. EbsOptimized *bool // The name or the Amazon Resource Name (ARN) of the instance profile associated // with the IAM role for the instance. The instance profile contains the IAM role. // For more information, see IAM role for applications that run on Amazon EC2 - // instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the - // Amazon EC2 Auto Scaling User Guide. + // instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) + // in the Amazon EC2 Auto Scaling User Guide. IamInstanceProfile *string - // Controls whether instances in this group are launched with detailed (true) or - // basic (false) monitoring. For more information, see Configure Monitoring for - // Auto Scaling Instances - // (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) + // Controls whether instances in this group are launched with detailed ( true ) or + // basic ( false ) monitoring. For more information, see Configure Monitoring for + // Auto Scaling Instances (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) // in the Amazon EC2 Auto Scaling User Guide. InstanceMonitoring *InstanceMonitoring // The ID of the kernel associated with the AMI. KernelId *string - // The name of the key pair. For more information, see Amazon EC2 Key Pairs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the - // Amazon EC2 User Guide for Linux Instances. + // The name of the key pair. For more information, see Amazon EC2 Key Pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) + // in the Amazon EC2 User Guide for Linux Instances. KeyName *string // The Amazon Resource Name (ARN) of the launch configuration. LaunchConfigurationARN *string // The metadata options for the instances. For more information, see Configuring - // the Instance Metadata Options - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) + // the Instance Metadata Options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) // in the Amazon EC2 Auto Scaling User Guide. MetadataOptions *InstanceMetadataOptions - // The tenancy of the instance, either default or dedicated. An instance with + // The tenancy of the instance, either default or dedicated . An instance with // dedicated tenancy runs on isolated, single-tenant hardware and can only be - // launched into a VPC. For more information, see Configuring instance tenancy with - // Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) + // launched into a VPC. For more information, see Configuring instance tenancy + // with Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) // in the Amazon EC2 Auto Scaling User Guide. PlacementTenancy *string @@ -1307,23 +1157,19 @@ type LaunchConfiguration struct { RamdiskId *string // A list that contains the security groups to assign to the instances in the Auto - // Scaling group. For more information, see Security Groups for Your VPC - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) + // Scaling group. For more information, see Security Groups for Your VPC (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) // in the Amazon Virtual Private Cloud User Guide. SecurityGroups []string // The maximum hourly price to be paid for any Spot Instance launched to fulfill // the request. Spot Instances are launched when the price you specify exceeds the - // current Spot price. For more information, see Requesting Spot Instances - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html) + // current Spot price. For more information, see Requesting Spot Instances (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html) // in the Amazon EC2 Auto Scaling User Guide. SpotPrice *string // The user data to make available to the launched EC2 instances. For more - // information, see Instance metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // (Linux) and Instance metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) + // information, see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) // (Windows). If you are using a command line tool, base64-encoding is performed // for you, and you can load the text from a file. Otherwise, you must provide // base64-encoded text. User data is limited to 16 KB. @@ -1346,25 +1192,21 @@ type LaunchTemplate struct { noSmithyDocumentSerde } -// Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto -// Scaling group has a mixed instances policy: +// Use this structure to let Amazon EC2 Auto Scaling do the following when the +// Auto Scaling group has a mixed instances policy: +// - Override the instance type that is specified in the launch template. +// - Use multiple instance types. // -// * Override the instance type that -// is specified in the launch template. -// -// * Use multiple instance types. -// -// Specify -// the instance types that you want, or define your instance requirements instead -// and let Amazon EC2 Auto Scaling provision the available instance types that meet -// your requirements. This can provide Amazon EC2 Auto Scaling with a larger -// selection of instance types to choose from when fulfilling Spot and On-Demand -// capacities. You can view which instance types are matched before you apply the -// instance requirements to your Auto Scaling group. After you define your instance -// requirements, you don't have to keep updating these settings to get new EC2 -// instance types automatically. Amazon EC2 Auto Scaling uses the instance -// requirements of the Auto Scaling group to determine whether a new EC2 instance -// type can be used. +// Specify the instance types that you want, or define your instance requirements +// instead and let Amazon EC2 Auto Scaling provision the available instance types +// that meet your requirements. This can provide Amazon EC2 Auto Scaling with a +// larger selection of instance types to choose from when fulfilling Spot and +// On-Demand capacities. You can view which instance types are matched before you +// apply the instance requirements to your Auto Scaling group. After you define +// your instance requirements, you don't have to keep updating these settings to +// get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the +// instance requirements of the Auto Scaling group to determine whether a new EC2 +// instance type can be used. type LaunchTemplateOverrides struct { // The instance requirements. Amazon EC2 Auto Scaling uses your specified @@ -1375,23 +1217,21 @@ type LaunchTemplateOverrides struct { // Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and // create a new launch template for each AMI. Then, create a compatible set of // instance requirements for each launch template. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements - // The instance type, such as m3.xlarge. You must specify an instance type that is + // The instance type, such as m3.xlarge . You must specify an instance type that is // supported in your requested Region and Availability Zones. For more information, - // see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. You can specify up to 40 instance types - // per Auto Scaling group. + // see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon Elastic Compute Cloud User Guide. You can specify up to 40 + // instance types per Auto Scaling group. InstanceType *string // Provides a launch template for the specified instance type or set of instance // requirements. For example, some instance types might require a launch template // with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch // template that's specified in the LaunchTemplate definition. For more - // information, see Specifying a different launch template for an instance type - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) + // information, see Specifying a different launch template for an instance type (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) // in the Amazon EC2 Auto Scaling User Guide. You can specify up to 20 launch // templates per Auto Scaling group. The launch templates specified in the // overrides and in the LaunchTemplate definition count towards this limit. @@ -1406,13 +1246,12 @@ type LaunchTemplateOverrides struct { // are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can // only launch an instance with a WeightedCapacity of five units, the instance is // launched, and the desired capacity is exceeded by three units. For more - // information, see Configuring instance weighting for Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) + // information, see Configuring instance weighting for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) // in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999. // If you specify a value for WeightedCapacity for one instance type, you must // specify a value for WeightedCapacity for all of them. Every Auto Scaling group - // has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you - // set these sizes based on a specific number of instances. However, if you + // has three size parameters ( DesiredCapacity , MaxSize , and MinSize ). Usually, + // you set these sizes based on a specific number of instances. However, if you // configure a mixed instances policy that defines weights for the instance types, // you must specify these sizes with the same units that you use for weighting // instances. @@ -1421,43 +1260,36 @@ type LaunchTemplateOverrides struct { noSmithyDocumentSerde } -// Describes the launch template and the version of the launch template that Amazon -// EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about -// launch templates, see Launch templates -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) in -// the Amazon EC2 Auto Scaling User Guide. +// Describes the launch template and the version of the launch template that +// Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more +// information about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) +// in the Amazon EC2 Auto Scaling User Guide. type LaunchTemplateSpecification struct { // The ID of the launch template. To get the template ID, use the Amazon EC2 - // DescribeLaunchTemplates - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) + // DescribeLaunchTemplates (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) // API operation. New launch templates can be created using the Amazon EC2 - // CreateLaunchTemplate - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) + // CreateLaunchTemplate (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) // API. Conditional: You must specify either a LaunchTemplateId or a - // LaunchTemplateName. + // LaunchTemplateName . LaunchTemplateId *string // The name of the launch template. To get the template name, use the Amazon EC2 - // DescribeLaunchTemplates - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) + // DescribeLaunchTemplates (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html) // API operation. New launch templates can be created using the Amazon EC2 - // CreateLaunchTemplate - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) + // CreateLaunchTemplate (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) // API. Conditional: You must specify either a LaunchTemplateId or a - // LaunchTemplateName. + // LaunchTemplateName . LaunchTemplateName *string - // The version number, $Latest, or $Default. To get the version number, use the - // Amazon EC2 DescribeLaunchTemplateVersions - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html) + // The version number, $Latest , or $Default . To get the version number, use the + // Amazon EC2 DescribeLaunchTemplateVersions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html) // API operation. New launch template versions can be created using the Amazon EC2 - // CreateLaunchTemplateVersion - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html) - // API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version - // of the launch template when launching instances. If the value is $Default, - // Amazon EC2 Auto Scaling selects the default version of the launch template when - // launching instances. The default value is $Default. + // CreateLaunchTemplateVersion (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html) + // API. If the value is $Latest , Amazon EC2 Auto Scaling selects the latest + // version of the launch template when launching instances. If the value is + // $Default , Amazon EC2 Auto Scaling selects the default version of the launch + // template when launching instances. The default value is $Default . Version *string noSmithyDocumentSerde @@ -1476,8 +1308,8 @@ type LifecycleHook struct { DefaultResult *string // The maximum time, in seconds, that an instance can remain in a wait state. The - // maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is - // smaller. + // maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout , whichever + // is smaller. GlobalTimeout *int32 // The maximum time, in seconds, that can elapse before the lifecycle hook times @@ -1492,8 +1324,8 @@ type LifecycleHook struct { // autoscaling:EC2_INSTANCE_TERMINATING LifecycleTransition *string - // Additional information that is included any time Amazon EC2 Auto Scaling sends a - // message to the notification target. + // Additional information that is included any time Amazon EC2 Auto Scaling sends + // a message to the notification target. NotificationMetadata *string // The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when @@ -1508,9 +1340,8 @@ type LifecycleHook struct { } // Describes information used to specify a lifecycle hook for an Auto Scaling -// group. For more information, see Amazon EC2 Auto Scaling lifecycle hooks -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in -// the Amazon EC2 Auto Scaling User Guide. +// group. For more information, see Amazon EC2 Auto Scaling lifecycle hooks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) +// in the Amazon EC2 Auto Scaling User Guide. type LifecycleHookSpecification struct { // The name of the lifecycle hook. @@ -1518,20 +1349,18 @@ type LifecycleHookSpecification struct { // This member is required. LifecycleHookName *string - // The lifecycle transition. For Auto Scaling groups, there are two major lifecycle - // transitions. - // - // * To create a lifecycle hook for scale-out events, specify - // autoscaling:EC2_INSTANCE_LAUNCHING. - // - // * To create a lifecycle hook for scale-in - // events, specify autoscaling:EC2_INSTANCE_TERMINATING. + // The lifecycle transition. For Auto Scaling groups, there are two major + // lifecycle transitions. + // - To create a lifecycle hook for scale-out events, specify + // autoscaling:EC2_INSTANCE_LAUNCHING . + // - To create a lifecycle hook for scale-in events, specify + // autoscaling:EC2_INSTANCE_TERMINATING . // // This member is required. LifecycleTransition *string // The action the Auto Scaling group takes when the lifecycle hook timeout elapses - // or if an unexpected failure occurs. The default value is ABANDON. Valid values: + // or if an unexpected failure occurs. The default value is ABANDON . Valid values: // CONTINUE | ABANDON DefaultResult *string @@ -1540,8 +1369,8 @@ type LifecycleHookSpecification struct { // hour). HeartbeatTimeout *int32 - // Additional information that you want to include any time Amazon EC2 Auto Scaling - // sends a message to the notification target. + // Additional information that you want to include any time Amazon EC2 Auto + // Scaling sends a message to the notification target. NotificationMetadata *string // The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto @@ -1551,8 +1380,7 @@ type LifecycleHookSpecification struct { // The ARN of the IAM role that allows the Auto Scaling group to publish to the // specified notification target. For information about creating this role, see - // Configure a notification target for a lifecycle hook - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) + // Configure a notification target for a lifecycle hook (https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) // in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target // is an Amazon SNS topic or an Amazon SQS queue. RoleARN *string @@ -1567,23 +1395,15 @@ type LoadBalancerState struct { LoadBalancerName *string // One of the following load balancer states: - // - // * Adding - The Auto Scaling - // instances are being registered with the load balancer. - // - // * Added - All Auto - // Scaling instances are registered with the load balancer. - // - // * InService - At least - // one Auto Scaling instance passed an ELB health check. - // - // * Removing - The Auto - // Scaling instances are being deregistered from the load balancer. If connection - // draining is enabled, Elastic Load Balancing waits for in-flight requests to - // complete before deregistering the instances. - // - // * Removed - All Auto Scaling - // instances are deregistered from the load balancer. + // - Adding - The Auto Scaling instances are being registered with the load + // balancer. + // - Added - All Auto Scaling instances are registered with the load balancer. + // - InService - At least one Auto Scaling instance passed an ELB health check. + // - Removing - The Auto Scaling instances are being deregistered from the load + // balancer. If connection draining is enabled, Elastic Load Balancing waits for + // in-flight requests to complete before deregistering the instances. + // - Removed - All Auto Scaling instances are deregistered from the load + // balancer. State *string noSmithyDocumentSerde @@ -1596,23 +1416,14 @@ type LoadBalancerTargetGroupState struct { LoadBalancerTargetGroupARN *string // The state of the target group. - // - // * Adding - The Auto Scaling instances are being - // registered with the target group. - // - // * Added - All Auto Scaling instances are - // registered with the target group. - // - // * InService - At least one Auto Scaling - // instance passed an ELB health check. - // - // * Removing - The Auto Scaling instances - // are being deregistered from the target group. If connection draining is enabled, - // Elastic Load Balancing waits for in-flight requests to complete before - // deregistering the instances. - // - // * Removed - All Auto Scaling instances are - // deregistered from the target group. + // - Adding - The Auto Scaling instances are being registered with the target + // group. + // - Added - All Auto Scaling instances are registered with the target group. + // - InService - At least one Auto Scaling instance passed an ELB health check. + // - Removing - The Auto Scaling instances are being deregistered from the target + // group. If connection draining is enabled, Elastic Load Balancing waits for + // in-flight requests to complete before deregistering the instances. + // - Removed - All Auto Scaling instances are deregistered from the target group. State *string noSmithyDocumentSerde @@ -1678,8 +1489,7 @@ type Metric struct { MetricName *string // The namespace of the metric. For more information, see the table in Amazon Web - // Services services that publish CloudWatch metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) + // Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. // // This member is required. @@ -1687,8 +1497,7 @@ type Metric struct { // The dimensions for the metric. For the list of available dimensions, see the // Amazon Web Services documentation available from the table in Amazon Web - // Services services that publish CloudWatch metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) + // Services services that publish CloudWatch metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) // in the Amazon CloudWatch User Guide. Conditional: If you published your metric // with dimensions, you must specify the same dimensions in your scaling policy. Dimensions []MetricDimension @@ -1700,53 +1509,26 @@ type Metric struct { type MetricCollectionType struct { // One of the following metrics: - // - // * GroupMinSize - // - // * GroupMaxSize - // - // * - // GroupDesiredCapacity - // - // * GroupInServiceInstances - // - // * GroupPendingInstances - // - // * - // GroupStandbyInstances - // - // * GroupTerminatingInstances - // - // * GroupTotalInstances - // - // * - // GroupInServiceCapacity - // - // * GroupPendingCapacity - // - // * GroupStandbyCapacity - // - // * - // GroupTerminatingCapacity - // - // * GroupTotalCapacity - // - // * WarmPoolDesiredCapacity - // - // * - // WarmPoolWarmedCapacity - // - // * WarmPoolPendingCapacity - // - // * - // WarmPoolTerminatingCapacity - // - // * WarmPoolTotalCapacity - // - // * - // GroupAndWarmPoolDesiredCapacity - // - // * GroupAndWarmPoolTotalCapacity + // - GroupMinSize + // - GroupMaxSize + // - GroupDesiredCapacity + // - GroupInServiceInstances + // - GroupPendingInstances + // - GroupStandbyInstances + // - GroupTerminatingInstances + // - GroupTotalInstances + // - GroupInServiceCapacity + // - GroupPendingCapacity + // - GroupStandbyCapacity + // - GroupTerminatingCapacity + // - GroupTotalCapacity + // - WarmPoolDesiredCapacity + // - WarmPoolWarmedCapacity + // - WarmPoolPendingCapacity + // - WarmPoolTerminatingCapacity + // - WarmPoolTotalCapacity + // - GroupAndWarmPoolDesiredCapacity + // - GroupAndWarmPoolTotalCapacity Metric *string noSmithyDocumentSerde @@ -1757,8 +1539,7 @@ type MetricCollectionType struct { // returned metric statistics to create a new time series. A time series is a // series of data points, each of which is associated with a timestamp. For more // information and examples, see Advanced predictive scaling policy configurations -// using custom metrics -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) +// using custom metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) // in the Amazon EC2 Auto Scaling User Guide. type MetricDataQuery struct { @@ -1776,7 +1557,7 @@ type MetricDataQuery struct { // performing a math expression. This expression can use the Id of the other // metrics to refer to those metrics, and can also use the Id of other expressions // to use the result of those expressions. Conditional: Within each MetricDataQuery - // object, you must specify either Expression or MetricStat, but not both. + // object, you must specify either Expression or MetricStat , but not both. Expression *string // A human-readable label for this metric or expression. This is especially useful @@ -1784,7 +1565,7 @@ type MetricDataQuery struct { Label *string // Information about the metric data to return. Conditional: Within each - // MetricDataQuery object, you must specify either Expression or MetricStat, but + // MetricDataQuery object, you must specify either Expression or MetricStat , but // not both. MetricStat *MetricStat @@ -1793,8 +1574,8 @@ type MetricDataQuery struct { // math expression that the metric specification is based on. You must specify // false for ReturnData for all the other metrics and expressions used in the // metric specification. If you are only retrieving metrics and not performing any - // math expressions, do not specify anything for ReturnData. This sets it to its - // default (true). + // math expressions, do not specify anything for ReturnData . This sets it to its + // default ( true ). ReturnData *bool noSmithyDocumentSerde @@ -1819,7 +1600,7 @@ type MetricDimension struct { // Describes a granularity of a metric. type MetricGranularityType struct { - // The granularity. The only valid value is 1Minute. + // The granularity. The only valid value is 1Minute . Granularity *string noSmithyDocumentSerde @@ -1827,53 +1608,48 @@ type MetricGranularityType struct { // This structure defines the CloudWatch metric to return, along with the // statistic, period, and unit. For more information about the CloudWatch -// terminology below, see Amazon CloudWatch concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// terminology below, see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. type MetricStat struct { // The CloudWatch metric to return, including the metric name, namespace, and // dimensions. To get the exact metric name, namespace, and dimensions, inspect the - // Metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) - // object that is returned by a call to ListMetrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). + // Metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) + // object that is returned by a call to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) + // . // // This member is required. Metric *Metric // The statistic to return. It can include any CloudWatch statistic or extended - // statistic. For a list of valid values, see the table in Statistics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) + // statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) // in the Amazon CloudWatch User Guide. The most commonly used metrics for - // predictive scaling are Average and Sum. + // predictive scaling are Average and Sum . // // This member is required. Stat *string // The unit to use for the returned data points. For a complete list of the units - // that CloudWatch supports, see the MetricDatum - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) // data type in the Amazon CloudWatch API Reference. Unit *string noSmithyDocumentSerde } -// Use this structure to launch multiple instance types and On-Demand Instances and -// Spot Instances within a single Auto Scaling group. A mixed instances policy +// Use this structure to launch multiple instance types and On-Demand Instances +// and Spot Instances within a single Auto Scaling group. A mixed instances policy // contains information that Amazon EC2 Auto Scaling can use to launch instances -// and help optimize your costs. For more information, see Auto Scaling groups with -// multiple instance types and purchase options -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) +// and help optimize your costs. For more information, see Auto Scaling groups +// with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) // in the Amazon EC2 Auto Scaling User Guide. type MixedInstancesPolicy struct { // The instances distribution. InstancesDistribution *InstancesDistribution - // One or more launch templates and the instance types (overrides) that are used to - // launch EC2 instances to fulfill On-Demand and Spot capacities. + // One or more launch templates and the instance types (overrides) that are used + // to launch EC2 instances to fulfill On-Demand and Spot capacities. LaunchTemplate *LaunchTemplate noSmithyDocumentSerde @@ -1885,8 +1661,7 @@ type MixedInstancesPolicy struct { // bandwidth. Amazon EC2 will identify instance types that support the specified // minimum bandwidth, but the actual bandwidth of your instance might go below the // specified minimum at times. For more information, see Available instance -// bandwidth -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) +// bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) // in the Amazon EC2 User Guide for Linux Instances. type NetworkBandwidthGbpsRequest struct { @@ -1919,19 +1694,11 @@ type NotificationConfiguration struct { AutoScalingGroupName *string // One of the following event notification types: - // - // * - // autoscaling:EC2_INSTANCE_LAUNCH - // - // * autoscaling:EC2_INSTANCE_LAUNCH_ERROR - // - // * - // autoscaling:EC2_INSTANCE_TERMINATE - // - // * - // autoscaling:EC2_INSTANCE_TERMINATE_ERROR - // - // * autoscaling:TEST_NOTIFICATION + // - autoscaling:EC2_INSTANCE_LAUNCH + // - autoscaling:EC2_INSTANCE_LAUNCH_ERROR + // - autoscaling:EC2_INSTANCE_TERMINATE + // - autoscaling:EC2_INSTANCE_TERMINATE_ERROR + // - autoscaling:TEST_NOTIFICATION NotificationType *string // The Amazon Resource Name (ARN) of the Amazon SNS topic. @@ -1945,20 +1712,14 @@ type NotificationConfiguration struct { type PredefinedMetricSpecification struct { // The metric type. The following predefined metrics are available: - // - // * - // ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. - // - // * - // ASGAverageNetworkIn - Average number of bytes received on all network interfaces - // by the Auto Scaling group. - // - // * ASGAverageNetworkOut - Average number of bytes - // sent out on all network interfaces by the Auto Scaling group. - // - // * - // ALBRequestCountPerTarget - Average Application Load Balancer request count per - // target for your Auto Scaling group. + // - ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling + // group. + // - ASGAverageNetworkIn - Average number of bytes received on all network + // interfaces by the Auto Scaling group. + // - ASGAverageNetworkOut - Average number of bytes sent out on all network + // interfaces by the Auto Scaling group. + // - ALBRequestCountPerTarget - Average Application Load Balancer request count + // per target for your Auto Scaling group. // // This member is required. PredefinedMetricType MetricType @@ -1970,34 +1731,27 @@ type PredefinedMetricSpecification struct { // the final portion of the load balancer ARN and the final portion of the target // group ARN into a single value, separated by a forward slash (/). The format of // the resource label is: - // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. + // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff . // Where: - // - // * app// is the final portion of the load balancer ARN - // - // * targetgroup// - // is the final portion of the target group ARN. - // - // To find the ARN for an - // Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string noSmithyDocumentSerde } -// Represents a predictive scaling policy configuration to use with Amazon EC2 Auto -// Scaling. +// Represents a predictive scaling policy configuration to use with Amazon EC2 +// Auto Scaling. type PredictiveScalingConfiguration struct { - // This structure includes the metrics and target utilization to use for predictive - // scaling. This is an array, but we currently only support a single metric - // specification. That is, you can specify a target value and a single metric pair, - // or a target value and one scaling metric and one load metric. + // This structure includes the metrics and target utilization to use for + // predictive scaling. This is an array, but we currently only support a single + // metric specification. That is, you can specify a target value and a single + // metric pair, or a target value and one scaling metric and one load metric. // // This member is required. MetricSpecifications []PredictiveScalingMetricSpecification @@ -2005,26 +1759,22 @@ type PredictiveScalingConfiguration struct { // Defines the behavior that should be applied if the forecast capacity approaches // or exceeds the maximum capacity of the Auto Scaling group. Defaults to // HonorMaxCapacity if not specified. The following are possible values: - // - // * - // HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than - // the maximum capacity. The maximum capacity is enforced as a hard limit. - // - // * - // IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than - // the maximum capacity when the forecast capacity is close to or exceeds the - // maximum capacity. The upper limit is determined by the forecasted capacity and - // the value for MaxCapacityBuffer. + // - HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher + // than the maximum capacity. The maximum capacity is enforced as a hard limit. + // - IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher + // than the maximum capacity when the forecast capacity is close to or exceeds the + // maximum capacity. The upper limit is determined by the forecasted capacity and + // the value for MaxCapacityBuffer . MaxCapacityBreachBehavior PredictiveScalingMaxCapacityBreachBehavior - // The size of the capacity buffer to use when the forecast capacity is close to or - // exceeds the maximum capacity. The value is specified as a percentage relative to - // the forecast capacity. For example, if the buffer is 10, this means a 10 percent - // buffer, such that if the forecast capacity is 50, and the maximum capacity is - // 40, then the effective maximum capacity is 55. If set to 0, Amazon EC2 Auto - // Scaling may scale capacity higher than the maximum capacity to equal but not - // exceed forecast capacity. Required if the MaxCapacityBreachBehavior property is - // set to IncreaseMaxCapacity, and cannot be used otherwise. + // The size of the capacity buffer to use when the forecast capacity is close to + // or exceeds the maximum capacity. The value is specified as a percentage relative + // to the forecast capacity. For example, if the buffer is 10, this means a 10 + // percent buffer, such that if the forecast capacity is 50, and the maximum + // capacity is 40, then the effective maximum capacity is 55. If set to 0, Amazon + // EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal + // but not exceed forecast capacity. Required if the MaxCapacityBreachBehavior + // property is set to IncreaseMaxCapacity , and cannot be used otherwise. MaxCapacityBuffer *int32 // The predictive scaling mode. Defaults to ForecastOnly if not specified. @@ -2073,9 +1823,9 @@ type PredictiveScalingCustomizedLoadMetric struct { // Describes a custom scaling metric for a predictive scaling policy. type PredictiveScalingCustomizedScalingMetric struct { - // One or more metric data queries to provide the data points for a scaling metric. - // Use multiple metric data queries only if you are performing a math expression on - // returned data. + // One or more metric data queries to provide the data points for a scaling + // metric. Use multiple metric data queries only if you are performing a math + // expression on returned data. // // This member is required. MetricDataQueries []MetricDataQuery @@ -2090,43 +1840,34 @@ type PredictiveScalingCustomizedScalingMetric struct { // policy. You choose the metric pair, and the policy automatically knows the // correct sum and average statistics to use for the load metric and the scaling // metric. Example +// - You create a predictive scaling policy and specify ALBRequestCount as the +// value for the metric pair and 1000.0 as the target value. For this type of +// metric, you must provide the metric dimension for the corresponding target +// group, so you also provide a resource label for the Application Load Balancer +// target group that is attached to your Auto Scaling group. +// - The number of requests the target group receives per minute provides the +// load metric, and the request count averaged between the members of the target +// group provides the scaling metric. In CloudWatch, this refers to the +// RequestCount and RequestCountPerTarget metrics, respectively. +// - For optimal use of predictive scaling, you adhere to the best practice of +// using a dynamic scaling policy to automatically scale between the minimum +// capacity and maximum capacity in response to real-time changes in resource +// utilization. +// - Amazon EC2 Auto Scaling consumes data points for the load metric over the +// last 14 days and creates an hourly load forecast for predictive scaling. (A +// minimum of 24 hours of data is required.) +// - After creating the load forecast, Amazon EC2 Auto Scaling determines when +// to reduce or increase the capacity of your Auto Scaling group in each hour of +// the forecast period so that the average number of requests received by each +// instance is as close to 1000 requests per minute as possible at all times. // -// * You create a predictive scaling policy and specify -// ALBRequestCount as the value for the metric pair and 1000.0 as the target value. -// For this type of metric, you must provide the metric dimension for the -// corresponding target group, so you also provide a resource label for the -// Application Load Balancer target group that is attached to your Auto Scaling -// group. -// -// * The number of requests the target group receives per minute provides -// the load metric, and the request count averaged between the members of the -// target group provides the scaling metric. In CloudWatch, this refers to the -// RequestCount and RequestCountPerTarget metrics, respectively. -// -// * For optimal use -// of predictive scaling, you adhere to the best practice of using a dynamic -// scaling policy to automatically scale between the minimum capacity and maximum -// capacity in response to real-time changes in resource utilization. -// -// * Amazon EC2 -// Auto Scaling consumes data points for the load metric over the last 14 days and -// creates an hourly load forecast for predictive scaling. (A minimum of 24 hours -// of data is required.) -// -// * After creating the load forecast, Amazon EC2 Auto -// Scaling determines when to reduce or increase the capacity of your Auto Scaling -// group in each hour of the forecast period so that the average number of requests -// received by each instance is as close to 1000 requests per minute as possible at -// all times. -// -// For information about using custom metrics with predictive scaling, -// see Advanced predictive scaling policy configurations using custom metrics -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) +// For information about using custom metrics with predictive scaling, see +// Advanced predictive scaling policy configurations using custom metrics (https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) // in the Amazon EC2 Auto Scaling User Guide. type PredictiveScalingMetricSpecification struct { - // Specifies the target utilization. Some metrics are based on a count instead of a - // percentage, such as the request count for an Application Load Balancer or the + // Specifies the target utilization. Some metrics are based on a count instead of + // a percentage, such as the request count for an Application Load Balancer or the // number of messages in an SQS queue. If the scaling policy specifies one of these // metrics, specify the target utilization as the optimal average request or // message count per instance during any one-minute interval. @@ -2157,7 +1898,7 @@ type PredictiveScalingMetricSpecification struct { } // Describes a load metric for a predictive scaling policy. When returned in the -// output of DescribePolicies, it indicates that a predictive scaling policy uses +// output of DescribePolicies , it indicates that a predictive scaling policy uses // individually specified load and scaling metrics instead of a metric pair. type PredictiveScalingPredefinedLoadMetric struct { @@ -2173,20 +1914,13 @@ type PredictiveScalingPredefinedLoadMetric struct { // portion of the load balancer ARN and the final portion of the target group ARN // into a single value, separated by a forward slash (/). The format of the // resource label is: - // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. + // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff . // Where: - // - // * app// is the final portion of the load balancer ARN - // - // * targetgroup// - // is the final portion of the target group ARN. - // - // To find the ARN for an - // Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string @@ -2198,7 +1932,7 @@ type PredictiveScalingPredefinedMetricPair struct { // Indicates which metrics to use. There are two different types of metrics for // each metric type: one is a load metric and one is a scaling metric. For example, - // if the metric type is ASGCPUUtilization, the Auto Scaling group's total CPU + // if the metric type is ASGCPUUtilization , the Auto Scaling group's total CPU // metric is used as the load metric, and the average CPU metric is used for the // scaling metric. // @@ -2212,29 +1946,22 @@ type PredictiveScalingPredefinedMetricPair struct { // appending the final portion of the load balancer ARN and the final portion of // the target group ARN into a single value, separated by a forward slash (/). The // format of the resource label is: - // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. + // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff . // Where: - // - // * app// is the final portion of the load balancer ARN - // - // * targetgroup// - // is the final portion of the target group ARN. - // - // To find the ARN for an - // Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string noSmithyDocumentSerde } -// Describes a scaling metric for a predictive scaling policy. When returned in the -// output of DescribePolicies, it indicates that a predictive scaling policy uses -// individually specified load and scaling metrics instead of a metric pair. +// Describes a scaling metric for a predictive scaling policy. When returned in +// the output of DescribePolicies , it indicates that a predictive scaling policy +// uses individually specified load and scaling metrics instead of a metric pair. type PredictiveScalingPredefinedScalingMetric struct { // The metric type. @@ -2249,52 +1976,33 @@ type PredictiveScalingPredefinedScalingMetric struct { // the final portion of the load balancer ARN and the final portion of the target // group ARN into a single value, separated by a forward slash (/). The format of // the resource label is: - // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. + // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff . // Where: - // - // * app// is the final portion of the load balancer ARN - // - // * targetgroup// - // is the final portion of the target group ARN. - // - // To find the ARN for an - // Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string noSmithyDocumentSerde } -// Describes a process type. For more information, see Scaling processes -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) +// Describes a process type. For more information, see Scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) // in the Amazon EC2 Auto Scaling User Guide. type ProcessType struct { // One of the following processes: - // - // * Launch - // - // * Terminate - // - // * AddToLoadBalancer - // - // * - // AlarmNotification - // - // * AZRebalance - // - // * HealthCheck - // - // * InstanceRefresh - // - // * - // ReplaceUnhealthy - // - // * ScheduledActions + // - Launch + // - Terminate + // - AddToLoadBalancer + // - AlarmNotification + // - AZRebalance + // - HealthCheck + // - InstanceRefresh + // - ReplaceUnhealthy + // - ScheduledActions // // This member is required. ProcessName *string @@ -2305,43 +2013,38 @@ type ProcessType struct { // Describes the preferences for an instance refresh. type RefreshPreferences struct { - // (Optional) Indicates whether to roll back the Auto Scaling group to its previous - // configuration if the instance refresh fails. The default is false. A rollback is - // not supported in the following situations: - // - // * There is no desired configuration - // specified for the instance refresh. - // - // * The Auto Scaling group has a launch - // template that uses an Amazon Web Services Systems Manager parameter instead of - // an AMI ID for the ImageId property. - // - // * The Auto Scaling group uses the launch - // template's $Latest or $Default version. + // (Optional) Indicates whether to roll back the Auto Scaling group to its + // previous configuration if the instance refresh fails. The default is false . A + // rollback is not supported in the following situations: + // - There is no desired configuration specified for the instance refresh. + // - The Auto Scaling group has a launch template that uses an Amazon Web + // Services Systems Manager parameter instead of an AMI ID for the ImageId + // property. + // - The Auto Scaling group uses the launch template's $Latest or $Default + // version. AutoRollback *bool // (Optional) The amount of time, in seconds, to wait after a checkpoint before // continuing. This property is optional, but if you specify a value for it, you - // must also specify a value for CheckpointPercentages. If you specify a value for - // CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults - // to 3600 (1 hour). + // must also specify a value for CheckpointPercentages . If you specify a value for + // CheckpointPercentages and not for CheckpointDelay , the CheckpointDelay + // defaults to 3600 (1 hour). CheckpointDelay *int32 // (Optional) Threshold values for each checkpoint in ascending order. Each number // must be unique. To replace all instances in the Auto Scaling group, the last - // number in the array must be 100. For usage examples, see Adding checkpoints to - // an instance refresh - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html) + // number in the array must be 100 . For usage examples, see Adding checkpoints to + // an instance refresh (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html) // in the Amazon EC2 Auto Scaling User Guide. CheckpointPercentages []int32 // A time period, in seconds, during which an instance refresh waits before moving // on to replacing the next instance after a new instance enters the InService // state. This property is not required for normal usage. Instead, use the - // DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup and - // DefaultInstanceWarmup properties work the same way. Only specify this property - // if you must override the DefaultInstanceWarmup property. If you do not specify - // this property, the instance warmup by default is the value of the + // DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup + // and DefaultInstanceWarmup properties work the same way. Only specify this + // property if you must override the DefaultInstanceWarmup property. If you do not + // specify this property, the instance warmup by default is the value of the // DefaultInstanceWarmup property, if defined (which is recommended in all cases), // or the HealthCheckGracePeriod property otherwise. InstanceWarmup *int32 @@ -2349,7 +2052,7 @@ type RefreshPreferences struct { // The amount of capacity in the Auto Scaling group that must pass your group's // health checks to allow the operation to continue. The value is expressed as a // percentage of the desired capacity of the Auto Scaling group (rounded up to the - // nearest integer). The default is 90. Setting the minimum healthy percentage to + // nearest integer). The default is 90 . Setting the minimum healthy percentage to // 100 percent limits the rate of replacement to one instance at a time. In // contrast, setting it to 0 percent has the effect of replacing all instances at // the same time. @@ -2364,20 +2067,19 @@ type RefreshPreferences struct { // Otherwise, the instance refresh will fail. ScaleInProtectedInstances ScaleInProtectedInstances - // (Optional) Indicates whether skip matching is enabled. If enabled (true), then + // (Optional) Indicates whether skip matching is enabled. If enabled ( true ), then // Amazon EC2 Auto Scaling skips replacing instances that match the desired // configuration. If no desired configuration is specified, then it skips replacing // instances that have the same launch template and instance types that the Auto // Scaling group was using before the start of the instance refresh. The default is - // false. For more information, see Use an instance refresh with skip matching - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html) + // false . For more information, see Use an instance refresh with skip matching (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html) // in the Amazon EC2 Auto Scaling User Guide. SkipMatching *bool - // Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in - // Standby state are found. The following lists the valid values: Terminate Amazon - // EC2 Auto Scaling terminates instances that are in Standby. Ignore Amazon EC2 - // Auto Scaling ignores instances that are in Standby and continues to replace + // Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances + // in Standby state are found. The following lists the valid values: Terminate + // Amazon EC2 Auto Scaling terminates instances that are in Standby . Ignore Amazon + // EC2 Auto Scaling ignores instances that are in Standby and continues to replace // instances that are in the InService state. Wait (default) Amazon EC2 Auto // Scaling waits one hour for you to return the instances to service. Otherwise, // the instance refresh will fail. @@ -2395,8 +2097,8 @@ type RollbackDetails struct { // Indicates the value of PercentageComplete at the time the rollback started. PercentageCompleteOnRollback *int32 - // Reports progress on replacing instances in an Auto Scaling group that has a warm - // pool. This includes separate details for instances in the warm pool and + // Reports progress on replacing instances in an Auto Scaling group that has a + // warm pool. This includes separate details for instances in the warm pool and // instances in the Auto Scaling group (the live pool). ProgressDetailsOnRollback *InstanceRefreshProgressDetails @@ -2414,8 +2116,8 @@ type RollbackDetails struct { type ScalingPolicy struct { // Specifies how the scaling adjustment is interpreted (for example, an absolute - // number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, - // and PercentChangeInCapacity. + // number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , + // and PercentChangeInCapacity . AdjustmentType *string // The CloudWatch alarms related to the policy. @@ -2427,19 +2129,19 @@ type ScalingPolicy struct { // The duration of the policy's cooldown period, in seconds. Cooldown *int32 - // Indicates whether the policy is enabled (true) or disabled (false). + // Indicates whether the policy is enabled ( true ) or disabled ( false ). Enabled *bool // The estimated time, in seconds, until a newly launched instance can contribute // to the CloudWatch metrics. EstimatedInstanceWarmup *int32 - // The aggregation type for the CloudWatch metrics. The valid values are Minimum, - // Maximum, and Average. + // The aggregation type for the CloudWatch metrics. The valid values are Minimum , + // Maximum , and Average . MetricAggregationType *string // The minimum value to scale by when the adjustment type is - // PercentChangeInCapacity. + // PercentChangeInCapacity . MinAdjustmentMagnitude *int32 // Available for backward compatibility. Use MinAdjustmentMagnitude instead. @@ -2454,30 +2156,21 @@ type ScalingPolicy struct { PolicyName *string // One of the following policy types: - // - // * TargetTrackingScaling - // - // * StepScaling - // - // * - // SimpleScaling (default) - // - // * PredictiveScaling - // - // For more information, see Target - // tracking scaling policies - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) - // and Step and simple scaling policies - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) + // - TargetTrackingScaling + // - StepScaling + // - SimpleScaling (default) + // - PredictiveScaling + // For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html) + // and Step and simple scaling policies (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) // in the Amazon EC2 Auto Scaling User Guide. PolicyType *string // A predictive scaling policy. PredictiveScalingConfiguration *PredictiveScalingConfiguration - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. + // The amount by which to scale, based on the specified adjustment type. A + // positive value adds to the current capacity while a negative number removes from + // the current capacity. ScalingAdjustment *int32 // A set of adjustments that enable you to scale based on the size of the alarm @@ -2496,12 +2189,12 @@ type ScheduledUpdateGroupAction struct { // The name of the Auto Scaling group. AutoScalingGroupName *string - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. + // The desired capacity is the initial capacity of the Auto Scaling group after + // the scheduled action runs and the capacity it attempts to maintain. DesiredCapacity *int32 // The date and time in UTC for the recurring schedule to end. For example, - // "2019-06-01T00:00:00Z". + // "2019-06-01T00:00:00Z" . EndTime *time.Time // The maximum size of the Auto Scaling group. @@ -2511,8 +2204,8 @@ type ScheduledUpdateGroupAction struct { MinSize *int32 // The recurring schedule for the action, in Unix cron syntax format. When - // StartTime and EndTime are specified with Recurrence, they form the boundaries of - // when the recurring action starts and stops. + // StartTime and EndTime are specified with Recurrence , they form the boundaries + // of when the recurring action starts and stops. Recurrence *string // The Amazon Resource Name (ARN) of the scheduled action. @@ -2522,7 +2215,7 @@ type ScheduledUpdateGroupAction struct { ScheduledActionName *string // The date and time in UTC for this action to start. For example, - // "2019-06-01T00:00:00Z". + // "2019-06-01T00:00:00Z" . StartTime *time.Time // This property is no longer used. @@ -2534,8 +2227,8 @@ type ScheduledUpdateGroupAction struct { noSmithyDocumentSerde } -// Describes information used for one or more scheduled scaling action updates in a -// BatchPutScheduledUpdateGroupAction operation. +// Describes information used for one or more scheduled scaling action updates in +// a BatchPutScheduledUpdateGroupAction operation. type ScheduledUpdateGroupActionRequest struct { // The name of the scaling action. @@ -2543,8 +2236,8 @@ type ScheduledUpdateGroupActionRequest struct { // This member is required. ScheduledActionName *string - // The desired capacity is the initial capacity of the Auto Scaling group after the - // scheduled action runs and the capacity it attempts to maintain. + // The desired capacity is the initial capacity of the Auto Scaling group after + // the scheduled action runs and the capacity it attempts to maintain. DesiredCapacity *int32 // The date and time for the recurring schedule to end, in UTC. @@ -2559,26 +2252,26 @@ type ScheduledUpdateGroupActionRequest struct { // The recurring schedule for the action, in Unix cron syntax format. This format // consists of five fields separated by white spaces: [Minute] [Hour] // [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for - // example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab - // (http://crontab.org). When StartTime and EndTime are specified with Recurrence, - // they form the boundaries of when the recurring action starts and stops. Cron - // expressions use Universal Coordinated Time (UTC) by default. + // example, "30 0 1 1,6,12 *" ). For more information about this format, see + // Crontab (http://crontab.org) . When StartTime and EndTime are specified with + // Recurrence , they form the boundaries of when the recurring action starts and + // stops. Cron expressions use Universal Coordinated Time (UTC) by default. Recurrence *string // The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in - // UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify - // Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this - // time, and then performs the action based on the specified recurrence. If you try - // to schedule the action in the past, Amazon EC2 Auto Scaling returns an error - // message. + // UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z" ). If you + // specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action + // at this time, and then performs the action based on the specified recurrence. If + // you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an + // error message. StartTime *time.Time // Specifies the time zone for a cron expression. If a time zone is not provided, // UTC is used by default. Valid values are the canonical names of the IANA time // zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or - // Pacific/Tahiti). For more information, see - // https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - // (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + // Pacific/Tahiti ). For more information, see + // https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + // . TimeZone *string noSmithyDocumentSerde @@ -2587,41 +2280,29 @@ type ScheduledUpdateGroupActionRequest struct { // Describes information used to create a step adjustment for a step scaling // policy. For the following examples, suppose that you have an alarm with a breach // threshold of 50: -// -// * To trigger the adjustment when the metric is greater than or -// equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of -// 10. -// -// * To trigger the adjustment when the metric is greater than 40 and less -// than or equal to 50, specify a lower bound of -10 and an upper bound of -// 0. +// - To trigger the adjustment when the metric is greater than or equal to 50 +// and less than 60, specify a lower bound of 0 and an upper bound of 10. +// - To trigger the adjustment when the metric is greater than 40 and less than +// or equal to 50, specify a lower bound of -10 and an upper bound of 0. // // There are a few rules for the step adjustments for your step policy: +// - The ranges of your step adjustments can't overlap or have a gap. +// - At most, one step adjustment can have a null lower bound. If one step +// adjustment has a negative lower bound, then there must be a step adjustment with +// a null lower bound. +// - At most, one step adjustment can have a null upper bound. If one step +// adjustment has a positive upper bound, then there must be a step adjustment with +// a null upper bound. +// - The upper and lower bound can't be null in the same step adjustment. // -// * The -// ranges of your step adjustments can't overlap or have a gap. -// -// * At most, one -// step adjustment can have a null lower bound. If one step adjustment has a -// negative lower bound, then there must be a step adjustment with a null lower -// bound. -// -// * At most, one step adjustment can have a null upper bound. If one step -// adjustment has a positive upper bound, then there must be a step adjustment with -// a null upper bound. -// -// * The upper and lower bound can't be null in the same step -// adjustment. -// -// For more information, see Step adjustments -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) +// For more information, see Step adjustments (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) // in the Amazon EC2 Auto Scaling User Guide. type StepAdjustment struct { - // The amount by which to scale, based on the specified adjustment type. A positive - // value adds to the current capacity while a negative number removes from the - // current capacity. The amount by which to scale. The adjustment is based on the - // value that you specified in the AdjustmentType property (either an absolute + // The amount by which to scale, based on the specified adjustment type. A + // positive value adds to the current capacity while a negative number removes from + // the current capacity. The amount by which to scale. The adjustment is based on + // the value that you specified in the AdjustmentType property (either an absolute // number or a percentage). A positive value adds to the current capacity and a // negative number subtracts from the current capacity. // @@ -2647,9 +2328,8 @@ type StepAdjustment struct { noSmithyDocumentSerde } -// Describes an auto scaling process that has been suspended. For more information, -// see Scaling processes -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) +// Describes an auto scaling process that has been suspended. For more +// information, see Scaling processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types) // in the Amazon EC2 Auto Scaling User Guide. type SuspendedProcess struct { @@ -2670,14 +2350,14 @@ type Tag struct { // This member is required. Key *string - // Determines whether the tag is added to new instances as they are launched in the - // group. + // Determines whether the tag is added to new instances as they are launched in + // the group. PropagateAtLaunch *bool // The name of the Auto Scaling group. ResourceId *string - // The type of resource. The only supported value is auto-scaling-group. + // The type of resource. The only supported value is auto-scaling-group . ResourceType *string // The tag value. @@ -2692,14 +2372,14 @@ type TagDescription struct { // The tag key. Key *string - // Determines whether the tag is added to new instances as they are launched in the - // group. + // Determines whether the tag is added to new instances as they are launched in + // the group. PropagateAtLaunch *bool // The name of the group. ResourceId *string - // The type of resource. The only supported value is auto-scaling-group. + // The type of resource. The only supported value is auto-scaling-group . ResourceType *string // The tag value. @@ -2708,8 +2388,8 @@ type TagDescription struct { noSmithyDocumentSerde } -// Represents a target tracking scaling policy configuration to use with Amazon EC2 -// Auto Scaling. +// Represents a target tracking scaling policy configuration to use with Amazon +// EC2 Auto Scaling. type TargetTrackingConfiguration struct { // The target value for the metric. Some metrics are based on a count instead of a @@ -2721,18 +2401,18 @@ type TargetTrackingConfiguration struct { // This member is required. TargetValue *float64 - // A customized metric. You must specify either a predefined metric or a customized - // metric. + // A customized metric. You must specify either a predefined metric or a + // customized metric. CustomizedMetricSpecification *CustomizedMetricSpecification // Indicates whether scaling in by the target tracking scaling policy is disabled. // If scaling in is disabled, the target tracking scaling policy doesn't remove // instances from the Auto Scaling group. Otherwise, the target tracking scaling - // policy can remove instances from the Auto Scaling group. The default is false. + // policy can remove instances from the Auto Scaling group. The default is false . DisableScaleIn *bool - // A predefined metric. You must specify either a predefined metric or a customized - // metric. + // A predefined metric. You must specify either a predefined metric or a + // customized metric. PredefinedMetricSpecification *PredefinedMetricSpecification noSmithyDocumentSerde @@ -2759,7 +2439,7 @@ type TargetTrackingMetricDataQuery struct { // metrics to refer to those metrics, and can also use the Id of other expressions // to use the result of those expressions. Conditional: Within each // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat, but not both. + // MetricStat , but not both. Expression *string // A human-readable label for this metric or expression. This is especially useful @@ -2768,7 +2448,7 @@ type TargetTrackingMetricDataQuery struct { // Information about the metric data to return. Conditional: Within each // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat, but not both. + // MetricStat , but not both. MetricStat *TargetTrackingMetricStat // Indicates whether to return the timestamps and raw data values of this metric. @@ -2776,17 +2456,16 @@ type TargetTrackingMetricDataQuery struct { // math expression that the metric specification is based on. You must specify // false for ReturnData for all the other metrics and expressions used in the // metric specification. If you are only retrieving metrics and not performing any - // math expressions, do not specify anything for ReturnData. This sets it to its - // default (true). + // math expressions, do not specify anything for ReturnData . This sets it to its + // default ( true ). ReturnData *bool noSmithyDocumentSerde } -// This structure defines the CloudWatch metric to return, along with the statistic -// and unit. For more information about the CloudWatch terminology below, see -// Amazon CloudWatch concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// This structure defines the CloudWatch metric to return, along with the +// statistic and unit. For more information about the CloudWatch terminology below, +// see Amazon CloudWatch concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. type TargetTrackingMetricStat struct { @@ -2796,17 +2475,15 @@ type TargetTrackingMetricStat struct { Metric *Metric // The statistic to return. It can include any CloudWatch statistic or extended - // statistic. For a list of valid values, see the table in Statistics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) + // statistic. For a list of valid values, see the table in Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) // in the Amazon CloudWatch User Guide. The most commonly used metric for scaling - // is Average. + // is Average . // // This member is required. Stat *string // The unit to use for the returned data points. For a complete list of the units - // that CloudWatch supports, see the MetricDatum - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // that CloudWatch supports, see the MetricDatum (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) // data type in the Amazon CloudWatch API Reference. Unit *string @@ -2834,45 +2511,29 @@ type TrafficSourceIdentifier struct { // Resource Name (ARN) for a target group in this account and Region. For Classic // Load Balancers, this will be the name of the Classic Load Balancer in this // account and Region. For example: - // - // * Application Load Balancer ARN: - // arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456 - // - // * - // Classic Load Balancer name: my-classic-load-balancer - // - // * VPC Lattice ARN: - // arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456 - // - // To - // get the ARN of a target group for a Application Load Balancer, Gateway Load + // - Application Load Balancer ARN: + // arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456 + // - Classic Load Balancer name: my-classic-load-balancer + // - VPC Lattice ARN: + // arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456 + // To get the ARN of a target group for a Application Load Balancer, Gateway Load // Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use - // the Elastic Load Balancing DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // and DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // the Elastic Load Balancing DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // and DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operations. To get the ARN of a target group for VPC Lattice, use the VPC - // Lattice GetTargetGroup - // (https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html) + // Lattice GetTargetGroup (https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html) // API operation. // // This member is required. Identifier *string - // Provides additional context for the value of Identifier. The following lists the - // valid values: - // - // * elb if Identifier is the name of a Classic Load Balancer. - // - // * - // elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load - // Balancer, or Network Load Balancer target group. - // - // * vpc-lattice if Identifier is - // the ARN of a VPC Lattice target group. - // - // Required if the identifier is the name - // of a Classic Load Balancer. + // Provides additional context for the value of Identifier . The following lists + // the valid values: + // - elb if Identifier is the name of a Classic Load Balancer. + // - elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load + // Balancer, or Network Load Balancer target group. + // - vpc-lattice if Identifier is the ARN of a VPC Lattice target group. + // Required if the identifier is the name of a Classic Load Balancer. Type *string noSmithyDocumentSerde @@ -2886,47 +2547,33 @@ type TrafficSourceState struct { // Describes the current state of a traffic source. The state values are as // follows: - // - // * Adding - The Auto Scaling instances are being registered with the - // load balancer or target group. - // - // * Added - All Auto Scaling instances are - // registered with the load balancer or target group. - // - // * InService - For an Elastic - // Load Balancing load balancer or target group, at least one Auto Scaling instance - // passed an ELB health check. For VPC Lattice, at least one Auto Scaling instance - // passed an VPC_LATTICE health check. - // - // * Removing - The Auto Scaling instances are - // being deregistered from the load balancer or target group. If connection - // draining (deregistration delay) is enabled, Elastic Load Balancing or VPC - // Lattice waits for in-flight requests to complete before deregistering the - // instances. - // - // * Removed - All Auto Scaling instances are deregistered from the - // load balancer or target group. + // - Adding - The Auto Scaling instances are being registered with the load + // balancer or target group. + // - Added - All Auto Scaling instances are registered with the load balancer or + // target group. + // - InService - For an Elastic Load Balancing load balancer or target group, at + // least one Auto Scaling instance passed an ELB health check. For VPC Lattice, + // at least one Auto Scaling instance passed an VPC_LATTICE health check. + // - Removing - The Auto Scaling instances are being deregistered from the load + // balancer or target group. If connection draining (deregistration delay) is + // enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to + // complete before deregistering the instances. + // - Removed - All Auto Scaling instances are deregistered from the load balancer + // or target group. State *string - // This is replaced by Identifier. + // This is replaced by Identifier . // // Deprecated: TrafficSource has been replaced by Identifier TrafficSource *string - // Provides additional context for the value of Identifier. The following lists the - // valid values: - // - // * elb if Identifier is the name of a Classic Load Balancer. - // - // * - // elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load - // Balancer, or Network Load Balancer target group. - // - // * vpc-lattice if Identifier is - // the ARN of a VPC Lattice target group. - // - // Required if the identifier is the name - // of a Classic Load Balancer. + // Provides additional context for the value of Identifier . The following lists + // the valid values: + // - elb if Identifier is the name of a Classic Load Balancer. + // - elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load + // Balancer, or Network Load Balancer target group. + // - vpc-lattice if Identifier is the ARN of a VPC Lattice target group. + // Required if the identifier is the name of a Classic Load Balancer. Type *string noSmithyDocumentSerde diff --git a/service/autoscalingplans/api_client.go b/service/autoscalingplans/api_client.go index 35c03bf38f7..a2488176401 100644 --- a/service/autoscalingplans/api_client.go +++ b/service/autoscalingplans/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/autoscalingplans/api_op_CreateScalingPlan.go b/service/autoscalingplans/api_op_CreateScalingPlan.go index dee3f9bc961..6822961e427 100644 --- a/service/autoscalingplans/api_op_CreateScalingPlan.go +++ b/service/autoscalingplans/api_op_CreateScalingPlan.go @@ -30,15 +30,13 @@ func (c *Client) CreateScalingPlan(ctx context.Context, params *CreateScalingPla type CreateScalingPlanInput struct { // A CloudFormation stack or set of tags. You can create one scaling plan per - // application source. For more information, see ApplicationSource - // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) + // application source. For more information, see ApplicationSource (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) // in the AWS Auto Scaling API Reference. // // This member is required. ApplicationSource *types.ApplicationSource - // The scaling instructions. For more information, see ScalingInstruction - // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) + // The scaling instructions. For more information, see ScalingInstruction (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) // in the AWS Auto Scaling API Reference. // // This member is required. @@ -55,7 +53,7 @@ type CreateScalingPlanInput struct { type CreateScalingPlanOutput struct { - // The version number of the scaling plan. This value is always 1. Currently, you + // The version number of the scaling plan. This value is always 1 . Currently, you // cannot have multiple scaling plan versions. // // This member is required. diff --git a/service/autoscalingplans/api_op_DeleteScalingPlan.go b/service/autoscalingplans/api_op_DeleteScalingPlan.go index ddfd1264388..a67d30d7d94 100644 --- a/service/autoscalingplans/api_op_DeleteScalingPlan.go +++ b/service/autoscalingplans/api_op_DeleteScalingPlan.go @@ -11,9 +11,9 @@ import ( ) // Deletes the specified scaling plan. Deleting a scaling plan deletes the -// underlying ScalingInstruction for all of the scalable resources that are covered -// by the plan. If the plan has launched resources or has scaling activities in -// progress, you must delete those resources separately. +// underlying ScalingInstruction for all of the scalable resources that are +// covered by the plan. If the plan has launched resources or has scaling +// activities in progress, you must delete those resources separately. func (c *Client) DeleteScalingPlan(ctx context.Context, params *DeleteScalingPlanInput, optFns ...func(*Options)) (*DeleteScalingPlanOutput, error) { if params == nil { params = &DeleteScalingPlanInput{} @@ -36,7 +36,7 @@ type DeleteScalingPlanInput struct { // This member is required. ScalingPlanName *string - // The version number of the scaling plan. Currently, the only valid value is 1. + // The version number of the scaling plan. Currently, the only valid value is 1 . // // This member is required. ScalingPlanVersion *int64 diff --git a/service/autoscalingplans/api_op_DescribeScalingPlanResources.go b/service/autoscalingplans/api_op_DescribeScalingPlanResources.go index d6f9efb0f65..a6333e5d359 100644 --- a/service/autoscalingplans/api_op_DescribeScalingPlanResources.go +++ b/service/autoscalingplans/api_op_DescribeScalingPlanResources.go @@ -34,7 +34,7 @@ type DescribeScalingPlanResourcesInput struct { // This member is required. ScalingPlanName *string - // The version number of the scaling plan. Currently, the only valid value is 1. + // The version number of the scaling plan. Currently, the only valid value is 1 . // // This member is required. ScalingPlanVersion *int64 diff --git a/service/autoscalingplans/api_op_DescribeScalingPlans.go b/service/autoscalingplans/api_op_DescribeScalingPlans.go index 7d1d6a53424..023ea506d53 100644 --- a/service/autoscalingplans/api_op_DescribeScalingPlans.go +++ b/service/autoscalingplans/api_op_DescribeScalingPlans.go @@ -44,8 +44,9 @@ type DescribeScalingPlansInput struct { // you cannot specify scaling plan names. ScalingPlanNames []string - // The version number of the scaling plan. Currently, the only valid value is 1. If - // you specify a scaling plan version, you must also specify a scaling plan name. + // The version number of the scaling plan. Currently, the only valid value is 1 . + // If you specify a scaling plan version, you must also specify a scaling plan + // name. ScalingPlanVersion *int64 noSmithyDocumentSerde diff --git a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go index 783590e68ac..4c7d46e86cc 100644 --- a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go +++ b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go @@ -43,33 +43,27 @@ type GetScalingPlanResourceForecastDataInput struct { EndTime *time.Time // The type of forecast data to get. - // - // * LoadForecast: The load metric forecast. - // - // * - // CapacityForecast: The capacity forecast. - // - // * ScheduledActionMinCapacity: The - // minimum capacity for each scheduled scaling action. This data is calculated as - // the larger of two values: the capacity forecast or the minimum capacity in the - // scaling instruction. - // - // * ScheduledActionMaxCapacity: The maximum capacity for - // each scheduled scaling action. The calculation used is determined by the - // predictive scaling maximum capacity behavior setting in the scaling instruction. + // - LoadForecast : The load metric forecast. + // - CapacityForecast : The capacity forecast. + // - ScheduledActionMinCapacity : The minimum capacity for each scheduled scaling + // action. This data is calculated as the larger of two values: the capacity + // forecast or the minimum capacity in the scaling instruction. + // - ScheduledActionMaxCapacity : The maximum capacity for each scheduled scaling + // action. The calculation used is determined by the predictive scaling maximum + // capacity behavior setting in the scaling instruction. // // This member is required. ForecastDataType types.ForecastDataType - // The ID of the resource. This string consists of a prefix (autoScalingGroup) - // followed by the name of a specified Auto Scaling group (my-asg). Example: - // autoScalingGroup/my-asg. + // The ID of the resource. This string consists of a prefix ( autoScalingGroup ) + // followed by the name of a specified Auto Scaling group ( my-asg ). Example: + // autoScalingGroup/my-asg . // // This member is required. ResourceId *string // The scalable dimension for the resource. The only valid value is - // autoscaling:autoScalingGroup:DesiredCapacity. + // autoscaling:autoScalingGroup:DesiredCapacity . // // This member is required. ScalableDimension types.ScalableDimension @@ -79,12 +73,12 @@ type GetScalingPlanResourceForecastDataInput struct { // This member is required. ScalingPlanName *string - // The version number of the scaling plan. Currently, the only valid value is 1. + // The version number of the scaling plan. Currently, the only valid value is 1 . // // This member is required. ScalingPlanVersion *int64 - // The namespace of the AWS service. The only valid value is autoscaling. + // The namespace of the AWS service. The only valid value is autoscaling . // // This member is required. ServiceNamespace types.ServiceNamespace diff --git a/service/autoscalingplans/api_op_UpdateScalingPlan.go b/service/autoscalingplans/api_op_UpdateScalingPlan.go index ca757c93a3c..144748ed209 100644 --- a/service/autoscalingplans/api_op_UpdateScalingPlan.go +++ b/service/autoscalingplans/api_op_UpdateScalingPlan.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified scaling plan. You cannot update a scaling plan if it is in -// the process of being created, updated, or deleted. +// Updates the specified scaling plan. You cannot update a scaling plan if it is +// in the process of being created, updated, or deleted. func (c *Client) UpdateScalingPlan(ctx context.Context, params *UpdateScalingPlanInput, optFns ...func(*Options)) (*UpdateScalingPlanOutput, error) { if params == nil { params = &UpdateScalingPlanInput{} @@ -35,20 +35,18 @@ type UpdateScalingPlanInput struct { // This member is required. ScalingPlanName *string - // The version number of the scaling plan. The only valid value is 1. Currently, + // The version number of the scaling plan. The only valid value is 1 . Currently, // you cannot have multiple scaling plan versions. // // This member is required. ScalingPlanVersion *int64 // A CloudFormation stack or set of tags. For more information, see - // ApplicationSource - // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) + // ApplicationSource (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) // in the AWS Auto Scaling API Reference. ApplicationSource *types.ApplicationSource - // The scaling instructions. For more information, see ScalingInstruction - // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) + // The scaling instructions. For more information, see ScalingInstruction (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) // in the AWS Auto Scaling API Reference. ScalingInstructions []types.ScalingInstruction diff --git a/service/autoscalingplans/doc.go b/service/autoscalingplans/doc.go index f555d3f149e..d95b09f3d4e 100644 --- a/service/autoscalingplans/doc.go +++ b/service/autoscalingplans/doc.go @@ -6,27 +6,18 @@ // AWS Auto Scaling Use AWS Auto Scaling to create scaling plans for your // applications to automatically scale your scalable AWS resources. API Summary You // can use the AWS Auto Scaling service API to accomplish the following tasks: -// -// * -// Create and manage scaling plans -// -// * Define target tracking scaling policies to -// dynamically scale your resources based on utilization -// -// * Scale Amazon EC2 Auto -// Scaling groups using predictive scaling and dynamic scaling to scale your Amazon -// EC2 capacity faster -// -// * Set minimum and maximum capacity limits -// -// * Retrieve -// information on existing scaling plans -// -// * Access current forecast data and -// historical forecast data for up to 56 days previous -// -// To learn more about AWS -// Auto Scaling, including information about granting IAM users required -// permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide -// (https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html). +// - Create and manage scaling plans +// - Define target tracking scaling policies to dynamically scale your resources +// based on utilization +// - Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic +// scaling to scale your Amazon EC2 capacity faster +// - Set minimum and maximum capacity limits +// - Retrieve information on existing scaling plans +// - Access current forecast data and historical forecast data for up to 56 days +// previous +// +// To learn more about AWS Auto Scaling, including information about granting IAM +// users required permissions for AWS Auto Scaling actions, see the AWS Auto +// Scaling User Guide (https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html) +// . package autoscalingplans diff --git a/service/autoscalingplans/types/enums.go b/service/autoscalingplans/types/enums.go index ab9e8351bf7..a9db0ac6e48 100644 --- a/service/autoscalingplans/types/enums.go +++ b/service/autoscalingplans/types/enums.go @@ -115,8 +115,8 @@ const ( PredictiveScalingModeForecastOnly PredictiveScalingMode = "ForecastOnly" ) -// Values returns all known values for PredictiveScalingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PredictiveScalingMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PredictiveScalingMode) Values() []PredictiveScalingMode { return []PredictiveScalingMode{ @@ -209,8 +209,8 @@ const ( ScalingPlanStatusCodeUpdateFailed ScalingPlanStatusCode = "UpdateFailed" ) -// Values returns all known values for ScalingPlanStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ScalingPlanStatusCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ScalingPlanStatusCode) Values() []ScalingPlanStatusCode { return []ScalingPlanStatusCode{ diff --git a/service/autoscalingplans/types/errors.go b/service/autoscalingplans/types/errors.go index 27b70e81a5a..ba3f81d96d1 100644 --- a/service/autoscalingplans/types/errors.go +++ b/service/autoscalingplans/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// Concurrent updates caused an exception, for example, if you request an update to -// a scaling plan that already has a pending update. +// Concurrent updates caused an exception, for example, if you request an update +// to a scaling plan that already has a pending update. type ConcurrentUpdateException struct { Message *string diff --git a/service/autoscalingplans/types/types.go b/service/autoscalingplans/types/types.go index 100b9921b7e..714bc689320 100644 --- a/service/autoscalingplans/types/types.go +++ b/service/autoscalingplans/types/types.go @@ -29,19 +29,17 @@ type ApplicationSource struct { // statistic must represent the average load per capacity unit of the resource. For // example, there is a metric that counts the number of requests processed by your // Auto Scaling group. If the Sum statistic represents the total request count -// processed by the group, then the Average statistic for the specified metric must -// represent the average request count processed by each instance of the group. If -// you publish your own metrics, you can aggregate the data points at a given -// interval and then publish the aggregated data points to CloudWatch. Before AWS -// Auto Scaling generates the forecast, it sums up all the metric data points that -// occurred within each hour to match the granularity period that is used in the -// forecast (60 minutes). For information about terminology, available metrics, or -// how to publish new metrics, see Amazon CloudWatch Concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// processed by the group, then the Average statistic for the specified metric +// must represent the average request count processed by each instance of the +// group. If you publish your own metrics, you can aggregate the data points at a +// given interval and then publish the aggregated data points to CloudWatch. Before +// AWS Auto Scaling generates the forecast, it sums up all the metric data points +// that occurred within each hour to match the granularity period that is used in +// the forecast (60 minutes). For information about terminology, available metrics, +// or how to publish new metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. After creating your scaling plan, you can // use the AWS Auto Scaling console to visualize forecasts for the specified -// metric. For more information, see View Scaling Information for a Resource -// (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) +// metric. For more information, see View Scaling Information for a Resource (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) // in the AWS Auto Scaling User Guide. type CustomizedLoadMetricSpecification struct { @@ -55,7 +53,7 @@ type CustomizedLoadMetricSpecification struct { // This member is required. Namespace *string - // The statistic of the metric. The only valid value is Sum. + // The statistic of the metric. The only valid value is Sum . // // This member is required. Statistic MetricStatistic @@ -74,23 +72,18 @@ type CustomizedLoadMetricSpecification struct { // Represents a CloudWatch metric of your choosing that can be used for dynamic // scaling as part of a target tracking scaling policy. To create your customized // scaling metric specification: +// - Add values for each required parameter from CloudWatch. You can use an +// existing metric, or a new metric that you create. To use your own metric, you +// must first publish the metric to CloudWatch. For more information, see +// Publish Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) +// in the Amazon CloudWatch User Guide. +// - Choose a metric that changes proportionally with capacity. The value of the +// metric should increase or decrease in inverse proportion to the number of +// capacity units. That is, the value of the metric should decrease when capacity +// increases. // -// * Add values for each required parameter from -// CloudWatch. You can use an existing metric, or a new metric that you create. To -// use your own metric, you must first publish the metric to CloudWatch. For more -// information, see Publish Custom Metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) -// in the Amazon CloudWatch User Guide. -// -// * Choose a metric that changes -// proportionally with capacity. The value of the metric should increase or -// decrease in inverse proportion to the number of capacity units. That is, the -// value of the metric should decrease when capacity increases. -// -// For information -// about terminology, available metrics, or how to publish new metrics, see Amazon -// CloudWatch Concepts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// For information about terminology, available metrics, or how to publish new +// metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. type CustomizedScalingMetricSpecification struct { @@ -151,8 +144,7 @@ type MetricDimension struct { // Represents a predefined metric that can be used for predictive scaling. After // creating your scaling plan, you can use the AWS Auto Scaling console to // visualize forecasts for the specified metric. For more information, see View -// Scaling Information for a Resource -// (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) +// Scaling Information for a Resource (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) // in the AWS Auto Scaling User Guide. type PredefinedLoadMetricSpecification struct { @@ -162,33 +154,26 @@ type PredefinedLoadMetricSpecification struct { PredefinedLoadMetricType LoadMetricType // Identifies the resource associated with the metric type. You can't specify a - // resource label unless the metric type is ALBTargetGroupRequestCount and there is - // a target group for an Application Load Balancer attached to the Auto Scaling + // resource label unless the metric type is ALBTargetGroupRequestCount and there + // is a target group for an Application Load Balancer attached to the Auto Scaling // group. You create the resource label by appending the final portion of the load // balancer ARN and the final portion of the target group ARN into a single value, // separated by a forward slash (/). The format is app///targetgroup//, where: - // - // * - // app// is the final portion of the load balancer ARN - // - // * targetgroup// is the - // final portion of the target group ARN. - // + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. // This is an example: // app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. - // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string noSmithyDocumentSerde } -// Represents a predefined metric that can be used for dynamic scaling as part of a -// target tracking scaling policy. +// Represents a predefined metric that can be used for dynamic scaling as part of +// a target tracking scaling policy. type PredefinedScalingMetricSpecification struct { // The metric type. The ALBRequestCountPerTarget metric type applies only to Auto @@ -198,26 +183,19 @@ type PredefinedScalingMetricSpecification struct { PredefinedScalingMetricType ScalingMetricType // Identifies the resource associated with the metric type. You can't specify a - // resource label unless the metric type is ALBRequestCountPerTarget and there is a - // target group for an Application Load Balancer attached to the Auto Scaling + // resource label unless the metric type is ALBRequestCountPerTarget and there is + // a target group for an Application Load Balancer attached to the Auto Scaling // group, Spot Fleet request, or ECS service. You create the resource label by // appending the final portion of the load balancer ARN and the final portion of // the target group ARN into a single value, separated by a forward slash (/). The // format is app///targetgroup//, where: - // - // * app// is the final portion of the load - // balancer ARN - // - // * targetgroup// is the final portion of the target group - // ARN. - // + // - app// is the final portion of the load balancer ARN + // - targetgroup// is the final portion of the target group ARN. // This is an example: // app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d. - // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) + // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string @@ -239,8 +217,7 @@ type PredefinedScalingMetricSpecification struct { // resource capacity to match the forecast. We recommend waiting a minimum of 24 // hours after creating an Auto Scaling group to configure predictive scaling. At // minimum, there must be 24 hours of historical data to generate a forecast. For -// more information, see Best Practices for AWS Auto Scaling -// (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html) +// more information, see Best Practices for AWS Auto Scaling (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html) // in the AWS Auto Scaling User Guide. type ScalingInstruction struct { @@ -257,63 +234,41 @@ type ScalingInstruction struct { // The ID of the resource. This string consists of the resource type and unique // identifier. - // - // * Auto Scaling group - The resource type is autoScalingGroup and - // the unique identifier is the name of the Auto Scaling group. Example: - // autoScalingGroup/my-asg. - // - // * ECS service - The resource type is service and the - // unique identifier is the cluster name and service name. Example: - // service/default/sample-webapp. - // - // * Spot Fleet request - The resource type is - // spot-fleet-request and the unique identifier is the Spot Fleet request ID. - // Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * - // DynamoDB table - The resource type is table and the unique identifier is the - // resource ID. Example: table/my-table. - // - // * DynamoDB global secondary index - The - // resource type is index and the unique identifier is the resource ID. Example: - // table/my-table/index/my-table-index. - // - // * Aurora DB cluster - The resource type is - // cluster and the unique identifier is the cluster name. Example: - // cluster:my-db-cluster. + // - Auto Scaling group - The resource type is autoScalingGroup and the unique + // identifier is the name of the Auto Scaling group. Example: + // autoScalingGroup/my-asg . + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet request - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - DynamoDB table - The resource type is table and the unique identifier is the + // resource ID. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the resource ID. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . // // This member is required. ResourceId *string // The scalable dimension associated with the resource. - // - // * - // autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto - // Scaling group. - // - // * ecs:service:DesiredCount - The desired task count of an ECS - // service. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a - // Spot Fleet request. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. + // - autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an + // Auto Scaling group. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet + // request. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. // // This member is required. ScalableDimension ScalableDimension @@ -336,8 +291,8 @@ type ScalingInstruction struct { // Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic // scaling is enabled, AWS Auto Scaling creates target tracking scaling policies - // based on the specified target tracking configurations. The default is enabled - // (false). + // based on the specified target tracking configurations. The default is enabled ( + // false ). DisableDynamicScaling *bool // The predefined load metric to use for predictive scaling. This parameter or a @@ -347,44 +302,39 @@ type ScalingInstruction struct { // Defines the behavior that should be applied if the forecast capacity approaches // or exceeds the maximum capacity specified for the resource. The default value is - // SetForecastCapacityToMaxCapacity. The following are possible values: - // - // * - // SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource - // capacity higher than the maximum capacity. The maximum capacity is enforced as a - // hard limit. - // - // * SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale - // resource capacity higher than the maximum capacity to equal but not exceed - // forecast capacity. - // - // * SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may - // scale resource capacity higher than the maximum capacity by a specified buffer - // value. The intention is to give the target tracking scaling policy extra - // capacity if unexpected traffic occurs. - // - // Only valid when configuring predictive - // scaling. + // SetForecastCapacityToMaxCapacity . The following are possible values: + // - SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource + // capacity higher than the maximum capacity. The maximum capacity is enforced as a + // hard limit. + // - SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource + // capacity higher than the maximum capacity to equal but not exceed forecast + // capacity. + // - SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource + // capacity higher than the maximum capacity by a specified buffer value. The + // intention is to give the target tracking scaling policy extra capacity if + // unexpected traffic occurs. + // Only valid when configuring predictive scaling. PredictiveScalingMaxCapacityBehavior PredictiveScalingMaxCapacityBehavior - // The size of the capacity buffer to use when the forecast capacity is close to or - // exceeds the maximum capacity. The value is specified as a percentage relative to - // the forecast capacity. For example, if the buffer is 10, this means a 10 percent - // buffer, such that if the forecast capacity is 50, and the maximum capacity is - // 40, then the effective maximum capacity is 55. Only valid when configuring - // predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set - // to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise. The range - // is 1-100. + // The size of the capacity buffer to use when the forecast capacity is close to + // or exceeds the maximum capacity. The value is specified as a percentage relative + // to the forecast capacity. For example, if the buffer is 10, this means a 10 + // percent buffer, such that if the forecast capacity is 50, and the maximum + // capacity is 40, then the effective maximum capacity is 55. Only valid when + // configuring predictive scaling. Required if the + // PredictiveScalingMaxCapacityBehavior is set to + // SetMaxCapacityAboveForecastCapacity , and cannot be used otherwise. The range is + // 1-100. PredictiveScalingMaxCapacityBuffer *int32 - // The predictive scaling mode. The default value is ForecastAndScale. Otherwise, + // The predictive scaling mode. The default value is ForecastAndScale . Otherwise, // AWS Auto Scaling forecasts capacity but does not create any scheduled scaling // actions based on the capacity forecast. PredictiveScalingMode PredictiveScalingMode // Controls whether a resource's externally created scaling policies are kept or - // replaced. The default value is KeepExternalPolicies. If the parameter is set to - // ReplaceExternalPolicies, any scaling policies that are external to AWS Auto + // replaced. The default value is KeepExternalPolicies . If the parameter is set to + // ReplaceExternalPolicies , any scaling policies that are external to AWS Auto // Scaling are deleted and new target tracking scaling policies created. Only valid // when configuring dynamic scaling. Condition: The number of existing policies to // be replaced must be less than or equal to 50. If there are more than 50 policies @@ -432,29 +382,15 @@ type ScalingPlan struct { ScalingPlanVersion *int64 // The status of the scaling plan. - // - // * Active - The scaling plan is active. - // - // * - // ActiveWithProblems - The scaling plan is active, but the scaling configuration - // for one or more resources could not be applied. - // - // * CreationInProgress - The - // scaling plan is being created. - // - // * CreationFailed - The scaling plan could not be - // created. - // - // * DeletionInProgress - The scaling plan is being deleted. - // - // * - // DeletionFailed - The scaling plan could not be deleted. - // - // * UpdateInProgress - - // The scaling plan is being updated. - // - // * UpdateFailed - The scaling plan could not - // be updated. + // - Active - The scaling plan is active. + // - ActiveWithProblems - The scaling plan is active, but the scaling + // configuration for one or more resources could not be applied. + // - CreationInProgress - The scaling plan is being created. + // - CreationFailed - The scaling plan could not be created. + // - DeletionInProgress - The scaling plan is being deleted. + // - DeletionFailed - The scaling plan could not be deleted. + // - UpdateInProgress - The scaling plan is being updated. + // - UpdateFailed - The scaling plan could not be updated. // // This member is required. StatusCode ScalingPlanStatusCode @@ -476,63 +412,41 @@ type ScalingPlanResource struct { // The ID of the resource. This string consists of the resource type and unique // identifier. - // - // * Auto Scaling group - The resource type is autoScalingGroup and - // the unique identifier is the name of the Auto Scaling group. Example: - // autoScalingGroup/my-asg. - // - // * ECS service - The resource type is service and the - // unique identifier is the cluster name and service name. Example: - // service/default/sample-webapp. - // - // * Spot Fleet request - The resource type is - // spot-fleet-request and the unique identifier is the Spot Fleet request ID. - // Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - // - // * - // DynamoDB table - The resource type is table and the unique identifier is the - // resource ID. Example: table/my-table. - // - // * DynamoDB global secondary index - The - // resource type is index and the unique identifier is the resource ID. Example: - // table/my-table/index/my-table-index. - // - // * Aurora DB cluster - The resource type is - // cluster and the unique identifier is the cluster name. Example: - // cluster:my-db-cluster. + // - Auto Scaling group - The resource type is autoScalingGroup and the unique + // identifier is the name of the Auto Scaling group. Example: + // autoScalingGroup/my-asg . + // - ECS service - The resource type is service and the unique identifier is the + // cluster name and service name. Example: service/default/sample-webapp . + // - Spot Fleet request - The resource type is spot-fleet-request and the unique + // identifier is the Spot Fleet request ID. Example: + // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . + // - DynamoDB table - The resource type is table and the unique identifier is the + // resource ID. Example: table/my-table . + // - DynamoDB global secondary index - The resource type is index and the unique + // identifier is the resource ID. Example: table/my-table/index/my-table-index . + // - Aurora DB cluster - The resource type is cluster and the unique identifier + // is the cluster name. Example: cluster:my-db-cluster . // // This member is required. ResourceId *string // The scalable dimension for the resource. - // - // * - // autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto - // Scaling group. - // - // * ecs:service:DesiredCount - The desired task count of an ECS - // service. - // - // * ec2:spot-fleet-request:TargetCapacity - The target capacity of a - // Spot Fleet request. - // - // * dynamodb:table:ReadCapacityUnits - The provisioned read - // capacity for a DynamoDB table. - // - // * dynamodb:table:WriteCapacityUnits - The - // provisioned write capacity for a DynamoDB table. - // - // * - // dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB - // global secondary index. - // - // * dynamodb:index:WriteCapacityUnits - The provisioned - // write capacity for a DynamoDB global secondary index. - // - // * - // rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB - // cluster. Available for Aurora MySQL-compatible edition and Aurora - // PostgreSQL-compatible edition. + // - autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an + // Auto Scaling group. + // - ecs:service:DesiredCount - The desired task count of an ECS service. + // - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet + // request. + // - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB table. + // - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB table. + // - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a + // DynamoDB global secondary index. + // - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a + // DynamoDB global secondary index. + // - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB + // cluster. Available for Aurora MySQL-compatible edition and Aurora + // PostgreSQL-compatible edition. // // This member is required. ScalableDimension ScalableDimension @@ -548,18 +462,13 @@ type ScalingPlanResource struct { ScalingPlanVersion *int64 // The scaling status of the resource. - // - // * Active - The scaling configuration is - // active. - // - // * Inactive - The scaling configuration is not active because the - // scaling plan is being created or the scaling configuration could not be applied. - // Check the status message for more information. - // - // * PartiallyActive - The scaling - // configuration is partially active because the scaling plan is being created or - // deleted or the scaling configuration could not be fully applied. Check the - // status message for more information. + // - Active - The scaling configuration is active. + // - Inactive - The scaling configuration is not active because the scaling plan + // is being created or the scaling configuration could not be applied. Check the + // status message for more information. + // - PartiallyActive - The scaling configuration is partially active because the + // scaling plan is being created or deleted or the scaling configuration could not + // be fully applied. Check the status message for more information. // // This member is required. ScalingStatusCode ScalingStatusCode @@ -611,7 +520,7 @@ type TagFilter struct { } // Describes a target tracking configuration to use with AWS Auto Scaling. Used -// with ScalingInstruction and ScalingPolicy. +// with ScalingInstruction and ScalingPolicy . type TargetTrackingConfiguration struct { // The target value for the metric. Although this property accepts numbers of type @@ -625,11 +534,11 @@ type TargetTrackingConfiguration struct { // metric. CustomizedScalingMetricSpecification *CustomizedScalingMetricSpecification - // Indicates whether scale in by the target tracking scaling policy is disabled. If - // the value is true, scale in is disabled and the target tracking scaling policy - // doesn't remove capacity from the scalable resource. Otherwise, scale in is - // enabled and the target tracking scaling policy can remove capacity from the - // scalable resource. The default value is false. + // Indicates whether scale in by the target tracking scaling policy is disabled. + // If the value is true , scale in is disabled and the target tracking scaling + // policy doesn't remove capacity from the scalable resource. Otherwise, scale in + // is enabled and the target tracking scaling policy can remove capacity from the + // scalable resource. The default value is false . DisableScaleIn *bool // The estimated time, in seconds, until a newly launched instance can contribute diff --git a/service/backup/api_client.go b/service/backup/api_client.go index ccb350ed164..5173d37f0b9 100644 --- a/service/backup/api_client.go +++ b/service/backup/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/backup/api_op_CancelLegalHold.go b/service/backup/api_op_CancelLegalHold.go index d12068255bf..ee14ae93cba 100644 --- a/service/backup/api_op_CancelLegalHold.go +++ b/service/backup/api_op_CancelLegalHold.go @@ -39,8 +39,8 @@ type CancelLegalHoldInput struct { // This member is required. LegalHoldId *string - // The integer amount in days specifying amount of days after this API operation to - // remove legal hold. + // The integer amount in days specifying amount of days after this API operation + // to remove legal hold. RetainRecordInDays *int64 noSmithyDocumentSerde diff --git a/service/backup/api_op_CreateBackupPlan.go b/service/backup/api_op_CreateBackupPlan.go index a2537c166cc..3019b23c4c7 100644 --- a/service/backup/api_op_CreateBackupPlan.go +++ b/service/backup/api_op_CreateBackupPlan.go @@ -34,7 +34,7 @@ func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanI type CreateBackupPlanInput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more - // sets of Rules. + // sets of Rules . // // This member is required. BackupPlan *types.BackupPlanInput @@ -44,9 +44,9 @@ type CreateBackupPlanInput struct { // assigned to all backups created with this plan. BackupPlanTags map[string]string - // Identifies the request and allows failed requests to be retried without the risk - // of running the operation twice. If the request includes a CreatorRequestId that - // matches an existing backup plan, that plan is returned. This parameter is + // Identifies the request and allows failed requests to be retried without the + // risk of running the operation twice. If the request includes a CreatorRequestId + // that matches an existing backup plan, that plan is returned. This parameter is // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' // characters. CreatorRequestId *string @@ -62,15 +62,15 @@ type CreateBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time that a backup plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_CreateBackupSelection.go b/service/backup/api_op_CreateBackupSelection.go index 32bdf6173f9..cbeb2438699 100644 --- a/service/backup/api_op_CreateBackupSelection.go +++ b/service/backup/api_op_CreateBackupSelection.go @@ -13,8 +13,8 @@ import ( ) // Creates a JSON document that specifies a set of resources to assign to a backup -// plan. For examples, see Assigning resources programmatically -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json). +// plan. For examples, see Assigning resources programmatically (https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json) +// . func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackupSelectionInput, optFns ...func(*Options)) (*CreateBackupSelectionOutput, error) { if params == nil { params = &CreateBackupSelectionInput{} @@ -58,8 +58,8 @@ type CreateBackupSelectionOutput struct { BackupPlanId *string // The date and time a backup selection is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_CreateBackupVault.go b/service/backup/api_op_CreateBackupVault.go index 8368674b292..90f726e06cb 100644 --- a/service/backup/api_op_CreateBackupVault.go +++ b/service/backup/api_op_CreateBackupVault.go @@ -52,7 +52,7 @@ type CreateBackupVaultInput struct { // The server-side encryption key that is used to protect your backups; for // example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . EncryptionKeyArn *string noSmithyDocumentSerde @@ -61,7 +61,7 @@ type CreateBackupVaultInput struct { type CreateBackupVaultOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -71,8 +71,8 @@ type CreateBackupVaultOutput struct { BackupVaultName *string // The date and time a backup vault is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_CreateFramework.go b/service/backup/api_op_CreateFramework.go index 0976335fc68..31768fbf519 100644 --- a/service/backup/api_op_CreateFramework.go +++ b/service/backup/api_op_CreateFramework.go @@ -40,9 +40,9 @@ type CreateFrameworkInput struct { // This member is required. FrameworkControls []types.FrameworkControl - // The unique name of the framework. The name must be between 1 and 256 characters, - // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and - // underscores (_). + // The unique name of the framework. The name must be between 1 and 256 + // characters, starting with a letter, and consisting of letters (a-z, A-Z), + // numbers (0-9), and underscores (_). // // This member is required. FrameworkName *string @@ -55,7 +55,7 @@ type CreateFrameworkInput struct { FrameworkTags map[string]string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to CreateFrameworkInput. Retrying a successful request with the + // identical calls to CreateFrameworkInput . Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string @@ -64,13 +64,13 @@ type CreateFrameworkInput struct { type CreateFrameworkOutput struct { - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. FrameworkArn *string - // The unique name of the framework. The name must be between 1 and 256 characters, - // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and - // underscores (_). + // The unique name of the framework. The name must be between 1 and 256 + // characters, starting with a letter, and consisting of letters (a-z, A-Z), + // numbers (0-9), and underscores (_). FrameworkName *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_CreateLegalHold.go b/service/backup/api_op_CreateLegalHold.go index 5b8fbc6055b..0dbc309e9da 100644 --- a/service/backup/api_op_CreateLegalHold.go +++ b/service/backup/api_op_CreateLegalHold.go @@ -12,9 +12,9 @@ import ( "time" ) -// This action creates a legal hold on a recovery point (backup). A legal hold is a -// restraint on altering or deleting a backup until an authorized user cancels the -// legal hold. Any actions to delete or disassociate a recovery point will fail +// This action creates a legal hold on a recovery point (backup). A legal hold is +// a restraint on altering or deleting a backup until an authorized user cancels +// the legal hold. Any actions to delete or disassociate a recovery point will fail // with an error if one or more active legal holds are on the recovery point. func (c *Client) CreateLegalHold(ctx context.Context, params *CreateLegalHoldInput, optFns ...func(*Options)) (*CreateLegalHoldOutput, error) { if params == nil { @@ -79,7 +79,7 @@ type CreateLegalHoldOutput struct { RecoveryPointSelection *types.RecoveryPointSelection // This displays the status of the legal hold returned after creating the legal - // hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED. + // hold. Statuses can be ACTIVE , PENDING , CANCELED , CANCELING , or FAILED . Status types.LegalHoldStatus // This is the string title of the legal hold returned after creating the legal diff --git a/service/backup/api_op_CreateReportPlan.go b/service/backup/api_op_CreateReportPlan.go index cb0a702f0d6..4ea5ded185f 100644 --- a/service/backup/api_op_CreateReportPlan.go +++ b/service/backup/api_op_CreateReportPlan.go @@ -52,15 +52,15 @@ type CreateReportPlanInput struct { // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | // RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or - // CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage + // CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage // by Amazon Web Services Regions and frameworks. // // This member is required. ReportSetting *types.ReportSetting // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to CreateReportPlanInput. Retrying a successful request with the - // same idempotency token results in a success message with no action taken. + // identical calls to CreateReportPlanInput . Retrying a successful request with + // the same idempotency token results in a success message with no action taken. IdempotencyToken *string // An optional description of the report plan with a maximum of 1,024 characters. @@ -76,13 +76,13 @@ type CreateReportPlanInput struct { type CreateReportPlanOutput struct { // The date and time a backup vault is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. ReportPlanArn *string // The unique name of the report plan. diff --git a/service/backup/api_op_DeleteBackupPlan.go b/service/backup/api_op_DeleteBackupPlan.go index a6e004955c9..8f042a3986f 100644 --- a/service/backup/api_op_DeleteBackupPlan.go +++ b/service/backup/api_op_DeleteBackupPlan.go @@ -43,15 +43,15 @@ type DeleteBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup plan is deleted, in Unix format and Coordinated - // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time diff --git a/service/backup/api_op_DeleteBackupSelection.go b/service/backup/api_op_DeleteBackupSelection.go index 840bbc7b70a..df0c378f72a 100644 --- a/service/backup/api_op_DeleteBackupSelection.go +++ b/service/backup/api_op_DeleteBackupSelection.go @@ -11,7 +11,7 @@ import ( ) // Deletes the resource selection associated with a backup plan that is specified -// by the SelectionId. +// by the SelectionId . func (c *Client) DeleteBackupSelection(ctx context.Context, params *DeleteBackupSelectionInput, optFns ...func(*Options)) (*DeleteBackupSelectionOutput, error) { if params == nil { params = &DeleteBackupSelectionInput{} diff --git a/service/backup/api_op_DeleteBackupVaultLockConfiguration.go b/service/backup/api_op_DeleteBackupVaultLockConfiguration.go index e6dd0515ce1..6b3f40b1e28 100644 --- a/service/backup/api_op_DeleteBackupVaultLockConfiguration.go +++ b/service/backup/api_op_DeleteBackupVaultLockConfiguration.go @@ -13,9 +13,8 @@ import ( // Deletes Backup Vault Lock from a backup vault specified by a backup vault name. // If the Vault Lock configuration is immutable, then you cannot delete Vault Lock // using API operations, and you will receive an InvalidRequestException if you -// attempt to do so. For more information, see Vault Lock -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) in the -// Backup Developer Guide. +// attempt to do so. For more information, see Vault Lock (https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) +// in the Backup Developer Guide. func (c *Client) DeleteBackupVaultLockConfiguration(ctx context.Context, params *DeleteBackupVaultLockConfigurationInput, optFns ...func(*Options)) (*DeleteBackupVaultLockConfigurationOutput, error) { if params == nil { params = &DeleteBackupVaultLockConfigurationInput{} diff --git a/service/backup/api_op_DeleteRecoveryPoint.go b/service/backup/api_op_DeleteRecoveryPoint.go index 313f402dc28..7bf50b6a06a 100644 --- a/service/backup/api_op_DeleteRecoveryPoint.go +++ b/service/backup/api_op_DeleteRecoveryPoint.go @@ -17,11 +17,10 @@ import ( // HTTP 200 response with an empty HTTP body, but the recovery point is not // deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be // deleted with this API once the IAM role has the iam:CreateServiceLinkedRole -// action. To learn more about adding this role, see Troubleshooting manual -// deletions -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting). -// If the user or role is deleted or the permission within the role is removed, the -// deletion will not be successful and will enter an EXPIRED state. +// action. To learn more about adding this role, see Troubleshooting manual +// deletions (https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting) +// . If the user or role is deleted or the permission within the role is removed, +// the deletion will not be successful and will enter an EXPIRED state. func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, optFns ...func(*Options)) (*DeleteRecoveryPointOutput, error) { if params == nil { params = &DeleteRecoveryPointInput{} @@ -49,7 +48,8 @@ type DeleteRecoveryPointInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . // // This member is required. RecoveryPointArn *string diff --git a/service/backup/api_op_DescribeBackupJob.go b/service/backup/api_op_DescribeBackupJob.go index d8935081a5e..d93188f0b02 100644 --- a/service/backup/api_op_DescribeBackupJob.go +++ b/service/backup/api_op_DescribeBackupJob.go @@ -12,7 +12,7 @@ import ( "time" ) -// Returns backup job details for the specified BackupJobId. +// Returns backup job details for the specified BackupJobId . func (c *Client) DescribeBackupJob(ctx context.Context, params *DescribeBackupJobInput, optFns ...func(*Options)) (*DescribeBackupJobOutput, error) { if params == nil { params = &DescribeBackupJobInput{} @@ -54,12 +54,12 @@ type DescribeBackupJobOutput struct { // Represents the actual backup type selected for a backup job. For example, if a // successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType - // returns "WindowsVSS". If BackupType is empty, then the backup type was a regular - // backup. + // returns "WindowsVSS" . If BackupType is empty, then the backup type was a + // regular backup. BackupType *string // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -75,20 +75,20 @@ type DescribeBackupJobOutput struct { // This returns the statistics of the included child (nested) backup jobs. ChildJobsInState map[string]int64 - // The date and time that a job to create a backup job is completed, in Unix format - // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. + // The date and time that a job to create a backup job is completed, in Unix + // format and Coordinated Universal Time (UTC). The value of CompletionDate is + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // Contains identifying information about the creation of a backup job, including - // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the + // the BackupPlanArn , BackupPlanId , BackupPlanVersion , and BackupRuleId of the // backup plan that is used to create it. CreatedBy *types.RecoveryPointCreator // The date and time that a backup job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -99,7 +99,7 @@ type DescribeBackupJobOutput struct { ExpectedCompletionDate *time.Time // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // This returns the boolean value that a backup job is a parent (composite) job. @@ -116,7 +116,8 @@ type DescribeBackupJobOutput struct { PercentDone *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // An ARN that uniquely identifies a saved resource. The format of the ARN depends @@ -127,9 +128,9 @@ type DescribeBackupJobOutput struct { // backup. ResourceName *string - // The type of Amazon Web Services resource to be backed up; for example, an Amazon - // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service - // (Amazon RDS) database. + // The type of Amazon Web Services resource to be backed up; for example, an + // Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database + // Service (Amazon RDS) database. ResourceType *string // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a diff --git a/service/backup/api_op_DescribeBackupVault.go b/service/backup/api_op_DescribeBackupVault.go index 6a476388418..d64930bdea0 100644 --- a/service/backup/api_op_DescribeBackupVault.go +++ b/service/backup/api_op_DescribeBackupVault.go @@ -43,7 +43,7 @@ type DescribeBackupVaultInput struct { type DescribeBackupVaultOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -52,10 +52,10 @@ type DescribeBackupVaultOutput struct { // hyphens. BackupVaultName *string - // The date and time that a backup vault is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The date and time that a backup vault is created, in Unix format and + // Coordinated Universal Time (UTC). The value of CreationDate is accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. CreationDate *time.Time // A unique string that identifies the request and allows failed requests to be @@ -64,7 +64,7 @@ type DescribeBackupVaultOutput struct { // The server-side encryption key that is used to protect your backups; for // example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . EncryptionKeyArn *string // The date and time when Backup Vault Lock configuration cannot be changed or diff --git a/service/backup/api_op_DescribeFramework.go b/service/backup/api_op_DescribeFramework.go index e662aa12d98..92bb75a7662 100644 --- a/service/backup/api_op_DescribeFramework.go +++ b/service/backup/api_op_DescribeFramework.go @@ -12,7 +12,7 @@ import ( "time" ) -// Returns the framework details for the specified FrameworkName. +// Returns the framework details for the specified FrameworkName . func (c *Client) DescribeFramework(ctx context.Context, params *DescribeFrameworkInput, optFns ...func(*Options)) (*DescribeFrameworkOutput, error) { if params == nil { params = &DescribeFrameworkInput{} @@ -50,8 +50,8 @@ type DescribeFrameworkOutput struct { // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED DeploymentStatus *string - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. FrameworkArn *string // A list of the controls that make up the framework. Each control in the list has @@ -67,23 +67,17 @@ type DescribeFrameworkOutput struct { // A framework consists of one or more controls. Each control governs a resource, // such as backup plans, backup selections, backup vaults, or recovery points. You // can also turn Config recording on or off for each resource. The statuses are: - // - // * - // ACTIVE when recording is turned on for all resources governed by the - // framework. - // - // * PARTIALLY_ACTIVE when recording is turned off for at least one - // resource governed by the framework. - // - // * INACTIVE when recording is turned off for - // all resources governed by the framework. - // - // * UNAVAILABLE when Backup is unable to - // validate recording status at this time. + // - ACTIVE when recording is turned on for all resources governed by the + // framework. + // - PARTIALLY_ACTIVE when recording is turned off for at least one resource + // governed by the framework. + // - INACTIVE when recording is turned off for all resources governed by the + // framework. + // - UNAVAILABLE when Backup is unable to validate recording status at this time. FrameworkStatus *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to DescribeFrameworkOutput. Retrying a successful request with + // identical calls to DescribeFrameworkOutput . Retrying a successful request with // the same idempotency token results in a success message with no action taken. IdempotencyToken *string diff --git a/service/backup/api_op_DescribeGlobalSettings.go b/service/backup/api_op_DescribeGlobalSettings.go index 04b5d6f8f3e..1ec27d05437 100644 --- a/service/backup/api_op_DescribeGlobalSettings.go +++ b/service/backup/api_op_DescribeGlobalSettings.go @@ -35,7 +35,7 @@ type DescribeGlobalSettingsInput struct { type DescribeGlobalSettingsOutput struct { - // The status of the flag isCrossAccountBackupEnabled. + // The status of the flag isCrossAccountBackupEnabled . GlobalSettings map[string]string // The date and time that the flag isCrossAccountBackupEnabled was last updated. diff --git a/service/backup/api_op_DescribeProtectedResource.go b/service/backup/api_op_DescribeProtectedResource.go index 21eacce8cd0..8408e1e64f1 100644 --- a/service/backup/api_op_DescribeProtectedResource.go +++ b/service/backup/api_op_DescribeProtectedResource.go @@ -31,8 +31,8 @@ func (c *Client) DescribeProtectedResource(ctx context.Context, params *Describe type DescribeProtectedResourceInput struct { - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. // // This member is required. ResourceArn *string @@ -48,16 +48,16 @@ type DescribeProtectedResourceOutput struct { // 26, 2018 12:11:30.087 AM. LastBackupTime *time.Time - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the resource type. ResourceArn *string // This is the non-unique name of the resource that belongs to the specified // backup. ResourceName *string - // The type of Amazon Web Services resource saved as a recovery point; for example, - // an Amazon EBS volume or an Amazon RDS database. + // The type of Amazon Web Services resource saved as a recovery point; for + // example, an Amazon EBS volume or an Amazon RDS database. ResourceType *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_DescribeRecoveryPoint.go b/service/backup/api_op_DescribeRecoveryPoint.go index 212b4eacb54..8c666ba3f92 100644 --- a/service/backup/api_op_DescribeRecoveryPoint.go +++ b/service/backup/api_op_DescribeRecoveryPoint.go @@ -41,7 +41,8 @@ type DescribeRecoveryPointInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . // // This member is required. RecoveryPointArn *string @@ -55,7 +56,7 @@ type DescribeRecoveryPointOutput struct { BackupSizeInBytes *int64 // An ARN that uniquely identifies a backup vault; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -76,14 +77,13 @@ type DescribeRecoveryPointOutput struct { // This is the identifier of a resource within a composite group, such as nested // (child) recovery point belonging to a composite (parent) stack. The ID is - // transferred from the logical ID - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) + // transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) // within a stack. CompositeMemberIdentifier *string // Contains identifying information about the creation of a recovery point, - // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId - // of the backup plan used to create it. + // including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and + // BackupRuleId of the backup plan used to create it. CreatedBy *types.RecoveryPointCreator // The date and time that a recovery point is created, in Unix format and @@ -93,11 +93,11 @@ type DescribeRecoveryPointOutput struct { CreationDate *time.Time // The server-side encryption key used to protect your backups; for example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . EncryptionKeyArn *string // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // A Boolean value that is returned as TRUE if the specified recovery point is @@ -122,18 +122,19 @@ type DescribeRecoveryPointOutput struct { // after days” setting. The “transition to cold after days” setting cannot be // changed after a backup has been transitioned to cold. Resource types that are // able to be transitioned to cold storage are listed in the "Lifecycle to cold - // storage" section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle - // This is an ARN that uniquely identifies a parent (composite) recovery point; for - // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // This is an ARN that uniquely identifies a parent (composite) recovery point; + // for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . ParentRecoveryPointArn *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // An ARN that uniquely identifies a saved resource. The format of the ARN depends @@ -151,37 +152,36 @@ type DescribeRecoveryPointOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies the source vault where // the resource was originally backed up in; for example, - // arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is + // arn:aws:backup:us-east-1:123456789012:vault:BackupVault . If the recovery is // restored to the same Amazon Web Services account or Region, this value will be - // null. + // null . SourceBackupVaultArn *string // A status code specifying the state of the recovery point. PARTIAL status // indicates Backup could not create the recovery point before the backup window - // closed. To increase your backup plan window using the API, see UpdateBackupPlan - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html). - // You can also increase your backup plan window using the Console by choosing and - // editing your backup plan. EXPIRED status indicates that the recovery point has - // exceeded its retention period, but Backup lacks permission or is otherwise - // unable to delete it. To manually delete these recovery points, see Step 3: - // Delete the recovery points - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups) - // in the Clean up resources section of Getting started. STOPPED status occurs on a - // continuous backup where a user has taken some action that causes the continuous - // backup to be disabled. This can be caused by the removal of permissions, turning - // off versioning, turning off events being sent to EventBridge, or disabling the - // EventBridge rules that are put in place by Backup. To resolve STOPPED status, - // ensure that all requested permissions are in place and that versioning is - // enabled on the S3 bucket. Once these conditions are met, the next instance of a - // backup rule running will result in a new continuous recovery point being - // created. The recovery points with STOPPED status do not need to be deleted. + // closed. To increase your backup plan window using the API, see UpdateBackupPlan (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html) + // . You can also increase your backup plan window using the Console by choosing + // and editing your backup plan. EXPIRED status indicates that the recovery point + // has exceeded its retention period, but Backup lacks permission or is otherwise + // unable to delete it. To manually delete these recovery points, see Step 3: + // Delete the recovery points (https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups) + // in the Clean up resources section of Getting started. STOPPED status occurs on + // a continuous backup where a user has taken some action that causes the + // continuous backup to be disabled. This can be caused by the removal of + // permissions, turning off versioning, turning off events being sent to + // EventBridge, or disabling the EventBridge rules that are put in place by Backup. + // To resolve STOPPED status, ensure that all requested permissions are in place + // and that versioning is enabled on the S3 bucket. Once these conditions are met, + // the next instance of a backup rule running will result in a new continuous + // recovery point being created. The recovery points with STOPPED status do not + // need to be deleted. Status types.RecoveryPointStatus // A status message explaining the reason for the recovery point deletion failure. StatusMessage *string - // Specifies the storage class of the recovery point. Valid values are WARM or - // COLD. + // Specifies the storage class of the recovery point. Valid values are WARM or COLD + // . StorageClass types.StorageClass // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_DescribeRegionSettings.go b/service/backup/api_op_DescribeRegionSettings.go index 87a80b5db69..f51668347f3 100644 --- a/service/backup/api_op_DescribeRegionSettings.go +++ b/service/backup/api_op_DescribeRegionSettings.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the current service opt-in settings for the Region. If service opt-in is -// enabled for a service, Backup tries to protect that service's resources in this -// Region, when the resource is included in an on-demand backup or scheduled backup -// plan. Otherwise, Backup does not try to protect that service's resources in this -// Region. +// Returns the current service opt-in settings for the Region. If service opt-in +// is enabled for a service, Backup tries to protect that service's resources in +// this Region, when the resource is included in an on-demand backup or scheduled +// backup plan. Otherwise, Backup does not try to protect that service's resources +// in this Region. func (c *Client) DescribeRegionSettings(ctx context.Context, params *DescribeRegionSettingsInput, optFns ...func(*Options)) (*DescribeRegionSettingsOutput, error) { if params == nil { params = &DescribeRegionSettingsInput{} @@ -37,14 +37,12 @@ type DescribeRegionSettingsInput struct { type DescribeRegionSettingsOutput struct { // Returns whether Backup fully manages the backups for a resource type. For the - // benefits of full Backup management, see Full Backup management - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management). - // For a list of resource types and whether each supports full Backup management, - // see the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) - // table. If "DynamoDB":false, you can enable full Backup management for DynamoDB - // backup by enabling Backup's advanced DynamoDB backup features - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli). + // benefits of full Backup management, see Full Backup management (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management) + // . For a list of resource types and whether each supports full Backup management, + // see the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // table. If "DynamoDB":false , you can enable full Backup management for DynamoDB + // backup by enabling Backup's advanced DynamoDB backup features (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli) + // . ResourceTypeManagementPreference map[string]bool // Returns a list of all services along with the opt-in preferences in the Region. diff --git a/service/backup/api_op_DescribeReportJob.go b/service/backup/api_op_DescribeReportJob.go index 3db1458b28c..69fb312402f 100644 --- a/service/backup/api_op_DescribeReportJob.go +++ b/service/backup/api_op_DescribeReportJob.go @@ -12,7 +12,7 @@ import ( ) // Returns the details associated with creating a report as specified by its -// ReportJobId. +// ReportJobId . func (c *Client) DescribeReportJob(ctx context.Context, params *DescribeReportJobInput, optFns ...func(*Options)) (*DescribeReportJobOutput, error) { if params == nil { params = &DescribeReportJobInput{} diff --git a/service/backup/api_op_DescribeReportPlan.go b/service/backup/api_op_DescribeReportPlan.go index 852dbeff16e..c989f4772ef 100644 --- a/service/backup/api_op_DescribeReportPlan.go +++ b/service/backup/api_op_DescribeReportPlan.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of all report plans for an Amazon Web Services account and Amazon -// Web Services Region. +// Returns a list of all report plans for an Amazon Web Services account and +// Amazon Web Services Region. func (c *Client) DescribeReportPlan(ctx context.Context, params *DescribeReportPlanInput, optFns ...func(*Options)) (*DescribeReportPlanOutput, error) { if params == nil { params = &DescribeReportPlanInput{} diff --git a/service/backup/api_op_DescribeRestoreJob.go b/service/backup/api_op_DescribeRestoreJob.go index 309ebd468c4..fc517353b0d 100644 --- a/service/backup/api_op_DescribeRestoreJob.go +++ b/service/backup/api_op_DescribeRestoreJob.go @@ -52,14 +52,14 @@ type DescribeRestoreJobOutput struct { // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery - // point is being restored. The format of the ARN depends on the resource type of - // the backed-up resource. + // An Amazon Resource Name (ARN) that uniquely identifies a resource whose + // recovery point is being restored. The format of the ARN depends on the resource + // type of the backed-up resource. CreatedResourceArn *string // The date and time that a restore job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -68,7 +68,7 @@ type DescribeRestoreJobOutput struct { ExpectedCompletionTimeMinutes *int64 // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // Contains an estimated percentage that is complete of a job at the time the job @@ -76,7 +76,8 @@ type DescribeRestoreJobOutput struct { PercentDone *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // Returns metadata associated with a restore job listed by resource type. diff --git a/service/backup/api_op_DisassociateRecoveryPointFromParent.go b/service/backup/api_op_DisassociateRecoveryPointFromParent.go index 9c9da57f4b7..ae563410e24 100644 --- a/service/backup/api_op_DisassociateRecoveryPointFromParent.go +++ b/service/backup/api_op_DisassociateRecoveryPointFromParent.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action to a specific child (nested) recovery point removes the relationship -// between the specified recovery point and its parent (composite) recovery point. +// This action to a specific child (nested) recovery point removes the +// relationship between the specified recovery point and its parent (composite) +// recovery point. func (c *Client) DisassociateRecoveryPointFromParent(ctx context.Context, params *DisassociateRecoveryPointFromParentInput, optFns ...func(*Options)) (*DisassociateRecoveryPointFromParentOutput, error) { if params == nil { params = &DisassociateRecoveryPointFromParentInput{} diff --git a/service/backup/api_op_GetBackupPlan.go b/service/backup/api_op_GetBackupPlan.go index 636dbb2ae10..fc1804ab135 100644 --- a/service/backup/api_op_GetBackupPlan.go +++ b/service/backup/api_op_GetBackupPlan.go @@ -12,7 +12,7 @@ import ( "time" ) -// Returns BackupPlan details for the specified BackupPlanId. The details are the +// Returns BackupPlan details for the specified BackupPlanId . The details are the // body of a backup plan in JSON format, in addition to plan metadata. func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, optFns ...func(*Options)) (*GetBackupPlanOutput, error) { if params == nil { @@ -50,20 +50,20 @@ type GetBackupPlanOutput struct { AdvancedBackupSettings []types.AdvancedBackupSetting // Specifies the body of a backup plan. Includes a BackupPlanName and one or more - // sets of Rules. + // sets of Rules . BackupPlan *types.BackupPlan // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time that a backup plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -72,8 +72,8 @@ type GetBackupPlanOutput struct { CreatorRequestId *string // The date and time that a backup plan is deleted, in Unix format and Coordinated - // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time diff --git a/service/backup/api_op_GetBackupPlanFromJSON.go b/service/backup/api_op_GetBackupPlanFromJSON.go index d95336459c1..122794bf922 100644 --- a/service/backup/api_op_GetBackupPlanFromJSON.go +++ b/service/backup/api_op_GetBackupPlanFromJSON.go @@ -40,7 +40,7 @@ type GetBackupPlanFromJSONInput struct { type GetBackupPlanFromJSONOutput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more - // sets of Rules. + // sets of Rules . BackupPlan *types.BackupPlan // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_GetBackupSelection.go b/service/backup/api_op_GetBackupSelection.go index 789f14a983a..a854cca7bb3 100644 --- a/service/backup/api_op_GetBackupSelection.go +++ b/service/backup/api_op_GetBackupSelection.go @@ -54,8 +54,8 @@ type GetBackupSelectionOutput struct { BackupSelection *types.BackupSelection // The date and time a backup selection is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_GetBackupVaultAccessPolicy.go b/service/backup/api_op_GetBackupVaultAccessPolicy.go index 7b03d96e247..01c7e780f14 100644 --- a/service/backup/api_op_GetBackupVaultAccessPolicy.go +++ b/service/backup/api_op_GetBackupVaultAccessPolicy.go @@ -43,7 +43,7 @@ type GetBackupVaultAccessPolicyInput struct { type GetBackupVaultAccessPolicyOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are diff --git a/service/backup/api_op_GetBackupVaultNotifications.go b/service/backup/api_op_GetBackupVaultNotifications.go index c8e46780e4c..30fd46131fd 100644 --- a/service/backup/api_op_GetBackupVaultNotifications.go +++ b/service/backup/api_op_GetBackupVaultNotifications.go @@ -43,7 +43,7 @@ type GetBackupVaultNotificationsInput struct { type GetBackupVaultNotificationsOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // An array of events that indicate the status of jobs to back up resources to the @@ -57,7 +57,7 @@ type GetBackupVaultNotificationsOutput struct { BackupVaultName *string // An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon - // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. + // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic . SNSTopicArn *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_GetLegalHold.go b/service/backup/api_op_GetLegalHold.go index c6f1a5a0e21..9ca7ac20a01 100644 --- a/service/backup/api_op_GetLegalHold.go +++ b/service/backup/api_op_GetLegalHold.go @@ -12,8 +12,8 @@ import ( "time" ) -// This action returns details for a specified legal hold. The details are the body -// of a legal hold in JSON format, in addition to metadata. +// This action returns details for a specified legal hold. The details are the +// body of a legal hold in JSON format, in addition to metadata. func (c *Client) GetLegalHold(ctx context.Context, params *GetLegalHoldInput, optFns ...func(*Options)) (*GetLegalHoldOutput, error) { if params == nil { params = &GetLegalHoldInput{} @@ -31,8 +31,8 @@ func (c *Client) GetLegalHold(ctx context.Context, params *GetLegalHoldInput, op type GetLegalHoldInput struct { - // This is the ID required to use GetLegalHold. This unique ID is associated with a - // specific legal hold. + // This is the ID required to use GetLegalHold . This unique ID is associated with + // a specific legal hold. // // This member is required. LegalHoldId *string @@ -69,8 +69,8 @@ type GetLegalHoldOutput struct { // This is the date and time until which the legal hold record will be retained. RetainRecordUntil *time.Time - // This is the status of the legal hold. Statuses can be ACTIVE, CREATING, - // CANCELED, and CANCELING. + // This is the status of the legal hold. Statuses can be ACTIVE , CREATING , + // CANCELED , and CANCELING . Status types.LegalHoldStatus // This is the string title of the legal hold. diff --git a/service/backup/api_op_GetRecoveryPointRestoreMetadata.go b/service/backup/api_op_GetRecoveryPointRestoreMetadata.go index 2c8d77b6d8e..8a24472037f 100644 --- a/service/backup/api_op_GetRecoveryPointRestoreMetadata.go +++ b/service/backup/api_op_GetRecoveryPointRestoreMetadata.go @@ -38,7 +38,8 @@ type GetRecoveryPointRestoreMetadataInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . // // This member is required. RecoveryPointArn *string @@ -49,11 +50,12 @@ type GetRecoveryPointRestoreMetadataInput struct { type GetRecoveryPointRestoreMetadataOutput struct { // An ARN that uniquely identifies a backup vault; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // The set of metadata key-value pairs that describe the original configuration of diff --git a/service/backup/api_op_GetSupportedResourceTypes.go b/service/backup/api_op_GetSupportedResourceTypes.go index 88b952ecf75..5bf29cea2fa 100644 --- a/service/backup/api_op_GetSupportedResourceTypes.go +++ b/service/backup/api_op_GetSupportedResourceTypes.go @@ -33,31 +33,16 @@ type GetSupportedResourceTypesInput struct { type GetSupportedResourceTypesOutput struct { // Contains a string with the supported Amazon Web Services resource types: - // - // * - // Aurora for Amazon Aurora - // - // * DynamoDB for Amazon DynamoDB - // - // * EBS for Amazon - // Elastic Block Store - // - // * EC2 for Amazon Elastic Compute Cloud - // - // * EFS for Amazon - // Elastic File System - // - // * FSX for Amazon FSx - // - // * RDS for Amazon Relational Database - // Service - // - // * Storage Gateway for Storage Gateway - // - // * DocDB for Amazon DocumentDB - // (with MongoDB compatibility) - // - // * Neptune for Amazon Neptune + // - Aurora for Amazon Aurora + // - DynamoDB for Amazon DynamoDB + // - EBS for Amazon Elastic Block Store + // - EC2 for Amazon Elastic Compute Cloud + // - EFS for Amazon Elastic File System + // - FSX for Amazon FSx + // - RDS for Amazon Relational Database Service + // - Storage Gateway for Storage Gateway + // - DocDB for Amazon DocumentDB (with MongoDB compatibility) + // - Neptune for Amazon Neptune ResourceTypes []string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_ListBackupJobs.go b/service/backup/api_op_ListBackupJobs.go index a71d1a16c30..b683a694e6d 100644 --- a/service/backup/api_op_ListBackupJobs.go +++ b/service/backup/api_op_ListBackupJobs.go @@ -13,9 +13,9 @@ import ( "time" ) -// Returns a list of existing backup jobs for an authenticated account for the last -// 30 days. For a longer period of time, consider using these monitoring tools -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html). +// Returns a list of existing backup jobs for an authenticated account for the +// last 30 days. For a longer period of time, consider using these monitoring tools (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) +// . func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput, optFns ...func(*Options)) (*ListBackupJobsOutput, error) { if params == nil { params = &ListBackupJobsInput{} @@ -66,36 +66,18 @@ type ListBackupJobsInput struct { ByResourceArn *string // Returns only backup jobs for the specified resources: - // - // * Aurora for Amazon - // Aurora - // - // * DocumentDB for Amazon DocumentDB (with MongoDB compatibility) - // - // * - // DynamoDB for Amazon DynamoDB - // - // * EBS for Amazon Elastic Block Store - // - // * EC2 for - // Amazon Elastic Compute Cloud - // - // * EFS for Amazon Elastic File System - // - // * FSx for - // Amazon FSx - // - // * Neptune for Amazon Neptune - // - // * RDS for Amazon Relational Database - // Service - // - // * Storage Gateway for Storage Gateway - // - // * S3 for Amazon S3 - // - // * - // VirtualMachine for virtual machines + // - Aurora for Amazon Aurora + // - DocumentDB for Amazon DocumentDB (with MongoDB compatibility) + // - DynamoDB for Amazon DynamoDB + // - EBS for Amazon Elastic Block Store + // - EC2 for Amazon Elastic Compute Cloud + // - EFS for Amazon Elastic File System + // - FSx for Amazon FSx + // - Neptune for Amazon Neptune + // - RDS for Amazon Relational Database Service + // - Storage Gateway for Storage Gateway + // - S3 for Amazon S3 + // - VirtualMachine for virtual machines ByResourceType *string // Returns only backup jobs that are in the specified state. diff --git a/service/backup/api_op_ListBackupPlanTemplates.go b/service/backup/api_op_ListBackupPlanTemplates.go index d7b019c8091..c35b83a647e 100644 --- a/service/backup/api_op_ListBackupPlanTemplates.go +++ b/service/backup/api_op_ListBackupPlanTemplates.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns metadata of your saved backup plan templates, including the template ID, -// name, and the creation and deletion dates. +// Returns metadata of your saved backup plan templates, including the template +// ID, name, and the creation and deletion dates. func (c *Client) ListBackupPlanTemplates(ctx context.Context, params *ListBackupPlanTemplatesInput, optFns ...func(*Options)) (*ListBackupPlanTemplatesOutput, error) { if params == nil { params = &ListBackupPlanTemplatesInput{} diff --git a/service/backup/api_op_ListBackupPlans.go b/service/backup/api_op_ListBackupPlans.go index 99a34127805..eec1b8d3430 100644 --- a/service/backup/api_op_ListBackupPlans.go +++ b/service/backup/api_op_ListBackupPlans.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of all active backup plans for an authenticated account. The list -// contains information such as Amazon Resource Names (ARNs), plan IDs, creation -// and deletion dates, version IDs, plan names, and creator request IDs. +// Returns a list of all active backup plans for an authenticated account. The +// list contains information such as Amazon Resource Names (ARNs), plan IDs, +// creation and deletion dates, version IDs, plan names, and creator request IDs. func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInput, optFns ...func(*Options)) (*ListBackupPlansOutput, error) { if params == nil { params = &ListBackupPlansInput{} @@ -33,7 +33,7 @@ func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInp type ListBackupPlansInput struct { // A Boolean value with a default value of FALSE that returns deleted backup plans - // when set to TRUE. + // when set to TRUE . IncludeDeleted *bool // The maximum number of items to be returned. diff --git a/service/backup/api_op_ListBackupSelections.go b/service/backup/api_op_ListBackupSelections.go index 8d9aebbd7eb..91c02b2bbe4 100644 --- a/service/backup/api_op_ListBackupSelections.go +++ b/service/backup/api_op_ListBackupSelections.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array containing metadata of the resources associated with the target -// backup plan. +// Returns an array containing metadata of the resources associated with the +// target backup plan. func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSelectionsInput, optFns ...func(*Options)) (*ListBackupSelectionsOutput, error) { if params == nil { params = &ListBackupSelectionsInput{} diff --git a/service/backup/api_op_ListBackupVaults.go b/service/backup/api_op_ListBackupVaults.go index 8ea13051ac2..aca933130a0 100644 --- a/service/backup/api_op_ListBackupVaults.go +++ b/service/backup/api_op_ListBackupVaults.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of recovery point storage containers along with information about -// them. +// Returns a list of recovery point storage containers along with information +// about them. func (c *Client) ListBackupVaults(ctx context.Context, params *ListBackupVaultsInput, optFns ...func(*Options)) (*ListBackupVaultsOutput, error) { if params == nil { params = &ListBackupVaultsInput{} diff --git a/service/backup/api_op_ListCopyJobs.go b/service/backup/api_op_ListCopyJobs.go index b9a2fdbcc01..a863e26470d 100644 --- a/service/backup/api_op_ListCopyJobs.go +++ b/service/backup/api_op_ListCopyJobs.go @@ -31,8 +31,8 @@ func (c *Client) ListCopyJobs(ctx context.Context, params *ListCopyJobsInput, op type ListCopyJobsInput struct { - // The account ID to list the jobs from. Returns only copy jobs associated with the - // specified account ID. + // The account ID to list the jobs from. Returns only copy jobs associated with + // the specified account ID. ByAccountId *string // Returns only copy jobs completed after a date expressed in Unix format and @@ -50,8 +50,8 @@ type ListCopyJobsInput struct { ByCreatedBefore *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to - // copy from; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault + // . ByDestinationVaultArn *string // This is a filter to list child (nested) jobs based on parent job ID. @@ -62,36 +62,18 @@ type ListCopyJobsInput struct { ByResourceArn *string // Returns only backup jobs for the specified resources: - // - // * Aurora for Amazon - // Aurora - // - // * DocumentDB for Amazon DocumentDB (with MongoDB compatibility) - // - // * - // DynamoDB for Amazon DynamoDB - // - // * EBS for Amazon Elastic Block Store - // - // * EC2 for - // Amazon Elastic Compute Cloud - // - // * EFS for Amazon Elastic File System - // - // * FSx for - // Amazon FSx - // - // * Neptune for Amazon Neptune - // - // * RDS for Amazon Relational Database - // Service - // - // * Storage Gateway for Storage Gateway - // - // * S3 for Amazon S3 - // - // * - // VirtualMachine for virtual machines + // - Aurora for Amazon Aurora + // - DocumentDB for Amazon DocumentDB (with MongoDB compatibility) + // - DynamoDB for Amazon DynamoDB + // - EBS for Amazon Elastic Block Store + // - EC2 for Amazon Elastic Compute Cloud + // - EFS for Amazon Elastic File System + // - FSx for Amazon FSx + // - Neptune for Amazon Neptune + // - RDS for Amazon Relational Database Service + // - Storage Gateway for Storage Gateway + // - S3 for Amazon S3 + // - VirtualMachine for virtual machines ByResourceType *string // Returns only copy jobs that are in the specified state. @@ -111,8 +93,8 @@ type ListCopyJobsInput struct { type ListCopyJobsOutput struct { - // An array of structures containing metadata about your copy jobs returned in JSON - // format. + // An array of structures containing metadata about your copy jobs returned in + // JSON format. CopyJobs []types.CopyJob // The next item following a partial list of returned items. For example, if a diff --git a/service/backup/api_op_ListRecoveryPointsByLegalHold.go b/service/backup/api_op_ListRecoveryPointsByLegalHold.go index 6f63941efc8..0beb36a6dea 100644 --- a/service/backup/api_op_ListRecoveryPointsByLegalHold.go +++ b/service/backup/api_op_ListRecoveryPointsByLegalHold.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action returns recovery point ARNs (Amazon Resource Names) of the specified -// legal hold. +// This action returns recovery point ARNs (Amazon Resource Names) of the +// specified legal hold. func (c *Client) ListRecoveryPointsByLegalHold(ctx context.Context, params *ListRecoveryPointsByLegalHoldInput, optFns ...func(*Options)) (*ListRecoveryPointsByLegalHoldOutput, error) { if params == nil { params = &ListRecoveryPointsByLegalHoldInput{} @@ -53,7 +53,7 @@ type ListRecoveryPointsByLegalHoldOutput struct { // This return is the next item following a partial list of returned resources. NextToken *string - // This is a list of the recovery points returned by ListRecoveryPointsByLegalHold. + // This is a list of the recovery points returned by ListRecoveryPointsByLegalHold . RecoveryPoints []types.RecoveryPointMember // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_ListRecoveryPointsByResource.go b/service/backup/api_op_ListRecoveryPointsByResource.go index cd3b50384de..ec39272d24d 100644 --- a/service/backup/api_op_ListRecoveryPointsByResource.go +++ b/service/backup/api_op_ListRecoveryPointsByResource.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns detailed information about all the recovery points of the type specified -// by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this -// action only lists recovery points created by Backup. +// Returns detailed information about all the recovery points of the type +// specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon +// EC2, this action only lists recovery points created by Backup. func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListRecoveryPointsByResourceInput, optFns ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error) { if params == nil { params = &ListRecoveryPointsByResourceInput{} @@ -32,8 +32,8 @@ func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListR type ListRecoveryPointsByResourceInput struct { - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the resource type. // // This member is required. ResourceArn *string diff --git a/service/backup/api_op_ListReportJobs.go b/service/backup/api_op_ListReportJobs.go index 3fe97a9b42e..85d93969600 100644 --- a/service/backup/api_op_ListReportJobs.go +++ b/service/backup/api_op_ListReportJobs.go @@ -36,8 +36,8 @@ type ListReportJobsInput struct { // 1516925490 represents Friday, January 26, 2018 12:11:30 AM. ByCreationAfter *time.Time - // Returns only report jobs that were created before the date and time specified in - // Unix format and Coordinated Universal Time (UTC). For example, the value + // Returns only report jobs that were created before the date and time specified + // in Unix format and Coordinated Universal Time (UTC). For example, the value // 1516925490 represents Friday, January 26, 2018 12:11:30 AM. ByCreationBefore *time.Time diff --git a/service/backup/api_op_ListReportPlans.go b/service/backup/api_op_ListReportPlans.go index 60240f0e550..b915783df86 100644 --- a/service/backup/api_op_ListReportPlans.go +++ b/service/backup/api_op_ListReportPlans.go @@ -13,7 +13,7 @@ import ( ) // Returns a list of your report plans. For detailed information about a single -// report plan, use DescribeReportPlan. +// report plan, use DescribeReportPlan . func (c *Client) ListReportPlans(ctx context.Context, params *ListReportPlansInput, optFns ...func(*Options)) (*ListReportPlansOutput, error) { if params == nil { params = &ListReportPlansInput{} diff --git a/service/backup/api_op_ListTags.go b/service/backup/api_op_ListTags.go index 6508b80f1fc..be2702f49b9 100644 --- a/service/backup/api_op_ListTags.go +++ b/service/backup/api_op_ListTags.go @@ -14,8 +14,7 @@ import ( // Returns a list of key-value pairs assigned to a target recovery point, backup // plan, or backup vault. ListTags only works for resource types that support full // Backup management of their backups. Those resource types are listed in the "Full -// Backup management" section of the Feature availability by resource -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) +// Backup management" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { @@ -34,9 +33,9 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the type of resource. Valid targets for ListTags are recovery - // points, backup plans, and backup vaults. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the type of resource. Valid targets for ListTags are + // recovery points, backup plans, and backup vaults. // // This member is required. ResourceArn *string diff --git a/service/backup/api_op_PutBackupVaultLockConfiguration.go b/service/backup/api_op_PutBackupVaultLockConfiguration.go index c9a78b2d7c1..f6502b5cb43 100644 --- a/service/backup/api_op_PutBackupVaultLockConfiguration.go +++ b/service/backup/api_op_PutBackupVaultLockConfiguration.go @@ -42,14 +42,14 @@ type PutBackupVaultLockConfigurationInput struct { // This member is required. BackupVaultName *string - // The Backup Vault Lock configuration that specifies the number of days before the - // lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm - // UTC will set the lock date to Jan. 31, 2022 at 8pm UTC. Backup enforces a + // The Backup Vault Lock configuration that specifies the number of days before + // the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at + // 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC. Backup enforces a // 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. - // Therefore, you must set ChangeableForDays to 3 or greater. Before the lock date, - // you can delete Vault Lock from the vault using + // Therefore, you must set ChangeableForDays to 3 or greater. Before the lock + // date, you can delete Vault Lock from the vault using // DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using - // PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock + // PutBackupVaultLockConfiguration . On and after the lock date, the Vault Lock // becomes immutable and cannot be changed or deleted. If this parameter is not // specified, you can delete Vault Lock from the vault using // DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using diff --git a/service/backup/api_op_PutBackupVaultNotifications.go b/service/backup/api_op_PutBackupVaultNotifications.go index 72787f0a8f5..62a53ae739a 100644 --- a/service/backup/api_op_PutBackupVaultNotifications.go +++ b/service/backup/api_op_PutBackupVaultNotifications.go @@ -31,26 +31,15 @@ type PutBackupVaultNotificationsInput struct { // An array of events that indicate the status of jobs to back up resources to the // backup vault. For common use cases and code samples, see Using Amazon SNS to - // track Backup events - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html). - // The following events are supported: - // - // * BACKUP_JOB_STARTED | - // BACKUP_JOB_COMPLETED - // - // * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | - // COPY_JOB_FAILED - // - // * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | - // RECOVERY_POINT_MODIFIED - // - // * S3_BACKUP_OBJECT_FAILED | - // S3_RESTORE_OBJECT_FAILED - // - // The list below shows items that are deprecated events - // (for reference) and are no longer in use. They are no longer supported and will - // not return statuses or notifications. Refer to the list above for current - // supported events. + // track Backup events (https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html) + // . The following events are supported: + // - BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED + // - COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED + // - RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED + // - S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED + // The list below shows items that are deprecated events (for reference) and are + // no longer in use. They are no longer supported and will not return statuses or + // notifications. Refer to the list above for current supported events. // // This member is required. BackupVaultEvents []types.BackupVaultEvent @@ -64,7 +53,7 @@ type PutBackupVaultNotificationsInput struct { BackupVaultName *string // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s - // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. + // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic . // // This member is required. SNSTopicArn *string diff --git a/service/backup/api_op_StartBackupJob.go b/service/backup/api_op_StartBackupJob.go index 8bf8ebd6e56..b865f4afef8 100644 --- a/service/backup/api_op_StartBackupJob.go +++ b/service/backup/api_op_StartBackupJob.go @@ -39,32 +39,32 @@ type StartBackupJobInput struct { BackupVaultName *string // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . // // This member is required. IamRoleArn *string - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. // // This member is required. ResourceArn *string // Specifies the backup option for a selected resource. This option is only // available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid - // values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and - // create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular - // backup. The WindowsVSS option is not enabled by default. + // values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option + // and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a + // regular backup. The WindowsVSS option is not enabled by default. BackupOptions map[string]string // A value in minutes during which a successfully started backup must complete, or // else Backup will cancel the job. This value is optional. This value begins // counting down from when the backup was scheduled. It does not add additional - // time for StartWindowMinutes, or if the backup started later than scheduled. + // time for StartWindowMinutes , or if the backup started later than scheduled. CompleteWindowMinutes *int64 // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to StartBackupJob. Retrying a successful request with the same + // identical calls to StartBackupJob . Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string @@ -76,8 +76,7 @@ type StartBackupJobInput struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" - // section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle @@ -100,8 +99,8 @@ type StartBackupJobOutput struct { BackupJobId *string // The date and time that a backup job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -111,7 +110,8 @@ type StartBackupJobOutput struct { // Note: This field is only returned for Amazon EFS and Advanced DynamoDB // resources. An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_StartCopyJob.go b/service/backup/api_op_StartCopyJob.go index 47d0c3a5627..4e890c9a812 100644 --- a/service/backup/api_op_StartCopyJob.go +++ b/service/backup/api_op_StartCopyJob.go @@ -33,13 +33,13 @@ type StartCopyJobInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a destination backup // vault to copy to; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . // // This member is required. DestinationBackupVaultArn *string // Specifies the IAM role ARN used to copy the target recovery point; for example, - // arn:aws:iam::123456789012:role/S3Access. + // arn:aws:iam::123456789012:role/S3Access . // // This member is required. IamRoleArn *string @@ -60,7 +60,7 @@ type StartCopyJobInput struct { SourceBackupVaultName *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to StartCopyJob. Retrying a successful request with the same + // identical calls to StartCopyJob . Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string @@ -71,8 +71,7 @@ type StartCopyJobInput struct { // the “transition to cold after days” setting. The “transition to cold after days” // setting cannot be changed after a backup has been transitioned to cold. Resource // types that are able to be transitioned to cold storage are listed in the - // "Lifecycle to cold storage" section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle @@ -85,8 +84,8 @@ type StartCopyJobOutput struct { CopyJobId *string // The date and time that a copy job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_StartReportJob.go b/service/backup/api_op_StartReportJob.go index b0b0ddd6895..36fdee6c7cd 100644 --- a/service/backup/api_op_StartReportJob.go +++ b/service/backup/api_op_StartReportJob.go @@ -35,7 +35,7 @@ type StartReportJobInput struct { ReportPlanName *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to StartReportJobInput. Retrying a successful request with the + // identical calls to StartReportJobInput . Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string diff --git a/service/backup/api_op_StartRestoreJob.go b/service/backup/api_op_StartRestoreJob.go index 66d8214a5d9..ca7f9fe8c9e 100644 --- a/service/backup/api_op_StartRestoreJob.go +++ b/service/backup/api_op_StartRestoreJob.go @@ -31,89 +31,61 @@ type StartRestoreJobInput struct { // A set of metadata key-value pairs. Contains information, such as a resource // name, required to restore a recovery point. You can get configuration metadata // about a resource at the time it was backed up by calling - // GetRecoveryPointRestoreMetadata. However, values in addition to those provided + // GetRecoveryPointRestoreMetadata . However, values in addition to those provided // by GetRecoveryPointRestoreMetadata might be required to restore a resource. For // example, you might need to provide a new resource name if the original already // exists. You need to specify specific metadata to restore an Amazon Elastic File // System (Amazon EFS) instance: - // - // * file-system-id: The ID of the Amazon EFS file - // system that is backed up by Backup. Returned in - // GetRecoveryPointRestoreMetadata. - // - // * Encrypted: A Boolean value that, if true, - // specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted - // must be set to true. - // - // * KmsKeyId: Specifies the Amazon Web Services KMS key that - // is used to encrypt the restored file system. You can specify a key from another - // Amazon Web Services account provided that key it is properly shared with your - // account via Amazon Web Services KMS. - // - // * PerformanceMode: Specifies the - // throughput mode of the file system. - // - // * CreationToken: A user-supplied value that - // ensures the uniqueness (idempotency) of the request. - // - // * newFileSystem: A Boolean - // value that, if true, specifies that the recovery point is restored to a new - // Amazon EFS file system. - // - // * ItemsToRestore: An array of one to five strings where - // each string is a file path. Use ItemsToRestore to restore specific files or - // directories rather than the entire file system. This parameter is optional. For - // example, "itemsToRestore":"[\"/my.test\"]". + // - file-system-id : The ID of the Amazon EFS file system that is backed up by + // Backup. Returned in GetRecoveryPointRestoreMetadata . + // - Encrypted : A Boolean value that, if true, specifies that the file system is + // encrypted. If KmsKeyId is specified, Encrypted must be set to true . + // - KmsKeyId : Specifies the Amazon Web Services KMS key that is used to encrypt + // the restored file system. You can specify a key from another Amazon Web Services + // account provided that key it is properly shared with your account via Amazon Web + // Services KMS. + // - PerformanceMode : Specifies the throughput mode of the file system. + // - CreationToken : A user-supplied value that ensures the uniqueness + // (idempotency) of the request. + // - newFileSystem : A Boolean value that, if true, specifies that the recovery + // point is restored to a new Amazon EFS file system. + // - ItemsToRestore : An array of one to five strings where each string is a file + // path. Use ItemsToRestore to restore specific files or directories rather than + // the entire file system. This parameter is optional. For example, + // "itemsToRestore":"[\"/my.test\"]" . // // This member is required. Metadata map[string]string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . // // This member is required. RecoveryPointArn *string // The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the - // target resource; for example: arn:aws:iam::123456789012:role/S3Access. + // target resource; for example: arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to StartRestoreJob. Retrying a successful request with the same + // identical calls to StartRestoreJob . Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string // Starts a job to restore a recovery point for one of the following resources: - // - // * - // Aurora for Amazon Aurora - // - // * DocumentDB for Amazon DocumentDB (with MongoDB - // compatibility) - // - // * DynamoDB for Amazon DynamoDB - // - // * EBS for Amazon Elastic Block - // Store - // - // * EC2 for Amazon Elastic Compute Cloud - // - // * EFS for Amazon Elastic File - // System - // - // * FSx for Amazon FSx - // - // * Neptune for Amazon Neptune - // - // * RDS for Amazon - // Relational Database Service - // - // * Storage Gateway for Storage Gateway - // - // * S3 for - // Amazon S3 - // - // * VirtualMachine for virtual machines + // - Aurora for Amazon Aurora + // - DocumentDB for Amazon DocumentDB (with MongoDB compatibility) + // - DynamoDB for Amazon DynamoDB + // - EBS for Amazon Elastic Block Store + // - EC2 for Amazon Elastic Compute Cloud + // - EFS for Amazon Elastic File System + // - FSx for Amazon FSx + // - Neptune for Amazon Neptune + // - RDS for Amazon Relational Database Service + // - Storage Gateway for Storage Gateway + // - S3 for Amazon S3 + // - VirtualMachine for virtual machines ResourceType *string noSmithyDocumentSerde diff --git a/service/backup/api_op_TagResource.go b/service/backup/api_op_TagResource.go index bfe4e702139..9c209b1ad0a 100644 --- a/service/backup/api_op_TagResource.go +++ b/service/backup/api_op_TagResource.go @@ -29,15 +29,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // type of the tagged resource. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the type of the tagged resource. // // This member is required. ResourceArn *string // Key-value pairs that are used to help organize your resources. You can assign // your own metadata to the resources you create. For clarity, this is the - // structure to assign tags: [{"Key":"string","Value":"string"}]. + // structure to assign tags: [{"Key":"string","Value":"string"}] . // // This member is required. Tags map[string]string diff --git a/service/backup/api_op_UntagResource.go b/service/backup/api_op_UntagResource.go index 41316397b7c..0ba214f7506 100644 --- a/service/backup/api_op_UntagResource.go +++ b/service/backup/api_op_UntagResource.go @@ -29,8 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // type of the tagged resource. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the type of the tagged resource. // // This member is required. ResourceArn *string diff --git a/service/backup/api_op_UpdateBackupPlan.go b/service/backup/api_op_UpdateBackupPlan.go index 2153d901ad1..f61bfdee141 100644 --- a/service/backup/api_op_UpdateBackupPlan.go +++ b/service/backup/api_op_UpdateBackupPlan.go @@ -13,7 +13,7 @@ import ( ) // Updates an existing backup plan identified by its backupPlanId with the input -// document in JSON format. The new version is uniquely identified by a VersionId. +// document in JSON format. The new version is uniquely identified by a VersionId . func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanInput, optFns ...func(*Options)) (*UpdateBackupPlanOutput, error) { if params == nil { params = &UpdateBackupPlanInput{} @@ -32,7 +32,7 @@ func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanI type UpdateBackupPlanInput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more - // sets of Rules. + // sets of Rules . // // This member is required. BackupPlan *types.BackupPlanInput @@ -52,15 +52,15 @@ type UpdateBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time diff --git a/service/backup/api_op_UpdateFramework.go b/service/backup/api_op_UpdateFramework.go index 29725309c83..01b9cc19f10 100644 --- a/service/backup/api_op_UpdateFramework.go +++ b/service/backup/api_op_UpdateFramework.go @@ -47,7 +47,7 @@ type UpdateFrameworkInput struct { FrameworkDescription *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to UpdateFrameworkInput. Retrying a successful request with the + // identical calls to UpdateFrameworkInput . Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string @@ -62,8 +62,8 @@ type UpdateFrameworkOutput struct { // hours behind UTC. CreationTime *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. FrameworkArn *string // The unique name of a framework. This name is between 1 and 256 characters, diff --git a/service/backup/api_op_UpdateGlobalSettings.go b/service/backup/api_op_UpdateGlobalSettings.go index 709bc679cda..3067fc5f306 100644 --- a/service/backup/api_op_UpdateGlobalSettings.go +++ b/service/backup/api_op_UpdateGlobalSettings.go @@ -32,7 +32,7 @@ type UpdateGlobalSettingsInput struct { // A value for isCrossAccountBackupEnabled and a Region. Example: // update-global-settings --global-settings isCrossAccountBackupEnabled=false - // --region us-west-2. + // --region us-west-2 . GlobalSettings map[string]string noSmithyDocumentSerde diff --git a/service/backup/api_op_UpdateRecoveryPointLifecycle.go b/service/backup/api_op_UpdateRecoveryPointLifecycle.go index 37e8b4259ea..a4c8b16b500 100644 --- a/service/backup/api_op_UpdateRecoveryPointLifecycle.go +++ b/service/backup/api_op_UpdateRecoveryPointLifecycle.go @@ -19,9 +19,8 @@ import ( // greater than the “transition to cold after days” setting. The “transition to // cold after days” setting cannot be changed after a backup has been transitioned // to cold. Resource types that are able to be transitioned to cold storage are -// listed in the "Lifecycle to cold storage" section of the Feature availability -// by resource -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) +// listed in the "Lifecycle to cold storage" section of the Feature availability +// by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. This operation // does not support continuous backups. func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, optFns ...func(*Options)) (*UpdateRecoveryPointLifecycleOutput, error) { @@ -51,7 +50,8 @@ type UpdateRecoveryPointLifecycleInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . // // This member is required. RecoveryPointArn *string @@ -71,7 +71,7 @@ type UpdateRecoveryPointLifecycleInput struct { type UpdateRecoveryPointLifecycleOutput struct { // An ARN that uniquely identifies a backup vault; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt @@ -86,14 +86,14 @@ type UpdateRecoveryPointLifecycleOutput struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" - // section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_UpdateRegionSettings.go b/service/backup/api_op_UpdateRegionSettings.go index 8982f649d0b..4ef21f129b4 100644 --- a/service/backup/api_op_UpdateRegionSettings.go +++ b/service/backup/api_op_UpdateRegionSettings.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the current service opt-in settings for the Region. If service-opt-in is -// enabled for a service, Backup tries to protect that service's resources in this -// Region, when the resource is included in an on-demand backup or scheduled backup -// plan. Otherwise, Backup does not try to protect that service's resources in this -// Region. Use the DescribeRegionSettings API to determine the resource types that -// are supported. +// Updates the current service opt-in settings for the Region. If service-opt-in +// is enabled for a service, Backup tries to protect that service's resources in +// this Region, when the resource is included in an on-demand backup or scheduled +// backup plan. Otherwise, Backup does not try to protect that service's resources +// in this Region. Use the DescribeRegionSettings API to determine the resource +// types that are supported. func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionSettingsInput, optFns ...func(*Options)) (*UpdateRegionSettingsOutput, error) { if params == nil { params = &UpdateRegionSettingsInput{} @@ -34,11 +34,10 @@ func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionS type UpdateRegionSettingsInput struct { // Enables or disables full Backup management of backups for a resource type. To - // enable full Backup management for DynamoDB along with Backup's advanced - // DynamoDB backup features - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html), - // follow the procedure to enable advanced DynamoDB backup programmatically - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli). + // enable full Backup management for DynamoDB along with Backup's advanced + // DynamoDB backup features (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html) + // , follow the procedure to enable advanced DynamoDB backup programmatically (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli) + // . ResourceTypeManagementPreference map[string]bool // Updates the list of services along with the opt-in preferences for the Region. diff --git a/service/backup/api_op_UpdateReportPlan.go b/service/backup/api_op_UpdateReportPlan.go index 626c00a9ec9..3adb589fc3d 100644 --- a/service/backup/api_op_UpdateReportPlan.go +++ b/service/backup/api_op_UpdateReportPlan.go @@ -40,8 +40,8 @@ type UpdateReportPlanInput struct { ReportPlanName *string // A customer-chosen string that you can use to distinguish between otherwise - // identical calls to UpdateReportPlanInput. Retrying a successful request with the - // same idempotency token results in a success message with no action taken. + // identical calls to UpdateReportPlanInput . Retrying a successful request with + // the same idempotency token results in a success message with no action taken. IdempotencyToken *string // A structure that contains information about where to deliver your reports, @@ -56,7 +56,7 @@ type UpdateReportPlanInput struct { // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | // RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or - // CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage + // CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage // by Amazon Web Services Regions and frameworks. ReportSetting *types.ReportSetting @@ -66,13 +66,13 @@ type UpdateReportPlanInput struct { type UpdateReportPlanOutput struct { // The date and time that a report plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. ReportPlanArn *string // The unique name of the report plan. diff --git a/service/backup/types/enums.go b/service/backup/types/enums.go index c287909462d..81bae18b3eb 100644 --- a/service/backup/types/enums.go +++ b/service/backup/types/enums.go @@ -109,9 +109,9 @@ const ( CopyJobStatePartial CopyJobState = "PARTIAL" ) -// Values returns all known values for CopyJobState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CopyJobState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CopyJobState) Values() []CopyJobState { return []CopyJobState{ "CREATED", @@ -199,9 +199,9 @@ const ( StorageClassDeleted StorageClass = "DELETED" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "WARM", diff --git a/service/backup/types/errors.go b/service/backup/types/errors.go index 379776c3901..1c7ff60fea0 100644 --- a/service/backup/types/errors.go +++ b/service/backup/types/errors.go @@ -194,8 +194,8 @@ func (e *InvalidResourceStateException) ErrorCode() string { } func (e *InvalidResourceStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A limit in the request has been exceeded; for example, a maximum number of items -// allowed in a request. +// A limit in the request has been exceeded; for example, a maximum number of +// items allowed in a request. type LimitExceededException struct { Message *string diff --git a/service/backup/types/types.go b/service/backup/types/types.go index bfb2b1a4fc3..edacb3e20d9 100644 --- a/service/backup/types/types.go +++ b/service/backup/types/types.go @@ -16,16 +16,15 @@ type AdvancedBackupSetting struct { // Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. // The WindowsVSS option is not enabled by default. If you specify an invalid // option, you get an InvalidParameterValueException exception. For more - // information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html). + // information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html) + // . BackupOptions map[string]string // Specifies an object containing resource type and backup options. The only // supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy // Service (VSS). For a CloudFormation example, see the sample CloudFormation - // template to enable Windows VSS - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html) - // in the Backup User Guide. Valid values: EC2. + // template to enable Windows VSS (https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html) + // in the Backup User Guide. Valid values: EC2 . ResourceType *string noSmithyDocumentSerde @@ -42,9 +41,9 @@ type BackupJob struct { // Specifies the backup option for a selected resource. This option is only // available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid - // values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and - // create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular - // backup. If you specify an invalid option, you get an + // values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option + // and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a + // regular backup. If you specify an invalid option, you get an // InvalidParameterValueException exception. BackupOptions map[string]string @@ -55,7 +54,7 @@ type BackupJob struct { BackupType *string // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -75,13 +74,13 @@ type BackupJob struct { CompletionDate *time.Time // Contains identifying information about the creation of a backup job, including - // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the + // the BackupPlanArn , BackupPlanId , BackupPlanVersion , and BackupRuleId of the // backup plan used to create it. CreatedBy *RecoveryPointCreator // The date and time a backup job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -93,7 +92,7 @@ type BackupJob struct { // Specifies the IAM role ARN used to create the target recovery point. IAM roles // other than the default role must include either AWSBackup or AwsBackup in the - // role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role + // role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess . Role // names without those strings lack permissions to perform backup jobs. IamRoleArn *string @@ -109,21 +108,22 @@ type BackupJob struct { PercentDone *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the resource type. ResourceArn *string // This is the non-unique name of the resource that belongs to the specified // backup. ResourceName *string - // The type of Amazon Web Services resource to be backed up; for example, an Amazon - // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service - // (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the - // only supported resource type is Amazon EC2. + // The type of Amazon Web Services resource to be backed up; for example, an + // Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database + // Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) + // backups, the only supported resource type is Amazon EC2. ResourceType *string // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a @@ -156,8 +156,8 @@ type BackupPlan struct { // This member is required. BackupPlanName *string - // An array of BackupRule objects, each of which specifies a scheduled task that is - // used to back up a selection of resources. + // An array of BackupRule objects, each of which specifies a scheduled task that + // is used to back up a selection of resources. // // This member is required. Rules []BackupRule @@ -179,8 +179,8 @@ type BackupPlanInput struct { // This member is required. BackupPlanName *string - // An array of BackupRule objects, each of which specifies a scheduled task that is - // used to back up a selection of resources. + // An array of BackupRule objects, each of which specifies a scheduled task that + // is used to back up a selection of resources. // // This member is required. Rules []BackupRuleInput @@ -200,7 +200,7 @@ type BackupPlansListMember struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. @@ -222,8 +222,8 @@ type BackupPlansListMember struct { CreatorRequestId *string // The date and time a backup plan is deleted, in Unix format and Coordinated - // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time @@ -290,8 +290,7 @@ type BackupRule struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" - // section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *Lifecycle @@ -299,18 +298,17 @@ type BackupRule struct { // associated with this rule when restored from backup. RecoveryPointTags map[string]string - // Uniquely identifies a rule that is used to schedule the backup of a selection of - // resources. + // Uniquely identifies a rule that is used to schedule the backup of a selection + // of resources. RuleId *string - // A cron expression in UTC specifying when Backup initiates a backup job. For more - // information about Amazon Web Services cron expressions, see Schedule Expressions - // for Rules - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) + // A cron expression in UTC specifying when Backup initiates a backup job. For + // more information about Amazon Web Services cron expressions, see Schedule + // Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) // in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services - // cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past - // the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table - // of examples, click the preceding link and scroll down the page. + // cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past + // the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a + // table of examples, click the preceding link and scroll down the page. ScheduleExpression *string // A value in minutes after a backup is scheduled before a job will be canceled if @@ -359,8 +357,7 @@ type BackupRuleInput struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" - // section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *Lifecycle @@ -380,13 +377,13 @@ type BackupRuleInput struct { } // Used to specify a set of resources to a backup plan. Specifying your desired -// Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none -// of these are specified, Backup will attempt to select all supported and opted-in -// storage resources, which could have unintended cost implications. +// Conditions , ListOfTags , NotResources , and/or Resources is recommended. If +// none of these are specified, Backup will attempt to select all supported and +// opted-in storage resources, which could have unintended cost implications. type BackupSelection struct { // The ARN of the IAM role that Backup uses to authenticate when backing up the - // target resource; for example, arn:aws:iam::123456789012:role/S3Access. + // target resource; for example, arn:aws:iam::123456789012:role/S3Access . // // This member is required. IamRoleArn *string @@ -399,30 +396,22 @@ type BackupSelection struct { // A list of conditions that you define to assign resources to your backup plans // using tags. For example, "StringEquals": { "ConditionKey": - // "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition + // "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition // operators are case sensitive. Conditions differs from ListOfTags as follows: - // - // * - // When you specify more than one condition, you only assign the resources that - // match ALL conditions (using AND logic). - // - // * Conditions supports StringEquals, - // StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports - // StringEquals. + // - When you specify more than one condition, you only assign the resources + // that match ALL conditions (using AND logic). + // - Conditions supports StringEquals , StringLike , StringNotEquals , and + // StringNotLike . ListOfTags only supports StringEquals . Conditions *Conditions // A list of conditions that you define to assign resources to your backup plans // using tags. For example, "StringEquals": { "ConditionKey": - // "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition + // "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition // operators are case sensitive. ListOfTags differs from Conditions as follows: - // - // * - // When you specify more than one condition, you assign all resources that match AT - // LEAST ONE condition (using OR logic). - // - // * ListOfTags only supports StringEquals. - // Conditions supports StringEquals, StringLike, StringNotEquals, and - // StringNotLike. + // - When you specify more than one condition, you assign all resources that + // match AT LEAST ONE condition (using OR logic). + // - ListOfTags only supports StringEquals . Conditions supports StringEquals , + // StringLike , StringNotEquals , and StringNotLike . ListOfTags []Condition // A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The @@ -449,8 +438,8 @@ type BackupSelectionsListMember struct { BackupPlanId *string // The date and time a backup plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -461,7 +450,7 @@ type BackupSelectionsListMember struct { CreatorRequestId *string // Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery - // point; for example, arn:aws:iam::123456789012:role/S3Access. + // point; for example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // Uniquely identifies a request to assign a set of resources to a backup plan. @@ -477,7 +466,7 @@ type BackupSelectionsListMember struct { type BackupVaultListMember struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -487,8 +476,8 @@ type BackupVaultListMember struct { BackupVaultName *string // The date and time a resource backup is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -500,13 +489,12 @@ type BackupVaultListMember struct { // A server-side encryption key you can specify to encrypt your backups from // services that support full Backup management; for example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If // you specify a key, you must specify its ARN, not its alias. If you do not // specify a key, Backup creates a KMS key for you by default. To learn which // Backup services support full Backup management and how Backup handles encryption - // for backups from services that do not yet support full Backup, see Encryption - // for backups in Backup - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html) + // for backups from services that do not yet support full Backup, see Encryption + // for backups in Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html) EncryptionKeyArn *string // The date and time when Backup Vault Lock configuration becomes immutable, @@ -518,9 +506,9 @@ type BackupVaultListMember struct { // 12:11:30.087 AM. LockDate *time.Time - // A Boolean value that indicates whether Backup Vault Lock applies to the selected - // backup vault. If true, Vault Lock prevents delete and update operations on the - // recovery points in the selected vault. + // A Boolean value that indicates whether Backup Vault Lock applies to the + // selected backup vault. If true , Vault Lock prevents delete and update + // operations on the recovery points in the selected vault. Locked *bool // The Backup Vault Lock setting that specifies the maximum retention period that @@ -561,8 +549,7 @@ type BackupVaultListMember struct { // than the “transition to cold after days” setting. The “transition to cold after // days” setting cannot be changed after a backup has been transitioned to cold. // Resource types that are able to be transitioned to cold storage are listed in -// the "Lifecycle to cold storage" section of the Feature availability by resource -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) +// the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. type CalculatedLifecycle struct { @@ -575,27 +562,27 @@ type CalculatedLifecycle struct { noSmithyDocumentSerde } -// Contains an array of triplets made up of a condition type (such as -// StringEquals), a key, and a value. Used to filter resources using their tags and -// assign them to a backup plan. Case sensitive. +// Contains an array of triplets made up of a condition type (such as StringEquals +// ), a key, and a value. Used to filter resources using their tags and assign them +// to a backup plan. Case sensitive. type Condition struct { - // The key in a key-value pair. For example, in the tag Department: Accounting, + // The key in a key-value pair. For example, in the tag Department: Accounting , // Department is the key. // // This member is required. ConditionKey *string - // An operation applied to a key-value pair used to assign resources to your backup - // plan. Condition only supports StringEquals. For more flexible assignment + // An operation applied to a key-value pair used to assign resources to your + // backup plan. Condition only supports StringEquals . For more flexible assignment // options, including StringLike and the ability to exclude resources from your - // backup plan, use Conditions (with an "s" on the end) for your BackupSelection - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html). + // backup plan, use Conditions (with an "s" on the end) for your BackupSelection (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html) + // . // // This member is required. ConditionType ConditionType - // The value in a key-value pair. For example, in the tag Department: Accounting, + // The value in a key-value pair. For example, in the tag Department: Accounting , // Accounting is the value. // // This member is required. @@ -608,11 +595,11 @@ type Condition struct { // backup plan. type ConditionParameter struct { - // The key in a key-value pair. For example, in the tag Department: Accounting, + // The key in a key-value pair. For example, in the tag Department: Accounting , // Department is the key. ConditionKey *string - // The value in a key-value pair. For example, in the tag Department: Accounting, + // The value in a key-value pair. For example, in the tag Department: Accounting , // Accounting is the value. ConditionValue *string @@ -627,8 +614,8 @@ type Conditions struct { // tagged with the same value. Also called "exact matching." StringEquals []ConditionParameter - // Filters the values of your tagged resources for matching tag values with the use - // of a wildcard character (*) anywhere in the string. For example, "prod*" or + // Filters the values of your tagged resources for matching tag values with the + // use of a wildcard character (*) anywhere in the string. For example, "prod*" or // "*rod*" matches the tag value "production". StringLike []ConditionParameter @@ -636,8 +623,8 @@ type Conditions struct { // tagged that do not have the same value. Also called "negated matching." StringNotEquals []ConditionParameter - // Filters the values of your tagged resources for non-matching tag values with the - // use of a wildcard character (*) anywhere in the string. + // Filters the values of your tagged resources for non-matching tag values with + // the use of a wildcard character (*) anywhere in the string. StringNotLike []ConditionParameter noSmithyDocumentSerde @@ -645,14 +632,14 @@ type Conditions struct { // A list of parameters for a control. A control can have zero, one, or more than // one parameter. An example of a control with two parameters is: "backup plan -// frequency is at least daily and the retention period is at least 1 year". The -// first parameter is daily. The second parameter is 1 year. +// frequency is at least daily and the retention period is at least 1 year ". The +// first parameter is daily . The second parameter is 1 year . type ControlInputParameter struct { - // The name of a parameter, for example, BackupPlanFrequency. + // The name of a parameter, for example, BackupPlanFrequency . ParameterName *string - // The value of parameter, for example, hourly. + // The value of parameter, for example, hourly . ParameterValue *string noSmithyDocumentSerde @@ -664,21 +651,21 @@ type ControlInputParameter struct { // ID. If no scope is specified, evaluations for the rule are triggered when any // resource in your recording group changes in configuration. To set a control // scope that includes all of a particular resource, leave the ControlScope empty -// or do not pass it when calling CreateFramework. +// or do not pass it when calling CreateFramework . type ControlScope struct { - // The ID of the only Amazon Web Services resource that you want your control scope - // to contain. + // The ID of the only Amazon Web Services resource that you want your control + // scope to contain. ComplianceResourceIds []string // Describes whether the control scope includes one or more types of resources, - // such as EFS or RDS. + // such as EFS or RDS . ComplianceResourceTypes []string // The tag key-value pair applied to those Amazon Web Services resources that you // want to trigger an evaluation for a rule. A maximum of one key-value pair can be // provided. The tag value is optional, but it cannot be an empty string. The - // structure to assign a tag is: [{"Key":"string","Value":"string"}]. + // structure to assign a tag is: [{"Key":"string","Value":"string"}] . Tags map[string]string noSmithyDocumentSerde @@ -689,7 +676,7 @@ type CopyAction struct { // An Amazon Resource Name (ARN) that uniquely identifies the destination backup // vault for the copied backup. For example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . // // This member is required. DestinationBackupVaultArn *string @@ -701,8 +688,7 @@ type CopyAction struct { // the “transition to cold after days” setting. The “transition to cold after days” // setting cannot be changed after a backup has been transitioned to cold. Resource // types that are able to be transitioned to cold storage are listed in the - // "Lifecycle to cold storage" section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *Lifecycle @@ -729,34 +715,34 @@ type CopyJob struct { // This is the identifier of a resource within a composite group, such as nested // (child) recovery point belonging to a composite (parent) stack. The ID is - // transferred from the logical ID - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) + // transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) // within a stack. CompositeMemberIdentifier *string // Uniquely identifies a copy job. CopyJobId *string - // Contains information about the backup plan and rule that Backup used to initiate - // the recovery point backup. + // Contains information about the backup plan and rule that Backup used to + // initiate the recovery point backup. CreatedBy *RecoveryPointCreator // The date and time a copy job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; - // for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // An Amazon Resource Name (ARN) that uniquely identifies a destination copy + // vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . DestinationBackupVaultArn *string // An ARN that uniquely identifies a destination recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . DestinationRecoveryPointArn *string // Specifies the IAM role ARN used to copy the target recovery point; for example, - // arn:aws:iam::123456789012:role/S3Access. + // arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // This is a boolean value indicating this is a parent (composite) copy job. @@ -765,8 +751,8 @@ type CopyJob struct { // This is the number of child (nested) copy jobs. NumberOfChildJobs *int64 - // This uniquely identifies a request to Backup to copy a resource. The return will - // be the parent (composite) job ID. + // This uniquely identifies a request to Backup to copy a resource. The return + // will be the parent (composite) job ID. ParentJobId *string // The Amazon Web Services resource to be copied; for example, an Amazon Elastic @@ -784,11 +770,12 @@ type CopyJob struct { ResourceType *string // An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for - // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . SourceBackupVaultArn *string // An ARN that uniquely identifies a source recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . SourceRecoveryPointArn *string // The current state of a copy job. @@ -839,8 +826,8 @@ type Framework struct { // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED DeploymentStatus *string - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. FrameworkArn *string // An optional description of the framework with a maximum 1,024 characters. @@ -872,7 +859,7 @@ type FrameworkControl struct { // The scope of a control. The control scope defines what the control will // evaluate. Three examples of control scopes are: a specific backup plan, all // backup plans with a specific tag, or all backup plans. For more information, see - // ControlScope. + // ControlScope . ControlScope *ControlScope noSmithyDocumentSerde @@ -896,16 +883,17 @@ type LegalHold struct { // This is the description of a legal hold. Description *string - // This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; - // for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // This is an Amazon Resource Number (ARN) that uniquely identifies the legal + // hold; for example, + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . LegalHoldArn *string // ID of specific legal hold on one or more recovery points. LegalHoldId *string - // This is the status of the legal hold. Statuses can be ACTIVE, CREATING, - // CANCELED, and CANCELING. + // This is the status of the legal hold. Statuses can be ACTIVE , CREATING , + // CANCELED , and CANCELING . Status LegalHoldStatus // This is the title of a legal hold. @@ -921,13 +909,12 @@ type LegalHold struct { // the “transition to cold after days” setting. The “transition to cold after days” // setting cannot be changed after a backup has been transitioned to cold. Resource // types that are able to be transitioned to cold storage are listed in the -// "Lifecycle to cold storage" section of the Feature availability by resource -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) +// "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. type Lifecycle struct { // Specifies the number of days after creation that a recovery point is deleted. - // Must be greater than 90 days plus MoveToColdStorageAfterDays. + // Must be greater than 90 days plus MoveToColdStorageAfterDays . DeleteAfterDays *int64 // Specifies the number of days after creation that a recovery point is moved to @@ -946,8 +933,8 @@ type ProtectedResource struct { // 12:11:30.087 AM. LastBackupTime *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. ResourceArn *string // This is the non-unique name of the resource that belongs to the specified @@ -971,7 +958,7 @@ type RecoveryPointByBackupVault struct { BackupSizeInBytes *int64 // An ARN that uniquely identifies a backup vault; for example, - // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. + // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault . BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are @@ -984,37 +971,36 @@ type RecoveryPointByBackupVault struct { // timestamps. CalculatedLifecycle *CalculatedLifecycle - // The date and time a job to restore a recovery point is completed, in Unix format - // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. + // The date and time a job to restore a recovery point is completed, in Unix + // format and Coordinated Universal Time (UTC). The value of CompletionDate is + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // This is the identifier of a resource within a composite group, such as nested // (child) recovery point belonging to a composite (parent) stack. The ID is - // transferred from the logical ID - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) + // transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) // within a stack. CompositeMemberIdentifier *string // Contains identifying information about the creation of a recovery point, - // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId - // of the backup plan that is used to create it. + // including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and + // BackupRuleId of the backup plan that is used to create it. CreatedBy *RecoveryPointCreator // The date and time a recovery point is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The server-side encryption key that is used to protect your backups; for // example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . EncryptionKeyArn *string // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // A Boolean value that is returned as TRUE if the specified recovery point is @@ -1038,8 +1024,7 @@ type RecoveryPointByBackupVault struct { // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" - // section of the Feature availability by resource - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) + // section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *Lifecycle @@ -1048,25 +1033,26 @@ type RecoveryPointByBackupVault struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the resource type. ResourceArn *string // This is the non-unique name of the resource that belongs to the specified // backup. ResourceName *string - // The type of Amazon Web Services resource saved as a recovery point; for example, - // an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational - // Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service - // (VSS) backups, the only supported resource type is Amazon EC2. + // The type of Amazon Web Services resource saved as a recovery point; for + // example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon + // Relational Database Service (Amazon RDS) database. For Windows Volume Shadow + // Copy Service (VSS) backups, the only supported resource type is Amazon EC2. ResourceType *string // The backup vault where the recovery point was originally copied from. If the - // recovery point is restored to the same account this value will be null. + // recovery point is restored to the same account this value will be null . SourceBackupVaultArn *string // A status code specifying the state of the recovery point. @@ -1091,14 +1077,14 @@ type RecoveryPointByResource struct { BackupVaultName *string // The date and time a recovery point is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The server-side encryption key that is used to protect your backups; for // example, - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . EncryptionKeyArn *string // This is a boolean value indicating this is a parent (composite) recovery point. @@ -1109,7 +1095,8 @@ type RecoveryPointByResource struct { // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // This is the non-unique name of the resource that belongs to the specified @@ -1125,13 +1112,13 @@ type RecoveryPointByResource struct { noSmithyDocumentSerde } -// Contains information about the backup plan and rule that Backup used to initiate -// the recovery point backup. +// Contains information about the backup plan and rule that Backup used to +// initiate the recovery point backup. type RecoveryPointCreator struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, - // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. + // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 . BackupPlanArn *string // Uniquely identifies a backup plan. @@ -1192,14 +1179,14 @@ type ReportDeliveryChannel struct { // This member is required. S3BucketName *string - // A list of the format of your reports: CSV, JSON, or both. If not specified, the - // default format is CSV. + // A list of the format of your reports: CSV , JSON , or both. If not specified, + // the default format is CSV . Formats []string // The prefix for where Backup Audit Manager delivers your reports to Amazon S3. - // The prefix is this part of the following path: - // s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not - // specified, there is no prefix. + // The prefix is this part of the following path: s3://your-bucket-name/ prefix + // /Backup/us-west-2/year/month/day/report-name. If not specified, there is no + // prefix. S3KeyPrefix *string noSmithyDocumentSerde @@ -1217,19 +1204,19 @@ type ReportDestination struct { noSmithyDocumentSerde } -// Contains detailed information about a report job. A report job compiles a report -// based on a report plan and publishes it to Amazon S3. +// Contains detailed information about a report job. A report job compiles a +// report based on a report plan and publishes it to Amazon S3. type ReportJob struct { - // The date and time that a report job is completed, in Unix format and Coordinated - // Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. - // For example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The date and time that a report job is completed, in Unix format and + // Coordinated Universal Time (UTC). The value of CompletionTime is accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. CompletionTime *time.Time // The date and time that a report job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time @@ -1242,8 +1229,8 @@ type ReportJob struct { // edited. ReportJobId *string - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. ReportPlanArn *string // Identifies the report template for the report. Reports are built using a report @@ -1253,8 +1240,8 @@ type ReportJob struct { ReportTemplate *string // The status of a report job. The statuses are: CREATED | RUNNING | COMPLETED | - // FAILEDCOMPLETED means that the report is available for your review at your - // designated destination. If the status is FAILED, review the StatusMessage for + // FAILED COMPLETED means that the report is available for your review at your + // designated destination. If the status is FAILED , review the StatusMessage for // the reason. Status *string @@ -1268,8 +1255,8 @@ type ReportJob struct { type ReportPlan struct { // The date and time that a report plan is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time @@ -1293,8 +1280,8 @@ type ReportPlan struct { // your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. ReportDeliveryChannel *ReportDeliveryChannel - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. ReportPlanArn *string // An optional description of the report plan with a maximum 1,024 characters. @@ -1309,7 +1296,7 @@ type ReportPlan struct { // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | // RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or - // CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage + // CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage // by Amazon Web Services Regions and frameworks. ReportSetting *ReportSetting @@ -1354,19 +1341,19 @@ type RestoreJobsListMember struct { // The size, in bytes, of the restored resource. BackupSizeInBytes *int64 - // The date and time a job to restore a recovery point is completed, in Unix format - // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to - // milliseconds. For example, the value 1516925490.087 represents Friday, January - // 26, 2018 12:11:30.087 AM. + // The date and time a job to restore a recovery point is completed, in Unix + // format and Coordinated Universal Time (UTC). The value of CompletionDate is + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time - // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of - // the ARN depends on the resource type. + // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format + // of the ARN depends on the resource type. CreatedResourceArn *string // The date and time a restore job is created, in Unix format and Coordinated - // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 + // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time @@ -1375,7 +1362,7 @@ type RestoreJobsListMember struct { ExpectedCompletionTimeMinutes *int64 // Specifies the IAM role ARN used to create the target recovery point; for - // example, arn:aws:iam::123456789012:role/S3Access. + // example, arn:aws:iam::123456789012:role/S3Access . IamRoleArn *string // Contains an estimated percentage complete of a job at the time the job status @@ -1383,7 +1370,8 @@ type RestoreJobsListMember struct { PercentDone *string // An ARN that uniquely identifies a recovery point; for example, - // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. + // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 + // . RecoveryPointArn *string // The resource type of the listed restore jobs; for example, an Amazon Elastic diff --git a/service/backupgateway/api_client.go b/service/backupgateway/api_client.go index b64df79be1f..510cdc9be30 100644 --- a/service/backupgateway/api_client.go +++ b/service/backupgateway/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/backupgateway/api_op_AssociateGatewayToServer.go b/service/backupgateway/api_op_AssociateGatewayToServer.go index f77b13f25b3..c37d2e15182 100644 --- a/service/backupgateway/api_op_AssociateGatewayToServer.go +++ b/service/backupgateway/api_op_AssociateGatewayToServer.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a backup gateway with your server. After you complete the association -// process, you can back up and restore your VMs through the gateway. +// Associates a backup gateway with your server. After you complete the +// association process, you can back up and restore your VMs through the gateway. func (c *Client) AssociateGatewayToServer(ctx context.Context, params *AssociateGatewayToServerInput, optFns ...func(*Options)) (*AssociateGatewayToServerOutput, error) { if params == nil { params = &AssociateGatewayToServerInput{} @@ -29,8 +29,8 @@ func (c *Client) AssociateGatewayToServer(ctx context.Context, params *Associate type AssociateGatewayToServerInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayArn *string diff --git a/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go b/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go index ab7dba920f7..4b898a99af1 100644 --- a/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go +++ b/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the bandwidth rate limit schedule for a specified gateway. By default, -// gateways do not have bandwidth rate limit schedules, which means no bandwidth -// rate limiting is in effect. Use this to get a gateway's bandwidth rate limit -// schedule. +// Retrieves the bandwidth rate limit schedule for a specified gateway. By +// default, gateways do not have bandwidth rate limit schedules, which means no +// bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate +// limit schedule. func (c *Client) GetBandwidthRateLimitSchedule(ctx context.Context, params *GetBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*GetBandwidthRateLimitScheduleOutput, error) { if params == nil { params = &GetBandwidthRateLimitScheduleInput{} @@ -32,8 +32,7 @@ func (c *Client) GetBandwidthRateLimitSchedule(ctx context.Context, params *GetB type GetBandwidthRateLimitScheduleInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) // operation to return a list of gateways for your account and Amazon Web Services // Region. // @@ -49,8 +48,7 @@ type GetBandwidthRateLimitScheduleOutput struct { // no bandwidth rate limit intervals have been scheduled, the array is empty. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) // operation to return a list of gateways for your account and Amazon Web Services // Region. GatewayArn *string diff --git a/service/backupgateway/api_op_ListVirtualMachines.go b/service/backupgateway/api_op_ListVirtualMachines.go index 11cabd51627..17275862da9 100644 --- a/service/backupgateway/api_op_ListVirtualMachines.go +++ b/service/backupgateway/api_op_ListVirtualMachines.go @@ -124,8 +124,8 @@ func (c *Client) addOperationListVirtualMachinesMiddlewares(stack *middleware.St return nil } -// ListVirtualMachinesAPIClient is a client that implements the ListVirtualMachines -// operation. +// ListVirtualMachinesAPIClient is a client that implements the +// ListVirtualMachines operation. type ListVirtualMachinesAPIClient interface { ListVirtualMachines(context.Context, *ListVirtualMachinesInput, ...func(*Options)) (*ListVirtualMachinesOutput, error) } diff --git a/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go b/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go index d1c2dda507a..792838ed0a8 100644 --- a/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go +++ b/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go @@ -38,8 +38,7 @@ type PutBandwidthRateLimitScheduleInput struct { // This member is required. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) // operation to return a list of gateways for your account and Amazon Web Services // Region. // @@ -51,8 +50,7 @@ type PutBandwidthRateLimitScheduleInput struct { type PutBandwidthRateLimitScheduleOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html) // operation to return a list of gateways for your account and Amazon Web Services // Region. GatewayArn *string diff --git a/service/backupgateway/api_op_PutMaintenanceStartTime.go b/service/backupgateway/api_op_PutMaintenanceStartTime.go index b729928d23b..bc09aeac56f 100644 --- a/service/backupgateway/api_op_PutMaintenanceStartTime.go +++ b/service/backupgateway/api_op_PutMaintenanceStartTime.go @@ -45,7 +45,7 @@ type PutMaintenanceStartTimeInput struct { MinuteOfHour *int32 // The day of the month start maintenance on a gateway. Valid values range from - // Sunday to Saturday. + // Sunday to Saturday . DayOfMonth *int32 // The day of the week to start maintenance on a gateway. diff --git a/service/backupgateway/types/types.go b/service/backupgateway/types/types.go index eb35d9ea595..d1f0cc391d2 100644 --- a/service/backupgateway/types/types.go +++ b/service/backupgateway/types/types.go @@ -14,9 +14,9 @@ import ( // both. type BandwidthRateLimitInterval struct { - // The days of the week component of the bandwidth rate limit interval, represented - // as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents - // Saturday. + // The days of the week component of the bandwidth rate limit interval, + // represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 + // represents Saturday. // // This member is required. DaysOfWeek []int32 @@ -28,7 +28,7 @@ type BandwidthRateLimitInterval struct { // The minute of the hour to end the bandwidth rate limit interval. The bandwidth // rate limit interval ends at the end of the minute. To end an interval at the end - // of an hour, use the value 59. + // of an hour, use the value 59 . // // This member is required. EndMinuteOfHour *int32 @@ -40,14 +40,14 @@ type BandwidthRateLimitInterval struct { // The minute of the hour to start the bandwidth rate limit interval. The interval // begins at the start of that minute. To begin an interval exactly at the start of - // the hour, use the value 0. + // the hour, use the value 0 . // // This member is required. StartMinuteOfHour *int32 - // The average upload rate limit component of the bandwidth rate limit interval, in - // bits per second. This field does not appear in the response if the upload rate - // limit is not set. For Backup Gateway, the minimum value is (Value). + // The average upload rate limit component of the bandwidth rate limit interval, + // in bits per second. This field does not appear in the response if the upload + // rate limit is not set. For Backup Gateway, the minimum value is (Value) . AverageUploadRateLimitInBitsPerSec *int64 noSmithyDocumentSerde @@ -58,8 +58,8 @@ type BandwidthRateLimitInterval struct { // Cloud. type Gateway struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayArn *string // The display name of the gateway. @@ -81,8 +81,8 @@ type Gateway struct { // The details of gateway. type GatewayDetails struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayArn *string // The display name of the gateway. @@ -125,8 +125,8 @@ type Hypervisor struct { // The Amazon Resource Name (ARN) of the hypervisor. HypervisorArn *string - // The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the - // hypervisor. + // The Amazon Resource Name (ARN) of the Key Management Service used to encrypt + // the hypervisor. KmsKeyArn *string // The name of the hypervisor. @@ -170,7 +170,7 @@ type HypervisorDetails struct { Name *string // This is the current state of the specified hypervisor. The possible states are - // PENDING, ONLINE, OFFLINE, or ERROR. + // PENDING , ONLINE , OFFLINE , or ERROR . State HypervisorState noSmithyDocumentSerde @@ -212,7 +212,7 @@ type MaintenanceStartTime struct { // characters: + - = . _ : /. type Tag struct { - // The key part of a tag's key-value pair. The key can't start with aws:. + // The key part of a tag's key-value pair. The key can't start with aws: . // // This member is required. Key *string @@ -245,7 +245,7 @@ type VirtualMachine struct { Path *string // The Amazon Resource Name (ARN) of the virtual machine. For example, - // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL. + // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL . ResourceArn *string noSmithyDocumentSerde @@ -271,7 +271,7 @@ type VirtualMachineDetails struct { Path *string // The Amazon Resource Name (ARN) of the virtual machine. For example, - // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL. + // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL . ResourceArn *string // These are the details of the VMware tags associated with the specified virtual @@ -281,10 +281,10 @@ type VirtualMachineDetails struct { noSmithyDocumentSerde } -// A VMware tag is a tag attached to a specific virtual machine. A tag -// (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) is a -// key-value pair you can use to manage, filter, and search for your resources. The -// content of VMware tags can be matched to Amazon Web Services tags. +// A VMware tag is a tag attached to a specific virtual machine. A tag (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) +// is a key-value pair you can use to manage, filter, and search for your +// resources. The content of VMware tags can be matched to Amazon Web Services +// tags. type VmwareTag struct { // The is the category of VMware. @@ -299,8 +299,8 @@ type VmwareTag struct { noSmithyDocumentSerde } -// This displays the mapping of on-premises VMware tags to the corresponding Amazon -// Web Services tags. +// This displays the mapping of on-premises VMware tags to the corresponding +// Amazon Web Services tags. type VmwareToAwsTagMapping struct { // The key part of the Amazon Web Services tag's key-value pair. diff --git a/service/backupstorage/api_client.go b/service/backupstorage/api_client.go index 3a3296e16a0..ad9db394191 100644 --- a/service/backupstorage/api_client.go +++ b/service/backupstorage/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/backupstorage/types/enums.go b/service/backupstorage/types/enums.go index 8b8230c3129..66c07f3ca85 100644 --- a/service/backupstorage/types/enums.go +++ b/service/backupstorage/types/enums.go @@ -9,8 +9,8 @@ const ( DataChecksumAlgorithmSha256 DataChecksumAlgorithm = "SHA256" ) -// Values returns all known values for DataChecksumAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DataChecksumAlgorithm. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DataChecksumAlgorithm) Values() []DataChecksumAlgorithm { return []DataChecksumAlgorithm{ @@ -25,9 +25,9 @@ const ( SummaryChecksumAlgorithmSummary SummaryChecksumAlgorithm = "SUMMARY" ) -// Values returns all known values for SummaryChecksumAlgorithm. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SummaryChecksumAlgorithm. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SummaryChecksumAlgorithm) Values() []SummaryChecksumAlgorithm { return []SummaryChecksumAlgorithm{ "SUMMARY", diff --git a/service/backupstorage/types/errors.go b/service/backupstorage/types/errors.go index a7f1fad72ee..41794e005dc 100644 --- a/service/backupstorage/types/errors.go +++ b/service/backupstorage/types/errors.go @@ -89,8 +89,8 @@ func (e *IllegalArgumentException) ErrorCode() string { } func (e *IllegalArgumentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception -// message for details. +// Non-retryable exception. Indicates the KMS key usage is incorrect. See +// exception message for details. type KMSInvalidKeyUsageException struct { Message *string diff --git a/service/batch/api_client.go b/service/batch/api_client.go index 545f5ae7f72..6e9680d03e4 100644 --- a/service/batch/api_client.go +++ b/service/batch/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/batch/api_op_CancelJob.go b/service/batch/api_op_CancelJob.go index 171f017f667..e1afcfaf205 100644 --- a/service/batch/api_op_CancelJob.go +++ b/service/batch/api_op_CancelJob.go @@ -11,11 +11,11 @@ import ( ) // Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING -// are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of -// the job queue. Then the job status is updated to FAILED. Jobs that progressed to -// the STARTING or RUNNING state aren't canceled. However, the API operation still -// succeeds, even if no job is canceled. These jobs must be terminated with the -// TerminateJob operation. +// are canceled. A job in RUNNABLE remains in RUNNABLE until it reaches the head +// of the job queue. Then the job status is updated to FAILED . Jobs that +// progressed to the STARTING or RUNNING state aren't canceled. However, the API +// operation still succeeds, even if no job is canceled. These jobs must be +// terminated with the TerminateJob operation. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { params = &CancelJobInput{} @@ -31,7 +31,7 @@ func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns . return out, nil } -// Contains the parameters for CancelJob. +// Contains the parameters for CancelJob . type CancelJobInput struct { // The Batch job ID of the job to cancel. diff --git a/service/batch/api_op_CreateComputeEnvironment.go b/service/batch/api_op_CreateComputeEnvironment.go index 617b06b0f54..639866e6e06 100644 --- a/service/batch/api_op_CreateComputeEnvironment.go +++ b/service/batch/api_op_CreateComputeEnvironment.go @@ -12,12 +12,11 @@ import ( ) // Creates an Batch compute environment. You can create MANAGED or UNMANAGED -// compute environments. MANAGED compute environments can use Amazon EC2 or Fargate -// resources. UNMANAGED compute environments can only use EC2 resources. In a -// managed compute environment, Batch manages the capacity and instance types of -// the compute resources within the environment. This is based on the compute -// resource specification that you define or the launch template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// compute environments. MANAGED compute environments can use Amazon EC2 or +// Fargate resources. UNMANAGED compute environments can only use EC2 resources. +// In a managed compute environment, Batch manages the capacity and instance types +// of the compute resources within the environment. This is based on the compute +// resource specification that you define or the launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) // that you specify when you create the compute environment. Either, you can choose // to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate // and Fargate Spot capacity in your managed compute environment. You can @@ -28,17 +27,15 @@ import ( // flexibility with how you configure your compute resources. For example, you can // use custom AMIs. However, you must verify that each of your AMIs meet the Amazon // ECS container instance AMI specification. For more information, see container -// instance AMIs -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) +// instance AMIs (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) // in the Amazon Elastic Container Service Developer Guide. After you created your // unmanaged compute environment, you can use the DescribeComputeEnvironments // operation to find the Amazon ECS cluster that's associated with it. Then, launch // your container instances into that Amazon ECS cluster. For more information, see -// Launching an Amazon ECS container instance -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) +// Launching an Amazon ECS container instance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) // in the Amazon Elastic Container Service Developer Guide. To create a compute // environment that uses EKS resources, the caller must have permissions to call -// eks:DescribeCluster. Batch doesn't automatically upgrade the AMIs in a compute +// eks:DescribeCluster . Batch doesn't automatically upgrade the AMIs in a compute // environment after it's created. For example, it also doesn't update the AMIs in // your compute environment when a newer version of the Amazon ECS optimized AMI is // available. You're responsible for the management of the guest operating system. @@ -46,55 +43,39 @@ import ( // additional application software or utilities that you install on the compute // resources. There are two ways to use a new AMI for your Batch jobs. The original // method is to complete these steps: +// - Create a new compute environment with the new AMI. +// - Add the compute environment to an existing job queue. +// - Remove the earlier compute environment from your job queue. +// - Delete the earlier compute environment. // -// * Create a new compute environment with the -// new AMI. -// -// * Add the compute environment to an existing job queue. -// -// * Remove the -// earlier compute environment from your job queue. -// -// * Delete the earlier compute -// environment. -// -// In April 2022, Batch added enhanced support for updating compute -// environments. For more information, see Updating compute environments -// (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html). -// To use the enhanced updating of compute environments to update AMIs, follow +// In April 2022, Batch added enhanced support for updating compute environments. +// For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) +// . To use the enhanced updating of compute environments to update AMIs, follow // these rules: +// - Either don't set the service role ( serviceRole ) parameter or set it to the +// AWSBatchServiceRole service-linked role. +// - Set the allocation strategy ( allocationStrategy ) parameter to +// BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED . +// - Set the update to latest image version ( updateToLatestImageVersion ) +// parameter to true . +// - Don't specify an AMI ID in imageId , imageIdOverride (in ec2Configuration (https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html) +// ), or in the launch template ( launchTemplate ). In that case, Batch selects +// the latest Amazon ECS optimized AMI that's supported by Batch at the time the +// infrastructure update is initiated. Alternatively, you can specify the AMI ID in +// the imageId or imageIdOverride parameters, or the launch template identified +// by the LaunchTemplate properties. Changing any of these properties starts an +// infrastructure update. If the AMI ID is specified in the launch template, it +// can't be replaced by specifying an AMI ID in either the imageId or +// imageIdOverride parameters. It can only be replaced by specifying a different +// launch template, or if the launch template version is set to $Default or +// $Latest , by setting either a new default version for the launch template (if +// $Default ) or by adding a new version to the launch template (if $Latest ). // -// * Either don't set the service role (serviceRole) parameter or set -// it to the AWSBatchServiceRole service-linked role. -// -// * Set the allocation -// strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or -// SPOT_CAPACITY_OPTIMIZED. -// -// * Set the update to latest image version -// (updateToLatestImageVersion) parameter to true. -// -// * Don't specify an AMI ID in -// imageId, imageIdOverride (in ec2Configuration -// (https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html)), -// or in the launch template (launchTemplate). In that case, Batch selects the -// latest Amazon ECS optimized AMI that's supported by Batch at the time the -// infrastructure update is initiated. Alternatively, you can specify the AMI ID in -// the imageId or imageIdOverride parameters, or the launch template identified by -// the LaunchTemplate properties. Changing any of these properties starts an -// infrastructure update. If the AMI ID is specified in the launch template, it -// can't be replaced by specifying an AMI ID in either the imageId or -// imageIdOverride parameters. It can only be replaced by specifying a different -// launch template, or if the launch template version is set to $Default or -// $Latest, by setting either a new default version for the launch template (if -// $Default) or by adding a new version to the launch template (if $Latest). -// -// If -// these rules are followed, any update that starts an infrastructure update causes -// the AMI ID to be re-selected. If the version setting in the launch template -// (launchTemplate) is set to $Latest or $Default, the latest or default version of -// the launch template is evaluated up at the time of the infrastructure update, -// even if the launchTemplate wasn't updated. +// If these rules are followed, any update that starts an infrastructure update +// causes the AMI ID to be re-selected. If the version setting in the launch +// template ( launchTemplate ) is set to $Latest or $Default , the latest or +// default version of the launch template is evaluated up at the time of the +// infrastructure update, even if the launchTemplate wasn't updated. func (c *Client) CreateComputeEnvironment(ctx context.Context, params *CreateComputeEnvironmentInput, optFns ...func(*Options)) (*CreateComputeEnvironmentOutput, error) { if params == nil { params = &CreateComputeEnvironmentInput{} @@ -110,7 +91,7 @@ func (c *Client) CreateComputeEnvironment(ctx context.Context, params *CreateCom return out, nil } -// Contains the parameters for CreateComputeEnvironment. +// Contains the parameters for CreateComputeEnvironment . type CreateComputeEnvironmentInput struct { // The name for your compute environment. It can be up to 128 characters long. It @@ -120,9 +101,8 @@ type CreateComputeEnvironmentInput struct { // This member is required. ComputeEnvironmentName *string - // The type of the compute environment: MANAGED or UNMANAGED. For more information, - // see Compute Environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // The type of the compute environment: MANAGED or UNMANAGED . For more + // information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. // // This member is required. @@ -130,8 +110,7 @@ type CreateComputeEnvironmentInput struct { // Details about the compute resources managed by the compute environment. This // parameter is required for managed compute environments. For more information, - // see Compute Environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. ComputeResources *types.ComputeResource @@ -140,18 +119,16 @@ type CreateComputeEnvironmentInput struct { // The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make // calls to other Amazon Web Services services on your behalf. For more - // information, see Batch service IAM role - // (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in - // the Batch User Guide. If your account already created the Batch service-linked - // role, that role is used by default for your compute environment unless you - // specify a different role here. If the Batch service-linked role doesn't exist in - // your account, and no role is specified here, the service attempts to create the - // Batch service-linked role in your account. If your specified role has a path - // other than /, then you must specify either the full role ARN (recommended) or - // prefix the role name with the path. For example, if a role with the name bar has - // a path of /foo/, specify /foo/bar as the role name. For more information, see - // Friendly names and paths - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) + // information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // in the Batch User Guide. If your account already created the Batch + // service-linked role, that role is used by default for your compute environment + // unless you specify a different role here. If the Batch service-linked role + // doesn't exist in your account, and no role is specified here, the service + // attempts to create the Batch service-linked role in your account. If your + // specified role has a path other than / , then you must specify either the full + // role ARN (recommended) or prefix the role name with the path. For example, if a + // role with the name bar has a path of /foo/ , specify /foo/bar as the role name. + // For more information, see Friendly names and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) // in the IAM User Guide. Depending on how you created your Batch service role, its // ARN might contain the service-role path prefix. When you only specify the name // of the service role, Batch assumes that your ARN doesn't use the service-role @@ -159,42 +136,38 @@ type CreateComputeEnvironmentInput struct { // service role when you create compute environments. ServiceRole *string - // The state of the compute environment. If the state is ENABLED, then the compute + // The state of the compute environment. If the state is ENABLED , then the compute // environment accepts jobs from a queue and can scale out automatically based on - // queues. If the state is ENABLED, then the Batch scheduler can attempt to place + // queues. If the state is ENABLED , then the Batch scheduler can attempt to place // jobs from an associated job queue on the compute resources within the // environment. If the compute environment is managed, then it can scale its // instances out or in automatically, based on the job queue demand. If the state - // is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the + // is DISABLED , then the Batch scheduler doesn't attempt to place jobs within the // environment. Jobs in a STARTING or RUNNING state continue to progress normally. // Managed compute environments in the DISABLED state don't scale out. Compute // environments in a DISABLED state may continue to incur billing charges. To // prevent additional charges, turn off and then delete the compute environment. - // For more information, see State - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) + // For more information, see State (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) // in the Batch User Guide. When an instance is idle, the instance scales down to // the minvCpus value. However, the instance size doesn't change. For example, // consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus - // value of 36. This instance doesn't scale down to a c5.large instance. + // value of 36 . This instance doesn't scale down to a c5.large instance. State types.CEState // The tags that you apply to the compute environment to help you categorize and // organize your resources. Each tag consists of a key and an optional value. For - // more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web - // Services General Reference. These tags can be updated or removed using the - // TagResource - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) and - // UntagResource - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) + // more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in Amazon Web Services General Reference. These tags can be updated or removed + // using the TagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) + // and UntagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) // API operations. These tags don't propagate to the underlying compute resources. Tags map[string]string - // The maximum number of vCPUs for an unmanaged compute environment. This parameter - // is only used for fair share scheduling to reserve vCPU capacity for new share - // identifiers. If this parameter isn't provided for a fair share job queue, no - // vCPU capacity is reserved. This parameter is only supported when the type - // parameter is set to UNMANAGED. + // The maximum number of vCPUs for an unmanaged compute environment. This + // parameter is only used for fair share scheduling to reserve vCPU capacity for + // new share identifiers. If this parameter isn't provided for a fair share job + // queue, no vCPU capacity is reserved. This parameter is only supported when the + // type parameter is set to UNMANAGED . UnmanagedvCpus *int32 noSmithyDocumentSerde @@ -205,9 +178,9 @@ type CreateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string - // The name of the compute environment. It can be up to 128 characters long. It can - // contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. It + // can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). ComputeEnvironmentName *string // Metadata pertaining to the operation's result. diff --git a/service/batch/api_op_CreateJobQueue.go b/service/batch/api_op_CreateJobQueue.go index efd60a3f07f..d381da75f11 100644 --- a/service/batch/api_op_CreateJobQueue.go +++ b/service/batch/api_op_CreateJobQueue.go @@ -33,17 +33,17 @@ func (c *Client) CreateJobQueue(ctx context.Context, params *CreateJobQueueInput return out, nil } -// Contains the parameters for CreateJobQueue. +// Contains the parameters for CreateJobQueue . type CreateJobQueueInput struct { // The set of compute environments mapped to a job queue and their order relative // to each other. The job scheduler uses this parameter to determine which compute - // environment runs a specific job. Compute environments must be in the VALID state - // before you can associate them with a job queue. You can associate up to three - // compute environments with a job queue. All of the compute environments must be - // either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate - // compute environments can't be mixed. All compute environments that are - // associated with a job queue must share the same architecture. Batch doesn't + // environment runs a specific job. Compute environments must be in the VALID + // state before you can associate them with a job queue. You can associate up to + // three compute environments with a job queue. All of the compute environments + // must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or FARGATE_SPOT ); EC2 + // and Fargate compute environments can't be mixed. All compute environments that + // are associated with a job queue must share the same architecture. Batch doesn't // support mixing compute environment architecture types in a single job queue. // // This member is required. @@ -59,9 +59,9 @@ type CreateJobQueueInput struct { // integer value for the priority parameter) are evaluated first when associated // with the same compute environment. Priority is determined in descending order. // For example, a job queue with a priority value of 10 is given scheduling - // preference over a job queue with a priority value of 1. All of the compute - // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or - // FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed. + // preference over a job queue with a priority value of 1 . All of the compute + // environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or + // FARGATE_SPOT ); EC2 and Fargate compute environments can't be mixed. // // This member is required. Priority *int32 @@ -72,19 +72,18 @@ type CreateJobQueueInput struct { // scheduling policy. After a job queue is created, you can replace but can't // remove the fair share scheduling policy. The format is // aws:Partition:batch:Region:Account:scheduling-policy/Name . An example is - // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. + // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy . SchedulingPolicyArn *string - // The state of the job queue. If the job queue state is ENABLED, it is able to - // accept jobs. If the job queue state is DISABLED, new jobs can't be added to the + // The state of the job queue. If the job queue state is ENABLED , it is able to + // accept jobs. If the job queue state is DISABLED , new jobs can't be added to the // queue, but jobs already in the queue can finish. State types.JQState // The tags that you apply to the job queue to help you categorize and organize // your resources. Each tag consists of a key and an optional value. For more - // information, see Tagging your Batch resources - // (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in Batch - // User Guide. + // information, see Tagging your Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // in Batch User Guide. Tags map[string]string noSmithyDocumentSerde diff --git a/service/batch/api_op_CreateSchedulingPolicy.go b/service/batch/api_op_CreateSchedulingPolicy.go index d1bdae1e2b8..a14ed21ae8d 100644 --- a/service/batch/api_op_CreateSchedulingPolicy.go +++ b/service/batch/api_op_CreateSchedulingPolicy.go @@ -27,7 +27,7 @@ func (c *Client) CreateSchedulingPolicy(ctx context.Context, params *CreateSched return out, nil } -// Contains the parameters for CreateSchedulingPolicy. +// Contains the parameters for CreateSchedulingPolicy . type CreateSchedulingPolicyInput struct { // The name of the scheduling policy. It can be up to 128 letters long. It can @@ -42,13 +42,10 @@ type CreateSchedulingPolicyInput struct { // The tags that you apply to the scheduling policy to help you categorize and // organize your resources. Each tag consists of a key and an optional value. For - // more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web - // Services General Reference. These tags can be updated or removed using the - // TagResource - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) and - // UntagResource - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) + // more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in Amazon Web Services General Reference. These tags can be updated or removed + // using the TagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) + // and UntagResource (https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) // API operations. Tags map[string]string @@ -59,7 +56,7 @@ type CreateSchedulingPolicyOutput struct { // The Amazon Resource Name (ARN) of the scheduling policy. The format is // aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, - // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. + // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy . // // This member is required. Arn *string diff --git a/service/batch/api_op_DeleteComputeEnvironment.go b/service/batch/api_op_DeleteComputeEnvironment.go index acf282c9329..4d91ee71232 100644 --- a/service/batch/api_op_DeleteComputeEnvironment.go +++ b/service/batch/api_op_DeleteComputeEnvironment.go @@ -32,7 +32,7 @@ func (c *Client) DeleteComputeEnvironment(ctx context.Context, params *DeleteCom return out, nil } -// Contains the parameters for DeleteComputeEnvironment. +// Contains the parameters for DeleteComputeEnvironment . type DeleteComputeEnvironmentInput struct { // The name or Amazon Resource Name (ARN) of the compute environment to delete. diff --git a/service/batch/api_op_DeleteJobQueue.go b/service/batch/api_op_DeleteJobQueue.go index bc75249fd78..210bee2fbc2 100644 --- a/service/batch/api_op_DeleteJobQueue.go +++ b/service/batch/api_op_DeleteJobQueue.go @@ -30,7 +30,7 @@ func (c *Client) DeleteJobQueue(ctx context.Context, params *DeleteJobQueueInput return out, nil } -// Contains the parameters for DeleteJobQueue. +// Contains the parameters for DeleteJobQueue . type DeleteJobQueueInput struct { // The short name or full Amazon Resource Name (ARN) of the queue to delete. diff --git a/service/batch/api_op_DeleteSchedulingPolicy.go b/service/batch/api_op_DeleteSchedulingPolicy.go index 4fb6a6049a9..c1a95c944ec 100644 --- a/service/batch/api_op_DeleteSchedulingPolicy.go +++ b/service/batch/api_op_DeleteSchedulingPolicy.go @@ -27,7 +27,7 @@ func (c *Client) DeleteSchedulingPolicy(ctx context.Context, params *DeleteSched return out, nil } -// Contains the parameters for DeleteSchedulingPolicy. +// Contains the parameters for DeleteSchedulingPolicy . type DeleteSchedulingPolicyInput struct { // The Amazon Resource Name (ARN) of the scheduling policy to delete. diff --git a/service/batch/api_op_DeregisterJobDefinition.go b/service/batch/api_op_DeregisterJobDefinition.go index ac0b00491e2..ac0af141bdd 100644 --- a/service/batch/api_op_DeregisterJobDefinition.go +++ b/service/batch/api_op_DeregisterJobDefinition.go @@ -29,8 +29,8 @@ func (c *Client) DeregisterJobDefinition(ctx context.Context, params *Deregister type DeregisterJobDefinitionInput struct { - // The name and revision (name:revision) or full Amazon Resource Name (ARN) of the - // job definition to deregister. + // The name and revision ( name:revision ) or full Amazon Resource Name (ARN) of + // the job definition to deregister. // // This member is required. JobDefinition *string diff --git a/service/batch/api_op_DescribeComputeEnvironments.go b/service/batch/api_op_DescribeComputeEnvironments.go index 0ab97dacb2e..b19a0fff19e 100644 --- a/service/batch/api_op_DescribeComputeEnvironments.go +++ b/service/batch/api_op_DescribeComputeEnvironments.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more of your compute environments. If you're using an unmanaged -// compute environment, you can use the DescribeComputeEnvironment operation to -// determine the ecsClusterArn that you launch your Amazon ECS container instances -// into. +// Describes one or more of your compute environments. If you're using an +// unmanaged compute environment, you can use the DescribeComputeEnvironment +// operation to determine the ecsClusterArn that you launch your Amazon ECS +// container instances into. func (c *Client) DescribeComputeEnvironments(ctx context.Context, params *DescribeComputeEnvironmentsInput, optFns ...func(*Options)) (*DescribeComputeEnvironmentsOutput, error) { if params == nil { params = &DescribeComputeEnvironmentsInput{} @@ -31,19 +31,19 @@ func (c *Client) DescribeComputeEnvironments(ctx context.Context, params *Descri return out, nil } -// Contains the parameters for DescribeComputeEnvironments. +// Contains the parameters for DescribeComputeEnvironments . type DescribeComputeEnvironmentsInput struct { - // A list of up to 100 compute environment names or full Amazon Resource Name (ARN) - // entries. + // A list of up to 100 compute environment names or full Amazon Resource Name + // (ARN) entries. ComputeEnvironments []string - // The maximum number of cluster results returned by DescribeComputeEnvironments in - // paginated output. When this parameter is used, DescribeComputeEnvironments only - // returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another DescribeComputeEnvironments request with the returned nextToken value. - // This value can be between 1 and 100. If this parameter isn't used, then + // The maximum number of cluster results returned by DescribeComputeEnvironments + // in paginated output. When this parameter is used, DescribeComputeEnvironments + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another DescribeComputeEnvironments request with the returned nextToken + // value. This value can be between 1 and 100. If this parameter isn't used, then // DescribeComputeEnvironments returns up to 100 results and a nextToken value if // applicable. MaxResults *int32 @@ -66,7 +66,7 @@ type DescribeComputeEnvironmentsOutput struct { ComputeEnvironments []types.ComputeEnvironmentDetail // The nextToken value to include in a future DescribeComputeEnvironments request. - // When the results of a DescribeComputeEnvironments request exceed maxResults, + // When the results of a DescribeComputeEnvironments request exceed maxResults , // this value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string @@ -148,12 +148,12 @@ var _ DescribeComputeEnvironmentsAPIClient = (*Client)(nil) // DescribeComputeEnvironmentsPaginatorOptions is the paginator options for // DescribeComputeEnvironments type DescribeComputeEnvironmentsPaginatorOptions struct { - // The maximum number of cluster results returned by DescribeComputeEnvironments in - // paginated output. When this parameter is used, DescribeComputeEnvironments only - // returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another DescribeComputeEnvironments request with the returned nextToken value. - // This value can be between 1 and 100. If this parameter isn't used, then + // The maximum number of cluster results returned by DescribeComputeEnvironments + // in paginated output. When this parameter is used, DescribeComputeEnvironments + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another DescribeComputeEnvironments request with the returned nextToken + // value. This value can be between 1 and 100. If this parameter isn't used, then // DescribeComputeEnvironments returns up to 100 results and a nextToken value if // applicable. Limit int32 diff --git a/service/batch/api_op_DescribeJobDefinitions.go b/service/batch/api_op_DescribeJobDefinitions.go index 7f49e500213..e27360dd17a 100644 --- a/service/batch/api_op_DescribeJobDefinitions.go +++ b/service/batch/api_op_DescribeJobDefinitions.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a list of job definitions. You can specify a status (such as ACTIVE) +// Describes a list of job definitions. You can specify a status (such as ACTIVE ) // to only return job definitions that match that status. func (c *Client) DescribeJobDefinitions(ctx context.Context, params *DescribeJobDefinitionsInput, optFns ...func(*Options)) (*DescribeJobDefinitionsOutput, error) { if params == nil { @@ -29,25 +29,26 @@ func (c *Client) DescribeJobDefinitions(ctx context.Context, params *DescribeJob return out, nil } -// Contains the parameters for DescribeJobDefinitions. +// Contains the parameters for DescribeJobDefinitions . type DescribeJobDefinitionsInput struct { // The name of the job definition to describe. JobDefinitionName *string - // A list of up to 100 job definitions. Each entry in the list can either be an ARN - // in the format + // A list of up to 100 job definitions. Each entry in the list can either be an + // ARN in the format // arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} - // or a short version using the form ${JobDefinitionName}:${Revision}. + // or a short version using the form ${JobDefinitionName}:${Revision} . JobDefinitions []string // The maximum number of results returned by DescribeJobDefinitions in paginated // output. When this parameter is used, DescribeJobDefinitions only returns // maxResults results in a single page and a nextToken response element. The // remaining results of the initial request can be seen by sending another - // DescribeJobDefinitions request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions - // returns up to 100 results and a nextToken value if applicable. + // DescribeJobDefinitions request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter isn't used, then + // DescribeJobDefinitions returns up to 100 results and a nextToken value if + // applicable. MaxResults *int32 // The nextToken value returned from a previous paginated DescribeJobDefinitions @@ -70,7 +71,7 @@ type DescribeJobDefinitionsOutput struct { JobDefinitions []types.JobDefinition // The nextToken value to include in a future DescribeJobDefinitions request. When - // the results of a DescribeJobDefinitions request exceed maxResults, this value + // the results of a DescribeJobDefinitions request exceed maxResults , this value // can be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string @@ -156,9 +157,10 @@ type DescribeJobDefinitionsPaginatorOptions struct { // output. When this parameter is used, DescribeJobDefinitions only returns // maxResults results in a single page and a nextToken response element. The // remaining results of the initial request can be seen by sending another - // DescribeJobDefinitions request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions - // returns up to 100 results and a nextToken value if applicable. + // DescribeJobDefinitions request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter isn't used, then + // DescribeJobDefinitions returns up to 100 results and a nextToken value if + // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/batch/api_op_DescribeJobQueues.go b/service/batch/api_op_DescribeJobQueues.go index 340aadb30ac..c4d13294628 100644 --- a/service/batch/api_op_DescribeJobQueues.go +++ b/service/batch/api_op_DescribeJobQueues.go @@ -28,28 +28,28 @@ func (c *Client) DescribeJobQueues(ctx context.Context, params *DescribeJobQueue return out, nil } -// Contains the parameters for DescribeJobQueues. +// Contains the parameters for DescribeJobQueues . type DescribeJobQueuesInput struct { // A list of up to 100 queue names or full queue Amazon Resource Name (ARN) // entries. JobQueues []string - // The maximum number of results returned by DescribeJobQueues in paginated output. - // When this parameter is used, DescribeJobQueues only returns maxResults results - // in a single page and a nextToken response element. The remaining results of the - // initial request can be seen by sending another DescribeJobQueues request with - // the returned nextToken value. This value can be between 1 and 100. If this - // parameter isn't used, then DescribeJobQueues returns up to 100 results and a - // nextToken value if applicable. + // The maximum number of results returned by DescribeJobQueues in paginated + // output. When this parameter is used, DescribeJobQueues only returns maxResults + // results in a single page and a nextToken response element. The remaining + // results of the initial request can be seen by sending another DescribeJobQueues + // request with the returned nextToken value. This value can be between 1 and 100. + // If this parameter isn't used, then DescribeJobQueues returns up to 100 results + // and a nextToken value if applicable. MaxResults *int32 - // The nextToken value returned from a previous paginated DescribeJobQueues request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. This value is null when there are no more results to return. - // Treat this token as an opaque identifier that's only used to retrieve the next - // items in a list and not for other programmatic purposes. + // The nextToken value returned from a previous paginated DescribeJobQueues + // request where maxResults was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. This value is null when there are no more results + // to return. Treat this token as an opaque identifier that's only used to retrieve + // the next items in a list and not for other programmatic purposes. NextToken *string noSmithyDocumentSerde @@ -61,9 +61,9 @@ type DescribeJobQueuesOutput struct { JobQueues []types.JobQueueDetail // The nextToken value to include in a future DescribeJobQueues request. When the - // results of a DescribeJobQueues request exceed maxResults, this value can be used - // to retrieve the next page of results. This value is null when there are no more - // results to return. + // results of a DescribeJobQueues request exceed maxResults , this value can be + // used to retrieve the next page of results. This value is null when there are no + // more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -142,13 +142,13 @@ var _ DescribeJobQueuesAPIClient = (*Client)(nil) // DescribeJobQueuesPaginatorOptions is the paginator options for DescribeJobQueues type DescribeJobQueuesPaginatorOptions struct { - // The maximum number of results returned by DescribeJobQueues in paginated output. - // When this parameter is used, DescribeJobQueues only returns maxResults results - // in a single page and a nextToken response element. The remaining results of the - // initial request can be seen by sending another DescribeJobQueues request with - // the returned nextToken value. This value can be between 1 and 100. If this - // parameter isn't used, then DescribeJobQueues returns up to 100 results and a - // nextToken value if applicable. + // The maximum number of results returned by DescribeJobQueues in paginated + // output. When this parameter is used, DescribeJobQueues only returns maxResults + // results in a single page and a nextToken response element. The remaining + // results of the initial request can be seen by sending another DescribeJobQueues + // request with the returned nextToken value. This value can be between 1 and 100. + // If this parameter isn't used, then DescribeJobQueues returns up to 100 results + // and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/batch/api_op_DescribeJobs.go b/service/batch/api_op_DescribeJobs.go index 019fad8d89b..92e6ab097f9 100644 --- a/service/batch/api_op_DescribeJobs.go +++ b/service/batch/api_op_DescribeJobs.go @@ -27,7 +27,7 @@ func (c *Client) DescribeJobs(ctx context.Context, params *DescribeJobsInput, op return out, nil } -// Contains the parameters for DescribeJobs. +// Contains the parameters for DescribeJobs . type DescribeJobsInput struct { // A list of up to 100 job IDs. diff --git a/service/batch/api_op_DescribeSchedulingPolicies.go b/service/batch/api_op_DescribeSchedulingPolicies.go index c1390d52f69..37c4b36574a 100644 --- a/service/batch/api_op_DescribeSchedulingPolicies.go +++ b/service/batch/api_op_DescribeSchedulingPolicies.go @@ -27,7 +27,7 @@ func (c *Client) DescribeSchedulingPolicies(ctx context.Context, params *Describ return out, nil } -// Contains the parameters for DescribeSchedulingPolicies. +// Contains the parameters for DescribeSchedulingPolicies . type DescribeSchedulingPoliciesInput struct { // A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries. diff --git a/service/batch/api_op_ListJobs.go b/service/batch/api_op_ListJobs.go index f40a1f61af3..6bcb9c7b196 100644 --- a/service/batch/api_op_ListJobs.go +++ b/service/batch/api_op_ListJobs.go @@ -12,20 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of Batch jobs. You must specify only one of the following -// items: +// Returns a list of Batch jobs. You must specify only one of the following items: +// - A job queue ID to return a list of jobs in that job queue +// - A multi-node parallel job ID to return a list of nodes for that job +// - An array job ID to return a list of the children for that job // -// * A job queue ID to return a list of jobs in that job queue -// -// * A -// multi-node parallel job ID to return a list of nodes for that job -// -// * An array -// job ID to return a list of the children for that job -// -// You can filter the results -// by job status with the jobStatus parameter. If you don't specify a status, only -// RUNNING jobs are returned. +// You can filter the results by job status with the jobStatus parameter. If you +// don't specify a status, only RUNNING jobs are returned. func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { params = &ListJobsInput{} @@ -41,7 +34,7 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... return out, nil } -// Contains the parameters for ListJobs. +// Contains the parameters for ListJobs . type ListJobsInput struct { // The job ID for an array job. Specifying an array job ID with this parameter @@ -49,32 +42,33 @@ type ListJobsInput struct { ArrayJobId *string // The filter to apply to the query. Only one filter can be used at a time. When - // the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs - // in an array or multi-node parallel (MNP) jobs. The results are sorted by the - // createdAt field, with the most recent jobs being first. JOB_NAME The value of - // the filter is a case-insensitive match for the job name. If the value ends with - // an asterisk (*), the filter matches any job name that begins with the string - // before the '*'. This corresponds to the jobName value. For example, test1 - // matches both Test1 and test1, and test1* matches both test1 and Test10. When the - // JOB_NAME filter is used, the results are grouped by the job name and version. - // JOB_DEFINITION The value for the filter is the name or Amazon Resource Name - // (ARN) of the job definition. This corresponds to the jobDefinition value. The - // value is case sensitive. When the value for the filter is the job definition + // the filter is used, jobStatus is ignored. The filter doesn't apply to child + // jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by + // the createdAt field, with the most recent jobs being first. JOB_NAME The value + // of the filter is a case-insensitive match for the job name. If the value ends + // with an asterisk (*), the filter matches any job name that begins with the + // string before the '*'. This corresponds to the jobName value. For example, test1 + // matches both Test1 and test1 , and test1* matches both test1 and Test10 . When + // the JOB_NAME filter is used, the results are grouped by the job name and + // version. JOB_DEFINITION The value for the filter is the name or Amazon Resource + // Name (ARN) of the job definition. This corresponds to the jobDefinition value. + // The value is case sensitive. When the value for the filter is the job definition // name, the results include all the jobs that used any revision of that job // definition name. If the value ends with an asterisk (*), the filter matches any // job definition name that begins with the string before the '*'. For example, jd1 - // matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job + // matches only jd1 , and jd1* matches both jd1 and jd1A . The version of the job // definition that's used doesn't affect the sort order. When the JOB_DEFINITION // filter is used and the ARN is used (which is in the form - // arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), - // the results include jobs that used the specified revision of the job definition. - // Asterisk (*) isn't supported when the ARN is used. BEFORE_CREATED_AT The value - // for the filter is the time that's before the job was created. This corresponds - // to the createdAt value. The value is a string representation of the number of - // milliseconds since 00:00:00 UTC (midnight) on January 1, 1970. AFTER_CREATED_AT - // The value for the filter is the time that's after the job was created. This + // arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} + // ), the results include jobs that used the specified revision of the job + // definition. Asterisk (*) isn't supported when the ARN is used. BEFORE_CREATED_AT + // The value for the filter is the time that's before the job was created. This // corresponds to the createdAt value. The value is a string representation of the // number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970. + // AFTER_CREATED_AT The value for the filter is the time that's after the job was + // created. This corresponds to the createdAt value. The value is a string + // representation of the number of milliseconds since 00:00:00 UTC (midnight) on + // January 1, 1970. Filters []types.KeyValuesPair // The name or full Amazon Resource Name (ARN) of the job queue used to list jobs. @@ -118,8 +112,8 @@ type ListJobsOutput struct { // This member is required. JobSummaryList []types.JobSummary - // The nextToken value to include in a future ListJobs request. When the results of - // a ListJobs request exceed maxResults, this value can be used to retrieve the + // The nextToken value to include in a future ListJobs request. When the results + // of a ListJobs request exceed maxResults , this value can be used to retrieve the // next page of results. This value is null when there are no more results to // return. NextToken *string diff --git a/service/batch/api_op_ListSchedulingPolicies.go b/service/batch/api_op_ListSchedulingPolicies.go index 73378c42869..79efc47214b 100644 --- a/service/batch/api_op_ListSchedulingPolicies.go +++ b/service/batch/api_op_ListSchedulingPolicies.go @@ -28,15 +28,15 @@ func (c *Client) ListSchedulingPolicies(ctx context.Context, params *ListSchedul return out, nil } -// Contains the parameters for ListSchedulingPolicies. +// Contains the parameters for ListSchedulingPolicies . type ListSchedulingPoliciesInput struct { // The maximum number of results that's returned by ListSchedulingPolicies in // paginated output. When this parameter is used, ListSchedulingPolicies only // returns maxResults results in a single page and a nextToken response element. // You can see the remaining results of the initial request by sending another - // ListSchedulingPolicies request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies + // ListSchedulingPolicies request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies // returns up to 100 results and a nextToken value if applicable. MaxResults *int32 @@ -55,7 +55,7 @@ type ListSchedulingPoliciesInput struct { type ListSchedulingPoliciesOutput struct { // The nextToken value to include in a future ListSchedulingPolicies request. When - // the results of a ListSchedulingPolicies request exceed maxResults, this value + // the results of a ListSchedulingPolicies request exceed maxResults , this value // can be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string @@ -144,8 +144,8 @@ type ListSchedulingPoliciesPaginatorOptions struct { // paginated output. When this parameter is used, ListSchedulingPolicies only // returns maxResults results in a single page and a nextToken response element. // You can see the remaining results of the initial request by sending another - // ListSchedulingPolicies request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies + // ListSchedulingPolicies request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies // returns up to 100 results and a nextToken value if applicable. Limit int32 diff --git a/service/batch/api_op_ListTagsForResource.go b/service/batch/api_op_ListTagsForResource.go index 27f080b1c6b..fd21d4a2b1a 100644 --- a/service/batch/api_op_ListTagsForResource.go +++ b/service/batch/api_op_ListTagsForResource.go @@ -29,13 +29,13 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes return out, nil } -// Contains the parameters for ListTagsForResource. +// Contains the parameters for ListTagsForResource . type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) that identifies the resource that tags are listed - // for. Batch resources that support tags are compute environments, jobs, job - // definitions, job queues, and scheduling policies. ARNs for child jobs of array - // and multi-node parallel (MNP) jobs aren't supported. + // The Amazon Resource Name (ARN) that identifies the resource that tags are + // listed for. Batch resources that support tags are compute environments, jobs, + // job definitions, job queues, and scheduling policies. ARNs for child jobs of + // array and multi-node parallel (MNP) jobs aren't supported. // // This member is required. ResourceArn *string diff --git a/service/batch/api_op_RegisterJobDefinition.go b/service/batch/api_op_RegisterJobDefinition.go index c1a0d015e2e..3a7189ecdd4 100644 --- a/service/batch/api_op_RegisterJobDefinition.go +++ b/service/batch/api_op_RegisterJobDefinition.go @@ -27,31 +27,30 @@ func (c *Client) RegisterJobDefinition(ctx context.Context, params *RegisterJobD return out, nil } -// Contains the parameters for RegisterJobDefinition. +// Contains the parameters for RegisterJobDefinition . type RegisterJobDefinitionInput struct { - // The name of the job definition to register. It can be up to 128 letters long. It - // can contain uppercase and lowercase letters, numbers, hyphens (-), and + // The name of the job definition to register. It can be up to 128 letters long. + // It can contain uppercase and lowercase letters, numbers, hyphens (-), and // underscores (_). // // This member is required. JobDefinitionName *string - // The type of job definition. For more information about multi-node parallel jobs, - // see Creating a multi-node parallel job definition - // (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) in - // the Batch User Guide. If the job is run on Fargate resources, then multinode + // The type of job definition. For more information about multi-node parallel + // jobs, see Creating a multi-node parallel job definition (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) + // in the Batch User Guide. If the job is run on Fargate resources, then multinode // isn't supported. // // This member is required. Type types.JobDefinitionType // An object with various properties specific to Amazon ECS based single-node - // container-based jobs. If the job definition's type parameter is container, then - // you must specify either containerProperties or nodeProperties. This must not be + // container-based jobs. If the job definition's type parameter is container , then + // you must specify either containerProperties or nodeProperties . This must not be // specified for Amazon EKS based job definitions. If the job runs on Fargate - // resources, then you must not specify nodeProperties; use only - // containerProperties. + // resources, then you must not specify nodeProperties ; use only + // containerProperties . ContainerProperties *types.ContainerProperties // An object with various properties that are specific to Amazon EKS based jobs. @@ -60,13 +59,12 @@ type RegisterJobDefinitionInput struct { // An object with various properties specific to multi-node parallel jobs. If you // specify node properties for a job, it becomes a multi-node parallel job. For - // more information, see Multi-node Parallel Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html) - // in the Batch User Guide. If the job definition's type parameter is container, - // then you must specify either containerProperties or nodeProperties. If the job - // runs on Fargate resources, then you must not specify nodeProperties; use + // more information, see Multi-node Parallel Jobs (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html) + // in the Batch User Guide. If the job definition's type parameter is container , + // then you must specify either containerProperties or nodeProperties . If the job + // runs on Fargate resources, then you must not specify nodeProperties ; use // containerProperties instead. If the job runs on Amazon EKS resources, then you - // must not specify nodeProperties. + // must not specify nodeProperties . NodeProperties *types.NodeProperties // Default parameter substitution placeholders to set in the job definition. @@ -75,9 +73,9 @@ type RegisterJobDefinitionInput struct { Parameters map[string]string // The platform capabilities required by the job definition. If no value is - // specified, it defaults to EC2. To run the job on Fargate resources, specify - // FARGATE. If the job runs on Amazon EKS resources, then you must not specify - // platformCapabilities. + // specified, it defaults to EC2 . To run the job on Fargate resources, specify + // FARGATE . If the job runs on Amazon EKS resources, then you must not specify + // platformCapabilities . PlatformCapabilities []types.PlatformCapability // Specifies whether to propagate the tags from the job or job definition to the @@ -86,7 +84,7 @@ type RegisterJobDefinitionInput struct { // tags with the same name, job tags are given priority over job definitions tags. // If the total number of combined tags from the job and job definition is over 50, // the job is moved to the FAILED state. If the job runs on Amazon EKS resources, - // then you must not specify propagateTags. + // then you must not specify propagateTags . PropagateTags *bool // The retry strategy to use for failed jobs that are submitted with this job @@ -104,9 +102,8 @@ type RegisterJobDefinitionInput struct { // The tags that you apply to the job definition to help you categorize and // organize your resources. Each tag consists of a key and an optional value. For - // more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in Batch - // User Guide. + // more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // in Batch User Guide. Tags map[string]string // The timeout configuration for jobs that are submitted with this job definition, @@ -114,9 +111,8 @@ type RegisterJobDefinitionInput struct { // terminated due to a timeout, it isn't retried. The minimum value for the timeout // is 60 seconds. Any timeout configuration that's specified during a SubmitJob // operation overrides the timeout configuration defined here. For more - // information, see Job Timeouts - // (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html) in the - // Batch User Guide. + // information, see Job Timeouts (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html) + // in the Batch User Guide. Timeout *types.JobTimeout noSmithyDocumentSerde diff --git a/service/batch/api_op_SubmitJob.go b/service/batch/api_op_SubmitJob.go index c6b1d8cfad7..8862c292d24 100644 --- a/service/batch/api_op_SubmitJob.go +++ b/service/batch/api_op_SubmitJob.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Submits an Batch job from a job definition. Parameters that are specified during -// SubmitJob override parameters defined in the job definition. vCPU and memory -// requirements that are specified in the resourceRequirements objects in the job -// definition are the exception. They can't be overridden this way using the memory -// and vcpus parameters. Rather, you must specify updates to job definition -// parameters in a resourceRequirements object that's included in the +// Submits an Batch job from a job definition. Parameters that are specified +// during SubmitJob override parameters defined in the job definition. vCPU and +// memory requirements that are specified in the resourceRequirements objects in +// the job definition are the exception. They can't be overridden this way using +// the memory and vcpus parameters. Rather, you must specify updates to job +// definition parameters in a resourceRequirements object that's included in the // containerOverrides parameter. Job queues with a scheduling policy are limited to // 500 active fair share identifiers at a time. Jobs that run on Fargate resources // can't be guaranteed to run for more than 14 days. This is because, after 14 @@ -36,13 +36,13 @@ func (c *Client) SubmitJob(ctx context.Context, params *SubmitJobInput, optFns . return out, nil } -// Contains the parameters for SubmitJob. +// Contains the parameters for SubmitJob . type SubmitJobInput struct { - // The job definition used by this job. This value can be one of definition-name, - // definition-name:revision, or the Amazon Resource Name (ARN) for the job - // definition, with or without the revision - // (arn:aws:batch:region:account:job-definition/definition-name:revision , or + // The job definition used by this job. This value can be one of definition-name , + // definition-name:revision , or the Amazon Resource Name (ARN) for the job + // definition, with or without the revision ( + // arn:aws:batch:region:account:job-definition/definition-name:revision , or // arn:aws:batch:region:account:job-definition/definition-name ). If the revision // is not specified, then the latest active revision is used. // @@ -56,17 +56,16 @@ type SubmitJobInput struct { // This member is required. JobName *string - // The job queue where the job is submitted. You can specify either the name or the - // Amazon Resource Name (ARN) of the queue. + // The job queue where the job is submitted. You can specify either the name or + // the Amazon Resource Name (ARN) of the queue. // // This member is required. JobQueue *string // The array properties for the submitted job, such as the size of the array. The // array size can be between 2 and 10,000. If you specify array properties for a - // job, it becomes an array job. For more information, see Array Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the - // Batch User Guide. + // job, it becomes an array job. For more information, see Array Jobs (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) + // in the Batch User Guide. ArrayProperties *types.ArrayProperties // An object with various properties that override the defaults for the job @@ -114,8 +113,8 @@ type SubmitJobInput struct { // job definition. RetryStrategy *types.RetryStrategy - // The scheduling priority for the job. This only affects jobs in job queues with a - // fair share policy. Jobs with a higher scheduling priority are scheduled before + // The scheduling priority for the job. This only affects jobs in job queues with + // a fair share policy. Jobs with a higher scheduling priority are scheduled before // jobs with a lower scheduling priority. This overrides any scheduling priority in // the job definition. The minimum supported value is 0 and the maximum supported // value is 9999. @@ -128,9 +127,8 @@ type SubmitJobInput struct { // The tags that you apply to the job request to help you categorize and organize // your resources. Each tag consists of a key and an optional value. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web - // Services General Reference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in Amazon Web Services General Reference. Tags map[string]string // The timeout configuration for this SubmitJob operation. You can specify a @@ -139,8 +137,7 @@ type SubmitJobInput struct { // value for the timeout is 60 seconds. This configuration overrides any timeout // configuration specified in the job definition. For array jobs, child jobs have // the same timeout configuration as the parent job. For more information, see Job - // Timeouts - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) + // Timeouts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html) // in the Amazon Elastic Container Service Developer Guide. Timeout *types.JobTimeout diff --git a/service/batch/api_op_TagResource.go b/service/batch/api_op_TagResource.go index cfe102ed44f..9f852870d56 100644 --- a/service/batch/api_op_TagResource.go +++ b/service/batch/api_op_TagResource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource aren't specified in the request parameters, they // aren't changed. When a resource is deleted, the tags that are associated with // that resource are deleted as well. Batch resources that support tags are compute @@ -31,7 +31,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF return out, nil } -// Contains the parameters for TagResource. +// Contains the parameters for TagResource . type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that tags are added to. Batch @@ -42,11 +42,10 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The tags that you apply to the resource to help you categorize and organize your - // resources. Each tag consists of a key and an optional value. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web - // Services General Reference. + // The tags that you apply to the resource to help you categorize and organize + // your resources. Each tag consists of a key and an optional value. For more + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in Amazon Web Services General Reference. // // This member is required. Tags map[string]string diff --git a/service/batch/api_op_TerminateJob.go b/service/batch/api_op_TerminateJob.go index 1796614fbf6..0fc441eeddd 100644 --- a/service/batch/api_op_TerminateJob.go +++ b/service/batch/api_op_TerminateJob.go @@ -11,7 +11,7 @@ import ( ) // Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state -// are terminated, which causes them to transition to FAILED. Jobs that have not +// are terminated, which causes them to transition to FAILED . Jobs that have not // progressed to the STARTING state are cancelled. func (c *Client) TerminateJob(ctx context.Context, params *TerminateJobInput, optFns ...func(*Options)) (*TerminateJobOutput, error) { if params == nil { @@ -28,7 +28,7 @@ func (c *Client) TerminateJob(ctx context.Context, params *TerminateJobInput, op return out, nil } -// Contains the parameters for TerminateJob. +// Contains the parameters for TerminateJob . type TerminateJobInput struct { // The Batch job ID of the job to terminate. diff --git a/service/batch/api_op_UntagResource.go b/service/batch/api_op_UntagResource.go index c546c5788fa..126aa438bb2 100644 --- a/service/batch/api_op_UntagResource.go +++ b/service/batch/api_op_UntagResource.go @@ -26,7 +26,7 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, return out, nil } -// Contains the parameters for UntagResource. +// Contains the parameters for UntagResource . type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch diff --git a/service/batch/api_op_UpdateComputeEnvironment.go b/service/batch/api_op_UpdateComputeEnvironment.go index 26c5c6e1625..2641fef1a53 100644 --- a/service/batch/api_op_UpdateComputeEnvironment.go +++ b/service/batch/api_op_UpdateComputeEnvironment.go @@ -27,7 +27,7 @@ func (c *Client) UpdateComputeEnvironment(ctx context.Context, params *UpdateCom return out, nil } -// Contains the parameters for UpdateComputeEnvironment. +// Contains the parameters for UpdateComputeEnvironment . type UpdateComputeEnvironmentInput struct { // The name or full Amazon Resource Name (ARN) of the compute environment to @@ -38,23 +38,20 @@ type UpdateComputeEnvironmentInput struct { // Details of the compute resources managed by the compute environment. Required // for a managed compute environment. For more information, see Compute - // Environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. ComputeResources *types.ComputeResourceUpdate // The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make // calls to other Amazon Web Services services on your behalf. For more - // information, see Batch service IAM role - // (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in - // the Batch User Guide. If the compute environment has a service-linked role, it - // can't be changed to use a regular IAM role. Likewise, if the compute environment - // has a regular IAM role, it can't be changed to use a service-linked role. To - // update the parameters for the compute environment that require an infrastructure - // update to change, the AWSServiceRoleForBatch service-linked role must be used. - // For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) - // in the Batch User Guide. If your specified role has a path other than /, then + // information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // in the Batch User Guide. If the compute environment has a service-linked role, + // it can't be changed to use a regular IAM role. Likewise, if the compute + // environment has a regular IAM role, it can't be changed to use a service-linked + // role. To update the parameters for the compute environment that require an + // infrastructure update to change, the AWSServiceRoleForBatch service-linked role + // must be used. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // in the Batch User Guide. If your specified role has a path other than / , then // you must either specify the full role ARN (recommended) or prefix the role name // with the path. Depending on how you created your Batch service role, its ARN // might contain the service-role path prefix. When you only specify the name of @@ -65,21 +62,20 @@ type UpdateComputeEnvironmentInput struct { // The state of the compute environment. Compute environments in the ENABLED state // can accept jobs from a queue and scale in or out automatically based on the - // workload demand of its associated queues. If the state is ENABLED, then the + // workload demand of its associated queues. If the state is ENABLED , then the // Batch scheduler can attempt to place jobs from an associated job queue on the // compute resources within the environment. If the compute environment is managed, // then it can scale its instances out or in automatically, based on the job queue - // demand. If the state is DISABLED, then the Batch scheduler doesn't attempt to + // demand. If the state is DISABLED , then the Batch scheduler doesn't attempt to // place jobs within the environment. Jobs in a STARTING or RUNNING state continue // to progress normally. Managed compute environments in the DISABLED state don't // scale out. Compute environments in a DISABLED state may continue to incur // billing charges. To prevent additional charges, turn off and then delete the - // compute environment. For more information, see State - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) + // compute environment. For more information, see State (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) // in the Batch User Guide. When an instance is idle, the instance scales down to // the minvCpus value. However, the instance size doesn't change. For example, // consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus - // value of 36. This instance doesn't scale down to a c5.large instance. + // value of 36 . This instance doesn't scale down to a c5.large instance. State types.CEState // The maximum number of vCPUs expected to be used for an unmanaged compute @@ -91,8 +87,7 @@ type UpdateComputeEnvironmentInput struct { // Specifies the updated infrastructure update policy for the compute environment. // For more information about infrastructure updates, see Updating compute - // environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. UpdatePolicy *types.UpdatePolicy @@ -104,9 +99,9 @@ type UpdateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string - // The name of the compute environment. It can be up to 128 characters long. It can - // contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. It + // can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). ComputeEnvironmentName *string // Metadata pertaining to the operation's result. diff --git a/service/batch/api_op_UpdateJobQueue.go b/service/batch/api_op_UpdateJobQueue.go index 8af507ab6ca..f96b1f71dc0 100644 --- a/service/batch/api_op_UpdateJobQueue.go +++ b/service/batch/api_op_UpdateJobQueue.go @@ -27,7 +27,7 @@ func (c *Client) UpdateJobQueue(ctx context.Context, params *UpdateJobQueueInput return out, nil } -// Contains the parameters for UpdateJobQueue. +// Contains the parameters for UpdateJobQueue . type UpdateJobQueueInput struct { // The name or the Amazon Resource Name (ARN) of the job queue. @@ -39,10 +39,10 @@ type UpdateJobQueueInput struct { // relative to each other. This is one of the parameters used by the job scheduler // to determine which compute environment runs a given job. Compute environments // must be in the VALID state before you can associate them with a job queue. All - // of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE - // or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. All - // compute environments that are associated with a job queue must share the same - // architecture. Batch doesn't support mixing compute environment architecture + // of the compute environments must be either EC2 ( EC2 or SPOT ) or Fargate ( + // FARGATE or FARGATE_SPOT ). EC2 and Fargate compute environments can't be mixed. + // All compute environments that are associated with a job queue must share the + // same architecture. Batch doesn't support mixing compute environment architecture // types in a single job queue. ComputeEnvironmentOrder []types.ComputeEnvironmentOrder @@ -50,21 +50,21 @@ type UpdateJobQueueInput struct { // integer value for the priority parameter) are evaluated first when associated // with the same compute environment. Priority is determined in descending order. // For example, a job queue with a priority value of 10 is given scheduling - // preference over a job queue with a priority value of 1. All of the compute - // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or - // FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. + // preference over a job queue with a priority value of 1 . All of the compute + // environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or + // FARGATE_SPOT ). EC2 and Fargate compute environments can't be mixed. Priority *int32 - // Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue - // is created, the fair share scheduling policy can be replaced but not removed. - // The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For - // example, - // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. + // Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job + // queue is created, the fair share scheduling policy can be replaced but not + // removed. The format is + // aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, + // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy . SchedulingPolicyArn *string // Describes the queue's ability to accept new jobs. If the job queue state is - // ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't - // be added to the queue, but jobs already in the queue can finish. + // ENABLED , it can accept jobs. If the job queue state is DISABLED , new jobs + // can't be added to the queue, but jobs already in the queue can finish. State types.JQState noSmithyDocumentSerde diff --git a/service/batch/api_op_UpdateSchedulingPolicy.go b/service/batch/api_op_UpdateSchedulingPolicy.go index 277d9c72939..fd577342850 100644 --- a/service/batch/api_op_UpdateSchedulingPolicy.go +++ b/service/batch/api_op_UpdateSchedulingPolicy.go @@ -27,7 +27,7 @@ func (c *Client) UpdateSchedulingPolicy(ctx context.Context, params *UpdateSched return out, nil } -// Contains the parameters for UpdateSchedulingPolicy. +// Contains the parameters for UpdateSchedulingPolicy . type UpdateSchedulingPolicyInput struct { // The Amazon Resource Name (ARN) of the scheduling policy to update. diff --git a/service/batch/types/enums.go b/service/batch/types/enums.go index 3a07f4d8f2d..8f288088e79 100644 --- a/service/batch/types/enums.go +++ b/service/batch/types/enums.go @@ -247,9 +247,9 @@ const ( JobStatusFailed JobStatus = "FAILED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -319,9 +319,9 @@ const ( LogDriverSplunk LogDriver = "splunk" ) -// Values returns all known values for LogDriver. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LogDriver. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LogDriver) Values() []LogDriver { return []LogDriver{ "json-file", @@ -379,9 +379,9 @@ const ( ResourceTypeMemory ResourceType = "MEMORY" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "GPU", diff --git a/service/batch/types/types.go b/service/batch/types/types.go index 30f92742578..daa097d28d2 100644 --- a/service/batch/types/types.go +++ b/service/batch/types/types.go @@ -25,8 +25,8 @@ type ArrayPropertiesDetail struct { // The size of the array job. This parameter is returned for parent array jobs. Size *int32 - // A summary of the number of array job children in each available job status. This - // parameter is returned for parent array jobs. + // A summary of the number of array job children in each available job status. + // This parameter is returned for parent array jobs. StatusSummary map[string]int32 noSmithyDocumentSerde @@ -56,20 +56,20 @@ type AttemptContainerDetail struct { // The exit code for the job attempt. A non-zero exit code is considered failed. ExitCode *int32 - // The name of the CloudWatch Logs log stream that's associated with the container. - // The log group for Batch jobs is /aws/batch/job. Each container attempt receives - // a log stream name when they reach the RUNNING status. + // The name of the CloudWatch Logs log stream that's associated with the + // container. The log group for Batch jobs is /aws/batch/job . Each container + // attempt receives a log stream name when they reach the RUNNING status. LogStreamName *string // The network interfaces that are associated with the job attempt. NetworkInterfaces []NetworkInterface - // A short (255 max characters) human-readable string to provide additional details - // for a running or stopped container. + // A short (255 max characters) human-readable string to provide additional + // details for a running or stopped container. Reason *string - // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the - // job attempt. Each container attempt receives a task ARN when they reach the + // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with + // the job attempt. Each container attempt receives a task ARN when they reach the // STARTING status. TaskArn *string @@ -92,7 +92,7 @@ type AttemptDetail struct { // The Unix timestamp (in milliseconds) for when the attempt was stopped (when the // attempt transitioned from the RUNNING state to a terminal state, such as - // SUCCEEDED or FAILED). + // SUCCEEDED or FAILED ). StoppedAt *int64 noSmithyDocumentSerde @@ -106,21 +106,20 @@ type ComputeEnvironmentDetail struct { // This member is required. ComputeEnvironmentArn *string - // The name of the compute environment. It can be up to 128 characters long. It can - // contain uppercase and lowercase letters, numbers, hyphens (-), and underscores - // (_). + // The name of the compute environment. It can be up to 128 characters long. It + // can contain uppercase and lowercase letters, numbers, hyphens (-), and + // underscores (_). // // This member is required. ComputeEnvironmentName *string - // The compute resources defined for the compute environment. For more information, - // see Compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // The compute resources defined for the compute environment. For more + // information, see Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. ComputeResources *ComputeResource // The orchestration type of the compute environment. The valid values are ECS - // (default) or EKS. + // (default) or EKS . ContainerOrchestrationType OrchestrationType // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the @@ -129,35 +128,33 @@ type ComputeEnvironmentDetail struct { // The configuration for the Amazon EKS cluster that supports the Batch compute // environment. Only specify this parameter if the containerOrchestrationType is - // EKS. + // EKS . EksConfiguration *EksConfiguration // The service role that's associated with the compute environment that allows // Batch to make calls to Amazon Web Services API operations on your behalf. For - // more information, see Batch service IAM role - // (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in - // the Batch User Guide. + // more information, see Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // in the Batch User Guide. ServiceRole *string - // The state of the compute environment. The valid values are ENABLED or DISABLED. - // If the state is ENABLED, then the Batch scheduler can attempt to place jobs from - // an associated job queue on the compute resources within the environment. If the - // compute environment is managed, then it can scale its instances out or in - // automatically based on the job queue demand. If the state is DISABLED, then the + // The state of the compute environment. The valid values are ENABLED or DISABLED . + // If the state is ENABLED , then the Batch scheduler can attempt to place jobs + // from an associated job queue on the compute resources within the environment. If + // the compute environment is managed, then it can scale its instances out or in + // automatically based on the job queue demand. If the state is DISABLED , then the // Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a // STARTING or RUNNING state continue to progress normally. Managed compute // environments in the DISABLED state don't scale out. Compute environments in a // DISABLED state may continue to incur billing charges. To prevent additional // charges, turn off and then delete the compute environment. For more information, - // see State - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) + // see State (https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) // in the Batch User Guide. When an instance is idle, the instance scales down to // the minvCpus value. However, the instance size doesn't change. For example, // consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus - // value of 36. This instance doesn't scale down to a c5.large instance. + // value of 36 . This instance doesn't scale down to a c5.large instance. State CEState - // The current status of the compute environment (for example, CREATING or VALID). + // The current status of the compute environment (for example, CREATING or VALID ). Status CEStatus // A short, human-readable string to provide additional details for the current @@ -167,9 +164,8 @@ type ComputeEnvironmentDetail struct { // The tags applied to the compute environment. Tags map[string]string - // The type of the compute environment: MANAGED or UNMANAGED. For more information, - // see Compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // The type of the compute environment: MANAGED or UNMANAGED . For more + // information, see Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. Type CEType @@ -177,9 +173,8 @@ type ComputeEnvironmentDetail struct { // environment. UnmanagedvCpus *int32 - // Specifies the infrastructure update policy for the compute environment. For more - // information about infrastructure updates, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // Specifies the infrastructure update policy for the compute environment. For + // more information about infrastructure updates, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. UpdatePolicy *UpdatePolicy @@ -193,11 +188,11 @@ type ComputeEnvironmentDetail struct { // queue. Compute environments are tried in ascending order. For example, if two // compute environments are associated with a job queue, the compute environment // with a lower order integer value is tried for job placement first. Compute -// environments must be in the VALID state before you can associate them with a job -// queue. All of the compute environments must be either EC2 (EC2 or SPOT) or -// Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be -// mixed. All compute environments that are associated with a job queue must share -// the same architecture. Batch doesn't support mixing compute environment +// environments must be in the VALID state before you can associate them with a +// job queue. All of the compute environments must be either EC2 ( EC2 or SPOT ) or +// Fargate ( FARGATE or FARGATE_SPOT ); EC2 and Fargate compute environments can't +// be mixed. All compute environments that are associated with a job queue must +// share the same architecture. Batch doesn't support mixing compute environment // architecture types in a single job queue. type ComputeEnvironmentOrder struct { @@ -208,8 +203,8 @@ type ComputeEnvironmentOrder struct { // The order of the compute environment. Compute environments are tried in // ascending order. For example, if two compute environments are associated with a - // job queue, the compute environment with a lower order integer value is tried for - // job placement first. + // job queue, the compute environment with a lower order integer value is tried + // for job placement first. // // This member is required. Order *int32 @@ -218,15 +213,14 @@ type ComputeEnvironmentOrder struct { } // An object that represents an Batch compute resource. For more information, see -// Compute environments -// (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) +// Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the Batch User Guide. type ComputeResource struct { // The maximum number of Amazon EC2 vCPUs that a compute environment can reach. - // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies - // using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot - // Instances, Batch might need to exceed maxvCpus to meet your capacity + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation + // strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using + // Spot Instances, Batch might need to exceed maxvCpus to meet your capacity // requirements. In this event, Batch never exceeds maxvCpus by more than a single // instance. For example, no more than a single instance from among those specified // in your compute environment is allocated. @@ -236,56 +230,46 @@ type ComputeResource struct { // The VPC subnets where the compute resources are launched. These subnets must be // within the same VPC. Fargate compute resources can contain up to 16 subnets. For - // more information, see VPCs and subnets - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the - // Amazon VPC User Guide. Batch on Amazon EC2 and Batch on Amazon EKS support Local - // Zones. For more information, see Local Zones - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) + // more information, see VPCs and subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // in the Amazon VPC User Guide. Batch on Amazon EC2 and Batch on Amazon EKS + // support Local Zones. For more information, see Local Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) // in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web - // Services Local Zones - // (https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) in the - // Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, - // and Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) + // Services Local Zones (https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) + // in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength + // Zones, and Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) // in the Amazon ECS Developer Guide. Batch on Fargate doesn't currently support // Local Zones. // // This member is required. Subnets []string - // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more - // information, see Compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) - // in the Batch User Guide. If you choose SPOT, you must also specify an Amazon EC2 - // Spot Fleet role with the spotIamFleetRole parameter. For more information, see - // Amazon EC2 spot fleet role - // (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in - // the Batch User Guide. + // The type of compute environment: EC2 , SPOT , FARGATE , or FARGATE_SPOT . For + // more information, see Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // in the Batch User Guide. If you choose SPOT , you must also specify an Amazon + // EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, + // see Amazon EC2 spot fleet role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) + // in the Batch User Guide. // // This member is required. Type CRType // The allocation strategy to use for the compute resource if not enough instances // of the best fitting instance type can be allocated. This might be because of - // availability of the instance type in the Region or Amazon EC2 service limits - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html). - // For more information, see Allocation strategies - // (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) + // availability of the instance type in the Region or Amazon EC2 service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) + // . For more information, see Allocation strategies (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. BEST_FIT (default) Batch selects // an instance type that best fits the needs of the jobs with a preference for the // lowest-cost instance type. If additional instances of the selected instance type // aren't available, Batch waits for the additional instances to be available. If // there aren't enough instances available or the user is reaching Amazon EC2 - // service limits - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html), - // additional jobs aren't run until the currently running jobs are completed. This - // allocation strategy keeps costs lower but can limit scaling. If you're using - // Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute - // resources that use a BEST_FIT allocation strategy don't support infrastructure - // updates and can't update some parameters. For more information, see Updating - // compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) + // , additional jobs aren't run until the currently running jobs are completed. + // This allocation strategy keeps costs lower but can limit scaling. If you're + // using Spot Fleets with BEST_FIT , the Spot Fleet IAM Role must be specified. + // Compute resources that use a BEST_FIT allocation strategy don't support + // infrastructure updates and can't update some parameters. For more information, + // see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. BEST_FIT_PROGRESSIVE Batch selects additional instance // types that are large enough to meet the requirements of the jobs in the queue. // Its preference is for instance types with lower cost vCPUs. If additional @@ -319,7 +303,7 @@ type ComputeResource struct { // Provides information that's used to select Amazon Machine Images (AMIs) for EC2 // instances in the compute environment. If Ec2Configuration isn't specified, the - // default is ECS_AL2. One or two values can be provided. This parameter isn't + // default is ECS_AL2 . One or two values can be provided. This parameter isn't // applicable to jobs that are running on Fargate resources. Don't specify it. Ec2Configuration []Ec2Configuration @@ -338,8 +322,7 @@ type ComputeResource struct { // environment uses A1 instance types, the compute resource AMI that you choose // must support ARM instances. Amazon ECS vends both x86 and ARM versions of the // Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon - // ECS-optimized Amazon Linux 2 AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) + // ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) // in the Amazon Elastic Container Service Developer Guide. // // Deprecated: This field is deprecated, use ec2Configuration[].imageIdOverride @@ -348,17 +331,16 @@ type ComputeResource struct { // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute // environment. You can specify the short name or full Amazon Resource Name (ARN) - // of an instance profile. For example, ecsInstanceRole or + // of an instance profile. For example, ecsInstanceRole or // arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see - // Amazon ECS instance role - // (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in - // the Batch User Guide. This parameter isn't applicable to jobs that are running - // on Fargate resources. Don't specify it. + // Amazon ECS instance role (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) + // in the Batch User Guide. This parameter isn't applicable to jobs that are + // running on Fargate resources. Don't specify it. InstanceRole *string // The instances types that can be launched. You can specify instance families to - // launch any instance type within those families (for example, c5 or p3), or you - // can specify specific sizes within a family (such as c5.8xlarge). You can also + // launch any instance type within those families (for example, c5 or p3 ), or you + // can specify specific sizes within a family (such as c5.8xlarge ). You can also // choose optimal to select instance types (from the C4, M4, and R4 instance // families) that match the demand of your job queues. This parameter isn't // applicable to jobs that are running on Fargate resources. Don't specify it. When @@ -371,18 +353,17 @@ type ComputeResource struct { InstanceTypes []string // The launch template to use for your compute resources. Any other compute - // resource parameters that you specify in a CreateComputeEnvironment API operation - // override the same parameters in the launch template. You must specify either the - // launch template ID or launch template name in the request, but not both. For - // more information, see Launch template support - // (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in - // the Batch User Guide. This parameter isn't applicable to jobs that are running - // on Fargate resources. Don't specify it. + // resource parameters that you specify in a CreateComputeEnvironment API + // operation override the same parameters in the launch template. You must specify + // either the launch template ID or launch template name in the request, but not + // both. For more information, see Launch template support (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) + // in the Batch User Guide. This parameter isn't applicable to jobs that are + // running on Fargate resources. Don't specify it. LaunchTemplate *LaunchTemplateSpecification - // The minimum number of Amazon EC2 vCPUs that an environment should maintain (even - // if the compute environment is DISABLED). This parameter isn't applicable to jobs - // that are running on Fargate resources. Don't specify it. + // The minimum number of Amazon EC2 vCPUs that an environment should maintain + // (even if the compute environment is DISABLED ). This parameter isn't applicable + // to jobs that are running on Fargate resources. Don't specify it. MinvCpus *int32 // The Amazon EC2 placement group to associate with your compute resources. If you @@ -390,45 +371,41 @@ type ComputeResource struct { // should consider creating a cluster placement group and associate it with your // compute resources. This keeps your multi-node parallel job on a logical grouping // of instances within a single Availability Zone with high network flow potential. - // For more information, see Placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. This parameter isn't applicable - // to jobs that are running on Fargate resources. Don't specify it. + // For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) + // in the Amazon EC2 User Guide for Linux Instances. This parameter isn't + // applicable to jobs that are running on Fargate resources. Don't specify it. PlacementGroup *string // The Amazon EC2 security groups that are associated with instances launched in // the compute environment. One or more security groups must be specified, either - // in securityGroupIds or using a launch template referenced in launchTemplate. + // in securityGroupIds or using a launch template referenced in launchTemplate . // This parameter is required for jobs that are running on Fargate resources and // must contain at least one security group. Fargate doesn't support launch // templates. If security groups are specified using both securityGroupIds and - // launchTemplate, the values in securityGroupIds are used. + // launchTemplate , the values in securityGroupIds are used. SecurityGroupIds []string // The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to - // a SPOT compute environment. This role is required if the allocation strategy set - // to BEST_FIT or if the allocation strategy isn't specified. For more information, - // see Amazon EC2 spot fleet role - // (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in - // the Batch User Guide. This parameter isn't applicable to jobs that are running - // on Fargate resources. Don't specify it. To tag your Spot Instances on creation, - // the Spot Fleet IAM role specified here must use the newer + // a SPOT compute environment. This role is required if the allocation strategy + // set to BEST_FIT or if the allocation strategy isn't specified. For more + // information, see Amazon EC2 spot fleet role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) + // in the Batch User Guide. This parameter isn't applicable to jobs that are + // running on Fargate resources. Don't specify it. To tag your Spot Instances on + // creation, the Spot Fleet IAM role specified here must use the newer // AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended // AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to // tag Spot Instances. For more information, see Spot instances not tagged on - // creation - // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag) + // creation (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag) // in the Batch User Guide. SpotIamFleetRole *string // Key-value pair tags to be applied to EC2 resources that are launched in the - // compute environment. For Batch, these take the form of "String1": "String2", - // where String1 is the tag key and String2 is the tag value-for example, { "Name": - // "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch - // instances in the Amazon EC2 console. Updating these tags requires an + // compute environment. For Batch, these take the form of "String1": "String2" , + // where String1 is the tag key and String2 is the tag value-for example, { + // "Name": "Batch Instance - C4OnDemand" } . This is helpful for recognizing your + // Batch instances in the Amazon EC2 console. Updating these tags requires an // infrastructure update to the compute environment. For more information, see - // Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. These tags aren't seen when using the Batch // ListTagsForResource API operation. This parameter isn't applicable to jobs that // are running on Fargate resources. Don't specify it. @@ -438,22 +415,18 @@ type ComputeResource struct { } // An object that represents the attributes of a compute environment that can be -// updated. For more information, see Updating compute environments -// (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) +// updated. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. type ComputeResourceUpdate struct { // The allocation strategy to use for the compute resource if there's not enough // instances of the best fitting instance type that can be allocated. This might be - // because of availability of the instance type in the Region or Amazon EC2 service - // limits - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html). - // For more information, see Allocation strategies - // (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) + // because of availability of the instance type in the Region or Amazon EC2 + // service limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) + // . For more information, see Allocation strategies (https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) // in the Batch User Guide. When updating a compute environment, changing the // allocation strategy requires an infrastructure update of the compute - // environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. BEST_FIT isn't supported when updating a compute // environment. This parameter isn't applicable to jobs that are running on Fargate // resources. Don't specify it. BEST_FIT_PROGRESSIVE Batch selects additional @@ -478,8 +451,7 @@ type ComputeResourceUpdate struct { // lowest (market) price and never more than your maximum percentage. For most use // cases, we recommend leaving this field empty. When updating a compute // environment, changing the bid percentage requires an infrastructure update of - // the compute environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // the compute environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. BidPercentage *int32 @@ -492,19 +464,17 @@ type ComputeResourceUpdate struct { // compute environments using Amazon EKS clusters. When you update the desiredvCpus // setting, the value must be between the minvCpus and maxvCpus values. // Additionally, the updated desiredvCpus value must be greater than or equal to - // the current desiredvCpus value. For more information, see Troubleshooting Batch - // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update) + // the current desiredvCpus value. For more information, see Troubleshooting Batch (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update) // in the Batch User Guide. DesiredvCpus *int32 // Provides information used to select Amazon Machine Images (AMIs) for EC2 // instances in the compute environment. If Ec2Configuration isn't specified, the - // default is ECS_AL2. When updating a compute environment, changing this setting + // default is ECS_AL2 . When updating a compute environment, changing this setting // requires an infrastructure update of the compute environment. For more - // information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. To remove the EC2 configuration and any custom AMI ID - // specified in imageIdOverride, set this value to an empty string. One or two + // specified in imageIdOverride , set this value to an empty string. One or two // values can be provided. This parameter isn't applicable to jobs that are running // on Fargate resources. Don't specify it. Ec2Configuration []Ec2Configuration @@ -514,8 +484,7 @@ type ComputeResourceUpdate struct { // remove the Amazon EC2 key pair, set this value to an empty string. When updating // a compute environment, changing the EC2 key pair requires an infrastructure // update of the compute environment. For more information, see Updating compute - // environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. Ec2KeyPair *string @@ -525,8 +494,7 @@ type ComputeResourceUpdate struct { // Ec2Configuration structure. To remove the custom AMI ID and use the default AMI // ID, set this value to an empty string. When updating a compute environment, // changing the AMI ID requires an infrastructure update of the compute - // environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. The AMI that you choose for a // compute environment must match the architecture of the instance types that you @@ -534,33 +502,29 @@ type ComputeResourceUpdate struct { // environment uses A1 instance types, the compute resource AMI that you choose // must support ARM instances. Amazon ECS vends both x86 and ARM versions of the // Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon - // ECS-optimized Amazon Linux 2 AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) + // ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) // in the Amazon Elastic Container Service Developer Guide. ImageId *string // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute // environment. You can specify the short name or full Amazon Resource Name (ARN) - // of an instance profile. For example, ecsInstanceRole or + // of an instance profile. For example, ecsInstanceRole or // arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see - // Amazon ECS instance role - // (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in - // the Batch User Guide. When updating a compute environment, changing this setting - // requires an infrastructure update of the compute environment. For more - // information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // Amazon ECS instance role (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) + // in the Batch User Guide. When updating a compute environment, changing this + // setting requires an infrastructure update of the compute environment. For more + // information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. InstanceRole *string // The instances types that can be launched. You can specify instance families to - // launch any instance type within those families (for example, c5 or p3), or you - // can specify specific sizes within a family (such as c5.8xlarge). You can also + // launch any instance type within those families (for example, c5 or p3 ), or you + // can specify specific sizes within a family (such as c5.8xlarge ). You can also // choose optimal to select instance types (from the C4, M4, and R4 instance // families) that match the demand of your job queues. When updating a compute // environment, changing this setting requires an infrastructure update of the - // compute environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // compute environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. When you create a compute // environment, the instance types that you select for the compute environment must @@ -573,18 +537,16 @@ type ComputeResourceUpdate struct { // The updated launch template to use for your compute resources. You must specify // either the launch template ID or launch template name in the request, but not - // both. For more information, see Launch template support - // (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in - // the Batch User Guide. To remove the custom launch template and use the default - // launch template, set launchTemplateId or launchTemplateName member of the launch - // template specification to an empty string. Removing the launch template from a - // compute environment will not remove the AMI specified in the launch template. In - // order to update the AMI specified in a launch template, the - // updateToLatestImageVersion parameter must be set to true. When updating a + // both. For more information, see Launch template support (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) + // in the Batch User Guide. To remove the custom launch template and use the + // default launch template, set launchTemplateId or launchTemplateName member of + // the launch template specification to an empty string. Removing the launch + // template from a compute environment will not remove the AMI specified in the + // launch template. In order to update the AMI specified in a launch template, the + // updateToLatestImageVersion parameter must be set to true . When updating a // compute environment, changing the launch template requires an infrastructure // update of the compute environment. For more information, see Updating compute - // environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. LaunchTemplate *LaunchTemplateSpecification @@ -598,9 +560,9 @@ type ComputeResourceUpdate struct { // environment. MaxvCpus *int32 - // The minimum number of Amazon EC2 vCPUs that an environment should maintain (even - // if the compute environment is DISABLED). This parameter isn't applicable to jobs - // that are running on Fargate resources. Don't specify it. + // The minimum number of Amazon EC2 vCPUs that an environment should maintain + // (even if the compute environment is DISABLED ). This parameter isn't applicable + // to jobs that are running on Fargate resources. Don't specify it. MinvCpus *int32 // The Amazon EC2 placement group to associate with your compute resources. If you @@ -608,12 +570,10 @@ type ComputeResourceUpdate struct { // should consider creating a cluster placement group and associate it with your // compute resources. This keeps your multi-node parallel job on a logical grouping // of instances within a single Availability Zone with high network flow potential. - // For more information, see Placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in - // the Amazon EC2 User Guide for Linux Instances. When updating a compute + // For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) + // in the Amazon EC2 User Guide for Linux Instances. When updating a compute // environment, changing the placement group requires an infrastructure update of - // the compute environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // the compute environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. PlacementGroup *string @@ -626,8 +586,7 @@ type ComputeResourceUpdate struct { // list removes the security groups from the compute resource. When updating a // compute environment, changing the EC2 security groups requires an infrastructure // update of the compute environment. For more information, see Updating compute - // environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. SecurityGroupIds []string @@ -639,60 +598,50 @@ type ComputeResourceUpdate struct { // subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in // the Amazon VPC User Guide. When updating a compute environment, changing the VPC // subnets requires an infrastructure update of the compute environment. For more - // information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. Batch on Amazon EC2 and Batch on Amazon EKS support - // Local Zones. For more information, see Local Zones - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) + // Local Zones. For more information, see Local Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) // in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web - // Services Local Zones - // (https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) in the - // Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, - // and Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) + // Services Local Zones (https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) + // in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength + // Zones, and Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) // in the Amazon ECS Developer Guide. Batch on Fargate doesn't currently support // Local Zones. Subnets []string // Key-value pair tags to be applied to EC2 resources that are launched in the - // compute environment. For Batch, these take the form of "String1": "String2", - // where String1 is the tag key and String2 is the tag value-for example, { "Name": - // "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch - // instances in the Amazon EC2 console. These tags aren't seen when using the Batch - // ListTagsForResource API operation. When updating a compute environment, changing - // this setting requires an infrastructure update of the compute environment. For - // more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // compute environment. For Batch, these take the form of "String1": "String2" , + // where String1 is the tag key and String2 is the tag value-for example, { + // "Name": "Batch Instance - C4OnDemand" } . This is helpful for recognizing your + // Batch instances in the Amazon EC2 console. These tags aren't seen when using the + // Batch ListTagsForResource API operation. When updating a compute environment, + // changing this setting requires an infrastructure update of the compute + // environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. This parameter isn't applicable to jobs that are // running on Fargate resources. Don't specify it. Tags map[string]string - // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more - // information, see Compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) - // in the Batch User Guide. If you choose SPOT, you must also specify an Amazon EC2 - // Spot Fleet role with the spotIamFleetRole parameter. For more information, see - // Amazon EC2 spot fleet role - // (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in - // the Batch User Guide. When updating a compute environment, changing the type of - // a compute environment requires an infrastructure update of the compute - // environment. For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // The type of compute environment: EC2 , SPOT , FARGATE , or FARGATE_SPOT . For + // more information, see Compute environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // in the Batch User Guide. If you choose SPOT , you must also specify an Amazon + // EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, + // see Amazon EC2 spot fleet role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) + // in the Batch User Guide. When updating a compute environment, changing the type + // of a compute environment requires an infrastructure update of the compute + // environment. For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. Type CRType // Specifies whether the AMI ID is updated to the latest one that's supported by // Batch when the compute environment has an infrastructure update. The default - // value is false. An AMI ID can either be specified in the imageId or + // value is false . An AMI ID can either be specified in the imageId or // imageIdOverride parameters or be determined by the launch template that's // specified in the launchTemplate parameter. If an AMI ID is specified any of // these ways, this parameter is ignored. For more information about to update AMI - // IDs during an infrastructure update, see Updating the AMI ID - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) + // IDs during an infrastructure update, see Updating the AMI ID (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) // in the Batch User Guide. When updating a compute environment, changing this // setting requires an infrastructure update of the compute environment. For more - // information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. UpdateToLatestImageVersion *bool @@ -710,7 +659,7 @@ type ContainerDetail struct { ContainerInstanceArn *string // The environment variables to pass to a container. Environment variables cannot - // start with "AWS_BATCH". This naming convention is reserved for variables that + // start with " AWS_BATCH ". This naming convention is reserved for variables that // Batch sets. Environment []KeyValuePair @@ -720,9 +669,8 @@ type ContainerDetail struct { EphemeralStorage *EphemeralStorage // The Amazon Resource Name (ARN) of the execution role that Batch can assume. For - // more information, see Batch execution IAM role - // (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in - // the Batch User Guide. + // more information, see Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) + // in the Batch User Guide. ExecutionRoleArn *string // The exit code to return upon completion. @@ -735,9 +683,9 @@ type ContainerDetail struct { // The image used to start the container. Image *string - // The instance type of the underlying host infrastructure of a multi-node parallel - // job. This parameter isn't applicable to jobs that are running on Fargate - // resources. + // The instance type of the underlying host infrastructure of a multi-node + // parallel job. This parameter isn't applicable to jobs that are running on + // Fargate resources. InstanceType *string // The Amazon Resource Name (ARN) that's associated with the job when run. @@ -748,43 +696,40 @@ type ContainerDetail struct { LinuxParameters *LinuxParameters // The log configuration specification for the container. This parameter maps to - // LogConfig in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --log-driver option to docker run - // (https://docs.docker.com/engine/reference/run/). By default, containers use the - // same logging driver that the Docker daemon uses. However, the container might - // use a different logging driver than the Docker daemon by specifying a log driver - // with this parameter in the container definition. To use a different logging - // driver for a container, the log system must be configured properly on the - // container instance. Or, alternatively, it must be configured on a different log - // server for remote logging options. For more information on the options for - // different supported log drivers, see Configure logging drivers - // (https://docs.docker.com/engine/admin/logging/overview/) in the Docker - // documentation. Batch currently supports a subset of the logging drivers - // available to the Docker daemon (shown in the LogConfiguration data type). - // Additional log drivers might be available in future releases of the Amazon ECS - // container agent. This parameter requires version 1.18 of the Docker Remote API - // or greater on your container instance. To check the Docker Remote API version on - // your container instance, log in to your container instance and run the following - // command: sudo docker version | grep "Server API version" The Amazon ECS - // container agent running on a container instance must register the logging - // drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS - // environment variable before containers placed on that instance can use these log - // configuration options. For more information, see Amazon ECS container agent - // configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/) + // . By default, containers use the same logging driver that the Docker daemon + // uses. However, the container might use a different logging driver than the + // Docker daemon by specifying a log driver with this parameter in the container + // definition. To use a different logging driver for a container, the log system + // must be configured properly on the container instance. Or, alternatively, it + // must be configured on a different log server for remote logging options. For + // more information on the options for different supported log drivers, see + // Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) + // in the Docker documentation. Batch currently supports a subset of the logging + // drivers available to the Docker daemon (shown in the LogConfiguration data + // type). Additional log drivers might be available in future releases of the + // Amazon ECS container agent. This parameter requires version 1.18 of the Docker + // Remote API or greater on your container instance. To check the Docker Remote API + // version on your container instance, log in to your container instance and run + // the following command: sudo docker version | grep "Server API version" The + // Amazon ECS container agent running on a container instance must register the + // logging drivers available on that instance with the + // ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on + // that instance can use these log configuration options. For more information, see + // Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. LogConfiguration *LogConfiguration // The name of the Amazon CloudWatch Logs log stream that's associated with the - // container. The log group for Batch jobs is /aws/batch/job. Each container + // container. The log group for Batch jobs is /aws/batch/job . Each container // attempt receives a log stream name when they reach the RUNNING status. LogStreamName *string // For jobs running on EC2 resources that didn't specify memory requirements using - // resourceRequirements, the number of MiB of memory reserved for the job. For - // other jobs, including all run on Fargate resources, see resourceRequirements. + // resourceRequirements , the number of MiB of memory reserved for the job. For + // other jobs, including all run on Fargate resources, see resourceRequirements . Memory *int32 // The mount points for data volumes in your container. @@ -798,67 +743,63 @@ type ContainerDetail struct { NetworkInterfaces []NetworkInterface // When this parameter is true, the container is given elevated permissions on the - // host container instance (similar to the root user). The default value is false. + // host container instance (similar to the root user). The default value is false . // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided, or specified as false. + // and shouldn't be provided, or specified as false . Privileged *bool - // When this parameter is true, the container is given read-only access to its root - // file system. This parameter maps to ReadonlyRootfs in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --read-only option to docker run - // (https://docs.docker.com/engine/reference/commandline/run/). + // When this parameter is true, the container is given read-only access to its + // root file system. This parameter maps to ReadonlyRootfs in the Create a + // container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section + // of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // --read-only option to docker run (https://docs.docker.com/engine/reference/commandline/run/) + // . ReadonlyRootFilesystem *bool - // A short (255 max characters) human-readable string to provide additional details - // for a running or stopped container. + // A short (255 max characters) human-readable string to provide additional + // details for a running or stopped container. Reason *string // The type and amount of resources to assign to a container. The supported - // resources include GPU, MEMORY, and VCPU. + // resources include GPU , MEMORY , and VCPU . ResourceRequirements []ResourceRequirement // The secrets to pass to the container. For more information, see Specifying - // sensitive data - // (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) + // sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) // in the Batch User Guide. Secrets []Secret - // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the - // container job. Each container attempt receives a task ARN when they reach the - // STARTING status. + // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with + // the container job. Each container attempt receives a task ARN when they reach + // the STARTING status. TaskArn *string // A list of ulimit values to set in the container. This parameter maps to Ulimits - // in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --ulimit - // option to docker run (https://docs.docker.com/engine/reference/run/). This - // parameter isn't applicable to jobs that are running on Fargate resources. + // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter isn't applicable to jobs that are running on Fargate resources. Ulimits []Ulimit // The user name to use inside the container. This parameter maps to User in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --user - // option to docker run (https://docs.docker.com/engine/reference/run/). + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --user option to docker run (https://docs.docker.com/engine/reference/run/) + // . User *string // The number of vCPUs reserved for the container. For jobs that run on EC2 // resources, you can specify the vCPU requirement for the job using - // resourceRequirements, but you can't specify the vCPU requirements in both the + // resourceRequirements , but you can't specify the vCPU requirements in both the // vcpus and resourceRequirements object. This parameter maps to CpuShares in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to - // 1,024 CPU shares. You must specify at least one vCPU. This is required but can - // be specified in several places. It must be specified for each node at least - // once. This parameter isn't applicable to jobs that run on Fargate resources. For - // jobs that run on Fargate resources, you must specify the vCPU requirement for - // the job using resourceRequirements. + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/) + // . Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one + // vCPU. This is required but can be specified in several places. It must be + // specified for each node at least once. This parameter isn't applicable to jobs + // that run on Fargate resources. For jobs that run on Fargate resources, you must + // specify the vCPU requirement for the job using resourceRequirements . Vcpus *int32 // A list of volumes that are associated with the job. @@ -870,14 +811,14 @@ type ContainerDetail struct { // The overrides that should be sent to a container. type ContainerOverrides struct { - // The command to send to the container that overrides the default command from the - // Docker image or the job definition. + // The command to send to the container that overrides the default command from + // the Docker image or the job definition. Command []string // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch, or you can override the // existing environment variables from the Docker image or the job definition. - // Environment variables cannot start with "AWS_BATCH". This naming convention is + // Environment variables cannot start with " AWS_BATCH ". This naming convention is // reserved for variables that Batch sets. Environment []KeyValuePair @@ -895,16 +836,15 @@ type ContainerOverrides struct { // resourceRequirements structure in the job definition, resourceRequirements must // be specified in the SubmitJob request, with type set to MEMORY and value set to // the new value. For more information, see Can't override job definition resource - // requirements - // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements) + // requirements (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements) // in the Batch User Guide. // // Deprecated: This field is deprecated, use resourceRequirements instead. Memory *int32 // The type and amount of resources to assign to a container. This overrides the - // settings in the job definition. The supported resources include GPU, MEMORY, and - // VCPU. + // settings in the job definition. The supported resources include GPU , MEMORY , + // and VCPU . ResourceRequirements []ResourceRequirement // This parameter is deprecated, use resourceRequirements to override the vcpus @@ -915,8 +855,7 @@ type ContainerOverrides struct { // override vCPU requirements that are specified in the resourceRequirements // structure in the job definition, resourceRequirements must be specified in the // SubmitJob request, with type set to VCPU and value set to the new value. For - // more information, see Can't override job definition resource requirements - // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements) + // more information, see Can't override job definition resource requirements (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements) // in the Batch User Guide. // // Deprecated: This field is deprecated, use resourceRequirements instead. @@ -930,34 +869,32 @@ type ContainerOverrides struct { type ContainerProperties struct { // The command that's passed to the container. This parameter maps to Cmd in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the COMMAND - // parameter to docker run (https://docs.docker.com/engine/reference/run/). For - // more information, see https://docs.docker.com/engine/reference/builder/#cmd - // (https://docs.docker.com/engine/reference/builder/#cmd). + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/) + // . For more information, see + // https://docs.docker.com/engine/reference/builder/#cmd (https://docs.docker.com/engine/reference/builder/#cmd) + // . Command []string // The environment variables to pass to a container. This parameter maps to Env in - // the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --env - // option to docker run (https://docs.docker.com/engine/reference/run/). We don't - // recommend using plaintext environment variables for sensitive information, such - // as credential data. Environment variables cannot start with "AWS_BATCH". This - // naming convention is reserved for variables that Batch sets. + // the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --env option to docker run (https://docs.docker.com/engine/reference/run/) + // . We don't recommend using plaintext environment variables for sensitive + // information, such as credential data. Environment variables cannot start with " + // AWS_BATCH ". This naming convention is reserved for variables that Batch sets. Environment []KeyValuePair - // The amount of ephemeral storage to allocate for the task. This parameter is used - // to expand the total amount of ephemeral storage available, beyond the default - // amount, for tasks hosted on Fargate. + // The amount of ephemeral storage to allocate for the task. This parameter is + // used to expand the total amount of ephemeral storage available, beyond the + // default amount, for tasks hosted on Fargate. EphemeralStorage *EphemeralStorage // The Amazon Resource Name (ARN) of the execution role that Batch can assume. For // jobs that run on Fargate resources, you must provide an execution role. For more - // information, see Batch execution IAM role - // (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in - // the Batch User Guide. + // information, see Batch execution IAM role (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) + // in the Batch User Guide. ExecutionRoleArn *string // The platform configuration for jobs that are running on Fargate resources. Jobs @@ -966,35 +903,26 @@ type ContainerProperties struct { // The image used to start a container. This string is passed directly to the // Docker daemon. Images in the Docker Hub registry are available by default. Other - // repositories are specified with repository-url/image:tag . It can be 255 + // repositories are specified with repository-url/image:tag . It can be 255 // characters long. It can contain uppercase and lowercase letters, numbers, // hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and - // number signs (#). This parameter maps to Image in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the IMAGE - // parameter of docker run (https://docs.docker.com/engine/reference/run/). Docker - // image architecture must match the processor architecture of the compute + // number signs (#). This parameter maps to Image in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/) + // . Docker image architecture must match the processor architecture of the compute // resources that they're scheduled on. For example, ARM-based Docker images can // only run on ARM-based compute resources. - // - // * Images in Amazon ECR Public - // repositories use the full registry/repository[:tag] or - // registry/repository[@digest] naming conventions. For example, - // public.ecr.aws/registry_alias/my-web-app:latest . - // - // * Images in Amazon ECR - // repositories use the full registry and repository URI (for example, - // 123456789012.dkr.ecr..amazonaws.com/). - // - // * Images in official repositories on - // Docker Hub use a single name (for example, ubuntu or mongo). - // - // * Images in other - // repositories on Docker Hub are qualified with an organization name (for example, - // amazon/amazon-ecs-agent). - // - // * Images in other online repositories are qualified - // further by a domain name (for example, quay.io/assemblyline/ubuntu). + // - Images in Amazon ECR Public repositories use the full + // registry/repository[:tag] or registry/repository[@digest] naming conventions. + // For example, public.ecr.aws/registry_alias/my-web-app:latest . + // - Images in Amazon ECR repositories use the full registry and repository URI + // (for example, 123456789012.dkr.ecr..amazonaws.com/ ). + // - Images in official repositories on Docker Hub use a single name (for + // example, ubuntu or mongo ). + // - Images in other repositories on Docker Hub are qualified with an + // organization name (for example, amazon/amazon-ecs-agent ). + // - Images in other online repositories are qualified further by a domain name + // (for example, quay.io/assemblyline/ubuntu ). Image *string // The instance type to use for a multi-node parallel job. All node groups in a @@ -1003,9 +931,9 @@ type ContainerProperties struct { // and shouldn't be provided. InstanceType *string - // The Amazon Resource Name (ARN) of the IAM role that the container can assume for - // Amazon Web Services permissions. For more information, see IAM roles for tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // The Amazon Resource Name (ARN) of the IAM role that the container can assume + // for Amazon Web Services permissions. For more information, see IAM roles for + // tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. JobRoleArn *string @@ -1014,30 +942,27 @@ type ContainerProperties struct { LinuxParameters *LinuxParameters // The log configuration specification for the container. This parameter maps to - // LogConfig in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --log-driver option to docker run - // (https://docs.docker.com/engine/reference/run/). By default, containers use the - // same logging driver that the Docker daemon uses. However the container might use - // a different logging driver than the Docker daemon by specifying a log driver - // with this parameter in the container definition. To use a different logging - // driver for a container, the log system must be configured properly on the - // container instance (or on a different log server for remote logging options). - // For more information on the options for different supported log drivers, see - // Configure logging drivers - // (https://docs.docker.com/engine/admin/logging/overview/) in the Docker - // documentation. Batch currently supports a subset of the logging drivers - // available to the Docker daemon (shown in the LogConfiguration data type). This - // parameter requires version 1.18 of the Docker Remote API or greater on your - // container instance. To check the Docker Remote API version on your container - // instance, log in to your container instance and run the following command: sudo - // docker version | grep "Server API version" The Amazon ECS container agent - // running on a container instance must register the logging drivers available on - // that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before - // containers placed on that instance can use these log configuration options. For - // more information, see Amazon ECS container agent configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/) + // . By default, containers use the same logging driver that the Docker daemon + // uses. However the container might use a different logging driver than the Docker + // daemon by specifying a log driver with this parameter in the container + // definition. To use a different logging driver for a container, the log system + // must be configured properly on the container instance (or on a different log + // server for remote logging options). For more information on the options for + // different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) + // in the Docker documentation. Batch currently supports a subset of the logging + // drivers available to the Docker daemon (shown in the LogConfiguration data + // type). This parameter requires version 1.18 of the Docker Remote API or greater + // on your container instance. To check the Docker Remote API version on your + // container instance, log in to your container instance and run the following + // command: sudo docker version | grep "Server API version" The Amazon ECS + // container agent running on a container instance must register the logging + // drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS + // environment variable before containers placed on that instance can use these log + // configuration options. For more information, see Amazon ECS container agent + // configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. LogConfiguration *LogConfiguration @@ -1053,10 +978,10 @@ type ContainerProperties struct { Memory *int32 // The mount points for data volumes in your container. This parameter maps to - // Volumes in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --volume - // option to docker run (https://docs.docker.com/engine/reference/run/). + // Volumes in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/) + // . MountPoints []MountPoint // The network configuration for jobs that are running on Fargate resources. Jobs @@ -1065,59 +990,53 @@ type ContainerProperties struct { // When this parameter is true, the container is given elevated permissions on the // host container instance (similar to the root user). This parameter maps to - // Privileged in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --privileged option to docker run - // (https://docs.docker.com/engine/reference/run/). The default value is false. - // This parameter isn't applicable to jobs that are running on Fargate resources - // and shouldn't be provided, or specified as false. + // Privileged in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/) + // . The default value is false. This parameter isn't applicable to jobs that are + // running on Fargate resources and shouldn't be provided, or specified as false. Privileged *bool - // When this parameter is true, the container is given read-only access to its root - // file system. This parameter maps to ReadonlyRootfs in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --read-only option to docker run. + // When this parameter is true, the container is given read-only access to its + // root file system. This parameter maps to ReadonlyRootfs in the Create a + // container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section + // of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // --read-only option to docker run . ReadonlyRootFilesystem *bool // The type and amount of resources to assign to a container. The supported - // resources include GPU, MEMORY, and VCPU. + // resources include GPU , MEMORY , and VCPU . ResourceRequirements []ResourceRequirement // The secrets for the container. For more information, see Specifying sensitive - // data - // (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) + // data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) // in the Batch User Guide. Secrets []Secret - // A list of ulimits to set in the container. This parameter maps to Ulimits in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --ulimit - // option to docker run (https://docs.docker.com/engine/reference/run/). This - // parameter isn't applicable to jobs that are running on Fargate resources and - // shouldn't be provided. + // A list of ulimits to set in the container. This parameter maps to Ulimits in + // the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter isn't applicable to jobs that are running on Fargate resources + // and shouldn't be provided. Ulimits []Ulimit // The user name to use inside the container. This parameter maps to User in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --user - // option to docker run (https://docs.docker.com/engine/reference/run/). + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --user option to docker run (https://docs.docker.com/engine/reference/run/) + // . User *string // This parameter is deprecated, use resourceRequirements to specify the vCPU // requirements for the job definition. It's not supported for jobs running on // Fargate resources. For jobs running on EC2 resources, it specifies the number of // vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This - // parameter maps to CpuShares in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/). The number of vCPUs must be - // specified but can be specified in several places. You must specify it at least - // once for each node. + // parameter maps to CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/) + // . The number of vCPUs must be specified but can be specified in several places. + // You must specify it at least once for each node. // // Deprecated: This field is deprecated, use resourceRequirements instead. Vcpus *int32 @@ -1134,8 +1053,8 @@ type ContainerSummary struct { // The exit code to return upon completion. ExitCode *int32 - // A short (255 max characters) human-readable string to provide additional details - // for a running or stopped container. + // A short (255 max characters) human-readable string to provide additional + // details for a running or stopped container. Reason *string noSmithyDocumentSerde @@ -1151,12 +1070,13 @@ type Device struct { // This member is required. HostPath *string - // The path inside the container that's used to expose the host device. By default, - // the hostPath value is used. + // The path inside the container that's used to expose the host device. By + // default, the hostPath value is used. ContainerPath *string - // The explicit permissions to provide to the container for the device. By default, - // the container has permissions for read, write, and mknod for the device. + // The explicit permissions to provide to the container for the device. By + // default, the container has permissions for read , write , and mknod for the + // device. Permissions []DeviceCgroupPermission noSmithyDocumentSerde @@ -1164,54 +1084,45 @@ type Device struct { // Provides information used to select Amazon Machine Images (AMIs) for instances // in the compute environment. If Ec2Configuration isn't specified, the default is -// ECS_AL2 (Amazon Linux 2 -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami)). -// This object isn't applicable to jobs that are running on Fargate resources. +// ECS_AL2 ( Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) +// ). This object isn't applicable to jobs that are running on Fargate resources. type Ec2Configuration struct { // The image type to match with the instance type to select an AMI. The supported // values are different for ECS and EKS resources. ECS If the imageIdOverride - // parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) - // (ECS_AL2) is used. If a new image type is specified in an update, but neither an - // imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS - // optimized AMI for that image type that's supported by Batch is used. ECS_AL2 - // Amazon Linux 2 - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami): - // Default for all non-GPU instance families. ECS_AL2_NVIDIA Amazon Linux 2 (GPU) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami): - // Default for all GPU instance families (for example P4 and G4) and can be used + // parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) + // ( ECS_AL2 ) is used. If a new image type is specified in an update, but neither + // an imageId nor a imageIdOverride parameter is specified, then the latest Amazon + // ECS optimized AMI for that image type that's supported by Batch is used. ECS_AL2 + // Amazon Linux 2 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) + // : Default for all non-GPU instance families. ECS_AL2_NVIDIA Amazon Linux 2 (GPU) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) + // : Default for all GPU instance families (for example P4 and G4 ) and can be used // for all non Amazon Web Services Graviton-based instance types. ECS_AL1 Amazon - // Linux - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami). - // Amazon Linux has reached the end-of-life of standard support. For more - // information, see Amazon Linux AMI (http://aws.amazon.com/amazon-linux-ami/). EKS - // If the imageIdOverride parameter isn't specified, then a recent Amazon - // EKS-optimized Amazon Linux AMI - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) - // (EKS_AL2) is used. If a new image type is specified in an update, but neither an - // imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS - // optimized AMI for that image type that Batch supports is used. EKS_AL2 Amazon - // Linux 2 - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): - // Default for all non-GPU instance families. EKS_AL2_NVIDIA Amazon Linux 2 - // (accelerated) - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html): - // Default for all GPU instance families (for example, P4 and G4) and can be used - // for all non Amazon Web Services Graviton-based instance types. + // Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami) + // . Amazon Linux has reached the end-of-life of standard support. For more + // information, see Amazon Linux AMI (http://aws.amazon.com/amazon-linux-ami/) . + // EKS If the imageIdOverride parameter isn't specified, then a recent Amazon + // EKS-optimized Amazon Linux AMI (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) + // ( EKS_AL2 ) is used. If a new image type is specified in an update, but neither + // an imageId nor a imageIdOverride parameter is specified, then the latest Amazon + // EKS optimized AMI for that image type that Batch supports is used. EKS_AL2 + // Amazon Linux 2 (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) + // : Default for all non-GPU instance families. EKS_AL2_NVIDIA Amazon Linux 2 + // (accelerated) (https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) + // : Default for all GPU instance families (for example, P4 and G4 ) and can be + // used for all non Amazon Web Services Graviton-based instance types. // // This member is required. ImageType *string - // The AMI ID used for instances launched in the compute environment that match the - // image type. This setting overrides the imageId set in the computeResource + // The AMI ID used for instances launched in the compute environment that match + // the image type. This setting overrides the imageId set in the computeResource // object. The AMI that you choose for a compute environment must match the // architecture of the instance types that you intend to use for that compute // environment. For example, if your compute environment uses A1 instance types, // the compute resource AMI that you choose must support ARM instances. Amazon ECS // vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. - // For more information, see Amazon ECS-optimized Amazon Linux 2 AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) + // For more information, see Amazon ECS-optimized Amazon Linux 2 AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) // in the Amazon Elastic Container Service Developer Guide. ImageIdOverride *string @@ -1225,21 +1136,20 @@ type Ec2Configuration struct { // The authorization configuration details for the Amazon EFS file system. type EFSAuthorizationConfig struct { - // The Amazon EFS access point ID to use. If an access point is specified, the root - // directory value specified in the EFSVolumeConfiguration must either be omitted - // or set to / which enforces the path set on the EFS access point. If an access - // point is used, transit encryption must be enabled in the EFSVolumeConfiguration. - // For more information, see Working with Amazon EFS access points - // (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the Amazon - // Elastic File System User Guide. + // The Amazon EFS access point ID to use. If an access point is specified, the + // root directory value specified in the EFSVolumeConfiguration must either be + // omitted or set to / which enforces the path set on the EFS access point. If an + // access point is used, transit encryption must be enabled in the + // EFSVolumeConfiguration . For more information, see Working with Amazon EFS + // access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) + // in the Amazon Elastic File System User Guide. AccessPointId *string // Whether or not to use the Batch job IAM role defined in a job definition when // mounting the Amazon EFS file system. If enabled, transit encryption must be - // enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default - // value of DISABLED is used. For more information, see Using Amazon EFS access - // points - // (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) + // enabled in the EFSVolumeConfiguration . If this parameter is omitted, the + // default value of DISABLED is used. For more information, see Using Amazon EFS + // access points (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) // in the Batch User Guide. EFS IAM authorization requires that TransitEncryption // be ENABLED and that a JobRoleArn is specified. Iam EFSAuthorizationConfigIAM @@ -1247,10 +1157,9 @@ type EFSAuthorizationConfig struct { noSmithyDocumentSerde } -// This is used when you're using an Amazon Elastic File System file system for job -// storage. For more information, see Amazon EFS Volumes -// (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) in the -// Batch User Guide. +// This is used when you're using an Amazon Elastic File System file system for +// job storage. For more information, see Amazon EFS Volumes (https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) +// in the Batch User Guide. type EFSVolumeConfiguration struct { // The Amazon EFS file system ID to use. @@ -1265,25 +1174,23 @@ type EFSVolumeConfiguration struct { // inside the host. If this parameter is omitted, the root of the Amazon EFS volume // is used instead. Specifying / has the same effect as omitting this parameter. // The maximum length is 4,096 characters. If an EFS access point is specified in - // the authorizationConfig, the root directory parameter must either be omitted or - // set to /, which enforces the path set on the Amazon EFS access point. + // the authorizationConfig , the root directory parameter must either be omitted or + // set to / , which enforces the path set on the Amazon EFS access point. RootDirectory *string // Determines whether to enable encryption for Amazon EFS data in transit between // the Amazon ECS host and the Amazon EFS server. Transit encryption must be // enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, - // the default value of DISABLED is used. For more information, see Encrypting data - // in transit - // (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the - // Amazon Elastic File System User Guide. + // the default value of DISABLED is used. For more information, see Encrypting + // data in transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) + // in the Amazon Elastic File System User Guide. TransitEncryption EFSTransitEncryption // The port to use when sending encrypted data between the Amazon ECS host and the // Amazon EFS server. If you don't specify a transit encryption port, it uses the // port selection strategy that the Amazon EFS mount helper uses. The value must be - // between 0 and 65,535. For more information, see EFS mount helper - // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the Amazon - // Elastic File System User Guide. + // between 0 and 65,535. For more information, see EFS mount helper (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) + // in the Amazon Elastic File System User Guide. TransitEncryptionPort *int32 noSmithyDocumentSerde @@ -1296,8 +1203,8 @@ type EksAttemptContainerDetail struct { // The exit code for the job attempt. A non-zero exit code is considered failed. ExitCode *int32 - // A short (255 max characters) human-readable string to provide additional details - // for a running or stopped container. + // A short (255 max characters) human-readable string to provide additional + // details for a running or stopped container. Reason *string noSmithyDocumentSerde @@ -1326,7 +1233,7 @@ type EksAttemptDetail struct { // The Unix timestamp (in milliseconds) for when the attempt was stopped. This // happens when the attempt transitioned from the RUNNING state to a terminal - // state, such as SUCCEEDED or FAILED. + // state, such as SUCCEEDED or FAILED . StoppedAt *int64 noSmithyDocumentSerde @@ -1345,10 +1252,9 @@ type EksConfiguration struct { // The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. // The value can't left empty or null. It must be fewer than 64 characters long, - // can't be set to default, can't start with "kube-," and must match this regular - // expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see - // Namespaces - // (https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) + // can't be set to default , can't start with " kube- ," and must match this + // regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ . For more information, see + // Namespaces (https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) // in the Kubernetes documentation. // // This member is required. @@ -1368,21 +1274,19 @@ type EksContainer struct { // This member is required. Image *string - // An array of arguments to the entrypoint. If this isn't specified, the CMD of the - // container image is used. This corresponds to the args member in the Entrypoint - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) - // portion of the Pod - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) + // An array of arguments to the entrypoint. If this isn't specified, the CMD of + // the container image is used. This corresponds to the args member in the + // Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // portion of the Pod (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) // in Kubernetes. Environment variable references are expanded using the // container's environment. If the referenced environment variable doesn't exist, // the reference in the command isn't changed. For example, if the reference is to - // "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string - // will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't - // expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the - // VAR_NAME environment variable exists. For more information, see CMD - // (https://docs.docker.com/engine/reference/builder/#cmd) in the Dockerfile - // reference and Define a command and arguments for a pod - // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // " $(NAME1) " and the NAME1 environment variable doesn't exist, the command + // string will remain " $(NAME1) ." $$ is replaced with $ , and the resulting + // string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) + // whether or not the VAR_NAME environment variable exists. For more information, + // see CMD (https://docs.docker.com/engine/reference/builder/#cmd) in the + // Dockerfile reference and Define a command and arguments for a pod (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) // in the Kubernetes documentation. Args []string @@ -1390,51 +1294,45 @@ type EksContainer struct { // specified, the ENTRYPOINT of the container image is used. Environment variable // references are expanded using the container's environment. If the referenced // environment variable doesn't exist, the reference in the command isn't changed. - // For example, if the reference is to "$(NAME1)" and the NAME1 environment - // variable doesn't exist, the command string will remain "$(NAME1)." $$ is + // For example, if the reference is to " $(NAME1) " and the NAME1 environment + // variable doesn't exist, the command string will remain " $(NAME1) ." $$ is // replaced with $ and the resulting string isn't expanded. For example, // $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME // environment variable exists. The entrypoint can't be updated. For more - // information, see ENTRYPOINT - // (https://docs.docker.com/engine/reference/builder/#entrypoint) in the Dockerfile - // reference and Define a command and arguments for a container - // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) - // and Entrypoint - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // information, see ENTRYPOINT (https://docs.docker.com/engine/reference/builder/#entrypoint) + // in the Dockerfile reference and Define a command and arguments for a container (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // and Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) // in the Kubernetes documentation. Command []string // The environment variables to pass to a container. Environment variables cannot - // start with "AWS_BATCH". This naming convention is reserved for variables that + // start with " AWS_BATCH ". This naming convention is reserved for variables that // Batch sets. Env []EksContainerEnvironmentVariable - // The image pull policy for the container. Supported values are Always, - // IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if - // the :latest tag is specified, it defaults to Always. For more information, see - // Updating images - // (https://kubernetes.io/docs/concepts/containers/images/#updating-images) in the - // Kubernetes documentation. + // The image pull policy for the container. Supported values are Always , + // IfNotPresent , and Never . This parameter defaults to IfNotPresent . However, if + // the :latest tag is specified, it defaults to Always . For more information, see + // Updating images (https://kubernetes.io/docs/concepts/containers/images/#updating-images) + // in the Kubernetes documentation. ImagePullPolicy *string - // The name of the container. If the name isn't specified, the default name - // "Default" is used. Each container in a pod must have a unique name. + // The name of the container. If the name isn't specified, the default name " + // Default " is used. Each container in a pod must have a unique name. Name *string // The type and amount of resources to assign to a container. The supported - // resources include memory, cpu, and nvidia.com/gpu. For more information, see - // Resource management for pods and containers - // (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // resources include memory , cpu , and nvidia.com/gpu . For more information, see + // Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) // in the Kubernetes documentation. Resources *EksContainerResourceRequirements // The security context for a job. For more information, see Configure a security - // context for a pod or container - // (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in - // the Kubernetes documentation. + // context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) + // in the Kubernetes documentation. SecurityContext *EksContainerSecurityContext - // The volume mounts for the container. Batch supports emptyDir, hostPath, and + // The volume mounts for the container. Batch supports emptyDir , hostPath , and // secret volume types. For more information about volumes and volume mounts in // Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) // in the Kubernetes documentation. @@ -1447,31 +1345,27 @@ type EksContainer struct { // that use Amazon EKS. type EksContainerDetail struct { - // An array of arguments to the entrypoint. If this isn't specified, the CMD of the - // container image is used. This corresponds to the args member in the Entrypoint - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) - // portion of the Pod - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) + // An array of arguments to the entrypoint. If this isn't specified, the CMD of + // the container image is used. This corresponds to the args member in the + // Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // portion of the Pod (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) // in Kubernetes. Environment variable references are expanded using the // container's environment. If the referenced environment variable doesn't exist, // the reference in the command isn't changed. For example, if the reference is to - // "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string - // will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't - // expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the - // VAR_NAME environment variable exists. For more information, see CMD - // (https://docs.docker.com/engine/reference/builder/#cmd) in the Dockerfile - // reference and Define a command and arguments for a pod - // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // " $(NAME1) " and the NAME1 environment variable doesn't exist, the command + // string will remain " $(NAME1) ". $$ is replaced with $ and the resulting string + // isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or + // not the VAR_NAME environment variable exists. For more information, see CMD (https://docs.docker.com/engine/reference/builder/#cmd) + // in the Dockerfile reference and Define a command and arguments for a pod (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) // in the Kubernetes documentation. Args []string - // The entrypoint for the container. For more information, see Entrypoint - // (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) + // The entrypoint for the container. For more information, see Entrypoint (https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) // in the Kubernetes documentation. Command []string // The environment variables to pass to a container. Environment variables cannot - // start with "AWS_BATCH". This naming convention is reserved for variables that + // start with " AWS_BATCH ". This naming convention is reserved for variables that // Batch sets. Env []EksContainerEnvironmentVariable @@ -1481,15 +1375,14 @@ type EksContainerDetail struct { // The Docker image used to start the container. Image *string - // The image pull policy for the container. Supported values are Always, - // IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is - // specified, IfNotPresent otherwise. For more information, see Updating images - // (https://kubernetes.io/docs/concepts/containers/images/#updating-images) in the - // Kubernetes documentation. + // The image pull policy for the container. Supported values are Always , + // IfNotPresent , and Never . This parameter defaults to Always if the :latest tag + // is specified, IfNotPresent otherwise. For more information, see Updating images (https://kubernetes.io/docs/concepts/containers/images/#updating-images) + // in the Kubernetes documentation. ImagePullPolicy *string - // The name of the container. If the name isn't specified, the default name - // "Default" is used. Each container in a pod must have a unique name. + // The name of the container. If the name isn't specified, the default name " + // Default " is used. Each container in a pod must have a unique name. Name *string // A short human-readable string to provide additional details for a running or @@ -1497,19 +1390,17 @@ type EksContainerDetail struct { Reason *string // The type and amount of resources to assign to a container. The supported - // resources include memory, cpu, and nvidia.com/gpu. For more information, see - // Resource management for pods and containers - // (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // resources include memory , cpu , and nvidia.com/gpu . For more information, see + // Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) // in the Kubernetes documentation. Resources *EksContainerResourceRequirements // The security context for a job. For more information, see Configure a security - // context for a pod or container - // (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in - // the Kubernetes documentation. + // context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) + // in the Kubernetes documentation. SecurityContext *EksContainerSecurityContext - // The volume mounts for the container. Batch supports emptyDir, hostPath, and + // The volume mounts for the container. Batch supports emptyDir , hostPath , and // secret volume types. For more information about volumes and volume mounts in // Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) // in the Kubernetes documentation. @@ -1539,19 +1430,18 @@ type EksContainerOverride struct { // The arguments to the entrypoint to send to the container that overrides the // default arguments from the Docker image or the job definition. For more // information, see CMD (https://docs.docker.com/engine/reference/builder/#cmd) in - // the Dockerfile reference and Define a command an arguments for a pod - // (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) + // the Dockerfile reference and Define a command an arguments for a pod (https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) // in the Kubernetes documentation. Args []string - // The command to send to the container that overrides the default command from the - // Docker image or the job definition. + // The command to send to the container that overrides the default command from + // the Docker image or the job definition. Command []string // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch. Or, you can override the // existing environment variables from the Docker image or the job definition. - // Environment variables cannot start with "AWS_BATCH". This naming convention is + // Environment variables cannot start with " AWS_BATCH ". This naming convention is // reserved for variables that Batch sets. Env []EksContainerEnvironmentVariable @@ -1559,10 +1449,9 @@ type EksContainerOverride struct { Image *string // The type and amount of resources to assign to a container. These override the - // settings in the job definition. The supported resources include memory, cpu, and - // nvidia.com/gpu. For more information, see Resource management for pods and - // containers - // (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) + // settings in the job definition. The supported resources include memory , cpu , + // and nvidia.com/gpu . For more information, see Resource management for pods and + // containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) // in the Kubernetes documentation. Resources *EksContainerResourceRequirements @@ -1570,101 +1459,95 @@ type EksContainerOverride struct { } // The type and amount of resources to assign to a container. The supported -// resources include memory, cpu, and nvidia.com/gpu. For more information, see -// Resource management for pods and containers -// (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) +// resources include memory , cpu , and nvidia.com/gpu . For more information, see +// Resource management for pods and containers (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) // in the Kubernetes documentation. type EksContainerResourceRequirements struct { // The type and quantity of the resources to reserve for the container. The values - // vary based on the name that's specified. Resources can be requested using either - // the limits or the requests objects. memory The memory hard limit (in MiB) for - // the container, using whole integers, with a "Mi" suffix. If your container - // attempts to exceed the memory specified, the container is terminated. You must - // specify at least 4 MiB of memory for a job. memory can be specified in limits, - // requests, or both. If memory is specified in both places, then the value that's - // specified in limits must be equal to the value that's specified in requests. To - // maximize your resource utilization, provide your jobs with as much memory as - // possible for the specific instance type that you are using. To learn how, see - // Memory management - // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in - // the Batch User Guide. cpu The number of CPUs that's reserved for the container. - // Values must be an even multiple of 0.25. cpu can be specified in limits, - // requests, or both. If cpu is specified in both places, then the value that's - // specified in limits must be at least as large as the value that's specified in - // requests. nvidia.com/gpu The number of GPUs that's reserved for the container. - // Values must be a whole integer. memory can be specified in limits, requests, or - // both. If memory is specified in both places, then the value that's specified in - // limits must be equal to the value that's specified in requests. + // vary based on the name that's specified. Resources can be requested using + // either the limits or the requests objects. memory The memory hard limit (in + // MiB) for the container, using whole integers, with a "Mi" suffix. If your + // container attempts to exceed the memory specified, the container is terminated. + // You must specify at least 4 MiB of memory for a job. memory can be specified in + // limits , requests , or both. If memory is specified in both places, then the + // value that's specified in limits must be equal to the value that's specified in + // requests . To maximize your resource utilization, provide your jobs with as much + // memory as possible for the specific instance type that you are using. To learn + // how, see Memory management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. cpu The number of CPUs that's reserved for the + // container. Values must be an even multiple of 0.25 . cpu can be specified in + // limits , requests , or both. If cpu is specified in both places, then the value + // that's specified in limits must be at least as large as the value that's + // specified in requests . nvidia.com/gpu The number of GPUs that's reserved for + // the container. Values must be a whole integer. memory can be specified in limits + // , requests , or both. If memory is specified in both places, then the value + // that's specified in limits must be equal to the value that's specified in + // requests . Limits map[string]string // The type and quantity of the resources to request for the container. The values // vary based on the name that's specified. Resources can be requested by using - // either the limits or the requests objects. memory The memory hard limit (in MiB) - // for the container, using whole integers, with a "Mi" suffix. If your container - // attempts to exceed the memory specified, the container is terminated. You must - // specify at least 4 MiB of memory for a job. memory can be specified in limits, - // requests, or both. If memory is specified in both, then the value that's - // specified in limits must be equal to the value that's specified in requests. If - // you're trying to maximize your resource utilization by providing your jobs as - // much memory as possible for a particular instance type, see Memory management - // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in - // the Batch User Guide. cpu The number of CPUs that are reserved for the - // container. Values must be an even multiple of 0.25. cpu can be specified in - // limits, requests, or both. If cpu is specified in both, then the value that's + // either the limits or the requests objects. memory The memory hard limit (in + // MiB) for the container, using whole integers, with a "Mi" suffix. If your + // container attempts to exceed the memory specified, the container is terminated. + // You must specify at least 4 MiB of memory for a job. memory can be specified in + // limits , requests , or both. If memory is specified in both, then the value + // that's specified in limits must be equal to the value that's specified in + // requests . If you're trying to maximize your resource utilization by providing + // your jobs as much memory as possible for a particular instance type, see Memory + // management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. cpu The number of CPUs that are reserved for the + // container. Values must be an even multiple of 0.25 . cpu can be specified in + // limits , requests , or both. If cpu is specified in both, then the value that's // specified in limits must be at least as large as the value that's specified in - // requests. nvidia.com/gpu The number of GPUs that are reserved for the container. - // Values must be a whole integer. nvidia.com/gpu can be specified in limits, - // requests, or both. If nvidia.com/gpu is specified in both, then the value that's - // specified in limits must be equal to the value that's specified in requests. + // requests . nvidia.com/gpu The number of GPUs that are reserved for the + // container. Values must be a whole integer. nvidia.com/gpu can be specified in + // limits , requests , or both. If nvidia.com/gpu is specified in both, then the + // value that's specified in limits must be equal to the value that's specified in + // requests . Requests map[string]string noSmithyDocumentSerde } // The security context for a job. For more information, see Configure a security -// context for a pod or container -// (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in -// the Kubernetes documentation. +// context for a pod or container (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) +// in the Kubernetes documentation. type EksContainerSecurityContext struct { - // When this parameter is true, the container is given elevated permissions on the + // When this parameter is true , the container is given elevated permissions on the // host container instance. The level of permissions are similar to the root user - // permissions. The default value is false. This parameter maps to privileged - // policy in the Privileged pod security policies - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged) + // permissions. The default value is false . This parameter maps to privileged + // policy in the Privileged pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged) // in the Kubernetes documentation. Privileged *bool - // When this parameter is true, the container is given read-only access to its root - // file system. The default value is false. This parameter maps to + // When this parameter is true , the container is given read-only access to its + // root file system. The default value is false . This parameter maps to // ReadOnlyRootFilesystem policy in the Volumes and file systems pod security - // policies - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) + // policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) // in the Kubernetes documentation. ReadOnlyRootFilesystem *bool - // When this parameter is specified, the container is run as the specified group ID - // (gid). If this parameter isn't specified, the default is the group that's + // When this parameter is specified, the container is run as the specified group + // ID ( gid ). If this parameter isn't specified, the default is the group that's // specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs - // policy in the Users and groups pod security policies - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // policy in the Users and groups pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) // in the Kubernetes documentation. RunAsGroup *int64 // When this parameter is specified, the container is run as a user with a uid // other than 0. If this parameter isn't specified, so such rule is enforced. This // parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups - // pod security policies - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) // in the Kubernetes documentation. RunAsNonRoot *bool // When this parameter is specified, the container is run as the specified user ID - // (uid). If this parameter isn't specified, the default is the user that's + // ( uid ). If this parameter isn't specified, the default is the user that's // specified in the image metadata. This parameter maps to RunAsUser and MustRanAs - // policy in the Users and groups pod security policies - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) + // policy in the Users and groups pod security policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) // in the Kubernetes documentation. RunAsUser *int64 @@ -1672,20 +1555,19 @@ type EksContainerSecurityContext struct { } // The volume mounts for a container for an Amazon EKS job. For more information -// about volumes and volume mounts in Kubernetes, see Volumes -// (https://kubernetes.io/docs/concepts/storage/volumes/) in the Kubernetes -// documentation. +// about volumes and volume mounts in Kubernetes, see Volumes (https://kubernetes.io/docs/concepts/storage/volumes/) +// in the Kubernetes documentation. type EksContainerVolumeMount struct { // The path on the container where the volume is mounted. MountPath *string - // The name the volume mount. This must match the name of one of the volumes in the - // pod. + // The name the volume mount. This must match the name of one of the volumes in + // the pod. Name *string - // If this value is true, the container has read-only access to the volume. - // Otherwise, the container can write to the volume. The default value is false. + // If this value is true , the container has read-only access to the volume. + // Otherwise, the container can write to the volume. The default value is false . ReadOnly *bool noSmithyDocumentSerde @@ -1697,15 +1579,14 @@ type EksContainerVolumeMount struct { // in the pod can read and write the files in the emptyDir volume. However, the // emptyDir volume can be mounted at the same or different paths in each container. // When a pod is removed from a node for any reason, the data in the emptyDir is -// deleted permanently. For more information, see emptyDir -// (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) in the -// Kubernetes documentation. +// deleted permanently. For more information, see emptyDir (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) +// in the Kubernetes documentation. type EksEmptyDir struct { - // The medium to store the volume. The default value is an empty string, which uses - // the storage of the node. "" (Default) Use the disk storage of the node. "Memory" - // Use the tmpfs volume that's backed by the RAM of the node. Contents of the - // volume are lost when the node reboots, and any storage on the volume counts + // The medium to store the volume. The default value is an empty string, which + // uses the storage of the node. "" (Default) Use the disk storage of the node. + // "Memory" Use the tmpfs volume that's backed by the RAM of the node. Contents of + // the volume are lost when the node reboots, and any storage on the volume counts // against the container's memory limit. Medium *string @@ -1717,9 +1598,8 @@ type EksEmptyDir struct { // Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume // mounts an existing file or directory from the host node's filesystem into your -// pod. For more information, see hostPath -// (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) in the -// Kubernetes documentation. +// pod. For more information, see hostPath (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) +// in the Kubernetes documentation. type EksHostPath struct { // The path of the file or directory on the host to mount into containers on the @@ -1729,15 +1609,14 @@ type EksHostPath struct { noSmithyDocumentSerde } -// Describes and uniquely identifies Kubernetes resources. For example, the compute -// environment that a pod runs in or the jobID for a job running in the pod. For -// more information, see Understanding Kubernetes Objects -// (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) +// Describes and uniquely identifies Kubernetes resources. For example, the +// compute environment that a pod runs in or the jobID for a job running in the +// pod. For more information, see Understanding Kubernetes Objects (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) // in the Kubernetes documentation. type EksMetadata struct { - // Key-value pairs used to identify, sort, and organize cube resources. Can contain - // up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and + // Key-value pairs used to identify, sort, and organize cube resources. Can + // contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and // underscores (_). Labels can be added or modified at any time. Each resource can // have multiple labels, but each key must be unique for a given object. Labels map[string]string @@ -1751,39 +1630,32 @@ type EksPodProperties struct { // The properties of the container that's used on the Amazon EKS pod. Containers []EksContainer - // The DNS policy for the pod. The default value is ClusterFirst. If the - // hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. + // The DNS policy for the pod. The default value is ClusterFirst . If the + // hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet . // ClusterFirst indicates that any DNS query that does not match the configured // cluster domain suffix is forwarded to the upstream nameserver inherited from the - // node. For more information, see Pod's DNS policy - // (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) + // node. For more information, see Pod's DNS policy (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) // in the Kubernetes documentation. Valid values: Default | ClusterFirst | // ClusterFirstWithHostNet DnsPolicy *string // Indicates if the pod uses the hosts' network IP address. The default value is - // true. Setting this to false enables the Kubernetes pod networking model. Most + // true . Setting this to false enables the Kubernetes pod networking model. Most // Batch workloads are egress-only and don't require the overhead of IP allocation - // for each pod for incoming connections. For more information, see Host namespaces - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) - // and Pod networking - // (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) in the - // Kubernetes documentation. + // for each pod for incoming connections. For more information, see Host namespaces (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) + // and Pod networking (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) + // in the Kubernetes documentation. HostNetwork *bool // Metadata about the Kubernetes pod. For more information, see Understanding - // Kubernetes Objects - // (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) + // Kubernetes Objects (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) // in the Kubernetes documentation. Metadata *EksMetadata // The name of the service account that's used to run the pod. For more - // information, see Kubernetes service accounts - // (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) and - // Configure a Kubernetes service account to assume an IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) - // in the Amazon EKS User Guide and Configure service accounts for pods - // (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) + // information, see Kubernetes service accounts (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) + // and Configure a Kubernetes service account to assume an IAM role (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) + // in the Amazon EKS User Guide and Configure service accounts for pods (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) // in the Kubernetes documentation. ServiceAccountName *string @@ -1799,39 +1671,32 @@ type EksPodPropertiesDetail struct { // The properties of the container that's used on the Amazon EKS pod. Containers []EksContainerDetail - // The DNS policy for the pod. The default value is ClusterFirst. If the - // hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. + // The DNS policy for the pod. The default value is ClusterFirst . If the + // hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet . // ClusterFirst indicates that any DNS query that does not match the configured // cluster domain suffix is forwarded to the upstream nameserver inherited from the - // node. If no value was specified for dnsPolicy in the RegisterJobDefinition - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html) + // node. If no value was specified for dnsPolicy in the RegisterJobDefinition (https://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html) // API operation, then no value will be returned for dnsPolicy by either of - // DescribeJobDefinitions - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobDefinitions.html) - // or DescribeJobs - // (https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobs.html) + // DescribeJobDefinitions (https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobDefinitions.html) + // or DescribeJobs (https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobs.html) // API operations. The pod spec setting will contain either ClusterFirst or - // ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. - // For more information, see Pod's DNS policy - // (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) + // ClusterFirstWithHostNet , depending on the value of the hostNetwork parameter. + // For more information, see Pod's DNS policy (https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) // in the Kubernetes documentation. Valid values: Default | ClusterFirst | // ClusterFirstWithHostNet DnsPolicy *string // Indicates if the pod uses the hosts' network IP address. The default value is - // true. Setting this to false enables the Kubernetes pod networking model. Most + // true . Setting this to false enables the Kubernetes pod networking model. Most // Batch workloads are egress-only and don't require the overhead of IP allocation - // for each pod for incoming connections. For more information, see Host namespaces - // (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) - // and Pod networking - // (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) in the - // Kubernetes documentation. + // for each pod for incoming connections. For more information, see Host namespaces (https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) + // and Pod networking (https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) + // in the Kubernetes documentation. HostNetwork *bool - // Describes and uniquely identifies Kubernetes resources. For example, the compute - // environment that a pod runs in or the jobID for a job running in the pod. For - // more information, see Understanding Kubernetes Objects - // (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) + // Describes and uniquely identifies Kubernetes resources. For example, the + // compute environment that a pod runs in or the jobID for a job running in the + // pod. For more information, see Understanding Kubernetes Objects (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) // in the Kubernetes documentation. Metadata *EksMetadata @@ -1842,12 +1707,9 @@ type EksPodPropertiesDetail struct { PodName *string // The name of the service account that's used to run the pod. For more - // information, see Kubernetes service accounts - // (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) and - // Configure a Kubernetes service account to assume an IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) - // in the Amazon EKS User Guide and Configure service accounts for pods - // (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) + // information, see Kubernetes service accounts (https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) + // and Configure a Kubernetes service account to assume an IAM role (https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) + // in the Amazon EKS User Guide and Configure service accounts for pods (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) // in the Kubernetes documentation. ServiceAccountName *string @@ -1897,14 +1759,13 @@ type EksPropertiesOverride struct { noSmithyDocumentSerde } -// Specifies the configuration of a Kubernetes secret volume. For more information, -// see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the -// Kubernetes documentation. +// Specifies the configuration of a Kubernetes secret volume. For more +// information, see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) +// in the Kubernetes documentation. type EksSecret struct { // The name of the secret. The name must be allowed as a DNS subdomain name. For - // more information, see DNS subdomain names - // (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) + // more information, see DNS subdomain names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) // in the Kubernetes documentation. // // This member is required. @@ -1920,36 +1781,33 @@ type EksSecret struct { type EksVolume struct { // The name of the volume. The name must be allowed as a DNS subdomain name. For - // more information, see DNS subdomain names - // (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) + // more information, see DNS subdomain names (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) // in the Kubernetes documentation. // // This member is required. Name *string // Specifies the configuration of a Kubernetes emptyDir volume. For more - // information, see emptyDir - // (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) in the - // Kubernetes documentation. + // information, see emptyDir (https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) + // in the Kubernetes documentation. EmptyDir *EksEmptyDir // Specifies the configuration of a Kubernetes hostPath volume. For more - // information, see hostPath - // (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) in the - // Kubernetes documentation. + // information, see hostPath (https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) + // in the Kubernetes documentation. HostPath *EksHostPath - // Specifies the configuration of a Kubernetes secret volume. For more information, - // see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the - // Kubernetes documentation. + // Specifies the configuration of a Kubernetes secret volume. For more + // information, see secret (https://kubernetes.io/docs/concepts/storage/volumes/#secret) + // in the Kubernetes documentation. Secret *EksSecret noSmithyDocumentSerde } -// The amount of ephemeral storage to allocate for the task. This parameter is used -// to expand the total amount of ephemeral storage available, beyond the default -// amount, for tasks hosted on Fargate. +// The amount of ephemeral storage to allocate for the task. This parameter is +// used to expand the total amount of ephemeral storage available, beyond the +// default amount, for tasks hosted on Fargate. type EphemeralStorage struct { // The total amount, in GiB, of ephemeral storage to set for the task. The minimum @@ -1961,13 +1819,13 @@ type EphemeralStorage struct { noSmithyDocumentSerde } -// Specifies an array of up to 5 conditions to be met, and an action to take (RETRY -// or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in -// a RetryStrategy match, then the job is retried. +// Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY +// or EXIT ) if all conditions are met. If none of the EvaluateOnExit conditions +// in a RetryStrategy match, then the job is retried. type EvaluateOnExit struct { - // Specifies the action to take if all of the specified conditions (onStatusReason, - // onReason, and onExitCode) are met. The values aren't case sensitive. + // Specifies the action to take if all of the specified conditions ( onStatusReason + // , onReason , and onExitCode ) are met. The values aren't case sensitive. // // This member is required. Action RetryAction @@ -2001,12 +1859,12 @@ type FairsharePolicy struct { // A value used to reserve some of the available maximum vCPU for fair share // identifiers that aren't already used. The reserved ratio is - // (computeReservation/100)^ActiveFairShares where ActiveFairShares is the - // number of active fair share identifiers. For example, a computeReservation value - // of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's - // only one fair share identifier. It reserves 25% if there are two fair share - // identifiers. It reserves 12.5% if there are three fair share identifiers. A - // computeReservation value of 25 indicates that Batch should reserve 25% of the + // (computeReservation/100)^ActiveFairShares where ActiveFairShares is the + // number of active fair share identifiers. For example, a computeReservation + // value of 50 indicates that Batchreserves 50% of the maximum available vCPU if + // there's only one fair share identifier. It reserves 25% if there are two fair + // share identifiers. It reserves 12.5% if there are three fair share identifiers. + // A computeReservation value of 25 indicates that Batch should reserve 25% of the // maximum available vCPU if there's only one fair share identifier, 6.25% if there // are two fair share identifiers, and 1.56% if there are three fair share // identifiers. The minimum value is 0 and the maximum value is 99. @@ -2019,9 +1877,9 @@ type FairsharePolicy struct { // week). ShareDecaySeconds *int32 - // An array of SharedIdentifier objects that contain the weights for the fair share - // identifiers for the fair share policy. Fair share identifiers that aren't - // included have a default weight of 1.0. + // An array of SharedIdentifier objects that contain the weights for the fair + // share identifiers for the fair share policy. Fair share identifiers that aren't + // included have a default weight of 1.0 . ShareDistribution []ShareAttributes noSmithyDocumentSerde @@ -2035,8 +1893,7 @@ type FargatePlatformConfiguration struct { // specified only for jobs that are running on Fargate resources. If one isn't // specified, the LATEST platform version is used by default. This uses a recent, // approved version of the Fargate platform for compute resources. For more - // information, see Fargate platform versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string @@ -2080,47 +1937,45 @@ type JobDefinition struct { // This member is required. Revision *int32 - // The type of job definition. It's either container or multinode. If the job is + // The type of job definition. It's either container or multinode . If the job is // run on Fargate resources, then multinode isn't supported. For more information // about multi-node parallel jobs, see Creating a multi-node parallel job - // definition - // (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) in - // the Batch User Guide. + // definition (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) + // in the Batch User Guide. // // This member is required. Type *string // The orchestration type of the compute environment. The valid values are ECS - // (default) or EKS. + // (default) or EKS . ContainerOrchestrationType OrchestrationType // An object with various properties specific to Amazon ECS based jobs. Valid - // values are containerProperties, eksProperties, and nodeProperties. Only one can - // be specified. + // values are containerProperties , eksProperties , and nodeProperties . Only one + // can be specified. ContainerProperties *ContainerProperties // An object with various properties that are specific to Amazon EKS based jobs. - // Valid values are containerProperties, eksProperties, and nodeProperties. Only + // Valid values are containerProperties , eksProperties , and nodeProperties . Only // one can be specified. EksProperties *EksProperties - // An object with various properties that are specific to multi-node parallel jobs. - // Valid values are containerProperties, eksProperties, and nodeProperties. Only - // one can be specified. If the job runs on Fargate resources, don't specify - // nodeProperties. Use containerProperties instead. + // An object with various properties that are specific to multi-node parallel + // jobs. Valid values are containerProperties , eksProperties , and nodeProperties + // . Only one can be specified. If the job runs on Fargate resources, don't specify + // nodeProperties . Use containerProperties instead. NodeProperties *NodeProperties // Default parameters or parameter substitution placeholders that are set in the // job definition. Parameters are specified as a key-value pair mapping. Parameters // in a SubmitJob request override any corresponding parameter defaults from the // job definition. For more information about specifying parameters, see Job - // definition parameters - // (https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html) + // definition parameters (https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html) // in the Batch User Guide. Parameters map[string]string // The platform capabilities required by the job definition. If no value is - // specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE. + // specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE . PlatformCapabilities []PlatformCapability // Specifies whether to propagate the tags from the job or job definition to the @@ -2146,8 +2001,8 @@ type JobDefinition struct { // The tags that are applied to the job definition. Tags map[string]string - // The timeout time for jobs that are submitted with this job definition. After the - // amount of time you specify passes, Batch terminates your jobs if they aren't + // The timeout time for jobs that are submitted with this job definition. After + // the amount of time you specify passes, Batch terminates your jobs if they aren't // finished. Timeout *JobTimeout @@ -2197,9 +2052,8 @@ type JobDetail struct { // This member is required. StartedAt *int64 - // The current status for the job. If your jobs don't progress to STARTING, see - // Jobs stuck in RUNNABLE status - // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable) + // The current status for the job. If your jobs don't progress to STARTING , see + // Jobs stuck in RUNNABLE status (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable) // in the troubleshooting section of the Batch User Guide. // // This member is required. @@ -2215,11 +2069,11 @@ type JobDetail struct { // the job. Container *ContainerDetail - // The Unix timestamp (in milliseconds) for when the job was created. For non-array - // jobs and parent array jobs, this is when the job entered the SUBMITTED state. - // This is specifically at the time SubmitJob was called. For array child jobs, - // this is when the child job was spawned by its parent and entered the PENDING - // state. + // The Unix timestamp (in milliseconds) for when the job was created. For + // non-array jobs and parent array jobs, this is when the job entered the SUBMITTED + // state. This is specifically at the time SubmitJob was called. For array child + // jobs, this is when the child job was spawned by its parent and entered the + // PENDING state. CreatedAt *int64 // A list of job IDs that this job depends on. @@ -2229,7 +2083,7 @@ type JobDetail struct { EksAttempts []EksAttemptDetail // An object with various properties that are specific to Amazon EKS based jobs. - // Only one of container, eksProperties, or nodeDetails is specified. + // Only one of container , eksProperties , or nodeDetails is specified. EksProperties *EksPropertiesDetail // Indicates whether the job is canceled. @@ -2245,8 +2099,8 @@ type JobDetail struct { // multi-node parallel job. NodeDetails *NodeDetails - // An object that represents the node properties of a multi-node parallel job. This - // isn't applicable to jobs that are running on Fargate resources. + // An object that represents the node properties of a multi-node parallel job. + // This isn't applicable to jobs that are running on Fargate resources. NodeProperties *NodeProperties // Additional parameters that are passed to the job that replace parameter @@ -2255,7 +2109,7 @@ type JobDetail struct { Parameters map[string]string // The platform capabilities required by the job definition. If no value is - // specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE. + // specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE . PlatformCapabilities []PlatformCapability // Specifies whether to propagate the tags from the job or job definition to the @@ -2277,13 +2131,13 @@ type JobDetail struct { // The share identifier for the job. ShareIdentifier *string - // A short, human-readable string to provide more details for the current status of - // the job. + // A short, human-readable string to provide more details for the current status + // of the job. StatusReason *string // The Unix timestamp (in milliseconds) for when the job was stopped. More // specifically, it's when the job transitioned from the RUNNING state to a - // terminal state, such as SUCCEEDED or FAILED. + // terminal state, such as SUCCEEDED or FAILED . StoppedAt *int64 // The tags that are applied to the job. @@ -2319,26 +2173,26 @@ type JobQueueDetail struct { // integer value for the priority parameter) are evaluated first when associated // with the same compute environment. Priority is determined in descending order. // For example, a job queue with a priority value of 10 is given scheduling - // preference over a job queue with a priority value of 1. All of the compute - // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or - // FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. + // preference over a job queue with a priority value of 1 . All of the compute + // environments must be either EC2 ( EC2 or SPOT ) or Fargate ( FARGATE or + // FARGATE_SPOT ). EC2 and Fargate compute environments can't be mixed. // // This member is required. Priority *int32 - // Describes the ability of the queue to accept new jobs. If the job queue state is - // ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't - // be added to the queue, but jobs already in the queue can finish. + // Describes the ability of the queue to accept new jobs. If the job queue state + // is ENABLED , it can accept jobs. If the job queue state is DISABLED , new jobs + // can't be added to the queue, but jobs already in the queue can finish. // // This member is required. State JQState // The Amazon Resource Name (ARN) of the scheduling policy. The format is // aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, - // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy. + // aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy . SchedulingPolicyArn *string - // The status of the job queue (for example, CREATING or VALID). + // The status of the job queue (for example, CREATING or VALID ). Status JQStatus // A short, human-readable string to provide additional details for the current @@ -2346,9 +2200,8 @@ type JobQueueDetail struct { StatusReason *string // The tags that are applied to the job queue. For more information, see Tagging - // your Batch resources - // (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in Batch - // User Guide. + // your Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // in Batch User Guide. Tags map[string]string noSmithyDocumentSerde @@ -2374,10 +2227,10 @@ type JobSummary struct { // the job. Container *ContainerSummary - // The Unix timestamp (in milliseconds) for when the job was created. For non-array - // jobs and parent array jobs, this is when the job entered the SUBMITTED state (at - // the time SubmitJob was called). For array child jobs, this is when the child job - // was spawned by its parent and entered the PENDING state. + // The Unix timestamp (in milliseconds) for when the job was created. For + // non-array jobs and parent array jobs, this is when the job entered the SUBMITTED + // state (at the time SubmitJob was called). For array child jobs, this is when + // the child job was spawned by its parent and entered the PENDING state. CreatedAt *int64 // The Amazon Resource Name (ARN) of the job. @@ -2397,13 +2250,13 @@ type JobSummary struct { // The current status for the job. Status JobStatus - // A short, human-readable string to provide more details for the current status of - // the job. + // A short, human-readable string to provide more details for the current status + // of the job. StatusReason *string // The Unix timestamp for when the job was stopped. More specifically, it's when // the job transitioned from the RUNNING state to a terminal state, such as - // SUCCEEDED or FAILED. + // SUCCEEDED or FAILED . StoppedAt *int64 noSmithyDocumentSerde @@ -2430,8 +2283,8 @@ type KeyValuePair struct { // the environment variable. Name *string - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. Value *string noSmithyDocumentSerde @@ -2454,8 +2307,8 @@ type KeyValuesPair struct { // resource. You must specify either the launch template ID or launch template name // in the request, but not both. If security groups are specified using both the // securityGroupIds parameter of CreateComputeEnvironment and the launch template, -// the values in the securityGroupIds parameter of CreateComputeEnvironment will be -// used. This object isn't applicable to jobs that are running on Fargate +// the values in the securityGroupIds parameter of CreateComputeEnvironment will +// be used. This object isn't applicable to jobs that are running on Fargate // resources. type LaunchTemplateSpecification struct { @@ -2465,20 +2318,19 @@ type LaunchTemplateSpecification struct { // The name of the launch template. LaunchTemplateName *string - // The version number of the launch template, $Latest, or $Default. If the value is - // $Latest, the latest version of the launch template is used. If the value is - // $Default, the default version of the launch template is used. If the AMI ID + // The version number of the launch template, $Latest , or $Default . If the value + // is $Latest , the latest version of the launch template is used. If the value is + // $Default , the default version of the launch template is used. If the AMI ID // that's used in a compute environment is from the launch template, the AMI isn't // changed when the compute environment is updated. It's only changed if the - // updateToLatestImageVersion parameter for the compute environment is set to true. - // During an infrastructure update, if either $Latest or $Default is specified, + // updateToLatestImageVersion parameter for the compute environment is set to true + // . During an infrastructure update, if either $Latest or $Default is specified, // Batch re-evaluates the launch template version, and it might use a different // version of the launch template. This is the case even if the launch template // isn't specified in the update. When updating a compute environment, changing the // launch template requires an infrastructure update of the compute environment. - // For more information, see Updating compute environments - // (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) - // in the Batch User Guide. Default: $Default. + // For more information, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) + // in the Batch User Guide. Default: $Default . Version *string noSmithyDocumentSerde @@ -2489,81 +2341,67 @@ type LaunchTemplateSpecification struct { type LinuxParameters struct { // Any of the host devices to expose to the container. This parameter maps to - // Devices in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --device - // option to docker run (https://docs.docker.com/engine/reference/run/). This - // parameter isn't applicable to jobs that are running on Fargate resources. Don't - // provide it for these jobs. + // Devices in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --device option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. Devices []Device // If true, run an init process inside the container that forwards signals and - // reaps processes. This parameter maps to the --init option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter requires version - // 1.25 of the Docker Remote API or greater on your container instance. To check - // the Docker Remote API version on your container instance, log in to your - // container instance and run the following command: sudo docker version | grep - // "Server API version" + // reaps processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter requires version 1.25 of the Docker Remote API or greater on + // your container instance. To check the Docker Remote API version on your + // container instance, log in to your container instance and run the following + // command: sudo docker version | grep "Server API version" InitProcessEnabled *bool // The total amount of swap memory (in MiB) a container can use. This parameter is - // translated to the --memory-swap option to docker run - // (https://docs.docker.com/engine/reference/run/) where the value is the sum of - // the container memory plus the maxSwap value. For more information, see - // --memory-swap details - // (https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) - // in the Docker documentation. If a maxSwap value of 0 is specified, the container - // doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap - // parameter is omitted, the container doesn't use the swap configuration for the - // container instance that it's running on. A maxSwap value must be set for the - // swappiness parameter to be used. This parameter isn't applicable to jobs that - // are running on Fargate resources. Don't provide it for these jobs. + // translated to the --memory-swap option to docker run (https://docs.docker.com/engine/reference/run/) + // where the value is the sum of the container memory plus the maxSwap value. For + // more information, see --memory-swap details (https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) + // in the Docker documentation. If a maxSwap value of 0 is specified, the + // container doesn't use swap. Accepted values are 0 or any positive integer. If + // the maxSwap parameter is omitted, the container doesn't use the swap + // configuration for the container instance that it's running on. A maxSwap value + // must be set for the swappiness parameter to be used. This parameter isn't + // applicable to jobs that are running on Fargate resources. Don't provide it for + // these jobs. MaxSwap *int32 // The value for the size (in MiB) of the /dev/shm volume. This parameter maps to - // the --shm-size option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter isn't applicable - // to jobs that are running on Fargate resources. Don't provide it for these jobs. + // the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. SharedMemorySize *int32 // You can use this parameter to tune a container's memory swappiness behavior. A // swappiness value of 0 causes swapping to not occur unless absolutely necessary. // A swappiness value of 100 causes pages to be swapped aggressively. Valid values - // are whole numbers between 0 and 100. If the swappiness parameter isn't - // specified, a default value of 60 is used. If a value isn't specified for - // maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container - // doesn't use swap. This parameter maps to the --memory-swappiness option to - // docker run (https://docs.docker.com/engine/reference/run/). Consider the - // following when you use a per-container swap configuration. - // - // * Swap space must be - // enabled and allocated on the container instance for the containers to use. By - // default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable - // swap on the instance to use this feature. For more information, see Instance - // store swap volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) - // in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to - // work as swap space in an Amazon EC2 instance by using a swap file? - // (http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/) - // - // * - // The swap space parameters are only supported for job definitions using EC2 - // resources. - // - // * If the maxSwap and swappiness parameters are omitted from a job - // definition, each container has a default swappiness value of 60. Moreover, the - // total swap usage is limited to two times the memory reservation of the - // container. - // - // This parameter isn't applicable to jobs that are running on Fargate - // resources. Don't provide it for these jobs. + // are whole numbers between 0 and 100 . If the swappiness parameter isn't + // specified, a default value of 60 is used. If a value isn't specified for maxSwap + // , then this parameter is ignored. If maxSwap is set to 0, the container doesn't + // use swap. This parameter maps to the --memory-swappiness option to docker run (https://docs.docker.com/engine/reference/run/) + // . Consider the following when you use a per-container swap configuration. + // - Swap space must be enabled and allocated on the container instance for the + // containers to use. By default, the Amazon ECS optimized AMIs don't have swap + // enabled. You must enable swap on the instance to use this feature. For more + // information, see Instance store swap volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) + // in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory + // to work as swap space in an Amazon EC2 instance by using a swap file? (http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/) + // - The swap space parameters are only supported for job definitions using EC2 + // resources. + // - If the maxSwap and swappiness parameters are omitted from a job definition, + // each container has a default swappiness value of 60. Moreover, the total swap + // usage is limited to two times the memory reservation of the container. + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide it for these jobs. Swappiness *int32 // The container path, mount options, and size (in MiB) of the tmpfs mount. This - // parameter maps to the --tmpfs option to docker run - // (https://docs.docker.com/engine/reference/run/). This parameter isn't applicable - // to jobs that are running on Fargate resources. Don't provide this parameter for - // this resource type. + // parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/) + // . This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't provide this parameter for this resource type. Tmpfs []Tmpfs noSmithyDocumentSerde @@ -2574,42 +2412,35 @@ type LogConfiguration struct { // The log driver to use for the container. The valid values that are listed for // this parameter are log drivers that the Amazon ECS container agent can - // communicate with by default. The supported log drivers are awslogs, fluentd, - // gelf, json-file, journald, logentries, syslog, and splunk. Jobs that are running - // on Fargate resources are restricted to the awslogs and splunk log drivers. - // awslogs Specifies the Amazon CloudWatch Logs logging driver. For more - // information, see Using the awslogs log driver - // (https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html) in the - // Batch User Guide and Amazon CloudWatch Logs logging driver - // (https://docs.docker.com/config/containers/logging/awslogs/) in the Docker - // documentation. fluentd Specifies the Fluentd logging driver. For more - // information including usage and options, see Fluentd logging driver - // (https://docs.docker.com/config/containers/logging/fluentd/) in the Docker - // documentation. gelf Specifies the Graylog Extended Format (GELF) logging driver. - // For more information including usage and options, see Graylog Extended Format - // logging driver (https://docs.docker.com/config/containers/logging/gelf/) in the - // Docker documentation. journald Specifies the journald logging driver. For more - // information including usage and options, see Journald logging driver - // (https://docs.docker.com/config/containers/logging/journald/) in the Docker - // documentation. json-file Specifies the JSON file logging driver. For more - // information including usage and options, see JSON File logging driver - // (https://docs.docker.com/config/containers/logging/json-file/) in the Docker - // documentation. splunk Specifies the Splunk logging driver. For more information - // including usage and options, see Splunk logging driver - // (https://docs.docker.com/config/containers/logging/splunk/) in the Docker - // documentation. syslog Specifies the syslog logging driver. For more information - // including usage and options, see Syslog logging driver - // (https://docs.docker.com/config/containers/logging/syslog/) in the Docker - // documentation. If you have a custom driver that's not listed earlier that you - // want to work with the Amazon ECS container agent, you can fork the Amazon ECS - // container agent project that's available on GitHub - // (https://github.com/aws/amazon-ecs-agent) and customize it to work with that - // driver. We encourage you to submit pull requests for changes that you want to - // have included. However, Amazon Web Services doesn't currently support running - // modified copies of this software. This parameter requires version 1.18 of the - // Docker Remote API or greater on your container instance. To check the Docker - // Remote API version on your container instance, log in to your container instance - // and run the following command: sudo docker version | grep "Server API version" + // communicate with by default. The supported log drivers are awslogs , fluentd , + // gelf , json-file , journald , logentries , syslog , and splunk . Jobs that are + // running on Fargate resources are restricted to the awslogs and splunk log + // drivers. awslogs Specifies the Amazon CloudWatch Logs logging driver. For more + // information, see Using the awslogs log driver (https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html) + // in the Batch User Guide and Amazon CloudWatch Logs logging driver (https://docs.docker.com/config/containers/logging/awslogs/) + // in the Docker documentation. fluentd Specifies the Fluentd logging driver. For + // more information including usage and options, see Fluentd logging driver (https://docs.docker.com/config/containers/logging/fluentd/) + // in the Docker documentation. gelf Specifies the Graylog Extended Format (GELF) + // logging driver. For more information including usage and options, see Graylog + // Extended Format logging driver (https://docs.docker.com/config/containers/logging/gelf/) + // in the Docker documentation. journald Specifies the journald logging driver. For + // more information including usage and options, see Journald logging driver (https://docs.docker.com/config/containers/logging/journald/) + // in the Docker documentation. json-file Specifies the JSON file logging driver. + // For more information including usage and options, see JSON File logging driver (https://docs.docker.com/config/containers/logging/json-file/) + // in the Docker documentation. splunk Specifies the Splunk logging driver. For + // more information including usage and options, see Splunk logging driver (https://docs.docker.com/config/containers/logging/splunk/) + // in the Docker documentation. syslog Specifies the syslog logging driver. For + // more information including usage and options, see Syslog logging driver (https://docs.docker.com/config/containers/logging/syslog/) + // in the Docker documentation. If you have a custom driver that's not listed + // earlier that you want to work with the Amazon ECS container agent, you can fork + // the Amazon ECS container agent project that's available on GitHub (https://github.com/aws/amazon-ecs-agent) + // and customize it to work with that driver. We encourage you to submit pull + // requests for changes that you want to have included. However, Amazon Web + // Services doesn't currently support running modified copies of this software. + // This parameter requires version 1.18 of the Docker Remote API or greater on your + // container instance. To check the Docker Remote API version on your container + // instance, log in to your container instance and run the following command: sudo + // docker version | grep "Server API version" // // This member is required. LogDriver LogDriver @@ -2622,8 +2453,7 @@ type LogConfiguration struct { Options map[string]string // The secrets to pass to the log configuration. For more information, see - // Specifying sensitive data - // (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) + // Specifying sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) // in the Batch User Guide. SecretOptions []Secret @@ -2631,16 +2461,15 @@ type LogConfiguration struct { } // Details for a Docker volume mount point that's used in a job's container -// properties. This parameter maps to Volumes in the Create a container -// (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) +// properties. This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API and the --volume option to docker run. type MountPoint struct { // The path on the container where the host volume is mounted. ContainerPath *string - // If this value is true, the container has read-only access to the volume. - // Otherwise, the container can write to the volume. The default value is false. + // If this value is true , the container has read-only access to the volume. + // Otherwise, the container can write to the volume. The default value is false . ReadOnly *bool // The name of the volume to mount. @@ -2657,10 +2486,9 @@ type NetworkConfiguration struct { // Fargate resources in a private subnet to send outbound traffic to the internet // (for example, to pull container images), the private subnet requires a NAT // gateway be attached to route requests to the internet. For more information, see - // Amazon ECS task networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) - // in the Amazon Elastic Container Service Developer Guide. The default value is - // "DISABLED". + // Amazon ECS task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // in the Amazon Elastic Container Service Developer Guide. The default value is " + // DISABLED ". AssignPublicIp AssignPublicIp noSmithyDocumentSerde @@ -2709,24 +2537,19 @@ type NodeOverrides struct { // The number of nodes to use with a multi-node parallel job. This value overrides // the number of nodes that are specified in the job definition. To use this // override, you must meet the following conditions: - // - // * There must be at least one - // node range in your job definition that has an open upper boundary, such as : or - // n:. - // - // * The lower boundary of the node range that's specified in the job - // definition must be fewer than the number of nodes specified in the override. - // - // * - // The main node index that's specified in the job definition must be fewer than - // the number of nodes specified in the override. + // - There must be at least one node range in your job definition that has an + // open upper boundary, such as : or n: . + // - The lower boundary of the node range that's specified in the job definition + // must be fewer than the number of nodes specified in the override. + // - The main node index that's specified in the job definition must be fewer + // than the number of nodes specified in the override. NumNodes *int32 noSmithyDocumentSerde } -// An object that represents the node properties of a multi-node parallel job. Node -// properties can't be specified for Amazon EKS based job definitions. +// An object that represents the node properties of a multi-node parallel job. +// Node properties can't be specified for Amazon EKS based job definitions. type NodeProperties struct { // Specifies the node index for the main node of a multi-node parallel job. This @@ -2735,8 +2558,8 @@ type NodeProperties struct { // This member is required. MainNode *int32 - // A list of node ranges and their properties that are associated with a multi-node - // parallel job. + // A list of node ranges and their properties that are associated with a + // multi-node parallel job. // // This member is required. NodeRangeProperties []NodeRangeProperty @@ -2768,14 +2591,14 @@ type NodePropertiesSummary struct { noSmithyDocumentSerde } -// The object that represents any node overrides to a job definition that's used in -// a SubmitJob API operation. +// The object that represents any node overrides to a job definition that's used +// in a SubmitJob API operation. type NodePropertyOverride struct { - // The range of nodes, using node index values, that's used to override. A range of - // 0:3 indicates nodes with index values of 0 through 3. If the starting range - // value is omitted (:n), then 0 is used to start the range. If the ending range - // value is omitted (n:), then the highest possible node index is used to end the + // The range of nodes, using node index values, that's used to override. A range + // of 0:3 indicates nodes with index values of 0 through 3 . If the starting range + // value is omitted ( :n ), then 0 is used to start the range. If the ending range + // value is omitted ( n: ), then the highest possible node index is used to end the // range. // // This member is required. @@ -2791,13 +2614,13 @@ type NodePropertyOverride struct { // parallel job. type NodeRangeProperty struct { - // The range of nodes, using node index values. A range of 0:3 indicates nodes with - // index values of 0 through 3. If the starting range value is omitted (:n), then 0 - // is used to start the range. If the ending range value is omitted (n:), then the - // highest possible node index is used to end the range. Your accumulative node - // ranges must account for all nodes (0:n). You can nest node ranges (for example, - // 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 - // properties. + // The range of nodes, using node index values. A range of 0:3 indicates nodes + // with index values of 0 through 3 . If the starting range value is omitted ( :n + // ), then 0 is used to start the range. If the ending range value is omitted ( n: + // ), then the highest possible node index is used to end the range. Your + // accumulative node ranges must account for all nodes ( 0:n ). You can nest node + // ranges (for example, 0:10 and 4:5 ). In this case, the 4:5 range properties + // override the 0:10 properties. // // This member is required. TargetNodes *string @@ -2809,11 +2632,11 @@ type NodeRangeProperty struct { } // The type and amount of a resource to assign to a container. The supported -// resources include GPU, MEMORY, and VCPU. +// resources include GPU , MEMORY , and VCPU . type ResourceRequirement struct { // The type of resource to assign to a container. The supported resources include - // GPU, MEMORY, and VCPU. + // GPU , MEMORY , and VCPU . // // This member is required. Type ResourceType @@ -2826,54 +2649,50 @@ type ResourceRequirement struct { // running on Fargate resources. type="MEMORY" The memory hard limit (in MiB) // present to the container. This parameter is supported for jobs that are running // on EC2 resources. If your container attempts to exceed the memory specified, the - // container is terminated. This parameter maps to Memory in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --memory - // option to docker run (https://docs.docker.com/engine/reference/run/). You must - // specify at least 4 MiB of memory for a job. This is required but can be - // specified in several places for multi-node parallel (MNP) jobs. It must be + // container is terminated. This parameter maps to Memory in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/) + // . You must specify at least 4 MiB of memory for a job. This is required but can + // be specified in several places for multi-node parallel (MNP) jobs. It must be // specified for each node at least once. This parameter maps to Memory in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --memory - // option to docker run (https://docs.docker.com/engine/reference/run/). If you're - // trying to maximize your resource utilization by providing your jobs as much - // memory as possible for a particular instance type, see Memory management - // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in - // the Batch User Guide. For jobs that are running on Fargate resources, then value - // is the hard limit (in MiB), and must match one of the supported values and the - // VCPU values must be one of the values supported for that memory value. value = - // 512 VCPU = 0.25 value = 1024 VCPU = 0.25 or 0.5 value = 2048 VCPU = 0.25, 0.5, - // or 1 value = 3072 VCPU = 0.5, or 1 value = 4096 VCPU = 0.5, 1, or 2 value = - // 5120, 6144, or 7168 VCPU = 1 or 2 value = 8192 VCPU = 1, 2, or 4 value = 9216, - // 10240, 11264, 12288, 13312, 14336, or 15360 VCPU = 2 or 4 value = 16384 VCPU = - // 2, 4, or 8 value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, - // 27648, 29696, or 30720 VCPU = 4 value = 20480, 24576, or 28672 VCPU = 4 or 8 - // value = 36864, 45056, 53248, or 61440 VCPU = 8 value = 32768, 40960, 49152, or - // 57344 VCPU = 8 or 16 value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, - // or 122880 VCPU = 16 type="VCPU" The number of vCPUs reserved for the container. - // This parameter maps to CpuShares in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to - // 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is - // required but can be specified in several places; it must be specified for each - // node at least once. The default for the Fargate On-Demand vCPU resource count - // quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas - // (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/) + // . If you're trying to maximize your resource utilization by providing your jobs + // as much memory as possible for a particular instance type, see Memory management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. For jobs that are running on Fargate resources, then + // value is the hard limit (in MiB), and must match one of the supported values and + // the VCPU values must be one of the values supported for that memory value. + // value = 512 VCPU = 0.25 value = 1024 VCPU = 0.25 or 0.5 value = 2048 VCPU = + // 0.25, 0.5, or 1 value = 3072 VCPU = 0.5, or 1 value = 4096 VCPU = 0.5, 1, or 2 + // value = 5120, 6144, or 7168 VCPU = 1 or 2 value = 8192 VCPU = 1, 2, or 4 value + // = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 VCPU = 2 or 4 value = 16384 + // VCPU = 2, 4, or 8 value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, + // 26624, 27648, 29696, or 30720 VCPU = 4 value = 20480, 24576, or 28672 VCPU = 4 + // or 8 value = 36864, 45056, 53248, or 61440 VCPU = 8 value = 32768, 40960, + // 49152, or 57344 VCPU = 8 or 16 value = 65536, 73728, 81920, 90112, 98304, + // 106496, 114688, or 122880 VCPU = 16 type="VCPU" The number of vCPUs reserved + // for the container. This parameter maps to CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/) + // . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must + // specify at least one vCPU. This is required but can be specified in several + // places; it must be specified for each node at least once. The default for the + // Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information + // about Fargate quotas, see Fargate quotas (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) // in the Amazon Web Services General Reference. For jobs that are running on // Fargate resources, then value must match one of the supported values and the // MEMORY values must be one of the values supported for that VCPU value. The // supported values are 0.25, 0.5, 1, 2, 4, 8, and 16 value = 0.25 MEMORY = 512, // 1024, or 2048 value = 0.5 MEMORY = 1024, 2048, 3072, or 4096 value = 1 MEMORY = - // 2048, 3072, 4096, 5120, 6144, 7168, or 8192 value = 2 MEMORY = 4096, 5120, 6144, - // 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 value = 4 - // MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, - // 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, - // 29696, or 30720 value = 8 MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, - // 40960, 45056, 49152, 53248, 57344, or 61440 value = 16 MEMORY = 32768, 40960, - // 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 + // 2048, 3072, 4096, 5120, 6144, 7168, or 8192 value = 2 MEMORY = 4096, 5120, + // 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 value + // = 4 MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, + // 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, + // 28672, 29696, or 30720 value = 8 MEMORY = 16384, 20480, 24576, 28672, 32768, + // 36864, 40960, 45056, 49152, 53248, 57344, or 61440 value = 16 MEMORY = 32768, + // 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or + // 122880 // // This member is required. Value *string @@ -2882,19 +2701,18 @@ type ResourceRequirement struct { } // The retry strategy that's associated with a job. For more information, see -// Automated job retries -// (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the -// Batch User Guide. +// Automated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) +// in the Batch User Guide. type RetryStrategy struct { // The number of times to move a job to the RUNNABLE status. You can specify - // between 1 and 10 attempts. If the value of attempts is greater than one, the job - // is retried on failure the same number of attempts as the value. + // between 1 and 10 attempts. If the value of attempts is greater than one, the + // job is retried on failure the same number of attempts as the value. Attempts *int32 // Array of up to 5 objects that specify the conditions where jobs are retried or - // failed. If this parameter is specified, then the attempts parameter must also be - // specified. If none of the listed conditions match, then the job is retried. + // failed. If this parameter is specified, then the attempts parameter must also + // be specified. If none of the listed conditions match, then the job is retried. EvaluateOnExit []EvaluateOnExit noSmithyDocumentSerde @@ -2917,11 +2735,10 @@ type SchedulingPolicyDetail struct { // The fair share policy for the scheduling policy. FairsharePolicy *FairsharePolicy - // The tags that you apply to the scheduling policy to categorize and organize your - // resources. Each tag consists of a key and an optional value. For more - // information, see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web - // Services General Reference. + // The tags that you apply to the scheduling policy to categorize and organize + // your resources. Each tag consists of a key and an optional value. For more + // information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in Amazon Web Services General Reference. Tags map[string]string noSmithyDocumentSerde @@ -2939,19 +2756,14 @@ type SchedulingPolicyListingDetail struct { noSmithyDocumentSerde } -// An object that represents the secret to expose to your container. Secrets can be -// exposed to a container in the following ways: -// -// * To inject sensitive data into -// your containers as environment variables, use the secrets container definition -// parameter. -// -// * To reference sensitive information in the log configuration of a -// container, use the secretOptions container definition parameter. +// An object that represents the secret to expose to your container. Secrets can +// be exposed to a container in the following ways: +// - To inject sensitive data into your containers as environment variables, use +// the secrets container definition parameter. +// - To reference sensitive information in the log configuration of a container, +// use the secretOptions container definition parameter. // -// For more -// information, see Specifying sensitive data -// (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) +// For more information, see Specifying sensitive data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) // in the Batch User Guide. type Secret struct { @@ -2975,17 +2787,17 @@ type Secret struct { } // Specifies the weights for the fair share identifiers for the fair share policy. -// Fair share identifiers that aren't included have a default weight of 1.0. +// Fair share identifiers that aren't included have a default weight of 1.0 . type ShareAttributes struct { - // A fair share identifier or fair share identifier prefix. If the string ends with - // an asterisk (*), this entry specifies the weight factor to use for fair share - // identifiers that start with that prefix. The list of fair share identifiers in a - // fair share policy can't overlap. For example, you can't have one that specifies - // a shareIdentifier of UserA* and another that specifies a shareIdentifier of - // UserA-1. There can be no more than 500 fair share identifiers active in a job - // queue. The string is limited to 255 alphanumeric characters, and can be followed - // by an asterisk (*). + // A fair share identifier or fair share identifier prefix. If the string ends + // with an asterisk (*), this entry specifies the weight factor to use for fair + // share identifiers that start with that prefix. The list of fair share + // identifiers in a fair share policy can't overlap. For example, you can't have + // one that specifies a shareIdentifier of UserA* and another that specifies a + // shareIdentifier of UserA-1 . There can be no more than 500 fair share + // identifiers active in a job queue. The string is limited to 255 alphanumeric + // characters, and can be followed by an asterisk (*). // // This member is required. ShareIdentifier *string @@ -3015,13 +2827,14 @@ type Tmpfs struct { // This member is required. Size *int32 - // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | - // "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | - // "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | - // "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | - // "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | - // "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | - // "nr_inodes" | "nr_blocks" | "mpol" + // The list of tmpfs volume mount options. Valid values: " defaults " | " ro " | " + // rw " | " suid " | " nosuid " | " dev " | " nodev " | " exec " | " noexec " | " + // sync " | " async " | " dirsync " | " remount " | " mand " | " nomand " | " atime + // " | " noatime " | " diratime " | " nodiratime " | " bind " | " rbind" | + // "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | + // "slave" | "rslave" | "relatime " | " norelatime " | " strictatime " | " + // nostrictatime " | " mode " | " uid " | " gid " | " nr_inodes " | " nr_blocks " | + // " mpol " MountOptions []string noSmithyDocumentSerde @@ -3036,7 +2849,7 @@ type Ulimit struct { // This member is required. HardLimit *int32 - // The type of the ulimit. + // The type of the ulimit . // // This member is required. Name *string @@ -3049,9 +2862,8 @@ type Ulimit struct { noSmithyDocumentSerde } -// Specifies the infrastructure update policy for the compute environment. For more -// information about infrastructure updates, see Updating compute environments -// (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) +// Specifies the infrastructure update policy for the compute environment. For +// more information about infrastructure updates, see Updating compute environments (https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) // in the Batch User Guide. type UpdatePolicy struct { @@ -3060,7 +2872,7 @@ type UpdatePolicy struct { JobExecutionTimeoutMinutes int64 // Specifies whether jobs are automatically terminated when the computer - // environment infrastructure is updated. The default value is false. + // environment infrastructure is updated. The default value is false . TerminateJobsOnUpdate *bool noSmithyDocumentSerde @@ -3069,9 +2881,9 @@ type UpdatePolicy struct { // A data volume that's used in a job's container properties. type Volume struct { - // This parameter is specified when you're using an Amazon Elastic File System file - // system for job storage. Jobs that are running on Fargate resources must specify - // a platformVersion of at least 1.4.0. + // This parameter is specified when you're using an Amazon Elastic File System + // file system for job storage. Jobs that are running on Fargate resources must + // specify a platformVersion of at least 1.4.0 . EfsVolumeConfiguration *EFSVolumeConfiguration // The contents of the host parameter determine whether your data volume persists @@ -3085,7 +2897,7 @@ type Volume struct { // The name of the volume. It can be up to 255 characters long. It can contain // uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This // name is referenced in the sourceVolume parameter of container definition - // mountPoints. + // mountPoints . Name *string noSmithyDocumentSerde diff --git a/service/billingconductor/api_client.go b/service/billingconductor/api_client.go index d2c0fdc8c88..a0058bd44bd 100644 --- a/service/billingconductor/api_client.go +++ b/service/billingconductor/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/billingconductor/api_op_AssociateAccounts.go b/service/billingconductor/api_op_AssociateAccounts.go index 3abd63b335f..765a92ca3e5 100644 --- a/service/billingconductor/api_op_AssociateAccounts.go +++ b/service/billingconductor/api_op_AssociateAccounts.go @@ -37,8 +37,8 @@ type AssociateAccountsInput struct { // This member is required. AccountIds []string - // The Amazon Resource Name (ARN) of the billing group that associates the array of - // account IDs. + // The Amazon Resource Name (ARN) of the billing group that associates the array + // of account IDs. // // This member is required. Arn *string @@ -48,8 +48,8 @@ type AssociateAccountsInput struct { type AssociateAccountsOutput struct { - // The Amazon Resource Name (ARN) of the billing group that associates the array of - // account IDs. + // The Amazon Resource Name (ARN) of the billing group that associates the array + // of account IDs. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_AssociatePricingRules.go b/service/billingconductor/api_op_AssociatePricingRules.go index 1c2d4915ba8..b5778e4dfb0 100644 --- a/service/billingconductor/api_op_AssociatePricingRules.go +++ b/service/billingconductor/api_op_AssociatePricingRules.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Connects an array of PricingRuleArns to a defined PricingPlan. The maximum +// Connects an array of PricingRuleArns to a defined PricingPlan . The maximum // number PricingRuleArn that can be associated in one call is 30. func (c *Client) AssociatePricingRules(ctx context.Context, params *AssociatePricingRulesInput, optFns ...func(*Options)) (*AssociatePricingRulesOutput, error) { if params == nil { diff --git a/service/billingconductor/api_op_CreateBillingGroup.go b/service/billingconductor/api_op_CreateBillingGroup.go index e377d08e5c0..c6305ffb676 100644 --- a/service/billingconductor/api_op_CreateBillingGroup.go +++ b/service/billingconductor/api_op_CreateBillingGroup.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a billing group that resembles a consolidated billing family that Amazon -// Web Services charges, based off of the predefined pricing plan computation. +// Creates a billing group that resembles a consolidated billing family that +// Amazon Web Services charges, based off of the predefined pricing plan +// computation. func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGroupInput, optFns ...func(*Options)) (*CreateBillingGroupOutput, error) { if params == nil { params = &CreateBillingGroupInput{} diff --git a/service/billingconductor/api_op_CreatePricingRule.go b/service/billingconductor/api_op_CreatePricingRule.go index 106f4bd7148..e1f89e3024c 100644 --- a/service/billingconductor/api_op_CreatePricingRule.go +++ b/service/billingconductor/api_op_CreatePricingRule.go @@ -63,12 +63,12 @@ type CreatePricingRuleInput struct { // Operation is the specific Amazon Web Services action covered by this line item. // This describes the specific usage of the line item. If the Scope attribute is - // set to SKU, this attribute indicates which operation the PricingRule is + // set to SKU , this attribute indicates which operation the PricingRule is // modifying. For example, a value of RunInstances:0202 indicates the operation of // running an Amazon EC2 instance. Operation *string - // If the Scope attribute is set to SERVICE or SKU, the attribute indicates which + // If the Scope attribute is set to SERVICE or SKU , the attribute indicates which // service the PricingRule is applicable for. Service *string @@ -78,11 +78,11 @@ type CreatePricingRuleInput struct { // The set of tiering configurations for the pricing rule. Tiering *types.CreateTieringInput - // Usage type is the unit that each service uses to measure the usage of a specific - // type of resource. If the Scope attribute is set to SKU, this attribute indicates - // which usage type the PricingRule is modifying. For example, - // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance - // in the US West (Oregon) Region. + // Usage type is the unit that each service uses to measure the usage of a + // specific type of resource. If the Scope attribute is set to SKU , this attribute + // indicates which usage type the PricingRule is modifying. For example, + // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large + // instance in the US West (Oregon) Region. UsageType *string noSmithyDocumentSerde diff --git a/service/billingconductor/api_op_DeletePricingPlan.go b/service/billingconductor/api_op_DeletePricingPlan.go index 738dac04c69..4c9eae5a850 100644 --- a/service/billingconductor/api_op_DeletePricingPlan.go +++ b/service/billingconductor/api_op_DeletePricingPlan.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a pricing plan. The pricing plan must not be associated with any billing -// groups to delete successfully. +// Deletes a pricing plan. The pricing plan must not be associated with any +// billing groups to delete successfully. func (c *Client) DeletePricingPlan(ctx context.Context, params *DeletePricingPlanInput, optFns ...func(*Options)) (*DeletePricingPlanOutput, error) { if params == nil { params = &DeletePricingPlanInput{} diff --git a/service/billingconductor/api_op_ListAccountAssociations.go b/service/billingconductor/api_op_ListAccountAssociations.go index e4760c0ea0f..54a41504773 100644 --- a/service/billingconductor/api_op_ListAccountAssociations.go +++ b/service/billingconductor/api_op_ListAccountAssociations.go @@ -37,8 +37,8 @@ type ListAccountAssociationsInput struct { BillingPeriod *string // The filter on the account ID of the linked account, or any of the following: - // MONITORED: linked accounts that are associated to billing groups. UNMONITORED: - // linked accounts that aren't associated to billing groups. Billing Group Arn: + // MONITORED : linked accounts that are associated to billing groups. UNMONITORED : + // linked accounts that aren't associated to billing groups. Billing Group Arn : // linked accounts that are associated to the provided billing group Arn. Filters *types.ListAccountAssociationsFilter diff --git a/service/billingconductor/api_op_ListCustomLineItems.go b/service/billingconductor/api_op_ListCustomLineItems.go index 8ba110dc642..e6c8c3f43e5 100644 --- a/service/billingconductor/api_op_ListCustomLineItems.go +++ b/service/billingconductor/api_op_ListCustomLineItems.go @@ -124,8 +124,8 @@ func (c *Client) addOperationListCustomLineItemsMiddlewares(stack *middleware.St return nil } -// ListCustomLineItemsAPIClient is a client that implements the ListCustomLineItems -// operation. +// ListCustomLineItemsAPIClient is a client that implements the +// ListCustomLineItems operation. type ListCustomLineItemsAPIClient interface { ListCustomLineItems(context.Context, *ListCustomLineItemsInput, ...func(*Options)) (*ListCustomLineItemsOutput, error) } diff --git a/service/billingconductor/api_op_ListPricingPlans.go b/service/billingconductor/api_op_ListPricingPlans.go index 15cb4880f6e..030638b393d 100644 --- a/service/billingconductor/api_op_ListPricingPlans.go +++ b/service/billingconductor/api_op_ListPricingPlans.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A paginated call to get pricing plans for the given billing period. If you don't -// provide a billing period, the current billing period is used. +// A paginated call to get pricing plans for the given billing period. If you +// don't provide a billing period, the current billing period is used. func (c *Client) ListPricingPlans(ctx context.Context, params *ListPricingPlansInput, optFns ...func(*Options)) (*ListPricingPlansOutput, error) { if params == nil { params = &ListPricingPlansInput{} diff --git a/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go b/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go index abf32f2ea9c..40418139034 100644 --- a/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go +++ b/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go @@ -55,8 +55,8 @@ type ListPricingPlansAssociatedWithPricingRuleOutput struct { // The pagination token to be used on subsequent calls. NextToken *string - // The list containing pricing plans that are associated with the requested pricing - // rule. + // The list containing pricing plans that are associated with the requested + // pricing rule. PricingPlanArns []string // The pricing rule Amazon Resource Name (ARN) for which associations will be diff --git a/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go b/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go index c979ec4ad58..dc2fa86df9a 100644 --- a/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go +++ b/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go @@ -29,8 +29,8 @@ func (c *Client) ListPricingRulesAssociatedToPricingPlan(ctx context.Context, pa type ListPricingRulesAssociatedToPricingPlanInput struct { - // The Amazon Resource Name (ARN) of the pricing plan for which associations are to - // be listed. + // The Amazon Resource Name (ARN) of the pricing plan for which associations are + // to be listed. // // This member is required. PricingPlanArn *string @@ -132,16 +132,16 @@ func (c *Client) addOperationListPricingRulesAssociatedToPricingPlanMiddlewares( return nil } -// ListPricingRulesAssociatedToPricingPlanAPIClient is a client that implements the -// ListPricingRulesAssociatedToPricingPlan operation. +// ListPricingRulesAssociatedToPricingPlanAPIClient is a client that implements +// the ListPricingRulesAssociatedToPricingPlan operation. type ListPricingRulesAssociatedToPricingPlanAPIClient interface { ListPricingRulesAssociatedToPricingPlan(context.Context, *ListPricingRulesAssociatedToPricingPlanInput, ...func(*Options)) (*ListPricingRulesAssociatedToPricingPlanOutput, error) } var _ ListPricingRulesAssociatedToPricingPlanAPIClient = (*Client)(nil) -// ListPricingRulesAssociatedToPricingPlanPaginatorOptions is the paginator options -// for ListPricingRulesAssociatedToPricingPlan +// ListPricingRulesAssociatedToPricingPlanPaginatorOptions is the paginator +// options for ListPricingRulesAssociatedToPricingPlan type ListPricingRulesAssociatedToPricingPlanPaginatorOptions struct { // The optional maximum number of pricing rule associations to retrieve. Limit int32 diff --git a/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go b/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go index 3ff426080e2..3213ba9579e 100644 --- a/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go +++ b/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go @@ -134,16 +134,16 @@ func (c *Client) addOperationListResourcesAssociatedToCustomLineItemMiddlewares( return nil } -// ListResourcesAssociatedToCustomLineItemAPIClient is a client that implements the -// ListResourcesAssociatedToCustomLineItem operation. +// ListResourcesAssociatedToCustomLineItemAPIClient is a client that implements +// the ListResourcesAssociatedToCustomLineItem operation. type ListResourcesAssociatedToCustomLineItemAPIClient interface { ListResourcesAssociatedToCustomLineItem(context.Context, *ListResourcesAssociatedToCustomLineItemInput, ...func(*Options)) (*ListResourcesAssociatedToCustomLineItemOutput, error) } var _ ListResourcesAssociatedToCustomLineItemAPIClient = (*Client)(nil) -// ListResourcesAssociatedToCustomLineItemPaginatorOptions is the paginator options -// for ListResourcesAssociatedToCustomLineItem +// ListResourcesAssociatedToCustomLineItemPaginatorOptions is the paginator +// options for ListResourcesAssociatedToCustomLineItem type ListResourcesAssociatedToCustomLineItemPaginatorOptions struct { // (Optional) The maximum number of resource associations to be retrieved. Limit int32 diff --git a/service/billingconductor/api_op_TagResource.go b/service/billingconductor/api_op_TagResource.go index 7f6de8b2c52..4c7df3058b4 100644 --- a/service/billingconductor/api_op_TagResource.go +++ b/service/billingconductor/api_op_TagResource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource are not specified in the request parameters, they // are not changed. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { diff --git a/service/billingconductor/api_op_UpdatePricingRule.go b/service/billingconductor/api_op_UpdatePricingRule.go index a91eca48dba..7f999e62850 100644 --- a/service/billingconductor/api_op_UpdatePricingRule.go +++ b/service/billingconductor/api_op_UpdatePricingRule.go @@ -78,7 +78,7 @@ type UpdatePricingRuleOutput struct { // Operation refers to the specific Amazon Web Services covered by this line item. // This describes the specific usage of the line item. If the Scope attribute is - // set to SKU, this attribute indicates which operation the PricingRule is + // set to SKU , this attribute indicates which operation the PricingRule is // modifying. For example, a value of RunInstances:0202 indicates the operation of // running an Amazon EC2 instance. Operation *string @@ -87,7 +87,7 @@ type UpdatePricingRuleOutput struct { // service-specific. Scope types.PricingRuleScope - // If the Scope attribute is set to SERVICE, the attribute indicates which service + // If the Scope attribute is set to SERVICE , the attribute indicates which service // the PricingRule is applicable for. Service *string @@ -97,11 +97,11 @@ type UpdatePricingRuleOutput struct { // The new pricing rule type. Type types.PricingRuleType - // Usage type is the unit that each service uses to measure the usage of a specific - // type of resource. If the Scope attribute is set to SKU, this attribute indicates - // which usage type the PricingRule is modifying. For example, - // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance - // in the US West (Oregon) Region. + // Usage type is the unit that each service uses to measure the usage of a + // specific type of resource. If the Scope attribute is set to SKU , this attribute + // indicates which usage type the PricingRule is modifying. For example, + // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large + // instance in the US West (Oregon) Region. UsageType *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/doc.go b/service/billingconductor/doc.go index 410db36dc62..506775b949d 100644 --- a/service/billingconductor/doc.go +++ b/service/billingconductor/doc.go @@ -4,8 +4,7 @@ // types for AWSBillingConductor. // // Amazon Web Services Billing Conductor is a fully managed service that you can -// use to customize a pro forma -// (https://docs.aws.amazon.com/billingconductor/latest/userguide/understanding-eb.html#eb-other-definitions) +// use to customize a pro forma (https://docs.aws.amazon.com/billingconductor/latest/userguide/understanding-eb.html#eb-other-definitions) // version of your billing data each month, to accurately show or chargeback your // end customers. Amazon Web Services Billing Conductor doesn't change the way // you're billed by Amazon Web Services each month by design. Instead, it provides @@ -14,12 +13,10 @@ // between the rates you apply to your accounting groupings relative to your actual // rates from Amazon Web Services. As a result of your Amazon Web Services Billing // Conductor configuration, the payer account can also see the custom rate applied -// on the billing details page of the Amazon Web Services Billing console -// (https://console.aws.amazon.com/billing), or configure a cost and usage report -// per billing group. This documentation shows how you can configure Amazon Web -// Services Billing Conductor using its API. For more information about using the -// Amazon Web Services Billing Conductor -// (https://console.aws.amazon.com/billingconductor/) user interface, see the -// Amazon Web Services Billing Conductor User Guide -// (https://docs.aws.amazon.com/billingconductor/latest/userguide/what-is-billingconductor.html). +// on the billing details page of the Amazon Web Services Billing console (https://console.aws.amazon.com/billing) +// , or configure a cost and usage report per billing group. This documentation +// shows how you can configure Amazon Web Services Billing Conductor using its API. +// For more information about using the Amazon Web Services Billing Conductor (https://console.aws.amazon.com/billingconductor/) +// user interface, see the Amazon Web Services Billing Conductor User Guide (https://docs.aws.amazon.com/billingconductor/latest/userguide/what-is-billingconductor.html) +// . package billingconductor diff --git a/service/billingconductor/types/enums.go b/service/billingconductor/types/enums.go index 2d198ff0ee3..82703b8ae81 100644 --- a/service/billingconductor/types/enums.go +++ b/service/billingconductor/types/enums.go @@ -13,9 +13,10 @@ const ( AssociateResourceErrorReasonInvalidBillingPeriodRange AssociateResourceErrorReason = "INVALID_BILLING_PERIOD_RANGE" ) -// Values returns all known values for AssociateResourceErrorReason. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AssociateResourceErrorReason. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AssociateResourceErrorReason) Values() []AssociateResourceErrorReason { return []AssociateResourceErrorReason{ "INVALID_ARN", @@ -76,9 +77,9 @@ const ( CurrencyCodeCny CurrencyCode = "CNY" ) -// Values returns all known values for CurrencyCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CurrencyCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CurrencyCode) Values() []CurrencyCode { return []CurrencyCode{ "USD", diff --git a/service/billingconductor/types/types.go b/service/billingconductor/types/types.go index fe55c4b584e..0c038839d3c 100644 --- a/service/billingconductor/types/types.go +++ b/service/billingconductor/types/types.go @@ -61,8 +61,8 @@ type AssociateResourceResponseElement struct { noSmithyDocumentSerde } -// A summary report of actual Amazon Web Services charges and calculated Amazon Web -// Services charges, based on the associated pricing plan of a billing group. +// A summary report of actual Amazon Web Services charges and calculated Amazon +// Web Services charges, based on the associated pricing plan of a billing group. type BillingGroupCostReportElement struct { // The actual Amazon Web Services charges for the billing group. @@ -177,7 +177,7 @@ type CustomLineItemBillingPeriodRange struct { } // The charge details of a custom line item. It should contain only one of Flat or -// Percentage. +// Percentage . type CustomLineItemChargeDetails struct { // The type of the custom line item that indicates whether the charge is a fee or @@ -335,8 +335,8 @@ type FreeTierConfig struct { } // The filter on the account ID of the linked account, or any of the following: -// MONITORED: linked accounts that are associated to billing groups. UNMONITORED: -// linked accounts that are not associated to billing groups. Billing Group Arn: +// MONITORED : linked accounts that are associated to billing groups. UNMONITORED : +// linked accounts that are not associated to billing groups. Billing Group Arn : // linked accounts that are associated to the provided Billing Group Arn. type ListAccountAssociationsFilter struct { @@ -347,15 +347,15 @@ type ListAccountAssociationsFilter struct { // for a given time range. AccountIds []string - // MONITORED: linked accounts that are associated to billing groups. UNMONITORED: - // linked accounts that are not associated to billing groups. Billing Group Arn: + // MONITORED : linked accounts that are associated to billing groups. UNMONITORED : + // linked accounts that are not associated to billing groups. Billing Group Arn : // linked accounts that are associated to the provided Billing Group Arn. Association *string noSmithyDocumentSerde } -// The filter used to retrieve specific BillingGroupCostReportElements. +// The filter used to retrieve specific BillingGroupCostReportElements . type ListBillingGroupCostReportsFilter struct { // The list of Amazon Resource Names (ARNs) used to filter billing groups to @@ -386,7 +386,7 @@ type ListBillingGroupsFilter struct { type ListCustomLineItemChargeDetails struct { // The type of the custom line item that indicates whether the charge is a fee or - // credit. + // credit . // // This member is required. Type CustomLineItemType @@ -395,8 +395,8 @@ type ListCustomLineItemChargeDetails struct { // flat custom line item. Flat *ListCustomLineItemFlatChargeDetails - // A ListCustomLineItemPercentageChargeDetails that describes the charge details of - // a percentage custom line item. + // A ListCustomLineItemPercentageChargeDetails that describes the charge details + // of a percentage custom line item. Percentage *ListCustomLineItemPercentageChargeDetails noSmithyDocumentSerde @@ -572,7 +572,7 @@ type PricingRuleListElement struct { // Operation is the specific Amazon Web Services action covered by this line item. // This describes the specific usage of the line item. If the Scope attribute is - // set to SKU, this attribute indicates which operation the PricingRule is + // set to SKU , this attribute indicates which operation the PricingRule is // modifying. For example, a value of RunInstances:0202 indicates the operation of // running an Amazon EC2 instance. Operation *string @@ -581,7 +581,7 @@ type PricingRuleListElement struct { // is service-specific. Scope PricingRuleScope - // If the Scope attribute is SERVICE, this attribute indicates which service the + // If the Scope attribute is SERVICE , this attribute indicates which service the // PricingRule is applicable for. Service *string @@ -591,11 +591,11 @@ type PricingRuleListElement struct { // The type of pricing rule. Type PricingRuleType - // Usage type is the unit that each service uses to measure the usage of a specific - // type of resource. If the Scope attribute is set to SKU, this attribute indicates - // which usage type the PricingRule is modifying. For example, - // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance - // in the US West (Oregon) Region. + // Usage type is the unit that each service uses to measure the usage of a + // specific type of resource. If the Scope attribute is set to SKU , this attribute + // indicates which usage type the PricingRule is modifying. For example, + // USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large + // instance in the US West (Oregon) Region. UsageType *string noSmithyDocumentSerde @@ -613,7 +613,7 @@ type Tiering struct { } // A representation of the new charge details of a custom line item. This should -// contain only one of Flat or Percentage. +// contain only one of Flat or Percentage . type UpdateCustomLineItemChargeDetails struct { // An UpdateCustomLineItemFlatChargeDetails that describes the new charge details @@ -639,12 +639,12 @@ type UpdateCustomLineItemFlatChargeDetails struct { noSmithyDocumentSerde } -// A representation of the new charge details that are associated with a percentage -// custom line item. +// A representation of the new charge details that are associated with a +// percentage custom line item. type UpdateCustomLineItemPercentageChargeDetails struct { - // The custom line item's new percentage value. This will be multiplied against the - // combined value of its associated resources to determine its charge value. + // The custom line item's new percentage value. This will be multiplied against + // the combined value of its associated resources to determine its charge value. // // This member is required. PercentageValue *float64 diff --git a/service/braket/api_client.go b/service/braket/api_client.go index da9a3856ccc..758301e6653 100644 --- a/service/braket/api_client.go +++ b/service/braket/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/braket/api_op_CreateJob.go b/service/braket/api_op_CreateJob.go index 22e8b662476..45cfbac3864 100644 --- a/service/braket/api_op_CreateJob.go +++ b/service/braket/api_op_CreateJob.go @@ -30,8 +30,8 @@ func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns . type CreateJobInput struct { - // Definition of the Amazon Braket job to be created. Specifies the container image - // the job uses and information about the Python scripts used for entry and + // Definition of the Amazon Braket job to be created. Specifies the container + // image the job uses and information about the Python scripts used for entry and // training. // // This member is required. diff --git a/service/braket/doc.go b/service/braket/doc.go index 0436d253703..eb998d81a2a 100644 --- a/service/braket/doc.go +++ b/service/braket/doc.go @@ -5,8 +5,5 @@ // // The Amazon Braket API Reference provides information about the operations and // structures supported in Amazon Braket. Additional Resources: -// -// * Amazon Braket -// Developer Guide -// (https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html) +// - Amazon Braket Developer Guide (https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html) package braket diff --git a/service/braket/types/enums.go b/service/braket/types/enums.go index 76eb03b3cb6..d7034aece0e 100644 --- a/service/braket/types/enums.go +++ b/service/braket/types/enums.go @@ -47,9 +47,9 @@ const ( DeviceStatusRetired DeviceStatus = "RETIRED" ) -// Values returns all known values for DeviceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeviceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DeviceStatus) Values() []DeviceStatus { return []DeviceStatus{ "ONLINE", @@ -121,9 +121,9 @@ const ( InstanceTypeMlC5n18xlarge InstanceType = "ml.c5n.18xlarge" ) -// Values returns all known values for InstanceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InstanceType) Values() []InstanceType { return []InstanceType{ "ml.m4.xlarge", @@ -185,9 +185,9 @@ const ( JobEventTypeCancelled JobEventType = "CANCELLED" ) -// Values returns all known values for JobEventType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for JobEventType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (JobEventType) Values() []JobEventType { return []JobEventType{ "WAITING_FOR_PRIORITY", @@ -271,9 +271,9 @@ const ( SearchJobsFilterOperatorContains SearchJobsFilterOperator = "CONTAINS" ) -// Values returns all known values for SearchJobsFilterOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SearchJobsFilterOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchJobsFilterOperator) Values() []SearchJobsFilterOperator { return []SearchJobsFilterOperator{ "LT", diff --git a/service/braket/types/types.go b/service/braket/types/types.go index 183fc75012e..0731bd2764e 100644 --- a/service/braket/types/types.go +++ b/service/braket/types/types.go @@ -46,8 +46,8 @@ type DataSource struct { // run an Amazon Braket job. type DeviceConfig struct { - // The primary quantum processing unit (QPU) or simulator used to create and run an - // Amazon Braket job. + // The primary quantum processing unit (QPU) or simulator used to create and run + // an Amazon Braket job. // // This member is required. Device *string @@ -132,13 +132,13 @@ type InstanceConfig struct { type JobCheckpointConfig struct { // Identifies the S3 path where you want Amazon Braket to store checkpoints. For - // example, s3://bucket-name/key-name-prefix. + // example, s3://bucket-name/key-name-prefix . // // This member is required. S3Uri *string // (Optional) The local directory where checkpoints are written. The default - // directory is /opt/braket/checkpoints/. + // directory is /opt/braket/checkpoints/ . LocalPath *string noSmithyDocumentSerde @@ -165,7 +165,7 @@ type JobEventDetails struct { type JobOutputDataConfig struct { // Identifies the S3 path where you want Amazon Braket to store the job training - // artifacts. For example, s3://bucket-name/key-name-prefix. + // artifacts. For example, s3://bucket-name/key-name-prefix . // // This member is required. S3Path *string @@ -278,7 +278,7 @@ type QuantumTaskSummary struct { // Information about the data stored in Amazon S3 used by the Amazon Braket job. type S3DataSource struct { - // Depending on the value specified for the S3DataType, identifies either a key + // Depending on the value specified for the S3DataType , identifies either a key // name prefix or a manifest that locates the S3 data source. // // This member is required. @@ -297,8 +297,8 @@ type ScriptModeConfig struct { // This member is required. EntryPoint *string - // The URI that specifies the S3 path to the Python script module that contains the - // training script used by an Amazon Braket job. + // The URI that specifies the S3 path to the Python script module that contains + // the training script used by an Amazon Braket job. // // This member is required. S3Uri *string diff --git a/service/budgets/api_client.go b/service/budgets/api_client.go index ffe1dd0a7ef..1d48a8decbb 100644 --- a/service/budgets/api_client.go +++ b/service/budgets/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/budgets/api_op_CreateBudget.go b/service/budgets/api_op_CreateBudget.go index f1a81ef8f56..6a9e3d80767 100644 --- a/service/budgets/api_op_CreateBudget.go +++ b/service/budgets/api_op_CreateBudget.go @@ -12,10 +12,9 @@ import ( ) // Creates a budget and, if included, notifications and subscribers. Only one of -// BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use -// the syntax that matches your case. The Request Syntax section shows the -// BudgetLimit syntax. For PlannedBudgetLimits, see the Examples -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples) +// BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. +// Use the syntax that matches your case. The Request Syntax section shows the +// BudgetLimit syntax. For PlannedBudgetLimits , see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples) // section. func (c *Client) CreateBudget(ctx context.Context, params *CreateBudgetInput, optFns ...func(*Options)) (*CreateBudgetOutput, error) { if params == nil { @@ -45,9 +44,9 @@ type CreateBudgetInput struct { // This member is required. Budget *types.Budget - // A notification that you want to associate with a budget. A budget can have up to - // five notifications, and each notification can have one SNS subscriber and up to - // 10 email subscribers. If you include notifications and subscribers in your + // A notification that you want to associate with a budget. A budget can have up + // to five notifications, and each notification can have one SNS subscriber and up + // to 10 email subscribers. If you include notifications and subscribers in your // CreateBudget call, Amazon Web Services creates the notifications and subscribers // for you. NotificationsWithSubscribers []types.NotificationWithSubscribers diff --git a/service/budgets/api_op_CreateBudgetAction.go b/service/budgets/api_op_CreateBudgetAction.go index d2e6f667d17..f6bf5d33d7a 100644 --- a/service/budgets/api_op_CreateBudgetAction.go +++ b/service/budgets/api_op_CreateBudgetAction.go @@ -61,8 +61,8 @@ type CreateBudgetActionInput struct { // This member is required. Definition *types.Definition - // The role passed for action execution and reversion. Roles and actions must be in - // the same account. + // The role passed for action execution and reversion. Roles and actions must be + // in the same account. // // This member is required. ExecutionRoleArn *string diff --git a/service/budgets/api_op_DeleteBudget.go b/service/budgets/api_op_DeleteBudget.go index a8232160d61..cf748ace1b4 100644 --- a/service/budgets/api_op_DeleteBudget.go +++ b/service/budgets/api_op_DeleteBudget.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a budget. You can delete your budget at any time. Deleting a budget also -// deletes the notifications and subscribers that are associated with that budget. +// Deletes a budget. You can delete your budget at any time. Deleting a budget +// also deletes the notifications and subscribers that are associated with that +// budget. func (c *Client) DeleteBudget(ctx context.Context, params *DeleteBudgetInput, optFns ...func(*Options)) (*DeleteBudgetOutput, error) { if params == nil { params = &DeleteBudgetInput{} diff --git a/service/budgets/api_op_DescribeBudget.go b/service/budgets/api_op_DescribeBudget.go index e096c2a8b57..ad92f09ac44 100644 --- a/service/budgets/api_op_DescribeBudget.go +++ b/service/budgets/api_op_DescribeBudget.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a budget. The Request Syntax section shows the BudgetLimit syntax. For -// PlannedBudgetLimits, see the Examples -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples) +// Describes a budget. The Request Syntax section shows the BudgetLimit syntax. +// For PlannedBudgetLimits , see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples) // section. func (c *Client) DescribeBudget(ctx context.Context, params *DescribeBudgetInput, optFns ...func(*Options)) (*DescribeBudgetOutput, error) { if params == nil { diff --git a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go index 44e70605a04..cd42a0e9444 100644 --- a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go +++ b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history -// isn't available for ANNUAL budgets. +// Describes the history for DAILY , MONTHLY , and QUARTERLY budgets. Budget +// history isn't available for ANNUAL budgets. func (c *Client) DescribeBudgetPerformanceHistory(ctx context.Context, params *DescribeBudgetPerformanceHistoryInput, optFns ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error) { if params == nil { params = &DescribeBudgetPerformanceHistoryInput{} diff --git a/service/budgets/api_op_DescribeBudgets.go b/service/budgets/api_op_DescribeBudgets.go index f2da9814cfe..613fd90cc1b 100644 --- a/service/budgets/api_op_DescribeBudgets.go +++ b/service/budgets/api_op_DescribeBudgets.go @@ -13,8 +13,7 @@ import ( ) // Lists the budgets that are associated with an account. The Request Syntax -// section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples) +// section shows the BudgetLimit syntax. For PlannedBudgetLimits , see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples) // section. func (c *Client) DescribeBudgets(ctx context.Context, params *DescribeBudgetsInput, optFns ...func(*Options)) (*DescribeBudgetsOutput, error) { if params == nil { diff --git a/service/budgets/api_op_UpdateBudget.go b/service/budgets/api_op_UpdateBudget.go index 62b76ca9efa..e7bc8dcfb9b 100644 --- a/service/budgets/api_op_UpdateBudget.go +++ b/service/budgets/api_op_UpdateBudget.go @@ -12,13 +12,12 @@ import ( ) // Updates a budget. You can change every part of a budget except for the -// budgetName and the calculatedSpend. When you modify a budget, the +// budgetName and the calculatedSpend . When you modify a budget, the // calculatedSpend drops to zero until Amazon Web Services has new usage data to // use for forecasting. Only one of BudgetLimit or PlannedBudgetLimits can be // present in the syntax at one time. Use the syntax that matches your case. The -// Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, -// see the Examples -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples) +// Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits , +// see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples) // section. func (c *Client) UpdateBudget(ctx context.Context, params *UpdateBudgetInput, optFns ...func(*Options)) (*UpdateBudgetOutput, error) { if params == nil { diff --git a/service/budgets/api_op_UpdateBudgetAction.go b/service/budgets/api_op_UpdateBudgetAction.go index 94908cb3537..15029ee3721 100644 --- a/service/budgets/api_op_UpdateBudgetAction.go +++ b/service/budgets/api_op_UpdateBudgetAction.go @@ -54,8 +54,8 @@ type UpdateBudgetActionInput struct { // Specifies all of the type-specific parameters. Definition *types.Definition - // The role passed for action execution and reversion. Roles and actions must be in - // the same account. + // The role passed for action execution and reversion. Roles and actions must be + // in the same account. ExecutionRoleArn *string // The type of a notification. It must be ACTUAL or FORECASTED. diff --git a/service/budgets/doc.go b/service/budgets/doc.go index c5b5d967f1f..46cac25234b 100644 --- a/service/budgets/doc.go +++ b/service/budgets/doc.go @@ -1,53 +1,38 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package budgets provides the API client, operations, and parameter types for AWS -// Budgets. +// Package budgets provides the API client, operations, and parameter types for +// AWS Budgets. // // Use the Amazon Web Services Budgets API to plan your service usage, service // costs, and instance reservations. This API reference provides descriptions, // syntax, and usage examples for each of the actions and data types for the Amazon // Web Services Budgets feature. Budgets provide you with a way to see the // following information: -// -// * How close your plan is to your budgeted amount or to -// the free tier limits -// -// * Your usage-to-date, including how much you've used of -// your Reserved Instances (RIs) -// -// * Your current estimated charges from Amazon Web -// Services, and how much your predicted usage will accrue in charges by the end of -// the month -// -// * How much of your budget has been used -// -// Amazon Web Services updates -// your budget status several times a day. Budgets track your unblended costs, -// subscriptions, refunds, and RIs. You can create the following types of -// budgets: -// -// * Cost budgets - Plan how much you want to spend on a service. -// -// * -// Usage budgets - Plan how much you want to use one or more services. -// -// * RI -// utilization budgets - Define a utilization threshold, and receive alerts when -// your RI usage falls below that threshold. This lets you see if your RIs are -// unused or under-utilized. -// -// * RI coverage budgets - Define a coverage threshold, -// and receive alerts when the number of your instance hours that are covered by -// RIs fall below that threshold. This lets you see how much of your instance usage -// is covered by a reservation. -// -// Service Endpoint The Amazon Web Services Budgets -// API provides the following endpoint: -// -// * https://budgets.amazonaws.com -// -// For -// information about costs that are associated with the Amazon Web Services Budgets -// API, see Amazon Web Services Cost Management Pricing -// (https://aws.amazon.com/aws-cost-management/pricing/). +// - How close your plan is to your budgeted amount or to the free tier limits +// - Your usage-to-date, including how much you've used of your Reserved +// Instances (RIs) +// - Your current estimated charges from Amazon Web Services, and how much your +// predicted usage will accrue in charges by the end of the month +// - How much of your budget has been used +// +// Amazon Web Services updates your budget status several times a day. Budgets +// track your unblended costs, subscriptions, refunds, and RIs. You can create the +// following types of budgets: +// - Cost budgets - Plan how much you want to spend on a service. +// - Usage budgets - Plan how much you want to use one or more services. +// - RI utilization budgets - Define a utilization threshold, and receive alerts +// when your RI usage falls below that threshold. This lets you see if your RIs are +// unused or under-utilized. +// - RI coverage budgets - Define a coverage threshold, and receive alerts when +// the number of your instance hours that are covered by RIs fall below that +// threshold. This lets you see how much of your instance usage is covered by a +// reservation. +// +// Service Endpoint The Amazon Web Services Budgets API provides the following +// endpoint: +// - https://budgets.amazonaws.com +// +// For information about costs that are associated with the Amazon Web Services +// Budgets API, see Amazon Web Services Cost Management Pricing (https://aws.amazon.com/aws-cost-management/pricing/) +// . package budgets diff --git a/service/budgets/types/enums.go b/service/budgets/types/enums.go index c7ee9d78edd..b51121dd2aa 100644 --- a/service/budgets/types/enums.go +++ b/service/budgets/types/enums.go @@ -18,9 +18,9 @@ const ( ActionStatusResetFailure ActionStatus = "RESET_FAILURE" ) -// Values returns all known values for ActionStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActionStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ActionStatus) Values() []ActionStatus { return []ActionStatus{ "STANDBY", @@ -167,9 +167,9 @@ const ( EventTypeExecuteAction EventType = "EXECUTE_ACTION" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "SYSTEM", diff --git a/service/budgets/types/errors.go b/service/budgets/types/errors.go index a81fb7a7346..ff8d4600952 100644 --- a/service/budgets/types/errors.go +++ b/service/budgets/types/errors.go @@ -111,8 +111,8 @@ func (e *ExpiredNextTokenException) ErrorCode() string { } func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An error on the server occurred during the processing of your request. Try again -// later. +// An error on the server occurred during the processing of your request. Try +// again later. type InternalErrorException struct { Message *string diff --git a/service/budgets/types/types.go b/service/budgets/types/types.go index 5e592787a20..34bc3e0b082 100644 --- a/service/budgets/types/types.go +++ b/service/budgets/types/types.go @@ -42,8 +42,8 @@ type Action struct { // This member is required. Definition *Definition - // The role passed for action execution and reversion. Roles and actions must be in - // the same account. + // The role passed for action execution and reversion. Roles and actions must be + // in the same account. // // This member is required. ExecutionRoleArn *string @@ -144,14 +144,14 @@ type AutoAdjustData struct { noSmithyDocumentSerde } -// Represents the output of the CreateBudget operation. The content consists of the -// detailed metadata and data file information, and the current status of the +// Represents the output of the CreateBudget operation. The content consists of +// the detailed metadata and data file information, and the current status of the // budget object. This is the Amazon Resource Name (ARN) pattern for a budget: // arn:aws:budgets::AccountId:budget/budgetName type Budget struct { // The name of a budget. The name must be unique within an account. The : and \ - // characters aren't allowed in BudgetName. + // characters aren't allowed in BudgetName . // // This member is required. BudgetName *string @@ -174,7 +174,7 @@ type Budget struct { // utilization, or Savings Plans coverage that you want to track with your budget. // BudgetLimit is required for cost or usage budgets, but optional for RI or // Savings Plans utilization or coverage budgets. RI and Savings Plans utilization - // or coverage budgets default to 100. This is the only valid value for RI or + // or coverage budgets default to 100 . This is the only valid value for RI or // Savings Plans utilization or coverage budgets. You can't use BudgetLimit with // PlannedBudgetLimits for CreateBudget and UpdateBudget actions. BudgetLimit *Spend @@ -182,66 +182,59 @@ type Budget struct { // The actual and forecasted cost or usage that the budget tracks. CalculatedSpend *CalculatedSpend - // The cost filters, such as Region, Service, member account, Tag, or Cost - // Category, that are applied to a budget. Amazon Web Services Budgets supports the - // following services as a Service filter for RI budgets: - // - // * Amazon EC2 - // - // * Amazon - // Redshift - // - // * Amazon Relational Database Service - // - // * Amazon ElastiCache - // - // * Amazon - // OpenSearch Service + // The cost filters, such as Region , Service , member account , Tag , or Cost + // Category , that are applied to a budget. Amazon Web Services Budgets supports + // the following services as a Service filter for RI budgets: + // - Amazon EC2 + // - Amazon Redshift + // - Amazon Relational Database Service + // - Amazon ElastiCache + // - Amazon OpenSearch Service CostFilters map[string][]string - // The types of costs that are included in this COST budget. USAGE, RI_UTILIZATION, - // RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do - // not have CostTypes. + // The types of costs that are included in this COST budget. USAGE , RI_UTILIZATION + // , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION , and SAVINGS_PLANS_COVERAGE budgets + // do not have CostTypes . CostTypes *CostTypes // The last time that you updated this budget. LastUpdatedTime *time.Time - // A map containing multiple BudgetLimit, including current or future limits. + // A map containing multiple BudgetLimit , including current or future limits. // PlannedBudgetLimits is available for cost or usage budget and supports both - // monthly and quarterly TimeUnit. For monthly budgets, provide 12 months of + // monthly and quarterly TimeUnit . For monthly budgets, provide 12 months of // PlannedBudgetLimits values. This must start from the current month and include - // the next 11 months. The key is the start of the month, UTC in epoch seconds. For - // quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in - // standard calendar quarter increments. This must start from the current quarter - // and include the next three quarters. The key is the start of the quarter, UTC in - // epoch seconds. If the planned budget expires before 12 months for monthly or - // four quarters for quarterly, provide the PlannedBudgetLimits values only for the - // remaining periods. If the budget begins at a date in the future, provide - // PlannedBudgetLimits values from the start date of the budget. After all of the - // BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use - // the last limit as the BudgetLimit. At that point, the planned budget provides - // the same experience as a fixed budget. DescribeBudget and DescribeBudgets - // response along with PlannedBudgetLimits also contain BudgetLimit representing - // the current month or quarter limit present in PlannedBudgetLimits. This only - // applies to budgets that are created with PlannedBudgetLimits. Budgets that are - // created without PlannedBudgetLimits only contain BudgetLimit. They don't contain - // PlannedBudgetLimits. + // the next 11 months. The key is the start of the month, UTC in epoch seconds. + // For quarterly budgets, provide four quarters of PlannedBudgetLimits value + // entries in standard calendar quarter increments. This must start from the + // current quarter and include the next three quarters. The key is the start of + // the quarter, UTC in epoch seconds. If the planned budget expires before 12 + // months for monthly or four quarters for quarterly, provide the + // PlannedBudgetLimits values only for the remaining periods. If the budget begins + // at a date in the future, provide PlannedBudgetLimits values from the start date + // of the budget. After all of the BudgetLimit values in PlannedBudgetLimits are + // used, the budget continues to use the last limit as the BudgetLimit . At that + // point, the planned budget provides the same experience as a fixed budget. + // DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also + // contain BudgetLimit representing the current month or quarter limit present in + // PlannedBudgetLimits . This only applies to budgets that are created with + // PlannedBudgetLimits . Budgets that are created without PlannedBudgetLimits only + // contain BudgetLimit . They don't contain PlannedBudgetLimits . PlannedBudgetLimits map[string]Spend // The period of time that's covered by a budget. You setthe start date and end // date. The start date must come before the end date. The end date must come - // before 06/15/87 00:00 UTC. If you create your budget and don't specify a start + // before 06/15/87 00:00 UTC . If you create your budget and don't specify a start // date, Amazon Web Services defaults to the start of your chosen time period // (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your - // budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web - // Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon - // Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an - // end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The - // defaults are the same for the Billing and Cost Management console and the API. - // You can change either date with the UpdateBudget operation. After the end date, - // Amazon Web Services deletes the budget and all the associated notifications and - // subscribers. + // budget on January 24, 2018, chose DAILY , and didn't set a start date, Amazon + // Web Services set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , + // Amazon Web Services set your start date to 01/01/18 00:00 UTC . If you didn't + // specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC + // . The defaults are the same for the Billing and Cost Management console and the + // API. You can change either date with the UpdateBudget operation. After the end + // date, Amazon Web Services deletes the budget and all the associated + // notifications and subscribers. TimePeriod *TimePeriod noSmithyDocumentSerde @@ -284,9 +277,9 @@ type BudgetPerformanceHistory struct { // allowed. BudgetName *string - // The type of a budget. It must be one of the following types: COST, USAGE, - // RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or - // SAVINGS_PLANS_COVERAGE. + // The type of a budget. It must be one of the following types: COST , USAGE , + // RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION , or + // SAVINGS_PLANS_COVERAGE . BudgetType BudgetType // A list of amounts of cost or usage that you created budgets for, which are @@ -309,8 +302,8 @@ type BudgetPerformanceHistory struct { // how much you've used, cost, usage, RI units, or Savings Plans units and the // forecastedSpend tracks how much that you're predicted to spend based on your // historical usage profile. For example, if it's the 20th of the month and you -// have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your -// forecastedSpend is 75 USD. +// have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD , and your +// forecastedSpend is 75 USD . type CalculatedSpend struct { // The amount of cost, usage, RI units, or Savings Plans units that you used. @@ -326,44 +319,44 @@ type CalculatedSpend struct { } // The types of cost that are included in a COST budget, such as tax and -// subscriptions. USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, -// and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes. +// subscriptions. USAGE , RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION +// , and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes . type CostTypes struct { - // Specifies whether a budget includes credits. The default value is true. + // Specifies whether a budget includes credits. The default value is true . IncludeCredit *bool - // Specifies whether a budget includes discounts. The default value is true. + // Specifies whether a budget includes discounts. The default value is true . IncludeDiscount *bool - // Specifies whether a budget includes non-RI subscription costs. The default value - // is true. + // Specifies whether a budget includes non-RI subscription costs. The default + // value is true . IncludeOtherSubscription *bool // Specifies whether a budget includes recurring fees such as monthly RI fees. The - // default value is true. + // default value is true . IncludeRecurring *bool - // Specifies whether a budget includes refunds. The default value is true. + // Specifies whether a budget includes refunds. The default value is true . IncludeRefund *bool - // Specifies whether a budget includes subscriptions. The default value is true. + // Specifies whether a budget includes subscriptions. The default value is true . IncludeSubscription *bool - // Specifies whether a budget includes support subscription fees. The default value - // is true. + // Specifies whether a budget includes support subscription fees. The default + // value is true . IncludeSupport *bool - // Specifies whether a budget includes taxes. The default value is true. + // Specifies whether a budget includes taxes. The default value is true . IncludeTax *bool - // Specifies whether a budget includes upfront RI costs. The default value is true. + // Specifies whether a budget includes upfront RI costs. The default value is true . IncludeUpfront *bool - // Specifies whether a budget uses the amortized rate. The default value is false. + // Specifies whether a budget uses the amortized rate. The default value is false . UseAmortized *bool - // Specifies whether a budget uses a blended rate. The default value is false. + // Specifies whether a budget uses a blended rate. The default value is false . UseBlended *bool noSmithyDocumentSerde @@ -391,30 +384,23 @@ type HistoricalOptions struct { // The number of budget periods included in the moving-average calculation that // determines your auto-adjusted budget amount. The maximum value depends on the // TimeUnit granularity of the budget: - // - // * For the DAILY granularity, the maximum - // value is 60. - // - // * For the MONTHLY granularity, the maximum value is 12. - // - // * For the - // QUARTERLY granularity, the maximum value is 4. - // - // * For the ANNUALLY granularity, - // the maximum value is 1. + // - For the DAILY granularity, the maximum value is 60 . + // - For the MONTHLY granularity, the maximum value is 12 . + // - For the QUARTERLY granularity, the maximum value is 4 . + // - For the ANNUALLY granularity, the maximum value is 1 . // // This member is required. BudgetAdjustmentPeriod *int32 // The integer that describes how many budget periods in your // BudgetAdjustmentPeriod are included in the calculation of your current - // BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no + // BudgetLimit . If the first budget period in your BudgetAdjustmentPeriod has no // cost data, then that budget period isn’t included in the average that determines - // your budget limit. For example, if you set BudgetAdjustmentPeriod as 4 quarters, - // but your account had no cost data in the first quarter, then only the last three - // quarters are included in the calculation. In this scenario, - // LookBackAvailablePeriods returns 3. You can’t set your own - // LookBackAvailablePeriods. The value is automatically calculated from the + // your budget limit. For example, if you set BudgetAdjustmentPeriod as 4 + // quarters, but your account had no cost data in the first quarter, then only the + // last three quarters are included in the calculation. In this scenario, + // LookBackAvailablePeriods returns 3 . You can’t set your own + // LookBackAvailablePeriods . The value is automatically calculated from the // BudgetAdjustmentPeriod and your historical cost data. LookBackAvailablePeriods *int32 @@ -447,16 +433,10 @@ type IamActionDefinition struct { // total of 11 subscribers. For example, if you have a budget for 200 dollars and // you want to be notified when you go over 160 dollars, create a notification with // the following parameters: -// -// * A notificationType of ACTUAL -// -// * A thresholdType of -// PERCENTAGE -// -// * A comparisonOperator of GREATER_THAN -// -// * A notification threshold -// of 80 +// - A notificationType of ACTUAL +// - A thresholdType of PERCENTAGE +// - A comparisonOperator of GREATER_THAN +// - A notification threshold of 80 type Notification struct { // The comparison that's used for this notification. @@ -464,8 +444,8 @@ type Notification struct { // This member is required. ComparisonOperator ComparisonOperator - // Specifies whether the notification is for how much you have spent (ACTUAL) or - // for how much that you're forecasted to spend (FORECASTED). + // Specifies whether the notification is for how much you have spent ( ACTUAL ) or + // for how much that you're forecasted to spend ( FORECASTED ). // // This member is required. NotificationType NotificationType @@ -487,8 +467,8 @@ type Notification struct { // total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies // you when you go over or are forecasted to go over a certain percentage of your // forecasted spend. For example, if you have a budget for 200 dollars and you have - // a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over - // 160 dollars. + // a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go + // over 160 dollars. ThresholdType ThresholdType noSmithyDocumentSerde @@ -529,15 +509,12 @@ type ScpActionDefinition struct { // The amount of cost or usage that's measured for a budget. For example, a Spend // for 3 GB of S3 usage has the following parameters: -// -// * An Amount of 3 -// -// * A unit -// of GB +// - An Amount of 3 +// - A unit of GB type Spend struct { - // The cost or usage amount that's associated with a budget forecast, actual spend, - // or budget threshold. + // The cost or usage amount that's associated with a budget forecast, actual + // spend, or budget threshold. // // This member is required. Amount *string @@ -575,11 +552,8 @@ type SsmActionDefinition struct { // The subscriber to a budget notification. The subscriber consists of a // subscription type and either an Amazon SNS topic or an email address. For // example, an email subscriber has the following parameters: -// -// * A subscriptionType -// of EMAIL -// -// * An address of example@example.com +// - A subscriptionType of EMAIL +// - An address of example@example.com type Subscriber struct { // The address that Amazon Web Services sends budget notifications to, either an @@ -603,7 +577,7 @@ type Subscriber struct { type TimePeriod struct { // The end date for a budget. If you didn't specify an end date, Amazon Web - // Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for + // Services set your end date to 06/15/87 00:00 UTC . The defaults are the same for // the Billing and Cost Management console and the API. After the end date, Amazon // Web Services deletes the budget and all the associated notifications and // subscribers. You can change your end date with the UpdateBudget operation. @@ -612,10 +586,10 @@ type TimePeriod struct { // The start date for a budget. If you created your budget and didn't specify a // start date, Amazon Web Services defaults to the start of your chosen time period // (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your - // budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web - // Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon - // Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the - // same for the Billing and Cost Management console and the API. You can change + // budget on January 24, 2018, chose DAILY , and didn't set a start date, Amazon + // Web Services set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , + // Amazon Web Services set your start date to 01/01/18 00:00 UTC . The defaults are + // the same for the Billing and Cost Management console and the API. You can change // your start date with the UpdateBudget operation. Start *time.Time diff --git a/service/chime/api_client.go b/service/chime/api_client.go index f3495e4b25e..22a32a134f6 100644 --- a/service/chime/api_client.go +++ b/service/chime/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go b/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go index f6f75ea31d5..423b415d4ca 100644 --- a/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go +++ b/service/chime/api_op_AssociateSigninDelegateGroupsWithAccount.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified sign-in delegate groups with the specified Amazon Chime -// account. +// Associates the specified sign-in delegate groups with the specified Amazon +// Chime account. func (c *Client) AssociateSigninDelegateGroupsWithAccount(ctx context.Context, params *AssociateSigninDelegateGroupsWithAccountInput, optFns ...func(*Options)) (*AssociateSigninDelegateGroupsWithAccountOutput, error) { if params == nil { params = &AssociateSigninDelegateGroupsWithAccountInput{} diff --git a/service/chime/api_op_BatchCreateAttendee.go b/service/chime/api_op_BatchCreateAttendee.go index eb62ad55e34..0664839c960 100644 --- a/service/chime/api_op_BatchCreateAttendee.go +++ b/service/chime/api_op_BatchCreateAttendee.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For +// more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) BatchCreateAttendee(ctx context.Context, params *BatchCreateAttendeeInput, optFns ...func(*Options)) (*BatchCreateAttendeeOutput, error) { if params == nil { params = &BatchCreateAttendeeInput{} diff --git a/service/chime/api_op_BatchCreateChannelMembership.go b/service/chime/api_op_BatchCreateChannelMembership.go index 3955b18d98b..b1cac04c80b 100644 --- a/service/chime/api_op_BatchCreateChannelMembership.go +++ b/service/chime/api_op_BatchCreateChannelMembership.go @@ -43,9 +43,9 @@ type BatchCreateChannelMembershipInput struct { // The AppInstanceUserArn of the user that makes the API call. ChimeBearer *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are always - // returned as part of ListChannelMemberships. Hidden members are only returned if - // the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden + // The membership type of a user, DEFAULT or HIDDEN . Default members are always + // returned as part of ListChannelMemberships . Hidden members are only returned if + // the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden // members are not returned. This is only supported by moderators. Type types.ChannelMembershipType @@ -57,8 +57,8 @@ type BatchCreateChannelMembershipOutput struct { // The list of channel memberships in the response. BatchChannelMemberships *types.BatchChannelMemberships - // If the action fails for one or more of the memberships in the request, a list of - // the memberships is returned, along with error codes and error messages. + // If the action fails for one or more of the memberships in the request, a list + // of the memberships is returned, along with error codes and error messages. Errors []types.BatchCreateChannelMembershipError // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_BatchDeletePhoneNumber.go b/service/chime/api_op_BatchDeletePhoneNumber.go index f9305c8a46e..7f414f1bd08 100644 --- a/service/chime/api_op_BatchDeletePhoneNumber.go +++ b/service/chime/api_op_BatchDeletePhoneNumber.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves phone numbers into the Deletion queue. Phone numbers must be disassociated -// from any users or Amazon Chime Voice Connectors before they can be deleted. -// Phone numbers remain in the Deletion queue for 7 days before they are deleted -// permanently. +// Moves phone numbers into the Deletion queue. Phone numbers must be +// disassociated from any users or Amazon Chime Voice Connectors before they can be +// deleted. Phone numbers remain in the Deletion queue for 7 days before they are +// deleted permanently. func (c *Client) BatchDeletePhoneNumber(ctx context.Context, params *BatchDeletePhoneNumberInput, optFns ...func(*Options)) (*BatchDeletePhoneNumberOutput, error) { if params == nil { params = &BatchDeletePhoneNumberInput{} diff --git a/service/chime/api_op_BatchUnsuspendUser.go b/service/chime/api_op_BatchUnsuspendUser.go index ecdc27c7461..a3c1d57c427 100644 --- a/service/chime/api_op_BatchUnsuspendUser.go +++ b/service/chime/api_op_BatchUnsuspendUser.go @@ -14,11 +14,10 @@ import ( // Removes the suspension from up to 50 previously suspended users for the // specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA // accounts can be unsuspended using this action. For more information about -// different account types, see Managing Your Amazon Chime Accounts -// (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the -// account types, in the Amazon Chime Administration Guide. Previously suspended -// users who are unsuspended using this action are returned to Registered status. -// Users who are not previously suspended are ignored. +// different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) +// in the account types, in the Amazon Chime Administration Guide. Previously +// suspended users who are unsuspended using this action are returned to Registered +// status. Users who are not previously suspended are ignored. func (c *Client) BatchUnsuspendUser(ctx context.Context, params *BatchUnsuspendUserInput, optFns ...func(*Options)) (*BatchUnsuspendUserOutput, error) { if params == nil { params = &BatchUnsuspendUserInput{} diff --git a/service/chime/api_op_BatchUpdatePhoneNumber.go b/service/chime/api_op_BatchUpdatePhoneNumber.go index e50170c2b75..900c556cf94 100644 --- a/service/chime/api_op_BatchUpdatePhoneNumber.go +++ b/service/chime/api_op_BatchUpdatePhoneNumber.go @@ -12,7 +12,7 @@ import ( ) // Updates phone number product types or calling names. You can update one -// attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can +// attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can // update the product type or the calling name. For toll-free numbers, you cannot // use the Amazon Chime Business Calling product type. For numbers outside the // U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. diff --git a/service/chime/api_op_CreateAccount.go b/service/chime/api_op_CreateAccount.go index 0734b91358f..05a62ed0dd9 100644 --- a/service/chime/api_op_CreateAccount.go +++ b/service/chime/api_op_CreateAccount.go @@ -13,9 +13,8 @@ import ( // Creates an Amazon Chime account under the administrator's AWS account. Only Team // account types are currently supported for this action. For more information -// about different account types, see Managing Your Amazon Chime Accounts -// (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the -// Amazon Chime Administration Guide. +// about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) +// in the Amazon Chime Administration Guide. func (c *Client) CreateAccount(ctx context.Context, params *CreateAccountInput, optFns ...func(*Options)) (*CreateAccountOutput, error) { if params == nil { params = &CreateAccountInput{} diff --git a/service/chime/api_op_CreateAppInstance.go b/service/chime/api_op_CreateAppInstance.go index 9bb9c2e2a2b..27faac1e1f8 100644 --- a/service/chime/api_op_CreateAppInstance.go +++ b/service/chime/api_op_CreateAppInstance.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK -// messaging customers use this API. CreateAppInstance supports idempotency +// Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only +// SDK messaging customers use this API. CreateAppInstance supports idempotency // behavior as described in the AWS API Standard. func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanceInput, optFns ...func(*Options)) (*CreateAppInstanceOutput, error) { if params == nil { @@ -32,20 +32,20 @@ func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanc type CreateAppInstanceInput struct { - // The ClientRequestToken of the AppInstance. + // The ClientRequestToken of the AppInstance . // // This member is required. ClientRequestToken *string - // The name of the AppInstance. + // The name of the AppInstance . // // This member is required. Name *string - // The metadata of the AppInstance. Limited to a 1KB string in UTF-8. + // The metadata of the AppInstance . Limited to a 1KB string in UTF-8. Metadata *string - // Tags assigned to the AppInstance. + // Tags assigned to the AppInstance . Tags []types.Tag noSmithyDocumentSerde @@ -53,7 +53,7 @@ type CreateAppInstanceInput struct { type CreateAppInstanceOutput struct { - // The Amazon Resource Number (ARN) of the AppInstance. + // The Amazon Resource Number (ARN) of the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_CreateAppInstanceAdmin.go b/service/chime/api_op_CreateAppInstanceAdmin.go index c2f2f03fabb..d3b9a572d25 100644 --- a/service/chime/api_op_CreateAppInstanceAdmin.go +++ b/service/chime/api_op_CreateAppInstanceAdmin.go @@ -12,16 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can +// Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can // perform the following actions. +// - ChannelModerator actions across all channels in the AppInstance . +// - DeleteChannelMessage actions. // -// * ChannelModerator actions across all channels -// in the AppInstance. -// -// * DeleteChannelMessage actions. -// -// Only an AppInstanceUser -// can be promoted to an AppInstanceAdmin role. +// Only an AppInstanceUser can be promoted to an AppInstanceAdmin role. func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppInstanceAdminInput, optFns ...func(*Options)) (*CreateAppInstanceAdminOutput, error) { if params == nil { params = &CreateAppInstanceAdminInput{} @@ -39,12 +35,12 @@ func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppIn type CreateAppInstanceAdminInput struct { - // The ARN of the administrator of the current AppInstance. + // The ARN of the administrator of the current AppInstance . // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -54,10 +50,10 @@ type CreateAppInstanceAdminInput struct { type CreateAppInstanceAdminOutput struct { - // The name and ARN of the admin for the AppInstance. + // The name and ARN of the admin for the AppInstance . AppInstanceAdmin *types.Identity - // The ARN of the of the admin for the AppInstance. + // The ARN of the of the admin for the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_CreateAppInstanceUser.go b/service/chime/api_op_CreateAppInstanceUser.go index 350b4e51cb6..eeaf530d5d6 100644 --- a/service/chime/api_op_CreateAppInstanceUser.go +++ b/service/chime/api_op_CreateAppInstanceUser.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user under an Amazon Chime AppInstance. The request consists of a +// Creates a user under an Amazon Chime AppInstance . The request consists of a // unique appInstanceUserId and Name for that user. func (c *Client) CreateAppInstanceUser(ctx context.Context, params *CreateAppInstanceUserInput, optFns ...func(*Options)) (*CreateAppInstanceUserOutput, error) { if params == nil { @@ -36,12 +36,12 @@ type CreateAppInstanceUserInput struct { // This member is required. AppInstanceArn *string - // The user ID of the AppInstance. + // The user ID of the AppInstance . // // This member is required. AppInstanceUserId *string - // The token assigned to the user requesting an AppInstance. + // The token assigned to the user requesting an AppInstance . // // This member is required. ClientRequestToken *string @@ -54,7 +54,7 @@ type CreateAppInstanceUserInput struct { // The request's metadata. Limited to a 1KB string in UTF-8. Metadata *string - // Tags assigned to the AppInstanceUser. + // Tags assigned to the AppInstanceUser . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/chime/api_op_CreateAttendee.go b/service/chime/api_op_CreateAttendee.go index af169a0ad17..c09887b344a 100644 --- a/service/chime/api_op_CreateAttendee.go +++ b/service/chime/api_op_CreateAttendee.go @@ -12,9 +12,8 @@ import ( ) // Creates a new attendee for an active Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) CreateAttendee(ctx context.Context, params *CreateAttendeeInput, optFns ...func(*Options)) (*CreateAttendeeOutput, error) { if params == nil { params = &CreateAttendeeInput{} diff --git a/service/chime/api_op_CreateChannel.go b/service/chime/api_op_CreateChannel.go index 908212a0d7f..22fff1ab151 100644 --- a/service/chime/api_op_CreateChannel.go +++ b/service/chime/api_op_CreateChannel.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a channel to which you can add users and send messages. Restriction: You -// can't change a channel's privacy. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// Creates a channel to which you can add users and send messages. Restriction: +// You can't change a channel's privacy. The x-amz-chime-bearer request header is +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error) { if params == nil { params = &CreateChannelInput{} @@ -54,14 +54,14 @@ type CreateChannelInput struct { // The metadata of the creation request. Limited to 1KB and UTF-8. Metadata *string - // The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and + // The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and // channel members can add themselves and other members to unrestricted channels. // Only administrators and moderators can add members to restricted channels. Mode types.ChannelMode - // The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't + // The channel's privacy level: PUBLIC or PRIVATE . Private channels aren't // discoverable by users outside the channel. Public channels are discoverable by - // anyone in the AppInstance. + // anyone in the AppInstance . Privacy types.ChannelPrivacy // The tags for the creation request. diff --git a/service/chime/api_op_CreateChannelBan.go b/service/chime/api_op_CreateChannelBan.go index fcea56f1fd5..99b1d0688fb 100644 --- a/service/chime/api_op_CreateChannelBan.go +++ b/service/chime/api_op_CreateChannelBan.go @@ -12,13 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently bans a member from a channel. Moderators can't add banned members to -// a channel. To undo a ban, you first have to DeleteChannelBan, and then -// CreateChannelMembership. Bans are cleaned up when you delete users or channels. +// Permanently bans a member from a channel. Moderators can't add banned members +// to a channel. To undo a ban, you first have to DeleteChannelBan , and then +// CreateChannelMembership . Bans are cleaned up when you delete users or channels. // If you ban a user who is already part of a channel, that user is automatically -// kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use -// the AppInstanceUserArn of the user that makes the API call as the value in the -// header. +// kicked from the channel. The x-amz-chime-bearer request header is mandatory. +// Use the AppInstanceUserArn of the user that makes the API call as the value in +// the header. func (c *Client) CreateChannelBan(ctx context.Context, params *CreateChannelBanInput, optFns ...func(*Options)) (*CreateChannelBanOutput, error) { if params == nil { params = &CreateChannelBanInput{} diff --git a/service/chime/api_op_CreateChannelMembership.go b/service/chime/api_op_CreateChannelMembership.go index 96820ceb172..9d89a5e8d88 100644 --- a/service/chime/api_op_CreateChannelMembership.go +++ b/service/chime/api_op_CreateChannelMembership.go @@ -14,30 +14,19 @@ import ( // Adds a user to a channel. The InvitedBy response field is derived from the // request header. A channel member can: +// - List messages +// - Send messages +// - Receive messages +// - Edit their own messages +// - Leave the channel // -// * List messages +// Privacy settings impact this action as follows: +// - Public Channels: You do not need to be a member to list messages, but you +// must be a member to send messages. +// - Private Channels: You must be a member to list or send messages. // -// * Send messages -// -// * -// Receive messages -// -// * Edit their own messages -// -// * Leave the channel -// -// Privacy -// settings impact this action as follows: -// -// * Public Channels: You do not need to -// be a member to list messages, but you must be a member to send messages. -// -// * -// Private Channels: You must be a member to list or send messages. -// -// The -// x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of -// the user that makes the API call as the value in the header. +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. func (c *Client) CreateChannelMembership(ctx context.Context, params *CreateChannelMembershipInput, optFns ...func(*Options)) (*CreateChannelMembershipOutput, error) { if params == nil { params = &CreateChannelMembershipInput{} @@ -65,9 +54,9 @@ type CreateChannelMembershipInput struct { // This member is required. MemberArn *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are always - // returned as part of ListChannelMemberships. Hidden members are only returned if - // the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden + // The membership type of a user, DEFAULT or HIDDEN . Default members are always + // returned as part of ListChannelMemberships . Hidden members are only returned if + // the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden // members are not returned. This is only supported by moderators. // // This member is required. diff --git a/service/chime/api_op_CreateChannelModerator.go b/service/chime/api_op_CreateChannelModerator.go index 887f0ee57b7..0f2d3231d98 100644 --- a/service/chime/api_op_CreateChannelModerator.go +++ b/service/chime/api_op_CreateChannelModerator.go @@ -12,24 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new ChannelModerator. A channel moderator can: +// Creates a new ChannelModerator . A channel moderator can: +// - Add and remove other members of the channel. +// - Add and remove other moderators of the channel. +// - Add and remove user bans for the channel. +// - Redact messages in the channel. +// - List messages in the channel. // -// * Add and remove other -// members of the channel. -// -// * Add and remove other moderators of the channel. -// -// * -// Add and remove user bans for the channel. -// -// * Redact messages in the channel. -// -// * -// List messages in the channel. -// -// The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. func (c *Client) CreateChannelModerator(ctx context.Context, params *CreateChannelModeratorInput, optFns ...func(*Options)) (*CreateChannelModeratorOutput, error) { if params == nil { params = &CreateChannelModeratorInput{} diff --git a/service/chime/api_op_CreateMediaCapturePipeline.go b/service/chime/api_op_CreateMediaCapturePipeline.go index 494ded50749..9674d6a9c4a 100644 --- a/service/chime/api_op_CreateMediaCapturePipeline.go +++ b/service/chime/api_op_CreateMediaCapturePipeline.go @@ -46,14 +46,14 @@ type CreateMediaCapturePipelineInput struct { // This member is required. SourceArn *string - // Source type from which the media artifacts will be captured. A Chime SDK Meeting - // is the only supported source. + // Source type from which the media artifacts will be captured. A Chime SDK + // Meeting is the only supported source. // // This member is required. SourceType types.MediaPipelineSourceType // The configuration for a specified media capture pipeline. SourceType must be - // ChimeSdkMeeting. + // ChimeSdkMeeting . ChimeSdkMeetingConfiguration *types.ChimeSdkMeetingConfiguration // The token assigned to the client making the pipeline request. @@ -64,8 +64,8 @@ type CreateMediaCapturePipelineInput struct { type CreateMediaCapturePipelineOutput struct { - // A media capture pipeline object, the ID, source type, source ARN, sink type, and - // sink ARN of a media capture pipeline object. + // A media capture pipeline object, the ID, source type, source ARN, sink type, + // and sink ARN of a media capture pipeline object. MediaCapturePipeline *types.MediaCapturePipeline // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_CreateMeeting.go b/service/chime/api_op_CreateMeeting.go index f75708c36d1..86f3e6d9cc1 100644 --- a/service/chime/api_op_CreateMeeting.go +++ b/service/chime/api_op_CreateMeeting.go @@ -14,12 +14,10 @@ import ( // Creates a new Amazon Chime SDK meeting in the specified media Region with no // initial attendees. For more information about specifying media Regions, see -// Amazon Chime SDK Media Regions -// (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in -// the Amazon Chime Developer Guide . For more information about the Amazon Chime -// SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide . +// Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime Developer Guide . For more information about the Amazon +// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide . func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, optFns ...func(*Options)) (*CreateMeetingOutput, error) { if params == nil { params = &CreateMeetingInput{} @@ -46,18 +44,18 @@ type CreateMeetingInput struct { // The external meeting ID. ExternalMeetingId *string - // The Region in which to create the meeting. Default: us-east-1. Available values: - // af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , - // ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , - // eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , - // us-west-1 , us-west-2 . + // The Region in which to create the meeting. Default: us-east-1 . Available + // values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , + // ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , + // eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , + // us-east-2 , us-west-1 , us-west-2 . MediaRegion *string // Reserved. MeetingHostId *string - // The configuration for resource targets to receive notifications when meeting and - // attendee events occur. + // The configuration for resource targets to receive notifications when meeting + // and attendee events occur. NotificationsConfiguration *types.MeetingNotificationConfiguration // The tag key-value pairs. diff --git a/service/chime/api_op_CreateMeetingDialOut.go b/service/chime/api_op_CreateMeetingDialOut.go index 016547c9b3c..e68cf0309a9 100644 --- a/service/chime/api_op_CreateMeetingDialOut.go +++ b/service/chime/api_op_CreateMeetingDialOut.go @@ -38,8 +38,7 @@ type CreateMeetingDialOutInput struct { // This member is required. FromPhoneNumber *string - // Token used by the Amazon Chime SDK attendee. Call the CreateAttendee - // (https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html) + // Token used by the Amazon Chime SDK attendee. Call the CreateAttendee (https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html) // action to get a join token. // // This member is required. diff --git a/service/chime/api_op_CreateMeetingWithAttendees.go b/service/chime/api_op_CreateMeetingWithAttendees.go index bbf0c9a9815..8bbf7367bc7 100644 --- a/service/chime/api_op_CreateMeetingWithAttendees.go +++ b/service/chime/api_op_CreateMeetingWithAttendees.go @@ -13,13 +13,11 @@ import ( ) // Creates a new Amazon Chime SDK meeting in the specified media Region, with -// attendees. For more information about specifying media Regions, see Amazon Chime -// SDK Media Regions -// (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in -// the Amazon Chime Developer Guide . For more information about the Amazon Chime -// SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide . +// attendees. For more information about specifying media Regions, see Amazon +// Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime Developer Guide . For more information about the Amazon +// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide . func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateMeetingWithAttendeesInput, optFns ...func(*Options)) (*CreateMeetingWithAttendeesOutput, error) { if params == nil { params = &CreateMeetingWithAttendeesInput{} @@ -61,7 +59,7 @@ type CreateMeetingWithAttendeesInput struct { // The resource target configurations for receiving Amazon Chime SDK meeting and // attendee event notifications. The Amazon Chime SDK supports resource targets - // located in the US East (N. Virginia) AWS Region (us-east-1). + // located in the US East (N. Virginia) AWS Region ( us-east-1 ). NotificationsConfiguration *types.MeetingNotificationConfiguration // The tag key-value pairs. diff --git a/service/chime/api_op_CreatePhoneNumberOrder.go b/service/chime/api_op_CreatePhoneNumberOrder.go index 1dcd55c71df..f0b5430c7c6 100644 --- a/service/chime/api_op_CreatePhoneNumberOrder.go +++ b/service/chime/api_op_CreatePhoneNumberOrder.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an order for phone numbers to be provisioned. For toll-free numbers, you -// cannot use the Amazon Chime Business Calling product type. For numbers outside -// the U.S., you must use the Amazon Chime SIP Media Application Dial-In product -// type. +// Creates an order for phone numbers to be provisioned. For toll-free numbers, +// you cannot use the Amazon Chime Business Calling product type. For numbers +// outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In +// product type. func (c *Client) CreatePhoneNumberOrder(ctx context.Context, params *CreatePhoneNumberOrderInput, optFns ...func(*Options)) (*CreatePhoneNumberOrderOutput, error) { if params == nil { params = &CreatePhoneNumberOrderInput{} diff --git a/service/chime/api_op_CreateRoomMembership.go b/service/chime/api_op_CreateRoomMembership.go index 3951ff29da7..a0802df9d9e 100644 --- a/service/chime/api_op_CreateRoomMembership.go +++ b/service/chime/api_op_CreateRoomMembership.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a member to a chat room in an Amazon Chime Enterprise account. A member can -// be either a user or a bot. The member role designates whether the member is a -// chat room administrator or a general chat room member. +// Adds a member to a chat room in an Amazon Chime Enterprise account. A member +// can be either a user or a bot. The member role designates whether the member is +// a chat room administrator or a general chat room member. func (c *Client) CreateRoomMembership(ctx context.Context, params *CreateRoomMembershipInput, optFns ...func(*Options)) (*CreateRoomMembershipOutput, error) { if params == nil { params = &CreateRoomMembershipInput{} diff --git a/service/chime/api_op_CreateSipMediaApplicationCall.go b/service/chime/api_op_CreateSipMediaApplicationCall.go index 7b1158b5068..2b2fefbe130 100644 --- a/service/chime/api_op_CreateSipMediaApplicationCall.go +++ b/service/chime/api_op_CreateSipMediaApplicationCall.go @@ -12,7 +12,7 @@ import ( ) // Creates an outbound call to a phone number from the phone number specified in -// the request, and it invokes the endpoint of the specified sipMediaApplicationId. +// the request, and it invokes the endpoint of the specified sipMediaApplicationId . func (c *Client) CreateSipMediaApplicationCall(ctx context.Context, params *CreateSipMediaApplicationCallInput, optFns ...func(*Options)) (*CreateSipMediaApplicationCallOutput, error) { if params == nil { params = &CreateSipMediaApplicationCallInput{} diff --git a/service/chime/api_op_CreateSipRule.go b/service/chime/api_op_CreateSipRule.go index c99c9f38781..c4f77d811aa 100644 --- a/service/chime/api_op_CreateSipRule.go +++ b/service/chime/api_op_CreateSipRule.go @@ -41,18 +41,18 @@ type CreateSipRuleInput struct { // This member is required. TargetApplications []types.SipRuleTargetApplication - // The type of trigger assigned to the SIP rule in TriggerValue, currently - // RequestUriHostname or ToPhoneNumber. + // The type of trigger assigned to the SIP rule in TriggerValue , currently + // RequestUriHostname or ToPhoneNumber . // // This member is required. TriggerType types.SipRuleTriggerType - // If TriggerType is RequestUriHostname, the value can be the outbound host name of - // an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can - // be a customer-owned phone number in the E164 format. The SipMediaApplication + // If TriggerType is RequestUriHostname , the value can be the outbound host name + // of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , the value + // can be a customer-owned phone number in the E164 format. The SipMediaApplication // specified in the SipRule is triggered if the request URI in an incoming SIP - // request matches the RequestUriHostname, or if the To header in the incoming SIP - // request matches the ToPhoneNumber value. + // request matches the RequestUriHostname , or if the To header in the incoming + // SIP request matches the ToPhoneNumber value. // // This member is required. TriggerValue *string diff --git a/service/chime/api_op_DeleteAppInstance.go b/service/chime/api_op_DeleteAppInstance.go index 55a6f236559..b56381d8155 100644 --- a/service/chime/api_op_DeleteAppInstance.go +++ b/service/chime/api_op_DeleteAppInstance.go @@ -29,7 +29,7 @@ func (c *Client) DeleteAppInstance(ctx context.Context, params *DeleteAppInstanc type DeleteAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chime/api_op_DeleteAppInstanceAdmin.go b/service/chime/api_op_DeleteAppInstanceAdmin.go index ef1b1bb7b31..7069fee30b4 100644 --- a/service/chime/api_op_DeleteAppInstanceAdmin.go +++ b/service/chime/api_op_DeleteAppInstanceAdmin.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete +// Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete // the user. func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppInstanceAdminInput, optFns ...func(*Options)) (*DeleteAppInstanceAdminOutput, error) { if params == nil { @@ -30,12 +30,12 @@ func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppIn type DeleteAppInstanceAdminInput struct { - // The ARN of the AppInstance's administrator. + // The ARN of the AppInstance 's administrator. // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go b/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go index f92e90e3fa7..4fe60f5c142 100644 --- a/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the streaming configurations of an AppInstance. +// Deletes the streaming configurations of an AppInstance . func (c *Client) DeleteAppInstanceStreamingConfigurations(ctx context.Context, params *DeleteAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*DeleteAppInstanceStreamingConfigurationsOutput, error) { if params == nil { params = &DeleteAppInstanceStreamingConfigurationsInput{} diff --git a/service/chime/api_op_DeleteAppInstanceUser.go b/service/chime/api_op_DeleteAppInstanceUser.go index 9bc3785b11e..3f49161ae35 100644 --- a/service/chime/api_op_DeleteAppInstanceUser.go +++ b/service/chime/api_op_DeleteAppInstanceUser.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppInstanceUser. +// Deletes an AppInstanceUser . func (c *Client) DeleteAppInstanceUser(ctx context.Context, params *DeleteAppInstanceUserInput, optFns ...func(*Options)) (*DeleteAppInstanceUserOutput, error) { if params == nil { params = &DeleteAppInstanceUserInput{} diff --git a/service/chime/api_op_DeleteAttendee.go b/service/chime/api_op_DeleteAttendee.go index fb57e9b6667..3600ca0ba7e 100644 --- a/service/chime/api_op_DeleteAttendee.go +++ b/service/chime/api_op_DeleteAttendee.go @@ -11,11 +11,10 @@ import ( ) // Deletes an attendee from the specified Amazon Chime SDK meeting and deletes -// their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK +// their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK // meeting is deleted. For more information about the Amazon Chime SDK, see Using -// the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) DeleteAttendee(ctx context.Context, params *DeleteAttendeeInput, optFns ...func(*Options)) (*DeleteAttendeeOutput, error) { if params == nil { params = &DeleteAttendeeInput{} diff --git a/service/chime/api_op_DeleteChannel.go b/service/chime/api_op_DeleteChannel.go index 80965e1f83d..38087e5eaa0 100644 --- a/service/chime/api_op_DeleteChannel.go +++ b/service/chime/api_op_DeleteChannel.go @@ -12,9 +12,9 @@ import ( ) // Immediately makes a channel and its memberships inaccessible and marks them for -// deletion. This is an irreversible process. The x-amz-chime-bearer request header -// is mandatory. Use the AppInstanceUserArn of the user that makes the API call as -// the value in the header. +// deletion. This is an irreversible process. The x-amz-chime-bearer request +// header is mandatory. Use the AppInstanceUserArn of the user that makes the API +// call as the value in the header. func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error) { if params == nil { params = &DeleteChannelInput{} diff --git a/service/chime/api_op_DeleteChannelMembership.go b/service/chime/api_op_DeleteChannelMembership.go index 0aa6a6c50b6..d5af9909af6 100644 --- a/service/chime/api_op_DeleteChannelMembership.go +++ b/service/chime/api_op_DeleteChannelMembership.go @@ -12,8 +12,8 @@ import ( ) // Removes a member from a channel. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) DeleteChannelMembership(ctx context.Context, params *DeleteChannelMembershipInput, optFns ...func(*Options)) (*DeleteChannelMembershipOutput, error) { if params == nil { params = &DeleteChannelMembershipInput{} diff --git a/service/chime/api_op_DeleteChannelMessage.go b/service/chime/api_op_DeleteChannelMessage.go index c33cc79371e..63609da2e8d 100644 --- a/service/chime/api_op_DeleteChannelMessage.go +++ b/service/chime/api_op_DeleteChannelMessage.go @@ -13,9 +13,9 @@ import ( // Deletes a channel message. Only admins can perform this action. Deletion makes // messages inaccessible immediately. A background process deletes any revisions -// created by UpdateChannelMessage. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// created by UpdateChannelMessage . The x-amz-chime-bearer request header is +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) DeleteChannelMessage(ctx context.Context, params *DeleteChannelMessageInput, optFns ...func(*Options)) (*DeleteChannelMessageOutput, error) { if params == nil { params = &DeleteChannelMessageInput{} diff --git a/service/chime/api_op_DeleteChannelModerator.go b/service/chime/api_op_DeleteChannelModerator.go index bc8de5993f3..e9eda5c56b4 100644 --- a/service/chime/api_op_DeleteChannelModerator.go +++ b/service/chime/api_op_DeleteChannelModerator.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. -// Use the AppInstanceUserArn of the user that makes the API call as the value in -// the header. +// Deletes a channel moderator. The x-amz-chime-bearer request header is +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) DeleteChannelModerator(ctx context.Context, params *DeleteChannelModeratorInput, optFns ...func(*Options)) (*DeleteChannelModeratorOutput, error) { if params == nil { params = &DeleteChannelModeratorInput{} diff --git a/service/chime/api_op_DeletePhoneNumber.go b/service/chime/api_op_DeletePhoneNumber.go index c041c5529d7..e2afaa88197 100644 --- a/service/chime/api_op_DeletePhoneNumber.go +++ b/service/chime/api_op_DeletePhoneNumber.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves the specified phone number into the Deletion queue. A phone number must be -// disassociated from any users or Amazon Chime Voice Connectors before it can be -// deleted. Deleted phone numbers remain in the Deletion queue for 7 days before +// Moves the specified phone number into the Deletion queue. A phone number must +// be disassociated from any users or Amazon Chime Voice Connectors before it can +// be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before // they are deleted permanently. func (c *Client) DeletePhoneNumber(ctx context.Context, params *DeletePhoneNumberInput, optFns ...func(*Options)) (*DeletePhoneNumberOutput, error) { if params == nil { diff --git a/service/chime/api_op_DeleteVoiceConnector.go b/service/chime/api_op_DeleteVoiceConnector.go index a1eb3981052..76fa15acf31 100644 --- a/service/chime/api_op_DeleteVoiceConnector.go +++ b/service/chime/api_op_DeleteVoiceConnector.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated -// with the Amazon Chime Voice Connector must be disassociated from it before it -// can be deleted. +// Deletes the specified Amazon Chime Voice Connector. Any phone numbers +// associated with the Amazon Chime Voice Connector must be disassociated from it +// before it can be deleted. func (c *Client) DeleteVoiceConnector(ctx context.Context, params *DeleteVoiceConnectorInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOutput, error) { if params == nil { params = &DeleteVoiceConnectorInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorOrigination.go b/service/chime/api_op_DeleteVoiceConnectorOrigination.go index 3c9e3a73b1f..9e13c810289 100644 --- a/service/chime/api_op_DeleteVoiceConnectorOrigination.go +++ b/service/chime/api_op_DeleteVoiceConnectorOrigination.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the origination settings for the specified Amazon Chime Voice Connector. -// If emergency calling is configured for the Amazon Chime Voice Connector, it must -// be deleted prior to deleting the origination settings. +// Deletes the origination settings for the specified Amazon Chime Voice +// Connector. If emergency calling is configured for the Amazon Chime Voice +// Connector, it must be deleted prior to deleting the origination settings. func (c *Client) DeleteVoiceConnectorOrigination(ctx context.Context, params *DeleteVoiceConnectorOriginationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorOriginationOutput, error) { if params == nil { params = &DeleteVoiceConnectorOriginationInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorTermination.go b/service/chime/api_op_DeleteVoiceConnectorTermination.go index 13ae301f7c8..74a2c768244 100644 --- a/service/chime/api_op_DeleteVoiceConnectorTermination.go +++ b/service/chime/api_op_DeleteVoiceConnectorTermination.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the termination settings for the specified Amazon Chime Voice Connector. -// If emergency calling is configured for the Amazon Chime Voice Connector, it must -// be deleted prior to deleting the termination settings. +// Deletes the termination settings for the specified Amazon Chime Voice +// Connector. If emergency calling is configured for the Amazon Chime Voice +// Connector, it must be deleted prior to deleting the termination settings. func (c *Client) DeleteVoiceConnectorTermination(ctx context.Context, params *DeleteVoiceConnectorTerminationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationOutput, error) { if params == nil { params = &DeleteVoiceConnectorTerminationInput{} diff --git a/service/chime/api_op_DescribeAppInstance.go b/service/chime/api_op_DescribeAppInstance.go index 151f00d1da1..c49f4ca0379 100644 --- a/service/chime/api_op_DescribeAppInstance.go +++ b/service/chime/api_op_DescribeAppInstance.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstance. +// Returns the full details of an AppInstance . func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppInstanceInput, optFns ...func(*Options)) (*DescribeAppInstanceOutput, error) { if params == nil { params = &DescribeAppInstanceInput{} @@ -30,7 +30,7 @@ func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppIns type DescribeAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -41,7 +41,7 @@ type DescribeAppInstanceInput struct { type DescribeAppInstanceOutput struct { // The ARN, metadata, created and last-updated timestamps, and the name of the - // AppInstance. All timestamps use epoch milliseconds. + // AppInstance . All timestamps use epoch milliseconds. AppInstance *types.AppInstance // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_DescribeAppInstanceAdmin.go b/service/chime/api_op_DescribeAppInstanceAdmin.go index 547776eab30..e68226c4b86 100644 --- a/service/chime/api_op_DescribeAppInstanceAdmin.go +++ b/service/chime/api_op_DescribeAppInstanceAdmin.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceAdmin. +// Returns the full details of an AppInstanceAdmin . func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeAppInstanceAdminInput, optFns ...func(*Options)) (*DescribeAppInstanceAdminOutput, error) { if params == nil { params = &DescribeAppInstanceAdminInput{} @@ -30,12 +30,12 @@ func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeA type DescribeAppInstanceAdminInput struct { - // The ARN of the AppInstanceAdmin. + // The ARN of the AppInstanceAdmin . // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -45,7 +45,7 @@ type DescribeAppInstanceAdminInput struct { type DescribeAppInstanceAdminOutput struct { - // The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the + // The ARN and name of the AppInstanceUser , the ARN of the AppInstance , and the // created and last-updated timestamps. All timestamps use epoch milliseconds. AppInstanceAdmin *types.AppInstanceAdmin diff --git a/service/chime/api_op_DescribeAppInstanceUser.go b/service/chime/api_op_DescribeAppInstanceUser.go index 1e3a4221645..2d710706f9d 100644 --- a/service/chime/api_op_DescribeAppInstanceUser.go +++ b/service/chime/api_op_DescribeAppInstanceUser.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceUser. +// Returns the full details of an AppInstanceUser . func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAppInstanceUserInput, optFns ...func(*Options)) (*DescribeAppInstanceUserOutput, error) { if params == nil { params = &DescribeAppInstanceUserInput{} @@ -30,7 +30,7 @@ func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAp type DescribeAppInstanceUserInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string @@ -40,7 +40,7 @@ type DescribeAppInstanceUserInput struct { type DescribeAppInstanceUserOutput struct { - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . AppInstanceUser *types.AppInstanceUser // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_DescribeChannel.go b/service/chime/api_op_DescribeChannel.go index acb6b4f0797..8639dee9e07 100644 --- a/service/chime/api_op_DescribeChannel.go +++ b/service/chime/api_op_DescribeChannel.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel in an Amazon Chime AppInstance. The +// Returns the full details of a channel in an Amazon Chime AppInstance . The // x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of // the user that makes the API call as the value in the header. func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { diff --git a/service/chime/api_op_DescribeChannelBan.go b/service/chime/api_op_DescribeChannelBan.go index cce4ba6d591..5576d1443c5 100644 --- a/service/chime/api_op_DescribeChannelBan.go +++ b/service/chime/api_op_DescribeChannelBan.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel ban. The x-amz-chime-bearer request header -// is mandatory. Use the AppInstanceUserArn of the user that makes the API call as -// the value in the header. +// Returns the full details of a channel ban. The x-amz-chime-bearer request +// header is mandatory. Use the AppInstanceUserArn of the user that makes the API +// call as the value in the header. func (c *Client) DescribeChannelBan(ctx context.Context, params *DescribeChannelBanInput, optFns ...func(*Options)) (*DescribeChannelBanOutput, error) { if params == nil { params = &DescribeChannelBanInput{} diff --git a/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go b/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go index 24ac1f9e5ad..b23ba419dcd 100644 --- a/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go +++ b/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go @@ -13,7 +13,7 @@ import ( ) // Returns the details of a channel based on the membership of the specified -// AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the +// AppInstanceUser . The x-amz-chime-bearer request header is mandatory. Use the // AppInstanceUserArn of the user that makes the API call as the value in the // header. func (c *Client) DescribeChannelMembershipForAppInstanceUser(ctx context.Context, params *DescribeChannelMembershipForAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelMembershipForAppInstanceUserOutput, error) { diff --git a/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go b/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go index cdd040ccac6..303407a009c 100644 --- a/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go +++ b/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go @@ -12,10 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel moderated by the specified -// AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the -// AppInstanceUserArn of the user that makes the API call as the value in the -// header. +// Returns the full details of a channel moderated by the specified AppInstanceUser +// . The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. func (c *Client) DescribeChannelModeratedByAppInstanceUser(ctx context.Context, params *DescribeChannelModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelModeratedByAppInstanceUserOutput, error) { if params == nil { params = &DescribeChannelModeratedByAppInstanceUserInput{} diff --git a/service/chime/api_op_GetAccountSettings.go b/service/chime/api_op_GetAccountSettings.go index 727e08db84c..779701a247e 100644 --- a/service/chime/api_op_GetAccountSettings.go +++ b/service/chime/api_op_GetAccountSettings.go @@ -13,9 +13,8 @@ import ( // Retrieves account settings for the specified Amazon Chime account ID, such as // remote control and dialout settings. For more information about these settings, -// see Use the Policies Page -// (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime -// Administration Guide. +// see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) +// in the Amazon Chime Administration Guide. func (c *Client) GetAccountSettings(ctx context.Context, params *GetAccountSettingsInput, optFns ...func(*Options)) (*GetAccountSettingsOutput, error) { if params == nil { params = &GetAccountSettingsInput{} diff --git a/service/chime/api_op_GetAppInstanceRetentionSettings.go b/service/chime/api_op_GetAppInstanceRetentionSettings.go index eb57e75bc3e..22fd2286478 100644 --- a/service/chime/api_op_GetAppInstanceRetentionSettings.go +++ b/service/chime/api_op_GetAppInstanceRetentionSettings.go @@ -13,7 +13,7 @@ import ( "time" ) -// Gets the retention settings for an AppInstance. +// Gets the retention settings for an AppInstance . func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *GetAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*GetAppInstanceRetentionSettingsOutput, error) { if params == nil { params = &GetAppInstanceRetentionSettingsInput{} @@ -31,7 +31,7 @@ func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *Ge type GetAppInstanceRetentionSettingsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -41,7 +41,7 @@ type GetAppInstanceRetentionSettingsInput struct { type GetAppInstanceRetentionSettingsOutput struct { - // The retention settings for the AppInstance. + // The retention settings for the AppInstance . AppInstanceRetentionSettings *types.AppInstanceRetentionSettings // The timestamp representing the time at which the specified items are retained, diff --git a/service/chime/api_op_GetAppInstanceStreamingConfigurations.go b/service/chime/api_op_GetAppInstanceStreamingConfigurations.go index 3f659f41267..31d92644fdf 100644 --- a/service/chime/api_op_GetAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_GetAppInstanceStreamingConfigurations.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the streaming settings for an AppInstance. +// Gets the streaming settings for an AppInstance . func (c *Client) GetAppInstanceStreamingConfigurations(ctx context.Context, params *GetAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*GetAppInstanceStreamingConfigurationsOutput, error) { if params == nil { params = &GetAppInstanceStreamingConfigurationsInput{} @@ -29,7 +29,7 @@ func (c *Client) GetAppInstanceStreamingConfigurations(ctx context.Context, para type GetAppInstanceStreamingConfigurationsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chime/api_op_GetMeeting.go b/service/chime/api_op_GetMeeting.go index 9992207767a..73fec1c6af9 100644 --- a/service/chime/api_op_GetMeeting.go +++ b/service/chime/api_op_GetMeeting.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide . +// Gets the Amazon Chime SDK meeting details for the specified meeting ID. For +// more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide . func (c *Client) GetMeeting(ctx context.Context, params *GetMeetingInput, optFns ...func(*Options)) (*GetMeetingOutput, error) { if params == nil { params = &GetMeetingInput{} diff --git a/service/chime/api_op_GetPhoneNumberSettings.go b/service/chime/api_op_GetPhoneNumberSettings.go index 411949fe783..5e83d1aeb62 100644 --- a/service/chime/api_op_GetPhoneNumberSettings.go +++ b/service/chime/api_op_GetPhoneNumberSettings.go @@ -11,8 +11,8 @@ import ( "time" ) -// Retrieves the phone number settings for the administrator's AWS account, such as -// the default outbound calling name. +// Retrieves the phone number settings for the administrator's AWS account, such +// as the default outbound calling name. func (c *Client) GetPhoneNumberSettings(ctx context.Context, params *GetPhoneNumberSettingsInput, optFns ...func(*Options)) (*GetPhoneNumberSettingsOutput, error) { if params == nil { params = &GetPhoneNumberSettingsInput{} diff --git a/service/chime/api_op_GetRetentionSettings.go b/service/chime/api_op_GetRetentionSettings.go index 978ac34ea1e..025dc5959f9 100644 --- a/service/chime/api_op_GetRetentionSettings.go +++ b/service/chime/api_op_GetRetentionSettings.go @@ -43,8 +43,8 @@ type GetRetentionSettingsInput struct { type GetRetentionSettingsOutput struct { - // The timestamp representing the time at which the specified items are permanently - // deleted, in ISO 8601 format. + // The timestamp representing the time at which the specified items are + // permanently deleted, in ISO 8601 format. InitiateDeletionTimestamp *time.Time // The retention settings. diff --git a/service/chime/api_op_GetUser.go b/service/chime/api_op_GetUser.go index 6716d2252ca..bf5579f40f8 100644 --- a/service/chime/api_op_GetUser.go +++ b/service/chime/api_op_GetUser.go @@ -13,8 +13,8 @@ import ( // Retrieves details for the specified user ID, such as primary email address, // license type,and personal meeting PIN. To retrieve user details with an email -// address instead of a user ID, use the ListUsers action, and then filter by email -// address. +// address instead of a user ID, use the ListUsers action, and then filter by +// email address. func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error) { if params == nil { params = &GetUserInput{} diff --git a/service/chime/api_op_GetVoiceConnectorGroup.go b/service/chime/api_op_GetVoiceConnectorGroup.go index b81a8ca7263..ead8df2a26b 100644 --- a/service/chime/api_op_GetVoiceConnectorGroup.go +++ b/service/chime/api_op_GetVoiceConnectorGroup.go @@ -12,7 +12,7 @@ import ( ) // Retrieves details for the specified Amazon Chime Voice Connector group, such as -// timestamps,name, and associated VoiceConnectorItems. +// timestamps,name, and associated VoiceConnectorItems . func (c *Client) GetVoiceConnectorGroup(ctx context.Context, params *GetVoiceConnectorGroupInput, optFns ...func(*Options)) (*GetVoiceConnectorGroupOutput, error) { if params == nil { params = &GetVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go b/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go index dd44a465b23..7d095631a28 100644 --- a/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go +++ b/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the logging configuration details for the specified Amazon Chime Voice -// Connector. Shows whether SIP message logs are enabled for sending to Amazon -// CloudWatch Logs. +// Retrieves the logging configuration details for the specified Amazon Chime +// Voice Connector. Shows whether SIP message logs are enabled for sending to +// Amazon CloudWatch Logs. func (c *Client) GetVoiceConnectorLoggingConfiguration(ctx context.Context, params *GetVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorLoggingConfigurationOutput, error) { if params == nil { params = &GetVoiceConnectorLoggingConfigurationInput{} diff --git a/service/chime/api_op_ListAppInstanceAdmins.go b/service/chime/api_op_ListAppInstanceAdmins.go index 659faaa3c4b..59df7b16106 100644 --- a/service/chime/api_op_ListAppInstanceAdmins.go +++ b/service/chime/api_op_ListAppInstanceAdmins.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the administrators in the AppInstance. +// Returns a list of the administrators in the AppInstance . func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInstanceAdminsInput, optFns ...func(*Options)) (*ListAppInstanceAdminsOutput, error) { if params == nil { params = &ListAppInstanceAdminsInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInsta type ListAppInstanceAdminsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -38,8 +38,8 @@ type ListAppInstanceAdminsInput struct { // The maximum number of administrators that you want to return. MaxResults *int32 - // The token returned from previous API requests until the number of administrators - // is reached. + // The token returned from previous API requests until the number of + // administrators is reached. NextToken *string noSmithyDocumentSerde @@ -50,11 +50,11 @@ type ListAppInstanceAdminsOutput struct { // The information for each administrator. AppInstanceAdmins []types.AppInstanceAdminSummary - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string - // The token returned from previous API requests until the number of administrators - // is reached. + // The token returned from previous API requests until the number of + // administrators is reached. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_ListAppInstanceUsers.go b/service/chime/api_op_ListAppInstanceUsers.go index 6fdf3f51529..52dad705818 100644 --- a/service/chime/api_op_ListAppInstanceUsers.go +++ b/service/chime/api_op_ListAppInstanceUsers.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all AppInstanceUsers created under a single AppInstance. +// List all AppInstanceUsers created under a single AppInstance . func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstanceUsersInput, optFns ...func(*Options)) (*ListAppInstanceUsersOutput, error) { if params == nil { params = &ListAppInstanceUsersInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstan type ListAppInstanceUsersInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -46,10 +46,10 @@ type ListAppInstanceUsersInput struct { type ListAppInstanceUsersOutput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string - // The information for each requested AppInstanceUser. + // The information for each requested AppInstanceUser . AppInstanceUsers []types.AppInstanceUserSummary // The token passed by previous API calls until all requested users are returned. diff --git a/service/chime/api_op_ListAppInstances.go b/service/chime/api_op_ListAppInstances.go index cbf4f5bb72e..f5025844575 100644 --- a/service/chime/api_op_ListAppInstances.go +++ b/service/chime/api_op_ListAppInstances.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Amazon Chime AppInstances created under a single AWS account. +// Lists all Amazon Chime AppInstance s created under a single AWS account. func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesInput, optFns ...func(*Options)) (*ListAppInstancesOutput, error) { if params == nil { params = &ListAppInstancesInput{} @@ -30,11 +30,11 @@ func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesI type ListAppInstancesInput struct { - // The maximum number of AppInstances that you want to return. + // The maximum number of AppInstance s that you want to return. MaxResults *int32 // The token passed by previous API requests until you reach the maximum number of - // AppInstances. + // AppInstance s. NextToken *string noSmithyDocumentSerde @@ -42,11 +42,11 @@ type ListAppInstancesInput struct { type ListAppInstancesOutput struct { - // The information for each AppInstance. + // The information for each AppInstance . AppInstances []types.AppInstanceSummary // The token passed by previous API requests until the maximum number of - // AppInstances is reached. + // AppInstance s is reached. NextToken *string // Metadata pertaining to the operation's result. @@ -155,7 +155,7 @@ var _ ListAppInstancesAPIClient = (*Client)(nil) // ListAppInstancesPaginatorOptions is the paginator options for ListAppInstances type ListAppInstancesPaginatorOptions struct { - // The maximum number of AppInstances that you want to return. + // The maximum number of AppInstance s that you want to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/chime/api_op_ListAttendees.go b/service/chime/api_op_ListAttendees.go index 9a9f20f439f..b2ddd8818fc 100644 --- a/service/chime/api_op_ListAttendees.go +++ b/service/chime/api_op_ListAttendees.go @@ -13,9 +13,8 @@ import ( ) // Lists the attendees for the specified Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) ListAttendees(ctx context.Context, params *ListAttendeesInput, optFns ...func(*Options)) (*ListAttendeesOutput, error) { if params == nil { params = &ListAttendeesInput{} diff --git a/service/chime/api_op_ListChannelMemberships.go b/service/chime/api_op_ListChannelMemberships.go index dd00fabc68d..cb94bc51675 100644 --- a/service/chime/api_op_ListChannelMemberships.go +++ b/service/chime/api_op_ListChannelMemberships.go @@ -47,9 +47,9 @@ type ListChannelMembershipsInput struct { // are returned. NextToken *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are always - // returned as part of ListChannelMemberships. Hidden members are only returned if - // the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden + // The membership type of a user, DEFAULT or HIDDEN . Default members are always + // returned as part of ListChannelMemberships . Hidden members are only returned if + // the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden // members are not returned. Type types.ChannelMembershipType diff --git a/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go b/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go index fe7e8cab4a4..d2eff6852d1 100644 --- a/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go +++ b/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go @@ -33,7 +33,7 @@ func (c *Client) ListChannelMembershipsForAppInstanceUser(ctx context.Context, p type ListChannelMembershipsForAppInstanceUserInput struct { - // The ARN of the AppInstanceUsers + // The ARN of the AppInstanceUser s AppInstanceUserArn *string // The AppInstanceUserArn of the user that makes the API call. diff --git a/service/chime/api_op_ListChannelMessages.go b/service/chime/api_op_ListChannelMessages.go index 4c842111611..cb3288f4385 100644 --- a/service/chime/api_op_ListChannelMessages.go +++ b/service/chime/api_op_ListChannelMessages.go @@ -13,13 +13,13 @@ import ( "time" ) -// List all the messages in a channel. Returns a paginated list of ChannelMessages. -// By default, sorted by creation timestamp in descending order. Redacted messages -// appear in the results as empty, since they are only redacted, not deleted. -// Deleted messages do not appear in the results. This action always returns the -// latest version of an edited message. Also, the x-amz-chime-bearer request header -// is mandatory. Use the AppInstanceUserArn of the user that makes the API call as -// the value in the header. +// List all the messages in a channel. Returns a paginated list of ChannelMessages +// . By default, sorted by creation timestamp in descending order. Redacted +// messages appear in the results as empty, since they are only redacted, not +// deleted. Deleted messages do not appear in the results. This action always +// returns the latest version of an edited message. Also, the x-amz-chime-bearer +// request header is mandatory. Use the AppInstanceUserArn of the user that makes +// the API call as the value in the header. func (c *Client) ListChannelMessages(ctx context.Context, params *ListChannelMessagesInput, optFns ...func(*Options)) (*ListChannelMessagesOutput, error) { if params == nil { params = &ListChannelMessagesInput{} @@ -176,8 +176,8 @@ func addEndpointPrefix_opListChannelMessagesMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opListChannelMessagesMiddleware{}, `OperationSerializer`, middleware.After) } -// ListChannelMessagesAPIClient is a client that implements the ListChannelMessages -// operation. +// ListChannelMessagesAPIClient is a client that implements the +// ListChannelMessages operation. type ListChannelMessagesAPIClient interface { ListChannelMessages(context.Context, *ListChannelMessagesInput, ...func(*Options)) (*ListChannelMessagesOutput, error) } diff --git a/service/chime/api_op_ListChannelModerators.go b/service/chime/api_op_ListChannelModerators.go index f9e11dce450..6a4102a4e17 100644 --- a/service/chime/api_op_ListChannelModerators.go +++ b/service/chime/api_op_ListChannelModerators.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the moderators for a channel. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// Lists all the moderators for a channel. The x-amz-chime-bearer request header +// is mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) ListChannelModerators(ctx context.Context, params *ListChannelModeratorsInput, optFns ...func(*Options)) (*ListChannelModeratorsOutput, error) { if params == nil { params = &ListChannelModeratorsInput{} diff --git a/service/chime/api_op_ListChannels.go b/service/chime/api_op_ListChannels.go index 5a249384172..8c2fef22cca 100644 --- a/service/chime/api_op_ListChannels.go +++ b/service/chime/api_op_ListChannels.go @@ -12,19 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Channels created under a single Chime App as a paginated list. You can -// specify filters to narrow results. Functionality & restrictions +// Lists all Channels created under a single Chime App as a paginated list. You +// can specify filters to narrow results. Functionality & restrictions +// - Use privacy = PUBLIC to retrieve all public channels in the account. +// - Only an AppInstanceAdmin can set privacy = PRIVATE to list the private +// channels in an account. // -// * Use privacy = -// PUBLIC to retrieve all public channels in the account. -// -// * Only an -// AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an -// account. -// -// The x-amz-chime-bearer request header is mandatory. Use the -// AppInstanceUserArn of the user that makes the API call as the value in the -// header. +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error) { if params == nil { params = &ListChannelsInput{} @@ -42,7 +37,7 @@ func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, op type ListChannelsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -57,8 +52,9 @@ type ListChannelsInput struct { // returned. NextToken *string - // The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves - // private channels. Only an AppInstanceAdmin can retrieve private channels. + // The privacy setting. PUBLIC retrieves all the public channels. PRIVATE + // retrieves private channels. Only an AppInstanceAdmin can retrieve private + // channels. Privacy types.ChannelPrivacy noSmithyDocumentSerde diff --git a/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go b/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go index 68e4bd4854d..b993446d58a 100644 --- a/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go +++ b/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer +// A list of the channels moderated by an AppInstanceUser . The x-amz-chime-bearer // request header is mandatory. Use the AppInstanceUserArn of the user that makes // the API call as the value in the header. func (c *Client) ListChannelsModeratedByAppInstanceUser(ctx context.Context, params *ListChannelsModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error) { diff --git a/service/chime/api_op_ListMeetings.go b/service/chime/api_op_ListMeetings.go index 67c3a0ca90b..64de24a9345 100644 --- a/service/chime/api_op_ListMeetings.go +++ b/service/chime/api_op_ListMeetings.go @@ -12,10 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists up to 100 active Amazon Chime SDK meetings. For more information about the -// Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// Lists up to 100 active Amazon Chime SDK meetings. For more information about +// the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) ListMeetings(ctx context.Context, params *ListMeetingsInput, optFns ...func(*Options)) (*ListMeetingsOutput, error) { if params == nil { params = &ListMeetingsInput{} diff --git a/service/chime/api_op_ListRoomMemberships.go b/service/chime/api_op_ListRoomMemberships.go index d9cc0a2b6fa..aa10d5e1a11 100644 --- a/service/chime/api_op_ListRoomMemberships.go +++ b/service/chime/api_op_ListRoomMemberships.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListRoomMembershipsMiddlewares(stack *middleware.St return nil } -// ListRoomMembershipsAPIClient is a client that implements the ListRoomMemberships -// operation. +// ListRoomMembershipsAPIClient is a client that implements the +// ListRoomMemberships operation. type ListRoomMembershipsAPIClient interface { ListRoomMemberships(context.Context, *ListRoomMembershipsInput, ...func(*Options)) (*ListRoomMembershipsOutput, error) } diff --git a/service/chime/api_op_ListVoiceConnectors.go b/service/chime/api_op_ListVoiceConnectors.go index d9445ea29ca..120b266a77a 100644 --- a/service/chime/api_op_ListVoiceConnectors.go +++ b/service/chime/api_op_ListVoiceConnectors.go @@ -113,8 +113,8 @@ func (c *Client) addOperationListVoiceConnectorsMiddlewares(stack *middleware.St return nil } -// ListVoiceConnectorsAPIClient is a client that implements the ListVoiceConnectors -// operation. +// ListVoiceConnectorsAPIClient is a client that implements the +// ListVoiceConnectors operation. type ListVoiceConnectorsAPIClient interface { ListVoiceConnectors(context.Context, *ListVoiceConnectorsInput, ...func(*Options)) (*ListVoiceConnectorsOutput, error) } diff --git a/service/chime/api_op_PutAppInstanceRetentionSettings.go b/service/chime/api_op_PutAppInstanceRetentionSettings.go index 3d572425844..86753d05cc3 100644 --- a/service/chime/api_op_PutAppInstanceRetentionSettings.go +++ b/service/chime/api_op_PutAppInstanceRetentionSettings.go @@ -31,7 +31,7 @@ func (c *Client) PutAppInstanceRetentionSettings(ctx context.Context, params *Pu type PutAppInstanceRetentionSettingsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chime/api_op_PutAppInstanceStreamingConfigurations.go b/service/chime/api_op_PutAppInstanceStreamingConfigurations.go index 136ef856876..cb832647e3d 100644 --- a/service/chime/api_op_PutAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_PutAppInstanceStreamingConfigurations.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The data streaming configurations of an AppInstance. +// The data streaming configurations of an AppInstance . func (c *Client) PutAppInstanceStreamingConfigurations(ctx context.Context, params *PutAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*PutAppInstanceStreamingConfigurationsOutput, error) { if params == nil { params = &PutAppInstanceStreamingConfigurationsInput{} @@ -29,12 +29,12 @@ func (c *Client) PutAppInstanceStreamingConfigurations(ctx context.Context, para type PutAppInstanceStreamingConfigurationsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string - // The streaming configurations set for an AppInstance. + // The streaming configurations set for an AppInstance . // // This member is required. AppInstanceStreamingConfigurations []types.AppInstanceStreamingConfiguration @@ -44,7 +44,7 @@ type PutAppInstanceStreamingConfigurationsInput struct { type PutAppInstanceStreamingConfigurationsOutput struct { - // The streaming configurations of an AppInstance. + // The streaming configurations of an AppInstance . AppInstanceStreamingConfigurations []types.AppInstanceStreamingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_PutEventsConfiguration.go b/service/chime/api_op_PutEventsConfiguration.go index 14fa71fc156..a8efdb843fc 100644 --- a/service/chime/api_op_PutEventsConfiguration.go +++ b/service/chime/api_op_PutEventsConfiguration.go @@ -13,7 +13,7 @@ import ( // Creates an events configuration that allows a bot to receive outgoing events // sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. -// For more information, see Bot. +// For more information, see Bot . func (c *Client) PutEventsConfiguration(ctx context.Context, params *PutEventsConfigurationInput, optFns ...func(*Options)) (*PutEventsConfigurationOutput, error) { if params == nil { params = &PutEventsConfigurationInput{} @@ -52,8 +52,8 @@ type PutEventsConfigurationInput struct { type PutEventsConfigurationOutput struct { - // The configuration that allows a bot to receive outgoing events. Can be either an - // HTTPS endpoint or a Lambda function ARN. + // The configuration that allows a bot to receive outgoing events. Can be either + // an HTTPS endpoint or a Lambda function ARN. EventsConfiguration *types.EventsConfiguration // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_PutRetentionSettings.go b/service/chime/api_op_PutRetentionSettings.go index ec79b55cb35..8b5b33632b0 100644 --- a/service/chime/api_op_PutRetentionSettings.go +++ b/service/chime/api_op_PutRetentionSettings.go @@ -14,14 +14,12 @@ import ( // Puts retention settings for the specified Amazon Chime Enterprise account. We // recommend using AWS CloudTrail to monitor usage of this API for your account. -// For more information, see Logging Amazon Chime API Calls with AWS CloudTrail -// (https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html) in the Amazon -// Chime Administration Guide. To turn off existing retention settings, remove the -// number of days from the corresponding RetentionDays field in the -// RetentionSettings object. For more information about retention settings, see -// Managing Chat Retention Policies -// (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the Amazon -// Chime Administration Guide. +// For more information, see Logging Amazon Chime API Calls with AWS CloudTrail (https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html) +// in the Amazon Chime Administration Guide. To turn off existing retention +// settings, remove the number of days from the corresponding RetentionDays field +// in the RetentionSettings object. For more information about retention settings, +// see Managing Chat Retention Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) +// in the Amazon Chime Administration Guide. func (c *Client) PutRetentionSettings(ctx context.Context, params *PutRetentionSettingsInput, optFns ...func(*Options)) (*PutRetentionSettingsOutput, error) { if params == nil { params = &PutRetentionSettingsInput{} @@ -54,8 +52,8 @@ type PutRetentionSettingsInput struct { type PutRetentionSettingsOutput struct { - // The timestamp representing the time at which the specified items are permanently - // deleted, in ISO 8601 format. + // The timestamp representing the time at which the specified items are + // permanently deleted, in ISO 8601 format. InitiateDeletionTimestamp *time.Time // The retention settings. diff --git a/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go b/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go index cf996371a9a..134d3118f3a 100644 --- a/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Puts emergency calling configuration details to the specified Amazon Chime Voice -// Connector, such as emergency phone numbers and calling countries. Origination -// and termination settings must be enabled for the Amazon Chime Voice Connector -// before emergency calling can be configured. +// Puts emergency calling configuration details to the specified Amazon Chime +// Voice Connector, such as emergency phone numbers and calling countries. +// Origination and termination settings must be enabled for the Amazon Chime Voice +// Connector before emergency calling can be configured. func (c *Client) PutVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *PutVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorEmergencyCallingConfigurationOutput, error) { if params == nil { params = &PutVoiceConnectorEmergencyCallingConfigurationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go b/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go index 14245a490ae..a81f6f72d1a 100644 --- a/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a logging configuration for the specified Amazon Chime Voice Connector. The -// logging configuration specifies whether SIP message logs are enabled for sending -// to Amazon CloudWatch Logs. +// Adds a logging configuration for the specified Amazon Chime Voice Connector. +// The logging configuration specifies whether SIP message logs are enabled for +// sending to Amazon CloudWatch Logs. func (c *Client) PutVoiceConnectorLoggingConfiguration(ctx context.Context, params *PutVoiceConnectorLoggingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorLoggingConfigurationOutput, error) { if params == nil { params = &PutVoiceConnectorLoggingConfigurationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorProxy.go b/service/chime/api_op_PutVoiceConnectorProxy.go index 35a5016c853..731470fab28 100644 --- a/service/chime/api_op_PutVoiceConnectorProxy.go +++ b/service/chime/api_op_PutVoiceConnectorProxy.go @@ -45,8 +45,8 @@ type PutVoiceConnectorProxyInput struct { // This member is required. VoiceConnectorId *string - // When true, stops proxy sessions from being created on the specified Amazon Chime - // Voice Connector. + // When true, stops proxy sessions from being created on the specified Amazon + // Chime Voice Connector. Disabled *bool // The phone number to route calls to after a proxy session expires. diff --git a/service/chime/api_op_SearchAvailablePhoneNumbers.go b/service/chime/api_op_SearchAvailablePhoneNumbers.go index e2a34146503..2129ff8f6f9 100644 --- a/service/chime/api_op_SearchAvailablePhoneNumbers.go +++ b/service/chime/api_op_SearchAvailablePhoneNumbers.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for phone numbers that can be ordered. For US numbers, provide at least -// one of the following search filters: AreaCode, City, State, or TollFreePrefix. -// If you provide City, you must also provide State. Numbers outside the US only -// support the PhoneNumberType filter, which you must use. +// Searches for phone numbers that can be ordered. For US numbers, provide at +// least one of the following search filters: AreaCode , City , State , or +// TollFreePrefix . If you provide City , you must also provide State . Numbers +// outside the US only support the PhoneNumberType filter, which you must use. func (c *Client) SearchAvailablePhoneNumbers(ctx context.Context, params *SearchAvailablePhoneNumbersInput, optFns ...func(*Options)) (*SearchAvailablePhoneNumbersOutput, error) { if params == nil { params = &SearchAvailablePhoneNumbersInput{} @@ -52,7 +52,7 @@ type SearchAvailablePhoneNumbersInput struct { // The phone number type used to filter results. Required for non-US numbers. PhoneNumberType types.PhoneNumberType - // The state used to filter results. Required only if you provide City. Only + // The state used to filter results. Required only if you provide City . Only // applies to the US. State *string diff --git a/service/chime/api_op_SendChannelMessage.go b/service/chime/api_op_SendChannelMessage.go index d6302ff49cc..03c9a0bc300 100644 --- a/service/chime/api_op_SendChannelMessage.go +++ b/service/chime/api_op_SendChannelMessage.go @@ -55,7 +55,7 @@ type SendChannelMessageInput struct { // This member is required. Persistence types.ChannelMessagePersistenceType - // The type of message, STANDARD or CONTROL. + // The type of message, STANDARD or CONTROL . // // This member is required. Type types.ChannelMessageType diff --git a/service/chime/api_op_StartMeetingTranscription.go b/service/chime/api_op_StartMeetingTranscription.go index 179198df21e..a9095b76bd0 100644 --- a/service/chime/api_op_StartMeetingTranscription.go +++ b/service/chime/api_op_StartMeetingTranscription.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts transcription for the specified meetingId. +// Starts transcription for the specified meetingId . func (c *Client) StartMeetingTranscription(ctx context.Context, params *StartMeetingTranscriptionInput, optFns ...func(*Options)) (*StartMeetingTranscriptionOutput, error) { if params == nil { params = &StartMeetingTranscriptionInput{} @@ -35,7 +35,7 @@ type StartMeetingTranscriptionInput struct { MeetingId *string // The configuration for the current transcription operation. Must contain - // EngineTranscribeSettings or EngineTranscribeMedicalSettings. + // EngineTranscribeSettings or EngineTranscribeMedicalSettings . // // This member is required. TranscriptionConfiguration *types.TranscriptionConfiguration diff --git a/service/chime/api_op_StopMeetingTranscription.go b/service/chime/api_op_StopMeetingTranscription.go index be905eadb92..90a181e921b 100644 --- a/service/chime/api_op_StopMeetingTranscription.go +++ b/service/chime/api_op_StopMeetingTranscription.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops transcription for the specified meetingId. +// Stops transcription for the specified meetingId . func (c *Client) StopMeetingTranscription(ctx context.Context, params *StopMeetingTranscriptionInput, optFns ...func(*Options)) (*StopMeetingTranscriptionOutput, error) { if params == nil { params = &StopMeetingTranscriptionInput{} diff --git a/service/chime/api_op_UpdateAccountSettings.go b/service/chime/api_op_UpdateAccountSettings.go index 05607ac3318..5cfbc845b63 100644 --- a/service/chime/api_op_UpdateAccountSettings.go +++ b/service/chime/api_op_UpdateAccountSettings.go @@ -13,9 +13,8 @@ import ( // Updates the settings for the specified Amazon Chime account. You can update // settings for remote control of shared screens, or for the dial-out option. For -// more information about these settings, see Use the Policies Page -// (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime -// Administration Guide. +// more information about these settings, see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) +// in the Amazon Chime Administration Guide. func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) { if params == nil { params = &UpdateAccountSettingsInput{} diff --git a/service/chime/api_op_UpdateAppInstance.go b/service/chime/api_op_UpdateAppInstance.go index e70d54c5601..a6138c7d4e7 100644 --- a/service/chime/api_op_UpdateAppInstance.go +++ b/service/chime/api_op_UpdateAppInstance.go @@ -29,7 +29,7 @@ func (c *Client) UpdateAppInstance(ctx context.Context, params *UpdateAppInstanc type UpdateAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -47,7 +47,7 @@ type UpdateAppInstanceInput struct { type UpdateAppInstanceOutput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_UpdateAppInstanceUser.go b/service/chime/api_op_UpdateAppInstanceUser.go index 5fdf397c668..f758ef441bc 100644 --- a/service/chime/api_op_UpdateAppInstanceUser.go +++ b/service/chime/api_op_UpdateAppInstanceUser.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details of an AppInstanceUser. You can update names and metadata. +// Updates the details of an AppInstanceUser . You can update names and metadata. func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppInstanceUserInput, optFns ...func(*Options)) (*UpdateAppInstanceUserOutput, error) { if params == nil { params = &UpdateAppInstanceUserInput{} @@ -29,17 +29,17 @@ func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppIns type UpdateAppInstanceUserInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . // // This member is required. Name *string - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . Metadata *string noSmithyDocumentSerde @@ -47,7 +47,7 @@ type UpdateAppInstanceUserInput struct { type UpdateAppInstanceUserOutput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_UpdateChannelMessage.go b/service/chime/api_op_UpdateChannelMessage.go index f755c9f75b9..c802d65df41 100644 --- a/service/chime/api_op_UpdateChannelMessage.go +++ b/service/chime/api_op_UpdateChannelMessage.go @@ -12,8 +12,8 @@ import ( ) // Updates the content of a message. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) UpdateChannelMessage(ctx context.Context, params *UpdateChannelMessageInput, optFns ...func(*Options)) (*UpdateChannelMessageOutput, error) { if params == nil { params = &UpdateChannelMessageInput{} diff --git a/service/chime/api_op_UpdateVoiceConnectorGroup.go b/service/chime/api_op_UpdateVoiceConnectorGroup.go index d14729efdb2..f7e28d535ec 100644 --- a/service/chime/api_op_UpdateVoiceConnectorGroup.go +++ b/service/chime/api_op_UpdateVoiceConnectorGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates details of the specified Amazon Chime Voice Connector group, such as the -// name and Amazon Chime Voice Connector priority ranking. +// Updates details of the specified Amazon Chime Voice Connector group, such as +// the name and Amazon Chime Voice Connector priority ranking. func (c *Client) UpdateVoiceConnectorGroup(ctx context.Context, params *UpdateVoiceConnectorGroupInput, optFns ...func(*Options)) (*UpdateVoiceConnectorGroupOutput, error) { if params == nil { params = &UpdateVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_ValidateE911Address.go b/service/chime/api_op_ValidateE911Address.go index 7d739897306..11ac3ea3e10 100644 --- a/service/chime/api_op_ValidateE911Address.go +++ b/service/chime/api_op_ValidateE911Address.go @@ -37,32 +37,32 @@ type ValidateE911AddressInput struct { // This member is required. AwsAccountId *string - // The address city, such as Portland. + // The address city, such as Portland . // // This member is required. City *string - // The address country, such as US. + // The address country, such as US . // // This member is required. Country *string - // The address postal code, such as 04352. + // The address postal code, such as 04352 . // // This member is required. PostalCode *string - // The address state, such as ME. + // The address state, such as ME . // // This member is required. State *string - // The address street information, such as 8th Avenue. + // The address street information, such as 8th Avenue . // // This member is required. StreetInfo *string - // The address street number, such as 200 or 2121. + // The address street number, such as 200 or 2121 . // // This member is required. StreetNumber *string diff --git a/service/chime/doc.go b/service/chime/doc.go index a7114538cd1..a2afa70c5a6 100644 --- a/service/chime/doc.go +++ b/service/chime/doc.go @@ -9,28 +9,25 @@ // about the Amazon Chime API, including operations, types, inputs and outputs, and // error codes. It also includes API actions for use with the Amazon Chime SDK, // which developers use to build their own communication applications. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. You can use an AWS SDK, the AWS Command Line Interface -// (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or -// the AWS CLI. Each API operation includes links to information about using it -// with a language-specific AWS SDK or the AWS CLI. Using an AWS SDK You don't need -// to write code to calculate a signature for request authentication. The SDK -// clients authenticate your requests by using access keys that you provide. For -// more information about AWS SDKs, see the AWS Developer Center -// (http://aws.amazon.com/developer/). Using the AWS CLI Use your access keys with -// the AWS CLI to make API calls. For information about setting up the AWS CLI, see -// Installing the AWS Command Line Interface -// (https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the AWS -// Command Line Interface User Guide. For a list of available Amazon Chime -// commands, see the Amazon Chime commands -// (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) in the AWS -// CLI Command Reference. Using REST APIs If you use REST to make API calls, you -// must authenticate your request by providing a signature. Amazon Chime supports -// signature version 4. For more information, see Signature Version 4 Signing -// Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. You can use an AWS SDK, the AWS Command +// Line Interface (AWS CLI), or the REST API to make API calls. We recommend using +// an AWS SDK or the AWS CLI. Each API operation includes links to information +// about using it with a language-specific AWS SDK or the AWS CLI. Using an AWS SDK +// You don't need to write code to calculate a signature for request +// authentication. The SDK clients authenticate your requests by using access keys +// that you provide. For more information about AWS SDKs, see the AWS Developer +// Center (http://aws.amazon.com/developer/) . Using the AWS CLI Use your access +// keys with the AWS CLI to make API calls. For information about setting up the +// AWS CLI, see Installing the AWS Command Line Interface (https://docs.aws.amazon.com/cli/latest/userguide/installing.html) +// in the AWS Command Line Interface User Guide. For a list of available Amazon +// Chime commands, see the Amazon Chime commands (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) +// in the AWS CLI Command Reference. Using REST APIs If you use REST to make API +// calls, you must authenticate your request by providing a signature. Amazon Chime +// supports signature version 4. For more information, see Signature Version 4 +// Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) // in the Amazon Web Services General Reference. When making REST API calls, use -// the service name chime and REST endpoint https://service.chime.aws.amazon.com. +// the service name chime and REST endpoint https://service.chime.aws.amazon.com . // Administrative permissions are controlled using AWS Identity and Access // Management (IAM). For more information, see Identity and Access Management for // Amazon Chime (https://docs.aws.amazon.com/chime/latest/ag/security-iam.html) in diff --git a/service/chime/types/enums.go b/service/chime/types/enums.go index 05a1f24b051..4efbd1a49c8 100644 --- a/service/chime/types/enums.go +++ b/service/chime/types/enums.go @@ -86,9 +86,9 @@ const ( AudioMuxTypeAudioWithActiveSpeakerVideo AudioMuxType = "AudioWithActiveSpeakerVideo" ) -// Values returns all known values for AudioMuxType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioMuxType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AudioMuxType) Values() []AudioMuxType { return []AudioMuxType{ "AudioOnly", @@ -160,8 +160,8 @@ const ( ChannelMembershipTypeHidden ChannelMembershipType = "HIDDEN" ) -// Values returns all known values for ChannelMembershipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ChannelMembershipType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ChannelMembershipType) Values() []ChannelMembershipType { return []ChannelMembershipType{ @@ -300,9 +300,9 @@ const ( ErrorCodePhoneNumberAssociationsExist ErrorCode = "PhoneNumberAssociationsExist" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "BadRequest", @@ -350,9 +350,9 @@ const ( InviteStatusFailed InviteStatus = "Failed" ) -// Values returns all known values for InviteStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InviteStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InviteStatus) Values() []InviteStatus { return []InviteStatus{ "Pending", @@ -390,8 +390,8 @@ const ( MediaPipelineSinkTypeS3Bucket MediaPipelineSinkType = "S3Bucket" ) -// Values returns all known values for MediaPipelineSinkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MediaPipelineSinkType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineSinkType) Values() []MediaPipelineSinkType { return []MediaPipelineSinkType{ @@ -506,9 +506,9 @@ const ( OrderedPhoneNumberStatusFailed OrderedPhoneNumberStatus = "Failed" ) -// Values returns all known values for OrderedPhoneNumberStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderedPhoneNumberStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderedPhoneNumberStatus) Values() []OrderedPhoneNumberStatus { return []OrderedPhoneNumberStatus{ "Processing", @@ -525,9 +525,9 @@ const ( OriginationRouteProtocolUdp OriginationRouteProtocol = "UDP" ) -// Values returns all known values for OriginationRouteProtocol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OriginationRouteProtocol. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginationRouteProtocol) Values() []OriginationRouteProtocol { return []OriginationRouteProtocol{ "TCP", @@ -733,9 +733,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -911,8 +911,8 @@ const ( TranscribeMedicalTypeDictation TranscribeMedicalType = "DICTATION" ) -// Values returns all known values for TranscribeMedicalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TranscribeMedicalType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalType) Values() []TranscribeMedicalType { return []TranscribeMedicalType{ @@ -930,8 +930,8 @@ const ( TranscribePartialResultsStabilityHigh TranscribePartialResultsStability = "high" ) -// Values returns all known values for TranscribePartialResultsStability. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for TranscribePartialResultsStability. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability { @@ -1026,9 +1026,9 @@ const ( VideoMuxTypeVideoOnly VideoMuxType = "VideoOnly" ) -// Values returns all known values for VideoMuxType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for VideoMuxType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (VideoMuxType) Values() []VideoMuxType { return []VideoMuxType{ "VideoOnly", diff --git a/service/chime/types/types.go b/service/chime/types/types.go index f3b089afccc..1edb7585d8b 100644 --- a/service/chime/types/types.go +++ b/service/chime/types/types.go @@ -30,9 +30,8 @@ type Account struct { AccountStatus AccountStatus // The Amazon Chime account type. For more information about different account - // types, see Managing Your Amazon Chime Accounts - // (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the - // Amazon Chime Administration Guide. + // types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) + // in the Amazon Chime Administration Guide. AccountType AccountType // The Amazon Chime account creation timestamp, in ISO 8601 format. @@ -53,17 +52,16 @@ type Account struct { // Settings related to the Amazon Chime account. This includes settings that start // or stop remote control of shared screens, or start or stop the dial-out option // in the Amazon Chime web application. For more information about these settings, -// see Use the Policies Page -// (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime -// Administration Guide. +// see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) +// in the Amazon Chime Administration Guide. type AccountSettings struct { // Setting that stops or starts remote control of shared screens during meetings. DisableRemoteControl *bool - // Setting that allows meeting participants to choose the Call me at a phone number - // option. For more information, see Join a Meeting without the Amazon Chime App - // (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html). + // Setting that allows meeting participants to choose the Call me at a phone + // number option. For more information, see Join a Meeting without the Amazon + // Chime App (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html) . EnableDialOut *bool noSmithyDocumentSerde @@ -78,7 +76,7 @@ type Address struct { // The country of an address. Country *string - // An address suffix location, such as the S. Unit A in Central Park S. Unit A. + // An address suffix location, such as the S. Unit A in Central Park S. Unit A . PostDirectional *string // The postal code of an address. @@ -87,19 +85,19 @@ type Address struct { // The Zip + 4 or postal code + 4 of an address. PostalCodePlus4 *string - // An address prefix location, such as the N in N. Third St.. + // An address prefix location, such as the N in N. Third St. . PreDirectional *string // The state of an address. State *string - // The address street, such as 8th Avenue. + // The address street, such as 8th Avenue . StreetName *string // The numeric portion of an address. StreetNumber *string - // The address suffix, such as the N in 8th Avenue N. + // The address suffix, such as the N in 8th Avenue N . StreetSuffix *string noSmithyDocumentSerde @@ -118,7 +116,7 @@ type AlexaForBusinessMetadata struct { noSmithyDocumentSerde } -// The details of an AppInstance, an instance of an Amazon Chime SDK messaging +// The details of an AppInstance , an instance of an Amazon Chime SDK messaging // application. type AppInstance struct { @@ -131,16 +129,16 @@ type AppInstance struct { // The time an AppInstance was last updated. In epoch milliseconds. LastUpdatedTimestamp *time.Time - // The metadata of an AppInstance. + // The metadata of an AppInstance . Metadata *string - // The name of an AppInstance. + // The name of an AppInstance . Name *string noSmithyDocumentSerde } -// The details of an AppInstanceAdmin. +// The details of an AppInstanceAdmin . type AppInstanceAdmin struct { // The AppInstanceAdmin data. @@ -155,16 +153,16 @@ type AppInstanceAdmin struct { noSmithyDocumentSerde } -// Summary of the details of an AppInstanceAdmin. +// Summary of the details of an AppInstanceAdmin . type AppInstanceAdminSummary struct { - // The details of the AppInstanceAdmin. + // The details of the AppInstanceAdmin . Admin *Identity noSmithyDocumentSerde } -// The details of the data-retention settings for an AppInstance. +// The details of the data-retention settings for an AppInstance . type AppInstanceRetentionSettings struct { // The length of time in days to retain the messages in a channel. @@ -173,7 +171,7 @@ type AppInstanceRetentionSettings struct { noSmithyDocumentSerde } -// The details of the streaming configuration of an AppInstance. +// The details of the streaming configuration of an AppInstance . type AppInstanceStreamingConfiguration struct { // The type of data to be streamed. @@ -189,25 +187,25 @@ type AppInstanceStreamingConfiguration struct { noSmithyDocumentSerde } -// Summary of the data for an AppInstance. +// Summary of the data for an AppInstance . type AppInstanceSummary struct { // The AppInstance ARN. AppInstanceArn *string - // The metadata of the AppInstance. + // The metadata of the AppInstance . Metadata *string - // The name of the AppInstance. + // The name of the AppInstance . Name *string noSmithyDocumentSerde } -// The details of an AppInstanceUser. +// The details of an AppInstanceUser . type AppInstanceUser struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // The time at which the AppInstanceUser was created. @@ -216,37 +214,37 @@ type AppInstanceUser struct { // The time at which the AppInstanceUser was last updated. LastUpdatedTimestamp *time.Time - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . Metadata *string - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . Name *string noSmithyDocumentSerde } -// Summary of the membership details of an AppInstanceUser. +// Summary of the membership details of an AppInstanceUser . type AppInstanceUserMembershipSummary struct { // The time at which a message was last read. ReadMarkerTimestamp *time.Time - // The type of ChannelMembership. + // The type of ChannelMembership . Type ChannelMembershipType noSmithyDocumentSerde } -// Summary of the details of an AppInstanceUser. +// Summary of the details of an AppInstanceUser . type AppInstanceUserSummary struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . Metadata *string - // The name of an AppInstanceUser. + // The name of an AppInstanceUser . Name *string noSmithyDocumentSerde @@ -463,7 +461,7 @@ type ChannelBan struct { noSmithyDocumentSerde } -// Summary of the details of a ChannelBan. +// Summary of the details of a ChannelBan . type ChannelBanSummary struct { // The member being banned from a channel. @@ -496,19 +494,19 @@ type ChannelMembership struct { noSmithyDocumentSerde } -// Summary of the channel membership details of an AppInstanceUser. +// Summary of the channel membership details of an AppInstanceUser . type ChannelMembershipForAppInstanceUserSummary struct { - // Summary of the membership details of an AppInstanceUser. + // Summary of the membership details of an AppInstanceUser . AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary - // Summary of the details of a Channel. + // Summary of the details of a Channel . ChannelSummary *ChannelSummary noSmithyDocumentSerde } -// Summary of the details of a ChannelMembership. +// Summary of the details of a ChannelMembership . type ChannelMembershipSummary struct { // A member's summary data. @@ -556,7 +554,7 @@ type ChannelMessage struct { noSmithyDocumentSerde } -// Summary of the messages in a Channel. +// Summary of the messages in a Channel . type ChannelMessageSummary struct { // The content of the message. @@ -592,7 +590,7 @@ type ChannelMessageSummary struct { // Summary of the details of a moderated channel. type ChannelModeratedByAppInstanceUserSummary struct { - // Summary of the details of a Channel. + // Summary of the details of a Channel . ChannelSummary *ChannelSummary noSmithyDocumentSerde @@ -616,7 +614,7 @@ type ChannelModerator struct { noSmithyDocumentSerde } -// Summary of the details of a ChannelModerator. +// Summary of the details of a ChannelModerator . type ChannelModeratorSummary struct { // The data for a moderator. @@ -634,7 +632,7 @@ type ChannelRetentionSettings struct { noSmithyDocumentSerde } -// Summary of the details of a Channel. +// Summary of the details of a Channel . type ChannelSummary struct { // The ARN of the channel. @@ -659,7 +657,7 @@ type ChannelSummary struct { } // The configuration object of the Amazon Chime SDK meeting for a specified media -// capture pipeline. SourceType must be ChimeSdkMeeting. +// capture pipeline. SourceType must be ChimeSdkMeeting . type ChimeSdkMeetingConfiguration struct { // The configuration for the artifacts in an Amazon Chime SDK meeting. @@ -737,8 +735,8 @@ type Credential struct { // format. Password *string - // The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII - // format. + // The RFC2617 compliant user name associated with the SIP credentials, in + // US-ASCII format. Username *string noSmithyDocumentSerde @@ -840,11 +838,11 @@ type EngineTranscribeSettings struct { PartialResultsStability TranscribePartialResultsStability // Lists the PII entity types you want to identify or redact. To specify entity - // types, you must enable ContentIdentificationType or ContentRedactionType. + // types, you must enable ContentIdentificationType or ContentRedactionType . // PIIEntityTypes must be comma-separated. The available values are: - // BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, - // CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. - // PiiEntityTypes is an optional parameter with a default value of ALL. + // BANK_ACCOUNT_NUMBER , BANK_ROUTING, CREDIT_DEBIT_NUMBER , CREDIT_DEBIT_CVV , + // CREDIT_DEBIT_EXPIRY , PIN , EMAIL , ADDRESS , NAME , PHONE , SSN , and ALL . + // PiiEntityTypes is an optional parameter with a default value of ALL . PiiEntityTypes *string // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, @@ -863,8 +861,8 @@ type EngineTranscribeSettings struct { noSmithyDocumentSerde } -// The configuration that allows a bot to receive outgoing events. Can be either an -// HTTPS endpoint or a Lambda function ARN. +// The configuration that allows a bot to receive outgoing events. Can be either +// an HTTPS endpoint or a Lambda function ARN. type EventsConfiguration struct { // The bot ID. @@ -945,7 +943,7 @@ type LoggingConfiguration struct { type MediaCapturePipeline struct { // The configuration for a specified media capture pipeline. SourceType must be - // ChimeSdkMeeting. + // ChimeSdkMeeting . ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration // The time at which the capture pipeline was created, in ISO 8601 format. @@ -964,7 +962,7 @@ type MediaCapturePipeline struct { // ARN of the source from which the media artifacts will be saved. SourceArn *string - // Source type from which media artifacts are saved. You must use ChimeMeeting. + // Source type from which media artifacts are saved. You must use ChimeMeeting . SourceType MediaPipelineSourceType // The status of the media capture pipeline. @@ -1016,10 +1014,10 @@ type Meeting struct { // The media placement for the meeting. MediaPlacement *MediaPlacement - // The Region in which you create the meeting. Available values: af-south-1, - // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, - // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, - // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. + // The Region in which you create the meeting. Available values: af-south-1 , + // ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , + // ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , + // eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . MediaRegion *string // The Amazon Chime SDK meeting ID. @@ -1030,7 +1028,7 @@ type Meeting struct { // The resource target configurations for receiving Amazon Chime SDK meeting and // attendee event notifications. The Amazon Chime SDK supports resource targets -// located in the US East (N. Virginia) AWS Region (us-east-1). +// located in the US East (N. Virginia) AWS Region ( us-east-1 ). type MeetingNotificationConfiguration struct { // The SNS topic ARN. @@ -1118,12 +1116,12 @@ type Origination struct { // When origination settings are disabled, inbound calls are not enabled for your // Amazon Chime Voice Connector. This parameter is not required, but you must - // specify this parameter or Routes. + // specify this parameter or Routes . Disabled *bool // The call distribution properties defined for your SIP hosts. Valid range: // Minimum value of 1. Maximum value of 20. This parameter is not required, but you - // must specify this parameter or Disabled. + // must specify this parameter or Disabled . Routes []OriginationRoute noSmithyDocumentSerde @@ -1141,8 +1139,8 @@ type OriginationRoute struct { // The designated origination route port. Defaults to 5060. Port *int32 - // The priority associated with the host, with 1 being the highest priority. Higher - // priority hosts are attempted first. + // The priority associated with the host, with 1 being the highest priority. + // Higher priority hosts are attempted first. Priority *int32 // The protocol to use for the origination route. Encryption-enabled Amazon Chime @@ -1318,8 +1316,8 @@ type Proxy struct { // The default number of minutes allowed for proxy sessions. DefaultSessionExpiryMinutes *int32 - // When true, stops proxy sessions from being created on the specified Amazon Chime - // Voice Connector. + // When true, stops proxy sessions from being created on the specified Amazon + // Chime Voice Connector. Disabled *bool // The phone number to route calls to after a proxy session expires. @@ -1378,8 +1376,9 @@ type ProxySession struct { noSmithyDocumentSerde } -// The retention settings for an Amazon Chime Enterprise account that determine how -// long to retain items such as chat-room messages and chat-conversation messages. +// The retention settings for an Amazon Chime Enterprise account that determine +// how long to retain items such as chat-room messages and chat-conversation +// messages. type RetentionSettings struct { // The chat conversation retention settings. @@ -1540,17 +1539,17 @@ type SipRule struct { // The SIP rule ID. SipRuleId *string - // Target SIP media application and other details, such as priority and AWS Region, - // to be specified in the SIP rule. Only one SIP rule per AWS Region can be + // Target SIP media application and other details, such as priority and AWS + // Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be // provided. TargetApplications []SipRuleTargetApplication - // The type of trigger assigned to the SIP rule in TriggerValue, currently - // RequestUriHostname or ToPhoneNumber. + // The type of trigger assigned to the SIP rule in TriggerValue , currently + // RequestUriHostname or ToPhoneNumber . TriggerType SipRuleTriggerType - // If TriggerType is RequestUriHostname, then the value can be the outbound host - // name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then + // If TriggerType is RequestUriHostname , then the value can be the outbound host + // name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then // the value can be a customer-owned phone number in E164 format. SipRule is // triggered when a SIP rule requests host name or ToPhoneNumber matches in the // incoming SIP request. @@ -1562,8 +1561,8 @@ type SipRule struct { noSmithyDocumentSerde } -// Target SIP media application and other details, such as priority and AWS Region, -// to be specified in the SIP rule. Only one SIP rule per AWS Region can be +// Target SIP media application and other details, such as priority and AWS +// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be // provided. type SipRuleTargetApplication struct { @@ -1668,8 +1667,8 @@ type Termination struct { // The IP addresses allowed to make calls, in CIDR format. Required. CidrAllowedList []string - // The limit on calls per second. Max value based on account service quota. Default - // value of 1. + // The limit on calls per second. Max value based on account service quota. + // Default value of 1. CpsLimit *int32 // The default caller ID phone number. @@ -1681,8 +1680,8 @@ type Termination struct { noSmithyDocumentSerde } -// The termination health details, including the source IP address and timestamp of -// the last successful SIP OPTIONS message from your SIP infrastructure. +// The termination health details, including the source IP address and timestamp +// of the last successful SIP OPTIONS message from your SIP infrastructure. type TerminationHealth struct { // The source IP address. @@ -1695,7 +1694,7 @@ type TerminationHealth struct { } // The configuration for the current transcription operation. Must contain -// EngineTranscribeSettings or EngineTranscribeMedicalSettings. +// EngineTranscribeSettings or EngineTranscribeMedicalSettings . type TranscriptionConfiguration struct { // The transcription configuration settings passed to Amazon Transcribe Medical. @@ -1794,8 +1793,8 @@ type User struct { } // The list of errors returned when errors are encountered during the -// BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes -// user IDs, error codes, and error messages. +// BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This +// includes user IDs, error codes, and error messages. type UserError struct { // The error code. @@ -1836,12 +1835,12 @@ type VideoArtifactsConfiguration struct { noSmithyDocumentSerde } -// The Amazon Chime Voice Connector configuration, including outbound host name and -// encryption settings. +// The Amazon Chime Voice Connector configuration, including outbound host name +// and encryption settings. type VoiceConnector struct { // The AWS Region in which the Amazon Chime Voice Connector is created. Default: - // us-east-1. + // us-east-1 . AwsRegion VoiceConnectorAwsRegion // The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format. diff --git a/service/chimesdkidentity/api_client.go b/service/chimesdkidentity/api_client.go index 203c89bb7b4..96ee8efa3ee 100644 --- a/service/chimesdkidentity/api_client.go +++ b/service/chimesdkidentity/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chimesdkidentity/api_op_CreateAppInstance.go b/service/chimesdkidentity/api_op_CreateAppInstance.go index 9013fc08c39..8785150931b 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstance.go +++ b/service/chimesdkidentity/api_op_CreateAppInstance.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK -// messaging customers use this API. CreateAppInstance supports idempotency +// Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only +// SDK messaging customers use this API. CreateAppInstance supports idempotency // behavior as described in the AWS API Standard. identity func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanceInput, optFns ...func(*Options)) (*CreateAppInstanceOutput, error) { if params == nil { @@ -33,20 +33,20 @@ func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanc type CreateAppInstanceInput struct { // The unique ID of the request. Use different tokens to create different - // AppInstances. + // AppInstances . // // This member is required. ClientRequestToken *string - // The name of the AppInstance. + // The name of the AppInstance . // // This member is required. Name *string - // The metadata of the AppInstance. Limited to a 1KB string in UTF-8. + // The metadata of the AppInstance . Limited to a 1KB string in UTF-8. Metadata *string - // Tags assigned to the AppInstance. + // Tags assigned to the AppInstance . Tags []types.Tag noSmithyDocumentSerde @@ -54,7 +54,7 @@ type CreateAppInstanceInput struct { type CreateAppInstanceOutput struct { - // The Amazon Resource Number (ARN) of the AppInstance. + // The Amazon Resource Number (ARN) of the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go b/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go index 2019228d261..c0ada327372 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go +++ b/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go @@ -11,17 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The +// Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin . The // promoted entity can perform the following actions. +// - ChannelModerator actions across all channels in the AppInstance . +// - DeleteChannelMessage actions. // -// * ChannelModerator actions -// across all channels in the AppInstance. -// -// * DeleteChannelMessage actions. -// -// Only -// an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin -// role. +// Only an AppInstanceUser and AppInstanceBot can be promoted to an +// AppInstanceAdmin role. func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppInstanceAdminInput, optFns ...func(*Options)) (*CreateAppInstanceAdminOutput, error) { if params == nil { params = &CreateAppInstanceAdminInput{} @@ -39,12 +35,12 @@ func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppIn type CreateAppInstanceAdminInput struct { - // The ARN of the administrator of the current AppInstance. + // The ARN of the administrator of the current AppInstance . // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -54,11 +50,11 @@ type CreateAppInstanceAdminInput struct { type CreateAppInstanceAdminOutput struct { - // The ARN and name of the administrator, the ARN of the AppInstance, and the + // The ARN and name of the administrator, the ARN of the AppInstance , and the // created and last-updated timestamps. All timestamps use epoch milliseconds. AppInstanceAdmin *types.Identity - // The ARN of the of the admin for the AppInstance. + // The ARN of the of the admin for the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_CreateAppInstanceBot.go b/service/chimesdkidentity/api_op_CreateAppInstanceBot.go index dc9045a8aa6..88a2bc3c270 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstanceBot.go +++ b/service/chimesdkidentity/api_op_CreateAppInstanceBot.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a bot under an Amazon Chime AppInstance. The request consists of a +// Creates a bot under an Amazon Chime AppInstance . The request consists of a // unique Configuration and Name for that bot. func (c *Client) CreateAppInstanceBot(ctx context.Context, params *CreateAppInstanceBotInput, optFns ...func(*Options)) (*CreateAppInstanceBotOutput, error) { if params == nil { @@ -37,7 +37,7 @@ type CreateAppInstanceBotInput struct { AppInstanceArn *string // The unique ID for the client making the request. Use different tokens for - // different AppInstanceBots. + // different AppInstanceBots . // // This member is required. ClientRequestToken *string @@ -53,7 +53,7 @@ type CreateAppInstanceBotInput struct { // The user's name. Name *string - // The tags assigned to the AppInstanceBot. + // The tags assigned to the AppInstanceBot . Tags []types.Tag noSmithyDocumentSerde @@ -61,7 +61,7 @@ type CreateAppInstanceBotInput struct { type CreateAppInstanceBotOutput struct { - // The ARN of the AppinstanceBot. + // The ARN of the AppinstanceBot . AppInstanceBotArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_CreateAppInstanceUser.go b/service/chimesdkidentity/api_op_CreateAppInstanceUser.go index cb25b298d06..a4e60b6652e 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstanceUser.go +++ b/service/chimesdkidentity/api_op_CreateAppInstanceUser.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user under an Amazon Chime AppInstance. The request consists of a +// Creates a user under an Amazon Chime AppInstance . The request consists of a // unique appInstanceUserId and Name for that user. func (c *Client) CreateAppInstanceUser(ctx context.Context, params *CreateAppInstanceUserInput, optFns ...func(*Options)) (*CreateAppInstanceUserOutput, error) { if params == nil { @@ -36,13 +36,13 @@ type CreateAppInstanceUserInput struct { // This member is required. AppInstanceArn *string - // The user ID of the AppInstance. + // The user ID of the AppInstance . // // This member is required. AppInstanceUserId *string // The unique ID of the request. Use different tokens to request additional - // AppInstances. + // AppInstances . // // This member is required. ClientRequestToken *string @@ -59,7 +59,7 @@ type CreateAppInstanceUserInput struct { // The request's metadata. Limited to a 1KB string in UTF-8. Metadata *string - // Tags assigned to the AppInstanceUser. + // Tags assigned to the AppInstanceUser . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/chimesdkidentity/api_op_DeleteAppInstance.go b/service/chimesdkidentity/api_op_DeleteAppInstance.go index df88e980547..d289049ce98 100644 --- a/service/chimesdkidentity/api_op_DeleteAppInstance.go +++ b/service/chimesdkidentity/api_op_DeleteAppInstance.go @@ -28,7 +28,7 @@ func (c *Client) DeleteAppInstance(ctx context.Context, params *DeleteAppInstanc type DeleteAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chimesdkidentity/api_op_DeleteAppInstanceAdmin.go b/service/chimesdkidentity/api_op_DeleteAppInstanceAdmin.go index b24919a1a20..2dea3d5f55d 100644 --- a/service/chimesdkidentity/api_op_DeleteAppInstanceAdmin.go +++ b/service/chimesdkidentity/api_op_DeleteAppInstanceAdmin.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action -// does not delete the user. +// Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot . This +// action does not delete the user. func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppInstanceAdminInput, optFns ...func(*Options)) (*DeleteAppInstanceAdminOutput, error) { if params == nil { params = &DeleteAppInstanceAdminInput{} @@ -29,12 +29,12 @@ func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppIn type DeleteAppInstanceAdminInput struct { - // The ARN of the AppInstance's administrator. + // The ARN of the AppInstance 's administrator. // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chimesdkidentity/api_op_DeleteAppInstanceBot.go b/service/chimesdkidentity/api_op_DeleteAppInstanceBot.go index a1b0d7bd1e4..b9db082bdfe 100644 --- a/service/chimesdkidentity/api_op_DeleteAppInstanceBot.go +++ b/service/chimesdkidentity/api_op_DeleteAppInstanceBot.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppInstanceBot. +// Deletes an AppInstanceBot . func (c *Client) DeleteAppInstanceBot(ctx context.Context, params *DeleteAppInstanceBotInput, optFns ...func(*Options)) (*DeleteAppInstanceBotOutput, error) { if params == nil { params = &DeleteAppInstanceBotInput{} diff --git a/service/chimesdkidentity/api_op_DeleteAppInstanceUser.go b/service/chimesdkidentity/api_op_DeleteAppInstanceUser.go index 41734b8e52f..88a307c631c 100644 --- a/service/chimesdkidentity/api_op_DeleteAppInstanceUser.go +++ b/service/chimesdkidentity/api_op_DeleteAppInstanceUser.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppInstanceUser. +// Deletes an AppInstanceUser . func (c *Client) DeleteAppInstanceUser(ctx context.Context, params *DeleteAppInstanceUserInput, optFns ...func(*Options)) (*DeleteAppInstanceUserOutput, error) { if params == nil { params = &DeleteAppInstanceUserInput{} diff --git a/service/chimesdkidentity/api_op_DeregisterAppInstanceUserEndpoint.go b/service/chimesdkidentity/api_op_DeregisterAppInstanceUserEndpoint.go index bed9a67a906..814e4c85c97 100644 --- a/service/chimesdkidentity/api_op_DeregisterAppInstanceUserEndpoint.go +++ b/service/chimesdkidentity/api_op_DeregisterAppInstanceUserEndpoint.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregisters an AppInstanceUserEndpoint. +// Deregisters an AppInstanceUserEndpoint . func (c *Client) DeregisterAppInstanceUserEndpoint(ctx context.Context, params *DeregisterAppInstanceUserEndpointInput, optFns ...func(*Options)) (*DeregisterAppInstanceUserEndpointOutput, error) { if params == nil { params = &DeregisterAppInstanceUserEndpointInput{} @@ -28,12 +28,12 @@ func (c *Client) DeregisterAppInstanceUserEndpoint(ctx context.Context, params * type DeregisterAppInstanceUserEndpointInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . // // This member is required. EndpointId *string diff --git a/service/chimesdkidentity/api_op_DescribeAppInstance.go b/service/chimesdkidentity/api_op_DescribeAppInstance.go index 73664049f9e..8dffbb11362 100644 --- a/service/chimesdkidentity/api_op_DescribeAppInstance.go +++ b/service/chimesdkidentity/api_op_DescribeAppInstance.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstance. +// Returns the full details of an AppInstance . func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppInstanceInput, optFns ...func(*Options)) (*DescribeAppInstanceOutput, error) { if params == nil { params = &DescribeAppInstanceInput{} @@ -29,7 +29,7 @@ func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppIns type DescribeAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -40,7 +40,7 @@ type DescribeAppInstanceInput struct { type DescribeAppInstanceOutput struct { // The ARN, metadata, created and last-updated timestamps, and the name of the - // AppInstance. All timestamps use epoch milliseconds. + // AppInstance . All timestamps use epoch milliseconds. AppInstance *types.AppInstance // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_DescribeAppInstanceAdmin.go b/service/chimesdkidentity/api_op_DescribeAppInstanceAdmin.go index 5d7c763860f..6f283286b25 100644 --- a/service/chimesdkidentity/api_op_DescribeAppInstanceAdmin.go +++ b/service/chimesdkidentity/api_op_DescribeAppInstanceAdmin.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceAdmin. +// Returns the full details of an AppInstanceAdmin . func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeAppInstanceAdminInput, optFns ...func(*Options)) (*DescribeAppInstanceAdminOutput, error) { if params == nil { params = &DescribeAppInstanceAdminInput{} @@ -29,12 +29,12 @@ func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeA type DescribeAppInstanceAdminInput struct { - // The ARN of the AppInstanceAdmin. + // The ARN of the AppInstanceAdmin . // // This member is required. AppInstanceAdminArn *string - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -44,7 +44,7 @@ type DescribeAppInstanceAdminInput struct { type DescribeAppInstanceAdminOutput struct { - // The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the + // The ARN and name of the AppInstanceUser , the ARN of the AppInstance , and the // created and last-updated timestamps. All timestamps use epoch milliseconds. AppInstanceAdmin *types.AppInstanceAdmin diff --git a/service/chimesdkidentity/api_op_DescribeAppInstanceBot.go b/service/chimesdkidentity/api_op_DescribeAppInstanceBot.go index a87a92f1c03..ea096918719 100644 --- a/service/chimesdkidentity/api_op_DescribeAppInstanceBot.go +++ b/service/chimesdkidentity/api_op_DescribeAppInstanceBot.go @@ -29,7 +29,7 @@ func (c *Client) DescribeAppInstanceBot(ctx context.Context, params *DescribeApp type DescribeAppInstanceBotInput struct { - // The ARN of the AppInstanceBot. + // The ARN of the AppInstanceBot . // // This member is required. AppInstanceBotArn *string @@ -39,7 +39,7 @@ type DescribeAppInstanceBotInput struct { type DescribeAppInstanceBotOutput struct { - // The detials of the AppInstanceBot. + // The detials of the AppInstanceBot . AppInstanceBot *types.AppInstanceBot // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_DescribeAppInstanceUser.go b/service/chimesdkidentity/api_op_DescribeAppInstanceUser.go index 42e08185a67..1b250e013a5 100644 --- a/service/chimesdkidentity/api_op_DescribeAppInstanceUser.go +++ b/service/chimesdkidentity/api_op_DescribeAppInstanceUser.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceUser. +// Returns the full details of an AppInstanceUser . func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAppInstanceUserInput, optFns ...func(*Options)) (*DescribeAppInstanceUserOutput, error) { if params == nil { params = &DescribeAppInstanceUserInput{} @@ -29,7 +29,7 @@ func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAp type DescribeAppInstanceUserInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string @@ -39,7 +39,7 @@ type DescribeAppInstanceUserInput struct { type DescribeAppInstanceUserOutput struct { - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . AppInstanceUser *types.AppInstanceUser // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_DescribeAppInstanceUserEndpoint.go b/service/chimesdkidentity/api_op_DescribeAppInstanceUserEndpoint.go index 638346392cc..38d19975853 100644 --- a/service/chimesdkidentity/api_op_DescribeAppInstanceUserEndpoint.go +++ b/service/chimesdkidentity/api_op_DescribeAppInstanceUserEndpoint.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceUserEndpoint. +// Returns the full details of an AppInstanceUserEndpoint . func (c *Client) DescribeAppInstanceUserEndpoint(ctx context.Context, params *DescribeAppInstanceUserEndpointInput, optFns ...func(*Options)) (*DescribeAppInstanceUserEndpointOutput, error) { if params == nil { params = &DescribeAppInstanceUserEndpointInput{} @@ -29,12 +29,12 @@ func (c *Client) DescribeAppInstanceUserEndpoint(ctx context.Context, params *De type DescribeAppInstanceUserEndpointInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . // // This member is required. EndpointId *string @@ -44,7 +44,7 @@ type DescribeAppInstanceUserEndpointInput struct { type DescribeAppInstanceUserEndpointOutput struct { - // The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, + // The full details of an AppInstanceUserEndpoint : the AppInstanceUserArn , ID, // name, type, resource ARN, attributes, allow messages, state, and created and // last updated timestamps. All timestamps use epoch milliseconds. AppInstanceUserEndpoint *types.AppInstanceUserEndpoint diff --git a/service/chimesdkidentity/api_op_GetAppInstanceRetentionSettings.go b/service/chimesdkidentity/api_op_GetAppInstanceRetentionSettings.go index f1c9bef4f5d..070a6c35887 100644 --- a/service/chimesdkidentity/api_op_GetAppInstanceRetentionSettings.go +++ b/service/chimesdkidentity/api_op_GetAppInstanceRetentionSettings.go @@ -12,7 +12,7 @@ import ( "time" ) -// Gets the retention settings for an AppInstance. +// Gets the retention settings for an AppInstance . func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *GetAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*GetAppInstanceRetentionSettingsOutput, error) { if params == nil { params = &GetAppInstanceRetentionSettingsInput{} @@ -30,7 +30,7 @@ func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *Ge type GetAppInstanceRetentionSettingsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -40,7 +40,7 @@ type GetAppInstanceRetentionSettingsInput struct { type GetAppInstanceRetentionSettingsOutput struct { - // The retention settings for the AppInstance. + // The retention settings for the AppInstance . AppInstanceRetentionSettings *types.AppInstanceRetentionSettings // The timestamp representing the time at which the specified items are retained, diff --git a/service/chimesdkidentity/api_op_ListAppInstanceAdmins.go b/service/chimesdkidentity/api_op_ListAppInstanceAdmins.go index f7c8c739a23..d5b85a5413a 100644 --- a/service/chimesdkidentity/api_op_ListAppInstanceAdmins.go +++ b/service/chimesdkidentity/api_op_ListAppInstanceAdmins.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the administrators in the AppInstance. +// Returns a list of the administrators in the AppInstance . func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInstanceAdminsInput, optFns ...func(*Options)) (*ListAppInstanceAdminsOutput, error) { if params == nil { params = &ListAppInstanceAdminsInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInsta type ListAppInstanceAdminsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -38,8 +38,8 @@ type ListAppInstanceAdminsInput struct { // The maximum number of administrators that you want to return. MaxResults *int32 - // The token returned from previous API requests until the number of administrators - // is reached. + // The token returned from previous API requests until the number of + // administrators is reached. NextToken *string noSmithyDocumentSerde @@ -50,11 +50,11 @@ type ListAppInstanceAdminsOutput struct { // The information for each administrator. AppInstanceAdmins []types.AppInstanceAdminSummary - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string - // The token returned from previous API requests until the number of administrators - // is reached. + // The token returned from previous API requests until the number of + // administrators is reached. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_ListAppInstanceBots.go b/service/chimesdkidentity/api_op_ListAppInstanceBots.go index 0ce54af1f38..0a9040a276f 100644 --- a/service/chimesdkidentity/api_op_ListAppInstanceBots.go +++ b/service/chimesdkidentity/api_op_ListAppInstanceBots.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all AppInstanceBots created under a single AppInstance. +// Lists all AppInstanceBots created under a single AppInstance . func (c *Client) ListAppInstanceBots(ctx context.Context, params *ListAppInstanceBotsInput, optFns ...func(*Options)) (*ListAppInstanceBotsOutput, error) { if params == nil { params = &ListAppInstanceBotsInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceBots(ctx context.Context, params *ListAppInstanc type ListAppInstanceBotsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -49,7 +49,7 @@ type ListAppInstanceBotsOutput struct { // The ARN of the AppInstance. AppInstanceArn *string - // The information for each requested AppInstanceBot. + // The information for each requested AppInstanceBot . AppInstanceBots []types.AppInstanceBotSummary // The token passed by previous API calls until all requested bots are returned. @@ -124,8 +124,8 @@ func (c *Client) addOperationListAppInstanceBotsMiddlewares(stack *middleware.St return nil } -// ListAppInstanceBotsAPIClient is a client that implements the ListAppInstanceBots -// operation. +// ListAppInstanceBotsAPIClient is a client that implements the +// ListAppInstanceBots operation. type ListAppInstanceBotsAPIClient interface { ListAppInstanceBots(context.Context, *ListAppInstanceBotsInput, ...func(*Options)) (*ListAppInstanceBotsOutput, error) } diff --git a/service/chimesdkidentity/api_op_ListAppInstanceUserEndpoints.go b/service/chimesdkidentity/api_op_ListAppInstanceUserEndpoints.go index 9b3d0b0e55c..66131607227 100644 --- a/service/chimesdkidentity/api_op_ListAppInstanceUserEndpoints.go +++ b/service/chimesdkidentity/api_op_ListAppInstanceUserEndpoints.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser. +// Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser . func (c *Client) ListAppInstanceUserEndpoints(ctx context.Context, params *ListAppInstanceUserEndpointsInput, optFns ...func(*Options)) (*ListAppInstanceUserEndpointsOutput, error) { if params == nil { params = &ListAppInstanceUserEndpointsInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceUserEndpoints(ctx context.Context, params *ListA type ListAppInstanceUserEndpointsInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string @@ -47,7 +47,7 @@ type ListAppInstanceUserEndpointsInput struct { type ListAppInstanceUserEndpointsOutput struct { - // The information for each requested AppInstanceUserEndpoint. + // The information for each requested AppInstanceUserEndpoint . AppInstanceUserEndpoints []types.AppInstanceUserEndpointSummary // The token passed by previous API calls until all requested endpoints are diff --git a/service/chimesdkidentity/api_op_ListAppInstanceUsers.go b/service/chimesdkidentity/api_op_ListAppInstanceUsers.go index 0c792497306..e0e5e02b0b9 100644 --- a/service/chimesdkidentity/api_op_ListAppInstanceUsers.go +++ b/service/chimesdkidentity/api_op_ListAppInstanceUsers.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all AppInstanceUsers created under a single AppInstance. +// List all AppInstanceUsers created under a single AppInstance . func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstanceUsersInput, optFns ...func(*Options)) (*ListAppInstanceUsersOutput, error) { if params == nil { params = &ListAppInstanceUsersInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstan type ListAppInstanceUsersInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -46,10 +46,10 @@ type ListAppInstanceUsersInput struct { type ListAppInstanceUsersOutput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string - // The information for each requested AppInstanceUser. + // The information for each requested AppInstanceUser . AppInstanceUsers []types.AppInstanceUserSummary // The token passed by previous API calls until all requested users are returned. diff --git a/service/chimesdkidentity/api_op_ListAppInstances.go b/service/chimesdkidentity/api_op_ListAppInstances.go index 37a26c65270..0ec7e759b63 100644 --- a/service/chimesdkidentity/api_op_ListAppInstances.go +++ b/service/chimesdkidentity/api_op_ListAppInstances.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Amazon Chime AppInstances created under a single AWS account. +// Lists all Amazon Chime AppInstance s created under a single AWS account. func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesInput, optFns ...func(*Options)) (*ListAppInstancesOutput, error) { if params == nil { params = &ListAppInstancesInput{} @@ -30,11 +30,11 @@ func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesI type ListAppInstancesInput struct { - // The maximum number of AppInstances that you want to return. + // The maximum number of AppInstance s that you want to return. MaxResults *int32 // The token passed by previous API requests until you reach the maximum number of - // AppInstances. + // AppInstances . NextToken *string noSmithyDocumentSerde @@ -42,11 +42,11 @@ type ListAppInstancesInput struct { type ListAppInstancesOutput struct { - // The information for each AppInstance. + // The information for each AppInstance . AppInstances []types.AppInstanceSummary // The token passed by previous API requests until the maximum number of - // AppInstances is reached. + // AppInstance s is reached. NextToken *string // Metadata pertaining to the operation's result. @@ -125,7 +125,7 @@ var _ ListAppInstancesAPIClient = (*Client)(nil) // ListAppInstancesPaginatorOptions is the paginator options for ListAppInstances type ListAppInstancesPaginatorOptions struct { - // The maximum number of AppInstances that you want to return. + // The maximum number of AppInstance s that you want to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/chimesdkidentity/api_op_PutAppInstanceRetentionSettings.go b/service/chimesdkidentity/api_op_PutAppInstanceRetentionSettings.go index 13f2133d459..f87e0a10d22 100644 --- a/service/chimesdkidentity/api_op_PutAppInstanceRetentionSettings.go +++ b/service/chimesdkidentity/api_op_PutAppInstanceRetentionSettings.go @@ -30,7 +30,7 @@ func (c *Client) PutAppInstanceRetentionSettings(ctx context.Context, params *Pu type PutAppInstanceRetentionSettingsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string diff --git a/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go b/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go index be30c4da903..e030ea77c95 100644 --- a/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go +++ b/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go @@ -33,7 +33,7 @@ func (c *Client) PutAppInstanceUserExpirationSettings(ctx context.Context, param type PutAppInstanceUserExpirationSettingsInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string @@ -47,7 +47,7 @@ type PutAppInstanceUserExpirationSettingsInput struct { type PutAppInstanceUserExpirationSettingsOutput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // Settings that control the interval after which an AppInstanceUser is diff --git a/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go b/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go index 53dbcfef6d1..6362dc1dade 100644 --- a/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go +++ b/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint +// Registers an endpoint under an Amazon Chime AppInstanceUser . The endpoint // receives messages for a user. For push notifications, the endpoint is a mobile // device used to receive mobile push notifications for a user. func (c *Client) RegisterAppInstanceUserEndpoint(ctx context.Context, params *RegisterAppInstanceUserEndpointInput, optFns ...func(*Options)) (*RegisterAppInstanceUserEndpointOutput, error) { @@ -32,7 +32,7 @@ func (c *Client) RegisterAppInstanceUserEndpoint(ctx context.Context, params *Re type RegisterAppInstanceUserEndpointInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string @@ -43,7 +43,7 @@ type RegisterAppInstanceUserEndpointInput struct { // This member is required. ClientRequestToken *string - // The attributes of an Endpoint. + // The attributes of an Endpoint . // // This member is required. EndpointAttributes *types.EndpointAttributes @@ -53,29 +53,22 @@ type RegisterAppInstanceUserEndpointInput struct { // This member is required. ResourceArn *string - // The type of the AppInstanceUserEndpoint. Supported types: - // - // * APNS: The mobile - // notification service for an Apple device. - // - // * APNS_SANDBOX: The sandbox - // environment of the mobile notification service for an Apple device. - // - // * GCM: The - // mobile notification service for an Android device. - // - // Populate the ResourceArn - // value of each type as PinpointAppArn. + // The type of the AppInstanceUserEndpoint . Supported types: + // - APNS : The mobile notification service for an Apple device. + // - APNS_SANDBOX : The sandbox environment of the mobile notification service + // for an Apple device. + // - GCM : The mobile notification service for an Android device. + // Populate the ResourceArn value of each type as PinpointAppArn . // // This member is required. Type types.AppInstanceUserEndpointType - // Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive - // messages. ALL indicates the endpoint receives all messages. NONE indicates the - // endpoint receives no messages. + // Boolean that controls whether the AppInstanceUserEndpoint is opted in to + // receive messages. ALL indicates the endpoint receives all messages. NONE + // indicates the endpoint receives no messages. AllowMessages types.AllowMessages - // The name of the AppInstanceUserEndpoint. + // The name of the AppInstanceUserEndpoint . Name *string noSmithyDocumentSerde @@ -83,10 +76,10 @@ type RegisterAppInstanceUserEndpointInput struct { type RegisterAppInstanceUserEndpointOutput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . EndpointId *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_UpdateAppInstance.go b/service/chimesdkidentity/api_op_UpdateAppInstance.go index e217e4af837..ca3e957a306 100644 --- a/service/chimesdkidentity/api_op_UpdateAppInstance.go +++ b/service/chimesdkidentity/api_op_UpdateAppInstance.go @@ -28,7 +28,7 @@ func (c *Client) UpdateAppInstance(ctx context.Context, params *UpdateAppInstanc type UpdateAppInstanceInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -48,7 +48,7 @@ type UpdateAppInstanceInput struct { type UpdateAppInstanceOutput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . AppInstanceArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_UpdateAppInstanceBot.go b/service/chimesdkidentity/api_op_UpdateAppInstanceBot.go index 32f40838ebf..531ca11d7ae 100644 --- a/service/chimesdkidentity/api_op_UpdateAppInstanceBot.go +++ b/service/chimesdkidentity/api_op_UpdateAppInstanceBot.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the name and metadata of an AppInstanceBot. +// Updates the name and metadata of an AppInstanceBot . func (c *Client) UpdateAppInstanceBot(ctx context.Context, params *UpdateAppInstanceBotInput, optFns ...func(*Options)) (*UpdateAppInstanceBotOutput, error) { if params == nil { params = &UpdateAppInstanceBotInput{} @@ -28,17 +28,17 @@ func (c *Client) UpdateAppInstanceBot(ctx context.Context, params *UpdateAppInst type UpdateAppInstanceBotInput struct { - // The ARN of the AppInstanceBot. + // The ARN of the AppInstanceBot . // // This member is required. AppInstanceBotArn *string - // The metadata of the AppInstanceBot. + // The metadata of the AppInstanceBot . // // This member is required. Metadata *string - // The name of the AppInstanceBot. + // The name of the AppInstanceBot . // // This member is required. Name *string @@ -48,7 +48,7 @@ type UpdateAppInstanceBotInput struct { type UpdateAppInstanceBotOutput struct { - // The ARN of the AppInstanceBot. + // The ARN of the AppInstanceBot . AppInstanceBotArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_UpdateAppInstanceUser.go b/service/chimesdkidentity/api_op_UpdateAppInstanceUser.go index c7e9a0ba900..938ca914391 100644 --- a/service/chimesdkidentity/api_op_UpdateAppInstanceUser.go +++ b/service/chimesdkidentity/api_op_UpdateAppInstanceUser.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details of an AppInstanceUser. You can update names and metadata. +// Updates the details of an AppInstanceUser . You can update names and metadata. func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppInstanceUserInput, optFns ...func(*Options)) (*UpdateAppInstanceUserOutput, error) { if params == nil { params = &UpdateAppInstanceUserInput{} @@ -28,17 +28,17 @@ func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppIns type UpdateAppInstanceUserInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . // // This member is required. Metadata *string - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . // // This member is required. Name *string @@ -48,7 +48,7 @@ type UpdateAppInstanceUserInput struct { type UpdateAppInstanceUserOutput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/api_op_UpdateAppInstanceUserEndpoint.go b/service/chimesdkidentity/api_op_UpdateAppInstanceUserEndpoint.go index b445c2e445c..21830d9315c 100644 --- a/service/chimesdkidentity/api_op_UpdateAppInstanceUserEndpoint.go +++ b/service/chimesdkidentity/api_op_UpdateAppInstanceUserEndpoint.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details of an AppInstanceUserEndpoint. You can update the name and +// Updates the details of an AppInstanceUserEndpoint . You can update the name and // AllowMessage values. func (c *Client) UpdateAppInstanceUserEndpoint(ctx context.Context, params *UpdateAppInstanceUserEndpointInput, optFns ...func(*Options)) (*UpdateAppInstanceUserEndpointOutput, error) { if params == nil { @@ -30,22 +30,22 @@ func (c *Client) UpdateAppInstanceUserEndpoint(ctx context.Context, params *Upda type UpdateAppInstanceUserEndpointInput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . // // This member is required. AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . // // This member is required. EndpointId *string - // Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive - // messages. ALL indicates the endpoint will receive all messages. NONE indicates - // the endpoint will receive no messages. + // Boolean that controls whether the AppInstanceUserEndpoint is opted in to + // receive messages. ALL indicates the endpoint will receive all messages. NONE + // indicates the endpoint will receive no messages. AllowMessages types.AllowMessages - // The name of the AppInstanceUserEndpoint. + // The name of the AppInstanceUserEndpoint . Name *string noSmithyDocumentSerde @@ -53,10 +53,10 @@ type UpdateAppInstanceUserEndpointInput struct { type UpdateAppInstanceUserEndpointOutput struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . EndpointId *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkidentity/doc.go b/service/chimesdkidentity/doc.go index 3d9215d4b68..185bccda9ec 100644 --- a/service/chimesdkidentity/doc.go +++ b/service/chimesdkidentity/doc.go @@ -6,6 +6,6 @@ // The Amazon Chime SDK Identity APIs in this section allow software developers to // create and manage unique instances of their messaging applications. These APIs // provide the overarching framework for creating and sending messages. For more -// information about the identity APIs, refer to Amazon Chime SDK identity -// (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html). +// information about the identity APIs, refer to Amazon Chime SDK identity (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html) +// . package chimesdkidentity diff --git a/service/chimesdkidentity/types/enums.go b/service/chimesdkidentity/types/enums.go index 6db71ea7a92..cb1acaca6f7 100644 --- a/service/chimesdkidentity/types/enums.go +++ b/service/chimesdkidentity/types/enums.go @@ -97,9 +97,9 @@ const ( ErrorCodePhoneNumberAssociationsExist ErrorCode = "PhoneNumberAssociationsExist" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "BadRequest", diff --git a/service/chimesdkidentity/types/types.go b/service/chimesdkidentity/types/types.go index 85f91a96b7f..b4cf53c263a 100644 --- a/service/chimesdkidentity/types/types.go +++ b/service/chimesdkidentity/types/types.go @@ -7,7 +7,7 @@ import ( "time" ) -// The details of an AppInstance, an instance of an Amazon Chime SDK messaging +// The details of an AppInstance , an instance of an Amazon Chime SDK messaging // application. type AppInstance struct { @@ -20,16 +20,16 @@ type AppInstance struct { // The time an AppInstance was last updated. In epoch milliseconds. LastUpdatedTimestamp *time.Time - // The metadata of an AppInstance. + // The metadata of an AppInstance . Metadata *string - // The name of an AppInstance. + // The name of an AppInstance . Name *string noSmithyDocumentSerde } -// The name and ARN of the admin for the AppInstance. +// The name and ARN of the admin for the AppInstance . type AppInstanceAdmin struct { // The AppInstanceAdmin data. @@ -44,16 +44,16 @@ type AppInstanceAdmin struct { noSmithyDocumentSerde } -// Summary of the details of an AppInstanceAdmin. +// Summary of the details of an AppInstanceAdmin . type AppInstanceAdminSummary struct { - // The details of the AppInstanceAdmin. + // The details of the AppInstanceAdmin . Admin *Identity noSmithyDocumentSerde } -// An Amazon Lex V2 chat bot created under an AppInstance. +// An Amazon Lex V2 chat bot created under an AppInstance . type AppInstanceBot struct { // The ARN of the AppInstanceBot. @@ -92,7 +92,7 @@ type AppInstanceBotSummary struct { noSmithyDocumentSerde } -// The details of the data-retention settings for an AppInstance. +// The details of the data-retention settings for an AppInstance . type AppInstanceRetentionSettings struct { // The length of time in days to retain the messages in a channel. @@ -101,25 +101,25 @@ type AppInstanceRetentionSettings struct { noSmithyDocumentSerde } -// Summary of the data for an AppInstance. +// Summary of the data for an AppInstance . type AppInstanceSummary struct { // The AppInstance ARN. AppInstanceArn *string - // The metadata of the AppInstance. + // The metadata of the AppInstance . Metadata *string - // The name of the AppInstance. + // The name of the AppInstance . Name *string noSmithyDocumentSerde } -// The details of an AppInstanceUser. +// The details of an AppInstanceUser . type AppInstanceUser struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // The time at which the AppInstanceUser was created. @@ -131,10 +131,10 @@ type AppInstanceUser struct { // The time at which the AppInstanceUser was last updated. LastUpdatedTimestamp *time.Time - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . Metadata *string - // The name of the AppInstanceUser. + // The name of the AppInstanceUser . Name *string noSmithyDocumentSerde @@ -145,58 +145,52 @@ type AppInstanceUser struct { // mobile push notifications for a user. type AppInstanceUserEndpoint struct { - // Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive - // messages. ALL indicates the endpoint will receive all messages. NONE indicates - // the endpoint will receive no messages. + // Boolean that controls whether the AppInstanceUserEndpoint is opted in to + // receive messages. ALL indicates the endpoint will receive all messages. NONE + // indicates the endpoint will receive no messages. AllowMessages AllowMessages - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string // The time at which an AppInstanceUserEndpoint was created. CreatedTimestamp *time.Time - // The attributes of an Endpoint. + // The attributes of an Endpoint . EndpointAttributes *EndpointAttributes - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . EndpointId *string - // A read-only field that represents the state of an AppInstanceUserEndpoint. + // A read-only field that represents the state of an AppInstanceUserEndpoint . // Supported values: - // - // * ACTIVE: The AppInstanceUserEndpoint is active and able to - // receive messages. When ACTIVE, the EndpointStatusReason remains empty. - // - // * - // INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. - // When INACTIVE, the corresponding reason will be conveyed through - // EndpointStatusReason. - // - // * INVALID_DEVICE_TOKEN indicates that an - // AppInstanceUserEndpoint is INACTIVE due to invalid device token - // - // * - // INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due - // to an invalid pinpoint ARN that was input through the ResourceArn field. + // - ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages. + // When ACTIVE , the EndpointStatusReason remains empty. + // - INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive + // message. When INACTIVE , the corresponding reason will be conveyed through + // EndpointStatusReason . + // - INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE + // due to invalid device token + // - INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE + // due to an invalid pinpoint ARN that was input through the ResourceArn field. EndpointState *EndpointState // The time at which an AppInstanceUserEndpoint was last updated. LastUpdatedTimestamp *time.Time - // The name of the AppInstanceUserEndpoint. + // The name of the AppInstanceUserEndpoint . Name *string // The ARN of the resource to which the endpoint belongs. ResourceArn *string - // The type of the AppInstanceUserEndpoint. + // The type of the AppInstanceUserEndpoint . Type AppInstanceUserEndpointType noSmithyDocumentSerde } -// Summary of the details of an AppInstanceUserEndpoint. +// Summary of the details of an AppInstanceUserEndpoint . type AppInstanceUserEndpointSummary struct { // BBoolean that controls whether the AppInstanceUserEndpoint is opted in to @@ -204,34 +198,34 @@ type AppInstanceUserEndpointSummary struct { // indicates the endpoint will receive no messages. AllowMessages AllowMessages - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string - // The unique identifier of the AppInstanceUserEndpoint. + // The unique identifier of the AppInstanceUserEndpoint . EndpointId *string - // A read-only field that represent the state of an AppInstanceUserEndpoint. + // A read-only field that represent the state of an AppInstanceUserEndpoint . EndpointState *EndpointState - // The name of the AppInstanceUserEndpoint. + // The name of the AppInstanceUserEndpoint . Name *string - // The type of the AppInstanceUserEndpoint. + // The type of the AppInstanceUserEndpoint . Type AppInstanceUserEndpointType noSmithyDocumentSerde } -// Summary of the details of an AppInstanceUser. +// Summary of the details of an AppInstanceUser . type AppInstanceUserSummary struct { - // The ARN of the AppInstanceUser. + // The ARN of the AppInstanceUser . AppInstanceUserArn *string - // The metadata of the AppInstanceUser. + // The metadata of the AppInstanceUser . Metadata *string - // The name of an AppInstanceUser. + // The name of an AppInstanceUser . Name *string noSmithyDocumentSerde @@ -257,7 +251,7 @@ type Configuration struct { noSmithyDocumentSerde } -// The attributes of an Endpoint. +// The attributes of an Endpoint . type EndpointAttributes struct { // The device token for the GCM, APNS, and APNS_SANDBOX endpoint types. @@ -271,31 +265,25 @@ type EndpointAttributes struct { noSmithyDocumentSerde } -// A read-only field that represents the state of an AppInstanceUserEndpoint. +// A read-only field that represents the state of an AppInstanceUserEndpoint . // Supported values: -// -// * ACTIVE: The AppInstanceUserEndpoint is active and able to -// receive messages. When ACTIVE, the EndpointStatusReason remains empty. -// -// * -// INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. -// When INACTIVE, the corresponding reason will be conveyed through -// EndpointStatusReason. -// -// * INVALID_DEVICE_TOKEN indicates that an -// AppInstanceUserEndpoint is INACTIVE due to invalid device token -// -// * -// INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due -// to an invalid pinpoint ARN that was input through the ResourceArn field. +// - ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages. +// When ACTIVE , the EndpointStatusReason remains empty. +// - INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive +// message. When INACTIVE, the corresponding reason will be conveyed through +// EndpointStatusReason. +// - INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE +// due to invalid device token +// - INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE +// due to an invalid pinpoint ARN that was input through the ResourceArn field. type EndpointState struct { - // Enum that indicates the Status of an AppInstanceUserEndpoint. + // Enum that indicates the Status of an AppInstanceUserEndpoint . // // This member is required. Status EndpointStatus - // The reason for the EndpointStatus. + // The reason for the EndpointStatus . StatusReason EndpointStatusReason noSmithyDocumentSerde @@ -341,9 +329,8 @@ type LexConfiguration struct { // Identifies the Amazon Lex V2 bot's language and locale. The string must match // one of the supported locales in Amazon Lex V2. All of the intents, slot types, // and slots used in the bot must have the same locale. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) in the Amazon - // Lex V2 Developer Guide. + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // in the Amazon Lex V2 Developer Guide. // // This member is required. LocaleId *string diff --git a/service/chimesdkmediapipelines/api_client.go b/service/chimesdkmediapipelines/api_client.go index 2d31b7453e2..2e176fdbc0e 100644 --- a/service/chimesdkmediapipelines/api_client.go +++ b/service/chimesdkmediapipelines/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chimesdkmediapipelines/api_op_CreateMediaCapturePipeline.go b/service/chimesdkmediapipelines/api_op_CreateMediaCapturePipeline.go index 2c6b655ea53..9a283f1bfc8 100644 --- a/service/chimesdkmediapipelines/api_op_CreateMediaCapturePipeline.go +++ b/service/chimesdkmediapipelines/api_op_CreateMediaCapturePipeline.go @@ -53,7 +53,7 @@ type CreateMediaCapturePipelineInput struct { SourceType types.MediaPipelineSourceType // The configuration for a specified media pipeline. SourceType must be - // ChimeSdkMeeting. + // ChimeSdkMeeting . ChimeSdkMeetingConfiguration *types.ChimeSdkMeetingConfiguration // The unique identifier for the client request. The token makes the API request diff --git a/service/chimesdkmediapipelines/api_op_CreateMediaConcatenationPipeline.go b/service/chimesdkmediapipelines/api_op_CreateMediaConcatenationPipeline.go index a0d75024b4c..7fbcc05fd0c 100644 --- a/service/chimesdkmediapipelines/api_op_CreateMediaConcatenationPipeline.go +++ b/service/chimesdkmediapipelines/api_op_CreateMediaConcatenationPipeline.go @@ -52,7 +52,7 @@ type CreateMediaConcatenationPipelineInput struct { type CreateMediaConcatenationPipelineOutput struct { - // A media concatenation pipeline object, the ID, source type, MediaPipelineARN, + // A media concatenation pipeline object, the ID, source type, MediaPipelineARN , // and sink of a media concatenation pipeline object. MediaConcatenationPipeline *types.MediaConcatenationPipeline diff --git a/service/chimesdkmediapipelines/api_op_CreateMediaInsightsPipelineConfiguration.go b/service/chimesdkmediapipelines/api_op_CreateMediaInsightsPipelineConfiguration.go index c8aee9b9409..691f73a9e9a 100644 --- a/service/chimesdkmediapipelines/api_op_CreateMediaInsightsPipelineConfiguration.go +++ b/service/chimesdkmediapipelines/api_op_CreateMediaInsightsPipelineConfiguration.go @@ -31,8 +31,8 @@ func (c *Client) CreateMediaInsightsPipelineConfiguration(ctx context.Context, p type CreateMediaInsightsPipelineConfigurationInput struct { - // The elements in the request, such as a processor for Amazon Transcribe or a sink - // for a Kinesis Data Stream. + // The elements in the request, such as a processor for Amazon Transcribe or a + // sink for a Kinesis Data Stream. // // This member is required. Elements []types.MediaInsightsPipelineConfigurationElement @@ -42,8 +42,9 @@ type CreateMediaInsightsPipelineConfigurationInput struct { // This member is required. MediaInsightsPipelineConfigurationName *string - // The ARN of the role used by the service to access Amazon Web Services resources, - // including Transcribe and Transcribe Call Analytics, on the caller’s behalf. + // The ARN of the role used by the service to access Amazon Web Services + // resources, including Transcribe and Transcribe Call Analytics , on the caller’s + // behalf. // // This member is required. ResourceAccessRoleArn *string @@ -51,8 +52,8 @@ type CreateMediaInsightsPipelineConfigurationInput struct { // The unique identifier for the media insights pipeline configuration request. ClientRequestToken *string - // The configuration settings for the real-time alerts in a media insights pipeline - // configuration. + // The configuration settings for the real-time alerts in a media insights + // pipeline configuration. RealTimeAlertConfiguration *types.RealTimeAlertConfiguration // The tags assigned to the media insights pipeline configuration. diff --git a/service/chimesdkmediapipelines/api_op_ListMediaInsightsPipelineConfigurations.go b/service/chimesdkmediapipelines/api_op_ListMediaInsightsPipelineConfigurations.go index 3f73daf3e72..05b7d5d9d0c 100644 --- a/service/chimesdkmediapipelines/api_op_ListMediaInsightsPipelineConfigurations.go +++ b/service/chimesdkmediapipelines/api_op_ListMediaInsightsPipelineConfigurations.go @@ -113,16 +113,16 @@ func (c *Client) addOperationListMediaInsightsPipelineConfigurationsMiddlewares( return nil } -// ListMediaInsightsPipelineConfigurationsAPIClient is a client that implements the -// ListMediaInsightsPipelineConfigurations operation. +// ListMediaInsightsPipelineConfigurationsAPIClient is a client that implements +// the ListMediaInsightsPipelineConfigurations operation. type ListMediaInsightsPipelineConfigurationsAPIClient interface { ListMediaInsightsPipelineConfigurations(context.Context, *ListMediaInsightsPipelineConfigurationsInput, ...func(*Options)) (*ListMediaInsightsPipelineConfigurationsOutput, error) } var _ ListMediaInsightsPipelineConfigurationsAPIClient = (*Client)(nil) -// ListMediaInsightsPipelineConfigurationsPaginatorOptions is the paginator options -// for ListMediaInsightsPipelineConfigurations +// ListMediaInsightsPipelineConfigurationsPaginatorOptions is the paginator +// options for ListMediaInsightsPipelineConfigurations type ListMediaInsightsPipelineConfigurationsPaginatorOptions struct { // The maximum number of results to return in a single call. Limit int32 diff --git a/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineConfiguration.go b/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineConfiguration.go index dcd501c5eea..407b019c39e 100644 --- a/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineConfiguration.go +++ b/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineConfiguration.go @@ -29,8 +29,8 @@ func (c *Client) UpdateMediaInsightsPipelineConfiguration(ctx context.Context, p type UpdateMediaInsightsPipelineConfigurationInput struct { - // The elements in the request, such as a processor for Amazon Transcribe or a sink - // for a Kinesis Data Stream.. + // The elements in the request, such as a processor for Amazon Transcribe or a + // sink for a Kinesis Data Stream.. // // This member is required. Elements []types.MediaInsightsPipelineConfigurationElement diff --git a/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineStatus.go b/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineStatus.go index 8d59ecefbd1..7b6ba9f0c2c 100644 --- a/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineStatus.go +++ b/service/chimesdkmediapipelines/api_op_UpdateMediaInsightsPipelineStatus.go @@ -29,8 +29,8 @@ func (c *Client) UpdateMediaInsightsPipelineStatus(ctx context.Context, params * type UpdateMediaInsightsPipelineStatusInput struct { - // The unique identifier of the resource to be updated. Valid values include the ID - // and ARN of the media insights pipeline. + // The unique identifier of the resource to be updated. Valid values include the + // ID and ARN of the media insights pipeline. // // This member is required. Identifier *string diff --git a/service/chimesdkmediapipelines/doc.go b/service/chimesdkmediapipelines/doc.go index 0cbc788718d..28fa673056e 100644 --- a/service/chimesdkmediapipelines/doc.go +++ b/service/chimesdkmediapipelines/doc.go @@ -6,6 +6,6 @@ // The Amazon Chime SDK media pipeline APIs in this section allow software // developers to create Amazon Chime SDK media pipelines that capture, concatenate, // or stream your Amazon Chime SDK meetings. For more information about media -// pipelines, see Amazon Chime SDK media pipelines -// (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Media_Pipelines.html). +// pipelines, see Amazon Chime SDK media pipelines (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Media_Pipelines.html) +// . package chimesdkmediapipelines diff --git a/service/chimesdkmediapipelines/types/enums.go b/service/chimesdkmediapipelines/types/enums.go index 49ea43cbc00..540556e75e1 100644 --- a/service/chimesdkmediapipelines/types/enums.go +++ b/service/chimesdkmediapipelines/types/enums.go @@ -82,9 +82,9 @@ const ( AudioMuxTypeAudioWithCompositedVideo AudioMuxType = "AudioWithCompositedVideo" ) -// Values returns all known values for AudioMuxType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioMuxType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AudioMuxType) Values() []AudioMuxType { return []AudioMuxType{ "AudioOnly", @@ -132,8 +132,8 @@ const ( ConcatenationSinkTypeS3Bucket ConcatenationSinkType = "S3Bucket" ) -// Values returns all known values for ConcatenationSinkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ConcatenationSinkType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ConcatenationSinkType) Values() []ConcatenationSinkType { return []ConcatenationSinkType{ @@ -200,9 +200,9 @@ const ( ContentShareLayoutOptionVertical ContentShareLayoutOption = "Vertical" ) -// Values returns all known values for ContentShareLayoutOption. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ContentShareLayoutOption. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentShareLayoutOption) Values() []ContentShareLayoutOption { return []ContentShareLayoutOption{ "PresenterOnly", @@ -240,9 +240,9 @@ const ( ErrorCodeThrottling ErrorCode = "Throttling" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "BadRequest", @@ -280,9 +280,9 @@ const ( LayoutOptionGridView LayoutOption = "GridView" ) -// Values returns all known values for LayoutOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LayoutOption. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LayoutOption) Values() []LayoutOption { return []LayoutOption{ "GridView", @@ -314,8 +314,8 @@ const ( LiveConnectorSinkTypeRtmp LiveConnectorSinkType = "RTMP" ) -// Values returns all known values for LiveConnectorSinkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LiveConnectorSinkType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LiveConnectorSinkType) Values() []LiveConnectorSinkType { return []LiveConnectorSinkType{ @@ -393,8 +393,8 @@ const ( MediaPipelineSinkTypeS3Bucket MediaPipelineSinkType = "S3Bucket" ) -// Values returns all known values for MediaPipelineSinkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MediaPipelineSinkType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineSinkType) Values() []MediaPipelineSinkType { return []MediaPipelineSinkType{ @@ -531,8 +531,8 @@ const ( RealTimeAlertRuleTypeIssueDetection RealTimeAlertRuleType = "IssueDetection" ) -// Values returns all known values for RealTimeAlertRuleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RealTimeAlertRuleType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RealTimeAlertRuleType) Values() []RealTimeAlertRuleType { return []RealTimeAlertRuleType{ @@ -601,9 +601,9 @@ const ( VideoMuxTypeVideoOnly VideoMuxType = "VideoOnly" ) -// Values returns all known values for VideoMuxType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for VideoMuxType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (VideoMuxType) Values() []VideoMuxType { return []VideoMuxType{ "VideoOnly", @@ -638,8 +638,8 @@ const ( VoiceAnalyticsConfigurationStatusDisabled VoiceAnalyticsConfigurationStatus = "Disabled" ) -// Values returns all known values for VoiceAnalyticsConfigurationStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for VoiceAnalyticsConfigurationStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (VoiceAnalyticsConfigurationStatus) Values() []VoiceAnalyticsConfigurationStatus { diff --git a/service/chimesdkmediapipelines/types/types.go b/service/chimesdkmediapipelines/types/types.go index 2491f3ae31b..4752fc60590 100644 --- a/service/chimesdkmediapipelines/types/types.go +++ b/service/chimesdkmediapipelines/types/types.go @@ -24,27 +24,25 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { // Labels all personally identifiable information (PII) identified in your // transcript. Content identification is performed at the segment level; PII // specified in PiiEntityTypes is flagged upon complete transcription of an audio - // segment. You can’t set ContentIdentificationType and ContentRedactionType in the - // same request. If you do, your request returns a BadRequestException. For more - // information, see Redacting or identifying personally identifiable information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) in the - // Amazon Transcribe Developer Guide. + // segment. You can’t set ContentIdentificationType and ContentRedactionType in + // the same request. If you do, your request returns a BadRequestException . For + // more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // in the Amazon Transcribe Developer Guide. ContentIdentificationType ContentType // Redacts all personally identifiable information (PII) identified in your // transcript. Content redaction is performed at the segment level; PII specified // in PiiEntityTypes is redacted upon complete transcription of an audio segment. // You can’t set ContentRedactionType and ContentIdentificationType in the same - // request. If you do, your request returns a BadRequestException. For more - // information, see Redacting or identifying personally identifiable information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) in the - // Amazon Transcribe Developer Guide. + // request. If you do, your request returns a BadRequestException . For more + // information, see Redacting or identifying personally identifiable information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // in the Amazon Transcribe Developer Guide. ContentRedactionType ContentType // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. For - // more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) // in the Amazon Transcribe Developer Guide. EnablePartialResultsStabilization bool @@ -57,35 +55,33 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { // of the specified language model must match the language code specified in the // transcription request. If the languages don't match, the custom language model // isn't applied. Language mismatches don't generate errors or warnings. For more - // information, see Custom language models - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) + // information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) // in the Amazon Transcribe Developer Guide. LanguageModelName *string // Specifies the level of stability to use when you enable partial results - // stabilization (EnablePartialResultsStabilization). Low stability provides the + // stabilization ( EnablePartialResultsStabilization ). Low stability provides the // highest accuracy. High stability transcribes faster, but with slightly lower - // accuracy. For more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // accuracy. For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) // in the Amazon Transcribe Developer Guide. PartialResultsStability PartialResultsStability // Specifies the types of personally identifiable information (PII) to redact from - // a transcript. You can include as many types as you'd like, or you can select - // ALL. To include PiiEntityTypes in your Call Analytics request, you must also - // include ContentIdentificationType or ContentRedactionType, but you can't include - // both. Values must be comma-separated and can include: ADDRESS, - // BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, - // CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL. Length Constraints: - // Minimum length of 1. Maximum length of 300. + // a transcript. You can include as many types as you'd like, or you can select ALL + // . To include PiiEntityTypes in your Call Analytics request, you must also + // include ContentIdentificationType or ContentRedactionType , but you can't + // include both. Values must be comma-separated and can include: ADDRESS , + // BANK_ACCOUNT_NUMBER , BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , + // CREDIT_DEBIT_NUMBER , EMAIL , NAME , PHONE , PIN , SSN , or ALL . Length + // Constraints: Minimum length of 1. Maximum length of 300. PiiEntityTypes *string // The settings for a post-call analysis task in an analytics configuration. PostCallAnalyticsSettings *PostCallAnalyticsSettings // Specifies how to apply a vocabulary filter to a transcript. To replace words - // with ***, choose mask. To delete words, choose remove. To flag words without - // changing them, choose tag. + // with ***, choose mask . To delete words, choose remove . To flag words without + // changing them, choose tag . VocabularyFilterMethod VocabularyFilterMethod // Specifies the name of the custom vocabulary filter to use when processing a @@ -93,20 +89,18 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { // language of the specified custom vocabulary filter doesn't match the language // identified in your media, the vocabulary filter is not applied to your // transcription. For more information, see Using vocabulary filtering with - // unwanted words - // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) in - // the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. - // Maximum length of 200. + // unwanted words (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) + // in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of + // 1. Maximum length of 200. VocabularyFilterName *string // Specifies the name of the custom vocabulary to use when processing a // transcription. Note that vocabulary names are case sensitive. If the language of // the specified custom vocabulary doesn't match the language identified in your // media, the custom vocabulary is not applied to your transcription. For more - // information, see Custom vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) in the - // Amazon Transcribe Developer Guide. Length Constraints: Minimum length of 1. - // Maximum length of 200. + // information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) + // in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of + // 1. Maximum length of 200. VocabularyName *string noSmithyDocumentSerde @@ -119,9 +113,8 @@ type AmazonTranscribeProcessorConfiguration struct { // The language code that represents the language spoken in your audio. If you're // unsure of the language spoken in your audio, consider using IdentifyLanguage to // enable automatic language identification. For a list of languages that real-time - // Call Analytics supports, see the Supported languages table - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) in - // the Amazon Transcribe Developer Guide. + // Call Analytics supports, see the Supported languages table (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // in the Amazon Transcribe Developer Guide. // // This member is required. LanguageCode CallAnalyticsLanguageCode @@ -129,28 +122,25 @@ type AmazonTranscribeProcessorConfiguration struct { // Labels all personally identifiable information (PII) identified in your // transcript. Content identification is performed at the segment level; PII // specified in PiiEntityTypes is flagged upon complete transcription of an audio - // segment. You can’t set ContentIdentificationType and ContentRedactionType in the - // same request. If you set both, your request returns a BadRequestException. For - // more information, see Redacting or identifying personally identifiable - // information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) in the - // Amazon Transcribe Developer Guide. + // segment. You can’t set ContentIdentificationType and ContentRedactionType in + // the same request. If you set both, your request returns a BadRequestException . + // For more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // in the Amazon Transcribe Developer Guide. ContentIdentificationType ContentType // Redacts all personally identifiable information (PII) identified in your // transcript. Content redaction is performed at the segment level; PII specified // in PiiEntityTypes is redacted upon complete transcription of an audio segment. // You can’t set ContentRedactionType and ContentIdentificationType in the same - // request. If you set both, your request returns a BadRequestException. For more - // information, see Redacting or identifying personally identifiable information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) in the - // Amazon Transcribe Developer Guide. + // request. If you set both, your request returns a BadRequestException . For more + // information, see Redacting or identifying personally identifiable information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // in the Amazon Transcribe Developer Guide. ContentRedactionType ContentType // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. For - // more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) // in the Amazon Transcribe Developer Guide. EnablePartialResultsStabilization bool @@ -163,34 +153,31 @@ type AmazonTranscribeProcessorConfiguration struct { // of the specified language model must match the language code you specify in your // transcription request. If the languages don't match, the custom language model // isn't applied. There are no errors or warnings associated with a language - // mismatch. For more information, see Custom language models - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) + // mismatch. For more information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) // in the Amazon Transcribe Developer Guide. LanguageModelName *string - // The level of stability to use when you enable partial results stabilization - // (EnablePartialResultsStabilization). Low stability provides the highest + // The level of stability to use when you enable partial results stabilization ( + // EnablePartialResultsStabilization ). Low stability provides the highest // accuracy. High stability transcribes faster, but with slightly lower accuracy. - // For more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) // in the Amazon Transcribe Developer Guide. PartialResultsStability PartialResultsStability // The types of personally identifiable information (PII) to redact from a - // transcript. You can include as many types as you'd like, or you can select ALL. + // transcript. You can include as many types as you'd like, or you can select ALL . // To include PiiEntityTypes in your Call Analytics request, you must also include - // ContentIdentificationType or ContentRedactionType, but you can't include both. - // Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, - // NAME, PHONE, PIN, SSN, or ALL. Length Constraints: Minimum length of 1. Maximum - // length of 300. + // ContentIdentificationType or ContentRedactionType , but you can't include both. + // Values must be comma-separated and can include: ADDRESS , BANK_ACCOUNT_NUMBER , + // BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , CREDIT_DEBIT_NUMBER , + // EMAIL , NAME , PHONE , PIN , SSN , or ALL . Length Constraints: Minimum length + // of 1. Maximum length of 300. PiiEntityTypes *string - // Enables speaker partitioning (diarization) in your transcription output. Speaker - // partitioning labels the speech from individual speakers in your media file. For - // more information, see Partitioning speakers (diarization) - // (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) in the - // Amazon Transcribe Developer Guide. + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) + // in the Amazon Transcribe Developer Guide. ShowSpeakerLabel bool // The vocabulary filtering method used in your Call Analytics transcription. @@ -303,7 +290,7 @@ type ChannelDefinition struct { // This member is required. ChannelId int32 - // Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER. + // Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER . ParticipantRole ParticipantRole noSmithyDocumentSerde @@ -323,7 +310,7 @@ type ChimeSdkMeetingConcatenationConfiguration struct { } // The configuration object of the Amazon Chime SDK meeting for a specified media -// pipeline. SourceType must be ChimeSdkMeeting. +// pipeline. SourceType must be ChimeSdkMeeting . type ChimeSdkMeetingConfiguration struct { // The configuration for the artifacts in an Amazon Chime SDK meeting. @@ -376,7 +363,7 @@ type CompositedVideoArtifactsConfiguration struct { } // The composited video configuration object for a specified media pipeline. -// SourceType must be ChimeSdkMeeting. +// SourceType must be ChimeSdkMeeting . type CompositedVideoConcatenationConfiguration struct { // Enables or disables the configuration object. @@ -456,26 +443,20 @@ type DataChannelConcatenationConfiguration struct { noSmithyDocumentSerde } -// Describes the timestamp range and timestamp origin of a range of fragments. Only -// fragments with a start timestamp greater than or equal to the given start time -// and less than or equal to the end time are returned. For example, say a stream -// contains fragments with the following start timestamps: -// -// * 00:00:00 -// -// * -// 00:00:02 -// -// * 00:00:04 +// Describes the timestamp range and timestamp origin of a range of fragments. +// Only fragments with a start timestamp greater than or equal to the given start +// time and less than or equal to the end time are returned. For example, say a +// stream contains fragments with the following start timestamps: +// - 00:00:00 +// - 00:00:02 +// - 00:00:04 +// - 00:00:06 // -// * 00:00:06 -// -// A fragment selector range with a start time of -// 00:00:01 and end time of 00:00:04 would return the fragments with start times of -// 00:00:02 and 00:00:04. +// A fragment selector range with a start time of 00:00:01 and end time of +// 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04. type FragmentSelector struct { - // The origin of the timestamps to use, Server or Producer. For more information, + // The origin of the timestamps to use, Server or Producer . For more information, // see StartSelectorType in the Amazon Kinesis Video Streams Developer Guide. // // This member is required. @@ -528,9 +509,9 @@ type KeywordMatchConfiguration struct { // This member is required. RuleName *string - // Matches keywords or phrases on their presence or absence. If set to TRUE, the + // Matches keywords or phrases on their presence or absence. If set to TRUE , the // rule matches when all the specified keywords or phrases are absent. Default: - // FALSE. + // FALSE . Negate bool noSmithyDocumentSerde @@ -540,8 +521,8 @@ type KeywordMatchConfiguration struct { // sink. type KinesisDataStreamSinkConfiguration struct { - // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ - // (https://aws.amazon.com/kinesis/data-streams/). + // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/) + // . InsightsTarget *string noSmithyDocumentSerde @@ -570,8 +551,7 @@ type KinesisVideoStreamSourceRuntimeConfiguration struct { // Specifies the encoding of your input audio. Supported format: PCM (only signed // 16-bit little-endian audio formats, which does not include WAV) For more - // information, see Media formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) // in the Amazon Transcribe Developer Guide. // // This member is required. @@ -598,8 +578,8 @@ type KinesisVideoStreamSourceRuntimeConfiguration struct { // function's data sink. type LambdaFunctionSinkConfiguration struct { - // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ - // (https://aws.amazon.com/kinesis/data-streams/). + // The URL of the sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/) + // . InsightsTarget *string noSmithyDocumentSerde @@ -659,7 +639,7 @@ type LiveConnectorSourceConfiguration struct { type MediaCapturePipeline struct { // The configuration for a specified media pipeline. SourceType must be - // ChimeSdkMeeting. + // ChimeSdkMeeting . ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration // The time at which the pipeline was created, in ISO 8601 format. @@ -681,7 +661,7 @@ type MediaCapturePipeline struct { // ARN of the source from which the media artifacts are saved. SourceArn *string - // Source type from which media artifacts are saved. You must use ChimeMeeting. + // Source type from which media artifacts are saved. You must use ChimeMeeting . SourceType MediaPipelineSourceType // The status of the media pipeline. @@ -902,8 +882,8 @@ type MediaLiveConnectorPipeline struct { noSmithyDocumentSerde } -// A pipeline consisting of a media capture, media concatenation, or live-streaming -// pipeline. +// A pipeline consisting of a media capture, media concatenation, or +// live-streaming pipeline. type MediaPipeline struct { // A pipeline that enables users to capture audio and video. @@ -949,9 +929,8 @@ type PostCallAnalyticsSettings struct { // The ARN of the role used by Amazon Web Services Transcribe to upload your post // call analysis. For more information, see Post-call analytics with real-time - // transcriptions - // (https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html) in the - // Amazon Transcribe Developer Guide. + // transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html) + // in the Amazon Transcribe Developer Guide. // // This member is required. DataAccessRoleArn *string @@ -973,7 +952,7 @@ type PostCallAnalyticsSettings struct { // Defines the configuration for a presenter only video tile. type PresenterOnlyConfiguration struct { - // Defines the position of the presenter video tile. Default: TopRight. + // Defines the position of the presenter video tile. Default: TopRight . PresenterPosition PresenterPosition noSmithyDocumentSerde @@ -1081,7 +1060,7 @@ type SentimentConfiguration struct { // This member is required. RuleName *string - // The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL. + // The type of sentiment, POSITIVE , NEGATIVE , or NEUTRAL . // // This member is required. SentimentType SentimentType @@ -1097,8 +1076,8 @@ type SentimentConfiguration struct { // The configuration settings for the SNS topic sink. type SnsTopicSinkConfiguration struct { - // The URL of the SNS sink, https://aws.amazon.com/kinesis/data-streams/ - // (https://aws.amazon.com/kinesis/data-streams/). + // The URL of the SNS sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/) + // . InsightsTarget *string noSmithyDocumentSerde @@ -1117,8 +1096,8 @@ type SourceConfiguration struct { // The URL of the SQS sink. type SqsQueueSinkConfiguration struct { - // The URL of the SQS sink, https://aws.amazon.com/kinesis/data-streams/ - // (https://aws.amazon.com/kinesis/data-streams/). + // The URL of the SQS sink, https://aws.amazon.com/kinesis/data-streams/ (https://aws.amazon.com/kinesis/data-streams/) + // . InsightsTarget *string noSmithyDocumentSerde diff --git a/service/chimesdkmeetings/api_client.go b/service/chimesdkmeetings/api_client.go index 693bc0e63f6..6caa72add4c 100644 --- a/service/chimesdkmeetings/api_client.go +++ b/service/chimesdkmeetings/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chimesdkmeetings/api_op_BatchCreateAttendee.go b/service/chimesdkmeetings/api_op_BatchCreateAttendee.go index 8be6f16beed..c5320c244d6 100644 --- a/service/chimesdkmeetings/api_op_BatchCreateAttendee.go +++ b/service/chimesdkmeetings/api_op_BatchCreateAttendee.go @@ -12,9 +12,8 @@ import ( ) // Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) BatchCreateAttendee(ctx context.Context, params *BatchCreateAttendeeInput, optFns ...func(*Options)) (*BatchCreateAttendeeOutput, error) { if params == nil { params = &BatchCreateAttendeeInput{} diff --git a/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go b/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go index a687764df71..c960aa161dc 100644 --- a/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go +++ b/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go @@ -16,22 +16,18 @@ import ( // control what the capabilities can do, such as SendReceive data. For more // information about those values, see . When using capabilities, be aware of these // corner cases: -// -// * You can't set content capabilities to SendReceive or Receive -// unless you also set video capabilities to SendReceive or Receive. If you don't -// set the video capability to receive, the response will contain an HTTP 400 Bad -// Request status code. However, you can set your video capability to receive and -// you set your content capability to not receive. -// -// * When you change an audio -// capability from None or Receive to Send or SendReceive , and if the attendee -// left their microphone unmuted, audio will flow from the attendee to the other -// meeting participants. -// -// * When you change a video or content capability from None -// or Receive to Send or SendReceive , and if the attendee turned on their video or -// content streams, remote attendess can receive those streams, but only after -// media renegotiation between the client and the Amazon Chime back-end server. +// - You can't set content capabilities to SendReceive or Receive unless you also +// set video capabilities to SendReceive or Receive . If you don't set the video +// capability to receive, the response will contain an HTTP 400 Bad Request status +// code. However, you can set your video capability to receive and you set your +// content capability to not receive. +// - When you change an audio capability from None or Receive to Send or +// SendReceive , and if the attendee left their microphone unmuted, audio will +// flow from the attendee to the other meeting participants. +// - When you change a video or content capability from None or Receive to Send +// or SendReceive , and if the attendee turned on their video or content streams, +// remote attendess can receive those streams, but only after media renegotiation +// between the client and the Amazon Chime back-end server. func (c *Client) BatchUpdateAttendeeCapabilitiesExcept(ctx context.Context, params *BatchUpdateAttendeeCapabilitiesExceptInput, optFns ...func(*Options)) (*BatchUpdateAttendeeCapabilitiesExceptOutput, error) { if params == nil { params = &BatchUpdateAttendeeCapabilitiesExceptInput{} @@ -49,7 +45,7 @@ func (c *Client) BatchUpdateAttendeeCapabilitiesExcept(ctx context.Context, para type BatchUpdateAttendeeCapabilitiesExceptInput struct { - // The capabilities (audio, video, or content) that you want to update. + // The capabilities ( audio , video , or content ) that you want to update. // // This member is required. Capabilities *types.AttendeeCapabilities diff --git a/service/chimesdkmeetings/api_op_CreateAttendee.go b/service/chimesdkmeetings/api_op_CreateAttendee.go index 713a370f275..718cba874d2 100644 --- a/service/chimesdkmeetings/api_op_CreateAttendee.go +++ b/service/chimesdkmeetings/api_op_CreateAttendee.go @@ -12,9 +12,8 @@ import ( ) // Creates a new attendee for an active Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) CreateAttendee(ctx context.Context, params *CreateAttendeeInput, optFns ...func(*Options)) (*CreateAttendeeOutput, error) { if params == nil { params = &CreateAttendeeInput{} @@ -45,28 +44,24 @@ type CreateAttendeeInput struct { // This member is required. MeetingId *string - // The capabilities (audio, video, or content) that you want to grant an attendee. - // If you don't specify capabilities, all users have send and receive capabilities - // on all media channels by default. You use the capabilities with a set of values - // that control what the capabilities can do, such as SendReceive data. For more - // information about those values, see . When using capabilities, be aware of these - // corner cases: - // - // * You can't set content capabilities to SendReceive or Receive - // unless you also set video capabilities to SendReceive or Receive. If you don't - // set the video capability to receive, the response will contain an HTTP 400 Bad - // Request status code. However, you can set your video capability to receive and - // you set your content capability to not receive. - // - // * When you change an audio - // capability from None or Receive to Send or SendReceive , and if the attendee - // left their microphone unmuted, audio will flow from the attendee to the other - // meeting participants. - // - // * When you change a video or content capability from None - // or Receive to Send or SendReceive , and if the attendee turned on their video or - // content streams, remote attendess can receive those streams, but only after - // media renegotiation between the client and the Amazon Chime back-end server. + // The capabilities ( audio , video , or content ) that you want to grant an + // attendee. If you don't specify capabilities, all users have send and receive + // capabilities on all media channels by default. You use the capabilities with a + // set of values that control what the capabilities can do, such as SendReceive + // data. For more information about those values, see . When using capabilities, be + // aware of these corner cases: + // - You can't set content capabilities to SendReceive or Receive unless you also + // set video capabilities to SendReceive or Receive . If you don't set the video + // capability to receive, the response will contain an HTTP 400 Bad Request status + // code. However, you can set your video capability to receive and you set your + // content capability to not receive. + // - When you change an audio capability from None or Receive to Send or + // SendReceive , and if the attendee left their microphone unmuted, audio will + // flow from the attendee to the other meeting participants. + // - When you change a video or content capability from None or Receive to Send + // or SendReceive , and if the attendee turned on their video or content streams, + // remote attendess can receive those streams, but only after media renegotiation + // between the client and the Amazon Chime back-end server. Capabilities *types.AttendeeCapabilities noSmithyDocumentSerde diff --git a/service/chimesdkmeetings/api_op_CreateMeeting.go b/service/chimesdkmeetings/api_op_CreateMeeting.go index 72cb1fe94e1..f5fe56f1c43 100644 --- a/service/chimesdkmeetings/api_op_CreateMeeting.go +++ b/service/chimesdkmeetings/api_op_CreateMeeting.go @@ -14,12 +14,10 @@ import ( // Creates a new Amazon Chime SDK meeting in the specified media Region with no // initial attendees. For more information about specifying media Regions, see -// Amazon Chime SDK Media Regions -// (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in -// the Amazon Chime Developer Guide. For more information about the Amazon Chime -// SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime Developer Guide. For more information about the Amazon Chime +// SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, optFns ...func(*Options)) (*CreateMeetingOutput, error) { if params == nil { params = &CreateMeetingInput{} @@ -50,11 +48,11 @@ type CreateMeetingInput struct { // This member is required. ExternalMeetingId *string - // The Region in which to create the meeting. Available values: af-south-1, - // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, - // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, - // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. Available - // values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. + // The Region in which to create the meeting. Available values: af-south-1 , + // ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , + // ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , + // eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . + // Available values in AWS GovCloud (US) Regions: us-gov-east-1 , us-gov-west-1 . // // This member is required. MediaRegion *string @@ -66,8 +64,8 @@ type CreateMeetingInput struct { // Reserved. MeetingHostId *string - // The configuration for resource targets to receive notifications when meeting and - // attendee events occur. + // The configuration for resource targets to receive notifications when meeting + // and attendee events occur. NotificationsConfiguration *types.NotificationsConfiguration // When specified, replicates the media from the primary meeting to the new @@ -75,42 +73,32 @@ type CreateMeetingInput struct { PrimaryMeetingId *string // Applies one or more tags to an Amazon Chime SDK meeting. Note the following: - // - // * - // Not all resources have tags. For a list of services with resources that support - // tagging using this operation, see Services that support the Resource Groups - // Tagging API - // (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html). - // If the resource doesn't yet support this operation, the resource's service might - // support tagging using its own API operations. For more information, refer to the - // documentation for that service. - // - // * Each resource can have up to 50 tags. For - // other limits, see Tag Naming and Usage Conventions - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) - // in the AWS General Reference. - // - // * You can only tag resources that are located in - // the specified AWS Region for the AWS account. - // - // * To add tags to a resource, you - // need the necessary permissions for the service that the resource belongs to as - // well as permissions for adding tags. For more information, see the documentation - // for each service. - // - // Do not store personally identifiable information (PII) or - // other confidential or sensitive information in tags. We use tags to provide you - // with billing and administration services. Tags are not intended to be used for - // private or sensitive data. Minimum permissions In addition to the - // tag:TagResources permission required by this operation, you must also have the - // tagging permission defined by the service that created the resource. For - // example, to tag a ChimeSDKMeetings instance using the TagResources operation, - // you must have both of the following permissions: - // tag:TagResourcesChimeSDKMeetings:CreateTags Some services might have specific - // requirements for tagging some resources. For example, to tag an Amazon S3 - // bucket, you must also have the s3:GetBucketTagging permission. If the expected - // minimum permissions don't work, check the documentation for that service's - // tagging APIs for more information. + // - Not all resources have tags. For a list of services with resources that + // support tagging using this operation, see Services that support the Resource + // Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html) + // . If the resource doesn't yet support this operation, the resource's service + // might support tagging using its own API operations. For more information, refer + // to the documentation for that service. + // - Each resource can have up to 50 tags. For other limits, see Tag Naming and + // Usage Conventions (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) + // in the AWS General Reference. + // - You can only tag resources that are located in the specified AWS Region for + // the AWS account. + // - To add tags to a resource, you need the necessary permissions for the + // service that the resource belongs to as well as permissions for adding tags. For + // more information, see the documentation for each service. + // Do not store personally identifiable information (PII) or other confidential or + // sensitive information in tags. We use tags to provide you with billing and + // administration services. Tags are not intended to be used for private or + // sensitive data. Minimum permissions In addition to the tag:TagResources + // permission required by this operation, you must also have the tagging permission + // defined by the service that created the resource. For example, to tag a + // ChimeSDKMeetings instance using the TagResources operation, you must have both + // of the following permissions: tag:TagResources ChimeSDKMeetings:CreateTags Some + // services might have specific requirements for tagging some resources. For + // example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging + // permission. If the expected minimum permissions don't work, check the + // documentation for that service's tagging APIs for more information. Tags []types.Tag // A consistent and opaque identifier, created and maintained by the builder to @@ -122,7 +110,7 @@ type CreateMeetingInput struct { type CreateMeetingOutput struct { - // The meeting information, including the meeting ID and MediaPlacement. + // The meeting information, including the meeting ID and MediaPlacement . Meeting *types.Meeting // Metadata pertaining to the operation's result. diff --git a/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go b/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go index 9445a692bd0..c1aa223f9f5 100644 --- a/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go +++ b/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go @@ -13,13 +13,11 @@ import ( ) // Creates a new Amazon Chime SDK meeting in the specified media Region, with -// attendees. For more information about specifying media Regions, see Amazon Chime -// SDK Media Regions -// (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) in -// the Amazon Chime Developer Guide. For more information about the Amazon Chime -// SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// attendees. For more information about specifying media Regions, see Amazon +// Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) +// in the Amazon Chime Developer Guide. For more information about the Amazon Chime +// SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateMeetingWithAttendeesInput, optFns ...func(*Options)) (*CreateMeetingWithAttendeesOutput, error) { if params == nil { params = &CreateMeetingWithAttendeesInput{} @@ -55,11 +53,11 @@ type CreateMeetingWithAttendeesInput struct { // This member is required. ExternalMeetingId *string - // The Region in which to create the meeting. Available values: af-south-1, - // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, - // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, - // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. Available - // values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. + // The Region in which to create the meeting. Available values: af-south-1 , + // ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , + // ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , + // eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . + // Available values in AWS GovCloud (US) Regions: us-gov-east-1 , us-gov-west-1 . // // This member is required. MediaRegion *string @@ -71,8 +69,8 @@ type CreateMeetingWithAttendeesInput struct { // Reserved. MeetingHostId *string - // The configuration for resource targets to receive notifications when meeting and - // attendee events occur. + // The configuration for resource targets to receive notifications when meeting + // and attendee events occur. NotificationsConfiguration *types.NotificationsConfiguration // When specified, replicates the media from the primary meeting to the new @@ -98,7 +96,7 @@ type CreateMeetingWithAttendeesOutput struct { // the attendees is returned, along with error codes and error messages. Errors []types.CreateAttendeeError - // The meeting information, including the meeting ID and MediaPlacement. + // The meeting information, including the meeting ID and MediaPlacement . Meeting *types.Meeting // Metadata pertaining to the operation's result. diff --git a/service/chimesdkmeetings/api_op_DeleteAttendee.go b/service/chimesdkmeetings/api_op_DeleteAttendee.go index b33bd0ae8cf..b8a82ce71ac 100644 --- a/service/chimesdkmeetings/api_op_DeleteAttendee.go +++ b/service/chimesdkmeetings/api_op_DeleteAttendee.go @@ -11,11 +11,10 @@ import ( ) // Deletes an attendee from the specified Amazon Chime SDK meeting and deletes -// their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK +// their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK // meeting is deleted. For more information about the Amazon Chime SDK, see Using -// the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) DeleteAttendee(ctx context.Context, params *DeleteAttendeeInput, optFns ...func(*Options)) (*DeleteAttendeeOutput, error) { if params == nil { params = &DeleteAttendeeInput{} diff --git a/service/chimesdkmeetings/api_op_GetMeeting.go b/service/chimesdkmeetings/api_op_GetMeeting.go index 0cd82ebf850..a1ca23cfed7 100644 --- a/service/chimesdkmeetings/api_op_GetMeeting.go +++ b/service/chimesdkmeetings/api_op_GetMeeting.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// Gets the Amazon Chime SDK meeting details for the specified meeting ID. For +// more information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) GetMeeting(ctx context.Context, params *GetMeetingInput, optFns ...func(*Options)) (*GetMeetingOutput, error) { if params == nil { params = &GetMeetingInput{} diff --git a/service/chimesdkmeetings/api_op_ListAttendees.go b/service/chimesdkmeetings/api_op_ListAttendees.go index f222360bbbe..ad1834ba228 100644 --- a/service/chimesdkmeetings/api_op_ListAttendees.go +++ b/service/chimesdkmeetings/api_op_ListAttendees.go @@ -13,9 +13,8 @@ import ( ) // Lists the attendees for the specified Amazon Chime SDK meeting. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK -// (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. func (c *Client) ListAttendees(ctx context.Context, params *ListAttendeesInput, optFns ...func(*Options)) (*ListAttendeesOutput, error) { if params == nil { params = &ListAttendeesInput{} diff --git a/service/chimesdkmeetings/api_op_StartMeetingTranscription.go b/service/chimesdkmeetings/api_op_StartMeetingTranscription.go index e0de3dd9623..899aabc30bb 100644 --- a/service/chimesdkmeetings/api_op_StartMeetingTranscription.go +++ b/service/chimesdkmeetings/api_op_StartMeetingTranscription.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts transcription for the specified meetingId. For more information, refer to -// Using Amazon Chime SDK live transcription -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) in -// the Amazon Chime SDK Developer Guide. Amazon Chime SDK live transcription is +// Starts transcription for the specified meetingId . For more information, refer +// to Using Amazon Chime SDK live transcription (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) +// in the Amazon Chime SDK Developer Guide. Amazon Chime SDK live transcription is // powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS -// Service Terms (https://aws.amazon.com/service-terms/), including the terms +// Service Terms (https://aws.amazon.com/service-terms/) , including the terms // specific to the AWS Machine Learning and Artificial Intelligence Services. func (c *Client) StartMeetingTranscription(ctx context.Context, params *StartMeetingTranscriptionInput, optFns ...func(*Options)) (*StartMeetingTranscriptionOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type StartMeetingTranscriptionInput struct { MeetingId *string // The configuration for the current transcription operation. Must contain - // EngineTranscribeSettings or EngineTranscribeMedicalSettings. + // EngineTranscribeSettings or EngineTranscribeMedicalSettings . // // This member is required. TranscriptionConfiguration *types.TranscriptionConfiguration diff --git a/service/chimesdkmeetings/api_op_StopMeetingTranscription.go b/service/chimesdkmeetings/api_op_StopMeetingTranscription.go index 11d97704487..6016e66aa7d 100644 --- a/service/chimesdkmeetings/api_op_StopMeetingTranscription.go +++ b/service/chimesdkmeetings/api_op_StopMeetingTranscription.go @@ -10,12 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops transcription for the specified meetingId. For more information, refer to -// Using Amazon Chime SDK live transcription -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) in -// the Amazon Chime SDK Developer Guide. Amazon Chime SDK live transcription is +// Stops transcription for the specified meetingId . For more information, refer to +// Using Amazon Chime SDK live transcription (https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html) +// in the Amazon Chime SDK Developer Guide. Amazon Chime SDK live transcription is // powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS -// Service Terms (https://aws.amazon.com/service-terms/), including the terms +// Service Terms (https://aws.amazon.com/service-terms/) , including the terms // specific to the AWS Machine Learning and Artificial Intelligence Services. func (c *Client) StopMeetingTranscription(ctx context.Context, params *StopMeetingTranscriptionInput, optFns ...func(*Options)) (*StopMeetingTranscriptionOutput, error) { if params == nil { diff --git a/service/chimesdkmeetings/api_op_UntagResource.go b/service/chimesdkmeetings/api_op_UntagResource.go index 5fc52b63fdd..e85b0ce1266 100644 --- a/service/chimesdkmeetings/api_op_UntagResource.go +++ b/service/chimesdkmeetings/api_op_UntagResource.go @@ -14,21 +14,18 @@ import ( // key, the action removes both that key and its associated value. The operation // succeeds even if you attempt to remove tags from a resource that were already // removed. Note the following: +// - To remove tags from a resource, you need the necessary permissions for the +// service that the resource belongs to as well as permissions for removing tags. +// For more information, see the documentation for the service whose resource you +// want to untag. +// - You can only tag resources that are located in the specified AWS Region for +// the calling AWS account. // -// * To remove tags from a resource, you need the -// necessary permissions for the service that the resource belongs to as well as -// permissions for removing tags. For more information, see the documentation for -// the service whose resource you want to untag. -// -// * You can only tag resources that -// are located in the specified AWS Region for the calling AWS account. -// -// Minimum -// permissions In addition to the tag:UntagResources permission required by this -// operation, you must also have the remove tags permission defined by the service -// that created the resource. For example, to remove the tags from an Amazon EC2 -// instance using the UntagResources operation, you must have both of the following -// permissions: tag:UntagResource +// Minimum permissions In addition to the tag:UntagResources permission required +// by this operation, you must also have the remove tags permission defined by the +// service that created the resource. For example, to remove the tags from an +// Amazon EC2 instance using the UntagResources operation, you must have both of +// the following permissions: tag:UntagResource // // ChimeSDKMeetings:DeleteTags func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { diff --git a/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go b/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go index dde3420098a..cc848afc93c 100644 --- a/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go +++ b/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go @@ -15,22 +15,18 @@ import ( // values that control what the capabilities can do, such as SendReceive data. For // more information about those values, see . When using capabilities, be aware of // these corner cases: -// -// * You can't set content capabilities to SendReceive or -// Receive unless you also set video capabilities to SendReceive or Receive. If you -// don't set the video capability to receive, the response will contain an HTTP 400 -// Bad Request status code. However, you can set your video capability to receive -// and you set your content capability to not receive. -// -// * When you change an audio -// capability from None or Receive to Send or SendReceive , and if the attendee -// left their microphone unmuted, audio will flow from the attendee to the other -// meeting participants. -// -// * When you change a video or content capability from None -// or Receive to Send or SendReceive , and if the attendee turned on their video or -// content streams, remote attendess can receive those streams, but only after -// media renegotiation between the client and the Amazon Chime back-end server. +// - You can't set content capabilities to SendReceive or Receive unless you also +// set video capabilities to SendReceive or Receive . If you don't set the video +// capability to receive, the response will contain an HTTP 400 Bad Request status +// code. However, you can set your video capability to receive and you set your +// content capability to not receive. +// - When you change an audio capability from None or Receive to Send or +// SendReceive , and if the attendee left their microphone unmuted, audio will +// flow from the attendee to the other meeting participants. +// - When you change a video or content capability from None or Receive to Send +// or SendReceive , and if the attendee turned on their video or content streams, +// remote attendess can receive those streams, but only after media renegotiation +// between the client and the Amazon Chime back-end server. func (c *Client) UpdateAttendeeCapabilities(ctx context.Context, params *UpdateAttendeeCapabilitiesInput, optFns ...func(*Options)) (*UpdateAttendeeCapabilitiesOutput, error) { if params == nil { params = &UpdateAttendeeCapabilitiesInput{} diff --git a/service/chimesdkmeetings/doc.go b/service/chimesdkmeetings/doc.go index d0239a2d169..8f461a5e55d 100644 --- a/service/chimesdkmeetings/doc.go +++ b/service/chimesdkmeetings/doc.go @@ -6,6 +6,6 @@ // The Amazon Chime SDK meetings APIs in this section allow software developers to // create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and // manage users, and send and receive meeting notifications. For more information -// about the meeting APIs, see Amazon Chime SDK meetings -// (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html). +// about the meeting APIs, see Amazon Chime SDK meetings (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html) +// . package chimesdkmeetings diff --git a/service/chimesdkmeetings/types/enums.go b/service/chimesdkmeetings/types/enums.go index 4967f9e41bd..186ca53fbae 100644 --- a/service/chimesdkmeetings/types/enums.go +++ b/service/chimesdkmeetings/types/enums.go @@ -210,8 +210,8 @@ const ( TranscribeMedicalTypeDictation TranscribeMedicalType = "DICTATION" ) -// Values returns all known values for TranscribeMedicalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TranscribeMedicalType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalType) Values() []TranscribeMedicalType { return []TranscribeMedicalType{ @@ -229,8 +229,8 @@ const ( TranscribePartialResultsStabilityHigh TranscribePartialResultsStability = "high" ) -// Values returns all known values for TranscribePartialResultsStability. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for TranscribePartialResultsStability. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability { diff --git a/service/chimesdkmeetings/types/types.go b/service/chimesdkmeetings/types/types.go index c2564110473..97340f2f666 100644 --- a/service/chimesdkmeetings/types/types.go +++ b/service/chimesdkmeetings/types/types.go @@ -6,13 +6,13 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and -// JoinToken. The JoinToken allows a client to authenticate and join as the -// specified attendee. The JoinToken expires when the meeting ends, or when -// DeleteAttendee is called. After that, the attendee is unable to join the -// meeting. We recommend securely transferring each JoinToken from your server -// application to the client so that no other client has access to the token except -// for the one authorized to represent the attendee. +// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken +// . The JoinToken allows a client to authenticate and join as the specified +// attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee +// is called. After that, the attendee is unable to join the meeting. We recommend +// securely transferring each JoinToken from your server application to the client +// so that no other client has access to the token except for the one authorized to +// represent the attendee. type Attendee struct { // The Amazon Chime SDK attendee ID. @@ -22,23 +22,18 @@ type Attendee struct { // capabilities with a set of values that control what the capabilities can do, // such as SendReceive data. For more information about those values, see . When // using capabilities, be aware of these corner cases: - // - // * You can't set content - // capabilities to SendReceive or Receive unless you also set video capabilities to - // SendReceive or Receive. If you don't set the video capability to receive, the - // response will contain an HTTP 400 Bad Request status code. However, you can set - // your video capability to receive and you set your content capability to not - // receive. - // - // * When you change an audio capability from None or Receive to Send or - // SendReceive , and if the attendee left their microphone unmuted, audio will flow - // from the attendee to the other meeting participants. - // - // * When you change a video - // or content capability from None or Receive to Send or SendReceive , and if the - // attendee turned on their video or content streams, remote attendess can receive - // those streams, but only after media renegotiation between the client and the - // Amazon Chime back-end server. + // - You can't set content capabilities to SendReceive or Receive unless you also + // set video capabilities to SendReceive or Receive . If you don't set the video + // capability to receive, the response will contain an HTTP 400 Bad Request status + // code. However, you can set your video capability to receive and you set your + // content capability to not receive. + // - When you change an audio capability from None or Receive to Send or + // SendReceive , and if the attendee left their microphone unmuted, audio will + // flow from the attendee to the other meeting participants. + // - When you change a video or content capability from None or Receive to Send + // or SendReceive , and if the attendee turned on their video or content streams, + // remote attendess can receive those streams, but only after media renegotiation + // between the client and the Amazon Chime back-end server. Capabilities *AttendeeCapabilities // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee @@ -57,23 +52,18 @@ type Attendee struct { // capabilities with a set of values that control what the capabilities can do, // such as SendReceive data. For more information about those values, see . When // using capabilities, be aware of these corner cases: -// -// * You can't set content -// capabilities to SendReceive or Receive unless you also set video capabilities to -// SendReceive or Receive. If you don't set the video capability to receive, the -// response will contain an HTTP 400 Bad Request status code. However, you can set -// your video capability to receive and you set your content capability to not -// receive. -// -// * When you change an audio capability from None or Receive to Send or -// SendReceive , and if the attendee left their microphone unmuted, audio will flow -// from the attendee to the other meeting participants. -// -// * When you change a video -// or content capability from None or Receive to Send or SendReceive , and if the -// attendee turned on their video or content streams, remote attendess can receive -// those streams, but only after media renegotiation between the client and the -// Amazon Chime back-end server. +// - You can't set content capabilities to SendReceive or Receive unless you also +// set video capabilities to SendReceive or Receive . If you don't set the video +// capability to receive, the response will contain an HTTP 400 Bad Request status +// code. However, you can set your video capability to receive and you set your +// content capability to not receive. +// - When you change an audio capability from None or Receive to Send or +// SendReceive , and if the attendee left their microphone unmuted, audio will +// flow from the attendee to the other meeting participants. +// - When you change a video or content capability from None or Receive to Send +// or SendReceive , and if the attendee turned on their video or content streams, +// remote attendess can receive those streams, but only after media renegotiation +// between the client and the Amazon Chime back-end server. type AttendeeCapabilities struct { // The audio capability assigned to an attendee. @@ -196,7 +186,7 @@ type EngineTranscribeSettings struct { // transcription output. Content redaction is performed only upon complete // transcription of the audio segments. You can’t set ContentRedactionType and // ContentIdentificationType in the same request. If you set both, your request - // returns a BadRequestException. + // returns a BadRequestException . ContentRedactionType TranscribeContentRedactionType // Generates partial transcription results that are less likely to change as @@ -223,11 +213,11 @@ type EngineTranscribeSettings struct { PartialResultsStability TranscribePartialResultsStability // Lists the PII entity types you want to identify or redact. To specify entity - // types, you must enable ContentIdentificationType or ContentRedactionType. + // types, you must enable ContentIdentificationType or ContentRedactionType . // PIIEntityTypes must be comma-separated. The available values are: - // BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, - // CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. - // PiiEntityTypes is an optional parameter with a default value of ALL. + // BANK_ACCOUNT_NUMBER , BANK_ROUTING, CREDIT_DEBIT_NUMBER , CREDIT_DEBIT_CVV , + // CREDIT_DEBIT_EXPIRY , PIN , EMAIL , ADDRESS , NAME , PHONE , SSN , and ALL . + // PiiEntityTypes is an optional parameter with a default value of ALL . PiiEntityTypes *string // Language code for the preferred language. @@ -291,11 +281,11 @@ type Meeting struct { // The media placement for the meeting. MediaPlacement *MediaPlacement - // The Region in which you create the meeting. Available values: af-south-1, - // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, - // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, - // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. Available - // values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1. + // The Region in which you create the meeting. Available values: af-south-1 , + // ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , + // ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , + // eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . + // Available values in AWS GovCloud (US) Regions: us-gov-east-1 , us-gov-west-1 . MediaRegion *string // The ARN of the meeting. @@ -328,8 +318,8 @@ type MeetingFeaturesConfiguration struct { noSmithyDocumentSerde } -// The configuration for resource targets to receive notifications when meeting and -// attendee events occur. +// The configuration for resource targets to receive notifications when meeting +// and attendee events occur. type NotificationsConfiguration struct { // The ARN of the AWS Lambda function in the notifications configuration. @@ -361,7 +351,7 @@ type Tag struct { } // The configuration for the current transcription operation. Must contain -// EngineTranscribeSettings or EngineTranscribeMedicalSettings. +// EngineTranscribeSettings or EngineTranscribeMedicalSettings . type TranscriptionConfiguration struct { // The transcription configuration settings passed to Amazon Transcribe Medical. diff --git a/service/chimesdkmessaging/api_client.go b/service/chimesdkmessaging/api_client.go index f54182817b5..901092036b5 100644 --- a/service/chimesdkmessaging/api_client.go +++ b/service/chimesdkmessaging/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go b/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go index adcc0eaf461..5cbb12446dd 100644 --- a/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go +++ b/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go @@ -49,9 +49,9 @@ type BatchCreateChannelMembershipInput struct { // in a SubChannel for a moderator in an elastic channel. SubChannelId *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are always - // returned as part of ListChannelMemberships. Hidden members are only returned if - // the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden + // The membership type of a user, DEFAULT or HIDDEN . Default members are always + // returned as part of ListChannelMemberships . Hidden members are only returned if + // the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden // members are not returned. This is only supported by moderators. Type types.ChannelMembershipType @@ -63,8 +63,8 @@ type BatchCreateChannelMembershipOutput struct { // The list of channel memberships in the response. BatchChannelMemberships *types.BatchChannelMemberships - // If the action fails for one or more of the memberships in the request, a list of - // the memberships is returned, along with error codes and error messages. + // If the action fails for one or more of the memberships in the request, a list + // of the memberships is returned, along with error codes and error messages. Errors []types.BatchCreateChannelMembershipError // Metadata pertaining to the operation's result. diff --git a/service/chimesdkmessaging/api_op_ChannelFlowCallback.go b/service/chimesdkmessaging/api_op_ChannelFlowCallback.go index 53dbb23dfe1..c3b96106209 100644 --- a/service/chimesdkmessaging/api_op_ChannelFlowCallback.go +++ b/service/chimesdkmessaging/api_op_ChannelFlowCallback.go @@ -15,13 +15,9 @@ import ( // Calls back Chime SDK Messaging with a processing response message. This should // be invoked from the processor Lambda. This is a developer API. You can return // one of the following processing responses: -// -// * Update message content or -// metadata -// -// * Deny a message -// -// * Make no changes to the message +// - Update message content or metadata +// - Deny a message +// - Make no changes to the message func (c *Client) ChannelFlowCallback(ctx context.Context, params *ChannelFlowCallbackInput, optFns ...func(*Options)) (*ChannelFlowCallbackOutput, error) { if params == nil { params = &ChannelFlowCallbackInput{} @@ -55,7 +51,7 @@ type ChannelFlowCallbackInput struct { // This member is required. ChannelMessage *types.ChannelMessageCallback - // When a processor determines that a message needs to be DENIED, pass this + // When a processor determines that a message needs to be DENIED , pass this // parameter with a value of true. DeleteResource bool diff --git a/service/chimesdkmessaging/api_op_CreateChannel.go b/service/chimesdkmessaging/api_op_CreateChannel.go index 586cb41bc56..ffab16503bd 100644 --- a/service/chimesdkmessaging/api_op_CreateChannel.go +++ b/service/chimesdkmessaging/api_op_CreateChannel.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a channel to which you can add users and send messages. Restriction: You -// can't change a channel's privacy. The x-amz-chime-bearer request header is +// Creates a channel to which you can add users and send messages. Restriction: +// You can't change a channel's privacy. The x-amz-chime-bearer request header is // mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the // API call as the value in the header. func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error) { @@ -70,7 +70,7 @@ type CreateChannelInput struct { // The metadata of the creation request. Limited to 1KB and UTF-8. Metadata *string - // The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and + // The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and // channel members can add themselves and other members to unrestricted channels. // Only administrators and moderators can add members to restricted channels. Mode types.ChannelMode @@ -78,9 +78,9 @@ type CreateChannelInput struct { // The ARNs of the channel moderators in the request. ModeratorArns []string - // The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't + // The channel's privacy level: PUBLIC or PRIVATE . Private channels aren't // discoverable by users outside the channel. Public channels are discoverable by - // anyone in the AppInstance. + // anyone in the AppInstance . Privacy types.ChannelPrivacy // The tags for the creation request. diff --git a/service/chimesdkmessaging/api_op_CreateChannelBan.go b/service/chimesdkmessaging/api_op_CreateChannelBan.go index db18d3f4703..794e9cf9ff9 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelBan.go +++ b/service/chimesdkmessaging/api_op_CreateChannelBan.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently bans a member from a channel. Moderators can't add banned members to -// a channel. To undo a ban, you first have to DeleteChannelBan, and then -// CreateChannelMembership. Bans are cleaned up when you delete users or channels. +// Permanently bans a member from a channel. Moderators can't add banned members +// to a channel. To undo a ban, you first have to DeleteChannelBan , and then +// CreateChannelMembership . Bans are cleaned up when you delete users or channels. // If you ban a user who is already part of a channel, that user is automatically -// kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use -// the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the -// value in the header. +// kicked from the channel. The x-amz-chime-bearer request header is mandatory. +// Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as +// the value in the header. func (c *Client) CreateChannelBan(ctx context.Context, params *CreateChannelBanInput, optFns ...func(*Options)) (*CreateChannelBanOutput, error) { if params == nil { params = &CreateChannelBanInput{} diff --git a/service/chimesdkmessaging/api_op_CreateChannelFlow.go b/service/chimesdkmessaging/api_op_CreateChannelFlow.go index 0639cbf7920..ead50405f08 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelFlow.go +++ b/service/chimesdkmessaging/api_op_CreateChannelFlow.go @@ -16,19 +16,12 @@ import ( // profanity. You can associate channel flows with channels, and the processors in // the channel flow then take action on all messages sent to that channel. This is // a developer API. Channel flows process the following items: +// - New and updated messages +// - Persistent and non-persistent messages +// - The Standard message type // -// * New and updated -// messages -// -// * Persistent and non-persistent messages -// -// * The Standard message -// type -// -// Channel flows don't process Control or System messages. For more -// information about the message types provided by Chime SDK Messaging, refer to -// Message types -// (https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types) +// Channel flows don't process Control or System messages. For more information +// about the message types provided by Chime SDK Messaging, refer to Message types (https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types) // in the Amazon Chime developer guide. func (c *Client) CreateChannelFlow(ctx context.Context, params *CreateChannelFlowInput, optFns ...func(*Options)) (*CreateChannelFlowOutput, error) { if params == nil { diff --git a/service/chimesdkmessaging/api_op_CreateChannelMembership.go b/service/chimesdkmessaging/api_op_CreateChannelMembership.go index f9aeec3835f..1335acab488 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelMembership.go +++ b/service/chimesdkmessaging/api_op_CreateChannelMembership.go @@ -13,30 +13,19 @@ import ( // Adds a member to a channel. The InvitedBy field in ChannelMembership is derived // from the request header. A channel member can: -// -// * List messages -// -// * Send -// messages -// -// * Receive messages -// -// * Edit their own messages -// -// * Leave the -// channel +// - List messages +// - Send messages +// - Receive messages +// - Edit their own messages +// - Leave the channel // // Privacy settings impact this action as follows: +// - Public Channels: You do not need to be a member to list messages, but you +// must be a member to send messages. +// - Private Channels: You must be a member to list or send messages. // -// * Public Channels: You -// do not need to be a member to list messages, but you must be a member to send -// messages. -// -// * Private Channels: You must be a member to list or send -// messages. -// -// The x-amz-chime-bearer request header is mandatory. Use the ARN of -// the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in +// The x-amz-chime-bearer request header is mandatory. Use the ARN of the +// AppInstanceUserArn or AppInstanceBot that makes the API call as the value in // the header. func (c *Client) CreateChannelMembership(ctx context.Context, params *CreateChannelMembershipInput, optFns ...func(*Options)) (*CreateChannelMembershipOutput, error) { if params == nil { @@ -70,9 +59,9 @@ type CreateChannelMembershipInput struct { // This member is required. MemberArn *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are always - // returned as part of ListChannelMemberships. Hidden members are only returned if - // the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden + // The membership type of a user, DEFAULT or HIDDEN . Default members are always + // returned as part of ListChannelMemberships . Hidden members are only returned if + // the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden // members are not returned. This is only supported by moderators. // // This member is required. diff --git a/service/chimesdkmessaging/api_op_CreateChannelModerator.go b/service/chimesdkmessaging/api_op_CreateChannelModerator.go index 222f6c59410..134a61059d0 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelModerator.go +++ b/service/chimesdkmessaging/api_op_CreateChannelModerator.go @@ -11,24 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new ChannelModerator. A channel moderator can: +// Creates a new ChannelModerator . A channel moderator can: +// - Add and remove other members of the channel. +// - Add and remove other moderators of the channel. +// - Add and remove user bans for the channel. +// - Redact messages in the channel. +// - List messages in the channel. // -// * Add and remove other -// members of the channel. -// -// * Add and remove other moderators of the channel. -// -// * -// Add and remove user bans for the channel. -// -// * Redact messages in the channel. -// -// * -// List messages in the channel. -// -// The x-amz-chime-bearer request header is -// mandatory. Use the ARN of the AppInstanceUser or AppInstanceBotof the user that -// makes the API call as the value in the header. +// The x-amz-chime-bearer request header is mandatory. Use the ARN of the +// AppInstanceUser or AppInstanceBot of the user that makes the API call as the +// value in the header. func (c *Client) CreateChannelModerator(ctx context.Context, params *CreateChannelModeratorInput, optFns ...func(*Options)) (*CreateChannelModeratorOutput, error) { if params == nil { params = &CreateChannelModeratorInput{} diff --git a/service/chimesdkmessaging/api_op_DeleteChannel.go b/service/chimesdkmessaging/api_op_DeleteChannel.go index 43ad23d364f..86083948c35 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannel.go +++ b/service/chimesdkmessaging/api_op_DeleteChannel.go @@ -11,9 +11,9 @@ import ( ) // Immediately makes a channel and its memberships inaccessible and marks them for -// deletion. This is an irreversible process. The x-amz-chime-bearer request header -// is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot that makes -// the API call as the value in the header. +// deletion. This is an irreversible process. The x-amz-chime-bearer request +// header is mandatory. Use the ARN of the AppInstanceUserArn or AppInstanceBot +// that makes the API call as the value in the header. func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error) { if params == nil { params = &DeleteChannelInput{} diff --git a/service/chimesdkmessaging/api_op_DeleteChannelMembership.go b/service/chimesdkmessaging/api_op_DeleteChannelMembership.go index 699a815a1ee..28de65227b4 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelMembership.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelMembership.go @@ -11,8 +11,8 @@ import ( ) // Removes a member from a channel. The x-amz-chime-bearer request header is -// mandatory. Use the AppInstanceUserArn of the user that makes the API call as the -// value in the header. +// mandatory. Use the AppInstanceUserArn of the user that makes the API call as +// the value in the header. func (c *Client) DeleteChannelMembership(ctx context.Context, params *DeleteChannelMembershipInput, optFns ...func(*Options)) (*DeleteChannelMembershipOutput, error) { if params == nil { params = &DeleteChannelMembershipInput{} diff --git a/service/chimesdkmessaging/api_op_DeleteChannelMessage.go b/service/chimesdkmessaging/api_op_DeleteChannelMessage.go index 058fd207ed6..fda2d26f3f1 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelMessage.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelMessage.go @@ -12,7 +12,7 @@ import ( // Deletes a channel message. Only admins can perform this action. Deletion makes // messages inaccessible immediately. A background process deletes any revisions -// created by UpdateChannelMessage. The x-amz-chime-bearer request header is +// created by UpdateChannelMessage . The x-amz-chime-bearer request header is // mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the // API call as the value in the header. func (c *Client) DeleteChannelMessage(ctx context.Context, params *DeleteChannelMessageInput, optFns ...func(*Options)) (*DeleteChannelMessageOutput, error) { @@ -47,8 +47,8 @@ type DeleteChannelMessageInput struct { // This member is required. MessageId *string - // The ID of the SubChannel in the request. Only required when deleting messages in - // a SubChannel that the user belongs to. + // The ID of the SubChannel in the request. Only required when deleting messages + // in a SubChannel that the user belongs to. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_DeleteChannelModerator.go b/service/chimesdkmessaging/api_op_DeleteChannelModerator.go index 9e96e5ffea6..cbb23d10046 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelModerator.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelModerator.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. -// Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as -// the value in the header. +// Deletes a channel moderator. The x-amz-chime-bearer request header is +// mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the +// API call as the value in the header. func (c *Client) DeleteChannelModerator(ctx context.Context, params *DeleteChannelModeratorInput, optFns ...func(*Options)) (*DeleteChannelModeratorOutput, error) { if params == nil { params = &DeleteChannelModeratorInput{} diff --git a/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go b/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go index 96fd19ff3f4..245416f2ea7 100644 --- a/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the streaming configurations for an AppInstance. For more information, -// see Streaming messaging data -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the -// Amazon Chime SDK Developer Guide. +// Deletes the streaming configurations for an AppInstance . For more information, +// see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) +// in the Amazon Chime SDK Developer Guide. func (c *Client) DeleteMessagingStreamingConfigurations(ctx context.Context, params *DeleteMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*DeleteMessagingStreamingConfigurationsOutput, error) { if params == nil { params = &DeleteMessagingStreamingConfigurationsInput{} diff --git a/service/chimesdkmessaging/api_op_DescribeChannel.go b/service/chimesdkmessaging/api_op_DescribeChannel.go index 74921363599..1cf44fa081c 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannel.go +++ b/service/chimesdkmessaging/api_op_DescribeChannel.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel in an Amazon Chime AppInstance. The +// Returns the full details of a channel in an Amazon Chime AppInstance . The // x-amz-chime-bearer request header is mandatory. Use the ARN of the // AppInstanceUser or AppInstanceBot that makes the API call as the value in the // header. diff --git a/service/chimesdkmessaging/api_op_DescribeChannelBan.go b/service/chimesdkmessaging/api_op_DescribeChannelBan.go index f3b5cc9dd8e..c36e226a953 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelBan.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelBan.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel ban. The x-amz-chime-bearer request header -// is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes -// the API call as the value in the header. +// Returns the full details of a channel ban. The x-amz-chime-bearer request +// header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that +// makes the API call as the value in the header. func (c *Client) DescribeChannelBan(ctx context.Context, params *DescribeChannelBanInput, optFns ...func(*Options)) (*DescribeChannelBanOutput, error) { if params == nil { params = &DescribeChannelBanInput{} diff --git a/service/chimesdkmessaging/api_op_DescribeChannelFlow.go b/service/chimesdkmessaging/api_op_DescribeChannelFlow.go index 621fcd9a02d..c3eef03cea0 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelFlow.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelFlow.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a channel flow in an Amazon Chime AppInstance. This +// Returns the full details of a channel flow in an Amazon Chime AppInstance . This // is a developer API. func (c *Client) DescribeChannelFlow(ctx context.Context, params *DescribeChannelFlowInput, optFns ...func(*Options)) (*DescribeChannelFlowOutput, error) { if params == nil { diff --git a/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go b/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go index 5aba1e9835d..272cd224987 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go @@ -12,7 +12,7 @@ import ( ) // Returns the details of a channel based on the membership of the specified -// AppInstanceUser or AppInstanceBot. The x-amz-chime-bearer request header is +// AppInstanceUser or AppInstanceBot . The x-amz-chime-bearer request header is // mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the // API call as the value in the header. func (c *Client) DescribeChannelMembershipForAppInstanceUser(ctx context.Context, params *DescribeChannelMembershipForAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelMembershipForAppInstanceUserOutput, error) { diff --git a/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go b/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go index 996267aa44e..d642e7d9e9c 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go @@ -12,7 +12,7 @@ import ( ) // Returns the full details of a channel moderated by the specified AppInstanceUser -// or AppInstanceBot. The x-amz-chime-bearer request header is mandatory. Use the +// or AppInstanceBot . The x-amz-chime-bearer request header is mandatory. Use the // ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the // value in the header. func (c *Client) DescribeChannelModeratedByAppInstanceUser(ctx context.Context, params *DescribeChannelModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelModeratedByAppInstanceUserOutput, error) { diff --git a/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go b/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go index 878ac434d39..2d9f4e83fe7 100644 --- a/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go +++ b/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go @@ -11,23 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets message status for a specified messageId. Use this API to determine the +// Gets message status for a specified messageId . Use this API to determine the // intermediate status of messages going through channel flow processing. The API // provides an alternative to retrieving message status if the event was not // received because a client wasn't connected to a websocket. Messages can have any // one of these statuses. SENT Message processed successfully PENDING Ongoing // processing FAILED Processing failed DENIED Messasge denied by the processor -// -// * -// This API does not return statuses for denied messages, because we don't store -// them once the processor denies them. -// -// * Only the message sender can invoke this -// API. -// -// * The x-amz-chime-bearer request header is mandatory. Use the ARN of the -// AppInstanceUser or AppInstanceBot that makes the API call as the value in the -// header. +// - This API does not return statuses for denied messages, because we don't +// store them once the processor denies them. +// - Only the message sender can invoke this API. +// - The x-amz-chime-bearer request header is mandatory. Use the ARN of the +// AppInstanceUser or AppInstanceBot that makes the API call as the value in the +// header. func (c *Client) GetChannelMessageStatus(ctx context.Context, params *GetChannelMessageStatusInput, optFns ...func(*Options)) (*GetChannelMessageStatusOutput, error) { if params == nil { params = &GetChannelMessageStatusInput{} diff --git a/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go b/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go index 0cd254d610e..b52ca3a67c8 100644 --- a/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the data streaming configuration for an AppInstance. For more -// information, see Streaming messaging data -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the -// Amazon Chime SDK Developer Guide. +// Retrieves the data streaming configuration for an AppInstance . For more +// information, see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) +// in the Amazon Chime SDK Developer Guide. func (c *Client) GetMessagingStreamingConfigurations(ctx context.Context, params *GetMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*GetMessagingStreamingConfigurationsOutput, error) { if params == nil { params = &GetMessagingStreamingConfigurationsInput{} diff --git a/service/chimesdkmessaging/api_op_ListChannelFlows.go b/service/chimesdkmessaging/api_op_ListChannelFlows.go index 1cf7724809c..19da727cb83 100644 --- a/service/chimesdkmessaging/api_op_ListChannelFlows.go +++ b/service/chimesdkmessaging/api_op_ListChannelFlows.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a paginated lists of all the channel flows created under a single Chime. -// This is a developer API. +// Returns a paginated lists of all the channel flows created under a single +// Chime. This is a developer API. func (c *Client) ListChannelFlows(ctx context.Context, params *ListChannelFlowsInput, optFns ...func(*Options)) (*ListChannelFlowsOutput, error) { if params == nil { params = &ListChannelFlowsInput{} diff --git a/service/chimesdkmessaging/api_op_ListChannelMemberships.go b/service/chimesdkmessaging/api_op_ListChannelMemberships.go index 331d31880ab..52d348e352d 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMemberships.go +++ b/service/chimesdkmessaging/api_op_ListChannelMemberships.go @@ -16,8 +16,7 @@ import ( // header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that // makes the API call as the value in the header. If you want to list the channels // to which a specific app instance user belongs, see the -// ListChannelMembershipsForAppInstanceUser -// (https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html) +// ListChannelMembershipsForAppInstanceUser (https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html) // API. func (c *Client) ListChannelMemberships(ctx context.Context, params *ListChannelMembershipsInput, optFns ...func(*Options)) (*ListChannelMembershipsOutput, error) { if params == nil { @@ -57,9 +56,9 @@ type ListChannelMembershipsInput struct { // memberships in a particular sub-channel of an elastic channel. SubChannelId *string - // The membership type of a user, DEFAULT or HIDDEN. Default members are returned + // The membership type of a user, DEFAULT or HIDDEN . Default members are returned // as part of ListChannelMemberships if no type is specified. Hidden members are - // only returned if the type filter in ListChannelMemberships equals HIDDEN. + // only returned if the type filter in ListChannelMemberships equals HIDDEN . Type types.ChannelMembershipType noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go b/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go index 804b9dbe163..4f43f53f408 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. Only -// an AppInstanceAdmin can call the API with a user ARN that is not their own. The -// x-amz-chime-bearer request header is mandatory. Use the ARN of the +// Lists all channels that anr AppInstanceUser or AppInstanceBot is a part of. +// Only an AppInstanceAdmin can call the API with a user ARN that is not their +// own. The x-amz-chime-bearer request header is mandatory. Use the ARN of the // AppInstanceUser or AppInstanceBot that makes the API call as the value in the // header. func (c *Client) ListChannelMembershipsForAppInstanceUser(ctx context.Context, params *ListChannelMembershipsForAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error) { diff --git a/service/chimesdkmessaging/api_op_ListChannelMessages.go b/service/chimesdkmessaging/api_op_ListChannelMessages.go index afd7dd719ee..5b59e1bc20c 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMessages.go +++ b/service/chimesdkmessaging/api_op_ListChannelMessages.go @@ -13,13 +13,13 @@ import ( "time" ) -// List all the messages in a channel. Returns a paginated list of ChannelMessages. -// By default, sorted by creation timestamp in descending order. Redacted messages -// appear in the results as empty, since they are only redacted, not deleted. -// Deleted messages do not appear in the results. This action always returns the -// latest version of an edited message. Also, the x-amz-chime-bearer request header -// is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes -// the API call as the value in the header. +// List all the messages in a channel. Returns a paginated list of ChannelMessages +// . By default, sorted by creation timestamp in descending order. Redacted +// messages appear in the results as empty, since they are only redacted, not +// deleted. Deleted messages do not appear in the results. This action always +// returns the latest version of an edited message. Also, the x-amz-chime-bearer +// request header is mandatory. Use the ARN of the AppInstanceUser or +// AppInstanceBot that makes the API call as the value in the header. func (c *Client) ListChannelMessages(ctx context.Context, params *ListChannelMessagesInput, optFns ...func(*Options)) (*ListChannelMessagesOutput, error) { if params == nil { params = &ListChannelMessagesInput{} @@ -64,8 +64,8 @@ type ListChannelMessagesInput struct { // time created. SortOrder types.SortOrder - // The ID of the SubChannel in the request. Only required when listing the messages - // in a SubChannel that the user belongs to. + // The ID of the SubChannel in the request. Only required when listing the + // messages in a SubChannel that the user belongs to. SubChannelId *string noSmithyDocumentSerde @@ -155,8 +155,8 @@ func (c *Client) addOperationListChannelMessagesMiddlewares(stack *middleware.St return nil } -// ListChannelMessagesAPIClient is a client that implements the ListChannelMessages -// operation. +// ListChannelMessagesAPIClient is a client that implements the +// ListChannelMessages operation. type ListChannelMessagesAPIClient interface { ListChannelMessages(context.Context, *ListChannelMessagesInput, ...func(*Options)) (*ListChannelMessagesOutput, error) } diff --git a/service/chimesdkmessaging/api_op_ListChannelModerators.go b/service/chimesdkmessaging/api_op_ListChannelModerators.go index 3d9d0e4fba5..6829cf7b59b 100644 --- a/service/chimesdkmessaging/api_op_ListChannelModerators.go +++ b/service/chimesdkmessaging/api_op_ListChannelModerators.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the moderators for a channel. The x-amz-chime-bearer request header is -// mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the -// API call as the value in the header. +// Lists all the moderators for a channel. The x-amz-chime-bearer request header +// is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes +// the API call as the value in the header. func (c *Client) ListChannelModerators(ctx context.Context, params *ListChannelModeratorsInput, optFns ...func(*Options)) (*ListChannelModeratorsOutput, error) { if params == nil { params = &ListChannelModeratorsInput{} diff --git a/service/chimesdkmessaging/api_op_ListChannels.go b/service/chimesdkmessaging/api_op_ListChannels.go index 38ec76b82b6..ce3b9a9280f 100644 --- a/service/chimesdkmessaging/api_op_ListChannels.go +++ b/service/chimesdkmessaging/api_op_ListChannels.go @@ -12,15 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Channels created under a single Chime App as a paginated list. You can -// specify filters to narrow results. Functionality & restrictions -// -// * Use privacy = -// PUBLIC to retrieve all public channels in the account. -// -// * Only an -// AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an -// account. +// Lists all Channels created under a single Chime App as a paginated list. You +// can specify filters to narrow results. Functionality & restrictions +// - Use privacy = PUBLIC to retrieve all public channels in the account. +// - Only an AppInstanceAdmin can set privacy = PRIVATE to list the private +// channels in an account. // // The x-amz-chime-bearer request header is mandatory. Use the ARN of the // AppInstanceUser or AppInstanceBot that makes the API call as the value in the @@ -42,7 +38,7 @@ func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, op type ListChannelsInput struct { - // The ARN of the AppInstance. + // The ARN of the AppInstance . // // This member is required. AppInstanceArn *string @@ -59,8 +55,9 @@ type ListChannelsInput struct { // returned. NextToken *string - // The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves - // private channels. Only an AppInstanceAdmin can retrieve private channels. + // The privacy setting. PUBLIC retrieves all the public channels. PRIVATE + // retrieves private channels. Only an AppInstanceAdmin can retrieve private + // channels. Privacy types.ChannelPrivacy noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_ListChannelsAssociatedWithChannelFlow.go b/service/chimesdkmessaging/api_op_ListChannelsAssociatedWithChannelFlow.go index 3012cfd7547..a9dd82c4ddc 100644 --- a/service/chimesdkmessaging/api_op_ListChannelsAssociatedWithChannelFlow.go +++ b/service/chimesdkmessaging/api_op_ListChannelsAssociatedWithChannelFlow.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channels associated with a specified channel flow. You can associate a -// channel flow with multiple channels, but you can only associate a channel with +// Lists all channels associated with a specified channel flow. You can associate +// a channel flow with multiple channels, but you can only associate a channel with // one channel flow. This is a developer API. func (c *Client) ListChannelsAssociatedWithChannelFlow(ctx context.Context, params *ListChannelsAssociatedWithChannelFlowInput, optFns ...func(*Options)) (*ListChannelsAssociatedWithChannelFlowOutput, error) { if params == nil { diff --git a/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go b/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go index 83697990987..09a8417d208 100644 --- a/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer +// A list of the channels moderated by an AppInstanceUser . The x-amz-chime-bearer // request header is mandatory. Use the ARN of the AppInstanceUser or // AppInstanceBot that makes the API call as the value in the header. func (c *Client) ListChannelsModeratedByAppInstanceUser(ctx context.Context, params *ListChannelsModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error) { diff --git a/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go b/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go index 1efb7bc54ed..5ac7cfaffb2 100644 --- a/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go +++ b/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go @@ -12,18 +12,13 @@ import ( ) // Sets the number of days before the channel is automatically deleted. -// -// * A -// background process deletes expired channels within 6 hours of expiration. Actual -// deletion times may vary. -// -// * Expired channels that have not yet been deleted -// appear as active, and you can update their expiration settings. The system -// honors the new settings. -// -// * The x-amz-chime-bearer request header is mandatory. -// Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as -// the value in the header. +// - A background process deletes expired channels within 6 hours of expiration. +// Actual deletion times may vary. +// - Expired channels that have not yet been deleted appear as active, and you +// can update their expiration settings. The system honors the new settings. +// - The x-amz-chime-bearer request header is mandatory. Use the ARN of the +// AppInstanceUser or AppInstanceBot that makes the API call as the value in the +// header. func (c *Client) PutChannelExpirationSettings(ctx context.Context, params *PutChannelExpirationSettingsInput, optFns ...func(*Options)) (*PutChannelExpirationSettingsOutput, error) { if params == nil { params = &PutChannelExpirationSettingsInput{} diff --git a/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go b/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go index 38ad43a0077..72b9a9d47ff 100644 --- a/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the data streaming configuration for an AppInstance. For more information, -// see Streaming messaging data -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) in the -// Amazon Chime SDK Developer Guide. +// Sets the data streaming configuration for an AppInstance . For more information, +// see Streaming messaging data (https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html) +// in the Amazon Chime SDK Developer Guide. func (c *Client) PutMessagingStreamingConfigurations(ctx context.Context, params *PutMessagingStreamingConfigurationsInput, optFns ...func(*Options)) (*PutMessagingStreamingConfigurationsOutput, error) { if params == nil { params = &PutMessagingStreamingConfigurationsInput{} diff --git a/service/chimesdkmessaging/api_op_SendChannelMessage.go b/service/chimesdkmessaging/api_op_SendChannelMessage.go index 253336925a5..cc0f130f847 100644 --- a/service/chimesdkmessaging/api_op_SendChannelMessage.go +++ b/service/chimesdkmessaging/api_op_SendChannelMessage.go @@ -15,8 +15,8 @@ import ( // Sends a message to a particular channel that the member is a part of. The // x-amz-chime-bearer request header is mandatory. Use the ARN of the // AppInstanceUser or AppInstanceBot that makes the API call as the value in the -// header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. -// CONTROL messages can contain 30 bytes of data and no metadata. +// header. Also, STANDARD messages can contain 4KB of data and the 1KB of +// metadata. CONTROL messages can contain 30 bytes of data and no metadata. func (c *Client) SendChannelMessage(ctx context.Context, params *SendChannelMessageInput, optFns ...func(*Options)) (*SendChannelMessageOutput, error) { if params == nil { params = &SendChannelMessageInput{} @@ -60,7 +60,7 @@ type SendChannelMessageInput struct { // This member is required. Persistence types.ChannelMessagePersistenceType - // The type of message, STANDARD or CONTROL. + // The type of message, STANDARD or CONTROL . // // This member is required. Type types.ChannelMessageType @@ -69,7 +69,7 @@ type SendChannelMessageInput struct { ContentType *string // The attributes for the message, used for message filtering along with a - // FilterRule defined in the PushNotificationPreferences. + // FilterRule defined in the PushNotificationPreferences . MessageAttributes map[string]types.MessageAttributeValue // The optional metadata for each message. diff --git a/service/chimesdkmessaging/api_op_UpdateChannelMessage.go b/service/chimesdkmessaging/api_op_UpdateChannelMessage.go index 8dee4fbc311..20cae4f24c3 100644 --- a/service/chimesdkmessaging/api_op_UpdateChannelMessage.go +++ b/service/chimesdkmessaging/api_op_UpdateChannelMessage.go @@ -57,8 +57,8 @@ type UpdateChannelMessageInput struct { // The metadata of the message being updated. Metadata *string - // The ID of the SubChannel in the request. Only required when updating messages in - // a SubChannel that the user belongs to. + // The ID of the SubChannel in the request. Only required when updating messages + // in a SubChannel that the user belongs to. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/doc.go b/service/chimesdkmessaging/doc.go index 9d44d7bbba9..68d420c2471 100644 --- a/service/chimesdkmessaging/doc.go +++ b/service/chimesdkmessaging/doc.go @@ -3,9 +3,9 @@ // Package chimesdkmessaging provides the API client, operations, and parameter // types for Amazon Chime SDK Messaging. // -// The Amazon Chime SDK Messaging APIs in this section allow software developers to -// send and receive messages in custom messaging applications. These APIs depend on -// the frameworks provided by the Amazon Chime SDK Identity APIs. For more -// information about the messaging APIs, see Amazon Chime SDK messaging -// (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html). +// The Amazon Chime SDK Messaging APIs in this section allow software developers +// to send and receive messages in custom messaging applications. These APIs depend +// on the frameworks provided by the Amazon Chime SDK Identity APIs. For more +// information about the messaging APIs, see Amazon Chime SDK messaging (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html) +// . package chimesdkmessaging diff --git a/service/chimesdkmessaging/types/enums.go b/service/chimesdkmessaging/types/enums.go index ed04b910f39..8ec0490aa31 100644 --- a/service/chimesdkmessaging/types/enums.go +++ b/service/chimesdkmessaging/types/enums.go @@ -30,8 +30,8 @@ const ( ChannelMembershipTypeHidden ChannelMembershipType = "HIDDEN" ) -// Values returns all known values for ChannelMembershipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ChannelMembershipType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ChannelMembershipType) Values() []ChannelMembershipType { return []ChannelMembershipType{ @@ -156,9 +156,9 @@ const ( ErrorCodePhoneNumberAssociationsExist ErrorCode = "PhoneNumberAssociationsExist" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "BadRequest", @@ -309,9 +309,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/chimesdkmessaging/types/types.go b/service/chimesdkmessaging/types/types.go index 55b7061be93..efb432b745e 100644 --- a/service/chimesdkmessaging/types/types.go +++ b/service/chimesdkmessaging/types/types.go @@ -7,7 +7,7 @@ import ( "time" ) -// Summary of the membership details of an AppInstanceUser. +// Summary of the membership details of an AppInstanceUser . type AppInstanceUserMembershipSummary struct { // The time at which an AppInstanceUser last marked a channel as read. @@ -16,7 +16,7 @@ type AppInstanceUserMembershipSummary struct { // The ID of the SubChannel that the AppInstanceUser is a member of. SubChannelId *string - // The type of ChannelMembership. + // The type of ChannelMembership . Type ChannelMembershipType noSmithyDocumentSerde @@ -141,7 +141,7 @@ type ChannelBan struct { noSmithyDocumentSerde } -// Summary of the details of a ChannelBan. +// Summary of the details of a ChannelBan . type ChannelBanSummary struct { // The member being banned from a channel. @@ -213,19 +213,19 @@ type ChannelMembership struct { noSmithyDocumentSerde } -// Summary of the channel membership details of an AppInstanceUser. +// Summary of the channel membership details of an AppInstanceUser . type ChannelMembershipForAppInstanceUserSummary struct { - // Returns the channel membership data for an AppInstance. + // Returns the channel membership data for an AppInstance . AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary - // Returns the channel data for an AppInstance. + // Returns the channel data for an AppInstance . ChannelSummary *ChannelSummary noSmithyDocumentSerde } -// The channel membership preferences for an AppInstanceUser. +// The channel membership preferences for an AppInstanceUser . type ChannelMembershipPreferences struct { // The push notification configuration of a message. @@ -234,7 +234,7 @@ type ChannelMembershipPreferences struct { noSmithyDocumentSerde } -// Summary of the details of a ChannelMembership. +// Summary of the details of a ChannelMembership . type ChannelMembershipSummary struct { // A member's summary data. @@ -265,7 +265,7 @@ type ChannelMessage struct { LastUpdatedTimestamp *time.Time // The attributes for the message, used for message filtering along with a - // FilterRule defined in the PushNotificationPreferences. + // FilterRule defined in the PushNotificationPreferences . MessageAttributes map[string]MessageAttributeValue // The ID of a message. @@ -310,7 +310,7 @@ type ChannelMessageCallback struct { ContentType *string // The attributes for the message, used for message filtering along with a - // FilterRule defined in the PushNotificationPreferences. + // FilterRule defined in the PushNotificationPreferences . MessageAttributes map[string]MessageAttributeValue // The message metadata. @@ -337,7 +337,7 @@ type ChannelMessageStatusStructure struct { noSmithyDocumentSerde } -// Summary of the messages in a Channel. +// Summary of the messages in a Channel . type ChannelMessageSummary struct { // The content of the message. @@ -384,7 +384,7 @@ type ChannelMessageSummary struct { // Summary of the details of a moderated channel. type ChannelModeratedByAppInstanceUserSummary struct { - // Summary of the details of a Channel. + // Summary of the details of a Channel . ChannelSummary *ChannelSummary noSmithyDocumentSerde @@ -408,7 +408,7 @@ type ChannelModerator struct { noSmithyDocumentSerde } -// Summary of the details of a ChannelModerator. +// Summary of the details of a ChannelModerator . type ChannelModeratorSummary struct { // The data for a moderator. @@ -417,7 +417,7 @@ type ChannelModeratorSummary struct { noSmithyDocumentSerde } -// Summary of the details of a Channel. +// Summary of the details of a Channel . type ChannelSummary struct { // The ARN of the channel. @@ -543,13 +543,13 @@ type Processor struct { // This member is required. ExecutionOrder *int32 - // Determines whether to continue with message processing or stop it in cases where - // communication with a processor fails. If a processor has a fallback action of - // ABORT and communication with it fails, the processor sets the message status to - // FAILED and does not send the message to any recipients. Note that if the last - // processor in the channel flow sequence has a fallback action of CONTINUE and - // communication with the processor fails, then the message is considered processed - // and sent to recipients of the channel. + // Determines whether to continue with message processing or stop it in cases + // where communication with a processor fails. If a processor has a fallback action + // of ABORT and communication with it fails, the processor sets the message status + // to FAILED and does not send the message to any recipients. Note that if the + // last processor in the channel flow sequence has a fallback action of CONTINUE + // and communication with the processor fails, then the message is considered + // processed and sent to recipients of the channel. // // This member is required. FallbackAction FallbackAction @@ -583,7 +583,7 @@ type PushNotificationConfiguration struct { Title *string // Enum value that indicates the type of the push notification for a message. - // DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification. + // DEFAULT : Normal mobile push notification. VOIP : VOIP mobile push notification. Type PushNotificationType noSmithyDocumentSerde @@ -618,10 +618,10 @@ type SearchField struct { // This member is required. Key SearchFieldKey - // The operator used to compare field values, currently EQUALS or INCLUDES. Use the - // EQUALS operator to find channels whose memberships equal the specified values. - // Use the INCLUDES operator to find channels whose memberships include the - // specified values. + // The operator used to compare field values, currently EQUALS or INCLUDES . Use + // the EQUALS operator to find channels whose memberships equal the specified + // values. Use the INCLUDES operator to find channels whose memberships include + // the specified values. // // This member is required. Operator SearchFieldOperator diff --git a/service/chimesdkvoice/api_client.go b/service/chimesdkvoice/api_client.go index 2d5b9ab6ed5..bdac33b3ed7 100644 --- a/service/chimesdkvoice/api_client.go +++ b/service/chimesdkvoice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go b/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go index c66f8ddb67e..d98e237a0b7 100644 --- a/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go +++ b/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves phone numbers into the Deletion queue. Phone numbers must be disassociated -// from any users or Amazon Chime SDK Voice Connectors before they can be deleted. -// Phone numbers remain in the Deletion queue for 7 days before they are deleted -// permanently. +// Moves phone numbers into the Deletion queue. Phone numbers must be +// disassociated from any users or Amazon Chime SDK Voice Connectors before they +// can be deleted. Phone numbers remain in the Deletion queue for 7 days before +// they are deleted permanently. func (c *Client) BatchDeletePhoneNumber(ctx context.Context, params *BatchDeletePhoneNumberInput, optFns ...func(*Options)) (*BatchDeletePhoneNumberOutput, error) { if params == nil { params = &BatchDeletePhoneNumberInput{} diff --git a/service/chimesdkvoice/api_op_CreateSipMediaApplication.go b/service/chimesdkvoice/api_op_CreateSipMediaApplication.go index 95773bd8dbf..50e3bb5a582 100644 --- a/service/chimesdkvoice/api_op_CreateSipMediaApplication.go +++ b/service/chimesdkvoice/api_op_CreateSipMediaApplication.go @@ -12,8 +12,7 @@ import ( ) // Creates a SIP media application. For more information about SIP media -// applications, see Managing SIP media applications and rules -// (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) +// applications, see Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) // in the Amazon Chime SDK Administrator Guide. func (c *Client) CreateSipMediaApplication(ctx context.Context, params *CreateSipMediaApplicationInput, optFns ...func(*Options)) (*CreateSipMediaApplicationOutput, error) { if params == nil { diff --git a/service/chimesdkvoice/api_op_CreateSipMediaApplicationCall.go b/service/chimesdkvoice/api_op_CreateSipMediaApplicationCall.go index 59f782f9bd6..e1d7837217e 100644 --- a/service/chimesdkvoice/api_op_CreateSipMediaApplicationCall.go +++ b/service/chimesdkvoice/api_op_CreateSipMediaApplicationCall.go @@ -12,7 +12,7 @@ import ( ) // Creates an outbound call to a phone number from the phone number specified in -// the request, and it invokes the endpoint of the specified sipMediaApplicationId. +// the request, and it invokes the endpoint of the specified sipMediaApplicationId . func (c *Client) CreateSipMediaApplicationCall(ctx context.Context, params *CreateSipMediaApplicationCallInput, optFns ...func(*Options)) (*CreateSipMediaApplicationCallOutput, error) { if params == nil { params = &CreateSipMediaApplicationCallInput{} diff --git a/service/chimesdkvoice/api_op_CreateSipRule.go b/service/chimesdkvoice/api_op_CreateSipRule.go index 8168a074de9..b16d95b3756 100644 --- a/service/chimesdkvoice/api_op_CreateSipRule.go +++ b/service/chimesdkvoice/api_op_CreateSipRule.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a SIP rule, which can be used to run a SIP media application as a target -// for a specific trigger type. For more information about SIP rules, see Managing -// SIP media applications and rules -// (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) +// Creates a SIP rule, which can be used to run a SIP media application as a +// target for a specific trigger type. For more information about SIP rules, see +// Managing SIP media applications and rules (https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html) // in the Amazon Chime SDK Administrator Guide. func (c *Client) CreateSipRule(ctx context.Context, params *CreateSipRuleInput, optFns ...func(*Options)) (*CreateSipRuleOutput, error) { if params == nil { @@ -38,24 +37,24 @@ type CreateSipRuleInput struct { // This member is required. Name *string - // The type of trigger assigned to the SIP rule in TriggerValue, currently - // RequestUriHostname or ToPhoneNumber. + // The type of trigger assigned to the SIP rule in TriggerValue , currently + // RequestUriHostname or ToPhoneNumber . // // This member is required. TriggerType types.SipRuleTriggerType - // If TriggerType is RequestUriHostname, the value can be the outbound host name of - // a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a + // If TriggerType is RequestUriHostname , the value can be the outbound host name + // of a Voice Connector. If TriggerType is ToPhoneNumber , the value can be a // customer-owned phone number in the E164 format. The SipMediaApplication // specified in the SipRule is triggered if the request URI in an incoming SIP - // request matches the RequestUriHostname, or if the To header in the incoming SIP - // request matches the ToPhoneNumber value. + // request matches the RequestUriHostname , or if the To header in the incoming + // SIP request matches the ToPhoneNumber value. // // This member is required. TriggerValue *string - // Disables or enables a SIP rule. You must disable SIP rules before you can delete - // them. + // Disables or enables a SIP rule. You must disable SIP rules before you can + // delete them. Disabled *bool // List of SIP media applications, with priority and AWS Region. Only one SIP diff --git a/service/chimesdkvoice/api_op_CreateVoiceConnector.go b/service/chimesdkvoice/api_op_CreateVoiceConnector.go index 0039db687ed..bd8897b2b84 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceConnector.go +++ b/service/chimesdkvoice/api_op_CreateVoiceConnector.go @@ -12,9 +12,8 @@ import ( ) // Creates an Amazon Chime SDK Voice Connector. For more information about Voice -// Connectors, see Managing Amazon Chime SDK Voice Connector groups -// (https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html) in -// the Amazon Chime SDK Administrator Guide. +// Connectors, see Managing Amazon Chime SDK Voice Connector groups (https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html) +// in the Amazon Chime SDK Administrator Guide. func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceConnectorInput, optFns ...func(*Options)) (*CreateVoiceConnectorOutput, error) { if params == nil { params = &CreateVoiceConnectorInput{} @@ -42,8 +41,8 @@ type CreateVoiceConnectorInput struct { // This member is required. RequireEncryption *bool - // The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default - // value: us-east-1 . + // The AWS Region in which the Amazon Chime SDK Voice Connector is created. + // Default value: us-east-1 . AwsRegion types.VoiceConnectorAwsRegion noSmithyDocumentSerde diff --git a/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go b/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go index f71e2137a90..b003386cf88 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go +++ b/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go @@ -13,9 +13,9 @@ import ( // Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS // account. You can associate Amazon Chime SDK Voice Connectors with the Voice -// Connector group by including VoiceConnectorItems in the request. You can include -// Voice Connectors from different AWS Regions in your group. This creates a fault -// tolerant mechanism for fallback in case of availability events. +// Connector group by including VoiceConnectorItems in the request. You can +// include Voice Connectors from different AWS Regions in your group. This creates +// a fault tolerant mechanism for fallback in case of availability events. func (c *Client) CreateVoiceConnectorGroup(ctx context.Context, params *CreateVoiceConnectorGroupInput, optFns ...func(*Options)) (*CreateVoiceConnectorGroupOutput, error) { if params == nil { params = &CreateVoiceConnectorGroupInput{} diff --git a/service/chimesdkvoice/api_op_CreateVoiceProfile.go b/service/chimesdkvoice/api_op_CreateVoiceProfile.go index 0248a259c24..b5b699d471b 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceProfile.go +++ b/service/chimesdkvoice/api_op_CreateVoiceProfile.go @@ -14,12 +14,10 @@ import ( // Creates a voice profile, which consists of an enrolled user and their latest // voice print. Before creating any voice profiles, you must provide all notices // and obtain all consents from the speaker as required under applicable privacy -// and biometrics laws, and as required under the AWS service terms -// (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. For more -// information about voice profiles and voice analytics, see Using Amazon Chime SDK -// Voice Analytics -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in -// the Amazon Chime SDK Developer Guide. +// and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) +// for the Amazon Chime SDK. For more information about voice profiles and voice +// analytics, see Using Amazon Chime SDK Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. func (c *Client) CreateVoiceProfile(ctx context.Context, params *CreateVoiceProfileInput, optFns ...func(*Options)) (*CreateVoiceProfileOutput, error) { if params == nil { params = &CreateVoiceProfileInput{} diff --git a/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go b/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go index 51ff039ce97..7c81548188e 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go +++ b/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go @@ -17,9 +17,8 @@ import ( // under applicable privacy and biometrics laws, and as required under the AWS // service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. // For more information about voice profile domains, see Using Amazon Chime SDK -// Voice Analytics -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in -// the Amazon Chime SDK Developer Guide. +// Voice Analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. func (c *Client) CreateVoiceProfileDomain(ctx context.Context, params *CreateVoiceProfileDomainInput, optFns ...func(*Options)) (*CreateVoiceProfileDomainOutput, error) { if params == nil { params = &CreateVoiceProfileDomainInput{} diff --git a/service/chimesdkvoice/api_op_DeletePhoneNumber.go b/service/chimesdkvoice/api_op_DeletePhoneNumber.go index 879918eee01..76eaef220df 100644 --- a/service/chimesdkvoice/api_op_DeletePhoneNumber.go +++ b/service/chimesdkvoice/api_op_DeletePhoneNumber.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves the specified phone number into the Deletion queue. A phone number must be -// disassociated from any users or Amazon Chime SDK Voice Connectors before it can -// be deleted. Deleted phone numbers remain in the Deletion queue queue for 7 days -// before they are deleted permanently. +// Moves the specified phone number into the Deletion queue. A phone number must +// be disassociated from any users or Amazon Chime SDK Voice Connectors before it +// can be deleted. Deleted phone numbers remain in the Deletion queue queue for 7 +// days before they are deleted permanently. func (c *Client) DeletePhoneNumber(ctx context.Context, params *DeletePhoneNumberInput, optFns ...func(*Options)) (*DeletePhoneNumberOutput, error) { if params == nil { params = &DeletePhoneNumberInput{} diff --git a/service/chimesdkvoice/api_op_DeleteVoiceProfile.go b/service/chimesdkvoice/api_op_DeleteVoiceProfile.go index 767d0e68bdf..4658a99b31a 100644 --- a/service/chimesdkvoice/api_op_DeleteVoiceProfile.go +++ b/service/chimesdkvoice/api_op_DeleteVoiceProfile.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a voice profile, including its voice print and enrollment data. WARNING: -// This action is not reversible. +// Deletes a voice profile, including its voice print and enrollment data. +// WARNING: This action is not reversible. func (c *Client) DeleteVoiceProfile(ctx context.Context, params *DeleteVoiceProfileInput, optFns ...func(*Options)) (*DeleteVoiceProfileOutput, error) { if params == nil { params = &DeleteVoiceProfileInput{} diff --git a/service/chimesdkvoice/api_op_GetPhoneNumberSettings.go b/service/chimesdkvoice/api_op_GetPhoneNumberSettings.go index ea5abfd8b92..a157ed1118d 100644 --- a/service/chimesdkvoice/api_op_GetPhoneNumberSettings.go +++ b/service/chimesdkvoice/api_op_GetPhoneNumberSettings.go @@ -11,8 +11,8 @@ import ( "time" ) -// Retrieves the phone number settings for the administrator's AWS account, such as -// the default outbound calling name. +// Retrieves the phone number settings for the administrator's AWS account, such +// as the default outbound calling name. func (c *Client) GetPhoneNumberSettings(ctx context.Context, params *GetPhoneNumberSettingsInput, optFns ...func(*Options)) (*GetPhoneNumberSettingsOutput, error) { if params == nil { params = &GetPhoneNumberSettingsInput{} diff --git a/service/chimesdkvoice/api_op_GetProxySession.go b/service/chimesdkvoice/api_op_GetProxySession.go index e99bb6c6427..b5b03ad1329 100644 --- a/service/chimesdkvoice/api_op_GetProxySession.go +++ b/service/chimesdkvoice/api_op_GetProxySession.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified proxy session details for the specified Amazon Chime SDK -// Voice Connector. +// Retrieves the specified proxy session details for the specified Amazon Chime +// SDK Voice Connector. func (c *Client) GetProxySession(ctx context.Context, params *GetProxySessionInput, optFns ...func(*Options)) (*GetProxySessionOutput, error) { if params == nil { params = &GetProxySessionInput{} diff --git a/service/chimesdkvoice/api_op_GetVoiceConnectorGroup.go b/service/chimesdkvoice/api_op_GetVoiceConnectorGroup.go index 84d0d2abcd9..d4a8918e2ca 100644 --- a/service/chimesdkvoice/api_op_GetVoiceConnectorGroup.go +++ b/service/chimesdkvoice/api_op_GetVoiceConnectorGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details for the specified Amazon Chime SDK Voice Connector group, such -// as timestamps,name, and associated VoiceConnectorItems. +// Retrieves details for the specified Amazon Chime SDK Voice Connector group, +// such as timestamps,name, and associated VoiceConnectorItems . func (c *Client) GetVoiceConnectorGroup(ctx context.Context, params *GetVoiceConnectorGroupInput, optFns ...func(*Options)) (*GetVoiceConnectorGroupOutput, error) { if params == nil { params = &GetVoiceConnectorGroupInput{} diff --git a/service/chimesdkvoice/api_op_GetVoiceConnectorStreamingConfiguration.go b/service/chimesdkvoice/api_op_GetVoiceConnectorStreamingConfiguration.go index 7bbfd9d36dc..773bc1b1b80 100644 --- a/service/chimesdkvoice/api_op_GetVoiceConnectorStreamingConfiguration.go +++ b/service/chimesdkvoice/api_op_GetVoiceConnectorStreamingConfiguration.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the streaming configuration details for the specified Amazon Chime SDK -// Voice Connector. Shows whether media streaming is enabled for sending to Amazon -// Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis -// data. +// Retrieves the streaming configuration details for the specified Amazon Chime +// SDK Voice Connector. Shows whether media streaming is enabled for sending to +// Amazon Kinesis. It also shows the retention period, in hours, for the Amazon +// Kinesis data. func (c *Client) GetVoiceConnectorStreamingConfiguration(ctx context.Context, params *GetVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorStreamingConfigurationOutput, error) { if params == nil { params = &GetVoiceConnectorStreamingConfigurationInput{} diff --git a/service/chimesdkvoice/api_op_ListPhoneNumbers.go b/service/chimesdkvoice/api_op_ListPhoneNumbers.go index 8ed287a8226..fd532447efb 100644 --- a/service/chimesdkvoice/api_op_ListPhoneNumbers.go +++ b/service/chimesdkvoice/api_op_ListPhoneNumbers.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime -// SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector -// group. +// Lists the phone numbers for the specified Amazon Chime SDK account, Amazon +// Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice +// Connector group. func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error) { if params == nil { params = &ListPhoneNumbersInput{} diff --git a/service/chimesdkvoice/api_op_ListVoiceConnectors.go b/service/chimesdkvoice/api_op_ListVoiceConnectors.go index 5174f8ce806..97470270c60 100644 --- a/service/chimesdkvoice/api_op_ListVoiceConnectors.go +++ b/service/chimesdkvoice/api_op_ListVoiceConnectors.go @@ -113,8 +113,8 @@ func (c *Client) addOperationListVoiceConnectorsMiddlewares(stack *middleware.St return nil } -// ListVoiceConnectorsAPIClient is a client that implements the ListVoiceConnectors -// operation. +// ListVoiceConnectorsAPIClient is a client that implements the +// ListVoiceConnectors operation. type ListVoiceConnectorsAPIClient interface { ListVoiceConnectors(context.Context, *ListVoiceConnectorsInput, ...func(*Options)) (*ListVoiceConnectorsOutput, error) } diff --git a/service/chimesdkvoice/api_op_PutVoiceConnectorProxy.go b/service/chimesdkvoice/api_op_PutVoiceConnectorProxy.go index 5e372697b20..73f59ccaf2d 100644 --- a/service/chimesdkvoice/api_op_PutVoiceConnectorProxy.go +++ b/service/chimesdkvoice/api_op_PutVoiceConnectorProxy.go @@ -45,8 +45,8 @@ type PutVoiceConnectorProxyInput struct { // This member is required. VoiceConnectorId *string - // When true, stops proxy sessions from being created on the specified Amazon Chime - // SDK Voice Connector. + // When true, stops proxy sessions from being created on the specified Amazon + // Chime SDK Voice Connector. Disabled *bool // The phone number to route calls to after a proxy session expires. diff --git a/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go b/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go index 7dbf524736f..53c4e48a93c 100644 --- a/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go +++ b/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a speaker search task. Before starting any speaker search tasks, you must -// provide all notices and obtain all consents from the speaker as required under -// applicable privacy and biometrics laws, and as required under the AWS service -// terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. +// Starts a speaker search task. Before starting any speaker search tasks, you +// must provide all notices and obtain all consents from the speaker as required +// under applicable privacy and biometrics laws, and as required under the AWS +// service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK. func (c *Client) StartSpeakerSearchTask(ctx context.Context, params *StartSpeakerSearchTaskInput, optFns ...func(*Options)) (*StartSpeakerSearchTaskOutput, error) { if params == nil { params = &StartSpeakerSearchTaskInput{} diff --git a/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go b/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go index 785b667f898..6d57d795b31 100644 --- a/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go +++ b/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go @@ -12,9 +12,8 @@ import ( ) // Starts a voice tone analysis task. For more information about voice tone -// analysis, see Using Amazon Chime SDK voice analytics -// (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) in -// the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis +// analysis, see Using Amazon Chime SDK voice analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html) +// in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis // tasks, you must provide all notices and obtain all consents from the speaker as // required under applicable privacy and biometrics laws, and as required under the // AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime diff --git a/service/chimesdkvoice/api_op_ValidateE911Address.go b/service/chimesdkvoice/api_op_ValidateE911Address.go index 84c5853e2d9..69f09364ca8 100644 --- a/service/chimesdkvoice/api_op_ValidateE911Address.go +++ b/service/chimesdkvoice/api_op_ValidateE911Address.go @@ -37,7 +37,7 @@ type ValidateE911AddressInput struct { // This member is required. AwsAccountId *string - // The address city, such as Portland. + // The address city, such as Portland . // // This member is required. City *string @@ -47,22 +47,22 @@ type ValidateE911AddressInput struct { // This member is required. Country *string - // The dress postal code, such 04352. + // The dress postal code, such 04352 . // // This member is required. PostalCode *string - // The address state, such as ME. + // The address state, such as ME . // // This member is required. State *string - // The address street information, such as 8th Avenue. + // The address street information, such as 8th Avenue . // // This member is required. StreetInfo *string - // The address street number, such as 200 or 2121. + // The address street number, such as 200 or 2121 . // // This member is required. StreetNumber *string diff --git a/service/chimesdkvoice/types/enums.go b/service/chimesdkvoice/types/enums.go index 6361371a726..2f77b2f27ac 100644 --- a/service/chimesdkvoice/types/enums.go +++ b/service/chimesdkvoice/types/enums.go @@ -82,9 +82,9 @@ const ( ErrorCodeGone ErrorCode = "Gone" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "BadRequest", @@ -131,9 +131,9 @@ const ( LanguageCodeEnUs LanguageCode = "en-US" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "en-US", @@ -187,9 +187,9 @@ const ( OrderedPhoneNumberStatusFailed OrderedPhoneNumberStatus = "Failed" ) -// Values returns all known values for OrderedPhoneNumberStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderedPhoneNumberStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderedPhoneNumberStatus) Values() []OrderedPhoneNumberStatus { return []OrderedPhoneNumberStatus{ "Processing", @@ -206,9 +206,9 @@ const ( OriginationRouteProtocolUdp OriginationRouteProtocol = "UDP" ) -// Values returns all known values for OriginationRouteProtocol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OriginationRouteProtocol. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginationRouteProtocol) Values() []OriginationRouteProtocol { return []OriginationRouteProtocol{ "TCP", diff --git a/service/chimesdkvoice/types/types.go b/service/chimesdkvoice/types/types.go index 8f96bd5f980..ff131fb9df5 100644 --- a/service/chimesdkvoice/types/types.go +++ b/service/chimesdkvoice/types/types.go @@ -16,7 +16,7 @@ type Address struct { // The country of an address. Country *string - // An address suffix location, such as the S. Unit A in Central Park S. Unit A. + // An address suffix location, such as the S. Unit A in Central Park S. Unit A . PostDirectional *string // The postal code of an address. @@ -31,13 +31,13 @@ type Address struct { // The state of an address. State *string - // The address street, such as 8th Avenue. + // The address street, such as 8th Avenue . StreetName *string // The numeric portion of an address. StreetNumber *string - // The address suffix, such as the N in 8th Avenue N. + // The address suffix, such as the N in 8th Avenue N . StreetSuffix *string noSmithyDocumentSerde @@ -93,8 +93,8 @@ type Credential struct { // format. Password *string - // The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII - // format. + // The RFC2617 compliant user name associated with the SIP credentials, in + // US-ASCII format. Username *string noSmithyDocumentSerde @@ -193,12 +193,12 @@ type Origination struct { // When origination settings are disabled, inbound calls are not enabled for your // Amazon Chime SDK Voice Connector. This parameter is not required, but you must - // specify this parameter or Routes. + // specify this parameter or Routes . Disabled *bool // The call distribution properties defined for your SIP hosts. Valid range: // Minimum value of 1. Maximum value of 20. This parameter is not required, but you - // must specify this parameter or Disabled. + // must specify this parameter or Disabled . Routes []OriginationRoute noSmithyDocumentSerde @@ -216,8 +216,8 @@ type OriginationRoute struct { // The designated origination route port. Defaults to 5060. Port *int32 - // The priority associated with the host, with 1 being the highest priority. Higher - // priority hosts are attempted first. + // The priority associated with the host, with 1 being the highest priority. + // Higher priority hosts are attempted first. Priority *int32 // The protocol to use for the origination route. Encryption-enabled Amazon Chime @@ -231,8 +231,8 @@ type OriginationRoute struct { noSmithyDocumentSerde } -// The phone number and proxy phone number for a participant in an Amazon Chime SDK -// Voice Connector proxy session. +// The phone number and proxy phone number for a participant in an Amazon Chime +// SDK Voice Connector proxy session. type Participant struct { // The participant's phone number. @@ -397,8 +397,8 @@ type Proxy struct { // The default number of minutes allowed for proxy sessions. DefaultSessionExpiryMinutes *int32 - // When true, stops proxy sessions from being created on the specified Amazon Chime - // SDK Voice Connector. + // When true, stops proxy sessions from being created on the specified Amazon + // Chime SDK Voice Connector. Disabled *bool // The phone number to route calls to after a proxy session expires. @@ -457,9 +457,9 @@ type ProxySession struct { noSmithyDocumentSerde } -// A structure that contains the configuration settings for server-side encryption. -// We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS -// aliases. +// A structure that contains the configuration settings for server-side +// encryption. We only support symmetric keys. Do not use asymmetric or HMAC keys, +// or KMS aliases. type ServerSideEncryptionConfiguration struct { // The ARN of the KMS key used to encrypt the enrollment data in a voice profile @@ -541,8 +541,8 @@ type SipMediaApplicationLoggingConfiguration struct { noSmithyDocumentSerde } -// The details of a SIP rule, including name, triggers, and target applications. An -// AWS account can have multiple SIP rules. +// The details of a SIP rule, including name, triggers, and target applications. +// An AWS account can have multiple SIP rules. type SipRule struct { // The time at which the SIP rule was created, in ISO 8601 format. @@ -600,8 +600,8 @@ type SpeakerSearchDetails struct { // The result value in the speaker search details. Results []SpeakerSearchResult - // The status of a voice print generation operation, VoiceprintGenerationSuccess or - // VoiceprintGenerationFailure.. + // The status of a voice print generation operation, VoiceprintGenerationSuccess + // or VoiceprintGenerationFailure .. VoiceprintGenerationStatus *string noSmithyDocumentSerde @@ -635,8 +635,8 @@ type SpeakerSearchTask struct { // The speaker search task ID. SpeakerSearchTaskId *string - // The status of the speaker search task, IN_QUEUE, IN_PROGRESS, PARTIAL_SUCCESS, - // SUCCEEDED, FAILED, or STOPPED. + // The status of the speaker search task, IN_QUEUE , IN_PROGRESS , PARTIAL_SUCCESS + // , SUCCEEDED , FAILED , or STOPPED . SpeakerSearchTaskStatus *string // The time at which the speaker search task began. @@ -651,9 +651,9 @@ type SpeakerSearchTask struct { noSmithyDocumentSerde } -// The streaming configuration associated with an Amazon Chime SDK Voice Connector. -// Specifies whether media streaming is enabled for sending to Amazon Kinesis, and -// shows the retention period for the Amazon Kinesis data, in hours. +// The streaming configuration associated with an Amazon Chime SDK Voice +// Connector. Specifies whether media streaming is enabled for sending to Amazon +// Kinesis, and shows the retention period for the Amazon Kinesis data, in hours. type StreamingConfiguration struct { // The amount of time, in hours, to the Kinesis data. @@ -711,8 +711,8 @@ type Termination struct { // The IP addresses allowed to make calls, in CIDR format. CidrAllowedList []string - // The limit on calls per second. Max value based on account service quota. Default - // value of 1. + // The limit on calls per second. Max value based on account service quota. + // Default value of 1. CpsLimit *int32 // The default outbound calling number. @@ -724,8 +724,8 @@ type Termination struct { noSmithyDocumentSerde } -// The termination health details, including the source IP address and timestamp of -// the last successful SIP OPTIONS message from your SIP infrastructure. +// The termination health details, including the source IP address and timestamp +// of the last successful SIP OPTIONS message from your SIP infrastructure. type TerminationHealth struct { // The source IP address. @@ -755,8 +755,8 @@ type UpdatePhoneNumberRequestItem struct { noSmithyDocumentSerde } -// The Amazon Chime SDK Voice Connector configuration, including outbound host name -// and encryption settings. +// The Amazon Chime SDK Voice Connector configuration, including outbound host +// name and encryption settings. type VoiceConnector struct { // The AWS Region in which the Voice Connector is created. Default: us-east-1. @@ -925,8 +925,9 @@ type VoiceProfileSummary struct { // The time at which a voice profile summary was created. CreatedTimestamp *time.Time - // Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh - // an existing voice profile's voice print and extend the life of the summary. + // Extends the life of the voice profile. You can use UpdateVoiceProfile to + // refresh an existing voice profile's voice print and extend the life of the + // summary. ExpirationTimestamp *time.Time // The time at which a voice profile summary was last updated. @@ -966,8 +967,8 @@ type VoiceToneAnalysisTask struct { // The ID of the voice tone analysis task. VoiceToneAnalysisTaskId *string - // The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS, - // PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED. + // The status of a voice tone analysis task, IN_QUEUE , IN_PROGRESS , + // PARTIAL_SUCCESS , SUCCEEDED , FAILED , or STOPPED . VoiceToneAnalysisTaskStatus *string noSmithyDocumentSerde diff --git a/service/cleanrooms/api_client.go b/service/cleanrooms/api_client.go index c9f59a2612d..36d475b3f1f 100644 --- a/service/cleanrooms/api_client.go +++ b/service/cleanrooms/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cleanrooms/api_op_BatchGetSchema.go b/service/cleanrooms/api_op_BatchGetSchema.go index dfffda24b5a..fe285fd0886 100644 --- a/service/cleanrooms/api_op_BatchGetSchema.go +++ b/service/cleanrooms/api_op_BatchGetSchema.go @@ -45,8 +45,8 @@ type BatchGetSchemaInput struct { type BatchGetSchemaOutput struct { - // Error reasons for schemas that could not be retrieved. One error is returned for - // every schema that could not be retrieved. + // Error reasons for schemas that could not be retrieved. One error is returned + // for every schema that could not be retrieved. // // This member is required. Errors []types.BatchGetSchemaError diff --git a/service/cleanrooms/api_op_CreateCollaboration.go b/service/cleanrooms/api_op_CreateCollaboration.go index 4791d6cc050..5f29ff7f290 100644 --- a/service/cleanrooms/api_op_CreateCollaboration.go +++ b/service/cleanrooms/api_op_CreateCollaboration.go @@ -64,10 +64,10 @@ type CreateCollaborationInput struct { // Rooms. DataEncryptionMetadata *types.DataEncryptionMetadata - // An optional label that you can assign to a resource when you create it. Each tag - // consists of a key and an optional value, both of which you define. When you use - // tagging, you can also use tag-based access control in IAM policies to control - // access to this resource. + // An optional label that you can assign to a resource when you create it. Each + // tag consists of a key and an optional value, both of which you define. When you + // use tagging, you can also use tag-based access control in IAM policies to + // control access to this resource. Tags map[string]string noSmithyDocumentSerde diff --git a/service/cleanrooms/api_op_CreateConfiguredTable.go b/service/cleanrooms/api_op_CreateConfiguredTable.go index 95f278d242b..4d2dd4c16e6 100644 --- a/service/cleanrooms/api_op_CreateConfiguredTable.go +++ b/service/cleanrooms/api_op_CreateConfiguredTable.go @@ -35,8 +35,8 @@ type CreateConfiguredTableInput struct { // This member is required. AllowedColumns []string - // The analysis method for the configured tables. The only valid value is currently - // `DIRECT_QUERY`. + // The analysis method for the configured tables. The only valid value is + // currently `DIRECT_QUERY`. // // This member is required. AnalysisMethod types.AnalysisMethod @@ -54,10 +54,10 @@ type CreateConfiguredTableInput struct { // A description for the configured table. Description *string - // An optional label that you can assign to a resource when you create it. Each tag - // consists of a key and an optional value, both of which you define. When you use - // tagging, you can also use tag-based access control in IAM policies to control - // access to this resource. + // An optional label that you can assign to a resource when you create it. Each + // tag consists of a key and an optional value, both of which you define. When you + // use tagging, you can also use tag-based access control in IAM policies to + // control access to this resource. Tags map[string]string noSmithyDocumentSerde diff --git a/service/cleanrooms/api_op_CreateConfiguredTableAnalysisRule.go b/service/cleanrooms/api_op_CreateConfiguredTableAnalysisRule.go index a7914a8f525..8035cfb9d28 100644 --- a/service/cleanrooms/api_op_CreateConfiguredTableAnalysisRule.go +++ b/service/cleanrooms/api_op_CreateConfiguredTableAnalysisRule.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new analysis rule for a configured table. Currently, only one analysis -// rule can be created for a given configured table. +// Creates a new analysis rule for a configured table. Currently, only one +// analysis rule can be created for a given configured table. func (c *Client) CreateConfiguredTableAnalysisRule(ctx context.Context, params *CreateConfiguredTableAnalysisRuleInput, optFns ...func(*Options)) (*CreateConfiguredTableAnalysisRuleOutput, error) { if params == nil { params = &CreateConfiguredTableAnalysisRuleInput{} diff --git a/service/cleanrooms/api_op_CreateConfiguredTableAssociation.go b/service/cleanrooms/api_op_CreateConfiguredTableAssociation.go index 021cf548fa1..f1dfd838f19 100644 --- a/service/cleanrooms/api_op_CreateConfiguredTableAssociation.go +++ b/service/cleanrooms/api_op_CreateConfiguredTableAssociation.go @@ -58,10 +58,10 @@ type CreateConfiguredTableAssociationInput struct { // A description for the configured table association. Description *string - // An optional label that you can assign to a resource when you create it. Each tag - // consists of a key and an optional value, both of which you define. When you use - // tagging, you can also use tag-based access control in IAM policies to control - // access to this resource. + // An optional label that you can assign to a resource when you create it. Each + // tag consists of a key and an optional value, both of which you define. When you + // use tagging, you can also use tag-based access control in IAM policies to + // control access to this resource. Tags map[string]string noSmithyDocumentSerde diff --git a/service/cleanrooms/api_op_CreateMembership.go b/service/cleanrooms/api_op_CreateMembership.go index 3b9a073cfc2..581b4055fac 100644 --- a/service/cleanrooms/api_op_CreateMembership.go +++ b/service/cleanrooms/api_op_CreateMembership.go @@ -41,10 +41,10 @@ type CreateMembershipInput struct { // This member is required. QueryLogStatus types.MembershipQueryLogStatus - // An optional label that you can assign to a resource when you create it. Each tag - // consists of a key and an optional value, both of which you define. When you use - // tagging, you can also use tag-based access control in IAM policies to control - // access to this resource. + // An optional label that you can assign to a resource when you create it. Each + // tag consists of a key and an optional value, both of which you define. When you + // use tagging, you can also use tag-based access control in IAM policies to + // control access to this resource. Tags map[string]string noSmithyDocumentSerde diff --git a/service/cleanrooms/api_op_UpdateProtectedQuery.go b/service/cleanrooms/api_op_UpdateProtectedQuery.go index 3bd34905484..66faff50695 100644 --- a/service/cleanrooms/api_op_UpdateProtectedQuery.go +++ b/service/cleanrooms/api_op_UpdateProtectedQuery.go @@ -39,8 +39,8 @@ type UpdateProtectedQueryInput struct { // This member is required. ProtectedQueryIdentifier *string - // The target status of a query. Used to update the execution status of a currently - // running query. + // The target status of a query. Used to update the execution status of a + // currently running query. // // This member is required. TargetStatus types.TargetProtectedQueryStatus diff --git a/service/cleanrooms/doc.go b/service/cleanrooms/doc.go index 26e49192515..4e30f770f67 100644 --- a/service/cleanrooms/doc.go +++ b/service/cleanrooms/doc.go @@ -9,5 +9,5 @@ // results can get insights into the collective datasets without either party // getting access to the other party's raw data. To learn more about AWS Clean // Rooms concepts, procedures, and best practices, see the AWS Clean Rooms User -// Guide (https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html). +// Guide (https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html) . package cleanrooms diff --git a/service/cleanrooms/types/enums.go b/service/cleanrooms/types/enums.go index 78cdd2b9095..0f0927ee5fe 100644 --- a/service/cleanrooms/types/enums.go +++ b/service/cleanrooms/types/enums.go @@ -29,8 +29,8 @@ const ( AggregateFunctionNameAvg AggregateFunctionName = "AVG" ) -// Values returns all known values for AggregateFunctionName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AggregateFunctionName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AggregateFunctionName) Values() []AggregateFunctionName { return []AggregateFunctionName{ @@ -209,9 +209,9 @@ const ( MembershipQueryLogStatusDisabled MembershipQueryLogStatus = "DISABLED" ) -// Values returns all known values for MembershipQueryLogStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MembershipQueryLogStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MembershipQueryLogStatus) Values() []MembershipQueryLogStatus { return []MembershipQueryLogStatus{ "ENABLED", @@ -249,9 +249,9 @@ const ( MemberStatusRemoved MemberStatus = "REMOVED" ) -// Values returns all known values for MemberStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MemberStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MemberStatus) Values() []MemberStatus { return []MemberStatus{ "INVITED", @@ -315,9 +315,9 @@ const ( ResourceTypeConfiguredTableAssociation ResourceType = "CONFIGURED_TABLE_ASSOCIATION" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "CONFIGURED_TABLE", @@ -335,9 +335,9 @@ const ( ResultFormatParquet ResultFormat = "PARQUET" ) -// Values returns all known values for ResultFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResultFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResultFormat) Values() []ResultFormat { return []ResultFormat{ "CSV", diff --git a/service/cleanrooms/types/types.go b/service/cleanrooms/types/types.go index 1969d456411..96fe2529fd2 100644 --- a/service/cleanrooms/types/types.go +++ b/service/cleanrooms/types/types.go @@ -40,8 +40,8 @@ type AggregationConstraint struct { // This member is required. Minimum *int32 - // The type of aggregation the constraint allows. The only valid value is currently - // `COUNT_DISTINCT`. + // The type of aggregation the constraint allows. The only valid value is + // currently `COUNT_DISTINCT`. // // This member is required. Type AggregationType @@ -104,14 +104,14 @@ type AnalysisRuleAggregation struct { // This member is required. JoinColumns []string - // Columns that must meet a specific threshold value (after an aggregation function - // is applied to it) for each output row to be returned. + // Columns that must meet a specific threshold value (after an aggregation + // function is applied to it) for each output row to be returned. // // This member is required. OutputConstraints []AggregationConstraint - // Set of scalar functions that are allowed to be used on dimension columns and the - // output of aggregation of metrics. + // Set of scalar functions that are allowed to be used on dimension columns and + // the output of aggregation of metrics. // // This member is required. ScalarFunctions []ScalarFunctions @@ -126,8 +126,8 @@ type AnalysisRuleAggregation struct { // A type of analysis rule that enables row-level analysis. type AnalysisRuleList struct { - // Columns that can be used to join a configured table with the table of the member - // who can query and another members' configured tables. + // Columns that can be used to join a configured table with the table of the + // member who can query and another members' configured tables. // // This member is required. JoinColumns []string @@ -601,8 +601,8 @@ type ConfiguredTableAssociationSummary struct { // The configured table summary for the objects listed by the request. type ConfiguredTableSummary struct { - // The analysis method for the configured tables. The only valid value is currently - // `DIRECT_QUERY`. + // The analysis method for the configured tables. The only valid value is + // currently `DIRECT_QUERY`. // // This member is required. AnalysisMethod AnalysisMethod @@ -1201,8 +1201,8 @@ type SchemaSummary struct { // This member is required. UpdateTime *time.Time - // The analysis method for the associated schema. The only valid value is currently - // `DIRECT_QUERY`. + // The analysis method for the associated schema. The only valid value is + // currently `DIRECT_QUERY`. AnalysisMethod AnalysisMethod noSmithyDocumentSerde diff --git a/service/cloud9/api_client.go b/service/cloud9/api_client.go index 9ffdb657d6c..23bdbf9b2a4 100644 --- a/service/cloud9/api_client.go +++ b/service/cloud9/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloud9/api_op_CreateEnvironmentEC2.go b/service/cloud9/api_op_CreateEnvironmentEC2.go index 92afde74f2a..db3642260c6 100644 --- a/service/cloud9/api_op_CreateEnvironmentEC2.go +++ b/service/cloud9/api_op_CreateEnvironmentEC2.go @@ -31,7 +31,7 @@ func (c *Client) CreateEnvironmentEC2(ctx context.Context, params *CreateEnviron type CreateEnvironmentEC2Input struct { - // The type of instance to connect to the environment (for example, t2.micro). + // The type of instance to connect to the environment (for example, t2.micro ). // // This member is required. InstanceType *string @@ -47,17 +47,15 @@ type CreateEnvironmentEC2Input struct { AutomaticStopTimeMinutes *int32 // A unique, case-sensitive string that helps Cloud9 to ensure this operation - // completes no more than one time. For more information, see Client Tokens - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // completes no more than one time. For more information, see Client Tokens (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. ClientRequestToken *string // The connection type used for connecting to an Amazon EC2 environment. Valid // values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 // Systems Manager). For more information, see Accessing no-ingress EC2 instances - // with Amazon EC2 Systems Manager - // (https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html) in the - // Cloud9 User Guide. + // with Amazon EC2 Systems Manager (https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html) + // in the Cloud9 User Guide. ConnectionType types.ConnectionType // The description of the environment to create. @@ -65,8 +63,8 @@ type CreateEnvironmentEC2Input struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 @@ -77,30 +75,19 @@ type CreateEnvironmentEC2Input struct { // available when you specify an AMI for your instance. Amazon Linux 2 will then // become the default AMI, which is used to launch your instance if no parameter is // explicitly defined. AMI aliases - // - // * Amazon Linux (default): - // amazonlinux-1-x86_64 - // - // * Amazon Linux 2: amazonlinux-2-x86_64 - // - // * Ubuntu 18.04: - // ubuntu-18.04-x86_64 - // + // - Amazon Linux (default): amazonlinux-1-x86_64 + // - Amazon Linux 2: amazonlinux-2-x86_64 + // - Ubuntu 18.04: ubuntu-18.04-x86_64 // SSM paths - // - // * Amazon Linux (default): - // resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64 - // - // * Amazon Linux 2: - // resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64 - // - // * Ubuntu 18.04: - // resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64 + // - Amazon Linux (default): + // resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64 + // - Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64 + // - Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64 ImageId *string - // The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN - // of any IAM principal. If this value is not specified, the ARN defaults to this - // environment's creator. + // The Amazon Resource Name (ARN) of the environment owner. This ARN can be the + // ARN of any IAM principal. If this value is not specified, the ARN defaults to + // this environment's creator. OwnerArn *string // The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the diff --git a/service/cloud9/api_op_CreateEnvironmentMembership.go b/service/cloud9/api_op_CreateEnvironmentMembership.go index c72e37ba98c..a94f9fd38f2 100644 --- a/service/cloud9/api_op_CreateEnvironmentMembership.go +++ b/service/cloud9/api_op_CreateEnvironmentMembership.go @@ -36,11 +36,8 @@ type CreateEnvironmentMembershipInput struct { // The type of environment member permissions you want to associate with this // environment member. Available values include: - // - // * read-only: Has read-only access - // to the environment. - // - // * read-write: Has read-write access to the environment. + // - read-only : Has read-only access to the environment. + // - read-write : Has read-write access to the environment. // // This member is required. Permissions types.MemberPermissions diff --git a/service/cloud9/api_op_DescribeEnvironmentMemberships.go b/service/cloud9/api_op_DescribeEnvironmentMemberships.go index 6ed5c67e262..a8669661aa7 100644 --- a/service/cloud9/api_op_DescribeEnvironmentMemberships.go +++ b/service/cloud9/api_op_DescribeEnvironmentMemberships.go @@ -47,17 +47,11 @@ type DescribeEnvironmentMembershipsInput struct { // The type of environment member permissions to get information about. Available // values include: - // - // * owner: Owns the environment. - // - // * read-only: Has read-only - // access to the environment. - // - // * read-write: Has read-write access to the - // environment. - // - // If no value is specified, information about all environment - // members are returned. + // - owner : Owns the environment. + // - read-only : Has read-only access to the environment. + // - read-write : Has read-write access to the environment. + // If no value is specified, information about all environment members are + // returned. Permissions []types.Permissions // The Amazon Resource Name (ARN) of an individual environment member to get diff --git a/service/cloud9/api_op_DescribeEnvironmentStatus.go b/service/cloud9/api_op_DescribeEnvironmentStatus.go index e4087816df2..23ff82dd559 100644 --- a/service/cloud9/api_op_DescribeEnvironmentStatus.go +++ b/service/cloud9/api_op_DescribeEnvironmentStatus.go @@ -45,24 +45,13 @@ type DescribeEnvironmentStatusOutput struct { Message *string // The status of the environment. Available values include: - // - // * connecting: The - // environment is connecting. - // - // * creating: The environment is being created. - // - // * - // deleting: The environment is being deleted. - // - // * error: The environment is in an - // error state. - // - // * ready: The environment is ready. - // - // * stopped: The environment is - // stopped. - // - // * stopping: The environment is stopping. + // - connecting : The environment is connecting. + // - creating : The environment is being created. + // - deleting : The environment is being deleted. + // - error : The environment is in an error state. + // - ready : The environment is ready. + // - stopped : The environment is stopped. + // - stopping : The environment is stopping. // // This member is required. Status types.EnvironmentStatus diff --git a/service/cloud9/api_op_TagResource.go b/service/cloud9/api_op_TagResource.go index a17195979a6..72f29ab3386 100644 --- a/service/cloud9/api_op_TagResource.go +++ b/service/cloud9/api_op_TagResource.go @@ -31,8 +31,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags - // to. + // The Amazon Resource Name (ARN) of the Cloud9 development environment to add + // tags to. // // This member is required. ResourceARN *string diff --git a/service/cloud9/api_op_UpdateEnvironment.go b/service/cloud9/api_op_UpdateEnvironment.go index dd28d892379..81f4d98fb1f 100644 --- a/service/cloud9/api_op_UpdateEnvironment.go +++ b/service/cloud9/api_op_UpdateEnvironment.go @@ -40,15 +40,12 @@ type UpdateEnvironmentInput struct { // Allows the environment owner to turn on or turn off the Amazon Web Services // managed temporary credentials for an Cloud9 environment by using one of the // following values: - // - // * ENABLE - // - // * DISABLE - // - // Only the environment owner can change - // the status of managed temporary credentials. An AccessDeniedException is thrown - // if an attempt to turn on or turn off managed temporary credentials is made by an - // account that's not the environment owner. + // - ENABLE + // - DISABLE + // Only the environment owner can change the status of managed temporary + // credentials. An AccessDeniedException is thrown if an attempt to turn on or + // turn off managed temporary credentials is made by an account that's not the + // environment owner. ManagedCredentialsAction types.ManagedCredentialsAction // A replacement name for the environment. diff --git a/service/cloud9/api_op_UpdateEnvironmentMembership.go b/service/cloud9/api_op_UpdateEnvironmentMembership.go index d2df7272234..4c0419975b2 100644 --- a/service/cloud9/api_op_UpdateEnvironmentMembership.go +++ b/service/cloud9/api_op_UpdateEnvironmentMembership.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the settings of an existing environment member for an Cloud9 development -// environment. +// Changes the settings of an existing environment member for an Cloud9 +// development environment. func (c *Client) UpdateEnvironmentMembership(ctx context.Context, params *UpdateEnvironmentMembershipInput, optFns ...func(*Options)) (*UpdateEnvironmentMembershipOutput, error) { if params == nil { params = &UpdateEnvironmentMembershipInput{} @@ -38,18 +38,14 @@ type UpdateEnvironmentMembershipInput struct { // The replacement type of environment member permissions you want to associate // with this environment member. Available values include: - // - // * read-only: Has - // read-only access to the environment. - // - // * read-write: Has read-write access to the - // environment. + // - read-only : Has read-only access to the environment. + // - read-write : Has read-write access to the environment. // // This member is required. Permissions types.MemberPermissions - // The Amazon Resource Name (ARN) of the environment member whose settings you want - // to change. + // The Amazon Resource Name (ARN) of the environment member whose settings you + // want to change. // // This member is required. UserArn *string diff --git a/service/cloud9/doc.go b/service/cloud9/doc.go index 12aafdfe250..b94bfac652e 100644 --- a/service/cloud9/doc.go +++ b/service/cloud9/doc.go @@ -5,47 +5,24 @@ // // Cloud9 Cloud9 is a collection of tools that you can use to code, build, run, // test, debug, and release software in the cloud. For more information about -// Cloud9, see the Cloud9 User Guide -// (https://docs.aws.amazon.com/cloud9/latest/user-guide). Cloud9 supports these -// operations: -// -// * CreateEnvironmentEC2: Creates an Cloud9 development environment, -// launches an Amazon EC2 instance, and then connects from the instance to the -// environment. -// -// * CreateEnvironmentMembership: Adds an environment member to an -// environment. -// -// * DeleteEnvironment: Deletes an environment. If an Amazon EC2 -// instance is connected to the environment, also terminates the instance. -// -// * -// DeleteEnvironmentMembership: Deletes an environment member from an -// environment. -// -// * DescribeEnvironmentMemberships: Gets information about -// environment members for an environment. -// -// * DescribeEnvironments: Gets -// information about environments. -// -// * DescribeEnvironmentStatus: Gets status -// information for an environment. -// -// * ListEnvironments: Gets a list of environment -// identifiers. -// -// * ListTagsForResource: Gets the tags for an environment. -// -// * -// TagResource: Adds tags to an environment. -// -// * UntagResource: Removes tags from an -// environment. -// -// * UpdateEnvironment: Changes the settings of an existing -// environment. -// -// * UpdateEnvironmentMembership: Changes the settings of an existing -// environment member for an environment. +// Cloud9, see the Cloud9 User Guide (https://docs.aws.amazon.com/cloud9/latest/user-guide) +// . Cloud9 supports these operations: +// - CreateEnvironmentEC2 : Creates an Cloud9 development environment, launches +// an Amazon EC2 instance, and then connects from the instance to the environment. +// - CreateEnvironmentMembership : Adds an environment member to an environment. +// - DeleteEnvironment : Deletes an environment. If an Amazon EC2 instance is +// connected to the environment, also terminates the instance. +// - DeleteEnvironmentMembership : Deletes an environment member from an +// environment. +// - DescribeEnvironmentMemberships : Gets information about environment members +// for an environment. +// - DescribeEnvironments : Gets information about environments. +// - DescribeEnvironmentStatus : Gets status information for an environment. +// - ListEnvironments : Gets a list of environment identifiers. +// - ListTagsForResource : Gets the tags for an environment. +// - TagResource : Adds tags to an environment. +// - UntagResource : Removes tags from an environment. +// - UpdateEnvironment : Changes the settings of an existing environment. +// - UpdateEnvironmentMembership : Changes the settings of an existing +// environment member for an environment. package cloud9 diff --git a/service/cloud9/types/enums.go b/service/cloud9/types/enums.go index afd01119e0d..8dffa83e9c3 100644 --- a/service/cloud9/types/enums.go +++ b/service/cloud9/types/enums.go @@ -98,9 +98,9 @@ const ( ManagedCredentialsActionDisable ManagedCredentialsAction = "DISABLE" ) -// Values returns all known values for ManagedCredentialsAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ManagedCredentialsAction. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedCredentialsAction) Values() []ManagedCredentialsAction { return []ManagedCredentialsAction{ "ENABLE", @@ -125,9 +125,9 @@ const ( ManagedCredentialsStatusFailedRemovalByOwner ManagedCredentialsStatus = "FAILED_REMOVAL_BY_OWNER" ) -// Values returns all known values for ManagedCredentialsStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ManagedCredentialsStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedCredentialsStatus) Values() []ManagedCredentialsStatus { return []ManagedCredentialsStatus{ "ENABLED_ON_CREATE", diff --git a/service/cloud9/types/types.go b/service/cloud9/types/types.go index d964d23ebc8..55bc0f84ec0 100644 --- a/service/cloud9/types/types.go +++ b/service/cloud9/types/types.go @@ -21,12 +21,9 @@ type Environment struct { OwnerArn *string // The type of environment. Valid values include the following: - // - // * ec2: An Amazon - // Elastic Compute Cloud (Amazon EC2) instance connects to the environment. - // - // * ssh: - // Your own server connects to the environment. + // - ec2 : An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the + // environment. + // - ssh : Your own server connects to the environment. // // This member is required. Type EnvironmentType @@ -46,30 +43,16 @@ type Environment struct { // Describes the status of Amazon Web Services managed temporary credentials for // the Cloud9 environment. Available values are: - // - // * ENABLED_ON_CREATE - // - // * - // ENABLED_BY_OWNER - // - // * DISABLED_BY_DEFAULT - // - // * DISABLED_BY_OWNER - // - // * - // DISABLED_BY_COLLABORATOR - // - // * PENDING_REMOVAL_BY_COLLABORATOR - // - // * - // PENDING_REMOVAL_BY_OWNER - // - // * FAILED_REMOVAL_BY_COLLABORATOR - // - // * - // ENABLED_BY_OWNER - // - // * DISABLED_BY_DEFAULT + // - ENABLED_ON_CREATE + // - ENABLED_BY_OWNER + // - DISABLED_BY_DEFAULT + // - DISABLED_BY_OWNER + // - DISABLED_BY_COLLABORATOR + // - PENDING_REMOVAL_BY_COLLABORATOR + // - PENDING_REMOVAL_BY_OWNER + // - FAILED_REMOVAL_BY_COLLABORATOR + // - ENABLED_BY_OWNER + // - DISABLED_BY_DEFAULT ManagedCredentialsStatus ManagedCredentialsStatus // The name of the environment. @@ -90,20 +73,11 @@ type EnvironmentLifecycle struct { Reason *string // The current creation or deletion lifecycle state of the environment. - // - // * - // CREATING: The environment is in the process of being created. - // - // * CREATED: The - // environment was successfully created. - // - // * CREATE_FAILED: The environment failed - // to be created. - // - // * DELETING: The environment is in the process of being - // deleted. - // - // * DELETE_FAILED: The environment failed to delete. + // - CREATING : The environment is in the process of being created. + // - CREATED : The environment was successfully created. + // - CREATE_FAILED : The environment failed to be created. + // - DELETING : The environment is in the process of being deleted. + // - DELETE_FAILED : The environment failed to delete. Status EnvironmentLifecycleStatus noSmithyDocumentSerde @@ -119,14 +93,9 @@ type EnvironmentMember struct { // The type of environment member permissions associated with this environment // member. Available values include: - // - // * owner: Owns the environment. - // - // * read-only: - // Has read-only access to the environment. - // - // * read-write: Has read-write access to - // the environment. + // - owner : Owns the environment. + // - read-only : Has read-only access to the environment. + // - read-write : Has read-write access to the environment. // // This member is required. Permissions Permissions @@ -148,8 +117,8 @@ type EnvironmentMember struct { noSmithyDocumentSerde } -// Metadata that is associated with Amazon Web Services resources. In particular, a -// name-value pair that can be associated with an Cloud9 development environment. +// Metadata that is associated with Amazon Web Services resources. In particular, +// a name-value pair that can be associated with an Cloud9 development environment. // There are two types of tags: user tags and system tags. A user tag is created by // the user. A system tag is automatically created by Amazon Web Services services. // A system tag is prefixed with "aws:" and cannot be modified by the user. diff --git a/service/cloudcontrol/api_client.go b/service/cloudcontrol/api_client.go index e58bc927ebe..2c6ec20e8f6 100644 --- a/service/cloudcontrol/api_client.go +++ b/service/cloudcontrol/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudcontrol/api_op_CancelResourceRequest.go b/service/cloudcontrol/api_op_CancelResourceRequest.go index 37fc8a5912c..87da9a0c32c 100644 --- a/service/cloudcontrol/api_op_CancelResourceRequest.go +++ b/service/cloudcontrol/api_op_CancelResourceRequest.go @@ -12,8 +12,7 @@ import ( ) // Cancels the specified resource operation request. For more information, see -// Canceling resource operation requests -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel) +// Canceling resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel) // in the Amazon Web Services Cloud Control API User Guide. Only resource // operations requests with a status of PENDING or IN_PROGRESS can be canceled. func (c *Client) CancelResourceRequest(ctx context.Context, params *CancelResourceRequestInput, optFns ...func(*Options)) (*CancelResourceRequestOutput, error) { @@ -45,8 +44,7 @@ type CancelResourceRequestInput struct { type CancelResourceRequestOutput struct { // Represents the current status of a resource operation request. For more - // information, see Managing resource operation requests - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) + // information, see Managing resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) // in the Amazon Web Services Cloud Control API User Guide. ProgressEvent *types.ProgressEvent diff --git a/service/cloudcontrol/api_op_CreateResource.go b/service/cloudcontrol/api_op_CreateResource.go index 7c51b33f802..bd996481e97 100644 --- a/service/cloudcontrol/api_op_CreateResource.go +++ b/service/cloudcontrol/api_op_CreateResource.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the specified resource. For more information, see Creating a resource -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html) +// Creates the specified resource. For more information, see Creating a resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html) // in the Amazon Web Services Cloud Control API User Guide. After you have // initiated a resource creation request, you can monitor the progress of your -// request by calling GetResourceRequestStatus -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) -// using the RequestToken of the ProgressEvent type returned by CreateResource. +// request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) +// using the RequestToken of the ProgressEvent type returned by CreateResource . func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput, optFns ...func(*Options)) (*CreateResourceOutput, error) { if params == nil { params = &CreateResourceInput{} @@ -40,19 +38,12 @@ type CreateResourceInput struct { // consisting of that resource's properties and their desired values. Cloud Control // API currently supports JSON as a structured data format. Specify the desired // state as one of the following: - // - // * A JSON blob - // - // * A local path containing the - // desired state in JSON data format - // - // For more information, see Composing the - // desired state of the resource - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate) + // - A JSON blob + // - A local path containing the desired state in JSON data format + // For more information, see Composing the desired state of the resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate) // in the Amazon Web Services Cloud Control API User Guide. For more information // about the properties of a specific resource, refer to the related topic for the - // resource in the Resource and property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // resource in the Resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation Users Guide. // // This member is required. @@ -63,30 +54,26 @@ type CreateResourceInput struct { // This member is required. TypeName *string - // A unique identifier to ensure the idempotency of the resource request. As a best - // practice, specify this token to ensure idempotency, so that Amazon Web Services - // Cloud Control API can accurately distinguish between request retries and new - // resource requests. You might retry a resource request to ensure that it was - // successfully received. A client token is valid for 36 hours once used. After + // A unique identifier to ensure the idempotency of the resource request. As a + // best practice, specify this token to ensure idempotency, so that Amazon Web + // Services Cloud Control API can accurately distinguish between request retries + // and new resource requests. You might retry a resource request to ensure that it + // was successfully received. A client token is valid for 36 hours once used. After // that, a resource request with the same client token is treated as a new request. // If you do not specify a client token, one is generated for inclusion in the // request. For more information, see Ensuring resource operation requests are - // unique - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) + // unique (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) // in the Amazon Web Services Cloud Control API User Guide. ClientToken *string // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // for Cloud Control API to use when performing this resource operation. The role // specified must have the permissions required for this operation. The necessary - // permissions for each event handler are defined in the handlers - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) - // section of the resource type definition schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html). - // If you do not specify a role, Cloud Control API uses a temporary session created - // using your Amazon Web Services user credentials. For more information, see - // Specifying credentials - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) + // permissions for each event handler are defined in the handlers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) + // section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // . If you do not specify a role, Cloud Control API uses a temporary session + // created using your Amazon Web Services user credentials. For more information, + // see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) // in the Amazon Web Services Cloud Control API User Guide. RoleArn *string @@ -102,9 +89,8 @@ type CreateResourceOutput struct { // Represents the current status of the resource creation request. After you have // initiated a resource creation request, you can monitor the progress of your - // request by calling GetResourceRequestStatus - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) - // using the RequestToken of the ProgressEvent returned by CreateResource. + // request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) + // using the RequestToken of the ProgressEvent returned by CreateResource . ProgressEvent *types.ProgressEvent // Metadata pertaining to the operation's result. diff --git a/service/cloudcontrol/api_op_DeleteResource.go b/service/cloudcontrol/api_op_DeleteResource.go index 2d7b1ab2940..4076f37a0e4 100644 --- a/service/cloudcontrol/api_op_DeleteResource.go +++ b/service/cloudcontrol/api_op_DeleteResource.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified resource. For details, see Deleting a resource -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html) +// Deletes the specified resource. For details, see Deleting a resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html) // in the Amazon Web Services Cloud Control API User Guide. After you have // initiated a resource deletion request, you can monitor the progress of your -// request by calling GetResourceRequestStatus -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) -// using the RequestToken of the ProgressEvent returned by DeleteResource. +// request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) +// using the RequestToken of the ProgressEvent returned by DeleteResource . func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput, optFns ...func(*Options)) (*DeleteResourceOutput, error) { if params == nil { params = &DeleteResourceInput{} @@ -43,8 +41,7 @@ type DeleteResourceInput struct { // primary identifiers (that is, one that consists of multiple resource properties // strung together), to specify the primary identifier as a string, list the // property values in the order they are specified in the primary identifier - // definition, separated by |. For more information, see Identifying resources - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) + // definition, separated by | . For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) // in the Amazon Web Services Cloud Control API User Guide. // // This member is required. @@ -55,30 +52,26 @@ type DeleteResourceInput struct { // This member is required. TypeName *string - // A unique identifier to ensure the idempotency of the resource request. As a best - // practice, specify this token to ensure idempotency, so that Amazon Web Services - // Cloud Control API can accurately distinguish between request retries and new - // resource requests. You might retry a resource request to ensure that it was - // successfully received. A client token is valid for 36 hours once used. After + // A unique identifier to ensure the idempotency of the resource request. As a + // best practice, specify this token to ensure idempotency, so that Amazon Web + // Services Cloud Control API can accurately distinguish between request retries + // and new resource requests. You might retry a resource request to ensure that it + // was successfully received. A client token is valid for 36 hours once used. After // that, a resource request with the same client token is treated as a new request. // If you do not specify a client token, one is generated for inclusion in the // request. For more information, see Ensuring resource operation requests are - // unique - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) + // unique (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) // in the Amazon Web Services Cloud Control API User Guide. ClientToken *string // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // for Cloud Control API to use when performing this resource operation. The role // specified must have the permissions required for this operation. The necessary - // permissions for each event handler are defined in the handlers - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) - // section of the resource type definition schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html). - // If you do not specify a role, Cloud Control API uses a temporary session created - // using your Amazon Web Services user credentials. For more information, see - // Specifying credentials - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) + // permissions for each event handler are defined in the handlers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) + // section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // . If you do not specify a role, Cloud Control API uses a temporary session + // created using your Amazon Web Services user credentials. For more information, + // see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) // in the Amazon Web Services Cloud Control API User Guide. RoleArn *string @@ -94,9 +87,8 @@ type DeleteResourceOutput struct { // Represents the current status of the resource deletion request. After you have // initiated a resource deletion request, you can monitor the progress of your - // request by calling GetResourceRequestStatus - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) - // using the RequestToken of the ProgressEvent returned by DeleteResource. + // request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) + // using the RequestToken of the ProgressEvent returned by DeleteResource . ProgressEvent *types.ProgressEvent // Metadata pertaining to the operation's result. diff --git a/service/cloudcontrol/api_op_GetResource.go b/service/cloudcontrol/api_op_GetResource.go index fe9c6fc4a14..e3eb7205586 100644 --- a/service/cloudcontrol/api_op_GetResource.go +++ b/service/cloudcontrol/api_op_GetResource.go @@ -12,11 +12,10 @@ import ( ) // Returns information about the current state of the specified resource. For -// details, see Reading a resource's current state -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html). -// You can use this action to return information about an existing resource in your -// account and Amazon Web Services Region, whether those resources were provisioned -// using Cloud Control API. +// details, see Reading a resource's current state (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html) +// . You can use this action to return information about an existing resource in +// your account and Amazon Web Services Region, whether those resources were +// provisioned using Cloud Control API. func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optFns ...func(*Options)) (*GetResourceOutput, error) { if params == nil { params = &GetResourceInput{} @@ -41,8 +40,7 @@ type GetResourceInput struct { // primary identifiers (that is, one that consists of multiple resource properties // strung together), to specify the primary identifier as a string, list the // property values in the order they are specified in the primary identifier - // definition, separated by |. For more information, see Identifying resources - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) + // definition, separated by | . For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) // in the Amazon Web Services Cloud Control API User Guide. // // This member is required. @@ -56,14 +54,11 @@ type GetResourceInput struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // for Cloud Control API to use when performing this resource operation. The role // specified must have the permissions required for this operation. The necessary - // permissions for each event handler are defined in the handlers - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) - // section of the resource type definition schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html). - // If you do not specify a role, Cloud Control API uses a temporary session created - // using your Amazon Web Services user credentials. For more information, see - // Specifying credentials - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) + // permissions for each event handler are defined in the handlers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) + // section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // . If you do not specify a role, Cloud Control API uses a temporary session + // created using your Amazon Web Services user credentials. For more information, + // see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) // in the Amazon Web Services Cloud Control API User Guide. RoleArn *string diff --git a/service/cloudcontrol/api_op_GetResourceRequestStatus.go b/service/cloudcontrol/api_op_GetResourceRequestStatus.go index 2d8760884a5..69efc946f6c 100644 --- a/service/cloudcontrol/api_op_GetResourceRequestStatus.go +++ b/service/cloudcontrol/api_op_GetResourceRequestStatus.go @@ -17,8 +17,7 @@ import ( ) // Returns the current status of a resource operation request. For more -// information, see Tracking the progress of resource operation requests -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-track) +// information, see Tracking the progress of resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-track) // in the Amazon Web Services Cloud Control API User Guide. func (c *Client) GetResourceRequestStatus(ctx context.Context, params *GetResourceRequestStatusInput, optFns ...func(*Options)) (*GetResourceRequestStatusOutput, error) { if params == nil { @@ -143,9 +142,10 @@ type ResourceRequestSuccessWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ResourceRequestSuccessWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ResourceRequestSuccessWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -185,9 +185,9 @@ func NewResourceRequestSuccessWaiter(client GetResourceRequestStatusAPIClient, o } } -// Wait calls the waiter function for ResourceRequestSuccess waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for ResourceRequestSuccess waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *ResourceRequestSuccessWaiter) Wait(ctx context.Context, params *GetResourceRequestStatusInput, maxWaitDur time.Duration, optFns ...func(*ResourceRequestSuccessWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/cloudcontrol/api_op_ListResourceRequests.go b/service/cloudcontrol/api_op_ListResourceRequests.go index 985c3917c78..c566f645221 100644 --- a/service/cloudcontrol/api_op_ListResourceRequests.go +++ b/service/cloudcontrol/api_op_ListResourceRequests.go @@ -14,8 +14,7 @@ import ( // Returns existing resource operation requests. This includes requests of all // status types. For more information, see Listing active resource operation -// requests -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list) +// requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list) // in the Amazon Web Services Cloud Control API User Guide. Resource operation // requests expire after 7 days. func (c *Client) ListResourceRequests(ctx context.Context, params *ListResourceRequestsInput, optFns ...func(*Options)) (*ListResourceRequestsOutput, error) { @@ -37,15 +36,15 @@ type ListResourceRequestsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. The default is 20. + // value that you can assign to the NextToken request parameter to get the next + // set of results. The default is 20 . MaxResults *int32 // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // previous response object's NextToken parameter is set to null . NextToken *string // The filter criteria to apply to the requests returned. @@ -144,8 +143,8 @@ var _ ListResourceRequestsAPIClient = (*Client)(nil) type ListResourceRequestsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. The default is 20. + // value that you can assign to the NextToken request parameter to get the next + // set of results. The default is 20 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudcontrol/api_op_ListResources.go b/service/cloudcontrol/api_op_ListResources.go index 54a63b35203..2ffdf1d7e59 100644 --- a/service/cloudcontrol/api_op_ListResources.go +++ b/service/cloudcontrol/api_op_ListResources.go @@ -13,8 +13,7 @@ import ( ) // Returns information about the specified resources. For more information, see -// Discovering resources -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html) +// Discovering resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html) // in the Amazon Web Services Cloud Control API User Guide. You can use this action // to return information about existing resources in your account and Amazon Web // Services Region, whether those resources were provisioned using Cloud Control @@ -48,7 +47,7 @@ type ListResourcesInput struct { // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // previous response object's NextToken parameter is set to null . NextToken *string // The resource model to use to select the resources to return. @@ -57,14 +56,11 @@ type ListResourcesInput struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // for Cloud Control API to use when performing this resource operation. The role // specified must have the permissions required for this operation. The necessary - // permissions for each event handler are defined in the handlers - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) - // section of the resource type definition schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html). - // If you do not specify a role, Cloud Control API uses a temporary session created - // using your Amazon Web Services user credentials. For more information, see - // Specifying credentials - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) + // permissions for each event handler are defined in the handlers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) + // section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // . If you do not specify a role, Cloud Control API uses a temporary session + // created using your Amazon Web Services user credentials. For more information, + // see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) // in the Amazon Web Services Cloud Control API User Guide. RoleArn *string diff --git a/service/cloudcontrol/api_op_UpdateResource.go b/service/cloudcontrol/api_op_UpdateResource.go index e3fdfe6fa4e..318abcdb411 100644 --- a/service/cloudcontrol/api_op_UpdateResource.go +++ b/service/cloudcontrol/api_op_UpdateResource.go @@ -12,20 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified property values in the resource. You specify your resource -// property updates as a list of patch operations contained in a JSON patch -// document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch -// (https://datatracker.ietf.org/doc/html/rfc6902) standard. For details on how -// Cloud Control API performs resource update operations, see Updating a resource -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html) +// Updates the specified property values in the resource. You specify your +// resource property updates as a list of patch operations contained in a JSON +// patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) +// Patch (https://datatracker.ietf.org/doc/html/rfc6902) standard. For details on +// how Cloud Control API performs resource update operations, see Updating a +// resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html) // in the Amazon Web Services Cloud Control API User Guide. After you have // initiated a resource update request, you can monitor the progress of your -// request by calling GetResourceRequestStatus -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) -// using the RequestToken of the ProgressEvent returned by UpdateResource. For more -// information about the properties of a specific resource, refer to the related -// topic for the resource in the Resource and property types reference -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) +// request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) +// using the RequestToken of the ProgressEvent returned by UpdateResource . For +// more information about the properties of a specific resource, refer to the +// related topic for the resource in the Resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation Users Guide. func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error) { if params == nil { @@ -51,8 +49,7 @@ type UpdateResourceInput struct { // primary identifiers (that is, one that consists of multiple resource properties // strung together), to specify the primary identifier as a string, list the // property values in the order they are specified in the primary identifier - // definition, separated by |. For more information, see Identifying resources - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) + // definition, separated by | . For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) // in the Amazon Web Services Cloud Control API User Guide. // // This member is required. @@ -60,8 +57,7 @@ type UpdateResourceInput struct { // A JavaScript Object Notation (JSON) document listing the patch operations that // represent the updates to apply to the current resource properties. For details, - // see Composing the patch document - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch) + // see Composing the patch document (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch) // in the Amazon Web Services Cloud Control API User Guide. // // This member is required. @@ -72,30 +68,26 @@ type UpdateResourceInput struct { // This member is required. TypeName *string - // A unique identifier to ensure the idempotency of the resource request. As a best - // practice, specify this token to ensure idempotency, so that Amazon Web Services - // Cloud Control API can accurately distinguish between request retries and new - // resource requests. You might retry a resource request to ensure that it was - // successfully received. A client token is valid for 36 hours once used. After + // A unique identifier to ensure the idempotency of the resource request. As a + // best practice, specify this token to ensure idempotency, so that Amazon Web + // Services Cloud Control API can accurately distinguish between request retries + // and new resource requests. You might retry a resource request to ensure that it + // was successfully received. A client token is valid for 36 hours once used. After // that, a resource request with the same client token is treated as a new request. // If you do not specify a client token, one is generated for inclusion in the // request. For more information, see Ensuring resource operation requests are - // unique - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) + // unique (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency) // in the Amazon Web Services Cloud Control API User Guide. ClientToken *string // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // for Cloud Control API to use when performing this resource operation. The role // specified must have the permissions required for this operation. The necessary - // permissions for each event handler are defined in the handlers - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) - // section of the resource type definition schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html). - // If you do not specify a role, Cloud Control API uses a temporary session created - // using your Amazon Web Services user credentials. For more information, see - // Specifying credentials - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) + // permissions for each event handler are defined in the handlers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers) + // section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // . If you do not specify a role, Cloud Control API uses a temporary session + // created using your Amazon Web Services user credentials. For more information, + // see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions) // in the Amazon Web Services Cloud Control API User Guide. RoleArn *string @@ -110,8 +102,7 @@ type UpdateResourceInput struct { type UpdateResourceOutput struct { // Represents the current status of the resource update request. Use the - // RequestToken of the ProgressEvent with GetResourceRequestStatus - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) + // RequestToken of the ProgressEvent with GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) // to return the current status of a resource operation request. ProgressEvent *types.ProgressEvent diff --git a/service/cloudcontrol/doc.go b/service/cloudcontrol/doc.go index c4814b4558e..786abf814f4 100644 --- a/service/cloudcontrol/doc.go +++ b/service/cloudcontrol/doc.go @@ -3,7 +3,7 @@ // Package cloudcontrol provides the API client, operations, and parameter types // for AWS Cloud Control API. // -// For more information about Amazon Web Services Cloud Control API, see the Amazon -// Web Services Cloud Control API User Guide -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html). +// For more information about Amazon Web Services Cloud Control API, see the +// Amazon Web Services Cloud Control API User Guide (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) +// . package cloudcontrol diff --git a/service/cloudcontrol/types/enums.go b/service/cloudcontrol/types/enums.go index 3f4f3029711..b95d9e90fe5 100644 --- a/service/cloudcontrol/types/enums.go +++ b/service/cloudcontrol/types/enums.go @@ -55,9 +55,9 @@ const ( OperationUpdate Operation = "UPDATE" ) -// Values returns all known values for Operation. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operation. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operation) Values() []Operation { return []Operation{ "CREATE", diff --git a/service/cloudcontrol/types/errors.go b/service/cloudcontrol/types/errors.go index 079c178bb8d..5b657850ec6 100644 --- a/service/cloudcontrol/types/errors.go +++ b/service/cloudcontrol/types/errors.go @@ -113,8 +113,8 @@ func (e *ConcurrentOperationException) ErrorCode() string { } func (e *ConcurrentOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource handler has returned that the downstream service generated an error -// that doesn't map to any other handler error code. +// The resource handler has returned that the downstream service generated an +// error that doesn't map to any other handler error code. type GeneralServiceException struct { Message *string @@ -221,8 +221,8 @@ func (e *InvalidCredentialsException) ErrorCode() string { } func (e *InvalidCredentialsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource handler has returned that invalid input from the user has generated -// a generic exception. +// The resource handler has returned that invalid input from the user has +// generated a generic exception. type InvalidRequestException struct { Message *string diff --git a/service/cloudcontrol/types/types.go b/service/cloudcontrol/types/types.go index 84c755317fc..518b7cf2eec 100644 --- a/service/cloudcontrol/types/types.go +++ b/service/cloudcontrol/types/types.go @@ -8,14 +8,12 @@ import ( ) // Represents the current status of a resource operation request. For more -// information, see Managing resource operation requests -// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) +// information, see Managing resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) // in the Amazon Web Services Cloud Control API User Guide. type ProgressEvent struct { - // For requests with a status of FAILED, the associated error code. For error code - // definitions, see Handler error codes - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html) + // For requests with a status of FAILED , the associated error code. For error code + // definitions, see Handler error codes (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html) // in the CloudFormation Command Line Interface User Guide for Extension // Development. ErrorCode HandlerErrorCode @@ -24,36 +22,25 @@ type ProgressEvent struct { EventTime *time.Time // The primary identifier for the resource. In some cases, the resource identifier - // may be available before the resource operation has reached a status of SUCCESS. + // may be available before the resource operation has reached a status of SUCCESS . Identifier *string // The resource operation type. Operation Operation // The current status of the resource operation request. - // - // * PENDING: The resource - // operation hasn't yet started. - // - // * IN_PROGRESS: The resource operation is - // currently in progress. - // - // * SUCCESS: The resource operation has successfully - // completed. - // - // * FAILED: The resource operation has failed. Refer to the error code - // and status message for more information. - // - // * CANCEL_IN_PROGRESS: The resource - // operation is in the process of being canceled. - // - // * CANCEL_COMPLETE: The resource - // operation has been canceled. + // - PENDING : The resource operation hasn't yet started. + // - IN_PROGRESS : The resource operation is currently in progress. + // - SUCCESS : The resource operation has successfully completed. + // - FAILED : The resource operation has failed. Refer to the error code and + // status message for more information. + // - CANCEL_IN_PROGRESS : The resource operation is in the process of being + // canceled. + // - CANCEL_COMPLETE : The resource operation has been canceled. OperationStatus OperationStatus // The unique token representing this resource operation request. Use the - // RequestToken with GetResourceRequestStatus - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) + // RequestToken with GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) // to return the current status of a resource operation request. RequestToken *string @@ -77,8 +64,7 @@ type ProgressEvent struct { type ResourceDescription struct { // The primary identifier for the resource. For more information, see Identifying - // resources - // (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) + // resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html) // in the Amazon Web Services Cloud Control API User Guide. Identifier *string @@ -92,22 +78,12 @@ type ResourceDescription struct { type ResourceRequestStatusFilter struct { // The operation statuses to include in the filter. - // - // * PENDING: The operation has - // been requested, but not yet initiated. - // - // * IN_PROGRESS: The operation is in - // progress. - // - // * SUCCESS: The operation completed. - // - // * FAILED: The operation - // failed. - // - // * CANCEL_IN_PROGRESS: The operation is in the process of being - // canceled. - // - // * CANCEL_COMPLETE: The operation has been canceled. + // - PENDING : The operation has been requested, but not yet initiated. + // - IN_PROGRESS : The operation is in progress. + // - SUCCESS : The operation completed. + // - FAILED : The operation failed. + // - CANCEL_IN_PROGRESS : The operation is in the process of being canceled. + // - CANCEL_COMPLETE : The operation has been canceled. OperationStatuses []OperationStatus // The operation types to include in the filter. diff --git a/service/clouddirectory/api_client.go b/service/clouddirectory/api_client.go index 536d00a6a98..9e7621ad5fa 100644 --- a/service/clouddirectory/api_client.go +++ b/service/clouddirectory/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/clouddirectory/api_op_AddFacetToObject.go b/service/clouddirectory/api_op_AddFacetToObject.go index 49dec327ca0..7d139ed32da 100644 --- a/service/clouddirectory/api_op_AddFacetToObject.go +++ b/service/clouddirectory/api_op_AddFacetToObject.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a new Facet to an object. An object can have more than one facet applied on -// it. +// Adds a new Facet to an object. An object can have more than one facet applied +// on it. func (c *Client) AddFacetToObject(ctx context.Context, params *AddFacetToObjectInput, optFns ...func(*Options)) (*AddFacetToObjectOutput, error) { if params == nil { params = &AddFacetToObjectInput{} @@ -31,7 +31,7 @@ func (c *Client) AddFacetToObject(ctx context.Context, params *AddFacetToObjectI type AddFacetToObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string @@ -41,8 +41,8 @@ type AddFacetToObjectInput struct { // This member is required. ObjectReference *types.ObjectReference - // Identifiers for the facet that you are adding to the object. See SchemaFacet for - // details. + // Identifiers for the facet that you are adding to the object. See SchemaFacet + // for details. // // This member is required. SchemaFacet *types.SchemaFacet diff --git a/service/clouddirectory/api_op_ApplySchema.go b/service/clouddirectory/api_op_ApplySchema.go index c1f565451c6..25adb109933 100644 --- a/service/clouddirectory/api_op_ApplySchema.go +++ b/service/clouddirectory/api_op_ApplySchema.go @@ -30,13 +30,13 @@ func (c *Client) ApplySchema(ctx context.Context, params *ApplySchemaInput, optF type ApplySchemaInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory into which - // the schema is copied. For more information, see arns. + // the schema is copied. For more information, see arns . // // This member is required. DirectoryArn *string // Published schema Amazon Resource Name (ARN) that needs to be copied. For more - // information, see arns. + // information, see arns . // // This member is required. PublishedSchemaArn *string @@ -47,11 +47,11 @@ type ApplySchemaInput struct { type ApplySchemaOutput struct { // The applied schema ARN that is associated with the copied schema in the - // Directory. You can use this ARN to describe the schema information applied on - // this directory. For more information, see arns. + // Directory . You can use this ARN to describe the schema information applied on + // this directory. For more information, see arns . AppliedSchemaArn *string - // The ARN that is associated with the Directory. For more information, see arns. + // The ARN that is associated with the Directory . For more information, see arns . DirectoryArn *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_AttachObject.go b/service/clouddirectory/api_op_AttachObject.go index 0391bd8516d..2cc4f70971e 100644 --- a/service/clouddirectory/api_op_AttachObject.go +++ b/service/clouddirectory/api_op_AttachObject.go @@ -13,10 +13,8 @@ import ( // Attaches an existing object to another object. An object can be accessed in two // ways: -// -// * Using the path -// -// * Using ObjectIdentifier +// - Using the path +// - Using ObjectIdentifier func (c *Client) AttachObject(ctx context.Context, params *AttachObjectInput, optFns ...func(*Options)) (*AttachObjectOutput, error) { if params == nil { params = &AttachObjectInput{} @@ -40,7 +38,7 @@ type AttachObjectInput struct { ChildReference *types.ObjectReference // Amazon Resource Name (ARN) that is associated with the Directory where both - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string @@ -60,7 +58,7 @@ type AttachObjectInput struct { type AttachObjectOutput struct { - // The attached ObjectIdentifier, which is the child ObjectIdentifier. + // The attached ObjectIdentifier , which is the child ObjectIdentifier . AttachedObjectIdentifier *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_AttachPolicy.go b/service/clouddirectory/api_op_AttachPolicy.go index fdefade21ce..d05bd4f7a31 100644 --- a/service/clouddirectory/api_op_AttachPolicy.go +++ b/service/clouddirectory/api_op_AttachPolicy.go @@ -31,7 +31,7 @@ func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, op type AttachPolicyInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where both - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_AttachTypedLink.go b/service/clouddirectory/api_op_AttachTypedLink.go index ee0ce9ca1b9..afee57de844 100644 --- a/service/clouddirectory/api_op_AttachTypedLink.go +++ b/service/clouddirectory/api_op_AttachTypedLink.go @@ -12,8 +12,8 @@ import ( ) // Attaches a typed link to a specified source and target object. For more -// information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) AttachTypedLink(ctx context.Context, params *AttachTypedLinkInput, optFns ...func(*Options)) (*AttachTypedLinkOutput, error) { if params == nil { params = &AttachTypedLinkInput{} diff --git a/service/clouddirectory/api_op_BatchRead.go b/service/clouddirectory/api_op_BatchRead.go index 679a11bdf85..214f3d0d3b2 100644 --- a/service/clouddirectory/api_op_BatchRead.go +++ b/service/clouddirectory/api_op_BatchRead.go @@ -29,8 +29,8 @@ func (c *Client) BatchRead(ctx context.Context, params *BatchReadInput, optFns . type BatchReadInput struct { - // The Amazon Resource Name (ARN) that is associated with the Directory. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Directory . For more + // information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_BatchWrite.go b/service/clouddirectory/api_op_BatchWrite.go index ffd70363f4b..2a08d32c785 100644 --- a/service/clouddirectory/api_op_BatchWrite.go +++ b/service/clouddirectory/api_op_BatchWrite.go @@ -30,8 +30,8 @@ func (c *Client) BatchWrite(ctx context.Context, params *BatchWriteInput, optFns type BatchWriteInput struct { - // The Amazon Resource Name (ARN) that is associated with the Directory. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Directory . For more + // information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_CreateDirectory.go b/service/clouddirectory/api_op_CreateDirectory.go index 1e53d6abbea..b322911641a 100644 --- a/service/clouddirectory/api_op_CreateDirectory.go +++ b/service/clouddirectory/api_op_CreateDirectory.go @@ -12,9 +12,8 @@ import ( // Creates a Directory by copying the published schema into the directory. A // directory cannot be created without a schema. You can also quickly create a -// directory using a managed schema, called the QuickStartSchema. For more -// information, see Managed Schema -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html) +// directory using a managed schema, called the QuickStartSchema . For more +// information, see Managed Schema (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html) // in the Amazon Cloud Directory Developer Guide. func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error) { if params == nil { @@ -33,13 +32,13 @@ func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInp type CreateDirectoryInput struct { - // The name of the Directory. Should be unique per account, per region. + // The name of the Directory . Should be unique per account, per region. // // This member is required. Name *string // The Amazon Resource Name (ARN) of the published schema that will be copied into - // the data Directory. For more information, see arns. + // the data Directory . For more information, see arns . // // This member is required. SchemaArn *string @@ -49,19 +48,19 @@ type CreateDirectoryInput struct { type CreateDirectoryOutput struct { - // The ARN of the published schema in the Directory. Once a published schema is + // The ARN of the published schema in the Directory . Once a published schema is // copied into the directory, it has its own ARN, which is referred to applied - // schema ARN. For more information, see arns. + // schema ARN. For more information, see arns . // // This member is required. AppliedSchemaArn *string - // The ARN that is associated with the Directory. For more information, see arns. + // The ARN that is associated with the Directory . For more information, see arns . // // This member is required. DirectoryArn *string - // The name of the Directory. + // The name of the Directory . // // This member is required. Name *string diff --git a/service/clouddirectory/api_op_CreateFacet.go b/service/clouddirectory/api_op_CreateFacet.go index b16d57ac18a..d80ea1d38ab 100644 --- a/service/clouddirectory/api_op_CreateFacet.go +++ b/service/clouddirectory/api_op_CreateFacet.go @@ -30,40 +30,36 @@ func (c *Client) CreateFacet(ctx context.Context, params *CreateFacetInput, optF type CreateFacetInput struct { - // The name of the Facet, which is unique for a given schema. + // The name of the Facet , which is unique for a given schema. // // This member is required. Name *string - // The schema ARN in which the new Facet will be created. For more information, see - // arns. + // The schema ARN in which the new Facet will be created. For more information, + // see arns . // // This member is required. SchemaArn *string - // The attributes that are associated with the Facet. + // The attributes that are associated with the Facet . Attributes []types.FacetAttribute // There are two different styles that you can define on any given facet, Static - // and Dynamic. For static facets, all attributes must be defined in the schema. + // and Dynamic . For static facets, all attributes must be defined in the schema. // For dynamic facets, attributes can be defined during data plane operations. FacetStyle types.FacetStyle // Specifies whether a given object created from this facet is of type node, leaf // node, policy or index. + // - Node: Can have multiple children but one parent. // - // * Node: Can have multiple children but one parent. + // - Leaf node: Cannot have children but can have multiple parents. // - // * - // Leaf node: Cannot have children but can have multiple parents. + // - Policy: Allows you to store a policy document and policy type. For more + // information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) + // . // - // * Policy: Allows - // you to store a policy document and policy type. For more information, see - // Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). - // - // * - // Index: Can be created with the Index API. + // - Index: Can be created with the Index API. ObjectType types.ObjectType noSmithyDocumentSerde diff --git a/service/clouddirectory/api_op_CreateIndex.go b/service/clouddirectory/api_op_CreateIndex.go index f3c63894e28..f3703b1f274 100644 --- a/service/clouddirectory/api_op_CreateIndex.go +++ b/service/clouddirectory/api_op_CreateIndex.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an index object. See Indexing and search -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html) +// Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html) // for more information. func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { diff --git a/service/clouddirectory/api_op_CreateObject.go b/service/clouddirectory/api_op_CreateObject.go index 37db4b49809..acbe6319e2a 100644 --- a/service/clouddirectory/api_op_CreateObject.go +++ b/service/clouddirectory/api_op_CreateObject.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an object in a Directory. Additionally attaches the object to a parent, +// Creates an object in a Directory . Additionally attaches the object to a parent, // if a parent reference and LinkName is specified. An object is simply a // collection of Facet attributes. You can also use this API call to create a // policy object, if the facet from which you create the object is a policy facet. @@ -33,7 +33,7 @@ func (c *Client) CreateObject(ctx context.Context, params *CreateObjectInput, op type CreateObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory in which - // the object will be created. For more information, see arns. + // the object will be created. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_CreateSchema.go b/service/clouddirectory/api_op_CreateSchema.go index e3c0666340d..3337fce36f8 100644 --- a/service/clouddirectory/api_op_CreateSchema.go +++ b/service/clouddirectory/api_op_CreateSchema.go @@ -12,18 +12,13 @@ import ( // Creates a new schema in a development state. A schema can exist in three // phases: -// -// * Development: This is a mutable phase of the schema. All new schemas -// are in the development phase. Once the schema is finalized, it can be -// published. -// -// * Published: Published schemas are immutable and have a version -// associated with them. -// -// * Applied: Applied schemas are mutable in a way that -// allows you to add new schema facets. You can also add new, nonrequired -// attributes to existing schema facets. You can apply only published schemas to -// directories. +// - Development: This is a mutable phase of the schema. All new schemas are in +// the development phase. Once the schema is finalized, it can be published. +// - Published: Published schemas are immutable and have a version associated +// with them. +// - Applied: Applied schemas are mutable in a way that allows you to add new +// schema facets. You can also add new, nonrequired attributes to existing schema +// facets. You can apply only published schemas to directories. func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error) { if params == nil { params = &CreateSchemaInput{} @@ -53,7 +48,7 @@ type CreateSchemaInput struct { type CreateSchemaOutput struct { // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . SchemaArn *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_CreateTypedLinkFacet.go b/service/clouddirectory/api_op_CreateTypedLinkFacet.go index 16caa8297d3..2174d4768ab 100644 --- a/service/clouddirectory/api_op_CreateTypedLinkFacet.go +++ b/service/clouddirectory/api_op_CreateTypedLinkFacet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a TypedLinkFacet. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// Creates a TypedLinkFacet . For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) CreateTypedLinkFacet(ctx context.Context, params *CreateTypedLinkFacetInput, optFns ...func(*Options)) (*CreateTypedLinkFacetOutput, error) { if params == nil { params = &CreateTypedLinkFacetInput{} @@ -36,7 +36,7 @@ type CreateTypedLinkFacetInput struct { Facet *types.TypedLinkFacet // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_DeleteFacet.go b/service/clouddirectory/api_op_DeleteFacet.go index 1717ada6f96..d725e54156b 100644 --- a/service/clouddirectory/api_op_DeleteFacet.go +++ b/service/clouddirectory/api_op_DeleteFacet.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a given Facet. All attributes and Rules that are associated with the +// Deletes a given Facet . All attributes and Rule s that are associated with the // facet will be deleted. Only development schema facets are allowed deletion. func (c *Client) DeleteFacet(ctx context.Context, params *DeleteFacetInput, optFns ...func(*Options)) (*DeleteFacetOutput, error) { if params == nil { @@ -34,8 +34,8 @@ type DeleteFacetInput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) that is associated with the Facet. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Facet . For more + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_DeleteObject.go b/service/clouddirectory/api_op_DeleteObject.go index 0e7b2ada38b..6a56a228de8 100644 --- a/service/clouddirectory/api_op_DeleteObject.go +++ b/service/clouddirectory/api_op_DeleteObject.go @@ -14,8 +14,8 @@ import ( // Deletes an object and its associated attributes. Only objects with no children // and no parents can be deleted. The maximum number of attributes that can be // deleted during an object deletion is 30. For more information, see Amazon Cloud -// Directory Limits -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html). +// Directory Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) +// . func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error) { if params == nil { params = &DeleteObjectInput{} @@ -34,7 +34,7 @@ func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, op type DeleteObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_DeleteSchema.go b/service/clouddirectory/api_op_DeleteSchema.go index 0de1ef23452..9ce5bf0113f 100644 --- a/service/clouddirectory/api_op_DeleteSchema.go +++ b/service/clouddirectory/api_op_DeleteSchema.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a given schema. Schemas in a development and published state can only be -// deleted. +// Deletes a given schema. Schemas in a development and published state can only +// be deleted. func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error) { if params == nil { params = &DeleteSchemaInput{} @@ -30,7 +30,7 @@ func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, op type DeleteSchemaInput struct { // The Amazon Resource Name (ARN) of the development schema. For more information, - // see arns. + // see arns . // // This member is required. SchemaArn *string @@ -41,7 +41,7 @@ type DeleteSchemaInput struct { type DeleteSchemaOutput struct { // The input ARN that is returned as part of the response. For more information, - // see arns. + // see arns . SchemaArn *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_DeleteTypedLinkFacet.go b/service/clouddirectory/api_op_DeleteTypedLinkFacet.go index 2c648a9dcba..db797f69af9 100644 --- a/service/clouddirectory/api_op_DeleteTypedLinkFacet.go +++ b/service/clouddirectory/api_op_DeleteTypedLinkFacet.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a TypedLinkFacet. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// Deletes a TypedLinkFacet . For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) DeleteTypedLinkFacet(ctx context.Context, params *DeleteTypedLinkFacetInput, optFns ...func(*Options)) (*DeleteTypedLinkFacetOutput, error) { if params == nil { params = &DeleteTypedLinkFacetInput{} @@ -35,7 +35,7 @@ type DeleteTypedLinkFacetInput struct { Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_DetachObject.go b/service/clouddirectory/api_op_DetachObject.go index af9504cacbb..78679cea518 100644 --- a/service/clouddirectory/api_op_DetachObject.go +++ b/service/clouddirectory/api_op_DetachObject.go @@ -31,7 +31,7 @@ func (c *Client) DetachObject(ctx context.Context, params *DetachObjectInput, op type DetachObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_DetachPolicy.go b/service/clouddirectory/api_op_DetachPolicy.go index 41aa37e4850..fe2edcaa23f 100644 --- a/service/clouddirectory/api_op_DetachPolicy.go +++ b/service/clouddirectory/api_op_DetachPolicy.go @@ -30,7 +30,7 @@ func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, op type DetachPolicyInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where both - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_DetachTypedLink.go b/service/clouddirectory/api_op_DetachTypedLink.go index 73124f1b700..9b105c6e72b 100644 --- a/service/clouddirectory/api_op_DetachTypedLink.go +++ b/service/clouddirectory/api_op_DetachTypedLink.go @@ -12,8 +12,8 @@ import ( ) // Detaches a typed link from a specified source and target object. For more -// information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) DetachTypedLink(ctx context.Context, params *DetachTypedLinkInput, optFns ...func(*Options)) (*DetachTypedLinkOutput, error) { if params == nil { params = &DetachTypedLinkInput{} diff --git a/service/clouddirectory/api_op_DisableDirectory.go b/service/clouddirectory/api_op_DisableDirectory.go index bc97fb884c4..d01001e986f 100644 --- a/service/clouddirectory/api_op_DisableDirectory.go +++ b/service/clouddirectory/api_op_DisableDirectory.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables the specified directory. Disabled directories cannot be read or written -// to. Only enabled directories can be disabled. Disabled directories may be -// reenabled. +// Disables the specified directory. Disabled directories cannot be read or +// written to. Only enabled directories can be disabled. Disabled directories may +// be reenabled. func (c *Client) DisableDirectory(ctx context.Context, params *DisableDirectoryInput, optFns ...func(*Options)) (*DisableDirectoryOutput, error) { if params == nil { params = &DisableDirectoryInput{} diff --git a/service/clouddirectory/api_op_GetFacet.go b/service/clouddirectory/api_op_GetFacet.go index 30280938780..779f1d8515c 100644 --- a/service/clouddirectory/api_op_GetFacet.go +++ b/service/clouddirectory/api_op_GetFacet.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. -// You can call this on all kinds of schema facets -- published, development, or -// applied. +// Gets details of the Facet , such as facet name, attributes, Rule s, or +// ObjectType . You can call this on all kinds of schema facets -- published, +// development, or applied. func (c *Client) GetFacet(ctx context.Context, params *GetFacetInput, optFns ...func(*Options)) (*GetFacetOutput, error) { if params == nil { params = &GetFacetInput{} @@ -36,8 +36,8 @@ type GetFacetInput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) that is associated with the Facet. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Facet . For more + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_GetLinkAttributes.go b/service/clouddirectory/api_op_GetLinkAttributes.go index edfba39531b..239fef0ecf1 100644 --- a/service/clouddirectory/api_op_GetLinkAttributes.go +++ b/service/clouddirectory/api_op_GetLinkAttributes.go @@ -35,8 +35,8 @@ type GetLinkAttributesInput struct { AttributeNames []string // The Amazon Resource Name (ARN) that is associated with the Directory where the - // typed link resides. For more information, see arns or Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // typed link resides. For more information, see arns or Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_GetObjectAttributes.go b/service/clouddirectory/api_op_GetObjectAttributes.go index 7ad098e3132..490b1dcbbd3 100644 --- a/service/clouddirectory/api_op_GetObjectAttributes.go +++ b/service/clouddirectory/api_op_GetObjectAttributes.go @@ -45,8 +45,8 @@ type GetObjectAttributesInput struct { // This member is required. ObjectReference *types.ObjectReference - // Identifier for the facet whose attributes will be retrieved. See SchemaFacet for - // details. + // Identifier for the facet whose attributes will be retrieved. See SchemaFacet + // for details. // // This member is required. SchemaFacet *types.SchemaFacet diff --git a/service/clouddirectory/api_op_GetSchemaAsJson.go b/service/clouddirectory/api_op_GetSchemaAsJson.go index 01b390dafef..40dff95a856 100644 --- a/service/clouddirectory/api_op_GetSchemaAsJson.go +++ b/service/clouddirectory/api_op_GetSchemaAsJson.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a JSON representation of the schema. See JSON Schema Format -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) +// Retrieves a JSON representation of the schema. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) // for more information. func (c *Client) GetSchemaAsJson(ctx context.Context, params *GetSchemaAsJsonInput, optFns ...func(*Options)) (*GetSchemaAsJsonOutput, error) { if params == nil { diff --git a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go index 0732dbe03d8..3c0078e95e0 100644 --- a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go +++ b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the identity attribute order for a specific TypedLinkFacet. For more -// information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// Returns the identity attribute order for a specific TypedLinkFacet . For more +// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) GetTypedLinkFacetInformation(ctx context.Context, params *GetTypedLinkFacetInformationInput, optFns ...func(*Options)) (*GetTypedLinkFacetInformationOutput, error) { if params == nil { params = &GetTypedLinkFacetInformationInput{} @@ -36,7 +36,7 @@ type GetTypedLinkFacetInformationInput struct { Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string @@ -53,8 +53,8 @@ type GetTypedLinkFacetInformationOutput struct { // that do not have a range specified are presumed to match the entire range. // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. For more information - // about identity attributes, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // about identity attributes, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . IdentityAttributeOrder []string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_ListAppliedSchemaArns.go b/service/clouddirectory/api_op_ListAppliedSchemaArns.go index 9be60f1462c..e283813eec9 100644 --- a/service/clouddirectory/api_op_ListAppliedSchemaArns.go +++ b/service/clouddirectory/api_op_ListAppliedSchemaArns.go @@ -41,8 +41,8 @@ type ListAppliedSchemaArnsInput struct { // The pagination token. NextToken *string - // The response for ListAppliedSchemaArns when this parameter is used will list all - // minor version ARNs for a major version. + // The response for ListAppliedSchemaArns when this parameter is used will list + // all minor version ARNs for a major version. SchemaArn *string noSmithyDocumentSerde diff --git a/service/clouddirectory/api_op_ListAttachedIndices.go b/service/clouddirectory/api_op_ListAttachedIndices.go index fb32f606b88..e31da9b94db 100644 --- a/service/clouddirectory/api_op_ListAttachedIndices.go +++ b/service/clouddirectory/api_op_ListAttachedIndices.go @@ -129,8 +129,8 @@ func (c *Client) addOperationListAttachedIndicesMiddlewares(stack *middleware.St return nil } -// ListAttachedIndicesAPIClient is a client that implements the ListAttachedIndices -// operation. +// ListAttachedIndicesAPIClient is a client that implements the +// ListAttachedIndices operation. type ListAttachedIndicesAPIClient interface { ListAttachedIndices(context.Context, *ListAttachedIndicesInput, ...func(*Options)) (*ListAttachedIndicesOutput, error) } diff --git a/service/clouddirectory/api_op_ListFacetAttributes.go b/service/clouddirectory/api_op_ListFacetAttributes.go index d25e65953b6..925eb45d839 100644 --- a/service/clouddirectory/api_op_ListFacetAttributes.go +++ b/service/clouddirectory/api_op_ListFacetAttributes.go @@ -126,8 +126,8 @@ func (c *Client) addOperationListFacetAttributesMiddlewares(stack *middleware.St return nil } -// ListFacetAttributesAPIClient is a client that implements the ListFacetAttributes -// operation. +// ListFacetAttributesAPIClient is a client that implements the +// ListFacetAttributes operation. type ListFacetAttributesAPIClient interface { ListFacetAttributes(context.Context, *ListFacetAttributesInput, ...func(*Options)) (*ListFacetAttributesOutput, error) } diff --git a/service/clouddirectory/api_op_ListIncomingTypedLinks.go b/service/clouddirectory/api_op_ListIncomingTypedLinks.go index 2e5b59b0867..d7c68a10c42 100644 --- a/service/clouddirectory/api_op_ListIncomingTypedLinks.go +++ b/service/clouddirectory/api_op_ListIncomingTypedLinks.go @@ -13,8 +13,8 @@ import ( // Returns a paginated list of all the incoming TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity -// attributes. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) ListIncomingTypedLinks(ctx context.Context, params *ListIncomingTypedLinksInput, optFns ...func(*Options)) (*ListIncomingTypedLinksOutput, error) { if params == nil { params = &ListIncomingTypedLinksInput{} @@ -32,8 +32,8 @@ func (c *Client) ListIncomingTypedLinks(ctx context.Context, params *ListIncomin type ListIncomingTypedLinksInput struct { - // The Amazon Resource Name (ARN) of the directory where you want to list the typed - // links. + // The Amazon Resource Name (ARN) of the directory where you want to list the + // typed links. // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListIndex.go b/service/clouddirectory/api_op_ListIndex.go index 041613af6f5..bcdb28344a7 100644 --- a/service/clouddirectory/api_op_ListIndex.go +++ b/service/clouddirectory/api_op_ListIndex.go @@ -43,9 +43,9 @@ type ListIndexInput struct { // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel - // The maximum number of objects in a single page to retrieve from the index during - // a request. For more information, see Amazon Cloud Directory Limits - // (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html). + // The maximum number of objects in a single page to retrieve from the index + // during a request. For more information, see Amazon Cloud Directory Limits (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) + // . MaxResults *int32 // The pagination token. @@ -143,9 +143,9 @@ var _ ListIndexAPIClient = (*Client)(nil) // ListIndexPaginatorOptions is the paginator options for ListIndex type ListIndexPaginatorOptions struct { - // The maximum number of objects in a single page to retrieve from the index during - // a request. For more information, see Amazon Cloud Directory Limits - // (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html). + // The maximum number of objects in a single page to retrieve from the index + // during a request. For more information, see Amazon Cloud Directory Limits (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/clouddirectory/api_op_ListObjectAttributes.go b/service/clouddirectory/api_op_ListObjectAttributes.go index a3b48461d33..8c13d6018d9 100644 --- a/service/clouddirectory/api_op_ListObjectAttributes.go +++ b/service/clouddirectory/api_op_ListObjectAttributes.go @@ -31,7 +31,7 @@ func (c *Client) ListObjectAttributes(ctx context.Context, params *ListObjectAtt type ListObjectAttributesInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListObjectChildren.go b/service/clouddirectory/api_op_ListObjectChildren.go index 7378dd5c446..eb11e81a61c 100644 --- a/service/clouddirectory/api_op_ListObjectChildren.go +++ b/service/clouddirectory/api_op_ListObjectChildren.go @@ -32,7 +32,7 @@ func (c *Client) ListObjectChildren(ctx context.Context, params *ListObjectChild type ListObjectChildrenInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListObjectParentPaths.go b/service/clouddirectory/api_op_ListObjectParentPaths.go index bcf6b6b5440..db964493c2e 100644 --- a/service/clouddirectory/api_op_ListObjectParentPaths.go +++ b/service/clouddirectory/api_op_ListObjectParentPaths.go @@ -14,14 +14,13 @@ import ( // Retrieves all available parent paths for any object type such as node, leaf // node, policy node, and index node objects. For more information about objects, -// see Directory Structure -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). -// Use this API to evaluate all parents for an object. The call returns all objects -// from the root of the directory up to the requested object. The API returns the -// number of paths based on user-defined MaxResults, in case there are multiple -// paths to the parent. The order of the paths and nodes returned is consistent -// among multiple API calls unless the objects are deleted or moved. Paths not -// leading to the directory root are ignored from the target object. +// see Directory Structure (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html) +// . Use this API to evaluate all parents for an object. The call returns all +// objects from the root of the directory up to the requested object. The API +// returns the number of paths based on user-defined MaxResults , in case there are +// multiple paths to the parent. The order of the paths and nodes returned is +// consistent among multiple API calls unless the objects are deleted or moved. +// Paths not leading to the directory root are ignored from the target object. func (c *Client) ListObjectParentPaths(ctx context.Context, params *ListObjectParentPathsInput, optFns ...func(*Options)) (*ListObjectParentPathsOutput, error) { if params == nil { params = &ListObjectParentPathsInput{} diff --git a/service/clouddirectory/api_op_ListObjectParents.go b/service/clouddirectory/api_op_ListObjectParents.go index 25313e29e2b..61168433a74 100644 --- a/service/clouddirectory/api_op_ListObjectParents.go +++ b/service/clouddirectory/api_op_ListObjectParents.go @@ -32,7 +32,7 @@ func (c *Client) ListObjectParents(ctx context.Context, params *ListObjectParent type ListObjectParentsInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string @@ -47,8 +47,8 @@ type ListObjectParentsInput struct { // object is reflected in a subsequent read operation of that same object. ConsistencyLevel types.ConsistencyLevel - // When set to True, returns all ListObjectParentsResponse$ParentLinks. There could - // be multiple links between a parent-child pair. + // When set to True, returns all ListObjectParentsResponse$ParentLinks . There + // could be multiple links between a parent-child pair. IncludeAllLinksToEachParent bool // The maximum number of items to be retrieved in a single call. This is an diff --git a/service/clouddirectory/api_op_ListObjectPolicies.go b/service/clouddirectory/api_op_ListObjectPolicies.go index 8eabb2c7ad3..ca2d7ce2c3d 100644 --- a/service/clouddirectory/api_op_ListObjectPolicies.go +++ b/service/clouddirectory/api_op_ListObjectPolicies.go @@ -31,7 +31,7 @@ func (c *Client) ListObjectPolicies(ctx context.Context, params *ListObjectPolic type ListObjectPoliciesInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string @@ -57,7 +57,7 @@ type ListObjectPoliciesInput struct { type ListObjectPoliciesOutput struct { - // A list of policy ObjectIdentifiers, that are attached to the object. + // A list of policy ObjectIdentifiers , that are attached to the object. AttachedPolicyIds []string // The pagination token. diff --git a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go index d20db28226d..e78a3e96f0b 100644 --- a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go +++ b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go @@ -13,8 +13,8 @@ import ( // Returns a paginated list of all the outgoing TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity -// attributes. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) ListOutgoingTypedLinks(ctx context.Context, params *ListOutgoingTypedLinksInput, optFns ...func(*Options)) (*ListOutgoingTypedLinksOutput, error) { if params == nil { params = &ListOutgoingTypedLinksInput{} @@ -32,8 +32,8 @@ func (c *Client) ListOutgoingTypedLinks(ctx context.Context, params *ListOutgoin type ListOutgoingTypedLinksInput struct { - // The Amazon Resource Name (ARN) of the directory where you want to list the typed - // links. + // The Amazon Resource Name (ARN) of the directory where you want to list the + // typed links. // // This member is required. DirectoryArn *string @@ -51,8 +51,8 @@ type ListOutgoingTypedLinksInput struct { // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []types.TypedLinkAttributeRange - // Filters are interpreted in the order of the attributes defined on the typed link - // facet, not the order they are supplied to any API calls. + // Filters are interpreted in the order of the attributes defined on the typed + // link facet, not the order they are supplied to any API calls. FilterTypedLink *types.TypedLinkSchemaAndFacetName // The maximum number of results to retrieve. diff --git a/service/clouddirectory/api_op_ListPolicyAttachments.go b/service/clouddirectory/api_op_ListPolicyAttachments.go index 88ba5e9f143..783fa9e116f 100644 --- a/service/clouddirectory/api_op_ListPolicyAttachments.go +++ b/service/clouddirectory/api_op_ListPolicyAttachments.go @@ -31,7 +31,7 @@ func (c *Client) ListPolicyAttachments(ctx context.Context, params *ListPolicyAt type ListPolicyAttachmentsInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where - // objects reside. For more information, see arns. + // objects reside. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListPublishedSchemaArns.go b/service/clouddirectory/api_op_ListPublishedSchemaArns.go index ff1a652645e..d671d94d8c3 100644 --- a/service/clouddirectory/api_op_ListPublishedSchemaArns.go +++ b/service/clouddirectory/api_op_ListPublishedSchemaArns.go @@ -12,7 +12,7 @@ import ( ) // Lists the major version families of each published schema. If a major version -// ARN is provided as SchemaArn, the minor version revisions in that family are +// ARN is provided as SchemaArn , the minor version revisions in that family are // listed instead. func (c *Client) ListPublishedSchemaArns(ctx context.Context, params *ListPublishedSchemaArnsInput, optFns ...func(*Options)) (*ListPublishedSchemaArnsOutput, error) { if params == nil { diff --git a/service/clouddirectory/api_op_ListTagsForResource.go b/service/clouddirectory/api_op_ListTagsForResource.go index 1a8f3f7c317..62eb8d545b0 100644 --- a/service/clouddirectory/api_op_ListTagsForResource.go +++ b/service/clouddirectory/api_op_ListTagsForResource.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns tags for a resource. Tagging is currently supported only for directories -// with a limit of 50 tags per directory. All 50 tags are returned for a given -// directory with this API call. +// Returns tags for a resource. Tagging is currently supported only for +// directories with a limit of 50 tags per directory. All 50 tags are returned for +// a given directory with this API call. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -38,8 +38,8 @@ type ListTagsForResourceInput struct { // This member is required. ResourceArn *string - // The MaxResults parameter sets the maximum number of results returned in a single - // page. This is for future use and is not supported currently. + // The MaxResults parameter sets the maximum number of results returned in a + // single page. This is for future use and is not supported currently. MaxResults *int32 // The pagination token. This is for future use. Currently pagination is not @@ -127,8 +127,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -138,8 +138,8 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) // ListTagsForResourcePaginatorOptions is the paginator options for // ListTagsForResource type ListTagsForResourcePaginatorOptions struct { - // The MaxResults parameter sets the maximum number of results returned in a single - // page. This is for future use and is not supported currently. + // The MaxResults parameter sets the maximum number of results returned in a + // single page. This is for future use and is not supported currently. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go index 6ed5b1573c9..3190655c5b5 100644 --- a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go +++ b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go @@ -13,8 +13,8 @@ import ( ) // Returns a paginated list of all attribute definitions for a particular -// TypedLinkFacet. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// TypedLinkFacet . For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) ListTypedLinkFacetAttributes(ctx context.Context, params *ListTypedLinkFacetAttributesInput, optFns ...func(*Options)) (*ListTypedLinkFacetAttributesOutput, error) { if params == nil { params = &ListTypedLinkFacetAttributesInput{} @@ -38,7 +38,7 @@ type ListTypedLinkFacetAttributesInput struct { Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_ListTypedLinkFacetNames.go b/service/clouddirectory/api_op_ListTypedLinkFacetNames.go index 3d0ea4849f2..0fff749eb56 100644 --- a/service/clouddirectory/api_op_ListTypedLinkFacetNames.go +++ b/service/clouddirectory/api_op_ListTypedLinkFacetNames.go @@ -12,8 +12,8 @@ import ( ) // Returns a paginated list of TypedLink facet names for a particular schema. For -// more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) ListTypedLinkFacetNames(ctx context.Context, params *ListTypedLinkFacetNamesInput, optFns ...func(*Options)) (*ListTypedLinkFacetNamesOutput, error) { if params == nil { params = &ListTypedLinkFacetNamesInput{} @@ -32,7 +32,7 @@ func (c *Client) ListTypedLinkFacetNames(ctx context.Context, params *ListTypedL type ListTypedLinkFacetNamesInput struct { // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_LookupPolicy.go b/service/clouddirectory/api_op_LookupPolicy.go index 19838a39af6..a14c7364f3c 100644 --- a/service/clouddirectory/api_op_LookupPolicy.go +++ b/service/clouddirectory/api_op_LookupPolicy.go @@ -16,9 +16,9 @@ import ( // there are no policies present, an empty list is returned. If policies are // present, and if some objects don't have the policies attached, it returns the // ObjectIdentifier for such objects. If policies are present, it returns -// ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root -// from the target object are ignored. For more information, see Policies -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). +// ObjectIdentifier , policyId , and policyType . Paths that don't lead to the root +// from the target object are ignored. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) +// . func (c *Client) LookupPolicy(ctx context.Context, params *LookupPolicyInput, optFns ...func(*Options)) (*LookupPolicyOutput, error) { if params == nil { params = &LookupPolicyInput{} @@ -36,8 +36,8 @@ func (c *Client) LookupPolicy(ctx context.Context, params *LookupPolicyInput, op type LookupPolicyInput struct { - // The Amazon Resource Name (ARN) that is associated with the Directory. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Directory . For more + // information, see arns . // // This member is required. DirectoryArn *string @@ -62,9 +62,9 @@ type LookupPolicyOutput struct { // The pagination token. NextToken *string - // Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, - // and PolicyType. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + // Provides list of path to policies. Policies contain PolicyId , ObjectIdentifier + // , and PolicyType . For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) + // . PolicyToPathList []types.PolicyToPath // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_PublishSchema.go b/service/clouddirectory/api_op_PublishSchema.go index d4658ec4b1a..aaedc02da57 100644 --- a/service/clouddirectory/api_op_PublishSchema.go +++ b/service/clouddirectory/api_op_PublishSchema.go @@ -30,7 +30,7 @@ func (c *Client) PublishSchema(ctx context.Context, params *PublishSchemaInput, type PublishSchemaInput struct { // The Amazon Resource Name (ARN) that is associated with the development schema. - // For more information, see arns. + // For more information, see arns . // // This member is required. DevelopmentSchemaArn *string @@ -55,7 +55,7 @@ type PublishSchemaInput struct { type PublishSchemaOutput struct { // The ARN that is associated with the published schema. For more information, see - // arns. + // arns . PublishedSchemaArn *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_PutSchemaFromJson.go b/service/clouddirectory/api_op_PutSchemaFromJson.go index 91ad1e8ba65..a82347bc45a 100644 --- a/service/clouddirectory/api_op_PutSchemaFromJson.go +++ b/service/clouddirectory/api_op_PutSchemaFromJson.go @@ -11,8 +11,7 @@ import ( ) // Allows a schema to be updated using JSON upload. Only available for development -// schemas. See JSON Schema Format -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) +// schemas. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) // for more information. func (c *Client) PutSchemaFromJson(ctx context.Context, params *PutSchemaFromJsonInput, optFns ...func(*Options)) (*PutSchemaFromJsonOutput, error) { if params == nil { diff --git a/service/clouddirectory/api_op_UpdateFacet.go b/service/clouddirectory/api_op_UpdateFacet.go index 9445c062f30..59a8d33d03b 100644 --- a/service/clouddirectory/api_op_UpdateFacet.go +++ b/service/clouddirectory/api_op_UpdateFacet.go @@ -12,14 +12,9 @@ import ( ) // Does the following: -// -// * Adds new Attributes, Rules, or ObjectTypes. -// -// * Updates -// existing Attributes, Rules, or ObjectTypes. -// -// * Deletes existing Attributes, -// Rules, or ObjectTypes. +// - Adds new Attributes , Rules , or ObjectTypes . +// - Updates existing Attributes , Rules , or ObjectTypes . +// - Deletes existing Attributes , Rules , or ObjectTypes . func (c *Client) UpdateFacet(ctx context.Context, params *UpdateFacetInput, optFns ...func(*Options)) (*UpdateFacetOutput, error) { if params == nil { params = &UpdateFacetInput{} @@ -42,14 +37,14 @@ type UpdateFacetInput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) that is associated with the Facet. For more - // information, see arns. + // The Amazon Resource Name (ARN) that is associated with the Facet . For more + // information, see arns . // // This member is required. SchemaArn *string - // List of attributes that need to be updated in a given schema Facet. Each - // attribute is followed by AttributeAction, which specifies the type of update + // List of attributes that need to be updated in a given schema Facet . Each + // attribute is followed by AttributeAction , which specifies the type of update // operation to perform. AttributeUpdates []types.FacetAttributeUpdate diff --git a/service/clouddirectory/api_op_UpdateLinkAttributes.go b/service/clouddirectory/api_op_UpdateLinkAttributes.go index 5f64543989e..393123bc83b 100644 --- a/service/clouddirectory/api_op_UpdateLinkAttributes.go +++ b/service/clouddirectory/api_op_UpdateLinkAttributes.go @@ -13,7 +13,7 @@ import ( // Updates a given typed link’s attributes. Attributes to be updated must not // contribute to the typed link’s identity, as defined by its -// IdentityAttributeOrder. +// IdentityAttributeOrder . func (c *Client) UpdateLinkAttributes(ctx context.Context, params *UpdateLinkAttributesInput, optFns ...func(*Options)) (*UpdateLinkAttributesOutput, error) { if params == nil { params = &UpdateLinkAttributesInput{} @@ -37,8 +37,8 @@ type UpdateLinkAttributesInput struct { AttributeUpdates []types.LinkAttributeUpdate // The Amazon Resource Name (ARN) that is associated with the Directory where the - // updated typed link resides. For more information, see arns or Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // updated typed link resides. For more information, see arns or Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_UpdateObjectAttributes.go b/service/clouddirectory/api_op_UpdateObjectAttributes.go index 380202a6701..a0a4f88738f 100644 --- a/service/clouddirectory/api_op_UpdateObjectAttributes.go +++ b/service/clouddirectory/api_op_UpdateObjectAttributes.go @@ -35,7 +35,7 @@ type UpdateObjectAttributesInput struct { AttributeUpdates []types.ObjectAttributeUpdate // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns. + // object resides. For more information, see arns . // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_UpdateSchema.go b/service/clouddirectory/api_op_UpdateSchema.go index 0a2b54142bd..3ee8f7bdaee 100644 --- a/service/clouddirectory/api_op_UpdateSchema.go +++ b/service/clouddirectory/api_op_UpdateSchema.go @@ -35,7 +35,7 @@ type UpdateSchemaInput struct { Name *string // The Amazon Resource Name (ARN) of the development schema. For more information, - // see arns. + // see arns . // // This member is required. SchemaArn *string @@ -46,7 +46,7 @@ type UpdateSchemaInput struct { type UpdateSchemaOutput struct { // The ARN that is associated with the updated schema. For more information, see - // arns. + // arns . SchemaArn *string // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_UpdateTypedLinkFacet.go b/service/clouddirectory/api_op_UpdateTypedLinkFacet.go index cc800a19aba..558ffb3c738 100644 --- a/service/clouddirectory/api_op_UpdateTypedLinkFacet.go +++ b/service/clouddirectory/api_op_UpdateTypedLinkFacet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a TypedLinkFacet. For more information, see Typed Links -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). +// Updates a TypedLinkFacet . For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) +// . func (c *Client) UpdateTypedLinkFacet(ctx context.Context, params *UpdateTypedLinkFacetInput, optFns ...func(*Options)) (*UpdateTypedLinkFacetOutput, error) { if params == nil { params = &UpdateTypedLinkFacetInput{} @@ -42,8 +42,8 @@ type UpdateTypedLinkFacetInput struct { // that do not have a range specified are presumed to match the entire range. // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. For more information - // about identity attributes, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // about identity attributes, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . // // This member is required. IdentityAttributeOrder []string @@ -54,7 +54,7 @@ type UpdateTypedLinkFacetInput struct { Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string diff --git a/service/clouddirectory/api_op_UpgradeAppliedSchema.go b/service/clouddirectory/api_op_UpgradeAppliedSchema.go index 290aba3b3c4..1371aba03f5 100644 --- a/service/clouddirectory/api_op_UpgradeAppliedSchema.go +++ b/service/clouddirectory/api_op_UpgradeAppliedSchema.go @@ -11,7 +11,7 @@ import ( ) // Upgrades a single directory in-place using the PublishedSchemaArn with schema -// updates found in MinorVersion. Backwards-compatible minor version upgrades are +// updates found in MinorVersion . Backwards-compatible minor version upgrades are // instantaneously available for readers on all objects in the directory. Note: // This is a synchronous API call and upgrades only one schema on a given directory // per call. To upgrade multiple directories from one schema, you would need to diff --git a/service/clouddirectory/api_op_UpgradePublishedSchema.go b/service/clouddirectory/api_op_UpgradePublishedSchema.go index 481dd505e5c..84c0b80929e 100644 --- a/service/clouddirectory/api_op_UpgradePublishedSchema.go +++ b/service/clouddirectory/api_op_UpgradePublishedSchema.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Upgrades a published schema under a new minor version revision using the current -// contents of DevelopmentSchemaArn. +// Upgrades a published schema under a new minor version revision using the +// current contents of DevelopmentSchemaArn . func (c *Client) UpgradePublishedSchema(ctx context.Context, params *UpgradePublishedSchemaInput, optFns ...func(*Options)) (*UpgradePublishedSchemaOutput, error) { if params == nil { params = &UpgradePublishedSchemaInput{} diff --git a/service/clouddirectory/doc.go b/service/clouddirectory/doc.go index 2b6d6b0938e..fce3f89f7d3 100644 --- a/service/clouddirectory/doc.go +++ b/service/clouddirectory/doc.go @@ -9,6 +9,6 @@ // operations that you can call programmatically and includes detailed information // on data types and errors. For information about Cloud Directory features, see // AWS Directory Service (https://aws.amazon.com/directoryservice/) and the Amazon -// Cloud Directory Developer Guide -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html). +// Cloud Directory Developer Guide (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html) +// . package clouddirectory diff --git a/service/clouddirectory/types/enums.go b/service/clouddirectory/types/enums.go index ec9f578e979..3c679327cbe 100644 --- a/service/clouddirectory/types/enums.go +++ b/service/clouddirectory/types/enums.go @@ -207,9 +207,9 @@ const ( RangeModeExclusive RangeMode = "EXCLUSIVE" ) -// Values returns all known values for RangeMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RangeMode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RangeMode) Values() []RangeMode { return []RangeMode{ "FIRST", diff --git a/service/clouddirectory/types/errors.go b/service/clouddirectory/types/errors.go index e8d09cf8f9a..2aaee325ee2 100644 --- a/service/clouddirectory/types/errors.go +++ b/service/clouddirectory/types/errors.go @@ -7,9 +7,9 @@ import ( smithy "github.com/aws/smithy-go" ) -// Access denied or directory not found. Either you don't have permissions for this -// directory or the directory does not exist. Try calling ListDirectories and check -// your permissions. +// Access denied or directory not found. Either you don't have permissions for +// this directory or the directory does not exist. Try calling ListDirectories and +// check your permissions. type AccessDeniedException struct { Message *string @@ -90,8 +90,8 @@ func (e *CannotListParentOfRootException) ErrorCode() string { } func (e *CannotListParentOfRootException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that a Directory could not be created due to a naming conflict. Choose -// a different name and try again. +// Indicates that a Directory could not be created due to a naming conflict. +// Choose a different name and try again. type DirectoryAlreadyExistsException struct { Message *string @@ -302,9 +302,9 @@ func (e *FacetValidationException) ErrorCode() string { } func (e *FacetValidationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates a failure occurred while performing a check for backward compatibility -// between the specified schema and the schema that is currently applied to the -// directory. +// Indicates a failure occurred while performing a check for backward +// compatibility between the specified schema and the schema that is currently +// applied to the directory. type IncompatibleSchemaException struct { Message *string @@ -359,9 +359,8 @@ func (e *IndexedAttributeMissingException) ErrorFault() smithy.ErrorFault { retu // Indicates a problem that must be resolved by Amazon Web Services. This might be // a transient error in which case you can retry your request until it succeeds. -// Otherwise, go to the AWS Service Health Dashboard -// (http://status.aws.amazon.com/) site to see if there are any operational issues -// with the service. +// Otherwise, go to the AWS Service Health Dashboard (http://status.aws.amazon.com/) +// site to see if there are any operational issues with the service. type InternalServiceException struct { Message *string @@ -573,8 +572,7 @@ func (e *InvalidTaggingRequestException) ErrorCode() string { } func (e *InvalidTaggingRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that limits are exceeded. See Limits -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) +// Indicates that limits are exceeded. See Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) // for more information. type LimitExceededException struct { Message *string diff --git a/service/clouddirectory/types/types.go b/service/clouddirectory/types/types.go index dd631ad9552..ff9beb4811b 100644 --- a/service/clouddirectory/types/types.go +++ b/service/clouddirectory/types/types.go @@ -118,7 +118,7 @@ type BatchAttachObjectResponse struct { } // Attaches a policy object to a regular object inside a BatchRead operation. For -// more information, see AttachPolicy and BatchReadRequest$Operations. +// more information, see AttachPolicy and BatchReadRequest$Operations . type BatchAttachPolicy struct { // The reference that identifies the object to which the policy will be attached. @@ -141,7 +141,7 @@ type BatchAttachPolicyResponse struct { // Attaches the specified object to the specified index inside a BatchRead // operation. For more information, see AttachToIndex and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchAttachToIndex struct { // A reference to the index that you are attaching the object to. @@ -168,7 +168,7 @@ type BatchAttachToIndexResponse struct { // Attaches a typed link to a specified source and target object inside a BatchRead // operation. For more information, see AttachTypedLink and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchAttachTypedLink struct { // A set of attributes that are associated with the typed link. @@ -204,7 +204,7 @@ type BatchAttachTypedLinkResponse struct { } // Creates an index object inside of a BatchRead operation. For more information, -// see CreateIndex and BatchReadRequest$Operations. +// see CreateIndex and BatchReadRequest$Operations . type BatchCreateIndex struct { // Indicates whether the attribute that is being indexed has unique values or not. @@ -218,8 +218,7 @@ type BatchCreateIndex struct { // This member is required. OrderedIndexedAttributeList []AttributeKey - // The batch reference name. See Transaction Support - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) + // The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) // for more information. BatchReferenceName *string @@ -244,20 +243,19 @@ type BatchCreateIndexResponse struct { // Represents the output of a CreateObject operation. type BatchCreateObject struct { - // An attribute map, which contains an attribute ARN as the key and attribute value - // as the map value. + // An attribute map, which contains an attribute ARN as the key and attribute + // value as the map value. // // This member is required. ObjectAttributeList []AttributeKeyAndValue // A list of FacetArns that will be associated with the object. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaFacet []SchemaFacet - // The batch reference name. See Transaction Support - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) + // The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) // for more information. BatchReferenceName *string @@ -297,7 +295,7 @@ type BatchDeleteObjectResponse struct { // Detaches the specified object from the specified index inside a BatchRead // operation. For more information, see DetachFromIndex and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchDetachFromIndex struct { // A reference to the index object. @@ -335,8 +333,7 @@ type BatchDetachObject struct { // This member is required. ParentReference *ObjectReference - // The batch reference name. See Transaction Support - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) + // The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html) // for more information. BatchReferenceName *string @@ -354,7 +351,7 @@ type BatchDetachObjectResponse struct { // Detaches the specified policy from the specified directory inside a BatchWrite // operation. For more information, see DetachPolicy and -// BatchWriteRequest$Operations. +// BatchWriteRequest$Operations . type BatchDetachPolicy struct { // Reference that identifies the object whose policy object will be detached. @@ -377,7 +374,7 @@ type BatchDetachPolicyResponse struct { // Detaches a typed link from a specified source and target object inside a // BatchRead operation. For more information, see DetachTypedLink and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchDetachTypedLink struct { // Used to accept a typed link specifier as input. @@ -395,7 +392,7 @@ type BatchDetachTypedLinkResponse struct { // Retrieves attributes that are associated with a typed link inside a BatchRead // operation. For more information, see GetLinkAttributes and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchGetLinkAttributes struct { // A list of attribute names whose values will be retrieved. @@ -420,9 +417,9 @@ type BatchGetLinkAttributesResponse struct { noSmithyDocumentSerde } -// Retrieves attributes within a facet that are associated with an object inside an -// BatchRead operation. For more information, see GetObjectAttributes and -// BatchReadRequest$Operations. +// Retrieves attributes within a facet that are associated with an object inside +// an BatchRead operation. For more information, see GetObjectAttributes and +// BatchReadRequest$Operations . type BatchGetObjectAttributes struct { // List of attribute names whose values will be retrieved. @@ -435,8 +432,8 @@ type BatchGetObjectAttributes struct { // This member is required. ObjectReference *ObjectReference - // Identifier for the facet whose attributes will be retrieved. See SchemaFacet for - // details. + // Identifier for the facet whose attributes will be retrieved. See SchemaFacet + // for details. // // This member is required. SchemaFacet *SchemaFacet @@ -454,7 +451,7 @@ type BatchGetObjectAttributesResponse struct { } // Retrieves metadata about an object inside a BatchRead operation. For more -// information, see GetObjectInformation and BatchReadRequest$Operations. +// information, see GetObjectInformation and BatchReadRequest$Operations . type BatchGetObjectInformation struct { // A reference to the object. @@ -478,7 +475,7 @@ type BatchGetObjectInformationResponse struct { } // Lists indices attached to an object inside a BatchRead operation. For more -// information, see ListAttachedIndices and BatchReadRequest$Operations. +// information, see ListAttachedIndices and BatchReadRequest$Operations . type BatchListAttachedIndices struct { // A reference to the object that has indices attached. @@ -509,7 +506,7 @@ type BatchListAttachedIndicesResponse struct { // Returns a paginated list of all the incoming TypedLinkSpecifier information for // an object inside a BatchRead operation. For more information, see -// ListIncomingTypedLinks and BatchReadRequest$Operations. +// ListIncomingTypedLinks and BatchReadRequest$Operations . type BatchListIncomingTypedLinks struct { // The reference that identifies the object whose attributes will be listed. @@ -548,7 +545,7 @@ type BatchListIncomingTypedLinksResponse struct { } // Lists objects attached to the specified index inside a BatchRead operation. For -// more information, see ListIndex and BatchReadRequest$Operations. +// more information, see ListIndex and BatchReadRequest$Operations . type BatchListIndex struct { // The reference to the index to list. @@ -623,8 +620,8 @@ type BatchListObjectChildren struct { // This member is required. ObjectReference *ObjectReference - // Maximum number of items to be retrieved in a single call. This is an approximate - // number. + // Maximum number of items to be retrieved in a single call. This is an + // approximate number. MaxResults *int32 // The pagination token. @@ -647,8 +644,8 @@ type BatchListObjectChildrenResponse struct { } // Retrieves all available parent paths for any object type such as node, leaf -// node, policy node, and index node objects inside a BatchRead operation. For more -// information, see ListObjectParentPaths and BatchReadRequest$Operations. +// node, policy node, and index node objects inside a BatchRead operation. For +// more information, see ListObjectParentPaths and BatchReadRequest$Operations . type BatchListObjectParentPaths struct { // The reference that identifies the object whose attributes will be listed. @@ -711,7 +708,7 @@ type BatchListObjectParentsResponse struct { // Returns policies attached to an object in pagination fashion inside a BatchRead // operation. For more information, see ListObjectPolicies and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchListObjectPolicies struct { // The reference that identifies the object whose attributes will be listed. @@ -731,7 +728,7 @@ type BatchListObjectPolicies struct { // Represents the output of a ListObjectPolicies response operation. type BatchListObjectPoliciesResponse struct { - // A list of policy ObjectIdentifiers, that are attached to the object. + // A list of policy ObjectIdentifiers , that are attached to the object. AttachedPolicyIds []string // The pagination token. @@ -742,7 +739,7 @@ type BatchListObjectPoliciesResponse struct { // Returns a paginated list of all the outgoing TypedLinkSpecifier information for // an object inside a BatchRead operation. For more information, see -// ListOutgoingTypedLinks and BatchReadRequest$Operations. +// ListOutgoingTypedLinks and BatchReadRequest$Operations . type BatchListOutgoingTypedLinks struct { // The reference that identifies the object whose attributes will be listed. @@ -755,8 +752,8 @@ type BatchListOutgoingTypedLinks struct { // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []TypedLinkAttributeRange - // Filters are interpreted in the order of the attributes defined on the typed link - // facet, not the order they are supplied to any API calls. + // Filters are interpreted in the order of the attributes defined on the typed + // link facet, not the order they are supplied to any API calls. FilterTypedLink *TypedLinkSchemaAndFacetName // The maximum number of results to retrieve. @@ -782,7 +779,7 @@ type BatchListOutgoingTypedLinksResponse struct { // Returns all of the ObjectIdentifiers to which a given policy is attached inside // a BatchRead operation. For more information, see ListPolicyAttachments and -// BatchReadRequest$Operations. +// BatchReadRequest$Operations . type BatchListPolicyAttachments struct { // The reference that identifies the policy object. @@ -811,9 +808,9 @@ type BatchListPolicyAttachmentsResponse struct { noSmithyDocumentSerde } -// Lists all policies from the root of the Directory to the object specified inside -// a BatchRead operation. For more information, see LookupPolicy and -// BatchReadRequest$Operations. +// Lists all policies from the root of the Directory to the object specified +// inside a BatchRead operation. For more information, see LookupPolicy and +// BatchReadRequest$Operations . type BatchLookupPolicy struct { // Reference that identifies the object whose policies will be looked up. @@ -836,9 +833,9 @@ type BatchLookupPolicyResponse struct { // The pagination token. NextToken *string - // Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, - // and PolicyType. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + // Provides list of path to policies. Policies contain PolicyId , ObjectIdentifier + // , and PolicyType . For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) + // . PolicyToPathList []PolicyToPath noSmithyDocumentSerde @@ -851,7 +848,7 @@ type BatchReadException struct { // An exception message that is associated with the failure. Message *string - // A type of exception, such as InvalidArnException. + // A type of exception, such as InvalidArnException . Type BatchReadExceptionType noSmithyDocumentSerde @@ -874,8 +871,8 @@ type BatchReadOperation struct { // Returns a paginated list of all the incoming TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity - // attributes. For more information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . ListIncomingTypedLinks *BatchListIncomingTypedLinks // Lists objects attached to the specified index. @@ -890,8 +887,8 @@ type BatchReadOperation struct { // Retrieves all available parent paths for any object type such as node, leaf // node, policy node, and index node objects. For more information about objects, - // see Directory Structure - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). + // see Directory Structure (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html) + // . ListObjectParentPaths *BatchListObjectParentPaths // Lists parent objects that are associated with a given object in pagination @@ -903,8 +900,8 @@ type BatchReadOperation struct { // Returns a paginated list of all the outgoing TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity - // attributes. For more information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . ListOutgoingTypedLinks *BatchListOutgoingTypedLinks // Returns all of the ObjectIdentifiers to which a given policy is attached. @@ -914,9 +911,9 @@ type BatchReadOperation struct { // there are no policies present, an empty list is returned. If policies are // present, and if some objects don't have the policies attached, it returns the // ObjectIdentifier for such objects. If policies are present, it returns - // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root - // from the target object are ignored. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + // ObjectIdentifier , policyId , and policyType . Paths that don't lead to the root + // from the target object are ignored. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) + // . LookupPolicy *BatchLookupPolicy noSmithyDocumentSerde @@ -951,8 +948,8 @@ type BatchReadSuccessfulResponse struct { // Returns a paginated list of all the incoming TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity - // attributes. For more information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . ListIncomingTypedLinks *BatchListIncomingTypedLinksResponse // Lists objects attached to the specified index. @@ -967,8 +964,8 @@ type BatchReadSuccessfulResponse struct { // Retrieves all available parent paths for any object type such as node, leaf // node, policy node, and index node objects. For more information about objects, - // see Directory Structure - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). + // see Directory Structure (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html) + // . ListObjectParentPaths *BatchListObjectParentPathsResponse // The list of parent objects to retrieve. @@ -979,8 +976,8 @@ type BatchReadSuccessfulResponse struct { // Returns a paginated list of all the outgoing TypedLinkSpecifier information for // an object. It also supports filtering by typed link facet and identity - // attributes. For more information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . ListOutgoingTypedLinks *BatchListOutgoingTypedLinksResponse // Returns all of the ObjectIdentifiers to which a given policy is attached. @@ -990,9 +987,9 @@ type BatchReadSuccessfulResponse struct { // there are no policies present, an empty list is returned. If policies are // present, and if some objects don't have the policies attached, it returns the // ObjectIdentifier for such objects. If policies are present, it returns - // ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root - // from the target object are ignored. For more information, see Policies - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). + // ObjectIdentifier , policyId , and policyType . Paths that don't lead to the root + // from the target object are ignored. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) + // . LookupPolicy *BatchLookupPolicyResponse noSmithyDocumentSerde @@ -1019,10 +1016,10 @@ type BatchRemoveFacetFromObjectResponse struct { noSmithyDocumentSerde } -// Updates a given typed link’s attributes inside a BatchRead operation. Attributes -// to be updated must not contribute to the typed link’s identity, as defined by -// its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and -// BatchReadRequest$Operations. +// Updates a given typed link’s attributes inside a BatchRead operation. +// Attributes to be updated must not contribute to the typed link’s identity, as +// defined by its IdentityAttributeOrder . For more information, see +// UpdateLinkAttributes and BatchReadRequest$Operations . type BatchUpdateLinkAttributes struct { // The attributes update structure. @@ -1074,7 +1071,7 @@ type BatchWriteOperation struct { // A batch operation that adds a facet to an object. AddFacetToObject *BatchAddFacetToObject - // Attaches an object to a Directory. + // Attaches an object to a Directory . AttachObject *BatchAttachObject // Attaches a policy object to a regular object. An object can have a limited @@ -1085,33 +1082,32 @@ type BatchWriteOperation struct { AttachToIndex *BatchAttachToIndex // Attaches a typed link to a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . AttachTypedLink *BatchAttachTypedLink - // Creates an index object. See Indexing and search - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) + // Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) // for more information. CreateIndex *BatchCreateIndex // Creates an object. CreateObject *BatchCreateObject - // Deletes an object in a Directory. + // Deletes an object in a Directory . DeleteObject *BatchDeleteObject // Detaches the specified object from the specified index. DetachFromIndex *BatchDetachFromIndex - // Detaches an object from a Directory. + // Detaches an object from a Directory . DetachObject *BatchDetachObject - // Detaches a policy from a Directory. + // Detaches a policy from a Directory . DetachPolicy *BatchDetachPolicy // Detaches a typed link from a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . DetachTypedLink *BatchDetachTypedLink // A batch operation that removes a facet from an object. @@ -1132,7 +1128,7 @@ type BatchWriteOperationResponse struct { // The result of an add facet to object batch operation. AddFacetToObject *BatchAddFacetToObjectResponse - // Attaches an object to a Directory. + // Attaches an object to a Directory . AttachObject *BatchAttachObjectResponse // Attaches a policy object to a regular object. An object can have a limited @@ -1143,33 +1139,32 @@ type BatchWriteOperationResponse struct { AttachToIndex *BatchAttachToIndexResponse // Attaches a typed link to a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . AttachTypedLink *BatchAttachTypedLinkResponse - // Creates an index object. See Indexing and search - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) + // Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm) // for more information. CreateIndex *BatchCreateIndexResponse - // Creates an object in a Directory. + // Creates an object in a Directory . CreateObject *BatchCreateObjectResponse - // Deletes an object in a Directory. + // Deletes an object in a Directory . DeleteObject *BatchDeleteObjectResponse // Detaches the specified object from the specified index. DetachFromIndex *BatchDetachFromIndexResponse - // Detaches an object from a Directory. + // Detaches an object from a Directory . DetachObject *BatchDetachObjectResponse - // Detaches a policy from a Directory. + // Detaches a policy from a Directory . DetachPolicy *BatchDetachPolicyResponse // Detaches a typed link from a specified source and target object. For more - // information, see Typed Links - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). + // information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink) + // . DetachTypedLink *BatchDetachTypedLinkResponse // The result of a batch remove facet from object operation. @@ -1191,30 +1186,29 @@ type Directory struct { CreationDateTime *time.Time // The Amazon Resource Name (ARN) that is associated with the directory. For more - // information, see arns. + // information, see arns . DirectoryArn *string // The name of the directory. Name *string - // The state of the directory. Can be either Enabled, Disabled, or Deleted. + // The state of the directory. Can be either Enabled , Disabled , or Deleted . State DirectoryState noSmithyDocumentSerde } -// A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See -// Facets -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html) +// A structure that contains Name , ARN , Attributes , Rule s , and ObjectTypes . +// See Facets (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html) // for more information. type Facet struct { // There are two different styles that you can define on any given facet, Static - // and Dynamic. For static facets, all attributes must be defined in the schema. + // and Dynamic . For static facets, all attributes must be defined in the schema. // For dynamic facets, attributes can be defined during data plane operations. FacetStyle FacetStyle - // The name of the Facet. + // The name of the Facet . Name *string // The object type that is associated with the facet. See @@ -1224,7 +1218,7 @@ type Facet struct { noSmithyDocumentSerde } -// An attribute that is associated with the Facet. +// An attribute that is associated with the Facet . type FacetAttribute struct { // The name of the facet attribute. @@ -1232,26 +1226,23 @@ type FacetAttribute struct { // This member is required. Name *string - // A facet attribute consists of either a definition or a reference. This structure - // contains the attribute definition. See Attribute References - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) + // A facet attribute consists of either a definition or a reference. This + // structure contains the attribute definition. See Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) // for more information. AttributeDefinition *FacetAttributeDefinition // An attribute reference that is associated with the attribute. See Attribute - // References - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) + // References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) // for more information. AttributeReference *FacetAttributeReference - // The required behavior of the FacetAttribute. + // The required behavior of the FacetAttribute . RequiredBehavior RequiredAttributeBehavior noSmithyDocumentSerde } -// A facet attribute definition. See Attribute References -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) +// A facet attribute definition. See Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) // for more information. type FacetAttributeDefinition struct { @@ -1277,16 +1268,14 @@ type FacetAttributeDefinition struct { type FacetAttributeReference struct { // The target attribute name that is associated with the facet reference. See - // Attribute References - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) + // Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) // for more information. // // This member is required. TargetAttributeName *string - // The target facet name that is associated with the facet reference. See Attribute - // References - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) + // The target facet name that is associated with the facet reference. See + // Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) // for more information. // // This member is required. @@ -1313,8 +1302,8 @@ type IndexAttachment struct { // The indexed attribute values. IndexedAttributes []AttributeKeyAndValue - // In response to ListIndex, the ObjectIdentifier of the object attached to the - // index. In response to ListAttachedIndices, the ObjectIdentifier of the index + // In response to ListIndex , the ObjectIdentifier of the object attached to the + // index. In response to ListAttachedIndices , the ObjectIdentifier of the index // attached to the object. This field will always contain the ObjectIdentifier of // the object on the opposite side of the attachment specified in the query. ObjectIdentifier *string @@ -1326,7 +1315,7 @@ type IndexAttachment struct { // for attributes which don’t contribute to link identity. type LinkAttributeAction struct { - // A type that can be either UPDATE_OR_CREATE or DELETE. + // A type that can be either UPDATE_OR_CREATE or DELETE . AttributeActionType UpdateActionType // The value that you want to update to. @@ -1350,7 +1339,7 @@ type LinkAttributeUpdate struct { // The action to take on the object attribute. type ObjectAttributeAction struct { - // A type that can be either Update or Delete. + // A type that can be either Update or Delete . ObjectAttributeActionType UpdateActionType // The value that you want to update to. @@ -1401,22 +1390,15 @@ type ObjectReference struct { // A path selector supports easy selection of an object by the parent/child links // leading to it from the directory root. Use the link names from each parent/child // link to construct the path. Path selectors start with a slash (/) and link names - // are separated by slashes. For more information about paths, see Access Objects - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html). - // You can identify an object in one of the following ways: - // - // * $ObjectIdentifier - - // An object identifier is an opaque string provided by Amazon Cloud Directory. - // When creating objects, the system will provide you with the identifier of the - // created object. An object’s identifier is immutable and no two objects will ever - // share the same object identifier. To identify an object with ObjectIdentifier, - // the ObjectIdentifier must be wrapped in double quotes. - // - // * /some/path - - // Identifies the object based on path - // - // * #SomeBatchReference - Identifies the - // object in a batch call + // are separated by slashes. For more information about paths, see Access Objects (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html) + // . You can identify an object in one of the following ways: + // - $ObjectIdentifier - An object identifier is an opaque string provided by + // Amazon Cloud Directory. When creating objects, the system will provide you with + // the identifier of the created object. An object’s identifier is immutable and no + // two objects will ever share the same object identifier. To identify an object + // with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. + // - /some/path - Identifies the object based on path + // - #SomeBatchReference - Identifies the object in a batch call Selector *string noSmithyDocumentSerde @@ -1435,25 +1417,25 @@ type PathToObjectIdentifiers struct { noSmithyDocumentSerde } -// Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is -// attached. For more information, see Policies -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). +// Contains the PolicyType , PolicyId , and the ObjectIdentifier to which it is +// attached. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) +// . type PolicyAttachment struct { - // The ObjectIdentifier that is associated with PolicyAttachment. + // The ObjectIdentifier that is associated with PolicyAttachment . ObjectIdentifier *string - // The ID of PolicyAttachment. + // The ID of PolicyAttachment . PolicyId *string - // The type of policy that can be associated with PolicyAttachment. + // The type of policy that can be associated with PolicyAttachment . PolicyType *string noSmithyDocumentSerde } -// Used when a regular object exists in a Directory and you want to find all of the -// policies that are associated with that object and the parent to that object. +// Used when a regular object exists in a Directory and you want to find all of +// the policies that are associated with that object and the parent to that object. type PolicyToPath struct { // The path that is referenced from the root. @@ -1485,8 +1467,7 @@ type SchemaFacet struct { FacetName *string // The ARN of the schema that contains the facet with no minor component. See arns - // and In-Place Schema Upgrade - // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html) + // and In-Place Schema Upgrade (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html) // for a description of when to provide minor versions. If this value is set, // FacetName must also be set. SchemaArn *string @@ -1506,8 +1487,8 @@ type Tag struct { noSmithyDocumentSerde } -// Represents the data for a typed attribute. You can set one, and only one, of the -// elements. Each attribute in an item is a name-value pair. Attributes have a +// Represents the data for a typed attribute. You can set one, and only one, of +// the elements. Each attribute in an item is a name-value pair. Attributes have a // single value. // // The following types satisfy this interface: @@ -1566,8 +1547,8 @@ type TypedAttributeValueMemberStringValue struct { func (*TypedAttributeValueMemberStringValue) isTypedAttributeValue() {} -// A range of attribute values. For more information, see Range Filters -// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html). +// A range of attribute values. For more information, see Range Filters (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html) +// . type TypedAttributeValueRange struct { // The inclusive or exclusive range end. @@ -1597,7 +1578,7 @@ type TypedLinkAttributeDefinition struct { // This member is required. Name *string - // The required behavior of the TypedLinkAttributeDefinition. + // The required behavior of the TypedLinkAttributeDefinition . // // This member is required. RequiredBehavior RequiredAttributeBehavior @@ -1682,7 +1663,7 @@ type TypedLinkFacetAttributeUpdate struct { type TypedLinkSchemaAndFacetName struct { // The Amazon Resource Name (ARN) that is associated with the schema. For more - // information, see arns. + // information, see arns . // // This member is required. SchemaArn *string @@ -1695,10 +1676,10 @@ type TypedLinkSchemaAndFacetName struct { noSmithyDocumentSerde } -// Contains all the information that is used to uniquely identify a typed link. The -// parameters discussed in this topic are used to uniquely specify the typed link -// being operated on. The AttachTypedLink API returns a typed link specifier while -// the DetachTypedLink API accepts one as input. Similarly, the +// Contains all the information that is used to uniquely identify a typed link. +// The parameters discussed in this topic are used to uniquely specify the typed +// link being operated on. The AttachTypedLink API returns a typed link specifier +// while the DetachTypedLink API accepts one as input. Similarly, the // ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed // link specifiers as output. You can also construct a typed link specifier from // scratch. diff --git a/service/cloudformation/api_client.go b/service/cloudformation/api_client.go index 8df00879dbb..f591049e1ee 100644 --- a/service/cloudformation/api_client.go +++ b/service/cloudformation/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudformation/api_op_ActivateType.go b/service/cloudformation/api_op_ActivateType.go index 4372ce66c1f..3cba6f30d2e 100644 --- a/service/cloudformation/api_op_ActivateType.go +++ b/service/cloudformation/api_op_ActivateType.go @@ -12,13 +12,11 @@ import ( ) // Activates a public third-party extension, making it available for use in stack -// templates. For more information, see Using public extensions -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) +// templates. For more information, see Using public extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) // in the CloudFormation User Guide. Once you have activated a public third-party // extension in your account and region, use SetTypeConfiguration to specify // configuration properties for the extension. For more information, see -// Configuring extensions at the account level -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) +// Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. func (c *Client) ActivateType(ctx context.Context, params *ActivateTypeInput, optFns ...func(*Options)) (*ActivateTypeOutput, error) { if params == nil { @@ -39,7 +37,7 @@ type ActivateTypeInput struct { // Whether to automatically update the extension in this account and region when a // new minor version is published by the extension publisher. Major versions - // released by the publisher must be manually updated. The default is true. + // released by the publisher must be manually updated. The default is true . AutoUpdate *bool // The name of the IAM execution role to use to activate the extension. @@ -51,23 +49,23 @@ type ActivateTypeInput struct { // The major version of this extension you want to activate, if multiple major // versions are available. The default is the latest major version. CloudFormation // uses the latest available minor version of the major version selected. You can - // specify MajorVersion or VersionBump, but not both. + // specify MajorVersion or VersionBump , but not both. MajorVersion *int64 // The Amazon Resource Name (ARN) of the public extension. Conditional: You must - // specify PublicTypeArn, or TypeName, Type, and PublisherId. + // specify PublicTypeArn , or TypeName , Type , and PublisherId . PublicTypeArn *string - // The ID of the extension publisher. Conditional: You must specify PublicTypeArn, - // or TypeName, Type, and PublisherId. + // The ID of the extension publisher. Conditional: You must specify PublicTypeArn , + // or TypeName , Type , and PublisherId . PublisherId *string - // The extension type. Conditional: You must specify PublicTypeArn, or TypeName, - // Type, and PublisherId. + // The extension type. Conditional: You must specify PublicTypeArn , or TypeName , + // Type , and PublisherId . Type types.ThirdPartyType - // The name of the extension. Conditional: You must specify PublicTypeArn, or - // TypeName, Type, and PublisherId. + // The name of the extension. Conditional: You must specify PublicTypeArn , or + // TypeName , Type , and PublisherId . TypeName *string // An alias to assign to the public extension, in this account and region. If you @@ -79,15 +77,13 @@ type ActivateTypeInput struct { // using different type name aliases. TypeNameAlias *string - // Manually updates a previously-activated type to a new major or minor version, if - // available. You can also use this parameter to update the value of AutoUpdate. - // - // * - // MAJOR: CloudFormation updates the extension to the newest major version, if one - // is available. - // - // * MINOR: CloudFormation updates the extension to the newest minor - // version, if one is available. + // Manually updates a previously-activated type to a new major or minor version, + // if available. You can also use this parameter to update the value of AutoUpdate + // . + // - MAJOR : CloudFormation updates the extension to the newest major version, if + // one is available. + // - MINOR : CloudFormation updates the extension to the newest minor version, if + // one is available. VersionBump types.VersionBump noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go b/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go index c6667c2aad4..9293c35be2c 100644 --- a/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go +++ b/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns configuration data for the specified CloudFormation extensions, from the -// CloudFormation registry for the account and region. For more information, see -// Configuring extensions at the account level -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) +// Returns configuration data for the specified CloudFormation extensions, from +// the CloudFormation registry for the account and region. For more information, +// see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. func (c *Client) BatchDescribeTypeConfigurations(ctx context.Context, params *BatchDescribeTypeConfigurationsInput, optFns ...func(*Options)) (*BatchDescribeTypeConfigurationsOutput, error) { if params == nil { diff --git a/service/cloudformation/api_op_ContinueUpdateRollback.go b/service/cloudformation/api_op_ContinueUpdateRollback.go index 21facdf4125..c1ab4a12075 100644 --- a/service/cloudformation/api_op_ContinueUpdateRollback.go +++ b/service/cloudformation/api_op_ContinueUpdateRollback.go @@ -11,9 +11,8 @@ import ( ) // For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues -// rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of -// the failure, you can manually fix the error -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) +// rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause +// of the failure, you can manually fix the error (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) // and continue the rollback. By continuing the rollback, you can return your stack // to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update // the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when @@ -51,8 +50,8 @@ type ContinueUpdateRollbackInput struct { // A unique identifier for this ContinueUpdateRollback request. Specify this token // if you plan to retry requests so that CloudFormationknows that you're not // attempting to continue the rollback to a stack with the same name. You might - // retry ContinueUpdateRollback requests to ensure that CloudFormation successfully - // received them. + // retry ContinueUpdateRollback requests to ensure that CloudFormation + // successfully received them. ClientRequestToken *string // A list of the logical IDs of the resources that CloudFormation skips during the @@ -62,8 +61,7 @@ type ContinueUpdateRollbackInput struct { // update was canceled. To check why a resource update failed, use the // DescribeStackResources action, and view the resource status reason. Specify this // property to skip rolling back resources that CloudFormation can't successfully - // roll back. We recommend that you troubleshoot - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) + // roll back. We recommend that you troubleshoot (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) // resources before skipping them. CloudFormation sets the status of the specified // resources to UPDATE_COMPLETE and continues to roll back the stack. After the // rollback is complete, the state of the skipped resources will be inconsistent @@ -74,14 +72,15 @@ type ContinueUpdateRollbackInput struct { // successfully roll back your stack. For example, a failed resource update might // cause dependent resources to fail. In this case, it might not be necessary to // skip the dependent resources. To skip resources that are part of nested stacks, - // use the following format: NestedStackName.ResourceLogicalID. If you want to - // specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in - // the ResourcesToSkip list, then its corresponding embedded stack must be in one - // of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. - // Don't confuse a child stack's name with its corresponding logical ID defined in - // the parent stack. For an example of a continue update rollback operation with - // nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks). + // use the following format: NestedStackName.ResourceLogicalID . If you want to + // specify the logical ID of a stack resource ( Type: AWS::CloudFormation::Stack ) + // in the ResourcesToSkip list, then its corresponding embedded stack must be in + // one of the following states: DELETE_IN_PROGRESS , DELETE_COMPLETE , or + // DELETE_FAILED . Don't confuse a child stack's name with its corresponding + // logical ID defined in the parent stack. For an example of a continue update + // rollback operation with nested stacks, see Using ResourcesToSkip to recover a + // nested stacks hierarchy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks) + // . ResourcesToSkip []string // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role diff --git a/service/cloudformation/api_op_CreateChangeSet.go b/service/cloudformation/api_op_CreateChangeSet.go index 25660f8a360..8e8db7406b7 100644 --- a/service/cloudformation/api_op_CreateChangeSet.go +++ b/service/cloudformation/api_op_CreateChangeSet.go @@ -11,25 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a list of changes that will be applied to a stack so that you can review -// the changes before executing them. You can create a change set for a stack that -// doesn't exist or an existing stack. If you create a change set for a stack that -// doesn't exist, the change set shows all of the resources that CloudFormation -// will create. If you create a change set for an existing stack, CloudFormation -// compares the stack's information with the information that you submit in the -// change set and lists the differences. Use change sets to understand which -// resources CloudFormation will create or change, and how it will change resources -// in an existing stack, before you create or update a stack. To create a change -// set for a stack that doesn't exist, for the ChangeSetType parameter, specify -// CREATE. To create a change set for an existing stack, specify UPDATE for the -// ChangeSetType parameter. To create a change set for an import operation, specify -// IMPORT for the ChangeSetType parameter. After the CreateChangeSet call -// successfully completes, CloudFormation starts creating the change set. To check -// the status of the change set or to review it, use the DescribeChangeSet action. -// When you are satisfied with the changes the change set will make, execute the -// change set by using the ExecuteChangeSet action. CloudFormation doesn't make -// changes until you execute the change set. To create a change set for the entire -// stack hierarchy, set IncludeNestedStacks to True. +// Creates a list of changes that will be applied to a stack so that you can +// review the changes before executing them. You can create a change set for a +// stack that doesn't exist or an existing stack. If you create a change set for a +// stack that doesn't exist, the change set shows all of the resources that +// CloudFormation will create. If you create a change set for an existing stack, +// CloudFormation compares the stack's information with the information that you +// submit in the change set and lists the differences. Use change sets to +// understand which resources CloudFormation will create or change, and how it will +// change resources in an existing stack, before you create or update a stack. To +// create a change set for a stack that doesn't exist, for the ChangeSetType +// parameter, specify CREATE . To create a change set for an existing stack, +// specify UPDATE for the ChangeSetType parameter. To create a change set for an +// import operation, specify IMPORT for the ChangeSetType parameter. After the +// CreateChangeSet call successfully completes, CloudFormation starts creating the +// change set. To check the status of the change set or to review it, use the +// DescribeChangeSet action. When you are satisfied with the changes the change set +// will make, execute the change set by using the ExecuteChangeSet action. +// CloudFormation doesn't make changes until you execute the change set. To create +// a change set for the entire stack hierarchy, set IncludeNestedStacks to True . func (c *Client) CreateChangeSet(ctx context.Context, params *CreateChangeSetInput, optFns ...func(*Options)) (*CreateChangeSetOutput, error) { if params == nil { params = &CreateChangeSetInput{} @@ -64,94 +64,59 @@ type CreateChangeSetInput struct { // This member is required. StackName *string - // In some cases, you must explicitly acknowledge that your stack template contains - // certain capabilities in order for CloudFormation to create the stack. - // - // * - // CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include - // resources that can affect permissions in your Amazon Web Services account; for - // example, by creating new Identity and Access Management (IAM) users. For those - // stacks, you must explicitly acknowledge this by specifying one of these - // capabilities. The following IAM resources require you to specify either the - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. - // - // * If you have IAM resources, - // you can specify either capability. - // - // * If you have IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM. - // - // * If you don't specify either of - // these capabilities, CloudFormation returns an InsufficientCapabilities - // error. - // - // If your stack template contains these resources, we suggest that you - // review all permissions associated with them and edit their permissions if - // necessary. - // - // * AWS::IAM::AccessKey - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) - // - // * - // AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) - // - // * - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) - // - // * - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) - // - // * - // AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) - // - // * - // AWS::IAM::User - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) - // - // * - // AWS::IAM::UserToGroupAddition - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) - // - // For - // more information, see Acknowledging IAM resources in CloudFormation templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). - // - // * - // CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom - // processing on templates; this can include simple actions like find-and-replace - // operations, all the way to extensive transformations of entire templates. - // Because of this, users typically create a change set from the processed - // template, so that they can review the changes resulting from the macros before - // actually creating the stack. If your stack template contains one or more macros, - // and you choose to create a stack directly from the processed template, without - // first reviewing the resulting changes in a change set, you must acknowledge this - // capability. This includes the AWS::Include - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) - // transforms, which are macros hosted by CloudFormation. This capacity doesn't - // apply to creating change sets, and specifying it when creating change sets has - // no effect. If you want to create a stack from a stack template that contains - // macros and nested stacks, you must create or update the stack directly from the - // template using the CreateStack or UpdateStack action, and specifying this - // capability. For more information about macros, see Using CloudFormation macros - // to perform custom processing on templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // In some cases, you must explicitly acknowledge that your stack template + // contains certain capabilities in order for CloudFormation to create the stack. + // - CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include + // resources that can affect permissions in your Amazon Web Services account; for + // example, by creating new Identity and Access Management (IAM) users. For those + // stacks, you must explicitly acknowledge this by specifying one of these + // capabilities. The following IAM resources require you to specify either the + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. + // - If you have IAM resources, you can specify either capability. + // - If you have IAM resources with custom names, you must specify + // CAPABILITY_NAMED_IAM . + // - If you don't specify either of these capabilities, CloudFormation returns + // an InsufficientCapabilities error. If your stack template contains these + // resources, we suggest that you review all permissions associated with them and + // edit their permissions if necessary. + // - AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // - AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // - AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // - AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) + // - AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // - AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) + // - AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) + // For more information, see Acknowledging IAM resources in CloudFormation + // templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . + // - CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom + // processing on templates; this can include simple actions like find-and-replace + // operations, all the way to extensive transformations of entire templates. + // Because of this, users typically create a change set from the processed + // template, so that they can review the changes resulting from the macros before + // actually creating the stack. If your stack template contains one or more macros, + // and you choose to create a stack directly from the processed template, without + // first reviewing the resulting changes in a change set, you must acknowledge this + // capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // transforms, which are macros hosted by CloudFormation. This capacity doesn't + // apply to creating change sets, and specifying it when creating change sets has + // no effect. If you want to create a stack from a stack template that contains + // macros and nested stacks, you must create or update the stack directly from the + // template using the CreateStack or UpdateStack action, and specifying this + // capability. For more information about macros, see Using CloudFormation + // macros to perform custom processing on templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) + // . Capabilities []types.Capability // The type of change set operation. To create a change set for a new stack, - // specify CREATE. To create a change set for an existing stack, specify UPDATE. To - // create a change set for an import operation, specify IMPORT. If you create a + // specify CREATE . To create a change set for an existing stack, specify UPDATE . + // To create a change set for an import operation, specify IMPORT . If you create a // change set for a new stack, CloudFormation creates a stack with a unique stack - // ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) + // ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) // state until you execute the change set. By default, CloudFormation specifies - // UPDATE. You can't use the UPDATE type to create a change set for a new stack or - // the CREATE type to create a change set for an existing stack. + // UPDATE . You can't use the UPDATE type to create a change set for a new stack + // or the CREATE type to create a change set for an existing stack. ChangeSetType types.ChangeSetType // A unique identifier for this CreateChangeSet request. Specify this token if you @@ -164,8 +129,8 @@ type CreateChangeSetInput struct { Description *string // Creates a change set for the all nested stacks specified in the template. The - // default behavior of this action is set to False. To include nested sets in a - // change set, specify True. + // default behavior of this action is set to False . To include nested sets in a + // change set, specify True . IncludeNestedStacks *bool // The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon @@ -173,19 +138,18 @@ type CreateChangeSetInput struct { // associated notification topics, specify an empty list. NotificationARNs []string - // A list of Parameter structures that specify input parameters for the change set. - // For more information, see the Parameter data type. + // A list of Parameter structures that specify input parameters for the change + // set. For more information, see the Parameter data type. Parameters []types.Parameter // The template resource types that you have permissions to work with if you - // execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or - // Custom::MyCustomInstance. If the list of resource types doesn't include a + // execute this change set, such as AWS::EC2::Instance , AWS::EC2::* , or + // Custom::MyCustomInstance . If the list of resource types doesn't include a // resource type that you're updating, the stack update fails. By default, // CloudFormation grants permissions to all resource types. Identity and Access // Management (IAM) uses this parameter for condition keys in IAM policies for // CloudFormation. For more information, see Controlling access with Identity and - // Access Management - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) + // Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) // in the CloudFormation User Guide. ResourceTypes []string @@ -214,14 +178,14 @@ type CreateChangeSetInput struct { // A structure that contains the body of the revised template, with a minimum // length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates // the change set by comparing this template with the template of the stack that - // you specified. Conditional: You must specify only TemplateBody or TemplateURL. + // you specified. Conditional: You must specify only TemplateBody or TemplateURL . TemplateBody *string // The location of the file that contains the revised template. The URL must point // to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or // a Systems Manager document. CloudFormation generates the change set by comparing // this template with the stack that you specified. Conditional: You must specify - // only TemplateBody or TemplateURL. + // only TemplateBody or TemplateURL . TemplateURL *string // Whether to reuse the template that's associated with the stack to create the diff --git a/service/cloudformation/api_op_CreateStack.go b/service/cloudformation/api_op_CreateStack.go index 8fb1d8e0f6d..f05584730d8 100644 --- a/service/cloudformation/api_op_CreateStack.go +++ b/service/cloudformation/api_op_CreateStack.go @@ -13,7 +13,7 @@ import ( // Creates a stack as specified in the template. After the call completes // successfully, the stack creation starts. You can check the status of the stack -// through the DescribeStacksoperation. +// through the DescribeStacks operation. func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error) { if params == nil { params = &CreateStackInput{} @@ -32,124 +32,88 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF // The input for CreateStack action. type CreateStackInput struct { - // The name that's associated with the stack. The name must be unique in the Region - // in which you are creating the stack. A stack name can contain only alphanumeric - // characters (case sensitive) and hyphens. It must start with an alphabetical - // character and can't be longer than 128 characters. + // The name that's associated with the stack. The name must be unique in the + // Region in which you are creating the stack. A stack name can contain only + // alphanumeric characters (case sensitive) and hyphens. It must start with an + // alphabetical character and can't be longer than 128 characters. // // This member is required. StackName *string - // In some cases, you must explicitly acknowledge that your stack template contains - // certain capabilities in order for CloudFormation to create the stack. - // - // * - // CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include - // resources that can affect permissions in your Amazon Web Services account; for - // example, by creating new Identity and Access Management (IAM) users. For those - // stacks, you must explicitly acknowledge this by specifying one of these - // capabilities. The following IAM resources require you to specify either the - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. - // - // * If you have IAM resources, - // you can specify either capability. - // - // * If you have IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM. - // - // * If you don't specify either of - // these capabilities, CloudFormation returns an InsufficientCapabilities - // error. - // - // If your stack template contains these resources, we recommend that you - // review all permissions associated with them and edit their permissions if - // necessary. - // - // * AWS::IAM::AccessKey - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) - // - // * - // AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) - // - // * - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) - // - // * - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) - // - // * - // AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) - // - // * - // AWS::IAM::User - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) - // - // * - // AWS::IAM::UserToGroupAddition - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) - // - // For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). - // - // * - // CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom - // processing on templates; this can include simple actions like find-and-replace - // operations, all the way to extensive transformations of entire templates. - // Because of this, users typically create a change set from the processed - // template, so that they can review the changes resulting from the macros before - // actually creating the stack. If your stack template contains one or more macros, - // and you choose to create a stack directly from the processed template, without - // first reviewing the resulting changes in a change set, you must acknowledge this - // capability. This includes the AWS::Include - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) - // transforms, which are macros hosted by CloudFormation. If you want to create a - // stack from a stack template that contains macros and nested stacks, you must - // create the stack directly from the template using this capability. You should - // only create stacks directly from a stack template that contains macros if you - // know what processing the macro performs. Each macro relies on an underlying - // Lambda service function for processing stack templates. Be aware that the Lambda - // function owner can update the function operation without CloudFormation being - // notified. For more information, see Using CloudFormation macros to perform - // custom processing on templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // In some cases, you must explicitly acknowledge that your stack template + // contains certain capabilities in order for CloudFormation to create the stack. + // - CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include + // resources that can affect permissions in your Amazon Web Services account; for + // example, by creating new Identity and Access Management (IAM) users. For those + // stacks, you must explicitly acknowledge this by specifying one of these + // capabilities. The following IAM resources require you to specify either the + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. + // - If you have IAM resources, you can specify either capability. + // - If you have IAM resources with custom names, you must specify + // CAPABILITY_NAMED_IAM . + // - If you don't specify either of these capabilities, CloudFormation returns + // an InsufficientCapabilities error. If your stack template contains these + // resources, we recommend that you review all permissions associated with them and + // edit their permissions if necessary. + // - AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // - AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // - AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // - AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) + // - AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // - AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) + // - AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) + // For more information, see Acknowledging IAM Resources in CloudFormation + // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . + // - CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom + // processing on templates; this can include simple actions like find-and-replace + // operations, all the way to extensive transformations of entire templates. + // Because of this, users typically create a change set from the processed + // template, so that they can review the changes resulting from the macros before + // actually creating the stack. If your stack template contains one or more macros, + // and you choose to create a stack directly from the processed template, without + // first reviewing the resulting changes in a change set, you must acknowledge this + // capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // transforms, which are macros hosted by CloudFormation. If you want to create a + // stack from a stack template that contains macros and nested stacks, you must + // create the stack directly from the template using this capability. You should + // only create stacks directly from a stack template that contains macros if you + // know what processing the macro performs. Each macro relies on an underlying + // Lambda service function for processing stack templates. Be aware that the Lambda + // function owner can update the function operation without CloudFormation being + // notified. For more information, see Using CloudFormation macros to perform + // custom processing on templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) + // . Capabilities []types.Capability - // A unique identifier for this CreateStack request. Specify this token if you plan - // to retry requests so that CloudFormation knows that you're not attempting to - // create a stack with the same name. You might retry CreateStack requests to + // A unique identifier for this CreateStack request. Specify this token if you + // plan to retry requests so that CloudFormation knows that you're not attempting + // to create a stack with the same name. You might retry CreateStack requests to // ensure that CloudFormation successfully received them. All events initiated by a // given stack operation are assigned the same client request token, which you can // use to track operations. For example, if you execute a CreateStack operation - // with the token token1, then all the StackEvents generated by that operation will - // have ClientRequestToken set as token1. In the console, stack operations display - // the client request token on the Events tab. Stack operations that are initiated - // from the console use the token format Console-StackOperation-ID, which helps you - // easily identify the stack operation . For example, if you create a stack using - // the console, each stack event would be assigned the same token in the following - // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + // with the token token1 , then all the StackEvents generated by that operation + // will have ClientRequestToken set as token1 . In the console, stack operations + // display the client request token on the Events tab. Stack operations that are + // initiated from the console use the token format Console-StackOperation-ID, which + // helps you easily identify the stack operation . For example, if you create a + // stack using the console, each stack event would be assigned the same token in + // the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 . ClientRequestToken *string // Set to true to disable rollback of the stack if stack creation failed. You can - // specify either DisableRollback or OnFailure, but not both. Default: false + // specify either DisableRollback or OnFailure , but not both. Default: false DisableRollback *bool // Whether to enable termination protection on the specified stack. If a user // attempts to delete a stack with termination protection enabled, the operation // fails and the stack remains unchanged. For more information, see Protecting a - // Stack From Being Deleted - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) + // Stack From Being Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the CloudFormation User Guide. Termination protection is deactivated on - // stacks by default. For nested stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), - // termination protection is set on the root stack and can't be changed directly on - // the nested stack. + // stacks by default. For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // , termination protection is set on the root stack and can't be changed directly + // on the nested stack. EnableTerminationProtection *bool // The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack @@ -158,29 +122,28 @@ type CreateStackInput struct { NotificationARNs []string // Determines what action will be taken if stack creation fails. This must be one - // of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or - // DisableRollback, but not both. Default: ROLLBACK + // of: DO_NOTHING , ROLLBACK , or DELETE . You can specify either OnFailure or + // DisableRollback , but not both. Default: ROLLBACK OnFailure types.OnFailure // A list of Parameter structures that specify input parameters for the stack. For - // more information, see the Parameter - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) + // more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []types.Parameter // The template resource types that you have permissions to work with for this - // create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or - // Custom::MyCustomInstance. Use the following syntax to describe template resource - // types: AWS::* (for all Amazon Web Services resources), Custom::* (for all custom - // resources), Custom::logical_ID (for a specific custom resource), + // create stack action, such as AWS::EC2::Instance , AWS::EC2::* , or + // Custom::MyCustomInstance . Use the following syntax to describe template + // resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for + // all custom resources), Custom::logical_ID (for a specific custom resource), // AWS::service_name::* (for all resources of a particular Amazon Web Services - // service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web - // Services resource). If the list of resource types doesn't include a resource + // service), and AWS::service_name::resource_logical_ID (for a specific Amazon + // Web Services resource). If the list of resource types doesn't include a resource // that you're creating, the stack creation fails. By default, CloudFormation // grants permissions to all resource types. Identity and Access Management (IAM) // uses this parameter for CloudFormation-specific condition keys in IAM policies. - // For more information, see Controlling Access with Identity and Access Management - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). + // For more information, see Controlling Access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) + // . ResourceTypes []string // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role @@ -198,9 +161,8 @@ type CreateStackInput struct { // updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration - // Structure containing the stack policy body. For more information, go to Prevent - // Updates to Stack Resources - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) + // Structure containing the stack policy body. For more information, go to + // Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the CloudFormation User Guide. You can specify either the StackPolicyBody or // the StackPolicyURL parameter, but not both. StackPolicyBody *string @@ -217,22 +179,20 @@ type CreateStackInput struct { Tags []types.Tag // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. For more information, go to Template anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // maximum length of 51,200 bytes. For more information, go to Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify either the // TemplateBody or the TemplateURL parameter, but not both. TemplateBody *string // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems - // Manager document. For more information, go to the Template anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // Manager document. For more information, go to the Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify either the // TemplateBody or the TemplateURL parameter, but not both. TemplateURL *string // The amount of time that can pass before the stack status becomes CREATE_FAILED; - // if DisableRollback is not set or is set to false, the stack will be rolled back. + // if DisableRollback is not set or is set to false , the stack will be rolled back. TimeoutInMinutes *int32 noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_CreateStackInstances.go b/service/cloudformation/api_op_CreateStackInstances.go index abb181af32f..5509520d111 100644 --- a/service/cloudformation/api_op_CreateStackInstances.go +++ b/service/cloudformation/api_op_CreateStackInstances.go @@ -15,7 +15,7 @@ import ( // Creates stack instances for the specified accounts, within the specified Amazon // Web Services Regions. A stack instance refers to a stack in a specific account // and Region. You must specify at least one value for either Accounts or -// DeploymentTargets, and you must specify at least one value for Regions. +// DeploymentTargets , and you must specify at least one value for Regions . func (c *Client) CreateStackInstances(ctx context.Context, params *CreateStackInstancesInput, optFns ...func(*Options)) (*CreateStackInstancesOutput, error) { if params == nil { params = &CreateStackInstancesInput{} @@ -45,30 +45,26 @@ type CreateStackInstancesInput struct { // This member is required. StackSetName *string - // [Self-managed permissions] The names of one or more Amazon Web Services accounts - // that you want to create stack instances in the specified Region(s) for. You can - // specify Accounts or DeploymentTargets, but not both. + // [Self-managed permissions] The names of one or more Amazon Web Services + // accounts that you want to create stack instances in the specified Region(s) for. + // You can specify Accounts or DeploymentTargets , but not both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The Organizations accounts for which to create // stack instances in the specified Amazon Web Services Regions. You can specify - // Accounts or DeploymentTargets, but not both. + // Accounts or DeploymentTargets , but not both. DeploymentTargets *types.DeploymentTargets // The unique identifier for this stack set operation. The operation ID also @@ -77,38 +73,30 @@ type CreateStackInstancesInput struct { // might retry stack set operation requests to ensure that CloudFormation // successfully received them. If you don't specify an operation ID, the SDK // generates one automatically. Repeating this stack set operation with a new - // operation ID retries all stack instances whose status is OUTDATED. + // operation ID retries all stack instances whose status is OUTDATED . OperationId *string // Preferences for how CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences - // A list of stack set parameters whose values you want to override in the selected - // stack instances. Any overridden parameter values will be applied to all stack - // instances in the specified accounts and Amazon Web Services Regions. When + // A list of stack set parameters whose values you want to override in the + // selected stack instances. Any overridden parameter values will be applied to all + // stack instances in the specified accounts and Amazon Web Services Regions. When // specifying parameters and their values, be aware of how CloudFormation sets // parameter values during stack instance operations: - // - // * To override the current - // value for a parameter, include the parameter and specify its value. - // - // * To leave - // an overridden parameter set to its present value, include the parameter and - // specify UsePreviousValue as true. (You can't specify both a value and set - // UsePreviousValue to true.) - // - // * To set an overridden parameter back to the value - // specified in the stack set, specify a parameter list but don't include the - // parameter in the list. - // - // * To leave all parameters set to their present values, - // don't specify this property at all. - // - // During stack set updates, any parameter - // values overridden for a stack instance aren't updated, but retain their - // overridden value. You can only override the parameter values that are specified - // in the stack set; to add or delete a parameter itself, use UpdateStackSet - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) + // - To override the current value for a parameter, include the parameter and + // specify its value. + // - To leave an overridden parameter set to its present value, include the + // parameter and specify UsePreviousValue as true . (You can't specify both a + // value and set UsePreviousValue to true .) + // - To set an overridden parameter back to the value specified in the stack + // set, specify a parameter list but don't include the parameter in the list. + // - To leave all parameters set to their present values, don't specify this + // property at all. + // During stack set updates, any parameter values overridden for a stack instance + // aren't updated, but retain their overridden value. You can only override the + // parameter values that are specified in the stack set; to add or delete a + // parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update the stack set template. ParameterOverrides []types.Parameter diff --git a/service/cloudformation/api_op_CreateStackSet.go b/service/cloudformation/api_op_CreateStackSet.go index 0d69ff7e5f0..47ed3f22bc1 100644 --- a/service/cloudformation/api_op_CreateStackSet.go +++ b/service/cloudformation/api_op_CreateStackSet.go @@ -42,110 +42,68 @@ type CreateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles to // control which users or groups can manage specific stack sets within the same // administrator account. For more information, see Prerequisites: Granting - // Permissions for Stack Set Operations - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string - // Describes whether StackSets automatically deploys to Organizations accounts that - // are added to the target organization or organizational unit (OU). Specify only - // if PermissionModel is SERVICE_MANAGED. + // Describes whether StackSets automatically deploys to Organizations accounts + // that are added to the target organization or organizational unit (OU). Specify + // only if PermissionModel is SERVICE_MANAGED . AutoDeployment *types.AutoDeployment // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * To create a stack set with - // service-managed permissions while signed in to the management account, specify - // SELF. - // - // * To create a stack set with service-managed permissions while signed in - // to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web - // Services account must be registered as a delegated admin in the management - // account. For more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. - // - // Stack sets with service-managed permissions - // are created in the management account, including stack sets that are created by - // delegated administrators. + // - To create a stack set with service-managed permissions while signed in to + // the management account, specify SELF . + // - To create a stack set with service-managed permissions while signed in to a + // delegated administrator account, specify DELEGATED_ADMIN . Your Amazon Web + // Services account must be registered as a delegated admin in the management + // account. For more information, see Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. + // Stack sets with service-managed permissions are created in the management + // account, including stack sets that are created by delegated administrators. CallAs types.CallAs // In some cases, you must explicitly acknowledge that your stack set template // contains certain capabilities in order for CloudFormation to create the stack // set and related stack instances. - // - // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some - // stack templates might include resources that can affect permissions in your - // Amazon Web Services account; for example, by creating new Identity and Access - // Management (IAM) users. For those stack sets, you must explicitly acknowledge - // this by specifying one of these capabilities. The following IAM resources - // require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM - // capability. - // - // * If you have IAM resources, you can specify either capability. - // - // * - // If you have IAM resources with custom names, you must specify - // CAPABILITY_NAMED_IAM. - // - // * If you don't specify either of these capabilities, - // CloudFormation returns an InsufficientCapabilities error. - // - // If your stack - // template contains these resources, we recommend that you review all permissions - // associated with them and edit their permissions if necessary. - // - // * - // AWS::IAM::AccessKey - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) - // - // * - // AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) - // - // * - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) - // - // * - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) - // - // * - // AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) - // - // * - // AWS::IAM::User - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) - // - // * - // AWS::IAM::UserToGroupAddition - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) - // - // For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). - // - // * - // CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set - // template references one or more macros, you must create the stack set directly - // from the processed template, without first reviewing the resulting changes in a - // change set. To create the stack set directly, you must acknowledge this - // capability. For more information, see Using CloudFormation Macros to Perform - // Custom Processing on Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). - // Stack sets with service-managed permissions don't currently support the use of - // macros in templates. (This includes the AWS::Include - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) - // transforms, which are macros hosted by CloudFormation.) Even if you specify this - // capability for a stack set with service-managed permissions, if you reference a - // macro in your template the stack set operation will fail. + // - CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include + // resources that can affect permissions in your Amazon Web Services account; for + // example, by creating new Identity and Access Management (IAM) users. For those + // stack sets, you must explicitly acknowledge this by specifying one of these + // capabilities. The following IAM resources require you to specify either the + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. + // - If you have IAM resources, you can specify either capability. + // - If you have IAM resources with custom names, you must specify + // CAPABILITY_NAMED_IAM . + // - If you don't specify either of these capabilities, CloudFormation returns + // an InsufficientCapabilities error. If your stack template contains these + // resources, we recommend that you review all permissions associated with them and + // edit their permissions if necessary. + // - AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // - AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // - AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // - AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) + // - AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // - AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) + // - AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) + // For more information, see Acknowledging IAM Resources in CloudFormation + // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . + // - CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set + // template references one or more macros, you must create the stack set directly + // from the processed template, without first reviewing the resulting changes in a + // change set. To create the stack set directly, you must acknowledge this + // capability. For more information, see Using CloudFormation Macros to Perform + // Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) + // . Stack sets with service-managed permissions don't currently support the use of + // macros in templates. (This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // transforms, which are macros hosted by CloudFormation.) Even if you specify this + // capability for a stack set with service-managed permissions, if you reference a + // macro in your template the stack set operation will fail. Capabilities []types.Capability // A unique identifier for this CreateStackSet request. Specify this token if you @@ -159,15 +117,15 @@ type CreateStackSetInput struct { // stack set's purpose or other important information. Description *string - // The name of the IAM execution role to use to create the stack set. If you do not - // specify an execution role, CloudFormation uses the + // The name of the IAM execution role to use to create the stack set. If you do + // not specify an execution role, CloudFormation uses the // AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify // an IAM role only if you are using customized execution roles to control which // stack resources users and groups can include in their stack sets. ExecutionRoleName *string - // Describes whether StackSets performs non-conflicting operations concurrently and - // queues conflicting operations. + // Describes whether StackSets performs non-conflicting operations concurrently + // and queues conflicting operations. ManagedExecution *types.ManagedExecution // The input parameters for the stack set template. @@ -175,43 +133,38 @@ type CreateStackSetInput struct { // Describes how the IAM roles required for stack set operations are created. By // default, SELF-MANAGED is specified. - // - // * With self-managed permissions, you must - // create the administrator and execution roles required to deploy to target - // accounts. For more information, see Grant Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // - // * - // With service-managed permissions, StackSets automatically creates the IAM roles - // required to deploy to accounts managed by Organizations. For more information, - // see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + // - With self-managed permissions, you must create the administrator and + // execution roles required to deploy to target accounts. For more information, see + // Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) + // . + // - With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) + // . PermissionModel types.PermissionModels - // The stack ID you are importing into a new stack set. Specify the Amazon Resource - // Name (ARN) of the stack. + // The stack ID you are importing into a new stack set. Specify the Amazon + // Resource Name (ARN) of the stack. StackId *string - // The key-value pairs to associate with this stack set and the stacks created from - // it. CloudFormation also propagates these tags to supported resources that are - // created in the stacks. A maximum number of 50 tags can be specified. If you - // specify tags as part of a CreateStackSet action, CloudFormation checks to see if - // you have the required IAM permission to tag resources. If you don't, the entire - // CreateStackSet action fails with an access denied error, and the stack set is - // not created. + // The key-value pairs to associate with this stack set and the stacks created + // from it. CloudFormation also propagates these tags to supported resources that + // are created in the stacks. A maximum number of 50 tags can be specified. If you + // specify tags as part of a CreateStackSet action, CloudFormation checks to see + // if you have the required IAM permission to tag resources. If you don't, the + // entire CreateStackSet action fails with an access denied error, and the stack + // set is not created. Tags []types.Tag // The structure that contains the template body, with a minimum length of 1 byte - // and a maximum length of 51,200 bytes. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // and a maximum length of 51,200 bytes. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify either the // TemplateBody or the TemplateURL parameter, but not both. TemplateBody *string // The location of the file that contains the template body. The URL must point to // a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket - // or a Systems Manager document. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // or a Systems Manager document. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify either the // TemplateBody or the TemplateURL parameter, but not both. TemplateURL *string diff --git a/service/cloudformation/api_op_DeactivateType.go b/service/cloudformation/api_op_DeactivateType.go index a6e16443149..e1f4a305f43 100644 --- a/service/cloudformation/api_op_DeactivateType.go +++ b/service/cloudformation/api_op_DeactivateType.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deactivates a public extension that was previously activated in this account and -// region. Once deactivated, an extension can't be used in any CloudFormation +// Deactivates a public extension that was previously activated in this account +// and region. Once deactivated, an extension can't be used in any CloudFormation // operation. This includes stack update operations where the stack template // includes the extension, even if no updates are being made to the extension. In // addition, deactivated extensions aren't automatically updated if a new version @@ -35,16 +35,16 @@ func (c *Client) DeactivateType(ctx context.Context, params *DeactivateTypeInput type DeactivateTypeInput struct { // The Amazon Resource Name (ARN) for the extension, in this account and region. - // Conditional: You must specify either Arn, or TypeName and Type. + // Conditional: You must specify either Arn , or TypeName and Type . Arn *string - // The extension type. Conditional: You must specify either Arn, or TypeName and - // Type. + // The extension type. Conditional: You must specify either Arn , or TypeName and + // Type . Type types.ThirdPartyType // The type name of the extension, in this account and region. If you specified a // type name alias when enabling the extension, use the type name alias. - // Conditional: You must specify either Arn, or TypeName and Type. + // Conditional: You must specify either Arn , or TypeName and Type . TypeName *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DeleteChangeSet.go b/service/cloudformation/api_op_DeleteChangeSet.go index a27e4f7461d..b20651d4723 100644 --- a/service/cloudformation/api_op_DeleteChangeSet.go +++ b/service/cloudformation/api_op_DeleteChangeSet.go @@ -16,7 +16,7 @@ import ( // specifies True during the creation of the nested change set, then // DeleteChangeSet will delete all change sets that belong to the stacks hierarchy // and will also delete all change sets for nested stacks with the status of -// REVIEW_IN_PROGRESS. +// REVIEW_IN_PROGRESS . func (c *Client) DeleteChangeSet(ctx context.Context, params *DeleteChangeSetInput, optFns ...func(*Options)) (*DeleteChangeSetOutput, error) { if params == nil { params = &DeleteChangeSetInput{} diff --git a/service/cloudformation/api_op_DeleteStack.go b/service/cloudformation/api_op_DeleteStack.go index 2ecfc795130..b50678a1945 100644 --- a/service/cloudformation/api_op_DeleteStack.go +++ b/service/cloudformation/api_op_DeleteStack.go @@ -36,19 +36,19 @@ type DeleteStackInput struct { // This member is required. StackName *string - // A unique identifier for this DeleteStack request. Specify this token if you plan - // to retry requests so that CloudFormation knows that you're not attempting to - // delete a stack with the same name. You might retry DeleteStack requests to + // A unique identifier for this DeleteStack request. Specify this token if you + // plan to retry requests so that CloudFormation knows that you're not attempting + // to delete a stack with the same name. You might retry DeleteStack requests to // ensure that CloudFormation successfully received them. All events initiated by a // given stack operation are assigned the same client request token, which you can // use to track operations. For example, if you execute a CreateStack operation - // with the token token1, then all the StackEvents generated by that operation will - // have ClientRequestToken set as token1. In the console, stack operations display - // the client request token on the Events tab. Stack operations that are initiated - // from the console use the token format Console-StackOperation-ID, which helps you - // easily identify the stack operation . For example, if you create a stack using - // the console, each stack event would be assigned the same token in the following - // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + // with the token token1 , then all the StackEvents generated by that operation + // will have ClientRequestToken set as token1 . In the console, stack operations + // display the client request token on the Events tab. Stack operations that are + // initiated from the console use the token format Console-StackOperation-ID, which + // helps you easily identify the stack operation . For example, if you create a + // stack using the console, each stack event would be assigned the same token in + // the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 . ClientRequestToken *string // For stacks in the DELETE_FAILED state, a list of resource logical IDs that are diff --git a/service/cloudformation/api_op_DeleteStackInstances.go b/service/cloudformation/api_op_DeleteStackInstances.go index 06f253377af..61a114c591f 100644 --- a/service/cloudformation/api_op_DeleteStackInstances.go +++ b/service/cloudformation/api_op_DeleteStackInstances.go @@ -36,10 +36,10 @@ type DeleteStackInstancesInput struct { // This member is required. Regions []string - // Removes the stack instances from the specified stack set, but doesn't delete the - // stacks. You can't reassociate a retained stack or add an existing, saved stack - // to a new stack set. For more information, see Stack set operation options - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). + // Removes the stack instances from the specified stack set, but doesn't delete + // the stacks. You can't reassociate a retained stack or add an existing, saved + // stack to a new stack set. For more information, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) + // . // // This member is required. RetainStacks bool @@ -52,27 +52,23 @@ type DeleteStackInstancesInput struct { // [Self-managed permissions] The names of the Amazon Web Services accounts that // you want to delete stack instances for. You can specify Accounts or - // DeploymentTargets, but not both. + // DeploymentTargets , but not both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The Organizations accounts from which to delete - // stack instances. You can specify Accounts or DeploymentTargets, but not both. + // stack instances. You can specify Accounts or DeploymentTargets , but not both. DeploymentTargets *types.DeploymentTargets // The unique identifier for this stack set operation. If you don't specify an @@ -81,7 +77,7 @@ type DeleteStackInstancesInput struct { // stack set operation only once, even if you retry the request multiple times. You // can retry stack set operation requests to ensure that CloudFormation // successfully received them. Repeating this stack set operation with a new - // operation ID retries all stack instances whose status is OUTDATED. + // operation ID retries all stack instances whose status is OUTDATED . OperationId *string // Preferences for how CloudFormation performs this stack set operation. diff --git a/service/cloudformation/api_op_DeleteStackSet.go b/service/cloudformation/api_op_DeleteStackSet.go index e8a6e35cd99..5df5933bf0b 100644 --- a/service/cloudformation/api_op_DeleteStackSet.go +++ b/service/cloudformation/api_op_DeleteStackSet.go @@ -13,7 +13,7 @@ import ( // Deletes a stack set. Before you can delete a stack set, all its member stack // instances must be deleted. For more information about how to complete this, see -// DeleteStackInstances. +// DeleteStackInstances . func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput, optFns ...func(*Options)) (*DeleteStackSetOutput, error) { if params == nil { params = &DeleteStackSetInput{} @@ -31,8 +31,8 @@ func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput type DeleteStackSetInput struct { - // The name or unique ID of the stack set that you're deleting. You can obtain this - // value by running ListStackSets. + // The name or unique ID of the stack set that you're deleting. You can obtain + // this value by running ListStackSets . // // This member is required. StackSetName *string @@ -41,16 +41,12 @@ type DeleteStackSetInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DeregisterType.go b/service/cloudformation/api_op_DeregisterType.go index 4a88c578de5..0a623dc2394 100644 --- a/service/cloudformation/api_op_DeregisterType.go +++ b/service/cloudformation/api_op_DeregisterType.go @@ -21,8 +21,8 @@ import ( // extension if there are other active version of that extension. If you do // deregister the default version of an extension, the extension type itself is // deregistered as well and marked as deprecated. To view the deprecation status of -// an extension or extension version, use DescribeType -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html). +// an extension or extension version, use DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) +// . func (c *Client) DeregisterType(ctx context.Context, params *DeregisterTypeInput, optFns ...func(*Options)) (*DeregisterTypeOutput, error) { if params == nil { params = &DeregisterTypeInput{} @@ -41,15 +41,15 @@ func (c *Client) DeregisterType(ctx context.Context, params *DeregisterTypeInput type DeregisterTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify - // either TypeName and Type, or Arn. + // either TypeName and Type , or Arn . Arn *string - // The kind of extension. Conditional: You must specify either TypeName and Type, - // or Arn. + // The kind of extension. Conditional: You must specify either TypeName and Type , + // or Arn . Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and - // Type, or Arn. + // Type , or Arn . TypeName *string // The ID of a specific version of the extension. The version ID is the value at diff --git a/service/cloudformation/api_op_DescribeAccountLimits.go b/service/cloudformation/api_op_DescribeAccountLimits.go index fd60d5e4657..564c592a96d 100644 --- a/service/cloudformation/api_op_DescribeAccountLimits.go +++ b/service/cloudformation/api_op_DescribeAccountLimits.go @@ -14,8 +14,7 @@ import ( // Retrieves your account's CloudFormation limits, such as the maximum number of // stacks that you can create in your account. For more information about account -// limits, see CloudFormation Quotas -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) +// limits, see CloudFormation Quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) // in the CloudFormation User Guide. func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { diff --git a/service/cloudformation/api_op_DescribeChangeSet.go b/service/cloudformation/api_op_DescribeChangeSet.go index 7464f43bcde..16f13604b2d 100644 --- a/service/cloudformation/api_op_DescribeChangeSet.go +++ b/service/cloudformation/api_op_DescribeChangeSet.go @@ -20,8 +20,7 @@ import ( // Returns the inputs for the change set and a list of changes that CloudFormation // will make if you execute the change set. For more information, see Updating -// Stacks Using Change Sets -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) +// Stacks Using Change Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) // in the CloudFormation User Guide. func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error) { if params == nil { @@ -47,12 +46,12 @@ type DescribeChangeSetInput struct { // This member is required. ChangeSetName *string - // A string (provided by the DescribeChangeSet response output) that identifies the - // next page of information that you want to retrieve. + // A string (provided by the DescribeChangeSet response output) that identifies + // the next page of information that you want to retrieve. NextToken *string - // If you specified the name of a change set, specify the stack name or ID (ARN) of - // the change set you want to describe. + // If you specified the name of a change set, specify the stack name or ID (ARN) + // of the change set you want to describe. StackName *string noSmithyDocumentSerde @@ -81,26 +80,25 @@ type DescribeChangeSetOutput struct { // Information about the change set. Description *string - // If the change set execution status is AVAILABLE, you can execute the change set. - // If you can't execute the change set, the status indicates why. For example, a - // change set might be in an UNAVAILABLE state because CloudFormation is still + // If the change set execution status is AVAILABLE , you can execute the change + // set. If you can't execute the change set, the status indicates why. For example, + // a change set might be in an UNAVAILABLE state because CloudFormation is still // creating it or in an OBSOLETE state because the stack was already updated. ExecutionStatus types.ExecutionStatus - // Verifies if IncludeNestedStacks is set to True. + // Verifies if IncludeNestedStacks is set to True . IncludeNestedStacks *bool // If the output exceeds 1 MB, a string that identifies the next page of changes. // If there is no additional page, this value is null. NextToken *string - // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will - // be associated with the stack if you execute the change set. + // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that + // will be associated with the stack if you execute the change set. NotificationARNs []string // A list of Parameter structures that describes the input parameters and their - // values used to create the change set. For more information, see the Parameter - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) + // values used to create the change set. For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []types.Parameter @@ -123,12 +121,12 @@ type DescribeChangeSetOutput struct { // The name of the stack that's associated with the change set. StackName *string - // The current status of the change set, such as CREATE_IN_PROGRESS, - // CREATE_COMPLETE, or FAILED. + // The current status of the change set, such as CREATE_IN_PROGRESS , + // CREATE_COMPLETE , or FAILED . Status types.ChangeSetStatus - // A description of the change set's status. For example, if your attempt to create - // a change set failed, CloudFormation shows the error message. + // A description of the change set's status. For example, if your attempt to + // create a change set failed, CloudFormation shows the error message. StatusReason *string // If you execute the change set, the tags that will be associated with the stack. @@ -225,8 +223,8 @@ type ChangeSetCreateCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ChangeSetCreateCompleteWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ChangeSetCreateCompleteWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/cloudformation/api_op_DescribeChangeSetHooks.go b/service/cloudformation/api_op_DescribeChangeSetHooks.go index b93d617e451..98e503acdd0 100644 --- a/service/cloudformation/api_op_DescribeChangeSetHooks.go +++ b/service/cloudformation/api_op_DescribeChangeSetHooks.go @@ -36,7 +36,7 @@ type DescribeChangeSetHooksInput struct { // This member is required. ChangeSetName *string - // If specified, lists only the hooks related to the specified LogicalResourceId. + // If specified, lists only the hooks related to the specified LogicalResourceId . LogicalResourceId *string // A string, provided by the DescribeChangeSetHooks response output, that diff --git a/service/cloudformation/api_op_DescribePublisher.go b/service/cloudformation/api_op_DescribePublisher.go index 7402c59a881..f5af9c0e45f 100644 --- a/service/cloudformation/api_op_DescribePublisher.go +++ b/service/cloudformation/api_op_DescribePublisher.go @@ -12,17 +12,12 @@ import ( ) // Returns information about a CloudFormation extension publisher. If you don't -// supply a PublisherId, and you have registered as an extension publisher, +// supply a PublisherId , and you have registered as an extension publisher, // DescribePublisher returns information about your own publisher account. For more // information about registering as a publisher, see: -// -// * RegisterPublisher -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html) -// -// * -// Publishing extensions to make them available for public use -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) -// in the CloudFormation CLI User Guide +// - RegisterPublisher (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html) +// - Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) +// in the CloudFormation CLI User Guide func (c *Client) DescribePublisher(ctx context.Context, params *DescribePublisherInput, optFns ...func(*Options)) (*DescribePublisherOutput, error) { if params == nil { params = &DescribePublisherInput{} @@ -40,9 +35,9 @@ func (c *Client) DescribePublisher(ctx context.Context, params *DescribePublishe type DescribePublisherInput struct { - // The ID of the extension publisher. If you don't supply a PublisherId, and you - // have registered as an extension publisher, DescribePublisher returns information - // about your own publisher account. + // The ID of the extension publisher. If you don't supply a PublisherId , and you + // have registered as an extension publisher, DescribePublisher returns + // information about your own publisher account. PublisherId *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go index 58c58482c21..d4ba9ac6265 100644 --- a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go +++ b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go @@ -18,11 +18,10 @@ import ( // and any values specified as template parameters. A stack is considered to have // drifted if one or more of its resources have drifted. For more information about // stack and resource drift, see Detecting Unregulated Configuration Changes to -// Stacks and Resources -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). -// Use DetectStackDrift to initiate a stack drift detection operation. +// Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) +// . Use DetectStackDrift to initiate a stack drift detection operation. // DetectStackDrift returns a StackDriftDetectionId you can use to monitor the -// progress of the operation using DescribeStackDriftDetectionStatus. Once the +// progress of the operation using DescribeStackDriftDetectionStatus . Once the // drift detection operation has completed, use DescribeStackResourceDrifts to // return drift information about the stack and its resources. func (c *Client) DescribeStackDriftDetectionStatus(ctx context.Context, params *DescribeStackDriftDetectionStatusInput, optFns ...func(*Options)) (*DescribeStackDriftDetectionStatusOutput, error) { @@ -56,21 +55,17 @@ type DescribeStackDriftDetectionStatusInput struct { type DescribeStackDriftDetectionStatusOutput struct { // The status of the stack drift detection operation. - // - // * DETECTION_COMPLETE: The - // stack drift detection operation has successfully completed for all resources in - // the stack that support drift detection. (Resources that don't currently support - // stack detection remain unchecked.) If you specified logical resource IDs for - // CloudFormation to use as a filter for the stack drift detection operation, only - // the resources with those logical IDs are checked for drift. - // - // * DETECTION_FAILED: - // The stack drift detection operation has failed for at least one resource in the - // stack. Results will be available for resources on which CloudFormation - // successfully completed drift detection. - // - // * DETECTION_IN_PROGRESS: The stack - // drift detection operation is currently in progress. + // - DETECTION_COMPLETE : The stack drift detection operation has successfully + // completed for all resources in the stack that support drift detection. + // (Resources that don't currently support stack detection remain unchecked.) If + // you specified logical resource IDs for CloudFormation to use as a filter for the + // stack drift detection operation, only the resources with those logical IDs are + // checked for drift. + // - DETECTION_FAILED : The stack drift detection operation has failed for at + // least one resource in the stack. Results will be available for resources on + // which CloudFormation successfully completed drift detection. + // - DETECTION_IN_PROGRESS : The stack drift detection operation is currently in + // progress. // // This member is required. DetectionStatus types.StackDriftDetectionStatus @@ -97,25 +92,20 @@ type DescribeStackDriftDetectionStatusOutput struct { DetectionStatusReason *string // Total number of stack resources that have drifted. This is NULL until the drift - // detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 - // for stacks whose drift status is IN_SYNC. + // detection operation reaches a status of DETECTION_COMPLETE . This value will be + // 0 for stacks whose drift status is IN_SYNC . DriftedStackResourceCount *int32 // Status of the stack's actual configuration compared to its expected // configuration. - // - // * DRIFTED: The stack differs from its expected template - // configuration. A stack is considered to have drifted if one or more of its - // resources have drifted. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the - // stack differs from its expected template configuration. - // - // * IN_SYNC: The stack's - // actual configuration matches its expected template configuration. - // - // * UNKNOWN: - // This value is reserved for future use. + // - DRIFTED : The stack differs from its expected template configuration. A + // stack is considered to have drifted if one or more of its resources have + // drifted. + // - NOT_CHECKED : CloudFormation hasn't checked if the stack differs from its + // expected template configuration. + // - IN_SYNC : The stack's actual configuration matches its expected template + // configuration. + // - UNKNOWN : This value is reserved for future use. StackDriftStatus types.StackDriftStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_DescribeStackEvents.go b/service/cloudformation/api_op_DescribeStackEvents.go index 605f9ef654c..faa6da4312a 100644 --- a/service/cloudformation/api_op_DescribeStackEvents.go +++ b/service/cloudformation/api_op_DescribeStackEvents.go @@ -13,8 +13,7 @@ import ( ) // Returns all stack related events for a specified stack in reverse chronological -// order. For more information about a stack's event history, go to Stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html) +// order. For more information about a stack's event history, go to Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html) // in the CloudFormation User Guide. You can list events for stacks that have // failed to create or have been deleted by specifying the unique stack identifier // (stack ID). @@ -41,13 +40,9 @@ type DescribeStackEventsInput struct { // The name or the unique stack ID that's associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. // Default: There is no default value. StackName *string @@ -130,8 +125,8 @@ func (c *Client) addOperationDescribeStackEventsMiddlewares(stack *middleware.St return nil } -// DescribeStackEventsAPIClient is a client that implements the DescribeStackEvents -// operation. +// DescribeStackEventsAPIClient is a client that implements the +// DescribeStackEvents operation. type DescribeStackEventsAPIClient interface { DescribeStackEvents(context.Context, *DescribeStackEventsInput, ...func(*Options)) (*DescribeStackEventsOutput, error) } diff --git a/service/cloudformation/api_op_DescribeStackInstance.go b/service/cloudformation/api_op_DescribeStackInstance.go index 92dab0ac330..7acb5cd540d 100644 --- a/service/cloudformation/api_op_DescribeStackInstance.go +++ b/service/cloudformation/api_op_DescribeStackInstance.go @@ -13,7 +13,7 @@ import ( // Returns the stack instance that's associated with the specified stack set, // Amazon Web Services account, and Region. For a list of stack instances that are -// associated with a specific stack set, use ListStackInstances. +// associated with a specific stack set, use ListStackInstances . func (c *Client) DescribeStackInstance(ctx context.Context, params *DescribeStackInstanceInput, optFns ...func(*Options)) (*DescribeStackInstanceOutput, error) { if params == nil { params = &DescribeStackInstanceInput{} @@ -52,16 +52,12 @@ type DescribeStackInstanceInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackResource.go b/service/cloudformation/api_op_DescribeStackResource.go index c1ea0d5af98..c30e9a0daad 100644 --- a/service/cloudformation/api_op_DescribeStackResource.go +++ b/service/cloudformation/api_op_DescribeStackResource.go @@ -32,21 +32,17 @@ func (c *Client) DescribeStackResource(ctx context.Context, params *DescribeStac // The input for DescribeStackResource action. type DescribeStackResourceInput struct { - // The logical name of the resource as specified in the template. Default: There is - // no default value. + // The logical name of the resource as specified in the template. Default: There + // is no default value. // // This member is required. LogicalResourceId *string // The name or the unique stack ID that's associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. // Default: There is no default value. // // This member is required. diff --git a/service/cloudformation/api_op_DescribeStackResourceDrifts.go b/service/cloudformation/api_op_DescribeStackResourceDrifts.go index 10b35f326c6..a26c5b4a07f 100644 --- a/service/cloudformation/api_op_DescribeStackResourceDrifts.go +++ b/service/cloudformation/api_op_DescribeStackResourceDrifts.go @@ -19,9 +19,8 @@ import ( // checked for drift. Resources that haven't yet been checked for drift aren't // included. Resources that don't currently support drift detection aren't checked, // and so not included. For a list of resources that support drift detection, see -// Resources that Support Drift Detection -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). -// Use DetectStackResourceDrift to detect drift on individual resources, or +// Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) +// . Use DetectStackResourceDrift to detect drift on individual resources, or // DetectStackDrift to detect drift on all supported resources for a given stack. func (c *Client) DescribeStackResourceDrifts(ctx context.Context, params *DescribeStackResourceDriftsInput, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error) { if params == nil { @@ -47,8 +46,8 @@ type DescribeStackResourceDriftsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // A string that identifies the next page of stack resource drift results. @@ -56,18 +55,13 @@ type DescribeStackResourceDriftsInput struct { // The resource drift status values to use as filters for the resource drift // results returned. - // - // * DELETED: The resource differs from its expected template - // configuration in that the resource has been deleted. - // - // * MODIFIED: One or more - // resource properties differ from their expected template values. - // - // * IN_SYNC: The - // resource's actual configuration matches its expected template configuration. - // - // * - // NOT_CHECKED: CloudFormation doesn't currently return this value. + // - DELETED : The resource differs from its expected template configuration in + // that the resource has been deleted. + // - MODIFIED : One or more resource properties differ from their expected + // template values. + // - IN_SYNC : The resource's actual configuration matches its expected template + // configuration. + // - NOT_CHECKED : CloudFormation doesn't currently return this value. StackResourceDriftStatusFilters []types.StackResourceDriftStatus noSmithyDocumentSerde @@ -82,8 +76,8 @@ type DescribeStackResourceDriftsOutput struct { // Resources that haven't yet been checked for drift aren't included. Resources // that do not currently support drift detection aren't checked, and so not // included. For a list of resources that support drift detection, see Resources - // that Support Drift Detection - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). + // that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) + // . // // This member is required. StackResourceDrifts []types.StackResourceDrift @@ -91,7 +85,7 @@ type DescribeStackResourceDriftsOutput struct { // If the request doesn't return all the remaining results, NextToken is set to a // token. To retrieve the next set of results, call DescribeStackResourceDrifts // again and assign that token to the request object's NextToken parameter. If the - // request returns all results, NextToken is set to null. + // request returns all results, NextToken is set to null . NextToken *string // Metadata pertaining to the operation's result. @@ -176,8 +170,8 @@ var _ DescribeStackResourceDriftsAPIClient = (*Client)(nil) type DescribeStackResourceDriftsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_DescribeStackResources.go b/service/cloudformation/api_op_DescribeStackResources.go index 3332892eb37..365ef2101f3 100644 --- a/service/cloudformation/api_op_DescribeStackResources.go +++ b/service/cloudformation/api_op_DescribeStackResources.go @@ -12,19 +12,18 @@ import ( ) // Returns Amazon Web Services resource descriptions for running and deleted -// stacks. If StackName is specified, all the associated resources that are part of -// the stack are returned. If PhysicalResourceId is specified, the associated +// stacks. If StackName is specified, all the associated resources that are part +// of the stack are returned. If PhysicalResourceId is specified, the associated // resources of the stack that the resource belongs to are returned. Only the first // 100 resources will be returned. If your stack has more resources than this, you // should use ListStackResources instead. For deleted stacks, // DescribeStackResources returns resource information for up to 90 days after the -// stack has been deleted. You must specify either StackName or PhysicalResourceId, -// but not both. In addition, you can specify LogicalResourceId to filter the -// returned result. For more information about resources, the LogicalResourceId and -// PhysicalResourceId, go to the CloudFormation User Guide -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/). A -// ValidationError is returned if you specify both StackName and PhysicalResourceId -// in the same request. +// stack has been deleted. You must specify either StackName or PhysicalResourceId +// , but not both. In addition, you can specify LogicalResourceId to filter the +// returned result. For more information about resources, the LogicalResourceId +// and PhysicalResourceId , go to the CloudFormation User Guide (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/) +// . A ValidationError is returned if you specify both StackName and +// PhysicalResourceId in the same request. func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeStackResourcesInput, optFns ...func(*Options)) (*DescribeStackResourcesOutput, error) { if params == nil { params = &DescribeStackResourcesInput{} @@ -43,30 +42,26 @@ func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeSta // The input for DescribeStackResources action. type DescribeStackResourcesInput struct { - // The logical name of the resource as specified in the template. Default: There is - // no default value. + // The logical name of the resource as specified in the template. Default: There + // is no default value. LogicalResourceId *string // The name or unique identifier that corresponds to a physical instance ID of a // resource supported by CloudFormation. For example, for an Amazon Elastic Compute - // Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can + // Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId . You can // pass the EC2 InstanceId to DescribeStackResources to find which stack the // instance belongs to and what other resources are part of the stack. Required: - // Conditional. If you don't specify PhysicalResourceId, you must specify - // StackName. Default: There is no default value. + // Conditional. If you don't specify PhysicalResourceId , you must specify + // StackName . Default: There is no default value. PhysicalResourceId *string // The name or the unique stack ID that is associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // - // Default: There is no default value. Required: Conditional. If you - // don't specify StackName, you must specify PhysicalResourceId. + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. + // Default: There is no default value. Required: Conditional. If you don't specify + // StackName , you must specify PhysicalResourceId . StackName *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackSet.go b/service/cloudformation/api_op_DescribeStackSet.go index d0ee230e20c..93839d77715 100644 --- a/service/cloudformation/api_op_DescribeStackSet.go +++ b/service/cloudformation/api_op_DescribeStackSet.go @@ -38,16 +38,12 @@ type DescribeStackSetInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackSetOperation.go b/service/cloudformation/api_op_DescribeStackSetOperation.go index af784976dce..360ff2fbe24 100644 --- a/service/cloudformation/api_op_DescribeStackSetOperation.go +++ b/service/cloudformation/api_op_DescribeStackSetOperation.go @@ -43,16 +43,12 @@ type DescribeStackSetOperationInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStacks.go b/service/cloudformation/api_op_DescribeStacks.go index 715bccdad8a..4db0d695582 100644 --- a/service/cloudformation/api_op_DescribeStacks.go +++ b/service/cloudformation/api_op_DescribeStacks.go @@ -18,9 +18,9 @@ import ( "time" ) -// Returns the description for the specified stack; if no stack name was specified, -// then it returns the description for all the stacks created. If the stack doesn't -// exist, an ValidationError is returned. +// Returns the description for the specified stack; if no stack name was +// specified, then it returns the description for all the stacks created. If the +// stack doesn't exist, an ValidationError is returned. func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error) { if params == nil { params = &DescribeStacksInput{} @@ -44,13 +44,9 @@ type DescribeStacksInput struct { // The name or the unique stack ID that's associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. // Default: There is no default value. StackName *string @@ -225,9 +221,10 @@ type StackCreateCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackCreateCompleteWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackCreateCompleteWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -267,9 +264,9 @@ func NewStackCreateCompleteWaiter(client DescribeStacksAPIClient, optFns ...func } } -// Wait calls the waiter function for StackCreateComplete waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for StackCreateComplete waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *StackCreateCompleteWaiter) Wait(ctx context.Context, params *DescribeStacksInput, maxWaitDur time.Duration, optFns ...func(*StackCreateCompleteWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -533,9 +530,10 @@ type StackDeleteCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackDeleteCompleteWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackDeleteCompleteWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -575,9 +573,9 @@ func NewStackDeleteCompleteWaiter(client DescribeStacksAPIClient, optFns ...func } } -// Wait calls the waiter function for StackDeleteComplete waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for StackDeleteComplete waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *StackDeleteCompleteWaiter) Wait(ctx context.Context, params *DescribeStacksInput, maxWaitDur time.Duration, optFns ...func(*StackDeleteCompleteWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -888,9 +886,9 @@ type StackExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1047,9 +1045,10 @@ type StackImportCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackImportCompleteWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackImportCompleteWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1089,9 +1088,9 @@ func NewStackImportCompleteWaiter(client DescribeStacksAPIClient, optFns ...func } } -// Wait calls the waiter function for StackImportComplete waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for StackImportComplete waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *StackImportCompleteWaiter) Wait(ctx context.Context, params *DescribeStacksInput, maxWaitDur time.Duration, optFns ...func(*StackImportCompleteWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -1355,9 +1354,10 @@ type StackRollbackCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackRollbackCompleteWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackRollbackCompleteWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1615,9 +1615,10 @@ type StackUpdateCompleteWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StackUpdateCompleteWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StackUpdateCompleteWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1657,9 +1658,9 @@ func NewStackUpdateCompleteWaiter(client DescribeStacksAPIClient, optFns ...func } } -// Wait calls the waiter function for StackUpdateComplete waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for StackUpdateComplete waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *StackUpdateCompleteWaiter) Wait(ctx context.Context, params *DescribeStacksInput, maxWaitDur time.Duration, optFns ...func(*StackUpdateCompleteWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/cloudformation/api_op_DescribeType.go b/service/cloudformation/api_op_DescribeType.go index 445591cf5c9..81d6f094bd0 100644 --- a/service/cloudformation/api_op_DescribeType.go +++ b/service/cloudformation/api_op_DescribeType.go @@ -12,8 +12,8 @@ import ( "time" ) -// Returns detailed information about an extension that has been registered. If you -// specify a VersionId, DescribeType returns information about that specific +// Returns detailed information about an extension that has been registered. If +// you specify a VersionId , DescribeType returns information about that specific // extension version. Otherwise, it returns information about the default extension // version. func (c *Client) DescribeType(ctx context.Context, params *DescribeTypeInput, optFns ...func(*Options)) (*DescribeTypeOutput, error) { @@ -34,7 +34,7 @@ func (c *Client) DescribeType(ctx context.Context, params *DescribeTypeInput, op type DescribeTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify - // either TypeName and Type, or Arn. + // either TypeName and Type , or Arn . Arn *string // The version number of a public third-party extension. @@ -44,17 +44,17 @@ type DescribeTypeInput struct { // Services are not assigned a publisher ID. PublisherId *string - // The kind of extension. Conditional: You must specify either TypeName and Type, - // or Arn. + // The kind of extension. Conditional: You must specify either TypeName and Type , + // or Arn . Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and - // Type, or Arn. + // Type , or Arn . TypeName *string // The ID of a specific version of the extension. The version ID is the value at // the end of the Amazon Resource Name (ARN) assigned to the extension version when - // it is registered. If you specify a VersionId, DescribeType returns information + // it is registered. If you specify a VersionId , DescribeType returns information // about that specific extension version. Otherwise, it returns information about // the default extension version. VersionId *string @@ -74,36 +74,28 @@ type DescribeTypeOutput struct { // CloudFormation User Guide. AutoUpdate *bool - // A JSON string that represent the current configuration data for the extension in - // this account and region. To set the configuration data for an extension, use - // SetTypeConfiguration - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html). - // For more information, see Configuring extensions at the account level - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) + // A JSON string that represent the current configuration data for the extension + // in this account and region. To set the configuration data for an extension, use + // SetTypeConfiguration (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) + // . For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. ConfigurationSchema *string - // The ID of the default version of the extension. The default version is used when - // the extension version isn't specified. This applies only to private extensions - // you have registered in your account. For public extensions, both those provided - // by Amazon Web Services and published by third parties, CloudFormation returns - // null. For more information, see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). - // To set the default version of an extension, use SetTypeDefaultVersion. + // The ID of the default version of the extension. The default version is used + // when the extension version isn't specified. This applies only to private + // extensions you have registered in your account. For public extensions, both + // those provided by Amazon Web Services and published by third parties, + // CloudFormation returns null . For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . To set the default version of an extension, use SetTypeDefaultVersion . DefaultVersionId *string // The deprecation status of the extension version. Valid values include: - // - // * LIVE: - // The extension is activated or registered and can be used in CloudFormation - // operations, dependent on its provisioning behavior and visibility scope. - // - // * - // DEPRECATED: The extension has been deactivated or deregistered and can no longer - // be used in CloudFormation operations. - // - // For public third-party extensions, - // CloudFormation returns null. + // - LIVE : The extension is activated or registered and can be used in + // CloudFormation operations, dependent on its provisioning behavior and visibility + // scope. + // - DEPRECATED : The extension has been deactivated or deregistered and can no + // longer be used in CloudFormation operations. + // For public third-party extensions, CloudFormation returns null . DeprecatedStatus types.DeprecatedStatus // The description of the extension. @@ -114,50 +106,44 @@ type DescribeTypeOutput struct { // The Amazon Resource Name (ARN) of the IAM execution role used to register the // extension. This applies only to private extensions you have registered in your - // account. For more information, see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). - // If the registered extension calls any Amazon Web Services APIs, you must create - // an IAM execution role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes - // the necessary permissions to call those Amazon Web Services APIs, and provision - // that execution role in your account. CloudFormation then assumes that execution - // role to provide your extension with the appropriate credentials. + // account. For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . If the registered extension calls any Amazon Web Services APIs, you must + // create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) + // that includes the necessary permissions to call those Amazon Web Services APIs, + // and provision that execution role in your account. CloudFormation then assumes + // that execution role to provide your extension with the appropriate credentials. ExecutionRoleArn *string // Whether the extension is activated in the account and region. This only applies // to public third-party extensions. For all other extensions, CloudFormation - // returns null. + // returns null . IsActivated *bool // Whether the specified extension version is set as the default version. This // applies only to private extensions you have registered in your account, and // extensions published by Amazon Web Services. For public third-party extensions, - // whether they are activated in your account, CloudFormation returns null. + // whether they are activated in your account, CloudFormation returns null . IsDefaultVersion *bool // When the specified extension version was registered. This applies only to: - // - // * - // Private extensions you have registered in your account. For more information, - // see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). - // - // * - // Public extensions you have activated in your account with auto-update specified. - // For more information, see ActivateType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). + // - Private extensions you have registered in your account. For more + // information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . + // - Public extensions you have activated in your account with auto-update + // specified. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // . LastUpdated *time.Time // The latest version of a public extension that is available for use. This only // applies if you specify a public extension, and you don't specify a version. For - // all other requests, CloudFormation returns null. + // all other requests, CloudFormation returns null . LatestPublicVersion *string // Contains logging configuration information for private extensions. This applies // only to private extensions you have registered in your account. For public // extensions, both those provided by Amazon Web Services and published by third - // parties, CloudFormation returns null. For more information, see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). + // parties, CloudFormation returns null . For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . LoggingConfig *types.LoggingConfig // For public extensions that have been activated for this account and region, the @@ -169,8 +155,7 @@ type DescribeTypeOutput struct { // enabling the extension in this account and region, CloudFormation treats that // alias as the extension's type name within the account and region, not the type // name of the public extension. For more information, see Specifying aliases to - // refer to extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) + // refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) // in the CloudFormation User Guide. OriginalTypeName *string @@ -178,34 +163,26 @@ type DescribeTypeOutput struct { // CloudFormation determines the provisioning type during registration, based on // the types of handlers in the schema handler package submitted. Valid values // include: - // - // * FULLY_MUTABLE: The resource type includes an update handler to - // process updates to the type during stack update operations. - // - // * IMMUTABLE: The - // resource type doesn't include an update handler, so the type can't be updated - // and must instead be replaced during stack update operations. - // - // * - // NON_PROVISIONABLE: The resource type doesn't include all the following handlers, - // and therefore can't actually be provisioned. - // - // * create - // - // * read - // - // * delete + // - FULLY_MUTABLE : The resource type includes an update handler to process + // updates to the type during stack update operations. + // - IMMUTABLE : The resource type doesn't include an update handler, so the type + // can't be updated and must instead be replaced during stack update operations. + // - NON_PROVISIONABLE : The resource type doesn't include all the following + // handlers, and therefore can't actually be provisioned. + // - create + // - read + // - delete ProvisioningType types.ProvisioningType // The version number of a public third-party extension. This applies only if you // specify a public extension you have activated in your account, or specify a // public extension without specifying a version. For all other extensions, - // CloudFormation returns null. + // CloudFormation returns null . PublicVersionNumber *string // The publisher ID of the extension publisher. This applies only to public // third-party extensions. For private registered extensions, and extensions - // provided by Amazon Web Services, CloudFormation returns null. + // provided by Amazon Web Services, CloudFormation returns null . PublisherId *string // For extensions that are modules, the public third-party extensions that must be @@ -213,16 +190,15 @@ type DescribeTypeOutput struct { RequiredActivatedTypes []types.RequiredActivatedType // The schema that defines the extension. For more information about extension - // schemas, see Resource Provider Schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // schemas, see Resource Provider Schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) // in the CloudFormation CLI User Guide. Schema *string // The URL of the source code for the extension. SourceUrl *string - // When the specified private extension version was registered or activated in your - // account. + // When the specified private extension version was registered or activated in + // your account. TimeCreated *time.Time // The kind of extension. @@ -230,48 +206,37 @@ type DescribeTypeOutput struct { // The name of the extension. If the extension is a public third-party type you // have activated with a type name alias, CloudFormation returns the type name - // alias. For more information, see ActivateType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). + // alias. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // . TypeName *string // The contract test status of the registered extension version. To return the // extension test status of a specific extension version, you must specify - // VersionId. This applies only to registered private extension versions. + // VersionId . This applies only to registered private extension versions. // CloudFormation doesn't return this information for public extensions, whether // they are activated in your account. - // - // * PASSED: The extension has passed all its - // contract tests. An extension must have a test status of PASSED before it can be - // published. For more information, see Publishing extensions to make them - // available for public use - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) - // in the CloudFormation Command Line Interface User Guide. - // - // * FAILED: The - // extension has failed one or more contract tests. - // - // * IN_PROGRESS: Contract tests - // are currently being performed on the extension. - // - // * NOT_TESTED: Contract tests - // haven't been performed on the extension. + // - PASSED : The extension has passed all its contract tests. An extension must + // have a test status of PASSED before it can be published. For more information, + // see Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) + // in the CloudFormation Command Line Interface User Guide. + // - FAILED : The extension has failed one or more contract tests. + // - IN_PROGRESS : Contract tests are currently being performed on the extension. + // - NOT_TESTED : Contract tests haven't been performed on the extension. TypeTestsStatus types.TypeTestsStatus // The description of the test status. To return the extension test status of a - // specific extension version, you must specify VersionId. This applies only to + // specific extension version, you must specify VersionId . This applies only to // registered private extension versions. CloudFormation doesn't return this // information for public extensions, whether they are activated in your account. TypeTestsStatusDescription *string // The scope at which the extension is visible and usable in CloudFormation // operations. Valid values include: - // - // * PRIVATE: The extension is only visible and - // usable within the account in which it is registered. CloudFormation marks any - // extensions you register as PRIVATE. - // - // * PUBLIC: The extension is publicly visible - // and usable within any Amazon Web Services account. + // - PRIVATE : The extension is only visible and usable within the account in + // which it is registered. CloudFormation marks any extensions you register as + // PRIVATE . + // - PUBLIC : The extension is publicly visible and usable within any Amazon Web + // Services account. Visibility types.Visibility // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_DescribeTypeRegistration.go b/service/cloudformation/api_op_DescribeTypeRegistration.go index 63d3b6a3f31..dba3ef172af 100644 --- a/service/cloudformation/api_op_DescribeTypeRegistration.go +++ b/service/cloudformation/api_op_DescribeTypeRegistration.go @@ -18,9 +18,10 @@ import ( // Returns information about an extension's registration, including its current // status and type and version identifiers. When you initiate a registration -// request using RegisterType, you can then use DescribeTypeRegistration to monitor -// the progress of that registration request. Once the registration request has -// completed, use DescribeType to return detailed information about an extension. +// request using RegisterType , you can then use DescribeTypeRegistration to +// monitor the progress of that registration request. Once the registration request +// has completed, use DescribeType to return detailed information about an +// extension. func (c *Client) DescribeTypeRegistration(ctx context.Context, params *DescribeTypeRegistrationInput, optFns ...func(*Options)) (*DescribeTypeRegistrationOutput, error) { if params == nil { params = &DescribeTypeRegistrationInput{} @@ -40,7 +41,7 @@ type DescribeTypeRegistrationInput struct { // The identifier for this registration request. This registration token is // generated by CloudFormation when you initiate a registration request using - // RegisterType. + // RegisterType . // // This member is required. RegistrationToken *string @@ -57,13 +58,13 @@ type DescribeTypeRegistrationOutput struct { ProgressStatus types.RegistrationStatus // The Amazon Resource Name (ARN) of the extension being registered. For - // registration requests with a ProgressStatus of other than COMPLETE, this will be - // null. + // registration requests with a ProgressStatus of other than COMPLETE , this will + // be null . TypeArn *string // The Amazon Resource Name (ARN) of this specific version of the extension being // registered. For registration requests with a ProgressStatus of other than - // COMPLETE, this will be null. + // COMPLETE , this will be null . TypeVersionArn *string // Metadata pertaining to the operation's result. @@ -157,8 +158,8 @@ type TypeRegistrationCompleteWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TypeRegistrationCompleteWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TypeRegistrationCompleteWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/cloudformation/api_op_DetectStackDrift.go b/service/cloudformation/api_op_DetectStackDrift.go index b3789849b5f..edf85780b00 100644 --- a/service/cloudformation/api_op_DetectStackDrift.go +++ b/service/cloudformation/api_op_DetectStackDrift.go @@ -18,14 +18,12 @@ import ( // explicitly defined in the stack template are checked for drift. A stack is // considered to have drifted if one or more of its resources differ from their // expected template configurations. For more information, see Detecting -// Unregulated Configuration Changes to Stacks and Resources -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). -// Use DetectStackDrift to detect drift on all supported resources for a given +// Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) +// . Use DetectStackDrift to detect drift on all supported resources for a given // stack, or DetectStackResourceDrift to detect drift on individual resources. For // a list of stack resources that currently support drift detection, see Resources -// that Support Drift Detection -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). -// DetectStackDrift can take up to several minutes, depending on the number of +// that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) +// . DetectStackDrift can take up to several minutes, depending on the number of // resources contained within the stack. Use DescribeStackDriftDetectionStatus to // monitor the progress of a detect stack drift operation. Once the drift detection // operation has completed, use DescribeStackResourceDrifts to return drift diff --git a/service/cloudformation/api_op_DetectStackResourceDrift.go b/service/cloudformation/api_op_DetectStackResourceDrift.go index 322a68324a0..bb4ce598902 100644 --- a/service/cloudformation/api_op_DetectStackResourceDrift.go +++ b/service/cloudformation/api_op_DetectStackResourceDrift.go @@ -17,14 +17,13 @@ import ( // actual and expected property values for resources in which CloudFormation // detects drift. Only resource properties explicitly defined in the stack template // are checked for drift. For more information about stack and resource drift, see -// Detecting Unregulated Configuration Changes to Stacks and Resources -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). -// Use DetectStackResourceDrift to detect drift on individual resources, or +// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) +// . Use DetectStackResourceDrift to detect drift on individual resources, or // DetectStackDrift to detect drift on all resources in a given stack that support // drift detection. Resources that don't currently support drift detection can't be // checked. For a list of resources that support drift detection, see Resources -// that Support Drift Detection -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). +// that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) +// . func (c *Client) DetectStackResourceDrift(ctx context.Context, params *DetectStackResourceDriftInput, optFns ...func(*Options)) (*DetectStackResourceDriftOutput, error) { if params == nil { params = &DetectStackResourceDriftInput{} diff --git a/service/cloudformation/api_op_DetectStackSetDrift.go b/service/cloudformation/api_op_DetectStackSetDrift.go index 48199b2d780..0ee49080b35 100644 --- a/service/cloudformation/api_op_DetectStackSetDrift.go +++ b/service/cloudformation/api_op_DetectStackSetDrift.go @@ -14,36 +14,29 @@ import ( // Detect drift on a stack set. When CloudFormation performs drift detection on a // stack set, it performs drift detection on the stack associated with each stack -// instance in the stack set. For more information, see How CloudFormation performs -// drift detection on a stack set -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html). -// DetectStackSetDrift returns the OperationId of the stack set drift detection +// instance in the stack set. For more information, see How CloudFormation +// performs drift detection on a stack set (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) +// . DetectStackSetDrift returns the OperationId of the stack set drift detection // operation. Use this operation id with DescribeStackSetOperation to monitor the // progress of the drift detection operation. The drift detection operation may // take some time, depending on the number of stack instances included in the stack // set, in addition to the number of resources included in each stack. Once the -// operation has completed, use the following actions to return drift -// information: +// operation has completed, use the following actions to return drift information: +// - Use DescribeStackSet to return detailed information about the stack set, +// including detailed information about the last completed drift operation +// performed on the stack set. (Information about drift operations that are in +// progress isn't included.) +// - Use ListStackInstances to return a list of stack instances belonging to the +// stack set, including the drift status and last drift time checked of each +// instance. +// - Use DescribeStackInstance to return detailed information about a specific +// stack instance, including its drift status and last drift time checked. // -// * Use DescribeStackSet to return detailed information about the -// stack set, including detailed information about the last completed drift -// operation performed on the stack set. (Information about drift operations that -// are in progress isn't included.) -// -// * Use ListStackInstances to return a list of -// stack instances belonging to the stack set, including the drift status and last -// drift time checked of each instance. -// -// * Use DescribeStackInstance to return -// detailed information about a specific stack instance, including its drift status -// and last drift time checked. -// -// For more information about performing a drift -// detection operation on a stack set, see Detecting unmanaged changes in stack -// sets -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html). -// You can only run a single drift detection operation on a given stack set at one -// time. To stop a drift detection stack set operation, use StopStackSetOperation. +// For more information about performing a drift detection operation on a stack +// set, see Detecting unmanaged changes in stack sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) +// . You can only run a single drift detection operation on a given stack set at +// one time. To stop a drift detection stack set operation, use +// StopStackSetOperation . func (c *Client) DetectStackSetDrift(ctx context.Context, params *DetectStackSetDriftInput, optFns ...func(*Options)) (*DetectStackSetDriftOutput, error) { if params == nil { params = &DetectStackSetDriftInput{} @@ -70,16 +63,12 @@ type DetectStackSetDriftInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The ID of the stack set operation. @@ -87,8 +76,8 @@ type DetectStackSetDriftInput struct { // The user-specified preferences for how CloudFormation performs a stack set // operation. For more information about maximum concurrent accounts and failure - // tolerance, see Stack set operation options - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). + // tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) + // . OperationPreferences *types.StackSetOperationPreferences noSmithyDocumentSerde @@ -96,9 +85,9 @@ type DetectStackSetDriftInput struct { type DetectStackSetDriftOutput struct { - // The ID of the drift detection stack set operation. You can use this operation ID - // with DescribeStackSetOperation to monitor the progress of the drift detection - // operation. + // The ID of the drift detection stack set operation. You can use this operation + // ID with DescribeStackSetOperation to monitor the progress of the drift + // detection operation. OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_EstimateTemplateCost.go b/service/cloudformation/api_op_EstimateTemplateCost.go index 3dddee93c11..e02247ad8bc 100644 --- a/service/cloudformation/api_op_EstimateTemplateCost.go +++ b/service/cloudformation/api_op_EstimateTemplateCost.go @@ -36,18 +36,16 @@ type EstimateTemplateCostInput struct { Parameters []types.Parameter // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. (For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // maximum length of 51,200 bytes. (For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide.) Conditional: You must pass TemplateBody or - // TemplateURL. If both are passed, only TemplateBody is used. + // TemplateURL . If both are passed, only TemplateBody is used. TemplateBody *string // Location of file containing the template body. The URL must point to a template // that's located in an Amazon S3 bucket or a Systems Manager document. For more - // information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must pass TemplateURL or - // TemplateBody. If both are passed, only TemplateBody is used. + // TemplateBody . If both are passed, only TemplateBody is used. TemplateURL *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ExecuteChangeSet.go b/service/cloudformation/api_op_ExecuteChangeSet.go index 08f65bf9bcf..e06c46af429 100644 --- a/service/cloudformation/api_op_ExecuteChangeSet.go +++ b/service/cloudformation/api_op_ExecuteChangeSet.go @@ -10,15 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a stack using the input information that was provided when the specified -// change set was created. After the call successfully completes, CloudFormation -// starts updating the stack. Use the DescribeStacks action to view the status of -// the update. When you execute a change set, CloudFormation deletes all other -// change sets associated with the stack because they aren't valid for the updated -// stack. If a stack policy is associated with the stack, CloudFormation enforces -// the policy during the update. You can't specify a temporary stack policy that -// overrides the current policy. To create a change set for the entire stack -// hierarchy, IncludeNestedStacks must have been set to True. +// Updates a stack using the input information that was provided when the +// specified change set was created. After the call successfully completes, +// CloudFormation starts updating the stack. Use the DescribeStacks action to view +// the status of the update. When you execute a change set, CloudFormation deletes +// all other change sets associated with the stack because they aren't valid for +// the updated stack. If a stack policy is associated with the stack, +// CloudFormation enforces the policy during the update. You can't specify a +// temporary stack policy that overrides the current policy. To create a change set +// for the entire stack hierarchy, IncludeNestedStacks must have been set to True . func (c *Client) ExecuteChangeSet(ctx context.Context, params *ExecuteChangeSetInput, optFns ...func(*Options)) (*ExecuteChangeSetOutput, error) { if params == nil { params = &ExecuteChangeSetInput{} @@ -43,15 +43,15 @@ type ExecuteChangeSetInput struct { // This member is required. ChangeSetName *string - // A unique identifier for this ExecuteChangeSet request. Specify this token if you - // plan to retry requests so that CloudFormation knows that you're not attempting - // to execute a change set to update a stack with the same name. You might retry - // ExecuteChangeSet requests to ensure that CloudFormation successfully received - // them. + // A unique identifier for this ExecuteChangeSet request. Specify this token if + // you plan to retry requests so that CloudFormation knows that you're not + // attempting to execute a change set to update a stack with the same name. You + // might retry ExecuteChangeSet requests to ensure that CloudFormation + // successfully received them. ClientRequestToken *string - // Preserves the state of previously provisioned resources when an operation fails. - // Default: True + // Preserves the state of previously provisioned resources when an operation + // fails. Default: True DisableRollback *bool // If you specified the name of a change set, specify the stack name or Amazon diff --git a/service/cloudformation/api_op_GetStackPolicy.go b/service/cloudformation/api_op_GetStackPolicy.go index aa2031f3540..943a40bda4c 100644 --- a/service/cloudformation/api_op_GetStackPolicy.go +++ b/service/cloudformation/api_op_GetStackPolicy.go @@ -43,8 +43,7 @@ type GetStackPolicyInput struct { type GetStackPolicyOutput struct { // Structure containing the stack policy body. (For more information, go to - // Prevent Updates to Stack Resources - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) + // Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the CloudFormation User Guide.) StackPolicyBody *string diff --git a/service/cloudformation/api_op_GetTemplate.go b/service/cloudformation/api_op_GetTemplate.go index 0a84d284c90..8771f057f1e 100644 --- a/service/cloudformation/api_op_GetTemplate.go +++ b/service/cloudformation/api_op_GetTemplate.go @@ -35,26 +35,22 @@ type GetTemplateInput struct { // The name or Amazon Resource Name (ARN) of a change set for which CloudFormation // returns the associated template. If you specify a name, you must also specify - // the StackName. + // the StackName . ChangeSetName *string // The name or the unique stack ID that's associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. // Default: There is no default value. StackName *string // For templates that include transforms, the stage of the template that - // CloudFormation returns. To get the user-submitted template, specify Original. To - // get the template after CloudFormation has processed all transforms, specify - // Processed. If the template doesn't include transforms, Original and Processed - // return the same template. By default, CloudFormation specifies Processed. + // CloudFormation returns. To get the user-submitted template, specify Original . + // To get the template after CloudFormation has processed all transforms, specify + // Processed . If the template doesn't include transforms, Original and Processed + // return the same template. By default, CloudFormation specifies Processed . TemplateStage types.TemplateStage noSmithyDocumentSerde @@ -64,14 +60,13 @@ type GetTemplateInput struct { type GetTemplateOutput struct { // The stage of the template that you can retrieve. For stacks, the Original and - // Processed templates are always available. For change sets, the Original template - // is always available. After CloudFormation finishes creating the change set, the - // Processed template becomes available. + // Processed templates are always available. For change sets, the Original + // template is always available. After CloudFormation finishes creating the change + // set, the Processed template becomes available. StagesAvailable []types.TemplateStage // Structure containing the template body. (For more information, go to Template - // Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide.) CloudFormation returns the same template that // was used when the stack was created. TemplateBody *string diff --git a/service/cloudformation/api_op_GetTemplateSummary.go b/service/cloudformation/api_op_GetTemplateSummary.go index 13187e6e0fe..40e1959fc65 100644 --- a/service/cloudformation/api_op_GetTemplateSummary.go +++ b/service/cloudformation/api_op_GetTemplateSummary.go @@ -14,10 +14,10 @@ import ( // Returns information about a new or existing template. The GetTemplateSummary // action is useful for viewing parameter information, such as default parameter // values and parameter types, before you create or update a stack or stack set. -// You can use the GetTemplateSummary action when you submit a template, or you can -// get template information for a stack set, or a running or deleted stack. For -// deleted stacks, GetTemplateSummary returns the template information for up to 90 -// days after the stack has been deleted. If the template doesn't exist, a +// You can use the GetTemplateSummary action when you submit a template, or you +// can get template information for a stack set, or a running or deleted stack. For +// deleted stacks, GetTemplateSummary returns the template information for up to +// 90 days after the stack has been deleted. If the template doesn't exist, a // ValidationError is returned. func (c *Client) GetTemplateSummary(ctx context.Context, params *GetTemplateSummaryInput, optFns ...func(*Options)) (*GetTemplateSummaryOutput, error) { if params == nil { @@ -41,44 +41,38 @@ type GetTemplateSummaryInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The name or the stack ID that's associated with the stack, which aren't always // interchangeable. For running stacks, you can specify either the stack's name or // its unique stack ID. For deleted stack, you must specify the unique stack ID. - // Conditional: You must specify only one of the following parameters: StackName, - // StackSetName, TemplateBody, or TemplateURL. + // Conditional: You must specify only one of the following parameters: StackName , + // StackSetName , TemplateBody , or TemplateURL . StackName *string // The name or unique ID of the stack set from which the stack was created. - // Conditional: You must specify only one of the following parameters: StackName, - // StackSetName, TemplateBody, or TemplateURL. + // Conditional: You must specify only one of the following parameters: StackName , + // StackSetName , TemplateBody , or TemplateURL . StackSetName *string // Structure containing the template body with a minimum length of 1 byte and a // maximum length of 51,200 bytes. For more information about templates, see - // Template anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + // following parameters: StackName , StackSetName , TemplateBody , or TemplateURL . TemplateBody *string // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems - // Manager document. For more information about templates, see Template anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // Manager document. For more information about templates, see Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: StackName, StackSetName, TemplateBody, or TemplateURL. + // following parameters: StackName , StackSetName , TemplateBody , or TemplateURL . TemplateURL *string noSmithyDocumentSerde @@ -88,11 +82,12 @@ type GetTemplateSummaryInput struct { type GetTemplateSummaryOutput struct { // The capabilities found within the template. If your template contains IAM - // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for - // this parameter when you use the CreateStack or UpdateStack actions with your - // template; otherwise, those actions return an InsufficientCapabilities error. For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value + // for this parameter when you use the CreateStack or UpdateStack actions with + // your template; otherwise, those actions return an InsufficientCapabilities + // error. For more information, see Acknowledging IAM Resources in CloudFormation + // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . Capabilities []types.Capability // The list of resources that generated the values in the Capabilities response @@ -112,14 +107,14 @@ type GetTemplateSummaryOutput struct { // parameter. Parameters []types.ParameterDeclaration - // A list of resource identifier summaries that describe the target resources of an - // import operation and the properties you can provide during the import to + // A list of resource identifier summaries that describe the target resources of + // an import operation and the properties you can provide during the import to // identify the target resources. For example, BucketName is a possible identifier // property for an AWS::S3::Bucket resource. ResourceIdentifierSummaries []types.ResourceIdentifierSummary - // A list of all the template resource types that are defined in the template, such - // as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. + // A list of all the template resource types that are defined in the template, + // such as AWS::EC2::Instance , AWS::Dynamo::Table , and Custom::MyCustomInstance . ResourceTypes []string // The Amazon Web Services template format version, which identifies the diff --git a/service/cloudformation/api_op_ImportStacksToStackSet.go b/service/cloudformation/api_op_ImportStacksToStackSet.go index 116318e5c26..822be90cc0b 100644 --- a/service/cloudformation/api_op_ImportStacksToStackSet.go +++ b/service/cloudformation/api_op_ImportStacksToStackSet.go @@ -42,11 +42,8 @@ type ImportStacksToStackSetInput struct { // By default, SELF is specified. Use SELF for stack sets with self-managed // permissions. - // - // * If you are signed in to the management account, specify SELF. - // - // * - // For service managed stack sets, specify DELEGATED_ADMIN. + // - If you are signed in to the management account, specify SELF . + // - For service managed stack sets, specify DELEGATED_ADMIN . CallAs types.CallAs // A unique, user defined, identifier for the stack set operation. @@ -54,8 +51,8 @@ type ImportStacksToStackSetInput struct { // The user-specified preferences for how CloudFormation performs a stack set // operation. For more information about maximum concurrent accounts and failure - // tolerance, see Stack set operation options - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). + // tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) + // . OperationPreferences *types.StackSetOperationPreferences // The list of OU ID's to which the stacks being imported has to be mapped as @@ -63,11 +60,11 @@ type ImportStacksToStackSetInput struct { OrganizationalUnitIds []string // The IDs of the stacks you are importing into a stack set. You import up to 10 - // stacks per stack set at a time. Specify either StackIds or StackIdsUrl. + // stacks per stack set at a time. Specify either StackIds or StackIdsUrl . StackIds []string // The Amazon S3 URL which contains list of stack ids to be inputted. Specify - // either StackIds or StackIdsUrl. + // either StackIds or StackIdsUrl . StackIdsUrl *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ListChangeSets.go b/service/cloudformation/api_op_ListChangeSets.go index 2dbd454932c..c8aa9440fc4 100644 --- a/service/cloudformation/api_op_ListChangeSets.go +++ b/service/cloudformation/api_op_ListChangeSets.go @@ -50,7 +50,7 @@ type ListChangeSetsInput struct { type ListChangeSetsOutput struct { // If the output exceeds 1 MB, a string that identifies the next page of change - // sets. If there is no additional page, this value is null. + // sets. If there is no additional page, this value is null . NextToken *string // A list of ChangeSetSummary structures that provides the ID and status of each diff --git a/service/cloudformation/api_op_ListExports.go b/service/cloudformation/api_op_ListExports.go index c27f9ccac8f..8cdfb628173 100644 --- a/service/cloudformation/api_op_ListExports.go +++ b/service/cloudformation/api_op_ListExports.go @@ -14,10 +14,9 @@ import ( // Lists all exported output values in the account and Region in which you call // this action. Use this action to see the exported output values that you can -// import into other stacks. To import values, use the Fn::ImportValue -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) -// function. For more information, see CloudFormation export stack output values -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html). +// import into other stacks. To import values, use the Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) +// function. For more information, see CloudFormation export stack output values (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html) +// . func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optFns ...func(*Options)) (*ListExportsOutput, error) { if params == nil { params = &ListExportsInput{} diff --git a/service/cloudformation/api_op_ListImports.go b/service/cloudformation/api_op_ListImports.go index 0f20f9c1514..156f5c2f0a0 100644 --- a/service/cloudformation/api_op_ListImports.go +++ b/service/cloudformation/api_op_ListImports.go @@ -13,10 +13,9 @@ import ( // Lists all stacks that are importing an exported output value. To modify or // remove an exported output value, first use this action to see which stacks are -// using it. To see the exported output values in your account, see ListExports. +// using it. To see the exported output values in your account, see ListExports . // For more information about importing an exported output value, see the -// Fn::ImportValue -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) +// Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) // function. func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error) { if params == nil { diff --git a/service/cloudformation/api_op_ListStackInstances.go b/service/cloudformation/api_op_ListStackInstances.go index 3a97fdd0cde..f3d3c359af9 100644 --- a/service/cloudformation/api_op_ListStackInstances.go +++ b/service/cloudformation/api_op_ListStackInstances.go @@ -43,16 +43,12 @@ type ListStackInstancesInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The filter to apply to stack instances @@ -60,15 +56,15 @@ type ListStackInstancesInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous request didn't return all the remaining results, the response's // NextToken parameter value is set to a token. To retrieve the next set of // results, call ListStackInstances again and assign that token to the request // object's NextToken parameter. If there are no remaining results, the previous - // response object's NextToken parameter is set to null. + // response object's NextToken parameter is set to null . NextToken *string // The name of the Amazon Web Services account that you want to list stack @@ -86,7 +82,7 @@ type ListStackInstancesOutput struct { // If the request doesn't return all the remaining results, NextToken is set to a // token. To retrieve the next set of results, call ListStackInstances again and // assign that token to the request object's NextToken parameter. If the request - // returns all results, NextToken is set to null. + // returns all results, NextToken is set to null . NextToken *string // A list of StackInstanceSummary structures that contain information about the @@ -175,8 +171,8 @@ var _ ListStackInstancesAPIClient = (*Client)(nil) type ListStackInstancesPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListStackResources.go b/service/cloudformation/api_op_ListStackResources.go index c4ee7036c6b..7ed7466aad6 100644 --- a/service/cloudformation/api_op_ListStackResources.go +++ b/service/cloudformation/api_op_ListStackResources.go @@ -35,13 +35,9 @@ type ListStackResourcesInput struct { // The name or the unique stack ID that is associated with the stack, which aren't // always interchangeable: - // - // * Running stacks: You can specify either the stack's - // name or its unique stack ID. - // - // * Deleted stacks: You must specify the unique - // stack ID. - // + // - Running stacks: You can specify either the stack's name or its unique stack + // ID. + // - Deleted stacks: You must specify the unique stack ID. // Default: There is no default value. // // This member is required. diff --git a/service/cloudformation/api_op_ListStackSetOperationResults.go b/service/cloudformation/api_op_ListStackSetOperationResults.go index c316c190787..1cdf39d7d83 100644 --- a/service/cloudformation/api_op_ListStackSetOperationResults.go +++ b/service/cloudformation/api_op_ListStackSetOperationResults.go @@ -45,16 +45,12 @@ type ListStackSetOperationResultsInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The filter to apply to operation results. @@ -62,15 +58,15 @@ type ListStackSetOperationResultsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous request didn't return all the remaining results, the response // object's NextToken parameter value is set to a token. To retrieve the next set - // of results, call ListStackSetOperationResults again and assign that token to the - // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // of results, call ListStackSetOperationResults again and assign that token to + // the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null . NextToken *string noSmithyDocumentSerde @@ -81,7 +77,7 @@ type ListStackSetOperationResultsOutput struct { // If the request doesn't return all results, NextToken is set to a token. To // retrieve the next set of results, call ListOperationResults again and assign // that token to the request object's NextToken parameter. If there are no - // remaining results, NextToken is set to null. + // remaining results, NextToken is set to null . NextToken *string // A list of StackSetOperationResultSummary structures that contain information @@ -171,8 +167,8 @@ var _ ListStackSetOperationResultsAPIClient = (*Client)(nil) type ListStackSetOperationResultsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListStackSetOperations.go b/service/cloudformation/api_op_ListStackSetOperations.go index cde2d5c0092..cd701094dc2 100644 --- a/service/cloudformation/api_op_ListStackSetOperations.go +++ b/service/cloudformation/api_op_ListStackSetOperations.go @@ -40,29 +40,25 @@ type ListStackSetOperationsInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve - // the next set of results, call ListStackSetOperations again and assign that token - // to the request object's NextToken parameter. If there are no remaining results, - // the previous response object's NextToken parameter is set to null. + // the next set of results, call ListStackSetOperations again and assign that + // token to the request object's NextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null . NextToken *string noSmithyDocumentSerde @@ -73,7 +69,7 @@ type ListStackSetOperationsOutput struct { // If the request doesn't return all results, NextToken is set to a token. To // retrieve the next set of results, call ListOperationResults again and assign // that token to the request object's NextToken parameter. If there are no - // remaining results, NextToken is set to null. + // remaining results, NextToken is set to null . NextToken *string // A list of StackSetOperationSummary structures that contain summary information @@ -162,8 +158,8 @@ var _ ListStackSetOperationsAPIClient = (*Client)(nil) type ListStackSetOperationsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListStackSets.go b/service/cloudformation/api_op_ListStackSets.go index 16175001964..bbbef763d62 100644 --- a/service/cloudformation/api_op_ListStackSets.go +++ b/service/cloudformation/api_op_ListStackSets.go @@ -12,22 +12,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns summary information about stack sets that are associated with the -// user. -// -// * [Self-managed permissions] If you set the CallAs parameter to SELF -// while signed in to your Amazon Web Services account, ListStackSets returns all -// self-managed stack sets in your Amazon Web Services account. -// -// * [Service-managed -// permissions] If you set the CallAs parameter to SELF while signed in to the -// organization's management account, ListStackSets returns all stack sets in the -// management account. -// -// * [Service-managed permissions] If you set the CallAs -// parameter to DELEGATED_ADMIN while signed in to your member account, -// ListStackSets returns all stack sets with service-managed permissions in the -// management account. +// Returns summary information about stack sets that are associated with the user. +// - [Self-managed permissions] If you set the CallAs parameter to SELF while +// signed in to your Amazon Web Services account, ListStackSets returns all +// self-managed stack sets in your Amazon Web Services account. +// - [Service-managed permissions] If you set the CallAs parameter to SELF while +// signed in to the organization's management account, ListStackSets returns all +// stack sets in the management account. +// - [Service-managed permissions] If you set the CallAs parameter to +// DELEGATED_ADMIN while signed in to your member account, ListStackSets returns +// all stack sets with service-managed permissions in the management account. func (c *Client) ListStackSets(ctx context.Context, params *ListStackSetsInput, optFns ...func(*Options)) (*ListStackSetsOutput, error) { if params == nil { params = &ListStackSetsInput{} @@ -49,29 +43,25 @@ type ListStackSetsInput struct { // administrator in the management account or as a delegated administrator in a // member account. By default, SELF is specified. Use SELF for stack sets with // self-managed permissions. - // - // * If you are signed in to the management account, - // specify SELF. - // - // * If you are signed in to a delegated administrator account, - // specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as - // a delegated administrator in the management account. For more information, see - // Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous paginated request didn't return all the remaining results, the // response object's NextToken parameter value is set to a token. To retrieve the // next set of results, call ListStackSets again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // previous response object's NextToken parameter is set to null . NextToken *string // The status of the stack sets that you want to get summary information about. @@ -85,7 +75,7 @@ type ListStackSetsOutput struct { // If the request doesn't return all of the remaining results, NextToken is set to // a token. To retrieve the next set of results, call ListStackInstances again and // assign that token to the request object's NextToken parameter. If the request - // returns all results, NextToken is set to null. + // returns all results, NextToken is set to null . NextToken *string // A list of StackSetSummary structures that contain information about the user's @@ -169,8 +159,8 @@ var _ ListStackSetsAPIClient = (*Client)(nil) type ListStackSetsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListTypeRegistrations.go b/service/cloudformation/api_op_ListTypeRegistrations.go index b36916d8cf3..5450d061cce 100644 --- a/service/cloudformation/api_op_ListTypeRegistrations.go +++ b/service/cloudformation/api_op_ListTypeRegistrations.go @@ -32,31 +32,31 @@ type ListTypeRegistrationsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous paginated request didn't return all the remaining results, the // response object's NextToken parameter value is set to a token. To retrieve the // next set of results, call this action again and assign that token to the request // object's NextToken parameter. If there are no remaining results, the previous - // response object's NextToken parameter is set to null. + // response object's NextToken parameter is set to null . NextToken *string // The current status of the extension registration request. The default is - // IN_PROGRESS. + // IN_PROGRESS . RegistrationStatusFilter types.RegistrationStatus - // The kind of extension. Conditional: You must specify either TypeName and Type, - // or Arn. + // The kind of extension. Conditional: You must specify either TypeName and Type , + // or Arn . Type types.RegistryType // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify - // either TypeName and Type, or Arn. + // either TypeName and Type , or Arn . TypeArn *string // The name of the extension. Conditional: You must specify either TypeName and - // Type, or Arn. + // Type , or Arn . TypeName *string noSmithyDocumentSerde @@ -67,7 +67,7 @@ type ListTypeRegistrationsOutput struct { // If the request doesn't return all the remaining results, NextToken is set to a // token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns - // all results, NextToken is set to null. + // all results, NextToken is set to null . NextToken *string // A list of extension registration tokens. Use DescribeTypeRegistration to return @@ -153,8 +153,8 @@ var _ ListTypeRegistrationsAPIClient = (*Client)(nil) type ListTypeRegistrationsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListTypeVersions.go b/service/cloudformation/api_op_ListTypeVersions.go index cabc7560a6c..4785f72ba07 100644 --- a/service/cloudformation/api_op_ListTypeVersions.go +++ b/service/cloudformation/api_op_ListTypeVersions.go @@ -31,35 +31,30 @@ func (c *Client) ListTypeVersions(ctx context.Context, params *ListTypeVersionsI type ListTypeVersionsInput struct { // The Amazon Resource Name (ARN) of the extension for which you want version - // summary information. Conditional: You must specify either TypeName and Type, or - // Arn. + // summary information. Conditional: You must specify either TypeName and Type , or + // Arn . Arn *string // The deprecation status of the extension versions that you want to get summary // information about. Valid values include: - // - // * LIVE: The extension version is - // registered and can be used in CloudFormation operations, dependent on its - // provisioning behavior and visibility scope. - // - // * DEPRECATED: The extension version - // has been deregistered and can no longer be used in CloudFormation - // operations. - // - // The default is LIVE. + // - LIVE : The extension version is registered and can be used in CloudFormation + // operations, dependent on its provisioning behavior and visibility scope. + // - DEPRECATED : The extension version has been deregistered and can no longer + // be used in CloudFormation operations. + // The default is LIVE . DeprecatedStatus types.DeprecatedStatus // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // previous response object's NextToken parameter is set to null . NextToken *string // The publisher ID of the extension publisher. Extensions published by Amazon @@ -67,11 +62,11 @@ type ListTypeVersionsInput struct { PublisherId *string // The kind of the extension. Conditional: You must specify either TypeName and - // Type, or Arn. + // Type , or Arn . Type types.RegistryType // The name of the extension for which you want version summary information. - // Conditional: You must specify either TypeName and Type, or Arn. + // Conditional: You must specify either TypeName and Type , or Arn . TypeName *string noSmithyDocumentSerde @@ -82,7 +77,7 @@ type ListTypeVersionsOutput struct { // If the request doesn't return all of the remaining results, NextToken is set to // a token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns - // all results, NextToken is set to null. + // all results, NextToken is set to null . NextToken *string // A list of TypeVersionSummary structures that contain information about the @@ -167,8 +162,8 @@ var _ ListTypeVersionsAPIClient = (*Client)(nil) type ListTypeVersionsPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_ListTypes.go b/service/cloudformation/api_op_ListTypes.go index 6ba187e306a..1a64585df1b 100644 --- a/service/cloudformation/api_op_ListTypes.go +++ b/service/cloudformation/api_op_ListTypes.go @@ -31,14 +31,11 @@ func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns . type ListTypesInput struct { - // The deprecation status of the extension that you want to get summary information - // about. Valid values include: - // - // * LIVE: The extension is registered for use in - // CloudFormation operations. - // - // * DEPRECATED: The extension has been deregistered - // and can no longer be used in CloudFormation operations. + // The deprecation status of the extension that you want to get summary + // information about. Valid values include: + // - LIVE : The extension is registered for use in CloudFormation operations. + // - DEPRECATED : The extension has been deregistered and can no longer be used + // in CloudFormation operations. DeprecatedStatus types.DeprecatedStatus // Filter criteria to use in determining which extensions to return. Filters must @@ -49,35 +46,28 @@ type ListTypesInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. MaxResults *int32 // If the previous paginated request didn't return all the remaining results, the // response object's NextToken parameter value is set to a token. To retrieve the // next set of results, call this action again and assign that token to the request // object's NextToken parameter. If there are no remaining results, the previous - // response object's NextToken parameter is set to null. + // response object's NextToken parameter is set to null . NextToken *string // For resource types, the provisioning behavior of the resource type. // CloudFormation determines the provisioning type during registration, based on // the types of handlers in the schema handler package submitted. Valid values // include: - // - // * FULLY_MUTABLE: The resource type includes an update handler to - // process updates to the type during stack update operations. - // - // * IMMUTABLE: The - // resource type doesn't include an update handler, so the type can't be updated - // and must instead be replaced during stack update operations. - // - // * - // NON_PROVISIONABLE: The resource type doesn't include create, read, and delete - // handlers, and therefore can't actually be provisioned. - // - // The default is - // FULLY_MUTABLE. + // - FULLY_MUTABLE : The resource type includes an update handler to process + // updates to the type during stack update operations. + // - IMMUTABLE : The resource type doesn't include an update handler, so the type + // can't be updated and must instead be replaced during stack update operations. + // - NON_PROVISIONABLE : The resource type doesn't include create, read, and + // delete handlers, and therefore can't actually be provisioned. + // The default is FULLY_MUTABLE . ProvisioningType types.ProvisioningType // The type of extension. @@ -85,22 +75,14 @@ type ListTypesInput struct { // The scope at which the extensions are visible and usable in CloudFormation // operations. Valid values include: - // - // * PRIVATE: Extensions that are visible and - // usable within this account and region. This includes: - // - // * Private extensions you - // have registered in this account and region. - // - // * Public extensions that you have - // activated in this account and region. - // - // * PUBLIC: Extensions that are publicly - // visible and available to be activated within any Amazon Web Services account. - // This includes extensions from Amazon Web Services, in addition to third-party - // publishers. - // - // The default is PRIVATE. + // - PRIVATE : Extensions that are visible and usable within this account and + // region. This includes: + // - Private extensions you have registered in this account and region. + // - Public extensions that you have activated in this account and region. + // - PUBLIC : Extensions that are publicly visible and available to be activated + // within any Amazon Web Services account. This includes extensions from Amazon Web + // Services, in addition to third-party publishers. + // The default is PRIVATE . Visibility types.Visibility noSmithyDocumentSerde @@ -111,7 +93,7 @@ type ListTypesOutput struct { // If the request doesn't return all the remaining results, NextToken is set to a // token. To retrieve the next set of results, call this action again and assign // that token to the request object's NextToken parameter. If the request returns - // all results, NextToken is set to null. + // all results, NextToken is set to null . NextToken *string // A list of TypeSummary structures that contain information about the specified @@ -195,8 +177,8 @@ var _ ListTypesAPIClient = (*Client)(nil) type ListTypesPaginatorOptions struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken - // value that you can assign to the NextToken request parameter to get the next set - // of results. + // value that you can assign to the NextToken request parameter to get the next + // set of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudformation/api_op_PublishType.go b/service/cloudformation/api_op_PublishType.go index 8a1abbfc7c0..f848bc2dbd7 100644 --- a/service/cloudformation/api_op_PublishType.go +++ b/service/cloudformation/api_op_PublishType.go @@ -14,12 +14,11 @@ import ( // Publishes the specified extension to the CloudFormation registry as a public // extension in this region. Public extensions are available for use by all // CloudFormation users. For more information about publishing extensions, see -// Publishing extensions to make them available for public use -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) +// Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) // in the CloudFormation CLI User Guide. To publish an extension, you must be // registered as a publisher with CloudFormation. For more information, see -// RegisterPublisher -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html). +// RegisterPublisher (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html) +// . func (c *Client) PublishType(ctx context.Context, params *PublishTypeInput, optFns ...func(*Options)) (*PublishTypeOutput, error) { if params == nil { params = &PublishTypeInput{} @@ -38,24 +37,24 @@ func (c *Client) PublishType(ctx context.Context, params *PublishTypeInput, optF type PublishTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify - // Arn, or TypeName and Type. + // Arn , or TypeName and Type . Arn *string - // The version number to assign to this version of the extension. Use the following - // format, and adhere to semantic versioning when assigning a version number to - // your extension: MAJOR.MINOR.PATCH For more information, see Semantic Versioning - // 2.0.0 (https://semver.org/). If you don't specify a version number, + // The version number to assign to this version of the extension. Use the + // following format, and adhere to semantic versioning when assigning a version + // number to your extension: MAJOR.MINOR.PATCH For more information, see Semantic + // Versioning 2.0.0 (https://semver.org/) . If you don't specify a version number, // CloudFormation increments the version number by one minor version release. You // cannot specify a version number the first time you publish a type. - // CloudFormation automatically sets the first version number to be 1.0.0. + // CloudFormation automatically sets the first version number to be 1.0.0 . PublicVersionNumber *string - // The type of the extension. Conditional: You must specify Arn, or TypeName and - // Type. + // The type of the extension. Conditional: You must specify Arn , or TypeName and + // Type . Type types.ThirdPartyType - // The name of the extension. Conditional: You must specify Arn, or TypeName and - // Type. + // The name of the extension. Conditional: You must specify Arn , or TypeName and + // Type . TypeName *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_RecordHandlerProgress.go b/service/cloudformation/api_op_RecordHandlerProgress.go index d94c3b65076..4aaa6b8fa31 100644 --- a/service/cloudformation/api_op_RecordHandlerProgress.go +++ b/service/cloudformation/api_op_RecordHandlerProgress.go @@ -12,9 +12,8 @@ import ( ) // Reports progress of a resource handler to CloudFormation. Reserved for use by -// the CloudFormation CLI -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). -// Don't use this API in your code. +// the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) +// . Don't use this API in your code. func (c *Client) RecordHandlerProgress(ctx context.Context, params *RecordHandlerProgressInput, optFns ...func(*Options)) (*RecordHandlerProgressOutput, error) { if params == nil { params = &RecordHandlerProgressInput{} @@ -32,36 +31,36 @@ func (c *Client) RecordHandlerProgress(ctx context.Context, params *RecordHandle type RecordHandlerProgressInput struct { - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . // // This member is required. BearerToken *string - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . // // This member is required. OperationStatus types.OperationStatus - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . ClientRequestToken *string - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . CurrentOperationStatus types.OperationStatus - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . ErrorCode types.HandlerErrorCode - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . ResourceModel *string - // Reserved for use by the CloudFormation CLI - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). + // Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) + // . StatusMessage *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_RegisterPublisher.go b/service/cloudformation/api_op_RegisterPublisher.go index b3ffc0f2b25..50a68e31cb8 100644 --- a/service/cloudformation/api_op_RegisterPublisher.go +++ b/service/cloudformation/api_op_RegisterPublisher.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers your account as a publisher of public extensions in the CloudFormation -// registry. Public extensions are available for use by all CloudFormation users. -// This publisher ID applies to your account in all Amazon Web Services Regions. -// For information about requirements for registering as a public extension -// publisher, see Registering your account to publish CloudFormation extensions -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) +// Registers your account as a publisher of public extensions in the +// CloudFormation registry. Public extensions are available for use by all +// CloudFormation users. This publisher ID applies to your account in all Amazon +// Web Services Regions. For information about requirements for registering as a +// public extension publisher, see Registering your account to publish +// CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) // in the CloudFormation CLI User Guide. func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublisherInput, optFns ...func(*Options)) (*RegisterPublisherOutput, error) { if params == nil { @@ -34,17 +34,15 @@ func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublishe type RegisterPublisherInput struct { - // Whether you accept the Terms and Conditions - // (https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) + // Whether you accept the Terms and Conditions (https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) // for publishing extensions in the CloudFormation registry. You must accept the // terms and conditions in order to register to publish public extensions to the - // CloudFormation registry. The default is false. + // CloudFormation registry. The default is false . AcceptTermsAndConditions *bool // If you are using a Bitbucket or GitHub account for identity verification, the // Amazon Resource Name (ARN) for your connection to that account. For more - // information, see Registering your account to publish CloudFormation extensions - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) + // information, see Registering your account to publish CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) // in the CloudFormation CLI User Guide. ConnectionArn *string diff --git a/service/cloudformation/api_op_RegisterType.go b/service/cloudformation/api_op_RegisterType.go index b6981a5cfbc..a600546e8a5 100644 --- a/service/cloudformation/api_op_RegisterType.go +++ b/service/cloudformation/api_op_RegisterType.go @@ -11,31 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers an extension with the CloudFormation service. Registering an extension -// makes it available for use in CloudFormation templates in your Amazon Web -// Services account, and includes: +// Registers an extension with the CloudFormation service. Registering an +// extension makes it available for use in CloudFormation templates in your Amazon +// Web Services account, and includes: +// - Validating the extension schema. +// - Determining which handlers, if any, have been specified for the extension. +// - Making the extension available for use in your account. // -// * Validating the extension schema. -// -// * -// Determining which handlers, if any, have been specified for the extension. -// -// * -// Making the extension available for use in your account. -// -// For more information -// about how to develop extensions and ready them for registration, see Creating -// Resource Providers -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) +// For more information about how to develop extensions and ready them for +// registration, see Creating Resource Providers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) // in the CloudFormation CLI User Guide. You can have a maximum of 50 resource // extension versions registered at a time. This maximum is per account and per // region. Use DeregisterType to deregister specific extension versions if -// necessary. Once you have initiated a registration request using RegisterType, -// you can use DescribeTypeRegistration to monitor the progress of the registration -// request. Once you have registered a private extension in your account and -// region, use SetTypeConfiguration to specify configuration properties for the -// extension. For more information, see Configuring extensions at the account level -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) +// necessary. Once you have initiated a registration request using RegisterType , +// you can use DescribeTypeRegistration to monitor the progress of the +// registration request. Once you have registered a private extension in your +// account and region, use SetTypeConfiguration to specify configuration +// properties for the extension. For more information, see Configuring extensions +// at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, optFns ...func(*Options)) (*RegisterTypeOutput, error) { if params == nil { @@ -57,46 +50,30 @@ type RegisterTypeInput struct { // A URL to the S3 bucket containing the extension project package that contains // the necessary files for the extension you want to register. For information // about generating a schema handler package for the extension you want to - // register, see submit - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) + // register, see submit (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) // in the CloudFormation CLI User Guide. The user registering the extension must be // able to access the package in the S3 bucket. That's, the user needs to have // GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // permissions for the schema handler package. For more information, see Actions, - // Resources, and Condition Keys for Amazon S3 - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the - // Identity and Access Management User Guide. + // Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) + // in the Identity and Access Management User Guide. // // This member is required. SchemaHandlerPackage *string // The name of the extension being registered. We suggest that extension names // adhere to the following patterns: - // - // * For resource types, - // company_or_organization::service::type. - // - // * For modules, - // company_or_organization::service::type::MODULE. - // - // * For hooks, - // MyCompany::Testing::MyTestHook. - // - // The following organization namespaces are - // reserved and can't be used in your extension names: - // - // * Alexa - // - // * AMZN - // - // * - // Amazon - // - // * AWS - // - // * Custom - // - // * Dev + // - For resource types, company_or_organization::service::type. + // - For modules, company_or_organization::service::type::MODULE. + // - For hooks, MyCompany::Testing::MyTestHook. + // The following organization namespaces are reserved and can't be used in your + // extension names: + // - Alexa + // - AMZN + // - Amazon + // - AWS + // - Custom + // - Dev // // This member is required. TypeName *string @@ -107,19 +84,19 @@ type RegisterTypeInput struct { // request, even if the request is submitted multiple times. ClientRequestToken *string - // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when - // invoking the extension. For CloudFormation to assume the specified execution - // role, the role must contain a trust relationship with the CloudFormation service - // principle (resources.cloudformation.amazonaws.com). For more information about - // adding trust relationships, see Modifying a role trust policy in the Identity - // and Access Management User Guide. If your extension calls Amazon Web Services - // APIs in any of its handlers, you must create an IAM execution role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes - // the necessary permissions to call those Amazon Web Services APIs, and provision - // that execution role in your account. When CloudFormation needs to invoke the - // resource type handler, CloudFormation assumes this execution role to create a - // temporary session token, which it then passes to the resource type handler, - // thereby supplying your resource type with the appropriate credentials. + // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume + // when invoking the extension. For CloudFormation to assume the specified + // execution role, the role must contain a trust relationship with the + // CloudFormation service principle ( resources.cloudformation.amazonaws.com ). For + // more information about adding trust relationships, see Modifying a role trust + // policy in the Identity and Access Management User Guide. If your extension calls + // Amazon Web Services APIs in any of its handlers, you must create an IAM + // execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) + // that includes the necessary permissions to call those Amazon Web Services APIs, + // and provision that execution role in your account. When CloudFormation needs to + // invoke the resource type handler, CloudFormation assumes this execution role to + // create a temporary session token, which it then passes to the resource type + // handler, thereby supplying your resource type with the appropriate credentials. ExecutionRoleArn *string // Specifies logging configuration information for an extension. @@ -134,8 +111,8 @@ type RegisterTypeInput struct { type RegisterTypeOutput struct { // The identifier for this registration request. Use this registration token when - // calling DescribeTypeRegistration, which returns information about the status and - // IDs of the extension registration. + // calling DescribeTypeRegistration , which returns information about the status + // and IDs of the extension registration. RegistrationToken *string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_RollbackStack.go b/service/cloudformation/api_op_RollbackStack.go index 861f397204f..8430e745de2 100644 --- a/service/cloudformation/api_op_RollbackStack.go +++ b/service/cloudformation/api_op_RollbackStack.go @@ -10,24 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// When specifying RollbackStack, you preserve the state of previously provisioned +// When specifying RollbackStack , you preserve the state of previously provisioned // resources when an operation fails. You can check the status of the stack through // the DescribeStacks operation. Rolls back the specified stack to the last known // stable state from CREATE_FAILED or UPDATE_FAILED stack statuses. This operation // will delete a stack if it doesn't contain a last known stable state. A last -// known stable state includes any status in a *_COMPLETE. This includes the +// known stable state includes any status in a *_COMPLETE . This includes the // following stack statuses. -// -// * CREATE_COMPLETE -// -// * UPDATE_COMPLETE -// -// * -// UPDATE_ROLLBACK_COMPLETE -// -// * IMPORT_COMPLETE -// -// * IMPORT_ROLLBACK_COMPLETE +// - CREATE_COMPLETE +// - UPDATE_COMPLETE +// - UPDATE_ROLLBACK_COMPLETE +// - IMPORT_COMPLETE +// - IMPORT_ROLLBACK_COMPLETE func (c *Client) RollbackStack(ctx context.Context, params *RollbackStackInput, optFns ...func(*Options)) (*RollbackStackOutput, error) { if params == nil { params = &RollbackStackInput{} diff --git a/service/cloudformation/api_op_SetStackPolicy.go b/service/cloudformation/api_op_SetStackPolicy.go index e8f5ccef016..7bc8d07a4d1 100644 --- a/service/cloudformation/api_op_SetStackPolicy.go +++ b/service/cloudformation/api_op_SetStackPolicy.go @@ -34,9 +34,8 @@ type SetStackPolicyInput struct { // This member is required. StackName *string - // Structure containing the stack policy body. For more information, go to Prevent - // updates to stack resources - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) + // Structure containing the stack policy body. For more information, go to + // Prevent updates to stack resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the CloudFormation User Guide. You can specify either the StackPolicyBody or // the StackPolicyURL parameter, but not both. StackPolicyBody *string diff --git a/service/cloudformation/api_op_SetTypeConfiguration.go b/service/cloudformation/api_op_SetTypeConfiguration.go index fb6ba5748e3..bf9f96142ba 100644 --- a/service/cloudformation/api_op_SetTypeConfiguration.go +++ b/service/cloudformation/api_op_SetTypeConfiguration.go @@ -13,9 +13,8 @@ import ( // Specifies the configuration data for a registered CloudFormation extension, in // the given account and region. To view the current configuration data for an -// extension, refer to the ConfigurationSchema element of DescribeType. For more -// information, see Configuring extensions at the account level -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) +// extension, refer to the ConfigurationSchema element of DescribeType . For more +// information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. It's strongly recommended that you use dynamic // references to restrict sensitive configuration definitions, such as third-party // credentials. For more details on dynamic references, see Using dynamic @@ -40,9 +39,8 @@ type SetTypeConfigurationInput struct { // The configuration data for the extension, in this account and region. The // configuration data must be formatted as JSON, and validate against the schema - // returned in the ConfigurationSchema response element of API_DescribeType. For - // more information, see Defining account-level configuration data for an extension - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration) + // returned in the ConfigurationSchema response element of API_DescribeType . For + // more information, see Defining account-level configuration data for an extension (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration) // in the CloudFormation CLI User Guide. // // This member is required. @@ -53,23 +51,21 @@ type SetTypeConfigurationInput struct { // resource type extension. ConfigurationAlias *string - // The type of extension. Conditional: You must specify ConfigurationArn, or Type - // and TypeName. + // The type of extension. Conditional: You must specify ConfigurationArn , or Type + // and TypeName . Type types.ThirdPartyType // The Amazon Resource Name (ARN) for the extension, in this account and region. - // For public extensions, this will be the ARN assigned when you activate the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // For public extensions, this will be the ARN assigned when you activate the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) // in this account and region. For private extensions, this will be the ARN - // assigned when you register the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) // in this account and region. Do not include the extension versions suffix at the // end of the ARN. You can set the configuration for an extension, but not for a // specific extension version. TypeArn *string - // The name of the extension. Conditional: You must specify ConfigurationArn, or - // Type and TypeName. + // The name of the extension. Conditional: You must specify ConfigurationArn , or + // Type and TypeName . TypeName *string noSmithyDocumentSerde @@ -78,7 +74,7 @@ type SetTypeConfigurationInput struct { type SetTypeConfigurationOutput struct { // The Amazon Resource Name (ARN) for the configuration data, in this account and - // region. Conditional: You must specify ConfigurationArn, or Type and TypeName. + // region. Conditional: You must specify ConfigurationArn , or Type and TypeName . ConfigurationArn *string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_SetTypeDefaultVersion.go b/service/cloudformation/api_op_SetTypeDefaultVersion.go index ea2d21d6fc7..fc8e8a8da23 100644 --- a/service/cloudformation/api_op_SetTypeDefaultVersion.go +++ b/service/cloudformation/api_op_SetTypeDefaultVersion.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Specify the default version of an extension. The default version of an extension -// will be used in CloudFormation operations. +// Specify the default version of an extension. The default version of an +// extension will be used in CloudFormation operations. func (c *Client) SetTypeDefaultVersion(ctx context.Context, params *SetTypeDefaultVersionInput, optFns ...func(*Options)) (*SetTypeDefaultVersionOutput, error) { if params == nil { params = &SetTypeDefaultVersionInput{} @@ -31,16 +31,16 @@ func (c *Client) SetTypeDefaultVersion(ctx context.Context, params *SetTypeDefau type SetTypeDefaultVersionInput struct { // The Amazon Resource Name (ARN) of the extension for which you want version - // summary information. Conditional: You must specify either TypeName and Type, or - // Arn. + // summary information. Conditional: You must specify either TypeName and Type , or + // Arn . Arn *string - // The kind of extension. Conditional: You must specify either TypeName and Type, - // or Arn. + // The kind of extension. Conditional: You must specify either TypeName and Type , + // or Arn . Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and - // Type, or Arn. + // Type , or Arn . TypeName *string // The ID of a specific version of the extension. The version ID is the value at diff --git a/service/cloudformation/api_op_SignalResource.go b/service/cloudformation/api_op_SignalResource.go index c724280bcbf..a08bfe7c93c 100644 --- a/service/cloudformation/api_op_SignalResource.go +++ b/service/cloudformation/api_op_SignalResource.go @@ -15,8 +15,8 @@ import ( // can use the SignalResource operation in conjunction with a creation policy or // update policy. CloudFormation doesn't proceed with a stack creation or update // until resources receive the required number of signals or the timeout period is -// exceeded. The SignalResource operation is useful in cases where you want to send -// signals from anywhere other than an Amazon EC2 instance. +// exceeded. The SignalResource operation is useful in cases where you want to +// send signals from anywhere other than an Amazon EC2 instance. func (c *Client) SignalResource(ctx context.Context, params *SignalResourceInput, optFns ...func(*Options)) (*SignalResourceOutput, error) { if params == nil { params = &SignalResourceInput{} diff --git a/service/cloudformation/api_op_StopStackSetOperation.go b/service/cloudformation/api_op_StopStackSetOperation.go index a4494de0642..bcce41dc103 100644 --- a/service/cloudformation/api_op_StopStackSetOperation.go +++ b/service/cloudformation/api_op_StopStackSetOperation.go @@ -45,16 +45,12 @@ type StopStackSetOperationInput struct { // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_TestType.go b/service/cloudformation/api_op_TestType.go index d4e96e2d2f8..5e416001598 100644 --- a/service/cloudformation/api_op_TestType.go +++ b/service/cloudformation/api_op_TestType.go @@ -13,29 +13,22 @@ import ( // Tests a registered extension to make sure it meets all necessary requirements // for being published in the CloudFormation registry. +// - For resource types, this includes passing all contracts tests defined for +// the type. +// - For modules, this includes determining if the module's model meets all +// necessary requirements. // -// * For resource types, this -// includes passing all contracts tests defined for the type. -// -// * For modules, this -// includes determining if the module's model meets all necessary -// requirements. -// -// For more information, see Testing your public extension prior to -// publishing -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) +// For more information, see Testing your public extension prior to publishing (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) // in the CloudFormation CLI User Guide. If you don't specify a version, // CloudFormation uses the default version of the extension in your account and // region for testing. To perform testing, CloudFormation assumes the execution // role specified when the type was registered. For more information, see -// RegisterType. Once you've initiated testing on an extension using TestType, you -// can pass the returned TypeVersionArn into DescribeType -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) +// RegisterType . Once you've initiated testing on an extension using TestType , +// you can pass the returned TypeVersionArn into DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) // to monitor the current test status and test status description for the // extension. An extension must have a test status of PASSED before it can be // published. For more information, see Publishing extensions to make them -// available for public use -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) +// available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) // in the CloudFormation CLI User Guide. func (c *Client) TestType(ctx context.Context, params *TestTypeInput, optFns ...func(*Options)) (*TestTypeOutput, error) { if params == nil { @@ -55,38 +48,32 @@ func (c *Client) TestType(ctx context.Context, params *TestTypeInput, optFns ... type TestTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify - // Arn, or TypeName and Type. + // Arn , or TypeName and Type . Arn *string - // The S3 bucket to which CloudFormation delivers the contract test execution logs. - // CloudFormation delivers the logs by the time contract testing has completed and - // the extension has been assigned a test type status of PASSED or FAILED. The user - // calling TestType must be able to access items in the specified S3 bucket. - // Specifically, the user needs the following permissions: - // - // * GetObject - // - // * - // PutObject - // - // For more information, see Actions, Resources, and Condition Keys for - // Amazon S3 - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) + // The S3 bucket to which CloudFormation delivers the contract test execution + // logs. CloudFormation delivers the logs by the time contract testing has + // completed and the extension has been assigned a test type status of PASSED or + // FAILED . The user calling TestType must be able to access items in the + // specified S3 bucket. Specifically, the user needs the following permissions: + // - GetObject + // - PutObject + // For more information, see Actions, Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) // in the Amazon Web Services Identity and Access Management User Guide. LogDeliveryBucket *string - // The type of the extension to test. Conditional: You must specify Arn, or - // TypeName and Type. + // The type of the extension to test. Conditional: You must specify Arn , or + // TypeName and Type . Type types.ThirdPartyType - // The name of the extension to test. Conditional: You must specify Arn, or - // TypeName and Type. + // The name of the extension to test. Conditional: You must specify Arn , or + // TypeName and Type . TypeName *string - // The version of the extension to test. You can specify the version id with either - // Arn, or with TypeName and Type. If you don't specify a version, CloudFormation - // uses the default version of the extension in this account and region for - // testing. + // The version of the extension to test. You can specify the version id with + // either Arn , or with TypeName and Type . If you don't specify a version, + // CloudFormation uses the default version of the extension in this account and + // region for testing. VersionId *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_UpdateStack.go b/service/cloudformation/api_op_UpdateStack.go index 4c69e609aac..80feec96d6c 100644 --- a/service/cloudformation/api_op_UpdateStack.go +++ b/service/cloudformation/api_op_UpdateStack.go @@ -13,11 +13,11 @@ import ( // Updates a stack as specified in the template. After the call completes // successfully, the stack update starts. You can check the status of the stack -// through the DescribeStacks action. To get a copy of the template for an existing -// stack, you can use the GetTemplate action. For more information about creating -// an update template, updating a stack, and monitoring the progress of the update, -// see Updating a Stack -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html). +// through the DescribeStacks action. To get a copy of the template for an +// existing stack, you can use the GetTemplate action. For more information about +// creating an update template, updating a stack, and monitoring the progress of +// the update, see Updating a Stack (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) +// . func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error) { if params == nil { params = &UpdateStackInput{} @@ -41,100 +41,66 @@ type UpdateStackInput struct { // This member is required. StackName *string - // In some cases, you must explicitly acknowledge that your stack template contains - // certain capabilities in order for CloudFormation to update the stack. - // - // * - // CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include - // resources that can affect permissions in your Amazon Web Services account; for - // example, by creating new Identity and Access Management (IAM) users. For those - // stacks, you must explicitly acknowledge this by specifying one of these - // capabilities. The following IAM resources require you to specify either the - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. - // - // * If you have IAM resources, - // you can specify either capability. - // - // * If you have IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM. - // - // * If you don't specify either of - // these capabilities, CloudFormation returns an InsufficientCapabilities - // error. - // - // If your stack template contains these resources, we suggest that you - // review all permissions associated with them and edit their permissions if - // necessary. - // - // * AWS::IAM::AccessKey - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) - // - // * - // AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) - // - // * - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) - // - // * - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) - // - // * - // AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) - // - // * - // AWS::IAM::User - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) - // - // * - // AWS::IAM::UserToGroupAddition - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) - // - // For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). - // - // * - // CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom - // processing on templates; this can include simple actions like find-and-replace - // operations, all the way to extensive transformations of entire templates. - // Because of this, users typically create a change set from the processed - // template, so that they can review the changes resulting from the macros before - // actually updating the stack. If your stack template contains one or more macros, - // and you choose to update a stack directly from the processed template, without - // first reviewing the resulting changes in a change set, you must acknowledge this - // capability. This includes the AWS::Include - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) - // transforms, which are macros hosted by CloudFormation. If you want to update a - // stack from a stack template that contains macros and nested stacks, you must - // update the stack directly from the template using this capability. You should - // only update stacks directly from a stack template that contains macros if you - // know what processing the macro performs. Each macro relies on an underlying - // Lambda service function for processing stack templates. Be aware that the Lambda - // function owner can update the function operation without CloudFormation being - // notified. For more information, see Using CloudFormation Macros to Perform - // Custom Processing on Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). + // In some cases, you must explicitly acknowledge that your stack template + // contains certain capabilities in order for CloudFormation to update the stack. + // - CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include + // resources that can affect permissions in your Amazon Web Services account; for + // example, by creating new Identity and Access Management (IAM) users. For those + // stacks, you must explicitly acknowledge this by specifying one of these + // capabilities. The following IAM resources require you to specify either the + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. + // - If you have IAM resources, you can specify either capability. + // - If you have IAM resources with custom names, you must specify + // CAPABILITY_NAMED_IAM . + // - If you don't specify either of these capabilities, CloudFormation returns + // an InsufficientCapabilities error. If your stack template contains these + // resources, we suggest that you review all permissions associated with them and + // edit their permissions if necessary. + // - AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // - AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // - AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // - AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) + // - AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // - AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) + // - AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) + // For more information, see Acknowledging IAM Resources in CloudFormation + // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . + // - CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom + // processing on templates; this can include simple actions like find-and-replace + // operations, all the way to extensive transformations of entire templates. + // Because of this, users typically create a change set from the processed + // template, so that they can review the changes resulting from the macros before + // actually updating the stack. If your stack template contains one or more macros, + // and you choose to update a stack directly from the processed template, without + // first reviewing the resulting changes in a change set, you must acknowledge this + // capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // transforms, which are macros hosted by CloudFormation. If you want to update a + // stack from a stack template that contains macros and nested stacks, you must + // update the stack directly from the template using this capability. You should + // only update stacks directly from a stack template that contains macros if you + // know what processing the macro performs. Each macro relies on an underlying + // Lambda service function for processing stack templates. Be aware that the Lambda + // function owner can update the function operation without CloudFormation being + // notified. For more information, see Using CloudFormation Macros to Perform + // Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) + // . Capabilities []types.Capability - // A unique identifier for this UpdateStack request. Specify this token if you plan - // to retry requests so that CloudFormation knows that you're not attempting to - // update a stack with the same name. You might retry UpdateStack requests to + // A unique identifier for this UpdateStack request. Specify this token if you + // plan to retry requests so that CloudFormation knows that you're not attempting + // to update a stack with the same name. You might retry UpdateStack requests to // ensure that CloudFormation successfully received them. All events triggered by a // given stack operation are assigned the same client request token, which you can // use to track operations. For example, if you execute a CreateStack operation - // with the token token1, then all the StackEvents generated by that operation will - // have ClientRequestToken set as token1. In the console, stack operations display - // the client request token on the Events tab. Stack operations that are initiated - // from the console use the token format Console-StackOperation-ID, which helps you - // easily identify the stack operation . For example, if you create a stack using - // the console, each stack event would be assigned the same token in the following - // format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + // with the token token1 , then all the StackEvents generated by that operation + // will have ClientRequestToken set as token1 . In the console, stack operations + // display the client request token on the Events tab. Stack operations that are + // initiated from the console use the token format Console-StackOperation-ID, which + // helps you easily identify the stack operation . For example, if you create a + // stack using the console, each stack event would be assigned the same token in + // the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 . ClientRequestToken *string // Preserve the state of previously provisioned resources when an operation fails. @@ -147,20 +113,19 @@ type UpdateStackInput struct { NotificationARNs []string // A list of Parameter structures that specify input parameters for the stack. For - // more information, see the Parameter - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) + // more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []types.Parameter // The template resource types that you have permissions to work with for this - // update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or - // Custom::MyCustomInstance. If the list of resource types doesn't include a + // update stack action, such as AWS::EC2::Instance , AWS::EC2::* , or + // Custom::MyCustomInstance . If the list of resource types doesn't include a // resource that you're updating, the stack update fails. By default, // CloudFormation grants permissions to all resource types. Identity and Access // Management (IAM) uses this parameter for CloudFormation-specific condition keys // in IAM policies. For more information, see Controlling Access with Identity and - // Access Management - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). + // Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) + // . ResourceTypes []string // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role @@ -185,8 +150,8 @@ type UpdateStackInput struct { // policy that is associated with the stack is unchanged. StackPolicyBody *string - // Structure containing the temporary overriding stack policy body. You can specify - // either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL + // Structure containing the temporary overriding stack policy body. You can + // specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL // parameter, but not both. If you want to update protected resources, specify a // temporary overriding stack policy during this update. If you don't specify a // stack policy, the current policy that is associated with the stack will be used. @@ -217,25 +182,23 @@ type UpdateStackInput struct { Tags []types.Tag // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. (For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // maximum length of 51,200 bytes. (For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide.) Conditional: You must specify only one of the - // following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate - // to true. + // following parameters: TemplateBody , TemplateURL , or set the + // UsePreviousTemplate to true . TemplateBody *string // Location of file containing the template body. The URL must point to a template // that's located in an Amazon S3 bucket or a Systems Manager document. For more - // information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate - // to true. + // following parameters: TemplateBody , TemplateURL , or set the + // UsePreviousTemplate to true . TemplateURL *string // Reuse the existing template that is associated with the stack that you are // updating. Conditional: You must specify only one of the following parameters: - // TemplateBody, TemplateURL, or set the UsePreviousTemplate to true. + // TemplateBody , TemplateURL , or set the UsePreviousTemplate to true . UsePreviousTemplate *bool noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_UpdateStackInstances.go b/service/cloudformation/api_op_UpdateStackInstances.go index f265f9cbeee..148769191c0 100644 --- a/service/cloudformation/api_op_UpdateStackInstances.go +++ b/service/cloudformation/api_op_UpdateStackInstances.go @@ -16,20 +16,17 @@ import ( // within the specified Amazon Web Services Regions. A stack instance refers to a // stack in a specific account and Region. You can only update stack instances in // Amazon Web Services Regions and accounts where they already exist; to create -// additional stack instances, use CreateStackInstances -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html). -// During stack set updates, any parameters overridden for a stack instance aren't -// updated, but retain their overridden value. You can only update the parameter -// values that are specified in the stack set; to add or delete a parameter itself, -// use UpdateStackSet -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) +// additional stack instances, use CreateStackInstances (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html) +// . During stack set updates, any parameters overridden for a stack instance +// aren't updated, but retain their overridden value. You can only update the +// parameter values that are specified in the stack set; to add or delete a +// parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update the stack set template. If you add a parameter to a template, before // you can override the parameter value specified in the stack set you must first -// use UpdateStackSet -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) +// use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update all stack instances with the updated template and parameter value // specified in the stack set. Once a stack instance has been updated with the new -// parameter, you can then override the parameter value using UpdateStackInstances. +// parameter, you can then override the parameter value using UpdateStackInstances . func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackInstancesInput, optFns ...func(*Options)) (*UpdateStackInstancesOutput, error) { if params == nil { params = &UpdateStackInstancesInput{} @@ -47,10 +44,10 @@ func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackIn type UpdateStackInstancesInput struct { - // The names of one or more Amazon Web Services Regions in which you want to update - // parameter values for stack instances. The overridden parameter values will be - // applied to all stack instances in the specified accounts and Amazon Web Services - // Regions. + // The names of one or more Amazon Web Services Regions in which you want to + // update parameter values for stack instances. The overridden parameter values + // will be applied to all stack instances in the specified accounts and Amazon Web + // Services Regions. // // This member is required. Regions []string @@ -60,27 +57,23 @@ type UpdateStackInstancesInput struct { // This member is required. StackSetName *string - // [Self-managed permissions] The names of one or more Amazon Web Services accounts - // for which you want to update parameter values for stack instances. The + // [Self-managed permissions] The names of one or more Amazon Web Services + // accounts for which you want to update parameter values for stack instances. The // overridden parameter values will be applied to all stack instances in the // specified accounts and Amazon Web Services Regions. You can specify Accounts or - // DeploymentTargets, but not both. + // DeploymentTargets , but not both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The Organizations accounts for which you want to @@ -88,7 +81,7 @@ type UpdateStackInstancesInput struct { // overridden parameter values only apply to the accounts that are currently in the // target OUs and their child OUs. Accounts added to the target OUs and their child // OUs in the future won't use the overridden values. You can specify Accounts or - // DeploymentTargets, but not both. + // DeploymentTargets , but not both. DeploymentTargets *types.DeploymentTargets // The unique identifier for this stack set operation. The operation ID also @@ -107,33 +100,24 @@ type UpdateStackInstancesInput struct { // instances in the specified accounts and Amazon Web Services Regions. When // specifying parameters and their values, be aware of how CloudFormation sets // parameter values during stack instance update operations: - // - // * To override the - // current value for a parameter, include the parameter and specify its value. - // - // * - // To leave an overridden parameter set to its present value, include the parameter - // and specify UsePreviousValue as true. (You can't specify both a value and set - // UsePreviousValue to true.) - // - // * To set an overridden parameter back to the value - // specified in the stack set, specify a parameter list but don't include the - // parameter in the list. - // - // * To leave all parameters set to their present values, - // don't specify this property at all. - // - // During stack set updates, any parameter - // values overridden for a stack instance aren't updated, but retain their - // overridden value. You can only override the parameter values that are specified - // in the stack set; to add or delete a parameter itself, use UpdateStackSet to - // update the stack set template. If you add a parameter to a template, before you - // can override the parameter value specified in the stack set you must first use - // UpdateStackSet - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) + // - To override the current value for a parameter, include the parameter and + // specify its value. + // - To leave an overridden parameter set to its present value, include the + // parameter and specify UsePreviousValue as true . (You can't specify both a + // value and set UsePreviousValue to true .) + // - To set an overridden parameter back to the value specified in the stack + // set, specify a parameter list but don't include the parameter in the list. + // - To leave all parameters set to their present values, don't specify this + // property at all. + // During stack set updates, any parameter values overridden for a stack instance + // aren't updated, but retain their overridden value. You can only override the + // parameter values that are specified in the stack set; to add or delete a + // parameter itself, use UpdateStackSet to update the stack set template. If you + // add a parameter to a template, before you can override the parameter value + // specified in the stack set you must first use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update all stack instances with the updated template and parameter value // specified in the stack set. Once a stack instance has been updated with the new - // parameter, you can then override the parameter value using UpdateStackInstances. + // parameter, you can then override the parameter value using UpdateStackInstances . ParameterOverrides []types.Parameter noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_UpdateStackSet.go b/service/cloudformation/api_op_UpdateStackSet.go index a067b8b3956..ecb44149efe 100644 --- a/service/cloudformation/api_op_UpdateStackSet.go +++ b/service/cloudformation/api_op_UpdateStackSet.go @@ -16,8 +16,8 @@ import ( // and Amazon Web Services Regions. Even if the stack set operation created by // updating the stack set fails (completely or partially, below or above a // specified failure tolerance), the stack set is updated with your changes. -// Subsequent CreateStackInstances calls on the specified stack set use the updated -// stack set. +// Subsequent CreateStackInstances calls on the specified stack set use the +// updated stack set. func (c *Client) UpdateStackSet(ctx context.Context, params *UpdateStackSetInput, optFns ...func(*Options)) (*UpdateStackSetOutput, error) { if params == nil { params = &UpdateStackSetInput{} @@ -58,8 +58,7 @@ type UpdateStackSetInput struct { // Specify an IAM role only if you are using customized administrator roles to // control which users or groups can manage specific stack sets within the same // administrator account. For more information, see Granting Permissions for Stack - // Set Operations - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. If you specified a customized administrator // role when you created the stack set, you must specify a customized administrator // role, even if it is the same customized administrator role used with this stack @@ -68,106 +67,67 @@ type UpdateStackSetInput struct { // [Service-managed permissions] Describes whether StackSets automatically deploys // to Organizations accounts that are added to a target organization or - // organizational unit (OU). If you specify AutoDeployment, don't specify - // DeploymentTargets or Regions. + // organizational unit (OU). If you specify AutoDeployment , don't specify + // DeploymentTargets or Regions . AutoDeployment *types.AutoDeployment // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. - // - // * If you are signed in to the - // management account, specify SELF. - // - // * If you are signed in to a delegated - // administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account - // must be registered as a delegated administrator in the management account. For - // more information, see Register a delegated administrator - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) - // in the CloudFormation User Guide. + // - If you are signed in to the management account, specify SELF . + // - If you are signed in to a delegated administrator account, specify + // DELEGATED_ADMIN . Your Amazon Web Services account must be registered as a + // delegated administrator in the management account. For more information, see + // Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) + // in the CloudFormation User Guide. CallAs types.CallAs - // In some cases, you must explicitly acknowledge that your stack template contains - // certain capabilities in order for CloudFormation to update the stack set and its - // associated stack instances. - // - // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some - // stack templates might include resources that can affect permissions in your - // Amazon Web Services account; for example, by creating new Identity and Access - // Management (IAM) users. For those stacks sets, you must explicitly acknowledge - // this by specifying one of these capabilities. The following IAM resources - // require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM - // capability. - // - // * If you have IAM resources, you can specify either capability. - // - // * - // If you have IAM resources with custom names, you must specify - // CAPABILITY_NAMED_IAM. - // - // * If you don't specify either of these capabilities, - // CloudFormation returns an InsufficientCapabilities error. - // - // If your stack - // template contains these resources, we recommend that you review all permissions - // associated with them and edit their permissions if necessary. - // - // * - // AWS::IAM::AccessKey - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) - // - // * - // AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) - // - // * - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) - // - // * - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) - // - // * - // AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) - // - // * - // AWS::IAM::User - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) - // - // * - // AWS::IAM::UserToGroupAddition - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) - // - // For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). - // - // * - // CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set - // template references one or more macros, you must update the stack set directly - // from the processed template, without first reviewing the resulting changes in a - // change set. To update the stack set directly, you must acknowledge this - // capability. For more information, see Using CloudFormation Macros to Perform - // Custom Processing on Templates - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). - // Stack sets with service-managed permissions do not currently support the use of - // macros in templates. (This includes the AWS::Include - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) - // and AWS::Serverless - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) - // transforms, which are macros hosted by CloudFormation.) Even if you specify this - // capability for a stack set with service-managed permissions, if you reference a - // macro in your template the stack set operation will fail. + // In some cases, you must explicitly acknowledge that your stack template + // contains certain capabilities in order for CloudFormation to update the stack + // set and its associated stack instances. + // - CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include + // resources that can affect permissions in your Amazon Web Services account; for + // example, by creating new Identity and Access Management (IAM) users. For those + // stacks sets, you must explicitly acknowledge this by specifying one of these + // capabilities. The following IAM resources require you to specify either the + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. + // - If you have IAM resources, you can specify either capability. + // - If you have IAM resources with custom names, you must specify + // CAPABILITY_NAMED_IAM . + // - If you don't specify either of these capabilities, CloudFormation returns + // an InsufficientCapabilities error. If your stack template contains these + // resources, we recommend that you review all permissions associated with them and + // edit their permissions if necessary. + // - AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) + // - AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // - AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // - AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) + // - AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // - AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) + // - AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) + // For more information, see Acknowledging IAM Resources in CloudFormation + // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . + // - CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack set + // template references one or more macros, you must update the stack set directly + // from the processed template, without first reviewing the resulting changes in a + // change set. To update the stack set directly, you must acknowledge this + // capability. For more information, see Using CloudFormation Macros to Perform + // Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) + // . Stack sets with service-managed permissions do not currently support the use + // of macros in templates. (This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) + // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) + // transforms, which are macros hosted by CloudFormation.) Even if you specify this + // capability for a stack set with service-managed permissions, if you reference a + // macro in your template the stack set operation will fail. Capabilities []types.Capability // [Service-managed permissions] The Organizations accounts in which to update // associated stack instances. To update all the stack instances associated with - // this stack set, do not specify DeploymentTargets or Regions. If the stack set + // this stack set, do not specify DeploymentTargets or Regions . If the stack set // update includes changes to the template (that is, if TemplateBody or TemplateURL - // is specified), or the Parameters, CloudFormation marks all stack instances with + // is specified), or the Parameters , CloudFormation marks all stack instances with // a status of OUTDATED prior to updating the stack instances in the specified // accounts and Amazon Web Services Regions. If the stack set update doesn't // include changes to the template or parameters, CloudFormation updates the stack @@ -178,8 +138,8 @@ type UpdateStackSetInput struct { // A brief description of updates that you are making. Description *string - // The name of the IAM execution role to use to update the stack set. If you do not - // specify an execution role, CloudFormation uses the + // The name of the IAM execution role to use to update the stack set. If you do + // not specify an execution role, CloudFormation uses the // AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify // an IAM role only if you are using customized execution roles to control which // stack resources users and groups can include in their stack sets. If you specify @@ -189,8 +149,8 @@ type UpdateStackSetInput struct { // have permissions to perform operations on the stack set. ExecutionRoleName *string - // Describes whether StackSets performs non-conflicting operations concurrently and - // queues conflicting operations. + // Describes whether StackSets performs non-conflicting operations concurrently + // and queues conflicting operations. ManagedExecution *types.ManagedExecution // The unique ID for this stack set operation. The operation ID also functions as @@ -199,7 +159,7 @@ type UpdateStackSetInput struct { // retry stack set operation requests to ensure that CloudFormation successfully // received them. If you don't specify an operation ID, CloudFormation generates // one automatically. Repeating this stack set operation with a new operation ID - // retries all stack instances whose status is OUTDATED. + // retries all stack instances whose status is OUTDATED . OperationId *string // Preferences for how CloudFormation performs this stack set operation. @@ -211,17 +171,14 @@ type UpdateStackSetInput struct { // Describes how the IAM roles required for stack set operations are created. You // cannot modify PermissionModel if there are stack instances associated with your // stack set. - // - // * With self-managed permissions, you must create the administrator - // and execution roles required to deploy to target accounts. For more information, - // see Grant Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // - // * - // With service-managed permissions, StackSets automatically creates the IAM roles - // required to deploy to accounts managed by Organizations. For more information, - // see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + // - With self-managed permissions, you must create the administrator and + // execution roles required to deploy to target accounts. For more information, see + // Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) + // . + // - With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) + // . PermissionModel types.PermissionModels // The Amazon Web Services Regions in which to update associated stack instances. @@ -237,56 +194,48 @@ type UpdateStackSetInput struct { // instances with their existing stack instance status. Regions []string - // The key-value pairs to associate with this stack set and the stacks created from - // it. CloudFormation also propagates these tags to supported resources that are - // created in the stacks. You can specify a maximum number of 50 tags. If you + // The key-value pairs to associate with this stack set and the stacks created + // from it. CloudFormation also propagates these tags to supported resources that + // are created in the stacks. You can specify a maximum number of 50 tags. If you // specify tags for this parameter, those tags replace any list of tags that are // currently associated with this stack set. This means: + // - If you don't specify this parameter, CloudFormation doesn't modify the + // stack's tags. + // - If you specify any tags using this parameter, you must specify all the tags + // that you want associated with this stack set, even tags you've specified before + // (for example, when creating the stack set or during a previous update of the + // stack set.). Any tags that you don't include in the updated list of tags are + // removed from the stack set, and therefore from the stacks and resources as well. // - // * If you don't specify - // this parameter, CloudFormation doesn't modify the stack's tags. - // - // * If you - // specify any tags using this parameter, you must specify all the tags that you - // want associated with this stack set, even tags you've specified before (for - // example, when creating the stack set or during a previous update of the stack - // set.). Any tags that you don't include in the updated list of tags are removed - // from the stack set, and therefore from the stacks and resources as well. - // - // * If - // you specify an empty value, CloudFormation removes all currently associated - // tags. - // - // If you specify new tags as part of an UpdateStackSet action, - // CloudFormation checks to see if you have the required IAM permission to tag - // resources. If you omit tags that are currently associated with the stack set - // from the list of tags you specify, CloudFormation assumes that you want to - // remove those tags from the stack set, and checks to see if you have permission - // to untag resources. If you don't have the necessary permission(s), the entire - // UpdateStackSet action fails with an access denied error, and the stack set is - // not updated. + // - If you specify an empty value, CloudFormation removes all currently + // associated tags. + // If you specify new tags as part of an UpdateStackSet action, CloudFormation + // checks to see if you have the required IAM permission to tag resources. If you + // omit tags that are currently associated with the stack set from the list of tags + // you specify, CloudFormation assumes that you want to remove those tags from the + // stack set, and checks to see if you have permission to untag resources. If you + // don't have the necessary permission(s), the entire UpdateStackSet action fails + // with an access denied error, and the stack set is not updated. Tags []types.Tag // The structure that contains the template body, with a minimum length of 1 byte - // and a maximum length of 51,200 bytes. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // and a maximum length of 51,200 bytes. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to - // true. + // following parameters: TemplateBody or TemplateURL —or set UsePreviousTemplate + // to true. TemplateBody *string // The location of the file that contains the template body. The URL must point to // a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket - // or a Systems Manager document. For more information, see Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // or a Systems Manager document. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to - // true. + // following parameters: TemplateBody or TemplateURL —or set UsePreviousTemplate + // to true. TemplateURL *string // Use the existing template that's associated with the stack set that you're // updating. Conditional: You must specify only one of the following parameters: - // TemplateBody or TemplateURL—or set UsePreviousTemplate to true. + // TemplateBody or TemplateURL —or set UsePreviousTemplate to true. UsePreviousTemplate *bool noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_UpdateTerminationProtection.go b/service/cloudformation/api_op_UpdateTerminationProtection.go index b59a1927948..fb6bf74e0e6 100644 --- a/service/cloudformation/api_op_UpdateTerminationProtection.go +++ b/service/cloudformation/api_op_UpdateTerminationProtection.go @@ -12,13 +12,11 @@ import ( // Updates termination protection for the specified stack. If a user attempts to // delete a stack with termination protection enabled, the operation fails and the -// stack remains unchanged. For more information, see Protecting a Stack From Being -// Deleted -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) -// in the CloudFormation User Guide. For nested stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), -// termination protection is set on the root stack and can't be changed directly on -// the nested stack. +// stack remains unchanged. For more information, see Protecting a Stack From +// Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) +// in the CloudFormation User Guide. For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) +// , termination protection is set on the root stack and can't be changed directly +// on the nested stack. func (c *Client) UpdateTerminationProtection(ctx context.Context, params *UpdateTerminationProtectionInput, optFns ...func(*Options)) (*UpdateTerminationProtectionOutput, error) { if params == nil { params = &UpdateTerminationProtectionInput{} diff --git a/service/cloudformation/api_op_ValidateTemplate.go b/service/cloudformation/api_op_ValidateTemplate.go index 113f7f09cd1..07c6e01ed39 100644 --- a/service/cloudformation/api_op_ValidateTemplate.go +++ b/service/cloudformation/api_op_ValidateTemplate.go @@ -33,18 +33,16 @@ func (c *Client) ValidateTemplate(ctx context.Context, params *ValidateTemplateI type ValidateTemplateInput struct { // Structure containing the template body with a minimum length of 1 byte and a - // maximum length of 51,200 bytes. For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // maximum length of 51,200 bytes. For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must pass TemplateURL or - // TemplateBody. If both are passed, only TemplateBody is used. + // TemplateBody . If both are passed, only TemplateBody is used. TemplateBody *string // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems - // Manager document. For more information, go to Template Anatomy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) + // Manager document. For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the CloudFormation User Guide. Conditional: You must pass TemplateURL or - // TemplateBody. If both are passed, only TemplateBody is used. + // TemplateBody . If both are passed, only TemplateBody is used. TemplateURL *string noSmithyDocumentSerde @@ -57,8 +55,8 @@ type ValidateTemplateOutput struct { // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for // this parameter when you use the CreateStack or UpdateStack actions with your // template; otherwise, those actions return an InsufficientCapabilities error. For - // more information, see Acknowledging IAM Resources in CloudFormation Templates - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). + // more information, see Acknowledging IAM Resources in CloudFormation Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // . Capabilities []types.Capability // The list of resources that generated the values in the Capabilities response diff --git a/service/cloudformation/doc.go b/service/cloudformation/doc.go index 361ec87e6ab..db08705c8b6 100644 --- a/service/cloudformation/doc.go +++ b/service/cloudformation/doc.go @@ -14,9 +14,9 @@ // collection of resources as a single unit called a stack. CloudFormation creates // and deletes all member resources of the stack together and manages all // dependencies between the resources for you. For more information about -// CloudFormation, see the CloudFormation product page -// (http://aws.amazon.com/cloudformation/). CloudFormation makes use of other -// Amazon Web Services products. If you need additional technical information about -// a specific Amazon Web Services product, you can find the product's technical -// documentation at docs.aws.amazon.com (https://docs.aws.amazon.com/). +// CloudFormation, see the CloudFormation product page (http://aws.amazon.com/cloudformation/) +// . CloudFormation makes use of other Amazon Web Services products. If you need +// additional technical information about a specific Amazon Web Services product, +// you can find the product's technical documentation at docs.aws.amazon.com (https://docs.aws.amazon.com/) +// . package cloudformation diff --git a/service/cloudformation/types/enums.go b/service/cloudformation/types/enums.go index ad8c39b363d..da9fd215bbe 100644 --- a/service/cloudformation/types/enums.go +++ b/service/cloudformation/types/enums.go @@ -115,9 +115,9 @@ const ( ChangeActionDynamic ChangeAction = "Dynamic" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "Add", @@ -209,9 +209,9 @@ const ( ChangeSourceAutomatic ChangeSource = "Automatic" ) -// Values returns all known values for ChangeSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeSource. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeSource) Values() []ChangeSource { return []ChangeSource{ "ResourceReference", @@ -473,9 +473,9 @@ const ( OnFailureDelete OnFailure = "DELETE" ) -// Values returns all known values for OnFailure. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OnFailure. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OnFailure) Values() []OnFailure { return []OnFailure{ "DO_NOTHING", @@ -586,8 +586,8 @@ const ( RegionConcurrencyTypeParallel RegionConcurrencyType = "PARALLEL" ) -// Values returns all known values for RegionConcurrencyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RegionConcurrencyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RegionConcurrencyType) Values() []RegionConcurrencyType { return []RegionConcurrencyType{ @@ -625,9 +625,9 @@ const ( RegistryTypeHook RegistryType = "HOOK" ) -// Values returns all known values for RegistryType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RegistryType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RegistryType) Values() []RegistryType { return []RegistryType{ "RESOURCE", @@ -894,9 +894,9 @@ const ( StackResourceDriftStatusNotChecked StackResourceDriftStatus = "NOT_CHECKED" ) -// Values returns all known values for StackResourceDriftStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StackResourceDriftStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (StackResourceDriftStatus) Values() []StackResourceDriftStatus { return []StackResourceDriftStatus{ "IN_SYNC", @@ -917,9 +917,10 @@ const ( StackSetDriftDetectionStatusStopped StackSetDriftDetectionStatus = "STOPPED" ) -// Values returns all known values for StackSetDriftDetectionStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StackSetDriftDetectionStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (StackSetDriftDetectionStatus) Values() []StackSetDriftDetectionStatus { return []StackSetDriftDetectionStatus{ "COMPLETED", diff --git a/service/cloudformation/types/errors.go b/service/cloudformation/types/errors.go index ad9cad7e5fd..ec9e2018e1a 100644 --- a/service/cloudformation/types/errors.go +++ b/service/cloudformation/types/errors.go @@ -140,8 +140,8 @@ func (e *InsufficientCapabilitiesException) ErrorCode() string { func (e *InsufficientCapabilitiesException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified change set can't be used to update the stack. For example, the -// change set status might be CREATE_IN_PROGRESS, or the stack status might be -// UPDATE_IN_PROGRESS. +// change set status might be CREATE_IN_PROGRESS , or the stack status might be +// UPDATE_IN_PROGRESS . type InvalidChangeSetStatusException struct { Message *string @@ -193,9 +193,8 @@ func (e *InvalidOperationException) ErrorCode() string { } func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Error reserved for use by the CloudFormation CLI -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). -// CloudFormation doesn't return this error to users. +// Error reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) +// . CloudFormation doesn't return this error to users. type InvalidStateTransitionException struct { Message *string @@ -222,8 +221,7 @@ func (e *InvalidStateTransitionException) ErrorCode() string { func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The quota for the resource has already been reached. For information about -// resource and stack limitations, see CloudFormation quotas -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) +// resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) // in the CloudFormation User Guide. type LimitExceededException struct { Message *string @@ -355,9 +353,8 @@ func (e *OperationNotFoundException) ErrorCode() string { } func (e *OperationNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Error reserved for use by the CloudFormation CLI -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). -// CloudFormation doesn't return this error to users. +// Error reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html) +// . CloudFormation doesn't return this error to users. type OperationStatusCheckFailedException struct { Message *string @@ -438,9 +435,9 @@ func (e *StackNotFoundException) ErrorCode() string { } func (e *StackNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You can't yet delete this stack set, because it still contains one or more stack -// instances. Delete all stack instances from the stack set before deleting the -// stack set. +// You can't yet delete this stack set, because it still contains one or more +// stack instances. Delete all stack instances from the stack set before deleting +// the stack set. type StackSetNotEmptyException struct { Message *string diff --git a/service/cloudformation/types/types.go b/service/cloudformation/types/types.go index ef2b88502a9..07958bbb078 100644 --- a/service/cloudformation/types/types.go +++ b/service/cloudformation/types/types.go @@ -13,41 +13,32 @@ import ( // specify a Lambda function that encapsulates any requirements that must be met // before CloudFormation can proceed with a stack set operation in that account and // Region. CloudFormation invokes the function each time a stack set operation is -// requested for that account and Region; if the function returns FAILED, +// requested for that account and Region; if the function returns FAILED , // CloudFormation cancels the operation in that account and Region, and sets the -// stack set operation result status for that account and Region to FAILED. For -// more information, see Configuring a target account gate -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html). +// stack set operation result status for that account and Region to FAILED . For +// more information, see Configuring a target account gate (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html) +// . type AccountGateResult struct { // The status of the account gate function. - // - // * SUCCEEDED: The account gate function - // has determined that the account and Region passes any requirements for a stack - // set operation to occur. CloudFormation proceeds with the stack operation in that - // account and Region. - // - // * FAILED: The account gate function has determined that the - // account and Region doesn't meet the requirements for a stack set operation to - // occur. CloudFormation cancels the stack set operation in that account and - // Region, and sets the stack set operation result status for that account and - // Region to FAILED. - // - // * SKIPPED: CloudFormation has skipped calling the account - // gate function for this account and Region, for one of the following reasons: - // - // * - // An account gate function hasn't been specified for the account and Region. - // CloudFormation proceeds with the stack set operation in this account and - // Region. - // - // * The AWSCloudFormationStackSetExecutionRole of the stack set - // administration account lacks permissions to invoke the function. CloudFormation - // proceeds with the stack set operation in this account and Region. - // - // * Either no - // action is necessary, or no action is possible, on the stack. CloudFormation - // skips the stack set operation in this account and Region. + // - SUCCEEDED : The account gate function has determined that the account and + // Region passes any requirements for a stack set operation to occur. + // CloudFormation proceeds with the stack operation in that account and Region. + // - FAILED : The account gate function has determined that the account and + // Region doesn't meet the requirements for a stack set operation to occur. + // CloudFormation cancels the stack set operation in that account and Region, and + // sets the stack set operation result status for that account and Region to + // FAILED . + // - SKIPPED : CloudFormation has skipped calling the account gate function for + // this account and Region, for one of the following reasons: + // - An account gate function hasn't been specified for the account and Region. + // CloudFormation proceeds with the stack set operation in this account and Region. + // + // - The AWSCloudFormationStackSetExecutionRole of the stack set administration + // account lacks permissions to invoke the function. CloudFormation proceeds with + // the stack set operation in this account and Region. + // - Either no action is necessary, or no action is possible, on the stack. + // CloudFormation skips the stack set operation in this account and Region. Status AccountGateStatus // The reason for the account gate status assigned to this account and Region for @@ -59,17 +50,12 @@ type AccountGateResult struct { // The AccountLimit data type. CloudFormation has the following limits per // account: +// - Number of concurrent resources +// - Number of stacks +// - Number of stack outputs // -// * Number of concurrent resources -// -// * Number of stacks -// -// * Number of -// stack outputs -// -// For more information about these account limits, and other -// CloudFormation limits, see CloudFormation quotas -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) +// For more information about these account limits, and other CloudFormation +// limits, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) // in the CloudFormation User Guide. type AccountLimit struct { @@ -88,16 +74,16 @@ type AccountLimit struct { // organizational unit (OU). type AutoDeployment struct { - // If set to true, StackSets automatically deploys additional stack instances to + // If set to true , StackSets automatically deploys additional stack instances to // Organizations accounts that are added to a target organization or organizational // unit (OU) in the specified Regions. If an account is removed from a target // organization or OU, StackSets deletes stack instances from the account in the // specified Regions. Enabled *bool - // If set to true, stack resources are retained when an account is removed from a - // target organization or OU. If set to false, stack resources are deleted. Specify - // only if Enabled is set to True. + // If set to true , stack resources are retained when an account is removed from a + // target organization or OU. If set to false , stack resources are deleted. + // Specify only if Enabled is set to True . RetainStacksOnAccountRemoval *bool noSmithyDocumentSerde @@ -123,7 +109,7 @@ type BatchDescribeTypeConfigurationsError struct { // execute the change set. type Change struct { - // Is either null, if no hooks invoke for the resource, or contains the number of + // Is either null , if no hooks invoke for the resource, or contains the number of // hooks that will invoke for the resource. HookInvocationCount *int32 @@ -132,7 +118,7 @@ type Change struct { ResourceChange *ResourceChange // The type of entity that CloudFormation changes. Currently, the only entity type - // is Resource. + // is Resource . Type ChangeType noSmithyDocumentSerde @@ -143,11 +129,8 @@ type ChangeSetHook struct { // Specify the hook failure mode for non-compliant resources in the followings // ways. - // - // * FAIL Stops provisioning resources. - // - // * WARN Allows provisioning to - // continue with a warning message. + // - FAIL Stops provisioning resources. + // - WARN Allows provisioning to continue with a warning message. FailureMode HookFailureMode // Specifies the points in provisioning logic where a hook is invoked. @@ -160,23 +143,15 @@ type ChangeSetHook struct { TypeConfigurationVersionId *string // The unique name for your hook. Specifies a three-part namespace for your hook, - // with a recommended pattern of Organization::Service::Hook. The following - // organization namespaces are reserved and can't be used in your hook type - // names: - // - // * Alexa - // - // * AMZN - // - // * Amazon - // - // * ASK - // - // * AWS - // - // * Custom - // - // * Dev + // with a recommended pattern of Organization::Service::Hook . The following + // organization namespaces are reserved and can't be used in your hook type names: + // - Alexa + // - AMZN + // - Amazon + // - ASK + // - AWS + // - Custom + // - Dev TypeName *string // The version ID of the type specified. @@ -194,7 +169,7 @@ type ChangeSetHookResourceTargetDetails struct { // Specifies the action of the resource. ResourceAction ChangeAction - // The type of CloudFormation resource, such as AWS::S3::Bucket. + // The type of CloudFormation resource, such as AWS::S3::Bucket . ResourceType *string noSmithyDocumentSerde @@ -203,7 +178,7 @@ type ChangeSetHookResourceTargetDetails struct { // Specifies target details for an activated hook. type ChangeSetHookTargetDetails struct { - // Required if TargetType is RESOURCE. + // Required if TargetType is RESOURCE . ResourceTargetDetails *ChangeSetHookResourceTargetDetails // The name of the type. @@ -212,8 +187,8 @@ type ChangeSetHookTargetDetails struct { noSmithyDocumentSerde } -// The ChangeSetSummary structure describes a change set, its status, and the stack -// with which it's associated. +// The ChangeSetSummary structure describes a change set, its status, and the +// stack with which it's associated. type ChangeSetSummary struct { // The ID of the change set. @@ -228,9 +203,9 @@ type ChangeSetSummary struct { // Descriptive information about the change set. Description *string - // If the change set execution status is AVAILABLE, you can execute the change set. - // If you can't execute the change set, the status indicates why. For example, a - // change set might be in an UNAVAILABLE state because CloudFormation is still + // If the change set execution status is AVAILABLE , you can execute the change + // set. If you can't execute the change set, the status indicates why. For example, + // a change set might be in an UNAVAILABLE state because CloudFormation is still // creating it or in an OBSOLETE state because the stack was already updated. ExecutionStatus ExecutionStatus @@ -249,8 +224,8 @@ type ChangeSetSummary struct { // The name of the stack with which the change set is associated. StackName *string - // The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or - // FAILED. + // The state of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or + // FAILED . Status ChangeSetStatus // A description of the change set's status. For example, if your change set is in @@ -264,28 +239,23 @@ type ChangeSetSummary struct { // deploys. StackSets doesn't deploy stack instances to the organization management // account, even if the organization management account is in your organization or // in an OU in your organization. For update operations, you can specify either -// Accounts or OrganizationalUnitIds. For create and delete operations, specify -// OrganizationalUnitIds. +// Accounts or OrganizationalUnitIds . For create and delete operations, specify +// OrganizationalUnitIds . type DeploymentTargets struct { // Limit deployment targets to individual accounts or include additional accounts // with provided OUs. The following is a list of possible values for the // AccountFilterType operation. - // - // * INTERSECTION: StackSets deploys to the accounts - // specified in Accounts parameter. - // - // * DIFFERENCE: StackSets excludes the accounts - // specified in Accounts parameter. This enables user to avoid certain accounts - // within an OU such as suspended accounts. - // - // * UNION: StackSets includes additional - // accounts deployment targets. This is the default value if AccountFilterType is - // not provided. This enables user to update an entire OU and individual accounts - // from a different OU in one request, which used to be two separate requests. - // - // * - // NONE: Deploys to all the accounts in specified organizational units (OU). + // - INTERSECTION : StackSets deploys to the accounts specified in Accounts + // parameter. + // - DIFFERENCE : StackSets excludes the accounts specified in Accounts + // parameter. This enables user to avoid certain accounts within an OU such as + // suspended accounts. + // - UNION : StackSets includes additional accounts deployment targets. This is + // the default value if AccountFilterType is not provided. This enables user to + // update an entire OU and individual accounts from a different OU in one request, + // which used to be two separate requests. + // - NONE : Deploys to all the accounts in specified organizational units (OU). AccountFilterType AccountFilterType // The names of one or more Amazon Web Services accounts for which you want to @@ -338,17 +308,17 @@ type LoggingConfig struct { noSmithyDocumentSerde } -// Describes whether StackSets performs non-conflicting operations concurrently and -// queues conflicting operations. +// Describes whether StackSets performs non-conflicting operations concurrently +// and queues conflicting operations. type ManagedExecution struct { - // When true, StackSets performs non-conflicting operations concurrently and queues - // conflicting operations. After conflicting operations finish, StackSets starts - // queued operations in request order. If there are already running or queued - // operations, StackSets queues all incoming operations even if they are + // When true , StackSets performs non-conflicting operations concurrently and + // queues conflicting operations. After conflicting operations finish, StackSets + // starts queued operations in request order. If there are already running or + // queued operations, StackSets queues all incoming operations even if they are // non-conflicting. You can't modify your stack set's execution configuration while - // there are running or queued operations for that stack set. When false (default), - // StackSets performs one operation at a time in request order. + // there are running or queued operations for that stack set. When false + // (default), StackSets performs one operation at a time in request order. Active *bool noSmithyDocumentSerde @@ -362,17 +332,17 @@ type ModuleInfo struct { // A concatenated list of the logical IDs of the module or modules containing the // resource. Modules are listed starting with the inner-most nested module, and - // separated by /. In the following example, the resource was created from a - // module, moduleA, that's nested inside a parent module, moduleB. moduleA/moduleB - // For more information, see Referencing resources in a module in the - // CloudFormation User Guide. + // separated by / . In the following example, the resource was created from a + // module, moduleA , that's nested inside a parent module, moduleB . + // moduleA/moduleB For more information, see Referencing resources in a module in + // the CloudFormation User Guide. LogicalIdHierarchy *string // A concatenated list of the module type or types containing the resource. Module - // types are listed starting with the inner-most nested module, and separated by /. - // In the following example, the resource was created from a module of type - // AWS::First::Example::MODULE, that's nested inside a parent module of type - // AWS::Second::Example::MODULE. + // types are listed starting with the inner-most nested module, and separated by / + // . In the following example, the resource was created from a module of type + // AWS::First::Example::MODULE , that's nested inside a parent module of type + // AWS::Second::Example::MODULE . // AWS::First::Example::MODULE/AWS::Second::Example::MODULE TypeHierarchy *string @@ -421,13 +391,12 @@ type Parameter struct { ParameterValue *string // Read-only. The value that corresponds to a SSM parameter key. This field is - // returned only for SSM - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types) + // returned only for SSM (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types) // parameter types in the template. ResolvedValue *string // During a stack update, use the existing parameter value that the stack is using - // for a given parameter key. If you specify true, do not specify a parameter + // for a given parameter key. If you specify true , do not specify a parameter // value. UsePreviousValue *bool @@ -470,10 +439,11 @@ type ParameterDeclaration struct { noSmithyDocumentSerde } -// Context information that enables CloudFormation to uniquely identify a resource. -// CloudFormation uses context key-value pairs in cases where a resource's logical -// and physical IDs aren't enough to uniquely identify that resource. Each context -// key-value pair specifies a resource that contains the targeted resource. +// Context information that enables CloudFormation to uniquely identify a +// resource. CloudFormation uses context key-value pairs in cases where a +// resource's logical and physical IDs aren't enough to uniquely identify that +// resource. Each context key-value pair specifies a resource that contains the +// targeted resource. type PhysicalResourceIdContextKeyValuePair struct { // The resource context key. @@ -492,9 +462,9 @@ type PhysicalResourceIdContextKeyValuePair struct { // Information about a resource property whose actual value differs from its // expected value, as defined in the stack template and any values specified as // template parameters. These will be present only for resources whose -// StackResourceDriftStatus is MODIFIED. For more information, see Detecting -// Unregulated Configuration Changes to Stacks and Resources -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). +// StackResourceDriftStatus is MODIFIED . For more information, see Detecting +// Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) +// . type PropertyDifference struct { // The actual property value of the resource property. @@ -503,16 +473,12 @@ type PropertyDifference struct { ActualValue *string // The type of property difference. - // - // * ADD: A value has been added to a resource - // property that's an array or list data type. - // - // * REMOVE: The property has been - // removed from the current resource configuration. - // - // * NOT_EQUAL: The current - // property value differs from its expected value (as defined in the stack template - // and any values specified as template parameters). + // - ADD : A value has been added to a resource property that's an array or list + // data type. + // - REMOVE : The property has been removed from the current resource + // configuration. + // - NOT_EQUAL : The current property value differs from its expected value (as + // defined in the stack template and any values specified as template parameters). // // This member is required. DifferenceType DifferenceType @@ -533,8 +499,7 @@ type PropertyDifference struct { // For extensions that are modules, a public third-party extension that must be // activated in your account in order for the module itself to be activated. For -// more information, see Activating public modules for use in your account -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling) +// more information, see Activating public modules for use in your account (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling) // in the CloudFormation User Guide. type RequiredActivatedType struct { @@ -542,8 +507,7 @@ type RequiredActivatedType struct { // enabling the extension in this account and region, CloudFormation treats that // alias as the extension's type name within the account and region, not the type // name of the public extension. For more information, see Specifying aliases to - // refer to extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) + // refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) // in the CloudFormation User Guide. OriginalTypeName *string @@ -594,64 +558,57 @@ type ResourceChange struct { // resource by creating a new one and deleting the old one. This value depends on // the value of the RequiresRecreation property in the ResourceTargetDefinition // structure. For example, if the RequiresRecreation field is Always and the - // Evaluation field is Static, Replacement is True. If the RequiresRecreation field - // is Always and the Evaluation field is Dynamic, Replacement is Conditionally. If - // you have multiple changes with different RequiresRecreation values, the - // Replacement value depends on the change with the most impact. A + // Evaluation field is Static , Replacement is True . If the RequiresRecreation + // field is Always and the Evaluation field is Dynamic , Replacement is + // Conditionally . If you have multiple changes with different RequiresRecreation + // values, the Replacement value depends on the change with the most impact. A // RequiresRecreation value of Always has the most impact, followed by - // Conditionally, and then Never. + // Conditionally , and then Never . Replacement Replacement - // The type of CloudFormation resource, such as AWS::S3::Bucket. + // The type of CloudFormation resource, such as AWS::S3::Bucket . ResourceType *string // For the Modify action, indicates which resource attribute is triggering this - // update, such as a change in the resource attribute's Metadata, Properties, or - // Tags. + // update, such as a change in the resource attribute's Metadata , Properties , or + // Tags . Scope []ResourceAttribute noSmithyDocumentSerde } -// For a resource with Modify as the action, the ResourceChange structure describes -// the changes CloudFormation will make to that resource. +// For a resource with Modify as the action, the ResourceChange structure +// describes the changes CloudFormation will make to that resource. type ResourceChangeDetail struct { // The identity of the entity that triggered this change. This entity is a member // of the group that's specified by the ChangeSource field. For example, if you // modified the value of the KeyPairName parameter, the CausingEntity is the name - // of the parameter (KeyPairName). If the ChangeSource value is DirectModification, - // no value is given for CausingEntity. + // of the parameter ( KeyPairName ). If the ChangeSource value is + // DirectModification , no value is given for CausingEntity . CausingEntity *string // The group to which the CausingEntity value belongs. There are five entity // groups: - // - // * ResourceReference entities are Ref intrinsic functions that refer to - // resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. - // - // * - // ParameterReference entities are Ref intrinsic functions that get template - // parameter values, such as { "Ref" : "MyPasswordParameter" }. - // - // * - // ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource - // attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", - // "PublicDnsName" ] }. - // - // * DirectModification entities are changes that are made - // directly to the template. - // - // * Automatic entities are AWS::CloudFormation::Stack - // resource types, which are also known as nested stacks. If you made no changes to - // the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to - // Automatic because the nested stack's template might have changed. Changes to a - // nested stack's template aren't visible to CloudFormation until you run an update - // on the parent stack. + // - ResourceReference entities are Ref intrinsic functions that refer to + // resources in the template, such as { "Ref" : "MyEC2InstanceResource" } . + // - ParameterReference entities are Ref intrinsic functions that get template + // parameter values, such as { "Ref" : "MyPasswordParameter" } . + // - ResourceAttribute entities are Fn::GetAtt intrinsic functions that get + // resource attribute values, such as { "Fn::GetAtt" : [ + // "MyEC2InstanceResource", "PublicDnsName" ] } . + // - DirectModification entities are changes that are made directly to the + // template. + // - Automatic entities are AWS::CloudFormation::Stack resource types, which are + // also known as nested stacks. If you made no changes to the + // AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to + // Automatic because the nested stack's template might have changed. Changes to a + // nested stack's template aren't visible to CloudFormation until you run an update + // on the parent stack. ChangeSource ChangeSource - // Indicates whether CloudFormation can determine the target value, and whether the - // target value will change before you execute a change set. For Static + // Indicates whether CloudFormation can determine the target value, and whether + // the target value will change before you execute a change set. For Static // evaluations, CloudFormation can determine that the target value will change, and // its value. For example, if you directly modify the InstanceType property of an // EC2 instance, CloudFormation knows that this property value will change, and its @@ -677,7 +634,7 @@ type ResourceChangeDetail struct { // during the import to identify resources of that type. type ResourceIdentifierSummary struct { - // The logical IDs of the target resources of the specified ResourceType, as + // The logical IDs of the target resources of the specified ResourceType , as // defined in the import template. LogicalResourceIds []string @@ -686,7 +643,7 @@ type ResourceIdentifierSummary struct { // AWS::S3::Bucket resources. ResourceIdentifiers []string - // The template resource type of the target resources, such as AWS::S3::Bucket. + // The template resource type of the target resources, such as AWS::S3::Bucket . ResourceType *string noSmithyDocumentSerde @@ -697,18 +654,17 @@ type ResourceIdentifierSummary struct { type ResourceTargetDefinition struct { // Indicates which resource attribute is triggering this update, such as a change - // in the resource attribute's Metadata, Properties, or Tags. + // in the resource attribute's Metadata , Properties , or Tags . Attribute ResourceAttribute - // If the Attribute value is Properties, the name of the property. For all other + // If the Attribute value is Properties , the name of the property. For all other // attributes, the value is null. Name *string - // If the Attribute value is Properties, indicates whether a change to this - // property causes the resource to be recreated. The value can be Never, Always, or - // Conditionally. To determine the conditions for a Conditionally recreation, see - // the update behavior for that property - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // If the Attribute value is Properties , indicates whether a change to this + // property causes the resource to be recreated. The value can be Never , Always , + // or Conditionally . To determine the conditions for a Conditionally recreation, + // see the update behavior for that property (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. RequiresRecreation RequiresRecreation @@ -725,14 +681,13 @@ type ResourceToImport struct { // A key-value pair that identifies the target resource. The key is an identifier // property (for example, BucketName for AWS::S3::Bucket resources) and the value - // is the actual property value (for example, MyS3Bucket). + // is the actual property value (for example, MyS3Bucket ). // // This member is required. ResourceIdentifier map[string]string - // The type of resource to import into your stack, such as AWS::S3::Bucket. For a - // list of supported resource types, see Resources that support import operations - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) + // The type of resource to import into your stack, such as AWS::S3::Bucket . For a + // list of supported resource types, see Resources that support import operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) // in the CloudFormation User Guide. // // This member is required. @@ -747,8 +702,8 @@ type ResourceToImport struct { // state of your application during stack creation and updating, and to roll back // that operation if the application breaches the threshold of any of the alarms // you've specified. For more information, see Monitor and Roll Back Stack -// Operations -// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html). +// Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html) +// . type RollbackConfiguration struct { // The amount of time, in minutes, during which CloudFormation should monitor all @@ -758,9 +713,8 @@ type RollbackConfiguration struct { // specified period of time before cleaning up old resources after update // operations. You can use this monitoring period to perform any manual stack // validation desired, and manually cancel the stack creation or update (using - // CancelUpdateStack - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html), - // for example) as necessary. If you specify 0 for this parameter, CloudFormation + // CancelUpdateStack (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html) + // , for example) as necessary. If you specify 0 for this parameter, CloudFormation // still monitors the specified rollback triggers during stack creation and update // operations. Then, for update operations, it begins disposing of old resources // immediately once the operation completes. @@ -772,22 +726,17 @@ type RollbackConfiguration struct { // otherwise. If you do specify rollback triggers for this parameter, those // triggers replace any list of triggers previously specified for the stack. This // means: - // - // * To use the rollback triggers previously specified for this stack, if - // any, don't specify this parameter. - // - // * To specify new or updated rollback - // triggers, you must specify all the triggers that you want used for this stack, - // even triggers you've specified before (for example, when creating the stack or - // during a previous stack update). Any triggers that you don't include in the - // updated list of triggers are no longer applied to the stack. - // - // * To remove all - // currently specified triggers, specify an empty list for this parameter. - // - // If a - // specified trigger is missing, the entire stack operation fails and is rolled - // back. + // - To use the rollback triggers previously specified for this stack, if any, + // don't specify this parameter. + // - To specify new or updated rollback triggers, you must specify all the + // triggers that you want used for this stack, even triggers you've specified + // before (for example, when creating the stack or during a previous stack update). + // Any triggers that you don't include in the updated list of triggers are no + // longer applied to the stack. + // - To remove all currently specified triggers, specify an empty list for this + // parameter. + // If a specified trigger is missing, the entire stack operation fails and is + // rolled back. RollbackTriggers []RollbackTrigger noSmithyDocumentSerde @@ -805,10 +754,8 @@ type RollbackTrigger struct { // This member is required. Arn *string - // The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html) - // or AWS::CloudWatch::CompositeAlarm - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html) + // The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html) + // or AWS::CloudWatch::CompositeAlarm (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html) // resource types. // // This member is required. @@ -848,26 +795,21 @@ type Stack struct { Description *string // Boolean to enable or disable rollback on stack creation failures: - // - // * true: - // disable rollback. - // - // * false: enable rollback. + // - true : disable rollback. + // - false : enable rollback. DisableRollback *bool // Information about whether a stack's actual configuration differs, or has // drifted, from it's expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // any values specified as template parameters. For more information, see + // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) + // . DriftInformation *StackDriftInformation - // Whether termination protection is enabled for the stack. For nested stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), - // termination protection is set on the root stack and can't be changed directly on - // the nested stack. For more information, see Protecting a Stack From Being - // Deleted - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) + // Whether termination protection is enabled for the stack. For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // , termination protection is set on the root stack and can't be changed directly + // on the nested stack. For more information, see Protecting a Stack From Being + // Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the CloudFormation User Guide. EnableTerminationProtection *bool @@ -888,8 +830,7 @@ type Stack struct { // For nested stacks--stacks created as resources for another stack--the stack ID // of the direct parent of this stack. For the first level of nested stacks, the // root stack is also the parent stack. For more information, see Working with - // Nested Stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. ParentId *string @@ -904,8 +845,7 @@ type Stack struct { // For nested stacks--stacks created as resources for another stack--the stack ID // of the top-level stack to which the nested stack ultimately belongs. For more - // information, see Working with Nested Stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. RootId *string @@ -915,7 +855,7 @@ type Stack struct { // Success/failure message associated with the stack status. StackStatusReason *string - // A list of Tags that specify information about the stack. + // A list of Tag s that specify information about the stack. Tags []Tag // The amount of time within which stack creation should complete. @@ -932,25 +872,20 @@ type StackDriftInformation struct { // Status of the stack's actual configuration compared to its expected template // configuration. - // - // * DRIFTED: The stack differs from its expected template - // configuration. A stack is considered to have drifted if one or more of its - // resources have drifted. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the - // stack differs from its expected template configuration. - // - // * IN_SYNC: The stack's - // actual configuration matches its expected template configuration. - // - // * UNKNOWN: - // This value is reserved for future use. + // - DRIFTED : The stack differs from its expected template configuration. A + // stack is considered to have drifted if one or more of its resources have + // drifted. + // - NOT_CHECKED : CloudFormation hasn't checked if the stack differs from its + // expected template configuration. + // - IN_SYNC : The stack's actual configuration matches its expected template + // configuration. + // - UNKNOWN : This value is reserved for future use. // // This member is required. StackDriftStatus StackDriftStatus - // Most recent time when a drift detection operation was initiated on the stack, or - // any of its individual resources that support drift detection. + // Most recent time when a drift detection operation was initiated on the stack, + // or any of its individual resources that support drift detection. LastCheckTimestamp *time.Time noSmithyDocumentSerde @@ -964,25 +899,20 @@ type StackDriftInformationSummary struct { // Status of the stack's actual configuration compared to its expected template // configuration. - // - // * DRIFTED: The stack differs from its expected template - // configuration. A stack is considered to have drifted if one or more of its - // resources have drifted. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the - // stack differs from its expected template configuration. - // - // * IN_SYNC: The stack's - // actual configuration matches its expected template configuration. - // - // * UNKNOWN: - // This value is reserved for future use. + // - DRIFTED : The stack differs from its expected template configuration. A + // stack is considered to have drifted if one or more of its resources have + // drifted. + // - NOT_CHECKED : CloudFormation hasn't checked if the stack differs from its + // expected template configuration. + // - IN_SYNC : The stack's actual configuration matches its expected template + // configuration. + // - UNKNOWN : This value is reserved for future use. // // This member is required. StackDriftStatus StackDriftStatus - // Most recent time when a drift detection operation was initiated on the stack, or - // any of its individual resources that support drift detection. + // Most recent time when a drift detection operation was initiated on the stack, + // or any of its individual resources that support drift detection. LastCheckTimestamp *time.Time noSmithyDocumentSerde @@ -1014,23 +944,20 @@ type StackEvent struct { // The token passed to the operation that generated this event. All events // triggered by a given stack operation are assigned the same client request token, // which you can use to track operations. For example, if you execute a CreateStack - // operation with the token token1, then all the StackEvents generated by that - // operation will have ClientRequestToken set as token1. In the console, stack + // operation with the token token1 , then all the StackEvents generated by that + // operation will have ClientRequestToken set as token1 . In the console, stack // operations display the client request token on the Events tab. Stack operations // that are initiated from the console use the token format // Console-StackOperation-ID, which helps you easily identify the stack operation . // For example, if you create a stack using the console, each stack event would be // assigned the same token in the following format: - // Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. + // Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 . ClientRequestToken *string // Specify the hook failure mode for non-compliant resources in the followings // ways. - // - // * FAIL Stops provisioning resources. - // - // * WARN Allows provisioning to - // continue with a warning message. + // - FAIL Stops provisioning resources. + // - WARN Allows provisioning to continue with a warning message. HookFailureMode HookFailureMode // Invocation points are points in provisioning logic where hooks are initiated. @@ -1062,8 +989,7 @@ type StackEvent struct { ResourceStatusReason *string // Type of resource. (For more information, go to Amazon Web Services Resource - // Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide.) ResourceType *string @@ -1085,21 +1011,15 @@ type StackInstance struct { // Status of the stack instance's actual configuration compared to the expected // template and parameter configuration of the stack set to which it belongs. - // - // * - // DRIFTED: The stack differs from the expected template and parameter - // configuration of the stack set to which it belongs. A stack instance is - // considered to have drifted if one or more of the resources in the associated - // stack have drifted. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the stack - // instance differs from its expected stack set configuration. - // - // * IN_SYNC: The - // stack instance's actual configuration matches its expected stack set - // configuration. - // - // * UNKNOWN: This value is reserved for future use. + // - DRIFTED : The stack differs from the expected template and parameter + // configuration of the stack set to which it belongs. A stack instance is + // considered to have drifted if one or more of the resources in the associated + // stack have drifted. + // - NOT_CHECKED : CloudFormation hasn't checked if the stack instance differs + // from its expected stack set configuration. + // - IN_SYNC : The stack instance's actual configuration matches its expected + // stack set configuration. + // - UNKNOWN : This value is reserved for future use. DriftStatus StackDriftStatus // Most recent time when CloudFormation performed a drift detection operation on @@ -1111,16 +1031,16 @@ type StackInstance struct { LastOperationId *string // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + // (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html) + // . OrganizationalUnitId *string // A list of parameters from the stack set template whose values have been // overridden in this stack instance. ParameterOverrides []Parameter - // The name of the Amazon Web Services Region that the stack instance is associated - // with. + // The name of the Amazon Web Services Region that the stack instance is + // associated with. Region *string // The ID of the stack instance. @@ -1135,25 +1055,17 @@ type StackInstance struct { // The status of the stack instance, in terms of its synchronization with its // associated stack set. - // - // * INOPERABLE: A DeleteStackInstances operation has failed - // and left the stack in an unstable state. Stacks in this state are excluded from - // further UpdateStackSet operations. You might need to perform a - // DeleteStackInstances operation, with RetainStacks set to true, to delete the - // stack instance, and then delete the stack manually. - // - // * OUTDATED: The stack isn't - // currently up to date with the stack set because: - // - // * The associated stack failed - // during a CreateStackSet or UpdateStackSet operation. - // - // * The stack was part of a - // CreateStackSet or UpdateStackSet operation that failed or was stopped before the - // stack was created or updated. - // - // * CURRENT: The stack is currently up to date with - // the stack set. + // - INOPERABLE : A DeleteStackInstances operation has failed and left the stack + // in an unstable state. Stacks in this state are excluded from further + // UpdateStackSet operations. You might need to perform a DeleteStackInstances + // operation, with RetainStacks set to true , to delete the stack instance, and + // then delete the stack manually. + // - OUTDATED : The stack isn't currently up to date with the stack set because: + // - The associated stack failed during a CreateStackSet or UpdateStackSet + // operation. + // - The stack was part of a CreateStackSet or UpdateStackSet operation that + // failed or was stopped before the stack was created or updated. + // - CURRENT : The stack is currently up to date with the stack set. Status StackInstanceStatus // The explanation for the specific status code that's assigned to this stack @@ -1166,30 +1078,23 @@ type StackInstance struct { // The detailed status of the stack instance. type StackInstanceComprehensiveStatus struct { - // * CANCELLED: The operation in the specified account and Region has been - // canceled. This is either because a user has stopped the stack set operation, or - // because the failure tolerance of the stack set operation has been exceeded. - // - // * - // FAILED: The operation in the specified account and Region failed. If the stack - // set operation fails in enough accounts within a Region, the failure tolerance - // for the stack set operation as a whole might be exceeded. - // - // * INOPERABLE: A - // DeleteStackInstances operation has failed and left the stack in an unstable - // state. Stacks in this state are excluded from further UpdateStackSet operations. - // You might need to perform a DeleteStackInstances operation, with RetainStacks - // set to true, to delete the stack instance, and then delete the stack - // manually. - // - // * PENDING: The operation in the specified account and Region has yet - // to start. - // - // * RUNNING: The operation in the specified account and Region is - // currently in progress. - // - // * SUCCEEDED: The operation in the specified account and - // Region completed successfully. + // - CANCELLED : The operation in the specified account and Region has been + // canceled. This is either because a user has stopped the stack set operation, or + // because the failure tolerance of the stack set operation has been exceeded. + // - FAILED : The operation in the specified account and Region failed. If the + // stack set operation fails in enough accounts within a Region, the failure + // tolerance for the stack set operation as a whole might be exceeded. + // - INOPERABLE : A DeleteStackInstances operation has failed and left the stack + // in an unstable state. Stacks in this state are excluded from further + // UpdateStackSet operations. You might need to perform a DeleteStackInstances + // operation, with RetainStacks set to true , to delete the stack instance, and + // then delete the stack manually. + // - PENDING : The operation in the specified account and Region has yet to + // start. + // - RUNNING : The operation in the specified account and Region is currently in + // progress. + // - SUCCEEDED : The operation in the specified account and Region completed + // successfully. DetailedStatus StackInstanceDetailedStatus noSmithyDocumentSerde @@ -1216,21 +1121,15 @@ type StackInstanceSummary struct { // Status of the stack instance's actual configuration compared to the expected // template and parameter configuration of the stack set to which it belongs. - // - // * - // DRIFTED: The stack differs from the expected template and parameter - // configuration of the stack set to which it belongs. A stack instance is - // considered to have drifted if one or more of the resources in the associated - // stack have drifted. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the stack - // instance differs from its expected stack set configuration. - // - // * IN_SYNC: The - // stack instance's actual configuration matches its expected stack set - // configuration. - // - // * UNKNOWN: This value is reserved for future use. + // - DRIFTED : The stack differs from the expected template and parameter + // configuration of the stack set to which it belongs. A stack instance is + // considered to have drifted if one or more of the resources in the associated + // stack have drifted. + // - NOT_CHECKED : CloudFormation hasn't checked if the stack instance differs + // from its expected stack set configuration. + // - IN_SYNC : The stack instance's actual configuration matches its expected + // stack set configuration. + // - UNKNOWN : This value is reserved for future use. DriftStatus StackDriftStatus // Most recent time when CloudFormation performed a drift detection operation on @@ -1242,12 +1141,12 @@ type StackInstanceSummary struct { LastOperationId *string // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + // (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html) + // . OrganizationalUnitId *string - // The name of the Amazon Web Services Region that the stack instance is associated - // with. + // The name of the Amazon Web Services Region that the stack instance is + // associated with. Region *string // The ID of the stack instance. @@ -1262,25 +1161,17 @@ type StackInstanceSummary struct { // The status of the stack instance, in terms of its synchronization with its // associated stack set. - // - // * INOPERABLE: A DeleteStackInstances operation has failed - // and left the stack in an unstable state. Stacks in this state are excluded from - // further UpdateStackSet operations. You might need to perform a - // DeleteStackInstances operation, with RetainStacks set to true, to delete the - // stack instance, and then delete the stack manually. - // - // * OUTDATED: The stack isn't - // currently up to date with the stack set because: - // - // * The associated stack failed - // during a CreateStackSet or UpdateStackSet operation. - // - // * The stack was part of a - // CreateStackSet or UpdateStackSet operation that failed or was stopped before the - // stack was created or updated. - // - // * CURRENT: The stack is currently up to date with - // the stack set. + // - INOPERABLE : A DeleteStackInstances operation has failed and left the stack + // in an unstable state. Stacks in this state are excluded from further + // UpdateStackSet operations. You might need to perform a DeleteStackInstances + // operation, with RetainStacks set to true , to delete the stack instance, and + // then delete the stack manually. + // - OUTDATED : The stack isn't currently up to date with the stack set because: + // - The associated stack failed during a CreateStackSet or UpdateStackSet + // operation. + // - The stack was part of a CreateStackSet or UpdateStackSet operation that + // failed or was stopped before the stack was created or updated. + // - CURRENT : The stack is currently up to date with the stack set. Status StackInstanceStatus // The explanation for the specific status code assigned to this stack instance. @@ -1302,9 +1193,8 @@ type StackResource struct { // This member is required. ResourceStatus ResourceStatus - // Type of resource. For more information, go to Amazon Web Services Resource Types - // Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // Type of resource. For more information, go to Amazon Web Services Resource + // Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. // // This member is required. @@ -1320,9 +1210,9 @@ type StackResource struct { // Information about whether the resource's actual configuration differs, or has // drifted, from its expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // any values specified as template parameters. For more information, see + // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) + // . DriftInformation *StackResourceDriftInformation // Contains information about the module from which the resource was created, if @@ -1363,9 +1253,8 @@ type StackResourceDetail struct { // This member is required. ResourceStatus ResourceStatus - // Type of resource. For more information, go to Amazon Web Services Resource Types - // Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // Type of resource. For more information, go to Amazon Web Services Resource + // Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. // // This member is required. @@ -1376,14 +1265,13 @@ type StackResourceDetail struct { // Information about whether the resource's actual configuration differs, or has // drifted, from its expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // any values specified as template parameters. For more information, see + // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) + // . DriftInformation *StackResourceDriftInformation // The content of the Metadata attribute declared for the resource. For more - // information, see Metadata Attribute - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html) + // information, see Metadata Attribute (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html) // in the CloudFormation User Guide. Metadata *string @@ -1410,14 +1298,12 @@ type StackResourceDetail struct { // Contains the drift information for a resource that has been checked for drift. // This includes actual and expected property values for resources in which // CloudFormation has detected drift. Only resource properties explicitly defined -// in the stack template are checked for drift. For more information, see Detecting -// Unregulated Configuration Changes to Stacks and Resources -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). -// Resources that don't currently support drift detection can't be checked. For a -// list of resources that support drift detection, see Resources that Support Drift -// Detection -// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). -// Use DetectStackResourceDrift to detect drift on individual resources, or +// in the stack template are checked for drift. For more information, see +// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) +// . Resources that don't currently support drift detection can't be checked. For a +// list of resources that support drift detection, see Resources that Support +// Drift Detection (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) +// . Use DetectStackResourceDrift to detect drift on individual resources, or // DetectStackDrift to detect drift on all resources in a given stack that support // drift detection. type StackResourceDrift struct { @@ -1439,19 +1325,14 @@ type StackResourceDrift struct { // Status of the resource's actual configuration compared to its expected // configuration. - // - // * DELETED: The resource differs from its expected template - // configuration because the resource has been deleted. - // - // * MODIFIED: One or more - // resource properties differ from their expected values (as defined in the stack - // template and any values specified as template parameters). - // - // * IN_SYNC: The - // resource's actual configuration matches its expected template configuration. - // - // * - // NOT_CHECKED: CloudFormation does not currently return this value. + // - DELETED : The resource differs from its expected template configuration + // because the resource has been deleted. + // - MODIFIED : One or more resource properties differ from their expected values + // (as defined in the stack template and any values specified as template + // parameters). + // - IN_SYNC : The resource's actual configuration matches its expected template + // configuration. + // - NOT_CHECKED : CloudFormation does not currently return this value. // // This member is required. StackResourceDriftStatus StackResourceDriftStatus @@ -1462,13 +1343,13 @@ type StackResourceDrift struct { Timestamp *time.Time // A JSON structure containing the actual property values of the stack resource. - // For resources whose StackResourceDriftStatus is DELETED, this structure will not - // be present. + // For resources whose StackResourceDriftStatus is DELETED , this structure will + // not be present. ActualProperties *string // A JSON structure containing the expected property values of the stack resource, // as defined in the stack template and any values specified as template - // parameters. For resources whose StackResourceDriftStatus is DELETED, this + // parameters. For resources whose StackResourceDriftStatus is DELETED , this // structure will not be present. ExpectedProperties *string @@ -1480,15 +1361,16 @@ type StackResourceDrift struct { // resource supported by CloudFormation. PhysicalResourceId *string - // Context information that enables CloudFormation to uniquely identify a resource. - // CloudFormation uses context key-value pairs in cases where a resource's logical - // and physical IDs aren't enough to uniquely identify that resource. Each context - // key-value pair specifies a unique resource that contains the targeted resource. + // Context information that enables CloudFormation to uniquely identify a + // resource. CloudFormation uses context key-value pairs in cases where a + // resource's logical and physical IDs aren't enough to uniquely identify that + // resource. Each context key-value pair specifies a unique resource that contains + // the targeted resource. PhysicalResourceIdContext []PhysicalResourceIdContextKeyValuePair // A collection of the resource properties whose actual values differ from their // expected values. These will be present only for resources whose - // StackResourceDriftStatus is MODIFIED. + // StackResourceDriftStatus is MODIFIED . PropertyDifferences []PropertyDifference noSmithyDocumentSerde @@ -1500,21 +1382,16 @@ type StackResourceDriftInformation struct { // Status of the resource's actual configuration compared to its expected // configuration - // - // * DELETED: The resource differs from its expected configuration - // in that it has been deleted. - // - // * MODIFIED: The resource differs from its expected - // configuration. - // - // * NOT_CHECKED: CloudFormation has not checked if the resource - // differs from its expected configuration. Any resources that do not currently - // support drift detection have a status of NOT_CHECKED. For more information, see - // Resources that Support Drift Detection - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). - // - // * - // IN_SYNC: The resource's actual configuration matches its expected configuration. + // - DELETED : The resource differs from its expected configuration in that it + // has been deleted. + // - MODIFIED : The resource differs from its expected configuration. + // - NOT_CHECKED : CloudFormation has not checked if the resource differs from + // its expected configuration. Any resources that do not currently support drift + // detection have a status of NOT_CHECKED . For more information, see Resources + // that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) + // . + // - IN_SYNC : The resource's actual configuration matches its expected + // configuration. // // This member is required. StackResourceDriftStatus StackResourceDriftStatus @@ -1532,27 +1409,20 @@ type StackResourceDriftInformationSummary struct { // Status of the resource's actual configuration compared to its expected // configuration. - // - // * DELETED: The resource differs from its expected configuration - // in that it has been deleted. - // - // * MODIFIED: The resource differs from its expected - // configuration. - // - // * NOT_CHECKED: CloudFormation hasn't checked if the resource - // differs from its expected configuration. Any resources that don't currently - // support drift detection have a status of NOT_CHECKED. For more information, see - // Resources that Support Drift Detection - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). - // If you performed an ContinueUpdateRollback operation on a stack, any resources - // included in ResourcesToSkip will also have a status of NOT_CHECKED. For more - // information about skipping resources during rollback operations, see Continue - // Rolling Back an Update - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) - // in the CloudFormation User Guide. - // - // * IN_SYNC: The resource's actual - // configuration matches its expected configuration. + // - DELETED : The resource differs from its expected configuration in that it + // has been deleted. + // - MODIFIED : The resource differs from its expected configuration. + // - NOT_CHECKED : CloudFormation hasn't checked if the resource differs from its + // expected configuration. Any resources that don't currently support drift + // detection have a status of NOT_CHECKED . For more information, see Resources + // that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html) + // . If you performed an ContinueUpdateRollback operation on a stack, any + // resources included in ResourcesToSkip will also have a status of NOT_CHECKED . + // For more information about skipping resources during rollback operations, see + // Continue Rolling Back an Update (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) + // in the CloudFormation User Guide. + // - IN_SYNC : The resource's actual configuration matches its expected + // configuration. // // This member is required. StackResourceDriftStatus StackResourceDriftStatus @@ -1583,8 +1453,7 @@ type StackResourceSummary struct { ResourceStatus ResourceStatus // Type of resource. (For more information, go to Amazon Web Services Resource - // Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide.) // // This member is required. @@ -1592,9 +1461,9 @@ type StackResourceSummary struct { // Information about whether the resource's actual configuration differs, or has // drifted, from its expected configuration, as defined in the stack template and - // any values specified as template parameters. For more information, see Detecting - // Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // any values specified as template parameters. For more information, see + // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) + // . DriftInformation *StackResourceDriftInformationSummary // Contains information about the module from which the resource was created, if @@ -1611,8 +1480,8 @@ type StackResourceSummary struct { noSmithyDocumentSerde } -// A structure that contains information about a stack set. A stack set enables you -// to provision stacks into Amazon Web Services accounts and across Regions by +// A structure that contains information about a stack set. A stack set enables +// you to provision stacks into Amazon Web Services accounts and across Regions by // using a single CloudFormation template. In the stack set, you specify the // template to use, in addition to any parameters and capabilities that the // template requires. @@ -1621,8 +1490,7 @@ type StackSet struct { // The Amazon Resource Name (ARN) of the IAM role used to create or update the // stack set. Use customized administrator roles to control which users or groups // can manage specific stack sets within the same administrator account. For more - // information, see Prerequisites: Granting Permissions for Stack Set Operations - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // information, see Prerequisites: Granting Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string @@ -1635,12 +1503,11 @@ type StackSet struct { // might include resources that can affect permissions in your Amazon Web Services // account—for example, by creating new Identity and Access Management (IAM) users. // For more information, see Acknowledging IAM Resources in CloudFormation - // Templates. - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // Templates. (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) Capabilities []Capability - // A description of the stack set that you specify when the stack set is created or - // updated. + // A description of the stack set that you specify when the stack set is created + // or updated. Description *string // The name of the IAM execution role used to create or update the stack set. Use @@ -1648,31 +1515,27 @@ type StackSet struct { // include in their stack sets. ExecutionRoleName *string - // Describes whether StackSets performs non-conflicting operations concurrently and - // queues conflicting operations. + // Describes whether StackSets performs non-conflicting operations concurrently + // and queues conflicting operations. ManagedExecution *ManagedExecution // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + // (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html) + // . OrganizationalUnitIds []string // A list of input parameters for a stack set. Parameters []Parameter // Describes how the IAM roles required for stack set operations are created. - // - // * - // With self-managed permissions, you must create the administrator and execution - // roles required to deploy to target accounts. For more information, see Grant - // Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // - // * - // With service-managed permissions, StackSets automatically creates the IAM roles - // required to deploy to accounts managed by Organizations. For more information, - // see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + // - With self-managed permissions, you must create the administrator and + // execution roles required to deploy to target accounts. For more information, see + // Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) + // . + // - With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) + // . PermissionModel PermissionModels Regions []string @@ -1695,8 +1558,8 @@ type StackSet struct { // The status of the stack set. Status StackSetStatus - // A list of tags that specify information about the stack set. A maximum number of - // 50 tags can be specified. + // A list of tags that specify information about the stack set. A maximum number + // of 50 tags can be specified. Tags []Tag // The structure that contains the body of the template that was used to create or @@ -1711,46 +1574,32 @@ type StackSet struct { // stack set. Information about drift operations in-progress isn't included. For // stack set operations, includes information about drift operations currently // being performed on the stack set. For more information, see Detecting unmanaged -// changes in stack sets -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) +// changes in stack sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) // in the CloudFormation User Guide. type StackSetDriftDetectionDetails struct { // The status of the stack set drift detection operation. - // - // * COMPLETED: The drift - // detection operation completed without failing on any stack instances. - // - // * FAILED: - // The drift detection operation exceeded the specified failure tolerance. - // - // * - // PARTIAL_SUCCESS: The drift detection operation completed without exceeding the - // failure tolerance for the operation. - // - // * IN_PROGRESS: The drift detection - // operation is currently being performed. - // - // * STOPPED: The user has canceled the - // drift detection operation. + // - COMPLETED : The drift detection operation completed without failing on any + // stack instances. + // - FAILED : The drift detection operation exceeded the specified failure + // tolerance. + // - PARTIAL_SUCCESS : The drift detection operation completed without exceeding + // the failure tolerance for the operation. + // - IN_PROGRESS : The drift detection operation is currently being performed. + // - STOPPED : The user has canceled the drift detection operation. DriftDetectionStatus StackSetDriftDetectionStatus - // Status of the stack set's actual configuration compared to its expected template - // and parameter configuration. A stack set is considered to have drifted if one or - // more of its stack instances have drifted from their expected template and - // parameter configuration. - // - // * DRIFTED: One or more of the stack instances - // belonging to the stack set stack differs from the expected template and - // parameter configuration. A stack instance is considered to have drifted if one - // or more of the resources in the associated stack have drifted. - // - // * NOT_CHECKED: - // CloudFormation hasn't checked the stack set for drift. - // - // * IN_SYNC: All of the - // stack instances belonging to the stack set stack match from the expected - // template and parameter configuration. + // Status of the stack set's actual configuration compared to its expected + // template and parameter configuration. A stack set is considered to have drifted + // if one or more of its stack instances have drifted from their expected template + // and parameter configuration. + // - DRIFTED : One or more of the stack instances belonging to the stack set + // stack differs from the expected template and parameter configuration. A stack + // instance is considered to have drifted if one or more of the resources in the + // associated stack have drifted. + // - NOT_CHECKED : CloudFormation hasn't checked the stack set for drift. + // - IN_SYNC : All of the stack instances belonging to the stack set stack match + // from the expected template and parameter configuration. DriftStatus StackSetDriftStatus // The number of stack instances that have drifted from the expected template and @@ -1776,17 +1625,10 @@ type StackSetDriftDetectionDetails struct { // The total number of stack instances belonging to this stack set. The total // number of stack instances is equal to the total of: - // - // * Stack instances that - // match the stack set configuration. - // - // * Stack instances that have drifted from the - // stack set configuration. - // - // * Stack instances where the drift detection operation - // has failed. - // - // * Stack instances currently being checked for drift. + // - Stack instances that match the stack set configuration. + // - Stack instances that have drifted from the stack set configuration. + // - Stack instances where the drift detection operation has failed. + // - Stack instances currently being checked for drift. TotalStackInstancesCount int32 noSmithyDocumentSerde @@ -1795,7 +1637,7 @@ type StackSetDriftDetectionDetails struct { // The structure that contains information about a stack set operation. type StackSetOperation struct { - // The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete + // The type of stack set operation: CREATE , UPDATE , or DELETE . Create and delete // operations affect only the specified stack set instances that are associated // with the specified stack set. Update operations affect both the stack set // itself, in addition to all associated stack set instances. @@ -1804,8 +1646,7 @@ type StackSetOperation struct { // The Amazon Resource Name (ARN) of the IAM role used to perform this stack set // operation. Use customized administrator roles to control which users or groups // can manage specific stack sets within the same administrator account. For more - // information, see Define Permissions for Multiple Administrators - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) + // information, see Define Permissions for Multiple Administrators (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the CloudFormation User Guide. AdministrationRoleARN *string @@ -1820,9 +1661,9 @@ type StackSetOperation struct { // operation. DeploymentTargets *DeploymentTargets - // The time at which the stack set operation ended, across all accounts and Regions - // specified. Note that this doesn't necessarily mean that the stack set operation - // was successful, or even attempted, in each account or Region. + // The time at which the stack set operation ended, across all accounts and + // Regions specified. Note that this doesn't necessarily mean that the stack set + // operation was successful, or even attempted, in each account or Region. EndTimestamp *time.Time // The name of the IAM execution role used to create or update the stack set. Use @@ -1836,7 +1677,7 @@ type StackSetOperation struct { // The preferences for how CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences - // For stack set operations of action type DELETE, specifies whether to remove the + // For stack set operations of action type DELETE , specifies whether to remove the // stack instances from the specified stack set, but doesn't delete the stacks. You // can't re-associate a retained stack, or add an existing, saved stack to a new // stack set. @@ -1844,10 +1685,9 @@ type StackSetOperation struct { // Detailed information about the drift status of the stack set. This includes // information about drift operations currently being performed on the stack set. - // This information will only be present for stack set operations whose Action type - // is DETECT_DRIFT. For more information, see Detecting Unmanaged Changes in Stack - // Sets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) + // This information will only be present for stack set operations whose Action + // type is DETECT_DRIFT . For more information, see Detecting Unmanaged Changes in + // Stack Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) // in the CloudFormation User Guide. StackSetDriftDetectionDetails *StackSetDriftDetectionDetails @@ -1855,33 +1695,22 @@ type StackSetOperation struct { StackSetId *string // The status of the operation. - // - // * FAILED: The operation exceeded the specified - // failure tolerance. The failure tolerance value that you've set for an operation - // is applied for each Region during stack create and update operations. If the - // number of failed stacks within a Region exceeds the failure tolerance, the - // status of the operation in the Region is set to FAILED. This in turn sets the - // status of the operation as a whole to FAILED, and CloudFormation cancels the - // operation in any remaining Regions. - // - // * QUEUED: [Service-managed permissions] For - // automatic deployments that require a sequence of operations, the operation is - // queued to be performed. For more information, see the stack set operation status - // codes - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) - // in the CloudFormation User Guide. - // - // * RUNNING: The operation is currently being - // performed. - // - // * STOPPED: The user has canceled the operation. - // - // * STOPPING: The - // operation is in the process of stopping, at user request. - // - // * SUCCEEDED: The - // operation completed creating or updating all the specified stacks without - // exceeding the failure tolerance for the operation. + // - FAILED : The operation exceeded the specified failure tolerance. The failure + // tolerance value that you've set for an operation is applied for each Region + // during stack create and update operations. If the number of failed stacks within + // a Region exceeds the failure tolerance, the status of the operation in the + // Region is set to FAILED . This in turn sets the status of the operation as a + // whole to FAILED , and CloudFormation cancels the operation in any remaining + // Regions. + // - QUEUED : [Service-managed permissions] For automatic deployments that + // require a sequence of operations, the operation is queued to be performed. For + // more information, see the stack set operation status codes (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) + // in the CloudFormation User Guide. + // - RUNNING : The operation is currently being performed. + // - STOPPED : The user has canceled the operation. + // - STOPPING : The operation is in the process of stopping, at user request. + // - SUCCEEDED : The operation completed creating or updating all the specified + // stacks without exceeding the failure tolerance for the operation. Status StackSetOperationStatus // Detailed information about the StackSet operation. @@ -1895,8 +1724,8 @@ type StackSetOperation struct { // The user-specified preferences for how CloudFormation performs a stack set // operation. For more information about maximum concurrent accounts and failure -// tolerance, see Stack set operation options -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). +// tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) +// . type StackSetOperationPreferences struct { // The number of accounts, per Region, for which this operation can fail before @@ -1912,16 +1741,16 @@ type StackSetOperationPreferences struct { // subsequent Regions. When calculating the number of accounts based on the // specified percentage, CloudFormation rounds down to the next whole number. // Conditional: You must specify either FailureToleranceCount or - // FailureTolerancePercentage, but not both. By default, 0 is specified. + // FailureTolerancePercentage , but not both. By default, 0 is specified. FailureTolerancePercentage *int32 // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of FailureToleranceCount.MaxConcurrentCount is at - // most one more than the FailureToleranceCount. Note that this setting lets you - // specify the maximum for operations. For large deployments, under certain + // This is dependent on the value of FailureToleranceCount . MaxConcurrentCount is + // at most one more than the FailureToleranceCount . Note that this setting lets + // you specify the maximum for operations. For large deployments, under certain // circumstances the actual number of accounts acted upon concurrently may be lower // due to service throttling. Conditional: You must specify either - // MaxConcurrentCount or MaxConcurrentPercentage, but not both. By default, 1 is + // MaxConcurrentCount or MaxConcurrentPercentage , but not both. By default, 1 is // specified. MaxConcurrentCount *int32 @@ -1933,7 +1762,7 @@ type StackSetOperationPreferences struct { // maximum for operations. For large deployments, under certain circumstances the // actual number of accounts acted upon concurrently may be lower due to service // throttling. Conditional: You must specify either MaxConcurrentCount or - // MaxConcurrentPercentage, but not both. By default, 1 is specified. + // MaxConcurrentPercentage , but not both. By default, 1 is specified. MaxConcurrentPercentage *int32 // The concurrency type of deploying StackSets operations in Regions, could be in @@ -1959,8 +1788,8 @@ type StackSetOperationResultSummary struct { AccountGateResult *AccountGateResult // [Service-managed permissions] The organization root ID or organizational unit - // (OU) IDs that you specified for DeploymentTargets - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). + // (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html) + // . OrganizationalUnitId *string // The name of the Amazon Web Services Region for this operation result. @@ -1968,25 +1797,18 @@ type StackSetOperationResultSummary struct { // The result status of the stack set operation for the given account in the given // Region. - // - // * CANCELLED: The operation in the specified account and Region has been - // canceled. This is either because a user has stopped the stack set operation, or - // because the failure tolerance of the stack set operation has been exceeded. - // - // * - // FAILED: The operation in the specified account and Region failed. If the stack - // set operation fails in enough accounts within a Region, the failure tolerance - // for the stack set operation as a whole might be exceeded. - // - // * RUNNING: The - // operation in the specified account and Region is currently in progress. - // - // * - // PENDING: The operation in the specified account and Region has yet to start. - // - // * - // SUCCEEDED: The operation in the specified account and Region completed - // successfully. + // - CANCELLED : The operation in the specified account and Region has been + // canceled. This is either because a user has stopped the stack set operation, or + // because the failure tolerance of the stack set operation has been exceeded. + // - FAILED : The operation in the specified account and Region failed. If the + // stack set operation fails in enough accounts within a Region, the failure + // tolerance for the stack set operation as a whole might be exceeded. + // - RUNNING : The operation in the specified account and Region is currently in + // progress. + // - PENDING : The operation in the specified account and Region has yet to + // start. + // - SUCCEEDED : The operation in the specified account and Region completed + // successfully. Status StackSetOperationResultStatus // The reason for the assigned result status. @@ -2007,10 +1829,10 @@ type StackSetOperationStatusDetails struct { // The structures that contain summary information about the specified operation. type StackSetOperationSummary struct { - // The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations - // affect only the specified stack instances that are associated with the specified - // stack set. Update operations affect both the stack set itself and all associated - // stack set instances. + // The type of operation: CREATE , UPDATE , or DELETE . Create and delete + // operations affect only the specified stack instances that are associated with + // the specified stack set. Update operations affect both the stack set itself and + // all associated stack set instances. Action StackSetOperationAction // The time at which the operation was initiated. Note that the creation times for @@ -2020,9 +1842,9 @@ type StackSetOperationSummary struct { // before actually creating the first stacks. CreationTimestamp *time.Time - // The time at which the stack set operation ended, across all accounts and Regions - // specified. Note that this doesn't necessarily mean that the stack set operation - // was successful, or even attempted, in each account or Region. + // The time at which the stack set operation ended, across all accounts and + // Regions specified. Note that this doesn't necessarily mean that the stack set + // operation was successful, or even attempted, in each account or Region. EndTimestamp *time.Time // The unique ID of the stack set operation. @@ -2030,38 +1852,27 @@ type StackSetOperationSummary struct { // The user-specified preferences for how CloudFormation performs a stack set // operation. For more information about maximum concurrent accounts and failure - // tolerance, see Stack set operation options - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). + // tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) + // . OperationPreferences *StackSetOperationPreferences // The overall status of the operation. - // - // * FAILED: The operation exceeded the - // specified failure tolerance. The failure tolerance value that you've set for an - // operation is applied for each Region during stack create and update operations. - // If the number of failed stacks within a Region exceeds the failure tolerance, - // the status of the operation in the Region is set to FAILED. This in turn sets - // the status of the operation as a whole to FAILED, and CloudFormation cancels the - // operation in any remaining Regions. - // - // * QUEUED: [Service-managed permissions] For - // automatic deployments that require a sequence of operations, the operation is - // queued to be performed. For more information, see the stack set operation status - // codes - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) - // in the CloudFormation User Guide. - // - // * RUNNING: The operation is currently being - // performed. - // - // * STOPPED: The user has canceled the operation. - // - // * STOPPING: The - // operation is in the process of stopping, at user request. - // - // * SUCCEEDED: The - // operation completed creating or updating all the specified stacks without - // exceeding the failure tolerance for the operation. + // - FAILED : The operation exceeded the specified failure tolerance. The failure + // tolerance value that you've set for an operation is applied for each Region + // during stack create and update operations. If the number of failed stacks within + // a Region exceeds the failure tolerance, the status of the operation in the + // Region is set to FAILED . This in turn sets the status of the operation as a + // whole to FAILED , and CloudFormation cancels the operation in any remaining + // Regions. + // - QUEUED : [Service-managed permissions] For automatic deployments that + // require a sequence of operations, the operation is queued to be performed. For + // more information, see the stack set operation status codes (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes) + // in the CloudFormation User Guide. + // - RUNNING : The operation is currently being performed. + // - STOPPED : The user has canceled the operation. + // - STOPPING : The operation is in the process of stopping, at user request. + // - SUCCEEDED : The operation completed creating or updating all the specified + // stacks without exceeding the failure tolerance for the operation. Status StackSetOperationStatus // Detailed information about the stack set operation. @@ -2080,28 +1891,22 @@ type StackSetSummary struct { // to Organizations accounts that are added to a target organizational unit (OU). AutoDeployment *AutoDeployment - // A description of the stack set that you specify when the stack set is created or - // updated. + // A description of the stack set that you specify when the stack set is created + // or updated. Description *string - // Status of the stack set's actual configuration compared to its expected template - // and parameter configuration. A stack set is considered to have drifted if one or - // more of its stack instances have drifted from their expected template and - // parameter configuration. - // - // * DRIFTED: One or more of the stack instances - // belonging to the stack set stack differs from the expected template and - // parameter configuration. A stack instance is considered to have drifted if one - // or more of the resources in the associated stack have drifted. - // - // * NOT_CHECKED: - // CloudFormation hasn't checked the stack set for drift. - // - // * IN_SYNC: All the stack - // instances belonging to the stack set stack match from the expected template and - // parameter configuration. - // - // * UNKNOWN: This value is reserved for future use. + // Status of the stack set's actual configuration compared to its expected + // template and parameter configuration. A stack set is considered to have drifted + // if one or more of its stack instances have drifted from their expected template + // and parameter configuration. + // - DRIFTED : One or more of the stack instances belonging to the stack set + // stack differs from the expected template and parameter configuration. A stack + // instance is considered to have drifted if one or more of the resources in the + // associated stack have drifted. + // - NOT_CHECKED : CloudFormation hasn't checked the stack set for drift. + // - IN_SYNC : All the stack instances belonging to the stack set stack match + // from the expected template and parameter configuration. + // - UNKNOWN : This value is reserved for future use. DriftStatus StackDriftStatus // Most recent time when CloudFormation performed a drift detection operation on @@ -2109,23 +1914,19 @@ type StackSetSummary struct { // detection hasn't yet been performed. LastDriftCheckTimestamp *time.Time - // Describes whether StackSets performs non-conflicting operations concurrently and - // queues conflicting operations. + // Describes whether StackSets performs non-conflicting operations concurrently + // and queues conflicting operations. ManagedExecution *ManagedExecution // Describes how the IAM roles required for stack set operations are created. - // - // * - // With self-managed permissions, you must create the administrator and execution - // roles required to deploy to target accounts. For more information, see Grant - // Self-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). - // - // * - // With service-managed permissions, StackSets automatically creates the IAM roles - // required to deploy to accounts managed by Organizations. For more information, - // see Grant Service-Managed Stack Set Permissions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). + // - With self-managed permissions, you must create the administrator and + // execution roles required to deploy to target accounts. For more information, see + // Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) + // . + // - With service-managed permissions, StackSets automatically creates the IAM + // roles required to deploy to accounts managed by Organizations. For more + // information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html) + // . PermissionModel PermissionModels // The ID of the stack set. @@ -2164,8 +1965,8 @@ type StackSummary struct { // Summarizes information about whether a stack's actual configuration differs, or // has drifted, from it's expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see - // Detecting Unregulated Configuration Changes to Stacks and Resources - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). + // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) + // . DriftInformation *StackDriftInformationSummary // The time the stack was last updated. This field will only be returned if the @@ -2175,15 +1976,13 @@ type StackSummary struct { // For nested stacks--stacks created as resources for another stack--the stack ID // of the direct parent of this stack. For the first level of nested stacks, the // root stack is also the parent stack. For more information, see Working with - // Nested Stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. ParentId *string // For nested stacks--stacks created as resources for another stack--the stack ID // of the top-level stack to which the nested stack ultimately belongs. For more - // information, see Working with Nested Stacks - // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) + // information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the CloudFormation User Guide. RootId *string @@ -2205,7 +2004,7 @@ type Tag struct { // Required. A string used to identify this tag. You can specify a maximum of 128 // characters for a tag key. Tags owned by Amazon Web Services (Amazon Web - // Services) have the reserved prefix: aws:. + // Services) have the reserved prefix: aws: . // // This member is required. Key *string @@ -2240,8 +2039,7 @@ type TemplateParameter struct { // Detailed information concerning the specification of a CloudFormation extension // in a given account and region. For more information, see Configuring extensions -// at the account level -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) +// at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. type TypeConfigurationDetails struct { @@ -2255,7 +2053,7 @@ type TypeConfigurationDetails struct { // A JSON string specifying the configuration data for the extension, in this // account and region. If a configuration hasn't been set for a specified - // extension, CloudFormation returns {}. + // extension, CloudFormation returns {} . Configuration *string // Whether this configuration data is the default configuration for the extension. @@ -2263,15 +2061,13 @@ type TypeConfigurationDetails struct { // When the configuration data was last updated for this extension. If a // configuration hasn't been set for a specified extension, CloudFormation returns - // null. + // null . LastUpdated *time.Time // The Amazon Resource Name (ARN) for the extension, in this account and region. - // For public extensions, this will be the ARN assigned when you activate the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // For public extensions, this will be the ARN assigned when you activate the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) // in this account and region. For private extensions, this will be the ARN - // assigned when you register the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) // in this account and region. TypeArn *string @@ -2288,11 +2084,9 @@ type TypeConfigurationIdentifier struct { Type ThirdPartyType // The Amazon Resource Name (ARN) for the extension, in this account and region. - // For public extensions, this will be the ARN assigned when you activate the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // For public extensions, this will be the ARN assigned when you activate the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) // in this account and region. For private extensions, this will be the ARN - // assigned when you register the type - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) // in this account and region. TypeArn *string @@ -2314,24 +2108,16 @@ type TypeConfigurationIdentifier struct { type TypeFilters struct { // The category of extensions to return. - // - // * REGISTERED: Private extensions that - // have been registered for this account and region. - // - // * ACTIVATED: Public - // extensions that have been activated for this account and region. - // - // * THIRD_PARTY: - // Extensions available for use from publishers other than Amazon. This - // includes: - // - // * Private extensions registered in the account. - // - // * Public extensions - // from publishers other than Amazon, whether activated or not. - // - // * AWS_TYPES: - // Extensions available for use from Amazon. + // - REGISTERED : Private extensions that have been registered for this account + // and region. + // - ACTIVATED : Public extensions that have been activated for this account and + // region. + // - THIRD_PARTY : Extensions available for use from publishers other than + // Amazon. This includes: + // - Private extensions registered in the account. + // - Public extensions from publishers other than Amazon, whether activated or + // not. + // - AWS_TYPES : Extensions available for use from Amazon. Category Category // The id of the publisher of the extension. Extensions published by Amazon aren't @@ -2348,13 +2134,12 @@ type TypeFilters struct { // Contains summary information about the specified CloudFormation extension. type TypeSummary struct { - // The ID of the default version of the extension. The default version is used when - // the extension version isn't specified. This applies only to private extensions - // you have registered in your account. For public extensions, both those provided - // by Amazon and published by third parties, CloudFormation returns null. For more - // information, see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). - // To set the default version of an extension, use SetTypeDefaultVersion. + // The ID of the default version of the extension. The default version is used + // when the extension version isn't specified. This applies only to private + // extensions you have registered in your account. For public extensions, both + // those provided by Amazon and published by third parties, CloudFormation returns + // null . For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . To set the default version of an extension, use SetTypeDefaultVersion . DefaultVersionId *string // The description of the extension. @@ -2366,29 +2151,22 @@ type TypeSummary struct { IsActivated *bool // When the specified extension version was registered. This applies only to: - // - // * - // Private extensions you have registered in your account. For more information, - // see RegisterType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). - // - // * - // Public extensions you have activated in your account with auto-update specified. - // For more information, see ActivateType - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). - // - // For - // all other extension types, CloudFormation returns null. + // - Private extensions you have registered in your account. For more + // information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) + // . + // - Public extensions you have activated in your account with auto-update + // specified. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // . + // For all other extension types, CloudFormation returns null . LastUpdated *time.Time // For public extensions that have been activated for this account and region, the // latest version of the public extension that is available. For any extensions - // other than activated third-arty extensions, CloudFormation returns null. How you - // specified AutoUpdate when enabling the extension affects whether CloudFormation - // automatically updates the extension in this account and region when a new - // version is released. For more information, see Setting CloudFormation to - // automatically use new versions of extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) + // other than activated third-arty extensions, CloudFormation returns null . How + // you specified AutoUpdate when enabling the extension affects whether + // CloudFormation automatically updates the extension in this account and region + // when a new version is released. For more information, see Setting + // CloudFormation to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) // in the CloudFormation User Guide. LatestPublicVersion *string @@ -2397,8 +2175,7 @@ type TypeSummary struct { // enabling the extension in this account and region, CloudFormation treats that // alias as the extension's type name within the account and region, not the type // name of the public extension. For more information, see Specifying aliases to - // refer to extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) + // refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) // in the CloudFormation User Guide. OriginalTypeName *string @@ -2407,8 +2184,7 @@ type TypeSummary struct { // account and Region. How you specified AutoUpdate when enabling the extension // affects whether CloudFormation automatically updates the extension in this // account and region when a new version is released. For more information, see - // Setting CloudFormation to automatically use new versions of extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) + // Setting CloudFormation to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) // in the CloudFormation User Guide. PublicVersionNumber *string @@ -2417,8 +2193,7 @@ type TypeSummary struct { PublisherId *string // The service used to verify the publisher identity. For more information, see - // Registering your account to publish CloudFormation extensions - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) + // Registering your account to publish CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) // in the CFN-CLI User Guide for Extension Development. PublisherIdentity IdentityProvider @@ -2433,8 +2208,7 @@ type TypeSummary struct { TypeArn *string // The name of the extension. If you specified a TypeNameAlias when you activate - // this extension - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) + // this extension (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) // in your account and region, CloudFormation considers that alias as the type // name. TypeName *string @@ -2455,18 +2229,17 @@ type TypeVersionSummary struct { // Whether the specified extension version is set as the default version. This // applies only to private extensions you have registered in your account, and // extensions published by Amazon. For public third-party extensions, - // CloudFormation returns null. + // CloudFormation returns null . IsDefaultVersion *bool // For public extensions that have been activated for this account and region, the // version of the public extension to be used for CloudFormation operations in this // account and region. For any extensions other than activated third-arty - // extensions, CloudFormation returns null. How you specified AutoUpdate when + // extensions, CloudFormation returns null . How you specified AutoUpdate when // enabling the extension affects whether CloudFormation automatically updates the // extension in this account and region when a new version is released. For more // information, see Setting CloudFormation to automatically use new versions of - // extensions - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) + // extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) // in the CloudFormation User Guide. PublicVersionNumber *string diff --git a/service/cloudfront/api_client.go b/service/cloudfront/api_client.go index b5d3e14d705..91165fa38ea 100644 --- a/service/cloudfront/api_client.go +++ b/service/cloudfront/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudfront/api_op_AssociateAlias.go b/service/cloudfront/api_op_AssociateAlias.go index e346079c98e..34a2a7cbb8d 100644 --- a/service/cloudfront/api_op_AssociateAlias.go +++ b/service/cloudfront/api_op_AssociateAlias.go @@ -19,8 +19,7 @@ import ( // alias and the ID of the target distribution for the alias. For more information, // including how to set up the target distribution, prerequisites that you must // complete, and other restrictions, see Moving an alternate domain name to a -// different distribution -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move) +// different distribution (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move) // in the Amazon CloudFront Developer Guide. func (c *Client) AssociateAlias(ctx context.Context, params *AssociateAliasInput, optFns ...func(*Options)) (*AssociateAliasOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CopyDistribution.go b/service/cloudfront/api_op_CopyDistribution.go index 2a14c7f2920..91904677e70 100644 --- a/service/cloudfront/api_op_CopyDistribution.go +++ b/service/cloudfront/api_op_CopyDistribution.go @@ -43,18 +43,18 @@ type CopyDistributionInput struct { CallerReference *string // The identifier of the primary distribution whose configuration you are copying. - // To get a distribution ID, use ListDistributions. + // To get a distribution ID, use ListDistributions . // // This member is required. PrimaryDistributionId *string // The version identifier of the primary distribution whose configuration you are // copying. This is the ETag value returned in the response to GetDistribution and - // GetDistributionConfig. + // GetDistributionConfig . IfMatch *string // The type of distribution that your primary distribution will be copied to. The - // only valid value is True, indicating that you are copying to a staging + // only valid value is True , indicating that you are copying to a staging // distribution. Staging *bool @@ -63,8 +63,8 @@ type CopyDistributionInput struct { type CopyDistributionOutput struct { - // A distribution tells CloudFront where you want content to be delivered from, and - // the details about how to track and manage content delivery. + // A distribution tells CloudFront where you want content to be delivered from, + // and the details about how to track and manage content delivery. Distribution *types.Distribution // The version identifier for the current version of the staging distribution. diff --git a/service/cloudfront/api_op_CreateCachePolicy.go b/service/cloudfront/api_op_CreateCachePolicy.go index 91aa501fa61..5edc601bbe4 100644 --- a/service/cloudfront/api_op_CreateCachePolicy.go +++ b/service/cloudfront/api_op_CreateCachePolicy.go @@ -14,23 +14,18 @@ import ( // Creates a cache policy. After you create a cache policy, you can attach it to // one or more cache behaviors. When it's attached to a cache behavior, the cache // policy determines the following: +// - The values that CloudFront includes in the cache key. These values can +// include HTTP headers, cookies, and URL query strings. CloudFront uses the cache +// key to find an object in its cache that it can return to the viewer. +// - The default, minimum, and maximum time to live (TTL) values that you want +// objects to stay in the CloudFront cache. // -// * The values that CloudFront includes in the -// cache key. These values can include HTTP headers, cookies, and URL query -// strings. CloudFront uses the cache key to find an object in its cache that it -// can return to the viewer. -// -// * The default, minimum, and maximum time to live -// (TTL) values that you want objects to stay in the CloudFront cache. -// -// The -// headers, cookies, and query strings that are included in the cache key are also -// included in requests that CloudFront sends to the origin. CloudFront sends a -// request when it can't find an object in its cache that matches the request's +// The headers, cookies, and query strings that are included in the cache key are +// also included in requests that CloudFront sends to the origin. CloudFront sends +// a request when it can't find an object in its cache that matches the request's // cache key. If you want to send values to the origin but not include them in the -// cache key, use OriginRequestPolicy. For more information about cache policies, -// see Controlling the cache key -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) +// cache key, use OriginRequestPolicy . For more information about cache policies, +// see Controlling the cache key (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateCachePolicy(ctx context.Context, params *CreateCachePolicyInput, optFns ...func(*Options)) (*CreateCachePolicyOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go index 51ce268aa11..c1ca170d8a7 100644 --- a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new origin access identity. If you're using Amazon S3 for your origin, -// you can use an origin access identity to require users to access your content -// using a CloudFront URL instead of the Amazon S3 URL. For more information about -// how to use origin access identities, see Serving Private Content through -// CloudFront -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// Creates a new origin access identity. If you're using Amazon S3 for your +// origin, you can use an origin access identity to require users to access your +// content using a CloudFront URL instead of the Amazon S3 URL. For more +// information about how to use origin access identities, see Serving Private +// Content through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateCloudFrontOriginAccessIdentity(ctx context.Context, params *CreateCloudFrontOriginAccessIdentityInput, optFns ...func(*Options)) (*CreateCloudFrontOriginAccessIdentityOutput, error) { if params == nil { @@ -36,9 +35,8 @@ func (c *Client) CreateCloudFrontOriginAccessIdentity(ctx context.Context, param // The request to create a new origin access identity (OAI). An origin access // identity is a special CloudFront user that you can associate with Amazon S3 // origins, so that you can secure all or just some of your Amazon S3 content. For -// more information, see Restricting Access to Amazon S3 Content by Using an -// Origin Access Identity -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) +// more information, see Restricting Access to Amazon S3 Content by Using an +// Origin Access Identity (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) // in the Amazon CloudFront Developer Guide. type CreateCloudFrontOriginAccessIdentityInput struct { diff --git a/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go b/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go index 73bdb0afd16..da0c4314f16 100644 --- a/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go +++ b/service/cloudfront/api_op_CreateFieldLevelEncryptionConfig.go @@ -40,7 +40,7 @@ type CreateFieldLevelEncryptionConfigInput struct { type CreateFieldLevelEncryptionConfigOutput struct { // The current version of the field level encryption configuration. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Returned when you create a new field-level encryption configuration. diff --git a/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go index 07d21357c66..371ed1a5b70 100644 --- a/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_CreateFieldLevelEncryptionProfile.go @@ -40,7 +40,7 @@ type CreateFieldLevelEncryptionProfileInput struct { type CreateFieldLevelEncryptionProfileOutput struct { // The current version of the field level encryption profile. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Returned when you create a new field-level encryption profile. diff --git a/service/cloudfront/api_op_CreateFunction.go b/service/cloudfront/api_op_CreateFunction.go index 67236bf09c8..3e93946da92 100644 --- a/service/cloudfront/api_op_CreateFunction.go +++ b/service/cloudfront/api_op_CreateFunction.go @@ -15,9 +15,9 @@ import ( // code and some configuration information about the function. The response // contains an Amazon Resource Name (ARN) that uniquely identifies the function. // When you create a function, it's in the DEVELOPMENT stage. In this stage, you -// can test the function with TestFunction, and update it with UpdateFunction. When -// you're ready to use your function with a CloudFront distribution, use -// PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When +// can test the function with TestFunction , and update it with UpdateFunction . +// When you're ready to use your function with a CloudFront distribution, use +// PublishFunction to copy the function from the DEVELOPMENT stage to LIVE . When // it's live, you can attach the function to a distribution's cache behavior, using // the function's ARN. func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error) { @@ -37,9 +37,8 @@ func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput type CreateFunctionInput struct { - // The function code. For more information about writing a CloudFront function, see - // Writing function code for CloudFront Functions - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) + // The function code. For more information about writing a CloudFront function, + // see Writing function code for CloudFront Functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) // in the Amazon CloudFront Developer Guide. // // This member is required. diff --git a/service/cloudfront/api_op_CreateInvalidation.go b/service/cloudfront/api_op_CreateInvalidation.go index 34070e946b8..a31bdc6662a 100644 --- a/service/cloudfront/api_op_CreateInvalidation.go +++ b/service/cloudfront/api_op_CreateInvalidation.go @@ -50,7 +50,7 @@ type CreateInvalidationOutput struct { Invalidation *types.Invalidation // The fully qualified URI of the distribution and invalidation batch request, - // including the Invalidation ID. + // including the Invalidation ID . Location *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_CreateKeyGroup.go b/service/cloudfront/api_op_CreateKeyGroup.go index 71c12a9f588..f1bd1a2b9a5 100644 --- a/service/cloudfront/api_op_CreateKeyGroup.go +++ b/service/cloudfront/api_op_CreateKeyGroup.go @@ -12,17 +12,15 @@ import ( ) // Creates a key group that you can use with CloudFront signed URLs and signed -// cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html). -// To create a key group, you must specify at least one public key for the key +// cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// . To create a key group, you must specify at least one public key for the key // group. After you create a key group, you can reference it from one or more cache // behaviors. When you reference a key group in a cache behavior, CloudFront // requires signed URLs or signed cookies for all requests that match the cache // behavior. The URLs or cookies must be signed with a private key whose // corresponding public key is in the key group. The signed URL or cookie contains // information about which public key CloudFront should use to verify the -// signature. For more information, see Serving private content -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// signature. For more information, see Serving private content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateKeyGroup(ctx context.Context, params *CreateKeyGroupInput, optFns ...func(*Options)) (*CreateKeyGroupOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CreateMonitoringSubscription.go b/service/cloudfront/api_op_CreateMonitoringSubscription.go index fd7d7f8cd4b..d2aee40fd7f 100644 --- a/service/cloudfront/api_op_CreateMonitoringSubscription.go +++ b/service/cloudfront/api_op_CreateMonitoringSubscription.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables additional CloudWatch metrics for the specified CloudFront distribution. -// The additional metrics incur an additional cost. For more information, see -// Viewing additional CloudFront distribution metrics -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional) +// Enables additional CloudWatch metrics for the specified CloudFront +// distribution. The additional metrics incur an additional cost. For more +// information, see Viewing additional CloudFront distribution metrics (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateMonitoringSubscription(ctx context.Context, params *CreateMonitoringSubscriptionInput, optFns ...func(*Options)) (*CreateMonitoringSubscriptionOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CreateOriginAccessControl.go b/service/cloudfront/api_op_CreateOriginAccessControl.go index 61b3436901c..83d0457841a 100644 --- a/service/cloudfront/api_op_CreateOriginAccessControl.go +++ b/service/cloudfront/api_op_CreateOriginAccessControl.go @@ -17,8 +17,7 @@ import ( // possible to block public access to the origin, allowing viewers (users) to // access the origin's content only through CloudFront. For more information about // using a CloudFront origin access control, see Restricting access to an Amazon -// Web Services origin -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) +// Web Services origin (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateOriginAccessControl(ctx context.Context, params *CreateOriginAccessControlInput, optFns ...func(*Options)) (*CreateOriginAccessControlOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CreateOriginRequestPolicy.go b/service/cloudfront/api_op_CreateOriginRequestPolicy.go index 8d885c3f337..1f5c109dedc 100644 --- a/service/cloudfront/api_op_CreateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_CreateOriginRequestPolicy.go @@ -11,30 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an origin request policy. After you create an origin request policy, you -// can attach it to one or more cache behaviors. When it's attached to a cache +// Creates an origin request policy. After you create an origin request policy, +// you can attach it to one or more cache behaviors. When it's attached to a cache // behavior, the origin request policy determines the values that CloudFront // includes in requests that it sends to the origin. Each request that CloudFront // sends to the origin includes the following: +// - The request body and the URL path (without the domain name) from the viewer +// request. +// - The headers that CloudFront automatically includes in every origin request, +// including Host , User-Agent , and X-Amz-Cf-Id . +// - All HTTP headers, cookies, and URL query strings that are specified in the +// cache policy or the origin request policy. These can include items from the +// viewer request and, in the case of headers, additional ones that are added by +// CloudFront. // -// * The request body and the URL path -// (without the domain name) from the viewer request. -// -// * The headers that -// CloudFront automatically includes in every origin request, including Host, -// User-Agent, and X-Amz-Cf-Id. -// -// * All HTTP headers, cookies, and URL query strings -// that are specified in the cache policy or the origin request policy. These can -// include items from the viewer request and, in the case of headers, additional -// ones that are added by CloudFront. -// -// CloudFront sends a request when it can't -// find a valid object in its cache that matches the request. If you want to send -// values to the origin and also include them in the cache key, use CachePolicy. -// For more information about origin request policies, see Controlling origin -// requests -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html) +// CloudFront sends a request when it can't find a valid object in its cache that +// matches the request. If you want to send values to the origin and also include +// them in the cache key, use CachePolicy . For more information about origin +// request policies, see Controlling origin requests (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateOriginRequestPolicy(ctx context.Context, params *CreateOriginRequestPolicyInput, optFns ...func(*Options)) (*CreateOriginRequestPolicyOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_CreatePublicKey.go b/service/cloudfront/api_op_CreatePublicKey.go index 9266ba41c97..515ec870ca2 100644 --- a/service/cloudfront/api_op_CreatePublicKey.go +++ b/service/cloudfront/api_op_CreatePublicKey.go @@ -12,10 +12,9 @@ import ( ) // Uploads a public key to CloudFront that you can use with signed URLs and signed -// cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), -// or with field-level encryption -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). +// cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) +// . func (c *Client) CreatePublicKey(ctx context.Context, params *CreatePublicKeyInput, optFns ...func(*Options)) (*CreatePublicKeyOutput, error) { if params == nil { params = &CreatePublicKeyInput{} diff --git a/service/cloudfront/api_op_CreateRealtimeLogConfig.go b/service/cloudfront/api_op_CreateRealtimeLogConfig.go index 34d6982e267..04509193278 100644 --- a/service/cloudfront/api_op_CreateRealtimeLogConfig.go +++ b/service/cloudfront/api_op_CreateRealtimeLogConfig.go @@ -14,8 +14,7 @@ import ( // Creates a real-time log configuration. After you create a real-time log // configuration, you can attach it to one or more cache behaviors to send // real-time log data to the specified Amazon Kinesis data stream. For more -// information about real-time log configurations, see Real-time logs -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) +// information about real-time log configurations, see Real-time logs (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateRealtimeLogConfig(ctx context.Context, params *CreateRealtimeLogConfigInput, optFns ...func(*Options)) (*CreateRealtimeLogConfigOutput, error) { if params == nil { @@ -41,8 +40,7 @@ type CreateRealtimeLogConfigInput struct { EndPoints []types.EndPoint // A list of fields to include in each real-time log record. For more information - // about fields, see Real-time log configuration fields - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) + // about fields, see Real-time log configuration fields (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) // in the Amazon CloudFront Developer Guide. // // This member is required. diff --git a/service/cloudfront/api_op_CreateResponseHeadersPolicy.go b/service/cloudfront/api_op_CreateResponseHeadersPolicy.go index d72a1d299d4..8f0eb0255cc 100644 --- a/service/cloudfront/api_op_CreateResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_CreateResponseHeadersPolicy.go @@ -20,8 +20,7 @@ import ( // HTTP headers that CloudFront includes in HTTP responses to requests that match // the cache behavior. CloudFront adds or removes response headers according to the // configuration of the response headers policy. For more information, see Adding -// or removing HTTP headers in CloudFront responses -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) +// or removing HTTP headers in CloudFront responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) // in the Amazon CloudFront Developer Guide. func (c *Client) CreateResponseHeadersPolicy(ctx context.Context, params *CreateResponseHeadersPolicyInput, optFns ...func(*Options)) (*CreateResponseHeadersPolicyOutput, error) { if params == nil { @@ -40,8 +39,8 @@ func (c *Client) CreateResponseHeadersPolicy(ctx context.Context, params *Create type CreateResponseHeadersPolicyInput struct { - // Contains metadata about the response headers policy, and a set of configurations - // that specify the HTTP headers. + // Contains metadata about the response headers policy, and a set of + // configurations that specify the HTTP headers. // // This member is required. ResponseHeadersPolicyConfig *types.ResponseHeadersPolicyConfig diff --git a/service/cloudfront/api_op_DeleteCachePolicy.go b/service/cloudfront/api_op_DeleteCachePolicy.go index 280d5641ef5..4082aec82d0 100644 --- a/service/cloudfront/api_op_DeleteCachePolicy.go +++ b/service/cloudfront/api_op_DeleteCachePolicy.go @@ -14,7 +14,7 @@ import ( // cache behavior. First update your distributions to remove the cache policy from // all cache behaviors, then delete the cache policy. To delete a cache policy, you // must provide the policy's identifier and version. To get these values, you can -// use ListCachePolicies or GetCachePolicy. +// use ListCachePolicies or GetCachePolicy . func (c *Client) DeleteCachePolicy(ctx context.Context, params *DeleteCachePolicyInput, optFns ...func(*Options)) (*DeleteCachePolicyOutput, error) { if params == nil { params = &DeleteCachePolicyInput{} @@ -33,14 +33,14 @@ func (c *Client) DeleteCachePolicy(ctx context.Context, params *DeleteCachePolic type DeleteCachePolicyInput struct { // The unique identifier for the cache policy that you are deleting. To get the - // identifier, you can use ListCachePolicies. + // identifier, you can use ListCachePolicies . // // This member is required. Id *string // The version of the cache policy that you are deleting. The version is the cache - // policy's ETag value, which you can get using ListCachePolicies, GetCachePolicy, - // or GetCachePolicyConfig. + // policy's ETag value, which you can get using ListCachePolicies , GetCachePolicy + // , or GetCachePolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go index 85e787bebaf..1910f50081f 100644 --- a/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_DeleteCloudFrontOriginAccessIdentity.go @@ -35,7 +35,7 @@ type DeleteCloudFrontOriginAccessIdentityInput struct { Id *string // The value of the ETag header you received from a previous GET or PUT request. - // For example: E2QWRUHAPOMQZL. + // For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go b/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go index c61d4a46269..becf3459dc1 100644 --- a/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go @@ -36,7 +36,7 @@ type DeleteContinuousDeploymentPolicyInput struct { // This member is required. Id *string - // The current version (ETag value) of the continuous deployment policy that you + // The current version ( ETag value) of the continuous deployment policy that you // are deleting. IfMatch *string diff --git a/service/cloudfront/api_op_DeleteDistribution.go b/service/cloudfront/api_op_DeleteDistribution.go index c7ca77aa036..4f92559562c 100644 --- a/service/cloudfront/api_op_DeleteDistribution.go +++ b/service/cloudfront/api_op_DeleteDistribution.go @@ -29,42 +29,28 @@ func (c *Client) DeleteDistribution(ctx context.Context, params *DeleteDistribut // This action deletes a web distribution. To delete a web distribution using the // CloudFront API, perform the following steps. To delete a web distribution using // the CloudFront API: +// - Disable the web distribution +// - Submit a GET Distribution Config request to get the current configuration +// and the Etag header for the distribution. +// - Update the XML document that was returned in the response to your GET +// Distribution Config request to change the value of Enabled to false . +// - Submit a PUT Distribution Config request to update the configuration for +// your distribution. In the request body, include the XML document that you +// updated in Step 3. Set the value of the HTTP If-Match header to the value of +// the ETag header that CloudFront returned when you submitted the GET +// Distribution Config request in Step 2. +// - Review the response to the PUT Distribution Config request to confirm that +// the distribution was successfully disabled. +// - Submit a GET Distribution request to confirm that your changes have +// propagated. When propagation is complete, the value of Status is Deployed . +// - Submit a DELETE Distribution request. Set the value of the HTTP If-Match +// header to the value of the ETag header that CloudFront returned when you +// submitted the GET Distribution Config request in Step 6. +// - Review the response to your DELETE Distribution request to confirm that the +// distribution was successfully deleted. // -// * Disable the web distribution -// -// * Submit a GET Distribution -// Config request to get the current configuration and the Etag header for the -// distribution. -// -// * Update the XML document that was returned in the response to -// your GET Distribution Config request to change the value of Enabled to false. -// -// * -// Submit a PUT Distribution Config request to update the configuration for your -// distribution. In the request body, include the XML document that you updated in -// Step 3. Set the value of the HTTP If-Match header to the value of the ETag -// header that CloudFront returned when you submitted the GET Distribution Config -// request in Step 2. -// -// * Review the response to the PUT Distribution Config request -// to confirm that the distribution was successfully disabled. -// -// * Submit a GET -// Distribution request to confirm that your changes have propagated. When -// propagation is complete, the value of Status is Deployed. -// -// * Submit a DELETE -// Distribution request. Set the value of the HTTP If-Match header to the value of -// the ETag header that CloudFront returned when you submitted the GET Distribution -// Config request in Step 6. -// -// * Review the response to your DELETE Distribution -// request to confirm that the distribution was successfully deleted. -// -// For -// information about deleting a distribution using the CloudFront console, see -// Deleting a Distribution -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html) +// For information about deleting a distribution using the CloudFront console, see +// Deleting a Distribution (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html) // in the Amazon CloudFront Developer Guide. type DeleteDistributionInput struct { @@ -74,7 +60,7 @@ type DeleteDistributionInput struct { Id *string // The value of the ETag header that you received when you disabled the - // distribution. For example: E2QWRUHAPOMQZL. + // distribution. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteFieldLevelEncryptionConfig.go b/service/cloudfront/api_op_DeleteFieldLevelEncryptionConfig.go index fd26d3136ca..f1851c52392 100644 --- a/service/cloudfront/api_op_DeleteFieldLevelEncryptionConfig.go +++ b/service/cloudfront/api_op_DeleteFieldLevelEncryptionConfig.go @@ -33,8 +33,8 @@ type DeleteFieldLevelEncryptionConfigInput struct { // This member is required. Id *string - // The value of the ETag header that you received when retrieving the configuration - // identity to delete. For example: E2QWRUHAPOMQZL. + // The value of the ETag header that you received when retrieving the + // configuration identity to delete. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go index 5549b6901ad..411a03c3167 100644 --- a/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_DeleteFieldLevelEncryptionProfile.go @@ -34,7 +34,7 @@ type DeleteFieldLevelEncryptionProfileInput struct { Id *string // The value of the ETag header that you received when retrieving the profile to - // delete. For example: E2QWRUHAPOMQZL. + // delete. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteFunction.go b/service/cloudfront/api_op_DeleteFunction.go index b60cbc5f4c6..fc302382216 100644 --- a/service/cloudfront/api_op_DeleteFunction.go +++ b/service/cloudfront/api_op_DeleteFunction.go @@ -13,8 +13,8 @@ import ( // Deletes a CloudFront function. You cannot delete a function if it's associated // with a cache behavior. First, update your distributions to remove the function // association from all cache behaviors, then delete the function. To delete a -// function, you must provide the function's name and version (ETag value). To get -// these values, you can use ListFunctions and DescribeFunction. +// function, you must provide the function's name and version ( ETag value). To +// get these values, you can use ListFunctions and DescribeFunction . func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error) { if params == nil { params = &DeleteFunctionInput{} @@ -32,8 +32,8 @@ func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput type DeleteFunctionInput struct { - // The current version (ETag value) of the function that you are deleting, which - // you can get using DescribeFunction. + // The current version ( ETag value) of the function that you are deleting, which + // you can get using DescribeFunction . // // This member is required. IfMatch *string diff --git a/service/cloudfront/api_op_DeleteKeyGroup.go b/service/cloudfront/api_op_DeleteKeyGroup.go index fb1dbf0dcaa..e8e2dc15aac 100644 --- a/service/cloudfront/api_op_DeleteKeyGroup.go +++ b/service/cloudfront/api_op_DeleteKeyGroup.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a key group. You cannot delete a key group that is referenced in a cache -// behavior. First update your distributions to remove the key group from all cache -// behaviors, then delete the key group. To delete a key group, you must provide -// the key group's identifier and version. To get these values, use ListKeyGroups -// followed by GetKeyGroup or GetKeyGroupConfig. +// Deletes a key group. You cannot delete a key group that is referenced in a +// cache behavior. First update your distributions to remove the key group from all +// cache behaviors, then delete the key group. To delete a key group, you must +// provide the key group's identifier and version. To get these values, use +// ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig . func (c *Client) DeleteKeyGroup(ctx context.Context, params *DeleteKeyGroupInput, optFns ...func(*Options)) (*DeleteKeyGroupOutput, error) { if params == nil { params = &DeleteKeyGroupInput{} @@ -33,13 +33,13 @@ func (c *Client) DeleteKeyGroup(ctx context.Context, params *DeleteKeyGroupInput type DeleteKeyGroupInput struct { // The identifier of the key group that you are deleting. To get the identifier, - // use ListKeyGroups. + // use ListKeyGroups . // // This member is required. Id *string // The version of the key group that you are deleting. The version is the key - // group's ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig. + // group's ETag value. To get the ETag , use GetKeyGroup or GetKeyGroupConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteOriginAccessControl.go b/service/cloudfront/api_op_DeleteOriginAccessControl.go index 90c2cb3d34f..893bf5ce675 100644 --- a/service/cloudfront/api_op_DeleteOriginAccessControl.go +++ b/service/cloudfront/api_op_DeleteOriginAccessControl.go @@ -35,7 +35,7 @@ type DeleteOriginAccessControlInput struct { // This member is required. Id *string - // The current version (ETag value) of the origin access control that you are + // The current version ( ETag value) of the origin access control that you are // deleting. IfMatch *string diff --git a/service/cloudfront/api_op_DeleteOriginRequestPolicy.go b/service/cloudfront/api_op_DeleteOriginRequestPolicy.go index 8ca31b41d74..7832241912e 100644 --- a/service/cloudfront/api_op_DeleteOriginRequestPolicy.go +++ b/service/cloudfront/api_op_DeleteOriginRequestPolicy.go @@ -15,7 +15,7 @@ import ( // the origin request policy from all cache behaviors, then delete the origin // request policy. To delete an origin request policy, you must provide the // policy's identifier and version. To get the identifier, you can use -// ListOriginRequestPolicies or GetOriginRequestPolicy. +// ListOriginRequestPolicies or GetOriginRequestPolicy . func (c *Client) DeleteOriginRequestPolicy(ctx context.Context, params *DeleteOriginRequestPolicyInput, optFns ...func(*Options)) (*DeleteOriginRequestPolicyOutput, error) { if params == nil { params = &DeleteOriginRequestPolicyInput{} @@ -34,15 +34,15 @@ func (c *Client) DeleteOriginRequestPolicy(ctx context.Context, params *DeleteOr type DeleteOriginRequestPolicyInput struct { // The unique identifier for the origin request policy that you are deleting. To - // get the identifier, you can use ListOriginRequestPolicies. + // get the identifier, you can use ListOriginRequestPolicies . // // This member is required. Id *string // The version of the origin request policy that you are deleting. The version is // the origin request policy's ETag value, which you can get using - // ListOriginRequestPolicies, GetOriginRequestPolicy, or - // GetOriginRequestPolicyConfig. + // ListOriginRequestPolicies , GetOriginRequestPolicy , or + // GetOriginRequestPolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeletePublicKey.go b/service/cloudfront/api_op_DeletePublicKey.go index eaa9041136f..27414856f0e 100644 --- a/service/cloudfront/api_op_DeletePublicKey.go +++ b/service/cloudfront/api_op_DeletePublicKey.go @@ -34,7 +34,7 @@ type DeletePublicKeyInput struct { Id *string // The value of the ETag header that you received when retrieving the public key - // identity to delete. For example: E2QWRUHAPOMQZL. + // identity to delete. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go b/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go index af052bd76ca..04b3c021975 100644 --- a/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go @@ -15,7 +15,7 @@ import ( // the response headers policy from all cache behaviors, then delete the response // headers policy. To delete a response headers policy, you must provide the // policy's identifier and version. To get these values, you can use -// ListResponseHeadersPolicies or GetResponseHeadersPolicy. +// ListResponseHeadersPolicies or GetResponseHeadersPolicy . func (c *Client) DeleteResponseHeadersPolicy(ctx context.Context, params *DeleteResponseHeadersPolicyInput, optFns ...func(*Options)) (*DeleteResponseHeadersPolicyOutput, error) { if params == nil { params = &DeleteResponseHeadersPolicyInput{} @@ -33,16 +33,16 @@ func (c *Client) DeleteResponseHeadersPolicy(ctx context.Context, params *Delete type DeleteResponseHeadersPolicyInput struct { - // The identifier for the response headers policy that you are deleting. To get the - // identifier, you can use ListResponseHeadersPolicies. + // The identifier for the response headers policy that you are deleting. To get + // the identifier, you can use ListResponseHeadersPolicies . // // This member is required. Id *string - // The version of the response headers policy that you are deleting. The version is - // the response headers policy's ETag value, which you can get using - // ListResponseHeadersPolicies, GetResponseHeadersPolicy, or - // GetResponseHeadersPolicyConfig. + // The version of the response headers policy that you are deleting. The version + // is the response headers policy's ETag value, which you can get using + // ListResponseHeadersPolicies , GetResponseHeadersPolicy , or + // GetResponseHeadersPolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DeleteStreamingDistribution.go b/service/cloudfront/api_op_DeleteStreamingDistribution.go index 5b33f617a0e..94112bd87af 100644 --- a/service/cloudfront/api_op_DeleteStreamingDistribution.go +++ b/service/cloudfront/api_op_DeleteStreamingDistribution.go @@ -13,43 +13,30 @@ import ( // Delete a streaming distribution. To delete an RTMP distribution using the // CloudFront API, perform the following steps. To delete an RTMP distribution // using the CloudFront API: +// - Disable the RTMP distribution. +// - Submit a GET Streaming Distribution Config request to get the current +// configuration and the Etag header for the distribution. +// - Update the XML document that was returned in the response to your GET +// Streaming Distribution Config request to change the value of Enabled to false +// . +// - Submit a PUT Streaming Distribution Config request to update the +// configuration for your distribution. In the request body, include the XML +// document that you updated in Step 3. Then set the value of the HTTP If-Match +// header to the value of the ETag header that CloudFront returned when you +// submitted the GET Streaming Distribution Config request in Step 2. +// - Review the response to the PUT Streaming Distribution Config request to +// confirm that the distribution was successfully disabled. +// - Submit a GET Streaming Distribution Config request to confirm that your +// changes have propagated. When propagation is complete, the value of Status is +// Deployed . +// - Submit a DELETE Streaming Distribution request. Set the value of the HTTP +// If-Match header to the value of the ETag header that CloudFront returned when +// you submitted the GET Streaming Distribution Config request in Step 2. +// - Review the response to your DELETE Streaming Distribution request to confirm +// that the distribution was successfully deleted. // -// * Disable the RTMP distribution. -// -// * Submit a GET -// Streaming Distribution Config request to get the current configuration and the -// Etag header for the distribution. -// -// * Update the XML document that was returned -// in the response to your GET Streaming Distribution Config request to change the -// value of Enabled to false. -// -// * Submit a PUT Streaming Distribution Config request -// to update the configuration for your distribution. In the request body, include -// the XML document that you updated in Step 3. Then set the value of the HTTP -// If-Match header to the value of the ETag header that CloudFront returned when -// you submitted the GET Streaming Distribution Config request in Step 2. -// -// * Review -// the response to the PUT Streaming Distribution Config request to confirm that -// the distribution was successfully disabled. -// -// * Submit a GET Streaming -// Distribution Config request to confirm that your changes have propagated. When -// propagation is complete, the value of Status is Deployed. -// -// * Submit a DELETE -// Streaming Distribution request. Set the value of the HTTP If-Match header to the -// value of the ETag header that CloudFront returned when you submitted the GET -// Streaming Distribution Config request in Step 2. -// -// * Review the response to your -// DELETE Streaming Distribution request to confirm that the distribution was -// successfully deleted. -// -// For information about deleting a distribution using the -// CloudFront console, see Deleting a Distribution -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html) +// For information about deleting a distribution using the CloudFront console, see +// Deleting a Distribution (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html) // in the Amazon CloudFront Developer Guide. func (c *Client) DeleteStreamingDistribution(ctx context.Context, params *DeleteStreamingDistributionInput, optFns ...func(*Options)) (*DeleteStreamingDistributionOutput, error) { if params == nil { @@ -75,7 +62,7 @@ type DeleteStreamingDistributionInput struct { Id *string // The value of the ETag header that you received when you disabled the streaming - // distribution. For example: E2QWRUHAPOMQZL. + // distribution. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_DescribeFunction.go b/service/cloudfront/api_op_DescribeFunction.go index 35510ae5874..cb5e2ccb081 100644 --- a/service/cloudfront/api_op_DescribeFunction.go +++ b/service/cloudfront/api_op_DescribeFunction.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets configuration information and metadata about a CloudFront function, but not -// the function's code. To get a function's code, use GetFunction. To get +// Gets configuration information and metadata about a CloudFront function, but +// not the function's code. To get a function's code, use GetFunction . To get // configuration information and metadata about a function, you must provide the -// function's name and stage. To get these values, you can use ListFunctions. +// function's name and stage. To get these values, you can use ListFunctions . func (c *Client) DescribeFunction(ctx context.Context, params *DescribeFunctionInput, optFns ...func(*Options)) (*DescribeFunctionOutput, error) { if params == nil { params = &DescribeFunctionInput{} @@ -37,7 +37,7 @@ type DescribeFunctionInput struct { // This member is required. Name *string - // The function's stage, either DEVELOPMENT or LIVE. + // The function's stage, either DEVELOPMENT or LIVE . Stage types.FunctionStage noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_GetCachePolicy.go b/service/cloudfront/api_op_GetCachePolicy.go index ef8efd41f3d..d93932fd013 100644 --- a/service/cloudfront/api_op_GetCachePolicy.go +++ b/service/cloudfront/api_op_GetCachePolicy.go @@ -12,17 +12,14 @@ import ( ) // Gets a cache policy, including the following metadata: +// - The policy's identifier. +// - The date and time when the policy was last modified. // -// * The policy's -// identifier. -// -// * The date and time when the policy was last modified. -// -// To get a -// cache policy, you must provide the policy's identifier. If the cache policy is -// attached to a distribution's cache behavior, you can get the policy's identifier -// using ListDistributions or GetDistribution. If the cache policy is not attached -// to a cache behavior, you can get the identifier using ListCachePolicies. +// To get a cache policy, you must provide the policy's identifier. If the cache +// policy is attached to a distribution's cache behavior, you can get the policy's +// identifier using ListDistributions or GetDistribution . If the cache policy is +// not attached to a cache behavior, you can get the identifier using +// ListCachePolicies . func (c *Client) GetCachePolicy(ctx context.Context, params *GetCachePolicyInput, optFns ...func(*Options)) (*GetCachePolicyOutput, error) { if params == nil { params = &GetCachePolicyInput{} @@ -40,10 +37,10 @@ func (c *Client) GetCachePolicy(ctx context.Context, params *GetCachePolicyInput type GetCachePolicyInput struct { - // The unique identifier for the cache policy. If the cache policy is attached to a - // distribution's cache behavior, you can get the policy's identifier using - // ListDistributions or GetDistribution. If the cache policy is not attached to a - // cache behavior, you can get the identifier using ListCachePolicies. + // The unique identifier for the cache policy. If the cache policy is attached to + // a distribution's cache behavior, you can get the policy's identifier using + // ListDistributions or GetDistribution . If the cache policy is not attached to a + // cache behavior, you can get the identifier using ListCachePolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetCachePolicyConfig.go b/service/cloudfront/api_op_GetCachePolicyConfig.go index 66d8e94d948..8743b630f2b 100644 --- a/service/cloudfront/api_op_GetCachePolicyConfig.go +++ b/service/cloudfront/api_op_GetCachePolicyConfig.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a cache policy configuration. To get a cache policy configuration, you must -// provide the policy's identifier. If the cache policy is attached to a +// Gets a cache policy configuration. To get a cache policy configuration, you +// must provide the policy's identifier. If the cache policy is attached to a // distribution's cache behavior, you can get the policy's identifier using -// ListDistributions or GetDistribution. If the cache policy is not attached to a -// cache behavior, you can get the identifier using ListCachePolicies. +// ListDistributions or GetDistribution . If the cache policy is not attached to a +// cache behavior, you can get the identifier using ListCachePolicies . func (c *Client) GetCachePolicyConfig(ctx context.Context, params *GetCachePolicyConfigInput, optFns ...func(*Options)) (*GetCachePolicyConfigOutput, error) { if params == nil { params = &GetCachePolicyConfigInput{} @@ -33,10 +33,10 @@ func (c *Client) GetCachePolicyConfig(ctx context.Context, params *GetCachePolic type GetCachePolicyConfigInput struct { - // The unique identifier for the cache policy. If the cache policy is attached to a - // distribution's cache behavior, you can get the policy's identifier using - // ListDistributions or GetDistribution. If the cache policy is not attached to a - // cache behavior, you can get the identifier using ListCachePolicies. + // The unique identifier for the cache policy. If the cache policy is attached to + // a distribution's cache behavior, you can get the policy's identifier using + // ListDistributions or GetDistribution . If the cache policy is not attached to a + // cache behavior, you can get the identifier using ListCachePolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentity.go index 91edd7d7c66..988f0c549a6 100644 --- a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentity.go @@ -45,7 +45,7 @@ type GetCloudFrontOriginAccessIdentityOutput struct { CloudFrontOriginAccessIdentity *types.CloudFrontOriginAccessIdentity // The current version of the origin access identity's information. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go index ce46da87096..966b1a9a74d 100644 --- a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go +++ b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go @@ -28,8 +28,8 @@ func (c *Client) GetCloudFrontOriginAccessIdentityConfig(ctx context.Context, pa } // The origin access identity's configuration information. For more information, -// see CloudFrontOriginAccessIdentityConfig -// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CloudFrontOriginAccessIdentityConfig.html). +// see CloudFrontOriginAccessIdentityConfig (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CloudFrontOriginAccessIdentityConfig.html) +// . type GetCloudFrontOriginAccessIdentityConfigInput struct { // The identity's ID. @@ -46,7 +46,7 @@ type GetCloudFrontOriginAccessIdentityConfigOutput struct { // The origin access identity's configuration information. CloudFrontOriginAccessIdentityConfig *types.CloudFrontOriginAccessIdentityConfig - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_GetContinuousDeploymentPolicy.go b/service/cloudfront/api_op_GetContinuousDeploymentPolicy.go index 76aad9d0255..4d7bce9ba64 100644 --- a/service/cloudfront/api_op_GetContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_GetContinuousDeploymentPolicy.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a continuous deployment policy, including metadata (the policy's identifier -// and the date and time when the policy was last modified). +// Gets a continuous deployment policy, including metadata (the policy's +// identifier and the date and time when the policy was last modified). func (c *Client) GetContinuousDeploymentPolicy(ctx context.Context, params *GetContinuousDeploymentPolicyInput, optFns ...func(*Options)) (*GetContinuousDeploymentPolicyOutput, error) { if params == nil { params = &GetContinuousDeploymentPolicyInput{} diff --git a/service/cloudfront/api_op_GetDistribution.go b/service/cloudfront/api_op_GetDistribution.go index 711e9535e17..ad622d91203 100644 --- a/service/cloudfront/api_op_GetDistribution.go +++ b/service/cloudfront/api_op_GetDistribution.go @@ -51,7 +51,7 @@ type GetDistributionOutput struct { Distribution *types.Distribution // The current version of the distribution's information. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. @@ -145,9 +145,10 @@ type DistributionDeployedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DistributionDeployedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DistributionDeployedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/cloudfront/api_op_GetDistributionConfig.go b/service/cloudfront/api_op_GetDistributionConfig.go index 5615b2eaa07..af99acebe35 100644 --- a/service/cloudfront/api_op_GetDistributionConfig.go +++ b/service/cloudfront/api_op_GetDistributionConfig.go @@ -45,7 +45,7 @@ type GetDistributionConfigOutput struct { // The distribution's configuration information. DistributionConfig *types.DistributionConfig - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_GetFieldLevelEncryption.go b/service/cloudfront/api_op_GetFieldLevelEncryption.go index f82b1abd228..ecac3cb8826 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryption.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryption.go @@ -40,7 +40,7 @@ type GetFieldLevelEncryptionInput struct { type GetFieldLevelEncryptionOutput struct { // The current version of the field level encryption configuration. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Return the field-level encryption configuration information. diff --git a/service/cloudfront/api_op_GetFieldLevelEncryptionConfig.go b/service/cloudfront/api_op_GetFieldLevelEncryptionConfig.go index 4c338a86c38..b65e3b17e01 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryptionConfig.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryptionConfig.go @@ -40,7 +40,7 @@ type GetFieldLevelEncryptionConfigInput struct { type GetFieldLevelEncryptionConfigOutput struct { // The current version of the field level encryption configuration. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Return the field-level encryption configuration information. diff --git a/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go index 6fe7e12755e..fd6e73ccc11 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryptionProfile.go @@ -40,7 +40,7 @@ type GetFieldLevelEncryptionProfileInput struct { type GetFieldLevelEncryptionProfileOutput struct { // The current version of the field level encryption profile. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // Return the field-level encryption profile information. diff --git a/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go b/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go index d47e88dc684..b6fee169047 100644 --- a/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go +++ b/service/cloudfront/api_op_GetFieldLevelEncryptionProfileConfig.go @@ -40,7 +40,7 @@ type GetFieldLevelEncryptionProfileConfigInput struct { type GetFieldLevelEncryptionProfileConfigOutput struct { // The current version of the field-level encryption profile configuration result. - // For example: E2QWRUHAPOMQZL. + // For example: E2QWRUHAPOMQZL . ETag *string // Return the field-level encryption profile configuration information. diff --git a/service/cloudfront/api_op_GetFunction.go b/service/cloudfront/api_op_GetFunction.go index 827fabddd89..423fef4f35d 100644 --- a/service/cloudfront/api_op_GetFunction.go +++ b/service/cloudfront/api_op_GetFunction.go @@ -12,9 +12,9 @@ import ( ) // Gets the code of a CloudFront function. To get configuration information and -// metadata about a function, use DescribeFunction. To get a function's code, you +// metadata about a function, use DescribeFunction . To get a function's code, you // must provide the function's name and stage. To get these values, you can use -// ListFunctions. +// ListFunctions . func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optFns ...func(*Options)) (*GetFunctionOutput, error) { if params == nil { params = &GetFunctionInput{} @@ -37,7 +37,7 @@ type GetFunctionInput struct { // This member is required. Name *string - // The function's stage, either DEVELOPMENT or LIVE. + // The function's stage, either DEVELOPMENT or LIVE . Stage types.FunctionStage noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_GetInvalidation.go b/service/cloudfront/api_op_GetInvalidation.go index 7dbf147eb13..f8445259563 100644 --- a/service/cloudfront/api_op_GetInvalidation.go +++ b/service/cloudfront/api_op_GetInvalidation.go @@ -40,7 +40,7 @@ type GetInvalidationInput struct { // This member is required. DistributionId *string - // The identifier for the invalidation request, for example, IDFDVBD632BHDS5. + // The identifier for the invalidation request, for example, IDFDVBD632BHDS5 . // // This member is required. Id *string @@ -52,8 +52,8 @@ type GetInvalidationInput struct { type GetInvalidationOutput struct { // The invalidation's information. For more information, see Invalidation Complex - // Type - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html). + // Type (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html) + // . Invalidation *types.Invalidation // Metadata pertaining to the operation's result. @@ -147,9 +147,10 @@ type InvalidationCompletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InvalidationCompletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InvalidationCompletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/cloudfront/api_op_GetKeyGroup.go b/service/cloudfront/api_op_GetKeyGroup.go index 8d5a24d8a17..ac6cda44550 100644 --- a/service/cloudfront/api_op_GetKeyGroup.go +++ b/service/cloudfront/api_op_GetKeyGroup.go @@ -14,9 +14,9 @@ import ( // Gets a key group, including the date and time when the key group was last // modified. To get a key group, you must provide the key group's identifier. If // the key group is referenced in a distribution's cache behavior, you can get the -// key group's identifier using ListDistributions or GetDistribution. If the key +// key group's identifier using ListDistributions or GetDistribution . If the key // group is not referenced in a cache behavior, you can get the identifier using -// ListKeyGroups. +// ListKeyGroups . func (c *Client) GetKeyGroup(ctx context.Context, params *GetKeyGroupInput, optFns ...func(*Options)) (*GetKeyGroupOutput, error) { if params == nil { params = &GetKeyGroupInput{} @@ -34,8 +34,8 @@ func (c *Client) GetKeyGroup(ctx context.Context, params *GetKeyGroupInput, optF type GetKeyGroupInput struct { - // The identifier of the key group that you are getting. To get the identifier, use - // ListKeyGroups. + // The identifier of the key group that you are getting. To get the identifier, + // use ListKeyGroups . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetKeyGroupConfig.go b/service/cloudfront/api_op_GetKeyGroupConfig.go index 52060f307ce..a19efdcb690 100644 --- a/service/cloudfront/api_op_GetKeyGroupConfig.go +++ b/service/cloudfront/api_op_GetKeyGroupConfig.go @@ -14,8 +14,8 @@ import ( // Gets a key group configuration. To get a key group configuration, you must // provide the key group's identifier. If the key group is referenced in a // distribution's cache behavior, you can get the key group's identifier using -// ListDistributions or GetDistribution. If the key group is not referenced in a -// cache behavior, you can get the identifier using ListKeyGroups. +// ListDistributions or GetDistribution . If the key group is not referenced in a +// cache behavior, you can get the identifier using ListKeyGroups . func (c *Client) GetKeyGroupConfig(ctx context.Context, params *GetKeyGroupConfigInput, optFns ...func(*Options)) (*GetKeyGroupConfigOutput, error) { if params == nil { params = &GetKeyGroupConfigInput{} @@ -34,7 +34,7 @@ func (c *Client) GetKeyGroupConfig(ctx context.Context, params *GetKeyGroupConfi type GetKeyGroupConfigInput struct { // The identifier of the key group whose configuration you are getting. To get the - // identifier, use ListKeyGroups. + // identifier, use ListKeyGroups . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetMonitoringSubscription.go b/service/cloudfront/api_op_GetMonitoringSubscription.go index ff213513ac0..fbf2a1cdcd1 100644 --- a/service/cloudfront/api_op_GetMonitoringSubscription.go +++ b/service/cloudfront/api_op_GetMonitoringSubscription.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about whether additional CloudWatch metrics are enabled for the -// specified CloudFront distribution. +// Gets information about whether additional CloudWatch metrics are enabled for +// the specified CloudFront distribution. func (c *Client) GetMonitoringSubscription(ctx context.Context, params *GetMonitoringSubscriptionInput, optFns ...func(*Options)) (*GetMonitoringSubscriptionOutput, error) { if params == nil { params = &GetMonitoringSubscriptionInput{} diff --git a/service/cloudfront/api_op_GetOriginRequestPolicy.go b/service/cloudfront/api_op_GetOriginRequestPolicy.go index 842fed2baf5..44d86569fd6 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicy.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicy.go @@ -12,18 +12,14 @@ import ( ) // Gets an origin request policy, including the following metadata: +// - The policy's identifier. +// - The date and time when the policy was last modified. // -// * The policy's -// identifier. -// -// * The date and time when the policy was last modified. -// -// To get an -// origin request policy, you must provide the policy's identifier. If the origin -// request policy is attached to a distribution's cache behavior, you can get the -// policy's identifier using ListDistributions or GetDistribution. If the origin -// request policy is not attached to a cache behavior, you can get the identifier -// using ListOriginRequestPolicies. +// To get an origin request policy, you must provide the policy's identifier. If +// the origin request policy is attached to a distribution's cache behavior, you +// can get the policy's identifier using ListDistributions or GetDistribution . If +// the origin request policy is not attached to a cache behavior, you can get the +// identifier using ListOriginRequestPolicies . func (c *Client) GetOriginRequestPolicy(ctx context.Context, params *GetOriginRequestPolicyInput, optFns ...func(*Options)) (*GetOriginRequestPolicyOutput, error) { if params == nil { params = &GetOriginRequestPolicyInput{} @@ -43,9 +39,9 @@ type GetOriginRequestPolicyInput struct { // The unique identifier for the origin request policy. If the origin request // policy is attached to a distribution's cache behavior, you can get the policy's - // identifier using ListDistributions or GetDistribution. If the origin request + // identifier using ListDistributions or GetDistribution . If the origin request // policy is not attached to a cache behavior, you can get the identifier using - // ListOriginRequestPolicies. + // ListOriginRequestPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go index 5f772d49c17..b6c540dc059 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go @@ -14,9 +14,9 @@ import ( // Gets an origin request policy configuration. To get an origin request policy // configuration, you must provide the policy's identifier. If the origin request // policy is attached to a distribution's cache behavior, you can get the policy's -// identifier using ListDistributions or GetDistribution. If the origin request +// identifier using ListDistributions or GetDistribution . If the origin request // policy is not attached to a cache behavior, you can get the identifier using -// ListOriginRequestPolicies. +// ListOriginRequestPolicies . func (c *Client) GetOriginRequestPolicyConfig(ctx context.Context, params *GetOriginRequestPolicyConfigInput, optFns ...func(*Options)) (*GetOriginRequestPolicyConfigOutput, error) { if params == nil { params = &GetOriginRequestPolicyConfigInput{} @@ -36,9 +36,9 @@ type GetOriginRequestPolicyConfigInput struct { // The unique identifier for the origin request policy. If the origin request // policy is attached to a distribution's cache behavior, you can get the policy's - // identifier using ListDistributions or GetDistribution. If the origin request + // identifier using ListDistributions or GetDistribution . If the origin request // policy is not attached to a cache behavior, you can get the identifier using - // ListOriginRequestPolicies. + // ListOriginRequestPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetResponseHeadersPolicy.go b/service/cloudfront/api_op_GetResponseHeadersPolicy.go index 18454046ebd..5ce89afc14c 100644 --- a/service/cloudfront/api_op_GetResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_GetResponseHeadersPolicy.go @@ -15,9 +15,9 @@ import ( // the date and time when the policy was last modified). To get a response headers // policy, you must provide the policy's identifier. If the response headers policy // is attached to a distribution's cache behavior, you can get the policy's -// identifier using ListDistributions or GetDistribution. If the response headers +// identifier using ListDistributions or GetDistribution . If the response headers // policy is not attached to a cache behavior, you can get the identifier using -// ListResponseHeadersPolicies. +// ListResponseHeadersPolicies . func (c *Client) GetResponseHeadersPolicy(ctx context.Context, params *GetResponseHeadersPolicyInput, optFns ...func(*Options)) (*GetResponseHeadersPolicyOutput, error) { if params == nil { params = &GetResponseHeadersPolicyInput{} @@ -37,9 +37,9 @@ type GetResponseHeadersPolicyInput struct { // The identifier for the response headers policy. If the response headers policy // is attached to a distribution's cache behavior, you can get the policy's - // identifier using ListDistributions or GetDistribution. If the response headers + // identifier using ListDistributions or GetDistribution . If the response headers // policy is not attached to a cache behavior, you can get the identifier using - // ListResponseHeadersPolicies. + // ListResponseHeadersPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go b/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go index 1f36cee73c8..61b20b7fc2d 100644 --- a/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go +++ b/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go @@ -14,9 +14,9 @@ import ( // Gets a response headers policy configuration. To get a response headers policy // configuration, you must provide the policy's identifier. If the response headers // policy is attached to a distribution's cache behavior, you can get the policy's -// identifier using ListDistributions or GetDistribution. If the response headers +// identifier using ListDistributions or GetDistribution . If the response headers // policy is not attached to a cache behavior, you can get the identifier using -// ListResponseHeadersPolicies. +// ListResponseHeadersPolicies . func (c *Client) GetResponseHeadersPolicyConfig(ctx context.Context, params *GetResponseHeadersPolicyConfigInput, optFns ...func(*Options)) (*GetResponseHeadersPolicyConfigOutput, error) { if params == nil { params = &GetResponseHeadersPolicyConfigInput{} @@ -36,9 +36,9 @@ type GetResponseHeadersPolicyConfigInput struct { // The identifier for the response headers policy. If the response headers policy // is attached to a distribution's cache behavior, you can get the policy's - // identifier using ListDistributions or GetDistribution. If the response headers + // identifier using ListDistributions or GetDistribution . If the response headers // policy is not attached to a cache behavior, you can get the identifier using - // ListResponseHeadersPolicies. + // ListResponseHeadersPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetStreamingDistribution.go b/service/cloudfront/api_op_GetStreamingDistribution.go index 50653a7302a..d2578762cd1 100644 --- a/service/cloudfront/api_op_GetStreamingDistribution.go +++ b/service/cloudfront/api_op_GetStreamingDistribution.go @@ -16,8 +16,8 @@ import ( "time" ) -// Gets information about a specified RTMP distribution, including the distribution -// configuration. +// Gets information about a specified RTMP distribution, including the +// distribution configuration. func (c *Client) GetStreamingDistribution(ctx context.Context, params *GetStreamingDistributionInput, optFns ...func(*Options)) (*GetStreamingDistributionOutput, error) { if params == nil { params = &GetStreamingDistributionInput{} @@ -48,7 +48,7 @@ type GetStreamingDistributionInput struct { type GetStreamingDistributionOutput struct { // The current version of the streaming distribution's information. For example: - // E2QWRUHAPOMQZL. + // E2QWRUHAPOMQZL . ETag *string // The streaming distribution's information. @@ -146,10 +146,10 @@ type StreamingDistributionDeployedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingDistributionDeployedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingDistributionDeployedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -199,8 +199,8 @@ func (w *StreamingDistributionDeployedWaiter) Wait(ctx context.Context, params * return err } -// WaitForOutput calls the waiter function for StreamingDistributionDeployed waiter -// and returns the output of the successful operation. The maxWaitDur is the +// WaitForOutput calls the waiter function for StreamingDistributionDeployed +// waiter and returns the output of the successful operation. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *StreamingDistributionDeployedWaiter) WaitForOutput(ctx context.Context, params *GetStreamingDistributionInput, maxWaitDur time.Duration, optFns ...func(*StreamingDistributionDeployedWaiterOptions)) (*GetStreamingDistributionOutput, error) { diff --git a/service/cloudfront/api_op_GetStreamingDistributionConfig.go b/service/cloudfront/api_op_GetStreamingDistributionConfig.go index 9dd8f357dd9..c35ff08b57a 100644 --- a/service/cloudfront/api_op_GetStreamingDistributionConfig.go +++ b/service/cloudfront/api_op_GetStreamingDistributionConfig.go @@ -41,7 +41,7 @@ type GetStreamingDistributionConfigInput struct { // The returned result of the corresponding request. type GetStreamingDistributionConfigOutput struct { - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // The streaming distribution's configuration information. diff --git a/service/cloudfront/api_op_ListCachePolicies.go b/service/cloudfront/api_op_ListCachePolicies.go index 0852ffbe80e..eb2c695854b 100644 --- a/service/cloudfront/api_op_ListCachePolicies.go +++ b/service/cloudfront/api_op_ListCachePolicies.go @@ -47,12 +47,9 @@ type ListCachePoliciesInput struct { // A filter to return only the specified kinds of cache policies. Valid values // are: - // - // * managed – Returns only the managed policies created by Amazon Web - // Services. - // - // * custom – Returns only the custom policies created in your Amazon - // Web Services account. + // - managed – Returns only the managed policies created by Amazon Web Services. + // - custom – Returns only the custom policies created in your Amazon Web + // Services account. Type types.CachePolicyType noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_ListConflictingAliases.go b/service/cloudfront/api_op_ListConflictingAliases.go index 503be1244be..e3ab99448d0 100644 --- a/service/cloudfront/api_op_ListConflictingAliases.go +++ b/service/cloudfront/api_op_ListConflictingAliases.go @@ -19,16 +19,15 @@ import ( // protect the information of ones that you don't own. Use this operation to find // aliases that are in use in CloudFront that conflict or overlap with the provided // alias. For example, if you provide www.example.com as input, the returned list -// can include www.example.com and the overlapping wildcard alternate domain name -// (*.example.com), if they exist. If you provide *.example.com as input, the +// can include www.example.com and the overlapping wildcard alternate domain name ( +// *.example.com ), if they exist. If you provide *.example.com as input, the // returned list can include *.example.com and any alternate domain names covered -// by that wildcard (for example, www.example.com, test.example.com, -// dev.example.com, and so on), if they exist. To list conflicting aliases, you +// by that wildcard (for example, www.example.com , test.example.com , +// dev.example.com , and so on), if they exist. To list conflicting aliases, you // provide the alias to search and the ID of a distribution in your account that // has an attached SSL/TLS certificate that includes the provided alias. For more // information, including how to set up the distribution and certificate, see -// Moving an alternate domain name to a different distribution -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move) +// Moving an alternate domain name to a different distribution (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move) // in the Amazon CloudFront Developer Guide. You can optionally specify the maximum // number of items to receive in the response. If the total number of items in the // list exceeds the maximum that you specify, or the default maximum, the response @@ -63,10 +62,10 @@ type ListConflictingAliasesInput struct { // This member is required. DistributionId *string - // Use this field when paginating results to indicate where to begin in the list of - // conflicting aliases. The response includes conflicting aliases in the list that - // occur after the marker. To get the next page of the list, set this field's value - // to the value of NextMarker from the current page's response. + // Use this field when paginating results to indicate where to begin in the list + // of conflicting aliases. The response includes conflicting aliases in the list + // that occur after the marker. To get the next page of the list, set this field's + // value to the value of NextMarker from the current page's response. Marker *string // The maximum number of conflicting aliases that you want in the response. diff --git a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go index 212f9a32288..029a859da68 100644 --- a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go @@ -16,8 +16,8 @@ import ( // specify the maximum number of items to receive in the response. If the total // number of items in the list exceeds the maximum that you specify, or the default // maximum, the response is paginated. To get the next page of items, send a -// subsequent request that specifies the NextMarker value from the current response -// as the Marker value in the subsequent request. +// subsequent request that specifies the NextMarker value from the current +// response as the Marker value in the subsequent request. func (c *Client) ListDistributionsByOriginRequestPolicyId(ctx context.Context, params *ListDistributionsByOriginRequestPolicyIdInput, optFns ...func(*Options)) (*ListDistributionsByOriginRequestPolicyIdOutput, error) { if params == nil { params = &ListDistributionsByOriginRequestPolicyIdInput{} diff --git a/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go b/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go index 17c914f9d99..051b0681e9d 100644 --- a/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go +++ b/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go @@ -19,8 +19,8 @@ import ( // specify the maximum number of items to receive in the response. If the total // number of items in the list exceeds the maximum that you specify, or the default // maximum, the response is paginated. To get the next page of items, send a -// subsequent request that specifies the NextMarker value from the current response -// as the Marker value in the subsequent request. +// subsequent request that specifies the NextMarker value from the current +// response as the Marker value in the subsequent request. func (c *Client) ListDistributionsByRealtimeLogConfig(ctx context.Context, params *ListDistributionsByRealtimeLogConfigInput, optFns ...func(*Options)) (*ListDistributionsByRealtimeLogConfigOutput, error) { if params == nil { params = &ListDistributionsByRealtimeLogConfigInput{} diff --git a/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go b/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go index 2f06601b703..40fa9213564 100644 --- a/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go @@ -16,8 +16,8 @@ import ( // specify the maximum number of items to receive in the response. If the total // number of items in the list exceeds the maximum that you specify, or the default // maximum, the response is paginated. To get the next page of items, send a -// subsequent request that specifies the NextMarker value from the current response -// as the Marker value in the subsequent request. +// subsequent request that specifies the NextMarker value from the current +// response as the Marker value in the subsequent request. func (c *Client) ListDistributionsByResponseHeadersPolicyId(ctx context.Context, params *ListDistributionsByResponseHeadersPolicyIdInput, optFns ...func(*Options)) (*ListDistributionsByResponseHeadersPolicyIdOutput, error) { if params == nil { params = &ListDistributionsByResponseHeadersPolicyIdInput{} @@ -35,8 +35,8 @@ func (c *Client) ListDistributionsByResponseHeadersPolicyId(ctx context.Context, type ListDistributionsByResponseHeadersPolicyIdInput struct { - // The ID of the response headers policy whose associated distribution IDs you want - // to list. + // The ID of the response headers policy whose associated distribution IDs you + // want to list. // // This member is required. ResponseHeadersPolicyId *string diff --git a/service/cloudfront/api_op_ListDistributionsByWebACLId.go b/service/cloudfront/api_op_ListDistributionsByWebACLId.go index 5afe7f5abc5..6d5abbc5eb0 100644 --- a/service/cloudfront/api_op_ListDistributionsByWebACLId.go +++ b/service/cloudfront/api_op_ListDistributionsByWebACLId.go @@ -31,9 +31,9 @@ func (c *Client) ListDistributionsByWebACLId(ctx context.Context, params *ListDi // ACL. type ListDistributionsByWebACLIdInput struct { - // The ID of the WAF web ACL that you want to list the associated distributions. If - // you specify "null" for the ID, the request returns a list of the distributions - // that aren't associated with a web ACL. + // The ID of the WAF web ACL that you want to list the associated distributions. + // If you specify "null" for the ID, the request returns a list of the + // distributions that aren't associated with a web ACL. // // This member is required. WebACLId *string @@ -41,8 +41,8 @@ type ListDistributionsByWebACLIdInput struct { // Use Marker and MaxItems to control pagination of results. If you have more than // MaxItems distributions that satisfy the request, the response includes a // NextMarker element. To get the next page of results, submit another request. For - // the value of Marker, specify the value of NextMarker from the last response. - // (For the first request, omit Marker.) + // the value of Marker , specify the value of NextMarker from the last response. + // (For the first request, omit Marker .) Marker *string // The maximum number of distributions that you want CloudFront to return in the diff --git a/service/cloudfront/api_op_ListFunctions.go b/service/cloudfront/api_op_ListFunctions.go index c3c57732e15..de58daf1e60 100644 --- a/service/cloudfront/api_op_ListFunctions.go +++ b/service/cloudfront/api_op_ListFunctions.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of all CloudFront functions in your Amazon Web Services account. You -// can optionally apply a filter to return only the functions that are in the -// specified stage, either DEVELOPMENT or LIVE. You can optionally specify the +// Gets a list of all CloudFront functions in your Amazon Web Services account. +// You can optionally apply a filter to return only the functions that are in the +// specified stage, either DEVELOPMENT or LIVE . You can optionally specify the // maximum number of items to receive in the response. If the total number of items // in the list exceeds the maximum that you specify, or the default maximum, the // response is paginated. To get the next page of items, send a subsequent request @@ -45,8 +45,8 @@ type ListFunctionsInput struct { // The maximum number of functions that you want in the response. MaxItems *int32 - // An optional filter to return only the functions that are in the specified stage, - // either DEVELOPMENT or LIVE. + // An optional filter to return only the functions that are in the specified + // stage, either DEVELOPMENT or LIVE . Stage types.FunctionStage noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_ListOriginAccessControls.go b/service/cloudfront/api_op_ListOriginAccessControls.go index 500286ce2eb..784f90373df 100644 --- a/service/cloudfront/api_op_ListOriginAccessControls.go +++ b/service/cloudfront/api_op_ListOriginAccessControls.go @@ -15,8 +15,8 @@ import ( // account. You can optionally specify the maximum number of items to receive in // the response. If the total number of items in the list exceeds the maximum that // you specify, or the default maximum, the response is paginated. To get the next -// page of items, send another request that specifies the NextMarker value from the -// current response as the Marker value in the next request. +// page of items, send another request that specifies the NextMarker value from +// the current response as the Marker value in the next request. func (c *Client) ListOriginAccessControls(ctx context.Context, params *ListOriginAccessControlsInput, optFns ...func(*Options)) (*ListOriginAccessControlsOutput, error) { if params == nil { params = &ListOriginAccessControlsInput{} diff --git a/service/cloudfront/api_op_ListOriginRequestPolicies.go b/service/cloudfront/api_op_ListOriginRequestPolicies.go index a70466c780b..4f6ce38d606 100644 --- a/service/cloudfront/api_op_ListOriginRequestPolicies.go +++ b/service/cloudfront/api_op_ListOriginRequestPolicies.go @@ -17,8 +17,8 @@ import ( // specify the maximum number of items to receive in the response. If the total // number of items in the list exceeds the maximum that you specify, or the default // maximum, the response is paginated. To get the next page of items, send a -// subsequent request that specifies the NextMarker value from the current response -// as the Marker value in the subsequent request. +// subsequent request that specifies the NextMarker value from the current +// response as the Marker value in the subsequent request. func (c *Client) ListOriginRequestPolicies(ctx context.Context, params *ListOriginRequestPoliciesInput, optFns ...func(*Options)) (*ListOriginRequestPoliciesOutput, error) { if params == nil { params = &ListOriginRequestPoliciesInput{} @@ -47,12 +47,9 @@ type ListOriginRequestPoliciesInput struct { // A filter to return only the specified kinds of origin request policies. Valid // values are: - // - // * managed – Returns only the managed policies created by Amazon Web - // Services. - // - // * custom – Returns only the custom policies created in your Amazon - // Web Services account. + // - managed – Returns only the managed policies created by Amazon Web Services. + // - custom – Returns only the custom policies created in your Amazon Web + // Services account. Type types.OriginRequestPolicyType noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_ListResponseHeadersPolicies.go b/service/cloudfront/api_op_ListResponseHeadersPolicies.go index 4763d5f30e3..fbbdaf56bf4 100644 --- a/service/cloudfront/api_op_ListResponseHeadersPolicies.go +++ b/service/cloudfront/api_op_ListResponseHeadersPolicies.go @@ -48,12 +48,9 @@ type ListResponseHeadersPoliciesInput struct { // A filter to get only the specified kind of response headers policies. Valid // values are: - // - // * managed – Gets only the managed policies created by Amazon Web - // Services. - // - // * custom – Gets only the custom policies created in your Amazon Web - // Services account. + // - managed – Gets only the managed policies created by Amazon Web Services. + // - custom – Gets only the custom policies created in your Amazon Web Services + // account. Type types.ResponseHeadersPolicyType noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_PublishFunction.go b/service/cloudfront/api_op_PublishFunction.go index 1afaf316538..5416bee1776 100644 --- a/service/cloudfront/api_op_PublishFunction.go +++ b/service/cloudfront/api_op_PublishFunction.go @@ -12,12 +12,12 @@ import ( ) // Publishes a CloudFront function by copying the function code from the -// DEVELOPMENT stage to LIVE. This automatically updates all cache behaviors that +// DEVELOPMENT stage to LIVE . This automatically updates all cache behaviors that // are using this function to use the newly published copy in the LIVE stage. When // a function is published to the LIVE stage, you can attach the function to a // distribution's cache behavior, using the function's Amazon Resource Name (ARN). -// To publish a function, you must provide the function's name and version (ETag -// value). To get these values, you can use ListFunctions and DescribeFunction. +// To publish a function, you must provide the function's name and version ( ETag +// value). To get these values, you can use ListFunctions and DescribeFunction . func (c *Client) PublishFunction(ctx context.Context, params *PublishFunctionInput, optFns ...func(*Options)) (*PublishFunctionOutput, error) { if params == nil { params = &PublishFunctionInput{} @@ -35,8 +35,8 @@ func (c *Client) PublishFunction(ctx context.Context, params *PublishFunctionInp type PublishFunctionInput struct { - // The current version (ETag value) of the function that you are publishing, which - // you can get using DescribeFunction. + // The current version ( ETag value) of the function that you are publishing, + // which you can get using DescribeFunction . // // This member is required. IfMatch *string diff --git a/service/cloudfront/api_op_TestFunction.go b/service/cloudfront/api_op_TestFunction.go index 5307366708a..8c801815493 100644 --- a/service/cloudfront/api_op_TestFunction.go +++ b/service/cloudfront/api_op_TestFunction.go @@ -17,11 +17,10 @@ import ( // object that you provided, and returns the function's result (the modified event // object) in the response. The response also contains function logs and error // messages, if any exist. For more information about testing functions, see -// Testing functions -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function) +// Testing functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function) // in the Amazon CloudFront Developer Guide. To test a function, you provide the -// function's name and version (ETag value) along with the event object. To get the -// function's name and version, you can use ListFunctions and DescribeFunction. +// function's name and version ( ETag value) along with the event object. To get +// the function's name and version, you can use ListFunctions and DescribeFunction . func (c *Client) TestFunction(ctx context.Context, params *TestFunctionInput, optFns ...func(*Options)) (*TestFunctionOutput, error) { if params == nil { params = &TestFunctionInput{} @@ -40,15 +39,14 @@ func (c *Client) TestFunction(ctx context.Context, params *TestFunctionInput, op type TestFunctionInput struct { // The event object to test the function with. For more information about the - // structure of the event object, see Testing functions - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function) + // structure of the event object, see Testing functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function) // in the Amazon CloudFront Developer Guide. // // This member is required. EventObject []byte - // The current version (ETag value) of the function that you are testing, which you - // can get using DescribeFunction. + // The current version ( ETag value) of the function that you are testing, which + // you can get using DescribeFunction . // // This member is required. IfMatch *string @@ -58,7 +56,7 @@ type TestFunctionInput struct { // This member is required. Name *string - // The stage of the function that you are testing, either DEVELOPMENT or LIVE. + // The stage of the function that you are testing, either DEVELOPMENT or LIVE . Stage types.FunctionStage noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdateCachePolicy.go b/service/cloudfront/api_op_UpdateCachePolicy.go index 5268df7496c..36117e6ba8c 100644 --- a/service/cloudfront/api_op_UpdateCachePolicy.go +++ b/service/cloudfront/api_op_UpdateCachePolicy.go @@ -15,16 +15,11 @@ import ( // configuration, all the fields are updated with the values provided in the // request. You cannot update some fields independent of others. To update a cache // policy configuration: -// -// * Use GetCachePolicyConfig to get the current -// configuration. -// -// * Locally modify the fields in the cache policy configuration -// that you want to update. -// -// * Call UpdateCachePolicy by providing the entire cache -// policy configuration, including the fields that you modified and those that you -// didn't. +// - Use GetCachePolicyConfig to get the current configuration. +// - Locally modify the fields in the cache policy configuration that you want +// to update. +// - Call UpdateCachePolicy by providing the entire cache policy configuration, +// including the fields that you modified and those that you didn't. func (c *Client) UpdateCachePolicy(ctx context.Context, params *UpdateCachePolicyInput, optFns ...func(*Options)) (*UpdateCachePolicyOutput, error) { if params == nil { params = &UpdateCachePolicyInput{} @@ -47,15 +42,15 @@ type UpdateCachePolicyInput struct { // This member is required. CachePolicyConfig *types.CachePolicyConfig - // The unique identifier for the cache policy that you are updating. The identifier - // is returned in a cache behavior's CachePolicyId field in the response to - // GetDistributionConfig. + // The unique identifier for the cache policy that you are updating. The + // identifier is returned in a cache behavior's CachePolicyId field in the + // response to GetDistributionConfig . // // This member is required. Id *string // The version of the cache policy that you are updating. The version is returned - // in the cache policy's ETag field in the response to GetCachePolicyConfig. + // in the cache policy's ETag field in the response to GetCachePolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go index e70584ef7c0..7d5d1fafb3c 100644 --- a/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_UpdateCloudFrontOriginAccessIdentity.go @@ -41,7 +41,7 @@ type UpdateCloudFrontOriginAccessIdentityInput struct { Id *string // The value of the ETag header that you received when retrieving the identity's - // configuration. For example: E2QWRUHAPOMQZL. + // configuration. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde @@ -53,7 +53,7 @@ type UpdateCloudFrontOriginAccessIdentityOutput struct { // The origin access identity's information. CloudFrontOriginAccessIdentity *types.CloudFrontOriginAccessIdentity - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go b/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go index 0d2bd6e2668..77bf5d64ba2 100644 --- a/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go @@ -18,17 +18,12 @@ import ( // all the fields are updated with the values that are provided in the request. You // cannot update some fields independent of others. To update a continuous // deployment policy configuration: -// -// * Use GetContinuousDeploymentPolicyConfig to -// get the current configuration. -// -// * Locally modify the fields in the continuous -// deployment policy configuration that you want to update. -// -// * Use -// UpdateContinuousDeploymentPolicy, providing the entire continuous deployment -// policy configuration, including the fields that you modified and those that you -// didn't. +// - Use GetContinuousDeploymentPolicyConfig to get the current configuration. +// - Locally modify the fields in the continuous deployment policy configuration +// that you want to update. +// - Use UpdateContinuousDeploymentPolicy , providing the entire continuous +// deployment policy configuration, including the fields that you modified and +// those that you didn't. func (c *Client) UpdateContinuousDeploymentPolicy(ctx context.Context, params *UpdateContinuousDeploymentPolicyInput, optFns ...func(*Options)) (*UpdateContinuousDeploymentPolicyOutput, error) { if params == nil { params = &UpdateContinuousDeploymentPolicyInput{} @@ -56,7 +51,7 @@ type UpdateContinuousDeploymentPolicyInput struct { // This member is required. Id *string - // The current version (ETag value) of the continuous deployment policy that you + // The current version ( ETag value) of the continuous deployment policy that you // are updating. IfMatch *string diff --git a/service/cloudfront/api_op_UpdateDistribution.go b/service/cloudfront/api_op_UpdateDistribution.go index a952d46afb7..e2d4eac6ddb 100644 --- a/service/cloudfront/api_op_UpdateDistribution.go +++ b/service/cloudfront/api_op_UpdateDistribution.go @@ -15,26 +15,18 @@ import ( // includes getting the current distribution configuration, updating it to make // your changes, and then submitting an UpdateDistribution request to make the // updates. To update a web distribution using the CloudFront API -// -// * Use -// GetDistributionConfig to get the current configuration, including the version -// identifier (ETag). -// -// * Update the distribution configuration that was returned in -// the response. Note the following important requirements and restrictions: -// -// * You -// must rename the ETag field to IfMatch, leaving the value unchanged. (Set the -// value of IfMatch to the value of ETag, then remove the ETag field.) -// -// * You can't -// change the value of CallerReference. -// -// * Submit an UpdateDistribution request, -// providing the distribution configuration. The new configuration replaces the -// existing configuration. The values that you specify in an UpdateDistribution -// request are not merged into your existing configuration. Make sure to include -// all fields: the ones that you modified and also the ones that you didn't. +// - Use GetDistributionConfig to get the current configuration, including the +// version identifier ( ETag ). +// - Update the distribution configuration that was returned in the response. +// Note the following important requirements and restrictions: +// - You must rename the ETag field to IfMatch , leaving the value unchanged. +// (Set the value of IfMatch to the value of ETag , then remove the ETag field.) +// - You can't change the value of CallerReference . +// - Submit an UpdateDistribution request, providing the distribution +// configuration. The new configuration replaces the existing configuration. The +// values that you specify in an UpdateDistribution request are not merged into +// your existing configuration. Make sure to include all fields: the ones that you +// modified and also the ones that you didn't. func (c *Client) UpdateDistribution(ctx context.Context, params *UpdateDistributionInput, optFns ...func(*Options)) (*UpdateDistributionOutput, error) { if params == nil { params = &UpdateDistributionInput{} @@ -64,7 +56,7 @@ type UpdateDistributionInput struct { Id *string // The value of the ETag header that you received when retrieving the - // distribution's configuration. For example: E2QWRUHAPOMQZL. + // distribution's configuration. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde @@ -76,7 +68,7 @@ type UpdateDistributionOutput struct { // The distribution's information. Distribution *types.Distribution - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // Metadata pertaining to the operation's result. diff --git a/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go b/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go index 77508dc8371..0d3e6f90a33 100644 --- a/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go +++ b/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go @@ -45,7 +45,7 @@ type UpdateDistributionWithStagingConfigInput struct { // This member is required. Id *string - // The current versions (ETag values) of both primary and staging distributions. + // The current versions ( ETag values) of both primary and staging distributions. // Provide these in the following format: , IfMatch *string @@ -58,8 +58,8 @@ type UpdateDistributionWithStagingConfigInput struct { type UpdateDistributionWithStagingConfigOutput struct { - // A distribution tells CloudFront where you want content to be delivered from, and - // the details about how to track and manage content delivery. + // A distribution tells CloudFront where you want content to be delivered from, + // and the details about how to track and manage content delivery. Distribution *types.Distribution // The current version of the primary distribution (after it's updated). diff --git a/service/cloudfront/api_op_UpdateFieldLevelEncryptionConfig.go b/service/cloudfront/api_op_UpdateFieldLevelEncryptionConfig.go index dcb982085e9..879624f96d9 100644 --- a/service/cloudfront/api_op_UpdateFieldLevelEncryptionConfig.go +++ b/service/cloudfront/api_op_UpdateFieldLevelEncryptionConfig.go @@ -39,8 +39,8 @@ type UpdateFieldLevelEncryptionConfigInput struct { // This member is required. Id *string - // The value of the ETag header that you received when retrieving the configuration - // identity to update. For example: E2QWRUHAPOMQZL. + // The value of the ETag header that you received when retrieving the + // configuration identity to update. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde @@ -49,7 +49,7 @@ type UpdateFieldLevelEncryptionConfigInput struct { type UpdateFieldLevelEncryptionConfigOutput struct { // The value of the ETag header that you received when updating the configuration. - // For example: E2QWRUHAPOMQZL. + // For example: E2QWRUHAPOMQZL . ETag *string // Return the results of updating the configuration. diff --git a/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go b/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go index 9bab9c47db2..632758251d6 100644 --- a/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go +++ b/service/cloudfront/api_op_UpdateFieldLevelEncryptionProfile.go @@ -40,7 +40,7 @@ type UpdateFieldLevelEncryptionProfileInput struct { Id *string // The value of the ETag header that you received when retrieving the profile - // identity to update. For example: E2QWRUHAPOMQZL. + // identity to update. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdateFunction.go b/service/cloudfront/api_op_UpdateFunction.go index f250458d295..a1033dfb786 100644 --- a/service/cloudfront/api_op_UpdateFunction.go +++ b/service/cloudfront/api_op_UpdateFunction.go @@ -13,9 +13,9 @@ import ( // Updates a CloudFront function. You can update a function's code or the comment // that describes the function. You cannot update a function's name. To update a -// function, you provide the function's name and version (ETag value) along with +// function, you provide the function's name and version ( ETag value) along with // the updated function code. To get the name and version, you can use -// ListFunctions and DescribeFunction. +// ListFunctions and DescribeFunction . func (c *Client) UpdateFunction(ctx context.Context, params *UpdateFunctionInput, optFns ...func(*Options)) (*UpdateFunctionOutput, error) { if params == nil { params = &UpdateFunctionInput{} @@ -33,9 +33,8 @@ func (c *Client) UpdateFunction(ctx context.Context, params *UpdateFunctionInput type UpdateFunctionInput struct { - // The function code. For more information about writing a CloudFront function, see - // Writing function code for CloudFront Functions - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) + // The function code. For more information about writing a CloudFront function, + // see Writing function code for CloudFront Functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -46,8 +45,8 @@ type UpdateFunctionInput struct { // This member is required. FunctionConfig *types.FunctionConfig - // The current version (ETag value) of the function that you are updating, which - // you can get using DescribeFunction. + // The current version ( ETag value) of the function that you are updating, which + // you can get using DescribeFunction . // // This member is required. IfMatch *string diff --git a/service/cloudfront/api_op_UpdateKeyGroup.go b/service/cloudfront/api_op_UpdateKeyGroup.go index 7be99e6930e..2fb95e61c3c 100644 --- a/service/cloudfront/api_op_UpdateKeyGroup.go +++ b/service/cloudfront/api_op_UpdateKeyGroup.go @@ -14,16 +14,11 @@ import ( // Updates a key group. When you update a key group, all the fields are updated // with the values provided in the request. You cannot update some fields // independent of others. To update a key group: -// -// * Get the current key group with -// GetKeyGroup or GetKeyGroupConfig. -// -// * Locally modify the fields in the key group -// that you want to update. For example, add or remove public key IDs. -// -// * Call -// UpdateKeyGroup with the entire key group object, including the fields that you -// modified and those that you didn't. +// - Get the current key group with GetKeyGroup or GetKeyGroupConfig . +// - Locally modify the fields in the key group that you want to update. For +// example, add or remove public key IDs. +// - Call UpdateKeyGroup with the entire key group object, including the fields +// that you modified and those that you didn't. func (c *Client) UpdateKeyGroup(ctx context.Context, params *UpdateKeyGroupInput, optFns ...func(*Options)) (*UpdateKeyGroupOutput, error) { if params == nil { params = &UpdateKeyGroupInput{} diff --git a/service/cloudfront/api_op_UpdateOriginAccessControl.go b/service/cloudfront/api_op_UpdateOriginAccessControl.go index eee39876572..056a2b37c86 100644 --- a/service/cloudfront/api_op_UpdateOriginAccessControl.go +++ b/service/cloudfront/api_op_UpdateOriginAccessControl.go @@ -39,7 +39,7 @@ type UpdateOriginAccessControlInput struct { // This member is required. OriginAccessControlConfig *types.OriginAccessControlConfig - // The current version (ETag value) of the origin access control that you are + // The current version ( ETag value) of the origin access control that you are // updating. IfMatch *string diff --git a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go index e30c9ac5bee..8ab61112eb1 100644 --- a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go @@ -15,17 +15,11 @@ import ( // request policy configuration, all the fields are updated with the values // provided in the request. You cannot update some fields independent of others. To // update an origin request policy configuration: -// -// * Use -// GetOriginRequestPolicyConfig to get the current configuration. -// -// * Locally modify -// the fields in the origin request policy configuration that you want to -// update. -// -// * Call UpdateOriginRequestPolicy by providing the entire origin request -// policy configuration, including the fields that you modified and those that you -// didn't. +// - Use GetOriginRequestPolicyConfig to get the current configuration. +// - Locally modify the fields in the origin request policy configuration that +// you want to update. +// - Call UpdateOriginRequestPolicy by providing the entire origin request policy +// configuration, including the fields that you modified and those that you didn't. func (c *Client) UpdateOriginRequestPolicy(ctx context.Context, params *UpdateOriginRequestPolicyInput, optFns ...func(*Options)) (*UpdateOriginRequestPolicyOutput, error) { if params == nil { params = &UpdateOriginRequestPolicyInput{} @@ -45,7 +39,7 @@ type UpdateOriginRequestPolicyInput struct { // The unique identifier for the origin request policy that you are updating. The // identifier is returned in a cache behavior's OriginRequestPolicyId field in the - // response to GetDistributionConfig. + // response to GetDistributionConfig . // // This member is required. Id *string @@ -57,7 +51,7 @@ type UpdateOriginRequestPolicyInput struct { // The version of the origin request policy that you are updating. The version is // returned in the origin request policy's ETag field in the response to - // GetOriginRequestPolicyConfig. + // GetOriginRequestPolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdatePublicKey.go b/service/cloudfront/api_op_UpdatePublicKey.go index a1b8f97c17e..8de11797e46 100644 --- a/service/cloudfront/api_op_UpdatePublicKey.go +++ b/service/cloudfront/api_op_UpdatePublicKey.go @@ -40,8 +40,8 @@ type UpdatePublicKeyInput struct { // This member is required. PublicKeyConfig *types.PublicKeyConfig - // The value of the ETag header that you received when retrieving the public key to - // update. For example: E2QWRUHAPOMQZL. + // The value of the ETag header that you received when retrieving the public key + // to update. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdateRealtimeLogConfig.go b/service/cloudfront/api_op_UpdateRealtimeLogConfig.go index bb982e9bcb3..677bea3ee64 100644 --- a/service/cloudfront/api_op_UpdateRealtimeLogConfig.go +++ b/service/cloudfront/api_op_UpdateRealtimeLogConfig.go @@ -15,19 +15,14 @@ import ( // configuration, all the parameters are updated with the values provided in the // request. You cannot update some parameters independent of others. To update a // real-time log configuration: +// - Call GetRealtimeLogConfig to get the current real-time log configuration. +// - Locally modify the parameters in the real-time log configuration that you +// want to update. +// - Call this API ( UpdateRealtimeLogConfig ) by providing the entire real-time +// log configuration, including the parameters that you modified and those that you +// didn't. // -// * Call GetRealtimeLogConfig to get the current -// real-time log configuration. -// -// * Locally modify the parameters in the real-time -// log configuration that you want to update. -// -// * Call this API -// (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, -// including the parameters that you modified and those that you didn't. -// -// You -// cannot update a real-time log configuration's Name or ARN. +// You cannot update a real-time log configuration's Name or ARN . func (c *Client) UpdateRealtimeLogConfig(ctx context.Context, params *UpdateRealtimeLogConfigInput, optFns ...func(*Options)) (*UpdateRealtimeLogConfigOutput, error) { if params == nil { params = &UpdateRealtimeLogConfigInput{} @@ -53,8 +48,7 @@ type UpdateRealtimeLogConfigInput struct { EndPoints []types.EndPoint // A list of fields to include in each real-time log record. For more information - // about fields, see Real-time log configuration fields - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) + // about fields, see Real-time log configuration fields (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) // in the Amazon CloudFront Developer Guide. Fields []string diff --git a/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go b/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go index 7fed14174f2..33dfc1e4668 100644 --- a/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go @@ -14,17 +14,13 @@ import ( // Updates a response headers policy. When you update a response headers policy, // the entire policy is replaced. You cannot update some policy fields independent // of others. To update a response headers policy configuration: -// -// * Use -// GetResponseHeadersPolicyConfig to get the current policy's configuration. -// -// * -// Modify the fields in the response headers policy configuration that you want to -// update. -// -// * Call UpdateResponseHeadersPolicy, providing the entire response -// headers policy configuration, including the fields that you modified and those -// that you didn't. +// - Use GetResponseHeadersPolicyConfig to get the current policy's +// configuration. +// - Modify the fields in the response headers policy configuration that you +// want to update. +// - Call UpdateResponseHeadersPolicy , providing the entire response headers +// policy configuration, including the fields that you modified and those that you +// didn't. func (c *Client) UpdateResponseHeadersPolicy(ctx context.Context, params *UpdateResponseHeadersPolicyInput, optFns ...func(*Options)) (*UpdateResponseHeadersPolicyOutput, error) { if params == nil { params = &UpdateResponseHeadersPolicyInput{} @@ -52,9 +48,9 @@ type UpdateResponseHeadersPolicyInput struct { // This member is required. ResponseHeadersPolicyConfig *types.ResponseHeadersPolicyConfig - // The version of the response headers policy that you are updating. The version is - // returned in the cache policy's ETag field in the response to - // GetResponseHeadersPolicyConfig. + // The version of the response headers policy that you are updating. The version + // is returned in the cache policy's ETag field in the response to + // GetResponseHeadersPolicyConfig . IfMatch *string noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_UpdateStreamingDistribution.go b/service/cloudfront/api_op_UpdateStreamingDistribution.go index 209593b80f1..5235a7daccb 100644 --- a/service/cloudfront/api_op_UpdateStreamingDistribution.go +++ b/service/cloudfront/api_op_UpdateStreamingDistribution.go @@ -41,7 +41,7 @@ type UpdateStreamingDistributionInput struct { StreamingDistributionConfig *types.StreamingDistributionConfig // The value of the ETag header that you received when retrieving the streaming - // distribution's configuration. For example: E2QWRUHAPOMQZL. + // distribution's configuration. For example: E2QWRUHAPOMQZL . IfMatch *string noSmithyDocumentSerde @@ -50,7 +50,7 @@ type UpdateStreamingDistributionInput struct { // The returned result of the corresponding request. type UpdateStreamingDistributionOutput struct { - // The current version of the configuration. For example: E2QWRUHAPOMQZL. + // The current version of the configuration. For example: E2QWRUHAPOMQZL . ETag *string // The streaming distribution's information. diff --git a/service/cloudfront/doc.go b/service/cloudfront/doc.go index 5258354d512..49156d185b0 100644 --- a/service/cloudfront/doc.go +++ b/service/cloudfront/doc.go @@ -3,8 +3,8 @@ // Package cloudfront provides the API client, operations, and parameter types for // Amazon CloudFront. // -// Amazon CloudFront This is the Amazon CloudFront API Reference. This guide is for -// developers who need detailed information about CloudFront API actions, data +// Amazon CloudFront This is the Amazon CloudFront API Reference. This guide is +// for developers who need detailed information about CloudFront API actions, data // types, and errors. For detailed information about CloudFront features, see the // Amazon CloudFront Developer Guide. package cloudfront diff --git a/service/cloudfront/types/enums.go b/service/cloudfront/types/enums.go index 2859fd0548b..4463e086520 100644 --- a/service/cloudfront/types/enums.go +++ b/service/cloudfront/types/enums.go @@ -132,9 +132,9 @@ const ( EventTypeOriginResponse EventType = "origin-response" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "viewer-request", @@ -437,8 +437,8 @@ const ( OriginRequestPolicyCookieBehaviorAllExcept OriginRequestPolicyCookieBehavior = "allExcept" ) -// Values returns all known values for OriginRequestPolicyCookieBehavior. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for OriginRequestPolicyCookieBehavior. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (OriginRequestPolicyCookieBehavior) Values() []OriginRequestPolicyCookieBehavior { @@ -461,8 +461,8 @@ const ( OriginRequestPolicyHeaderBehaviorAllExcept OriginRequestPolicyHeaderBehavior = "allExcept" ) -// Values returns all known values for OriginRequestPolicyHeaderBehavior. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for OriginRequestPolicyHeaderBehavior. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (OriginRequestPolicyHeaderBehavior) Values() []OriginRequestPolicyHeaderBehavior { @@ -485,9 +485,9 @@ const ( OriginRequestPolicyQueryStringBehaviorAllExcept OriginRequestPolicyQueryStringBehavior = "allExcept" ) -// Values returns all known values for OriginRequestPolicyQueryStringBehavior. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for OriginRequestPolicyQueryStringBehavior. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (OriginRequestPolicyQueryStringBehavior) Values() []OriginRequestPolicyQueryStringBehavior { return []OriginRequestPolicyQueryStringBehavior{ @@ -544,8 +544,8 @@ const ( RealtimeMetricsSubscriptionStatusDisabled RealtimeMetricsSubscriptionStatus = "Disabled" ) -// Values returns all known values for RealtimeMetricsSubscriptionStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for RealtimeMetricsSubscriptionStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (RealtimeMetricsSubscriptionStatus) Values() []RealtimeMetricsSubscriptionStatus { diff --git a/service/cloudfront/types/errors.go b/service/cloudfront/types/errors.go index d97f3bafb78..8a67d69a3d0 100644 --- a/service/cloudfront/types/errors.go +++ b/service/cloudfront/types/errors.go @@ -59,8 +59,8 @@ func (e *BatchTooLarge) ErrorCode() string { } func (e *BatchTooLarge) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A cache policy with this name already exists. You must provide a unique name. To -// modify an existing cache policy, use UpdateCachePolicy. +// A cache policy with this name already exists. You must provide a unique name. +// To modify an existing cache policy, use UpdateCachePolicy . type CachePolicyAlreadyExists struct { Message *string @@ -281,8 +281,8 @@ func (e *ContinuousDeploymentPolicyInUse) ErrorCode() string { } func (e *ContinuousDeploymentPolicyInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The caller reference you attempted to create the distribution with is associated -// with another distribution. +// The caller reference you attempted to create the distribution with is +// associated with another distribution. type DistributionAlreadyExists struct { Message *string @@ -473,7 +473,7 @@ func (e *FieldLevelEncryptionProfileSizeExceeded) ErrorFault() smithy.ErrorFault // A function with the same name already exists in this Amazon Web Services // account. To create a function, you must provide a unique name. To update an -// existing function, use UpdateFunction. +// existing function, use UpdateFunction . type FunctionAlreadyExists struct { Message *string @@ -525,8 +525,7 @@ func (e *FunctionInUse) ErrorCode() string { } func (e *FunctionInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The function is too large. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// The function is too large. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type FunctionSizeLimitExceeded struct { Message *string @@ -1189,8 +1188,8 @@ func (e *InvalidQueryStringParameters) ErrorCode() string { } func (e *InvalidQueryStringParameters) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The relative path is too big, is not URL-encoded, or does not begin with a slash -// (/). +// The relative path is too big, is not URL-encoded, or does not begin with a +// slash (/). type InvalidRelativePath struct { Message *string @@ -1350,9 +1349,9 @@ func (e *InvalidViewerCertificate) ErrorFault() smithy.ErrorFault { return smith // A web ACL ID specified is not valid. To specify a web ACL created using the // latest version of WAF, use the ACL ARN, for example -// arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. -// To specify a web ACL created using WAF Classic, use the ACL ID, for example -// 473e64fd-f30b-4765-81a0-62ad96dd167a. +// arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a +// . To specify a web ACL created using WAF Classic, use the ACL ID, for example +// 473e64fd-f30b-4765-81a0-62ad96dd167a . type InvalidWebACLId struct { Message *string @@ -1379,7 +1378,7 @@ func (e *InvalidWebACLId) ErrorCode() string { func (e *InvalidWebACLId) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // A key group with this name already exists. You must provide a unique name. To -// modify an existing key group, use UpdateKeyGroup. +// modify an existing key group, use UpdateKeyGroup . type KeyGroupAlreadyExists struct { Message *string @@ -1696,7 +1695,7 @@ func (e *NoSuchMonitoringSubscription) ErrorCode() string { } func (e *NoSuchMonitoringSubscription) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// No origin exists with the specified Origin Id. +// No origin exists with the specified Origin Id . type NoSuchOrigin struct { Message *string @@ -1959,7 +1958,7 @@ func (e *OriginAccessControlInUse) ErrorFault() smithy.ErrorFault { return smith // An origin request policy with this name already exists. You must provide a // unique name. To modify an existing origin request policy, use -// UpdateOriginRequestPolicy. +// UpdateOriginRequestPolicy . type OriginRequestPolicyAlreadyExists struct { Message *string @@ -2012,7 +2011,7 @@ func (e *OriginRequestPolicyInUse) ErrorCode() string { } func (e *OriginRequestPolicyInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The precondition in one or more of the request fields evaluated to false. +// The precondition in one or more of the request fields evaluated to false . type PreconditionFailed struct { Message *string @@ -2118,7 +2117,7 @@ func (e *QueryArgProfileEmpty) ErrorFault() smithy.ErrorFault { return smithy.Fa // A real-time log configuration with this name already exists. You must provide a // unique name. To modify an existing real-time log configuration, use -// UpdateRealtimeLogConfig. +// UpdateRealtimeLogConfig . type RealtimeLogConfigAlreadyExists struct { Message *string @@ -2226,7 +2225,7 @@ func (e *ResourceInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClie // A response headers policy with this name already exists. You must provide a // unique name. To modify an existing response headers policy, use -// UpdateResponseHeadersPolicy. +// UpdateResponseHeadersPolicy . type ResponseHeadersPolicyAlreadyExists struct { Message *string @@ -2390,8 +2389,7 @@ func (e *TestFunctionFailed) ErrorCode() string { func (e *TestFunctionFailed) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // The length of the Content-Security-Policy header value in the response headers -// policy exceeds the maximum. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// policy exceeds the maximum. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooLongCSPInResponseHeadersPolicy struct { Message *string @@ -2445,8 +2443,7 @@ func (e *TooManyCacheBehaviors) ErrorCode() string { func (e *TooManyCacheBehaviors) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the maximum number of cache policies for this Amazon Web -// Services account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// Services account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyCachePolicies struct { Message *string @@ -2585,8 +2582,7 @@ func (e *TooManyCookieNamesInWhiteList) ErrorCode() string { func (e *TooManyCookieNamesInWhiteList) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of cookies in the cache policy exceeds the maximum. For more -// information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyCookiesInCachePolicy struct { Message *string @@ -2613,9 +2609,8 @@ func (e *TooManyCookiesInCachePolicy) ErrorCode() string { } func (e *TooManyCookiesInCachePolicy) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of cookies in the origin request policy exceeds the maximum. For more -// information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// The number of cookies in the origin request policy exceeds the maximum. For +// more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyCookiesInOriginRequestPolicy struct { Message *string @@ -2644,9 +2639,8 @@ func (e *TooManyCookiesInOriginRequestPolicy) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of custom headers in the response headers policy exceeds the maximum. -// For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// The number of custom headers in the response headers policy exceeds the +// maximum. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyCustomHeadersInResponseHeadersPolicy struct { Message *string @@ -2729,8 +2723,7 @@ func (e *TooManyDistributions) ErrorCode() string { func (e *TooManyDistributions) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The maximum number of distributions have been associated with the specified -// cache policy. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// cache policy. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsAssociatedToCachePolicy struct { Message *string @@ -2789,8 +2782,7 @@ func (e *TooManyDistributionsAssociatedToFieldLevelEncryptionConfig) ErrorFault( } // The number of distributions that reference this key group is more than the -// maximum allowed. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// maximum allowed. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsAssociatedToKeyGroup struct { Message *string @@ -2820,8 +2812,7 @@ func (e *TooManyDistributionsAssociatedToKeyGroup) ErrorFault() smithy.ErrorFaul } // The maximum number of distributions have been associated with the specified -// origin access control. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// origin access control. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsAssociatedToOriginAccessControl struct { Message *string @@ -2851,8 +2842,7 @@ func (e *TooManyDistributionsAssociatedToOriginAccessControl) ErrorFault() smith } // The maximum number of distributions have been associated with the specified -// origin request policy. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// origin request policy. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsAssociatedToOriginRequestPolicy struct { Message *string @@ -2882,8 +2872,7 @@ func (e *TooManyDistributionsAssociatedToOriginRequestPolicy) ErrorFault() smith } // The maximum number of distributions have been associated with the specified -// response headers policy. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// response headers policy. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsAssociatedToResponseHeadersPolicy struct { Message *string @@ -2913,8 +2902,7 @@ func (e *TooManyDistributionsAssociatedToResponseHeadersPolicy) ErrorFault() smi } // You have reached the maximum number of distributions that are associated with a -// CloudFront function. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// CloudFront function. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyDistributionsWithFunctionAssociations struct { Message *string @@ -3030,8 +3018,8 @@ func (e *TooManyFieldLevelEncryptionConfigs) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The maximum number of content type profiles for field-level encryption have been -// created. +// The maximum number of content type profiles for field-level encryption have +// been created. type TooManyFieldLevelEncryptionContentTypeProfiles struct { Message *string @@ -3174,9 +3162,8 @@ func (e *TooManyFieldLevelEncryptionQueryArgProfiles) ErrorFault() smithy.ErrorF return smithy.FaultClient } -// You have reached the maximum number of CloudFront function associations for this -// distribution. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// You have reached the maximum number of CloudFront function associations for +// this distribution. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyFunctionAssociations struct { Message *string @@ -3204,8 +3191,7 @@ func (e *TooManyFunctionAssociations) ErrorCode() string { func (e *TooManyFunctionAssociations) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the maximum number of CloudFront functions for this Amazon Web -// Services account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// Services account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyFunctions struct { Message *string @@ -3233,8 +3219,7 @@ func (e *TooManyFunctions) ErrorCode() string { func (e *TooManyFunctions) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of headers in the cache policy exceeds the maximum. For more -// information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyHeadersInCachePolicy struct { Message *string @@ -3287,9 +3272,8 @@ func (e *TooManyHeadersInForwardedValues) ErrorCode() string { } func (e *TooManyHeadersInForwardedValues) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of headers in the origin request policy exceeds the maximum. For more -// information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// The number of headers in the origin request policy exceeds the maximum. For +// more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyHeadersInOriginRequestPolicy struct { Message *string @@ -3346,8 +3330,7 @@ func (e *TooManyInvalidationsInProgress) ErrorCode() string { func (e *TooManyInvalidationsInProgress) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the maximum number of key groups for this Amazon Web Services -// account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyKeyGroups struct { Message *string @@ -3375,8 +3358,7 @@ func (e *TooManyKeyGroups) ErrorCode() string { func (e *TooManyKeyGroups) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of key groups referenced by this distribution is more than the -// maximum allowed. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// maximum allowed. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyKeyGroupsAssociatedToDistribution struct { Message *string @@ -3432,9 +3414,8 @@ func (e *TooManyLambdaFunctionAssociations) ErrorCode() string { } func (e *TooManyLambdaFunctionAssociations) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of origin access controls in your Amazon Web Services account exceeds -// the maximum allowed. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// The number of origin access controls in your Amazon Web Services account +// exceeds the maximum allowed. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyOriginAccessControls struct { Message *string @@ -3517,8 +3498,7 @@ func (e *TooManyOriginGroupsPerDistribution) ErrorFault() smithy.ErrorFault { } // You have reached the maximum number of origin request policies for this Amazon -// Web Services account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// Web Services account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyOriginRequestPolicies struct { Message *string @@ -3599,8 +3579,7 @@ func (e *TooManyPublicKeys) ErrorCode() string { func (e *TooManyPublicKeys) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of public keys in this key group is more than the maximum allowed. -// For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyPublicKeysInKeyGroup struct { Message *string @@ -3654,8 +3633,7 @@ func (e *TooManyQueryStringParameters) ErrorCode() string { func (e *TooManyQueryStringParameters) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of query strings in the cache policy exceeds the maximum. For more -// information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyQueryStringsInCachePolicy struct { Message *string @@ -3683,8 +3661,7 @@ func (e *TooManyQueryStringsInCachePolicy) ErrorCode() string { func (e *TooManyQueryStringsInCachePolicy) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of query strings in the origin request policy exceeds the maximum. -// For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyQueryStringsInOriginRequestPolicy struct { Message *string @@ -3714,8 +3691,7 @@ func (e *TooManyQueryStringsInOriginRequestPolicy) ErrorFault() smithy.ErrorFaul } // You have reached the maximum number of real-time log configurations for this -// Amazon Web Services account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// Amazon Web Services account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyRealtimeLogConfigs struct { Message *string @@ -3743,8 +3719,7 @@ func (e *TooManyRealtimeLogConfigs) ErrorCode() string { func (e *TooManyRealtimeLogConfigs) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of headers in RemoveHeadersConfig in the response headers policy -// exceeds the maximum. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// exceeds the maximum. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyRemoveHeadersInResponseHeadersPolicy struct { Message *string @@ -3773,9 +3748,8 @@ func (e *TooManyRemoveHeadersInResponseHeadersPolicy) ErrorFault() smithy.ErrorF return smithy.FaultClient } -// You have reached the maximum number of response headers policies for this Amazon -// Web Services account. For more information, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// You have reached the maximum number of response headers policies for this +// Amazon Web Services account. For more information, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // (formerly known as limits) in the Amazon CloudFront Developer Guide. type TooManyResponseHeadersPolicies struct { Message *string diff --git a/service/cloudfront/types/types.go b/service/cloudfront/types/types.go index eebf0c9d728..809453c1ebc 100644 --- a/service/cloudfront/types/types.go +++ b/service/cloudfront/types/types.go @@ -7,13 +7,13 @@ import ( "time" ) -// A list of key groups, and the public keys in each key group, that CloudFront can -// use to verify the signatures of signed URLs and signed cookies. +// A list of key groups, and the public keys in each key group, that CloudFront +// can use to verify the signatures of signed URLs and signed cookies. type ActiveTrustedKeyGroups struct { - // This field is true if any of the key groups have public keys that CloudFront can - // use to verify the signatures of signed URLs and signed cookies. If not, this - // field is false. + // This field is true if any of the key groups have public keys that CloudFront + // can use to verify the signatures of signed URLs and signed cookies. If not, this + // field is false . // // This member is required. Enabled *bool @@ -38,7 +38,7 @@ type ActiveTrustedSigners struct { // This field is true if any of the Amazon Web Services accounts in the list have // active CloudFront key pairs that CloudFront can use to verify the signatures of - // signed URLs and signed cookies. If not, this field is false. + // signed URLs and signed cookies. If not, this field is false . // // This member is required. Enabled *bool @@ -78,9 +78,8 @@ type Aliases struct { // alternate domain name, also known as a CNAME, that they've added to CloudFront. // AliasICPRecordal provides the ICP recordal status for CNAMEs associated with // distributions. The status is returned in the CloudFront response; you can't -// configure it yourself. For more information about ICP recordals, see Signup, -// Accounts, and Credentials -// (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) +// configure it yourself. For more information about ICP recordals, see Signup, +// Accounts, and Credentials (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) // in Getting Started with Amazon Web Services services in China. type AliasICPRecordal struct { @@ -90,21 +89,17 @@ type AliasICPRecordal struct { // The Internet Content Provider (ICP) recordal status for a CNAME. The // ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside // of China. The status values returned are the following: - // - // * APPROVED indicates - // that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can - // be associated with a distribution, and CNAMEs can correspond to different ICP - // recordals. To be marked as APPROVED, that is, valid to use with China region, a - // CNAME must have one ICP recordal number associated with it. - // - // * SUSPENDED - // indicates that the associated CNAME does not have a valid ICP recordal - // number. - // - // * PENDING indicates that CloudFront can't determine the ICP recordal - // status of the CNAME associated with the distribution because there was an error - // in trying to determine the status. You can try again to see if the error is - // resolved in which case CloudFront returns an APPROVED or SUSPENDED status. + // - APPROVED indicates that the associated CNAME has a valid ICP recordal + // number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can + // correspond to different ICP recordals. To be marked as APPROVED, that is, valid + // to use with China region, a CNAME must have one ICP recordal number associated + // with it. + // - SUSPENDED indicates that the associated CNAME does not have a valid ICP + // recordal number. + // - PENDING indicates that CloudFront can't determine the ICP recordal status + // of the CNAME associated with the distribution because there was an error in + // trying to determine the status. You can try again to see if the error is + // resolved in which case CloudFront returns an APPROVED or SUSPENDED status. ICPRecordalStatus ICPRecordalStatus noSmithyDocumentSerde @@ -113,20 +108,15 @@ type AliasICPRecordal struct { // A complex type that controls which HTTP methods CloudFront processes and // forwards to your Amazon S3 bucket or your custom origin. There are three // choices: +// - CloudFront forwards only GET and HEAD requests. +// - CloudFront forwards only GET , HEAD , and OPTIONS requests. +// - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST , and DELETE +// requests. // -// * CloudFront forwards only GET and HEAD requests. -// -// * CloudFront -// forwards only GET, HEAD, and OPTIONS requests. -// -// * CloudFront forwards GET, HEAD, -// OPTIONS, PUT, PATCH, POST, and DELETE requests. -// -// If you pick the third choice, -// you may need to restrict access to your Amazon S3 bucket or to your custom -// origin so users can't perform operations that you don't want them to. For -// example, you might not want users to have permissions to delete objects from -// your origin. +// If you pick the third choice, you may need to restrict access to your Amazon S3 +// bucket or to your custom origin so users can't perform operations that you don't +// want them to. For example, you might not want users to have permissions to +// delete objects from your origin. type AllowedMethods struct { // A complex type that contains the HTTP methods that you want CloudFront to @@ -136,40 +126,34 @@ type AllowedMethods struct { Items []Method // The number of HTTP methods that you want CloudFront to forward to your origin. - // Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS - // requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). + // Valid values are 2 (for GET and HEAD requests), 3 (for GET , HEAD , and OPTIONS + // requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST , and DELETE + // requests). // // This member is required. Quantity *int32 // A complex type that controls whether CloudFront caches the response to requests // using the specified HTTP methods. There are two choices: - // - // * CloudFront caches - // responses to GET and HEAD requests. - // - // * CloudFront caches responses to GET, HEAD, - // and OPTIONS requests. - // - // If you pick the second choice for your Amazon S3 Origin, - // you may need to forward Access-Control-Request-Method, - // Access-Control-Request-Headers, and Origin headers for the responses to be - // cached correctly. + // - CloudFront caches responses to GET and HEAD requests. + // - CloudFront caches responses to GET , HEAD , and OPTIONS requests. + // If you pick the second choice for your Amazon S3 Origin, you may need to + // forward Access-Control-Request-Method, Access-Control-Request-Headers, and + // Origin headers for the responses to be cached correctly. CachedMethods *CachedMethods noSmithyDocumentSerde } -// A complex type that describes how CloudFront processes requests. You must create -// at least as many cache behaviors (including the default cache behavior) as you -// have origins if you want CloudFront to serve objects from all of the origins. -// Each cache behavior specifies the one origin from which you want CloudFront to -// get objects. If you have two origins and only the default cache behavior, the -// default cache behavior will cause CloudFront to get objects from one of the -// origins, but the other origin is never used. For the current quota (formerly -// known as limit) on the number of cache behaviors that you can add to a -// distribution, see Quotas -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) +// A complex type that describes how CloudFront processes requests. You must +// create at least as many cache behaviors (including the default cache behavior) +// as you have origins if you want CloudFront to serve objects from all of the +// origins. Each cache behavior specifies the one origin from which you want +// CloudFront to get objects. If you have two origins and only the default cache +// behavior, the default cache behavior will cause CloudFront to get objects from +// one of the origins, but the other origin is never used. For the current quota +// (formerly known as limit) on the number of cache behaviors that you can add to a +// distribution, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) // in the Amazon CloudFront Developer Guide. If you don't want to specify any cache // behaviors, include only an empty CacheBehaviors element. Don't include an empty // CacheBehavior element because this is invalid. To delete all cache behaviors in @@ -177,21 +161,19 @@ type AllowedMethods struct { // an empty CacheBehaviors element. To add, change, or remove one or more cache // behaviors, update the distribution configuration and specify all of the cache // behaviors that you want to include in the updated distribution. For more -// information about cache behaviors, see Cache Behavior Settings -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) +// information about cache behaviors, see Cache Behavior Settings (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) // in the Amazon CloudFront Developer Guide. type CacheBehavior struct { - // The pattern (for example, images/*.jpg) that specifies which requests to apply + // The pattern (for example, images/*.jpg ) that specifies which requests to apply // the behavior to. When CloudFront receives a viewer request, the requested path // is compared with path patterns in the order in which cache behaviors are listed - // in the distribution. You can optionally include a slash (/) at the beginning of - // the path pattern. For example, /images/*.jpg. CloudFront behavior is the same - // with or without the leading /. The path pattern for the default cache behavior - // is * and cannot be changed. If the request for an object does not match the path - // pattern for any cache behaviors, CloudFront applies the behavior in the default - // cache behavior. For more information, see Path Pattern - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) + // in the distribution. You can optionally include a slash ( / ) at the beginning + // of the path pattern. For example, /images/*.jpg . CloudFront behavior is the + // same with or without the leading / . The path pattern for the default cache + // behavior is * and cannot be changed. If the request for an object does not + // match the path pattern for any cache behaviors, CloudFront applies the behavior + // in the default cache behavior. For more information, see Path Pattern (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -203,32 +185,24 @@ type CacheBehavior struct { // This member is required. TargetOriginId *string - // The protocol that viewers can use to access the files in the origin specified by - // TargetOriginId when a request matches the path pattern in PathPattern. You can - // specify the following options: - // - // * allow-all: Viewers can use HTTP or HTTPS. - // - // * - // redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an - // HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS - // URL. The viewer then resubmits the request using the new URL. - // - // * https-only: If - // a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 - // (Forbidden). - // - // For more information about requiring the HTTPS protocol, see - // Requiring HTTPS Between Viewers and CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) + // The protocol that viewers can use to access the files in the origin specified + // by TargetOriginId when a request matches the path pattern in PathPattern . You + // can specify the following options: + // - allow-all : Viewers can use HTTP or HTTPS. + // - redirect-to-https : If a viewer submits an HTTP request, CloudFront returns + // an HTTP status code of 301 (Moved Permanently) to the viewer along with the + // HTTPS URL. The viewer then resubmits the request using the new URL. + // - https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP + // status code of 403 (Forbidden). + // For more information about requiring the HTTPS protocol, see Requiring HTTPS + // Between Viewers and CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) // in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers // retrieve an object that was fetched from the origin using HTTPS is never to use // any other protocol to fetch the object. If you have recently changed from HTTP // to HTTPS, we recommend that you clear your objects' cache because cached objects // are protocol agnostic. That means that an edge location will return an object // from the cache regardless of whether the current request protocol matches the - // protocol used previously. For more information, see Managing Cache Expiration - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // protocol used previously. For more information, see Managing Cache Expiration (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -237,52 +211,40 @@ type CacheBehavior struct { // A complex type that controls which HTTP methods CloudFront processes and // forwards to your Amazon S3 bucket or your custom origin. There are three // choices: - // - // * CloudFront forwards only GET and HEAD requests. - // - // * CloudFront - // forwards only GET, HEAD, and OPTIONS requests. - // - // * CloudFront forwards GET, HEAD, - // OPTIONS, PUT, PATCH, POST, and DELETE requests. - // - // If you pick the third choice, - // you may need to restrict access to your Amazon S3 bucket or to your custom - // origin so users can't perform operations that you don't want them to. For - // example, you might not want users to have permissions to delete objects from - // your origin. + // - CloudFront forwards only GET and HEAD requests. + // - CloudFront forwards only GET , HEAD , and OPTIONS requests. + // - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST , and DELETE + // requests. + // If you pick the third choice, you may need to restrict access to your Amazon S3 + // bucket or to your custom origin so users can't perform operations that you don't + // want them to. For example, you might not want users to have permissions to + // delete objects from your origin. AllowedMethods *AllowedMethods // The unique identifier of the cache policy that is attached to this cache - // behavior. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // behavior. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. A CacheBehavior must include either a - // CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId. + // CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId . CachePolicyId *string // Whether you want CloudFront to automatically compress certain files for this // cache behavior. If so, specify true; if not, specify false. For more - // information, see Serving Compressed Files - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) + // information, see Serving Compressed Files (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) // in the Amazon CloudFront Developer Guide. Compress *bool // This field is deprecated. We recommend that you use the DefaultTTL field in a // cache policy instead of this field. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The default amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. The // value that you specify applies only when your origin does not add HTTP headers - // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. - // For more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // such as Cache-Control max-age , Cache-Control s-maxage , and Expires to + // objects. For more information, see Managing How Long Content Stays in an Edge + // Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // Deprecated: This member has been deprecated. @@ -295,21 +257,16 @@ type CacheBehavior struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. For more information, see Working with - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) // in the Amazon CloudFront Developer Guide. If you want to include values in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. If you want to send values to the // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) // in the Amazon CloudFront Developer Guide. A CacheBehavior must include either a - // CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId. A + // CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId . A // complex type that specifies how CloudFront handles query strings, cookies, and // HTTP headers. // @@ -326,51 +283,43 @@ type CacheBehavior struct { LambdaFunctionAssociations *LambdaFunctionAssociations // This field is deprecated. We recommend that you use the MaxTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policy instead of this field. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The maximum amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. The // value that you specify applies only when your origin adds HTTP headers such as - // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more - // information, see Managing How Long Content Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For + // more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // Deprecated: This member has been deprecated. MaxTTL *int64 // This field is deprecated. We recommend that you use the MinTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policy instead of this field. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The minimum amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. For - // more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you - // configure CloudFront to forward all headers to your origin (under Headers, if - // you specify 1 for Quantity and * for Name). + // configure CloudFront to forward all headers to your origin (under Headers , if + // you specify 1 for Quantity and * for Name ). // // Deprecated: This member has been deprecated. MinTTL *int64 // The unique identifier of the origin request policy that is attached to this - // cache behavior. For more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // cache behavior. For more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) // in the Amazon CloudFront Developer Guide. OriginRequestPolicyId *string // The Amazon Resource Name (ARN) of the real-time log configuration that is - // attached to this cache behavior. For more information, see Real-time logs - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) + // attached to this cache behavior. For more information, see Real-time logs (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) // in the Amazon CloudFront Developer Guide. RealtimeLogConfigArn *string @@ -379,9 +328,9 @@ type CacheBehavior struct { // Indicates whether you want to distribute media files in the Microsoft Smooth // Streaming format using the origin that is associated with this cache behavior. - // If so, specify true; if not, specify false. If you specify true for - // SmoothStreaming, you can still distribute other content using this cache - // behavior if the content matches the value of PathPattern. + // If so, specify true ; if not, specify false . If you specify true for + // SmoothStreaming , you can still distribute other content using this cache + // behavior if the content matches the value of PathPattern . SmoothStreaming *bool // A list of key groups that CloudFront can use to validate signed URLs or signed @@ -390,12 +339,11 @@ type CacheBehavior struct { // The URLs or cookies must be signed with a private key whose corresponding public // key is in the key group. The signed URL or cookie contains information about // which public key CloudFront should use to verify the signature. For more - // information, see Serving private content - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // information, see Serving private content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. TrustedKeyGroups *TrustedKeyGroups - // We recommend using TrustedKeyGroups instead of TrustedSigners. A list of Amazon + // We recommend using TrustedKeyGroups instead of TrustedSigners . A list of Amazon // Web Services account IDs whose public keys CloudFront can use to validate signed // URLs or signed cookies. When a cache behavior contains trusted signers, // CloudFront requires signed URLs or signed cookies for all requests that match @@ -403,8 +351,7 @@ type CacheBehavior struct { // CloudFront key pair in the trusted signer's Amazon Web Services account. The // signed URL or cookie contains information about which public key CloudFront // should use to verify the signature. For more information, see Serving private - // content - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. TrustedSigners *TrustedSigners @@ -419,8 +366,8 @@ type CacheBehaviors struct { // This member is required. Quantity *int32 - // Optional: A complex type that contains cache behaviors for this distribution. If - // Quantity is 0, you can omit Items. + // Optional: A complex type that contains cache behaviors for this distribution. + // If Quantity is 0 , you can omit Items . Items []CacheBehavior noSmithyDocumentSerde @@ -428,17 +375,12 @@ type CacheBehaviors struct { // A complex type that controls whether CloudFront caches the response to requests // using the specified HTTP methods. There are two choices: +// - CloudFront caches responses to GET and HEAD requests. +// - CloudFront caches responses to GET , HEAD , and OPTIONS requests. // -// * CloudFront caches -// responses to GET and HEAD requests. -// -// * CloudFront caches responses to GET, HEAD, -// and OPTIONS requests. -// -// If you pick the second choice for your Amazon S3 Origin, -// you may need to forward Access-Control-Request-Method, -// Access-Control-Request-Headers, and Origin headers for the responses to be -// cached correctly. +// If you pick the second choice for your Amazon S3 Origin, you may need to +// forward Access-Control-Request-Method, Access-Control-Request-Headers, and +// Origin headers for the responses to be cached correctly. type CachedMethods struct { // A complex type that contains the HTTP methods that you want CloudFront to cache @@ -449,7 +391,7 @@ type CachedMethods struct { // The number of HTTP methods for which you want CloudFront to cache responses. // Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for - // caching responses to GET, HEAD, and OPTIONS requests). + // caching responses to GET , HEAD , and OPTIONS requests). // // This member is required. Quantity *int32 @@ -459,21 +401,17 @@ type CachedMethods struct { // A cache policy. When it's attached to a cache behavior, the cache policy // determines the following: +// - The values that CloudFront includes in the cache key. These values can +// include HTTP headers, cookies, and URL query strings. CloudFront uses the cache +// key to find an object in its cache that it can return to the viewer. +// - The default, minimum, and maximum time to live (TTL) values that you want +// objects to stay in the CloudFront cache. // -// * The values that CloudFront includes in the cache -// key. These values can include HTTP headers, cookies, and URL query strings. -// CloudFront uses the cache key to find an object in its cache that it can return -// to the viewer. -// -// * The default, minimum, and maximum time to live (TTL) values -// that you want objects to stay in the CloudFront cache. -// -// The headers, cookies, -// and query strings that are included in the cache key are also included in -// requests that CloudFront sends to the origin. CloudFront sends a request when it -// can't find a valid object in its cache that matches the request's cache key. If -// you want to send values to the origin but not include them in the cache key, use -// OriginRequestPolicy. +// The headers, cookies, and query strings that are included in the cache key are +// also included in requests that CloudFront sends to the origin. CloudFront sends +// a request when it can't find a valid object in its cache that matches the +// request's cache key. If you want to send values to the origin but not include +// them in the cache key, use OriginRequestPolicy . type CachePolicy struct { // The cache policy configuration. @@ -495,28 +433,23 @@ type CachePolicy struct { } // A cache policy configuration. This configuration determines the following: +// - The values that CloudFront includes in the cache key. These values can +// include HTTP headers, cookies, and URL query strings. CloudFront uses the cache +// key to find an object in its cache that it can return to the viewer. +// - The default, minimum, and maximum time to live (TTL) values that you want +// objects to stay in the CloudFront cache. // -// * -// The values that CloudFront includes in the cache key. These values can include -// HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to -// find an object in its cache that it can return to the viewer. -// -// * The default, -// minimum, and maximum time to live (TTL) values that you want objects to stay in -// the CloudFront cache. -// -// The headers, cookies, and query strings that are included -// in the cache key are also included in requests that CloudFront sends to the -// origin. CloudFront sends a request when it can't find a valid object in its -// cache that matches the request's cache key. If you want to send values to the -// origin but not include them in the cache key, use OriginRequestPolicy. +// The headers, cookies, and query strings that are included in the cache key are +// also included in requests that CloudFront sends to the origin. CloudFront sends +// a request when it can't find a valid object in its cache that matches the +// request's cache key. If you want to send values to the origin but not include +// them in the cache key, use OriginRequestPolicy . type CachePolicyConfig struct { // The minimum amount of time, in seconds, that you want objects to stay in the // CloudFront cache before CloudFront sends another request to the origin to see if - // the object has been updated. For more information, see Managing How Long Content - // Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // the object has been updated. For more information, see Managing How Long + // Content Stays in an Edge Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -535,24 +468,22 @@ type CachePolicyConfig struct { // CloudFront cache before CloudFront sends another request to the origin to see if // the object has been updated. CloudFront uses this value as the object's time to // live (TTL) only when the origin does not send Cache-Control or Expires headers - // with the object. For more information, see Managing How Long Content Stays in an - // Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // with the object. For more information, see Managing How Long Content Stays in + // an Edge Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. The default value for this field is - // 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then - // the default value for this field is the same as the value of MinTTL. + // 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, + // then the default value for this field is the same as the value of MinTTL . DefaultTTL *int64 // The maximum amount of time, in seconds, that objects stay in the CloudFront // cache before CloudFront sends another request to the origin to see if the object // has been updated. CloudFront uses this value only when the origin sends // Cache-Control or Expires headers with the object. For more information, see - // Managing How Long Content Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // Managing How Long Content Stays in an Edge Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. The default value for this field is // 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than // 31536000 seconds, then the default value for this field is the same as the value - // of DefaultTTL. + // of DefaultTTL . MaxTTL *int64 // The HTTP headers, cookies, and URL query strings to include in the cache key. @@ -570,24 +501,18 @@ type CachePolicyCookiesConfig struct { // Determines whether any cookies in viewer requests are included in the cache key // and in requests that CloudFront sends to the origin. Valid values are: - // - // * none – - // No cookies in viewer requests are included in the cache key or in requests that - // CloudFront sends to the origin. Even when this field is set to none, any cookies - // that are listed in an OriginRequestPolicy are included in origin requests. - // - // * - // whitelist – Only the cookies in viewer requests that are listed in the - // CookieNames type are included in the cache key and in requests that CloudFront - // sends to the origin. - // - // * allExcept – All cookies in viewer requests are included - // in the cache key and in requests that CloudFront sends to the origin, except for - // those that are listed in the CookieNames type, which are not included. - // - // * all – - // All cookies in viewer requests are included in the cache key and in requests - // that CloudFront sends to the origin. + // - none – No cookies in viewer requests are included in the cache key or in + // requests that CloudFront sends to the origin. Even when this field is set to + // none , any cookies that are listed in an OriginRequestPolicy are included in + // origin requests. + // - whitelist – Only the cookies in viewer requests that are listed in the + // CookieNames type are included in the cache key and in requests that CloudFront + // sends to the origin. + // - allExcept – All cookies in viewer requests are included in the cache key and + // in requests that CloudFront sends to the origin, except for those that are + // listed in the CookieNames type, which are not included. + // - all – All cookies in viewer requests are included in the cache key and in + // requests that CloudFront sends to the origin. // // This member is required. CookieBehavior CachePolicyCookieBehavior @@ -605,15 +530,12 @@ type CachePolicyHeadersConfig struct { // Determines whether any HTTP headers are included in the cache key and in // requests that CloudFront sends to the origin. Valid values are: - // - // * none – No - // HTTP headers are included in the cache key or in requests that CloudFront sends - // to the origin. Even when this field is set to none, any headers that are listed - // in an OriginRequestPolicy are included in origin requests. - // - // * whitelist – Only - // the HTTP headers that are listed in the Headers type are included in the cache - // key and in requests that CloudFront sends to the origin. + // - none – No HTTP headers are included in the cache key or in requests that + // CloudFront sends to the origin. Even when this field is set to none , any + // headers that are listed in an OriginRequestPolicy are included in origin + // requests. + // - whitelist – Only the HTTP headers that are listed in the Headers type are + // included in the cache key and in requests that CloudFront sends to the origin. // // This member is required. HeaderBehavior CachePolicyHeaderBehavior @@ -654,26 +576,20 @@ type CachePolicyList struct { type CachePolicyQueryStringsConfig struct { // Determines whether any URL query strings in viewer requests are included in the - // cache key and in requests that CloudFront sends to the origin. Valid values - // are: - // - // * none – No query strings in viewer requests are included in the cache key - // or in requests that CloudFront sends to the origin. Even when this field is set - // to none, any query strings that are listed in an OriginRequestPolicy are - // included in origin requests. - // - // * whitelist – Only the query strings in viewer - // requests that are listed in the QueryStringNames type are included in the cache - // key and in requests that CloudFront sends to the origin. - // - // * allExcept – All - // query strings in viewer requests are included in the cache key and in requests - // that CloudFront sends to the origin, except those that are listed in the - // QueryStringNames type, which are not included. - // - // * all – All query strings in - // viewer requests are included in the cache key and in requests that CloudFront - // sends to the origin. + // cache key and in requests that CloudFront sends to the origin. Valid values are: + // + // - none – No query strings in viewer requests are included in the cache key or + // in requests that CloudFront sends to the origin. Even when this field is set to + // none , any query strings that are listed in an OriginRequestPolicy are + // included in origin requests. + // - whitelist – Only the query strings in viewer requests that are listed in the + // QueryStringNames type are included in the cache key and in requests that + // CloudFront sends to the origin. + // - allExcept – All query strings in viewer requests are included in the cache + // key and in requests that CloudFront sends to the origin, except those that are + // listed in the QueryStringNames type, which are not included. + // - all – All query strings in viewer requests are included in the cache key and + // in requests that CloudFront sends to the origin. // // This member is required. QueryStringBehavior CachePolicyQueryStringBehavior @@ -681,9 +597,9 @@ type CachePolicyQueryStringsConfig struct { // Contains the specific query strings in viewer requests that either are or are // not included in the cache key and in requests that CloudFront sends to the // origin. The behavior depends on whether the QueryStringBehavior field in the - // CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings - // are included) or allExcept (the listed query strings are not included, but all - // other query strings are). + // CachePolicyQueryStringsConfig type is set to whitelist (the listed query + // strings are included) or allExcept (the listed query strings are not included, + // but all other query strings are). QueryStrings *QueryStringNames noSmithyDocumentSerde @@ -709,13 +625,13 @@ type CachePolicySummary struct { // CloudFront origin access identity. type CloudFrontOriginAccessIdentity struct { - // The ID for the origin access identity, for example, E74FTE3AJFJ256A. + // The ID for the origin access identity, for example, E74FTE3AJFJ256A . // // This member is required. Id *string - // The Amazon S3 canonical user ID for the origin access identity, used when giving - // the origin access identity read permission to an object in Amazon S3. + // The Amazon S3 canonical user ID for the origin access identity, used when + // giving the origin access identity read permission to an object in Amazon S3. // // This member is required. S3CanonicalUserId *string @@ -732,8 +648,8 @@ type CloudFrontOriginAccessIdentityConfig struct { // A unique value (for example, a date-time stamp) that ensures that the request // can't be replayed. If the value of CallerReference is new (regardless of the - // content of the CloudFrontOriginAccessIdentityConfig object), a new origin access - // identity is created. If the CallerReference is a value already sent in a + // content of the CloudFrontOriginAccessIdentityConfig object), a new origin + // access identity is created. If the CallerReference is a value already sent in a // previous identity request, and the content of the // CloudFrontOriginAccessIdentityConfig is identical to the original request // (ignoring white space), the response includes the same information returned to @@ -762,9 +678,9 @@ type CloudFrontOriginAccessIdentityConfig struct { // long, you can paginate it using the MaxItems and Marker parameters. type CloudFrontOriginAccessIdentityList struct { - // A flag that indicates whether more origin access identities remain to be listed. - // If your results were truncated, you can make a follow-up pagination request - // using the Marker request parameter to retrieve more items in the list. + // A flag that indicates whether more origin access identities remain to be + // listed. If your results were truncated, you can make a follow-up pagination + // request using the Marker request parameter to retrieve more items in the list. // // This member is required. IsTruncated *bool @@ -794,7 +710,7 @@ type CloudFrontOriginAccessIdentityList struct { // Services account. Items []CloudFrontOriginAccessIdentitySummary - // If IsTruncated is true, this element is present and contains the value you can + // If IsTruncated is true , this element is present and contains the value you can // use for the Marker request parameter to continue listing your origin access // identities where they left off. NextMarker *string @@ -811,7 +727,7 @@ type CloudFrontOriginAccessIdentitySummary struct { // This member is required. Comment *string - // The ID for the origin access identity. For example: E74FTE3AJFJ256A. + // The ID for the origin access identity. For example: E74FTE3AJFJ256A . // // This member is required. Id *string @@ -947,14 +863,14 @@ type ContinuousDeploymentPolicy struct { type ContinuousDeploymentPolicyConfig struct { // A Boolean that indicates whether this continuous deployment policy is enabled - // (in effect). When this value is true, this policy is enabled and in effect. When - // this value is false, this policy is not enabled and has no effect. + // (in effect). When this value is true , this policy is enabled and in effect. + // When this value is false , this policy is not enabled and has no effect. // // This member is required. Enabled *bool // The CloudFront domain name of the staging distribution. For example: - // d111111abcdef8.cloudfront.net. + // d111111abcdef8.cloudfront.net . // // This member is required. StagingDistributionDnsNames *StagingDistributionDnsNames @@ -969,8 +885,8 @@ type ContinuousDeploymentPolicyConfig struct { // Contains a list of continuous deployment policies. type ContinuousDeploymentPolicyList struct { - // The maximum number of continuous deployment policies that were specified in your - // request. + // The maximum number of continuous deployment policies that were specified in + // your request. // // This member is required. MaxItems *int32 @@ -1009,7 +925,7 @@ type ContinuousDeploymentPolicySummary struct { type ContinuousDeploymentSingleHeaderConfig struct { // The request header name that you want CloudFront to send to your staging - // distribution. The header must contain the prefix aws-cf-cd-. + // distribution. The header must contain the prefix aws-cf-cd- . // // This member is required. Header *string @@ -1057,24 +973,21 @@ type CookieNames struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include cookies in the -// cache key, use CookiesConfig in a cache policy. See CachePolicy. If you want to +// cache key, use CookiesConfig in a cache policy. See CachePolicy . If you want to // send cookies to the origin but not include them in the cache key, use -// CookiesConfig in an origin request policy. See OriginRequestPolicy. A complex +// CookiesConfig in an origin request policy. See OriginRequestPolicy . A complex // type that specifies whether you want CloudFront to forward cookies to the origin // and, if so, which ones. For more information about forwarding cookies to the -// origin, see Caching Content Based on Cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) +// origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) // in the Amazon CloudFront Developer Guide. type CookiePreference struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include cookies in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send cookies to the // origin but not include them in the cache key, use origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. Specifies which cookies to forward to // the origin for this cache behavior: all, none, or the list of cookies specified // in the WhitelistedNames complex type. Amazon S3 doesn't process cookies. When @@ -1086,22 +999,19 @@ type CookiePreference struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include cookies in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send cookies to the // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. Required if you specify whitelist for - // the value of Forward. A complex type that specifies how many different cookies + // the value of Forward . A complex type that specifies how many different cookies // you want CloudFront to forward to the origin for this cache behavior and, if you // want to forward selected cookies, the names of those cookies. If you specify all - // or none for the value of Forward, omit WhitelistedNames. If you change the value - // of Forward from whitelist to all or none and you don't delete the + // or none for the value of Forward , omit WhitelistedNames . If you change the + // value of Forward from whitelist to all or none and you don't delete the // WhitelistedNames element and its child elements, CloudFront deletes them // automatically. For the current limit on the number of cookie names that you can - // whitelist for each cache behavior, see CloudFront Limits - // (https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) + // whitelist for each cache behavior, see CloudFront Limits (https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) // in the Amazon Web Services General Reference. WhitelistedNames *CookieNames @@ -1109,17 +1019,11 @@ type CookiePreference struct { } // A complex type that controls: +// - Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with +// custom error messages before returning the response to the viewer. +// - How long CloudFront caches HTTP status codes in the 4xx and 5xx range. // -// * Whether CloudFront replaces HTTP status codes -// in the 4xx and 5xx range with custom error messages before returning the -// response to the viewer. -// -// * How long CloudFront caches HTTP status codes in the -// 4xx and 5xx range. -// -// For more information about custom error pages, see -// Customizing Error Responses -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) +// For more information about custom error pages, see Customizing Error Responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) // in the Amazon CloudFront Developer Guide. type CustomErrorResponse struct { @@ -1130,55 +1034,43 @@ type CustomErrorResponse struct { ErrorCode *int32 // The minimum amount of time, in seconds, that you want CloudFront to cache the - // HTTP status code specified in ErrorCode. When this time period has elapsed, + // HTTP status code specified in ErrorCode . When this time period has elapsed, // CloudFront queries your origin to see whether the problem that caused the error // has been resolved and the requested object is now available. For more - // information, see Customizing Error Responses - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) + // information, see Customizing Error Responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) // in the Amazon CloudFront Developer Guide. ErrorCachingMinTTL *int64 - // The HTTP status code that you want CloudFront to return to the viewer along with - // the custom error page. There are a variety of reasons that you might want + // The HTTP status code that you want CloudFront to return to the viewer along + // with the custom error page. There are a variety of reasons that you might want // CloudFront to return a status code different from the status code that your // origin returned to CloudFront, for example: - // - // * Some Internet devices (some - // firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and - // prevent the response from being returned to the viewer. If you substitute 200, - // the response typically won't be intercepted. - // - // * If you don't care about - // distinguishing among different client errors or server errors, you can specify - // 400 or 500 as the ResponseCode for all 4xx or 5xx errors. - // - // * You might want to - // return a 200 status code (OK) and static website so your customers don't know - // that your website is down. - // - // If you specify a value for ResponseCode, you must - // also specify a value for ResponsePagePath. + // - Some Internet devices (some firewalls and corporate proxies, for example) + // intercept HTTP 4xx and 5xx and prevent the response from being returned to the + // viewer. If you substitute 200 , the response typically won't be intercepted. + // - If you don't care about distinguishing among different client errors or + // server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or + // 5xx errors. + // - You might want to return a 200 status code (OK) and static website so your + // customers don't know that your website is down. + // If you specify a value for ResponseCode , you must also specify a value for + // ResponsePagePath . ResponseCode *string - // The path to the custom error page that you want CloudFront to return to a viewer - // when your origin returns the HTTP status code specified by ErrorCode, for - // example, /4xx-errors/403-forbidden.html. If you want to store your objects and - // your custom error pages in different locations, your distribution must include a - // cache behavior for which the following is true: - // - // * The value of PathPattern - // matches the path to your custom error messages. For example, suppose you saved - // custom error pages for 4xx errors in an Amazon S3 bucket in a directory named - // /4xx-errors. Your distribution must include a cache behavior for which the path - // pattern routes requests for your custom error pages to that location, for - // example, /4xx-errors/*. - // - // * The value of TargetOriginId specifies the value of - // the ID element for the origin that contains your custom error pages. - // - // If you - // specify a value for ResponsePagePath, you must also specify a value for - // ResponseCode. We recommend that you store custom error pages in an Amazon S3 + // The path to the custom error page that you want CloudFront to return to a + // viewer when your origin returns the HTTP status code specified by ErrorCode , + // for example, /4xx-errors/403-forbidden.html . If you want to store your objects + // and your custom error pages in different locations, your distribution must + // include a cache behavior for which the following is true: + // - The value of PathPattern matches the path to your custom error messages. For + // example, suppose you saved custom error pages for 4xx errors in an Amazon S3 + // bucket in a directory named /4xx-errors . Your distribution must include a + // cache behavior for which the path pattern routes requests for your custom error + // pages to that location, for example, /4xx-errors/* . + // - The value of TargetOriginId specifies the value of the ID element for the + // origin that contains your custom error pages. + // If you specify a value for ResponsePagePath , you must also specify a value for + // ResponseCode . We recommend that you store custom error pages in an Amazon S3 // bucket. If you store custom error pages on an HTTP server and the server starts // to return 5xx errors, CloudFront can't get the files that you want to return to // viewers because the origin server is unavailable. @@ -1188,22 +1080,16 @@ type CustomErrorResponse struct { } // A complex type that controls: +// - Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with +// custom error messages before returning the response to the viewer. +// - How long CloudFront caches HTTP status codes in the 4xx and 5xx range. // -// * Whether CloudFront replaces HTTP status codes -// in the 4xx and 5xx range with custom error messages before returning the -// response to the viewer. -// -// * How long CloudFront caches HTTP status codes in the -// 4xx and 5xx range. -// -// For more information about custom error pages, see -// Customizing Error Responses -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) +// For more information about custom error pages, see Customizing Error Responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) // in the Amazon CloudFront Developer Guide. type CustomErrorResponses struct { // The number of HTTP status codes for which you want to specify a custom error - // page and/or a caching duration. If Quantity is 0, you can omit Items. + // page and/or a caching duration. If Quantity is 0 , you can omit Items . // // This member is required. Quantity *int32 @@ -1225,8 +1111,8 @@ type CustomHeaders struct { Quantity *int32 // Optional: A list that contains one OriginCustomHeader element for each custom - // header that you want CloudFront to forward to the origin. If Quantity is 0, omit - // Items. + // header that you want CloudFront to forward to the origin. If Quantity is 0 , + // omit Items . Items []OriginCustomHeader noSmithyDocumentSerde @@ -1252,15 +1138,10 @@ type CustomOriginConfig struct { // Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the // origin. Valid values are: - // - // * http-only – CloudFront always uses HTTP to connect - // to the origin. - // - // * match-viewer – CloudFront connects to the origin using the - // same protocol that the viewer used to connect to CloudFront. - // - // * https-only – - // CloudFront always uses HTTPS to connect to the origin. + // - http-only – CloudFront always uses HTTP to connect to the origin. + // - match-viewer – CloudFront connects to the origin using the same protocol + // that the viewer used to connect to CloudFront. + // - https-only – CloudFront always uses HTTPS to connect to the origin. // // This member is required. OriginProtocolPolicy OriginProtocolPolicy @@ -1268,23 +1149,20 @@ type CustomOriginConfig struct { // Specifies how long, in seconds, CloudFront persists its connection to the // origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the // default (if you don't specify otherwise) is 5 seconds. For more information, see - // Origin Keep-alive Timeout - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) + // Origin Keep-alive Timeout (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) // in the Amazon CloudFront Developer Guide. OriginKeepaliveTimeout *int32 - // Specifies how long, in seconds, CloudFront waits for a response from the origin. - // This is also known as the origin response timeout. The minimum timeout is 1 - // second, the maximum is 60 seconds, and the default (if you don't specify - // otherwise) is 30 seconds. For more information, see Origin Response Timeout - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) + // Specifies how long, in seconds, CloudFront waits for a response from the + // origin. This is also known as the origin response timeout. The minimum timeout + // is 1 second, the maximum is 60 seconds, and the default (if you don't specify + // otherwise) is 30 seconds. For more information, see Origin Response Timeout (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) // in the Amazon CloudFront Developer Guide. OriginReadTimeout *int32 // Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to - // your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2. - // For more information, see Minimum Origin SSL Protocol - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) + // your origin over HTTPS. Valid values include SSLv3 , TLSv1 , TLSv1.1 , and + // TLSv1.2 . For more information, see Minimum Origin SSL Protocol (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) // in the Amazon CloudFront Developer Guide. OriginSslProtocols *OriginSslProtocols @@ -1293,8 +1171,8 @@ type CustomOriginConfig struct { // A complex type that describes the default cache behavior if you don't specify a // CacheBehavior element or if request URLs don't match any of the values of -// PathPattern in CacheBehavior elements. You must create exactly one default cache -// behavior. +// PathPattern in CacheBehavior elements. You must create exactly one default +// cache behavior. type DefaultCacheBehavior struct { // The value of ID for the origin that you want CloudFront to route requests to @@ -1303,32 +1181,24 @@ type DefaultCacheBehavior struct { // This member is required. TargetOriginId *string - // The protocol that viewers can use to access the files in the origin specified by - // TargetOriginId when a request matches the path pattern in PathPattern. You can - // specify the following options: - // - // * allow-all: Viewers can use HTTP or HTTPS. - // - // * - // redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an - // HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS - // URL. The viewer then resubmits the request using the new URL. - // - // * https-only: If - // a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 - // (Forbidden). - // - // For more information about requiring the HTTPS protocol, see - // Requiring HTTPS Between Viewers and CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) + // The protocol that viewers can use to access the files in the origin specified + // by TargetOriginId when a request matches the path pattern in PathPattern . You + // can specify the following options: + // - allow-all : Viewers can use HTTP or HTTPS. + // - redirect-to-https : If a viewer submits an HTTP request, CloudFront returns + // an HTTP status code of 301 (Moved Permanently) to the viewer along with the + // HTTPS URL. The viewer then resubmits the request using the new URL. + // - https-only : If a viewer sends an HTTP request, CloudFront returns an HTTP + // status code of 403 (Forbidden). + // For more information about requiring the HTTPS protocol, see Requiring HTTPS + // Between Viewers and CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) // in the Amazon CloudFront Developer Guide. The only way to guarantee that viewers // retrieve an object that was fetched from the origin using HTTPS is never to use // any other protocol to fetch the object. If you have recently changed from HTTP // to HTTPS, we recommend that you clear your objects' cache because cached objects // are protocol agnostic. That means that an edge location will return an object // from the cache regardless of whether the current request protocol matches the - // protocol used previously. For more information, see Managing Cache Expiration - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // protocol used previously. For more information, see Managing Cache Expiration (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -1337,53 +1207,41 @@ type DefaultCacheBehavior struct { // A complex type that controls which HTTP methods CloudFront processes and // forwards to your Amazon S3 bucket or your custom origin. There are three // choices: - // - // * CloudFront forwards only GET and HEAD requests. - // - // * CloudFront - // forwards only GET, HEAD, and OPTIONS requests. - // - // * CloudFront forwards GET, HEAD, - // OPTIONS, PUT, PATCH, POST, and DELETE requests. - // - // If you pick the third choice, - // you may need to restrict access to your Amazon S3 bucket or to your custom - // origin so users can't perform operations that you don't want them to. For - // example, you might not want users to have permissions to delete objects from - // your origin. + // - CloudFront forwards only GET and HEAD requests. + // - CloudFront forwards only GET , HEAD , and OPTIONS requests. + // - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST , and DELETE + // requests. + // If you pick the third choice, you may need to restrict access to your Amazon S3 + // bucket or to your custom origin so users can't perform operations that you don't + // want them to. For example, you might not want users to have permissions to + // delete objects from your origin. AllowedMethods *AllowedMethods // The unique identifier of the cache policy that is attached to the default cache - // behavior. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // behavior. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. A DefaultCacheBehavior must include - // either a CachePolicyId or ForwardedValues. We recommend that you use a - // CachePolicyId. + // either a CachePolicyId or ForwardedValues . We recommend that you use a + // CachePolicyId . CachePolicyId *string // Whether you want CloudFront to automatically compress certain files for this - // cache behavior. If so, specify true; if not, specify false. For more - // information, see Serving Compressed Files - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) + // cache behavior. If so, specify true ; if not, specify false . For more + // information, see Serving Compressed Files (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) // in the Amazon CloudFront Developer Guide. Compress *bool // This field is deprecated. We recommend that you use the DefaultTTL field in a // cache policy instead of this field. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The default amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. The // value that you specify applies only when your origin does not add HTTP headers - // such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. - // For more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // such as Cache-Control max-age , Cache-Control s-maxage , and Expires to + // objects. For more information, see Managing How Long Content Stays in an Edge + // Cache (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // Deprecated: This member has been deprecated. @@ -1396,22 +1254,17 @@ type DefaultCacheBehavior struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. For more information, see Working with - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) // in the Amazon CloudFront Developer Guide. If you want to include values in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. If you want to send values to the // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) // in the Amazon CloudFront Developer Guide. A DefaultCacheBehavior must include - // either a CachePolicyId or ForwardedValues. We recommend that you use a - // CachePolicyId. A complex type that specifies how CloudFront handles query + // either a CachePolicyId or ForwardedValues . We recommend that you use a + // CachePolicyId . A complex type that specifies how CloudFront handles query // strings, cookies, and HTTP headers. // // Deprecated: This member has been deprecated. @@ -1427,52 +1280,44 @@ type DefaultCacheBehavior struct { LambdaFunctionAssociations *LambdaFunctionAssociations // This field is deprecated. We recommend that you use the MaxTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policy instead of this field. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The maximum amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. The // value that you specify applies only when your origin adds HTTP headers such as - // Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more - // information, see Managing How Long Content Stays in an Edge Cache (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // Cache-Control max-age , Cache-Control s-maxage , and Expires to objects. For + // more information, see Managing How Long Content Stays in an Edge Cache + // (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. // // Deprecated: This member has been deprecated. MaxTTL *int64 // This field is deprecated. We recommend that you use the MinTTL field in a cache - // policy instead of this field. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) - // or Using the managed cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) + // policy instead of this field. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // or Using the managed cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) // in the Amazon CloudFront Developer Guide. The minimum amount of time that you // want objects to stay in CloudFront caches before CloudFront forwards another // request to your origin to determine whether the object has been updated. For // more information, see Managing How Long Content Stays in an Edge Cache - // (Expiration) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) + // (Expiration) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) // in the Amazon CloudFront Developer Guide. You must specify 0 for MinTTL if you - // configure CloudFront to forward all headers to your origin (under Headers, if - // you specify 1 for Quantity and * for Name). + // configure CloudFront to forward all headers to your origin (under Headers , if + // you specify 1 for Quantity and * for Name ). // // Deprecated: This member has been deprecated. MinTTL *int64 // The unique identifier of the origin request policy that is attached to the // default cache behavior. For more information, see Creating origin request - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) - // or Using the managed origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // or Using the managed origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) // in the Amazon CloudFront Developer Guide. OriginRequestPolicyId *string // The Amazon Resource Name (ARN) of the real-time log configuration that is - // attached to this cache behavior. For more information, see Real-time logs - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) + // attached to this cache behavior. For more information, see Real-time logs (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) // in the Amazon CloudFront Developer Guide. RealtimeLogConfigArn *string @@ -1481,9 +1326,9 @@ type DefaultCacheBehavior struct { // Indicates whether you want to distribute media files in the Microsoft Smooth // Streaming format using the origin that is associated with this cache behavior. - // If so, specify true; if not, specify false. If you specify true for - // SmoothStreaming, you can still distribute other content using this cache - // behavior if the content matches the value of PathPattern. + // If so, specify true ; if not, specify false . If you specify true for + // SmoothStreaming , you can still distribute other content using this cache + // behavior if the content matches the value of PathPattern . SmoothStreaming *bool // A list of key groups that CloudFront can use to validate signed URLs or signed @@ -1492,12 +1337,11 @@ type DefaultCacheBehavior struct { // The URLs or cookies must be signed with a private key whose corresponding public // key is in the key group. The signed URL or cookie contains information about // which public key CloudFront should use to verify the signature. For more - // information, see Serving private content - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // information, see Serving private content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. TrustedKeyGroups *TrustedKeyGroups - // We recommend using TrustedKeyGroups instead of TrustedSigners. A list of Amazon + // We recommend using TrustedKeyGroups instead of TrustedSigners . A list of Amazon // Web Services account IDs whose public keys CloudFront can use to validate signed // URLs or signed cookies. When a cache behavior contains trusted signers, // CloudFront requires signed URLs or signed cookies for all requests that match @@ -1505,16 +1349,15 @@ type DefaultCacheBehavior struct { // CloudFront key pair in a trusted signer's Amazon Web Services account. The // signed URL or cookie contains information about which public key CloudFront // should use to verify the signature. For more information, see Serving private - // content - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. TrustedSigners *TrustedSigners noSmithyDocumentSerde } -// A distribution tells CloudFront where you want content to be delivered from, and -// the details about how to track and manage content delivery. +// A distribution tells CloudFront where you want content to be delivered from, +// and the details about how to track and manage content delivery. type Distribution struct { // The distribution's Amazon Resource Name (ARN). @@ -1528,12 +1371,12 @@ type Distribution struct { DistributionConfig *DistributionConfig // The distribution's CloudFront domain name. For example: - // d111111abcdef8.cloudfront.net. + // d111111abcdef8.cloudfront.net . // // This member is required. DomainName *string - // The distribution's identifier. For example: E1U5RQF7T870K0. + // The distribution's identifier. For example: E1U5RQF7T870K0 . // // This member is required. Id *string @@ -1548,7 +1391,7 @@ type Distribution struct { // This member is required. LastModifiedTime *time.Time - // The distribution's status. When the status is Deployed, the distribution's + // The distribution's status. When the status is Deployed , the distribution's // information is fully propagated to all CloudFront edge locations. // // This member is required. @@ -1559,7 +1402,7 @@ type Distribution struct { // cookies. ActiveTrustedKeyGroups *ActiveTrustedKeyGroups - // We recommend using TrustedKeyGroups instead of TrustedSigners. This field + // We recommend using TrustedKeyGroups instead of TrustedSigners . This field // contains a list of Amazon Web Services account IDs and the active CloudFront key // pairs in each account that CloudFront can use to verify the signatures of signed // URLs or signed cookies. @@ -1569,9 +1412,8 @@ type Distribution struct { // Content Provider (ICP) recordal if they want to serve content publicly on an // alternate domain name, also known as a CNAME, that they've added to CloudFront. // AliasICPRecordal provides the ICP recordal status for CNAMEs associated with - // distributions. For more information about ICP recordals, see Signup, Accounts, - // and Credentials - // (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) + // distributions. For more information about ICP recordals, see Signup, Accounts, + // and Credentials (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) // in Getting Started with Amazon Web Services services in China. AliasICPRecordals []AliasICPRecordal @@ -1622,82 +1464,67 @@ type DistributionConfig struct { CacheBehaviors *CacheBehaviors // The identifier of a continuous deployment policy. For more information, see - // CreateContinuousDeploymentPolicy. + // CreateContinuousDeploymentPolicy . ContinuousDeploymentPolicyId *string // A complex type that controls the following: - // - // * Whether CloudFront replaces HTTP - // status codes in the 4xx and 5xx range with custom error messages before - // returning the response to the viewer. - // - // * How long CloudFront caches HTTP status - // codes in the 4xx and 5xx range. - // - // For more information about custom error pages, - // see Customizing Error Responses - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) + // - Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with + // custom error messages before returning the response to the viewer. + // - How long CloudFront caches HTTP status codes in the 4xx and 5xx range. + // For more information about custom error pages, see Customizing Error Responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) // in the Amazon CloudFront Developer Guide. CustomErrorResponses *CustomErrorResponses // The object that you want CloudFront to request from your origin (for example, - // index.html) when a viewer requests the root URL for your distribution - // (https://www.example.com) instead of an object in your distribution - // (https://www.example.com/product-description.html). Specifying a default root + // index.html ) when a viewer requests the root URL for your distribution ( + // https://www.example.com ) instead of an object in your distribution ( + // https://www.example.com/product-description.html ). Specifying a default root // object avoids exposing the contents of your distribution. Specify only the - // object name, for example, index.html. Don't add a / before the object name. If + // object name, for example, index.html . Don't add a / before the object name. If // you don't want to specify a default root object when you create a distribution, // include an empty DefaultRootObject element. To delete the default root object // from an existing distribution, update the distribution configuration and include // an empty DefaultRootObject element. To replace the default root object, update // the distribution configuration and specify the new object. For more information - // about the default root object, see Creating a Default Root Object - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) + // about the default root object, see Creating a Default Root Object (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) // in the Amazon CloudFront Developer Guide. DefaultRootObject *string // (Optional) Specify the maximum HTTP version(s) that you want viewers to use to // communicate with CloudFront. The default value for new web distributions is - // http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP + // http2 . Viewers that don't support HTTP/2 automatically use an earlier HTTP // version. For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 // or later, and must support Server Name Indication (SNI). For viewers and // CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name // Indication (SNI). CloudFront supports HTTP/3 connection migration to allow the // viewer to switch networks without losing connection. For more information about - // connection migration, see Connection Migration - // (https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC - // 9000. For more information about supported TLSv1.3 ciphers, see Supported - // protocols and ciphers between viewers and CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html). + // connection migration, see Connection Migration (https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) + // at RFC 9000. For more information about supported TLSv1.3 ciphers, see + // Supported protocols and ciphers between viewers and CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html) + // . HttpVersion HttpVersion // If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for - // your distribution, specify true. If you specify false, CloudFront responds to + // your distribution, specify true . If you specify false , CloudFront responds to // IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. // This allows viewers to submit a second request, for an IPv4 address for your // distribution. In general, you should enable IPv6 if you have users on IPv6 // networks who want to access your content. However, if you're using signed URLs // or signed cookies to restrict access to your content, and if you're using a - // custom policy that includes the IpAddress parameter to restrict the IP addresses - // that can access your content, don't enable IPv6. If you want to restrict access - // to some content by IP address and not restrict access to other content (or - // restrict access but not by IP address), you can create two distributions. For - // more information, see Creating a Signed URL Using a Custom Policy - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) + // custom policy that includes the IpAddress parameter to restrict the IP + // addresses that can access your content, don't enable IPv6. If you want to + // restrict access to some content by IP address and not restrict access to other + // content (or restrict access but not by IP address), you can create two + // distributions. For more information, see Creating a Signed URL Using a Custom + // Policy (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) // in the Amazon CloudFront Developer Guide. If you're using an Route 53 Amazon Web // Services Integration alias resource record set to route traffic to your // CloudFront distribution, you need to create a second alias resource record set // when both of the following are true: - // - // * You enable IPv6 for the distribution - // - // * - // You're using alternate domain names in the URLs for your objects - // - // For more - // information, see Routing Traffic to an Amazon CloudFront Web Distribution by - // Using Your Domain Name - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) + // - You enable IPv6 for the distribution + // - You're using alternate domain names in the URLs for your objects + // For more information, see Routing Traffic to an Amazon CloudFront Web + // Distribution by Using Your Domain Name (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) // in the Route 53 Amazon Web Services Integration Developer Guide. If you created // a CNAME resource record set, either with Route 53 Amazon Web Services // Integration or with another DNS service, you don't need to make any changes. A @@ -1706,8 +1533,7 @@ type DistributionConfig struct { IsIPV6Enabled *bool // A complex type that controls whether access logs are written for the - // distribution. For more information about logging, see Access Logs - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) + // distribution. For more information about logging, see Access Logs (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) // in the Amazon CloudFront Developer Guide. Logging *LoggingConfig @@ -1715,28 +1541,27 @@ type DistributionConfig struct { // distribution. OriginGroups *OriginGroups - // The price class that corresponds with the maximum price that you want to pay for - // CloudFront service. If you specify PriceClass_All, CloudFront responds to + // The price class that corresponds with the maximum price that you want to pay + // for CloudFront service. If you specify PriceClass_All , CloudFront responds to // requests for your objects from all CloudFront edge locations. If you specify a - // price class other than PriceClass_All, CloudFront serves your objects from the + // price class other than PriceClass_All , CloudFront serves your objects from the // CloudFront edge location that has the lowest latency among the edge locations in // your price class. Viewers who are in or near regions that are excluded from your // specified price class may encounter slower performance. For more information - // about price classes, see Choosing the Price Class for a CloudFront Distribution - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) + // about price classes, see Choosing the Price Class for a CloudFront Distribution (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) // in the Amazon CloudFront Developer Guide. For information about CloudFront // pricing, including how price classes (such as Price Class 100) map to CloudFront - // regions, see Amazon CloudFront Pricing - // (http://aws.amazon.com/cloudfront/pricing/). + // regions, see Amazon CloudFront Pricing (http://aws.amazon.com/cloudfront/pricing/) + // . PriceClass PriceClass // A complex type that identifies ways in which you want to restrict distribution // of your content. Restrictions *Restrictions - // A Boolean that indicates whether this is a staging distribution. When this value - // is true, this is a staging distribution. When this value is false, this is not a - // staging distribution. + // A Boolean that indicates whether this is a staging distribution. When this + // value is true , this is a staging distribution. When this value is false , this + // is not a staging distribution. Staging *bool // A complex type that determines the distribution's SSL/TLS configuration for @@ -1746,17 +1571,17 @@ type DistributionConfig struct { // A unique identifier that specifies the WAF web ACL, if any, to associate with // this distribution. To specify a web ACL created using the latest version of WAF, // use the ACL ARN, for example - // arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. - // To specify a web ACL created using WAF Classic, use the ACL ID, for example - // 473e64fd-f30b-4765-81a0-62ad96dd167a. WAF is a web application firewall that + // arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a + // . To specify a web ACL created using WAF Classic, use the ACL ID, for example + // 473e64fd-f30b-4765-81a0-62ad96dd167a . WAF is a web application firewall that // lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, // and lets you control access to your content. Based on conditions that you // specify, such as the IP addresses that requests originate from or the values of // query strings, CloudFront responds to requests either with the requested content // or with an HTTP 403 status code (Forbidden). You can also configure CloudFront // to return a custom error page when a request is blocked. For more information - // about WAF, see the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). + // about WAF, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html) + // . WebACLId *string noSmithyDocumentSerde @@ -1782,8 +1607,8 @@ type DistributionConfigWithTags struct { // A list of distribution IDs. type DistributionIdList struct { - // A flag that indicates whether more distribution IDs remain to be listed. If your - // results were truncated, you can make a subsequent request using the Marker + // A flag that indicates whether more distribution IDs remain to be listed. If + // your results were truncated, you can make a subsequent request using the Marker // request field to retrieve more distribution IDs in the list. // // This member is required. @@ -1834,8 +1659,8 @@ type DistributionList struct { // This member is required. MaxItems *int32 - // The number of distributions that were created by the current Amazon Web Services - // account. + // The number of distributions that were created by the current Amazon Web + // Services account. // // This member is required. Quantity *int32 @@ -1844,7 +1669,7 @@ type DistributionList struct { // distribution that was created by the current Amazon Web Services account. Items []DistributionSummary - // If IsTruncated is true, this element is present and contains the value you can + // If IsTruncated is true , this element is present and contains the value you can // use for the Marker request parameter to continue listing your distributions // where they left off. NextMarker *string @@ -1856,7 +1681,7 @@ type DistributionList struct { type DistributionSummary struct { // The ARN (Amazon Resource Name) for the distribution. For example: - // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where + // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where // 123456789012 is your Amazon Web Services account ID. // // This member is required. @@ -1891,7 +1716,7 @@ type DistributionSummary struct { DefaultCacheBehavior *DefaultCacheBehavior // The domain name that corresponds to the distribution, for example, - // d111111abcdef8.cloudfront.net. + // d111111abcdef8.cloudfront.net . // // This member is required. DomainName *string @@ -1902,13 +1727,13 @@ type DistributionSummary struct { Enabled *bool // Specify the maximum HTTP version that you want viewers to use to communicate - // with CloudFront. The default value for new web distributions is http2. Viewers + // with CloudFront. The default value for new web distributions is http2 . Viewers // that don't support HTTP/2 will automatically use an earlier version. // // This member is required. HttpVersion HttpVersion - // The identifier for the distribution. For example: EDFDVBD632BHDS5. + // The identifier for the distribution. For example: EDFDVBD632BHDS5 . // // This member is required. Id *string @@ -1946,7 +1771,7 @@ type DistributionSummary struct { // This member is required. Staging *bool - // The current status of the distribution. When the status is Deployed, the + // The current status of the distribution. When the status is Deployed , the // distribution's information is propagated to all CloudFront edge locations. // // This member is required. @@ -1967,9 +1792,8 @@ type DistributionSummary struct { // Content Provider (ICP) recordal if they want to serve content publicly on an // alternate domain name, also known as a CNAME, that they've added to CloudFront. // AliasICPRecordal provides the ICP recordal status for CNAMEs associated with - // distributions. For more information about ICP recordals, see Signup, Accounts, - // and Credentials - // (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) + // distributions. For more information about ICP recordals, see Signup, Accounts, + // and Credentials (https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html) // in Getting Started with Amazon Web Services services in China. AliasICPRecordals []AliasICPRecordal @@ -2030,8 +1854,8 @@ type EncryptionEntity struct { // real-time log data in a real-time log configuration. type EndPoint struct { - // The type of data stream where you are sending real-time log data. The only valid - // value is Kinesis. + // The type of data stream where you are sending real-time log data. The only + // valid value is Kinesis . // // This member is required. StreamType *string @@ -2053,8 +1877,8 @@ type FieldLevelEncryption struct { // This member is required. FieldLevelEncryptionConfig *FieldLevelEncryptionConfig - // The configuration ID for a field-level encryption configuration which includes a - // set of profiles that specify certain selected data fields to be encrypted by + // The configuration ID for a field-level encryption configuration which includes + // a set of profiles that specify certain selected data fields to be encrypted by // specific public keys. // // This member is required. @@ -2238,8 +2062,8 @@ type FieldLevelEncryptionSummary struct { // This member is required. LastModifiedTime *time.Time - // An optional comment about the field-level encryption item. The comment cannot be - // longer than 128 characters. + // An optional comment about the field-level encryption item. The comment cannot + // be longer than 128 characters. Comment *string // A summary of a content type-profile mapping. @@ -2268,29 +2092,24 @@ type FieldPatterns struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include values in the cache -// key, use a cache policy. For more information, see Creating cache policies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) +// key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send values to the // origin but not include them in the cache key, use an origin request policy. For -// more information, see Creating origin request policies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) +// more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. A complex type that specifies how // CloudFront handles query strings, cookies, and HTTP headers. type ForwardedValues struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include cookies in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send cookies to the // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. A complex type that specifies whether // you want CloudFront to forward cookies to the origin and, if so, which ones. For // more information about forwarding cookies to the origin, see How CloudFront - // Forwards, Caches, and Logs Cookies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) + // Forwards, Caches, and Logs Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -2299,29 +2118,26 @@ type ForwardedValues struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include query strings in // the cache key, use a cache policy. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send query strings to // the origin but not include them in the cache key, use an origin request policy. - // For more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // For more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. Indicates whether you want CloudFront // to forward query strings to the origin that is associated with this cache // behavior and cache based on the query string parameters. CloudFront behavior // depends on the value of QueryString and on the values that you specify for - // QueryStringCacheKeys, if any: If you specify true for QueryString and you don't - // specify any values for QueryStringCacheKeys, CloudFront forwards all query - // string parameters to the origin and caches based on all query string parameters. - // Depending on how many query string parameters and values you have, this can - // adversely affect performance because CloudFront must forward more requests to - // the origin. If you specify true for QueryString and you specify one or more - // values for QueryStringCacheKeys, CloudFront forwards all query string parameters - // to the origin, but it only caches based on the query string parameters that you - // specify. If you specify false for QueryString, CloudFront doesn't forward any - // query string parameters to the origin, and doesn't cache based on query string - // parameters. For more information, see Configuring CloudFront to Cache Based on - // Query String Parameters - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) + // QueryStringCacheKeys , if any: If you specify true for QueryString and you + // don't specify any values for QueryStringCacheKeys , CloudFront forwards all + // query string parameters to the origin and caches based on all query string + // parameters. Depending on how many query string parameters and values you have, + // this can adversely affect performance because CloudFront must forward more + // requests to the origin. If you specify true for QueryString and you specify one + // or more values for QueryStringCacheKeys , CloudFront forwards all query string + // parameters to the origin, but it only caches based on the query string + // parameters that you specify. If you specify false for QueryString , CloudFront + // doesn't forward any query string parameters to the origin, and doesn't cache + // based on query string parameters. For more information, see Configuring + // CloudFront to Cache Based on Query String Parameters (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -2329,31 +2145,26 @@ type ForwardedValues struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include headers in the - // cache key, use a cache policy. For more information, see Creating cache policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send headers to the // origin but not include them in the cache key, use an origin request policy. For - // more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. A complex type that specifies the - // Headers, if any, that you want CloudFront to forward to the origin for this + // Headers , if any, that you want CloudFront to forward to the origin for this // cache behavior (whitelisted headers). For the headers that you specify, // CloudFront also caches separate versions of a specified object that is based on - // the header values in viewer requests. For more information, see Caching Content - // Based on Request Headers - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) + // the header values in viewer requests. For more information, see Caching Content + // Based on Request Headers (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) // in the Amazon CloudFront Developer Guide. Headers *Headers // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include query strings in // the cache key, use a cache policy. For more information, see Creating cache - // policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) + // policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) // in the Amazon CloudFront Developer Guide. If you want to send query strings to // the origin but not include them in the cache key, use an origin request policy. - // For more information, see Creating origin request policies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) + // For more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) // in the Amazon CloudFront Developer Guide. A complex type that contains // information about the query string parameters that you want CloudFront to use // for caching for this cache behavior. @@ -2366,9 +2177,9 @@ type ForwardedValues struct { // distribution. type FunctionAssociation struct { - // The event type of the function, either viewer-request or viewer-response. You - // cannot use origin-facing event types (origin-request and origin-response) with a - // CloudFront function. + // The event type of the function, either viewer-request or viewer-response . You + // cannot use origin-facing event types ( origin-request and origin-response ) with + // a CloudFront function. // // This member is required. EventType EventType @@ -2407,7 +2218,7 @@ type FunctionConfig struct { // This member is required. Comment *string - // The function's runtime environment. The only valid value is cloudfront-js-1.0. + // The function's runtime environment. The only valid value is cloudfront-js-1.0 . // // This member is required. Runtime FunctionRuntime @@ -2456,9 +2267,9 @@ type FunctionMetadata struct { // The date and time when the function was created. CreatedTime *time.Time - // The stage that the function is in, either DEVELOPMENT or LIVE. When a function - // is in the DEVELOPMENT stage, you can test the function with TestFunction, and - // update it with UpdateFunction. When a function is in the LIVE stage, you can + // The stage that the function is in, either DEVELOPMENT or LIVE . When a function + // is in the DEVELOPMENT stage, you can test the function with TestFunction , and + // update it with UpdateFunction . When a function is in the LIVE stage, you can // attach the function to a distribution's cache behavior, using the function's // ARN. Stage FunctionStage @@ -2490,40 +2301,37 @@ type FunctionSummary struct { noSmithyDocumentSerde } -// A complex type that controls the countries in which your content is distributed. -// CloudFront determines the location of your users using MaxMind GeoIP databases. +// A complex type that controls the countries in which your content is +// distributed. CloudFront determines the location of your users using MaxMind +// GeoIP databases. type GeoRestriction struct { - // When geo restriction is enabled, this is the number of countries in your - // whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and - // you can omit Items. + // When geo restriction is enabled , this is the number of countries in your + // whitelist or blacklist . Otherwise, when it is not enabled, Quantity is 0 , and + // you can omit Items . // // This member is required. Quantity *int32 // The method that you want to use to restrict distribution of your content by // country: - // - // * none: No geo restriction is enabled, meaning access to content is - // not restricted by client geo location. - // - // * blacklist: The Location elements - // specify the countries in which you don't want CloudFront to distribute your - // content. - // - // * whitelist: The Location elements specify the countries in which you - // want CloudFront to distribute your content. + // - none : No geo restriction is enabled, meaning access to content is not + // restricted by client geo location. + // - blacklist : The Location elements specify the countries in which you don't + // want CloudFront to distribute your content. + // - whitelist : The Location elements specify the countries in which you want + // CloudFront to distribute your content. // // This member is required. RestrictionType GeoRestrictionType // A complex type that contains a Location element for each country in which you - // want CloudFront either to distribute your content (whitelist) or not distribute - // your content (blacklist). The Location element is a two-letter, uppercase - // country code for a country that you want to include in your blacklist or - // whitelist. Include one Location element for each country. CloudFront and MaxMind - // both use ISO 3166 country codes. For the current list of countries and the - // corresponding codes, see ISO 3166-1-alpha-2 code on the International + // want CloudFront either to distribute your content ( whitelist ) or not + // distribute your content ( blacklist ). The Location element is a two-letter, + // uppercase country code for a country that you want to include in your blacklist + // or whitelist . Include one Location element for each country. CloudFront and + // MaxMind both use ISO 3166 country codes. For the current list of countries and + // the corresponding codes, see ISO 3166-1-alpha-2 code on the International // Organization for Standardization website. You can also refer to the country list // on the CloudFront console, which includes both country names and codes. Items []string @@ -2553,7 +2361,7 @@ type Invalidation struct { // This member is required. CreateTime *time.Time - // The identifier for the invalidation request. For example: IDFDVBD632BHDS5. + // The identifier for the invalidation request. For example: IDFDVBD632BHDS5 . // // This member is required. Id *string @@ -2563,8 +2371,8 @@ type Invalidation struct { // This member is required. InvalidationBatch *InvalidationBatch - // The status of the invalidation request. When the invalidation batch is finished, - // the status is Completed. + // The status of the invalidation request. When the invalidation batch is + // finished, the status is Completed . // // This member is required. Status *string @@ -2580,21 +2388,20 @@ type InvalidationBatch struct { // identical request. Whenever you create a new invalidation request, you must // specify a new value for CallerReference and change other values in the request // as applicable. One way to ensure that the value of CallerReference is unique is - // to use a timestamp, for example, 20120301090000. If you make a second - // invalidation request with the same value for CallerReference, and if the rest of - // the request is the same, CloudFront doesn't create a new invalidation request. - // Instead, CloudFront returns information about the invalidation request that you - // previously created with the same CallerReference. If CallerReference is a value - // you already sent in a previous invalidation batch request but the content of any - // Path is different from the original request, CloudFront returns an - // InvalidationBatchAlreadyExists error. + // to use a timestamp , for example, 20120301090000 . If you make a second + // invalidation request with the same value for CallerReference , and if the rest + // of the request is the same, CloudFront doesn't create a new invalidation + // request. Instead, CloudFront returns information about the invalidation request + // that you previously created with the same CallerReference . If CallerReference + // is a value you already sent in a previous invalidation batch request but the + // content of any Path is different from the original request, CloudFront returns + // an InvalidationBatchAlreadyExists error. // // This member is required. CallerReference *string // A complex type that contains information about the objects that you want to - // invalidate. For more information, see Specifying the Objects to Invalidate - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) + // invalidate. For more information, see Specifying the Objects to Invalidate (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -2605,15 +2412,14 @@ type InvalidationBatch struct { // The InvalidationList complex type describes the list of invalidation objects. // For more information about invalidation, see Invalidating Objects (Web -// Distributions Only) -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) +// Distributions Only) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) // in the Amazon CloudFront Developer Guide. type InvalidationList struct { // A flag that indicates whether more invalidation batch requests remain to be // listed. If your results were truncated, you can make a follow-up pagination - // request using the Marker request parameter to retrieve more invalidation batches - // in the list. + // request using the Marker request parameter to retrieve more invalidation + // batches in the list. // // This member is required. IsTruncated *bool @@ -2638,7 +2444,7 @@ type InvalidationList struct { // invalidation batch created by the current Amazon Web Services account. Items []InvalidationSummary - // If IsTruncated is true, this element is present and contains the value that you + // If IsTruncated is true , this element is present and contains the value that you // can use for the Marker request parameter to continue listing your invalidation // batches where they left off. NextMarker *string @@ -2668,8 +2474,8 @@ type InvalidationSummary struct { } // A key group. A key group contains a list of public keys that you can use with -// CloudFront signed URLs and signed cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html). +// CloudFront signed URLs and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// . type KeyGroup struct { // The identifier for the key group. @@ -2691,8 +2497,8 @@ type KeyGroup struct { } // A key group configuration. A key group contains a list of public keys that you -// can use with CloudFront signed URLs and signed cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html). +// can use with CloudFront signed URLs and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// . type KeyGroupConfig struct { // A list of the identifiers of the public keys in the key group. @@ -2780,8 +2586,7 @@ type KinesisStreamConfig struct { // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role // that CloudFront can use to send real-time log data to your Kinesis data stream. - // For more information the IAM role, see Real-time log configuration IAM role - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) + // For more information the IAM role, see Real-time log configuration IAM role (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -2801,25 +2606,19 @@ type LambdaFunctionAssociation struct { // Specifies the event type that triggers a Lambda@Edge function invocation. You // can specify the following values: - // - // * viewer-request: The function executes when - // CloudFront receives a request from a viewer and before it checks to see whether - // the requested object is in the edge cache. - // - // * origin-request: The function - // executes only when CloudFront sends a request to your origin. When the requested - // object is in the edge cache, the function doesn't execute. - // - // * origin-response: - // The function executes after CloudFront receives a response from the origin and - // before it caches the object in the response. When the requested object is in the - // edge cache, the function doesn't execute. - // - // * viewer-response: The function - // executes before CloudFront returns the requested object to the viewer. The - // function executes regardless of whether the object was already in the edge - // cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the - // function doesn't execute. + // - viewer-request : The function executes when CloudFront receives a request + // from a viewer and before it checks to see whether the requested object is in the + // edge cache. + // - origin-request : The function executes only when CloudFront sends a request + // to your origin. When the requested object is in the edge cache, the function + // doesn't execute. + // - origin-response : The function executes after CloudFront receives a response + // from the origin and before it caches the object in the response. When the + // requested object is in the edge cache, the function doesn't execute. + // - viewer-response : The function executes before CloudFront returns the + // requested object to the viewer. The function executes regardless of whether the + // object was already in the edge cache. If the origin returns an HTTP status code + // other than HTTP 200 (OK), the function doesn't execute. // // This member is required. EventType EventType @@ -2832,22 +2631,21 @@ type LambdaFunctionAssociation struct { // A flag that allows a Lambda@Edge function to have read access to the body // content. For more information, see Accessing the Request Body by Choosing the - // Include Body Option - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) + // Include Body Option (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) // in the Amazon CloudFront Developer Guide. IncludeBody *bool noSmithyDocumentSerde } -// A complex type that specifies a list of Lambda@Edge functions associations for a -// cache behavior. If you want to invoke one or more Lambda@Edge functions +// A complex type that specifies a list of Lambda@Edge functions associations for +// a cache behavior. If you want to invoke one or more Lambda@Edge functions // triggered by requests that match the PathPattern of the cache behavior, specify -// the applicable values for Quantity and Items. Note that there can be up to 4 +// the applicable values for Quantity and Items . Note that there can be up to 4 // LambdaFunctionAssociation items in this list (one for each possible value of -// EventType) and each EventType can be associated with only one function. If you +// EventType ) and each EventType can be associated with only one function. If you // don't want to invoke any Lambda@Edge functions for the requests that match -// PathPattern, specify 0 for Quantity and omit Items. +// PathPattern , specify 0 for Quantity and omit Items . type LambdaFunctionAssociations struct { // The number of Lambda@Edge function associations for this cache behavior. @@ -2856,7 +2654,7 @@ type LambdaFunctionAssociations struct { Quantity *int32 // Optional: A complex type that contains LambdaFunctionAssociation items for this - // cache behavior. If Quantity is 0, you can omit Items. + // cache behavior. If Quantity is 0 , you can omit Items . Items []LambdaFunctionAssociation noSmithyDocumentSerde @@ -2867,7 +2665,7 @@ type LambdaFunctionAssociations struct { type LoggingConfig struct { // The Amazon S3 bucket to store the access logs in, for example, - // myawslogbucket.s3.amazonaws.com. + // myawslogbucket.s3.amazonaws.com . // // This member is required. Bucket *string @@ -2875,25 +2673,25 @@ type LoggingConfig struct { // Specifies whether you want CloudFront to save access logs to an Amazon S3 // bucket. If you don't want to enable logging when you create a distribution or if // you want to disable logging for an existing distribution, specify false for - // Enabled, and specify empty Bucket and Prefix elements. If you specify false for - // Enabled but you specify values for Bucket, prefix, and IncludeCookies, the - // values are automatically deleted. + // Enabled , and specify empty Bucket and Prefix elements. If you specify false + // for Enabled but you specify values for Bucket , prefix , and IncludeCookies , + // the values are automatically deleted. // // This member is required. Enabled *bool - // Specifies whether you want CloudFront to include cookies in access logs, specify - // true for IncludeCookies. If you choose to include cookies in logs, CloudFront - // logs all cookies regardless of how you configure the cache behaviors for this - // distribution. If you don't want to include cookies when you create a + // Specifies whether you want CloudFront to include cookies in access logs, + // specify true for IncludeCookies . If you choose to include cookies in logs, + // CloudFront logs all cookies regardless of how you configure the cache behaviors + // for this distribution. If you don't want to include cookies when you create a // distribution or if you want to disable include cookies for an existing - // distribution, specify false for IncludeCookies. + // distribution, specify false for IncludeCookies . // // This member is required. IncludeCookies *bool // An optional string that you want CloudFront to prefix to the access log - // filenames for this distribution, for example, myprefix/. If you want to enable + // filenames for this distribution, for example, myprefix/ . If you want to enable // logging, but you don't want to specify a prefix, you still must include an empty // Prefix element in the Logging element. // @@ -2915,45 +2713,31 @@ type MonitoringSubscription struct { // An origin. An origin is the location where content is stored, and from which // CloudFront gets content to serve to viewers. To specify an origin: +// - Use S3OriginConfig to specify an Amazon S3 bucket that is not configured +// with static website hosting. +// - Use CustomOriginConfig to specify all other kinds of origins, including: +// - An Amazon S3 bucket that is configured with static website hosting +// - An Elastic Load Balancing load balancer +// - An AWS Elemental MediaPackage endpoint +// - An AWS Elemental MediaStore container +// - Any other HTTP server, running on an Amazon EC2 instance or any other kind +// of host // -// * Use -// S3OriginConfig to specify an Amazon S3 bucket that is not configured with static -// website hosting. -// -// * Use CustomOriginConfig to specify all other kinds of -// origins, including: -// -// * An Amazon S3 bucket that is configured with static -// website hosting -// -// * An Elastic Load Balancing load balancer -// -// * An AWS Elemental -// MediaPackage endpoint -// -// * An AWS Elemental MediaStore container -// -// * Any other HTTP -// server, running on an Amazon EC2 instance or any other kind of host -// -// For the -// current maximum number of origins that you can specify per distribution, see -// General Quotas on Web Distributions -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) +// For the current maximum number of origins that you can specify per +// distribution, see General Quotas on Web Distributions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) // in the Amazon CloudFront Developer Guide (quotas were formerly referred to as // limits). type Origin struct { - // The domain name for the origin. For more information, see Origin Domain Name - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) + // The domain name for the origin. For more information, see Origin Domain Name (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) // in the Amazon CloudFront Developer Guide. // // This member is required. DomainName *string // A unique identifier for the origin. This value must be unique within the - // distribution. Use this value to specify the TargetOriginId in a CacheBehavior or - // DefaultCacheBehavior. + // distribution. Use this value to specify the TargetOriginId in a CacheBehavior + // or DefaultCacheBehavior . // // This member is required. Id *string @@ -2963,25 +2747,21 @@ type Origin struct { // otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's // configured with static website hosting), this value also specifies the number of // times that CloudFront attempts to get a response from the origin, in the case of - // an Origin Response Timeout - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). - // For more information, see Origin Connection Attempts - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) + // an Origin Response Timeout (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) + // . For more information, see Origin Connection Attempts (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) // in the Amazon CloudFront Developer Guide. ConnectionAttempts *int32 // The number of seconds that CloudFront waits when trying to establish a // connection to the origin. The minimum timeout is 1 second, the maximum is 10 // seconds, and the default (if you don't specify otherwise) is 10 seconds. For - // more information, see Origin Connection Timeout - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) + // more information, see Origin Connection Timeout (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) // in the Amazon CloudFront Developer Guide. ConnectionTimeout *int32 - // A list of HTTP header names and values that CloudFront adds to the requests that - // it sends to the origin. For more information, see Adding Custom Headers to - // Origin Requests - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) + // A list of HTTP header names and values that CloudFront adds to the requests + // that it sends to the origin. For more information, see Adding Custom Headers to + // Origin Requests (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) // in the Amazon CloudFront Developer Guide. CustomHeaders *CustomHeaders @@ -2992,21 +2772,18 @@ type Origin struct { CustomOriginConfig *CustomOriginConfig // The unique identifier of an origin access control for this origin. For more - // information, see Restricting access to an Amazon S3 origin - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) + // information, see Restricting access to an Amazon S3 origin (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) // in the Amazon CloudFront Developer Guide. OriginAccessControlId *string // An optional path that CloudFront appends to the origin domain name when // CloudFront requests content from the origin. For more information, see Origin - // Path - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) + // Path (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) // in the Amazon CloudFront Developer Guide. OriginPath *string // CloudFront Origin Shield. Using Origin Shield can help reduce the load on your - // origin. For more information, see Using Origin Shield - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) + // origin. For more information, see Using Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) // in the Amazon CloudFront Developer Guide. OriginShield *OriginShield @@ -3048,34 +2825,28 @@ type OriginAccessControlConfig struct { // Specifies which requests CloudFront signs (adds authentication information to). // Specify always for the most common use case. For more information, see origin - // access control advanced settings - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) + // access control advanced settings (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) // in the Amazon CloudFront Developer Guide. This field can have one of the // following values: - // - // * always – CloudFront signs all origin requests, overwriting - // the Authorization header from the viewer request if one exists. - // - // * never – - // CloudFront doesn't sign any origin requests. This value turns off origin access - // control for all origins in all distributions that use this origin access - // control. - // - // * no-override – If the viewer request doesn't contain the - // Authorization header, then CloudFront signs the origin request. If the viewer - // request contains the Authorization header, then CloudFront doesn't sign the - // origin request and instead passes along the Authorization header from the viewer - // request. WARNING: To pass along the Authorization header from the viewer - // request, you must add the Authorization header to a cache policy - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) - // for all cache behaviors that use origins associated with this origin access - // control. + // - always – CloudFront signs all origin requests, overwriting the Authorization + // header from the viewer request if one exists. + // - never – CloudFront doesn't sign any origin requests. This value turns off + // origin access control for all origins in all distributions that use this origin + // access control. + // - no-override – If the viewer request doesn't contain the Authorization + // header, then CloudFront signs the origin request. If the viewer request contains + // the Authorization header, then CloudFront doesn't sign the origin request and + // instead passes along the Authorization header from the viewer request. + // WARNING: To pass along the Authorization header from the viewer request, you + // must add the Authorization header to a cache policy (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) + // for all cache behaviors that use origins associated with this origin access + // control. // // This member is required. SigningBehavior OriginAccessControlSigningBehaviors // The signing protocol of the origin access control, which determines how - // CloudFront signs (authenticates) requests. The only valid value is sigv4. + // CloudFront signs (authenticates) requests. The only valid value is sigv4 . // // This member is required. SigningProtocol OriginAccessControlSigningProtocols @@ -3090,7 +2861,7 @@ type OriginAccessControlConfig struct { type OriginAccessControlList struct { // If there are more items in the list than are in this response, this value is - // true. + // true . // // This member is required. IsTruncated *bool @@ -3146,26 +2917,20 @@ type OriginAccessControlSummary struct { // A value that specifies which requests CloudFront signs (adds authentication // information to). This field can have one of the following values: - // - // * never – - // CloudFront doesn't sign any origin requests. - // - // * always – CloudFront signs all - // origin requests, overwriting the Authorization header from the viewer request if - // necessary. - // - // * no-override – If the viewer request doesn't contain the - // Authorization header, CloudFront signs the origin request. If the viewer request - // contains the Authorization header, CloudFront doesn't sign the origin request, - // but instead passes along the Authorization header that it received in the viewer - // request. + // - never – CloudFront doesn't sign any origin requests. + // - always – CloudFront signs all origin requests, overwriting the Authorization + // header from the viewer request if necessary. + // - no-override – If the viewer request doesn't contain the Authorization + // header, CloudFront signs the origin request. If the viewer request contains the + // Authorization header, CloudFront doesn't sign the origin request, but instead + // passes along the Authorization header that it received in the viewer request. // // This member is required. SigningBehavior OriginAccessControlSigningBehaviors // The signing protocol of the origin access control. The signing protocol // determines how CloudFront signs (authenticates) requests. The only valid value - // is sigv4. + // is sigv4 . // // This member is required. SigningProtocol OriginAccessControlSigningProtocols @@ -3178,8 +2943,7 @@ type OriginAccessControlSummary struct { type OriginCustomHeader struct { // The name of a header that you want CloudFront to send to your origin. For more - // information, see Adding Custom Headers to Origin Requests - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) + // information, see Adding Custom Headers to Origin Requests (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -3220,9 +2984,9 @@ type OriginGroup struct { noSmithyDocumentSerde } -// A complex data type that includes information about the failover criteria for an -// origin group, including the status codes for which CloudFront will failover from -// the primary origin to the second origin. +// A complex data type that includes information about the failover criteria for +// an origin group, including the status codes for which CloudFront will failover +// from the primary origin to the second origin. type OriginGroupFailoverCriteria struct { // The status codes that, when returned from the primary origin, will trigger @@ -3279,22 +3043,18 @@ type OriginGroups struct { // request policy determines the values that CloudFront includes in requests that // it sends to the origin. Each request that CloudFront sends to the origin // includes the following: +// - The request body and the URL path (without the domain name) from the viewer +// request. +// - The headers that CloudFront automatically includes in every origin request, +// including Host , User-Agent , and X-Amz-Cf-Id . +// - All HTTP headers, cookies, and URL query strings that are specified in the +// cache policy or the origin request policy. These can include items from the +// viewer request and, in the case of headers, additional ones that are added by +// CloudFront. // -// * The request body and the URL path (without the domain -// name) from the viewer request. -// -// * The headers that CloudFront automatically -// includes in every origin request, including Host, User-Agent, and -// X-Amz-Cf-Id. -// -// * All HTTP headers, cookies, and URL query strings that are -// specified in the cache policy or the origin request policy. These can include -// items from the viewer request and, in the case of headers, additional ones that -// are added by CloudFront. -// -// CloudFront sends a request when it can't find an -// object in its cache that matches the request. If you want to send values to the -// origin and also include them in the cache key, use CachePolicy. +// CloudFront sends a request when it can't find an object in its cache that +// matches the request. If you want to send values to the origin and also include +// them in the cache key, use CachePolicy . type OriginRequestPolicy struct { // The unique identifier for the origin request policy. @@ -3315,26 +3075,21 @@ type OriginRequestPolicy struct { noSmithyDocumentSerde } -// An origin request policy configuration. This configuration determines the values -// that CloudFront includes in requests that it sends to the origin. Each request -// that CloudFront sends to the origin includes the following: -// -// * The request body -// and the URL path (without the domain name) from the viewer request. -// -// * The -// headers that CloudFront automatically includes in every origin request, -// including Host, User-Agent, and X-Amz-Cf-Id. -// -// * All HTTP headers, cookies, and -// URL query strings that are specified in the cache policy or the origin request -// policy. These can include items from the viewer request and, in the case of -// headers, additional ones that are added by CloudFront. +// An origin request policy configuration. This configuration determines the +// values that CloudFront includes in requests that it sends to the origin. Each +// request that CloudFront sends to the origin includes the following: +// - The request body and the URL path (without the domain name) from the viewer +// request. +// - The headers that CloudFront automatically includes in every origin request, +// including Host , User-Agent , and X-Amz-Cf-Id . +// - All HTTP headers, cookies, and URL query strings that are specified in the +// cache policy or the origin request policy. These can include items from the +// viewer request and, in the case of headers, additional ones that are added by +// CloudFront. // -// CloudFront sends a -// request when it can't find an object in its cache that matches the request. If -// you want to send values to the origin and also include them in the cache key, -// use CachePolicy. +// CloudFront sends a request when it can't find an object in its cache that +// matches the request. If you want to send values to the origin and also include +// them in the cache key, use CachePolicy . type OriginRequestPolicyConfig struct { // The cookies from viewer requests to include in origin requests. @@ -3371,22 +3126,16 @@ type OriginRequestPolicyCookiesConfig struct { // Determines whether cookies in viewer requests are included in requests that // CloudFront sends to the origin. Valid values are: - // - // * none – No cookies in viewer - // requests are included in requests that CloudFront sends to the origin. Even when - // this field is set to none, any cookies that are listed in a CachePolicy are - // included in origin requests. - // - // * whitelist – Only the cookies in viewer requests - // that are listed in the CookieNames type are included in requests that CloudFront - // sends to the origin. - // - // * all – All cookies in viewer requests are included in - // requests that CloudFront sends to the origin. - // - // * allExcept – All cookies in - // viewer requests are included in requests that CloudFront sends to the origin, - // except for those listed in the CookieNames type, which are not included. + // - none – No cookies in viewer requests are included in requests that + // CloudFront sends to the origin. Even when this field is set to none , any + // cookies that are listed in a CachePolicy are included in origin requests. + // - whitelist – Only the cookies in viewer requests that are listed in the + // CookieNames type are included in requests that CloudFront sends to the origin. + // - all – All cookies in viewer requests are included in requests that + // CloudFront sends to the origin. + // - allExcept – All cookies in viewer requests are included in requests that + // CloudFront sends to the origin, except for those listed in the CookieNames + // type, which are not included. // // This member is required. CookieBehavior OriginRequestPolicyCookieBehavior @@ -3403,28 +3152,20 @@ type OriginRequestPolicyHeadersConfig struct { // Determines whether any HTTP headers are included in requests that CloudFront // sends to the origin. Valid values are: - // - // * none – No HTTP headers in viewer - // requests are included in requests that CloudFront sends to the origin. Even when - // this field is set to none, any headers that are listed in a CachePolicy are - // included in origin requests. - // - // * whitelist – Only the HTTP headers that are - // listed in the Headers type are included in requests that CloudFront sends to the - // origin. - // - // * allViewer – All HTTP headers in viewer requests are included in - // requests that CloudFront sends to the origin. - // - // * allViewerAndWhitelistCloudFront - // – All HTTP headers in viewer requests and the additional CloudFront headers that - // are listed in the Headers type are included in requests that CloudFront sends to - // the origin. The additional headers are added by CloudFront. - // - // * allExcept – All - // HTTP headers in viewer requests are included in requests that CloudFront sends - // to the origin, except for those listed in the Headers type, which are not - // included. + // - none – No HTTP headers in viewer requests are included in requests that + // CloudFront sends to the origin. Even when this field is set to none , any + // headers that are listed in a CachePolicy are included in origin requests. + // - whitelist – Only the HTTP headers that are listed in the Headers type are + // included in requests that CloudFront sends to the origin. + // - allViewer – All HTTP headers in viewer requests are included in requests + // that CloudFront sends to the origin. + // - allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and + // the additional CloudFront headers that are listed in the Headers type are + // included in requests that CloudFront sends to the origin. The additional headers + // are added by CloudFront. + // - allExcept – All HTTP headers in viewer requests are included in requests + // that CloudFront sends to the origin, except for those listed in the Headers + // type, which are not included. // // This member is required. HeaderBehavior OriginRequestPolicyHeaderBehavior @@ -3467,23 +3208,18 @@ type OriginRequestPolicyQueryStringsConfig struct { // Determines whether any URL query strings in viewer requests are included in // requests that CloudFront sends to the origin. Valid values are: - // - // * none – No - // query strings in viewer requests are included in requests that CloudFront sends - // to the origin. Even when this field is set to none, any query strings that are - // listed in a CachePolicy are included in origin requests. - // - // * whitelist – Only the - // query strings in viewer requests that are listed in the QueryStringNames type - // are included in requests that CloudFront sends to the origin. - // - // * all – All query - // strings in viewer requests are included in requests that CloudFront sends to the - // origin. - // - // * allExcept – All query strings in viewer requests are included in - // requests that CloudFront sends to the origin, except for those listed in the - // QueryStringNames type, which are not included. + // - none – No query strings in viewer requests are included in requests that + // CloudFront sends to the origin. Even when this field is set to none , any + // query strings that are listed in a CachePolicy are included in origin + // requests. + // - whitelist – Only the query strings in viewer requests that are listed in the + // QueryStringNames type are included in requests that CloudFront sends to the + // origin. + // - all – All query strings in viewer requests are included in requests that + // CloudFront sends to the origin. + // - allExcept – All query strings in viewer requests are included in requests + // that CloudFront sends to the origin, except for those listed in the + // QueryStringNames type, which are not included. // // This member is required. QueryStringBehavior OriginRequestPolicyQueryStringBehavior @@ -3491,9 +3227,9 @@ type OriginRequestPolicyQueryStringsConfig struct { // Contains the specific query strings in viewer requests that either are or are // not included in requests that CloudFront sends to the origin. The behavior // depends on whether the QueryStringBehavior field in the - // OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query - // strings are included) or allExcept (the listed query strings are not included, - // but all other query strings are). + // OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed + // query strings are included) or allExcept (the listed query strings are not + // included, but all other query strings are). QueryStrings *QueryStringNames noSmithyDocumentSerde @@ -3533,8 +3269,7 @@ type Origins struct { } // CloudFront Origin Shield. Using Origin Shield can help reduce the load on your -// origin. For more information, see Using Origin Shield -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) +// origin. For more information, see Using Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) // in the Amazon CloudFront Developer Guide. type OriginShield struct { @@ -3549,11 +3284,10 @@ type OriginShield struct { // The Amazon Web Services Region for Origin Shield. Specify the Amazon Web // Services Region that has the lowest latency to your origin. To specify a region, // use the region code, not the region name. For example, specify the US East - // (Ohio) region as us-east-2. When you enable CloudFront Origin Shield, you must + // (Ohio) region as us-east-2 . When you enable CloudFront Origin Shield, you must // specify the Amazon Web Services Region for Origin Shield. For the list of Amazon // Web Services Regions that you can specify, and for help choosing the best Region - // for your origin, see Choosing the Amazon Web Services Region for Origin Shield - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) + // for your origin, see Choosing the Amazon Web Services Region for Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) // in the Amazon CloudFront Developer Guide. OriginShieldRegion *string @@ -3585,7 +3319,7 @@ type OriginSslProtocols struct { // cache key are also included in requests that CloudFront sends to the origin. // CloudFront sends a request when it can't find an object in its cache that // matches the request's cache key. If you want to send values to the origin but -// not include them in the cache key, use OriginRequestPolicy. +// not include them in the cache key, use OriginRequestPolicy . type ParametersInCacheKeyAndForwardedToOrigin struct { // An object that determines whether any cookies in viewer requests (and if so, @@ -3598,26 +3332,19 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // A flag that can affect whether the Accept-Encoding HTTP header is included in // the cache key and included in requests that CloudFront sends to the origin. This // field is related to the EnableAcceptEncodingBrotli field. If one or both of - // these fields is true and the viewer request includes the Accept-Encoding header, - // then CloudFront does the following: - // - // * Normalizes the value of the viewer's - // Accept-Encoding header - // - // * Includes the normalized header in the cache key - // - // * - // Includes the normalized header in the request to the origin, if a request is - // necessary - // - // For more information, see Compression support - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) - // in the Amazon CloudFront Developer Guide. If you set this value to true, and + // these fields is true and the viewer request includes the Accept-Encoding + // header, then CloudFront does the following: + // - Normalizes the value of the viewer's Accept-Encoding header + // - Includes the normalized header in the cache key + // - Includes the normalized header in the request to the origin, if a request + // is necessary + // For more information, see Compression support (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) + // in the Amazon CloudFront Developer Guide. If you set this value to true , and // this cache behavior also has an origin request policy attached, do not include // the Accept-Encoding header in the origin request policy. CloudFront always // includes the Accept-Encoding header in origin requests when the value of this - // field is true, so including this header in an origin request policy has no - // effect. If both of these fields are false, then CloudFront treats the + // field is true , so including this header in an origin request policy has no + // effect. If both of these fields are false , then CloudFront treats the // Accept-Encoding header the same as any other HTTP header in the viewer request. // By default, it's not included in the cache key and it's not included in origin // requests. In this case, you can manually add Accept-Encoding to the headers @@ -3645,24 +3372,17 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // field is related to the EnableAcceptEncodingGzip field. If one or both of these // fields is true and the viewer request includes the Accept-Encoding header, then // CloudFront does the following: - // - // * Normalizes the value of the viewer's - // Accept-Encoding header - // - // * Includes the normalized header in the cache key - // - // * - // Includes the normalized header in the request to the origin, if a request is - // necessary - // - // For more information, see Compression support - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) - // in the Amazon CloudFront Developer Guide. If you set this value to true, and + // - Normalizes the value of the viewer's Accept-Encoding header + // - Includes the normalized header in the cache key + // - Includes the normalized header in the request to the origin, if a request + // is necessary + // For more information, see Compression support (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) + // in the Amazon CloudFront Developer Guide. If you set this value to true , and // this cache behavior also has an origin request policy attached, do not include // the Accept-Encoding header in the origin request policy. CloudFront always // includes the Accept-Encoding header in origin requests when the value of this - // field is true, so including this header in an origin request policy has no - // effect. If both of these fields are false, then CloudFront treats the + // field is true , so including this header in an origin request policy has no + // effect. If both of these fields are false , then CloudFront treats the // Accept-Encoding header the same as any other HTTP header in the viewer request. // By default, it's not included in the cache key and it's not included in origin // requests. In this case, you can manually add Accept-Encoding to the headers @@ -3673,8 +3393,7 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { } // A complex type that contains information about the objects that you want to -// invalidate. For more information, see Specifying the Objects to Invalidate -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) +// invalidate. For more information, see Specifying the Objects to Invalidate (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects) // in the Amazon CloudFront Developer Guide. type Paths struct { @@ -3690,10 +3409,9 @@ type Paths struct { noSmithyDocumentSerde } -// A public key that you can use with signed URLs and signed cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), -// or with field-level encryption -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). +// A public key that you can use with signed URLs and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) +// . type PublicKey struct { // The date and time when the public key was uploaded. @@ -3707,10 +3425,9 @@ type PublicKey struct { Id *string // Configuration information about a public key that you can use with signed URLs - // and signed cookies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), - // or with field-level encryption - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). + // and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) + // . // // This member is required. PublicKeyConfig *PublicKeyConfig @@ -3719,10 +3436,9 @@ type PublicKey struct { } // Configuration information about a public key that you can use with signed URLs -// and signed cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), -// or with field-level encryption -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). +// and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) +// . type PublicKeyConfig struct { // A string included in the request to help make sure that the request can't be @@ -3731,10 +3447,9 @@ type PublicKeyConfig struct { // This member is required. CallerReference *string - // The public key that you can use with signed URLs and signed cookies - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), - // or with field-level encryption - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). + // The public key that you can use with signed URLs and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) + // . // // This member is required. EncodedKey *string @@ -3751,10 +3466,9 @@ type PublicKeyConfig struct { noSmithyDocumentSerde } -// A list of public keys that you can use with signed URLs and signed cookies -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), -// or with field-level encryption -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html). +// A list of public keys that you can use with signed URLs and signed cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) +// , or with field-level encryption (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) +// . type PublicKeyList struct { // The maximum number of public keys you want in the response. @@ -3858,11 +3572,11 @@ type QueryArgProfiles struct { // This field is deprecated. We recommend that you use a cache policy or an origin // request policy instead of this field. If you want to include query strings in -// the cache key, use QueryStringsConfig in a cache policy. See CachePolicy. If you -// want to send query strings to the origin but not include them in the cache key, -// use QueryStringsConfig in an origin request policy. See OriginRequestPolicy. A -// complex type that contains information about the query string parameters that -// you want CloudFront to use for caching for a cache behavior. +// the cache key, use QueryStringsConfig in a cache policy. See CachePolicy . If +// you want to send query strings to the origin but not include them in the cache +// key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy +// . A complex type that contains information about the query string parameters +// that you want CloudFront to use for caching for a cache behavior. type QueryStringCacheKeys struct { // The number of whitelisted query string parameters for a cache behavior. @@ -3870,9 +3584,9 @@ type QueryStringCacheKeys struct { // This member is required. Quantity *int32 - // A list that contains the query string parameters that you want CloudFront to use - // as a basis for caching for a cache behavior. If Quantity is 0, you can omit - // Items. + // A list that contains the query string parameters that you want CloudFront to + // use as a basis for caching for a cache behavior. If Quantity is 0, you can omit + // Items . Items []string noSmithyDocumentSerde @@ -3908,9 +3622,8 @@ type RealtimeLogConfig struct { // A list of fields that are included in each real-time log record. In an API // response, the fields are provided in the same order in which they are sent to - // the Amazon Kinesis data stream. For more information about fields, see Real-time - // log configuration fields - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) + // the Amazon Kinesis data stream. For more information about fields, see + // Real-time log configuration fields (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -3941,8 +3654,9 @@ type RealtimeLogConfigs struct { // This member is required. IsTruncated *bool - // This parameter indicates where this list of real-time log configurations begins. - // This list includes real-time log configurations that occur after the marker. + // This parameter indicates where this list of real-time log configurations + // begins. This list includes real-time log configurations that occur after the + // marker. // // This member is required. Marker *string @@ -3983,8 +3697,7 @@ type RealtimeMetricsSubscriptionConfig struct { // policy affects the HTTP headers that CloudFront includes in HTTP responses to // requests that match the cache behavior. CloudFront adds or removes response // headers according to the configuration of the response headers policy. For more -// information, see Adding or removing HTTP headers in CloudFront responses -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) +// information, see Adding or removing HTTP headers in CloudFront responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html) // in the Amazon CloudFront Developer Guide. type ResponseHeadersPolicy struct { @@ -4009,8 +3722,7 @@ type ResponseHeadersPolicy struct { // A list of HTTP header names that CloudFront includes as values for the // Access-Control-Allow-Headers HTTP response header. For more information about // the Access-Control-Allow-Headers HTTP response header, see -// Access-Control-Allow-Headers -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) +// Access-Control-Allow-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) // in the MDN Web Docs. type ResponseHeadersPolicyAccessControlAllowHeaders struct { @@ -4030,32 +3742,20 @@ type ResponseHeadersPolicyAccessControlAllowHeaders struct { // A list of HTTP methods that CloudFront includes as values for the // Access-Control-Allow-Methods HTTP response header. For more information about // the Access-Control-Allow-Methods HTTP response header, see -// Access-Control-Allow-Methods -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) +// Access-Control-Allow-Methods (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) // in the MDN Web Docs. type ResponseHeadersPolicyAccessControlAllowMethods struct { // The list of HTTP methods. Valid values are: - // - // * GET - // - // * DELETE - // - // * HEAD - // - // * - // OPTIONS - // - // * PATCH - // - // * POST - // - // * PUT - // - // * ALL - // - // ALL is a special value that includes all - // of the listed HTTP methods. + // - GET + // - DELETE + // - HEAD + // - OPTIONS + // - PATCH + // - POST + // - PUT + // - ALL + // ALL is a special value that includes all of the listed HTTP methods. // // This member is required. Items []ResponseHeadersPolicyAccessControlAllowMethodsValues @@ -4071,8 +3771,7 @@ type ResponseHeadersPolicyAccessControlAllowMethods struct { // A list of origins (domain names) that CloudFront can use as the value for the // Access-Control-Allow-Origin HTTP response header. For more information about the // Access-Control-Allow-Origin HTTP response header, see -// Access-Control-Allow-Origin -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) +// Access-Control-Allow-Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) // in the MDN Web Docs. type ResponseHeadersPolicyAccessControlAllowOrigins struct { @@ -4092,8 +3791,7 @@ type ResponseHeadersPolicyAccessControlAllowOrigins struct { // A list of HTTP headers that CloudFront includes as values for the // Access-Control-Expose-Headers HTTP response header. For more information about // the Access-Control-Expose-Headers HTTP response header, see -// Access-Control-Expose-Headers -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) +// Access-Control-Expose-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) // in the MDN Web Docs. type ResponseHeadersPolicyAccessControlExposeHeaders struct { @@ -4108,9 +3806,9 @@ type ResponseHeadersPolicyAccessControlExposeHeaders struct { noSmithyDocumentSerde } -// A response headers policy configuration. A response headers policy configuration -// contains metadata about the response headers policy, and configurations for sets -// of HTTP response headers. +// A response headers policy configuration. A response headers policy +// configuration contains metadata about the response headers policy, and +// configurations for sets of HTTP response headers. type ResponseHeadersPolicyConfig struct { // A name to identify the response headers policy. The name must be unique for @@ -4144,9 +3842,8 @@ type ResponseHeadersPolicyConfig struct { } // The policy directives and their values that CloudFront includes as values for -// the Content-Security-Policy HTTP response header. For more information about the -// Content-Security-Policy HTTP response header, see Content-Security-Policy -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) +// the Content-Security-Policy HTTP response header. For more information about +// the Content-Security-Policy HTTP response header, see Content-Security-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) // in the MDN Web Docs. type ResponseHeadersPolicyContentSecurityPolicy struct { @@ -4167,9 +3864,8 @@ type ResponseHeadersPolicyContentSecurityPolicy struct { } // Determines whether CloudFront includes the X-Content-Type-Options HTTP response -// header with its value set to nosniff. For more information about the -// X-Content-Type-Options HTTP response header, see X-Content-Type-Options -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) +// header with its value set to nosniff . For more information about the +// X-Content-Type-Options HTTP response header, see X-Content-Type-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) // in the MDN Web Docs. type ResponseHeadersPolicyContentTypeOptions struct { @@ -4187,15 +3883,14 @@ type ResponseHeadersPolicyContentTypeOptions struct { // cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP // responses that it sends for CORS requests that match a cache behavior associated // with this response headers policy. For more information about CORS, see -// Cross-Origin Resource Sharing (CORS) -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs. +// Cross-Origin Resource Sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) +// in the MDN Web Docs. type ResponseHeadersPolicyCorsConfig struct { // A Boolean that CloudFront uses as the value for the // Access-Control-Allow-Credentials HTTP response header. For more information // about the Access-Control-Allow-Credentials HTTP response header, see - // Access-Control-Allow-Credentials - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) + // Access-Control-Allow-Credentials (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) // in the MDN Web Docs. // // This member is required. @@ -4204,8 +3899,7 @@ type ResponseHeadersPolicyCorsConfig struct { // A list of HTTP header names that CloudFront includes as values for the // Access-Control-Allow-Headers HTTP response header. For more information about // the Access-Control-Allow-Headers HTTP response header, see - // Access-Control-Allow-Headers - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) + // Access-Control-Allow-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) // in the MDN Web Docs. // // This member is required. @@ -4214,8 +3908,7 @@ type ResponseHeadersPolicyCorsConfig struct { // A list of HTTP methods that CloudFront includes as values for the // Access-Control-Allow-Methods HTTP response header. For more information about // the Access-Control-Allow-Methods HTTP response header, see - // Access-Control-Allow-Methods - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) + // Access-Control-Allow-Methods (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) // in the MDN Web Docs. // // This member is required. @@ -4224,8 +3917,7 @@ type ResponseHeadersPolicyCorsConfig struct { // A list of origins (domain names) that CloudFront can use as the value for the // Access-Control-Allow-Origin HTTP response header. For more information about the // Access-Control-Allow-Origin HTTP response header, see - // Access-Control-Allow-Origin - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) + // Access-Control-Allow-Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) // in the MDN Web Docs. // // This member is required. @@ -4241,15 +3933,13 @@ type ResponseHeadersPolicyCorsConfig struct { // A list of HTTP headers that CloudFront includes as values for the // Access-Control-Expose-Headers HTTP response header. For more information about // the Access-Control-Expose-Headers HTTP response header, see - // Access-Control-Expose-Headers - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) + // Access-Control-Expose-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) // in the MDN Web Docs. AccessControlExposeHeaders *ResponseHeadersPolicyAccessControlExposeHeaders // A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP // response header. For more information about the Access-Control-Max-Age HTTP - // response header, see Access-Control-Max-Age - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) + // response header, see Access-Control-Max-Age (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) // in the MDN Web Docs. AccessControlMaxAgeSec *int32 @@ -4280,9 +3970,9 @@ type ResponseHeadersPolicyCustomHeader struct { noSmithyDocumentSerde } -// A list of HTTP response header names and their values. CloudFront includes these -// headers in HTTP responses that it sends for requests that match a cache behavior -// that's associated with this response headers policy. +// A list of HTTP response header names and their values. CloudFront includes +// these headers in HTTP responses that it sends for requests that match a cache +// behavior that's associated with this response headers policy. type ResponseHeadersPolicyCustomHeadersConfig struct { // The number of HTTP response headers in the list. @@ -4298,15 +3988,13 @@ type ResponseHeadersPolicyCustomHeadersConfig struct { // Determines whether CloudFront includes the X-Frame-Options HTTP response header // and the header's value. For more information about the X-Frame-Options HTTP -// response header, see X-Frame-Options -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in -// the MDN Web Docs. +// response header, see X-Frame-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) +// in the MDN Web Docs. type ResponseHeadersPolicyFrameOptions struct { - // The value of the X-Frame-Options HTTP response header. Valid values are DENY and - // SAMEORIGIN. For more information about these values, see X-Frame-Options - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in - // the MDN Web Docs. + // The value of the X-Frame-Options HTTP response header. Valid values are DENY + // and SAMEORIGIN . For more information about these values, see X-Frame-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) + // in the MDN Web Docs. // // This member is required. FrameOption FrameOptionsList @@ -4348,9 +4036,8 @@ type ResponseHeadersPolicyList struct { // Determines whether CloudFront includes the Referrer-Policy HTTP response header // and the header's value. For more information about the Referrer-Policy HTTP -// response header, see Referrer-Policy -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in -// the MDN Web Docs. +// response header, see Referrer-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) +// in the MDN Web Docs. type ResponseHeadersPolicyReferrerPolicy struct { // A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP @@ -4361,30 +4048,16 @@ type ResponseHeadersPolicyReferrerPolicy struct { Override *bool // The value of the Referrer-Policy HTTP response header. Valid values are: - // - // * - // no-referrer - // - // * no-referrer-when-downgrade - // - // * origin - // - // * - // origin-when-cross-origin - // - // * same-origin - // - // * strict-origin - // - // * - // strict-origin-when-cross-origin - // - // * unsafe-url - // - // For more information about these - // values, see Referrer-Policy - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in - // the MDN Web Docs. + // - no-referrer + // - no-referrer-when-downgrade + // - origin + // - origin-when-cross-origin + // - same-origin + // - strict-origin + // - strict-origin-when-cross-origin + // - unsafe-url + // For more information about these values, see Referrer-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) + // in the MDN Web Docs. // // This member is required. ReferrerPolicy ReferrerPolicyList @@ -4427,45 +4100,39 @@ type ResponseHeadersPolicyRemoveHeadersConfig struct { type ResponseHeadersPolicySecurityHeadersConfig struct { // The policy directives and their values that CloudFront includes as values for - // the Content-Security-Policy HTTP response header. For more information about the - // Content-Security-Policy HTTP response header, see Content-Security-Policy - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) + // the Content-Security-Policy HTTP response header. For more information about + // the Content-Security-Policy HTTP response header, see Content-Security-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) // in the MDN Web Docs. ContentSecurityPolicy *ResponseHeadersPolicyContentSecurityPolicy // Determines whether CloudFront includes the X-Content-Type-Options HTTP response - // header with its value set to nosniff. For more information about the - // X-Content-Type-Options HTTP response header, see X-Content-Type-Options - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) + // header with its value set to nosniff . For more information about the + // X-Content-Type-Options HTTP response header, see X-Content-Type-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) // in the MDN Web Docs. ContentTypeOptions *ResponseHeadersPolicyContentTypeOptions // Determines whether CloudFront includes the X-Frame-Options HTTP response header // and the header's value. For more information about the X-Frame-Options HTTP - // response header, see X-Frame-Options - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in - // the MDN Web Docs. + // response header, see X-Frame-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) + // in the MDN Web Docs. FrameOptions *ResponseHeadersPolicyFrameOptions // Determines whether CloudFront includes the Referrer-Policy HTTP response header // and the header's value. For more information about the Referrer-Policy HTTP - // response header, see Referrer-Policy - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in - // the MDN Web Docs. + // response header, see Referrer-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) + // in the MDN Web Docs. ReferrerPolicy *ResponseHeadersPolicyReferrerPolicy // Determines whether CloudFront includes the Strict-Transport-Security HTTP // response header and the header's value. For more information about the - // Strict-Transport-Security HTTP response header, see Strict-Transport-Security - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) + // Strict-Transport-Security HTTP response header, see Strict-Transport-Security (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) // in the MDN Web Docs. StrictTransportSecurity *ResponseHeadersPolicyStrictTransportSecurity - // Determines whether CloudFront includes the X-XSS-Protection HTTP response header - // and the header's value. For more information about the X-XSS-Protection HTTP - // response header, see X-XSS-Protection - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in - // the MDN Web Docs. + // Determines whether CloudFront includes the X-XSS-Protection HTTP response + // header and the header's value. For more information about the X-XSS-Protection + // HTTP response header, see X-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) + // in the MDN Web Docs. XSSProtection *ResponseHeadersPolicyXSSProtection noSmithyDocumentSerde @@ -4480,8 +4147,7 @@ type ResponseHeadersPolicySecurityHeadersConfig struct { // the first byte latency from the origin when there was a cache miss. You can use // the metrics in the Server-Timing header to troubleshoot issues or test the // efficiency of your CloudFront configuration. For more information, see -// Server-Timing header -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header) +// Server-Timing header (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header) // in the Amazon CloudFront Developer Guide. type ResponseHeadersPolicyServerTimingHeadersConfig struct { @@ -4506,8 +4172,7 @@ type ResponseHeadersPolicyServerTimingHeadersConfig struct { // Determines whether CloudFront includes the Strict-Transport-Security HTTP // response header and the header's value. For more information about the -// Strict-Transport-Security HTTP response header, see Strict-Transport-Security -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) +// Strict-Transport-Security HTTP response header, see Strict-Transport-Security (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) // in the MDN Web Docs. type ResponseHeadersPolicyStrictTransportSecurity struct { @@ -4552,42 +4217,38 @@ type ResponseHeadersPolicySummary struct { noSmithyDocumentSerde } -// Determines whether CloudFront includes the X-XSS-Protection HTTP response header -// and the header's value. For more information about the X-XSS-Protection HTTP -// response header, see X-XSS-Protection -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in -// the MDN Web Docs. +// Determines whether CloudFront includes the X-XSS-Protection HTTP response +// header and the header's value. For more information about the X-XSS-Protection +// HTTP response header, see X-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) +// in the MDN Web Docs. type ResponseHeadersPolicyXSSProtection struct { - // A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP - // response header received from the origin with the one specified in this response - // headers policy. + // A Boolean that determines whether CloudFront overrides the X-XSS-Protection + // HTTP response header received from the origin with the one specified in this + // response headers policy. // // This member is required. Override *bool // A Boolean that determines the value of the X-XSS-Protection HTTP response - // header. When this setting is true, the value of the X-XSS-Protection header is - // 1. When this setting is false, the value of the X-XSS-Protection header is 0. - // For more information about these settings, see X-XSS-Protection - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in - // the MDN Web Docs. + // header. When this setting is true , the value of the X-XSS-Protection header is + // 1 . When this setting is false , the value of the X-XSS-Protection header is 0 . + // For more information about these settings, see X-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) + // in the MDN Web Docs. // // This member is required. Protection *bool // A Boolean that determines whether CloudFront includes the mode=block directive // in the X-XSS-Protection header. For more information about this directive, see - // X-XSS-Protection - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in - // the MDN Web Docs. + // X-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) + // in the MDN Web Docs. ModeBlock *bool // A reporting URI, which CloudFront uses as the value of the report directive in // the X-XSS-Protection header. You cannot specify a ReportUri when ModeBlock is - // true. For more information about using a reporting URL, see X-XSS-Protection - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in - // the MDN Web Docs. + // true . For more information about using a reporting URL, see X-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) + // in the MDN Web Docs. ReportUri *string noSmithyDocumentSerde @@ -4597,8 +4258,9 @@ type ResponseHeadersPolicyXSSProtection struct { // of your content. type Restrictions struct { - // A complex type that controls the countries in which your content is distributed. - // CloudFront determines the location of your users using MaxMind GeoIP databases. + // A complex type that controls the countries in which your content is + // distributed. CloudFront determines the location of your users using MaxMind + // GeoIP databases. // // This member is required. GeoRestriction *GeoRestriction @@ -4615,17 +4277,16 @@ type S3Origin struct { // This member is required. DomainName *string - // The CloudFront origin access identity to associate with the distribution. Use an - // origin access identity to configure the distribution so that end users can only - // access objects in an Amazon S3 bucket through CloudFront. If you want end users - // to be able to access objects using either the CloudFront URL or the Amazon S3 - // URL, specify an empty OriginAccessIdentity element. To delete the origin access - // identity from an existing distribution, update the distribution configuration - // and include an empty OriginAccessIdentity element. To replace the origin access - // identity, update the distribution configuration and specify the new origin - // access identity. For more information, see Using an Origin Access Identity to - // Restrict Access to Your Amazon S3 Content - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) + // The CloudFront origin access identity to associate with the distribution. Use + // an origin access identity to configure the distribution so that end users can + // only access objects in an Amazon S3 bucket through CloudFront. If you want end + // users to be able to access objects using either the CloudFront URL or the Amazon + // S3 URL, specify an empty OriginAccessIdentity element. To delete the origin + // access identity from an existing distribution, update the distribution + // configuration and include an empty OriginAccessIdentity element. To replace the + // origin access identity, update the distribution configuration and specify the + // new origin access identity. For more information, see Using an Origin Access + // Identity to Restrict Access to Your Amazon S3 Content (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -4643,7 +4304,7 @@ type S3OriginConfig struct { // origin access identity to configure the origin so that viewers can only access // objects in an Amazon S3 bucket through CloudFront. The format of the value is: // origin-access-identity/cloudfront/ID-of-origin-access-identity where - // ID-of-origin-access-identity is the value that CloudFront returned in the ID + // ID-of-origin-access-identity is the value that CloudFront returned in the ID // element when you created the origin access identity. If you want viewers to be // able to access objects using either the CloudFront URL or the Amazon S3 URL, // specify an empty OriginAccessIdentity element. To delete the origin access @@ -4651,8 +4312,7 @@ type S3OriginConfig struct { // and include an empty OriginAccessIdentity element. To replace the origin access // identity, update the distribution configuration and specify the new origin // access identity. For more information about the origin access identity, see - // Serving Private Content through CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // Serving Private Content through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -4670,14 +4330,14 @@ type SessionStickinessConfig struct { // The amount of time after which you want sessions to cease if no requests are // received. Allowed values are 300–3600 seconds (5–60 minutes). The value must be - // less than or equal to MaximumTTL. + // less than or equal to MaximumTTL . // // This member is required. IdleTTL *int32 - // The maximum amount of time to consider requests from the viewer as being part of - // the same session. Allowed values are 300–3600 seconds (5–60 minutes). The value - // must be less than or equal to IdleTTL. + // The maximum amount of time to consider requests from the viewer as being part + // of the same session. Allowed values are 300–3600 seconds (5–60 minutes). The + // value must be less than or equal to IdleTTL . // // This member is required. MaximumTTL *int32 @@ -4693,7 +4353,7 @@ type Signer struct { // An Amazon Web Services account number that contains active CloudFront key pairs // that CloudFront can use to verify the signatures of signed URLs and signed // cookies. If the Amazon Web Services account that owns the key pairs is the same - // account that owns the CloudFront distribution, the value of this field is self. + // account that owns the CloudFront distribution, the value of this field is self . AwsAccountNumber *string // A list of CloudFront key pair identifiers. @@ -4716,8 +4376,8 @@ type StagingDistributionDnsNames struct { noSmithyDocumentSerde } -// A complex data type for the status codes that you specify that, when returned by -// a primary origin, trigger CloudFront to failover to a second origin. +// A complex data type for the status codes that you specify that, when returned +// by a primary origin, trigger CloudFront to failover to a second origin. type StatusCodes struct { // The items (status codes) for an origin group. @@ -4738,40 +4398,39 @@ type StatusCodes struct { type StreamingDistribution struct { // The ARN (Amazon Resource Name) for the distribution. For example: - // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where + // arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5 , where // 123456789012 is your Amazon Web Services account ID. // // This member is required. ARN *string // A complex type that lists the Amazon Web Services accounts, if any, that you - // included in the TrustedSigners complex type for this distribution. These are the - // accounts that you want to allow to create signed URLs for private content. The - // Signer complex type lists the Amazon Web Services account number of the trusted - // signer or self if the signer is the Amazon Web Services account that created the - // distribution. The Signer element also includes the IDs of any active CloudFront - // key pairs that are associated with the trusted signer's Amazon Web Services - // account. If no KeyPairId element appears for a Signer, that signer can't create - // signed URLs. For more information, see Serving Private Content through - // CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // included in the TrustedSigners complex type for this distribution. These are + // the accounts that you want to allow to create signed URLs for private content. + // The Signer complex type lists the Amazon Web Services account number of the + // trusted signer or self if the signer is the Amazon Web Services account that + // created the distribution. The Signer element also includes the IDs of any + // active CloudFront key pairs that are associated with the trusted signer's Amazon + // Web Services account. If no KeyPairId element appears for a Signer , that signer + // can't create signed URLs. For more information, see Serving Private Content + // through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. // // This member is required. ActiveTrustedSigners *ActiveTrustedSigners // The domain name that corresponds to the streaming distribution, for example, - // s5c39gqb8ow64r.cloudfront.net. + // s5c39gqb8ow64r.cloudfront.net . // // This member is required. DomainName *string - // The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE. + // The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE . // // This member is required. Id *string - // The current status of the RTMP distribution. When the status is Deployed, the + // The current status of the RTMP distribution. When the status is Deployed , the // distribution's information is propagated to all CloudFront edge locations. // // This member is required. @@ -4822,8 +4481,7 @@ type StreamingDistributionConfig struct { // permit to create signed URLs for private content. If you want the distribution // to use signed URLs, include this element; if you want the distribution to use // public URLs, remove this element. For more information, see Serving Private - // Content through CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // Content through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -4891,9 +4549,9 @@ type StreamingDistributionList struct { // distribution that was created by the current Amazon Web Services account. Items []StreamingDistributionSummary - // If IsTruncated is true, this element is present and contains the value you can - // use for the Marker request parameter to continue listing your RTMP distributions - // where they left off. + // If IsTruncated is true , this element is present and contains the value you can + // use for the Marker request parameter to continue listing your RTMP + // distributions where they left off. NextMarker *string noSmithyDocumentSerde @@ -4903,7 +4561,7 @@ type StreamingDistributionList struct { type StreamingDistributionSummary struct { // The ARN (Amazon Resource Name) for the streaming distribution. For example: - // arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where + // arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5 , where // 123456789012 is your Amazon Web Services account ID. // // This member is required. @@ -4921,7 +4579,7 @@ type StreamingDistributionSummary struct { Comment *string // The domain name corresponding to the distribution, for example, - // d111111abcdef8.cloudfront.net. + // d111111abcdef8.cloudfront.net . // // This member is required. DomainName *string @@ -4931,7 +4589,7 @@ type StreamingDistributionSummary struct { // This member is required. Enabled *bool - // The identifier for the distribution, for example, EDFDVBD632BHDS5. + // The identifier for the distribution, for example, EDFDVBD632BHDS5 . // // This member is required. Id *string @@ -4953,25 +4611,24 @@ type StreamingDistributionSummary struct { // This member is required. S3Origin *S3Origin - // Indicates the current status of the distribution. When the status is Deployed, + // Indicates the current status of the distribution. When the status is Deployed , // the distribution's information is fully propagated throughout the Amazon // CloudFront system. // // This member is required. Status *string - // A complex type that specifies the Amazon Web Services accounts, if any, that you - // want to allow to create signed URLs for private content. If you want to require - // signed URLs in requests for objects in the target origin that match the - // PathPattern for this cache behavior, specify true for Enabled, and specify the - // applicable values for Quantity and Items.If you don't want to require signed - // URLs in requests for objects that match PathPattern, specify false for Enabled - // and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted - // signers, change Enabled to true (if it's currently false), change Quantity as + // A complex type that specifies the Amazon Web Services accounts, if any, that + // you want to allow to create signed URLs for private content. If you want to + // require signed URLs in requests for objects in the target origin that match the + // PathPattern for this cache behavior, specify true for Enabled , and specify the + // applicable values for Quantity and Items .If you don't want to require signed + // URLs in requests for objects that match PathPattern , specify false for Enabled + // and 0 for Quantity . Omit Items . To add, change, or remove one or more trusted + // signers, change Enabled to true (if it's currently false ), change Quantity as // applicable, and specify all of the trusted signers that you want to include in // the updated distribution. For more information, see Serving Private Content - // through CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) + // through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) // in the Amazon CloudFront Developer Guide. // // This member is required. @@ -4985,7 +4642,7 @@ type StreamingDistributionSummary struct { type StreamingLoggingConfig struct { // The Amazon S3 bucket to store the access logs in, for example, - // myawslogbucket.s3.amazonaws.com. + // myawslogbucket.s3.amazonaws.com . // // This member is required. Bucket *string @@ -4993,15 +4650,15 @@ type StreamingLoggingConfig struct { // Specifies whether you want CloudFront to save access logs to an Amazon S3 // bucket. If you don't want to enable logging when you create a streaming // distribution or if you want to disable logging for an existing streaming - // distribution, specify false for Enabled, and specify empty Bucket and Prefix - // elements. If you specify false for Enabled but you specify values for Bucket and - // Prefix, the values are automatically deleted. + // distribution, specify false for Enabled , and specify empty Bucket and Prefix + // elements. If you specify false for Enabled but you specify values for Bucket + // and Prefix , the values are automatically deleted. // // This member is required. Enabled *bool // An optional string that you want CloudFront to prefix to the access log - // filenames for this streaming distribution, for example, myprefix/. If you want + // filenames for this streaming distribution, for example, myprefix/ . If you want // to enable logging, but you don't want to specify a prefix, you still must // include an empty Prefix element in the Logging element. // @@ -5015,15 +4672,15 @@ type StreamingLoggingConfig struct { type Tag struct { // A string that contains Tag key. The string length should be between 1 and 128 - // characters. Valid characters include a-z, A-Z, 0-9, space, and the special - // characters _ - . : / = + @. + // characters. Valid characters include a-z , A-Z , 0-9 , space, and the special + // characters _ - . : / = + @ . // // This member is required. Key *string // A string that contains an optional Tag value. The string length should be - // between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and - // the special characters _ - . : / = + @. + // between 0 and 256 characters. Valid characters include a-z , A-Z , 0-9 , space, + // and the special characters _ - . : / = + @ . Value *string noSmithyDocumentSerde @@ -5047,7 +4704,7 @@ type Tags struct { noSmithyDocumentSerde } -// Contains the result of testing a CloudFront function with TestFunction. +// Contains the result of testing a CloudFront function with TestFunction . type TestResult struct { // The amount of time that the function took to run as a percentage of the maximum @@ -5063,8 +4720,7 @@ type TestResult struct { FunctionExecutionLogs []string // The event object returned by the function. For more information about the - // structure of the event object, see Event object structure - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html) + // structure of the event object, see Event object structure (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html) // in the Amazon CloudFront Developer Guide. FunctionOutput *string @@ -5098,7 +4754,7 @@ type TrustedKeyGroups struct { // This field is true if any of the key groups in the list have public keys that // CloudFront can use to verify the signatures of signed URLs and signed cookies. - // If not, this field is false. + // If not, this field is false . // // This member is required. Enabled *bool @@ -5120,7 +4776,7 @@ type TrustedSigners struct { // This field is true if any of the Amazon Web Services accounts have public keys // that CloudFront can use to verify the signatures of signed URLs and signed - // cookies. If not, this field is false. + // cookies. If not, this field is false . // // This member is required. Enabled *bool @@ -5139,156 +4795,111 @@ type TrustedSigners struct { // A complex type that determines the distribution's SSL/TLS configuration for // communicating with viewers. If the distribution doesn't use Aliases (also known // as alternate domain names or CNAMEs)—that is, if the distribution uses the -// CloudFront domain name such as d111111abcdef8.cloudfront.net—set +// CloudFront domain name such as d111111abcdef8.cloudfront.net —set // CloudFrontDefaultCertificate to true and leave all other fields empty. If the // distribution uses Aliases (alternate domain names or CNAMEs), use the fields in // this type to specify the following settings: +// - Which viewers the distribution accepts HTTPS connections from: only viewers +// that support server name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication) +// (recommended), or all viewers including those that don't support SNI. +// - To accept HTTPS connections from only viewers that support SNI, set +// SSLSupportMethod to sni-only . This is recommended. Most browsers and clients +// support SNI. +// - To accept HTTPS connections from all viewers, including those that don't +// support SNI, set SSLSupportMethod to vip . This is not recommended, and +// results in additional monthly charges from CloudFront. +// - The minimum SSL/TLS protocol version that the distribution can use to +// communicate with viewers. To specify a minimum version, choose a value for +// MinimumProtocolVersion . For more information, see Security Policy (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) +// in the Amazon CloudFront Developer Guide. +// - The location of the SSL/TLS certificate, Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) +// (recommended) or Identity and Access Management (IAM) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// . You specify the location by setting a value in one of the following fields +// (not both): +// - ACMCertificateArn +// - IAMCertificateId // -// * Which viewers the distribution -// accepts HTTPS connections from: only viewers that support server name indication -// (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or -// all viewers including those that don't support SNI. -// -// * To accept HTTPS -// connections from only viewers that support SNI, set SSLSupportMethod to -// sni-only. This is recommended. Most browsers and clients support SNI. -// -// * To -// accept HTTPS connections from all viewers, including those that don't support -// SNI, set SSLSupportMethod to vip. This is not recommended, and results in -// additional monthly charges from CloudFront. -// -// * The minimum SSL/TLS protocol -// version that the distribution can use to communicate with viewers. To specify a -// minimum version, choose a value for MinimumProtocolVersion. For more -// information, see Security Policy -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) -// in the Amazon CloudFront Developer Guide. -// -// * The location of the SSL/TLS -// certificate, Certificate Manager (ACM) -// (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) -// (recommended) or Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). -// You specify the location by setting a value in one of the following fields (not -// both): -// -// * ACMCertificateArn -// -// * IAMCertificateId -// -// All distributions support HTTPS -// connections from viewers. To require viewers to use HTTPS only, or to redirect -// them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or -// DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to -// communicate with your custom origin, use CustomOriginConfig. For more -// information, see Using HTTPS with CloudFront -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) -// and Using Alternate Domain Names and HTTPS -// (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) +// All distributions support HTTPS connections from viewers. To require viewers to +// use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy +// in the CacheBehavior or DefaultCacheBehavior . To specify how CloudFront should +// use SSL/TLS to communicate with your custom origin, use CustomOriginConfig . For +// more information, see Using HTTPS with CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) +// and Using Alternate Domain Names and HTTPS (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) // in the Amazon CloudFront Developer Guide. type ViewerCertificate struct { // If the distribution uses Aliases (alternate domain names or CNAMEs) and the - // SSL/TLS certificate is stored in Certificate Manager (ACM) - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide - // the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports - // ACM certificates in the US East (N. Virginia) Region (us-east-1). If you specify - // an ACM certificate ARN, you must also specify values for MinimumProtocolVersion - // and SSLSupportMethod. + // SSL/TLS certificate is stored in Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) + // , provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only + // supports ACM certificates in the US East (N. Virginia) Region ( us-east-1 ). If + // you specify an ACM certificate ARN, you must also specify values for + // MinimumProtocolVersion and SSLSupportMethod . ACMCertificateArn *string // This field is deprecated. Use one of the following fields instead: - // - // * - // ACMCertificateArn - // - // * IAMCertificateId - // - // * CloudFrontDefaultCertificate + // - ACMCertificateArn + // - IAMCertificateId + // - CloudFrontDefaultCertificate // // Deprecated: This member has been deprecated. Certificate *string // This field is deprecated. Use one of the following fields instead: - // - // * - // ACMCertificateArn - // - // * IAMCertificateId - // - // * CloudFrontDefaultCertificate + // - ACMCertificateArn + // - IAMCertificateId + // - CloudFrontDefaultCertificate // // Deprecated: This member has been deprecated. CertificateSource CertificateSource // If the distribution uses the CloudFront domain name such as - // d111111abcdef8.cloudfront.net, set this field to true. If the distribution uses - // Aliases (alternate domain names or CNAMEs), set this field to false and specify - // values for the following fields: - // - // * ACMCertificateArn or IAMCertificateId - // (specify a value for one, not both) - // - // * MinimumProtocolVersion - // - // * - // SSLSupportMethod + // d111111abcdef8.cloudfront.net , set this field to true . If the distribution + // uses Aliases (alternate domain names or CNAMEs), set this field to false and + // specify values for the following fields: + // - ACMCertificateArn or IAMCertificateId (specify a value for one, not both) + // - MinimumProtocolVersion + // - SSLSupportMethod CloudFrontDefaultCertificate *bool // If the distribution uses Aliases (alternate domain names or CNAMEs) and the - // SSL/TLS certificate is stored in Identity and Access Management (IAM) - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), - // provide the ID of the IAM certificate. If you specify an IAM certificate ID, you - // must also specify values for MinimumProtocolVersion and SSLSupportMethod. + // SSL/TLS certificate is stored in Identity and Access Management (IAM) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) + // , provide the ID of the IAM certificate. If you specify an IAM certificate ID, + // you must also specify values for MinimumProtocolVersion and SSLSupportMethod . IAMCertificateId *string - // If the distribution uses Aliases (alternate domain names or CNAMEs), specify the - // security policy that you want CloudFront to use for HTTPS connections with + // If the distribution uses Aliases (alternate domain names or CNAMEs), specify + // the security policy that you want CloudFront to use for HTTPS connections with // viewers. The security policy determines two settings: - // - // * The minimum SSL/TLS - // protocol that CloudFront can use to communicate with viewers. - // - // * The ciphers - // that CloudFront can use to encrypt the content that it returns to viewers. - // - // For - // more information, see Security Policy - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) - // and Supported Protocols and Ciphers Between Viewers and CloudFront - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) + // - The minimum SSL/TLS protocol that CloudFront can use to communicate with + // viewers. + // - The ciphers that CloudFront can use to encrypt the content that it returns + // to viewers. + // For more information, see Security Policy (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) + // and Supported Protocols and Ciphers Between Viewers and CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) // in the Amazon CloudFront Developer Guide. On the CloudFront console, this // setting is called Security Policy. When you're using SNI only (you set - // SSLSupportMethod to sni-only), you must specify TLSv1 or higher. If the + // SSLSupportMethod to sni-only ), you must specify TLSv1 or higher. If the // distribution uses the CloudFront domain name such as - // d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), + // d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), // CloudFront automatically sets the security policy to TLSv1 regardless of the // value that you set here. MinimumProtocolVersion MinimumProtocolVersion // If the distribution uses Aliases (alternate domain names or CNAMEs), specify // which viewers the distribution accepts HTTPS connections from. - // - // * sni-only – The - // distribution accepts HTTPS connections from only viewers that support server - // name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication). - // This is recommended. Most browsers and clients support SNI. - // - // * vip – The - // distribution accepts HTTPS connections from all viewers including those that - // don't support SNI. This is not recommended, and results in additional monthly - // charges from CloudFront. - // - // * static-ip - Do not specify this value unless your - // distribution has been enabled for this feature by the CloudFront team. If you - // have a use case that requires static IP addresses for a distribution, contact - // CloudFront through the Amazon Web Services Support Center - // (https://console.aws.amazon.com/support/home). - // - // If the distribution uses the - // CloudFront domain name such as d111111abcdef8.cloudfront.net, don't set a value - // for this field. + // - sni-only – The distribution accepts HTTPS connections from only viewers that + // support server name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication) + // . This is recommended. Most browsers and clients support SNI. + // - vip – The distribution accepts HTTPS connections from all viewers including + // those that don't support SNI. This is not recommended, and results in additional + // monthly charges from CloudFront. + // - static-ip - Do not specify this value unless your distribution has been + // enabled for this feature by the CloudFront team. If you have a use case that + // requires static IP addresses for a distribution, contact CloudFront through the + // Amazon Web Services Support Center (https://console.aws.amazon.com/support/home) + // . + // If the distribution uses the CloudFront domain name such as + // d111111abcdef8.cloudfront.net , don't set a value for this field. SSLSupportMethod SSLSupportMethod noSmithyDocumentSerde diff --git a/service/cloudhsm/api_client.go b/service/cloudhsm/api_client.go index ee061094c80..3dd1907914e 100644 --- a/service/cloudhsm/api_client.go +++ b/service/cloudhsm/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudhsm/api_op_AddTagsToResource.go b/service/cloudhsm/api_op_AddTagsToResource.go index 2a53229223c..fe6d35ed96f 100644 --- a/service/cloudhsm/api_op_AddTagsToResource.go +++ b/service/cloudhsm/api_op_AddTagsToResource.go @@ -12,17 +12,15 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Adds -// or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag -// consists of a key and a value. Tag keys must be unique to each resource. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Adds or overwrites one or more tags for the specified AWS CloudHSM resource. +// Each tag consists of a key and a value. Tag keys must be unique to each +// resource. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} diff --git a/service/cloudhsm/api_op_CreateHapg.go b/service/cloudhsm/api_op_CreateHapg.go index ba5e63139f1..f337eaec031 100644 --- a/service/cloudhsm/api_op_CreateHapg.go +++ b/service/cloudhsm/api_op_CreateHapg.go @@ -11,17 +11,14 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Creates a high-availability partition group. A high-availability partition group -// is a group of partitions that spans multiple physical HSMs. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Creates a high-availability partition group. A high-availability partition +// group is a group of partitions that spans multiple physical HSMs. func (c *Client) CreateHapg(ctx context.Context, params *CreateHapgInput, optFns ...func(*Options)) (*CreateHapgOutput, error) { if params == nil { params = &CreateHapgInput{} diff --git a/service/cloudhsm/api_op_CreateHsm.go b/service/cloudhsm/api_op_CreateHsm.go index 8eb063b4c9b..2793f071b7b 100644 --- a/service/cloudhsm/api_op_CreateHsm.go +++ b/service/cloudhsm/api_op_CreateHsm.go @@ -12,24 +12,20 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Creates an uninitialized HSM instance. There is an upfront fee charged for each -// HSM instance that you create with the CreateHsm operation. If you accidentally -// provision an HSM and want to request a refund, delete the instance using the -// DeleteHsm operation, go to the AWS Support Center -// (https://console.aws.amazon.com/support/home), create a new case, and select -// Account and Billing Support. It can take up to 20 minutes to create and -// provision an HSM. You can monitor the status of the HSM with the DescribeHsm -// operation. The HSM is ready to be initialized when the status changes to -// RUNNING. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Creates an uninitialized HSM instance. There is an upfront fee charged for +// each HSM instance that you create with the CreateHsm operation. If you +// accidentally provision an HSM and want to request a refund, delete the instance +// using the DeleteHsm operation, go to the AWS Support Center (https://console.aws.amazon.com/support/home) +// , create a new case, and select Account and Billing Support. It can take up to +// 20 minutes to create and provision an HSM. You can monitor the status of the HSM +// with the DescribeHsm operation. The HSM is ready to be initialized when the +// status changes to RUNNING . func (c *Client) CreateHsm(ctx context.Context, params *CreateHsmInput, optFns ...func(*Options)) (*CreateHsmOutput, error) { if params == nil { params = &CreateHsmInput{} @@ -65,12 +61,8 @@ type CreateHsmInput struct { SubnetId *string // Specifies the type of subscription for the HSM. - // - // * PRODUCTION - The HSM is being - // used in a production environment. - // - // * TRIAL - The HSM is being used in a product - // trial. + // - PRODUCTION - The HSM is being used in a production environment. + // - TRIAL - The HSM is being used in a product trial. // // This member is required. SubscriptionType types.SubscriptionType @@ -79,11 +71,11 @@ type CreateHsmInput struct { // with the same token will be ignored. ClientToken *string - // The IP address to assign to the HSM's ENI. If an IP address is not specified, an - // IP address will be randomly chosen from the CIDR range of the subnet. + // The IP address to assign to the HSM's ENI. If an IP address is not specified, + // an IP address will be randomly chosen from the CIDR range of the subnet. EniIp *string - // The external ID from IamRoleArn, if present. + // The external ID from IamRoleArn , if present. ExternalId *string // The IP address for the syslog monitoring server. The AWS CloudHSM service only diff --git a/service/cloudhsm/api_op_CreateLunaClient.go b/service/cloudhsm/api_op_CreateLunaClient.go index 5252b0fe592..409472625ae 100644 --- a/service/cloudhsm/api_op_CreateLunaClient.go +++ b/service/cloudhsm/api_op_CreateLunaClient.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Creates an HSM client. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Creates an HSM client. func (c *Client) CreateLunaClient(ctx context.Context, params *CreateLunaClientInput, optFns ...func(*Options)) (*CreateLunaClientOutput, error) { if params == nil { params = &CreateLunaClientInput{} diff --git a/service/cloudhsm/api_op_DeleteHapg.go b/service/cloudhsm/api_op_DeleteHapg.go index 73f1823a9bf..72e6012e733 100644 --- a/service/cloudhsm/api_op_DeleteHapg.go +++ b/service/cloudhsm/api_op_DeleteHapg.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Deletes a high-availability partition group. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Deletes a high-availability partition group. func (c *Client) DeleteHapg(ctx context.Context, params *DeleteHapgInput, optFns ...func(*Options)) (*DeleteHapgOutput, error) { if params == nil { params = &DeleteHapgInput{} diff --git a/service/cloudhsm/api_op_DeleteHsm.go b/service/cloudhsm/api_op_DeleteHsm.go index 31089f30c9e..38a85a33f3a 100644 --- a/service/cloudhsm/api_op_DeleteHsm.go +++ b/service/cloudhsm/api_op_DeleteHsm.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Deletes an HSM. After completion, this operation cannot be undone and your key +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Deletes an HSM. After completion, this operation cannot be undone and your key // material cannot be recovered. func (c *Client) DeleteHsm(ctx context.Context, params *DeleteHsmInput, optFns ...func(*Options)) (*DeleteHsmOutput, error) { if params == nil { diff --git a/service/cloudhsm/api_op_DeleteLunaClient.go b/service/cloudhsm/api_op_DeleteLunaClient.go index 6450d025ed8..fa6dd5f11b9 100644 --- a/service/cloudhsm/api_op_DeleteLunaClient.go +++ b/service/cloudhsm/api_op_DeleteLunaClient.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Deletes a client. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Deletes a client. func (c *Client) DeleteLunaClient(ctx context.Context, params *DeleteLunaClientInput, optFns ...func(*Options)) (*DeleteLunaClientOutput, error) { if params == nil { params = &DeleteLunaClientInput{} diff --git a/service/cloudhsm/api_op_DescribeHapg.go b/service/cloudhsm/api_op_DescribeHapg.go index eea1b2ee7f8..8720e25b353 100644 --- a/service/cloudhsm/api_op_DescribeHapg.go +++ b/service/cloudhsm/api_op_DescribeHapg.go @@ -12,16 +12,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Retrieves information about a high-availability partition group. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Retrieves information about a high-availability partition group. func (c *Client) DescribeHapg(ctx context.Context, params *DescribeHapgInput, optFns ...func(*Options)) (*DescribeHapgOutput, error) { if params == nil { params = &DescribeHapgInput{} diff --git a/service/cloudhsm/api_op_DescribeHsm.go b/service/cloudhsm/api_op_DescribeHsm.go index 804189a7d7b..b300db45cbb 100644 --- a/service/cloudhsm/api_op_DescribeHsm.go +++ b/service/cloudhsm/api_op_DescribeHsm.go @@ -12,16 +12,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Retrieves information about an HSM. You can identify the HSM by its ARN or its +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Retrieves information about an HSM. You can identify the HSM by its ARN or its // serial number. func (c *Client) DescribeHsm(ctx context.Context, params *DescribeHsmInput, optFns ...func(*Options)) (*DescribeHsmOutput, error) { if params == nil { @@ -45,8 +42,8 @@ type DescribeHsmInput struct { // specified. HsmArn *string - // The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter - // must be specified. + // The serial number of the HSM. Either the HsmArn or the HsmSerialNumber + // parameter must be specified. HsmSerialNumber *string noSmithyDocumentSerde @@ -110,12 +107,8 @@ type DescribeHsmOutput struct { SubscriptionStartDate *string // Specifies the type of subscription for the HSM. - // - // * PRODUCTION - The HSM is being - // used in a production environment. - // - // * TRIAL - The HSM is being used in a product - // trial. + // - PRODUCTION - The HSM is being used in a production environment. + // - TRIAL - The HSM is being used in a product trial. SubscriptionType types.SubscriptionType // The name of the HSM vendor. diff --git a/service/cloudhsm/api_op_DescribeLunaClient.go b/service/cloudhsm/api_op_DescribeLunaClient.go index 99aa542500d..ab4fb62c73e 100644 --- a/service/cloudhsm/api_op_DescribeLunaClient.go +++ b/service/cloudhsm/api_op_DescribeLunaClient.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Retrieves information about an HSM client. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Retrieves information about an HSM client. func (c *Client) DescribeLunaClient(ctx context.Context, params *DescribeLunaClientInput, optFns ...func(*Options)) (*DescribeLunaClientOutput, error) { if params == nil { params = &DescribeLunaClientInput{} diff --git a/service/cloudhsm/api_op_GetConfig.go b/service/cloudhsm/api_op_GetConfig.go index f62c67a3856..8225ddc8c55 100644 --- a/service/cloudhsm/api_op_GetConfig.go +++ b/service/cloudhsm/api_op_GetConfig.go @@ -12,17 +12,14 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Gets -// the configuration files necessary to connect to all high availability partition -// groups the client is associated with. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Gets the configuration files necessary to connect to all high availability +// partition groups the client is associated with. func (c *Client) GetConfig(ctx context.Context, params *GetConfigInput, optFns ...func(*Options)) (*GetConfigOutput, error) { if params == nil { params = &GetConfigInput{} diff --git a/service/cloudhsm/api_op_ListAvailableZones.go b/service/cloudhsm/api_op_ListAvailableZones.go index 64ca675f3de..444ce615b57 100644 --- a/service/cloudhsm/api_op_ListAvailableZones.go +++ b/service/cloudhsm/api_op_ListAvailableZones.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Lists -// the Availability Zones that have available AWS CloudHSM capacity. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Lists the Availability Zones that have available AWS CloudHSM capacity. func (c *Client) ListAvailableZones(ctx context.Context, params *ListAvailableZonesInput, optFns ...func(*Options)) (*ListAvailableZonesOutput, error) { if params == nil { params = &ListAvailableZonesInput{} diff --git a/service/cloudhsm/api_op_ListHapgs.go b/service/cloudhsm/api_op_ListHapgs.go index c11e4811cff..e8156ee61e3 100644 --- a/service/cloudhsm/api_op_ListHapgs.go +++ b/service/cloudhsm/api_op_ListHapgs.go @@ -11,19 +11,16 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Lists -// the high-availability partition groups for the account. This operation supports -// pagination with the use of the NextToken member. If more results are available, -// the NextToken member of the response contains a token that you pass in the next -// call to ListHapgs to retrieve the next set of items. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Lists the high-availability partition groups for the account. This operation +// supports pagination with the use of the NextToken member. If more results are +// available, the NextToken member of the response contains a token that you pass +// in the next call to ListHapgs to retrieve the next set of items. func (c *Client) ListHapgs(ctx context.Context, params *ListHapgsInput, optFns ...func(*Options)) (*ListHapgsOutput, error) { if params == nil { params = &ListHapgsInput{} @@ -41,7 +38,7 @@ func (c *Client) ListHapgs(ctx context.Context, params *ListHapgsInput, optFns . type ListHapgsInput struct { - // The NextToken value from a previous call to ListHapgs. Pass null if this is the + // The NextToken value from a previous call to ListHapgs . Pass null if this is the // first call. NextToken *string diff --git a/service/cloudhsm/api_op_ListHsms.go b/service/cloudhsm/api_op_ListHsms.go index 0ca10bf366e..df574b62d1a 100644 --- a/service/cloudhsm/api_op_ListHsms.go +++ b/service/cloudhsm/api_op_ListHsms.go @@ -11,20 +11,17 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Retrieves the identifiers of all of the HSMs provisioned for the current +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Retrieves the identifiers of all of the HSMs provisioned for the current // customer. This operation supports pagination with the use of the NextToken // member. If more results are available, the NextToken member of the response -// contains a token that you pass in the next call to ListHsms to retrieve the next -// set of items. +// contains a token that you pass in the next call to ListHsms to retrieve the +// next set of items. func (c *Client) ListHsms(ctx context.Context, params *ListHsmsInput, optFns ...func(*Options)) (*ListHsmsOutput, error) { if params == nil { params = &ListHsmsInput{} @@ -42,7 +39,7 @@ func (c *Client) ListHsms(ctx context.Context, params *ListHsmsInput, optFns ... type ListHsmsInput struct { - // The NextToken value from a previous call to ListHsms. Pass null if this is the + // The NextToken value from a previous call to ListHsms . Pass null if this is the // first call. NextToken *string @@ -55,8 +52,8 @@ type ListHsmsOutput struct { // The list of ARNs that identify the HSMs. HsmList []string - // If not null, more results are available. Pass this value to ListHsms to retrieve - // the next set of items. + // If not null, more results are available. Pass this value to ListHsms to + // retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/cloudhsm/api_op_ListLunaClients.go b/service/cloudhsm/api_op_ListLunaClients.go index e11199cfbe0..c711743bd32 100644 --- a/service/cloudhsm/api_op_ListLunaClients.go +++ b/service/cloudhsm/api_op_ListLunaClients.go @@ -11,19 +11,16 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Lists -// all of the clients. This operation supports pagination with the use of the -// NextToken member. If more results are available, the NextToken member of the -// response contains a token that you pass in the next call to ListLunaClients to -// retrieve the next set of items. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Lists all of the clients. This operation supports pagination with the use of +// the NextToken member. If more results are available, the NextToken member of +// the response contains a token that you pass in the next call to ListLunaClients +// to retrieve the next set of items. func (c *Client) ListLunaClients(ctx context.Context, params *ListLunaClientsInput, optFns ...func(*Options)) (*ListLunaClientsOutput, error) { if params == nil { params = &ListLunaClientsInput{} @@ -41,7 +38,7 @@ func (c *Client) ListLunaClients(ctx context.Context, params *ListLunaClientsInp type ListLunaClientsInput struct { - // The NextToken value from a previous call to ListLunaClients. Pass null if this + // The NextToken value from a previous call to ListLunaClients . Pass null if this // is the first call. NextToken *string diff --git a/service/cloudhsm/api_op_ListTagsForResource.go b/service/cloudhsm/api_op_ListTagsForResource.go index 10a8da77d47..68c19616d63 100644 --- a/service/cloudhsm/api_op_ListTagsForResource.go +++ b/service/cloudhsm/api_op_ListTagsForResource.go @@ -12,16 +12,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Returns a list of all tags for the specified AWS CloudHSM resource. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Returns a list of all tags for the specified AWS CloudHSM resource. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/cloudhsm/api_op_ModifyHapg.go b/service/cloudhsm/api_op_ModifyHapg.go index d6de25fde4f..460388c884a 100644 --- a/service/cloudhsm/api_op_ModifyHapg.go +++ b/service/cloudhsm/api_op_ModifyHapg.go @@ -11,16 +11,13 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Modifies an existing high-availability partition group. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Modifies an existing high-availability partition group. func (c *Client) ModifyHapg(ctx context.Context, params *ModifyHapgInput, optFns ...func(*Options)) (*ModifyHapgOutput, error) { if params == nil { params = &ModifyHapgInput{} diff --git a/service/cloudhsm/api_op_ModifyHsm.go b/service/cloudhsm/api_op_ModifyHsm.go index bb549fdd8a7..f675b60259d 100644 --- a/service/cloudhsm/api_op_ModifyHsm.go +++ b/service/cloudhsm/api_op_ModifyHsm.go @@ -11,18 +11,15 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Modifies an HSM. This operation can result in the HSM being offline for up to 15 -// minutes while the AWS CloudHSM service is reconfigured. If you are modifying a -// production HSM, you should ensure that your AWS CloudHSM service is configured +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Modifies an HSM. This operation can result in the HSM being offline for up to +// 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying +// a production HSM, you should ensure that your AWS CloudHSM service is configured // for high availability, and consider executing this operation during a // maintenance window. func (c *Client) ModifyHsm(ctx context.Context, params *ModifyHsmInput, optFns ...func(*Options)) (*ModifyHsmOutput, error) { diff --git a/service/cloudhsm/api_op_ModifyLunaClient.go b/service/cloudhsm/api_op_ModifyLunaClient.go index 96306135c60..788ad2e4ecb 100644 --- a/service/cloudhsm/api_op_ModifyLunaClient.go +++ b/service/cloudhsm/api_op_ModifyLunaClient.go @@ -11,17 +11,14 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Modifies the certificate used by the client. This action can potentially start a -// workflow to install the new certificate on the client's HSMs. +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Modifies the certificate used by the client. This action can potentially start +// a workflow to install the new certificate on the client's HSMs. func (c *Client) ModifyLunaClient(ctx context.Context, params *ModifyLunaClientInput, optFns ...func(*Options)) (*ModifyLunaClientOutput, error) { if params == nil { params = &ModifyLunaClientInput{} diff --git a/service/cloudhsm/api_op_RemoveTagsFromResource.go b/service/cloudhsm/api_op_RemoveTagsFromResource.go index f4b7ff005c5..4580684174f 100644 --- a/service/cloudhsm/api_op_RemoveTagsFromResource.go +++ b/service/cloudhsm/api_op_RemoveTagsFromResource.go @@ -11,18 +11,15 @@ import ( ) // This is documentation for AWS CloudHSM Classic. For more information, see AWS -// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS -// CloudHSM Classic User Guide -// (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM -// Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). -// Removes one or more tags from the specified AWS CloudHSM resource. To remove a +// CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) , the AWS +// CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . Removes one or more tags from the specified AWS CloudHSM resource. To remove a // tag, specify only the tag key to remove (not the value). To overwrite the value -// for an existing tag, use AddTagsToResource. +// for an existing tag, use AddTagsToResource . func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { params = &RemoveTagsFromResourceInput{} @@ -46,7 +43,7 @@ type RemoveTagsFromResourceInput struct { ResourceArn *string // The tag key or keys to remove. Specify only the tag key to remove (not the - // value). To overwrite the value for an existing tag, use AddTagsToResource. + // value). To overwrite the value for an existing tag, use AddTagsToResource . // // This member is required. TagKeyList []string diff --git a/service/cloudhsm/doc.go b/service/cloudhsm/doc.go index 1268b4c42d3..c7e6e3b564d 100644 --- a/service/cloudhsm/doc.go +++ b/service/cloudhsm/doc.go @@ -4,13 +4,11 @@ // Amazon CloudHSM. // // AWS CloudHSM Service This is documentation for AWS CloudHSM Classic. For more -// information, see AWS CloudHSM Classic FAQs -// (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User -// Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS -// CloudHSM Classic API Reference -// (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/). For information -// about the current version of AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM -// API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). +// information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/) +// , the AWS CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/) +// , and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/) +// . For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// , the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// , and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/) +// . package cloudhsm diff --git a/service/cloudhsm/types/enums.go b/service/cloudhsm/types/enums.go index 70cd711a052..467cae13d45 100644 --- a/service/cloudhsm/types/enums.go +++ b/service/cloudhsm/types/enums.go @@ -53,9 +53,9 @@ const ( HsmStatusDegraded HsmStatus = "DEGRADED" ) -// Values returns all known values for HsmStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for HsmStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (HsmStatus) Values() []HsmStatus { return []HsmStatus{ "PENDING", diff --git a/service/cloudhsmv2/api_client.go b/service/cloudhsmv2/api_client.go index c503c45d645..37564a72fa2 100644 --- a/service/cloudhsmv2/api_client.go +++ b/service/cloudhsmv2/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudhsmv2/api_op_CreateCluster.go b/service/cloudhsmv2/api_op_CreateCluster.go index c86f1b07f90..78bd574bc45 100644 --- a/service/cloudhsmv2/api_op_CreateCluster.go +++ b/service/cloudhsmv2/api_op_CreateCluster.go @@ -30,7 +30,7 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { // The type of HSM to use in the cluster. Currently the only allowed value is - // hsm1.medium. + // hsm1.medium . // // This member is required. HsmType *string @@ -38,11 +38,8 @@ type CreateClusterInput struct { // The identifiers (IDs) of the subnets where you are creating the cluster. You // must specify at least one subnet. If you specify multiple subnets, they must // meet the following criteria: - // - // * All subnets must be in the same virtual private - // cloud (VPC). - // - // * You can specify only one subnet per Availability Zone. + // - All subnets must be in the same virtual private cloud (VPC). + // - You can specify only one subnet per Availability Zone. // // This member is required. SubnetIds []string @@ -52,7 +49,7 @@ type CreateClusterInput struct { // The identifier (ID) of the cluster backup to restore. Use this value to restore // the cluster from a backup instead of creating a new cluster. To find the backup - // ID, use DescribeBackups. + // ID, use DescribeBackups . SourceBackupId *string // Tags to apply to the CloudHSM cluster during creation. diff --git a/service/cloudhsmv2/api_op_CreateHsm.go b/service/cloudhsmv2/api_op_CreateHsm.go index 57c621dddb7..79714562f55 100644 --- a/service/cloudhsmv2/api_op_CreateHsm.go +++ b/service/cloudhsmv2/api_op_CreateHsm.go @@ -31,13 +31,13 @@ func (c *Client) CreateHsm(ctx context.Context, params *CreateHsmInput, optFns . type CreateHsmInput struct { // The Availability Zone where you are creating the HSM. To find the cluster's - // Availability Zones, use DescribeClusters. + // Availability Zones, use DescribeClusters . // // This member is required. AvailabilityZone *string // The identifier (ID) of the HSM's cluster. To find the cluster ID, use - // DescribeClusters. + // DescribeClusters . // // This member is required. ClusterId *string diff --git a/service/cloudhsmv2/api_op_DeleteBackup.go b/service/cloudhsmv2/api_op_DeleteBackup.go index 3c89d77662e..3b6b79f75de 100644 --- a/service/cloudhsmv2/api_op_DeleteBackup.go +++ b/service/cloudhsmv2/api_op_DeleteBackup.go @@ -13,7 +13,7 @@ import ( // Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days // after the DeleteBackup request is made. For more information on restoring a -// backup, see RestoreBackup. +// backup, see RestoreBackup . func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error) { if params == nil { params = &DeleteBackupInput{} diff --git a/service/cloudhsmv2/api_op_DeleteCluster.go b/service/cloudhsmv2/api_op_DeleteCluster.go index e3961866096..059cb3cc6d0 100644 --- a/service/cloudhsmv2/api_op_DeleteCluster.go +++ b/service/cloudhsmv2/api_op_DeleteCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you -// must delete all HSMs in the cluster. To see if the cluster contains any HSMs, -// use DescribeClusters. To delete an HSM, use DeleteHsm. +// Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, +// you must delete all HSMs in the cluster. To see if the cluster contains any +// HSMs, use DescribeClusters . To delete an HSM, use DeleteHsm . func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error) { if params == nil { params = &DeleteClusterInput{} @@ -32,7 +32,7 @@ func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, type DeleteClusterInput struct { // The identifier (ID) of the cluster that you are deleting. To find the cluster - // ID, use DescribeClusters. + // ID, use DescribeClusters . // // This member is required. ClusterId *string diff --git a/service/cloudhsmv2/api_op_DeleteHsm.go b/service/cloudhsmv2/api_op_DeleteHsm.go index ef5ad1b29ac..09cf81c0584 100644 --- a/service/cloudhsmv2/api_op_DeleteHsm.go +++ b/service/cloudhsmv2/api_op_DeleteHsm.go @@ -13,7 +13,7 @@ import ( // Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), // the IP address of the HSM's elastic network interface (ENI), or the ID of the // HSM's ENI. You need to specify only one of these values. To find these values, -// use DescribeClusters. +// use DescribeClusters . func (c *Client) DeleteHsm(ctx context.Context, params *DeleteHsmInput, optFns ...func(*Options)) (*DeleteHsmOutput, error) { if params == nil { params = &DeleteHsmInput{} diff --git a/service/cloudhsmv2/api_op_DescribeBackups.go b/service/cloudhsmv2/api_op_DescribeBackups.go index 9877c331a1c..4bdbb0b78e8 100644 --- a/service/cloudhsmv2/api_op_DescribeBackups.go +++ b/service/cloudhsmv2/api_op_DescribeBackups.go @@ -16,8 +16,8 @@ import ( // operation, which means that each response might contain only a subset of all the // backups. When the response contains only a subset of backups, it includes a // NextToken value. Use this value in a subsequent DescribeBackups request to get -// more backups. When you receive a response with no NextToken (or an empty or null -// value), that means there are no more backups to get. +// more backups. When you receive a response with no NextToken (or an empty or +// null value), that means there are no more backups to get. func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error) { if params == nil { params = &DescribeBackupsInput{} @@ -41,11 +41,11 @@ type DescribeBackupsInput struct { // backups created from a source backup. The sourceBackupID of a source backup is // returned by the CopyBackupToRegion operation. Use the clusterIds filter to // return only the backups for the specified clusters. Specify clusters by their - // cluster identifier (ID). Use the states filter to return only backups that match - // the specified state. Use the neverExpires filter to return backups filtered by - // the value in the neverExpires parameter. True returns all backups exempt from - // the backup retention policy. False returns all backups with a backup retention - // policy defined at the cluster. + // cluster identifier (ID). Use the states filter to return only backups that + // match the specified state. Use the neverExpires filter to return backups + // filtered by the value in the neverExpires parameter. True returns all backups + // exempt from the backup retention policy. False returns all backups with a + // backup retention policy defined at the cluster. Filters map[string][]string // The maximum number of backups to return in the response. When there are more diff --git a/service/cloudhsmv2/api_op_DescribeClusters.go b/service/cloudhsmv2/api_op_DescribeClusters.go index dc559da41a5..2e9f7e51fcf 100644 --- a/service/cloudhsmv2/api_op_DescribeClusters.go +++ b/service/cloudhsmv2/api_op_DescribeClusters.go @@ -37,10 +37,10 @@ type DescribeClustersInput struct { // One or more filters to limit the items returned in the response. Use the // clusterIds filter to return only the specified clusters. Specify clusters by - // their cluster identifier (ID). Use the vpcIds filter to return only the clusters - // in the specified virtual private clouds (VPCs). Specify VPCs by their VPC - // identifier (ID). Use the states filter to return only clusters that match the - // specified state. + // their cluster identifier (ID). Use the vpcIds filter to return only the + // clusters in the specified virtual private clouds (VPCs). Specify VPCs by their + // VPC identifier (ID). Use the states filter to return only clusters that match + // the specified state. Filters map[string][]string // The maximum number of clusters to return in the response. When there are more diff --git a/service/cloudhsmv2/api_op_InitializeCluster.go b/service/cloudhsmv2/api_op_InitializeCluster.go index dc66086ef1c..5d3d85e3f6d 100644 --- a/service/cloudhsmv2/api_op_InitializeCluster.go +++ b/service/cloudhsmv2/api_op_InitializeCluster.go @@ -14,7 +14,7 @@ import ( // Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by // your issuing certificate authority (CA) and the CA's root certificate. Before // you can claim a cluster, you must sign the cluster's certificate signing request -// (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters. +// (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters . func (c *Client) InitializeCluster(ctx context.Context, params *InitializeClusterInput, optFns ...func(*Options)) (*InitializeClusterOutput, error) { if params == nil { params = &InitializeClusterInput{} @@ -33,7 +33,7 @@ func (c *Client) InitializeCluster(ctx context.Context, params *InitializeCluste type InitializeClusterInput struct { // The identifier (ID) of the cluster that you are claiming. To find the cluster - // ID, use DescribeClusters. + // ID, use DescribeClusters . // // This member is required. ClusterId *string diff --git a/service/cloudhsmv2/api_op_ListTags.go b/service/cloudhsmv2/api_op_ListTags.go index 88de461dc7c..0c2e0de3294 100644 --- a/service/cloudhsmv2/api_op_ListTags.go +++ b/service/cloudhsmv2/api_op_ListTags.go @@ -16,8 +16,8 @@ import ( // operation, which means that each response might contain only a subset of all the // tags. When the response contains only a subset of tags, it includes a NextToken // value. Use this value in a subsequent ListTags request to get more tags. When -// you receive a response with no NextToken (or an empty or null value), that means -// there are no more tags to get. +// you receive a response with no NextToken (or an empty or null value), that +// means there are no more tags to get. func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} @@ -36,7 +36,7 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { // The cluster identifier (ID) for the cluster whose tags you are getting. To find - // the cluster ID, use DescribeClusters. + // the cluster ID, use DescribeClusters . // // This member is required. ResourceId *string diff --git a/service/cloudhsmv2/api_op_ModifyBackupAttributes.go b/service/cloudhsmv2/api_op_ModifyBackupAttributes.go index 5e1eafd3dac..1d8253f54c0 100644 --- a/service/cloudhsmv2/api_op_ModifyBackupAttributes.go +++ b/service/cloudhsmv2/api_op_ModifyBackupAttributes.go @@ -29,8 +29,8 @@ func (c *Client) ModifyBackupAttributes(ctx context.Context, params *ModifyBacku type ModifyBackupAttributesInput struct { - // The identifier (ID) of the backup to modify. To find the ID of a backup, use the - // DescribeBackups operation. + // The identifier (ID) of the backup to modify. To find the ID of a backup, use + // the DescribeBackups operation. // // This member is required. BackupId *string @@ -48,9 +48,9 @@ type ModifyBackupAttributesInput struct { type ModifyBackupAttributesOutput struct { // Contains information about a backup of an AWS CloudHSM cluster. All backup - // objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp + // objects contain the BackupId , BackupState , ClusterId , and CreateTimestamp // parameters. Backups that were copied into a destination region additionally - // contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion + // contain the CopyTimestamp , SourceBackup , SourceCluster , and SourceRegion // parameters. A backup that is pending deletion will include the DeleteTimestamp // parameter. Backup *types.Backup diff --git a/service/cloudhsmv2/api_op_ModifyCluster.go b/service/cloudhsmv2/api_op_ModifyCluster.go index aeb578c2703..d17503aaf4a 100644 --- a/service/cloudhsmv2/api_op_ModifyCluster.go +++ b/service/cloudhsmv2/api_op_ModifyCluster.go @@ -35,7 +35,7 @@ type ModifyClusterInput struct { BackupRetentionPolicy *types.BackupRetentionPolicy // The identifier (ID) of the cluster that you want to modify. To find the cluster - // ID, use DescribeClusters. + // ID, use DescribeClusters . // // This member is required. ClusterId *string diff --git a/service/cloudhsmv2/api_op_RestoreBackup.go b/service/cloudhsmv2/api_op_RestoreBackup.go index 33ee2978015..6cf16ed36ce 100644 --- a/service/cloudhsmv2/api_op_RestoreBackup.go +++ b/service/cloudhsmv2/api_op_RestoreBackup.go @@ -12,7 +12,7 @@ import ( ) // Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. -// For mor information on deleting a backup, see DeleteBackup. +// For mor information on deleting a backup, see DeleteBackup . func (c *Client) RestoreBackup(ctx context.Context, params *RestoreBackupInput, optFns ...func(*Options)) (*RestoreBackupOutput, error) { if params == nil { params = &RestoreBackupInput{} diff --git a/service/cloudhsmv2/api_op_TagResource.go b/service/cloudhsmv2/api_op_TagResource.go index 0e31a2d680d..76ef753f5c7 100644 --- a/service/cloudhsmv2/api_op_TagResource.go +++ b/service/cloudhsmv2/api_op_TagResource.go @@ -30,7 +30,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The cluster identifier (ID) for the cluster that you are tagging. To find the - // cluster ID, use DescribeClusters. + // cluster ID, use DescribeClusters . // // This member is required. ResourceId *string diff --git a/service/cloudhsmv2/api_op_UntagResource.go b/service/cloudhsmv2/api_op_UntagResource.go index 40c8539f1d2..9cb4a39fa93 100644 --- a/service/cloudhsmv2/api_op_UntagResource.go +++ b/service/cloudhsmv2/api_op_UntagResource.go @@ -28,8 +28,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The cluster identifier (ID) for the cluster whose tags you are removing. To find - // the cluster ID, use DescribeClusters. + // The cluster identifier (ID) for the cluster whose tags you are removing. To + // find the cluster ID, use DescribeClusters . // // This member is required. ResourceId *string diff --git a/service/cloudhsmv2/doc.go b/service/cloudhsmv2/doc.go index a6850379cf4..6c86685ce8d 100644 --- a/service/cloudhsmv2/doc.go +++ b/service/cloudhsmv2/doc.go @@ -3,7 +3,7 @@ // Package cloudhsmv2 provides the API client, operations, and parameter types for // AWS CloudHSM V2. // -// For more information about AWS CloudHSM, see AWS CloudHSM -// (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/). +// For more information about AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) +// and the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/) +// . package cloudhsmv2 diff --git a/service/cloudhsmv2/types/enums.go b/service/cloudhsmv2/types/enums.go index a5e1d28613c..4b9c9f46aa3 100644 --- a/service/cloudhsmv2/types/enums.go +++ b/service/cloudhsmv2/types/enums.go @@ -9,9 +9,9 @@ const ( BackupPolicyDefault BackupPolicy = "DEFAULT" ) -// Values returns all known values for BackupPolicy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BackupPolicy. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BackupPolicy) Values() []BackupPolicy { return []BackupPolicy{ "DEFAULT", @@ -71,9 +71,9 @@ const ( ClusterStateDegraded ClusterState = "DEGRADED" ) -// Values returns all known values for ClusterState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClusterState) Values() []ClusterState { return []ClusterState{ "CREATE_IN_PROGRESS", diff --git a/service/cloudhsmv2/types/errors.go b/service/cloudhsmv2/types/errors.go index 13c9437c3bb..d66852dd4d0 100644 --- a/service/cloudhsmv2/types/errors.go +++ b/service/cloudhsmv2/types/errors.go @@ -139,8 +139,8 @@ func (e *CloudHsmServiceException) ErrorCode() string { } func (e *CloudHsmServiceException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because of a tagging failure. Verify the tag conditions -// in all applicable policies, and then retry the request. +// The request was rejected because of a tagging failure. Verify the tag +// conditions in all applicable policies, and then retry the request. type CloudHsmTagException struct { Message *string diff --git a/service/cloudhsmv2/types/types.go b/service/cloudhsmv2/types/types.go index 13f01e63a9c..44ffa9e510b 100644 --- a/service/cloudhsmv2/types/types.go +++ b/service/cloudhsmv2/types/types.go @@ -8,9 +8,9 @@ import ( ) // Contains information about a backup of an AWS CloudHSM cluster. All backup -// objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp +// objects contain the BackupId , BackupState , ClusterId , and CreateTimestamp // parameters. Backups that were copied into a destination region additionally -// contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion +// contain the CopyTimestamp , SourceBackup , SourceCluster , and SourceRegion // parameters. A backup that is pending deletion will include the DeleteTimestamp // parameter. type Backup struct { @@ -81,7 +81,7 @@ type Certificates struct { ClusterCertificate *string // The cluster's certificate signing request (CSR). The CSR exists only when the - // cluster's state is UNINITIALIZED. + // cluster's state is UNINITIALIZED . ClusterCsr *string // The HSM certificate issued (signed) by the HSM hardware. diff --git a/service/cloudsearch/api_client.go b/service/cloudsearch/api_client.go index 9050d1b44b2..8d206b1ef84 100644 --- a/service/cloudsearch/api_client.go +++ b/service/cloudsearch/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudsearch/api_op_BuildSuggesters.go b/service/cloudsearch/api_op_BuildSuggesters.go index b377110ee92..fd7d5c35f09 100644 --- a/service/cloudsearch/api_op_BuildSuggesters.go +++ b/service/cloudsearch/api_op_BuildSuggesters.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Indexes the search suggestions. For more information, see Configuring Suggesters -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) +// Indexes the search suggestions. For more information, see Configuring Suggesters (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) // in the Amazon CloudSearch Developer Guide. func (c *Client) BuildSuggesters(ctx context.Context, params *BuildSuggestersInput, optFns ...func(*Options)) (*BuildSuggestersOutput, error) { if params == nil { @@ -28,8 +27,8 @@ func (c *Client) BuildSuggesters(ctx context.Context, params *BuildSuggestersInp return out, nil } -// Container for the parameters to the BuildSuggester operation. Specifies the name -// of the domain you want to update. +// Container for the parameters to the BuildSuggester operation. Specifies the +// name of the domain you want to update. type BuildSuggestersInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_CreateDomain.go b/service/cloudsearch/api_op_CreateDomain.go index 51a72a38ed9..df01e4be06c 100644 --- a/service/cloudsearch/api_op_CreateDomain.go +++ b/service/cloudsearch/api_op_CreateDomain.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new search domain. For more information, see Creating a Search Domain -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) +// Creates a new search domain. For more information, see Creating a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { @@ -29,8 +28,8 @@ func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, op return out, nil } -// Container for the parameters to the CreateDomain operation. Specifies a name for -// the new search domain. +// Container for the parameters to the CreateDomain operation. Specifies a name +// for the new search domain. type CreateDomainInput struct { // A name for the domain you are creating. Allowed characters are a-z (lower-case @@ -43,7 +42,7 @@ type CreateDomainInput struct { noSmithyDocumentSerde } -// The result of a CreateDomainRequest. Contains the status of a newly created +// The result of a CreateDomainRequest . Contains the status of a newly created // domain. type CreateDomainOutput struct { diff --git a/service/cloudsearch/api_op_DefineAnalysisScheme.go b/service/cloudsearch/api_op_DefineAnalysisScheme.go index f51cd5f01f2..d6e567fedfd 100644 --- a/service/cloudsearch/api_op_DefineAnalysisScheme.go +++ b/service/cloudsearch/api_op_DefineAnalysisScheme.go @@ -13,8 +13,7 @@ import ( // Configures an analysis scheme that can be applied to a text or text-array field // to define language-specific text processing options. For more information, see -// Configuring Analysis Schemes -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) +// Configuring Analysis Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DefineAnalysisScheme(ctx context.Context, params *DefineAnalysisSchemeInput, optFns ...func(*Options)) (*DefineAnalysisSchemeOutput, error) { if params == nil { @@ -37,8 +36,8 @@ type DefineAnalysisSchemeInput struct { // Configuration information for an analysis scheme. Each analysis scheme has a // unique name and specifies the language of the text to be processed. The - // following options can be configured for an analysis scheme: Synonyms, Stopwords, - // StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming. + // following options can be configured for an analysis scheme: Synonyms , Stopwords + // , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming . // // This member is required. AnalysisScheme *types.AnalysisScheme @@ -58,7 +57,7 @@ type DefineAnalysisSchemeInput struct { // newly-configured analysis scheme. type DefineAnalysisSchemeOutput struct { - // The status and configuration of an AnalysisScheme. + // The status and configuration of an AnalysisScheme . // // This member is required. AnalysisScheme *types.AnalysisSchemeStatus diff --git a/service/cloudsearch/api_op_DefineExpression.go b/service/cloudsearch/api_op_DefineExpression.go index 1c2fbb9ccda..df4b9e79a78 100644 --- a/service/cloudsearch/api_op_DefineExpression.go +++ b/service/cloudsearch/api_op_DefineExpression.go @@ -13,8 +13,7 @@ import ( // Configures an Expression for the search domain. Used to create new expressions // and modify existing ones. If the expression exists, the new configuration -// replaces the old one. For more information, see Configuring Expressions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) +// replaces the old one. For more information, see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DefineExpression(ctx context.Context, params *DefineExpressionInput, optFns ...func(*Options)) (*DefineExpressionOutput, error) { if params == nil { @@ -43,9 +42,9 @@ type DefineExpressionInput struct { // This member is required. DomainName *string - // A named expression that can be evaluated at search time. Can be used to sort the - // search results, define other expressions, or return computed information in the - // search results. + // A named expression that can be evaluated at search time. Can be used to sort + // the search results, define other expressions, or return computed information in + // the search results. // // This member is required. Expression *types.Expression diff --git a/service/cloudsearch/api_op_DefineIndexField.go b/service/cloudsearch/api_op_DefineIndexField.go index dcdeb33ee6a..14c7fc2e377 100644 --- a/service/cloudsearch/api_op_DefineIndexField.go +++ b/service/cloudsearch/api_op_DefineIndexField.go @@ -16,9 +16,8 @@ import ( // configuring and an index field configuration. The index field configuration // specifies a unique name, the index field type, and the options you want to // configure for the field. The options you can specify depend on the -// IndexFieldType. If the field exists, the new configuration replaces the old one. -// For more information, see Configuring Index Fields -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) +// IndexFieldType . If the field exists, the new configuration replaces the old +// one. For more information, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldInput, optFns ...func(*Options)) (*DefineIndexFieldOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DefineSuggester.go b/service/cloudsearch/api_op_DefineSuggester.go index 613f6ac19d4..b101764ec6e 100644 --- a/service/cloudsearch/api_op_DefineSuggester.go +++ b/service/cloudsearch/api_op_DefineSuggester.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Configures a suggester for a domain. A suggester enables you to display possible -// matches before users finish typing their queries. When you configure a +// Configures a suggester for a domain. A suggester enables you to display +// possible matches before users finish typing their queries. When you configure a // suggester, you must specify the name of the text field you want to search for // possible matches and a unique name for the suggester. For more information, see -// Getting Search Suggestions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) +// Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DefineSuggester(ctx context.Context, params *DefineSuggesterInput, optFns ...func(*Options)) (*DefineSuggesterOutput, error) { if params == nil { @@ -47,7 +46,7 @@ type DefineSuggesterInput struct { // Configuration information for a search suggester. Each suggester has a unique // name and specifies the text field you want to use for suggestions. The following - // options can be configured for a suggester: FuzzyMatching, SortExpression. + // options can be configured for a suggester: FuzzyMatching , SortExpression . // // This member is required. Suggester *types.Suggester diff --git a/service/cloudsearch/api_op_DeleteAnalysisScheme.go b/service/cloudsearch/api_op_DeleteAnalysisScheme.go index 89d49a9841a..1a61594db05 100644 --- a/service/cloudsearch/api_op_DeleteAnalysisScheme.go +++ b/service/cloudsearch/api_op_DeleteAnalysisScheme.go @@ -12,8 +12,7 @@ import ( ) // Deletes an analysis scheme. For more information, see Configuring Analysis -// Schemes -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) +// Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DeleteAnalysisScheme(ctx context.Context, params *DeleteAnalysisSchemeInput, optFns ...func(*Options)) (*DeleteAnalysisSchemeOutput, error) { if params == nil { @@ -51,8 +50,8 @@ type DeleteAnalysisSchemeInput struct { noSmithyDocumentSerde } -// The result of a DeleteAnalysisScheme request. Contains the status of the deleted -// analysis scheme. +// The result of a DeleteAnalysisScheme request. Contains the status of the +// deleted analysis scheme. type DeleteAnalysisSchemeOutput struct { // The status of the analysis scheme being deleted. diff --git a/service/cloudsearch/api_op_DeleteDomain.go b/service/cloudsearch/api_op_DeleteDomain.go index 05ad94a8224..96a3461b061 100644 --- a/service/cloudsearch/api_op_DeleteDomain.go +++ b/service/cloudsearch/api_op_DeleteDomain.go @@ -13,8 +13,7 @@ import ( // Permanently deletes a search domain and all of its data. Once a domain has been // deleted, it cannot be recovered. For more information, see Deleting a Search -// Domain -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) +// Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DeleteExpression.go b/service/cloudsearch/api_op_DeleteExpression.go index 0dca66e1188..59c65661922 100644 --- a/service/cloudsearch/api_op_DeleteExpression.go +++ b/service/cloudsearch/api_op_DeleteExpression.go @@ -12,8 +12,7 @@ import ( ) // Removes an Expression from the search domain. For more information, see -// Configuring Expressions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) +// Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DeleteExpression(ctx context.Context, params *DeleteExpressionInput, optFns ...func(*Options)) (*DeleteExpressionOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DeleteIndexField.go b/service/cloudsearch/api_op_DeleteIndexField.go index 889caa8828d..eddcfed9c4b 100644 --- a/service/cloudsearch/api_op_DeleteIndexField.go +++ b/service/cloudsearch/api_op_DeleteIndexField.go @@ -12,8 +12,7 @@ import ( ) // Removes an IndexField from the search domain. For more information, see -// Configuring Index Fields -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) +// Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DeleteIndexField(ctx context.Context, params *DeleteIndexFieldInput, optFns ...func(*Options)) (*DeleteIndexFieldOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DeleteSuggester.go b/service/cloudsearch/api_op_DeleteSuggester.go index 4e330ddb80c..21d91632050 100644 --- a/service/cloudsearch/api_op_DeleteSuggester.go +++ b/service/cloudsearch/api_op_DeleteSuggester.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a suggester. For more information, see Getting Search Suggestions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) +// Deletes a suggester. For more information, see Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DeleteSuggester(ctx context.Context, params *DeleteSuggesterInput, optFns ...func(*Options)) (*DeleteSuggesterOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DescribeAnalysisSchemes.go b/service/cloudsearch/api_op_DescribeAnalysisSchemes.go index 30c84c53e8b..e2dad650632 100644 --- a/service/cloudsearch/api_op_DescribeAnalysisSchemes.go +++ b/service/cloudsearch/api_op_DescribeAnalysisSchemes.go @@ -16,8 +16,7 @@ import ( // specific analysis schemes by name. By default, shows all analysis schemes and // includes any pending changes to the configuration. Set the Deployed option to // true to show the active configuration and exclude pending changes. For more -// information, see Configuring Analysis Schemes -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) +// information, see Configuring Analysis Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeAnalysisSchemes(ctx context.Context, params *DescribeAnalysisSchemesInput, optFns ...func(*Options)) (*DescribeAnalysisSchemesOutput, error) { if params == nil { @@ -34,11 +33,11 @@ func (c *Client) DescribeAnalysisSchemes(ctx context.Context, params *DescribeAn return out, nil } -// Container for the parameters to the DescribeAnalysisSchemes operation. Specifies -// the name of the domain you want to describe. To limit the response to particular -// analysis schemes, specify the names of the analysis schemes you want to -// describe. To show the active configuration and exclude any pending changes, set -// the Deployed option to true. +// Container for the parameters to the DescribeAnalysisSchemes operation. +// Specifies the name of the domain you want to describe. To limit the response to +// particular analysis schemes, specify the names of the analysis schemes you want +// to describe. To show the active configuration and exclude any pending changes, +// set the Deployed option to true . type DescribeAnalysisSchemesInput struct { // The name of the domain you want to describe. @@ -49,8 +48,8 @@ type DescribeAnalysisSchemesInput struct { // The analysis schemes you want to describe. AnalysisSchemeNames []string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool noSmithyDocumentSerde diff --git a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go index 950740db9e2..258143accb8 100644 --- a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go +++ b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go @@ -14,8 +14,7 @@ import ( // Gets the availability options configured for a domain. By default, shows the // configuration with any pending changes. Set the Deployed option to true to show // the active configuration and exclude pending changes. For more information, see -// Configuring Availability Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) +// Configuring Availability Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *DescribeAvailabilityOptionsInput, optFns ...func(*Options)) (*DescribeAvailabilityOptionsOutput, error) { if params == nil { @@ -34,7 +33,7 @@ func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *Descri // Container for the parameters to the DescribeAvailabilityOptions operation. // Specifies the name of the domain you want to describe. To show the active -// configuration and exclude any pending changes, set the Deployed option to true. +// configuration and exclude any pending changes, set the Deployed option to true . type DescribeAvailabilityOptionsInput struct { // The name of the domain you want to describe. @@ -42,8 +41,8 @@ type DescribeAvailabilityOptionsInput struct { // This member is required. DomainName *string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool noSmithyDocumentSerde diff --git a/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go b/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go index 8cff2dfa46c..3d3e0390b1f 100644 --- a/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go +++ b/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go @@ -13,8 +13,7 @@ import ( // Returns the domain's endpoint options, specifically whether all requests to the // domain must arrive over HTTPS. For more information, see Configuring Domain -// Endpoint Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) +// Endpoint Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeDomainEndpointOptions(ctx context.Context, params *DescribeDomainEndpointOptionsInput, optFns ...func(*Options)) (*DescribeDomainEndpointOptionsOutput, error) { if params == nil { @@ -33,7 +32,7 @@ func (c *Client) DescribeDomainEndpointOptions(ctx context.Context, params *Desc // Container for the parameters to the DescribeDomainEndpointOptions operation. // Specify the name of the domain you want to describe. To show the active -// configuration and exclude any pending changes, set the Deployed option to true. +// configuration and exclude any pending changes, set the Deployed option to true . type DescribeDomainEndpointOptionsInput struct { // A string that represents the name of a domain. @@ -42,7 +41,7 @@ type DescribeDomainEndpointOptionsInput struct { DomainName *string // Whether to retrieve the latest configuration (which might be in a Processing - // state) or the current, active configuration. Defaults to false. + // state) or the current, active configuration. Defaults to false . Deployed *bool noSmithyDocumentSerde diff --git a/service/cloudsearch/api_op_DescribeDomains.go b/service/cloudsearch/api_op_DescribeDomains.go index bdf4038c4d4..1c4942d6a6f 100644 --- a/service/cloudsearch/api_op_DescribeDomains.go +++ b/service/cloudsearch/api_op_DescribeDomains.go @@ -14,9 +14,8 @@ import ( // Gets information about the search domains owned by this account. Can be limited // to specific domains. Shows all domains by default. To get the number of // searchable documents in a domain, use the console or submit a matchall request -// to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For -// more information, see Getting Information about a Search Domain -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) +// to your domain's search endpoint: q=matchall&q.parser=structured&size=0 . For +// more information, see Getting Information about a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeDomains(ctx context.Context, params *DescribeDomainsInput, optFns ...func(*Options)) (*DescribeDomainsOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DescribeExpressions.go b/service/cloudsearch/api_op_DescribeExpressions.go index dcb7e61a6e9..9503264e337 100644 --- a/service/cloudsearch/api_op_DescribeExpressions.go +++ b/service/cloudsearch/api_op_DescribeExpressions.go @@ -15,8 +15,7 @@ import ( // specific expressions by name. By default, shows all expressions and includes any // pending changes to the configuration. Set the Deployed option to true to show // the active configuration and exclude pending changes. For more information, see -// Configuring Expressions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) +// Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpressionsInput, optFns ...func(*Options)) (*DescribeExpressionsOutput, error) { if params == nil { @@ -37,7 +36,7 @@ func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpres // name of the domain you want to describe. To restrict the response to particular // expressions, specify the names of the expressions you want to describe. To show // the active configuration and exclude any pending changes, set the Deployed -// option to true. +// option to true . type DescribeExpressionsInput struct { // The name of the domain you want to describe. @@ -45,8 +44,8 @@ type DescribeExpressionsInput struct { // This member is required. DomainName *string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool // Limits the DescribeExpressions response to the specified expressions. If not @@ -56,8 +55,8 @@ type DescribeExpressionsInput struct { noSmithyDocumentSerde } -// The result of a DescribeExpressions request. Contains the expressions configured -// for the domain specified in the request. +// The result of a DescribeExpressions request. Contains the expressions +// configured for the domain specified in the request. type DescribeExpressionsOutput struct { // The expressions configured for the domain. diff --git a/service/cloudsearch/api_op_DescribeIndexFields.go b/service/cloudsearch/api_op_DescribeIndexFields.go index ca76cb8f5e9..80eb0867dd5 100644 --- a/service/cloudsearch/api_op_DescribeIndexFields.go +++ b/service/cloudsearch/api_op_DescribeIndexFields.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the index fields configured for the search domain. Can be -// limited to specific fields by name. By default, shows all fields and includes +// Gets information about the index fields configured for the search domain. Can +// be limited to specific fields by name. By default, shows all fields and includes // any pending changes to the configuration. Set the Deployed option to true to // show the active configuration and exclude pending changes. For more information, -// see Getting Domain Information -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) +// see Getting Domain Information (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeIndexFields(ctx context.Context, params *DescribeIndexFieldsInput, optFns ...func(*Options)) (*DescribeIndexFieldsOutput, error) { if params == nil { @@ -33,11 +32,11 @@ func (c *Client) DescribeIndexFields(ctx context.Context, params *DescribeIndexF return out, nil } -// Container for the parameters to the DescribeIndexFields operation. Specifies the -// name of the domain you want to describe. To restrict the response to particular -// index fields, specify the names of the index fields you want to describe. To -// show the active configuration and exclude any pending changes, set the Deployed -// option to true. +// Container for the parameters to the DescribeIndexFields operation. Specifies +// the name of the domain you want to describe. To restrict the response to +// particular index fields, specify the names of the index fields you want to +// describe. To show the active configuration and exclude any pending changes, set +// the Deployed option to true . type DescribeIndexFieldsInput struct { // The name of the domain you want to describe. @@ -45,8 +44,8 @@ type DescribeIndexFieldsInput struct { // This member is required. DomainName *string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool // A list of the index fields you want to describe. If not specified, information diff --git a/service/cloudsearch/api_op_DescribeScalingParameters.go b/service/cloudsearch/api_op_DescribeScalingParameters.go index 17b3258f322..8f7e982f7ad 100644 --- a/service/cloudsearch/api_op_DescribeScalingParameters.go +++ b/service/cloudsearch/api_op_DescribeScalingParameters.go @@ -13,8 +13,7 @@ import ( // Gets the scaling parameters configured for a domain. A domain's scaling // parameters specify the desired search instance type and replication count. For -// more information, see Configuring Scaling Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) +// more information, see Configuring Scaling Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeScalingParameters(ctx context.Context, params *DescribeScalingParametersInput, optFns ...func(*Options)) (*DescribeScalingParametersOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go b/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go index bea1e0ade1c..fac7020f0f9 100644 --- a/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go +++ b/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go @@ -14,9 +14,8 @@ import ( // Gets information about the access policies that control access to the domain's // document and search endpoints. By default, shows the configuration with any // pending changes. Set the Deployed option to true to show the active -// configuration and exclude pending changes. For more information, see Configuring -// Access for a Search Domain -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) +// configuration and exclude pending changes. For more information, see +// Configuring Access for a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeServiceAccessPolicies(ctx context.Context, params *DescribeServiceAccessPoliciesInput, optFns ...func(*Options)) (*DescribeServiceAccessPoliciesOutput, error) { if params == nil { @@ -35,7 +34,7 @@ func (c *Client) DescribeServiceAccessPolicies(ctx context.Context, params *Desc // Container for the parameters to the DescribeServiceAccessPolicies operation. // Specifies the name of the domain you want to describe. To show the active -// configuration and exclude any pending changes, set the Deployed option to true. +// configuration and exclude any pending changes, set the Deployed option to true . type DescribeServiceAccessPoliciesInput struct { // The name of the domain you want to describe. @@ -43,8 +42,8 @@ type DescribeServiceAccessPoliciesInput struct { // This member is required. DomainName *string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool noSmithyDocumentSerde diff --git a/service/cloudsearch/api_op_DescribeSuggesters.go b/service/cloudsearch/api_op_DescribeSuggesters.go index 7ae716673f6..5b9bc0977ad 100644 --- a/service/cloudsearch/api_op_DescribeSuggesters.go +++ b/service/cloudsearch/api_op_DescribeSuggesters.go @@ -16,8 +16,7 @@ import ( // specific suggesters by name. By default, shows all suggesters and includes any // pending changes to the configuration. Set the Deployed option to true to show // the active configuration and exclude pending changes. For more information, see -// Getting Search Suggestions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) +// Getting Search Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggestersInput, optFns ...func(*Options)) (*DescribeSuggestersOutput, error) { if params == nil { @@ -38,7 +37,7 @@ func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggest // name of the domain you want to describe. To restrict the response to particular // suggesters, specify the names of the suggesters you want to describe. To show // the active configuration and exclude any pending changes, set the Deployed -// option to true. +// option to true . type DescribeSuggestersInput struct { // The name of the domain you want to describe. @@ -46,8 +45,8 @@ type DescribeSuggestersInput struct { // This member is required. DomainName *string - // Whether to display the deployed configuration (true) or include any pending - // changes (false). Defaults to false. + // Whether to display the deployed configuration ( true ) or include any pending + // changes ( false ). Defaults to false . Deployed *bool // The suggesters you want to describe. diff --git a/service/cloudsearch/api_op_IndexDocuments.go b/service/cloudsearch/api_op_IndexDocuments.go index 02ec819d737..95643f59519 100644 --- a/service/cloudsearch/api_op_IndexDocuments.go +++ b/service/cloudsearch/api_op_IndexDocuments.go @@ -12,7 +12,7 @@ import ( // Tells the search domain to start indexing its documents using the latest // indexing options. This operation must be invoked to activate options whose -// OptionStatus is RequiresIndexDocuments. +// OptionStatus is RequiresIndexDocuments . func (c *Client) IndexDocuments(ctx context.Context, params *IndexDocumentsInput, optFns ...func(*Options)) (*IndexDocumentsOutput, error) { if params == nil { params = &IndexDocumentsInput{} @@ -28,8 +28,8 @@ func (c *Client) IndexDocuments(ctx context.Context, params *IndexDocumentsInput return out, nil } -// Container for the parameters to the IndexDocuments operation. Specifies the name -// of the domain you want to re-index. +// Container for the parameters to the IndexDocuments operation. Specifies the +// name of the domain you want to re-index. type IndexDocumentsInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_ListDomainNames.go b/service/cloudsearch/api_op_ListDomainNames.go index 94cf53ac502..1ca6dbe7f4d 100644 --- a/service/cloudsearch/api_op_ListDomainNames.go +++ b/service/cloudsearch/api_op_ListDomainNames.go @@ -30,8 +30,8 @@ type ListDomainNamesInput struct { noSmithyDocumentSerde } -// The result of a ListDomainNames request. Contains a list of the domains owned by -// an account. +// The result of a ListDomainNames request. Contains a list of the domains owned +// by an account. type ListDomainNamesOutput struct { // The names of the search domains owned by an account. diff --git a/service/cloudsearch/api_op_UpdateAvailabilityOptions.go b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go index ed41bb4f19c..1b2f75dc186 100644 --- a/service/cloudsearch/api_op_UpdateAvailabilityOptions.go +++ b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go @@ -15,8 +15,7 @@ import ( // expands an Amazon CloudSearch domain to an additional Availability Zone in the // same Region to increase fault tolerance in the event of a service disruption. // Changes to the Multi-AZ option can take about half an hour to become active. For -// more information, see Configuring Availability Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) +// more information, see Configuring Availability Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) UpdateAvailabilityOptions(ctx context.Context, params *UpdateAvailabilityOptionsInput, optFns ...func(*Options)) (*UpdateAvailabilityOptionsOutput, error) { if params == nil { @@ -49,7 +48,7 @@ type UpdateAvailabilityOptionsInput struct { // You expand an existing search domain to a second Availability Zone by setting // the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to // downgrade the domain to a single Availability Zone by setting the Multi-AZ - // option to false. + // option to false . // // This member is required. MultiAZ *bool @@ -61,8 +60,8 @@ type UpdateAvailabilityOptionsInput struct { // domain's availability options. type UpdateAvailabilityOptionsOutput struct { - // The newly-configured availability options. Indicates whether Multi-AZ is enabled - // for the domain. + // The newly-configured availability options. Indicates whether Multi-AZ is + // enabled for the domain. AvailabilityOptions *types.AvailabilityOptionsStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go b/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go index 0e6629f508b..e54b8d9bb41 100644 --- a/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go +++ b/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go @@ -13,8 +13,7 @@ import ( // Updates the domain's endpoint options, specifically whether all requests to the // domain must arrive over HTTPS. For more information, see Configuring Domain -// Endpoint Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) +// Endpoint Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) UpdateDomainEndpointOptions(ctx context.Context, params *UpdateDomainEndpointOptionsInput, optFns ...func(*Options)) (*UpdateDomainEndpointOptionsOutput, error) { if params == nil { diff --git a/service/cloudsearch/api_op_UpdateScalingParameters.go b/service/cloudsearch/api_op_UpdateScalingParameters.go index 23a695771d9..4e2900c1c88 100644 --- a/service/cloudsearch/api_op_UpdateScalingParameters.go +++ b/service/cloudsearch/api_op_UpdateScalingParameters.go @@ -16,8 +16,7 @@ import ( // CloudSearch will still automatically scale your domain based on the volume of // data and traffic, but not below the desired instance type and replication count. // If the Multi-AZ option is enabled, these values control the resources used per -// Availability Zone. For more information, see Configuring Scaling Options -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) +// Availability Zone. For more information, see Configuring Scaling Options (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) UpdateScalingParameters(ctx context.Context, params *UpdateScalingParametersInput, optFns ...func(*Options)) (*UpdateScalingParametersOutput, error) { if params == nil { @@ -34,9 +33,9 @@ func (c *Client) UpdateScalingParameters(ctx context.Context, params *UpdateScal return out, nil } -// Container for the parameters to the UpdateScalingParameters operation. Specifies -// the name of the domain you want to update and the scaling parameters you want to -// configure. +// Container for the parameters to the UpdateScalingParameters operation. +// Specifies the name of the domain you want to update and the scaling parameters +// you want to configure. type UpdateScalingParametersInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go b/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go index 015933b57fe..61351441bc9 100644 --- a/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go +++ b/service/cloudsearch/api_op_UpdateServiceAccessPolicies.go @@ -12,9 +12,9 @@ import ( ) // Configures the access rules that control access to the domain's document and -// search endpoints. For more information, see Configuring Access for an Amazon -// CloudSearch Domain -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html). +// search endpoints. For more information, see Configuring Access for an Amazon +// CloudSearch Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) +// . func (c *Client) UpdateServiceAccessPolicies(ctx context.Context, params *UpdateServiceAccessPoliciesInput, optFns ...func(*Options)) (*UpdateServiceAccessPoliciesOutput, error) { if params == nil { params = &UpdateServiceAccessPoliciesInput{} diff --git a/service/cloudsearch/doc.go b/service/cloudsearch/doc.go index f4f558ff82b..800d931176c 100644 --- a/service/cloudsearch/doc.go +++ b/service/cloudsearch/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package cloudsearch provides the API client, operations, and parameter types for -// Amazon CloudSearch. +// Package cloudsearch provides the API client, operations, and parameter types +// for Amazon CloudSearch. // // Amazon CloudSearch Configuration Service You use the Amazon CloudSearch // configuration service to create, configure, and manage search domains. @@ -10,6 +10,6 @@ // query parameter named Action. The endpoint for configuration service requests is // region-specific: cloudsearch.region.amazonaws.com. For example, // cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and -// endpoints, see Regions and Endpoints -// (http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region). +// endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region) +// . package cloudsearch diff --git a/service/cloudsearch/types/enums.go b/service/cloudsearch/types/enums.go index ab4cf2b56ad..e1af516b5fa 100644 --- a/service/cloudsearch/types/enums.go +++ b/service/cloudsearch/types/enums.go @@ -189,8 +189,8 @@ const ( PartitionInstanceTypeSearchPreviousgeneration2xlarge PartitionInstanceType = "search.previousgeneration.2xlarge" ) -// Values returns all known values for PartitionInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PartitionInstanceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PartitionInstanceType) Values() []PartitionInstanceType { return []PartitionInstanceType{ diff --git a/service/cloudsearch/types/errors.go b/service/cloudsearch/types/errors.go index 6bd5367aef3..27e41d68d20 100644 --- a/service/cloudsearch/types/errors.go +++ b/service/cloudsearch/types/errors.go @@ -64,8 +64,8 @@ func (e *DisabledOperationException) ErrorCode() string { func (e *DisabledOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An internal error occurred while processing the request. If this problem -// persists, report an issue from the Service Health Dashboard -// (http://status.aws.amazon.com/). +// persists, report an issue from the Service Health Dashboard (http://status.aws.amazon.com/) +// . type InternalException struct { Message *string diff --git a/service/cloudsearch/types/types.go b/service/cloudsearch/types/types.go index 1d4b21bce0f..b582a914ee6 100644 --- a/service/cloudsearch/types/types.go +++ b/service/cloudsearch/types/types.go @@ -12,8 +12,7 @@ import ( type AccessPoliciesStatus struct { // Access rules for a domain's document or search service endpoints. For more - // information, see Configuring Access for a Search Domain - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) + // information, see Configuring Access for a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) // in the Amazon CloudSearch Developer Guide. The maximum size of a policy document // is 100 KB. // @@ -32,10 +31,9 @@ type AccessPoliciesStatus struct { // tokenization dictionary for Japanese. type AnalysisOptions struct { - // The level of algorithmic stemming to perform: none, minimal, light, or full. The - // available levels vary depending on the language. For more information, see - // Language Specific Text Processing Settings - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) + // The level of algorithmic stemming to perform: none , minimal , light , or full . + // The available levels vary depending on the language. For more information, see + // Language Specific Text Processing Settings (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) // in the Amazon CloudSearch Developer Guide AlgorithmicStemming AlgorithmicStemming @@ -47,14 +45,14 @@ type AnalysisOptions struct { // A JSON object that contains a collection of string:value pairs that each map a // term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": - // "stem3"}. The stemming dictionary is applied in addition to any algorithmic + // "stem3"} . The stemming dictionary is applied in addition to any algorithmic // stemming. This enables you to override the results of the algorithmic stemming // to correct specific cases of overstemming or understemming. The maximum size of // a stemming dictionary is 500 KB. StemmingDictionary *string // A JSON array of terms to ignore during indexing and searching. For example, - // ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each + // ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each // word you want to ignore. Wildcards and regular expressions are not supported. Stopwords *string @@ -65,8 +63,7 @@ type AnalysisOptions struct { // string specifies a term and the array of values specifies each of the aliases // for that term. An alias is considered a synonym of the specified term, but the // term is not considered a synonym of the alias. For more information about - // specifying synonyms, see Synonyms - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) + // specifying synonyms, see Synonyms (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) // in the Amazon CloudSearch Developer Guide. Synonyms *string @@ -75,8 +72,8 @@ type AnalysisOptions struct { // Configuration information for an analysis scheme. Each analysis scheme has a // unique name and specifies the language of the text to be processed. The -// following options can be configured for an analysis scheme: Synonyms, Stopwords, -// StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming. +// following options can be configured for an analysis scheme: Synonyms , Stopwords +// , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming . type AnalysisScheme struct { // An IETF RFC 4646 (http://tools.ietf.org/html/rfc4646) language code or mul for @@ -98,13 +95,13 @@ type AnalysisScheme struct { noSmithyDocumentSerde } -// The status and configuration of an AnalysisScheme. +// The status and configuration of an AnalysisScheme . type AnalysisSchemeStatus struct { // Configuration information for an analysis scheme. Each analysis scheme has a // unique name and specifies the language of the text to be processed. The - // following options can be configured for an analysis scheme: Synonyms, Stopwords, - // StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming. + // following options can be configured for an analysis scheme: Synonyms , Stopwords + // , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming . // // This member is required. Options *AnalysisScheme @@ -134,7 +131,7 @@ type AvailabilityOptionsStatus struct { } // Options for a field that contains an array of dates. Present if IndexFieldType -// specifies the field is of type date-array. All options are enabled by default. +// specifies the field is of type date-array . All options are enabled by default. type DateArrayOptions struct { // A value to use for the field if the field isn't specified for a document. @@ -157,7 +154,7 @@ type DateArrayOptions struct { // Options for a date field. Dates and times are specified in UTC (Coordinated // Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if -// IndexFieldType specifies the field is of type date. All options are enabled by +// IndexFieldType specifies the field is of type date . All options are enabled by // default. type DateOptions struct { @@ -186,7 +183,7 @@ type DateOptions struct { // wildcard can also be the only character in a dynamic field name. Multiple // wildcards, and wildcards embedded within a string are not supported. The name // score is reserved and cannot be used as a field name. To reference a document's - // ID, you can use the name _id. + // ID, you can use the name _id . SourceField *string noSmithyDocumentSerde @@ -200,8 +197,8 @@ type DocumentSuggesterOptions struct { // This member is required. SourceField *string - // The level of fuzziness allowed when suggesting matches for a string: none, low, - // or high. With none, the specified string is treated as an exact prefix. With + // The level of fuzziness allowed when suggesting matches for a string: none , low + // , or high . With none, the specified string is treated as an exact prefix. With // low, suggestions must differ from the specified string by no more than one // character. With high, suggestions can differ by up to two characters. The // default is none. @@ -210,10 +207,10 @@ type DocumentSuggesterOptions struct { // An expression that computes a score for each suggestion to control how they are // sorted. The scores are rounded to the nearest integer, with a floor of 0 and a // ceiling of 2^31-1. A document's relevance score is not computed for suggestions, - // so sort expressions cannot reference the _score value. To sort suggestions using - // a numeric field or existing expression, simply specify the name of the field or - // expression. If no expression is configured for the suggester, the suggestions - // are sorted with the closest matches listed first. + // so sort expressions cannot reference the _score value. To sort suggestions + // using a numeric field or existing expression, simply specify the name of the + // field or expression. If no expression is configured for the suggester, the + // suggestions are sorted with the closest matches listed first. SortExpression *string noSmithyDocumentSerde @@ -270,8 +267,7 @@ type DomainStatus struct { RequiresIndexDocuments *bool // The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM - // Entities - // (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) + // Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) // in Using AWS Identity and Access Management for more information. ARN *string @@ -282,9 +278,9 @@ type DomainStatus struct { Created *bool // True if the search domain has been deleted. The system must clean up resources - // dedicated to the search domain when DeleteDomain is called. Newly deleted search - // domains are returned from DescribeDomains with a true value for IsDeleted for - // several minutes until resource cleanup is complete. + // dedicated to the search domain when DeleteDomain is called. Newly deleted + // search domains are returned from DescribeDomains with a true value for + // IsDeleted for several minutes until resource cleanup is complete. Deleted *bool // The service endpoint for updating documents in a search domain. @@ -312,7 +308,7 @@ type DomainStatus struct { // Options for a field that contains an array of double-precision 64-bit floating // point values. Present if IndexFieldType specifies the field is of type -// double-array. All options are enabled by default. +// double-array . All options are enabled by default. type DoubleArrayOptions struct { // A value to use for the field if the field isn't specified for a document. @@ -334,8 +330,8 @@ type DoubleArrayOptions struct { } // Options for a double-precision 64-bit floating point field. Present if -// IndexFieldType specifies the field is of type double. All options are enabled by -// default. +// IndexFieldType specifies the field is of type double . All options are enabled +// by default. type DoubleOptions struct { // A value to use for the field if the field isn't specified for a document. This @@ -361,9 +357,9 @@ type DoubleOptions struct { noSmithyDocumentSerde } -// A named expression that can be evaluated at search time. Can be used to sort the -// search results, define other expressions, or return computed information in the -// search results. +// A named expression that can be evaluated at search time. Can be used to sort +// the search results, define other expressions, or return computed information in +// the search results. type Expression struct { // Names must begin with a letter and can contain the following characters: a-z @@ -374,8 +370,7 @@ type Expression struct { // The expression to evaluate for sorting while processing a search request. The // Expression syntax is based on JavaScript expressions. For more information, see - // Configuring Expressions - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) + // Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) // in the Amazon CloudSearch Developer Guide. // // This member is required. @@ -401,7 +396,7 @@ type ExpressionStatus struct { } // Configuration information for a field in the index, including its name, type, -// and options. The supported options depend on the IndexFieldType. +// and options. The supported options depend on the IndexFieldType . type IndexField struct { // A string that represents the name of an index field. CloudSearch supports @@ -414,69 +409,69 @@ type IndexField struct { // wildcard can also be the only character in a dynamic field name. Multiple // wildcards, and wildcards embedded within a string are not supported. The name // score is reserved and cannot be used as a field name. To reference a document's - // ID, you can use the name _id. + // ID, you can use the name _id . // // This member is required. IndexFieldName *string // The type of field. The valid options for a field depend on the field type. For - // more information about the supported field types, see Configuring Index Fields - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) + // more information about the supported field types, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) // in the Amazon CloudSearch Developer Guide. // // This member is required. IndexFieldType IndexFieldType // Options for a field that contains an array of dates. Present if IndexFieldType - // specifies the field is of type date-array. All options are enabled by default. + // specifies the field is of type date-array . All options are enabled by default. DateArrayOptions *DateArrayOptions // Options for a date field. Dates and times are specified in UTC (Coordinated // Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if - // IndexFieldType specifies the field is of type date. All options are enabled by + // IndexFieldType specifies the field is of type date . All options are enabled by // default. DateOptions *DateOptions // Options for a field that contains an array of double-precision 64-bit floating // point values. Present if IndexFieldType specifies the field is of type - // double-array. All options are enabled by default. + // double-array . All options are enabled by default. DoubleArrayOptions *DoubleArrayOptions // Options for a double-precision 64-bit floating point field. Present if - // IndexFieldType specifies the field is of type double. All options are enabled by - // default. + // IndexFieldType specifies the field is of type double . All options are enabled + // by default. DoubleOptions *DoubleOptions - // Options for a field that contains an array of 64-bit signed integers. Present if - // IndexFieldType specifies the field is of type int-array. All options are enabled - // by default. + // Options for a field that contains an array of 64-bit signed integers. Present + // if IndexFieldType specifies the field is of type int-array . All options are + // enabled by default. IntArrayOptions *IntArrayOptions // Options for a 64-bit signed integer field. Present if IndexFieldType specifies - // the field is of type int. All options are enabled by default. + // the field is of type int . All options are enabled by default. IntOptions *IntOptions // Options for a latlon field. A latlon field contains a location stored as a - // latitude and longitude value pair. Present if IndexFieldType specifies the field - // is of type latlon. All options are enabled by default. + // latitude and longitude value pair. Present if IndexFieldType specifies the + // field is of type latlon . All options are enabled by default. LatLonOptions *LatLonOptions // Options for a field that contains an array of literal strings. Present if - // IndexFieldType specifies the field is of type literal-array. All options are + // IndexFieldType specifies the field is of type literal-array . All options are // enabled by default. LiteralArrayOptions *LiteralArrayOptions // Options for literal field. Present if IndexFieldType specifies the field is of - // type literal. All options are enabled by default. + // type literal . All options are enabled by default. LiteralOptions *LiteralOptions // Options for a field that contains an array of text strings. Present if - // IndexFieldType specifies the field is of type text-array. A text-array field is - // always searchable. All options are enabled by default. + // IndexFieldType specifies the field is of type text-array . A text-array field + // is always searchable. All options are enabled by default. TextArrayOptions *TextArrayOptions - // Options for text field. Present if IndexFieldType specifies the field is of type - // text. A text field is always searchable. All options are enabled by default. + // Options for text field. Present if IndexFieldType specifies the field is of + // type text . A text field is always searchable. All options are enabled by + // default. TextOptions *TextOptions noSmithyDocumentSerde @@ -486,7 +481,7 @@ type IndexField struct { type IndexFieldStatus struct { // Configuration information for a field in the index, including its name, type, - // and options. The supported options depend on the IndexFieldType. + // and options. The supported options depend on the IndexFieldType . // // This member is required. Options *IndexField @@ -499,9 +494,9 @@ type IndexFieldStatus struct { noSmithyDocumentSerde } -// Options for a field that contains an array of 64-bit signed integers. Present if -// IndexFieldType specifies the field is of type int-array. All options are enabled -// by default. +// Options for a field that contains an array of 64-bit signed integers. Present +// if IndexFieldType specifies the field is of type int-array . All options are +// enabled by default. type IntArrayOptions struct { // A value to use for the field if the field isn't specified for a document. @@ -523,7 +518,7 @@ type IntArrayOptions struct { } // Options for a 64-bit signed integer field. Present if IndexFieldType specifies -// the field is of type int. All options are enabled by default. +// the field is of type int . All options are enabled by default. type IntOptions struct { // A value to use for the field if the field isn't specified for a document. This @@ -550,8 +545,8 @@ type IntOptions struct { } // Options for a latlon field. A latlon field contains a location stored as a -// latitude and longitude value pair. Present if IndexFieldType specifies the field -// is of type latlon. All options are enabled by default. +// latitude and longitude value pair. Present if IndexFieldType specifies the +// field is of type latlon . All options are enabled by default. type LatLonOptions struct { // A value to use for the field if the field isn't specified for a document. @@ -579,7 +574,7 @@ type LatLonOptions struct { // wildcard can also be the only character in a dynamic field name. Multiple // wildcards, and wildcards embedded within a string are not supported. The name // score is reserved and cannot be used as a field name. To reference a document's - // ID, you can use the name _id. + // ID, you can use the name _id . SourceField *string noSmithyDocumentSerde @@ -597,7 +592,7 @@ type Limits struct { } // Options for a field that contains an array of literal strings. Present if -// IndexFieldType specifies the field is of type literal-array. All options are +// IndexFieldType specifies the field is of type literal-array . All options are // enabled by default. type LiteralArrayOptions struct { @@ -620,7 +615,7 @@ type LiteralArrayOptions struct { } // Options for literal field. Present if IndexFieldType specifies the field is of -// type literal. All options are enabled by default. +// type literal . All options are enabled by default. type LiteralOptions struct { // A value to use for the field if the field isn't specified for a document. @@ -648,7 +643,7 @@ type LiteralOptions struct { // wildcard can also be the only character in a dynamic field name. Multiple // wildcards, and wildcards embedded within a string are not supported. The name // score is reserved and cannot be used as a field name. To reference a document's - // ID, you can use the name _id. + // ID, you can use the name _id . SourceField *string noSmithyDocumentSerde @@ -663,21 +658,13 @@ type OptionStatus struct { CreationDate *time.Time // The state of processing a change to an option. Possible values: - // - // * - // RequiresIndexDocuments: the option's latest value will not be deployed until - // IndexDocuments has been called and indexing is complete. - // - // * Processing: the - // option's latest value is in the process of being activated. - // - // * Active: the - // option's latest value is completely deployed. - // - // * FailedToValidate: the option - // value is not compatible with the domain's data and cannot be used to index the - // data. You must either modify the option value or update or remove the - // incompatible documents. + // - RequiresIndexDocuments : the option's latest value will not be deployed + // until IndexDocuments has been called and indexing is complete. + // - Processing : the option's latest value is in the process of being activated. + // - Active : the option's latest value is completely deployed. + // - FailedToValidate : the option value is not compatible with the domain's data + // and cannot be used to index the data. You must either modify the option value or + // update or remove the incompatible documents. // // This member is required. State OptionState @@ -701,7 +688,7 @@ type OptionStatus struct { type ScalingParameters struct { // The instance type that you want to preconfigure for your domain. For example, - // search.m1.small. + // search.m1.small . DesiredInstanceType PartitionInstanceType // The number of partitions you want to preconfigure for your domain. Only valid @@ -737,7 +724,7 @@ type ServiceEndpoint struct { // The endpoint to which service requests can be submitted. For example, // search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com // or - // doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com. + // doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com . Endpoint *string noSmithyDocumentSerde @@ -745,7 +732,7 @@ type ServiceEndpoint struct { // Configuration information for a search suggester. Each suggester has a unique // name and specifies the text field you want to use for suggestions. The following -// options can be configured for a suggester: FuzzyMatching, SortExpression. +// options can be configured for a suggester: FuzzyMatching , SortExpression . type Suggester struct { // Options for a search suggester. @@ -767,7 +754,7 @@ type SuggesterStatus struct { // Configuration information for a search suggester. Each suggester has a unique // name and specifies the text field you want to use for suggestions. The following - // options can be configured for a suggester: FuzzyMatching, SortExpression. + // options can be configured for a suggester: FuzzyMatching , SortExpression . // // This member is required. Options *Suggester @@ -781,8 +768,8 @@ type SuggesterStatus struct { } // Options for a field that contains an array of text strings. Present if -// IndexFieldType specifies the field is of type text-array. A text-array field is -// always searchable. All options are enabled by default. +// IndexFieldType specifies the field is of type text-array . A text-array field +// is always searchable. All options are enabled by default. type TextArrayOptions struct { // The name of an analysis scheme for a text-array field. @@ -803,8 +790,9 @@ type TextArrayOptions struct { noSmithyDocumentSerde } -// Options for text field. Present if IndexFieldType specifies the field is of type -// text. A text field is always searchable. All options are enabled by default. +// Options for text field. Present if IndexFieldType specifies the field is of +// type text . A text field is always searchable. All options are enabled by +// default. type TextOptions struct { // The name of an analysis scheme for a text field. @@ -832,7 +820,7 @@ type TextOptions struct { // wildcard can also be the only character in a dynamic field name. Multiple // wildcards, and wildcards embedded within a string are not supported. The name // score is reserved and cannot be used as a field name. To reference a document's - // ID, you can use the name _id. + // ID, you can use the name _id . SourceField *string noSmithyDocumentSerde diff --git a/service/cloudsearchdomain/api_client.go b/service/cloudsearchdomain/api_client.go index 354348d009f..720f1b7be40 100644 --- a/service/cloudsearchdomain/api_client.go +++ b/service/cloudsearchdomain/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudsearchdomain/api_op_Search.go b/service/cloudsearchdomain/api_op_Search.go index a1d5829769e..02c9c3bf72e 100644 --- a/service/cloudsearchdomain/api_op_Search.go +++ b/service/cloudsearchdomain/api_op_Search.go @@ -14,25 +14,17 @@ import ( // Retrieves a list of documents that match the specified search criteria. How you // specify the search criteria depends on which query parser you use. Amazon // CloudSearch supports four query parsers: +// - simple : search all text and text-array fields for the specified string. +// Search for phrases, individual terms, and prefixes. +// - structured : search specific fields, construct compound queries using +// Boolean operators, and use advanced features such as term boosting and proximity +// searching. +// - lucene : specify search criteria using the Apache Lucene query parser syntax. +// - dismax : specify search criteria using the simplified subset of the Apache +// Lucene query parser syntax defined by the DisMax query parser. // -// * simple: search all text and -// text-array fields for the specified string. Search for phrases, individual -// terms, and prefixes. -// -// * structured: search specific fields, construct compound -// queries using Boolean operators, and use advanced features such as term boosting -// and proximity searching. -// -// * lucene: specify search criteria using the Apache -// Lucene query parser syntax. -// -// * dismax: specify search criteria using the -// simplified subset of the Apache Lucene query parser syntax defined by the DisMax -// query parser. -// -// For more information, see Searching Your Data -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) in -// the Amazon CloudSearch Developer Guide. The endpoint for submitting Search +// For more information, see Searching Your Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) +// in the Amazon CloudSearch Developer Guide. The endpoint for submitting Search // requests is domain-specific. You submit search requests to a domain's search // endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch // configuration service DescribeDomains action. A domain's endpoints are also @@ -58,33 +50,30 @@ type SearchInput struct { // Specifies the search criteria for the request. How you specify the search // criteria depends on the query parser used for the request and the parser options // specified in the queryOptions parameter. By default, the simple query parser is - // used to process requests. To use the structured, lucene, or dismax query parser, - // you must also specify the queryParser parameter. For more information about - // specifying search criteria, see Searching Your Data - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) in - // the Amazon CloudSearch Developer Guide. + // used to process requests. To use the structured , lucene , or dismax query + // parser, you must also specify the queryParser parameter. For more information + // about specifying search criteria, see Searching Your Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) + // in the Amazon CloudSearch Developer Guide. // // This member is required. Query *string // Retrieves a cursor value you can use to page through large result sets. Use the // size parameter to control the number of hits to include in each response. You - // can specify either the cursor or start parameter in a request; they are mutually - // exclusive. To get the first cursor, set the cursor value to initial. In - // subsequent requests, specify the cursor value returned in the hits section of - // the response. For more information, see Paginating Results - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) + // can specify either the cursor or start parameter in a request; they are + // mutually exclusive. To get the first cursor, set the cursor value to initial . + // In subsequent requests, specify the cursor value returned in the hits section of + // the response. For more information, see Paginating Results (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) // in the Amazon CloudSearch Developer Guide. Cursor *string // Defines one or more numeric expressions that can be used to sort results or // specify search or filter criteria. You can also specify expressions as return // fields. You specify the expressions in JSON using the form - // {"EXPRESSIONNAME":"EXPRESSION"}. You can define and use multiple expressions in - // a search request. For example: {"expression1":"_score*rating", - // "expression2":"(1/rank)*year"} For information about the variables, operators, - // and functions you can use in expressions, see Writing Expressions - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions) + // {"EXPRESSIONNAME":"EXPRESSION"} . You can define and use multiple expressions in + // a search request. For example: {"expression1":"_score*rating", + // "expression2":"(1/rank)*year"} For information about the variables, operators, + // and functions you can use in expressions, see Writing Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions) // in the Amazon CloudSearch Developer Guide. Expr *string @@ -92,47 +81,39 @@ type SearchInput struct { // that control how the facet information is returned. Each specified field must be // facet-enabled in the domain configuration. The fields and options are specified // in JSON using the form - // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. - // You can specify the following faceting options: - // - // * buckets specifies an array of - // the facet values or ranges to count. Ranges are specified using the same syntax - // that you use to search for a range of values. For more information, see - // Searching for a Range of Values - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html) - // in the Amazon CloudSearch Developer Guide. Buckets are returned in the order - // they are specified in the request. The sort and size options are not valid if - // you specify buckets. - // - // * size specifies the maximum number of facets to include - // in the results. By default, Amazon CloudSearch returns counts for the top 10. - // The size parameter is only valid when you specify the sort option; it cannot be - // used in conjunction with buckets. - // - // * sort specifies how you want to sort the - // facets in the results: bucket or count. Specify bucket to sort alphabetically or - // numerically by facet value (in ascending order). Specify count to sort by the - // facet counts computed for each facet value (in descending order). To retrieve - // facet counts for particular values or ranges of values, use the buckets option - // instead of sort. - // - // If no facet options are specified, facet counts are computed - // for all field values, the facets are sorted by facet count, and the top 10 - // facets are returned in the results. To count particular buckets of values, use - // the buckets option. For example, the following request uses the buckets option - // to calculate and return facet counts by decade. + // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}} + // . You can specify the following faceting options: + // - buckets specifies an array of the facet values or ranges to count. Ranges + // are specified using the same syntax that you use to search for a range of + // values. For more information, see Searching for a Range of Values (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html) + // in the Amazon CloudSearch Developer Guide. Buckets are returned in the order + // they are specified in the request. The sort and size options are not valid if + // you specify buckets . + // - size specifies the maximum number of facets to include in the results. By + // default, Amazon CloudSearch returns counts for the top 10. The size parameter + // is only valid when you specify the sort option; it cannot be used in + // conjunction with buckets . + // - sort specifies how you want to sort the facets in the results: bucket or + // count . Specify bucket to sort alphabetically or numerically by facet value + // (in ascending order). Specify count to sort by the facet counts computed for + // each facet value (in descending order). To retrieve facet counts for particular + // values or ranges of values, use the buckets option instead of sort . + // If no facet options are specified, facet counts are computed for all field + // values, the facets are sorted by facet count, and the top 10 facets are returned + // in the results. To count particular buckets of values, use the buckets option. + // For example, the following request uses the buckets option to calculate and + // return facet counts by decade. // {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} // To sort facets by facet count, use the count option. For example, the following // request sets the sort option to count to sort the facet values by facet count, // with the facet values that have the most matching documents listed first. // Setting the size option to 3 returns only the top three facet values. - // {"year":{"sort":"count","size":3}} To sort the facets by value, use the bucket + // {"year":{"sort":"count","size":3}} To sort the facets by value, use the bucket // option. For example, the following request sets the sort option to bucket to // sort the facet values numerically by year, with earliest year listed first. - // {"year":{"sort":"bucket"}} For more information, see Getting and Using Facet - // Information - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html) in - // the Amazon CloudSearch Developer Guide. + // {"year":{"sort":"bucket"}} For more information, see Getting and Using Facet + // Information (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html) + // in the Amazon CloudSearch Developer Guide. Facet *string // Specifies a structured query that filters the results of a search without @@ -141,38 +122,30 @@ type SearchInput struct { // constraints specified in the query parameter. Specifying a filter controls only // which matching documents are included in the results, it has no effect on how // they are scored and sorted. The filterQuery parameter supports the full - // structured query syntax. For more information about using filters, see Filtering - // Matching Documents - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html) + // structured query syntax. For more information about using filters, see + // Filtering Matching Documents (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html) // in the Amazon CloudSearch Developer Guide. FilterQuery *string // Retrieves highlights for matches in the specified text or text-array fields. // Each specified field must be highlight enabled in the domain configuration. The // fields and options are specified in JSON using the form - // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}. - // You can specify the following highlight options: - // - // * format: specifies the format - // of the data in the text field: text or html. When data is returned as HTML, all - // non-alphanumeric characters are encoded. The default is html. - // - // * max_phrases: - // specifies the maximum number of occurrences of the search term(s) you want to - // highlight. By default, the first occurrence is highlighted. - // - // * pre_tag: - // specifies the string to prepend to an occurrence of a search term. The default - // for HTML highlights is . The default for text highlights is *. - // - // * post_tag: - // specifies the string to append to an occurrence of a search term. The default - // for HTML highlights is . The default for text highlights is *. - // - // If no - // highlight options are specified for a field, the returned field text is treated - // as HTML and the first match is highlighted with emphasis tags: - // search-term. For example, the following request retrieves highlights + // {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}} + // . You can specify the following highlight options: + // - format : specifies the format of the data in the text field: text or html . + // When data is returned as HTML, all non-alphanumeric characters are encoded. The + // default is html . + // - max_phrases : specifies the maximum number of occurrences of the search + // term(s) you want to highlight. By default, the first occurrence is highlighted. + // - pre_tag : specifies the string to prepend to an occurrence of a search term. + // The default for HTML highlights is . The default for text highlights is * + // . + // - post_tag : specifies the string to append to an occurrence of a search term. + // The default for HTML highlights is . The default for text highlights is + // * . + // If no highlight options are specified for a field, the returned field text is + // treated as HTML and the first match is highlighted with emphasis tags: + // search-term . For example, the following request retrieves highlights // for the actors and title fields. { "actors": {}, "title": {"format": // "text","max_phrases": 2,"pre_tag": "","post_tag": ""} } Highlight *string @@ -194,134 +167,114 @@ type SearchInput struct { // You specify the options in JSON using the following form // {"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}. The options you can // configure vary according to which parser you use: - // - // * defaultOperator: The - // default operator used to combine individual terms in the search string. For - // example: defaultOperator: 'or'. For the dismax parser, you specify a percentage - // that represents the percentage of terms in the search string (rounded down) that - // must match, rather than a default operator. A value of 0% is the equivalent to - // OR, and a value of 100% is equivalent to AND. The percentage must be specified - // as a value in the range 0-100 followed by the percent (%) symbol. For example, - // defaultOperator: 50%. Valid values: and, or, a percentage in the range 0%-100% - // (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: - // simple, structured, lucene, and dismax. - // - // * fields: An array of the fields to - // search when no fields are specified in a search. If no fields are specified in a - // search and this option is not specified, all text and text-array fields are - // searched. You can specify a weight for each field to control the relative - // importance of each field when Amazon CloudSearch calculates relevance scores. To - // specify a field weight, append a caret (^) symbol and the weight to the field - // name. For example, to boost the importance of the title field over the - // description field you could specify: "fields":["title^5","description"]. Valid - // values: The name of any configured field and an optional numeric value greater - // than zero. Default: All text and text-array fields. Valid for: simple, - // structured, lucene, and dismax. - // - // * operators: An array of the operators or - // special characters you want to disable for the simple query parser. If you - // disable the and, or, or not operators, the corresponding operators (+, |, -) - // have no special meaning and are dropped from the search string. Similarly, - // disabling prefix disables the wildcard operator (*) and disabling phrase - // disables the ability to search for phrases by enclosing phrases in double - // quotes. Disabling precedence disables the ability to control order of precedence - // using parentheses. Disabling near disables the ability to use the ~ operator to - // perform a sloppy phrase search. Disabling the fuzzy operator disables the - // ability to use the ~ operator to perform a fuzzy search. escape disables the - // ability to use a backslash () to escape special characters within the - // search string. Disabling whitespace is an advanced option that prevents the - // parser from tokenizing on whitespace, which can be useful for Vietnamese. (It - // prevents Vietnamese words from being split incorrectly.) For example, you could - // disable all operators other than the phrase operator to support just simple term - // and phrase queries: "operators":["and","not","or", "prefix"]. Valid values: and, - // escape, fuzzy, near, not, or, phrase, precedence, prefix, whitespace. Default: - // All operators and special characters are enabled. Valid for: simple. - // - // * - // phraseFields: An array of the text or text-array fields you want to use for - // phrase searches. When the terms in the search string appear in close proximity - // within a field, the field scores higher. You can specify a weight for each field - // to boost that score. The phraseSlop option controls how much the matches can - // deviate from the search string and still be boosted. To specify a field weight, - // append a caret (^) symbol and the weight to the field name. For example, to - // boost phrase matches in the title field over the abstract field, you could - // specify: "phraseFields":["title^3", "plot"] Valid values: The name of any text - // or text-array field and an optional numeric value greater than zero. Default: No - // fields. If you don't specify any fields with phraseFields, proximity scoring is - // disabled even if phraseSlop is specified. Valid for: dismax. - // - // * phraseSlop: An - // integer value that specifies how much matches can deviate from the search phrase - // and still be boosted according to the weights specified in the phraseFields - // option; for example, phraseSlop: 2. You must also specify phraseFields to enable - // proximity scoring. Valid values: positive integers. Default: 0. Valid for: - // dismax. - // - // * explicitPhraseSlop: An integer value that specifies how much a match - // can deviate from the search phrase when the phrase is enclosed in double quotes - // in the search string. (Phrases that exceed this proximity distance are not - // considered a match.) For example, to specify a slop of three for dismax phrase - // queries, you would specify "explicitPhraseSlop":3. Valid values: positive - // integers. Default: 0. Valid for: dismax. - // - // * tieBreaker: When a term in the - // search string is found in a document's field, a score is calculated for that - // field based on how common the word is in that field compared to other documents. - // If the term occurs in multiple fields within a document, by default only the - // highest scoring field contributes to the document's overall score. You can - // specify a tieBreaker value to enable the matches in lower-scoring fields to - // contribute to the document's score. That way, if two documents have the same max - // field score for a particular term, the score for the document that has matches - // in more fields will be higher. The formula for calculating the score with a - // tieBreaker is (max field score) + (tieBreaker) * (sum of the scores for the rest - // of the matching fields). Set tieBreaker to 0 to disregard all but the highest - // scoring field (pure max): "tieBreaker":0. Set to 1 to sum the scores from all - // fields (pure sum): "tieBreaker":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid - // for: dismax. + // - defaultOperator : The default operator used to combine individual terms in + // the search string. For example: defaultOperator: 'or' . For the dismax parser, + // you specify a percentage that represents the percentage of terms in the search + // string (rounded down) that must match, rather than a default operator. A value + // of 0% is the equivalent to OR, and a value of 100% is equivalent to AND. The + // percentage must be specified as a value in the range 0-100 followed by the + // percent (%) symbol. For example, defaultOperator: 50% . Valid values: and , or + // , a percentage in the range 0%-100% ( dismax ). Default: and ( simple , + // structured , lucene ) or 100 ( dismax ). Valid for: simple , structured , + // lucene , and dismax . + // - fields : An array of the fields to search when no fields are specified in a + // search. If no fields are specified in a search and this option is not specified, + // all text and text-array fields are searched. You can specify a weight for each + // field to control the relative importance of each field when Amazon CloudSearch + // calculates relevance scores. To specify a field weight, append a caret ( ^ ) + // symbol and the weight to the field name. For example, to boost the importance of + // the title field over the description field you could specify: + // "fields":["title^5","description"] . Valid values: The name of any configured + // field and an optional numeric value greater than zero. Default: All text and + // text-array fields. Valid for: simple , structured , lucene , and dismax . + // - operators : An array of the operators or special characters you want to + // disable for the simple query parser. If you disable the and , or , or not + // operators, the corresponding operators ( + , | , - ) have no special meaning + // and are dropped from the search string. Similarly, disabling prefix disables + // the wildcard operator ( * ) and disabling phrase disables the ability to + // search for phrases by enclosing phrases in double quotes. Disabling precedence + // disables the ability to control order of precedence using parentheses. Disabling + // near disables the ability to use the ~ operator to perform a sloppy phrase + // search. Disabling the fuzzy operator disables the ability to use the ~ + // operator to perform a fuzzy search. escape disables the ability to use a + // backslash ( ) to escape special characters within the search string. + // Disabling whitespace is an advanced option that prevents the parser from + // tokenizing on whitespace, which can be useful for Vietnamese. (It prevents + // Vietnamese words from being split incorrectly.) For example, you could disable + // all operators other than the phrase operator to support just simple term and + // phrase queries: "operators":["and","not","or", "prefix"] . Valid values: and , + // escape , fuzzy , near , not , or , phrase , precedence , prefix , whitespace . + // Default: All operators and special characters are enabled. Valid for: simple . + // - phraseFields : An array of the text or text-array fields you want to use for + // phrase searches. When the terms in the search string appear in close proximity + // within a field, the field scores higher. You can specify a weight for each field + // to boost that score. The phraseSlop option controls how much the matches can + // deviate from the search string and still be boosted. To specify a field weight, + // append a caret ( ^ ) symbol and the weight to the field name. For example, to + // boost phrase matches in the title field over the abstract field, you could + // specify: "phraseFields":["title^3", "plot"] Valid values: The name of any text + // or text-array field and an optional numeric value greater than zero. Default: + // No fields. If you don't specify any fields with phraseFields , proximity + // scoring is disabled even if phraseSlop is specified. Valid for: dismax . + // - phraseSlop : An integer value that specifies how much matches can deviate + // from the search phrase and still be boosted according to the weights specified + // in the phraseFields option; for example, phraseSlop: 2 . You must also specify + // phraseFields to enable proximity scoring. Valid values: positive integers. + // Default: 0. Valid for: dismax . + // - explicitPhraseSlop : An integer value that specifies how much a match can + // deviate from the search phrase when the phrase is enclosed in double quotes in + // the search string. (Phrases that exceed this proximity distance are not + // considered a match.) For example, to specify a slop of three for dismax phrase + // queries, you would specify "explicitPhraseSlop":3 . Valid values: positive + // integers. Default: 0. Valid for: dismax . + // - tieBreaker : When a term in the search string is found in a document's + // field, a score is calculated for that field based on how common the word is in + // that field compared to other documents. If the term occurs in multiple fields + // within a document, by default only the highest scoring field contributes to the + // document's overall score. You can specify a tieBreaker value to enable the + // matches in lower-scoring fields to contribute to the document's score. That way, + // if two documents have the same max field score for a particular term, the score + // for the document that has matches in more fields will be higher. The formula for + // calculating the score with a tieBreaker is (max field score) + (tieBreaker) * + // (sum of the scores for the rest of the matching fields) . Set tieBreaker to 0 + // to disregard all but the highest scoring field (pure max): "tieBreaker":0 . + // Set to 1 to sum the scores from all fields (pure sum): "tieBreaker":1 . Valid + // values: 0.0 to 1.0. Default: 0.0. Valid for: dismax . QueryOptions *string // Specifies which query parser to use to process the request. If queryParser is // not specified, Amazon CloudSearch uses the simple query parser. Amazon // CloudSearch supports four query parsers: - // - // * simple: perform simple searches of - // text and text-array fields. By default, the simple query parser searches all - // text and text-array fields. You can specify which fields to search by with the - // queryOptions parameter. If you prefix a search term with a plus sign (+) - // documents must contain the term to be considered a match. (This is the default, - // unless you configure the default operator with the queryOptions parameter.) You - // can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular - // terms, find results that match any of the specified terms, or search for a - // prefix. To search for a phrase rather than individual terms, enclose the phrase - // in double quotes. For more information, see Searching for Text - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html) - // in the Amazon CloudSearch Developer Guide. - // - // * structured: perform advanced - // searches by combining multiple expressions to define the search criteria. You - // can also search within particular fields, search for values and ranges of - // values, and use advanced options such as term boosting, matchall, and near. For - // more information, see Constructing Compound Queries - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html) - // in the Amazon CloudSearch Developer Guide. - // - // * lucene: search using the Apache - // Lucene query parser syntax. For more information, see Apache Lucene Query Parser - // Syntax - // (http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description). - // - // * - // dismax: search using the simplified subset of the Apache Lucene query parser - // syntax defined by the DisMax query parser. For more information, see DisMax - // Query Parser Syntax - // (http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax). + // - simple : perform simple searches of text and text-array fields. By default, + // the simple query parser searches all text and text-array fields. You can + // specify which fields to search by with the queryOptions parameter. If you + // prefix a search term with a plus sign (+) documents must contain the term to be + // considered a match. (This is the default, unless you configure the default + // operator with the queryOptions parameter.) You can use the - (NOT), | (OR), + // and * (wildcard) operators to exclude particular terms, find results that + // match any of the specified terms, or search for a prefix. To search for a phrase + // rather than individual terms, enclose the phrase in double quotes. For more + // information, see Searching for Text (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html) + // in the Amazon CloudSearch Developer Guide. + // - structured : perform advanced searches by combining multiple expressions to + // define the search criteria. You can also search within particular fields, search + // for values and ranges of values, and use advanced options such as term boosting, + // matchall , and near . For more information, see Constructing Compound Queries (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html) + // in the Amazon CloudSearch Developer Guide. + // - lucene : search using the Apache Lucene query parser syntax. For more + // information, see Apache Lucene Query Parser Syntax (http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description) + // . + // - dismax : search using the simplified subset of the Apache Lucene query + // parser syntax defined by the DisMax query parser. For more information, see + // DisMax Query Parser Syntax (http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax) + // . QueryParser types.QueryParser // Specifies the field and expression values to include in the response. Multiple // fields or expressions are specified as a comma-separated list. By default, a - // search response includes all return enabled fields (_all_fields). To return only - // the document IDs for the matching documents, specify _no_fields. To retrieve the - // relevance score calculated for each document, specify _score. + // search response includes all return enabled fields ( _all_fields ). To return + // only the document IDs for the matching documents, specify _no_fields . To + // retrieve the relevance score calculated for each document, specify _score . Return *string // Specifies the maximum number of search hits to include in the response. @@ -329,21 +282,19 @@ type SearchInput struct { // Specifies the fields or custom expressions to use to sort the search results. // Multiple fields or expressions are specified as a comma-separated list. You must - // specify the sort direction (asc or desc) for each field; for example, year - // desc,title asc. To use a field to sort results, the field must be sort-enabled + // specify the sort direction ( asc or desc ) for each field; for example, year + // desc,title asc . To use a field to sort results, the field must be sort-enabled // in the domain configuration. Array type fields cannot be used for sorting. If no // sort parameter is specified, results are sorted by their default relevance - // scores in descending order: _score desc. You can also sort by document ID (_id - // asc) and version (_version desc). For more information, see Sorting Results - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html) + // scores in descending order: _score desc . You can also sort by document ID ( _id + // asc ) and version ( _version desc ). For more information, see Sorting Results (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html) // in the Amazon CloudSearch Developer Guide. Sort *string // Specifies the offset of the first search hit you want to return. Note that the // result set is zero-based; the first result is at index 0. You can specify either // the start or cursor parameter in a request, they are mutually exclusive. For - // more information, see Paginating Results - // (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) + // more information, see Paginating Results (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html) // in the Amazon CloudSearch Developer Guide. Start int64 diff --git a/service/cloudsearchdomain/api_op_Suggest.go b/service/cloudsearchdomain/api_op_Suggest.go index 11d99b7afe4..85e5603297f 100644 --- a/service/cloudsearchdomain/api_op_Suggest.go +++ b/service/cloudsearchdomain/api_op_Suggest.go @@ -18,8 +18,7 @@ import ( // documents whose values in the suggester field start with the specified query // string. The beginning of the field must match the query string to be considered // a match. For more information about configuring suggesters and retrieving -// suggestions, see Getting Suggestions -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) +// suggestions, see Getting Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) // in the Amazon CloudSearch Developer Guide. The endpoint for submitting Suggest // requests is domain-specific. You submit suggest requests to a domain's search // endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch @@ -62,8 +61,8 @@ type SuggestInput struct { // Contains the response to a Suggest request. type SuggestOutput struct { - // The status of a SuggestRequest. Contains the resource ID (rid) and how long it - // took to process the request (timems). + // The status of a SuggestRequest . Contains the resource ID ( rid ) and how long + // it took to process the request ( timems ). Status *types.SuggestStatus // Container for the matching search suggestion information. diff --git a/service/cloudsearchdomain/api_op_UploadDocuments.go b/service/cloudsearchdomain/api_op_UploadDocuments.go index 43cfd959faa..e38faaf3fd9 100644 --- a/service/cloudsearchdomain/api_op_UploadDocuments.go +++ b/service/cloudsearchdomain/api_op_UploadDocuments.go @@ -27,11 +27,9 @@ import ( // CloudSearch configuration service DescribeDomains action. A domain's endpoints // are also displayed on the domain dashboard in the Amazon CloudSearch console. // For more information about formatting your data for Amazon CloudSearch, see -// Preparing Your Data -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html) +// Preparing Your Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html) // in the Amazon CloudSearch Developer Guide. For more information about uploading -// data for indexing, see Uploading Data -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html) +// data for indexing, see Uploading Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html) // in the Amazon CloudSearch Developer Guide. func (c *Client) UploadDocuments(ctx context.Context, params *UploadDocumentsInput, optFns ...func(*Options)) (*UploadDocumentsOutput, error) { if params == nil { @@ -53,10 +51,8 @@ type UploadDocumentsInput struct { // The format of the batch you are uploading. Amazon CloudSearch supports two // document batch formats: - // - // * application/json - // - // * application/xml + // - application/json + // - application/xml // // This member is required. ContentType types.ContentType @@ -78,7 +74,7 @@ type UploadDocumentsOutput struct { // The number of documents that were deleted from the search domain. Deletes int64 - // The status of an UploadDocumentsRequest. + // The status of an UploadDocumentsRequest . Status *string // Any warnings returned by the document service about the documents being diff --git a/service/cloudsearchdomain/doc.go b/service/cloudsearchdomain/doc.go index 43a47e1ce80..9ad14e4bf74 100644 --- a/service/cloudsearchdomain/doc.go +++ b/service/cloudsearchdomain/doc.go @@ -3,12 +3,12 @@ // Package cloudsearchdomain provides the API client, operations, and parameter // types for Amazon CloudSearch Domain. // -// You use the AmazonCloudSearch2013 API to upload documents to a search domain and -// search those documents. The endpoints for submitting UploadDocuments, Search, -// and Suggest requests are domain-specific. To get the endpoints for your domain, -// use the Amazon CloudSearch configuration service DescribeDomains action. The -// domain endpoints are also displayed on the domain dashboard in the Amazon -// CloudSearch console. You submit suggest requests to the search endpoint. For -// more information, see the Amazon CloudSearch Developer Guide -// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide). +// You use the AmazonCloudSearch2013 API to upload documents to a search domain +// and search those documents. The endpoints for submitting UploadDocuments , +// Search , and Suggest requests are domain-specific. To get the endpoints for +// your domain, use the Amazon CloudSearch configuration service DescribeDomains +// action. The domain endpoints are also displayed on the domain dashboard in the +// Amazon CloudSearch console. You submit suggest requests to the search endpoint. +// For more information, see the Amazon CloudSearch Developer Guide (http://docs.aws.amazon.com/cloudsearch/latest/developerguide) +// . package cloudsearchdomain diff --git a/service/cloudsearchdomain/types/types.go b/service/cloudsearchdomain/types/types.go index 7a29fafbbd9..e19262bec00 100644 --- a/service/cloudsearchdomain/types/types.go +++ b/service/cloudsearchdomain/types/types.go @@ -45,26 +45,26 @@ type FieldStats struct { Count int64 // The maximum value found in the specified field in the result set. If the field - // is numeric (int, int-array, double, or double-array), max is the string + // is numeric ( int , int-array , double , or double-array ), max is the string // representation of a double-precision 64-bit floating point value. If the field - // is date or date-array, max is the string representation of a date with the - // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339): + // is date or date-array , max is the string representation of a date with the + // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339) : // yyyy-mm-ddTHH:mm:ss.SSSZ. Max *string - // The average of the values found in the specified field in the result set. If the - // field is numeric (int, int-array, double, or double-array), mean is the string - // representation of a double-precision 64-bit floating point value. If the field - // is date or date-array, mean is the string representation of a date with the - // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339): + // The average of the values found in the specified field in the result set. If + // the field is numeric ( int , int-array , double , or double-array ), mean is + // the string representation of a double-precision 64-bit floating point value. If + // the field is date or date-array , mean is the string representation of a date + // with the format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339) : // yyyy-mm-ddTHH:mm:ss.SSSZ. Mean *string // The minimum value found in the specified field in the result set. If the field - // is numeric (int, int-array, double, or double-array), min is the string + // is numeric ( int , int-array , double , or double-array ), min is the string // representation of a double-precision 64-bit floating point value. If the field - // is date or date-array, min is the string representation of a date with the - // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339): + // is date or date-array , min is the string representation of a date with the + // format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339) : // yyyy-mm-ddTHH:mm:ss.SSSZ. Min *string @@ -122,8 +122,8 @@ type Hits struct { noSmithyDocumentSerde } -// Contains the resource id (rid) and the time it took to process the request -// (timems). +// Contains the resource id ( rid ) and the time it took to process the request ( +// timems ). type SearchStatus struct { // The encrypted resource ID for the request. @@ -136,7 +136,7 @@ type SearchStatus struct { } // An autocomplete suggestion that matches the query string specified in a -// SuggestRequest. +// SuggestRequest . type SuggestionMatch struct { // The document ID of the suggested document. @@ -145,13 +145,13 @@ type SuggestionMatch struct { // The relevance score of a suggested match. Score int64 - // The string that matches the query string specified in the SuggestRequest. + // The string that matches the query string specified in the SuggestRequest . Suggestion *string noSmithyDocumentSerde } -// Container for the suggestion information returned in a SuggestResponse. +// Container for the suggestion information returned in a SuggestResponse . type SuggestModel struct { // The number of documents that were found to match the query string. @@ -166,8 +166,8 @@ type SuggestModel struct { noSmithyDocumentSerde } -// Contains the resource id (rid) and the time it took to process the request -// (timems). +// Contains the resource id ( rid ) and the time it took to process the request ( +// timems ). type SuggestStatus struct { // The encrypted resource ID for the request. diff --git a/service/cloudtrail/api_client.go b/service/cloudtrail/api_client.go index 7ac64b43324..cff2cd5ff51 100644 --- a/service/cloudtrail/api_client.go +++ b/service/cloudtrail/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudtrail/api_op_AddTags.go b/service/cloudtrail/api_op_AddTags.go index cb222f5a3c2..fd0e1e5e3d0 100644 --- a/service/cloudtrail/api_op_AddTags.go +++ b/service/cloudtrail/api_op_AddTags.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to a trail, event data store, or channel, up to a limit of -// 50. Overwrites an existing tag's value when a new value is specified for an +// Adds one or more tags to a trail, event data store, or channel, up to a limit +// of 50. Overwrites an existing tag's value when a new value is specified for an // existing tag key. Tag key names must be unique; you cannot have two keys with // the same name but different values. If you specify a key without a value, the // tag will be created with the specified key and a value of null. You can tag a diff --git a/service/cloudtrail/api_op_CancelQuery.go b/service/cloudtrail/api_op_CancelQuery.go index 14e593055b1..c3da7473a30 100644 --- a/service/cloudtrail/api_op_CancelQuery.go +++ b/service/cloudtrail/api_op_CancelQuery.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a query if the query is not in a terminated state, such as CANCELLED, -// FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for -// EventDataStore. The ID of the query that you want to cancel is also required. -// When you run CancelQuery, the query status might show as CANCELLED even if the +// Cancels a query if the query is not in a terminated state, such as CANCELLED , +// FAILED , TIMED_OUT , or FINISHED . You must specify an ARN value for +// EventDataStore . The ID of the query that you want to cancel is also required. +// When you run CancelQuery , the query status might show as CANCELLED even if the // operation is not yet finished. func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optFns ...func(*Options)) (*CancelQueryOutput, error) { if params == nil { @@ -33,8 +33,8 @@ func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optF type CancelQueryInput struct { - // The ID of the query that you want to cancel. The QueryId comes from the response - // of a StartQuery operation. + // The ID of the query that you want to cancel. The QueryId comes from the + // response of a StartQuery operation. // // This member is required. QueryId *string @@ -56,7 +56,7 @@ type CancelQueryOutput struct { QueryId *string // Shows the status of a query after a CancelQuery request. Typically, the values - // shown are either RUNNING or CANCELLED. + // shown are either RUNNING or CANCELLED . // // This member is required. QueryStatus types.QueryStatus diff --git a/service/cloudtrail/api_op_CreateChannel.go b/service/cloudtrail/api_op_CreateChannel.go index 3588f3bac83..114947a0956 100644 --- a/service/cloudtrail/api_op_CreateChannel.go +++ b/service/cloudtrail/api_op_CreateChannel.go @@ -31,8 +31,8 @@ func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, type CreateChannelInput struct { - // One or more event data stores to which events arriving through a channel will be - // logged. + // One or more event data stores to which events arriving through a channel will + // be logged. // // This member is required. Destinations []types.Destination @@ -44,10 +44,9 @@ type CreateChannelInput struct { // The name of the partner or external event source. You cannot change this name // after you create the channel. A maximum of one channel is allowed per source. A - // source can be either Custom for all valid non-Amazon Web Services events, or the - // name of a partner event source. For information about the source names for - // available partners, see Additional information about integration partners - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) + // source can be either Custom for all valid non-Amazon Web Services events, or + // the name of a partner event source. For information about the source names for + // available partners, see Additional information about integration partners (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) // in the CloudTrail User Guide. // // This member is required. diff --git a/service/cloudtrail/api_op_CreateEventDataStore.go b/service/cloudtrail/api_op_CreateEventDataStore.go index 5ab14f64280..7fb3bcdbafc 100644 --- a/service/cloudtrail/api_op_CreateEventDataStore.go +++ b/service/cloudtrail/api_op_CreateEventDataStore.go @@ -35,24 +35,21 @@ type CreateEventDataStoreInput struct { // This member is required. Name *string - // The advanced event selectors to use to select the events for the data store. You - // can configure up to five advanced event selectors for each event data store. For - // more information about how to use advanced event selectors to log CloudTrail - // events, see Log events by using advanced event selectors - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) + // The advanced event selectors to use to select the events for the data store. + // You can configure up to five advanced event selectors for each event data store. + // For more information about how to use advanced event selectors to log CloudTrail + // events, see Log events by using advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) // in the CloudTrail User Guide. For more information about how to use advanced // event selectors to include Config configuration items in your event data store, - // see Create an event data store for Config configuration items - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) + // see Create an event data store for Config configuration items (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) // in the CloudTrail User Guide. For more information about how to use advanced // event selectors to include non-Amazon Web Services events in your event data - // store, see Create an integration to log events from outside Amazon Web Services - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) + // store, see Create an integration to log events from outside Amazon Web Services (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) // in the CloudTrail User Guide. AdvancedEventSelectors []types.AdvancedEventSelector // Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. - // The value can be an alias name prefixed by alias/, a fully specified ARN to an + // The value can be an alias name prefixed by alias/ , a fully specified ARN to an // alias, a fully specified ARN to a key, or a globally unique identifier. // Disabling or deleting the KMS key, or removing CloudTrail permissions on the // key, prevents CloudTrail from logging events to the event data store, and @@ -61,28 +58,20 @@ type CreateEventDataStoreInput struct { // key cannot be removed or changed. Before you disable or delete a KMS key that // you are using with an event data store, delete or back up your event data store. // CloudTrail also supports KMS multi-Region keys. For more information about - // multi-Region keys, see Using multi-Region keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. Examples: - // - // * alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // 12345678-1234-1234-1234-123456789012 + // - alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // - 12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Specifies whether the event data store includes events from all regions, or only - // from the region in which the event data store is created. + // Specifies whether the event data store includes events from all regions, or + // only from the region in which the event data store is created. MultiRegionEnabled *bool - // Specifies whether an event data store collects events logged for an organization - // in Organizations. + // Specifies whether an event data store collects events logged for an + // organization in Organizations. OrganizationEnabled *bool // The retention period of the event data store, in days. You can set a retention @@ -92,9 +81,9 @@ type CreateEventDataStoreInput struct { // A list of tags. TagsList []types.Tag - // Specifies whether termination protection is enabled for the event data store. If - // termination protection is enabled, you cannot delete the event data store until - // termination protection is disabled. + // Specifies whether termination protection is enabled for the event data store. + // If termination protection is enabled, you cannot delete the event data store + // until termination protection is disabled. TerminationProtectionEnabled *bool noSmithyDocumentSerde @@ -117,8 +106,8 @@ type CreateEventDataStoreOutput struct { // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Indicates whether the event data store collects events from all regions, or only - // from the region in which it was created. + // Indicates whether the event data store collects events from all regions, or + // only from the region in which it was created. MultiRegionEnabled *bool // The name of the event data store. @@ -142,7 +131,7 @@ type CreateEventDataStoreOutput struct { // The timestamp that shows when an event data store was updated, if applicable. // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. + // CreatedTimestamp . UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_CreateTrail.go b/service/cloudtrail/api_op_CreateTrail.go index 0b96604051d..34ffdc66071 100644 --- a/service/cloudtrail/api_op_CreateTrail.go +++ b/service/cloudtrail/api_op_CreateTrail.go @@ -31,29 +31,21 @@ func (c *Client) CreateTrail(ctx context.Context, params *CreateTrailInput, optF // Specifies the settings for each trail. type CreateTrailInput struct { - // Specifies the name of the trail. The name must meet the following - // requirements: - // - // * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods - // (.), underscores (_), or dashes (-) - // - // * Start with a letter or number, and end - // with a letter or number - // - // * Be between 3 and 128 characters - // - // * Have no adjacent - // periods, underscores or dashes. Names like my-_namespace and my--namespace are - // not valid. - // - // * Not be in IP address format (for example, 192.168.5.4) + // Specifies the name of the trail. The name must meet the following requirements: + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), + // underscores (_), or dashes (-) + // - Start with a letter or number, and end with a letter or number + // - Be between 3 and 128 characters + // - Have no adjacent periods, underscores or dashes. Names like my-_namespace + // and my--namespace are not valid. + // - Not be in IP address format (for example, 192.168.5.4) // // This member is required. Name *string // Specifies the name of the Amazon S3 bucket designated for publishing log files. - // See Amazon S3 Bucket Naming Requirements - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). + // See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html) + // . // // This member is required. S3BucketName *string @@ -61,7 +53,7 @@ type CreateTrailInput struct { // Specifies a log group name using an Amazon Resource Name (ARN), a unique // identifier that represents the log group to which CloudTrail logs will be // delivered. You must use a log group that exists in your account. Not required - // unless you specify CloudWatchLogsRoleArn. + // unless you specify CloudWatchLogsRoleArn . CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a @@ -96,31 +88,22 @@ type CreateTrailInput struct { // account for an organization in Organizations. IsOrganizationTrail *bool - // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The - // value can be an alias name prefixed by alias/, a fully specified ARN to an + // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. + // The value can be an alias name prefixed by alias/ , a fully specified ARN to an // alias, a fully specified ARN to a key, or a globally unique identifier. // CloudTrail also supports KMS multi-Region keys. For more information about - // multi-Region keys, see Using multi-Region keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. Examples: - // - // * alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // 12345678-1234-1234-1234-123456789012 + // - alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // - 12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). - // The maximum length is 200 characters. + // CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) + // . The maximum length is 200 characters. S3KeyPrefix *string // Specifies the name of the Amazon SNS topic defined for notification of log file @@ -171,8 +154,8 @@ type CreateTrailOutput struct { // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). + // CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) + // . S3KeyPrefix *string // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send diff --git a/service/cloudtrail/api_op_DeleteEventDataStore.go b/service/cloudtrail/api_op_DeleteEventDataStore.go index c083719eeba..bfe8d3b8a52 100644 --- a/service/cloudtrail/api_op_DeleteEventDataStore.go +++ b/service/cloudtrail/api_op_DeleteEventDataStore.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables the event data store specified by EventDataStore, which accepts an -// event data store ARN. After you run DeleteEventDataStore, the event data store +// Disables the event data store specified by EventDataStore , which accepts an +// event data store ARN. After you run DeleteEventDataStore , the event data store // enters a PENDING_DELETION state, and is automatically deleted after a wait // period of seven days. TerminationProtectionEnabled must be set to False on the // event data store; this operation cannot work if TerminationProtectionEnabled is -// True. After you run DeleteEventDataStore on an event data store, you cannot run -// ListQueries, DescribeQuery, or GetQueryResults on queries that are using an -// event data store in a PENDING_DELETION state. An event data store in the +// True . After you run DeleteEventDataStore on an event data store, you cannot +// run ListQueries , DescribeQuery , or GetQueryResults on queries that are using +// an event data store in a PENDING_DELETION state. An event data store in the // PENDING_DELETION state does not incur costs. func (c *Client) DeleteEventDataStore(ctx context.Context, params *DeleteEventDataStoreInput, optFns ...func(*Options)) (*DeleteEventDataStoreOutput, error) { if params == nil { diff --git a/service/cloudtrail/api_op_DeleteResourcePolicy.go b/service/cloudtrail/api_op_DeleteResourcePolicy.go index 35f34292e1f..fc875fc7496 100644 --- a/service/cloudtrail/api_op_DeleteResourcePolicy.go +++ b/service/cloudtrail/api_op_DeleteResourcePolicy.go @@ -30,7 +30,7 @@ type DeleteResourcePolicyInput struct { // The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the // resource-based policy from. The following is the format of a resource ARN: - // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel. + // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel . // // This member is required. ResourceArn *string diff --git a/service/cloudtrail/api_op_DeleteTrail.go b/service/cloudtrail/api_op_DeleteTrail.go index fc98c6d3da1..4f15d7ab12c 100644 --- a/service/cloudtrail/api_op_DeleteTrail.go +++ b/service/cloudtrail/api_op_DeleteTrail.go @@ -11,8 +11,8 @@ import ( ) // Deletes a trail. This operation must be called from the region in which the -// trail was created. DeleteTrail cannot be called on the shadow trails (replicated -// trails in other regions) of a trail that is enabled in all regions. +// trail was created. DeleteTrail cannot be called on the shadow trails +// (replicated trails in other regions) of a trail that is enabled in all regions. func (c *Client) DeleteTrail(ctx context.Context, params *DeleteTrailInput, optFns ...func(*Options)) (*DeleteTrailOutput, error) { if params == nil { params = &DeleteTrailInput{} diff --git a/service/cloudtrail/api_op_DescribeQuery.go b/service/cloudtrail/api_op_DescribeQuery.go index 5d46e2f8b75..850f7087ab1 100644 --- a/service/cloudtrail/api_op_DescribeQuery.go +++ b/service/cloudtrail/api_op_DescribeQuery.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns metadata about a query, including query run time in milliseconds, number -// of events scanned and matched, and query status. You must specify an ARN for -// EventDataStore, and a value for QueryID. +// Returns metadata about a query, including query run time in milliseconds, +// number of events scanned and matched, and query status. You must specify an ARN +// for EventDataStore , and a value for QueryID . func (c *Client) DescribeQuery(ctx context.Context, params *DescribeQueryInput, optFns ...func(*Options)) (*DescribeQueryOutput, error) { if params == nil { params = &DescribeQueryInput{} @@ -65,8 +65,8 @@ type DescribeQueryOutput struct { // query's creation time. QueryStatistics *types.QueryStatisticsForDescribeQuery - // The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, - // FAILED, TIMED_OUT, or CANCELLED + // The status of a query. Values for QueryStatus include QUEUED , RUNNING , + // FINISHED , FAILED , TIMED_OUT , or CANCELLED QueryStatus types.QueryStatus // The SQL code of a query. diff --git a/service/cloudtrail/api_op_DescribeTrails.go b/service/cloudtrail/api_op_DescribeTrails.go index 080dfe45280..1ef16e5d396 100644 --- a/service/cloudtrail/api_op_DescribeTrails.go +++ b/service/cloudtrail/api_op_DescribeTrails.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves settings for one or more trails associated with the current region for -// your account. +// Retrieves settings for one or more trails associated with the current region +// for your account. func (c *Client) DescribeTrails(ctx context.Context, params *DescribeTrailsInput, optFns ...func(*Options)) (*DescribeTrailsOutput, error) { if params == nil { params = &DescribeTrailsInput{} @@ -39,24 +39,19 @@ type DescribeTrailsInput struct { // The default is true. IncludeShadowTrails *bool - // Specifies a list of trail names, trail ARNs, or both, of the trails to describe. - // The format of a trail ARN is: + // Specifies a list of trail names, trail ARNs, or both, of the trails to + // describe. The format of a trail ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail If an empty list is // specified, information for the trail in the current region is returned. - // - // * If an - // empty list is specified and IncludeShadowTrails is false, then information for - // all trails in the current region is returned. - // - // * If an empty list is specified - // and IncludeShadowTrails is null or true, then information for all trails in the - // current region and any associated shadow trails in other regions is - // returned. - // - // If one or more trail names are specified, information is returned - // only if the names match the names of trails belonging only to the current region - // and current account. To return information about a trail in another region, you - // must specify its trail ARN. + // - If an empty list is specified and IncludeShadowTrails is false, then + // information for all trails in the current region is returned. + // - If an empty list is specified and IncludeShadowTrails is null or true, then + // information for all trails in the current region and any associated shadow + // trails in other regions is returned. + // If one or more trail names are specified, information is returned only if the + // names match the names of trails belonging only to the current region and current + // account. To return information about a trail in another region, you must specify + // its trail ARN. TrailNameList []string noSmithyDocumentSerde @@ -66,8 +61,8 @@ type DescribeTrailsInput struct { // error. type DescribeTrailsOutput struct { - // The list of trail objects. Trail objects with string values are only returned if - // values for the objects exist in a trail's configuration. For example, + // The list of trail objects. Trail objects with string values are only returned + // if values for the objects exist in a trail's configuration. For example, // SNSTopicName and SNSTopicARN are only returned in results if a trail is // configured to send SNS notifications. Similarly, KMSKeyId only appears in // results if a trail's log files are encrypted with KMS customer managed keys. diff --git a/service/cloudtrail/api_op_GetChannel.go b/service/cloudtrail/api_op_GetChannel.go index 299cf771694..a19a561d354 100644 --- a/service/cloudtrail/api_op_GetChannel.go +++ b/service/cloudtrail/api_op_GetChannel.go @@ -48,15 +48,14 @@ type GetChannelOutput struct { // service that created the service-linked channel to receive events. Destinations []types.Destination - // A table showing information about the most recent successful and failed attempts - // to ingest events. + // A table showing information about the most recent successful and failed + // attempts to ingest events. IngestionStatus *types.IngestionStatus // The name of the CloudTrail channel. For service-linked channels, the name is - // aws-service-channel/service-name/custom-suffix where service-name represents the - // name of the Amazon Web Services service that created the channel and - // custom-suffix represents the suffix generated by the Amazon Web Services - // service. + // aws-service-channel/service-name/custom-suffix where service-name represents + // the name of the Amazon Web Services service that created the channel and + // custom-suffix represents the suffix generated by the Amazon Web Services service. Name *string // The source for the CloudTrail channel. diff --git a/service/cloudtrail/api_op_GetEventDataStore.go b/service/cloudtrail/api_op_GetEventDataStore.go index 20d4a5fd0c7..50b624ce57c 100644 --- a/service/cloudtrail/api_op_GetEventDataStore.go +++ b/service/cloudtrail/api_op_GetEventDataStore.go @@ -56,8 +56,8 @@ type GetEventDataStoreOutput struct { // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Indicates whether the event data store includes events from all regions, or only - // from the region in which it was created. + // Indicates whether the event data store includes events from all regions, or + // only from the region in which it was created. MultiRegionEnabled *bool // The name of the event data store. @@ -70,7 +70,7 @@ type GetEventDataStoreOutput struct { // The retention period of the event data store, in days. RetentionPeriod *int32 - // The status of an event data store. Values can be ENABLED and PENDING_DELETION. + // The status of an event data store. Values can be ENABLED and PENDING_DELETION . Status types.EventDataStoreStatus // Indicates that termination protection is enabled. @@ -78,7 +78,7 @@ type GetEventDataStoreOutput struct { // Shows the time that an event data store was updated, if applicable. // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. + // CreatedTimestamp . UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_GetEventSelectors.go b/service/cloudtrail/api_op_GetEventSelectors.go index 55b5f1f0b52..cd95609a047 100644 --- a/service/cloudtrail/api_op_GetEventSelectors.go +++ b/service/cloudtrail/api_op_GetEventSelectors.go @@ -12,29 +12,18 @@ import ( ) // Describes the settings for the event selectors that you configured for your -// trail. The information returned for your event selectors includes the -// following: +// trail. The information returned for your event selectors includes the following: // -// * If your event selector includes read-only events, write-only -// events, or all events. This applies to both management events and data -// events. -// -// * If your event selector includes management events. -// -// * If your event -// selector includes data events, the resources on which you are logging data -// events. +// - If your event selector includes read-only events, write-only events, or all +// events. This applies to both management events and data events. +// - If your event selector includes management events. +// - If your event selector includes data events, the resources on which you are +// logging data events. // // For more information about logging management and data events, see the // following topics in the CloudTrail User Guide: -// -// * Logging management events for -// trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) -// -// * -// Logging data events for trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) +// - Logging management events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) +// - Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) func (c *Client) GetEventSelectors(ctx context.Context, params *GetEventSelectorsInput, optFns ...func(*Options)) (*GetEventSelectorsOutput, error) { if params == nil { params = &GetEventSelectorsInput{} @@ -54,24 +43,15 @@ type GetEventSelectorsInput struct { // Specifies the name of the trail or trail ARN. If you specify a trail name, the // string must meet the following requirements: - // - // * Contain only ASCII letters (a-z, - // A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) - // - // * Start with a - // letter or number, and end with a letter or number - // - // * Be between 3 and 128 - // characters - // - // * Have no adjacent periods, underscores or dashes. Names like - // my-_namespace and my--namespace are not valid. - // - // * Not be in IP address format - // (for example, 192.168.5.4) - // - // If you specify a trail ARN, it must be in the - // format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), + // underscores (_), or dashes (-) + // - Start with a letter or number, and end with a letter or number + // - Be between 3 and 128 characters + // - Have no adjacent periods, underscores or dashes. Names like my-_namespace + // and my--namespace are not valid. + // - Not be in IP address format (for example, 192.168.5.4) + // If you specify a trail ARN, it must be in the format: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. TrailName *string diff --git a/service/cloudtrail/api_op_GetImport.go b/service/cloudtrail/api_op_GetImport.go index d3d3df065cf..e0f2b3a1489 100644 --- a/service/cloudtrail/api_op_GetImport.go +++ b/service/cloudtrail/api_op_GetImport.go @@ -56,10 +56,10 @@ type GetImportOutput struct { // The source S3 bucket. ImportSource *types.ImportSource - // Provides statistics for the import. CloudTrail does not update import statistics - // in real-time. Returned values for parameters such as EventsCompleted may be - // lower than the actual value, because CloudTrail updates statistics incrementally - // over the course of the import. + // Provides statistics for the import. CloudTrail does not update import + // statistics in real-time. Returned values for parameters such as EventsCompleted + // may be lower than the actual value, because CloudTrail updates statistics + // incrementally over the course of the import. ImportStatistics *types.ImportStatistics // The status of the import. diff --git a/service/cloudtrail/api_op_GetInsightSelectors.go b/service/cloudtrail/api_op_GetInsightSelectors.go index 79ed5391034..847aaea3cb8 100644 --- a/service/cloudtrail/api_op_GetInsightSelectors.go +++ b/service/cloudtrail/api_op_GetInsightSelectors.go @@ -16,8 +16,7 @@ import ( // enabled on the trail, and if it is, which insight types are enabled. If you run // GetInsightSelectors on a trail that does not have Insights events enabled, the // operation throws the exception InsightNotEnabledException For more information, -// see Logging CloudTrail Insights Events for Trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) +// see Logging CloudTrail Insights Events for Trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) // in the CloudTrail User Guide. func (c *Client) GetInsightSelectors(ctx context.Context, params *GetInsightSelectorsInput, optFns ...func(*Options)) (*GetInsightSelectorsOutput, error) { if params == nil { @@ -38,24 +37,15 @@ type GetInsightSelectorsInput struct { // Specifies the name of the trail or trail ARN. If you specify a trail name, the // string must meet the following requirements: - // - // * Contain only ASCII letters (a-z, - // A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) - // - // * Start with a - // letter or number, and end with a letter or number - // - // * Be between 3 and 128 - // characters - // - // * Have no adjacent periods, underscores or dashes. Names like - // my-_namespace and my--namespace are not valid. - // - // * Not be in IP address format - // (for example, 192.168.5.4) - // - // If you specify a trail ARN, it must be in the - // format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), + // underscores (_), or dashes (-) + // - Start with a letter or number, and end with a letter or number + // - Be between 3 and 128 characters + // - Have no adjacent periods, underscores or dashes. Names like my-_namespace + // and my--namespace are not valid. + // - Not be in IP address format (for example, 192.168.5.4) + // If you specify a trail ARN, it must be in the format: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. TrailName *string diff --git a/service/cloudtrail/api_op_GetQueryResults.go b/service/cloudtrail/api_op_GetQueryResults.go index 6f93d0209e9..2f8cd8903f0 100644 --- a/service/cloudtrail/api_op_GetQueryResults.go +++ b/service/cloudtrail/api_op_GetQueryResults.go @@ -13,7 +13,7 @@ import ( ) // Gets event data results of a query. You must specify the QueryID value returned -// by the StartQuery operation, and an ARN for EventDataStore. +// by the StartQuery operation, and an ARN for EventDataStore . func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error) { if params == nil { params = &GetQueryResultsInput{} @@ -65,8 +65,8 @@ type GetQueryResultsOutput struct { // Shows the count of query results. QueryStatistics *types.QueryStatistics - // The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, - // TIMED_OUT, or CANCELLED. + // The status of the query. Values include QUEUED , RUNNING , FINISHED , FAILED , + // TIMED_OUT , or CANCELLED . QueryStatus types.QueryStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_GetResourcePolicy.go b/service/cloudtrail/api_op_GetResourcePolicy.go index 1b060ba008e..cf72cc14bc8 100644 --- a/service/cloudtrail/api_op_GetResourcePolicy.go +++ b/service/cloudtrail/api_op_GetResourcePolicy.go @@ -31,7 +31,7 @@ type GetResourcePolicyInput struct { // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the // resource-based policy. The following is the format of a resource ARN: - // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel. + // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel . // // This member is required. ResourceArn *string diff --git a/service/cloudtrail/api_op_GetTrailStatus.go b/service/cloudtrail/api_op_GetTrailStatus.go index cf9a78b2137..31135c68a00 100644 --- a/service/cloudtrail/api_op_GetTrailStatus.go +++ b/service/cloudtrail/api_op_GetTrailStatus.go @@ -102,8 +102,8 @@ type GetTrailStatusOutput struct { // Displays any Amazon SNS error that CloudTrail encountered when attempting to // send a notification. For more information about Amazon SNS errors, see the - // Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). + // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/welcome.html) + // . LatestNotificationError *string // Specifies the date and time of the most recent Amazon SNS notification that diff --git a/service/cloudtrail/api_op_ListChannels.go b/service/cloudtrail/api_op_ListChannels.go index 029f4eaa7e8..ac8d8e4bd0b 100644 --- a/service/cloudtrail/api_op_ListChannels.go +++ b/service/cloudtrail/api_op_ListChannels.go @@ -33,8 +33,8 @@ type ListChannelsInput struct { // The maximum number of CloudTrail channels to display on a single page. MaxResults *int32 - // The token to use to get the next page of results after a previous API call. This - // token must be passed in with the same parameters that were specified in the + // The token to use to get the next page of results after a previous API call. + // This token must be passed in with the same parameters that were specified in the // original call. For example, if the original call specified an AttributeKey of // 'Username' with a value of 'root', the call with NextToken should include those // same parameters. diff --git a/service/cloudtrail/api_op_ListEventDataStores.go b/service/cloudtrail/api_op_ListEventDataStores.go index d9e3f81b200..26751b200f8 100644 --- a/service/cloudtrail/api_op_ListEventDataStores.go +++ b/service/cloudtrail/api_op_ListEventDataStores.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListEventDataStoresMiddlewares(stack *middleware.St return nil } -// ListEventDataStoresAPIClient is a client that implements the ListEventDataStores -// operation. +// ListEventDataStoresAPIClient is a client that implements the +// ListEventDataStores operation. type ListEventDataStoresAPIClient interface { ListEventDataStores(context.Context, *ListEventDataStoresInput, ...func(*Options)) (*ListEventDataStoresOutput, error) } diff --git a/service/cloudtrail/api_op_ListImports.go b/service/cloudtrail/api_op_ListImports.go index 0217abc16b1..295a37e9f1b 100644 --- a/service/cloudtrail/api_op_ListImports.go +++ b/service/cloudtrail/api_op_ListImports.go @@ -13,7 +13,7 @@ import ( ) // Returns information on all imports, or a select set of imports by ImportStatus -// or Destination. +// or Destination . func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error) { if params == nil { params = &ListImportsInput{} diff --git a/service/cloudtrail/api_op_ListPublicKeys.go b/service/cloudtrail/api_op_ListPublicKeys.go index 857e5a77f46..35673cbd7a8 100644 --- a/service/cloudtrail/api_op_ListPublicKeys.go +++ b/service/cloudtrail/api_op_ListPublicKeys.go @@ -45,9 +45,9 @@ type ListPublicKeysInput struct { // Reserved for future use. NextToken *string - // Optionally specifies, in UTC, the start of the time range to look up public keys - // for CloudTrail digest files. If not specified, the current time is used, and the - // current public key is returned. + // Optionally specifies, in UTC, the start of the time range to look up public + // keys for CloudTrail digest files. If not specified, the current time is used, + // and the current public key is returned. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/cloudtrail/api_op_ListQueries.go b/service/cloudtrail/api_op_ListQueries.go index b2b054110c5..c79711a5c50 100644 --- a/service/cloudtrail/api_op_ListQueries.go +++ b/service/cloudtrail/api_op_ListQueries.go @@ -14,10 +14,11 @@ import ( ) // Returns a list of queries and query statuses for the past seven days. You must -// specify an ARN value for EventDataStore. Optionally, to shorten the list of +// specify an ARN value for EventDataStore . Optionally, to shorten the list of // results, you can specify a time range, formatted as timestamps, by adding // StartTime and EndTime parameters, and a QueryStatus value. Valid values for -// QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED. +// QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or +// CANCELLED . func (c *Client) ListQueries(ctx context.Context, params *ListQueriesInput, optFns ...func(*Options)) (*ListQueriesOutput, error) { if params == nil { params = &ListQueriesInput{} @@ -41,8 +42,8 @@ type ListQueriesInput struct { // This member is required. EventDataStore *string - // Use with StartTime to bound a ListQueries request, and limit its results to only - // those queries run within a specified time period. + // Use with StartTime to bound a ListQueries request, and limit its results to + // only those queries run within a specified time period. EndTime *time.Time // The maximum number of queries to show on a page. @@ -52,7 +53,8 @@ type ListQueriesInput struct { NextToken *string // The status of queries that you want to return in results. Valid values for - // QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED. + // QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , TIMED_OUT , or + // CANCELLED . QueryStatus types.QueryStatus // Use with EndTime to bound a ListQueries request, and limit its results to only diff --git a/service/cloudtrail/api_op_ListTrails.go b/service/cloudtrail/api_op_ListTrails.go index 007cfedbf66..45f47b8c684 100644 --- a/service/cloudtrail/api_op_ListTrails.go +++ b/service/cloudtrail/api_op_ListTrails.go @@ -30,8 +30,8 @@ func (c *Client) ListTrails(ctx context.Context, params *ListTrailsInput, optFns type ListTrailsInput struct { - // The token to use to get the next page of results after a previous API call. This - // token must be passed in with the same parameters that were specified in the + // The token to use to get the next page of results after a previous API call. + // This token must be passed in with the same parameters that were specified in the // original call. For example, if the original call specified an AttributeKey of // 'Username' with a value of 'root', the call with NextToken should include those // same parameters. diff --git a/service/cloudtrail/api_op_LookupEvents.go b/service/cloudtrail/api_op_LookupEvents.go index 0d0adeef677..6497465f743 100644 --- a/service/cloudtrail/api_op_LookupEvents.go +++ b/service/cloudtrail/api_op_LookupEvents.go @@ -13,46 +13,30 @@ import ( "time" ) -// Looks up management events -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events) -// or CloudTrail Insights events -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events) +// Looks up management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events) +// or CloudTrail Insights events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events) // that are captured by CloudTrail. You can look up events that occurred in a // region within the last 90 days. Lookup supports the following attributes for // management events: -// -// * Amazon Web Services access key -// -// * Event ID -// -// * Event -// name -// -// * Event source -// -// * Read only -// -// * Resource name -// -// * Resource type -// -// * User -// name +// - Amazon Web Services access key +// - Event ID +// - Event name +// - Event source +// - Read only +// - Resource name +// - Resource type +// - User name // // Lookup supports the following attributes for Insights events: +// - Event ID +// - Event name +// - Event source // -// * Event -// ID -// -// * Event name -// -// * Event source -// -// All attributes are optional. The default -// number of results returned is 50, with a maximum of 50 possible. The response -// includes a token that you can use to get the next page of results. The rate of -// lookup requests is limited to two per second, per account, per region. If this -// limit is exceeded, a throttling error occurs. +// All attributes are optional. The default number of results returned is 50, with +// a maximum of 50 possible. The response includes a token that you can use to get +// the next page of results. The rate of lookup requests is limited to two per +// second, per account, per region. If this limit is exceeded, a throttling error +// occurs. func (c *Client) LookupEvents(ctx context.Context, params *LookupEventsInput, optFns ...func(*Options)) (*LookupEventsOutput, error) { if params == nil { params = &LookupEventsInput{} @@ -76,21 +60,21 @@ type LookupEventsInput struct { // is returned. EndTime *time.Time - // Specifies the event category. If you do not specify an event category, events of - // the category are not returned in the response. For example, if you do not - // specify insight as the value of EventCategory, no Insights events are returned. + // Specifies the event category. If you do not specify an event category, events + // of the category are not returned in the response. For example, if you do not + // specify insight as the value of EventCategory , no Insights events are returned. EventCategory types.EventCategory // Contains a list of lookup attributes. Currently the list can contain only one // item. LookupAttributes []types.LookupAttribute - // The number of events to return. Possible values are 1 through 50. The default is - // 50. + // The number of events to return. Possible values are 1 through 50. The default + // is 50. MaxResults *int32 - // The token to use to get the next page of results after a previous API call. This - // token must be passed in with the same parameters that were specified in the + // The token to use to get the next page of results after a previous API call. + // This token must be passed in with the same parameters that were specified in the // original call. For example, if the original call specified an AttributeKey of // 'Username' with a value of 'root', the call with NextToken should include those // same parameters. @@ -197,8 +181,8 @@ var _ LookupEventsAPIClient = (*Client)(nil) // LookupEventsPaginatorOptions is the paginator options for LookupEvents type LookupEventsPaginatorOptions struct { - // The number of events to return. Possible values are 1 through 50. The default is - // 50. + // The number of events to return. Possible values are 1 through 50. The default + // is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudtrail/api_op_PutEventSelectors.go b/service/cloudtrail/api_op_PutEventSelectors.go index 3d87a81704e..9340876647d 100644 --- a/service/cloudtrail/api_op_PutEventSelectors.go +++ b/service/cloudtrail/api_op_PutEventSelectors.go @@ -20,40 +20,29 @@ import ( // the event matches any event selector, the trail processes and logs the event. If // the event doesn't match any event selector, the trail doesn't log the event. // Example +// - You create an event selector for a trail and specify that you want +// write-only events. +// - The EC2 GetConsoleOutput and RunInstances API operations occur in your +// account. +// - CloudTrail evaluates whether the events match your event selectors. +// - The RunInstances is a write-only event and it matches your event selector. +// The trail logs the event. +// - The GetConsoleOutput is a read-only event that doesn't match your event +// selector. The trail doesn't log the event. // -// * You create an event selector for a trail and specify that you want -// write-only events. -// -// * The EC2 GetConsoleOutput and RunInstances API operations -// occur in your account. -// -// * CloudTrail evaluates whether the events match your -// event selectors. -// -// * The RunInstances is a write-only event and it matches your -// event selector. The trail logs the event. -// -// * The GetConsoleOutput is a read-only -// event that doesn't match your event selector. The trail doesn't log the -// event. -// -// The PutEventSelectors operation must be called from the region in which -// the trail was created; otherwise, an InvalidHomeRegionException exception is +// The PutEventSelectors operation must be called from the region in which the +// trail was created; otherwise, an InvalidHomeRegionException exception is // thrown. You can configure up to five event selectors for each trail. For more -// information, see Logging management events for trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html), -// Logging data events for trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html), -// and Quotas in CloudTrail -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) +// information, see Logging management events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) +// , Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) +// , and Quotas in CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) // in the CloudTrail User Guide. You can add advanced event selectors, and // conditions for your advanced event selectors, up to a maximum of 500 values for // all conditions and selectors on a trail. You can use either -// AdvancedEventSelectors or EventSelectors, but not both. If you apply +// AdvancedEventSelectors or EventSelectors , but not both. If you apply // AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. -// For more information about advanced event selectors, see Logging data events for -// trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) +// For more information about advanced event selectors, see Logging data events +// for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) // in the CloudTrail User Guide. func (c *Client) PutEventSelectors(ctx context.Context, params *PutEventSelectorsInput, optFns ...func(*Options)) (*PutEventSelectorsOutput, error) { if params == nil { @@ -74,24 +63,15 @@ type PutEventSelectorsInput struct { // Specifies the name of the trail or trail ARN. If you specify a trail name, the // string must meet the following requirements: - // - // * Contain only ASCII letters (a-z, - // A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) - // - // * Start with a - // letter or number, and end with a letter or number - // - // * Be between 3 and 128 - // characters - // - // * Have no adjacent periods, underscores or dashes. Names like - // my-_namespace and my--namespace are not valid. - // - // * Not be in IP address format - // (for example, 192.168.5.4) - // - // If you specify a trail ARN, it must be in the - // following format. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), + // underscores (_), or dashes (-) + // - Start with a letter or number, and end with a letter or number + // - Be between 3 and 128 characters + // - Have no adjacent periods, underscores or dashes. Names like my-_namespace + // and my--namespace are not valid. + // - Not be in IP address format (for example, 192.168.5.4) + // If you specify a trail ARN, it must be in the following format. + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. TrailName *string @@ -99,11 +79,10 @@ type PutEventSelectorsInput struct { // Specifies the settings for advanced event selectors. You can add advanced event // selectors, and conditions for your advanced event selectors, up to a maximum of // 500 values for all conditions and selectors on a trail. You can use either - // AdvancedEventSelectors or EventSelectors, but not both. If you apply + // AdvancedEventSelectors or EventSelectors , but not both. If you apply // AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. - // For more information about advanced event selectors, see Logging data events for - // trails - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) + // For more information about advanced event selectors, see Logging data events + // for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) // in the CloudTrail User Guide. AdvancedEventSelectors []types.AdvancedEventSelector diff --git a/service/cloudtrail/api_op_PutInsightSelectors.go b/service/cloudtrail/api_op_PutInsightSelectors.go index ddf47541846..fb0ab14ba71 100644 --- a/service/cloudtrail/api_op_PutInsightSelectors.go +++ b/service/cloudtrail/api_op_PutInsightSelectors.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lets you enable Insights event logging by specifying the Insights selectors that -// you want to enable on an existing trail. You also use PutInsightSelectors to -// turn off Insights event logging, by passing an empty list of insight types. The -// valid Insights event types in this release are ApiErrorRateInsight and -// ApiCallRateInsight. +// Lets you enable Insights event logging by specifying the Insights selectors +// that you want to enable on an existing trail. You also use PutInsightSelectors +// to turn off Insights event logging, by passing an empty list of insight types. +// The valid Insights event types in this release are ApiErrorRateInsight and +// ApiCallRateInsight . func (c *Client) PutInsightSelectors(ctx context.Context, params *PutInsightSelectorsInput, optFns ...func(*Options)) (*PutInsightSelectorsOutput, error) { if params == nil { params = &PutInsightSelectorsInput{} @@ -52,7 +52,7 @@ type PutInsightSelectorsOutput struct { // A JSON string that contains the Insights event types that you want to log on a // trail. The valid Insights types in this release are ApiErrorRateInsight and - // ApiCallRateInsight. + // ApiCallRateInsight . InsightSelectors []types.InsightSelector // The Amazon Resource Name (ARN) of a trail for which you want to change or add diff --git a/service/cloudtrail/api_op_PutResourcePolicy.go b/service/cloudtrail/api_op_PutResourcePolicy.go index cfe73f3f6f3..89c1c414e0d 100644 --- a/service/cloudtrail/api_op_PutResourcePolicy.go +++ b/service/cloudtrail/api_op_PutResourcePolicy.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a resource-based permission policy to a CloudTrail channel that is used -// for an integration with an event source outside of Amazon Web Services. For more -// information about resource-based policies, see CloudTrail resource-based policy -// examples -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) +// Attaches a resource-based permission policy to a CloudTrail channel that is +// used for an integration with an event source outside of Amazon Web Services. For +// more information about resource-based policies, see CloudTrail resource-based +// policy examples (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html) // in the CloudTrail User Guide. func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { @@ -35,22 +34,18 @@ type PutResourcePolicyInput struct { // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the // resource-based policy. The following is the format of a resource ARN: - // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel. + // arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel . // // This member is required. ResourceArn *string // A JSON-formatted string for an Amazon Web Services resource-based policy. The // following are requirements for the resource policy: - // - // * Contains only one action: - // cloudtrail-data:PutAuditEvents - // - // * Contains at least one statement. The policy - // can have a maximum of 20 statements. - // - // * Each statement contains at least one - // principal. A statement can have a maximum of 50 principals. + // - Contains only one action: cloudtrail-data:PutAuditEvents + // - Contains at least one statement. The policy can have a maximum of 20 + // statements. + // - Each statement contains at least one principal. A statement can have a + // maximum of 50 principals. // // This member is required. ResourcePolicy *string diff --git a/service/cloudtrail/api_op_RestoreEventDataStore.go b/service/cloudtrail/api_op_RestoreEventDataStore.go index 8aae5c853e3..60e045820d1 100644 --- a/service/cloudtrail/api_op_RestoreEventDataStore.go +++ b/service/cloudtrail/api_op_RestoreEventDataStore.go @@ -12,7 +12,7 @@ import ( "time" ) -// Restores a deleted event data store specified by EventDataStore, which accepts +// Restores a deleted event data store specified by EventDataStore , which accepts // an event data store ARN. You can only restore a deleted event data store within // the seven-day wait period after deletion. Restoring an event data store can take // several minutes, depending on the size of the event data store. @@ -58,8 +58,8 @@ type RestoreEventDataStoreOutput struct { // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Indicates whether the event data store is collecting events from all regions, or - // only from the region in which the event data store was created. + // Indicates whether the event data store is collecting events from all regions, + // or only from the region in which the event data store was created. MultiRegionEnabled *bool // The name of the event data store. @@ -75,13 +75,13 @@ type RestoreEventDataStoreOutput struct { // The status of the event data store. Status types.EventDataStoreStatus - // Indicates that termination protection is enabled and the event data store cannot - // be automatically deleted. + // Indicates that termination protection is enabled and the event data store + // cannot be automatically deleted. TerminationProtectionEnabled *bool // The timestamp that shows when an event data store was updated, if applicable. // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. + // CreatedTimestamp . UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_StartImport.go b/service/cloudtrail/api_op_StartImport.go index 81a428e0b00..ff8318d6399 100644 --- a/service/cloudtrail/api_op_StartImport.go +++ b/service/cloudtrail/api_op_StartImport.go @@ -12,23 +12,21 @@ import ( "time" ) -// Starts an import of logged trail events from a source S3 bucket to a destination -// event data store. By default, CloudTrail only imports events contained in the S3 -// bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and -// does not check prefixes for other Amazon Web Services services. If you want to -// import CloudTrail events contained in another prefix, you must include the -// prefix in the S3LocationUri. For more considerations about importing trail -// events, see Considerations -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations). -// When you start a new import, the Destinations and ImportSource parameters are +// Starts an import of logged trail events from a source S3 bucket to a +// destination event data store. By default, CloudTrail only imports events +// contained in the S3 bucket's CloudTrail prefix and the prefixes inside the +// CloudTrail prefix, and does not check prefixes for other Amazon Web Services +// services. If you want to import CloudTrail events contained in another prefix, +// you must include the prefix in the S3LocationUri . For more considerations about +// importing trail events, see Considerations (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations) +// . When you start a new import, the Destinations and ImportSource parameters are // required. Before starting a new import, disable any access control lists (ACLs) // attached to the source S3 bucket. For more information about disabling ACLs, see -// Controlling ownership of objects and disabling ACLs for your bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html). -// When you retry an import, the ImportID parameter is required. If the destination -// event data store is for an organization, you must use the management account to -// import trail events. You cannot use the delegated administrator account for the -// organization. +// Controlling ownership of objects and disabling ACLs for your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// . When you retry an import, the ImportID parameter is required. If the +// destination event data store is for an organization, you must use the management +// account to import trail events. You cannot use the delegated administrator +// account for the organization. func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optFns ...func(*Options)) (*StartImportOutput, error) { if params == nil { params = &StartImportInput{} @@ -50,11 +48,11 @@ type StartImportInput struct { // import. Destinations []string - // Use with StartEventTime to bound a StartImport request, and limit imported trail - // events to only those events logged within a specified time period. When you - // specify a time range, CloudTrail checks the prefix and log file names to verify - // the names contain a date between the specified StartEventTime and EndEventTime - // before attempting to import events. + // Use with StartEventTime to bound a StartImport request, and limit imported + // trail events to only those events logged within a specified time period. When + // you specify a time range, CloudTrail checks the prefix and log file names to + // verify the names contain a date between the specified StartEventTime and + // EndEventTime before attempting to import events. EndEventTime *time.Time // The ID of the import. Use this parameter when you are retrying an import. diff --git a/service/cloudtrail/api_op_UpdateEventDataStore.go b/service/cloudtrail/api_op_UpdateEventDataStore.go index 23c91398c28..6fa11fd6cc0 100644 --- a/service/cloudtrail/api_op_UpdateEventDataStore.go +++ b/service/cloudtrail/api_op_UpdateEventDataStore.go @@ -18,8 +18,8 @@ import ( // in days, and valid values are integers between 90 and 2557. By default, // TerminationProtection is enabled. For event data stores for CloudTrail events, // AdvancedEventSelectors includes or excludes management and data events in your -// event data store. For more information about AdvancedEventSelectors, see -// PutEventSelectorsRequest$AdvancedEventSelectors. For event data stores for +// event data store. For more information about AdvancedEventSelectors , see +// PutEventSelectorsRequest$AdvancedEventSelectors . For event data stores for // Config configuration items, Audit Manager evidence, or non-Amazon Web Services // events, AdvancedEventSelectors includes events of that type in your event data // store. @@ -46,12 +46,12 @@ type UpdateEventDataStoreInput struct { // This member is required. EventDataStore *string - // The advanced event selectors used to select events for the event data store. You - // can configure up to five advanced event selectors for each event data store. + // The advanced event selectors used to select events for the event data store. + // You can configure up to five advanced event selectors for each event data store. AdvancedEventSelectors []types.AdvancedEventSelector // Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. - // The value can be an alias name prefixed by alias/, a fully specified ARN to an + // The value can be an alias name prefixed by alias/ , a fully specified ARN to an // alias, a fully specified ARN to a key, or a globally unique identifier. // Disabling or deleting the KMS key, or removing CloudTrail permissions on the // key, prevents CloudTrail from logging events to the event data store, and @@ -60,20 +60,12 @@ type UpdateEventDataStoreInput struct { // key cannot be removed or changed. Before you disable or delete a KMS key that // you are using with an event data store, delete or back up your event data store. // CloudTrail also supports KMS multi-Region keys. For more information about - // multi-Region keys, see Using multi-Region keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. Examples: - // - // * alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // 12345678-1234-1234-1234-123456789012 + // - alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // - 12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies whether an event data store collects events from all regions, or only @@ -83,15 +75,15 @@ type UpdateEventDataStoreInput struct { // The event data store name. Name *string - // Specifies whether an event data store collects events logged for an organization - // in Organizations. + // Specifies whether an event data store collects events logged for an + // organization in Organizations. OrganizationEnabled *bool // The retention period, in days. RetentionPeriod *int32 - // Indicates that termination protection is enabled and the event data store cannot - // be automatically deleted. + // Indicates that termination protection is enabled and the event data store + // cannot be automatically deleted. TerminationProtectionEnabled *bool noSmithyDocumentSerde @@ -113,8 +105,8 @@ type UpdateEventDataStoreOutput struct { // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string - // Indicates whether the event data store includes events from all regions, or only - // from the region in which it was created. + // Indicates whether the event data store includes events from all regions, or + // only from the region in which it was created. MultiRegionEnabled *bool // The name of the event data store. @@ -127,7 +119,7 @@ type UpdateEventDataStoreOutput struct { // The retention period, in days. RetentionPeriod *int32 - // The status of an event data store. Values can be ENABLED and PENDING_DELETION. + // The status of an event data store. Values can be ENABLED and PENDING_DELETION . Status types.EventDataStoreStatus // Indicates whether termination protection is enabled for the event data store. @@ -135,7 +127,7 @@ type UpdateEventDataStoreOutput struct { // The timestamp that shows when the event data store was last updated. // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. + // CreatedTimestamp . UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_UpdateTrail.go b/service/cloudtrail/api_op_UpdateTrail.go index 4b395c00f4b..90cb57e29e4 100644 --- a/service/cloudtrail/api_op_UpdateTrail.go +++ b/service/cloudtrail/api_op_UpdateTrail.go @@ -36,24 +36,15 @@ type UpdateTrailInput struct { // Specifies the name of the trail or trail ARN. If Name is a trail name, the // string must meet the following requirements: - // - // * Contain only ASCII letters (a-z, - // A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) - // - // * Start with a - // letter or number, and end with a letter or number - // - // * Be between 3 and 128 - // characters - // - // * Have no adjacent periods, underscores or dashes. Names like - // my-_namespace and my--namespace are not valid. - // - // * Not be in IP address format - // (for example, 192.168.5.4) - // - // If Name is a trail ARN, it must be in the following - // format. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), + // underscores (_), or dashes (-) + // - Start with a letter or number, and end with a letter or number + // - Be between 3 and 128 characters + // - Have no adjacent periods, underscores or dashes. Names like my-_namespace + // and my--namespace are not valid. + // - Not be in IP address format (for example, 192.168.5.4) + // If Name is a trail ARN, it must be in the following format. + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. Name *string @@ -61,16 +52,16 @@ type UpdateTrailInput struct { // Specifies a log group name using an Amazon Resource Name (ARN), a unique // identifier that represents the log group to which CloudTrail logs are delivered. // You must use a log group that exists in your account. Not required unless you - // specify CloudWatchLogsRoleArn. + // specify CloudWatchLogsRoleArn . CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a // user's log group. You must use a role that exists in your account. CloudWatchLogsRoleArn *string - // Specifies whether log file validation is enabled. The default is false. When you - // disable log file integrity validation, the chain of digest files is broken after - // one hour. CloudTrail does not create digest files for log files that were + // Specifies whether log file validation is enabled. The default is false. When + // you disable log file integrity validation, the chain of digest files is broken + // after one hour. CloudTrail does not create digest files for log files that were // delivered during a period in which log file integrity validation was disabled. // For example, if you enable log file integrity validation at noon on January 1, // disable it at noon on January 2, and re-enable it at noon on January 10, digest @@ -97,43 +88,34 @@ type UpdateTrailInput struct { // is false, and cannot be true unless the call is made on behalf of an Amazon Web // Services account that is the management account or delegated administrator // account for an organization in Organizations. If the trail is not an - // organization trail and this is set to true, the trail will be created in all + // organization trail and this is set to true , the trail will be created in all // Amazon Web Services accounts that belong to the organization. If the trail is an - // organization trail and this is set to false, the trail will remain in the + // organization trail and this is set to false , the trail will remain in the // current Amazon Web Services account but be deleted from all member accounts in // the organization. IsOrganizationTrail *bool - // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The - // value can be an alias name prefixed by "alias/", a fully specified ARN to an + // Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. + // The value can be an alias name prefixed by "alias/", a fully specified ARN to an // alias, a fully specified ARN to a key, or a globally unique identifier. // CloudTrail also supports KMS multi-Region keys. For more information about - // multi-Region keys, see Using multi-Region keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. Examples: - // - // * alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:alias/MyAliasName - // - // * - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // 12345678-1234-1234-1234-123456789012 + // - alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:alias/MyAliasName + // - arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // - 12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies the name of the Amazon S3 bucket designated for publishing log files. - // See Amazon S3 Bucket Naming Requirements - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). + // See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html) + // . S3BucketName *string // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). - // The maximum length is 200 characters. + // CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) + // . The maximum length is 200 characters. S3KeyPrefix *string // Specifies the name of the Amazon SNS topic defined for notification of log file @@ -181,8 +163,8 @@ type UpdateTrailOutput struct { // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your - // IAM Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). + // IAM Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) + // . S3KeyPrefix *string // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send @@ -190,7 +172,7 @@ type UpdateTrailOutput struct { // topic ARN. arn:aws:sns:us-east-2:123456789012:MyTopic SnsTopicARN *string - // This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN. + // This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN . // // Deprecated: This member has been deprecated. SnsTopicName *string diff --git a/service/cloudtrail/doc.go b/service/cloudtrail/doc.go index 44ee7e496ae..3255cf64078 100644 --- a/service/cloudtrail/doc.go +++ b/service/cloudtrail/doc.go @@ -15,10 +15,9 @@ // iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For // example, the SDKs handle cryptographically signing requests, managing errors, // and retrying requests automatically. For more information about the Amazon Web -// Services SDKs, including how to download and install them, see Tools to Build on -// Amazon Web Services (http://aws.amazon.com/tools/). See the CloudTrail User -// Guide -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) +// Services SDKs, including how to download and install them, see Tools to Build +// on Amazon Web Services (http://aws.amazon.com/tools/) . See the CloudTrail User +// Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) // for information about the data that is included with each Amazon Web Services // API call listed in the log files. package cloudtrail diff --git a/service/cloudtrail/types/enums.go b/service/cloudtrail/types/enums.go index c58f2d232cd..4658bd22fe0 100644 --- a/service/cloudtrail/types/enums.go +++ b/service/cloudtrail/types/enums.go @@ -119,9 +119,9 @@ const ( ImportStatusCompleted ImportStatus = "COMPLETED" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "INITIALIZING", diff --git a/service/cloudtrail/types/errors.go b/service/cloudtrail/types/errors.go index f86e36a01bc..b42a1f29a33 100644 --- a/service/cloudtrail/types/errors.go +++ b/service/cloudtrail/types/errors.go @@ -277,10 +277,9 @@ func (e *ChannelNotFoundException) ErrorFault() smithy.ErrorFault { return smith // This exception is thrown when trusted access has not been enabled between // CloudTrail and Organizations. For more information, see Enabling Trusted Access -// with Other Amazon Web Services Services -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) -// and Prepare For Creating a Trail For Your Organization -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// with Other Amazon Web Services Services (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) +// and Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// . type CloudTrailAccessNotEnabledException struct { Message *string @@ -488,8 +487,8 @@ func (e *EventDataStoreAlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified event data store ARN is not valid or does not map to an event data -// store in your account. +// The specified event data store ARN is not valid or does not map to an event +// data store in your account. type EventDataStoreARNInvalidException struct { Message *string @@ -598,8 +597,8 @@ func (e *EventDataStoreNotFoundException) ErrorCode() string { } func (e *EventDataStoreNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The event data store cannot be deleted because termination protection is enabled -// for it. +// The event data store cannot be deleted because termination protection is +// enabled for it. type EventDataStoreTerminationProtectedException struct { Message *string @@ -679,8 +678,8 @@ func (e *InactiveEventDataStoreException) ErrorCode() string { } func (e *InactiveEventDataStoreException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified query cannot be canceled because it is in the FINISHED, FAILED, -// TIMED_OUT, or CANCELLED state. +// The specified query cannot be canceled because it is in the FINISHED , FAILED , +// TIMED_OUT , or CANCELLED state. type InactiveQueryException struct { Message *string @@ -707,7 +706,7 @@ func (e *InactiveQueryException) ErrorCode() string { func (e *InactiveQueryException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // If you run GetInsightSelectors on a trail that does not have Insights events -// enabled, the operation throws the exception InsightNotEnabledException. +// enabled, the operation throws the exception InsightNotEnabledException . type InsightNotEnabledException struct { Message *string @@ -908,8 +907,7 @@ func (e *InvalidCloudWatchLogsRoleArnException) ErrorFault() smithy.ErrorFault { // A date range for the query was specified that is not valid. Be sure that the // start time is chronologically before the end time. For more information about -// writing a query, see Create or edit a query -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) +// writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) // in the CloudTrail User Guide. type InvalidDateRangeException struct { Message *string @@ -937,7 +935,7 @@ func (e *InvalidDateRangeException) ErrorCode() string { func (e *InvalidDateRangeException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Occurs if an event category that is not valid is specified as a value of -// EventCategory. +// EventCategory . type InvalidEventCategoryException struct { Message *string @@ -1028,22 +1026,15 @@ func (e *InvalidEventDataStoreStatusException) ErrorFault() smithy.ErrorFault { // conditions in all advanced event selectors is allowed. A trail is limited to 250 // data resources. These data resources can be distributed across event selectors, // but the overall total cannot exceed 250. You can: -// -// * Specify a valid number of -// event selectors (1 to 5) for a trail. -// -// * Specify a valid number of data -// resources (1 to 250) for an event selector. The limit of number of resources on -// an individual event selector is configurable up to 250. However, this upper -// limit is allowed only if the total number of data resources does not exceed 250 -// across all event selectors for a trail. -// -// * Specify up to 500 values for all -// conditions in all advanced event selectors for a trail. -// -// * Specify a valid value -// for a parameter. For example, specifying the ReadWriteType parameter with a -// value of read-only is not valid. +// - Specify a valid number of event selectors (1 to 5) for a trail. +// - Specify a valid number of data resources (1 to 250) for an event selector. +// The limit of number of resources on an individual event selector is configurable +// up to 250. However, this upper limit is allowed only if the total number of data +// resources does not exceed 250 across all event selectors for a trail. +// - Specify up to 500 values for all conditions in all advanced event selectors +// for a trail. +// - Specify a valid value for a parameter. For example, specifying the +// ReadWriteType parameter with a value of read-only is not valid. type InvalidEventSelectorsException struct { Message *string @@ -1230,8 +1221,8 @@ func (e *InvalidMaxResultsException) ErrorCode() string { } func (e *InvalidMaxResultsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A token that is not valid, or a token that was previously used in a request with -// different parameters. This exception is thrown if the token is not valid. +// A token that is not valid, or a token that was previously used in a request +// with different parameters. This exception is thrown if the token is not valid. type InvalidNextTokenException struct { Message *string @@ -1314,8 +1305,7 @@ func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smit // The query that was submitted has validation errors, or uses incorrect syntax or // unsupported keywords. For more information about writing a query, see Create or -// edit a query -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) +// edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) // in the CloudTrail User Guide. type InvalidQueryStatementException struct { Message *string @@ -1499,8 +1489,8 @@ func (e *InvalidTagParameterException) ErrorCode() string { } func (e *InvalidTagParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Occurs if the timestamp values are not valid. Either the start time occurs after -// the end time, or the time range is outside the range of possible values. +// Occurs if the timestamp values are not valid. Either the start time occurs +// after the end time, or the time range is outside the range of possible values. type InvalidTimeRangeException struct { Message *string @@ -1554,21 +1544,13 @@ func (e *InvalidTokenException) ErrorFault() smithy.ErrorFault { return smithy.F // This exception is thrown when the provided trail name is not valid. Trail names // must meet the following requirements: -// -// * Contain only ASCII letters (a-z, A-Z), -// numbers (0-9), periods (.), underscores (_), or dashes (-) -// -// * Start with a -// letter or number, and end with a letter or number -// -// * Be between 3 and 128 -// characters -// -// * Have no adjacent periods, underscores or dashes. Names like -// my-_namespace and my--namespace are not valid. -// -// * Not be in IP address format -// (for example, 192.168.5.4) +// - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), +// underscores (_), or dashes (-) +// - Start with a letter or number, and end with a letter or number +// - Be between 3 and 128 characters +// - Have no adjacent periods, underscores or dashes. Names like my-_namespace +// and my--namespace are not valid. +// - Not be in IP address format (for example, 192.168.5.4) type InvalidTrailNameException struct { Message *string @@ -1647,9 +1629,9 @@ func (e *KmsKeyDisabledException) ErrorCode() string { } func (e *KmsKeyDisabledException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the KMS key does not exist, when the S3 bucket and -// the KMS key are not in the same region, or when the KMS key associated with the -// Amazon SNS topic either does not exist or is not in the same region. +// This exception is thrown when the KMS key does not exist, when the S3 bucket +// and the KMS key are not in the same region, or when the KMS key associated with +// the Amazon SNS topic either does not exist or is not in the same region. type KmsKeyNotFoundException struct { Message *string @@ -1788,13 +1770,12 @@ func (e *NotOrganizationManagementAccountException) ErrorFault() smithy.ErrorFau return smithy.FaultClient } -// This exception is thrown when the Amazon Web Services account making the request -// to create or update an organization trail or event data store is not the +// This exception is thrown when the Amazon Web Services account making the +// request to create or update an organization trail or event data store is not the // management account for an organization in Organizations. For more information, -// see Prepare For Creating a Trail For Your Organization -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) -// or Create an event data store -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). +// see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html) +// . type NotOrganizationMasterAccountException struct { Message *string @@ -1934,7 +1915,7 @@ func (e *QueryIdNotFoundException) ErrorFault() smithy.ErrorFault { return smith // This exception is thrown when the provided resource does not exist, or the ARN // format of the resource is not valid. The following is the valid format for a -// resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel. +// resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel . type ResourceARNNotValidException struct { Message *string @@ -2015,15 +1996,11 @@ func (e *ResourcePolicyNotFoundException) ErrorFault() smithy.ErrorFault { retur // This exception is thrown when the resouce-based policy has syntax errors, or // contains a principal that is not valid. The following are requirements for the // resource policy: -// -// * Contains only one action: cloudtrail-data:PutAuditEvents -// -// * -// Contains at least one statement. The policy can have a maximum of 20 -// statements. -// -// * Each statement contains at least one principal. A statement can -// have a maximum of 50 principals. +// - Contains only one action: cloudtrail-data:PutAuditEvents +// - Contains at least one statement. The policy can have a maximum of 20 +// statements. +// - Each statement contains at least one principal. A statement can have a +// maximum of 50 principals. type ResourcePolicyNotValidException struct { Message *string diff --git a/service/cloudtrail/types/types.go b/service/cloudtrail/types/types.go index d4d6cc8e8dc..8be80b67c0e 100644 --- a/service/cloudtrail/types/types.go +++ b/service/cloudtrail/types/types.go @@ -7,28 +7,19 @@ import ( "time" ) -// Advanced event selectors let you create fine-grained selectors for the following -// CloudTrail event record fields. They help you control costs by logging only those -// events that are important to you. For more information about advanced event -// selectors, see Logging data events for trails -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) +// Advanced event selectors let you create fine-grained selectors for the +// following CloudTrail event record fields. They help you control costs by logging +// only those events that are important to you. For more information about advanced +// event selectors, see Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) // in the CloudTrail User Guide. +// - readOnly +// - eventSource +// - eventName +// - eventCategory +// - resources.type +// - resources.ARN // -// * readOnly -// -// * eventSource -// -// * eventName -// -// * -// eventCategory -// -// * resources.type -// -// * resources.ARN -// -// You cannot apply both event -// selectors and advanced event selectors to a trail. +// You cannot apply both event selectors and advanced event selectors to a trail. type AdvancedEventSelector struct { // Contains all selector statements in an advanced event selector. @@ -46,213 +37,126 @@ type AdvancedEventSelector struct { // A single selector statement in an advanced event selector. type AdvancedFieldSelector struct { - // A field in a CloudTrail event record on which to filter events to be logged. For - // event data stores for Config configuration items, Audit Manager evidence, or + // A field in a CloudTrail event record on which to filter events to be logged. + // For event data stores for Config configuration items, Audit Manager evidence, or // non-Amazon Web Services events, the field is used only for selecting events as // filtering is not supported. For CloudTrail event records, supported fields - // include readOnly, eventCategory, eventSource (for management events), eventName, - // resources.type, and resources.ARN. For event data stores for Config - // configuration items, Audit Manager evidence, or non-Amazon Web Services events, - // the only supported field is eventCategory. - // - // * readOnly - Optional. Can be set to - // Equals a value of true or false. If you do not add this field, CloudTrail logs - // both read and write events. A value of true logs only read events. A value of - // false logs only write events. - // - // * eventSource - For filtering management events - // only. This can be set only to NotEqualskms.amazonaws.com. - // - // * eventName - Can use - // any operator. You can use it to filter in or filter out any data event logged to - // CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values - // for this field, separated by commas. - // - // * eventCategory - This is required and must - // be set to Equals. - // - // * For CloudTrail event records, the value must be Management - // or Data. - // - // * For Config configuration items, the value must be - // ConfigurationItem. - // - // * For Audit Manager evidence, the value must be Evidence. - // - // * - // For non-Amazon Web Services events, the value must be ActivityAuditLog. - // - // * - // resources.type - This field is required for CloudTrail data events. - // resources.type can only use the Equals operator, and the value can be one of the - // following: - // - // * AWS::CloudTrail::Channel - // - // * AWS::S3::Object - // - // * - // AWS::Lambda::Function - // - // * AWS::DynamoDB::Table - // - // * AWS::S3Outposts::Object - // - // * - // AWS::ManagedBlockchain::Node - // - // * AWS::S3ObjectLambda::AccessPoint - // - // * - // AWS::EC2::Snapshot - // - // * AWS::S3::AccessPoint - // - // * AWS::DynamoDB::Stream - // - // * - // AWS::Glue::Table - // - // * AWS::FinSpace::Environment - // - // * - // AWS::SageMaker::ExperimentTrialComponent - // - // * AWS::SageMaker::FeatureGroup - // - // You - // can have only one resources.type field per selector. To log data events on more - // than one resource type, add another selector. - // - // * resources.ARN - You can use any - // operator with resources.ARN, but if you use Equals or NotEquals, the value must - // exactly match the ARN of a valid resource of the type you've specified in the - // template as the value of resources.type. For example, if resources.type equals - // AWS::S3::Object, the ARN must be in one of the following formats. To log all - // data events for all objects in a specific S3 bucket, use the StartsWith - // operator, and include only the bucket ARN as the matching value. The trailing - // slash is intentional; do not exclude it. Replace the text between less than and - // greater than symbols (<>) with resource-specific information. - // - // * arn::s3:::/ - // - // * - // arn::s3:::// - // - // When resources.type equals AWS::S3::AccessPoint, and the operator - // is set to Equals or NotEquals, the ARN must be in one of the following formats. - // To log events on all objects in an S3 access point, we recommend that you use - // only the access point ARN, don’t include the object path, and use the StartsWith - // or NotStartsWith operators. - // - // * arn::s3:::accesspoint/ - // - // * - // arn::s3:::accesspoint//object/ - // - // When resources.type equals - // AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN - // must be in the following format: - // - // * arn::lambda:::function: - // - // When resources.type - // equals AWS::DynamoDB::Table, and the operator is set to Equals or NotEquals, the - // ARN must be in the following format: - // - // * arn::dynamodb:::table/ - // - // When - // resources.type equals AWS::CloudTrail::Channel, and the operator is set to - // Equals or NotEquals, the ARN must be in the following format: - // - // * - // arn::cloudtrail:::channel/ - // - // When resources.type equals AWS::S3Outposts::Object, - // and the operator is set to Equals or NotEquals, the ARN must be in the following - // format: - // - // * arn::s3-outposts::: - // - // When resources.type equals - // AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals, - // the ARN must be in the following format: - // - // * - // arn::managedblockchain:::nodes/ - // - // When resources.type equals - // AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or - // NotEquals, the ARN must be in the following format: - // - // * - // arn::s3-object-lambda:::accesspoint/ - // - // When resources.type equals - // AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must - // be in the following format: - // - // * arn::ec2:::snapshot/ - // - // When resources.type equals - // AWS::DynamoDB::Stream, and the operator is set to Equals or NotEquals, the ARN - // must be in the following format: - // - // * arn::dynamodb:::table//stream/ - // - // When - // resources.type equals AWS::Glue::Table, and the operator is set to Equals or - // NotEquals, the ARN must be in the following format: - // - // * arn::glue:::table// - // - // When - // resources.type equals AWS::FinSpace::Environment, and the operator is set to - // Equals or NotEquals, the ARN must be in the following format: - // - // * - // arn::finspace:::environment/ - // - // When resources.type equals - // AWS::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or - // NotEquals, the ARN must be in the following format: - // - // * - // arn::sagemaker:::experiment-trial-component/ - // - // When resources.type equals - // AWS::SageMaker::FeatureGroup, and the operator is set to Equals or NotEquals, - // the ARN must be in the following format: - // - // * arn::sagemaker:::feature-group/ + // include readOnly , eventCategory , eventSource (for management events), + // eventName , resources.type , and resources.ARN . For event data stores for + // Config configuration items, Audit Manager evidence, or non-Amazon Web Services + // events, the only supported field is eventCategory . + // - readOnly - Optional. Can be set to Equals a value of true or false . If you + // do not add this field, CloudTrail logs both read and write events. A value of + // true logs only read events. A value of false logs only write events. + // - eventSource - For filtering management events only. This can be set only to + // NotEquals kms.amazonaws.com . + // - eventName - Can use any operator. You can use it to filter in or filter out + // any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock . + // You can have multiple values for this field, separated by commas. + // - eventCategory - This is required and must be set to Equals . + // - For CloudTrail event records, the value must be Management or Data . + // - For Config configuration items, the value must be ConfigurationItem . + // - For Audit Manager evidence, the value must be Evidence . + // - For non-Amazon Web Services events, the value must be ActivityAuditLog . + // - resources.type - This field is required for CloudTrail data events. + // resources.type can only use the Equals operator, and the value can be one of + // the following: + // - AWS::CloudTrail::Channel + // - AWS::S3::Object + // - AWS::Lambda::Function + // - AWS::DynamoDB::Table + // - AWS::S3Outposts::Object + // - AWS::ManagedBlockchain::Node + // - AWS::S3ObjectLambda::AccessPoint + // - AWS::EC2::Snapshot + // - AWS::S3::AccessPoint + // - AWS::DynamoDB::Stream + // - AWS::Glue::Table + // - AWS::FinSpace::Environment + // - AWS::SageMaker::ExperimentTrialComponent + // - AWS::SageMaker::FeatureGroup You can have only one resources.type field per + // selector. To log data events on more than one resource type, add another + // selector. + // - resources.ARN - You can use any operator with resources.ARN , but if you use + // Equals or NotEquals , the value must exactly match the ARN of a valid resource + // of the type you've specified in the template as the value of resources.type. For + // example, if resources.type equals AWS::S3::Object , the ARN must be in one of + // the following formats. To log all data events for all objects in a specific S3 + // bucket, use the StartsWith operator, and include only the bucket ARN as the + // matching value. The trailing slash is intentional; do not exclude it. Replace + // the text between less than and greater than symbols (<>) with resource-specific + // information. + // - arn::s3:::/ + // - arn::s3:::// When resources.type equals AWS::S3::AccessPoint , and the + // operator is set to Equals or NotEquals , the ARN must be in one of the + // following formats. To log events on all objects in an S3 access point, we + // recommend that you use only the access point ARN, don’t include the object path, + // and use the StartsWith or NotStartsWith operators. + // - arn::s3:::accesspoint/ + // - arn::s3:::accesspoint//object/ When resources.type equals + // AWS::Lambda::Function , and the operator is set to Equals or NotEquals , the + // ARN must be in the following format: + // - arn::lambda:::function: When resources.type equals AWS::DynamoDB::Table , + // and the operator is set to Equals or NotEquals , the ARN must be in the + // following format: + // - arn::dynamodb:::table/ When resources.type equals AWS::CloudTrail::Channel , + // and the operator is set to Equals or NotEquals , the ARN must be in the + // following format: + // - arn::cloudtrail:::channel/ When resources.type equals + // AWS::S3Outposts::Object , and the operator is set to Equals or NotEquals , the + // ARN must be in the following format: + // - arn::s3-outposts::: When resources.type equals AWS::ManagedBlockchain::Node + // , and the operator is set to Equals or NotEquals , the ARN must be in the + // following format: + // - arn::managedblockchain:::nodes/ When resources.type equals + // AWS::S3ObjectLambda::AccessPoint , and the operator is set to Equals or + // NotEquals , the ARN must be in the following format: + // - arn::s3-object-lambda:::accesspoint/ When resources.type equals + // AWS::EC2::Snapshot , and the operator is set to Equals or NotEquals , the ARN + // must be in the following format: + // - arn::ec2:::snapshot/ When resources.type equals AWS::DynamoDB::Stream , and + // the operator is set to Equals or NotEquals , the ARN must be in the following + // format: + // - arn::dynamodb:::table//stream/ When resources.type equals AWS::Glue::Table , + // and the operator is set to Equals or NotEquals , the ARN must be in the + // following format: + // - arn::glue:::table// When resources.type equals AWS::FinSpace::Environment , + // and the operator is set to Equals or NotEquals , the ARN must be in the + // following format: + // - arn::finspace:::environment/ When resources.type equals + // AWS::SageMaker::ExperimentTrialComponent , and the operator is set to Equals + // or NotEquals , the ARN must be in the following format: + // - arn::sagemaker:::experiment-trial-component/ When resources.type equals + // AWS::SageMaker::FeatureGroup , and the operator is set to Equals or NotEquals + // , the ARN must be in the following format: + // - arn::sagemaker:::feature-group/ // // This member is required. Field *string - // An operator that includes events that match the last few characters of the event - // record field specified as the value of Field. + // An operator that includes events that match the last few characters of the + // event record field specified as the value of Field . EndsWith []string // An operator that includes events that match the exact value of the event record - // field specified as the value of Field. This is the only valid operator that you - // can use with the readOnly, eventCategory, and resources.type fields. + // field specified as the value of Field . This is the only valid operator that you + // can use with the readOnly , eventCategory , and resources.type fields. Equals []string - // An operator that excludes events that match the last few characters of the event - // record field specified as the value of Field. + // An operator that excludes events that match the last few characters of the + // event record field specified as the value of Field . NotEndsWith []string // An operator that excludes events that match the exact value of the event record - // field specified as the value of Field. + // field specified as the value of Field . NotEquals []string // An operator that excludes events that match the first few characters of the - // event record field specified as the value of Field. + // event record field specified as the value of Field . NotStartsWith []string // An operator that includes events that match the first few characters of the - // event record field specified as the value of Field. + // event record field specified as the value of Field . StartsWith []string noSmithyDocumentSerde @@ -265,8 +169,8 @@ type Channel struct { ChannelArn *string // The name of the CloudTrail channel. For service-linked channels, the name is - // aws-service-channel/service-name/custom-suffix where service-name represents the - // name of the Amazon Web Services service that created the channel and + // aws-service-channel/service-name/custom-suffix where service-name represents + // the name of the Amazon Web Services service that created the channel and // custom-suffix represents the suffix created by the Amazon Web Services service. Name *string @@ -283,124 +187,81 @@ type Channel struct { // advanced event selectors, the maximum total number of values for all conditions, // across all advanced event selectors for the trail, is 500. The following example // demonstrates how logging works when you configure logging of all data events for -// an S3 bucket named bucket-1. In this example, the CloudTrail user specified an +// an S3 bucket named bucket-1 . In this example, the CloudTrail user specified an // empty prefix, and the option to log both Read and Write data events. +// - A user uploads an image file to bucket-1 . +// - The PutObject API operation is an Amazon S3 object-level API. It is recorded +// as a data event in CloudTrail. Because the CloudTrail user specified an S3 +// bucket with an empty prefix, events that occur on any object in that bucket are +// logged. The trail processes and logs the event. +// - A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2 +// . +// - The PutObject API operation occurred for an object in an S3 bucket that the +// CloudTrail user didn't specify for the trail. The trail doesn’t log the event. // -// * A user -// uploads an image file to bucket-1. -// -// * The PutObject API operation is an Amazon -// S3 object-level API. It is recorded as a data event in CloudTrail. Because the -// CloudTrail user specified an S3 bucket with an empty prefix, events that occur -// on any object in that bucket are logged. The trail processes and logs the -// event. -// -// * A user uploads an object to an Amazon S3 bucket named -// arn:aws:s3:::bucket-2. -// -// * The PutObject API operation occurred for an object in -// an S3 bucket that the CloudTrail user didn't specify for the trail. The trail -// doesn’t log the event. -// -// The following example demonstrates how logging works -// when you configure logging of Lambda data events for a Lambda function named -// MyLambdaFunction, but not for all Lambda functions. -// -// * A user runs a script that -// includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction -// function. -// -// * The Invoke API operation on MyLambdaFunction is an Lambda API. It -// is recorded as a data event in CloudTrail. Because the CloudTrail user specified -// logging data events for MyLambdaFunction, any invocations of that function are -// logged. The trail processes and logs the event. -// -// * The Invoke API operation on -// MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not -// specify logging data events for all Lambda functions, the Invoke operation for -// MyOtherLambdaFunction does not match the function specified for the trail. The -// trail doesn’t log the event. +// The following example demonstrates how logging works when you configure logging +// of Lambda data events for a Lambda function named MyLambdaFunction, but not for +// all Lambda functions. +// - A user runs a script that includes a call to the MyLambdaFunction function +// and the MyOtherLambdaFunction function. +// - The Invoke API operation on MyLambdaFunction is an Lambda API. It is +// recorded as a data event in CloudTrail. Because the CloudTrail user specified +// logging data events for MyLambdaFunction, any invocations of that function are +// logged. The trail processes and logs the event. +// - The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because +// the CloudTrail user did not specify logging data events for all Lambda +// functions, the Invoke operation for MyOtherLambdaFunction does not match the +// function specified for the trail. The trail doesn’t log the event. type DataResource struct { // The resource type in which you want to log data events. You can specify the // following basic event selector resource types: - // - // * AWS::S3::Object - // - // * - // AWS::Lambda::Function - // - // * AWS::DynamoDB::Table - // - // The following resource types are - // also available through advanced event selectors. Basic event selector resource - // types are valid in advanced event selectors, but advanced event selector - // resource types are not valid in basic event selectors. For more information, see - // AdvancedFieldSelector$Field. - // - // * AWS::CloudTrail::Channel - // - // * - // AWS::S3Outposts::Object - // - // * AWS::ManagedBlockchain::Node - // - // * - // AWS::S3ObjectLambda::AccessPoint - // - // * AWS::EC2::Snapshot - // - // * - // AWS::S3::AccessPoint - // - // * AWS::DynamoDB::Stream - // - // * AWS::Glue::Table - // - // * - // AWS::FinSpace::Environment - // - // * AWS::SageMaker::ExperimentTrialComponent - // - // * - // AWS::SageMaker::FeatureGroup + // - AWS::S3::Object + // - AWS::Lambda::Function + // - AWS::DynamoDB::Table + // The following resource types are also available through advanced event + // selectors. Basic event selector resource types are valid in advanced event + // selectors, but advanced event selector resource types are not valid in basic + // event selectors. For more information, see AdvancedFieldSelector$Field . + // - AWS::CloudTrail::Channel + // - AWS::S3Outposts::Object + // - AWS::ManagedBlockchain::Node + // - AWS::S3ObjectLambda::AccessPoint + // - AWS::EC2::Snapshot + // - AWS::S3::AccessPoint + // - AWS::DynamoDB::Stream + // - AWS::Glue::Table + // - AWS::FinSpace::Environment + // - AWS::SageMaker::ExperimentTrialComponent + // - AWS::SageMaker::FeatureGroup Type *string // An array of Amazon Resource Name (ARN) strings or partial ARN strings for the // specified objects. - // - // * To log data events for all objects in all S3 buckets in - // your Amazon Web Services account, specify the prefix as arn:aws:s3. This also - // enables logging of data event activity performed by any user or role in your - // Amazon Web Services account, even if that activity is performed on a bucket that - // belongs to another Amazon Web Services account. - // - // * To log data events for all - // objects in an S3 bucket, specify the bucket and an empty object prefix such as - // arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 - // bucket. - // - // * To log data events for specific objects, specify the S3 bucket and - // object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data - // events for objects in this S3 bucket that match the prefix. - // - // * To log data - // events for all Lambda functions in your Amazon Web Services account, specify the - // prefix as arn:aws:lambda. This also enables logging of Invoke activity performed - // by any user or role in your Amazon Web Services account, even if that activity - // is performed on a function that belongs to another Amazon Web Services - // account. - // - // * To log data events for a specific Lambda function, specify the - // function ARN. Lambda function ARNs are exact. For example, if you specify a - // function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data - // events will only be logged for - // arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be - // logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2. - // - // * To log - // data events for all DynamoDB tables in your Amazon Web Services account, specify - // the prefix as arn:aws:dynamodb. + // - To log data events for all objects in all S3 buckets in your Amazon Web + // Services account, specify the prefix as arn:aws:s3 . This also enables logging + // of data event activity performed by any user or role in your Amazon Web Services + // account, even if that activity is performed on a bucket that belongs to another + // Amazon Web Services account. + // - To log data events for all objects in an S3 bucket, specify the bucket and + // an empty object prefix such as arn:aws:s3:::bucket-1/ . The trail logs data + // events for all objects in this S3 bucket. + // - To log data events for specific objects, specify the S3 bucket and object + // prefix such as arn:aws:s3:::bucket-1/example-images . The trail logs data + // events for objects in this S3 bucket that match the prefix. + // - To log data events for all Lambda functions in your Amazon Web Services + // account, specify the prefix as arn:aws:lambda . This also enables logging of + // Invoke activity performed by any user or role in your Amazon Web Services + // account, even if that activity is performed on a function that belongs to + // another Amazon Web Services account. + // - To log data events for a specific Lambda function, specify the function + // ARN. Lambda function ARNs are exact. For example, if you specify a function ARN + // arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only + // be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They + // will not be logged for + // arn:aws:lambda:us-west-2:111111111111:function:helloworld2. + // - To log data events for all DynamoDB tables in your Amazon Web Services + // account, specify the prefix as arn:aws:dynamodb . Values []string noSmithyDocumentSerde @@ -417,8 +278,8 @@ type Destination struct { Location *string // The type of destination for events arriving from a channel. For channels used - // for a CloudTrail Lake integration, the value is EventDataStore. For - // service-linked channels, the value is AWS_SERVICE. + // for a CloudTrail Lake integration, the value is EventDataStore . For + // service-linked channels, the value is AWS_SERVICE . // // This member is required. Type DestinationType @@ -466,8 +327,8 @@ type Event struct { // A storage lake of event data against which you can run complex SQL-based // queries. An event data store can include events that you have logged on your // account from the last 90 to 2557 days (about three months to up to seven years). -// To select events for an event data store, use advanced event selectors -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced). +// To select events for an event data store, use advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) +// . type EventDataStore struct { // The advanced event selectors that were used to select events for the data store. @@ -483,8 +344,8 @@ type EventDataStore struct { // The ARN of the event data store. EventDataStoreArn *string - // Indicates whether the event data store includes events from all regions, or only - // from the region in which it was created. + // Indicates whether the event data store includes events from all regions, or + // only from the region in which it was created. // // Deprecated: MultiRegionEnabled is no longer returned by ListEventDataStores MultiRegionEnabled *bool @@ -503,7 +364,7 @@ type EventDataStore struct { // Deprecated: RetentionPeriod is no longer returned by ListEventDataStores RetentionPeriod *int32 - // The status of an event data store. Values are ENABLED and PENDING_DELETION. + // The status of an event data store. Values are ENABLED and PENDING_DELETION . // // Deprecated: Status is no longer returned by ListEventDataStores Status EventDataStoreStatus @@ -516,7 +377,7 @@ type EventDataStore struct { // The timestamp showing when an event data store was updated, if applicable. // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. + // CreatedTimestamp . // // Deprecated: UpdatedTimestamp is no longer returned by ListEventDataStores UpdatedTimestamp *time.Time @@ -540,35 +401,32 @@ type EventSelector struct { // resources for an individual event selector, but the total number of data // resources cannot exceed 250 across all event selectors in a trail. This limit // does not apply if you configure resource logging for all data events. For more - // information, see Data Events - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) - // and Limits in CloudTrail - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) + // information, see Data Events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) + // and Limits in CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) // in the CloudTrail User Guide. DataResources []DataResource // An optional list of service event sources from which you do not want management // events to be logged on your trail. In this release, the list can be empty // (disables the filter), or it can filter out Key Management Service or Amazon RDS - // Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By - // default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API - // events are logged to your trail. You can exclude management event sources only - // in regions that support the event source. + // Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com . By + // default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data + // API events are logged to your trail. You can exclude management event sources + // only in regions that support the event source. ExcludeManagementEventSources []string // Specify if you want your event selector to include management events for your - // trail. For more information, see Management Events - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) - // in the CloudTrail User Guide. By default, the value is true. The first copy of + // trail. For more information, see Management Events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) + // in the CloudTrail User Guide. By default, the value is true . The first copy of // management events is free. You are charged for additional copies of management // events that you are logging on any subsequent trail in the same region. For more - // information about CloudTrail pricing, see CloudTrail Pricing - // (http://aws.amazon.com/cloudtrail/pricing/). + // information about CloudTrail pricing, see CloudTrail Pricing (http://aws.amazon.com/cloudtrail/pricing/) + // . IncludeManagementEvents *bool // Specify if you want your trail to log read-only events, write-only events, or // all. For example, the EC2 GetConsoleOutput is a read-only API operation and - // RunInstances is a write-only API operation. By default, the value is All. + // RunInstances is a write-only API operation. By default, the value is All . ReadWriteType ReadWriteType noSmithyDocumentSerde @@ -627,7 +485,7 @@ type ImportSource struct { noSmithyDocumentSerde } -// Provides statistics for the specified ImportID. CloudTrail does not update +// Provides statistics for the specified ImportID . CloudTrail does not update // import statistics in real-time. Returned values for parameters such as // EventsCompleted may be lower than the actual value, because CloudTrail updates // statistics incrementally over the course of the import. @@ -651,8 +509,8 @@ type ImportStatistics struct { noSmithyDocumentSerde } -// A table showing information about the most recent successful and failed attempts -// to ingest events. +// A table showing information about the most recent successful and failed +// attempts to ingest events. type IngestionStatus struct { // The event ID of the most recent attempt to ingest events. @@ -728,8 +586,8 @@ type Query struct { // The ID of a query. QueryId *string - // The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, - // TIMED_OUT, or CANCELLED. + // The status of the query. This can be QUEUED , RUNNING , FINISHED , FAILED , + // TIMED_OUT , or CANCELLED . QueryStatus QueryStatus noSmithyDocumentSerde @@ -790,8 +648,8 @@ type Resource struct { // cannot be determined, null is returned. Some examples of resource types are: // Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey // for IAM. To learn more about how to look up and filter events by the resource - // types supported for a service, see Filtering CloudTrail Events - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events). + // types supported for a service, see Filtering CloudTrail Events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events) + // . ResourceType *string noSmithyDocumentSerde @@ -862,8 +720,8 @@ type Tag struct { // The settings for a trail. type Trail struct { - // Specifies an Amazon Resource Name (ARN), a unique identifier that represents the - // log group to which CloudTrail logs will be delivered. + // Specifies an Amazon Resource Name (ARN), a unique identifier that represents + // the log group to which CloudTrail logs will be delivered. CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a @@ -898,20 +756,19 @@ type Trail struct { // Specifies whether log file validation is enabled. LogFileValidationEnabled *bool - // Name of the trail set by calling CreateTrail. The maximum length is 128 + // Name of the trail set by calling CreateTrail . The maximum length is 128 // characters. Name *string // Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. - // See Amazon S3 Bucket Naming Requirements - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). + // See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html) + // . S3BucketName *string // Specifies the Amazon S3 key prefix that comes after the name of the bucket you // have designated for log file delivery. For more information, see Finding Your - // CloudTrail Log Files - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). - // The maximum length is 200 characters. + // CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) + // . The maximum length is 200 characters. S3KeyPrefix *string // Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send diff --git a/service/cloudtraildata/api_client.go b/service/cloudtraildata/api_client.go index 3a8b1553007..b8c1e1ccc30 100644 --- a/service/cloudtraildata/api_client.go +++ b/service/cloudtraildata/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudtraildata/api_op_PutAuditEvents.go b/service/cloudtraildata/api_op_PutAuditEvents.go index b3c678b2852..1b1629a9b82 100644 --- a/service/cloudtraildata/api_op_PutAuditEvents.go +++ b/service/cloudtraildata/api_op_PutAuditEvents.go @@ -12,7 +12,7 @@ import ( ) // Ingests your application events into CloudTrail Lake. A required parameter, -// auditEvents, accepts the JSON records (also called payload) of events that you +// auditEvents , accepts the JSON records (also called payload) of events that you // want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) // per PutAuditEvents request. func (c *Client) PutAuditEvents(ctx context.Context, params *PutAuditEventsInput, optFns ...func(*Options)) (*PutAuditEventsOutput, error) { diff --git a/service/cloudtraildata/types/types.go b/service/cloudtraildata/types/types.go index b8c6bce7aa7..0ce3ffafcd0 100644 --- a/service/cloudtraildata/types/types.go +++ b/service/cloudtraildata/types/types.go @@ -10,8 +10,8 @@ import ( // to log. type AuditEvent struct { - // The content of an audit event that comes from the event, such as userIdentity, - // userAgent, and eventSource. + // The content of an audit event that comes from the event, such as userIdentity , + // userAgent , and eventSource . // // This member is required. EventData *string @@ -51,9 +51,9 @@ type AuditEventResultEntry struct { type ResultErrorEntry struct { // The error code for events that could not be ingested by CloudTrail. Possible - // error codes include: FieldTooLong, FieldNotFound, InvalidChecksum, InvalidData, - // InvalidRecipient, InvalidEventSource, AccountNotSubscribed, Throttling, and - // InternalFailure. + // error codes include: FieldTooLong , FieldNotFound , InvalidChecksum , + // InvalidData , InvalidRecipient , InvalidEventSource , AccountNotSubscribed , + // Throttling , and InternalFailure . // // This member is required. ErrorCode *string diff --git a/service/cloudwatch/api_client.go b/service/cloudwatch/api_client.go index 30c5e274c50..39dfb85b282 100644 --- a/service/cloudwatch/api_client.go +++ b/service/cloudwatch/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudwatch/api_op_DeleteAlarms.go b/service/cloudwatch/api_op_DeleteAlarms.go index 467366cb04c..b8e991a9e66 100644 --- a/service/cloudwatch/api_op_DeleteAlarms.go +++ b/service/cloudwatch/api_op_DeleteAlarms.go @@ -16,9 +16,8 @@ import ( // but you can't delete two composite alarms with one operation. If you specify an // incorrect alarm name or make any other error in the operation, no alarms are // deleted. To confirm that alarms were deleted successfully, you can use the -// DescribeAlarms -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) -// operation after using DeleteAlarms. It is possible to create a loop or cycle of +// DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) +// operation after using DeleteAlarms . It is possible to create a loop or cycle of // composite alarms, where composite alarm A depends on composite alarm B, and // composite alarm B also depends on composite alarm A. In this scenario, you can't // delete any composite alarm that is part of the cycle because there is always @@ -26,7 +25,7 @@ import ( // get out of such a situation, you must break the cycle by changing the rule of // one of the composite alarms in the cycle to remove a dependency that creates the // cycle. The simplest change to make to break a cycle is to change the AlarmRule -// of one of the alarms to false. Additionally, the evaluation of composite alarms +// of one of the alarms to false . Additionally, the evaluation of composite alarms // stops if CloudWatch detects a cycle in the evaluation path. func (c *Client) DeleteAlarms(ctx context.Context, params *DeleteAlarmsInput, optFns ...func(*Options)) (*DeleteAlarmsOutput, error) { if params == nil { diff --git a/service/cloudwatch/api_op_DeleteAnomalyDetector.go b/service/cloudwatch/api_op_DeleteAnomalyDetector.go index 746acb422e7..bebb003ad5f 100644 --- a/service/cloudwatch/api_op_DeleteAnomalyDetector.go +++ b/service/cloudwatch/api_op_DeleteAnomalyDetector.go @@ -13,8 +13,7 @@ import ( // Deletes the specified anomaly detection model from your account. For more // information about how to delete an anomaly detection model, see Deleting an -// anomaly detection model -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model) +// anomaly detection model (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model) // in the CloudWatch User Guide. func (c *Client) DeleteAnomalyDetector(ctx context.Context, params *DeleteAnomalyDetectorInput, optFns ...func(*Options)) (*DeleteAnomalyDetectorOutput, error) { if params == nil { @@ -39,22 +38,14 @@ type DeleteAnomalyDetectorInput struct { Dimensions []types.Dimension // The metric math anomaly detector to be deleted. When using - // MetricMathAnomalyDetector, you cannot include following parameters in the same + // MetricMathAnomalyDetector , you cannot include following parameters in the same // operation: - // - // * Dimensions, - // - // * MetricName - // - // * Namespace - // - // * Stat - // - // * the - // SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput - // - // Instead, - // specify the metric math anomaly detector attributes as part of the + // - Dimensions , + // - MetricName + // - Namespace + // - Stat + // - the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput + // Instead, specify the metric math anomaly detector attributes as part of the // MetricMathAnomalyDetector property. MetricMathAnomalyDetector *types.MetricMathAnomalyDetector @@ -69,22 +60,14 @@ type DeleteAnomalyDetectorInput struct { Namespace *string // A single metric anomaly detector to be deleted. When using - // SingleMetricAnomalyDetector, you cannot include the following parameters in the + // SingleMetricAnomalyDetector , you cannot include the following parameters in the // same operation: - // - // * Dimensions, - // - // * MetricName - // - // * Namespace - // - // * Stat - // - // * the - // MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput - // - // Instead, - // specify the single metric anomaly detector attributes as part of the + // - Dimensions , + // - MetricName + // - Namespace + // - Stat + // - the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput + // Instead, specify the single metric anomaly detector attributes as part of the // SingleMetricAnomalyDetector property. SingleMetricAnomalyDetector *types.SingleMetricAnomalyDetector diff --git a/service/cloudwatch/api_op_DeleteDashboards.go b/service/cloudwatch/api_op_DeleteDashboards.go index 66f9aef902c..10163cc9008 100644 --- a/service/cloudwatch/api_op_DeleteDashboards.go +++ b/service/cloudwatch/api_op_DeleteDashboards.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes all dashboards that you specify. You can specify up to 100 dashboards to -// delete. If there is an error during this call, no dashboards are deleted. +// Deletes all dashboards that you specify. You can specify up to 100 dashboards +// to delete. If there is an error during this call, no dashboards are deleted. func (c *Client) DeleteDashboards(ctx context.Context, params *DeleteDashboardsInput, optFns ...func(*Options)) (*DeleteDashboardsOutput, error) { if params == nil { params = &DeleteDashboardsInput{} diff --git a/service/cloudwatch/api_op_DeleteInsightRules.go b/service/cloudwatch/api_op_DeleteInsightRules.go index 30d9d9b2c65..b5b523aad5b 100644 --- a/service/cloudwatch/api_op_DeleteInsightRules.go +++ b/service/cloudwatch/api_op_DeleteInsightRules.go @@ -32,8 +32,8 @@ func (c *Client) DeleteInsightRules(ctx context.Context, params *DeleteInsightRu type DeleteInsightRulesInput struct { // An array of the rule names to delete. If you need to find out the names of your - // rules, use DescribeInsightRules - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html). + // rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html) + // . // // This member is required. RuleNames []string @@ -43,8 +43,8 @@ type DeleteInsightRulesInput struct { type DeleteInsightRulesOutput struct { - // An array listing the rules that could not be deleted. You cannot delete built-in - // rules. + // An array listing the rules that could not be deleted. You cannot delete + // built-in rules. Failures []types.PartialFailure // Metadata pertaining to the operation's result. diff --git a/service/cloudwatch/api_op_DescribeAlarmHistory.go b/service/cloudwatch/api_op_DescribeAlarmHistory.go index d09f188de63..1bbc4a58855 100644 --- a/service/cloudwatch/api_op_DescribeAlarmHistory.go +++ b/service/cloudwatch/api_op_DescribeAlarmHistory.go @@ -18,7 +18,7 @@ import ( // either all metric alarms or all composite alarms are returned. CloudWatch // retains the history of an alarm even if you delete the alarm. To use this // operation and return information about a composite alarm, you must be signed on -// with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You +// with the cloudwatch:DescribeAlarmHistory permission that is scoped to * . You // can't return information about composite alarms if your // cloudwatch:DescribeAlarmHistory permission has a narrower scope. func (c *Client) DescribeAlarmHistory(ctx context.Context, params *DescribeAlarmHistoryInput, optFns ...func(*Options)) (*DescribeAlarmHistoryOutput, error) { diff --git a/service/cloudwatch/api_op_DescribeAlarms.go b/service/cloudwatch/api_op_DescribeAlarms.go index 73026f301de..e6a7233d1c9 100644 --- a/service/cloudwatch/api_op_DescribeAlarms.go +++ b/service/cloudwatch/api_op_DescribeAlarms.go @@ -20,7 +20,7 @@ import ( // Retrieves the specified alarms. You can filter the results by specifying a // prefix for the alarm name, the alarm state, or a prefix for any action. To use // this operation and return information about composite alarms, you must be signed -// on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't +// on with the cloudwatch:DescribeAlarms permission that is scoped to * . You can't // return information about composite alarms if your cloudwatch:DescribeAlarms // permission has a narrower scope. func (c *Client) DescribeAlarms(ctx context.Context, params *DescribeAlarmsInput, optFns ...func(*Options)) (*DescribeAlarmsOutput, error) { @@ -47,7 +47,7 @@ type DescribeAlarmsInput struct { // An alarm name prefix. If you specify this parameter, you receive information // about all alarms that have names that start with this prefix. If this parameter - // is specified, you cannot specify AlarmNames. + // is specified, you cannot specify AlarmNames . AlarmNamePrefix *string // The names of the alarms to retrieve information about. @@ -61,15 +61,15 @@ type DescribeAlarmsInput struct { // If you use this parameter and specify the name of a composite alarm, the // operation returns information about the "children" alarms of the alarm you // specify. These are the metric alarms and composite alarms referenced in the - // AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. + // AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName . // Information about the composite alarm that you name in ChildrenOfAlarmName is - // not returned. If you specify ChildrenOfAlarmName, you cannot specify any other - // parameters in the request except for MaxRecords and NextToken. If you do so, you - // receive a validation error. Only the Alarm Name, ARN, StateValue - // (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned - // by this operation when you use this parameter. To get complete information about - // these alarms, perform another DescribeAlarms operation and specify the parent - // alarm names in the AlarmNames parameter. + // not returned. If you specify ChildrenOfAlarmName , you cannot specify any other + // parameters in the request except for MaxRecords and NextToken . If you do so, + // you receive a validation error. Only the Alarm Name , ARN , StateValue + // (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are + // returned by this operation when you use this parameter. To get complete + // information about these alarms, perform another DescribeAlarms operation and + // specify the parent alarm names in the AlarmNames parameter. ChildrenOfAlarmName *string // The maximum number of alarm descriptions to retrieve. @@ -82,10 +82,10 @@ type DescribeAlarmsInput struct { // If you use this parameter and specify the name of a metric or composite alarm, // the operation returns information about the "parent" alarms of the alarm you // specify. These are the composite alarms that have AlarmRule parameters that - // reference the alarm named in ParentsOfAlarmName. Information about the alarm + // reference the alarm named in ParentsOfAlarmName . Information about the alarm // that you specify in ParentsOfAlarmName is not returned. If you specify - // ParentsOfAlarmName, you cannot specify any other parameters in the request - // except for MaxRecords and NextToken. If you do so, you receive a validation + // ParentsOfAlarmName , you cannot specify any other parameters in the request + // except for MaxRecords and NextToken . If you do so, you receive a validation // error. Only the Alarm Name and ARN are returned by this operation when you use // this parameter. To get complete information about these alarms, perform another // DescribeAlarms operation and specify the parent alarm names in the AlarmNames @@ -279,9 +279,9 @@ type AlarmExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AlarmExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AlarmExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -443,9 +443,10 @@ type CompositeAlarmExistsWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CompositeAlarmExistsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CompositeAlarmExistsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go index da89456db4a..52ef7e7864e 100644 --- a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go +++ b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go @@ -53,8 +53,8 @@ type DescribeAlarmsForMetricInput struct { // The period, in seconds, over which the statistic is applied. Period *int32 - // The statistic for the metric, other than percentiles. For percentile statistics, - // use ExtendedStatistics. + // The statistic for the metric, other than percentiles. For percentile + // statistics, use ExtendedStatistics . Statistic types.Statistic // The unit for the metric. diff --git a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go index 47dcd1519bb..f38171d4276 100644 --- a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go +++ b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go @@ -35,27 +35,28 @@ func (c *Client) DescribeAnomalyDetectors(ctx context.Context, params *DescribeA type DescribeAnomalyDetectorsInput struct { - // The anomaly detector types to request when using DescribeAnomalyDetectorsInput. - // If empty, defaults to SINGLE_METRIC. + // The anomaly detector types to request when using DescribeAnomalyDetectorsInput . + // If empty, defaults to SINGLE_METRIC . AnomalyDetectorTypes []types.AnomalyDetectorType - // Limits the results to only the anomaly detection models that are associated with - // the specified metric dimensions. If there are multiple metrics that have these - // dimensions and have anomaly detection models associated, they're all returned. + // Limits the results to only the anomaly detection models that are associated + // with the specified metric dimensions. If there are multiple metrics that have + // these dimensions and have anomaly detection models associated, they're all + // returned. Dimensions []types.Dimension - // The maximum number of results to return in one operation. The maximum value that - // you can specify is 100. To retrieve the remaining results, make another call - // with the returned NextToken value. + // The maximum number of results to return in one operation. The maximum value + // that you can specify is 100. To retrieve the remaining results, make another + // call with the returned NextToken value. MaxResults *int32 - // Limits the results to only the anomaly detection models that are associated with - // the specified metric name. If there are multiple metrics with this name in + // Limits the results to only the anomaly detection models that are associated + // with the specified metric name. If there are multiple metrics with this name in // different namespaces that have anomaly detection models, they're all returned. MetricName *string - // Limits the results to only the anomaly detection models that are associated with - // the specified namespace. + // Limits the results to only the anomaly detection models that are associated + // with the specified namespace. Namespace *string // Use the token returned by the previous operation to request the next page of @@ -154,9 +155,9 @@ var _ DescribeAnomalyDetectorsAPIClient = (*Client)(nil) // DescribeAnomalyDetectorsPaginatorOptions is the paginator options for // DescribeAnomalyDetectors type DescribeAnomalyDetectorsPaginatorOptions struct { - // The maximum number of results to return in one operation. The maximum value that - // you can specify is 100. To retrieve the remaining results, make another call - // with the returned NextToken value. + // The maximum number of results to return in one operation. The maximum value + // that you can specify is 100. To retrieve the remaining results, make another + // call with the returned NextToken value. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudwatch/api_op_DescribeInsightRules.go b/service/cloudwatch/api_op_DescribeInsightRules.go index 7536d0eb0a5..987bc91b32b 100644 --- a/service/cloudwatch/api_op_DescribeInsightRules.go +++ b/service/cloudwatch/api_op_DescribeInsightRules.go @@ -14,8 +14,8 @@ import ( // Returns a list of all the Contributor Insights rules in your account. For more // information about Contributor Insights, see Using Contributor Insights to -// Analyze High-Cardinality Data -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html). +// Analyze High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) +// . func (c *Client) DescribeInsightRules(ctx context.Context, params *DescribeInsightRulesInput, optFns ...func(*Options)) (*DescribeInsightRulesOutput, error) { if params == nil { params = &DescribeInsightRulesInput{} diff --git a/service/cloudwatch/api_op_DisableInsightRules.go b/service/cloudwatch/api_op_DisableInsightRules.go index d8752a59a82..e87272eab60 100644 --- a/service/cloudwatch/api_op_DisableInsightRules.go +++ b/service/cloudwatch/api_op_DisableInsightRules.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables the specified Contributor Insights rules. When rules are disabled, they -// do not analyze log groups and do not incur costs. +// Disables the specified Contributor Insights rules. When rules are disabled, +// they do not analyze log groups and do not incur costs. func (c *Client) DisableInsightRules(ctx context.Context, params *DisableInsightRulesInput, optFns ...func(*Options)) (*DisableInsightRulesOutput, error) { if params == nil { params = &DisableInsightRulesInput{} @@ -30,9 +30,9 @@ func (c *Client) DisableInsightRules(ctx context.Context, params *DisableInsight type DisableInsightRulesInput struct { - // An array of the rule names to disable. If you need to find out the names of your - // rules, use DescribeInsightRules - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html). + // An array of the rule names to disable. If you need to find out the names of + // your rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html) + // . // // This member is required. RuleNames []string diff --git a/service/cloudwatch/api_op_EnableInsightRules.go b/service/cloudwatch/api_op_EnableInsightRules.go index 548a13356b1..4e8f3316021 100644 --- a/service/cloudwatch/api_op_EnableInsightRules.go +++ b/service/cloudwatch/api_op_EnableInsightRules.go @@ -31,8 +31,8 @@ func (c *Client) EnableInsightRules(ctx context.Context, params *EnableInsightRu type EnableInsightRulesInput struct { // An array of the rule names to enable. If you need to find out the names of your - // rules, use DescribeInsightRules - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html). + // rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html) + // . // // This member is required. RuleNames []string diff --git a/service/cloudwatch/api_op_GetDashboard.go b/service/cloudwatch/api_op_GetDashboard.go index 23cefcfd183..b8be376e75c 100644 --- a/service/cloudwatch/api_op_GetDashboard.go +++ b/service/cloudwatch/api_op_GetDashboard.go @@ -11,9 +11,9 @@ import ( ) // Displays the details of the dashboard that you specify. To copy an existing -// dashboard, use GetDashboard, and then use the data returned within DashboardBody -// as the template for the new dashboard when you call PutDashboard to create the -// copy. +// dashboard, use GetDashboard , and then use the data returned within +// DashboardBody as the template for the new dashboard when you call PutDashboard +// to create the copy. func (c *Client) GetDashboard(ctx context.Context, params *GetDashboardInput, optFns ...func(*Options)) (*GetDashboardOutput, error) { if params == nil { params = &GetDashboardInput{} @@ -46,8 +46,8 @@ type GetDashboardOutput struct { // The detailed information about the dashboard, including what widgets are // included and their location on the dashboard. For more information about the - // DashboardBody syntax, see Dashboard Body Structure and Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html). + // DashboardBody syntax, see Dashboard Body Structure and Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) + // . DashboardBody *string // The name of the dashboard. diff --git a/service/cloudwatch/api_op_GetInsightRuleReport.go b/service/cloudwatch/api_op_GetInsightRuleReport.go index 96da074a3cf..a909934e1c8 100644 --- a/service/cloudwatch/api_op_GetInsightRuleReport.go +++ b/service/cloudwatch/api_op_GetInsightRuleReport.go @@ -16,34 +16,22 @@ import ( // rule. The data includes the identity and number of contributors to the log // group. You can also optionally return one or more statistics about each data // point in the time series. These statistics can include the following: -// -// * -// UniqueContributors -- the number of unique contributors for each data point. -// -// * -// MaxContributorValue -- the value of the top contributor for each data point. The -// identity of the contributor might change for each data point in the graph. If -// this rule aggregates by COUNT, the top contributor for each data point is the -// contributor with the most occurrences in that period. If the rule aggregates by -// SUM, the top contributor is the contributor with the highest sum in the log -// field specified by the rule's Value, during that period. -// -// * SampleCount -- the -// number of data points matched by the rule. -// -// * Sum -- the sum of the values from -// all contributors during the time period represented by that data point. -// -// * -// Minimum -- the minimum value from a single observation during the time period -// represented by that data point. -// -// * Maximum -- the maximum value from a single -// observation during the time period represented by that data point. -// -// * Average -- -// the average value from all contributors during the time period represented by -// that data point. +// - UniqueContributors -- the number of unique contributors for each data point. +// - MaxContributorValue -- the value of the top contributor for each data point. +// The identity of the contributor might change for each data point in the graph. +// If this rule aggregates by COUNT, the top contributor for each data point is the +// contributor with the most occurrences in that period. If the rule aggregates by +// SUM, the top contributor is the contributor with the highest sum in the log +// field specified by the rule's Value , during that period. +// - SampleCount -- the number of data points matched by the rule. +// - Sum -- the sum of the values from all contributors during the time period +// represented by that data point. +// - Minimum -- the minimum value from a single observation during the time +// period represented by that data point. +// - Maximum -- the maximum value from a single observation during the time +// period represented by that data point. +// - Average -- the average value from all contributors during the time period +// represented by that data point. func (c *Client) GetInsightRuleReport(ctx context.Context, params *GetInsightRuleReportInput, optFns ...func(*Options)) (*GetInsightRuleReportOutput, error) { if params == nil { params = &GetInsightRuleReportInput{} @@ -62,7 +50,8 @@ func (c *Client) GetInsightRuleReport(ctx context.Context, params *GetInsightRul type GetInsightRuleReportInput struct { // The end time of the data to use in the report. When used in a raw HTTP Query - // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 + // . // // This member is required. EndTime *time.Time @@ -79,7 +68,8 @@ type GetInsightRuleReportInput struct { RuleName *string // The start time of the data to use in the report. When used in a raw HTTP Query - // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59. + // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 + // . // // This member is required. StartTime *time.Time @@ -90,34 +80,22 @@ type GetInsightRuleReportInput struct { // Specifies which metrics to use for aggregation of contributor values for the // report. You can specify one or more of the following metrics: - // - // * - // UniqueContributors -- the number of unique contributors for each data point. - // - // * - // MaxContributorValue -- the value of the top contributor for each data point. The - // identity of the contributor might change for each data point in the graph. If - // this rule aggregates by COUNT, the top contributor for each data point is the - // contributor with the most occurrences in that period. If the rule aggregates by - // SUM, the top contributor is the contributor with the highest sum in the log - // field specified by the rule's Value, during that period. - // - // * SampleCount -- the - // number of data points matched by the rule. - // - // * Sum -- the sum of the values from - // all contributors during the time period represented by that data point. - // - // * - // Minimum -- the minimum value from a single observation during the time period - // represented by that data point. - // - // * Maximum -- the maximum value from a single - // observation during the time period represented by that data point. - // - // * Average -- - // the average value from all contributors during the time period represented by - // that data point. + // - UniqueContributors -- the number of unique contributors for each data point. + // - MaxContributorValue -- the value of the top contributor for each data point. + // The identity of the contributor might change for each data point in the graph. + // If this rule aggregates by COUNT, the top contributor for each data point is the + // contributor with the most occurrences in that period. If the rule aggregates by + // SUM, the top contributor is the contributor with the highest sum in the log + // field specified by the rule's Value , during that period. + // - SampleCount -- the number of data points matched by the rule. + // - Sum -- the sum of the values from all contributors during the time period + // represented by that data point. + // - Minimum -- the minimum value from a single observation during the time + // period represented by that data point. + // - Maximum -- the maximum value from a single observation during the time + // period represented by that data point. + // - Average -- the average value from all contributors during the time period + // represented by that data point. Metrics []string // Determines what statistic to use to rank the contributors. Valid values are SUM diff --git a/service/cloudwatch/api_op_GetMetricData.go b/service/cloudwatch/api_op_GetMetricData.go index 600528cddb6..bd6652ba1af 100644 --- a/service/cloudwatch/api_op_GetMetricData.go +++ b/service/cloudwatch/api_op_GetMetricData.go @@ -21,55 +21,47 @@ import ( // expressions on the values of the returned statistics, to create new time series // that represent new insights into your data. For example, using Lambda metrics, // you could divide the Errors metric by the Invocations metric to get an error -// rate time series. For more information about metric math expressions, see Metric -// Math Syntax and Functions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) +// rate time series. For more information about metric math expressions, see +// Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) // in the Amazon CloudWatch User Guide. If you include a Metrics Insights query, // each GetMetricData operation can include only one query. But the same // GetMetricData operation can also retrieve other metrics. Metrics Insights // queries can query only the most recent three hours of metric data. For more // information about Metrics Insights, see Query your metrics with CloudWatch -// Metrics Insights -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html). -// Calls to the GetMetricData API have a different pricing structure than calls to -// GetMetricStatistics. For more information about pricing, see Amazon CloudWatch -// Pricing (https://aws.amazon.com/cloudwatch/pricing/). Amazon CloudWatch retains -// metric data as follows: +// Metrics Insights (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html) +// . Calls to the GetMetricData API have a different pricing structure than calls +// to GetMetricStatistics . For more information about pricing, see Amazon +// CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/) . Amazon +// CloudWatch retains metric data as follows: +// - Data points with a period of less than 60 seconds are available for 3 +// hours. These data points are high-resolution metrics and are available only for +// custom metrics that have been defined with a StorageResolution of 1. +// - Data points with a period of 60 seconds (1-minute) are available for 15 +// days. +// - Data points with a period of 300 seconds (5-minute) are available for 63 +// days. +// - Data points with a period of 3600 seconds (1 hour) are available for 455 +// days (15 months). // -// * Data points with a period of less than 60 seconds are -// available for 3 hours. These data points are high-resolution metrics and are -// available only for custom metrics that have been defined with a -// StorageResolution of 1. -// -// * Data points with a period of 60 seconds (1-minute) -// are available for 15 days. -// -// * Data points with a period of 300 seconds -// (5-minute) are available for 63 days. -// -// * Data points with a period of 3600 -// seconds (1 hour) are available for 455 days (15 months). -// -// Data points that are -// initially published with a shorter period are aggregated together for long-term -// storage. For example, if you collect data using a period of 1 minute, the data -// remains available for 15 days with 1-minute resolution. After 15 days, this data -// is still available, but is aggregated and retrievable only with a resolution of -// 5 minutes. After 63 days, the data is further aggregated and is available with a -// resolution of 1 hour. If you omit Unit in your request, all data that was -// collected with any unit is returned, along with the corresponding units that -// were specified when the data was reported to CloudWatch. If you specify a unit, -// the operation returns only data that was collected with that unit specified. If -// you specify a unit that does not match the data collected, the results of the -// operation are null. CloudWatch does not perform unit conversions. Using Metrics -// Insights queries with metric math You can't mix a Metric Insights query and -// metric math syntax in the same expression, but you can reference results from a -// Metrics Insights query within other Metric math expressions. A Metrics Insights -// query without a GROUP BY clause returns a single time-series (TS), and can be -// used as input for a metric math expression that expects a single time series. A -// Metrics Insights query with a GROUP BY clause returns an array of time-series -// (TS[]), and can be used as input for a metric math expression that expects an -// array of time series. +// Data points that are initially published with a shorter period are aggregated +// together for long-term storage. For example, if you collect data using a period +// of 1 minute, the data remains available for 15 days with 1-minute resolution. +// After 15 days, this data is still available, but is aggregated and retrievable +// only with a resolution of 5 minutes. After 63 days, the data is further +// aggregated and is available with a resolution of 1 hour. If you omit Unit in +// your request, all data that was collected with any unit is returned, along with +// the corresponding units that were specified when the data was reported to +// CloudWatch. If you specify a unit, the operation returns only data that was +// collected with that unit specified. If you specify a unit that does not match +// the data collected, the results of the operation are null. CloudWatch does not +// perform unit conversions. Using Metrics Insights queries with metric math You +// can't mix a Metric Insights query and metric math syntax in the same expression, +// but you can reference results from a Metrics Insights query within other Metric +// math expressions. A Metrics Insights query without a GROUP BY clause returns a +// single time-series (TS), and can be used as input for a metric math expression +// that expects a single time series. A Metrics Insights query with a GROUP BY +// clause returns an array of time-series (TS[]), and can be used as input for a +// metric math expression that expects an array of time series. func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error) { if params == nil { params = &GetMetricDataInput{} @@ -87,13 +79,13 @@ func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, type GetMetricDataInput struct { - // The time stamp indicating the latest data to be returned. The value specified is - // exclusive; results include data points up to the specified time stamp. For + // The time stamp indicating the latest data to be returned. The value specified + // is exclusive; results include data points up to the specified time stamp. For // better performance, specify StartTime and EndTime values that align with the // value of the metric's Period and sync up with the beginning and end of an hour. // For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 - // as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 - // as the EndTime. + // as EndTime can get a faster response from CloudWatch than setting 12:07 or + // 12:29 as the EndTime . // // This member is required. EndTime *time.Time @@ -109,30 +101,23 @@ type GetMetricDataInput struct { // The time stamp indicating the earliest data to be returned. The value specified // is inclusive; results include data points with the specified time stamp. // CloudWatch rounds the specified time stamp as follows: - // - // * Start time less than - // 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is - // rounded down to 12:32:00. - // - // * Start time between 15 and 63 days ago - Round down - // to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to - // 12:30:00. - // - // * Start time greater than 63 days ago - Round down to the nearest - // 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00. - // - // If - // you set Period to 5, 10, or 30, the start time of your request is rounded down - // to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of - // a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the - // previous 10-second period, the start time of your request is rounded down and - // you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for - // the previous 5 minutes of data, using a period of 5 seconds, you receive data - // timestamped between 15:02:15 and 15:07:15. For better performance, specify - // StartTime and EndTime values that align with the value of the metric's Period - // and sync up with the beginning and end of an hour. For example, if the Period of - // a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster - // response from CloudWatch than setting 12:07 or 12:29 as the StartTime. + // - Start time less than 15 days ago - Round down to the nearest whole minute. + // For example, 12:32:34 is rounded down to 12:32:00. + // - Start time between 15 and 63 days ago - Round down to the nearest 5-minute + // clock interval. For example, 12:32:34 is rounded down to 12:30:00. + // - Start time greater than 63 days ago - Round down to the nearest 1-hour + // clock interval. For example, 12:32:34 is rounded down to 12:00:00. + // If you set Period to 5, 10, or 30, the start time of your request is rounded + // down to the nearest time that corresponds to even 5-, 10-, or 30-second + // divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 + // for the previous 10-second period, the start time of your request is rounded + // down and you receive data from 01:05:10 to 01:05:20. If you make a query at + // 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you + // receive data timestamped between 15:02:15 and 15:07:15. For better performance, + // specify StartTime and EndTime values that align with the value of the metric's + // Period and sync up with the beginning and end of an hour. For example, if the + // Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get + // a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime . // // This member is required. StartTime *time.Time @@ -163,11 +148,11 @@ type GetMetricDataOutput struct { // Contains a message about this GetMetricData operation, if the operation results // in such a message. An example of a message that might be returned is Maximum - // number of allowed metrics exceeded. If there is a message, as much of the + // number of allowed metrics exceeded . If there is a message, as much of the // operation as possible is still executed. A message appears here only if it is // related to the global GetMetricData operation. Any message about a specific - // metric returned by the operation appears in the MetricDataResult object returned - // for that metric. + // metric returned by the operation appears in the MetricDataResult object + // returned for that metric. Messages []types.MessageData // The metrics that are returned, including the metric name, namespace, and diff --git a/service/cloudwatch/api_op_GetMetricStatistics.go b/service/cloudwatch/api_op_GetMetricStatistics.go index 107f1e3ff80..26e7929f1fe 100644 --- a/service/cloudwatch/api_op_GetMetricStatistics.go +++ b/service/cloudwatch/api_op_GetMetricStatistics.go @@ -25,42 +25,30 @@ import ( // CloudWatch needs raw data points to calculate percentile statistics. If you // publish data using a statistic set instead, you can only retrieve percentile // statistics for this data if one of the following conditions is true: +// - The SampleCount value of the statistic set is 1. +// - The Min and the Max values of the statistic set are equal. // -// * The -// SampleCount value of the statistic set is 1. +// Percentile statistics are not available for metrics when any of the metric +// values are negative numbers. Amazon CloudWatch retains metric data as follows: +// - Data points with a period of less than 60 seconds are available for 3 +// hours. These data points are high-resolution metrics and are available only for +// custom metrics that have been defined with a StorageResolution of 1. +// - Data points with a period of 60 seconds (1-minute) are available for 15 +// days. +// - Data points with a period of 300 seconds (5-minute) are available for 63 +// days. +// - Data points with a period of 3600 seconds (1 hour) are available for 455 +// days (15 months). // -// * The Min and the Max values of -// the statistic set are equal. -// -// Percentile statistics are not available for -// metrics when any of the metric values are negative numbers. Amazon CloudWatch -// retains metric data as follows: -// -// * Data points with a period of less than 60 -// seconds are available for 3 hours. These data points are high-resolution metrics -// and are available only for custom metrics that have been defined with a -// StorageResolution of 1. -// -// * Data points with a period of 60 seconds (1-minute) -// are available for 15 days. -// -// * Data points with a period of 300 seconds -// (5-minute) are available for 63 days. -// -// * Data points with a period of 3600 -// seconds (1 hour) are available for 455 days (15 months). -// -// Data points that are -// initially published with a shorter period are aggregated together for long-term -// storage. For example, if you collect data using a period of 1 minute, the data -// remains available for 15 days with 1-minute resolution. After 15 days, this data -// is still available, but is aggregated and retrievable only with a resolution of -// 5 minutes. After 63 days, the data is further aggregated and is available with a -// resolution of 1 hour. CloudWatch started retaining 5-minute and 1-hour metric -// data as of July 9, 2016. For information about metrics and dimensions supported -// by Amazon Web Services services, see the Amazon CloudWatch Metrics and -// Dimensions Reference -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html) +// Data points that are initially published with a shorter period are aggregated +// together for long-term storage. For example, if you collect data using a period +// of 1 minute, the data remains available for 15 days with 1-minute resolution. +// After 15 days, this data is still available, but is aggregated and retrievable +// only with a resolution of 5 minutes. After 63 days, the data is further +// aggregated and is available with a resolution of 1 hour. CloudWatch started +// retaining 5-minute and 1-hour metric data as of July 9, 2016. For information +// about metrics and dimensions supported by Amazon Web Services services, see the +// Amazon CloudWatch Metrics and Dimensions Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html) // in the Amazon CloudWatch User Guide. func (c *Client) GetMetricStatistics(ctx context.Context, params *GetMetricStatisticsInput, optFns ...func(*Options)) (*GetMetricStatisticsOutput, error) { if params == nil { @@ -105,16 +93,12 @@ type GetMetricStatisticsInput struct { // that includes a StorageResolution of 1 second. If the StartTime parameter // specifies a time stamp that is greater than 3 hours ago, you must specify the // period as follows or no data points in that time range is returned: - // - // * Start - // time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 - // minute). - // - // * Start time between 15 and 63 days ago - Use a multiple of 300 - // seconds (5 minutes). - // - // * Start time greater than 63 days ago - Use a multiple of - // 3600 seconds (1 hour). + // - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + // (1 minute). + // - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + // minutes). + // - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + // hour). // // This member is required. Period *int32 @@ -125,25 +109,19 @@ type GetMetricStatisticsInput struct { // stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for // example, 2016-10-03T23:00:00Z). CloudWatch rounds the specified time stamp as // follows: - // - // * Start time less than 15 days ago - Round down to the nearest whole - // minute. For example, 12:32:34 is rounded down to 12:32:00. - // - // * Start time between - // 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For - // example, 12:32:34 is rounded down to 12:30:00. - // - // * Start time greater than 63 - // days ago - Round down to the nearest 1-hour clock interval. For example, - // 12:32:34 is rounded down to 12:00:00. - // - // If you set Period to 5, 10, or 30, the - // start time of your request is rounded down to the nearest time that corresponds - // to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a - // query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time - // of your request is rounded down and you receive data from 01:05:10 to 01:05:20. - // If you make a query at 15:07:17 for the previous 5 minutes of data, using a - // period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15. + // - Start time less than 15 days ago - Round down to the nearest whole minute. + // For example, 12:32:34 is rounded down to 12:32:00. + // - Start time between 15 and 63 days ago - Round down to the nearest 5-minute + // clock interval. For example, 12:32:34 is rounded down to 12:30:00. + // - Start time greater than 63 days ago - Round down to the nearest 1-hour + // clock interval. For example, 12:32:34 is rounded down to 12:00:00. + // If you set Period to 5, 10, or 30, the start time of your request is rounded + // down to the nearest time that corresponds to even 5-, 10-, or 30-second + // divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 + // for the previous 10-second period, the start time of your request is rounded + // down and you receive data from 01:05:10 to 01:05:20. If you make a query at + // 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you + // receive data timestamped between 15:02:15 and 15:07:15. // // This member is required. StartTime *time.Time @@ -153,26 +131,24 @@ type GetMetricStatisticsInput struct { // dimensions as a separate metric. If a specific combination of dimensions was not // published, you can't retrieve statistics for it. You must specify the same // dimensions that were used when the metrics were created. For an example, see - // Dimension Combinations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations) + // Dimension Combinations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations) // in the Amazon CloudWatch User Guide. For more information about specifying - // dimensions, see Publishing Metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) + // dimensions, see Publishing Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) // in the Amazon CloudWatch User Guide. Dimensions []types.Dimension // The percentile statistics. Specify values between p0.0 and p100. When calling - // GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, + // GetMetricStatistics , you must specify either Statistics or ExtendedStatistics , // but not both. Percentile statistics are not available for metrics when any of // the metric values are negative numbers. ExtendedStatistics []string // The metric statistics, other than percentile. For percentile statistics, use - // ExtendedStatistics. When calling GetMetricStatistics, you must specify either - // Statistics or ExtendedStatistics, but not both. + // ExtendedStatistics . When calling GetMetricStatistics , you must specify either + // Statistics or ExtendedStatistics , but not both. Statistics []types.Statistic - // The unit for a given metric. If you omit Unit, all data that was collected with + // The unit for a given metric. If you omit Unit , all data that was collected with // any unit is returned, along with the corresponding units that were specified // when the data was reported to CloudWatch. If you specify a unit, the operation // returns only data that was collected with that unit specified. If you specify a diff --git a/service/cloudwatch/api_op_GetMetricStream.go b/service/cloudwatch/api_op_GetMetricStream.go index 7062d3e5c49..0ac4e886451 100644 --- a/service/cloudwatch/api_op_GetMetricStream.go +++ b/service/cloudwatch/api_op_GetMetricStream.go @@ -52,8 +52,8 @@ type GetMetricStreamOutput struct { // stream. ExcludeFilters []types.MetricStreamFilter - // The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this - // metric stream. + // The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by + // this metric stream. FirehoseArn *string // If this array of metric namespaces is present, then these namespaces are the @@ -71,22 +71,22 @@ type GetMetricStreamOutput struct { // The name of the metric stream. Name *string - // The output format for the stream. Valid values are json and opentelemetry0.7. + // The output format for the stream. Valid values are json and opentelemetry0.7 . // For more information about metric stream output formats, see Metric streams - // output formats - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html). + // output formats (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) + // . OutputFormat types.MetricStreamOutputFormat // The ARN of the IAM role that is used by this metric stream. RoleArn *string - // The state of the metric stream. The possible values are running and stopped. + // The state of the metric stream. The possible values are running and stopped . State *string // Each entry in this array displays information about one or more metrics that // include additional statistics in the metric stream. For more information about - // the additional statistics, see CloudWatch statistics definitions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). + // the additional statistics, see CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) + // . StatisticsConfigurations []types.MetricStreamStatisticsConfiguration // Metadata pertaining to the operation's result. diff --git a/service/cloudwatch/api_op_GetMetricWidgetImage.go b/service/cloudwatch/api_op_GetMetricWidgetImage.go index d5a53b56aad..b9974c95e6e 100644 --- a/service/cloudwatch/api_op_GetMetricWidgetImage.go +++ b/service/cloudwatch/api_op_GetMetricWidgetImage.go @@ -18,11 +18,8 @@ import ( // graph features, including metric math and horizontal and vertical annotations. // There is a limit of 20 transactions per second for this API. Each // GetMetricWidgetImage action has the following limits: -// -// * As many as 100 metrics -// in the graph. -// -// * Up to 100 KB uncompressed payload. +// - As many as 100 metrics in the graph. +// - Up to 100 KB uncompressed payload. func (c *Client) GetMetricWidgetImage(ctx context.Context, params *GetMetricWidgetImageInput, optFns ...func(*Options)) (*GetMetricWidgetImageOutput, error) { if params == nil { params = &GetMetricWidgetImageInput{} @@ -40,33 +37,30 @@ func (c *Client) GetMetricWidgetImage(ctx context.Context, params *GetMetricWidg type GetMetricWidgetImageInput struct { - // A JSON string that defines the bitmap graph to be retrieved. The string includes - // the metrics to include in the graph, statistics, annotations, title, axis - // limits, and so on. You can include only one MetricWidget parameter in each + // A JSON string that defines the bitmap graph to be retrieved. The string + // includes the metrics to include in the graph, statistics, annotations, title, + // axis limits, and so on. You can include only one MetricWidget parameter in each // GetMetricWidgetImage call. For more information about the syntax of MetricWidget - // see GetMetricWidgetImage: Metric Widget Structure and Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html). - // If any metric on the graph could not load all the requested data points, an + // see GetMetricWidgetImage: Metric Widget Structure and Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html) + // . If any metric on the graph could not load all the requested data points, an // orange triangle with an exclamation point appears next to the graph legend. // // This member is required. MetricWidget *string - // The format of the resulting image. Only PNG images are supported. The default is - // png. If you specify png, the API returns an HTTP response with the content-type - // set to text/xml. The image data is in a MetricWidgetImage field. For example: - // > + // The format of the resulting image. Only PNG images are supported. The default + // is png . If you specify png , the API returns an HTTP response with the + // content-type set to text/xml . The image data is in a MetricWidgetImage field. + // For example: > // // iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip... // + // 6f0d4192-4d42-11e8-82c1-f539a07e0e3b // - // 6f0d4192-4d42-11e8-82c1-f539a07e0e3b - // - // The image/png setting is intended only for - // custom HTTP requests. For most use cases, and all actions using an Amazon Web - // Services SDK, you should use png. If you specify image/png, the HTTP response - // has a content-type set to image/png, and the body of the response is a PNG - // image. + // The image/png setting is intended only for custom HTTP requests. For most use + // cases, and all actions using an Amazon Web Services SDK, you should use png . If + // you specify image/png , the HTTP response has a content-type set to image/png , + // and the body of the response is a PNG image. OutputFormat *string noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_ListDashboards.go b/service/cloudwatch/api_op_ListDashboards.go index 0280e045aa1..829ac303c67 100644 --- a/service/cloudwatch/api_op_ListDashboards.go +++ b/service/cloudwatch/api_op_ListDashboards.go @@ -13,7 +13,7 @@ import ( ) // Returns a list of the dashboards for your account. If you include -// DashboardNamePrefix, only those dashboards with names starting with the prefix +// DashboardNamePrefix , only those dashboards with names starting with the prefix // are listed. Otherwise, all dashboards in your account are listed. ListDashboards // returns up to 1000 results on one page. If there are more than 1000 dashboards, // you can call ListDashboards again and include the value you received for diff --git a/service/cloudwatch/api_op_ListManagedInsightRules.go b/service/cloudwatch/api_op_ListManagedInsightRules.go index 039d968feae..494ff641162 100644 --- a/service/cloudwatch/api_op_ListManagedInsightRules.go +++ b/service/cloudwatch/api_op_ListManagedInsightRules.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list that contains the number of managed Contributor Insights rules in -// your account. +// Returns a list that contains the number of managed Contributor Insights rules +// in your account. func (c *Client) ListManagedInsightRules(ctx context.Context, params *ListManagedInsightRulesInput, optFns ...func(*Options)) (*ListManagedInsightRulesOutput, error) { if params == nil { params = &ListManagedInsightRulesInput{} @@ -31,18 +31,18 @@ func (c *Client) ListManagedInsightRules(ctx context.Context, params *ListManage type ListManagedInsightRulesInput struct { - // The ARN of an Amazon Web Services resource that has managed Contributor Insights - // rules. + // The ARN of an Amazon Web Services resource that has managed Contributor + // Insights rules. // // This member is required. ResourceARN *string // The maximum number of results to return in one operation. If you omit this - // parameter, the default number is used. The default number is 100. + // parameter, the default number is used. The default number is 100 . MaxResults *int32 - // Include this value to get the next set of rules if the value was returned by the - // previous operation. + // Include this value to get the next set of rules if the value was returned by + // the previous operation. NextToken *string noSmithyDocumentSerde @@ -54,8 +54,8 @@ type ListManagedInsightRulesOutput struct { // resource. ManagedRules []types.ManagedRuleDescription - // Include this value to get the next set of rules if the value was returned by the - // previous operation. + // Include this value to get the next set of rules if the value was returned by + // the previous operation. NextToken *string // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListManagedInsightRulesAPIClient = (*Client)(nil) // ListManagedInsightRules type ListManagedInsightRulesPaginatorOptions struct { // The maximum number of results to return in one operation. If you omit this - // parameter, the default number is used. The default number is 100. + // parameter, the default number is used. The default number is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudwatch/api_op_ListMetricStreams.go b/service/cloudwatch/api_op_ListMetricStreams.go index fe591a9da60..b39cb3db13b 100644 --- a/service/cloudwatch/api_op_ListMetricStreams.go +++ b/service/cloudwatch/api_op_ListMetricStreams.go @@ -33,8 +33,8 @@ type ListMetricStreamsInput struct { // The maximum number of results to return in one operation. MaxResults *int32 - // Include this value, if it was returned by the previous call, to get the next set - // of metric streams. + // Include this value, if it was returned by the previous call, to get the next + // set of metric streams. NextToken *string noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_ListMetrics.go b/service/cloudwatch/api_op_ListMetrics.go index 508a61b4304..eb989b000dd 100644 --- a/service/cloudwatch/api_op_ListMetrics.go +++ b/service/cloudwatch/api_op_ListMetrics.go @@ -12,27 +12,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the specified metrics. You can use the returned metrics with GetMetricData -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) -// or GetMetricStatistics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) +// List the specified metrics. You can use the returned metrics with GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) +// or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) // to get statistical data. Up to 500 results are returned for any one call. To // retrieve additional results, use the returned token with subsequent calls. After // you create a metric, allow up to 15 minutes for the metric to appear. To see -// metric statistics sooner, use GetMetricData -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) -// or GetMetricStatistics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html). -// If you are using CloudWatch cross-account observability, you can use this +// metric statistics sooner, use GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) +// or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) +// . If you are using CloudWatch cross-account observability, you can use this // operation in a monitoring account and view metrics from the linked source -// accounts. For more information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). -// ListMetrics doesn't return information about metrics if those metrics haven't +// accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . ListMetrics doesn't return information about metrics if those metrics haven't // reported data in the past two weeks. To retrieve those metrics, use -// GetMetricData -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) -// or GetMetricStatistics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html). +// GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) +// or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) +// . func (c *Client) ListMetrics(ctx context.Context, params *ListMetricsInput, optFns ...func(*Options)) (*ListMetricsOutput, error) { if params == nil { params = &ListMetricsInput{} @@ -50,16 +44,16 @@ func (c *Client) ListMetrics(ctx context.Context, params *ListMetricsInput, optF type ListMetricsInput struct { - // The dimensions to filter against. Only the dimensions that match exactly will be - // returned. + // The dimensions to filter against. Only the dimensions that match exactly will + // be returned. Dimensions []types.DimensionFilter - // If you are using this operation in a monitoring account, specify true to include - // metrics from source accounts in the returned data. The default is false. + // If you are using this operation in a monitoring account, specify true to + // include metrics from source accounts in the returned data. The default is false . IncludeLinkedAccounts bool - // The name of the metric to filter against. Only the metrics with names that match - // exactly will be returned. + // The name of the metric to filter against. Only the metrics with names that + // match exactly will be returned. MetricName *string // The metric namespace to filter against. Only the namespace that matches exactly @@ -72,11 +66,11 @@ type ListMetricsInput struct { // When you use this operation in a monitoring account, use this field to return // metrics only from one source account. To do so, specify that source account ID - // in this field, and also specify true for IncludeLinkedAccounts. + // in this field, and also specify true for IncludeLinkedAccounts . OwningAccount *string // To filter the results to show only metrics that have had data points published - // in the past three hours, specify this parameter with a value of PT3H. This is + // in the past three hours, specify this parameter with a value of PT3H . This is // the only valid value for this parameter. The results that are returned are an // approximation of the value you specify. There is a low probability that the // returned results include metrics with last published data as much as 40 minutes @@ -94,10 +88,10 @@ type ListMetricsOutput struct { // The token that marks the start of the next batch of returned results. NextToken *string - // If you are using this operation in a monitoring account, this array contains the - // account IDs of the source accounts where the metrics in the returned data are - // from. This field is a 1:1 mapping between each metric that is returned and the - // ID of the owning account. + // If you are using this operation in a monitoring account, this array contains + // the account IDs of the source accounts where the metrics in the returned data + // are from. This field is a 1:1 mapping between each metric that is returned and + // the ID of the owning account. OwningAccounts []string // Metadata pertaining to the operation's result. diff --git a/service/cloudwatch/api_op_ListTagsForResource.go b/service/cloudwatch/api_op_ListTagsForResource.go index 1c29e137c3c..cdf10cfc201 100644 --- a/service/cloudwatch/api_op_ListTagsForResource.go +++ b/service/cloudwatch/api_op_ListTagsForResource.go @@ -31,11 +31,10 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The ARN of the CloudWatch resource that you want to view tags for. The ARN - // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name The - // ARN format of a Contributor Insights rule is - // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more - // information about ARN format, see Resource Types Defined by Amazon CloudWatch - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) + // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name + // The ARN format of a Contributor Insights rule is + // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more + // information about ARN format, see Resource Types Defined by Amazon CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) // in the Amazon Web Services General Reference. // // This member is required. diff --git a/service/cloudwatch/api_op_PutAnomalyDetector.go b/service/cloudwatch/api_op_PutAnomalyDetector.go index 39a0c8545e7..e1b3f72b1e1 100644 --- a/service/cloudwatch/api_op_PutAnomalyDetector.go +++ b/service/cloudwatch/api_op_PutAnomalyDetector.go @@ -13,8 +13,8 @@ import ( // Creates an anomaly detection model for a CloudWatch metric. You can use the // model to display a band of expected normal values when the metric is graphed. -// For more information, see CloudWatch Anomaly Detection -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html). +// For more information, see CloudWatch Anomaly Detection (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) +// . func (c *Client) PutAnomalyDetector(ctx context.Context, params *PutAnomalyDetectorInput, optFns ...func(*Options)) (*PutAnomalyDetectorOutput, error) { if params == nil { params = &PutAnomalyDetectorInput{} @@ -44,23 +44,15 @@ type PutAnomalyDetectorInput struct { Dimensions []types.Dimension // The metric math anomaly detector to be created. When using - // MetricMathAnomalyDetector, you cannot include the following parameters in the + // MetricMathAnomalyDetector , you cannot include the following parameters in the // same operation: - // - // * Dimensions - // - // * MetricName - // - // * Namespace - // - // * Stat - // - // * the - // SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput - // - // Instead, - // specify the metric math anomaly detector attributes as part of the property - // MetricMathAnomalyDetector. + // - Dimensions + // - MetricName + // - Namespace + // - Stat + // - the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput + // Instead, specify the metric math anomaly detector attributes as part of the + // property MetricMathAnomalyDetector . MetricMathAnomalyDetector *types.MetricMathAnomalyDetector // The name of the metric to create the anomaly detection model for. @@ -74,23 +66,15 @@ type PutAnomalyDetectorInput struct { Namespace *string // A single metric anomaly detector to be created. When using - // SingleMetricAnomalyDetector, you cannot include the following parameters in the + // SingleMetricAnomalyDetector , you cannot include the following parameters in the // same operation: - // - // * Dimensions - // - // * MetricName - // - // * Namespace - // - // * Stat - // - // * the - // MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput - // - // Instead, - // specify the single metric anomaly detector attributes as part of the property - // SingleMetricAnomalyDetector. + // - Dimensions + // - MetricName + // - Namespace + // - Stat + // - the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput + // Instead, specify the single metric anomaly detector attributes as part of the + // property SingleMetricAnomalyDetector . SingleMetricAnomalyDetector *types.SingleMetricAnomalyDetector // The statistic to use for the metric and the anomaly detection model. diff --git a/service/cloudwatch/api_op_PutCompositeAlarm.go b/service/cloudwatch/api_op_PutCompositeAlarm.go index 18ab390013c..ce64d5001bf 100644 --- a/service/cloudwatch/api_op_PutCompositeAlarm.go +++ b/service/cloudwatch/api_op_PutCompositeAlarm.go @@ -31,16 +31,16 @@ import ( // to delete. To get out of such a situation, you must break the cycle by changing // the rule of one of the composite alarms in the cycle to remove a dependency that // creates the cycle. The simplest change to make to break a cycle is to change the -// AlarmRule of one of the alarms to false. Additionally, the evaluation of +// AlarmRule of one of the alarms to false . Additionally, the evaluation of // composite alarms stops if CloudWatch detects a cycle in the evaluation path. // When this operation creates an alarm, the alarm state is immediately set to -// INSUFFICIENT_DATA. The alarm is then evaluated and its state is set +// INSUFFICIENT_DATA . The alarm is then evaluated and its state is set // appropriately. Any actions associated with the new state are then executed. For // a composite alarm, this initial time after creation is the only time that the // alarm can be in INSUFFICIENT_DATA state. When you update an existing alarm, its // state is left unchanged, but the update completely overwrites the previous // configuration of the alarm. To use this operation, you must be signed on with -// the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't +// the cloudwatch:PutCompositeAlarm permission that is scoped to * . You can't // create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a // narrower scope. If you are an IAM user, you must have // iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager @@ -67,62 +67,47 @@ type PutCompositeAlarmInput struct { // This member is required. AlarmName *string - // An expression that specifies which other alarms are to be evaluated to determine - // this composite alarm's state. For each alarm that you reference, you designate a - // function that specifies whether that alarm needs to be in ALARM state, OK state, - // or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine - // multiple functions in a single expression. You can use parenthesis to logically - // group the functions in your expression. You can use either alarm names or ARNs - // to reference the other alarms that are to be evaluated. Functions can include - // the following: - // - // * ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is - // in ALARM state. - // - // * OK("alarm-name or alarm-ARN") is TRUE if the named alarm is - // in OK state. - // - // * INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the - // named alarm is in INSUFFICIENT_DATA state. - // - // * TRUE always evaluates to TRUE. - // - // * - // FALSE always evaluates to FALSE. - // - // TRUE and FALSE are useful for testing a - // complex AlarmRule structure, and for testing your alarm actions. Alarm names - // specified in AlarmRule can be surrounded with double-quotes ("), but do not have - // to be. The following are some examples of AlarmRule: - // - // * - // ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the - // composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and - // DiskReadOpsTooHigh alarms are in ALARM state. - // - // * ALARM(CPUUtilizationTooHigh) - // AND NOT ALARM(DeploymentInProgress) specifies that the alarm goes to ALARM state - // if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in - // ALARM state. This example reduces alarm noise during a known deployment - // window. - // - // * (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND - // OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh OR - // DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. - // This provides another example of using a composite alarm to prevent noise. This - // rule ensures that you are not notified with an alarm action on high CPU or disk - // usage if a known network problem is also occurring. - // - // The AlarmRule can specify - // as many as 100 "children" alarms. The AlarmRule expression can have as many as - // 500 elements. Elements are child alarms, TRUE or FALSE statements, and - // parentheses. + // An expression that specifies which other alarms are to be evaluated to + // determine this composite alarm's state. For each alarm that you reference, you + // designate a function that specifies whether that alarm needs to be in ALARM + // state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and + // NOT) to combine multiple functions in a single expression. You can use + // parenthesis to logically group the functions in your expression. You can use + // either alarm names or ARNs to reference the other alarms that are to be + // evaluated. Functions can include the following: + // - ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM + // state. + // - OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state. + // - INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is + // in INSUFFICIENT_DATA state. + // - TRUE always evaluates to TRUE. + // - FALSE always evaluates to FALSE. + // TRUE and FALSE are useful for testing a complex AlarmRule structure, and for + // testing your alarm actions. Alarm names specified in AlarmRule can be + // surrounded with double-quotes ("), but do not have to be. The following are some + // examples of AlarmRule : + // - ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that + // the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and + // DiskReadOpsTooHigh alarms are in ALARM state. + // - ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) specifies + // that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state + // and DeploymentInProgress is not in ALARM state. This example reduces alarm noise + // during a known deployment window. + // - (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND + // OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh OR + // DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. + // This provides another example of using a composite alarm to prevent noise. This + // rule ensures that you are not notified with an alarm action on high CPU or disk + // usage if a known network problem is also occurring. + // The AlarmRule can specify as many as 100 "children" alarms. The AlarmRule + // expression can have as many as 500 elements. Elements are child alarms, TRUE or + // FALSE statements, and parentheses. // // This member is required. AlarmRule *string // Indicates whether actions should be executed during any changes to the alarm - // state of the composite alarm. The default is TRUE. + // state of the composite alarm. The default is TRUE . ActionsEnabled *bool // Actions will be suppressed if the suppressor alarm is in the ALARM state. @@ -131,9 +116,9 @@ type PutCompositeAlarmInput struct { ActionsSuppressor *string // The maximum time in seconds that the composite alarm waits after suppressor - // alarm goes out of the ALARM state. After this time, the composite alarm performs - // its actions. ExtensionPeriod is required only when ActionsSuppressor is - // specified. + // alarm goes out of the ALARM state. After this time, the composite alarm + // performs its actions. ExtensionPeriod is required only when ActionsSuppressor + // is specified. ActionsSuppressorExtensionPeriod *int32 // The maximum time in seconds that the composite alarm waits for the suppressor @@ -155,9 +140,9 @@ type PutCompositeAlarmInput struct { // (ARN). Valid Values: arn:aws:sns:region:account-id:sns-topic-name InsufficientDataActions []string - // The actions to execute when this alarm transitions to an OK state from any other - // state. Each action is specified as an Amazon Resource Name (ARN). Valid Values: - // arn:aws:sns:region:account-id:sns-topic-name + // The actions to execute when this alarm transitions to an OK state from any + // other state. Each action is specified as an Amazon Resource Name (ARN). Valid + // Values: arn:aws:sns:region:account-id:sns-topic-name OKActions []string // A list of key-value pairs to associate with the composite alarm. You can diff --git a/service/cloudwatch/api_op_PutDashboard.go b/service/cloudwatch/api_op_PutDashboard.go index ecb663b8ed1..7fd3be395f6 100644 --- a/service/cloudwatch/api_op_PutDashboard.go +++ b/service/cloudwatch/api_op_PutDashboard.go @@ -18,9 +18,9 @@ import ( // copy an existing dashboard. To copy an existing dashboard using the console, you // can load the dashboard and then use the View/edit source command in the Actions // menu to display the JSON block for that dashboard. Another way to copy a -// dashboard is to use GetDashboard, and then use the data returned within -// DashboardBody as the template for the new dashboard when you call PutDashboard. -// When you create a dashboard with PutDashboard, a good practice is to add a text +// dashboard is to use GetDashboard , and then use the data returned within +// DashboardBody as the template for the new dashboard when you call PutDashboard . +// When you create a dashboard with PutDashboard , a good practice is to add a text // widget at the top of the dashboard with a message that the dashboard was created // by script and should not be changed in the console. This message could also // point console users to the location of the DashboardBody script or the @@ -45,8 +45,8 @@ type PutDashboardInput struct { // The detailed information about the dashboard in JSON format, including the // widgets to include and their location on the dashboard. This parameter is // required. For more information about the syntax, see Dashboard Body Structure - // and Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html). + // and Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) + // . // // This member is required. DashboardBody *string diff --git a/service/cloudwatch/api_op_PutInsightRule.go b/service/cloudwatch/api_op_PutInsightRule.go index 3b4557d66be..c788f459b90 100644 --- a/service/cloudwatch/api_op_PutInsightRule.go +++ b/service/cloudwatch/api_op_PutInsightRule.go @@ -14,9 +14,8 @@ import ( // Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch // Logs log group, enabling you to find contributor data for the log events in that // log group. For more information, see Using Contributor Insights to Analyze -// High-Cardinality Data -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html). -// If you create a rule, delete it, and then re-create it with the same name, +// High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) +// . If you create a rule, delete it, and then re-create it with the same name, // historical data from the first time the rule was created might not be available. func (c *Client) PutInsightRule(ctx context.Context, params *PutInsightRuleInput, optFns ...func(*Options)) (*PutInsightRuleOutput, error) { if params == nil { @@ -36,8 +35,8 @@ func (c *Client) PutInsightRule(ctx context.Context, params *PutInsightRuleInput type PutInsightRuleInput struct { // The definition of the rule, as a JSON object. For details on the valid syntax, - // see Contributor Insights Rule Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). + // see Contributor Insights Rule Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) + // . // // This member is required. RuleDefinition *string @@ -58,8 +57,8 @@ type PutInsightRuleInput struct { // cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule // permission. If you are using this operation to update an existing Contributor // Insights rule, any tags you specify in this parameter are ignored. To change the - // tags of an existing rule, use TagResource - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html). + // tags of an existing rule, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_PutManagedInsightRules.go b/service/cloudwatch/api_op_PutManagedInsightRules.go index b5165e88db3..617a561f806 100644 --- a/service/cloudwatch/api_op_PutManagedInsightRules.go +++ b/service/cloudwatch/api_op_PutManagedInsightRules.go @@ -14,10 +14,11 @@ import ( // Creates a managed Contributor Insights rule for a specified Amazon Web Services // resource. When you enable a managed rule, you create a Contributor Insights rule // that collects data from Amazon Web Services services. You cannot edit these -// rules with PutInsightRule. The rules can be enabled, disabled, and deleted using -// EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a previously -// created managed rule is currently disabled, a subsequent call to this API will -// re-enable it. Use ListManagedInsightRules to describe all available rules. +// rules with PutInsightRule . The rules can be enabled, disabled, and deleted +// using EnableInsightRules , DisableInsightRules , and DeleteInsightRules . If a +// previously created managed rule is currently disabled, a subsequent call to this +// API will re-enable it. Use ListManagedInsightRules to describe all available +// rules. func (c *Client) PutManagedInsightRules(ctx context.Context, params *PutManagedInsightRulesInput, optFns ...func(*Options)) (*PutManagedInsightRulesOutput, error) { if params == nil { params = &PutManagedInsightRulesInput{} diff --git a/service/cloudwatch/api_op_PutMetricAlarm.go b/service/cloudwatch/api_op_PutMetricAlarm.go index 8e23d54e18a..7868b12e207 100644 --- a/service/cloudwatch/api_op_PutMetricAlarm.go +++ b/service/cloudwatch/api_op_PutMetricAlarm.go @@ -13,51 +13,40 @@ import ( // Creates or updates an alarm and associates it with the specified metric, metric // math expression, anomaly detection model, or Metrics Insights query. For more -// information about using a Metrics Insights query for an alarm, see Create alarms -// on Metrics Insights queries -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html). -// Alarms based on anomaly detection models cannot have Auto Scaling actions. When -// this operation creates an alarm, the alarm state is immediately set to -// INSUFFICIENT_DATA. The alarm is then evaluated and its state is set +// information about using a Metrics Insights query for an alarm, see Create +// alarms on Metrics Insights queries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html) +// . Alarms based on anomaly detection models cannot have Auto Scaling actions. +// When this operation creates an alarm, the alarm state is immediately set to +// INSUFFICIENT_DATA . The alarm is then evaluated and its state is set // appropriately. Any actions associated with the new state are then executed. When // you update an existing alarm, its state is left unchanged, but the update // completely overwrites the previous configuration of the alarm. If you are an IAM // user, you must have Amazon EC2 permissions for some alarm operations: +// - The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions +// - The iam:CreateServiceLinkedRole permissions to create an alarm with Systems +// Manager OpsItem or response plan actions. // -// * The -// iam:CreateServiceLinkedRole permission for all alarms with EC2 actions -// -// * The -// iam:CreateServiceLinkedRole permissions to create an alarm with Systems Manager -// OpsItem or response plan actions. -// -// The first time you create an alarm in the -// Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm -// API, CloudWatch creates the necessary service-linked role for you. The -// service-linked roles are called AWSServiceRoleForCloudWatchEvents and -// AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon -// Web Services service-linked role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role). -// Cross-account alarms You can set an alarm on metrics in the current account, or -// in another account. To create a cross-account alarm that watches a metric in a -// different account, you must have completed the following pre-requisites: -// -// * The -// account where the metrics are located (the sharing account) must already have a -// sharing role named CloudWatch-CrossAccountSharingRole. If it does not already -// have this role, you must create it using the instructions in Set up a sharing -// account in Cross-account cross-Region CloudWatch console -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region). -// The policy for that role must grant access to the ID of the account where you -// are creating the alarm. -// -// * The account where you are creating the alarm (the -// monitoring account) must already have a service-linked role named -// AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the -// sharing role in the sharing account. If it does not, you must create it -// following the directions in Set up a monitoring account in Cross-account -// cross-Region CloudWatch console -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region). +// The first time you create an alarm in the Amazon Web Services Management +// Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the +// necessary service-linked role for you. The service-linked roles are called +// AWSServiceRoleForCloudWatchEvents and +// AWSServiceRoleForCloudWatchAlarms_ActionSSM . For more information, see Amazon +// Web Services service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role) +// . Cross-account alarms You can set an alarm on metrics in the current account, +// or in another account. To create a cross-account alarm that watches a metric in +// a different account, you must have completed the following pre-requisites: +// - The account where the metrics are located (the sharing account) must +// already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does +// not already have this role, you must create it using the instructions in Set up +// a sharing account in Cross-account cross-Region CloudWatch console (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region) +// . The policy for that role must grant access to the ID of the account where you +// are creating the alarm. +// - The account where you are creating the alarm (the monitoring account) must +// already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount +// to allow CloudWatch to assume the sharing role in the sharing account. If it +// does not, you must create it following the directions in Set up a monitoring +// account in Cross-account cross-Region CloudWatch console (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region) +// . func (c *Client) PutMetricAlarm(ctx context.Context, params *PutMetricAlarmInput, optFns ...func(*Options)) (*PutMetricAlarmOutput, error) { if params == nil { params = &PutMetricAlarmInput{} @@ -83,73 +72,50 @@ type PutMetricAlarmInput struct { // The arithmetic operation to use when comparing the specified statistic and // threshold. The specified statistic value is used as the first operand. The - // values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and + // values LessThanLowerOrGreaterThanUpperThreshold , LessThanLowerThreshold , and // GreaterThanUpperThreshold are used only for alarms based on anomaly detection // models. // // This member is required. ComparisonOperator types.ComparisonOperator - // The number of periods over which data is compared to the specified threshold. If - // you are setting an alarm that requires that a number of consecutive data points - // be breaching to trigger the alarm, this value specifies that number. If you are - // setting an "M out of N" alarm, this value is the N. An alarm's total current - // evaluation period can be no longer than one day, so this number multiplied by - // Period cannot be more than 86,400 seconds. + // The number of periods over which data is compared to the specified threshold. + // If you are setting an alarm that requires that a number of consecutive data + // points be breaching to trigger the alarm, this value specifies that number. If + // you are setting an "M out of N" alarm, this value is the N. An alarm's total + // current evaluation period can be no longer than one day, so this number + // multiplied by Period cannot be more than 86,400 seconds. // // This member is required. EvaluationPeriods *int32 // Indicates whether actions should be executed during any changes to the alarm - // state. The default is TRUE. + // state. The default is TRUE . ActionsEnabled *bool // The actions to execute when this alarm transitions to the ALARM state from any // other state. Each action is specified as an Amazon Resource Name (ARN). Valid // values: EC2 actions: - // - // * arn:aws:automate:region:ec2:stop - // - // * - // arn:aws:automate:region:ec2:terminate - // - // * arn:aws:automate:region:ec2:reboot - // - // * - // arn:aws:automate:region:ec2:recover - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 - // - // Autoscaling - // action: - // - // * - // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSN - // notification action: - // - // * - // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSM - // integration actions: - // - // * - // arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name - // - // * - // arn:aws:ssm-incidents::account-id:responseplan/response-plan-name + // - arn:aws:automate:region:ec2:stop + // - arn:aws:automate:region:ec2:terminate + // - arn:aws:automate:region:ec2:reboot + // - arn:aws:automate:region:ec2:recover + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 + // - + // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 + // Autoscaling action: + // - + // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSN notification action: + // - + // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSM integration actions: + // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name + // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name AlarmActions []string // The description for the alarm. @@ -157,81 +123,57 @@ type PutMetricAlarmInput struct { // The number of data points that must be breaching to trigger the alarm. This is // used only if you are setting an "M out of N" alarm. In that case, this value is - // the M. For more information, see Evaluating an Alarm - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) + // the M. For more information, see Evaluating an Alarm (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) // in the Amazon CloudWatch User Guide. DatapointsToAlarm *int32 - // The dimensions for the metric specified in MetricName. + // The dimensions for the metric specified in MetricName . Dimensions []types.Dimension - // Used only for alarms based on percentiles. If you specify ignore, the alarm + // Used only for alarms based on percentiles. If you specify ignore , the alarm // state does not change during periods with too few data points to be // statistically significant. If you specify evaluate or omit this parameter, the // alarm is always evaluated and possibly changes state no matter how many data // points are available. For more information, see Percentile-Based CloudWatch - // Alarms and Low Data Samples - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples). - // Valid Values: evaluate | ignore + // Alarms and Low Data Samples (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples) + // . Valid Values: evaluate | ignore EvaluateLowSampleCountPercentile *string - // The percentile statistic for the metric specified in MetricName. Specify a value - // between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, - // you must specify either Statistic or ExtendedStatistic, but not both. + // The percentile statistic for the metric specified in MetricName . Specify a + // value between p0.0 and p100. When you call PutMetricAlarm and specify a + // MetricName , you must specify either Statistic or ExtendedStatistic, but not + // both. ExtendedStatistic *string // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource Name // (ARN). Valid values: EC2 actions: - // - // * arn:aws:automate:region:ec2:stop - // - // * - // arn:aws:automate:region:ec2:terminate - // - // * arn:aws:automate:region:ec2:reboot - // - // * - // arn:aws:automate:region:ec2:recover - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 - // - // Autoscaling - // action: - // - // * - // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSN - // notification action: - // - // * - // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSM - // integration actions: - // - // * - // arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name - // - // * - // arn:aws:ssm-incidents::account-id:responseplan/response-plan-name + // - arn:aws:automate:region:ec2:stop + // - arn:aws:automate:region:ec2:terminate + // - arn:aws:automate:region:ec2:reboot + // - arn:aws:automate:region:ec2:recover + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 + // - + // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 + // Autoscaling action: + // - + // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSN notification action: + // - + // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSM integration actions: + // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name + // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name InsufficientDataActions []string // The name for the metric associated with the alarm. For each PutMetricAlarm // operation, you must specify either MetricName or a Metrics array. If you are // creating an alarm based on a math expression, you cannot specify this parameter, - // or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic + // or any of the Dimensions , Period , Namespace , Statistic , or ExtendedStatistic // parameters. Instead, you specify all this information in the Metrics array. MetricName *string @@ -241,63 +183,39 @@ type PutMetricAlarmInput struct { // array either retrieves a metric or performs a math expression. One item in the // Metrics array is the expression that the alarm watches. You designate this // expression by setting ReturnData to true for this object in the array. For more - // information, see MetricDataQuery - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html). - // If you use the Metrics parameter, you cannot include the MetricName, Dimensions, - // Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm - // in the same operation. Instead, you retrieve the metrics you are using in your - // math expression as part of the Metrics array. + // information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html) + // . If you use the Metrics parameter, you cannot include the MetricName , + // Dimensions , Period , Namespace , Statistic , or ExtendedStatistic parameters + // of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you + // are using in your math expression as part of the Metrics array. Metrics []types.MetricDataQuery - // The namespace for the metric associated specified in MetricName. + // The namespace for the metric associated specified in MetricName . Namespace *string - // The actions to execute when this alarm transitions to an OK state from any other - // state. Each action is specified as an Amazon Resource Name (ARN). Valid values: - // EC2 actions: - // - // * arn:aws:automate:region:ec2:stop - // - // * - // arn:aws:automate:region:ec2:terminate - // - // * arn:aws:automate:region:ec2:reboot - // - // * - // arn:aws:automate:region:ec2:recover - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 - // - // * - // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 - // - // Autoscaling - // action: - // - // * - // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSN - // notification action: - // - // * - // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name - // - // SSM - // integration actions: - // - // * - // arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name - // - // * - // arn:aws:ssm-incidents::account-id:responseplan/response-plan-name + // The actions to execute when this alarm transitions to an OK state from any + // other state. Each action is specified as an Amazon Resource Name (ARN). Valid + // values: EC2 actions: + // - arn:aws:automate:region:ec2:stop + // - arn:aws:automate:region:ec2:terminate + // - arn:aws:automate:region:ec2:reboot + // - arn:aws:automate:region:ec2:recover + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 + // - + // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 + // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 + // Autoscaling action: + // - + // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSN notification action: + // - + // arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + // + // SSM integration actions: + // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name + // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name OKActions []string // The length, in seconds, used each time the metric specified in MetricName is @@ -305,35 +223,33 @@ type PutMetricAlarmInput struct { // for alarms based on static thresholds. If you are creating an alarm based on a // metric math expression, you specify the period for each metric within the // objects in the Metrics array. Be sure to specify 10 or 30 only for metrics that - // are stored by a PutMetricData call with a StorageResolution of 1. If you specify - // a period of 10 or 30 for a metric that does not have sub-minute resolution, the - // alarm still attempts to gather data at the period rate that you specify. In this - // case, it does not receive data for the attempts that do not correspond to a - // one-minute data resolution, and the alarm might often lapse into + // are stored by a PutMetricData call with a StorageResolution of 1. If you + // specify a period of 10 or 30 for a metric that does not have sub-minute + // resolution, the alarm still attempts to gather data at the period rate that you + // specify. In this case, it does not receive data for the attempts that do not + // correspond to a one-minute data resolution, and the alarm might often lapse into // INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a // high-resolution alarm, which has a higher charge than other alarms. For more - // information about pricing, see Amazon CloudWatch Pricing - // (https://aws.amazon.com/cloudwatch/pricing/). An alarm's total current - // evaluation period can be no longer than one day, so Period multiplied by - // EvaluationPeriods cannot be more than 86,400 seconds. + // information about pricing, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/) + // . An alarm's total current evaluation period can be no longer than one day, so + // Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. Period *int32 - // The statistic for the metric specified in MetricName, other than percentile. For - // percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and - // specify a MetricName, you must specify either Statistic or ExtendedStatistic, - // but not both. + // The statistic for the metric specified in MetricName , other than percentile. + // For percentile statistics, use ExtendedStatistic . When you call PutMetricAlarm + // and specify a MetricName , you must specify either Statistic or + // ExtendedStatistic, but not both. Statistic types.Statistic - // A list of key-value pairs to associate with the alarm. You can associate as many - // as 50 tags with an alarm. Tags can help you organize and categorize your + // A list of key-value pairs to associate with the alarm. You can associate as + // many as 50 tags with an alarm. Tags can help you organize and categorize your // resources. You can also use them to scope user permissions by granting a user // permission to access or change only resources with certain tag values. If you // are using this operation to update an existing alarm, any tags you specify in // this parameter are ignored. To change the tags of an existing alarm, use - // TagResource - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) - // or UntagResource - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). + // TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) + // or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html) + // . Tags []types.Tag // The value against which the specified statistic is compared. This parameter is @@ -342,27 +258,27 @@ type PutMetricAlarmInput struct { Threshold *float64 // If this is an alarm based on an anomaly detection model, make this value match - // the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this - // parameter, see the Anomaly Detection Model Alarm example on this page. If your - // alarm uses this parameter, it cannot have Auto Scaling actions. + // the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use + // this parameter, see the Anomaly Detection Model Alarm example on this page. If + // your alarm uses this parameter, it cannot have Auto Scaling actions. ThresholdMetricId *string // Sets how this alarm is to handle missing data points. If TreatMissingData is // omitted, the default behavior of missing is used. For more information, see - // Configuring How CloudWatch Alarms Treats Missing Data - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). - // Valid Values: breaching | notBreaching | ignore | missing Alarms that evaluate - // metrics in the AWS/DynamoDB namespace always ignore missing data even if you - // choose a different option for TreatMissingData. When an AWS/DynamoDB metric has - // missing data, alarms that evaluate that metric remain in their current state. + // Configuring How CloudWatch Alarms Treats Missing Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) + // . Valid Values: breaching | notBreaching | ignore | missing Alarms that + // evaluate metrics in the AWS/DynamoDB namespace always ignore missing data even + // if you choose a different option for TreatMissingData . When an AWS/DynamoDB + // metric has missing data, alarms that evaluate that metric remain in their + // current state. TreatMissingData *string - // The unit of measure for the statistic. For example, the units for the Amazon EC2 - // NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an - // instance receives on all network interfaces. You can also specify a unit when + // The unit of measure for the statistic. For example, the units for the Amazon + // EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that + // an instance receives on all network interfaces. You can also specify a unit when // you create a custom metric. Units help provide conceptual meaning to your data. // Metric data points that specify a unit of measure, such as Percent, are - // aggregated separately. If you don't specify Unit, CloudWatch retrieves all unit + // aggregated separately. If you don't specify Unit , CloudWatch retrieves all unit // types that have been published for the metric and attempts to evaluate the // alarm. Usually, metrics are published with only one unit, so the alarm works as // intended. However, if the metric is published with multiple types of units and diff --git a/service/cloudwatch/api_op_PutMetricData.go b/service/cloudwatch/api_op_PutMetricData.go index 2b0808d653f..ad72787b60e 100644 --- a/service/cloudwatch/api_op_PutMetricData.go +++ b/service/cloudwatch/api_op_PutMetricData.go @@ -14,46 +14,37 @@ import ( // Publishes metric data points to Amazon CloudWatch. CloudWatch associates the // data points with the specified metric. If the specified metric does not exist, // CloudWatch creates the metric. When CloudWatch creates a metric, it can take up -// to fifteen minutes for the metric to appear in calls to ListMetrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). -// You can publish either individual data points in the Value field, or arrays of -// values and the number of times each value occurred during the period by using +// to fifteen minutes for the metric to appear in calls to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) +// . You can publish either individual data points in the Value field, or arrays +// of values and the number of times each value occurred during the period by using // the Values and Counts fields in the MetricDatum structure. Using the Values and // Counts method enables you to publish up to 150 values per metric with one // PutMetricData request, and supports retrieving percentile statistics on this // data. Each PutMetricData request is limited to 1 MB in size for HTTP POST // requests. You can send a payload compressed by gzip. Each request is also // limited to no more than 1000 different metrics. Although the Value parameter -// accepts numbers of type Double, CloudWatch rejects values that are either too +// accepts numbers of type Double , CloudWatch rejects values that are either too // small or too large. Values must be in the range of -2^360 to 2^360. In addition, // special values (for example, NaN, +Infinity, -Infinity) are not supported. You // can use up to 30 dimensions per metric to further clarify what data the metric // collects. Each dimension consists of a Name and Value pair. For more information -// about specifying dimensions, see Publishing Metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) +// about specifying dimensions, see Publishing Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) // in the Amazon CloudWatch User Guide. You specify the time stamp to be associated // with each data point. You can specify time stamps that are as much as two weeks // before the current date, and as much as 2 hours after the current day and time. // Data points with time stamps from 24 hours ago or longer can take at least 48 -// hours to become available for GetMetricData -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) -// or GetMetricStatistics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) +// hours to become available for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) +// or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) // from the time they are submitted. Data points with time stamps between 3 and 24 -// hours ago can take as much as 2 hours to become available for for GetMetricData -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) -// or GetMetricStatistics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html). -// CloudWatch needs raw data points to calculate percentile statistics. If you +// hours ago can take as much as 2 hours to become available for for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) +// or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) +// . CloudWatch needs raw data points to calculate percentile statistics. If you // publish data using a statistic set instead, you can only retrieve percentile // statistics for this data if one of the following conditions is true: -// -// * The -// SampleCount value of the statistic set is 1 and Min, Max, and Sum are all -// equal. -// -// * The Min and Max are equal, and Sum is equal to Min multiplied by -// SampleCount. +// - The SampleCount value of the statistic set is 1 and Min , Max , and Sum are +// all equal. +// - The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount +// . func (c *Client) PutMetricData(ctx context.Context, params *PutMetricDataInput, optFns ...func(*Options)) (*PutMetricDataOutput, error) { if params == nil { params = &PutMetricDataInput{} diff --git a/service/cloudwatch/api_op_PutMetricStream.go b/service/cloudwatch/api_op_PutMetricStream.go index bb010069a84..922df290b6a 100644 --- a/service/cloudwatch/api_op_PutMetricStream.go +++ b/service/cloudwatch/api_op_PutMetricStream.go @@ -13,36 +13,29 @@ import ( // Creates or updates a metric stream. Metric streams can automatically stream // CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and -// to many third-party solutions. For more information, see Using Metric Streams -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html). -// To create a metric stream, you must be signed in to an account that has the +// to many third-party solutions. For more information, see Using Metric Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) +// . To create a metric stream, you must be signed in to an account that has the // iam:PassRole permission and either the CloudWatchFullAccess policy or the // cloudwatch:PutMetricStream permission. When you create or update a metric // stream, you choose one of the following: +// - Stream metrics from all metric namespaces in the account. +// - Stream metrics from all metric namespaces in the account, except for the +// namespaces that you list in ExcludeFilters . +// - Stream metrics from only the metric namespaces that you list in +// IncludeFilters . // -// * Stream metrics from all metric -// namespaces in the account. -// -// * Stream metrics from all metric namespaces in the -// account, except for the namespaces that you list in ExcludeFilters. -// -// * Stream -// metrics from only the metric namespaces that you list in IncludeFilters. -// -// By -// default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT +// By default, a metric stream always sends the MAX , MIN , SUM , and SAMPLECOUNT // statistics for each metric that is streamed. You can use the // StatisticsConfigurations parameter to have the metric stream send additional // statistics in the stream. Streaming additional statistics incurs additional -// costs. For more information, see Amazon CloudWatch Pricing -// (https://aws.amazon.com/cloudwatch/pricing/). When you use PutMetricStream to -// create a new metric stream, the stream is created in the running state. If you -// use it to update an existing stream, the state of the stream is not changed. If -// you are using CloudWatch cross-account observability and you create a metric -// stream in a monitoring account, you can choose whether to include metrics from -// source accounts in the stream. For more information, see CloudWatch -// cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// costs. For more information, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/) +// . When you use PutMetricStream to create a new metric stream, the stream is +// created in the running state. If you use it to update an existing stream, the +// state of the stream is not changed. If you are using CloudWatch cross-account +// observability and you create a metric stream in a monitoring account, you can +// choose whether to include metrics from source accounts in the stream. For more +// information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) PutMetricStream(ctx context.Context, params *PutMetricStreamInput, optFns ...func(*Options)) (*PutMetricStreamOutput, error) { if params == nil { params = &PutMetricStreamInput{} @@ -75,22 +68,20 @@ type PutMetricStreamInput struct { // This member is required. Name *string - // The output format for the stream. Valid values are json and opentelemetry0.7. - // For more information about metric stream output formats, see Metric streams - // output formats - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html). + // The output format for the stream. Valid values are json and opentelemetry0.7 . + // For more information about metric stream output formats, see Metric streams + // output formats (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) + // . // // This member is required. OutputFormat types.MetricStreamOutputFormat - // The ARN of an IAM role that this metric stream will use to access Amazon Kinesis - // Data Firehose resources. This IAM role must already exist and must be in the - // same account as the metric stream. This IAM role must include the following + // The ARN of an IAM role that this metric stream will use to access Amazon + // Kinesis Data Firehose resources. This IAM role must already exist and must be in + // the same account as the metric stream. This IAM role must include the following // permissions: - // - // * firehose:PutRecord - // - // * firehose:PutRecordBatch + // - firehose:PutRecord + // - firehose:PutRecordBatch // // This member is required. RoleArn *string @@ -100,8 +91,8 @@ type PutMetricStreamInput struct { // ExcludeFilters and IncludeFilters in the same operation. ExcludeFilters []types.MetricStreamFilter - // If you specify this parameter, the stream sends only the metrics from the metric - // namespaces that you specify here. You cannot include IncludeFilters and + // If you specify this parameter, the stream sends only the metrics from the + // metric namespaces that you specify here. You cannot include IncludeFilters and // ExcludeFilters in the same operation. IncludeFilters []types.MetricStreamFilter @@ -109,30 +100,28 @@ type PutMetricStreamInput struct { // include metrics from source accounts in the metric stream. IncludeLinkedAccountsMetrics *bool - // By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT + // By default, a metric stream always sends the MAX , MIN , SUM , and SAMPLECOUNT // statistics for each metric that is streamed. You can use this parameter to have // the metric stream also send additional statistics in the stream. This array can // have up to 100 members. For each entry in this array, you specify one or more // metrics and the list of additional statistics to stream for those metrics. The - // additional statistics that you can stream depend on the stream's OutputFormat. - // If the OutputFormat is json, you can stream any additional statistic that is - // supported by CloudWatch, listed in CloudWatch statistics definitions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). - // If the OutputFormat is opentelemetry0.7, you can stream percentile statistics + // additional statistics that you can stream depend on the stream's OutputFormat . + // If the OutputFormat is json , you can stream any additional statistic that is + // supported by CloudWatch, listed in CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) + // . If the OutputFormat is opentelemetry0.7 , you can stream percentile statistics // such as p95, p99.9, and so on. StatisticsConfigurations []types.MetricStreamStatisticsConfiguration - // A list of key-value pairs to associate with the metric stream. You can associate - // as many as 50 tags with a metric stream. Tags can help you organize and - // categorize your resources. You can also use them to scope user permissions by - // granting a user permission to access or change only resources with certain tag - // values. You can use this parameter only when you are creating a new metric + // A list of key-value pairs to associate with the metric stream. You can + // associate as many as 50 tags with a metric stream. Tags can help you organize + // and categorize your resources. You can also use them to scope user permissions + // by granting a user permission to access or change only resources with certain + // tag values. You can use this parameter only when you are creating a new metric // stream. If you are using this operation to update an existing metric stream, any // tags you specify in this parameter are ignored. To change the tags of an - // existing metric stream, use TagResource - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) - // or UntagResource - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). + // existing metric stream, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) + // or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_SetAlarmState.go b/service/cloudwatch/api_op_SetAlarmState.go index 37a95d009bc..b075f42412f 100644 --- a/service/cloudwatch/api_op_SetAlarmState.go +++ b/service/cloudwatch/api_op_SetAlarmState.go @@ -18,9 +18,8 @@ import ( // ALARM sends an SNS message. Metric alarms returns to their actual state quickly, // often within seconds. Because the metric alarm state change happens quickly, it // is typically only visible in the alarm's History tab in the Amazon CloudWatch -// console or through DescribeAlarmHistory -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html). -// If you use SetAlarmState on a composite alarm, the composite alarm is not +// console or through DescribeAlarmHistory (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html) +// . If you use SetAlarmState on a composite alarm, the composite alarm is not // guaranteed to return to its actual state. It returns to its actual state only // once any of its children alarms change state. It is also reevaluated if you // update its configuration. If an alarm triggers EC2 Auto Scaling policies or diff --git a/service/cloudwatch/api_op_TagResource.go b/service/cloudwatch/api_op_TagResource.go index ef0bc34498e..41f6fdae2f7 100644 --- a/service/cloudwatch/api_op_TagResource.go +++ b/service/cloudwatch/api_op_TagResource.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. -// Currently, the only CloudWatch resources that can be tagged are alarms and -// Contributor Insights rules. Tags can help you organize and categorize your +// Assigns one or more tags (key-value pairs) to the specified CloudWatch +// resource. Currently, the only CloudWatch resources that can be tagged are alarms +// and Contributor Insights rules. Tags can help you organize and categorize your // resources. You can also use them to scope user permissions by granting a user // permission to access or change only resources with certain tag values. Tags // don't have any semantic meaning to Amazon Web Services and are interpreted @@ -40,12 +40,11 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN of the CloudWatch resource that you're adding tags to. The ARN format of - // an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name The ARN + // The ARN of the CloudWatch resource that you're adding tags to. The ARN format + // of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name The ARN // format of a Contributor Insights rule is - // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more - // information about ARN format, see Resource Types Defined by Amazon CloudWatch - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) + // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more + // information about ARN format, see Resource Types Defined by Amazon CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) // in the Amazon Web Services General Reference. // // This member is required. diff --git a/service/cloudwatch/api_op_UntagResource.go b/service/cloudwatch/api_op_UntagResource.go index 2965eced46b..949cb12286c 100644 --- a/service/cloudwatch/api_op_UntagResource.go +++ b/service/cloudwatch/api_op_UntagResource.go @@ -29,11 +29,10 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The ARN of the CloudWatch resource that you're removing tags from. The ARN - // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name The - // ARN format of a Contributor Insights rule is - // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more - // information about ARN format, see Resource Types Defined by Amazon CloudWatch - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) + // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name + // The ARN format of a Contributor Insights rule is + // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more + // information about ARN format, see Resource Types Defined by Amazon CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies) // in the Amazon Web Services General Reference. // // This member is required. diff --git a/service/cloudwatch/types/enums.go b/service/cloudwatch/types/enums.go index 8ae0712b54c..a1c7e077c6c 100644 --- a/service/cloudwatch/types/enums.go +++ b/service/cloudwatch/types/enums.go @@ -30,9 +30,9 @@ const ( AlarmTypeMetricAlarm AlarmType = "MetricAlarm" ) -// Values returns all known values for AlarmType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AlarmType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AlarmType) Values() []AlarmType { return []AlarmType{ "CompositeAlarm", @@ -150,9 +150,9 @@ const ( MetricStreamOutputFormatOpenTelemetry07 MetricStreamOutputFormat = "opentelemetry0.7" ) -// Values returns all known values for MetricStreamOutputFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MetricStreamOutputFormat. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStreamOutputFormat) Values() []MetricStreamOutputFormat { return []MetricStreamOutputFormat{ "json", @@ -227,9 +227,9 @@ const ( StandardUnitNone StandardUnit = "None" ) -// Values returns all known values for StandardUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StandardUnit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StandardUnit) Values() []StandardUnit { return []StandardUnit{ "Seconds", @@ -293,9 +293,9 @@ const ( StatisticMaximum Statistic = "Maximum" ) -// Values returns all known values for Statistic. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Statistic. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Statistic) Values() []Statistic { return []Statistic{ "SampleCount", diff --git a/service/cloudwatch/types/types.go b/service/cloudwatch/types/types.go index 3aee60b2a08..66551500205 100644 --- a/service/cloudwatch/types/types.go +++ b/service/cloudwatch/types/types.go @@ -88,7 +88,7 @@ type AnomalyDetectorConfiguration struct { // automatically account for daylight savings time changes if the metric is // sensitive to such time changes. To specify a time zone, use the name of the time // zone as specified in the standard tz database. For more information, see tz - // database (https://en.wikipedia.org/wiki/Tz_database). + // database (https://en.wikipedia.org/wiki/Tz_database) . MetricTimezone *string noSmithyDocumentSerde @@ -101,15 +101,15 @@ type CompositeAlarm struct { // state. ActionsEnabled *bool - // When the value is ALARM, it means that the actions are suppressed because the - // suppressor alarm is in ALARM When the value is WaitPeriod, it means that the + // When the value is ALARM , it means that the actions are suppressed because the + // suppressor alarm is in ALARM When the value is WaitPeriod , it means that the // actions are suppressed because the composite alarm is waiting for the suppressor // alarm to go into into the ALARM state. The maximum waiting time is as specified - // in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs - // its actions. When the value is ExtensionPeriod, it means that the actions are + // in ActionsSuppressorWaitPeriod . After this time, the composite alarm performs + // its actions. When the value is ExtensionPeriod , it means that the actions are // suppressed because the composite alarm is waiting after the suppressor alarm // went out of the ALARM state. The maximum waiting time is as specified in - // ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs + // ActionsSuppressorExtensionPeriod . After this time, the composite alarm performs // its actions. ActionsSuppressedBy ActionsSuppressedBy @@ -122,9 +122,9 @@ type CompositeAlarm struct { ActionsSuppressor *string // The maximum time in seconds that the composite alarm waits after suppressor - // alarm goes out of the ALARM state. After this time, the composite alarm performs - // its actions. ExtensionPeriod is required only when ActionsSuppressor is - // specified. + // alarm goes out of the ALARM state. After this time, the composite alarm + // performs its actions. ExtensionPeriod is required only when ActionsSuppressor + // is specified. ActionsSuppressorExtensionPeriod *int32 // The maximum time in seconds that the composite alarm waits for the suppressor @@ -166,7 +166,7 @@ type CompositeAlarm struct { // An explanation for the alarm state, in JSON format. StateReasonData *string - // The timestamp of the last change to the alarm's StateValue. + // The timestamp of the last change to the alarm's StateValue . StateTransitionedTimestamp *time.Time // Tracks the timestamp of any state update, even if StateValue doesn't change. @@ -187,8 +187,8 @@ type DashboardEntry struct { // The name of the dashboard. DashboardName *string - // The time stamp of when the dashboard was last modified, either by an API call or - // through the console. This number is expressed as the number of milliseconds + // The time stamp of when the dashboard was last modified, either by an API call + // or through the console. This number is expressed as the number of milliseconds // since Jan 1, 1970 00:00:00 UTC. LastModified *time.Time @@ -225,8 +225,8 @@ type Datapoint struct { // The minimum metric value for the data point. Minimum *float64 - // The number of metric values that contributed to the aggregate value of this data - // point. + // The number of metric values that contributed to the aggregate value of this + // data point. SampleCount *float64 // The sum of the metric values for the data point. @@ -251,7 +251,7 @@ type Dimension struct { // The name of the dimension. Dimension names must contain only ASCII characters, // must include at least one non-whitespace character, and cannot start with a - // colon (:). ASCII control characters are not supported as part of dimension + // colon ( : ). ASCII control characters are not supported as part of dimension // names. // // This member is required. @@ -281,18 +281,17 @@ type DimensionFilter struct { noSmithyDocumentSerde } -// This structure contains the definition for a Contributor Insights rule. For more -// information about this rule, see Using Constributor Insights to analyze -// high-cardinality data -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) +// This structure contains the definition for a Contributor Insights rule. For +// more information about this rule, see Using Constributor Insights to analyze +// high-cardinality data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) // in the Amazon CloudWatch User Guide. type InsightRule struct { // The definition of the rule, as a JSON object. The definition contains the // keywords used to define contributors, the value to aggregate on if this rule // returns a sum instead of a count, and the filters. For details on the valid - // syntax, see Contributor Insights Rule Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html). + // syntax, see Contributor Insights Rule Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) + // . // // This member is required. Definition *string @@ -303,8 +302,8 @@ type InsightRule struct { Name *string // For rules that you create, this is always {"Name": "CloudWatchLogRule", - // "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": - // 1} + // "Version": 1} . For managed rules, this is {"Name": "ServiceLogRule", + // "Version": 1} // // This member is required. Schema *string @@ -320,12 +319,12 @@ type InsightRule struct { noSmithyDocumentSerde } -// One of the unique contributors found by a Contributor Insights rule. If the rule -// contains multiple keys, then a unique contributor is a unique combination of -// values from all the keys in the rule. If the rule contains a single key, then +// One of the unique contributors found by a Contributor Insights rule. If the +// rule contains multiple keys, then a unique contributor is a unique combination +// of values from all the keys in the rule. If the rule contains a single key, then // each unique contributor is each unique value for this key. For more information, -// see GetInsightRuleReport -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html). +// see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) +// . type InsightRuleContributor struct { // An approximation of the aggregate value that comes from this contributor. @@ -339,8 +338,8 @@ type InsightRuleContributor struct { // This member is required. Datapoints []InsightRuleContributorDatapoint - // One of the log entry field keywords that is used to define contributors for this - // rule. + // One of the log entry field keywords that is used to define contributors for + // this rule. // // This member is required. Keys []string @@ -349,10 +348,9 @@ type InsightRuleContributor struct { } // One data point related to one contributor. For more information, see -// GetInsightRuleReport -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) -// and InsightRuleContributor -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html). +// GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) +// and InsightRuleContributor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html) +// . type InsightRuleContributorDatapoint struct { // The approximate value that this contributor added during this timestamp. @@ -369,8 +367,8 @@ type InsightRuleContributorDatapoint struct { } // One data point from the metric time series returned in a Contributor Insights -// rule report. For more information, see GetInsightRuleReport -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html). +// rule report. For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) +// . type InsightRuleMetricDatapoint struct { // The timestamp of the data point. @@ -409,8 +407,8 @@ type InsightRuleMetricDatapoint struct { // Metrics array in your request. Sum *float64 - // The number of unique contributors who published data during this timestamp. This - // statistic is returned only if you included it in the Metrics array in your + // The number of unique contributors who published data during this timestamp. + // This statistic is returned only if you included it in the Metrics array in your // request. UniqueContributors *float64 @@ -421,8 +419,8 @@ type InsightRuleMetricDatapoint struct { // your time zone so that the labels that are associated with returned metrics // display the correct time for your time zone. The Timezone value affects a label // only if you have a time-based dynamic expression in the label. For more -// information about dynamic expressions in labels, see Using Dynamic Labels -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html). +// information about dynamic expressions in labels, see Using Dynamic Labels (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) +// . type LabelOptions struct { // The time zone to use for metric data return in this operation. The format is + @@ -439,14 +437,14 @@ type LabelOptions struct { // Insights rule for an Amazon Web Services resource. type ManagedRule struct { - // The ARN of an Amazon Web Services resource that has managed Contributor Insights - // rules. + // The ARN of an Amazon Web Services resource that has managed Contributor + // Insights rules. // // This member is required. ResourceARN *string // The template name for the managed Contributor Insights rule, as returned by - // ListManagedInsightRules. + // ListManagedInsightRules . // // This member is required. TemplateName *string @@ -459,27 +457,27 @@ type ManagedRule struct { // cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule // permission. If you are using this operation to update an existing Contributor // Insights rule, any tags that you specify in this parameter are ignored. To - // change the tags of an existing rule, use TagResource. + // change the tags of an existing rule, use TagResource . Tags []Tag noSmithyDocumentSerde } // Contains information about managed Contributor Insights rules, as returned by -// ListManagedInsightRules. +// ListManagedInsightRules . type ManagedRuleDescription struct { // If a managed rule is enabled, this is the ARN for the related Amazon Web // Services resource. ResourceARN *string - // Describes the state of a managed rule. If present, it contains information about - // the Contributor Insights rule that contains information about the related Amazon - // Web Services resource. + // Describes the state of a managed rule. If present, it contains information + // about the Contributor Insights rule that contains information about the related + // Amazon Web Services resource. RuleState *ManagedRuleState // The template name for the managed rule. Used to enable managed rules using - // PutManagedInsightRules. + // PutManagedInsightRules . TemplateName *string noSmithyDocumentSerde @@ -502,9 +500,9 @@ type ManagedRuleState struct { noSmithyDocumentSerde } -// A message returned by the GetMetricDataAPI, including a code and a description. +// A message returned by the GetMetricData API, including a code and a description. // If a cross-Region GetMetricData operation fails with a code of Forbidden and a -// value of Authentication too complex to retrieve cross region data, you can +// value of Authentication too complex to retrieve cross region data , you can // correct the problem by running the GetMetricData operation in the same Region // where the metric data is. type MessageData struct { @@ -566,7 +564,7 @@ type MetricAlarm struct { // The dimensions for the metric associated with the alarm. Dimensions []Dimension - // Used only for alarms based on percentiles. If ignore, the alarm state does not + // Used only for alarms based on percentiles. If ignore , the alarm state does not // change during periods with too few data points to be statistically significant. // If evaluate or this parameter is not used, the alarm is always evaluated and // possibly changes state no matter how many data points are available. @@ -575,11 +573,11 @@ type MetricAlarm struct { // The number of periods over which data is compared to the specified threshold. EvaluationPeriods *int32 - // If the value of this field is PARTIAL_DATA, the alarm is being evaluated based + // If the value of this field is PARTIAL_DATA , the alarm is being evaluated based // on only partial data. This happens if the query used for the alarm returns more - // than 10,000 metrics. For more information, see Create alarms on Metrics Insights - // queries - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html). + // than 10,000 metrics. For more information, see Create alarms on Metrics + // Insights queries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html) + // . EvaluationState EvaluationState // The percentile statistic for the metric associated with the alarm. Specify a @@ -591,8 +589,8 @@ type MetricAlarm struct { // (ARN). InsufficientDataActions []string - // The name of the metric associated with the alarm, if this is an alarm based on a - // single metric. + // The name of the metric associated with the alarm, if this is an alarm based on + // a single metric. MetricName *string // An array of MetricDataQuery structures, used in an alarm based on a metric math @@ -628,7 +626,7 @@ type MetricAlarm struct { StateValue StateValue // The statistic for the metric associated with the alarm, other than percentile. - // For percentile statistics, use ExtendedStatistic. + // For percentile statistics, use ExtendedStatistic . Statistic Statistic // The value to compare with the specified statistic. @@ -639,10 +637,9 @@ type MetricAlarm struct { ThresholdMetricId *string // Sets how this alarm is to handle missing data points. The valid values are - // breaching, notBreaching, ignore, and missing. For more information, see - // Configuring how CloudWatch alarms treat missing data - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). - // If this parameter is omitted, the default behavior of missing is used. + // breaching , notBreaching , ignore , and missing . For more information, see + // Configuring how CloudWatch alarms treat missing data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) + // . If this parameter is omitted, the default behavior of missing is used. TreatMissingData *string // The unit of the metric associated with the alarm. @@ -651,23 +648,22 @@ type MetricAlarm struct { noSmithyDocumentSerde } -// This structure is used in both GetMetricData and PutMetricAlarm. The supported +// This structure is used in both GetMetricData and PutMetricAlarm . The supported // use of this structure is different for those two operations. When used in -// GetMetricData, it indicates the metric data to return, and whether this call is +// GetMetricData , it indicates the metric data to return, and whether this call is // just retrieving a batch set of data for one metric, or is performing a Metrics // Insights query or a math expression. A single GetMetricData call can include up -// to 500 MetricDataQuery structures. When used in PutMetricAlarm, it enables you +// to 500 MetricDataQuery structures. When used in PutMetricAlarm , it enables you // to create an alarm based on a metric math expression. Each MetricDataQuery in // the array specifies either a metric to retrieve, or a math expression to be // performed on retrieved metrics. A single PutMetricAlarm call can include up to // 20 MetricDataQuery structures in the array. The 20 structures can include as // many as 10 structures that contain a MetricStat parameter to retrieve a metric, // and as many as 10 structures that contain the Expression parameter to perform a -// math expression. Of those Expression structures, one must have true as the value -// for ReturnData. The result of this expression is the value the alarm watches. -// Any expression used in a PutMetricAlarm operation must return a single time -// series. For more information, see Metric Math Syntax and Functions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) +// math expression. Of those Expression structures, one must have true as the +// value for ReturnData . The result of this expression is the value the alarm +// watches. Any expression used in a PutMetricAlarm operation must return a single +// time series. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) // in the Amazon CloudWatch User Guide. Some of the parameters of this structure // also have different uses whether you are using this structure in a GetMetricData // operation or a PutMetricAlarm operation. These differences are explained in the @@ -675,10 +671,11 @@ type MetricAlarm struct { type MetricDataQuery struct { // A short name used to tie this object to the results in the response. This name - // must be unique within a single call to GetMetricData. If you are performing math - // expressions on this set of data, this name represents that data and can serve as - // a variable in the mathematical expression. The valid characters are letters, - // numbers, and underscore. The first character must be a lowercase letter. + // must be unique within a single call to GetMetricData . If you are performing + // math expressions on this set of data, this name represents that data and can + // serve as a variable in the mathematical expression. The valid characters are + // letters, numbers, and underscore. The first character must be a lowercase + // letter. // // This member is required. Id *string @@ -692,13 +689,11 @@ type MetricDataQuery struct { // This field can contain either a Metrics Insights query, or a metric math // expression to be performed on the returned data. For more information about - // Metrics Insights queries, see Metrics Insights query components and syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) + // Metrics Insights queries, see Metrics Insights query components and syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) // in the Amazon CloudWatch User Guide. A math expression can use the Id of the // other metrics or queries to refer to those metrics, and can also use the Id of // other expressions to use the result of those expressions. For more information - // about metric math expressions, see Metric Math Syntax and Functions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) + // about metric math expressions, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) // in the Amazon CloudWatch User Guide. Within each MetricDataQuery object, you // must specify either Expression or MetricStat but not both. Expression *string @@ -708,8 +703,8 @@ type MetricDataQuery struct { // metric or expression is shown in a CloudWatch dashboard widget, the label is // shown. If Label is omitted, CloudWatch generates a default. You can put dynamic // expressions into a label, so that it is more descriptive. For more information, - // see Using Dynamic Labels - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html). + // see Using Dynamic Labels (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) + // . Label *string // The metric to be returned, along with statistics, period, and units. Use this @@ -723,16 +718,16 @@ type MetricDataQuery struct { // be a multiple of 60. For high-resolution metrics that are collected at intervals // of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of // 60. High-resolution metrics are those metrics stored by a PutMetricData - // operation that includes a StorageResolution of 1 second. + // operation that includes a StorageResolution of 1 second . Period *int32 - // When used in GetMetricData, this option indicates whether to return the + // When used in GetMetricData , this option indicates whether to return the // timestamps and raw data values of this metric. If you are performing this call // just to do math expressions and do not also need the raw data returned, you can - // specify false. If you omit this, the default of true is used. When used in - // PutMetricAlarm, specify true for the one expression result to use as the alarm. - // For all other metrics and expressions in the same PutMetricAlarm operation, - // specify ReturnData as False. + // specify false . If you omit this, the default of true is used. When used in + // PutMetricAlarm , specify true for the one expression result to use as the + // alarm. For all other metrics and expressions in the same PutMetricAlarm + // operation, specify ReturnData as False. ReturnData *bool noSmithyDocumentSerde @@ -754,10 +749,10 @@ type MetricDataResult struct { // The status of the returned data. Complete indicates that all data points in the // requested time range were returned. PartialData means that an incomplete set of - // data points were returned. You can use the NextToken value that was returned and - // repeat your request to get more data points. NextToken is not returned if you - // are performing a math expression. InternalError indicates that an error - // occurred. Retry your request using NextToken, if present. + // data points were returned. You can use the NextToken value that was returned + // and repeat your request to get more data points. NextToken is not returned if + // you are performing a math expression. InternalError indicates that an error + // occurred. Retry your request using NextToken , if present. StatusCode StatusCode // The timestamps for the data points, formatted in Unix timestamp format. The @@ -765,16 +760,16 @@ type MetricDataResult struct { // Timestamps[x] is Values[x]. Timestamps []time.Time - // The data points for the metric corresponding to Timestamps. The number of values - // always matches the number of timestamps and the timestamp for Values[x] is - // Timestamps[x]. + // The data points for the metric corresponding to Timestamps . The number of + // values always matches the number of timestamps and the timestamp for Values[x] + // is Timestamps[x]. Values []float64 noSmithyDocumentSerde } -// Encapsulates the information sent to either create a metric or add new values to -// be aggregated into an existing metric. +// Encapsulates the information sent to either create a metric or add new values +// to be aggregated into an existing metric. type MetricDatum struct { // The name of the metric. @@ -785,8 +780,8 @@ type MetricDatum struct { // Array of numbers that is used along with the Values array. Each number in the // Count array is the number of times the corresponding value in the Values array // occurred during the period. If you omit the Counts array, the default of 1 is - // used as the value for each count. If you include a Counts array, it must include - // the same amount of values as the Values array. + // used as the value for each count. If you include a Counts array, it must + // include the same amount of values as the Values array. Counts []float64 // The dimensions associated with the metric. @@ -800,8 +795,7 @@ type MetricDatum struct { // resolution down to one second. Setting this to 60 specifies this metric as a // regular-resolution metric, which CloudWatch stores at 1-minute resolution. // Currently, high resolution is available only for custom metrics. For more - // information about high-resolution metrics, see High-Resolution Metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) + // information about high-resolution metrics, see High-Resolution Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) // in the Amazon CloudWatch User Guide. This field is optional, if you do not // specify it the default of 60 is used. StorageResolution *int32 @@ -815,19 +809,19 @@ type MetricDatum struct { // the metric. Unit StandardUnit - // The value for the metric. Although the parameter accepts numbers of type Double, - // CloudWatch rejects values that are either too small or too large. Values must be - // in the range of -2^360 to 2^360. In addition, special values (for example, NaN, - // +Infinity, -Infinity) are not supported. + // The value for the metric. Although the parameter accepts numbers of type + // Double, CloudWatch rejects values that are either too small or too large. Values + // must be in the range of -2^360 to 2^360. In addition, special values (for + // example, NaN, +Infinity, -Infinity) are not supported. Value *float64 // Array of numbers representing the values for the metric during the period. Each // unique value is listed just once in this array, and the corresponding number in // the Counts array specifies the number of times that value occurred during the // period. You can include up to 150 unique values in each PutMetricData action - // that specifies a Values array. Although the Values array accepts numbers of type - // Double, CloudWatch rejects values that are either too small or too large. Values - // must be in the range of -2^360 to 2^360. In addition, special values (for + // that specifies a Values array. Although the Values array accepts numbers of + // type Double , CloudWatch rejects values that are either too small or too large. + // Values must be in the range of -2^360 to 2^360. In addition, special values (for // example, NaN, +Infinity, -Infinity) are not supported. Values []float64 @@ -844,8 +838,9 @@ type MetricMathAnomalyDetector struct { // MetricDataQueries gets a metric or performs a math expression. One item in // MetricDataQueries is the expression that provides the time series that the // anomaly detector uses as input. Designate the expression by setting ReturnData - // to true for this object in the array. For all other expressions and metrics, set - // ReturnData to false. The designated expression must return a single time series. + // to true for this object in the array. For all other expressions and metrics, + // set ReturnData to false . The designated expression must return a single time + // series. MetricDataQueries []MetricDataQuery noSmithyDocumentSerde @@ -868,16 +863,12 @@ type MetricStat struct { // that includes a StorageResolution of 1 second. If the StartTime parameter // specifies a time stamp that is greater than 3 hours ago, you must specify the // period as follows or no data points in that time range is returned: - // - // * Start - // time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 - // minute). - // - // * Start time between 15 and 63 days ago - Use a multiple of 300 - // seconds (5 minutes). - // - // * Start time greater than 63 days ago - Use a multiple of - // 3600 seconds (1 hour). + // - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + // (1 minute). + // - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + // minutes). + // - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + // hour). // // This member is required. Period *int32 @@ -920,10 +911,10 @@ type MetricStreamEntry struct { Name *string // The output format of this metric stream. Valid values are json and - // opentelemetry0.7. + // opentelemetry0.7 . OutputFormat MetricStreamOutputFormat - // The current state of this stream. Valid values are running and stopped. + // The current state of this stream. Valid values are running and stopped . State *string noSmithyDocumentSerde @@ -941,22 +932,22 @@ type MetricStreamFilter struct { noSmithyDocumentSerde } -// By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT +// By default, a metric stream always sends the MAX , MIN , SUM , and SAMPLECOUNT // statistics for each metric that is streamed. This structure contains information // for one metric that includes additional statistics in the stream. For more -// information about statistics, see CloudWatch, listed in CloudWatch statistics -// definitions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). +// information about statistics, see CloudWatch, listed in CloudWatch statistics +// definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) +// . type MetricStreamStatisticsConfiguration struct { - // The list of additional statistics that are to be streamed for the metrics listed - // in the IncludeMetrics array in this structure. This list can include as many as - // 20 statistics. If the OutputFormat for the stream is opentelemetry0.7, the only - // valid values are p?? percentile statistics such as p90, p99 and so on. If the - // OutputFormat for the stream is json, the valid values include the abbreviations - // for all of the statistics listed in CloudWatch statistics definitions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). - // For example, this includes tm98, wm90, PR(:300), and so on. + // The list of additional statistics that are to be streamed for the metrics + // listed in the IncludeMetrics array in this structure. This list can include as + // many as 20 statistics. If the OutputFormat for the stream is opentelemetry0.7 , + // the only valid values are p?? percentile statistics such as p90 , p99 and so + // on. If the OutputFormat for the stream is json , the valid values include the + // abbreviations for all of the statistics listed in CloudWatch statistics + // definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html) + // . For example, this includes tm98, wm90 , PR(:300) , and so on. // // This member is required. AdditionalStatistics []string @@ -1010,18 +1001,18 @@ type PartialFailure struct { noSmithyDocumentSerde } -// Specifies one range of days or times to exclude from use for training an anomaly -// detection model. +// Specifies one range of days or times to exclude from use for training an +// anomaly detection model. type Range struct { - // The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For - // example, 2019-07-01T23:59:59. + // The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . For + // example, 2019-07-01T23:59:59 . // // This member is required. EndTime *time.Time - // The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For - // example, 2019-07-01T23:59:59. + // The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss . + // For example, 2019-07-01T23:59:59 . // // This member is required. StartTime *time.Time @@ -1029,8 +1020,8 @@ type Range struct { noSmithyDocumentSerde } -// Designates the CloudWatch metric and statistic that provides the time series the -// anomaly detector uses as input. +// Designates the CloudWatch metric and statistic that provides the time series +// the anomaly detector uses as input. type SingleMetricAnomalyDetector struct { // The metric dimensions to create the anomaly detection model for. diff --git a/service/cloudwatchevents/api_client.go b/service/cloudwatchevents/api_client.go index ffbea67852a..bf7d63897bc 100644 --- a/service/cloudwatchevents/api_client.go +++ b/service/cloudwatchevents/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudwatchevents/api_op_ActivateEventSource.go b/service/cloudwatchevents/api_op_ActivateEventSource.go index 9253d30a4ab..5dff282536f 100644 --- a/service/cloudwatchevents/api_op_ActivateEventSource.go +++ b/service/cloudwatchevents/api_op_ActivateEventSource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Activates a partner event source that has been deactivated. Once activated, your -// matching event bus will start receiving events from the event source. +// Activates a partner event source that has been deactivated. Once activated, +// your matching event bus will start receiving events from the event source. func (c *Client) ActivateEventSource(ctx context.Context, params *ActivateEventSourceInput, optFns ...func(*Options)) (*ActivateEventSourceOutput, error) { if params == nil { params = &ActivateEventSourceInput{} diff --git a/service/cloudwatchevents/api_op_CreateApiDestination.go b/service/cloudwatchevents/api_op_CreateApiDestination.go index c6129373c05..18f6b12fc17 100644 --- a/service/cloudwatchevents/api_op_CreateApiDestination.go +++ b/service/cloudwatchevents/api_op_CreateApiDestination.go @@ -12,8 +12,8 @@ import ( "time" ) -// Creates an API destination, which is an HTTP invocation endpoint configured as a -// target for events. +// Creates an API destination, which is an HTTP invocation endpoint configured as +// a target for events. func (c *Client) CreateApiDestination(ctx context.Context, params *CreateApiDestinationInput, optFns ...func(*Options)) (*CreateApiDestinationOutput, error) { if params == nil { params = &CreateApiDestinationInput{} diff --git a/service/cloudwatchevents/api_op_CreateArchive.go b/service/cloudwatchevents/api_op_CreateArchive.go index b78b541af08..64e2c0703cf 100644 --- a/service/cloudwatchevents/api_op_CreateArchive.go +++ b/service/cloudwatchevents/api_op_CreateArchive.go @@ -50,8 +50,8 @@ type CreateArchiveInput struct { // An event pattern to use to filter events sent to the archive. EventPattern *string - // The number of days to retain events for. Default value is 0. If set to 0, events - // are retained indefinitely + // The number of days to retain events for. Default value is 0. If set to 0, + // events are retained indefinitely RetentionDays *int32 noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_CreateEventBus.go b/service/cloudwatchevents/api_op_CreateEventBus.go index 47307c9c500..edd53e247b6 100644 --- a/service/cloudwatchevents/api_op_CreateEventBus.go +++ b/service/cloudwatchevents/api_op_CreateEventBus.go @@ -40,8 +40,8 @@ type CreateEventBusInput struct { // This member is required. Name *string - // If you are creating a partner event bus, this specifies the partner event source - // that the new event bus will be matched with. + // If you are creating a partner event bus, this specifies the partner event + // source that the new event bus will be matched with. EventSourceName *string // Tags to associate with the event bus. diff --git a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go index 12c5890e117..0594a217c94 100644 --- a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go @@ -20,7 +20,7 @@ import ( // partner event bus that matches the partner event source can use that event bus // to receive events from the partner, and then process them using Amazon Web // Services Events rules and targets. Partner event source names follow this -// format: partner_name/event_namespace/event_name partner_name is determined +// format: partner_name/event_namespace/event_name partner_name is determined // during partner registration and identifies the partner to Amazon Web Services // customers. event_namespace is determined by the partner and is a way for the // partner to categorize their events. event_name is determined by the partner, and @@ -52,7 +52,7 @@ type CreatePartnerEventSourceInput struct { Account *string // The name of the partner event source. This name must be unique and must be in - // the format partner_name/event_namespace/event_name . The Amazon Web Services + // the format partner_name/event_namespace/event_name . The Amazon Web Services // account that wants to use this partner event source must create a partner event // bus with a name that matches the name of the partner event source. // diff --git a/service/cloudwatchevents/api_op_DeactivateEventSource.go b/service/cloudwatchevents/api_op_DeactivateEventSource.go index a091c981342..82194a26e6d 100644 --- a/service/cloudwatchevents/api_op_DeactivateEventSource.go +++ b/service/cloudwatchevents/api_op_DeactivateEventSource.go @@ -14,8 +14,8 @@ import ( // specified partner event source. The matching event bus is not deleted. When you // deactivate a partner event source, the source goes into PENDING state. If it // remains in PENDING state for more than two weeks, it is deleted. To activate a -// deactivated partner event source, use ActivateEventSource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html). +// deactivated partner event source, use ActivateEventSource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html) +// . func (c *Client) DeactivateEventSource(ctx context.Context, params *DeactivateEventSourceInput, optFns ...func(*Options)) (*DeactivateEventSourceOutput, error) { if params == nil { params = &DeactivateEventSourceInput{} diff --git a/service/cloudwatchevents/api_op_DeleteRule.go b/service/cloudwatchevents/api_op_DeleteRule.go index 12c7eb01216..e8954c29dd2 100644 --- a/service/cloudwatchevents/api_op_DeleteRule.go +++ b/service/cloudwatchevents/api_op_DeleteRule.go @@ -11,9 +11,8 @@ import ( ) // Deletes the specified rule. Before you can delete the rule, you must remove all -// targets, using RemoveTargets -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html). -// When you delete a rule, incoming events might continue to match to the deleted +// targets, using RemoveTargets (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html) +// . When you delete a rule, incoming events might continue to match to the deleted // rule. Allow a short period of time for changes to take effect. If you call // delete rule multiple times for the same rule, all calls will succeed. When you // call delete rule for a non-existent custom eventbus, ResourceNotFoundException @@ -44,15 +43,15 @@ type DeleteRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // If this is a managed rule, created by an Amazon Web Services service on your // behalf, you must specify Force as True to delete the rule. This parameter is // ignored for rules that are not managed rules. You can check whether a rule is a - // managed rule by using DescribeRule or ListRules and checking the ManagedBy field - // of the response. + // managed rule by using DescribeRule or ListRules and checking the ManagedBy + // field of the response. Force bool noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_DescribeEventBus.go b/service/cloudwatchevents/api_op_DescribeEventBus.go index f82a33c9ee0..b6f63b8e230 100644 --- a/service/cloudwatchevents/api_op_DescribeEventBus.go +++ b/service/cloudwatchevents/api_op_DescribeEventBus.go @@ -15,10 +15,9 @@ import ( // default event bus, and the associated policy. For custom event buses and partner // event buses, it displays the name, ARN, policy, state, and creation time. To // enable your account to receive events from other accounts on its default event -// bus, use PutPermission -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html). -// For more information about partner event buses, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). +// bus, use PutPermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) +// . For more information about partner event buses, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . func (c *Client) DescribeEventBus(ctx context.Context, params *DescribeEventBusInput, optFns ...func(*Options)) (*DescribeEventBusOutput, error) { if params == nil { params = &DescribeEventBusInput{} @@ -49,7 +48,7 @@ type DescribeEventBusOutput struct { // current account. Arn *string - // The name of the event bus. Currently, this is always default. + // The name of the event bus. Currently, this is always default . Name *string // The policy that enables the external account to send events to your account. diff --git a/service/cloudwatchevents/api_op_DescribePartnerEventSource.go b/service/cloudwatchevents/api_op_DescribePartnerEventSource.go index 6d96453b3ba..e349c99a985 100644 --- a/service/cloudwatchevents/api_op_DescribePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_DescribePartnerEventSource.go @@ -12,8 +12,7 @@ import ( // An SaaS partner can use this operation to list details about a partner event // source that they have created. Amazon Web Services customers do not use this -// operation. Instead, Amazon Web Services customers can use DescribeEventSource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) +// operation. Instead, Amazon Web Services customers can use DescribeEventSource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) // to see details about a partner event source that is shared with them. func (c *Client) DescribePartnerEventSource(ctx context.Context, params *DescribePartnerEventSourceInput, optFns ...func(*Options)) (*DescribePartnerEventSourceOutput, error) { if params == nil { diff --git a/service/cloudwatchevents/api_op_DescribeReplay.go b/service/cloudwatchevents/api_op_DescribeReplay.go index 0f11b64c5e5..3b1b7397886 100644 --- a/service/cloudwatchevents/api_op_DescribeReplay.go +++ b/service/cloudwatchevents/api_op_DescribeReplay.go @@ -14,8 +14,8 @@ import ( // Retrieves details about a replay. Use DescribeReplay to determine the progress // of a running replay. A replay processes events to replay based on the time in -// the event, and replays them using 1 minute intervals. If you use StartReplay and -// specify an EventStartTime and an EventEndTime that covers a 20 minute time +// the event, and replays them using 1 minute intervals. If you use StartReplay +// and specify an EventStartTime and an EventEndTime that covers a 20 minute time // range, the events are replayed from the first minute of that 20 minute range // first. Then the events from the second minute are replayed. You can use // DescribeReplay to determine the progress of a replay. The value returned for diff --git a/service/cloudwatchevents/api_op_DescribeRule.go b/service/cloudwatchevents/api_op_DescribeRule.go index 81e04ebf328..df0abf20f36 100644 --- a/service/cloudwatchevents/api_op_DescribeRule.go +++ b/service/cloudwatchevents/api_op_DescribeRule.go @@ -12,8 +12,8 @@ import ( ) // Describes the specified rule. DescribeRule does not list the targets of a rule. -// To see the targets associated with a rule, use ListTargetsByRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html). +// To see the targets associated with a rule, use ListTargetsByRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html) +// . func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, optFns ...func(*Options)) (*DescribeRuleOutput, error) { if params == nil { params = &DescribeRuleInput{} @@ -36,8 +36,8 @@ type DescribeRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde @@ -61,8 +61,7 @@ type DescribeRuleOutput struct { // The name of the event bus associated with the rule. EventBusName *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string diff --git a/service/cloudwatchevents/api_op_DisableRule.go b/service/cloudwatchevents/api_op_DisableRule.go index 974770cf054..183521e4651 100644 --- a/service/cloudwatchevents/api_op_DisableRule.go +++ b/service/cloudwatchevents/api_op_DisableRule.go @@ -36,8 +36,8 @@ type DisableRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_EnableRule.go b/service/cloudwatchevents/api_op_EnableRule.go index 5b44ba4a0ba..e0834a84dee 100644 --- a/service/cloudwatchevents/api_op_EnableRule.go +++ b/service/cloudwatchevents/api_op_EnableRule.go @@ -35,8 +35,8 @@ type EnableRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_ListApiDestinations.go b/service/cloudwatchevents/api_op_ListApiDestinations.go index baeb4ffc5c2..283072dd466 100644 --- a/service/cloudwatchevents/api_op_ListApiDestinations.go +++ b/service/cloudwatchevents/api_op_ListApiDestinations.go @@ -35,8 +35,8 @@ type ListApiDestinationsInput struct { // The maximum number of API destinations to include in the response. Limit *int32 - // A name prefix to filter results returned. Only API destinations with a name that - // starts with the prefix are returned. + // A name prefix to filter results returned. Only API destinations with a name + // that starts with the prefix are returned. NamePrefix *string // The token returned by a previous call to retrieve the next set of results. diff --git a/service/cloudwatchevents/api_op_ListEventSources.go b/service/cloudwatchevents/api_op_ListEventSources.go index b1317ead9b1..09081508c39 100644 --- a/service/cloudwatchevents/api_op_ListEventSources.go +++ b/service/cloudwatchevents/api_op_ListEventSources.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You can use this to see all the partner event sources that have been shared with -// your Amazon Web Services account. For more information about partner event -// sources, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). +// You can use this to see all the partner event sources that have been shared +// with your Amazon Web Services account. For more information about partner event +// sources, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . func (c *Client) ListEventSources(ctx context.Context, params *ListEventSourcesInput, optFns ...func(*Options)) (*ListEventSourcesOutput, error) { if params == nil { params = &ListEventSourcesInput{} diff --git a/service/cloudwatchevents/api_op_ListPartnerEventSources.go b/service/cloudwatchevents/api_op_ListPartnerEventSources.go index 79b9ef5ed90..5ef47d3f0ce 100644 --- a/service/cloudwatchevents/api_op_ListPartnerEventSources.go +++ b/service/cloudwatchevents/api_op_ListPartnerEventSources.go @@ -31,8 +31,8 @@ func (c *Client) ListPartnerEventSources(ctx context.Context, params *ListPartne type ListPartnerEventSourcesInput struct { - // If you specify this, the results are limited to only those partner event sources - // that start with the string you specify. + // If you specify this, the results are limited to only those partner event + // sources that start with the string you specify. // // This member is required. NamePrefix *string diff --git a/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go b/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go index 51ebbe59733..c96030599f0 100644 --- a/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go +++ b/service/cloudwatchevents/api_op_ListRuleNamesByTarget.go @@ -49,8 +49,8 @@ type ListRuleNamesByTargetInput struct { type ListRuleNamesByTargetOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The names of the rules that can invoke the given target. diff --git a/service/cloudwatchevents/api_op_ListRules.go b/service/cloudwatchevents/api_op_ListRules.go index cc8670dffff..847ec71de87 100644 --- a/service/cloudwatchevents/api_op_ListRules.go +++ b/service/cloudwatchevents/api_op_ListRules.go @@ -14,8 +14,8 @@ import ( // Lists your Amazon EventBridge rules. You can either list all the rules or you // can provide a prefix to match to the rule names. ListRules does not list the // targets of a rule. To see the targets associated with a rule, use -// ListTargetsByRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html). +// ListTargetsByRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html) +// . func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} @@ -51,8 +51,8 @@ type ListRulesInput struct { type ListRulesOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The rules that match the specified criteria. diff --git a/service/cloudwatchevents/api_op_ListTagsForResource.go b/service/cloudwatchevents/api_op_ListTagsForResource.go index 4de4bdb5cd6..01549d648ae 100644 --- a/service/cloudwatchevents/api_op_ListTagsForResource.go +++ b/service/cloudwatchevents/api_op_ListTagsForResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays the tags associated with an EventBridge resource. In EventBridge, rules -// and event buses can be tagged. +// Displays the tags associated with an EventBridge resource. In EventBridge, +// rules and event buses can be tagged. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/cloudwatchevents/api_op_ListTargetsByRule.go b/service/cloudwatchevents/api_op_ListTargetsByRule.go index 51857445ce4..c094e4cf73a 100644 --- a/service/cloudwatchevents/api_op_ListTargetsByRule.go +++ b/service/cloudwatchevents/api_op_ListTargetsByRule.go @@ -34,8 +34,8 @@ type ListTargetsByRuleInput struct { // This member is required. Rule *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // The maximum number of results to return. @@ -49,8 +49,8 @@ type ListTargetsByRuleInput struct { type ListTargetsByRuleOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The targets assigned to the rule. diff --git a/service/cloudwatchevents/api_op_PutPartnerEvents.go b/service/cloudwatchevents/api_op_PutPartnerEvents.go index 4ad771df5c6..81fdabf4221 100644 --- a/service/cloudwatchevents/api_op_PutPartnerEvents.go +++ b/service/cloudwatchevents/api_op_PutPartnerEvents.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is used by SaaS partners to write events to a customer's partner event bus. -// Amazon Web Services customers do not use this operation. +// This is used by SaaS partners to write events to a customer's partner event +// bus. Amazon Web Services customers do not use this operation. func (c *Client) PutPartnerEvents(ctx context.Context, params *PutPartnerEventsInput, optFns ...func(*Options)) (*PutPartnerEventsOutput, error) { if params == nil { params = &PutPartnerEventsInput{} diff --git a/service/cloudwatchevents/api_op_PutPermission.go b/service/cloudwatchevents/api_op_PutPermission.go index 1be6cc48d49..61beacf6c61 100644 --- a/service/cloudwatchevents/api_op_PutPermission.go +++ b/service/cloudwatchevents/api_op_PutPermission.go @@ -20,13 +20,12 @@ import ( // Services accounts to put events to your event bus, run PutPermission once for // each of these accounts. Or, if all the accounts are members of the same Amazon // Web Services organization, you can run PutPermission once specifying Principal -// as "*" and specifying the Amazon Web Services organization ID in Condition, to +// as "*" and specifying the Amazon Web Services organization ID in Condition , to // grant permissions to all accounts in that organization. If you grant permissions // using an organization, then accounts in that organization must specify a RoleArn // with proper permissions when they use PutTarget to add your account's event bus // as a target. For more information, see Sending and Receiving Events Between -// Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. The permission policy on the event bus // cannot exceed 10 KB in size. func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { @@ -52,12 +51,11 @@ type PutPermissionInput struct { // This parameter enables you to limit the permission to accounts that fulfill a // certain condition, such as being a member of a certain Amazon Web Services // organization. For more information about Amazon Web Services Organizations, see - // What Is Amazon Web Services Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) + // What Is Amazon Web Services Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) // in the Amazon Web Services Organizations User Guide. If you specify Condition // with an Amazon Web Services organization ID, and specify "*" as the value for - // Principal, you grant permission to all the accounts in the named organization. - // The Condition is a JSON string which must contain Type, Key, and Value fields. + // Principal , you grant permission to all the accounts in the named organization. + // The Condition is a JSON string which must contain Type , Key , and Value fields. Condition *types.Condition // The name of the event bus associated with the rule. If you omit this, the @@ -65,14 +63,14 @@ type PutPermissionInput struct { EventBusName *string // A JSON string that describes the permission policy statement. You can include a - // Policy parameter in the request instead of using the StatementId, Action, - // Principal, or Condition parameters. + // Policy parameter in the request instead of using the StatementId , Action , + // Principal , or Condition parameters. Policy *string // The 12-digit Amazon Web Services account ID that you are permitting to put // events to your default event bus. Specify "*" to permit any account to put // events to your default event bus. If you specify "*" without specifying - // Condition, avoid creating rules that may match undesirable events. To create + // Condition , avoid creating rules that may match undesirable events. To create // more secure rules, make sure that the event pattern for each rule contains an // account field with a specific account ID from which to receive events. Rules // with an account field do not match any events sent from other accounts. @@ -80,8 +78,8 @@ type PutPermissionInput struct { // An identifier string for the external account that you are granting permissions // to. If you later want to revoke the permission for this external account, - // specify this StatementId when you run RemovePermission - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html). + // specify this StatementId when you run RemovePermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) + // . StatementId *string noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_PutRule.go b/service/cloudwatchevents/api_op_PutRule.go index b8ad74db549..177ec812403 100644 --- a/service/cloudwatchevents/api_op_PutRule.go +++ b/service/cloudwatchevents/api_op_PutRule.go @@ -11,37 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates the specified rule. Rules are enabled by default, or based on -// value of the state. You can disable a rule using DisableRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html). -// A single rule watches for events from a single event bus. Events generated by +// Creates or updates the specified rule. Rules are enabled by default, or based +// on value of the state. You can disable a rule using DisableRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) +// . A single rule watches for events from a single event bus. Events generated by // Amazon Web Services services go to your account's default event bus. Events // generated by SaaS partner services or applications go to the matching partner // event bus. If you have custom applications or services, you can specify whether // their events go to your default event bus or a custom event bus that you have -// created. For more information, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). -// If you are updating an existing rule, the rule is replaced with what you specify -// in this PutRule command. If you omit arguments in PutRule, the old values for -// those arguments are not kept. Instead, they are replaced with null values. When -// you create or update a rule, incoming events might not immediately start -// matching to new or updated rules. Allow a short period of time for changes to -// take effect. A rule must contain at least an EventPattern or ScheduleExpression. -// Rules with EventPatterns are triggered when a matching event is observed. Rules -// with ScheduleExpressions self-trigger based on the given schedule. A rule can -// have both an EventPattern and a ScheduleExpression, in which case the rule -// triggers on matching events as well as on a schedule. When you initially create -// a rule, you can optionally assign one or more tags to the rule. Tags can help -// you organize and categorize your resources. You can also use them to scope user -// permissions, by granting a user permission to access or change only rules with -// certain tag values. To use the PutRule operation and assign tags, you must have -// both the events:PutRule and events:TagResource permissions. If you are updating -// an existing rule, any tags you specify in the PutRule operation are ignored. To -// update the tags of an existing rule, use TagResource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) -// and UntagResource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html). -// Most services in Amazon Web Services treat : or / as the same character in +// created. For more information, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . If you are updating an existing rule, the rule is replaced with what you +// specify in this PutRule command. If you omit arguments in PutRule , the old +// values for those arguments are not kept. Instead, they are replaced with null +// values. When you create or update a rule, incoming events might not immediately +// start matching to new or updated rules. Allow a short period of time for changes +// to take effect. A rule must contain at least an EventPattern or +// ScheduleExpression. Rules with EventPatterns are triggered when a matching event +// is observed. Rules with ScheduleExpressions self-trigger based on the given +// schedule. A rule can have both an EventPattern and a ScheduleExpression, in +// which case the rule triggers on matching events as well as on a schedule. When +// you initially create a rule, you can optionally assign one or more tags to the +// rule. Tags can help you organize and categorize your resources. You can also use +// them to scope user permissions, by granting a user permission to access or +// change only rules with certain tag values. To use the PutRule operation and +// assign tags, you must have both the events:PutRule and events:TagResource +// permissions. If you are updating an existing rule, any tags you specify in the +// PutRule operation are ignored. To update the tags of an existing rule, use +// TagResource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) +// and UntagResource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html) +// . Most services in Amazon Web Services treat : or / as the same character in // Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event // patterns and rules. Be sure to use the correct ARN characters when creating // event patterns so that they match the ARN syntax in the event you want to match. @@ -55,8 +52,8 @@ import ( // after any change. An infinite loop can quickly cause higher than expected // charges. We recommend that you use budgeting, which alerts you when charges // exceed your specified limit. For more information, see Managing Your Costs with -// Budgets -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html). +// Budgets (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) +// . func (c *Client) PutRule(ctx context.Context, params *PutRuleInput, optFns ...func(*Options)) (*PutRuleOutput, error) { if params == nil { params = &PutRuleInput{} @@ -86,8 +83,7 @@ type PutRuleInput struct { // the default event bus is used. EventBusName *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string diff --git a/service/cloudwatchevents/api_op_PutTargets.go b/service/cloudwatchevents/api_op_PutTargets.go index 0d70dea7aaf..f98d49d4934 100644 --- a/service/cloudwatchevents/api_op_PutTargets.go +++ b/service/cloudwatchevents/api_op_PutTargets.go @@ -11,136 +11,91 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified targets to the specified rule, or updates the targets if they -// are already associated with the rule. Targets are the resources that are invoked -// when a rule is triggered. You can configure the following as targets for +// Adds the specified targets to the specified rule, or updates the targets if +// they are already associated with the rule. Targets are the resources that are +// invoked when a rule is triggered. You can configure the following as targets for // Events: -// -// * API destination -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) -// -// * -// Amazon API Gateway REST API endpoints -// -// * API Gateway -// -// * Batch job queue -// -// * -// CloudWatch Logs group -// -// * CodeBuild project -// -// * CodePipeline -// -// * Amazon EC2 -// CreateSnapshot API call -// -// * Amazon EC2 RebootInstances API call -// -// * Amazon EC2 -// StopInstances API call -// -// * Amazon EC2 TerminateInstances API call -// -// * Amazon ECS -// tasks -// -// * Event bus in a different Amazon Web Services account or Region. You can -// use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) -// us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. -// -// * -// Firehose delivery stream (Kinesis Data Firehose) -// -// * Inspector assessment -// template (Amazon Inspector) -// -// * Kinesis stream (Kinesis Data Stream) -// -// * Lambda -// function -// -// * Redshift clusters (Data API statement execution) -// -// * Amazon SNS -// topic -// -// * Amazon SQS queues (includes FIFO queues -// -// * SSM Automation -// -// * SSM -// OpsItem -// -// * SSM Run Command -// -// * Step Functions state machines -// -// Creating rules with -// built-in targets is supported only in the Management Console. The built-in -// targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 -// StopInstances API call, and EC2 TerminateInstances API call. For some target -// types, PutTargets provides target-specific parameters. If the target is a -// Kinesis data stream, you can optionally specify which shard the event goes to by -// using the KinesisParameters argument. To invoke a command on multiple EC2 -// instances with one rule, you can use the RunCommandParameters field. To be able -// to make API calls against the resources that you own, Amazon EventBridge needs -// the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge -// relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step -// Functions state machines and API Gateway REST APIs, EventBridge relies on IAM -// roles that you specify in the RoleARN argument in PutTargets. For more -// information, see Authentication and Access Control -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) +// - API destination (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) +// - Amazon API Gateway REST API endpoints +// - API Gateway +// - Batch job queue +// - CloudWatch Logs group +// - CodeBuild project +// - CodePipeline +// - Amazon EC2 CreateSnapshot API call +// - Amazon EC2 RebootInstances API call +// - Amazon EC2 StopInstances API call +// - Amazon EC2 TerminateInstances API call +// - Amazon ECS tasks +// - Event bus in a different Amazon Web Services account or Region. You can use +// an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, +// or Europe (Ireland) eu-west-1 Regions as a target for a rule. +// - Firehose delivery stream (Kinesis Data Firehose) +// - Inspector assessment template (Amazon Inspector) +// - Kinesis stream (Kinesis Data Stream) +// - Lambda function +// - Redshift clusters (Data API statement execution) +// - Amazon SNS topic +// - Amazon SQS queues (includes FIFO queues +// - SSM Automation +// - SSM OpsItem +// - SSM Run Command +// - Step Functions state machines +// +// Creating rules with built-in targets is supported only in the Management +// Console. The built-in targets are EC2 CreateSnapshot API call , EC2 +// RebootInstances API call , EC2 StopInstances API call , and EC2 +// TerminateInstances API call . For some target types, PutTargets provides +// target-specific parameters. If the target is a Kinesis data stream, you can +// optionally specify which shard the event goes to by using the KinesisParameters +// argument. To invoke a command on multiple EC2 instances with one rule, you can +// use the RunCommandParameters field. To be able to make API calls against the +// resources that you own, Amazon EventBridge needs the appropriate permissions. +// For Lambda and Amazon SNS resources, EventBridge relies on resource-based +// policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines +// and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in +// the RoleARN argument in PutTargets . For more information, see Authentication +// and Access Control (https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) // in the Amazon EventBridge User Guide. If another Amazon Web Services account is -// in the same region and has granted you permission (using PutPermission), you can -// send events to that account. Set that account's event bus as a target of the +// in the same region and has granted you permission (using PutPermission ), you +// can send events to that account. Set that account's event bus as a target of the // rules in your account. To send the matched events to the other account, specify -// that account's event bus as the Arn value when you run PutTargets. If your +// that account's event bus as the Arn value when you run PutTargets . If your // account sends events to another account, your account is charged for each sent // event. Each event sent to another account is charged as a custom event. The // account receiving the event is not charged. For more information, see Amazon -// EventBridge Pricing (http://aws.amazon.com/eventbridge/pricing/). Input, -// InputPath, and InputTransformer are not available with PutTarget if the target +// EventBridge Pricing (http://aws.amazon.com/eventbridge/pricing/) . Input , +// InputPath , and InputTransformer are not available with PutTarget if the target // is an event bus of a different Amazon Web Services account. If you are setting // the event bus of another account as the target, and that account granted // permission to your account through an organization instead of directly by the // account ID, then you must specify a RoleArn with proper permissions in the -// Target structure. For more information, see Sending and Receiving Events Between -// Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Target structure. For more information, see Sending and Receiving Events +// Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. For more information about enabling -// cross-account events, see PutPermission -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html). -// Input, InputPath, and InputTransformer are mutually exclusive and optional +// cross-account events, see PutPermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) +// . Input, InputPath, and InputTransformer are mutually exclusive and optional // parameters of a target. When a rule is triggered due to a matched event: -// -// * If -// none of the following arguments are specified for a target, then the entire -// event is passed to the target in JSON format (unless the target is Amazon EC2 -// Run Command or Amazon ECS task, in which case nothing from the event is passed -// to the target). -// -// * If Input is specified in the form of valid JSON, then the -// matched event is overridden with this constant. -// -// * If InputPath is specified in -// the form of JSONPath (for example, $.detail), then only the part of the event -// specified in the path is passed to the target (for example, only the detail part -// of the event is passed). -// -// * If InputTransformer is specified, then one or more -// specified JSONPaths are extracted from the event and used as values in a -// template that you specify as the input to the target. -// -// When you specify -// InputPath or InputTransformer, you must use JSON dot notation, not bracket -// notation. When you add targets to a rule and the associated rule triggers soon -// after, new or updated targets might not be immediately invoked. Allow a short -// period of time for changes to take effect. This action can partially fail if too -// many requests are made at the same time. If that happens, FailedEntryCount is -// non-zero in the response and each entry in FailedEntries provides the ID of the -// failed target and the error code. +// - If none of the following arguments are specified for a target, then the +// entire event is passed to the target in JSON format (unless the target is Amazon +// EC2 Run Command or Amazon ECS task, in which case nothing from the event is +// passed to the target). +// - If Input is specified in the form of valid JSON, then the matched event is +// overridden with this constant. +// - If InputPath is specified in the form of JSONPath (for example, $.detail ), +// then only the part of the event specified in the path is passed to the target +// (for example, only the detail part of the event is passed). +// - If InputTransformer is specified, then one or more specified JSONPaths are +// extracted from the event and used as values in a template that you specify as +// the input to the target. +// +// When you specify InputPath or InputTransformer , you must use JSON dot notation, +// not bracket notation. When you add targets to a rule and the associated rule +// triggers soon after, new or updated targets might not be immediately invoked. +// Allow a short period of time for changes to take effect. This action can +// partially fail if too many requests are made at the same time. If that happens, +// FailedEntryCount is non-zero in the response and each entry in FailedEntries +// provides the ID of the failed target and the error code. func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns ...func(*Options)) (*PutTargetsOutput, error) { if params == nil { params = &PutTargetsInput{} @@ -168,8 +123,8 @@ type PutTargetsInput struct { // This member is required. Targets []types.Target - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_RemovePermission.go b/service/cloudwatchevents/api_op_RemovePermission.go index 8bfdf7f1372..583121b9e82 100644 --- a/service/cloudwatchevents/api_op_RemovePermission.go +++ b/service/cloudwatchevents/api_op_RemovePermission.go @@ -13,9 +13,9 @@ import ( // Revokes the permission of another Amazon Web Services account to be able to put // events to the specified event bus. Specify the account to revoke by the // StatementId value that you associated with the account when you granted it -// permission with PutPermission. You can find the StatementId by using -// DescribeEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html). +// permission with PutPermission . You can find the StatementId by using +// DescribeEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html) +// . func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} diff --git a/service/cloudwatchevents/api_op_RemoveTargets.go b/service/cloudwatchevents/api_op_RemoveTargets.go index 183438d64a1..c9522c9a3ec 100644 --- a/service/cloudwatchevents/api_op_RemoveTargets.go +++ b/service/cloudwatchevents/api_op_RemoveTargets.go @@ -45,15 +45,15 @@ type RemoveTargetsInput struct { // This member is required. Rule *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // If this is a managed rule, created by an Amazon Web Services service on your // behalf, you must specify Force as True to remove targets. This parameter is // ignored for rules that are not managed rules. You can check whether a rule is a - // managed rule by using DescribeRule or ListRules and checking the ManagedBy field - // of the response. + // managed rule by using DescribeRule or ListRules and checking the ManagedBy + // field of the response. Force bool noSmithyDocumentSerde diff --git a/service/cloudwatchevents/api_op_StartReplay.go b/service/cloudwatchevents/api_op_StartReplay.go index 6ab82aa0c2d..462ac4e12f7 100644 --- a/service/cloudwatchevents/api_op_StartReplay.go +++ b/service/cloudwatchevents/api_op_StartReplay.go @@ -15,11 +15,11 @@ import ( // Starts the specified replay. Events are not necessarily replayed in the exact // same order that they were added to the archive. A replay processes events to // replay based on the time in the event, and replays them using 1 minute -// intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 -// minute time range, the events are replayed from the first minute of that 20 +// intervals. If you specify an EventStartTime and an EventEndTime that covers a +// 20 minute time range, the events are replayed from the first minute of that 20 // minute range first. Then the events from the second minute are replayed. You can -// use DescribeReplay to determine the progress of a replay. The value returned for -// EventLastReplayedTime indicates the time within the specified time range +// use DescribeReplay to determine the progress of a replay. The value returned +// for EventLastReplayedTime indicates the time within the specified time range // associated with the last event replayed. func (c *Client) StartReplay(ctx context.Context, params *StartReplayInput, optFns ...func(*Options)) (*StartReplayOutput, error) { if params == nil { diff --git a/service/cloudwatchevents/api_op_TestEventPattern.go b/service/cloudwatchevents/api_op_TestEventPattern.go index f8b8df08eca..a2d84f1d049 100644 --- a/service/cloudwatchevents/api_op_TestEventPattern.go +++ b/service/cloudwatchevents/api_op_TestEventPattern.go @@ -33,30 +33,20 @@ func (c *Client) TestEventPattern(ctx context.Context, params *TestEventPatternI type TestEventPatternInput struct { // The event, in JSON format, to test against the event pattern. The JSON must - // follow the format specified in Amazon Web Services Events - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html), and - // the following fields are mandatory: - // - // * id - // - // * account - // - // * source - // - // * time - // - // * - // region - // - // * resources - // - // * detail-type + // follow the format specified in Amazon Web Services Events (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html) + // , and the following fields are mandatory: + // - id + // - account + // - source + // - time + // - region + // - resources + // - detail-type // // This member is required. Event *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. // // This member is required. diff --git a/service/cloudwatchevents/doc.go b/service/cloudwatchevents/doc.go index 6a5d47042b0..58f2c070b3c 100644 --- a/service/cloudwatchevents/doc.go +++ b/service/cloudwatchevents/doc.go @@ -9,18 +9,14 @@ // the stream and route them to targets to take action. You can also use rules to // take action on a predetermined schedule. For example, you can configure rules // to: +// - Automatically invoke an Lambda function to update DNS entries when an event +// notifies you that Amazon EC2 instance enters the running state. +// - Direct specific API records from CloudTrail to an Amazon Kinesis data +// stream for detailed analysis of potential security or availability risks. +// - Periodically invoke a built-in target to create a snapshot of an Amazon EBS +// volume. // -// * Automatically invoke an Lambda function to update DNS entries when an -// event notifies you that Amazon EC2 instance enters the running state. -// -// * Direct -// specific API records from CloudTrail to an Amazon Kinesis data stream for -// detailed analysis of potential security or availability risks. -// -// * Periodically -// invoke a built-in target to create a snapshot of an Amazon EBS volume. -// -// For more -// information about the features of Amazon EventBridge, see the Amazon EventBridge -// User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide). +// For more information about the features of Amazon EventBridge, see the Amazon +// EventBridge User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide) +// . package cloudwatchevents diff --git a/service/cloudwatchevents/types/enums.go b/service/cloudwatchevents/types/enums.go index 897e41f2917..65e0253d58b 100644 --- a/service/cloudwatchevents/types/enums.go +++ b/service/cloudwatchevents/types/enums.go @@ -15,9 +15,9 @@ const ( ApiDestinationHttpMethodDelete ApiDestinationHttpMethod = "DELETE" ) -// Values returns all known values for ApiDestinationHttpMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ApiDestinationHttpMethod. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiDestinationHttpMethod) Values() []ApiDestinationHttpMethod { return []ApiDestinationHttpMethod{ "POST", @@ -60,9 +60,9 @@ const ( ArchiveStateUpdateFailed ArchiveState = "UPDATE_FAILED" ) -// Values returns all known values for ArchiveState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ArchiveState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ArchiveState) Values() []ArchiveState { return []ArchiveState{ "ENABLED", @@ -227,8 +227,8 @@ const ( PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" ) -// Values returns all known values for PlacementStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PlacementStrategyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategyType) Values() []PlacementStrategyType { return []PlacementStrategyType{ @@ -288,9 +288,9 @@ const ( RuleStateDisabled RuleState = "DISABLED" ) -// Values returns all known values for RuleState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RuleState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RuleState) Values() []RuleState { return []RuleState{ "ENABLED", diff --git a/service/cloudwatchevents/types/errors.go b/service/cloudwatchevents/types/errors.go index fb8b0a0a165..ff43bf3cc57 100644 --- a/service/cloudwatchevents/types/errors.go +++ b/service/cloudwatchevents/types/errors.go @@ -167,10 +167,10 @@ func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy. // This rule was created by an Amazon Web Services service on behalf of your // account. It is managed by that service. If you see this error in response to -// DeleteRule or RemoveTargets, you can use the Force parameter in those calls to +// DeleteRule or RemoveTargets , you can use the Force parameter in those calls to // delete the rule or remove targets from the rule. You cannot modify these managed -// rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or -// UntagResource. +// rules by using DisableRule , EnableRule , PutTargets , PutRule , TagResource , +// or UntagResource . type ManagedRuleException struct { Message *string diff --git a/service/cloudwatchevents/types/types.go b/service/cloudwatchevents/types/types.go index c5d8adcc243..33389efd3c1 100644 --- a/service/cloudwatchevents/types/types.go +++ b/service/cloudwatchevents/types/types.go @@ -76,15 +76,15 @@ type Archive struct { // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. + // Specifies the subnets associated with the task. These subnets must all be in + // the same VPC. You can specify as many as 16 subnets. // // This member is required. Subnets []string // Specifies whether the task's elastic network interface receives a public IP - // address. You can specify ENABLED only when LaunchType in EcsParameters is set to - // FARGATE. + // address. You can specify ENABLED only when LaunchType in EcsParameters is set + // to FARGATE . AssignPublicIp AssignPublicIp // Specifies the security groups associated with the task. These security groups @@ -138,9 +138,9 @@ type BatchParameters struct { noSmithyDocumentSerde } -// The retry strategy to use for failed jobs, if the target is an Batch job. If you -// specify a retry strategy here, it overrides the retry strategy defined in the -// job definition. +// The retry strategy to use for failed jobs, if the target is an Batch job. If +// you specify a retry strategy here, it overrides the retry strategy defined in +// the job definition. type BatchRetryStrategy struct { // The number of times to attempt to retry, if the job fails. Valid values are @@ -151,8 +151,7 @@ type BatchRetryStrategy struct { } // The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) // in the Amazon ECS API Reference. type CapacityProviderStrategyItem struct { @@ -167,9 +166,9 @@ type CapacityProviderStrategyItem struct { // used. Base int32 - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. The weight value is - // taken into consideration after the base value, if defined, is satisfied. + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight value + // is taken into consideration after the base value, if defined, is satisfied. Weight int32 noSmithyDocumentSerde @@ -178,20 +177,20 @@ type CapacityProviderStrategyItem struct { // A JSON string which you can use to limit the event bus permissions you are // granting to only accounts that fulfill the condition. Currently, the only // supported condition is membership in a certain Amazon Web Services organization. -// The string must contain Type, Key, and Value fields. The Value field specifies -// the ID of the Amazon Web Services organization. Following is an example value -// for Condition: '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": -// "o-1234567890"}' +// The string must contain Type , Key , and Value fields. The Value field +// specifies the ID of the Amazon Web Services organization. Following is an +// example value for Condition : '{"Type" : "StringEquals", "Key": +// "aws:PrincipalOrgID", "Value": "o-1234567890"}' type Condition struct { // Specifies the key for the condition. Currently the only supported key is - // aws:PrincipalOrgID. + // aws:PrincipalOrgID . // // This member is required. Key *string // Specifies the type of condition. Currently the only supported value is - // StringEquals. + // StringEquals . // // This member is required. Type *string @@ -235,8 +234,8 @@ type Connection struct { noSmithyDocumentSerde } -// Contains the authorization parameters for the connection if API Key is specified -// as the authorization type. +// Contains the authorization parameters for the connection if API Key is +// specified as the authorization type. type ConnectionApiKeyAuthResponseParameters struct { // The name of the header to use for the APIKeyValue used for authorization. @@ -338,8 +337,9 @@ type ConnectionOAuthResponseParameters struct { // The URL to the HTTP endpoint that authorized the request. AuthorizationEndpoint *string - // A ConnectionOAuthClientResponseParameters object that contains details about the - // client parameters returned when OAuth is specified as the authorization type. + // A ConnectionOAuthClientResponseParameters object that contains details about + // the client parameters returned when OAuth is specified as the authorization + // type. ClientParameters *ConnectionOAuthClientResponseParameters // The method used to connect to the HTTP endpoint. @@ -397,8 +397,8 @@ type CreateConnectionAuthRequestParameters struct { // A ConnectionHttpParameters object that contains the API key authorization // parameters to use for the connection. Note that if you include additional - // parameters for the target of a rule via HttpParameters, including query strings, - // the parameters added for the connection take precedence. + // parameters for the target of a rule via HttpParameters , including query + // strings, the parameters added for the connection take precedence. InvocationHttpParameters *ConnectionHttpParameters // A CreateConnectionOAuthRequestParameters object that contains the OAuth @@ -487,20 +487,19 @@ type EcsParameters struct { TaskDefinitionArn *string // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be omitted. - // If no capacityProviderStrategy or launchType is specified, the + // capacityProviderStrategy is specified, the launchType parameter must be + // omitted. If no capacityProviderStrategy or launchType is specified, the // defaultCapacityProviderStrategy for the cluster is used. CapacityProviderStrategy []CapacityProviderStrategyItem // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool - // Whether or not to enable the execute command functionality for the containers in - // this task. If true, this enables execute command functionality on all containers - // in the task. + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. EnableExecuteCommand bool // Specifies an ECS task group for the task. The maximum length is 255 characters. @@ -509,8 +508,7 @@ type EcsParameters struct { // Specifies the launch type on which your task is running. The launch type that // you specify here must match one of the launch type (compatibilities) of the // target task. The FARGATE value is supported only in the Regions where Fargate - // witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType @@ -522,27 +520,26 @@ type EcsParameters struct { // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration - // An array of placement constraint objects to use for the task. You can specify up - // to 10 constraints per task (including constraints in the task definition and + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition and // those specified at runtime). PlacementConstraints []PlacementConstraint - // The placement strategy objects to use for the task. You can specify a maximum of - // five strategy rules per task. + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. PlacementStrategy []PlacementStrategy - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. This structure is used only if LaunchType - // is FARGATE. For more information about valid platform versions, see Fargate - // Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Specifies the platform version for the task. Specify only the numeric portion + // of the platform version, such as 1.1.0 . This structure is used only if + // LaunchType is FARGATE . For more information about valid platform versions, see + // Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags are not propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource API action. + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use the TagResource API action. PropagateTags PropagateTags // The reference ID to use for the task. @@ -550,12 +547,11 @@ type EcsParameters struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you - // define. To learn more, see RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) // in the Amazon ECS API Reference. Tags []Tag - // The number of tasks to create based on TaskDefinition. The default is 1. + // The number of tasks to create based on TaskDefinition . The default is 1. TaskCount *int32 noSmithyDocumentSerde @@ -634,50 +630,40 @@ type HttpParameters struct { noSmithyDocumentSerde } -// Contains the parameters needed for you to provide custom input to a target based -// on one or more pieces of data extracted from the event. +// Contains the parameters needed for you to provide custom input to a target +// based on one or more pieces of data extracted from the event. type InputTransformer struct { // Input template where you specify placeholders that will be filled with the // values of the keys from InputPathsMap to customize the data sent to the target. - // Enclose each InputPathsMaps value in brackets: The InputTemplate must be - // valid JSON. If InputTemplate is a JSON object (surrounded by curly braces), the - // following restrictions apply: - // - // * The placeholder cannot be used as an object - // key. - // - // The following example shows the syntax for using InputPathsMap and - // InputTemplate. "InputTransformer": + // Enclose each InputPathsMaps value in brackets: The InputTemplate must + // be valid JSON. If InputTemplate is a JSON object (surrounded by curly braces), + // the following restrictions apply: + // - The placeholder cannot be used as an object key. + // The following example shows the syntax for using InputPathsMap and InputTemplate + // . "InputTransformer": // { // - // "InputPathsMap": {"instance": - // "$.detail.instance","status": "$.detail.status"}, - // - // "InputTemplate": " is in - // state " + // "InputPathsMap": {"instance": "$.detail.instance","status": + // "$.detail.status"}, // - // } To have the InputTemplate include quote marks within a JSON string, - // escape each quote marks with a slash, as in the following example: - // "InputTransformer": + // "InputTemplate": " is in state " + // } To have the InputTemplate include quote marks within a JSON string, escape + // each quote marks with a slash, as in the following example: "InputTransformer": // { // - // "InputPathsMap": {"instance": - // "$.detail.instance","status": "$.detail.status"}, + // "InputPathsMap": {"instance": "$.detail.instance","status": + // "$.detail.status"}, // - // "InputTemplate": " is in - // state """ - // - // } The InputTemplate can also be valid JSON with varibles in quotes or - // out, as in the following example: "InputTransformer": + // "InputTemplate": " is in state """ + // } The InputTemplate can also be valid JSON with varibles in quotes or out, as + // in the following example: "InputTransformer": // { // + // "InputPathsMap": {"instance": "$.detail.instance","status": + // "$.detail.status"}, // - // "InputPathsMap": {"instance": "$.detail.instance","status": - // "$.detail.status"}, - // - // "InputTemplate": '{"myInstance": ,"myStatus": " is in - // state """}' + // "InputTemplate": '{"myInstance": ,"myStatus": " is in state """}' // // } // @@ -695,15 +681,14 @@ type InputTransformer struct { noSmithyDocumentSerde } -// This object enables you to specify a JSON path to extract from the event and use -// as the partition key for the Amazon Kinesis data stream, so that you can control -// the shard to which the event goes. If you do not include this parameter, the -// default is to use the eventId as the partition key. +// This object enables you to specify a JSON path to extract from the event and +// use as the partition key for the Amazon Kinesis data stream, so that you can +// control the shard to which the event goes. If you do not include this parameter, +// the default is to use the eventId as the partition key. type KinesisParameters struct { // The JSON path to be extracted from the event and used as the partition key. For - // more information, see Amazon Kinesis Streams Key Concepts - // (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) + // more information, see Amazon Kinesis Streams Key Concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) // in the Amazon Kinesis Streams Developer Guide. // // This member is required. @@ -761,15 +746,13 @@ type PartnerEventSourceAccount struct { } // An object representing a constraint on task placement. To learn more, see Task -// Placement Constraints -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. You cannot - // specify an expression if the constraint type is distinctInstance. To learn more, - // see Cluster Query Language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // specify an expression if the constraint type is distinctInstance . To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string @@ -782,8 +765,7 @@ type PlacementConstraint struct { } // The task placement strategy for a task or service. To learn more, see Task -// Placement Strategies -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) // in the Amazon Elastic Container Service Service Developer Guide. type PlacementStrategy struct { @@ -829,17 +811,14 @@ type PutEventsRequestEntry struct { // The source of the event. Source *string - // The time stamp of the event, per RFC3339 - // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the - // time stamp of the PutEvents - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) + // The time stamp of the event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt) + // . If no time stamp is provided, the time stamp of the PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) // call is used. Time *time.Time // An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains // the trace-id associated with the event. To learn more about X-Ray trace headers, - // see Tracing header - // (https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) + // see Tracing header (https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) // in the X-Ray Developer Guide. TraceHeader *string @@ -903,7 +882,7 @@ type PutPartnerEventsResultEntry struct { type PutTargetsResultEntry struct { // The error code that indicates why the target addition failed. If the value is - // ConcurrentModificationException, too many requests were made at the same time. + // ConcurrentModificationException , too many requests were made at the same time. ErrorCode *string // The error message that explains why the target addition failed. @@ -935,12 +914,12 @@ type RedshiftDataParameters struct { // credentials. DbUser *string - // The name or ARN of the secret that enables access to the database. Required when - // authenticating using Amazon Web Services Secrets Manager. + // The name or ARN of the secret that enables access to the database. Required + // when authenticating using Amazon Web Services Secrets Manager. SecretManagerArn *string - // The name of the SQL statement. You can name the SQL statement when you create it - // to identify the query. + // The name of the SQL statement. You can name the SQL statement when you create + // it to identify the query. StatementName *string // Indicates whether to send an event back to EventBridge after the SQL statement @@ -954,7 +933,7 @@ type RedshiftDataParameters struct { type RemoveTargetsResultEntry struct { // The error code that indicates why the target removal failed. If the value is - // ConcurrentModificationException, too many requests were made at the same time. + // ConcurrentModificationException , too many requests were made at the same time. ErrorCode *string // The error message that explains why the target removal failed. @@ -980,8 +959,8 @@ type Replay struct { EventSourceArn *string // A time stamp for the time to start replaying events. This is determined by the - // time in the event as described in Time - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time). + // time in the event as described in Time (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time) + // . EventStartTime *time.Time // A time stamp for the time that the replay completed. @@ -1040,13 +1019,12 @@ type Rule struct { // The description of the rule. Description *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // The event pattern of the rule. For more information, see Events and Event - // Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string @@ -1065,10 +1043,10 @@ type Rule struct { // Target structure, instead of here in this parameter. RoleArn *string - // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". - // For more information, see Creating an Amazon EventBridge rule that runs on a - // schedule - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html). + // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 + // minutes)". For more information, see Creating an Amazon EventBridge rule that + // runs on a schedule (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) + // . ScheduleExpression *string // The state of the rule. @@ -1081,8 +1059,8 @@ type Rule struct { // specify which EC2 instances are to be sent the command. type RunCommandParameters struct { - // Currently, we support including only one RunCommandTarget block, which specifies - // either an array of InstanceIds or a tag. + // Currently, we support including only one RunCommandTarget block, which + // specifies either an array of InstanceIds or a tag. // // This member is required. RunCommandTargets []RunCommandTarget @@ -1095,12 +1073,12 @@ type RunCommandParameters struct { // this key may specify multiple values. type RunCommandTarget struct { - // Can be either tag: tag-key or InstanceIds. + // Can be either tag: tag-key or InstanceIds . // // This member is required. Key *string - // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, + // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds , // Values is a list of Amazon EC2 instance IDs. // // This member is required. @@ -1126,8 +1104,8 @@ type SageMakerPipelineParameter struct { noSmithyDocumentSerde } -// These are custom parameters to use when the target is a SageMaker Model Building -// Pipeline that starts based on EventBridge events. +// These are custom parameters to use when the target is a SageMaker Model +// Building Pipeline that starts based on EventBridge events. type SageMakerPipelineParameters struct { // List of Parameter names and values for SageMaker Model Building Pipeline @@ -1165,15 +1143,14 @@ type Tag struct { noSmithyDocumentSerde } -// Targets are the resources to be invoked when a rule is triggered. For a complete -// list of services and resources that can be set as a target, see PutTargets -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html). -// If you are setting the event bus of another account as the target, and that +// Targets are the resources to be invoked when a rule is triggered. For a +// complete list of services and resources that can be set as a target, see +// PutTargets (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) +// . If you are setting the event bus of another account as the target, and that // account granted permission to your account through an organization instead of // directly by the account ID, then you must specify a RoleArn with proper // permissions in the Target structure. For more information, see Sending and -// Receiving Events Between Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Receiving Events Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. type Target struct { @@ -1187,10 +1164,9 @@ type Target struct { // This member is required. Id *string - // If the event target is an Batch job, this contains the job definition, job name, - // and other parameters. For more information, see Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the Batch User - // Guide. + // If the event target is an Batch job, this contains the job definition, job + // name, and other parameters. For more information, see Jobs (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) + // in the Batch User Guide. BatchParameters *BatchParameters // The DeadLetterConfig that defines the target queue to send dead-letter queue @@ -1199,8 +1175,7 @@ type Target struct { // Contains the Amazon ECS task definition and task count to be used, if the event // target is an Amazon ECS task. For more information about Amazon ECS tasks, see - // Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. EcsParameters *EcsParameters @@ -1215,14 +1190,14 @@ type Target struct { // Valid JSON text passed to the target. In this case, nothing from the event // itself is passed to the target. For more information, see The JavaScript Object - // Notation (JSON) Data Interchange Format - // (http://www.rfc-editor.org/rfc/rfc7159.txt). + // Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt) + // . Input *string // The value of the JSONPath that is used for extracting part of the matched event // when passing it to the target. You must use JSON dot notation, not bracket - // notation. For more information about JSON paths, see JSONPath - // (http://goessner.net/articles/JsonPath/). + // notation. For more information about JSON paths, see JSONPath (http://goessner.net/articles/JsonPath/) + // . InputPath *string // Settings to enable you to provide custom input to a target based on certain @@ -1290,8 +1265,8 @@ type UpdateConnectionAuthRequestParameters struct { // authorization parameters for Basic authorization. BasicAuthParameters *UpdateConnectionBasicAuthRequestParameters - // A ConnectionHttpParameters object that contains the additional parameters to use - // for the connection. + // A ConnectionHttpParameters object that contains the additional parameters to + // use for the connection. InvocationHttpParameters *ConnectionHttpParameters // A UpdateConnectionOAuthRequestParameters object that contains the authorization diff --git a/service/cloudwatchlogs/api_client.go b/service/cloudwatchlogs/api_client.go index cae2522fccb..ef44de70932 100644 --- a/service/cloudwatchlogs/api_client.go +++ b/service/cloudwatchlogs/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cloudwatchlogs/api_op_AssociateKmsKey.go b/service/cloudwatchlogs/api_op_AssociateKmsKey.go index b91643bf5a7..8b77ab2e658 100644 --- a/service/cloudwatchlogs/api_op_AssociateKmsKey.go +++ b/service/cloudwatchlogs/api_op_AssociateKmsKey.go @@ -10,19 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified KMS key with the specified log group. Associating a KMS -// key with a log group overrides any existing associations between the log group -// and a KMS key. After a KMS key is associated with a log group, all newly +// Associates the specified KMS key with the specified log group. Associating a +// KMS key with a log group overrides any existing associations between the log +// group and a KMS key. After a KMS key is associated with a log group, all newly // ingested data for the log group is encrypted using the KMS key. This association // is stored as long as the data encrypted with the KMS keyis still within // CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it // is requested. CloudWatch Logs supports only symmetric KMS keys. Do not use an // associate an asymmetric KMS key with your log group. For more information, see -// Using Symmetric and Asymmetric Keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html). -// It can take up to 5 minutes for this operation to take effect. If you attempt to -// associate a KMS key with a log group but the KMS key does not exist or the KMS -// key is disabled, you receive an InvalidParameterException error. +// Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// . It can take up to 5 minutes for this operation to take effect. If you attempt +// to associate a KMS key with a log group but the KMS key does not exist or the +// KMS key is disabled, you receive an InvalidParameterException error. func (c *Client) AssociateKmsKey(ctx context.Context, params *AssociateKmsKeyInput, optFns ...func(*Options)) (*AssociateKmsKeyOutput, error) { if params == nil { params = &AssociateKmsKeyInput{} @@ -42,10 +41,9 @@ type AssociateKmsKeyInput struct { // The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. // This must be a symmetric KMS key. For more information, see Amazon Resource - // Names - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) - // and Using Symmetric and Asymmetric Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html). + // Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) + // and Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // . // // This member is required. KmsKeyId *string diff --git a/service/cloudwatchlogs/api_op_CreateExportTask.go b/service/cloudwatchlogs/api_op_CreateExportTask.go index f129cda1220..883ba2eb414 100644 --- a/service/cloudwatchlogs/api_op_CreateExportTask.go +++ b/service/cloudwatchlogs/api_op_CreateExportTask.go @@ -19,17 +19,15 @@ import ( // are encrypted with AES-256 is supported. This is an asynchronous call. If all // the required information is provided, this operation initiates an export task // and responds with the ID of the task. After the task has started, you can use -// DescribeExportTasks -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html) -// to get the status of the export task. Each account can only have one active -// (RUNNING or PENDING) export task at a time. To cancel an export task, use -// CancelExportTask -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html). -// You can export logs from multiple log groups or multiple time ranges to the same -// S3 bucket. To separate log data for each export task, specify a prefix to be -// used as the Amazon S3 key prefix for all exported objects. Time-based sorting on -// chunks of log data inside an exported file is not guaranteed. You can sort the -// exported log field data by using Linux utilities. +// DescribeExportTasks (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html) +// to get the status of the export task. Each account can only have one active ( +// RUNNING or PENDING ) export task at a time. To cancel an export task, use +// CancelExportTask (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html) +// . You can export logs from multiple log groups or multiple time ranges to the +// same S3 bucket. To separate log data for each export task, specify a prefix to +// be used as the Amazon S3 key prefix for all exported objects. Time-based sorting +// on chunks of log data inside an exported file is not guaranteed. You can sort +// the exported log field data by using Linux utilities. func (c *Client) CreateExportTask(ctx context.Context, params *CreateExportTaskInput, optFns ...func(*Options)) (*CreateExportTaskOutput, error) { if params == nil { params = &CreateExportTaskInput{} @@ -54,7 +52,7 @@ type CreateExportTaskInput struct { Destination *string // The start time of the range for the request, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier + // milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp earlier // than this time are not exported. // // This member is required. @@ -66,7 +64,7 @@ type CreateExportTaskInput struct { LogGroupName *string // The end time of the range for the request, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than + // milliseconds after Jan 1, 1970 00:00:00 UTC . Events with a timestamp later than // this time are not exported. You must specify a time that is not earlier than // when this log group was created. // @@ -74,7 +72,7 @@ type CreateExportTaskInput struct { To *int64 // The prefix used as the start of the key for every object exported. If you don't - // specify a value, the default is exportedlogs. + // specify a value, the default is exportedlogs . DestinationPrefix *string // Export only log streams that match the provided prefix. If you don't specify a diff --git a/service/cloudwatchlogs/api_op_CreateLogGroup.go b/service/cloudwatchlogs/api_op_CreateLogGroup.go index 620c6c2dfab..2d5a3c4722f 100644 --- a/service/cloudwatchlogs/api_op_CreateLogGroup.go +++ b/service/cloudwatchlogs/api_op_CreateLogGroup.go @@ -13,30 +13,25 @@ import ( // Creates a log group with the specified name. You can create up to 20,000 log // groups per account. You must use the following guidelines when naming a log // group: +// - Log group names must be unique within a Region for an Amazon Web Services +// account. +// - Log group names can be between 1 and 512 characters long. +// - Log group names consist of the following characters: a-z, A-Z, 0-9, '_' +// (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number +// sign) // -// * Log group names must be unique within a Region for an Amazon Web -// Services account. -// -// * Log group names can be between 1 and 512 characters -// long. -// -// * Log group names consist of the following characters: a-z, A-Z, 0-9, '_' -// (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number -// sign) -// -// When you create a log group, by default the log events in the log group -// do not expire. To set a retention policy so that events expire and are deleted -// after a specified time, use PutRetentionPolicy -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html). -// If you associate an KMS key with the log group, ingested data is encrypted using -// the KMS key. This association is stored as long as the data encrypted with the -// KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt -// this data whenever it is requested. If you attempt to associate a KMS key with -// the log group but the KMS keydoes not exist or the KMS key is disabled, you -// receive an InvalidParameterException error. CloudWatch Logs supports only +// When you create a log group, by default the log events in the log group do not +// expire. To set a retention policy so that events expire and are deleted after a +// specified time, use PutRetentionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html) +// . If you associate an KMS key with the log group, ingested data is encrypted +// using the KMS key. This association is stored as long as the data encrypted with +// the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to +// decrypt this data whenever it is requested. If you attempt to associate a KMS +// key with the log group but the KMS keydoes not exist or the KMS key is disabled, +// you receive an InvalidParameterException error. CloudWatch Logs supports only // symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. -// For more information, see Using Symmetric and Asymmetric Keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html). +// For more information, see Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// . func (c *Client) CreateLogGroup(ctx context.Context, params *CreateLogGroupInput, optFns ...func(*Options)) (*CreateLogGroupOutput, error) { if params == nil { params = &CreateLogGroupInput{} @@ -60,8 +55,8 @@ type CreateLogGroupInput struct { LogGroupName *string // The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. - // For more information, see Amazon Resource Names - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms). + // For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) + // . KmsKeyId *string // The key-value pairs to use for the tags. You can grant users access to certain @@ -69,11 +64,10 @@ type CreateLogGroupInput struct { // your groups and use IAM policies that refer to those tags. To assign tags when // you create a log group, you must have either the logs:TagResource or // logs:TagLogGroup permission. For more information about tagging, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For more - // information about using tags to control access, see Controlling access to Amazon - // Web Services resources using tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . For more information about using tags to control access, see Controlling + // access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_CreateLogStream.go b/service/cloudwatchlogs/api_op_CreateLogStream.go index a264a4fb94d..9d11ca15db6 100644 --- a/service/cloudwatchlogs/api_op_CreateLogStream.go +++ b/service/cloudwatchlogs/api_op_CreateLogStream.go @@ -16,14 +16,9 @@ import ( // streams that you can create for a log group. There is a limit of 50 TPS on // CreateLogStream operations, after which transactions are throttled. You must use // the following guidelines when naming a log stream: -// -// * Log stream names must be -// unique within the log group. -// -// * Log stream names can be between 1 and 512 -// characters long. -// -// * Don't use ':' (colon) or '*' (asterisk) characters. +// - Log stream names must be unique within the log group. +// - Log stream names can be between 1 and 512 characters long. +// - Don't use ':' (colon) or '*' (asterisk) characters. func (c *Client) CreateLogStream(ctx context.Context, params *CreateLogStreamInput, optFns ...func(*Options)) (*CreateLogStreamOutput, error) { if params == nil { params = &CreateLogStreamInput{} diff --git a/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go b/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go index d4274e384fe..c0dfc88bf83 100644 --- a/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go +++ b/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go @@ -11,8 +11,8 @@ import ( ) // Deletes the data protection policy from the specified log group. For more -// information about data protection policies, see PutDataProtectionPolicy -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html). +// information about data protection policies, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html) +// . func (c *Client) DeleteDataProtectionPolicy(ctx context.Context, params *DeleteDataProtectionPolicyInput, optFns ...func(*Options)) (*DeleteDataProtectionPolicyOutput, error) { if params == nil { params = &DeleteDataProtectionPolicyInput{} diff --git a/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go b/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go index 65cc6cd767f..4172222b08d 100644 --- a/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go +++ b/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go @@ -32,8 +32,7 @@ func (c *Client) DeleteQueryDefinition(ctx context.Context, params *DeleteQueryD type DeleteQueryDefinitionInput struct { // The ID of the query definition that you want to delete. You can use - // DescribeQueryDefinitions - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) + // DescribeQueryDefinitions (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) // to retrieve the IDs of your saved query definitions. // // This member is required. @@ -44,8 +43,8 @@ type DeleteQueryDefinitionInput struct { type DeleteQueryDefinitionOutput struct { - // A value of TRUE indicates that the operation succeeded. FALSE indicates that the - // operation failed. + // A value of TRUE indicates that the operation succeeded. FALSE indicates that + // the operation failed. Success bool // Metadata pertaining to the operation's result. diff --git a/service/cloudwatchlogs/api_op_DescribeExportTasks.go b/service/cloudwatchlogs/api_op_DescribeExportTasks.go index 5e17209e496..b897244c841 100644 --- a/service/cloudwatchlogs/api_op_DescribeExportTasks.go +++ b/service/cloudwatchlogs/api_op_DescribeExportTasks.go @@ -38,8 +38,8 @@ type DescribeExportTasksInput struct { // previous call.) NextToken *string - // The status code of the export task. Specifying a status code filters the results - // to zero or more export tasks. + // The status code of the export task. Specifying a status code filters the + // results to zero or more export tasks. StatusCode types.ExportTaskStatusCode // The ID of the export task. Specifying a task ID filters the results to one or diff --git a/service/cloudwatchlogs/api_op_DescribeLogGroups.go b/service/cloudwatchlogs/api_op_DescribeLogGroups.go index 2830fe1e2e0..f733c665520 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogGroups.go +++ b/service/cloudwatchlogs/api_op_DescribeLogGroups.go @@ -18,12 +18,11 @@ import ( // action by using the aws:ResourceTag/key-name condition key. Other CloudWatch // Logs actions do support the use of the aws:ResourceTag/key-name condition key // to control access. For more information about using tags to control access, see -// Controlling access to Amazon Web Services resources using tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). If you are -// using CloudWatch cross-account observability, you can use this operation in a -// monitoring account and view data from the linked source accounts. For more -// information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// . If you are using CloudWatch cross-account observability, you can use this +// operation in a monitoring account and view data from the linked source accounts. +// For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) DescribeLogGroups(ctx context.Context, params *DescribeLogGroupsInput, optFns ...func(*Options)) (*DescribeLogGroupsOutput, error) { if params == nil { params = &DescribeLogGroupsInput{} @@ -41,18 +40,18 @@ func (c *Client) DescribeLogGroups(ctx context.Context, params *DescribeLogGroup type DescribeLogGroupsInput struct { - // When includeLinkedAccounts is set to True, use this parameter to specify the + // When includeLinkedAccounts is set to True , use this parameter to specify the // list of accounts to search. You can specify as many as 20 account IDs in the // array. AccountIdentifiers []string // If you are using a monitoring account, set this to True to have the operation - // return log groups in the accounts listed in accountIdentifiers. If this + // return log groups in the accounts listed in accountIdentifiers . If this // parameter is set to true and accountIdentifiers contains a null value, the // operation returns all log groups in the monitoring account and all log groups in // all source accounts that are linked to the monitoring account. If you specify - // includeLinkedAccounts in your request, then metricFilterCount, retentionInDays, - // and storedBytes are not included in the response. + // includeLinkedAccounts in your request, then metricFilterCount , retentionInDays + // , and storedBytes are not included in the response. IncludeLinkedAccounts *bool // The maximum number of items returned. If you don't specify a value, the default @@ -61,8 +60,8 @@ type DescribeLogGroupsInput struct { // If you specify a string for this parameter, the operation returns only log // groups that have names that match the string based on a case-sensitive substring - // search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and - // GroupFoo would match, but foo, F/o/o and Froo would not match. + // search. For example, if you specify Foo , log groups named FooBar , aws/Foo , + // and GroupFoo would match, but foo , F/o/o and Froo would not match. // logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of // these parameters can be passed. LogGroupNamePattern *string diff --git a/service/cloudwatchlogs/api_op_DescribeLogStreams.go b/service/cloudwatchlogs/api_op_DescribeLogStreams.go index 69e40e9b3cd..ded02cf974d 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogStreams.go +++ b/service/cloudwatchlogs/api_op_DescribeLogStreams.go @@ -15,13 +15,13 @@ import ( // Lists the log streams for the specified log group. You can list all the log // streams or filter the results by prefix. You can also control how the results // are ordered. You can specify the log group to search by using either -// logGroupIdentifier or logGroupName. You must include one of these two +// logGroupIdentifier or logGroupName . You must include one of these two // parameters, but you can't include both. This operation has a limit of five // transactions per second, after which transactions are throttled. If you are // using CloudWatch cross-account observability, you can use this operation in a // monitoring account and view data from the linked source accounts. For more -// information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) DescribeLogStreams(ctx context.Context, params *DescribeLogStreamsInput, optFns ...func(*Options)) (*DescribeLogStreamsOutput, error) { if params == nil { params = &DescribeLogStreamsInput{} @@ -49,15 +49,15 @@ type DescribeLogStreamsInput struct { // Specify either the name or ARN of the log group to view. If the log group is in // a source account and you are using a monitoring account, you must use the log - // group ARN. You must include either logGroupIdentifier or logGroupName, but not + // group ARN. You must include either logGroupIdentifier or logGroupName , but not // both. LogGroupIdentifier *string // The name of the log group. You must include either logGroupIdentifier or - // logGroupName, but not both. + // logGroupName , but not both. LogGroupName *string - // The prefix to match. If orderBy is LastEventTime, you cannot specify this + // The prefix to match. If orderBy is LastEventTime , you cannot specify this // parameter. LogStreamNamePrefix *string @@ -65,13 +65,13 @@ type DescribeLogStreamsInput struct { // previous call.) NextToken *string - // If the value is LogStreamName, the results are ordered by log stream name. If - // the value is LastEventTime, the results are ordered by the event time. The - // default value is LogStreamName. If you order the results by event time, you + // If the value is LogStreamName , the results are ordered by log stream name. If + // the value is LastEventTime , the results are ordered by the event time. The + // default value is LogStreamName . If you order the results by event time, you // cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents // the time of the most recent log event in the log stream in CloudWatch Logs. This - // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 - // UTC. lastEventTimestamp updates on an eventual consistency basis. It typically + // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC + // . lastEventTimestamp updates on an eventual consistency basis. It typically // updates in less than an hour from ingestion, but in rare situations might take // longer. OrderBy types.OrderBy diff --git a/service/cloudwatchlogs/api_op_DescribeMetricFilters.go b/service/cloudwatchlogs/api_op_DescribeMetricFilters.go index 262de630af1..1e7b3ff054f 100644 --- a/service/cloudwatchlogs/api_op_DescribeMetricFilters.go +++ b/service/cloudwatchlogs/api_op_DescribeMetricFilters.go @@ -48,8 +48,9 @@ type DescribeMetricFiltersInput struct { // metricNamespace parameter. MetricName *string - // Filters results to include only those in the specified namespace. If you include - // this parameter in your request, you must also include the metricName parameter. + // Filters results to include only those in the specified namespace. If you + // include this parameter in your request, you must also include the metricName + // parameter. MetricNamespace *string // The token for the next set of items to return. (You received this token from a diff --git a/service/cloudwatchlogs/api_op_DescribeQueries.go b/service/cloudwatchlogs/api_op_DescribeQueries.go index 8ced2e583b2..22487273510 100644 --- a/service/cloudwatchlogs/api_op_DescribeQueries.go +++ b/service/cloudwatchlogs/api_op_DescribeQueries.go @@ -41,7 +41,7 @@ type DescribeQueriesInput struct { NextToken *string // Limits the returned queries to only those that have the specified status. Valid - // values are Cancelled, Complete, Failed, Running, and Scheduled. + // values are Cancelled , Complete , Failed , Running , and Scheduled . Status types.QueryStatus noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go b/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go index c13a3624eaa..900d0561803 100644 --- a/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go +++ b/service/cloudwatchlogs/api_op_DescribeSubscriptionFilters.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the subscription filters for the specified log group. You can list all the -// subscription filters or filter the results by prefix. The results are +// Lists the subscription filters for the specified log group. You can list all +// the subscription filters or filter the results by prefix. The results are // ASCII-sorted by filter name. func (c *Client) DescribeSubscriptionFilters(ctx context.Context, params *DescribeSubscriptionFiltersInput, optFns ...func(*Options)) (*DescribeSubscriptionFiltersOutput, error) { if params == nil { diff --git a/service/cloudwatchlogs/api_op_DisassociateKmsKey.go b/service/cloudwatchlogs/api_op_DisassociateKmsKey.go index 0d3fe6dc6ad..31bd7fd5f6e 100644 --- a/service/cloudwatchlogs/api_op_DisassociateKmsKey.go +++ b/service/cloudwatchlogs/api_op_DisassociateKmsKey.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates the associated KMS key from the specified log group. After the KMS -// key is disassociated from the log group, CloudWatch Logs stops encrypting newly -// ingested data for the log group. All previously ingested data remains encrypted, -// and CloudWatch Logs requires permissions for the KMS key whenever the encrypted -// data is requested. Note that it can take up to 5 minutes for this operation to -// take effect. +// Disassociates the associated KMS key from the specified log group. After the +// KMS key is disassociated from the log group, CloudWatch Logs stops encrypting +// newly ingested data for the log group. All previously ingested data remains +// encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the +// encrypted data is requested. Note that it can take up to 5 minutes for this +// operation to take effect. func (c *Client) DisassociateKmsKey(ctx context.Context, params *DisassociateKmsKeyInput, optFns ...func(*Options)) (*DisassociateKmsKeyOutput, error) { if params == nil { params = &DisassociateKmsKeyInput{} diff --git a/service/cloudwatchlogs/api_op_FilterLogEvents.go b/service/cloudwatchlogs/api_op_FilterLogEvents.go index 60c04bfa585..3871d3b9492 100644 --- a/service/cloudwatchlogs/api_op_FilterLogEvents.go +++ b/service/cloudwatchlogs/api_op_FilterLogEvents.go @@ -16,7 +16,7 @@ import ( // or filter the results using a filter pattern, a time range, and the name of the // log stream. You must have the logs;FilterLogEvents permission to perform this // operation. You can specify the log group to search by using either -// logGroupIdentifier or logGroupName. You must include one of these two +// logGroupIdentifier or logGroupName . You must include one of these two // parameters, but you can't include both. By default, this operation returns as // many log events as can fit in 1 MB (up to 10,000 log events) or all the events // found within the specified time range. If the results include a token, that @@ -27,8 +27,8 @@ import ( // was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. If you // are using CloudWatch cross-account observability, you can use this operation in // a monitoring account and view data from the linked source accounts. For more -// information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) FilterLogEvents(ctx context.Context, params *FilterLogEventsInput, optFns ...func(*Options)) (*FilterLogEventsOutput, error) { if params == nil { params = &FilterLogEventsInput{} @@ -47,13 +47,12 @@ func (c *Client) FilterLogEvents(ctx context.Context, params *FilterLogEventsInp type FilterLogEventsInput struct { // The end of the time range, expressed as the number of milliseconds after Jan 1, - // 1970 00:00:00 UTC. Events with a timestamp later than this time are not + // 1970 00:00:00 UTC . Events with a timestamp later than this time are not // returned. EndTime *int64 - // The filter pattern to use. For more information, see Filter and Pattern Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). - // If not provided, all the events are matched. + // The filter pattern to use. For more information, see Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) + // . If not provided, all the events are matched. FilterPattern *string // If the value is true, the operation attempts to provide responses that contain @@ -75,22 +74,22 @@ type FilterLogEventsInput struct { // Specify either the name or ARN of the log group to view log events from. If the // log group is in a source account and you are using a monitoring account, you // must use the log group ARN. You must include either logGroupIdentifier or - // logGroupName, but not both. + // logGroupName , but not both. LogGroupIdentifier *string // The name of the log group to search. You must include either logGroupIdentifier - // or logGroupName, but not both. + // or logGroupName , but not both. LogGroupName *string // Filters the results to include only events from log streams that have names // starting with this prefix. If you specify a value for both logStreamNamePrefix - // and logStreamNames, but the value for logStreamNamePrefix does not match any log - // stream names specified in logStreamNames, the action returns an + // and logStreamNames , but the value for logStreamNamePrefix does not match any + // log stream names specified in logStreamNames , the action returns an // InvalidParameterException error. LogStreamNamePrefix *string // Filters the results to only logs from the log streams in this list. If you - // specify a value for both logStreamNamePrefix and logStreamNames, the action + // specify a value for both logStreamNamePrefix and logStreamNames , the action // returns an InvalidParameterException error. LogStreamNames []string @@ -99,11 +98,11 @@ type FilterLogEventsInput struct { NextToken *string // The start of the time range, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. + // 1, 1970 00:00:00 UTC . Events with a timestamp before this time are not returned. StartTime *int64 // Specify true to display the log event fields with all sensitive data unmasked - // and visible. The default is false. To use this operation with this parameter, + // and visible. The default is false . To use this operation with this parameter, // you must be signed into an account with the logs:Unmask permission. Unmask bool diff --git a/service/cloudwatchlogs/api_op_GetLogEvents.go b/service/cloudwatchlogs/api_op_GetLogEvents.go index ad851821bb9..e14e9c64a5b 100644 --- a/service/cloudwatchlogs/api_op_GetLogEvents.go +++ b/service/cloudwatchlogs/api_op_GetLogEvents.go @@ -20,10 +20,9 @@ import ( // available through the token. If you are using CloudWatch cross-account // observability, you can use this operation in a monitoring account and view data // from the linked source accounts. For more information, see CloudWatch -// cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). -// You can specify the log group to search by using either logGroupIdentifier or -// logGroupName. You must include one of these two parameters, but you can't +// cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . You can specify the log group to search by using either logGroupIdentifier or +// logGroupName . You must include one of these two parameters, but you can't // include both. func (c *Client) GetLogEvents(ctx context.Context, params *GetLogEventsInput, optFns ...func(*Options)) (*GetLogEventsOutput, error) { if params == nil { @@ -48,7 +47,7 @@ type GetLogEventsInput struct { LogStreamName *string // The end of the time range, expressed as the number of milliseconds after Jan 1, - // 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are + // 1970 00:00:00 UTC . Events with a timestamp equal to or later than this time are // not included. EndTime *int64 @@ -60,11 +59,11 @@ type GetLogEventsInput struct { // Specify either the name or ARN of the log group to view events from. If the log // group is in a source account and you are using a monitoring account, you must // use the log group ARN. You must include either logGroupIdentifier or - // logGroupName, but not both. + // logGroupName , but not both. LogGroupIdentifier *string // The name of the log group. You must include either logGroupIdentifier or - // logGroupName, but not both. + // logGroupName , but not both. LogGroupName *string // The token for the next set of items to return. (You received this token from a @@ -74,17 +73,17 @@ type GetLogEventsInput struct { // If the value is true, the earliest log events are returned first. If the value // is false, the latest log events are returned first. The default value is false. // If you are using a previous nextForwardToken value as the nextToken in this - // operation, you must specify true for startFromHead. + // operation, you must specify true for startFromHead . StartFromHead *bool // The start of the time range, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than + // 1, 1970 00:00:00 UTC . Events with a timestamp equal to this time or later than // this time are included. Events with a timestamp earlier than this time are not // included. StartTime *int64 // Specify true to display the log event fields with all sensitive data unmasked - // and visible. The default is false. To use this operation with this parameter, + // and visible. The default is false . To use this operation with this parameter, // you must be signed into an account with the logs:Unmask permission. Unmask bool @@ -96,9 +95,9 @@ type GetLogEventsOutput struct { // The events. Events []types.OutputLogEvent - // The token for the next set of items in the backward direction. The token expires - // after 24 hours. This token is not null. If you have reached the end of the - // stream, it returns the same token you passed in. + // The token for the next set of items in the backward direction. The token + // expires after 24 hours. This token is not null. If you have reached the end of + // the stream, it returns the same token you passed in. NextBackwardToken *string // The token for the next set of items in the forward direction. The token expires diff --git a/service/cloudwatchlogs/api_op_GetLogGroupFields.go b/service/cloudwatchlogs/api_op_GetLogGroupFields.go index 118769a21a5..04de98c2efb 100644 --- a/service/cloudwatchlogs/api_op_GetLogGroupFields.go +++ b/service/cloudwatchlogs/api_op_GetLogGroupFields.go @@ -14,19 +14,18 @@ import ( // Returns a list of the fields that are included in log events in the specified // log group. Includes the percentage of log events that contain each field. The // search is limited to a time period that you specify. You can specify the log -// group to search by using either logGroupIdentifier or logGroupName. You must +// group to search by using either logGroupIdentifier or logGroupName . You must // specify one of these parameters, but you can't specify both. In the results, // fields that start with @ are fields generated by CloudWatch Logs. For example, // @timestamp is the timestamp of each log event. For more information about the // fields that are generated by CloudWatch logs, see Supported Logs and Discovered -// Fields -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html). -// The response results are sorted by the frequency percentage, starting with the +// Fields (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html) +// . The response results are sorted by the frequency percentage, starting with the // highest percentage. If you are using CloudWatch cross-account observability, you // can use this operation in a monitoring account and view data from the linked // source accounts. For more information, see CloudWatch cross-account -// observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) GetLogGroupFields(ctx context.Context, params *GetLogGroupFieldsInput, optFns ...func(*Options)) (*GetLogGroupFieldsOutput, error) { if params == nil { params = &GetLogGroupFieldsInput{} @@ -46,17 +45,17 @@ type GetLogGroupFieldsInput struct { // Specify either the name or ARN of the log group to view. If the log group is in // a source account and you are using a monitoring account, you must specify the - // ARN. You must include either logGroupIdentifier or logGroupName, but not both. + // ARN. You must include either logGroupIdentifier or logGroupName , but not both. LogGroupIdentifier *string // The name of the log group to search. You must include either logGroupIdentifier - // or logGroupName, but not both. + // or logGroupName , but not both. LogGroupName *string - // The time to set as the center of the query. If you specify time, the 15 minutes - // before this time are queries. If you omit time, the 8 minutes before and 8 - // minutes after this time are searched. The time value is specified as epoch time, - // which is the number of seconds since January 1, 1970, 00:00:00 UTC. + // The time to set as the center of the query. If you specify time , the 15 minutes + // before this time are queries. If you omit time , the 8 minutes before and 8 + // minutes after this time are searched. The time value is specified as epoch + // time, which is the number of seconds since January 1, 1970, 00:00:00 UTC . Time *int64 noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_GetLogRecord.go b/service/cloudwatchlogs/api_op_GetLogRecord.go index 1d56f273208..9fb0773cb05 100644 --- a/service/cloudwatchlogs/api_op_GetLogRecord.go +++ b/service/cloudwatchlogs/api_op_GetLogRecord.go @@ -13,7 +13,7 @@ import ( // Retrieves all of the fields and values of a single log event. All fields are // retrieved, even if the original query that produced the logRecordPointer // retrieved only a subset of fields. Fields are returned as field name/field value -// pairs. The full unparsed log event is returned within @message. +// pairs. The full unparsed log event is returned within @message . func (c *Client) GetLogRecord(ctx context.Context, params *GetLogRecordInput, optFns ...func(*Options)) (*GetLogRecordOutput, error) { if params == nil { params = &GetLogRecordInput{} @@ -40,7 +40,7 @@ type GetLogRecordInput struct { LogRecordPointer *string // Specify true to display the log event fields with all sensitive data unmasked - // and visible. The default is false. To use this operation with this parameter, + // and visible. The default is false . To use this operation with this parameter, // you must be signed into an account with the logs:Unmask permission. Unmask bool diff --git a/service/cloudwatchlogs/api_op_GetQueryResults.go b/service/cloudwatchlogs/api_op_GetQueryResults.go index 9dd56f1c54f..dcb3f670e3b 100644 --- a/service/cloudwatchlogs/api_op_GetQueryResults.go +++ b/service/cloudwatchlogs/api_op_GetQueryResults.go @@ -12,19 +12,17 @@ import ( ) // Returns the results from the specified query. Only the fields requested in the -// query are returned, along with a @ptr field, which is the identifier for the log -// record. You can use the value of @ptr in a GetLogRecord -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html) +// query are returned, along with a @ptr field, which is the identifier for the +// log record. You can use the value of @ptr in a GetLogRecord (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html) // operation to get the full log record. GetQueryResults does not start running a -// query. To run a query, use StartQuery -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html). -// If the value of the Status field in the output is Running, this operation -// returns only partial results. If you see a value of Scheduled or Running for the -// status, you can retry the operation later to see the final results. If you are -// using CloudWatch cross-account observability, you can use this operation in a -// monitoring account to start queries in linked source accounts. For more -// information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). +// query. To run a query, use StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) +// . If the value of the Status field in the output is Running , this operation +// returns only partial results. If you see a value of Scheduled or Running for +// the status, you can retry the operation later to see the final results. If you +// are using CloudWatch cross-account observability, you can use this operation in +// a monitoring account to start queries in linked source accounts. For more +// information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error) { if params == nil { params = &GetQueryResultsInput{} @@ -54,20 +52,21 @@ type GetQueryResultsOutput struct { // The log events that matched the query criteria during the most recent time it // ran. The results value is an array of arrays. Each log event is one object in - // the top-level array. Each of these log event objects is an array of field/value + // the top-level array. Each of these log event objects is an array of field / value // pairs. Results [][]types.ResultField - // Includes the number of log events scanned by the query, the number of log events - // that matched the query criteria, and the total number of bytes in the log events - // that were scanned. These values reflect the full raw results of the query. + // Includes the number of log events scanned by the query, the number of log + // events that matched the query criteria, and the total number of bytes in the log + // events that were scanned. These values reflect the full raw results of the + // query. Statistics *types.QueryStatistics // The status of the most recent running of the query. Possible values are - // Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown. Queries - // time out after 15 minutes of runtime. To avoid having your queries time out, - // reduce the time range being searched or partition your query into a number of - // queries. + // Cancelled , Complete , Failed , Running , Scheduled , Timeout , and Unknown . + // Queries time out after 15 minutes of runtime. To avoid having your queries time + // out, reduce the time range being searched or partition your query into a number + // of queries. Status types.QueryStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudwatchlogs/api_op_ListTagsForResource.go b/service/cloudwatchlogs/api_op_ListTagsForResource.go index b63c1cab0a2..8b10e5687ca 100644 --- a/service/cloudwatchlogs/api_op_ListTagsForResource.go +++ b/service/cloudwatchlogs/api_op_ListTagsForResource.go @@ -30,11 +30,11 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The ARN of the resource that you want to view tags for. The ARN format of a log - // group is arn:aws:logs:Region:account-id:log-group:log-group-name The ARN format - // of a destination is arn:aws:logs:Region:account-id:destination:destination-name - // For more information about ARN format, see CloudWatch Logs resources and - // operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). + // group is arn:aws:logs:Region:account-id:log-group:log-group-name The ARN + // format of a destination is + // arn:aws:logs:Region:account-id:destination:destination-name For more + // information about ARN format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . // // This member is required. ResourceArn *string diff --git a/service/cloudwatchlogs/api_op_ListTagsLogGroup.go b/service/cloudwatchlogs/api_op_ListTagsLogGroup.go index 1d49f9b169c..fe0970534af 100644 --- a/service/cloudwatchlogs/api_op_ListTagsLogGroup.go +++ b/service/cloudwatchlogs/api_op_ListTagsLogGroup.go @@ -11,8 +11,7 @@ import ( ) // The ListTagsLogGroup operation is on the path to deprecation. We recommend that -// you use ListTagsForResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) +// you use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) // instead. Lists the tags for the specified log group. // // Deprecated: Please use the generic tagging API ListTagsForResource diff --git a/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go b/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go index 45fcfdb40a5..d3a844e846a 100644 --- a/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go @@ -17,16 +17,14 @@ import ( // policy, log events ingested into the log group before that time are not masked. // By default, when a user views a log event that includes masked data, the // sensitive data is replaced by asterisks. A user who has the logs:Unmask -// permission can use a GetLogEvents -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) -// or FilterLogEvents -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html) -// operation with the unmask parameter set to true to view the unmasked log events. -// Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs -// console by running a CloudWatch Logs Insights query with the unmask query -// command. For more information, including a list of types of data that can be -// audited and masked, see Protect sensitive log data with masking -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html). +// permission can use a GetLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) +// or FilterLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html) +// operation with the unmask parameter set to true to view the unmasked log +// events. Users with the logs:Unmask can also view unmasked data in the +// CloudWatch Logs console by running a CloudWatch Logs Insights query with the +// unmask query command. For more information, including a list of types of data +// that can be audited and masked, see Protect sensitive log data with masking (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) +// . func (c *Client) PutDataProtectionPolicy(ctx context.Context, params *PutDataProtectionPolicyInput, optFns ...func(*Options)) (*PutDataProtectionPolicyOutput, error) { if params == nil { params = &PutDataProtectionPolicyInput{} @@ -51,28 +49,24 @@ type PutDataProtectionPolicyInput struct { // Specify the data protection policy, in JSON. This policy must include two JSON // blocks: - // - // * The first block must include both a DataIdentifer array and an - // Operation property with an Audit action. The DataIdentifer array lists the types - // of sensitive data that you want to mask. For more information about the - // available options, see Types of data that you can mask - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html). - // The Operation property with an Audit action is required to find the sensitive - // data terms. This Audit action must contain a FindingsDestination object. You can - // optionally use that FindingsDestination object to list one or more destinations - // to send audit findings to. If you specify destinations such as log groups, - // Kinesis Data Firehose streams, and S3 buckets, they must already exist. - // - // * The - // second block must include both a DataIdentifer array and an Operation property - // with an Deidentify action. The DataIdentifer array must exactly match the - // DataIdentifer array in the first block of the policy. The Operation property - // with the Deidentify action is what actually masks the data, and it must contain - // the "MaskConfig": {} object. The "MaskConfig": {} object must be empty. - // - // For - // an example data protection policy, see the Examples section on this page. The - // contents of two DataIdentifer arrays must match exactly. + // - The first block must include both a DataIdentifer array and an Operation + // property with an Audit action. The DataIdentifer array lists the types of + // sensitive data that you want to mask. For more information about the available + // options, see Types of data that you can mask (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html) + // . The Operation property with an Audit action is required to find the + // sensitive data terms. This Audit action must contain a FindingsDestination + // object. You can optionally use that FindingsDestination object to list one or + // more destinations to send audit findings to. If you specify destinations such as + // log groups, Kinesis Data Firehose streams, and S3 buckets, they must already + // exist. + // - The second block must include both a DataIdentifer array and an Operation + // property with an Deidentify action. The DataIdentifer array must exactly match + // the DataIdentifer array in the first block of the policy. The Operation + // property with the Deidentify action is what actually masks the data, and it + // must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be + // empty. + // For an example data protection policy, see the Examples section on this page. + // The contents of two DataIdentifer arrays must match exactly. // // This member is required. PolicyDocument *string diff --git a/service/cloudwatchlogs/api_op_PutDestination.go b/service/cloudwatchlogs/api_op_PutDestination.go index e22b25304ee..acdd110d876 100644 --- a/service/cloudwatchlogs/api_op_PutDestination.go +++ b/service/cloudwatchlogs/api_op_PutDestination.go @@ -15,17 +15,14 @@ import ( // destinations for cross-account subscriptions. A destination encapsulates a // physical resource (such as an Amazon Kinesis stream). With a destination, you // can subscribe to a real-time stream of log events for a different account, -// ingested using PutLogEvents -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html). -// Through an access policy, a destination controls what is written to it. By +// ingested using PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) +// . Through an access policy, a destination controls what is written to it. By // default, PutDestination does not set any access policy with the destination, -// which means a cross-account user cannot call PutSubscriptionFilter -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html) +// which means a cross-account user cannot call PutSubscriptionFilter (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html) // against this destination. To enable this, the destination owner must call -// PutDestinationPolicy -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html) -// after PutDestination. To perform a PutDestination operation, you must also have -// the iam:PassRole permission. +// PutDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html) +// after PutDestination . To perform a PutDestination operation, you must also +// have the iam:PassRole permission. func (c *Client) PutDestination(ctx context.Context, params *PutDestinationInput, optFns ...func(*Options)) (*PutDestinationOutput, error) { if params == nil { params = &PutDestinationInput{} @@ -60,8 +57,7 @@ type PutDestinationInput struct { TargetArn *string // An optional list of key-value pairs to associate with the resource. For more - // information about tagging, see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // information about tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) Tags map[string]string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_PutDestinationPolicy.go b/service/cloudwatchlogs/api_op_PutDestinationPolicy.go index 7991a7a1c0c..cf399004508 100644 --- a/service/cloudwatchlogs/api_op_PutDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDestinationPolicy.go @@ -11,10 +11,9 @@ import ( ) // Creates or updates an access policy associated with an existing destination. An -// access policy is an IAM policy document -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) that -// is used to authorize claims to register a subscription filter against a given -// destination. +// access policy is an IAM policy document (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) +// that is used to authorize claims to register a subscription filter against a +// given destination. func (c *Client) PutDestinationPolicy(ctx context.Context, params *PutDestinationPolicyInput, optFns ...func(*Options)) (*PutDestinationPolicyOutput, error) { if params == nil { params = &PutDestinationPolicyInput{} @@ -48,10 +47,9 @@ type PutDestinationPolicyInput struct { // AWS accounts. Before you update a destination policy this way, you must first // update the subscription filters in the accounts that send logs to this // destination. If you do not, the subscription filters might stop working. By - // specifying true for forceUpdate, you are affirming that you have already updated - // the subscription filters. For more information, see Updating an existing - // cross-account subscription - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html) + // specifying true for forceUpdate , you are affirming that you have already + // updated the subscription filters. For more information, see Updating an + // existing cross-account subscription (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html) // If you omit this parameter, the default of false is used. ForceUpdate *bool diff --git a/service/cloudwatchlogs/api_op_PutLogEvents.go b/service/cloudwatchlogs/api_op_PutLogEvents.go index e473098f623..2b912b26681 100644 --- a/service/cloudwatchlogs/api_op_PutLogEvents.go +++ b/service/cloudwatchlogs/api_op_PutLogEvents.go @@ -11,45 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads a batch of log events to the specified log stream. The sequence token is -// now ignored in PutLogEvents actions. PutLogEvents actions are always accepted -// and never return InvalidSequenceTokenException or DataAlreadyAcceptedException -// even if the sequence token is not valid. You can use parallel PutLogEvents -// actions on the same log stream. The batch of events must satisfy the following -// constraints: +// Uploads a batch of log events to the specified log stream. The sequence token +// is now ignored in PutLogEvents actions. PutLogEvents actions are always +// accepted and never return InvalidSequenceTokenException or +// DataAlreadyAcceptedException even if the sequence token is not valid. You can +// use parallel PutLogEvents actions on the same log stream. The batch of events +// must satisfy the following constraints: +// - The maximum batch size is 1,048,576 bytes. This size is calculated as the +// sum of all event messages in UTF-8, plus 26 bytes for each log event. +// - None of the log events in the batch can be more than 2 hours in the future. +// - None of the log events in the batch can be more than 14 days in the past. +// Also, none of the log events can be from earlier than the retention period of +// the log group. +// - The log events in the batch must be in chronological order by their +// timestamp. The timestamp is the time that the event occurred, expressed as the +// number of milliseconds after Jan 1, 1970 00:00:00 UTC . (In Amazon Web +// Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the +// timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss . For example, +// 2017-09-15T13:45:30 .) +// - A batch of log events in a single request cannot span more than 24 hours. +// Otherwise, the operation fails. +// - The maximum number of log events in a batch is 10,000. +// - The quota of five requests per second per log stream has been removed. +// Instead, PutLogEvents actions are throttled based on a per-second per-account +// quota. You can request an increase to the per-second throttling quota by using +// the Service Quotas service. // -// * The maximum batch size is 1,048,576 bytes. This size is -// calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log -// event. -// -// * None of the log events in the batch can be more than 2 hours in the -// future. -// -// * None of the log events in the batch can be more than 14 days in the -// past. Also, none of the log events can be from earlier than the retention period -// of the log group. -// -// * The log events in the batch must be in chronological order -// by their timestamp. The timestamp is the time that the event occurred, expressed -// as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web -// Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the -// timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, -// 2017-09-15T13:45:30.) -// -// * A batch of log events in a single request cannot span -// more than 24 hours. Otherwise, the operation fails. -// -// * The maximum number of log -// events in a batch is 10,000. -// -// * The quota of five requests per second per log -// stream has been removed. Instead, PutLogEvents actions are throttled based on a -// per-second per-account quota. You can request an increase to the per-second -// throttling quota by using the Service Quotas service. -// -// If a call to PutLogEvents -// returns "UnrecognizedClientException" the most likely cause is a non-valid -// Amazon Web Services access key ID or secret key. +// If a call to PutLogEvents returns "UnrecognizedClientException" the most likely +// cause is a non-valid Amazon Web Services access key ID or secret key. func (c *Client) PutLogEvents(ctx context.Context, params *PutLogEventsInput, optFns ...func(*Options)) (*PutLogEventsOutput, error) { if params == nil { params = &PutLogEventsInput{} @@ -82,10 +71,11 @@ type PutLogEventsInput struct { // This member is required. LogStreamName *string - // The sequence token obtained from the response of the previous PutLogEvents call. - // The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents - // actions are now accepted and never return InvalidSequenceTokenException or - // DataAlreadyAcceptedException even if the sequence token is not valid. + // The sequence token obtained from the response of the previous PutLogEvents + // call. The sequenceToken parameter is now ignored in PutLogEvents actions. + // PutLogEvents actions are now accepted and never return + // InvalidSequenceTokenException or DataAlreadyAcceptedException even if the + // sequence token is not valid. SequenceToken *string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_PutMetricFilter.go b/service/cloudwatchlogs/api_op_PutMetricFilter.go index 2167df607b0..3e6c6687e30 100644 --- a/service/cloudwatchlogs/api_op_PutMetricFilter.go +++ b/service/cloudwatchlogs/api_op_PutMetricFilter.go @@ -13,21 +13,20 @@ import ( // Creates or updates a metric filter and associates it with the specified log // group. With metric filters, you can configure rules to extract metric data from -// log events ingested through PutLogEvents -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html). -// The maximum number of metric filters that can be associated with a log group is -// 100. When you create a metric filter, you can also optionally assign a unit and -// dimensions to the metric that is created. Metrics extracted from log events are -// charged as custom metrics. To prevent unexpected high charges, do not specify -// high-cardinality fields such as IPAddress or requestID as dimensions. Each -// different value found for a dimension is treated as a separate metric and +// log events ingested through PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) +// . The maximum number of metric filters that can be associated with a log group +// is 100. When you create a metric filter, you can also optionally assign a unit +// and dimensions to the metric that is created. Metrics extracted from log events +// are charged as custom metrics. To prevent unexpected high charges, do not +// specify high-cardinality fields such as IPAddress or requestID as dimensions. +// Each different value found for a dimension is treated as a separate metric and // accrues charges as a separate custom metric. CloudWatch Logs disables a metric // filter if it generates 1,000 different name/value pairs for your specified // dimensions within a certain amount of time. This helps to prevent accidental // high charges. You can also set up a billing alarm to alert you if your charges -// are higher than expected. For more information, see Creating a Billing Alarm to -// Monitor Your Estimated Amazon Web Services Charges -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). +// are higher than expected. For more information, see Creating a Billing Alarm to +// Monitor Your Estimated Amazon Web Services Charges (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) +// . func (c *Client) PutMetricFilter(ctx context.Context, params *PutMetricFilterInput, optFns ...func(*Options)) (*PutMetricFilterOutput, error) { if params == nil { params = &PutMetricFilterInput{} diff --git a/service/cloudwatchlogs/api_op_PutQueryDefinition.go b/service/cloudwatchlogs/api_op_PutQueryDefinition.go index 8afee3ae64d..0f0678a8b81 100644 --- a/service/cloudwatchlogs/api_op_PutQueryDefinition.go +++ b/service/cloudwatchlogs/api_op_PutQueryDefinition.go @@ -11,12 +11,11 @@ import ( ) // Creates or updates a query definition for CloudWatch Logs Insights. For more -// information, see Analyzing Log Data with CloudWatch Logs Insights -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html). -// To update a query definition, specify its queryDefinitionId in your request. The -// values of name, queryString, and logGroupNames are changed to the values that -// you specify in your update operation. No current values are retained from the -// current query definition. For example, imagine updating a current query +// information, see Analyzing Log Data with CloudWatch Logs Insights (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) +// . To update a query definition, specify its queryDefinitionId in your request. +// The values of name , queryString , and logGroupNames are changed to the values +// that you specify in your update operation. No current values are retained from +// the current query definition. For example, imagine updating a current query // definition that includes log groups. If you don't specify the logGroupNames // parameter in your update operation, the query definition changes to contain no // log groups. You must have the logs:PutQueryDefinition permission to be able to @@ -41,15 +40,15 @@ type PutQueryDefinitionInput struct { // A name for the query definition. If you are saving numerous query definitions, // we recommend that you name them. This way, you can find the ones you want by // using the first part of the name as a filter in the queryDefinitionNamePrefix - // parameter of DescribeQueryDefinitions - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html). + // parameter of DescribeQueryDefinitions (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) + // . // // This member is required. Name *string // The query string to use for this definition. For more information, see - // CloudWatch Logs Insights Query Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). + // CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) + // . // // This member is required. QueryString *string @@ -61,8 +60,7 @@ type PutQueryDefinitionInput struct { // If you are updating a query definition, use this parameter to specify the ID of // the query definition that you want to update. You can use - // DescribeQueryDefinitions - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) + // DescribeQueryDefinitions (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html) // to retrieve the IDs of your saved query definitions. If you are creating a query // definition, do not specify this parameter. CloudWatch generates a unique ID for // the new query definition and include it in the response to this operation. diff --git a/service/cloudwatchlogs/api_op_PutResourcePolicy.go b/service/cloudwatchlogs/api_op_PutResourcePolicy.go index 3d10fdd590e..9156121b181 100644 --- a/service/cloudwatchlogs/api_op_PutResourcePolicy.go +++ b/service/cloudwatchlogs/api_op_PutResourcePolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates a resource policy allowing other Amazon Web Services services -// to put log events to this account, such as Amazon Route 53. An account can have -// up to 10 resource policies per Amazon Web Services Region. +// Creates or updates a resource policy allowing other Amazon Web Services +// services to put log events to this account, such as Amazon Route 53. An account +// can have up to 10 resource policies per Amazon Web Services Region. func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -36,19 +36,17 @@ type PutResourcePolicyInput struct { // parameter is required. The following example creates a resource policy enabling // the Route 53 service to put DNS query logs in to the specified log group. // Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log - // group or log stream. CloudWatch Logs also supports aws:SourceArn - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) - // and aws:SourceAccount - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) + // group or log stream. CloudWatch Logs also supports aws:SourceArn (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn) + // and aws:SourceAccount (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount) // condition context keys. In the example resource policy, you would replace the - // value of SourceArn with the resource making the call from Route 53 to CloudWatch - // Logs. You would also replace the value of SourceAccount with the Amazon Web - // Services account ID making that call. { "Version": "2012-10-17", "Statement": [ - // { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { - // "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", - // "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": - // "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": - // "myAwsAccountId" } } } ] } + // value of SourceArn with the resource making the call from Route 53 to + // CloudWatch Logs. You would also replace the value of SourceAccount with the + // Amazon Web Services account ID making that call. { "Version": "2012-10-17", + // "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", + // "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": + // "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { + // "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { + // "aws:SourceAccount": "myAwsAccountId" } } } ] } PolicyDocument *string // Name of the new policy. This parameter is required. diff --git a/service/cloudwatchlogs/api_op_PutRetentionPolicy.go b/service/cloudwatchlogs/api_op_PutRetentionPolicy.go index 1438d30de7a..05ad3fe1d63 100644 --- a/service/cloudwatchlogs/api_op_PutRetentionPolicy.go +++ b/service/cloudwatchlogs/api_op_PutRetentionPolicy.go @@ -44,11 +44,11 @@ type PutRetentionPolicyInput struct { // This member is required. LogGroupName *string - // The number of days to retain the log events in the specified log group. Possible - // values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, - // 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do - // not expire, use DeleteRetentionPolicy - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html). + // The number of days to retain the log events in the specified log group. + // Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, + // 731, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log + // events do not expire, use DeleteRetentionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) + // . // // This member is required. RetentionInDays *int32 diff --git a/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go b/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go index 3f919b30b03..eb2a4dec983 100644 --- a/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go +++ b/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go @@ -13,31 +13,23 @@ import ( // Creates or updates a subscription filter and associates it with the specified // log group. With subscription filters, you can subscribe to a real-time stream of -// log events ingested through PutLogEvents -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) +// log events ingested through PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) // and have them delivered to a specific destination. When log events are sent to // the receiving service, they are Base64 encoded and compressed with the GZIP // format. The following destinations are supported for subscription filters: +// - An Amazon Kinesis data stream belonging to the same account as the +// subscription filter, for same-account delivery. +// - A logical destination that belongs to a different account, for +// cross-account delivery. +// - An Amazon Kinesis Data Firehose delivery stream that belongs to the same +// account as the subscription filter, for same-account delivery. +// - An Lambda function that belongs to the same account as the subscription +// filter, for same-account delivery. // -// * An -// Amazon Kinesis data stream belonging to the same account as the subscription -// filter, for same-account delivery. -// -// * A logical destination that belongs to a -// different account, for cross-account delivery. -// -// * An Amazon Kinesis Data -// Firehose delivery stream that belongs to the same account as the subscription -// filter, for same-account delivery. -// -// * An Lambda function that belongs to the -// same account as the subscription filter, for same-account delivery. -// -// Each log -// group can have up to two subscription filters associated with it. If you are -// updating an existing filter, you must specify the correct name in filterName. To -// perform a PutSubscriptionFilter operation, you must also have the iam:PassRole -// permission. +// Each log group can have up to two subscription filters associated with it. If +// you are updating an existing filter, you must specify the correct name in +// filterName . To perform a PutSubscriptionFilter operation, you must also have +// the iam:PassRole permission. func (c *Client) PutSubscriptionFilter(ctx context.Context, params *PutSubscriptionFilterInput, optFns ...func(*Options)) (*PutSubscriptionFilterOutput, error) { if params == nil { params = &PutSubscriptionFilterInput{} @@ -57,32 +49,26 @@ type PutSubscriptionFilterInput struct { // The ARN of the destination to deliver matching log events to. Currently, the // supported destinations are: - // - // * An Amazon Kinesis stream belonging to the same - // account as the subscription filter, for same-account delivery. - // - // * A logical - // destination (specified using an ARN) belonging to a different account, for - // cross-account delivery. If you're setting up a cross-account subscription, the - // destination must have an IAM policy associated with it. The IAM policy must - // allow the sender to send logs to the destination. For more information, see - // PutDestinationPolicy - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html). - // - // * - // A Kinesis Data Firehose delivery stream belonging to the same account as the - // subscription filter, for same-account delivery. - // - // * A Lambda function belonging - // to the same account as the subscription filter, for same-account delivery. + // - An Amazon Kinesis stream belonging to the same account as the subscription + // filter, for same-account delivery. + // - A logical destination (specified using an ARN) belonging to a different + // account, for cross-account delivery. If you're setting up a cross-account + // subscription, the destination must have an IAM policy associated with it. The + // IAM policy must allow the sender to send logs to the destination. For more + // information, see PutDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html) + // . + // - A Kinesis Data Firehose delivery stream belonging to the same account as + // the subscription filter, for same-account delivery. + // - A Lambda function belonging to the same account as the subscription filter, + // for same-account delivery. // // This member is required. DestinationArn *string // A name for the subscription filter. If you are updating an existing filter, you - // must specify the correct name in filterName. To find the name of the filter - // currently associated with a log group, use DescribeSubscriptionFilters - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html). + // must specify the correct name in filterName . To find the name of the filter + // currently associated with a log group, use DescribeSubscriptionFilters (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html) + // . // // This member is required. FilterName *string diff --git a/service/cloudwatchlogs/api_op_StartQuery.go b/service/cloudwatchlogs/api_op_StartQuery.go index d4a6bf0ac0c..30fb1e290b3 100644 --- a/service/cloudwatchlogs/api_op_StartQuery.go +++ b/service/cloudwatchlogs/api_op_StartQuery.go @@ -10,19 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Schedules a query of a log group using CloudWatch Logs Insights. You specify the -// log group and time range to query and the query string to use. For more -// information, see CloudWatch Logs Insights Query Syntax -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). -// Queries time out after 15 minutes of runtime. If your queries are timing out, +// Schedules a query of a log group using CloudWatch Logs Insights. You specify +// the log group and time range to query and the query string to use. For more +// information, see CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) +// . Queries time out after 15 minutes of runtime. If your queries are timing out, // reduce the time range being searched or partition your query into a number of // queries. If you are using CloudWatch cross-account observability, you can use // this operation in a monitoring account to start a query in a linked source -// account. For more information, see CloudWatch cross-account observability -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). -// For a cross-account StartQuery operation, the query definition must be defined -// in the monitoring account. You can have up to 20 concurrent CloudWatch Logs -// insights queries, including queries that have been added to dashboards. +// account. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) +// . For a cross-account StartQuery operation, the query definition must be +// defined in the monitoring account. You can have up to 20 concurrent CloudWatch +// Logs insights queries, including queries that have been added to dashboards. func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns ...func(*Options)) (*StartQueryOutput, error) { if params == nil { params = &StartQueryInput{} @@ -40,23 +38,23 @@ func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns type StartQueryInput struct { - // The end of the time range to query. The range is inclusive, so the specified end - // time is included in the query. Specified as epoch time, the number of seconds - // since January 1, 1970, 00:00:00 UTC. + // The end of the time range to query. The range is inclusive, so the specified + // end time is included in the query. Specified as epoch time, the number of + // seconds since January 1, 1970, 00:00:00 UTC . // // This member is required. EndTime *int64 // The query string to use. For more information, see CloudWatch Logs Insights - // Query Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). + // Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) + // . // // This member is required. QueryString *string // The beginning of the time range to query. The range is inclusive, so the // specified start time is included in the query. Specified as epoch time, the - // number of seconds since January 1, 1970, 00:00:00 UTC. + // number of seconds since January 1, 1970, 00:00:00 UTC . // // This member is required. StartTime *int64 @@ -72,17 +70,17 @@ type StartQueryInput struct { // the ARN of the log group here. The query definition must also be defined in the // monitoring account. If you specify an ARN, the ARN can't end with an asterisk // (*). A StartQuery operation must include exactly one of the following - // parameters: logGroupName, logGroupNames or logGroupIdentifiers. + // parameters: logGroupName , logGroupNames or logGroupIdentifiers . LogGroupIdentifiers []string - // The log group on which to perform the query. A StartQuery operation must include - // exactly one of the following parameters: logGroupName, logGroupNames or - // logGroupIdentifiers. + // The log group on which to perform the query. A StartQuery operation must + // include exactly one of the following parameters: logGroupName , logGroupNames + // or logGroupIdentifiers . LogGroupName *string // The list of log groups to be queried. You can include up to 50 log groups. A // StartQuery operation must include exactly one of the following parameters: - // logGroupName, logGroupNames or logGroupIdentifiers. + // logGroupName , logGroupNames or logGroupIdentifiers . LogGroupNames []string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_StopQuery.go b/service/cloudwatchlogs/api_op_StopQuery.go index 60ae990087e..f605c99a4d8 100644 --- a/service/cloudwatchlogs/api_op_StopQuery.go +++ b/service/cloudwatchlogs/api_op_StopQuery.go @@ -30,7 +30,7 @@ func (c *Client) StopQuery(ctx context.Context, params *StopQueryInput, optFns . type StopQueryInput struct { - // The ID number of the query to stop. To find this ID number, use DescribeQueries. + // The ID number of the query to stop. To find this ID number, use DescribeQueries . // // This member is required. QueryId *string diff --git a/service/cloudwatchlogs/api_op_TagLogGroup.go b/service/cloudwatchlogs/api_op_TagLogGroup.go index 36dd15c3341..a221ea561b5 100644 --- a/service/cloudwatchlogs/api_op_TagLogGroup.go +++ b/service/cloudwatchlogs/api_op_TagLogGroup.go @@ -11,21 +11,17 @@ import ( ) // The TagLogGroup operation is on the path to deprecation. We recommend that you -// use TagResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) +// use TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) // instead. Adds or updates the specified tags for the specified log group. To list -// the tags for a log group, use ListTagsForResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html). -// To remove tags, use UntagResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html). -// For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging) +// the tags for a log group, use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) +// . To remove tags, use UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) +// . For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging) // in the Amazon CloudWatch Logs User Guide. CloudWatch Logs doesn’t support IAM // policies that prevent users from assigning specified tags to log groups using // the aws:Resource/key-name or aws:TagKeys condition keys. For more information // about using tags to control access, see Controlling access to Amazon Web -// Services resources using tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). +// Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// . // // Deprecated: Please use the generic tagging API TagResource func (c *Client) TagLogGroup(ctx context.Context, params *TagLogGroupInput, optFns ...func(*Options)) (*TagLogGroupOutput, error) { diff --git a/service/cloudwatchlogs/api_op_TagResource.go b/service/cloudwatchlogs/api_op_TagResource.go index fe5f07aaddc..f3583ae4e61 100644 --- a/service/cloudwatchlogs/api_op_TagResource.go +++ b/service/cloudwatchlogs/api_op_TagResource.go @@ -40,11 +40,11 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The ARN of the resource that you're adding tags to. The ARN format of a log - // group is arn:aws:logs:Region:account-id:log-group:log-group-name The ARN format - // of a destination is arn:aws:logs:Region:account-id:destination:destination-name - // For more information about ARN format, see CloudWatch Logs resources and - // operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). + // group is arn:aws:logs:Region:account-id:log-group:log-group-name The ARN + // format of a destination is + // arn:aws:logs:Region:account-id:destination:destination-name For more + // information about ARN format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . // // This member is required. ResourceArn *string diff --git a/service/cloudwatchlogs/api_op_UntagLogGroup.go b/service/cloudwatchlogs/api_op_UntagLogGroup.go index eb9020bfca6..f97c3f8ef17 100644 --- a/service/cloudwatchlogs/api_op_UntagLogGroup.go +++ b/service/cloudwatchlogs/api_op_UntagLogGroup.go @@ -10,15 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UntagLogGroup operation is on the path to deprecation. We recommend that you -// use UntagResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) +// The UntagLogGroup operation is on the path to deprecation. We recommend that +// you use UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) // instead. Removes the specified tags from the specified log group. To list the -// tags for a log group, use ListTagsForResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html). -// To add tags, use TagResource -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html). -// CloudWatch Logs doesn’t support IAM policies that prevent users from assigning +// tags for a log group, use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) +// . To add tags, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) +// . CloudWatch Logs doesn’t support IAM policies that prevent users from assigning // specified tags to log groups using the aws:Resource/key-name or aws:TagKeys // condition keys. // diff --git a/service/cloudwatchlogs/api_op_UntagResource.go b/service/cloudwatchlogs/api_op_UntagResource.go index 06ffb33aa5e..2c7a20a71f9 100644 --- a/service/cloudwatchlogs/api_op_UntagResource.go +++ b/service/cloudwatchlogs/api_op_UntagResource.go @@ -29,11 +29,11 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The ARN of the CloudWatch Logs resource that you're removing tags from. The ARN - // format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name - // The ARN format of a destination is - // arn:aws:logs:Region:account-id:destination:destination-name For more - // information about ARN format, see CloudWatch Logs resources and operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). + // format of a log group is + // arn:aws:logs:Region:account-id:log-group:log-group-name The ARN format of a + // destination is arn:aws:logs:Region:account-id:destination:destination-name For + // more information about ARN format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . // // This member is required. ResourceArn *string diff --git a/service/cloudwatchlogs/doc.go b/service/cloudwatchlogs/doc.go index 3078e4db773..c8642b3eb87 100644 --- a/service/cloudwatchlogs/doc.go +++ b/service/cloudwatchlogs/doc.go @@ -9,27 +9,23 @@ // Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services // CLI, CloudWatch Logs API, or CloudWatch Logs SDK. You can use CloudWatch Logs // to: -// -// * Monitor logs from EC2 instances in real time: You can use CloudWatch Logs -// to monitor applications and systems using log data. For example, CloudWatch Logs -// can track the number of errors that occur in your application logs. Then, it can -// send you a notification whenever the rate of errors exceeds a threshold that you -// specify. CloudWatch Logs uses your log data for monitoring so no code changes -// are required. For example, you can monitor application logs for specific literal -// terms (such as "NullReferenceException"). You can also count the number of -// occurrences of a literal term at a particular position in log data (such as -// "404" status codes in an Apache access log). When the term you are searching for -// is found, CloudWatch Logs reports the data to a CloudWatch metric that you -// specify. -// -// * Monitor CloudTrail logged events: You can create alarms in -// CloudWatch and receive notifications of particular API activity as captured by -// CloudTrail. You can use the notification to perform troubleshooting. -// -// * Archive -// log data: You can use CloudWatch Logs to store your log data in highly durable -// storage. You can change the log retention setting so that any log events earlier -// than this setting are automatically deleted. The CloudWatch Logs agent helps to -// quickly send both rotated and non-rotated log data off of a host and into the -// log service. You can then access the raw log data when you need it. +// - Monitor logs from EC2 instances in real time: You can use CloudWatch Logs +// to monitor applications and systems using log data. For example, CloudWatch Logs +// can track the number of errors that occur in your application logs. Then, it can +// send you a notification whenever the rate of errors exceeds a threshold that you +// specify. CloudWatch Logs uses your log data for monitoring so no code changes +// are required. For example, you can monitor application logs for specific literal +// terms (such as "NullReferenceException"). You can also count the number of +// occurrences of a literal term at a particular position in log data (such as +// "404" status codes in an Apache access log). When the term you are searching for +// is found, CloudWatch Logs reports the data to a CloudWatch metric that you +// specify. +// - Monitor CloudTrail logged events: You can create alarms in CloudWatch and +// receive notifications of particular API activity as captured by CloudTrail. You +// can use the notification to perform troubleshooting. +// - Archive log data: You can use CloudWatch Logs to store your log data in +// highly durable storage. You can change the log retention setting so that any log +// events earlier than this setting are automatically deleted. The CloudWatch Logs +// agent helps to quickly send both rotated and non-rotated log data off of a host +// and into the log service. You can then access the raw log data when you need it. package cloudwatchlogs diff --git a/service/cloudwatchlogs/types/enums.go b/service/cloudwatchlogs/types/enums.go index b67c8a81a18..77929a3412e 100644 --- a/service/cloudwatchlogs/types/enums.go +++ b/service/cloudwatchlogs/types/enums.go @@ -32,9 +32,9 @@ const ( DistributionByLogStream Distribution = "ByLogStream" ) -// Values returns all known values for Distribution. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Distribution. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Distribution) Values() []Distribution { return []Distribution{ "Random", @@ -147,9 +147,9 @@ const ( StandardUnitNone StandardUnit = "None" ) -// Values returns all known values for StandardUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StandardUnit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StandardUnit) Values() []StandardUnit { return []StandardUnit{ "Seconds", diff --git a/service/cloudwatchlogs/types/errors.go b/service/cloudwatchlogs/types/errors.go index b7e3437d7f1..e2a02af3673 100644 --- a/service/cloudwatchlogs/types/errors.go +++ b/service/cloudwatchlogs/types/errors.go @@ -8,8 +8,8 @@ import ( ) // The event was already logged. PutLogEvents actions are now always accepted and -// never return DataAlreadyAcceptedException regardless of whether a given batch of -// log events has already been accepted. +// never return DataAlreadyAcceptedException regardless of whether a given batch +// of log events has already been accepted. type DataAlreadyAcceptedException struct { Message *string @@ -147,11 +147,10 @@ func (e *LimitExceededException) ErrorCode() string { func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The query string is not valid. Details about this error are displayed in a -// QueryCompileError object. For more information, see QueryCompileError -// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html). -// For more information about valid query syntax, see CloudWatch Logs Insights -// Query Syntax -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). +// QueryCompileError object. For more information, see QueryCompileError (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html) +// . For more information about valid query syntax, see CloudWatch Logs Insights +// Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) +// . type MalformedQueryException struct { Message *string diff --git a/service/cloudwatchlogs/types/types.go b/service/cloudwatchlogs/types/types.go index ed371e1a118..f57744f42c0 100644 --- a/service/cloudwatchlogs/types/types.go +++ b/service/cloudwatchlogs/types/types.go @@ -47,7 +47,7 @@ type ExportTask struct { ExecutionInfo *ExportTaskExecutionInfo // The start time, expressed as the number of milliseconds after Jan 1, 1970 - // 00:00:00 UTC. Events with a timestamp before this time are not exported. + // 00:00:00 UTC . Events with a timestamp before this time are not exported. From *int64 // The name of the log group from which logs data was exported. @@ -62,8 +62,8 @@ type ExportTask struct { // The name of the export task. TaskName *string - // The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 - // UTC. Events with a timestamp later than this time are not exported. + // The end time, expressed as the number of milliseconds after Jan 1, 1970 + // 00:00:00 UTC . Events with a timestamp later than this time are not exported. To *int64 noSmithyDocumentSerde @@ -73,11 +73,11 @@ type ExportTask struct { type ExportTaskExecutionInfo struct { // The completion time of the export task, expressed as the number of milliseconds - // after Jan 1, 1970 00:00:00 UTC. + // after Jan 1, 1970 00:00:00 UTC . CompletionTime *int64 // The creation time of the export task, expressed as the number of milliseconds - // after Jan 1, 1970 00:00:00 UTC. + // after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 noSmithyDocumentSerde @@ -102,7 +102,7 @@ type FilteredLogEvent struct { EventId *string // The time the event was ingested, expressed as the number of milliseconds after - // Jan 1, 1970 00:00:00 UTC. + // Jan 1, 1970 00:00:00 UTC . IngestionTime *int64 // The name of the log stream to which this event belongs. @@ -112,7 +112,7 @@ type FilteredLogEvent struct { Message *string // The time the event occurred, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. + // 1, 1970 00:00:00 UTC . Timestamp *int64 noSmithyDocumentSerde @@ -128,7 +128,7 @@ type InputLogEvent struct { Message *string // The time the event occurred, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. + // 1, 1970 00:00:00 UTC . // // This member is required. Timestamp *int64 @@ -147,8 +147,8 @@ type LogGroup struct { CreationTime *int64 // Displays whether this log group has a protection policy, or whether it had one - // in the past. For more information, see PutDataProtectionPolicy - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html). + // in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html) + // . DataProtectionStatus DataProtectionStatus // The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. @@ -160,11 +160,11 @@ type LogGroup struct { // The number of metric filters. MetricFilterCount *int32 - // The number of days to retain the log events in the specified log group. Possible - // values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, - // 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do - // not expire, use DeleteRetentionPolicy - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html). + // The number of days to retain the log events in the specified log group. + // Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, + // 731, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log + // events do not expire, use DeleteRetentionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) + // . RetentionInDays *int32 // The number of bytes stored. @@ -173,8 +173,8 @@ type LogGroup struct { noSmithyDocumentSerde } -// The fields contained in log events found by a GetLogGroupFields operation, along -// with the percentage of queried log events in which each field appears. +// The fields contained in log events found by a GetLogGroupFields operation, +// along with the percentage of queried log events in which each field appears. type LogGroupField struct { // The name of a log field. @@ -186,26 +186,26 @@ type LogGroupField struct { noSmithyDocumentSerde } -// Represents a log stream, which is a sequence of log events from a single emitter -// of logs. +// Represents a log stream, which is a sequence of log events from a single +// emitter of logs. type LogStream struct { // The Amazon Resource Name (ARN) of the log stream. Arn *string // The creation time of the stream, expressed as the number of milliseconds after - // Jan 1, 1970 00:00:00 UTC. + // Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The time of the first event, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. + // 1, 1970 00:00:00 UTC . FirstEventTimestamp *int64 - // The time of the most recent log event in the log stream in CloudWatch Logs. This - // number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 - // UTC. The lastEventTime value updates on an eventual consistency basis. It - // typically updates in less than an hour from ingestion, but in rare situations - // might take longer. + // The time of the most recent log event in the log stream in CloudWatch Logs. + // This number is expressed as the number of milliseconds after Jan 1, 1970 + // 00:00:00 UTC . The lastEventTime value updates on an eventual consistency + // basis. It typically updates in less than an hour from ingestion, but in rare + // situations might take longer. LastEventTimestamp *int64 // The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 @@ -217,14 +217,14 @@ type LogStream struct { // The name of the log stream. LogStreamName *string - // The number of bytes stored. Important: As of June 17, 2019, this parameter is no - // longer supported for log streams, and is always reported as zero. This change + // The number of bytes stored. Important: As of June 17, 2019, this parameter is + // no longer supported for log streams, and is always reported as zero. This change // applies only to log streams. The storedBytes parameter for log groups is not // affected. // - // Deprecated: Starting on June 17, 2019, this parameter will be deprecated for log - // streams, and will be reported as zero. This change applies only to log streams. - // The storedBytes parameter for log groups is not affected. + // Deprecated: Starting on June 17, 2019, this parameter will be deprecated for + // log streams, and will be reported as zero. This change applies only to log + // streams. The storedBytes parameter for log groups is not affected. StoredBytes *int64 // The sequence token. The sequence token is now ignored in PutLogEvents actions. @@ -242,7 +242,7 @@ type LogStream struct { type MetricFilter struct { // The creation time of the metric filter, expressed as the number of milliseconds - // after Jan 1, 1970 00:00:00 UTC. + // after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The name of the metric filter. @@ -287,9 +287,9 @@ type MetricTransformation struct { // This member is required. MetricName *string - // A custom namespace to contain your metric in CloudWatch. Use namespaces to group - // together metrics that are similar. For more information, see Namespaces - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). + // A custom namespace to contain your metric in CloudWatch. Use namespaces to + // group together metrics that are similar. For more information, see Namespaces (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace) + // . // // This member is required. MetricNamespace *string @@ -304,8 +304,8 @@ type MetricTransformation struct { // This value can be null. DefaultValue *float64 - // The fields to use as dimensions for the metric. One metric filter can include as - // many as three dimensions. Metrics extracted from log events are charged as + // The fields to use as dimensions for the metric. One metric filter can include + // as many as three dimensions. Metrics extracted from log events are charged as // custom metrics. To prevent unexpected high charges, do not specify // high-cardinality fields such as IPAddress or requestID as dimensions. Each // different value found for a dimension is treated as a separate metric and @@ -313,12 +313,12 @@ type MetricTransformation struct { // filter if it generates 1000 different name/value pairs for your specified // dimensions within a certain amount of time. This helps to prevent accidental // high charges. You can also set up a billing alarm to alert you if your charges - // are higher than expected. For more information, see Creating a Billing Alarm to - // Monitor Your Estimated Amazon Web Services Charges - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). + // are higher than expected. For more information, see Creating a Billing Alarm to + // Monitor Your Estimated Amazon Web Services Charges (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html) + // . Dimensions map[string]string - // The unit to assign to the metric. If you omit this, the unit is set as None. + // The unit to assign to the metric. If you omit this, the unit is set as None . Unit StandardUnit noSmithyDocumentSerde @@ -328,14 +328,14 @@ type MetricTransformation struct { type OutputLogEvent struct { // The time the event was ingested, expressed as the number of milliseconds after - // Jan 1, 1970 00:00:00 UTC. + // Jan 1, 1970 00:00:00 UTC . IngestionTime *int64 // The data contained in the log event. Message *string // The time the event occurred, expressed as the number of milliseconds after Jan - // 1, 1970 00:00:00 UTC. + // 1, 1970 00:00:00 UTC . Timestamp *int64 noSmithyDocumentSerde @@ -383,15 +383,15 @@ type QueryDefinition struct { QueryDefinitionId *string // The query string to use for this definition. For more information, see - // CloudWatch Logs Insights Query Syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). + // CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) + // . QueryString *string noSmithyDocumentSerde } -// Information about one CloudWatch Logs Insights query that matches the request in -// a DescribeQueries operation. +// Information about one CloudWatch Logs Insights query that matches the request +// in a DescribeQueries operation. type QueryInfo struct { // The date and time that this query was created. @@ -406,16 +406,16 @@ type QueryInfo struct { // The query string used in this query. QueryString *string - // The status of this query. Possible values are Cancelled, Complete, Failed, - // Running, Scheduled, and Unknown. + // The status of this query. Possible values are Cancelled , Complete , Failed , + // Running , Scheduled , and Unknown . Status QueryStatus noSmithyDocumentSerde } -// Contains the number of log events scanned by the query, the number of log events -// that matched the query criteria, and the total number of bytes in the log events -// that were scanned. +// Contains the number of log events scanned by the query, the number of log +// events that matched the query criteria, and the total number of bytes in the log +// events that were scanned. type QueryStatistics struct { // The total number of bytes in the log events scanned during the query. @@ -450,7 +450,7 @@ type RejectedLogEventsInfo struct { type ResourcePolicy struct { // Timestamp showing when this policy was last updated, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. + // milliseconds after Jan 1, 1970 00:00:00 UTC . LastUpdatedTime *int64 // The details of the policy. @@ -464,8 +464,8 @@ type ResourcePolicy struct { // Contains one field from one log event returned by a CloudWatch Logs Insights // query, along with the value of that field. For more information about the fields -// that are generated by CloudWatch logs, see Supported Logs and Discovered Fields -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html). +// that are generated by CloudWatch logs, see Supported Logs and Discovered Fields (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html) +// . type ResultField struct { // The log event field. @@ -493,7 +493,7 @@ type SearchedLogStream struct { type SubscriptionFilter struct { // The creation time of the subscription filter, expressed as the number of - // milliseconds after Jan 1, 1970 00:00:00 UTC. + // milliseconds after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The Amazon Resource Name (ARN) of the destination. diff --git a/service/codeartifact/api_client.go b/service/codeartifact/api_client.go index 949ceb198da..5c503c3491e 100644 --- a/service/codeartifact/api_client.go +++ b/service/codeartifact/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codeartifact/api_op_AssociateExternalConnection.go b/service/codeartifact/api_op_AssociateExternalConnection.go index 83bb84dc545..ad783484c3c 100644 --- a/service/codeartifact/api_op_AssociateExternalConnection.go +++ b/service/codeartifact/api_op_AssociateExternalConnection.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds an existing external connection to a repository. One external connection is -// allowed per repository. A repository can have one or more upstream repositories, -// or an external connection. +// Adds an existing external connection to a repository. One external connection +// is allowed per repository. A repository can have one or more upstream +// repositories, or an external connection. func (c *Client) AssociateExternalConnection(ctx context.Context, params *AssociateExternalConnectionInput, optFns ...func(*Options)) (*AssociateExternalConnectionOutput, error) { if params == nil { params = &AssociateExternalConnectionInput{} @@ -38,28 +38,14 @@ type AssociateExternalConnectionInput struct { // The name of the external connection to add to the repository. The following // values are supported: - // - // * public:npmjs - for the npm public repository. - // - // * - // public:nuget-org - for the NuGet Gallery. - // - // * public:pypi - for the Python - // Package Index. - // - // * public:maven-central - for Maven Central. - // - // * - // public:maven-googleandroid - for the Google Android repository. - // - // * - // public:maven-gradleplugins - for the Gradle plugins repository. - // - // * - // public:maven-commonsware - for the CommonsWare Android repository. - // - // * - // public:maven-clojars - for the Clojars repository. + // - public:npmjs - for the npm public repository. + // - public:nuget-org - for the NuGet Gallery. + // - public:pypi - for the Python Package Index. + // - public:maven-central - for Maven Central. + // - public:maven-googleandroid - for the Google Android repository. + // - public:maven-gradleplugins - for the Gradle plugins repository. + // - public:maven-commonsware - for the CommonsWare Android repository. + // - public:maven-clojars - for the Clojars repository. // // This member is required. ExternalConnection *string diff --git a/service/codeartifact/api_op_CopyPackageVersions.go b/service/codeartifact/api_op_CopyPackageVersions.go index e9d022e7120..0fb9a4e84cd 100644 --- a/service/codeartifact/api_op_CopyPackageVersions.go +++ b/service/codeartifact/api_op_CopyPackageVersions.go @@ -12,7 +12,7 @@ import ( ) // Copies package versions from one repository to another repository in the same -// domain. You must specify versions or versionRevisions. You cannot specify both. +// domain. You must specify versions or versionRevisions . You cannot specify both. func (c *Client) CopyPackageVersions(ctx context.Context, params *CopyPackageVersionsInput, optFns ...func(*Options)) (*CopyPackageVersionsOutput, error) { if params == nil { params = &CopyPackageVersionsInput{} @@ -65,38 +65,31 @@ type CopyPackageVersionsInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // Set to true to copy packages from repositories that are upstream from the source - // repository to the destination repository. The default setting is false. For more - // information, see Working with upstream repositories - // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). + // Set to true to copy packages from repositories that are upstream from the + // source repository to the destination repository. The default setting is false. + // For more information, see Working with upstream repositories (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) + // . IncludeFromUpstream *bool // The namespace of the package versions to be copied. The package version // component that specifies its namespace depends on its type. For example: - // - // * The - // namespace of a Maven package version is its groupId. The namespace is required - // when copying Maven package versions. - // - // * The namespace of an npm package version - // is its scope. - // - // * Python and NuGet package versions do not contain a - // corresponding component, package versions of those formats do not have a - // namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . The namespace is + // required when copying Maven package versions. + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // A list of key-value pairs. The keys are package versions and the values are // package version revisions. A CopyPackageVersion operation succeeds if the // specified versions in the source repository match the specified package version - // revision. You must specify versions or versionRevisions. You cannot specify + // revision. You must specify versions or versionRevisions . You cannot specify // both. VersionRevisions map[string]string // The versions of the package to be copied. You must specify versions or - // versionRevisions. You cannot specify both. + // versionRevisions . You cannot specify both. Versions []string noSmithyDocumentSerde @@ -106,20 +99,12 @@ type CopyPackageVersionsOutput struct { // A map of package versions that failed to copy and their error codes. The // possible error codes are in the PackageVersionError data type. They are: - // - // * - // ALREADY_EXISTS - // - // * MISMATCHED_REVISION - // - // * MISMATCHED_STATUS - // - // * NOT_ALLOWED - // - // * - // NOT_FOUND - // - // * SKIPPED + // - ALREADY_EXISTS + // - MISMATCHED_REVISION + // - MISMATCHED_STATUS + // - NOT_ALLOWED + // - NOT_FOUND + // - SKIPPED FailedVersions map[string]types.PackageVersionError // A list of the package versions that were successfully copied to your repository. diff --git a/service/codeartifact/api_op_CreateDomain.go b/service/codeartifact/api_op_CreateDomain.go index 54e84bbc9a5..d017decfab2 100644 --- a/service/codeartifact/api_op_CreateDomain.go +++ b/service/codeartifact/api_op_CreateDomain.go @@ -46,17 +46,14 @@ type CreateDomainInput struct { // The encryption key for the domain. This is used to encrypt content stored in a // domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a - // key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must + // key alias, or a key alias ARN. To specify an encryptionKey , your IAM role must // have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that - // is used. For more information, see DescribeKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax) + // is used. For more information, see DescribeKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax) // in the Key Management Service API Reference and Key Management Service API - // Permissions Reference - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) + // Permissions Reference (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // in the Key Management Service Developer Guide. CodeArtifact supports only // symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more - // information, see Using symmetric and asymmetric keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // information, see Using symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. EncryptionKey *string diff --git a/service/codeartifact/api_op_CreateRepository.go b/service/codeartifact/api_op_CreateRepository.go index eb844914faf..53b47291f56 100644 --- a/service/codeartifact/api_op_CreateRepository.go +++ b/service/codeartifact/api_op_CreateRepository.go @@ -52,8 +52,8 @@ type CreateRepositoryInput struct { // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when // CodeArtifact looks for a requested package version. For more information, see - // Working with upstream repositories - // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). + // Working with upstream repositories (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) + // . Upstreams []types.UpstreamRepository noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go index 52d77ba433d..2deb0de0d96 100644 --- a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go @@ -38,9 +38,9 @@ type DeleteDomainPermissionsPolicyInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The current revision of the resource policy to be deleted. This revision is used - // for optimistic locking, which prevents others from overwriting your changes to - // the domain's resource policy. + // The current revision of the resource policy to be deleted. This revision is + // used for optimistic locking, which prevents others from overwriting your changes + // to the domain's resource policy. PolicyRevision *string noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_DeletePackage.go b/service/codeartifact/api_op_DeletePackage.go index c6637a5c00b..962ecb30ead 100644 --- a/service/codeartifact/api_op_DeletePackage.go +++ b/service/codeartifact/api_op_DeletePackage.go @@ -13,8 +13,7 @@ import ( // Deletes a package and all associated package versions. A deleted package cannot // be restored. To delete one or more package versions, use the -// DeletePackageVersions -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html) +// DeletePackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html) // API. func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error) { if params == nil { @@ -57,20 +56,14 @@ type DeletePackageInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The namespace of the package to delete. The package component that specifies its - // namespace depends on its type. For example: - // - // * The namespace of a Maven package - // is its groupId. The namespace is required when deleting Maven package - // versions. - // - // * The namespace of an npm package is its scope. - // - // * Python and NuGet - // packages do not contain corresponding components, packages of those formats do - // not have a namespace. - // - // * The namespace of a generic package is its namespace. + // The namespace of the package to delete. The package component that specifies + // its namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . The namespace is required + // when deleting Maven package versions. + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain corresponding components, packages + // of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_DeletePackageVersions.go b/service/codeartifact/api_op_DeletePackageVersions.go index d74f4b98ebd..a58b23f8947 100644 --- a/service/codeartifact/api_op_DeletePackageVersions.go +++ b/service/codeartifact/api_op_DeletePackageVersions.go @@ -13,12 +13,11 @@ import ( // Deletes one or more versions of a package. A deleted package version cannot be // restored in your repository. If you want to remove a package version from your -// repository and be able to restore it later, set its status to Archived. Archived -// packages cannot be downloaded from a repository and don't show up with list -// package APIs (for example, ListPackageVersions -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html)), -// but you can restore them using UpdatePackageVersionsStatus -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html). +// repository and be able to restore it later, set its status to Archived . +// Archived packages cannot be downloaded from a repository and don't show up with +// list package APIs (for example, ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) +// ), but you can restore them using UpdatePackageVersionsStatus (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html) +// . func (c *Client) DeletePackageVersions(ctx context.Context, params *DeletePackageVersionsInput, optFns ...func(*Options)) (*DeletePackageVersionsOutput, error) { if params == nil { params = &DeletePackageVersionsInput{} @@ -70,19 +69,12 @@ type DeletePackageVersionsInput struct { // The namespace of the package versions to be deleted. The package version // component that specifies its namespace depends on its type. For example: - // - // * The - // namespace of a Maven package version is its groupId. The namespace is required - // when deleting Maven package versions. - // - // * The namespace of an npm package version - // is its scope. - // - // * Python and NuGet package versions do not contain a - // corresponding component, package versions of those formats do not have a - // namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . The namespace is + // required when deleting Maven package versions. + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string noSmithyDocumentSerde @@ -90,25 +82,18 @@ type DeletePackageVersionsInput struct { type DeletePackageVersionsOutput struct { - // A PackageVersionError object that contains a map of errors codes for the deleted - // package that failed. The possible error codes are: - // - // * ALREADY_EXISTS - // - // * - // MISMATCHED_REVISION - // - // * MISMATCHED_STATUS - // - // * NOT_ALLOWED - // - // * NOT_FOUND - // - // * SKIPPED + // A PackageVersionError object that contains a map of errors codes for the + // deleted package that failed. The possible error codes are: + // - ALREADY_EXISTS + // - MISMATCHED_REVISION + // - MISMATCHED_STATUS + // - NOT_ALLOWED + // - NOT_FOUND + // - SKIPPED FailedVersions map[string]types.PackageVersionError // A list of the package versions that were successfully deleted. The status of - // every successful version will be Deleted. + // every successful version will be Deleted . SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go index 9f45c5fee07..ea6b90c0fee 100644 --- a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the resource policy that is set on a repository. After a resource policy -// is deleted, the permissions allowed and denied by the deleted policy are +// Deletes the resource policy that is set on a repository. After a resource +// policy is deleted, the permissions allowed and denied by the deleted policy are // removed. The effect of deleting a resource policy might not be immediate. Use // DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, // Amazon Web Services users, roles, and accounts lose permissions to perform the @@ -34,8 +34,8 @@ func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params * type DeleteRepositoryPermissionsPolicyInput struct { - // The name of the domain that contains the repository associated with the resource - // policy to be deleted. + // The name of the domain that contains the repository associated with the + // resource policy to be deleted. // // This member is required. Domain *string @@ -50,9 +50,9 @@ type DeleteRepositoryPermissionsPolicyInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The revision of the repository's resource policy to be deleted. This revision is - // used for optimistic locking, which prevents others from accidentally overwriting - // your changes to the repository's resource policy. + // The revision of the repository's resource policy to be deleted. This revision + // is used for optimistic locking, which prevents others from accidentally + // overwriting your changes to the repository's resource policy. PolicyRevision *string noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_DescribeDomain.go b/service/codeartifact/api_op_DescribeDomain.go index 389301e4fc1..36f1ba4b505 100644 --- a/service/codeartifact/api_op_DescribeDomain.go +++ b/service/codeartifact/api_op_DescribeDomain.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a DomainDescription -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html) +// Returns a DomainDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html) // object that contains information about the requested domain. func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error) { if params == nil { diff --git a/service/codeartifact/api_op_DescribePackage.go b/service/codeartifact/api_op_DescribePackage.go index 93d617e785c..586b1503379 100644 --- a/service/codeartifact/api_op_DescribePackage.go +++ b/service/codeartifact/api_op_DescribePackage.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a PackageDescription -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) +// Returns a PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) // object that contains information about the requested package. func (c *Client) DescribePackage(ctx context.Context, params *DescribePackageInput, optFns ...func(*Options)) (*DescribePackageOutput, error) { if params == nil { @@ -55,20 +54,14 @@ type DescribePackageInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The namespace of the requested package. The package component that specifies its - // namespace depends on its type. For example: - // - // * The namespace of a Maven package - // is its groupId. The namespace is required when requesting Maven packages. - // - // * The - // namespace of an npm package is its scope. - // - // * Python and NuGet packages do not - // contain a corresponding component, packages of those formats do not have a - // namespace. - // - // * The namespace of a generic package is its namespace. + // The namespace of the requested package. The package component that specifies + // its namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . The namespace is required + // when requesting Maven packages. + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string noSmithyDocumentSerde @@ -76,8 +69,7 @@ type DescribePackageInput struct { type DescribePackageOutput struct { - // A PackageDescription - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) + // A PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) // object that contains information about the requested package. // // This member is required. diff --git a/service/codeartifact/api_op_DescribePackageVersion.go b/service/codeartifact/api_op_DescribePackageVersion.go index 7d1f71f7f20..de271284bf4 100644 --- a/service/codeartifact/api_op_DescribePackageVersion.go +++ b/service/codeartifact/api_op_DescribePackageVersion.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a PackageVersionDescription -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) +// Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) // object that contains information about the requested package version. func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePackageVersionInput, optFns ...func(*Options)) (*DescribePackageVersionOutput, error) { if params == nil { @@ -47,7 +46,7 @@ type DescribePackageVersionInput struct { // This member is required. Package *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). // // This member is required. PackageVersion *string @@ -63,18 +62,11 @@ type DescribePackageVersionInput struct { // The namespace of the requested package version. The package version component // that specifies its namespace depends on its type. For example: - // - // * The namespace - // of a Maven package version is its groupId. - // - // * The namespace of an npm package - // version is its scope. - // - // * Python and NuGet package versions do not contain a - // corresponding component, package versions of those formats do not have a - // namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string noSmithyDocumentSerde @@ -82,8 +74,7 @@ type DescribePackageVersionInput struct { type DescribePackageVersionOutput struct { - // A PackageVersionDescription - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) + // A PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) // object that contains information about the requested package version. // // This member is required. diff --git a/service/codeartifact/api_op_DisposePackageVersions.go b/service/codeartifact/api_op_DisposePackageVersions.go index d0784238e66..a6faad893ec 100644 --- a/service/codeartifact/api_op_DisposePackageVersions.go +++ b/service/codeartifact/api_op_DisposePackageVersions.go @@ -12,15 +12,13 @@ import ( ) // Deletes the assets in package versions and sets the package versions' status to -// Disposed. A disposed package version cannot be restored in your repository +// Disposed . A disposed package version cannot be restored in your repository // because its assets are deleted. To view all disposed package versions in a -// repository, use ListPackageVersions -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) -// and set the status -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax) -// parameter to Disposed. To view information about a disposed package version, use -// DescribePackageVersion -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html). +// repository, use ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) +// and set the status (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax) +// parameter to Disposed . To view information about a disposed package version, +// use DescribePackageVersion (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html) +// . func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePackageVersionsInput, optFns ...func(*Options)) (*DisposePackageVersionsOutput, error) { if params == nil { params = &DisposePackageVersionsInput{} @@ -73,18 +71,11 @@ type DisposePackageVersionsInput struct { // The namespace of the package versions to be disposed. The package version // component that specifies its namespace depends on its type. For example: - // - // * The - // namespace of a Maven package version is its groupId. - // - // * The namespace of an npm - // package version is its scope. - // - // * Python and NuGet package versions do not - // contain a corresponding component, package versions of those formats do not have - // a namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The revisions of the package versions you want to dispose. @@ -97,20 +88,12 @@ type DisposePackageVersionsOutput struct { // A PackageVersionError object that contains a map of errors codes for the // disposed package versions that failed. The possible error codes are: - // - // * - // ALREADY_EXISTS - // - // * MISMATCHED_REVISION - // - // * MISMATCHED_STATUS - // - // * NOT_ALLOWED - // - // * - // NOT_FOUND - // - // * SKIPPED + // - ALREADY_EXISTS + // - MISMATCHED_REVISION + // - MISMATCHED_STATUS + // - NOT_ALLOWED + // - NOT_FOUND + // - SKIPPED FailedVersions map[string]types.PackageVersionError // A list of the package versions that were successfully disposed. diff --git a/service/codeartifact/api_op_GetAuthorizationToken.go b/service/codeartifact/api_op_GetAuthorizationToken.go index 76cb6847bf2..3687af6de70 100644 --- a/service/codeartifact/api_op_GetAuthorizationToken.go +++ b/service/codeartifact/api_op_GetAuthorizationToken.go @@ -14,9 +14,8 @@ import ( // Generates a temporary authorization token for accessing repositories in the // domain. This API requires the codeartifact:GetAuthorizationToken and // sts:GetServiceBearerToken permissions. For more information about authorization -// tokens, see CodeArtifact authentication and tokens -// (https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html). -// CodeArtifact authorization tokens are valid for a period of 12 hours when +// tokens, see CodeArtifact authentication and tokens (https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html) +// . CodeArtifact authorization tokens are valid for a period of 12 hours when // created with the login command. You can call login periodically to refresh the // token. When you create an authorization token with the GetAuthorizationToken // API, you can set a custom authorization period, up to a maximum of 12 hours, @@ -26,9 +25,8 @@ import ( // duration of the role. For example, if you call sts assume-role and specify a // session duration of 15 minutes, then generate a CodeArtifact authorization // token, the token will be valid for the full authorization period even though -// this is longer than the 15-minute session duration. See Using IAM Roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) for more -// information on controlling session duration. +// this is longer than the 15-minute session duration. See Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) +// for more information on controlling session duration. func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error) { if params == nil { params = &GetAuthorizationTokenInput{} diff --git a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go index 3d0384bb144..e1a5fae2613 100644 --- a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go @@ -13,8 +13,7 @@ import ( // Returns the resource policy attached to the specified domain. The policy is a // resource-based policy, not an identity-based policy. For more information, see -// Identity-based policies and resource-based policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) +// Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) // in the IAM User Guide. func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDomainPermissionsPolicyInput, optFns ...func(*Options)) (*GetDomainPermissionsPolicyOutput, error) { if params == nil { diff --git a/service/codeartifact/api_op_GetPackageVersionAsset.go b/service/codeartifact/api_op_GetPackageVersionAsset.go index 3cca74f01c1..899d37ac32c 100644 --- a/service/codeartifact/api_op_GetPackageVersionAsset.go +++ b/service/codeartifact/api_op_GetPackageVersionAsset.go @@ -43,8 +43,8 @@ type GetPackageVersionAssetInput struct { // This member is required. Domain *string - // A format that specifies the type of the package version with the requested asset - // file. + // A format that specifies the type of the package version with the requested + // asset file. // // This member is required. Format types.PackageFormat @@ -54,7 +54,7 @@ type GetPackageVersionAssetInput struct { // This member is required. Package *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). // // This member is required. PackageVersion *string @@ -69,20 +69,13 @@ type GetPackageVersionAssetInput struct { DomainOwner *string // The namespace of the package version with the requested asset file. The package - // version component that specifies its namespace depends on its type. For - // example: + // version component that specifies its namespace depends on its type. For example: // - // * The namespace of a Maven package version is its groupId. - // - // * The - // namespace of an npm package version is its scope. - // - // * Python and NuGet package - // versions do not contain a corresponding component, package versions of those - // formats do not have a namespace. - // - // * The namespace of a generic package is its - // namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The name of the package version revision that contains the requested asset. @@ -99,7 +92,7 @@ type GetPackageVersionAssetOutput struct { // The name of the asset that is downloaded. AssetName *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). PackageVersion *string // The name of the package version revision that contains the downloaded asset. diff --git a/service/codeartifact/api_op_GetPackageVersionReadme.go b/service/codeartifact/api_op_GetPackageVersionReadme.go index 16fa455124d..8f5c8855ff2 100644 --- a/service/codeartifact/api_op_GetPackageVersionReadme.go +++ b/service/codeartifact/api_op_GetPackageVersionReadme.go @@ -48,7 +48,7 @@ type GetPackageVersionReadmeInput struct { // This member is required. Package *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). // // This member is required. PackageVersion *string @@ -62,15 +62,12 @@ type GetPackageVersionReadmeInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The namespace of the package version with the requested readme file. The package - // version component that specifies its namespace depends on its type. For + // The namespace of the package version with the requested readme file. The + // package version component that specifies its namespace depends on its type. For // example: - // - // * The namespace of an npm package version is its scope. - // - // * Python and - // NuGet package versions do not contain a corresponding component, package - // versions of those formats do not have a namespace. + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. Namespace *string noSmithyDocumentSerde @@ -81,18 +78,13 @@ type GetPackageVersionReadmeOutput struct { // The format of the package with the requested readme file. Format types.PackageFormat - // The namespace of the package version with the requested readme file. The package - // version component that specifies its namespace depends on its type. For + // The namespace of the package version with the requested readme file. The + // package version component that specifies its namespace depends on its type. For // example: - // - // * The namespace of a Maven package version is its groupId. - // - // * The - // namespace of an npm package version is its scope. - // - // * Python and NuGet package - // versions do not contain a corresponding component, package versions of those - // formats do not have a namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. Namespace *string // The name of the package that contains the returned readme file. diff --git a/service/codeartifact/api_op_GetRepositoryEndpoint.go b/service/codeartifact/api_op_GetRepositoryEndpoint.go index 8642a9e0d3d..8e46fc5a9b5 100644 --- a/service/codeartifact/api_op_GetRepositoryEndpoint.go +++ b/service/codeartifact/api_op_GetRepositoryEndpoint.go @@ -11,16 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the endpoint of a repository for a specific package format. A repository -// has one endpoint for each package format: -// -// * maven -// -// * npm -// -// * nuget -// -// * pypi +// Returns the endpoint of a repository for a specific package format. A +// repository has one endpoint for each package format: +// - maven +// - npm +// - nuget +// - pypi func (c *Client) GetRepositoryEndpoint(ctx context.Context, params *GetRepositoryEndpointInput, optFns ...func(*Options)) (*GetRepositoryEndpointOutput, error) { if params == nil { params = &GetRepositoryEndpointInput{} diff --git a/service/codeartifact/api_op_ListDomains.go b/service/codeartifact/api_op_ListDomains.go index c835f516a02..a6433c6406d 100644 --- a/service/codeartifact/api_op_ListDomains.go +++ b/service/codeartifact/api_op_ListDomains.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of DomainSummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) +// Returns a list of DomainSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) // objects for all domains owned by the Amazon Web Services account that makes this // call. Each returned DomainSummary object contains information about a domain. func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error) { @@ -45,8 +44,7 @@ type ListDomainsInput struct { type ListDomainsOutput struct { - // The returned list of DomainSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainSummary.html) + // The returned list of DomainSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainSummary.html) // objects. Domains []types.DomainSummary diff --git a/service/codeartifact/api_op_ListPackageVersionAssets.go b/service/codeartifact/api_op_ListPackageVersionAssets.go index 13f80b9d3f2..bb0c1fcf88a 100644 --- a/service/codeartifact/api_op_ListPackageVersionAssets.go +++ b/service/codeartifact/api_op_ListPackageVersionAssets.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of AssetSummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) +// Returns a list of AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) // objects for assets in a package version. func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPackageVersionAssetsInput, optFns ...func(*Options)) (*ListPackageVersionAssetsOutput, error) { if params == nil { @@ -48,13 +47,13 @@ type ListPackageVersionAssetsInput struct { // This member is required. Package *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). // // This member is required. PackageVersion *string - // The name of the repository that contains the package that contains the requested - // package version assets. + // The name of the repository that contains the package that contains the + // requested package version assets. // // This member is required. Repository *string @@ -66,21 +65,14 @@ type ListPackageVersionAssetsInput struct { // The maximum number of results to return per page. MaxResults *int32 - // The namespace of the package version that contains the requested package version - // assets. The package version component that specifies its namespace depends on - // its type. For example: - // - // * The namespace of a Maven package version is its - // groupId. - // - // * The namespace of an npm package version is its scope. - // - // * Python and - // NuGet package versions do not contain a corresponding component, package - // versions of those formats do not have a namespace. - // - // * The namespace of a generic - // package is its namespace. + // The namespace of the package version that contains the requested package + // version assets. The package version component that specifies its namespace + // depends on its type. For example: + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The token for the next set of results. Use the value returned in the previous @@ -92,26 +84,20 @@ type ListPackageVersionAssetsInput struct { type ListPackageVersionAssetsOutput struct { - // The returned list of AssetSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) + // The returned list of AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) // objects. Assets []types.AssetSummary // The format of the package that contains the requested package version assets. Format types.PackageFormat - // The namespace of the package version that contains the requested package version - // assets. The package version component that specifies its namespace depends on - // its type. For example: - // - // * The namespace of a Maven package version is its - // groupId. - // - // * The namespace of an npm package version is its scope. - // - // * Python and - // NuGet package versions do not contain a corresponding component, package - // versions of those formats do not have a namespace. + // The namespace of the package version that contains the requested package + // version assets. The package version component that specifies its namespace + // depends on its type. For example: + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. Namespace *string // If there are additional results, this is the token for the next set of results. diff --git a/service/codeartifact/api_op_ListPackageVersionDependencies.go b/service/codeartifact/api_op_ListPackageVersionDependencies.go index 751153432f2..4a69e23c12f 100644 --- a/service/codeartifact/api_op_ListPackageVersionDependencies.go +++ b/service/codeartifact/api_op_ListPackageVersionDependencies.go @@ -12,12 +12,11 @@ import ( ) // Returns the direct dependencies for a package version. The dependencies are -// returned as PackageDependency -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) +// returned as PackageDependency (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) // objects. CodeArtifact extracts the dependencies for a package version from the -// metadata file for the package format (for example, the package.json file for npm -// packages and the pom.xml file for Maven). Any package version dependencies that -// are not listed in the configuration file are not returned. +// metadata file for the package format (for example, the package.json file for +// npm packages and the pom.xml file for Maven). Any package version dependencies +// that are not listed in the configuration file are not returned. func (c *Client) ListPackageVersionDependencies(ctx context.Context, params *ListPackageVersionDependenciesInput, optFns ...func(*Options)) (*ListPackageVersionDependenciesOutput, error) { if params == nil { params = &ListPackageVersionDependenciesInput{} @@ -51,7 +50,7 @@ type ListPackageVersionDependenciesInput struct { // This member is required. Package *string - // A string that contains the package version (for example, 3.5.2). + // A string that contains the package version (for example, 3.5.2 ). // // This member is required. PackageVersion *string @@ -68,18 +67,11 @@ type ListPackageVersionDependenciesInput struct { // The namespace of the package version with the requested dependencies. The // package version component that specifies its namespace depends on its type. For // example: - // - // * The namespace of a Maven package version is its groupId. - // - // * The - // namespace of an npm package version is its scope. - // - // * Python and NuGet package - // versions do not contain a corresponding component, package versions of those - // formats do not have a namespace. - // - // * The namespace of a generic package is its - // namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The token for the next set of results. Use the value returned in the previous @@ -91,8 +83,7 @@ type ListPackageVersionDependenciesInput struct { type ListPackageVersionDependenciesOutput struct { - // The returned list of PackageDependency - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) + // The returned list of PackageDependency (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) // objects. Dependencies []types.PackageDependency @@ -103,15 +94,10 @@ type ListPackageVersionDependenciesOutput struct { // The namespace of the package version that contains the returned dependencies. // The package version component that specifies its namespace depends on its type. // For example: - // - // * The namespace of a Maven package version is its groupId. - // - // * The - // namespace of an npm package version is its scope. - // - // * Python and NuGet package - // versions do not contain a corresponding component, package versions of those - // formats do not have a namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. Namespace *string // The token for the next set of results. Use the value returned in the previous diff --git a/service/codeartifact/api_op_ListPackageVersions.go b/service/codeartifact/api_op_ListPackageVersions.go index bdf90f5d6b1..c01565feb09 100644 --- a/service/codeartifact/api_op_ListPackageVersions.go +++ b/service/codeartifact/api_op_ListPackageVersions.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of PackageVersionSummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) +// Returns a list of PackageVersionSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) // objects for package versions in a repository that match the request parameters. // Package versions of all statuses will be returned by default when calling // list-package-versions with no --status parameter. @@ -63,19 +62,13 @@ type ListPackageVersionsInput struct { MaxResults *int32 // The namespace of the package that contains the requested package versions. The - // package component that specifies its namespace depends on its type. For - // example: + // package component that specifies its namespace depends on its type. For example: // - // * The namespace of a Maven package is its groupId. - // - // * The namespace of - // an npm package is its scope. - // - // * Python and NuGet packages do not contain a - // corresponding component, packages of those formats do not have a namespace. - // - // * - // The namespace of a generic package is its namespace. + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The token for the next set of results. Use the value returned in the previous @@ -98,29 +91,22 @@ type ListPackageVersionsInput struct { type ListPackageVersionsOutput struct { // The default package version to display. This depends on the package format: - // - // * - // For Maven and PyPI packages, it's the most recently published package - // version. - // - // * For npm packages, it's the version referenced by the latest tag. If - // the latest tag is not set, it's the most recently published package version. + // - For Maven and PyPI packages, it's the most recently published package + // version. + // - For npm packages, it's the version referenced by the latest tag. If the + // latest tag is not set, it's the most recently published package version. DefaultDisplayVersion *string // A format of the package. Format types.PackageFormat // The namespace of the package that contains the requested package versions. The - // package component that specifies its namespace depends on its type. For - // example: - // - // * The namespace of a Maven package is its groupId. - // - // * The namespace of - // an npm package is its scope. + // package component that specifies its namespace depends on its type. For example: // - // * Python and NuGet packages do not contain a - // corresponding component, packages of those formats do not have a namespace. + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. Namespace *string // If there are additional results, this is the token for the next set of results. @@ -129,8 +115,7 @@ type ListPackageVersionsOutput struct { // The name of the package. Package *string - // The returned list of PackageVersionSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) + // The returned list of PackageVersionSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) // objects. Versions []types.PackageVersionSummary @@ -203,8 +188,8 @@ func (c *Client) addOperationListPackageVersionsMiddlewares(stack *middleware.St return nil } -// ListPackageVersionsAPIClient is a client that implements the ListPackageVersions -// operation. +// ListPackageVersionsAPIClient is a client that implements the +// ListPackageVersions operation. type ListPackageVersionsAPIClient interface { ListPackageVersions(context.Context, *ListPackageVersionsInput, ...func(*Options)) (*ListPackageVersionsOutput, error) } diff --git a/service/codeartifact/api_op_ListPackages.go b/service/codeartifact/api_op_ListPackages.go index f8269b41fef..af370619729 100644 --- a/service/codeartifact/api_op_ListPackages.go +++ b/service/codeartifact/api_op_ListPackages.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of PackageSummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) +// Returns a list of PackageSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) // objects for packages in a repository that match the request parameters. func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error) { if params == nil { @@ -56,20 +55,13 @@ type ListPackagesInput struct { // The namespace prefix used to filter requested packages. Only packages with a // namespace that starts with the provided string value are returned. Note that - // although this option is called --namespace and not --namespace-prefix, it has + // although this option is called --namespace and not --namespace-prefix , it has // prefix-matching behavior. Each package format uses namespace as follows: - // - // * The - // namespace of a Maven package is its groupId. - // - // * The namespace of an npm package - // is its scope. - // - // * Python and NuGet packages do not contain a corresponding - // component, packages of those formats do not have a namespace. - // - // * The namespace - // of a generic package is its namespace. + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The token for the next set of results. Use the value returned in the previous @@ -82,14 +74,14 @@ type ListPackagesInput struct { // The value of the Publish package origin control restriction used to filter // requested packages. Only packages with the provided restriction are returned. - // For more information, see PackageOriginRestrictions - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html). + // For more information, see PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) + // . Publish types.AllowPublish // The value of the Upstream package origin control restriction used to filter // requested packages. Only packages with the provided restriction are returned. - // For more information, see PackageOriginRestrictions - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html). + // For more information, see PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) + // . Upstream types.AllowUpstream noSmithyDocumentSerde @@ -100,8 +92,7 @@ type ListPackagesOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string - // The list of returned PackageSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) + // The list of returned PackageSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) // objects. Packages []types.PackageSummary diff --git a/service/codeartifact/api_op_ListRepositories.go b/service/codeartifact/api_op_ListRepositories.go index b8cac76470f..2d32f98dd73 100644 --- a/service/codeartifact/api_op_ListRepositories.go +++ b/service/codeartifact/api_op_ListRepositories.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of RepositorySummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) +// Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) // objects. Each RepositorySummary contains information about a repository in the // specified Amazon Web Services account and that matches the input parameters. func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesInput, optFns ...func(*Options)) (*ListRepositoriesOutput, error) { @@ -40,8 +39,8 @@ type ListRepositoriesInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // A prefix used to filter returned repositories. Only repositories with names that - // start with repositoryPrefix are returned. + // A prefix used to filter returned repositories. Only repositories with names + // that start with repositoryPrefix are returned. RepositoryPrefix *string noSmithyDocumentSerde @@ -52,8 +51,7 @@ type ListRepositoriesOutput struct { // If there are additional results, this is the token for the next set of results. NextToken *string - // The returned list of RepositorySummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) + // The returned list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) // objects. Repositories []types.RepositorySummary diff --git a/service/codeartifact/api_op_ListRepositoriesInDomain.go b/service/codeartifact/api_op_ListRepositoriesInDomain.go index 8b5be35653d..136de3e9ddb 100644 --- a/service/codeartifact/api_op_ListRepositoriesInDomain.go +++ b/service/codeartifact/api_op_ListRepositoriesInDomain.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of RepositorySummary -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) +// Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) // objects. Each RepositorySummary contains information about a repository in the // specified domain and that matches the input parameters. func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepositoriesInDomainInput, optFns ...func(*Options)) (*ListRepositoriesInDomainOutput, error) { @@ -53,8 +52,8 @@ type ListRepositoriesInDomainInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // A prefix used to filter returned repositories. Only repositories with names that - // start with repositoryPrefix are returned. + // A prefix used to filter returned repositories. Only repositories with names + // that start with repositoryPrefix are returned. RepositoryPrefix *string noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_PublishPackageVersion.go b/service/codeartifact/api_op_PublishPackageVersion.go index 27dcdce65f3..4a5910ea43a 100644 --- a/service/codeartifact/api_op_PublishPackageVersion.go +++ b/service/codeartifact/api_op_PublishPackageVersion.go @@ -14,17 +14,14 @@ import ( // Creates a new package version containing one or more assets (or files). The // unfinished flag can be used to keep the package version in the Unfinished state -// until all of its assets have been uploaded (see Package version status -// (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status) +// until all of its assets have been uploaded (see Package version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status) // in the CodeArtifact user guide). To set the package version’s status to -// Published, omit the unfinished flag when uploading the final asset, or set the -// status using UpdatePackageVersionStatus -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html). -// Once a package version’s status is set to Published, it cannot change back to -// Unfinished. Only generic packages can be published using this API. For more -// information, see Using generic packages -// (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html) in the -// CodeArtifact User Guide. +// Published , omit the unfinished flag when uploading the final asset, or set the +// status using UpdatePackageVersionStatus (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html) +// . Once a package version’s status is set to Published , it cannot change back to +// Unfinished . Only generic packages can be published using this API. For more +// information, see Using generic packages (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html) +// in the CodeArtifact User Guide. func (c *Client) PublishPackageVersion(ctx context.Context, params *PublishPackageVersionInput, optFns ...func(*Options)) (*PublishPackageVersionOutput, error) { if params == nil { params = &PublishPackageVersionInput{} @@ -48,15 +45,14 @@ type PublishPackageVersionInput struct { AssetContent io.Reader // The name of the asset to publish. Asset names can include Unicode letters and - // numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , - // . ` + // numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; + // , . ` // // This member is required. AssetName *string - // The SHA256 hash of the assetContent to publish. This value must be calculated by - // the caller and provided with the request (see Publishing a generic package - // (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html#publishing-generic-packages) + // The SHA256 hash of the assetContent to publish. This value must be calculated + // by the caller and provided with the request (see Publishing a generic package (https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html#publishing-generic-packages) // in the CodeArtifact User Guide). This value is used as an integrity check to // verify that the assetContent has not changed after it was originally sent. // @@ -69,8 +65,8 @@ type PublishPackageVersionInput struct { // This member is required. Domain *string - // A format that specifies the type of the package version with the requested asset - // file. + // A format that specifies the type of the package version with the requested + // asset file. // // This member is required. Format types.PackageFormat @@ -80,7 +76,7 @@ type PublishPackageVersionInput struct { // This member is required. Package *string - // The package version to publish (for example, 3.5.2). + // The package version to publish (for example, 3.5.2 ). // // This member is required. PackageVersion *string @@ -90,8 +86,8 @@ type PublishPackageVersionInput struct { // This member is required. Repository *string - // The 12-digit account number of the AWS account that owns the domain. It does not - // include dashes or spaces. + // The 12-digit account number of the AWS account that owns the domain. It does + // not include dashes or spaces. DomainOwner *string // The namespace of the package version to publish. @@ -99,8 +95,7 @@ type PublishPackageVersionInput struct { // Specifies whether the package version should remain in the unfinished state. If // omitted, the package version status will be set to Published (see Package - // version status - // (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status) + // version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status) // in the CodeArtifact User Guide). Valid values: unfinished Unfinished *bool @@ -109,8 +104,7 @@ type PublishPackageVersionInput struct { type PublishPackageVersionOutput struct { - // An AssetSummary - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) + // An AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) // for the published asset. Asset *types.AssetSummary @@ -124,8 +118,7 @@ type PublishPackageVersionOutput struct { Package *string // A string that contains the status of the package version. For more information, - // see Package version status - // (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status) + // see Package version status (https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status) // in the CodeArtifact User Guide. Status types.PackageVersionStatus diff --git a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go index 7a78301c3f4..5d34eaade23 100644 --- a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets a resource policy on a domain that specifies permissions to access it. When -// you call PutDomainPermissionsPolicy, the resource policy on the domain is +// Sets a resource policy on a domain that specifies permissions to access it. +// When you call PutDomainPermissionsPolicy , the resource policy on the domain is // ignored when evaluting permissions. This ensures that the owner of a domain // cannot lock themselves out of the domain, which would prevent them from being // able to update the resource policy. @@ -48,9 +48,9 @@ type PutDomainPermissionsPolicyInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The current revision of the resource policy to be set. This revision is used for - // optimistic locking, which prevents others from overwriting your changes to the - // domain's resource policy. + // The current revision of the resource policy to be set. This revision is used + // for optimistic locking, which prevents others from overwriting your changes to + // the domain's resource policy. PolicyRevision *string noSmithyDocumentSerde diff --git a/service/codeartifact/api_op_PutPackageOriginConfiguration.go b/service/codeartifact/api_op_PutPackageOriginConfiguration.go index 0c52367af52..cabf436fa6d 100644 --- a/service/codeartifact/api_op_PutPackageOriginConfiguration.go +++ b/service/codeartifact/api_op_PutPackageOriginConfiguration.go @@ -16,15 +16,14 @@ import ( // repository. You can allow or block direct publishing of new package versions, or // ingestion and retaining of new package versions from an external connection or // upstream source. For more information about package origin controls and -// configuration, see Editing package origin controls -// (https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html) -// in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on a -// package that doesn't yet exist in the repository. When called on a package that -// does not exist, a package is created in the repository with no versions and the -// requested restrictions are set on the package. This can be used to preemptively -// block ingesting or retaining any versions from external connections or upstream -// repositories, or to block publishing any versions of the package into the -// repository before connecting any package managers or publishers to the +// configuration, see Editing package origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html) +// in the CodeArtifact User Guide. PutPackageOriginConfiguration can be called on +// a package that doesn't yet exist in the repository. When called on a package +// that does not exist, a package is created in the repository with no versions and +// the requested restrictions are set on the package. This can be used to +// preemptively block ingesting or retaining any versions from external connections +// or upstream repositories, or to block publishing any versions of the package +// into the repository before connecting any package managers or publishers to the // repository. func (c *Client) PutPackageOriginConfiguration(ctx context.Context, params *PutPackageOriginConfigurationInput, optFns ...func(*Options)) (*PutPackageOriginConfigurationOutput, error) { if params == nil { @@ -63,11 +62,10 @@ type PutPackageOriginConfigurationInput struct { // This member is required. Repository *string - // A PackageOriginRestrictions - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) + // A PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) // object that contains information about the upstream and publish package origin - // restrictions. The upstream restriction determines if new package versions can be - // ingested or retained from external connections or upstream repositories. The + // restrictions. The upstream restriction determines if new package versions can + // be ingested or retained from external connections or upstream repositories. The // publish restriction determines if new package versions can be published directly // to the repository. You must include both the desired upstream and publish // restrictions. @@ -79,20 +77,13 @@ type PutPackageOriginConfigurationInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The namespace of the package to be updated. The package component that specifies - // its namespace depends on its type. For example: - // - // * The namespace of a Maven - // package is its groupId. - // - // * The namespace of an npm package is its scope. - // - // * - // Python and NuGet packages do not contain a corresponding component, packages of - // those formats do not have a namespace. - // - // * The namespace of a generic package is - // its namespace. + // The namespace of the package to be updated. The package component that + // specifies its namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string noSmithyDocumentSerde @@ -100,11 +91,9 @@ type PutPackageOriginConfigurationInput struct { type PutPackageOriginConfigurationOutput struct { - // A PackageOriginConfiguration - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html) + // A PackageOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html) // object that describes the origin configuration set for the package. It contains - // a PackageOriginRestrictions - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) + // a PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) // object that describes how new versions of the package can be introduced to the // repository. OriginConfiguration *types.PackageOriginConfiguration diff --git a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go index ef17f137a61..ee10fbd261f 100644 --- a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go @@ -12,7 +12,7 @@ import ( ) // Sets the resource policy on a repository that specifies permissions to access -// it. When you call PutRepositoryPermissionsPolicy, the resource policy on the +// it. When you call PutRepositoryPermissionsPolicy , the resource policy on the // repository is ignored when evaluting permissions. This ensures that the owner of // a repository cannot lock themselves out of the repository, which would prevent // them from being able to update the resource policy. diff --git a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go index 461084877a0..d30d68466e2 100644 --- a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go +++ b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go @@ -12,10 +12,10 @@ import ( ) // Updates the status of one or more versions of a package. Using -// UpdatePackageVersionsStatus, you can update the status of package versions to -// Archived, Published, or Unlisted. To set the status of a package version to -// Disposed, use DisposePackageVersions -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html). +// UpdatePackageVersionsStatus , you can update the status of package versions to +// Archived , Published , or Unlisted . To set the status of a package version to +// Disposed , use DisposePackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html) +// . func (c *Client) UpdatePackageVersionsStatus(ctx context.Context, params *UpdatePackageVersionsStatusInput, optFns ...func(*Options)) (*UpdatePackageVersionsStatusOutput, error) { if params == nil { params = &UpdatePackageVersionsStatusInput{} @@ -70,29 +70,22 @@ type UpdatePackageVersionsStatusInput struct { // domain. It does not include dashes or spaces. DomainOwner *string - // The package version’s expected status before it is updated. If expectedStatus is - // provided, the package version's status is updated only if its status at the time - // UpdatePackageVersionsStatus is called matches expectedStatus. + // The package version’s expected status before it is updated. If expectedStatus + // is provided, the package version's status is updated only if its status at the + // time UpdatePackageVersionsStatus is called matches expectedStatus . ExpectedStatus types.PackageVersionStatus // The namespace of the package version to be updated. The package version // component that specifies its namespace depends on its type. For example: - // - // * The - // namespace of a Maven package version is its groupId. - // - // * The namespace of an npm - // package version is its scope. - // - // * Python and NuGet package versions do not - // contain a corresponding component, package versions of those formats do not have - // a namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // A map of package versions and package version revisions. The map key is the - // package version (for example, 3.5.2), and the map value is the package version + // package version (for example, 3.5.2 ), and the map value is the package version // revision. VersionRevisions map[string]string diff --git a/service/codeartifact/api_op_UpdateRepository.go b/service/codeartifact/api_op_UpdateRepository.go index f1b083857e3..670e62f5ea8 100644 --- a/service/codeartifact/api_op_UpdateRepository.go +++ b/service/codeartifact/api_op_UpdateRepository.go @@ -49,8 +49,8 @@ type UpdateRepositoryInput struct { // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when // CodeArtifact looks for a requested package version. For more information, see - // Working with upstream repositories - // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). + // Working with upstream repositories (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) + // . Upstreams []types.UpstreamRepository noSmithyDocumentSerde diff --git a/service/codeartifact/doc.go b/service/codeartifact/doc.go index c8d8a7df619..04edbec058a 100644 --- a/service/codeartifact/doc.go +++ b/service/codeartifact/doc.go @@ -12,197 +12,118 @@ // contents from the point of view of a package manager client. CodeArtifact // Components Use the information in this guide to help you work with the following // CodeArtifact components: -// -// * Repository: A CodeArtifact repository contains a set -// of package versions -// (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version), -// each of which maps to a set of assets, or files. Repositories are polyglot, so a -// single repository can contain packages of any supported type. Each repository -// exposes endpoints for fetching and publishing packages using tools like the npm -// CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), and NuGet CLIs (nuget -// and dotnet). -// -// * Domain: Repositories are aggregated into a higher-level entity -// known as a domain. All package assets and metadata are stored in the domain, but -// are consumed through repositories. A given package asset, such as a Maven JAR -// file, is stored once per domain, no matter how many repositories it's present -// in. All of the assets and metadata in a domain are encrypted with the same -// customer master key (CMK) stored in Key Management Service (KMS). Each -// repository is a member of a single domain and can't be moved to a different -// domain. The domain allows organizational policy to be applied across multiple -// repositories, such as which accounts can access repositories in the domain, and -// which public repositories can be used as sources of packages. Although an -// organization can have multiple domains, we recommend a single production domain -// that contains all published artifacts so that teams can find and share packages -// across their organization. -// -// * Package: A package is a bundle of software and the -// metadata required to resolve dependencies and install the software. CodeArtifact -// supports npm -// (https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html), PyPI -// (https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html), Maven -// (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven), and NuGet -// (https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget) package -// formats. In CodeArtifact, a package consists of: -// -// * A name (for example, webpack -// is the name of a popular npm package) -// -// * An optional namespace (for example, -// @types in @types/node) -// -// * A set of versions (for example, 1.0.0, 1.0.1, 1.0.2, -// etc.) -// -// * Package-level metadata (for example, npm tags) -// -// * Package version: A -// version of a package, such as @types/node 12.6.9. The version number format and -// semantics vary for different package formats. For example, npm package versions -// must conform to the Semantic Versioning specification (https://semver.org/). In -// CodeArtifact, a package version consists of the version identifier, metadata at -// the package version level, and a set of assets. -// -// * Upstream repository: One -// repository is upstream of another when the package versions in it can be -// accessed from the repository endpoint of the downstream repository, effectively -// merging the contents of the two repositories from the point of view of a client. -// CodeArtifact allows creating an upstream relationship between two -// repositories. -// -// * Asset: An individual file stored in CodeArtifact associated -// with a package version, such as an npm .tgz file or Maven POM and JAR -// files. +// - Repository: A CodeArtifact repository contains a set of package versions (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version) +// , each of which maps to a set of assets, or files. Repositories are polyglot, so +// a single repository can contain packages of any supported type. Each repository +// exposes endpoints for fetching and publishing packages using tools like the +// npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine ), and NuGet CLIs ( +// nuget and dotnet ). +// - Domain: Repositories are aggregated into a higher-level entity known as a +// domain. All package assets and metadata are stored in the domain, but are +// consumed through repositories. A given package asset, such as a Maven JAR file, +// is stored once per domain, no matter how many repositories it's present in. All +// of the assets and metadata in a domain are encrypted with the same customer +// master key (CMK) stored in Key Management Service (KMS). Each repository is a +// member of a single domain and can't be moved to a different domain. The domain +// allows organizational policy to be applied across multiple repositories, such as +// which accounts can access repositories in the domain, and which public +// repositories can be used as sources of packages. Although an organization can +// have multiple domains, we recommend a single production domain that contains all +// published artifacts so that teams can find and share packages across their +// organization. +// - Package: A package is a bundle of software and the metadata required to +// resolve dependencies and install the software. CodeArtifact supports npm (https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html) +// , PyPI (https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html) +// , Maven (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven) , and +// NuGet (https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget) package +// formats. In CodeArtifact, a package consists of: +// - A name (for example, webpack is the name of a popular npm package) +// - An optional namespace (for example, @types in @types/node ) +// - A set of versions (for example, 1.0.0 , 1.0.1 , 1.0.2 , etc.) +// - Package-level metadata (for example, npm tags) +// - Package version: A version of a package, such as @types/node 12.6.9 . The +// version number format and semantics vary for different package formats. For +// example, npm package versions must conform to the Semantic Versioning +// specification (https://semver.org/) . In CodeArtifact, a package version +// consists of the version identifier, metadata at the package version level, and a +// set of assets. +// - Upstream repository: One repository is upstream of another when the package +// versions in it can be accessed from the repository endpoint of the downstream +// repository, effectively merging the contents of the two repositories from the +// point of view of a client. CodeArtifact allows creating an upstream relationship +// between two repositories. +// - Asset: An individual file stored in CodeArtifact associated with a package +// version, such as an npm .tgz file or Maven POM and JAR files. // // CodeArtifact supports these operations: -// -// * AssociateExternalConnection: -// Adds an existing external connection to a repository. -// -// * CopyPackageVersions: -// Copies package versions from one repository to another repository in the same -// domain. -// -// * CreateDomain: Creates a domain -// -// * CreateRepository: Creates a -// CodeArtifact repository in a domain. -// -// * DeleteDomain: Deletes a domain. You -// cannot delete a domain that contains repositories. -// -// * -// DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a -// domain. -// -// * DeletePackage: Deletes a package and all associated package -// versions. -// -// * DeletePackageVersions: Deletes versions of a package. After a -// package has been deleted, it can be republished, but its assets and metadata -// cannot be restored because they have been permanently removed from storage. -// -// * -// DeleteRepository: Deletes a repository. -// -// * DeleteRepositoryPermissionsPolicy: -// Deletes the resource policy that is set on a repository. -// -// * DescribeDomain: -// Returns a DomainDescription object that contains information about the requested -// domain. -// -// * DescribePackage: Returns a PackageDescription -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) -// object that contains details about a package. -// -// * DescribePackageVersion: Returns -// a PackageVersionDescription -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) -// object that contains details about a package version. -// -// * DescribeRepository: -// Returns a RepositoryDescription object that contains detailed information about -// the requested repository. -// -// * DisposePackageVersions: Disposes versions of a -// package. A package version with the status Disposed cannot be restored because -// they have been permanently removed from storage. -// -// * -// DisassociateExternalConnection: Removes an existing external connection from a -// repository. -// -// * GetAuthorizationToken: Generates a temporary authorization token -// for accessing repositories in the domain. The token expires the authorization -// period has passed. The default authorization period is 12 hours and can be -// customized to any length with a maximum of 12 hours. -// -// * -// GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to -// the specified domain. -// -// * GetPackageVersionAsset: Returns the contents of an -// asset that is in a package version. -// -// * GetPackageVersionReadme: Gets the readme -// file or descriptive text for a package version. -// -// * GetRepositoryEndpoint: -// Returns the endpoint of a repository for a specific package format. A repository -// has one endpoint for each package format: -// -// * maven -// -// * npm -// -// * nuget -// -// * pypi -// -// * -// GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a -// repository. -// -// * ListDomains: Returns a list of DomainSummary objects. Each -// returned DomainSummary object contains information about a domain. -// -// * -// ListPackages: Lists the packages in a repository. -// -// * ListPackageVersionAssets: -// Lists the assets for a given package version. -// -// * ListPackageVersionDependencies: -// Returns a list of the direct dependencies for a package version. -// -// * -// ListPackageVersions: Returns a list of package versions for a specified package -// in a repository. -// -// * ListRepositories: Returns a list of repositories owned by -// the Amazon Web Services account that called this method. -// -// * -// ListRepositoriesInDomain: Returns a list of the repositories in a domain. -// -// * -// PublishPackageVersion: Creates a new package version containing one or more -// assets. -// -// * PutDomainPermissionsPolicy: Attaches a resource policy to a -// domain. -// -// * PutPackageOriginConfiguration: Sets the package origin configuration -// for a package, which determine how new versions of the package can be added to a -// specific repository. -// -// * PutRepositoryPermissionsPolicy: Sets the resource policy -// on a repository that specifies permissions to access it. -// -// * -// UpdatePackageVersionsStatus: Updates the status of one or more versions of a -// package. -// -// * UpdateRepository: Updates the properties of a repository. +// - AssociateExternalConnection : Adds an existing external connection to a +// repository. +// - CopyPackageVersions : Copies package versions from one repository to another +// repository in the same domain. +// - CreateDomain : Creates a domain +// - CreateRepository : Creates a CodeArtifact repository in a domain. +// - DeleteDomain : Deletes a domain. You cannot delete a domain that contains +// repositories. +// - DeleteDomainPermissionsPolicy : Deletes the resource policy that is set on a +// domain. +// - DeletePackage : Deletes a package and all associated package versions. +// - DeletePackageVersions : Deletes versions of a package. After a package has +// been deleted, it can be republished, but its assets and metadata cannot be +// restored because they have been permanently removed from storage. +// - DeleteRepository : Deletes a repository. +// - DeleteRepositoryPermissionsPolicy : Deletes the resource policy that is set +// on a repository. +// - DescribeDomain : Returns a DomainDescription object that contains +// information about the requested domain. +// - DescribePackage : Returns a PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) +// object that contains details about a package. +// - DescribePackageVersion : Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) +// object that contains details about a package version. +// - DescribeRepository : Returns a RepositoryDescription object that contains +// detailed information about the requested repository. +// - DisposePackageVersions : Disposes versions of a package. A package version +// with the status Disposed cannot be restored because they have been permanently +// removed from storage. +// - DisassociateExternalConnection : Removes an existing external connection +// from a repository. +// - GetAuthorizationToken : Generates a temporary authorization token for +// accessing repositories in the domain. The token expires the authorization period +// has passed. The default authorization period is 12 hours and can be customized +// to any length with a maximum of 12 hours. +// - GetDomainPermissionsPolicy : Returns the policy of a resource that is +// attached to the specified domain. +// - GetPackageVersionAsset : Returns the contents of an asset that is in a +// package version. +// - GetPackageVersionReadme : Gets the readme file or descriptive text for a +// package version. +// - GetRepositoryEndpoint : Returns the endpoint of a repository for a specific +// package format. A repository has one endpoint for each package format: +// - maven +// - npm +// - nuget +// - pypi +// - GetRepositoryPermissionsPolicy : Returns the resource policy that is set on +// a repository. +// - ListDomains : Returns a list of DomainSummary objects. Each returned +// DomainSummary object contains information about a domain. +// - ListPackages : Lists the packages in a repository. +// - ListPackageVersionAssets : Lists the assets for a given package version. +// - ListPackageVersionDependencies : Returns a list of the direct dependencies +// for a package version. +// - ListPackageVersions : Returns a list of package versions for a specified +// package in a repository. +// - ListRepositories : Returns a list of repositories owned by the Amazon Web +// Services account that called this method. +// - ListRepositoriesInDomain : Returns a list of the repositories in a domain. +// - PublishPackageVersion : Creates a new package version containing one or more +// assets. +// - PutDomainPermissionsPolicy : Attaches a resource policy to a domain. +// - PutPackageOriginConfiguration : Sets the package origin configuration for a +// package, which determine how new versions of the package can be added to a +// specific repository. +// - PutRepositoryPermissionsPolicy : Sets the resource policy on a repository +// that specifies permissions to access it. +// - UpdatePackageVersionsStatus : Updates the status of one or more versions of +// a package. +// - UpdateRepository : Updates the properties of a repository. package codeartifact diff --git a/service/codeartifact/types/enums.go b/service/codeartifact/types/enums.go index 7d7e6b54060..b9970177ffd 100644 --- a/service/codeartifact/types/enums.go +++ b/service/codeartifact/types/enums.go @@ -10,9 +10,9 @@ const ( AllowPublishBlock AllowPublish = "BLOCK" ) -// Values returns all known values for AllowPublish. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AllowPublish. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AllowPublish) Values() []AllowPublish { return []AllowPublish{ "ALLOW", @@ -46,9 +46,9 @@ const ( DomainStatusDeleted DomainStatus = "Deleted" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "Active", @@ -63,9 +63,9 @@ const ( ExternalConnectionStatusAvailable ExternalConnectionStatus = "Available" ) -// Values returns all known values for ExternalConnectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExternalConnectionStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalConnectionStatus) Values() []ExternalConnectionStatus { return []ExternalConnectionStatus{ "Available", @@ -153,9 +153,9 @@ const ( PackageVersionOriginTypeUnknown PackageVersionOriginType = "UNKNOWN" ) -// Values returns all known values for PackageVersionOriginType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PackageVersionOriginType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionOriginType) Values() []PackageVersionOriginType { return []PackageVersionOriginType{ "INTERNAL", @@ -217,9 +217,9 @@ const ( ResourceTypeAsset ResourceType = "asset" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "domain", diff --git a/service/codeartifact/types/errors.go b/service/codeartifact/types/errors.go index 09f16415ffb..26eda5d72de 100644 --- a/service/codeartifact/types/errors.go +++ b/service/codeartifact/types/errors.go @@ -89,8 +89,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The operation did not succeed because the resource requested is not found in the -// service. +// The operation did not succeed because the resource requested is not found in +// the service. type ResourceNotFoundException struct { Message *string @@ -119,8 +119,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation did not succeed because it would have exceeded a service limit for -// your account. +// The operation did not succeed because it would have exceeded a service limit +// for your account. type ServiceQuotaExceededException struct { Message *string diff --git a/service/codeartifact/types/types.go b/service/codeartifact/types/types.go index e583545518d..0c55009cd48 100644 --- a/service/codeartifact/types/types.go +++ b/service/codeartifact/types/types.go @@ -77,8 +77,7 @@ type DomainEntryPoint struct { } // Information about a domain, including its name, Amazon Resource Name (ARN), and -// status. The ListDomains -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html) +// status. The ListDomains (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html) // operation returns a list of DomainSummary objects. type DomainSummary struct { @@ -121,39 +120,29 @@ type PackageDependency struct { // The type of a package dependency. The possible values depend on the package // type. - // - // * npm: regular, dev, peer, optional - // - // * maven: optional, parent, compile, - // runtime, test, system, provided. Note that parent is not a regular Maven - // dependency type; instead this is extracted from the element if one is defined - // in the package version's POM file. - // - // * nuget: The dependencyType field is never - // set for NuGet packages. - // - // * pypi: Requires-Dist + // - npm: regular , dev , peer , optional + // - maven: optional , parent , compile , runtime , test , system , provided . + // Note that parent is not a regular Maven dependency type; instead this is + // extracted from the element if one is defined in the package version's POM + // file. + // - nuget: The dependencyType field is never set for NuGet packages. + // - pypi: Requires-Dist DependencyType *string - // The namespace of the package that this package depends on. The package component - // that specifies its namespace depends on its type. For example: - // - // * The namespace - // of a Maven package is its groupId. - // - // * The namespace of an npm package is its - // scope. - // - // * Python and NuGet packages do not contain a corresponding component, - // packages of those formats do not have a namespace. + // The namespace of the package that this package depends on. The package + // component that specifies its namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. Namespace *string // The name of the package that this package depends on. Package *string - // The required version, or version range, of the package that this package depends - // on. The version format is specific to the package type. For example, the - // following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x. + // The required version, or version range, of the package that this package + // depends on. The version format is specific to the package type. For example, the + // following are possible valid required versions: 1.2.3 , ^2.3.4 , or 4.x . VersionRequirement *string noSmithyDocumentSerde @@ -168,19 +157,13 @@ type PackageDescription struct { // The name of the package. Name *string - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: - // - // * The namespace of a Maven package is its - // groupId. - // - // * The namespace of an npm package is its scope. - // - // * Python and NuGet - // packages do not contain a corresponding component, packages of those formats do - // not have a namespace. - // - // * The namespace of a generic package is its namespace. + // The namespace of the package. The package component that specifies its + // namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string // The package origin configuration for the package. @@ -225,25 +208,17 @@ type PackageSummary struct { // The format of the package. Format PackageFormat - // The namespace of the package. The package component that specifies its namespace - // depends on its type. For example: - // - // * The namespace of a Maven package is its - // groupId. - // - // * The namespace of an npm package is its scope. - // - // * Python and NuGet - // packages do not contain a corresponding component, packages of those formats do - // not have a namespace. - // - // * The namespace of a generic package is its namespace. + // The namespace of the package. The package component that specifies its + // namespace depends on its type. For example: + // - The namespace of a Maven package is its groupId . + // - The namespace of an npm package is its scope . + // - Python and NuGet packages do not contain a corresponding component, + // packages of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string - // A PackageOriginConfiguration - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html) - // object that contains a PackageOriginRestrictions - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) + // A PackageOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html) + // object that contains a PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html) // object that contains information about the upstream and publish package origin // restrictions. OriginConfiguration *PackageOriginConfiguration @@ -258,8 +233,8 @@ type PackageSummary struct { type PackageVersionDescription struct { // The name of the package that is displayed. The displayName varies depending on - // the package version's format. For example, if an npm package is named ui, is in - // the namespace vue, and has the format npm, then the displayName is @vue/ui. + // the package version's format. For example, if an npm package is named ui , is in + // the namespace vue , and has the format npm , then the displayName is @vue/ui . DisplayName *string // The format of the package version. @@ -273,22 +248,14 @@ type PackageVersionDescription struct { // The namespace of the package version. The package version component that // specifies its namespace depends on its type. For example: - // - // * The namespace of a - // Maven package version is its groupId. - // - // * The namespace of an npm package version - // is its scope. - // - // * Python and NuGet package versions do not contain a - // corresponding component, package versions of those formats do not have a - // namespace. - // - // * The namespace of a generic package is its namespace. + // - The namespace of a Maven package version is its groupId . + // - The namespace of an npm package version is its scope . + // - Python and NuGet package versions do not contain a corresponding component, + // package versions of those formats do not have a namespace. + // - The namespace of a generic package is its namespace . Namespace *string - // A PackageVersionOrigin - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html) + // A PackageVersionOrigin (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html) // object that contains information about how the package version was added to the // repository. Origin *PackageVersionOrigin @@ -309,9 +276,9 @@ type PackageVersionDescription struct { // A string that contains the status of the package version. Status PackageVersionStatus - // A summary of the package version. The summary is extracted from the package. The - // information in and detail level of the summary depends on the package version's - // format. + // A summary of the package version. The summary is extracted from the package. + // The information in and detail level of the summary depends on the package + // version's format. Summary *string // The version of the package. @@ -324,20 +291,12 @@ type PackageVersionDescription struct { type PackageVersionError struct { // The error code associated with the error. Valid error codes are: - // - // * - // ALREADY_EXISTS - // - // * MISMATCHED_REVISION - // - // * MISMATCHED_STATUS - // - // * NOT_ALLOWED - // - // * - // NOT_FOUND - // - // * SKIPPED + // - ALREADY_EXISTS + // - MISMATCHED_REVISION + // - MISMATCHED_STATUS + // - NOT_ALLOWED + // - NOT_FOUND + // - SKIPPED ErrorCode PackageVersionErrorCode // The error message associated with the error. @@ -349,8 +308,7 @@ type PackageVersionError struct { // Information about how a package version was added to a repository. type PackageVersionOrigin struct { - // A DomainEntryPoint - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainEntryPoint.html) + // A DomainEntryPoint (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainEntryPoint.html) // object that contains information about from which repository or external // connection the package version was added to the domain. DomainEntryPoint *DomainEntryPoint @@ -365,8 +323,7 @@ type PackageVersionOrigin struct { } // Details about a package version, including its status, version, and revision. -// The ListPackageVersions -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) +// The ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) // operation returns a list of PackageVersionSummary objects. type PackageVersionSummary struct { @@ -381,8 +338,7 @@ type PackageVersionSummary struct { // This member is required. Version *string - // A PackageVersionOrigin - // (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html) + // A PackageVersionOrigin (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html) // object that contains information about how the package version was added to the // repository. Origin *PackageVersionOrigin @@ -397,7 +353,7 @@ type PackageVersionSummary struct { // contains a set of package versions, each of which maps to a set of assets. // Repositories are polyglot—a single repository can contain packages of any // supported type. Each repository exposes endpoints for fetching and publishing -// packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can +// packages using tools like the npm CLI, the Maven CLI ( mvn ), and pip . You can // create up to 100 repositories per Amazon Web Services account. type RepositoryDescription struct { @@ -430,8 +386,8 @@ type RepositoryDescription struct { // A list of upstream repositories to associate with the repository. The order of // the upstream repositories in the list determines their priority order when // CodeArtifact looks for a requested package version. For more information, see - // Working with upstream repositories - // (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). + // Working with upstream repositories (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) + // . Upstreams []UpstreamRepositoryInfo noSmithyDocumentSerde @@ -443,31 +399,24 @@ type RepositoryExternalConnectionInfo struct { // The name of the external connection associated with a repository. ExternalConnectionName *string - // The package format associated with a repository's external connection. The valid - // package formats are: - // - // * npm: A Node Package Manager (npm) package. - // - // * pypi: A - // Python Package Index (PyPI) package. - // - // * maven: A Maven package that contains - // compiled code in a distributable format, such as a JAR file. - // - // * nuget: A NuGet - // package. + // The package format associated with a repository's external connection. The + // valid package formats are: + // - npm : A Node Package Manager (npm) package. + // - pypi : A Python Package Index (PyPI) package. + // - maven : A Maven package that contains compiled code in a distributable + // format, such as a JAR file. + // - nuget : A NuGet package. PackageFormat PackageFormat - // The status of the external connection of a repository. There is one valid value, - // Available. + // The status of the external connection of a repository. There is one valid + // value, Available . Status ExternalConnectionStatus noSmithyDocumentSerde } // Details about a repository, including its Amazon Resource Name (ARN), -// description, and domain information. The ListRepositories -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html) +// description, and domain information. The ListRepositories (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html) // operation returns a list of RepositorySummary objects. type RepositorySummary struct { @@ -542,10 +491,9 @@ type Tag struct { } // Information about an upstream repository. A list of UpstreamRepository objects -// is an input parameter to CreateRepository -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) -// and UpdateRepository -// (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html). +// is an input parameter to CreateRepository (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) +// and UpdateRepository (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html) +// . type UpstreamRepository struct { // The name of an upstream repository. diff --git a/service/codebuild/api_client.go b/service/codebuild/api_client.go index 0867e200d1e..770d1377ff5 100644 --- a/service/codebuild/api_client.go +++ b/service/codebuild/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codebuild/api_op_BatchGetReportGroups.go b/service/codebuild/api_op_BatchGetReportGroups.go index 145c0438a65..92d3ea38fdf 100644 --- a/service/codebuild/api_op_BatchGetReportGroups.go +++ b/service/codebuild/api_op_BatchGetReportGroups.go @@ -39,11 +39,11 @@ type BatchGetReportGroupsInput struct { type BatchGetReportGroupsOutput struct { - // The array of report groups returned by BatchGetReportGroups. + // The array of report groups returned by BatchGetReportGroups . ReportGroups []types.ReportGroup // An array of ARNs passed to BatchGetReportGroups that are not associated with a - // ReportGroup. + // ReportGroup . ReportGroupsNotFound []string // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_BatchGetReports.go b/service/codebuild/api_op_BatchGetReports.go index ea1e6f03fa5..6eca01c3f2e 100644 --- a/service/codebuild/api_op_BatchGetReports.go +++ b/service/codebuild/api_op_BatchGetReports.go @@ -39,11 +39,11 @@ type BatchGetReportsInput struct { type BatchGetReportsOutput struct { - // The array of Report objects returned by BatchGetReports. + // The array of Report objects returned by BatchGetReports . Reports []types.Report // An array of ARNs passed to BatchGetReportGroups that are not associated with a - // Report. + // Report . ReportsNotFound []string // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_CreateProject.go b/service/codebuild/api_op_CreateProject.go index 119a19034af..b410056599f 100644 --- a/service/codebuild/api_op_CreateProject.go +++ b/service/codebuild/api_op_CreateProject.go @@ -44,8 +44,8 @@ type CreateProjectInput struct { // This member is required. Name *string - // The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon - // Web Services services on behalf of the Amazon Web Services account. + // The ARN of the IAM role that enables CodeBuild to interact with dependent + // Amazon Web Services services on behalf of the Amazon Web Services account. // // This member is required. ServiceRole *string @@ -80,13 +80,13 @@ type CreateProjectInput struct { // the build output artifacts. You can use a cross-account KMS key to encrypt the // build output artifacts if your service role has permission to that key. You can // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/). + // CMK's alias (using the format alias/ ). EncryptionKey *string // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. + // ProjectFileSystemLocation object specifies the identifier , location , + // mountOptions , mountPoint , and type of a file system created using Amazon + // Elastic File System. FileSystemLocations []types.ProjectFileSystemLocation // Information about logs for the build project. These can be logs in CloudWatch @@ -107,38 +107,29 @@ type CreateProjectInput struct { // An array of ProjectSource objects. SecondarySources []types.ProjectSource - // A version of the build input to be built for this project. If not specified, the - // latest version is used. If specified, it must be one of: - // - // * For CodeCommit: the - // commit ID, branch, or Git tag to use. - // - // * For GitHub: the commit ID, pull request - // ID, branch name, or tag name that corresponds to the version of the source code - // you want to build. If a pull request ID is specified, it must use the format - // pr/pull-request-ID (for example pr/25). If a branch name is specified, the - // branch's HEAD commit ID is used. If not specified, the default branch's HEAD - // commit ID is used. - // - // * For Bitbucket: the commit ID, branch name, or tag name - // that corresponds to the version of the source code you want to build. If a - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // the default branch's HEAD commit ID is used. - // - // * For Amazon S3: the version ID of - // the object that represents the build input ZIP file to use. - // - // If sourceVersion is - // specified at the build level, then that version takes precedence over this - // sourceVersion (at the project level). For more information, see Source Version - // Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // A version of the build input to be built for this project. If not specified, + // the latest version is used. If specified, it must be one of: + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example pr/25 ). If a branch name is specified, the branch's HEAD commit ID is + // used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. + // If sourceVersion is specified at the build level, then that version takes + // precedence over this sourceVersion (at the project level). For more + // information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string - // A list of tag key and value pairs associated with this build project. These tags - // are available for use by Amazon Web Services services that support CodeBuild - // build project tags. + // A list of tag key and value pairs associated with this build project. These + // tags are available for use by Amazon Web Services services that support + // CodeBuild build project tags. Tags []types.Tag // How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it diff --git a/service/codebuild/api_op_CreateWebhook.go b/service/codebuild/api_op_CreateWebhook.go index af039845dad..593163f1e6e 100644 --- a/service/codebuild/api_op_CreateWebhook.go +++ b/service/codebuild/api_op_CreateWebhook.go @@ -20,8 +20,8 @@ import ( // on a per-build basis, you are billed for both builds. Therefore, if you are // using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the // CodeBuild console, clear the Webhook box. For more information, see step 5 in -// Change a Build Project's Settings -// (https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console). +// Change a Build Project's Settings (https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console) +// . func (c *Client) CreateWebhook(ctx context.Context, params *CreateWebhookInput, optFns ...func(*Options)) (*CreateWebhookOutput, error) { if params == nil { params = &CreateWebhookInput{} @@ -47,16 +47,17 @@ type CreateWebhookInput struct { // A regular expression used to determine which repository branches are built when // a webhook is triggered. If the name of a branch matches the regular expression, // then it is built. If branchFilter is empty, then all branches are built. It is - // recommended that you use filterGroups instead of branchFilter. + // recommended that you use filterGroups instead of branchFilter . BranchFilter *string // Specifies the type of build this webhook will trigger. BuildType types.WebhookBuildType - // An array of arrays of WebhookFilter objects used to determine which webhooks are - // triggered. At least one WebhookFilter in the array must specify EVENT as its - // type. For a build to be triggered, at least one filter group in the filterGroups - // array must pass. For a filter group to pass, each of its filters must pass. + // An array of arrays of WebhookFilter objects used to determine which webhooks + // are triggered. At least one WebhookFilter in the array must specify EVENT as + // its type . For a build to be triggered, at least one filter group in the + // filterGroups array must pass. For a filter group to pass, each of its filters + // must pass. FilterGroups [][]types.WebhookFilter noSmithyDocumentSerde diff --git a/service/codebuild/api_op_DeleteReportGroup.go b/service/codebuild/api_op_DeleteReportGroup.go index a1423f45301..9e3368fac18 100644 --- a/service/codebuild/api_op_DeleteReportGroup.go +++ b/service/codebuild/api_op_DeleteReportGroup.go @@ -34,12 +34,10 @@ type DeleteReportGroupInput struct { // This member is required. Arn *string - // If true, deletes any reports that belong to a report group before deleting the - // report group. If false, you must delete any reports in the report group. Use - // ListReportsForReportGroup - // (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html) - // to get the reports in a report group. Use DeleteReport - // (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html) + // If true , deletes any reports that belong to a report group before deleting the + // report group. If false , you must delete any reports in the report group. Use + // ListReportsForReportGroup (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html) + // to get the reports in a report group. Use DeleteReport (https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html) // to delete the reports. If you call DeleteReportGroup for a report group that // contains one or more reports, an exception is thrown. DeleteReports bool diff --git a/service/codebuild/api_op_DescribeCodeCoverages.go b/service/codebuild/api_op_DescribeCodeCoverages.go index a43877a669c..be38b1f8e8b 100644 --- a/service/codebuild/api_op_DescribeCodeCoverages.go +++ b/service/codebuild/api_op_DescribeCodeCoverages.go @@ -44,14 +44,14 @@ type DescribeCodeCoveragesInput struct { // The minimum line coverage percentage to report. MinLineCoveragePercentage *float64 - // The nextToken value returned from a previous call to DescribeCodeCoverages. This - // specifies the next item to return. To return the beginning of the list, exclude - // this parameter. + // The nextToken value returned from a previous call to DescribeCodeCoverages . + // This specifies the next item to return. To return the beginning of the list, + // exclude this parameter. NextToken *string - // Specifies how the results are sorted. Possible values are: FILE_PATH The results - // are sorted by file path. LINE_COVERAGE_PERCENTAGE The results are sorted by the - // percentage of lines that are covered. + // Specifies how the results are sorted. Possible values are: FILE_PATH The + // results are sorted by file path. LINE_COVERAGE_PERCENTAGE The results are sorted + // by the percentage of lines that are covered. SortBy types.ReportCodeCoverageSortByType // Specifies if the results are sorted in ascending or descending order. diff --git a/service/codebuild/api_op_DescribeTestCases.go b/service/codebuild/api_op_DescribeTestCases.go index 3b9bcd07efa..420655d6fcb 100644 --- a/service/codebuild/api_op_DescribeTestCases.go +++ b/service/codebuild/api_op_DescribeTestCases.go @@ -44,7 +44,7 @@ type DescribeTestCasesInput struct { MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -57,7 +57,7 @@ type DescribeTestCasesInput struct { type DescribeTestCasesOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next diff --git a/service/codebuild/api_op_ImportSourceCredentials.go b/service/codebuild/api_op_ImportSourceCredentials.go index 93d990bfb93..7045194725e 100644 --- a/service/codebuild/api_op_ImportSourceCredentials.go +++ b/service/codebuild/api_op_ImportSourceCredentials.go @@ -49,7 +49,7 @@ type ImportSourceCredentialsInput struct { Token *string // Set to false to prevent overwriting the repository source credentials. Set to - // true to overwrite the repository source credentials. The default value is true. + // true to overwrite the repository source credentials. The default value is true . ShouldOverwrite *bool // The Bitbucket username when the authType is BASIC_AUTH. This parameter is not diff --git a/service/codebuild/api_op_ListBuildBatches.go b/service/codebuild/api_op_ListBuildBatches.go index 5d7bdb4b296..72bb11b921f 100644 --- a/service/codebuild/api_op_ListBuildBatches.go +++ b/service/codebuild/api_op_ListBuildBatches.go @@ -36,18 +36,16 @@ type ListBuildBatchesInput struct { // The maximum number of results to return. MaxResults *int32 - // The nextToken value returned from a previous call to ListBuildBatches. This + // The nextToken value returned from a previous call to ListBuildBatches . This // specifies the next item to return. To return the beginning of the list, exclude // this parameter. NextToken *string // Specifies the sort order of the returned items. Valid values include: - // - // * - // ASCENDING: List the batch build identifiers in ascending order by identifier. - // - // * - // DESCENDING: List the batch build identifiers in descending order by identifier. + // - ASCENDING : List the batch build identifiers in ascending order by + // identifier. + // - DESCENDING : List the batch build identifiers in descending order by + // identifier. SortOrder types.SortOrderType noSmithyDocumentSerde diff --git a/service/codebuild/api_op_ListBuildBatchesForProject.go b/service/codebuild/api_op_ListBuildBatchesForProject.go index bb95d91f265..c36e98409fe 100644 --- a/service/codebuild/api_op_ListBuildBatchesForProject.go +++ b/service/codebuild/api_op_ListBuildBatchesForProject.go @@ -36,8 +36,8 @@ type ListBuildBatchesForProjectInput struct { // The maximum number of results to return. MaxResults *int32 - // The nextToken value returned from a previous call to ListBuildBatchesForProject. - // This specifies the next item to return. To return the beginning of the list, + // The nextToken value returned from a previous call to ListBuildBatchesForProject + // . This specifies the next item to return. To return the beginning of the list, // exclude this parameter. NextToken *string @@ -45,12 +45,10 @@ type ListBuildBatchesForProjectInput struct { ProjectName *string // Specifies the sort order of the returned items. Valid values include: - // - // * - // ASCENDING: List the batch build identifiers in ascending order by identifier. - // - // * - // DESCENDING: List the batch build identifiers in descending order by identifier. + // - ASCENDING : List the batch build identifiers in ascending order by + // identifier. + // - DESCENDING : List the batch build identifiers in descending order by + // identifier. SortOrder types.SortOrderType noSmithyDocumentSerde diff --git a/service/codebuild/api_op_ListBuilds.go b/service/codebuild/api_op_ListBuilds.go index 4803f4baeb3..76ca3f940ee 100644 --- a/service/codebuild/api_op_ListBuilds.go +++ b/service/codebuild/api_op_ListBuilds.go @@ -39,12 +39,8 @@ type ListBuildsInput struct { NextToken *string // The order to list build IDs. Valid values include: - // - // * ASCENDING: List the build - // IDs in ascending order by build ID. - // - // * DESCENDING: List the build IDs in - // descending order by build ID. + // - ASCENDING : List the build IDs in ascending order by build ID. + // - DESCENDING : List the build IDs in descending order by build ID. SortOrder types.SortOrderType noSmithyDocumentSerde diff --git a/service/codebuild/api_op_ListBuildsForProject.go b/service/codebuild/api_op_ListBuildsForProject.go index b5f64318598..b344f540beb 100644 --- a/service/codebuild/api_op_ListBuildsForProject.go +++ b/service/codebuild/api_op_ListBuildsForProject.go @@ -47,15 +47,11 @@ type ListBuildsForProjectInput struct { // The order to sort the results in. The results are sorted by build number, not // the build identifier. If this is not specified, the results are sorted in // descending order. Valid values include: - // - // * ASCENDING: List the build identifiers - // in ascending order, by build number. - // - // * DESCENDING: List the build identifiers - // in descending order, by build number. - // - // If the project has more than 100 builds, - // setting the sort order will result in an error. + // - ASCENDING : List the build identifiers in ascending order, by build number. + // - DESCENDING : List the build identifiers in descending order, by build + // number. + // If the project has more than 100 builds, setting the sort order will result in + // an error. SortOrder types.SortOrderType noSmithyDocumentSerde diff --git a/service/codebuild/api_op_ListProjects.go b/service/codebuild/api_op_ListProjects.go index be27de085ca..b85ae0fb4dd 100644 --- a/service/codebuild/api_op_ListProjects.go +++ b/service/codebuild/api_op_ListProjects.go @@ -40,30 +40,18 @@ type ListProjectsInput struct { NextToken *string // The criterion to be used to list build project names. Valid values include: - // - // * - // CREATED_TIME: List based on when each build project was created. - // - // * - // LAST_MODIFIED_TIME: List based on when information about each build project was - // last changed. - // - // * NAME: List based on each build project's name. - // - // Use sortOrder - // to specify in what order to list the build project names based on the preceding - // criteria. + // - CREATED_TIME : List based on when each build project was created. + // - LAST_MODIFIED_TIME : List based on when information about each build project + // was last changed. + // - NAME : List based on each build project's name. + // Use sortOrder to specify in what order to list the build project names based on + // the preceding criteria. SortBy types.ProjectSortByType // The order in which to list build projects. Valid values include: - // - // * ASCENDING: - // List in ascending order. - // - // * DESCENDING: List in descending order. - // - // Use sortBy to - // specify the criterion to be used to list build project names. + // - ASCENDING : List in ascending order. + // - DESCENDING : List in descending order. + // Use sortBy to specify the criterion to be used to list build project names. SortOrder types.SortOrderType noSmithyDocumentSerde diff --git a/service/codebuild/api_op_ListReportGroups.go b/service/codebuild/api_op_ListReportGroups.go index 5789be3c2eb..b64922b1ea4 100644 --- a/service/codebuild/api_op_ListReportGroups.go +++ b/service/codebuild/api_op_ListReportGroups.go @@ -37,7 +37,7 @@ type ListReportGroupsInput struct { MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -45,19 +45,13 @@ type ListReportGroupsInput struct { NextToken *string // The criterion to be used to list build report groups. Valid values include: - // - // * - // CREATED_TIME: List based on when each report group was created. - // - // * - // LAST_MODIFIED_TIME: List based on when each report group was last changed. - // - // * - // NAME: List based on each report group's name. + // - CREATED_TIME : List based on when each report group was created. + // - LAST_MODIFIED_TIME : List based on when each report group was last changed. + // - NAME : List based on each report group's name. SortBy types.ReportGroupSortByType // Used to specify the order to sort the list of returned report groups. Valid - // values are ASCENDING and DESCENDING. + // values are ASCENDING and DESCENDING . SortOrder types.SortOrderType noSmithyDocumentSerde @@ -66,7 +60,7 @@ type ListReportGroupsInput struct { type ListReportGroupsOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next diff --git a/service/codebuild/api_op_ListReports.go b/service/codebuild/api_op_ListReports.go index 87ed8b774ae..66ca4d2ab5f 100644 --- a/service/codebuild/api_op_ListReports.go +++ b/service/codebuild/api_op_ListReports.go @@ -39,7 +39,7 @@ type ListReportsInput struct { MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -47,13 +47,10 @@ type ListReportsInput struct { NextToken *string // Specifies the sort order for the list of returned reports. Valid values are: - // - // * - // ASCENDING: return reports in chronological order based on their creation - // date. - // - // * DESCENDING: return reports in the reverse chronological order based on - // their creation date. + // - ASCENDING : return reports in chronological order based on their creation + // date. + // - DESCENDING : return reports in the reverse chronological order based on + // their creation date. SortOrder types.SortOrderType noSmithyDocumentSerde @@ -62,7 +59,7 @@ type ListReportsInput struct { type ListReportsOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next diff --git a/service/codebuild/api_op_ListReportsForReportGroup.go b/service/codebuild/api_op_ListReportsForReportGroup.go index 40fe453e666..883325d4066 100644 --- a/service/codebuild/api_op_ListReportsForReportGroup.go +++ b/service/codebuild/api_op_ListReportsForReportGroup.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of ARNs for the reports that belong to a ReportGroup. +// Returns a list of ARNs for the reports that belong to a ReportGroup . func (c *Client) ListReportsForReportGroup(ctx context.Context, params *ListReportsForReportGroupInput, optFns ...func(*Options)) (*ListReportsForReportGroupOutput, error) { if params == nil { params = &ListReportsForReportGroupInput{} @@ -39,12 +39,12 @@ type ListReportsForReportGroupInput struct { Filter *types.ReportFilter // The maximum number of paginated reports in this report group returned per - // response. Use nextToken to iterate pages in the list of returned Report objects. - // The default value is 100. + // response. Use nextToken to iterate pages in the list of returned Report + // objects. The default value is 100. MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -61,7 +61,7 @@ type ListReportsForReportGroupInput struct { type ListReportsForReportGroupOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -152,8 +152,8 @@ var _ ListReportsForReportGroupAPIClient = (*Client)(nil) // ListReportsForReportGroup type ListReportsForReportGroupPaginatorOptions struct { // The maximum number of paginated reports in this report group returned per - // response. Use nextToken to iterate pages in the list of returned Report objects. - // The default value is 100. + // response. Use nextToken to iterate pages in the list of returned Report + // objects. The default value is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codebuild/api_op_ListSharedProjects.go b/service/codebuild/api_op_ListSharedProjects.go index 8cda5f95d92..92c58e10e69 100644 --- a/service/codebuild/api_op_ListSharedProjects.go +++ b/service/codebuild/api_op_ListSharedProjects.go @@ -31,13 +31,13 @@ func (c *Client) ListSharedProjects(ctx context.Context, params *ListSharedProje type ListSharedProjectsInput struct { - // The maximum number of paginated shared build projects returned per response. Use - // nextToken to iterate pages in the list of returned Project objects. The default - // value is 100. + // The maximum number of paginated shared build projects returned per response. + // Use nextToken to iterate pages in the list of returned Project objects. The + // default value is 100. MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -46,20 +46,14 @@ type ListSharedProjectsInput struct { // The criterion to be used to list build projects shared with the current Amazon // Web Services account or user. Valid values include: - // - // * ARN: List based on the - // ARN. - // - // * MODIFIED_TIME: List based on when information about the shared project - // was last changed. + // - ARN : List based on the ARN. + // - MODIFIED_TIME : List based on when information about the shared project was + // last changed. SortBy types.SharedResourceSortByType // The order in which to list shared build projects. Valid values include: - // - // * - // ASCENDING: List in ascending order. - // - // * DESCENDING: List in descending order. + // - ASCENDING : List in ascending order. + // - DESCENDING : List in descending order. SortOrder types.SortOrderType noSmithyDocumentSerde @@ -68,7 +62,7 @@ type ListSharedProjectsInput struct { type ListSharedProjectsOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -156,9 +150,9 @@ var _ ListSharedProjectsAPIClient = (*Client)(nil) // ListSharedProjectsPaginatorOptions is the paginator options for // ListSharedProjects type ListSharedProjectsPaginatorOptions struct { - // The maximum number of paginated shared build projects returned per response. Use - // nextToken to iterate pages in the list of returned Project objects. The default - // value is 100. + // The maximum number of paginated shared build projects returned per response. + // Use nextToken to iterate pages in the list of returned Project objects. The + // default value is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codebuild/api_op_ListSharedReportGroups.go b/service/codebuild/api_op_ListSharedReportGroups.go index aad85e4dc39..6efe2a7715c 100644 --- a/service/codebuild/api_op_ListSharedReportGroups.go +++ b/service/codebuild/api_op_ListSharedReportGroups.go @@ -37,7 +37,7 @@ type ListSharedReportGroupsInput struct { MaxResults *int32 // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next @@ -46,20 +46,14 @@ type ListSharedReportGroupsInput struct { // The criterion to be used to list report groups shared with the current Amazon // Web Services account or user. Valid values include: - // - // * ARN: List based on the - // ARN. - // - // * MODIFIED_TIME: List based on when information about the shared report - // group was last changed. + // - ARN : List based on the ARN. + // - MODIFIED_TIME : List based on when information about the shared report group + // was last changed. SortBy types.SharedResourceSortByType // The order in which to list shared report groups. Valid values include: - // - // * - // ASCENDING: List in ascending order. - // - // * DESCENDING: List in descending order. + // - ASCENDING : List in ascending order. + // - DESCENDING : List in descending order. SortOrder types.SortOrderType noSmithyDocumentSerde @@ -68,7 +62,7 @@ type ListSharedReportGroupsInput struct { type ListSharedReportGroupsOutput struct { // During a previous call, the maximum number of items that can be returned is the - // value specified in maxResults. If there more items in the list, then a unique + // value specified in maxResults . If there more items in the list, then a unique // string called a nextToken is returned. To get the next batch of items in the // list, call this operation again, adding the next token to the call. To get all // of the items in the list, keep calling this operation with each subsequent next diff --git a/service/codebuild/api_op_PutResourcePolicy.go b/service/codebuild/api_op_PutResourcePolicy.go index 076cb21b8ea..17ce6ef9b61 100644 --- a/service/codebuild/api_op_PutResourcePolicy.go +++ b/service/codebuild/api_op_PutResourcePolicy.go @@ -28,10 +28,8 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // A JSON-formatted resource policy. For more information, see Sharing a Project - // (https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share) - // and Sharing a Report Group - // (https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share) + // A JSON-formatted resource policy. For more information, see Sharing a Project (https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share) + // and Sharing a Report Group (https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share) // in the CodeBuild User Guide. // // This member is required. diff --git a/service/codebuild/api_op_RetryBuild.go b/service/codebuild/api_op_RetryBuild.go index 364f8ccdd43..e00e26144c0 100644 --- a/service/codebuild/api_op_RetryBuild.go +++ b/service/codebuild/api_op_RetryBuild.go @@ -32,10 +32,10 @@ type RetryBuildInput struct { // Specifies the identifier of the build to restart. Id *string - // A unique, case sensitive identifier you provide to ensure the idempotency of the - // RetryBuild request. The token is included in the RetryBuild request and is valid - // for five minutes. If you repeat the RetryBuild request with the same token, but - // change a parameter, CodeBuild returns a parameter mismatch error. + // A unique, case sensitive identifier you provide to ensure the idempotency of + // the RetryBuild request. The token is included in the RetryBuild request and is + // valid for five minutes. If you repeat the RetryBuild request with the same + // token, but change a parameter, CodeBuild returns a parameter mismatch error. IdempotencyToken *string noSmithyDocumentSerde diff --git a/service/codebuild/api_op_RetryBuildBatch.go b/service/codebuild/api_op_RetryBuildBatch.go index f1d77ef4091..7c07502e0d9 100644 --- a/service/codebuild/api_op_RetryBuildBatch.go +++ b/service/codebuild/api_op_RetryBuildBatch.go @@ -33,11 +33,11 @@ type RetryBuildBatchInput struct { // Specifies the identifier of the batch build to restart. Id *string - // A unique, case sensitive identifier you provide to ensure the idempotency of the - // RetryBuildBatch request. The token is included in the RetryBuildBatch request - // and is valid for five minutes. If you repeat the RetryBuildBatch request with - // the same token, but change a parameter, CodeBuild returns a parameter mismatch - // error. + // A unique, case sensitive identifier you provide to ensure the idempotency of + // the RetryBuildBatch request. The token is included in the RetryBuildBatch + // request and is valid for five minutes. If you repeat the RetryBuildBatch + // request with the same token, but change a parameter, CodeBuild returns a + // parameter mismatch error. IdempotencyToken *string // Specifies the type of retry to perform. diff --git a/service/codebuild/api_op_StartBuild.go b/service/codebuild/api_op_StartBuild.go index 60ffd2b68b3..99b0d2a40af 100644 --- a/service/codebuild/api_op_StartBuild.go +++ b/service/codebuild/api_op_StartBuild.go @@ -38,30 +38,30 @@ type StartBuildInput struct { // ones already defined in the build project. ArtifactsOverride *types.ProjectArtifacts - // Contains information that defines how the build project reports the build status - // to the source provider. This option is only used when the source provider is - // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + // Contains information that defines how the build project reports the build + // status to the source provider. This option is only used when the source provider + // is GITHUB , GITHUB_ENTERPRISE , or BITBUCKET . BuildStatusConfigOverride *types.BuildStatusConfig - // A buildspec file declaration that overrides, for this build only, the latest one - // already defined in the build project. If this value is set, it can be either an - // inline buildspec definition, the path to an alternate buildspec file relative to - // the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to - // an S3 bucket. The bucket must be in the same Amazon Web Services Region as the - // build project. Specify the buildspec file using its ARN (for example, - // arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided + // A buildspec file declaration that overrides, for this build only, the latest + // one already defined in the build project. If this value is set, it can be either + // an inline buildspec definition, the path to an alternate buildspec file relative + // to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the + // path to an S3 bucket. The bucket must be in the same Amazon Web Services Region + // as the build project. Specify the buildspec file using its ARN (for example, + // arn:aws:s3:::my-codebuild-sample2/buildspec.yml ). If this value is not provided // or is set to an empty string, the source code must contain a buildspec file in // its root directory. For more information, see Buildspec File Name and Storage - // Location - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). + // Location (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage) + // . BuildspecOverride *string - // A ProjectCache object specified for this build that overrides the one defined in - // the build project. + // A ProjectCache object specified for this build that overrides the one defined + // in the build project. CacheOverride *types.ProjectCache - // The name of a certificate for this build that overrides the one specified in the - // build project. + // The name of a certificate for this build that overrides the one specified in + // the build project. CertificateOverride *string // The name of a compute type for this build that overrides the one specified in @@ -69,8 +69,8 @@ type StartBuildInput struct { ComputeTypeOverride types.ComputeType // Specifies if session debugging is enabled for this build. For more information, - // see Viewing a running build in Session Manager - // (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). + // see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html) + // . DebugSessionEnabled *bool // The Key Management Service customer master key (CMK) that overrides the one @@ -78,7 +78,7 @@ type StartBuildInput struct { // You can use a cross-account KMS key to encrypt the build output artifacts if // your service role has permission to that key. You can specify either the Amazon // Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the - // format alias/). + // format alias/ ). EncryptionKeyOverride *string // A container type for this build that overrides the one specified in the build @@ -97,10 +97,10 @@ type StartBuildInput struct { // CodeBuild build project. GitSubmodulesConfigOverride *types.GitSubmodulesConfig - // A unique, case sensitive identifier you provide to ensure the idempotency of the - // StartBuild request. The token is included in the StartBuild request and is valid - // for 5 minutes. If you repeat the StartBuild request with the same token, but - // change a parameter, CodeBuild returns a parameter mismatch error. + // A unique, case sensitive identifier you provide to ensure the idempotency of + // the StartBuild request. The token is included in the StartBuild request and is + // valid for 5 minutes. If you repeat the StartBuild request with the same token, + // but change a parameter, CodeBuild returns a parameter mismatch error. IdempotencyToken *string // The name of an image for this build that overrides the one specified in the @@ -141,10 +141,9 @@ type StartBuildInput struct { // to report the build status to the source provider, the user associated with the // source provider must have write access to the repo. If the user does not have // write access, the build status cannot be updated. For more information, see - // Source provider access - // (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html) in - // the CodeBuild User Guide. The status of a build triggered by a webhook is always - // reported to your source provider. + // Source provider access (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html) + // in the CodeBuild User Guide. The status of a build triggered by a webhook is + // always reported to your source provider. ReportBuildStatusOverride *bool // An array of ProjectArtifacts objects. @@ -161,9 +160,9 @@ type StartBuildInput struct { // the build project. ServiceRoleOverride *string - // An authorization type for this build that overrides the one defined in the build - // project. This override applies only if the build project's source is BitBucket - // or GitHub. + // An authorization type for this build that overrides the one defined in the + // build project. This override applies only if the build project's source is + // BitBucket or GitHub. SourceAuthOverride *types.SourceAuth // A location that overrides, for this build, the source location for the one @@ -179,7 +178,7 @@ type StartBuildInput struct { // source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The // commit ID, pull request ID, branch name, or tag name that corresponds to the // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example pr/25). If a branch name + // it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name // is specified, the branch's HEAD commit ID is used. If not specified, the default // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag // name that corresponds to the version of the source code you want to build. If a @@ -187,8 +186,7 @@ type StartBuildInput struct { // the default branch's HEAD commit ID is used. Amazon S3 The version ID of the // object that represents the build input ZIP file to use. If sourceVersion is // specified at the project level, then this sourceVersion (at the build level) - // takes precedence. For more information, see Source Version Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // takes precedence. For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string diff --git a/service/codebuild/api_op_StartBuildBatch.go b/service/codebuild/api_op_StartBuildBatch.go index 08455d4f0cb..85d44b29684 100644 --- a/service/codebuild/api_op_StartBuildBatch.go +++ b/service/codebuild/api_op_StartBuildBatch.go @@ -45,17 +45,17 @@ type StartBuildBatchInput struct { // Overrides the build timeout specified in the batch build project. BuildTimeoutInMinutesOverride *int32 - // A buildspec file declaration that overrides, for this build only, the latest one - // already defined in the build project. If this value is set, it can be either an - // inline buildspec definition, the path to an alternate buildspec file relative to - // the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to - // an S3 bucket. The bucket must be in the same Amazon Web Services Region as the - // build project. Specify the buildspec file using its ARN (for example, - // arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided + // A buildspec file declaration that overrides, for this build only, the latest + // one already defined in the build project. If this value is set, it can be either + // an inline buildspec definition, the path to an alternate buildspec file relative + // to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the + // path to an S3 bucket. The bucket must be in the same Amazon Web Services Region + // as the build project. Specify the buildspec file using its ARN (for example, + // arn:aws:s3:::my-codebuild-sample2/buildspec.yml ). If this value is not provided // or is set to an empty string, the source code must contain a buildspec file in // its root directory. For more information, see Buildspec File Name and Storage - // Location - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). + // Location (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage) + // . BuildspecOverride *string // A ProjectCache object that specifies cache overrides. @@ -65,14 +65,13 @@ type StartBuildBatchInput struct { // in the batch build project. CertificateOverride *string - // The name of a compute type for this batch build that overrides the one specified - // in the batch build project. + // The name of a compute type for this batch build that overrides the one + // specified in the batch build project. ComputeTypeOverride types.ComputeType // Specifies if session debugging is enabled for this batch build. For more - // information, see Viewing a running build in Session Manager - // (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). - // Batch session debugging is not supported for matrix batch builds. + // information, see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html) + // . Batch session debugging is not supported for matrix batch builds. DebugSessionEnabled *bool // The Key Management Service customer master key (CMK) that overrides the one @@ -80,7 +79,7 @@ type StartBuildBatchInput struct { // artifacts. You can use a cross-account KMS key to encrypt the build output // artifacts if your service role has permission to that key. You can specify // either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's - // alias (using the format alias/). + // alias (using the format alias/ ). EncryptionKeyOverride *string // A container type for this batch build that overrides the one specified in the @@ -96,23 +95,23 @@ type StartBuildBatchInput struct { // build project. GitCloneDepthOverride *int32 - // A GitSubmodulesConfig object that overrides the Git submodules configuration for - // this batch build. + // A GitSubmodulesConfig object that overrides the Git submodules configuration + // for this batch build. GitSubmodulesConfigOverride *types.GitSubmodulesConfig - // A unique, case sensitive identifier you provide to ensure the idempotency of the - // StartBuildBatch request. The token is included in the StartBuildBatch request - // and is valid for five minutes. If you repeat the StartBuildBatch request with - // the same token, but change a parameter, CodeBuild returns a parameter mismatch - // error. + // A unique, case sensitive identifier you provide to ensure the idempotency of + // the StartBuildBatch request. The token is included in the StartBuildBatch + // request and is valid for five minutes. If you repeat the StartBuildBatch + // request with the same token, but change a parameter, CodeBuild returns a + // parameter mismatch error. IdempotencyToken *string // The name of an image for this batch build that overrides the one specified in // the batch build project. ImageOverride *string - // The type of credentials CodeBuild uses to pull images in your batch build. There - // are two valid values: CODEBUILD Specifies that CodeBuild uses its own + // The type of credentials CodeBuild uses to pull images in your batch build. + // There are two valid values: CODEBUILD Specifies that CodeBuild uses its own // credentials. This requires that you modify your ECR repository policy to trust // CodeBuild's service principal. SERVICE_ROLE Specifies that CodeBuild uses your // build project's service role. When using a cross-account or private registry @@ -142,8 +141,8 @@ type StartBuildBatchInput struct { // Set to true to report to your source provider the status of a batch build's // start and completion. If you use this option with a source provider other than - // GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The - // status of a build triggered by a webhook is always reported to your source + // GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. + // The status of a build triggered by a webhook is always reported to your source // provider. ReportBuildBatchStatusOverride *bool @@ -151,16 +150,16 @@ type StartBuildBatchInput struct { // defined in the batch build project. SecondaryArtifactsOverride []types.ProjectArtifacts - // An array of ProjectSource objects that override the secondary sources defined in - // the batch build project. + // An array of ProjectSource objects that override the secondary sources defined + // in the batch build project. SecondarySourcesOverride []types.ProjectSource // An array of ProjectSourceVersion objects that override the secondary source // versions in the batch build project. SecondarySourcesVersionOverride []types.ProjectSourceVersion - // The name of a service role for this batch build that overrides the one specified - // in the batch build project. + // The name of a service role for this batch build that overrides the one + // specified in the batch build project. ServiceRoleOverride *string // A SourceAuth object that overrides the one defined in the batch build project. @@ -171,8 +170,8 @@ type StartBuildBatchInput struct { // the batch build project. SourceLocationOverride *string - // The source input type that overrides the source input defined in the batch build - // project. + // The source input type that overrides the source input defined in the batch + // build project. SourceTypeOverride types.SourceType // The version of the batch build input to be built, for this build only. If not @@ -180,7 +179,7 @@ type StartBuildBatchInput struct { // source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The // commit ID, pull request ID, branch name, or tag name that corresponds to the // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example pr/25). If a branch name + // it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name // is specified, the branch's HEAD commit ID is used. If not specified, the default // branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag // name that corresponds to the version of the source code you want to build. If a @@ -188,8 +187,7 @@ type StartBuildBatchInput struct { // the default branch's HEAD commit ID is used. Amazon S3 The version ID of the // object that represents the build input ZIP file to use. If sourceVersion is // specified at the project level, then this sourceVersion (at the build level) - // takes precedence. For more information, see Source Version Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // takes precedence. For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string diff --git a/service/codebuild/api_op_UpdateProject.go b/service/codebuild/api_op_UpdateProject.go index c7048d676b4..394f664dbad 100644 --- a/service/codebuild/api_op_UpdateProject.go +++ b/service/codebuild/api_op_UpdateProject.go @@ -62,16 +62,16 @@ type UpdateProjectInput struct { // the build output artifacts. You can use a cross-account KMS key to encrypt the // build output artifacts if your service role has permission to that key. You can // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/). + // CMK's alias (using the format alias/ ). EncryptionKey *string // Information to be changed about the build environment for the build project. Environment *types.ProjectEnvironment // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. + // ProjectFileSystemLocation object specifies the identifier , location , + // mountOptions , mountPoint , and type of a file system created using Amazon + // Elastic File System. FileSystemLocations []types.ProjectFileSystemLocation // Information about logs for the build project. A project can create logs in @@ -101,32 +101,23 @@ type UpdateProjectInput struct { // project. Source *types.ProjectSource - // A version of the build input to be built for this project. If not specified, the - // latest version is used. If specified, it must be one of: - // - // * For CodeCommit: the - // commit ID, branch, or Git tag to use. - // - // * For GitHub: the commit ID, pull request - // ID, branch name, or tag name that corresponds to the version of the source code - // you want to build. If a pull request ID is specified, it must use the format - // pr/pull-request-ID (for example pr/25). If a branch name is specified, the - // branch's HEAD commit ID is used. If not specified, the default branch's HEAD - // commit ID is used. - // - // * For Bitbucket: the commit ID, branch name, or tag name - // that corresponds to the version of the source code you want to build. If a - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // the default branch's HEAD commit ID is used. - // - // * For Amazon S3: the version ID of - // the object that represents the build input ZIP file to use. - // - // If sourceVersion is - // specified at the build level, then that version takes precedence over this - // sourceVersion (at the project level). For more information, see Source Version - // Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // A version of the build input to be built for this project. If not specified, + // the latest version is used. If specified, it must be one of: + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example pr/25 ). If a branch name is specified, the branch's HEAD commit ID is + // used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. + // If sourceVersion is specified at the build level, then that version takes + // precedence over this sourceVersion (at the project level). For more + // information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string @@ -135,8 +126,8 @@ type UpdateProjectInput struct { // CodeBuild build project tags. Tags []types.Tag - // The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait - // before timing out any related build that did not get marked as completed. + // The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to + // wait before timing out any related build that did not get marked as completed. TimeoutInMinutes *int32 // VpcConfig enables CodeBuild to access resources in an Amazon VPC. diff --git a/service/codebuild/api_op_UpdateProjectVisibility.go b/service/codebuild/api_op_UpdateProjectVisibility.go index 9903de4f6c3..ac03cfbc357 100644 --- a/service/codebuild/api_op_UpdateProjectVisibility.go +++ b/service/codebuild/api_op_UpdateProjectVisibility.go @@ -13,37 +13,32 @@ import ( // Changes the public visibility for a project. The project's build results, logs, // and artifacts are available to the general public. For more information, see -// Public build projects -// (https://docs.aws.amazon.com/codebuild/latest/userguide/public-builds.html) in -// the CodeBuild User Guide. The following should be kept in mind when making your -// projects public: +// Public build projects (https://docs.aws.amazon.com/codebuild/latest/userguide/public-builds.html) +// in the CodeBuild User Guide. The following should be kept in mind when making +// your projects public: // -// * All of a project's build results, logs, and artifacts, -// including builds that were run when the project was private, are available to -// the general public. +// - All of a project's build results, logs, and artifacts, including builds +// that were run when the project was private, are available to the general public. // -// * All build logs and artifacts are available to the public. -// Environment variables, source code, and other sensitive information may have -// been output to the build logs and artifacts. You must be careful about what -// information is output to the build logs. Some best practice are: +// - All build logs and artifacts are available to the public. Environment +// variables, source code, and other sensitive information may have been output to +// the build logs and artifacts. You must be careful about what information is +// output to the build logs. Some best practice are: // -// * Do not store -// sensitive values, especially Amazon Web Services access key IDs and secret -// access keys, in environment variables. We recommend that you use an Amazon EC2 -// Systems Manager Parameter Store or Secrets Manager to store sensitive values. +// - Do not store sensitive values, especially Amazon Web Services access key +// IDs and secret access keys, in environment variables. We recommend that you use +// an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store +// sensitive values. // -// * -// Follow Best practices for using webhooks -// (https://docs.aws.amazon.com/codebuild/latest/userguide/webhooks.html#webhook-best-practices) -// in the CodeBuild User Guide to limit which entities can trigger a build, and do -// not store the buildspec in the project itself, to ensure that your webhooks are -// as secure as possible. +// - Follow Best practices for using webhooks (https://docs.aws.amazon.com/codebuild/latest/userguide/webhooks.html#webhook-best-practices) +// in the CodeBuild User Guide to limit which entities can trigger a build, and do +// not store the buildspec in the project itself, to ensure that your webhooks are +// as secure as possible. // -// * A malicious user can use public builds to distribute -// malicious artifacts. We recommend that you review all pull requests to verify -// that the pull request is a legitimate change. We also recommend that you -// validate any artifacts with their checksums to make sure that the correct -// artifacts are being downloaded. +// - A malicious user can use public builds to distribute malicious artifacts. +// We recommend that you review all pull requests to verify that the pull request +// is a legitimate change. We also recommend that you validate any artifacts with +// their checksums to make sure that the correct artifacts are being downloaded. func (c *Client) UpdateProjectVisibility(ctx context.Context, params *UpdateProjectVisibilityInput, optFns ...func(*Options)) (*UpdateProjectVisibilityOutput, error) { if params == nil { params = &UpdateProjectVisibilityInput{} @@ -73,8 +68,8 @@ type UpdateProjectVisibilityInput struct { // This member is required. ProjectVisibility types.ProjectVisibilityType - // The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and - // Amazon S3 artifacts for the project's builds. + // The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs + // and Amazon S3 artifacts for the project's builds. ResourceAccessRole *string noSmithyDocumentSerde diff --git a/service/codebuild/api_op_UpdateReportGroup.go b/service/codebuild/api_op_UpdateReportGroup.go index c775189657e..7e40cef4f70 100644 --- a/service/codebuild/api_op_UpdateReportGroup.go +++ b/service/codebuild/api_op_UpdateReportGroup.go @@ -35,12 +35,8 @@ type UpdateReportGroupInput struct { Arn *string // Used to specify an updated export type. Valid values are: - // - // * S3: The report - // results are exported to an S3 bucket. - // - // * NO_EXPORT: The report results are not - // exported. + // - S3 : The report results are exported to an S3 bucket. + // - NO_EXPORT : The report results are not exported. ExportConfig *types.ReportExportConfig // An updated list of tag key and value pairs associated with this report group. diff --git a/service/codebuild/api_op_UpdateWebhook.go b/service/codebuild/api_op_UpdateWebhook.go index 96e15a201c8..77901fe427a 100644 --- a/service/codebuild/api_op_UpdateWebhook.go +++ b/service/codebuild/api_op_UpdateWebhook.go @@ -38,20 +38,20 @@ type UpdateWebhookInput struct { // A regular expression used to determine which repository branches are built when // a webhook is triggered. If the name of a branch matches the regular expression, // then it is built. If branchFilter is empty, then all branches are built. It is - // recommended that you use filterGroups instead of branchFilter. + // recommended that you use filterGroups instead of branchFilter . BranchFilter *string // Specifies the type of build this webhook will trigger. BuildType types.WebhookBuildType - // An array of arrays of WebhookFilter objects used to determine if a webhook event - // can trigger a build. A filter group must contain at least one - // EVENTWebhookFilter. + // An array of arrays of WebhookFilter objects used to determine if a webhook + // event can trigger a build. A filter group must contain at least one EVENT + // WebhookFilter . FilterGroups [][]types.WebhookFilter - // A boolean value that specifies whether the associated GitHub repository's secret - // token should be updated. If you use Bitbucket for your repository, rotateSecret - // is ignored. + // A boolean value that specifies whether the associated GitHub repository's + // secret token should be updated. If you use Bitbucket for your repository, + // rotateSecret is ignored. RotateSecret bool noSmithyDocumentSerde diff --git a/service/codebuild/doc.go b/service/codebuild/doc.go index b8205c22115..714b36ffdfd 100644 --- a/service/codebuild/doc.go +++ b/service/codebuild/doc.go @@ -11,6 +11,6 @@ // more. You can also fully customize build environments in CodeBuild to use your // own build tools. CodeBuild scales automatically to meet peak build requests. You // pay only for the build time you consume. For more information about CodeBuild, -// see the CodeBuild User Guide -// (https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html). +// see the CodeBuild User Guide (https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html) +// . package codebuild diff --git a/service/codebuild/types/enums.go b/service/codebuild/types/enums.go index 405797f3f29..77137ccbeeb 100644 --- a/service/codebuild/types/enums.go +++ b/service/codebuild/types/enums.go @@ -189,9 +189,9 @@ const ( CacheModeLocalCustomCache CacheMode = "LOCAL_CUSTOM_CACHE" ) -// Values returns all known values for CacheMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for CacheMode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (CacheMode) Values() []CacheMode { return []CacheMode{ "LOCAL_DOCKER_LAYER_CACHE", @@ -209,9 +209,9 @@ const ( CacheTypeLocal CacheType = "LOCAL" ) -// Values returns all known values for CacheType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for CacheType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (CacheType) Values() []CacheType { return []CacheType{ "NO_CACHE", @@ -326,9 +326,9 @@ const ( ImagePullCredentialsTypeServiceRole ImagePullCredentialsType = "SERVICE_ROLE" ) -// Values returns all known values for ImagePullCredentialsType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImagePullCredentialsType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ImagePullCredentialsType) Values() []ImagePullCredentialsType { return []ImagePullCredentialsType{ "CODEBUILD", @@ -352,9 +352,9 @@ const ( LanguageTypePhp LanguageType = "PHP" ) -// Values returns all known values for LanguageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageType) Values() []LanguageType { return []LanguageType{ "JAVA", @@ -398,9 +398,9 @@ const ( PlatformTypeWindowsServer PlatformType = "WINDOWS_SERVER" ) -// Values returns all known values for PlatformType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PlatformType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PlatformType) Values() []PlatformType { return []PlatformType{ "DEBIAN", @@ -438,8 +438,8 @@ const ( ProjectVisibilityTypePrivate ProjectVisibilityType = "PRIVATE" ) -// Values returns all known values for ProjectVisibilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ProjectVisibilityType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ProjectVisibilityType) Values() []ProjectVisibilityType { return []ProjectVisibilityType{ @@ -456,9 +456,10 @@ const ( ReportCodeCoverageSortByTypeFilePath ReportCodeCoverageSortByType = "FILE_PATH" ) -// Values returns all known values for ReportCodeCoverageSortByType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportCodeCoverageSortByType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ReportCodeCoverageSortByType) Values() []ReportCodeCoverageSortByType { return []ReportCodeCoverageSortByType{ "LINE_COVERAGE_PERCENTAGE", @@ -493,8 +494,8 @@ const ( ReportGroupSortByTypeLastModifiedTime ReportGroupSortByType = "LAST_MODIFIED_TIME" ) -// Values returns all known values for ReportGroupSortByType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReportGroupSortByType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReportGroupSortByType) Values() []ReportGroupSortByType { return []ReportGroupSortByType{ @@ -512,8 +513,8 @@ const ( ReportGroupStatusTypeDeleting ReportGroupStatusType = "DELETING" ) -// Values returns all known values for ReportGroupStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReportGroupStatusType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReportGroupStatusType) Values() []ReportGroupStatusType { return []ReportGroupStatusType{ @@ -660,9 +661,9 @@ const ( SharedResourceSortByTypeModifiedTime SharedResourceSortByType = "MODIFIED_TIME" ) -// Values returns all known values for SharedResourceSortByType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SharedResourceSortByType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SharedResourceSortByType) Values() []SharedResourceSortByType { return []SharedResourceSortByType{ "ARN", diff --git a/service/codebuild/types/types.go b/service/codebuild/types/types.go index 25b699843aa..4b61f24c1b8 100644 --- a/service/codebuild/types/types.go +++ b/service/codebuild/types/types.go @@ -11,8 +11,7 @@ import ( type BatchRestrictions struct { // An array of strings that specify the compute types that are allowed for the - // batch build. See Build environment compute types - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) + // batch build. See Build environment compute types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) // in the CodeBuild User Guide for these values. ComputeTypesAllowed []string @@ -37,27 +36,18 @@ type Build struct { // Whether the build is complete. True if complete; otherwise, false. BuildComplete bool - // The number of the build. For each project, the buildNumber of its first build is - // 1. The buildNumber of each subsequent build is incremented by 1. If a build is - // deleted, the buildNumber of other builds does not change. + // The number of the build. For each project, the buildNumber of its first build + // is 1 . The buildNumber of each subsequent build is incremented by 1 . If a build + // is deleted, the buildNumber of other builds does not change. BuildNumber *int64 // The current status of the build. Valid values include: - // - // * FAILED: The build - // failed. - // - // * FAULT: The build faulted. - // - // * IN_PROGRESS: The build is still in - // progress. - // - // * STOPPED: The build stopped. - // - // * SUCCEEDED: The build succeeded. - // - // * - // TIMED_OUT: The build timed out. + // - FAILED : The build failed. + // - FAULT : The build faulted. + // - IN_PROGRESS : The build is still in progress. + // - STOPPED : The build stopped. + // - SUCCEEDED : The build succeeded. + // - TIMED_OUT : The build timed out. BuildStatus StatusType // Information about the cache for the build. @@ -73,7 +63,7 @@ type Build struct { // the build output artifacts. You can use a cross-account KMS key to encrypt the // build output artifacts if your service role has permission to that key. You can // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/). + // CMK's alias (using the format alias/ ). EncryptionKey *string // When the build process ended, expressed in Unix time format. @@ -85,31 +75,26 @@ type Build struct { // A list of exported environment variables for this build. Exported environment // variables are used in conjunction with CodePipeline to export environment // variables from the current build stage to subsequent stages in the pipeline. For - // more information, see Working with variables - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) + // more information, see Working with variables (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) // in the CodePipeline User Guide. ExportedEnvironmentVariables []ExportedEnvironmentVariable // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. + // ProjectFileSystemLocation object specifies the identifier , location , + // mountOptions , mountPoint , and type of a file system created using Amazon + // Elastic File System. FileSystemLocations []ProjectFileSystemLocation // The unique ID for the build. Id *string // The entity that started the build. Valid values include: - // - // * If CodePipeline - // started the build, the pipeline's name (for example, - // codepipeline/my-demo-pipeline). - // - // * If an IAM user started the build, the user's - // name (for example, MyUserName). - // - // * If the Jenkins plugin for CodeBuild started - // the build, the string CodeBuild-Jenkins-Plugin. + // - If CodePipeline started the build, the pipeline's name (for example, + // codepipeline/my-demo-pipeline ). + // - If an IAM user started the build, the user's name (for example, MyUserName + // ). + // - If the Jenkins plugin for CodeBuild started the build, the string + // CodeBuild-Jenkins-Plugin . Initiator *string // Information about the build's logs in CloudWatch Logs. @@ -132,15 +117,9 @@ type Build struct { ReportArns []string // An identifier for the version of this build's source code. - // - // * For CodeCommit, - // GitHub, GitHub Enterprise, and BitBucket, the commit ID. - // - // * For CodePipeline, - // the source revision provided by CodePipeline. - // - // * For Amazon S3, this does not - // apply. + // - For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. + // - For CodePipeline, the source revision provided by CodePipeline. + // - For Amazon S3, this does not apply. ResolvedSourceVersion *string // An array of ProjectArtifacts objects. @@ -148,23 +127,18 @@ type Build struct { // An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one // of: - // - // * For CodeCommit: the commit ID, branch, or Git tag to use. - // - // * For GitHub: - // the commit ID, pull request ID, branch name, or tag name that corresponds to the - // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example, pr/25). If a branch name - // is specified, the branch's HEAD commit ID is used. If not specified, the default - // branch's HEAD commit ID is used. - // - // * For Bitbucket: the commit ID, branch name, - // or tag name that corresponds to the version of the source code you want to - // build. If a branch name is specified, the branch's HEAD commit ID is used. If - // not specified, the default branch's HEAD commit ID is used. - // - // * For Amazon S3: - // the version ID of the object that represents the build input ZIP file to use. + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example, pr/25 ). If a branch name is specified, the branch's HEAD commit ID + // is used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. SecondarySourceVersions []ProjectSourceVersion // An array of ProjectSource objects. @@ -177,10 +151,9 @@ type Build struct { Source *ProjectSource // Any version identifier for the version of the source code to be built. If - // sourceVersion is specified at the project level, then this sourceVersion (at the - // build level) takes precedence. For more information, see Source Version Sample - // with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // sourceVersion is specified at the project level, then this sourceVersion (at + // the build level) takes precedence. For more information, see Source Version + // Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string @@ -217,18 +190,12 @@ type BuildArtifacts struct { // the objects. The uploading account retains ownership of the objects. FULL The // bucket owner has full access to the objects. Object ownership is determined by // the following criteria: - // - // * If the bucket is configured with the Bucket owner - // preferred setting, the bucket owner owns the objects. The uploading account will - // have object access as specified by the bucket's policy. - // - // * Otherwise, the - // uploading account retains ownership of the objects. - // - // For more information about - // Amazon S3 object ownership, see Controlling ownership of uploaded objects using - // S3 Object Ownership - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) + // - If the bucket is configured with the Bucket owner preferred setting, the + // bucket owner owns the objects. The uploading account will have object access as + // specified by the bucket's policy. + // - Otherwise, the uploading account retains ownership of the objects. + // For more information about Amazon S3 object ownership, see Controlling + // ownership of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon Simple Storage Service User Guide. BucketOwnerAccess BucketOwnerAccess @@ -240,7 +207,7 @@ type BuildArtifacts struct { // The MD5 hash of the build artifact. You can use this hash along with a checksum // tool to confirm file integrity and authenticity. This value is available only if - // the build project's packaging value is set to ZIP. + // the build project's packaging value is set to ZIP . Md5sum *string // If this flag is set, a name specified in the buildspec file overrides the @@ -251,7 +218,7 @@ type BuildArtifacts struct { // The SHA-256 hash of the build artifact. You can use this hash along with a // checksum tool to confirm file integrity and authenticity. This value is - // available only if the build project's packaging value is set to ZIP. + // available only if the build project's packaging value is set to ZIP . Sha256sum *string noSmithyDocumentSerde @@ -270,8 +237,8 @@ type BuildBatch struct { BuildBatchConfig *ProjectBuildBatchConfig // The number of the batch build. For each project, the buildBatchNumber of its - // first batch build is 1. The buildBatchNumber of each subsequent batch build is - // incremented by 1. If a batch build is deleted, the buildBatchNumber of other + // first batch build is 1 . The buildBatchNumber of each subsequent batch build is + // incremented by 1 . If a batch build is deleted, the buildBatchNumber of other // batch builds does not change. BuildBatchNumber *int64 @@ -281,8 +248,8 @@ type BuildBatch struct { // An array of BuildGroup objects that define the build groups for the batch build. BuildGroups []BuildGroup - // Specifies the maximum amount of time, in minutes, that the build in a batch must - // be completed in. + // Specifies the maximum amount of time, in minutes, that the build in a batch + // must be completed in. BuildTimeoutInMinutes *int32 // Information about the cache for the build project. @@ -295,16 +262,15 @@ type BuildBatch struct { CurrentPhase *string // Specifies if session debugging is enabled for this batch build. For more - // information, see Viewing a running build in Session Manager - // (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). - // Batch session debugging is not supported for matrix batch builds. + // information, see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html) + // . Batch session debugging is not supported for matrix batch builds. DebugSessionEnabled *bool // The Key Management Service customer master key (CMK) to be used for encrypting // the batch build output artifacts. You can use a cross-account KMS key to encrypt // the build output artifacts if your service role has permission to that key. You // can specify either the Amazon Resource Name (ARN) of the CMK or, if available, - // the CMK's alias (using the format alias/). + // the CMK's alias (using the format alias/ ). EncryptionKey *string // The date and time that the batch build ended. @@ -314,25 +280,20 @@ type BuildBatch struct { Environment *ProjectEnvironment // An array of ProjectFileSystemLocation objects for the batch build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. + // ProjectFileSystemLocation object specifies the identifier , location , + // mountOptions , mountPoint , and type of a file system created using Amazon + // Elastic File System. FileSystemLocations []ProjectFileSystemLocation // The identifier of the batch build. Id *string // The entity that started the batch build. Valid values include: - // - // * If - // CodePipeline started the build, the pipeline's name (for example, - // codepipeline/my-demo-pipeline). - // - // * If an IAM user started the build, the user's - // name. - // - // * If the Jenkins plugin for CodeBuild started the build, the string - // CodeBuild-Jenkins-Plugin. + // - If CodePipeline started the build, the pipeline's name (for example, + // codepipeline/my-demo-pipeline ). + // - If an IAM user started the build, the user's name. + // - If the Jenkins plugin for CodeBuild started the build, the string + // CodeBuild-Jenkins-Plugin . Initiator *string // Information about logs for a build project. These can be logs in CloudWatch @@ -350,40 +311,29 @@ type BuildBatch struct { QueuedTimeoutInMinutes *int32 // The identifier of the resolved version of this batch build's source code. - // - // * For - // CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. - // - // * For - // CodePipeline, the source revision provided by CodePipeline. - // - // * For Amazon S3, - // this does not apply. + // - For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. + // - For CodePipeline, the source revision provided by CodePipeline. + // - For Amazon S3, this does not apply. ResolvedSourceVersion *string - // An array of BuildArtifacts objects the define the build artifacts for this batch - // build. + // An array of BuildArtifacts objects the define the build artifacts for this + // batch build. SecondaryArtifacts []BuildArtifacts // An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one // of: - // - // * For CodeCommit: the commit ID, branch, or Git tag to use. - // - // * For GitHub: - // the commit ID, pull request ID, branch name, or tag name that corresponds to the - // version of the source code you want to build. If a pull request ID is specified, - // it must use the format pr/pull-request-ID (for example, pr/25). If a branch name - // is specified, the branch's HEAD commit ID is used. If not specified, the default - // branch's HEAD commit ID is used. - // - // * For Bitbucket: the commit ID, branch name, - // or tag name that corresponds to the version of the source code you want to - // build. If a branch name is specified, the branch's HEAD commit ID is used. If - // not specified, the default branch's HEAD commit ID is used. - // - // * For Amazon S3: - // the version ID of the object that represents the build input ZIP file to use. + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example, pr/25 ). If a branch name is specified, the branch's HEAD commit ID + // is used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. SecondarySourceVersions []ProjectSourceVersion // An array of ProjectSource objects that define the sources for the batch build. @@ -424,8 +374,8 @@ type BuildBatchPhase struct { // troubleshoot a failed batch build. Contexts []PhaseContext - // How long, in seconds, between the starting and ending times of the batch build's - // phase. + // How long, in seconds, between the starting and ending times of the batch + // build's phase. DurationInSeconds *int64 // When the batch build phase ended, expressed in Unix time format. @@ -437,8 +387,8 @@ type BuildBatchPhase struct { // succeeded. TIMED_OUT The build phase timed out. PhaseStatus StatusType - // The name of the batch build phase. Valid values include: COMBINE_ARTIFACTS Build - // output artifacts are being combined and uploaded to the output location. + // The name of the batch build phase. Valid values include: COMBINE_ARTIFACTS + // Build output artifacts are being combined and uploaded to the output location. // DOWNLOAD_BATCHSPEC The batch build specification is being downloaded. FAILED One // or more of the builds failed. IN_PROGRESS The batch build is in progress. // STOPPED The batch build was stopped. SUBMITTED The btach build has been @@ -533,25 +483,21 @@ type BuildStatusConfig struct { // Specifies the context of the build status CodeBuild sends to the source // provider. The usage of this parameter depends on the source provider. Bitbucket // This parameter is used for the name parameter in the Bitbucket commit status. - // For more information, see build - // (https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) + // For more information, see build (https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) // in the Bitbucket API documentation. GitHub/GitHub Enterprise Server This // parameter is used for the context parameter in the GitHub commit status. For - // more information, see Create a commit status - // (https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the - // GitHub developer guide. + // more information, see Create a commit status (https://developer.github.com/v3/repos/statuses/#create-a-commit-status) + // in the GitHub developer guide. Context *string // Specifies the target url of the build status CodeBuild sends to the source // provider. The usage of this parameter depends on the source provider. Bitbucket - // This parameter is used for the url parameter in the Bitbucket commit status. For - // more information, see build - // (https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) + // This parameter is used for the url parameter in the Bitbucket commit status. + // For more information, see build (https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) // in the Bitbucket API documentation. GitHub/GitHub Enterprise Server This // parameter is used for the target_url parameter in the GitHub commit status. For - // more information, see Create a commit status - // (https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the - // GitHub developer guide. + // more information, see Create a commit status (https://developer.github.com/v3/repos/statuses/#create-a-commit-status) + // in the GitHub developer guide. TargetUrl *string noSmithyDocumentSerde @@ -588,23 +534,20 @@ type CloudWatchLogsConfig struct { // The current status of the logs in CloudWatch Logs for a build project. Valid // values are: - // - // * ENABLED: CloudWatch Logs are enabled for this build project. - // - // * - // DISABLED: CloudWatch Logs are not enabled for this build project. + // - ENABLED : CloudWatch Logs are enabled for this build project. + // - DISABLED : CloudWatch Logs are not enabled for this build project. // // This member is required. Status LogsConfigStatusType - // The group name of the logs in CloudWatch Logs. For more information, see Working - // with Log Groups and Log Streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). + // The group name of the logs in CloudWatch Logs. For more information, see + // Working with Log Groups and Log Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) + // . GroupName *string // The prefix of the stream name of the CloudWatch Logs. For more information, see - // Working with Log Groups and Log Streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html). + // Working with Log Groups and Log Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) + // . StreamName *string noSmithyDocumentSerde @@ -677,8 +620,8 @@ type CodeCoverageReportSummary struct { } // Contains information about the debug session for a build. For more information, -// see Viewing a running build in Session Manager -// (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). +// see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html) +// . type DebugSession struct { // Specifies if session debugging is enabled for this build. @@ -747,27 +690,22 @@ type EnvironmentVariable struct { // Services secret key IDs and secret access keys. PLAINTEXT environment variables // can be displayed in plain text using the CodeBuild console and the CLI. For // sensitive values, we recommend you use an environment variable of type - // PARAMETER_STORE or SECRETS_MANAGER. + // PARAMETER_STORE or SECRETS_MANAGER . // // This member is required. Value *string // The type of environment variable. Valid values include: - // - // * PARAMETER_STORE: An - // environment variable stored in Systems Manager Parameter Store. To learn how to - // specify a parameter store environment variable, see env/parameter-store - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) - // in the CodeBuild User Guide. - // - // * PLAINTEXT: An environment variable in plain text - // format. This is the default value. - // - // * SECRETS_MANAGER: An environment variable - // stored in Secrets Manager. To learn how to specify a secrets manager environment - // variable, see env/secrets-manager - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) - // in the CodeBuild User Guide. + // - PARAMETER_STORE : An environment variable stored in Systems Manager + // Parameter Store. To learn how to specify a parameter store environment variable, + // see env/parameter-store (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) + // in the CodeBuild User Guide. + // - PLAINTEXT : An environment variable in plain text format. This is the + // default value. + // - SECRETS_MANAGER : An environment variable stored in Secrets Manager. To + // learn how to specify a secrets manager environment variable, see + // env/secrets-manager (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) + // in the CodeBuild User Guide. Type EnvironmentVariableType noSmithyDocumentSerde @@ -776,8 +714,7 @@ type EnvironmentVariable struct { // Contains information about an exported environment variable. Exported // environment variables are used in conjunction with CodePipeline to export // environment variables from the current build stage to subsequent stages in the -// pipeline. For more information, see Working with variables -// (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) +// pipeline. For more information, see Working with variables (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) // in the CodePipeline User Guide. During a build, the value of a variable is // available starting with the install phase. It can be updated between the start // of the install phase and the end of the post_build phase. After the post_build @@ -827,9 +764,9 @@ type LogsLocation struct { CloudWatchLogs *CloudWatchLogsConfig // The ARN of CloudWatch Logs for a build project. Its format is - // arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. - // For more information, see Resources Defined by CloudWatch Logs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies). + // arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName} + // . For more information, see Resources Defined by CloudWatch Logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies) + // . CloudWatchLogsArn *string // The URL to an individual build log in CloudWatch Logs. @@ -845,9 +782,9 @@ type LogsLocation struct { S3Logs *S3LogsConfig // The ARN of S3 logs for a build project. Its format is - // arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see - // Resources Defined by Amazon S3 - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies). + // arn:${Partition}:s3:::${BucketName}/${ObjectName} . For more information, see + // Resources Defined by Amazon S3 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies) + // . S3LogsArn *string // The name of the CloudWatch Logs stream for the build logs. @@ -872,8 +809,8 @@ type NetworkInterface struct { // information for troubleshooting. type PhaseContext struct { - // An explanation of the build phase's context. This might include a command ID and - // an exit code. + // An explanation of the build phase's context. This might include a command ID + // and an exit code. Message *string // The status code for the context of the build phase. @@ -917,7 +854,7 @@ type Project struct { // the build output artifacts. You can use a cross-account KMS key to encrypt the // build output artifacts if your service role has permission to that key. You can // specify either the Amazon Resource Name (ARN) of the CMK or, if available, the - // CMK's alias (using the format alias/). If you don't specify a value, CodeBuild + // CMK's alias (using the format alias/ ). If you don't specify a value, CodeBuild // uses the managed CMK for Amazon Simple Storage Service (Amazon S3). EncryptionKey *string @@ -925,9 +862,9 @@ type Project struct { Environment *ProjectEnvironment // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A - // ProjectFileSystemLocation object specifies the identifier, location, - // mountOptions, mountPoint, and type of a file system created using Amazon Elastic - // File System. + // ProjectFileSystemLocation object specifies the identifier , location , + // mountOptions , mountPoint , and type of a file system created using Amazon + // Elastic File System. FileSystemLocations []ProjectFileSystemLocation // When the build project's settings were last modified, expressed in Unix time @@ -952,8 +889,8 @@ type Project struct { // The number of minutes a build is allowed to be queued before it times out. QueuedTimeoutInMinutes *int32 - // The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and - // Amazon S3 artifacts for the project's builds. + // The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs + // and Amazon S3 artifacts for the project's builds. ResourceAccessRole *string // An array of ProjectArtifacts objects. @@ -967,45 +904,36 @@ type Project struct { // An array of ProjectSource objects. SecondarySources []ProjectSource - // The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon - // Web Services services on behalf of the Amazon Web Services account. + // The ARN of the IAM role that enables CodeBuild to interact with dependent + // Amazon Web Services services on behalf of the Amazon Web Services account. ServiceRole *string // Information about the build input source code for this build project. Source *ProjectSource - // A version of the build input to be built for this project. If not specified, the - // latest version is used. If specified, it must be one of: - // - // * For CodeCommit: the - // commit ID, branch, or Git tag to use. - // - // * For GitHub: the commit ID, pull request - // ID, branch name, or tag name that corresponds to the version of the source code - // you want to build. If a pull request ID is specified, it must use the format - // pr/pull-request-ID (for example pr/25). If a branch name is specified, the - // branch's HEAD commit ID is used. If not specified, the default branch's HEAD - // commit ID is used. - // - // * For Bitbucket: the commit ID, branch name, or tag name - // that corresponds to the version of the source code you want to build. If a - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // the default branch's HEAD commit ID is used. - // - // * For Amazon S3: the version ID of - // the object that represents the build input ZIP file to use. - // - // If sourceVersion is - // specified at the build level, then that version takes precedence over this - // sourceVersion (at the project level). For more information, see Source Version - // Sample with CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // A version of the build input to be built for this project. If not specified, + // the latest version is used. If specified, it must be one of: + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example pr/25 ). If a branch name is specified, the branch's HEAD commit ID is + // used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. + // If sourceVersion is specified at the build level, then that version takes + // precedence over this sourceVersion (at the project level). For more + // information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. SourceVersion *string - // A list of tag key and value pairs associated with this build project. These tags - // are available for use by Amazon Web Services services that support CodeBuild - // build project tags. + // A list of tag key and value pairs associated with this build project. These + // tags are available for use by Amazon Web Services services that support + // CodeBuild build project tags. Tags []Tag // How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before @@ -1027,16 +955,10 @@ type Project struct { type ProjectArtifacts struct { // The type of build output artifact. Valid values include: - // - // * CODEPIPELINE: The - // build project has build output generated through CodePipeline. The CODEPIPELINE - // type is not supported for secondaryArtifacts. - // - // * NO_ARTIFACTS: The build project - // does not produce any build output. - // - // * S3: The build project stores build output - // in Amazon S3. + // - CODEPIPELINE : The build project has build output generated through + // CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts . + // - NO_ARTIFACTS : The build project does not produce any build output. + // - S3 : The build project stores build output in Amazon S3. // // This member is required. Type ArtifactsType @@ -1055,18 +977,12 @@ type ProjectArtifacts struct { // the objects. The uploading account retains ownership of the objects. FULL The // bucket owner has full access to the objects. Object ownership is determined by // the following criteria: - // - // * If the bucket is configured with the Bucket owner - // preferred setting, the bucket owner owns the objects. The uploading account will - // have object access as specified by the bucket's policy. - // - // * Otherwise, the - // uploading account retains ownership of the objects. - // - // For more information about - // Amazon S3 object ownership, see Controlling ownership of uploaded objects using - // S3 Object Ownership - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) + // - If the bucket is configured with the Bucket owner preferred setting, the + // bucket owner owns the objects. The uploading account will have object access as + // specified by the bucket's policy. + // - Otherwise, the uploading account retains ownership of the objects. + // For more information about Amazon S3 object ownership, see Controlling + // ownership of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon Simple Storage Service User Guide. BucketOwnerAccess BucketOwnerAccess @@ -1076,71 +992,49 @@ type ProjectArtifacts struct { EncryptionDisabled *bool // Information about the build output artifact location: - // - // * If type is set to - // CODEPIPELINE, CodePipeline ignores this value if specified. This is because - // CodePipeline manages its build output locations instead of CodeBuild. - // - // * If type - // is set to NO_ARTIFACTS, this value is ignored if specified, because no build - // output is produced. - // - // * If type is set to S3, this is the name of the output - // bucket. + // - If type is set to CODEPIPELINE , CodePipeline ignores this value if + // specified. This is because CodePipeline manages its build output locations + // instead of CodeBuild. + // - If type is set to NO_ARTIFACTS , this value is ignored if specified, because + // no build output is produced. + // - If type is set to S3 , this is the name of the output bucket. Location *string - // Along with path and namespaceType, the pattern that CodeBuild uses to name and + // Along with path and namespaceType , the pattern that CodeBuild uses to name and // store the output artifact: - // - // * If type is set to CODEPIPELINE, CodePipeline - // ignores this value if specified. This is because CodePipeline manages its build - // output names instead of CodeBuild. - // - // * If type is set to NO_ARTIFACTS, this value - // is ignored if specified, because no build output is produced. - // - // * If type is set - // to S3, this is the name of the output artifact object. If you set the name to be - // a forward slash ("/"), the artifact is stored in the root of the output - // bucket. - // + // - If type is set to CODEPIPELINE , CodePipeline ignores this value if + // specified. This is because CodePipeline manages its build output names instead + // of CodeBuild. + // - If type is set to NO_ARTIFACTS , this value is ignored if specified, because + // no build output is produced. + // - If type is set to S3 , this is the name of the output artifact object. If + // you set the name to be a forward slash ("/"), the artifact is stored in the root + // of the output bucket. // For example: - // - // * If path is set to MyArtifacts, namespaceType is set to - // BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored - // in MyArtifacts//MyArtifact.zip. - // - // * If path is empty, namespaceType is set to - // NONE, and name is set to "/", the output artifact is stored in the root of the - // output bucket. - // - // * If path is set to MyArtifacts, namespaceType is set to - // BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/. + // - If path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name + // is set to MyArtifact.zip , then the output artifact is stored in + // MyArtifacts//MyArtifact.zip . + // - If path is empty, namespaceType is set to NONE , and name is set to " / ", + // the output artifact is stored in the root of the output bucket. + // - If path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name + // is set to " / ", the output artifact is stored in MyArtifacts/ . Name *string - // Along with path and name, the pattern that CodeBuild uses to determine the name + // Along with path and name , the pattern that CodeBuild uses to determine the name // and location to store the output artifact: - // - // * If type is set to CODEPIPELINE, - // CodePipeline ignores this value if specified. This is because CodePipeline - // manages its build output names instead of CodeBuild. - // - // * If type is set to - // NO_ARTIFACTS, this value is ignored if specified, because no build output is - // produced. - // - // * If type is set to S3, valid values include: - // - // * BUILD_ID: Include - // the build ID in the location of the build output artifact. - // - // * NONE: Do not - // include the build ID. This is the default if namespaceType is not - // specified. - // - // For example, if path is set to MyArtifacts, namespaceType is set to - // BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in - // MyArtifacts//MyArtifact.zip. + // - If type is set to CODEPIPELINE , CodePipeline ignores this value if + // specified. This is because CodePipeline manages its build output names instead + // of CodeBuild. + // - If type is set to NO_ARTIFACTS , this value is ignored if specified, because + // no build output is produced. + // - If type is set to S3 , valid values include: + // - BUILD_ID : Include the build ID in the location of the build output + // artifact. + // - NONE : Do not include the build ID. This is the default if namespaceType is + // not specified. + // For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , + // and name is set to MyArtifact.zip , the output artifact is stored in + // MyArtifacts//MyArtifact.zip . NamespaceType ArtifactNamespace // If this flag is set, a name specified in the buildspec file overrides the @@ -1150,42 +1044,30 @@ type ProjectArtifacts struct { OverrideArtifactName *bool // The type of build output artifact to create: - // - // * If type is set to CODEPIPELINE, - // CodePipeline ignores this value if specified. This is because CodePipeline - // manages its build output artifacts instead of CodeBuild. - // - // * If type is set to - // NO_ARTIFACTS, this value is ignored if specified, because no build output is - // produced. - // - // * If type is set to S3, valid values include: - // - // * NONE: CodeBuild - // creates in the output bucket a folder that contains the build output. This is - // the default if packaging is not specified. - // - // * ZIP: CodeBuild creates in the - // output bucket a ZIP file that contains the build output. + // - If type is set to CODEPIPELINE , CodePipeline ignores this value if + // specified. This is because CodePipeline manages its build output artifacts + // instead of CodeBuild. + // - If type is set to NO_ARTIFACTS , this value is ignored if specified, because + // no build output is produced. + // - If type is set to S3 , valid values include: + // - NONE : CodeBuild creates in the output bucket a folder that contains the + // build output. This is the default if packaging is not specified. + // - ZIP : CodeBuild creates in the output bucket a ZIP file that contains the + // build output. Packaging ArtifactPackaging - // Along with namespaceType and name, the pattern that CodeBuild uses to name and + // Along with namespaceType and name , the pattern that CodeBuild uses to name and // store the output artifact: - // - // * If type is set to CODEPIPELINE, CodePipeline - // ignores this value if specified. This is because CodePipeline manages its build - // output names instead of CodeBuild. - // - // * If type is set to NO_ARTIFACTS, this value - // is ignored if specified, because no build output is produced. - // - // * If type is set - // to S3, this is the path to the output artifact. If path is not specified, path - // is not used. - // - // For example, if path is set to MyArtifacts, namespaceType is set - // to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the - // output bucket at MyArtifacts/MyArtifact.zip. + // - If type is set to CODEPIPELINE , CodePipeline ignores this value if + // specified. This is because CodePipeline manages its build output names instead + // of CodeBuild. + // - If type is set to NO_ARTIFACTS , this value is ignored if specified, because + // no build output is produced. + // - If type is set to S3 , this is the path to the output artifact. If path is + // not specified, path is not used. + // For example, if path is set to MyArtifacts , namespaceType is set to NONE , and + // name is set to MyArtifact.zip , the output artifact is stored in the output + // bucket at MyArtifacts/MyArtifact.zip . Path *string noSmithyDocumentSerde @@ -1208,13 +1090,13 @@ type ProjectBadge struct { // Contains configuration information about a batch build project. type ProjectBuildBatchConfig struct { - // Specifies how build status reports are sent to the source provider for the batch - // build. This property is only used when the source provider for your project is - // Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to - // report build statuses to the source provider. REPORT_AGGREGATED_BATCH (Default) - // Aggregate all of the build statuses into a single status report. - // REPORT_INDIVIDUAL_BUILDS Send a separate status report for each individual - // build. + // Specifies how build status reports are sent to the source provider for the + // batch build. This property is only used when the source provider for your + // project is Bitbucket, GitHub, or GitHub Enterprise, and your project is + // configured to report build statuses to the source provider. + // REPORT_AGGREGATED_BATCH (Default) Aggregate all of the build statuses into a + // single status report. REPORT_INDIVIDUAL_BUILDS Send a separate status report for + // each individual build. BatchReportMode BatchReportModeType // Specifies if the build artifacts for the batch build should be combined into a @@ -1238,25 +1120,17 @@ type ProjectBuildBatchConfig struct { type ProjectCache struct { // The type of cache used by the build project. Valid values include: - // - // * NO_CACHE: - // The build project does not use any cache. - // - // * S3: The build project reads and - // writes from and to S3. - // - // * LOCAL: The build project stores a cache locally on a - // build host that is only available to that build host. + // - NO_CACHE : The build project does not use any cache. + // - S3 : The build project reads and writes from and to S3. + // - LOCAL : The build project stores a cache locally on a build host that is + // only available to that build host. // // This member is required. Type CacheType // Information about the cache location: - // - // * NO_CACHE or LOCAL: This value is - // ignored. - // - // * S3: This is the S3 bucket name/prefix. + // - NO_CACHE or LOCAL : This value is ignored. + // - S3 : This is the S3 bucket name/prefix. Location *string // An array of strings that specify the local cache modes. You can use one or more @@ -1270,31 +1144,20 @@ type ProjectCache struct { // Caches existing Docker layers. This mode is a good choice for projects that // build or pull large Docker images. It can prevent the performance issues caused // by pulling large Docker images down from the network. - // - // * You can use a Docker - // layer cache in the Linux environment only. - // - // * The privileged flag must be set so - // that your project has the required Docker permissions. - // - // * You should consider - // the security implications before you use a Docker layer - // cache. - // - // LOCAL_CUSTOM_CACHE Caches directories you specify in the buildspec file. - // This mode is a good choice if your build scenario is not suited to one of the - // other three local cache modes. If you use a custom cache: - // - // * Only directories - // can be specified for caching. You cannot specify individual files. - // - // * Symlinks - // are used to reference cached directories. - // - // * Cached directories are linked to - // your build before it downloads its project sources. Cached items are overridden - // if a source item has the same name. Directories are specified using cache paths - // in the buildspec file. + // - You can use a Docker layer cache in the Linux environment only. + // - The privileged flag must be set so that your project has the required Docker + // permissions. + // - You should consider the security implications before you use a Docker layer + // cache. + // LOCAL_CUSTOM_CACHE Caches directories you specify in the buildspec file. This + // mode is a good choice if your build scenario is not suited to one of the other + // three local cache modes. If you use a custom cache: + // - Only directories can be specified for caching. You cannot specify + // individual files. + // - Symlinks are used to reference cached directories. + // - Cached directories are linked to your build before it downloads its project + // sources. Cached items are overridden if a source item has the same name. + // Directories are specified using cache paths in the buildspec file. Modes []CacheMode noSmithyDocumentSerde @@ -1303,38 +1166,23 @@ type ProjectCache struct { // Information about the build environment of the build project. type ProjectEnvironment struct { - // Information about the compute resources the build project uses. Available values - // include: - // - // * BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for - // builds. - // - // * BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for - // builds. - // - // * BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, - // depending on your environment type. - // - // * BUILD_GENERAL1_2XLARGE: Use up to 145 GB - // memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type - // supports Docker images up to 100 GB uncompressed. - // - // If you use - // BUILD_GENERAL1_LARGE: - // - // * For environment type LINUX_CONTAINER, you can use up to - // 15 GB memory and 8 vCPUs for builds. - // - // * For environment type - // LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA - // Tesla V100 GPUs for builds. - // - // * For environment type ARM_CONTAINER, you can use - // up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. - // - // For more - // information, see Build Environment Compute Types - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) + // Information about the compute resources the build project uses. Available + // values include: + // - BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds. + // - BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds. + // - BUILD_GENERAL1_LARGE : Use up to 16 GB memory and 8 vCPUs for builds, + // depending on your environment type. + // - BUILD_GENERAL1_2XLARGE : Use up to 145 GB memory, 72 vCPUs, and 824 GB of + // SSD storage for builds. This compute type supports Docker images up to 100 GB + // uncompressed. + // If you use BUILD_GENERAL1_LARGE : + // - For environment type LINUX_CONTAINER , you can use up to 15 GB memory and 8 + // vCPUs for builds. + // - For environment type LINUX_GPU_CONTAINER , you can use up to 255 GB memory, + // 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. + // - For environment type ARM_CONTAINER , you can use up to 16 GB memory and 8 + // vCPUs on ARM-based processors for builds. + // For more information, see Build Environment Compute Types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) // in the CodeBuild User Guide. // // This member is required. @@ -1342,51 +1190,36 @@ type ProjectEnvironment struct { // The image tag or image digest that identifies the Docker image to use for this // build project. Use the following formats: - // - // * For an image tag: /:. For example, - // in the Docker repository that CodeBuild uses to manage its Docker images, this - // would be aws/codebuild/standard:4.0. - // - // * For an image digest: /@. For example, to - // specify an image with the digest - // "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use - // /@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf. - // - // For - // more information, see Docker images provided by CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) + // - For an image tag: /: . For example, in the Docker repository that CodeBuild + // uses to manage its Docker images, this would be aws/codebuild/standard:4.0 . + // - For an image digest: /@ . For example, to specify an image with the digest + // "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use + // /@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf . + // For more information, see Docker images provided by CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) // in the CodeBuild user guide. // // This member is required. Image *string // The type of build environment to use for related builds. - // - // * The environment type - // ARM_CONTAINER is available only in regions US East (N. Virginia), US East - // (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific - // (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). - // - // * The environment type - // LINUX_CONTAINER with compute type build.general1.2xlarge is available only in - // regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada - // (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia - // Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China - // (Beijing), and China (Ningxia). - // - // * The environment type LINUX_GPU_CONTAINER is - // available only in regions US East (N. Virginia), US East (Ohio), US West - // (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia - // Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific - // (Sydney) , China (Beijing), and China (Ningxia). - // - // * The environment types - // WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in - // regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU - // (Ireland). - // - // For more information, see Build environment compute types - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) + // - The environment type ARM_CONTAINER is available only in regions US East (N. + // Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific + // (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). + // - The environment type LINUX_CONTAINER with compute type + // build.general1.2xlarge is available only in regions US East (N. Virginia), US + // East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU + // (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific + // (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). + // - The environment type LINUX_GPU_CONTAINER is available only in regions US + // East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU + // (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific + // (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and + // China (Ningxia). + // + // - The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER + // are available only in regions US East (N. Virginia), US East (Ohio), US West + // (Oregon), and EU (Ireland). + // For more information, see Build environment compute types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) // in the CodeBuild user guide. // // This member is required. @@ -1394,8 +1227,7 @@ type ProjectEnvironment struct { // The ARN of the Amazon S3 bucket, path prefix, and object key that contains the // PEM-encoded certificate for the build project. For more information, see - // certificate - // (https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) + // certificate (https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) // in the CodeBuild User Guide. Certificate *string @@ -1405,33 +1237,29 @@ type ProjectEnvironment struct { // The type of credentials CodeBuild uses to pull images in your build. There are // two valid values: - // - // * CODEBUILD specifies that CodeBuild uses its own - // credentials. This requires that you modify your ECR repository policy to trust - // CodeBuild service principal. - // - // * SERVICE_ROLE specifies that CodeBuild uses your - // build project's service role. - // - // When you use a cross-account or private registry - // image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated - // image, you must use CODEBUILD credentials. + // - CODEBUILD specifies that CodeBuild uses its own credentials. This requires + // that you modify your ECR repository policy to trust CodeBuild service principal. + // + // - SERVICE_ROLE specifies that CodeBuild uses your build project's service + // role. + // When you use a cross-account or private registry image, you must use + // SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use + // CODEBUILD credentials. ImagePullCredentialsType ImagePullCredentialsType - // Enables running the Docker daemon inside a Docker container. Set to true only if - // the build project is used to build Docker images. Otherwise, a build that - // attempts to interact with the Docker daemon fails. The default setting is false. - // You can initialize the Docker daemon during the install phase of your build by + // Enables running the Docker daemon inside a Docker container. Set to true only + // if the build project is used to build Docker images. Otherwise, a build that + // attempts to interact with the Docker daemon fails. The default setting is false + // . You can initialize the Docker daemon during the install phase of your build by // adding one of the following sets of commands to the install phase of your // buildspec file: If the operating system's base image is Ubuntu Linux: - nohup // /usr/local/bin/dockerd --host=unix:///var/run/docker.sock - // --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until + // --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout 15 sh -c "until // docker info; do echo .; sleep 1; done" If the operating system's base image is // Alpine Linux and the previous command does not work, add the -t argument to - // timeout: - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock + // timeout : - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock // --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - // - timeout -t 15 sh -c - // "until docker info; do echo .; sleep 1; done" + // - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" PrivilegedMode *bool // The credentials for access to a private registry. @@ -1440,25 +1268,24 @@ type ProjectEnvironment struct { noSmithyDocumentSerde } -// Information about a file system created by Amazon Elastic File System (EFS). For -// more information, see What Is Amazon Elastic File System? -// (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) +// Information about a file system created by Amazon Elastic File System (EFS). +// For more information, see What Is Amazon Elastic File System? (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) type ProjectFileSystemLocation struct { // The name used to access a file system created by Amazon EFS. CodeBuild creates // an environment variable by appending the identifier in all capital letters to - // CODEBUILD_. For example, if you specify my_efs for identifier, a new environment - // variable is create named CODEBUILD_MY_EFS. The identifier is used to mount your - // file system. + // CODEBUILD_ . For example, if you specify my_efs for identifier , a new + // environment variable is create named CODEBUILD_MY_EFS . The identifier is used + // to mount your file system. Identifier *string // A string that specifies the location of the file system created by Amazon EFS. - // Its format is efs-dns-name:/directory-path. You can find the DNS name of file + // Its format is efs-dns-name:/directory-path . You can find the DNS name of file // system when you view it in the Amazon EFS console. The directory path is a path // to a directory in the file system that CodeBuild mounts. For example, if the DNS - // name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount - // directory is my-efs-mount-directory, then the location is - // fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory. The directory + // name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com , and its mount + // directory is my-efs-mount-directory , then the location is + // fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory . The directory // path in the format efs-dns-name:/directory-path is optional. If you do not // specify a directory path, the location is only the DNS name and CodeBuild mounts // the entire file system. @@ -1466,15 +1293,15 @@ type ProjectFileSystemLocation struct { // The mount options for a file system created by Amazon EFS. The default mount // options used by CodeBuild are - // nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more - // information, see Recommended NFS Mount Options - // (https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html). + // nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2 . For more + // information, see Recommended NFS Mount Options (https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html) + // . MountOptions *string // The location in the container where you mount the file system. MountPoint *string - // The type of the file system. The one supported type is EFS. + // The type of the file system. The one supported type is EFS . Type FileSystemType noSmithyDocumentSerde @@ -1485,26 +1312,16 @@ type ProjectSource struct { // The type of repository that contains the source code to be built. Valid values // include: - // - // * BITBUCKET: The source code is in a Bitbucket repository. - // - // * - // CODECOMMIT: The source code is in an CodeCommit repository. - // - // * CODEPIPELINE: The - // source code settings are specified in the source action of a pipeline in - // CodePipeline. - // - // * GITHUB: The source code is in a GitHub or GitHub Enterprise - // Cloud repository. - // - // * GITHUB_ENTERPRISE: The source code is in a GitHub - // Enterprise Server repository. - // - // * NO_SOURCE: The project does not have input - // source code. - // - // * S3: The source code is in an Amazon S3 bucket. + // - BITBUCKET : The source code is in a Bitbucket repository. + // - CODECOMMIT : The source code is in an CodeCommit repository. + // - CODEPIPELINE : The source code settings are specified in the source action + // of a pipeline in CodePipeline. + // - GITHUB : The source code is in a GitHub or GitHub Enterprise Cloud + // repository. + // - GITHUB_ENTERPRISE : The source code is in a GitHub Enterprise Server + // repository. + // - NO_SOURCE : The project does not have input source code. + // - S3 : The source code is in an Amazon S3 bucket. // // This member is required. Type SourceType @@ -1514,9 +1331,9 @@ type ProjectSource struct { // code should not get or set this information directly. Auth *SourceAuth - // Contains information that defines how the build project reports the build status - // to the source provider. This option is only used when the source provider is - // GITHUB, GITHUB_ENTERPRISE, or BITBUCKET. + // Contains information that defines how the build project reports the build + // status to the source provider. This option is only used when the source provider + // is GITHUB , GITHUB_ENTERPRISE , or BITBUCKET . BuildStatusConfig *BuildStatusConfig // The buildspec file declaration to use for the builds in this build project. If @@ -1525,11 +1342,11 @@ type ProjectSource struct { // CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket // must be in the same Amazon Web Services Region as the build project. Specify the // buildspec file using its ARN (for example, - // arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided + // arn:aws:s3:::my-codebuild-sample2/buildspec.yml ). If this value is not provided // or is set to an empty string, the source code must contain a buildspec file in // its root directory. For more information, see Buildspec File Name and Storage - // Location - // (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage). + // Location (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage) + // . Buildspec *string // Information about the Git clone depth for the build project. @@ -1544,51 +1361,39 @@ type ProjectSource struct { // Information about the location of the source code to be built. Valid values // include: - // - // * For source code settings that are specified in the source action of - // a pipeline in CodePipeline, location should not be specified. If it is - // specified, CodePipeline ignores it. This is because CodePipeline uses the - // settings in a pipeline's source action instead of this value. - // - // * For source code - // in an CodeCommit repository, the HTTPS clone URL to the repository that contains - // the source code and the buildspec file (for example, - // https://git-codecommit..amazonaws.com/v1/repos/). - // - // * For source code in an - // Amazon S3 input bucket, one of the following. - // - // * The path to the ZIP file that - // contains the source code (for example, //.zip). - // - // * The path to the folder that - // contains the source code (for example, ///). - // - // * For source code in a GitHub - // repository, the HTTPS clone URL to the repository that contains the source and - // the buildspec file. You must connect your Amazon Web Services account to your - // GitHub account. Use the CodeBuild console to start creating a build project. - // When you use the console to connect (or reconnect) with GitHub, on the GitHub - // Authorize application page, for Organization access, choose Request access next - // to each repository you want to allow CodeBuild to have access to, and then - // choose Authorize application. (After you have connected to your GitHub account, - // you do not need to finish creating the build project. You can leave the - // CodeBuild console.) To instruct CodeBuild to use this connection, in the source - // object, set the auth object's type value to OAUTH. - // - // * For source code in a - // Bitbucket repository, the HTTPS clone URL to the repository that contains the - // source and the buildspec file. You must connect your Amazon Web Services account - // to your Bitbucket account. Use the CodeBuild console to start creating a build - // project. When you use the console to connect (or reconnect) with Bitbucket, on - // the Bitbucket Confirm access to your account page, choose Grant access. (After - // you have connected to your Bitbucket account, you do not need to finish creating - // the build project. You can leave the CodeBuild console.) To instruct CodeBuild - // to use this connection, in the source object, set the auth object's type value - // to OAUTH. - // - // If you specify CODEPIPELINE for the Type property, don't specify this - // property. For all of the other types, you must specify Location. + // - For source code settings that are specified in the source action of a + // pipeline in CodePipeline, location should not be specified. If it is + // specified, CodePipeline ignores it. This is because CodePipeline uses the + // settings in a pipeline's source action instead of this value. + // - For source code in an CodeCommit repository, the HTTPS clone URL to the + // repository that contains the source code and the buildspec file (for example, + // https://git-codecommit..amazonaws.com/v1/repos/ ). + // - For source code in an Amazon S3 input bucket, one of the following. + // - The path to the ZIP file that contains the source code (for example, //.zip + // ). + // - The path to the folder that contains the source code (for example, /// ). + // - For source code in a GitHub repository, the HTTPS clone URL to the + // repository that contains the source and the buildspec file. You must connect + // your Amazon Web Services account to your GitHub account. Use the CodeBuild + // console to start creating a build project. When you use the console to connect + // (or reconnect) with GitHub, on the GitHub Authorize application page, for + // Organization access, choose Request access next to each repository you want to + // allow CodeBuild to have access to, and then choose Authorize application. (After + // you have connected to your GitHub account, you do not need to finish creating + // the build project. You can leave the CodeBuild console.) To instruct CodeBuild + // to use this connection, in the source object, set the auth object's type value + // to OAUTH . + // - For source code in a Bitbucket repository, the HTTPS clone URL to the + // repository that contains the source and the buildspec file. You must connect + // your Amazon Web Services account to your Bitbucket account. Use the CodeBuild + // console to start creating a build project. When you use the console to connect + // (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account + // page, choose Grant access. (After you have connected to your Bitbucket account, + // you do not need to finish creating the build project. You can leave the + // CodeBuild console.) To instruct CodeBuild to use this connection, in the + // source object, set the auth object's type value to OAUTH . + // If you specify CODEPIPELINE for the Type property, don't specify this property. + // For all of the other types, you must specify Location . Location *string // Set to true to report the status of a build's start and finish to your source @@ -1597,12 +1402,11 @@ type ProjectSource struct { // provider, an invalidInputException is thrown. To be able to report the build // status to the source provider, the user associated with the source provider must // have write access to the repo. If the user does not have write access, the build - // status cannot be updated. For more information, see Source provider access - // (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html) in - // the CodeBuild User Guide. The status of a build triggered by a webhook is always - // reported to your source provider. If your project's builds are triggered by a - // webhook, you must push a new commit to the repo for a change to this property to - // take effect. + // status cannot be updated. For more information, see Source provider access (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html) + // in the CodeBuild User Guide. The status of a build triggered by a webhook is + // always reported to your source provider. If your project's builds are triggered + // by a webhook, you must push a new commit to the repo for a change to this + // property to take effect. ReportBuildStatus *bool // An identifier for this project source. The identifier can only contain @@ -1616,37 +1420,28 @@ type ProjectSource struct { // A source identifier and its corresponding version. type ProjectSourceVersion struct { - // An identifier for a source in the build project. The identifier can only contain - // alphanumeric characters and underscores, and must be less than 128 characters in - // length. + // An identifier for a source in the build project. The identifier can only + // contain alphanumeric characters and underscores, and must be less than 128 + // characters in length. // // This member is required. SourceIdentifier *string // The source version for the corresponding source identifier. If specified, must // be one of: - // - // * For CodeCommit: the commit ID, branch, or Git tag to use. - // - // * For - // GitHub: the commit ID, pull request ID, branch name, or tag name that - // corresponds to the version of the source code you want to build. If a pull - // request ID is specified, it must use the format pr/pull-request-ID (for example, - // pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If - // not specified, the default branch's HEAD commit ID is used. - // - // * For Bitbucket: - // the commit ID, branch name, or tag name that corresponds to the version of the - // source code you want to build. If a branch name is specified, the branch's HEAD - // commit ID is used. If not specified, the default branch's HEAD commit ID is - // used. - // - // * For Amazon S3: the version ID of the object that represents the build - // input ZIP file to use. - // - // For more information, see Source Version Sample with - // CodeBuild - // (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) + // - For CodeCommit: the commit ID, branch, or Git tag to use. + // - For GitHub: the commit ID, pull request ID, branch name, or tag name that + // corresponds to the version of the source code you want to build. If a pull + // request ID is specified, it must use the format pr/pull-request-ID (for + // example, pr/25 ). If a branch name is specified, the branch's HEAD commit ID + // is used. If not specified, the default branch's HEAD commit ID is used. + // - For Bitbucket: the commit ID, branch name, or tag name that corresponds to + // the version of the source code you want to build. If a branch name is specified, + // the branch's HEAD commit ID is used. If not specified, the default branch's HEAD + // commit ID is used. + // - For Amazon S3: the version ID of the object that represents the build input + // ZIP file to use. + // For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) // in the CodeBuild User Guide. // // This member is required. @@ -1657,15 +1452,12 @@ type ProjectSourceVersion struct { // Information about credentials that provide access to a private Docker registry. // When this is set: +// - imagePullCredentialsType must be set to SERVICE_ROLE . +// - images cannot be curated or an Amazon ECR image. // -// * imagePullCredentialsType must be set to SERVICE_ROLE. -// -// * -// images cannot be curated or an Amazon ECR image. -// -// For more information, see -// Private Registry with Secrets Manager Sample for CodeBuild -// (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html). +// For more information, see Private Registry with Secrets Manager Sample for +// CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html) +// . type RegistryCredential struct { // The Amazon Resource Name (ARN) or name of credentials created using Secrets @@ -1684,10 +1476,11 @@ type RegistryCredential struct { noSmithyDocumentSerde } -// Information about the results from running a series of test cases during the run -// of a build project. The test cases are specified in the buildspec for the build -// project using one or more paths to the test case files. You can specify any type -// of tests you want, such as unit tests, integration tests, and functional tests. +// Information about the results from running a series of test cases during the +// run of a build project. The test cases are specified in the buildspec for the +// build project using one or more paths to the test case files. You can specify +// any type of tests you want, such as unit tests, integration tests, and +// functional tests. type Report struct { // The ARN of the report run. @@ -1722,8 +1515,8 @@ type Report struct { // A TestReportSummary object that contains information about this test report. TestSummary *TestReportSummary - // A boolean that specifies if this report run is truncated. The list of test cases - // is truncated after the maximum number of test cases is reached. + // A boolean that specifies if this report run is truncated. The list of test + // cases is truncated after the maximum number of test cases is reached. Truncated *bool // The type of the report that was run. CODE_COVERAGE A code coverage report. TEST @@ -1737,11 +1530,8 @@ type Report struct { type ReportExportConfig struct { // The export configuration type. Valid values are: - // - // * S3: The report results are - // exported to an S3 bucket. - // - // * NO_EXPORT: The report results are not exported. + // - S3 : The report results are exported to an S3 bucket. + // - NO_EXPORT : The report results are not exported. ExportConfigType ReportExportConfigType // A S3ReportExportConfig object that contains information about the S3 bucket @@ -1767,7 +1557,7 @@ type ReportFilter struct { // files. type ReportGroup struct { - // The ARN of the ReportGroup. + // The ARN of the ReportGroup . Arn *string // The date and time this ReportGroup was created. @@ -1780,7 +1570,7 @@ type ReportGroup struct { // The date and time this ReportGroup was last modified. LastModified *time.Time - // The name of the ReportGroup. + // The name of the ReportGroup . Name *string // The status of the report group. This property is read-only. This can be one of @@ -1793,7 +1583,7 @@ type ReportGroup struct { // report group tags. Tags []Tag - // The type of the ReportGroup. This can be one of the following values: + // The type of the ReportGroup . This can be one of the following values: // CODE_COVERAGE The report group contains code coverage reports. TEST The report // group contains test reports. Type ReportType @@ -1829,8 +1619,8 @@ type ReportWithRawData struct { noSmithyDocumentSerde } -// Represents a resolved build artifact. A resolved artifact is an artifact that is -// built and deployed to the destination, such as Amazon S3. +// Represents a resolved build artifact. A resolved artifact is an artifact that +// is built and deployed to the destination, such as Amazon S3. type ResolvedArtifact struct { // The identifier of the artifact. @@ -1849,12 +1639,8 @@ type ResolvedArtifact struct { type S3LogsConfig struct { // The current status of the S3 build logs. Valid values are: - // - // * ENABLED: S3 build - // logs are enabled for this build project. - // - // * DISABLED: S3 build logs are not - // enabled for this build project. + // - ENABLED : S3 build logs are enabled for this build project. + // - DISABLED : S3 build logs are not enabled for this build project. // // This member is required. Status LogsConfigStatusType @@ -1870,28 +1656,22 @@ type S3LogsConfig struct { // the objects. The uploading account retains ownership of the objects. FULL The // bucket owner has full access to the objects. Object ownership is determined by // the following criteria: - // - // * If the bucket is configured with the Bucket owner - // preferred setting, the bucket owner owns the objects. The uploading account will - // have object access as specified by the bucket's policy. - // - // * Otherwise, the - // uploading account retains ownership of the objects. - // - // For more information about - // Amazon S3 object ownership, see Controlling ownership of uploaded objects using - // S3 Object Ownership - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) + // - If the bucket is configured with the Bucket owner preferred setting, the + // bucket owner owns the objects. The uploading account will have object access as + // specified by the bucket's policy. + // - Otherwise, the uploading account retains ownership of the objects. + // For more information about Amazon S3 object ownership, see Controlling + // ownership of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon Simple Storage Service User Guide. BucketOwnerAccess BucketOwnerAccess - // Set to true if you do not want your S3 build log output encrypted. By default S3 - // build logs are encrypted. + // Set to true if you do not want your S3 build log output encrypted. By default + // S3 build logs are encrypted. EncryptionDisabled *bool // The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 - // bucket name is my-bucket, and your path prefix is build-log, then acceptable - // formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. + // bucket name is my-bucket , and your path prefix is build-log , then acceptable + // formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log . Location *string noSmithyDocumentSerde @@ -1903,9 +1683,9 @@ type S3ReportExportConfig struct { // The name of the S3 bucket where the raw data of a report are exported. Bucket *string - // The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. - // This allows report data to be exported to an Amazon S3 bucket that is owned by - // an account other than the account running the build. + // The Amazon Web Services account identifier of the owner of the Amazon S3 + // bucket. This allows report data to be exported to an Amazon S3 bucket that is + // owned by an account other than the account running the build. BucketOwner *string // A boolean value that specifies if the results of a report are encrypted. @@ -1915,13 +1695,9 @@ type S3ReportExportConfig struct { EncryptionKey *string // The type of build output artifact to create. Valid values include: - // - // * NONE: - // CodeBuild creates the raw data in the output bucket. This is the default if - // packaging is not specified. - // - // * ZIP: CodeBuild creates a ZIP file with the raw - // data in the output bucket. + // - NONE : CodeBuild creates the raw data in the output bucket. This is the + // default if packaging is not specified. + // - ZIP : CodeBuild creates a ZIP file with the raw data in the output bucket. Packaging ReportPackagingType // The path to the exported report's raw data results. @@ -1936,7 +1712,7 @@ type S3ReportExportConfig struct { type SourceAuth struct { // This data type is deprecated and is no longer accurate or used. The - // authorization type to use. The only valid value is OAUTH, which represents the + // authorization type to use. The only valid value is OAUTH , which represents the // OAuth authorization type. // // This member is required. @@ -1959,8 +1735,8 @@ type SourceCredentialsInfo struct { // BASIC_AUTH, or PERSONAL_ACCESS_TOKEN. AuthType AuthType - // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or - // BITBUCKET. + // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, + // or BITBUCKET. ServerType ServerType noSmithyDocumentSerde @@ -2005,7 +1781,7 @@ type TestCase struct { ReportArn *string // The status returned by the test case after it was run. Valid statuses are - // SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. + // SUCCEEDED , FAILED , ERROR , SKIPPED , and UNKNOWN . Status *string // The path to the raw data file that contains the test result. @@ -2025,16 +1801,11 @@ type TestCaseFilter struct { // The status used to filter test cases. A TestCaseFilter can have one status. // Valid values are: - // - // * SUCCEEDED - // - // * FAILED - // - // * ERROR - // - // * SKIPPED - // - // * UNKNOWN + // - SUCCEEDED + // - FAILED + // - ERROR + // - SKIPPED + // - UNKNOWN Status *string noSmithyDocumentSerde @@ -2049,13 +1820,13 @@ type TestReportSummary struct { DurationInNanoSeconds *int64 // A map that contains the number of each type of status returned by the test - // results in this TestReportSummary. + // results in this TestReportSummary . // // This member is required. StatusCounts map[string]int32 - // The number of test cases in this TestReportSummary. The total includes truncated - // test cases. + // The number of test cases in this TestReportSummary . The total includes + // truncated test cases. // // This member is required. Total *int32 @@ -2085,16 +1856,17 @@ type Webhook struct { // A regular expression used to determine which repository branches are built when // a webhook is triggered. If the name of a branch matches the regular expression, // then it is built. If branchFilter is empty, then all branches are built. It is - // recommended that you use filterGroups instead of branchFilter. + // recommended that you use filterGroups instead of branchFilter . BranchFilter *string // Specifies the type of build this webhook will trigger. BuildType WebhookBuildType - // An array of arrays of WebhookFilter objects used to determine which webhooks are - // triggered. At least one WebhookFilter in the array must specify EVENT as its - // type. For a build to be triggered, at least one filter group in the filterGroups - // array must pass. For a filter group to pass, each of its filters must pass. + // An array of arrays of WebhookFilter objects used to determine which webhooks + // are triggered. At least one WebhookFilter in the array must specify EVENT as + // its type . For a build to be triggered, at least one filter group in the + // filterGroups array must pass. For a filter group to pass, each of its filters + // must pass. FilterGroups [][]WebhookFilter // A timestamp that indicates the last time a repository's secret token was @@ -2105,7 +1877,7 @@ type Webhook struct { PayloadUrl *string // The secret token of the associated repository. A Bitbucket webhook does not - // support secret. + // support secret . Secret *string // The URL to the webhook. @@ -2124,44 +1896,44 @@ type WebhookFilter struct { // that uses any of the other filter types, a regular expression pattern. For // example, a WebHookFilter that uses HEAD_REF for its type and the pattern // ^refs/heads/ triggers a build when the head reference is a branch with a - // reference name refs/heads/branch-name. + // reference name refs/heads/branch-name . // // This member is required. Pattern *string - // The type of webhook filter. There are six webhook filter types: EVENT, - // ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE. EVENT A - // webhook event triggers a build when the provided pattern matches one of five - // event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, - // PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. The EVENT patterns are specified - // as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, + // The type of webhook filter. There are six webhook filter types: EVENT , + // ACTOR_ACCOUNT_ID , HEAD_REF , BASE_REF , FILE_PATH , and COMMIT_MESSAGE . EVENT + // A webhook event triggers a build when the provided pattern matches one of five + // event types: PUSH , PULL_REQUEST_CREATED , PULL_REQUEST_UPDATED , + // PULL_REQUEST_REOPENED , and PULL_REQUEST_MERGED . The EVENT patterns are + // specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, // PULL_REQUEST_UPDATED filters all push, pull request created, and pull request // updated events. The PULL_REQUEST_REOPENED works with GitHub and GitHub // Enterprise only. ACTOR_ACCOUNT_ID A webhook event triggers a build when a // GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular - // expression pattern. HEAD_REF A webhook event triggers a build when the head - // reference matches the regular expression pattern. For example, - // refs/heads/branch-name and refs/tags/tag-name. Works with GitHub and GitHub + // expression pattern . HEAD_REF A webhook event triggers a build when the head + // reference matches the regular expression pattern . For example, + // refs/heads/branch-name and refs/tags/tag-name . Works with GitHub and GitHub // Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and // Bitbucket pull request events. BASE_REF A webhook event triggers a build when - // the base reference matches the regular expression pattern. For example, - // refs/heads/branch-name. Works with pull request events only. FILE_PATH A webhook - // triggers a build when the path of a changed file matches the regular expression - // pattern. Works with GitHub and Bitbucket events push and pull requests events. + // the base reference matches the regular expression pattern . For example, + // refs/heads/branch-name . Works with pull request events only. FILE_PATH A + // webhook triggers a build when the path of a changed file matches the regular + // expression pattern . Works with GitHub and Bitbucket events push and pull + // requests events. Also works with GitHub Enterprise push events, but does not + // work with GitHub Enterprise pull request events. COMMIT_MESSAGE A webhook + // triggers a build when the head commit message matches the regular expression + // pattern . Works with GitHub and Bitbucket events push and pull requests events. // Also works with GitHub Enterprise push events, but does not work with GitHub - // Enterprise pull request events. COMMIT_MESSAGE A webhook triggers a build when - // the head commit message matches the regular expression pattern. Works with - // GitHub and Bitbucket events push and pull requests events. Also works with - // GitHub Enterprise push events, but does not work with GitHub Enterprise pull - // request events. + // Enterprise pull request events. // // This member is required. Type WebhookFilterType - // Used to indicate that the pattern determines which webhook events do not trigger - // a build. If true, then a webhook event that does not match the pattern triggers - // a build. If false, then a webhook event that matches the pattern triggers a - // build. + // Used to indicate that the pattern determines which webhook events do not + // trigger a build. If true, then a webhook event that does not match the pattern + // triggers a build. If false, then a webhook event that matches the pattern + // triggers a build. ExcludeMatchedPattern *bool noSmithyDocumentSerde diff --git a/service/codecatalyst/api_client.go b/service/codecatalyst/api_client.go index 4f482355e1b..5a623f70521 100644 --- a/service/codecatalyst/api_client.go +++ b/service/codecatalyst/api_client.go @@ -113,7 +113,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codecatalyst/api_op_CreateAccessToken.go b/service/codecatalyst/api_op_CreateAccessToken.go index a39b0bbb6d4..e55223ad71d 100644 --- a/service/codecatalyst/api_op_CreateAccessToken.go +++ b/service/codecatalyst/api_op_CreateAccessToken.go @@ -15,8 +15,8 @@ import ( // You use PATs to access Amazon CodeCatalyst resources such as source repositories // from third-party applications like Git and integrated development environments // (IDEs). For more information, see Managing personal access tokens in Amazon -// CodeCatalyst -// (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html). +// CodeCatalyst (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html) +// . func (c *Client) CreateAccessToken(ctx context.Context, params *CreateAccessTokenInput, optFns ...func(*Options)) (*CreateAccessTokenOutput, error) { if params == nil { params = &CreateAccessTokenInput{} @@ -40,8 +40,8 @@ type CreateAccessTokenInput struct { Name *string // The date and time the personal access token expires, in coordinated universal - // time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . ExpiresTime *time.Time noSmithyDocumentSerde @@ -55,9 +55,8 @@ type CreateAccessTokenOutput struct { AccessTokenId *string // The date and time the personal access token expires, in coordinated universal - // time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). If not specified, the - // default is one year from creation. + // time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . If not specified, the default is one year from creation. // // This member is required. ExpiresTime *time.Time diff --git a/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go b/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go index 56c3ba92479..da7851f6d11 100644 --- a/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go +++ b/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go @@ -63,8 +63,8 @@ type CreateSourceRepositoryBranchOutput struct { HeadCommitId *string // The time the branch was last updated, in coordinated universal time (UTC) - // timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . LastUpdatedTime *time.Time // The name of the newly created branch. diff --git a/service/codecatalyst/api_op_DeleteAccessToken.go b/service/codecatalyst/api_op_DeleteAccessToken.go index b176423f2bc..c5c9f633652 100644 --- a/service/codecatalyst/api_op_DeleteAccessToken.go +++ b/service/codecatalyst/api_op_DeleteAccessToken.go @@ -29,7 +29,7 @@ func (c *Client) DeleteAccessToken(ctx context.Context, params *DeleteAccessToke type DeleteAccessTokenInput struct { // The ID of the personal access token to delete. You can find the IDs of all PATs - // associated with your user account by calling ListAccessTokens. + // associated with your user account by calling ListAccessTokens . // // This member is required. Id *string diff --git a/service/codecatalyst/api_op_DeleteDevEnvironment.go b/service/codecatalyst/api_op_DeleteDevEnvironment.go index 4ec89c5f622..d997f68871a 100644 --- a/service/codecatalyst/api_op_DeleteDevEnvironment.go +++ b/service/codecatalyst/api_op_DeleteDevEnvironment.go @@ -28,7 +28,7 @@ func (c *Client) DeleteDevEnvironment(ctx context.Context, params *DeleteDevEnvi type DeleteDevEnvironmentInput struct { // The system-generated unique ID of the Dev Environment you want to delete. To - // retrieve a list of Dev Environment IDs, use ListDevEnvironments. + // retrieve a list of Dev Environment IDs, use ListDevEnvironments . // // This member is required. Id *string diff --git a/service/codecatalyst/api_op_GetDevEnvironment.go b/service/codecatalyst/api_op_GetDevEnvironment.go index 799fa02b56b..c8ba62dd171 100644 --- a/service/codecatalyst/api_op_GetDevEnvironment.go +++ b/service/codecatalyst/api_op_GetDevEnvironment.go @@ -30,8 +30,9 @@ func (c *Client) GetDevEnvironment(ctx context.Context, params *GetDevEnvironmen type GetDevEnvironmentInput struct { - // The system-generated unique ID of the Dev Environment for which you want to view - // information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments. + // The system-generated unique ID of the Dev Environment for which you want to + // view information. To retrieve a list of Dev Environment IDs, use + // ListDevEnvironments . // // This member is required. Id *string @@ -73,8 +74,8 @@ type GetDevEnvironmentOutput struct { InstanceType types.InstanceType // The time when the Dev Environment was last updated, in coordinated universal - // time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. LastUpdatedTime *time.Time diff --git a/service/codecatalyst/api_op_GetSourceRepositoryCloneUrls.go b/service/codecatalyst/api_op_GetSourceRepositoryCloneUrls.go index 74762f8faed..b6fbe9af897 100644 --- a/service/codecatalyst/api_op_GetSourceRepositoryCloneUrls.go +++ b/service/codecatalyst/api_op_GetSourceRepositoryCloneUrls.go @@ -9,8 +9,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the URLs that can be used with a Git client to clone a -// source repository. +// Returns information about the URLs that can be used with a Git client to clone +// a source repository. func (c *Client) GetSourceRepositoryCloneUrls(ctx context.Context, params *GetSourceRepositoryCloneUrlsInput, optFns ...func(*Options)) (*GetSourceRepositoryCloneUrlsOutput, error) { if params == nil { params = &GetSourceRepositoryCloneUrlsInput{} diff --git a/service/codecatalyst/api_op_ListDevEnvironments.go b/service/codecatalyst/api_op_ListDevEnvironments.go index 6220e3ac560..111f96eb038 100644 --- a/service/codecatalyst/api_op_ListDevEnvironments.go +++ b/service/codecatalyst/api_op_ListDevEnvironments.go @@ -131,8 +131,8 @@ func (c *Client) addOperationListDevEnvironmentsMiddlewares(stack *middleware.St return nil } -// ListDevEnvironmentsAPIClient is a client that implements the ListDevEnvironments -// operation. +// ListDevEnvironmentsAPIClient is a client that implements the +// ListDevEnvironments operation. type ListDevEnvironmentsAPIClient interface { ListDevEnvironments(context.Context, *ListDevEnvironmentsInput, ...func(*Options)) (*ListDevEnvironmentsOutput, error) } diff --git a/service/codecatalyst/api_op_ListEventLogs.go b/service/codecatalyst/api_op_ListEventLogs.go index 08c8d30de94..18e690acb9a 100644 --- a/service/codecatalyst/api_op_ListEventLogs.go +++ b/service/codecatalyst/api_op_ListEventLogs.go @@ -32,8 +32,8 @@ func (c *Client) ListEventLogs(ctx context.Context, params *ListEventLogsInput, type ListEventLogsInput struct { // The time after which you do not want any events retrieved, in coordinated - // universal time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. EndTime *time.Time @@ -44,8 +44,8 @@ type ListEventLogsInput struct { SpaceName *string // The date and time when you want to start retrieving events, in coordinated - // universal time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. StartTime *time.Time diff --git a/service/codecatalyst/api_op_StopDevEnvironment.go b/service/codecatalyst/api_op_StopDevEnvironment.go index ed35290b6aa..71132e560ee 100644 --- a/service/codecatalyst/api_op_StopDevEnvironment.go +++ b/service/codecatalyst/api_op_StopDevEnvironment.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Pauses a specified Dev Environment and places it in a non-running state. Stopped -// Dev Environments do not consume compute minutes. +// Pauses a specified Dev Environment and places it in a non-running state. +// Stopped Dev Environments do not consume compute minutes. func (c *Client) StopDevEnvironment(ctx context.Context, params *StopDevEnvironmentInput, optFns ...func(*Options)) (*StopDevEnvironmentOutput, error) { if params == nil { params = &StopDevEnvironmentInput{} diff --git a/service/codecatalyst/api_op_StopDevEnvironmentSession.go b/service/codecatalyst/api_op_StopDevEnvironmentSession.go index 8b5a3a80414..4717e4bc93c 100644 --- a/service/codecatalyst/api_op_StopDevEnvironmentSession.go +++ b/service/codecatalyst/api_op_StopDevEnvironmentSession.go @@ -28,7 +28,7 @@ func (c *Client) StopDevEnvironmentSession(ctx context.Context, params *StopDevE type StopDevEnvironmentSessionInput struct { // The system-generated unique ID of the Dev Environment. To obtain this ID, use - // ListDevEnvironments. + // ListDevEnvironments . // // This member is required. Id *string @@ -39,7 +39,7 @@ type StopDevEnvironmentSessionInput struct { ProjectName *string // The system-generated unique ID of the Dev Environment session. This ID is - // returned by StartDevEnvironmentSession. + // returned by StartDevEnvironmentSession . // // This member is required. SessionId *string diff --git a/service/codecatalyst/api_op_UpdateDevEnvironment.go b/service/codecatalyst/api_op_UpdateDevEnvironment.go index 343966a84f9..06e40dff098 100644 --- a/service/codecatalyst/api_op_UpdateDevEnvironment.go +++ b/service/codecatalyst/api_op_UpdateDevEnvironment.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes one or more values for a Dev Environment. Updating certain values of the -// Dev Environment will cause a restart. +// Changes one or more values for a Dev Environment. Updating certain values of +// the Dev Environment will cause a restart. func (c *Client) UpdateDevEnvironment(ctx context.Context, params *UpdateDevEnvironmentInput, optFns ...func(*Options)) (*UpdateDevEnvironmentOutput, error) { if params == nil { params = &UpdateDevEnvironmentInput{} diff --git a/service/codecatalyst/doc.go b/service/codecatalyst/doc.go index a25269a6de1..ca2f46d0ccb 100644 --- a/service/codecatalyst/doc.go +++ b/service/codecatalyst/doc.go @@ -8,84 +8,48 @@ // operations and data types for Amazon CodeCatalyst. You can use the Amazon // CodeCatalyst API to work with the following objects. Dev Environments and the // Amazon Web Services Toolkits, by calling the following: -// -// * CreateAccessToken, -// which creates a personal access token (PAT) for the current user. -// -// * -// CreateDevEnvironment, which creates a Dev Environment, where you can quickly -// work on the code stored in the source repositories of your project. -// -// * -// CreateProject which creates a project in a specified space. -// -// * -// CreateSourceRepositoryBranch, which creates a branch in a specified repository -// where you can work on code. -// -// * DeleteDevEnvironment, which deletes a Dev -// Environment. -// -// * GetDevEnvironment, which returns information about a Dev -// Environment. -// -// * GetProject, which returns information about a project. -// -// * -// GetSourceRepositoryCloneUrls, which returns information about the URLs that can -// be used with a Git client to clone a source repository. -// -// * GetSubscription, -// which returns information about the Amazon Web Services account used for billing -// purposes and the billing plan for the space. -// -// * GetUserDetails, which returns -// information about a user in Amazon CodeCatalyst. -// -// * ListDevEnvironments, which -// retrives a list of Dev Environments in a project. -// -// * ListProjects, which -// retrieves a list of projects in a space. -// -// * ListSourceRepositories, which -// retrieves a list of source repositories in a project. -// -// * -// ListSourceRepositoryBranches, which retrieves a list of branches in a source -// repository. -// -// * ListSpaces, which retrieves a list of spaces. -// -// * -// StartDevEnvironment, which starts a specified Dev Environment and puts it into -// an active state. -// -// * StartDevEnvironmentSession, which starts a session to a -// specified Dev Environment. -// -// * StopDevEnvironment, which stops a specified Dev -// Environment and puts it into an stopped state. -// -// * StopDevEnvironmentSession, -// which stops a session for a specified Dev Environment. -// -// * UpdateDevEnvironment, -// which changes one or more values for a Dev Environment. -// -// * VerifySession, which -// verifies whether the calling user has a valid Amazon CodeCatalyst login and -// session. -// -// Security, activity, and resource management in Amazon CodeCatalyst, by -// calling the following: -// -// * DeleteAccessToken, which deletes a specified personal -// access token (PAT). -// -// * ListAccessTokens, which lists all personal access tokens -// (PATs) associated with a user. -// -// * ListEventLogs, which retrieves a list of -// events that occurred during a specified time period in a space. +// - CreateAccessToken , which creates a personal access token (PAT) for the +// current user. +// - CreateDevEnvironment , which creates a Dev Environment, where you can +// quickly work on the code stored in the source repositories of your project. +// - CreateProject which creates a project in a specified space. +// - CreateSourceRepositoryBranch , which creates a branch in a specified +// repository where you can work on code. +// - DeleteDevEnvironment , which deletes a Dev Environment. +// - GetDevEnvironment , which returns information about a Dev Environment. +// - GetProject , which returns information about a project. +// - GetSourceRepositoryCloneUrls , which returns information about the URLs that +// can be used with a Git client to clone a source repository. +// - GetSubscription , which returns information about the Amazon Web Services +// account used for billing purposes and the billing plan for the space. +// - GetUserDetails , which returns information about a user in Amazon +// CodeCatalyst. +// - ListDevEnvironments , which retrives a list of Dev Environments in a +// project. +// - ListProjects , which retrieves a list of projects in a space. +// - ListSourceRepositories , which retrieves a list of source repositories in a +// project. +// - ListSourceRepositoryBranches , which retrieves a list of branches in a +// source repository. +// - ListSpaces , which retrieves a list of spaces. +// - StartDevEnvironment , which starts a specified Dev Environment and puts it +// into an active state. +// - StartDevEnvironmentSession , which starts a session to a specified Dev +// Environment. +// - StopDevEnvironment , which stops a specified Dev Environment and puts it +// into an stopped state. +// - StopDevEnvironmentSession , which stops a session for a specified Dev +// Environment. +// - UpdateDevEnvironment , which changes one or more values for a Dev +// Environment. +// - VerifySession , which verifies whether the calling user has a valid Amazon +// CodeCatalyst login and session. +// +// Security, activity, and resource management in Amazon CodeCatalyst, by calling +// the following: +// - DeleteAccessToken , which deletes a specified personal access token (PAT). +// - ListAccessTokens , which lists all personal access tokens (PATs) associated +// with a user. +// - ListEventLogs , which retrieves a list of events that occurred during a +// specified time period in a space. package codecatalyst diff --git a/service/codecatalyst/types/enums.go b/service/codecatalyst/types/enums.go index fea245a2c49..5a49cdf22ff 100644 --- a/service/codecatalyst/types/enums.go +++ b/service/codecatalyst/types/enums.go @@ -100,9 +100,9 @@ const ( FilterKeyHasAccessTo FilterKey = "hasAccessTo" ) -// Values returns all known values for FilterKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FilterKey. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FilterKey) Values() []FilterKey { return []FilterKey{ "hasAccessTo", @@ -119,9 +119,9 @@ const ( InstanceTypeDevStandard1Xlarge InstanceType = "dev.standard1.xlarge" ) -// Values returns all known values for InstanceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InstanceType) Values() []InstanceType { return []InstanceType{ "dev.standard1.small", diff --git a/service/codecatalyst/types/errors.go b/service/codecatalyst/types/errors.go index 83d630d1b73..21e958916a5 100644 --- a/service/codecatalyst/types/errors.go +++ b/service/codecatalyst/types/errors.go @@ -63,8 +63,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was denied because the specified resource was not found. Verify that -// the spelling is correct and that you have access to the resource. +// The request was denied because the specified resource was not found. Verify +// that the spelling is correct and that you have access to the resource. type ResourceNotFoundException struct { Message *string diff --git a/service/codecatalyst/types/types.go b/service/codecatalyst/types/types.go index e64884be3b9..a076e1e8e88 100644 --- a/service/codecatalyst/types/types.go +++ b/service/codecatalyst/types/types.go @@ -21,8 +21,8 @@ type AccessTokenSummary struct { Name *string // The date and time when the personal access token will expire, in coordinated - // universal time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . ExpiresTime *time.Time noSmithyDocumentSerde @@ -67,8 +67,8 @@ type DevEnvironmentSessionConfiguration struct { // This member is required. SessionType DevEnvironmentSessionType - // Information about optional commands that will be run on the Dev Environment when - // the SSH session begins. + // Information about optional commands that will be run on the Dev Environment + // when the SSH session begins. ExecuteCommandSessionConfiguration *ExecuteCommandSessionConfiguration noSmithyDocumentSerde @@ -100,8 +100,8 @@ type DevEnvironmentSummary struct { InstanceType InstanceType // The time when the Dev Environment was last updated, in coordinated universal - // time (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. LastUpdatedTime *time.Time @@ -112,8 +112,8 @@ type DevEnvironmentSummary struct { // This member is required. PersistentStorage *PersistentStorage - // Information about the repositories that will be cloned into the Dev Environment. - // If no rvalue is specified, no repository is cloned. + // Information about the repositories that will be cloned into the Dev + // Environment. If no rvalue is specified, no repository is cloned. // // This member is required. Repositories []DevEnvironmentRepositorySummary @@ -173,8 +173,8 @@ type EventLogEntry struct { EventSource *string // The time the event took place, in coordinated universal time (UTC) timestamp - // format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. EventTime *time.Time @@ -237,8 +237,8 @@ type EventPayload struct { noSmithyDocumentSerde } -// Information about the commands that will be run on a Dev Environment when an SSH -// session begins. +// Information about the commands that will be run on a Dev Environment when an +// SSH session begins. type ExecuteCommandSessionConfiguration struct { // The command used at the beginning of the SSH session to a Dev Environment. @@ -287,11 +287,11 @@ type Ide struct { // (IDE) for a Dev Environment. type IdeConfiguration struct { - // The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and - // VSCode. + // The name of the IDE. Valid values include Cloud9 , IntelliJ , PyCharm , GoLand , + // and VSCode . Name *string - // A link to the IDE runtime image. This parameter is not required for VSCode. + // A link to the IDE runtime image. This parameter is not required for VSCode . Runtime *string noSmithyDocumentSerde @@ -301,8 +301,8 @@ type IdeConfiguration struct { type ListSourceRepositoriesItem struct { // The time the source repository was created, in coordinated universal time (UTC) - // timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. CreatedTime *time.Time @@ -313,8 +313,8 @@ type ListSourceRepositoriesItem struct { Id *string // The time the source repository was last updated, in coordinated universal time - // (UTC) timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . // // This member is required. LastUpdatedTime *time.Time @@ -334,13 +334,13 @@ type ListSourceRepositoriesItem struct { // branches. type ListSourceRepositoryBranchesItem struct { - // The commit ID of the tip of the branch at the time of the request, also known as - // the head commit. + // The commit ID of the tip of the branch at the time of the request, also known + // as the head commit. HeadCommitId *string // The time the branch was last updated, in coordinated universal time (UTC) - // timestamp format as specified in RFC 3339 - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . LastUpdatedTime *time.Time // The name of the branch. @@ -355,9 +355,9 @@ type ListSourceRepositoryBranchesItem struct { // Information about the persistent storage for a Dev Environment. type PersistentStorage struct { - // The size of the persistent storage in gigabytes (specifically GiB). Valid values - // for storage are based on memory sizes in 16GB increments. Valid values are 16, - // 32, and 64. + // The size of the persistent storage in gigabytes (specifically GiB). Valid + // values for storage are based on memory sizes in 16GB increments. Valid values + // are 16, 32, and 64. // // This member is required. SizeInGiB *int32 @@ -368,9 +368,9 @@ type PersistentStorage struct { // Information about the configuration of persistent storage for a Dev Environment. type PersistentStorageConfiguration struct { - // The size of the persistent storage in gigabytes (specifically GiB). Valid values - // for storage are based on memory sizes in 16GB increments. Valid values are 16, - // 32, and 64. + // The size of the persistent storage in gigabytes (specifically GiB). Valid + // values for storage are based on memory sizes in 16GB increments. Valid values + // are 16, 32, and 64. // // This member is required. SizeInGiB *int32 @@ -471,8 +471,8 @@ type UserIdentity struct { // This member is required. PrincipalId *string - // The role assigned to the user in a Amazon CodeCatalyst space or project when the - // event occurred. + // The role assigned to the user in a Amazon CodeCatalyst space or project when + // the event occurred. // // This member is required. UserType UserType diff --git a/service/codecommit/api_client.go b/service/codecommit/api_client.go index 2bff089046a..5f142eb55ad 100644 --- a/service/codecommit/api_client.go +++ b/service/codecommit/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codecommit/api_op_BatchDescribeMergeConflicts.go b/service/codecommit/api_op_BatchDescribeMergeConflicts.go index 537f9e5e8a2..6ee25802093 100644 --- a/service/codecommit/api_op_BatchDescribeMergeConflicts.go +++ b/service/codecommit/api_op_BatchDescribeMergeConflicts.go @@ -74,8 +74,8 @@ type BatchDescribeMergeConflictsInput struct { // The maximum number of merge hunks to include in the output. MaxMergeHunks *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -83,8 +83,8 @@ type BatchDescribeMergeConflictsInput struct { type BatchDescribeMergeConflictsOutput struct { - // A list of conflicts for each file, including the conflict metadata and the hunks - // of the differences between the files. + // A list of conflicts for each file, including the conflict metadata and the + // hunks of the differences between the files. // // This member is required. Conflicts []types.Conflict diff --git a/service/codecommit/api_op_BatchGetCommits.go b/service/codecommit/api_op_BatchGetCommits.go index 009d39b8f80..b3ea776224c 100644 --- a/service/codecommit/api_op_BatchGetCommits.go +++ b/service/codecommit/api_op_BatchGetCommits.go @@ -29,8 +29,8 @@ func (c *Client) BatchGetCommits(ctx context.Context, params *BatchGetCommitsInp type BatchGetCommitsInput struct { - // The full commit IDs of the commits to get information about. You must supply the - // full SHA IDs of each commit. You cannot use shortened SHA IDs. + // The full commit IDs of the commits to get information about. You must supply + // the full SHA IDs of each commit. You cannot use shortened SHA IDs. // // This member is required. CommitIds []string @@ -45,13 +45,13 @@ type BatchGetCommitsInput struct { type BatchGetCommitsOutput struct { - // An array of commit data type objects, each of which contains information about a - // specified commit. + // An array of commit data type objects, each of which contains information about + // a specified commit. Commits []types.Commit - // Returns any commit IDs for which information could not be found. For example, if - // one of the commit IDs was a shortened SHA ID or that commit was not found in the - // specified repository, the ID returns an error object with more information. + // Returns any commit IDs for which information could not be found. For example, + // if one of the commit IDs was a shortened SHA ID or that commit was not found in + // the specified repository, the ID returns an error object with more information. Errors []types.BatchGetCommitsError // Metadata pertaining to the operation's result. diff --git a/service/codecommit/api_op_CreateApprovalRuleTemplate.go b/service/codecommit/api_op_CreateApprovalRuleTemplate.go index 18343584401..4b9782b88f7 100644 --- a/service/codecommit/api_op_CreateApprovalRuleTemplate.go +++ b/service/codecommit/api_op_CreateApprovalRuleTemplate.go @@ -15,7 +15,7 @@ import ( // more repositories in your AWS account. When you associate a template with a // repository, AWS CodeCommit creates an approval rule that matches the conditions // of the template for all pull requests that meet the conditions of the template. -// For more information, see AssociateApprovalRuleTemplateWithRepository. +// For more information, see AssociateApprovalRuleTemplateWithRepository . func (c *Client) CreateApprovalRuleTemplate(ctx context.Context, params *CreateApprovalRuleTemplateInput, optFns ...func(*Options)) (*CreateApprovalRuleTemplateOutput, error) { if params == nil { params = &CreateApprovalRuleTemplateInput{} @@ -39,34 +39,23 @@ type CreateApprovalRuleTemplateInput struct { // references (branches) match those specified in the template. When you create the // content of the approval rule template, you can specify approvers in an approval // pool in one of two ways: - // - // * CodeCommitApprovers: This option only requires an - // AWS account and a resource. It can be used for both IAM users and federated - // access users whose name matches the provided resource name. This is a very - // powerful option that offers a great deal of flexibility. For example, if you - // specify the AWS account 123456789012 and Mary_Major, all of the following are - // counted as approvals coming from that user: - // - // * An IAM user in the account - // (arn:aws:iam::123456789012:user/Mary_Major) - // - // * A federated user identified in - // IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major) - // - // This - // option does not recognize an active session of someone assuming the role of - // CodeCommitReview with a role session name of Mary_Major - // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you - // include a wildcard (*Mary_Major). - // - // * Fully qualified ARN: This option allows you - // to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or - // role. - // - // For more information about IAM ARNs, wildcards, and formats, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // - CodeCommitApprovers: This option only requires an AWS account and a + // resource. It can be used for both IAM users and federated access users whose + // name matches the provided resource name. This is a very powerful option that + // offers a great deal of flexibility. For example, if you specify the AWS account + // 123456789012 and Mary_Major, all of the following are counted as approvals + // coming from that user: + // - An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major) + // - A federated user identified in IAM as Mary_Major + // (arn:aws:sts::123456789012:federated-user/Mary_Major) This option does not + // recognize an active session of someone assuming the role of CodeCommitReview + // with a role session name of Mary_Major + // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you + // include a wildcard (*Mary_Major). + // - Fully qualified ARN: This option allows you to specify the fully qualified + // Amazon Resource Name (ARN) of the IAM user or role. + // For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. ApprovalRuleTemplateContent *string diff --git a/service/codecommit/api_op_CreatePullRequestApprovalRule.go b/service/codecommit/api_op_CreatePullRequestApprovalRule.go index 226ec67a052..d3cac26b54f 100644 --- a/service/codecommit/api_op_CreatePullRequestApprovalRule.go +++ b/service/codecommit/api_op_CreatePullRequestApprovalRule.go @@ -34,35 +34,23 @@ type CreatePullRequestApprovalRuleInput struct { // information about approval pools, see the AWS CodeCommit User Guide. When you // create the content of the approval rule, you can specify approvers in an // approval pool in one of two ways: - // - // * CodeCommitApprovers: This option only - // requires an AWS account and a resource. It can be used for both IAM users and - // federated access users whose name matches the provided resource name. This is a - // very powerful option that offers a great deal of flexibility. For example, if - // you specify the AWS account 123456789012 and Mary_Major, all of the following - // would be counted as approvals coming from that user: - // - // * An IAM user in the - // account (arn:aws:iam::123456789012:user/Mary_Major) - // - // * A federated user - // identified in IAM as Mary_Major - // (arn:aws:sts::123456789012:federated-user/Mary_Major) - // - // This option does not - // recognize an active session of someone assuming the role of CodeCommitReview - // with a role session name of Mary_Major - // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you - // include a wildcard (*Mary_Major). - // - // * Fully qualified ARN: This option allows you - // to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or - // role. - // - // For more information about IAM ARNs, wildcards, and formats, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // - CodeCommitApprovers: This option only requires an AWS account and a + // resource. It can be used for both IAM users and federated access users whose + // name matches the provided resource name. This is a very powerful option that + // offers a great deal of flexibility. For example, if you specify the AWS account + // 123456789012 and Mary_Major, all of the following would be counted as approvals + // coming from that user: + // - An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major) + // - A federated user identified in IAM as Mary_Major + // (arn:aws:sts::123456789012:federated-user/Mary_Major) This option does not + // recognize an active session of someone assuming the role of CodeCommitReview + // with a role session name of Mary_Major + // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you + // include a wildcard (*Mary_Major). + // - Fully qualified ARN: This option allows you to specify the fully qualified + // Amazon Resource Name (ARN) of the IAM user or role. + // For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. ApprovalRuleContent *string diff --git a/service/codecommit/api_op_CreateRepository.go b/service/codecommit/api_op_CreateRepository.go index 066f3ab97c0..d4044a1aa90 100644 --- a/service/codecommit/api_op_CreateRepository.go +++ b/service/codecommit/api_op_CreateRepository.go @@ -30,8 +30,8 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI // Represents the input of a create repository operation. type CreateRepositoryInput struct { - // The name of the new repository to be created. The repository name must be unique - // across the calling AWS account. Repository names are limited to 100 + // The name of the new repository to be created. The repository name must be + // unique across the calling AWS account. Repository names are limited to 100 // alphanumeric, dash, and underscore characters, and cannot include certain // characters. For more information about the limits on repository names, see // Limits (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) in diff --git a/service/codecommit/api_op_DeleteBranch.go b/service/codecommit/api_op_DeleteBranch.go index 54cb0b79961..f58f49196b7 100644 --- a/service/codecommit/api_op_DeleteBranch.go +++ b/service/codecommit/api_op_DeleteBranch.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a branch from a repository, unless that branch is the default branch for -// the repository. +// Deletes a branch from a repository, unless that branch is the default branch +// for the repository. func (c *Client) DeleteBranch(ctx context.Context, params *DeleteBranchInput, optFns ...func(*Options)) (*DeleteBranchOutput, error) { if params == nil { params = &DeleteBranchInput{} @@ -47,8 +47,8 @@ type DeleteBranchInput struct { // Represents the output of a delete branch operation. type DeleteBranchOutput struct { - // Information about the branch deleted by the operation, including the branch name - // and the commit ID that was the tip of the branch. + // Information about the branch deleted by the operation, including the branch + // name and the commit ID that was the tip of the branch. DeletedBranch *types.BranchInfo // Metadata pertaining to the operation's result. diff --git a/service/codecommit/api_op_DeleteCommentContent.go b/service/codecommit/api_op_DeleteCommentContent.go index 13bcbc475bf..28764660fd0 100644 --- a/service/codecommit/api_op_DeleteCommentContent.go +++ b/service/codecommit/api_op_DeleteCommentContent.go @@ -31,7 +31,7 @@ func (c *Client) DeleteCommentContent(ctx context.Context, params *DeleteComment type DeleteCommentContentInput struct { // The unique, system-generated ID of the comment. To get this ID, use - // GetCommentsForComparedCommit or GetCommentsForPullRequest. + // GetCommentsForComparedCommit or GetCommentsForPullRequest . // // This member is required. CommentId *string diff --git a/service/codecommit/api_op_DeleteFile.go b/service/codecommit/api_op_DeleteFile.go index 0071a148458..f9d262490a4 100644 --- a/service/codecommit/api_op_DeleteFile.go +++ b/service/codecommit/api_op_DeleteFile.go @@ -35,9 +35,9 @@ type DeleteFileInput struct { // This member is required. BranchName *string - // The fully qualified path to the file that to be deleted, including the full name - // and extension of that file. For example, /examples/file.md is a fully qualified - // path to a file named file.md in a folder named examples. + // The fully qualified path to the file that to be deleted, including the full + // name and extension of that file. For example, /examples/file.md is a fully + // qualified path to a file named file.md in a folder named examples. // // This member is required. FilePath *string diff --git a/service/codecommit/api_op_DescribeMergeConflicts.go b/service/codecommit/api_op_DescribeMergeConflicts.go index 24c11b72efb..27a59e3dbcf 100644 --- a/service/codecommit/api_op_DescribeMergeConflicts.go +++ b/service/codecommit/api_op_DescribeMergeConflicts.go @@ -76,8 +76,8 @@ type DescribeMergeConflictsInput struct { // The maximum number of merge hunks to include in the output. MaxMergeHunks *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_DescribePullRequestEvents.go b/service/codecommit/api_op_DescribePullRequestEvents.go index cb9f56f0983..39014c0d0e4 100644 --- a/service/codecommit/api_op_DescribePullRequestEvents.go +++ b/service/codecommit/api_op_DescribePullRequestEvents.go @@ -31,7 +31,7 @@ func (c *Client) DescribePullRequestEvents(ctx context.Context, params *Describe type DescribePullRequestEventsInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string @@ -46,8 +46,8 @@ type DescribePullRequestEventsInput struct { // be returned in a result. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string // Optional. The pull request event type about which you want to return diff --git a/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go b/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go index d1e2a9aea44..ceed9f453cf 100644 --- a/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go +++ b/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go @@ -36,7 +36,7 @@ type EvaluatePullRequestApprovalRulesInput struct { PullRequestId *string // The system-generated ID for the pull request revision. To retrieve the most - // recent revision ID for a pull request, use GetPullRequest. + // recent revision ID for a pull request, use GetPullRequest . // // This member is required. RevisionId *string diff --git a/service/codecommit/api_op_GetComment.go b/service/codecommit/api_op_GetComment.go index ad1d09ca1eb..272e7d2d3cf 100644 --- a/service/codecommit/api_op_GetComment.go +++ b/service/codecommit/api_op_GetComment.go @@ -33,7 +33,7 @@ func (c *Client) GetComment(ctx context.Context, params *GetCommentInput, optFns type GetCommentInput struct { // The unique, system-generated ID of the comment. To get this ID, use - // GetCommentsForComparedCommit or GetCommentsForPullRequest. + // GetCommentsForComparedCommit or GetCommentsForPullRequest . // // This member is required. CommentId *string diff --git a/service/codecommit/api_op_GetCommentReactions.go b/service/codecommit/api_op_GetCommentReactions.go index 33b6564dcc1..2a7e616ff51 100644 --- a/service/codecommit/api_op_GetCommentReactions.go +++ b/service/codecommit/api_op_GetCommentReactions.go @@ -40,8 +40,8 @@ type GetCommentReactionsInput struct { // The default is the same as the allowed maximum, 1,000. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string // Optional. The Amazon Resource Name (ARN) of the user or identity for which you @@ -131,8 +131,8 @@ func (c *Client) addOperationGetCommentReactionsMiddlewares(stack *middleware.St return nil } -// GetCommentReactionsAPIClient is a client that implements the GetCommentReactions -// operation. +// GetCommentReactionsAPIClient is a client that implements the +// GetCommentReactions operation. type GetCommentReactionsAPIClient interface { GetCommentReactions(context.Context, *GetCommentReactionsInput, ...func(*Options)) (*GetCommentReactionsOutput, error) } diff --git a/service/codecommit/api_op_GetCommentsForPullRequest.go b/service/codecommit/api_op_GetCommentsForPullRequest.go index 16dabe7aa0d..6592917843b 100644 --- a/service/codecommit/api_op_GetCommentsForPullRequest.go +++ b/service/codecommit/api_op_GetCommentsForPullRequest.go @@ -33,7 +33,7 @@ func (c *Client) GetCommentsForPullRequest(ctx context.Context, params *GetComme type GetCommentsForPullRequestInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string @@ -51,8 +51,8 @@ type GetCommentsForPullRequestInput struct { // request. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string // The name of the repository that contains the pull request. diff --git a/service/codecommit/api_op_GetDifferences.go b/service/codecommit/api_op_GetDifferences.go index c592a057740..fda143591d4 100644 --- a/service/codecommit/api_op_GetDifferences.go +++ b/service/codecommit/api_op_GetDifferences.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the differences in a valid commit specifier (such as a -// branch, tag, HEAD, commit ID, or other fully qualified reference). Results can +// Returns information about the differences in a valid commit specifier (such as +// a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can // be limited to a specified path. func (c *Client) GetDifferences(ctx context.Context, params *GetDifferencesInput, optFns ...func(*Options)) (*GetDifferencesOutput, error) { if params == nil { @@ -52,7 +52,7 @@ type GetDifferencesInput struct { // commit (for example, the full commit ID). Optional. If not specified, all // changes before the afterCommitSpecifier value are shown. If you do not use // beforeCommitSpecifier in your request, consider limiting the results with - // maxResults. + // maxResults . BeforeCommitSpecifier *string // The file path in which to check for differences. Limits the results to this @@ -63,8 +63,8 @@ type GetDifferencesInput struct { // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_GetFile.go b/service/codecommit/api_op_GetFile.go index 5145e9c47b4..c3ad8f005bf 100644 --- a/service/codecommit/api_op_GetFile.go +++ b/service/codecommit/api_op_GetFile.go @@ -67,10 +67,10 @@ type GetFileOutput struct { // This member is required. FileContent []byte - // The extrapolated file mode permissions of the blob. Valid values include strings - // such as EXECUTABLE and not numeric values. The file mode permissions returned by - // this API are not the standard file mode permission values, such as 100644, but - // rather extrapolated values. See the supported return values. + // The extrapolated file mode permissions of the blob. Valid values include + // strings such as EXECUTABLE and not numeric values. The file mode permissions + // returned by this API are not the standard file mode permission values, such as + // 100644, but rather extrapolated values. See the supported return values. // // This member is required. FileMode types.FileModeTypeEnum diff --git a/service/codecommit/api_op_GetMergeConflicts.go b/service/codecommit/api_op_GetMergeConflicts.go index 4147294acf4..34fe8908ecf 100644 --- a/service/codecommit/api_op_GetMergeConflicts.go +++ b/service/codecommit/api_op_GetMergeConflicts.go @@ -68,8 +68,8 @@ type GetMergeConflictsInput struct { // The maximum number of files to include in the output. MaxConflictFiles *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -77,8 +77,8 @@ type GetMergeConflictsInput struct { type GetMergeConflictsOutput struct { - // A list of metadata for any conflicting files. If the specified merge strategy is - // FAST_FORWARD_MERGE, this list is always empty. + // A list of metadata for any conflicting files. If the specified merge strategy + // is FAST_FORWARD_MERGE, this list is always empty. // // This member is required. ConflictMetadataList []types.ConflictMetadata diff --git a/service/codecommit/api_op_GetMergeOptions.go b/service/codecommit/api_op_GetMergeOptions.go index 7198487b0e0..46385238052 100644 --- a/service/codecommit/api_op_GetMergeOptions.go +++ b/service/codecommit/api_op_GetMergeOptions.go @@ -37,8 +37,8 @@ type GetMergeOptionsInput struct { // This member is required. DestinationCommitSpecifier *string - // The name of the repository that contains the commits about which you want to get - // merge options. + // The name of the repository that contains the commits about which you want to + // get merge options. // // This member is required. RepositoryName *string diff --git a/service/codecommit/api_op_GetPullRequest.go b/service/codecommit/api_op_GetPullRequest.go index d3fef7468bf..bba5fbd532b 100644 --- a/service/codecommit/api_op_GetPullRequest.go +++ b/service/codecommit/api_op_GetPullRequest.go @@ -30,7 +30,7 @@ func (c *Client) GetPullRequest(ctx context.Context, params *GetPullRequestInput type GetPullRequestInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_GetPullRequestOverrideState.go b/service/codecommit/api_op_GetPullRequestOverrideState.go index 2aa6314ea17..2402ef2cd55 100644 --- a/service/codecommit/api_op_GetPullRequestOverrideState.go +++ b/service/codecommit/api_op_GetPullRequestOverrideState.go @@ -38,7 +38,7 @@ type GetPullRequestOverrideStateInput struct { PullRequestId *string // The system-generated ID of the revision for the pull request. To retrieve the - // most recent revision ID, use GetPullRequest. + // most recent revision ID, use GetPullRequest . // // This member is required. RevisionId *string diff --git a/service/codecommit/api_op_ListApprovalRuleTemplates.go b/service/codecommit/api_op_ListApprovalRuleTemplates.go index b72adf0f04e..87d98d9bc43 100644 --- a/service/codecommit/api_op_ListApprovalRuleTemplates.go +++ b/service/codecommit/api_op_ListApprovalRuleTemplates.go @@ -34,8 +34,8 @@ type ListApprovalRuleTemplatesInput struct { // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go b/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go index 2c473317a5f..b05cef0278b 100644 --- a/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go +++ b/service/codecommit/api_op_ListAssociatedApprovalRuleTemplatesForRepository.go @@ -39,8 +39,8 @@ type ListAssociatedApprovalRuleTemplatesForRepositoryInput struct { // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_ListPullRequests.go b/service/codecommit/api_op_ListPullRequests.go index be207dbf202..68fddfafda8 100644 --- a/service/codecommit/api_op_ListPullRequests.go +++ b/service/codecommit/api_op_ListPullRequests.go @@ -44,8 +44,8 @@ type ListPullRequestsInput struct { // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string // Optional. The status of the pull request. If used, this refines the results to diff --git a/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go b/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go index a34bf068741..5ae868f1a0e 100644 --- a/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go +++ b/service/codecommit/api_op_ListRepositoriesForApprovalRuleTemplate.go @@ -38,8 +38,8 @@ type ListRepositoriesForApprovalRuleTemplateInput struct { // A non-zero, non-negative integer used to limit the number of returned results. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -124,16 +124,16 @@ func (c *Client) addOperationListRepositoriesForApprovalRuleTemplateMiddlewares( return nil } -// ListRepositoriesForApprovalRuleTemplateAPIClient is a client that implements the -// ListRepositoriesForApprovalRuleTemplate operation. +// ListRepositoriesForApprovalRuleTemplateAPIClient is a client that implements +// the ListRepositoriesForApprovalRuleTemplate operation. type ListRepositoriesForApprovalRuleTemplateAPIClient interface { ListRepositoriesForApprovalRuleTemplate(context.Context, *ListRepositoriesForApprovalRuleTemplateInput, ...func(*Options)) (*ListRepositoriesForApprovalRuleTemplateOutput, error) } var _ ListRepositoriesForApprovalRuleTemplateAPIClient = (*Client)(nil) -// ListRepositoriesForApprovalRuleTemplatePaginatorOptions is the paginator options -// for ListRepositoriesForApprovalRuleTemplate +// ListRepositoriesForApprovalRuleTemplatePaginatorOptions is the paginator +// options for ListRepositoriesForApprovalRuleTemplate type ListRepositoriesForApprovalRuleTemplatePaginatorOptions struct { // A non-zero, non-negative integer used to limit the number of returned results. Limit int32 diff --git a/service/codecommit/api_op_ListTagsForResource.go b/service/codecommit/api_op_ListTagsForResource.go index f2f527354fd..89aee880e0e 100644 --- a/service/codecommit/api_op_ListTagsForResource.go +++ b/service/codecommit/api_op_ListTagsForResource.go @@ -12,8 +12,7 @@ import ( // Gets information about AWS tags for a specified Amazon Resource Name (ARN) in // AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit -// Resources and Operations -// (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) +// Resources and Operations (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) // in the AWS CodeCommit User Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type ListTagsForResourceInput struct { // This member is required. ResourceArn *string - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_MergePullRequestByFastForward.go b/service/codecommit/api_op_MergePullRequestByFastForward.go index ddf6aa3e910..25d4ca817a8 100644 --- a/service/codecommit/api_op_MergePullRequestByFastForward.go +++ b/service/codecommit/api_op_MergePullRequestByFastForward.go @@ -33,7 +33,7 @@ func (c *Client) MergePullRequestByFastForward(ctx context.Context, params *Merg type MergePullRequestByFastForwardInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_MergePullRequestBySquash.go b/service/codecommit/api_op_MergePullRequestBySquash.go index 03d9b256f99..a1f0335caff 100644 --- a/service/codecommit/api_op_MergePullRequestBySquash.go +++ b/service/codecommit/api_op_MergePullRequestBySquash.go @@ -32,7 +32,7 @@ func (c *Client) MergePullRequestBySquash(ctx context.Context, params *MergePull type MergePullRequestBySquashInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_MergePullRequestByThreeWay.go b/service/codecommit/api_op_MergePullRequestByThreeWay.go index c5ae87309af..0bf39fff914 100644 --- a/service/codecommit/api_op_MergePullRequestByThreeWay.go +++ b/service/codecommit/api_op_MergePullRequestByThreeWay.go @@ -33,7 +33,7 @@ func (c *Client) MergePullRequestByThreeWay(ctx context.Context, params *MergePu type MergePullRequestByThreeWayInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_OverridePullRequestApprovalRules.go b/service/codecommit/api_op_OverridePullRequestApprovalRules.go index 8d171889c0c..4a87e6b357a 100644 --- a/service/codecommit/api_op_OverridePullRequestApprovalRules.go +++ b/service/codecommit/api_op_OverridePullRequestApprovalRules.go @@ -38,7 +38,7 @@ type OverridePullRequestApprovalRulesInput struct { OverrideStatus types.OverrideStatus // The system-generated ID of the pull request for which you want to override all - // approval rule requirements. To get this information, use GetPullRequest. + // approval rule requirements. To get this information, use GetPullRequest . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_PostCommentForPullRequest.go b/service/codecommit/api_op_PostCommentForPullRequest.go index 1b9399029a6..5b4ed587f74 100644 --- a/service/codecommit/api_op_PostCommentForPullRequest.go +++ b/service/codecommit/api_op_PostCommentForPullRequest.go @@ -30,8 +30,8 @@ func (c *Client) PostCommentForPullRequest(ctx context.Context, params *PostComm type PostCommentForPullRequestInput struct { - // The full commit ID of the commit in the source branch that is the current tip of - // the branch for the pull request when you post the comment. + // The full commit ID of the commit in the source branch that is the current tip + // of the branch for the pull request when you post the comment. // // This member is required. AfterCommitId *string @@ -48,7 +48,7 @@ type PostCommentForPullRequestInput struct { Content *string // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_PostCommentReply.go b/service/codecommit/api_op_PostCommentReply.go index ca9fa82c5c7..4dba0479d98 100644 --- a/service/codecommit/api_op_PostCommentReply.go +++ b/service/codecommit/api_op_PostCommentReply.go @@ -37,7 +37,7 @@ type PostCommentReplyInput struct { Content *string // The system-generated ID of the comment to which you want to reply. To get this - // ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. + // ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest . // // This member is required. InReplyTo *string diff --git a/service/codecommit/api_op_PutCommentReaction.go b/service/codecommit/api_op_PutCommentReaction.go index d8bdcaaacbe..52b0f0ce6a7 100644 --- a/service/codecommit/api_op_PutCommentReaction.go +++ b/service/codecommit/api_op_PutCommentReaction.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or updates a reaction to a specified comment for the user whose identity is -// used to make the request. You can only add or update a reaction for yourself. +// Adds or updates a reaction to a specified comment for the user whose identity +// is used to make the request. You can only add or update a reaction for yourself. // You cannot add, modify, or delete a reaction for another user. func (c *Client) PutCommentReaction(ctx context.Context, params *PutCommentReactionInput, optFns ...func(*Options)) (*PutCommentReactionOutput, error) { if params == nil { @@ -38,8 +38,8 @@ type PutCommentReactionInput struct { // The emoji reaction you want to add or update. To remove a reaction, provide a // value of blank or null. You can also provide the value of none. For information // about emoji reaction values supported in AWS CodeCommit, see the AWS CodeCommit - // User Guide - // (https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#emoji-reaction-table). + // User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#emoji-reaction-table) + // . // // This member is required. ReactionValue *string diff --git a/service/codecommit/api_op_PutFile.go b/service/codecommit/api_op_PutFile.go index f72ed3dbd9e..1a337f7bdc8 100644 --- a/service/codecommit/api_op_PutFile.go +++ b/service/codecommit/api_op_PutFile.go @@ -90,8 +90,8 @@ type PutFileOutput struct { // This member is required. CommitId *string - // The full SHA-1 pointer of the tree information for the commit that contains this - // file change. + // The full SHA-1 pointer of the tree information for the commit that contains + // this file change. // // This member is required. TreeId *string diff --git a/service/codecommit/api_op_TagResource.go b/service/codecommit/api_op_TagResource.go index 261d1933d6b..d1ba0e3132d 100644 --- a/service/codecommit/api_op_TagResource.go +++ b/service/codecommit/api_op_TagResource.go @@ -11,8 +11,7 @@ import ( ) // Adds or updates tags for a resource in AWS CodeCommit. For a list of valid -// resources in AWS CodeCommit, see CodeCommit Resources and Operations -// (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) +// resources in AWS CodeCommit, see CodeCommit Resources and Operations (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) // in the AWS CodeCommit User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/codecommit/api_op_TestRepositoryTriggers.go b/service/codecommit/api_op_TestRepositoryTriggers.go index 88f403d43ee..d2267f4dfd3 100644 --- a/service/codecommit/api_op_TestRepositoryTriggers.go +++ b/service/codecommit/api_op_TestRepositoryTriggers.go @@ -52,8 +52,8 @@ type TestRepositoryTriggersOutput struct { // triggers that could not be tested, separated by commas. FailedExecutions []types.RepositoryTriggerExecutionFailure - // The list of triggers that were successfully tested. This list provides the names - // of the triggers that were successfully tested, separated by commas. + // The list of triggers that were successfully tested. This list provides the + // names of the triggers that were successfully tested, separated by commas. SuccessfulExecutions []string // Metadata pertaining to the operation's result. diff --git a/service/codecommit/api_op_UntagResource.go b/service/codecommit/api_op_UntagResource.go index 0bd4ef8db57..1fb9eefa2a7 100644 --- a/service/codecommit/api_op_UntagResource.go +++ b/service/codecommit/api_op_UntagResource.go @@ -11,8 +11,7 @@ import ( ) // Removes tags for a resource in AWS CodeCommit. For a list of valid resources in -// AWS CodeCommit, see CodeCommit Resources and Operations -// (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) +// AWS CodeCommit, see CodeCommit Resources and Operations (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) // in the AWS CodeCommit User Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go b/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go index e807d14132b..c40fbef2e37 100644 --- a/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go +++ b/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go @@ -44,7 +44,7 @@ type UpdateApprovalRuleTemplateContentInput struct { NewRuleContent *string // The SHA-256 hash signature for the content of the approval rule. You can - // retrieve this information by using GetPullRequest. + // retrieve this information by using GetPullRequest . ExistingRuleContentSha256 *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_UpdateComment.go b/service/codecommit/api_op_UpdateComment.go index edb285d9d59..c8c85cf8f08 100644 --- a/service/codecommit/api_op_UpdateComment.go +++ b/service/codecommit/api_op_UpdateComment.go @@ -30,7 +30,7 @@ func (c *Client) UpdateComment(ctx context.Context, params *UpdateCommentInput, type UpdateCommentInput struct { // The system-generated ID of the comment you want to update. To get this ID, use - // GetCommentsForComparedCommit or GetCommentsForPullRequest. + // GetCommentsForComparedCommit or GetCommentsForPullRequest . // // This member is required. CommentId *string diff --git a/service/codecommit/api_op_UpdateDefaultBranch.go b/service/codecommit/api_op_UpdateDefaultBranch.go index 1aa272c4390..aa8fd985ac3 100644 --- a/service/codecommit/api_op_UpdateDefaultBranch.go +++ b/service/codecommit/api_op_UpdateDefaultBranch.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets or changes the default branch name for the specified repository. If you use -// this operation to change the default branch name to the current default branch -// name, a success message is returned even though the default branch did not -// change. +// Sets or changes the default branch name for the specified repository. If you +// use this operation to change the default branch name to the current default +// branch name, a success message is returned even though the default branch did +// not change. func (c *Client) UpdateDefaultBranch(ctx context.Context, params *UpdateDefaultBranchInput, optFns ...func(*Options)) (*UpdateDefaultBranchOutput, error) { if params == nil { params = &UpdateDefaultBranchInput{} diff --git a/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go b/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go index 468a7717db2..0db1b450889 100644 --- a/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go +++ b/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go @@ -37,36 +37,25 @@ type UpdatePullRequestApprovalRuleContentInput struct { ApprovalRuleName *string // The updated content for the approval rule. When you update the content of the - // approval rule, you can specify approvers in an approval pool in one of two - // ways: + // approval rule, you can specify approvers in an approval pool in one of two ways: // - // * CodeCommitApprovers: This option only requires an AWS account and a - // resource. It can be used for both IAM users and federated access users whose - // name matches the provided resource name. This is a very powerful option that - // offers a great deal of flexibility. For example, if you specify the AWS account - // 123456789012 and Mary_Major, all of the following are counted as approvals - // coming from that user: - // - // * An IAM user in the account - // (arn:aws:iam::123456789012:user/Mary_Major) - // - // * A federated user identified in - // IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major) - // - // This - // option does not recognize an active session of someone assuming the role of - // CodeCommitReview with a role session name of Mary_Major - // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you - // include a wildcard (*Mary_Major). - // - // * Fully qualified ARN: This option allows you - // to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or - // role. - // - // For more information about IAM ARNs, wildcards, and formats, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // - CodeCommitApprovers: This option only requires an AWS account and a + // resource. It can be used for both IAM users and federated access users whose + // name matches the provided resource name. This is a very powerful option that + // offers a great deal of flexibility. For example, if you specify the AWS account + // 123456789012 and Mary_Major, all of the following are counted as approvals + // coming from that user: + // - An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major) + // - A federated user identified in IAM as Mary_Major + // (arn:aws:sts::123456789012:federated-user/Mary_Major) This option does not + // recognize an active session of someone assuming the role of CodeCommitReview + // with a role session name of Mary_Major + // (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you + // include a wildcard (*Mary_Major). + // - Fully qualified ARN: This option allows you to specify the fully qualified + // Amazon Resource Name (ARN) of the IAM user or role. + // For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. NewRuleContent *string @@ -77,7 +66,7 @@ type UpdatePullRequestApprovalRuleContentInput struct { PullRequestId *string // The SHA-256 hash signature for the content of the approval rule. You can - // retrieve this information by using GetPullRequest. + // retrieve this information by using GetPullRequest . ExistingRuleContentSha256 *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_UpdatePullRequestDescription.go b/service/codecommit/api_op_UpdatePullRequestDescription.go index 6ecab9d1ff6..3b7bf12b80d 100644 --- a/service/codecommit/api_op_UpdatePullRequestDescription.go +++ b/service/codecommit/api_op_UpdatePullRequestDescription.go @@ -36,7 +36,7 @@ type UpdatePullRequestDescriptionInput struct { Description *string // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_UpdatePullRequestStatus.go b/service/codecommit/api_op_UpdatePullRequestStatus.go index de90c15215b..7af34dc165c 100644 --- a/service/codecommit/api_op_UpdatePullRequestStatus.go +++ b/service/codecommit/api_op_UpdatePullRequestStatus.go @@ -30,13 +30,13 @@ func (c *Client) UpdatePullRequestStatus(ctx context.Context, params *UpdatePull type UpdatePullRequestStatusInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string // The status of the pull request. The only valid operations are to update the - // status from OPEN to OPEN, OPEN to CLOSED or from CLOSED to CLOSED. + // status from OPEN to OPEN , OPEN to CLOSED or from CLOSED to CLOSED . // // This member is required. PullRequestStatus types.PullRequestStatusEnum diff --git a/service/codecommit/api_op_UpdatePullRequestTitle.go b/service/codecommit/api_op_UpdatePullRequestTitle.go index e500115bb76..e1e4e15b470 100644 --- a/service/codecommit/api_op_UpdatePullRequestTitle.go +++ b/service/codecommit/api_op_UpdatePullRequestTitle.go @@ -30,7 +30,7 @@ func (c *Client) UpdatePullRequestTitle(ctx context.Context, params *UpdatePullR type UpdatePullRequestTitleInput struct { // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests. + // ListPullRequests . // // This member is required. PullRequestId *string diff --git a/service/codecommit/doc.go b/service/codecommit/doc.go index 9ee5b92f2b5..38e0744fb0f 100644 --- a/service/codecommit/doc.go +++ b/service/codecommit/doc.go @@ -3,308 +3,183 @@ // Package codecommit provides the API client, operations, and parameter types for // AWS CodeCommit. // -// AWS CodeCommit This is the AWS CodeCommit API Reference. This reference provides -// descriptions of the operations and data types for AWS CodeCommit API along with -// usage examples. You can use the AWS CodeCommit API to work with the following -// objects: Repositories, by calling the following: -// -// * BatchGetRepositories, which -// returns information about one or more repositories associated with your AWS -// account. -// -// * CreateRepository, which creates an AWS CodeCommit repository. -// -// * -// DeleteRepository, which deletes an AWS CodeCommit repository. -// -// * GetRepository, -// which returns information about a specified repository. -// -// * ListRepositories, -// which lists all AWS CodeCommit repositories associated with your AWS account. -// -// * -// UpdateRepositoryDescription, which sets or updates the description of the -// repository. -// -// * UpdateRepositoryName, which changes the name of the repository. -// If you change the name of a repository, no other users of that repository can -// access it until you send them the new HTTPS or SSH URL to use. -// -// Branches, by -// calling the following: -// -// * CreateBranch, which creates a branch in a specified -// repository. -// -// * DeleteBranch, which deletes the specified branch in a repository -// unless it is the default branch. -// -// * GetBranch, which returns information about a -// specified branch. -// -// * ListBranches, which lists all branches for a specified -// repository. -// -// * UpdateDefaultBranch, which changes the default branch for a -// repository. +// AWS CodeCommit This is the AWS CodeCommit API Reference. This reference +// provides descriptions of the operations and data types for AWS CodeCommit API +// along with usage examples. You can use the AWS CodeCommit API to work with the +// following objects: Repositories, by calling the following: +// - BatchGetRepositories , which returns information about one or more +// repositories associated with your AWS account. +// - CreateRepository , which creates an AWS CodeCommit repository. +// - DeleteRepository , which deletes an AWS CodeCommit repository. +// - GetRepository , which returns information about a specified repository. +// - ListRepositories , which lists all AWS CodeCommit repositories associated +// with your AWS account. +// - UpdateRepositoryDescription , which sets or updates the description of the +// repository. +// - UpdateRepositoryName , which changes the name of the repository. If you +// change the name of a repository, no other users of that repository can access it +// until you send them the new HTTPS or SSH URL to use. +// +// Branches, by calling the following: +// - CreateBranch , which creates a branch in a specified repository. +// - DeleteBranch , which deletes the specified branch in a repository unless it +// is the default branch. +// - GetBranch , which returns information about a specified branch. +// - ListBranches , which lists all branches for a specified repository. +// - UpdateDefaultBranch , which changes the default branch for a repository. // // Files, by calling the following: -// -// * 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 in 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 single file in a specified repository and -// branch. +// - 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 in 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 single file in a specified repository and +// branch. // // Commits, by calling the following: -// -// * BatchGetCommits, which returns -// information about one or more commits in a repository. -// -// * CreateCommit, which -// creates a commit for changes to a repository. -// -// * GetCommit, which returns -// information about a commit, including commit messages and author and committer -// information. -// -// * GetDifferences, which returns information about the differences -// in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other -// fully qualified reference). +// - BatchGetCommits , which returns information about one or more commits in a +// repository. +// - CreateCommit , which creates a commit for changes to a repository. +// - GetCommit , which returns information about a commit, including commit +// messages and author and committer information. +// - GetDifferences , which returns information about the differences in a valid +// commit specifier (such as a branch, tag, HEAD, commit ID, or other fully +// qualified reference). // // Merges, by calling the following: -// -// * -// BatchDescribeMergeConflicts, which returns information about conflicts in a -// merge between commits in a repository. -// -// * CreateUnreferencedMergeCommit, which -// creates an unreferenced commit between two branches or commits for the purpose -// of comparing them and identifying any potential conflicts. -// -// * -// DescribeMergeConflicts, which returns information about merge conflicts between -// the base, source, and destination versions of a file in a potential merge. -// -// * -// GetMergeCommit, which returns information about the merge between a source and -// destination commit. -// -// * GetMergeConflicts, which returns information about merge -// conflicts between the source and destination branch in a pull request. -// -// * -// GetMergeOptions, which returns information about the available merge options -// between two branches or commit specifiers. -// -// * MergeBranchesByFastForward, which -// merges two branches using the fast-forward merge option. -// -// * -// MergeBranchesBySquash, which merges two branches using the squash merge -// option. -// -// * MergeBranchesByThreeWay, which merges two branches using the -// three-way merge option. +// - BatchDescribeMergeConflicts , which returns information about conflicts in a +// merge between commits in a repository. +// - CreateUnreferencedMergeCommit , which creates an unreferenced commit between +// two branches or commits for the purpose of comparing them and identifying any +// potential conflicts. +// - DescribeMergeConflicts , which returns information about merge conflicts +// between the base, source, and destination versions of a file in a potential +// merge. +// - GetMergeCommit , which returns information about the merge between a source +// and destination commit. +// - GetMergeConflicts , which returns information about merge conflicts between +// the source and destination branch in a pull request. +// - GetMergeOptions , which returns information about the available merge +// options between two branches or commit specifiers. +// - MergeBranchesByFastForward , which merges two branches using the +// fast-forward merge option. +// - MergeBranchesBySquash , which merges two branches using the squash merge +// option. +// - MergeBranchesByThreeWay , which merges two branches using the three-way +// merge option. // // Pull requests, by calling the following: -// -// * -// CreatePullRequest, which creates a pull request in a specified repository. -// -// * -// CreatePullRequestApprovalRule, which creates an approval rule for a specified -// pull request. -// -// * DeletePullRequestApprovalRule, which deletes an approval rule -// for a specified pull request. -// -// * DescribePullRequestEvents, which returns -// information about one or more pull request events. -// -// * -// EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met -// all the conditions specified in its associated approval rules. -// -// * -// GetCommentsForPullRequest, which returns information about comments on a -// specified pull request. -// -// * GetPullRequest, which returns information about a -// specified pull request. -// -// * GetPullRequestApprovalStates, which returns -// information about the approval states for a specified pull request. -// -// * -// GetPullRequestOverrideState, which returns information about whether approval -// rules have been set aside (overriden) for a pull request, and if so, the Amazon -// Resource Name (ARN) of the user or identity that overrode the rules and their -// requirements for the pull request. -// -// * ListPullRequests, which lists all pull -// requests for a repository. -// -// * MergePullRequestByFastForward, which merges the -// source destination branch of a pull request into the specified destination -// branch for that pull request using the fast-forward merge option. -// -// * -// MergePullRequestBySquash, which merges the source destination branch of a pull -// request into the specified destination branch for that pull request using the -// squash merge option. -// -// * MergePullRequestByThreeWay. which merges the source -// destination branch of a pull request into the specified destination branch for -// that pull request using the three-way merge option. -// -// * -// OverridePullRequestApprovalRules, which sets aside all approval rule -// requirements for a pull request. -// -// * PostCommentForPullRequest, which posts a -// comment to a pull request at the specified line, file, or request. -// -// * -// UpdatePullRequestApprovalRuleContent, which updates the structure of an approval -// rule for a pull request. -// -// * UpdatePullRequestApprovalState, which updates the -// state of an approval on a pull request. -// -// * UpdatePullRequestDescription, which -// updates the description of a pull request. -// -// * UpdatePullRequestStatus, which -// updates the status of a pull request. -// -// * UpdatePullRequestTitle, which updates -// the title of a pull request. -// -// Approval rule templates, by calling the +// - CreatePullRequest , which creates a pull request in a specified repository. +// - CreatePullRequestApprovalRule , which creates an approval rule for a +// specified pull request. +// - DeletePullRequestApprovalRule , which deletes an approval rule for a +// specified pull request. +// - DescribePullRequestEvents , which returns information about one or more pull +// request events. +// - EvaluatePullRequestApprovalRules , which evaluates whether a pull request +// has met all the conditions specified in its associated approval rules. +// - GetCommentsForPullRequest , which returns information about comments on a +// specified pull request. +// - GetPullRequest , which returns information about a specified pull request. +// - GetPullRequestApprovalStates , which returns information about the approval +// states for a specified pull request. +// - GetPullRequestOverrideState , which returns information about whether +// approval rules have been set aside (overriden) for a pull request, and if so, +// the Amazon Resource Name (ARN) of the user or identity that overrode the rules +// and their requirements for the pull request. +// - ListPullRequests , which lists all pull requests for a repository. +// - MergePullRequestByFastForward , which merges the source destination branch +// of a pull request into the specified destination branch for that pull request +// using the fast-forward merge option. +// - MergePullRequestBySquash , which merges the source destination branch of a +// pull request into the specified destination branch for that pull request using +// the squash merge option. +// - MergePullRequestByThreeWay . which merges the source destination branch of a +// pull request into the specified destination branch for that pull request using +// the three-way merge option. +// - OverridePullRequestApprovalRules , which sets aside all approval rule +// requirements for a pull request. +// - PostCommentForPullRequest , which posts a comment to a pull request at the +// specified line, file, or request. +// - UpdatePullRequestApprovalRuleContent , which updates the structure of an +// approval rule for a pull request. +// - UpdatePullRequestApprovalState , which updates the state of an approval on a +// pull request. +// - UpdatePullRequestDescription , which updates the description of a pull +// request. +// - UpdatePullRequestStatus , which updates the status of a pull request. +// - UpdatePullRequestTitle , which updates the title of a pull request. +// +// Approval rule templates, by calling the following: +// - AssociateApprovalRuleTemplateWithRepository , which associates a template +// with a specified repository. After the template is associated with a repository, +// AWS CodeCommit creates approval rules that match the template conditions on +// every pull request created in the specified repository. +// - BatchAssociateApprovalRuleTemplateWithRepositories , which associates a +// template with one or more specified repositories. After the template is +// associated with a repository, AWS CodeCommit creates approval rules that match +// the template conditions on every pull request created in the specified +// repositories. +// - BatchDisassociateApprovalRuleTemplateFromRepositories , which removes the +// association between a template and specified repositories so that approval rules +// based on the template are not automatically created when pull requests are +// created in those repositories. +// - CreateApprovalRuleTemplate , which creates a template for approval rules +// that can then be associated with one or more repositories in your AWS account. +// - DeleteApprovalRuleTemplate , which deletes the specified template. It does +// not remove approval rules on pull requests already created with the template. +// - DisassociateApprovalRuleTemplateFromRepository , which removes the +// association between a template and a repository so that approval rules based on +// the template are not automatically created when pull requests are created in the +// specified repository. +// - GetApprovalRuleTemplate , which returns information about an approval rule +// template. +// - ListApprovalRuleTemplates , which lists all approval rule templates in the +// AWS Region in your AWS account. +// - ListAssociatedApprovalRuleTemplatesForRepository , which lists all approval +// rule templates that are associated with a specified repository. +// - ListRepositoriesForApprovalRuleTemplate , which lists all repositories +// associated with the specified approval rule template. +// - UpdateApprovalRuleTemplateDescription , which updates the description of an +// approval rule template. +// - UpdateApprovalRuleTemplateName , which updates the name of an approval rule +// template. +// - UpdateApprovalRuleTemplateContent , which updates the content of an approval +// rule template. +// +// Comments in a repository, by calling the following: +// - DeleteCommentContent , which deletes the content of a comment on a commit in +// a repository. +// - GetComment , which returns information about a comment on a commit. +// - GetCommentReactions , which returns information about emoji reactions to +// comments. +// - GetCommentsForComparedCommit , which returns information about comments on +// the comparison between two commit specifiers in a repository. +// - PostCommentForComparedCommit , which creates a comment on the comparison +// between two commit specifiers in a repository. +// - PostCommentReply , which creates a reply to a comment. +// - PutCommentReaction , which creates or updates an emoji reaction to a +// comment. +// - UpdateComment , which updates the content of a comment on a commit in a +// repository. +// +// Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the // following: -// -// * AssociateApprovalRuleTemplateWithRepository, which associates a -// template with a specified repository. After the template is associated with a -// repository, AWS CodeCommit creates approval rules that match the template -// conditions on every pull request created in the specified repository. -// -// * -// BatchAssociateApprovalRuleTemplateWithRepositories, which associates a template -// with one or more specified repositories. After the template is associated with a -// repository, AWS CodeCommit creates approval rules that match the template -// conditions on every pull request created in the specified repositories. -// -// * -// BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the -// association between a template and specified repositories so that approval rules -// based on the template are not automatically created when pull requests are -// created in those repositories. -// -// * CreateApprovalRuleTemplate, which creates a -// template for approval rules that can then be associated with one or more -// repositories in your AWS account. -// -// * DeleteApprovalRuleTemplate, which deletes -// the specified template. It does not remove approval rules on pull requests -// already created with the template. -// -// * -// DisassociateApprovalRuleTemplateFromRepository, which removes the association -// between a template and a repository so that approval rules based on the template -// are not automatically created when pull requests are created in the specified -// repository. -// -// * GetApprovalRuleTemplate, which returns information about an -// approval rule template. -// -// * ListApprovalRuleTemplates, which lists all approval -// rule templates in the AWS Region in your AWS account. -// -// * -// ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule -// templates that are associated with a specified repository. -// -// * -// ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated -// with the specified approval rule template. -// -// * -// UpdateApprovalRuleTemplateDescription, which updates the description of an -// approval rule template. -// -// * UpdateApprovalRuleTemplateName, which updates the -// name of an approval rule template. -// -// * UpdateApprovalRuleTemplateContent, which -// updates the content of an approval rule template. -// -// Comments in a repository, by -// calling the following: -// -// * DeleteCommentContent, which deletes the content of a -// comment on a commit in a repository. -// -// * GetComment, which returns information -// about a comment on a commit. -// -// * GetCommentReactions, which returns information -// about emoji reactions to comments. -// -// * GetCommentsForComparedCommit, which -// returns information about comments on the comparison between two commit -// specifiers in a repository. -// -// * PostCommentForComparedCommit, which creates a -// comment on the comparison between two commit specifiers in a repository. -// -// * -// PostCommentReply, which creates a reply to a comment. -// -// * PutCommentReaction, -// which creates or updates an emoji reaction to a comment. -// -// * UpdateComment, which -// updates the content of a comment on a commit in a repository. -// -// Tags used to tag -// resources in AWS CodeCommit (not Git tags), by calling the following: -// -// * -// ListTagsForResource, which gets information about AWS tags for a specified -// Amazon Resource Name (ARN) in AWS CodeCommit. -// -// * TagResource, which adds or -// updates tags for a resource in AWS CodeCommit. -// -// * UntagResource, which removes -// tags for a resource in AWS CodeCommit. +// - ListTagsForResource , which gets information about AWS tags for a specified +// Amazon Resource Name (ARN) in AWS CodeCommit. +// - TagResource , which adds or updates tags for a resource in AWS CodeCommit. +// - UntagResource , which removes tags for a resource in AWS CodeCommit. // // Triggers, by calling the following: -// -// * -// GetRepositoryTriggers, which returns information about triggers configured for a -// repository. -// -// * PutRepositoryTriggers, which replaces all triggers for a -// repository and can be used to create or delete triggers. -// -// * -// TestRepositoryTriggers, which tests the functionality of a repository trigger by -// sending data to the trigger target. -// -// For information about how to use AWS -// CodeCommit, see the AWS CodeCommit User Guide -// (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html). +// - GetRepositoryTriggers , which returns information about triggers configured +// for a repository. +// - PutRepositoryTriggers , which replaces all triggers for a repository and can +// be used to create or delete triggers. +// - TestRepositoryTriggers , which tests the functionality of a repository +// trigger by sending data to the trigger target. +// +// For information about how to use AWS CodeCommit, see the AWS CodeCommit User +// Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) . package codecommit diff --git a/service/codecommit/types/enums.go b/service/codecommit/types/enums.go index 15b94dfa403..83773ec5828 100644 --- a/service/codecommit/types/enums.go +++ b/service/codecommit/types/enums.go @@ -151,9 +151,9 @@ const ( OrderEnumDescending OrderEnum = "descending" ) -// Values returns all known values for OrderEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderEnum. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OrderEnum) Values() []OrderEnum { return []OrderEnum{ "ascending", @@ -219,8 +219,8 @@ const ( PullRequestStatusEnumClosed PullRequestStatusEnum = "CLOSED" ) -// Values returns all known values for PullRequestStatusEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PullRequestStatusEnum. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PullRequestStatusEnum) Values() []PullRequestStatusEnum { return []PullRequestStatusEnum{ diff --git a/service/codecommit/types/errors.go b/service/codecommit/types/errors.go index ed7ffbf95a6..fc065662e6a 100644 --- a/service/codecommit/types/errors.go +++ b/service/codecommit/types/errors.go @@ -33,8 +33,8 @@ func (e *ActorDoesNotExistException) ErrorCode() string { } func (e *ActorDoesNotExistException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The content for the approval rule is empty. You must provide some content for an -// approval rule. The content cannot be null. +// The content for the approval rule is empty. You must provide some content for +// an approval rule. The content cannot be null. type ApprovalRuleContentRequiredException struct { Message *string @@ -478,7 +478,7 @@ func (e *BranchNameExistsException) ErrorFault() smithy.ErrorFault { return smit // The specified branch name is not valid because it is a tag name. Enter the name // of a branch in the repository. For a list of valid branch names, use -// ListBranches. +// ListBranches . type BranchNameIsTagNameException struct { Message *string @@ -530,8 +530,9 @@ func (e *BranchNameRequiredException) ErrorCode() string { } func (e *BranchNameRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The approval rule cannot be deleted from the pull request because it was created -// by an approval rule template and applied to the pull request automatically. +// The approval rule cannot be deleted from the pull request because it was +// created by an approval rule template and applied to the pull request +// automatically. type CannotDeleteApprovalRuleFromTemplateException struct { Message *string @@ -559,8 +560,9 @@ func (e *CannotDeleteApprovalRuleFromTemplateException) ErrorFault() smithy.Erro return smithy.FaultClient } -// The approval rule cannot be modified for the pull request because it was created -// by an approval rule template and applied to the pull request automatically. +// The approval rule cannot be modified for the pull request because it was +// created by an approval rule template and applied to the pull request +// automatically. type CannotModifyApprovalRuleFromTemplateException struct { Message *string @@ -1031,8 +1033,8 @@ func (e *DefaultBranchCannotBeDeletedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A file cannot be added to the repository because the specified path name has the -// same name as a file that already exists in this repository. Either provide a +// A file cannot be added to the repository because the specified path name has +// the same name as a file that already exists in this repository. Either provide a // different name for the file, or specify a different path for the file. type DirectoryNameConflictsWithFileNameException struct { Message *string @@ -1225,8 +1227,8 @@ func (e *FileContentAndSourceFileSpecifiedException) ErrorFault() smithy.ErrorFa return smithy.FaultClient } -// The file cannot be added because it is empty. Empty files cannot be added to the -// repository with this API. +// The file cannot be added because it is empty. Empty files cannot be added to +// the repository with this API. type FileContentRequiredException struct { Message *string @@ -1252,9 +1254,9 @@ func (e *FileContentRequiredException) ErrorCode() string { } func (e *FileContentRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The file cannot be added because it is too large. The maximum file size is 6 MB, -// and the combined file content change size is 7 MB. Consider making these changes -// using a Git client. +// The file cannot be added because it is too large. The maximum file size is 6 +// MB, and the combined file content change size is 7 MB. Consider making these +// changes using a Git client. type FileContentSizeLimitExceededException struct { Message *string @@ -1363,9 +1365,9 @@ func (e *FileModeRequiredException) ErrorCode() string { } func (e *FileModeRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A file cannot be added to the repository because the specified file name has the -// same name as a directory in this repository. Either provide another name for the -// file, or add the file in a directory that does not match the file name. +// A file cannot be added to the repository because the specified file name has +// the same name as a directory in this repository. Either provide another name for +// the file, or add the file in a directory that does not match the file name. type FileNameConflictsWithDirectoryNameException struct { Message *string @@ -1424,8 +1426,8 @@ func (e *FilePathConflictsWithSubmodulePathException) ErrorFault() smithy.ErrorF } // The specified file exceeds the file size limit for AWS CodeCommit. For more -// information about limits in AWS CodeCommit, see AWS CodeCommit User Guide -// (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html). +// information about limits in AWS CodeCommit, see AWS CodeCommit User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) +// . type FileTooLargeException struct { Message *string @@ -1650,8 +1652,8 @@ func (e *InvalidApprovalRuleTemplateContentException) ErrorFault() smithy.ErrorF // The description for the approval rule template is not valid because it exceeds // the maximum characters allowed for a description. For more information about -// limits in AWS CodeCommit, see AWS CodeCommit User Guide -// (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html). +// limits in AWS CodeCommit, see AWS CodeCommit User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) +// . type InvalidApprovalRuleTemplateDescriptionException struct { Message *string @@ -1681,8 +1683,8 @@ func (e *InvalidApprovalRuleTemplateDescriptionException) ErrorFault() smithy.Er // The name of the approval rule template is not valid. Template names must be // between 1 and 100 valid characters in length. For more information about limits -// in AWS CodeCommit, see AWS CodeCommit User Guide -// (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html). +// in AWS CodeCommit, see AWS CodeCommit User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) +// . type InvalidApprovalRuleTemplateNameException struct { Message *string @@ -2171,7 +2173,7 @@ func (e *InvalidFileLocationException) ErrorCode() string { func (e *InvalidFileLocationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified file mode permission is not valid. For a list of valid file mode -// permissions, see PutFile. +// permissions, see PutFile . type InvalidFileModeException struct { Message *string @@ -2381,9 +2383,9 @@ func (e *InvalidOverrideStatusException) ErrorCode() string { } func (e *InvalidOverrideStatusException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The parent commit ID is not valid. The commit ID cannot be empty, and must match -// the head commit ID for the branch of the repository where you want to add or -// update a file. +// The parent commit ID is not valid. The commit ID cannot be empty, and must +// match the head commit ID for the branch of the repository where you want to add +// or update a file. type InvalidParentCommitIdException struct { Message *string @@ -2490,7 +2492,7 @@ func (e *InvalidPullRequestIdException) ErrorCode() string { } func (e *InvalidPullRequestIdException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The pull request status is not valid. The only valid values are OPEN and CLOSED. +// The pull request status is not valid. The only valid values are OPEN and CLOSED . type InvalidPullRequestStatusException struct { Message *string @@ -2517,7 +2519,7 @@ func (e *InvalidPullRequestStatusException) ErrorCode() string { func (e *InvalidPullRequestStatusException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The pull request status update is not valid. The only valid update is from OPEN -// to CLOSED. +// to CLOSED . type InvalidPullRequestStatusUpdateException struct { Message *string @@ -2572,8 +2574,8 @@ func (e *InvalidReactionUserArnException) ErrorCode() string { func (e *InvalidReactionUserArnException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The value of the reaction is not valid. For more information, see the AWS -// CodeCommit User Guide -// (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html). +// CodeCommit User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) +// . type InvalidReactionValueException struct { Message *string @@ -2601,9 +2603,8 @@ func (e *InvalidReactionValueException) ErrorFault() smithy.ErrorFault { return // The specified reference name format is not valid. Reference names must conform // to the Git references format (for example, refs/heads/master). For more -// information, see Git Internals - Git References -// (https://git-scm.com/book/en/v2/Git-Internals-Git-References) or consult your -// Git documentation. +// information, see Git Internals - Git References (https://git-scm.com/book/en/v2/Git-Internals-Git-References) +// or consult your Git documentation. type InvalidReferenceNameException struct { Message *string @@ -2944,8 +2945,7 @@ func (e *InvalidRepositoryTriggerRegionException) ErrorFault() smithy.ErrorFault } // The value for the resource ARN is not valid. For more information about -// resources in AWS CodeCommit, see CodeCommit Resources and Operations -// (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) +// resources in AWS CodeCommit, see CodeCommit Resources and Operations (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) // in the AWS CodeCommit User Guide. type InvalidResourceArnException struct { Message *string @@ -3267,8 +3267,8 @@ func (e *InvalidTitleException) ErrorCode() string { } func (e *InvalidTitleException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The pull request cannot be merged automatically into the destination branch. You -// must manually merge the branches and resolve any conflicts. +// The pull request cannot be merged automatically into the destination branch. +// You must manually merge the branches and resolve any conflicts. type ManualMergeRequiredException struct { Message *string @@ -3464,9 +3464,9 @@ func (e *MaximumNumberOfApprovalsExceededException) ErrorFault() smithy.ErrorFau return smithy.FaultClient } -// You cannot create the pull request because the repository has too many open pull -// requests. The maximum number of open pull requests for a repository is 1,000. -// Close one or more open pull requests, and then try again. +// You cannot create the pull request because the repository has too many open +// pull requests. The maximum number of open pull requests for a repository is +// 1,000. Close one or more open pull requests, and then try again. type MaximumOpenPullRequestsExceededException struct { Message *string @@ -3857,7 +3857,7 @@ func (e *ParentCommitDoesNotExistException) ErrorFault() smithy.ErrorFault { ret // The file could not be added because the provided parent commit ID is not the // current tip of the specified branch. To view the full commit ID of the current -// head of the branch, use GetBranch. +// head of the branch, use GetBranch . type ParentCommitIdOutdatedException struct { Message *string @@ -4155,8 +4155,8 @@ func (e *PutFileEntryConflictException) ErrorCode() string { } func (e *PutFileEntryConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The number of reactions has been exceeded. Reactions are limited to one reaction -// per user for each individual comment ID. +// The number of reactions has been exceeded. Reactions are limited to one +// reaction per user for each individual comment ID. type ReactionLimitExceededException struct { Message *string @@ -4472,8 +4472,9 @@ func (e *RepositoryNamesRequiredException) ErrorCode() string { } func (e *RepositoryNamesRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The repository does not contain any pull requests with that pull request ID. Use -// GetPullRequest to verify the correct repository name for the pull request ID. +// The repository does not contain any pull requests with that pull request ID. +// Use GetPullRequest to verify the correct repository name for the pull request +// ID. type RepositoryNotAssociatedWithPullRequestException struct { Message *string @@ -4645,8 +4646,7 @@ func (e *RepositoryTriggersListRequiredException) ErrorFault() smithy.ErrorFault // A valid Amazon Resource Name (ARN) for an AWS CodeCommit resource is required. // For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and -// Operations -// (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) +// Operations (https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats) // in the AWS CodeCommit User Guide. type ResourceArnRequiredException struct { Message *string @@ -4753,8 +4753,8 @@ func (e *RevisionNotCurrentException) ErrorCode() string { } func (e *RevisionNotCurrentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The file was not added or updated because the content of the file is exactly the -// same as the content of that file in the repository and branch that you +// The file was not added or updated because the content of the file is exactly +// the same as the content of that file in the repository and branch that you // specified. type SameFileContentException struct { Message *string diff --git a/service/codecommit/types/types.go b/service/codecommit/types/types.go index eafde7587f9..e49d84af670 100644 --- a/service/codecommit/types/types.go +++ b/service/codecommit/types/types.go @@ -203,16 +203,10 @@ type BlobMetadata struct { BlobId *string // The file mode permissions of the blob. File mode permission codes include: - // - // * - // 100644 indicates read/write - // - // * 100755 indicates read/write/execute - // - // * 160000 - // indicates a submodule - // - // * 120000 indicates a symlink + // - 100644 indicates read/write + // - 100755 indicates read/write/execute + // - 160000 indicates a submodule + // - 120000 indicates a symlink Mode *string // The path to the blob and associated file name, if any. @@ -318,10 +312,10 @@ type CommentsForPullRequest struct { // commit. BeforeBlobId *string - // The full commit ID of the commit that was the tip of the destination branch when - // the pull request was created. This commit is superceded by the after commit in - // the source branch when and if you merge the source branch into the destination - // branch. + // The full commit ID of the commit that was the tip of the destination branch + // when the pull request was created. This commit is superceded by the after commit + // in the source branch when and if you merge the source branch into the + // destination branch. BeforeCommitId *string // An array of comment objects. Each comment object contains information about a @@ -360,8 +354,8 @@ type Commit struct { // the committer. Information includes the date in timestamp format with GMT // offset, the name of the committer, and the email address for the committer, as // configured in Git. For more information about the difference between an author - // and a committer in Git, see Viewing the Commit History - // (http://git-scm.com/book/ch2-3.html) in Pro Git by Scott Chacon and Ben Straub. + // and a committer in Git, see Viewing the Commit History (http://git-scm.com/book/ch2-3.html) + // in Pro Git by Scott Chacon and Ben Straub. Committer *UserInfo // The commit message associated with the specified commit. @@ -409,8 +403,8 @@ type ConflictMetadata struct { // The file sizes of the file in the source, destination, and base of the merge. FileSizes *FileSizes - // A boolean value (true or false) indicating whether the file is binary or textual - // in the source, destination, and base of the merge. + // A boolean value (true or false) indicating whether the file is binary or + // textual in the source, destination, and base of the merge. IsBinaryFile *IsBinaryFile // Whether an add, modify, or delete operation caused the conflict between the @@ -460,12 +454,12 @@ type DeleteFileEntry struct { // Returns information about a set of differences for a commit specifier. type Difference struct { - // Information about an afterBlob data type object, including the ID, the file mode - // permission code, and the path. + // Information about an afterBlob data type object, including the ID, the file + // mode permission code, and the path. AfterBlob *BlobMetadata - // Information about a beforeBlob data type object, including the ID, the file mode - // permission code, and the path. + // Information about a beforeBlob data type object, including the ID, the file + // mode permission code, and the path. BeforeBlob *BlobMetadata // Whether the change type of the difference is an addition (A), deletion (D), or @@ -488,8 +482,8 @@ type Evaluation struct { // Whether the state of the pull request is approved. Approved bool - // Whether the approval rule requirements for the pull request have been overridden - // and no longer need to be met. + // Whether the approval rule requirements for the pull request have been + // overridden and no longer need to be met. Overridden bool noSmithyDocumentSerde @@ -578,8 +572,8 @@ type Folder struct { noSmithyDocumentSerde } -// Information about whether a file is binary or textual in a merge or pull request -// operation. +// Information about whether a file is binary or textual in a merge or pull +// request operation. type IsBinaryFile struct { // The binary or non-binary status of a file in the base of a merge or pull @@ -702,8 +696,8 @@ type ObjectTypes struct { noSmithyDocumentSerde } -// Returns information about the template that created the approval rule for a pull -// request. +// Returns information about the template that created the approval rule for a +// pull request. type OriginApprovalRuleTemplate struct { // The ID of the template that created the approval rule. @@ -744,8 +738,8 @@ type PullRequest struct { // The system-generated ID of the pull request. PullRequestId *string - // The status of the pull request. Pull request status can only change from OPEN to - // CLOSED. + // The status of the pull request. Pull request status can only change from OPEN + // to CLOSED . PullRequestStatus PullRequestStatusEnum // The targets of the pull request, including the source branch and destination @@ -875,8 +869,8 @@ type PullRequestStatusChangedEventMetadata struct { // Returns information about a pull request target. type PullRequestTarget struct { - // The full commit ID that is the tip of the destination branch. This is the commit - // where the pull request was or will be merged. + // The full commit ID that is the tip of the destination branch. This is the + // commit where the pull request was or will be merged. DestinationCommit *string // The branch of the repository where the pull request changes are merged. Also @@ -891,8 +885,8 @@ type PullRequestTarget struct { // been made. MergeMetadata *MergeMetadata - // The name of the repository that contains the pull request source and destination - // branches. + // The name of the repository that contains the pull request source and + // destination branches. RepositoryName *string // The full commit ID of the tip of the source branch used to create the pull @@ -922,8 +916,8 @@ type PutFileEntry struct { // EXECUTABLE and NORMAL. FileMode FileModeTypeEnum - // The name and full path of the file that contains the changes you want to make as - // part of the commit, if you are not providing the file content directly. + // The name and full path of the file that contains the changes you want to make + // as part of the commit, if you are not providing the file content directly. SourceFile *SourceFileSpecifier noSmithyDocumentSerde @@ -939,16 +933,17 @@ type ReactionForComment struct { // comment. ReactionUsers []string - // A numerical count of users who reacted with the specified emoji whose identities - // have been subsequently deleted from IAM. While these IAM users or roles no - // longer exist, the reactions might still appear in total reaction counts. + // A numerical count of users who reacted with the specified emoji whose + // identities have been subsequently deleted from IAM. While these IAM users or + // roles no longer exist, the reactions might still appear in total reaction + // counts. ReactionsFromDeletedUsersCount *int32 noSmithyDocumentSerde } -// Information about the values for reactions to a comment. AWS CodeCommit supports -// a limited set of reactions. +// Information about the values for reactions to a comment. AWS CodeCommit +// supports a limited set of reactions. type ReactionValueFormats struct { // The Emoji Version 1.0 graphic of the reaction. These graphics are interpreted @@ -965,8 +960,8 @@ type ReactionValueFormats struct { noSmithyDocumentSerde } -// Information about a replacement content entry in the conflict of a merge or pull -// request operation. +// Information about a replacement content entry in the conflict of a merge or +// pull request operation. type ReplaceContentEntry struct { // The path of the conflicting file. diff --git a/service/codedeploy/api_client.go b/service/codedeploy/api_client.go index 5b974534ec7..35429c50bbe 100644 --- a/service/codedeploy/api_client.go +++ b/service/codedeploy/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go b/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go index a5ab1e66853..75cd4b2d770 100644 --- a/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go +++ b/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go @@ -35,8 +35,8 @@ type AddTagsToOnPremisesInstancesInput struct { // This member is required. InstanceNames []string - // The tag key-value pairs to add to the on-premises instances. Keys and values are - // both required. Keys cannot be null or empty strings. Value-only tags are not + // The tag key-value pairs to add to the on-premises instances. Keys and values + // are both required. Keys cannot be null or empty strings. Value-only tags are not // allowed. // // This member is required. diff --git a/service/codedeploy/api_op_BatchGetDeploymentTargets.go b/service/codedeploy/api_op_BatchGetDeploymentTargets.go index 407c0a0a583..a38da64ff71 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentTargets.go +++ b/service/codedeploy/api_op_BatchGetDeploymentTargets.go @@ -13,21 +13,14 @@ import ( // Returns an array of one or more targets associated with a deployment. This // method works with all compute types and should be used instead of the deprecated -// BatchGetDeploymentInstances. The maximum number of targets that can be returned +// BatchGetDeploymentInstances . The maximum number of targets that can be returned // is 25. The type of targets returned depends on the deployment's compute platform // or deployment method: -// -// * EC2/On-premises: Information about Amazon EC2 instance -// targets. -// -// * Lambda: Information about Lambda functions targets. -// -// * Amazon ECS: -// Information about Amazon ECS service targets. -// -// * CloudFormation: Information -// about targets of blue/green deployments initiated by a CloudFormation stack -// update. +// - EC2/On-premises: Information about Amazon EC2 instance targets. +// - Lambda: Information about Lambda functions targets. +// - Amazon ECS: Information about Amazon ECS service targets. +// - CloudFormation: Information about targets of blue/green deployments +// initiated by a CloudFormation stack update. func (c *Client) BatchGetDeploymentTargets(ctx context.Context, params *BatchGetDeploymentTargetsInput, optFns ...func(*Options)) (*BatchGetDeploymentTargetsOutput, error) { if params == nil { params = &BatchGetDeploymentTargetsInput{} @@ -48,25 +41,19 @@ type BatchGetDeploymentTargetsInput struct { // The unique ID of a deployment. DeploymentId *string - // The unique IDs of the deployment targets. The compute platform of the deployment - // determines the type of the targets and their formats. The maximum number of - // deployment target IDs you can specify is 25. - // - // * For deployments that use the - // EC2/On-premises compute platform, the target IDs are Amazon EC2 or on-premises - // instances IDs, and their target type is instanceTarget. - // - // * For deployments that - // use the Lambda compute platform, the target IDs are the names of Lambda - // functions, and their target type is instanceTarget. - // - // * For deployments that use - // the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters - // and services specified using the format :. Their target type is ecsTarget. - // - // * - // For deployments that are deployed with CloudFormation, the target IDs are - // CloudFormation stack IDs. Their target type is cloudFormationTarget. + // The unique IDs of the deployment targets. The compute platform of the + // deployment determines the type of the targets and their formats. The maximum + // number of deployment target IDs you can specify is 25. + // - For deployments that use the EC2/On-premises compute platform, the target + // IDs are Amazon EC2 or on-premises instances IDs, and their target type is + // instanceTarget . + // - For deployments that use the Lambda compute platform, the target IDs are + // the names of Lambda functions, and their target type is instanceTarget . + // - For deployments that use the Amazon ECS compute platform, the target IDs + // are pairs of Amazon ECS clusters and services specified using the format : . + // Their target type is ecsTarget . + // - For deployments that are deployed with CloudFormation, the target IDs are + // CloudFormation stack IDs. Their target type is cloudFormationTarget . TargetIds []string noSmithyDocumentSerde @@ -77,18 +64,12 @@ type BatchGetDeploymentTargetsOutput struct { // A list of target objects for a deployment. Each target object contains details // about the target, such as its status and lifecycle events. The type of the // target objects depends on the deployment' compute platform. - // - // * EC2/On-premises: - // Each target object is an Amazon EC2 or on-premises instance. - // - // * Lambda: The - // target object is a specific version of an Lambda function. - // - // * Amazon ECS: The - // target object is an Amazon ECS service. - // - // * CloudFormation: The target object is - // an CloudFormation blue/green deployment. + // - EC2/On-premises: Each target object is an Amazon EC2 or on-premises + // instance. + // - Lambda: The target object is a specific version of an Lambda function. + // - Amazon ECS: The target object is an Amazon ECS service. + // - CloudFormation: The target object is an CloudFormation blue/green + // deployment. DeploymentTargets []types.DeploymentTarget // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_CreateApplication.go b/service/codedeploy/api_op_CreateApplication.go index abf200f6a7b..89b1fffd9b0 100644 --- a/service/codedeploy/api_op_CreateApplication.go +++ b/service/codedeploy/api_op_CreateApplication.go @@ -30,13 +30,13 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio // Represents the input of a CreateApplication operation. type CreateApplicationInput struct { - // The name of the application. This name must be unique with the applicable IAM or - // Amazon Web Services account. + // The name of the application. This name must be unique with the applicable IAM + // or Amazon Web Services account. // // This member is required. ApplicationName *string - // The destination platform type for the deployment (Lambda, Server, or ECS). + // The destination platform type for the deployment ( Lambda , Server , or ECS ). ComputePlatform types.ComputePlatform // The metadata that you apply to CodeDeploy applications to help you organize and diff --git a/service/codedeploy/api_op_CreateDeployment.go b/service/codedeploy/api_op_CreateDeployment.go index a0232675bf3..248d045b373 100644 --- a/service/codedeploy/api_op_CreateDeployment.go +++ b/service/codedeploy/api_op_CreateDeployment.go @@ -30,8 +30,8 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // Represents the input of a CreateDeployment operation. type CreateDeploymentInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string @@ -43,7 +43,7 @@ type CreateDeploymentInput struct { // The name of a deployment configuration associated with the IAM user or Amazon // Web Services account. If not specified, the value configured in the deployment // group is used as the default. If the deployment group does not have a deployment - // configuration associated with it, CodeDeployDefault.OneAtATime is used by + // configuration associated with it, CodeDeployDefault . OneAtATime is used by // default. DeploymentConfigName *string @@ -55,52 +55,47 @@ type CreateDeploymentInput struct { // Information about how CodeDeploy handles files that already exist in a // deployment target location but weren't part of the previous successful - // deployment. The fileExistsBehavior parameter takes any of the following - // values: - // - // * DISALLOW: The deployment fails. This is also the default behavior if - // no option is specified. - // - // * OVERWRITE: The version of the file from the - // application revision currently being deployed replaces the version already on - // the instance. - // - // * RETAIN: The version of the file already on the instance is kept - // and used as part of the new deployment. + // deployment. The fileExistsBehavior parameter takes any of the following values: + // - DISALLOW: The deployment fails. This is also the default behavior if no + // option is specified. + // - OVERWRITE: The version of the file from the application revision currently + // being deployed replaces the version already on the instance. + // - RETAIN: The version of the file already on the instance is kept and used as + // part of the new deployment. FileExistsBehavior types.FileExistsBehavior - // If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic + // If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic // deployment lifecycle event to an instance fails, then the deployment continues // to the next deployment lifecycle event. For example, if ApplicationStop fails, - // the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the - // deployment continues with BlockTraffic. If AfterBlockTraffic fails, the - // deployment continues with ApplicationStop. If false or not specified, then if a + // the deployment continues with DownloadBundle . If BeforeBlockTraffic fails, the + // deployment continues with BlockTraffic . If AfterBlockTraffic fails, the + // deployment continues with ApplicationStop . If false or not specified, then if a // lifecycle event fails during a deployment to an instance, that deployment fails. // If deployment to that instance is part of an overall deployment and the number // of healthy hosts is not less than the minimum number of healthy hosts, then a // deployment to the next instance is attempted. During a deployment, the - // CodeDeploy agent runs the scripts specified for ApplicationStop, - // BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous - // successful deployment. (All other scripts are run from the AppSpec file in the - // current deployment.) If one of these scripts contains an error and does not run - // successfully, the deployment can fail. If the cause of the failure is a script - // from the last successful deployment that will never run successfully, create a - // new deployment and use ignoreApplicationStopFailures to specify that the - // ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be - // ignored. + // CodeDeploy agent runs the scripts specified for ApplicationStop , + // BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the + // previous successful deployment. (All other scripts are run from the AppSpec file + // in the current deployment.) If one of these scripts contains an error and does + // not run successfully, the deployment can fail. If the cause of the failure is a + // script from the last successful deployment that will never run successfully, + // create a new deployment and use ignoreApplicationStopFailures to specify that + // the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures + // should be ignored. IgnoreApplicationStopFailures bool - // Allows you to specify information about alarms associated with a deployment. The - // alarm configuration that you specify here will override the alarm configuration - // at the deployment group level. Consider overriding the alarm configuration if - // you have set up alarms at the deployment group level that are causing deployment - // failures. In this case, you would call CreateDeployment to create a new - // deployment that uses a previous application revision that is known to work, and - // set its alarm configuration to turn off alarm polling. Turning off alarm polling - // ensures that the new deployment proceeds without being blocked by the alarm that - // was generated by the previous, failed, deployment. If you specify an - // overrideAlarmConfiguration, you need the UpdateDeploymentGroup IAM permission - // when calling CreateDeployment. + // Allows you to specify information about alarms associated with a deployment. + // The alarm configuration that you specify here will override the alarm + // configuration at the deployment group level. Consider overriding the alarm + // configuration if you have set up alarms at the deployment group level that are + // causing deployment failures. In this case, you would call CreateDeployment to + // create a new deployment that uses a previous application revision that is known + // to work, and set its alarm configuration to turn off alarm polling. Turning off + // alarm polling ensures that the new deployment proceeds without being blocked by + // the alarm that was generated by the previous, failed, deployment. If you specify + // an overrideAlarmConfiguration , you need the UpdateDeploymentGroup IAM + // permission when calling CreateDeployment . OverrideAlarmConfiguration *types.AlarmConfiguration // The type and location of the revision to deploy. diff --git a/service/codedeploy/api_op_CreateDeploymentConfig.go b/service/codedeploy/api_op_CreateDeploymentConfig.go index deed4f69c8c..29bf3e623a8 100644 --- a/service/codedeploy/api_op_CreateDeploymentConfig.go +++ b/service/codedeploy/api_op_CreateDeploymentConfig.go @@ -35,26 +35,21 @@ type CreateDeploymentConfigInput struct { // This member is required. DeploymentConfigName *string - // The destination platform type for the deployment (Lambda, Server, or ECS). + // The destination platform type for the deployment ( Lambda , Server , or ECS ). ComputePlatform types.ComputePlatform // The minimum number of healthy instances that should be available at any time // during the deployment. There are two parameters expected in the input: type and // value. The type parameter takes either of the following values: - // - // * HOST_COUNT: - // The value parameter represents the minimum number of healthy instances as an - // absolute value. - // - // * FLEET_PERCENT: The value parameter represents the minimum - // number of healthy instances as a percentage of the total number of instances in - // the deployment. If you specify FLEET_PERCENT, at the start of the deployment, - // CodeDeploy converts the percentage to the equivalent number of instances and - // rounds up fractional instances. - // - // The value parameter takes an integer. For - // example, to set a minimum of 95% healthy instance, specify a type of - // FLEET_PERCENT and a value of 95. + // - HOST_COUNT: The value parameter represents the minimum number of healthy + // instances as an absolute value. + // - FLEET_PERCENT: The value parameter represents the minimum number of healthy + // instances as a percentage of the total number of instances in the deployment. If + // you specify FLEET_PERCENT, at the start of the deployment, CodeDeploy converts + // the percentage to the equivalent number of instances and rounds up fractional + // instances. + // The value parameter takes an integer. For example, to set a minimum of 95% + // healthy instance, specify a type of FLEET_PERCENT and a value of 95. MinimumHealthyHosts *types.MinimumHealthyHosts // The configuration that specifies how the deployment traffic is routed. diff --git a/service/codedeploy/api_op_CreateDeploymentGroup.go b/service/codedeploy/api_op_CreateDeploymentGroup.go index e13885f3435..5ff1aa4e992 100644 --- a/service/codedeploy/api_op_CreateDeploymentGroup.go +++ b/service/codedeploy/api_op_CreateDeploymentGroup.go @@ -30,8 +30,8 @@ func (c *Client) CreateDeploymentGroup(ctx context.Context, params *CreateDeploy // Represents the input of a CreateDeploymentGroup operation. type CreateDeploymentGroupInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string @@ -64,11 +64,11 @@ type CreateDeploymentGroupInput struct { // If specified, the deployment configuration name can be either one of the // predefined configurations provided with CodeDeploy or a custom deployment // configuration that you create by calling the create deployment configuration - // operation. CodeDeployDefault.OneAtATime is the default deployment configuration. - // It is used if a configuration isn't specified for the deployment or deployment - // group. For more information about the predefined deployment configurations in - // CodeDeploy, see Working with Deployment Configurations in CodeDeploy - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) + // operation. CodeDeployDefault.OneAtATime is the default deployment + // configuration. It is used if a configuration isn't specified for the deployment + // or deployment group. For more information about the predefined deployment + // configurations in CodeDeploy, see Working with Deployment Configurations in + // CodeDeploy (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) // in the CodeDeploy User Guide. DeploymentConfigName *string @@ -76,20 +76,20 @@ type CreateDeploymentGroupInput struct { // to run and whether to route deployment traffic behind a load balancer. DeploymentStyle *types.DeploymentStyle - // The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 - // instances with any of the specified tags. Cannot be used in the same call as + // The Amazon EC2 tags on which to filter. The deployment group includes Amazon + // EC2 instances with any of the specified tags. Cannot be used in the same call as // ec2TagSet. Ec2TagFilters []types.EC2TagFilter - // Information about groups of tags applied to Amazon EC2 instances. The deployment - // group includes only Amazon EC2 instances identified by all the tag groups. - // Cannot be used in the same call as ec2TagFilters. + // Information about groups of tags applied to Amazon EC2 instances. The + // deployment group includes only Amazon EC2 instances identified by all the tag + // groups. Cannot be used in the same call as ec2TagFilters . Ec2TagSet *types.EC2TagSet // The target Amazon ECS services in the deployment group. This applies only to // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS // service is specified as an Amazon ECS cluster and service name pair using the - // format :. + // format : . EcsServices []types.ECSService // Information about the load balancer used in a deployment. @@ -97,31 +97,30 @@ type CreateDeploymentGroupInput struct { // The on-premises instance tags on which to filter. The deployment group includes // on-premises instances with any of the specified tags. Cannot be used in the same - // call as OnPremisesTagSet. + // call as OnPremisesTagSet . OnPremisesInstanceTagFilters []types.TagFilter // Information about groups of tags applied to on-premises instances. The // deployment group includes only on-premises instances identified by all of the - // tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters. + // tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters . OnPremisesTagSet *types.OnPremisesTagSet - // Indicates what happens when new Amazon EC2 instances are launched mid-deployment - // and do not receive the deployed application revision. If this option is set to - // UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated - // instances' deployments to apply the deployed application revision to the new - // Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not - // initiate a deployment to update the new Amazon EC2 instances. This may result in - // instances having different revisions. + // Indicates what happens when new Amazon EC2 instances are launched + // mid-deployment and do not receive the deployed application revision. If this + // option is set to UPDATE or is unspecified, CodeDeploy initiates one or more + // 'auto-update outdated instances' deployments to apply the deployed application + // revision to the new Amazon EC2 instances. If this option is set to IGNORE , + // CodeDeploy does not initiate a deployment to update the new Amazon EC2 + // instances. This may result in instances having different revisions. OutdatedInstancesStrategy types.OutdatedInstancesStrategy - // The metadata that you apply to CodeDeploy deployment groups to help you organize - // and categorize them. Each tag consists of a key and an optional value, both of - // which you define. + // The metadata that you apply to CodeDeploy deployment groups to help you + // organize and categorize them. Each tag consists of a key and an optional value, + // both of which you define. Tags []types.Tag // Information about triggers to create when the deployment group is created. For - // examples, see Create a Trigger for an CodeDeploy Event - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html) + // examples, see Create a Trigger for an CodeDeploy Event (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html) // in the CodeDeploy User Guide. TriggerConfigurations []types.TriggerConfig diff --git a/service/codedeploy/api_op_DeleteApplication.go b/service/codedeploy/api_op_DeleteApplication.go index 0281e41887a..bdbe5a73f9f 100644 --- a/service/codedeploy/api_op_DeleteApplication.go +++ b/service/codedeploy/api_op_DeleteApplication.go @@ -29,8 +29,8 @@ func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicatio // Represents the input of a DeleteApplication operation. type DeleteApplicationInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string diff --git a/service/codedeploy/api_op_DeleteDeploymentConfig.go b/service/codedeploy/api_op_DeleteDeploymentConfig.go index 1f4bc656e6a..1db55689583 100644 --- a/service/codedeploy/api_op_DeleteDeploymentConfig.go +++ b/service/codedeploy/api_op_DeleteDeploymentConfig.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a deployment configuration. A deployment configuration cannot be deleted -// if it is currently in use. Predefined configurations cannot be deleted. +// Deletes a deployment configuration. A deployment configuration cannot be +// deleted if it is currently in use. Predefined configurations cannot be deleted. func (c *Client) DeleteDeploymentConfig(ctx context.Context, params *DeleteDeploymentConfigInput, optFns ...func(*Options)) (*DeleteDeploymentConfigOutput, error) { if params == nil { params = &DeleteDeploymentConfigInput{} diff --git a/service/codedeploy/api_op_DeleteDeploymentGroup.go b/service/codedeploy/api_op_DeleteDeploymentGroup.go index 229a159782e..9b243f80767 100644 --- a/service/codedeploy/api_op_DeleteDeploymentGroup.go +++ b/service/codedeploy/api_op_DeleteDeploymentGroup.go @@ -30,8 +30,8 @@ func (c *Client) DeleteDeploymentGroup(ctx context.Context, params *DeleteDeploy // Represents the input of a DeleteDeploymentGroup operation. type DeleteDeploymentGroupInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string @@ -47,8 +47,8 @@ type DeleteDeploymentGroupInput struct { // Represents the output of a DeleteDeploymentGroup operation. type DeleteDeploymentGroupOutput struct { - // If the output contains no data, and the corresponding deployment group contained - // at least one Auto Scaling group, CodeDeploy successfully removed all + // If the output contains no data, and the corresponding deployment group + // contained at least one Auto Scaling group, CodeDeploy successfully removed all // corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances // in the Auto Scaling group. If the output contains data, CodeDeploy could not // remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in diff --git a/service/codedeploy/api_op_GetApplication.go b/service/codedeploy/api_op_GetApplication.go index f13a91acb50..7798996bcb0 100644 --- a/service/codedeploy/api_op_GetApplication.go +++ b/service/codedeploy/api_op_GetApplication.go @@ -30,8 +30,8 @@ func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput // Represents the input of a GetApplication operation. type GetApplicationInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string diff --git a/service/codedeploy/api_op_GetDeployment.go b/service/codedeploy/api_op_GetDeployment.go index 1e0e5ac56cb..709c30a41f8 100644 --- a/service/codedeploy/api_op_GetDeployment.go +++ b/service/codedeploy/api_op_GetDeployment.go @@ -143,9 +143,10 @@ type DeploymentSuccessfulWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DeploymentSuccessfulWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DeploymentSuccessfulWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/codedeploy/api_op_GetDeploymentGroup.go b/service/codedeploy/api_op_GetDeploymentGroup.go index 4d13cfe44f9..7485dc99b46 100644 --- a/service/codedeploy/api_op_GetDeploymentGroup.go +++ b/service/codedeploy/api_op_GetDeploymentGroup.go @@ -30,8 +30,8 @@ func (c *Client) GetDeploymentGroup(ctx context.Context, params *GetDeploymentGr // Represents the input of a GetDeploymentGroup operation. type GetDeploymentGroupInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string diff --git a/service/codedeploy/api_op_GetDeploymentTarget.go b/service/codedeploy/api_op_GetDeploymentTarget.go index 28c08a16d93..6465158da87 100644 --- a/service/codedeploy/api_op_GetDeploymentTarget.go +++ b/service/codedeploy/api_op_GetDeploymentTarget.go @@ -43,7 +43,7 @@ type GetDeploymentTargetOutput struct { // A deployment target that contains information about a deployment such as its // status, lifecycle events, and when it was last updated. It also contains // metadata about the deployment target. The deployment target metadata depends on - // the deployment target's type (instanceTarget, lambdaTarget, or ecsTarget). + // the deployment target's type ( instanceTarget , lambdaTarget , or ecsTarget ). DeploymentTarget *types.DeploymentTarget // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ListApplicationRevisions.go b/service/codedeploy/api_op_ListApplicationRevisions.go index 8fd4480dcbd..f5d5a3b6697 100644 --- a/service/codedeploy/api_op_ListApplicationRevisions.go +++ b/service/codedeploy/api_op_ListApplicationRevisions.go @@ -31,22 +31,18 @@ func (c *Client) ListApplicationRevisions(ctx context.Context, params *ListAppli // Represents the input of a ListApplicationRevisions operation. type ListApplicationRevisionsInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string // Whether to list revisions based on whether the revision is the target revision // of a deployment group: - // - // * include: List revisions that are target revisions of a - // deployment group. - // - // * exclude: Do not list revisions that are target revisions of - // a deployment group. - // - // * ignore: List all revisions. + // - include : List revisions that are target revisions of a deployment group. + // - exclude : Do not list revisions that are target revisions of a deployment + // group. + // - ignore : List all revisions. Deployed types.ListStateFilterAction // An identifier returned from the previous ListApplicationRevisions call. It can @@ -61,29 +57,20 @@ type ListApplicationRevisionsInput struct { S3KeyPrefix *string // The column name to use to sort the list results: - // - // * registerTime: Sort by the - // time the revisions were registered with CodeDeploy. - // - // * firstUsedTime: Sort by - // the time the revisions were first used in a deployment. - // - // * lastUsedTime: Sort by - // the time the revisions were last used in a deployment. - // - // If not specified or set - // to null, the results are returned in an arbitrary order. + // - registerTime : Sort by the time the revisions were registered with + // CodeDeploy. + // - firstUsedTime : Sort by the time the revisions were first used in a + // deployment. + // - lastUsedTime : Sort by the time the revisions were last used in a + // deployment. + // If not specified or set to null, the results are returned in an arbitrary order. SortBy types.ApplicationRevisionSortBy // The order in which to sort the list results: - // - // * ascending: ascending order. - // - // * - // descending: descending order. - // - // If not specified, the results are sorted in - // ascending order. If set to null, the results are sorted in an arbitrary order. + // - ascending : ascending order. + // - descending : descending order. + // If not specified, the results are sorted in ascending order. If set to null, + // the results are sorted in an arbitrary order. SortOrder types.SortOrder noSmithyDocumentSerde @@ -92,9 +79,9 @@ type ListApplicationRevisionsInput struct { // Represents the output of a ListApplicationRevisions operation. type ListApplicationRevisionsOutput struct { - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list application revisions call to return the next - // set of application revisions in the list. + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list application revisions call to return the + // next set of application revisions in the list. NextToken *string // A list of locations that contain the matching revisions. diff --git a/service/codedeploy/api_op_ListApplications.go b/service/codedeploy/api_op_ListApplications.go index 2f52e4ae91b..dda1050298a 100644 --- a/service/codedeploy/api_op_ListApplications.go +++ b/service/codedeploy/api_op_ListApplications.go @@ -44,8 +44,8 @@ type ListApplicationsOutput struct { // A list of application names. Applications []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list applications call to return the next set of + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list applications call to return the next set of // applications in the list. NextToken *string diff --git a/service/codedeploy/api_op_ListDeploymentConfigs.go b/service/codedeploy/api_op_ListDeploymentConfigs.go index 6af20d0a3c2..9e7e6fc95d7 100644 --- a/service/codedeploy/api_op_ListDeploymentConfigs.go +++ b/service/codedeploy/api_op_ListDeploymentConfigs.go @@ -42,11 +42,11 @@ type ListDeploymentConfigsInput struct { type ListDeploymentConfigsOutput struct { // A list of deployment configurations, including built-in configurations such as - // CodeDeployDefault.OneAtATime. + // CodeDeployDefault.OneAtATime . DeploymentConfigsList []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list deployment configurations call to return the + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list deployment configurations call to return the // next set of deployment configurations in the list. NextToken *string diff --git a/service/codedeploy/api_op_ListDeploymentGroups.go b/service/codedeploy/api_op_ListDeploymentGroups.go index df6441b4a2b..ad927ab2cda 100644 --- a/service/codedeploy/api_op_ListDeploymentGroups.go +++ b/service/codedeploy/api_op_ListDeploymentGroups.go @@ -31,8 +31,8 @@ func (c *Client) ListDeploymentGroups(ctx context.Context, params *ListDeploymen // Represents the input of a ListDeploymentGroups operation. type ListDeploymentGroupsInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string @@ -53,9 +53,9 @@ type ListDeploymentGroupsOutput struct { // A list of deployment group names. DeploymentGroups []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list deployment groups call to return the next set - // of deployment groups in the list. + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list deployment groups call to return the next + // set of deployment groups in the list. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ListDeploymentInstances.go b/service/codedeploy/api_op_ListDeploymentInstances.go index 9435f9ce498..03890834416 100644 --- a/service/codedeploy/api_op_ListDeploymentInstances.go +++ b/service/codedeploy/api_op_ListDeploymentInstances.go @@ -12,10 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The newer BatchGetDeploymentTargets should be used instead because it works with -// all compute types. ListDeploymentInstances throws an exception if it is used -// with a compute platform other than EC2/On-premises or Lambda. Lists the instance -// for a deployment associated with the IAM user or Amazon Web Services account. +// The newer BatchGetDeploymentTargets should be used instead because it works +// with all compute types. ListDeploymentInstances throws an exception if it is +// used with a compute platform other than EC2/On-premises or Lambda. Lists the +// instance for a deployment associated with the IAM user or Amazon Web Services +// account. // // Deprecated: This operation is deprecated, use ListDeploymentTargets instead. func (c *Client) ListDeploymentInstances(ctx context.Context, params *ListDeploymentInstancesInput, optFns ...func(*Options)) (*ListDeploymentInstancesOutput, error) { @@ -42,23 +43,13 @@ type ListDeploymentInstancesInput struct { DeploymentId *string // A subset of instances to list by status: - // - // * Pending: Include those instances - // with pending deployments. - // - // * InProgress: Include those instances where - // deployments are still in progress. - // - // * Succeeded: Include those instances with - // successful deployments. - // - // * Failed: Include those instances with failed - // deployments. - // - // * Skipped: Include those instances with skipped deployments. - // - // * - // Unknown: Include those instances with deployments in an unknown state. + // - Pending : Include those instances with pending deployments. + // - InProgress : Include those instances where deployments are still in + // progress. + // - Succeeded : Include those instances with successful deployments. + // - Failed : Include those instances with failed deployments. + // - Skipped : Include those instances with skipped deployments. + // - Unknown : Include those instances with deployments in an unknown state. InstanceStatusFilter []types.InstanceStatus // The set of instances in a blue/green deployment, either those in the original @@ -79,8 +70,8 @@ type ListDeploymentInstancesOutput struct { // A list of instance IDs. InstancesList []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list deployment instances call to return the next + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list deployment instances call to return the next // set of deployment instances in the list. NextToken *string diff --git a/service/codedeploy/api_op_ListDeploymentTargets.go b/service/codedeploy/api_op_ListDeploymentTargets.go index 8cfea698758..a7d9ab316e0 100644 --- a/service/codedeploy/api_op_ListDeploymentTargets.go +++ b/service/codedeploy/api_op_ListDeploymentTargets.go @@ -31,18 +31,15 @@ type ListDeploymentTargetsInput struct { // The unique ID of a deployment. DeploymentId *string - // A token identifier returned from the previous ListDeploymentTargets call. It can - // be used to return the next set of deployment targets in the list. + // A token identifier returned from the previous ListDeploymentTargets call. It + // can be used to return the next set of deployment targets in the list. NextToken *string // A key used to filter the returned targets. The two valid values are: - // - // * - // TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, - // Ready, Skipped, Succeeded, or Unknown. - // - // * ServerInstanceLabel - A - // ServerInstanceLabel filter string can be Blue or Green. + // - TargetStatus - A TargetStatus filter string can be Failed , InProgress , + // Pending , Ready , Skipped , Succeeded , or Unknown . + // - ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or + // Green . TargetFilters map[string][]string noSmithyDocumentSerde diff --git a/service/codedeploy/api_op_ListDeployments.go b/service/codedeploy/api_op_ListDeployments.go index 0e0e5b974a0..179cd7a83c7 100644 --- a/service/codedeploy/api_op_ListDeployments.go +++ b/service/codedeploy/api_op_ListDeployments.go @@ -32,9 +32,9 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp // Represents the input of a ListDeployments operation. type ListDeploymentsInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. If applicationName is specified, then deploymentGroupName must - // be specified. If it is not specified, then deploymentGroupName must not be + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. If applicationName is specified, then deploymentGroupName + // must be specified. If it is not specified, then deploymentGroupName must not be // specified. ApplicationName *string @@ -51,23 +51,12 @@ type ListDeploymentsInput struct { ExternalId *string // A subset of deployments to list by status: - // - // * Created: Include created - // deployments in the resulting list. - // - // * Queued: Include queued deployments in the - // resulting list. - // - // * In Progress: Include in-progress deployments in the resulting - // list. - // - // * Succeeded: Include successful deployments in the resulting list. - // - // * - // Failed: Include failed deployments in the resulting list. - // - // * Stopped: Include - // stopped deployments in the resulting list. + // - Created : Include created deployments in the resulting list. + // - Queued : Include queued deployments in the resulting list. + // - In Progress : Include in-progress deployments in the resulting list. + // - Succeeded : Include successful deployments in the resulting list. + // - Failed : Include failed deployments in the resulting list. + // - Stopped : Include stopped deployments in the resulting list. IncludeOnlyStatuses []types.DeploymentStatus // An identifier returned from the previous list deployments call. It can be used @@ -83,8 +72,8 @@ type ListDeploymentsOutput struct { // A list of deployment IDs. Deployments []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list deployments call to return the next set of + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list deployments call to return the next set of // deployments in the list. NextToken *string diff --git a/service/codedeploy/api_op_ListGitHubAccountTokenNames.go b/service/codedeploy/api_op_ListGitHubAccountTokenNames.go index 6cbbb0fe8e9..16faba0070d 100644 --- a/service/codedeploy/api_op_ListGitHubAccountTokenNames.go +++ b/service/codedeploy/api_op_ListGitHubAccountTokenNames.go @@ -39,9 +39,9 @@ type ListGitHubAccountTokenNamesInput struct { // Represents the output of a ListGitHubAccountTokenNames operation. type ListGitHubAccountTokenNamesOutput struct { - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent ListGitHubAccountTokenNames call to return the next - // set of names in the list. + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent ListGitHubAccountTokenNames call to return the + // next set of names in the list. NextToken *string // A list of names of connections to GitHub accounts. diff --git a/service/codedeploy/api_op_ListOnPremisesInstances.go b/service/codedeploy/api_op_ListOnPremisesInstances.go index 162dbc870ad..8ee988e6e0e 100644 --- a/service/codedeploy/api_op_ListOnPremisesInstances.go +++ b/service/codedeploy/api_op_ListOnPremisesInstances.go @@ -33,21 +33,18 @@ func (c *Client) ListOnPremisesInstances(ctx context.Context, params *ListOnPrem // Represents the input of a ListOnPremisesInstances operation. type ListOnPremisesInstancesInput struct { - // An identifier returned from the previous list on-premises instances call. It can - // be used to return the next set of on-premises instances in the list. + // An identifier returned from the previous list on-premises instances call. It + // can be used to return the next set of on-premises instances in the list. NextToken *string // The registration status of the on-premises instances: - // - // * Deregistered: Include - // deregistered on-premises instances in the resulting list. - // - // * Registered: Include - // registered on-premises instances in the resulting list. + // - Deregistered : Include deregistered on-premises instances in the resulting + // list. + // - Registered : Include registered on-premises instances in the resulting list. RegistrationStatus types.RegistrationStatus - // The on-premises instance tags that are used to restrict the on-premises instance - // names returned. + // The on-premises instance tags that are used to restrict the on-premises + // instance names returned. TagFilters []types.TagFilter noSmithyDocumentSerde @@ -59,9 +56,9 @@ type ListOnPremisesInstancesOutput struct { // The list of matching on-premises instance names. InstanceNames []string - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list on-premises instances call to return the next - // set of on-premises instances in the list. + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list on-premises instances call to return the + // next set of on-premises instances in the list. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ListTagsForResource.go b/service/codedeploy/api_op_ListTagsForResource.go index 6806aeea795..0a3834475af 100644 --- a/service/codedeploy/api_op_ListTagsForResource.go +++ b/service/codedeploy/api_op_ListTagsForResource.go @@ -32,7 +32,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags - // associated with the resource that is identified by the ResourceArn. + // associated with the resource that is identified by the ResourceArn . // // This member is required. ResourceArn *string @@ -46,13 +46,13 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // If a large amount of information is returned, an identifier is also returned. It - // can be used in a subsequent list application revisions call to return the next - // set of application revisions in the list. + // If a large amount of information is returned, an identifier is also returned. + // It can be used in a subsequent list application revisions call to return the + // next set of application revisions in the list. NextToken *string - // A list of tags returned by ListTagsForResource. The tags are associated with the - // resource identified by the input ResourceArn parameter. + // A list of tags returned by ListTagsForResource . The tags are associated with + // the resource identified by the input ResourceArn parameter. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go index b02da12b853..5667d7a63f7 100644 --- a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go +++ b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go @@ -14,14 +14,13 @@ import ( // Sets the result of a Lambda validation function. The function validates // lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute // platform. For Lambda deployments, the available lifecycle hooks are -// BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the -// available lifecycle hooks are BeforeInstall, AfterInstall, -// AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda -// validation functions return Succeeded or Failed. For more information, see -// AppSpec 'hooks' Section for an Lambda Deployment -// (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda) -// and AppSpec 'hooks' Section for an Amazon ECS Deployment -// (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs). +// BeforeAllowTraffic and AfterAllowTraffic . For Amazon ECS deployments, the +// available lifecycle hooks are BeforeInstall , AfterInstall , +// AfterAllowTestTraffic , BeforeAllowTraffic , and AfterAllowTraffic . Lambda +// validation functions return Succeeded or Failed . For more information, see +// AppSpec 'hooks' Section for an Lambda Deployment (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda) +// and AppSpec 'hooks' Section for an Amazon ECS Deployment (https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs) +// . func (c *Client) PutLifecycleEventHookExecutionStatus(ctx context.Context, params *PutLifecycleEventHookExecutionStatusInput, optFns ...func(*Options)) (*PutLifecycleEventHookExecutionStatusOutput, error) { if params == nil { params = &PutLifecycleEventHookExecutionStatusInput{} @@ -47,8 +46,8 @@ type PutLifecycleEventHookExecutionStatusInput struct { // is specified in the hooks section of the AppSpec file. LifecycleEventHookExecutionId *string - // The result of a Lambda function that validates a deployment lifecycle event. The - // values listed in Valid Values are valid for lifecycle statuses in general; + // The result of a Lambda function that validates a deployment lifecycle event. + // The values listed in Valid Values are valid for lifecycle statuses in general; // however, only Succeeded and Failed can be passed successfully in your API call. Status types.LifecycleEventStatus diff --git a/service/codedeploy/api_op_RegisterApplicationRevision.go b/service/codedeploy/api_op_RegisterApplicationRevision.go index 0066eed4b9a..71d54073301 100644 --- a/service/codedeploy/api_op_RegisterApplicationRevision.go +++ b/service/codedeploy/api_op_RegisterApplicationRevision.go @@ -30,8 +30,8 @@ func (c *Client) RegisterApplicationRevision(ctx context.Context, params *Regist // Represents the input of a RegisterApplicationRevision operation. type RegisterApplicationRevisionInput struct { - // The name of an CodeDeploy application associated with the IAM user or Amazon Web - // Services account. + // The name of an CodeDeploy application associated with the IAM user or Amazon + // Web Services account. // // This member is required. ApplicationName *string diff --git a/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go b/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go index 150757d9b9f..342ecc3d2d4 100644 --- a/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go +++ b/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go @@ -32,8 +32,8 @@ func (c *Client) SkipWaitTimeForInstanceTermination(ctx context.Context, params type SkipWaitTimeForInstanceTerminationInput struct { - // The unique ID of a blue/green deployment for which you want to skip the instance - // termination wait time. + // The unique ID of a blue/green deployment for which you want to skip the + // instance termination wait time. DeploymentId *string noSmithyDocumentSerde diff --git a/service/codedeploy/api_op_StopDeployment.go b/service/codedeploy/api_op_StopDeployment.go index 8bd893d1c53..540d454d5cb 100644 --- a/service/codedeploy/api_op_StopDeployment.go +++ b/service/codedeploy/api_op_StopDeployment.go @@ -47,11 +47,8 @@ type StopDeploymentInput struct { type StopDeploymentOutput struct { // The status of the stop deployment operation: - // - // * Pending: The stop operation is - // pending. - // - // * Succeeded: The stop operation was successful. + // - Pending: The stop operation is pending. + // - Succeeded: The stop operation was successful. Status types.StopStatus // An accompanying status message. diff --git a/service/codedeploy/api_op_UpdateDeploymentGroup.go b/service/codedeploy/api_op_UpdateDeploymentGroup.go index 0f1c6e06079..d7757624355 100644 --- a/service/codedeploy/api_op_UpdateDeploymentGroup.go +++ b/service/codedeploy/api_op_UpdateDeploymentGroup.go @@ -50,17 +50,13 @@ type UpdateDeploymentGroupInput struct { // The replacement list of Auto Scaling groups to be included in the deployment // group, if you want to change them. - // - // * To keep the Auto Scaling groups, enter - // their names or do not specify this parameter. - // - // * To remove Auto Scaling groups, - // specify a non-null empty list of Auto Scaling group names to detach all - // CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see Amazon EC2 - // instances in an Amazon EC2 Auto Scaling group fail to launch and receive the - // error "Heartbeat Timeout" - // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat) - // in the CodeDeploy User Guide. + // - To keep the Auto Scaling groups, enter their names or do not specify this + // parameter. + // - To remove Auto Scaling groups, specify a non-null empty list of Auto + // Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle + // hooks. For examples, see Amazon EC2 instances in an Amazon EC2 Auto Scaling + // group fail to launch and receive the error "Heartbeat Timeout" (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat) + // in the CodeDeploy User Guide. AutoScalingGroups []string // Information about blue/green deployment options for a deployment group. @@ -73,9 +69,9 @@ type UpdateDeploymentGroupInput struct { // want to run and whether to route deployment traffic behind a load balancer. DeploymentStyle *types.DeploymentStyle - // The replacement set of Amazon EC2 tags on which to filter, if you want to change - // them. To keep the existing tags, enter their names. To remove tags, do not enter - // any tag names. + // The replacement set of Amazon EC2 tags on which to filter, if you want to + // change them. To keep the existing tags, enter their names. To remove tags, do + // not enter any tag names. Ec2TagFilters []types.EC2TagFilter // Information about groups of tags applied to on-premises instances. The @@ -86,7 +82,7 @@ type UpdateDeploymentGroupInput struct { // The target Amazon ECS services in the deployment group. This applies only to // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS // service is specified as an Amazon ECS cluster and service name pair using the - // format :. + // format : . EcsServices []types.ECSService // Information about the load balancer used in a deployment. @@ -95,30 +91,29 @@ type UpdateDeploymentGroupInput struct { // The new name of the deployment group, if you want to change it. NewDeploymentGroupName *string - // The replacement set of on-premises instance tags on which to filter, if you want - // to change them. To keep the existing tags, enter their names. To remove tags, do - // not enter any tag names. + // The replacement set of on-premises instance tags on which to filter, if you + // want to change them. To keep the existing tags, enter their names. To remove + // tags, do not enter any tag names. OnPremisesInstanceTagFilters []types.TagFilter - // Information about an on-premises instance tag set. The deployment group includes - // only on-premises instances identified by all the tag groups. + // Information about an on-premises instance tag set. The deployment group + // includes only on-premises instances identified by all the tag groups. OnPremisesTagSet *types.OnPremisesTagSet - // Indicates what happens when new Amazon EC2 instances are launched mid-deployment - // and do not receive the deployed application revision. If this option is set to - // UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated - // instances' deployments to apply the deployed application revision to the new - // Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not - // initiate a deployment to update the new Amazon EC2 instances. This may result in - // instances having different revisions. + // Indicates what happens when new Amazon EC2 instances are launched + // mid-deployment and do not receive the deployed application revision. If this + // option is set to UPDATE or is unspecified, CodeDeploy initiates one or more + // 'auto-update outdated instances' deployments to apply the deployed application + // revision to the new Amazon EC2 instances. If this option is set to IGNORE , + // CodeDeploy does not initiate a deployment to update the new Amazon EC2 + // instances. This may result in instances having different revisions. OutdatedInstancesStrategy types.OutdatedInstancesStrategy // A replacement ARN for the service role, if you want to change it. ServiceRoleArn *string // Information about triggers to change when the deployment group is updated. For - // examples, see Edit a Trigger in a CodeDeploy Deployment Group - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html) + // examples, see Edit a Trigger in a CodeDeploy Deployment Group (https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html) // in the CodeDeploy User Guide. TriggerConfigurations []types.TriggerConfig @@ -128,8 +123,8 @@ type UpdateDeploymentGroupInput struct { // Represents the output of an UpdateDeploymentGroup operation. type UpdateDeploymentGroupOutput struct { - // If the output contains no data, and the corresponding deployment group contained - // at least one Auto Scaling group, CodeDeploy successfully removed all + // If the output contains no data, and the corresponding deployment group + // contained at least one Auto Scaling group, CodeDeploy successfully removed all // corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services // account. If the output contains data, CodeDeploy could not remove some Auto // Scaling lifecycle event hooks from the Amazon Web Services account. diff --git a/service/codedeploy/doc.go b/service/codedeploy/doc.go index d394acfd473..1a3849fba40 100644 --- a/service/codedeploy/doc.go +++ b/service/codedeploy/doc.go @@ -17,61 +17,42 @@ // applications, without many of the risks associated with error-prone manual // deployments. CodeDeploy Components Use the information in this guide to help you // work with the following CodeDeploy components: -// -// * Application: A name that -// uniquely identifies the application you want to deploy. CodeDeploy uses this -// name, which functions as a container, to ensure the correct combination of -// revision, deployment configuration, and deployment group are referenced during a -// deployment. -// -// * Deployment group: A set of individual instances, CodeDeploy -// Lambda deployment configuration settings, or an Amazon ECS service and network -// details. A Lambda deployment group specifies how to route traffic to a new -// version of a Lambda function. An Amazon ECS deployment group specifies the -// service created in Amazon ECS to deploy, a load balancer, and a listener to -// reroute production traffic to an updated containerized application. An Amazon -// EC2/On-premises deployment group contains individually tagged instances, Amazon -// EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups -// can specify optional trigger, alarm, and rollback settings. -// -// * Deployment -// configuration: A set of deployment rules and deployment success and failure -// conditions used by CodeDeploy during a deployment. -// -// * Deployment: The process -// and the components used when updating a Lambda function, a containerized -// application in an Amazon ECS service, or of installing content on one or more -// instances. -// -// * Application revisions: For an Lambda deployment, this is an -// AppSpec file that specifies the Lambda function to be updated and one or more -// functions to validate deployment lifecycle events. For an Amazon ECS deployment, -// this is an AppSpec file that specifies the Amazon ECS task definition, -// container, and port where production traffic is rerouted. For an EC2/On-premises -// deployment, this is an archive file that contains source content—source code, -// webpages, executable files, and deployment scripts—along with an AppSpec file. -// Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, -// a revision is uniquely identified by its Amazon S3 object key and its ETag, -// version, or both. For GitHub, a revision is uniquely identified by its commit -// ID. +// - Application: A name that uniquely identifies the application you want to +// deploy. CodeDeploy uses this name, which functions as a container, to ensure the +// correct combination of revision, deployment configuration, and deployment group +// are referenced during a deployment. +// - Deployment group: A set of individual instances, CodeDeploy Lambda +// deployment configuration settings, or an Amazon ECS service and network details. +// A Lambda deployment group specifies how to route traffic to a new version of a +// Lambda function. An Amazon ECS deployment group specifies the service created in +// Amazon ECS to deploy, a load balancer, and a listener to reroute production +// traffic to an updated containerized application. An Amazon EC2/On-premises +// deployment group contains individually tagged instances, Amazon EC2 instances in +// Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify +// optional trigger, alarm, and rollback settings. +// - Deployment configuration: A set of deployment rules and deployment success +// and failure conditions used by CodeDeploy during a deployment. +// - Deployment: The process and the components used when updating a Lambda +// function, a containerized application in an Amazon ECS service, or of installing +// content on one or more instances. +// - Application revisions: For an Lambda deployment, this is an AppSpec file +// that specifies the Lambda function to be updated and one or more functions to +// validate deployment lifecycle events. For an Amazon ECS deployment, this is an +// AppSpec file that specifies the Amazon ECS task definition, container, and port +// where production traffic is rerouted. For an EC2/On-premises deployment, this is +// an archive file that contains source content—source code, webpages, executable +// files, and deployment scripts—along with an AppSpec file. Revisions are stored +// in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is +// uniquely identified by its Amazon S3 object key and its ETag, version, or both. +// For GitHub, a revision is uniquely identified by its commit ID. // // This guide also contains information to help you get details about the // instances in your deployments, to make on-premises instances available for // CodeDeploy deployments, to get details about a Lambda function deployment, and // to get details about Amazon ECS service deployments. CodeDeploy Information // Resources -// -// * CodeDeploy User Guide -// (https://docs.aws.amazon.com/codedeploy/latest/userguide) -// -// * CodeDeploy API -// Reference Guide (https://docs.aws.amazon.com/codedeploy/latest/APIReference/) -// -// * -// CLI Reference for CodeDeploy -// (https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html) -// -// * -// CodeDeploy Developer Forum -// (https://forums.aws.amazon.com/forum.jspa?forumID=179) +// - CodeDeploy User Guide (https://docs.aws.amazon.com/codedeploy/latest/userguide) +// - CodeDeploy API Reference Guide (https://docs.aws.amazon.com/codedeploy/latest/APIReference/) +// - CLI Reference for CodeDeploy (https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html) +// - CodeDeploy Developer Forum (https://forums.aws.amazon.com/forum.jspa?forumID=179) package codedeploy diff --git a/service/codedeploy/types/enums.go b/service/codedeploy/types/enums.go index 2c96d5c1594..f9548c07373 100644 --- a/service/codedeploy/types/enums.go +++ b/service/codedeploy/types/enums.go @@ -140,8 +140,8 @@ const ( DeploymentReadyActionStopDeployment DeploymentReadyAction = "STOP_DEPLOYMENT" ) -// Values returns all known values for DeploymentReadyAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DeploymentReadyAction. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DeploymentReadyAction) Values() []DeploymentReadyAction { return []DeploymentReadyAction{ @@ -298,9 +298,9 @@ const ( ErrorCodeCloudformationStackFailure ErrorCode = "CLOUDFORMATION_STACK_FAILURE" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "AGENT_ISSUE", @@ -368,9 +368,10 @@ const ( GreenFleetProvisioningActionCopyAutoScalingGroup GreenFleetProvisioningAction = "COPY_AUTO_SCALING_GROUP" ) -// Values returns all known values for GreenFleetProvisioningAction. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for GreenFleetProvisioningAction. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (GreenFleetProvisioningAction) Values() []GreenFleetProvisioningAction { return []GreenFleetProvisioningAction{ "DISCOVER_EXISTING", @@ -432,9 +433,9 @@ const ( InstanceTypeGreen InstanceType = "Green" ) -// Values returns all known values for InstanceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InstanceType) Values() []InstanceType { return []InstanceType{ "Blue", @@ -503,8 +504,8 @@ const ( ListStateFilterActionIgnore ListStateFilterAction = "ignore" ) -// Values returns all known values for ListStateFilterAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ListStateFilterAction. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ListStateFilterAction) Values() []ListStateFilterAction { return []ListStateFilterAction{ @@ -598,9 +599,9 @@ const ( SortOrderDescending SortOrder = "descending" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ascending", @@ -695,9 +696,9 @@ const ( TargetStatusReady TargetStatus = "Ready" ) -// Values returns all known values for TargetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetStatus) Values() []TargetStatus { return []TargetStatus{ "Pending", diff --git a/service/codedeploy/types/errors.go b/service/codedeploy/types/errors.go index bdcca1c38e6..6b0dcad2f98 100644 --- a/service/codedeploy/types/errors.go +++ b/service/codedeploy/types/errors.go @@ -440,8 +440,8 @@ func (e *DeploymentGroupAlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The named deployment group with the IAM user or Amazon Web Services account does -// not exist. +// The named deployment group with the IAM user or Amazon Web Services account +// does not exist. type DeploymentGroupDoesNotExistException struct { Message *string @@ -856,8 +856,8 @@ func (e *IamArnRequiredException) ErrorCode() string { } func (e *IamArnRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request included an IAM session ARN that has already been used to register a -// different instance. +// The request included an IAM session ARN that has already been used to register +// a different instance. type IamSessionArnAlreadyRegisteredException struct { Message *string @@ -1099,20 +1099,11 @@ func (e *InstanceNotRegisteredException) ErrorCode() string { func (e *InstanceNotRegisteredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The format of the alarm configuration is invalid. Possible causes include: -// -// * -// The alarm list is null. -// -// * The alarm object is null. -// -// * The alarm name is empty -// or null or exceeds the limit of 255 characters. -// -// * Two alarms with the same name -// have been specified. -// -// * The alarm configuration is enabled, but the alarm list -// is empty. +// - The alarm list is null. +// - The alarm object is null. +// - The alarm name is empty or null or exceeds the limit of 255 characters. +// - Two alarms with the same name have been specified. +// - The alarm configuration is enabled, but the alarm list is empty. type InvalidAlarmConfigException struct { Message *string @@ -1246,9 +1237,9 @@ func (e *InvalidAutoScalingGroupException) ErrorCode() string { } func (e *InvalidAutoScalingGroupException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The configuration for the blue/green deployment group was provided in an invalid -// format. For information about deployment configuration format, see -// CreateDeploymentConfig. +// The configuration for the blue/green deployment group was provided in an +// invalid format. For information about deployment configuration format, see +// CreateDeploymentConfig . type InvalidBlueGreenDeploymentConfigurationException struct { Message *string @@ -1302,8 +1293,8 @@ func (e *InvalidBucketNameFilterException) ErrorCode() string { } func (e *InvalidBucketNameFilterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The computePlatform is invalid. The computePlatform should be Lambda, Server, or -// ECS. +// The computePlatform is invalid. The computePlatform should be Lambda , Server , +// or ECS . type InvalidComputePlatformException struct { Message *string @@ -1929,9 +1920,9 @@ func (e *InvalidInstanceStatusException) ErrorCode() string { } func (e *InvalidInstanceStatusException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An invalid instance type was specified for instances in a blue/green deployment. -// Valid values include "Blue" for an original environment and "Green" for a -// replacement environment. +// An invalid instance type was specified for instances in a blue/green +// deployment. Valid values include "Blue" for an original environment and "Green" +// for a replacement environment. type InvalidInstanceTypeException struct { Message *string @@ -1983,8 +1974,8 @@ func (e *InvalidKeyPrefixFilterException) ErrorCode() string { } func (e *InvalidKeyPrefixFilterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A lifecycle event hook is invalid. Review the hooks section in your AppSpec file -// to ensure the lifecycle events and hooks functions are valid. +// A lifecycle event hook is invalid. Review the hooks section in your AppSpec +// file to ensure the lifecycle events and hooks functions are valid. type InvalidLifecycleEventHookExecutionIdException struct { Message *string @@ -2013,7 +2004,7 @@ func (e *InvalidLifecycleEventHookExecutionIdException) ErrorFault() smithy.Erro } // The result of a Lambda validation function that verifies a lifecycle event is -// invalid. It should return Succeeded or Failed. +// invalid. It should return Succeeded or Failed . type InvalidLifecycleEventHookExecutionStatusException struct { Message *string @@ -2442,18 +2433,11 @@ func (e *InvalidTargetGroupPairException) ErrorCode() string { func (e *InvalidTargetGroupPairException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The target instance configuration is invalid. Possible causes include: -// -// * -// Configuration data for target instances was entered for an in-place -// deployment. -// -// * The limit of 10 tags for a tag type was exceeded. -// -// * The combined -// length of the tag names exceeded the limit. -// -// * A specified tag is not currently -// applied to any instances. +// - Configuration data for target instances was entered for an in-place +// deployment. +// - The limit of 10 tags for a tag type was exceeded. +// - The combined length of the tag names exceeded the limit. +// - A specified tag is not currently applied to any instances. type InvalidTargetInstancesException struct { Message *string diff --git a/service/codedeploy/types/types.go b/service/codedeploy/types/types.go index 6567e9e8304..ccf8333b901 100644 --- a/service/codedeploy/types/types.go +++ b/service/codedeploy/types/types.go @@ -20,8 +20,8 @@ type Alarm struct { // Information about alarms associated with a deployment or deployment group. type AlarmConfiguration struct { - // A list of alarms configured for the deployment or deployment group. A maximum of - // 10 alarms can be added. + // A list of alarms configured for the deployment or deployment group. A maximum + // of 10 alarms can be added. Alarms []Alarm // Indicates whether the alarm configuration is enabled. @@ -30,12 +30,10 @@ type AlarmConfiguration struct { // Indicates whether a deployment should continue if information about the current // state of alarms cannot be retrieved from Amazon CloudWatch. The default value is // false. - // - // * true: The deployment proceeds even if alarm status information can't - // be retrieved from Amazon CloudWatch. - // - // * false: The deployment stops if alarm - // status information can't be retrieved from Amazon CloudWatch. + // - true : The deployment proceeds even if alarm status information can't be + // retrieved from Amazon CloudWatch. + // - false : The deployment stops if alarm status information can't be retrieved + // from Amazon CloudWatch. IgnorePollAlarmFailure bool noSmithyDocumentSerde @@ -50,8 +48,8 @@ type ApplicationInfo struct { // The application name. ApplicationName *string - // The destination platform type for deployment of the application (Lambda or - // Server). + // The destination platform type for deployment of the application ( Lambda or + // Server ). ComputePlatform ComputePlatform // The time at which the application was created. @@ -69,8 +67,8 @@ type ApplicationInfo struct { // A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or // JSON-formatted string. For Lambda and Amazon ECS deployments, the revision is -// the same as the AppSpec file. This method replaces the deprecated RawString data -// type. +// the same as the AppSpec file. This method replaces the deprecated RawString +// data type. type AppSpecContent struct { // The YAML-formatted or JSON-formatted revision string. For an Lambda deployment, @@ -80,7 +78,7 @@ type AppSpecContent struct { // Amazon ECS deployment, the content includes the task name, information about the // load balancer that serves traffic to the container, and more. For both types of // deployments, the content can specify Lambda functions that run at specified - // hooks, such as BeforeInstall, during a deployment. + // hooks, such as BeforeInstall , during a deployment. Content *string // The SHA256 hash value of the revision content. @@ -123,8 +121,8 @@ type BlueGreenDeploymentConfiguration struct { // to receive traffic in a blue/green deployment. DeploymentReadyOption *DeploymentReadyOption - // Information about how instances are provisioned for a replacement environment in - // a blue/green deployment. + // Information about how instances are provisioned for a replacement environment + // in a blue/green deployment. GreenFleetProvisioningOption *GreenFleetProvisioningOption // Information about whether to terminate instances in the original fleet during a @@ -141,12 +139,9 @@ type BlueInstanceTerminationOption struct { // The action to take on instances in the original environment after a successful // blue/green deployment. - // - // * TERMINATE: Instances are terminated after a specified - // wait time. - // - // * KEEP_ALIVE: Instances are left running after they are deregistered - // from the load balancer and removed from the deployment group. + // - TERMINATE : Instances are terminated after a specified wait time. + // - KEEP_ALIVE : Instances are left running after they are deregistered from the + // load balancer and removed from the deployment group. Action InstanceAction // For an Amazon EC2 deployment, the number of minutes to wait after a successful @@ -182,7 +177,7 @@ type CloudFormationTarget struct { // The status of an CloudFormation blue/green deployment's target application. Status TargetStatus - // The unique ID of a deployment target that has a type of CloudFormationTarget. + // The unique ID of a deployment target that has a type of CloudFormationTarget . TargetId *string // The percentage of production traffic that the target version of an @@ -195,7 +190,7 @@ type CloudFormationTarget struct { // Information about a deployment configuration. type DeploymentConfigInfo struct { - // The destination platform type for the deployment (Lambda, Server, or ECS). + // The destination platform type for the deployment ( Lambda , Server , or ECS ). ComputePlatform ComputePlatform // The time at which the deployment configuration was created. @@ -236,7 +231,7 @@ type DeploymentGroupInfo struct { // Information about blue/green deployment options for a deployment group. BlueGreenDeploymentConfiguration *BlueGreenDeploymentConfiguration - // The destination platform type for the deployment (Lambda, Server, or ECS). + // The destination platform type for the deployment ( Lambda , Server , or ECS ). ComputePlatform ComputePlatform // The deployment configuration name. @@ -264,7 +259,7 @@ type DeploymentGroupInfo struct { // The target Amazon ECS services in the deployment group. This applies only to // deployment groups that use the Amazon ECS compute platform. A target Amazon ECS // service is specified as an Amazon ECS cluster and service name pair using the - // format :. + // format : . EcsServices []ECSService // Information about the most recent attempted deployment to the deployment group. @@ -285,19 +280,18 @@ type DeploymentGroupInfo struct { // groups. Cannot be used in the same call as onPremisesInstanceTagFilters. OnPremisesTagSet *OnPremisesTagSet - // Indicates what happens when new Amazon EC2 instances are launched mid-deployment - // and do not receive the deployed application revision. If this option is set to - // UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated - // instances' deployments to apply the deployed application revision to the new - // Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not - // initiate a deployment to update the new Amazon EC2 instances. This may result in - // instances having different revisions. + // Indicates what happens when new Amazon EC2 instances are launched + // mid-deployment and do not receive the deployed application revision. If this + // option is set to UPDATE or is unspecified, CodeDeploy initiates one or more + // 'auto-update outdated instances' deployments to apply the deployed application + // revision to the new Amazon EC2 instances. If this option is set to IGNORE , + // CodeDeploy does not initiate a deployment to update the new Amazon EC2 + // instances. This may result in instances having different revisions. OutdatedInstancesStrategy OutdatedInstancesStrategy // A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to // make calls to Amazon Web Services services on your behalf. For more information, - // see Create a Service Role for CodeDeploy - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) + // see Create a Service Role for CodeDeploy (https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) // in the CodeDeploy User Guide. ServiceRoleArn *string @@ -335,25 +329,18 @@ type DeploymentInfo struct { // A timestamp that indicates when the deployment was complete. CompleteTime *time.Time - // The destination platform type for the deployment (Lambda, Server, or ECS). + // The destination platform type for the deployment ( Lambda , Server , or ECS ). ComputePlatform ComputePlatform // A timestamp that indicates when the deployment was created. CreateTime *time.Time // The means by which the deployment was created: - // - // * user: A user created the - // deployment. - // - // * autoscaling: Amazon EC2 Auto Scaling created the deployment. - // - // * - // codeDeployRollback: A rollback process created the deployment. - // - // * - // CodeDeployAutoUpdate: An auto-update process created the deployment when it - // detected outdated Amazon EC2 instances. + // - user : A user created the deployment. + // - autoscaling : Amazon EC2 Auto Scaling created the deployment. + // - codeDeployRollback : A rollback process created the deployment. + // - CodeDeployAutoUpdate : An auto-update process created the deployment when it + // detected outdated Amazon EC2 instances. Creator DeploymentCreator // The deployment configuration name. @@ -388,37 +375,33 @@ type DeploymentInfo struct { // Information about how CodeDeploy handles files that already exist in a // deployment target location but weren't part of the previous successful // deployment. - // - // * DISALLOW: The deployment fails. This is also the default behavior - // if no option is specified. - // - // * OVERWRITE: The version of the file from the - // application revision currently being deployed replaces the version already on - // the instance. - // - // * RETAIN: The version of the file already on the instance is kept - // and used as part of the new deployment. + // - DISALLOW : The deployment fails. This is also the default behavior if no + // option is specified. + // - OVERWRITE : The version of the file from the application revision currently + // being deployed replaces the version already on the instance. + // - RETAIN : The version of the file already on the instance is kept and used as + // part of the new deployment. FileExistsBehavior FileExistsBehavior - // If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic + // If true, then if an ApplicationStop , BeforeBlockTraffic , or AfterBlockTraffic // deployment lifecycle event to an instance fails, then the deployment continues // to the next deployment lifecycle event. For example, if ApplicationStop fails, // the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the - // deployment continues with BlockTraffic. If AfterBlockTraffic fails, the - // deployment continues with ApplicationStop. If false or not specified, then if a + // deployment continues with BlockTraffic . If AfterBlockTraffic fails, the + // deployment continues with ApplicationStop . If false or not specified, then if a // lifecycle event fails during a deployment to an instance, that deployment fails. // If deployment to that instance is part of an overall deployment and the number // of healthy hosts is not less than the minimum number of healthy hosts, then a // deployment to the next instance is attempted. During a deployment, the - // CodeDeploy agent runs the scripts specified for ApplicationStop, - // BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous - // successful deployment. (All other scripts are run from the AppSpec file in the - // current deployment.) If one of these scripts contains an error and does not run - // successfully, the deployment can fail. If the cause of the failure is a script - // from the last successful deployment that will never run successfully, create a - // new deployment and use ignoreApplicationStopFailures to specify that the - // ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be - // ignored. + // CodeDeploy agent runs the scripts specified for ApplicationStop , + // BeforeBlockTraffic , and AfterBlockTraffic in the AppSpec file from the + // previous successful deployment. (All other scripts are run from the AppSpec file + // in the current deployment.) If one of these scripts contains an error and does + // not run successfully, the deployment can fail. If the cause of the failure is a + // script from the last successful deployment that will never run successfully, + // create a new deployment and use ignoreApplicationStopFailures to specify that + // the ApplicationStop , BeforeBlockTraffic , and AfterBlockTraffic failures + // should be ignored. IgnoreApplicationStopFailures bool // Indicates whether the wait period set for the termination of instances in the @@ -478,8 +461,8 @@ type DeploymentOverview struct { // The number of instances in the deployment in a pending state. Pending int64 - // The number of instances in a replacement environment ready to receive traffic in - // a blue/green deployment. + // The number of instances in a replacement environment ready to receive traffic + // in a blue/green deployment. Ready int64 // The number of instances in the deployment in a skipped state. @@ -498,21 +481,18 @@ type DeploymentReadyOption struct { // Information about when to reroute traffic from an original environment to a // replacement environment in a blue/green deployment. - // - // * CONTINUE_DEPLOYMENT: - // Register new instances with the load balancer immediately after the new - // application revision is installed on the instances in the replacement - // environment. - // - // * STOP_DEPLOYMENT: Do not register new instances with a load - // balancer unless traffic rerouting is started using ContinueDeployment. If - // traffic rerouting is not started before the end of the specified wait period, - // the deployment status is changed to Stopped. + // - CONTINUE_DEPLOYMENT: Register new instances with the load balancer + // immediately after the new application revision is installed on the instances in + // the replacement environment. + // - STOP_DEPLOYMENT: Do not register new instances with a load balancer unless + // traffic rerouting is started using ContinueDeployment . If traffic rerouting + // is not started before the end of the specified wait period, the deployment + // status is changed to Stopped. ActionOnTimeout DeploymentReadyAction // The number of minutes to wait before the status of a blue/green deployment is // changed to Stopped if rerouting is not started manually. Applies only to the - // STOP_DEPLOYMENT option for actionOnTimeout. + // STOP_DEPLOYMENT option for actionOnTimeout . WaitTimeInMinutes int32 noSmithyDocumentSerde @@ -562,24 +542,15 @@ type DeploymentTarget struct { type Diagnostics struct { // The associated error code: - // - // * Success: The specified script ran. - // - // * - // ScriptMissing: The specified script was not found in the specified location. - // - // * - // ScriptNotExecutable: The specified script is not a recognized executable file - // type. - // - // * ScriptTimedOut: The specified script did not finish running in the - // specified time period. - // - // * ScriptFailed: The specified script failed to run as - // expected. - // - // * UnknownError: The specified script did not run for an unknown - // reason. + // - Success: The specified script ran. + // - ScriptMissing: The specified script was not found in the specified + // location. + // - ScriptNotExecutable: The specified script is not a recognized executable + // file type. + // - ScriptTimedOut: The specified script did not finish running in the + // specified time period. + // - ScriptFailed: The specified script failed to run as expected. + // - UnknownError: The specified script did not run for an unknown reason. ErrorCode LifecycleErrorCode // The last portion of the diagnostic log. If available, CodeDeploy returns up to @@ -602,13 +573,9 @@ type EC2TagFilter struct { Key *string // The tag filter type: - // - // * KEY_ONLY: Key only. - // - // * VALUE_ONLY: Value only. - // - // * - // KEY_AND_VALUE: Key and value. + // - KEY_ONLY : Key only. + // - VALUE_ONLY : Value only. + // - KEY_AND_VALUE : Key and value. Type EC2TagFilterType // The tag filter value. @@ -660,7 +627,7 @@ type ECSTarget struct { // The Amazon Resource Name (ARN) of the target. TargetArn *string - // The unique ID of a deployment target that has a type of ecsTarget. + // The unique ID of a deployment target that has a type of ecsTarget . TargetId *string // The ECSTaskSet objects associated with the ECS target. @@ -682,7 +649,7 @@ type ECSTaskSet struct { // created, CodeDeploy shifts traffic to the new task set. DesiredCount int64 - // A unique ID of an ECSTaskSet. + // A unique ID of an ECSTaskSet . Identifer *string // The number of tasks in the task set that are in the PENDING status during an @@ -696,24 +663,18 @@ type ECSTaskSet struct { RunningCount int64 // The status of the task set. There are three valid task set statuses: - // - // * PRIMARY: - // Indicates the task set is serving production traffic. - // - // * ACTIVE: Indicates the - // task set is not serving production traffic. - // - // * DRAINING: Indicates the tasks in - // the task set are being stopped and their corresponding targets are being - // deregistered from their target group. + // - PRIMARY : Indicates the task set is serving production traffic. + // - ACTIVE : Indicates the task set is not serving production traffic. + // - DRAINING : Indicates the tasks in the task set are being stopped and their + // corresponding targets are being deregistered from their target group. Status *string // The target group associated with the task set. The target group is used by // CodeDeploy to manage traffic to a task set. TargetGroup *TargetGroupInfo - // A label that identifies whether the ECS task set is an original target (BLUE) or - // a replacement target (GREEN). + // A label that identifies whether the ECS task set is an original target ( BLUE ) + // or a replacement target ( GREEN ). TaskSetLabel TargetLabel // The percentage of traffic served by this task set. @@ -740,55 +701,32 @@ type ELBInfo struct { // Information about a deployment error. type ErrorInformation struct { - // For more information, see Error Codes for CodeDeploy - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html) in - // the CodeDeploy User Guide - // (https://docs.aws.amazon.com/codedeploy/latest/userguide). The error code: - // - // * - // APPLICATION_MISSING: The application was missing. This error code is most likely - // raised if the application is deleted after the deployment is created, but before - // it is started. - // - // * DEPLOYMENT_GROUP_MISSING: The deployment group was missing. - // This error code is most likely raised if the deployment group is deleted after - // the deployment is created, but before it is started. - // - // * HEALTH_CONSTRAINTS: The - // deployment failed on too many instances to be successfully deployed within the - // instance health constraints specified. - // - // * HEALTH_CONSTRAINTS_INVALID: The - // revision cannot be successfully deployed within the instance health constraints - // specified. - // - // * IAM_ROLE_MISSING: The service role cannot be accessed. - // - // * - // IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions. - // - // * - // INTERNAL_ERROR: There was an internal error. - // - // * NO_EC2_SUBSCRIPTION: The calling - // account is not subscribed to Amazon EC2. - // - // * NO_INSTANCES: No instances were - // specified, or no instances can be found. - // - // * OVER_MAX_INSTANCES: The maximum - // number of instances was exceeded. - // - // * THROTTLED: The operation was throttled - // because the calling account exceeded the throttling limits of one or more Amazon - // Web Services services. - // - // * TIMEOUT: The deployment has timed out. - // - // * - // REVISION_MISSING: The revision ID was missing. This error code is most likely - // raised if the revision is deleted after the deployment is created, but before it - // is started. + // For more information, see Error Codes for CodeDeploy (https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html) + // in the CodeDeploy User Guide (https://docs.aws.amazon.com/codedeploy/latest/userguide) + // . The error code: + // - APPLICATION_MISSING: The application was missing. This error code is most + // likely raised if the application is deleted after the deployment is created, but + // before it is started. + // - DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code + // is most likely raised if the deployment group is deleted after the deployment is + // created, but before it is started. + // - HEALTH_CONSTRAINTS: The deployment failed on too many instances to be + // successfully deployed within the instance health constraints specified. + // - HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed + // within the instance health constraints specified. + // - IAM_ROLE_MISSING: The service role cannot be accessed. + // - IAM_ROLE_PERMISSIONS: The service role does not have the correct + // permissions. + // - INTERNAL_ERROR: There was an internal error. + // - NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2. + // - NO_INSTANCES: No instances were specified, or no instances can be found. + // - OVER_MAX_INSTANCES: The maximum number of instances was exceeded. + // - THROTTLED: The operation was throttled because the calling account exceeded + // the throttling limits of one or more Amazon Web Services services. + // - TIMEOUT: The deployment has timed out. + // - REVISION_MISSING: The revision ID was missing. This error code is most + // likely raised if the revision is deleted after the deployment is created, but + // before it is started. Code ErrorCode // An accompanying error message. @@ -838,13 +776,10 @@ type GitHubLocation struct { type GreenFleetProvisioningOption struct { // The method used to add instances to a replacement environment. - // - // * - // DISCOVER_EXISTING: Use instances that already exist or will be created - // manually. - // - // * COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling - // group to define and create instances in a new Auto Scaling group. + // - DISCOVER_EXISTING : Use instances that already exist or will be created + // manually. + // - COPY_AUTO_SCALING_GROUP : Use settings from a specified Auto Scaling group + // to define and create instances in a new Auto Scaling group. Action GreenFleetProvisioningAction noSmithyDocumentSerde @@ -889,11 +824,8 @@ type InstanceSummary struct { // Information about which environment an instance belongs to in a blue/green // deployment. - // - // * BLUE: The instance is part of the original environment. - // - // * GREEN: - // The instance is part of the replacement environment. + // - BLUE: The instance is part of the original environment. + // - GREEN: The instance is part of the replacement environment. InstanceType InstanceType // A timestamp that indicates when the instance information was last updated. @@ -903,23 +835,12 @@ type InstanceSummary struct { LifecycleEvents []LifecycleEvent // The deployment status for this instance: - // - // * Pending: The deployment is pending - // for this instance. - // - // * In Progress: The deployment is in progress for this - // instance. - // - // * Succeeded: The deployment has succeeded for this instance. - // - // * - // Failed: The deployment has failed for this instance. - // - // * Skipped: The deployment - // has been skipped for this instance. - // - // * Unknown: The deployment status is unknown - // for this instance. + // - Pending : The deployment is pending for this instance. + // - In Progress : The deployment is in progress for this instance. + // - Succeeded : The deployment has succeeded for this instance. + // - Failed : The deployment has failed for this instance. + // - Skipped : The deployment has been skipped for this instance. + // - Unknown : The deployment status is unknown for this instance. // // Deprecated: InstanceStatus is deprecated, use TargetStatus instead. Status InstanceStatus @@ -934,8 +855,8 @@ type InstanceTarget struct { // The unique ID of a deployment. DeploymentId *string - // A label that identifies whether the instance is an original target (BLUE) or a - // replacement target (GREEN). + // A label that identifies whether the instance is an original target ( BLUE ) or a + // replacement target ( GREEN ). InstanceLabel TargetLabel // The date and time when the target instance was updated by a deployment. @@ -950,7 +871,7 @@ type InstanceTarget struct { // The Amazon Resource Name (ARN) of the target. TargetArn *string - // The unique ID of a deployment target that has a type of instanceTarget. + // The unique ID of a deployment target that has a type of instanceTarget . TargetId *string noSmithyDocumentSerde @@ -1002,7 +923,7 @@ type LambdaTarget struct { // The Amazon Resource Name (ARN) of the target. TargetArn *string - // The unique ID of a deployment target that has a type of lambdaTarget. + // The unique ID of a deployment target that has a type of lambdaTarget . TargetId *string noSmithyDocumentSerde @@ -1038,31 +959,20 @@ type LifecycleEvent struct { // A timestamp that indicates when the deployment lifecycle event ended. EndTime *time.Time - // The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, - // AfterInstall, ApplicationStart, or ValidateService. + // The deployment lifecycle event name, such as ApplicationStop , BeforeInstall , + // AfterInstall , ApplicationStart , or ValidateService . LifecycleEventName *string // A timestamp that indicates when the deployment lifecycle event started. StartTime *time.Time // The deployment lifecycle event status: - // - // * Pending: The deployment lifecycle - // event is pending. - // - // * InProgress: The deployment lifecycle event is in - // progress. - // - // * Succeeded: The deployment lifecycle event ran successfully. - // - // * - // Failed: The deployment lifecycle event has failed. - // - // * Skipped: The deployment - // lifecycle event has been skipped. - // - // * Unknown: The deployment lifecycle event is - // unknown. + // - Pending: The deployment lifecycle event is pending. + // - InProgress: The deployment lifecycle event is in progress. + // - Succeeded: The deployment lifecycle event ran successfully. + // - Failed: The deployment lifecycle event has failed. + // - Skipped: The deployment lifecycle event has been skipped. + // - Unknown: The deployment lifecycle event is unknown. Status LifecycleEventStatus noSmithyDocumentSerde @@ -1095,30 +1005,24 @@ type LoadBalancerInfo struct { type MinimumHealthyHosts struct { // The minimum healthy instance type: - // - // * HOST_COUNT: The minimum number of healthy - // instances as an absolute value. - // - // * FLEET_PERCENT: The minimum number of healthy - // instances as a percentage of the total number of instances in the - // deployment. - // - // In an example of nine instances, if a HOST_COUNT of six is - // specified, deploy to up to three instances at a time. The deployment is - // successful if six or more instances are deployed to successfully. Otherwise, the - // deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five - // instances at a time. The deployment is successful if four or more instances are - // deployed to successfully. Otherwise, the deployment fails. In a call to the - // GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy - // instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to - // only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only - // to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, - // CodeDeploy attempts to ensure that all instances but one are kept in a healthy - // state during the deployment. Although this allows one instance at a time to be - // taken offline for a new deployment, it also means that if the deployment to the - // last instance fails, the overall deployment is still successful. For more - // information, see CodeDeploy Instance Health - // (https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) + // - HOST_COUNT : The minimum number of healthy instances as an absolute value. + // - FLEET_PERCENT : The minimum number of healthy instances as a percentage of + // the total number of instances in the deployment. + // In an example of nine instances, if a HOST_COUNT of six is specified, deploy to + // up to three instances at a time. The deployment is successful if six or more + // instances are deployed to successfully. Otherwise, the deployment fails. If a + // FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The + // deployment is successful if four or more instances are deployed to successfully. + // Otherwise, the deployment fails. In a call to the GetDeploymentConfig , + // CodeDeployDefault.OneAtATime returns a minimum healthy instance type of + // MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance + // at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or + // FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, CodeDeploy + // attempts to ensure that all instances but one are kept in a healthy state during + // the deployment. Although this allows one instance at a time to be taken offline + // for a new deployment, it also means that if the deployment to the last instance + // fails, the overall deployment is still successful. For more information, see + // CodeDeploy Instance Health (https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) // in the CodeDeploy User Guide. Type MinimumHealthyHostsType @@ -1191,19 +1095,14 @@ type RevisionLocation struct { GitHubLocation *GitHubLocation // The type of application revision: - // - // * S3: An application revision stored in - // Amazon S3. - // - // * GitHub: An application revision stored in GitHub (EC2/On-premises - // deployments only). - // - // * String: A YAML-formatted or JSON-formatted string (Lambda - // deployments only). - // - // * AppSpecContent: An AppSpecContent object that contains the - // contents of an AppSpec file for an Lambda or Amazon ECS deployment. The content - // is formatted as JSON or YAML stored as a RawString. + // - S3: An application revision stored in Amazon S3. + // - GitHub: An application revision stored in GitHub (EC2/On-premises + // deployments only). + // - String: A YAML-formatted or JSON-formatted string (Lambda deployments + // only). + // - AppSpecContent: An AppSpecContent object that contains the contents of an + // AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as + // JSON or YAML stored as a RawString. RevisionType RevisionLocationType // Information about the location of a revision stored in Amazon S3. @@ -1244,14 +1143,9 @@ type S3Location struct { Bucket *string // The file type of the application revision. Must be one of the following: - // - // * tar: - // A tar archive file. - // - // * tgz: A compressed tar archive file. - // - // * zip: A zip archive - // file. + // - tar : A tar archive file. + // - tgz : A compressed tar archive file. + // - zip : A zip archive file. BundleType BundleType // The ETag of the Amazon S3 object that represents the bundled artifacts for the @@ -1263,9 +1157,9 @@ type S3Location struct { // application revision. Key *string - // A specific version of the Amazon S3 object that represents the bundled artifacts - // for the application revision. If the version is not specified, the system uses - // the most recent version by default. + // A specific version of the Amazon S3 object that represents the bundled + // artifacts for the application revision. If the version is not specified, the + // system uses the most recent version by default. Version *string noSmithyDocumentSerde @@ -1290,13 +1184,9 @@ type TagFilter struct { Key *string // The on-premises instance tag filter type: - // - // * KEY_ONLY: Key only. - // - // * VALUE_ONLY: - // Value only. - // - // * KEY_AND_VALUE: Key and value. + // - KEY_ONLY: Key only. + // - VALUE_ONLY: Value only. + // - KEY_AND_VALUE: Key and value. Type TagFilterType // The on-premises instance tag filter value. @@ -1352,12 +1242,12 @@ type TargetInstances struct { // Information about the groups of Amazon EC2 instance tags that an instance must // be identified by in order for it to be included in the replacement environment - // for a blue/green deployment. Cannot be used in the same call as tagFilters. + // for a blue/green deployment. Cannot be used in the same call as tagFilters . Ec2TagSet *EC2TagSet // The tag filter key, type, and value used to identify Amazon EC2 instances in a // replacement environment for a blue/green deployment. Cannot be used in the same - // call as ec2TagSet. + // call as ec2TagSet . TagFilters []EC2TagFilter noSmithyDocumentSerde @@ -1380,10 +1270,10 @@ type TimeBasedCanary struct { noSmithyDocumentSerde } -// A configuration that shifts traffic from one version of a Lambda function or ECS -// task set to another in equal increments, with an equal number of minutes between -// each increment. The original and target Lambda function versions or ECS task -// sets are specified in the deployment's AppSpec file. +// A configuration that shifts traffic from one version of a Lambda function or +// ECS task set to another in equal increments, with an equal number of minutes +// between each increment. The original and target Lambda function versions or ECS +// task sets are specified in the deployment's AppSpec file. type TimeBasedLinear struct { // The number of minutes between each incremental traffic shift of a @@ -1427,9 +1317,10 @@ type TrafficRoute struct { // Amazon ECS task set to another during an Amazon ECS deployment. type TrafficRoutingConfig struct { - // A configuration that shifts traffic from one version of a Lambda function or ECS - // task set to another in two increments. The original and target Lambda function - // versions or ECS task sets are specified in the deployment's AppSpec file. + // A configuration that shifts traffic from one version of a Lambda function or + // ECS task set to another in two increments. The original and target Lambda + // function versions or ECS task sets are specified in the deployment's AppSpec + // file. TimeBasedCanary *TimeBasedCanary // A configuration that shifts traffic from one version of a Lambda function or @@ -1438,7 +1329,7 @@ type TrafficRoutingConfig struct { // or Amazon ECS task sets are specified in the deployment's AppSpec file. TimeBasedLinear *TimeBasedLinear - // The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a + // The type of traffic shifting ( TimeBasedCanary or TimeBasedLinear ) used by a // deployment configuration. Type TrafficRoutingType diff --git a/service/codeguruprofiler/api_client.go b/service/codeguruprofiler/api_client.go index 07d86e4cf07..948d84f1573 100644 --- a/service/codeguruprofiler/api_client.go +++ b/service/codeguruprofiler/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go b/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go index 57c6eade791..97bc1b64dc2 100644 --- a/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go +++ b/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go @@ -43,15 +43,15 @@ type BatchGetFrameMetricDataInput struct { // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. EndTime *time.Time - // The details of the metrics that are used to request a time series of values. The - // metric includes the name of the frame, the aggregation type to calculate the + // The details of the metrics that are used to request a time series of values. + // The metric includes the name of the frame, the aggregation type to calculate the // metric value for the frame, and the thread states to use to get the count for // the metric value of the frame. FrameMetrics []types.FrameMetric - // The duration of the frame metrics used to return the time series values. Specify - // using the ISO 8601 format. The maximum period duration is one day (PT24H or - // P1D). + // The duration of the frame metrics used to return the time series values. + // Specify using the ISO 8601 format. The maximum period duration is one day ( PT24H + // or P1D ). Period *string // The start time of the time period for the frame metrics used to return the time @@ -64,13 +64,9 @@ type BatchGetFrameMetricDataInput struct { // If the requested target resolution is not available due to data not being // retained we provide a best effort result by falling back to the most granular // available resolution after the target resolution. There are 3 valid values. - // - // * - // P1D — 1 day - // - // * PT1H — 1 hour - // - // * PT5M — 5 minutes + // - P1D — 1 day + // - PT1H — 1 hour + // - PT5M — 5 minutes TargetResolution types.AggregationPeriod noSmithyDocumentSerde @@ -87,8 +83,8 @@ type BatchGetFrameMetricDataOutput struct { EndTime *time.Time // List of instances, or time steps, in the time series. For example, if the period - // is one day (PT24H)), and the resolution is five minutes (PT5M), then there are - // 288 endTimes in the list that are each five minutes appart. + // is one day ( PT24H) ), and the resolution is five minutes ( PT5M ), then there + // are 288 endTimes in the list that are each five minutes appart. // // This member is required. EndTimes []types.TimestampStructure @@ -104,12 +100,9 @@ type BatchGetFrameMetricDataOutput struct { // Resolution or granularity of the profile data used to generate the time series. // This is the value used to jump through time steps in a time series. There are 3 // valid values. - // - // * P1D — 1 day - // - // * PT1H — 1 hour - // - // * PT5M — 5 minutes + // - P1D — 1 day + // - PT1H — 1 hour + // - PT5M — 5 minutes // // This member is required. Resolution types.AggregationPeriod diff --git a/service/codeguruprofiler/api_op_ConfigureAgent.go b/service/codeguruprofiler/api_op_ConfigureAgent.go index 44018b0a1e9..04a95f1c842 100644 --- a/service/codeguruprofiler/api_op_ConfigureAgent.go +++ b/service/codeguruprofiler/api_op_ConfigureAgent.go @@ -38,43 +38,27 @@ type ConfigureAgentInput struct { // This member is required. ProfilingGroupName *string - // A universally unique identifier (UUID) for a profiling instance. For example, if - // the profiling instance is an Amazon EC2 instance, it is the instance ID. If it - // is an AWS Fargate container, it is the container's task ID. + // A universally unique identifier (UUID) for a profiling instance. For example, + // if the profiling instance is an Amazon EC2 instance, it is the instance ID. If + // it is an AWS Fargate container, it is the container's task ID. FleetInstanceId *string // Metadata captured about the compute platform the agent is running on. It // includes information about sampling and reporting. The valid fields are: - // - // * - // COMPUTE_PLATFORM - The compute platform on which the agent is running - // - // * - // AGENT_ID - The ID for an agent instance. - // - // * AWS_REQUEST_ID - The AWS request ID - // of a Lambda invocation. - // - // * EXECUTION_ENVIRONMENT - The execution environment a - // Lambda function is running on. - // - // * LAMBDA_FUNCTION_ARN - The Amazon Resource Name - // (ARN) that is used to invoke a Lambda function. - // - // * LAMBDA_MEMORY_LIMIT_IN_MB - - // The memory allocated to a Lambda function. - // - // * - // LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before - // execution of a Lambda function times out. - // - // * - // LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds - // between two invocations of a Lambda function. - // - // * - // LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for - // the previous Lambda invocation. + // - COMPUTE_PLATFORM - The compute platform on which the agent is running + // - AGENT_ID - The ID for an agent instance. + // - AWS_REQUEST_ID - The AWS request ID of a Lambda invocation. + // - EXECUTION_ENVIRONMENT - The execution environment a Lambda function is + // running on. + // - LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke + // a Lambda function. + // - LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function. + // - LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before + // execution of a Lambda function times out. + // - LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds + // between two invocations of a Lambda function. + // - LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds + // for the previous Lambda invocation. Metadata map[string]string noSmithyDocumentSerde @@ -83,8 +67,7 @@ type ConfigureAgentInput struct { // The structure representing the configureAgentResponse. type ConfigureAgentOutput struct { - // An AgentConfiguration - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html) + // An AgentConfiguration (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html) // object that specifies if an agent profiles or not and for how long to return // profiling data. // diff --git a/service/codeguruprofiler/api_op_CreateProfilingGroup.go b/service/codeguruprofiler/api_op_CreateProfilingGroup.go index b6bdf832ba2..78917e52ffd 100644 --- a/service/codeguruprofiler/api_op_CreateProfilingGroup.go +++ b/service/codeguruprofiler/api_op_CreateProfilingGroup.go @@ -62,8 +62,7 @@ type CreateProfilingGroupInput struct { // The structure representing the createProfilingGroupResponse. type CreateProfilingGroupOutput struct { - // The returned ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // The returned ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // object that contains information about the created profiling group. // // This member is required. diff --git a/service/codeguruprofiler/api_op_DescribeProfilingGroup.go b/service/codeguruprofiler/api_op_DescribeProfilingGroup.go index d042d8b3d3b..b9576f6af56 100644 --- a/service/codeguruprofiler/api_op_DescribeProfilingGroup.go +++ b/service/codeguruprofiler/api_op_DescribeProfilingGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a ProfilingGroupDescription -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) +// Returns a ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // object that contains information about the requested profiling group. func (c *Client) DescribeProfilingGroup(ctx context.Context, params *DescribeProfilingGroupInput, optFns ...func(*Options)) (*DescribeProfilingGroupOutput, error) { if params == nil { @@ -43,8 +42,7 @@ type DescribeProfilingGroupInput struct { // The structure representing the describeProfilingGroupResponse. type DescribeProfilingGroupOutput struct { - // The returned ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // The returned ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // object that contains information about the requested profiling group. // // This member is required. diff --git a/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go b/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go index 30e21e33b1d..e6e39bc83ec 100644 --- a/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go +++ b/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of FindingsReportSummary -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) +// Returns a list of FindingsReportSummary (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) // objects that contain analysis results for all profiling groups in your AWS // account. func (c *Client) GetFindingsReportAccountSummary(ctx context.Context, params *GetFindingsReportAccountSummaryInput, optFns ...func(*Options)) (*GetFindingsReportAccountSummaryOutput, error) { @@ -35,17 +34,17 @@ func (c *Client) GetFindingsReportAccountSummary(ctx context.Context, params *Ge type GetFindingsReportAccountSummaryInput struct { // A Boolean value indicating whether to only return reports from daily profiles. - // If set to True, only analysis data from daily profiles is returned. If set to - // False, analysis data is returned from smaller time windows (for example, one + // If set to True , only analysis data from daily profiles is returned. If set to + // False , analysis data is returned from smaller time windows (for example, one // hour). DailyReportsOnly *bool // The maximum number of results returned by GetFindingsReportAccountSummary in // paginated output. When this parameter is used, GetFindingsReportAccountSummary - // only returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another GetFindingsReportAccountSummary request with the returned nextToken - // value. + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another GetFindingsReportAccountSummary request with the returned + // nextToken value. MaxResults *int32 // The nextToken value returned from a previous paginated @@ -62,8 +61,7 @@ type GetFindingsReportAccountSummaryInput struct { // The structure representing the GetFindingsReportAccountSummaryResponse. type GetFindingsReportAccountSummaryOutput struct { - // The return list of FindingsReportSummary - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) + // The return list of FindingsReportSummary (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) // objects taht contain summaries of analysis results for all profiling groups in // your AWS account. // @@ -72,7 +70,7 @@ type GetFindingsReportAccountSummaryOutput struct { // The nextToken value to include in a future GetFindingsReportAccountSummary // request. When the results of a GetFindingsReportAccountSummary request exceed - // maxResults, this value can be used to retrieve the next page of results. This + // maxResults , this value can be used to retrieve the next page of results. This // value is null when there are no more results to return. NextToken *string @@ -155,10 +153,10 @@ var _ GetFindingsReportAccountSummaryAPIClient = (*Client)(nil) type GetFindingsReportAccountSummaryPaginatorOptions struct { // The maximum number of results returned by GetFindingsReportAccountSummary in // paginated output. When this parameter is used, GetFindingsReportAccountSummary - // only returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another GetFindingsReportAccountSummary request with the returned nextToken - // value. + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another GetFindingsReportAccountSummary request with the returned + // nextToken value. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeguruprofiler/api_op_GetPolicy.go b/service/codeguruprofiler/api_op_GetPolicy.go index f023e5ca7ad..da6ee2030ee 100644 --- a/service/codeguruprofiler/api_op_GetPolicy.go +++ b/service/codeguruprofiler/api_op_GetPolicy.go @@ -26,7 +26,7 @@ func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns . return out, nil } -// The structure representing the getPolicyRequest. +// The structure representing the getPolicyRequest . type GetPolicyInput struct { // The name of the profiling group. @@ -37,10 +37,10 @@ type GetPolicyInput struct { noSmithyDocumentSerde } -// The structure representing the getPolicyResponse. +// The structure representing the getPolicyResponse . type GetPolicyOutput struct { - // The JSON-formatted resource-based policy attached to the ProfilingGroup. + // The JSON-formatted resource-based policy attached to the ProfilingGroup . // // This member is required. Policy *string diff --git a/service/codeguruprofiler/api_op_GetProfile.go b/service/codeguruprofiler/api_op_GetProfile.go index fa74c8142d4..95b041089fc 100644 --- a/service/codeguruprofiler/api_op_GetProfile.go +++ b/service/codeguruprofiler/api_op_GetProfile.go @@ -15,46 +15,36 @@ import ( // Amazon CodeGuru Profiler collects posted agent profiles for a profiling group // into aggregated profiles. Because aggregated profiles expire over time // GetProfile is not idempotent. Specify the time range for the requested -// aggregated profile using 1 or 2 of the following parameters: startTime, endTime, -// period. The maximum time range allowed is 7 days. If you specify all 3 -// parameters, an exception is thrown. If you specify only period, the latest +// aggregated profile using 1 or 2 of the following parameters: startTime , endTime +// , period . The maximum time range allowed is 7 days. If you specify all 3 +// parameters, an exception is thrown. If you specify only period , the latest // aggregated profile is returned. Aggregated profiles are available with // aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The // aggregation period of an aggregated profile determines how long it is retained. -// For more information, see AggregatedProfileTime -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html). -// The aggregated profile's aggregation period determines how long +// For more information, see AggregatedProfileTime (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html) +// . The aggregated profile's aggregation period determines how long // -// it is retained -// by CodeGuru Profiler. +// it is retained by CodeGuru Profiler. +// - If the aggregation period is 5 minutes, the aggregated profile is retained +// for 15 days. +// - If the aggregation period is 1 hour, the aggregated profile is retained for +// 60 days. +// - If the aggregation period is 1 day, the aggregated profile is retained for +// 3 years. // -// * If the aggregation period is 5 minutes, the aggregated -// profile is retained for 15 days. -// -// * If the aggregation period is 1 hour, the -// aggregated profile is retained for 60 days. -// -// * If the aggregation period is 1 -// day, the aggregated profile is retained for 3 years. -// -// There are two use cases -// for calling GetProfile. -// -// * If you want to return an aggregated profile that -// already exists, use ListProfileTimes -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html) -// to view the time ranges of existing aggregated profiles. Use them in a -// GetProfile request to return a specific, existing aggregated profile. -// -// * If you -// want to return an aggregated profile for a time range that doesn't align with an -// existing aggregated profile, then CodeGuru Profiler makes a best effort to -// combine existing aggregated profiles from the requested time range and return -// them as one aggregated profile. If aggregated profiles do not exist for the full -// time range requested, then aggregated profiles for a smaller time range are -// returned. For example, if the requested time range is from 00:00 to 00:20, and -// the existing aggregated profiles are from 00:15 and 00:25, then the aggregated -// profiles from 00:15 to 00:20 are returned. +// There are two use cases for calling GetProfile . +// - If you want to return an aggregated profile that already exists, use +// ListProfileTimes (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html) +// to view the time ranges of existing aggregated profiles. Use them in a +// GetProfile request to return a specific, existing aggregated profile. +// - If you want to return an aggregated profile for a time range that doesn't +// align with an existing aggregated profile, then CodeGuru Profiler makes a best +// effort to combine existing aggregated profiles from the requested time range and +// return them as one aggregated profile. If aggregated profiles do not exist for +// the full time range requested, then aggregated profiles for a smaller time range +// are returned. For example, if the requested time range is from 00:00 to 00:20, +// and the existing aggregated profiles are from 00:15 and 00:25, then the +// aggregated profiles from 00:15 to 00:20 are returned. func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error) { if params == nil { params = &GetProfileInput{} @@ -81,36 +71,33 @@ type GetProfileInput struct { // The format of the returned profiling data. The format maps to the Accept and // Content-Type headers of the HTTP request. You can specify one of the following: // or the default . - // - // * application/json — standard JSON format - // - // * - // application/x-amzn-ion — the Amazon Ion data format. For more information, see - // Amazon Ion (http://amzn.github.io/ion-docs/). + // - application/json — standard JSON format + // - application/x-amzn-ion — the Amazon Ion data format. For more information, + // see Amazon Ion (http://amzn.github.io/ion-docs/) . Accept *string // The end time of the requested profile. Specify using the ISO 8601 format. For // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 - // 1:15:02 PM UTC. If you specify endTime, then you must also specify period or - // startTime, but not both. + // 1:15:02 PM UTC. If you specify endTime , then you must also specify period or + // startTime , but not both. EndTime *time.Time // The maximum depth of the stacks in the code that is represented in the - // aggregated profile. For example, if CodeGuru Profiler finds a method A, which - // calls method B, which calls method C, which calls method D, then the depth is 4. - // If the maxDepth is set to 2, then the aggregated profile contains - // representations of methods A and B. + // aggregated profile. For example, if CodeGuru Profiler finds a method A , which + // calls method B , which calls method C , which calls method D , then the depth is + // 4. If the maxDepth is set to 2, then the aggregated profile contains + // representations of methods A and B . MaxDepth *int32 // Used with startTime or endTime to specify the time range for the returned - // aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. - // To get the latest aggregated profile, specify only period. + // aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S . + // To get the latest aggregated profile, specify only period . Period *string // The start time of the profile to get. Specify using the ISO 8601 format. For // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 - // 1:15:02 PM UTC. If you specify startTime, then you must also specify period or - // endTime, but not both. + // 1:15:02 PM UTC. If you specify startTime , then you must also specify period or + // endTime , but not both. StartTime *time.Time noSmithyDocumentSerde @@ -119,8 +106,8 @@ type GetProfileInput struct { // The structure representing the getProfileResponse. type GetProfileOutput struct { - // The content type of the profile in the payload. It is either application/json or - // the default application/x-amzn-ion. + // The content type of the profile in the payload. It is either application/json + // or the default application/x-amzn-ion . // // This member is required. ContentType *string diff --git a/service/codeguruprofiler/api_op_GetRecommendations.go b/service/codeguruprofiler/api_op_GetRecommendations.go index 6d81594c46e..e4d5b1fa784 100644 --- a/service/codeguruprofiler/api_op_GetRecommendations.go +++ b/service/codeguruprofiler/api_op_GetRecommendations.go @@ -12,11 +12,9 @@ import ( "time" ) -// Returns a list of Recommendation -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html) +// Returns a list of Recommendation (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html) // objects that contain recommendations for a profiling group for a given time -// period. A list of Anomaly -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html) +// period. A list of Anomaly (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html) // objects that contains details about anomalies detected in the profiling group // for the same time period is also returned. func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { @@ -38,9 +36,9 @@ func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendati type GetRecommendationsInput struct { // The start time of the profile to get analysis data about. You must specify - // startTime and endTime. This is specified using the ISO 8601 format. For example, - // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM - // UTC. + // startTime and endTime . This is specified using the ISO 8601 format. For + // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 + // 1:15:02 PM UTC. // // This member is required. EndTime *time.Time @@ -51,41 +49,26 @@ type GetRecommendationsInput struct { ProfilingGroupName *string // The end time of the profile to get analysis data about. You must specify - // startTime and endTime. This is specified using the ISO 8601 format. For example, - // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM - // UTC. + // startTime and endTime . This is specified using the ISO 8601 format. For + // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 + // 1:15:02 PM UTC. // // This member is required. StartTime *time.Time - // The language used to provide analysis. Specify using a string that is one of the - // following BCP 47 language codes. - // - // * de-DE - German, Germany - // - // * en-GB - English, - // United Kingdom - // - // * en-US - English, United States - // - // * es-ES - Spanish, Spain - // - // * - // fr-FR - French, France - // - // * it-IT - Italian, Italy - // - // * ja-JP - Japanese, Japan - // - // * - // ko-KR - Korean, Republic of Korea - // - // * pt-BR - Portugese, Brazil - // - // * zh-CN - - // Chinese, China - // - // * zh-TW - Chinese, Taiwan + // The language used to provide analysis. Specify using a string that is one of + // the following BCP 47 language codes. + // - de-DE - German, Germany + // - en-GB - English, United Kingdom + // - en-US - English, United States + // - es-ES - Spanish, Spain + // - fr-FR - French, France + // - it-IT - Italian, Italy + // - ja-JP - Japanese, Japan + // - ko-KR - Korean, Republic of Korea + // - pt-BR - Portugese, Brazil + // - zh-CN - Chinese, China + // - zh-TW - Chinese, Taiwan Locale *string noSmithyDocumentSerde diff --git a/service/codeguruprofiler/api_op_ListFindingsReports.go b/service/codeguruprofiler/api_op_ListFindingsReports.go index 5b4df28535a..52ff5d7cd0e 100644 --- a/service/codeguruprofiler/api_op_ListFindingsReports.go +++ b/service/codeguruprofiler/api_op_ListFindingsReports.go @@ -33,9 +33,9 @@ func (c *Client) ListFindingsReports(ctx context.Context, params *ListFindingsRe type ListFindingsReportsInput struct { // The end time of the profile to get analysis data about. You must specify - // startTime and endTime. This is specified using the ISO 8601 format. For example, - // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM - // UTC. + // startTime and endTime . This is specified using the ISO 8601 format. For + // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 + // 1:15:02 PM UTC. // // This member is required. EndTime *time.Time @@ -46,32 +46,32 @@ type ListFindingsReportsInput struct { ProfilingGroupName *string // The start time of the profile to get analysis data about. You must specify - // startTime and endTime. This is specified using the ISO 8601 format. For example, - // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM - // UTC. + // startTime and endTime . This is specified using the ISO 8601 format. For + // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 + // 1:15:02 PM UTC. // // This member is required. StartTime *time.Time // A Boolean value indicating whether to only return reports from daily profiles. - // If set to True, only analysis data from daily profiles is returned. If set to - // False, analysis data is returned from smaller time windows (for example, one + // If set to True , only analysis data from daily profiles is returned. If set to + // False , analysis data is returned from smaller time windows (for example, one // hour). DailyReportsOnly *bool // The maximum number of report results returned by ListFindingsReports in // paginated output. When this parameter is used, ListFindingsReports only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another + // maxResults results in a single page along with a nextToken response element. + // The remaining results of the initial request can be seen by sending another // ListFindingsReports request with the returned nextToken value. MaxResults *int32 // The nextToken value returned from a previous paginated // ListFindingsReportsRequest request where maxResults was used and the results // exceeded the value of that parameter. Pagination continues from the end of the - // previous results that returned the nextToken value. This token should be treated - // as an opaque identifier that is only used to retrieve the next items in a list - // and not for other programmatic purposes. + // previous results that returned the nextToken value. This token should be + // treated as an opaque identifier that is only used to retrieve the next items in + // a list and not for other programmatic purposes. NextToken *string noSmithyDocumentSerde @@ -85,10 +85,10 @@ type ListFindingsReportsOutput struct { // This member is required. FindingsReportSummaries []types.FindingsReportSummary - // The nextToken value to include in a future ListFindingsReports request. When the - // results of a ListFindingsReports request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListFindingsReports request. When + // the results of a ListFindingsReports request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -160,8 +160,8 @@ func (c *Client) addOperationListFindingsReportsMiddlewares(stack *middleware.St return nil } -// ListFindingsReportsAPIClient is a client that implements the ListFindingsReports -// operation. +// ListFindingsReportsAPIClient is a client that implements the +// ListFindingsReports operation. type ListFindingsReportsAPIClient interface { ListFindingsReports(context.Context, *ListFindingsReportsInput, ...func(*Options)) (*ListFindingsReportsOutput, error) } @@ -173,8 +173,8 @@ var _ ListFindingsReportsAPIClient = (*Client)(nil) type ListFindingsReportsPaginatorOptions struct { // The maximum number of report results returned by ListFindingsReports in // paginated output. When this parameter is used, ListFindingsReports only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another + // maxResults results in a single page along with a nextToken response element. + // The remaining results of the initial request can be seen by sending another // ListFindingsReports request with the returned nextToken value. Limit int32 diff --git a/service/codeguruprofiler/api_op_ListProfileTimes.go b/service/codeguruprofiler/api_op_ListProfileTimes.go index a4e5af8f4a9..5abb6efda0c 100644 --- a/service/codeguruprofiler/api_op_ListProfileTimes.go +++ b/service/codeguruprofiler/api_op_ListProfileTimes.go @@ -41,12 +41,9 @@ type ListProfileTimesInput struct { // The aggregation period. This specifies the period during which an aggregation // profile collects posted agent profiles for a profiling group. There are 3 valid // values. - // - // * P1D — 1 day - // - // * PT1H — 1 hour - // - // * PT5M — 5 minutes + // - P1D — 1 day + // - PT1H — 1 hour + // - PT5M — 5 minutes // // This member is required. Period types.AggregationPeriod @@ -77,7 +74,7 @@ type ListProfileTimesInput struct { NextToken *string // The order (ascending or descending by start time of the profile) to use when - // listing profiles. Defaults to TIMESTAMP_DESCENDING. + // listing profiles. Defaults to TIMESTAMP_DESCENDING . OrderBy types.OrderBy noSmithyDocumentSerde @@ -93,7 +90,7 @@ type ListProfileTimesOutput struct { ProfileTimes []types.ProfileTime // The nextToken value to include in a future ListProfileTimes request. When the - // results of a ListProfileTimes request exceed maxResults, this value can be used + // results of a ListProfileTimes request exceed maxResults , this value can be used // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/codeguruprofiler/api_op_ListProfilingGroups.go b/service/codeguruprofiler/api_op_ListProfilingGroups.go index efebee6c262..881c875b5a0 100644 --- a/service/codeguruprofiler/api_op_ListProfilingGroups.go +++ b/service/codeguruprofiler/api_op_ListProfilingGroups.go @@ -13,8 +13,7 @@ import ( ) // Returns a list of profiling groups. The profiling groups are returned as -// ProfilingGroupDescription -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) +// ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects. func (c *Client) ListProfilingGroups(ctx context.Context, params *ListProfilingGroupsInput, optFns ...func(*Options)) (*ListProfilingGroupsOutput, error) { if params == nil { @@ -34,11 +33,10 @@ func (c *Client) ListProfilingGroups(ctx context.Context, params *ListProfilingG // The structure representing the listProfilingGroupsRequest. type ListProfilingGroupsInput struct { - // A Boolean value indicating whether to include a description. If true, then a - // list of ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // A Boolean value indicating whether to include a description. If true , then a + // list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects that contain detailed information about profiling groups is returned. If - // false, then a list of profiling group names is returned. + // false , then a list of profiling group names is returned. IncludeDescription *bool // The maximum number of profiling groups results returned by ListProfilingGroups @@ -63,24 +61,21 @@ type ListProfilingGroupsInput struct { type ListProfilingGroupsOutput struct { // A returned list of profiling group names. A list of the names is returned only - // if includeDescription is false, otherwise a list of ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // if includeDescription is false , otherwise a list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects is returned. // // This member is required. ProfilingGroupNames []string - // The nextToken value to include in a future ListProfilingGroups request. When the - // results of a ListProfilingGroups request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListProfilingGroups request. When + // the results of a ListProfilingGroups request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string - // A returned list ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) - // objects. A list of ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) - // objects is returned only if includeDescription is true, otherwise a list of + // A returned list ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // objects. A list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // objects is returned only if includeDescription is true , otherwise a list of // profiling group names is returned. ProfilingGroups []types.ProfilingGroupDescription @@ -150,8 +145,8 @@ func (c *Client) addOperationListProfilingGroupsMiddlewares(stack *middleware.St return nil } -// ListProfilingGroupsAPIClient is a client that implements the ListProfilingGroups -// operation. +// ListProfilingGroupsAPIClient is a client that implements the +// ListProfilingGroups operation. type ListProfilingGroupsAPIClient interface { ListProfilingGroups(context.Context, *ListProfilingGroupsInput, ...func(*Options)) (*ListProfilingGroupsOutput, error) } diff --git a/service/codeguruprofiler/api_op_PostAgentProfile.go b/service/codeguruprofiler/api_op_PostAgentProfile.go index 7ba5414ba0a..1d50fbfc8f4 100644 --- a/service/codeguruprofiler/api_op_PostAgentProfile.go +++ b/service/codeguruprofiler/api_op_PostAgentProfile.go @@ -12,8 +12,8 @@ import ( ) // Submits profiling data to an aggregated profile of a profiling group. To get an -// aggregated profile that is created with this profiling data, use GetProfile -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html). +// aggregated profile that is created with this profiling data, use GetProfile (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html) +// . func (c *Client) PostAgentProfile(ctx context.Context, params *PostAgentProfileInput, optFns ...func(*Options)) (*PostAgentProfileOutput, error) { if params == nil { params = &PostAgentProfileInput{} @@ -40,12 +40,9 @@ type PostAgentProfileInput struct { // The format of the submitted profiling data. The format maps to the Accept and // Content-Type headers of the HTTP request. You can specify one of the following: // or the default . - // - // * application/json — standard JSON format - // - // * - // application/x-amzn-ion — the Amazon Ion data format. For more information, see - // Amazon Ion (http://amzn.github.io/ion-docs/). + // - application/json — standard JSON format + // - application/x-amzn-ion — the Amazon Ion data format. For more information, + // see Amazon Ion (http://amzn.github.io/ion-docs/) . // // This member is required. ContentType *string diff --git a/service/codeguruprofiler/api_op_PutPermission.go b/service/codeguruprofiler/api_op_PutPermission.go index e86b6e5568e..a5cebf36d55 100644 --- a/service/codeguruprofiler/api_op_PutPermission.go +++ b/service/codeguruprofiler/api_op_PutPermission.go @@ -14,19 +14,16 @@ import ( // Adds permissions to a profiling group's resource-based policy that are provided // using an action group. If a profiling group doesn't have a resource-based // policy, one is created for it using the permissions in the action group and the -// roles and users in the principals parameter. The one supported action group that -// can be added is agentPermission which grants ConfigureAgent and PostAgent +// roles and users in the principals parameter. The one supported action group +// that can be added is agentPermission which grants ConfigureAgent and PostAgent // permissions. For more information, see Resource-based policies in CodeGuru -// Profiler -// (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) -// in the Amazon CodeGuru Profiler User Guide, ConfigureAgent -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), -// and PostAgentProfile -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html). -// The first time you call PutPermission on a profiling group, do not specify a +// Profiler (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) +// in the Amazon CodeGuru Profiler User Guide, ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) +// , and PostAgentProfile (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html) +// . The first time you call PutPermission on a profiling group, do not specify a // revisionId because it doesn't have a resource-based policy. Subsequent calls -// must provide a revisionId to specify which revision of the resource-based policy -// to add the permissions to. The response contains the profiling group's +// must provide a revisionId to specify which revision of the resource-based +// policy to add the permissions to. The response contains the profiling group's // JSON-formatted resource policy. func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { if params == nil { @@ -43,11 +40,11 @@ func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, return out, nil } -// The structure representing the putPermissionRequest. +// The structure representing the putPermissionRequest . type PutPermissionInput struct { // Specifies an action group that contains permissions to add to a profiling group - // resource. One action group is supported, agentPermissions, which grants + // resource. One action group is supported, agentPermissions , which grants // permission to perform actions required by the profiling agent, ConfigureAgent // and PostAgentProfile permissions. // @@ -68,13 +65,13 @@ type PutPermissionInput struct { // A universally unique identifier (UUID) for the revision of the policy you are // adding to the profiling group. Do not specify this when you add permissions to a // profiling group for the first time. If a policy already exists on the profiling - // group, you must specify the revisionId. + // group, you must specify the revisionId . RevisionId *string noSmithyDocumentSerde } -// The structure representing the putPermissionResponse. +// The structure representing the putPermissionResponse . type PutPermissionOutput struct { // The JSON-formatted resource-based policy on the profiling group that includes diff --git a/service/codeguruprofiler/api_op_RemovePermission.go b/service/codeguruprofiler/api_op_RemovePermission.go index 4a680cdbd8e..9bda6c89a53 100644 --- a/service/codeguruprofiler/api_op_RemovePermission.go +++ b/service/codeguruprofiler/api_op_RemovePermission.go @@ -15,12 +15,10 @@ import ( // provided using an action group. The one supported action group that can be // removed is agentPermission which grants ConfigureAgent and PostAgent // permissions. For more information, see Resource-based policies in CodeGuru -// Profiler -// (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) -// in the Amazon CodeGuru Profiler User Guide, ConfigureAgent -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), -// and PostAgentProfile -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html). +// Profiler (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) +// in the Amazon CodeGuru Profiler User Guide, ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) +// , and PostAgentProfile (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html) +// . func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} @@ -36,12 +34,12 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI return out, nil } -// The structure representing the removePermissionRequest. +// The structure representing the removePermissionRequest . type RemovePermissionInput struct { // Specifies an action group that contains the permissions to remove from a // profiling group's resource-based policy. One action group is supported, - // agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions. + // agentPermissions , which grants ConfigureAgent and PostAgentProfile permissions. // // This member is required. ActionGroup types.ActionGroup @@ -60,7 +58,7 @@ type RemovePermissionInput struct { noSmithyDocumentSerde } -// The structure representing the removePermissionResponse. +// The structure representing the removePermissionResponse . type RemovePermissionOutput struct { // The JSON-formatted resource-based policy on the profiling group after the diff --git a/service/codeguruprofiler/api_op_SubmitFeedback.go b/service/codeguruprofiler/api_op_SubmitFeedback.go index de1bc544c99..e207bb83ef5 100644 --- a/service/codeguruprofiler/api_op_SubmitFeedback.go +++ b/service/codeguruprofiler/api_op_SubmitFeedback.go @@ -31,8 +31,7 @@ func (c *Client) SubmitFeedback(ctx context.Context, params *SubmitFeedbackInput // The structure representing the SubmitFeedbackRequest. type SubmitFeedbackInput struct { - // The universally unique identifier (UUID) of the AnomalyInstance - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html) + // The universally unique identifier (UUID) of the AnomalyInstance (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html) // object that is included in the analysis data. // // This member is required. @@ -43,7 +42,7 @@ type SubmitFeedbackInput struct { // This member is required. ProfilingGroupName *string - // The feedback tpye. Thee are two valid values, Positive and Negative. + // The feedback tpye. Thee are two valid values, Positive and Negative . // // This member is required. Type types.FeedbackType diff --git a/service/codeguruprofiler/api_op_UpdateProfilingGroup.go b/service/codeguruprofiler/api_op_UpdateProfilingGroup.go index 58d721693aa..9bae639f5fb 100644 --- a/service/codeguruprofiler/api_op_UpdateProfilingGroup.go +++ b/service/codeguruprofiler/api_op_UpdateProfilingGroup.go @@ -46,8 +46,7 @@ type UpdateProfilingGroupInput struct { // The structure representing the updateProfilingGroupResponse. type UpdateProfilingGroupOutput struct { - // A ProfilingGroupDescription - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) + // A ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // that contains information about the returned updated profiling group. // // This member is required. diff --git a/service/codeguruprofiler/doc.go b/service/codeguruprofiler/doc.go index 5b90a291a90..85cb2ccb6d4 100644 --- a/service/codeguruprofiler/doc.go +++ b/service/codeguruprofiler/doc.go @@ -16,7 +16,6 @@ // Profiler supports both visualizations and recommendations for applications // written in Java, it can also generate visualizations and a subset of // recommendations for applications written in other JVM languages and Python. For -// more information, see What is Amazon CodeGuru Profiler -// (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html) +// more information, see What is Amazon CodeGuru Profiler (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html) // in the Amazon CodeGuru Profiler User Guide. package codeguruprofiler diff --git a/service/codeguruprofiler/types/enums.go b/service/codeguruprofiler/types/enums.go index fc1c30996eb..4bf447aa77b 100644 --- a/service/codeguruprofiler/types/enums.go +++ b/service/codeguruprofiler/types/enums.go @@ -120,9 +120,9 @@ const ( FeedbackTypeNegative FeedbackType = "Negative" ) -// Values returns all known values for FeedbackType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FeedbackType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FeedbackType) Values() []FeedbackType { return []FeedbackType{ "Positive", diff --git a/service/codeguruprofiler/types/errors.go b/service/codeguruprofiler/types/errors.go index b7d9e8187f1..56fa4b7faa4 100644 --- a/service/codeguruprofiler/types/errors.go +++ b/service/codeguruprofiler/types/errors.go @@ -88,9 +88,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have exceeded your service quota. To perform the requested action, remove -// some of the relevant resources, or use Service Quotas -// (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html) to -// request a service quota increase. +// some of the relevant resources, or use Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html) +// to request a service quota increase. type ServiceQuotaExceededException struct { Message *string diff --git a/service/codeguruprofiler/types/types.go b/service/codeguruprofiler/types/types.go index a1b3718fa06..03a5ec2c979 100644 --- a/service/codeguruprofiler/types/types.go +++ b/service/codeguruprofiler/types/types.go @@ -7,16 +7,13 @@ import ( "time" ) -// The response of ConfigureAgent -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) +// The response of ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) // that specifies if an agent profiles or not and for how long to return profiling // data. type AgentConfiguration struct { - // How long a profiling agent should send profiling data using ConfigureAgent - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html). - // For example, if this is set to 300, the profiling agent calls ConfigureAgent - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) + // How long a profiling agent should send profiling data using ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) + // . For example, if this is set to 300, the profiling agent calls ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) // every 5 minutes to submit the profiled data collected during that period. // // This member is required. @@ -29,33 +26,26 @@ type AgentConfiguration struct { ShouldProfile *bool // Parameters used by the profiler. The valid parameters are: - // - // * MaxStackDepth - - // The maximum depth of the stacks in the code that is represented in the profile. - // For example, if CodeGuru Profiler finds a method A, which calls method B, which - // calls method C, which calls method D, then the depth is 4. If the maxDepth is - // set to 2, then the profiler evaluates A and B. - // - // * MemoryUsageLimitPercent - The - // percentage of memory that is used by the profiler. - // - // * - // MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between - // sending reports. - // - // * ReportingIntervalInMilliseconds - The reporting interval in - // milliseconds used to report profiles. - // - // * SamplingIntervalInMilliseconds - The - // sampling interval in milliseconds that is used to profile samples. + // - MaxStackDepth - The maximum depth of the stacks in the code that is + // represented in the profile. For example, if CodeGuru Profiler finds a method A + // , which calls method B , which calls method C , which calls method D , then + // the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and + // B . + // - MemoryUsageLimitPercent - The percentage of memory that is used by the + // profiler. + // - MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds + // between sending reports. + // - ReportingIntervalInMilliseconds - The reporting interval in milliseconds + // used to report profiles. + // - SamplingIntervalInMilliseconds - The sampling interval in milliseconds that + // is used to profile samples. AgentParameters map[string]string noSmithyDocumentSerde } // Specifies whether profiling is enabled or disabled for a profiling group. It is -// used by ConfigureAgent -// (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) +// used by ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) // to enable or disable profiling for a profiling group. type AgentOrchestrationConfig struct { @@ -77,18 +67,14 @@ type AggregatedProfileTime struct { // The aggregation period. This indicates the period during which an aggregation // profile collects posted agent profiles for a profiling group. Use one of three // valid durations that are specified using the ISO 8601 format. - // - // * P1D — 1 day - // - // * - // PT1H — 1 hour - // - // * PT5M — 5 minutes + // - P1D — 1 day + // - PT1H — 1 hour + // - PT5M — 5 minutes Period AggregationPeriod - // The time that aggregation of posted agent profiles for a profiling group starts. - // The aggregation profile contains profiles posted by the agent starting at this - // time for an aggregation period specified by the period property of the + // The time that aggregation of posted agent profiles for a profiling group + // starts. The aggregation profile contains profiles posted by the agent starting + // at this time for an aggregation period specified by the period property of the // AggregatedProfileTime object. Specify start using the ISO 8601 format. For // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 // 1:15:02 PM UTC. @@ -138,9 +124,10 @@ type AnomalyInstance struct { // This member is required. StartTime *time.Time - // The end time of the period during which the metric is flagged as anomalous. This - // is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z - // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. + // The end time of the period during which the metric is flagged as anomalous. + // This is specified using the ISO 8601 format. For example, + // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM + // UTC. EndTime *time.Time // Feedback type on a specific instance of anomaly submitted by the user. @@ -181,9 +168,10 @@ type FindingsReportSummary struct { // The universally unique identifier (UUID) of the recommendation report. Id *string - // The end time of the period during which the metric is flagged as anomalous. This - // is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z - // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. + // The end time of the period during which the metric is flagged as anomalous. + // This is specified using the ISO 8601 format. For example, + // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM + // UTC. ProfileEndTime *time.Time // The start time of the profile the analysis data is about. This is specified @@ -305,8 +293,8 @@ type Pattern struct { // A list of the different counters used to determine if there is a match. CountersToAggregate []string - // The description of the recommendation. This explains a potential inefficiency in - // a profiled application. + // The description of the recommendation. This explains a potential inefficiency + // in a profiled application. Description *string // The universally unique identifier (UUID) of this pattern. @@ -345,19 +333,18 @@ type ProfileTime struct { // Contains information about a profiling group. type ProfilingGroupDescription struct { - // An AgentOrchestrationConfig - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html) + // An AgentOrchestrationConfig (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html) // object that indicates if the profiling group is enabled for profiled or not. AgentOrchestrationConfig *AgentOrchestrationConfig // The Amazon Resource Name (ARN) identifying the profiling group resource. Arn *string - // The compute platform of the profiling group. If it is set to AWSLambda, then the - // profiled application runs on AWS Lambda. If it is set to Default, then the + // The compute platform of the profiling group. If it is set to AWSLambda , then + // the profiled application runs on AWS Lambda. If it is set to Default , then the // profiled application runs on a compute platform that is not AWS Lambda, such an // Amazon EC2 instance, an on-premises server, or a different platform. The default - // is Default. + // is Default . ComputePlatform ComputePlatform // The time when the profiling group was created. Specify using the ISO 8601 @@ -368,8 +355,7 @@ type ProfilingGroupDescription struct { // The name of the profiling group. Name *string - // A ProfilingStatus - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html) + // A ProfilingStatus (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html) // object that includes information about the last time a profile agent pinged // back, the last time a profile was received, and the aggregation period and start // time for the most recent aggregated profile. @@ -386,9 +372,9 @@ type ProfilingGroupDescription struct { noSmithyDocumentSerde } -// Profiling status includes information about the last time a profile agent pinged -// back, the last time a profile was received, and the aggregation period and start -// time for the most recent aggregated profile. +// Profiling status includes information about the last time a profile agent +// pinged back, the last time a profile was received, and the aggregation period +// and start time for the most recent aggregated profile. type ProfilingStatus struct { // The date and time when the profiling agent most recently pinged back. Specify @@ -401,8 +387,7 @@ type ProfilingStatus struct { // past June 1, 2020 1:15:02 PM UTC. LatestAgentProfileReportedAt *time.Time - // An AggregatedProfileTime - // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html) + // An AggregatedProfileTime (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html) // object that contains the aggregation period and start time for an aggregated // profile. LatestAggregatedProfile *AggregatedProfileTime @@ -455,7 +440,7 @@ type Recommendation struct { // June 1, 2020 1:15:02 PM UTC. type TimestampStructure struct { - // A Timestamp. This is specified using the ISO 8601 format. For example, + // A Timestamp . This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM // UTC. // diff --git a/service/codegurureviewer/api_client.go b/service/codegurureviewer/api_client.go index 72f6660a88a..f74c06ba7ff 100644 --- a/service/codegurureviewer/api_client.go +++ b/service/codegurureviewer/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codegurureviewer/api_op_AssociateRepository.go b/service/codegurureviewer/api_op_AssociateRepository.go index 3afa0213c49..6fd965634f9 100644 --- a/service/codegurureviewer/api_op_AssociateRepository.go +++ b/service/codegurureviewer/api_op_AssociateRepository.go @@ -17,20 +17,17 @@ import ( // Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code // changes in the repository's pull requests and provides automatic // recommendations. You can view recommendations using the CodeGuru Reviewer -// console. For more information, see Recommendations in Amazon CodeGuru Reviewer -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html) +// console. For more information, see Recommendations in Amazon CodeGuru Reviewer (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html) // in the Amazon CodeGuru Reviewer User Guide. If you associate a CodeCommit or S3 // repository, it must be in the same Amazon Web Services Region and Amazon Web // Services account where its CodeGuru Reviewer code reviews are configured. // Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web // Services CodeStar Connections to connect to CodeGuru Reviewer. For more -// information, see Associate a repository -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html) +// information, see Associate a repository (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html) // in the Amazon CodeGuru Reviewer User Guide. You cannot use the CodeGuru Reviewer // SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon // CodeGuru Reviewer. To associate a GitHub repository, use the console. For more -// information, see Getting started with CodeGuru Reviewer -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html) +// information, see Getting started with CodeGuru Reviewer (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html) // in the CodeGuru Reviewer User Guide. func (c *Client) AssociateRepository(ctx context.Context, params *AssociateRepositoryInput, optFns ...func(*Options)) (*AssociateRepositoryOutput, error) { if params == nil { @@ -59,26 +56,20 @@ type AssociateRepositoryInput struct { ClientRequestToken *string // A KMSKeyDetails object that contains: - // - // * The encryption option for this - // repository association. It is either owned by Amazon Web Services Key Management - // Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). - // - // * The - // ID of the Amazon Web Services KMS key that is associated with this repository - // association. + // - The encryption option for this repository association. It is either owned + // by Amazon Web Services Key Management Service (KMS) ( AWS_OWNED_CMK ) or + // customer managed ( CUSTOMER_MANAGED_CMK ). + // - The ID of the Amazon Web Services KMS key that is associated with this + // repository association. KMSKeyDetails *types.KMSKeyDetails // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. Tags map[string]string noSmithyDocumentSerde @@ -91,14 +82,11 @@ type AssociateRepositoryOutput struct { // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/codegurureviewer/api_op_CreateCodeReview.go b/service/codegurureviewer/api_op_CreateCodeReview.go index 641f05e6fe2..225eb3f26eb 100644 --- a/service/codegurureviewer/api_op_CreateCodeReview.go +++ b/service/codegurureviewer/api_op_CreateCodeReview.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use to create a code review with a CodeReviewType -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) -// of RepositoryAnalysis. This type of code review analyzes all code under a +// Use to create a code review with a CodeReviewType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) +// of RepositoryAnalysis . This type of code review analyzes all code under a // specified branch in an associated repository. PullRequest code reviews are // automatically triggered by a pull request. func (c *Client) CreateCodeReview(ctx context.Context, params *CreateCodeReviewInput, optFns ...func(*Options)) (*CreateCodeReviewOutput, error) { @@ -40,19 +39,16 @@ type CreateCodeReviewInput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). - // A code review can only be created on an associated repository. This is the ARN + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . A code review can only be created on an associated repository. This is the ARN // of the associated repository. // // This member is required. RepositoryAssociationArn *string - // The type of code review to create. This is specified using a CodeReviewType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) - // object. You can create a code review only of type RepositoryAnalysis. + // The type of code review to create. This is specified using a CodeReviewType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) + // object. You can create a code review only of type RepositoryAnalysis . // // This member is required. Type *types.CodeReviewType diff --git a/service/codegurureviewer/api_op_DescribeCodeReview.go b/service/codegurureviewer/api_op_DescribeCodeReview.go index 9e2f3379730..4c73b9c345d 100644 --- a/service/codegurureviewer/api_op_DescribeCodeReview.go +++ b/service/codegurureviewer/api_op_DescribeCodeReview.go @@ -34,8 +34,7 @@ func (c *Client) DescribeCodeReview(ctx context.Context, params *DescribeCodeRev type DescribeCodeReviewInput struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. // // This member is required. @@ -140,9 +139,10 @@ type CodeReviewCompletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CodeReviewCompletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CodeReviewCompletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -182,9 +182,9 @@ func NewCodeReviewCompletedWaiter(client DescribeCodeReviewAPIClient, optFns ... } } -// Wait calls the waiter function for CodeReviewCompleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for CodeReviewCompleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *CodeReviewCompletedWaiter) Wait(ctx context.Context, params *DescribeCodeReviewInput, maxWaitDur time.Duration, optFns ...func(*CodeReviewCompletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go index ff7dda26281..f52491b8567 100644 --- a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go @@ -29,15 +29,14 @@ func (c *Client) DescribeRecommendationFeedback(ctx context.Context, params *Des type DescribeRecommendationFeedbackInput struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. // // This member is required. CodeReviewArn *string - // The recommendation ID that can be used to track the provided recommendations and - // then to collect the feedback. + // The recommendation ID that can be used to track the provided recommendations + // and then to collect the feedback. // // This member is required. RecommendationId *string @@ -45,8 +44,7 @@ type DescribeRecommendationFeedbackInput struct { // Optional parameter to describe the feedback for a given user. If this is not // supplied, it defaults to the user making the request. The UserId is an IAM // principal that can be specified as an Amazon Web Services account ID or an - // Amazon Resource Name (ARN). For more information, see Specifying a Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) + // Amazon Resource Name (ARN). For more information, see Specifying a Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) // in the Amazon Web Services Identity and Access Management User Guide. UserId *string diff --git a/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go b/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go index 7e4e05c5288..243ab2a87a7 100644 --- a/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go +++ b/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go @@ -16,8 +16,7 @@ import ( "time" ) -// Returns a RepositoryAssociation -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) +// Returns a RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) // object that contains information about the requested repository association. func (c *Client) DescribeRepositoryAssociation(ctx context.Context, params *DescribeRepositoryAssociationInput, optFns ...func(*Options)) (*DescribeRepositoryAssociationOutput, error) { if params == nil { @@ -36,10 +35,9 @@ func (c *Client) DescribeRepositoryAssociation(ctx context.Context, params *Desc type DescribeRepositoryAssociationInput struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . // // This member is required. AssociationArn *string @@ -54,14 +52,11 @@ type DescribeRepositoryAssociationOutput struct { // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. Tags map[string]string // Metadata pertaining to the operation's result. @@ -156,10 +151,10 @@ type RepositoryAssociationSucceededWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RepositoryAssociationSucceededWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RepositoryAssociationSucceededWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/codegurureviewer/api_op_DisassociateRepository.go b/service/codegurureviewer/api_op_DisassociateRepository.go index 2c6dae63ae0..3dfb39798eb 100644 --- a/service/codegurureviewer/api_op_DisassociateRepository.go +++ b/service/codegurureviewer/api_op_DisassociateRepository.go @@ -29,10 +29,9 @@ func (c *Client) DisassociateRepository(ctx context.Context, params *Disassociat type DisassociateRepositoryInput struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . // // This member is required. AssociationArn *string @@ -47,14 +46,11 @@ type DisassociateRepositoryOutput struct { // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/codegurureviewer/api_op_ListCodeReviews.go b/service/codegurureviewer/api_op_ListCodeReviews.go index fe187692ac1..0ac3a1c521e 100644 --- a/service/codegurureviewer/api_op_ListCodeReviews.go +++ b/service/codegurureviewer/api_op_ListCodeReviews.go @@ -55,16 +55,10 @@ type ListCodeReviewsInput struct { // List of states for filtering that needs to be applied before displaying the // result. For example, states=[Pending] lists code reviews in the Pending state. // The valid code review states are: - // - // * Completed: The code review is complete. - // - // * - // Pending: The code review started and has not completed or failed. - // - // * Failed: The - // code review failed. - // - // * Deleting: The code review is being deleted. + // - Completed : The code review is complete. + // - Pending : The code review started and has not completed or failed. + // - Failed : The code review failed. + // - Deleting : The code review is being deleted. States []types.JobState noSmithyDocumentSerde diff --git a/service/codegurureviewer/api_op_ListRecommendationFeedback.go b/service/codegurureviewer/api_op_ListRecommendationFeedback.go index 21655f98b61..f3ddee92aff 100644 --- a/service/codegurureviewer/api_op_ListRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_ListRecommendationFeedback.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of RecommendationFeedbackSummary -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html) +// Returns a list of RecommendationFeedbackSummary (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html) // objects that contain customer recommendation feedback for all CodeGuru Reviewer // users. func (c *Client) ListRecommendationFeedback(ctx context.Context, params *ListRecommendationFeedbackInput, optFns ...func(*Options)) (*ListRecommendationFeedbackOutput, error) { @@ -33,8 +32,7 @@ func (c *Client) ListRecommendationFeedback(ctx context.Context, params *ListRec type ListRecommendationFeedbackInput struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. // // This member is required. @@ -52,12 +50,11 @@ type ListRecommendationFeedbackInput struct { // Used to query the recommendation feedback for a given recommendation. RecommendationIds []string - // An Amazon Web Services user's account ID or Amazon Resource Name (ARN). Use this - // ID to query the recommendation feedback for a code review from that user. The - // UserId is an IAM principal that can be specified as an Amazon Web Services + // An Amazon Web Services user's account ID or Amazon Resource Name (ARN). Use + // this ID to query the recommendation feedback for a code review from that user. + // The UserId is an IAM principal that can be specified as an Amazon Web Services // account ID or an Amazon Resource Name (ARN). For more information, see - // Specifying a Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) + // Specifying a Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) // in the Amazon Web Services Identity and Access Management User Guide. UserIds []string diff --git a/service/codegurureviewer/api_op_ListRecommendations.go b/service/codegurureviewer/api_op_ListRecommendations.go index 5205adc890d..dcd229aca00 100644 --- a/service/codegurureviewer/api_op_ListRecommendations.go +++ b/service/codegurureviewer/api_op_ListRecommendations.go @@ -30,8 +30,7 @@ func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommenda type ListRecommendationsInput struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. // // This member is required. @@ -123,8 +122,8 @@ func (c *Client) addOperationListRecommendationsMiddlewares(stack *middleware.St return nil } -// ListRecommendationsAPIClient is a client that implements the ListRecommendations -// operation. +// ListRecommendationsAPIClient is a client that implements the +// ListRecommendations operation. type ListRecommendationsAPIClient interface { ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error) } diff --git a/service/codegurureviewer/api_op_ListRepositoryAssociations.go b/service/codegurureviewer/api_op_ListRepositoryAssociations.go index fc8b124b98d..42589447e6c 100644 --- a/service/codegurureviewer/api_op_ListRepositoryAssociations.go +++ b/service/codegurureviewer/api_op_ListRepositoryAssociations.go @@ -12,17 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of RepositoryAssociationSummary -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html) +// Returns a list of RepositoryAssociationSummary (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html) // objects that contain summary information about a repository association. You can -// filter the returned list by ProviderType -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType), -// Name -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name), -// State -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State), -// and Owner -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner). +// filter the returned list by ProviderType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType) +// , Name (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name) +// , State (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State) +// , and Owner (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner) +// . func (c *Client) ListRepositoryAssociations(ctx context.Context, params *ListRepositoryAssociationsInput, optFns ...func(*Options)) (*ListRepositoryAssociationsOutput, error) { if params == nil { params = &ListRepositoryAssociationsInput{} @@ -42,12 +38,12 @@ type ListRepositoryAssociationsInput struct { // The maximum number of repository association results returned by // ListRepositoryAssociations in paginated output. When this parameter is used, - // ListRepositoryAssociations only returns maxResults results in a single page with - // a nextToken response element. The remaining results of the initial request can - // be seen by sending another ListRepositoryAssociations request with the returned - // nextToken value. This value can be between 1 and 100. If this parameter is not - // used, ListRepositoryAssociations returns up to 100 results and a nextToken value - // if applicable. + // ListRepositoryAssociations only returns maxResults results in a single page + // with a nextToken response element. The remaining results of the initial request + // can be seen by sending another ListRepositoryAssociations request with the + // returned nextToken value. This value can be between 1 and 100. If this + // parameter is not used, ListRepositoryAssociations returns up to 100 results and + // a nextToken value if applicable. MaxResults *int32 // List of repository names to use as a filter. @@ -61,9 +57,9 @@ type ListRepositoryAssociationsInput struct { // for other programmatic purposes. NextToken *string - // List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the - // name of the CodeCommit account that was used to associate the repository. For - // other repository source providers, such as Bitbucket and GitHub Enterprise + // List of owners to use as a filter. For Amazon Web Services CodeCommit, it is + // the name of the CodeCommit account that was used to associate the repository. + // For other repository source providers, such as Bitbucket and GitHub Enterprise // Server, this is name of the account that was used to associate the repository. Owners []string @@ -72,37 +68,24 @@ type ListRepositoryAssociationsInput struct { // List of repository association states to use as a filter. The valid repository // association states are: - // - // * Associated: The repository association is - // complete. - // - // * Associating: CodeGuru Reviewer is: - // - // * Setting up pull request - // notifications. This is required for pull requests to trigger a CodeGuru Reviewer - // review. If your repository ProviderType is GitHub, GitHub Enterprise Server, or - // Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger - // CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your - // repository cannot be triggered. - // - // * Setting up source code access. This is - // required for CodeGuru Reviewer to securely clone code in your repository. - // - // * - // Failed: The repository failed to associate or disassociate. - // - // * Disassociating: - // CodeGuru Reviewer is removing the repository's pull request notifications and - // source code access. - // - // * Disassociated: CodeGuru Reviewer successfully - // disassociated the repository. You can create a new association with this - // repository if you want to review source code in it later. You can control access - // to code reviews created in anassociated repository with tags after it has been - // disassociated. For more information, see Using tags to control access to - // associated repositories - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) - // in the Amazon CodeGuru Reviewer User Guide. + // - Associated: The repository association is complete. + // - Associating: CodeGuru Reviewer is: + // - Setting up pull request notifications. This is required for pull requests + // to trigger a CodeGuru Reviewer review. If your repository ProviderType is + // GitHub , GitHub Enterprise Server , or Bitbucket , CodeGuru Reviewer creates + // webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete + // these webhooks, reviews of code in your repository cannot be triggered. + // - Setting up source code access. This is required for CodeGuru Reviewer to + // securely clone code in your repository. + // - Failed: The repository failed to associate or disassociate. + // - Disassociating: CodeGuru Reviewer is removing the repository's pull request + // notifications and source code access. + // - Disassociated: CodeGuru Reviewer successfully disassociated the repository. + // You can create a new association with this repository if you want to review + // source code in it later. You can control access to code reviews created in + // anassociated repository with tags after it has been disassociated. For more + // information, see Using tags to control access to associated repositories (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) + // in the Amazon CodeGuru Reviewer User Guide. States []types.RepositoryAssociationState noSmithyDocumentSerde @@ -110,10 +93,10 @@ type ListRepositoryAssociationsInput struct { type ListRepositoryAssociationsOutput struct { - // The nextToken value to include in a future ListRecommendations request. When the - // results of a ListRecommendations request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListRecommendations request. When + // the results of a ListRecommendations request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // A list of repository associations that meet the criteria of the request. @@ -198,12 +181,12 @@ var _ ListRepositoryAssociationsAPIClient = (*Client)(nil) type ListRepositoryAssociationsPaginatorOptions struct { // The maximum number of repository association results returned by // ListRepositoryAssociations in paginated output. When this parameter is used, - // ListRepositoryAssociations only returns maxResults results in a single page with - // a nextToken response element. The remaining results of the initial request can - // be seen by sending another ListRepositoryAssociations request with the returned - // nextToken value. This value can be between 1 and 100. If this parameter is not - // used, ListRepositoryAssociations returns up to 100 results and a nextToken value - // if applicable. + // ListRepositoryAssociations only returns maxResults results in a single page + // with a nextToken response element. The remaining results of the initial request + // can be seen by sending another ListRepositoryAssociations request with the + // returned nextToken value. This value can be between 1 and 100. If this + // parameter is not used, ListRepositoryAssociations returns up to 100 results and + // a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codegurureviewer/api_op_ListTagsForResource.go b/service/codegurureviewer/api_op_ListTagsForResource.go index 65902d96a19..ff3e2257db7 100644 --- a/service/codegurureviewer/api_op_ListTagsForResource.go +++ b/service/codegurureviewer/api_op_ListTagsForResource.go @@ -28,10 +28,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . // // This member is required. ResourceArn *string @@ -43,14 +42,11 @@ type ListTagsForResourceOutput struct { // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/codegurureviewer/api_op_PutRecommendationFeedback.go b/service/codegurureviewer/api_op_PutRecommendationFeedback.go index a2b127303ae..b64e1a58346 100644 --- a/service/codegurureviewer/api_op_PutRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_PutRecommendationFeedback.go @@ -30,8 +30,7 @@ func (c *Client) PutRecommendationFeedback(ctx context.Context, params *PutRecom type PutRecommendationFeedbackInput struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. // // This member is required. @@ -43,8 +42,8 @@ type PutRecommendationFeedbackInput struct { // This member is required. Reactions []types.Reaction - // The recommendation ID that can be used to track the provided recommendations and - // then to collect the feedback. + // The recommendation ID that can be used to track the provided recommendations + // and then to collect the feedback. // // This member is required. RecommendationId *string diff --git a/service/codegurureviewer/api_op_TagResource.go b/service/codegurureviewer/api_op_TagResource.go index fbba2714cea..02df13b04ad 100644 --- a/service/codegurureviewer/api_op_TagResource.go +++ b/service/codegurureviewer/api_op_TagResource.go @@ -28,24 +28,20 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . // // This member is required. ResourceArn *string // An array of key-value pairs used to tag an associated repository. A tag is a // custom attribute label with two parts: - // - // * A tag key (for example, CostCenter, - // Environment, Project, or Secret). Tag keys are case sensitive. - // - // * An optional - // field known as a tag value (for example, 111122223333, Production, or a team - // name). Omitting the tag value is the same as using an empty string. Like tag - // keys, tag values are case sensitive. + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case sensitive. // // This member is required. Tags map[string]string diff --git a/service/codegurureviewer/api_op_UntagResource.go b/service/codegurureviewer/api_op_UntagResource.go index 41483266a47..73d0bcbc930 100644 --- a/service/codegurureviewer/api_op_UntagResource.go +++ b/service/codegurureviewer/api_op_UntagResource.go @@ -28,10 +28,9 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . // // This member is required. ResourceArn *string diff --git a/service/codegurureviewer/doc.go b/service/codegurureviewer/doc.go index 17ae7300078..db064dce505 100644 --- a/service/codegurureviewer/doc.go +++ b/service/codegurureviewer/doc.go @@ -10,12 +10,10 @@ // detecting and providing recommendations for addressing code defects and // implementing best practices, CodeGuru Reviewer improves the overall quality and // maintainability of your code base during the code review stage. For more -// information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html). To -// improve the security of your CodeGuru Reviewer API calls, you can establish a -// private connection between your VPC and CodeGuru Reviewer by creating an +// information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html) +// . To improve the security of your CodeGuru Reviewer API calls, you can establish +// a private connection between your VPC and CodeGuru Reviewer by creating an // interface VPC endpoint. For more information, see CodeGuru Reviewer and -// interface VPC endpoints (Amazon Web Services PrivateLink) -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html) +// interface VPC endpoints (Amazon Web Services PrivateLink) (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html) // in the Amazon CodeGuru Reviewer User Guide. package codegurureviewer diff --git a/service/codegurureviewer/types/enums.go b/service/codegurureviewer/types/enums.go index 7f83da8307e..44948dd917b 100644 --- a/service/codegurureviewer/types/enums.go +++ b/service/codegurureviewer/types/enums.go @@ -10,9 +10,9 @@ const ( AnalysisTypeCodeQuality AnalysisType = "CodeQuality" ) -// Values returns all known values for AnalysisType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AnalysisType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AnalysisType) Values() []AnalysisType { return []AnalysisType{ "Security", @@ -91,9 +91,9 @@ const ( ProviderTypeS3Bucket ProviderType = "S3Bucket" ) -// Values returns all known values for ProviderType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProviderType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProviderType) Values() []ProviderType { return []ProviderType{ "CodeCommit", diff --git a/service/codegurureviewer/types/types.go b/service/codegurureviewer/types/types.go index 5de86c28f45..77700e70987 100644 --- a/service/codegurureviewer/types/types.go +++ b/service/codegurureviewer/types/types.go @@ -7,8 +7,7 @@ import ( "time" ) -// A type of SourceCodeType -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) +// A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies a code diff between a source and destination branch in an // associated repository. type BranchDiffSourceCodeType struct { @@ -28,12 +27,10 @@ type BranchDiffSourceCodeType struct { // Code artifacts are source code artifacts and build artifacts used in a // repository analysis or a pull request review. -// -// * Source code artifacts are -// source code files in a Git repository that are compressed into a .zip file. -// -// * -// Build artifacts are .jar or .class files that are compressed in a .zip file. +// - Source code artifacts are source code files in a Git repository that are +// compressed into a .zip file. +// - Build artifacts are .jar or .class files that are compressed in a .zip +// file. type CodeArtifacts struct { // The S3 object key for a source code .zip file. This is required for all code @@ -44,8 +41,7 @@ type CodeArtifacts struct { // The S3 object key for a build artifacts .zip file that contains .jar or .class // files. This is required for a code review with security analysis. For more - // information, see Create code reviews with GitHub Actions - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html) + // information, see Create code reviews with GitHub Actions (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html) // in the Amazon CodeGuru Reviewer User Guide. BuildArtifactsObjectKey *string @@ -57,9 +53,8 @@ type CodeArtifacts struct { // Services account where its CodeGuru Reviewer code reviews are configured. type CodeCommitRepository struct { - // The name of the Amazon Web Services CodeCommit repository. For more information, - // see repositoryName - // (https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName) + // The name of the Amazon Web Services CodeCommit repository. For more + // information, see repositoryName (https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName) // in the Amazon Web Services CodeCommit API Reference. // // This member is required. @@ -73,18 +68,16 @@ type CodeCommitRepository struct { type CodeReview struct { // The types of analysis performed during a repository analysis or a pull request - // review. You can specify either Security, CodeQuality, or both. + // review. You can specify either Security , CodeQuality , or both. AnalysisTypes []AnalysisType - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) // that contains the reviewed source code. You can retrieve associated repository - // ARNs by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // ARNs by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . AssociationArn *string - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. CodeReviewArn *string @@ -127,16 +120,10 @@ type CodeReview struct { SourceCodeType *SourceCodeType // The valid code review states are: - // - // * Completed: The code review is complete. - // - // * - // Pending: The code review started and has not completed or failed. - // - // * Failed: The - // code review failed. - // - // * Deleting: The code review is being deleted. + // - Completed : The code review is complete. + // - Pending : The code review started and has not completed or failed. + // - Failed : The code review failed. + // - Deleting : The code review is being deleted. State JobState // The reason for the state of the code review. @@ -151,8 +138,7 @@ type CodeReview struct { // Information about the summary of the code review. type CodeReviewSummary struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. CodeReviewArn *string @@ -189,17 +175,10 @@ type CodeReviewSummary struct { SourceCodeType *SourceCodeType // The state of the code review. The valid code review states are: - // - // * Completed: - // The code review is complete. - // - // * Pending: The code review started and has not - // completed or failed. - // - // * Failed: The code review failed. - // - // * Deleting: The code - // review is being deleted. + // - Completed : The code review is complete. + // - Pending : The code review started and has not completed or failed. + // - Failed : The code review failed. + // - Deleting : The code review is being deleted. State JobState // The type of the code review. @@ -209,34 +188,30 @@ type CodeReviewSummary struct { } // The type of a code review. There are two code review types: -// -// * PullRequest - A -// code review that is automatically triggered by a pull request on an associated -// repository. -// -// * RepositoryAnalysis - A code review that analyzes all code under a -// specified branch in an associated repository. The associated repository is -// specified using its ARN in CreateCodeReview -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). +// - PullRequest - A code review that is automatically triggered by a pull +// request on an associated repository. +// - RepositoryAnalysis - A code review that analyzes all code under a specified +// branch in an associated repository. The associated repository is specified using +// its ARN in CreateCodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview) +// . type CodeReviewType struct { // A code review that analyzes all code under a specified branch in an associated // repository. The associated repository is specified using its ARN in - // CreateCodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). + // CreateCodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview) + // . // // This member is required. RepositoryAnalysis *RepositoryAnalysis // They types of analysis performed during a repository analysis or a pull request - // review. You can specify either Security, CodeQuality, or both. + // review. You can specify either Security , CodeQuality , or both. AnalysisTypes []AnalysisType noSmithyDocumentSerde } -// A type of SourceCodeType -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) +// A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the commit diff for a pull request on an associated repository. // The SourceCommit and DestinationCommit fields are required to do a pull request // code review. @@ -260,8 +235,8 @@ type CommitDiffSourceCodeType struct { // request, or another type of event. type EventInfo struct { - // The name of the event. The possible names are pull_request, workflow_dispatch, - // schedule, and push + // The name of the event. The possible names are pull_request , workflow_dispatch , + // schedule , and push Name *string // The state of an event. The state might be open, closed, or another state. @@ -271,18 +246,16 @@ type EventInfo struct { } // An object that contains: -// -// * The encryption option for a repository association. -// It is either owned by Amazon Web Services Key Management Service (KMS) -// (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). -// -// * The ID of the -// Amazon Web Services KMS key that is associated with a repository association. +// - The encryption option for a repository association. It is either owned by +// Amazon Web Services Key Management Service (KMS) ( AWS_OWNED_CMK ) or customer +// managed ( CUSTOMER_MANAGED_CMK ). +// - The ID of the Amazon Web Services KMS key that is associated with a +// repository association. type KMSKeyDetails struct { - // The encryption option for a repository association. It is either owned by Amazon - // Web Services Key Management Service (KMS) (AWS_OWNED_CMK) or customer managed - // (CUSTOMER_MANAGED_CMK). + // The encryption option for a repository association. It is either owned by + // Amazon Web Services Key Management Service (KMS) ( AWS_OWNED_CMK ) or customer + // managed ( CUSTOMER_MANAGED_CMK ). EncryptionOption EncryptionOption // The ID of the Amazon Web Services KMS key that is associated with a repository @@ -332,14 +305,14 @@ type MetricsSummary struct { // 2,725 lines of code. MeteredLinesOfCodeCount *int64 - // Lines of code suppressed in the code review based on the excludeFiles element in - // the aws-codeguru-reviewer.yml file. For full repository analyses, this number - // includes all lines of code in the files that are suppressed. For pull requests, - // this number only includes the changed lines of code that are suppressed. In both - // cases, this number does not include non-code lines such as comments and import - // statements. For example, if you initiate a full repository analysis on a - // repository containing 5 files, each file with 100 lines of code, and 2 files are - // listed as excluded in the aws-codeguru-reviewer.yml file, then + // Lines of code suppressed in the code review based on the excludeFiles element + // in the aws-codeguru-reviewer.yml file. For full repository analyses, this + // number includes all lines of code in the files that are suppressed. For pull + // requests, this number only includes the changed lines of code that are + // suppressed. In both cases, this number does not include non-code lines such as + // comments and import statements. For example, if you initiate a full repository + // analysis on a repository containing 5 files, each file with 100 lines of code, + // and 2 files are listed as excluded in the aws-codeguru-reviewer.yml file, then // SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of lines of // code suppressed. However, if you submit a pull request for the same repository, // then SuppressedLinesOfCodeCount only includes the lines in the 2 files that @@ -354,8 +327,7 @@ type MetricsSummary struct { // Information about the recommendation feedback. type RecommendationFeedback struct { - // The Amazon Resource Name (ARN) of the CodeReview - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) + // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) // object. CodeReviewArn *string @@ -375,8 +347,7 @@ type RecommendationFeedback struct { // The ID of the user that made the API call. The UserId is an IAM principal that // can be specified as an Amazon Web Services account ID or an Amazon Resource Name - // (ARN). For more information, see Specifying a Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) + // (ARN). For more information, see Specifying a Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) // in the Amazon Web Services Identity and Access Management User Guide. UserId *string @@ -395,8 +366,7 @@ type RecommendationFeedbackSummary struct { // The ID of the user that gave the feedback. The UserId is an IAM principal that // can be specified as an Amazon Web Services account ID or an Amazon Resource Name - // (ARN). For more information, see Specifying a Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) + // (ARN). For more information, see Specifying a Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying) // in the Amazon Web Services Identity and Access Management User Guide. UserId *string @@ -406,8 +376,8 @@ type RecommendationFeedbackSummary struct { // Information about recommendations. type RecommendationSummary struct { - // A description of the recommendation generated by CodeGuru Reviewer for the lines - // of code between the start line and the end line. + // A description of the recommendation generated by CodeGuru Reviewer for the + // lines of code between the start line and the end line. Description *string // Last line where the recommendation is applicable in the source commit or source @@ -425,9 +395,9 @@ type RecommendationSummary struct { // Later on it can be used to collect the feedback. RecommendationId *string - // Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and - // a short and long description. CodeGuru Reviewer uses rules to analyze code. A - // rule's recommendation is included in analysis results if code is detected that + // Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, + // and a short and long description. CodeGuru Reviewer uses rules to analyze code. + // A rule's recommendation is included in analysis results if code is detected that // violates the rule. RuleMetadata *RuleMetadata @@ -443,8 +413,8 @@ type RecommendationSummary struct { // Information about an associated Amazon Web Services CodeCommit repository or an // associated repository that is managed by Amazon Web Services CodeStar -// Connections (for example, Bitbucket). This Repository object is not used if your -// source code is in an associated GitHub repository. +// Connections (for example, Bitbucket). This Repository object is not used if +// your source code is in an associated GitHub repository. type Repository struct { // Information about a Bitbucket repository. @@ -464,12 +434,11 @@ type Repository struct { // A code review type that analyzes all code under a specified branch in an // associated repository. The associated repository is specified using its ARN when -// you call CreateCodeReview -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). +// you call CreateCodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview) +// . type RepositoryAnalysis struct { - // A SourceCodeType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the tip of a branch in an associated repository. RepositoryHead *RepositoryHeadSourceCodeType @@ -479,8 +448,7 @@ type RepositoryAnalysis struct { noSmithyDocumentSerde } -// Information about a repository association. The DescribeRepositoryAssociation -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html) +// Information about a repository association. The DescribeRepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html) // operation returns a RepositoryAssociation object. type RepositoryAssociation struct { @@ -492,9 +460,8 @@ type RepositoryAssociation struct { // The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections // connection. Its format is - // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. - // For more information, see Connection - // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) + // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . + // For more information, see Connection (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) // in the Amazon Web Services CodeStar Connections API Reference. ConnectionArn *string @@ -503,14 +470,11 @@ type RepositoryAssociation struct { CreatedTimeStamp *time.Time // A KMSKeyDetails object that contains: - // - // * The encryption option for this - // repository association. It is either owned by Amazon Web Services Key Management - // Service (KMS) (AWS_OWNED_CMK) or customer managed (CUSTOMER_MANAGED_CMK). - // - // * The - // ID of the Amazon Web Services KMS key that is associated with this repository - // association. + // - The encryption option for this repository association. It is either owned + // by Amazon Web Services Key Management Service (KMS) ( AWS_OWNED_CMK ) or + // customer managed ( CUSTOMER_MANAGED_CMK ). + // - The ID of the Amazon Web Services KMS key that is associated with this + // repository association. KMSKeyDetails *KMSKeyDetails // The time, in milliseconds since the epoch, when the repository association was @@ -535,38 +499,26 @@ type RepositoryAssociation struct { // that contains .jar or .class files. S3RepositoryDetails *S3RepositoryDetails - // The state of the repository association. The valid repository association states - // are: - // - // * Associated: The repository association is complete. - // - // * Associating: - // CodeGuru Reviewer is: - // - // * Setting up pull request notifications. This is required - // for pull requests to trigger a CodeGuru Reviewer review. If your repository - // ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru - // Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer - // reviews. If you delete these webhooks, reviews of code in your repository cannot - // be triggered. - // - // * Setting up source code access. This is required for CodeGuru - // Reviewer to securely clone code in your repository. - // - // * Failed: The repository - // failed to associate or disassociate. - // - // * Disassociating: CodeGuru Reviewer is - // removing the repository's pull request notifications and source code access. - // - // * - // Disassociated: CodeGuru Reviewer successfully disassociated the repository. You - // can create a new association with this repository if you want to review source - // code in it later. You can control access to code reviews created in anassociated - // repository with tags after it has been disassociated. For more information, see - // Using tags to control access to associated repositories - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) - // in the Amazon CodeGuru Reviewer User Guide. + // The state of the repository association. The valid repository association + // states are: + // - Associated: The repository association is complete. + // - Associating: CodeGuru Reviewer is: + // - Setting up pull request notifications. This is required for pull requests + // to trigger a CodeGuru Reviewer review. If your repository ProviderType is + // GitHub , GitHub Enterprise Server , or Bitbucket , CodeGuru Reviewer creates + // webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete + // these webhooks, reviews of code in your repository cannot be triggered. + // - Setting up source code access. This is required for CodeGuru Reviewer to + // securely clone code in your repository. + // - Failed: The repository failed to associate or disassociate. + // - Disassociating: CodeGuru Reviewer is removing the repository's pull request + // notifications and source code access. + // - Disassociated: CodeGuru Reviewer successfully disassociated the repository. + // You can create a new association with this repository if you want to review + // source code in it later. You can control access to code reviews created in + // anassociated repository with tags after it has been disassociated. For more + // information, see Using tags to control access to associated repositories (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) + // in the Amazon CodeGuru Reviewer User Guide. State RepositoryAssociationState // A description of why the repository association is in the current state. @@ -576,15 +528,13 @@ type RepositoryAssociation struct { } // Summary information about a repository association. The -// ListRepositoryAssociations -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) +// ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) // operation returns a list of RepositoryAssociationSummary objects. type RepositoryAssociationSummary struct { - // The Amazon Resource Name (ARN) of the RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) - // object. You can retrieve this ARN by calling ListRepositoryAssociations - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // object. You can retrieve this ARN by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) + // . AssociationArn *string // The repository association ID. @@ -592,9 +542,8 @@ type RepositoryAssociationSummary struct { // The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections // connection. Its format is - // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. - // For more information, see Connection - // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) + // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . + // For more information, see Connection (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) // in the Amazon Web Services CodeStar Connections API Reference. ConnectionArn *string @@ -615,45 +564,32 @@ type RepositoryAssociationSummary struct { // The provider type of the repository association. ProviderType ProviderType - // The state of the repository association. The valid repository association states - // are: - // - // * Associated: The repository association is complete. - // - // * Associating: - // CodeGuru Reviewer is: - // - // * Setting up pull request notifications. This is required - // for pull requests to trigger a CodeGuru Reviewer review. If your repository - // ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru - // Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer - // reviews. If you delete these webhooks, reviews of code in your repository cannot - // be triggered. - // - // * Setting up source code access. This is required for CodeGuru - // Reviewer to securely clone code in your repository. - // - // * Failed: The repository - // failed to associate or disassociate. - // - // * Disassociating: CodeGuru Reviewer is - // removing the repository's pull request notifications and source code access. - // - // * - // Disassociated: CodeGuru Reviewer successfully disassociated the repository. You - // can create a new association with this repository if you want to review source - // code in it later. You can control access to code reviews created in anassociated - // repository with tags after it has been disassociated. For more information, see - // Using tags to control access to associated repositories - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) - // in the Amazon CodeGuru Reviewer User Guide. + // The state of the repository association. The valid repository association + // states are: + // - Associated: The repository association is complete. + // - Associating: CodeGuru Reviewer is: + // - Setting up pull request notifications. This is required for pull requests + // to trigger a CodeGuru Reviewer review. If your repository ProviderType is + // GitHub , GitHub Enterprise Server , or Bitbucket , CodeGuru Reviewer creates + // webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete + // these webhooks, reviews of code in your repository cannot be triggered. + // - Setting up source code access. This is required for CodeGuru Reviewer to + // securely clone code in your repository. + // - Failed: The repository failed to associate or disassociate. + // - Disassociating: CodeGuru Reviewer is removing the repository's pull request + // notifications and source code access. + // - Disassociated: CodeGuru Reviewer successfully disassociated the repository. + // You can create a new association with this repository if you want to review + // source code in it later. You can control access to code reviews created in + // anassociated repository with tags after it has been disassociated. For more + // information, see Using tags to control access to associated repositories (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html) + // in the Amazon CodeGuru Reviewer User Guide. State RepositoryAssociationState noSmithyDocumentSerde } -// A SourceCodeType -// (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) +// A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the tip of a branch in an associated repository. type RepositoryHeadSourceCodeType struct { @@ -686,16 +622,16 @@ type RequestMetadata struct { // bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then // the repository association's ProviderType is S3Bucket and the CI/CD repository // vendor name is GitHub. For more information, see the definition for ProviderType - // in RepositoryAssociation - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html). + // in RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) + // . VendorName VendorName noSmithyDocumentSerde } -// Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and -// a short and long description. CodeGuru Reviewer uses rules to analyze code. A -// rule's recommendation is included in analysis results if code is detected that +// Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, +// and a short and long description. CodeGuru Reviewer uses rules to analyze code. +// A rule's recommendation is included in analysis results if code is detected that // violates the rule. type RuleMetadata struct { @@ -722,14 +658,14 @@ type RuleMetadata struct { // contains .jar or .class files. type S3BucketRepository struct { - // The name of the repository when the ProviderType is S3Bucket. + // The name of the repository when the ProviderType is S3Bucket . // // This member is required. Name *string // An S3RepositoryDetails object that specifies the name of an S3 bucket and a - // CodeArtifacts object. The CodeArtifacts object includes the S3 object keys for a - // source code .zip file and for a build artifacts .zip file. + // CodeArtifacts object. The CodeArtifacts object includes the S3 object keys for + // a source code .zip file and for a build artifacts .zip file. Details *S3RepositoryDetails noSmithyDocumentSerde @@ -739,7 +675,7 @@ type S3BucketRepository struct { type S3Repository struct { // The name of the S3 bucket used for associating a new S3 repository. It must - // begin with codeguru-reviewer-. + // begin with codeguru-reviewer- . // // This member is required. BucketName *string @@ -758,7 +694,7 @@ type S3Repository struct { type S3RepositoryDetails struct { // The name of the S3 bucket used for associating a new S3 repository. It must - // begin with codeguru-reviewer-. + // begin with codeguru-reviewer- . BucketName *string // A CodeArtifacts object. The CodeArtifacts object includes the S3 object key for @@ -772,35 +708,31 @@ type S3RepositoryDetails struct { // Specifies the source code that is analyzed in a code review. type SourceCodeType struct { - // A type of SourceCodeType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies a source branch name and a destination branch name in an // associated repository. BranchDiff *BranchDiffSourceCodeType - // A SourceCodeType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies a commit diff created by a pull request on an associated // repository. CommitDiff *CommitDiffSourceCodeType - // A SourceCodeType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the tip of a branch in an associated repository. RepositoryHead *RepositoryHeadSourceCodeType - // Metadata that is associated with a code review. This applies to any type of code - // review supported by CodeGuru Reviewer. The RequestMetadaa field captures any - // event metadata. For example, it might capture metadata associated with an event - // trigger, such as a push or a pull request. + // Metadata that is associated with a code review. This applies to any type of + // code review supported by CodeGuru Reviewer. The RequestMetadaa field captures + // any event metadata. For example, it might capture metadata associated with an + // event trigger, such as a push or a pull request. RequestMetadata *RequestMetadata // Information about an associated repository in an S3 bucket that includes its // name and an S3RepositoryDetails object. The S3RepositoryDetails object includes // the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key // for a build artifacts .zip file. S3BucketRepository is required in - // SourceCodeType - // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // for S3BucketRepository based code reviews. S3BucketRepository *S3BucketRepository @@ -813,9 +745,8 @@ type ThirdPartySourceRepository struct { // The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections // connection. Its format is - // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. - // For more information, see Connection - // (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) + // arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . + // For more information, see Connection (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) // in the Amazon Web Services CodeStar Connections API Reference. // // This member is required. diff --git a/service/codepipeline/api_client.go b/service/codepipeline/api_client.go index 58962219ee9..06a8c79887e 100644 --- a/service/codepipeline/api_client.go +++ b/service/codepipeline/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codepipeline/api_op_AcknowledgeJob.go b/service/codepipeline/api_op_AcknowledgeJob.go index d22b848baed..05ba64a2dd7 100644 --- a/service/codepipeline/api_op_AcknowledgeJob.go +++ b/service/codepipeline/api_op_AcknowledgeJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a specified job and whether that job has been received -// by the job worker. Used for custom actions only. +// Returns information about a specified job and whether that job has been +// received by the job worker. Used for custom actions only. func (c *Client) AcknowledgeJob(ctx context.Context, params *AcknowledgeJobInput, optFns ...func(*Options)) (*AcknowledgeJobOutput, error) { if params == nil { params = &AcknowledgeJobInput{} diff --git a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go index 5bb5193af48..cfde9c01b8a 100644 --- a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go +++ b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go @@ -31,8 +31,8 @@ func (c *Client) AcknowledgeThirdPartyJob(ctx context.Context, params *Acknowled // Represents the input of an AcknowledgeThirdPartyJob action. type AcknowledgeThirdPartyJobInput struct { - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. + // The clientToken portion of the clientId and clientToken pair used to verify + // that the calling entity is allowed access to the job and its details. // // This member is required. ClientToken *string diff --git a/service/codepipeline/api_op_CreateCustomActionType.go b/service/codepipeline/api_op_CreateCustomActionType.go index 97735d5b177..e0f169990cd 100644 --- a/service/codepipeline/api_op_CreateCustomActionType.go +++ b/service/codepipeline/api_op_CreateCustomActionType.go @@ -60,8 +60,8 @@ type CreateCustomActionTypeInput struct { // the configuration properties of the custom action within the URL templates by // following the format of {Config:name}, as long as the configuration property is // both required and not secret. For more information, see Create a Custom Action - // for a Pipeline - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html). + // for a Pipeline (https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) + // . ConfigurationProperties []types.ActionConfigurationProperty // URLs that provide users information about this custom action. diff --git a/service/codepipeline/api_op_CreatePipeline.go b/service/codepipeline/api_op_CreatePipeline.go index b7e7a2578fa..285a6d6d145 100644 --- a/service/codepipeline/api_op_CreatePipeline.go +++ b/service/codepipeline/api_op_CreatePipeline.go @@ -13,7 +13,7 @@ import ( // Creates a pipeline. In the pipeline structure, you must include either // artifactStore or artifactStores in your pipeline, but you cannot use both. If -// you create a cross-region action in your pipeline, you must use artifactStores. +// you create a cross-region action in your pipeline, you must use artifactStores . func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error) { if params == nil { params = &CreatePipelineInput{} diff --git a/service/codepipeline/api_op_DisableStageTransition.go b/service/codepipeline/api_op_DisableStageTransition.go index e2d05b86d75..694c64a6861 100644 --- a/service/codepipeline/api_op_DisableStageTransition.go +++ b/service/codepipeline/api_op_DisableStageTransition.go @@ -31,8 +31,8 @@ func (c *Client) DisableStageTransition(ctx context.Context, params *DisableStag // Represents the input of a DisableStageTransition action. type DisableStageTransitionInput struct { - // The name of the pipeline in which you want to disable the flow of artifacts from - // one stage to another. + // The name of the pipeline in which you want to disable the flow of artifacts + // from one stage to another. // // This member is required. PipelineName *string diff --git a/service/codepipeline/api_op_GetActionType.go b/service/codepipeline/api_op_GetActionType.go index c9ee442ef5d..af1dc1cbd1e 100644 --- a/service/codepipeline/api_op_GetActionType.go +++ b/service/codepipeline/api_op_GetActionType.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about an action type created for an external provider, where -// the action is to be used by customers of the external provider. The action can -// be created with any supported integration model. +// Returns information about an action type created for an external provider, +// where the action is to be used by customers of the external provider. The action +// can be created with any supported integration model. func (c *Client) GetActionType(ctx context.Context, params *GetActionTypeInput, optFns ...func(*Options)) (*GetActionTypeOutput, error) { if params == nil { params = &GetActionTypeInput{} @@ -33,24 +33,18 @@ type GetActionTypeInput struct { // Defines what kind of action can be taken in the stage. The following are the // valid values: - // - // * Source - // - // * Build - // - // * Test - // - // * Deploy - // - // * Approval - // - // * Invoke + // - Source + // - Build + // - Test + // - Deploy + // - Approval + // - Invoke // // This member is required. Category types.ActionCategory // The creator of an action type that was created with any supported integration - // model. There are two valid values: AWS and ThirdParty. + // model. There are two valid values: AWS and ThirdParty . // // This member is required. Owner *string diff --git a/service/codepipeline/api_op_GetJobDetails.go b/service/codepipeline/api_op_GetJobDetails.go index b18eed3e93c..d151b9e568a 100644 --- a/service/codepipeline/api_op_GetJobDetails.go +++ b/service/codepipeline/api_op_GetJobDetails.go @@ -45,8 +45,8 @@ type GetJobDetailsInput struct { // Represents the output of a GetJobDetails action. type GetJobDetailsOutput struct { - // The details of the job. If AWSSessionCredentials is used, a long-running job can - // call GetJobDetails again to obtain new credentials. + // The details of the job. If AWSSessionCredentials is used, a long-running job + // can call GetJobDetails again to obtain new credentials. JobDetails *types.JobDetails // Metadata pertaining to the operation's result. diff --git a/service/codepipeline/api_op_GetPipeline.go b/service/codepipeline/api_op_GetPipeline.go index 30102cc0145..67bd6bb8557 100644 --- a/service/codepipeline/api_op_GetPipeline.go +++ b/service/codepipeline/api_op_GetPipeline.go @@ -13,7 +13,7 @@ import ( // Returns the metadata, structure, stages, and actions of a pipeline. Can be used // to return the entire structure of a pipeline in JSON format, which can then be -// modified and used to update the pipeline structure with UpdatePipeline. +// modified and used to update the pipeline structure with UpdatePipeline . func (c *Client) GetPipeline(ctx context.Context, params *GetPipelineInput, optFns ...func(*Options)) (*GetPipelineOutput, error) { if params == nil { params = &GetPipelineInput{} @@ -38,8 +38,8 @@ type GetPipelineInput struct { // This member is required. Name *string - // The version number of the pipeline. If you do not specify a version, defaults to - // the current version. + // The version number of the pipeline. If you do not specify a version, defaults + // to the current version. Version *int32 noSmithyDocumentSerde @@ -48,8 +48,8 @@ type GetPipelineInput struct { // Represents the output of a GetPipeline action. type GetPipelineOutput struct { - // Represents the pipeline metadata information returned as part of the output of a - // GetPipeline action. + // Represents the pipeline metadata information returned as part of the output of + // a GetPipeline action. Metadata *types.PipelineMetadata // Represents the structure of actions and stages to be performed in the pipeline. diff --git a/service/codepipeline/api_op_GetPipelineState.go b/service/codepipeline/api_op_GetPipelineState.go index 64816caf361..7d102037523 100644 --- a/service/codepipeline/api_op_GetPipelineState.go +++ b/service/codepipeline/api_op_GetPipelineState.go @@ -51,7 +51,7 @@ type GetPipelineStateOutput struct { PipelineName *string // The version number of the pipeline. A newly created pipeline is always assigned - // a version number of 1. + // a version number of 1 . PipelineVersion *int32 // A list of the pipeline stage output information, including stage name, state, diff --git a/service/codepipeline/api_op_GetThirdPartyJobDetails.go b/service/codepipeline/api_op_GetThirdPartyJobDetails.go index e161053fb55..93a0d11b96a 100644 --- a/service/codepipeline/api_op_GetThirdPartyJobDetails.go +++ b/service/codepipeline/api_op_GetThirdPartyJobDetails.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests the details of a job for a third party action. Used for partner actions -// only. When this API is called, AWS CodePipeline returns temporary credentials -// for the S3 bucket used to store artifacts for the pipeline, if the action -// requires access to that S3 bucket for input or output artifacts. This API also -// returns any secret values defined for the action. +// Requests the details of a job for a third party action. Used for partner +// actions only. When this API is called, AWS CodePipeline returns temporary +// credentials for the S3 bucket used to store artifacts for the pipeline, if the +// action requires access to that S3 bucket for input or output artifacts. This API +// also returns any secret values defined for the action. func (c *Client) GetThirdPartyJobDetails(ctx context.Context, params *GetThirdPartyJobDetailsInput, optFns ...func(*Options)) (*GetThirdPartyJobDetailsOutput, error) { if params == nil { params = &GetThirdPartyJobDetailsInput{} @@ -34,8 +34,8 @@ func (c *Client) GetThirdPartyJobDetails(ctx context.Context, params *GetThirdPa // Represents the input of a GetThirdPartyJobDetails action. type GetThirdPartyJobDetailsInput struct { - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. + // The clientToken portion of the clientId and clientToken pair used to verify + // that the calling entity is allowed access to the job and its details. // // This member is required. ClientToken *string diff --git a/service/codepipeline/api_op_ListPipelineExecutions.go b/service/codepipeline/api_op_ListPipelineExecutions.go index 6983518c20f..a4873ac2332 100644 --- a/service/codepipeline/api_op_ListPipelineExecutions.go +++ b/service/codepipeline/api_op_ListPipelineExecutions.go @@ -43,8 +43,8 @@ type ListPipelineExecutionsInput struct { // start times. Default value is 100. MaxResults *int32 - // The token that was returned from the previous ListPipelineExecutions call, which - // can be used to return the next set of pipeline executions in the list. + // The token that was returned from the previous ListPipelineExecutions call, + // which can be used to return the next set of pipeline executions in the list. NextToken *string noSmithyDocumentSerde diff --git a/service/codepipeline/api_op_ListPipelines.go b/service/codepipeline/api_op_ListPipelines.go index a9f3b4afbfa..99f5ac564d3 100644 --- a/service/codepipeline/api_op_ListPipelines.go +++ b/service/codepipeline/api_op_ListPipelines.go @@ -36,8 +36,8 @@ type ListPipelinesInput struct { // minimum value you can specify is 1. The maximum accepted value is 1000. MaxResults *int32 - // An identifier that was returned from the previous list pipelines call. It can be - // used to return the next set of pipelines in the list. + // An identifier that was returned from the previous list pipelines call. It can + // be used to return the next set of pipelines in the list. NextToken *string noSmithyDocumentSerde diff --git a/service/codepipeline/api_op_ListTagsForResource.go b/service/codepipeline/api_op_ListTagsForResource.go index e90937faf44..5a8624028df 100644 --- a/service/codepipeline/api_op_ListTagsForResource.go +++ b/service/codepipeline/api_op_ListTagsForResource.go @@ -126,8 +126,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/codepipeline/api_op_PutApprovalResult.go b/service/codepipeline/api_op_PutApprovalResult.go index 251900c45bc..8d08668b30d 100644 --- a/service/codepipeline/api_op_PutApprovalResult.go +++ b/service/codepipeline/api_op_PutApprovalResult.go @@ -52,8 +52,8 @@ type PutApprovalResultInput struct { // This member is required. StageName *string - // The system-generated token used to identify a unique approval request. The token - // for each open approval request can be obtained using the GetPipelineState + // The system-generated token used to identify a unique approval request. The + // token for each open approval request can be obtained using the GetPipelineState // action. It is used to validate that the approval request corresponding to this // token is still valid. // diff --git a/service/codepipeline/api_op_PutJobFailureResult.go b/service/codepipeline/api_op_PutJobFailureResult.go index c775d0cf4ae..7fa42ae60d2 100644 --- a/service/codepipeline/api_op_PutJobFailureResult.go +++ b/service/codepipeline/api_op_PutJobFailureResult.go @@ -37,7 +37,7 @@ type PutJobFailureResultInput struct { FailureDetails *types.FailureDetails // The unique system-generated ID of the job that failed. This is the same ID - // returned from PollForJobs. + // returned from PollForJobs . // // This member is required. JobId *string diff --git a/service/codepipeline/api_op_PutJobSuccessResult.go b/service/codepipeline/api_op_PutJobSuccessResult.go index e59f6ef0e31..4d9a93586a4 100644 --- a/service/codepipeline/api_op_PutJobSuccessResult.go +++ b/service/codepipeline/api_op_PutJobSuccessResult.go @@ -32,16 +32,16 @@ func (c *Client) PutJobSuccessResult(ctx context.Context, params *PutJobSuccessR type PutJobSuccessResultInput struct { // The unique system-generated ID of the job that succeeded. This is the same ID - // returned from PollForJobs. + // returned from PollForJobs . // // This member is required. JobId *string - // A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that - // a successful job provides to identify a custom action in progress. Future jobs - // use this token to identify the running instance of the action. It can be reused - // to return more information about the progress of the custom action. When the - // action is complete, no continuation token should be supplied. + // A token generated by a job worker, such as an AWS CodeDeploy deployment ID, + // that a successful job provides to identify a custom action in progress. Future + // jobs use this token to identify the running instance of the action. It can be + // reused to return more information about the progress of the custom action. When + // the action is complete, no continuation token should be supplied. ContinuationToken *string // The ID of the current revision of the artifact successfully worked on by the @@ -52,8 +52,8 @@ type PutJobSuccessResultInput struct { // job worker. ExecutionDetails *types.ExecutionDetails - // Key-value pairs produced as output by a job worker that can be made available to - // a downstream action configuration. outputVariables can be included only when + // Key-value pairs produced as output by a job worker that can be made available + // to a downstream action configuration. outputVariables can be included only when // there is no continuation token on the request. OutputVariables map[string]string diff --git a/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go b/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go index d2f8a6a2684..11848006ca9 100644 --- a/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go +++ b/service/codepipeline/api_op_PutThirdPartyJobFailureResult.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Represents the failure of a third party job as returned to the pipeline by a job -// worker. Used for partner actions only. +// Represents the failure of a third party job as returned to the pipeline by a +// job worker. Used for partner actions only. func (c *Client) PutThirdPartyJobFailureResult(ctx context.Context, params *PutThirdPartyJobFailureResultInput, optFns ...func(*Options)) (*PutThirdPartyJobFailureResultOutput, error) { if params == nil { params = &PutThirdPartyJobFailureResultInput{} @@ -31,8 +31,8 @@ func (c *Client) PutThirdPartyJobFailureResult(ctx context.Context, params *PutT // Represents the input of a PutThirdPartyJobFailureResult action. type PutThirdPartyJobFailureResultInput struct { - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. + // The clientToken portion of the clientId and clientToken pair used to verify + // that the calling entity is allowed access to the job and its details. // // This member is required. ClientToken *string @@ -43,7 +43,7 @@ type PutThirdPartyJobFailureResultInput struct { FailureDetails *types.FailureDetails // The ID of the job that failed. This is the same ID returned from - // PollForThirdPartyJobs. + // PollForThirdPartyJobs . // // This member is required. JobId *string diff --git a/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go b/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go index f8b5026bff7..1cfcec1e063 100644 --- a/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go +++ b/service/codepipeline/api_op_PutThirdPartyJobSuccessResult.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Represents the success of a third party job as returned to the pipeline by a job -// worker. Used for partner actions only. +// Represents the success of a third party job as returned to the pipeline by a +// job worker. Used for partner actions only. func (c *Client) PutThirdPartyJobSuccessResult(ctx context.Context, params *PutThirdPartyJobSuccessResultInput, optFns ...func(*Options)) (*PutThirdPartyJobSuccessResultOutput, error) { if params == nil { params = &PutThirdPartyJobSuccessResultInput{} @@ -31,23 +31,23 @@ func (c *Client) PutThirdPartyJobSuccessResult(ctx context.Context, params *PutT // Represents the input of a PutThirdPartyJobSuccessResult action. type PutThirdPartyJobSuccessResultInput struct { - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. + // The clientToken portion of the clientId and clientToken pair used to verify + // that the calling entity is allowed access to the job and its details. // // This member is required. ClientToken *string - // The ID of the job that successfully completed. This is the same ID returned from - // PollForThirdPartyJobs. + // The ID of the job that successfully completed. This is the same ID returned + // from PollForThirdPartyJobs . // // This member is required. JobId *string - // A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that - // a successful job provides to identify a partner action in progress. Future jobs - // use this token to identify the running instance of the action. It can be reused - // to return more information about the progress of the partner action. When the - // action is complete, no continuation token should be supplied. + // A token generated by a job worker, such as an AWS CodeDeploy deployment ID, + // that a successful job provides to identify a partner action in progress. Future + // jobs use this token to identify the running instance of the action. It can be + // reused to return more information about the progress of the partner action. When + // the action is complete, no continuation token should be supplied. ContinuationToken *string // Represents information about a current revision. diff --git a/service/codepipeline/api_op_PutWebhook.go b/service/codepipeline/api_op_PutWebhook.go index 0e0bf57dfd4..0af6694d4ec 100644 --- a/service/codepipeline/api_op_PutWebhook.go +++ b/service/codepipeline/api_op_PutWebhook.go @@ -52,8 +52,8 @@ type PutWebhookInput struct { type PutWebhookOutput struct { - // The detail returned from creating the webhook, such as the webhook name, webhook - // URL, and webhook ARN. + // The detail returned from creating the webhook, such as the webhook name, + // webhook URL, and webhook ARN. Webhook *types.ListWebhookItem // Metadata pertaining to the operation's result. diff --git a/service/codepipeline/doc.go b/service/codepipeline/doc.go index 58cb40e4708..3486150757b 100644 --- a/service/codepipeline/doc.go +++ b/service/codepipeline/doc.go @@ -3,136 +3,90 @@ // Package codepipeline provides the API client, operations, and parameter types // for AWS CodePipeline. // -// AWS CodePipeline Overview This is the AWS CodePipeline API Reference. This guide -// provides descriptions of the actions and data types for AWS CodePipeline. Some -// functionality for your pipeline can only be configured through the API. For more -// information, see the AWS CodePipeline User Guide -// (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html). You -// can use the AWS CodePipeline API to work with pipelines, stages, actions, and -// transitions. Pipelines are models of automated release processes. Each pipeline -// is uniquely named, and consists of stages, actions, and transitions. You can -// work with pipelines by calling: -// -// * CreatePipeline, which creates a uniquely -// named pipeline. -// -// * DeletePipeline, which deletes the specified pipeline. -// -// * -// GetPipeline, which returns information about the pipeline structure and pipeline -// metadata, including the pipeline Amazon Resource Name (ARN). -// -// * -// GetPipelineExecution, which returns information about a specific execution of a -// pipeline. -// -// * GetPipelineState, which returns information about the current state -// of the stages and actions of a pipeline. -// -// * ListActionExecutions, which returns -// action-level details for past executions. The details include full stage and -// action-level details, including individual action duration, status, any errors -// that occurred during the execution, and input and output artifact location -// details. -// -// * ListPipelines, which gets a summary of all of the pipelines -// associated with your account. -// -// * ListPipelineExecutions, which gets a summary of -// the most recent executions for a pipeline. -// -// * StartPipelineExecution, which runs -// the most recent revision of an artifact through the pipeline. -// -// * -// StopPipelineExecution, which stops the specified pipeline execution from -// continuing through the pipeline. -// -// * UpdatePipeline, which updates a pipeline -// with edits or changes to the structure of the pipeline. -// -// Pipelines include -// stages. Each stage contains one or more actions that must complete before the -// next stage begins. A stage results in success or failure. If a stage fails, the -// pipeline stops at that stage and remains stopped until either a new version of -// an artifact appears in the source location, or a user takes action to rerun the -// most recent artifact through the pipeline. You can call GetPipelineState, which -// displays the status of a pipeline, including the status of stages in the -// pipeline, or GetPipeline, which returns the entire structure of the pipeline, -// including the stages of that pipeline. For more information about the structure -// of stages and actions, see AWS CodePipeline Pipeline Structure Reference -// (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html). -// Pipeline stages include actions that are categorized into categories such as +// AWS CodePipeline Overview This is the AWS CodePipeline API Reference. This +// guide provides descriptions of the actions and data types for AWS CodePipeline. +// Some functionality for your pipeline can only be configured through the API. For +// more information, see the AWS CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) +// . You can use the AWS CodePipeline API to work with pipelines, stages, actions, +// and transitions. Pipelines are models of automated release processes. Each +// pipeline is uniquely named, and consists of stages, actions, and transitions. +// You can work with pipelines by calling: +// - CreatePipeline , which creates a uniquely named pipeline. +// - DeletePipeline , which deletes the specified pipeline. +// - GetPipeline , which returns information about the pipeline structure and +// pipeline metadata, including the pipeline Amazon Resource Name (ARN). +// - GetPipelineExecution , which returns information about a specific execution +// of a pipeline. +// - GetPipelineState , which returns information about the current state of the +// stages and actions of a pipeline. +// - ListActionExecutions , which returns action-level details for past +// executions. The details include full stage and action-level details, including +// individual action duration, status, any errors that occurred during the +// execution, and input and output artifact location details. +// - ListPipelines , which gets a summary of all of the pipelines associated with +// your account. +// - ListPipelineExecutions , which gets a summary of the most recent executions +// for a pipeline. +// - StartPipelineExecution , which runs the most recent revision of an artifact +// through the pipeline. +// - StopPipelineExecution , which stops the specified pipeline execution from +// continuing through the pipeline. +// - UpdatePipeline , which updates a pipeline with edits or changes to the +// structure of the pipeline. +// +// Pipelines include stages. Each stage contains one or more actions that must +// complete before the next stage begins. A stage results in success or failure. If +// a stage fails, the pipeline stops at that stage and remains stopped until either +// a new version of an artifact appears in the source location, or a user takes +// action to rerun the most recent artifact through the pipeline. You can call +// GetPipelineState , which displays the status of a pipeline, including the status +// of stages in the pipeline, or GetPipeline , which returns the entire structure +// of the pipeline, including the stages of that pipeline. For more information +// about the structure of stages and actions, see AWS CodePipeline Pipeline +// Structure Reference (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html) +// . Pipeline stages include actions that are categorized into categories such as // source or build actions performed in a stage of a pipeline. For example, you can // use a source action to import artifacts into a pipeline from a source such as // Amazon S3. Like stages, you do not work with actions directly in most cases, but // you do define and interact with actions when working with pipeline operations -// such as CreatePipeline and GetPipelineState. Valid action categories are: -// -// * -// Source -// -// * Build -// -// * Test -// -// * Deploy -// -// * Approval -// -// * Invoke -// -// Pipelines also include -// transitions, which allow the transition of artifacts from one stage to the next -// in a pipeline after the actions in one stage complete. You can work with -// transitions by calling: -// -// * DisableStageTransition, which prevents artifacts from -// transitioning to the next stage in a pipeline. -// -// * EnableStageTransition, which -// enables transition of artifacts between stages in a pipeline. -// -// Using the API to -// integrate with AWS CodePipeline For third-party integrators or developers who -// want to create their own integrations with AWS CodePipeline, the expected -// sequence varies from the standard API user. To integrate with AWS CodePipeline, -// developers need to work with the following items: Jobs, which are instances of -// an action. For example, a job for a source action might import a revision of an -// artifact from a source. You can work with jobs by calling: -// -// * AcknowledgeJob, -// which confirms whether a job worker has received the specified job. -// -// * -// GetJobDetails, which returns the details of a job. -// -// * PollForJobs, which -// determines whether there are any jobs to act on. -// -// * PutJobFailureResult, which -// provides details of a job failure. -// -// * PutJobSuccessResult, which provides -// details of a job success. -// -// Third party jobs, which are instances of an action -// created by a partner action and integrated into AWS CodePipeline. Partner -// actions are created by members of the AWS Partner Network. You can work with -// third party jobs by calling: -// -// * AcknowledgeThirdPartyJob, which confirms whether -// a job worker has received the specified job. -// -// * GetThirdPartyJobDetails, which -// requests the details of a job for a partner action. -// -// * PollForThirdPartyJobs, -// which determines whether there are any jobs to act on. -// -// * -// PutThirdPartyJobFailureResult, which provides details of a job failure. -// -// * -// PutThirdPartyJobSuccessResult, which provides details of a job success. +// such as CreatePipeline and GetPipelineState . Valid action categories are: +// - Source +// - Build +// - Test +// - Deploy +// - Approval +// - Invoke +// +// Pipelines also include transitions, which allow the transition of artifacts +// from one stage to the next in a pipeline after the actions in one stage +// complete. You can work with transitions by calling: +// - DisableStageTransition , which prevents artifacts from transitioning to the +// next stage in a pipeline. +// - EnableStageTransition , which enables transition of artifacts between stages +// in a pipeline. +// +// Using the API to integrate with AWS CodePipeline For third-party integrators or +// developers who want to create their own integrations with AWS CodePipeline, the +// expected sequence varies from the standard API user. To integrate with AWS +// CodePipeline, developers need to work with the following items: Jobs, which are +// instances of an action. For example, a job for a source action might import a +// revision of an artifact from a source. You can work with jobs by calling: +// - AcknowledgeJob , which confirms whether a job worker has received the +// specified job. +// - GetJobDetails , which returns the details of a job. +// - PollForJobs , which determines whether there are any jobs to act on. +// - PutJobFailureResult , which provides details of a job failure. +// - PutJobSuccessResult , which provides details of a job success. +// +// Third party jobs, which are instances of an action created by a partner action +// and integrated into AWS CodePipeline. Partner actions are created by members of +// the AWS Partner Network. You can work with third party jobs by calling: +// - AcknowledgeThirdPartyJob , which confirms whether a job worker has received +// the specified job. +// - GetThirdPartyJobDetails , which requests the details of a job for a partner +// action. +// - PollForThirdPartyJobs , which determines whether there are any jobs to act +// on. +// - PutThirdPartyJobFailureResult , which provides details of a job failure. +// - PutThirdPartyJobSuccessResult , which provides details of a job success. package codepipeline diff --git a/service/codepipeline/types/enums.go b/service/codepipeline/types/enums.go index 112607f4acb..52ebe3dad98 100644 --- a/service/codepipeline/types/enums.go +++ b/service/codepipeline/types/enums.go @@ -59,8 +59,8 @@ const ( ActionExecutionStatusFailed ActionExecutionStatus = "Failed" ) -// Values returns all known values for ActionExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ActionExecutionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ActionExecutionStatus) Values() []ActionExecutionStatus { return []ActionExecutionStatus{ @@ -181,9 +181,9 @@ const ( ExecutorTypeLambda ExecutorType = "Lambda" ) -// Values returns all known values for ExecutorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExecutorType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExecutorType) Values() []ExecutorType { return []ExecutorType{ "JobWorker", @@ -230,9 +230,9 @@ const ( JobStatusFailed JobStatus = "Failed" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "Created", diff --git a/service/codepipeline/types/errors.go b/service/codepipeline/types/errors.go index d908294ad41..1b1256e46a5 100644 --- a/service/codepipeline/types/errors.go +++ b/service/codepipeline/types/errors.go @@ -352,8 +352,8 @@ func (e *InvalidJobStateException) ErrorCode() string { } func (e *InvalidJobStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The next token was specified in an invalid format. Make sure that the next token -// you provide is the token returned by a previous call. +// The next token was specified in an invalid format. Make sure that the next +// token you provide is the token returned by a previous call. type InvalidNextTokenException struct { Message *string @@ -649,8 +649,8 @@ func (e *OutputVariablesSizeExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The pipeline execution was specified in an invalid format or cannot be found, or -// an execution ID does not belong to the specified pipeline. +// The pipeline execution was specified in an invalid format or cannot be found, +// or an execution ID does not belong to the specified pipeline. type PipelineExecutionNotFoundException struct { Message *string diff --git a/service/codepipeline/types/types.go b/service/codepipeline/types/types.go index 97f7eafc78b..26126f6cc31 100644 --- a/service/codepipeline/types/types.go +++ b/service/codepipeline/types/types.go @@ -35,8 +35,8 @@ type ActionConfigurationProperty struct { Required bool // Whether the configuration property is secret. Secrets are hidden from all calls - // except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and - // PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without + // except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and + // PollForThirdPartyJobs . When updating a pipeline, passing * * * * * without // changing any other values of the action preserves the previous value of the // secret. // @@ -46,7 +46,7 @@ type ActionConfigurationProperty struct { // The description of the action configuration property that is displayed to users. Description *string - // Indicates that the property is used with PollForJobs. When creating a custom + // Indicates that the property is used with PollForJobs . When creating a custom // action, an action can have up to one queryable property. If it has one, that // property must be both required and not secret. If you create a pipeline with a // custom action type, and that custom action contains a queryable property, the @@ -88,14 +88,11 @@ type ActionDeclaration struct { // The action's configuration. These are key-value pairs that specify input values // for an action. For more information, see Action Structure Requirements in - // CodePipeline - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). - // For the list of configuration properties for the AWS CloudFormation action type - // in CodePipeline, see Configuration Properties Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) + // CodePipeline (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) + // . For the list of configuration properties for the AWS CloudFormation action + // type in CodePipeline, see Configuration Properties Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) // in the AWS CloudFormation User Guide. For template snippets with examples, see - // Using Parameter Override Functions with CodePipeline Pipelines - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) + // Using Parameter Override Functions with CodePipeline Pipelines (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) // in the AWS CloudFormation User Guide. The values can be represented in either // JSON or YAML format. For example, the JSON configuration item format is as // follows: JSON: "Configuration" : { Key : Value }, @@ -161,8 +158,8 @@ type ActionExecution struct { // A summary of the run of the action. Summary *string - // The system-generated token used to identify a unique approval request. The token - // for each open approval request can be obtained using the GetPipelineState + // The system-generated token used to identify a unique approval request. The + // token for each open approval request can be obtained using the GetPipelineState // command. It is used to validate that the approval request corresponding to this // token is still valid. Token *string @@ -202,8 +199,8 @@ type ActionExecutionDetail struct { // The start time of the action execution. StartTime *time.Time - // The status of the action execution. Status categories are InProgress, Succeeded, - // and Failed. + // The status of the action execution. Status categories are InProgress , Succeeded + // , and Failed . Status ActionExecutionStatus noSmithyDocumentSerde @@ -238,8 +235,8 @@ type ActionExecutionInput struct { // The AWS Region for the action, such as us-east-1. Region *string - // Configuration data for an action execution with all variable references replaced - // with their real values for the execution. + // Configuration data for an action execution with all variable references + // replaced with their real values for the execution. ResolvedConfiguration map[string]string // The ARN of the IAM service role that performs the declared action. This is @@ -358,20 +355,20 @@ type ActionType struct { noSmithyDocumentSerde } -// Information about parameters for artifacts associated with the action type, such -// as the minimum and maximum artifacts allowed. +// Information about parameters for artifacts associated with the action type, +// such as the minimum and maximum artifacts allowed. type ActionTypeArtifactDetails struct { // The maximum number of artifacts that can be used with the actiontype. For // example, you should specify a minimum and maximum of zero input artifacts for an - // action type with a category of source. + // action type with a category of source . // // This member is required. MaximumCount int32 // The minimum number of artifacts that can be used with the action type. For // example, you should specify a minimum and maximum of zero input artifacts for an - // action type with a category of source. + // action type with a category of source . // // This member is required. MinimumCount int32 @@ -423,9 +420,9 @@ type ActionTypeDeclaration struct { noSmithyDocumentSerde } -// The action engine, or executor, for an action type created for a provider, where -// the action is to be used by customers of the provider. The action engine is -// associated with the model used to create and update the action, such as the +// The action engine, or executor, for an action type created for a provider, +// where the action is to be used by customers of the provider. The action engine +// is associated with the model used to create and update the action, such as the // Lambda integration model. type ActionTypeExecutor struct { @@ -436,7 +433,7 @@ type ActionTypeExecutor struct { Configuration *ExecutorConfiguration // The integration model used to create and update the action type, Lambda or - // JobWorker. + // JobWorker . // // This member is required. Type ExecutorType @@ -449,7 +446,7 @@ type ActionTypeExecutor struct { // customer’s account that are needed to successfully run an action. To grant // permission to another account, specify the account ID as the Principal, a // domain-style identifier defined by the service, for example - // codepipeline.amazonaws.com. The size of the passed JSON policy document cannot + // codepipeline.amazonaws.com . The size of the passed JSON policy document cannot // exceed 2048 characters. PolicyStatementsTemplate *string @@ -459,30 +456,24 @@ type ActionTypeExecutor struct { // Represents information about an action type. type ActionTypeId struct { - // A category defines what kind of action can be taken in the stage, and constrains - // the provider type for the action. Valid categories are limited to one of the - // following values. - // - // * Source - // - // * Build - // - // * Test - // - // * Deploy - // - // * Invoke - // - // * Approval + // A category defines what kind of action can be taken in the stage, and + // constrains the provider type for the action. Valid categories are limited to one + // of the following values. + // - Source + // - Build + // - Test + // - Deploy + // - Invoke + // - Approval // // This member is required. Category ActionCategory // The creator of the action being called. There are three valid values for the - // Owner field in the action category section within your pipeline structure: AWS, - // ThirdParty, and Custom. For more information, see Valid Action Types and - // Providers in CodePipeline - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers). + // Owner field in the action category section within your pipeline structure: AWS , + // ThirdParty , and Custom . For more information, see Valid Action Types and + // Providers in CodePipeline (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) + // . // // This member is required. Owner ActionOwner @@ -491,8 +482,8 @@ type ActionTypeId struct { // determined by the action category. For example, an action in the Deploy category // type might have a provider of AWS CodeDeploy, which would be specified as // CodeDeploy. For more information, see Valid Action Types and Providers in - // CodePipeline - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers). + // CodePipeline (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) + // . // // This member is required. Provider *string @@ -509,30 +500,23 @@ type ActionTypeId struct { type ActionTypeIdentifier struct { // Defines what kind of action can be taken in the stage, one of the following: - // - // * - // Source - // - // * Build - // - // * Test - // - // * Deploy - // - // * Approval - // - // * Invoke + // - Source + // - Build + // - Test + // - Deploy + // - Approval + // - Invoke // // This member is required. Category ActionCategory - // The creator of the action type being called: AWS or ThirdParty. + // The creator of the action type being called: AWS or ThirdParty . // // This member is required. Owner *string - // The provider of the action type being called. The provider name is supplied when - // the action type is created. + // The provider of the action type being called. The provider name is supplied + // when the action type is created. // // This member is required. Provider *string @@ -571,8 +555,8 @@ type ActionTypeProperty struct { // This member is required. Name *string - // Whether to omit the field value entered by the customer in the log. If true, the - // value is not saved in CloudTrail logs for the action execution. + // Whether to omit the field value entered by the customer in the log. If true , + // the value is not saved in CloudTrail logs for the action execution. // // This member is required. NoEcho bool @@ -730,8 +714,8 @@ type ArtifactRevision struct { // or defined by the user when an action is created. Name *string - // An additional identifier for a revision, such as a commit date or, for artifacts - // stored in Amazon S3 buckets, the ETag value. + // An additional identifier for a revision, such as a commit date or, for + // artifacts stored in Amazon S3 buckets, the ETag value. RevisionChangeIdentifier *string // The revision ID of the artifact. @@ -753,11 +737,11 @@ type ArtifactRevision struct { // The S3 bucket where artifacts for the pipeline are stored. You must include // either artifactStore or artifactStores in your pipeline, but you cannot use // both. If you create a cross-region action in your pipeline, you must use -// artifactStores. +// artifactStores . type ArtifactStore struct { - // The S3 bucket used for storing the artifacts for a pipeline. You can specify the - // name of an S3 bucket but not a folder in the bucket. A folder to contain the + // The S3 bucket used for storing the artifacts for a pipeline. You can specify + // the name of an S3 bucket but not a folder in the bucket. A folder to contain the // pipeline artifacts is created for you based on the name of the pipeline. You can // use any S3 bucket in the same AWS Region as the pipeline to store your pipeline // artifacts. @@ -841,20 +825,20 @@ type CurrentRevision struct { noSmithyDocumentSerde } -// Represents information about the key used to encrypt data in the artifact store, -// such as an AWS Key Management Service (AWS KMS) key. +// Represents information about the key used to encrypt data in the artifact +// store, such as an AWS Key Management Service (AWS KMS) key. type EncryptionKey struct { - // The ID used to identify the key. For an AWS KMS key, you can use the key ID, the - // key ARN, or the alias ARN. Aliases are recognized only in the account that + // The ID used to identify the key. For an AWS KMS key, you can use the key ID, + // the key ARN, or the alias ARN. Aliases are recognized only in the account that // created the customer master key (CMK). For cross-account actions, you can only // use the key ID or key ARN to identify the key. // // This member is required. Id *string - // The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. - // When creating or updating a pipeline, the value must be set to 'KMS'. + // The type of encryption key, such as an AWS Key Management Service (AWS KMS) + // key. When creating or updating a pipeline, the value must be set to 'KMS'. // // This member is required. Type EncryptionKeyType @@ -900,8 +884,8 @@ type ExecutionTrigger struct { // for a user-initiated start-pipeline-execution CLI command. TriggerDetail *string - // The type of change-detection method, command, or user interaction that started a - // pipeline execution. + // The type of change-detection method, command, or user interaction that started + // a pipeline execution. TriggerType TriggerType noSmithyDocumentSerde @@ -909,7 +893,7 @@ type ExecutionTrigger struct { // The action engine, or executor, related to the supported integration model used // to create and update the action type. The available executor types are Lambda -// and JobWorker. +// and JobWorker . type ExecutorConfiguration struct { // Details about the JobWorker executor of the action type. @@ -997,8 +981,8 @@ type JobData struct { // job to continue the job asynchronously. ContinuationToken *string - // Represents information about the key used to encrypt data in the artifact store, - // such as an AWS Key Management Service (AWS KMS) key. + // Represents information about the key used to encrypt data in the artifact + // store, such as an AWS Key Management Service (AWS KMS) key. EncryptionKey *EncryptionKey // The artifact supplied to the job. @@ -1056,8 +1040,8 @@ type LambdaExecutorConfiguration struct { noSmithyDocumentSerde } -// The detail returned for each webhook after listing webhooks, such as the webhook -// URL, the webhook name, and the webhook ARN. +// The detail returned for each webhook after listing webhooks, such as the +// webhook URL, the webhook name, and the webhook ARN. type ListWebhookItem struct { // The detail returned for each webhook, such as the webhook authentication type @@ -1066,8 +1050,8 @@ type ListWebhookItem struct { // This member is required. Definition *WebhookDefinition - // A unique URL generated by CodePipeline. When a POST request is made to this URL, - // the defined pipeline is started as long as the body of the post request + // A unique URL generated by CodePipeline. When a POST request is made to this + // URL, the defined pipeline is started as long as the body of the post request // satisfies the defined authentication and filtering conditions. Deleting and // re-creating a webhook makes the old URL invalid and generates a new one. // @@ -1124,8 +1108,8 @@ type PipelineContext struct { // The execution ID of the pipeline. PipelineExecutionId *string - // The name of the pipeline. This is a user-specified value. Pipeline names must be - // unique across all pipeline names under an Amazon Web Services account. + // The name of the pipeline. This is a user-specified value. Pipeline names must + // be unique across all pipeline names under an Amazon Web Services account. PipelineName *string // The stage of the pipeline. @@ -1143,8 +1127,8 @@ type PipelineDeclaration struct { Name *string // The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform - // actions with no actionRoleArn, or to use to assume roles for actions with an - // actionRoleArn. + // actions with no actionRoleArn , or to use to assume roles for actions with an + // actionRoleArn . // // This member is required. RoleArn *string @@ -1157,14 +1141,14 @@ type PipelineDeclaration struct { // Represents information about the S3 bucket where artifacts are stored for the // pipeline. You must include either artifactStore or artifactStores in your // pipeline, but you cannot use both. If you create a cross-region action in your - // pipeline, you must use artifactStores. + // pipeline, you must use artifactStores . ArtifactStore *ArtifactStore // A mapping of artifactStore objects and their corresponding AWS Regions. There // must be an artifact store for the pipeline Region and for each cross-region // action in the pipeline. You must include either artifactStore or artifactStores // in your pipeline, but you cannot use both. If you create a cross-region action - // in your pipeline, you must use artifactStores. + // in your pipeline, you must use artifactStores . ArtifactStores map[string]ArtifactStore // The version number of the pipeline. A new pipeline always has a version number @@ -1190,34 +1174,22 @@ type PipelineExecution struct { PipelineVersion *int32 // The status of the pipeline execution. - // - // * Cancelled: The pipeline’s definition - // was updated before the pipeline execution could be completed. - // - // * InProgress: The - // pipeline execution is currently running. - // - // * Stopped: The pipeline execution was - // manually stopped. For more information, see Stopped Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). - // - // * - // Stopping: The pipeline execution received a request to be manually stopped. - // Depending on the selected stop mode, the execution is either completing or - // abandoning in-progress actions. For more information, see Stopped Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). - // - // * - // Succeeded: The pipeline execution was completed successfully. - // - // * Superseded: - // While this pipeline execution was waiting for the next stage to be completed, a - // newer pipeline execution advanced and continued through the pipeline instead. - // For more information, see Superseded Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded). - // - // * - // Failed: The pipeline execution was not completed successfully. + // - Cancelled: The pipeline’s definition was updated before the pipeline + // execution could be completed. + // - InProgress: The pipeline execution is currently running. + // - Stopped: The pipeline execution was manually stopped. For more information, + // see Stopped Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped) + // . + // - Stopping: The pipeline execution received a request to be manually stopped. + // Depending on the selected stop mode, the execution is either completing or + // abandoning in-progress actions. For more information, see Stopped Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped) + // . + // - Succeeded: The pipeline execution was completed successfully. + // - Superseded: While this pipeline execution was waiting for the next stage to + // be completed, a newer pipeline execution advanced and continued through the + // pipeline instead. For more information, see Superseded Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded) + // . + // - Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus // A summary that contains a description of the pipeline execution status. @@ -1243,31 +1215,20 @@ type PipelineExecutionSummary struct { StartTime *time.Time // The status of the pipeline execution. - // - // * InProgress: The pipeline execution is - // currently running. - // - // * Stopped: The pipeline execution was manually stopped. For - // more information, see Stopped Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). - // - // * - // Stopping: The pipeline execution received a request to be manually stopped. - // Depending on the selected stop mode, the execution is either completing or - // abandoning in-progress actions. For more information, see Stopped Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped). - // - // * - // Succeeded: The pipeline execution was completed successfully. - // - // * Superseded: - // While this pipeline execution was waiting for the next stage to be completed, a - // newer pipeline execution advanced and continued through the pipeline instead. - // For more information, see Superseded Executions - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded). - // - // * - // Failed: The pipeline execution was not completed successfully. + // - InProgress: The pipeline execution is currently running. + // - Stopped: The pipeline execution was manually stopped. For more information, + // see Stopped Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped) + // . + // - Stopping: The pipeline execution received a request to be manually stopped. + // Depending on the selected stop mode, the execution is either completing or + // abandoning in-progress actions. For more information, see Stopped Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped) + // . + // - Succeeded: The pipeline execution was completed successfully. + // - Superseded: While this pipeline execution was waiting for the next stage to + // be completed, a newer pipeline execution advanced and continued through the + // pipeline instead. For more information, see Superseded Executions (https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded) + // . + // - Failed: The pipeline execution was not completed successfully. Status PipelineExecutionStatus // The interaction that stopped a pipeline execution. @@ -1404,9 +1365,9 @@ type StageExecution struct { // This member is required. PipelineExecutionId *string - // The status of the stage, or for a completed stage, the last status of the stage. - // A status of cancelled means that the pipeline’s definition was updated before - // the stage execution could be completed. + // The status of the stage, or for a completed stage, the last status of the + // stage. A status of cancelled means that the pipeline’s definition was updated + // before the stage execution could be completed. // // This member is required. Status StageExecutionStatus @@ -1465,8 +1426,8 @@ type Tag struct { // there is a job to be worked on by a partner action. type ThirdPartyJob struct { - // The clientToken portion of the clientId and clientToken pair used to verify that - // the calling entity is allowed access to the job and its details. + // The clientToken portion of the clientId and clientToken pair used to verify + // that the calling entity is allowed access to the job and its details. ClientId *string // The identifier used to identify the job in AWS CodePipeline. @@ -1574,24 +1535,18 @@ type WebhookAuthConfiguration struct { type WebhookDefinition struct { // Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. - // - // * For information - // about the authentication scheme implemented by GITHUB_HMAC, see Securing your - // webhooks (https://developer.github.com/webhooks/securing/) on the GitHub - // Developer website. - // - // * IP rejects webhooks trigger requests unless they originate - // from an IP address in the IP range whitelisted in the authentication - // configuration. - // - // * UNAUTHENTICATED accepts all webhook trigger requests - // regardless of origin. + // - For information about the authentication scheme implemented by GITHUB_HMAC, + // see Securing your webhooks (https://developer.github.com/webhooks/securing/) + // on the GitHub Developer website. + // - IP rejects webhooks trigger requests unless they originate from an IP + // address in the IP range whitelisted in the authentication configuration. + // - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin. // // This member is required. Authentication WebhookAuthenticationType - // Properties that configure the authentication applied to incoming webhook trigger - // requests. The required properties depend on the authentication type. For + // Properties that configure the authentication applied to incoming webhook + // trigger requests. The required properties depend on the authentication type. For // GITHUB_HMAC, only the SecretToken property must be set. For IP, only the // AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, // no properties can be set. @@ -1636,16 +1591,16 @@ type WebhookFilterRule struct { // This member is required. JsonPath *string - // The value selected by the JsonPath expression must match what is supplied in the - // MatchEquals field. Otherwise, the request is ignored. Properties from the target - // action configuration can be included as placeholders in this value by + // The value selected by the JsonPath expression must match what is supplied in + // the MatchEquals field. Otherwise, the request is ignored. Properties from the + // target action configuration can be included as placeholders in this value by // surrounding the action configuration key with curly brackets. For example, if // the value supplied here is "refs/heads/{Branch}" and the target action has an // action configuration property called "Branch" with a value of "master", the // MatchEquals value is evaluated as "refs/heads/master". For a list of action // configuration properties for built-in action types, see Pipeline Structure - // Reference Action Requirements - // (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). + // Reference Action Requirements (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) + // . MatchEquals *string noSmithyDocumentSerde diff --git a/service/codestar/api_client.go b/service/codestar/api_client.go index 00ee1a415b7..8597e284d3a 100644 --- a/service/codestar/api_client.go +++ b/service/codestar/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codestar/api_op_AssociateTeamMember.go b/service/codestar/api_op_AssociateTeamMember.go index f0e4def0d2a..7bb7bd51cd1 100644 --- a/service/codestar/api_op_AssociateTeamMember.go +++ b/service/codestar/api_op_AssociateTeamMember.go @@ -33,8 +33,8 @@ type AssociateTeamMemberInput struct { // This member is required. ProjectId *string - // The AWS CodeStar project role that will apply to this user. This role determines - // what actions a user can take in an AWS CodeStar project. + // The AWS CodeStar project role that will apply to this user. This role + // determines what actions a user can take in an AWS CodeStar project. // // This member is required. ProjectRole *string @@ -59,8 +59,8 @@ type AssociateTeamMemberInput struct { type AssociateTeamMemberOutput struct { - // The user- or system-generated token from the initial request that can be used to - // repeat the request. + // The user- or system-generated token from the initial request that can be used + // to repeat the request. ClientRequestToken *string // Metadata pertaining to the operation's result. diff --git a/service/codestar/api_op_CreateProject.go b/service/codestar/api_op_CreateProject.go index 9a2efe9eb82..d8512beae05 100644 --- a/service/codestar/api_op_CreateProject.go +++ b/service/codestar/api_op_CreateProject.go @@ -49,8 +49,8 @@ type CreateProjectInput struct { // The description of the project, if any. Description *string - // A list of the Code objects submitted with the project request. If this parameter - // is specified, the request must also include the toolchain parameter. + // A list of the Code objects submitted with the project request. If this + // parameter is specified, the request must also include the toolchain parameter. SourceCode []types.Code // The tags created for the project. diff --git a/service/codestar/api_op_CreateUserProfile.go b/service/codestar/api_op_CreateUserProfile.go index a9214c06d41..a913d104134 100644 --- a/service/codestar/api_op_CreateUserProfile.go +++ b/service/codestar/api_op_CreateUserProfile.go @@ -11,10 +11,11 @@ import ( "time" ) -// Creates a profile for a user that includes user preferences, such as the display -// name and email address assocciated with the user, in AWS CodeStar. The user -// profile is not project-specific. Information in the user profile is displayed -// wherever the user's information appears to other users in AWS CodeStar. +// Creates a profile for a user that includes user preferences, such as the +// display name and email address assocciated with the user, in AWS CodeStar. The +// user profile is not project-specific. Information in the user profile is +// displayed wherever the user's information appears to other users in AWS +// CodeStar. func (c *Client) CreateUserProfile(ctx context.Context, params *CreateUserProfileInput, optFns ...func(*Options)) (*CreateUserProfileOutput, error) { if params == nil { params = &CreateUserProfileInput{} diff --git a/service/codestar/api_op_DeleteProject.go b/service/codestar/api_op_DeleteProject.go index 40a36cc53ab..394c7d8ed57 100644 --- a/service/codestar/api_op_DeleteProject.go +++ b/service/codestar/api_op_DeleteProject.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a project, including project resources. Does not delete users associated -// with the project, but does delete the IAM roles that allowed access to the -// project. +// Deletes a project, including project resources. Does not delete users +// associated with the project, but does delete the IAM roles that allowed access +// to the project. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/codestar/api_op_DescribeProject.go b/service/codestar/api_op_DescribeProject.go index cf606921029..fbb9c9170dd 100644 --- a/service/codestar/api_op_DescribeProject.go +++ b/service/codestar/api_op_DescribeProject.go @@ -62,8 +62,8 @@ type DescribeProjectOutput struct { // The ID for the AWS CodeStar project template used to create the project. ProjectTemplateId *string - // The ID of the primary stack in AWS CloudFormation used to generate resources for - // the project. + // The ID of the primary stack in AWS CloudFormation used to generate resources + // for the project. StackId *string // The project creation or deletion status. diff --git a/service/codestar/api_op_UpdateTeamMember.go b/service/codestar/api_op_UpdateTeamMember.go index 8fcfbe185cb..08024e3bb02 100644 --- a/service/codestar/api_op_UpdateTeamMember.go +++ b/service/codestar/api_op_UpdateTeamMember.go @@ -42,8 +42,7 @@ type UpdateTeamMemberInput struct { UserArn *string // The role assigned to the user in the project. Project roles have different - // levels of access. For more information, see Working with Teams - // (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) + // levels of access. For more information, see Working with Teams (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) // in the AWS CodeStar User Guide. ProjectRole *string @@ -65,8 +64,8 @@ type UpdateTeamMemberOutput struct { // SSH public key associated with the user's profile. RemoteAccessAllowed *bool - // The Amazon Resource Name (ARN) of the user whose team membership attributes were - // updated. + // The Amazon Resource Name (ARN) of the user whose team membership attributes + // were updated. UserArn *string // Metadata pertaining to the operation's result. diff --git a/service/codestar/doc.go b/service/codestar/doc.go index 54cc866ff1e..a82aaaad16a 100644 --- a/service/codestar/doc.go +++ b/service/codestar/doc.go @@ -3,64 +3,33 @@ // Package codestar provides the API client, operations, and parameter types for // AWS CodeStar. // -// AWS CodeStar This is the API reference for AWS CodeStar. This reference provides -// descriptions of the operations and data types for the AWS CodeStar API along -// with usage examples. You can use the AWS CodeStar API to work with: Projects and -// their resources, by calling the following: -// -// * DeleteProject, which deletes a -// project. -// -// * DescribeProject, which lists the attributes of a project. -// -// * -// ListProjects, which lists all projects associated with your AWS account. -// -// * -// ListResources, which lists the resources associated with a project. -// -// * -// ListTagsForProject, which lists the tags associated with a project. -// -// * -// TagProject, which adds tags to a project. -// -// * UntagProject, which removes tags -// from a project. -// -// * UpdateProject, which updates the attributes of a -// project. +// AWS CodeStar This is the API reference for AWS CodeStar. This reference +// provides descriptions of the operations and data types for the AWS CodeStar API +// along with usage examples. You can use the AWS CodeStar API to work with: +// Projects and their resources, by calling the following: +// - DeleteProject , which deletes a project. +// - DescribeProject , which lists the attributes of a project. +// - ListProjects , which lists all projects associated with your AWS account. +// - ListResources , which lists the resources associated with a project. +// - ListTagsForProject , which lists the tags associated with a project. +// - TagProject , which adds tags to a project. +// - UntagProject , which removes tags from a project. +// - UpdateProject , which updates the attributes of a project. // // Teams and team members, by calling the following: -// -// * -// AssociateTeamMember, which adds an IAM user to the team for a project. -// -// * -// DisassociateTeamMember, which removes an IAM user from the team for a -// project. -// -// * ListTeamMembers, which lists all the IAM users in the team for a -// project, including their roles and attributes. -// -// * UpdateTeamMember, which -// updates a team member's attributes in a project. -// -// Users, by calling the -// following: -// -// * CreateUserProfile, which creates a user profile that contains data -// associated with the user across all projects. -// -// * DeleteUserProfile, which -// deletes all user profile information across all projects. -// -// * -// DescribeUserProfile, which describes the profile of a user. -// -// * ListUserProfiles, -// which lists all user profiles. -// -// * UpdateUserProfile, which updates the profile -// for a user. +// - AssociateTeamMember , which adds an IAM user to the team for a project. +// - DisassociateTeamMember , which removes an IAM user from the team for a +// project. +// - ListTeamMembers , which lists all the IAM users in the team for a project, +// including their roles and attributes. +// - UpdateTeamMember , which updates a team member's attributes in a project. +// +// Users, by calling the following: +// - CreateUserProfile , which creates a user profile that contains data +// associated with the user across all projects. +// - DeleteUserProfile , which deletes all user profile information across all +// projects. +// - DescribeUserProfile , which describes the profile of a user. +// - ListUserProfiles , which lists all user profiles. +// - UpdateUserProfile , which updates the profile for a user. package codestar diff --git a/service/codestar/types/errors.go b/service/codestar/types/errors.go index 65917b7eb5b..1288f82e806 100644 --- a/service/codestar/types/errors.go +++ b/service/codestar/types/errors.go @@ -274,9 +274,9 @@ func (e *TeamMemberNotFoundException) ErrorCode() string { } func (e *TeamMemberNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A user profile with that name already exists in this region for the AWS account. -// AWS CodeStar user profile names must be unique within a region for the AWS -// account. +// A user profile with that name already exists in this region for the AWS +// account. AWS CodeStar user profile names must be unique within a region for the +// AWS account. type UserProfileAlreadyExistsException struct { Message *string diff --git a/service/codestar/types/types.go b/service/codestar/types/types.go index b9c1ba749aa..63c55b4df22 100644 --- a/service/codestar/types/types.go +++ b/service/codestar/types/types.go @@ -11,9 +11,9 @@ import ( // repository after project creation. type Code struct { - // The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or - // GitHub. After AWS CodeStar provisions the new repository, the source code files - // provided with the project request are placed in the repository. + // The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit + // or GitHub. After AWS CodeStar provisions the new repository, the source code + // files provided with the project request are placed in the repository. // // This member is required. Destination *CodeDestination @@ -40,9 +40,9 @@ type CodeCommitCodeDestination struct { noSmithyDocumentSerde } -// The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or -// GitHub. After AWS CodeStar provisions the new repository, the source code files -// provided with the project request are placed in the repository. +// The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit +// or GitHub. After AWS CodeStar provisions the new repository, the source code +// files provided with the project request are placed in the repository. type CodeDestination struct { // Information about the AWS CodeCommit repository to be created in AWS CodeStar. @@ -172,8 +172,7 @@ type S3Location struct { type TeamMember struct { // The role assigned to the user in the project. Project roles have different - // levels of access. For more information, see Working with Teams - // (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) + // levels of access. For more information, see Working with Teams (http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html) // in the AWS CodeStar User Guide. // // This member is required. @@ -191,8 +190,8 @@ type TeamMember struct { noSmithyDocumentSerde } -// The toolchain template file provided with the project request. AWS CodeStar uses -// the template to provision the toolchain stack in AWS CloudFormation. +// The toolchain template file provided with the project request. AWS CodeStar +// uses the template to provision the toolchain stack in AWS CloudFormation. type Toolchain struct { // The Amazon S3 location where the toolchain template file provided with the @@ -218,8 +217,8 @@ type Toolchain struct { // creation. type ToolchainSource struct { - // The Amazon S3 bucket where the toolchain template file provided with the project - // request is stored. + // The Amazon S3 bucket where the toolchain template file provided with the + // project request is stored. // // This member is required. S3 *S3Location diff --git a/service/codestarconnections/api_client.go b/service/codestarconnections/api_client.go index a615bf9eac6..8616463dc95 100644 --- a/service/codestarconnections/api_client.go +++ b/service/codestarconnections/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codestarconnections/api_op_CreateConnection.go b/service/codestarconnections/api_op_CreateConnection.go index 22fd9bb5d15..41aca759747 100644 --- a/service/codestarconnections/api_op_CreateConnection.go +++ b/service/codestarconnections/api_op_CreateConnection.go @@ -32,8 +32,8 @@ func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionI type CreateConnectionInput struct { - // The name of the connection to be created. The name must be unique in the calling - // AWS account. + // The name of the connection to be created. The name must be unique in the + // calling AWS account. // // This member is required. ConnectionName *string diff --git a/service/codestarconnections/api_op_DeleteConnection.go b/service/codestarconnections/api_op_DeleteConnection.go index f981e0e289a..b2ad2238a52 100644 --- a/service/codestarconnections/api_op_DeleteConnection.go +++ b/service/codestarconnections/api_op_DeleteConnection.go @@ -28,8 +28,8 @@ func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionI type DeleteConnectionInput struct { - // The Amazon Resource Name (ARN) of the connection to be deleted. The ARN is never - // reused if the connection is deleted. + // The Amazon Resource Name (ARN) of the connection to be deleted. The ARN is + // never reused if the connection is deleted. // // This member is required. ConnectionArn *string diff --git a/service/codestarconnections/api_op_ListConnections.go b/service/codestarconnections/api_op_ListConnections.go index b4b274baf55..5d9e875e74c 100644 --- a/service/codestarconnections/api_op_ListConnections.go +++ b/service/codestarconnections/api_op_ListConnections.go @@ -37,8 +37,8 @@ type ListConnectionsInput struct { // remaining results, make another call with the returned nextToken value. MaxResults int32 - // The token that was returned from the previous ListConnections call, which can be - // used to return the next set of connections in the list. + // The token that was returned from the previous ListConnections call, which can + // be used to return the next set of connections in the list. NextToken *string // Filters the list of connections to those associated with a specified provider, diff --git a/service/codestarconnections/doc.go b/service/codestarconnections/doc.go index 163172ddd53..1efc235f3aa 100644 --- a/service/codestarconnections/doc.go +++ b/service/codestarconnections/doc.go @@ -20,48 +20,30 @@ // you want to create a connection to an installed provider type such as GitHub // Enterprise Server, you create a host for your connections. You can work with // connections by calling: -// -// * CreateConnection, which creates a uniquely named -// connection that can be referenced by services such as CodePipeline. -// -// * -// DeleteConnection, which deletes the specified connection. -// -// * GetConnection, -// which returns information about the connection, including the connection -// status. -// -// * ListConnections, which lists the connections associated with your -// account. +// - CreateConnection , which creates a uniquely named connection that can be +// referenced by services such as CodePipeline. +// - DeleteConnection , which deletes the specified connection. +// - GetConnection , which returns information about the connection, including +// the connection status. +// - ListConnections , which lists the connections associated with your account. // // You can work with hosts by calling: -// -// * CreateHost, which creates a -// host that represents the infrastructure where your provider is installed. -// -// * -// DeleteHost, which deletes the specified host. -// -// * GetHost, which returns -// information about the host, including the setup status. -// -// * ListHosts, which -// lists the hosts associated with your account. -// -// You can work with tags in AWS -// CodeStar Connections by calling the following: -// -// * ListTagsForResource, which -// gets information about AWS tags for a specified Amazon Resource Name (ARN) in -// AWS CodeStar Connections. -// -// * TagResource, which adds or updates tags for a -// resource in AWS CodeStar Connections. -// -// * UntagResource, which removes tags for a -// resource in AWS CodeStar Connections. -// -// For information about how to use AWS -// CodeStar Connections, see the Developer Tools User Guide -// (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html). +// - CreateHost , which creates a host that represents the infrastructure where +// your provider is installed. +// - DeleteHost , which deletes the specified host. +// - GetHost , which returns information about the host, including the setup +// status. +// - ListHosts , which lists the hosts associated with your account. +// +// You can work with tags in AWS CodeStar Connections by calling the following: +// - ListTagsForResource , which gets information about AWS tags for a specified +// Amazon Resource Name (ARN) in AWS CodeStar Connections. +// - TagResource , which adds or updates tags for a resource in AWS CodeStar +// Connections. +// - UntagResource , which removes tags for a resource in AWS CodeStar +// Connections. +// +// For information about how to use AWS CodeStar Connections, see the Developer +// Tools User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html) +// . package codestarconnections diff --git a/service/codestarconnections/types/enums.go b/service/codestarconnections/types/enums.go index 5d49b9765f8..4422282244d 100644 --- a/service/codestarconnections/types/enums.go +++ b/service/codestarconnections/types/enums.go @@ -31,9 +31,9 @@ const ( ProviderTypeGithubEnterpriseServer ProviderType = "GitHubEnterpriseServer" ) -// Values returns all known values for ProviderType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProviderType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProviderType) Values() []ProviderType { return []ProviderType{ "Bitbucket", diff --git a/service/codestarnotifications/api_client.go b/service/codestarnotifications/api_client.go index ca5401298cd..4c194a65e7f 100644 --- a/service/codestarnotifications/api_client.go +++ b/service/codestarnotifications/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/codestarnotifications/api_op_CreateNotificationRule.go b/service/codestarnotifications/api_op_CreateNotificationRule.go index f62311a9af5..fa2c4091694 100644 --- a/service/codestarnotifications/api_op_CreateNotificationRule.go +++ b/service/codestarnotifications/api_op_CreateNotificationRule.go @@ -42,7 +42,7 @@ type CreateNotificationRuleInput struct { DetailType types.DetailType // A list of event types associated with this notification rule. For a list of - // allowed events, see EventTypeSummary. + // allowed events, see EventTypeSummary . // // This member is required. EventTypeIds []string @@ -74,12 +74,12 @@ type CreateNotificationRuleInput struct { // Web Services SDK, an idempotency token is created for you. ClientRequestToken *string - // The status of the notification rule. The default value is ENABLED. If the status - // is set to DISABLED, notifications aren't sent for the notification rule. + // The status of the notification rule. The default value is ENABLED . If the + // status is set to DISABLED , notifications aren't sent for the notification rule. Status types.NotificationRuleStatus - // A list of tags to apply to this notification rule. Key names cannot start with - // "aws". + // A list of tags to apply to this notification rule. Key names cannot start with " + // aws ". Tags map[string]string noSmithyDocumentSerde diff --git a/service/codestarnotifications/api_op_ListEventTypes.go b/service/codestarnotifications/api_op_ListEventTypes.go index 1edadfd6c40..019d02dca14 100644 --- a/service/codestarnotifications/api_op_ListEventTypes.go +++ b/service/codestarnotifications/api_op_ListEventTypes.go @@ -34,12 +34,12 @@ type ListEventTypesInput struct { // The filters to use to return information by service or resource type. Filters []types.ListEventTypesFilter - // A non-negative integer used to limit the number of returned results. The default - // number is 50. The maximum number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // default number is 50. The maximum number of results that can be returned is 100. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -134,8 +134,8 @@ var _ ListEventTypesAPIClient = (*Client)(nil) // ListEventTypesPaginatorOptions is the paginator options for ListEventTypes type ListEventTypesPaginatorOptions struct { - // A non-negative integer used to limit the number of returned results. The default - // number is 50. The maximum number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // default number is 50. The maximum number of results that can be returned is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codestarnotifications/api_op_ListNotificationRules.go b/service/codestarnotifications/api_op_ListNotificationRules.go index 443e1ca919e..a2106793db0 100644 --- a/service/codestarnotifications/api_op_ListNotificationRules.go +++ b/service/codestarnotifications/api_op_ListNotificationRules.go @@ -31,17 +31,17 @@ func (c *Client) ListNotificationRules(ctx context.Context, params *ListNotifica type ListNotificationRulesInput struct { // The filters to use to return information by service or resource type. For valid - // values, see ListNotificationRulesFilter. A filter with the same name can appear + // values, see ListNotificationRulesFilter . A filter with the same name can appear // more than once when used with OR statements. Filters with different names should // be applied with AND statements. Filters []types.ListNotificationRulesFilter - // A non-negative integer used to limit the number of returned results. The maximum - // number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // maximum number of results that can be returned is 100. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -137,8 +137,8 @@ var _ ListNotificationRulesAPIClient = (*Client)(nil) // ListNotificationRulesPaginatorOptions is the paginator options for // ListNotificationRules type ListNotificationRulesPaginatorOptions struct { - // A non-negative integer used to limit the number of returned results. The maximum - // number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // maximum number of results that can be returned is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codestarnotifications/api_op_ListTargets.go b/service/codestarnotifications/api_op_ListTargets.go index 9849cfff315..c0c67699d99 100644 --- a/service/codestarnotifications/api_op_ListTargets.go +++ b/service/codestarnotifications/api_op_ListTargets.go @@ -37,12 +37,12 @@ type ListTargetsInput struct { // with different names should be applied with AND statements. Filters []types.ListTargetsFilter - // A non-negative integer used to limit the number of returned results. The maximum - // number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // maximum number of results that can be returned is 100. MaxResults *int32 - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. NextToken *string noSmithyDocumentSerde @@ -135,8 +135,8 @@ var _ ListTargetsAPIClient = (*Client)(nil) // ListTargetsPaginatorOptions is the paginator options for ListTargets type ListTargetsPaginatorOptions struct { - // A non-negative integer used to limit the number of returned results. The maximum - // number of results that can be returned is 100. + // A non-negative integer used to limit the number of returned results. The + // maximum number of results that can be returned is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codestarnotifications/api_op_Subscribe.go b/service/codestarnotifications/api_op_Subscribe.go index 4be99f6667c..9f48dabefb2 100644 --- a/service/codestarnotifications/api_op_Subscribe.go +++ b/service/codestarnotifications/api_op_Subscribe.go @@ -43,8 +43,8 @@ type SubscribeInput struct { // This member is required. Target *types.Target - // An enumeration token that, when provided in a request, returns the next batch of - // the results. + // An enumeration token that, when provided in a request, returns the next batch + // of the results. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/codestarnotifications/api_op_TagResource.go b/service/codestarnotifications/api_op_TagResource.go index 7067273b4bb..3a035710647 100644 --- a/service/codestarnotifications/api_op_TagResource.go +++ b/service/codestarnotifications/api_op_TagResource.go @@ -33,8 +33,8 @@ type TagResourceInput struct { // This member is required. Arn *string - // The list of tags to associate with the resource. Tag key names cannot start with - // "aws". + // The list of tags to associate with the resource. Tag key names cannot start + // with " aws ". // // This member is required. Tags map[string]string diff --git a/service/codestarnotifications/api_op_UntagResource.go b/service/codestarnotifications/api_op_UntagResource.go index 267ed2f7ffd..243226c1fc7 100644 --- a/service/codestarnotifications/api_op_UntagResource.go +++ b/service/codestarnotifications/api_op_UntagResource.go @@ -29,8 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the notification rule from which to remove the - // tags. + // The Amazon Resource Name (ARN) of the notification rule from which to remove + // the tags. // // This member is required. Arn *string diff --git a/service/codestarnotifications/api_op_UpdateNotificationRule.go b/service/codestarnotifications/api_op_UpdateNotificationRule.go index 83828c9f3cd..e105acf0994 100644 --- a/service/codestarnotifications/api_op_UpdateNotificationRule.go +++ b/service/codestarnotifications/api_op_UpdateNotificationRule.go @@ -14,7 +14,7 @@ import ( // Updates a notification rule for a resource. You can change the events that // trigger the notification rule, the status of the rule, and the targets that // receive the notifications. To add or remove tags for a notification rule, you -// must use TagResource and UntagResource. +// must use TagResource and UntagResource . func (c *Client) UpdateNotificationRule(ctx context.Context, params *UpdateNotificationRuleInput, optFns ...func(*Options)) (*UpdateNotificationRuleOutput, error) { if params == nil { params = &UpdateNotificationRuleInput{} @@ -45,8 +45,7 @@ type UpdateNotificationRuleInput struct { DetailType types.DetailType // A list of event types associated with this notification rule. For a complete - // list of event types and IDs, see Notification concepts - // (https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) + // list of event types and IDs, see Notification concepts (https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) // in the Developer Tools Console User Guide. EventTypeIds []string diff --git a/service/codestarnotifications/doc.go b/service/codestarnotifications/doc.go index 7a5cd6c6cf3..a3edf59b6c4 100644 --- a/service/codestarnotifications/doc.go +++ b/service/codestarnotifications/doc.go @@ -1,62 +1,42 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package codestarnotifications provides the API client, operations, and parameter -// types for AWS CodeStar Notifications. +// Package codestarnotifications provides the API client, operations, and +// parameter types for AWS CodeStar Notifications. // // This AWS CodeStar Notifications API Reference provides descriptions and usage // examples of the operations and data types for the AWS CodeStar Notifications // API. You can use the AWS CodeStar Notifications API to work with the following // objects: Notification rules, by calling the following: -// -// * -// CreateNotificationRule, which creates a notification rule for a resource in your -// account. -// -// * DeleteNotificationRule, which deletes a notification rule. -// -// * -// DescribeNotificationRule, which provides information about a notification -// rule. -// -// * ListNotificationRules, which lists the notification rules associated -// with your account. -// -// * UpdateNotificationRule, which changes the name, events, or -// targets associated with a notification rule. -// -// * Subscribe, which subscribes a -// target to a notification rule. -// -// * Unsubscribe, which removes a target from a -// notification rule. +// - CreateNotificationRule , which creates a notification rule for a resource in +// your account. +// - DeleteNotificationRule , which deletes a notification rule. +// - DescribeNotificationRule , which provides information about a notification +// rule. +// - ListNotificationRules , which lists the notification rules associated with +// your account. +// - UpdateNotificationRule , which changes the name, events, or targets +// associated with a notification rule. +// - Subscribe , which subscribes a target to a notification rule. +// - Unsubscribe , which removes a target from a notification rule. // // Targets, by calling the following: +// - DeleteTarget , which removes a notification rule target from a notification +// rule. +// - ListTargets , which lists the targets associated with a notification rule. // -// * DeleteTarget, which -// removes a notification rule target from a notification rule. -// -// * ListTargets, -// which lists the targets associated with a notification rule. -// -// Events, by calling -// the following: -// -// * ListEventTypes, which lists the event types you can include in -// a notification rule. +// Events, by calling the following: +// - ListEventTypes , which lists the event types you can include in a +// notification rule. // // Tags, by calling the following: -// -// * ListTagsForResource, -// which lists the tags already associated with a notification rule in your -// account. -// -// * TagResource, which associates a tag you provide with a notification -// rule in your account. -// -// * UntagResource, which removes a tag from a notification -// rule in your account. -// -// For information about how to use AWS CodeStar -// Notifications, see the Amazon Web Services Developer Tools Console User Guide -// (https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html). +// - ListTagsForResource , which lists the tags already associated with a +// notification rule in your account. +// - TagResource , which associates a tag you provide with a notification rule in +// your account. +// - UntagResource , which removes a tag from a notification rule in your +// account. +// +// For information about how to use AWS CodeStar Notifications, see the Amazon Web +// Services Developer Tools Console User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/what-is-dtconsole.html) +// . package codestarnotifications diff --git a/service/codestarnotifications/types/enums.go b/service/codestarnotifications/types/enums.go index 81af3dd5ba0..3def5382586 100644 --- a/service/codestarnotifications/types/enums.go +++ b/service/codestarnotifications/types/enums.go @@ -28,9 +28,9 @@ const ( ListEventTypesFilterNameServiceName ListEventTypesFilterName = "SERVICE_NAME" ) -// Values returns all known values for ListEventTypesFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListEventTypesFilterName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ListEventTypesFilterName) Values() []ListEventTypesFilterName { return []ListEventTypesFilterName{ "RESOURCE_TYPE", @@ -70,8 +70,8 @@ const ( ListTargetsFilterNameTargetStatus ListTargetsFilterName = "TARGET_STATUS" ) -// Values returns all known values for ListTargetsFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ListTargetsFilterName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ListTargetsFilterName) Values() []ListTargetsFilterName { return []ListTargetsFilterName{ @@ -110,9 +110,9 @@ const ( TargetStatusDeactivated TargetStatus = "DEACTIVATED" ) -// Values returns all known values for TargetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetStatus) Values() []TargetStatus { return []TargetStatus{ "PENDING", diff --git a/service/codestarnotifications/types/errors.go b/service/codestarnotifications/types/errors.go index 6d592fcfa8d..a779cb6343e 100644 --- a/service/codestarnotifications/types/errors.go +++ b/service/codestarnotifications/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// AWS CodeStar Notifications can't create the notification rule because you do not -// have sufficient permissions. +// AWS CodeStar Notifications can't create the notification rule because you do +// not have sufficient permissions. type AccessDeniedException struct { Message *string @@ -87,8 +87,8 @@ func (e *ConfigurationException) ErrorCode() string { } func (e *ConfigurationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The value for the enumeration token used in the request to return the next batch -// of the results is not valid. +// The value for the enumeration token used in the request to return the next +// batch of the results is not valid. type InvalidNextTokenException struct { Message *string @@ -142,8 +142,8 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A resource with the same name or ID already exists. Notification rule names must -// be unique in your Amazon Web Services account. +// A resource with the same name or ID already exists. Notification rule names +// must be unique in your Amazon Web Services account. type ResourceAlreadyExistsException struct { Message *string diff --git a/service/codestarnotifications/types/types.go b/service/codestarnotifications/types/types.go index 5cc978fac5d..3ff2f17159a 100644 --- a/service/codestarnotifications/types/types.go +++ b/service/codestarnotifications/types/types.go @@ -10,8 +10,7 @@ import ( type EventTypeSummary struct { // The system-generated ID of the event. For a complete list of event types and - // IDs, see Notification concepts - // (https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) + // IDs, see Notification concepts (https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) // in the Developer Tools Console User Guide. EventTypeId *string @@ -27,8 +26,8 @@ type EventTypeSummary struct { noSmithyDocumentSerde } -// Information about a filter to apply to the list of returned event types. You can -// filter by resource type or service name. +// Information about a filter to apply to the list of returned event types. You +// can filter by resource type or service name. type ListEventTypesFilter struct { // The system-generated name of the filter type you want to filter by. @@ -68,8 +67,8 @@ type ListNotificationRulesFilter struct { // Information about a filter to apply to the list of returned targets. You can // filter by target type, address, or status. For example, to filter results to // notification rules that have active Chatbot topics as targets, you could specify -// a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of -// TARGET_STATUS and a Value of ACTIVE. +// a ListTargetsFilter Name as TargetType and a Value of SNS , and a Name of +// TARGET_STATUS and a Value of ACTIVE . type ListTargetsFilter struct { // The name of the attribute you want to use to filter the returned targets. @@ -107,11 +106,8 @@ type Target struct { TargetAddress *string // The target type. Can be an Chatbot topic or Chatbot client. - // - // * Chatbot topics - // are specified as SNS. - // - // * Chatbot clients are specified as AWSChatbotSlack. + // - Chatbot topics are specified as SNS . + // - Chatbot clients are specified as AWSChatbotSlack . TargetType *string noSmithyDocumentSerde @@ -126,12 +122,9 @@ type TargetSummary struct { // The status of the target. TargetStatus TargetStatus - // The type of the target (for example, SNS). - // - // * Chatbot topics are specified as - // SNS. - // - // * Chatbot clients are specified as AWSChatbotSlack. + // The type of the target (for example, SNS ). + // - Chatbot topics are specified as SNS . + // - Chatbot clients are specified as AWSChatbotSlack . TargetType *string noSmithyDocumentSerde diff --git a/service/cognitoidentity/api_client.go b/service/cognitoidentity/api_client.go index 942f855781f..964663cd684 100644 --- a/service/cognitoidentity/api_client.go +++ b/service/cognitoidentity/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cognitoidentity/api_op_CreateIdentityPool.go b/service/cognitoidentity/api_op_CreateIdentityPool.go index 0833f91b8bd..9ee1d27816a 100644 --- a/service/cognitoidentity/api_op_CreateIdentityPool.go +++ b/service/cognitoidentity/api_op_CreateIdentityPool.go @@ -14,21 +14,13 @@ import ( // Creates a new identity pool. The identity pool is a store of user identity // information that is specific to your AWS account. The keys for // SupportedLoginProviders are as follows: +// - Facebook: graph.facebook.com +// - Google: accounts.google.com +// - Amazon: www.amazon.com +// - Twitter: api.twitter.com +// - Digits: www.digits.com // -// * Facebook: graph.facebook.com -// -// * -// Google: accounts.google.com -// -// * Amazon: www.amazon.com -// -// * Twitter: -// api.twitter.com -// -// * Digits: www.digits.com -// -// You must use AWS Developer -// credentials to call this API. +// You must use AWS Developer credentials to call this API. func (c *Client) CreateIdentityPool(ctx context.Context, params *CreateIdentityPoolInput, optFns ...func(*Options)) (*CreateIdentityPoolOutput, error) { if params == nil { params = &CreateIdentityPoolInput{} @@ -58,8 +50,7 @@ type CreateIdentityPoolInput struct { IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) // in the Amazon Cognito Developer Guide. AllowClassicFlow *bool @@ -68,10 +59,10 @@ type CreateIdentityPoolInput struct { // The "domain" by which Cognito will refer to your users. This name acts as a // placeholder that allows your backend and the Cognito service to communicate - // about the developer provider. For the DeveloperProviderName, you can use letters - // as well as period (.), underscore (_), and dash (-). Once you have set a - // developer provider name, you cannot change it. Please take care in setting this - // parameter. + // about the developer provider. For the DeveloperProviderName , you can use + // letters as well as period ( . ), underscore ( _ ), and dash ( - ). Once you have + // set a developer provider name, you cannot change it. Please take care in setting + // this parameter. DeveloperProviderName *string // Tags to assign to the identity pool. A tag is a label that you can apply to @@ -111,8 +102,7 @@ type CreateIdentityPoolOutput struct { IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) // in the Amazon Cognito Developer Guide. AllowClassicFlow *bool diff --git a/service/cognitoidentity/api_op_DescribeIdentityPool.go b/service/cognitoidentity/api_op_DescribeIdentityPool.go index 06fe6819d7d..4bf747dde3a 100644 --- a/service/cognitoidentity/api_op_DescribeIdentityPool.go +++ b/service/cognitoidentity/api_op_DescribeIdentityPool.go @@ -59,8 +59,7 @@ type DescribeIdentityPoolOutput struct { IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) // in the Amazon Cognito Developer Guide. AllowClassicFlow *bool diff --git a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go index 351d21ddf39..5c2bb8ad105 100644 --- a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go +++ b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go @@ -50,8 +50,7 @@ type GetCredentialsForIdentityInput struct { // credentials for an unauthenticated identity. The Logins parameter is required // when using identities associated with external identity providers such as // Facebook. For examples of Logins maps, see the code examples in the External - // Identity Providers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html) + // Identity Providers (https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html) // section of the Amazon Cognito Developer Guide. Logins map[string]string diff --git a/service/cognitoidentity/api_op_GetId.go b/service/cognitoidentity/api_op_GetId.go index 7f940fbe954..f835960384c 100644 --- a/service/cognitoidentity/api_op_GetId.go +++ b/service/cognitoidentity/api_op_GetId.go @@ -40,22 +40,13 @@ type GetIdInput struct { // A set of optional name-value pairs that map provider names to provider tokens. // The available provider names for Logins are as follows: - // - // * Facebook: - // graph.facebook.com - // - // * Amazon Cognito user pool: cognito-idp..amazonaws.com/, for - // example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. - // - // * Google: - // accounts.google.com - // - // * Amazon: www.amazon.com - // - // * Twitter: api.twitter.com - // - // * - // Digits: www.digits.com + // - Facebook: graph.facebook.com + // - Amazon Cognito user pool: cognito-idp..amazonaws.com/ , for example, + // cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 . + // - Google: accounts.google.com + // - Amazon: www.amazon.com + // - Twitter: api.twitter.com + // - Digits: www.digits.com Logins map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go index 41136174d78..c62c1f96f3f 100644 --- a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go +++ b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go @@ -46,7 +46,7 @@ type GetIdentityPoolRolesOutput struct { IdentityPoolId *string // How users for a specific identity provider are to mapped to roles. This is a - // String-to-RoleMapping object map. The string identifies the identity provider, + // String-to- RoleMapping object map. The string identifies the identity provider, // for example, "graph.facebook.com" or // "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". RoleMappings map[string]types.RoleMapping diff --git a/service/cognitoidentity/api_op_GetOpenIdToken.go b/service/cognitoidentity/api_op_GetOpenIdToken.go index 04a9bb65b0b..433410fcdfd 100644 --- a/service/cognitoidentity/api_op_GetOpenIdToken.go +++ b/service/cognitoidentity/api_op_GetOpenIdToken.go @@ -10,7 +10,7 @@ import ( ) // Gets an OpenID token, using a known Cognito ID. This known Cognito ID is -// returned by GetId. You can optionally add additional logins for the identity. +// returned by GetId . You can optionally add additional logins for the identity. // Supplying multiple logins creates an implicit link. The OpenID token is valid // for 10 minutes. This is a public API. You do not need any credentials to call // this API. @@ -41,7 +41,7 @@ type GetOpenIdTokenInput struct { // When using graph.facebook.com and www.amazon.com, supply the access_token // returned from the provider's authflow. For accounts.google.com, an Amazon // Cognito user pool provider, or any other OpenID Connect provider, always include - // the id_token. + // the id_token . Logins map[string]string noSmithyDocumentSerde @@ -50,8 +50,8 @@ type GetOpenIdTokenInput struct { // Returned in response to a successful GetOpenIdToken request. type GetOpenIdTokenOutput struct { - // A unique identifier in the format REGION:GUID. Note that the IdentityId returned - // may not match the one passed on input. + // A unique identifier in the format REGION:GUID. Note that the IdentityId + // returned may not match the one passed on input. IdentityId *string // An OpenID token, valid for 10 minutes. diff --git a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go index 24d860c048d..75efb4ef846 100644 --- a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go @@ -20,8 +20,8 @@ import ( // developer provider) to an existing identity. When you want to create a new // identity, the IdentityId should be null. When you want to associate a new login // with an existing authenticated/unauthenticated identity, you can do so by -// providing the existing IdentityId. This API will create the identity in the -// specified IdentityPoolId. You must use AWS Developer credentials to call this +// providing the existing IdentityId . This API will create the identity in the +// specified IdentityPoolId . You must use AWS Developer credentials to call this // API. func (c *Client) GetOpenIdTokenForDeveloperIdentity(ctx context.Context, params *GetOpenIdTokenForDeveloperIdentityInput, optFns ...func(*Options)) (*GetOpenIdTokenForDeveloperIdentityOutput, error) { if params == nil { @@ -49,7 +49,7 @@ type GetOpenIdTokenForDeveloperIdentityInput struct { // A set of optional name-value pairs that map provider names to provider tokens. // Each name-value pair represents a user from a public provider or developer // provider. If the user is from a developer provider, the name-value pair will - // follow the syntax "developer_provider_name": "developer_user_identifier". The + // follow the syntax "developer_provider_name": "developer_user_identifier" . The // developer provider is the "domain" by which Cognito will refer to your users; // you provided this domain while creating/updating the identity pool. The // developer user identifier is an identifier from your backend that uniquely diff --git a/service/cognitoidentity/api_op_GetPrincipalTagAttributeMap.go b/service/cognitoidentity/api_op_GetPrincipalTagAttributeMap.go index a47aa04f91e..ef277f0a932 100644 --- a/service/cognitoidentity/api_op_GetPrincipalTagAttributeMap.go +++ b/service/cognitoidentity/api_op_GetPrincipalTagAttributeMap.go @@ -52,7 +52,7 @@ type GetPrincipalTagAttributeMapOutput struct { // You can use this operation to get the provider name. IdentityProviderName *string - // You can use this operation to add principal tags. The PrincipalTagsoperation + // You can use this operation to add principal tags. The PrincipalTags operation // enables you to reference user attributes in your IAM permissions policy. PrincipalTags map[string]string diff --git a/service/cognitoidentity/api_op_ListIdentities.go b/service/cognitoidentity/api_op_ListIdentities.go index b8da81a7b5a..b2d9d90e320 100644 --- a/service/cognitoidentity/api_op_ListIdentities.go +++ b/service/cognitoidentity/api_op_ListIdentities.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the identities in an identity pool. You must use AWS Developer credentials -// to call this API. +// Lists the identities in an identity pool. You must use AWS Developer +// credentials to call this API. func (c *Client) ListIdentities(ctx context.Context, params *ListIdentitiesInput, optFns ...func(*Options)) (*ListIdentitiesOutput, error) { if params == nil { params = &ListIdentitiesInput{} diff --git a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go index 8f9be3b7fcf..7d1a5ab5c73 100644 --- a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go @@ -15,7 +15,7 @@ import ( // identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you // supply only one of these values, the other value will be searched in the // database and returned as a part of the response. If you supply both, -// DeveloperUserIdentifier will be matched against IdentityID. If the values are +// DeveloperUserIdentifier will be matched against IdentityID . If the values are // verified against the database, the response returns both values and is the same // as the request. Otherwise a ResourceConflictException is thrown. // LookupDeveloperIdentity is intended for low-throughput control plane operations: @@ -60,10 +60,10 @@ type LookupDeveloperIdentityInput struct { // A pagination token. The first call you make will have NextToken set to null. // After that the service will return NextToken values as needed. For example, - // let's say you make a request with MaxResults set to 10, and there are 20 matches - // in the database. The service will return a pagination token as a part of the - // response. This token can be used to call the API again and get results starting - // from the 11th match. + // let's say you make a request with MaxResults set to 10, and there are 20 + // matches in the database. The service will return a pagination token as a part of + // the response. This token can be used to call the API again and get results + // starting from the 11th match. NextToken *string noSmithyDocumentSerde @@ -82,10 +82,10 @@ type LookupDeveloperIdentityOutput struct { // A pagination token. The first call you make will have NextToken set to null. // After that the service will return NextToken values as needed. For example, - // let's say you make a request with MaxResults set to 10, and there are 20 matches - // in the database. The service will return a pagination token as a part of the - // response. This token can be used to call the API again and get results starting - // from the 11th match. + // let's say you make a request with MaxResults set to 10, and there are 20 + // matches in the database. The service will return a pagination token as a part of + // the response. This token can be used to call the API again and get results + // starting from the 11th match. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go index cb34c5520d8..acfe5d1dd1c 100644 --- a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go +++ b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go @@ -10,16 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Merges two users having different IdentityIds, existing in the same identity +// Merges two users having different IdentityId s, existing in the same identity // pool, and identified by the same developer provider. You can use this action to // request that discrete users be merged and identified as a single user in the -// Cognito environment. Cognito associates the given source user -// (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. +// Cognito environment. Cognito associates the given source user ( +// SourceUserIdentifier ) with the IdentityId of the DestinationUserIdentifier . // Only developer-authenticated users can be merged. If the users to be merged are // associated with the same public provider, but as two different users, an // exception will be thrown. The number of linked logins is limited to 20. So, the -// number of linked logins for the source user, SourceUserIdentifier, and the -// destination user, DestinationUserIdentifier, together should not be larger than +// number of linked logins for the source user, SourceUserIdentifier , and the +// destination user, DestinationUserIdentifier , together should not be larger than // 20. Otherwise, an exception will be thrown. You must use AWS Developer // credentials to call this API. func (c *Client) MergeDeveloperIdentities(ctx context.Context, params *MergeDeveloperIdentitiesInput, optFns ...func(*Options)) (*MergeDeveloperIdentitiesOutput, error) { @@ -41,7 +41,7 @@ func (c *Client) MergeDeveloperIdentities(ctx context.Context, params *MergeDeve type MergeDeveloperIdentitiesInput struct { // User identifier for the destination user. The value should be a - // DeveloperUserIdentifier. + // DeveloperUserIdentifier . // // This member is required. DestinationUserIdentifier *string @@ -49,8 +49,8 @@ type MergeDeveloperIdentitiesInput struct { // The "domain" by which Cognito will refer to your users. This is a (pseudo) // domain name that you provide while creating an identity pool. This name acts as // a placeholder that allows your backend and the Cognito service to communicate - // about the developer provider. For the DeveloperProviderName, you can use letters - // as well as period (.), underscore (_), and dash (-). + // about the developer provider. For the DeveloperProviderName , you can use + // letters as well as period (.), underscore (_), and dash (-). // // This member is required. DeveloperProviderName *string @@ -61,7 +61,7 @@ type MergeDeveloperIdentitiesInput struct { IdentityPoolId *string // User identifier for the source user. The value should be a - // DeveloperUserIdentifier. + // DeveloperUserIdentifier . // // This member is required. SourceUserIdentifier *string diff --git a/service/cognitoidentity/api_op_SetPrincipalTagAttributeMap.go b/service/cognitoidentity/api_op_SetPrincipalTagAttributeMap.go index 2fdfddc78a6..ea66d037dcd 100644 --- a/service/cognitoidentity/api_op_SetPrincipalTagAttributeMap.go +++ b/service/cognitoidentity/api_op_SetPrincipalTagAttributeMap.go @@ -57,7 +57,7 @@ type SetPrincipalTagAttributeMapOutput struct { // The provider name you want to use for attribute mappings. IdentityProviderName *string - // You can use this operation to add principal tags. The PrincipalTagsoperation + // You can use this operation to add principal tags. The PrincipalTags operation // enables you to reference user attributes in your IAM permissions policy. PrincipalTags map[string]string diff --git a/service/cognitoidentity/api_op_UpdateIdentityPool.go b/service/cognitoidentity/api_op_UpdateIdentityPool.go index 5e59b19bbb0..8688158f14e 100644 --- a/service/cognitoidentity/api_op_UpdateIdentityPool.go +++ b/service/cognitoidentity/api_op_UpdateIdentityPool.go @@ -47,8 +47,7 @@ type UpdateIdentityPoolInput struct { IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) // in the Amazon Cognito Developer Guide. AllowClassicFlow *bool @@ -95,8 +94,7 @@ type UpdateIdentityPoolOutput struct { IdentityPoolName *string // Enables or disables the Basic (Classic) authentication flow. For more - // information, see Identity Pools (Federated Identities) Authentication Flow - // (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) + // information, see Identity Pools (Federated Identities) Authentication Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) // in the Amazon Cognito Developer Guide. AllowClassicFlow *bool diff --git a/service/cognitoidentity/doc.go b/service/cognitoidentity/doc.go index aeabc528ba3..846fb3e373a 100644 --- a/service/cognitoidentity/doc.go +++ b/service/cognitoidentity/doc.go @@ -1,21 +1,20 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package cognitoidentity provides the API client, operations, and parameter types -// for Amazon Cognito Identity. +// Package cognitoidentity provides the API client, operations, and parameter +// types for Amazon Cognito Identity. // -// Amazon Cognito Federated Identities Amazon Cognito Federated Identities is a web -// service that delivers scoped temporary credentials to mobile devices and other -// untrusted environments. It uniquely identifies a device and supplies the user -// with a consistent identity over the lifetime of an application. Using Amazon -// Cognito Federated Identities, you can enable authentication with one or more -// third-party identity providers (Facebook, Google, or Login with Amazon) or an -// Amazon Cognito user pool, and you can also choose to support unauthenticated +// Amazon Cognito Federated Identities Amazon Cognito Federated Identities is a +// web service that delivers scoped temporary credentials to mobile devices and +// other untrusted environments. It uniquely identifies a device and supplies the +// user with a consistent identity over the lifetime of an application. Using +// Amazon Cognito Federated Identities, you can enable authentication with one or +// more third-party identity providers (Facebook, Google, or Login with Amazon) or +// an Amazon Cognito user pool, and you can also choose to support unauthenticated // access from your app. Cognito delivers a unique identifier for each user and // acts as an OpenID token provider trusted by AWS Security Token Service (STS) to // access temporary, limited-privilege AWS credentials. For a description of the // authentication flow from the Amazon Cognito Developer Guide see Authentication -// Flow -// (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html). -// For more information see Amazon Cognito Federated Identities -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html). +// Flow (https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html) +// . For more information see Amazon Cognito Federated Identities (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html) +// . package cognitoidentity diff --git a/service/cognitoidentity/types/enums.go b/service/cognitoidentity/types/enums.go index 0455b48bc4c..adb9a5d9538 100644 --- a/service/cognitoidentity/types/enums.go +++ b/service/cognitoidentity/types/enums.go @@ -28,9 +28,9 @@ const ( ErrorCodeInternalServerError ErrorCode = "InternalServerError" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "AccessDenied", diff --git a/service/cognitoidentity/types/types.go b/service/cognitoidentity/types/types.go index 0e929b48372..9498d10df31 100644 --- a/service/cognitoidentity/types/types.go +++ b/service/cognitoidentity/types/types.go @@ -14,7 +14,7 @@ type CognitoIdentityProvider struct { ClientId *string // The provider name for an Amazon Cognito user pool. For example, - // cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. + // cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 . ProviderName *string // TRUE if server-side token validation is enabled for the identity provider’s @@ -86,7 +86,7 @@ type MappingRule struct { Claim *string // The match condition that specifies how closely the claim value in the IdP token - // must match Value. + // must match Value . // // This member is required. MatchType MappingRuleMatchType @@ -114,10 +114,10 @@ type RoleMapping struct { // This member is required. Type RoleMappingType - // If you specify Token or Rules as the Type, AmbiguousRoleResolution is required. - // Specifies the action to be taken if either no rules match the claim value for - // the Rules type, or there is no cognito:preferred_role claim and there are - // multiple cognito:roles matches for the Token type. + // If you specify Token or Rules as the Type , AmbiguousRoleResolution is + // required. Specifies the action to be taken if either no rules match the claim + // value for the Rules type, or there is no cognito:preferred_role claim and there + // are multiple cognito:roles matches for the Token type. AmbiguousRoleResolution AmbiguousRoleResolutionType // The rules to be used for mapping users to roles. If you specify Rules as the diff --git a/service/cognitoidentityprovider/api_client.go b/service/cognitoidentityprovider/api_client.go index dc2ad975a8d..cf738e75b61 100644 --- a/service/cognitoidentityprovider/api_client.go +++ b/service/cognitoidentityprovider/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go index 8773ea7022c..d7bf93d1c14 100644 --- a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go @@ -48,22 +48,17 @@ type AdminConfirmSignUpInput struct { // this payload, the clientMetadata attribute provides the data that you assigned // to the ClientMetadata parameter in your AdminConfirmSignUp request. In your // function code in Lambda, you can process the ClientMetadata value to enhance - // your workflow for your specific needs. For more information, see Customizing - // user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // your workflow for your specific needs. For more information, see Customizing + // user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminCreateUser.go b/service/cognitoidentityprovider/api_op_AdminCreateUser.go index d0c642fe8a9..079a71e729b 100644 --- a/service/cognitoidentityprovider/api_op_AdminCreateUser.go +++ b/service/cognitoidentityprovider/api_op_AdminCreateUser.go @@ -16,25 +16,24 @@ import ( // generate an SMS text message. Starting June 1, 2021, US telecom carriers require // you to register an origination phone number before you can send SMS messages to // US phone numbers. If you use SMS text messages in Amazon Cognito, you must -// register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. This message is based on a template that // you configured in your call to create or update a user pool. This template // includes your custom sign-up instructions and placeholders for user name and // temporary password. Alternatively, you can call AdminCreateUser with SUPPRESS // for the MessageAction parameter, and Amazon Cognito won't send any email. In -// either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign -// in and change their password. AdminCreateUser requires developer credentials. +// either case, the user will be in the FORCE_CHANGE_PASSWORD state until they +// sign in and change their password. AdminCreateUser requires developer +// credentials. func (c *Client) AdminCreateUser(ctx context.Context, params *AdminCreateUserInput, optFns ...func(*Options)) (*AdminCreateUserOutput, error) { if params == nil { params = &AdminCreateUserInput{} @@ -74,49 +73,44 @@ type AdminCreateUserInput struct { // attribute, which provides the data that you assigned to the ClientMetadata // parameter in your AdminCreateUser request. In your function code in Lambda, you // can process the clientMetadata value to enhance your workflow for your specific - // needs. For more information, see Customizing user pool Workflows with Lambda - // Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // needs. For more information, see Customizing user pool Workflows with Lambda + // Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" - // if the phone number will be used. The default value is "SMS". You can specify + // if the phone number will be used. The default value is "SMS" . You can specify // more than one value. DesiredDeliveryMediums []types.DeliveryMediumType // This parameter is used only if the phone_number_verified or email_verified - // attribute is set to True. Otherwise, it is ignored. If this parameter is set to + // attribute is set to True . Otherwise, it is ignored. If this parameter is set to // True and the phone number or email address specified in the UserAttributes // parameter already exists as an alias with a different user, the API call will // migrate the alias from the previous user to the newly created user. The previous // user will no longer be able to log in using that alias. If this parameter is set - // to False, the API throws an AliasExistsException error if the alias already - // exists. The default value is False. + // to False , the API throws an AliasExistsException error if the alias already + // exists. The default value is False . ForceAliasCreation bool - // Set to RESEND to resend the invitation message to a user that already exists and - // reset the expiration limit on the user's account. Set to SUPPRESS to suppress - // sending the message. You can specify only one value. + // Set to RESEND to resend the invitation message to a user that already exists + // and reset the expiration limit on the user's account. Set to SUPPRESS to + // suppress sending the message. You can specify only one value. MessageAction types.MessageActionType - // The user's temporary password. This password must conform to the password policy - // that you specified when you created the user pool. The temporary password is - // valid only once. To complete the Admin Create User flow, the user must enter the - // temporary password in the sign-in page, along with a new password to be used in - // all future sign-ins. This parameter isn't required. If you don't specify a + // The user's temporary password. This password must conform to the password + // policy that you specified when you created the user pool. The temporary password + // is valid only once. To complete the Admin Create User flow, the user must enter + // the temporary password in the sign-in page, along with a new password to be used + // in all future sign-ins. This parameter isn't required. If you don't specify a // value, Amazon Cognito generates one for you. The temporary password can only be // used until the user account expiration limit that you specified when you created // the user pool. To reset the account after that time limit, you must call @@ -125,29 +119,26 @@ type AdminCreateUserInput struct { // An array of name-value pairs that contain user attributes and attribute values // to be set for the user to be created. You can create a user without specifying - // any attributes other than Username. However, any attributes that you specify as + // any attributes other than Username . However, any attributes that you specify as // required (when creating a user pool or in the Attributes tab of the console) - // either you should supply (in your call to AdminCreateUser) or the user should + // either you should supply (in your call to AdminCreateUser ) or the user should // supply (when they sign up in response to your welcome message). For custom - // attributes, you must prepend the custom: prefix to the attribute name. To send a - // message inviting the user to sign up, you must specify the user's email address - // or phone number. You can do this in your call to AdminCreateUser or in the Users - // tab of the Amazon Cognito console for managing your user pools. In your call to - // AdminCreateUser, you can set the email_verified attribute to True, and you can - // set the phone_number_verified attribute to True. You can also do this by calling - // AdminUpdateUserAttributes - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html). - // - // * - // email: The email address of the user to whom the message that contains the code - // and username will be sent. Required if the email_verified attribute is set to - // True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. - // - // * - // phone_number: The phone number of the user to whom the message that contains the - // code and username will be sent. Required if the phone_number_verified attribute - // is set to True, or if "SMS" is specified in the DesiredDeliveryMediums - // parameter. + // attributes, you must prepend the custom: prefix to the attribute name. To send + // a message inviting the user to sign up, you must specify the user's email + // address or phone number. You can do this in your call to AdminCreateUser or in + // the Users tab of the Amazon Cognito console for managing your user pools. In + // your call to AdminCreateUser , you can set the email_verified attribute to True + // , and you can set the phone_number_verified attribute to True . You can also do + // this by calling AdminUpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) + // . + // - email: The email address of the user to whom the message that contains the + // code and username will be sent. Required if the email_verified attribute is + // set to True , or if "EMAIL" is specified in the DesiredDeliveryMediums + // parameter. + // - phone_number: The phone number of the user to whom the message that + // contains the code and username will be sent. Required if the + // phone_number_verified attribute is set to True , or if "SMS" is specified in + // the DesiredDeliveryMediums parameter. UserAttributes []types.AttributeType // The user's validation data. This is an array of name-value pairs that contain diff --git a/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go b/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go index 1b4d3df94c5..f406d26d24b 100644 --- a/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go @@ -17,25 +17,24 @@ import ( // password to sign in. If the user to deactivate is a linked external IdP user, // any link between that user and an existing user is removed. When the external // user signs in again, and the user is no longer attached to the previously linked -// DestinationUser, the user must create a new user account. See -// AdminLinkProviderForUser -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html). -// This action is enabled only for admin access and requires developer credentials. -// The ProviderName must match the value specified when creating an IdP for the -// pool. To deactivate a native username + password user, the ProviderName value -// must be Cognito and the ProviderAttributeName must be Cognito_Subject. The -// ProviderAttributeValue must be the name that is used in the user pool for the -// user. The ProviderAttributeName must always be Cognito_Subject for social IdPs. -// The ProviderAttributeValue must always be the exact subject that was used when -// the user was originally linked as a source user. For de-linking a SAML identity, -// there are two scenarios. If the linked identity has not yet been used to sign -// in, the ProviderAttributeName and ProviderAttributeValue must be the same values -// that were used for the SourceUser when the identities were originally linked -// using AdminLinkProviderForUser call. (If the linking was done with -// ProviderAttributeName set to Cognito_Subject, the same applies here). However, -// if the user has already signed in, the ProviderAttributeName must be -// Cognito_Subject and ProviderAttributeValue must be the subject of the SAML -// assertion. +// DestinationUser , the user must create a new user account. See +// AdminLinkProviderForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html) +// . This action is enabled only for admin access and requires developer +// credentials. The ProviderName must match the value specified when creating an +// IdP for the pool. To deactivate a native username + password user, the +// ProviderName value must be Cognito and the ProviderAttributeName must be +// Cognito_Subject . The ProviderAttributeValue must be the name that is used in +// the user pool for the user. The ProviderAttributeName must always be +// Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the +// exact subject that was used when the user was originally linked as a source +// user. For de-linking a SAML identity, there are two scenarios. If the linked +// identity has not yet been used to sign in, the ProviderAttributeName and +// ProviderAttributeValue must be the same values that were used for the SourceUser +// when the identities were originally linked using AdminLinkProviderForUser call. +// (If the linking was done with ProviderAttributeName set to Cognito_Subject , the +// same applies here). However, if the user has already signed in, the +// ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must +// be the subject of the SAML assertion. func (c *Client) AdminDisableProviderForUser(ctx context.Context, params *AdminDisableProviderForUserInput, optFns ...func(*Options)) (*AdminDisableProviderForUserOutput, error) { if params == nil { params = &AdminDisableProviderForUserInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminGetUser.go b/service/cognitoidentityprovider/api_op_AdminGetUser.go index 792487dfb82..882dd0675af 100644 --- a/service/cognitoidentityprovider/api_op_AdminGetUser.go +++ b/service/cognitoidentityprovider/api_op_AdminGetUser.go @@ -55,7 +55,7 @@ type AdminGetUserOutput struct { // This member is required. Username *string - // Indicates that the status is enabled. + // Indicates that the status is enabled . Enabled bool // This response parameter is no longer supported. It provides information only @@ -78,29 +78,19 @@ type AdminGetUserOutput struct { UserLastModifiedDate *time.Time // The MFA options that are activated for the user. The possible values in this - // list are SMS_MFA and SOFTWARE_TOKEN_MFA. + // list are SMS_MFA and SOFTWARE_TOKEN_MFA . UserMFASettingList []string // The user status. Can be one of the following: - // - // * UNCONFIRMED - User has been - // created but not confirmed. - // - // * CONFIRMED - User has been confirmed. - // - // * ARCHIVED - - // User is no longer active. - // - // * UNKNOWN - User status isn't known. - // - // * - // RESET_REQUIRED - User is confirmed, but the user must request a code and reset - // their password before they can sign in. - // - // * FORCE_CHANGE_PASSWORD - The user is - // confirmed and the user can sign in using a temporary password, but on first - // sign-in, the user must change their password to a new value before doing - // anything else. + // - UNCONFIRMED - User has been created but not confirmed. + // - CONFIRMED - User has been confirmed. + // - ARCHIVED - User is no longer active. + // - UNKNOWN - User status isn't known. + // - RESET_REQUIRED - User is confirmed, but the user must request a code and + // reset their password before they can sign in. + // - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in + // using a temporary password, but on first sign-in, the user must change their + // password to a new value before doing anything else. UserStatus types.UserStatusType // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go index 5db01274a42..4856a1279d4 100644 --- a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go @@ -15,18 +15,16 @@ import ( // generate an SMS text message. Starting June 1, 2021, US telecom carriers require // you to register an origination phone number before you can send SMS messages to // US phone numbers. If you use SMS text messages in Amazon Cognito, you must -// register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. Calling this action requires developer // credentials. func (c *Client) AdminInitiateAuth(ctx context.Context, params *AdminInitiateAuthInput, optFns ...func(*Options)) (*AdminInitiateAuthOutput, error) { @@ -47,39 +45,26 @@ func (c *Client) AdminInitiateAuth(ctx context.Context, params *AdminInitiateAut // Initiates the authorization request, as an administrator. type AdminInitiateAuthInput struct { - // The authentication flow for this call to run. The API action will depend on this - // value. For example: - // - // * REFRESH_TOKEN_AUTH will take in a valid refresh token and - // return new tokens. - // - // * USER_SRP_AUTH will take in USERNAME and SRP_A and return - // the Secure Remote Password (SRP) protocol variables to be used for next - // challenge execution. - // - // * ADMIN_USER_PASSWORD_AUTH will take in USERNAME and - // PASSWORD and return the next challenge or tokens. - // + // The authentication flow for this call to run. The API action will depend on + // this value. For example: + // - REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. + // - USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote + // Password (SRP) protocol variables to be used for next challenge execution. + // - ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the + // next challenge or tokens. // Valid values include: - // - // * - // USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) - // protocol. - // - // * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for - // refreshing the access token and ID token by supplying a valid refresh token. - // - // * - // CUSTOM_AUTH: Custom authentication flow. - // - // * ADMIN_NO_SRP_AUTH: Non-SRP - // authentication flow; you can pass in the USERNAME and PASSWORD directly if the - // flow is enabled for calling the app client. - // - // * ADMIN_USER_PASSWORD_AUTH: - // Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH - // authentication flow. In this flow, Amazon Cognito receives the password in the - // request instead of using the SRP process to verify passwords. + // - USER_SRP_AUTH : Authentication flow for the Secure Remote Password (SRP) + // protocol. + // - REFRESH_TOKEN_AUTH / REFRESH_TOKEN : Authentication flow for refreshing the + // access token and ID token by supplying a valid refresh token. + // - CUSTOM_AUTH : Custom authentication flow. + // - ADMIN_NO_SRP_AUTH : Non-SRP authentication flow; you can pass in the + // USERNAME and PASSWORD directly if the flow is enabled for calling the app + // client. + // - ADMIN_USER_PASSWORD_AUTH : Admin-based user password authentication. This + // replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon + // Cognito receives the password in the request instead of using the SRP process to + // verify passwords. // // This member is required. AuthFlow types.AuthFlowType @@ -99,79 +84,52 @@ type AdminInitiateAuthInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // The authentication parameters. These are inputs corresponding to the AuthFlow - // that you're invoking. The required values depend on the value of AuthFlow: - // - // * - // For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required - // if the app client is configured with a client secret), DEVICE_KEY. - // - // * For - // REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH - // (required if the app client is configured with a client secret), DEVICE_KEY. - // - // * - // For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is - // configured with client secret), PASSWORD (required), DEVICE_KEY. - // - // * For - // CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with - // client secret), DEVICE_KEY. To start the authentication flow with password - // verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value). + // that you're invoking. The required values depend on the value of AuthFlow : + // - For USER_SRP_AUTH : USERNAME (required), SRP_A (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY . + // - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN : REFRESH_TOKEN (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY . + // - For ADMIN_NO_SRP_AUTH : USERNAME (required), SECRET_HASH (if app client is + // configured with client secret), PASSWORD (required), DEVICE_KEY . + // - For CUSTOM_AUTH : USERNAME (required), SECRET_HASH (if app client is + // configured with client secret), DEVICE_KEY . To start the authentication flow + // with password verification, include ChallengeName: SRP_A and SRP_A: (The + // SRP_A Value) . AuthParameters map[string]string - // A map of custom key-value pairs that you can provide as input for certain custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the AdminInitiateAuth API - // action, Amazon Cognito invokes the Lambda functions that are specified for - // various triggers. The ClientMetadata value is passed as input to the functions - // for only the following triggers: - // - // * Pre signup - // - // * Pre authentication - // - // * User - // migration - // - // When Amazon Cognito invokes the functions for these triggers, it - // passes a JSON payload, which the function receives as input. This payload - // contains a validationData attribute, which provides the data that you assigned - // to the ClientMetadata parameter in your AdminInitiateAuth request. In your - // function code in Lambda, you can process the validationData value to enhance - // your workflow for your specific needs. When you use the AdminInitiateAuth API - // action, Amazon Cognito also invokes the functions for the following triggers, - // but it doesn't provide the ClientMetadata value as input: - // - // * Post - // authentication - // - // * Custom message - // - // * Pre token generation - // - // * Create auth - // challenge - // - // * Define auth challenge - // - // * Verify auth challenge - // - // For more - // information, see Customizing user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // A map of custom key-value pairs that you can provide as input for certain + // custom workflows that this action triggers. You create custom workflows by + // assigning Lambda functions to user pool triggers. When you use the + // AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that + // are specified for various triggers. The ClientMetadata value is passed as input + // to the functions for only the following triggers: + // - Pre signup + // - Pre authentication + // - User migration + // When Amazon Cognito invokes the functions for these triggers, it passes a JSON + // payload, which the function receives as input. This payload contains a + // validationData attribute, which provides the data that you assigned to the + // ClientMetadata parameter in your AdminInitiateAuth request. In your function + // code in Lambda, you can process the validationData value to enhance your + // workflow for your specific needs. When you use the AdminInitiateAuth API action, + // Amazon Cognito also invokes the functions for the following triggers, but it + // doesn't provide the ClientMetadata value as input: + // - Post authentication + // - Custom message + // - Pre token generation + // - Create auth challenge + // - Define auth challenge + // - Verify auth challenge + // For more information, see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -188,85 +146,70 @@ type AdminInitiateAuthOutput struct { // The result of the authentication response. This is only returned if the caller // doesn't need to pass another challenge. If the caller does need to pass another - // challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session - // are returned. + // challenge before it gets tokens, ChallengeName , ChallengeParameters , and + // Session are returned. AuthenticationResult *types.AuthenticationResultType // The name of the challenge that you're responding to with this call. This is - // returned in the AdminInitiateAuth response if you must pass another - // challenge. - // - // * MFA_SETUP: If MFA is required, users who don't have at least one - // of the MFA methods set up are presented with an MFA_SETUP challenge. The user - // must set up at least one MFA type to continue to authenticate. - // - // * - // SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text - // SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software - // token MFA. - // - // * SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered - // via SMS. - // - // * PASSWORD_VERIFIER: Next challenge is to supply - // PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the - // client-side SRP calculations. - // - // * CUSTOM_CHALLENGE: This is returned if your - // custom authentication flow determines that the user should pass another - // challenge before tokens are issued. - // - // * DEVICE_SRP_AUTH: If device tracking was - // activated in your user pool and the previous challenges were passed, this - // challenge is returned so that Amazon Cognito can start tracking this device. - // - // * - // DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. - // - // * - // ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and - // PASSWORD directly. An app client must be enabled to use this flow. - // - // * - // NEW_PASSWORD_REQUIRED: For users who are required to change their passwords - // after successful first login. Respond to this challenge with NEW_PASSWORD and - // any required attributes that Amazon Cognito returned in the requiredAttributes - // parameter. You can also set values for attributes that aren't required by your - // user pool and that your app client can write. For more information, see - // AdminRespondToAuthChallenge - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html). - // In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required - // attribute that already has a value. In AdminRespondToAuthChallenge, set a value - // for any keys that Amazon Cognito returned in the requiredAttributes parameter, - // then use the AdminUpdateUserAttributes API operation to modify the value of any - // additional attributes. - // - // * MFA_SETUP: For users who are required to set up an MFA - // factor before they can sign in. The MFA types activated for the user pool will - // be listed in the challenge parameters MFA_CAN_SETUP value. To set up software - // token MFA, use the session returned here from InitiateAuth as an input to - // AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as - // an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete - // sign-in. To set up SMS MFA, users will need help from an administrator to add a - // phone number to their account and then call InitiateAuth again to restart - // sign-in. + // returned in the AdminInitiateAuth response if you must pass another challenge. + // - MFA_SETUP : If MFA is required, users who don't have at least one of the MFA + // methods set up are presented with an MFA_SETUP challenge. The user must set up + // at least one MFA type to continue to authenticate. + // - SELECT_MFA_TYPE : Selects the MFA type. Valid MFA options are SMS_MFA for + // text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) + // software token MFA. + // - SMS_MFA : Next challenge is to supply an SMS_MFA_CODE , delivered via SMS. + // - PASSWORD_VERIFIER : Next challenge is to supply PASSWORD_CLAIM_SIGNATURE , + // PASSWORD_CLAIM_SECRET_BLOCK , and TIMESTAMP after the client-side SRP + // calculations. + // - CUSTOM_CHALLENGE : This is returned if your custom authentication flow + // determines that the user should pass another challenge before tokens are issued. + // + // - DEVICE_SRP_AUTH : If device tracking was activated in your user pool and the + // previous challenges were passed, this challenge is returned so that Amazon + // Cognito can start tracking this device. + // - DEVICE_PASSWORD_VERIFIER : Similar to PASSWORD_VERIFIER , but for devices + // only. + // - ADMIN_NO_SRP_AUTH : This is returned if you must authenticate with USERNAME + // and PASSWORD directly. An app client must be enabled to use this flow. + // - NEW_PASSWORD_REQUIRED : For users who are required to change their passwords + // after successful first login. Respond to this challenge with NEW_PASSWORD and + // any required attributes that Amazon Cognito returned in the requiredAttributes + // parameter. You can also set values for attributes that aren't required by your + // user pool and that your app client can write. For more information, see + // AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html) + // . In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required + // attribute that already has a value. In AdminRespondToAuthChallenge , set a + // value for any keys that Amazon Cognito returned in the requiredAttributes + // parameter, then use the AdminUpdateUserAttributes API operation to modify the + // value of any additional attributes. + // - MFA_SETUP : For users who are required to set up an MFA factor before they + // can sign in. The MFA types activated for the user pool will be listed in the + // challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use + // the session returned here from InitiateAuth as an input to + // AssociateSoftwareToken , and use the session returned by VerifySoftwareToken + // as an input to RespondToAuthChallenge with challenge name MFA_SETUP to + // complete sign-in. To set up SMS MFA, users will need help from an administrator + // to add a phone number to their account and then call InitiateAuth again to + // restart sign-in. ChallengeName types.ChallengeNameType // The challenge parameters. These are returned to you in the AdminInitiateAuth // response if you must pass another challenge. The responses in this parameter - // should be used to compute inputs to the next call (AdminRespondToAuthChallenge). - // All challenges require USERNAME and SECRET_HASH (if applicable). The value of - // the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such - // as email address or phone number), even if you specified an alias in your call - // to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge - // API ChallengeResponses, the USERNAME attribute can't be an alias. + // should be used to compute inputs to the next call ( AdminRespondToAuthChallenge + // ). All challenges require USERNAME and SECRET_HASH (if applicable). The value + // of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias + // (such as email address or phone number), even if you specified an alias in your + // call to AdminInitiateAuth . This happens because, in the + // AdminRespondToAuthChallenge API ChallengeResponses , the USERNAME attribute + // can't be an alias. ChallengeParameters map[string]string // The session that should be passed both ways in challenge-response calls to the - // service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines - // that the caller must pass another challenge, they return a session with other - // challenge parameters. This session should be passed as it is to the next - // AdminRespondToAuthChallenge API call. + // service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call + // determines that the caller must pass another challenge, they return a session + // with other challenge parameters. This session should be passed as it is to the + // next AdminRespondToAuthChallenge API call. Session *string // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go index 7edf5d7d41f..bdd7153955e 100644 --- a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Links an existing user account in a user pool (DestinationUser) to an identity -// from an external IdP (SourceUser) based on a specified attribute name and value -// from the external IdP. This allows you to create a link from the existing user -// account to an external federated user identity that has not yet been used to -// sign in. You can then use the federated user identity to sign in as the existing -// user account. For example, if there is an existing user with a username and -// password, this API links that user to a federated user identity. When the user -// signs in with a federated user identity, they sign in as the existing user +// Links an existing user account in a user pool ( DestinationUser ) to an identity +// from an external IdP ( SourceUser ) based on a specified attribute name and +// value from the external IdP. This allows you to create a link from the existing +// user account to an external federated user identity that has not yet been used +// to sign in. You can then use the federated user identity to sign in as the +// existing user account. For example, if there is an existing user with a username +// and password, this API links that user to a federated user identity. When the +// user signs in with a federated user identity, they sign in as the existing user // account. The maximum number of federated identities linked to a user is five. // Because this API allows a user with an external federated identity to sign in as // an existing user in the user pool, it is critical that it only be used with @@ -48,7 +48,7 @@ type AdminLinkProviderForUserInput struct { // returns this user when the new user (with the linked IdP attribute) signs in. // For a native username + password user, the ProviderAttributeValue for the // DestinationUser should be the username in the user pool. For a federated user, - // it should be the provider-specific user_id. The ProviderAttributeName of the + // it should be the provider-specific user_id . The ProviderAttributeName of the // DestinationUser is ignored. The ProviderName should be set to Cognito for users // in Cognito user pools. All attributes in the DestinationUser profile must be // mutable. If you have assigned the user any immutable custom attributes, the @@ -61,17 +61,17 @@ type AdminLinkProviderForUserInput struct { // user must be a federated user (for example, a SAML or Facebook user), not // another native user. If the SourceUser is using a federated social IdP, such as // Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName - // to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, - // or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, - // Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The - // ProviderAttributeValue for the user must be the same value as the id, sub, or - // user_id value found in the social IdP token. For SAML, the ProviderAttributeName - // can be any value that matches a claim in the SAML assertion. If you want to link - // SAML users based on the subject of the SAML assertion, you should map the - // subject to a claim through the SAML IdP and submit that claim name as the - // ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, - // Amazon Cognito will automatically parse the default unique identifier found in - // the subject from the SAML token. + // to Cognito_Subject . For social IdPs, the ProviderName will be Facebook , Google + // , or LoginWithAmazon , and Amazon Cognito will automatically parse the Facebook, + // Google, and Login with Amazon tokens for id , sub , and user_id , respectively. + // The ProviderAttributeValue for the user must be the same value as the id , sub , + // or user_id value found in the social IdP token. For SAML, the + // ProviderAttributeName can be any value that matches a claim in the SAML + // assertion. If you want to link SAML users based on the subject of the SAML + // assertion, you should map the subject to a claim through the SAML IdP and submit + // that claim name as the ProviderAttributeName . If you set ProviderAttributeName + // to Cognito_Subject , Amazon Cognito will automatically parse the default unique + // identifier found in the subject from the SAML token. // // This member is required. SourceUser *types.ProviderUserIdentifierType diff --git a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go index c4e474b3d51..ab472cb8c71 100644 --- a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go +++ b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go @@ -53,8 +53,8 @@ type AdminListUserAuthEventsInput struct { type AdminListUserAuthEventsOutput struct { - // The response object. It includes the EventID, EventType, CreationDate, - // EventRisk, and EventResponse. + // The response object. It includes the EventID , EventType , CreationDate , + // EventRisk , and EventResponse . AuthEvents []types.AuthEventType // A pagination token. diff --git a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go index f6a6b97f12d..cd14c41241f 100644 --- a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go @@ -23,17 +23,16 @@ import ( // June 1, 2021, US telecom carriers require you to register an origination phone // number before you can send SMS messages to US phone numbers. If you use SMS text // messages in Amazon Cognito, you must register a phone number with Amazon -// Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses +// Pinpoint (https://console.aws.amazon.com/pinpoint/home/) . Amazon Cognito uses // the registered number automatically. Otherwise, Amazon Cognito users who must // receive SMS messages might not be able to sign up, activate their accounts, or // sign in. If you have never used SMS text messages with Amazon Cognito or any // other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. Calling this action requires developer // credentials. func (c *Client) AdminResetUserPassword(ctx context.Context, params *AdminResetUserPasswordInput, optFns ...func(*Options)) (*AdminResetUserPasswordOutput, error) { @@ -73,22 +72,17 @@ type AdminResetUserPasswordInput struct { // clientMetadata attribute, which provides the data that you assigned to the // ClientMetadata parameter in your AdminResetUserPassword request. In your // function code in Lambda, you can process the clientMetadata value to enhance - // your workflow for your specific needs. For more information, see Customizing - // user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // your workflow for your specific needs. For more information, see Customizing + // user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go index 3e958c392ce..42b5076789c 100644 --- a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go @@ -15,18 +15,16 @@ import ( // generate an SMS text message. Starting June 1, 2021, US telecom carriers require // you to register an origination phone number before you can send SMS messages to // US phone numbers. If you use SMS text messages in Amazon Cognito, you must -// register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. Calling this action requires developer // credentials. func (c *Client) AdminRespondToAuthChallenge(ctx context.Context, params *AdminRespondToAuthChallengeInput, optFns ...func(*Options)) (*AdminRespondToAuthChallengeOutput, error) { @@ -47,8 +45,8 @@ func (c *Client) AdminRespondToAuthChallenge(ctx context.Context, params *AdminR // The request to respond to the authentication challenge, as an administrator. type AdminRespondToAuthChallengeInput struct { - // The challenge name. For more information, see AdminInitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html). + // The challenge name. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) + // . // // This member is required. ChallengeName types.ChallengeNameType @@ -68,40 +66,32 @@ type AdminRespondToAuthChallengeInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // The challenge responses. These are inputs corresponding to the value of - // ChallengeName, for example: - // - // * SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if - // app client is configured with client secret). - // - // * PASSWORD_VERIFIER: - // PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, - // SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER - // requires DEVICE_KEY when signing in with a remembered device. - // - // * - // ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured - // with client secret). - // - // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, - // SECRET_HASH (if app client is configured with client secret). To set any - // required attributes that Amazon Cognito returned as requiredAttributes in the - // AdminInitiateAuth response, add a userAttributes.attributename parameter. This - // parameter can also set values for writable attributes that aren't required by - // your user pool. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify - // a required attribute that already has a value. In AdminRespondToAuthChallenge, - // set a value for any keys that Amazon Cognito returned in the requiredAttributes - // parameter, then use the AdminUpdateUserAttributes API operation to modify the - // value of any additional attributes. - // - // * MFA_SETUP requires USERNAME, plus you - // must use the session value returned by VerifySoftwareToken in the Session - // parameter. - // - // The value of the USERNAME attribute must be the user's actual - // username, not an alias (such as an email address or phone number). To make this - // simpler, the AdminInitiateAuth response includes the actual username value in - // the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an - // alias in your call to AdminInitiateAuth. + // ChallengeName , for example: + // - SMS_MFA : SMS_MFA_CODE , USERNAME , SECRET_HASH (if app client is configured + // with client secret). + // - PASSWORD_VERIFIER : PASSWORD_CLAIM_SIGNATURE , PASSWORD_CLAIM_SECRET_BLOCK , + // TIMESTAMP , USERNAME , SECRET_HASH (if app client is configured with client + // secret). PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a + // remembered device. + // - ADMIN_NO_SRP_AUTH : PASSWORD , USERNAME , SECRET_HASH (if app client is + // configured with client secret). + // - NEW_PASSWORD_REQUIRED : NEW_PASSWORD , USERNAME , SECRET_HASH (if app client + // is configured with client secret). To set any required attributes that Amazon + // Cognito returned as requiredAttributes in the AdminInitiateAuth response, add + // a userAttributes.attributename parameter. This parameter can also set values + // for writable attributes that aren't required by your user pool. In a + // NEW_PASSWORD_REQUIRED challenge response, you can't modify a required + // attribute that already has a value. In AdminRespondToAuthChallenge , set a + // value for any keys that Amazon Cognito returned in the requiredAttributes + // parameter, then use the AdminUpdateUserAttributes API operation to modify the + // value of any additional attributes. + // - MFA_SETUP requires USERNAME , plus you must use the session value returned + // by VerifySoftwareToken in the Session parameter. + // The value of the USERNAME attribute must be the user's actual username, not an + // alias (such as an email address or phone number). To make this simpler, the + // AdminInitiateAuth response includes the actual username value in the + // USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias + // in your call to AdminInitiateAuth . ChallengeResponses map[string]string // A map of custom key-value pairs that you can provide as input for any custom @@ -109,47 +99,30 @@ type AdminRespondToAuthChallengeInput struct { // Lambda functions to user pool triggers. When you use the // AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions // that you have assigned to the following triggers: - // - // * pre sign-up - // - // * custom - // message - // - // * post authentication - // - // * user migration - // - // * pre token generation - // - // * - // define auth challenge - // - // * create auth challenge - // - // * verify auth challenge - // response - // - // When Amazon Cognito invokes any of these functions, it passes a JSON - // payload, which the function receives as input. This payload contains a - // clientMetadata attribute that provides the data that you assigned to the - // ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your - // function code in Lambda, you can process the clientMetadata value to enhance - // your workflow for your specific needs. For more information, see Customizing - // user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // - pre sign-up + // - custom message + // - post authentication + // - user migration + // - pre token generation + // - define auth challenge + // - create auth challenge + // - verify auth challenge response + // When Amazon Cognito invokes any of these functions, it passes a JSON payload, + // which the function receives as input. This payload contains a clientMetadata + // attribute that provides the data that you assigned to the ClientMetadata + // parameter in your AdminRespondToAuthChallenge request. In your function code in + // Lambda, you can process the clientMetadata value to enhance your workflow for + // your specific needs. For more information, see Customizing user pool Workflows + // with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -174,12 +147,12 @@ type AdminRespondToAuthChallengeOutput struct { // The result returned by the server in response to the authentication request. AuthenticationResult *types.AuthenticationResultType - // The name of the challenge. For more information, see AdminInitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html). + // The name of the challenge. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) + // . ChallengeName types.ChallengeNameType - // The challenge parameters. For more information, see AdminInitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html). + // The challenge parameters. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) + // . ChallengeParameters map[string]string // The session that should be passed both ways in challenge-response calls to the diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go index 1157467a939..5ef554aa680 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go @@ -17,7 +17,7 @@ import ( // NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, // the user won't be able to sign in, and an administrator must reset their // password. Once the user has set a new password, or the password is permanent, -// the user status is set to Confirmed. +// the user status is set to Confirmed . func (c *Client) AdminSetUserPassword(ctx context.Context, params *AdminSetUserPasswordInput, optFns ...func(*Options)) (*AdminSetUserPasswordOutput, error) { if params == nil { params = &AdminSetUserPasswordInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go b/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go index 0219b6a81ab..debbd927d9e 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go @@ -13,8 +13,7 @@ import ( // This action is no longer supported. You can use it to configure only SMS MFA. // You can't use it to configure time-based one-time password (TOTP) software token -// MFA. To configure either type of MFA, use AdminSetUserMFAPreference -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html) +// MFA. To configure either type of MFA, use AdminSetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html) // instead. func (c *Client) AdminSetUserSettings(ctx context.Context, params *AdminSetUserSettingsInput, optFns ...func(*Options)) (*AdminSetUserSettingsOutput, error) { if params == nil { diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go index a5706877193..2e40a97eda6 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go @@ -18,18 +18,16 @@ import ( // generate an SMS text message. Starting June 1, 2021, US telecom carriers require // you to register an origination phone number before you can send SMS messages to // US phone numbers. If you use SMS text messages in Amazon Cognito, you must -// register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. Calling this action requires developer // credentials. func (c *Client) AdminUpdateUserAttributes(ctx context.Context, params *AdminUpdateUserAttributesInput, optFns ...func(*Options)) (*AdminUpdateUserAttributesOutput, error) { @@ -59,9 +57,9 @@ type AdminUpdateUserAttributesInput struct { // Your user can sign in and receive messages with the original attribute value // until they verify the new value. To update the value of an attribute that // requires verification in the same API request, include the email_verified or - // phone_number_verified attribute, with a value of true. If you set the + // phone_number_verified attribute, with a value of true . If you set the // email_verified or phone_number_verified value for an email or phone_number - // attribute that requires verification to true, Amazon Cognito doesn’t send a + // attribute that requires verification to true , Amazon Cognito doesn’t send a // verification message to your user. // // This member is required. @@ -87,21 +85,16 @@ type AdminUpdateUserAttributesInput struct { // assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes // request. In your function code in Lambda, you can process the clientMetadata // value to enhance your workflow for your specific needs. For more information, - // see Customizing user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go index 81476eca594..b12a7cf787a 100644 --- a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go +++ b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests -// with Amazon Web Services credentials. It also invalidates all refresh tokens -// that Amazon Cognito has issued to a user. The user's current access and ID -// tokens remain valid until they expire. By default, access and ID tokens expire -// one hour after they're issued. A user can still use a hosted UI cookie to +// Signs out a user from all devices. You must sign AdminUserGlobalSignOut +// requests with Amazon Web Services credentials. It also invalidates all refresh +// tokens that Amazon Cognito has issued to a user. The user's current access and +// ID tokens remain valid until they expire. By default, access and ID tokens +// expire one hour after they're issued. A user can still use a hosted UI cookie to // retrieve new tokens for the duration of the cookie validity period of 1 hour. // Calling this action requires developer credentials. func (c *Client) AdminUserGlobalSignOut(ctx context.Context, params *AdminUserGlobalSignOutInput, optFns ...func(*Options)) (*AdminUserGlobalSignOutOutput, error) { diff --git a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go index 6e63c02a1dd..60e7acf3943 100644 --- a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go @@ -12,16 +12,16 @@ import ( // Begins setup of time-based one-time password (TOTP) multi-factor authentication // (MFA) for a user, with a unique private key that Amazon Cognito generates and -// returns in the API response. You can authorize an AssociateSoftwareToken request -// with either the user's access token, or a session string from a challenge -// response that you received from Amazon Cognito. Amazon Cognito disassociates an -// existing software token when you verify the new token in a VerifySoftwareToken -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html) +// returns in the API response. You can authorize an AssociateSoftwareToken +// request with either the user's access token, or a session string from a +// challenge response that you received from Amazon Cognito. Amazon Cognito +// disassociates an existing software token when you verify the new token in a +// VerifySoftwareToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html) // API request. If you don't verify the software token and your user pool doesn't // require MFA, the user can then authenticate with user name and password // credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates // an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. -// Complete setup with AssociateSoftwareToken and VerifySoftwareToken. After you +// Complete setup with AssociateSoftwareToken and VerifySoftwareToken . After you // set up software token MFA for your user, Amazon Cognito generates a // SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge // with your user's TOTP. @@ -42,8 +42,8 @@ func (c *Client) AssociateSoftwareToken(ctx context.Context, params *AssociateSo type AssociateSoftwareTokenInput struct { - // A valid access token that Amazon Cognito issued to the user whose software token - // you want to generate. + // A valid access token that Amazon Cognito issued to the user whose software + // token you want to generate. AccessToken *string // The session that should be passed both ways in challenge-response calls to the diff --git a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go index 9486ea6c79f..334886db3bb 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go @@ -34,9 +34,9 @@ type ConfirmForgotPasswordInput struct { // This member is required. ClientId *string - // The confirmation code from your user's request to reset their password. For more - // information, see ForgotPassword - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html). + // The confirmation code from your user's request to reset their password. For + // more information, see ForgotPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html) + // . // // This member is required. ConfirmationCode *string @@ -65,22 +65,17 @@ type ConfirmForgotPasswordInput struct { // clientMetadata attribute, which provides the data that you assigned to the // ClientMetadata parameter in your ConfirmForgotPassword request. In your function // code in Lambda, you can process the clientMetadata value to enhance your - // workflow for your specific needs. For more information, see Customizing user - // pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // workflow for your specific needs. For more information, see Customizing user + // pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key diff --git a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go index 014f766badb..fd9b951e716 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go @@ -57,29 +57,24 @@ type ConfirmSignUpInput struct { // clientMetadata attribute, which provides the data that you assigned to the // ClientMetadata parameter in your ConfirmSignUp request. In your function code in // Lambda, you can process the clientMetadata value to enhance your workflow for - // your specific needs. For more information, see Customizing user pool Workflows - // with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // your specific needs. For more information, see Customizing user pool Workflows + // with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // Boolean to be specified to force user confirmation irrespective of existing - // alias. By default set to False. If this parameter is set to True and the phone + // alias. By default set to False . If this parameter is set to True and the phone // number/email used for sign up confirmation already exists as an alias with a // different user, the API call will migrate the alias from the previous user to - // the newly created user being confirmed. If set to False, the API will throw an + // the newly created user being confirmed. If set to False , the API will throw an // AliasExistsException error. ForceAliasCreation bool diff --git a/service/cognitoidentityprovider/api_op_CreateGroup.go b/service/cognitoidentityprovider/api_op_CreateGroup.go index a5db7115b66..0400d6442aa 100644 --- a/service/cognitoidentityprovider/api_op_CreateGroup.go +++ b/service/cognitoidentityprovider/api_op_CreateGroup.go @@ -49,13 +49,13 @@ type CreateGroupInput struct { // precedence over groups with higher or null Precedence values. If a user belongs // to two or more groups, it is the group with the lowest precedence value whose // role ARN is given in the user's tokens for the cognito:roles and - // cognito:preferred_role claims. Two groups can have the same Precedence value. If - // this happens, neither group takes precedence over the other. If two groups with - // the same Precedence have the same role ARN, that role is used in the + // cognito:preferred_role claims. Two groups can have the same Precedence value. + // If this happens, neither group takes precedence over the other. If two groups + // with the same Precedence have the same role ARN, that role is used in the // cognito:preferred_role claim in tokens for users in each group. If the two // groups have different role ARNs, the cognito:preferred_role claim isn't set in // users' tokens. The default Precedence value is null. The maximum Precedence - // value is 2^31-1. + // value is 2^31-1 . Precedence *int32 // The role Amazon Resource Name (ARN) for the group. diff --git a/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go b/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go index 99aeb1baca1..55e81149a43 100644 --- a/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go @@ -31,78 +31,39 @@ type CreateIdentityProviderInput struct { // The IdP details. The following list describes the provider detail keys for each // IdP type. - // - // * For Google and Login with Amazon: - // - // * client_id - // - // * client_secret - // - // * - // authorize_scopes - // - // * For Facebook: - // - // * client_id - // - // * client_secret - // - // * - // authorize_scopes - // - // * api_version - // - // * For Sign in with Apple: - // - // * client_id - // - // * - // team_id - // - // * key_id - // - // * private_key - // - // * authorize_scopes - // - // * For OpenID Connect - // (OIDC) providers: - // - // * client_id - // - // * client_secret - // - // * attributes_request_method - // - // * - // oidc_issuer - // - // * authorize_scopes - // - // * The following keys are only present if Amazon - // Cognito didn't discover them at the oidc_issuer URL. - // - // * authorize_url - // - // * - // token_url - // - // * attributes_url - // - // * jwks_uri - // - // * Amazon Cognito sets the value of the - // following keys automatically. They are read-only. - // - // * - // attributes_url_add_attributes - // - // * For SAML providers: - // - // * MetadataFile or - // MetadataURL - // - // * IDPSignout optional + // - For Google and Login with Amazon: + // - client_id + // - client_secret + // - authorize_scopes + // - For Facebook: + // - client_id + // - client_secret + // - authorize_scopes + // - api_version + // - For Sign in with Apple: + // - client_id + // - team_id + // - key_id + // - private_key + // - authorize_scopes + // - For OpenID Connect (OIDC) providers: + // - client_id + // - client_secret + // - attributes_request_method + // - oidc_issuer + // - authorize_scopes + // - The following keys are only present if Amazon Cognito didn't discover them + // at the oidc_issuer URL. + // - authorize_url + // - token_url + // - attributes_url + // - jwks_uri + // - Amazon Cognito sets the value of the following keys automatically. They are + // read-only. + // - attributes_url_add_attributes + // - For SAML providers: + // - MetadataFile or MetadataURL + // - IDPSignout optional // // This member is required. ProviderDetails map[string]string diff --git a/service/cognitoidentityprovider/api_op_CreateResourceServer.go b/service/cognitoidentityprovider/api_op_CreateResourceServer.go index 4be9c5eb414..f8c19eff9bb 100644 --- a/service/cognitoidentityprovider/api_op_CreateResourceServer.go +++ b/service/cognitoidentityprovider/api_op_CreateResourceServer.go @@ -31,7 +31,7 @@ type CreateResourceServerInput struct { // A unique resource server identifier for the resource server. This could be an // HTTPS endpoint where the resource server is located, such as - // https://my-weather-api.example.com. + // https://my-weather-api.example.com . // // This member is required. Identifier *string @@ -47,7 +47,7 @@ type CreateResourceServerInput struct { UserPoolId *string // A list of scopes. Each scope is a key-value map with the keys name and - // description. + // description . Scopes []types.ResourceServerScopeType noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go index 227669ca850..06a50c580f1 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go +++ b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go @@ -49,8 +49,8 @@ type CreateUserImportJobInput struct { noSmithyDocumentSerde } -// Represents the response from the server to the request to create the user import -// job. +// Represents the response from the server to the request to create the user +// import job. type CreateUserImportJobOutput struct { // The job object that represents the user import job. diff --git a/service/cognitoidentityprovider/api_op_CreateUserPool.go b/service/cognitoidentityprovider/api_op_CreateUserPool.go index bde114cb0df..04fe5e32548 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPool.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPool.go @@ -15,18 +15,16 @@ import ( // pool. This action might generate an SMS text message. Starting June 1, 2021, US // telecom carriers require you to register an origination phone number before you // can send SMS messages to US phone numbers. If you use SMS text messages in -// Amazon Cognito, you must register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) CreateUserPool(ctx context.Context, params *CreateUserPoolInput, optFns ...func(*Options)) (*CreateUserPoolOutput, error) { if params == nil { @@ -51,9 +49,9 @@ type CreateUserPoolInput struct { // This member is required. PoolName *string - // The available verified method a user can use to recover their password when they - // call ForgotPassword. You can use this setting to define a preferred method when - // a user has more than one method available. With this setting, SMS doesn't + // The available verified method a user can use to recover their password when + // they call ForgotPassword . You can use this setting to define a preferred method + // when a user has more than one method available. With this setting, SMS doesn't // qualify for a valid password recovery mechanism if the user also has SMS // multi-factor authentication (MFA) activated. In the absence of this setting, // Amazon Cognito uses the legacy behavior to determine the recovery method where @@ -89,22 +87,21 @@ type CreateUserPoolInput struct { // messages from your user pool. EmailConfiguration *types.EmailConfigurationType - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationMessage *string - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationSubject *string // The Lambda trigger configuration information for the new user pool. In a push // model, event sources (such as Amazon S3 and custom applications) need permission // to invoke a function. So you must make an extra call to add permission for these // event sources to invoke your Lambda function. For more information on using the - // Lambda API to add permission, see AddPermission - // (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html). For - // adding permission using the CLI, see add-permission - // (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html). + // Lambda API to add permission, see AddPermission (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html) + // . For adding permission using the CLI, see add-permission (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html) + // . LambdaConfig *types.LambdaConfigType // Specifies MFA configuration details. @@ -127,16 +124,16 @@ type CreateUserPoolInput struct { // and Access Management (IAM) role in your Amazon Web Services account. SmsConfiguration *types.SmsConfigurationType - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . SmsVerificationMessage *string - // The settings for updates to user attributes. These settings include the property - // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon - // Cognito how to handle changes to the value of your users' email address and - // phone number attributes. For more information, see Verifying updates to email - // addresses and phone numbers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // The settings for updates to user attributes. These settings include the + // property AttributesRequireVerificationBeforeUpdate , a user-pool setting that + // tells Amazon Cognito how to handle changes to the value of your users' email + // address and phone number attributes. For more information, see Verifying + // updates to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates) + // . UserAttributeUpdateSettings *types.UserAttributeUpdateSettingsType // Enables advanced security risk detection. Set the key AdvancedSecurityMode to @@ -153,10 +150,10 @@ type CreateUserPoolInput struct { UsernameAttributes []types.UsernameAttributeType // Case sensitivity on the username input for the selected sign-in option. For - // example, when case sensitivity is set to False, users can sign in using either + // example, when case sensitivity is set to False , users can sign in using either // "username" or "Username". This configuration is immutable once it has been set. - // For more information, see UsernameConfigurationType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html). + // For more information, see UsernameConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) + // . UsernameConfiguration *types.UsernameConfigurationType // The template for the verification message that the user sees when the app diff --git a/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go b/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go index c07440b9f36..bb69851a0ab 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go @@ -13,8 +13,8 @@ import ( // Creates the user pool client. When you create a new user pool client, token // revocation is automatically activated. For more information about revoking -// tokens, see RevokeToken -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). +// tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) +// . func (c *Client) CreateUserPoolClient(ctx context.Context, params *CreateUserPoolClientInput, optFns ...func(*Options)) (*CreateUserPoolClientOutput, error) { if params == nil { params = &CreateUserPoolClientInput{} @@ -43,14 +43,15 @@ type CreateUserPoolClientInput struct { // This member is required. UserPoolId *string - // The access token time limit. After this limit expires, your user can't use their - // access token. To specify the time unit for AccessTokenValidity as seconds, - // minutes, hours, or days, set a TokenValidityUnits value in your API request. For - // example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, - // your user can authorize access with their access token for 10 hours. The default - // time unit for AccessTokenValidity in an API request is hours. Valid range is - // displayed below in seconds. If you don't specify otherwise in the configuration - // of your app client, your access tokens are valid for one hour. + // The access token time limit. After this limit expires, your user can't use + // their access token. To specify the time unit for AccessTokenValidity as seconds + // , minutes , hours , or days , set a TokenValidityUnits value in your API + // request. For example, when you set AccessTokenValidity to 10 and + // TokenValidityUnits to hours , your user can authorize access with their access + // token for 10 hours. The default time unit for AccessTokenValidity in an API + // request is hours. Valid range is displayed below in seconds. If you don't + // specify otherwise in the configuration of your app client, your access tokens + // are valid for one hour. AccessTokenValidity *int32 // The allowed OAuth flows. code Use a code grant flow, which provides an @@ -65,73 +66,60 @@ type CreateUserPoolClientInput struct { // interacting with Amazon Cognito user pools. AllowedOAuthFlowsUserPoolClient bool - // The allowed OAuth scopes. Possible values provided by OAuth are phone, email, - // openid, and profile. Possible values provided by Amazon Web Services are - // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are + // The allowed OAuth scopes. Possible values provided by OAuth are phone , email , + // openid , and profile . Possible values provided by Amazon Web Services are + // aws.cognito.signin.user.admin . Custom scopes created in Resource Servers are // also supported. AllowedOAuthScopes []string - // The user pool analytics configuration for collecting metrics and sending them to - // your Amazon Pinpoint campaign. In Amazon Web Services Regions where Amazon + // The user pool analytics configuration for collecting metrics and sending them + // to your Amazon Pinpoint campaign. In Amazon Web Services Regions where Amazon // Pinpoint isn't available, user pools only support sending events to Amazon // Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where // Amazon Pinpoint is available, user pools support sending events to Amazon // Pinpoint projects within that same Region. AnalyticsConfiguration *types.AnalyticsConfigurationType - // Amazon Cognito creates a session token for each API request in an authentication - // flow. AuthSessionValidity is the duration, in minutes, of that session token. - // Your user pool native user must respond to each authentication challenge before - // the session expires. + // Amazon Cognito creates a session token for each API request in an + // authentication flow. AuthSessionValidity is the duration, in minutes, of that + // session token. Your user pool native user must respond to each authentication + // challenge before the session expires. AuthSessionValidity *int32 // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - // - // * - // Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * Not - // include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. CallbackURLs []string // The default redirect URI. Must be in the CallbackURLs list. A redirect URI // must: - // - // * Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * - // Not include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. DefaultRedirectURI *string // Activates the propagation of additional user context data. For more information - // about propagation of user context data, see Adding advanced security to a user - // pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). - // If you don’t include this parameter, you can't send device fingerprint + // about propagation of user context data, see Adding advanced security to a user + // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) + // . If you don’t include this parameter, you can't send device fingerprint // information, including source IP address, to Amazon Cognito advanced security. // You can only activate EnablePropagateAdditionalUserContextData in an app client // that has a client secret. EnablePropagateAdditionalUserContextData *bool // Activates or deactivates token revocation. For more information about revoking - // tokens, see RevokeToken - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). - // If you don't include this parameter, token revocation is automatically activated - // for the new user pool client. + // tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) + // . If you don't include this parameter, token revocation is automatically + // activated for the new user pool client. EnableTokenRevocation *bool // The authentication flows that you want your user pool client to support. For @@ -139,34 +127,23 @@ type CreateUserPoolClientInput struct { // combination of one or more flows, including with a user name and Secure Remote // Password (SRP), a user name and password, or a custom authentication process // that you define with Lambda functions. If you don't specify a value for - // ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, - // ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid values include: - // - // * - // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, your app passes a user name and password - // to Amazon Cognito in the request, instead of using the Secure Remote Password - // (SRP) protocol to securely transmit the password. - // - // * ALLOW_CUSTOM_AUTH: Enable - // Lambda trigger based authentication. - // - // * ALLOW_USER_PASSWORD_AUTH: Enable user - // password-based authentication. In this flow, Amazon Cognito receives the - // password in the request instead of using the SRP protocol to verify - // passwords. - // - // * ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. - // - // * - // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - // - // In some - // environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, - // or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to - // user pool clients at the same time as values that begin with ALLOW_, like - // ALLOW_USER_SRP_AUTH. + // ExplicitAuthFlows , your user client supports ALLOW_REFRESH_TOKEN_AUTH , + // ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH . Valid values include: + // - ALLOW_ADMIN_USER_PASSWORD_AUTH : Enable admin based user password + // authentication flow ADMIN_USER_PASSWORD_AUTH . This setting replaces the + // ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a + // user name and password to Amazon Cognito in the request, instead of using the + // Secure Remote Password (SRP) protocol to securely transmit the password. + // - ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication. + // - ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In + // this flow, Amazon Cognito receives the password in the request instead of using + // the SRP protocol to verify passwords. + // - ALLOW_USER_SRP_AUTH : Enable SRP-based authentication. + // - ALLOW_REFRESH_TOKEN_AUTH : Enable authflow to refresh tokens. + // In some environments, you will see the values ADMIN_NO_SRP_AUTH , + // CUSTOM_AUTH_FLOW_ONLY , or USER_PASSWORD_AUTH . You can't assign these legacy + // ExplicitAuthFlows values to user pool clients at the same time as values that + // begin with ALLOW_ , like ALLOW_USER_SRP_AUTH . ExplicitAuthFlows []types.ExplicitAuthFlowsType // Boolean to specify whether you want to generate a secret for the user pool @@ -174,11 +151,11 @@ type CreateUserPoolClientInput struct { GenerateSecret bool // The ID token time limit. After this limit expires, your user can't use their ID - // token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, - // or days, set a TokenValidityUnits value in your API request. For example, when - // you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can - // authenticate their session with their ID token for 10 hours. The default time - // unit for AccessTokenValidity in an API request is hours. Valid range is + // token. To specify the time unit for IdTokenValidity as seconds , minutes , hours + // , or days , set a TokenValidityUnits value in your API request. For example, + // when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user + // can authenticate their session with their ID token for 10 hours. The default + // time unit for AccessTokenValidity in an API request is hours. Valid range is // displayed below in seconds. If you don't specify otherwise in the configuration // of your app client, your ID tokens are valid for one hour. IdTokenValidity *int32 @@ -191,15 +168,12 @@ type CreateUserPoolClientInput struct { // doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, // authentication returns an error indicating either the username or password was // incorrect. Account confirmation and password recovery return a response - // indicating a code was sent to a simulated destination. When set to LEGACY, those - // APIs return a UserNotFoundException exception if the user doesn't exist in the - // user pool. Valid values include: - // - // * ENABLED - This prevents user - // existence-related errors. - // - // * LEGACY - This represents the early behavior of - // Amazon Cognito where user existence related errors aren't prevented. + // indicating a code was sent to a simulated destination. When set to LEGACY , + // those APIs return a UserNotFoundException exception if the user doesn't exist + // in the user pool. Valid values include: + // - ENABLED - This prevents user existence-related errors. + // - LEGACY - This represents the early behavior of Amazon Cognito where user + // existence related errors aren't prevented. PreventUserExistenceErrors types.PreventUserExistenceErrorTypes // The read attributes. @@ -207,21 +181,22 @@ type CreateUserPoolClientInput struct { // The refresh token time limit. After this limit expires, your user can't use // their refresh token. To specify the time unit for RefreshTokenValidity as - // seconds, minutes, hours, or days, set a TokenValidityUnits value in your API - // request. For example, when you set RefreshTokenValidity as 10 and - // TokenValidityUnits as days, your user can refresh their session and retrieve new - // access and ID tokens for 10 days. The default time unit for RefreshTokenValidity - // in an API request is days. You can't set RefreshTokenValidity to 0. If you do, - // Amazon Cognito overrides the value with the default value of 30 days. Valid - // range is displayed below in seconds. If you don't specify otherwise in the - // configuration of your app client, your refresh tokens are valid for 30 days. + // seconds , minutes , hours , or days , set a TokenValidityUnits value in your + // API request. For example, when you set RefreshTokenValidity as 10 and + // TokenValidityUnits as days , your user can refresh their session and retrieve + // new access and ID tokens for 10 days. The default time unit for + // RefreshTokenValidity in an API request is days. You can't set + // RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with + // the default value of 30 days. Valid range is displayed below in seconds. If you + // don't specify otherwise in the configuration of your app client, your refresh + // tokens are valid for 30 days. RefreshTokenValidity int32 - // A list of provider names for the identity providers (IdPs) that are supported on - // this client. The following are supported: COGNITO, Facebook, Google, - // SignInWithApple, and LoginWithAmazon. You can also specify the names that you + // A list of provider names for the identity providers (IdPs) that are supported + // on this client. The following are supported: COGNITO , Facebook , Google , + // SignInWithApple , and LoginWithAmazon . You can also specify the names that you // configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP - // or MyOIDCIdP. + // or MyOIDCIdP . SupportedIdentityProviders []string // The units in which the validity times are represented. The default unit for @@ -234,8 +209,8 @@ type CreateUserPoolClientInput struct { // when users sign in to your application through an IdP. If your app client does // not have write access to a mapped attribute, Amazon Cognito throws an error when // it tries to update the attribute. For more information, see Specifying IdP - // Attribute Mappings for Your user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). + // Attribute Mappings for Your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) + // . WriteAttributes []string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go b/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go index 36db02f829a..d1f913d2a4b 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go @@ -30,8 +30,8 @@ func (c *Client) CreateUserPoolDomain(ctx context.Context, params *CreateUserPoo type CreateUserPoolDomainInput struct { // The domain string. For custom domains, this is the fully-qualified domain name, - // such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix - // alone, such as auth. + // such as auth.example.com . For Amazon Cognito prefix domains, this is the prefix + // alone, such as auth . // // This member is required. Domain *string @@ -45,8 +45,8 @@ type CreateUserPoolDomainInput struct { // webpages for your application. Provide this parameter only if you want to use a // custom domain for your user pool. Otherwise, you can exclude this parameter and // use the Amazon Cognito hosted domain instead. For more information about the - // hosted domain and custom domains, see Configuring a User Pool Domain - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html). + // hosted domain and custom domains, see Configuring a User Pool Domain (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) + // . CustomDomainConfig *types.CustomDomainConfigType noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go b/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go index 847cc939314..083b431e4be 100644 --- a/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go @@ -28,15 +28,15 @@ func (c *Client) DeleteUserAttributes(ctx context.Context, params *DeleteUserAtt // Represents the request to delete user attributes. type DeleteUserAttributesInput struct { - // A valid access token that Amazon Cognito issued to the user whose attributes you - // want to delete. + // A valid access token that Amazon Cognito issued to the user whose attributes + // you want to delete. // // This member is required. AccessToken *string // An array of strings representing the user attribute names you want to delete. - // For custom attributes, you must prependattach the custom: prefix to the front of - // the attribute name. + // For custom attributes, you must prependattach the custom: prefix to the front + // of the attribute name. // // This member is required. UserAttributeNames []string diff --git a/service/cognitoidentityprovider/api_op_DeleteUserPoolDomain.go b/service/cognitoidentityprovider/api_op_DeleteUserPoolDomain.go index 3150741b4f5..b52267652df 100644 --- a/service/cognitoidentityprovider/api_op_DeleteUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_DeleteUserPoolDomain.go @@ -29,8 +29,8 @@ func (c *Client) DeleteUserPoolDomain(ctx context.Context, params *DeleteUserPoo type DeleteUserPoolDomainInput struct { // The domain string. For custom domains, this is the fully-qualified domain name, - // such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix - // alone, such as auth. + // such as auth.example.com . For Amazon Cognito prefix domains, this is the prefix + // alone, such as auth . // // This member is required. Domain *string diff --git a/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go b/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go index 2d96cfa4867..ad1c0920e6d 100644 --- a/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go @@ -44,8 +44,8 @@ type DescribeUserPoolClientInput struct { noSmithyDocumentSerde } -// Represents the response from the server from a request to describe the user pool -// client. +// Represents the response from the server from a request to describe the user +// pool client. type DescribeUserPoolClientOutput struct { // The user pool client from a server response to describe the user pool client. diff --git a/service/cognitoidentityprovider/api_op_DescribeUserPoolDomain.go b/service/cognitoidentityprovider/api_op_DescribeUserPoolDomain.go index 3b7ccf43821..a1ee111a14e 100644 --- a/service/cognitoidentityprovider/api_op_DescribeUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_DescribeUserPoolDomain.go @@ -30,8 +30,8 @@ func (c *Client) DescribeUserPoolDomain(ctx context.Context, params *DescribeUse type DescribeUserPoolDomainInput struct { // The domain string. For custom domains, this is the fully-qualified domain name, - // such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix - // alone, such as auth. + // such as auth.example.com . For Amazon Cognito prefix domains, this is the prefix + // alone, such as auth . // // This member is required. Domain *string diff --git a/service/cognitoidentityprovider/api_op_ForgotPassword.go b/service/cognitoidentityprovider/api_op_ForgotPassword.go index 715bbc8f79e..1d61078398a 100644 --- a/service/cognitoidentityprovider/api_op_ForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ForgotPassword.go @@ -10,31 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Calling this API causes a message to be sent to the end user with a confirmation -// code that is required to change the user's password. For the Username parameter, -// you can use the username or user alias. The method used to send the confirmation -// code is sent according to the specified AccountRecoverySetting. For more -// information, see Recovering User Accounts -// (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html) +// Calling this API causes a message to be sent to the end user with a +// confirmation code that is required to change the user's password. For the +// Username parameter, you can use the username or user alias. The method used to +// send the confirmation code is sent according to the specified +// AccountRecoverySetting. For more information, see Recovering User Accounts (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html) // in the Amazon Cognito Developer Guide. If neither a verified phone number nor a // verified email exists, an InvalidParameterException is thrown. To use the -// confirmation code for resetting the password, call ConfirmForgotPassword -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html). -// This action might generate an SMS text message. Starting June 1, 2021, US +// confirmation code for resetting the password, call ConfirmForgotPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html) +// . This action might generate an SMS text message. Starting June 1, 2021, US // telecom carriers require you to register an origination phone number before you // can send SMS messages to US phone numbers. If you use SMS text messages in -// Amazon Cognito, you must register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) ForgotPassword(ctx context.Context, params *ForgotPasswordInput, optFns ...func(*Options)) (*ForgotPasswordOutput, error) { if params == nil { @@ -59,8 +55,8 @@ type ForgotPasswordInput struct { // This member is required. ClientId *string - // The user name of the user for whom you want to enter a code to reset a forgotten - // password. + // The user name of the user for whom you want to enter a code to reset a + // forgotten password. // // This member is required. Username *string @@ -79,21 +75,16 @@ type ForgotPasswordInput struct { // provides the data that you assigned to the ClientMetadata parameter in your // ForgotPassword request. In your function code in Lambda, you can process the // clientMetadata value to enhance your workflow for your specific needs. For more - // information, see Customizing user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // information, see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key diff --git a/service/cognitoidentityprovider/api_op_GetSigningCertificate.go b/service/cognitoidentityprovider/api_op_GetSigningCertificate.go index 6b557c5e5ed..52b468ea265 100644 --- a/service/cognitoidentityprovider/api_op_GetSigningCertificate.go +++ b/service/cognitoidentityprovider/api_op_GetSigningCertificate.go @@ -13,7 +13,7 @@ import ( // This method takes a user pool ID, and returns the signing certificate. The // issued certificate is valid for 10 years from the date of issue. Amazon Cognito // issues and assigns a new signing certificate annually. This process returns a -// new value in the response to GetSigningCertificate, but doesn't invalidate the +// new value in the response to GetSigningCertificate , but doesn't invalidate the // original certificate. func (c *Client) GetSigningCertificate(ctx context.Context, params *GetSigningCertificateInput, optFns ...func(*Options)) (*GetSigningCertificateOutput, error) { if params == nil { diff --git a/service/cognitoidentityprovider/api_op_GetUICustomization.go b/service/cognitoidentityprovider/api_op_GetUICustomization.go index cd95b9cddb3..d2a9a34f438 100644 --- a/service/cognitoidentityprovider/api_op_GetUICustomization.go +++ b/service/cognitoidentityprovider/api_op_GetUICustomization.go @@ -14,7 +14,7 @@ import ( // Gets the user interface (UI) Customization information for a particular app // client's app UI, if any such information exists for the client. If nothing is // set for the particular client, but there is an existing pool level customization -// (the app clientId is ALL), then that information is returned. If nothing is +// (the app clientId is ALL ), then that information is returned. If nothing is // present, then an empty shape is returned. func (c *Client) GetUICustomization(ctx context.Context, params *GetUICustomizationInput, optFns ...func(*Options)) (*GetUICustomizationOutput, error) { if params == nil { diff --git a/service/cognitoidentityprovider/api_op_GetUser.go b/service/cognitoidentityprovider/api_op_GetUser.go index fac1438267f..f1ac7da84ba 100644 --- a/service/cognitoidentityprovider/api_op_GetUser.go +++ b/service/cognitoidentityprovider/api_op_GetUser.go @@ -63,7 +63,7 @@ type GetUserOutput struct { PreferredMfaSetting *string // The MFA options that are activated for the user. The possible values in this - // list are SMS_MFA and SOFTWARE_TOKEN_MFA. + // list are SMS_MFA and SOFTWARE_TOKEN_MFA . UserMFASettingList []string // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go b/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go index 1a8ab0af946..60d50ef8287 100644 --- a/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go +++ b/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go @@ -16,17 +16,16 @@ import ( // Starting June 1, 2021, US telecom carriers require you to register an // origination phone number before you can send SMS messages to US phone numbers. // If you use SMS text messages in Amazon Cognito, you must register a phone number -// with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon +// with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) . Amazon // Cognito uses the registered number automatically. Otherwise, Amazon Cognito // users who must receive SMS messages might not be able to sign up, activate their // accounts, or sign in. If you have never used SMS text messages with Amazon // Cognito or any other Amazon Web Service, Amazon Simple Notification Service -// might place your account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) GetUserAttributeVerificationCode(ctx context.Context, params *GetUserAttributeVerificationCodeInput, optFns ...func(*Options)) (*GetUserAttributeVerificationCodeOutput, error) { if params == nil { @@ -68,22 +67,17 @@ type GetUserAttributeVerificationCodeInput struct { // assigned to the ClientMetadata parameter in your // GetUserAttributeVerificationCode request. In your function code in Lambda, you // can process the clientMetadata value to enhance your workflow for your specific - // needs. For more information, see Customizing user pool Workflows with Lambda - // Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // needs. For more information, see Customizing user pool Workflows with Lambda + // Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go index 099777d5c7f..63402e6b3f7 100644 --- a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go @@ -40,15 +40,10 @@ type GetUserPoolMfaConfigInput struct { type GetUserPoolMfaConfigOutput struct { // The multi-factor authentication (MFA) configuration. Valid values include: - // - // * - // OFF MFA won't be used for any users. - // - // * ON MFA is required for all users to sign - // in. - // - // * OPTIONAL MFA will be required only for individual users who have an MFA - // factor activated. + // - OFF MFA won't be used for any users. + // - ON MFA is required for all users to sign in. + // - OPTIONAL MFA will be required only for individual users who have an MFA + // factor activated. MfaConfiguration types.UserPoolMfaType // The SMS text message multi-factor authentication (MFA) configuration. diff --git a/service/cognitoidentityprovider/api_op_GlobalSignOut.go b/service/cognitoidentityprovider/api_op_GlobalSignOut.go index ac219967c35..e70791f4c3c 100644 --- a/service/cognitoidentityprovider/api_op_GlobalSignOut.go +++ b/service/cognitoidentityprovider/api_op_GlobalSignOut.go @@ -31,8 +31,8 @@ func (c *Client) GlobalSignOut(ctx context.Context, params *GlobalSignOutInput, // Represents the request to sign out all devices. type GlobalSignOutInput struct { - // A valid access token that Amazon Cognito issued to the user who you want to sign - // out. + // A valid access token that Amazon Cognito issued to the user who you want to + // sign out. // // This member is required. AccessToken *string diff --git a/service/cognitoidentityprovider/api_op_InitiateAuth.go b/service/cognitoidentityprovider/api_op_InitiateAuth.go index de1bbbaf9ae..ca5d2be75e3 100644 --- a/service/cognitoidentityprovider/api_op_InitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_InitiateAuth.go @@ -11,24 +11,21 @@ import ( ) // Initiates sign-in for a user in the Amazon Cognito user directory. You can't -// sign in a user with a federated IdP with InitiateAuth. For more information, see -// Adding user pool sign-in through a third party -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html). -// This action might generate an SMS text message. Starting June 1, 2021, US +// sign in a user with a federated IdP with InitiateAuth . For more information, +// see Adding user pool sign-in through a third party (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) +// . This action might generate an SMS text message. Starting June 1, 2021, US // telecom carriers require you to register an origination phone number before you // can send SMS messages to US phone numbers. If you use SMS text messages in -// Amazon Cognito, you must register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) InitiateAuth(ctx context.Context, params *InitiateAuthInput, optFns ...func(*Options)) (*InitiateAuthOutput, error) { if params == nil { @@ -48,37 +45,24 @@ func (c *Client) InitiateAuth(ctx context.Context, params *InitiateAuthInput, op // Initiates the authentication request. type InitiateAuthInput struct { - // The authentication flow for this call to run. The API action will depend on this - // value. For example: - // - // * REFRESH_TOKEN_AUTH takes in a valid refresh token and - // returns new tokens. - // - // * USER_SRP_AUTH takes in USERNAME and SRP_A and returns the - // SRP variables to be used for next challenge execution. - // - // * USER_PASSWORD_AUTH - // takes in USERNAME and PASSWORD and returns the next challenge or tokens. - // - // Valid - // values include: - // - // * USER_SRP_AUTH: Authentication flow for the Secure Remote - // Password (SRP) protocol. - // - // * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication - // flow for refreshing the access token and ID token by supplying a valid refresh - // token. - // - // * CUSTOM_AUTH: Custom authentication flow. - // - // * USER_PASSWORD_AUTH: - // Non-SRP authentication flow; user name and password are passed directly. If a - // user migration Lambda trigger is set, this flow will invoke the user migration - // Lambda if it doesn't find the user name in the user pool. - // - // ADMIN_NO_SRP_AUTH - // isn't a valid value. + // The authentication flow for this call to run. The API action will depend on + // this value. For example: + // - REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens. + // - USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to + // be used for next challenge execution. + // - USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next + // challenge or tokens. + // Valid values include: + // - USER_SRP_AUTH : Authentication flow for the Secure Remote Password (SRP) + // protocol. + // - REFRESH_TOKEN_AUTH / REFRESH_TOKEN : Authentication flow for refreshing the + // access token and ID token by supplying a valid refresh token. + // - CUSTOM_AUTH : Custom authentication flow. + // - USER_PASSWORD_AUTH : Non-SRP authentication flow; user name and password are + // passed directly. If a user migration Lambda trigger is set, this flow will + // invoke the user migration Lambda if it doesn't find the user name in the user + // pool. + // ADMIN_NO_SRP_AUTH isn't a valid value. // // This member is required. AuthFlow types.AuthFlowType @@ -93,75 +77,50 @@ type InitiateAuthInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // The authentication parameters. These are inputs corresponding to the AuthFlow - // that you're invoking. The required values depend on the value of AuthFlow: - // - // * - // For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required - // if the app client is configured with a client secret), DEVICE_KEY. - // - // * For - // REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH - // (required if the app client is configured with a client secret), DEVICE_KEY. - // - // * - // For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured - // with client secret), DEVICE_KEY. To start the authentication flow with password - // verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value). + // that you're invoking. The required values depend on the value of AuthFlow : + // - For USER_SRP_AUTH : USERNAME (required), SRP_A (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY . + // - For REFRESH_TOKEN_AUTH/REFRESH_TOKEN : REFRESH_TOKEN (required), SECRET_HASH + // (required if the app client is configured with a client secret), DEVICE_KEY . + // - For CUSTOM_AUTH : USERNAME (required), SECRET_HASH (if app client is + // configured with client secret), DEVICE_KEY . To start the authentication flow + // with password verification, include ChallengeName: SRP_A and SRP_A: (The + // SRP_A Value) . AuthParameters map[string]string - // A map of custom key-value pairs that you can provide as input for certain custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the InitiateAuth API - // action, Amazon Cognito invokes the Lambda functions that are specified for + // A map of custom key-value pairs that you can provide as input for certain + // custom workflows that this action triggers. You create custom workflows by + // assigning Lambda functions to user pool triggers. When you use the InitiateAuth + // API action, Amazon Cognito invokes the Lambda functions that are specified for // various triggers. The ClientMetadata value is passed as input to the functions // for only the following triggers: - // - // * Pre signup - // - // * Pre authentication - // - // * User - // migration - // - // When Amazon Cognito invokes the functions for these triggers, it - // passes a JSON payload, which the function receives as input. This payload - // contains a validationData attribute, which provides the data that you assigned - // to the ClientMetadata parameter in your InitiateAuth request. In your function - // code in Lambda, you can process the validationData value to enhance your - // workflow for your specific needs. When you use the InitiateAuth API action, - // Amazon Cognito also invokes the functions for the following triggers, but it - // doesn't provide the ClientMetadata value as input: - // - // * Post authentication - // - // * - // Custom message - // - // * Pre token generation - // - // * Create auth challenge - // - // * Define auth - // challenge - // - // * Verify auth challenge - // - // For more information, see Customizing user - // pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // - Pre signup + // - Pre authentication + // - User migration + // When Amazon Cognito invokes the functions for these triggers, it passes a JSON + // payload, which the function receives as input. This payload contains a + // validationData attribute, which provides the data that you assigned to the + // ClientMetadata parameter in your InitiateAuth request. In your function code in + // Lambda, you can process the validationData value to enhance your workflow for + // your specific needs. When you use the InitiateAuth API action, Amazon Cognito + // also invokes the functions for the following triggers, but it doesn't provide + // the ClientMetadata value as input: + // - Post authentication + // - Custom message + // - Pre token generation + // - Create auth challenge + // - Define auth challenge + // - Verify auth challenge + // For more information, see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -178,63 +137,52 @@ type InitiateAuthOutput struct { // The result of the authentication response. This result is only returned if the // caller doesn't need to pass another challenge. If the caller does need to pass - // another challenge before it gets tokens, ChallengeName, ChallengeParameters, and - // Session are returned. + // another challenge before it gets tokens, ChallengeName , ChallengeParameters , + // and Session are returned. AuthenticationResult *types.AuthenticationResultType - // The name of the challenge that you're responding to with this call. This name is - // returned in the AdminInitiateAuth response if you must pass another challenge. - // Valid values include the following: All of the following challenges require - // USERNAME and SECRET_HASH (if applicable) in the parameters. - // - // * SMS_MFA: Next - // challenge is to supply an SMS_MFA_CODE, delivered via SMS. - // - // * PASSWORD_VERIFIER: - // Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, - // PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP - // calculations. - // - // * CUSTOM_CHALLENGE: This is returned if your custom - // authentication flow determines that the user should pass another challenge - // before tokens are issued. - // - // * DEVICE_SRP_AUTH: If device tracking was activated - // on your user pool and the previous challenges were passed, this challenge is - // returned so that Amazon Cognito can start tracking this device. - // - // * - // DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. - // - // * - // NEW_PASSWORD_REQUIRED: For users who are required to change their passwords - // after successful first login. Respond to this challenge with NEW_PASSWORD and - // any required attributes that Amazon Cognito returned in the requiredAttributes - // parameter. You can also set values for attributes that aren't required by your - // user pool and that your app client can write. For more information, see - // RespondToAuthChallenge - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html). - // In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required - // attribute that already has a value. In RespondToAuthChallenge, set a value for - // any keys that Amazon Cognito returned in the requiredAttributes parameter, then - // use the UpdateUserAttributes API operation to modify the value of any additional - // attributes. - // - // * MFA_SETUP: For users who are required to setup an MFA factor - // before they can sign in. The MFA types activated for the user pool will be - // listed in the challenge parameters MFA_CAN_SETUP value. To set up software token - // MFA, use the session returned here from InitiateAuth as an input to - // AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an - // input to RespondToAuthChallenge with challenge name MFA_SETUP to complete - // sign-in. To set up SMS MFA, an administrator should help the user to add a phone - // number to their account, and then the user should call InitiateAuth again to - // restart sign-in. + // The name of the challenge that you're responding to with this call. This name + // is returned in the AdminInitiateAuth response if you must pass another + // challenge. Valid values include the following: All of the following challenges + // require USERNAME and SECRET_HASH (if applicable) in the parameters. + // - SMS_MFA : Next challenge is to supply an SMS_MFA_CODE , delivered via SMS. + // - PASSWORD_VERIFIER : Next challenge is to supply PASSWORD_CLAIM_SIGNATURE , + // PASSWORD_CLAIM_SECRET_BLOCK , and TIMESTAMP after the client-side SRP + // calculations. + // - CUSTOM_CHALLENGE : This is returned if your custom authentication flow + // determines that the user should pass another challenge before tokens are issued. + // + // - DEVICE_SRP_AUTH : If device tracking was activated on your user pool and the + // previous challenges were passed, this challenge is returned so that Amazon + // Cognito can start tracking this device. + // - DEVICE_PASSWORD_VERIFIER : Similar to PASSWORD_VERIFIER , but for devices + // only. + // - NEW_PASSWORD_REQUIRED : For users who are required to change their passwords + // after successful first login. Respond to this challenge with NEW_PASSWORD and + // any required attributes that Amazon Cognito returned in the requiredAttributes + // parameter. You can also set values for attributes that aren't required by your + // user pool and that your app client can write. For more information, see + // RespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html) + // . In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required + // attribute that already has a value. In RespondToAuthChallenge , set a value + // for any keys that Amazon Cognito returned in the requiredAttributes parameter, + // then use the UpdateUserAttributes API operation to modify the value of any + // additional attributes. + // - MFA_SETUP : For users who are required to setup an MFA factor before they + // can sign in. The MFA types activated for the user pool will be listed in the + // challenge parameters MFA_CAN_SETUP value. To set up software token MFA, use + // the session returned here from InitiateAuth as an input to + // AssociateSoftwareToken . Use the session returned by VerifySoftwareToken as an + // input to RespondToAuthChallenge with challenge name MFA_SETUP to complete + // sign-in. To set up SMS MFA, an administrator should help the user to add a phone + // number to their account, and then the user should call InitiateAuth again to + // restart sign-in. ChallengeName types.ChallengeNameType - // The challenge parameters. These are returned in the InitiateAuth response if you - // must pass another challenge. The responses in this parameter should be used to - // compute inputs to the next call (RespondToAuthChallenge). All challenges require - // USERNAME and SECRET_HASH (if applicable). + // The challenge parameters. These are returned in the InitiateAuth response if + // you must pass another challenge. The responses in this parameter should be used + // to compute inputs to the next call ( RespondToAuthChallenge ). All challenges + // require USERNAME and SECRET_HASH (if applicable). ChallengeParameters map[string]string // The session that should pass both ways in challenge-response calls to the diff --git a/service/cognitoidentityprovider/api_op_ListResourceServers.go b/service/cognitoidentityprovider/api_op_ListResourceServers.go index 8cfeaef51d0..f44de2cc76c 100644 --- a/service/cognitoidentityprovider/api_op_ListResourceServers.go +++ b/service/cognitoidentityprovider/api_op_ListResourceServers.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListResourceServersMiddlewares(stack *middleware.St return nil } -// ListResourceServersAPIClient is a client that implements the ListResourceServers -// operation. +// ListResourceServersAPIClient is a client that implements the +// ListResourceServers operation. type ListResourceServersAPIClient interface { ListResourceServers(context.Context, *ListResourceServersInput, ...func(*Options)) (*ListResourceServersOutput, error) } diff --git a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go index 162dbce29d9..df83b4526a8 100644 --- a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go +++ b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go @@ -40,7 +40,7 @@ type ListUserImportJobsInput struct { // This member is required. UserPoolId *string - // An identifier that was returned from the previous call to ListUserImportJobs, + // An identifier that was returned from the previous call to ListUserImportJobs , // which can be used to return the next set of import jobs in the list. PaginationToken *string @@ -51,8 +51,8 @@ type ListUserImportJobsInput struct { // jobs. type ListUserImportJobsOutput struct { - // An identifier that can be used to return the next set of user import jobs in the - // list. + // An identifier that can be used to return the next set of user import jobs in + // the list. PaginationToken *string // The user import jobs. diff --git a/service/cognitoidentityprovider/api_op_ListUserPoolClients.go b/service/cognitoidentityprovider/api_op_ListUserPoolClients.go index 0e9c9ceabfd..c0e6ba9c266 100644 --- a/service/cognitoidentityprovider/api_op_ListUserPoolClients.go +++ b/service/cognitoidentityprovider/api_op_ListUserPoolClients.go @@ -126,8 +126,8 @@ func (c *Client) addOperationListUserPoolClientsMiddlewares(stack *middleware.St return nil } -// ListUserPoolClientsAPIClient is a client that implements the ListUserPoolClients -// operation. +// ListUserPoolClientsAPIClient is a client that implements the +// ListUserPoolClients operation. type ListUserPoolClientsAPIClient interface { ListUserPoolClients(context.Context, *ListUserPoolClientsInput, ...func(*Options)) (*ListUserPoolClientsOutput, error) } diff --git a/service/cognitoidentityprovider/api_op_ListUsers.go b/service/cognitoidentityprovider/api_op_ListUsers.go index 284045d84e9..0be495bfc66 100644 --- a/service/cognitoidentityprovider/api_op_ListUsers.go +++ b/service/cognitoidentityprovider/api_op_ListUsers.go @@ -43,62 +43,37 @@ type ListUsersInput struct { // A filter string of the form "AttributeName Filter-Type "AttributeValue"". // Quotation marks within the filter string must be escaped using the backslash (\) - // character. For example, "family_name = \"Reddy\"". - // - // * AttributeName: The name of - // the attribute to search for. You can only search for one attribute at a time. - // - // * - // Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For - // a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"". - // - // * - // AttributeValue: The attribute value that must be matched for each user. - // - // If the - // filter string is empty, ListUsers returns all users in the user pool. You can - // only search for the following standard attributes: - // - // * username - // (case-sensitive) - // - // * email - // - // * phone_number - // - // * name - // - // * given_name - // - // * - // family_name - // - // * preferred_username - // - // * cognito:user_status (called Status in the - // Console) (case-insensitive) - // - // * status (called Enabled in the Console) - // (case-sensitive) - // - // * sub - // - // Custom attributes aren't searchable. You can also list - // users with a client-side filter. The server-side filter matches no more than one - // attribute. For an advanced search, use a client-side filter with the --query - // parameter of the list-users action in the CLI. When you use a client-side - // filter, ListUsers returns a paginated list of zero or more users. You can - // receive multiple pages in a row with zero results. Repeat the query with each - // pagination token that is returned until you receive a null pagination token - // value, and then review the combined result. For more information about - // server-side and client-side filtering, see FilteringCLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) in the - // Command Line Interface User Guide - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). For - // more information, see Searching for Users Using the ListUsers API - // (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api) - // and Examples of Using the ListUsers API - // (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples) + // character. For example, " family_name = \"Reddy\"". + // - AttributeName: The name of the attribute to search for. You can only search + // for one attribute at a time. + // - Filter-Type: For an exact match, use =, for example, " given_name = + // \"Jon\"". For a prefix ("starts with") match, use ^=, for example, " given_name + // ^= \"Jon\"". + // - AttributeValue: The attribute value that must be matched for each user. + // If the filter string is empty, ListUsers returns all users in the user pool. + // You can only search for the following standard attributes: + // - username (case-sensitive) + // - email + // - phone_number + // - name + // - given_name + // - family_name + // - preferred_username + // - cognito:user_status (called Status in the Console) (case-insensitive) + // - status (called Enabled in the Console) (case-sensitive) + // - sub + // Custom attributes aren't searchable. You can also list users with a client-side + // filter. The server-side filter matches no more than one attribute. For an + // advanced search, use a client-side filter with the --query parameter of the + // list-users action in the CLI. When you use a client-side filter, ListUsers + // returns a paginated list of zero or more users. You can receive multiple pages + // in a row with zero results. Repeat the query with each pagination token that is + // returned until you receive a null pagination token value, and then review the + // combined result. For more information about server-side and client-side + // filtering, see FilteringCLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // in the Command Line Interface User Guide (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . For more information, see Searching for Users Using the ListUsers API (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api) + // and Examples of Using the ListUsers API (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples) // in the Amazon Cognito Developer Guide. Filter *string diff --git a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go index 0e0c78bd505..69ffeff2e25 100644 --- a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go +++ b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go @@ -15,17 +15,16 @@ import ( // 1, 2021, US telecom carriers require you to register an origination phone number // before you can send SMS messages to US phone numbers. If you use SMS text // messages in Amazon Cognito, you must register a phone number with Amazon -// Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses +// Pinpoint (https://console.aws.amazon.com/pinpoint/home/) . Amazon Cognito uses // the registered number automatically. Otherwise, Amazon Cognito users who must // receive SMS messages might not be able to sign up, activate their accounts, or // sign in. If you have never used SMS text messages with Amazon Cognito or any // other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) ResendConfirmationCode(ctx context.Context, params *ResendConfirmationCodeInput, optFns ...func(*Options)) (*ResendConfirmationCodeOutput, error) { if params == nil { @@ -69,22 +68,17 @@ type ResendConfirmationCodeInput struct { // clientMetadata attribute, which provides the data that you assigned to the // ClientMetadata parameter in your ResendConfirmationCode request. In your // function code in Lambda, you can process the clientMetadata value to enhance - // your workflow for your specific needs. For more information, see Customizing - // user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // your workflow for your specific needs. For more information, see Customizing + // user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key diff --git a/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go b/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go index 9f65b4b34bd..fbfa23f5c07 100644 --- a/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go @@ -10,21 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Responds to the authentication challenge. This action might generate an SMS text -// message. Starting June 1, 2021, US telecom carriers require you to register an -// origination phone number before you can send SMS messages to US phone numbers. -// If you use SMS text messages in Amazon Cognito, you must register a phone number -// with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon -// Cognito uses the registered number automatically. Otherwise, Amazon Cognito -// users who must receive SMS messages might not be able to sign up, activate their -// accounts, or sign in. If you have never used SMS text messages with Amazon -// Cognito or any other Amazon Web Service, Amazon Simple Notification Service -// might place your account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Responds to the authentication challenge. This action might generate an SMS +// text message. Starting June 1, 2021, US telecom carriers require you to register +// an origination phone number before you can send SMS messages to US phone +// numbers. If you use SMS text messages in Amazon Cognito, you must register a +// phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) RespondToAuthChallenge(ctx context.Context, params *RespondToAuthChallengeInput, optFns ...func(*Options)) (*RespondToAuthChallengeOutput, error) { if params == nil { @@ -44,9 +43,8 @@ func (c *Client) RespondToAuthChallenge(ctx context.Context, params *RespondToAu // The request to respond to an authentication challenge. type RespondToAuthChallengeInput struct { - // The challenge name. For more information, see InitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html). - // ADMIN_NO_SRP_AUTH isn't a valid value. + // The challenge name. For more information, see InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) + // . ADMIN_NO_SRP_AUTH isn't a valid value. // // This member is required. ChallengeName types.ChallengeNameType @@ -61,40 +59,30 @@ type RespondToAuthChallengeInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // The challenge responses. These are inputs corresponding to the value of - // ChallengeName, for example: SECRET_HASH (if app client is configured with client - // secret) applies to all of the inputs that follow (including - // SOFTWARE_TOKEN_MFA). - // - // * SMS_MFA: SMS_MFA_CODE, USERNAME. - // - // * PASSWORD_VERIFIER: - // PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME. - // PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered - // device. - // - // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app - // client is configured with client secret). To set any required attributes that - // Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add - // a userAttributes.attributename parameter. This parameter can also set values - // for writable attributes that aren't required by your user pool. In a - // NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute - // that already has a value. In RespondToAuthChallenge, set a value for any keys - // that Amazon Cognito returned in the requiredAttributes parameter, then use the - // UpdateUserAttributes API operation to modify the value of any additional - // attributes. - // - // * SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are - // required attributes. - // - // * DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A - // (and SECRET_HASH). - // - // * DEVICE_PASSWORD_VERIFIER requires everything that - // PASSWORD_VERIFIER requires, plus DEVICE_KEY. - // - // * MFA_SETUP requires USERNAME, - // plus you must use the session value returned by VerifySoftwareToken in the - // Session parameter. + // ChallengeName , for example: SECRET_HASH (if app client is configured with + // client secret) applies to all of the inputs that follow (including + // SOFTWARE_TOKEN_MFA ). + // - SMS_MFA : SMS_MFA_CODE , USERNAME . + // - PASSWORD_VERIFIER : PASSWORD_CLAIM_SIGNATURE , PASSWORD_CLAIM_SECRET_BLOCK , + // TIMESTAMP , USERNAME . PASSWORD_VERIFIER requires DEVICE_KEY when you sign in + // with a remembered device. + // - NEW_PASSWORD_REQUIRED : NEW_PASSWORD , USERNAME , SECRET_HASH (if app client + // is configured with client secret). To set any required attributes that Amazon + // Cognito returned as requiredAttributes in the InitiateAuth response, add a + // userAttributes.attributename parameter. This parameter can also set values + // for writable attributes that aren't required by your user pool. In a + // NEW_PASSWORD_REQUIRED challenge response, you can't modify a required + // attribute that already has a value. In RespondToAuthChallenge , set a value + // for any keys that Amazon Cognito returned in the requiredAttributes parameter, + // then use the UpdateUserAttributes API operation to modify the value of any + // additional attributes. + // - SOFTWARE_TOKEN_MFA : USERNAME and SOFTWARE_TOKEN_MFA_CODE are required + // attributes. + // - DEVICE_SRP_AUTH requires USERNAME , DEVICE_KEY , SRP_A (and SECRET_HASH ). + // - DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER + // requires, plus DEVICE_KEY . + // - MFA_SETUP requires USERNAME , plus you must use the session value returned + // by VerifySoftwareToken in the Session parameter. ChallengeResponses map[string]string // A map of custom key-value pairs that you can provide as input for any custom @@ -108,21 +96,16 @@ type RespondToAuthChallengeInput struct { // provides the data that you assigned to the ClientMetadata parameter in your // RespondToAuthChallenge request. In your function code in Lambda, you can process // the clientMetadata value to enhance your workflow for your specific needs. For - // more information, see Customizing user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // more information, see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // The session that should be passed both ways in challenge-response calls to the @@ -148,12 +131,12 @@ type RespondToAuthChallengeOutput struct { // authentication challenge. AuthenticationResult *types.AuthenticationResultType - // The challenge name. For more information, see InitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html). + // The challenge name. For more information, see InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) + // . ChallengeName types.ChallengeNameType - // The challenge parameters. For more information, see InitiateAuth - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html). + // The challenge parameters. For more information, see InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) + // . ChallengeParameters map[string]string // The session that should be passed both ways in challenge-response calls to the diff --git a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go index 422dd3248d3..45acd0b6360 100644 --- a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go +++ b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go @@ -12,9 +12,9 @@ import ( ) // Configures actions on detected risks. To delete the risk configuration for -// UserPoolId or ClientId, pass null values for all four configuration types. To +// UserPoolId or ClientId , pass null values for all four configuration types. To // activate Amazon Cognito advanced security features, update the user pool to -// include the UserPoolAddOns keyAdvancedSecurityMode. +// include the UserPoolAddOns key AdvancedSecurityMode . func (c *Client) SetRiskConfiguration(ctx context.Context, params *SetRiskConfigurationInput, optFns ...func(*Options)) (*SetRiskConfigurationOutput, error) { if params == nil { params = &SetRiskConfigurationInput{} @@ -40,11 +40,11 @@ type SetRiskConfigurationInput struct { // The account takeover risk configuration. AccountTakeoverRiskConfiguration *types.AccountTakeoverRiskConfigurationType - // The app client ID. If ClientId is null, then the risk configuration is mapped to - // userPoolId. When the client ID is null, the same risk configuration is applied - // to all the clients in the userPool. Otherwise, ClientId is mapped to the client. - // When the client ID isn't null, the user pool configuration is overridden and the - // risk configuration for the client is used instead. + // The app client ID. If ClientId is null, then the risk configuration is mapped + // to userPoolId . When the client ID is null, the same risk configuration is + // applied to all the clients in the userPool. Otherwise, ClientId is mapped to + // the client. When the client ID isn't null, the user pool configuration is + // overridden and the risk configuration for the client is used instead. ClientId *string // The compromised credentials risk configuration. diff --git a/service/cognitoidentityprovider/api_op_SetUICustomization.go b/service/cognitoidentityprovider/api_op_SetUICustomization.go index 129be4c3846..9048b2c5419 100644 --- a/service/cognitoidentityprovider/api_op_SetUICustomization.go +++ b/service/cognitoidentityprovider/api_op_SetUICustomization.go @@ -13,11 +13,11 @@ import ( // Sets the user interface (UI) customization information for a user pool's // built-in app UI. You can specify app UI customization settings for a single -// client (with a specific clientId) or for all clients (by setting the clientId to -// ALL). If you specify ALL, the default configuration is used for every client -// that has no previously set UI customization. If you specify UI customization -// settings for a particular client, it will no longer return to the ALL -// configuration. To use this API, your user pool must have a domain associated +// client (with a specific clientId ) or for all clients (by setting the clientId +// to ALL ). If you specify ALL , the default configuration is used for every +// client that has no previously set UI customization. If you specify UI +// customization settings for a particular client, it will no longer return to the +// ALL configuration. To use this API, your user pool must have a domain associated // with it. Otherwise, there is no place to host the app's pages, and the service // will throw an error. func (c *Client) SetUICustomization(ctx context.Context, params *SetUICustomizationInput, optFns ...func(*Options)) (*SetUICustomizationOutput, error) { diff --git a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go index 50e60958782..f2bbec8bec8 100644 --- a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go +++ b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go @@ -38,8 +38,8 @@ func (c *Client) SetUserMFAPreference(ctx context.Context, params *SetUserMFAPre type SetUserMFAPreferenceInput struct { - // A valid access token that Amazon Cognito issued to the user whose MFA preference - // you want to set. + // A valid access token that Amazon Cognito issued to the user whose MFA + // preference you want to set. // // This member is required. AccessToken *string diff --git a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go index e5b57d0c6bf..8a63174e670 100644 --- a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go @@ -15,18 +15,16 @@ import ( // might generate an SMS text message. Starting June 1, 2021, US telecom carriers // require you to register an origination phone number before you can send SMS // messages to US phone numbers. If you use SMS text messages in Amazon Cognito, -// you must register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) SetUserPoolMfaConfig(ctx context.Context, params *SetUserPoolMfaConfigInput, optFns ...func(*Options)) (*SetUserPoolMfaConfigOutput, error) { if params == nil { @@ -50,19 +48,14 @@ type SetUserPoolMfaConfigInput struct { // This member is required. UserPoolId *string - // The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users - // who have set up an MFA factor can sign in. To learn more, see Adding - // Multi-Factor Authentication (MFA) to a user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html). - // Valid values include: - // - // * OFF MFA won't be used for any users. - // - // * ON MFA is - // required for all users to sign in. - // - // * OPTIONAL MFA will be required only for - // individual users who have an MFA factor activated. + // The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only + // users who have set up an MFA factor can sign in. To learn more, see Adding + // Multi-Factor Authentication (MFA) to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) + // . Valid values include: + // - OFF MFA won't be used for any users. + // - ON MFA is required for all users to sign in. + // - OPTIONAL MFA will be required only for individual users who have an MFA + // factor activated. MfaConfiguration types.UserPoolMfaType // The SMS text message MFA configuration. @@ -77,14 +70,10 @@ type SetUserPoolMfaConfigInput struct { type SetUserPoolMfaConfigOutput struct { // The MFA configuration. Valid values include: - // - // * OFF MFA won't be used for any - // users. - // - // * ON MFA is required for all users to sign in. - // - // * OPTIONAL MFA will be - // required only for individual users who have an MFA factor enabled. + // - OFF MFA won't be used for any users. + // - ON MFA is required for all users to sign in. + // - OPTIONAL MFA will be required only for individual users who have an MFA + // factor enabled. MfaConfiguration types.UserPoolMfaType // The SMS text message MFA configuration. diff --git a/service/cognitoidentityprovider/api_op_SetUserSettings.go b/service/cognitoidentityprovider/api_op_SetUserSettings.go index c2d3c3cf11d..55f0d227f98 100644 --- a/service/cognitoidentityprovider/api_op_SetUserSettings.go +++ b/service/cognitoidentityprovider/api_op_SetUserSettings.go @@ -12,8 +12,7 @@ import ( // This action is no longer supported. You can use it to configure only SMS MFA. // You can't use it to configure time-based one-time password (TOTP) software token -// MFA. To configure either type of MFA, use SetUserMFAPreference -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html) +// MFA. To configure either type of MFA, use SetUserMFAPreference (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html) // instead. func (c *Client) SetUserSettings(ctx context.Context, params *SetUserSettingsInput, optFns ...func(*Options)) (*SetUserSettingsOutput, error) { if params == nil { diff --git a/service/cognitoidentityprovider/api_op_SignUp.go b/service/cognitoidentityprovider/api_op_SignUp.go index be92fd953da..a58fda9fdff 100644 --- a/service/cognitoidentityprovider/api_op_SignUp.go +++ b/service/cognitoidentityprovider/api_op_SignUp.go @@ -10,22 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers the user in the specified user pool and creates a user name, password, -// and user attributes. This action might generate an SMS text message. Starting -// June 1, 2021, US telecom carriers require you to register an origination phone -// number before you can send SMS messages to US phone numbers. If you use SMS text -// messages in Amazon Cognito, you must register a phone number with Amazon -// Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses -// the registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Registers the user in the specified user pool and creates a user name, +// password, and user attributes. This action might generate an SMS text message. +// Starting June 1, 2021, US telecom carriers require you to register an +// origination phone number before you can send SMS messages to US phone numbers. +// If you use SMS text messages in Amazon Cognito, you must register a phone number +// with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) . Amazon +// Cognito uses the registered number automatically. Otherwise, Amazon Cognito +// users who must receive SMS messages might not be able to sign up, activate their +// accounts, or sign in. If you have never used SMS text messages with Amazon +// Cognito or any other Amazon Web Service, Amazon Simple Notification Service +// might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) SignUp(ctx context.Context, params *SignUpInput, optFns ...func(*Options)) (*SignUpOutput, error) { if params == nil { @@ -74,21 +73,16 @@ type SignUpInput struct { // which provides the data that you assigned to the ClientMetadata parameter in // your SignUp request. In your function code in Lambda, you can process the // clientMetadata value to enhance your workflow for your specific needs. For more - // information, see Customizing user pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // information, see Customizing user pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key @@ -120,7 +114,7 @@ type SignUpOutput struct { // This member is required. UserConfirmed bool - // The UUID of the authenticated user. This isn't the same as username. + // The UUID of the authenticated user. This isn't the same as username . // // This member is required. UserSub *string diff --git a/service/cognitoidentityprovider/api_op_TagResource.go b/service/cognitoidentityprovider/api_op_TagResource.go index 75f8fed0f1b..e24e5beecea 100644 --- a/service/cognitoidentityprovider/api_op_TagResource.go +++ b/service/cognitoidentityprovider/api_op_TagResource.go @@ -15,14 +15,15 @@ import ( // purpose, owner, environment, or other criteria. Each tag consists of a key and // value, both of which you define. A key is a general category for more specific // values. For example, if you have two versions of a user pool, one for testing -// and another for production, you might assign an Environment tag key to both user -// pools. The value of this key might be Test for one user pool, and Production for -// the other. Tags are useful for cost tracking and access control. You can -// activate your tags so that they appear on the Billing and Cost Management -// console, where you can track the costs associated with your user pools. In an -// Identity and Access Management policy, you can constrain permissions for user -// pools based on specific tags or tag values. You can use this action up to 5 -// times per second, per account. A user pool can have as many as 50 tags. +// and another for production, you might assign an Environment tag key to both +// user pools. The value of this key might be Test for one user pool, and +// Production for the other. Tags are useful for cost tracking and access control. +// You can activate your tags so that they appear on the Billing and Cost +// Management console, where you can track the costs associated with your user +// pools. In an Identity and Access Management policy, you can constrain +// permissions for user pools based on specific tags or tag values. You can use +// this action up to 5 times per second, per account. A user pool can have as many +// as 50 tags. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/cognitoidentityprovider/api_op_UpdateGroup.go b/service/cognitoidentityprovider/api_op_UpdateGroup.go index 009b32cd6fe..7fcd36b3558 100644 --- a/service/cognitoidentityprovider/api_op_UpdateGroup.go +++ b/service/cognitoidentityprovider/api_op_UpdateGroup.go @@ -44,8 +44,8 @@ type UpdateGroupInput struct { Description *string // The new precedence value for the group. For more information about this - // parameter, see CreateGroup - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html). + // parameter, see CreateGroup (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html) + // . Precedence *int32 // The new role Amazon Resource Name (ARN) for the group. This is used for setting diff --git a/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go b/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go index 496a362bad1..ea872b8df8b 100644 --- a/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go @@ -45,7 +45,7 @@ type UpdateIdentityProviderInput struct { // A list of IdP identifiers. IdpIdentifiers []string - // The IdP details to be updated, such as MetadataURL and MetadataFile. + // The IdP details to be updated, such as MetadataURL and MetadataFile . ProviderDetails map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go index 1b4d8ec1f25..0aa48193a43 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go @@ -14,18 +14,16 @@ import ( // generate an SMS text message. Starting June 1, 2021, US telecom carriers require // you to register an origination phone number before you can send SMS messages to // US phone numbers. If you use SMS text messages in Amazon Cognito, you must -// register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) UpdateUserAttributes(ctx context.Context, params *UpdateUserAttributesInput, optFns ...func(*Options)) (*UpdateUserAttributesOutput, error) { if params == nil { @@ -72,22 +70,17 @@ type UpdateUserAttributesInput struct { // clientMetadata attribute, which provides the data that you assigned to the // ClientMetadata parameter in your UpdateUserAttributes request. In your function // code in Lambda, you can process the clientMetadata value to enhance your - // workflow for your specific needs. For more information, see Customizing user - // pool Workflows with Lambda Triggers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) + // workflow for your specific needs. For more information, see Customizing user + // pool Workflows with Lambda Triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) // in the Amazon Cognito Developer Guide. When you use the ClientMetadata // parameter, remember that Amazon Cognito won't do the following: - // - // * Store the - // ClientMetadata value. This data is available only to Lambda triggers that are - // assigned to a user pool to support custom workflows. If your user pool - // configuration doesn't include triggers, the ClientMetadata parameter serves no - // purpose. - // - // * Validate the ClientMetadata value. - // - // * Encrypt the ClientMetadata - // value. Don't use Amazon Cognito to provide sensitive information. + // - Store the ClientMetadata value. This data is available only to Lambda + // triggers that are assigned to a user pool to support custom workflows. If your + // user pool configuration doesn't include triggers, the ClientMetadata parameter + // serves no purpose. + // - Validate the ClientMetadata value. + // - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide + // sensitive information. ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPool.go b/service/cognitoidentityprovider/api_op_UpdateUserPool.go index e391dedb3d6..d69e90814a3 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPool.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPool.go @@ -12,24 +12,21 @@ import ( ) // Updates the specified user pool with the specified attributes. You can get a -// list of the current user pool settings using DescribeUserPool -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html). -// If you don't provide a value for an attribute, it will be set to the default +// list of the current user pool settings using DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) +// . If you don't provide a value for an attribute, it will be set to the default // value. This action might generate an SMS text message. Starting June 1, 2021, US // telecom carriers require you to register an origination phone number before you // can send SMS messages to US phone numbers. If you use SMS text messages in -// Amazon Cognito, you must register a phone number with Amazon Pinpoint -// (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the -// registered number automatically. Otherwise, Amazon Cognito users who must -// receive SMS messages might not be able to sign up, activate their accounts, or -// sign in. If you have never used SMS text messages with Amazon Cognito or any -// other Amazon Web Service, Amazon Simple Notification Service might place your -// account in the SMS sandbox. In sandbox mode -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send -// messages only to verified phone numbers. After you test your app while in the -// sandbox environment, you can move out of the sandbox and into production. For -// more information, see SMS message settings for Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) +// Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/) +// . Amazon Cognito uses the registered number automatically. Otherwise, Amazon +// Cognito users who must receive SMS messages might not be able to sign up, +// activate their accounts, or sign in. If you have never used SMS text messages +// with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification +// Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// , you can send messages only to verified phone numbers. After you test your app +// while in the sandbox environment, you can move out of the sandbox and into +// production. For more information, see SMS message settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html) // in the Amazon Cognito Developer Guide. func (c *Client) UpdateUserPool(ctx context.Context, params *UpdateUserPoolInput, optFns ...func(*Options)) (*UpdateUserPoolOutput, error) { if params == nil { @@ -54,9 +51,9 @@ type UpdateUserPoolInput struct { // This member is required. UserPoolId *string - // The available verified method a user can use to recover their password when they - // call ForgotPassword. You can use this setting to define a preferred method when - // a user has more than one method available. With this setting, SMS doesn't + // The available verified method a user can use to recover their password when + // they call ForgotPassword . You can use this setting to define a preferred method + // when a user has more than one method available. With this setting, SMS doesn't // qualify for a valid password recovery mechanism if the user also has SMS // multi-factor authentication (MFA) activated. In the absence of this setting, // Amazon Cognito uses the legacy behavior to determine the recovery method where @@ -89,30 +86,25 @@ type UpdateUserPoolInput struct { // invitation and verification messages from your user pool. EmailConfiguration *types.EmailConfigurationType - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationMessage *string - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationSubject *string // The Lambda configuration information from the request to update the user pool. LambdaConfig *types.LambdaConfigType // Possible values include: - // - // * OFF - MFA tokens aren't required and can't be - // specified during user registration. - // - // * ON - MFA tokens are required for all user - // registrations. You can only specify ON when you're initially creating a user - // pool. You can use the SetUserPoolMfaConfig - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html) - // API operation to turn MFA "ON" for existing user pools. - // - // * OPTIONAL - Users have - // the option when registering to create an MFA token. + // - OFF - MFA tokens aren't required and can't be specified during user + // registration. + // - ON - MFA tokens are required for all user registrations. You can only + // specify ON when you're initially creating a user pool. You can use the + // SetUserPoolMfaConfig (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html) + // API operation to turn MFA "ON" for existing user pools. + // - OPTIONAL - Users have the option when registering to create an MFA token. MfaConfiguration types.UserPoolMfaType // A container with the policies you want to update in a user pool. @@ -128,16 +120,16 @@ type UpdateUserPoolInput struct { // and Access Management (IAM) role in your Amazon Web Services account. SmsConfiguration *types.SmsConfigurationType - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . SmsVerificationMessage *string - // The settings for updates to user attributes. These settings include the property - // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon - // Cognito how to handle changes to the value of your users' email address and - // phone number attributes. For more information, see Verifying updates to email - // addresses and phone numbers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // The settings for updates to user attributes. These settings include the + // property AttributesRequireVerificationBeforeUpdate , a user-pool setting that + // tells Amazon Cognito how to handle changes to the value of your users' email + // address and phone number attributes. For more information, see Verifying + // updates to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates) + // . UserAttributeUpdateSettings *types.UserAttributeUpdateSettingsType // Enables advanced security risk detection. Set the key AdvancedSecurityMode to diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go index cf32094e998..96afa254ebc 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go @@ -13,12 +13,11 @@ import ( // Updates the specified user pool app client with the specified attributes. You // can get a list of the current user pool app client settings using -// DescribeUserPoolClient -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html). -// If you don't provide a value for an attribute, it will be set to the default +// DescribeUserPoolClient (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html) +// . If you don't provide a value for an attribute, it will be set to the default // value. You can also use this operation to enable token revocation for user pool -// clients. For more information about revoking tokens, see RevokeToken -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). +// clients. For more information about revoking tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) +// . func (c *Client) UpdateUserPoolClient(ctx context.Context, params *UpdateUserPoolClientInput, optFns ...func(*Options)) (*UpdateUserPoolClientOutput, error) { if params == nil { params = &UpdateUserPoolClientInput{} @@ -48,14 +47,15 @@ type UpdateUserPoolClientInput struct { // This member is required. UserPoolId *string - // The access token time limit. After this limit expires, your user can't use their - // access token. To specify the time unit for AccessTokenValidity as seconds, - // minutes, hours, or days, set a TokenValidityUnits value in your API request. For - // example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, - // your user can authorize access with their access token for 10 hours. The default - // time unit for AccessTokenValidity in an API request is hours. Valid range is - // displayed below in seconds. If you don't specify otherwise in the configuration - // of your app client, your access tokens are valid for one hour. + // The access token time limit. After this limit expires, your user can't use + // their access token. To specify the time unit for AccessTokenValidity as seconds + // , minutes , hours , or days , set a TokenValidityUnits value in your API + // request. For example, when you set AccessTokenValidity to 10 and + // TokenValidityUnits to hours , your user can authorize access with their access + // token for 10 hours. The default time unit for AccessTokenValidity in an API + // request is hours. Valid range is displayed below in seconds. If you don't + // specify otherwise in the configuration of your app client, your access tokens + // are valid for one hour. AccessTokenValidity *int32 // The allowed OAuth flows. code Use a code grant flow, which provides an @@ -70,9 +70,9 @@ type UpdateUserPoolClientInput struct { // interacting with Amazon Cognito user pools. AllowedOAuthFlowsUserPoolClient bool - // The allowed OAuth scopes. Possible values provided by OAuth are phone, email, - // openid, and profile. Possible values provided by Amazon Web Services are - // aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are + // The allowed OAuth scopes. Possible values provided by OAuth are phone , email , + // openid , and profile . Possible values provided by Amazon Web Services are + // aws.cognito.signin.user.admin . Custom scopes created in Resource Servers are // also supported. AllowedOAuthScopes []string @@ -83,26 +83,20 @@ type UpdateUserPoolClientInput struct { // sending events to Amazon Pinpoint projects within that same Region. AnalyticsConfiguration *types.AnalyticsConfigurationType - // Amazon Cognito creates a session token for each API request in an authentication - // flow. AuthSessionValidity is the duration, in minutes, of that session token. - // Your user pool native user must respond to each authentication challenge before - // the session expires. + // Amazon Cognito creates a session token for each API request in an + // authentication flow. AuthSessionValidity is the duration, in minutes, of that + // session token. Your user pool native user must respond to each authentication + // challenge before the session expires. AuthSessionValidity *int32 // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - // - // * - // Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * Not - // include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. CallbackURLs []string // The client name from the update user pool client request. @@ -110,33 +104,27 @@ type UpdateUserPoolClientInput struct { // The default redirect URI. Must be in the CallbackURLs list. A redirect URI // must: - // - // * Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * - // Not include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. DefaultRedirectURI *string // Activates the propagation of additional user context data. For more information - // about propagation of user context data, see Adding advanced security to a user - // pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). - // If you don’t include this parameter, you can't send device fingerprint + // about propagation of user context data, see Adding advanced security to a user + // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) + // . If you don’t include this parameter, you can't send device fingerprint // information, including source IP address, to Amazon Cognito advanced security. // You can only activate EnablePropagateAdditionalUserContextData in an app client // that has a client secret. EnablePropagateAdditionalUserContextData *bool // Activates or deactivates token revocation. For more information about revoking - // tokens, see RevokeToken - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). + // tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) + // . EnableTokenRevocation *bool // The authentication flows that you want your user pool client to support. For @@ -144,42 +132,31 @@ type UpdateUserPoolClientInput struct { // combination of one or more flows, including with a user name and Secure Remote // Password (SRP), a user name and password, or a custom authentication process // that you define with Lambda functions. If you don't specify a value for - // ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, - // ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid values include: - // - // * - // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, your app passes a user name and password - // to Amazon Cognito in the request, instead of using the Secure Remote Password - // (SRP) protocol to securely transmit the password. - // - // * ALLOW_CUSTOM_AUTH: Enable - // Lambda trigger based authentication. - // - // * ALLOW_USER_PASSWORD_AUTH: Enable user - // password-based authentication. In this flow, Amazon Cognito receives the - // password in the request instead of using the SRP protocol to verify - // passwords. - // - // * ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. - // - // * - // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - // - // In some - // environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, - // or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to - // user pool clients at the same time as values that begin with ALLOW_, like - // ALLOW_USER_SRP_AUTH. + // ExplicitAuthFlows , your user client supports ALLOW_REFRESH_TOKEN_AUTH , + // ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH . Valid values include: + // - ALLOW_ADMIN_USER_PASSWORD_AUTH : Enable admin based user password + // authentication flow ADMIN_USER_PASSWORD_AUTH . This setting replaces the + // ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a + // user name and password to Amazon Cognito in the request, instead of using the + // Secure Remote Password (SRP) protocol to securely transmit the password. + // - ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication. + // - ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In + // this flow, Amazon Cognito receives the password in the request instead of using + // the SRP protocol to verify passwords. + // - ALLOW_USER_SRP_AUTH : Enable SRP-based authentication. + // - ALLOW_REFRESH_TOKEN_AUTH : Enable authflow to refresh tokens. + // In some environments, you will see the values ADMIN_NO_SRP_AUTH , + // CUSTOM_AUTH_FLOW_ONLY , or USER_PASSWORD_AUTH . You can't assign these legacy + // ExplicitAuthFlows values to user pool clients at the same time as values that + // begin with ALLOW_ , like ALLOW_USER_SRP_AUTH . ExplicitAuthFlows []types.ExplicitAuthFlowsType // The ID token time limit. After this limit expires, your user can't use their ID - // token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, - // or days, set a TokenValidityUnits value in your API request. For example, when - // you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can - // authenticate their session with their ID token for 10 hours. The default time - // unit for AccessTokenValidity in an API request is hours. Valid range is + // token. To specify the time unit for IdTokenValidity as seconds , minutes , hours + // , or days , set a TokenValidityUnits value in your API request. For example, + // when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user + // can authenticate their session with their ID token for 10 hours. The default + // time unit for AccessTokenValidity in an API request is hours. Valid range is // displayed below in seconds. If you don't specify otherwise in the configuration // of your app client, your ID tokens are valid for one hour. IdTokenValidity *int32 @@ -192,15 +169,12 @@ type UpdateUserPoolClientInput struct { // doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, // authentication returns an error indicating either the username or password was // incorrect. Account confirmation and password recovery return a response - // indicating a code was sent to a simulated destination. When set to LEGACY, those - // APIs return a UserNotFoundException exception if the user doesn't exist in the - // user pool. Valid values include: - // - // * ENABLED - This prevents user - // existence-related errors. - // - // * LEGACY - This represents the early behavior of - // Amazon Cognito where user existence related errors aren't prevented. + // indicating a code was sent to a simulated destination. When set to LEGACY , + // those APIs return a UserNotFoundException exception if the user doesn't exist + // in the user pool. Valid values include: + // - ENABLED - This prevents user existence-related errors. + // - LEGACY - This represents the early behavior of Amazon Cognito where user + // existence related errors aren't prevented. PreventUserExistenceErrors types.PreventUserExistenceErrorTypes // The read-only attributes of the user pool. @@ -208,19 +182,20 @@ type UpdateUserPoolClientInput struct { // The refresh token time limit. After this limit expires, your user can't use // their refresh token. To specify the time unit for RefreshTokenValidity as - // seconds, minutes, hours, or days, set a TokenValidityUnits value in your API - // request. For example, when you set RefreshTokenValidity as 10 and - // TokenValidityUnits as days, your user can refresh their session and retrieve new - // access and ID tokens for 10 days. The default time unit for RefreshTokenValidity - // in an API request is days. You can't set RefreshTokenValidity to 0. If you do, - // Amazon Cognito overrides the value with the default value of 30 days. Valid - // range is displayed below in seconds. If you don't specify otherwise in the - // configuration of your app client, your refresh tokens are valid for 30 days. + // seconds , minutes , hours , or days , set a TokenValidityUnits value in your + // API request. For example, when you set RefreshTokenValidity as 10 and + // TokenValidityUnits as days , your user can refresh their session and retrieve + // new access and ID tokens for 10 days. The default time unit for + // RefreshTokenValidity in an API request is days. You can't set + // RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with + // the default value of 30 days. Valid range is displayed below in seconds. If you + // don't specify otherwise in the configuration of your app client, your refresh + // tokens are valid for 30 days. RefreshTokenValidity int32 // A list of provider names for the IdPs that this client supports. The following - // are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and - // the names of your own SAML and OIDC providers. + // are supported: COGNITO , Facebook , Google , SignInWithApple , LoginWithAmazon , + // and the names of your own SAML and OIDC providers. SupportedIdentityProviders []string // The units in which the validity times are represented. The default unit for @@ -237,8 +212,8 @@ type UpdateUserPoolClientInput struct { // client. type UpdateUserPoolClientOutput struct { - // The user pool client value from the response from the server when you request to - // update the user pool client. + // The user pool client value from the response from the server when you request + // to update the user pool client. UserPoolClient *types.UserPoolClientType // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go index 467873b8776..14cbd87d0cf 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go @@ -28,8 +28,8 @@ import ( // choose US East (N. Virginia) as the Amazon Web Services Region. After you submit // your request, Amazon Cognito requires up to 1 hour to distribute your new // certificate to your custom domain. For more information about adding a custom -// domain to your user pool, see Using Your Own Domain for the Hosted UI -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html). +// domain to your user pool, see Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html) +// . func (c *Client) UpdateUserPoolDomain(ctx context.Context, params *UpdateUserPoolDomainInput, optFns ...func(*Options)) (*UpdateUserPoolDomainOutput, error) { if params == nil { params = &UpdateUserPoolDomainInput{} @@ -56,7 +56,7 @@ type UpdateUserPoolDomainInput struct { CustomDomainConfig *types.CustomDomainConfigType // The domain name for the custom domain that hosts the sign-up and sign-in pages - // for your application. One example might be auth.example.com. This string can + // for your application. One example might be auth.example.com . This string can // include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the // first or last character. Use periods to separate subdomain names. // diff --git a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go index e43acc52159..16e39ab3a7f 100644 --- a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go @@ -32,14 +32,14 @@ func (c *Client) VerifySoftwareToken(ctx context.Context, params *VerifySoftware type VerifySoftwareTokenInput struct { // The one- time password computed using the secret code returned by - // AssociateSoftwareToken - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html). + // AssociateSoftwareToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html) + // . // // This member is required. UserCode *string - // A valid access token that Amazon Cognito issued to the user whose software token - // you want to verify. + // A valid access token that Amazon Cognito issued to the user whose software + // token you want to verify. AccessToken *string // The friendly device name. diff --git a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go index 9119ff42cea..aa954df2286 100644 --- a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go +++ b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go @@ -12,8 +12,8 @@ import ( // Verifies the specified user attributes in the user pool. If your user pool // requires verification before Amazon Cognito updates the attribute value, // VerifyUserAttribute updates the affected attribute to its pending value. For -// more information, see UserAttributeUpdateSettingsType -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html). +// more information, see UserAttributeUpdateSettingsType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html) +// . func (c *Client) VerifyUserAttribute(ctx context.Context, params *VerifyUserAttributeInput, optFns ...func(*Options)) (*VerifyUserAttributeOutput, error) { if params == nil { params = &VerifyUserAttributeInput{} @@ -51,8 +51,8 @@ type VerifyUserAttributeInput struct { noSmithyDocumentSerde } -// A container representing the response from the server from the request to verify -// user attributes. +// A container representing the response from the server from the request to +// verify user attributes. type VerifyUserAttributeOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/cognitoidentityprovider/doc.go b/service/cognitoidentityprovider/doc.go index 13adc5054ae..9648e75477b 100644 --- a/service/cognitoidentityprovider/doc.go +++ b/service/cognitoidentityprovider/doc.go @@ -7,6 +7,6 @@ // directories and users. You can authenticate a user to obtain tokens related to // user identity and access policies. This API reference provides information about // user pools in Amazon Cognito user pools. For more information, see the Amazon -// Cognito Documentation -// (https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html). +// Cognito Documentation (https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html) +// . package cognitoidentityprovider diff --git a/service/cognitoidentityprovider/types/enums.go b/service/cognitoidentityprovider/types/enums.go index 6f3f3061bed..2b5c36c609d 100644 --- a/service/cognitoidentityprovider/types/enums.go +++ b/service/cognitoidentityprovider/types/enums.go @@ -34,9 +34,9 @@ const ( AdvancedSecurityModeTypeEnforced AdvancedSecurityModeType = "ENFORCED" ) -// Values returns all known values for AdvancedSecurityModeType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AdvancedSecurityModeType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AdvancedSecurityModeType) Values() []AdvancedSecurityModeType { return []AdvancedSecurityModeType{ "OFF", @@ -100,9 +100,9 @@ const ( AuthFlowTypeAdminUserPasswordAuth AuthFlowType = "ADMIN_USER_PASSWORD_AUTH" ) -// Values returns all known values for AuthFlowType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AuthFlowType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AuthFlowType) Values() []AuthFlowType { return []AuthFlowType{ "USER_SRP_AUTH", @@ -403,9 +403,9 @@ const ( EventTypeResendCode EventType = "ResendCode" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "SignIn", @@ -430,8 +430,8 @@ const ( ExplicitAuthFlowsTypeAllowRefreshTokenAuth ExplicitAuthFlowsType = "ALLOW_REFRESH_TOKEN_AUTH" ) -// Values returns all known values for ExplicitAuthFlowsType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ExplicitAuthFlowsType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ExplicitAuthFlowsType) Values() []ExplicitAuthFlowsType { return []ExplicitAuthFlowsType{ @@ -476,9 +476,9 @@ const ( IdentityProviderTypeTypeOidc IdentityProviderTypeType = "OIDC" ) -// Values returns all known values for IdentityProviderTypeType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityProviderTypeType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityProviderTypeType) Values() []IdentityProviderTypeType { return []IdentityProviderTypeType{ "SAML", @@ -685,8 +685,8 @@ const ( UsernameAttributeTypeEmail UsernameAttributeType = "email" ) -// Values returns all known values for UsernameAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for UsernameAttributeType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (UsernameAttributeType) Values() []UsernameAttributeType { return []UsernameAttributeType{ @@ -751,8 +751,8 @@ const ( VerifiedAttributeTypeEmail VerifiedAttributeType = "email" ) -// Values returns all known values for VerifiedAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VerifiedAttributeType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAttributeType) Values() []VerifiedAttributeType { return []VerifiedAttributeType{ diff --git a/service/cognitoidentityprovider/types/errors.go b/service/cognitoidentityprovider/types/errors.go index e4f7d172e62..b177b20641e 100644 --- a/service/cognitoidentityprovider/types/errors.go +++ b/service/cognitoidentityprovider/types/errors.go @@ -981,8 +981,8 @@ func (e *UserLambdaValidationException) ErrorCode() string { } func (e *UserLambdaValidationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when Amazon Cognito encounters a user name that already -// exists in the user pool. +// This exception is thrown when Amazon Cognito encounters a user name that +// already exists in the user pool. type UsernameExistsException struct { Message *string diff --git a/service/cognitoidentityprovider/types/types.go b/service/cognitoidentityprovider/types/types.go index 4ec7f15d1eb..2385383c279 100644 --- a/service/cognitoidentityprovider/types/types.go +++ b/service/cognitoidentityprovider/types/types.go @@ -7,10 +7,10 @@ import ( "time" ) -// The data type for AccountRecoverySetting. +// The data type for AccountRecoverySetting . type AccountRecoverySettingType struct { - // The list of RecoveryOptionTypes. + // The list of RecoveryOptionTypes . RecoveryMechanisms []RecoveryOptionType noSmithyDocumentSerde @@ -36,17 +36,12 @@ type AccountTakeoverActionType struct { // The action to take in response to the account takeover action. Valid values are // as follows: - // - // * BLOCK Choosing this action will block the request. - // - // * - // MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow - // the request. - // - // * MFA_REQUIRED Present an MFA challenge if user has configured it, - // else block the request. - // - // * NO_ACTION Allow the user to sign in. + // - BLOCK Choosing this action will block the request. + // - MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else + // allow the request. + // - MFA_REQUIRED Present an MFA challenge if user has configured it, else block + // the request. + // - NO_ACTION Allow the user to sign in. // // This member is required. EventAction AccountTakeoverEventActionType @@ -77,20 +72,20 @@ type AccountTakeoverRiskConfigurationType struct { // The configuration for creating a new user profile. type AdminCreateUserConfigType struct { - // Set to True if only the administrator is allowed to create user profiles. Set to - // False if users can sign themselves up via an app. + // Set to True if only the administrator is allowed to create user profiles. Set + // to False if users can sign themselves up via an app. AllowAdminCreateUserOnly bool // The message template to be used for the welcome message to new users. See also - // Customizing User Invitation Messages - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization). + // Customizing User Invitation Messages (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) + // . InviteMessageTemplate *MessageTemplateType // The user account expiration limit, in days, after which a new account that // hasn't signed in is no longer usable. To reset the account after that time // limit, you must call AdminCreateUser again, specifying "RESEND" for the // MessageAction parameter. The default value for this parameter is 7. If you set a - // value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be + // value for TemporaryPasswordValidityDays in PasswordPolicy , that value will be // used, and UnusedAccountValidityDays will be no longer be an available parameter // for that user pool. UnusedAccountValidityDays int32 @@ -117,11 +112,11 @@ type AnalyticsConfigurationType struct { // The external ID. ExternalId *string - // The ARN of an Identity and Access Management role that authorizes Amazon Cognito - // to publish events to Amazon Pinpoint analytics. + // The ARN of an Identity and Access Management role that authorizes Amazon + // Cognito to publish events to Amazon Pinpoint analytics. RoleArn *string - // If UserDataShared is true, Amazon Cognito includes user data in the events that + // If UserDataShared is true , Amazon Cognito includes user data in the events that // it publishes to Amazon Pinpoint analytics. UserDataShared bool @@ -132,8 +127,8 @@ type AnalyticsConfigurationType struct { // device, email address, or phone number that can receive messages from Amazon // Pinpoint analytics. For more information about Amazon Web Services Regions that // can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, -// see Using Amazon Pinpoint analytics with Amazon Cognito user pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html). +// see Using Amazon Pinpoint analytics with Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) +// . type AnalyticsMetadataType struct { // The endpoint ID. @@ -269,8 +264,8 @@ type CompromisedCredentialsRiskConfigurationType struct { noSmithyDocumentSerde } -// Contextual user data type used for evaluating the risk of an unexpected event by -// Amazon Cognito advanced security. +// Contextual user data type used for evaluating the risk of an unexpected event +// by Amazon Cognito advanced security. type ContextDataType struct { // HttpHeaders received on your server in same order. @@ -295,8 +290,8 @@ type ContextDataType struct { // Encoded device-fingerprint details that your app collected with the Amazon // Cognito context data collection library. For more information, see Adding user - // device and session data to API requests - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). + // device and session data to API requests (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint) + // . EncodedData *string noSmithyDocumentSerde @@ -325,7 +320,7 @@ type CustomEmailLambdaVersionConfigType struct { LambdaArn *string // Signature of the "request" attribute in the "event" information Amazon Cognito - // passes to your custom email Lambda function. The only supported value is V1_0. + // passes to your custom email Lambda function. The only supported value is V1_0 . // // This member is required. LambdaVersion CustomEmailSenderLambdaVersionType @@ -344,7 +339,7 @@ type CustomSMSLambdaVersionConfigType struct { // Signature of the "request" attribute in the "event" information that Amazon // Cognito passes to your custom SMS Lambda function. The only supported value is - // V1_0. + // V1_0 . // // This member is required. LambdaVersion CustomSMSSenderLambdaVersionType @@ -352,42 +347,34 @@ type CustomSMSLambdaVersionConfigType struct { noSmithyDocumentSerde } -// The device-remembering configuration for a user pool. A DescribeUserPool -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) +// The device-remembering configuration for a user pool. A DescribeUserPool (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) // request returns a null value for this object when the user pool isn't configured // to remember devices. When device remembering is active, you can remember a -// user's device with a ConfirmDevice -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) -// API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is -// true, you must follow ConfirmDevice with an UpdateDeviceStatus -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) -// API request that sets the user's device to remembered or not_remembered. To sign -// in with a remembered device, include DEVICE_KEY in the authentication parameters -// in your user's InitiateAuth -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) -// request. If your app doesn't include a DEVICE_KEY parameter, the response -// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax) +// user's device with a ConfirmDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) +// API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt +// is true , you must follow ConfirmDevice with an UpdateDeviceStatus (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) +// API request that sets the user's device to remembered or not_remembered . To +// sign in with a remembered device, include DEVICE_KEY in the authentication +// parameters in your user's InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) +// request. If your app doesn't include a DEVICE_KEY parameter, the response (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax) // from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY -// values under NewDeviceMetadata. Store these values to use in future +// values under NewDeviceMetadata . Store these values to use in future // device-authentication requests. When you provide a value for any property of -// DeviceConfiguration, you activate the device remembering for the user pool. +// DeviceConfiguration , you activate the device remembering for the user pool. type DeviceConfigurationType struct { - // When true, a remembered device can sign in with device authentication instead of - // SMS and time-based one-time password (TOTP) factors for multi-factor - // authentication (MFA). Whether or not ChallengeRequiredOnNewDevice is true, users - // who sign in with devices that have not been confirmed or remembered must still - // provide a second factor in a user pool that requires MFA. + // When true, a remembered device can sign in with device authentication instead + // of SMS and time-based one-time password (TOTP) factors for multi-factor + // authentication (MFA). Whether or not ChallengeRequiredOnNewDevice is true, + // users who sign in with devices that have not been confirmed or remembered must + // still provide a second factor in a user pool that requires MFA. ChallengeRequiredOnNewDevice bool // When true, Amazon Cognito doesn't automatically remember a user's device when - // your app sends a ConfirmDevice - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) + // your app sends a ConfirmDevice (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) // API request. In your app, create a prompt for your user to choose whether they - // want to remember their device. Return the user's choice in an - // UpdateDeviceStatus - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) - // API request. When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito + // want to remember their device. Return the user's choice in an UpdateDeviceStatus (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) + // API request. When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito // immediately remembers devices that you register in a ConfirmDevice API request. DeviceOnlyRememberedOnUserPrompt bool @@ -441,8 +428,8 @@ type DomainDescriptionType struct { CustomDomainConfig *CustomDomainConfigType // The domain string. For custom domains, this is the fully-qualified domain name, - // such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix - // alone, such as auth. + // such as auth.example.com . For Amazon Cognito prefix domains, this is the prefix + // alone, such as auth . Domain *string // The Amazon S3 bucket where the static files for this domain are stored. @@ -465,9 +452,9 @@ type DomainDescriptionType struct { // messages from your user pool. Amazon Cognito can send email messages with Amazon // Simple Email Service resources in the Amazon Web Services Region where you // created your user pool, and in alternate Regions in some cases. For more -// information on the supported Regions, see Email settings for Amazon Cognito user -// pools -// (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html). +// information on the supported Regions, see Email settings for Amazon Cognito +// user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html) +// . type EmailConfigurationType struct { // The set of configuration rules that can be applied to emails sent using Amazon @@ -492,10 +479,9 @@ type EmailConfigurationType struct { // each day for your user pool. For typical production environments, the default // email limit is less than the required delivery volume. To achieve a higher // delivery volume, specify DEVELOPER to use your Amazon SES email configuration. - // To look up the email delivery limit for the default option, see Limits - // (https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the - // Amazon Cognito Developer Guide. The default FROM address is - // no-reply@verificationemail.com. To customize the FROM address, provide the + // To look up the email delivery limit for the default option, see Limits (https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) + // in the Amazon Cognito Developer Guide. The default FROM address is + // no-reply@verificationemail.com . To customize the FROM address, provide the // Amazon Resource Name (ARN) of an Amazon SES verified email address for the // SourceArn parameter. DEVELOPER When Amazon Cognito emails your users, it uses // your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to @@ -508,15 +494,14 @@ type EmailConfigurationType struct { // Amazon Cognito creates a service-linked role, which is a type of role in your // Amazon Web Services account. This role contains the permissions that allow you // to access Amazon SES and send email messages from your email address. For more - // information about the service-linked role that Amazon Cognito creates, see Using - // Service-Linked Roles for Amazon Cognito - // (https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) + // information about the service-linked role that Amazon Cognito creates, see + // Using Service-Linked Roles for Amazon Cognito (https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) // in the Amazon Cognito Developer Guide. EmailSendingAccount EmailSendingAccountType - // Either the sender’s email address or the sender’s name with their email address. - // For example, testuser@example.com or Test User . This address appears before the - // body of the email. + // Either the sender’s email address or the sender’s name with their email + // address. For example, testuser@example.com or Test User . This address appears + // before the body of the email. From *string // The destination to which the receiver of the email should reply. @@ -525,22 +510,16 @@ type EmailConfigurationType struct { // The ARN of a verified email address in Amazon SES. Amazon Cognito uses this // email address in one of the following ways, depending on the value that you // specify for the EmailSendingAccount parameter: - // - // * If you specify - // COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address - // when it emails your users using its built-in email account. - // - // * If you specify - // DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon - // SES on your behalf. - // - // The Region value of the SourceArn parameter must indicate a - // supported Amazon Web Services Region of your user pool. Typically, the Region in - // the SourceArn and the user pool Region are the same. For more information, see - // Amazon SES email configuration regions - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) - // in the Amazon Cognito Developer Guide - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). + // - If you specify COGNITO_DEFAULT , Amazon Cognito uses this address as the + // custom FROM address when it emails your users using its built-in email account. + // - If you specify DEVELOPER , Amazon Cognito emails your users with this + // address by calling Amazon SES on your behalf. + // The Region value of the SourceArn parameter must indicate a supported Amazon + // Web Services Region of your user pool. Typically, the Region in the SourceArn + // and the user pool Region are the same. For more information, see Amazon SES + // email configuration regions (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) + // in the Amazon Cognito Developer Guide (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // . SourceArn *string noSmithyDocumentSerde @@ -589,8 +568,8 @@ type EventFeedbackType struct { // The event risk type. type EventRiskType struct { - // Indicates whether compromised credentials were detected during an authentication - // event. + // Indicates whether compromised credentials were detected during an + // authentication event. CompromisedCredentialsDetected *bool // The risk decision. @@ -623,9 +602,9 @@ type GroupType struct { // precedence over groups with higher ornull Precedence values. If a user belongs // to two or more groups, it is the group with the lowest precedence value whose // role ARN is given in the user's tokens for the cognito:roles and - // cognito:preferred_role claims. Two groups can have the same Precedence value. If - // this happens, neither group takes precedence over the other. If two groups with - // the same Precedence have the same role ARN, that role is used in the + // cognito:preferred_role claims. Two groups can have the same Precedence value. + // If this happens, neither group takes precedence over the other. If two groups + // with the same Precedence have the same role ARN, that role is used in the // cognito:preferred_role claim in tokens for users in each group. If the two // groups have different role ARNs, the cognito:preferred_role claim isn't set in // users' tokens. The default Precedence value is null. @@ -669,79 +648,40 @@ type IdentityProviderType struct { // The IdP details. The following list describes the provider detail keys for each // IdP type. - // - // * For Google and Login with Amazon: - // - // * client_id - // - // * client_secret - // - // * - // authorize_scopes - // - // * For Facebook: - // - // * client_id - // - // * client_secret - // - // * - // authorize_scopes - // - // * api_version - // - // * For Sign in with Apple: - // - // * client_id - // - // * - // team_id - // - // * key_id - // - // * private_key You can submit a private_key when you add or - // update an IdP. Describe operations don't return the private key. - // - // * - // authorize_scopes - // - // * For OIDC providers: - // - // * client_id - // - // * client_secret - // - // * - // attributes_request_method - // - // * oidc_issuer - // - // * authorize_scopes - // - // * The following - // keys are only present if Amazon Cognito didn't discover them at the oidc_issuer - // URL. - // - // * authorize_url - // - // * token_url - // - // * attributes_url - // - // * jwks_uri - // - // * Amazon - // Cognito sets the value of the following keys automatically. They are - // read-only. - // - // * attributes_url_add_attributes - // - // * For SAML providers: - // - // * - // MetadataFile or MetadataURL - // - // * IDPSignout optional + // - For Google and Login with Amazon: + // - client_id + // - client_secret + // - authorize_scopes + // - For Facebook: + // - client_id + // - client_secret + // - authorize_scopes + // - api_version + // - For Sign in with Apple: + // - client_id + // - team_id + // - key_id + // - private_key You can submit a private_key when you add or update an IdP. + // Describe operations don't return the private key. + // - authorize_scopes + // - For OIDC providers: + // - client_id + // - client_secret + // - attributes_request_method + // - oidc_issuer + // - authorize_scopes + // - The following keys are only present if Amazon Cognito didn't discover them + // at the oidc_issuer URL. + // - authorize_url + // - token_url + // - attributes_url + // - jwks_uri + // - Amazon Cognito sets the value of the following keys automatically. They are + // read-only. + // - attributes_url_add_attributes + // - For SAML providers: + // - MetadataFile or MetadataURL + // - IDPSignout optional ProviderDetails map[string]string // The IdP name. @@ -774,9 +714,9 @@ type LambdaConfigType struct { // Defines the authentication challenge. DefineAuthChallenge *string - // The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to + // The Amazon Resource Name (ARN) of an KMS key . Amazon Cognito uses the key to // encrypt codes and temporary passwords sent to CustomEmailSender and - // CustomSMSSender. + // CustomSMSSender . KMSKeyID *string // A post-authentication Lambda trigger. @@ -807,14 +747,12 @@ type LambdaConfigType struct { type MessageTemplateType struct { // The message template for email messages. EmailMessage is allowed only if - // EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) // is DEVELOPER. EmailMessage *string // The subject line for email messages. EmailSubject is allowed only if - // EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) // is DEVELOPER. EmailSubject *string @@ -829,11 +767,11 @@ type MessageTemplateType struct { // password (TOTP) software token MFA configurations. type MFAOptionType struct { - // The attribute name of the MFA option type. The only valid value is phone_number. + // The attribute name of the MFA option type. The only valid value is phone_number . AttributeName *string - // The delivery medium to send the MFA code. You can use this parameter to set only - // the SMS delivery medium value. + // The delivery medium to send the MFA code. You can use this parameter to set + // only the SMS delivery medium value. DeliveryMedium DeliveryMediumType noSmithyDocumentSerde @@ -869,8 +807,8 @@ type NotifyConfigurationType struct { // has been verified with Amazon SES. From *string - // The multi-factor authentication (MFA) email template used when MFA is challenged - // as part of a detected risk. + // The multi-factor authentication (MFA) email template used when MFA is + // challenged as part of a detected risk. MfaEmail *NotifyEmailType // The email template used when a detected risk event is allowed. @@ -936,9 +874,9 @@ type PasswordPolicyType struct { // The number of days a temporary password is valid in the password policy. If the // user doesn't sign in during this time, an administrator must reset their - // password. When you set TemporaryPasswordValidityDays for a user pool, you can no - // longer set a value for the legacy UnusedAccountValidityDays parameter in that - // user pool. + // password. When you set TemporaryPasswordValidityDays for a user pool, you can + // no longer set a value for the legacy UnusedAccountValidityDays parameter in + // that user pool. TemporaryPasswordValidityDays int32 noSmithyDocumentSerde @@ -965,10 +903,10 @@ type ProviderDescription struct { // A container for information about an IdP for a user pool. type ProviderUserIdentifierType struct { - // The name of the provider attribute to link to, such as NameID. + // The name of the provider attribute to link to, such as NameID . ProviderAttributeName *string - // The value of the provider attribute to link to, such as xxxxx_account. + // The value of the provider attribute to link to, such as xxxxx_account . ProviderAttributeValue *string // The name of the provider, such as Facebook, Google, or Login with Amazon. @@ -1039,7 +977,7 @@ type RiskConfigurationType struct { ClientId *string // The compromised credentials risk configuration object, including the EventFilter - // and the EventAction. + // and the EventAction . CompromisedCredentialsRiskConfiguration *CompromisedCredentialsRiskConfigurationType // The last modified date. @@ -1057,9 +995,9 @@ type RiskConfigurationType struct { // The type of the configuration to override the risk decision. type RiskExceptionConfigurationType struct { - // Overrides the risk decision to always block the pre-authentication requests. The - // IP range is in CIDR notation, a compact representation of an IP address and its - // routing prefix. + // Overrides the risk decision to always block the pre-authentication requests. + // The IP range is in CIDR notation, a compact representation of an IP address and + // its routing prefix. BlockedIPRangeList []string // Risk detection isn't performed on the IP addresses in this range list. The IP @@ -1075,10 +1013,9 @@ type SchemaAttributeType struct { // The attribute data type. AttributeDataType AttributeDataType - // You should use WriteAttributes - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) + // You should use WriteAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) // in the user pool client to control how attributes can be mutated for new use - // cases instead of using DeveloperOnlyAttribute. Specifies whether the attribute + // cases instead of using DeveloperOnlyAttribute . Specifies whether the attribute // type is developer only. This attribute can only be modified by an administrator. // Users won't be able to modify this attribute using their access token. For // example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes @@ -1087,11 +1024,11 @@ type SchemaAttributeType struct { // Specifies whether the value of the attribute can be changed. For any user pool // attribute that is mapped to an IdP attribute, you must set this parameter to - // true. Amazon Cognito updates mapped attributes when users sign in to your + // true . Amazon Cognito updates mapped attributes when users sign in to your // application through an IdP. If an attribute is immutable, Amazon Cognito throws // an error when it attempts to update the attribute. For more information, see - // Specifying Identity Provider Attribute Mappings for Your User Pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html). + // Specifying Identity Provider Attribute Mappings for Your User Pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) + // . Mutable *bool // A schema attribute of the name type. @@ -1120,24 +1057,23 @@ type SmsConfigurationType struct { // The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the // IAM role in your Amazon Web Services account that Amazon Cognito will use to - // send SMS messages. SMS messages are subject to a spending limit - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html). + // send SMS messages. SMS messages are subject to a spending limit (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html) + // . // // This member is required. SnsCallerArn *string // The external ID provides additional security for your IAM role. You can use an // ExternalId with the IAM role that you use with Amazon SNS to send SMS messages - // for your user pool. If you provide an ExternalId, your Amazon Cognito user pool + // for your user pool. If you provide an ExternalId , your Amazon Cognito user pool // includes it in the request to assume your IAM role. You can configure the role // trust policy to require that Amazon Cognito, and any principal, provide the - // ExternalID. If you use the Amazon Cognito Management Console to create a role + // ExternalID . If you use the Amazon Cognito Management Console to create a role // for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with // the required permissions and a trust policy that demonstrates use of the - // ExternalId. For more information about the ExternalId of a role, see How to use - // an external ID when granting access to your Amazon Web Services resources to a - // third party - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) + // ExternalId . For more information about the ExternalId of a role, see How to + // use an external ID when granting access to your Amazon Web Services resources to + // a third party (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) ExternalId *string // The Amazon Web Services Region to use with Amazon SNS integration. You can @@ -1145,8 +1081,8 @@ type SmsConfigurationType struct { // alternate Region. Amazon Cognito resources in the Asia Pacific (Seoul) Amazon // Web Services Region must use your Amazon SNS configuration in the Asia Pacific // (Tokyo) Region. For more information, see SMS message settings for Amazon - // Cognito user pools - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html). + // Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) + // . SnsRegion *string noSmithyDocumentSerde @@ -1180,9 +1116,9 @@ type SmsMfaConfigType struct { // Authentication for the user pool. type SMSMfaSettingsType struct { - // Specifies whether SMS text message MFA is activated. If an MFA type is activated - // for a user, the user will be prompted for MFA during all sign-in attempts, - // unless device tracking is turned on and the device has been trusted. + // Specifies whether SMS text message MFA is activated. If an MFA type is + // activated for a user, the user will be prompted for MFA during all sign-in + // attempts, unless device tracking is turned on and the device has been trusted. Enabled bool // Specifies whether SMS is the preferred MFA method. @@ -1235,18 +1171,19 @@ type StringAttributeConstraintsType struct { // the duration of ID, access, and refresh tokens. type TokenValidityUnitsType struct { - // A time unit of seconds, minutes, hours, or days for the value that you set in - // the AccessTokenValidity parameter. The default AccessTokenValidity time unit is - // hours. + // A time unit of seconds , minutes , hours , or days for the value that you set + // in the AccessTokenValidity parameter. The default AccessTokenValidity time unit + // is hours. AccessToken TimeUnitsType - // A time unit of seconds, minutes, hours, or days for the value that you set in - // the IdTokenValidity parameter. The default IdTokenValidity time unit is hours. + // A time unit of seconds , minutes , hours , or days for the value that you set + // in the IdTokenValidity parameter. The default IdTokenValidity time unit is + // hours. IdToken TimeUnitsType - // A time unit of seconds, minutes, hours, or days for the value that you set in - // the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit - // is days. + // A time unit of seconds , minutes , hours , or days for the value that you set + // in the RefreshTokenValidity parameter. The default RefreshTokenValidity time + // unit is days. RefreshToken TimeUnitsType noSmithyDocumentSerde @@ -1280,12 +1217,12 @@ type UICustomizationType struct { noSmithyDocumentSerde } -// The settings for updates to user attributes. These settings include the property -// AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon -// Cognito how to handle changes to the value of your users' email address and -// phone number attributes. For more information, see Verifying updates to email -// addresses and phone numbers -// (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). +// The settings for updates to user attributes. These settings include the +// property AttributesRequireVerificationBeforeUpdate , a user-pool setting that +// tells Amazon Cognito how to handle changes to the value of your users' email +// address and phone number attributes. For more information, see Verifying +// updates to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates) +// . type UserAttributeUpdateSettingsType struct { // Requires that your user verifies their email address, phone number, or both @@ -1294,12 +1231,9 @@ type UserAttributeUpdateSettingsType struct { // verification message to the new phone number or email address. Amazon Cognito // doesn’t change the value of the attribute until your user responds to the // verification message and confirms the new value. You can verify an updated email - // address or phone number with a VerifyUserAttribute - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html) - // API request. You can also call the UpdateUserAttributes - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) - // or AdminUpdateUserAttributes - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) + // address or phone number with a VerifyUserAttribute (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html) + // API request. You can also call the UpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) + // or AdminUpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) // API and set email_verified or phone_number_verified to true. When // AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't // require that your users verify attribute changes before Amazon Cognito updates @@ -1311,15 +1245,15 @@ type UserAttributeUpdateSettingsType struct { noSmithyDocumentSerde } -// Contextual data, such as the user's device fingerprint, IP address, or location, -// used for evaluating the risk of an unexpected event by Amazon Cognito advanced -// security. +// Contextual data, such as the user's device fingerprint, IP address, or +// location, used for evaluating the risk of an unexpected event by Amazon Cognito +// advanced security. type UserContextDataType struct { // Encoded device-fingerprint details that your app collected with the Amazon // Cognito context data collection library. For more information, see Adding user - // device and session data to API requests - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). + // device and session data to API requests (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint) + // . EncodedData *string // The source IP address of your user's device. @@ -1367,30 +1301,17 @@ type UserImportJobType struct { StartDate *time.Time // The status of the user import job. One of the following: - // - // * Created - The job - // was created but not started. - // - // * Pending - A transition state. You have started - // the job, but it has not begun importing users yet. - // - // * InProgress - The job has - // started, and users are being imported. - // - // * Stopping - You have stopped the job, - // but the job has not stopped importing users yet. - // - // * Stopped - You have stopped - // the job, and the job has stopped importing users. - // - // * Succeeded - The job has - // completed successfully. - // - // * Failed - The job has stopped due to an error. - // - // * - // Expired - You created a job, but did not start the job within 24-48 hours. All - // data associated with the job was deleted, and the job can't be started. + // - Created - The job was created but not started. + // - Pending - A transition state. You have started the job, but it has not begun + // importing users yet. + // - InProgress - The job has started, and users are being imported. + // - Stopping - You have stopped the job, but the job has not stopped importing + // users yet. + // - Stopped - You have stopped the job, and the job has stopped importing users. + // - Succeeded - The job has completed successfully. + // - Failed - The job has stopped due to an error. + // - Expired - You created a job, but did not start the job within 24-48 hours. + // All data associated with the job was deleted, and the job can't be started. Status UserImportJobStatusType // The user pool ID for the user pool that the users are being imported into. @@ -1404,11 +1325,11 @@ type UsernameConfigurationType struct { // Specifies whether user name case sensitivity will be applied for all users in // the user pool through Amazon Cognito APIs. Valid values include: True Enables - // case sensitivity for all username input. When this option is set to True, users + // case sensitivity for all username input. When this option is set to True , users // must sign in using the exact capitalization of their given username, such as // “UserName”. This is the default value. False Enables case insensitivity for all - // username input. For example, when this option is set to False, users can sign in - // using either "username" or "Username". This option also enables both + // username input. For example, when this option is set to False , users can sign + // in using either "username" or "Username". This option also enables both // preferred_username and email alias to be case insensitive, in addition to the // username attribute. // @@ -1448,14 +1369,15 @@ type UserPoolClientDescription struct { // Contains information about a user pool client. type UserPoolClientType struct { - // The access token time limit. After this limit expires, your user can't use their - // access token. To specify the time unit for AccessTokenValidity as seconds, - // minutes, hours, or days, set a TokenValidityUnits value in your API request. For - // example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, - // your user can authorize access with their access token for 10 hours. The default - // time unit for AccessTokenValidity in an API request is hours. Valid range is - // displayed below in seconds. If you don't specify otherwise in the configuration - // of your app client, your access tokens are valid for one hour. + // The access token time limit. After this limit expires, your user can't use + // their access token. To specify the time unit for AccessTokenValidity as seconds + // , minutes , hours , or days , set a TokenValidityUnits value in your API + // request. For example, when you set AccessTokenValidity to 10 and + // TokenValidityUnits to hours , your user can authorize access with their access + // token for 10 hours. The default time unit for AccessTokenValidity in an API + // request is hours. Valid range is displayed below in seconds. If you don't + // specify otherwise in the configuration of your app client, your access tokens + // are valid for one hour. AccessTokenValidity *int32 // The allowed OAuth flows. code Use a code grant flow, which provides an @@ -1471,8 +1393,8 @@ type UserPoolClientType struct { AllowedOAuthFlowsUserPoolClient *bool // The OAuth scopes that your app client supports. Possible values that OAuth - // provides are phone, email, openid, and profile. Possible values that Amazon Web - // Services provides are aws.cognito.signin.user.admin. Amazon Cognito also + // provides are phone , email , openid , and profile . Possible values that Amazon + // Web Services provides are aws.cognito.signin.user.admin . Amazon Cognito also // supports custom scopes that you create in Resource Servers. AllowedOAuthScopes []string @@ -1482,26 +1404,20 @@ type UserPoolClientType struct { // user pool resides. AnalyticsConfiguration *AnalyticsConfigurationType - // Amazon Cognito creates a session token for each API request in an authentication - // flow. AuthSessionValidity is the duration, in minutes, of that session token. - // Your user pool native user must respond to each authentication challenge before - // the session expires. + // Amazon Cognito creates a session token for each API request in an + // authentication flow. AuthSessionValidity is the duration, in minutes, of that + // session token. Your user pool native user must respond to each authentication + // challenge before the session expires. AuthSessionValidity *int32 // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - // - // * - // Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * Not - // include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. CallbackURLs []string // The ID of the client associated with the user pool. @@ -1518,41 +1434,36 @@ type UserPoolClientType struct { // The default redirect URI. Must be in the CallbackURLs list. A redirect URI // must: - // - // * Be an absolute URI. - // - // * Be registered with the authorization server. - // - // * - // Not include a fragment component. - // - // See OAuth 2.0 - Redirection Endpoint - // (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito requires - // HTTPS over HTTP except for http://localhost for testing purposes only. App - // callback URLs such as myapp://example are also supported. + // - Be an absolute URI. + // - Be registered with the authorization server. + // - Not include a fragment component. + // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2) + // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for + // testing purposes only. App callback URLs such as myapp://example are also + // supported. DefaultRedirectURI *string - // When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an - // IpAddress value that you send in the UserContextData parameter. The + // When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts + // an IpAddress value that you send in the UserContextData parameter. The // UserContextData parameter sends information to Amazon Cognito advanced security // for risk analysis. You can send UserContextData when you sign in Amazon Cognito // native users with the InitiateAuth and RespondToAuthChallenge API operations. // When EnablePropagateAdditionalUserContextData is false, you can't send your // user's source IP address to Amazon Cognito advanced security with - // unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't - // affect whether you can send a source IP address in a ContextData parameter with - // the authenticated API operations AdminInitiateAuth and - // AdminRespondToAuthChallenge. You can only activate + // unauthenticated API operations. EnablePropagateAdditionalUserContextData + // doesn't affect whether you can send a source IP address in a ContextData + // parameter with the authenticated API operations AdminInitiateAuth and + // AdminRespondToAuthChallenge . You can only activate // EnablePropagateAdditionalUserContextData in an app client that has a client // secret. For more information about propagation of user context data, see Adding - // user device and session data to API requests - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). + // user device and session data to API requests (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint) + // . EnablePropagateAdditionalUserContextData *bool // Indicates whether token revocation is activated for the user pool client. When // you create a new user pool client, token revocation is activated by default. For - // more information about revoking tokens, see RevokeToken - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). + // more information about revoking tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) + // . EnableTokenRevocation *bool // The authentication flows that you want your user pool client to support. For @@ -1560,42 +1471,31 @@ type UserPoolClientType struct { // combination of one or more flows, including with a user name and Secure Remote // Password (SRP), a user name and password, or a custom authentication process // that you define with Lambda functions. If you don't specify a value for - // ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, - // ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid values include: - // - // * - // ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication - // flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH - // setting. With this authentication flow, your app passes a user name and password - // to Amazon Cognito in the request, instead of using the Secure Remote Password - // (SRP) protocol to securely transmit the password. - // - // * ALLOW_CUSTOM_AUTH: Enable - // Lambda trigger based authentication. - // - // * ALLOW_USER_PASSWORD_AUTH: Enable user - // password-based authentication. In this flow, Amazon Cognito receives the - // password in the request instead of using the SRP protocol to verify - // passwords. - // - // * ALLOW_USER_SRP_AUTH: Enable SRP-based authentication. - // - // * - // ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. - // - // In some - // environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, - // or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to - // user pool clients at the same time as values that begin with ALLOW_, like - // ALLOW_USER_SRP_AUTH. + // ExplicitAuthFlows , your user client supports ALLOW_REFRESH_TOKEN_AUTH , + // ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH . Valid values include: + // - ALLOW_ADMIN_USER_PASSWORD_AUTH : Enable admin based user password + // authentication flow ADMIN_USER_PASSWORD_AUTH . This setting replaces the + // ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a + // user name and password to Amazon Cognito in the request, instead of using the + // Secure Remote Password (SRP) protocol to securely transmit the password. + // - ALLOW_CUSTOM_AUTH : Enable Lambda trigger based authentication. + // - ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In + // this flow, Amazon Cognito receives the password in the request instead of using + // the SRP protocol to verify passwords. + // - ALLOW_USER_SRP_AUTH : Enable SRP-based authentication. + // - ALLOW_REFRESH_TOKEN_AUTH : Enable authflow to refresh tokens. + // In some environments, you will see the values ADMIN_NO_SRP_AUTH , + // CUSTOM_AUTH_FLOW_ONLY , or USER_PASSWORD_AUTH . You can't assign these legacy + // ExplicitAuthFlows values to user pool clients at the same time as values that + // begin with ALLOW_ , like ALLOW_USER_SRP_AUTH . ExplicitAuthFlows []ExplicitAuthFlowsType // The ID token time limit. After this limit expires, your user can't use their ID - // token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, - // or days, set a TokenValidityUnits value in your API request. For example, when - // you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can - // authenticate their session with their ID token for 10 hours. The default time - // unit for AccessTokenValidity in an API request is hours. Valid range is + // token. To specify the time unit for IdTokenValidity as seconds , minutes , hours + // , or days , set a TokenValidityUnits value in your API request. For example, + // when you set IdTokenValidity as 10 and TokenValidityUnits as hours , your user + // can authenticate their session with their ID token for 10 hours. The default + // time unit for AccessTokenValidity in an API request is hours. Valid range is // displayed below in seconds. If you don't specify otherwise in the configuration // of your app client, your ID tokens are valid for one hour. IdTokenValidity *int32 @@ -1611,15 +1511,12 @@ type UserPoolClientType struct { // doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, // authentication returns an error indicating either the username or password was // incorrect. Account confirmation and password recovery return a response - // indicating a code was sent to a simulated destination. When set to LEGACY, those - // APIs return a UserNotFoundException exception if the user doesn't exist in the - // user pool. Valid values include: - // - // * ENABLED - This prevents user - // existence-related errors. - // - // * LEGACY - This represents the old behavior of Amazon - // Cognito where user existence related errors aren't prevented. + // indicating a code was sent to a simulated destination. When set to LEGACY , + // those APIs return a UserNotFoundException exception if the user doesn't exist + // in the user pool. Valid values include: + // - ENABLED - This prevents user existence-related errors. + // - LEGACY - This represents the old behavior of Amazon Cognito where user + // existence related errors aren't prevented. PreventUserExistenceErrors PreventUserExistenceErrorTypes // The Read-only attributes. @@ -1627,19 +1524,20 @@ type UserPoolClientType struct { // The refresh token time limit. After this limit expires, your user can't use // their refresh token. To specify the time unit for RefreshTokenValidity as - // seconds, minutes, hours, or days, set a TokenValidityUnits value in your API - // request. For example, when you set RefreshTokenValidity as 10 and - // TokenValidityUnits as days, your user can refresh their session and retrieve new - // access and ID tokens for 10 days. The default time unit for RefreshTokenValidity - // in an API request is days. You can't set RefreshTokenValidity to 0. If you do, - // Amazon Cognito overrides the value with the default value of 30 days. Valid - // range is displayed below in seconds. If you don't specify otherwise in the - // configuration of your app client, your refresh tokens are valid for 30 days. + // seconds , minutes , hours , or days , set a TokenValidityUnits value in your + // API request. For example, when you set RefreshTokenValidity as 10 and + // TokenValidityUnits as days , your user can refresh their session and retrieve + // new access and ID tokens for 10 days. The default time unit for + // RefreshTokenValidity in an API request is days. You can't set + // RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with + // the default value of 30 days. Valid range is displayed below in seconds. If you + // don't specify otherwise in the configuration of your app client, your refresh + // tokens are valid for 30 days. RefreshTokenValidity int32 // A list of provider names for the IdPs that this client supports. The following - // are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and - // the names of your own SAML and OIDC providers. + // are supported: COGNITO , Facebook , Google , SignInWithApple , LoginWithAmazon , + // and the names of your own SAML and OIDC providers. SupportedIdentityProviders []string // The time units used to specify the token validity times of each token type: ID, @@ -1691,9 +1589,9 @@ type UserPoolPolicyType struct { // A container for information about the user pool. type UserPoolType struct { - // The available verified method a user can use to recover their password when they - // call ForgotPassword. You can use this setting to define a preferred method when - // a user has more than one method available. With this setting, SMS doesn't + // The available verified method a user can use to recover their password when + // they call ForgotPassword . You can use this setting to define a preferred method + // when a user has more than one method available. With this setting, SMS doesn't // qualify for a valid password recovery mechanism if the user also has SMS // multi-factor authentication (MFA) activated. In the absence of this setting, // Amazon Cognito uses the legacy behavior to determine the recovery method where @@ -1717,10 +1615,10 @@ type UserPoolType struct { // A custom domain name that you provide to Amazon Cognito. This parameter applies // only if you use a custom domain to host the sign-up and sign-in pages for your - // application. An example of a custom domain name might be auth.example.com. For + // application. An example of a custom domain name might be auth.example.com . For // more information about adding a custom domain to your user pool, see Using Your - // Own Domain for the Hosted UI - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html). + // Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html) + // . CustomDomain *string // When active, DeletionProtection prevents accidental deletion of your user pool. @@ -1750,12 +1648,12 @@ type UserPoolType struct { // problems with user pool email configuration. EmailConfigurationFailure *string - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationMessage *string - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . EmailVerificationSubject *string // A number estimating the size of the user pool. @@ -1771,16 +1669,11 @@ type UserPoolType struct { LastModifiedDate *time.Time // Can be one of the following values: - // - // * OFF - MFA tokens aren't required and - // can't be specified during user registration. - // - // * ON - MFA tokens are required for - // all user registrations. You can only specify required when you're initially - // creating a user pool. - // - // * OPTIONAL - Users have the option when registering to - // create an MFA token. + // - OFF - MFA tokens aren't required and can't be specified during user + // registration. + // - ON - MFA tokens are required for all user registrations. You can only + // specify required when you're initially creating a user pool. + // - OPTIONAL - Users have the option when registering to create an MFA token. MfaConfiguration UserPoolMfaType // The name of the user pool. @@ -1802,41 +1695,40 @@ type UserPoolType struct { // and Access Management (IAM) role in your Amazon Web Services account. SmsConfiguration *SmsConfigurationType - // The reason why the SMS configuration can't send the messages to your users. This - // message might include comma-separated values to describe why your SMS + // The reason why the SMS configuration can't send the messages to your users. + // This message might include comma-separated values to describe why your SMS // configuration can't send messages to user pool end users. // InvalidSmsRoleAccessPolicyException The Identity and Access Management role that // Amazon Cognito uses to send SMS messages isn't properly configured. For more - // information, see SmsConfigurationType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html). - // SNSSandbox The Amazon Web Services account is in the SNS SMS Sandbox and + // information, see SmsConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html) + // . SNSSandbox The Amazon Web Services account is in the SNS SMS Sandbox and // messages will only reach verified end users. This parameter won’t get populated // with SNSSandbox if the IAM user creating the user pool doesn’t have SNS // permissions. To learn how to move your Amazon Web Services account out of the - // sandbox, see Moving out of the SMS sandbox - // (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html). + // sandbox, see Moving out of the SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html) + // . SmsConfigurationFailure *string - // This parameter is no longer used. See VerificationMessageTemplateType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html). + // This parameter is no longer used. See VerificationMessageTemplateType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html) + // . SmsVerificationMessage *string // The status of a user pool. Status StatusType - // The settings for updates to user attributes. These settings include the property - // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon - // Cognito how to handle changes to the value of your users' email address and - // phone number attributes. For more information, see Verifying updates to email - // addresses and phone numbers - // (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). + // The settings for updates to user attributes. These settings include the + // property AttributesRequireVerificationBeforeUpdate , a user-pool setting that + // tells Amazon Cognito how to handle changes to the value of your users' email + // address and phone number attributes. For more information, see Verifying + // updates to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates) + // . UserAttributeUpdateSettings *UserAttributeUpdateSettingsType // The user pool add-ons. UserPoolAddOns *UserPoolAddOnsType - // The tags that are assigned to the user pool. A tag is a label that you can apply - // to user pools to categorize and manage them in different ways, such as by + // The tags that are assigned to the user pool. A tag is a label that you can + // apply to user pools to categorize and manage them in different ways, such as by // purpose, owner, environment, or other criteria. UserPoolTags map[string]string @@ -1845,10 +1737,10 @@ type UserPoolType struct { UsernameAttributes []UsernameAttributeType // Case sensitivity of the username input for the selected sign-in option. For - // example, when case sensitivity is set to False, users can sign in using either + // example, when case sensitivity is set to False , users can sign in using either // "username" or "Username". This configuration is immutable once it has been set. - // For more information, see UsernameConfigurationType - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html). + // For more information, see UsernameConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) + // . UsernameConfiguration *UsernameConfigurationType // The template for verification messages. @@ -1876,27 +1768,16 @@ type UserType struct { UserLastModifiedDate *time.Time // The user status. This can be one of the following: - // - // * UNCONFIRMED - User has - // been created but not confirmed. - // - // * CONFIRMED - User has been confirmed. - // - // * - // EXTERNAL_PROVIDER - User signed in with a third-party IdP. - // - // * ARCHIVED - User is - // no longer active. - // - // * UNKNOWN - User status isn't known. - // - // * RESET_REQUIRED - User - // is confirmed, but the user must request a code and reset their password before - // they can sign in. - // - // * FORCE_CHANGE_PASSWORD - The user is confirmed and the user - // can sign in using a temporary password, but on first sign-in, the user must - // change their password to a new value before doing anything else. + // - UNCONFIRMED - User has been created but not confirmed. + // - CONFIRMED - User has been confirmed. + // - EXTERNAL_PROVIDER - User signed in with a third-party IdP. + // - ARCHIVED - User is no longer active. + // - UNKNOWN - User status isn't known. + // - RESET_REQUIRED - User is confirmed, but the user must request a code and + // reset their password before they can sign in. + // - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in + // using a temporary password, but on first sign-in, the user must change their + // password to a new value before doing anything else. UserStatus UserStatusType // The user name of the user you want to describe. @@ -1911,40 +1792,32 @@ type VerificationMessageTemplateType struct { // The default email option. DefaultEmailOption DefaultEmailOptionType - // The template for email messages that Amazon Cognito sends to your users. You can - // set an EmailMessage template only if the value of EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER. When your EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER, your user pool sends email messages with your own Amazon SES + // The template for email messages that Amazon Cognito sends to your users. You + // can set an EmailMessage template only if the value of EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER . When your EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. EmailMessage *string // The email message template for sending a confirmation link to the user. You can - // set an EmailMessageByLink template only if the value of EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER. When your EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER, your user pool sends email messages with your own Amazon SES + // set an EmailMessageByLink template only if the value of EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER . When your EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. EmailMessageByLink *string // The subject line for the email message template. You can set an EmailSubject - // template only if the value of EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER. When your EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER, your user pool sends email messages with your own Amazon SES + // template only if the value of EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER . When your EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. EmailSubject *string // The subject line for the email message template for sending a confirmation link // to the user. You can set an EmailSubjectByLink template only if the value of - // EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER. When your EmailSendingAccount - // (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) - // is DEVELOPER, your user pool sends email messages with your own Amazon SES + // EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER . When your EmailSendingAccount (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) + // is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. EmailSubjectByLink *string diff --git a/service/cognitosync/api_client.go b/service/cognitosync/api_client.go index 8298445de99..696dfd9ddb9 100644 --- a/service/cognitosync/api_client.go +++ b/service/cognitosync/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/cognitosync/api_op_BulkPublish.go b/service/cognitosync/api_op_BulkPublish.go index adf1b030abb..b6159557ae8 100644 --- a/service/cognitosync/api_op_BulkPublish.go +++ b/service/cognitosync/api_op_BulkPublish.go @@ -34,8 +34,9 @@ func (c *Client) BulkPublish(ctx context.Context, params *BulkPublishInput, optF // The input for the BulkPublish operation. type BulkPublishInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string @@ -46,8 +47,9 @@ type BulkPublishInput struct { // The output for the BulkPublish operation. type BulkPublishOutput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityPoolId *string // Metadata pertaining to the operation's result. diff --git a/service/cognitosync/api_op_DeleteDataset.go b/service/cognitosync/api_op_DeleteDataset.go index f37a43725e2..aa46c8bd034 100644 --- a/service/cognitosync/api_op_DeleteDataset.go +++ b/service/cognitosync/api_op_DeleteDataset.go @@ -40,14 +40,16 @@ type DeleteDatasetInput struct { // This member is required. DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_DescribeDataset.go b/service/cognitosync/api_op_DescribeDataset.go index 38f3e8e90ba..aeb6bae404b 100644 --- a/service/cognitosync/api_op_DescribeDataset.go +++ b/service/cognitosync/api_op_DescribeDataset.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets meta data about a dataset by identity and dataset name. With Amazon Cognito -// Sync, each identity has access only to its own data. Thus, the credentials used -// to make this API call need to have access to the identity data. This API can be -// called with temporary user credentials provided by Cognito Identity or with -// developer credentials. You should use Cognito Identity credentials to make this -// API call. +// Gets meta data about a dataset by identity and dataset name. With Amazon +// Cognito Sync, each identity has access only to its own data. Thus, the +// credentials used to make this API call need to have access to the identity data. +// This API can be called with temporary user credentials provided by Cognito +// Identity or with developer credentials. You should use Cognito Identity +// credentials to make this API call. func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} @@ -32,8 +32,8 @@ func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInp return out, nil } -// A request for meta data about a dataset (creation date, number of records, size) -// by owner and dataset name. +// A request for meta data about a dataset (creation date, number of records, +// size) by owner and dataset name. type DescribeDatasetInput struct { // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' @@ -42,14 +42,16 @@ type DescribeDatasetInput struct { // This member is required. DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_DescribeIdentityPoolUsage.go b/service/cognitosync/api_op_DescribeIdentityPoolUsage.go index a8574dab709..5c9a48131e2 100644 --- a/service/cognitosync/api_op_DescribeIdentityPoolUsage.go +++ b/service/cognitosync/api_op_DescribeIdentityPoolUsage.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets usage details (for example, data storage) about a particular identity pool. -// This API can only be called with developer credentials. You cannot call this API -// with the temporary user credentials provided by Cognito Identity. +// Gets usage details (for example, data storage) about a particular identity +// pool. This API can only be called with developer credentials. You cannot call +// this API with the temporary user credentials provided by Cognito Identity. // DescribeIdentityPoolUsage The following examples have been edited for // readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // 8dc0e749-c8cd-48bd-8520-da6be00d528b X-AMZ-TARGET: @@ -49,8 +49,9 @@ func (c *Client) DescribeIdentityPoolUsage(ctx context.Context, params *Describe // A request for usage information about the identity pool. type DescribeIdentityPoolUsageInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_DescribeIdentityUsage.go b/service/cognitosync/api_op_DescribeIdentityUsage.go index ec9a9f4706d..243882e7e09 100644 --- a/service/cognitosync/api_op_DescribeIdentityUsage.go +++ b/service/cognitosync/api_op_DescribeIdentityUsage.go @@ -50,14 +50,16 @@ func (c *Client) DescribeIdentityUsage(ctx context.Context, params *DescribeIden // A request for information about the usage of an identity pool. type DescribeIdentityUsageInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_GetBulkPublishDetails.go b/service/cognitosync/api_op_GetBulkPublishDetails.go index c3edaa55975..7c8469f35c6 100644 --- a/service/cognitosync/api_op_GetBulkPublishDetails.go +++ b/service/cognitosync/api_op_GetBulkPublishDetails.go @@ -33,8 +33,9 @@ func (c *Client) GetBulkPublishDetails(ctx context.Context, params *GetBulkPubli // The input for the GetBulkPublishDetails operation. type GetBulkPublishDetailsInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string @@ -63,8 +64,9 @@ type GetBulkPublishDetailsOutput struct { // caused the bulk publish to fail. FailureMessage *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityPoolId *string // Metadata pertaining to the operation's result. diff --git a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go index 512e7d423aa..0dca283a7a7 100644 --- a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go @@ -48,9 +48,9 @@ func (c *Client) GetIdentityPoolConfiguration(ctx context.Context, params *GetId // The input for the GetIdentityPoolConfiguration operation. type GetIdentityPoolConfigurationInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. This is the ID of the pool for which to return a - // configuration. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This + // is the ID of the pool for which to return a configuration. // // This member is required. IdentityPoolId *string @@ -64,8 +64,8 @@ type GetIdentityPoolConfigurationOutput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *types.CognitoStreams - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. IdentityPoolId *string // Options to apply to this identity pool for push synchronization. diff --git a/service/cognitosync/api_op_ListDatasets.go b/service/cognitosync/api_op_ListDatasets.go index feaf5678c98..14993ff08fe 100644 --- a/service/cognitosync/api_op_ListDatasets.go +++ b/service/cognitosync/api_op_ListDatasets.go @@ -52,14 +52,16 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op // Request for a list of datasets for an identity. type ListDatasetsInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_ListIdentityPoolUsage.go b/service/cognitosync/api_op_ListIdentityPoolUsage.go index bd5103126a8..7b4d3f15982 100644 --- a/service/cognitosync/api_op_ListIdentityPoolUsage.go +++ b/service/cognitosync/api_op_ListIdentityPoolUsage.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can -// only be called with developer credentials. You cannot make this API call with -// the temporary user credentials provided by Cognito Identity. +// Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage +// can only be called with developer credentials. You cannot make this API call +// with the temporary user credentials provided by Cognito Identity. // ListIdentityPoolUsage The following examples have been edited for readability. // POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 X-AMZ-TARGET: diff --git a/service/cognitosync/api_op_ListRecords.go b/service/cognitosync/api_op_ListRecords.go index 200c16c8f4d..59d6ecc2d82 100644 --- a/service/cognitosync/api_op_ListRecords.go +++ b/service/cognitosync/api_op_ListRecords.go @@ -59,14 +59,16 @@ type ListRecordsInput struct { // This member is required. DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_RegisterDevice.go b/service/cognitosync/api_op_RegisterDevice.go index 21fce2bf50d..f75335199d1 100644 --- a/service/cognitosync/api_op_RegisterDevice.go +++ b/service/cognitosync/api_op_RegisterDevice.go @@ -51,9 +51,9 @@ type RegisterDeviceInput struct { // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. Here, the ID of the pool that the identity belongs - // to. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, + // the ID of the pool that the identity belongs to. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go index 0c1906b3339..1a5ad7ffce8 100644 --- a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go @@ -50,8 +50,9 @@ func (c *Client) SetIdentityPoolConfiguration(ctx context.Context, params *SetId // The input for the SetIdentityPoolConfiguration operation. type SetIdentityPoolConfigurationInput struct { - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. This is the ID of the pool to modify. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This + // is the ID of the pool to modify. // // This member is required. IdentityPoolId *string @@ -71,8 +72,8 @@ type SetIdentityPoolConfigurationOutput struct { // Options to apply to this identity pool for Amazon Cognito streams. CognitoStreams *types.CognitoStreams - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. IdentityPoolId *string // Options to apply to this identity pool for push synchronization. diff --git a/service/cognitosync/api_op_SubscribeToDataset.go b/service/cognitosync/api_op_SubscribeToDataset.go index b1431c9213e..5957abcfa67 100644 --- a/service/cognitosync/api_op_SubscribeToDataset.go +++ b/service/cognitosync/api_op_SubscribeToDataset.go @@ -61,8 +61,9 @@ type SubscribeToDatasetInput struct { // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. The ID of the pool to which the identity belongs. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The + // ID of the pool to which the identity belongs. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_UnsubscribeFromDataset.go b/service/cognitosync/api_op_UnsubscribeFromDataset.go index e22b282683a..580a842a204 100644 --- a/service/cognitosync/api_op_UnsubscribeFromDataset.go +++ b/service/cognitosync/api_op_UnsubscribeFromDataset.go @@ -62,8 +62,9 @@ type UnsubscribeFromDatasetInput struct { // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. The ID of the pool to which this identity belongs. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The + // ID of the pool to which this identity belongs. // // This member is required. IdentityPoolId *string diff --git a/service/cognitosync/api_op_UpdateRecords.go b/service/cognitosync/api_op_UpdateRecords.go index cd12d820d45..aeea85c5c16 100644 --- a/service/cognitosync/api_op_UpdateRecords.go +++ b/service/cognitosync/api_op_UpdateRecords.go @@ -38,8 +38,8 @@ func (c *Client) UpdateRecords(ctx context.Context, params *UpdateRecordsInput, return out, nil } -// A request to post updates to records or add and delete records for a dataset and -// user. +// A request to post updates to records or add and delete records for a dataset +// and user. type UpdateRecordsInput struct { // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' @@ -48,20 +48,22 @@ type UpdateRecordsInput struct { // This member is required. DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. // // This member is required. IdentityPoolId *string - // The SyncSessionToken returned by a previous call to ListRecords for this dataset - // and identity. + // The SyncSessionToken returned by a previous call to ListRecords for this + // dataset and identity. // // This member is required. SyncSessionToken *string diff --git a/service/cognitosync/doc.go b/service/cognitosync/doc.go index f21440fde0d..604029e38ac 100644 --- a/service/cognitosync/doc.go +++ b/service/cognitosync/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package cognitosync provides the API client, operations, and parameter types for -// Amazon Cognito Sync. +// Package cognitosync provides the API client, operations, and parameter types +// for Amazon Cognito Sync. // // Amazon Cognito Sync Amazon Cognito Sync provides an AWS service and client // library that enable cross-device syncing of application-related user data. @@ -14,12 +14,10 @@ // identity. With Amazon Cognito Sync, the data stored for each identity is // accessible only to credentials assigned to that identity. In order to use the // Cognito Sync service, you need to make API calls using credentials retrieved -// with Amazon Cognito Identity service -// (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html). -// If you want to use Cognito Sync in an Android or iOS application, you will +// with Amazon Cognito Identity service (http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html) +// . If you want to use Cognito Sync in an Android or iOS application, you will // probably want to make API calls via the AWS Mobile SDK. To learn more, see the -// Developer Guide for Android -// (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html) -// and the Developer Guide for iOS -// (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html). +// Developer Guide for Android (http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html) +// and the Developer Guide for iOS (http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html) +// . package cognitosync diff --git a/service/cognitosync/types/enums.go b/service/cognitosync/types/enums.go index 3329e8edb4c..00cd12a2878 100644 --- a/service/cognitosync/types/enums.go +++ b/service/cognitosync/types/enums.go @@ -32,9 +32,9 @@ const ( OperationRemove Operation = "remove" ) -// Values returns all known values for Operation. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operation. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operation) Values() []Operation { return []Operation{ "replace", diff --git a/service/cognitosync/types/errors.go b/service/cognitosync/types/errors.go index 0d21e220a32..6add2f02e53 100644 --- a/service/cognitosync/types/errors.go +++ b/service/cognitosync/types/errors.go @@ -270,8 +270,8 @@ func (e *NotAuthorizedException) ErrorCode() string { } func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Thrown if an update can't be applied because the resource was changed by another -// call and this would result in a conflict. +// Thrown if an update can't be applied because the resource was changed by +// another call and this would result in a conflict. type ResourceConflictException struct { Message *string diff --git a/service/cognitosync/types/types.go b/service/cognitosync/types/types.go index b02dbe7a90e..1a5675af84a 100644 --- a/service/cognitosync/types/types.go +++ b/service/cognitosync/types/types.go @@ -10,9 +10,9 @@ import ( // Configuration options for configure Cognito streams. type CognitoStreams struct { - // The ARN of the role Amazon Cognito can assume in order to publish to the stream. - // This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord - // on your Cognito stream. + // The ARN of the role Amazon Cognito can assume in order to publish to the + // stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke + // PutRecord on your Cognito stream. RoleArn *string // The name of the Cognito stream to receive updates. This stream must be in the @@ -44,8 +44,9 @@ type Dataset struct { // (underscore), '-' (dash), and '.' (dot). DatasetName *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityId *string // The device that made the last change to this dataset. @@ -66,8 +67,9 @@ type IdentityPoolUsage struct { // Data storage information for the identity pool. DataStorage *int64 - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityPoolId *string // Date on which the identity pool was last modified. @@ -88,12 +90,14 @@ type IdentityUsage struct { // Number of datasets for the identity. DatasetCount int32 - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityId *string - // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) - // created by Amazon Cognito. GUID generation is unique within a region. + // A name-spaced GUID (for example, + // us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID + // generation is unique within a region. IdentityPoolId *string // Date on which the identity was last modified. diff --git a/service/comprehend/api_client.go b/service/comprehend/api_client.go index 8af57c53ff2..72ee4b69f2d 100644 --- a/service/comprehend/api_client.go +++ b/service/comprehend/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/comprehend/api_op_BatchDetectDominantLanguage.go b/service/comprehend/api_op_BatchDetectDominantLanguage.go index d317716129d..d45a72f4041 100644 --- a/service/comprehend/api_op_BatchDetectDominantLanguage.go +++ b/service/comprehend/api_op_BatchDetectDominantLanguage.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Determines the dominant language of the input text for a batch of documents. For -// a list of languages that Amazon Comprehend can detect, see Amazon Comprehend -// Supported Languages -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html). +// Determines the dominant language of the input text for a batch of documents. +// For a list of languages that Amazon Comprehend can detect, see Amazon +// Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) +// . func (c *Client) BatchDetectDominantLanguage(ctx context.Context, params *BatchDetectDominantLanguageInput, optFns ...func(*Options)) (*BatchDetectDominantLanguageOutput, error) { if params == nil { params = &BatchDetectDominantLanguageInput{} diff --git a/service/comprehend/api_op_BatchDetectEntities.go b/service/comprehend/api_op_BatchDetectEntities.go index 81995ea37ae..56e027132fa 100644 --- a/service/comprehend/api_op_BatchDetectEntities.go +++ b/service/comprehend/api_op_BatchDetectEntities.go @@ -12,9 +12,8 @@ import ( ) // Inspects the text of a batch of documents for named entities and returns -// information about them. For more information about named entities, see Entities -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the -// Comprehend Developer Guide. +// information about them. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) +// in the Comprehend Developer Guide. func (c *Client) BatchDetectEntities(ctx context.Context, params *BatchDetectEntitiesInput, optFns ...func(*Options)) (*BatchDetectEntitiesOutput, error) { if params == nil { params = &BatchDetectEntitiesInput{} diff --git a/service/comprehend/api_op_BatchDetectSentiment.go b/service/comprehend/api_op_BatchDetectSentiment.go index d376c1abed9..62153c8840a 100644 --- a/service/comprehend/api_op_BatchDetectSentiment.go +++ b/service/comprehend/api_op_BatchDetectSentiment.go @@ -12,7 +12,7 @@ import ( ) // Inspects a batch of documents and returns an inference of the prevailing -// sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. +// sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one. func (c *Client) BatchDetectSentiment(ctx context.Context, params *BatchDetectSentimentInput, optFns ...func(*Options)) (*BatchDetectSentimentOutput, error) { if params == nil { params = &BatchDetectSentimentInput{} diff --git a/service/comprehend/api_op_BatchDetectSyntax.go b/service/comprehend/api_op_BatchDetectSyntax.go index 17608da9630..4b1304a6adc 100644 --- a/service/comprehend/api_op_BatchDetectSyntax.go +++ b/service/comprehend/api_op_BatchDetectSyntax.go @@ -13,9 +13,8 @@ import ( // Inspects the text of a batch of documents for the syntax and part of speech of // the words in the document and returns information about them. For more -// information, see Syntax -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the -// Comprehend Developer Guide. +// information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) +// in the Comprehend Developer Guide. func (c *Client) BatchDetectSyntax(ctx context.Context, params *BatchDetectSyntaxInput, optFns ...func(*Options)) (*BatchDetectSyntaxOutput, error) { if params == nil { params = &BatchDetectSyntaxInput{} diff --git a/service/comprehend/api_op_BatchDetectTargetedSentiment.go b/service/comprehend/api_op_BatchDetectTargetedSentiment.go index ccbbdc9edca..dbd203f8be1 100644 --- a/service/comprehend/api_op_BatchDetectTargetedSentiment.go +++ b/service/comprehend/api_op_BatchDetectTargetedSentiment.go @@ -13,8 +13,8 @@ import ( // Inspects a batch of documents and returns a sentiment analysis for each entity // identified in the documents. For more information about targeted sentiment, see -// Targeted sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +// Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) +// . func (c *Client) BatchDetectTargetedSentiment(ctx context.Context, params *BatchDetectTargetedSentimentInput, optFns ...func(*Options)) (*BatchDetectTargetedSentimentOutput, error) { if params == nil { params = &BatchDetectTargetedSentimentInput{} diff --git a/service/comprehend/api_op_ClassifyDocument.go b/service/comprehend/api_op_ClassifyDocument.go index 5a049ff4512..52a6e33fb99 100644 --- a/service/comprehend/api_op_ClassifyDocument.go +++ b/service/comprehend/api_op_ClassifyDocument.go @@ -18,9 +18,8 @@ import ( // the input document, the API response includes an entry in Errors that describes // the errors. If the system detects a document-level error in your input document, // the API returns an InvalidRequestException error response. For details about -// this exception, see Errors in semi-structured documents -// (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in -// the Comprehend Developer Guide. +// this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) +// in the Comprehend Developer Guide. func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentInput, optFns ...func(*Options)) (*ClassifyDocumentOutput, error) { if params == nil { params = &ClassifyDocumentInput{} @@ -39,8 +38,8 @@ func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentI type ClassifyDocumentInput struct { // The Amazon Resource Number (ARN) of the endpoint. For information about - // endpoints, see Managing endpoints - // (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). + // endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) + // . // // This member is required. EndpointArn *string @@ -51,18 +50,17 @@ type ClassifyDocumentInput struct { // base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify // documents, the SDK may encode the document file bytes for you. The maximum // length of this field depends on the input document type. For details, see - // Inputs for real-time custom analysis - // (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) in the - // Comprehend Developer Guide. If you use the Bytes parameter, do not use the Text - // parameter. + // Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // in the Comprehend Developer Guide. If you use the Bytes parameter, do not use + // the Text parameter. Bytes []byte - // Provides configuration parameters to override the default actions for extracting - // text from PDF documents and image files. + // Provides configuration parameters to override the default actions for + // extracting text from PDF documents and image files. DocumentReaderConfig *types.DocumentReaderConfig - // The document text to be analyzed. If you enter text using this parameter, do not - // use the Bytes parameter. + // The document text to be analyzed. If you enter text using this parameter, do + // not use the Bytes parameter. Text *string noSmithyDocumentSerde @@ -76,8 +74,8 @@ type ClassifyDocumentOutput struct { // be a dog or a cat, but not both at the same time. Classes []types.DocumentClass - // Extraction information about the document. This field is present in the response - // only if your request includes the Byte parameter. + // Extraction information about the document. This field is present in the + // response only if your request includes the Byte parameter. DocumentMetadata *types.DocumentMetadata // The document type for each page in the input document. This field is present in diff --git a/service/comprehend/api_op_CreateDataset.go b/service/comprehend/api_op_CreateDataset.go index 81eeb7173d2..a65499d2dd1 100644 --- a/service/comprehend/api_op_CreateDataset.go +++ b/service/comprehend/api_op_CreateDataset.go @@ -13,9 +13,8 @@ import ( ) // Creates a dataset to upload training or test data for a model associated with a -// flywheel. For more information about datasets, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// flywheel. For more information about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -55,8 +54,8 @@ type CreateDatasetInput struct { // Amazon Comprehend generates one. ClientRequestToken *string - // The dataset type. You can specify that the data in a dataset is for training the - // model or for testing the model. + // The dataset type. You can specify that the data in a dataset is for training + // the model or for testing the model. DatasetType types.DatasetType // Description of the dataset. diff --git a/service/comprehend/api_op_CreateDocumentClassifier.go b/service/comprehend/api_op_CreateDocumentClassifier.go index 3e989f690cd..5abd23e4481 100644 --- a/service/comprehend/api_op_CreateDocumentClassifier.go +++ b/service/comprehend/api_op_CreateDocumentClassifier.go @@ -16,8 +16,7 @@ import ( // create a classifier, you provide a set of training documents that labeled with // the categories that you want to use. After the classifier is trained you can use // it to categorize a set of labeled documents into the categories. For more -// information, see Document Classification -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) +// information, see Document Classification (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) // in the Comprehend Developer Guide. func (c *Client) CreateDocumentClassifier(ctx context.Context, params *CreateDocumentClassifierInput, optFns ...func(*Options)) (*CreateDocumentClassifierOutput, error) { if params == nil { @@ -69,15 +68,11 @@ type CreateDocumentClassifierInput struct { // separated by a delimiter. The default delimiter between labels is a pipe (|). Mode types.DocumentClassifierMode - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // The resource-based policy to attach to your custom document classifier model. @@ -102,28 +97,26 @@ type CreateDocumentClassifierInput struct { // sales department. Tags []types.Tag - // The version name given to the newly created classifier. Version names can have a - // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores - // (_) are allowed. The version name must be unique among all models with the same - // classifier name in the Amazon Web Services account/Amazon Web Services Region. + // The version name given to the newly created classifier. Version names can have + // a maximum of 256 characters. Alphanumeric characters, hyphens (-) and + // underscores (_) are allowed. The version name must be unique among all models + // with the same classifier name in the Amazon Web Services account/Amazon Web + // Services Region. VersionName *string // ID for the Amazon Web Services Key Management Service (KMS) key that Amazon // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom classifier. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/comprehend/api_op_CreateEndpoint.go b/service/comprehend/api_op_CreateEndpoint.go index 02beedd378d..9633e415372 100644 --- a/service/comprehend/api_op_CreateEndpoint.go +++ b/service/comprehend/api_op_CreateEndpoint.go @@ -13,8 +13,8 @@ import ( ) // Creates a model-specific endpoint for synchronous inference for a previously -// trained custom model For information about endpoints, see Managing endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// trained custom model For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error) { if params == nil { params = &CreateEndpointInput{} @@ -39,15 +39,15 @@ type CreateEndpointInput struct { // This member is required. DesiredInferenceUnits *int32 - // This is the descriptive suffix that becomes part of the EndpointArn used for all - // subsequent requests to this resource. + // This is the descriptive suffix that becomes part of the EndpointArn used for + // all subsequent requests to this resource. // // This member is required. EndpointName *string // An idempotency token provided by the customer. If this token matches a previous // endpoint creation request, Amazon Comprehend will not return a - // ResourceInUseException. + // ResourceInUseException . ClientRequestToken *string // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend diff --git a/service/comprehend/api_op_CreateEntityRecognizer.go b/service/comprehend/api_op_CreateEntityRecognizer.go index ad3c0d3aa7b..3cfe2718675 100644 --- a/service/comprehend/api_op_CreateEntityRecognizer.go +++ b/service/comprehend/api_op_CreateEntityRecognizer.go @@ -65,22 +65,18 @@ type CreateEntityRecognizerInput struct { // Amazon Comprehend generates one. ClientRequestToken *string - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string - // The JSON resource-based policy to attach to your custom entity recognizer model. - // You can use this policy to allow another Amazon Web Services account to import - // your custom model. Provide your JSON as a UTF-8 encoded string without line - // breaks. To provide valid JSON for your policy, enclose the attribute names and - // values in double quotes. If the JSON body is also enclosed in double quotes, + // The JSON resource-based policy to attach to your custom entity recognizer + // model. You can use this policy to allow another Amazon Web Services account to + // import your custom model. Provide your JSON as a UTF-8 encoded string without + // line breaks. To provide valid JSON for your policy, enclose the attribute names + // and values in double quotes. If the JSON body is also enclosed in double quotes, // then you must escape the double quotes that are inside the policy: // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping // quotes, you can use single quotes to enclose the policy and double quotes to @@ -104,18 +100,15 @@ type CreateEntityRecognizerInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom entity recognizer. For - // more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/comprehend/api_op_CreateFlywheel.go b/service/comprehend/api_op_CreateFlywheel.go index 0b3a41b1211..49a4a0d6170 100644 --- a/service/comprehend/api_op_CreateFlywheel.go +++ b/service/comprehend/api_op_CreateFlywheel.go @@ -22,9 +22,8 @@ import ( // data and test data into the flywheel's data lake. To use the flywheel with a new // model, you need to provide a dataset for training data (and optional test data) // when you create the flywheel. For more information about flywheels, see -// Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) CreateFlywheel(ctx context.Context, params *CreateFlywheelInput, optFns ...func(*Options)) (*CreateFlywheelOutput, error) { if params == nil { params = &CreateFlywheelInput{} @@ -42,8 +41,8 @@ func (c *Client) CreateFlywheel(ctx context.Context, params *CreateFlywheelInput type CreateFlywheelInput struct { - // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the - // permissions required to access the flywheel data in the data lake. + // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend + // the permissions required to access the flywheel data in the data lake. // // This member is required. DataAccessRoleArn *string diff --git a/service/comprehend/api_op_DeleteDocumentClassifier.go b/service/comprehend/api_op_DeleteDocumentClassifier.go index 14280eb556b..17bc005a43a 100644 --- a/service/comprehend/api_op_DeleteDocumentClassifier.go +++ b/service/comprehend/api_op_DeleteDocumentClassifier.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a previously created document classifier Only those classifiers that are -// in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference -// job is using the model, a ResourceInUseException will be returned. This is an -// asynchronous action that puts the classifier into a DELETING state, and it is -// then removed by a background job. Once removed, the classifier disappears from -// your account and is no longer available for use. +// Deletes a previously created document classifier Only those classifiers that +// are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active +// inference job is using the model, a ResourceInUseException will be returned. +// This is an asynchronous action that puts the classifier into a DELETING state, +// and it is then removed by a background job. Once removed, the classifier +// disappears from your account and is no longer available for use. func (c *Client) DeleteDocumentClassifier(ctx context.Context, params *DeleteDocumentClassifierInput, optFns ...func(*Options)) (*DeleteDocumentClassifierOutput, error) { if params == nil { params = &DeleteDocumentClassifierInput{} diff --git a/service/comprehend/api_op_DeleteEndpoint.go b/service/comprehend/api_op_DeleteEndpoint.go index 0f39e0762a0..6cb41609140 100644 --- a/service/comprehend/api_op_DeleteEndpoint.go +++ b/service/comprehend/api_op_DeleteEndpoint.go @@ -12,8 +12,8 @@ import ( // Deletes a model-specific endpoint for a previously-trained custom model. All // endpoints must be deleted in order for the model to be deleted. For information -// about endpoints, see Managing endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { params = &DeleteEndpointInput{} diff --git a/service/comprehend/api_op_DeleteFlywheel.go b/service/comprehend/api_op_DeleteFlywheel.go index 8a94502328b..51bcecf3691 100644 --- a/service/comprehend/api_op_DeleteFlywheel.go +++ b/service/comprehend/api_op_DeleteFlywheel.go @@ -12,9 +12,8 @@ import ( // Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not // delete the data lake or the model associated with the flywheel. For more -// information about flywheels, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) DeleteFlywheel(ctx context.Context, params *DeleteFlywheelInput, optFns ...func(*Options)) (*DeleteFlywheelOutput, error) { if params == nil { params = &DeleteFlywheelInput{} diff --git a/service/comprehend/api_op_DescribeDataset.go b/service/comprehend/api_op_DescribeDataset.go index 9c1c0f737c4..1dd7af809d5 100644 --- a/service/comprehend/api_op_DescribeDataset.go +++ b/service/comprehend/api_op_DescribeDataset.go @@ -12,9 +12,8 @@ import ( ) // Returns information about the dataset that you specify. For more information -// about datasets, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} diff --git a/service/comprehend/api_op_DescribeDocumentClassificationJob.go b/service/comprehend/api_op_DescribeDocumentClassificationJob.go index 45d1557d9af..bbd065b1d9f 100644 --- a/service/comprehend/api_op_DescribeDocumentClassificationJob.go +++ b/service/comprehend/api_op_DescribeDocumentClassificationJob.go @@ -31,8 +31,7 @@ func (c *Client) DescribeDocumentClassificationJob(ctx context.Context, params * type DescribeDocumentClassificationJobInput struct { // The identifier that Amazon Comprehend generated for the job. The - // StartDocumentClassificationJob operation returns this identifier in its - // response. + // StartDocumentClassificationJob operation returns this identifier in its response. // // This member is required. JobId *string diff --git a/service/comprehend/api_op_DescribeEndpoint.go b/service/comprehend/api_op_DescribeEndpoint.go index bc1eab20c68..cc5c1179107 100644 --- a/service/comprehend/api_op_DescribeEndpoint.go +++ b/service/comprehend/api_op_DescribeEndpoint.go @@ -13,8 +13,8 @@ import ( // Gets the properties associated with a specific endpoint. Use this operation to // get the status of an endpoint. For information about endpoints, see Managing -// endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error) { if params == nil { params = &DescribeEndpointInput{} diff --git a/service/comprehend/api_op_DescribeFlywheel.go b/service/comprehend/api_op_DescribeFlywheel.go index 01bde46c5b7..bc12a0064b4 100644 --- a/service/comprehend/api_op_DescribeFlywheel.go +++ b/service/comprehend/api_op_DescribeFlywheel.go @@ -12,9 +12,8 @@ import ( ) // Provides configuration information about the flywheel. For more information -// about flywheels, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) DescribeFlywheel(ctx context.Context, params *DescribeFlywheelInput, optFns ...func(*Options)) (*DescribeFlywheelOutput, error) { if params == nil { params = &DescribeFlywheelInput{} diff --git a/service/comprehend/api_op_DescribeFlywheelIteration.go b/service/comprehend/api_op_DescribeFlywheelIteration.go index c77b052e987..a1be317f9a7 100644 --- a/service/comprehend/api_op_DescribeFlywheelIteration.go +++ b/service/comprehend/api_op_DescribeFlywheelIteration.go @@ -12,9 +12,8 @@ import ( ) // Retrieve the configuration properties of a flywheel iteration. For more -// information about flywheels, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) DescribeFlywheelIteration(ctx context.Context, params *DescribeFlywheelIterationInput, optFns ...func(*Options)) (*DescribeFlywheelIterationOutput, error) { if params == nil { params = &DescribeFlywheelIterationInput{} diff --git a/service/comprehend/api_op_DescribeResourcePolicy.go b/service/comprehend/api_op_DescribeResourcePolicy.go index 2204a4df43c..0ed1ecf97c9 100644 --- a/service/comprehend/api_op_DescribeResourcePolicy.go +++ b/service/comprehend/api_op_DescribeResourcePolicy.go @@ -30,8 +30,8 @@ func (c *Client) DescribeResourcePolicy(ctx context.Context, params *DescribeRes type DescribeResourcePolicyInput struct { - // The Amazon Resource Name (ARN) of the custom model version that has the resource - // policy. + // The Amazon Resource Name (ARN) of the custom model version that has the + // resource policy. // // This member is required. ResourceArn *string diff --git a/service/comprehend/api_op_DescribeTargetedSentimentDetectionJob.go b/service/comprehend/api_op_DescribeTargetedSentimentDetectionJob.go index 481e6a5a029..ac3a5e0d300 100644 --- a/service/comprehend/api_op_DescribeTargetedSentimentDetectionJob.go +++ b/service/comprehend/api_op_DescribeTargetedSentimentDetectionJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the properties associated with a targeted sentiment detection job. Use this -// operation to get the status of the job. +// Gets the properties associated with a targeted sentiment detection job. Use +// this operation to get the status of the job. func (c *Client) DescribeTargetedSentimentDetectionJob(ctx context.Context, params *DescribeTargetedSentimentDetectionJobInput, optFns ...func(*Options)) (*DescribeTargetedSentimentDetectionJobOutput, error) { if params == nil { params = &DescribeTargetedSentimentDetectionJobInput{} diff --git a/service/comprehend/api_op_DescribeTopicsDetectionJob.go b/service/comprehend/api_op_DescribeTopicsDetectionJob.go index b88812bb876..ae44bc7aa46 100644 --- a/service/comprehend/api_op_DescribeTopicsDetectionJob.go +++ b/service/comprehend/api_op_DescribeTopicsDetectionJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the properties associated with a topic detection job. Use this operation to -// get the status of a detection job. +// Gets the properties associated with a topic detection job. Use this operation +// to get the status of a detection job. func (c *Client) DescribeTopicsDetectionJob(ctx context.Context, params *DescribeTopicsDetectionJobInput, optFns ...func(*Options)) (*DescribeTopicsDetectionJobOutput, error) { if params == nil { params = &DescribeTopicsDetectionJobInput{} diff --git a/service/comprehend/api_op_DetectDominantLanguage.go b/service/comprehend/api_op_DetectDominantLanguage.go index 79e822d126a..15a02a2ea64 100644 --- a/service/comprehend/api_op_DetectDominantLanguage.go +++ b/service/comprehend/api_op_DetectDominantLanguage.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Determines the dominant language of the input text. For a list of languages that -// Amazon Comprehend can detect, see Amazon Comprehend Supported Languages -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html). +// Determines the dominant language of the input text. For a list of languages +// that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) +// . func (c *Client) DetectDominantLanguage(ctx context.Context, params *DetectDominantLanguageInput, optFns ...func(*Options)) (*DetectDominantLanguageOutput, error) { if params == nil { params = &DetectDominantLanguageInput{} @@ -31,8 +31,8 @@ func (c *Client) DetectDominantLanguage(ctx context.Context, params *DetectDomin type DetectDominantLanguageInput struct { - // A UTF-8 text string. The string must contain at least 20 characters. The maximum - // string size is 100 KB. + // A UTF-8 text string. The string must contain at least 20 characters. The + // maximum string size is 100 KB. // // This member is required. Text *string diff --git a/service/comprehend/api_op_DetectEntities.go b/service/comprehend/api_op_DetectEntities.go index 19993079b52..6601aa3a4d1 100644 --- a/service/comprehend/api_op_DetectEntities.go +++ b/service/comprehend/api_op_DetectEntities.go @@ -11,20 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detects named entities in input text when you use the pre-trained model. Detects -// custom entities if you have a custom entity recognition model. When detecting -// named entities using the pre-trained model, use plain text as the input. For -// more information about named entities, see Entities -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the -// Comprehend Developer Guide. When you use a custom entity recognition model, you -// can input plain text or you can upload a single-page input document (text, PDF, -// Word, or image). If the system detects errors while processing a page in the -// input document, the API response includes an entry in Errors for each error. If -// the system detects a document-level error in your input document, the API -// returns an InvalidRequestException error response. For details about this -// exception, see Errors in semi-structured documents -// (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in -// the Comprehend Developer Guide. +// Detects named entities in input text when you use the pre-trained model. +// Detects custom entities if you have a custom entity recognition model. When +// detecting named entities using the pre-trained model, use plain text as the +// input. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) +// in the Comprehend Developer Guide. When you use a custom entity recognition +// model, you can input plain text or you can upload a single-page input document +// (text, PDF, Word, or image). If the system detects errors while processing a +// page in the input document, the API response includes an entry in Errors for +// each error. If the system detects a document-level error in your input document, +// the API returns an InvalidRequestException error response. For details about +// this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) +// in the Comprehend Developer Guide. func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput, optFns ...func(*Options)) (*DetectEntitiesOutput, error) { if params == nil { params = &DetectEntitiesInput{} @@ -44,21 +42,21 @@ type DetectEntitiesInput struct { // This field applies only when you use a custom entity recognition model that was // trained with PDF annotations. For other cases, enter your text input in the Text - // field. Use the Bytes parameter to input a text, PDF, Word or image file. Using a - // plain-text file in the Bytes parameter is equivelent to using the Text parameter - // (the Entities field in the response is identical). You can also use the Bytes - // parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument - // output file. Provide the input document as a sequence of base64-encoded bytes. - // If your code uses an Amazon Web Services SDK to detect entities, the SDK may - // encode the document file bytes for you. The maximum length of this field depends - // on the input document type. For details, see Inputs for real-time custom - // analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) + // field. Use the Bytes parameter to input a text, PDF, Word or image file. Using + // a plain-text file in the Bytes parameter is equivelent to using the Text + // parameter (the Entities field in the response is identical). You can also use + // the Bytes parameter to input an Amazon Textract DetectDocumentText or + // AnalyzeDocument output file. Provide the input document as a sequence of + // base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect + // entities, the SDK may encode the document file bytes for you. The maximum length + // of this field depends on the input document type. For details, see Inputs for + // real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) // in the Comprehend Developer Guide. If you use the Bytes parameter, do not use // the Text parameter. Bytes []byte - // Provides configuration parameters to override the default actions for extracting - // text from PDF documents and image files. + // Provides configuration parameters to override the default actions for + // extracting text from PDF documents and image files. DocumentReaderConfig *types.DocumentReaderConfig // The Amazon Resource Name of an endpoint that is associated with a custom entity @@ -66,8 +64,8 @@ type DetectEntitiesInput struct { // your own custom model instead of the default model that is used by Amazon // Comprehend. If you specify an endpoint, Amazon Comprehend uses the language of // your custom model, and it ignores any language code that you provide in your - // request. For information about endpoints, see Managing endpoints - // (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). + // request. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) + // . EndpointArn *string // The language of the input documents. You can specify any of the primary @@ -86,15 +84,15 @@ type DetectEntitiesInput struct { type DetectEntitiesOutput struct { - // Information about each block of text in the input document. Blocks are nested. A - // page block contains a block for each line of text, which contains a block for + // Information about each block of text in the input document. Blocks are nested. + // A page block contains a block for each line of text, which contains a block for // each word. The Block content for a Word input document does not include a // Geometry field. The Block field is not present in the response for plain-text // inputs. Blocks []types.Block - // Information about the document, discovered during text extraction. This field is - // present in the response only if your request used the Byte parameter. + // Information about the document, discovered during text extraction. This field + // is present in the response only if your request used the Byte parameter. DocumentMetadata *types.DocumentMetadata // The document type for each page in the input document. This field is present in diff --git a/service/comprehend/api_op_DetectKeyPhrases.go b/service/comprehend/api_op_DetectKeyPhrases.go index ac5500ac0cc..4022aebf35a 100644 --- a/service/comprehend/api_op_DetectKeyPhrases.go +++ b/service/comprehend/api_op_DetectKeyPhrases.go @@ -47,10 +47,10 @@ type DetectKeyPhrasesInput struct { type DetectKeyPhrasesOutput struct { - // A collection of key phrases that Amazon Comprehend identified in the input text. - // For each key phrase, the response provides the text of the key phrase, where the - // key phrase begins and ends, and the level of confidence that Amazon Comprehend - // has in the accuracy of the detection. + // A collection of key phrases that Amazon Comprehend identified in the input + // text. For each key phrase, the response provides the text of the key phrase, + // where the key phrase begins and ends, and the level of confidence that Amazon + // Comprehend has in the accuracy of the detection. KeyPhrases []types.KeyPhrase // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_DetectSentiment.go b/service/comprehend/api_op_DetectSentiment.go index 1f680544751..550bff5f5c2 100644 --- a/service/comprehend/api_op_DetectSentiment.go +++ b/service/comprehend/api_op_DetectSentiment.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Inspects text and returns an inference of the prevailing sentiment (POSITIVE, -// NEUTRAL, MIXED, or NEGATIVE). +// Inspects text and returns an inference of the prevailing sentiment ( POSITIVE , +// NEUTRAL , MIXED , or NEGATIVE ). func (c *Client) DetectSentiment(ctx context.Context, params *DetectSentimentInput, optFns ...func(*Options)) (*DetectSentimentOutput, error) { if params == nil { params = &DetectSentimentInput{} diff --git a/service/comprehend/api_op_DetectSyntax.go b/service/comprehend/api_op_DetectSyntax.go index 27ec4ea70b6..c806248f8aa 100644 --- a/service/comprehend/api_op_DetectSyntax.go +++ b/service/comprehend/api_op_DetectSyntax.go @@ -12,9 +12,8 @@ import ( ) // Inspects text for syntax and the part of speech of words in the document. For -// more information, see Syntax -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the -// Comprehend Developer Guide. +// more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) +// in the Comprehend Developer Guide. func (c *Client) DetectSyntax(ctx context.Context, params *DetectSyntaxInput, optFns ...func(*Options)) (*DetectSyntaxOutput, error) { if params == nil { params = &DetectSyntaxInput{} @@ -52,9 +51,8 @@ type DetectSyntaxOutput struct { // A collection of syntax tokens describing the text. For each token, the response // provides the text, the token type, where the text begins and ends, and the level // of confidence that Amazon Comprehend has that the token is correct. For a list - // of token types, see Syntax - // (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the - // Comprehend Developer Guide. + // of token types, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) + // in the Comprehend Developer Guide. SyntaxTokens []types.SyntaxToken // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_DetectTargetedSentiment.go b/service/comprehend/api_op_DetectTargetedSentiment.go index e85a82d7c73..a0dfb6d01bc 100644 --- a/service/comprehend/api_op_DetectTargetedSentiment.go +++ b/service/comprehend/api_op_DetectTargetedSentiment.go @@ -13,8 +13,8 @@ import ( // Inspects the input text and returns a sentiment analysis for each entity // identified in the text. For more information about targeted sentiment, see -// Targeted sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +// Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) +// . func (c *Client) DetectTargetedSentiment(ctx context.Context, params *DetectTargetedSentimentInput, optFns ...func(*Options)) (*DetectTargetedSentimentOutput, error) { if params == nil { params = &DetectTargetedSentimentInput{} diff --git a/service/comprehend/api_op_ImportModel.go b/service/comprehend/api_op_ImportModel.go index 96ebf61aba9..85e911e4221 100644 --- a/service/comprehend/api_op_ImportModel.go +++ b/service/comprehend/api_op_ImportModel.go @@ -44,23 +44,19 @@ type ImportModelInput struct { // custom model. DataAccessRoleArn *string - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // The name to assign to the custom model that is created in Amazon Comprehend by // this import. ModelName *string - // Tags to associate with the custom model that is created by this import. A tag is - // a key-value pair that adds as a metadata to a resource used by Amazon + // Tags to associate with the custom model that is created by this import. A tag + // is a key-value pair that adds as a metadata to a resource used by Amazon // Comprehend. For example, a tag with "Sales" as the key might be added to a // resource to indicate its use by the sales department. Tags []types.Tag diff --git a/service/comprehend/api_op_ListDatasets.go b/service/comprehend/api_op_ListDatasets.go index 8e06301520e..026650244a6 100644 --- a/service/comprehend/api_op_ListDatasets.go +++ b/service/comprehend/api_op_ListDatasets.go @@ -13,9 +13,8 @@ import ( ) // List the datasets that you have configured in this Region. For more information -// about datasets, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error) { if params == nil { params = &ListDatasetsInput{} diff --git a/service/comprehend/api_op_ListEndpoints.go b/service/comprehend/api_op_ListEndpoints.go index 450f91f0015..828a9907250 100644 --- a/service/comprehend/api_op_ListEndpoints.go +++ b/service/comprehend/api_op_ListEndpoints.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of all existing endpoints that you've created. For information about -// endpoints, see Managing endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// Gets a list of all existing endpoints that you've created. For information +// about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error) { if params == nil { params = &ListEndpointsInput{} @@ -32,9 +32,9 @@ func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, type ListEndpointsInput struct { - // Filters the endpoints that are returned. You can filter endpoints on their name, - // model, status, or the date and time that they were created. You can only set one - // filter at a time. + // Filters the endpoints that are returned. You can filter endpoints on their + // name, model, status, or the date and time that they were created. You can only + // set one filter at a time. Filter *types.EndpointFilter // The maximum number of results to return in each page. The default is 100. diff --git a/service/comprehend/api_op_ListEntityRecognizers.go b/service/comprehend/api_op_ListEntityRecognizers.go index 99630072311..11a3e9025fc 100644 --- a/service/comprehend/api_op_ListEntityRecognizers.go +++ b/service/comprehend/api_op_ListEntityRecognizers.go @@ -35,8 +35,8 @@ func (c *Client) ListEntityRecognizers(ctx context.Context, params *ListEntityRe type ListEntityRecognizersInput struct { - // Filters the list of entities returned. You can filter on Status, - // SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time. + // Filters the list of entities returned. You can filter on Status , + // SubmitTimeBefore , or SubmitTimeAfter . You can only set one filter at a time. Filter *types.EntityRecognizerFilter // The maximum number of results to return on each page. The default is 100. diff --git a/service/comprehend/api_op_ListFlywheelIterationHistory.go b/service/comprehend/api_op_ListFlywheelIterationHistory.go index fee47fbc892..252236ae286 100644 --- a/service/comprehend/api_op_ListFlywheelIterationHistory.go +++ b/service/comprehend/api_op_ListFlywheelIterationHistory.go @@ -13,9 +13,8 @@ import ( ) // Information about the history of a flywheel iteration. For more information -// about flywheels, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) ListFlywheelIterationHistory(ctx context.Context, params *ListFlywheelIterationHistoryInput, optFns ...func(*Options)) (*ListFlywheelIterationHistoryOutput, error) { if params == nil { params = &ListFlywheelIterationHistoryInput{} diff --git a/service/comprehend/api_op_PutResourcePolicy.go b/service/comprehend/api_op_PutResourcePolicy.go index 36b7778a2b6..85d9a4fa9a2 100644 --- a/service/comprehend/api_op_PutResourcePolicy.go +++ b/service/comprehend/api_op_PutResourcePolicy.go @@ -35,11 +35,11 @@ type PutResourcePolicyInput struct { // This member is required. ResourceArn *string - // The JSON resource-based policy to attach to your custom model. Provide your JSON - // as a UTF-8 encoded string without line breaks. To provide valid JSON for your - // policy, enclose the attribute names and values in double quotes. If the JSON - // body is also enclosed in double quotes, then you must escape the double quotes - // that are inside the policy: "{\"attribute\": \"value\", \"attribute\": + // The JSON resource-based policy to attach to your custom model. Provide your + // JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for + // your policy, enclose the attribute names and values in double quotes. If the + // JSON body is also enclosed in double quotes, then you must escape the double + // quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": // [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the // policy and double quotes to enclose the JSON names and values: '{"attribute": // "value", "attribute": ["value"]}' diff --git a/service/comprehend/api_op_StartDocumentClassificationJob.go b/service/comprehend/api_op_StartDocumentClassificationJob.go index 2a936333b01..cfea29ed3f5 100644 --- a/service/comprehend/api_op_StartDocumentClassificationJob.go +++ b/service/comprehend/api_op_StartDocumentClassificationJob.go @@ -47,8 +47,8 @@ type StartDocumentClassificationJobInput struct { // This member is required. OutputDataConfig *types.OutputDataConfig - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Comprehend generates one. ClientRequestToken *string // The Amazon Resource Name (ARN) of the document classifier to use to process the @@ -72,18 +72,15 @@ type StartDocumentClassificationJobInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your document classification job. For - // more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -107,24 +104,14 @@ type StartDocumentClassificationJobOutput struct { JobId *string // The status of the job: - // - // * SUBMITTED - The job has been received and queued for - // processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. For details, use the - // DescribeDocumentClassificationJob operation. - // - // * STOP_REQUESTED - Amazon - // Comprehend has received a stop request for the job and is processing the - // request. - // - // * STOPPED - The job was successfully stopped without completing. + // - SUBMITTED - The job has been received and queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. For details, use the + // DescribeDocumentClassificationJob operation. + // - STOP_REQUESTED - Amazon Comprehend has received a stop request for the job + // and is processing the request. + // - STOPPED - The job was successfully stopped without completing. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go index b56353dade8..5524bbb3320 100644 --- a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go @@ -32,8 +32,8 @@ func (c *Client) StartDominantLanguageDetectionJob(ctx context.Context, params * type StartDominantLanguageDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -48,35 +48,32 @@ type StartDominantLanguageDetectionJobInput struct { // This member is required. OutputDataConfig *types.OutputDataConfig - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Comprehend generates one. ClientRequestToken *string // An identifier for the job. JobName *string - // Tags to associate with the dominant language detection job. A tag is a key-value - // pair that adds metadata to a resource used by Amazon Comprehend. For example, a - // tag with "Sales" as the key might be added to a resource to indicate its use by - // the sales department. + // Tags to associate with the dominant language detection job. A tag is a + // key-value pair that adds metadata to a resource used by Amazon Comprehend. For + // example, a tag with "Sales" as the key might be added to a resource to indicate + // its use by the sales department. Tags []types.Tag // ID for the Amazon Web Services Key Management Service (KMS) key that Amazon // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your dominant language detection job. - // For more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -97,17 +94,10 @@ type StartDominantLanguageDetectionJobOutput struct { JobId *string // The status of the job. - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the operation. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartEntitiesDetectionJob.go b/service/comprehend/api_op_StartEntitiesDetectionJob.go index 39d1eb992cd..1903c4816af 100644 --- a/service/comprehend/api_op_StartEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StartEntitiesDetectionJob.go @@ -36,8 +36,8 @@ func (c *Client) StartEntitiesDetectionJob(ctx context.Context, params *StartEnt type StartEntitiesDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -47,10 +47,10 @@ type StartEntitiesDetectionJobInput struct { // This member is required. InputDataConfig *types.InputDataConfig - // The language of the input documents. All documents must be in the same language. - // You can specify any of the languages supported by Amazon Comprehend. If custom - // entities recognition is used, this parameter is ignored and the language used - // for training the model is used instead. + // The language of the input documents. All documents must be in the same + // language. You can specify any of the languages supported by Amazon Comprehend. + // If custom entities recognition is used, this parameter is ignored and the + // language used for training the model is used instead. // // This member is required. LanguageCode types.LanguageCode @@ -64,9 +64,9 @@ type StartEntitiesDetectionJobInput struct { // Amazon Comprehend generates one. ClientRequestToken *string - // The Amazon Resource Name (ARN) that identifies the specific entity recognizer to - // be used by the StartEntitiesDetectionJob. This ARN is optional and is only used - // for a custom entity recognition job. + // The Amazon Resource Name (ARN) that identifies the specific entity recognizer + // to be used by the StartEntitiesDetectionJob . This ARN is optional and is only + // used for a custom entity recognition job. EntityRecognizerArn *string // The Amazon Resource Number (ARN) of the flywheel associated with the model to @@ -86,18 +86,15 @@ type StartEntitiesDetectionJobInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your entity detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -121,24 +118,13 @@ type StartEntitiesDetectionJobOutput struct { JobId *string // The status of the job. - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the operation. - // - // * - // STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and - // is processing the request. - // - // * STOPPED - The job was successfully stopped without - // completing. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the operation. + // - STOP_REQUESTED - Amazon Comprehend has received a stop request for the job + // and is processing the request. + // - STOPPED - The job was successfully stopped without completing. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartEventsDetectionJob.go b/service/comprehend/api_op_StartEventsDetectionJob.go index cce4be8365c..3ead1f0592b 100644 --- a/service/comprehend/api_op_StartEventsDetectionJob.go +++ b/service/comprehend/api_op_StartEventsDetectionJob.go @@ -56,8 +56,8 @@ type StartEventsDetectionJobInput struct { // This member is required. TargetEventTypes []string - // An unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. + // An unique identifier for the request. If you don't set the client request + // token, Amazon Comprehend generates one. ClientRequestToken *string // The identifier of the events detection job. @@ -77,13 +77,13 @@ type StartEventsDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the events detection job. It is a unique, // fully qualified identifier for the job. It includes the Amazon Web Services // account, Amazon Web Services Region, and the job ID. The format of the ARN is as - // follows: arn::comprehend:::events-detection-job/ The following is an example job - // ARN: + // follows: arn::comprehend:::events-detection-job/ The following is an example + // job ARN: // arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string - // An unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. + // An unique identifier for the request. If you don't set the client request + // token, Amazon Comprehend generates one. JobId *string // The status of the events detection job. diff --git a/service/comprehend/api_op_StartFlywheelIteration.go b/service/comprehend/api_op_StartFlywheelIteration.go index 7011548aa7a..7443c4f09fc 100644 --- a/service/comprehend/api_op_StartFlywheelIteration.go +++ b/service/comprehend/api_op_StartFlywheelIteration.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Start the flywheel iteration.This operation uses any new datasets to train a new -// model version. For more information about flywheels, see Flywheel overview -// (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the -// Amazon Comprehend Developer Guide. +// Start the flywheel iteration.This operation uses any new datasets to train a +// new model version. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) +// in the Amazon Comprehend Developer Guide. func (c *Client) StartFlywheelIteration(ctx context.Context, params *StartFlywheelIterationInput, optFns ...func(*Options)) (*StartFlywheelIterationOutput, error) { if params == nil { params = &StartFlywheelIterationInput{} diff --git a/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go b/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go index 0a1001fb0fa..0c5bee9c1ee 100644 --- a/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go +++ b/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go @@ -32,8 +32,8 @@ func (c *Client) StartKeyPhrasesDetectionJob(ctx context.Context, params *StartK type StartKeyPhrasesDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -72,18 +72,15 @@ type StartKeyPhrasesDetectionJobInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your key phrases detection job. For - // more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -104,17 +101,10 @@ type StartKeyPhrasesDetectionJobOutput struct { JobId *string // The status of the job. - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the operation. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go b/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go index 422bb27a303..9ed25e1585d 100644 --- a/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go @@ -47,8 +47,8 @@ type StartPiiEntitiesDetectionJobInput struct { // This member is required. LanguageCode types.LanguageCode - // Specifies whether the output provides the locations (offsets) of PII entities or - // a file in which PII entities are redacted. + // Specifies whether the output provides the locations (offsets) of PII entities + // or a file in which PII entities are redacted. // // This member is required. Mode types.PiiEntitiesDetectionMode @@ -66,14 +66,15 @@ type StartPiiEntitiesDetectionJobInput struct { JobName *string // Provides configuration parameters for PII entity redaction. This parameter is - // required if you set the Mode parameter to ONLY_REDACTION. In that case, you must - // provide a RedactionConfig definition that includes the PiiEntityTypes parameter. + // required if you set the Mode parameter to ONLY_REDACTION . In that case, you + // must provide a RedactionConfig definition that includes the PiiEntityTypes + // parameter. RedactionConfig *types.RedactionConfig - // Tags to associate with the PII entities detection job. A tag is a key-value pair - // that adds metadata to a resource used by Amazon Comprehend. For example, a tag - // with "Sales" as the key might be added to a resource to indicate its use by the - // sales department. + // Tags to associate with the PII entities detection job. A tag is a key-value + // pair that adds metadata to a resource used by Amazon Comprehend. For example, a + // tag with "Sales" as the key might be added to a resource to indicate its use by + // the sales department. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/comprehend/api_op_StartSentimentDetectionJob.go b/service/comprehend/api_op_StartSentimentDetectionJob.go index 7bc53a55fef..95e860cabac 100644 --- a/service/comprehend/api_op_StartSentimentDetectionJob.go +++ b/service/comprehend/api_op_StartSentimentDetectionJob.go @@ -32,8 +32,8 @@ func (c *Client) StartSentimentDetectionJob(ctx context.Context, params *StartSe type StartSentimentDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -72,18 +72,15 @@ type StartSentimentDetectionJobInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your sentiment detection job. For - // more information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -104,17 +101,10 @@ type StartSentimentDetectionJobOutput struct { JobId *string // The status of the job. - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the operation. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go b/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go index d0f37f36052..224d0ba86a4 100644 --- a/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go +++ b/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go @@ -33,8 +33,8 @@ func (c *Client) StartTargetedSentimentDetectionJob(ctx context.Context, params type StartTargetedSentimentDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -72,19 +72,15 @@ type StartTargetedSentimentDetectionJobInput struct { // ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage // volume attached to the ML compute instance(s) that process the analysis job. The // VolumeKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for the job. For more information, see - // Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -105,18 +101,11 @@ type StartTargetedSentimentDetectionJobOutput struct { JobId *string // The status of the job. - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the - // DescribeTargetedSentimentDetectionJob operation. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the + // DescribeTargetedSentimentDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StartTopicsDetectionJob.go b/service/comprehend/api_op_StartTopicsDetectionJob.go index a5c17cf133d..65a97470116 100644 --- a/service/comprehend/api_op_StartTopicsDetectionJob.go +++ b/service/comprehend/api_op_StartTopicsDetectionJob.go @@ -32,8 +32,8 @@ func (c *Client) StartTopicsDetectionJob(ctx context.Context, params *StartTopic type StartTopicsDetectionJobInput struct { // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend - // read access to your input data. For more information, see Role-based permissions - // (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions). + // read access to your input data. For more information, see Role-based permissions (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions) + // . // // This member is required. DataAccessRoleArn *string @@ -44,14 +44,14 @@ type StartTopicsDetectionJobInput struct { InputDataConfig *types.InputDataConfig // Specifies where to send the output files. The output is a compressed archive - // with two files, topic-terms.csv that lists the terms associated with each topic, - // and doc-topics.csv that lists the documents associated with each topic + // with two files, topic-terms.csv that lists the terms associated with each + // topic, and doc-topics.csv that lists the documents associated with each topic // // This member is required. OutputDataConfig *types.OutputDataConfig - // A unique identifier for the request. If you do not set the client request token, - // Amazon Comprehend generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Comprehend generates one. ClientRequestToken *string // The identifier of the job. @@ -70,18 +70,15 @@ type StartTopicsDetectionJobInput struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your topic detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -92,8 +89,8 @@ type StartTopicsDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the topics detection job. It is a unique, // fully qualified identifier for the job. It includes the Amazon Web Services // account, Amazon Web Services Region, and the job ID. The format of the ARN is as - // follows: arn::comprehend:::topics-detection-job/ The following is an example job - // ARN: + // follows: arn::comprehend:::topics-detection-job/ The following is an example + // job ARN: // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab JobArn *string @@ -102,18 +99,11 @@ type StartTopicsDetectionJobOutput struct { JobId *string // The status of the job: - // - // * SUBMITTED - The job has been received and is queued - // for processing. - // - // * IN_PROGRESS - Amazon Comprehend is processing the job. - // - // * - // COMPLETED - The job was successfully completed and the output is available. - // - // * - // FAILED - The job did not complete. To get details, use the - // DescribeTopicDetectionJob operation. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Comprehend is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - FAILED - The job did not complete. To get details, use the + // DescribeTopicDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go index 7c728d1b380..b07783c183d 100644 --- a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go @@ -14,8 +14,8 @@ import ( // Stops a dominant language detection job in progress. If the job state is // IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED // state. If the job completes before it can be stopped, it is put into the -// COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If -// the job is in the COMPLETED or FAILED state when you call the +// COMPLETED state; otherwise the job is stopped and put into the STOPPED state. +// If the job is in the COMPLETED or FAILED state when you call the // StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal // Request Exception. When a job is stopped, any documents already processed are // written to the output location. @@ -49,8 +49,8 @@ type StopDominantLanguageDetectionJobOutput struct { // The identifier of the dominant language detection job to stop. JobId *string - // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was - // previously stopped with the StopDominantLanguageDetectionJob operation. + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job + // was previously stopped with the StopDominantLanguageDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopEntitiesDetectionJob.go b/service/comprehend/api_op_StopEntitiesDetectionJob.go index b3b6a25f0a3..cd8747100f8 100644 --- a/service/comprehend/api_op_StopEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StopEntitiesDetectionJob.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an entities detection job in progress. If the job state is IN_PROGRESS the -// job is marked for termination and put into the STOP_REQUESTED state. If the job -// completes before it can be stopped, it is put into the COMPLETED state; +// Stops an entities detection job in progress. If the job state is IN_PROGRESS +// the job is marked for termination and put into the STOP_REQUESTED state. If the +// job completes before it can be stopped, it is put into the COMPLETED state; // otherwise the job is stopped and put into the STOPPED state. If the job is in // the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob // operation, the operation returns a 400 Internal Request Exception. When a job is @@ -48,8 +48,8 @@ type StopEntitiesDetectionJobOutput struct { // The identifier of the entities detection job to stop. JobId *string - // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was - // previously stopped with the StopEntitiesDetectionJob operation. + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job + // was previously stopped with the StopEntitiesDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go b/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go index 5b6ee400229..d0535a1f7ba 100644 --- a/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go +++ b/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go @@ -48,8 +48,8 @@ type StopKeyPhrasesDetectionJobOutput struct { // The identifier of the key phrases detection job to stop. JobId *string - // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was - // previously stopped with the StopKeyPhrasesDetectionJob operation. + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job + // was previously stopped with the StopKeyPhrasesDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopSentimentDetectionJob.go b/service/comprehend/api_op_StopSentimentDetectionJob.go index ddb1fa62839..642d524bbce 100644 --- a/service/comprehend/api_op_StopSentimentDetectionJob.go +++ b/service/comprehend/api_op_StopSentimentDetectionJob.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a sentiment detection job in progress. If the job state is IN_PROGRESS, +// Stops a sentiment detection job in progress. If the job state is IN_PROGRESS , // the job is marked for termination and put into the STOP_REQUESTED state. If the // job completes before it can be stopped, it is put into the COMPLETED state; -// otherwise the job is be stopped and put into the STOPPED state. If the job is in -// the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob -// operation, the operation returns a 400 Internal Request Exception. When a job is -// stopped, any documents already processed are written to the output location. +// otherwise the job is be stopped and put into the STOPPED state. If the job is +// in the COMPLETED or FAILED state when you call the +// StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal +// Request Exception. When a job is stopped, any documents already processed are +// written to the output location. func (c *Client) StopSentimentDetectionJob(ctx context.Context, params *StopSentimentDetectionJobInput, optFns ...func(*Options)) (*StopSentimentDetectionJobOutput, error) { if params == nil { params = &StopSentimentDetectionJobInput{} @@ -48,8 +49,8 @@ type StopSentimentDetectionJobOutput struct { // The identifier of the sentiment detection job to stop. JobId *string - // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was - // previously stopped with the StopSentimentDetectionJob operation. + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job + // was previously stopped with the StopSentimentDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go b/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go index 64e2c3b989c..283432f0679 100644 --- a/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go +++ b/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go @@ -12,10 +12,10 @@ import ( ) // Stops a targeted sentiment detection job in progress. If the job state is -// IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED +// IN_PROGRESS , the job is marked for termination and put into the STOP_REQUESTED // state. If the job completes before it can be stopped, it is put into the -// COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. -// If the job is in the COMPLETED or FAILED state when you call the +// COMPLETED state; otherwise the job is be stopped and put into the STOPPED +// state. If the job is in the COMPLETED or FAILED state when you call the // StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal // Request Exception. When a job is stopped, any documents already processed are // written to the output location. @@ -49,8 +49,8 @@ type StopTargetedSentimentDetectionJobOutput struct { // The identifier of the targeted sentiment detection job to stop. JobId *string - // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was - // previously stopped with the StopSentimentDetectionJob operation. + // Either STOP_REQUESTED if the job is currently running, or STOPPED if the job + // was previously stopped with the StopSentimentDetectionJob operation. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_StopTrainingDocumentClassifier.go b/service/comprehend/api_op_StopTrainingDocumentClassifier.go index 42797351bf7..f98b1ac03d2 100644 --- a/service/comprehend/api_op_StopTrainingDocumentClassifier.go +++ b/service/comprehend/api_op_StopTrainingDocumentClassifier.go @@ -11,9 +11,9 @@ import ( ) // Stops a document classifier training job while in progress. If the training job -// state is TRAINING, the job is marked for termination and put into the +// state is TRAINING , the job is marked for termination and put into the // STOP_REQUESTED state. If the training job completes before it can be stopped, it -// is put into the TRAINED; otherwise the training job is stopped and put into the +// is put into the TRAINED ; otherwise the training job is stopped and put into the // STOPPED state and the service sends back an HTTP 200 response with an empty HTTP // body. func (c *Client) StopTrainingDocumentClassifier(ctx context.Context, params *StopTrainingDocumentClassifierInput, optFns ...func(*Options)) (*StopTrainingDocumentClassifierOutput, error) { @@ -33,8 +33,8 @@ func (c *Client) StopTrainingDocumentClassifier(ctx context.Context, params *Sto type StopTrainingDocumentClassifierInput struct { - // The Amazon Resource Name (ARN) that identifies the document classifier currently - // being trained. + // The Amazon Resource Name (ARN) that identifies the document classifier + // currently being trained. // // This member is required. DocumentClassifierArn *string diff --git a/service/comprehend/api_op_StopTrainingEntityRecognizer.go b/service/comprehend/api_op_StopTrainingEntityRecognizer.go index 476f94affce..c62f2a8bdd8 100644 --- a/service/comprehend/api_op_StopTrainingEntityRecognizer.go +++ b/service/comprehend/api_op_StopTrainingEntityRecognizer.go @@ -11,9 +11,9 @@ import ( ) // Stops an entity recognizer training job while in progress. If the training job -// state is TRAINING, the job is marked for termination and put into the +// state is TRAINING , the job is marked for termination and put into the // STOP_REQUESTED state. If the training job completes before it can be stopped, it -// is put into the TRAINED; otherwise the training job is stopped and putted into +// is put into the TRAINED ; otherwise the training job is stopped and putted into // the STOPPED state and the service sends back an HTTP 200 response with an empty // HTTP body. func (c *Client) StopTrainingEntityRecognizer(ctx context.Context, params *StopTrainingEntityRecognizerInput, optFns ...func(*Options)) (*StopTrainingEntityRecognizerOutput, error) { diff --git a/service/comprehend/api_op_TagResource.go b/service/comprehend/api_op_TagResource.go index d1366d4203f..2c50d22b23d 100644 --- a/service/comprehend/api_op_TagResource.go +++ b/service/comprehend/api_op_TagResource.go @@ -38,8 +38,8 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // Tags being associated with a specific Amazon Comprehend resource. There can be a - // maximum of 50 tags (both existing and pending) associated with a specific + // Tags being associated with a specific Amazon Comprehend resource. There can be + // a maximum of 50 tags (both existing and pending) associated with a specific // resource. // // This member is required. diff --git a/service/comprehend/api_op_UntagResource.go b/service/comprehend/api_op_UntagResource.go index dcbd6f80ba5..5657a8b80cb 100644 --- a/service/comprehend/api_op_UntagResource.go +++ b/service/comprehend/api_op_UntagResource.go @@ -34,8 +34,8 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // The initial part of a key-value pair that forms a tag being removed from a given - // resource. For example, a tag with "Sales" as the key might be added to a + // The initial part of a key-value pair that forms a tag being removed from a + // given resource. For example, a tag with "Sales" as the key might be added to a // resource to indicate its use by the sales department. Keys must be unique and // cannot be duplicated for a particular resource. // diff --git a/service/comprehend/api_op_UpdateEndpoint.go b/service/comprehend/api_op_UpdateEndpoint.go index 4995ed18dbd..4898d5c314a 100644 --- a/service/comprehend/api_op_UpdateEndpoint.go +++ b/service/comprehend/api_op_UpdateEndpoint.go @@ -11,8 +11,8 @@ import ( ) // Updates information about the specified endpoint. For information about -// endpoints, see Managing endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error) { if params == nil { params = &UpdateEndpointInput{} diff --git a/service/comprehend/doc.go b/service/comprehend/doc.go index eabbc512d7a..39a602dbf90 100644 --- a/service/comprehend/doc.go +++ b/service/comprehend/doc.go @@ -3,8 +3,8 @@ // Package comprehend provides the API client, operations, and parameter types for // Amazon Comprehend. // -// Amazon Comprehend is an Amazon Web Services service for gaining insight into the -// content of documents. Use these actions to determine the topics contained in +// Amazon Comprehend is an Amazon Web Services service for gaining insight into +// the content of documents. Use these actions to determine the topics contained in // your documents, the topics they discuss, the predominant sentiment expressed in // them, the predominant language used, and more. package comprehend diff --git a/service/comprehend/types/enums.go b/service/comprehend/types/enums.go index 07aca0d1e85..6a47f0cf436 100644 --- a/service/comprehend/types/enums.go +++ b/service/comprehend/types/enums.go @@ -29,9 +29,9 @@ const ( BlockTypeWord BlockType = "WORD" ) -// Values returns all known values for BlockType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BlockType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BlockType) Values() []BlockType { return []BlockType{ "LINE", @@ -103,9 +103,10 @@ const ( DocumentClassifierDataFormatAugmentedManifest DocumentClassifierDataFormat = "AUGMENTED_MANIFEST" ) -// Values returns all known values for DocumentClassifierDataFormat. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DocumentClassifierDataFormat. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DocumentClassifierDataFormat) Values() []DocumentClassifierDataFormat { return []DocumentClassifierDataFormat{ "COMPREHEND_CSV", @@ -157,9 +158,9 @@ const ( DocumentReadFeatureTypesForms DocumentReadFeatureTypes = "FORMS" ) -// Values returns all known values for DocumentReadFeatureTypes. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DocumentReadFeatureTypes. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentReadFeatureTypes) Values() []DocumentReadFeatureTypes { return []DocumentReadFeatureTypes{ "TABLES", @@ -198,9 +199,9 @@ const ( DocumentTypeTextractAnalyzeDocumentJson DocumentType = "TEXTRACT_ANALYZE_DOCUMENT_JSON" ) -// Values returns all known values for DocumentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DocumentType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DocumentType) Values() []DocumentType { return []DocumentType{ "NATIVE_PDF", @@ -405,9 +406,9 @@ const ( JobStatusStopped JobStatus = "STOPPED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -437,9 +438,9 @@ const ( LanguageCodeZhTw LanguageCode = "zh-TW" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "en", @@ -495,9 +496,9 @@ const ( ModelTypeEntityRecognizer ModelType = "ENTITY_RECOGNIZER" ) -// Values returns all known values for ModelType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ModelType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ModelType) Values() []ModelType { return []ModelType{ "DOCUMENT_CLASSIFIER", @@ -587,9 +588,10 @@ const ( PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType PiiEntitiesDetectionMaskMode = "REPLACE_WITH_PII_ENTITY_TYPE" ) -// Values returns all known values for PiiEntitiesDetectionMaskMode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PiiEntitiesDetectionMaskMode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (PiiEntitiesDetectionMaskMode) Values() []PiiEntitiesDetectionMaskMode { return []PiiEntitiesDetectionMaskMode{ "MASK", @@ -605,9 +607,9 @@ const ( PiiEntitiesDetectionModeOnlyOffsets PiiEntitiesDetectionMode = "ONLY_OFFSETS" ) -// Values returns all known values for PiiEntitiesDetectionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PiiEntitiesDetectionMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PiiEntitiesDetectionMode) Values() []PiiEntitiesDetectionMode { return []PiiEntitiesDetectionMode{ "ONLY_REDACTION", @@ -749,8 +751,8 @@ const ( SplitTest Split = "TEST" ) -// Values returns all known values for Split. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Split. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Split) Values() []Split { return []Split{ diff --git a/service/comprehend/types/errors.go b/service/comprehend/types/errors.go index 2000ea6abf6..6f5b9eab90c 100644 --- a/service/comprehend/types/errors.go +++ b/service/comprehend/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// The number of documents in the request exceeds the limit of 25. Try your request -// again with fewer documents. +// The number of documents in the request exceeds the limit of 25. Try your +// request again with fewer documents. type BatchSizeLimitExceededException struct { Message *string @@ -195,8 +195,8 @@ func (e *KmsKeyValidationException) ErrorCode() string { } func (e *KmsKeyValidationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified resource name is already in use. Use a different name and try your -// request again. +// The specified resource name is already in use. Use a different name and try +// your request again. type ResourceInUseException struct { Message *string @@ -276,8 +276,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified resource is not available. Check the resource and try your request -// again. +// The specified resource is not available. Check the resource and try your +// request again. type ResourceUnavailableException struct { Message *string @@ -412,9 +412,8 @@ func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault { return smithy.Fa // Amazon Comprehend can't process the language of the input text. For custom // entity recognition APIs, only English, Spanish, French, Italian, German, or -// Portuguese are accepted. For a list of supported languages, Supported languages -// (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in -// the Comprehend Developer Guide. +// Portuguese are accepted. For a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) +// in the Comprehend Developer Guide. type UnsupportedLanguageException struct { Message *string diff --git a/service/comprehend/types/types.go b/service/comprehend/types/types.go index 476b9f7bed9..3476e392387 100644 --- a/service/comprehend/types/types.go +++ b/service/comprehend/types/types.go @@ -7,8 +7,8 @@ import ( "time" ) -// An augmented manifest file that provides training data for your custom model. An -// augmented manifest file is a labeled dataset that is produced by Amazon +// An augmented manifest file that provides training data for your custom model. +// An augmented manifest file is a labeled dataset that is produced by Amazon // SageMaker Ground Truth. type AugmentedManifestsListItem struct { @@ -35,14 +35,11 @@ type AugmentedManifestsListItem struct { // The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If // you don't specify, the default is PlainTextDocument. - // - // * PLAIN_TEXT_DOCUMENT A - // document type that represents any unicode text that is encoded in UTF-8. - // - // * - // SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, - // like a PDF. For training with Amazon Comprehend, only PDFs are supported. For - // inference, Amazon Comprehend support PDFs, DOCX and TXT. + // - PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is + // encoded in UTF-8. + // - SEMI_STRUCTURED_DOCUMENT A document type with positional and structural + // context, like a PDF. For training with Amazon Comprehend, only PDFs are + // supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT. DocumentType AugmentedManifestsDocumentTypeFormat // The S3 prefix to the source files (PDFs) that are referred to in the augmented @@ -160,19 +157,15 @@ type BatchItemError struct { } // Information about each word or line of text in the input document. For -// additional information, see Block -// (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) in the Amazon -// Textract API reference. +// additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) +// in the Amazon Textract API reference. type Block struct { // The block represents a line of text or one word of text. - // - // * WORD - A word that's - // detected on a document page. A word is one or more ISO basic Latin script - // characters that aren't separated by spaces. - // - // * LINE - A string of tab-delimited, - // contiguous words that are detected on a document page + // - WORD - A word that's detected on a document page. A word is one or more ISO + // basic Latin script characters that aren't separated by spaces. + // - LINE - A string of tab-delimited, contiguous words that are detected on a + // document page BlockType BlockType // Co-ordinates of the rectangle or polygon that contains the text. @@ -216,9 +209,8 @@ type BlockReference struct { // page. The left (x-coordinate) and top (y-coordinate) are coordinates that // represent the top and left sides of the bounding box. Note that the upper-left // corner of the image is the origin (0,0). For additional information, see -// BoundingBox -// (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) in the -// Amazon Textract API reference. +// BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) +// in the Amazon Textract API reference. type BoundingBox struct { // The height of the bounding box as a ratio of the overall document page height. @@ -273,9 +265,9 @@ type ClassifierEvaluationMetrics struct { HammingLoss *float64 // A measure of how accurate the classifier results are for the test data. It is a - // combination of the Micro Precision and Micro Recall values. The Micro F1Score is - // the harmonic mean of the two scores. The highest score is 1, and the worst score - // is 0. + // combination of the Micro Precision and Micro Recall values. The Micro F1Score + // is the harmonic mean of the two scores. The highest score is 1, and the worst + // score is 0. MicroF1Score *float64 // A measure of the usefulness of the recognizer results in the test data. High @@ -316,9 +308,9 @@ type ClassifierMetadata struct { // The number of labels in the input data. NumberOfLabels *int32 - // The number of documents in the input data that were used to test the classifier. - // Typically this is 10 to 20 percent of the input documents, up to 10,000 - // documents. + // The number of documents in the input data that were used to test the + // classifier. Typically this is 10 to 20 percent of the input documents, up to + // 10,000 documents. NumberOfTestDocuments *int32 // The number of documents in the input data that were used to train the @@ -335,15 +327,11 @@ type DataSecurityConfig struct { // lake. DataLakeKmsKeyId *string - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // ID for the KMS key that Amazon Comprehend uses to encrypt the volume. @@ -351,15 +339,15 @@ type DataSecurityConfig struct { // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for the job. For more information, see - // Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde } -// An augmented manifest file that provides training data for your custom model. An -// augmented manifest file is a labeled dataset that is produced by Amazon +// An augmented manifest file that provides training data for your custom model. +// An augmented manifest file is a labeled dataset that is produced by Amazon // SageMaker Ground Truth. type DatasetAugmentedManifestsListItem struct { @@ -398,18 +386,17 @@ type DatasetAugmentedManifestsListItem struct { // Describes the dataset input data configuration for a document classifier model. // For more information on how the input file is formatted, see Preparing training -// data -// (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in -// the Comprehend Developer Guide. +// data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) +// in the Comprehend Developer Guide. type DatasetDocumentClassifierInputDataConfig struct { // The Amazon S3 URI for the input data. The S3 bucket must be in the same Region // as the API endpoint that you are calling. The URI can point to a single input // file or it can provide the prefix for a collection of input files. For example, - // if you use the URI S3://bucketName/prefix, if the prefix is a single file, + // if you use the URI S3://bucketName/prefix , if the prefix is a single file, // Amazon Comprehend uses that file as input. If more than one file begins with the // prefix, Amazon Comprehend uses all of them as input. This parameter is required - // if you set DataFormat to COMPREHEND_CSV. + // if you set DataFormat to COMPREHEND_CSV . // // This member is required. S3Uri *string @@ -459,8 +446,7 @@ type DatasetEntityRecognizerDocuments struct { } // Describes the dataset entity list for an entity recognizer model. For more -// information on how the input file is formatted, see Preparing training data -// (https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html) +// information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html) // in the Comprehend Developer Guide. type DatasetEntityRecognizerEntityList struct { @@ -472,8 +458,8 @@ type DatasetEntityRecognizerEntityList struct { noSmithyDocumentSerde } -// Specifies the format and location of the input data. You must provide either the -// Annotations parameter or the EntityList parameter. +// Specifies the format and location of the input data. You must provide either +// the Annotations parameter or the EntityList parameter. type DatasetEntityRecognizerInputDataConfig struct { // The format and location of the training documents for your custom entity @@ -517,15 +503,14 @@ type DatasetInputDataConfig struct { // Amazon SageMaker Ground Truth. AugmentedManifests []DatasetAugmentedManifestsListItem - // COMPREHEND_CSV: The data format is a two-column CSV file, where the first column - // contains labels and the second column contains documents. AUGMENTED_MANIFEST: - // The data format + // COMPREHEND_CSV : The data format is a two-column CSV file, where the first + // column contains labels and the second column contains documents. + // AUGMENTED_MANIFEST : The data format DataFormat DatasetDataFormat // The input properties for training a document classifier model. For more - // information on how the input file is formatted, see Preparing training data - // (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in - // the Comprehend Developer Guide. + // information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) + // in the Comprehend Developer Guide. DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig // The input properties for training an entity recognizer model. @@ -564,8 +549,8 @@ type DatasetProperties struct { // The number of documents in the dataset. NumberOfDocuments *int64 - // The dataset status. While the system creates the dataset, the status is - // CREATING. When the dataset is ready to use, the status changes to COMPLETED. + // The dataset status. While the system creates the dataset, the status is CREATING + // . When the dataset is ready to use, the status changes to COMPLETED . Status DatasetStatus noSmithyDocumentSerde @@ -577,8 +562,8 @@ type DocumentClass struct { // The name of the class. Name *string - // Page number in the input document. This field is present in the response only if - // your request includes the Byte parameter. + // Page number in the input document. This field is present in the response only + // if your request includes the Byte parameter. Page *int32 // The confidence score that Amazon Comprehend has this class correctly attributed. @@ -591,7 +576,7 @@ type DocumentClass struct { type DocumentClassificationConfig struct { // Classification mode indicates whether the documents are MULTI_CLASS or - // MULTI_LABEL. + // MULTI_LABEL . // // This member is required. Mode DocumentClassifierMode @@ -661,7 +646,7 @@ type DocumentClassificationJobProperties struct { // The name that you assigned to the document classification job. JobName *string - // The current status of the document classification job. If the status is FAILED, + // The current status of the document classification job. If the status is FAILED , // the Message field shows the reason for the failure. JobStatus JobStatus @@ -679,18 +664,15 @@ type DocumentClassificationJobProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your document classification job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -720,33 +702,27 @@ type DocumentClassifierFilter struct { noSmithyDocumentSerde } -// The input properties for training a document classifier. For more information on -// how the input file is formatted, see Preparing training data -// (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in -// the Comprehend Developer Guide. +// The input properties for training a document classifier. For more information +// on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) +// in the Comprehend Developer Guide. type DocumentClassifierInputDataConfig struct { // A list of augmented manifest files that provide training data for your custom // model. An augmented manifest file is a labeled dataset that is produced by // Amazon SageMaker Ground Truth. This parameter is required if you set DataFormat - // to AUGMENTED_MANIFEST. + // to AUGMENTED_MANIFEST . AugmentedManifests []AugmentedManifestsListItem // The format of your training data: - // - // * COMPREHEND_CSV: A two-column CSV file, - // where labels are provided in the first column, and documents are provided in the - // second. If you use this value, you must provide the S3Uri parameter in your - // request. - // - // * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon - // SageMaker Ground Truth. This file is in JSON lines format. Each line is a - // complete JSON object that contains a training document and its associated - // labels. If you use this value, you must provide the AugmentedManifests parameter - // in your request. - // - // If you don't specify a value, Amazon Comprehend uses - // COMPREHEND_CSV as the default. + // - COMPREHEND_CSV : A two-column CSV file, where labels are provided in the + // first column, and documents are provided in the second. If you use this value, + // you must provide the S3Uri parameter in your request. + // - AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker + // Ground Truth. This file is in JSON lines format. Each line is a complete JSON + // object that contains a training document and its associated labels. If you use + // this value, you must provide the AugmentedManifests parameter in your request. + // If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the + // default. DataFormat DocumentClassifierDataFormat // Indicates the delimiter used to separate each label for training a multi-label @@ -760,10 +736,10 @@ type DocumentClassifierInputDataConfig struct { // The Amazon S3 URI for the input data. The S3 bucket must be in the same Region // as the API endpoint that you are calling. The URI can point to a single input // file or it can provide the prefix for a collection of input files. For example, - // if you use the URI S3://bucketName/prefix, if the prefix is a single file, + // if you use the URI S3://bucketName/prefix , if the prefix is a single file, // Amazon Comprehend uses that file as input. If more than one file begins with the // prefix, Amazon Comprehend uses all of them as input. This parameter is required - // if you set DataFormat to COMPREHEND_CSV. + // if you set DataFormat to COMPREHEND_CSV . S3Uri *string // This specifies the Amazon S3 location where the test annotations for an entity @@ -783,28 +759,21 @@ type DocumentClassifierOutputDataConfig struct { // ID for the Amazon Web Services Key Management Service (KMS) key that Amazon // Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId // can be one of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // KMS Key Alias: "alias/ExampleAlias" - // - // * ARN of a KMS Key Alias: - // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key Alias: "alias/ExampleAlias" + // - ARN of a KMS Key Alias: + // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" KmsKeyId *string - // When you use the OutputDataConfig object while creating a custom classifier, you - // specify the Amazon S3 location where you want to write the confusion matrix. The - // URI must be in the same Region as the API endpoint that you are calling. The + // When you use the OutputDataConfig object while creating a custom classifier, + // you specify the Amazon S3 location where you want to write the confusion matrix. + // The URI must be in the same Region as the API endpoint that you are calling. The // location is used as the prefix for the actual location of this output file. When // the custom classifier job is finished, the service creates the output file in a // directory specific to the job. The S3Uri field contains the location of the - // output file, called output.tar.gz. It is a compressed archive that contains the + // output file, called output.tar.gz . It is a compressed archive that contains the // confusion matrix. S3Uri *string @@ -849,23 +818,19 @@ type DocumentClassifierProperties struct { // the classifier is trained. Mode DocumentClassifierMode - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // Provides output results configuration parameters for custom classifier jobs. OutputDataConfig *DocumentClassifierOutputDataConfig - // The Amazon Resource Name (ARN) of the source model. This model was imported from - // a different Amazon Web Services account to create the document classifier model - // in your Amazon Web Services account. + // The Amazon Resource Name (ARN) of the source model. This model was imported + // from a different Amazon Web Services account to create the document classifier + // model in your Amazon Web Services account. SourceModelArn *string // The status of the document classifier. If the status is TRAINED the classifier @@ -893,18 +858,15 @@ type DocumentClassifierProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your custom classifier. For more information, - // see Amazon VPC - // (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html). + // see Amazon VPC (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -952,8 +914,8 @@ type DocumentLabel struct { // Information about the document, discovered during text extraction. type DocumentMetadata struct { - // List of pages in the document, with the number of characters extracted from each - // page. + // List of pages in the document, with the number of characters extracted from + // each page. ExtractedCharacters []ExtractedCharactersListItem // Number of pages in the document. @@ -962,59 +924,46 @@ type DocumentMetadata struct { noSmithyDocumentSerde } -// Provides configuration parameters to override the default actions for extracting -// text from PDF documents and image files. By default, Amazon Comprehend performs -// the following actions to extract text from files, based on the input file -// type: -// -// * Word files - Amazon Comprehend parser extracts the text. -// -// * Digital PDF -// files - Amazon Comprehend parser extracts the text. -// -// * Image files and scanned -// PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to -// extract the text. +// Provides configuration parameters to override the default actions for +// extracting text from PDF documents and image files. By default, Amazon +// Comprehend performs the following actions to extract text from files, based on +// the input file type: +// - Word files - Amazon Comprehend parser extracts the text. +// - Digital PDF files - Amazon Comprehend parser extracts the text. +// - Image files and scanned PDF files - Amazon Comprehend uses the Amazon +// Textract DetectDocumentText API to extract the text. // -// DocumentReaderConfig does not apply to plain text files or -// Word files. For image files and PDF documents, you can override these default -// actions using the fields listed below. For more information, see Setting text -// extraction options -// (https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf). +// DocumentReaderConfig does not apply to plain text files or Word files. For +// image files and PDF documents, you can override these default actions using the +// fields listed below. For more information, see Setting text extraction options (https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf) +// . type DocumentReaderConfig struct { - // This field defines the Amazon Textract API operation that Amazon Comprehend uses - // to extract text from PDF files and image files. Enter one of the following + // This field defines the Amazon Textract API operation that Amazon Comprehend + // uses to extract text from PDF files and image files. Enter one of the following // values: - // - // * TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses - // the DetectDocumentText API operation. - // - // * TEXTRACT_ANALYZE_DOCUMENT - The Amazon - // Comprehend service uses the AnalyzeDocument API operation. + // - TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the + // DetectDocumentText API operation. + // - TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the + // AnalyzeDocument API operation. // // This member is required. DocumentReadAction DocumentReadAction - // Determines the text extraction actions for PDF files. Enter one of the following - // values: - // - // * SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF - // files. - // - // * FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API - // specified by DocumentReadAction for all PDF files, including digital PDF files. + // Determines the text extraction actions for PDF files. Enter one of the + // following values: + // - SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files. + // - FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API + // specified by DocumentReadAction for all PDF files, including digital PDF files. DocumentReadMode DocumentReadMode // Specifies the type of Amazon Textract features to apply. If you chose // TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of // the following values: - // - // * TABLES - Returns information about any tables that are - // detected in the input document. - // - // * FORMS - Returns information and the data from - // any forms that are detected in the input document. + // - TABLES - Returns information about any tables that are detected in the input + // document. + // - FORMS - Returns information and the data from any forms that are detected in + // the input document. FeatureTypes []DocumentReadFeatureTypes noSmithyDocumentSerde @@ -1036,9 +985,9 @@ type DocumentTypeListItem struct { // confidence that Amazon Comprehend has in the accuracy of the detection. type DominantLanguage struct { - // The RFC 5646 language code for the dominant language. For more information about - // RFC 5646, see Tags for Identifying Languages - // (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site. + // The RFC 5646 language code for the dominant language. For more information + // about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646) + // on the IETF Tools web site. LanguageCode *string // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -1101,7 +1050,7 @@ type DominantLanguageDetectionJobProperties struct { JobName *string // The current status of the dominant language detection job. If the status is - // FAILED, the Message field shows the reason for the failure. + // FAILED , the Message field shows the reason for the failure. JobStatus JobStatus // A description for the status of a job. @@ -1118,18 +1067,15 @@ type DominantLanguageDetectionJobProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your dominant language detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1157,8 +1103,8 @@ type EndpointFilter struct { } // Specifies information about the specified endpoint. For information about -// endpoints, see Managing endpoints -// (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). +// endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) +// . type EndpointProperties struct { // The creation date and time of the endpoint. @@ -1181,8 +1127,8 @@ type EndpointProperties struct { // second. DesiredInferenceUnits *int32 - // ARN of the new model to use for updating an existing endpoint. This ARN is going - // to be different from the model ARN when the update is in progress + // ARN of the new model to use for updating an existing endpoint. This ARN is + // going to be different from the model ARN when the update is in progress DesiredModelArn *string // The Amazon Resource Number (ARN) of the endpoint. @@ -1266,7 +1212,7 @@ type EntitiesDetectionJobProperties struct { // The name that you assigned the entities detection job. JobName *string - // The current status of the entities detection job. If the status is FAILED, the + // The current status of the entities detection job. If the status is FAILED , the // Message field shows the reason for the failure. JobStatus JobStatus @@ -1287,18 +1233,15 @@ type EntitiesDetectionJobProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your entity detection job. For more information, - // see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1335,8 +1278,8 @@ type Entity struct { noSmithyDocumentSerde } -// Specifies one of the label or labels that categorize the personally identifiable -// information (PII) entity being analyzed. +// Specifies one of the label or labels that categorize the personally +// identifiable information (PII) entity being analyzed. type EntityLabel struct { // The name of the label. @@ -1481,32 +1424,28 @@ type EntityRecognizerInputDataConfig struct { // A list of augmented manifest files that provide training data for your custom // model. An augmented manifest file is a labeled dataset that is produced by // Amazon SageMaker Ground Truth. This parameter is required if you set DataFormat - // to AUGMENTED_MANIFEST. + // to AUGMENTED_MANIFEST . AugmentedManifests []AugmentedManifestsListItem // The format of your training data: - // - // * COMPREHEND_CSV: A CSV file that supplements - // your training documents. The CSV file contains information about the custom - // entities that your trained model will detect. The required format of the file - // depends on whether you are providing annotations or an entity list. If you use - // this value, you must provide your CSV file by using either the Annotations or - // EntityList parameters. You must provide your training documents by using the - // Documents parameter. - // - // * AUGMENTED_MANIFEST: A labeled dataset that is produced - // by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line - // is a complete JSON object that contains a training document and its labels. Each - // label annotates a named entity in the training document. If you use this value, - // you must provide the AugmentedManifests parameter in your request. - // - // If you don't - // specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default. + // - COMPREHEND_CSV : A CSV file that supplements your training documents. The + // CSV file contains information about the custom entities that your trained model + // will detect. The required format of the file depends on whether you are + // providing annotations or an entity list. If you use this value, you must provide + // your CSV file by using either the Annotations or EntityList parameters. You + // must provide your training documents by using the Documents parameter. + // - AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker + // Ground Truth. This file is in JSON lines format. Each line is a complete JSON + // object that contains a training document and its labels. Each label annotates a + // named entity in the training document. If you use this value, you must provide + // the AugmentedManifests parameter in your request. + // If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the + // default. DataFormat EntityRecognizerDataFormat // The S3 location of the folder that contains the training documents for your // custom entity recognizer. This parameter is required if you set DataFormat to - // COMPREHEND_CSV. + // COMPREHEND_CSV . Documents *EntityRecognizerDocuments // The S3 location of the CSV file that has the entity list for your custom entity @@ -1583,22 +1522,18 @@ type EntityRecognizerProperties struct { // The input data properties of an entity recognizer. InputDataConfig *EntityRecognizerInputDataConfig - // The language of the input documents. All documents must be in the same language. - // Only English ("en") is currently supported. + // The language of the input documents. All documents must be in the same + // language. Only English ("en") is currently supported. LanguageCode LanguageCode // A description of the status of the recognizer. Message *string - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // Output data configuration. @@ -1607,9 +1542,9 @@ type EntityRecognizerProperties struct { // Provides information about an entity recognizer. RecognizerMetadata *EntityRecognizerMetadata - // The Amazon Resource Name (ARN) of the source model. This model was imported from - // a different Amazon Web Services account to create the entity recognizer model in - // your Amazon Web Services account. + // The Amazon Resource Name (ARN) of the source model. This model was imported + // from a different Amazon Web Services account to create the entity recognizer + // model in your Amazon Web Services account. SourceModelArn *string // Provides the status of the entity recognizer. @@ -1631,18 +1566,15 @@ type EntityRecognizerProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your custom entity recognizer. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1679,8 +1611,8 @@ type EntityTypesEvaluationMetrics struct { // the worst score is 0. F1Score *float64 - // A measure of the usefulness of the recognizer results for a specific entity type - // in the test data. High precision means that the recognizer returned + // A measure of the usefulness of the recognizer results for a specific entity + // type in the test data. High precision means that the recognizer returned // substantially more relevant results than irrelevant ones. Precision *float64 @@ -1708,29 +1640,21 @@ type EntityTypesListItem struct { noSmithyDocumentSerde } -// Text extraction encountered one or more page-level errors in the input document. -// The ErrorCode contains one of the following values: -// -// * TEXTRACT_BAD_PAGE - -// Amazon Textract cannot read the page. For more information about page limits in -// Amazon Textract, see Page Quotas in Amazon Textract -// (https://docs.aws.amazon.com/textract/latest/dg/limits-document.html). -// -// * -// TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your -// throughput limit. For more information about throughput quotas in Amazon -// Textract, see Default quotas in Amazon Textract -// (https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html). -// -// * -// PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 -// characters maximum). -// -// * PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB. -// -// * -// INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API -// request again. +// Text extraction encountered one or more page-level errors in the input +// document. The ErrorCode contains one of the following values: +// - TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more +// information about page limits in Amazon Textract, see Page Quotas in Amazon +// Textract (https://docs.aws.amazon.com/textract/latest/dg/limits-document.html) +// . +// - TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded +// your throughput limit. For more information about throughput quotas in Amazon +// Textract, see Default quotas in Amazon Textract (https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html) +// . +// - PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 +// characters maximum). +// - PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB. +// - INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the +// API request again. type ErrorsListItem struct { // Error code for the cause of the error. @@ -1785,8 +1709,8 @@ type EventsDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the events detection job. It is a unique, // fully qualified identifier for the job. It includes the Amazon Web Services // account, Amazon Web Services Region, and the job ID. The format of the ARN is as - // follows: arn::comprehend:::events-detection-job/ The following is an example job - // ARN: + // follows: arn::comprehend:::events-detection-job/ The following is an example + // job ARN: // arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string @@ -1848,8 +1772,8 @@ type FlywheelFilter struct { // Filter the flywheel iterations based on creation time. type FlywheelIterationFilter struct { - // Filter the flywheel iterations to include iterations created after the specified - // time. + // Filter the flywheel iterations to include iterations created after the + // specified time. CreationTimeAfter *time.Time // Filter the flywheel iterations to include iterations created before the @@ -1993,9 +1917,8 @@ type FlywheelSummary struct { } // Information about the location of items on a document page. For additional -// information, see Geometry -// (https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html) in the Amazon -// Textract API reference. +// information, see Geometry (https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html) +// in the Amazon Textract API reference. type Geometry struct { // An axis-aligned coarse representation of the location of the recognized item on @@ -2015,48 +1938,41 @@ type InputDataConfig struct { // The Amazon S3 URI for the input data. The URI must be in same Region as the API // endpoint that you are calling. The URI can point to a single input file or it // can provide the prefix for a collection of data files. For example, if you use - // the URI S3://bucketName/prefix, if the prefix is a single file, Amazon + // the URI S3://bucketName/prefix , if the prefix is a single file, Amazon // Comprehend uses that file as input. If more than one file begins with the // prefix, Amazon Comprehend uses all of them as input. // // This member is required. S3Uri *string - // Provides configuration parameters to override the default actions for extracting - // text from PDF documents and image files. + // Provides configuration parameters to override the default actions for + // extracting text from PDF documents and image files. DocumentReaderConfig *DocumentReaderConfig // Specifies how the text in an input file should be processed: - // - // * ONE_DOC_PER_FILE - // - Each file is considered a separate document. Use this option when you are - // processing large documents, such as newspaper articles or scientific papers. - // - // * - // ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use - // this option when you are processing many short documents, such as text messages. + // - ONE_DOC_PER_FILE - Each file is considered a separate document. Use this + // option when you are processing large documents, such as newspaper articles or + // scientific papers. + // - ONE_DOC_PER_LINE - Each line in a file is considered a separate document. + // Use this option when you are processing many short documents, such as text + // messages. InputFormat InputFormat noSmithyDocumentSerde } // Provides additional detail about why the request failed: -// -// * Document size is too -// large - Check the size of your file and resubmit the request. -// -// * Document type -// is not supported - Check the file type and resubmit the request. -// -// * Too many -// pages in the document - Check the number of pages in your file and resubmit the -// request. -// -// * Access denied to Amazon Textract - Verify that your account has -// permission to use Amazon Textract API operations and resubmit the request. +// - Document size is too large - Check the size of your file and resubmit the +// request. +// - Document type is not supported - Check the file type and resubmit the +// request. +// - Too many pages in the document - Check the number of pages in your file and +// resubmit the request. +// - Access denied to Amazon Textract - Verify that your account has permission +// to use Amazon Textract API operations and resubmit the request. type InvalidRequestDetail struct { - // Reason code is INVALID_DOCUMENT. + // Reason code is INVALID_DOCUMENT . Reason InvalidRequestDetailReason noSmithyDocumentSerde @@ -2121,11 +2037,11 @@ type KeyPhrasesDetectionJobProperties struct { // detection job. InputDataConfig *InputDataConfig - // The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, - // fully qualified identifier for the job. It includes the Amazon Web Services - // account, Amazon Web Services Region, and the job ID. The format of the ARN is as - // follows: arn::comprehend:::key-phrases-detection-job/ The following is an - // example job ARN: + // The Amazon Resource Name (ARN) of the key phrases detection job. It is a + // unique, fully qualified identifier for the job. It includes the Amazon Web + // Services account, Amazon Web Services Region, and the job ID. The format of the + // ARN is as follows: arn::comprehend:::key-phrases-detection-job/ The following + // is an example job ARN: // arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string @@ -2135,7 +2051,7 @@ type KeyPhrasesDetectionJobProperties struct { // The name that you assigned the key phrases detection job. JobName *string - // The current status of the key phrases detection job. If the status is FAILED, + // The current status of the key phrases detection job. If the status is FAILED , // the Message field shows the reason for the failure. JobStatus JobStatus @@ -2145,8 +2061,8 @@ type KeyPhrasesDetectionJobProperties struct { // A description of the status of a job. Message *string - // The output data configuration that you supplied when you created the key phrases - // detection job. + // The output data configuration that you supplied when you created the key + // phrases detection job. OutputDataConfig *OutputDataConfig // The time that the key phrases detection job was submitted for processing. @@ -2155,27 +2071,23 @@ type KeyPhrasesDetectionJobProperties struct { // ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage // volume attached to the ML compute instance(s) that process the analysis job. The // VolumeKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your key phrases detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde } // Contains the sentiment and sentiment score for one mention of an entity. For -// more information about targeted sentiment, see Targeted sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +// more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) +// . type MentionSentiment struct { // The sentiment of the mention. @@ -2197,7 +2109,7 @@ type OutputDataConfig struct { // location is used as the prefix for the actual location of the output file. When // the topic detection job is finished, the service creates an output file in a // directory specific to the job. The S3Uri field contains the location of the - // output file, called output.tar.gz. It is a compressed archive that contains the + // output file, called output.tar.gz . It is a compressed archive that contains the // ouput of the operation. For a PII entity detection job, the output file is plain // text, not a compressed archive. The output file name is the same as the input // file, with .out appended at the end. @@ -2208,19 +2120,12 @@ type OutputDataConfig struct { // ID for the Amazon Web Services Key Management Service (KMS) key that Amazon // Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId // can be one of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // KMS Key Alias: "alias/ExampleAlias" - // - // * ARN of a KMS Key Alias: - // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key Alias: "alias/ExampleAlias" + // - ARN of a KMS Key Alias: + // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" KmsKeyId *string noSmithyDocumentSerde @@ -2229,8 +2134,8 @@ type OutputDataConfig struct { // Identifies the part of speech represented by the token and gives the confidence // that Amazon Comprehend has that the part of speech was correctly identified. For // more information about the parts of speech that Amazon Comprehend can identify, -// see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in -// the Comprehend Developer Guide. +// see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) +// in the Comprehend Developer Guide. type PartOfSpeechTag struct { // The confidence that Amazon Comprehend has that the part of speech was correctly @@ -2293,7 +2198,7 @@ type PiiEntitiesDetectionJobProperties struct { // The name that you assigned the PII entities detection job. JobName *string - // The current status of the PII entities detection job. If the status is FAILED, + // The current status of the PII entities detection job. If the status is FAILED , // the Message field shows the reason for the failure. JobStatus JobStatus @@ -2303,8 +2208,8 @@ type PiiEntitiesDetectionJobProperties struct { // A description of the status of a job. Message *string - // Specifies whether the output provides the locations (offsets) of PII entities or - // a file in which PII entities are redacted. + // Specifies whether the output provides the locations (offsets) of PII entities + // or a file in which PII entities are redacted. Mode PiiEntitiesDetectionMode // The output data configuration that you supplied when you created the PII @@ -2312,8 +2217,9 @@ type PiiEntitiesDetectionJobProperties struct { OutputDataConfig *PiiOutputDataConfig // Provides configuration parameters for PII entity redaction. This parameter is - // required if you set the Mode parameter to ONLY_REDACTION. In that case, you must - // provide a RedactionConfig definition that includes the PiiEntityTypes parameter. + // required if you set the Mode parameter to ONLY_REDACTION . In that case, you + // must provide a RedactionConfig definition that includes the PiiEntityTypes + // parameter. RedactionConfig *RedactionConfig // The time that the PII entities detection job was submitted for processing. @@ -2363,9 +2269,8 @@ type PiiOutputDataConfig struct { } // The X and Y coordinates of a point on a document page. For additional -// information, see Point -// (https://docs.aws.amazon.com/textract/latest/dg/API_Point.html) in the Amazon -// Textract API reference. +// information, see Point (https://docs.aws.amazon.com/textract/latest/dg/API_Point.html) +// in the Amazon Textract API reference. type Point struct { // The value of the X coordinate for a point on a polygon @@ -2458,7 +2363,7 @@ type SentimentDetectionJobProperties struct { // The name that you assigned to the sentiment detection job JobName *string - // The current status of the sentiment detection job. If the status is FAILED, the + // The current status of the sentiment detection job. If the status is FAILED , the // Messages field shows the reason for the failure. JobStatus JobStatus @@ -2479,18 +2384,15 @@ type SentimentDetectionJobProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your sentiment detection job. For more - // information, see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -2533,9 +2435,8 @@ type SyntaxToken struct { // Provides the part of speech label and the confidence level that Amazon // Comprehend has that the part of speech was correctly identified. For more - // information, see Syntax - // (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the - // Comprehend Developer Guide. + // information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) + // in the Comprehend Developer Guide. PartOfSpeech *PartOfSpeechTag // The word that was recognized in the source text. @@ -2622,7 +2523,7 @@ type TargetedSentimentDetectionJobProperties struct { JobName *string // The current status of the targeted sentiment detection job. If the status is - // FAILED, the Messages field shows the reason for the failure. + // FAILED , the Messages field shows the reason for the failure. JobStatus JobStatus // The language code of the input documents. @@ -2641,26 +2542,23 @@ type TargetedSentimentDetectionJobProperties struct { // storage volume attached to the ML compute instance(s) that process the targeted // sentiment detection job. The VolumeKmsKeyId can be either of the following // formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon - // Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for the job. For more information, see - // Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde } // Information about one of the entities found by targeted sentiment analysis. For -// more information about targeted sentiment, see Targeted sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +// more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) +// . type TargetedSentimentEntity struct { // One or more index into the Mentions array that provides the best name for the @@ -2668,18 +2566,17 @@ type TargetedSentimentEntity struct { DescriptiveMentionIndex []int32 // An array of mentions of the entity in the document. The array represents a - // co-reference group. See Co-reference group - // (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values) + // co-reference group. See Co-reference group (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values) // for an example. Mentions []TargetedSentimentMention noSmithyDocumentSerde } -// Information about one mention of an entity. The mention information includes the -// location of the mention in the text and the sentiment of the mention. For more -// information about targeted sentiment, see Targeted sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html). +// Information about one mention of an entity. The mention information includes +// the location of the mention in the text and the sentiment of the mention. For +// more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) +// . type TargetedSentimentMention struct { // The offset into the document text where the mention begins. @@ -2702,8 +2599,8 @@ type TargetedSentimentMention struct { // The text in the document that identifies the entity. Text *string - // The type of the entity. Amazon Comprehend supports a variety of entity types - // (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities). + // The type of the entity. Amazon Comprehend supports a variety of entity types (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities) + // . Type TargetedSentimentEntityType noSmithyDocumentSerde @@ -2766,8 +2663,8 @@ type TopicsDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the topics detection job. It is a unique, // fully qualified identifier for the job. It includes the Amazon Web Services // account, Amazon Web Services Region, and the job ID. The format of the ARN is as - // follows: arn::comprehend:::topics-detection-job/ The following is an example job - // ARN: + // follows: arn::comprehend:::topics-detection-job/ The following is an example + // job ARN: // arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string @@ -2777,7 +2674,7 @@ type TopicsDetectionJobProperties struct { // The name of the topic detection job. JobName *string - // The current status of the topic detection job. If the status is Failed, the + // The current status of the topic detection job. If the status is Failed , the // reason for the failure is shown in the Message field. JobStatus JobStatus @@ -2798,18 +2695,15 @@ type TopicsDetectionJobProperties struct { // Comprehend uses to encrypt data on the storage volume attached to the ML compute // instance(s) that process the analysis job. The VolumeKmsKeyId can be either of // the following formats: - // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your topic detection job. For more information, - // see Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -2818,15 +2712,11 @@ type TopicsDetectionJobProperties struct { // Data security configuration. type UpdateDataSecurityConfig struct { - // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. - // The ModelKmsKeyId can be either of the following formats: - // - // * KMS Key ID: - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key: - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom + // models. The ModelKmsKeyId can be either of the following formats: + // - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key: + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" ModelKmsKeyId *string // ID for the KMS key that Amazon Comprehend uses to encrypt the volume. @@ -2834,8 +2724,8 @@ type UpdateDataSecurityConfig struct { // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for the job. For more information, see - // Amazon VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). + // Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -2843,16 +2733,16 @@ type UpdateDataSecurityConfig struct { // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for the job. For more information, see -// Amazon VPC -// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). +// Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) +// . type VpcConfig struct { // The ID number for a security group on an instance of your private VPC. Security // groups on your VPC function serve as a virtual firewall to control inbound and // outbound traffic and provides security for the resources that you’ll be // accessing on the VPC. This ID number is preceded by "sg-", for instance: - // "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html). + // "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) + // . // // This member is required. SecurityGroupIds []string @@ -2861,7 +2751,7 @@ type VpcConfig struct { // of the a range of IPv4 addresses used by the VPC and is specific to a given // availability zone in the VPC’s Region. This ID number is preceded by "subnet-", // for instance: "subnet-04ccf456919e69055". For more information, see VPCs and - // Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). + // Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) . // // This member is required. Subnets []string diff --git a/service/comprehendmedical/api_client.go b/service/comprehendmedical/api_client.go index 4dd6a107ed7..1ab718956ff 100644 --- a/service/comprehendmedical/api_client.go +++ b/service/comprehendmedical/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/comprehendmedical/api_op_DetectEntities.go b/service/comprehendmedical/api_op_DetectEntities.go index e4f1002b1bb..1dd73d1ec3d 100644 --- a/service/comprehendmedical/api_op_DetectEntities.go +++ b/service/comprehendmedical/api_op_DetectEntities.go @@ -34,8 +34,8 @@ func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput type DetectEntitiesInput struct { - // A UTF-8 text string containing the clinical content being examined for entities. - // Each string must contain fewer than 20,000 bytes of characters. + // A UTF-8 text string containing the clinical content being examined for + // entities. Each string must contain fewer than 20,000 bytes of characters. // // This member is required. Text *string @@ -54,8 +54,8 @@ type DetectEntitiesOutput struct { // This member is required. Entities []types.Entity - // The version of the model used to analyze the documents. The version number looks - // like X.X.X. You can use this information to track the model used for a + // The version of the model used to analyze the documents. The version number + // looks like X.X.X. You can use this information to track the model used for a // particular batch of documents. // // This member is required. diff --git a/service/comprehendmedical/api_op_DetectEntitiesV2.go b/service/comprehendmedical/api_op_DetectEntitiesV2.go index e28738e05d6..d70a8da6085 100644 --- a/service/comprehendmedical/api_op_DetectEntitiesV2.go +++ b/service/comprehendmedical/api_op_DetectEntitiesV2.go @@ -37,8 +37,8 @@ func (c *Client) DetectEntitiesV2(ctx context.Context, params *DetectEntitiesV2I type DetectEntitiesV2Input struct { - // A UTF-8 string containing the clinical content being examined for entities. Each - // string must contain fewer than 20,000 bytes of characters. + // A UTF-8 string containing the clinical content being examined for entities. + // Each string must contain fewer than 20,000 bytes of characters. // // This member is required. Text *string @@ -57,8 +57,8 @@ type DetectEntitiesV2Output struct { // This member is required. Entities []types.Entity - // The version of the model used to analyze the documents. The version number looks - // like X.X.X. You can use this information to track the model used for a + // The version of the model used to analyze the documents. The version number + // looks like X.X.X. You can use this information to track the model used for a // particular batch of documents. // // This member is required. diff --git a/service/comprehendmedical/api_op_DetectPHI.go b/service/comprehendmedical/api_op_DetectPHI.go index 57bafa65639..235a1efea3e 100644 --- a/service/comprehendmedical/api_op_DetectPHI.go +++ b/service/comprehendmedical/api_op_DetectPHI.go @@ -50,8 +50,8 @@ type DetectPHIOutput struct { // This member is required. Entities []types.Entity - // The version of the model used to analyze the documents. The version number looks - // like X.X.X. You can use this information to track the model used for a + // The version of the model used to analyze the documents. The version number + // looks like X.X.X. You can use this information to track the model used for a // particular batch of documents. // // This member is required. diff --git a/service/comprehendmedical/api_op_InferICD10CM.go b/service/comprehendmedical/api_op_InferICD10CM.go index 14b4d65afed..b629cd3e66f 100644 --- a/service/comprehendmedical/api_op_InferICD10CM.go +++ b/service/comprehendmedical/api_op_InferICD10CM.go @@ -43,9 +43,9 @@ type InferICD10CMInput struct { type InferICD10CMOutput struct { - // The medical conditions detected in the text linked to ICD-10-CM concepts. If the - // action is successful, the service sends back an HTTP 200 response, as well as - // the entities detected. + // The medical conditions detected in the text linked to ICD-10-CM concepts. If + // the action is successful, the service sends back an HTTP 200 response, as well + // as the entities detected. // // This member is required. Entities []types.ICD10CMEntity @@ -55,8 +55,8 @@ type InferICD10CMOutput struct { // documents. ModelVersion *string - // If the result of the previous request to InferICD10CM was truncated, include the - // PaginationToken to fetch the next page of medical condition entities. + // If the result of the previous request to InferICD10CM was truncated, include + // the PaginationToken to fetch the next page of medical condition entities. PaginationToken *string // Metadata pertaining to the operation's result. diff --git a/service/comprehendmedical/api_op_InferRxNorm.go b/service/comprehendmedical/api_op_InferRxNorm.go index a4188eed7c2..7b44dce1167 100644 --- a/service/comprehendmedical/api_op_InferRxNorm.go +++ b/service/comprehendmedical/api_op_InferRxNorm.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// InferRxNorm detects medications as entities listed in a patient record and links -// to the normalized concept identifiers in the RxNorm database from the National -// Library of Medicine. Amazon Comprehend Medical only detects medical entities in -// English language texts. +// InferRxNorm detects medications as entities listed in a patient record and +// links to the normalized concept identifiers in the RxNorm database from the +// National Library of Medicine. Amazon Comprehend Medical only detects medical +// entities in English language texts. func (c *Client) InferRxNorm(ctx context.Context, params *InferRxNormInput, optFns ...func(*Options)) (*InferRxNormOutput, error) { if params == nil { params = &InferRxNormInput{} diff --git a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go index ac215250f1d..bdcd51a923d 100644 --- a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go +++ b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go @@ -34,20 +34,20 @@ type StartEntitiesDetectionV2JobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Comprehend Medical; read access to your input data. For more - // information, see Role-Based Permissions Required for Asynchronous Operations - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). + // information, see Role-Based Permissions Required for Asynchronous Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med) + // . // // This member is required. DataAccessRoleArn *string - // The input configuration that specifies the format and location of the input data - // for the job. + // The input configuration that specifies the format and location of the input + // data for the job. // // This member is required. InputDataConfig *types.InputDataConfig - // The language of the input documents. All documents must be in the same language. - // Comprehend Medical; processes files in US English (en). + // The language of the input documents. All documents must be in the same + // language. Comprehend Medical; processes files in US English (en). // // This member is required. LanguageCode types.LanguageCode diff --git a/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go index 85046a0c5b1..9f179a6841e 100644 --- a/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go +++ b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go @@ -34,8 +34,8 @@ type StartICD10CMInferenceJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Comprehend Medical; read access to your input data. For more - // information, see Role-Based Permissions Required for Asynchronous Operations - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). + // information, see Role-Based Permissions Required for Asynchronous Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med) + // . // // This member is required. DataAccessRoleArn *string diff --git a/service/comprehendmedical/api_op_StartPHIDetectionJob.go b/service/comprehendmedical/api_op_StartPHIDetectionJob.go index 292d4cc5e1d..7ed835410a9 100644 --- a/service/comprehendmedical/api_op_StartPHIDetectionJob.go +++ b/service/comprehendmedical/api_op_StartPHIDetectionJob.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an asynchronous job to detect protected health information (PHI). Use the -// DescribePHIDetectionJob operation to track the status of a job. +// Starts an asynchronous job to detect protected health information (PHI). Use +// the DescribePHIDetectionJob operation to track the status of a job. func (c *Client) StartPHIDetectionJob(ctx context.Context, params *StartPHIDetectionJobInput, optFns ...func(*Options)) (*StartPHIDetectionJobOutput, error) { if params == nil { params = &StartPHIDetectionJobInput{} @@ -33,8 +33,8 @@ type StartPHIDetectionJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Comprehend Medical; read access to your input data. For more - // information, see Role-Based Permissions Required for Asynchronous Operations - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). + // information, see Role-Based Permissions Required for Asynchronous Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med) + // . // // This member is required. DataAccessRoleArn *string diff --git a/service/comprehendmedical/api_op_StartRxNormInferenceJob.go b/service/comprehendmedical/api_op_StartRxNormInferenceJob.go index 5b3ecef9b6c..80d5efb34d8 100644 --- a/service/comprehendmedical/api_op_StartRxNormInferenceJob.go +++ b/service/comprehendmedical/api_op_StartRxNormInferenceJob.go @@ -34,8 +34,8 @@ type StartRxNormInferenceJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Comprehend Medical; read access to your input data. For more - // information, see Role-Based Permissions Required for Asynchronous Operations - // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med). + // information, see Role-Based Permissions Required for Asynchronous Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med) + // . // // This member is required. DataAccessRoleArn *string diff --git a/service/comprehendmedical/types/enums.go b/service/comprehendmedical/types/enums.go index 615f200de0c..20875537792 100644 --- a/service/comprehendmedical/types/enums.go +++ b/service/comprehendmedical/types/enums.go @@ -201,8 +201,8 @@ const ( ICD10CMEntityCategoryMedicalCondition ICD10CMEntityCategory = "MEDICAL_CONDITION" ) -// Values returns all known values for ICD10CMEntityCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ICD10CMEntityCategory. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ICD10CMEntityCategory) Values() []ICD10CMEntityCategory { return []ICD10CMEntityCategory{ @@ -287,9 +287,9 @@ const ( JobStatusStopped JobStatus = "STOPPED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -309,9 +309,9 @@ const ( LanguageCodeEn LanguageCode = "en" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "en", @@ -462,8 +462,8 @@ const ( SNOMEDCTAttributeTypeTestUnit SNOMEDCTAttributeType = "TEST_UNIT" ) -// Values returns all known values for SNOMEDCTAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SNOMEDCTAttributeType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SNOMEDCTAttributeType) Values() []SNOMEDCTAttributeType { return []SNOMEDCTAttributeType{ @@ -530,9 +530,9 @@ const ( SNOMEDCTRelationshipTypeSystemOrganSite SNOMEDCTRelationshipType = "SYSTEM_ORGAN_SITE" ) -// Values returns all known values for SNOMEDCTRelationshipType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SNOMEDCTRelationshipType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SNOMEDCTRelationshipType) Values() []SNOMEDCTRelationshipType { return []SNOMEDCTRelationshipType{ "ACUITY", diff --git a/service/comprehendmedical/types/errors.go b/service/comprehendmedical/types/errors.go index 1fbf57033d0..caaa2fb3ccf 100644 --- a/service/comprehendmedical/types/errors.go +++ b/service/comprehendmedical/types/errors.go @@ -114,8 +114,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Comprehend Medical; service is temporarily unavailable. Please wait and then -// retry your request. +// The Comprehend Medical; service is temporarily unavailable. Please wait and +// then retry your request. type ServiceUnavailableException struct { Message *string diff --git a/service/comprehendmedical/types/types.go b/service/comprehendmedical/types/types.go index 2c2c4971abd..0886dad2f64 100644 --- a/service/comprehendmedical/types/types.go +++ b/service/comprehendmedical/types/types.go @@ -7,10 +7,10 @@ import ( "time" ) -// An extracted segment of the text that is an attribute of an entity, or otherwise -// related to an entity, such as the dosage of a medication taken. It contains -// information about the attribute such as id, begin and end offset within the -// input text, and the segment of the input text. +// An extracted segment of the text that is an attribute of an entity, or +// otherwise related to an entity, such as the dosage of a medication taken. It +// contains information about the attribute such as id, begin and end offset within +// the input text, and the segment of the input text. type Attribute struct { // The 0-based character offset in the input text that shows where the attribute @@ -24,8 +24,8 @@ type Attribute struct { // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 - // The numeric identifier for this attribute. This is a monotonically increasing id - // unique within this response rather than a global unique identifier. + // The numeric identifier for this attribute. This is a monotonically increasing + // id unique within this response rather than a global unique identifier. Id *int32 // The level of confidence that Comprehend Medical; has that this attribute is @@ -33,12 +33,12 @@ type Attribute struct { RelationshipScore *float32 // The type of relationship between the entity and attribute. Type for the - // relationship is OVERLAP, indicating that the entity occurred at the same time as - // the Date_Expression. + // relationship is OVERLAP , indicating that the entity occurred at the same time + // as the Date_Expression . RelationshipType RelationshipType - // The level of confidence that Comprehend Medical; has that the segment of text is - // correctly recognized as an attribute. + // The level of confidence that Comprehend Medical; has that the segment of text + // is correctly recognized as an attribute. Score *float32 // The segment of input text extracted as this attribute. @@ -112,7 +112,7 @@ type ComprehendMedicalAsyncJobProperties struct { // The name that you assigned to the detection job. JobName *string - // The current status of the detection job. If the status is FAILED, the Message + // The current status of the detection job. If the status is FAILED , the Message // field shows the reason for the failure. JobStatus JobStatus @@ -128,8 +128,8 @@ type ComprehendMedicalAsyncJobProperties struct { // A description of the status of a job. Message *string - // The version of the model used to analyze the documents. The version number looks - // like X.X.X. You can use this information to track the model used for a + // The version of the model used to analyze the documents. The version number + // looks like X.X.X. You can use this information to track the model used for a // particular batch of documents. ModelVersion *string @@ -156,8 +156,8 @@ type Entity struct { // The category of the entity. Category EntityType - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. + // The 0-based character offset in the input text that shows where the entity + // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 // The numeric identifier for the entity. This is a monotonically increasing id @@ -182,23 +182,23 @@ type Entity struct { // The detected attributes that relate to an entity. This includes an extracted // segment of the text that is an attribute of an entity, or otherwise related to -// an entity. InferICD10CM detects the following attributes: Direction, System, -// Organ or Site, and Acuity. +// an entity. InferICD10CM detects the following attributes: Direction , System, +// Organ or Site , and Acuity . type ICD10CMAttribute struct { // The 0-based character offset in the input text that shows where the attribute // begins. The offset returns the UTF-8 code point in the string. BeginOffset *int32 - // The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION. + // The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION . Category ICD10CMEntityType // The 0-based character offset in the input text that shows where the attribute // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 - // The numeric identifier for this attribute. This is a monotonically increasing id - // unique within this response rather than a global unique identifier. + // The numeric identifier for this attribute. This is a monotonically increasing + // id unique within this response rather than a global unique identifier. Id *int32 // The level of confidence that Amazon Comprehend Medical has that this attribute @@ -206,7 +206,7 @@ type ICD10CMAttribute struct { RelationshipScore *float32 // The type of relationship between the entity and attribute. Type for the - // relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE. + // relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE . RelationshipType ICD10CMRelationshipType // The level of confidence that Amazon Comprehend Medical has that the segment of @@ -217,10 +217,10 @@ type ICD10CMAttribute struct { Text *string // The contextual information for the attribute. The traits recognized by - // InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. + // InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION . Traits []ICD10CMTrait - // The type of attribute. InferICD10CM detects entities of the type DX_NAME. + // The type of attribute. InferICD10CM detects entities of the type DX_NAME . Type ICD10CMAttributeType noSmithyDocumentSerde @@ -264,8 +264,8 @@ type ICD10CMEntity struct { // MEDICAL_CONDITION category. Category ICD10CMEntityCategory - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. + // The 0-based character offset in the input text that shows where the entity + // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 // The ICD-10-CM concepts that the entity could refer to, along with a score @@ -284,25 +284,25 @@ type ICD10CMEntity struct { Text *string // Provides Contextual information for the entity. The traits recognized by - // InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. + // InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION. Traits []ICD10CMTrait // Describes the specific type of entity with category of entities. InferICD10CM - // detects entities of the type DX_NAME and TIME_EXPRESSION. + // detects entities of the type DX_NAME and TIME_EXPRESSION . Type ICD10CMEntityType noSmithyDocumentSerde } -// Contextual information for the entity. The traits recognized by InferICD10CM are -// DIAGNOSIS, SIGN, SYMPTOM, and NEGATION. +// Contextual information for the entity. The traits recognized by InferICD10CM +// are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION . type ICD10CMTrait struct { // Provides a name or contextual description about the trait. Name ICD10CMTraitName - // The level of confidence that Comprehend Medical; has that the segment of text is - // correctly recognized as a trait. + // The level of confidence that Comprehend Medical; has that the segment of text + // is correctly recognized as a trait. Score *float32 noSmithyDocumentSerde @@ -312,10 +312,10 @@ type ICD10CMTrait struct { // the S3 bucket and the path to the files to be analyzed. type InputDataConfig struct { - // The URI of the S3 bucket that contains the input data. The bucket must be in the - // same region as the API endpoint that you are calling. Each file in the document - // collection must be less than 40 KB. You can store a maximum of 30 GB in the - // bucket. + // The URI of the S3 bucket that contains the input data. The bucket must be in + // the same region as the API endpoint that you are calling. Each file in the + // document collection must be less than 40 KB. You can store a maximum of 30 GB in + // the bucket. // // This member is required. S3Bucket *string @@ -346,7 +346,7 @@ type OutputDataConfig struct { } // The extracted attributes that relate to this entity. The attributes recognized -// by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE. +// by InferRxNorm are DOSAGE , DURATION , FORM , FREQUENCY , RATE , ROUTE_OR_MODE . type RxNormAttribute struct { // The 0-based character offset in the input text that shows where the attribute @@ -357,12 +357,12 @@ type RxNormAttribute struct { // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 - // The numeric identifier for this attribute. This is a monotonically increasing id - // unique within this response rather than a global unique identifier. + // The numeric identifier for this attribute. This is a monotonically increasing + // id unique within this response rather than a global unique identifier. Id *int32 - // The level of confidence that Amazon Comprehend Medical has that the attribute is - // accurately linked to an entity. + // The level of confidence that Amazon Comprehend Medical has that the attribute + // is accurately linked to an entity. RelationshipScore *float32 // The level of confidence that Comprehend Medical has that the segment of text is @@ -378,14 +378,14 @@ type RxNormAttribute struct { Traits []RxNormTrait // The type of attribute. The types of attributes recognized by InferRxNorm are - // BRAND_NAME and GENERIC_NAME. + // BRAND_NAME and GENERIC_NAME . Type RxNormAttributeType noSmithyDocumentSerde } -// The RxNorm concept that the entity could refer to, along with a score indicating -// the likelihood of the match. +// The RxNorm concept that the entity could refer to, along with a score +// indicating the likelihood of the match. type RxNormConcept struct { // RxNorm concept ID, also known as the RxCUI. @@ -408,20 +408,20 @@ type RxNormConcept struct { // Attributes and traits of the entity are also returned. type RxNormEntity struct { - // The extracted attributes that relate to the entity. The attributes recognized by - // InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and - // STRENGTH. + // The extracted attributes that relate to the entity. The attributes recognized + // by InferRxNorm are DOSAGE , DURATION , FORM , FREQUENCY , RATE , ROUTE_OR_MODE , + // and STRENGTH . Attributes []RxNormAttribute // The 0-based character offset in the input text that shows where the entity // begins. The offset returns the UTF-8 code point in the string. BeginOffset *int32 - // The category of the entity. The recognized categories are GENERIC or BRAND_NAME. + // The category of the entity. The recognized categories are GENERIC or BRAND_NAME . Category RxNormEntityCategory - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. + // The 0-based character offset in the input text that shows where the entity + // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 // The numeric identifier for the entity. This is a monotonically increasing id @@ -443,14 +443,14 @@ type RxNormEntity struct { Traits []RxNormTrait // Describes the specific type of entity. For InferRxNorm, the recognized entity - // type is MEDICATION. + // type is MEDICATION . Type RxNormEntityType noSmithyDocumentSerde } // The contextual information for the entity. InferRxNorm recognizes the trait -// NEGATION, which is any indication that the patient is not taking a medication. +// NEGATION , which is any indication that the patient is not taking a medication. type RxNormTrait struct { // Provides a name or contextual description about the trait. @@ -480,8 +480,8 @@ type SNOMEDCTAttribute struct { // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 - // The numeric identifier for this attribute. This is a monotonically increasing id - // unique within this response rather than a global unique identifier. + // The numeric identifier for this attribute. This is a monotonically increasing + // id unique within this response rather than a global unique identifier. Id *int32 // The level of confidence that Comprehend Medical has that this attribute is @@ -558,8 +558,8 @@ type SNOMEDCTDetails struct { // and traits of the entity are also returned. type SNOMEDCTEntity struct { - // An extracted segment of the text that is an attribute of an entity, or otherwise - // related to an entity, such as the dosage of a medication taken. + // An extracted segment of the text that is an attribute of an entity, or + // otherwise related to an entity, such as the dosage of a medication taken. Attributes []SNOMEDCTAttribute // The 0-based character offset in the input text that shows where the entity @@ -570,8 +570,8 @@ type SNOMEDCTEntity struct { // ANATOMY, or TEST_TREATMENT_PROCEDURE. Category SNOMEDCTEntityCategory - // The 0-based character offset in the input text that shows where the entity ends. - // The offset returns the UTF-8 code point in the string. + // The 0-based character offset in the input text that shows where the entity + // ends. The offset returns the UTF-8 code point in the string. EndOffset *int32 // The numeric identifier for the entity. This is a monotonically increasing id @@ -626,8 +626,8 @@ type Trait struct { noSmithyDocumentSerde } -// An attribute that was extracted, but Comprehend Medical; was unable to relate to -// an entity. +// An attribute that was extracted, but Comprehend Medical; was unable to relate +// to an entity. type UnmappedAttribute struct { // The specific attribute that has been extracted but not mapped to an entity. diff --git a/service/computeoptimizer/api_client.go b/service/computeoptimizer/api_client.go index 2ecf50e8623..a8c7700089b 100644 --- a/service/computeoptimizer/api_client.go +++ b/service/computeoptimizer/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go b/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go index d5e2b29092d..d1850e79300 100644 --- a/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go @@ -12,8 +12,7 @@ import ( ) // Deletes a recommendation preference, such as enhanced infrastructure metrics. -// For more information, see Activating enhanced infrastructure metrics -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) +// For more information, see Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. func (c *Client) DeleteRecommendationPreferences(ctx context.Context, params *DeleteRecommendationPreferencesInput, optFns ...func(*Options)) (*DeleteRecommendationPreferencesOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type DeleteRecommendationPreferencesInput struct { // Ec2Instance option encompasses standalone instances and instances that are part // of Auto Scaling groups. The AutoScalingGroup option encompasses only instances // that are part of an Auto Scaling group. The valid values for this parameter are - // Ec2Instance and AutoScalingGroup. + // Ec2Instance and AutoScalingGroup . // // This member is required. ResourceType types.ResourceType @@ -50,8 +49,7 @@ type DeleteRecommendationPreferencesInput struct { // You can delete recommendation preferences that are created at the organization // level (for management accounts of an organization only), account level, and // resource level. For more information, see Activating enhanced infrastructure - // metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. Scope *types.Scope diff --git a/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go index 502033f899f..c46b5cb5bb5 100644 --- a/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go @@ -15,8 +15,7 @@ import ( // are exported in a comma-separated values (.csv) file, and its metadata in a // JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple // Storage Service (Amazon S3) bucket that you specify. For more information, see -// Exporting Recommendations -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) +// Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) // in the Compute Optimizer User Guide. You can have only one Auto Scaling group // export job in progress per Amazon Web Services Region. func (c *Client) ExportAutoScalingGroupRecommendations(ctx context.Context, params *ExportAutoScalingGroupRecommendationsInput, optFns ...func(*Options)) (*ExportAutoScalingGroupRecommendationsOutput, error) { @@ -43,9 +42,8 @@ type ExportAutoScalingGroupRecommendationsInput struct { // the S3 bucket, ensure that it has the required permissions policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the policy that you add to the S3 bucket. For more information, see Amazon + // S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. // // This member is required. @@ -62,17 +60,16 @@ type ExportAutoScalingGroupRecommendationsInput struct { AccountIds []string // The recommendations data to include in the export file. For more information - // about the fields that can be exported, see Exported files - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) + // about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) // in the Compute Optimizer User Guide. FieldsToExport []types.ExportableAutoScalingGroupField // The format of the export file. The only export file format currently supported - // is Csv. + // is Csv . FileFormat types.FileFormat - // An array of objects to specify a filter that exports a more specific set of Auto - // Scaling group recommendations. + // An array of objects to specify a filter that exports a more specific set of + // Auto Scaling group recommendations. Filters []types.Filter // Indicates whether to include recommendations for resources in all member @@ -80,8 +77,7 @@ type ExportAutoScalingGroupRecommendationsInput struct { // organization. The member accounts must also be opted in to Compute Optimizer, // and trusted access for Compute Optimizer must be enabled in the organization // account. For more information, see Compute Optimizer and Amazon Web Services - // Organizations trusted access - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) + // Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) // in the Compute Optimizer User Guide. Recommendations for member accounts of the // organization are not included in the export file if this parameter is omitted. // This parameter cannot be specified together with the account IDs parameter. The diff --git a/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go b/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go index 64a4c07d3af..d3059098819 100644 --- a/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go +++ b/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports optimization recommendations for Amazon EBS volumes. Recommendations are -// exported in a comma-separated values (.csv) file, and its metadata in a +// Exports optimization recommendations for Amazon EBS volumes. Recommendations +// are exported in a comma-separated values (.csv) file, and its metadata in a // JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple // Storage Service (Amazon S3) bucket that you specify. For more information, see -// Exporting Recommendations -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) +// Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) // in the Compute Optimizer User Guide. You can have only one Amazon EBS volume // export job in progress per Amazon Web Services Region. func (c *Client) ExportEBSVolumeRecommendations(ctx context.Context, params *ExportEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*ExportEBSVolumeRecommendationsOutput, error) { @@ -43,9 +42,8 @@ type ExportEBSVolumeRecommendationsInput struct { // the S3 bucket, ensure that it has the required permission policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the policy that you add to the S3 bucket. For more information, see Amazon + // S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. // // This member is required. @@ -62,13 +60,12 @@ type ExportEBSVolumeRecommendationsInput struct { AccountIds []string // The recommendations data to include in the export file. For more information - // about the fields that can be exported, see Exported files - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) + // about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) // in the Compute Optimizer User Guide. FieldsToExport []types.ExportableVolumeField // The format of the export file. The only export file format currently supported - // is Csv. + // is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -80,8 +77,7 @@ type ExportEBSVolumeRecommendationsInput struct { // organization. The member accounts must also be opted in to Compute Optimizer, // and trusted access for Compute Optimizer must be enabled in the organization // account. For more information, see Compute Optimizer and Amazon Web Services - // Organizations trusted access - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) + // Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) // in the Compute Optimizer User Guide. Recommendations for member accounts of the // organization are not included in the export file if this parameter is omitted. // This parameter cannot be specified together with the account IDs parameter. The diff --git a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go index 5a0d16ea5a5..59652b4653d 100644 --- a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go @@ -15,8 +15,7 @@ import ( // are exported in a comma-separated values (.csv) file, and its metadata in a // JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple // Storage Service (Amazon S3) bucket that you specify. For more information, see -// Exporting Recommendations -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) +// Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) // in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance // export job in progress per Amazon Web Services Region. func (c *Client) ExportEC2InstanceRecommendations(ctx context.Context, params *ExportEC2InstanceRecommendationsInput, optFns ...func(*Options)) (*ExportEC2InstanceRecommendationsOutput, error) { @@ -43,9 +42,8 @@ type ExportEC2InstanceRecommendationsInput struct { // the S3 bucket, ensure that it has the required permissions policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the policy that you add to the S3 bucket. For more information, see Amazon + // S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. // // This member is required. @@ -62,13 +60,12 @@ type ExportEC2InstanceRecommendationsInput struct { AccountIds []string // The recommendations data to include in the export file. For more information - // about the fields that can be exported, see Exported files - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) + // about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) // in the Compute Optimizer User Guide. FieldsToExport []types.ExportableInstanceField // The format of the export file. The only export file format currently supported - // is Csv. + // is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -80,16 +77,15 @@ type ExportEC2InstanceRecommendationsInput struct { // organization. The member accounts must also be opted in to Compute Optimizer, // and trusted access for Compute Optimizer must be enabled in the organization // account. For more information, see Compute Optimizer and Amazon Web Services - // Organizations trusted access - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) + // Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) // in the Compute Optimizer User Guide. Recommendations for member accounts of the // organization are not included in the export file if this parameter is omitted. // Recommendations for member accounts are not included in the export if this // parameter, or the account IDs parameter, is omitted. IncludeMemberAccounts bool - // An object to specify the preferences for the Amazon EC2 instance recommendations - // to export. + // An object to specify the preferences for the Amazon EC2 instance + // recommendations to export. RecommendationPreferences *types.RecommendationPreferences noSmithyDocumentSerde diff --git a/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go b/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go index 17bd5786bf7..95fb8cbbebc 100644 --- a/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go +++ b/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go @@ -14,8 +14,7 @@ import ( // Exports optimization recommendations for Amazon ECS services on Fargate. // Recommendations are exported in a CSV file, and its metadata in a JSON file, to // an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. -// For more information, see Exporting Recommendations -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) +// For more information, see Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) // in the Compute Optimizer User Guide. You can only have one Amazon ECS service // export job in progress per Amazon Web Services Region. func (c *Client) ExportECSServiceRecommendations(ctx context.Context, params *ExportECSServiceRecommendationsInput, optFns ...func(*Options)) (*ExportECSServiceRecommendationsOutput, error) { @@ -42,9 +41,8 @@ type ExportECSServiceRecommendationsInput struct { // the S3 bucket, ensure that it has the required permission policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the policy that you add to the S3 bucket. For more information, see Amazon + // S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. // // This member is required. @@ -61,8 +59,7 @@ type ExportECSServiceRecommendationsInput struct { AccountIds []string // The recommendations data to include in the export file. For more information - // about the fields that can be exported, see Exported files - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) + // about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) // in the Compute Optimizer User Guide. FieldsToExport []types.ExportableECSServiceField @@ -79,8 +76,7 @@ type ExportECSServiceRecommendationsInput struct { // resources in all member accounts of the organization. The member accounts must // also be opted in to Compute Optimizer, and trusted access for Compute Optimizer // must be enabled in the organization account. For more information, see Compute - // Optimizer and Amazon Web Services Organizations trusted access - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) + // Optimizer and Amazon Web Services Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) // in the Compute Optimizer User Guide. If this parameter is omitted, // recommendations for member accounts of the organization aren't included in the // export file. If this parameter or the account ID parameter is omitted, diff --git a/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go b/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go index 7dc92a79c7a..e7605586541 100644 --- a/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go +++ b/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go @@ -15,8 +15,7 @@ import ( // exported in a comma-separated values (.csv) file, and its metadata in a // JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple // Storage Service (Amazon S3) bucket that you specify. For more information, see -// Exporting Recommendations -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) +// Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html) // in the Compute Optimizer User Guide. You can have only one Lambda function // export job in progress per Amazon Web Services Region. func (c *Client) ExportLambdaFunctionRecommendations(ctx context.Context, params *ExportLambdaFunctionRecommendationsInput, optFns ...func(*Options)) (*ExportLambdaFunctionRecommendationsOutput, error) { @@ -43,9 +42,8 @@ type ExportLambdaFunctionRecommendationsInput struct { // the S3 bucket, ensure that it has the required permission policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix - // in the policy that you add to the S3 bucket. For more information, see Amazon S3 - // Bucket Policy for Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) + // in the policy that you add to the S3 bucket. For more information, see Amazon + // S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. // // This member is required. @@ -62,13 +60,12 @@ type ExportLambdaFunctionRecommendationsInput struct { AccountIds []string // The recommendations data to include in the export file. For more information - // about the fields that can be exported, see Exported files - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) + // about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files) // in the Compute Optimizer User Guide. FieldsToExport []types.ExportableLambdaFunctionField // The format of the export file. The only export file format currently supported - // is Csv. + // is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -80,8 +77,7 @@ type ExportLambdaFunctionRecommendationsInput struct { // organization. The member accounts must also be opted in to Compute Optimizer, // and trusted access for Compute Optimizer must be enabled in the organization // account. For more information, see Compute Optimizer and Amazon Web Services - // Organizations trusted access - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) + // Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access) // in the Compute Optimizer User Guide. Recommendations for member accounts of the // organization are not included in the export file if this parameter is omitted. // This parameter cannot be specified together with the account IDs parameter. The diff --git a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go index 4e7fcc16d6d..ecd5d935a78 100644 --- a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go @@ -13,9 +13,8 @@ import ( // Returns Auto Scaling group recommendations. Compute Optimizer generates // recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of -// requirements. For more information, see the Supported resources and requirements -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in -// the Compute Optimizer User Guide. +// requirements. For more information, see the Supported resources and requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) +// in the Compute Optimizer User Guide. func (c *Client) GetAutoScalingGroupRecommendations(ctx context.Context, params *GetAutoScalingGroupRecommendationsInput, optFns ...func(*Options)) (*GetAutoScalingGroupRecommendationsOutput, error) { if params == nil { params = &GetAutoScalingGroupRecommendationsInput{} @@ -33,11 +32,11 @@ func (c *Client) GetAutoScalingGroupRecommendations(ctx context.Context, params type GetAutoScalingGroupRecommendationsInput struct { - // The ID of the Amazon Web Services account for which to return Auto Scaling group - // recommendations. If your account is the management account of an organization, - // use this parameter to specify the member account for which you want to return - // Auto Scaling group recommendations. Only one account ID can be specified per - // request. + // The ID of the Amazon Web Services account for which to return Auto Scaling + // group recommendations. If your account is the management account of an + // organization, use this parameter to specify the member account for which you + // want to return Auto Scaling group recommendations. Only one account ID can be + // specified per request. AccountIds []string // The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return @@ -48,8 +47,8 @@ type GetAutoScalingGroupRecommendationsInput struct { // Auto Scaling group recommendations. Filters []types.Filter - // The maximum number of Auto Scaling group recommendations to return with a single - // request. To retrieve the remaining results, make another request with the + // The maximum number of Auto Scaling group recommendations to return with a + // single request. To retrieve the remaining results, make another request with the // returned nextToken value. MaxResults *int32 diff --git a/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go b/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go index 160fe099e56..3622fcf751a 100644 --- a/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go +++ b/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go @@ -14,9 +14,8 @@ import ( // Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. Compute // Optimizer generates recommendations for Amazon EBS volumes that meet a specific // set of requirements. For more information, see the Supported resources and -// requirements -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in -// the Compute Optimizer User Guide. +// requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) +// in the Compute Optimizer User Guide. func (c *Client) GetEBSVolumeRecommendations(ctx context.Context, params *GetEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*GetEBSVolumeRecommendationsOutput, error) { if params == nil { params = &GetEBSVolumeRecommendationsInput{} @@ -44,9 +43,9 @@ type GetEBSVolumeRecommendationsInput struct { // volume recommendations. Filters []types.EBSFilter - // The maximum number of volume recommendations to return with a single request. To - // retrieve the remaining results, make another request with the returned nextToken - // value. + // The maximum number of volume recommendations to return with a single request. + // To retrieve the remaining results, make another request with the returned + // nextToken value. MaxResults *int32 // The token to advance to the next page of volume recommendations. diff --git a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go index ae16882e07b..b7488a25606 100644 --- a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go @@ -14,9 +14,8 @@ import ( // Returns Amazon EC2 instance recommendations. Compute Optimizer generates // recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that // meet a specific set of requirements. For more information, see the Supported -// resources and requirements -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in -// the Compute Optimizer User Guide. +// resources and requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) +// in the Compute Optimizer User Guide. func (c *Client) GetEC2InstanceRecommendations(ctx context.Context, params *GetEC2InstanceRecommendationsInput, optFns ...func(*Options)) (*GetEC2InstanceRecommendationsOutput, error) { if params == nil { params = &GetEC2InstanceRecommendationsInput{} @@ -56,8 +55,8 @@ type GetEC2InstanceRecommendationsInput struct { // The token to advance to the next page of instance recommendations. NextToken *string - // An object to specify the preferences for the Amazon EC2 instance recommendations - // to return in the response. + // An object to specify the preferences for the Amazon EC2 instance + // recommendations to return in the response. RecommendationPreferences *types.RecommendationPreferences noSmithyDocumentSerde diff --git a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go index 34289af7be1..b383243c864 100644 --- a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go +++ b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go @@ -17,8 +17,8 @@ import ( // metrics returned when you run this action. Additionally, the Memory metric is // returned only for resources that have the unified CloudWatch agent installed on // them. For more information, see Enabling Memory Utilization with the CloudWatch -// Agent -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). +// Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) +// . func (c *Client) GetEC2RecommendationProjectedMetrics(ctx context.Context, params *GetEC2RecommendationProjectedMetricsInput, optFns ...func(*Options)) (*GetEC2RecommendationProjectedMetricsOutput, error) { if params == nil { params = &GetEC2RecommendationProjectedMetricsInput{} @@ -62,8 +62,8 @@ type GetEC2RecommendationProjectedMetricsInput struct { // This member is required. Stat types.MetricStatistic - // An object to specify the preferences for the Amazon EC2 recommendation projected - // metrics to return in the response. + // An object to specify the preferences for the Amazon EC2 recommendation + // projected metrics to return in the response. RecommendationPreferences *types.RecommendationPreferences noSmithyDocumentSerde diff --git a/service/computeoptimizer/api_op_GetECSServiceRecommendations.go b/service/computeoptimizer/api_op_GetECSServiceRecommendations.go index 193bb9f9212..509ff58638a 100644 --- a/service/computeoptimizer/api_op_GetECSServiceRecommendations.go +++ b/service/computeoptimizer/api_op_GetECSServiceRecommendations.go @@ -13,9 +13,8 @@ import ( // Returns Amazon ECS service recommendations. Compute Optimizer generates // recommendations for Amazon ECS services on Fargate that meet a specific set of -// requirements. For more information, see the Supported resources and requirements -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in -// the Compute Optimizer User Guide. +// requirements. For more information, see the Supported resources and requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) +// in the Compute Optimizer User Guide. func (c *Client) GetECSServiceRecommendations(ctx context.Context, params *GetECSServiceRecommendationsInput, optFns ...func(*Options)) (*GetECSServiceRecommendationsOutput, error) { if params == nil { params = &GetECSServiceRecommendationsInput{} @@ -44,8 +43,8 @@ type GetECSServiceRecommendationsInput struct { // Amazon ECS service recommendations. Filters []types.ECSServiceRecommendationFilter - // The maximum number of Amazon ECS service recommendations to return with a single - // request. To retrieve the remaining results, make another request with the + // The maximum number of Amazon ECS service recommendations to return with a + // single request. To retrieve the remaining results, make another request with the // returned nextToken value. MaxResults *int32 diff --git a/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go b/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go index bdebd2129be..6efda2d11c9 100644 --- a/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go @@ -15,8 +15,8 @@ import ( // such as enhanced infrastructure metrics. Considers all applicable preferences // that you might have set at the resource, account, and organization level. When // you create a recommendation preference, you can set its status to Active or -// Inactive. Use this action to view the recommendation preferences that are in -// effect, or Active. +// Inactive . Use this action to view the recommendation preferences that are in +// effect, or Active . func (c *Client) GetEffectiveRecommendationPreferences(ctx context.Context, params *GetEffectiveRecommendationPreferencesInput, optFns ...func(*Options)) (*GetEffectiveRecommendationPreferencesOutput, error) { if params == nil { params = &GetEffectiveRecommendationPreferencesInput{} @@ -48,14 +48,13 @@ type GetEffectiveRecommendationPreferencesOutput struct { // The status of the enhanced infrastructure metrics recommendation preference. // Considers all applicable preferences that you might have set at the resource, - // account, and organization level. A status of Active confirms that the preference - // is applied in the latest recommendation refresh, and a status of Inactive - // confirms that it's not yet applied to recommendations. To validate whether the - // preference is applied to your last generated set of recommendations, review the - // effectiveRecommendationPreferences value in the response of the + // account, and organization level. A status of Active confirms that the + // preference is applied in the latest recommendation refresh, and a status of + // Inactive confirms that it's not yet applied to recommendations. To validate + // whether the preference is applied to your last generated set of recommendations, + // review the effectiveRecommendationPreferences value in the response of the // GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions. - // For more information, see Enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // For more information, see Enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. EnhancedInfrastructureMetrics types.EnhancedInfrastructureMetrics @@ -67,8 +66,7 @@ type GetEffectiveRecommendationPreferencesOutput struct { // the response. To validate whether the preference is applied to your last // generated set of recommendations, review the effectiveRecommendationPreferences // value in the response of the GetEC2InstanceRecommendations actions. For more - // information, see Enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html) + // information, see Enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html) // in the Compute Optimizer User Guide. ExternalMetricsPreference *types.ExternalMetricsPreference diff --git a/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go b/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go index cefafbf5f5c..86fb7cd44a5 100644 --- a/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go +++ b/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go @@ -50,8 +50,8 @@ type GetEnrollmentStatusesForOrganizationInput struct { type GetEnrollmentStatusesForOrganizationOutput struct { - // An array of objects that describe the enrollment statuses of organization member - // accounts. + // An array of objects that describe the enrollment statuses of organization + // member accounts. AccountEnrollmentStatuses []types.AccountEnrollmentStatus // The token to use to advance to the next page of account enrollment statuses. diff --git a/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go b/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go index 8f0e38fb369..eeea65a9b37 100644 --- a/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go +++ b/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go @@ -14,9 +14,8 @@ import ( // Returns Lambda function recommendations. Compute Optimizer generates // recommendations for functions that meet a specific set of requirements. For more -// information, see the Supported resources and requirements -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in -// the Compute Optimizer User Guide. +// information, see the Supported resources and requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) +// in the Compute Optimizer User Guide. func (c *Client) GetLambdaFunctionRecommendations(ctx context.Context, params *GetLambdaFunctionRecommendationsInput, optFns ...func(*Options)) (*GetLambdaFunctionRecommendationsOutput, error) { if params == nil { params = &GetLambdaFunctionRecommendationsInput{} @@ -47,11 +46,10 @@ type GetLambdaFunctionRecommendationsInput struct { // The Amazon Resource Name (ARN) of the functions for which to return // recommendations. You can specify a qualified or unqualified ARN. If you specify // an unqualified ARN without a function version suffix, Compute Optimizer will - // return recommendations for the latest ($LATEST) version of the function. If you - // specify a qualified ARN with a version suffix, Compute Optimizer will return + // return recommendations for the latest ( $LATEST ) version of the function. If + // you specify a qualified ARN with a version suffix, Compute Optimizer will return // recommendations for the specified function version. For more information about - // using function versions, see Using versions - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using) + // using function versions, see Using versions (https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using) // in the Lambda Developer Guide. FunctionArns []string diff --git a/service/computeoptimizer/api_op_GetRecommendationPreferences.go b/service/computeoptimizer/api_op_GetRecommendationPreferences.go index fde55d25a91..b65f0837ab6 100644 --- a/service/computeoptimizer/api_op_GetRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_GetRecommendationPreferences.go @@ -13,11 +13,10 @@ import ( ) // Returns existing recommendation preferences, such as enhanced infrastructure -// metrics. Use the scope parameter to specify which preferences to return. You can -// specify to return preferences for an organization, a specific account ID, or a -// specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN). For more -// information, see Activating enhanced infrastructure metrics -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) +// metrics. Use the scope parameter to specify which preferences to return. You +// can specify to return preferences for an organization, a specific account ID, or +// a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN). For +// more information, see Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. func (c *Client) GetRecommendationPreferences(ctx context.Context, params *GetRecommendationPreferencesInput, optFns ...func(*Options)) (*GetRecommendationPreferencesOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type GetRecommendationPreferencesInput struct { // preferences. The Ec2Instance option encompasses standalone instances and // instances that are part of Auto Scaling groups. The AutoScalingGroup option // encompasses only instances that are part of an Auto Scaling group. The valid - // values for this parameter are Ec2Instance and AutoScalingGroup. + // values for this parameter are Ec2Instance and AutoScalingGroup . // // This member is required. ResourceType types.ResourceType @@ -57,8 +56,7 @@ type GetRecommendationPreferencesInput struct { // You can return recommendation preferences that are created at the organization // level (for management accounts of an organization only), account level, and // resource level. For more information, see Activating enhanced infrastructure - // metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. Scope *types.Scope @@ -67,8 +65,8 @@ type GetRecommendationPreferencesInput struct { type GetRecommendationPreferencesOutput struct { - // The token to use to advance to the next page of recommendation preferences. This - // value is null when there are no more pages of recommendation preferences to + // The token to use to advance to the next page of recommendation preferences. + // This value is null when there are no more pages of recommendation preferences to // return. NextToken *string diff --git a/service/computeoptimizer/api_op_GetRecommendationSummaries.go b/service/computeoptimizer/api_op_GetRecommendationSummaries.go index 9de7c4d9bb3..3049dd2dcc9 100644 --- a/service/computeoptimizer/api_op_GetRecommendationSummaries.go +++ b/service/computeoptimizer/api_op_GetRecommendationSummaries.go @@ -13,22 +13,13 @@ import ( ) // Returns the optimization findings for an account. It returns the number of: -// -// * -// Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, -// or Optimized. -// -// * Auto Scaling groups in an account that are NotOptimized, or -// Optimized. -// -// * Amazon EBS volumes in an account that are NotOptimized, or -// Optimized. -// -// * Lambda functions in an account that are NotOptimized, or -// Optimized. -// -// * Amazon ECS services in an account that are Underprovisioned, -// Overprovisioned, or Optimized. +// - Amazon EC2 instances in an account that are Underprovisioned , +// Overprovisioned , or Optimized . +// - Auto Scaling groups in an account that are NotOptimized , or Optimized . +// - Amazon EBS volumes in an account that are NotOptimized , or Optimized . +// - Lambda functions in an account that are NotOptimized , or Optimized . +// - Amazon ECS services in an account that are Underprovisioned , +// Overprovisioned , or Optimized . func (c *Client) GetRecommendationSummaries(ctx context.Context, params *GetRecommendationSummariesInput, optFns ...func(*Options)) (*GetRecommendationSummariesOutput, error) { if params == nil { params = &GetRecommendationSummariesInput{} diff --git a/service/computeoptimizer/api_op_PutRecommendationPreferences.go b/service/computeoptimizer/api_op_PutRecommendationPreferences.go index 9df441d9215..b5b57586230 100644 --- a/service/computeoptimizer/api_op_PutRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_PutRecommendationPreferences.go @@ -13,8 +13,7 @@ import ( // Creates a new recommendation preference or updates an existing recommendation // preference, such as enhanced infrastructure metrics. For more information, see -// Activating enhanced infrastructure metrics -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) +// Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. func (c *Client) PutRecommendationPreferences(ctx context.Context, params *PutRecommendationPreferencesInput, optFns ...func(*Options)) (*PutRecommendationPreferencesOutput, error) { if params == nil { @@ -37,7 +36,7 @@ type PutRecommendationPreferencesInput struct { // Ec2Instance option encompasses standalone instances and instances that are part // of Auto Scaling groups. The AutoScalingGroup option encompasses only instances // that are part of an Auto Scaling group. The valid values for this parameter are - // Ec2Instance and AutoScalingGroup. + // Ec2Instance and AutoScalingGroup . // // This member is required. ResourceType types.ResourceType @@ -45,34 +44,30 @@ type PutRecommendationPreferencesInput struct { // The status of the enhanced infrastructure metrics recommendation preference to // create or update. Specify the Active status to activate the preference, or // specify Inactive to deactivate the preference. For more information, see - // Enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // Enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. EnhancedInfrastructureMetrics types.EnhancedInfrastructureMetrics // The provider of the external metrics recommendation preference to create or - // update. Specify a valid provider in the source field to activate the preference. - // To delete this preference, see the DeleteRecommendationPreferences action. This - // preference can only be set for the Ec2Instance resource type. For more - // information, see External metrics ingestion - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html) + // update. Specify a valid provider in the source field to activate the + // preference. To delete this preference, see the DeleteRecommendationPreferences + // action. This preference can only be set for the Ec2Instance resource type. For + // more information, see External metrics ingestion (https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html) // in the Compute Optimizer User Guide. ExternalMetricsPreference *types.ExternalMetricsPreference - // The status of the inferred workload types recommendation preference to create or - // update. The inferred workload type feature is active by default. To deactivate - // it, create a recommendation preference. Specify the Inactive status to - // deactivate the feature, or specify Active to activate it. For more information, - // see Inferred workload types - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html) + // The status of the inferred workload types recommendation preference to create + // or update. The inferred workload type feature is active by default. To + // deactivate it, create a recommendation preference. Specify the Inactive status + // to deactivate the feature, or specify Active to activate it. For more + // information, see Inferred workload types (https://docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html) // in the Compute Optimizer User Guide. InferredWorkloadTypes types.InferredWorkloadTypesPreference // An object that describes the scope of the recommendation preference to create. // You can create recommendation preferences at the organization level (for // management accounts of an organization only), account level, and resource level. - // For more information, see Activating enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // For more information, see Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. You cannot create recommendation // preferences for Auto Scaling groups at the organization and account levels. You // can create recommendation preferences for Auto Scaling groups only at the diff --git a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go index 2fc3275b22b..fcbefd0dab7 100644 --- a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go +++ b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go @@ -16,12 +16,10 @@ import ( // this action can also be used to enroll member accounts of the organization. You // must have the appropriate permissions to opt in to Compute Optimizer, to view // its recommendations, and to opt out. For more information, see Controlling -// access with Amazon Web Services Identity and Access Management -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html) in -// the Compute Optimizer User Guide. When you opt in, Compute Optimizer +// access with Amazon Web Services Identity and Access Management (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html) +// in the Compute Optimizer User Guide. When you opt in, Compute Optimizer // automatically creates a service-linked role in your account to access its data. -// For more information, see Using Service-Linked Roles for Compute Optimizer -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html) +// For more information, see Using Service-Linked Roles for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html) // in the Compute Optimizer User Guide. func (c *Client) UpdateEnrollmentStatus(ctx context.Context, params *UpdateEnrollmentStatusInput, optFns ...func(*Options)) (*UpdateEnrollmentStatusOutput, error) { if params == nil { @@ -42,22 +40,17 @@ type UpdateEnrollmentStatusInput struct { // The new enrollment status of the account. The following status options are // available: - // - // * Active - Opts in your account to the Compute Optimizer service. - // Compute Optimizer begins analyzing the configuration and utilization metrics of - // your Amazon Web Services resources after you opt in. For more information, see - // Metrics analyzed by Compute Optimizer - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html) in the - // Compute Optimizer User Guide. - // - // * Inactive - Opts out your account from the - // Compute Optimizer service. Your account's recommendations and related metrics - // data will be deleted from Compute Optimizer after you opt out. - // - // The Pending and - // Failed options cannot be used to update the enrollment status of an account. - // They are returned in the response of a request to update the enrollment status - // of an account. + // - Active - Opts in your account to the Compute Optimizer service. Compute + // Optimizer begins analyzing the configuration and utilization metrics of your + // Amazon Web Services resources after you opt in. For more information, see + // Metrics analyzed by Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html) + // in the Compute Optimizer User Guide. + // - Inactive - Opts out your account from the Compute Optimizer service. Your + // account's recommendations and related metrics data will be deleted from Compute + // Optimizer after you opt out. + // The Pending and Failed options cannot be used to update the enrollment status + // of an account. They are returned in the response of a request to update the + // enrollment status of an account. // // This member is required. Status types.Status diff --git a/service/computeoptimizer/doc.go b/service/computeoptimizer/doc.go index fe0031a4640..557f8af664b 100644 --- a/service/computeoptimizer/doc.go +++ b/service/computeoptimizer/doc.go @@ -15,6 +15,6 @@ // patterns can help you decide when to move or resize your running resources, and // still meet your performance and capacity requirements. For more information // about Compute Optimizer, including the required permissions to use the service, -// see the Compute Optimizer User Guide -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/). +// see the Compute Optimizer User Guide (https://docs.aws.amazon.com/compute-optimizer/latest/ug/) +// . package computeoptimizer diff --git a/service/computeoptimizer/types/enums.go b/service/computeoptimizer/types/enums.go index b7d1af8a7b4..18a190f6175 100644 --- a/service/computeoptimizer/types/enums.go +++ b/service/computeoptimizer/types/enums.go @@ -10,9 +10,9 @@ const ( AutoScalingConfigurationTargetTrackingScalingMemory AutoScalingConfiguration = "TargetTrackingScalingMemory" ) -// Values returns all known values for AutoScalingConfiguration. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoScalingConfiguration. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingConfiguration) Values() []AutoScalingConfiguration { return []AutoScalingConfiguration{ "TargetTrackingScalingCpu", @@ -28,8 +28,8 @@ const ( CpuVendorArchitectureCurrent CpuVendorArchitecture = "CURRENT" ) -// Values returns all known values for CpuVendorArchitecture. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CpuVendorArchitecture. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CpuVendorArchitecture) Values() []CpuVendorArchitecture { return []CpuVendorArchitecture{ @@ -693,8 +693,8 @@ const ( ExportableVolumeFieldRootVolume ExportableVolumeField = "RootVolume" ) -// Values returns all known values for ExportableVolumeField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ExportableVolumeField. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ExportableVolumeField) Values() []ExportableVolumeField { return []ExportableVolumeField{ @@ -740,8 +740,8 @@ const ( ExternalMetricsSourceInstana ExternalMetricsSource = "Instana" ) -// Values returns all known values for ExternalMetricsSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ExternalMetricsSource. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ExternalMetricsSource) Values() []ExternalMetricsSource { return []ExternalMetricsSource{ @@ -978,9 +978,9 @@ const ( JobStatusFailed JobStatus = "Failed" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "Queued", @@ -1036,9 +1036,9 @@ const ( LambdaFunctionMetricNameMemory LambdaFunctionMetricName = "Memory" ) -// Values returns all known values for LambdaFunctionMetricName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for LambdaFunctionMetricName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionMetricName) Values() []LambdaFunctionMetricName { return []LambdaFunctionMetricName{ "Duration", @@ -1073,9 +1073,9 @@ const ( LambdaFunctionRecommendationFilterNameFindingReasonCode LambdaFunctionRecommendationFilterName = "FindingReasonCode" ) -// Values returns all known values for LambdaFunctionRecommendationFilterName. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for LambdaFunctionRecommendationFilterName. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (LambdaFunctionRecommendationFilterName) Values() []LambdaFunctionRecommendationFilterName { return []LambdaFunctionRecommendationFilterName{ @@ -1245,9 +1245,10 @@ const ( RecommendationPreferenceNameExternalMetricsPreference RecommendationPreferenceName = "ExternalMetricsPreference" ) -// Values returns all known values for RecommendationPreferenceName. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecommendationPreferenceName. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RecommendationPreferenceName) Values() []RecommendationPreferenceName { return []RecommendationPreferenceName{ "EnhancedInfrastructureMetrics", @@ -1267,9 +1268,9 @@ const ( RecommendationSourceTypeEcsService RecommendationSourceType = "EcsService" ) -// Values returns all known values for RecommendationSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecommendationSourceType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationSourceType) Values() []RecommendationSourceType { return []RecommendationSourceType{ "Ec2Instance", @@ -1292,9 +1293,9 @@ const ( ResourceTypeEcsService ResourceType = "EcsService" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "Ec2Instance", @@ -1315,9 +1316,9 @@ const ( ScopeNameResourceArn ScopeName = "ResourceArn" ) -// Values returns all known values for ScopeName. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ScopeName. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ScopeName) Values() []ScopeName { return []ScopeName{ "Organization", diff --git a/service/computeoptimizer/types/types.go b/service/computeoptimizer/types/types.go index d132840096f..fae0338a9e1 100644 --- a/service/computeoptimizer/types/types.go +++ b/service/computeoptimizer/types/types.go @@ -21,9 +21,9 @@ type AccountEnrollmentStatus struct { // The account enrollment status. Status Status - // The reason for the account enrollment status. For example, an account might show - // a status of Pending because member accounts of an organization require more time - // to be enrolled in the service. + // The reason for the account enrollment status. For example, an account might + // show a status of Pending because member accounts of an organization require + // more time to be enrolled in the service. StatusReason *string noSmithyDocumentSerde @@ -75,42 +75,26 @@ type AutoScalingGroupRecommendation struct { // The finding classification of the Auto Scaling group. Findings for Auto Scaling // groups include: - // - // * NotOptimized —An Auto Scaling group is considered not - // optimized when Compute Optimizer identifies a recommendation that can provide - // better performance for your workload. - // - // * Optimized —An Auto Scaling group is - // considered optimized when Compute Optimizer determines that the group is - // correctly provisioned to run your workload based on the chosen instance type. - // For optimized resources, Compute Optimizer might recommend a new generation - // instance type. + // - NotOptimized —An Auto Scaling group is considered not optimized when Compute + // Optimizer identifies a recommendation that can provide better performance for + // your workload. + // - Optimized —An Auto Scaling group is considered optimized when Compute + // Optimizer determines that the group is correctly provisioned to run your + // workload based on the chosen instance type. For optimized resources, Compute + // Optimizer might recommend a new generation instance type. Finding Finding // The applications that might be running on the instances in the Auto Scaling // group as inferred by Compute Optimizer. Compute Optimizer can infer if one of // the following applications might be running on the instances: - // - // * AmazonEmr - - // Infers that Amazon EMR might be running on the instances. - // - // * ApacheCassandra - - // Infers that Apache Cassandra might be running on the instances. - // - // * ApacheHadoop - // - Infers that Apache Hadoop might be running on the instances. - // - // * Memcached - - // Infers that Memcached might be running on the instances. - // - // * NGINX - Infers that - // NGINX might be running on the instances. - // - // * PostgreSql - Infers that PostgreSQL - // might be running on the instances. - // - // * Redis - Infers that Redis might be running - // on the instances. + // - AmazonEmr - Infers that Amazon EMR might be running on the instances. + // - ApacheCassandra - Infers that Apache Cassandra might be running on the + // instances. + // - ApacheHadoop - Infers that Apache Hadoop might be running on the instances. + // - Memcached - Infers that Memcached might be running on the instances. + // - NGINX - Infers that NGINX might be running on the instances. + // - PostgreSql - Infers that PostgreSQL might be running on the instances. + // - Redis - Infers that Redis might be running on the instances. InferredWorkloadTypes []InferredWorkloadType // The timestamp of when the Auto Scaling group recommendation was last generated. @@ -153,7 +137,7 @@ type AutoScalingGroupRecommendationOption struct { // instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk // IOPS, network throughput, and network PPS. The performance risk of the // recommended instance is calculated as the maximum performance risk score across - // the analyzed resource specifications. The value ranges from 0 - 4, with 0 + // the analyzed resource specifications. The value ranges from 0 - 4 , with 0 // meaning that the recommended resource is predicted to always provide enough // hardware capability. The higher the performance risk is, the more likely you // should validate whether the recommendation will meet the performance @@ -165,12 +149,12 @@ type AutoScalingGroupRecommendationOption struct { // projected utilization metrics returned. Additionally, the Memory metric is // returned only for resources that have the unified CloudWatch agent installed on // them. For more information, see Enabling Memory Utilization with the CloudWatch - // Agent - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). + // Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) + // . ProjectedUtilizationMetrics []UtilizationMetric - // The rank of the Auto Scaling group recommendation option. The top recommendation - // option is ranked as 1. + // The rank of the Auto Scaling group recommendation option. The top + // recommendation option is ranked as 1 . Rank int32 // An object that describes the savings opportunity for the Auto Scaling group @@ -213,10 +197,10 @@ type ContainerRecommendation struct { noSmithyDocumentSerde } -// Describes the performance risk ratings for a given resource type. Resources with -// a high or medium rating are at risk of not meeting the performance needs of -// their workloads, while resources with a low rating are performing well in their -// workloads. +// Describes the performance risk ratings for a given resource type. Resources +// with a high or medium rating are at risk of not meeting the performance needs +// of their workloads, while resources with a low rating are performing well in +// their workloads. type CurrentPerformanceRiskRatings struct { // A count of the applicable resource types with a high performance risk rating. @@ -245,10 +229,10 @@ type CurrentPerformanceRiskRatings struct { type EBSFilter struct { // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification (for example, NotOptimized). + // specific finding classification (for example, NotOptimized ). Name EBSFilterName - // The value of the filter. The valid values are Optimized, or NotOptimized. + // The value of the filter. The valid values are Optimized , or NotOptimized . Values []string noSmithyDocumentSerde @@ -262,33 +246,26 @@ type EBSUtilizationMetric struct { // The name of the utilization metric. The following utilization metrics are // available: - // - // * VolumeReadOpsPerSecond - The completed read operations per second - // from the volume in a specified period of time. Unit: Count - // - // * - // VolumeWriteOpsPerSecond - The completed write operations per second to the - // volume in a specified period of time. Unit: Count - // - // * VolumeReadBytesPerSecond - - // The bytes read per second from the volume in a specified period of time. Unit: - // Bytes - // - // * VolumeWriteBytesPerSecond - The bytes written to the volume in a - // specified period of time. Unit: Bytes + // - VolumeReadOpsPerSecond - The completed read operations per second from the + // volume in a specified period of time. Unit: Count + // - VolumeWriteOpsPerSecond - The completed write operations per second to the + // volume in a specified period of time. Unit: Count + // - VolumeReadBytesPerSecond - The bytes read per second from the volume in a + // specified period of time. Unit: Bytes + // - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified + // period of time. Unit: Bytes Name EBSMetricName - // The statistic of the utilization metric. The Compute Optimizer API, Command Line - // Interface (CLI), and SDKs return utilization metrics using only the Maximum + // The statistic of the utilization metric. The Compute Optimizer API, Command + // Line Interface (CLI), and SDKs return utilization metrics using only the Maximum // statistic, which is the highest value observed during the specified period. The // Compute Optimizer console displays graphs for some utilization metrics using the // Average statistic, which is the value of Sum / SampleCount during the specified - // period. For more information, see Viewing resource recommendations - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) + // period. For more information, see Viewing resource recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) // in the Compute Optimizer User Guide. You can also get averaged utilization // metric data for your resources using Amazon CloudWatch. For more information, - // see the Amazon CloudWatch User Guide - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). + // see the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) + // . Statistic MetricStatistic // The value of the utilization metric. @@ -307,13 +284,10 @@ type ECSServiceProjectedMetric struct { LowerBoundValues []float64 // The name of the projected metric. The following metrics are available: - // - // * Cpu — - // The percentage of allocated compute units that are currently in use on the - // service tasks. - // - // * Memory — The percentage of memory that's currently in use on - // the service tasks. + // - Cpu — The percentage of allocated compute units that are currently in use on + // the service tasks. + // - Memory — The percentage of memory that's currently in use on the service + // tasks. Name ECSServiceMetricName // The timestamps of the projected metric. @@ -336,12 +310,10 @@ type ECSServiceProjectedUtilizationMetric struct { // The name of the projected utilization metric. The following utilization metrics // are available: - // - // * Cpu — The percentage of allocated compute units that are - // currently in use on the service tasks. - // - // * Memory — The percentage of memory - // that's currently in use on the service tasks. + // - Cpu — The percentage of allocated compute units that are currently in use on + // the service tasks. + // - Memory — The percentage of memory that's currently in use on the service + // tasks. Name ECSServiceMetricName // The statistic of the projected utilization metric. The Compute Optimizer API, @@ -350,12 +322,11 @@ type ECSServiceProjectedUtilizationMetric struct { // period. The Compute Optimizer console displays graphs for some utilization // metrics using the Average statistic, which is the value of Sum / SampleCount // during the specified period. For more information, see Viewing resource - // recommendations - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) + // recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) // in the Compute Optimizer User Guide. You can also get averaged utilization // metric data for your resources using Amazon CloudWatch. For more information, - // see the Amazon CloudWatch User Guide - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). + // see the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) + // . Statistic ECSServiceMetricStatistic // The upper bound values for the projected utilization metrics. @@ -380,51 +351,39 @@ type ECSServiceRecommendation struct { // The finding classification of an Amazon ECS service. Findings for Amazon ECS // services include: - // - // * Underprovisioned — When Compute Optimizer detects that - // there’s not enough memory or CPU, an Amazon ECS service is considered - // under-provisioned. An under-provisioned service might result in poor application - // performance. - // - // * Overprovisioned — When Compute Optimizer detects that there’s - // excessive memory or CPU, an Amazon ECS service is considered over-provisioned. - // An over-provisioned service might result in additional infrastructure costs. - // - // * - // Optimized — When both the CPU and memory of your Amazon ECS service meet the - // performance requirements of your workload, the service is considered optimized. + // - Underprovisioned — When Compute Optimizer detects that there’s not enough + // memory or CPU, an Amazon ECS service is considered under-provisioned. An + // under-provisioned service might result in poor application performance. + // - Overprovisioned — When Compute Optimizer detects that there’s excessive + // memory or CPU, an Amazon ECS service is considered over-provisioned. An + // over-provisioned service might result in additional infrastructure costs. + // - Optimized — When both the CPU and memory of your Amazon ECS service meet the + // performance requirements of your workload, the service is considered optimized. Finding ECSServiceRecommendationFinding // The reason for the finding classification of an Amazon ECS service. Finding // reason codes for Amazon ECS services include: - // - // * CPUUnderprovisioned — The - // service CPU configuration can be sized up to enhance the performance of your - // workload. This is identified by analyzing the CPUUtilization metric of the - // current service during the look-back period. - // - // * CPUOverprovisioned — The service - // CPU configuration can be sized down while still meeting the performance - // requirements of your workload. This is identified by analyzing the - // CPUUtilization metric of the current service during the look-back period. - // - // * - // MemoryUnderprovisioned — The service memory configuration can be sized up to - // enhance the performance of your workload. This is identified by analyzing the - // MemoryUtilization metric of the current service during the look-back period. - // - // * - // MemoryOverprovisioned — The service memory configuration can be sized down while - // still meeting the performance requirements of your workload. This is identified - // by analyzing the MemoryUtilization metric of the current service during the - // look-back period. + // - CPUUnderprovisioned — The service CPU configuration can be sized up to + // enhance the performance of your workload. This is identified by analyzing the + // CPUUtilization metric of the current service during the look-back period. + // - CPUOverprovisioned — The service CPU configuration can be sized down while + // still meeting the performance requirements of your workload. This is identified + // by analyzing the CPUUtilization metric of the current service during the + // look-back period. + // - MemoryUnderprovisioned — The service memory configuration can be sized up to + // enhance the performance of your workload. This is identified by analyzing the + // MemoryUtilization metric of the current service during the look-back period. + // - MemoryOverprovisioned — The service memory configuration can be sized down + // while still meeting the performance requirements of your workload. This is + // identified by analyzing the MemoryUtilization metric of the current service + // during the look-back period. FindingReasonCodes []ECSServiceRecommendationFindingReasonCode // The timestamp of when the Amazon ECS service recommendation was last generated. LastRefreshTimestamp *time.Time - // The launch type the Amazon ECS service is using. Compute Optimizer only supports - // the Fargate launch type. + // The launch type the Amazon ECS service is using. Compute Optimizer only + // supports the Fargate launch type. LaunchType ECSServiceLaunchType // The number of days the Amazon ECS service utilization metrics were analyzed. @@ -456,14 +415,11 @@ type ECSServiceRecommendationFilter struct { Name ECSServiceRecommendationFilterName // The value of the filter. The valid values for this parameter are as follows: - // - // * - // If you specify the name parameter as Finding, specify Optimized, NotOptimized, - // or Unavailable. - // - // * If you specify the name parameter as FindingReasonCode, - // specify CPUUnderprovisioned, CPUOverprovisioned, MemoryUnderprovisioned, or - // MemoryOverprovisioned. + // - If you specify the name parameter as Finding , specify Optimized , + // NotOptimized , or Unavailable . + // - If you specify the name parameter as FindingReasonCode , specify + // CPUUnderprovisioned , CPUOverprovisioned , MemoryUnderprovisioned , or + // MemoryOverprovisioned . Values []string noSmithyDocumentSerde @@ -496,10 +452,8 @@ type ECSServiceRecommendationOption struct { // generates savings estimates considering the price of existing resources, the // price of recommended resources, and historical usage data. Estimated monthly // savings reflects the projected dollar savings associated with each of the - // recommendations generated. For more information, see Enabling Cost Explorer - // (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html) - // and Optimizing your cost with Rightsizing Recommendations - // (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html) + // recommendations generated. For more information, see Enabling Cost Explorer (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html) + // and Optimizing your cost with Rightsizing Recommendations (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html) // in the Cost Management User Guide. SavingsOpportunity *SavingsOpportunity @@ -532,24 +486,20 @@ type ECSServiceUtilizationMetric struct { // The name of the utilization metric. The following utilization metrics are // available: - // - // * Cpu — The amount of CPU capacity that's used in the service. - // - // * - // Memory — The amount of memory that's used in the service. + // - Cpu — The amount of CPU capacity that's used in the service. + // - Memory — The amount of memory that's used in the service. Name ECSServiceMetricName - // The statistic of the utilization metric. The Compute Optimizer API, Command Line - // Interface (CLI), and SDKs return utilization metrics using only the Maximum + // The statistic of the utilization metric. The Compute Optimizer API, Command + // Line Interface (CLI), and SDKs return utilization metrics using only the Maximum // statistic, which is the highest value observed during the specified period. The // Compute Optimizer console displays graphs for some utilization metrics using the // Average statistic, which is the value of Sum / SampleCount during the specified - // period. For more information, see Viewing resource recommendations - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) + // period. For more information, see Viewing resource recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) // in the Compute Optimizer User Guide. You can also get averaged utilization // metric data for your resources using Amazon CloudWatch. For more information, - // see the Amazon CloudWatch User Guide - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). + // see the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) + // . Statistic ECSServiceMetricStatistic // The value of the utilization metric. @@ -563,27 +513,21 @@ type EffectiveRecommendationPreferences struct { // Describes the CPU vendor and architecture for an instance or Auto Scaling group // recommendations. For example, when you specify AWS_ARM64 with: - // - // * A - // GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, - // Compute Optimizer returns recommendations that consist of Graviton2 instance - // types only. - // - // * A GetEC2RecommendationProjectedMetrics request, Compute Optimizer - // returns projected utilization metrics for Graviton2 instance type - // recommendations only. - // - // * A ExportEC2InstanceRecommendations or - // ExportAutoScalingGroupRecommendations request, Compute Optimizer exports - // recommendations that consist of Graviton2 instance types only. + // - A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations + // request, Compute Optimizer returns recommendations that consist of Graviton2 + // instance types only. + // - A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns + // projected utilization metrics for Graviton2 instance type recommendations only. + // - A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations + // request, Compute Optimizer exports recommendations that consist of Graviton2 + // instance types only. CpuVendorArchitectures []CpuVendorArchitecture // Describes the activation status of the enhanced infrastructure metrics // preference. A status of Active confirms that the preference is applied in the // latest recommendation refresh, and a status of Inactive confirms that it's not // yet applied to recommendations. For more information, see Enhanced - // infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. EnhancedInfrastructureMetrics EnhancedInfrastructureMetrics @@ -607,11 +551,11 @@ type EffectiveRecommendationPreferences struct { type EnrollmentFilter struct { // The name of the filter. Specify Status to return accounts with a specific - // enrollment status (for example, Active). + // enrollment status (for example, Active ). Name EnrollmentFilterName - // The value of the filter. The valid values are Active, Inactive, Pending, and - // Failed. + // The value of the filter. The valid values are Active , Inactive , Pending , and + // Failed . Values []string noSmithyDocumentSerde @@ -620,8 +564,7 @@ type EnrollmentFilter struct { // Describes the estimated monthly savings amount possible, based on On-Demand // instance pricing, by adopting Compute Optimizer recommendations for a given // resource. For more information, see Estimated monthly savings and savings -// opportunities -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/view-ec2-recommendations.html#ec2-savings-calculation) +// opportunities (https://docs.aws.amazon.com/compute-optimizer/latest/ug/view-ec2-recommendations.html#ec2-savings-calculation) // in the Compute Optimizer User Guide. type EstimatedMonthlySavings struct { @@ -663,103 +606,72 @@ type ExternalMetricsPreference struct { type Filter struct { // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification (for example, Underprovisioned). Specify + // specific finding classification (for example, Underprovisioned ). Specify // RecommendationSourceType to return recommendations of a specific resource type - // (for example, Ec2Instance). Specify FindingReasonCodes to return recommendations - // with a specific finding reason code (for example, CPUUnderprovisioned). + // (for example, Ec2Instance ). Specify FindingReasonCodes to return + // recommendations with a specific finding reason code (for example, + // CPUUnderprovisioned ). Name FilterName // The value of the filter. The valid values for this parameter are as follows, // depending on what you specify for the name parameter and the resource type that // you wish to filter results for: - // - // * Specify Optimized or NotOptimized if you - // specify the name parameter as Finding and you want to filter results for Auto - // Scaling groups. - // - // * Specify Underprovisioned, Overprovisioned, or Optimized if - // you specify the name parameter as Finding and you want to filter results for EC2 - // instances. - // - // * Specify Ec2Instance or AutoScalingGroup if you specify the name - // parameter as RecommendationSourceType. - // - // * Specify one of the following options - // if you specify the name parameter as FindingReasonCodes: - // - // * CPUOverprovisioned — - // The instance’s CPU configuration can be sized down while still meeting the - // performance requirements of your workload. - // - // * CPUUnderprovisioned — The - // instance’s CPU configuration doesn't meet the performance requirements of your - // workload and there is an alternative instance type that provides better CPU - // performance. - // - // * MemoryOverprovisioned — The instance’s memory configuration can - // be sized down while still meeting the performance requirements of your - // workload. - // - // * MemoryUnderprovisioned — The instance’s memory configuration - // doesn't meet the performance requirements of your workload and there is an - // alternative instance type that provides better memory performance. - // - // * - // EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can - // be sized down while still meeting the performance requirements of your - // workload. - // - // * EBSThroughputUnderprovisioned — The instance’s EBS throughput - // configuration doesn't meet the performance requirements of your workload and - // there is an alternative instance type that provides better EBS throughput - // performance. - // - // * EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration - // can be sized down while still meeting the performance requirements of your - // workload. - // - // * EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration - // doesn't meet the performance requirements of your workload and there is an - // alternative instance type that provides better EBS IOPS performance. - // - // * - // NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration - // can be sized down while still meeting the performance requirements of your - // workload. - // - // * NetworkBandwidthUnderprovisioned — The instance’s network bandwidth - // configuration doesn't meet the performance requirements of your workload and - // there is an alternative instance type that provides better network bandwidth - // performance. This finding reason happens when the NetworkIn or NetworkOut - // performance of an instance is impacted. - // - // * NetworkPPSOverprovisioned — The - // instance’s network PPS (packets per second) configuration can be sized down - // while still meeting the performance requirements of your workload. - // - // * - // NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) - // configuration doesn't meet the performance requirements of your workload and - // there is an alternative instance type that provides better network PPS - // performance. - // - // * DiskIOPSOverprovisioned — The instance’s disk IOPS configuration - // can be sized down while still meeting the performance requirements of your - // workload. - // - // * DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration - // doesn't meet the performance requirements of your workload and there is an - // alternative instance type that provides better disk IOPS performance. - // - // * - // DiskThroughputOverprovisioned — The instance’s disk throughput configuration can - // be sized down while still meeting the performance requirements of your - // workload. - // - // * DiskThroughputUnderprovisioned — The instance’s disk throughput - // configuration doesn't meet the performance requirements of your workload and - // there is an alternative instance type that provides better disk throughput - // performance. + // - Specify Optimized or NotOptimized if you specify the name parameter as + // Finding and you want to filter results for Auto Scaling groups. + // - Specify Underprovisioned , Overprovisioned , or Optimized if you specify the + // name parameter as Finding and you want to filter results for EC2 instances. + // - Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as + // RecommendationSourceType . + // - Specify one of the following options if you specify the name parameter as + // FindingReasonCodes : + // - CPUOverprovisioned — The instance’s CPU configuration can be sized down + // while still meeting the performance requirements of your workload. + // - CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the + // performance requirements of your workload and there is an alternative instance + // type that provides better CPU performance. + // - MemoryOverprovisioned — The instance’s memory configuration can be sized + // down while still meeting the performance requirements of your workload. + // - MemoryUnderprovisioned — The instance’s memory configuration doesn't meet + // the performance requirements of your workload and there is an alternative + // instance type that provides better memory performance. + // - EBSThroughputOverprovisioned — The instance’s EBS throughput configuration + // can be sized down while still meeting the performance requirements of your + // workload. + // - EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration + // doesn't meet the performance requirements of your workload and there is an + // alternative instance type that provides better EBS throughput performance. + // - EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized + // down while still meeting the performance requirements of your workload. + // - EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet + // the performance requirements of your workload and there is an alternative + // instance type that provides better EBS IOPS performance. + // - NetworkBandwidthOverprovisioned — The instance’s network bandwidth + // configuration can be sized down while still meeting the performance requirements + // of your workload. + // - NetworkBandwidthUnderprovisioned — The instance’s network bandwidth + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better network bandwidth + // performance. This finding reason happens when the NetworkIn or NetworkOut + // performance of an instance is impacted. + // - NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) + // configuration can be sized down while still meeting the performance requirements + // of your workload. + // - NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better network PPS + // performance. + // - DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be + // sized down while still meeting the performance requirements of your workload. + // - DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't + // meet the performance requirements of your workload and there is an alternative + // instance type that provides better disk IOPS performance. + // - DiskThroughputOverprovisioned — The instance’s disk throughput configuration + // can be sized down while still meeting the performance requirements of your + // workload. + // - DiskThroughputUnderprovisioned — The instance’s disk throughput + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better disk throughput + // performance. Values []string noSmithyDocumentSerde @@ -802,173 +714,123 @@ type InstanceRecommendation struct { EffectiveRecommendationPreferences *EffectiveRecommendationPreferences // The finding classification of the instance. Findings for instances include: - // - // * - // Underprovisioned —An instance is considered under-provisioned when at least one - // specification of your instance, such as CPU, memory, or network, does not meet - // the performance requirements of your workload. Under-provisioned instances may - // lead to poor application performance. - // - // * Overprovisioned —An instance is - // considered over-provisioned when at least one specification of your instance, - // such as CPU, memory, or network, can be sized down while still meeting the - // performance requirements of your workload, and no specification is - // under-provisioned. Over-provisioned instances may lead to unnecessary - // infrastructure cost. - // - // * Optimized —An instance is considered optimized when all - // specifications of your instance, such as CPU, memory, and network, meet the - // performance requirements of your workload and is not over provisioned. For - // optimized resources, Compute Optimizer might recommend a new generation instance - // type. + // - Underprovisioned —An instance is considered under-provisioned when at least + // one specification of your instance, such as CPU, memory, or network, does not + // meet the performance requirements of your workload. Under-provisioned instances + // may lead to poor application performance. + // - Overprovisioned —An instance is considered over-provisioned when at least + // one specification of your instance, such as CPU, memory, or network, can be + // sized down while still meeting the performance requirements of your workload, + // and no specification is under-provisioned. Over-provisioned instances may lead + // to unnecessary infrastructure cost. + // - Optimized —An instance is considered optimized when all specifications of + // your instance, such as CPU, memory, and network, meet the performance + // requirements of your workload and is not over provisioned. For optimized + // resources, Compute Optimizer might recommend a new generation instance type. Finding Finding // The reason for the finding classification of the instance. Finding reason codes // for instances include: - // - // * CPUOverprovisioned — The instance’s CPU configuration - // can be sized down while still meeting the performance requirements of your - // workload. This is identified by analyzing the CPUUtilization metric of the - // current instance during the look-back period. - // - // * CPUUnderprovisioned — The - // instance’s CPU configuration doesn't meet the performance requirements of your - // workload and there is an alternative instance type that provides better CPU - // performance. This is identified by analyzing the CPUUtilization metric of the - // current instance during the look-back period. - // - // * MemoryOverprovisioned — The - // instance’s memory configuration can be sized down while still meeting the - // performance requirements of your workload. This is identified by analyzing the - // memory utilization metric of the current instance during the look-back - // period. - // - // * MemoryUnderprovisioned — The instance’s memory configuration doesn't - // meet the performance requirements of your workload and there is an alternative - // instance type that provides better memory performance. This is identified by - // analyzing the memory utilization metric of the current instance during the - // look-back period. Memory utilization is analyzed only for resources that have - // the unified CloudWatch agent installed on them. For more information, see - // Enabling memory utilization with the Amazon CloudWatch Agent - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) - // in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer - // analyses the mem_used_percent metric in the CWAgent namespace, or the legacy - // MemoryUtilization metric in the System/Linux namespace. On Windows instances, - // Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the - // CWAgent namespace. - // - // * EBSThroughputOverprovisioned — The instance’s EBS - // throughput configuration can be sized down while still meeting the performance - // requirements of your workload. This is identified by analyzing the - // VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the - // current instance during the look-back period. - // - // * EBSThroughputUnderprovisioned — - // The instance’s EBS throughput configuration doesn't meet the performance - // requirements of your workload and there is an alternative instance type that - // provides better EBS throughput performance. This is identified by analyzing the - // VolumeReadBytes and VolumeWriteBytes> metrics of EBS volumes attached to the - // current instance during the look-back period. - // - // * EBSIOPSOverprovisioned — The - // instance’s EBS IOPS configuration can be sized down while still meeting the - // performance requirements of your workload. This is identified by analyzing the - // VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current - // instance during the look-back period. - // - // * EBSIOPSUnderprovisioned — The - // instance’s EBS IOPS configuration doesn't meet the performance requirements of - // your workload and there is an alternative instance type that provides better EBS - // IOPS performance. This is identified by analyzing the VolumeReadOps and - // VolumeWriteOps metric of EBS volumes attached to the current instance during the - // look-back period. - // - // * NetworkBandwidthOverprovisioned — The instance’s network - // bandwidth configuration can be sized down while still meeting the performance - // requirements of your workload. This is identified by analyzing the NetworkIn and - // NetworkOut metrics of the current instance during the look-back period. - // - // * - // NetworkBandwidthUnderprovisioned — The instance’s network bandwidth - // configuration doesn't meet the performance requirements of your workload and - // there is an alternative instance type that provides better network bandwidth - // performance. This is identified by analyzing the NetworkIn and NetworkOut - // metrics of the current instance during the look-back period. This finding reason - // happens when the NetworkIn or NetworkOut performance of an instance is - // impacted. - // - // * NetworkPPSOverprovisioned — The instance’s network PPS (packets per - // second) configuration can be sized down while still meeting the performance - // requirements of your workload. This is identified by analyzing the - // NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the - // look-back period. - // - // * NetworkPPSUnderprovisioned — The instance’s network PPS - // (packets per second) configuration doesn't meet the performance requirements of - // your workload and there is an alternative instance type that provides better - // network PPS performance. This is identified by analyzing the NetworkPacketsIn - // and NetworkPacketsIn metrics of the current instance during the look-back - // period. - // - // * DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can - // be sized down while still meeting the performance requirements of your workload. - // This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the - // current instance during the look-back period. - // - // * DiskIOPSUnderprovisioned — The - // instance’s disk IOPS configuration doesn't meet the performance requirements of - // your workload and there is an alternative instance type that provides better - // disk IOPS performance. This is identified by analyzing the DiskReadOps and - // DiskWriteOps metrics of the current instance during the look-back period. - // - // * - // DiskThroughputOverprovisioned — The instance’s disk throughput configuration can - // be sized down while still meeting the performance requirements of your workload. - // This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of - // the current instance during the look-back period. - // - // * - // DiskThroughputUnderprovisioned — The instance’s disk throughput configuration - // doesn't meet the performance requirements of your workload and there is an - // alternative instance type that provides better disk throughput performance. This - // is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the - // current instance during the look-back period. - // - // For more information about - // instance metrics, see List the available CloudWatch metrics for your instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html) + // - CPUOverprovisioned — The instance’s CPU configuration can be sized down + // while still meeting the performance requirements of your workload. This is + // identified by analyzing the CPUUtilization metric of the current instance + // during the look-back period. + // - CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the + // performance requirements of your workload and there is an alternative instance + // type that provides better CPU performance. This is identified by analyzing the + // CPUUtilization metric of the current instance during the look-back period. + // - MemoryOverprovisioned — The instance’s memory configuration can be sized + // down while still meeting the performance requirements of your workload. This is + // identified by analyzing the memory utilization metric of the current instance + // during the look-back period. + // - MemoryUnderprovisioned — The instance’s memory configuration doesn't meet + // the performance requirements of your workload and there is an alternative + // instance type that provides better memory performance. This is identified by + // analyzing the memory utilization metric of the current instance during the + // look-back period. Memory utilization is analyzed only for resources that have + // the unified CloudWatch agent installed on them. For more information, see + // Enabling memory utilization with the Amazon CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) + // in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer + // analyses the mem_used_percent metric in the CWAgent namespace, or the legacy + // MemoryUtilization metric in the System/Linux namespace. On Windows instances, + // Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the + // CWAgent namespace. + // - EBSThroughputOverprovisioned — The instance’s EBS throughput configuration + // can be sized down while still meeting the performance requirements of your + // workload. This is identified by analyzing the VolumeReadBytes and + // VolumeWriteBytes metrics of EBS volumes attached to the current instance + // during the look-back period. + // - EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration + // doesn't meet the performance requirements of your workload and there is an + // alternative instance type that provides better EBS throughput performance. This + // is identified by analyzing the VolumeReadBytes and VolumeWriteBytes > metrics + // of EBS volumes attached to the current instance during the look-back period. + // - EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized + // down while still meeting the performance requirements of your workload. This is + // identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS + // volumes attached to the current instance during the look-back period. + // - EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet + // the performance requirements of your workload and there is an alternative + // instance type that provides better EBS IOPS performance. This is identified by + // analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached + // to the current instance during the look-back period. + // - NetworkBandwidthOverprovisioned — The instance’s network bandwidth + // configuration can be sized down while still meeting the performance requirements + // of your workload. This is identified by analyzing the NetworkIn and NetworkOut + // metrics of the current instance during the look-back period. + // - NetworkBandwidthUnderprovisioned — The instance’s network bandwidth + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better network bandwidth + // performance. This is identified by analyzing the NetworkIn and NetworkOut + // metrics of the current instance during the look-back period. This finding reason + // happens when the NetworkIn or NetworkOut performance of an instance is + // impacted. + // - NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) + // configuration can be sized down while still meeting the performance requirements + // of your workload. This is identified by analyzing the NetworkPacketsIn and + // NetworkPacketsIn metrics of the current instance during the look-back period. + // - NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better network PPS + // performance. This is identified by analyzing the NetworkPacketsIn and + // NetworkPacketsIn metrics of the current instance during the look-back period. + // - DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be + // sized down while still meeting the performance requirements of your workload. + // This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of + // the current instance during the look-back period. + // - DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't + // meet the performance requirements of your workload and there is an alternative + // instance type that provides better disk IOPS performance. This is identified by + // analyzing the DiskReadOps and DiskWriteOps metrics of the current instance + // during the look-back period. + // - DiskThroughputOverprovisioned — The instance’s disk throughput configuration + // can be sized down while still meeting the performance requirements of your + // workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes + // metrics of the current instance during the look-back period. + // - DiskThroughputUnderprovisioned — The instance’s disk throughput + // configuration doesn't meet the performance requirements of your workload and + // there is an alternative instance type that provides better disk throughput + // performance. This is identified by analyzing the DiskReadBytes and + // DiskWriteBytes metrics of the current instance during the look-back period. + // For more information about instance metrics, see List the available CloudWatch + // metrics for your instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html) // in the Amazon Elastic Compute Cloud User Guide. For more information about EBS - // volume metrics, see Amazon CloudWatch metrics for Amazon EBS - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cloudwatch_ebs.html) + // volume metrics, see Amazon CloudWatch metrics for Amazon EBS (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cloudwatch_ebs.html) // in the Amazon Elastic Compute Cloud User Guide. FindingReasonCodes []InstanceRecommendationFindingReasonCode // The applications that might be running on the instance as inferred by Compute // Optimizer. Compute Optimizer can infer if one of the following applications // might be running on the instance: - // - // * AmazonEmr - Infers that Amazon EMR might be - // running on the instance. - // - // * ApacheCassandra - Infers that Apache Cassandra might - // be running on the instance. - // - // * ApacheHadoop - Infers that Apache Hadoop might be - // running on the instance. - // - // * Memcached - Infers that Memcached might be running - // on the instance. - // - // * NGINX - Infers that NGINX might be running on the - // instance. - // - // * PostgreSql - Infers that PostgreSQL might be running on the - // instance. - // - // * Redis - Infers that Redis might be running on the instance. - // - // * - // Kafka - Infers that Kafka might be running on the instance. + // - AmazonEmr - Infers that Amazon EMR might be running on the instance. + // - ApacheCassandra - Infers that Apache Cassandra might be running on the + // instance. + // - ApacheHadoop - Infers that Apache Hadoop might be running on the instance. + // - Memcached - Infers that Memcached might be running on the instance. + // - NGINX - Infers that NGINX might be running on the instance. + // - PostgreSql - Infers that PostgreSQL might be running on the instance. + // - Redis - Infers that Redis might be running on the instance. + // - Kafka - Infers that Kafka might be running on the instance. InferredWorkloadTypes []InferredWorkloadType // The Amazon Resource Name (ARN) of the current instance. @@ -1020,7 +882,7 @@ type InstanceRecommendationOption struct { // including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, // network throughput, and network PPS. The performance risk of the recommended // instance is calculated as the maximum performance risk score across the analyzed - // resource specifications. The value ranges from 0 - 4, with 0 meaning that the + // resource specifications. The value ranges from 0 - 4 , with 0 meaning that the // recommended resource is predicted to always provide enough hardware capability. // The higher the performance risk is, the more likely you should validate whether // the recommendation will meet the performance requirements of your workload @@ -1030,94 +892,64 @@ type InstanceRecommendationOption struct { // Describes the configuration differences between the current instance and the // recommended instance type. You should consider the configuration differences // before migrating your workloads from the current instance to the recommended - // instance type. The Change the instance type guide for Linux - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html) - // and Change the instance type guide for Windows - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-resize.html) + // instance type. The Change the instance type guide for Linux (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html) + // and Change the instance type guide for Windows (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-resize.html) // provide general guidance for getting started with an instance migration. // Platform differences include: - // - // * Hypervisor — The hypervisor of the recommended - // instance type is different than that of the current instance. For example, the - // recommended instance type uses a Nitro hypervisor and the current instance uses - // a Xen hypervisor. The differences that you should consider between these - // hypervisors are covered in the Nitro Hypervisor - // (http://aws.amazon.com/ec2/faqs/#Nitro_Hypervisor) section of the Amazon EC2 - // frequently asked questions. For more information, see Instances built on the - // Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) - // in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#ec2-nitro-instances) - // in the Amazon EC2 User Guide for Windows. - // - // * NetworkInterface — The network - // interface of the recommended instance type is different than that of the current - // instance. For example, the recommended instance type supports enhanced - // networking and the current instance might not. To enable enhanced networking for - // the recommended instance type, you must install the Elastic Network Adapter - // (ENA) driver or the Intel 82599 Virtual Function driver. For more information, - // see Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) - // and Enhanced networking on Linux - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html) - // in the Amazon EC2 User Guide for Linux, or Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) - // and Enhanced networking on Windows - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/enhanced-networking.html) - // in the Amazon EC2 User Guide for Windows. - // - // * StorageInterface — The storage - // interface of the recommended instance type is different than that of the current - // instance. For example, the recommended instance type uses an NVMe storage - // interface and the current instance does not. To access NVMe volumes for the - // recommended instance type, you will need to install or upgrade the NVMe driver. - // For more information, see Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) - // and Amazon EBS and NVMe on Linux instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html) in - // the Amazon EC2 User Guide for Linux, or Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) - // and Amazon EBS and NVMe on Windows instances - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/nvme-ebs-volumes.html) - // in the Amazon EC2 User Guide for Windows. - // - // * InstanceStoreAvailability — The - // recommended instance type does not support instance store volumes and the - // current instance does. Before migrating, you might need to back up the data on - // your instance store volumes if you want to preserve them. For more information, - // see How do I back up an instance store volume on my Amazon EC2 instance to - // Amazon EBS? - // (https://aws.amazon.com/premiumsupport/knowledge-center/back-up-instance-store-ebs/) - // in the Amazon Web Services Premium Support Knowledge Base. For more information, - // see Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) - // and Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide for Linux, or see Networking and storage features - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) - // and Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide for Windows. - // - // * VirtualizationType — The recommended - // instance type uses the hardware virtual machine (HVM) virtualization type and - // the current instance uses the paravirtual (PV) virtualization type. For more - // information about the differences between these virtualization types, see Linux - // AMI virtualization types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/virtualization_types.html) - // in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#virtualization-types) - // in the Amazon EC2 User Guide for Windows. - // - // * Architecture — The CPU architecture - // between the recommended instance type and the current instance is different. For - // example, the recommended instance type might use an Arm CPU architecture and the - // current instance type might use a different one, such as x86. Before migrating, - // you should consider recompiling the software on your instance for the new - // architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) - // that supports the new architecture. For more information about the CPU - // architecture for each instance type, see Amazon EC2 Instance Types - // (http://aws.amazon.com/ec2/instance-types/). + // - Hypervisor — The hypervisor of the recommended instance type is different + // than that of the current instance. For example, the recommended instance type + // uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The + // differences that you should consider between these hypervisors are covered in + // the Nitro Hypervisor (http://aws.amazon.com/ec2/faqs/#Nitro_Hypervisor) + // section of the Amazon EC2 frequently asked questions. For more information, see + // Instances built on the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#ec2-nitro-instances) + // in the Amazon EC2 User Guide for Windows. + // - NetworkInterface — The network interface of the recommended instance type is + // different than that of the current instance. For example, the recommended + // instance type supports enhanced networking and the current instance might not. + // To enable enhanced networking for the recommended instance type, you must + // install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual + // Function driver. For more information, see Networking and storage features (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) + // and Enhanced networking on Linux (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html) + // in the Amazon EC2 User Guide for Linux, or Networking and storage features (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) + // and Enhanced networking on Windows (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/enhanced-networking.html) + // in the Amazon EC2 User Guide for Windows. + // - StorageInterface — The storage interface of the recommended instance type is + // different than that of the current instance. For example, the recommended + // instance type uses an NVMe storage interface and the current instance does not. + // To access NVMe volumes for the recommended instance type, you will need to + // install or upgrade the NVMe driver. For more information, see Networking and + // storage features (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) + // and Amazon EBS and NVMe on Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html) + // in the Amazon EC2 User Guide for Linux, or Networking and storage features (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) + // and Amazon EBS and NVMe on Windows instances (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/nvme-ebs-volumes.html) + // in the Amazon EC2 User Guide for Windows. + // - InstanceStoreAvailability — The recommended instance type does not support + // instance store volumes and the current instance does. Before migrating, you + // might need to back up the data on your instance store volumes if you want to + // preserve them. For more information, see How do I back up an instance store + // volume on my Amazon EC2 instance to Amazon EBS? (https://aws.amazon.com/premiumsupport/knowledge-center/back-up-instance-store-ebs/) + // in the Amazon Web Services Premium Support Knowledge Base. For more information, + // see Networking and storage features (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) + // and Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide for Linux, or see Networking and storage features (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) + // and Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide for Windows. + // - VirtualizationType — The recommended instance type uses the hardware virtual + // machine (HVM) virtualization type and the current instance uses the paravirtual + // (PV) virtualization type. For more information about the differences between + // these virtualization types, see Linux AMI virtualization types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/virtualization_types.html) + // in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#virtualization-types) + // in the Amazon EC2 User Guide for Windows. + // - Architecture — The CPU architecture between the recommended instance type + // and the current instance is different. For example, the recommended instance + // type might use an Arm CPU architecture and the current instance type might use a + // different one, such as x86. Before migrating, you should consider recompiling + // the software on your instance for the new architecture. Alternatively, you might + // switch to an Amazon Machine Image (AMI) that supports the new architecture. For + // more information about the CPU architecture for each instance type, see + // Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/) . PlatformDifferences []PlatformDifference // An array of objects that describe the projected utilization metrics of the @@ -1125,17 +957,17 @@ type InstanceRecommendationOption struct { // projected utilization metrics returned. Additionally, the Memory metric is // returned only for resources that have the unified CloudWatch agent installed on // them. For more information, see Enabling Memory Utilization with the CloudWatch - // Agent - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). + // Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) + // . ProjectedUtilizationMetrics []UtilizationMetric - // The rank of the instance recommendation option. The top recommendation option is - // ranked as 1. + // The rank of the instance recommendation option. The top recommendation option + // is ranked as 1 . Rank int32 - // An object that describes the savings opportunity for the instance recommendation - // option. Savings opportunity includes the estimated monthly savings amount and - // percentage. + // An object that describes the savings opportunity for the instance + // recommendation option. Savings opportunity includes the estimated monthly + // savings amount and percentage. SavingsOpportunity *SavingsOpportunity noSmithyDocumentSerde @@ -1149,21 +981,18 @@ type InstanceRecommendationOption struct { // GetEC2InstanceRecommendations actions. type JobFilter struct { - // The name of the filter. Specify ResourceType to return export jobs of a specific - // resource type (for example, Ec2Instance). Specify JobStatus to return export - // jobs with a specific status (e.g, Complete). + // The name of the filter. Specify ResourceType to return export jobs of a + // specific resource type (for example, Ec2Instance ). Specify JobStatus to return + // export jobs with a specific status (e.g, Complete ). Name JobFilterName // The value of the filter. The valid values for this parameter are as follows, // depending on what you specify for the name parameter: - // - // * Specify Ec2Instance or - // AutoScalingGroup if you specify the name parameter as ResourceType. There is no - // filter for EBS volumes because volume recommendations cannot be exported at this - // time. - // - // * Specify Queued, InProgress, Complete, or Failed if you specify the name - // parameter as JobStatus. + // - Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as + // ResourceType . There is no filter for EBS volumes because volume + // recommendations cannot be exported at this time. + // - Specify Queued , InProgress , Complete , or Failed if you specify the name + // parameter as JobStatus . Values []string noSmithyDocumentSerde @@ -1195,8 +1024,8 @@ type LambdaFunctionMemoryRecommendationOption struct { // function recommendation option. ProjectedUtilizationMetrics []LambdaFunctionMemoryProjectedMetric - // The rank of the function recommendation option. The top recommendation option is - // ranked as 1. + // The rank of the function recommendation option. The top recommendation option + // is ranked as 1 . Rank int32 // An object that describes the savings opportunity for the Lambda function @@ -1216,63 +1045,52 @@ type LambdaFunctionRecommendation struct { // The amount of memory, in MB, that's allocated to the current function. CurrentMemorySize int32 - // The risk of the current Lambda function not meeting the performance needs of its - // workloads. The higher the risk, the more likely the current Lambda function + // The risk of the current Lambda function not meeting the performance needs of + // its workloads. The higher the risk, the more likely the current Lambda function // requires more memory. CurrentPerformanceRisk CurrentPerformanceRisk // The finding classification of the function. Findings for functions include: - // - // * - // Optimized — The function is correctly provisioned to run your workload based on - // its current configuration and its utilization history. This finding - // classification does not include finding reason codes. - // - // * NotOptimized — The - // function is performing at a higher level (over-provisioned) or at a lower level - // (under-provisioned) than required for your workload because its current - // configuration is not optimal. Over-provisioned resources might lead to - // unnecessary infrastructure cost, and under-provisioned resources might lead to - // poor application performance. This finding classification can include the - // MemoryUnderprovisioned and MemoryUnderprovisioned finding reason codes. - // - // * - // Unavailable — Compute Optimizer was unable to generate a recommendation for the - // function. This could be because the function has not accumulated sufficient - // metric data, or the function does not qualify for a recommendation. This finding - // classification can include the InsufficientData and Inconclusive finding reason - // codes. Functions with a finding of unavailable are not returned unless you - // specify the filter parameter with a value of Unavailable in your - // GetLambdaFunctionRecommendations request. + // - Optimized — The function is correctly provisioned to run your workload based + // on its current configuration and its utilization history. This finding + // classification does not include finding reason codes. + // - NotOptimized — The function is performing at a higher level + // (over-provisioned) or at a lower level (under-provisioned) than required for + // your workload because its current configuration is not optimal. Over-provisioned + // resources might lead to unnecessary infrastructure cost, and under-provisioned + // resources might lead to poor application performance. This finding + // classification can include the MemoryUnderprovisioned and + // MemoryUnderprovisioned finding reason codes. + // - Unavailable — Compute Optimizer was unable to generate a recommendation for + // the function. This could be because the function has not accumulated sufficient + // metric data, or the function does not qualify for a recommendation. This finding + // classification can include the InsufficientData and Inconclusive finding + // reason codes. Functions with a finding of unavailable are not returned unless + // you specify the filter parameter with a value of Unavailable in your + // GetLambdaFunctionRecommendations request. Finding LambdaFunctionRecommendationFinding - // The reason for the finding classification of the function. Functions that have a - // finding classification of Optimized don't have a finding reason code. Finding + // The reason for the finding classification of the function. Functions that have + // a finding classification of Optimized don't have a finding reason code. Finding // reason codes for functions include: - // - // * MemoryOverprovisioned — The function is - // over-provisioned when its memory configuration can be sized down while still - // meeting the performance requirements of your workload. An over-provisioned - // function might lead to unnecessary infrastructure cost. This finding reason code - // is part of the NotOptimized finding classification. - // - // * MemoryUnderprovisioned — - // The function is under-provisioned when its memory configuration doesn't meet the - // performance requirements of the workload. An under-provisioned function might - // lead to poor application performance. This finding reason code is part of the - // NotOptimized finding classification. - // - // * InsufficientData — The function does not - // have sufficient metric data for Compute Optimizer to generate a recommendation. - // For more information, see the Supported resources and requirements - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in - // the Compute Optimizer User Guide. This finding reason code is part of the - // Unavailable finding classification. - // - // * Inconclusive — The function does not - // qualify for a recommendation because Compute Optimizer cannot generate a - // recommendation with a high degree of confidence. This finding reason code is - // part of the Unavailable finding classification. + // - MemoryOverprovisioned — The function is over-provisioned when its memory + // configuration can be sized down while still meeting the performance requirements + // of your workload. An over-provisioned function might lead to unnecessary + // infrastructure cost. This finding reason code is part of the NotOptimized + // finding classification. + // - MemoryUnderprovisioned — The function is under-provisioned when its memory + // configuration doesn't meet the performance requirements of the workload. An + // under-provisioned function might lead to poor application performance. This + // finding reason code is part of the NotOptimized finding classification. + // - InsufficientData — The function does not have sufficient metric data for + // Compute Optimizer to generate a recommendation. For more information, see the + // Supported resources and requirements (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) + // in the Compute Optimizer User Guide. This finding reason code is part of the + // Unavailable finding classification. + // - Inconclusive — The function does not qualify for a recommendation because + // Compute Optimizer cannot generate a recommendation with a high degree of + // confidence. This finding reason code is part of the Unavailable finding + // classification. FindingReasonCodes []LambdaFunctionRecommendationFindingReasonCode // The Amazon Resource Name (ARN) of the current function. @@ -1308,20 +1126,17 @@ type LambdaFunctionRecommendation struct { type LambdaFunctionRecommendationFilter struct { // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification (for example, NotOptimized). Specify + // specific finding classification (for example, NotOptimized ). Specify // FindingReasonCode to return recommendations with a specific finding reason code - // (for example, MemoryUnderprovisioned). + // (for example, MemoryUnderprovisioned ). Name LambdaFunctionRecommendationFilterName // The value of the filter. The valid values for this parameter are as follows, // depending on what you specify for the name parameter: - // - // * Specify Optimized, - // NotOptimized, or Unavailable if you specify the name parameter as Finding. - // - // * - // Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or - // Inconclusive if you specify the name parameter as FindingReasonCode. + // - Specify Optimized , NotOptimized , or Unavailable if you specify the name + // parameter as Finding . + // - Specify MemoryOverprovisioned , MemoryUnderprovisioned , InsufficientData , + // or Inconclusive if you specify the name parameter as FindingReasonCode . Values []string noSmithyDocumentSerde @@ -1332,24 +1147,21 @@ type LambdaFunctionUtilizationMetric struct { // The name of the utilization metric. The following utilization metrics are // available: - // - // * Duration - The amount of time that your function code spends - // processing an event. - // - // * Memory - The amount of memory used per invocation. + // - Duration - The amount of time that your function code spends processing an + // event. + // - Memory - The amount of memory used per invocation. Name LambdaFunctionMetricName - // The statistic of the utilization metric. The Compute Optimizer API, Command Line - // Interface (CLI), and SDKs return utilization metrics using only the Maximum + // The statistic of the utilization metric. The Compute Optimizer API, Command + // Line Interface (CLI), and SDKs return utilization metrics using only the Maximum // statistic, which is the highest value observed during the specified period. The // Compute Optimizer console displays graphs for some utilization metrics using the // Average statistic, which is the value of Sum / SampleCount during the specified - // period. For more information, see Viewing resource recommendations - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) + // period. For more information, see Viewing resource recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) // in the Compute Optimizer User Guide. You can also get averaged utilization // metric data for your resources using Amazon CloudWatch. For more information, - // see the Amazon CloudWatch User Guide - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). + // see the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) + // . Statistic LambdaFunctionMetricStatistic // The value of the utilization metric. @@ -1380,28 +1192,25 @@ type MemorySizeConfiguration struct { // GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is // returned only for resources that have the unified CloudWatch agent installed on // them. For more information, see Enabling Memory Utilization with the CloudWatch -// Agent -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). +// Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) +// . type ProjectedMetric struct { // The name of the projected utilization metric. The following projected // utilization metrics are returned: - // - // * Cpu - The projected percentage of allocated - // EC2 compute units that would be in use on the recommendation option had you used - // that resource during the analyzed period. This metric identifies the processing - // power required to run an application on the recommendation option. Depending on - // the instance type, tools in your operating system can show a lower percentage - // than CloudWatch when the instance is not allocated a full processor core. Units: - // Percent - // - // * Memory - The percentage of memory that would be in use on the - // recommendation option had you used that resource during the analyzed period. - // This metric identifies the amount of memory required to run an application on - // the recommendation option. Units: Percent The Memory metric is returned only for - // resources that have the unified CloudWatch agent installed on them. For more - // information, see Enabling Memory Utilization with the CloudWatch Agent - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). + // - Cpu - The projected percentage of allocated EC2 compute units that would be + // in use on the recommendation option had you used that resource during the + // analyzed period. This metric identifies the processing power required to run an + // application on the recommendation option. Depending on the instance type, tools + // in your operating system can show a lower percentage than CloudWatch when the + // instance is not allocated a full processor core. Units: Percent + // - Memory - The percentage of memory that would be in use on the recommendation + // option had you used that resource during the analyzed period. This metric + // identifies the amount of memory required to run an application on the + // recommendation option. Units: Percent The Memory metric is returned only for + // resources that have the unified CloudWatch agent installed on them. For more + // information, see Enabling Memory Utilization with the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) + // . Name MetricName // The timestamps of the projected utilization metric. @@ -1456,25 +1265,20 @@ type RecommendationExportJob struct { } // Describes the recommendation preferences to return in the response of a -// GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, and +// GetAutoScalingGroupRecommendations , GetEC2InstanceRecommendations , and // GetEC2RecommendationProjectedMetrics request. type RecommendationPreferences struct { // Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto // Scaling group recommendations. For example, when you specify AWS_ARM64 with: - // - // * - // A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, - // Compute Optimizer returns recommendations that consist of Graviton2 instance - // types only. - // - // * A GetEC2RecommendationProjectedMetrics request, Compute Optimizer - // returns projected utilization metrics for Graviton2 instance type - // recommendations only. - // - // * A ExportEC2InstanceRecommendations or - // ExportAutoScalingGroupRecommendations request, Compute Optimizer exports - // recommendations that consist of Graviton2 instance types only. + // - A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations + // request, Compute Optimizer returns recommendations that consist of Graviton2 + // instance types only. + // - A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns + // projected utilization metrics for Graviton2 instance type recommendations only. + // - A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations + // request, Compute Optimizer exports recommendations that consist of Graviton2 + // instance types only. CpuVendorArchitectures []CpuVendorArchitecture noSmithyDocumentSerde @@ -1484,11 +1288,10 @@ type RecommendationPreferences struct { type RecommendationPreferencesDetail struct { // The status of the enhanced infrastructure metrics recommendation preference. - // When the recommendations page is refreshed, a status of Active confirms that the - // preference is applied to the recommendations, and a status of Inactive confirms - // that the preference isn't yet applied to recommendations. For more information, - // see Enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // When the recommendations page is refreshed, a status of Active confirms that + // the preference is applied to the recommendations, and a status of Inactive + // confirms that the preference isn't yet applied to recommendations. For more + // information, see Enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. EnhancedInfrastructureMetrics EnhancedInfrastructureMetrics @@ -1513,16 +1316,15 @@ type RecommendationPreferencesDetail struct { // An object that describes the scope of the recommendation preference. // Recommendation preferences can be created at the organization level (for // management accounts of an organization only), account level, and resource level. - // For more information, see Activating enhanced infrastructure metrics - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) + // For more information, see Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. Scope *Scope noSmithyDocumentSerde } -// Describes the source of a recommendation, such as an Amazon EC2 instance or Auto -// Scaling group. +// Describes the source of a recommendation, such as an Amazon EC2 instance or +// Auto Scaling group. type RecommendationSource struct { // The Amazon Resource Name (ARN) of the recommendation source. @@ -1557,20 +1359,20 @@ type RecommendationSummary struct { noSmithyDocumentSerde } -// Describes a projected utilization metric of a recommendation option. The Cpu and -// Memory metrics are the only projected utilization metrics returned when you run -// the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric -// is returned only for resources that have the unified CloudWatch agent installed -// on them. For more information, see Enabling Memory Utilization with the -// CloudWatch Agent -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). +// Describes a projected utilization metric of a recommendation option. The Cpu +// and Memory metrics are the only projected utilization metrics returned when you +// run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory +// metric is returned only for resources that have the unified CloudWatch agent +// installed on them. For more information, see Enabling Memory Utilization with +// the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) +// . type RecommendedOptionProjectedMetric struct { // An array of objects that describe a projected utilization metric. ProjectedMetrics []ProjectedMetric // The rank of the recommendation option projected metric. The top recommendation - // option is ranked as 1. The projected metric rank correlates to the + // option is ranked as 1 . The projected metric rank correlates to the // recommendation option rank. For example, the projected metric ranked as 1 is // related to the recommendation option that is also ranked as 1 in the same // response. @@ -1608,9 +1410,8 @@ type S3Destination struct { // the S3 bucket, ensure that it has the required permission policy to allow // Compute Optimizer to write the export file to it. If you plan to specify an // object prefix when you create the export job, you must include the object prefix -// in the policy that you add to the S3 bucket. For more information, see Amazon S3 -// Bucket Policy for Compute Optimizer -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) +// in the policy that you add to the S3 bucket. For more information, see Amazon +// S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html) // in the Compute Optimizer User Guide. type S3DestinationConfig struct { @@ -1633,16 +1434,14 @@ type S3DestinationConfig struct { // generates savings estimates considering the price of existing resources, the // price of recommended resources, and historical usage data. Estimated monthly // savings reflects the projected dollar savings associated with each of the -// recommendations generated. For more information, see Enabling Cost Explorer -// (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html) -// and Optimizing your cost with Rightsizing Recommendations -// (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html) +// recommendations generated. For more information, see Enabling Cost Explorer (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html) +// and Optimizing your cost with Rightsizing Recommendations (https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html) // in the Cost Management User Guide. type SavingsOpportunity struct { - // An object that describes the estimated monthly savings amount possible, based on - // On-Demand instance pricing, by adopting Compute Optimizer recommendations for a - // given resource. + // An object that describes the estimated monthly savings amount possible, based + // on On-Demand instance pricing, by adopting Compute Optimizer recommendations for + // a given resource. EstimatedMonthlySavings *EstimatedMonthlySavings // The estimated monthly savings possible as a percentage of monthly cost by @@ -1655,8 +1454,7 @@ type SavingsOpportunity struct { // Describes the scope of a recommendation preference. Recommendation preferences // can be created at the organization level (for management accounts of an // organization only), account level, and resource level. For more information, see -// Activating enhanced infrastructure metrics -// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) +// Activating enhanced infrastructure metrics (https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html) // in the Compute Optimizer User Guide. You cannot create recommendation // preferences for Auto Scaling groups at the organization and account levels. You // can create recommendation preferences for Auto Scaling groups only at the @@ -1669,31 +1467,19 @@ type SavingsOpportunity struct { type Scope struct { // The name of the scope. The following scopes are possible: - // - // * Organization - - // Specifies that the recommendation preference applies at the organization level, - // for all member accounts of an organization. - // - // * AccountId - Specifies that the - // recommendation preference applies at the account level, for all resources of a - // given resource type in an account. - // - // * ResourceArn - Specifies that the - // recommendation preference applies at the individual resource level. + // - Organization - Specifies that the recommendation preference applies at the + // organization level, for all member accounts of an organization. + // - AccountId - Specifies that the recommendation preference applies at the + // account level, for all resources of a given resource type in an account. + // - ResourceArn - Specifies that the recommendation preference applies at the + // individual resource level. Name ScopeName // The value of the scope. If you specified the name of the scope as: - // - // * - // Organization - The value must be ALL_ACCOUNTS. - // - // * AccountId - The value must be - // a 12-digit Amazon Web Services account ID. - // - // * ResourceArn - The value must be - // the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling - // group. - // + // - Organization - The value must be ALL_ACCOUNTS . + // - AccountId - The value must be a 12-digit Amazon Web Services account ID. + // - ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 + // instance or an Auto Scaling group. // Only EC2 instance and Auto Scaling group ARNs are currently supported. Value *string @@ -1703,25 +1489,18 @@ type Scope struct { // The Amazon ECS service configurations used for recommendations. type ServiceConfiguration struct { - // Describes the Auto Scaling configuration methods for an Amazon ECS service. This - // affects the generated recommendations. For example, if Auto Scaling is + // Describes the Auto Scaling configuration methods for an Amazon ECS service. + // This affects the generated recommendations. For example, if Auto Scaling is // configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size // recommendations. The Auto Scaling configuration methods include: - // - // * - // TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use - // target scaling on CPU, Compute Optimizer doesn't generate CPU - // recommendations. - // - // * TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service - // is configured to use target scaling on memory, Compute Optimizer doesn't - // generate memory recommendations. - // - // For more information about step scaling and - // target scaling, see Step scaling policies for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) - // and Target tracking scaling policies for Application Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) + // - TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use + // target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations. + // - TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to + // use target scaling on memory, Compute Optimizer doesn't generate memory + // recommendations. + // For more information about step scaling and target scaling, see Step scaling + // policies for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) + // and Target tracking scaling policies for Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) // in the Application Auto Scaling User Guide. AutoScalingConfiguration AutoScalingConfiguration @@ -1763,92 +1542,67 @@ type UtilizationMetric struct { // The name of the utilization metric. The following utilization metrics are // available: - // - // * Cpu - The percentage of allocated EC2 compute units that are - // currently in use on the instance. This metric identifies the processing power - // required to run an application on the instance. Depending on the instance type, - // tools in your operating system can show a lower percentage than CloudWatch when - // the instance is not allocated a full processor core. Units: Percent - // - // * Memory - - // The percentage of memory that is currently in use on the instance. This metric - // identifies the amount of memory required to run an application on the instance. - // Units: Percent The Memory metric is returned only for resources that have the - // unified CloudWatch agent installed on them. For more information, see Enabling - // Memory Utilization with the CloudWatch Agent - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). - // - // * - // EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes - // attached to the instance in a specified period of time. Unit: Count - // - // * - // EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes - // attached to the instance in a specified period of time. Unit: Count - // - // * - // EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the - // instance in a specified period of time. Unit: Bytes - // - // * - // EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to - // the instance in a specified period of time. Unit: Bytes - // - // * - // DISK_READ_OPS_PER_SECOND - The completed read operations from all instance store - // volumes available to the instance in a specified period of time. If there are no - // instance store volumes, either the value is 0 or the metric is not reported. - // - // * - // DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance - // store volumes available to the instance in a specified period of time. If there - // are no instance store volumes, either the value is 0 or the metric is not - // reported. - // - // * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store - // volumes available to the instance. This metric is used to determine the volume - // of the data the application reads from the disk of the instance. This can be - // used to determine the speed of the application. If there are no instance store - // volumes, either the value is 0 or the metric is not reported. - // - // * - // DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store volumes - // available to the instance. This metric is used to determine the volume of the - // data the application writes onto the disk of the instance. This can be used to - // determine the speed of the application. If there are no instance store volumes, - // either the value is 0 or the metric is not reported. - // - // * - // NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance on - // all network interfaces. This metric identifies the volume of incoming network - // traffic to a single instance. - // - // * NETWORK_OUT_BYTES_PER_SECOND - The number of - // bytes sent out by the instance on all network interfaces. This metric identifies - // the volume of outgoing network traffic from a single instance. - // - // * - // NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the instance - // on all network interfaces. This metric identifies the volume of incoming traffic - // in terms of the number of packets on a single instance. - // - // * - // NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the instance - // on all network interfaces. This metric identifies the volume of outgoing traffic - // in terms of the number of packets on a single instance. + // - Cpu - The percentage of allocated EC2 compute units that are currently in + // use on the instance. This metric identifies the processing power required to run + // an application on the instance. Depending on the instance type, tools in your + // operating system can show a lower percentage than CloudWatch when the instance + // is not allocated a full processor core. Units: Percent + // - Memory - The percentage of memory that is currently in use on the instance. + // This metric identifies the amount of memory required to run an application on + // the instance. Units: Percent The Memory metric is returned only for resources + // that have the unified CloudWatch agent installed on them. For more information, + // see Enabling Memory Utilization with the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent) + // . + // - EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes + // attached to the instance in a specified period of time. Unit: Count + // - EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes + // attached to the instance in a specified period of time. Unit: Count + // - EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to + // the instance in a specified period of time. Unit: Bytes + // - EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached + // to the instance in a specified period of time. Unit: Bytes + // - DISK_READ_OPS_PER_SECOND - The completed read operations from all instance + // store volumes available to the instance in a specified period of time. If there + // are no instance store volumes, either the value is 0 or the metric is not + // reported. + // - DISK_WRITE_OPS_PER_SECOND - The completed write operations from all instance + // store volumes available to the instance in a specified period of time. If there + // are no instance store volumes, either the value is 0 or the metric is not + // reported. + // - DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store volumes + // available to the instance. This metric is used to determine the volume of the + // data the application reads from the disk of the instance. This can be used to + // determine the speed of the application. If there are no instance store volumes, + // either the value is 0 or the metric is not reported. + // - DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance store + // volumes available to the instance. This metric is used to determine the volume + // of the data the application writes onto the disk of the instance. This can be + // used to determine the speed of the application. If there are no instance store + // volumes, either the value is 0 or the metric is not reported. + // - NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the instance + // on all network interfaces. This metric identifies the volume of incoming network + // traffic to a single instance. + // - NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the instance + // on all network interfaces. This metric identifies the volume of outgoing network + // traffic from a single instance. + // - NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by the + // instance on all network interfaces. This metric identifies the volume of + // incoming traffic in terms of the number of packets on a single instance. + // - NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out by the + // instance on all network interfaces. This metric identifies the volume of + // outgoing traffic in terms of the number of packets on a single instance. Name MetricName - // The statistic of the utilization metric. The Compute Optimizer API, Command Line - // Interface (CLI), and SDKs return utilization metrics using only the Maximum + // The statistic of the utilization metric. The Compute Optimizer API, Command + // Line Interface (CLI), and SDKs return utilization metrics using only the Maximum // statistic, which is the highest value observed during the specified period. The // Compute Optimizer console displays graphs for some utilization metrics using the // Average statistic, which is the value of Sum / SampleCount during the specified - // period. For more information, see Viewing resource recommendations - // (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) + // period. For more information, see Viewing resource recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html) // in the Compute Optimizer User Guide. You can also get averaged utilization // metric data for your resources using Amazon CloudWatch. For more information, - // see the Amazon CloudWatch User Guide - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). + // see the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) + // . Statistic MetricStatistic // The value of the utilization metric. @@ -1902,16 +1656,13 @@ type VolumeRecommendation struct { CurrentPerformanceRisk CurrentPerformanceRisk // The finding classification of the volume. Findings for volumes include: - // - // * - // NotOptimized —A volume is considered not optimized when Compute Optimizer - // identifies a recommendation that can provide better performance for your - // workload. - // - // * Optimized —An volume is considered optimized when Compute Optimizer - // determines that the volume is correctly provisioned to run your workload based - // on the chosen volume type. For optimized resources, Compute Optimizer might - // recommend a new generation volume type. + // - NotOptimized —A volume is considered not optimized when Compute Optimizer + // identifies a recommendation that can provide better performance for your + // workload. + // - Optimized —An volume is considered optimized when Compute Optimizer + // determines that the volume is correctly provisioned to run your workload based + // on the chosen volume type. For optimized resources, Compute Optimizer might + // recommend a new generation volume type. Finding EBSFinding // The timestamp of when the volume recommendation was last generated. @@ -1932,8 +1683,8 @@ type VolumeRecommendation struct { noSmithyDocumentSerde } -// Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) -// instance. +// Describes a recommendation option for an Amazon Elastic Block Store (Amazon +// EBS) instance. type VolumeRecommendationOption struct { // An array of objects that describe a volume configuration. @@ -1941,7 +1692,7 @@ type VolumeRecommendationOption struct { // The performance risk of the volume recommendation option. Performance risk is // the likelihood of the recommended volume type meeting the performance - // requirement of your workload. The value ranges from 0 - 4, with 0 meaning that + // requirement of your workload. The value ranges from 0 - 4 , with 0 meaning that // the recommended resource is predicted to always provide enough hardware // capability. The higher the performance risk is, the more likely you should // validate whether the recommendation will meet the performance requirements of @@ -1949,7 +1700,7 @@ type VolumeRecommendationOption struct { PerformanceRisk float64 // The rank of the volume recommendation option. The top recommendation option is - // ranked as 1. + // ranked as 1 . Rank int32 // An object that describes the savings opportunity for the EBS volume diff --git a/service/configservice/api_client.go b/service/configservice/api_client.go index f3933c8b80f..3bf472947d9 100644 --- a/service/configservice/api_client.go +++ b/service/configservice/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/configservice/api_op_BatchGetAggregateResourceConfig.go b/service/configservice/api_op_BatchGetAggregateResourceConfig.go index 80cb03affa4..1c77670b571 100644 --- a/service/configservice/api_op_BatchGetAggregateResourceConfig.go +++ b/service/configservice/api_op_BatchGetAggregateResourceConfig.go @@ -15,12 +15,8 @@ import ( // Config aggregator. The operation also returns a list of resources that are not // processed in the current request. If there are no unprocessed resources, the // operation returns an empty unprocessedResourceIdentifiers list. -// -// * The API does -// not return results for deleted resources. -// -// * The API does not return tags and -// relationships. +// - The API does not return results for deleted resources. +// - The API does not return tags and relationships. func (c *Client) BatchGetAggregateResourceConfig(ctx context.Context, params *BatchGetAggregateResourceConfigInput, optFns ...func(*Options)) (*BatchGetAggregateResourceConfigOutput, error) { if params == nil { params = &BatchGetAggregateResourceConfigInput{} diff --git a/service/configservice/api_op_BatchGetResourceConfig.go b/service/configservice/api_op_BatchGetResourceConfig.go index e859bb65702..b274d016c97 100644 --- a/service/configservice/api_op_BatchGetResourceConfig.go +++ b/service/configservice/api_op_BatchGetResourceConfig.go @@ -15,13 +15,10 @@ import ( // operation also returns a list of resources that are not processed in the current // request. If there are no unprocessed resources, the operation returns an empty // unprocessedResourceKeys list. -// -// * The API does not return results for deleted -// resources. -// -// * The API does not return any tags for the requested resources. This -// information is filtered out of the supplementaryConfiguration section of the API -// response. +// - The API does not return results for deleted resources. +// - The API does not return any tags for the requested resources. This +// information is filtered out of the supplementaryConfiguration section of the API +// response. func (c *Client) BatchGetResourceConfig(ctx context.Context, params *BatchGetResourceConfigInput, optFns ...func(*Options)) (*BatchGetResourceConfigOutput, error) { if params == nil { params = &BatchGetResourceConfigInput{} diff --git a/service/configservice/api_op_DeleteConfigRule.go b/service/configservice/api_op_DeleteConfigRule.go index 946f682b510..a291c1c4da1 100644 --- a/service/configservice/api_op_DeleteConfigRule.go +++ b/service/configservice/api_op_DeleteConfigRule.go @@ -10,12 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Config rule and all of its evaluation results. Config sets -// the state of a rule to DELETING until the deletion is complete. You cannot +// Deletes the specified Config rule and all of its evaluation results. Config +// sets the state of a rule to DELETING until the deletion is complete. You cannot // update a rule while it is in this state. If you make a PutConfigRule or -// DeleteConfigRule request for the rule, you will receive a -// ResourceInUseException. You can check the state of a rule by using the -// DescribeConfigRules request. +// DeleteConfigRule request for the rule, you will receive a ResourceInUseException +// . You can check the state of a rule by using the DescribeConfigRules request. func (c *Client) DeleteConfigRule(ctx context.Context, params *DeleteConfigRuleInput, optFns ...func(*Options)) (*DeleteConfigRuleOutput, error) { if params == nil { params = &DeleteConfigRuleInput{} diff --git a/service/configservice/api_op_DeleteConfigurationRecorder.go b/service/configservice/api_op_DeleteConfigurationRecorder.go index 2beac738fbc..bea4d623660 100644 --- a/service/configservice/api_op_DeleteConfigurationRecorder.go +++ b/service/configservice/api_op_DeleteConfigurationRecorder.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the configuration recorder. After the configuration recorder is deleted, -// Config will not record resource configuration changes until you create a new -// configuration recorder. This action does not delete the configuration +// Deletes the configuration recorder. After the configuration recorder is +// deleted, Config will not record resource configuration changes until you create +// a new configuration recorder. This action does not delete the configuration // information that was previously recorded. You will be able to access the // previously recorded information by using the GetResourceConfigHistory action, // but you will not be able to access this information in the Config console until diff --git a/service/configservice/api_op_DeleteDeliveryChannel.go b/service/configservice/api_op_DeleteDeliveryChannel.go index ed5d22e7eb2..eb791043069 100644 --- a/service/configservice/api_op_DeleteDeliveryChannel.go +++ b/service/configservice/api_op_DeleteDeliveryChannel.go @@ -28,8 +28,8 @@ func (c *Client) DeleteDeliveryChannel(ctx context.Context, params *DeleteDelive return out, nil } -// The input for the DeleteDeliveryChannel action. The action accepts the following -// data, in JSON format. +// The input for the DeleteDeliveryChannel action. The action accepts the +// following data, in JSON format. type DeleteDeliveryChannelInput struct { // The name of the delivery channel to delete. diff --git a/service/configservice/api_op_DeleteOrganizationConfigRule.go b/service/configservice/api_op_DeleteOrganizationConfigRule.go index 56a82785957..d68e57ecbf4 100644 --- a/service/configservice/api_op_DeleteOrganizationConfigRule.go +++ b/service/configservice/api_op_DeleteOrganizationConfigRule.go @@ -10,13 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified organization Config rule and all of its evaluation results -// from all member accounts in that organization. Only a management account and a -// delegated administrator account can delete an organization Config rule. When -// calling this API with a delegated administrator, you must ensure Organizations -// ListDelegatedAdministrator permissions are added. Config sets the state of a -// rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a -// rule while it is in this state. +// Deletes the specified organization Config rule and all of its evaluation +// results from all member accounts in that organization. Only a management account +// and a delegated administrator account can delete an organization Config rule. +// When calling this API with a delegated administrator, you must ensure +// Organizations ListDelegatedAdministrator permissions are added. Config sets the +// state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot +// update a rule while it is in this state. func (c *Client) DeleteOrganizationConfigRule(ctx context.Context, params *DeleteOrganizationConfigRuleInput, optFns ...func(*Options)) (*DeleteOrganizationConfigRuleOutput, error) { if params == nil { params = &DeleteOrganizationConfigRuleInput{} diff --git a/service/configservice/api_op_DeliverConfigSnapshot.go b/service/configservice/api_op_DeliverConfigSnapshot.go index 191f3101049..0d67025b907 100644 --- a/service/configservice/api_op_DeliverConfigSnapshot.go +++ b/service/configservice/api_op_DeliverConfigSnapshot.go @@ -13,15 +13,10 @@ import ( // Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the // specified delivery channel. After the delivery has started, Config sends the // following notifications using an Amazon SNS topic that you have specified. -// -// * -// Notification of the start of the delivery. -// -// * Notification of the completion of -// the delivery, if the delivery was successfully completed. -// -// * Notification of -// delivery failure, if the delivery failed. +// - Notification of the start of the delivery. +// - Notification of the completion of the delivery, if the delivery was +// successfully completed. +// - Notification of delivery failure, if the delivery failed. func (c *Client) DeliverConfigSnapshot(ctx context.Context, params *DeliverConfigSnapshotInput, optFns ...func(*Options)) (*DeliverConfigSnapshotOutput, error) { if params == nil { params = &DeliverConfigSnapshotInput{} diff --git a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go index df51b9018c1..7ca681c72fc 100644 --- a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go +++ b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go @@ -15,7 +15,7 @@ import ( // Returns a list of compliant and noncompliant rules with the number of resources // for compliant and noncompliant rules. Does not display rules that do not have // compliance results. The results can return an empty result page, but if you have -// a nextToken, the results are displayed on the next page. +// a nextToken , the results are displayed on the next page. func (c *Client) DescribeAggregateComplianceByConfigRules(ctx context.Context, params *DescribeAggregateComplianceByConfigRulesInput, optFns ...func(*Options)) (*DescribeAggregateComplianceByConfigRulesOutput, error) { if params == nil { params = &DescribeAggregateComplianceByConfigRulesInput{} diff --git a/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go b/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go index f201e032a72..73c17373b49 100644 --- a/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go +++ b/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go @@ -17,7 +17,7 @@ import ( // conformance pack. Also returns the total rule count which includes compliant // rules, noncompliant rules, and rules that cannot be evaluated due to // insufficient data. The results can return an empty result page, but if you have -// a nextToken, the results are displayed on the next page. +// a nextToken , the results are displayed on the next page. func (c *Client) DescribeAggregateComplianceByConformancePacks(ctx context.Context, params *DescribeAggregateComplianceByConformancePacksInput, optFns ...func(*Options)) (*DescribeAggregateComplianceByConformancePacksOutput, error) { if params == nil { params = &DescribeAggregateComplianceByConformancePacksInput{} diff --git a/service/configservice/api_op_DescribeComplianceByConfigRule.go b/service/configservice/api_op_DescribeComplianceByConfigRule.go index 67590fb56f5..0d25202c984 100644 --- a/service/configservice/api_op_DescribeComplianceByConfigRule.go +++ b/service/configservice/api_op_DescribeComplianceByConfigRule.go @@ -17,22 +17,17 @@ import ( // that do not comply with the rule. A rule is compliant if all of the evaluated // resources comply with it. It is noncompliant if any of these resources do not // comply. If Config has no current evaluation results for the rule, it returns -// INSUFFICIENT_DATA. This result might indicate one of the following -// conditions: -// -// * Config has never invoked an evaluation for the rule. To check -// whether it has, use the DescribeConfigRuleEvaluationStatus action to get the -// LastSuccessfulInvocationTime and LastFailedInvocationTime. -// -// * The rule's Lambda -// function is failing to send evaluation results to Config. Verify that the role -// you assigned to your configuration recorder includes the config:PutEvaluations -// permission. If the rule is a custom rule, verify that the Lambda execution role -// includes the config:PutEvaluations permission. -// -// * The rule's Lambda function has -// returned NOT_APPLICABLE for all evaluation results. This can occur if the -// resources were deleted or removed from the rule's scope. +// INSUFFICIENT_DATA . This result might indicate one of the following conditions: +// - Config has never invoked an evaluation for the rule. To check whether it +// has, use the DescribeConfigRuleEvaluationStatus action to get the +// LastSuccessfulInvocationTime and LastFailedInvocationTime . +// - The rule's Lambda function is failing to send evaluation results to Config. +// Verify that the role you assigned to your configuration recorder includes the +// config:PutEvaluations permission. If the rule is a custom rule, verify that +// the Lambda execution role includes the config:PutEvaluations permission. +// - The rule's Lambda function has returned NOT_APPLICABLE for all evaluation +// results. This can occur if the resources were deleted or removed from the rule's +// scope. func (c *Client) DescribeComplianceByConfigRule(ctx context.Context, params *DescribeComplianceByConfigRuleInput, optFns ...func(*Options)) (*DescribeComplianceByConfigRuleOutput, error) { if params == nil { params = &DescribeComplianceByConfigRuleInput{} diff --git a/service/configservice/api_op_DescribeComplianceByResource.go b/service/configservice/api_op_DescribeComplianceByResource.go index 9858f496931..5dd969abd91 100644 --- a/service/configservice/api_op_DescribeComplianceByResource.go +++ b/service/configservice/api_op_DescribeComplianceByResource.go @@ -17,23 +17,18 @@ import ( // the resource does not comply with. A resource is compliant if it complies with // all the Config rules that evaluate it. It is noncompliant if it does not comply // with one or more of these rules. If Config has no current evaluation results for -// the resource, it returns INSUFFICIENT_DATA. This result might indicate one of +// the resource, it returns INSUFFICIENT_DATA . This result might indicate one of // the following conditions about the rules that evaluate the resource: -// -// * Config -// has never invoked an evaluation for the rule. To check whether it has, use the -// DescribeConfigRuleEvaluationStatus action to get the -// LastSuccessfulInvocationTime and LastFailedInvocationTime. -// -// * The rule's Lambda -// function is failing to send evaluation results to Config. Verify that the role -// that you assigned to your configuration recorder includes the -// config:PutEvaluations permission. If the rule is a custom rule, verify that the -// Lambda execution role includes the config:PutEvaluations permission. -// -// * The -// rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. -// This can occur if the resources were deleted or removed from the rule's scope. +// - Config has never invoked an evaluation for the rule. To check whether it +// has, use the DescribeConfigRuleEvaluationStatus action to get the +// LastSuccessfulInvocationTime and LastFailedInvocationTime . +// - The rule's Lambda function is failing to send evaluation results to Config. +// Verify that the role that you assigned to your configuration recorder includes +// the config:PutEvaluations permission. If the rule is a custom rule, verify +// that the Lambda execution role includes the config:PutEvaluations permission. +// - The rule's Lambda function has returned NOT_APPLICABLE for all evaluation +// results. This can occur if the resources were deleted or removed from the rule's +// scope. func (c *Client) DescribeComplianceByResource(ctx context.Context, params *DescribeComplianceByResourceInput, optFns ...func(*Options)) (*DescribeComplianceByResourceOutput, error) { if params == nil { params = &DescribeComplianceByResourceInput{} @@ -65,13 +60,13 @@ type DescribeComplianceByResourceInput struct { // The ID of the Amazon Web Services resource for which you want compliance // information. You can specify only one resource ID. If you specify a resource ID, - // you must also specify a type for ResourceType. + // you must also specify a type for ResourceType . ResourceId *string // The types of Amazon Web Services resources for which you want compliance - // information (for example, AWS::EC2::Instance). For this action, you can specify + // information (for example, AWS::EC2::Instance ). For this action, you can specify // that the resource type is an Amazon Web Services account by specifying - // AWS::::Account. + // AWS::::Account . ResourceType *string noSmithyDocumentSerde diff --git a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go index 4b11b26c8d1..5c3933d236d 100644 --- a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go +++ b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go @@ -40,8 +40,7 @@ type DescribeConfigRuleEvaluationStatusInput struct { // The number of rule evaluation results that you want returned. This parameter is // required if the rule limit for your account is more than the default of 150 - // rules. For information about requesting a rule limit increase, see Config Limits - // (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config) + // rules. For information about requesting a rule limit increase, see Config Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config) // in the Amazon Web Services General Reference Guide. Limit int32 @@ -140,8 +139,7 @@ var _ DescribeConfigRuleEvaluationStatusAPIClient = (*Client)(nil) type DescribeConfigRuleEvaluationStatusPaginatorOptions struct { // The number of rule evaluation results that you want returned. This parameter is // required if the rule limit for your account is more than the default of 150 - // rules. For information about requesting a rule limit increase, see Config Limits - // (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config) + // rules. For information about requesting a rule limit increase, see Config Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config) // in the Amazon Web Services General Reference Guide. Limit int32 diff --git a/service/configservice/api_op_DescribeConfigRules.go b/service/configservice/api_op_DescribeConfigRules.go index 5126bbe4863..6873b8135c7 100644 --- a/service/configservice/api_op_DescribeConfigRules.go +++ b/service/configservice/api_op_DescribeConfigRules.go @@ -36,8 +36,7 @@ type DescribeConfigRulesInput struct { // Returns a list of Detective or Proactive Config rules. By default, this API // returns an unfiltered list. For more information on Detective or Proactive - // Config rules, see Evaluation Mode - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html) + // Config rules, see Evaluation Mode (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html) // in the Config Developer Guide. Filters *types.DescribeConfigRulesFilters @@ -123,8 +122,8 @@ func (c *Client) addOperationDescribeConfigRulesMiddlewares(stack *middleware.St return nil } -// DescribeConfigRulesAPIClient is a client that implements the DescribeConfigRules -// operation. +// DescribeConfigRulesAPIClient is a client that implements the +// DescribeConfigRules operation. type DescribeConfigRulesAPIClient interface { DescribeConfigRules(context.Context, *DescribeConfigRulesInput, ...func(*Options)) (*DescribeConfigRulesOutput, error) } diff --git a/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go b/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go index bcb28d0d016..d41f7b829ee 100644 --- a/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go +++ b/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns status information for sources within an aggregator. The status includes -// information about the last time Config verified authorization between the source -// account and an aggregator account. In case of a failure, the status contains the -// related error code or message. +// Returns status information for sources within an aggregator. The status +// includes information about the last time Config verified authorization between +// the source account and an aggregator account. In case of a failure, the status +// contains the related error code or message. func (c *Client) DescribeConfigurationAggregatorSourcesStatus(ctx context.Context, params *DescribeConfigurationAggregatorSourcesStatusInput, optFns ...func(*Options)) (*DescribeConfigurationAggregatorSourcesStatusOutput, error) { if params == nil { params = &DescribeConfigurationAggregatorSourcesStatusInput{} @@ -47,14 +47,9 @@ type DescribeConfigurationAggregatorSourcesStatusInput struct { NextToken *string // Filters the status type. - // - // * Valid value FAILED indicates errors while moving - // data. - // - // * Valid value SUCCEEDED indicates the data was successfully moved. - // - // * - // Valid value OUTDATED indicates the data is not the most recent. + // - Valid value FAILED indicates errors while moving data. + // - Valid value SUCCEEDED indicates the data was successfully moved. + // - Valid value OUTDATED indicates the data is not the most recent. UpdateStatus []types.AggregatedSourceStatusType noSmithyDocumentSerde diff --git a/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go b/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go index ec8a575bfc7..e8fd0a93eb4 100644 --- a/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go +++ b/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go @@ -44,8 +44,8 @@ type DescribeOrganizationConfigRuleStatusesInput struct { // page of results in a paginated response. NextToken *string - // The names of organization Config rules for which you want status details. If you - // do not specify any names, Config returns details for all your organization + // The names of organization Config rules for which you want status details. If + // you do not specify any names, Config returns details for all your organization // Config rules. OrganizationConfigRuleNames []string diff --git a/service/configservice/api_op_DescribeOrganizationConfigRules.go b/service/configservice/api_op_DescribeOrganizationConfigRules.go index 527692eb831..539fbce1163 100644 --- a/service/configservice/api_op_DescribeOrganizationConfigRules.go +++ b/service/configservice/api_op_DescribeOrganizationConfigRules.go @@ -43,16 +43,16 @@ func (c *Client) DescribeOrganizationConfigRules(ctx context.Context, params *De type DescribeOrganizationConfigRulesInput struct { - // The maximum number of organization Config rules returned on each page. If you do - // no specify a number, Config uses the default. The default is 100. + // The maximum number of organization Config rules returned on each page. If you + // do no specify a number, Config uses the default. The default is 100. Limit int32 // The nextToken string returned on a previous page that you use to get the next // page of results in a paginated response. NextToken *string - // The names of organization Config rules for which you want details. If you do not - // specify any names, Config returns details for all your organization Config + // The names of organization Config rules for which you want details. If you do + // not specify any names, Config returns details for all your organization Config // rules. OrganizationConfigRuleNames []string @@ -145,8 +145,8 @@ var _ DescribeOrganizationConfigRulesAPIClient = (*Client)(nil) // DescribeOrganizationConfigRulesPaginatorOptions is the paginator options for // DescribeOrganizationConfigRules type DescribeOrganizationConfigRulesPaginatorOptions struct { - // The maximum number of organization Config rules returned on each page. If you do - // no specify a number, Config uses the default. The default is 100. + // The maximum number of organization Config rules returned on each page. If you + // do no specify a number, Config uses the default. The default is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go b/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go index a88a00ada7b..a2a06152caa 100644 --- a/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go +++ b/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go @@ -36,8 +36,9 @@ func (c *Client) DescribeOrganizationConformancePackStatuses(ctx context.Context type DescribeOrganizationConformancePackStatusesInput struct { - // The maximum number of OrganizationConformancePackStatuses returned on each page. - // If you do no specify a number, Config uses the default. The default is 100. + // The maximum number of OrganizationConformancePackStatuses returned on each + // page. If you do no specify a number, Config uses the default. The default is + // 100. Limit int32 // The nextToken string returned on a previous page that you use to get the next @@ -127,8 +128,8 @@ func (c *Client) addOperationDescribeOrganizationConformancePackStatusesMiddlewa return nil } -// DescribeOrganizationConformancePackStatusesAPIClient is a client that implements -// the DescribeOrganizationConformancePackStatuses operation. +// DescribeOrganizationConformancePackStatusesAPIClient is a client that +// implements the DescribeOrganizationConformancePackStatuses operation. type DescribeOrganizationConformancePackStatusesAPIClient interface { DescribeOrganizationConformancePackStatuses(context.Context, *DescribeOrganizationConformancePackStatusesInput, ...func(*Options)) (*DescribeOrganizationConformancePackStatusesOutput, error) } @@ -138,8 +139,9 @@ var _ DescribeOrganizationConformancePackStatusesAPIClient = (*Client)(nil) // DescribeOrganizationConformancePackStatusesPaginatorOptions is the paginator // options for DescribeOrganizationConformancePackStatuses type DescribeOrganizationConformancePackStatusesPaginatorOptions struct { - // The maximum number of OrganizationConformancePackStatuses returned on each page. - // If you do no specify a number, Config uses the default. The default is 100. + // The maximum number of OrganizationConformancePackStatuses returned on each + // page. If you do no specify a number, Config uses the default. The default is + // 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_DescribeOrganizationConformancePacks.go b/service/configservice/api_op_DescribeOrganizationConformancePacks.go index 59600d555b0..68cdc7070db 100644 --- a/service/configservice/api_op_DescribeOrganizationConformancePacks.go +++ b/service/configservice/api_op_DescribeOrganizationConformancePacks.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of organization conformance packs. When you specify the limit and -// the next token, you receive a paginated response. Limit and next token are not -// applicable if you specify organization conformance packs names. They are only -// applicable, when you request all the organization conformance packs. For +// Returns a list of organization conformance packs. When you specify the limit +// and the next token, you receive a paginated response. Limit and next token are +// not applicable if you specify organization conformance packs names. They are +// only applicable, when you request all the organization conformance packs. For // accounts within an organzation If you deploy an organizational rule or // conformance pack in an organization administrator account, and then establish a // delegated administrator and deploy an organizational rule or conformance pack in @@ -44,8 +44,8 @@ func (c *Client) DescribeOrganizationConformancePacks(ctx context.Context, param type DescribeOrganizationConformancePacksInput struct { - // The maximum number of organization config packs returned on each page. If you do - // no specify a number, Config uses the default. The default is 100. + // The maximum number of organization config packs returned on each page. If you + // do no specify a number, Config uses the default. The default is 100. Limit int32 // The nextToken string returned on a previous page that you use to get the next @@ -144,8 +144,8 @@ var _ DescribeOrganizationConformancePacksAPIClient = (*Client)(nil) // DescribeOrganizationConformancePacksPaginatorOptions is the paginator options // for DescribeOrganizationConformancePacks type DescribeOrganizationConformancePacksPaginatorOptions struct { - // The maximum number of organization config packs returned on each page. If you do - // no specify a number, Config uses the default. The default is 100. + // The maximum number of organization config packs returned on each page. If you + // do no specify a number, Config uses the default. The default is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_DescribeRemediationExceptions.go b/service/configservice/api_op_DescribeRemediationExceptions.go index 6b9f8d1f2dc..18622d4df00 100644 --- a/service/configservice/api_op_DescribeRemediationExceptions.go +++ b/service/configservice/api_op_DescribeRemediationExceptions.go @@ -43,8 +43,8 @@ type DescribeRemediationExceptionsInput struct { // This member is required. ConfigRuleName *string - // The maximum number of RemediationExceptionResourceKey returned on each page. The - // default is 25. If you specify 0, Config uses the default. + // The maximum number of RemediationExceptionResourceKey returned on each page. + // The default is 25. If you specify 0, Config uses the default. Limit int32 // The nextToken string returned in a previous request that you use to request the @@ -148,8 +148,8 @@ var _ DescribeRemediationExceptionsAPIClient = (*Client)(nil) // DescribeRemediationExceptionsPaginatorOptions is the paginator options for // DescribeRemediationExceptions type DescribeRemediationExceptionsPaginatorOptions struct { - // The maximum number of RemediationExceptionResourceKey returned on each page. The - // default is 25. If you specify 0, Config uses the default. + // The maximum number of RemediationExceptionResourceKey returned on each page. + // The default is 25. If you specify 0, Config uses the default. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go b/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go index cad9b629de4..2eda387b4f5 100644 --- a/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go +++ b/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go @@ -16,7 +16,7 @@ import ( // resource in a rule. The results indicate which Amazon Web Services resources // were evaluated by the rule, when each resource was last evaluated, and whether // each resource complies with the rule. The results can return an empty result -// page. But if you have a nextToken, the results are displayed on the next page. +// page. But if you have a nextToken , the results are displayed on the next page. func (c *Client) GetAggregateComplianceDetailsByConfigRule(ctx context.Context, params *GetAggregateComplianceDetailsByConfigRuleInput, optFns ...func(*Options)) (*GetAggregateComplianceDetailsByConfigRuleOutput, error) { if params == nil { params = &GetAggregateComplianceDetailsByConfigRuleInput{} @@ -56,8 +56,8 @@ type GetAggregateComplianceDetailsByConfigRuleInput struct { // The resource compliance status. For the // GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only - // the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and - // INSUFFICIENT_DATA values. + // the COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE + // and INSUFFICIENT_DATA values. ComplianceType types.ComplianceType // The maximum number of evaluation results returned on each page. The default is diff --git a/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go b/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go index 90a00f8864c..09c9677a581 100644 --- a/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go +++ b/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go @@ -136,16 +136,16 @@ func (c *Client) addOperationGetAggregateConfigRuleComplianceSummaryMiddlewares( return nil } -// GetAggregateConfigRuleComplianceSummaryAPIClient is a client that implements the -// GetAggregateConfigRuleComplianceSummary operation. +// GetAggregateConfigRuleComplianceSummaryAPIClient is a client that implements +// the GetAggregateConfigRuleComplianceSummary operation. type GetAggregateConfigRuleComplianceSummaryAPIClient interface { GetAggregateConfigRuleComplianceSummary(context.Context, *GetAggregateConfigRuleComplianceSummaryInput, ...func(*Options)) (*GetAggregateConfigRuleComplianceSummaryOutput, error) } var _ GetAggregateConfigRuleComplianceSummaryAPIClient = (*Client)(nil) -// GetAggregateConfigRuleComplianceSummaryPaginatorOptions is the paginator options -// for GetAggregateConfigRuleComplianceSummary +// GetAggregateConfigRuleComplianceSummaryPaginatorOptions is the paginator +// options for GetAggregateConfigRuleComplianceSummary type GetAggregateConfigRuleComplianceSummaryPaginatorOptions struct { // The maximum number of evaluation results returned on each page. The default is // 1000. You cannot specify a number greater than 1000. If you specify 0, Config diff --git a/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go b/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go index d299bde1d55..7054e29bad2 100644 --- a/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go +++ b/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go @@ -43,8 +43,8 @@ type GetAggregateConformancePackComplianceSummaryInput struct { // AggregateConformancePackComplianceSummaryFilters object. Filters *types.AggregateConformancePackComplianceSummaryFilters - // Groups the result based on Amazon Web Services account ID or Amazon Web Services - // Region. + // Groups the result based on Amazon Web Services account ID or Amazon Web + // Services Region. GroupByKey types.AggregateConformancePackComplianceSummaryGroupKey // The maximum number of results returned on each page. The default is maximum. If @@ -63,8 +63,8 @@ type GetAggregateConformancePackComplianceSummaryOutput struct { // Returns a list of AggregateConformancePackComplianceSummary object. AggregateConformancePackComplianceSummaries []types.AggregateConformancePackComplianceSummary - // Groups the result based on Amazon Web Services account ID or Amazon Web Services - // Region. + // Groups the result based on Amazon Web Services account ID or Amazon Web + // Services Region. GroupByKey *string // The nextToken string returned on a previous page that you use to get the next diff --git a/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go b/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go index 23fa338f99e..d4ba2202de0 100644 --- a/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go +++ b/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the resource counts across accounts and regions that are present in your -// Config aggregator. You can request the resource counts by providing filters and -// GroupByKey. For example, if the input contains accountID 12345678910 and region -// us-east-1 in filters, the API returns the count of resources in account ID -// 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a +// Returns the resource counts across accounts and regions that are present in +// your Config aggregator. You can request the resource counts by providing filters +// and GroupByKey. For example, if the input contains accountID 12345678910 and +// region us-east-1 in filters, the API returns the count of resources in account +// ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a // GroupByKey, the API returns resource counts for all source accounts that are // present in your aggregator. func (c *Client) GetAggregateDiscoveredResourceCounts(ctx context.Context, params *GetAggregateDiscoveredResourceCountsInput, optFns ...func(*Options)) (*GetAggregateDiscoveredResourceCountsOutput, error) { @@ -61,8 +61,8 @@ type GetAggregateDiscoveredResourceCountsInput struct { type GetAggregateDiscoveredResourceCountsOutput struct { - // The total number of resources that are present in an aggregator with the filters - // that you provide. + // The total number of resources that are present in an aggregator with the + // filters that you provide. // // This member is required. TotalDiscoveredResources int64 diff --git a/service/configservice/api_op_GetComplianceDetailsByResource.go b/service/configservice/api_op_GetComplianceDetailsByResource.go index bcc0c718c5a..1454779233d 100644 --- a/service/configservice/api_op_GetComplianceDetailsByResource.go +++ b/service/configservice/api_op_GetComplianceDetailsByResource.go @@ -43,7 +43,7 @@ type GetComplianceDetailsByResourceInput struct { // The unique ID of Amazon Web Services resource execution for which you want to // retrieve evaluation results. You need to only provide either a - // ResourceEvaluationID or a ResourceID and ResourceType. + // ResourceEvaluationID or a ResourceID and ResourceType . ResourceEvaluationId *string // The ID of the Amazon Web Services resource for which you want compliance diff --git a/service/configservice/api_op_GetComplianceSummaryByResourceType.go b/service/configservice/api_op_GetComplianceSummaryByResourceType.go index 4c9e797a443..5c20c4f3a43 100644 --- a/service/configservice/api_op_GetComplianceSummaryByResourceType.go +++ b/service/configservice/api_op_GetComplianceSummaryByResourceType.go @@ -34,8 +34,8 @@ type GetComplianceSummaryByResourceTypeInput struct { // Specify one or more resource types to get the number of resources that are // compliant and the number that are noncompliant for each resource type. For this // request, you can specify an Amazon Web Services resource type such as - // AWS::EC2::Instance. You can specify that the resource type is an Amazon Web - // Services account by specifying AWS::::Account. + // AWS::EC2::Instance . You can specify that the resource type is an Amazon Web + // Services account by specifying AWS::::Account . ResourceTypes []string noSmithyDocumentSerde @@ -43,9 +43,9 @@ type GetComplianceSummaryByResourceTypeInput struct { type GetComplianceSummaryByResourceTypeOutput struct { - // The number of resources that are compliant and the number that are noncompliant. - // If one or more resource types were provided with the request, the numbers are - // returned for each resource type. The maximum number returned is 100. + // The number of resources that are compliant and the number that are + // noncompliant. If one or more resource types were provided with the request, the + // numbers are returned for each resource type. The maximum number returned is 100. ComplianceSummariesByResourceType []types.ComplianceSummaryByResourceType // Metadata pertaining to the operation's result. diff --git a/service/configservice/api_op_GetConformancePackComplianceDetails.go b/service/configservice/api_op_GetConformancePackComplianceDetails.go index 762e26ae826..7c355007f5a 100644 --- a/service/configservice/api_op_GetConformancePackComplianceDetails.go +++ b/service/configservice/api_op_GetConformancePackComplianceDetails.go @@ -141,8 +141,8 @@ type GetConformancePackComplianceDetailsAPIClient interface { var _ GetConformancePackComplianceDetailsAPIClient = (*Client)(nil) -// GetConformancePackComplianceDetailsPaginatorOptions is the paginator options for -// GetConformancePackComplianceDetails +// GetConformancePackComplianceDetailsPaginatorOptions is the paginator options +// for GetConformancePackComplianceDetails type GetConformancePackComplianceDetailsPaginatorOptions struct { // The maximum number of evaluation results returned on each page. If you do no // specify a number, Config uses the default. The default is 100. diff --git a/service/configservice/api_op_GetConformancePackComplianceSummary.go b/service/configservice/api_op_GetConformancePackComplianceSummary.go index 05cb7e2e4ca..db64ce58697 100644 --- a/service/configservice/api_op_GetConformancePackComplianceSummary.go +++ b/service/configservice/api_op_GetConformancePackComplianceSummary.go @@ -132,8 +132,8 @@ type GetConformancePackComplianceSummaryAPIClient interface { var _ GetConformancePackComplianceSummaryAPIClient = (*Client)(nil) -// GetConformancePackComplianceSummaryPaginatorOptions is the paginator options for -// GetConformancePackComplianceSummary +// GetConformancePackComplianceSummaryPaginatorOptions is the paginator options +// for GetConformancePackComplianceSummary type GetConformancePackComplianceSummaryPaginatorOptions struct { // The maximum number of conformance packs returned on each page. Limit int32 diff --git a/service/configservice/api_op_GetCustomRulePolicy.go b/service/configservice/api_op_GetCustomRulePolicy.go index 4bedd6755a4..98405f3285c 100644 --- a/service/configservice/api_op_GetCustomRulePolicy.go +++ b/service/configservice/api_op_GetCustomRulePolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the policy definition containing the logic for your Config Custom Policy -// rule. +// Returns the policy definition containing the logic for your Config Custom +// Policy rule. func (c *Client) GetCustomRulePolicy(ctx context.Context, params *GetCustomRulePolicyInput, optFns ...func(*Options)) (*GetCustomRulePolicyOutput, error) { if params == nil { params = &GetCustomRulePolicyInput{} diff --git a/service/configservice/api_op_GetDiscoveredResourceCounts.go b/service/configservice/api_op_GetDiscoveredResourceCounts.go index b4c405b289b..d10bf62a9b7 100644 --- a/service/configservice/api_op_GetDiscoveredResourceCounts.go +++ b/service/configservice/api_op_GetDiscoveredResourceCounts.go @@ -15,40 +15,26 @@ import ( // Returns the resource types, the number of each resource type, and the total // number of resources that Config is recording in this region for your Amazon Web // Services account. Example +// - Config is recording three resource types in the US East (Ohio) Region for +// your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets. +// - You make a call to the GetDiscoveredResourceCounts action and specify that +// you want all resource types. +// - Config returns the following: +// - The resource types (EC2 instances, IAM users, and S3 buckets). +// - The number of each resource type (25, 20, and 15). +// - The total number of all resources (60). // -// * Config is recording three resource types in the US -// East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 -// buckets. -// -// * You make a call to the GetDiscoveredResourceCounts action and -// specify that you want all resource types. -// -// * Config returns the following: -// -// * -// The resource types (EC2 instances, IAM users, and S3 buckets). -// -// * The number of -// each resource type (25, 20, and 15). -// -// * The total number of all resources -// (60). -// -// The response is paginated. By default, Config lists 100 ResourceCount -// objects on each page. You can customize this number with the limit parameter. -// The response includes a nextToken string. To get the next page of results, run -// the request again and specify the string for the nextToken parameter. If you -// make a call to the GetDiscoveredResourceCounts action, you might not immediately +// The response is paginated. By default, Config lists 100 ResourceCount objects +// on each page. You can customize this number with the limit parameter. The +// response includes a nextToken string. To get the next page of results, run the +// request again and specify the string for the nextToken parameter. If you make a +// call to the GetDiscoveredResourceCounts action, you might not immediately // receive resource counts in the following situations: +// - You are a new Config customer. +// - You just enabled resource recording. // -// * You are a new Config -// customer. -// -// * You just enabled resource recording. -// -// It might take a few minutes -// for Config to record and count your resources. Wait a few minutes and then retry -// the GetDiscoveredResourceCounts action. +// It might take a few minutes for Config to record and count your resources. Wait +// a few minutes and then retry the GetDiscoveredResourceCounts action. func (c *Client) GetDiscoveredResourceCounts(ctx context.Context, params *GetDiscoveredResourceCountsInput, optFns ...func(*Options)) (*GetDiscoveredResourceCountsOutput, error) { if params == nil { params = &GetDiscoveredResourceCountsInput{} @@ -76,13 +62,13 @@ type GetDiscoveredResourceCountsInput struct { NextToken *string // The comma-separated list that specifies the resource types that you want Config - // to return (for example, "AWS::EC2::Instance", "AWS::IAM::User"). If a value for - // resourceTypes is not specified, Config returns all resource types that Config is - // recording in the region for your account. If the configuration recorder is - // turned off, Config returns an empty list of ResourceCount objects. If the - // configuration recorder is not recording a specific resource type (for example, - // S3 buckets), that resource type is not returned in the list of ResourceCount - // objects. + // to return (for example, "AWS::EC2::Instance" , "AWS::IAM::User" ). If a value + // for resourceTypes is not specified, Config returns all resource types that + // Config is recording in the region for your account. If the configuration + // recorder is turned off, Config returns an empty list of ResourceCount objects. + // If the configuration recorder is not recording a specific resource type (for + // example, S3 buckets), that resource type is not returned in the list of + // ResourceCount objects. ResourceTypes []string noSmithyDocumentSerde @@ -101,17 +87,12 @@ type GetDiscoveredResourceCountsOutput struct { // The total number of resources that Config is recording in the region for your // account. If you specify resource types in the request, Config returns only the // total number of resources for those resource types. Example - // - // * Config is - // recording three resource types in the US East (Ohio) Region for your account: 25 - // EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources. - // - // * - // You make a call to the GetDiscoveredResourceCounts action and specify the - // resource type, "AWS::EC2::Instances", in the request. - // - // * Config returns 25 for - // totalDiscoveredResources. + // - Config is recording three resource types in the US East (Ohio) Region for + // your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of + // 60 resources. + // - You make a call to the GetDiscoveredResourceCounts action and specify the + // resource type, "AWS::EC2::Instances" , in the request. + // - Config returns 25 for totalDiscoveredResources . TotalDiscoveredResources int64 // Metadata pertaining to the operation's result. diff --git a/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go b/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go index 74e0d17f922..686f2f764d9 100644 --- a/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go +++ b/service/configservice/api_op_GetOrganizationConfigRuleDetailedStatus.go @@ -130,16 +130,16 @@ func (c *Client) addOperationGetOrganizationConfigRuleDetailedStatusMiddlewares( return nil } -// GetOrganizationConfigRuleDetailedStatusAPIClient is a client that implements the -// GetOrganizationConfigRuleDetailedStatus operation. +// GetOrganizationConfigRuleDetailedStatusAPIClient is a client that implements +// the GetOrganizationConfigRuleDetailedStatus operation. type GetOrganizationConfigRuleDetailedStatusAPIClient interface { GetOrganizationConfigRuleDetailedStatus(context.Context, *GetOrganizationConfigRuleDetailedStatusInput, ...func(*Options)) (*GetOrganizationConfigRuleDetailedStatusOutput, error) } var _ GetOrganizationConfigRuleDetailedStatusAPIClient = (*Client)(nil) -// GetOrganizationConfigRuleDetailedStatusPaginatorOptions is the paginator options -// for GetOrganizationConfigRuleDetailedStatus +// GetOrganizationConfigRuleDetailedStatusPaginatorOptions is the paginator +// options for GetOrganizationConfigRuleDetailedStatus type GetOrganizationConfigRuleDetailedStatusPaginatorOptions struct { // The maximum number of OrganizationConfigRuleDetailedStatus returned on each // page. If you do not specify a number, Config uses the default. The default is diff --git a/service/configservice/api_op_GetResourceConfigHistory.go b/service/configservice/api_op_GetResourceConfigHistory.go index f9bd738a9b9..06e4f64c148 100644 --- a/service/configservice/api_op_GetResourceConfigHistory.go +++ b/service/configservice/api_op_GetResourceConfigHistory.go @@ -23,8 +23,8 @@ import ( // includes a nextToken string. To get the next page of results, run the request // again and specify the string for the nextToken parameter. Each call to the API // is limited to span a duration of seven days. It is likely that the number of -// records returned is smaller than the specified limit. In such cases, you can -// make another call, using the nextToken. +// records returned is smaller than the specified limit . In such cases, you can +// make another call, using the nextToken . func (c *Client) GetResourceConfigHistory(ctx context.Context, params *GetResourceConfigHistoryInput, optFns ...func(*Options)) (*GetResourceConfigHistoryOutput, error) { if params == nil { params = &GetResourceConfigHistoryInput{} @@ -43,7 +43,7 @@ func (c *Client) GetResourceConfigHistory(ctx context.Context, params *GetResour // The input for the GetResourceConfigHistory action. type GetResourceConfigHistoryInput struct { - // The ID of the resource (for example., sg-xxxxxx). + // The ID of the resource (for example., sg-xxxxxx ). // // This member is required. ResourceId *string diff --git a/service/configservice/api_op_GetResourceEvaluationSummary.go b/service/configservice/api_op_GetResourceEvaluationSummary.go index c457fb1971e..0c469de9e34 100644 --- a/service/configservice/api_op_GetResourceEvaluationSummary.go +++ b/service/configservice/api_op_GetResourceEvaluationSummary.go @@ -18,10 +18,8 @@ import ( // the evaluation mode that was run, and whether the resource details comply with // the configuration of the proactive rules. To see additional information about // the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, -// use the GetComplianceDetailsByResource -// (https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html) -// API. For more information, see the Examples -// (https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples) +// use the GetComplianceDetailsByResource (https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html) +// API. For more information, see the Examples (https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples) // section. func (c *Client) GetResourceEvaluationSummary(ctx context.Context, params *GetResourceEvaluationSummaryInput, optFns ...func(*Options)) (*GetResourceEvaluationSummaryOutput, error) { if params == nil { @@ -57,8 +55,8 @@ type GetResourceEvaluationSummaryOutput struct { // Returns an EvaluationContext object. EvaluationContext *types.EvaluationContext - // Lists results of the mode that you requested to retrieve the resource evaluation - // summary. The valid values are Detective or Proactive. + // Lists results of the mode that you requested to retrieve the resource + // evaluation summary. The valid values are Detective or Proactive. EvaluationMode types.EvaluationMode // The start timestamp when Config rule starts evaluating compliance for the diff --git a/service/configservice/api_op_ListConformancePackComplianceScores.go b/service/configservice/api_op_ListConformancePackComplianceScores.go index 409c9c9b80a..5539beaf0c4 100644 --- a/service/configservice/api_op_ListConformancePackComplianceScores.go +++ b/service/configservice/api_op_ListConformancePackComplianceScores.go @@ -19,7 +19,7 @@ import ( // view of the compliance state of your conformance packs. You can use it to // identify, investigate, and understand the level of compliance in your // conformance packs. Conformance packs with no evaluation results will have a -// compliance score of INSUFFICIENT_DATA. +// compliance score of INSUFFICIENT_DATA . func (c *Client) ListConformancePackComplianceScores(ctx context.Context, params *ListConformancePackComplianceScoresInput, optFns ...func(*Options)) (*ListConformancePackComplianceScoresOutput, error) { if params == nil { params = &ListConformancePackComplianceScoresInput{} @@ -37,7 +37,7 @@ func (c *Client) ListConformancePackComplianceScores(ctx context.Context, params type ListConformancePackComplianceScoresInput struct { - // Filters the results based on the ConformancePackComplianceScoresFilters. + // Filters the results based on the ConformancePackComplianceScoresFilters . Filters *types.ConformancePackComplianceScoresFilters // The maximum number of conformance pack compliance scores returned on each page. @@ -48,8 +48,8 @@ type ListConformancePackComplianceScoresInput struct { NextToken *string // Sorts your conformance pack compliance scores in either ascending or descending - // order, depending on SortOrder. By default, conformance pack compliance scores - // are sorted in alphabetical order by name of the conformance pack. Enter SCORE, + // order, depending on SortOrder . By default, conformance pack compliance scores + // are sorted in alphabetical order by name of the conformance pack. Enter SCORE , // to sort conformance pack compliance scores by the numerical value of the // compliance score. SortBy types.SortBy @@ -58,9 +58,9 @@ type ListConformancePackComplianceScoresInput struct { // Either in ascending or descending order. By default, conformance pack compliance // scores are sorted in alphabetical order by name of the conformance pack. // Conformance pack compliance scores are sorted in reverse alphabetical order if - // you enter DESCENDING. You can sort conformance pack compliance scores by the + // you enter DESCENDING . You can sort conformance pack compliance scores by the // numerical value of the compliance score by entering SCORE in the SortBy action. - // When compliance scores are sorted by SCORE, conformance packs with a compliance + // When compliance scores are sorted by SCORE , conformance packs with a compliance // score of INSUFFICIENT_DATA will be last when sorting by ascending order and // first when sorting by descending order. SortOrder types.SortOrder @@ -156,8 +156,8 @@ type ListConformancePackComplianceScoresAPIClient interface { var _ ListConformancePackComplianceScoresAPIClient = (*Client)(nil) -// ListConformancePackComplianceScoresPaginatorOptions is the paginator options for -// ListConformancePackComplianceScores +// ListConformancePackComplianceScoresPaginatorOptions is the paginator options +// for ListConformancePackComplianceScores type ListConformancePackComplianceScoresPaginatorOptions struct { // The maximum number of conformance pack compliance scores returned on each page. Limit int32 diff --git a/service/configservice/api_op_ListDiscoveredResources.go b/service/configservice/api_op_ListDiscoveredResources.go index e58d4caa7eb..6571b691a42 100644 --- a/service/configservice/api_op_ListDiscoveredResources.go +++ b/service/configservice/api_op_ListDiscoveredResources.go @@ -49,19 +49,19 @@ type ListDiscoveredResourcesInput struct { // deleted resources are not included. IncludeDeletedResources bool - // The maximum number of resource identifiers returned on each page. The default is - // 100. You cannot specify a number greater than 100. If you specify 0, Config uses - // the default. + // The maximum number of resource identifiers returned on each page. The default + // is 100. You cannot specify a number greater than 100. If you specify 0, Config + // uses the default. Limit int32 // The nextToken string returned on a previous page that you use to get the next // page of results in a paginated response. NextToken *string - // The IDs of only those resources that you want Config to list in the response. If - // you do not specify this parameter, Config lists all resources of the specified - // type that it has discovered. You can list a minimum of 1 resourceID and a - // maximum of 20 resourceIds. + // The IDs of only those resources that you want Config to list in the response. + // If you do not specify this parameter, Config lists all resources of the + // specified type that it has discovered. You can list a minimum of 1 resourceID + // and a maximum of 20 resourceIds. ResourceIds []string // The custom name of only those resources that you want Config to list in the @@ -78,8 +78,8 @@ type ListDiscoveredResourcesOutput struct { // in a paginated response. NextToken *string - // The details that identify a resource that is discovered by Config, including the - // resource type, ID, and (if available) the custom resource name. + // The details that identify a resource that is discovered by Config, including + // the resource type, ID, and (if available) the custom resource name. ResourceIdentifiers []types.ResourceIdentifier // Metadata pertaining to the operation's result. @@ -162,9 +162,9 @@ var _ ListDiscoveredResourcesAPIClient = (*Client)(nil) // ListDiscoveredResourcesPaginatorOptions is the paginator options for // ListDiscoveredResources type ListDiscoveredResourcesPaginatorOptions struct { - // The maximum number of resource identifiers returned on each page. The default is - // 100. You cannot specify a number greater than 100. If you specify 0, Config uses - // the default. + // The maximum number of resource identifiers returned on each page. The default + // is 100. You cannot specify a number greater than 100. If you specify 0, Config + // uses the default. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_ListStoredQueries.go b/service/configservice/api_op_ListStoredQueries.go index bd4cdbda1cc..47f4d0761d0 100644 --- a/service/configservice/api_op_ListStoredQueries.go +++ b/service/configservice/api_op_ListStoredQueries.go @@ -47,7 +47,7 @@ type ListStoredQueriesOutput struct { // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call this action again and assign that token to the // request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // previous response object's NextToken parameter is set to null . NextToken *string // A list of StoredQueryMetadata objects. diff --git a/service/configservice/api_op_ListTagsForResource.go b/service/configservice/api_op_ListTagsForResource.go index 702d9a93bdd..9a72b7d45de 100644 --- a/service/configservice/api_op_ListTagsForResource.go +++ b/service/configservice/api_op_ListTagsForResource.go @@ -31,8 +31,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource for which to list - // the tags. Currently, the supported resources are ConfigRule, - // ConfigurationAggregator and AggregatorAuthorization. + // the tags. Currently, the supported resources are ConfigRule , + // ConfigurationAggregator and AggregatorAuthorization . // // This member is required. ResourceArn *string @@ -127,8 +127,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/configservice/api_op_PutAggregationAuthorization.go b/service/configservice/api_op_PutAggregationAuthorization.go index 33dd326b96f..b5ef21dbd24 100644 --- a/service/configservice/api_op_PutAggregationAuthorization.go +++ b/service/configservice/api_op_PutAggregationAuthorization.go @@ -12,11 +12,11 @@ import ( ) // Authorizes the aggregator account and region to collect data from the source -// account and region. PutAggregationAuthorization is an idempotent API. Subsequent -// requests won’t create a duplicate resource if one was already created. If a -// following request has different tags values, Config will ignore these -// differences and treat it as an idempotent request of the previous. In this case, -// tags will not be updated, even if they are different. +// account and region. PutAggregationAuthorization is an idempotent API. +// Subsequent requests won’t create a duplicate resource if one was already +// created. If a following request has different tags values, Config will ignore +// these differences and treat it as an idempotent request of the previous. In this +// case, tags will not be updated, even if they are different. func (c *Client) PutAggregationAuthorization(ctx context.Context, params *PutAggregationAuthorizationInput, optFns ...func(*Options)) (*PutAggregationAuthorizationOutput, error) { if params == nil { params = &PutAggregationAuthorizationInput{} diff --git a/service/configservice/api_op_PutConfigRule.go b/service/configservice/api_op_PutConfigRule.go index ad15a656c92..99c3947f790 100644 --- a/service/configservice/api_op_PutConfigRule.go +++ b/service/configservice/api_op_PutConfigRule.go @@ -11,38 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or updates an Config rule to evaluate if your Amazon Web Services resources -// comply with your desired configurations. For information on how many Config -// rules you can have per account, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. There are two types of rules: Config Managed Rules -// and Config Custom Rules. You can use PutConfigRule to create both Config Managed -// Rules and Config Custom Rules. Config Managed Rules are predefined, customizable -// rules created by Config. For a list of managed rules, see List of Config Managed -// Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). -// If you are adding an Config managed rule, you must specify the rule's identifier -// for the SourceIdentifier key. Config Custom Rules are rules that you create from -// scratch. There are two ways to create Config custom rules: with Lambda functions -// ( Lambda Developer Guide -// (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) -// and with Guard (Guard GitHub Repository -// (https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code -// language. Config custom rules created with Lambda are called Config Custom -// Lambda Rules and Config custom rules created with Guard are called Config Custom -// Policy Rules. If you are adding a new Config Custom Lambda rule, you first need -// to create an Lambda function that the rule invokes to evaluate your resources. -// When you use PutConfigRule to add a Custom Lambda rule to Config, you must -// specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You -// specify the ARN in the SourceIdentifier key. This key is part of the Source -// object, which is part of the ConfigRule object. For any new Config rule that you -// add, specify the ConfigRuleName in the ConfigRule object. Do not specify the -// ConfigRuleArn or the ConfigRuleId. These values are generated by Config for new -// rules. If you are updating a rule that you added previously, you can specify the -// rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data -// type that you use in this request. For more information about developing and -// using Config rules, see Evaluating Resources with Config Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) +// Adds or updates an Config rule to evaluate if your Amazon Web Services +// resources comply with your desired configurations. For information on how many +// Config rules you can have per account, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. There are two types of rules: Config Managed +// Rules and Config Custom Rules. You can use PutConfigRule to create both Config +// Managed Rules and Config Custom Rules. Config Managed Rules are predefined, +// customizable rules created by Config. For a list of managed rules, see List of +// Config Managed Rules (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) +// . If you are adding an Config managed rule, you must specify the rule's +// identifier for the SourceIdentifier key. Config Custom Rules are rules that you +// create from scratch. There are two ways to create Config custom rules: with +// Lambda functions ( Lambda Developer Guide (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function) +// ) and with Guard ( Guard GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) +// ), a policy-as-code language. Config custom rules created with Lambda are called +// Config Custom Lambda Rules and Config custom rules created with Guard are called +// Config Custom Policy Rules. If you are adding a new Config Custom Lambda rule, +// you first need to create an Lambda function that the rule invokes to evaluate +// your resources. When you use PutConfigRule to add a Custom Lambda rule to +// Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to +// the function. You specify the ARN in the SourceIdentifier key. This key is part +// of the Source object, which is part of the ConfigRule object. For any new +// Config rule that you add, specify the ConfigRuleName in the ConfigRule object. +// Do not specify the ConfigRuleArn or the ConfigRuleId . These values are +// generated by Config for new rules. If you are updating a rule that you added +// previously, you can specify the rule by ConfigRuleName , ConfigRuleId , or +// ConfigRuleArn in the ConfigRule data type that you use in this request. For +// more information about developing and using Config rules, see Evaluating +// Resources with Config Rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) // in the Config Developer Guide. PutConfigRule is an idempotent API. Subsequent // requests won’t create a duplicate resource if one was already created. If a // following request has different tags values, Config will ignore these diff --git a/service/configservice/api_op_PutConfigurationAggregator.go b/service/configservice/api_op_PutConfigurationAggregator.go index 7fa67a9d547..1ee30170284 100644 --- a/service/configservice/api_op_PutConfigurationAggregator.go +++ b/service/configservice/api_op_PutConfigurationAggregator.go @@ -20,12 +20,11 @@ import ( // aggregate. If your source type is an organization, you must be signed in to the // management account or a registered delegated administrator and all the features // must be enabled in your organization. If the caller is a management account, -// Config calls EnableAwsServiceAccess API to enable integration between Config and -// Organizations. If the caller is a registered delegated administrator, Config +// Config calls EnableAwsServiceAccess API to enable integration between Config +// and Organizations. If the caller is a registered delegated administrator, Config // calls ListDelegatedAdministrators API to verify whether the caller is a valid // delegated administrator. To register a delegated administrator, see Register a -// Delegated Administrator -// (https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli) +// Delegated Administrator (https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli) // in the Config developer guide. PutConfigurationAggregator is an idempotent API. // Subsequent requests won’t create a duplicate resource if one was already // created. If a following request has different tags values, Config will ignore diff --git a/service/configservice/api_op_PutConfigurationRecorder.go b/service/configservice/api_op_PutConfigurationRecorder.go index 09c21f36908..e979f2df299 100644 --- a/service/configservice/api_op_PutConfigurationRecorder.go +++ b/service/configservice/api_op_PutConfigurationRecorder.go @@ -36,8 +36,8 @@ func (c *Client) PutConfigurationRecorder(ctx context.Context, params *PutConfig // The input for the PutConfigurationRecorder action. type PutConfigurationRecorderInput struct { - // The configuration recorder object that records each configuration change made to - // the resources. + // The configuration recorder object that records each configuration change made + // to the resources. // // This member is required. ConfigurationRecorder *types.ConfigurationRecorder diff --git a/service/configservice/api_op_PutConformancePack.go b/service/configservice/api_op_PutConformancePack.go index 0c556f38c23..a1d55083cdb 100644 --- a/service/configservice/api_op_PutConformancePack.go +++ b/service/configservice/api_op_PutConformancePack.go @@ -14,13 +14,12 @@ import ( // Creates or updates a conformance pack. A conformance pack is a collection of // Config rules that can be easily deployed in an account and a region and across // an organization. For information on how many conformance packs you can have per -// account, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. This API creates a service-linked role +// account, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. This API creates a service-linked role // AWSServiceRoleForConfigConforms in your account. The service-linked role is // created only when the role does not exist in your account. You must specify only -// one of the follow parameters: TemplateS3Uri, TemplateBody or -// TemplateSSMDocumentDetails. +// one of the follow parameters: TemplateS3Uri , TemplateBody or +// TemplateSSMDocumentDetails . func (c *Client) PutConformancePack(ctx context.Context, params *PutConformancePackInput, optFns ...func(*Options)) (*PutConformancePackOutput, error) { if params == nil { params = &PutConformancePackInput{} @@ -46,8 +45,8 @@ type PutConformancePackInput struct { // A list of ConformancePackInputParameter objects. ConformancePackInputParameters []types.ConformancePackInputParameter - // The name of the Amazon S3 bucket where Config stores conformance pack templates. - // This field is optional. + // The name of the Amazon S3 bucket where Config stores conformance pack + // templates. This field is optional. DeliveryS3Bucket *string // The prefix for the Amazon S3 bucket. This field is optional. @@ -56,17 +55,17 @@ type PutConformancePackInput struct { // A string containing the full conformance pack template body. The structure // containing the template body has a minimum length of 1 byte and a maximum length // of 51,200 bytes. You can use a YAML template with two resource types: Config - // rule (AWS::Config::ConfigRule) and remediation action - // (AWS::Config::RemediationConfiguration). + // rule ( AWS::Config::ConfigRule ) and remediation action ( + // AWS::Config::RemediationConfiguration ). TemplateBody *string - // The location of the file containing the template body (s3://bucketname/prefix). - // The uri must point to a conformance pack template (max size: 300 KB) that is + // The location of the file containing the template body ( s3://bucketname/prefix + // ). The uri must point to a conformance pack template (max size: 300 KB) that is // located in an Amazon S3 bucket in the same Region as the conformance pack. You // must have access to read Amazon S3 bucket. TemplateS3Uri *string - // An object of type TemplateSSMDocumentDetails, which contains the name or the + // An object of type TemplateSSMDocumentDetails , which contains the name or the // Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document // (SSM document) and the version of the SSM document that is used to create a // conformance pack. diff --git a/service/configservice/api_op_PutEvaluations.go b/service/configservice/api_op_PutEvaluations.go index fea49d85f64..473f105c5a1 100644 --- a/service/configservice/api_op_PutEvaluations.go +++ b/service/configservice/api_op_PutEvaluations.go @@ -30,21 +30,21 @@ func (c *Client) PutEvaluations(ctx context.Context, params *PutEvaluationsInput type PutEvaluationsInput struct { - // An encrypted token that associates an evaluation with an Config rule. Identifies - // the rule and the event that triggered the evaluation. + // An encrypted token that associates an evaluation with an Config rule. + // Identifies the rule and the event that triggered the evaluation. // // This member is required. ResultToken *string - // The assessments that the Lambda function performs. Each evaluation identifies an - // Amazon Web Services resource and indicates whether it complies with the Config - // rule that invokes the Lambda function. + // The assessments that the Lambda function performs. Each evaluation identifies + // an Amazon Web Services resource and indicates whether it complies with the + // Config rule that invokes the Lambda function. Evaluations []types.Evaluation - // Use this parameter to specify a test run for PutEvaluations. You can verify + // Use this parameter to specify a test run for PutEvaluations . You can verify // whether your Lambda function will deliver evaluation results to Config. No // updates occur to your existing evaluations, and evaluation results are not sent - // to Config. When TestMode is true, PutEvaluations doesn't require a valid value + // to Config. When TestMode is true , PutEvaluations doesn't require a valid value // for the ResultToken parameter, but the value cannot be null. TestMode bool diff --git a/service/configservice/api_op_PutOrganizationConfigRule.go b/service/configservice/api_op_PutOrganizationConfigRule.go index b93a29f8473..7e8e60d9b01 100644 --- a/service/configservice/api_op_PutOrganizationConfigRule.go +++ b/service/configservice/api_op_PutOrganizationConfigRule.go @@ -14,9 +14,8 @@ import ( // Adds or updates an Config rule for your entire organization to evaluate if your // Amazon Web Services resources comply with your desired configurations. For // information on how many organization Config rules you can have per account, see -// Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. Only a management account and a delegated +// Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. Only a management account and a delegated // administrator can create or update an organization Config rule. When calling // this API with a delegated administrator, you must ensure Organizations // ListDelegatedAdministrator permissions are added. An organization can have up to @@ -28,30 +27,27 @@ import ( // existence of role with GetRole action. To use this API with delegated // administrator, register a delegated administrator by calling Amazon Web Services // Organization register-delegated-administrator for -// config-multiaccountsetup.amazonaws.com. There are two types of rules: Config +// config-multiaccountsetup.amazonaws.com . There are two types of rules: Config // Managed Rules and Config Custom Rules. You can use PutOrganizationConfigRule to // create both Config Managed Rules and Config Custom Rules. Config Managed Rules // are predefined, customizable rules created by Config. For a list of managed -// rules, see List of Config Managed Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). -// If you are adding an Config managed rule, you must specify the rule's identifier -// for the RuleIdentifier key. Config Custom Rules are rules that you create from -// scratch. There are two ways to create Config custom rules: with Lambda functions -// ( Lambda Developer Guide -// (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) -// and with Guard (Guard GitHub Repository -// (https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code -// language. Config custom rules created with Lambda are called Config Custom -// Lambda Rules and Config custom rules created with Guard are called Config Custom -// Policy Rules. If you are adding a new Config Custom Lambda rule, you first need -// to create an Lambda function in the management account or a delegated -// administrator that the rule invokes to evaluate your resources. You also need to -// create an IAM role in the managed account that can be assumed by the Lambda -// function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to -// Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to -// the function. Prerequisite: Ensure you call EnableAllFeatures API to enable all -// features in an organization. Make sure to specify one of either -// OrganizationCustomPolicyRuleMetadata for Custom Policy rules, +// rules, see List of Config Managed Rules (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) +// . If you are adding an Config managed rule, you must specify the rule's +// identifier for the RuleIdentifier key. Config Custom Rules are rules that you +// create from scratch. There are two ways to create Config custom rules: with +// Lambda functions ( Lambda Developer Guide (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function) +// ) and with Guard ( Guard GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) +// ), a policy-as-code language. Config custom rules created with Lambda are called +// Config Custom Lambda Rules and Config custom rules created with Guard are called +// Config Custom Policy Rules. If you are adding a new Config Custom Lambda rule, +// you first need to create an Lambda function in the management account or a +// delegated administrator that the rule invokes to evaluate your resources. You +// also need to create an IAM role in the managed account that can be assumed by +// the Lambda function. When you use PutOrganizationConfigRule to add a Custom +// Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that +// Lambda assigns to the function. Prerequisite: Ensure you call EnableAllFeatures +// API to enable all features in an organization. Make sure to specify one of +// either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, // OrganizationCustomRuleMetadata for Custom Lambda rules, or // OrganizationManagedRuleMetadata for managed rules. func (c *Client) PutOrganizationConfigRule(ctx context.Context, params *PutOrganizationConfigRuleInput, optFns ...func(*Options)) (*PutOrganizationConfigRuleOutput, error) { @@ -76,8 +72,8 @@ type PutOrganizationConfigRuleInput struct { // This member is required. OrganizationConfigRuleName *string - // A comma-separated list of accounts that you want to exclude from an organization - // Config rule. + // A comma-separated list of accounts that you want to exclude from an + // organization Config rule. ExcludedAccounts []string // An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata diff --git a/service/configservice/api_op_PutOrganizationConformancePack.go b/service/configservice/api_op_PutOrganizationConformancePack.go index 8f7bd2d5ea1..7115aab3db4 100644 --- a/service/configservice/api_op_PutOrganizationConformancePack.go +++ b/service/configservice/api_op_PutOrganizationConformancePack.go @@ -13,27 +13,26 @@ import ( // Deploys conformance packs across member accounts in an Amazon Web Services // Organization. For information on how many organization conformance packs and how -// many Config rules you can have per account, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. Only a management account and a delegated +// many Config rules you can have per account, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. Only a management account and a delegated // administrator can call this API. When calling this API with a delegated // administrator, you must ensure Organizations ListDelegatedAdministrator // permissions are added. An organization can have up to 3 delegated // administrators. This API enables organization service access for -// config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action -// and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in -// the management or delegated administrator account of your organization. The -// service-linked role is created only when the role does not exist in the caller -// account. To use this API with delegated administrator, register a delegated -// administrator by calling Amazon Web Services Organization -// register-delegate-admin for config-multiaccountsetup.amazonaws.com. -// Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an -// organization. You must specify either the TemplateS3Uri or the TemplateBody -// parameter, but not both. If you provide both Config uses the TemplateS3Uri -// parameter and ignores the TemplateBody parameter. Config sets the state of a -// conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the -// conformance pack is created or updated. You cannot update a conformance pack -// while it is in this state. +// config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess +// action and creates a service-linked role +// AWSServiceRoleForConfigMultiAccountSetup in the management or delegated +// administrator account of your organization. The service-linked role is created +// only when the role does not exist in the caller account. To use this API with +// delegated administrator, register a delegated administrator by calling Amazon +// Web Services Organization register-delegate-admin for +// config-multiaccountsetup.amazonaws.com . Prerequisite: Ensure you call +// EnableAllFeatures API to enable all features in an organization. You must +// specify either the TemplateS3Uri or the TemplateBody parameter, but not both. +// If you provide both Config uses the TemplateS3Uri parameter and ignores the +// TemplateBody parameter. Config sets the state of a conformance pack to +// CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created +// or updated. You cannot update a conformance pack while it is in this state. func (c *Client) PutOrganizationConformancePack(ctx context.Context, params *PutOrganizationConformancePackInput, optFns ...func(*Options)) (*PutOrganizationConformancePackOutput, error) { if params == nil { params = &PutOrganizationConformancePackInput{} @@ -59,8 +58,9 @@ type PutOrganizationConformancePackInput struct { // A list of ConformancePackInputParameter objects. ConformancePackInputParameters []types.ConformancePackInputParameter - // The name of the Amazon S3 bucket where Config stores conformance pack templates. - // This field is optional. If used, it must be prefixed with awsconfigconforms. + // The name of the Amazon S3 bucket where Config stores conformance pack + // templates. This field is optional. If used, it must be prefixed with + // awsconfigconforms . DeliveryS3Bucket *string // The prefix for the Amazon S3 bucket. This field is optional. diff --git a/service/configservice/api_op_PutRemediationConfigurations.go b/service/configservice/api_op_PutRemediationConfigurations.go index d486bcb5aef..78f949949eb 100644 --- a/service/configservice/api_op_PutRemediationConfigurations.go +++ b/service/configservice/api_op_PutRemediationConfigurations.go @@ -21,7 +21,7 @@ import ( // Rules such as Organization Config rules, the rules deployed by conformance // packs, and rules deployed by Amazon Web Services Security Hub. For manual // remediation configuration, you need to provide a value for automationAssumeRole -// or use a value in the assumeRolefield to remediate your resources. The SSM +// or use a value in the assumeRole field to remediate your resources. The SSM // automation document can use either as long as it maps to a valid parameter. // However, for automatic remediation configuration, the only valid assumeRole // field value is AutomationAssumeRole and you need to provide a value for diff --git a/service/configservice/api_op_PutRemediationExceptions.go b/service/configservice/api_op_PutRemediationExceptions.go index 2ce08e65992..27314fbe0f1 100644 --- a/service/configservice/api_op_PutRemediationExceptions.go +++ b/service/configservice/api_op_PutRemediationExceptions.go @@ -12,24 +12,23 @@ import ( "time" ) -// A remediation exception is when a specified resource is no longer considered for -// auto-remediation. This API adds a new exception or updates an existing exception -// for a specified resource with a specified Config rule. Config generates a -// remediation exception when a problem occurs running a remediation action for a -// specified resource. Remediation exceptions blocks auto-remediation until the -// exception is cleared. When placing an exception on an Amazon Web Services -// resource, it is recommended that remediation is set as manual remediation until -// the given Config rule for the specified resource evaluates the resource as -// NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can -// add remediation exceptions and change the remediation type back from Manual to -// Auto if you want to use auto-remediation. Otherwise, using auto-remediation -// before a NON_COMPLIANT evaluation result can delete resources before the -// exception is applied. Placing an exception can only be performed on resources -// that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources -// that are NOT_APPLICABLE, a remediation exception will not be generated. For more -// information on the conditions that initiate the possible Config evaluation -// results, see Concepts | Config Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules) +// A remediation exception is when a specified resource is no longer considered +// for auto-remediation. This API adds a new exception or updates an existing +// exception for a specified resource with a specified Config rule. Config +// generates a remediation exception when a problem occurs running a remediation +// action for a specified resource. Remediation exceptions blocks auto-remediation +// until the exception is cleared. When placing an exception on an Amazon Web +// Services resource, it is recommended that remediation is set as manual +// remediation until the given Config rule for the specified resource evaluates the +// resource as NON_COMPLIANT . Once the resource has been evaluated as +// NON_COMPLIANT , you can add remediation exceptions and change the remediation +// type back from Manual to Auto if you want to use auto-remediation. Otherwise, +// using auto-remediation before a NON_COMPLIANT evaluation result can delete +// resources before the exception is applied. Placing an exception can only be +// performed on resources that are NON_COMPLIANT . If you use this API for +// COMPLIANT resources or resources that are NOT_APPLICABLE , a remediation +// exception will not be generated. For more information on the conditions that +// initiate the possible Config evaluation results, see Concepts | Config Rules (https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules) // in the Config Developer Guide. func (c *Client) PutRemediationExceptions(ctx context.Context, params *PutRemediationExceptionsInput, optFns ...func(*Options)) (*PutRemediationExceptionsOutput, error) { if params == nil { diff --git a/service/configservice/api_op_PutResourceConfig.go b/service/configservice/api_op_PutResourceConfig.go index 178bfa26e6c..44f7eef6842 100644 --- a/service/configservice/api_op_PutResourceConfig.go +++ b/service/configservice/api_op_PutResourceConfig.go @@ -37,9 +37,9 @@ func (c *Client) PutResourceConfig(ctx context.Context, params *PutResourceConfi type PutResourceConfigInput struct { - // The configuration object of the resource in valid JSON format. It must match the - // schema registered with CloudFormation. The configuration JSON must not exceed 64 - // KB. + // The configuration object of the resource in valid JSON format. It must match + // the schema registered with CloudFormation. The configuration JSON must not + // exceed 64 KB. // // This member is required. Configuration *string diff --git a/service/configservice/api_op_PutRetentionConfiguration.go b/service/configservice/api_op_PutRetentionConfiguration.go index 022b1a7fc53..992995132d6 100644 --- a/service/configservice/api_op_PutRetentionConfiguration.go +++ b/service/configservice/api_op_PutRetentionConfiguration.go @@ -14,9 +14,9 @@ import ( // Creates and updates the retention configuration with details about retention // period (number of days) that Config stores your historical information. The API // creates the RetentionConfiguration object and names the object as default. When -// you have a RetentionConfiguration object named default, calling the API modifies -// the default object. Currently, Config supports only one retention configuration -// per region in your account. +// you have a RetentionConfiguration object named default, calling the API +// modifies the default object. Currently, Config supports only one retention +// configuration per region in your account. func (c *Client) PutRetentionConfiguration(ctx context.Context, params *PutRetentionConfigurationInput, optFns ...func(*Options)) (*PutRetentionConfigurationOutput, error) { if params == nil { params = &PutRetentionConfigurationInput{} diff --git a/service/configservice/api_op_PutStoredQuery.go b/service/configservice/api_op_PutStoredQuery.go index 1177e9ddef6..5aa4df49668 100644 --- a/service/configservice/api_op_PutStoredQuery.go +++ b/service/configservice/api_op_PutStoredQuery.go @@ -36,8 +36,8 @@ func (c *Client) PutStoredQuery(ctx context.Context, params *PutStoredQueryInput type PutStoredQueryInput struct { - // A list of StoredQuery objects. The mandatory fields are QueryName and - // Expression. When you are creating a query, you must provide a query name and an + // A list of StoredQuery objects. The mandatory fields are QueryName and Expression + // . When you are creating a query, you must provide a query name and an // expression. When you are updating a query, you must provide a query name but // updating the description is optional. // diff --git a/service/configservice/api_op_SelectAggregateResourceConfig.go b/service/configservice/api_op_SelectAggregateResourceConfig.go index 376b4b8a5b9..194b313caa4 100644 --- a/service/configservice/api_op_SelectAggregateResourceConfig.go +++ b/service/configservice/api_op_SelectAggregateResourceConfig.go @@ -16,15 +16,14 @@ import ( // query configuration state of Amazon Web Services resources across multiple // accounts and regions, performs the corresponding search, and returns resource // configurations matching the properties. For more information about query -// components, see the Query Components -// (https://docs.aws.amazon.com/config/latest/developerguide/query-components.html) +// components, see the Query Components (https://docs.aws.amazon.com/config/latest/developerguide/query-components.html) // section in the Config Developer Guide. If you run an aggregation query (i.e., -// using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT -// resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) +// using GROUP BY or using aggregate functions such as COUNT ; e.g., SELECT +// resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId ) // and do not specify the MaxResults or the Limit query parameters, the default // page size is set to 500. If you run a non-aggregation query (i.e., not using // GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = -// 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query +// 'AWS::IAM::Role' ) and do not specify the MaxResults or the Limit query // parameters, the default page size is set to 25. func (c *Client) SelectAggregateResourceConfig(ctx context.Context, params *SelectAggregateResourceConfigInput, optFns ...func(*Options)) (*SelectAggregateResourceConfigOutput, error) { if params == nil { diff --git a/service/configservice/api_op_SelectResourceConfig.go b/service/configservice/api_op_SelectResourceConfig.go index fc77fde0b15..278b212681b 100644 --- a/service/configservice/api_op_SelectResourceConfig.go +++ b/service/configservice/api_op_SelectResourceConfig.go @@ -14,9 +14,8 @@ import ( // Accepts a structured query language (SQL) SELECT command, performs the // corresponding search, and returns resource configurations matching the -// properties. For more information about query components, see the Query -// Components -// (https://docs.aws.amazon.com/config/latest/developerguide/query-components.html) +// properties. For more information about query components, see the Query +// Components (https://docs.aws.amazon.com/config/latest/developerguide/query-components.html) // section in the Config Developer Guide. func (c *Client) SelectResourceConfig(ctx context.Context, params *SelectResourceConfigInput, optFns ...func(*Options)) (*SelectResourceConfigOutput, error) { if params == nil { diff --git a/service/configservice/api_op_StartConfigRulesEvaluation.go b/service/configservice/api_op_StartConfigRulesEvaluation.go index e2526fef550..43364a09780 100644 --- a/service/configservice/api_op_StartConfigRulesEvaluation.go +++ b/service/configservice/api_op_StartConfigRulesEvaluation.go @@ -22,23 +22,13 @@ import ( // evaluation starts. You don't need to call the StartConfigRulesEvaluation API to // run an evaluation for a new rule. When you create a rule, Config evaluates your // resources against the rule automatically. The StartConfigRulesEvaluation API is -// useful if you want to run on-demand evaluations, such as the following -// example: -// -// * You have a custom rule that evaluates your IAM resources every 24 -// hours. -// -// * You update your Lambda function to add additional conditions to your -// rule. -// -// * Instead of waiting for the next periodic evaluation, you call the -// StartConfigRulesEvaluation API. -// -// * Config invokes your Lambda function and -// evaluates your IAM resources. -// -// * Your custom rule will still run periodic -// evaluations every 24 hours. +// useful if you want to run on-demand evaluations, such as the following example: +// - You have a custom rule that evaluates your IAM resources every 24 hours. +// - You update your Lambda function to add additional conditions to your rule. +// - Instead of waiting for the next periodic evaluation, you call the +// StartConfigRulesEvaluation API. +// - Config invokes your Lambda function and evaluates your IAM resources. +// - Your custom rule will still run periodic evaluations every 24 hours. func (c *Client) StartConfigRulesEvaluation(ctx context.Context, params *StartConfigRulesEvaluationInput, optFns ...func(*Options)) (*StartConfigRulesEvaluationOutput, error) { if params == nil { params = &StartConfigRulesEvaluationInput{} diff --git a/service/configservice/api_op_StartResourceEvaluation.go b/service/configservice/api_op_StartResourceEvaluation.go index 4396679bcd6..4d08d85e6f2 100644 --- a/service/configservice/api_op_StartResourceEvaluation.go +++ b/service/configservice/api_op_StartResourceEvaluation.go @@ -11,21 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs an on-demand evaluation for the specified resource to determine whether the -// resource details will comply with configured Config rules. You can also use it -// for evaluation purposes. Config recommends using an evaluation context. It runs -// an execution against the resource details with all of the Config rules in your -// account that match with the specified proactive mode and resource type. Ensure -// you have the cloudformation:DescribeType role setup to validate the resource -// type schema. You can find the Resource type schema -// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) +// Runs an on-demand evaluation for the specified resource to determine whether +// the resource details will comply with configured Config rules. You can also use +// it for evaluation purposes. Config recommends using an evaluation context. It +// runs an execution against the resource details with all of the Config rules in +// your account that match with the specified proactive mode and resource type. +// Ensure you have the cloudformation:DescribeType role setup to validate the +// resource type schema. You can find the Resource type schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) // in "Amazon Web Services public extensions" within the CloudFormation registry or // with the following CLI commmand: aws cloudformation describe-type --type-name -// "AWS::S3::Bucket" --type RESOURCE. For more information, see Managing extensions -// through the CloudFormation registry -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view) -// and Amazon Web Services resource and property types reference -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) +// "AWS::S3::Bucket" --type RESOURCE . For more information, see Managing +// extensions through the CloudFormation registry (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view) +// and Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. func (c *Client) StartResourceEvaluation(ctx context.Context, params *StartResourceEvaluationInput, optFns ...func(*Options)) (*StartResourceEvaluationOutput, error) { if params == nil { @@ -45,7 +42,7 @@ func (c *Client) StartResourceEvaluation(ctx context.Context, params *StartResou type StartResourceEvaluationInput struct { // The mode of an evaluation. The valid values for this API are DETECTIVE and - // PROACTIVE. + // PROACTIVE . // // This member is required. EvaluationMode types.EvaluationMode diff --git a/service/configservice/api_op_TagResource.go b/service/configservice/api_op_TagResource.go index 0e65bc76d2d..a4429ab9c4b 100644 --- a/service/configservice/api_op_TagResource.go +++ b/service/configservice/api_op_TagResource.go @@ -34,8 +34,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource for which to list - // the tags. Currently, the supported resources are ConfigRule, - // ConfigurationAggregator and AggregatorAuthorization. + // the tags. Currently, the supported resources are ConfigRule , + // ConfigurationAggregator and AggregatorAuthorization . // // This member is required. ResourceArn *string diff --git a/service/configservice/api_op_UntagResource.go b/service/configservice/api_op_UntagResource.go index 1ef8d59773e..3b40c49479b 100644 --- a/service/configservice/api_op_UntagResource.go +++ b/service/configservice/api_op_UntagResource.go @@ -29,8 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource for which to list - // the tags. Currently, the supported resources are ConfigRule, - // ConfigurationAggregator and AggregatorAuthorization. + // the tags. Currently, the supported resources are ConfigRule , + // ConfigurationAggregator and AggregatorAuthorization . // // This member is required. ResourceArn *string diff --git a/service/configservice/doc.go b/service/configservice/doc.go index 9d0a3b3b14f..12818f8e367 100644 --- a/service/configservice/doc.go +++ b/service/configservice/doc.go @@ -10,19 +10,16 @@ // between the resources. An Amazon Web Services resource can be an Amazon Compute // Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic // network Interface (ENI), or a security group. For a complete list of resources -// currently supported by Config, see Supported Amazon Web Services resources -// (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources). -// You can access and manage Config through the Amazon Web Services Management +// currently supported by Config, see Supported Amazon Web Services resources (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) +// . You can access and manage Config through the Amazon Web Services Management // Console, the Amazon Web Services Command Line Interface (Amazon Web Services // CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference // guide contains documentation for the Config API and the Amazon Web Services CLI // commands that you can use to manage Config. The Config API uses the Signature // Version 4 protocol for signing requests. For more information about how to sign -// a request with this protocol, see Signature Version 4 Signing Process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). For -// detailed information about Config features and their associated actions or +// a request with this protocol, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . For detailed information about Config features and their associated actions or // commands, as well as how to work with Amazon Web Services Management Console, -// see What Is Config -// (https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html) in -// the Config Developer Guide. +// see What Is Config (https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html) +// in the Config Developer Guide. package configservice diff --git a/service/configservice/types/enums.go b/service/configservice/types/enums.go index f4b62ead0c9..911a8736f0e 100644 --- a/service/configservice/types/enums.go +++ b/service/configservice/types/enums.go @@ -350,8 +350,8 @@ const ( OrganizationConfigRuleTriggerTypeScheduledNotification OrganizationConfigRuleTriggerType = "ScheduledNotification" ) -// Values returns all known values for OrganizationConfigRuleTriggerType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for OrganizationConfigRuleTriggerType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (OrganizationConfigRuleTriggerType) Values() []OrganizationConfigRuleTriggerType { @@ -487,8 +487,8 @@ const ( OwnerCustomPolicy Owner = "CUSTOM_POLICY" ) -// Values returns all known values for Owner. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Owner. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Owner) Values() []Owner { return []Owner{ @@ -568,8 +568,8 @@ const ( RemediationTargetTypeSsmDocument RemediationTargetType = "SSM_DOCUMENT" ) -// Values returns all known values for RemediationTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RemediationTargetType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RemediationTargetType) Values() []RemediationTargetType { return []RemediationTargetType{ @@ -603,8 +603,8 @@ const ( ResourceCountGroupKeyAwsRegion ResourceCountGroupKey = "AWS_REGION" ) -// Values returns all known values for ResourceCountGroupKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ResourceCountGroupKey. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ResourceCountGroupKey) Values() []ResourceCountGroupKey { return []ResourceCountGroupKey{ @@ -623,9 +623,9 @@ const ( ResourceEvaluationStatusSucceeded ResourceEvaluationStatus = "SUCCEEDED" ) -// Values returns all known values for ResourceEvaluationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceEvaluationStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceEvaluationStatus) Values() []ResourceEvaluationStatus { return []ResourceEvaluationStatus{ "IN_PROGRESS", @@ -914,9 +914,9 @@ const ( ResourceTypeConnectPhoneNumber ResourceType = "AWS::Connect::PhoneNumber" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "AWS::EC2::CustomerGateway", @@ -1236,9 +1236,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/configservice/types/errors.go b/service/configservice/types/errors.go index d435a697bea..63618c5783c 100644 --- a/service/configservice/types/errors.go +++ b/service/configservice/types/errors.go @@ -35,8 +35,8 @@ func (e *ConformancePackTemplateValidationException) ErrorFault() smithy.ErrorFa return smithy.FaultClient } -// Using the same client token with one or more different parameters. Specify a new -// client token with the parameter changes and try again. +// Using the same client token with one or more different parameters. Specify a +// new client token with the parameter changes and try again. type IdempotentParameterMismatch struct { Message *string @@ -91,28 +91,19 @@ func (e *InsufficientDeliveryPolicyException) ErrorFault() smithy.ErrorFault { } // Indicates one of the following errors: -// -// * For PutConfigRule, the rule cannot be -// created because the IAM role assigned to Config lacks permissions to perform the -// config:Put* action. -// -// * For PutConfigRule, the Lambda function cannot be invoked. -// Check the function ARN, and check the function's permissions. -// -// * For -// PutOrganizationConfigRule, organization Config rule cannot be created because -// you do not have permissions to call IAM GetRole action or create a -// service-linked role. -// -// * For PutConformancePack and -// PutOrganizationConformancePack, a conformance pack cannot be created because you -// do not have the following permissions: -// -// * You do not have permission to call IAM -// GetRole action or create a service-linked role. -// -// * You do not have permission to -// read Amazon S3 bucket or call SSM:GetDocument. +// - For PutConfigRule, the rule cannot be created because the IAM role assigned +// to Config lacks permissions to perform the config:Put* action. +// - For PutConfigRule, the Lambda function cannot be invoked. Check the +// function ARN, and check the function's permissions. +// - For PutOrganizationConfigRule, organization Config rule cannot be created +// because you do not have permissions to call IAM GetRole action or create a +// service-linked role. +// - For PutConformancePack and PutOrganizationConformancePack, a conformance +// pack cannot be created because you do not have the following permissions: +// - You do not have permission to call IAM GetRole action or create a +// service-linked role. +// - You do not have permission to read Amazon S3 bucket or call +// SSM:GetDocument. type InsufficientPermissionsException struct { Message *string @@ -514,9 +505,9 @@ func (e *LastDeliveryChannelDeleteFailedException) ErrorFault() smithy.ErrorFaul return smithy.FaultClient } -// For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is -// in progress or if you call the StartConfigRulesEvaluation API more than once per -// minute. For PutConfigurationAggregator API, this exception is thrown if the +// For StartConfigRulesEvaluation API, this exception is thrown if an evaluation +// is in progress or if you call the StartConfigRulesEvaluation API more than once +// per minute. For PutConfigurationAggregator API, this exception is thrown if the // number of accounts and aggregators exceeds the limit. type LimitExceededException struct { Message *string @@ -544,8 +535,8 @@ func (e *LimitExceededException) ErrorCode() string { func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the limit of active custom resource types in your account. -// There is a limit of 100,000. Delete unused resources using DeleteResourceConfig -// (https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteResourceConfig.html). +// There is a limit of 100,000. Delete unused resources using DeleteResourceConfig (https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteResourceConfig.html) +// . type MaxActiveResourcesExceededException struct { Message *string @@ -632,9 +623,8 @@ func (e *MaxNumberOfConfigurationRecordersExceededException) ErrorFault() smithy } // You have reached the limit of the number of conformance packs you can create in -// an account. For more information, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. +// an account. For more information, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. type MaxNumberOfConformancePacksExceededException struct { Message *string @@ -691,9 +681,8 @@ func (e *MaxNumberOfDeliveryChannelsExceededException) ErrorFault() smithy.Error } // You have reached the limit of the number of organization Config rules you can -// create. For more information, see see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. +// create. For more information, see see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. type MaxNumberOfOrganizationConfigRulesExceededException struct { Message *string @@ -722,9 +711,8 @@ func (e *MaxNumberOfOrganizationConfigRulesExceededException) ErrorFault() smith } // You have reached the limit of the number of organization conformance packs you -// can create in an account. For more information, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. +// can create in an account. For more information, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. type MaxNumberOfOrganizationConformancePacksExceededException struct { Message *string @@ -752,8 +740,8 @@ func (e *MaxNumberOfOrganizationConformancePacksExceededException) ErrorFault() return smithy.FaultClient } -// Failed to add the retention configuration because a retention configuration with -// that name already exists. +// Failed to add the retention configuration because a retention configuration +// with that name already exists. type MaxNumberOfRetentionConfigurationsExceededException struct { Message *string @@ -1226,32 +1214,25 @@ func (e *NoSuchRetentionConfigurationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// For PutConfigurationAggregator API, you can see this exception for the following -// reasons: -// -// * No permission to call EnableAWSServiceAccess API -// -// * The -// configuration aggregator cannot be updated because your Amazon Web Services -// Organization management account or the delegated administrator role changed. -// Delete this aggregator and create a new one with the current Amazon Web Services -// Organization. -// -// * The configuration aggregator is associated with a previous -// Amazon Web Services Organization and Config cannot aggregate data with current -// Amazon Web Services Organization. Delete this aggregator and create a new one -// with the current Amazon Web Services Organization. +// For PutConfigurationAggregator API, you can see this exception for the +// following reasons: +// - No permission to call EnableAWSServiceAccess API +// - The configuration aggregator cannot be updated because your Amazon Web +// Services Organization management account or the delegated administrator role +// changed. Delete this aggregator and create a new one with the current Amazon Web +// Services Organization. +// - The configuration aggregator is associated with a previous Amazon Web +// Services Organization and Config cannot aggregate data with current Amazon Web +// Services Organization. Delete this aggregator and create a new one with the +// current Amazon Web Services Organization. +// - You are not a registered delegated administrator for Config with +// permissions to call ListDelegatedAdministrators API. Ensure that the +// management account registers delagated administrator for Config service +// principle name before the delegated administrator creates an aggregator. // -// * You are not a registered -// delegated administrator for Config with permissions to call -// ListDelegatedAdministrators API. Ensure that the management account registers -// delagated administrator for Config service principle name before the delegated -// administrator creates an aggregator. -// -// For all OrganizationConfigRule and -// OrganizationConformancePack APIs, Config throws an exception if APIs are called -// from member accounts. All APIs must be called from organization management -// account. +// For all OrganizationConfigRule and OrganizationConformancePack APIs, Config +// throws an exception if APIs are called from member accounts. All APIs must be +// called from organization management account. type OrganizationAccessDeniedException struct { Message *string @@ -1362,8 +1343,8 @@ func (e *OversizedConfigurationItemException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Remediation action is in progress. You can either cancel execution in Amazon Web -// Services Systems Manager or wait and try again later. +// Remediation action is in progress. You can either cancel execution in Amazon +// Web Services Systems Manager or wait and try again later. type RemediationInProgressException struct { Message *string @@ -1419,32 +1400,22 @@ func (e *ResourceConcurrentModificationException) ErrorFault() smithy.ErrorFault } // You see this exception in the following cases: -// -// * For DeleteConfigRule, Config -// is deleting this rule. Try your request again later. -// -// * For DeleteConfigRule, -// the rule is deleting your evaluation results. Try your request again later. -// -// * -// For DeleteConfigRule, a remediation action is associated with the rule and -// Config cannot delete this rule. Delete the remediation action associated with -// the rule before deleting the rule and try your request again later. -// -// * For -// PutConfigOrganizationRule, organization Config rule deletion is in progress. Try -// your request again later. -// -// * For DeleteOrganizationConfigRule, organization -// Config rule creation is in progress. Try your request again later. -// -// * For -// PutConformancePack and PutOrganizationConformancePack, a conformance pack -// creation, update, and deletion is in progress. Try your request again later. -// -// * -// For DeleteConformancePack, a conformance pack creation, update, and deletion is -// in progress. Try your request again later. +// - For DeleteConfigRule, Config is deleting this rule. Try your request again +// later. +// - For DeleteConfigRule, the rule is deleting your evaluation results. Try +// your request again later. +// - For DeleteConfigRule, a remediation action is associated with the rule and +// Config cannot delete this rule. Delete the remediation action associated with +// the rule before deleting the rule and try your request again later. +// - For PutConfigOrganizationRule, organization Config rule deletion is in +// progress. Try your request again later. +// - For DeleteOrganizationConfigRule, organization Config rule creation is in +// progress. Try your request again later. +// - For PutConformancePack and PutOrganizationConformancePack, a conformance +// pack creation, update, and deletion is in progress. Try your request again +// later. +// - For DeleteConformancePack, a conformance pack creation, update, and +// deletion is in progress. Try your request again later. type ResourceInUseException struct { Message *string @@ -1523,9 +1494,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the limit of the number of tags you can use. For more -// information, see Service Limits -// (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in -// the Config Developer Guide. +// information, see Service Limits (https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) +// in the Config Developer Guide. type TooManyTagsException struct { Message *string diff --git a/service/configservice/types/types.go b/service/configservice/types/types.go index bce8f09fa5b..f311a5d8eb1 100644 --- a/service/configservice/types/types.go +++ b/service/configservice/types/types.go @@ -150,8 +150,8 @@ type AggregateConformancePackComplianceSummary struct { // Returns an AggregateConformancePackComplianceCount object. ComplianceSummary *AggregateConformancePackComplianceCount - // Groups the result based on Amazon Web Services account ID or Amazon Web Services - // Region. + // Groups the result based on Amazon Web Services account ID or Amazon Web + // Services Region. GroupName *string noSmithyDocumentSerde @@ -184,14 +184,9 @@ type AggregatedSourceStatus struct { LastErrorMessage *string // Filters the last updated status type. - // - // * Valid value FAILED indicates errors - // while moving data. - // - // * Valid value SUCCEEDED indicates the data was successfully - // moved. - // - // * Valid value OUTDATED indicates the data is not the most recent. + // - Valid value FAILED indicates errors while moving data. + // - Valid value SUCCEEDED indicates the data was successfully moved. + // - Valid value OUTDATED indicates the data is not the most recent. LastUpdateStatus AggregatedSourceStatusType // The time of the last update. @@ -222,7 +217,7 @@ type AggregateEvaluationResult struct { AwsRegion *string // The resource compliance status. For the AggregationEvaluationResult data type, - // Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support + // Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support // the NOT_APPLICABLE and INSUFFICIENT_DATA value. ComplianceType ComplianceType @@ -310,24 +305,15 @@ type BaseConfigurationItem struct { ConfigurationItemCaptureTime *time.Time // The configuration item status. The valid values are: - // - // * OK – The resource - // configuration has been updated - // - // * ResourceDiscovered – The resource was newly - // discovered - // - // * ResourceNotRecorded – The resource was discovered but its - // configuration was not recorded since the recorder excludes the recording of - // resources of this type - // - // * ResourceDeleted – The resource was deleted - // - // * - // ResourceDeletedNotRecorded – The resource was deleted but its configuration was - // not recorded since the recorder excludes the recording of resources of this - // type - // + // - OK – The resource configuration has been updated + // - ResourceDiscovered – The resource was newly discovered + // - ResourceNotRecorded – The resource was discovered but its configuration was + // not recorded since the recorder excludes the recording of resources of this type + // + // - ResourceDeleted – The resource was deleted + // - ResourceDeletedNotRecorded – The resource was deleted but its configuration + // was not recorded since the recorder excludes the recording of resources of this + // type // The CIs do not incur any cost. ConfigurationItemStatus ConfigurationItemStatus @@ -362,17 +348,17 @@ type BaseConfigurationItem struct { type Compliance struct { // The number of Amazon Web Services resources or Config rules that cause a result - // of NON_COMPLIANT, up to a maximum number. + // of NON_COMPLIANT , up to a maximum number. ComplianceContributorCount *ComplianceContributorCount - // Indicates whether an Amazon Web Services resource or Config rule is compliant. A - // resource is compliant if it complies with all of the Config rules that evaluate - // it. A resource is noncompliant if it does not comply with one or more of these - // rules. A rule is compliant if all of the resources that the rule evaluates - // comply with it. A rule is noncompliant if any of these resources do not comply. - // Config returns the INSUFFICIENT_DATA value when no evaluation results are - // available for the Amazon Web Services resource or Config rule. For the - // Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and + // Indicates whether an Amazon Web Services resource or Config rule is compliant. + // A resource is compliant if it complies with all of the Config rules that + // evaluate it. A resource is noncompliant if it does not comply with one or more + // of these rules. A rule is compliant if all of the resources that the rule + // evaluates comply with it. A rule is noncompliant if any of these resources do + // not comply. Config returns the INSUFFICIENT_DATA value when no evaluation + // results are available for the Amazon Web Services resource or Config rule. For + // the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and // INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for // the Compliance data type. ComplianceType ComplianceType @@ -380,9 +366,9 @@ type Compliance struct { noSmithyDocumentSerde } -// Indicates whether an Config rule is compliant. A rule is compliant if all of the -// resources that the rule evaluated comply with it. A rule is noncompliant if any -// of these resources do not comply. +// Indicates whether an Config rule is compliant. A rule is compliant if all of +// the resources that the rule evaluated comply with it. A rule is noncompliant if +// any of these resources do not comply. type ComplianceByConfigRule struct { // Indicates whether the Config rule is compliant. @@ -394,8 +380,8 @@ type ComplianceByConfigRule struct { noSmithyDocumentSerde } -// Indicates whether an Amazon Web Services resource that is evaluated according to -// one or more Config rules is compliant. A resource is compliant if it complies +// Indicates whether an Amazon Web Services resource that is evaluated according +// to one or more Config rules is compliant. A resource is compliant if it complies // with all of the rules that evaluate it. A resource is noncompliant if it does // not comply with one or more of these rules. type ComplianceByResource struct { @@ -490,25 +476,21 @@ type ConfigExportDeliveryInfo struct { // Amazon Web Services resource or at a periodic frequency that you choose (for // example, every 24 hours). There are two types of rules: Config Managed Rules and // Config Custom Rules. Config Managed Rules are predefined, customizable rules -// created by Config. For a list of managed rules, see List of Config Managed Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). -// Config Custom Rules are rules that you create from scratch. There are two ways -// to create Config custom rules: with Lambda functions ( Lambda Developer Guide -// (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) -// and with Guard (Guard GitHub Repository -// (https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code -// language. Config custom rules created with Lambda are called Config Custom -// Lambda Rules and Config custom rules created with Guard are called Config Custom -// Policy Rules. For more information about developing and using Config rules, see -// Evaluating Resource with Config Rules -// (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) +// created by Config. For a list of managed rules, see List of Config Managed Rules (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) +// . Config Custom Rules are rules that you create from scratch. There are two ways +// to create Config custom rules: with Lambda functions ( Lambda Developer Guide (https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function) +// ) and with Guard ( Guard GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) +// ), a policy-as-code language. Config custom rules created with Lambda are called +// Config Custom Lambda Rules and Config custom rules created with Guard are called +// Config Custom Policy Rules. For more information about developing and using +// Config rules, see Evaluating Resource with Config Rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) // in the Config Developer Guide. You can use the Amazon Web Services CLI and // Amazon Web Services SDKs if you want to create a rule that triggers evaluations // for your resources when Config delivers the configuration snapshot. For more -// information, see ConfigSnapshotDeliveryProperties. +// information, see ConfigSnapshotDeliveryProperties . type ConfigRule struct { - // Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY + // Provides the rule owner ( Amazon Web Services for managed rules, CUSTOM_POLICY // for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule // identifier, and the notifications that cause the function to evaluate your // Amazon Web Services resources. @@ -555,17 +537,13 @@ type ConfigRule struct { // The maximum frequency with which Config runs evaluations for a rule. You can // specify a value for MaximumExecutionFrequency when: - // - // * This is for an Config - // managed rule that is triggered at a periodic frequency. - // - // * Your custom rule is - // triggered when Config delivers the configuration snapshot. For more information, - // see ConfigSnapshotDeliveryProperties. - // - // By default, rules with a periodic trigger - // are evaluated every 24 hours. To change the frequency, specify a valid value for - // the MaximumExecutionFrequency parameter. + // - This is for an Config managed rule that is triggered at a periodic + // frequency. + // - Your custom rule is triggered when Config delivers the configuration + // snapshot. For more information, see ConfigSnapshotDeliveryProperties . + // By default, rules with a periodic trigger are evaluated every 24 hours. To + // change the frequency, specify a valid value for the MaximumExecutionFrequency + // parameter. MaximumExecutionFrequency MaximumExecutionFrequency // Defines which resources can trigger an evaluation for the rule. The scope can @@ -579,8 +557,8 @@ type ConfigRule struct { noSmithyDocumentSerde } -// Filters the compliance results based on account ID, region, compliance type, and -// rule name. +// Filters the compliance results based on account ID, region, compliance type, +// and rule name. type ConfigRuleComplianceFilters struct { // The 12-digit account ID of the source account. @@ -590,7 +568,7 @@ type ConfigRuleComplianceFilters struct { AwsRegion *string // The rule compliance status. For the ConfigRuleComplianceFilters data type, - // Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the + // Config supports only COMPLIANT and NON_COMPLIANT . Config does not support the // NOT_APPLICABLE and the INSUFFICIENT_DATA values. ComplianceType ComplianceType @@ -612,10 +590,10 @@ type ConfigRuleComplianceSummaryFilters struct { noSmithyDocumentSerde } -// Status information for your Config Managed rules and Config Custom Policy rules. -// The status includes information such as the last time the rule ran, the last -// time it failed, and the related error for the last failure. This action does not -// return status information about Config Custom Lambda rules. +// Status information for your Config Managed rules and Config Custom Policy +// rules. The status includes information such as the last time the rule ran, the +// last time it failed, and the related error for the last failure. This action +// does not return status information about Config Custom Lambda rules. type ConfigRuleEvaluationStatus struct { // The Amazon Resource Name (ARN) of the Config rule. @@ -632,19 +610,17 @@ type ConfigRuleEvaluationStatus struct { // Indicates whether Config has evaluated your resources against the rule at least // once. - // - // * true - Config has evaluated your Amazon Web Services resources against - // the rule at least once. - // - // * false - Config has not finished evaluating your - // Amazon Web Services resources against the rule at least once. + // - true - Config has evaluated your Amazon Web Services resources against the + // rule at least once. + // - false - Config has not finished evaluating your Amazon Web Services + // resources against the rule at least once. FirstEvaluationStarted bool // The time that you last turned off the Config rule. LastDeactivatedTime *time.Time // The status of the last attempted delivery of a debug log for your Config Custom - // Policy rules. Either Successful or Failed. + // Policy rules. Either Successful or Failed . LastDebugLogDeliveryStatus *string // The reason Config was not able to deliver a debug log. This is for the last @@ -684,39 +660,30 @@ type ConfigRuleEvaluationStatus struct { // Amazon S3 bucket in your delivery channel. The frequency for a rule that // triggers evaluations for your resources when Config delivers the configuration // snapshot is set by one of two values, depending on which is less frequent: +// - The value for the deliveryFrequency parameter within the delivery channel +// configuration, which sets how often Config delivers configuration snapshots. +// This value also sets how often Config invokes evaluations for Config rules. +// - The value for the MaximumExecutionFrequency parameter, which sets the +// maximum frequency with which Config invokes evaluations for the rule. For more +// information, see ConfigRule . // -// * -// The value for the deliveryFrequency parameter within the delivery channel -// configuration, which sets how often Config delivers configuration snapshots. -// This value also sets how often Config invokes evaluations for Config rules. +// If the deliveryFrequency value is less frequent than the +// MaximumExecutionFrequency value for a rule, Config invokes the rule only as +// often as the deliveryFrequency value. +// - For example, you want your rule to run evaluations when Config delivers the +// configuration snapshot. +// - You specify the MaximumExecutionFrequency value for Six_Hours . +// - You then specify the delivery channel deliveryFrequency value for +// TwentyFour_Hours . +// - Because the value for deliveryFrequency is less frequent than +// MaximumExecutionFrequency , Config invokes evaluations for the rule every 24 +// hours. // -// * -// The value for the MaximumExecutionFrequency parameter, which sets the maximum -// frequency with which Config invokes evaluations for the rule. For more -// information, see ConfigRule. -// -// If the deliveryFrequency value is less frequent -// than the MaximumExecutionFrequency value for a rule, Config invokes the rule -// only as often as the deliveryFrequency value. -// -// * For example, you want your rule -// to run evaluations when Config delivers the configuration snapshot. -// -// * You -// specify the MaximumExecutionFrequency value for Six_Hours. -// -// * You then specify -// the delivery channel deliveryFrequency value for TwentyFour_Hours. -// -// * Because -// the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, -// Config invokes evaluations for the rule every 24 hours. -// -// You should set the -// MaximumExecutionFrequency value to be at least as frequent as the -// deliveryFrequency value. You can view the deliveryFrequency value by using the -// DescribeDeliveryChannnels action. To update the deliveryFrequency with which -// Config delivers your configuration snapshots, use the PutDeliveryChannel action. +// You should set the MaximumExecutionFrequency value to be at least as frequent +// as the deliveryFrequency value. You can view the deliveryFrequency value by +// using the DescribeDeliveryChannnels action. To update the deliveryFrequency +// with which Config delivers your configuration snapshots, use the +// PutDeliveryChannel action. type ConfigSnapshotDeliveryProperties struct { // The frequency with which Config delivers configuration snapshots. @@ -736,8 +703,7 @@ type ConfigStreamDeliveryInfo struct { LastErrorMessage *string // Status of the last attempted delivery. Note Providing an SNS topic on a - // DeliveryChannel - // (https://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html) + // DeliveryChannel (https://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html) // for Config is optional. If the SNS delivery is turned off, the last status will // be Not_Applicable. LastStatus DeliveryStatus @@ -803,24 +769,15 @@ type ConfigurationItem struct { ConfigurationItemMD5Hash *string // The configuration item status. The valid values are: - // - // * OK – The resource - // configuration has been updated - // - // * ResourceDiscovered – The resource was newly - // discovered - // - // * ResourceNotRecorded – The resource was discovered but its - // configuration was not recorded since the recorder excludes the recording of - // resources of this type - // - // * ResourceDeleted – The resource was deleted - // - // * - // ResourceDeletedNotRecorded – The resource was deleted but its configuration was - // not recorded since the recorder excludes the recording of resources of this - // type - // + // - OK – The resource configuration has been updated + // - ResourceDiscovered – The resource was newly discovered + // - ResourceNotRecorded – The resource was discovered but its configuration was + // not recorded since the recorder excludes the recording of resources of this type + // + // - ResourceDeleted – The resource was deleted + // - ResourceDeletedNotRecorded – The resource was deleted but its configuration + // was not recorded since the recorder excludes the recording of resources of this + // type // The CIs do not incur any cost. ConfigurationItemStatus ConfigurationItemStatus @@ -830,12 +787,10 @@ type ConfigurationItem struct { // A list of CloudTrail event IDs. A populated field indicates that the current // configuration was initiated by the events recorded in the CloudTrail log. For - // more information about CloudTrail, see What Is CloudTrail - // (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). - // An empty field indicates that the current configuration was not initiated by any - // event. As of Version 1.3, the relatedEvents field is empty. You can access the - // LookupEvents API - // (https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html) + // more information about CloudTrail, see What Is CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html) + // . An empty field indicates that the current configuration was not initiated by + // any event. As of Version 1.3, the relatedEvents field is empty. You can access + // the LookupEvents API (https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html) // in the CloudTrail API Reference to retrieve the events for the resource. RelatedEvents []string @@ -845,7 +800,7 @@ type ConfigurationItem struct { // The time stamp when the resource was created. ResourceCreationTime *time.Time - // The ID of the resource (for example, sg-xxxxxx). + // The ID of the resource (for example, sg-xxxxxx ). ResourceId *string // The custom name of the resource, if available. @@ -926,7 +881,7 @@ type ConfigurationRecorderStatus struct { type ConformancePackComplianceFilters struct { // Filters the results by compliance. The allowed values are COMPLIANT and - // NON_COMPLIANT. INSUFFICIENT_DATA is not supported. + // NON_COMPLIANT . INSUFFICIENT_DATA is not supported. ComplianceType ConformancePackComplianceType // Filters the results by Config rule names. @@ -950,7 +905,7 @@ type ConformancePackComplianceScore struct { LastUpdatedTime *time.Time // Compliance score for the conformance pack. Conformance packs with no evaluation - // results will have a compliance score of INSUFFICIENT_DATA. + // results will have a compliance score of INSUFFICIENT_DATA . Score *string noSmithyDocumentSerde @@ -1012,8 +967,8 @@ type ConformancePackDetail struct { // The Amazon Web Services service that created the conformance pack. CreatedBy *string - // The name of the Amazon S3 bucket where Config stores conformance pack templates. - // This field is optional. + // The name of the Amazon S3 bucket where Config stores conformance pack + // templates. This field is optional. DeliveryS3Bucket *string // The prefix for the Amazon S3 bucket. This field is optional. @@ -1022,8 +977,8 @@ type ConformancePackDetail struct { // The last time a conformation pack update was requested. LastUpdateRequestedTime *time.Time - // An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web - // Services Systems Manager document (SSM document) and the version of the SSM + // An object that contains the name or Amazon Resource Name (ARN) of the Amazon + // Web Services Systems Manager document (SSM document) and the version of the SSM // document that is used to create a conformance pack. TemplateSSMDocumentDetails *TemplateSSMDocumentDetails @@ -1035,7 +990,7 @@ type ConformancePackDetail struct { type ConformancePackEvaluationFilters struct { // Filters the results by compliance. The allowed values are COMPLIANT and - // NON_COMPLIANT. INSUFFICIENT_DATA is not supported. + // NON_COMPLIANT . INSUFFICIENT_DATA is not supported. ComplianceType ConformancePackComplianceType // Filters the results by Config rule names. @@ -1045,7 +1000,7 @@ type ConformancePackEvaluationFilters struct { // resource type. If there is no resource type, you will see an error. ResourceIds []string - // Filters the results by the resource type (for example, "AWS::EC2::Instance"). + // Filters the results by the resource type (for example, "AWS::EC2::Instance" ). ResourceType *string noSmithyDocumentSerde @@ -1056,7 +1011,7 @@ type ConformancePackEvaluationFilters struct { // pack, related time stamps, and supplementary information. type ConformancePackEvaluationResult struct { - // The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. + // The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT . // INSUFFICIENT_DATA is not supported. // // This member is required. @@ -1139,21 +1094,13 @@ type ConformancePackStatusDetail struct { // Indicates deployment status of conformance pack. Config sets the state of the // conformance pack to: - // - // * CREATE_IN_PROGRESS when a conformance pack creation is - // in progress for an account. - // - // * CREATE_COMPLETE when a conformance pack has been - // successfully created in your account. - // - // * CREATE_FAILED when a conformance pack - // creation failed in your account. - // - // * DELETE_IN_PROGRESS when a conformance pack - // deletion is in progress. - // - // * DELETE_FAILED when a conformance pack deletion - // failed in your account. + // - CREATE_IN_PROGRESS when a conformance pack creation is in progress for an + // account. + // - CREATE_COMPLETE when a conformance pack has been successfully created in + // your account. + // - CREATE_FAILED when a conformance pack creation failed in your account. + // - DELETE_IN_PROGRESS when a conformance pack deletion is in progress. + // - DELETE_FAILED when a conformance pack deletion failed in your account. // // This member is required. ConformancePackState ConformancePackState @@ -1182,10 +1129,10 @@ type ConformancePackStatusDetail struct { // for Config Custom Policy rules. type CustomPolicyDetails struct { - // The runtime system for your Config Custom Policy rule. Guard is a policy-as-code - // language that allows you to write policies that are enforced by Config Custom - // Policy rules. For more information about Guard, see the Guard GitHub Repository - // (https://github.com/aws-cloudformation/cloudformation-guard). + // The runtime system for your Config Custom Policy rule. Guard is a + // policy-as-code language that allows you to write policies that are enforced by + // Config Custom Policy rules. For more information about Guard, see the Guard + // GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) . // // This member is required. PolicyRuntime *string @@ -1196,7 +1143,7 @@ type CustomPolicyDetails struct { PolicyText *string // The boolean expression for enabling debug logging for your Config Custom Policy - // rule. The default value is false. + // rule. The default value is false . EnableDebugLogDelivery bool noSmithyDocumentSerde @@ -1221,24 +1168,22 @@ type DeliveryChannel struct { // snapshots and configuration history files. If you specify a bucket that belongs // to another Amazon Web Services account, that bucket must have policies that // grant access permissions to Config. For more information, see Permissions for - // the Amazon S3 Bucket - // (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) + // the Amazon S3 Bucket (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) // in the Config Developer Guide. S3BucketName *string // The prefix for the specified Amazon S3 bucket. S3KeyPrefix *string - // The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS - // key) used to encrypt objects delivered by Config. Must belong to the same Region - // as the destination S3 bucket. + // The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key + // (KMS key) used to encrypt objects delivered by Config. Must belong to the same + // Region as the destination S3 bucket. S3KmsKeyArn *string // The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends // notifications about configuration changes. If you choose a topic from another // account, the topic must have policies that grant access permissions to Config. - // For more information, see Permissions for the Amazon SNS Topic - // (https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) + // For more information, see Permissions for the Amazon SNS Topic (https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) // in the Config Developer Guide. SnsTopicARN *string @@ -1268,8 +1213,7 @@ type DeliveryChannelStatus struct { // Returns a filtered list of Detective or Proactive Config rules. By default, if // the filter is not defined, this API returns an unfiltered list. For more -// information on Detective or Proactive Config rules, see Evaluation Mode -// (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html) +// information on Detective or Proactive Config rules, see Evaluation Mode (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html) // in the Config Developer Guide. type DescribeConfigRulesFilters struct { @@ -1293,11 +1237,11 @@ type Evaluation struct { // This member is required. ComplianceResourceType *string - // Indicates whether the Amazon Web Services resource complies with the Config rule - // that it was evaluated against. For the Evaluation data type, Config supports - // only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not - // support the INSUFFICIENT_DATA value for this data type. Similarly, Config does - // not accept INSUFFICIENT_DATA as the value for ComplianceType from a + // Indicates whether the Amazon Web Services resource complies with the Config + // rule that it was evaluated against. For the Evaluation data type, Config + // supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config + // does not support the INSUFFICIENT_DATA value for this data type. Similarly, + // Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a // PutEvaluations request. For example, an Lambda function for a custom Config rule // cannot pass an INSUFFICIENT_DATA value to Config. // @@ -1348,10 +1292,10 @@ type EvaluationResult struct { // Supplementary information about how the evaluation determined the compliance. Annotation *string - // Indicates whether the Amazon Web Services resource complies with the Config rule - // that evaluated it. For the EvaluationResult data type, Config supports only the - // COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the - // INSUFFICIENT_DATA value for the EvaluationResult data type. + // Indicates whether the Amazon Web Services resource complies with the Config + // rule that evaluated it. For the EvaluationResult data type, Config supports + // only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not + // support the INSUFFICIENT_DATA value for the EvaluationResult data type. ComplianceType ComplianceType // The time when the Config rule evaluated the Amazon Web Services resource. @@ -1450,7 +1394,7 @@ type ExternalEvaluation struct { ComplianceResourceType *string // The compliance of the Amazon Web Services resource. The valid values are - // COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE. + // COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE . // // This member is required. ComplianceType ComplianceType @@ -1460,8 +1404,8 @@ type ExternalEvaluation struct { // This member is required. OrderingTimestamp *time.Time - // Supplementary information about the reason of compliance. For example, this task - // was completed on a specific date. + // Supplementary information about the reason of compliance. For example, this + // task was completed on a specific date. Annotation *string noSmithyDocumentSerde @@ -1517,7 +1461,7 @@ type FieldInfo struct { type GroupedResourceCount struct { // The name of the group that can be region, account ID, or resource type. For - // example, region1, region2 if the region was chosen as GroupByKey. + // example, region1, region2 if the region was chosen as GroupByKey . // // This member is required. GroupName *string @@ -1551,35 +1495,17 @@ type MemberAccountStatus struct { // calls PutOrganizationConfigRule action for the second time, Config rule status // is updated in the member account. Config rule status is deleted when the // management account deletes OrganizationConfigRule and disables service access - // for config-multiaccountsetup.amazonaws.com. Config sets the state of the rule + // for config-multiaccountsetup.amazonaws.com . Config sets the state of the rule // to: - // - // * CREATE_SUCCESSFUL when Config rule has been created in the member - // account. - // - // * CREATE_IN_PROGRESS when Config rule is being created in the member - // account. - // - // * CREATE_FAILED when Config rule creation has failed in the member - // account. - // - // * DELETE_FAILED when Config rule deletion has failed in the member - // account. - // - // * DELETE_IN_PROGRESS when Config rule is being deleted in the member - // account. - // - // * DELETE_SUCCESSFUL when Config rule has been deleted in the member - // account. - // - // * UPDATE_SUCCESSFUL when Config rule has been updated in the member - // account. - // - // * UPDATE_IN_PROGRESS when Config rule is being updated in the member - // account. - // - // * UPDATE_FAILED when Config rule deletion has failed in the member - // account. + // - CREATE_SUCCESSFUL when Config rule has been created in the member account. + // - CREATE_IN_PROGRESS when Config rule is being created in the member account. + // - CREATE_FAILED when Config rule creation has failed in the member account. + // - DELETE_FAILED when Config rule deletion has failed in the member account. + // - DELETE_IN_PROGRESS when Config rule is being deleted in the member account. + // - DELETE_SUCCESSFUL when Config rule has been deleted in the member account. + // - UPDATE_SUCCESSFUL when Config rule has been updated in the member account. + // - UPDATE_IN_PROGRESS when Config rule is being updated in the member account. + // - UPDATE_FAILED when Config rule deletion has failed in the member account. // // This member is required. MemberAccountRuleStatus MemberAccountRuleStatus @@ -1669,38 +1595,22 @@ type OrganizationConfigRuleStatus struct { // when one or more member accounts join or leave an organization. Config rule // status is deleted when the management account deletes OrganizationConfigRule in // all the member accounts and disables service access for - // config-multiaccountsetup.amazonaws.com. Config sets the state of the rule to: - // - // * - // CREATE_SUCCESSFUL when an organization Config rule has been successfully created - // in all the member accounts. - // - // * CREATE_IN_PROGRESS when an organization Config - // rule creation is in progress. - // - // * CREATE_FAILED when an organization Config rule - // creation failed in one or more member accounts within that organization. - // - // * - // DELETE_FAILED when an organization Config rule deletion failed in one or more - // member accounts within that organization. - // - // * DELETE_IN_PROGRESS when an - // organization Config rule deletion is in progress. - // - // * DELETE_SUCCESSFUL when an - // organization Config rule has been successfully deleted from all the member - // accounts. - // - // * UPDATE_SUCCESSFUL when an organization Config rule has been - // successfully updated in all the member accounts. - // - // * UPDATE_IN_PROGRESS when an - // organization Config rule update is in progress. - // - // * UPDATE_FAILED when an - // organization Config rule update failed in one or more member accounts within - // that organization. + // config-multiaccountsetup.amazonaws.com . Config sets the state of the rule to: + // - CREATE_SUCCESSFUL when an organization Config rule has been successfully + // created in all the member accounts. + // - CREATE_IN_PROGRESS when an organization Config rule creation is in progress. + // - CREATE_FAILED when an organization Config rule creation failed in one or + // more member accounts within that organization. + // - DELETE_FAILED when an organization Config rule deletion failed in one or + // more member accounts within that organization. + // - DELETE_IN_PROGRESS when an organization Config rule deletion is in progress. + // - DELETE_SUCCESSFUL when an organization Config rule has been successfully + // deleted from all the member accounts. + // - UPDATE_SUCCESSFUL when an organization Config rule has been successfully + // updated in all the member accounts. + // - UPDATE_IN_PROGRESS when an organization Config rule update is in progress. + // - UPDATE_FAILED when an organization Config rule update failed in one or more + // member accounts within that organization. // // This member is required. OrganizationRuleStatus OrganizationRuleStatus @@ -1741,8 +1651,8 @@ type OrganizationConformancePack struct { // A list of ConformancePackInputParameter objects. ConformancePackInputParameters []ConformancePackInputParameter - // The name of the Amazon S3 bucket where Config stores conformance pack templates. - // This field is optional. + // The name of the Amazon S3 bucket where Config stores conformance pack + // templates. This field is optional. DeliveryS3Bucket *string // Any folder structure you want to add to an Amazon S3 bucket. This field is @@ -1777,41 +1687,32 @@ type OrganizationConformancePackDetailedStatus struct { // conformance pack status is updated in the member account. Conformance pack // status is deleted when the management account deletes // OrganizationConformancePack and disables service access for - // config-multiaccountsetup.amazonaws.com. Config sets the state of the conformance - // pack to: - // - // * CREATE_SUCCESSFUL when conformance pack has been created in the - // member account. - // - // * CREATE_IN_PROGRESS when conformance pack is being created in - // the member account. - // - // * CREATE_FAILED when conformance pack creation has failed - // in the member account. - // - // * DELETE_FAILED when conformance pack deletion has - // failed in the member account. - // - // * DELETE_IN_PROGRESS when conformance pack is - // being deleted in the member account. - // - // * DELETE_SUCCESSFUL when conformance pack - // has been deleted in the member account. - // - // * UPDATE_SUCCESSFUL when conformance - // pack has been updated in the member account. - // - // * UPDATE_IN_PROGRESS when - // conformance pack is being updated in the member account. - // - // * UPDATE_FAILED when - // conformance pack deletion has failed in the member account. + // config-multiaccountsetup.amazonaws.com . Config sets the state of the + // conformance pack to: + // - CREATE_SUCCESSFUL when conformance pack has been created in the member + // account. + // - CREATE_IN_PROGRESS when conformance pack is being created in the member + // account. + // - CREATE_FAILED when conformance pack creation has failed in the member + // account. + // - DELETE_FAILED when conformance pack deletion has failed in the member + // account. + // - DELETE_IN_PROGRESS when conformance pack is being deleted in the member + // account. + // - DELETE_SUCCESSFUL when conformance pack has been deleted in the member + // account. + // - UPDATE_SUCCESSFUL when conformance pack has been updated in the member + // account. + // - UPDATE_IN_PROGRESS when conformance pack is being updated in the member + // account. + // - UPDATE_FAILED when conformance pack deletion has failed in the member + // account. // // This member is required. Status OrganizationResourceDetailedStatus - // An error code that is returned when conformance pack creation or deletion failed - // in the member account. + // An error code that is returned when conformance pack creation or deletion + // failed in the member account. ErrorCode *string // An error message indicating that conformance pack account creation or deletion @@ -1832,47 +1733,34 @@ type OrganizationConformancePackStatus struct { // This member is required. OrganizationConformancePackName *string - // Indicates deployment status of an organization conformance pack. When management - // account calls PutOrganizationConformancePack for the first time, conformance - // pack status is created in all the member accounts. When management account calls - // PutOrganizationConformancePack for the second time, conformance pack status is - // updated in all the member accounts. Additionally, conformance pack status is - // updated when one or more member accounts join or leave an organization. - // Conformance pack status is deleted when the management account deletes - // OrganizationConformancePack in all the member accounts and disables service - // access for config-multiaccountsetup.amazonaws.com. Config sets the state of the - // conformance pack to: - // - // * CREATE_SUCCESSFUL when an organization conformance pack - // has been successfully created in all the member accounts. - // - // * CREATE_IN_PROGRESS - // when an organization conformance pack creation is in progress. - // - // * CREATE_FAILED - // when an organization conformance pack creation failed in one or more member - // accounts within that organization. - // - // * DELETE_FAILED when an organization - // conformance pack deletion failed in one or more member accounts within that - // organization. - // - // * DELETE_IN_PROGRESS when an organization conformance pack - // deletion is in progress. - // - // * DELETE_SUCCESSFUL when an organization conformance - // pack has been successfully deleted from all the member accounts. - // - // * - // UPDATE_SUCCESSFUL when an organization conformance pack has been successfully - // updated in all the member accounts. - // - // * UPDATE_IN_PROGRESS when an organization - // conformance pack update is in progress. - // - // * UPDATE_FAILED when an organization - // conformance pack update failed in one or more member accounts within that - // organization. + // Indicates deployment status of an organization conformance pack. When + // management account calls PutOrganizationConformancePack for the first time, + // conformance pack status is created in all the member accounts. When management + // account calls PutOrganizationConformancePack for the second time, conformance + // pack status is updated in all the member accounts. Additionally, conformance + // pack status is updated when one or more member accounts join or leave an + // organization. Conformance pack status is deleted when the management account + // deletes OrganizationConformancePack in all the member accounts and disables + // service access for config-multiaccountsetup.amazonaws.com . Config sets the + // state of the conformance pack to: + // - CREATE_SUCCESSFUL when an organization conformance pack has been + // successfully created in all the member accounts. + // - CREATE_IN_PROGRESS when an organization conformance pack creation is in + // progress. + // - CREATE_FAILED when an organization conformance pack creation failed in one + // or more member accounts within that organization. + // - DELETE_FAILED when an organization conformance pack deletion failed in one + // or more member accounts within that organization. + // - DELETE_IN_PROGRESS when an organization conformance pack deletion is in + // progress. + // - DELETE_SUCCESSFUL when an organization conformance pack has been + // successfully deleted from all the member accounts. + // - UPDATE_SUCCESSFUL when an organization conformance pack has been + // successfully updated in all the member accounts. + // - UPDATE_IN_PROGRESS when an organization conformance pack update is in + // progress. + // - UPDATE_FAILED when an organization conformance pack update failed in one or + // more member accounts within that organization. // // This member is required. Status OrganizationResourceStatus @@ -1901,7 +1789,7 @@ type OrganizationCustomPolicyRuleMetadata struct { // The runtime system for your organization Config Custom Policy rules. Guard is a // policy-as-code language that allows you to write policies that are enforced by // Config Custom Policy rules. For more information about Guard, see the Guard - // GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard). + // GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) . // // This member is required. PolicyRuntime *string @@ -1925,23 +1813,20 @@ type OrganizationCustomPolicyRuleMetadata struct { // Policy rule. InputParameters *string - // The maximum frequency with which Config runs evaluations for a rule. Your Config - // Custom Policy rule is triggered when Config delivers the configuration snapshot. - // For more information, see ConfigSnapshotDeliveryProperties. + // The maximum frequency with which Config runs evaluations for a rule. Your + // Config Custom Policy rule is triggered when Config delivers the configuration + // snapshot. For more information, see ConfigSnapshotDeliveryProperties . MaximumExecutionFrequency MaximumExecutionFrequency // The type of notification that initiates Config to run an evaluation for a rule. // For Config Custom Policy rules, Config supports change-initiated notification // types: - // - // * ConfigurationItemChangeNotification - Initiates an evaluation when - // Config delivers a configuration item as a result of a resource change. - // - // * - // OversizedConfigurationItemChangeNotification - Initiates an evaluation when - // Config delivers an oversized configuration item. Config may generate this - // notification type when a resource changes and the notification exceeds the - // maximum size allowed by Amazon SNS. + // - ConfigurationItemChangeNotification - Initiates an evaluation when Config + // delivers a configuration item as a result of a resource change. + // - OversizedConfigurationItemChangeNotification - Initiates an evaluation when + // Config delivers an oversized configuration item. Config may generate this + // notification type when a resource changes and the notification exceeds the + // maximum size allowed by Amazon SNS. OrganizationConfigRuleTriggerTypes []OrganizationConfigRuleTriggerTypeNoSN // The ID of the Amazon Web Services resource that was evaluated. @@ -1981,29 +1866,26 @@ type OrganizationCustomPolicyRuleMetadataNoPolicy struct { // Policy rule. InputParameters *string - // The maximum frequency with which Config runs evaluations for a rule. Your Config - // Custom Policy rule is triggered when Config delivers the configuration snapshot. - // For more information, see ConfigSnapshotDeliveryProperties. + // The maximum frequency with which Config runs evaluations for a rule. Your + // Config Custom Policy rule is triggered when Config delivers the configuration + // snapshot. For more information, see ConfigSnapshotDeliveryProperties . MaximumExecutionFrequency MaximumExecutionFrequency // The type of notification that triggers Config to run an evaluation for a rule. // For Config Custom Policy rules, Config supports change triggered notification // types: - // - // * ConfigurationItemChangeNotification - Triggers an evaluation when - // Config delivers a configuration item as a result of a resource change. - // - // * - // OversizedConfigurationItemChangeNotification - Triggers an evaluation when - // Config delivers an oversized configuration item. Config may generate this - // notification type when a resource changes and the notification exceeds the - // maximum size allowed by Amazon SNS. + // - ConfigurationItemChangeNotification - Triggers an evaluation when Config + // delivers a configuration item as a result of a resource change. + // - OversizedConfigurationItemChangeNotification - Triggers an evaluation when + // Config delivers an oversized configuration item. Config may generate this + // notification type when a resource changes and the notification exceeds the + // maximum size allowed by Amazon SNS. OrganizationConfigRuleTriggerTypes []OrganizationConfigRuleTriggerTypeNoSN // The runtime system for your organization Config Custom Policy rules. Guard is a // policy-as-code language that allows you to write policies that are enforced by // Config Custom Policy rules. For more information about Guard, see the Guard - // GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard). + // GitHub Repository (https://github.com/aws-cloudformation/cloudformation-guard) . PolicyRuntime *string // The ID of the Amazon Web Services resource that was evaluated. @@ -2037,19 +1919,14 @@ type OrganizationCustomRuleMetadata struct { // The type of notification that triggers Config to run an evaluation for a rule. // You can specify the following notification types: - // - // * - // ConfigurationItemChangeNotification - Triggers an evaluation when Config - // delivers a configuration item as a result of a resource change. - // - // * - // OversizedConfigurationItemChangeNotification - Triggers an evaluation when - // Config delivers an oversized configuration item. Config may generate this - // notification type when a resource changes and the notification exceeds the - // maximum size allowed by Amazon SNS. - // - // * ScheduledNotification - Triggers a - // periodic evaluation at the frequency specified for MaximumExecutionFrequency. + // - ConfigurationItemChangeNotification - Triggers an evaluation when Config + // delivers a configuration item as a result of a resource change. + // - OversizedConfigurationItemChangeNotification - Triggers an evaluation when + // Config delivers an oversized configuration item. Config may generate this + // notification type when a resource changes and the notification exceeds the + // maximum size allowed by Amazon SNS. + // - ScheduledNotification - Triggers a periodic evaluation at the frequency + // specified for MaximumExecutionFrequency . // // This member is required. OrganizationConfigRuleTriggerTypes []OrganizationConfigRuleTriggerType @@ -2057,15 +1934,15 @@ type OrganizationCustomRuleMetadata struct { // The description that you provide for your organization Config rule. Description *string - // A string, in JSON format, that is passed to your organization Config rule Lambda - // function. + // A string, in JSON format, that is passed to your organization Config rule + // Lambda function. InputParameters *string - // The maximum frequency with which Config runs evaluations for a rule. Your custom - // rule is triggered when Config delivers the configuration snapshot. For more - // information, see ConfigSnapshotDeliveryProperties. By default, rules with a - // periodic trigger are evaluated every 24 hours. To change the frequency, specify - // a valid value for the MaximumExecutionFrequency parameter. + // The maximum frequency with which Config runs evaluations for a rule. Your + // custom rule is triggered when Config delivers the configuration snapshot. For + // more information, see ConfigSnapshotDeliveryProperties . By default, rules with + // a periodic trigger are evaluated every 24 hours. To change the frequency, + // specify a valid value for the MaximumExecutionFrequency parameter. MaximumExecutionFrequency MaximumExecutionFrequency // The ID of the Amazon Web Services resource that was evaluated. @@ -2092,9 +1969,9 @@ type OrganizationCustomRuleMetadata struct { type OrganizationManagedRuleMetadata struct { // For organization config managed rules, a predefined identifier from a list. For - // example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see - // Using Config managed rules - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html). + // example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, + // see Using Config managed rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) + // . // // This member is required. RuleIdentifier *string @@ -2102,14 +1979,15 @@ type OrganizationManagedRuleMetadata struct { // The description that you provide for your organization Config rule. Description *string - // A string, in JSON format, that is passed to your organization Config rule Lambda - // function. + // A string, in JSON format, that is passed to your organization Config rule + // Lambda function. InputParameters *string - // The maximum frequency with which Config runs evaluations for a rule. This is for - // an Config managed rule that is triggered at a periodic frequency. By default, - // rules with a periodic trigger are evaluated every 24 hours. To change the - // frequency, specify a valid value for the MaximumExecutionFrequency parameter. + // The maximum frequency with which Config runs evaluations for a rule. This is + // for an Config managed rule that is triggered at a periodic frequency. By + // default, rules with a periodic trigger are evaluated every 24 hours. To change + // the frequency, specify a valid value for the MaximumExecutionFrequency + // parameter. MaximumExecutionFrequency MaximumExecutionFrequency // The ID of the Amazon Web Services resource that was evaluated. @@ -2143,35 +2021,26 @@ type OrganizationResourceDetailedStatusFilters struct { // conformance pack status is updated in the member account. Conformance pack // status is deleted when the management account deletes // OrganizationConformancePack and disables service access for - // config-multiaccountsetup.amazonaws.com. Config sets the state of the conformance - // pack to: - // - // * CREATE_SUCCESSFUL when conformance pack has been created in the - // member account. - // - // * CREATE_IN_PROGRESS when conformance pack is being created in - // the member account. - // - // * CREATE_FAILED when conformance pack creation has failed - // in the member account. - // - // * DELETE_FAILED when conformance pack deletion has - // failed in the member account. - // - // * DELETE_IN_PROGRESS when conformance pack is - // being deleted in the member account. - // - // * DELETE_SUCCESSFUL when conformance pack - // has been deleted in the member account. - // - // * UPDATE_SUCCESSFUL when conformance - // pack has been updated in the member account. - // - // * UPDATE_IN_PROGRESS when - // conformance pack is being updated in the member account. - // - // * UPDATE_FAILED when - // conformance pack deletion has failed in the member account. + // config-multiaccountsetup.amazonaws.com . Config sets the state of the + // conformance pack to: + // - CREATE_SUCCESSFUL when conformance pack has been created in the member + // account. + // - CREATE_IN_PROGRESS when conformance pack is being created in the member + // account. + // - CREATE_FAILED when conformance pack creation has failed in the member + // account. + // - DELETE_FAILED when conformance pack deletion has failed in the member + // account. + // - DELETE_IN_PROGRESS when conformance pack is being deleted in the member + // account. + // - DELETE_SUCCESSFUL when conformance pack has been deleted in the member + // account. + // - UPDATE_SUCCESSFUL when conformance pack has been updated in the member + // account. + // - UPDATE_IN_PROGRESS when conformance pack is being updated in the member + // account. + // - UPDATE_FAILED when conformance pack deletion has failed in the member + // account. Status OrganizationResourceDetailedStatus noSmithyDocumentSerde @@ -2215,7 +2084,7 @@ type QueryInfo struct { // partition. You can view the Configuration Items for these new global resource // types only in their home region and Amazon Web Services GovCloud (US) West. // Supported global resource types onboarded before February 2022 such as -// AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User remain +// AWS::IAM::Group , AWS::IAM::Policy , AWS::IAM::Role , AWS::IAM::User remain // unchanged, and they will continue to deliver Configuration Items in all // supported regions in Config. The change will only affect new global resource // types onboarded after February 2022. To record global resource types onboarded @@ -2223,40 +2092,39 @@ type QueryInfo struct { // the global resource type you want to record. If you don't want Config to record // all resources, you can specify which types of resources it will record with the // resourceTypes parameter. For a list of supported resource types, see Supported -// Resource Types -// (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources). -// For more information and a table of the Home Regions for Global Resource Types -// Onboarded after February 2022, see Selecting Which Resources Config Records -// (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html). +// Resource Types (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) +// . For more information and a table of the Home Regions for Global Resource Types +// Onboarded after February 2022, see Selecting Which Resources Config Records (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html) +// . type RecordingGroup struct { // Specifies whether Config records configuration changes for every supported type - // of regional resource. If you set this option to true, when Config adds support + // of regional resource. If you set this option to true , when Config adds support // for a new type of regional resource, it starts recording resources of that type - // automatically. If you set this option to true, you cannot enumerate a list of - // resourceTypes. + // automatically. If you set this option to true , you cannot enumerate a list of + // resourceTypes . AllSupported bool // Specifies whether Config includes all supported types of global resources (for // example, IAM resources) with the resources that it records. Before you can set - // this option to true, you must set the allSupported option to true. If you set - // this option to true, when Config adds support for a new type of global resource, - // it starts recording resources of that type automatically. The configuration - // details for any global resource are the same in all regions. To prevent - // duplicate configuration items, you should consider customizing Config in only - // one region to record global resources. + // this option to true , you must set the allSupported option to true . If you set + // this option to true , when Config adds support for a new type of global + // resource, it starts recording resources of that type automatically. The + // configuration details for any global resource are the same in all regions. To + // prevent duplicate configuration items, you should consider customizing Config in + // only one region to record global resources. IncludeGlobalResourceTypes bool - // A comma-separated list that specifies the types of Amazon Web Services resources - // for which Config records configuration changes (for example, AWS::EC2::Instance - // or AWS::CloudTrail::Trail). To record all configuration changes, you must set - // the allSupported option to true. If you set the AllSupported option to false and - // populate the ResourceTypes option with values, when Config adds support for a - // new type of resource, it will not record resources of that type unless you - // manually add that type to your recording group. For a list of valid - // resourceTypes values, see the resourceType Value column in Supported Amazon Web - // Services resource Types - // (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources). + // A comma-separated list that specifies the types of Amazon Web Services + // resources for which Config records configuration changes (for example, + // AWS::EC2::Instance or AWS::CloudTrail::Trail ). To record all configuration + // changes, you must set the allSupported option to true . If you set the + // AllSupported option to false and populate the ResourceTypes option with values, + // when Config adds support for a new type of resource, it will not record + // resources of that type unless you manually add that type to your recording + // group. For a list of valid resourceTypes values, see the resourceType Value + // column in Supported Amazon Web Services resource Types (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) + // . ResourceTypes []ResourceType noSmithyDocumentSerde @@ -2268,7 +2136,7 @@ type Relationship struct { // The type of relationship with the related resource. RelationshipName *string - // The ID of the related resource (for example, sg-xxxxxx). + // The ID of the related resource (for example, sg-xxxxxx ). ResourceId *string // The custom name of the related resource, if available. @@ -2311,11 +2179,11 @@ type RemediationConfiguration struct { // An ExecutionControls object. ExecutionControls *ExecutionControls - // The maximum number of failed attempts for auto-remediation. If you do not select - // a number, the default is 5. For example, if you specify MaximumAutomaticAttempts - // as 5 with RetryAttemptSeconds as 50 seconds, Config will put a - // RemediationException on your behalf for the failing resource after the 5th - // failed attempt within 50 seconds. + // The maximum number of failed attempts for auto-remediation. If you do not + // select a number, the default is 5. For example, if you specify + // MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config + // will put a RemediationException on your behalf for the failing resource after + // the 5th failed attempt within 50 seconds. MaximumAutomaticAttempts *int32 // An object of the RemediationParameterValue. @@ -2443,7 +2311,7 @@ type ResourceCount struct { // The number of resources. Count int64 - // The resource type (for example, "AWS::EC2::Instance"). + // The resource type (for example, "AWS::EC2::Instance" ). ResourceType ResourceType noSmithyDocumentSerde @@ -2467,8 +2335,8 @@ type ResourceCountFilters struct { // Returns information about the resource being evaluated. type ResourceDetails struct { - // The resource definition to be evaluated as per the resource configuration schema - // type. + // The resource definition to be evaluated as per the resource configuration + // schema type. // // This member is required. ResourceConfiguration *string @@ -2484,15 +2352,12 @@ type ResourceDetails struct { ResourceType *string // The schema type of the resource configuration. You can find the Resource type - // schema - // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html), - // or CFN_RESOURCE_SCHEMA, in "Amazon Web Services public extensions" within the + // schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) + // , or CFN_RESOURCE_SCHEMA , in "Amazon Web Services public extensions" within the // CloudFormation registry or with the following CLI commmand: aws cloudformation - // describe-type --type-name "AWS::S3::Bucket" --type RESOURCE. For more - // information, see Managing extensions through the CloudFormation registry - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view) - // and Amazon Web Services resource and property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // describe-type --type-name "AWS::S3::Bucket" --type RESOURCE . For more + // information, see Managing extensions through the CloudFormation registry (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view) + // and Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. ResourceConfigurationSchemaType ResourceConfigurationSchemaType @@ -2522,7 +2387,7 @@ type ResourceEvaluationFilters struct { EvaluationContextIdentifier *string // Filters all resource evaluations results based on an evaluation mode. the valid - // value for this API is Proactive. + // value for this API is Proactive . EvaluationMode EvaluationMode // Returns a TimeWindow object. @@ -2550,14 +2415,14 @@ type ResourceFilters struct { noSmithyDocumentSerde } -// The details that identify a resource that is discovered by Config, including the -// resource type, ID, and (if available) the custom resource name. +// The details that identify a resource that is discovered by Config, including +// the resource type, ID, and (if available) the custom resource name. type ResourceIdentifier struct { // The time that the resource was deleted. ResourceDeletionTime *time.Time - // The ID of the resource (for example, sg-xxxxxx). + // The ID of the resource (for example, sg-xxxxxx ). ResourceId *string // The custom name of the resource (if available). @@ -2625,27 +2490,27 @@ type Scope struct { // The ID of the only Amazon Web Services resource that you want to trigger an // evaluation for the rule. If you specify a resource ID, you must specify one - // resource type for ComplianceResourceTypes. + // resource type for ComplianceResourceTypes . ComplianceResourceId *string // The resource types of only those Amazon Web Services resources that you want to // trigger an evaluation for the rule. You can only specify one type if you also - // specify a resource ID for ComplianceResourceId. + // specify a resource ID for ComplianceResourceId . ComplianceResourceTypes []string - // The tag key that is applied to only those Amazon Web Services resources that you - // want to trigger an evaluation for the rule. + // The tag key that is applied to only those Amazon Web Services resources that + // you want to trigger an evaluation for the rule. TagKey *string // The tag value applied to only those Amazon Web Services resources that you want - // to trigger an evaluation for the rule. If you specify a value for TagValue, you - // must also specify a value for TagKey. + // to trigger an evaluation for the rule. If you specify a value for TagValue , you + // must also specify a value for TagKey . TagValue *string noSmithyDocumentSerde } -// Provides the CustomPolicyDetails, the rule owner (Amazon Web Services for +// Provides the CustomPolicyDetails, the rule owner ( Amazon Web Services for // managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for // Custom Lambda rules), the rule identifier, and the events that cause the // evaluation of your Amazon Web Services resources. @@ -2653,36 +2518,33 @@ type Source struct { // Indicates whether Amazon Web Services or the customer owns and manages the // Config rule. Config Managed Rules are predefined rules owned by Amazon Web - // Services. For more information, see Config Managed Rules - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) + // Services. For more information, see Config Managed Rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) // in the Config developer guide. Config Custom Rules are rules that you can - // develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more - // information, see Config Custom Rules - // (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) + // develop either with Guard ( CUSTOM_POLICY ) or Lambda ( CUSTOM_LAMBDA ). For + // more information, see Config Custom Rules (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) // in the Config developer guide. // // This member is required. Owner Owner // Provides the runtime system, policy definition, and whether debug logging is - // enabled. Required when owner is set to CUSTOM_POLICY. + // enabled. Required when owner is set to CUSTOM_POLICY . CustomPolicyDetails *CustomPolicyDetails // Provides the source and the message types that cause Config to evaluate your // Amazon Web Services resources against a rule. It also provides the frequency // with which you want Config to run evaluations for the rule if the trigger type - // is periodic. If the owner is set to CUSTOM_POLICY, the only acceptable values + // is periodic. If the owner is set to CUSTOM_POLICY , the only acceptable values // for the Config rule trigger message type are ConfigurationItemChangeNotification - // and OversizedConfigurationItemChangeNotification. + // and OversizedConfigurationItemChangeNotification . SourceDetails []SourceDetail // For Config Managed rules, a predefined identifier from a list. For example, // IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of - // Config Managed Rules - // (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). - // For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) - // of the rule's Lambda function, such as - // arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name. For Config + // Config Managed Rules (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) + // . For Config Custom Lambda rules, the identifier is the Amazon Resource Name + // (ARN) of the rule's Lambda function, such as + // arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name . For Config // Custom Policy rules, this field will be ignored. SourceIdentifier *string @@ -2700,40 +2562,31 @@ type SourceDetail struct { // Config to evaluate your Amazon Web Services resources. EventSource EventSource - // The frequency at which you want Config to run evaluations for a custom rule with - // a periodic trigger. If you specify a value for MaximumExecutionFrequency, then - // MessageType must use the ScheduledNotification value. By default, rules with a - // periodic trigger are evaluated every 24 hours. To change the frequency, specify - // a valid value for the MaximumExecutionFrequency parameter. Based on the valid - // value you choose, Config runs evaluations once for each valid value. For - // example, if you choose Three_Hours, Config runs evaluations once every three + // The frequency at which you want Config to run evaluations for a custom rule + // with a periodic trigger. If you specify a value for MaximumExecutionFrequency , + // then MessageType must use the ScheduledNotification value. By default, rules + // with a periodic trigger are evaluated every 24 hours. To change the frequency, + // specify a valid value for the MaximumExecutionFrequency parameter. Based on the + // valid value you choose, Config runs evaluations once for each valid value. For + // example, if you choose Three_Hours , Config runs evaluations once every three // hours. In this case, Three_Hours is the frequency of this rule. MaximumExecutionFrequency MaximumExecutionFrequency // The type of notification that triggers Config to run an evaluation for a rule. // You can specify the following notification types: - // - // * - // ConfigurationItemChangeNotification - Triggers an evaluation when Config - // delivers a configuration item as a result of a resource change. - // - // * - // OversizedConfigurationItemChangeNotification - Triggers an evaluation when - // Config delivers an oversized configuration item. Config may generate this - // notification type when a resource changes and the notification exceeds the - // maximum size allowed by Amazon SNS. - // - // * ScheduledNotification - Triggers a - // periodic evaluation at the frequency specified for MaximumExecutionFrequency. - // - // * - // ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when - // Config delivers a configuration snapshot. - // - // If you want your custom rule to be - // triggered by configuration changes, specify two SourceDetail objects, one for - // ConfigurationItemChangeNotification and one for - // OversizedConfigurationItemChangeNotification. + // - ConfigurationItemChangeNotification - Triggers an evaluation when Config + // delivers a configuration item as a result of a resource change. + // - OversizedConfigurationItemChangeNotification - Triggers an evaluation when + // Config delivers an oversized configuration item. Config may generate this + // notification type when a resource changes and the notification exceeds the + // maximum size allowed by Amazon SNS. + // - ScheduledNotification - Triggers a periodic evaluation at the frequency + // specified for MaximumExecutionFrequency . + // - ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when + // Config delivers a configuration snapshot. + // If you want your custom rule to be triggered by configuration changes, specify + // two SourceDetail objects, one for ConfigurationItemChangeNotification and one + // for OversizedConfigurationItemChangeNotification . MessageType MessageType noSmithyDocumentSerde @@ -2782,35 +2635,17 @@ type StatusDetailFilters struct { // calls PutOrganizationConfigRule action for the second time, Config rule status // is updated in the member account. Config rule status is deleted when the // management account deletes OrganizationConfigRule and disables service access - // for config-multiaccountsetup.amazonaws.com. Config sets the state of the rule + // for config-multiaccountsetup.amazonaws.com . Config sets the state of the rule // to: - // - // * CREATE_SUCCESSFUL when Config rule has been created in the member - // account. - // - // * CREATE_IN_PROGRESS when Config rule is being created in the member - // account. - // - // * CREATE_FAILED when Config rule creation has failed in the member - // account. - // - // * DELETE_FAILED when Config rule deletion has failed in the member - // account. - // - // * DELETE_IN_PROGRESS when Config rule is being deleted in the member - // account. - // - // * DELETE_SUCCESSFUL when Config rule has been deleted in the member - // account. - // - // * UPDATE_SUCCESSFUL when Config rule has been updated in the member - // account. - // - // * UPDATE_IN_PROGRESS when Config rule is being updated in the member - // account. - // - // * UPDATE_FAILED when Config rule deletion has failed in the member - // account. + // - CREATE_SUCCESSFUL when Config rule has been created in the member account. + // - CREATE_IN_PROGRESS when Config rule is being created in the member account. + // - CREATE_FAILED when Config rule creation has failed in the member account. + // - DELETE_FAILED when Config rule deletion has failed in the member account. + // - DELETE_IN_PROGRESS when Config rule is being deleted in the member account. + // - DELETE_SUCCESSFUL when Config rule has been deleted in the member account. + // - UPDATE_SUCCESSFUL when Config rule has been updated in the member account. + // - UPDATE_IN_PROGRESS when Config rule is being updated in the member account. + // - UPDATE_FAILED when Config rule deletion has failed in the member account. MemberAccountRuleStatus MemberAccountRuleStatus noSmithyDocumentSerde @@ -2868,10 +2703,10 @@ type StoredQueryMetadata struct { noSmithyDocumentSerde } -// The tags for the resource. The metadata that you apply to a resource to help you -// categorize and organize them. Each tag consists of a key and an optional value, -// both of which you define. Tag keys can have a maximum character length of 128 -// characters, and tag values can have a maximum length of 256 characters. +// The tags for the resource. The metadata that you apply to a resource to help +// you categorize and organize them. Each tag consists of a key and an optional +// value, both of which you define. Tag keys can have a maximum character length of +// 128 characters, and tag values can have a maximum length of 256 characters. type Tag struct { // One part of a key-value pair that make up a tag. A key is a general label that @@ -2888,10 +2723,10 @@ type Tag struct { // This API allows you to create a conformance pack template with an Amazon Web // Services Systems Manager document (SSM document). To deploy a conformance pack // using an SSM document, first create an SSM document with conformance pack -// content, and then provide the DocumentName in the PutConformancePack API -// (https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html). -// You can also provide the DocumentVersion. The TemplateSSMDocumentDetails object -// contains the name of the SSM document and the version of the SSM document. +// content, and then provide the DocumentName in the PutConformancePack API (https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html) +// . You can also provide the DocumentVersion . The TemplateSSMDocumentDetails +// object contains the name of the SSM document and the version of the SSM +// document. type TemplateSSMDocumentDetails struct { // The name or Amazon Resource Name (ARN) of the SSM document to use to create a @@ -2902,8 +2737,8 @@ type TemplateSSMDocumentDetails struct { // This member is required. DocumentName *string - // The version of the SSM document to use to create a conformance pack. By default, - // Config uses the latest version. This field is optional. + // The version of the SSM document to use to create a conformance pack. By + // default, Config uses the latest version. This field is optional. DocumentVersion *string noSmithyDocumentSerde diff --git a/service/connect/api_client.go b/service/connect/api_client.go index a9985054966..6a7cdcda610 100644 --- a/service/connect/api_client.go +++ b/service/connect/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/connect/api_op_AssociateApprovedOrigin.go b/service/connect/api_op_AssociateApprovedOrigin.go index 6bf6c1528dd..749c14b5a29 100644 --- a/service/connect/api_op_AssociateApprovedOrigin.go +++ b/service/connect/api_op_AssociateApprovedOrigin.go @@ -29,8 +29,7 @@ func (c *Client) AssociateApprovedOrigin(ctx context.Context, params *AssociateA type AssociateApprovedOriginInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateBot.go b/service/connect/api_op_AssociateBot.go index a9e6a0f5cf9..213921e3e58 100644 --- a/service/connect/api_op_AssociateBot.go +++ b/service/connect/api_op_AssociateBot.go @@ -31,8 +31,7 @@ func (c *Client) AssociateBot(ctx context.Context, params *AssociateBotInput, op type AssociateBotInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateDefaultVocabulary.go b/service/connect/api_op_AssociateDefaultVocabulary.go index e93e77f20a5..b3401b99c18 100644 --- a/service/connect/api_op_AssociateDefaultVocabulary.go +++ b/service/connect/api_op_AssociateDefaultVocabulary.go @@ -31,22 +31,20 @@ func (c *Client) AssociateDefaultVocabulary(ctx context.Context, params *Associa type AssociateDefaultVocabularyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) // // This member is required. LanguageCode types.VocabularyLanguageCode - // The identifier of the custom vocabulary. If this is empty, the default is set to - // none. + // The identifier of the custom vocabulary. If this is empty, the default is set + // to none. VocabularyId *string noSmithyDocumentSerde diff --git a/service/connect/api_op_AssociateInstanceStorageConfig.go b/service/connect/api_op_AssociateInstanceStorageConfig.go index a9bd64b79f3..e802f17219c 100644 --- a/service/connect/api_op_AssociateInstanceStorageConfig.go +++ b/service/connect/api_op_AssociateInstanceStorageConfig.go @@ -36,8 +36,7 @@ func (c *Client) AssociateInstanceStorageConfig(ctx context.Context, params *Ass type AssociateInstanceStorageConfigInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateLambdaFunction.go b/service/connect/api_op_AssociateLambdaFunction.go index d9cd77f8cd2..24d58cb4609 100644 --- a/service/connect/api_op_AssociateLambdaFunction.go +++ b/service/connect/api_op_AssociateLambdaFunction.go @@ -30,14 +30,13 @@ func (c *Client) AssociateLambdaFunction(ctx context.Context, params *AssociateL type AssociateLambdaFunctionInput struct { - // The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum - // number of characters allowed is 140. + // The Amazon Resource Name (ARN) for the Lambda function being associated. + // Maximum number of characters allowed is 140. // // This member is required. FunctionArn *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateLexBot.go b/service/connect/api_op_AssociateLexBot.go index c7453b38231..98ea918ef2e 100644 --- a/service/connect/api_op_AssociateLexBot.go +++ b/service/connect/api_op_AssociateLexBot.go @@ -31,8 +31,7 @@ func (c *Client) AssociateLexBot(ctx context.Context, params *AssociateLexBotInp type AssociateLexBotInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociatePhoneNumberContactFlow.go b/service/connect/api_op_AssociatePhoneNumberContactFlow.go index b8d4fa3ebf1..25ad46d3338 100644 --- a/service/connect/api_op_AssociatePhoneNumberContactFlow.go +++ b/service/connect/api_op_AssociatePhoneNumberContactFlow.go @@ -18,7 +18,7 @@ import ( // is claimed to a traffic distribution group and you are calling this API using an // instance in the alternate Amazon Web Services Region associated with the traffic // distribution group, you must provide a full phone number ARN. If a UUID is -// provided in this scenario, you will receive a ResourceNotFoundException. +// provided in this scenario, you will receive a ResourceNotFoundException . func (c *Client) AssociatePhoneNumberContactFlow(ctx context.Context, params *AssociatePhoneNumberContactFlowInput, optFns ...func(*Options)) (*AssociatePhoneNumberContactFlowOutput, error) { if params == nil { params = &AssociatePhoneNumberContactFlowInput{} @@ -41,8 +41,7 @@ type AssociatePhoneNumberContactFlowInput struct { // This member is required. ContactFlowId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateQueueQuickConnects.go b/service/connect/api_op_AssociateQueueQuickConnects.go index b0f12d4f81d..a39006fb929 100644 --- a/service/connect/api_op_AssociateQueueQuickConnects.go +++ b/service/connect/api_op_AssociateQueueQuickConnects.go @@ -29,8 +29,7 @@ func (c *Client) AssociateQueueQuickConnects(ctx context.Context, params *Associ type AssociateQueueQuickConnectsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateRoutingProfileQueues.go b/service/connect/api_op_AssociateRoutingProfileQueues.go index 69b4af1b9c9..0a4d0a6c800 100644 --- a/service/connect/api_op_AssociateRoutingProfileQueues.go +++ b/service/connect/api_op_AssociateRoutingProfileQueues.go @@ -29,8 +29,7 @@ func (c *Client) AssociateRoutingProfileQueues(ctx context.Context, params *Asso type AssociateRoutingProfileQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_AssociateSecurityKey.go b/service/connect/api_op_AssociateSecurityKey.go index 6238a33a9ed..ca29f8e32a7 100644 --- a/service/connect/api_op_AssociateSecurityKey.go +++ b/service/connect/api_op_AssociateSecurityKey.go @@ -29,8 +29,7 @@ func (c *Client) AssociateSecurityKey(ctx context.Context, params *AssociateSecu type AssociateSecurityKeyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ClaimPhoneNumber.go b/service/connect/api_op_ClaimPhoneNumber.go index 3b364ca8cd8..6f50b271bde 100644 --- a/service/connect/api_op_ClaimPhoneNumber.go +++ b/service/connect/api_op_ClaimPhoneNumber.go @@ -14,18 +14,13 @@ import ( // Claims an available phone number to your Amazon Connect instance or traffic // distribution group. You can call this API only in the same Amazon Web Services // Region where the Amazon Connect instance or traffic distribution group was -// created. For more information about how to use this operation, see Claim a phone -// number in your country -// (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html) -// and Claim phone numbers to traffic distribution groups -// (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html) +// created. For more information about how to use this operation, see Claim a +// phone number in your country (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html) +// and Claim phone numbers to traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html) // in the Amazon Connect Administrator Guide. You can call the -// SearchAvailablePhoneNumbers -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html) -// API for available phone numbers that you can claim. Call the DescribePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) -// API to verify the status of a previous ClaimPhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) +// SearchAvailablePhoneNumbers (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html) +// API for available phone numbers that you can claim. Call the DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) +// API to verify the status of a previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) // operation. func (c *Client) ClaimPhoneNumber(ctx context.Context, params *ClaimPhoneNumberInput, optFns ...func(*Options)) (*ClaimPhoneNumberOutput, error) { if params == nil { @@ -45,7 +40,7 @@ func (c *Client) ClaimPhoneNumber(ctx context.Context, params *ClaimPhoneNumberI type ClaimPhoneNumberInput struct { // The phone number you want to claim. Phone numbers are formatted [+] [country - // code] [subscriber number including area code]. + // code] [subscriber number including area code] . // // This member is required. PhoneNumber *string @@ -59,9 +54,8 @@ type ClaimPhoneNumberInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). - // Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ ClientToken *string // The description of the phone number. diff --git a/service/connect/api_op_CreateAgentStatus.go b/service/connect/api_op_CreateAgentStatus.go index e38ddb27de2..e8d6b12df3c 100644 --- a/service/connect/api_op_CreateAgentStatus.go +++ b/service/connect/api_op_CreateAgentStatus.go @@ -30,8 +30,7 @@ func (c *Client) CreateAgentStatus(ctx context.Context, params *CreateAgentStatu type CreateAgentStatusInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateContactFlow.go b/service/connect/api_op_CreateContactFlow.go index 1273213b1f8..4998398e91d 100644 --- a/service/connect/api_op_CreateContactFlow.go +++ b/service/connect/api_op_CreateContactFlow.go @@ -12,8 +12,8 @@ import ( ) // Creates a flow for the specified Amazon Connect instance. You can also create -// and update flows using the Amazon Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). +// and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . func (c *Client) CreateContactFlow(ctx context.Context, params *CreateContactFlowInput, optFns ...func(*Options)) (*CreateContactFlowOutput, error) { if params == nil { params = &CreateContactFlowInput{} @@ -46,9 +46,8 @@ type CreateContactFlowInput struct { // This member is required. Name *string - // The type of the flow. For descriptions of the available types, see Choose a flow - // type - // (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) + // The type of the flow. For descriptions of the available types, see Choose a + // flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) // in the Amazon Connect Administrator Guide. // // This member is required. diff --git a/service/connect/api_op_CreateContactFlowModule.go b/service/connect/api_op_CreateContactFlowModule.go index c6045fc8528..f7dac1ef750 100644 --- a/service/connect/api_op_CreateContactFlowModule.go +++ b/service/connect/api_op_CreateContactFlowModule.go @@ -34,8 +34,7 @@ type CreateContactFlowModuleInput struct { // This member is required. Content *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -49,8 +48,8 @@ type CreateContactFlowModuleInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The description of the flow module. diff --git a/service/connect/api_op_CreateHoursOfOperation.go b/service/connect/api_op_CreateHoursOfOperation.go index af26596ae5f..10a9a2db4b1 100644 --- a/service/connect/api_op_CreateHoursOfOperation.go +++ b/service/connect/api_op_CreateHoursOfOperation.go @@ -36,8 +36,7 @@ type CreateHoursOfOperationInput struct { // This member is required. Config []types.HoursOfOperationConfig - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateIntegrationAssociation.go b/service/connect/api_op_CreateIntegrationAssociation.go index 83a9cfdcba0..07303b01c26 100644 --- a/service/connect/api_op_CreateIntegrationAssociation.go +++ b/service/connect/api_op_CreateIntegrationAssociation.go @@ -30,8 +30,7 @@ func (c *Client) CreateIntegrationAssociation(ctx context.Context, params *Creat type CreateIntegrationAssociationInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateQueue.go b/service/connect/api_op_CreateQueue.go index 786b5d5689c..9c49fb86487 100644 --- a/service/connect/api_op_CreateQueue.go +++ b/service/connect/api_op_CreateQueue.go @@ -17,13 +17,12 @@ import ( // calling this API using an instance in the Amazon Web Services Region where the // traffic distribution group was created, you can use either a full phone number // ARN or UUID value for the OutboundCallerIdNumberId value of the -// OutboundCallerConfig -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig) +// OutboundCallerConfig (https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig) // request body parameter. However, if the number is claimed to a traffic // distribution group and you are calling this API using an instance in the // alternate Amazon Web Services Region associated with the traffic distribution // group, you must provide a full phone number ARN. If a UUID is provided in this -// scenario, you will receive a ResourceNotFoundException. +// scenario, you will receive a ResourceNotFoundException . func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error) { if params == nil { params = &CreateQueueInput{} @@ -46,8 +45,7 @@ type CreateQueueInput struct { // This member is required. HoursOfOperationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateQuickConnect.go b/service/connect/api_op_CreateQuickConnect.go index 5b9b2a8a3c8..a66914830bd 100644 --- a/service/connect/api_op_CreateQuickConnect.go +++ b/service/connect/api_op_CreateQuickConnect.go @@ -29,8 +29,7 @@ func (c *Client) CreateQuickConnect(ctx context.Context, params *CreateQuickConn type CreateQuickConnectInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateRoutingProfile.go b/service/connect/api_op_CreateRoutingProfile.go index a7dd428eec2..2883f1df091 100644 --- a/service/connect/api_op_CreateRoutingProfile.go +++ b/service/connect/api_op_CreateRoutingProfile.go @@ -39,8 +39,7 @@ type CreateRoutingProfileInput struct { // This member is required. Description *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -61,9 +60,9 @@ type CreateRoutingProfileInput struct { // the agent can make only outbound calls. The limit of 10 array members applies to // the maximum number of RoutingProfileQueueConfig objects that can be passed // during a CreateRoutingProfile API request. It is different from the quota of 50 - // queues per routing profile per instance that is listed in Amazon Connect service - // quotas - // (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html). + // queues per routing profile per instance that is listed in Amazon Connect + // service quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) + // . QueueConfigs []types.RoutingProfileQueueConfig // The tags used to organize, track, or control access for this resource. For diff --git a/service/connect/api_op_CreateRule.go b/service/connect/api_op_CreateRule.go index 202ce422435..23a7e0c4e93 100644 --- a/service/connect/api_op_CreateRule.go +++ b/service/connect/api_op_CreateRule.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a rule for the specified Amazon Connect instance. Use the Rules Function -// language -// (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) +// Creates a rule for the specified Amazon Connect instance. Use the Rules +// Function language (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) // to code conditions for the rule. func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { @@ -43,8 +42,7 @@ type CreateRuleInput struct { // This member is required. Function *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -68,8 +66,8 @@ type CreateRuleInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_CreateSecurityProfile.go b/service/connect/api_op_CreateSecurityProfile.go index 59594f18cf6..ef37cdaa030 100644 --- a/service/connect/api_op_CreateSecurityProfile.go +++ b/service/connect/api_op_CreateSecurityProfile.go @@ -29,8 +29,7 @@ func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecuri type CreateSecurityProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -41,21 +40,21 @@ type CreateSecurityProfileInput struct { // This member is required. SecurityProfileName *string - // The list of tags that a security profile uses to restrict access to resources in - // Amazon Connect. + // The list of tags that a security profile uses to restrict access to resources + // in Amazon Connect. AllowedAccessControlTags map[string]string // The description of the security profile. Description *string // Permissions assigned to the security profile. For a list of valid permissions, - // see List of security profile permissions - // (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). + // see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html) + // . Permissions []string // The list of resources that a security profile applies tag restrictions to in - // Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | - // Queue | RoutingProfile + // Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile + // | Queue | RoutingProfile TagRestrictedResources []string // The tags used to organize, track, or control access for this resource. For diff --git a/service/connect/api_op_CreateTaskTemplate.go b/service/connect/api_op_CreateTaskTemplate.go index 17f79c20519..aee98f36916 100644 --- a/service/connect/api_op_CreateTaskTemplate.go +++ b/service/connect/api_op_CreateTaskTemplate.go @@ -35,8 +35,7 @@ type CreateTaskTemplateInput struct { // This member is required. Fields []types.TaskTemplateField - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -50,8 +49,8 @@ type CreateTaskTemplateInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // Constraints that are applicable to the fields listed. @@ -68,9 +67,9 @@ type CreateTaskTemplateInput struct { // The description of the task template. Description *string - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status types.TaskTemplateStatus noSmithyDocumentSerde diff --git a/service/connect/api_op_CreateTrafficDistributionGroup.go b/service/connect/api_op_CreateTrafficDistributionGroup.go index 5f296297169..76f3e00b041 100644 --- a/service/connect/api_op_CreateTrafficDistributionGroup.go +++ b/service/connect/api_op_CreateTrafficDistributionGroup.go @@ -13,8 +13,7 @@ import ( // Creates a traffic distribution group given an Amazon Connect instance that has // been replicated. For more information about creating traffic distribution -// groups, see Set up traffic distribution groups -// (https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html) +// groups, see Set up traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html) // in the Amazon Connect Administrator Guide. func (c *Client) CreateTrafficDistributionGroup(ctx context.Context, params *CreateTrafficDistributionGroupInput, optFns ...func(*Options)) (*CreateTrafficDistributionGroupOutput, error) { if params == nil { @@ -47,8 +46,8 @@ type CreateTrafficDistributionGroupInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A description for the traffic distribution group. diff --git a/service/connect/api_op_CreateUseCase.go b/service/connect/api_op_CreateUseCase.go index f55dec41a67..f6de0e92dc5 100644 --- a/service/connect/api_op_CreateUseCase.go +++ b/service/connect/api_op_CreateUseCase.go @@ -29,8 +29,7 @@ func (c *Client) CreateUseCase(ctx context.Context, params *CreateUseCaseInput, type CreateUseCaseInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateUser.go b/service/connect/api_op_CreateUser.go index fe3957f437e..f75c87571e5 100644 --- a/service/connect/api_op_CreateUser.go +++ b/service/connect/api_op_CreateUser.go @@ -13,9 +13,8 @@ import ( // Creates a user account for the specified Amazon Connect instance. For // information about how to create user accounts using the Amazon Connect console, -// see Add Users -// (https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in -// the Amazon Connect Administrator Guide. +// see Add Users (https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) +// in the Amazon Connect Administrator Guide. func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} @@ -33,8 +32,7 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateUserHierarchyGroup.go b/service/connect/api_op_CreateUserHierarchyGroup.go index 96a4c1aef6e..4adb9bec228 100644 --- a/service/connect/api_op_CreateUserHierarchyGroup.go +++ b/service/connect/api_op_CreateUserHierarchyGroup.go @@ -28,8 +28,7 @@ func (c *Client) CreateUserHierarchyGroup(ctx context.Context, params *CreateUse type CreateUserHierarchyGroupInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_CreateVocabulary.go b/service/connect/api_op_CreateVocabulary.go index bc6b7a48d23..f1bbebb0480 100644 --- a/service/connect/api_op_CreateVocabulary.go +++ b/service/connect/api_op_CreateVocabulary.go @@ -35,24 +35,22 @@ type CreateVocabularyInput struct { // The content of the custom vocabulary in plain-text format with a table of // values. Each row in the table represents a word or a phrase, described with - // Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB + // Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB // characters. The size limit is 50KB. For more information, see Create a custom - // vocabulary using a table - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). + // vocabulary using a table (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table) + // . // // This member is required. Content *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) // // This member is required. LanguageCode types.VocabularyLanguageCode @@ -65,9 +63,8 @@ type CreateVocabularyInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). - // If a create request is received more than once with same client token, + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . If a create request is received more than once with same client token, // subsequent requests return the previous response without creating a vocabulary // again. ClientToken *string diff --git a/service/connect/api_op_DeleteContactFlow.go b/service/connect/api_op_DeleteContactFlow.go index bd7fcae16e0..5b7e71eb429 100644 --- a/service/connect/api_op_DeleteContactFlow.go +++ b/service/connect/api_op_DeleteContactFlow.go @@ -33,8 +33,7 @@ type DeleteContactFlowInput struct { // This member is required. ContactFlowId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteContactFlowModule.go b/service/connect/api_op_DeleteContactFlowModule.go index 189b28d9cc2..7ae6a4ea317 100644 --- a/service/connect/api_op_DeleteContactFlowModule.go +++ b/service/connect/api_op_DeleteContactFlowModule.go @@ -33,8 +33,7 @@ type DeleteContactFlowModuleInput struct { // This member is required. ContactFlowModuleId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteHoursOfOperation.go b/service/connect/api_op_DeleteHoursOfOperation.go index 0053290eefd..d098b866694 100644 --- a/service/connect/api_op_DeleteHoursOfOperation.go +++ b/service/connect/api_op_DeleteHoursOfOperation.go @@ -34,8 +34,7 @@ type DeleteHoursOfOperationInput struct { // This member is required. HoursOfOperationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteInstance.go b/service/connect/api_op_DeleteInstance.go index 85037f77ee5..1ec64d763b2 100644 --- a/service/connect/api_op_DeleteInstance.go +++ b/service/connect/api_op_DeleteInstance.go @@ -33,8 +33,7 @@ func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput type DeleteInstanceInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteIntegrationAssociation.go b/service/connect/api_op_DeleteIntegrationAssociation.go index 51901f73d68..4429b0c16e1 100644 --- a/service/connect/api_op_DeleteIntegrationAssociation.go +++ b/service/connect/api_op_DeleteIntegrationAssociation.go @@ -29,8 +29,7 @@ func (c *Client) DeleteIntegrationAssociation(ctx context.Context, params *Delet type DeleteIntegrationAssociationInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteQuickConnect.go b/service/connect/api_op_DeleteQuickConnect.go index be4fb154a88..5c7a6d75dcb 100644 --- a/service/connect/api_op_DeleteQuickConnect.go +++ b/service/connect/api_op_DeleteQuickConnect.go @@ -28,8 +28,7 @@ func (c *Client) DeleteQuickConnect(ctx context.Context, params *DeleteQuickConn type DeleteQuickConnectInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteRule.go b/service/connect/api_op_DeleteRule.go index 535faf89509..0dfeef4e38a 100644 --- a/service/connect/api_op_DeleteRule.go +++ b/service/connect/api_op_DeleteRule.go @@ -28,8 +28,7 @@ func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns type DeleteRuleInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteSecurityProfile.go b/service/connect/api_op_DeleteSecurityProfile.go index 77c7a4d5e28..f41de58284c 100644 --- a/service/connect/api_op_DeleteSecurityProfile.go +++ b/service/connect/api_op_DeleteSecurityProfile.go @@ -29,8 +29,7 @@ func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecuri type DeleteSecurityProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteTaskTemplate.go b/service/connect/api_op_DeleteTaskTemplate.go index dc02e3a94f6..0e1243baa3f 100644 --- a/service/connect/api_op_DeleteTaskTemplate.go +++ b/service/connect/api_op_DeleteTaskTemplate.go @@ -28,8 +28,7 @@ func (c *Client) DeleteTaskTemplate(ctx context.Context, params *DeleteTaskTempl type DeleteTaskTemplateInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteTrafficDistributionGroup.go b/service/connect/api_op_DeleteTrafficDistributionGroup.go index bcc093aaa38..0407308b61d 100644 --- a/service/connect/api_op_DeleteTrafficDistributionGroup.go +++ b/service/connect/api_op_DeleteTrafficDistributionGroup.go @@ -12,8 +12,7 @@ import ( // Deletes a traffic distribution group. This API can be called only in the Region // where the traffic distribution group is created. For more information about -// deleting traffic distribution groups, see Delete traffic distribution groups -// (https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html) +// deleting traffic distribution groups, see Delete traffic distribution groups (https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html) // in the Amazon Connect Administrator Guide. func (c *Client) DeleteTrafficDistributionGroup(ctx context.Context, params *DeleteTrafficDistributionGroupInput, optFns ...func(*Options)) (*DeleteTrafficDistributionGroupOutput, error) { if params == nil { diff --git a/service/connect/api_op_DeleteUseCase.go b/service/connect/api_op_DeleteUseCase.go index 06acace747e..75e0af85053 100644 --- a/service/connect/api_op_DeleteUseCase.go +++ b/service/connect/api_op_DeleteUseCase.go @@ -28,8 +28,7 @@ func (c *Client) DeleteUseCase(ctx context.Context, params *DeleteUseCaseInput, type DeleteUseCaseInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteUser.go b/service/connect/api_op_DeleteUser.go index 411279df4cf..1fa838e1064 100644 --- a/service/connect/api_op_DeleteUser.go +++ b/service/connect/api_op_DeleteUser.go @@ -12,9 +12,8 @@ import ( // Deletes a user account from the specified Amazon Connect instance. For // information about what happens to a user's data when their account is deleted, -// see Delete Users from Your Amazon Connect Instance -// (https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html) in the -// Amazon Connect Administrator Guide. +// see Delete Users from Your Amazon Connect Instance (https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html) +// in the Amazon Connect Administrator Guide. func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} @@ -32,8 +31,7 @@ func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns type DeleteUserInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteUserHierarchyGroup.go b/service/connect/api_op_DeleteUserHierarchyGroup.go index 5f76b158a26..5fba0aa5276 100644 --- a/service/connect/api_op_DeleteUserHierarchyGroup.go +++ b/service/connect/api_op_DeleteUserHierarchyGroup.go @@ -34,8 +34,7 @@ type DeleteUserHierarchyGroupInput struct { // This member is required. HierarchyGroupId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DeleteVocabulary.go b/service/connect/api_op_DeleteVocabulary.go index 928c50b6089..19d695278cd 100644 --- a/service/connect/api_op_DeleteVocabulary.go +++ b/service/connect/api_op_DeleteVocabulary.go @@ -29,8 +29,7 @@ func (c *Client) DeleteVocabulary(ctx context.Context, params *DeleteVocabularyI type DeleteVocabularyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeAgentStatus.go b/service/connect/api_op_DescribeAgentStatus.go index 0188646dc3c..2d9e0982ad2 100644 --- a/service/connect/api_op_DescribeAgentStatus.go +++ b/service/connect/api_op_DescribeAgentStatus.go @@ -35,8 +35,7 @@ type DescribeAgentStatusInput struct { // This member is required. AgentStatusId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeContact.go b/service/connect/api_op_DescribeContact.go index c4c05933160..a4294e0c546 100644 --- a/service/connect/api_op_DescribeContact.go +++ b/service/connect/api_op_DescribeContact.go @@ -37,8 +37,7 @@ type DescribeContactInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeContactFlow.go b/service/connect/api_op_DescribeContactFlow.go index 09a7346d0e0..b76d8e7cad7 100644 --- a/service/connect/api_op_DescribeContactFlow.go +++ b/service/connect/api_op_DescribeContactFlow.go @@ -12,8 +12,8 @@ import ( ) // Describes the specified flow. You can also create and update flows using the -// Amazon Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). +// Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . func (c *Client) DescribeContactFlow(ctx context.Context, params *DescribeContactFlowInput, optFns ...func(*Options)) (*DescribeContactFlowOutput, error) { if params == nil { params = &DescribeContactFlowInput{} diff --git a/service/connect/api_op_DescribeContactFlowModule.go b/service/connect/api_op_DescribeContactFlowModule.go index 54b0286e211..9bc81124441 100644 --- a/service/connect/api_op_DescribeContactFlowModule.go +++ b/service/connect/api_op_DescribeContactFlowModule.go @@ -34,8 +34,7 @@ type DescribeContactFlowModuleInput struct { // This member is required. ContactFlowModuleId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeHoursOfOperation.go b/service/connect/api_op_DescribeHoursOfOperation.go index c0c56f051e8..4c368f2ffc7 100644 --- a/service/connect/api_op_DescribeHoursOfOperation.go +++ b/service/connect/api_op_DescribeHoursOfOperation.go @@ -35,8 +35,7 @@ type DescribeHoursOfOperationInput struct { // This member is required. HoursOfOperationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeInstance.go b/service/connect/api_op_DescribeInstance.go index b7ee5dfe6cd..aa70f3ad350 100644 --- a/service/connect/api_op_DescribeInstance.go +++ b/service/connect/api_op_DescribeInstance.go @@ -34,8 +34,7 @@ func (c *Client) DescribeInstance(ctx context.Context, params *DescribeInstanceI type DescribeInstanceInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeInstanceAttribute.go b/service/connect/api_op_DescribeInstanceAttribute.go index d2a149cf84d..9170d6ea514 100644 --- a/service/connect/api_op_DescribeInstanceAttribute.go +++ b/service/connect/api_op_DescribeInstanceAttribute.go @@ -35,8 +35,7 @@ type DescribeInstanceAttributeInput struct { // This member is required. AttributeType types.InstanceAttributeType - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeInstanceStorageConfig.go b/service/connect/api_op_DescribeInstanceStorageConfig.go index d1b01773e22..832d040162c 100644 --- a/service/connect/api_op_DescribeInstanceStorageConfig.go +++ b/service/connect/api_op_DescribeInstanceStorageConfig.go @@ -37,8 +37,7 @@ type DescribeInstanceStorageConfigInput struct { // This member is required. AssociationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribePhoneNumber.go b/service/connect/api_op_DescribePhoneNumber.go index c23189caff1..708fde9e4cc 100644 --- a/service/connect/api_op_DescribePhoneNumber.go +++ b/service/connect/api_op_DescribePhoneNumber.go @@ -19,7 +19,7 @@ import ( // number is claimed to a traffic distribution group and you are calling this API // in the alternate Amazon Web Services Region associated with the traffic // distribution group, you must provide a full phone number ARN. If a UUID is -// provided in this scenario, you will receive a ResourceNotFoundException. +// provided in this scenario, you will receive a ResourceNotFoundException . func (c *Client) DescribePhoneNumber(ctx context.Context, params *DescribePhoneNumberInput, optFns ...func(*Options)) (*DescribePhoneNumberOutput, error) { if params == nil { params = &DescribePhoneNumberInput{} diff --git a/service/connect/api_op_DescribeQueue.go b/service/connect/api_op_DescribeQueue.go index 5f68acbe1c4..abe0869e0de 100644 --- a/service/connect/api_op_DescribeQueue.go +++ b/service/connect/api_op_DescribeQueue.go @@ -30,8 +30,7 @@ func (c *Client) DescribeQueue(ctx context.Context, params *DescribeQueueInput, type DescribeQueueInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeQuickConnect.go b/service/connect/api_op_DescribeQuickConnect.go index 4d228f90d9a..f0c18134c0c 100644 --- a/service/connect/api_op_DescribeQuickConnect.go +++ b/service/connect/api_op_DescribeQuickConnect.go @@ -29,8 +29,7 @@ func (c *Client) DescribeQuickConnect(ctx context.Context, params *DescribeQuick type DescribeQuickConnectInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeRoutingProfile.go b/service/connect/api_op_DescribeRoutingProfile.go index a192494e1ae..9369bb1b8aa 100644 --- a/service/connect/api_op_DescribeRoutingProfile.go +++ b/service/connect/api_op_DescribeRoutingProfile.go @@ -29,8 +29,7 @@ func (c *Client) DescribeRoutingProfile(ctx context.Context, params *DescribeRou type DescribeRoutingProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeRule.go b/service/connect/api_op_DescribeRule.go index 3ef9f61816e..58c00c212a6 100644 --- a/service/connect/api_op_DescribeRule.go +++ b/service/connect/api_op_DescribeRule.go @@ -29,8 +29,7 @@ func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, op type DescribeRuleInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeSecurityProfile.go b/service/connect/api_op_DescribeSecurityProfile.go index ebb6f5ec182..bd0c49fe887 100644 --- a/service/connect/api_op_DescribeSecurityProfile.go +++ b/service/connect/api_op_DescribeSecurityProfile.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release for Amazon Connect and is subject to change. Gets -// basic information about the security profle. +// This API is in preview release for Amazon Connect and is subject to change. +// Gets basic information about the security profle. func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSecurityProfileInput, optFns ...func(*Options)) (*DescribeSecurityProfileOutput, error) { if params == nil { params = &DescribeSecurityProfileInput{} @@ -30,8 +30,7 @@ func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSe type DescribeSecurityProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeUser.go b/service/connect/api_op_DescribeUser.go index eaa6a19589c..dae9cb27252 100644 --- a/service/connect/api_op_DescribeUser.go +++ b/service/connect/api_op_DescribeUser.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified user account. You can find the instance ID in the Amazon -// Connect console -// (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) +// Describes the specified user account. You can find the instance ID in the +// Amazon Connect console (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // (it’s the final part of the ARN). The console does not display the user IDs. // Instead, list the users and note the IDs provided in the output. func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error) { @@ -33,8 +32,7 @@ func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, op type DescribeUserInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeUserHierarchyGroup.go b/service/connect/api_op_DescribeUserHierarchyGroup.go index 0ff99407a78..ea513ec3d87 100644 --- a/service/connect/api_op_DescribeUserHierarchyGroup.go +++ b/service/connect/api_op_DescribeUserHierarchyGroup.go @@ -34,8 +34,7 @@ type DescribeUserHierarchyGroupInput struct { // This member is required. HierarchyGroupId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeUserHierarchyStructure.go b/service/connect/api_op_DescribeUserHierarchyStructure.go index 0c1d9f23ae3..7aaf03a97b3 100644 --- a/service/connect/api_op_DescribeUserHierarchyStructure.go +++ b/service/connect/api_op_DescribeUserHierarchyStructure.go @@ -29,8 +29,7 @@ func (c *Client) DescribeUserHierarchyStructure(ctx context.Context, params *Des type DescribeUserHierarchyStructureInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DescribeVocabulary.go b/service/connect/api_op_DescribeVocabulary.go index 3c39108c2e7..4aa9a78c369 100644 --- a/service/connect/api_op_DescribeVocabulary.go +++ b/service/connect/api_op_DescribeVocabulary.go @@ -29,8 +29,7 @@ func (c *Client) DescribeVocabulary(ctx context.Context, params *DescribeVocabul type DescribeVocabularyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateApprovedOrigin.go b/service/connect/api_op_DisassociateApprovedOrigin.go index 04f7f2dcca6..e0a9fac889e 100644 --- a/service/connect/api_op_DisassociateApprovedOrigin.go +++ b/service/connect/api_op_DisassociateApprovedOrigin.go @@ -29,8 +29,7 @@ func (c *Client) DisassociateApprovedOrigin(ctx context.Context, params *Disasso type DisassociateApprovedOriginInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateBot.go b/service/connect/api_op_DisassociateBot.go index acd7b154a3b..2ef8e7786d8 100644 --- a/service/connect/api_op_DisassociateBot.go +++ b/service/connect/api_op_DisassociateBot.go @@ -31,8 +31,7 @@ func (c *Client) DisassociateBot(ctx context.Context, params *DisassociateBotInp type DisassociateBotInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateInstanceStorageConfig.go b/service/connect/api_op_DisassociateInstanceStorageConfig.go index 4d9b47d225e..985ab671ee0 100644 --- a/service/connect/api_op_DisassociateInstanceStorageConfig.go +++ b/service/connect/api_op_DisassociateInstanceStorageConfig.go @@ -37,8 +37,7 @@ type DisassociateInstanceStorageConfigInput struct { // This member is required. AssociationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateLambdaFunction.go b/service/connect/api_op_DisassociateLambdaFunction.go index 08fe32f186d..ec08248ffe6 100644 --- a/service/connect/api_op_DisassociateLambdaFunction.go +++ b/service/connect/api_op_DisassociateLambdaFunction.go @@ -35,8 +35,7 @@ type DisassociateLambdaFunctionInput struct { // This member is required. FunctionArn *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance.. // // This member is required. diff --git a/service/connect/api_op_DisassociateLexBot.go b/service/connect/api_op_DisassociateLexBot.go index 960683131f1..045311b8246 100644 --- a/service/connect/api_op_DisassociateLexBot.go +++ b/service/connect/api_op_DisassociateLexBot.go @@ -35,8 +35,7 @@ type DisassociateLexBotInput struct { // This member is required. BotName *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociatePhoneNumberContactFlow.go b/service/connect/api_op_DisassociatePhoneNumberContactFlow.go index a7982a60ec9..e64ae62044e 100644 --- a/service/connect/api_op_DisassociatePhoneNumberContactFlow.go +++ b/service/connect/api_op_DisassociatePhoneNumberContactFlow.go @@ -18,7 +18,7 @@ import ( // number is claimed to a traffic distribution group and you are calling this API // using an instance in the alternate Amazon Web Services Region associated with // the traffic distribution group, you must provide a full phone number ARN. If a -// UUID is provided in this scenario, you will receive a ResourceNotFoundException. +// UUID is provided in this scenario, you will receive a ResourceNotFoundException . func (c *Client) DisassociatePhoneNumberContactFlow(ctx context.Context, params *DisassociatePhoneNumberContactFlowInput, optFns ...func(*Options)) (*DisassociatePhoneNumberContactFlowOutput, error) { if params == nil { params = &DisassociatePhoneNumberContactFlowInput{} @@ -36,8 +36,7 @@ func (c *Client) DisassociatePhoneNumberContactFlow(ctx context.Context, params type DisassociatePhoneNumberContactFlowInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateQueueQuickConnects.go b/service/connect/api_op_DisassociateQueueQuickConnects.go index a89b98fd31e..8b3abd6ab01 100644 --- a/service/connect/api_op_DisassociateQueueQuickConnects.go +++ b/service/connect/api_op_DisassociateQueueQuickConnects.go @@ -29,8 +29,7 @@ func (c *Client) DisassociateQueueQuickConnects(ctx context.Context, params *Dis type DisassociateQueueQuickConnectsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateRoutingProfileQueues.go b/service/connect/api_op_DisassociateRoutingProfileQueues.go index 4e84e483ee2..f47f02ae8fa 100644 --- a/service/connect/api_op_DisassociateRoutingProfileQueues.go +++ b/service/connect/api_op_DisassociateRoutingProfileQueues.go @@ -29,8 +29,7 @@ func (c *Client) DisassociateRoutingProfileQueues(ctx context.Context, params *D type DisassociateRoutingProfileQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DisassociateSecurityKey.go b/service/connect/api_op_DisassociateSecurityKey.go index db99477771a..6293c9a8998 100644 --- a/service/connect/api_op_DisassociateSecurityKey.go +++ b/service/connect/api_op_DisassociateSecurityKey.go @@ -35,8 +35,7 @@ type DisassociateSecurityKeyInput struct { // This member is required. AssociationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_DismissUserContact.go b/service/connect/api_op_DismissUserContact.go index 6d78495eb46..833c2fefbf5 100644 --- a/service/connect/api_op_DismissUserContact.go +++ b/service/connect/api_op_DismissUserContact.go @@ -12,9 +12,9 @@ import ( // Dismisses contacts from an agent’s CCP and returns the agent to an available // state, which allows the agent to receive a new routed contact. Contacts can only -// be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the -// Agent Event Stream -// (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html). +// be dismissed if they are in a MISSED , ERROR , ENDED , or REJECTED state in the +// Agent Event Stream (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) +// . func (c *Client) DismissUserContact(ctx context.Context, params *DismissUserContactInput, optFns ...func(*Options)) (*DismissUserContactOutput, error) { if params == nil { params = &DismissUserContactInput{} diff --git a/service/connect/api_op_GetCurrentMetricData.go b/service/connect/api_op_GetCurrentMetricData.go index 518d787c2fc..30b584aa89c 100644 --- a/service/connect/api_op_GetCurrentMetricData.go +++ b/service/connect/api_op_GetCurrentMetricData.go @@ -13,9 +13,8 @@ import ( "time" ) -// Gets the real-time metric data from the specified Amazon Connect instance. For a -// description of each metric, see Real-time Metrics Definitions -// (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) +// Gets the real-time metric data from the specified Amazon Connect instance. For +// a description of each metric, see Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) // in the Amazon Connect Administrator Guide. func (c *Client) GetCurrentMetricData(ctx context.Context, params *GetCurrentMetricDataInput, optFns ...func(*Options)) (*GetCurrentMetricDataOutput, error) { if params == nil { @@ -36,85 +35,60 @@ type GetCurrentMetricDataInput struct { // The metrics to retrieve. Specify the name and unit for each metric. The // following metrics are available. For a description of all the metrics, see - // Real-time Metrics Definitions - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) + // Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) // in the Amazon Connect Administrator Guide. AGENTS_AFTER_CONTACT_WORK Unit: COUNT - // Name in real-time metrics report: ACW - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time) - // AGENTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Available - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time) - // AGENTS_ERROR Unit: COUNT Name in real-time metrics report: Error - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time) + // Name in real-time metrics report: ACW (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time) + // AGENTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Available (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time) + // AGENTS_ERROR Unit: COUNT Name in real-time metrics report: Error (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time) // AGENTS_NON_PRODUCTIVE Unit: COUNT Name in real-time metrics report: NPT - // (Non-Productive Time) - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time) - // AGENTS_ON_CALL Unit: COUNT Name in real-time metrics report: On contact - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) - // AGENTS_ON_CONTACT Unit: COUNT Name in real-time metrics report: On contact - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) - // AGENTS_ONLINE Unit: COUNT Name in real-time metrics report: Online - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time) - // AGENTS_STAFFED Unit: COUNT Name in real-time metrics report: Staffed - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time) - // CONTACTS_IN_QUEUE Unit: COUNT Name in real-time metrics report: In queue - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time) - // CONTACTS_SCHEDULED Unit: COUNT Name in real-time metrics report: Scheduled - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time) + // (Non-Productive Time) (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time) + // AGENTS_ON_CALL Unit: COUNT Name in real-time metrics report: On contact (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) + // AGENTS_ON_CONTACT Unit: COUNT Name in real-time metrics report: On contact (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) + // AGENTS_ONLINE Unit: COUNT Name in real-time metrics report: Online (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time) + // AGENTS_STAFFED Unit: COUNT Name in real-time metrics report: Staffed (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time) + // CONTACTS_IN_QUEUE Unit: COUNT Name in real-time metrics report: In queue (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time) + // CONTACTS_SCHEDULED Unit: COUNT Name in real-time metrics report: Scheduled (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time) // OLDEST_CONTACT_AGE Unit: SECONDS When you use groupings, Unit says SECONDS and // the Value is returned in SECONDS. When you do not use groupings, Unit says // SECONDS but the Value is returned in MILLISECONDS. For example, if you get a // response like this: { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": // "SECONDS" }, "Value": 24113.0 } The actual OLDEST_CONTACT_AGE is 24 seconds. - // Name in real-time metrics report: Oldest - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time) - // SLOTS_ACTIVE Unit: COUNT Name in real-time metrics report: Active - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time) - // SLOTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Availability - // (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time) + // Name in real-time metrics report: Oldest (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time) + // SLOTS_ACTIVE Unit: COUNT Name in real-time metrics report: Active (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time) + // SLOTS_AVAILABLE Unit: COUNT Name in real-time metrics report: Availability (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time) // // This member is required. CurrentMetrics []types.CurrentMetric // The filters to apply to returned metrics. You can filter up to the following // limits: - // - // * Queues: 100 - // - // * Routing profiles: 100 - // - // * Channels: 3 (VOICE, CHAT, and - // TASK channels are supported.) - // - // Metric data is retrieved only for the resources - // associated with the queues or routing profiles, and by any channels included in - // the filter. (You cannot filter by both queue AND routing profile.) You can - // include both resource IDs and resource ARNs in the same request. Currently - // tagging is only supported on the resources that are passed in the filter. + // - Queues: 100 + // - Routing profiles: 100 + // - Channels: 3 (VOICE, CHAT, and TASK channels are supported.) + // Metric data is retrieved only for the resources associated with the queues or + // routing profiles, and by any channels included in the filter. (You cannot filter + // by both queue AND routing profile.) You can include both resource IDs and + // resource ARNs in the same request. Currently tagging is only supported on the + // resources that are passed in the filter. // // This member is required. Filters *types.Filters - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string - // The grouping applied to the metrics returned. For example, when grouped by - // QUEUE, the metrics returned apply to each queue rather than aggregated for all + // The grouping applied to the metrics returned. For example, when grouped by QUEUE + // , the metrics returned apply to each queue rather than aggregated for all // queues. - // - // * If you group by CHANNEL, you should include a Channels filter. VOICE, - // CHAT, and TASK channels are supported. - // - // * If you group by ROUTING_PROFILE, you - // must include either a queue or routing profile filter. In addition, a routing - // profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, - // and OLDEST_CONTACT_AGE. - // - // * If no Grouping is included in the request, a summary - // of metrics is returned. + // - If you group by CHANNEL , you should include a Channels filter. VOICE, CHAT, + // and TASK channels are supported. + // - If you group by ROUTING_PROFILE , you must include either a queue or routing + // profile filter. In addition, a routing profile filter is required for metrics + // CONTACTS_SCHEDULED , CONTACTS_IN_QUEUE , and OLDEST_CONTACT_AGE . + // - If no Grouping is included in the request, a summary of metrics is returned. Groupings []types.Grouping // The maximum number of results to return per page. @@ -128,11 +102,9 @@ type GetCurrentMetricDataInput struct { NextToken *string // The way to sort the resulting response based on metrics. You can enter one sort - // criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. - // The metric collection is sorted based on the input metrics. Note the - // following: - // - // * Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported. + // criteria. By default resources are sorted based on AGENTS_ONLINE , DESCENDING . + // The metric collection is sorted based on the input metrics. Note the following: + // - Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported. SortCriteria []types.CurrentMetricSortCriteria noSmithyDocumentSerde diff --git a/service/connect/api_op_GetCurrentUserData.go b/service/connect/api_op_GetCurrentUserData.go index 4c4b1f7d067..50c295b2cf7 100644 --- a/service/connect/api_op_GetCurrentUserData.go +++ b/service/connect/api_op_GetCurrentUserData.go @@ -32,28 +32,20 @@ type GetCurrentUserDataInput struct { // The filters to apply to returned user data. You can filter up to the following // limits: - // - // * Queues: 100 - // - // * Routing profiles: 100 - // - // * Agents: 100 - // - // * Contact - // states: 9 - // - // * User hierarchy groups: 1 - // - // The user data is retrieved for only the - // specified values/resources in the filter. A maximum of one filter can be passed - // from queues, routing profiles, agents, and user hierarchy groups. Currently - // tagging is only supported on the resources that are passed in the filter. + // - Queues: 100 + // - Routing profiles: 100 + // - Agents: 100 + // - Contact states: 9 + // - User hierarchy groups: 1 + // The user data is retrieved for only the specified values/resources in the + // filter. A maximum of one filter can be passed from queues, routing profiles, + // agents, and user hierarchy groups. Currently tagging is only supported on the + // resources that are passed in the filter. // // This member is required. Filters *types.UserDataFilters - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_GetFederationToken.go b/service/connect/api_op_GetFederationToken.go index a9f4d52802b..6dbe10824f6 100644 --- a/service/connect/api_op_GetFederationToken.go +++ b/service/connect/api_op_GetFederationToken.go @@ -32,8 +32,7 @@ func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTo type GetFederationTokenInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_GetMetricData.go b/service/connect/api_op_GetMetricData.go index 2445abbd0ff..c0fbf56ac75 100644 --- a/service/connect/api_op_GetMetricData.go +++ b/service/connect/api_op_GetMetricData.go @@ -14,8 +14,7 @@ import ( ) // Gets historical metric data from the specified Amazon Connect instance. For a -// description of each historical metric, see Historical Metrics Definitions -// (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) +// description of each historical metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) // in the Amazon Connect Administrator Guide. func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error) { if params == nil { @@ -34,11 +33,11 @@ func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, type GetMetricDataInput struct { - // The timestamp, in UNIX Epoch time format, at which to end the reporting interval - // for the retrieval of historical metrics data. The time must be specified using - // an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than - // the start time timestamp. The time range between the start and end time must be - // less than 24 hours. + // The timestamp, in UNIX Epoch time format, at which to end the reporting + // interval for the retrieval of historical metrics data. The time must be + // specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must + // be later than the start time timestamp. The time range between the start and end + // time must be less than 24 hours. // // This member is required. EndTime *time.Time @@ -47,15 +46,14 @@ type GetMetricDataInput struct { // Metric data is retrieved only for the resources associated with the queues or // channels included in the filter. You can include both queue IDs and queue ARNs // in the same request. VOICE, CHAT, and TASK channels are supported. To filter by - // Queues, enter the queue ID/ARN, not the name of the queue. + // Queues , enter the queue ID/ARN, not the name of the queue. // // This member is required. Filters *types.Filters // The metrics to retrieve. Specify the name, unit, and statistic for each metric. // The following historical metrics are available. For a description of each - // metric, see Historical Metrics Definitions - // (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) + // metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) // in the Amazon Connect Administrator Guide. This API does not support a contacts // incoming metric (there's no CONTACTS_INCOMING metric missing from the documented // list). ABANDON_TIME Unit: SECONDS Statistic: AVG AFTER_CONTACT_WORK_TIME Unit: @@ -75,15 +73,14 @@ type GetMetricDataInput struct { // SECONDS Statistic: AVG OCCUPANCY Unit: PERCENT Statistic: AVG QUEUE_ANSWER_TIME // Unit: SECONDS Statistic: AVG QUEUED_TIME Unit: SECONDS Statistic: MAX // SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: - // PERCENT Statistic: AVG Threshold: For ThresholdValue, enter any whole number - // from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for - // "Less than"). + // PERCENT Statistic: AVG Threshold: For ThresholdValue , enter any whole number + // from 1 to 604800 (inclusive), in seconds. For Comparison , you must enter LT + // (for "Less than"). // // This member is required. HistoricalMetrics []types.HistoricalMetric - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -116,8 +113,8 @@ type GetMetricDataInput struct { type GetMetricDataOutput struct { - // Information about the historical metrics. If no grouping is specified, a summary - // of metric data is returned. + // Information about the historical metrics. If no grouping is specified, a + // summary of metric data is returned. MetricResults []types.HistoricalMetricResult // If there are additional results, this is the token for the next set of results. diff --git a/service/connect/api_op_GetMetricDataV2.go b/service/connect/api_op_GetMetricDataV2.go index 569c8832c6d..0ff3a228bb0 100644 --- a/service/connect/api_op_GetMetricDataV2.go +++ b/service/connect/api_op_GetMetricDataV2.go @@ -14,15 +14,13 @@ import ( ) // Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 -// offers more features than GetMetricData -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html), -// the previous version of this API. It has new metrics, offers filtering at a +// offers more features than GetMetricData (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html) +// , the previous version of this API. It has new metrics, offers filtering at a // metric level, and offers the ability to filter and group data by channels, // queues, routing profiles, agents, and agent hierarchy levels. It can retrieve // historical data for the last 14 days, in 24-hour intervals. For a description of -// the historical metrics that are supported by GetMetricDataV2 and GetMetricData, -// see Historical metrics definitions -// (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) +// the historical metrics that are supported by GetMetricDataV2 and GetMetricData , +// see Historical metrics definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) // in the Amazon Connect Administrator's Guide. This API is not available in the // Amazon Web Services GovCloud (US) Regions. func (c *Client) GetMetricDataV2(ctx context.Context, params *GetMetricDataV2Input, optFns ...func(*Options)) (*GetMetricDataV2Output, error) { @@ -42,77 +40,62 @@ func (c *Client) GetMetricDataV2(ctx context.Context, params *GetMetricDataV2Inp type GetMetricDataV2Input struct { - // The timestamp, in UNIX Epoch time format, at which to end the reporting interval - // for the retrieval of historical metrics data. The time must be later than the - // start time timestamp. The time range between the start and end time must be less - // than 24 hours. + // The timestamp, in UNIX Epoch time format, at which to end the reporting + // interval for the retrieval of historical metrics data. The time must be later + // than the start time timestamp. The time range between the start and end time + // must be less than 24 hours. // // This member is required. EndTime *time.Time // The filters to apply to returned metrics. You can filter on the following // resources: - // - // * Queues - // - // * Routing profiles - // - // * Agents - // - // * Channels - // - // * User hierarchy - // groups - // - // At least one filter must be passed from queues, routing profiles, - // agents, or user hierarchy groups. To filter by phone number, see Create a - // historical metrics report - // (https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html) + // - Queues + // - Routing profiles + // - Agents + // - Channels + // - User hierarchy groups + // At least one filter must be passed from queues, routing profiles, agents, or + // user hierarchy groups. To filter by phone number, see Create a historical + // metrics report (https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html) // in the Amazon Connect Administrator's Guide. Note the following limits: - // - // * - // Filter keys: A maximum of 5 filter keys are supported in a single request. Valid - // filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | - // AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | - // AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | - // AGENT_HIERARCHY_LEVEL_FIVE - // - // * Filter values: A maximum of 100 filter values are - // supported in a single request. For example, a GetMetricDataV2 request can filter - // by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter - // values. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. + // - Filter keys: A maximum of 5 filter keys are supported in a single request. + // Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | + // AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | + // AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | + // AGENT_HIERARCHY_LEVEL_FIVE + // - Filter values: A maximum of 100 filter values are supported in a single + // request. For example, a GetMetricDataV2 request can filter by 50 queues, 35 + // agents, and 15 routing profiles for a total of 100 filter values. VOICE , CHAT + // , and TASK are valid filterValue for the CHANNEL filter key. // // This member is required. Filters []types.FilterV2 // The metrics to retrieve. Specify the name, groupings, and filters for each // metric. The following historical metrics are available. For a description of - // each metric, see Historical metrics definitions - // (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) + // each metric, see Historical metrics definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) // in the Amazon Connect Administrator's Guide. AGENT_ADHERENT_TIME This metric is // available only in Amazon Web Services Regions where Forecasting, capacity - // planning, and scheduling - // (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) + // planning, and scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) // is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing // Profile, Agent, Agent Hierarchy AGENT_NON_RESPONSE Unit: Count Valid groupings // and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy // AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, // Agent, Agent Hierarchy AGENT_SCHEDULE_ADHERENCE This metric is available only in - // Amazon Web Services Regions where Forecasting, capacity planning, and scheduling - // (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) + // Amazon Web Services Regions where Forecasting, capacity planning, and scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) // is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing // Profile, Agent, Agent Hierarchy AGENT_SCHEDULED_TIME This metric is available // only in Amazon Web Services Regions where Forecasting, capacity planning, and - // scheduling - // (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) + // scheduling (https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) // is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing // Profile, Agent, Agent Hierarchy AVG_ABANDON_TIME Unit: Seconds Valid groupings // and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy // AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, // Channel, Routing Profile, Agent, Agent Hierarchy AVG_AGENT_CONNECTING_TIME Unit: - // Seconds Valid metric filter key: INITIATION_METHOD. For now, this metric only - // supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API - // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Seconds Valid metric filter key: INITIATION_METHOD . For now, this metric only + // supports the following as INITIATION_METHOD : INBOUND | OUTBOUND | CALLBACK | + // API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent // Hierarchy AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, // Channel, Routing Profile, Agent, Agent Hierarchy AVG_HOLD_TIME Unit: Seconds // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent @@ -124,7 +107,7 @@ type GetMetricDataV2Input struct { // and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy // CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid // groupings and filters: Queue, Channel, Routing Profile CONTACTS_HANDLED Unit: - // Count Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON Valid + // Count Valid metric filter key: INITIATION_METHOD , DISCONNECT_REASON Valid // groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy // CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, // Routing Profile, Agent, Agent Hierarchy CONTACTS_QUEUED Unit: Count Valid @@ -138,8 +121,8 @@ type GetMetricDataV2Input struct { // Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, // Agent Hierarchy SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in // a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing - // Profile Threshold: For ThresholdValue, enter any whole number from 1 to 604800 - // (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). + // Profile Threshold: For ThresholdValue , enter any whole number from 1 to 604800 + // (inclusive), in seconds. For Comparison , you must enter LT (for "Less than"). // SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, // Channel, Routing Profile SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings // and filters: Queue, Channel, Routing Profile SUM_CONTACTS_DISCONNECTED Valid @@ -165,11 +148,11 @@ type GetMetricDataV2Input struct { // This member is required. StartTime *time.Time - // The grouping applied to the metrics that are returned. For example, when results - // are grouped by queue, the metrics returned are grouped by queue. The values that - // are returned apply to the metrics for each queue. They are not aggregated for - // all queues. If no grouping is specified, a summary of all metrics is returned. - // Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | + // The grouping applied to the metrics that are returned. For example, when + // results are grouped by queue, the metrics returned are grouped by queue. The + // values that are returned apply to the metrics for each queue. They are not + // aggregated for all queues. If no grouping is specified, a summary of all metrics + // is returned. Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | // AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | // AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | // AGENT_HIERARCHY_LEVEL_FIVE diff --git a/service/connect/api_op_GetTaskTemplate.go b/service/connect/api_op_GetTaskTemplate.go index 885b0db20cf..8ccc4b8bd04 100644 --- a/service/connect/api_op_GetTaskTemplate.go +++ b/service/connect/api_op_GetTaskTemplate.go @@ -31,8 +31,7 @@ func (c *Client) GetTaskTemplate(ctx context.Context, params *GetTaskTemplateInp type GetTaskTemplateInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -87,17 +86,16 @@ type GetTaskTemplateOutput struct { // Fields that are part of the template. Fields []types.TaskTemplateField - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string // The timestamp when the task template was last modified. LastModifiedTime *time.Time - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status types.TaskTemplateStatus // The tags used to organize, track, or control access for this resource. For diff --git a/service/connect/api_op_ListAgentStatuses.go b/service/connect/api_op_ListAgentStatuses.go index 8bbba670461..33827ae4a14 100644 --- a/service/connect/api_op_ListAgentStatuses.go +++ b/service/connect/api_op_ListAgentStatuses.go @@ -31,8 +31,7 @@ func (c *Client) ListAgentStatuses(ctx context.Context, params *ListAgentStatuse type ListAgentStatusesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListApprovedOrigins.go b/service/connect/api_op_ListApprovedOrigins.go index 4526caf0289..368d8a41453 100644 --- a/service/connect/api_op_ListApprovedOrigins.go +++ b/service/connect/api_op_ListApprovedOrigins.go @@ -30,8 +30,7 @@ func (c *Client) ListApprovedOrigins(ctx context.Context, params *ListApprovedOr type ListApprovedOriginsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -124,8 +123,8 @@ func (c *Client) addOperationListApprovedOriginsMiddlewares(stack *middleware.St return nil } -// ListApprovedOriginsAPIClient is a client that implements the ListApprovedOrigins -// operation. +// ListApprovedOriginsAPIClient is a client that implements the +// ListApprovedOrigins operation. type ListApprovedOriginsAPIClient interface { ListApprovedOrigins(context.Context, *ListApprovedOriginsInput, ...func(*Options)) (*ListApprovedOriginsOutput, error) } diff --git a/service/connect/api_op_ListBots.go b/service/connect/api_op_ListBots.go index 9afd23ad5c9..da7767126e0 100644 --- a/service/connect/api_op_ListBots.go +++ b/service/connect/api_op_ListBots.go @@ -33,8 +33,7 @@ func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ... type ListBotsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListContactFlowModules.go b/service/connect/api_op_ListContactFlowModules.go index 1a3e3fa3b44..b1a56d991cf 100644 --- a/service/connect/api_op_ListContactFlowModules.go +++ b/service/connect/api_op_ListContactFlowModules.go @@ -31,8 +31,7 @@ func (c *Client) ListContactFlowModules(ctx context.Context, params *ListContact type ListContactFlowModulesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListContactFlows.go b/service/connect/api_op_ListContactFlows.go index 426abd92ae8..57001b05cbd 100644 --- a/service/connect/api_op_ListContactFlows.go +++ b/service/connect/api_op_ListContactFlows.go @@ -13,10 +13,8 @@ import ( ) // Provides information about the flows for the specified Amazon Connect instance. -// You can also create and update flows using the Amazon Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). -// For more information about flows, see Flows -// (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) +// You can also create and update flows using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . For more information about flows, see Flows (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListContactFlows(ctx context.Context, params *ListContactFlowsInput, optFns ...func(*Options)) (*ListContactFlowsOutput, error) { if params == nil { @@ -35,8 +33,7 @@ func (c *Client) ListContactFlows(ctx context.Context, params *ListContactFlowsI type ListContactFlowsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListContactReferences.go b/service/connect/api_op_ListContactReferences.go index 0ab4c4a7541..d22b452a443 100644 --- a/service/connect/api_op_ListContactReferences.go +++ b/service/connect/api_op_ListContactReferences.go @@ -13,7 +13,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. For -// the specified referenceTypes, returns a list of references associated with the +// the specified referenceTypes , returns a list of references associated with the // contact. func (c *Client) ListContactReferences(ctx context.Context, params *ListContactReferencesInput, optFns ...func(*Options)) (*ListContactReferencesOutput, error) { if params == nil { @@ -37,8 +37,7 @@ type ListContactReferencesInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListDefaultVocabularies.go b/service/connect/api_op_ListDefaultVocabularies.go index e0ea54dd37e..c3cb74cc704 100644 --- a/service/connect/api_op_ListDefaultVocabularies.go +++ b/service/connect/api_op_ListDefaultVocabularies.go @@ -30,16 +30,14 @@ func (c *Client) ListDefaultVocabularies(ctx context.Context, params *ListDefaul type ListDefaultVocabulariesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) LanguageCode types.VocabularyLanguageCode // The maximum number of results to return per page. diff --git a/service/connect/api_op_ListHoursOfOperations.go b/service/connect/api_op_ListHoursOfOperations.go index ca8451aa6a4..a7a97ab7af1 100644 --- a/service/connect/api_op_ListHoursOfOperations.go +++ b/service/connect/api_op_ListHoursOfOperations.go @@ -14,8 +14,7 @@ import ( // Provides information about the hours of operation for the specified Amazon // Connect instance. For more information about hours of operation, see Set the -// Hours of Operation for a Queue -// (https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) +// Hours of Operation for a Queue (https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListHoursOfOperations(ctx context.Context, params *ListHoursOfOperationsInput, optFns ...func(*Options)) (*ListHoursOfOperationsOutput, error) { if params == nil { @@ -34,8 +33,7 @@ func (c *Client) ListHoursOfOperations(ctx context.Context, params *ListHoursOfO type ListHoursOfOperationsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListInstanceAttributes.go b/service/connect/api_op_ListInstanceAttributes.go index 7fe3a6669d9..d564629f712 100644 --- a/service/connect/api_op_ListInstanceAttributes.go +++ b/service/connect/api_op_ListInstanceAttributes.go @@ -31,8 +31,7 @@ func (c *Client) ListInstanceAttributes(ctx context.Context, params *ListInstanc type ListInstanceAttributesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListInstanceStorageConfigs.go b/service/connect/api_op_ListInstanceStorageConfigs.go index 6464949d3ac..0fcfec499a9 100644 --- a/service/connect/api_op_ListInstanceStorageConfigs.go +++ b/service/connect/api_op_ListInstanceStorageConfigs.go @@ -32,8 +32,7 @@ func (c *Client) ListInstanceStorageConfigs(ctx context.Context, params *ListIns type ListInstanceStorageConfigsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListIntegrationAssociations.go b/service/connect/api_op_ListIntegrationAssociations.go index 90496c8a7b4..e2655673c75 100644 --- a/service/connect/api_op_ListIntegrationAssociations.go +++ b/service/connect/api_op_ListIntegrationAssociations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides summary information about the Amazon Web Services resource associations -// for the specified Amazon Connect instance. +// Provides summary information about the Amazon Web Services resource +// associations for the specified Amazon Connect instance. func (c *Client) ListIntegrationAssociations(ctx context.Context, params *ListIntegrationAssociationsInput, optFns ...func(*Options)) (*ListIntegrationAssociationsOutput, error) { if params == nil { params = &ListIntegrationAssociationsInput{} @@ -31,8 +31,7 @@ func (c *Client) ListIntegrationAssociations(ctx context.Context, params *ListIn type ListIntegrationAssociationsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListLambdaFunctions.go b/service/connect/api_op_ListLambdaFunctions.go index 1d32f2fef7f..0d662c0c767 100644 --- a/service/connect/api_op_ListLambdaFunctions.go +++ b/service/connect/api_op_ListLambdaFunctions.go @@ -31,8 +31,7 @@ func (c *Client) ListLambdaFunctions(ctx context.Context, params *ListLambdaFunc type ListLambdaFunctionsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -125,8 +124,8 @@ func (c *Client) addOperationListLambdaFunctionsMiddlewares(stack *middleware.St return nil } -// ListLambdaFunctionsAPIClient is a client that implements the ListLambdaFunctions -// operation. +// ListLambdaFunctionsAPIClient is a client that implements the +// ListLambdaFunctions operation. type ListLambdaFunctionsAPIClient interface { ListLambdaFunctions(context.Context, *ListLambdaFunctionsInput, ...func(*Options)) (*ListLambdaFunctionsOutput, error) } diff --git a/service/connect/api_op_ListLexBots.go b/service/connect/api_op_ListLexBots.go index 227e55a7bf6..039de3e2a08 100644 --- a/service/connect/api_op_ListLexBots.go +++ b/service/connect/api_op_ListLexBots.go @@ -14,8 +14,8 @@ import ( // This API is in preview release for Amazon Connect and is subject to change. // Returns a paginated list of all the Amazon Lex V1 bots currently associated with -// the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html) API. +// the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html) +// API. func (c *Client) ListLexBots(ctx context.Context, params *ListLexBotsInput, optFns ...func(*Options)) (*ListLexBotsOutput, error) { if params == nil { params = &ListLexBotsInput{} @@ -33,8 +33,7 @@ func (c *Client) ListLexBots(ctx context.Context, params *ListLexBotsInput, optF type ListLexBotsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -53,8 +52,8 @@ type ListLexBotsInput struct { type ListLexBotsOutput struct { - // The names and Amazon Web Services Regions of the Amazon Lex bots associated with - // the specified instance. + // The names and Amazon Web Services Regions of the Amazon Lex bots associated + // with the specified instance. LexBots []types.LexBot // If there are additional results, this is the token for the next set of results. diff --git a/service/connect/api_op_ListPhoneNumbers.go b/service/connect/api_op_ListPhoneNumbers.go index 4dac99a42db..388114da0ec 100644 --- a/service/connect/api_op_ListPhoneNumbers.go +++ b/service/connect/api_op_ListPhoneNumbers.go @@ -13,15 +13,12 @@ import ( ) // Provides information about the phone numbers for the specified Amazon Connect -// instance. For more information about phone numbers, see Set Up Phone Numbers for -// Your Contact Center -// (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) +// instance. For more information about phone numbers, see Set Up Phone Numbers +// for Your Contact Center (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) // in the Amazon Connect Administrator Guide. The phone number Arn value that is -// returned from each of the items in the PhoneNumberSummaryList -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList) +// returned from each of the items in the PhoneNumberSummaryList (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList) // cannot be used to tag phone number resources. It will fail with a -// ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) +// ResourceNotFoundException . Instead, use the ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) // API. It returns the new phone number ARN that can be used to tag phone number // resources. func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error) { @@ -41,8 +38,7 @@ func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersI type ListPhoneNumbersInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListPhoneNumbersV2.go b/service/connect/api_op_ListPhoneNumbersV2.go index 92833db75d2..cbdc6941d4f 100644 --- a/service/connect/api_op_ListPhoneNumbersV2.go +++ b/service/connect/api_op_ListPhoneNumbersV2.go @@ -15,9 +15,8 @@ import ( // Lists phone numbers claimed to your Amazon Connect instance or traffic // distribution group. If the provided TargetArn is a traffic distribution group, // you can call this API in both Amazon Web Services Regions associated with -// traffic distribution group. For more information about phone numbers, see Set Up -// Phone Numbers for Your Contact Center -// (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) +// traffic distribution group. For more information about phone numbers, see Set +// Up Phone Numbers for Your Contact Center (https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListPhoneNumbersV2(ctx context.Context, params *ListPhoneNumbersV2Input, optFns ...func(*Options)) (*ListPhoneNumbersV2Output, error) { if params == nil { @@ -54,8 +53,8 @@ type ListPhoneNumbersV2Input struct { PhoneNumberTypes []types.PhoneNumberType // The Amazon Resource Name (ARN) for Amazon Connect instances or traffic - // distribution groups that phone numbers are claimed to. If TargetArn input is not - // provided, this API lists numbers claimed to all the Amazon Connect instances + // distribution groups that phone numbers are claimed to. If TargetArn input is + // not provided, this API lists numbers claimed to all the Amazon Connect instances // belonging to your account in the same Amazon Web Services Region as the request. TargetArn *string diff --git a/service/connect/api_op_ListQueueQuickConnects.go b/service/connect/api_op_ListQueueQuickConnects.go index ed369ed8744..3c8a208c901 100644 --- a/service/connect/api_op_ListQueueQuickConnects.go +++ b/service/connect/api_op_ListQueueQuickConnects.go @@ -31,8 +31,7 @@ func (c *Client) ListQueueQuickConnects(ctx context.Context, params *ListQueueQu type ListQueueQuickConnectsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListQueues.go b/service/connect/api_op_ListQueues.go index 91025a5b027..a5e907208b8 100644 --- a/service/connect/api_op_ListQueues.go +++ b/service/connect/api_op_ListQueues.go @@ -12,12 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the queues for the specified Amazon Connect instance. -// If you do not specify a QueueTypes parameter, both standard and agent queues are -// returned. This might cause an unexpected truncation of results if you have more -// than 1000 agents and you limit the number of results of the API call in code. -// For more information about queues, see Queues: Standard and Agent -// (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html) +// Provides information about the queues for the specified Amazon Connect +// instance. If you do not specify a QueueTypes parameter, both standard and agent +// queues are returned. This might cause an unexpected truncation of results if you +// have more than 1000 agents and you limit the number of results of the API call +// in code. For more information about queues, see Queues: Standard and Agent (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error) { if params == nil { @@ -36,8 +35,7 @@ func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns type ListQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListQuickConnects.go b/service/connect/api_op_ListQuickConnects.go index 8b5f42e417e..10edcd730cb 100644 --- a/service/connect/api_op_ListQuickConnects.go +++ b/service/connect/api_op_ListQuickConnects.go @@ -31,8 +31,7 @@ func (c *Client) ListQuickConnects(ctx context.Context, params *ListQuickConnect type ListQuickConnectsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListRoutingProfileQueues.go b/service/connect/api_op_ListRoutingProfileQueues.go index 73e204a7a7c..79920d6b347 100644 --- a/service/connect/api_op_ListRoutingProfileQueues.go +++ b/service/connect/api_op_ListRoutingProfileQueues.go @@ -30,8 +30,7 @@ func (c *Client) ListRoutingProfileQueues(ctx context.Context, params *ListRouti type ListRoutingProfileQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListRoutingProfiles.go b/service/connect/api_op_ListRoutingProfiles.go index 6156bb27935..c6a50c2538f 100644 --- a/service/connect/api_op_ListRoutingProfiles.go +++ b/service/connect/api_op_ListRoutingProfiles.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides summary information about the routing profiles for the specified Amazon -// Connect instance. For more information about routing profiles, see Routing -// Profiles -// (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html) -// and Create a Routing Profile -// (https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) in -// the Amazon Connect Administrator Guide. +// Provides summary information about the routing profiles for the specified +// Amazon Connect instance. For more information about routing profiles, see +// Routing Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html) +// and Create a Routing Profile (https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) +// in the Amazon Connect Administrator Guide. func (c *Client) ListRoutingProfiles(ctx context.Context, params *ListRoutingProfilesInput, optFns ...func(*Options)) (*ListRoutingProfilesOutput, error) { if params == nil { params = &ListRoutingProfilesInput{} @@ -36,8 +34,7 @@ func (c *Client) ListRoutingProfiles(ctx context.Context, params *ListRoutingPro type ListRoutingProfilesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -131,8 +128,8 @@ func (c *Client) addOperationListRoutingProfilesMiddlewares(stack *middleware.St return nil } -// ListRoutingProfilesAPIClient is a client that implements the ListRoutingProfiles -// operation. +// ListRoutingProfilesAPIClient is a client that implements the +// ListRoutingProfiles operation. type ListRoutingProfilesAPIClient interface { ListRoutingProfiles(context.Context, *ListRoutingProfilesInput, ...func(*Options)) (*ListRoutingProfilesOutput, error) } diff --git a/service/connect/api_op_ListRules.go b/service/connect/api_op_ListRules.go index 449881549de..74e0a367a58 100644 --- a/service/connect/api_op_ListRules.go +++ b/service/connect/api_op_ListRules.go @@ -30,8 +30,7 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListSecurityKeys.go b/service/connect/api_op_ListSecurityKeys.go index c03db3146d8..af008d91a49 100644 --- a/service/connect/api_op_ListSecurityKeys.go +++ b/service/connect/api_op_ListSecurityKeys.go @@ -31,8 +31,7 @@ func (c *Client) ListSecurityKeys(ctx context.Context, params *ListSecurityKeysI type ListSecurityKeysInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListSecurityProfilePermissions.go b/service/connect/api_op_ListSecurityProfilePermissions.go index fa1625e24e2..cbaa590c230 100644 --- a/service/connect/api_op_ListSecurityProfilePermissions.go +++ b/service/connect/api_op_ListSecurityProfilePermissions.go @@ -30,8 +30,7 @@ func (c *Client) ListSecurityProfilePermissions(ctx context.Context, params *Lis type ListSecurityProfilePermissionsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -58,8 +57,8 @@ type ListSecurityProfilePermissionsOutput struct { NextToken *string // The permissions granted to the security profile. For a complete list of valid - // permissions, see List of security profile permissions - // (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). + // permissions, see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html) + // . Permissions []string // Metadata pertaining to the operation's result. diff --git a/service/connect/api_op_ListSecurityProfiles.go b/service/connect/api_op_ListSecurityProfiles.go index 0fb4d9ed4d1..67cbacfc7b1 100644 --- a/service/connect/api_op_ListSecurityProfiles.go +++ b/service/connect/api_op_ListSecurityProfiles.go @@ -14,8 +14,7 @@ import ( // Provides summary information about the security profiles for the specified // Amazon Connect instance. For more information about security profiles, see -// Security Profiles -// (https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) +// Security Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error) { if params == nil { @@ -34,8 +33,7 @@ func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityP type ListSecurityProfilesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListTagsForResource.go b/service/connect/api_op_ListTagsForResource.go index 27248787a68..640e236c21d 100644 --- a/service/connect/api_op_ListTagsForResource.go +++ b/service/connect/api_op_ListTagsForResource.go @@ -11,8 +11,7 @@ import ( ) // Lists the tags for the specified resource. For sample policies that use tags, -// see Amazon Connect Identity-Based Policy Examples -// (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) +// see Amazon Connect Identity-Based Policy Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) // in the Amazon Connect Administrator Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -33,8 +32,8 @@ type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources // (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN - // for an instance, for example, see Find your Amazon Connect instance ID/ARN - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html). + // for an instance, for example, see Find your Amazon Connect instance ID/ARN (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // . // // This member is required. ResourceArn *string diff --git a/service/connect/api_op_ListTaskTemplates.go b/service/connect/api_op_ListTaskTemplates.go index b3d1f8905f1..221e3af193f 100644 --- a/service/connect/api_op_ListTaskTemplates.go +++ b/service/connect/api_op_ListTaskTemplates.go @@ -30,8 +30,7 @@ func (c *Client) ListTaskTemplates(ctx context.Context, params *ListTaskTemplate type ListTaskTemplatesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -50,9 +49,9 @@ type ListTaskTemplatesInput struct { // is always null. NextToken *string - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status types.TaskTemplateStatus noSmithyDocumentSerde diff --git a/service/connect/api_op_ListTrafficDistributionGroups.go b/service/connect/api_op_ListTrafficDistributionGroups.go index 917742af475..7630174192e 100644 --- a/service/connect/api_op_ListTrafficDistributionGroups.go +++ b/service/connect/api_op_ListTrafficDistributionGroups.go @@ -30,8 +30,7 @@ func (c *Client) ListTrafficDistributionGroups(ctx context.Context, params *List type ListTrafficDistributionGroupsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string diff --git a/service/connect/api_op_ListUseCases.go b/service/connect/api_op_ListUseCases.go index f1e7d9ddff9..ba871d5f09e 100644 --- a/service/connect/api_op_ListUseCases.go +++ b/service/connect/api_op_ListUseCases.go @@ -32,8 +32,7 @@ func (c *Client) ListUseCases(ctx context.Context, params *ListUseCasesInput, op // association. type ListUseCasesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListUserHierarchyGroups.go b/service/connect/api_op_ListUserHierarchyGroups.go index 214aa4fb62c..f0c97d7dd19 100644 --- a/service/connect/api_op_ListUserHierarchyGroups.go +++ b/service/connect/api_op_ListUserHierarchyGroups.go @@ -12,11 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides summary information about the hierarchy groups for the specified Amazon -// Connect instance. For more information about agent hierarchies, see Set Up Agent -// Hierarchies -// (https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in -// the Amazon Connect Administrator Guide. +// Provides summary information about the hierarchy groups for the specified +// Amazon Connect instance. For more information about agent hierarchies, see Set +// Up Agent Hierarchies (https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) +// in the Amazon Connect Administrator Guide. func (c *Client) ListUserHierarchyGroups(ctx context.Context, params *ListUserHierarchyGroupsInput, optFns ...func(*Options)) (*ListUserHierarchyGroupsOutput, error) { if params == nil { params = &ListUserHierarchyGroupsInput{} @@ -34,8 +33,7 @@ func (c *Client) ListUserHierarchyGroups(ctx context.Context, params *ListUserHi type ListUserHierarchyGroupsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ListUsers.go b/service/connect/api_op_ListUsers.go index ace1b6d3a98..3b8e8e1832f 100644 --- a/service/connect/api_op_ListUsers.go +++ b/service/connect/api_op_ListUsers.go @@ -31,8 +31,7 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_MonitorContact.go b/service/connect/api_op_MonitorContact.go index ece0bda3ca4..a70a5a5295b 100644 --- a/service/connect/api_op_MonitorContact.go +++ b/service/connect/api_op_MonitorContact.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the -// user specified by userId will be set to silent monitoring mode on the contact. +// Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of +// the user specified by userId will be set to silent monitoring mode on the +// contact. func (c *Client) MonitorContact(ctx context.Context, params *MonitorContactInput, optFns ...func(*Options)) (*MonitorContactOutput, error) { if params == nil { params = &MonitorContactInput{} @@ -54,8 +55,8 @@ type MonitorContactInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_PutUserStatus.go b/service/connect/api_op_PutUserStatus.go index 207ee924762..51152f3ae3b 100644 --- a/service/connect/api_op_PutUserStatus.go +++ b/service/connect/api_op_PutUserStatus.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the current status of a user or agent in Amazon Connect. If the agent is -// currently handling a contact, this sets the agent's next status. For more -// information, see Agent status -// (https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html) -// and Set your next status -// (https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html) in -// the Amazon Connect Administrator Guide. +// Changes the current status of a user or agent in Amazon Connect. If the agent +// is currently handling a contact, this sets the agent's next status. For more +// information, see Agent status (https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html) +// and Set your next status (https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html) +// in the Amazon Connect Administrator Guide. func (c *Client) PutUserStatus(ctx context.Context, params *PutUserStatusInput, optFns ...func(*Options)) (*PutUserStatusOutput, error) { if params == nil { params = &PutUserStatusInput{} @@ -39,8 +37,7 @@ type PutUserStatusInput struct { // This member is required. AgentStatusId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_ReleasePhoneNumber.go b/service/connect/api_op_ReleasePhoneNumber.go index c7755080909..ada480cee3f 100644 --- a/service/connect/api_op_ReleasePhoneNumber.go +++ b/service/connect/api_op_ReleasePhoneNumber.go @@ -44,8 +44,8 @@ type ReleasePhoneNumberInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ReplicateInstance.go b/service/connect/api_op_ReplicateInstance.go index 2b4907e6b66..c47edb0ffd8 100644 --- a/service/connect/api_op_ReplicateInstance.go +++ b/service/connect/api_op_ReplicateInstance.go @@ -13,8 +13,7 @@ import ( // Replicates an Amazon Connect instance in the specified Amazon Web Services // Region. For more information about replicating an Amazon Connect instance, see -// Create a replica of your existing Amazon Connect instance -// (https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html) +// Create a replica of your existing Amazon Connect instance (https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html) // in the Amazon Connect Administrator Guide. func (c *Client) ReplicateInstance(ctx context.Context, params *ReplicateInstanceInput, optFns ...func(*Options)) (*ReplicateInstanceOutput, error) { if params == nil { @@ -33,10 +32,9 @@ func (c *Client) ReplicateInstance(ctx context.Context, params *ReplicateInstanc type ReplicateInstanceInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. You can provide the - // InstanceId, or the entire ARN. + // InstanceId , or the entire ARN. // // This member is required. InstanceId *string @@ -54,8 +52,8 @@ type ReplicateInstanceInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ResumeContactRecording.go b/service/connect/api_op_ResumeContactRecording.go index 2e500847ba0..00daaf619c0 100644 --- a/service/connect/api_op_ResumeContactRecording.go +++ b/service/connect/api_op_ResumeContactRecording.go @@ -41,8 +41,7 @@ type ResumeContactRecordingInput struct { // This member is required. InitialContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_SearchQueues.go b/service/connect/api_op_SearchQueues.go index e360483fc45..66296a36add 100644 --- a/service/connect/api_op_SearchQueues.go +++ b/service/connect/api_op_SearchQueues.go @@ -31,8 +31,7 @@ func (c *Client) SearchQueues(ctx context.Context, params *SearchQueuesInput, op type SearchQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -45,10 +44,10 @@ type SearchQueuesInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // The search criteria to be used to return queues. The name and description fields - // support "contains" queries with a minimum of 2 characters and a maximum of 25 - // characters. Any queries with character lengths outside of this range will throw - // invalid results. + // The search criteria to be used to return queues. The name and description + // fields support "contains" queries with a minimum of 2 characters and a maximum + // of 25 characters. Any queries with character lengths outside of this range will + // throw invalid results. SearchCriteria *types.QueueSearchCriteria // Filters to be applied to search results. diff --git a/service/connect/api_op_SearchRoutingProfiles.go b/service/connect/api_op_SearchRoutingProfiles.go index 3106343f7ff..f803e4c2432 100644 --- a/service/connect/api_op_SearchRoutingProfiles.go +++ b/service/connect/api_op_SearchRoutingProfiles.go @@ -32,8 +32,7 @@ func (c *Client) SearchRoutingProfiles(ctx context.Context, params *SearchRoutin type SearchRoutingProfilesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_SearchSecurityProfiles.go b/service/connect/api_op_SearchSecurityProfiles.go index 274aeb3e364..9b975cd7442 100644 --- a/service/connect/api_op_SearchSecurityProfiles.go +++ b/service/connect/api_op_SearchSecurityProfiles.go @@ -32,8 +32,7 @@ func (c *Client) SearchSecurityProfiles(ctx context.Context, params *SearchSecur type SearchSecurityProfilesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -49,7 +48,7 @@ type SearchSecurityProfilesInput struct { // The search criteria to be used to return security profiles. The name field // support "contains" queries with a minimum of 2 characters and maximum of 25 // characters. Any queries with character lengths outside of this range will throw - // invalid results. The currently supported value for FieldName: name + // invalid results. The currently supported value for FieldName : name SearchCriteria *types.SecurityProfileSearchCriteria // Filters to be applied to search results. diff --git a/service/connect/api_op_SearchUsers.go b/service/connect/api_op_SearchUsers.go index 019cc4523d7..c56206a9643 100644 --- a/service/connect/api_op_SearchUsers.go +++ b/service/connect/api_op_SearchUsers.go @@ -31,8 +31,7 @@ func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optF type SearchUsersInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string diff --git a/service/connect/api_op_SearchVocabularies.go b/service/connect/api_op_SearchVocabularies.go index f2e51e0e08f..dcdadb6f4a5 100644 --- a/service/connect/api_op_SearchVocabularies.go +++ b/service/connect/api_op_SearchVocabularies.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for vocabularies within a specific Amazon Connect instance using State, -// NameStartsWith, and LanguageCode. +// Searches for vocabularies within a specific Amazon Connect instance using State +// , NameStartsWith , and LanguageCode . func (c *Client) SearchVocabularies(ctx context.Context, params *SearchVocabulariesInput, optFns ...func(*Options)) (*SearchVocabulariesOutput, error) { if params == nil { params = &SearchVocabulariesInput{} @@ -31,16 +31,14 @@ func (c *Client) SearchVocabularies(ctx context.Context, params *SearchVocabular type SearchVocabulariesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) LanguageCode types.VocabularyLanguageCode // The maximum number of results to return per page. diff --git a/service/connect/api_op_StartChatContact.go b/service/connect/api_op_StartChatContact.go index 56c987ad536..f1e1cd8ffe9 100644 --- a/service/connect/api_op_StartChatContact.go +++ b/service/connect/api_op_StartChatContact.go @@ -14,26 +14,20 @@ import ( // Initiates a flow to start a new chat for the customer. Response of this API // provides a token required to obtain credentials from the -// CreateParticipantConnection -// (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) +// CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) // API in the Amazon Connect Participant Service. When a new chat contact is // successfully created, clients must subscribe to the participant’s connection for // the created chat within 5 minutes. This is achieved by invoking -// CreateParticipantConnection -// (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) +// CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) // with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following // situations: +// - API rate limit is exceeded. API TPS throttling returns a TooManyRequests +// exception. +// - The quota for concurrent active chats (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) +// is exceeded. Active chat throttling returns a LimitExceededException . // -// * API rate limit is exceeded. API TPS throttling returns a -// TooManyRequests exception. -// -// * The quota for concurrent active chats -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) -// is exceeded. Active chat throttling returns a LimitExceededException. -// -// If you -// use the ChatDurationInMinutes parameter and receive a 400 error, your account -// may not support the ability to configure custom chat durations. For more +// If you use the ChatDurationInMinutes parameter and receive a 400 error, your +// account may not support the ability to configure custom chat durations. For more // information, contact Amazon Web Services Support. For more information about // chat, see Chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat.html) // in the Amazon Connect Administrator Guide. @@ -64,8 +58,7 @@ type StartChatContactInput struct { // This member is required. ContactFlowId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -83,16 +76,16 @@ type StartChatContactInput struct { // underscore characters. Attributes map[string]string - // The total duration of the newly started chat session. If not specified, the chat - // session duration defaults to 25 hour. The minimum configurable time is 60 + // The total duration of the newly started chat session. If not specified, the + // chat session duration defaults to 25 hour. The minimum configurable time is 60 // minutes. The maximum configurable time is 10,080 minutes (7 days). ChatDurationInMinutes *int32 // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The initial message to be sent to the newly created chat. @@ -100,8 +93,8 @@ type StartChatContactInput struct { // Enable persistent chats. For more information about enabling persistent chat, // and for example use cases and how to configure for them, see Enable persistent - // chat - // (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). + // chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) + // . PersistentChat *types.PersistentChat // The unique identifier for an Amazon Connect contact. This identifier is related @@ -109,18 +102,17 @@ type StartChatContactInput struct { // PersistentChat. RelatedContactId *string - // The supported chat message content types. Supported types are text/plain, - // text/markdown, application/json, - // application/vnd.amazonaws.connect.message.interactive, and - // application/vnd.amazonaws.connect.message.interactive.response. Content types - // must always contain text/plain. You can then put any other supported type in the - // list. For example, all the following lists are valid because they contain - // text/plain: [text/plain, text/markdown, application/json], [text/markdown, - // text/plain], [text/plain, application/json, - // application/vnd.amazonaws.connect.message.interactive.response]. The type + // The supported chat message content types. Supported types are text/plain , + // text/markdown , application/json , + // application/vnd.amazonaws.connect.message.interactive , and + // application/vnd.amazonaws.connect.message.interactive.response . Content types + // must always contain text/plain . You can then put any other supported type in + // the list. For example, all the following lists are valid because they contain + // text/plain : [text/plain, text/markdown, application/json] , [text/markdown, + // text/plain] , [text/plain, application/json, + // application/vnd.amazonaws.connect.message.interactive.response] . The type // application/vnd.amazonaws.connect.message.interactive is required to use the - // Show view - // (https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html) + // Show view (https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html) // flow block. SupportedMessagingContentTypes []string @@ -140,9 +132,8 @@ type StartChatContactOutput struct { // is the same throughout the chat lifecycle. ParticipantId *string - // The token used by the chat participant to call CreateParticipantConnection - // (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html). - // The participant token is valid for the lifetime of a chat participant. + // The token used by the chat participant to call CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) + // . The participant token is valid for the lifetime of a chat participant. ParticipantToken *string // Metadata pertaining to the operation's result. diff --git a/service/connect/api_op_StartContactRecording.go b/service/connect/api_op_StartContactRecording.go index 9b680e8c7f1..ea7c6a22d99 100644 --- a/service/connect/api_op_StartContactRecording.go +++ b/service/connect/api_op_StartContactRecording.go @@ -12,13 +12,10 @@ import ( ) // Starts recording the contact: -// -// * If the API is called before the agent joins the -// call, recording starts when the agent joins the call. -// -// * If the API is called -// after the agent joins the call, recording starts at the time of the API -// call. +// - If the API is called before the agent joins the call, recording starts when +// the agent joins the call. +// - If the API is called after the agent joins the call, recording starts at +// the time of the API call. // // StartContactRecording is a one-time action. For example, if you use // StopContactRecording to stop recording an ongoing call, you can't use @@ -26,8 +23,7 @@ import ( // started and you want to suspend and resume it, such as when collecting sensitive // information (for example, a credit card number), use SuspendContactRecording and // ResumeContactRecording. You can use this API to override the recording behavior -// configured in the Set recording behavior -// (https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html) +// configured in the Set recording behavior (https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html) // block. Only voice recordings are supported at this time. func (c *Client) StartContactRecording(ctx context.Context, params *StartContactRecordingInput, optFns ...func(*Options)) (*StartContactRecordingOutput, error) { if params == nil { @@ -57,8 +53,7 @@ type StartContactRecordingInput struct { // This member is required. InitialContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_StartContactStreaming.go b/service/connect/api_op_StartContactStreaming.go index 83c2941621e..dd8b0cc1636 100644 --- a/service/connect/api_op_StartContactStreaming.go +++ b/service/connect/api_op_StartContactStreaming.go @@ -13,8 +13,7 @@ import ( ) // Initiates real-time message streaming for a new chat contact. For more -// information about message streaming, see Enable real-time chat message streaming -// (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) +// information about message streaming, see Enable real-time chat message streaming (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) // in the Amazon Connect Administrator Guide. func (c *Client) StartContactStreaming(ctx context.Context, params *StartContactStreamingInput, optFns ...func(*Options)) (*StartContactStreamingOutput, error) { if params == nil { @@ -41,8 +40,8 @@ type StartContactStreamingInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . // // This member is required. ClientToken *string @@ -53,8 +52,7 @@ type StartContactStreamingInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_StartOutboundVoiceContact.go b/service/connect/api_op_StartOutboundVoiceContact.go index 4a9a4f2be0b..850a0ff42d8 100644 --- a/service/connect/api_op_StartOutboundVoiceContact.go +++ b/service/connect/api_op_StartOutboundVoiceContact.go @@ -13,19 +13,18 @@ import ( ) // Places an outbound call to a contact, and then initiates the flow. It performs -// the actions in the flow that's specified (in ContactFlowId). Agents do not +// the actions in the flow that's specified (in ContactFlowId ). Agents do not // initiate the outbound API, which means that they do not dial the contact. If the // flow places an outbound call to a contact, and then puts the contact in queue, // the call is then routed to the agent, like any other inbound case. There is a // 60-second dialing timeout for this operation. If the call is not connected after // 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. // Before you can dial these UK mobile numbers, you must submit a service quota -// increase request. For more information, see Amazon Connect Service Quotas -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) +// increase request. For more information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) // in the Amazon Connect Administrator Guide. Campaign calls are not allowed by -// default. Before you can make a call with TrafficType = CAMPAIGN, you must submit -// a service quota increase request to the quota Amazon Connect campaigns -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas). +// default. Before you can make a call with TrafficType = CAMPAIGN , you must +// submit a service quota increase request to the quota Amazon Connect campaigns (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas) +// . func (c *Client) StartOutboundVoiceContact(ctx context.Context, params *StartOutboundVoiceContactInput, optFns ...func(*Options)) (*StartOutboundVoiceContactOutput, error) { if params == nil { params = &StartOutboundVoiceContactInput{} @@ -58,8 +57,7 @@ type StartOutboundVoiceContactInput struct { // This member is required. DestinationPhoneNumber *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -81,9 +79,8 @@ type StartOutboundVoiceContactInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). - // The token is valid for 7 days after creation. If a contact is already started, + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . The token is valid for 7 days after creation. If a contact is already started, // the contact ID is returned. ClientToken *string @@ -98,8 +95,8 @@ type StartOutboundVoiceContactInput struct { SourcePhoneNumber *string // Denotes the class of traffic. Calls with different traffic types are handled - // differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if - // EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL. + // differently by Amazon Connect. The default value is GENERAL . Use CAMPAIGN if + // EnableAnswerMachineDetection is set to true . For all other cases, use GENERAL . TrafficType types.TrafficType noSmithyDocumentSerde diff --git a/service/connect/api_op_StartTaskContact.go b/service/connect/api_op_StartTaskContact.go index c73e0ae8f7d..885711cc4aa 100644 --- a/service/connect/api_op_StartTaskContact.go +++ b/service/connect/api_op_StartTaskContact.go @@ -31,8 +31,7 @@ func (c *Client) StartTaskContact(ctx context.Context, params *StartTaskContactI type StartTaskContactInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -53,20 +52,20 @@ type StartTaskContactInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string - // The identifier of the flow for initiating the tasks. To see the ContactFlowId in - // the Amazon Connect console user interface, on the navigation menu go to Routing, - // Contact Flows. Choose the flow. On the flow page, under the name of the flow, - // choose Show additional flow information. The ContactFlowId is the last part of - // the ARN, shown here in bold: + // The identifier of the flow for initiating the tasks. To see the ContactFlowId + // in the Amazon Connect console user interface, on the navigation menu go to + // Routing, Contact Flows. Choose the flow. On the flow page, under the name of the + // flow, choose Show additional flow information. The ContactFlowId is the last + // part of the ARN, shown here in bold: // arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx ContactFlowId *string - // A description of the task that is shown to an agent in the Contact Control Panel - // (CCP). + // A description of the task that is shown to an agent in the Contact Control + // Panel (CCP). Description *string // The identifier of the previous chat, voice, or task contact. @@ -78,8 +77,7 @@ type StartTaskContactInput struct { // A formatted URL that is shown to an agent in the Contact Control Panel (CCP). References map[string]types.Reference - // The contactId that is related - // (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks) + // The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks) // to this contact. RelatedContactId *string diff --git a/service/connect/api_op_StopContact.go b/service/connect/api_op_StopContact.go index ac72394c00e..9fe807ebc5f 100644 --- a/service/connect/api_op_StopContact.go +++ b/service/connect/api_op_StopContact.go @@ -10,14 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Ends the specified contact. This call does not work for the following initiation -// methods: -// -// * DISCONNECT -// -// * TRANSFER -// -// * QUEUE_TRANSFER +// Ends the specified contact. This call does not work for the following +// initiation methods: +// - DISCONNECT +// - TRANSFER +// - QUEUE_TRANSFER func (c *Client) StopContact(ctx context.Context, params *StopContactInput, optFns ...func(*Options)) (*StopContactOutput, error) { if params == nil { params = &StopContactInput{} @@ -40,8 +37,7 @@ type StopContactInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_StopContactRecording.go b/service/connect/api_op_StopContactRecording.go index 393c2cd0396..38701c58b9e 100644 --- a/service/connect/api_op_StopContactRecording.go +++ b/service/connect/api_op_StopContactRecording.go @@ -10,13 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops recording a call when a contact is being recorded. StopContactRecording is -// a one-time action. If you use StopContactRecording to stop recording an ongoing -// call, you can't use StartContactRecording to restart it. For scenarios where the -// recording has started and you want to suspend it for sensitive information (for -// example, to collect a credit card number), and then restart it, use -// SuspendContactRecording and ResumeContactRecording. Only voice recordings are -// supported at this time. +// Stops recording a call when a contact is being recorded. StopContactRecording +// is a one-time action. If you use StopContactRecording to stop recording an +// ongoing call, you can't use StartContactRecording to restart it. For scenarios +// where the recording has started and you want to suspend it for sensitive +// information (for example, to collect a credit card number), and then restart it, +// use SuspendContactRecording and ResumeContactRecording. Only voice recordings +// are supported at this time. func (c *Client) StopContactRecording(ctx context.Context, params *StopContactRecordingInput, optFns ...func(*Options)) (*StopContactRecordingOutput, error) { if params == nil { params = &StopContactRecordingInput{} @@ -45,8 +45,7 @@ type StopContactRecordingInput struct { // This member is required. InitialContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_StopContactStreaming.go b/service/connect/api_op_StopContactStreaming.go index 0cc6df9b6b0..7248b12b1e2 100644 --- a/service/connect/api_op_StopContactStreaming.go +++ b/service/connect/api_op_StopContactStreaming.go @@ -11,8 +11,7 @@ import ( ) // Ends message streaming on a specified contact. To restart message streaming on -// that contact, call the StartContactStreaming -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) +// that contact, call the StartContactStreaming (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) // API. func (c *Client) StopContactStreaming(ctx context.Context, params *StopContactStreamingInput, optFns ...func(*Options)) (*StopContactStreamingOutput, error) { if params == nil { @@ -37,8 +36,7 @@ type StopContactStreamingInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_SuspendContactRecording.go b/service/connect/api_op_SuspendContactRecording.go index afaa03405b2..ce513884219 100644 --- a/service/connect/api_op_SuspendContactRecording.go +++ b/service/connect/api_op_SuspendContactRecording.go @@ -44,8 +44,7 @@ type SuspendContactRecordingInput struct { // This member is required. InitialContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_TagResource.go b/service/connect/api_op_TagResource.go index f2b03b2a32d..5075136d748 100644 --- a/service/connect/api_op_TagResource.go +++ b/service/connect/api_op_TagResource.go @@ -13,10 +13,9 @@ import ( // Adds the specified tags to the specified resource. Some of the supported // resource types are agents, routing profiles, queues, quick connects, contact // flows, agent statuses, hours of operation, phone numbers, security profiles, and -// task templates. For a complete list, see Tagging resources in Amazon Connect -// (https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html). For sample -// policies that use tags, see Amazon Connect Identity-Based Policy Examples -// (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) +// task templates. For a complete list, see Tagging resources in Amazon Connect (https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html) +// . For sample policies that use tags, see Amazon Connect Identity-Based Policy +// Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) // in the Amazon Connect Administrator Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/connect/api_op_TransferContact.go b/service/connect/api_op_TransferContact.go index 7f35b574568..ef102182947 100644 --- a/service/connect/api_op_TransferContact.go +++ b/service/connect/api_op_TransferContact.go @@ -17,20 +17,12 @@ import ( // gives you more control over contact handling and helps you adhere to the service // level agreement (SLA) guaranteed to your customers. Note the following // requirements: -// -// * Transfer is supported for only TASK contacts. -// -// * Do not use -// both QueueId and UserId in the same call. -// -// * The following flow types are -// supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. -// -// * -// The TransferContact API can be called only on active contacts. -// -// * A contact -// cannot be transferred more than 11 times. +// - Transfer is supported for only TASK contacts. +// - Do not use both QueueId and UserId in the same call. +// - The following flow types are supported: Inbound flow, Transfer to agent +// flow, and Transfer to queue flow. +// - The TransferContact API can be called only on active contacts. +// - A contact cannot be transferred more than 11 times. func (c *Client) TransferContact(ctx context.Context, params *TransferContactInput, optFns ...func(*Options)) (*TransferContactOutput, error) { if params == nil { params = &TransferContactInput{} @@ -58,8 +50,7 @@ type TransferContactInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -68,8 +59,8 @@ type TransferContactInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The identifier for the queue. diff --git a/service/connect/api_op_UpdateAgentStatus.go b/service/connect/api_op_UpdateAgentStatus.go index 411ab116b2a..bccdb6ae95e 100644 --- a/service/connect/api_op_UpdateAgentStatus.go +++ b/service/connect/api_op_UpdateAgentStatus.go @@ -35,8 +35,7 @@ type UpdateAgentStatusInput struct { // This member is required. AgentStatusId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContact.go b/service/connect/api_op_UpdateContact.go index 535e7c43b40..bf69ed5fc32 100644 --- a/service/connect/api_op_UpdateContact.go +++ b/service/connect/api_op_UpdateContact.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release for Amazon Connect and is subject to change. Adds -// or updates user-defined contact information associated with the specified +// This API is in preview release for Amazon Connect and is subject to change. +// Adds or updates user-defined contact information associated with the specified // contact. At least one field to be updated must be present in the request. You // can add or update user-defined contact information for both ongoing and // completed contacts. @@ -39,8 +39,7 @@ type UpdateContactInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContactAttributes.go b/service/connect/api_op_UpdateContactAttributes.go index 0629a27c837..73785c13bfd 100644 --- a/service/connect/api_op_UpdateContactAttributes.go +++ b/service/connect/api_op_UpdateContactAttributes.go @@ -10,18 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates user-defined contact attributes associated with the specified -// contact. You can create or update user-defined attributes for both ongoing and -// completed contacts. For example, while the call is active, you can update the -// customer's name or the reason the customer called. You can add notes about steps -// that the agent took during the call that display to the next agent that takes -// the call. You can also update attributes for a contact using data from your CRM -// application and save the data with the contact in Amazon Connect. You could also -// flag calls for additional analysis, such as legal review or to identify abusive -// callers. Contact attributes are available in Amazon Connect for 24 months, and -// are then deleted. For information about contact record retention and the maximum -// size of the contact record attributes section, see Feature specifications -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) +// Creates or updates user-defined contact attributes associated with the +// specified contact. You can create or update user-defined attributes for both +// ongoing and completed contacts. For example, while the call is active, you can +// update the customer's name or the reason the customer called. You can add notes +// about steps that the agent took during the call that display to the next agent +// that takes the call. You can also update attributes for a contact using data +// from your CRM application and save the data with the contact in Amazon Connect. +// You could also flag calls for additional analysis, such as legal review or to +// identify abusive callers. Contact attributes are available in Amazon Connect for +// 24 months, and are then deleted. For information about contact record retention +// and the maximum size of the contact record attributes section, see Feature +// specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) // in the Amazon Connect Administrator Guide. func (c *Client) UpdateContactAttributes(ctx context.Context, params *UpdateContactAttributesInput, optFns ...func(*Options)) (*UpdateContactAttributesOutput, error) { if params == nil { @@ -54,8 +54,7 @@ type UpdateContactAttributesInput struct { // This member is required. InitialContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContactFlowContent.go b/service/connect/api_op_UpdateContactFlowContent.go index a4a884dbcb7..83eff3d4255 100644 --- a/service/connect/api_op_UpdateContactFlowContent.go +++ b/service/connect/api_op_UpdateContactFlowContent.go @@ -11,8 +11,8 @@ import ( ) // Updates the specified flow. You can also create and update flows using the -// Amazon Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). +// Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . func (c *Client) UpdateContactFlowContent(ctx context.Context, params *UpdateContactFlowContentInput, optFns ...func(*Options)) (*UpdateContactFlowContentOutput, error) { if params == nil { params = &UpdateContactFlowContentInput{} @@ -36,8 +36,8 @@ type UpdateContactFlowContentInput struct { ContactFlowId *string // The JSON string that represents flow's content. For an example, see Example - // contact flow in Amazon Connect Flow language - // (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html). + // contact flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) + // . // // This member is required. Content *string diff --git a/service/connect/api_op_UpdateContactFlowMetadata.go b/service/connect/api_op_UpdateContactFlowMetadata.go index 4461a96d601..8c5682698ef 100644 --- a/service/connect/api_op_UpdateContactFlowMetadata.go +++ b/service/connect/api_op_UpdateContactFlowMetadata.go @@ -34,8 +34,7 @@ type UpdateContactFlowMetadataInput struct { // This member is required. ContactFlowId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContactFlowModuleContent.go b/service/connect/api_op_UpdateContactFlowModuleContent.go index 071d6372f6c..5b70c607597 100644 --- a/service/connect/api_op_UpdateContactFlowModuleContent.go +++ b/service/connect/api_op_UpdateContactFlowModuleContent.go @@ -38,8 +38,7 @@ type UpdateContactFlowModuleContentInput struct { // This member is required. Content *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContactFlowModuleMetadata.go b/service/connect/api_op_UpdateContactFlowModuleMetadata.go index 1fd81852a08..c54d5f7dc8b 100644 --- a/service/connect/api_op_UpdateContactFlowModuleMetadata.go +++ b/service/connect/api_op_UpdateContactFlowModuleMetadata.go @@ -34,8 +34,7 @@ type UpdateContactFlowModuleMetadataInput struct { // This member is required. ContactFlowModuleId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateContactFlowName.go b/service/connect/api_op_UpdateContactFlowName.go index 7e84b6e532c..bc44f81b5ab 100644 --- a/service/connect/api_op_UpdateContactFlowName.go +++ b/service/connect/api_op_UpdateContactFlowName.go @@ -11,8 +11,8 @@ import ( ) // The name of the flow. You can also create and update flows using the Amazon -// Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). +// Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . func (c *Client) UpdateContactFlowName(ctx context.Context, params *UpdateContactFlowNameInput, optFns ...func(*Options)) (*UpdateContactFlowNameOutput, error) { if params == nil { params = &UpdateContactFlowNameInput{} diff --git a/service/connect/api_op_UpdateContactSchedule.go b/service/connect/api_op_UpdateContactSchedule.go index e7c22d1efd0..6a6d34304ea 100644 --- a/service/connect/api_op_UpdateContactSchedule.go +++ b/service/connect/api_op_UpdateContactSchedule.go @@ -34,8 +34,7 @@ type UpdateContactScheduleInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateHoursOfOperation.go b/service/connect/api_op_UpdateHoursOfOperation.go index f512d604994..8bb1f207342 100644 --- a/service/connect/api_op_UpdateHoursOfOperation.go +++ b/service/connect/api_op_UpdateHoursOfOperation.go @@ -35,8 +35,7 @@ type UpdateHoursOfOperationInput struct { // This member is required. HoursOfOperationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateInstanceAttribute.go b/service/connect/api_op_UpdateInstanceAttribute.go index 11cf4ba1847..7d55f3d16d0 100644 --- a/service/connect/api_op_UpdateInstanceAttribute.go +++ b/service/connect/api_op_UpdateInstanceAttribute.go @@ -37,8 +37,7 @@ type UpdateInstanceAttributeInput struct { // This member is required. AttributeType types.InstanceAttributeType - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateInstanceStorageConfig.go b/service/connect/api_op_UpdateInstanceStorageConfig.go index d533be997a5..15669cefe75 100644 --- a/service/connect/api_op_UpdateInstanceStorageConfig.go +++ b/service/connect/api_op_UpdateInstanceStorageConfig.go @@ -36,8 +36,7 @@ type UpdateInstanceStorageConfigInput struct { // This member is required. AssociationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateParticipantRoleConfig.go b/service/connect/api_op_UpdateParticipantRoleConfig.go index 833759fee45..c50c826ce91 100644 --- a/service/connect/api_op_UpdateParticipantRoleConfig.go +++ b/service/connect/api_op_UpdateParticipantRoleConfig.go @@ -11,22 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates timeouts for when human chat participants are to be considered idle, and -// when agents are automatically disconnected from a chat due to idleness. You can -// set four timers: +// Updates timeouts for when human chat participants are to be considered idle, +// and when agents are automatically disconnected from a chat due to idleness. You +// can set four timers: +// - Customer idle timeout +// - Customer auto-disconnect timeout +// - Agent idle timeout +// - Agent auto-disconnect timeout // -// * Customer idle timeout -// -// * Customer auto-disconnect timeout -// -// * -// Agent idle timeout -// -// * Agent auto-disconnect timeout -// -// For more information about -// how chat timeouts work, see Set up chat timeouts for human participants -// (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html). +// For more information about how chat timeouts work, see Set up chat timeouts for +// human participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) +// . func (c *Client) UpdateParticipantRoleConfig(ctx context.Context, params *UpdateParticipantRoleConfigInput, optFns ...func(*Options)) (*UpdateParticipantRoleConfigOutput, error) { if params == nil { params = &UpdateParticipantRoleConfigInput{} @@ -54,8 +49,7 @@ type UpdateParticipantRoleConfigInput struct { // This member is required. ContactId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdatePhoneNumber.go b/service/connect/api_op_UpdatePhoneNumber.go index 6f963fdd628..155e9fd58e8 100644 --- a/service/connect/api_op_UpdatePhoneNumber.go +++ b/service/connect/api_op_UpdatePhoneNumber.go @@ -14,10 +14,8 @@ import ( // Updates your claimed phone number from its current Amazon Connect instance or // traffic distribution group to another Amazon Connect instance or traffic // distribution group in the same Amazon Web Services Region. You can call -// DescribePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) -// API to verify the status of a previous UpdatePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) +// DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) +// API to verify the status of a previous UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) // operation. func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error) { if params == nil { @@ -50,8 +48,8 @@ type UpdatePhoneNumberInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_UpdateQueueHoursOfOperation.go b/service/connect/api_op_UpdateQueueHoursOfOperation.go index c7274f54665..02660656c0a 100644 --- a/service/connect/api_op_UpdateQueueHoursOfOperation.go +++ b/service/connect/api_op_UpdateQueueHoursOfOperation.go @@ -34,8 +34,7 @@ type UpdateQueueHoursOfOperationInput struct { // This member is required. HoursOfOperationId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQueueMaxContacts.go b/service/connect/api_op_UpdateQueueMaxContacts.go index 2b0b249482d..4a2aab4cc74 100644 --- a/service/connect/api_op_UpdateQueueMaxContacts.go +++ b/service/connect/api_op_UpdateQueueMaxContacts.go @@ -30,8 +30,7 @@ func (c *Client) UpdateQueueMaxContacts(ctx context.Context, params *UpdateQueue type UpdateQueueMaxContactsInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQueueName.go b/service/connect/api_op_UpdateQueueName.go index f843fc6a42e..891f7891b4f 100644 --- a/service/connect/api_op_UpdateQueueName.go +++ b/service/connect/api_op_UpdateQueueName.go @@ -30,8 +30,7 @@ func (c *Client) UpdateQueueName(ctx context.Context, params *UpdateQueueNameInp type UpdateQueueNameInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQueueOutboundCallerConfig.go b/service/connect/api_op_UpdateQueueOutboundCallerConfig.go index 4eff92b8ac1..b67765dbe7f 100644 --- a/service/connect/api_op_UpdateQueueOutboundCallerConfig.go +++ b/service/connect/api_op_UpdateQueueOutboundCallerConfig.go @@ -17,13 +17,12 @@ import ( // distribution group, and you are calling this API using an instance in the Amazon // Web Services Region where the traffic distribution group was created, you can // use either a full phone number ARN or UUID value for the -// OutboundCallerIdNumberId value of the OutboundCallerConfig -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig) +// OutboundCallerIdNumberId value of the OutboundCallerConfig (https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig) // request body parameter. However, if the number is claimed to a traffic // distribution group and you are calling this API using an instance in the // alternate Amazon Web Services Region associated with the traffic distribution // group, you must provide a full phone number ARN. If a UUID is provided in this -// scenario, you will receive a ResourceNotFoundException. +// scenario, you will receive a ResourceNotFoundException . func (c *Client) UpdateQueueOutboundCallerConfig(ctx context.Context, params *UpdateQueueOutboundCallerConfigInput, optFns ...func(*Options)) (*UpdateQueueOutboundCallerConfigOutput, error) { if params == nil { params = &UpdateQueueOutboundCallerConfigInput{} @@ -41,8 +40,7 @@ func (c *Client) UpdateQueueOutboundCallerConfig(ctx context.Context, params *Up type UpdateQueueOutboundCallerConfigInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQueueStatus.go b/service/connect/api_op_UpdateQueueStatus.go index 4907d4fcaef..1238d997665 100644 --- a/service/connect/api_op_UpdateQueueStatus.go +++ b/service/connect/api_op_UpdateQueueStatus.go @@ -30,8 +30,7 @@ func (c *Client) UpdateQueueStatus(ctx context.Context, params *UpdateQueueStatu type UpdateQueueStatusInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQuickConnectConfig.go b/service/connect/api_op_UpdateQuickConnectConfig.go index fd8d0187286..35c9d5c1f2e 100644 --- a/service/connect/api_op_UpdateQuickConnectConfig.go +++ b/service/connect/api_op_UpdateQuickConnectConfig.go @@ -29,8 +29,7 @@ func (c *Client) UpdateQuickConnectConfig(ctx context.Context, params *UpdateQui type UpdateQuickConnectConfigInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateQuickConnectName.go b/service/connect/api_op_UpdateQuickConnectName.go index 6cda14c9648..81c5efdc679 100644 --- a/service/connect/api_op_UpdateQuickConnectName.go +++ b/service/connect/api_op_UpdateQuickConnectName.go @@ -29,8 +29,7 @@ func (c *Client) UpdateQuickConnectName(ctx context.Context, params *UpdateQuick type UpdateQuickConnectNameInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateRoutingProfileConcurrency.go b/service/connect/api_op_UpdateRoutingProfileConcurrency.go index 76459be2de7..ea9e7ee95e4 100644 --- a/service/connect/api_op_UpdateRoutingProfileConcurrency.go +++ b/service/connect/api_op_UpdateRoutingProfileConcurrency.go @@ -30,8 +30,7 @@ func (c *Client) UpdateRoutingProfileConcurrency(ctx context.Context, params *Up type UpdateRoutingProfileConcurrencyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go b/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go index 33bc5e45880..ad660b1da8c 100644 --- a/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go +++ b/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go @@ -33,8 +33,7 @@ type UpdateRoutingProfileDefaultOutboundQueueInput struct { // This member is required. DefaultOutboundQueueId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateRoutingProfileName.go b/service/connect/api_op_UpdateRoutingProfileName.go index 895e73e212d..bd461f56553 100644 --- a/service/connect/api_op_UpdateRoutingProfileName.go +++ b/service/connect/api_op_UpdateRoutingProfileName.go @@ -29,8 +29,7 @@ func (c *Client) UpdateRoutingProfileName(ctx context.Context, params *UpdateRou type UpdateRoutingProfileNameInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateRoutingProfileQueues.go b/service/connect/api_op_UpdateRoutingProfileQueues.go index 094157b92ba..bf037424a82 100644 --- a/service/connect/api_op_UpdateRoutingProfileQueues.go +++ b/service/connect/api_op_UpdateRoutingProfileQueues.go @@ -29,8 +29,7 @@ func (c *Client) UpdateRoutingProfileQueues(ctx context.Context, params *UpdateR type UpdateRoutingProfileQueuesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateRule.go b/service/connect/api_op_UpdateRule.go index 7ba5cfebefd..e3bf649263f 100644 --- a/service/connect/api_op_UpdateRule.go +++ b/service/connect/api_op_UpdateRule.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a rule for the specified Amazon Connect instance. Use the Rules Function -// language -// (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) +// Updates a rule for the specified Amazon Connect instance. Use the Rules +// Function language (https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) // to code conditions for the rule. func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { @@ -42,8 +41,7 @@ type UpdateRuleInput struct { // This member is required. Function *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateSecurityProfile.go b/service/connect/api_op_UpdateSecurityProfile.go index 4ac61e919df..9faa473252e 100644 --- a/service/connect/api_op_UpdateSecurityProfile.go +++ b/service/connect/api_op_UpdateSecurityProfile.go @@ -29,8 +29,7 @@ func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecuri type UpdateSecurityProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -41,16 +40,16 @@ type UpdateSecurityProfileInput struct { // This member is required. SecurityProfileId *string - // The list of tags that a security profile uses to restrict access to resources in - // Amazon Connect. + // The list of tags that a security profile uses to restrict access to resources + // in Amazon Connect. AllowedAccessControlTags map[string]string // The description of the security profile. Description *string // The permissions granted to a security profile. For a list of valid permissions, - // see List of security profile permissions - // (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). + // see List of security profile permissions (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html) + // . Permissions []string // The list of resources that a security profile applies tag restrictions to in diff --git a/service/connect/api_op_UpdateTaskTemplate.go b/service/connect/api_op_UpdateTaskTemplate.go index 32b2c76135f..686ac3e3ae2 100644 --- a/service/connect/api_op_UpdateTaskTemplate.go +++ b/service/connect/api_op_UpdateTaskTemplate.go @@ -32,8 +32,7 @@ func (c *Client) UpdateTaskTemplate(ctx context.Context, params *UpdateTaskTempl type UpdateTaskTemplateInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. @@ -64,9 +63,9 @@ type UpdateTaskTemplateInput struct { // The name of the task template. Name *string - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status types.TaskTemplateStatus noSmithyDocumentSerde @@ -100,8 +99,7 @@ type UpdateTaskTemplateOutput struct { // The identifier of the task template resource. Id *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string @@ -111,9 +109,9 @@ type UpdateTaskTemplateOutput struct { // The name of the task template. Name *string - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status types.TaskTemplateStatus // Metadata pertaining to the operation's result. diff --git a/service/connect/api_op_UpdateTrafficDistribution.go b/service/connect/api_op_UpdateTrafficDistribution.go index 7553d6845d0..04290f5f110 100644 --- a/service/connect/api_op_UpdateTrafficDistribution.go +++ b/service/connect/api_op_UpdateTrafficDistribution.go @@ -13,8 +13,7 @@ import ( // Updates the traffic distribution for a given traffic distribution group. For // more information about updating a traffic distribution group, see Update -// telephony traffic distribution across Amazon Web Services Regions -// (https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html) +// telephony traffic distribution across Amazon Web Services Regions (https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html) // in the Amazon Connect Administrator Guide. func (c *Client) UpdateTrafficDistribution(ctx context.Context, params *UpdateTrafficDistributionInput, optFns ...func(*Options)) (*UpdateTrafficDistributionOutput, error) { if params == nil { diff --git a/service/connect/api_op_UpdateUserHierarchy.go b/service/connect/api_op_UpdateUserHierarchy.go index cd4b636b605..19ed34ec8f0 100644 --- a/service/connect/api_op_UpdateUserHierarchy.go +++ b/service/connect/api_op_UpdateUserHierarchy.go @@ -28,8 +28,7 @@ func (c *Client) UpdateUserHierarchy(ctx context.Context, params *UpdateUserHier type UpdateUserHierarchyInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserHierarchyGroupName.go b/service/connect/api_op_UpdateUserHierarchyGroupName.go index 6be9881324b..5c6193bfae7 100644 --- a/service/connect/api_op_UpdateUserHierarchyGroupName.go +++ b/service/connect/api_op_UpdateUserHierarchyGroupName.go @@ -33,8 +33,7 @@ type UpdateUserHierarchyGroupNameInput struct { // This member is required. HierarchyGroupId *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserHierarchyStructure.go b/service/connect/api_op_UpdateUserHierarchyStructure.go index cbc014f95d8..9f493a94691 100644 --- a/service/connect/api_op_UpdateUserHierarchyStructure.go +++ b/service/connect/api_op_UpdateUserHierarchyStructure.go @@ -35,8 +35,7 @@ type UpdateUserHierarchyStructureInput struct { // This member is required. HierarchyStructure *types.HierarchyStructureUpdate - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserIdentityInfo.go b/service/connect/api_op_UpdateUserIdentityInfo.go index 2bcc702fc2a..b5d1fd4d197 100644 --- a/service/connect/api_op_UpdateUserIdentityInfo.go +++ b/service/connect/api_op_UpdateUserIdentityInfo.go @@ -12,13 +12,12 @@ import ( ) // Updates the identity information for the specified user. We strongly recommend -// limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that -// ability can change the login credentials of other users by changing their email -// address. This poses a security risk to your organization. They can change the -// email address of a user to the attacker's email address, and then reset the +// limiting who has the ability to invoke UpdateUserIdentityInfo . Someone with +// that ability can change the login credentials of other users by changing their +// email address. This poses a security risk to your organization. They can change +// the email address of a user to the attacker's email address, and then reset the // password through email. For more information, see Best Practices for Security -// Profiles -// (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) +// Profiles (https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) // in the Amazon Connect Administrator Guide. func (c *Client) UpdateUserIdentityInfo(ctx context.Context, params *UpdateUserIdentityInfoInput, optFns ...func(*Options)) (*UpdateUserIdentityInfoOutput, error) { if params == nil { @@ -42,8 +41,7 @@ type UpdateUserIdentityInfoInput struct { // This member is required. IdentityInfo *types.UserIdentityInfo - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserPhoneConfig.go b/service/connect/api_op_UpdateUserPhoneConfig.go index bfce147bfc7..083a0347b05 100644 --- a/service/connect/api_op_UpdateUserPhoneConfig.go +++ b/service/connect/api_op_UpdateUserPhoneConfig.go @@ -29,8 +29,7 @@ func (c *Client) UpdateUserPhoneConfig(ctx context.Context, params *UpdateUserPh type UpdateUserPhoneConfigInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserRoutingProfile.go b/service/connect/api_op_UpdateUserRoutingProfile.go index 72afa5ddc41..304f1d934e7 100644 --- a/service/connect/api_op_UpdateUserRoutingProfile.go +++ b/service/connect/api_op_UpdateUserRoutingProfile.go @@ -28,8 +28,7 @@ func (c *Client) UpdateUserRoutingProfile(ctx context.Context, params *UpdateUse type UpdateUserRoutingProfileInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/api_op_UpdateUserSecurityProfiles.go b/service/connect/api_op_UpdateUserSecurityProfiles.go index 6a1ce2a1b4e..710145958e7 100644 --- a/service/connect/api_op_UpdateUserSecurityProfiles.go +++ b/service/connect/api_op_UpdateUserSecurityProfiles.go @@ -28,8 +28,7 @@ func (c *Client) UpdateUserSecurityProfiles(ctx context.Context, params *UpdateU type UpdateUserSecurityProfilesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. diff --git a/service/connect/doc.go b/service/connect/doc.go index 3e747ef859c..e65cb908942 100644 --- a/service/connect/doc.go +++ b/service/connect/doc.go @@ -10,10 +10,9 @@ // efficiently by getting customers in touch with the appropriate agents. There are // limits to the number of Amazon Connect resources that you can create. There are // also limits to the number of requests that you can make per second. For more -// information, see Amazon Connect Service Quotas -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) +// information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) // in the Amazon Connect Administrator Guide. You can connect programmatically to // an Amazon Web Services service by using an endpoint. For a list of Amazon -// Connect endpoints, see Amazon Connect Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/connect_region.html). +// Connect endpoints, see Amazon Connect Endpoints (https://docs.aws.amazon.com/general/latest/gr/connect_region.html) +// . package connect diff --git a/service/connect/types/enums.go b/service/connect/types/enums.go index 2ce28109818..34018de4a24 100644 --- a/service/connect/types/enums.go +++ b/service/connect/types/enums.go @@ -229,9 +229,9 @@ const ( ContactStateRejected ContactState = "REJECTED" ) -// Values returns all known values for ContactState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ContactState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ContactState) Values() []ContactState { return []ContactState{ "INCOMING", @@ -494,8 +494,8 @@ const ( InstanceAttributeTypeEnhancedContactMonitoring InstanceAttributeType = "ENHANCED_CONTACT_MONITORING" ) -// Values returns all known values for InstanceAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceAttributeType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceAttributeType) Values() []InstanceAttributeType { return []InstanceAttributeType{ @@ -649,9 +649,9 @@ const ( NotificationDeliveryTypeEmail NotificationDeliveryType = "EMAIL" ) -// Values returns all known values for NotificationDeliveryType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NotificationDeliveryType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationDeliveryType) Values() []NotificationDeliveryType { return []NotificationDeliveryType{ "EMAIL", @@ -1226,9 +1226,9 @@ const ( PhoneTypeDeskPhone PhoneType = "DESK_PHONE" ) -// Values returns all known values for PhoneType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for PhoneType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (PhoneType) Values() []PhoneType { return []PhoneType{ "SOFT_PHONE", @@ -1248,8 +1248,8 @@ const ( PropertyValidationExceptionReasonNotSupported PropertyValidationExceptionReason = "NOT_SUPPORTED" ) -// Values returns all known values for PropertyValidationExceptionReason. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for PropertyValidationExceptionReason. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (PropertyValidationExceptionReason) Values() []PropertyValidationExceptionReason { @@ -1289,9 +1289,9 @@ const ( QueueTypeAgent QueueType = "AGENT" ) -// Values returns all known values for QueueType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for QueueType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (QueueType) Values() []QueueType { return []QueueType{ "STANDARD", @@ -1394,9 +1394,9 @@ const ( ResourceTypeUser ResourceType = "USER" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "CONTACT", @@ -1451,9 +1451,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -1488,9 +1488,9 @@ const ( StatisticAvg Statistic = "AVG" ) -// Values returns all known values for Statistic. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Statistic. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Statistic) Values() []Statistic { return []Statistic{ "SUM", @@ -1559,8 +1559,8 @@ const ( TaskTemplateFieldTypeEmail TaskTemplateFieldType = "EMAIL" ) -// Values returns all known values for TaskTemplateFieldType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TaskTemplateFieldType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TaskTemplateFieldType) Values() []TaskTemplateFieldType { return []TaskTemplateFieldType{ diff --git a/service/connect/types/types.go b/service/connect/types/types.go index ab1d29e0224..deec6f39045 100644 --- a/service/connect/types/types.go +++ b/service/connect/types/types.go @@ -18,13 +18,12 @@ type ActionSummary struct { noSmithyDocumentSerde } -// Information about the contact -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html) +// Information about the contact (https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html) // associated to the user. type AgentContactReference struct { - // The state of the contact - // (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html). + // The state of the contact (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) + // . AgentContactState ContactState // The channel of the contact. @@ -131,7 +130,7 @@ type AnswerMachineDetectionConfig struct { AwaitAnswerMachinePrompt bool // The flag to indicate if answer machine detection analysis needs to be performed - // for a voice call. If set to true, TrafficType must be set as CAMPAIGN. + // for a voice call. If set to true , TrafficType must be set as CAMPAIGN . EnableAnswerMachineDetection bool noSmithyDocumentSerde @@ -139,13 +138,13 @@ type AnswerMachineDetectionConfig struct { // This action must be set if TriggerEventSource is one of the following values: // OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | -// OnPostChatAnalysisAvailable. Contact is categorized using the rule name. -// RuleName is used as ContactCategory. +// OnPostChatAnalysisAvailable . Contact is categorized using the rule name. +// RuleName is used as ContactCategory . type AssignContactCategoryActionDefinition struct { noSmithyDocumentSerde } -// Information about a reference when the referenceType is ATTACHMENT. Otherwise, +// Information about a reference when the referenceType is ATTACHMENT . Otherwise, // null. type AttachmentReference struct { @@ -177,7 +176,7 @@ type Attribute struct { type AvailableNumberSummary struct { // The phone number. Phone numbers are formatted [+] [country code] [subscriber - // number including area code]. + // number including area code] . PhoneNumber *string // The ISO country code. @@ -193,18 +192,16 @@ type AvailableNumberSummary struct { type ChatMessage struct { // The content of the chat message. - // - // * For text/plain and text/markdown, the Length - // Constraints are Minimum of 1, Maximum of 1024. - // - // * For application/json, the - // Length Constraints are Minimum of 1, Maximum of 12000. + // - For text/plain and text/markdown , the Length Constraints are Minimum of 1, + // Maximum of 1024. + // - For application/json , the Length Constraints are Minimum of 1, Maximum of + // 12000. // // This member is required. Content *string - // The type of the content. Supported types are text/plain, text/markdown, and - // application/json. + // The type of the content. Supported types are text/plain , text/markdown , and + // application/json . // // This member is required. ContentType *string @@ -215,8 +212,8 @@ type ChatMessage struct { // Configuration information for the chat participant role. type ChatParticipantRoleConfig struct { - // A list of participant timers. You can specify any unique combination of role and - // timer type. Duplicate entries error out the request with a 400. + // A list of participant timers. You can specify any unique combination of role + // and timer type. Duplicate entries error out the request with a 400. // // This member is required. ParticipantTimerConfigList []ParticipantTimerConfiguration @@ -242,7 +239,7 @@ type ChatStreamingConfiguration struct { type ClaimedPhoneNumberSummary struct { // The phone number. Phone numbers are formatted [+] [country code] [subscriber - // number including area code]. + // number including area code] . PhoneNumber *string // The Amazon Resource Name (ARN) of the phone number. @@ -258,36 +255,24 @@ type ClaimedPhoneNumberSummary struct { PhoneNumberId *string // The status of the phone number. - // - // * CLAIMED means the previous ClaimedPhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) - // or UpdatePhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) - // operation succeeded. - // - // * IN_PROGRESS means a ClaimedPhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) - // or UpdatePhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) - // operation is still in progress and has not yet completed. You can call - // DescribePhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) - // at a later time to verify if the previous operation has completed. - // - // * FAILED - // indicates that the previous ClaimedPhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) - // or UpdatePhoneNumber - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) - // operation has failed. It will include a message indicating the failure reason. A - // common reason for a failure may be that the TargetArn value you are claiming or - // updating a phone number to has reached its limit of total claimed numbers. If - // you received a FAILED status from a ClaimPhoneNumber API call, you have one day - // to retry claiming the phone number before the number is released back to the - // inventory for other customers to claim. - // - // You will not be billed for the phone - // number during the 1-day period if number claiming fails. + // - CLAIMED means the previous ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) + // or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) + // operation succeeded. + // - IN_PROGRESS means a ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) + // or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) + // operation is still in progress and has not yet completed. You can call + // DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) + // at a later time to verify if the previous operation has completed. + // - FAILED indicates that the previous ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) + // or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) + // operation has failed. It will include a message indicating the failure reason. A + // common reason for a failure may be that the TargetArn value you are claiming + // or updating a phone number to has reached its limit of total claimed numbers. If + // you received a FAILED status from a ClaimPhoneNumber API call, you have one + // day to retry claiming the phone number before the number is released back to the + // inventory for other customers to claim. + // You will not be billed for the phone number during the 1-day period if number + // claiming fails. PhoneNumberStatus *PhoneNumberStatus // The type of phone number. @@ -332,10 +317,10 @@ type Contact struct { // Indicates how the contact was initiated. InitiationMethod ContactInitiationMethod - // The date and time this contact was initiated, in UTC time. For INBOUND, this is - // when the contact arrived. For OUTBOUND, this is when the agent began dialing. - // For CALLBACK, this is when the callback contact was created. For TRANSFER and - // QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when + // The date and time this contact was initiated, in UTC time. For INBOUND , this is + // when the contact arrived. For OUTBOUND , this is when the agent began dialing. + // For CALLBACK , this is when the callback contact was created. For TRANSFER and + // QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when // the request arrived. InitiationTimestamp *time.Time @@ -352,8 +337,7 @@ type Contact struct { // If this contact was queued, this contains information about the queue. QueueInfo *QueueInfo - // The contactId that is related - // (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid) + // The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid) // to this contact. RelatedContactId *string @@ -368,12 +352,12 @@ type Contact struct { } // Filters user data based on the contact information that is associated to the -// users. It contains a list of contact states -// (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html). +// users. It contains a list of contact states (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) +// . type ContactFilter struct { - // A list of up to 9 contact states - // (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html). + // A list of up to 9 contact states (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) + // . ContactStates []ContactState noSmithyDocumentSerde @@ -404,9 +388,8 @@ type ContactFlow struct { // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]string - // The type of the flow. For descriptions of the available types, see Choose a flow - // type - // (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) + // The type of the flow. For descriptions of the available types, see Choose a + // flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) // in the Amazon Connect Administrator Guide. Type ContactFlowType @@ -463,8 +446,8 @@ type ContactFlowModuleSummary struct { } // Contains summary information about a flow. You can also create and update flows -// using the Amazon Connect Flow language -// (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html). +// using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html) +// . type ContactFlowSummary struct { // The Amazon Resource Name (ARN) of the flow. @@ -485,14 +468,10 @@ type ContactFlowSummary struct { noSmithyDocumentSerde } -// An object that can be used to specify Tag conditions inside the SearchFilter. +// An object that can be used to specify Tag conditions inside the SearchFilter . // This accepts an OR of AND (List of List) input where: -// -// * Top level list -// specifies conditions that need to be applied with OR operator -// -// * Inner list -// specifies conditions that need to be applied with AND operator. +// - Top level list specifies conditions that need to be applied with OR operator +// - Inner list specifies conditions that need to be applied with AND operator. type ControlPlaneTagFilter struct { // A list of conditions which would be applied together with an AND condition. @@ -513,8 +492,8 @@ type Credentials struct { // An access token generated for a federated user to access Amazon Connect. AccessToken *string - // A token generated with an expiration time for the session a user is logged in to - // Amazon Connect. + // A token generated with an expiration time for the session a user is logged in + // to Amazon Connect. AccessTokenExpiration *time.Time // Renews a token generated for a user to access the Amazon Connect instance. @@ -526,9 +505,8 @@ type Credentials struct { noSmithyDocumentSerde } -// Contains information about a real-time metric. For a description of each metric, -// see Real-time Metrics Definitions -// (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) +// Contains information about a real-time metric. For a description of each +// metric, see Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) // in the Amazon Connect Administrator Guide. type CurrentMetric struct { @@ -566,7 +544,7 @@ type CurrentMetricResult struct { } // The way to sort the resulting response based on metrics. By default resources -// are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted +// are sorted based on AGENTS_ONLINE , DESCENDING . The metric collection is sorted // based on the input metrics. type CurrentMetricSortCriteria struct { @@ -579,7 +557,7 @@ type CurrentMetricSortCriteria struct { noSmithyDocumentSerde } -// Information about a reference when the referenceType is DATE. Otherwise, null. +// Information about a reference when the referenceType is DATE . Otherwise, null. type DateReference struct { // Identifier of the date reference. @@ -594,16 +572,14 @@ type DateReference struct { // Contains information about a default vocabulary. type DefaultVocabulary struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) // // This member is required. LanguageCode VocabularyLanguageCode @@ -652,7 +628,7 @@ type Distribution struct { noSmithyDocumentSerde } -// Information about a reference when the referenceType is EMAIL. Otherwise, null. +// Information about a reference when the referenceType is EMAIL . Otherwise, null. type EmailReference struct { // Identifier of the email reference. @@ -674,8 +650,8 @@ type EncryptionConfig struct { // The full ARN of the encryption key. Be sure to provide the full ARN of the // encryption key, not just the ID. Amazon Connect supports only KMS keys with the - // default key spec of SYMMETRIC_DEFAULT - // (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default). + // default key spec of SYMMETRIC_DEFAULT (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default) + // . // // This member is required. KeyId *string @@ -711,19 +687,18 @@ type Filters struct { noSmithyDocumentSerde } -// Contains the filter to apply when retrieving metrics with the GetMetricDataV2 -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) +// Contains the filter to apply when retrieving metrics with the GetMetricDataV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) // API. type FilterV2 struct { - // The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, - // CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, - // AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, - // AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys. + // The key to use for filtering data. For example, QUEUE , ROUTING_PROFILE, AGENT , + // CHANNEL , AGENT_HIERARCHY_LEVEL_ONE , AGENT_HIERARCHY_LEVEL_TWO , + // AGENT_HIERARCHY_LEVEL_THREE , AGENT_HIERARCHY_LEVEL_FOUR , + // AGENT_HIERARCHY_LEVEL_FIVE . There must be at least 1 key and a maximum 5 keys. FilterKey *string - // The identifiers to use for filtering data. For example, if you have a filter key - // of QUEUE, you would add queue IDs or ARNs in FilterValues. + // The identifiers to use for filtering data. For example, if you have a filter + // key of QUEUE , you would add queue IDs or ARNs in FilterValues . FilterValues []string noSmithyDocumentSerde @@ -904,8 +879,7 @@ type HierarchyStructureUpdate struct { } // Contains information about a historical metric. For a description of each -// metric, see Historical Metrics Definitions -// (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) +// metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html) // in the Amazon Connect Administrator Guide. type HistoricalMetric struct { @@ -1037,8 +1011,7 @@ type Instance struct { // When the instance was created. CreatedTime *time.Time - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. Id *string @@ -1138,8 +1111,7 @@ type InstanceSummary struct { // Contains summary information about the associated AppIntegrations. type IntegrationAssociationSummary struct { - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string @@ -1263,7 +1235,7 @@ type LexV2Bot struct { type ListPhoneNumbersSummary struct { // The phone number. Phone numbers are formatted [+] [country code] [subscriber - // number including area code]. + // number including area code] . PhoneNumber *string // The Amazon Resource Name (ARN) of the phone number. @@ -1295,8 +1267,8 @@ type MediaConcurrency struct { Channel Channel // The number of contacts an agent can have on a channel simultaneously. Valid - // Range for VOICE: Minimum value of 1. Maximum value of 1. Valid Range for CHAT: - // Minimum value of 1. Maximum value of 10. Valid Range for TASK: Minimum value of + // Range for VOICE : Minimum value of 1. Maximum value of 1. Valid Range for CHAT : + // Minimum value of 1. Maximum value of 10. Valid Range for TASK : Minimum value of // 1. Maximum value of 10. // // This member is required. @@ -1318,17 +1290,17 @@ type MetricDataV2 struct { } // Contains information about the filter used when retrieving metrics. -// MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, -// CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED. +// MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME +// , CONTACTS_CREATED , CONTACTS_HANDLED , SUM_CONTACTS_DISCONNECTED . type MetricFilterV2 struct { - // The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD, + // The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD , // DISCONNECT_REASON MetricFilterKey *string // The values to use for filtering data. Valid metric filter values for - // INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | - // API Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | + // INITIATION_METHOD : INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | + // API Valid metric filter values for DISCONNECT_REASON : CUSTOMER_DISCONNECT | // AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | // CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API MetricFilterValues []string @@ -1377,7 +1349,7 @@ type NotificationRecipientType struct { noSmithyDocumentSerde } -// Information about a reference when the referenceType is NUMBER. Otherwise, null. +// Information about a reference when the referenceType is NUMBER . Otherwise, null. type NumberReference struct { // Identifier of the number reference. @@ -1418,8 +1390,8 @@ type ParticipantDetails struct { // Configuration information for the timer. After the timer configuration is set, // it persists for the duration of the chat. It persists across new contacts in the // chain, for example, transfer contacts. For more information about how chat -// timeouts work, see Set up chat timeouts for human participants -// (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html). +// timeouts work, see Set up chat timeouts for human participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) +// . type ParticipantTimerConfiguration struct { // The role of the participant in the chat conversation. @@ -1427,8 +1399,8 @@ type ParticipantTimerConfiguration struct { // This member is required. ParticipantRole TimerEligibleParticipantRoles - // The type of timer. IDLE indicates the timer applies for considering a human chat - // participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to + // The type of timer. IDLE indicates the timer applies for considering a human + // chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to // automatically disconnecting a chat participant due to idleness. // // This member is required. @@ -1443,11 +1415,11 @@ type ParticipantTimerConfiguration struct { noSmithyDocumentSerde } -// The value of the timer. Either the timer action (Unset to delete the timer), or -// the duration of the timer in minutes. Only one value can be set. For more +// The value of the timer. Either the timer action ( Unset to delete the timer), +// or the duration of the timer in minutes. Only one value can be set. For more // information about how chat timeouts work, see Set up chat timeouts for human -// participants -// (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html). +// participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html) +// . // // The following types satisfy this interface: // @@ -1457,7 +1429,7 @@ type ParticipantTimerValue interface { isParticipantTimerValue() } -// The timer action. Currently only one value is allowed: Unset. It deletes a +// The timer action. Currently only one value is allowed: Unset . It deletes a // timer. type ParticipantTimerValueMemberParticipantTimerAction struct { Value ParticipantTimerAction @@ -1478,26 +1450,22 @@ func (*ParticipantTimerValueMemberParticipantTimerDurationInMinutes) isParticipa // Enable persistent chats. For more information about enabling persistent chat, // and for example use cases and how to configure for them, see Enable persistent -// chat -// (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). +// chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) +// . type PersistentChat struct { // The contactId that is used for rehydration depends on the rehydration type. // RehydrationType is required for persistent chat. - // - // * ENTIRE_PAST_SESSION: - // Rehydrates a chat from the most recently terminated past chat contact of the - // specified past ended chat session. To use this type, provide the - // initialContactId of the past ended chat session in the sourceContactId field. In - // this type, Amazon Connect determines the most recent chat contact on the - // specified chat session that has ended, and uses it to start a persistent - // chat. - // - // * FROM_SEGMENT: Rehydrates a chat from the past chat contact that is - // specified in the sourceContactId field. - // - // The actual contactId used for - // rehydration is provided in the response of this API. + // - ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated + // past chat contact of the specified past ended chat session. To use this type, + // provide the initialContactId of the past ended chat session in the + // sourceContactId field. In this type, Amazon Connect determines the most recent + // chat contact on the specified chat session that has ended, and uses it to start + // a persistent chat. + // - FROM_SEGMENT : Rehydrates a chat from the past chat contact that is + // specified in the sourceContactId field. + // The actual contactId used for rehydration is provided in the response of this + // API. RehydrationType RehydrationType // The contactId from which a persistent chat session must be started. @@ -1518,33 +1486,22 @@ type PhoneNumberQuickConnectConfig struct { } // The status of the phone number. -// -// * CLAIMED means the previous ClaimedPhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) -// or UpdatePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) -// operation succeeded. -// -// * IN_PROGRESS means a ClaimedPhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) -// or UpdatePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) -// operation is still in progress and has not yet completed. You can call -// DescribePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) -// at a later time to verify if the previous operation has completed. -// -// * FAILED -// indicates that the previous ClaimedPhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) -// or UpdatePhoneNumber -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) -// operation has failed. It will include a message indicating the failure reason. A -// common reason for a failure may be that the TargetArn value you are claiming or -// updating a phone number to has reached its limit of total claimed numbers. If -// you received a FAILED status from a ClaimPhoneNumber API call, you have one day -// to retry claiming the phone number before the number is released back to the -// inventory for other customers to claim. +// - CLAIMED means the previous ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) +// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) +// operation succeeded. +// - IN_PROGRESS means a ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) +// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) +// operation is still in progress and has not yet completed. You can call +// DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) +// at a later time to verify if the previous operation has completed. +// - FAILED indicates that the previous ClaimedPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html) +// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) +// operation has failed. It will include a message indicating the failure reason. A +// common reason for a failure may be that the TargetArn value you are claiming +// or updating a phone number to has reached its limit of total claimed numbers. If +// you received a FAILED status from a ClaimPhoneNumber API call, you have one +// day to retry claiming the phone number before the number is released back to the +// inventory for other customers to claim. type PhoneNumberStatus struct { // The status message. @@ -1669,8 +1626,8 @@ type QueueInfo struct { noSmithyDocumentSerde } -// Contains information about a queue for a quick connect. The flow must be of type -// Transfer to Queue. +// Contains information about a queue for a quick connect. The flow must be of +// type Transfer to Queue. type QueueQuickConnectConfig struct { // The identifier of the flow. @@ -1698,10 +1655,10 @@ type QueueReference struct { noSmithyDocumentSerde } -// The search criteria to be used to return queues. The name and description fields -// support "contains" queries with a minimum of 2 characters and a maximum of 25 -// characters. Any queries with character lengths outside of this range will throw -// invalid results. +// The search criteria to be used to return queues. The name and description +// fields support "contains" queries with a minimum of 2 characters and a maximum +// of 25 characters. Any queries with character lengths outside of this range will +// throw invalid results. type QueueSearchCriteria struct { // A list of conditions which would be applied together with an AND condition. @@ -1714,7 +1671,7 @@ type QueueSearchCriteria struct { QueueTypeCondition SearchableQueueType // A leaf node condition which can be used to specify a string condition. The - // currently supported value for FieldName: name + // currently supported value for FieldName : name StringCondition *StringCondition noSmithyDocumentSerde @@ -1723,14 +1680,10 @@ type QueueSearchCriteria struct { // Filters to be applied to search results. type QueueSearchFilter struct { - // An object that can be used to specify Tag conditions inside the SearchFilter. + // An object that can be used to specify Tag conditions inside the SearchFilter . // This accepts an OR of AND (List of List) input where: - // - // * Top level list - // specifies conditions that need to be applied with OR operator - // - // * Inner list - // specifies conditions that need to be applied with AND operator. + // - Top level list specifies conditions that need to be applied with OR operator + // - Inner list specifies conditions that need to be applied with AND operator. TagFilter *ControlPlaneTagFilter noSmithyDocumentSerde @@ -1831,8 +1784,8 @@ type ReadOnlyFieldInfo struct { noSmithyDocumentSerde } -// Well-formed data on a contact, used by agents to complete a contact request. You -// can have up to 4,096 UTF-8 bytes across all references for a contact. +// Well-formed data on a contact, used by agents to complete a contact request. +// You can have up to 4,096 UTF-8 bytes across all references for a contact. type Reference struct { // The type of the reference. DATE must be of type Epoch timestamp. @@ -1864,8 +1817,8 @@ type ReferenceSummary interface { isReferenceSummary() } -// Information about the reference when the referenceType is ATTACHMENT. Otherwise, -// null. +// Information about the reference when the referenceType is ATTACHMENT . +// Otherwise, null. type ReferenceSummaryMemberAttachment struct { Value AttachmentReference @@ -1874,7 +1827,7 @@ type ReferenceSummaryMemberAttachment struct { func (*ReferenceSummaryMemberAttachment) isReferenceSummary() {} -// Information about a reference when the referenceType is DATE. Otherwise, null. +// Information about a reference when the referenceType is DATE . Otherwise, null. type ReferenceSummaryMemberDate struct { Value DateReference @@ -1883,7 +1836,7 @@ type ReferenceSummaryMemberDate struct { func (*ReferenceSummaryMemberDate) isReferenceSummary() {} -// Information about a reference when the referenceType is EMAIL. Otherwise, null. +// Information about a reference when the referenceType is EMAIL . Otherwise, null. type ReferenceSummaryMemberEmail struct { Value EmailReference @@ -1892,7 +1845,7 @@ type ReferenceSummaryMemberEmail struct { func (*ReferenceSummaryMemberEmail) isReferenceSummary() {} -// Information about a reference when the referenceType is NUMBER. Otherwise, null. +// Information about a reference when the referenceType is NUMBER . Otherwise, null. type ReferenceSummaryMemberNumber struct { Value NumberReference @@ -1901,7 +1854,7 @@ type ReferenceSummaryMemberNumber struct { func (*ReferenceSummaryMemberNumber) isReferenceSummary() {} -// Information about a reference when the referenceType is STRING. Otherwise, null. +// Information about a reference when the referenceType is STRING . Otherwise, null. type ReferenceSummaryMemberString struct { Value StringReference @@ -1910,7 +1863,7 @@ type ReferenceSummaryMemberString struct { func (*ReferenceSummaryMemberString) isReferenceSummary() {} -// Information about the reference when the referenceType is URL. Otherwise, null. +// Information about the reference when the referenceType is URL . Otherwise, null. type ReferenceSummaryMemberUrl struct { Value UrlReference @@ -1937,8 +1890,7 @@ type RoutingProfile struct { // The description of the routing profile. Description *string - // The identifier of the Amazon Connect instance. You can find the instance ID - // (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) + // The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) // in the Amazon Resource Name (ARN) of the instance. InstanceId *string @@ -1973,16 +1925,15 @@ type RoutingProfile struct { type RoutingProfileQueueConfig struct { // The delay, in seconds, a contact should be in the queue before they are routed - // to an available agent. For more information, see Queues: priority and delay - // (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) + // to an available agent. For more information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) // in the Amazon Connect Administrator Guide. // // This member is required. Delay *int32 // The order in which contacts are to be handled for the queue. For more - // information, see Queues: priority and delay - // (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html). + // information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) + // . // // This member is required. Priority *int32 @@ -2005,16 +1956,15 @@ type RoutingProfileQueueConfigSummary struct { // The delay, in seconds, that a contact should be in the queue before they are // routed to an available agent. For more information, see Queues: priority and - // delay - // (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) + // delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) // in the Amazon Connect Administrator Guide. // // This member is required. Delay int32 // The order in which contacts are to be handled for the queue. For more - // information, see Queues: priority and delay - // (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html). + // information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) + // . // // This member is required. Priority int32 @@ -2079,7 +2029,7 @@ type RoutingProfileSearchCriteria struct { OrConditions []RoutingProfileSearchCriteria // A leaf node condition which can be used to specify a string condition. The - // currently supported value for FieldName: name + // currently supported value for FieldName : name StringCondition *StringCondition noSmithyDocumentSerde @@ -2088,14 +2038,10 @@ type RoutingProfileSearchCriteria struct { // Filters to be applied to search results. type RoutingProfileSearchFilter struct { - // An object that can be used to specify Tag conditions inside the SearchFilter. + // An object that can be used to specify Tag conditions inside the SearchFilter . // This accepts an OR of AND (List of List) input where: - // - // * Top level list - // specifies conditions that need to be applied with OR operator - // - // * Inner list - // specifies conditions that need to be applied with AND operator. + // - Top level list specifies conditions that need to be applied with OR operator + // - Inner list specifies conditions that need to be applied with AND operator. TagFilter *ControlPlaneTagFilter noSmithyDocumentSerde @@ -2301,8 +2247,8 @@ type SecurityKey struct { // Contains information about a security profile. type SecurityProfile struct { - // The list of tags that a security profile uses to restrict access to resources in - // Amazon Connect. + // The list of tags that a security profile uses to restrict access to resources + // in Amazon Connect. AllowedAccessControlTags map[string]string // The Amazon Resource Name (ARN) for the secruity profile. @@ -2344,7 +2290,7 @@ type SecurityProfileSearchCriteria struct { OrConditions []SecurityProfileSearchCriteria // A leaf node condition which can be used to specify a string condition. The - // currently supported value for FieldName: name + // currently supported value for FieldName : name StringCondition *StringCondition noSmithyDocumentSerde @@ -2378,14 +2324,10 @@ type SecurityProfileSearchSummary struct { // Filters to be applied to search results. type SecurityProfilesSearchFilter struct { - // An object that can be used to specify Tag conditions inside the SearchFilter. + // An object that can be used to specify Tag conditions inside the SearchFilter . // This accepts an OR of AND (List of List) input where: - // - // * Top level list - // specifies conditions that need to be applied with OR operator - // - // * Inner list - // specifies conditions that need to be applied with AND operator. + // - Top level list specifies conditions that need to be applied with OR operator + // - Inner list specifies conditions that need to be applied with AND operator. TagFilter *ControlPlaneTagFilter noSmithyDocumentSerde @@ -2410,8 +2352,7 @@ type SecurityProfileSummary struct { type SendNotificationActionDefinition struct { // Notification content. Supports variable injection. For more information, see - // JSONPath reference - // (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) + // JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) // in the Amazon Connect Administrators Guide. // // This member is required. @@ -2432,9 +2373,8 @@ type SendNotificationActionDefinition struct { // This member is required. Recipient *NotificationRecipientType - // The subject of the email if the delivery method is EMAIL. Supports variable - // injection. For more information, see JSONPath reference - // (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) + // The subject of the email if the delivery method is EMAIL . Supports variable + // injection. For more information, see JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) // in the Amazon Connect Administrators Guide. Subject *string @@ -2442,7 +2382,7 @@ type SendNotificationActionDefinition struct { } // A leaf node condition which can be used to specify a string condition. The -// currently supported value for FieldName: name +// currently supported value for FieldName : name type StringCondition struct { // The type of comparison to be made when evaluating the string condition. @@ -2457,7 +2397,7 @@ type StringCondition struct { noSmithyDocumentSerde } -// Information about a reference when the referenceType is STRING. Otherwise, null. +// Information about a reference when the referenceType is STRING . Otherwise, null. type StringReference struct { // Identifier of the string reference. @@ -2469,8 +2409,8 @@ type StringReference struct { noSmithyDocumentSerde } -// A leaf node condition which can be used to specify a tag condition, for example, -// HAVE BPO = 123. +// A leaf node condition which can be used to specify a tag condition, for +// example, HAVE BPO = 123 . type TagCondition struct { // The tag key in the tag condition. @@ -2491,20 +2431,18 @@ type TaskActionDefinition struct { ContactFlowId *string // The name. Supports variable injection. For more information, see JSONPath - // reference - // (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) + // reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) // in the Amazon Connect Administrators Guide. // // This member is required. Name *string - // The description. Supports variable injection. For more information, see JSONPath - // reference - // (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) + // The description. Supports variable injection. For more information, see + // JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) // in the Amazon Connect Administrators Guide. Description *string - // Information about the reference when the referenceType is URL. Otherwise, null. + // Information about the reference when the referenceType is URL . Otherwise, null. // (Supports variable injection in the Value field.) References map[string]Reference @@ -2597,9 +2535,9 @@ type TaskTemplateMetadata struct { // The name of the task template. Name *string - // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only - // be created from ACTIVE templates. If a template is marked as INACTIVE, then a - // task that refers to this template cannot be created. + // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can + // only be created from ACTIVE templates. If a template is marked as INACTIVE , + // then a task that refers to this template cannot be created. Status TaskTemplateStatus noSmithyDocumentSerde @@ -2661,36 +2599,18 @@ type TrafficDistributionGroup struct { Name *string // The status of the traffic distribution group. - // - // * CREATION_IN_PROGRESS means the - // previous CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. - // - // * ACTIVE means the - // previous CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation has succeeded. - // - // * CREATION_FAILED indicates that the previous - // CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation has failed. - // - // * PENDING_DELETION means the previous - // DeleteTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. - // - // * DELETION_FAILED - // means the previous DeleteTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) - // operation has failed. - // - // * UPDATE_IN_PROGRESS means the previous - // UpdateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. + // - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. + // - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation has succeeded. + // - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation has failed. + // - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. + // - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) + // operation has failed. + // - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. Status TrafficDistributionGroupStatus // The tags used to organize, track, or control access for this resource. For @@ -2718,36 +2638,18 @@ type TrafficDistributionGroupSummary struct { Name *string // The status of the traffic distribution group. - // - // * CREATION_IN_PROGRESS means the - // previous CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. - // - // * ACTIVE means the - // previous CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation has succeeded. - // - // * CREATION_FAILED indicates that the previous - // CreateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) - // operation has failed. - // - // * PENDING_DELETION means the previous - // DeleteTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. - // - // * DELETION_FAILED - // means the previous DeleteTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) - // operation has failed. - // - // * UPDATE_IN_PROGRESS means the previous - // UpdateTrafficDistributionGroup - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html) - // operation is still in progress and has not yet completed. + // - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. + // - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation has succeeded. + // - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html) + // operation has failed. + // - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. + // - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html) + // operation has failed. + // - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html) + // operation is still in progress and has not yet completed. Status TrafficDistributionGroupStatus noSmithyDocumentSerde @@ -2854,8 +2756,7 @@ type UserData struct { HierarchyPath *HierarchyPathReference // A map of maximum slots by channel. The key is a channel name. The value is an - // integer: the maximum number of slots. This is calculated from MediaConcurrency - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html) + // integer: the maximum number of slots. This is calculated from MediaConcurrency (https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html) // of the RoutingProfile assigned to the agent. MaxSlotsByChannel map[string]int32 @@ -3011,14 +2912,10 @@ type UserSearchCriteria struct { // Filters to be applied to search results. type UserSearchFilter struct { - // An object that can be used to specify Tag conditions inside the SearchFilter. + // An object that can be used to specify Tag conditions inside the SearchFilter . // This accepts an OR of AND (List of List) input where: - // - // * Top level list - // specifies conditions that need to be applied with OR operator - // - // * Inner list - // specifies conditions that need to be applied with AND operator. + // - Top level list specifies conditions that need to be applied with OR operator + // - Inner list specifies conditions that need to be applied with AND operator. TagFilter *ControlPlaneTagFilter noSmithyDocumentSerde @@ -3090,8 +2987,7 @@ type Vocabulary struct { Id *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) // // This member is required. LanguageCode VocabularyLanguageCode @@ -3113,9 +3009,9 @@ type Vocabulary struct { // The content of the custom vocabulary in plain-text format with a table of // values. Each row in the table represents a word or a phrase, described with - // Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB - // characters. For more information, see Create a custom vocabulary using a table - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). + // Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB + // characters. For more information, see Create a custom vocabulary using a table (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table) + // . Content *string // The reason why the custom vocabulary was not created. @@ -3142,8 +3038,7 @@ type VocabularySummary struct { Id *string // The language code of the vocabulary entries. For a list of languages and their - // corresponding language codes, see What is Amazon Transcribe? - // (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) + // corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html) // // This member is required. LanguageCode VocabularyLanguageCode diff --git a/service/connectcampaigns/api_client.go b/service/connectcampaigns/api_client.go index 03f712c9bd2..748861aa8b7 100644 --- a/service/connectcampaigns/api_client.go +++ b/service/connectcampaigns/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/connectcampaigns/types/enums.go b/service/connectcampaigns/types/enums.go index 8aa49e2d438..15aaccda4cf 100644 --- a/service/connectcampaigns/types/enums.go +++ b/service/connectcampaigns/types/enums.go @@ -99,9 +99,9 @@ const ( InstanceIdFilterOperatorEq InstanceIdFilterOperator = "Eq" ) -// Values returns all known values for InstanceIdFilterOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceIdFilterOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceIdFilterOperator) Values() []InstanceIdFilterOperator { return []InstanceIdFilterOperator{ "Eq", diff --git a/service/connectcases/api_client.go b/service/connectcases/api_client.go index 81ae0d7f8e5..7f574bb0af8 100644 --- a/service/connectcases/api_client.go +++ b/service/connectcases/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/connectcases/api_op_CreateCase.go b/service/connectcases/api_op_CreateCase.go index 236cafc7631..1febe83f469 100644 --- a/service/connectcases/api_op_CreateCase.go +++ b/service/connectcases/api_op_CreateCase.go @@ -15,12 +15,10 @@ import ( // Creates a case in the specified Cases domain. Case system and custom fields are // taken as an array id/value pairs with a declared data types. The following // fields are required when creating a case: -// -// * customer_id - You must provide the -// full customer profile ARN in this format: arn:aws:profile:your AWS Region:your -// AWS account ID:domains/profiles domain name/profiles/profile ID -// -// * title +// - customer_id - You must provide the full customer profile ARN in this format: +// arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain +// name/profiles/profile ID +// - title func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error) { if params == nil { params = &CreateCaseInput{} @@ -57,8 +55,8 @@ type CreateCaseInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connectcases/api_op_CreateDomain.go b/service/connectcases/api_op_CreateDomain.go index c7b029cb834..15466bae10e 100644 --- a/service/connectcases/api_op_CreateDomain.go +++ b/service/connectcases/api_op_CreateDomain.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a domain, which is a container for all case data, such as cases, fields, -// templates and layouts. Each Amazon Connect instance can be associated with only -// one Cases domain. This will not associate your connect instance to Cases domain. -// Instead, use the Amazon Connect CreateIntegrationAssociation -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) +// Creates a domain, which is a container for all case data, such as cases, +// fields, templates and layouts. Each Amazon Connect instance can be associated +// with only one Cases domain. This will not associate your connect instance to +// Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) // API. You need specific IAM permissions to successfully associate the Cases -// domain. For more information, see Onboard to Cases -// (https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam). +// domain. For more information, see Onboard to Cases (https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam) +// . func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} diff --git a/service/connectcases/api_op_CreateLayout.go b/service/connectcases/api_op_CreateLayout.go index 8f1a44794f3..42c843f4975 100644 --- a/service/connectcases/api_op_CreateLayout.go +++ b/service/connectcases/api_op_CreateLayout.go @@ -11,16 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a layout in the Cases domain. Layouts define the following configuration -// in the top section and More Info tab of the Cases user interface: +// Creates a layout in the Cases domain. Layouts define the following +// configuration in the top section and More Info tab of the Cases user interface: +// - Fields to display to the users +// - Field ordering // -// * Fields to -// display to the users -// -// * Field ordering -// -// Title and Status fields cannot be part -// of layouts since they are not configurable. +// Title and Status fields cannot be part of layouts since they are not +// configurable. func (c *Client) CreateLayout(ctx context.Context, params *CreateLayoutInput, optFns ...func(*Options)) (*CreateLayoutOutput, error) { if params == nil { params = &CreateLayoutInput{} diff --git a/service/connectcases/api_op_CreateRelatedItem.go b/service/connectcases/api_op_CreateRelatedItem.go index 19d4d3a35b2..f3731403283 100644 --- a/service/connectcases/api_op_CreateRelatedItem.go +++ b/service/connectcases/api_op_CreateRelatedItem.go @@ -14,8 +14,8 @@ import ( // Creates a related item (comments, tasks, and contacts) and associates it with a // case. A Related Item is a resource that is associated with a case. It may or may // not have an external identifier linking it to an external resource (for example, -// a contactArn). All Related Items have their own internal identifier, the -// relatedItemArn. Examples of related items include comments and contacts. +// a contactArn ). All Related Items have their own internal identifier, the +// relatedItemArn . Examples of related items include comments and contacts . func (c *Client) CreateRelatedItem(ctx context.Context, params *CreateRelatedItemInput, optFns ...func(*Options)) (*CreateRelatedItemOutput, error) { if params == nil { params = &CreateRelatedItemInput{} diff --git a/service/connectcases/api_op_CreateTemplate.go b/service/connectcases/api_op_CreateTemplate.go index c4a86120163..226768fa3b7 100644 --- a/service/connectcases/api_op_CreateTemplate.go +++ b/service/connectcases/api_op_CreateTemplate.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a template in the Cases domain. This template is used to define the case -// object model (that is, to define what data can be captured on cases) in a Cases -// domain. A template must have a unique name within a domain, and it must +// Creates a template in the Cases domain. This template is used to define the +// case object model (that is, to define what data can be captured on cases) in a +// Cases domain. A template must have a unique name within a domain, and it must // reference existing field IDs and layout IDs. Additionally, multiple fields with // same IDs are not allowed within the same Template. A template can be either // Active or Inactive, as indicated by its status. Inactive templates cannot be @@ -51,8 +51,8 @@ type CreateTemplateInput struct { // Configuration of layouts associated to the template. LayoutConfiguration *types.LayoutConfiguration - // A list of fields that must contain a value for a case to be successfully created - // with this template. + // A list of fields that must contain a value for a case to be successfully + // created with this template. RequiredFields []types.RequiredField // The status of the template. diff --git a/service/connectcases/api_op_GetCase.go b/service/connectcases/api_op_GetCase.go index 7e719e7242d..cd32d864442 100644 --- a/service/connectcases/api_op_GetCase.go +++ b/service/connectcases/api_op_GetCase.go @@ -64,8 +64,8 @@ type GetCaseOutput struct { // This member is required. TemplateId *string - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // A map of of key-value pairs that represent tags on a resource. Tags are used to diff --git a/service/connectcases/api_op_GetTemplate.go b/service/connectcases/api_op_GetTemplate.go index 79c1695ee73..f23b4ed7baa 100644 --- a/service/connectcases/api_op_GetTemplate.go +++ b/service/connectcases/api_op_GetTemplate.go @@ -70,8 +70,8 @@ type GetTemplateOutput struct { // Configuration of layouts associated to the template. LayoutConfiguration *types.LayoutConfiguration - // A list of fields that must contain a value for a case to be successfully created - // with this template. + // A list of fields that must contain a value for a case to be successfully + // created with this template. RequiredFields []types.RequiredField // A map of of key-value pairs that represent tags on a resource. Tags are used to diff --git a/service/connectcases/api_op_ListCasesForContact.go b/service/connectcases/api_op_ListCasesForContact.go index 5856a46927f..03637cee7d7 100644 --- a/service/connectcases/api_op_ListCasesForContact.go +++ b/service/connectcases/api_op_ListCasesForContact.go @@ -57,8 +57,8 @@ type ListCasesForContactOutput struct { // This member is required. Cases []types.CaseSummary - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -130,8 +130,8 @@ func (c *Client) addOperationListCasesForContactMiddlewares(stack *middleware.St return nil } -// ListCasesForContactAPIClient is a client that implements the ListCasesForContact -// operation. +// ListCasesForContactAPIClient is a client that implements the +// ListCasesForContact operation. type ListCasesForContactAPIClient interface { ListCasesForContact(context.Context, *ListCasesForContactInput, ...func(*Options)) (*ListCasesForContactOutput, error) } diff --git a/service/connectcases/api_op_ListDomains.go b/service/connectcases/api_op_ListDomains.go index 9aac0003e5f..24747b6a712 100644 --- a/service/connectcases/api_op_ListDomains.go +++ b/service/connectcases/api_op_ListDomains.go @@ -48,8 +48,8 @@ type ListDomainsOutput struct { // This member is required. Domains []types.DomainSummary - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_ListFieldOptions.go b/service/connectcases/api_op_ListFieldOptions.go index 70fb86f4c19..75628e1dd39 100644 --- a/service/connectcases/api_op_ListFieldOptions.go +++ b/service/connectcases/api_op_ListFieldOptions.go @@ -47,7 +47,7 @@ type ListFieldOptionsInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // A list of FieldOption values to filter on for ListFieldOptions. + // A list of FieldOption values to filter on for ListFieldOptions . Values []string noSmithyDocumentSerde @@ -60,8 +60,8 @@ type ListFieldOptionsOutput struct { // This member is required. Options []types.FieldOption - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_ListFields.go b/service/connectcases/api_op_ListFields.go index 35c550cc05e..f1b2afc0e67 100644 --- a/service/connectcases/api_op_ListFields.go +++ b/service/connectcases/api_op_ListFields.go @@ -52,8 +52,8 @@ type ListFieldsOutput struct { // This member is required. Fields []types.FieldSummary - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_ListLayouts.go b/service/connectcases/api_op_ListLayouts.go index a95d9c2d33f..972c42a58ff 100644 --- a/service/connectcases/api_op_ListLayouts.go +++ b/service/connectcases/api_op_ListLayouts.go @@ -53,8 +53,8 @@ type ListLayoutsOutput struct { // This member is required. Layouts []types.LayoutSummary - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_ListTemplates.go b/service/connectcases/api_op_ListTemplates.go index 3b32943c227..caba250e65e 100644 --- a/service/connectcases/api_op_ListTemplates.go +++ b/service/connectcases/api_op_ListTemplates.go @@ -56,8 +56,8 @@ type ListTemplatesOutput struct { // This member is required. Templates []types.TemplateSummary - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_SearchCases.go b/service/connectcases/api_op_SearchCases.go index 462a0dc6d96..f317a73aabb 100644 --- a/service/connectcases/api_op_SearchCases.go +++ b/service/connectcases/api_op_SearchCases.go @@ -14,8 +14,8 @@ import ( // Searches for cases within their associated Cases domain. Search results are // returned as a paginated list of abridged case documents. For customer_id you -// must provide the full customer profile ARN in this format: arn:aws:profile:your -// AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID. +// must provide the full customer profile ARN in this format: arn:aws:profile:your +// AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID . func (c *Client) SearchCases(ctx context.Context, params *SearchCasesInput, optFns ...func(*Options)) (*SearchCasesOutput, error) { if params == nil { params = &SearchCasesInput{} @@ -70,8 +70,8 @@ type SearchCasesOutput struct { // This member is required. Cases []*types.SearchCasesResponseItem - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_SearchRelatedItems.go b/service/connectcases/api_op_SearchRelatedItems.go index 1e64d47da27..2466ac45cd4 100644 --- a/service/connectcases/api_op_SearchRelatedItems.go +++ b/service/connectcases/api_op_SearchRelatedItems.go @@ -61,8 +61,8 @@ type SearchRelatedItemsOutput struct { // This member is required. RelatedItems []*types.SearchRelatedItemsResponseItem - // The token for the next set of results. This is null if there are no more results - // to return. + // The token for the next set of results. This is null if there are no more + // results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/connectcases/api_op_UpdateCase.go b/service/connectcases/api_op_UpdateCase.go index 1ed49d8e4fe..88d2f06067e 100644 --- a/service/connectcases/api_op_UpdateCase.go +++ b/service/connectcases/api_op_UpdateCase.go @@ -42,7 +42,7 @@ type UpdateCaseInput struct { DomainId *string // An array of objects with fieldId (matching ListFields/DescribeField) and value - // union data, structured identical to CreateCase. + // union data, structured identical to CreateCase . // // This member is required. Fields []types.FieldValue diff --git a/service/connectcases/api_op_UpdateTemplate.go b/service/connectcases/api_op_UpdateTemplate.go index ff5a563ab6a..7e6221c7bec 100644 --- a/service/connectcases/api_op_UpdateTemplate.go +++ b/service/connectcases/api_op_UpdateTemplate.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the attributes of an existing template. The template attributes that can -// be modified include name, description, layoutConfiguration, requiredFields, and -// status. At least one of these attributes must not be null. If a null value is -// provided for a given attribute, that attribute is ignored and its current value -// is preserved. +// Updates the attributes of an existing template. The template attributes that +// can be modified include name , description , layoutConfiguration , +// requiredFields , and status . At least one of these attributes must not be null. +// If a null value is provided for a given attribute, that attribute is ignored and +// its current value is preserved. func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error) { if params == nil { params = &UpdateTemplateInput{} @@ -52,8 +52,8 @@ type UpdateTemplateInput struct { // The name of the template. It must be unique per domain. Name *string - // A list of fields that must contain a value for a case to be successfully created - // with this template. + // A list of fields that must contain a value for a case to be successfully + // created with this template. RequiredFields []types.RequiredField // The status of the template. diff --git a/service/connectcases/doc.go b/service/connectcases/doc.go index 7687f1063cc..64576ae50bb 100644 --- a/service/connectcases/doc.go +++ b/service/connectcases/doc.go @@ -3,11 +3,10 @@ // Package connectcases provides the API client, operations, and parameter types // for Amazon Connect Cases. // -// With Amazon Connect Cases, your agents can track and manage customer issues that -// require multiple interactions, follow-up tasks, and teams in your contact +// With Amazon Connect Cases, your agents can track and manage customer issues +// that require multiple interactions, follow-up tasks, and teams in your contact // center. A case represents a customer issue. It records the issue, the steps and // interactions taken to resolve the issue, and the outcome. For more information, -// see Amazon Connect Cases -// (https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) in the Amazon -// Connect Administrator Guide. +// see Amazon Connect Cases (https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) +// in the Amazon Connect Administrator Guide. package connectcases diff --git a/service/connectcases/types/enums.go b/service/connectcases/types/enums.go index 069f8479b32..f1e43e696a9 100644 --- a/service/connectcases/types/enums.go +++ b/service/connectcases/types/enums.go @@ -27,9 +27,9 @@ const ( DomainStatusCreationFailed DomainStatus = "CreationFailed" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "Active", @@ -67,9 +67,9 @@ const ( FieldTypeSingleSelect FieldType = "SingleSelect" ) -// Values returns all known values for FieldType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FieldType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FieldType) Values() []FieldType { return []FieldType{ "Text", @@ -88,8 +88,8 @@ const ( OrderDescending Order = "Desc" ) -// Values returns all known values for Order. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Order. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Order) Values() []Order { return []Order{ diff --git a/service/connectcases/types/errors.go b/service/connectcases/types/errors.go index 7a56c0a4a08..be01456c040 100644 --- a/service/connectcases/types/errors.go +++ b/service/connectcases/types/errors.go @@ -122,8 +122,7 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The service quota has been exceeded. For a list of service quotas, see Amazon -// Connect Service Quotas -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) +// Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) // in the Amazon Connect Administrator Guide. type ServiceQuotaExceededException struct { Message *string diff --git a/service/connectcases/types/types.go b/service/connectcases/types/types.go index 4b690d8b141..16f475b8ea2 100644 --- a/service/connectcases/types/types.go +++ b/service/connectcases/types/types.go @@ -101,7 +101,7 @@ type CommentContent struct { noSmithyDocumentSerde } -// A filter for related items of type Comment. +// A filter for related items of type Comment . type CommentFilter struct { noSmithyDocumentSerde } @@ -120,7 +120,7 @@ type Contact struct { // An object that represents a content of an Amazon Connect contact object. type ContactContent struct { - // A list of channels to filter on for related items of type Contact. + // A list of channels to filter on for related items of type Contact . // // This member is required. Channel *string @@ -139,10 +139,10 @@ type ContactContent struct { noSmithyDocumentSerde } -// A filter for related items of type Contact. +// A filter for related items of type Contact . type ContactFilter struct { - // A list of channels to filter on for related items of type Contact. + // A list of channels to filter on for related items of type Contact . Channel []string // A unique identifier of a contact in Amazon Connect. @@ -628,7 +628,7 @@ type RelatedItemTypeFilter interface { isRelatedItemTypeFilter() } -// A filter for related items of type Comment. +// A filter for related items of type Comment . type RelatedItemTypeFilterMemberComment struct { Value CommentFilter @@ -637,7 +637,7 @@ type RelatedItemTypeFilterMemberComment struct { func (*RelatedItemTypeFilterMemberComment) isRelatedItemTypeFilter() {} -// A filter for related items of type Contact. +// A filter for related items of type Contact . type RelatedItemTypeFilterMemberContact struct { Value ContactFilter diff --git a/service/connectcontactlens/api_client.go b/service/connectcontactlens/api_client.go index 34a4b13fd9e..4a2f1a44900 100644 --- a/service/connectcontactlens/api_client.go +++ b/service/connectcontactlens/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go b/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go index 4aee7a2e620..e64e04d5eec 100644 --- a/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go +++ b/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go @@ -59,17 +59,12 @@ type ListRealtimeContactAnalysisSegmentsOutput struct { // If there are additional results, this is the token for the next set of results. // If response includes nextToken there are two possible scenarios: - // - // * There are - // more segments so another call is required to get them. - // - // * There are no more - // segments at this time, but more may be available later (real-time analysis is in - // progress) so the client should call the operation again to get new segments. - // - // If - // response does not include nextToken, the analysis is completed (successfully or - // failed) and there are no more segments to retrieve. + // - There are more segments so another call is required to get them. + // - There are no more segments at this time, but more may be available later + // (real-time analysis is in progress) so the client should call the operation + // again to get new segments. + // If response does not include nextToken , the analysis is completed (successfully + // or failed) and there are no more segments to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -149,8 +144,8 @@ type ListRealtimeContactAnalysisSegmentsAPIClient interface { var _ ListRealtimeContactAnalysisSegmentsAPIClient = (*Client)(nil) -// ListRealtimeContactAnalysisSegmentsPaginatorOptions is the paginator options for -// ListRealtimeContactAnalysisSegments +// ListRealtimeContactAnalysisSegmentsPaginatorOptions is the paginator options +// for ListRealtimeContactAnalysisSegments type ListRealtimeContactAnalysisSegmentsPaginatorOptions struct { // The maximimum number of results to return per page. Limit int32 diff --git a/service/connectcontactlens/doc.go b/service/connectcontactlens/doc.go index 7e267d1898c..a0b564d91ee 100644 --- a/service/connectcontactlens/doc.go +++ b/service/connectcontactlens/doc.go @@ -9,7 +9,6 @@ // issues, and enables you to automatically categorize contacts. Contact Lens for // Amazon Connect provides both real-time and post-call analytics of customer-agent // conversations. For more information, see Analyze conversations using Contact -// Lens -// (https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html) +// Lens (https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html) // in the Amazon Connect Administrator Guide. package connectcontactlens diff --git a/service/connectparticipant/api_client.go b/service/connectparticipant/api_client.go index bc117a2d809..b9738a7d9dc 100644 --- a/service/connectparticipant/api_client.go +++ b/service/connectparticipant/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/connectparticipant/api_op_CompleteAttachmentUpload.go b/service/connectparticipant/api_op_CompleteAttachmentUpload.go index 4aa2c463ddb..87b7f3ae91a 100644 --- a/service/connectparticipant/api_op_CompleteAttachmentUpload.go +++ b/service/connectparticipant/api_op_CompleteAttachmentUpload.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to confirm that the attachment has been uploaded using the pre-signed -// URL provided in StartAttachmentUpload API. ConnectionToken is used for invoking -// this API instead of ParticipantToken. The Amazon Connect Participant Service -// APIs do not use Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// Allows you to confirm that the attachment has been uploaded using the +// pre-signed URL provided in StartAttachmentUpload API. ConnectionToken is used +// for invoking this API instead of ParticipantToken . The Amazon Connect +// Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) CompleteAttachmentUpload(ctx context.Context, params *CompleteAttachmentUploadInput, optFns ...func(*Options)) (*CompleteAttachmentUploadOutput, error) { if params == nil { params = &CompleteAttachmentUploadInput{} @@ -41,8 +41,8 @@ type CompleteAttachmentUploadInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . // // This member is required. ClientToken *string diff --git a/service/connectparticipant/api_op_CreateParticipantConnection.go b/service/connectparticipant/api_op_CreateParticipantConnection.go index fcab38090ad..b600c4c0f62 100644 --- a/service/connectparticipant/api_op_CreateParticipantConnection.go +++ b/service/connectparticipant/api_op_CreateParticipantConnection.go @@ -11,29 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the participant's connection. ParticipantToken is used for invoking this -// API instead of ConnectionToken. The participant token is valid for the lifetime -// of the participant – until they are part of a contact. The response URL for -// WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually +// Creates the participant's connection. ParticipantToken is used for invoking +// this API instead of ConnectionToken . The participant token is valid for the +// lifetime of the participant – until they are part of a contact. The response URL +// for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually // connect to the returned websocket URL and subscribe to the desired topic. For // chat, you need to publish the following on the established websocket connection: // {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}} Upon websocket URL // expiry, as specified in the response ConnectionExpiry parameter, clients need to // call this API again to obtain a new websocket URL and perform the same steps as // before. Message streaming support: This API can also be used together with the -// StartContactStreaming -// (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) +// StartContactStreaming (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) // API to create a participant connection for chat contacts that are not using a // websocket. For more information about message streaming, Enable real-time chat -// message streaming -// (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) +// message streaming (https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) // in the Amazon Connect Administrator Guide. Feature specifications: For // information about feature specifications, such as the allowed number of open -// websocket connections per participant, see Feature specifications -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) +// websocket connections per participant, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) // in the Amazon Connect Administrator Guide. The Amazon Connect Participant -// Service APIs do not use Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) CreateParticipantConnection(ctx context.Context, params *CreateParticipantConnectionInput, optFns ...func(*Options)) (*CreateParticipantConnectionOutput, error) { if params == nil { params = &CreateParticipantConnectionInput{} @@ -52,8 +49,7 @@ func (c *Client) CreateParticipantConnection(ctx context.Context, params *Create type CreateParticipantConnectionInput struct { // This is a header parameter. The ParticipantToken as obtained from - // StartChatContact - // (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) + // StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) // API response. // // This member is required. @@ -65,7 +61,7 @@ type CreateParticipantConnectionInput struct { ConnectParticipant *bool // Type of connection information required. This can be omitted if - // ConnectParticipant is true. + // ConnectParticipant is true . Type []types.ConnectionType noSmithyDocumentSerde diff --git a/service/connectparticipant/api_op_DisconnectParticipant.go b/service/connectparticipant/api_op_DisconnectParticipant.go index bdbb4f23f84..a6402983b11 100644 --- a/service/connectparticipant/api_op_DisconnectParticipant.go +++ b/service/connectparticipant/api_op_DisconnectParticipant.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disconnects a participant. ConnectionToken is used for invoking this API instead -// of ParticipantToken. The Amazon Connect Participant Service APIs do not use -// Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// Disconnects a participant. ConnectionToken is used for invoking this API +// instead of ParticipantToken . The Amazon Connect Participant Service APIs do not +// use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) DisconnectParticipant(ctx context.Context, params *DisconnectParticipantInput, optFns ...func(*Options)) (*DisconnectParticipantOutput, error) { if params == nil { params = &DisconnectParticipantInput{} @@ -40,8 +40,8 @@ type DisconnectParticipantInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connectparticipant/api_op_GetAttachment.go b/service/connectparticipant/api_op_GetAttachment.go index b02277daf4f..8a39fa93e98 100644 --- a/service/connectparticipant/api_op_GetAttachment.go +++ b/service/connectparticipant/api_op_GetAttachment.go @@ -12,9 +12,9 @@ import ( // Provides a pre-signed URL for download of a completed attachment. This is an // asynchronous API for use with active contacts. ConnectionToken is used for -// invoking this API instead of ParticipantToken. The Amazon Connect Participant -// Service APIs do not use Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// invoking this API instead of ParticipantToken . The Amazon Connect Participant +// Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) GetAttachment(ctx context.Context, params *GetAttachmentInput, optFns ...func(*Options)) (*GetAttachmentOutput, error) { if params == nil { params = &GetAttachmentInput{} @@ -48,8 +48,8 @@ type GetAttachmentInput struct { type GetAttachmentOutput struct { // This is the pre-signed URL that can be used for uploading the file to Amazon S3 - // when used in response to StartAttachmentUpload - // (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html). + // when used in response to StartAttachmentUpload (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html) + // . Url *string // The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 diff --git a/service/connectparticipant/api_op_GetTranscript.go b/service/connectparticipant/api_op_GetTranscript.go index f9b0a8bd710..5119c70e419 100644 --- a/service/connectparticipant/api_op_GetTranscript.go +++ b/service/connectparticipant/api_op_GetTranscript.go @@ -14,12 +14,11 @@ import ( // Retrieves a transcript of the session, including details about any attachments. // For information about accessing past chat contact transcripts for a persistent -// chat, see Enable persistent chat -// (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). -// ConnectionToken is used for invoking this API instead of ParticipantToken. The -// Amazon Connect Participant Service APIs do not use Signature Version 4 -// authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// chat, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) +// . ConnectionToken is used for invoking this API instead of ParticipantToken . +// The Amazon Connect Participant Service APIs do not use Signature Version 4 +// authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) GetTranscript(ctx context.Context, params *GetTranscriptInput, optFns ...func(*Options)) (*GetTranscriptOutput, error) { if params == nil { params = &GetTranscriptInput{} diff --git a/service/connectparticipant/api_op_SendEvent.go b/service/connectparticipant/api_op_SendEvent.go index a04251fbbec..c12edddc8c8 100644 --- a/service/connectparticipant/api_op_SendEvent.go +++ b/service/connectparticipant/api_op_SendEvent.go @@ -12,9 +12,9 @@ import ( ) // Sends an event. ConnectionToken is used for invoking this API instead of -// ParticipantToken. The Amazon Connect Participant Service APIs do not use -// Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// ParticipantToken . The Amazon Connect Participant Service APIs do not use +// Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) SendEvent(ctx context.Context, params *SendEventInput, optFns ...func(*Options)) (*SendEventOutput, error) { if params == nil { params = &SendEventInput{} @@ -38,18 +38,10 @@ type SendEventInput struct { ConnectionToken *string // The content type of the request. Supported types are: - // - // * - // application/vnd.amazonaws.connect.event.typing - // - // * - // application/vnd.amazonaws.connect.event.connection.acknowledged - // - // * - // application/vnd.amazonaws.connect.event.message.delivered - // - // * - // application/vnd.amazonaws.connect.event.message.read + // - application/vnd.amazonaws.connect.event.typing + // - application/vnd.amazonaws.connect.event.connection.acknowledged + // - application/vnd.amazonaws.connect.event.message.delivered + // - application/vnd.amazonaws.connect.event.message.read // // This member is required. ContentType *string @@ -57,8 +49,8 @@ type SendEventInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The content of the event to be sent (for example, message text). For content diff --git a/service/connectparticipant/api_op_SendMessage.go b/service/connectparticipant/api_op_SendMessage.go index dc61f4c8a34..5a2f01926c0 100644 --- a/service/connectparticipant/api_op_SendMessage.go +++ b/service/connectparticipant/api_op_SendMessage.go @@ -12,9 +12,9 @@ import ( ) // Sends a message. ConnectionToken is used for invoking this API instead of -// ParticipantToken. The Amazon Connect Participant Service APIs do not use -// Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// ParticipantToken . The Amazon Connect Participant Service APIs do not use +// Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error) { if params == nil { params = &SendMessageInput{} @@ -38,23 +38,19 @@ type SendMessageInput struct { ConnectionToken *string // The content of the message. - // - // * For text/plain and text/markdown, the Length - // Constraints are Minimum of 1, Maximum of 1024. - // - // * For application/json, the - // Length Constraints are Minimum of 1, Maximum of 12000. - // - // * For - // application/vnd.amazonaws.connect.message.interactive.response, the Length - // Constraints are Minimum of 1, Maximum of 12288. + // - For text/plain and text/markdown , the Length Constraints are Minimum of 1, + // Maximum of 1024. + // - For application/json , the Length Constraints are Minimum of 1, Maximum of + // 12000. + // - For application/vnd.amazonaws.connect.message.interactive.response , the + // Length Constraints are Minimum of 1, Maximum of 12288. // // This member is required. Content *string - // The type of the content. Supported types are text/plain, text/markdown, - // application/json, and - // application/vnd.amazonaws.connect.message.interactive.response. + // The type of the content. Supported types are text/plain , text/markdown , + // application/json , and + // application/vnd.amazonaws.connect.message.interactive.response . // // This member is required. ContentType *string @@ -62,8 +58,8 @@ type SendMessageInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/connectparticipant/api_op_StartAttachmentUpload.go b/service/connectparticipant/api_op_StartAttachmentUpload.go index 7ca6d88dc38..85a9adda002 100644 --- a/service/connectparticipant/api_op_StartAttachmentUpload.go +++ b/service/connectparticipant/api_op_StartAttachmentUpload.go @@ -13,10 +13,10 @@ import ( ) // Provides a pre-signed Amazon S3 URL in response for uploading the file directly -// to S3. ConnectionToken is used for invoking this API instead of -// ParticipantToken. The Amazon Connect Participant Service APIs do not use -// Signature Version 4 authentication -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// to S3. ConnectionToken is used for invoking this API instead of ParticipantToken +// . The Amazon Connect Participant Service APIs do not use Signature Version 4 +// authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) StartAttachmentUpload(ctx context.Context, params *StartAttachmentUploadInput, optFns ...func(*Options)) (*StartAttachmentUploadOutput, error) { if params == nil { params = &StartAttachmentUploadInput{} @@ -47,8 +47,8 @@ type StartAttachmentUploadInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . // // This member is required. ClientToken *string @@ -59,9 +59,8 @@ type StartAttachmentUploadInput struct { ConnectionToken *string // Describes the MIME file type of the attachment. For a list of supported file - // types, see Feature specifications - // (https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html) in - // the Amazon Connect Administrator Guide. + // types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html) + // in the Amazon Connect Administrator Guide. // // This member is required. ContentType *string diff --git a/service/connectparticipant/types/enums.go b/service/connectparticipant/types/enums.go index 9274801f546..b7cfead0a02 100644 --- a/service/connectparticipant/types/enums.go +++ b/service/connectparticipant/types/enums.go @@ -40,9 +40,9 @@ const ( ChatItemTypeMessageRead ChatItemType = "MESSAGE_READ" ) -// Values returns all known values for ChatItemType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChatItemType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChatItemType) Values() []ChatItemType { return []ChatItemType{ "TYPING", diff --git a/service/connectparticipant/types/types.go b/service/connectparticipant/types/types.go index 0a191138060..28b2eb21035 100644 --- a/service/connectparticipant/types/types.go +++ b/service/connectparticipant/types/types.go @@ -17,9 +17,8 @@ type AttachmentItem struct { AttachmentName *string // Describes the MIME file type of the attachment. For a list of supported file - // types, see Feature specifications - // (https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html) in - // the Amazon Connect Administrator Guide. + // types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html) + // in the Amazon Connect Administrator Guide. ContentType *string // Status of the attachment. @@ -79,8 +78,8 @@ type Item struct { // The contactId on which the transcript item was originally sent. This field is // only populated for persistent chats when the transcript item is from the past - // chat session. For more information, see Enable persistent chat - // (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). + // chat session. For more information, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) + // . RelatedContactId *string // Type of the item: message or event. @@ -140,8 +139,8 @@ type UploadMetadata struct { HeadersToInclude map[string]string // This is the pre-signed URL that can be used for uploading the file to Amazon S3 - // when used in response to StartAttachmentUpload - // (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html). + // when used in response to StartAttachmentUpload (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html) + // . Url *string // The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 diff --git a/service/controltower/api_client.go b/service/controltower/api_client.go index c656588815e..eaba07911ff 100644 --- a/service/controltower/api_client.go +++ b/service/controltower/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/controltower/api_op_ListEnabledControls.go b/service/controltower/api_op_ListEnabledControls.go index 5d931f66888..9575f9a89be 100644 --- a/service/controltower/api_op_ListEnabledControls.go +++ b/service/controltower/api_op_ListEnabledControls.go @@ -54,8 +54,8 @@ type ListEnabledControlsOutput struct { // This member is required. EnabledControls []types.EnabledControlSummary - // Retrieves the next page of results. If the string is empty, the current response - // is the end of the results. + // Retrieves the next page of results. If the string is empty, the current + // response is the end of the results. NextToken *string // Metadata pertaining to the operation's result. @@ -127,8 +127,8 @@ func (c *Client) addOperationListEnabledControlsMiddlewares(stack *middleware.St return nil } -// ListEnabledControlsAPIClient is a client that implements the ListEnabledControls -// operation. +// ListEnabledControlsAPIClient is a client that implements the +// ListEnabledControls operation. type ListEnabledControlsAPIClient interface { ListEnabledControls(context.Context, *ListEnabledControlsInput, ...func(*Options)) (*ListEnabledControlsOutput, error) } diff --git a/service/controltower/doc.go b/service/controltower/doc.go index c63d2ae306b..07c8d70904f 100644 --- a/service/controltower/doc.go +++ b/service/controltower/doc.go @@ -5,22 +5,15 @@ // // These interfaces allow you to apply the AWS library of pre-defined controls to // your organizational units, programmatically. In this context, controls are the -// same as AWS Control Tower guardrails. To call these APIs, you'll need to -// know: -// -// * the ControlARN for the control--that is, the guardrail--you are -// targeting, -// -// * and the ARN associated with the target organizational unit -// (OU). -// -// To get the ControlARN for your AWS Control Tower guardrail: The -// ControlARN contains the control name which is specified in each guardrail. For a -// list of control names for Strongly recommended and Elective guardrails, see -// Resource identifiers for APIs and guardrails -// (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html) -// in the Automating tasks section -// (https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html) +// same as AWS Control Tower guardrails. To call these APIs, you'll need to know: +// - the ControlARN for the control--that is, the guardrail--you are targeting, +// - and the ARN associated with the target organizational unit (OU). +// +// To get the ControlARN for your AWS Control Tower guardrail: The ControlARN +// contains the control name which is specified in each guardrail. For a list of +// control names for Strongly recommended and Elective guardrails, see Resource +// identifiers for APIs and guardrails (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html) +// in the Automating tasks section (https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html) // of the AWS Control Tower User Guide. Remember that Mandatory guardrails cannot // be added or removed. ARN format: // arn:aws:controltower:{REGION}::control/{CONTROL_NAME} Example: @@ -30,33 +23,19 @@ // ARN format: // arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId} // Details and examples +// - List of resource identifiers for APIs and guardrails (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) +// - Guardrail API examples (CLI) (https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html) +// - Enable controls with AWS CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html) +// - Creating AWS Control Tower resources with AWS CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html) // -// * List of resource identifiers for APIs and guardrails -// (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) -// -// * -// Guardrail API examples (CLI) -// (https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html) -// -// * -// Enable controls with AWS CloudFormation -// (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html) -// -// * -// Creating AWS Control Tower resources with AWS CloudFormation -// (https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html) -// -// To -// view the open source resource repository on GitHub, see -// aws-cloudformation/aws-cloudformation-resource-providers-controltower -// (https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower) +// To view the open source resource repository on GitHub, see +// aws-cloudformation/aws-cloudformation-resource-providers-controltower (https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower) // Recording API Requests AWS Control Tower supports AWS CloudTrail, a service that // records AWS API calls for your AWS account and delivers log files to an Amazon // S3 bucket. By using information collected by CloudTrail, you can determine which // requests the AWS Control Tower service received, who made the request and when, // and so on. For more about AWS Control Tower and its support for CloudTrail, see -// Logging AWS Control Tower Actions with AWS CloudTrail -// (https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html) +// Logging AWS Control Tower Actions with AWS CloudTrail (https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html) // in the AWS Control Tower User Guide. To learn more about CloudTrail, including // how to turn it on and find your log files, see the AWS CloudTrail User Guide. package controltower diff --git a/service/controltower/types/types.go b/service/controltower/types/types.go index e579b58a43c..b9c771e19e1 100644 --- a/service/controltower/types/types.go +++ b/service/controltower/types/types.go @@ -13,17 +13,17 @@ type ControlOperation struct { // The time that the operation finished. EndTime *time.Time - // One of ENABLE_CONTROL or DISABLE_CONTROL. + // One of ENABLE_CONTROL or DISABLE_CONTROL . OperationType ControlOperationType // The time that the operation began. StartTime *time.Time - // One of IN_PROGRESS, SUCEEDED, or FAILED. + // One of IN_PROGRESS , SUCEEDED , or FAILED . Status ControlOperationStatus - // If the operation result is FAILED, this string contains a message explaining why - // the operation failed. + // If the operation result is FAILED , this string contains a message explaining + // why the operation failed. StatusMessage *string noSmithyDocumentSerde diff --git a/service/costandusagereportservice/api_client.go b/service/costandusagereportservice/api_client.go index e480a9b88e6..93baeb6b93e 100644 --- a/service/costandusagereportservice/api_client.go +++ b/service/costandusagereportservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/costandusagereportservice/api_op_DeleteReportDefinition.go b/service/costandusagereportservice/api_op_DeleteReportDefinition.go index a77e4c05124..0e2e44a203d 100644 --- a/service/costandusagereportservice/api_op_DeleteReportDefinition.go +++ b/service/costandusagereportservice/api_op_DeleteReportDefinition.go @@ -29,8 +29,8 @@ func (c *Client) DeleteReportDefinition(ctx context.Context, params *DeleteRepor // Deletes the specified report. type DeleteReportDefinitionInput struct { - // The name of the report that you want to delete. The name must be unique, is case - // sensitive, and can't include spaces. + // The name of the report that you want to delete. The name must be unique, is + // case sensitive, and can't include spaces. ReportName *string noSmithyDocumentSerde diff --git a/service/costandusagereportservice/api_op_ModifyReportDefinition.go b/service/costandusagereportservice/api_op_ModifyReportDefinition.go index a9cedcd621b..f6a260d7683 100644 --- a/service/costandusagereportservice/api_op_ModifyReportDefinition.go +++ b/service/costandusagereportservice/api_op_ModifyReportDefinition.go @@ -36,8 +36,8 @@ type ModifyReportDefinitionInput struct { // This member is required. ReportDefinition *types.ReportDefinition - // The name of the report that you want to create. The name must be unique, is case - // sensitive, and can't include spaces. + // The name of the report that you want to create. The name must be unique, is + // case sensitive, and can't include spaces. // // This member is required. ReportName *string diff --git a/service/costandusagereportservice/api_op_PutReportDefinition.go b/service/costandusagereportservice/api_op_PutReportDefinition.go index 93c0953f7ac..279ee6eaa22 100644 --- a/service/costandusagereportservice/api_op_PutReportDefinition.go +++ b/service/costandusagereportservice/api_op_PutReportDefinition.go @@ -30,8 +30,8 @@ func (c *Client) PutReportDefinition(ctx context.Context, params *PutReportDefin // Creates a Cost and Usage Report. type PutReportDefinitionInput struct { - // Represents the output of the PutReportDefinition operation. The content consists - // of the detailed metadata and data file information. + // Represents the output of the PutReportDefinition operation. The content + // consists of the detailed metadata and data file information. // // This member is required. ReportDefinition *types.ReportDefinition @@ -39,8 +39,8 @@ type PutReportDefinitionInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type PutReportDefinitionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/costandusagereportservice/doc.go b/service/costandusagereportservice/doc.go index f3d64d14cab..4ab7e16dbfa 100644 --- a/service/costandusagereportservice/doc.go +++ b/service/costandusagereportservice/doc.go @@ -3,14 +3,13 @@ // Package costandusagereportservice provides the API client, operations, and // parameter types for AWS Cost and Usage Report Service. // -// The AWS Cost and Usage Report API enables you to programmatically create, query, -// and delete AWS Cost and Usage report definitions. AWS Cost and Usage reports -// track the monthly AWS costs and usage associated with your AWS account. The -// report contains line items for each unique combination of AWS product, usage +// The AWS Cost and Usage Report API enables you to programmatically create, +// query, and delete AWS Cost and Usage report definitions. AWS Cost and Usage +// reports track the monthly AWS costs and usage associated with your AWS account. +// The report contains line items for each unique combination of AWS product, usage // type, and operation that your AWS account uses. You can configure the AWS Cost // and Usage report to show only the data that you want, using the AWS Cost and // Usage API. Service Endpoint The AWS Cost and Usage Report API provides the // following endpoint: -// -// * cur.us-east-1.amazonaws.com +// - cur.us-east-1.amazonaws.com package costandusagereportservice diff --git a/service/costandusagereportservice/types/enums.go b/service/costandusagereportservice/types/enums.go index 8b90332543f..81f404bdf99 100644 --- a/service/costandusagereportservice/types/enums.go +++ b/service/costandusagereportservice/types/enums.go @@ -54,9 +54,9 @@ const ( AWSRegionNingxia AWSRegion = "cn-northwest-1" ) -// Values returns all known values for AWSRegion. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AWSRegion. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AWSRegion) Values() []AWSRegion { return []AWSRegion{ "af-south-1", @@ -116,9 +116,9 @@ const ( ReportFormatParquet ReportFormat = "Parquet" ) -// Values returns all known values for ReportFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReportFormat) Values() []ReportFormat { return []ReportFormat{ "textORcsv", diff --git a/service/costandusagereportservice/types/errors.go b/service/costandusagereportservice/types/errors.go index 671e93bddde..626faf11900 100644 --- a/service/costandusagereportservice/types/errors.go +++ b/service/costandusagereportservice/types/errors.go @@ -34,8 +34,8 @@ func (e *DuplicateReportNameException) ErrorCode() string { } func (e *DuplicateReportNameException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An error on the server occurred during the processing of your request. Try again -// later. +// An error on the server occurred during the processing of your request. Try +// again later. type InternalErrorException struct { Message *string diff --git a/service/costandusagereportservice/types/types.go b/service/costandusagereportservice/types/types.go index e70e84c1527..a3f32dfe472 100644 --- a/service/costandusagereportservice/types/types.go +++ b/service/costandusagereportservice/types/types.go @@ -27,8 +27,8 @@ type ReportDefinition struct { // This member is required. Format ReportFormat - // The name of the report that you want to create. The name must be unique, is case - // sensitive, and can't include spaces. + // The name of the report that you want to create. The name must be unique, is + // case sensitive, and can't include spaces. // // This member is required. ReportName *string @@ -61,9 +61,9 @@ type ReportDefinition struct { // the billing view service public APIs. BillingViewArn *string - // Whether you want Amazon Web Services to update your reports after they have been - // finalized if Amazon Web Services detects charges related to previous months. - // These charges can include refunds, credits, or support fees. + // Whether you want Amazon Web Services to update your reports after they have + // been finalized if Amazon Web Services detects charges related to previous + // months. These charges can include refunds, credits, or support fees. RefreshClosedReports *bool // Whether you want Amazon Web Services to overwrite the previous version of each diff --git a/service/costexplorer/api_client.go b/service/costexplorer/api_client.go index c384ef9e766..5b3adaf7bc0 100644 --- a/service/costexplorer/api_client.go +++ b/service/costexplorer/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/costexplorer/api_op_CreateAnomalyMonitor.go b/service/costexplorer/api_op_CreateAnomalyMonitor.go index e498f896203..7aa2be120de 100644 --- a/service/costexplorer/api_op_CreateAnomalyMonitor.go +++ b/service/costexplorer/api_op_CreateAnomalyMonitor.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cost anomaly detection monitor with the requested type and monitor -// specification. +// Creates a new cost anomaly detection monitor with the requested type and +// monitor specification. func (c *Client) CreateAnomalyMonitor(ctx context.Context, params *CreateAnomalyMonitorInput, optFns ...func(*Options)) (*CreateAnomalyMonitorOutput, error) { if params == nil { params = &CreateAnomalyMonitorInput{} @@ -35,33 +35,21 @@ type CreateAnomalyMonitorInput struct { // This member is required. AnomalyMonitor *types.AnomalyMonitor - // An optional list of tags to associate with the specified AnomalyMonitor - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html). - // You can use resource tags to control access to your monitor using IAM policies. - // Each tag consists of a key and a value, and each key must be unique for the - // resource. The following restrictions apply to resource tags: - // - // * Although the - // maximum number of array members is 200, you can assign a maximum of 50 user-tags - // to one resource. The remaining are reserved for Amazon Web Services use - // - // * The - // maximum length of a key is 128 characters - // - // * The maximum length of a value is - // 256 characters - // - // * Keys and values can only contain alphanumeric characters, - // spaces, and any of the following: _.:/=+@- - // - // * Keys and values are case - // sensitive - // - // * Keys and values are trimmed for any leading or trailing - // whitespaces - // - // * Don’t use aws: as a prefix for your keys. This prefix is reserved - // for Amazon Web Services use + // An optional list of tags to associate with the specified AnomalyMonitor (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) + // . You can use resource tags to control access to your monitor using IAM + // policies. Each tag consists of a key and a value, and each key must be unique + // for the resource. The following restrictions apply to resource tags: + // - Although the maximum number of array members is 200, you can assign a + // maximum of 50 user-tags to one resource. The remaining are reserved for Amazon + // Web Services use + // - The maximum length of a key is 128 characters + // - The maximum length of a value is 256 characters + // - Keys and values can only contain alphanumeric characters, spaces, and any + // of the following: _.:/=+@- + // - Keys and values are case sensitive + // - Keys and values are trimmed for any leading or trailing whitespaces + // - Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon + // Web Services use ResourceTags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_CreateAnomalySubscription.go b/service/costexplorer/api_op_CreateAnomalySubscription.go index d2ad6ee5d31..0c82447d77d 100644 --- a/service/costexplorer/api_op_CreateAnomalySubscription.go +++ b/service/costexplorer/api_op_CreateAnomalySubscription.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds an alert subscription to a cost anomaly detection monitor. You can use each -// subscription to define subscribers with email or SNS notifications. Email +// Adds an alert subscription to a cost anomaly detection monitor. You can use +// each subscription to define subscribers with email or SNS notifications. Email // subscribers can set an absolute or percentage threshold and a time frequency for // receiving notifications. func (c *Client) CreateAnomalySubscription(ctx context.Context, params *CreateAnomalySubscriptionInput, optFns ...func(*Options)) (*CreateAnomalySubscriptionOutput, error) { @@ -37,33 +37,21 @@ type CreateAnomalySubscriptionInput struct { // This member is required. AnomalySubscription *types.AnomalySubscription - // An optional list of tags to associate with the specified AnomalySubscription - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html). - // You can use resource tags to control access to your subscription using IAM + // An optional list of tags to associate with the specified AnomalySubscription (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) + // . You can use resource tags to control access to your subscription using IAM // policies. Each tag consists of a key and a value, and each key must be unique // for the resource. The following restrictions apply to resource tags: - // - // * Although - // the maximum number of array members is 200, you can assign a maximum of 50 - // user-tags to one resource. The remaining are reserved for Amazon Web Services - // use - // - // * The maximum length of a key is 128 characters - // - // * The maximum length of a - // value is 256 characters - // - // * Keys and values can only contain alphanumeric - // characters, spaces, and any of the following: _.:/=+@- - // - // * Keys and values are - // case sensitive - // - // * Keys and values are trimmed for any leading or trailing - // whitespaces - // - // * Don’t use aws: as a prefix for your keys. This prefix is reserved - // for Amazon Web Services use + // - Although the maximum number of array members is 200, you can assign a + // maximum of 50 user-tags to one resource. The remaining are reserved for Amazon + // Web Services use + // - The maximum length of a key is 128 characters + // - The maximum length of a value is 256 characters + // - Keys and values can only contain alphanumeric characters, spaces, and any + // of the following: _.:/=+@- + // - Keys and values are case sensitive + // - Keys and values are trimmed for any leading or trailing whitespaces + // - Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon + // Web Services use ResourceTags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_CreateCostCategoryDefinition.go b/service/costexplorer/api_op_CreateCostCategoryDefinition.go index 8d4362c95e6..9588100f534 100644 --- a/service/costexplorer/api_op_CreateCostCategoryDefinition.go +++ b/service/costexplorer/api_op_CreateCostCategoryDefinition.go @@ -40,8 +40,8 @@ type CreateCostCategoryDefinitionInput struct { RuleVersion types.CostCategoryRuleVersion // The Cost Category rules used to categorize costs. For more information, see - // CostCategoryRule - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html). + // CostCategoryRule (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) + // . // // This member is required. Rules []types.CostCategoryRule @@ -55,33 +55,21 @@ type CreateCostCategoryDefinitionInput struct { // future. EffectiveStart *string - // An optional list of tags to associate with the specified CostCategory - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html). - // You can use resource tags to control access to your cost category using IAM + // An optional list of tags to associate with the specified CostCategory (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html) + // . You can use resource tags to control access to your cost category using IAM // policies. Each tag consists of a key and a value, and each key must be unique // for the resource. The following restrictions apply to resource tags: - // - // * Although - // the maximum number of array members is 200, you can assign a maximum of 50 - // user-tags to one resource. The remaining are reserved for Amazon Web Services - // use - // - // * The maximum length of a key is 128 characters - // - // * The maximum length of a - // value is 256 characters - // - // * Keys and values can only contain alphanumeric - // characters, spaces, and any of the following: _.:/=+@- - // - // * Keys and values are - // case sensitive - // - // * Keys and values are trimmed for any leading or trailing - // whitespaces - // - // * Don’t use aws: as a prefix for your keys. This prefix is reserved - // for Amazon Web Services use + // - Although the maximum number of array members is 200, you can assign a + // maximum of 50 user-tags to one resource. The remaining are reserved for Amazon + // Web Services use + // - The maximum length of a key is 128 characters + // - The maximum length of a value is 256 characters + // - Keys and values can only contain alphanumeric characters, spaces, and any + // of the following: _.:/=+@- + // - Keys and values are case sensitive + // - Keys and values are trimmed for any leading or trailing whitespaces + // - Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon + // Web Services use ResourceTags []types.ResourceTag // The split charge rules used to allocate your charges between your Cost Category diff --git a/service/costexplorer/api_op_DeleteCostCategoryDefinition.go b/service/costexplorer/api_op_DeleteCostCategoryDefinition.go index 18c17f93254..4d39a9e02ad 100644 --- a/service/costexplorer/api_op_DeleteCostCategoryDefinition.go +++ b/service/costexplorer/api_op_DeleteCostCategoryDefinition.go @@ -42,8 +42,8 @@ type DeleteCostCategoryDefinitionOutput struct { // The unique identifier for your Cost Category. CostCategoryArn *string - // The effective end date of the Cost Category as a result of deleting it. No costs - // after this date is categorized by the deleted Cost Category. + // The effective end date of the Cost Category as a result of deleting it. No + // costs after this date is categorized by the deleted Cost Category. EffectiveEnd *string // Metadata pertaining to the operation's result. diff --git a/service/costexplorer/api_op_DescribeCostCategoryDefinition.go b/service/costexplorer/api_op_DescribeCostCategoryDefinition.go index 268161bd478..bb0a7db7242 100644 --- a/service/costexplorer/api_op_DescribeCostCategoryDefinition.go +++ b/service/costexplorer/api_op_DescribeCostCategoryDefinition.go @@ -47,8 +47,8 @@ type DescribeCostCategoryDefinitionInput struct { type DescribeCostCategoryDefinitionOutput struct { - // The structure of Cost Categories. This includes detailed metadata and the set of - // rules for the CostCategory object. + // The structure of Cost Categories. This includes detailed metadata and the set + // of rules for the CostCategory object. CostCategory *types.CostCategory // Metadata pertaining to the operation's result. diff --git a/service/costexplorer/api_op_GetAnomalies.go b/service/costexplorer/api_op_GetAnomalies.go index b7dbe073fce..15f4bb5de33 100644 --- a/service/costexplorer/api_op_GetAnomalies.go +++ b/service/costexplorer/api_op_GetAnomalies.go @@ -43,8 +43,8 @@ type GetAnomaliesInput struct { // The number of entries a paginated response contains. MaxResults *int32 - // Retrieves all of the cost anomalies detected for a specific cost anomaly monitor - // Amazon Resource Name (ARN). + // Retrieves all of the cost anomalies detected for a specific cost anomaly + // monitor Amazon Resource Name (ARN). MonitorArn *string // The token to retrieve the next set of results. Amazon Web Services provides the diff --git a/service/costexplorer/api_op_GetAnomalySubscriptions.go b/service/costexplorer/api_op_GetAnomalySubscriptions.go index 094b8527836..7769c4be85f 100644 --- a/service/costexplorer/api_op_GetAnomalySubscriptions.go +++ b/service/costexplorer/api_op_GetAnomalySubscriptions.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the cost anomaly subscription objects for your account. You can filter -// using a list of cost anomaly monitor Amazon Resource Names (ARNs). +// Retrieves the cost anomaly subscription objects for your account. You can +// filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). func (c *Client) GetAnomalySubscriptions(ctx context.Context, params *GetAnomalySubscriptionsInput, optFns ...func(*Options)) (*GetAnomalySubscriptionsOutput, error) { if params == nil { params = &GetAnomalySubscriptionsInput{} diff --git a/service/costexplorer/api_op_GetCostAndUsage.go b/service/costexplorer/api_op_GetCostAndUsage.go index 045394f37b8..81c3f409e81 100644 --- a/service/costexplorer/api_op_GetCostAndUsage.go +++ b/service/costexplorer/api_op_GetCostAndUsage.go @@ -13,14 +13,12 @@ import ( // Retrieves cost and usage metrics for your account. You can specify which cost // and usage-related metric that you want the request to return. For example, you -// can specify BlendedCosts or UsageQuantity. You can also filter and group your -// data by various dimensions, such as SERVICE or AZ, in a specific time range. For -// a complete list of valid dimensions, see the GetDimensionValues -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) +// can specify BlendedCosts or UsageQuantity . You can also filter and group your +// data by various dimensions, such as SERVICE or AZ , in a specific time range. +// For a complete list of valid dimensions, see the GetDimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) // operation. Management account in an organization in Organizations have access to // all member accounts. For information about filter limitations, see Quotas and -// restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html) +// restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html) // in the Billing and Cost Management User Guide. func (c *Client) GetCostAndUsage(ctx context.Context, params *GetCostAndUsageInput, optFns ...func(*Options)) (*GetCostAndUsageOutput, error) { if params == nil { @@ -39,33 +37,32 @@ func (c *Client) GetCostAndUsage(ctx context.Context, params *GetCostAndUsageInp type GetCostAndUsageInput struct { - // Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If - // Granularity isn't set, the response object doesn't include the Granularity, - // either MONTHLY or DAILY, or HOURLY. + // Sets the Amazon Web Services cost granularity to MONTHLY or DAILY , or HOURLY . + // If Granularity isn't set, the response object doesn't include the Granularity , + // either MONTHLY or DAILY , or HOURLY . // // This member is required. Granularity types.Granularity // Which metrics are returned in the query. For more information about blended and - // unblended rates, see Why does the "blended" annotation appear on some line items - // in my bill? - // (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/). - // Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, - // NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the - // UsageQuantity metric, the service aggregates all usage numbers without taking - // into account the units. For example, if you aggregate usageQuantity across all - // of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours - // and data transfer are measured in different units (for example, hours and GB). - // To get more meaningful UsageQuantity metrics, filter by UsageType or - // UsageTypeGroups. Metrics is required for GetCostAndUsage requests. + // unblended rates, see Why does the "blended" annotation appear on some line + // items in my bill? (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/) + // . Valid values are AmortizedCost , BlendedCost , NetAmortizedCost , + // NetUnblendedCost , NormalizedUsageAmount , UnblendedCost , and UsageQuantity . + // If you return the UsageQuantity metric, the service aggregates all usage + // numbers without taking into account the units. For example, if you aggregate + // usageQuantity across all of Amazon EC2, the results aren't meaningful because + // Amazon EC2 compute hours and data transfer are measured in different units (for + // example, hours and GB). To get more meaningful UsageQuantity metrics, filter by + // UsageType or UsageTypeGroups . Metrics is required for GetCostAndUsage requests. // // This member is required. Metrics []string // Sets the start date and end date for retrieving Amazon Web Services costs. The - // start date is inclusive, but the end date is exclusive. For example, if start is - // 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from - // 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. + // start date is inclusive, but the end date is exclusive. For example, if start + // is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved + // from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval @@ -73,19 +70,19 @@ type GetCostAndUsageInput struct { // Filters Amazon Web Services costs by different dimensions. For example, you can // specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with // that account's usage of that service. You can nest Expression objects to define - // any combination of dimension filters. For more information, see Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html). - // Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE. - // Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, - // and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE. + // any combination of dimension filters. For more information, see Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // . Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE . + // Valid values for MatchOptions for CostCategories and Tags are EQUALS , ABSENT , + // and CASE_SENSITIVE . Default values are EQUALS and CASE_SENSITIVE . Filter *types.Expression - // You can group Amazon Web Services costs using up to two different groups, either - // dimensions, tag keys, cost categories, or any two group by types. Valid values - // for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, - // INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, - // TENANCY, RECORD_TYPE, and USAGE_TYPE. When you group by the TAG type and include - // a valid tag key, you get all tag values, including empty strings. + // You can group Amazon Web Services costs using up to two different groups, + // either dimensions, tag keys, cost categories, or any two group by types. Valid + // values for the DIMENSION type are AZ , INSTANCE_TYPE , LEGAL_ENTITY_NAME , + // INVOICING_ENTITY , LINKED_ACCOUNT , OPERATION , PLATFORM , PURCHASE_TYPE , + // SERVICE , TENANCY , RECORD_TYPE , and USAGE_TYPE . When you group by the TAG + // type and include a valid tag key, you get all tag values, including empty + // strings. GroupBy []types.GroupDefinition // The token to retrieve the next set of results. Amazon Web Services provides the diff --git a/service/costexplorer/api_op_GetCostAndUsageWithResources.go b/service/costexplorer/api_op_GetCostAndUsageWithResources.go index 8a1ef7c200c..8522e04334c 100644 --- a/service/costexplorer/api_op_GetCostAndUsageWithResources.go +++ b/service/costexplorer/api_op_GetCostAndUsageWithResources.go @@ -13,17 +13,15 @@ import ( // Retrieves cost and usage metrics with resources for your account. You can // specify which cost and usage-related metric, such as BlendedCosts or -// UsageQuantity, that you want the request to return. You can also filter and -// group your data by various dimensions, such as SERVICE or AZ, in a specific time -// range. For a complete list of valid dimensions, see the GetDimensionValues -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) +// UsageQuantity , that you want the request to return. You can also filter and +// group your data by various dimensions, such as SERVICE or AZ , in a specific +// time range. For a complete list of valid dimensions, see the GetDimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) // operation. Management account in an organization in Organizations have access to // all member accounts. This API is currently available for the Amazon Elastic // Compute Cloud – Compute service only. This is an opt-in only feature. You can // enable this feature from the Cost Explorer Settings page. For information about -// how to access the Settings page, see Controlling Access for Cost Explorer -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html) in -// the Billing and Cost Management User Guide. +// how to access the Settings page, see Controlling Access for Cost Explorer (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html) +// in the Billing and Cost Management User Guide. func (c *Client) GetCostAndUsageWithResources(ctx context.Context, params *GetCostAndUsageWithResourcesInput, optFns ...func(*Options)) (*GetCostAndUsageWithResourcesOutput, error) { if params == nil { params = &GetCostAndUsageWithResourcesInput{} @@ -44,52 +42,50 @@ type GetCostAndUsageWithResourcesInput struct { // Filters Amazon Web Services costs by different dimensions. For example, you can // specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with // that account's usage of that service. You can nest Expression objects to define - // any combination of dimension filters. For more information, see Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html). - // The GetCostAndUsageWithResources operation requires that you either group by or - // filter by a ResourceId. It requires the Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html)"SERVICE - // = Amazon Elastic Compute Cloud - Compute" in the filter. Valid values for - // MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE. Valid values for - // MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. - // Default values are EQUALS and CASE_SENSITIVE. + // any combination of dimension filters. For more information, see Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // . The GetCostAndUsageWithResources operation requires that you either group by + // or filter by a ResourceId . It requires the Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter. Valid values + // for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE . Valid values for + // MatchOptions for CostCategories and Tags are EQUALS , ABSENT , and + // CASE_SENSITIVE . Default values are EQUALS and CASE_SENSITIVE . // // This member is required. Filter *types.Expression - // Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If - // Granularity isn't set, the response object doesn't include the Granularity, - // MONTHLY, DAILY, or HOURLY. + // Sets the Amazon Web Services cost granularity to MONTHLY , DAILY , or HOURLY . + // If Granularity isn't set, the response object doesn't include the Granularity , + // MONTHLY , DAILY , or HOURLY . // // This member is required. Granularity types.Granularity - // Sets the start and end dates for retrieving Amazon Web Services costs. The range - // must be within the last 14 days (the start date cannot be earlier than 14 days - // ago). The start date is inclusive, but the end date is exclusive. For example, - // if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is - // retrieved from 2017-01-01 up to and including 2017-04-30 but not including - // 2017-05-01. + // Sets the start and end dates for retrieving Amazon Web Services costs. The + // range must be within the last 14 days (the start date cannot be earlier than 14 + // days ago). The start date is inclusive, but the end date is exclusive. For + // example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage + // data is retrieved from 2017-01-01 up to and including 2017-04-30 but not + // including 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval // You can group Amazon Web Services costs using up to two different groups: - // DIMENSION, TAG, COST_CATEGORY. + // DIMENSION , TAG , COST_CATEGORY . GroupBy []types.GroupDefinition // Which metrics are returned in the query. For more information about blended and - // unblended rates, see Why does the "blended" annotation appear on some line items - // in my bill? - // (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/). - // Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, - // NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the - // UsageQuantity metric, the service aggregates all usage numbers without taking - // the units into account. For example, if you aggregate usageQuantity across all - // of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours - // and data transfer are measured in different units (for example, hour or GB). To - // get more meaningful UsageQuantity metrics, filter by UsageType or - // UsageTypeGroups. Metrics is required for GetCostAndUsageWithResources requests. + // unblended rates, see Why does the "blended" annotation appear on some line + // items in my bill? (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/) + // . Valid values are AmortizedCost , BlendedCost , NetAmortizedCost , + // NetUnblendedCost , NormalizedUsageAmount , UnblendedCost , and UsageQuantity . + // If you return the UsageQuantity metric, the service aggregates all usage + // numbers without taking the units into account. For example, if you aggregate + // usageQuantity across all of Amazon EC2, the results aren't meaningful because + // Amazon EC2 compute hours and data transfer are measured in different units (for + // example, hour or GB). To get more meaningful UsageQuantity metrics, filter by + // UsageType or UsageTypeGroups . Metrics is required for + // GetCostAndUsageWithResources requests. Metrics []string // The token to retrieve the next set of results. Amazon Web Services provides the diff --git a/service/costexplorer/api_op_GetCostCategories.go b/service/costexplorer/api_op_GetCostCategories.go index 4d72ef69597..b2ea45b3634 100644 --- a/service/costexplorer/api_op_GetCostCategories.go +++ b/service/costexplorer/api_op_GetCostCategories.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves an array of Cost Category names and values incurred cost. If some Cost -// Category names and values are not associated with any cost, they will not be -// returned by this API. +// Retrieves an array of Cost Category names and values incurred cost. If some +// Cost Category names and values are not associated with any cost, they will not +// be returned by this API. func (c *Client) GetCostCategories(ctx context.Context, params *GetCostCategoriesInput, optFns ...func(*Options)) (*GetCostCategoriesOutput, error) { if params == nil { params = &GetCostCategoriesInput{} @@ -39,91 +39,64 @@ type GetCostCategoriesInput struct { // The unique name of the Cost Category. CostCategoryName *string - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . Filter *types.Expression // This field is only used when the SortBy value is provided in the request. The // maximum number of objects that are returned for this request. If MaxResults // isn't specified with the SortBy value, the request returns 1000 results as the - // default value for this parameter. For GetCostCategories, MaxResults has an upper - // quota of 1000. + // default value for this parameter. For GetCostCategories , MaxResults has an + // upper quota of 1000. MaxResults int32 // If the number of objects that are still available for retrieval exceeds the @@ -133,33 +106,23 @@ type GetCostCategoriesInput struct { NextPageToken *string // The value that you want to search the filter values for. If you don't specify a - // CostCategoryName, SearchString is used to filter Cost Category names that match - // the SearchString pattern. If you specify a CostCategoryName, SearchString is - // used to filter Cost Category values that match the SearchString pattern. + // CostCategoryName , SearchString is used to filter Cost Category names that + // match the SearchString pattern. If you specify a CostCategoryName , SearchString + // is used to filter Cost Category values that match the SearchString pattern. SearchString *string // The value that you sort the data by. The key represents the cost and usage // metrics. The following values are supported: - // - // * BlendedCost - // - // * UnblendedCost - // - // * - // AmortizedCost - // - // * NetAmortizedCost - // - // * NetUnblendedCost - // - // * UsageQuantity - // - // * - // NormalizedUsageAmount - // - // The supported key values for the SortOrder value are - // ASCENDING and DESCENDING. When you use the SortBy value, the NextPageToken and - // SearchString key values aren't supported. + // - BlendedCost + // - UnblendedCost + // - AmortizedCost + // - NetAmortizedCost + // - NetUnblendedCost + // - UsageQuantity + // - NormalizedUsageAmount + // The supported key values for the SortOrder value are ASCENDING and DESCENDING . + // When you use the SortBy value, the NextPageToken and SearchString key values + // aren't supported. SortBy []types.SortDefinition noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_GetCostForecast.go b/service/costexplorer/api_op_GetCostForecast.go index 793c3708f04..1f2a3941f6c 100644 --- a/service/costexplorer/api_op_GetCostForecast.go +++ b/service/costexplorer/api_op_GetCostForecast.go @@ -39,20 +39,13 @@ type GetCostForecastInput struct { // Which metric Cost Explorer uses to create your forecast. For more information // about blended and unblended rates, see Why does the "blended" annotation appear - // on some line items in my bill? - // (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/). - // Valid values for a GetCostForecast call are the following: - // - // * AMORTIZED_COST - // - // * - // BLENDED_COST - // - // * NET_AMORTIZED_COST - // - // * NET_UNBLENDED_COST - // - // * UNBLENDED_COST + // on some line items in my bill? (http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/) + // . Valid values for a GetCostForecast call are the following: + // - AMORTIZED_COST + // - BLENDED_COST + // - NET_AMORTIZED_COST + // - NET_UNBLENDED_COST + // - UNBLENDED_COST // // This member is required. Metric types.Metric @@ -65,57 +58,29 @@ type GetCostForecastInput struct { // The filters that you want to use to filter your forecast. The GetCostForecast // API supports filtering by the following dimensions: - // - // * AZ - // - // * INSTANCE_TYPE - // - // * - // LINKED_ACCOUNT - // - // * LINKED_ACCOUNT_NAME - // - // * OPERATION - // - // * PURCHASE_TYPE - // - // * REGION - // - // * - // SERVICE - // - // * USAGE_TYPE - // - // * USAGE_TYPE_GROUP - // - // * RECORD_TYPE - // - // * OPERATING_SYSTEM - // - // * - // TENANCY - // - // * SCOPE - // - // * PLATFORM - // - // * SUBSCRIPTION_ID - // - // * LEGAL_ENTITY_NAME - // - // * - // DEPLOYMENT_OPTION - // - // * DATABASE_ENGINE - // - // * INSTANCE_TYPE_FAMILY - // - // * - // BILLING_ENTITY - // - // * RESERVATION_ID - // - // * SAVINGS_PLAN_ARN + // - AZ + // - INSTANCE_TYPE + // - LINKED_ACCOUNT + // - LINKED_ACCOUNT_NAME + // - OPERATION + // - PURCHASE_TYPE + // - REGION + // - SERVICE + // - USAGE_TYPE + // - USAGE_TYPE_GROUP + // - RECORD_TYPE + // - OPERATING_SYSTEM + // - TENANCY + // - SCOPE + // - PLATFORM + // - SUBSCRIPTION_ID + // - LEGAL_ENTITY_NAME + // - DEPLOYMENT_OPTION + // - DATABASE_ENGINE + // - INSTANCE_TYPE_FAMILY + // - BILLING_ENTITY + // - RESERVATION_ID + // - SAVINGS_PLAN_ARN Filter *types.Expression // Cost Explorer always returns the mean forecast as a single point. You can @@ -134,7 +99,7 @@ type GetCostForecastOutput struct { // days. For MONTHLY forecasts, this is a list of months. ForecastResultsByTime []types.ForecastResult - // How much you are forecasted to spend over the forecast period, in USD. + // How much you are forecasted to spend over the forecast period, in USD . Total *types.MetricValue // Metadata pertaining to the operation's result. diff --git a/service/costexplorer/api_op_GetDimensionValues.go b/service/costexplorer/api_op_GetDimensionValues.go index 6bd4585d084..c7daa196805 100644 --- a/service/costexplorer/api_op_GetDimensionValues.go +++ b/service/costexplorer/api_op_GetDimensionValues.go @@ -30,259 +30,166 @@ func (c *Client) GetDimensionValues(ctx context.Context, params *GetDimensionVal type GetDimensionValuesInput struct { - // The name of the dimension. Each Dimension is available for a different Context. - // For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only - // be used in CostCategoryRule - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html). + // The name of the dimension. Each Dimension is available for a different Context . + // For more information, see Context . LINK_ACCOUNT_NAME and SERVICE_CODE can only + // be used in CostCategoryRule (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html) + // . // // This member is required. Dimension types.Dimension // The start date and end date for retrieving the dimension values. The start date // is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 - // and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 - // up to and including 2017-04-30 but not including 2017-05-01. + // and end is 2017-05-01 , then the cost and usage data is retrieved from + // 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval - // The context for the call to GetDimensionValues. This can be RESERVATIONS or - // COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to - // RESERVATIONS, the resulting dimension values can be used in the - // GetReservationUtilization operation. If the context is set to COST_AND_USAGE, + // The context for the call to GetDimensionValues . This can be RESERVATIONS or + // COST_AND_USAGE . The default value is COST_AND_USAGE . If the context is set to + // RESERVATIONS , the resulting dimension values can be used in the + // GetReservationUtilization operation. If the context is set to COST_AND_USAGE , // the resulting dimension values can be used in the GetCostAndUsage operation. If - // you set the context to COST_AND_USAGE, you can use the following dimensions for + // you set the context to COST_AND_USAGE , you can use the following dimensions for // searching: - // - // * AZ - The Availability Zone. An example is us-east-1a. - // - // * - // BILLING_ENTITY - The Amazon Web Services seller that your account is with. - // Possible values are the following: - Amazon Web Services(Amazon Web Services): - // The entity that sells Amazon Web Services. - AISPL (Amazon Internet Services - // Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web - // Services in India. - Amazon Web Services Marketplace: The entity that supports - // the sale of solutions that are built on Amazon Web Services by third-party - // software providers. - // - // * CACHE_ENGINE - The Amazon ElastiCache operating system. - // Examples are Windows or Linux. - // - // * DEPLOYMENT_OPTION - The scope of Amazon - // Relational Database Service deployments. Valid values are SingleAZ and - // MultiAZ. - // - // * DATABASE_ENGINE - The Amazon Relational Database Service database. - // Examples are Aurora or MySQL. - // - // * INSTANCE_TYPE - The type of Amazon EC2 - // instance. An example is m4.xlarge. - // - // * INSTANCE_TYPE_FAMILY - A family of - // instance types optimized to fit different use cases. Examples are Compute - // Optimized (for example, C4, C5, C6g, and C7g), Memory Optimization (for example, - // R4, R5n, R5b, and R6g). - // - // * INVOICING_ENTITY - The name of the entity that issues - // the Amazon Web Services invoice. - // - // * LEGAL_ENTITY_NAME - The name of the - // organization that sells you Amazon Web Services services, such as Amazon Web - // Services. - // - // * LINKED_ACCOUNT - The description in the attribute map that includes - // the full name of the member account. The value field contains the Amazon Web - // Services ID of the member account. - // - // * OPERATING_SYSTEM - The operating system. - // Examples are Windows or Linux. - // - // * OPERATION - The action performed. Examples - // include RunInstance and CreateBucket. - // - // * PLATFORM - The Amazon EC2 operating - // system. Examples are Windows or Linux. - // - // * PURCHASE_TYPE - The reservation type - // of the purchase that this usage is related to. Examples include On-Demand - // Instances and Standard Reserved Instances. - // - // * RESERVATION_ID - The unique - // identifier for an Amazon Web Services Reservation Instance. - // - // * SAVINGS_PLAN_ARN - // - The unique identifier for your Savings Plans. - // - // * SAVINGS_PLANS_TYPE - Type of - // Savings Plans (EC2 Instance or Compute). - // - // * SERVICE - The Amazon Web Services - // service such as Amazon DynamoDB. - // - // * TENANCY - The tenancy of a resource. - // Examples are shared or dedicated. - // - // * USAGE_TYPE - The type of usage. An example - // is DataTransfer-In-Bytes. The response for the GetDimensionValues operation - // includes a unit attribute. Examples include GB and Hrs. - // - // * USAGE_TYPE_GROUP - - // The grouping of common usage types. An example is Amazon EC2: CloudWatch – - // Alarms. The response for this operation includes a unit attribute. - // - // * REGION - - // The Amazon Web Services Region. - // - // * RECORD_TYPE - The different types of charges - // such as Reserved Instance (RI) fees, usage costs, tax refunds, and credits. - // - // * - // RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in - // feature only available for last 14 days for EC2-Compute Service. - // - // If you set the - // context to RESERVATIONS, you can use the following dimensions for searching: - // - // * - // AZ - The Availability Zone. An example is us-east-1a. - // - // * CACHE_ENGINE - The - // Amazon ElastiCache operating system. Examples are Windows or Linux. - // - // * - // DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. - // Valid values are SingleAZ and MultiAZ. - // - // * INSTANCE_TYPE - The type of Amazon EC2 - // instance. An example is m4.xlarge. - // - // * LINKED_ACCOUNT - The description in the - // attribute map that includes the full name of the member account. The value field - // contains the Amazon Web Services ID of the member account. - // - // * PLATFORM - The - // Amazon EC2 operating system. Examples are Windows or Linux. - // - // * REGION - The - // Amazon Web Services Region. - // - // * SCOPE (Utilization only) - The scope of a - // Reserved Instance (RI). Values are regional or a single Availability Zone. - // - // * - // TAG (Coverage only) - The tags that are associated with a Reserved Instance - // (RI). - // - // * TENANCY - The tenancy of a resource. Examples are shared or - // dedicated. - // - // If you set the context to SAVINGS_PLANS, you can use the following - // dimensions for searching: - // - // * SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 - // Instance or Compute) - // - // * PAYMENT_OPTION - The payment option for the given - // Savings Plans (for example, All Upfront) - // - // * REGION - The Amazon Web Services - // Region. - // - // * INSTANCE_TYPE_FAMILY - The family of instances (For example, m5) - // - // * - // LINKED_ACCOUNT - The description in the attribute map that includes the full - // name of the member account. The value field contains the Amazon Web Services ID - // of the member account. - // - // * SAVINGS_PLAN_ARN - The unique identifier for your - // Savings Plans. + // - AZ - The Availability Zone. An example is us-east-1a . + // - BILLING_ENTITY - The Amazon Web Services seller that your account is with. + // Possible values are the following: - Amazon Web Services(Amazon Web Services): + // The entity that sells Amazon Web Services. - AISPL (Amazon Internet Services + // Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web + // Services in India. - Amazon Web Services Marketplace: The entity that supports + // the sale of solutions that are built on Amazon Web Services by third-party + // software providers. + // - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are + // Windows or Linux. + // - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service + // deployments. Valid values are SingleAZ and MultiAZ . + // - DATABASE_ENGINE - The Amazon Relational Database Service database. Examples + // are Aurora or MySQL. + // - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge . + // - INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit + // different use cases. Examples are Compute Optimized (for example, C4 , C5 , + // C6g , and C7g ), Memory Optimization (for example, R4 , R5n , R5b , and R6g ). + // - INVOICING_ENTITY - The name of the entity that issues the Amazon Web + // Services invoice. + // - LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web + // Services services, such as Amazon Web Services. + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. + // - OPERATION - The action performed. Examples include RunInstance and + // CreateBucket . + // - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. + // - PURCHASE_TYPE - The reservation type of the purchase that this usage is + // related to. Examples include On-Demand Instances and Standard Reserved + // Instances. + // - RESERVATION_ID - The unique identifier for an Amazon Web Services + // Reservation Instance. + // - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans. + // - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute). + // - SERVICE - The Amazon Web Services service such as Amazon DynamoDB. + // - TENANCY - The tenancy of a resource. Examples are shared or dedicated. + // - USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The + // response for the GetDimensionValues operation includes a unit attribute. + // Examples include GB and Hrs. + // - USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon + // EC2: CloudWatch – Alarms. The response for this operation includes a unit + // attribute. + // - REGION - The Amazon Web Services Region. + // - RECORD_TYPE - The different types of charges such as Reserved Instance (RI) + // fees, usage costs, tax refunds, and credits. + // - RESOURCE_ID - The unique identifier of the resource. ResourceId is an + // opt-in feature only available for last 14 days for EC2-Compute Service. + // If you set the context to RESERVATIONS , you can use the following dimensions + // for searching: + // - AZ - The Availability Zone. An example is us-east-1a . + // - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are + // Windows or Linux. + // - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service + // deployments. Valid values are SingleAZ and MultiAZ . + // - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge . + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. + // - REGION - The Amazon Web Services Region. + // - SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values + // are regional or a single Availability Zone. + // - TAG (Coverage only) - The tags that are associated with a Reserved Instance + // (RI). + // - TENANCY - The tenancy of a resource. Examples are shared or dedicated. + // If you set the context to SAVINGS_PLANS , you can use the following dimensions + // for searching: + // - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute) + // - PAYMENT_OPTION - The payment option for the given Savings Plans (for + // example, All Upfront) + // - REGION - The Amazon Web Services Region. + // - INSTANCE_TYPE_FAMILY - The family of instances (For example, m5 ) + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans. Context types.Context - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . Filter *types.Expression // This field is only used when SortBy is provided in the request. The maximum // number of objects that are returned for this request. If MaxResults isn't // specified with SortBy, the request returns 1000 results as the default value for - // this parameter. For GetDimensionValues, MaxResults has an upper limit of 1000. + // this parameter. For GetDimensionValues , MaxResults has an upper limit of 1000. MaxResults int32 // The token to retrieve the next set of results. Amazon Web Services provides the @@ -295,27 +202,16 @@ type GetDimensionValuesInput struct { // The value that you want to sort the data by. The key represents cost and usage // metrics. The following values are supported: - // - // * BlendedCost - // - // * UnblendedCost - // - // * - // AmortizedCost - // - // * NetAmortizedCost - // - // * NetUnblendedCost - // - // * UsageQuantity - // - // * - // NormalizedUsageAmount - // - // The supported values for the SortOrder key are ASCENDING - // or DESCENDING. When you specify a SortBy paramater, the context must be - // COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString - // aren't supported. + // - BlendedCost + // - UnblendedCost + // - AmortizedCost + // - NetAmortizedCost + // - NetUnblendedCost + // - UsageQuantity + // - NormalizedUsageAmount + // The supported values for the SortOrder key are ASCENDING or DESCENDING . When + // you specify a SortBy paramater, the context must be COST_AND_USAGE . Further, + // when using SortBy , NextPageToken and SearchString aren't supported. SortBy []types.SortDefinition noSmithyDocumentSerde @@ -324,115 +220,65 @@ type GetDimensionValuesInput struct { type GetDimensionValuesOutput struct { // The filters that you used to filter your request. Some dimensions are available - // only for a specific context. If you set the context to COST_AND_USAGE, you can - // use the following dimensions for searching: - // - // * AZ - The Availability Zone. An - // example is us-east-1a. - // - // * DATABASE_ENGINE - The Amazon Relational Database - // Service database. Examples are Aurora or MySQL. - // - // * INSTANCE_TYPE - The type of - // Amazon EC2 instance. An example is m4.xlarge. - // - // * LEGAL_ENTITY_NAME - The name of - // the organization that sells you Amazon Web Services services, such as Amazon Web - // Services. - // - // * LINKED_ACCOUNT - The description in the attribute map that includes - // the full name of the member account. The value field contains the Amazon Web - // Services ID of the member account. - // - // * OPERATING_SYSTEM - The operating system. - // Examples are Windows or Linux. - // - // * OPERATION - The action performed. Examples - // include RunInstance and CreateBucket. - // - // * PLATFORM - The Amazon EC2 operating - // system. Examples are Windows or Linux. - // - // * PURCHASE_TYPE - The reservation type - // of the purchase to which this usage is related. Examples include On-Demand - // Instances and Standard Reserved Instances. - // - // * SERVICE - The Amazon Web Services - // service such as Amazon DynamoDB. - // - // * USAGE_TYPE - The type of usage. An example - // is DataTransfer-In-Bytes. The response for the GetDimensionValues operation - // includes a unit attribute. Examples include GB and Hrs. - // - // * USAGE_TYPE_GROUP - - // The grouping of common usage types. An example is Amazon EC2: CloudWatch – - // Alarms. The response for this operation includes a unit attribute. - // - // * - // RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax - // refunds, and credits. - // - // * RESOURCE_ID - The unique identifier of the resource. - // ResourceId is an opt-in feature only available for last 14 days for EC2-Compute - // Service. You can opt-in by enabling Hourly and Resource Level Data in Cost - // Management Console preferences. - // - // If you set the context to RESERVATIONS, you can + // only for a specific context. If you set the context to COST_AND_USAGE , you can // use the following dimensions for searching: - // - // * AZ - The Availability Zone. An - // example is us-east-1a. - // - // * CACHE_ENGINE - The Amazon ElastiCache operating - // system. Examples are Windows or Linux. - // - // * DEPLOYMENT_OPTION - The scope of - // Amazon Relational Database Service deployments. Valid values are SingleAZ and - // MultiAZ. - // - // * INSTANCE_TYPE - The type of Amazon EC2 instance. An example is - // m4.xlarge. - // - // * LINKED_ACCOUNT - The description in the attribute map that - // includes the full name of the member account. The value field contains the - // Amazon Web Services ID of the member account. - // - // * PLATFORM - The Amazon EC2 - // operating system. Examples are Windows or Linux. - // - // * REGION - The Amazon Web - // Services Region. - // - // * SCOPE (Utilization only) - The scope of a Reserved Instance - // (RI). Values are regional or a single Availability Zone. - // - // * TAG (Coverage only) - // - The tags that are associated with a Reserved Instance (RI). - // - // * TENANCY - The - // tenancy of a resource. Examples are shared or dedicated. - // - // If you set the context - // to SAVINGS_PLANS, you can use the following dimensions for searching: - // - // * - // SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute) - // - // * - // PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All - // Upfront) - // - // * REGION - The Amazon Web Services Region. - // - // * INSTANCE_TYPE_FAMILY - - // The family of instances (For example, m5) - // - // * LINKED_ACCOUNT - The description in - // the attribute map that includes the full name of the member account. The value - // field contains the Amazon Web Services ID of the member account. - // - // * - // SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan + // - AZ - The Availability Zone. An example is us-east-1a . + // - DATABASE_ENGINE - The Amazon Relational Database Service database. Examples + // are Aurora or MySQL. + // - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge . + // - LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web + // Services services, such as Amazon Web Services. + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. + // - OPERATION - The action performed. Examples include RunInstance and + // CreateBucket . + // - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. + // - PURCHASE_TYPE - The reservation type of the purchase to which this usage is + // related. Examples include On-Demand Instances and Standard Reserved Instances. + // - SERVICE - The Amazon Web Services service such as Amazon DynamoDB. + // - USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The + // response for the GetDimensionValues operation includes a unit attribute. + // Examples include GB and Hrs. + // - USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon + // EC2: CloudWatch – Alarms. The response for this operation includes a unit + // attribute. + // - RECORD_TYPE - The different types of charges such as RI fees, usage costs, + // tax refunds, and credits. + // - RESOURCE_ID - The unique identifier of the resource. ResourceId is an + // opt-in feature only available for last 14 days for EC2-Compute Service. You can + // opt-in by enabling Hourly and Resource Level Data in Cost Management Console + // preferences. + // If you set the context to RESERVATIONS , you can use the following dimensions + // for searching: + // - AZ - The Availability Zone. An example is us-east-1a . + // - CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are + // Windows or Linux. + // - DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service + // deployments. Valid values are SingleAZ and MultiAZ . + // - INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge . + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. + // - REGION - The Amazon Web Services Region. + // - SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values + // are regional or a single Availability Zone. + // - TAG (Coverage only) - The tags that are associated with a Reserved Instance + // (RI). + // - TENANCY - The tenancy of a resource. Examples are shared or dedicated. + // If you set the context to SAVINGS_PLANS , you can use the following dimensions + // for searching: + // - SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute) + // - PAYMENT_OPTION - Payment option for the given Savings Plans (for example, + // All Upfront) + // - REGION - The Amazon Web Services Region. + // - INSTANCE_TYPE_FAMILY - The family of instances (For example, m5 ) + // - LINKED_ACCOUNT - The description in the attribute map that includes the + // full name of the member account. The value field contains the Amazon Web + // Services ID of the member account. + // - SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan // // This member is required. DimensionValues []types.DimensionValuesWithAttributes diff --git a/service/costexplorer/api_op_GetReservationCoverage.go b/service/costexplorer/api_op_GetReservationCoverage.go index c9f38a43c72..e2fd50bd988 100644 --- a/service/costexplorer/api_op_GetReservationCoverage.go +++ b/service/costexplorer/api_op_GetReservationCoverage.go @@ -18,35 +18,20 @@ import ( // associated member accounts. This supports dimensions, Cost Categories, and // nested expressions. For any time period, you can filter data about reservation // usage by the following dimensions: +// - AZ +// - CACHE_ENGINE +// - DATABASE_ENGINE +// - DEPLOYMENT_OPTION +// - INSTANCE_TYPE +// - LINKED_ACCOUNT +// - OPERATING_SYSTEM +// - PLATFORM +// - REGION +// - SERVICE +// - TAG +// - TENANCY // -// * AZ -// -// * CACHE_ENGINE -// -// * DATABASE_ENGINE -// -// * -// DEPLOYMENT_OPTION -// -// * INSTANCE_TYPE -// -// * LINKED_ACCOUNT -// -// * OPERATING_SYSTEM -// -// * -// PLATFORM -// -// * REGION -// -// * SERVICE -// -// * TAG -// -// * TENANCY -// -// To determine valid values for a -// dimension, use the GetDimensionValues operation. +// To determine valid values for a dimension, use the GetDimensionValues operation. func (c *Client) GetReservationCoverage(ctx context.Context, params *GetReservationCoverageInput, optFns ...func(*Options)) (*GetReservationCoverageOutput, error) { if params == nil { params = &GetReservationCoverageInput{} @@ -69,44 +54,28 @@ type GetReservationCoverageInput struct { // The start and end dates of the period that you want to retrieve data about // reservation coverage for. You can retrieve data for a maximum of 13 months: the // last 12 months and the current month. The start date is inclusive, but the end - // date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, + // date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , // then the cost and usage data is retrieved from 2017-01-01 up to and including - // 2017-04-30 but not including 2017-05-01. + // 2017-04-30 but not including 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval // Filters utilization data by dimensions. You can filter by the following // dimensions: - // - // * AZ - // - // * CACHE_ENGINE - // - // * DATABASE_ENGINE - // - // * DEPLOYMENT_OPTION - // - // * - // INSTANCE_TYPE - // - // * LINKED_ACCOUNT - // - // * OPERATING_SYSTEM - // - // * PLATFORM - // - // * REGION - // - // * - // SERVICE - // - // * TAG - // - // * TENANCY - // - // GetReservationCoverage uses the same Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // - AZ + // - CACHE_ENGINE + // - DATABASE_ENGINE + // - DEPLOYMENT_OPTION + // - INSTANCE_TYPE + // - LINKED_ACCOUNT + // - OPERATING_SYSTEM + // - PLATFORM + // - REGION + // - SERVICE + // - TAG + // - TENANCY + // GetReservationCoverage uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object as the other operations, but only AND is supported among each dimension. // You can nest only one level deep. If there are multiple values for a dimension, // they are OR'd together. If you don't provide a SERVICE filter, Cost Explorer @@ -114,37 +83,24 @@ type GetReservationCoverageInput struct { Filter *types.Expression // The granularity of the Amazon Web Services cost data for the reservation. Valid - // values are MONTHLY and DAILY. If GroupBy is set, Granularity can't be set. If - // Granularity isn't set, the response object doesn't include Granularity, either - // MONTHLY or DAILY. The GetReservationCoverage operation supports only DAILY and + // values are MONTHLY and DAILY . If GroupBy is set, Granularity can't be set. If + // Granularity isn't set, the response object doesn't include Granularity , either + // MONTHLY or DAILY . The GetReservationCoverage operation supports only DAILY and // MONTHLY granularities. Granularity types.Granularity // You can group the data by the following attributes: - // - // * AZ - // - // * CACHE_ENGINE - // - // * - // DATABASE_ENGINE - // - // * DEPLOYMENT_OPTION - // - // * INSTANCE_TYPE - // - // * INVOICING_ENTITY - // - // * - // LINKED_ACCOUNT - // - // * OPERATING_SYSTEM - // - // * PLATFORM - // - // * REGION - // - // * TENANCY + // - AZ + // - CACHE_ENGINE + // - DATABASE_ENGINE + // - DEPLOYMENT_OPTION + // - INSTANCE_TYPE + // - INVOICING_ENTITY + // - LINKED_ACCOUNT + // - OPERATING_SYSTEM + // - PLATFORM + // - REGION + // - TENANCY GroupBy []types.GroupDefinition // The maximum number of objects that you returned for this request. If more @@ -154,7 +110,7 @@ type GetReservationCoverageInput struct { MaxResults *int32 // The measurement that you want your reservation coverage reported in. Valid - // values are Hour, Unit, and Cost. You can use multiple values in a request. + // values are Hour , Unit , and Cost . You can use multiple values in a request. Metrics []string // The token to retrieve the next set of results. Amazon Web Services provides the @@ -162,34 +118,19 @@ type GetReservationCoverageInput struct { // page size. NextPageToken *string - // The value by which you want to sort the data. The following values are supported - // for Key: - // - // * OnDemandCost - // - // * CoverageHoursPercentage - // - // * OnDemandHours - // - // * - // ReservedHours - // - // * TotalRunningHours - // - // * CoverageNormalizedUnitsPercentage - // - // * - // OnDemandNormalizedUnits - // - // * ReservedNormalizedUnits - // - // * - // TotalRunningNormalizedUnits - // - // * Time - // - // Supported values for SortOrder are - // ASCENDING or DESCENDING. + // The value by which you want to sort the data. The following values are + // supported for Key : + // - OnDemandCost + // - CoverageHoursPercentage + // - OnDemandHours + // - ReservedHours + // - TotalRunningHours + // - CoverageNormalizedUnitsPercentage + // - OnDemandNormalizedUnits + // - ReservedNormalizedUnits + // - TotalRunningNormalizedUnits + // - Time + // Supported values for SortOrder are ASCENDING or DESCENDING . SortBy *types.SortDefinition noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go b/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go index 23a427a18c9..9c2c1198a91 100644 --- a/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go +++ b/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets recommendations for reservation purchases. These recommendations might help -// you to reduce your costs. Reservations provide a discounted hourly rate (up to -// 75%) compared to On-Demand pricing. Amazon Web Services generates your +// Gets recommendations for reservation purchases. These recommendations might +// help you to reduce your costs. Reservations provide a discounted hourly rate (up +// to 75%) compared to On-Demand pricing. Amazon Web Services generates your // recommendations by identifying your On-Demand usage during a specific time // period and collecting your usage into categories that are eligible for a // reservation. After Amazon Web Services has these categories, it simulates every @@ -55,88 +55,61 @@ type GetReservationPurchaseRecommendationInput struct { // The account scope that you want your recommendations for. Amazon Web Services // calculates recommendations including the management account and member accounts - // if the value is set to PAYER. If the value is LINKED, recommendations are + // if the value is set to PAYER . If the value is LINKED , recommendations are // calculated for individual member accounts only. AccountScope types.AccountScope - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . Filter *types.Expression // The number of previous days that you want Amazon Web Services to consider when diff --git a/service/costexplorer/api_op_GetReservationUtilization.go b/service/costexplorer/api_op_GetReservationUtilization.go index 29695b42883..441ab75dd2b 100644 --- a/service/costexplorer/api_op_GetReservationUtilization.go +++ b/service/costexplorer/api_op_GetReservationUtilization.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the reservation utilization for your account. Management account in an -// organization have access to member accounts. You can filter data by dimensions -// in a time period. You can use GetDimensionValues to determine the possible -// dimension values. Currently, you can group only by SUBSCRIPTION_ID. +// Retrieves the reservation utilization for your account. Management account in +// an organization have access to member accounts. You can filter data by +// dimensions in a time period. You can use GetDimensionValues to determine the +// possible dimension values. Currently, you can group only by SUBSCRIPTION_ID . func (c *Client) GetReservationUtilization(ctx context.Context, params *GetReservationUtilizationInput, optFns ...func(*Options)) (*GetReservationUtilizationOutput, error) { if params == nil { params = &GetReservationUtilizationInput{} @@ -34,55 +34,40 @@ type GetReservationUtilizationInput struct { // Sets the start and end dates for retrieving Reserved Instance (RI) utilization. // The start date is inclusive, but the end date is exclusive. For example, if - // start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is + // start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is // retrieved from 2017-01-01 up to and including 2017-04-30 but not including - // 2017-05-01. + // 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval // Filters utilization data by dimensions. You can filter by the following // dimensions: - // - // * AZ - // - // * CACHE_ENGINE - // - // * DEPLOYMENT_OPTION - // - // * INSTANCE_TYPE - // - // * - // LINKED_ACCOUNT - // - // * OPERATING_SYSTEM - // - // * PLATFORM - // - // * REGION - // - // * SERVICE - // - // * SCOPE - // - // * - // TENANCY - // - // GetReservationUtilization uses the same Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // - AZ + // - CACHE_ENGINE + // - DEPLOYMENT_OPTION + // - INSTANCE_TYPE + // - LINKED_ACCOUNT + // - OPERATING_SYSTEM + // - PLATFORM + // - REGION + // - SERVICE + // - SCOPE + // - TENANCY + // GetReservationUtilization uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object as the other operations, but only AND is supported among each dimension, // and nesting is supported up to only one level deep. If there are multiple values // for a dimension, they are OR'd together. Filter *types.Expression // If GroupBy is set, Granularity can't be set. If Granularity isn't set, the - // response object doesn't include Granularity, either MONTHLY or DAILY. If both - // GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY. - // The GetReservationUtilization operation supports only DAILY and MONTHLY + // response object doesn't include Granularity , either MONTHLY or DAILY . If both + // GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY + // . The GetReservationUtilization operation supports only DAILY and MONTHLY // granularities. Granularity types.Granularity - // Groups only by SUBSCRIPTION_ID. Metadata is included. + // Groups only by SUBSCRIPTION_ID . Metadata is included. GroupBy []types.GroupDefinition // The maximum number of objects that you returned for this request. If more @@ -97,49 +82,25 @@ type GetReservationUtilizationInput struct { NextPageToken *string // The value that you want to sort the data by. The following values are supported - // for Key: - // - // * UtilizationPercentage - // - // * UtilizationPercentageInUnits - // - // * - // PurchasedHours - // - // * PurchasedUnits - // - // * TotalActualHours - // - // * TotalActualUnits - // - // * - // UnusedHours - // - // * UnusedUnits - // - // * OnDemandCostOfRIHoursUsed - // - // * NetRISavings - // - // * - // TotalPotentialRISavings - // - // * AmortizedUpfrontFee - // - // * AmortizedRecurringFee - // - // * - // TotalAmortizedFee - // - // * RICostForUnusedHours - // - // * RealizedSavings - // - // * - // UnrealizedSavings - // - // The supported values for SortOrder are ASCENDING and - // DESCENDING. + // for Key : + // - UtilizationPercentage + // - UtilizationPercentageInUnits + // - PurchasedHours + // - PurchasedUnits + // - TotalActualHours + // - TotalActualUnits + // - UnusedHours + // - UnusedUnits + // - OnDemandCostOfRIHoursUsed + // - NetRISavings + // - TotalPotentialRISavings + // - AmortizedUpfrontFee + // - AmortizedRecurringFee + // - TotalAmortizedFee + // - RICostForUnusedHours + // - RealizedSavings + // - UnrealizedSavings + // The supported values for SortOrder are ASCENDING and DESCENDING . SortBy *types.SortDefinition noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_GetRightsizingRecommendation.go b/service/costexplorer/api_op_GetRightsizingRecommendation.go index 9d29e292864..8e95def1d3b 100644 --- a/service/costexplorer/api_op_GetRightsizingRecommendation.go +++ b/service/costexplorer/api_op_GetRightsizingRecommendation.go @@ -15,8 +15,7 @@ import ( // underutilized Amazon EC2 instances. Recommendations are generated to either // downsize or terminate instances, along with providing savings detail and // metrics. For more information about calculation and function, see Optimizing -// Your Cost with Rightsizing Recommendations -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html) +// Your Cost with Rightsizing Recommendations (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html) // in the Billing and Cost Management User Guide. func (c *Client) GetRightsizingRecommendation(ctx context.Context, params *GetRightsizingRecommendationInput, optFns ...func(*Options)) (*GetRightsizingRecommendationOutput, error) { if params == nil { @@ -35,8 +34,8 @@ func (c *Client) GetRightsizingRecommendation(ctx context.Context, params *GetRi type GetRightsizingRecommendationInput struct { - // The specific service that you want recommendations for. The only valid value for - // GetRightsizingRecommendation is "AmazonEC2". + // The specific service that you want recommendations for. The only valid value + // for GetRightsizingRecommendation is " AmazonEC2 ". // // This member is required. Service *string @@ -48,84 +47,57 @@ type GetRightsizingRecommendationInput struct { // existing Savings Plans or RI benefits, or neither. Configuration *types.RightsizingRecommendationConfiguration - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . Filter *types.Expression // The pagination token that indicates the next set of results that you want to diff --git a/service/costexplorer/api_op_GetSavingsPlansCoverage.go b/service/costexplorer/api_op_GetSavingsPlansCoverage.go index 87a658f489a..46c5ae470f5 100644 --- a/service/costexplorer/api_op_GetSavingsPlansCoverage.go +++ b/service/costexplorer/api_op_GetSavingsPlansCoverage.go @@ -17,18 +17,12 @@ import ( // account can see the coverage of the associated member accounts. This supports // dimensions, Cost Categories, and nested expressions. For any time period, you // can filter data for Savings Plans usage with the following dimensions: +// - LINKED_ACCOUNT +// - REGION +// - SERVICE +// - INSTANCE_FAMILY // -// * -// LINKED_ACCOUNT -// -// * REGION -// -// * SERVICE -// -// * INSTANCE_FAMILY -// -// To determine valid -// values for a dimension, use the GetDimensionValues operation. +// To determine valid values for a dimension, use the GetDimensionValues operation. func (c *Client) GetSavingsPlansCoverage(ctx context.Context, params *GetSavingsPlansCoverageInput, optFns ...func(*Options)) (*GetSavingsPlansCoverageOutput, error) { if params == nil { params = &GetSavingsPlansCoverageInput{} @@ -55,19 +49,11 @@ type GetSavingsPlansCoverageInput struct { // Filters Savings Plans coverage data by dimensions. You can filter data for // Savings Plans usage with the following dimensions: - // - // * LINKED_ACCOUNT - // - // * - // REGION - // - // * SERVICE - // - // * INSTANCE_FAMILY - // - // GetSavingsPlansCoverage uses the same - // Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // - LINKED_ACCOUNT + // - REGION + // - SERVICE + // - INSTANCE_FAMILY + // GetSavingsPlansCoverage uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object as the other operations, but only AND is supported among each dimension. // If there are multiple values for a dimension, they are OR'd together. Cost // category is also supported. @@ -78,15 +64,16 @@ type GetSavingsPlansCoverageInput struct { // operation supports only DAILY and MONTHLY granularities. Granularity types.Granularity - // You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE. + // You can group the data using the attributes INSTANCE_FAMILY , REGION , or + // SERVICE . GroupBy []types.GroupDefinition - // The number of items to be returned in a response. The default is 20, with a - // minimum value of 1. + // The number of items to be returned in a response. The default is 20 , with a + // minimum value of 1 . MaxResults *int32 // The measurement that you want your Savings Plans coverage reported in. The only - // valid value is SpendCoveredBySavingsPlans. + // valid value is SpendCoveredBySavingsPlans . Metrics []string // The token to retrieve the next set of results. Amazon Web Services provides the @@ -95,25 +82,15 @@ type GetSavingsPlansCoverageInput struct { NextToken *string // The value that you want to sort the data by. The following values are supported - // for Key: - // - // * SpendCoveredBySavingsPlan - // - // * OnDemandCost - // - // * CoveragePercentage - // - // * - // TotalCost - // - // * InstanceFamily - // - // * Region - // - // * Service - // - // The supported values for - // SortOrder are ASCENDING and DESCENDING. + // for Key : + // - SpendCoveredBySavingsPlan + // - OnDemandCost + // - CoveragePercentage + // - TotalCost + // - InstanceFamily + // - Region + // - Service + // The supported values for SortOrder are ASCENDING and DESCENDING . SortBy *types.SortDefinition noSmithyDocumentSerde @@ -211,8 +188,8 @@ var _ GetSavingsPlansCoverageAPIClient = (*Client)(nil) // GetSavingsPlansCoveragePaginatorOptions is the paginator options for // GetSavingsPlansCoverage type GetSavingsPlansCoveragePaginatorOptions struct { - // The number of items to be returned in a response. The default is 20, with a - // minimum value of 1. + // The number of items to be returned in a response. The default is 20 , with a + // minimum value of 1 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go b/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go index c4081155e1b..3cf7bcf9a5e 100644 --- a/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go +++ b/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go @@ -55,7 +55,7 @@ type GetSavingsPlansPurchaseRecommendationInput struct { // The account scope that you want your recommendations for. Amazon Web Services // calculates recommendations including the management account and member accounts - // if the value is set to PAYER. If the value is LINKED, recommendations are + // if the value is set to PAYER . If the value is LINKED , recommendations are // calculated for individual member accounts only. AccountScope types.AccountScope @@ -64,7 +64,7 @@ type GetSavingsPlansPurchaseRecommendationInput struct { // LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to // see Savings Plans purchase recommendations for. For // GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories - // or Tags. It only includes Dimensions. With Dimensions, Key must be + // or Tags . It only includes Dimensions . With Dimensions , Key must be // LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated // Account IDs that you want to see Savings Plans Purchase Recommendations for. AND // and OR operators are not supported. diff --git a/service/costexplorer/api_op_GetSavingsPlansUtilization.go b/service/costexplorer/api_op_GetSavingsPlansUtilization.go index d4b3c622f53..2f09519ca9d 100644 --- a/service/costexplorer/api_op_GetSavingsPlansUtilization.go +++ b/service/costexplorer/api_op_GetSavingsPlansUtilization.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the Savings Plans utilization for your account across date ranges with -// daily or monthly granularity. Management account in an organization have access -// to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine -// the possible dimension values. You can't group by any dimension values for -// GetSavingsPlansUtilization. +// Retrieves the Savings Plans utilization for your account across date ranges +// with daily or monthly granularity. Management account in an organization have +// access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to +// determine the possible dimension values. You can't group by any dimension values +// for GetSavingsPlansUtilization . func (c *Client) GetSavingsPlansUtilization(ctx context.Context, params *GetSavingsPlansUtilizationInput, optFns ...func(*Options)) (*GetSavingsPlansUtilizationOutput, error) { if params == nil { params = &GetSavingsPlansUtilizationInput{} @@ -42,24 +42,13 @@ type GetSavingsPlansUtilizationInput struct { // Filters Savings Plans utilization coverage data for active Savings Plans // dimensions. You can filter data with the following dimensions: - // - // * - // LINKED_ACCOUNT - // - // * SAVINGS_PLAN_ARN - // - // * SAVINGS_PLANS_TYPE - // - // * REGION - // - // * - // PAYMENT_OPTION - // - // * INSTANCE_TYPE_FAMILY - // - // GetSavingsPlansUtilization uses the same - // Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // - LINKED_ACCOUNT + // - SAVINGS_PLAN_ARN + // - SAVINGS_PLANS_TYPE + // - REGION + // - PAYMENT_OPTION + // - INSTANCE_TYPE_FAMILY + // GetSavingsPlansUtilization uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object as the other operations, but only AND is supported among each dimension. Filter *types.Expression @@ -69,21 +58,13 @@ type GetSavingsPlansUtilizationInput struct { Granularity types.Granularity // The value that you want to sort the data by. The following values are supported - // for Key: - // - // * UtilizationPercentage - // - // * TotalCommitment - // - // * UsedCommitment - // - // * - // UnusedCommitment - // - // * NetSavings - // - // The supported values for SortOrder are ASCENDING - // and DESCENDING. + // for Key : + // - UtilizationPercentage + // - TotalCommitment + // - UsedCommitment + // - UnusedCommitment + // - NetSavings + // The supported values for SortOrder are ASCENDING and DESCENDING . SortBy *types.SortDefinition noSmithyDocumentSerde @@ -91,8 +72,8 @@ type GetSavingsPlansUtilizationInput struct { type GetSavingsPlansUtilizationOutput struct { - // The total amount of cost/commitment that you used your Savings Plans, regardless - // of date ranges. + // The total amount of cost/commitment that you used your Savings Plans, + // regardless of date ranges. // // This member is required. Total *types.SavingsPlansUtilizationAggregates diff --git a/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go b/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go index e2282855d27..23bf93dc929 100644 --- a/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go +++ b/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go @@ -12,13 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves attribute data along with aggregate utilization and savings data for a -// given time period. This doesn't support granular or grouped data (daily/monthly) -// in response. You can't retrieve data by dates in a single response similar to -// GetSavingsPlanUtilization, but you have the option to make multiple calls to -// GetSavingsPlanUtilizationDetails by providing individual dates. You can use -// GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. -// GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn. +// Retrieves attribute data along with aggregate utilization and savings data for +// a given time period. This doesn't support granular or grouped data +// (daily/monthly) in response. You can't retrieve data by dates in a single +// response similar to GetSavingsPlanUtilization , but you have the option to make +// multiple calls to GetSavingsPlanUtilizationDetails by providing individual +// dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the +// possible dimension values. GetSavingsPlanUtilizationDetails internally groups +// data by SavingsPlansArn . func (c *Client) GetSavingsPlansUtilizationDetails(ctx context.Context, params *GetSavingsPlansUtilizationDetailsInput, optFns ...func(*Options)) (*GetSavingsPlansUtilizationDetailsOutput, error) { if params == nil { params = &GetSavingsPlansUtilizationDetailsInput{} @@ -48,26 +49,17 @@ type GetSavingsPlansUtilizationDetailsInput struct { // Filters Savings Plans utilization coverage data for active Savings Plans // dimensions. You can filter data with the following dimensions: - // - // * - // LINKED_ACCOUNT - // - // * SAVINGS_PLAN_ARN - // - // * REGION - // - // * PAYMENT_OPTION - // - // * - // INSTANCE_TYPE_FAMILY - // - // GetSavingsPlansUtilizationDetails uses the same Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // - LINKED_ACCOUNT + // - SAVINGS_PLAN_ARN + // - REGION + // - PAYMENT_OPTION + // - INSTANCE_TYPE_FAMILY + // GetSavingsPlansUtilizationDetails uses the same Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object as the other operations, but only AND is supported among each dimension. Filter *types.Expression - // The number of items to be returned in a response. The default is 20, with a - // minimum value of 1. + // The number of items to be returned in a response. The default is 20 , with a + // minimum value of 1 . MaxResults *int32 // The token to retrieve the next set of results. Amazon Web Services provides the @@ -76,26 +68,15 @@ type GetSavingsPlansUtilizationDetailsInput struct { NextToken *string // The value that you want to sort the data by. The following values are supported - // for Key: - // - // * UtilizationPercentage - // - // * TotalCommitment - // - // * UsedCommitment - // - // * - // UnusedCommitment - // - // * NetSavings - // - // * AmortizedRecurringCommitment - // - // * - // AmortizedUpfrontCommitment - // - // The supported values for SortOrder are ASCENDING and - // DESCENDING. + // for Key : + // - UtilizationPercentage + // - TotalCommitment + // - UsedCommitment + // - UnusedCommitment + // - NetSavings + // - AmortizedRecurringCommitment + // - AmortizedUpfrontCommitment + // The supported values for SortOrder are ASCENDING and DESCENDING . SortBy *types.SortDefinition noSmithyDocumentSerde @@ -202,8 +183,8 @@ var _ GetSavingsPlansUtilizationDetailsAPIClient = (*Client)(nil) // GetSavingsPlansUtilizationDetailsPaginatorOptions is the paginator options for // GetSavingsPlansUtilizationDetails type GetSavingsPlansUtilizationDetailsPaginatorOptions struct { - // The number of items to be returned in a response. The default is 20, with a - // minimum value of 1. + // The number of items to be returned in a response. The default is 20 , with a + // minimum value of 1 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/costexplorer/api_op_GetTags.go b/service/costexplorer/api_op_GetTags.go index 1f654840d28..aca5f767a5d 100644 --- a/service/costexplorer/api_op_GetTags.go +++ b/service/costexplorer/api_op_GetTags.go @@ -32,96 +32,69 @@ type GetTagsInput struct { // The start and end dates for retrieving the dimension values. The start date is // inclusive, but the end date is exclusive. For example, if start is 2017-01-01 - // and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 - // up to and including 2017-04-30 but not including 2017-05-01. + // and end is 2017-05-01 , then the cost and usage data is retrieved from + // 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 . // // This member is required. TimePeriod *types.DateInterval - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . Filter *types.Expression // This field is only used when SortBy is provided in the request. The maximum // number of objects that are returned for this request. If MaxResults isn't // specified with SortBy, the request returns 1000 results as the default value for - // this parameter. For GetTags, MaxResults has an upper quota of 1000. + // this parameter. For GetTags , MaxResults has an upper quota of 1000. MaxResults int32 // The token to retrieve the next set of results. Amazon Web Services provides the @@ -134,26 +107,15 @@ type GetTagsInput struct { // The value that you want to sort the data by. The key represents cost and usage // metrics. The following values are supported: - // - // * BlendedCost - // - // * UnblendedCost - // - // * - // AmortizedCost - // - // * NetAmortizedCost - // - // * NetUnblendedCost - // - // * UsageQuantity - // - // * - // NormalizedUsageAmount - // - // The supported values for SortOrder are ASCENDING and - // DESCENDING. When you use SortBy, NextPageToken and SearchString aren't - // supported. + // - BlendedCost + // - UnblendedCost + // - AmortizedCost + // - NetAmortizedCost + // - NetUnblendedCost + // - UsageQuantity + // - NormalizedUsageAmount + // The supported values for SortOrder are ASCENDING and DESCENDING . When you use + // SortBy , NextPageToken and SearchString aren't supported. SortBy []types.SortDefinition // The key of the tag that you want to return values for. diff --git a/service/costexplorer/api_op_GetUsageForecast.go b/service/costexplorer/api_op_GetUsageForecast.go index 9767ad3b61e..e12c5a56cd2 100644 --- a/service/costexplorer/api_op_GetUsageForecast.go +++ b/service/costexplorer/api_op_GetUsageForecast.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a forecast for how much Amazon Web Services predicts that you will use -// over the forecast time period that you select, based on your past usage. +// Retrieves a forecast for how much Amazon Web Services predicts that you will +// use over the forecast time period that you select, based on your past usage. func (c *Client) GetUsageForecast(ctx context.Context, params *GetUsageForecastInput, optFns ...func(*Options)) (*GetUsageForecastOutput, error) { if params == nil { params = &GetUsageForecastInput{} @@ -39,20 +39,17 @@ type GetUsageForecastInput struct { // Which metric Cost Explorer uses to create your forecast. Valid values for a // GetUsageForecast call are the following: - // - // * USAGE_QUANTITY - // - // * - // NORMALIZED_USAGE_AMOUNT + // - USAGE_QUANTITY + // - NORMALIZED_USAGE_AMOUNT // // This member is required. Metric types.Metric // The start and end dates of the period that you want to retrieve usage forecast // for. The start date is included in the period, but the end date isn't included - // in the period. For example, if start is 2017-01-01 and end is 2017-05-01, then + // in the period. For example, if start is 2017-01-01 and end is 2017-05-01 , then // the cost and usage data is retrieved from 2017-01-01 up to and including - // 2017-04-30 but not including 2017-05-01. The start date must be equal to or + // 2017-04-30 but not including 2017-05-01 . The start date must be equal to or // later than the current date to avoid a validation error. // // This member is required. @@ -60,57 +57,29 @@ type GetUsageForecastInput struct { // The filters that you want to use to filter your forecast. The GetUsageForecast // API supports filtering by the following dimensions: - // - // * AZ - // - // * INSTANCE_TYPE - // - // * - // LINKED_ACCOUNT - // - // * LINKED_ACCOUNT_NAME - // - // * OPERATION - // - // * PURCHASE_TYPE - // - // * REGION - // - // * - // SERVICE - // - // * USAGE_TYPE - // - // * USAGE_TYPE_GROUP - // - // * RECORD_TYPE - // - // * OPERATING_SYSTEM - // - // * - // TENANCY - // - // * SCOPE - // - // * PLATFORM - // - // * SUBSCRIPTION_ID - // - // * LEGAL_ENTITY_NAME - // - // * - // DEPLOYMENT_OPTION - // - // * DATABASE_ENGINE - // - // * INSTANCE_TYPE_FAMILY - // - // * - // BILLING_ENTITY - // - // * RESERVATION_ID - // - // * SAVINGS_PLAN_ARN + // - AZ + // - INSTANCE_TYPE + // - LINKED_ACCOUNT + // - LINKED_ACCOUNT_NAME + // - OPERATION + // - PURCHASE_TYPE + // - REGION + // - SERVICE + // - USAGE_TYPE + // - USAGE_TYPE_GROUP + // - RECORD_TYPE + // - OPERATING_SYSTEM + // - TENANCY + // - SCOPE + // - PLATFORM + // - SUBSCRIPTION_ID + // - LEGAL_ENTITY_NAME + // - DEPLOYMENT_OPTION + // - DATABASE_ENGINE + // - INSTANCE_TYPE_FAMILY + // - BILLING_ENTITY + // - RESERVATION_ID + // - SAVINGS_PLAN_ARN Filter *types.Expression // Amazon Web Services Cost Explorer always returns the mean forecast as a single diff --git a/service/costexplorer/api_op_ListCostAllocationTags.go b/service/costexplorer/api_op_ListCostAllocationTags.go index 9ac6c0b70b3..7a23eaadffb 100644 --- a/service/costexplorer/api_op_ListCostAllocationTags.go +++ b/service/costexplorer/api_op_ListCostAllocationTags.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get a list of cost allocation tags. All inputs in the API are optional and serve -// as filters. By default, all cost allocation tags are returned. +// Get a list of cost allocation tags. All inputs in the API are optional and +// serve as filters. By default, all cost allocation tags are returned. func (c *Client) ListCostAllocationTags(ctx context.Context, params *ListCostAllocationTagsInput, optFns ...func(*Options)) (*ListCostAllocationTagsOutput, error) { if params == nil { params = &ListCostAllocationTagsInput{} diff --git a/service/costexplorer/api_op_ListCostCategoryDefinitions.go b/service/costexplorer/api_op_ListCostCategoryDefinitions.go index 93b05154509..52db8907e0a 100644 --- a/service/costexplorer/api_op_ListCostCategoryDefinitions.go +++ b/service/costexplorer/api_op_ListCostCategoryDefinitions.go @@ -17,8 +17,8 @@ import ( // EffectiveOn to return a list of Cost Categories that were active on a specific // date. If there is no EffectiveOn specified, you’ll see Cost Categories that are // effective on the current date. If Cost Category is still effective, EffectiveEnd -// is omitted in the response. ListCostCategoryDefinitions supports pagination. The -// request can have a MaxResults range up to 100. +// is omitted in the response. ListCostCategoryDefinitions supports pagination. +// The request can have a MaxResults range up to 100. func (c *Client) ListCostCategoryDefinitions(ctx context.Context, params *ListCostCategoryDefinitionsInput, optFns ...func(*Options)) (*ListCostCategoryDefinitionsOutput, error) { if params == nil { params = &ListCostCategoryDefinitionsInput{} diff --git a/service/costexplorer/api_op_ListTagsForResource.go b/service/costexplorer/api_op_ListTagsForResource.go index 78d3591b1dc..4aee4297d24 100644 --- a/service/costexplorer/api_op_ListTagsForResource.go +++ b/service/costexplorer/api_op_ListTagsForResource.go @@ -31,8 +31,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For a list of supported - // resources, see ResourceTag - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html). + // resources, see ResourceTag (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html) + // . // // This member is required. ResourceArn *string diff --git a/service/costexplorer/api_op_TagResource.go b/service/costexplorer/api_op_TagResource.go index 77f333676ea..2ced3958f12 100644 --- a/service/costexplorer/api_op_TagResource.go +++ b/service/costexplorer/api_op_TagResource.go @@ -37,8 +37,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For a list of supported - // resources, see ResourceTag - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html). + // resources, see ResourceTag (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html) + // . // // This member is required. ResourceArn *string @@ -46,27 +46,17 @@ type TagResourceInput struct { // A list of tag key-value pairs to be added to the resource. Each tag consists of // a key and a value, and each key must be unique for the resource. The following // restrictions apply to resource tags: - // - // * Although the maximum number of array - // members is 200, you can assign a maximum of 50 user-tags to one resource. The - // remaining are reserved for Amazon Web Services use - // - // * The maximum length of a - // key is 128 characters - // - // * The maximum length of a value is 256 characters - // - // * Keys - // and values can only contain alphanumeric characters, spaces, and any of the - // following: _.:/=+@- - // - // * Keys and values are case sensitive - // - // * Keys and values are - // trimmed for any leading or trailing whitespaces - // - // * Don’t use aws: as a prefix - // for your keys. This prefix is reserved for Amazon Web Services use + // - Although the maximum number of array members is 200, you can assign a + // maximum of 50 user-tags to one resource. The remaining are reserved for Amazon + // Web Services use + // - The maximum length of a key is 128 characters + // - The maximum length of a value is 256 characters + // - Keys and values can only contain alphanumeric characters, spaces, and any + // of the following: _.:/=+@- + // - Keys and values are case sensitive + // - Keys and values are trimmed for any leading or trailing whitespaces + // - Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon + // Web Services use // // This member is required. ResourceTags []types.ResourceTag diff --git a/service/costexplorer/api_op_UntagResource.go b/service/costexplorer/api_op_UntagResource.go index 528be986888..2ec57552307 100644 --- a/service/costexplorer/api_op_UntagResource.go +++ b/service/costexplorer/api_op_UntagResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more tags from a resource. Specify only tag keys in your request. -// Don't specify the value. +// Removes one or more tags from a resource. Specify only tag keys in your +// request. Don't specify the value. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -30,8 +30,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For a list of supported - // resources, see ResourceTag - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html). + // resources, see ResourceTag (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html) + // . // // This member is required. ResourceArn *string diff --git a/service/costexplorer/api_op_UpdateAnomalySubscription.go b/service/costexplorer/api_op_UpdateAnomalySubscription.go index e8565677fc8..f3cfbacdb95 100644 --- a/service/costexplorer/api_op_UpdateAnomalySubscription.go +++ b/service/costexplorer/api_op_UpdateAnomalySubscription.go @@ -46,42 +46,37 @@ type UpdateAnomalySubscriptionInput struct { // The new name of the subscription. SubscriptionName *string - // (deprecated) The update to the threshold value for receiving notifications. This - // field has been deprecated. To update a threshold, use ThresholdExpression. + // (deprecated) The update to the threshold value for receiving notifications. + // This field has been deprecated. To update a threshold, use ThresholdExpression. // Continued use of Threshold will be treated as shorthand syntax for a // ThresholdExpression. // // Deprecated: Threshold has been deprecated in favor of ThresholdExpression Threshold *float64 - // The update to the Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // The update to the Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to specify the anomalies that you want to generate alerts for. This // supports dimensions and nested expressions. The supported dimensions are - // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported - // nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL - // is required. Values must be numbers between 0 and 10,000,000,000. The following - // are examples of valid ThresholdExpressions: - // - // * Absolute threshold: { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } - // - // * Percentage threshold: { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } - // - // * AND two thresholds - // together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", - // "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] } - // - // * OR two thresholds - // together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", - // "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] } + // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE . The + // supported nested expression types are AND and OR . The match option + // GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and + // 10,000,000,000. The following are examples of valid ThresholdExpressions: + // - Absolute threshold: { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } + // - Percentage threshold: { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } + // - AND two thresholds together: { "And": [ { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } }, { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } ] } + // - OR two thresholds together: { "Or": [ { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } }, { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } ] } ThresholdExpression *types.Expression noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_UpdateCostCategoryDefinition.go b/service/costexplorer/api_op_UpdateCostCategoryDefinition.go index 1cde9b45ac5..23a0f8304e0 100644 --- a/service/costexplorer/api_op_UpdateCostCategoryDefinition.go +++ b/service/costexplorer/api_op_UpdateCostCategoryDefinition.go @@ -42,8 +42,8 @@ type UpdateCostCategoryDefinitionInput struct { RuleVersion types.CostCategoryRuleVersion // The Expression object used to categorize costs. For more information, see - // CostCategoryRule - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html). + // CostCategoryRule (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) + // . // // This member is required. Rules []types.CostCategoryRule diff --git a/service/costexplorer/doc.go b/service/costexplorer/doc.go index a5daff3b619..65de5ec43f0 100644 --- a/service/costexplorer/doc.go +++ b/service/costexplorer/doc.go @@ -9,10 +9,9 @@ // of daily write operations for Amazon DynamoDB database tables in your production // environment. Service Endpoint The Cost Explorer API provides the following // endpoint: +// - https://ce.us-east-1.amazonaws.com // -// * https://ce.us-east-1.amazonaws.com -// -// For information about the costs -// that are associated with the Cost Explorer API, see Amazon Web Services Cost -// Management Pricing (http://aws.amazon.com/aws-cost-management/pricing/). +// For information about the costs that are associated with the Cost Explorer API, +// see Amazon Web Services Cost Management Pricing (http://aws.amazon.com/aws-cost-management/pricing/) +// . package costexplorer diff --git a/service/costexplorer/types/enums.go b/service/costexplorer/types/enums.go index 66d41cc4d49..48d737ce67e 100644 --- a/service/costexplorer/types/enums.go +++ b/service/costexplorer/types/enums.go @@ -10,9 +10,9 @@ const ( AccountScopeLinked AccountScope = "LINKED" ) -// Values returns all known values for AccountScope. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AccountScope. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AccountScope) Values() []AccountScope { return []AccountScope{ "PAYER", @@ -49,9 +49,10 @@ const ( AnomalySubscriptionFrequencyWeekly AnomalySubscriptionFrequency = "WEEKLY" ) -// Values returns all known values for AnomalySubscriptionFrequency. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AnomalySubscriptionFrequency. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AnomalySubscriptionFrequency) Values() []AnomalySubscriptionFrequency { return []AnomalySubscriptionFrequency{ "DAILY", @@ -106,8 +107,8 @@ const ( CostAllocationTagTypeUserDefined CostAllocationTagType = "UserDefined" ) -// Values returns all known values for CostAllocationTagType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CostAllocationTagType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CostAllocationTagType) Values() []CostAllocationTagType { return []CostAllocationTagType{ @@ -281,9 +282,9 @@ const ( DimensionAnomalyTotalImpactPercentage Dimension = "ANOMALY_TOTAL_IMPACT_PERCENTAGE" ) -// Values returns all known values for Dimension. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Dimension. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Dimension) Values() []Dimension { return []Dimension{ "AZ", @@ -701,9 +702,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/costexplorer/types/errors.go b/service/costexplorer/types/errors.go index 369a77ef173..73db8b057cc 100644 --- a/service/costexplorer/types/errors.go +++ b/service/costexplorer/types/errors.go @@ -137,8 +137,8 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Your request parameters changed between pages. Try again with the old parameters -// or without a pagination token. +// Your request parameters changed between pages. Try again with the old +// parameters or without a pagination token. type RequestChangedException struct { Message *string @@ -302,7 +302,7 @@ func (e *UnknownSubscriptionException) ErrorFault() smithy.ErrorFault { return s // Cost Explorer was unable to identify the usage unit. Provide // UsageType/UsageTypeGroup filter selections that contain matching units, for -// example: hours. +// example: hours . type UnresolvableUsageUnitException struct { Message *string diff --git a/service/costexplorer/types/types.go b/service/costexplorer/types/types.go index 339fd877d2c..81ad1ac5895 100644 --- a/service/costexplorer/types/types.go +++ b/service/costexplorer/types/types.go @@ -64,7 +64,7 @@ type AnomalyDateInterval struct { } // This object continuously inspects your account's cost data for anomalies. It's -// based on MonitorType and MonitorSpecification. The content consists of detailed +// based on MonitorType and MonitorSpecification . The content consists of detailed // metadata and the current status of the monitor object. type AnomalyMonitor struct { @@ -96,84 +96,57 @@ type AnomalyMonitor struct { // The dimensions to evaluate. MonitorDimension MonitorDimension - // Use Expression to filter in various Cost Explorer APIs. Not all Expression types - // are supported in each API. Refer to the documentation for each specific API to - // see what is supported. There are two patterns: - // - // * Simple dimension values. - // - // * - // There are three types of simple dimension values: CostCategories, Tags, and - // Dimensions. - // - // * Specify the CostCategories field to define a filter that acts on - // Cost Categories. - // - // * Specify the Tags field to define a filter that acts on Cost - // Allocation Tags. - // - // * Specify the Dimensions field to define a filter that acts on - // the DimensionValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). - // - // * - // For each filter type, you can set the dimension name and values for the filters - // that you plan to use. - // - // * For example, you can filter for REGION==us-east-1 OR - // REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name - // (for example, REGION==US East (N. Virginia). - // - // * The corresponding Expression for - // this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", “us-west-1” ] } } - // - // * As shown in the previous example, lists of - // dimension values are combined with OR when applying the filter. - // - // * You can also - // set different match options to further control how the filter behaves. Not all - // APIs support match options. Refer to the documentation for each specific API to - // see what is supported. - // - // * For example, you can filter for linked account names - // that start with “a”. - // - // * The corresponding Expression for this example is as - // follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ - // "STARTS_WITH" ], "Values": [ "a" ] } } - // - // * Compound Expression types with logical - // operations. - // - // * You can use multiple Expression types and the logical operators - // AND/OR/NOT to create a list of one or more Expression objects. By doing this, - // you can filter by more advanced options. - // - // * For example, you can filter by - // ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND - // (USAGE_TYPE != DataTransfer). - // - // * The corresponding Expression for this example - // is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ - // "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] - // } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] - // }}} ] } - // - // Because each Expression can have only one operator, the service returns - // an error if more than one is specified. The following example shows an - // Expression object that creates an error: { "And": [ ... ], "Dimensions": { - // "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an - // example of the corresponding error message: "Expression has more than one roots. - // Only one root operator is allowed for each expression: And, Or, Not, Dimensions, - // Tags, CostCategories" - // - // For the GetRightsizingRecommendation action, a - // combination of OR and NOT isn't supported. OR isn't supported between different - // dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions - // are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the + // Use Expression to filter in various Cost Explorer APIs. Not all Expression + // types are supported in each API. Refer to the documentation for each specific + // API to see what is supported. There are two patterns: + // - Simple dimension values. + // - There are three types of simple dimension values: CostCategories , Tags , + // and Dimensions . + // - Specify the CostCategories field to define a filter that acts on Cost + // Categories. + // - Specify the Tags field to define a filter that acts on Cost Allocation Tags. + // - Specify the Dimensions field to define a filter that acts on the + // DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) + // . + // - For each filter type, you can set the dimension name and values for the + // filters that you plan to use. + // - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For + // GetRightsizingRecommendation , the Region is a full name (for example, + // REGION==US East (N. Virginia) . + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } + // - As shown in the previous example, lists of dimension values are combined + // with OR when applying the filter. + // - You can also set different match options to further control how the filter + // behaves. Not all APIs support match options. Refer to the documentation for each + // specific API to see what is supported. + // - For example, you can filter for linked account names that start with “a”. + // - The corresponding Expression for this example is as follows: { + // "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], + // "Values": [ "a" ] } } + // - Compound Expression types with logical operations. + // - You can use multiple Expression types and the logical operators AND/OR/NOT + // to create a list of one or more Expression objects. By doing this, you can + // filter by more advanced options. + // - For example, you can filter by ((REGION == us-east-1 OR REGION == + // us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . + // - The corresponding Expression for this example is as follows: { "And": [ + // {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" + // ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": + // {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } + // Because each Expression can have only one operator, the service returns an + // error if more than one is specified. The following example shows an Expression + // object that creates an error: { "And": [ ... ], "Dimensions": { "Key": + // "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of + // the corresponding error message: "Expression has more than one roots. Only + // one root operator is allowed for each expression: And, Or, Not, Dimensions, + // Tags, CostCategories" + // For the GetRightsizingRecommendation action, a combination of OR and NOT isn't + // supported. OR isn't supported between different dimensions, or dimensions and + // tags. NOT operators aren't supported. Dimensions are also limited to + // LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR - // aren't supported. Dimensions are limited to LINKED_ACCOUNT. + // aren't supported. Dimensions are limited to LINKED_ACCOUNT . MonitorSpecification *Expression noSmithyDocumentSerde @@ -187,7 +160,7 @@ type AnomalyScore struct { // This member is required. CurrentScore float64 - // The maximum score that's observed during the AnomalyDateInterval. + // The maximum score that's observed during the AnomalyDateInterval . // // This member is required. MaxScore float64 @@ -236,35 +209,30 @@ type AnomalySubscription struct { // Deprecated: Threshold has been deprecated in favor of ThresholdExpression Threshold *float64 - // An Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // An Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to specify the anomalies that you want to generate alerts for. This // supports dimensions and nested expressions. The supported dimensions are - // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported - // nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL - // is required. Values must be numbers between 0 and 10,000,000,000. One of - // Threshold or ThresholdExpression is required for this resource. The following - // are examples of valid ThresholdExpressions: - // - // * Absolute threshold: { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } - // - // * Percentage threshold: { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } - // - // * AND two thresholds - // together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", - // "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] } - // - // * OR two thresholds - // together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", - // "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { - // "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ - // "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] } + // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE . The + // supported nested expression types are AND and OR . The match option + // GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and + // 10,000,000,000. One of Threshold or ThresholdExpression is required for this + // resource. The following are examples of valid ThresholdExpressions: + // - Absolute threshold: { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } + // - Percentage threshold: { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } + // - AND two thresholds together: { "And": [ { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } }, { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } ] } + // - OR two thresholds together: { "Or": [ { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } }, { "Dimensions": { "Key": + // "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], + // "Values": [ "100" ] } } ] } ThresholdExpression *Expression noSmithyDocumentSerde @@ -312,8 +280,8 @@ type CostAllocationTagStatusEntry struct { noSmithyDocumentSerde } -// The structure of Cost Categories. This includes detailed metadata and the set of -// rules for the CostCategory object. +// The structure of Cost Categories. This includes detailed metadata and the set +// of rules for the CostCategory object. type CostCategory struct { // The unique identifier for your Cost Category. @@ -349,8 +317,8 @@ type CostCategory struct { // The effective end date of your Cost Category. EffectiveEnd *string - // The list of processing statuses for Cost Management products for a specific cost - // category. + // The list of processing statuses for Cost Management products for a specific + // cost category. ProcessingStatus []CostCategoryProcessingStatus // The split charge rules that are used to allocate your charges between your Cost @@ -361,28 +329,28 @@ type CostCategory struct { } // When you create or update a cost category, you can define the CostCategoryRule -// rule type as INHERITED_VALUE. This rule type adds the flexibility to define a +// rule type as INHERITED_VALUE . This rule type adds the flexibility to define a // rule that dynamically inherits the cost category value from the dimension value -// that's defined by CostCategoryInheritedValueDimension. For example, suppose that -// you want to dynamically group costs that are based on the value of a specific -// tag key. First, choose an inherited value rule type, and then choose the tag -// dimension and specify the tag key to use. +// that's defined by CostCategoryInheritedValueDimension . For example, suppose +// that you want to dynamically group costs that are based on the value of a +// specific tag key. First, choose an inherited value rule type, and then choose +// the tag dimension and specify the tag key to use. type CostCategoryInheritedValueDimension struct { // The key to extract cost category values. DimensionKey *string // The name of the dimension that's used to group costs. If you specify - // LINKED_ACCOUNT_NAME, the cost category value is based on account name. If you - // specify TAG, the cost category value is based on the value of the specified tag + // LINKED_ACCOUNT_NAME , the cost category value is based on account name. If you + // specify TAG , the cost category value is based on the value of the specified tag // key. DimensionName CostCategoryInheritedValueDimensionName noSmithyDocumentSerde } -// The list of processing statuses for Cost Management products for a specific cost -// category. +// The list of processing statuses for Cost Management products for a specific +// cost category. type CostCategoryProcessingStatus struct { // The Cost Management product name of the applied status. @@ -396,7 +364,7 @@ type CostCategoryProcessingStatus struct { // A reference to a Cost Category containing only enough information to identify // the Cost Category. You can use this information to retrieve the full Cost -// Category information using DescribeCostCategory. +// Category information using DescribeCostCategory . type CostCategoryReference struct { // The unique identifier for your Cost Category. @@ -417,8 +385,8 @@ type CostCategoryReference struct { // The number of rules that are associated with a specific Cost Category. NumberOfRules int32 - // The list of processing statuses for Cost Management products for a specific cost - // category. + // The list of processing statuses for Cost Management products for a specific + // cost category. ProcessingStatus []CostCategoryProcessingStatus // A list of unique cost category values in a specific cost category. @@ -436,24 +404,22 @@ type CostCategoryRule struct { // dimension. InheritedValue *CostCategoryInheritedValueDimension - // An Expression - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) + // An Expression (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) // object used to categorize costs. This supports dimensions, tags, and nested - // expressions. Currently the only dimensions supported are LINKED_ACCOUNT, - // SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME. Root level OR isn't + // expressions. Currently the only dimensions supported are LINKED_ACCOUNT , + // SERVICE_CODE , RECORD_TYPE , and LINKED_ACCOUNT_NAME . Root level OR isn't // supported. We recommend that you create a separate rule instead. RECORD_TYPE is // a dimension used for Cost Explorer APIs, and is also supported for Cost Category // expressions. This dimension uses different terms, depending on whether you're // using the console or API/JSON editor. For a detailed comparison, see Term - // Comparisons - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms) + // Comparisons (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms) // in the Billing and Cost Management User Guide. Rule *Expression // You can define the CostCategoryRule rule type as either REGULAR or - // INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility to define a - // rule that dynamically inherits the cost category value. This value is from the - // dimension value that's defined by CostCategoryInheritedValueDimension. For + // INHERITED_VALUE . The INHERITED_VALUE rule type adds the flexibility to define + // a rule that dynamically inherits the cost category value. This value is from the + // dimension value that's defined by CostCategoryInheritedValueDimension . For // example, suppose that you want to costs to be dynamically grouped based on the // value of a specific tag key. First, choose an inherited value rule type, and // then choose the tag dimension and specify the tag key to use. @@ -471,9 +437,9 @@ type CostCategorySplitChargeRule struct { // The method that's used to define how to split your source costs across your // targets. Proportional - Allocates charges across your targets based on the - // proportional weighted cost of each target. Fixed - Allocates charges across your - // targets based on your defined allocation percentage. >Even - Allocates costs - // evenly across all targets. + // proportional weighted cost of each target. Fixed - Allocates charges across + // your targets based on your defined allocation percentage. > Even - Allocates + // costs evenly across all targets. // // This member is required. Method CostCategorySplitChargeMethod @@ -485,8 +451,8 @@ type CostCategorySplitChargeRule struct { // This member is required. Source *string - // The Cost Category values that you want to split costs across. These values can't - // be used as a source in other split charge rules. + // The Cost Category values that you want to split costs across. These values + // can't be used as a source in other split charge rules. // // This member is required. Targets []string @@ -515,11 +481,11 @@ type CostCategorySplitChargeRuleParameter struct { } // The Cost Categories values used for filtering the costs. If Values and Key are -// not specified, the ABSENTMatchOption is applied to all Cost Categories. That is, -// it filters on resources that aren't mapped to any Cost Categories. If Values is -// provided and Key isn't specified, the ABSENTMatchOption is applied to the Cost -// Categories Key only. That is, it filters on resources without the given Cost -// Categories key. +// not specified, the ABSENT MatchOption is applied to all Cost Categories. That +// is, it filters on resources that aren't mapped to any Cost Categories. If Values +// is provided and Key isn't specified, the ABSENT MatchOption is applied to the +// Cost Categories Key only. That is, it filters on resources without the given +// Cost Categories key. type CostCategoryValues struct { // The unique name of the Cost Category. @@ -527,7 +493,7 @@ type CostCategoryValues struct { // The match options that you can use to filter your results. MatchOptions is only // applicable for actions related to cost category. The default values for - // MatchOptions is EQUALS and CASE_SENSITIVE. + // MatchOptions is EQUALS and CASE_SENSITIVE . MatchOptions []MatchOption // The specific value of the Cost Category. @@ -601,9 +567,8 @@ type CoverageHours struct { // show only one instance-hour. When you use normalized units instead of // instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge // instance used 16 normalized units. For more information, see Modifying Reserved -// Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) in the -// Amazon Elastic Compute Cloud User Guide for Linux Instances. +// Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) +// in the Amazon Elastic Compute Cloud User Guide for Linux Instances. type CoverageNormalizedUnits struct { // The percentage of your used instance normalized units that a reservation covers. @@ -667,14 +632,14 @@ type CurrentInstance struct { type DateInterval struct { // The end of the time period. The end date is exclusive. For example, if end is - // 2017-05-01, Amazon Web Services retrieves cost and usage data from the start - // date up to, but not including, 2017-05-01. + // 2017-05-01 , Amazon Web Services retrieves cost and usage data from the start + // date up to, but not including, 2017-05-01 . // // This member is required. End *string // The beginning of the time period. The start date is inclusive. For example, if - // start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting + // start is 2017-01-01 , Amazon Web Services retrieves cost and usage data starting // at 2017-01-01 up to the end date. The start date must be equal to or no later // than the current date to avoid a validation error. // @@ -692,17 +657,16 @@ type DimensionValues struct { // results. For example, AZ returns a list of Availability Zones. Not all // dimensions are supported in each API. Refer to the documentation for each // specific API to see what is supported. LINK_ACCOUNT_NAME and SERVICE_CODE can - // only be used in CostCategoryRule - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html). - // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be - // used in AnomalySubscriptions - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html). + // only be used in CostCategoryRule (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) + // . ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be + // used in AnomalySubscriptions (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) + // . Key Dimension // The match options that you can use to filter your results. MatchOptions is only // applicable for actions related to Cost Category and Anomaly Subscriptions. Refer // to the documentation for each specific API to see what is supported. The default - // values for MatchOptions are EQUALS and CASE_SENSITIVE. + // values for MatchOptions are EQUALS and CASE_SENSITIVE . MatchOptions []MatchOption // The metadata values that you can use to filter and group your results. You can @@ -716,7 +680,7 @@ type DimensionValues struct { // results. You can use GetDimensionValues to find specific values. type DimensionValuesWithAttributes struct { - // The attribute that applies to a specific Dimension. + // The attribute that applies to a specific Dimension . Attributes map[string]string // The value of a dimension with a specific attribute. @@ -916,84 +880,58 @@ type ESInstanceDetails struct { noSmithyDocumentSerde } -// Use Expression to filter in various Cost Explorer APIs. Not all Expression types -// are supported in each API. Refer to the documentation for each specific API to -// see what is supported. There are two patterns: -// -// * Simple dimension values. -// -// * -// There are three types of simple dimension values: CostCategories, Tags, and -// Dimensions. +// Use Expression to filter in various Cost Explorer APIs. Not all Expression +// types are supported in each API. Refer to the documentation for each specific +// API to see what is supported. There are two patterns: +// - Simple dimension values. +// - There are three types of simple dimension values: CostCategories , Tags , +// and Dimensions . +// - Specify the CostCategories field to define a filter that acts on Cost +// Categories. +// - Specify the Tags field to define a filter that acts on Cost Allocation Tags. +// - Specify the Dimensions field to define a filter that acts on the +// DimensionValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html) +// . +// - For each filter type, you can set the dimension name and values for the +// filters that you plan to use. +// - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For +// GetRightsizingRecommendation , the Region is a full name (for example, +// REGION==US East (N. Virginia) . +// - The corresponding Expression for this example is as follows: { +// "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } +// - As shown in the previous example, lists of dimension values are combined +// with OR when applying the filter. +// - You can also set different match options to further control how the filter +// behaves. Not all APIs support match options. Refer to the documentation for each +// specific API to see what is supported. +// - For example, you can filter for linked account names that start with “a”. +// - The corresponding Expression for this example is as follows: { +// "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], +// "Values": [ "a" ] } } +// - Compound Expression types with logical operations. +// - You can use multiple Expression types and the logical operators AND/OR/NOT +// to create a list of one or more Expression objects. By doing this, you can +// filter by more advanced options. +// - For example, you can filter by ((REGION == us-east-1 OR REGION == +// us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . +// - The corresponding Expression for this example is as follows: { "And": [ +// {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" +// ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": +// {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } +// Because each Expression can have only one operator, the service returns an +// error if more than one is specified. The following example shows an Expression +// object that creates an error: { "And": [ ... ], "Dimensions": { "Key": +// "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of +// the corresponding error message: "Expression has more than one roots. Only +// one root operator is allowed for each expression: And, Or, Not, Dimensions, +// Tags, CostCategories" // -// * Specify the CostCategories field to define a filter that acts on -// Cost Categories. -// -// * Specify the Tags field to define a filter that acts on Cost -// Allocation Tags. -// -// * Specify the Dimensions field to define a filter that acts on -// the DimensionValues -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html). -// -// * -// For each filter type, you can set the dimension name and values for the filters -// that you plan to use. -// -// * For example, you can filter for REGION==us-east-1 OR -// REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name -// (for example, REGION==US East (N. Virginia). -// -// * The corresponding Expression for -// this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ -// "us-east-1", “us-west-1” ] } } -// -// * As shown in the previous example, lists of -// dimension values are combined with OR when applying the filter. -// -// * You can also -// set different match options to further control how the filter behaves. Not all -// APIs support match options. Refer to the documentation for each specific API to -// see what is supported. -// -// * For example, you can filter for linked account names -// that start with “a”. -// -// * The corresponding Expression for this example is as -// follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ -// "STARTS_WITH" ], "Values": [ "a" ] } } -// -// * Compound Expression types with logical -// operations. -// -// * You can use multiple Expression types and the logical operators -// AND/OR/NOT to create a list of one or more Expression objects. By doing this, -// you can filter by more advanced options. -// -// * For example, you can filter by -// ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND -// (USAGE_TYPE != DataTransfer). -// -// * The corresponding Expression for this example -// is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ -// "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] -// } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] -// }}} ] } -// -// Because each Expression can have only one operator, the service returns -// an error if more than one is specified. The following example shows an -// Expression object that creates an error: { "And": [ ... ], "Dimensions": { -// "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an -// example of the corresponding error message: "Expression has more than one roots. -// Only one root operator is allowed for each expression: And, Or, Not, Dimensions, -// Tags, CostCategories" -// -// For the GetRightsizingRecommendation action, a -// combination of OR and NOT isn't supported. OR isn't supported between different -// dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions -// are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the +// For the GetRightsizingRecommendation action, a combination of OR and NOT isn't +// supported. OR isn't supported between different dimensions, or dimensions and +// tags. NOT operators aren't supported. Dimensions are also limited to +// LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE . For the // GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR -// aren't supported. Dimensions are limited to LINKED_ACCOUNT. +// aren't supported. Dimensions are limited to LINKED_ACCOUNT . type Expression struct { // Return results that match both Dimension objects. @@ -1002,7 +940,7 @@ type Expression struct { // The filter that's based on CostCategory values. CostCategories *CostCategoryValues - // The specific Dimension to use for Expression. + // The specific Dimension to use for Expression . Dimensions *DimensionValues // Return results that don't match a Dimension object. @@ -1011,7 +949,7 @@ type Expression struct { // Return results that match either Dimension object. Or []Expression - // The specific Tag to use for Expression. + // The specific Tag to use for Expression . Tags *TagValues noSmithyDocumentSerde @@ -1100,11 +1038,11 @@ type Impact struct { TotalExpectedSpend *float64 // The cumulative dollar difference between the total actual spend and total - // expected spend. It is calculated as TotalActualSpend - TotalExpectedSpend. + // expected spend. It is calculated as TotalActualSpend - TotalExpectedSpend . TotalImpact float64 // The cumulative percentage difference between the total actual spend and total - // expected spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100. + // expected spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100 . // When TotalExpectedSpend is zero, this field is omitted. Expected spend can be // zero in situations such as when you start to use a service for the first time. TotalImpactPercentage *float64 @@ -1119,8 +1057,8 @@ type InstanceDetails struct { // The Amazon EC2 instances that Amazon Web Services recommends that you purchase. EC2InstanceDetails *EC2InstanceDetails - // The Amazon OpenSearch Service instances that Amazon Web Services recommends that - // you purchase. + // The Amazon OpenSearch Service instances that Amazon Web Services recommends + // that you purchase. ESInstanceDetails *ESInstanceDetails // The ElastiCache instances that Amazon Web Services recommends that you purchase. @@ -1247,7 +1185,7 @@ type ReservationAggregates struct { // How much you saved due to purchasing and utilizing reservation. Amazon Web // Services calculates this by subtracting TotalAmortizedFee from - // OnDemandCostOfRIHoursUsed. + // OnDemandCostOfRIHoursUsed . NetRISavings *string // How much your reservation costs if charged On-Demand rates. @@ -1256,9 +1194,9 @@ type ReservationAggregates struct { // How many reservation hours that you purchased. PurchasedHours *string - // The number of Amazon EC2 reservation hours that you purchased. It's converted to - // normalized units. Normalized units are available only for Amazon EC2 usage after - // November 11, 2017. + // The number of Amazon EC2 reservation hours that you purchased. It's converted + // to normalized units. Normalized units are available only for Amazon EC2 usage + // after November 11, 2017. PurchasedUnits *string // The cost of unused hours for your reservation. @@ -1327,7 +1265,7 @@ type ReservationPurchaseRecommendation struct { // this recommendation. LookbackPeriodInDays LookbackPeriodInDays - // The payment option for the reservation (for example, AllUpfront or NoUpfront). + // The payment option for the reservation (for example, AllUpfront or NoUpfront ). PaymentOption PaymentOption // Details about the recommended purchases. @@ -1385,8 +1323,8 @@ type ReservationPurchaseRecommendationDetail struct { // save you in a month, as a percentage of your overall costs. EstimatedMonthlySavingsPercentage *string - // How much Amazon Web Services estimates that you might spend for all usage during - // the specified historical period if you had a reservation. + // How much Amazon Web Services estimates that you might spend for all usage + // during the specified historical period if you had a reservation. EstimatedReservationCostForLookbackPeriod *string // Details about the instances that Amazon Web Services recommends that you @@ -1489,12 +1427,10 @@ type ResourceDetails struct { } // The tag structure that contains a tag key and value. Tagging is supported only -// for the following Cost Explorer resource types: AnomalyMonitor -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html), -// AnomalySubscription -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html), -// CostCategory -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html). +// for the following Cost Explorer resource types: AnomalyMonitor (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) +// , AnomalySubscription (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) +// , CostCategory (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html) +// . type ResourceTag struct { // The key that's associated with the tag. @@ -1546,8 +1482,9 @@ type RightsizingRecommendation struct { // Context regarding the current instance. CurrentInstance *CurrentInstance - // The list of possible reasons why the recommendation is generated, such as under- - // or over-utilization of specific metrics (for example, CPU, Memory, Network). + // The list of possible reasons why the recommendation is generated, such as + // under- or over-utilization of specific metrics (for example, CPU, Memory, + // Network). FindingReasonCodes []FindingReasonCode // The details for the modification recommendations. @@ -1571,14 +1508,14 @@ type RightsizingRecommendation struct { type RightsizingRecommendationConfiguration struct { // The option to consider RI or Savings Plans discount benefits in your savings - // calculation. The default value is TRUE. + // calculation. The default value is TRUE . // // This member is required. BenefitsConsidered bool // The option to see recommendations within the same instance family or // recommendations for instances across other families. The default value is - // SAME_INSTANCE_FAMILY. + // SAME_INSTANCE_FAMILY . // // This member is required. RecommendationTarget RecommendationTarget @@ -1652,11 +1589,11 @@ type RootCause struct { type SavingsPlansAmortizedCommitment struct { // The amortized amount of your Savings Plans commitment that was purchased with - // either a Partial or a NoUpfront. + // either a Partial or a NoUpfront . AmortizedRecurringCommitment *string - // The amortized amount of your Savings Plans commitment that was purchased with an - // Upfront or PartialUpfront Savings Plans. + // The amortized amount of your Savings Plans commitment that was purchased with + // an Upfront or PartialUpfront Savings Plans. AmortizedUpfrontCommitment *string // The total amortized amount of your Savings Plans commitment, regardless of your @@ -1670,7 +1607,7 @@ type SavingsPlansAmortizedCommitment struct { // calculations consider the On-Demand equivalent of your Savings Plans usage. type SavingsPlansCoverage struct { - // The attribute that applies to a specific Dimension. + // The attribute that applies to a specific Dimension . Attributes map[string]string // The amount of Savings Plans eligible usage that the Savings Plans covered. @@ -1725,7 +1662,7 @@ type SavingsPlansPurchaseRecommendation struct { // The account scope that you want your recommendations for. Amazon Web Services // calculates recommendations that include the management account and member - // accounts if the value is set to PAYER. If the value is LINKED, recommendations + // accounts if the value is set to PAYER . If the value is LINKED , recommendations // are calculated for individual member accounts only. AccountScope AccountScope @@ -1784,13 +1721,13 @@ type SavingsPlansPurchaseRecommendationDetail struct { // Savings Plans, over the length of the lookback period. EstimatedOnDemandCost *string - // The estimated On-Demand costs you expect with no additional commitment, based on - // your usage of the selected time period and the Savings Plans you own. + // The estimated On-Demand costs you expect with no additional commitment, based + // on your usage of the selected time period and the Savings Plans you own. EstimatedOnDemandCostWithCurrentCommitment *string - // The estimated return on investment that's based on the recommended Savings Plans - // that you purchased. This is calculated as estimatedSavingsAmount/ - // estimatedSPCost*100. + // The estimated return on investment that's based on the recommended Savings + // Plans that you purchased. This is calculated as estimatedSavingsAmount / + // estimatedSPCost *100. EstimatedROI *string // The cost of the recommended Savings Plans over the length of the lookback @@ -1812,8 +1749,8 @@ type SavingsPlansPurchaseRecommendationDetail struct { // Details for your recommended Savings Plans. SavingsPlansDetails *SavingsPlansDetails - // The upfront cost of the recommended Savings Plans, based on the selected payment - // option. + // The upfront cost of the recommended Savings Plans, based on the selected + // payment option. UpfrontCost *string noSmithyDocumentSerde @@ -1856,8 +1793,8 @@ type SavingsPlansPurchaseRecommendationSummary struct { // based on your usage of the selected time period and the Savings Plans you own. EstimatedOnDemandCostWithCurrentCommitment *string - // The estimated return on investment that's based on the recommended Savings Plans - // and estimated savings. + // The estimated return on investment that's based on the recommended Savings + // Plans and estimated savings. EstimatedROI *string // The estimated total savings over the lookback period, based on the purchase of @@ -1865,8 +1802,8 @@ type SavingsPlansPurchaseRecommendationSummary struct { EstimatedSavingsAmount *string // The estimated savings relative to the total cost of On-Demand usage, over the - // lookback period. This is calculated as estimatedSavingsAmount/ - // CurrentOnDemandSpend*100. + // lookback period. This is calculated as estimatedSavingsAmount / + // CurrentOnDemandSpend *100. EstimatedSavingsPercentage *string // The estimated total cost of the usage after purchasing the recommended Savings @@ -1902,16 +1839,16 @@ type SavingsPlansSavings struct { // The measurement of how well you're using your existing Savings Plans. type SavingsPlansUtilization struct { - // The total amount of Savings Plans commitment that's been purchased in an account - // (or set of accounts). + // The total amount of Savings Plans commitment that's been purchased in an + // account (or set of accounts). TotalCommitment *string // The amount of your Savings Plans commitment that wasn't consumed from Savings // Plans eligible usage in a specific period. UnusedCommitment *string - // The amount of your Savings Plans commitment that was consumed from Savings Plans - // eligible usage in a specific period. + // The amount of your Savings Plans commitment that was consumed from Savings + // Plans eligible usage in a specific period. UsedCommitment *string // The amount of UsedCommitment divided by the TotalCommitment for your Savings @@ -1930,8 +1867,8 @@ type SavingsPlansUtilizationAggregates struct { // This member is required. Utilization *SavingsPlansUtilization - // The total amortized commitment for a Savings Plans. This includes the sum of the - // upfront and recurring Savings Plans fees. + // The total amortized commitment for a Savings Plans. This includes the sum of + // the upfront and recurring Savings Plans fees. AmortizedCommitment *SavingsPlansAmortizedCommitment // The amount that's saved by using existing Savings Plans. Savings returns both @@ -1956,8 +1893,8 @@ type SavingsPlansUtilizationByTime struct { // This member is required. Utilization *SavingsPlansUtilization - // The total amortized commitment for a Savings Plans. This includes the sum of the - // upfront and recurring Savings Plans fees. + // The total amortized commitment for a Savings Plans. This includes the sum of + // the upfront and recurring Savings Plans fees. AmortizedCommitment *SavingsPlansAmortizedCommitment // The amount that's saved by using existing Savings Plans. Savings returns both @@ -1977,7 +1914,7 @@ type SavingsPlansUtilizationDetail struct { // upfront and recurring Savings Plans fees. AmortizedCommitment *SavingsPlansAmortizedCommitment - // The attribute that applies to a specific Dimension. + // The attribute that applies to a specific Dimension . Attributes map[string]string // The amount saved by using existing Savings Plans. Savings returns both net @@ -2022,7 +1959,7 @@ type SortDefinition struct { // The recipient of AnomalySubscription notifications. type Subscriber struct { - // The email address or SNS Amazon Resource Name (ARN). This depends on the Type. + // The email address or SNS Amazon Resource Name (ARN). This depends on the Type . Address *string // Indicates if the subscriber accepts the notifications. @@ -2034,10 +1971,10 @@ type Subscriber struct { noSmithyDocumentSerde } -// The values that are available for a tag. If Values and Key aren't specified, the -// ABSENTMatchOption is applied to all tags. That is, it's filtered on resources -// with no tags. If Key is provided and Values isn't specified, the -// ABSENTMatchOption is applied to the tag Key only. That is, it's filtered on +// The values that are available for a tag. If Values and Key aren't specified, +// the ABSENT MatchOption is applied to all tags. That is, it's filtered on +// resources with no tags. If Key is provided and Values isn't specified, the +// ABSENT MatchOption is applied to the tag Key only. That is, it's filtered on // resources without the given tag key. type TagValues struct { @@ -2046,7 +1983,7 @@ type TagValues struct { // The match options that you can use to filter your results. MatchOptions is only // applicable for actions related to Cost Category. The default values for - // MatchOptions are EQUALS and CASE_SENSITIVE. + // MatchOptions are EQUALS and CASE_SENSITIVE . MatchOptions []MatchOption // The specific value of the tag. diff --git a/service/customerprofiles/api_client.go b/service/customerprofiles/api_client.go index 4a4472c01eb..d0041343dae 100644 --- a/service/customerprofiles/api_client.go +++ b/service/customerprofiles/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/customerprofiles/api_op_CreateDomain.go b/service/customerprofiles/api_op_CreateDomain.go index 5f8a487562a..1e778c10636 100644 --- a/service/customerprofiles/api_op_CreateDomain.go +++ b/service/customerprofiles/api_op_CreateDomain.go @@ -17,13 +17,10 @@ import ( // create multiple domains, and each domain can have multiple third-party // integrations. Each Amazon Connect instance can be associated with only one // domain. Multiple Amazon Connect instances can be associated with one domain. Use -// this API or UpdateDomain -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) -// to enable identity resolution -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): -// set Matching to true. To prevent cross-service impersonation when you call this -// API, see Cross-service confused deputy prevention -// (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) +// this API or UpdateDomain (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) +// to enable identity resolution (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) +// : set Matching to true. To prevent cross-service impersonation when you call +// this API, see Cross-service confused deputy prevention (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) // for sample policies that you should apply. func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { @@ -63,14 +60,13 @@ type CreateDomainInput struct { // before it is placed in permanent or semi-permanent storage. DefaultEncryptionKey *string - // The process of matching duplicate profiles. If Matching = true, Amazon Connect + // The process of matching duplicate profiles. If Matching = true , Amazon Connect // Customer Profiles starts a weekly batch process called Identity Resolution Job. // If you do not specify a date and time for Identity Resolution Job to run, by // default it runs every Saturday at 12AM UTC to detect duplicate profiles in your - // domains. After the Identity Resolution Job completes, use the GetMatches - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) + // domains. After the Identity Resolution Job completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest, you can download the results from S3. + // in the MatchingRequest , you can download the results from S3. Matching *types.MatchingRequest // The tags used to organize, track, or control access for this resource. @@ -110,14 +106,13 @@ type CreateDomainOutput struct { // before it is placed in permanent or semi-permanent storage. DefaultEncryptionKey *string - // The process of matching duplicate profiles. If Matching = true, Amazon Connect + // The process of matching duplicate profiles. If Matching = true , Amazon Connect // Customer Profiles starts a weekly batch process called Identity Resolution Job. // If you do not specify a date and time for Identity Resolution Job to run, by // default it runs every Saturday at 12AM UTC to detect duplicate profiles in your - // domains. After the Identity Resolution Job completes, use the GetMatches - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) + // domains. After the Identity Resolution Job completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest, you can download the results from S3. + // in the MatchingRequest , you can download the results from S3. Matching *types.MatchingResponse // The tags used to organize, track, or control access for this resource. diff --git a/service/customerprofiles/api_op_CreateProfile.go b/service/customerprofiles/api_op_CreateProfile.go index c8524d485b1..efb7cfbafca 100644 --- a/service/customerprofiles/api_op_CreateProfile.go +++ b/service/customerprofiles/api_op_CreateProfile.go @@ -41,8 +41,8 @@ type CreateProfileInput struct { // Any additional information relevant to the customer’s profile. AdditionalInformation *string - // A generic address associated with the customer that is not mailing, shipping, or - // billing. + // A generic address associated with the customer that is not mailing, shipping, + // or billing. Address *types.Address // A key value pair of attributes of a customer profile. diff --git a/service/customerprofiles/api_op_DeleteDomain.go b/service/customerprofiles/api_op_DeleteDomain.go index c58f6f66f10..0c899d9a824 100644 --- a/service/customerprofiles/api_op_DeleteDomain.go +++ b/service/customerprofiles/api_op_DeleteDomain.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific domain and all of its customer data, such as customer profile -// attributes and their related objects. +// Deletes a specific domain and all of its customer data, such as customer +// profile attributes and their related objects. func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} diff --git a/service/customerprofiles/api_op_GetAutoMergingPreview.go b/service/customerprofiles/api_op_GetAutoMergingPreview.go index 3fe30a56e2b..116374f2196 100644 --- a/service/customerprofiles/api_op_GetAutoMergingPreview.go +++ b/service/customerprofiles/api_op_GetAutoMergingPreview.go @@ -20,7 +20,7 @@ import ( // are matched and would be merged. We strongly recommend you use this API to do a // dry run of the automerging process before running the Identity Resolution Job. // Include at least two matching attributes. If your matching list includes too few -// attributes (such as only FirstName or only LastName), there may be a large +// attributes (such as only FirstName or only LastName ), there may be a large // number of matches. This increases the chances of erroneous merges. func (c *Client) GetAutoMergingPreview(ctx context.Context, params *GetAutoMergingPreviewInput, optFns ...func(*Options)) (*GetAutoMergingPreviewOutput, error) { if params == nil { @@ -69,8 +69,8 @@ type GetAutoMergingPreviewOutput struct { // This member is required. DomainName *string - // The number of match groups in the domain that have been reviewed in this preview - // dry run. + // The number of match groups in the domain that have been reviewed in this + // preview dry run. NumberOfMatchesInSample int64 // The number of profiles found in this preview dry run. diff --git a/service/customerprofiles/api_op_GetDomain.go b/service/customerprofiles/api_op_GetDomain.go index 3c31290e042..e833ec79bf1 100644 --- a/service/customerprofiles/api_op_GetDomain.go +++ b/service/customerprofiles/api_op_GetDomain.go @@ -67,14 +67,13 @@ type GetDomainOutput struct { // The default number of days until the data within the domain expires. DefaultExpirationDays *int32 - // The process of matching duplicate profiles. If Matching = true, Amazon Connect + // The process of matching duplicate profiles. If Matching = true , Amazon Connect // Customer Profiles starts a weekly batch process called Identity Resolution Job. // If you do not specify a date and time for Identity Resolution Job to run, by // default it runs every Saturday at 12AM UTC to detect duplicate profiles in your - // domains. After the Identity Resolution Job completes, use the GetMatches - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) + // domains. After the Identity Resolution Job completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest, you can download the results from S3. + // in the MatchingRequest , you can download the results from S3. Matching *types.MatchingResponse // Usage-specific statistics about the domain. diff --git a/service/customerprofiles/api_op_GetIdentityResolutionJob.go b/service/customerprofiles/api_op_GetIdentityResolutionJob.go index ebba84c43e8..0c034ed0054 100644 --- a/service/customerprofiles/api_op_GetIdentityResolutionJob.go +++ b/service/customerprofiles/api_op_GetIdentityResolutionJob.go @@ -14,8 +14,8 @@ import ( // Returns information about an Identity Resolution Job in a specific domain. // Identity Resolution Jobs are set up using the Amazon Connect admin console. For -// more information, see Use Identity Resolution to consolidate similar profiles -// (https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html). +// more information, see Use Identity Resolution to consolidate similar profiles (https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html) +// . func (c *Client) GetIdentityResolutionJob(ctx context.Context, params *GetIdentityResolutionJobInput, optFns ...func(*Options)) (*GetIdentityResolutionJobOutput, error) { if params == nil { params = &GetIdentityResolutionJobInput{} @@ -80,31 +80,19 @@ type GetIdentityResolutionJobOutput struct { Message *string // The status of the Identity Resolution Job. - // - // * PENDING: The Identity Resolution - // Job is scheduled but has not started yet. If you turn off the Identity - // Resolution feature in your domain, jobs in the PENDING state are deleted. - // - // * - // PREPROCESSING: The Identity Resolution Job is loading your data. - // - // * - // FIND_MATCHING: The Identity Resolution Job is using the machine learning model - // to identify profiles that belong to the same matching group. - // - // * MERGING: The - // Identity Resolution Job is merging duplicate profiles. - // - // * COMPLETED: The - // Identity Resolution Job completed successfully. - // - // * PARTIAL_SUCCESS: There's a - // system error and not all of the data is merged. The Identity Resolution Job - // writes a message indicating the source of the problem. - // - // * FAILED: The Identity - // Resolution Job did not merge any data. It writes a message indicating the source - // of the problem. + // - PENDING : The Identity Resolution Job is scheduled but has not started yet. + // If you turn off the Identity Resolution feature in your domain, jobs in the + // PENDING state are deleted. + // - PREPROCESSING : The Identity Resolution Job is loading your data. + // - FIND_MATCHING : The Identity Resolution Job is using the machine learning + // model to identify profiles that belong to the same matching group. + // - MERGING : The Identity Resolution Job is merging duplicate profiles. + // - COMPLETED : The Identity Resolution Job completed successfully. + // - PARTIAL_SUCCESS : There's a system error and not all of the data is merged. + // The Identity Resolution Job writes a message indicating the source of the + // problem. + // - FAILED : The Identity Resolution Job did not merge any data. It writes a + // message indicating the source of the problem. Status types.IdentityResolutionJobStatus // Metadata pertaining to the operation's result. diff --git a/service/customerprofiles/api_op_GetIntegration.go b/service/customerprofiles/api_op_GetIntegration.go index 3d19b0c95a8..510b0b66b33 100644 --- a/service/customerprofiles/api_op_GetIntegration.go +++ b/service/customerprofiles/api_op_GetIntegration.go @@ -64,9 +64,9 @@ type GetIntegrationOutput struct { // This member is required. Uri *string - // Boolean that shows if the Flow that's associated with the Integration is created - // in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in - // flowDefinition. + // Boolean that shows if the Flow that's associated with the Integration is + // created in Amazon Appflow, or with ObjectTypeName equals _unstructured via + // API/CLI in flowDefinition. IsUnstructured *bool // The name of the profile object type. @@ -74,9 +74,9 @@ type GetIntegrationOutput struct { // A map in which each key is an event type from an external application such as // Segment or Shopify, and each value is an ObjectTypeName (template) used to - // ingest the event. It supports the following event types: SegmentIdentify, - // ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, - // ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders. + // ingest the event. It supports the following event types: SegmentIdentify , + // ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , + // ShopifyUpdateDraftOrders , ShopifyCreateOrders , and ShopifyUpdatedOrders . ObjectTypeNames map[string]string // The tags used to organize, track, or control access for this resource. diff --git a/service/customerprofiles/api_op_GetMatches.go b/service/customerprofiles/api_op_GetMatches.go index 551db0d0b05..cdc23c9c258 100644 --- a/service/customerprofiles/api_op_GetMatches.go +++ b/service/customerprofiles/api_op_GetMatches.go @@ -12,44 +12,30 @@ import ( "time" ) -// Before calling this API, use CreateDomain -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) -// or UpdateDomain -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) +// Before calling this API, use CreateDomain (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) +// or UpdateDomain (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) // to enable identity resolution: set Matching to true. GetMatches returns // potentially matching profiles, based on the results of the latest run of a // machine learning process. The process of matching duplicate profiles. If -// Matching = true, Amazon Connect Customer Profiles starts a weekly batch process +// Matching = true , Amazon Connect Customer Profiles starts a weekly batch process // called Identity Resolution Job. If you do not specify a date and time for // Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to // detect duplicate profiles in your domains. After the Identity Resolution Job -// completes, use the GetMatches -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) +// completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig -// in the MatchingRequest, you can download the results from S3. Amazon Connect +// in the MatchingRequest , you can download the results from S3. Amazon Connect // uses the following profile attributes to identify matches: +// - PhoneNumber +// - HomePhoneNumber +// - BusinessPhoneNumber +// - MobilePhoneNumber +// - EmailAddress +// - PersonalEmailAddress +// - BusinessEmailAddress +// - FullName // -// * PhoneNumber -// -// * -// HomePhoneNumber -// -// * BusinessPhoneNumber -// -// * MobilePhoneNumber -// -// * EmailAddress -// -// * -// PersonalEmailAddress -// -// * BusinessEmailAddress -// -// * FullName -// -// For example, two or -// more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different -// casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and +// For example, two or more profiles—with spelling mistakes such as John Doe and +// Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and // johndoe@anycompany.com, or different phone number formats such as 555-010-0000 // and +1-555-010-0000—can be detected as belonging to the same customer John Doe // and merged into a unified profile. diff --git a/service/customerprofiles/api_op_GetProfileObjectType.go b/service/customerprofiles/api_op_GetProfileObjectType.go index 3d06ddcc25d..6635de57fe7 100644 --- a/service/customerprofiles/api_op_GetProfileObjectType.go +++ b/service/customerprofiles/api_op_GetProfileObjectType.go @@ -56,10 +56,10 @@ type GetProfileObjectTypeOutput struct { ObjectTypeName *string // Indicates whether a profile should be created when data is received if one - // doesn’t exist for an object of this type. The default is FALSE. If the - // AllowProfileCreation flag is set to FALSE, then the service tries to fetch a + // doesn’t exist for an object of this type. The default is FALSE . If the + // AllowProfileCreation flag is set to FALSE , then the service tries to fetch a // standard profile and associate this object with the profile. If it is set to - // TRUE, and if no match is found, then the service creates a new standard profile. + // TRUE , and if no match is found, then the service creates a new standard profile. AllowProfileCreation bool // The timestamp of when the domain was created. diff --git a/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go b/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go index ed3eb44932e..40e95b19aa5 100644 --- a/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go +++ b/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go @@ -44,10 +44,10 @@ type GetProfileObjectTypeTemplateInput struct { type GetProfileObjectTypeTemplateOutput struct { // Indicates whether a profile should be created when data is received if one - // doesn’t exist for an object of this type. The default is FALSE. If the - // AllowProfileCreation flag is set to FALSE, then the service tries to fetch a + // doesn’t exist for an object of this type. The default is FALSE . If the + // AllowProfileCreation flag is set to FALSE , then the service tries to fetch a // standard profile and associate this object with the profile. If it is set to - // TRUE, and if no match is found, then the service creates a new standard profile. + // TRUE , and if no match is found, then the service creates a new standard profile. AllowProfileCreation bool // A map of the name and ObjectType field. diff --git a/service/customerprofiles/api_op_ListAccountIntegrations.go b/service/customerprofiles/api_op_ListAccountIntegrations.go index bd932fd0b5e..8a679a37332 100644 --- a/service/customerprofiles/api_op_ListAccountIntegrations.go +++ b/service/customerprofiles/api_op_ListAccountIntegrations.go @@ -34,7 +34,7 @@ type ListAccountIntegrationsInput struct { // This member is required. Uri *string - // Boolean to indicate if hidden integration should be returned. Defaults to False. + // Boolean to indicate if hidden integration should be returned. Defaults to False . IncludeHidden *bool // The maximum number of objects returned per page. diff --git a/service/customerprofiles/api_op_ListIdentityResolutionJobs.go b/service/customerprofiles/api_op_ListIdentityResolutionJobs.go index 06b236137eb..bb0ff808df7 100644 --- a/service/customerprofiles/api_op_ListIdentityResolutionJobs.go +++ b/service/customerprofiles/api_op_ListIdentityResolutionJobs.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all of the Identity Resolution Jobs in your domain. The response sorts the -// list by JobStartTime. +// Lists all of the Identity Resolution Jobs in your domain. The response sorts +// the list by JobStartTime . func (c *Client) ListIdentityResolutionJobs(ctx context.Context, params *ListIdentityResolutionJobsInput, optFns ...func(*Options)) (*ListIdentityResolutionJobsOutput, error) { if params == nil { params = &ListIdentityResolutionJobsInput{} diff --git a/service/customerprofiles/api_op_ListIntegrations.go b/service/customerprofiles/api_op_ListIntegrations.go index 525c532ba0d..bfbb0129857 100644 --- a/service/customerprofiles/api_op_ListIntegrations.go +++ b/service/customerprofiles/api_op_ListIntegrations.go @@ -34,7 +34,7 @@ type ListIntegrationsInput struct { // This member is required. DomainName *string - // Boolean to indicate if hidden integration should be returned. Defaults to False. + // Boolean to indicate if hidden integration should be returned. Defaults to False . IncludeHidden *bool // The maximum number of objects returned per page. diff --git a/service/customerprofiles/api_op_MergeProfiles.go b/service/customerprofiles/api_op_MergeProfiles.go index 241df6cc27f..183d6f8c272 100644 --- a/service/customerprofiles/api_op_MergeProfiles.go +++ b/service/customerprofiles/api_op_MergeProfiles.go @@ -12,38 +12,23 @@ import ( ) // Runs an AWS Lambda job that does the following: +// - All the profileKeys in the ProfileToBeMerged will be moved to the main +// profile. +// - All the objects in the ProfileToBeMerged will be moved to the main profile. +// - All the ProfileToBeMerged will be deleted at the end. +// - All the profileKeys in the ProfileIdsToBeMerged will be moved to the main +// profile. +// - Standard fields are merged as follows: +// - Fields are always "union"-ed if there are no conflicts in standard fields +// or attributeKeys. +// - When there are conflicting fields: +// - If no SourceProfileIds entry is specified, the main Profile value is always +// taken. +// - If a SourceProfileIds entry is specified, the specified profileId is always +// taken, even if it is a NULL value. // -// * All the profileKeys in the -// ProfileToBeMerged will be moved to the main profile. -// -// * All the objects in the -// ProfileToBeMerged will be moved to the main profile. -// -// * All the -// ProfileToBeMerged will be deleted at the end. -// -// * All the profileKeys in the -// ProfileIdsToBeMerged will be moved to the main profile. -// -// * Standard fields are -// merged as follows: -// -// * Fields are always "union"-ed if there are no conflicts in -// standard fields or attributeKeys. -// -// * When there are conflicting fields: -// -// * If no -// SourceProfileIds entry is specified, the main Profile value is always taken. -// -// * -// If a SourceProfileIds entry is specified, the specified profileId is always -// taken, even if it is a NULL value. -// -// You can use MergeProfiles together with -// GetMatches -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html), -// which returns potentially matching profiles, or use it with the results of +// You can use MergeProfiles together with GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) +// , which returns potentially matching profiles, or use it with the results of // another matching system. After profiles have been merged, they cannot be // separated (unmerged). func (c *Client) MergeProfiles(ctx context.Context, params *MergeProfilesInput, optFns ...func(*Options)) (*MergeProfilesOutput, error) { diff --git a/service/customerprofiles/api_op_PutIntegration.go b/service/customerprofiles/api_op_PutIntegration.go index fa584670276..d440935d69f 100644 --- a/service/customerprofiles/api_op_PutIntegration.go +++ b/service/customerprofiles/api_op_PutIntegration.go @@ -14,10 +14,9 @@ import ( // Adds an integration between the service and a third-party service, which // includes Amazon AppFlow and Amazon Connect. An integration can belong to only -// one domain. To add or remove tags on an existing Integration, see TagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/ -// UntagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). +// one domain. To add or remove tags on an existing Integration, see TagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html) +// / UntagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html) +// . func (c *Client) PutIntegration(ctx context.Context, params *PutIntegrationInput, optFns ...func(*Options)) (*PutIntegrationOutput, error) { if params == nil { params = &PutIntegrationInput{} @@ -49,9 +48,9 @@ type PutIntegrationInput struct { // A map in which each key is an event type from an external application such as // Segment or Shopify, and each value is an ObjectTypeName (template) used to - // ingest the event. It supports the following event types: SegmentIdentify, - // ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, - // ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders. + // ingest the event. It supports the following event types: SegmentIdentify , + // ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , + // ShopifyUpdateDraftOrders , ShopifyCreateOrders , and ShopifyUpdatedOrders . ObjectTypeNames map[string]string // The tags used to organize, track, or control access for this resource. @@ -85,9 +84,9 @@ type PutIntegrationOutput struct { // This member is required. Uri *string - // Boolean that shows if the Flow that's associated with the Integration is created - // in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in - // flowDefinition. + // Boolean that shows if the Flow that's associated with the Integration is + // created in Amazon Appflow, or with ObjectTypeName equals _unstructured via + // API/CLI in flowDefinition. IsUnstructured *bool // The name of the profile object type. @@ -95,9 +94,9 @@ type PutIntegrationOutput struct { // A map in which each key is an event type from an external application such as // Segment or Shopify, and each value is an ObjectTypeName (template) used to - // ingest the event. It supports the following event types: SegmentIdentify, - // ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, - // ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders. + // ingest the event. It supports the following event types: SegmentIdentify , + // ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , + // ShopifyUpdateDraftOrders , ShopifyCreateOrders , and ShopifyUpdatedOrders . ObjectTypeNames map[string]string // The tags used to organize, track, or control access for this resource. diff --git a/service/customerprofiles/api_op_PutProfileObjectType.go b/service/customerprofiles/api_op_PutProfileObjectType.go index 90a63670ae8..d0ab26de3c4 100644 --- a/service/customerprofiles/api_op_PutProfileObjectType.go +++ b/service/customerprofiles/api_op_PutProfileObjectType.go @@ -13,9 +13,9 @@ import ( ) // Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, -// see TagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/UntagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). +// see TagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html) +// / UntagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html) +// . func (c *Client) PutProfileObjectType(ctx context.Context, params *PutProfileObjectTypeInput, optFns ...func(*Options)) (*PutProfileObjectTypeOutput, error) { if params == nil { params = &PutProfileObjectTypeInput{} @@ -49,10 +49,10 @@ type PutProfileObjectTypeInput struct { ObjectTypeName *string // Indicates whether a profile should be created when data is received if one - // doesn’t exist for an object of this type. The default is FALSE. If the - // AllowProfileCreation flag is set to FALSE, then the service tries to fetch a + // doesn’t exist for an object of this type. The default is FALSE . If the + // AllowProfileCreation flag is set to FALSE , then the service tries to fetch a // standard profile and associate this object with the profile. If it is set to - // TRUE, and if no match is found, then the service creates a new standard profile. + // TRUE , and if no match is found, then the service creates a new standard profile. AllowProfileCreation bool // The customer-provided key to encrypt the profile object that will be created in @@ -74,13 +74,13 @@ type PutProfileObjectTypeInput struct { // The tags used to organize, track, or control access for this resource. Tags map[string]string - // A unique identifier for the object template. For some attributes in the request, - // the service will use the default value from the object template when TemplateId - // is present. If these attributes are present in the request, the service may - // return a BadRequestException. These attributes include: AllowProfileCreation, - // SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if - // AllowProfileCreation is set to true when TemplateId is set, the service may - // return a BadRequestException. + // A unique identifier for the object template. For some attributes in the + // request, the service will use the default value from the object template when + // TemplateId is present. If these attributes are present in the request, the + // service may return a BadRequestException . These attributes include: + // AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For + // example, if AllowProfileCreation is set to true when TemplateId is set, the + // service may return a BadRequestException . TemplateId *string noSmithyDocumentSerde @@ -99,10 +99,10 @@ type PutProfileObjectTypeOutput struct { ObjectTypeName *string // Indicates whether a profile should be created when data is received if one - // doesn’t exist for an object of this type. The default is FALSE. If the - // AllowProfileCreation flag is set to FALSE, then the service tries to fetch a + // doesn’t exist for an object of this type. The default is FALSE . If the + // AllowProfileCreation flag is set to FALSE , then the service tries to fetch a // standard profile and associate this object with the profile. If it is set to - // TRUE, and if no match is found, then the service creates a new standard profile. + // TRUE , and if no match is found, then the service creates a new standard profile. AllowProfileCreation bool // The timestamp of when the domain was created. @@ -125,10 +125,9 @@ type PutProfileObjectTypeOutput struct { LastUpdatedAt *time.Time // The format of your sourceLastUpdatedTimestamp that was previously set up in - // fields that were parsed using SimpleDateFormat - // (https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html). If - // you have sourceLastUpdatedTimestamp in your field, you must set up - // sourceLastUpdatedTimestampFormat. + // fields that were parsed using SimpleDateFormat (https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html) + // . If you have sourceLastUpdatedTimestamp in your field, you must set up + // sourceLastUpdatedTimestampFormat . SourceLastUpdatedTimestampFormat *string // The tags used to organize, track, or control access for this resource. diff --git a/service/customerprofiles/api_op_SearchProfiles.go b/service/customerprofiles/api_op_SearchProfiles.go index 68c22d58455..db6b7df26ed 100644 --- a/service/customerprofiles/api_op_SearchProfiles.go +++ b/service/customerprofiles/api_op_SearchProfiles.go @@ -67,15 +67,11 @@ type SearchProfilesInput struct { // any key-value(s) pairs specified in the AdditionalSearchKeys list. This // parameter influences which profiles will be returned in the response in the // following manner: - // - // * AND - The response only includes profiles that match all of - // the search keys. - // - // * OR - The response includes profiles that match at least one - // of the search keys. - // - // The OR relationship is the default behavior if this - // parameter is not included in the request. + // - AND - The response only includes profiles that match all of the search keys. + // - OR - The response includes profiles that match at least one of the search + // keys. + // The OR relationship is the default behavior if this parameter is not included + // in the request. LogicalOperator types.LogicalOperator // The maximum number of objects returned per page. The default is 20 if this diff --git a/service/customerprofiles/api_op_UpdateDomain.go b/service/customerprofiles/api_op_UpdateDomain.go index a15e008df28..c823b6c2d24 100644 --- a/service/customerprofiles/api_op_UpdateDomain.go +++ b/service/customerprofiles/api_op_UpdateDomain.go @@ -14,17 +14,14 @@ import ( // Updates the properties of a domain, including creating or selecting a dead // letter queue or an encryption key. After a domain is created, the name can’t be -// changed. Use this API or CreateDomain -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) -// to enable identity resolution -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): -// set Matching to true. To prevent cross-service impersonation when you call this -// API, see Cross-service confused deputy prevention -// (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) +// changed. Use this API or CreateDomain (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) +// to enable identity resolution (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) +// : set Matching to true. To prevent cross-service impersonation when you call +// this API, see Cross-service confused deputy prevention (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) // for sample policies that you should apply. To add or remove tags on an existing -// Domain, see TagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/UntagResource -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html). +// Domain, see TagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html) +// / UntagResource (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html) +// . func (c *Client) UpdateDomain(ctx context.Context, params *UpdateDomainInput, optFns ...func(*Options)) (*UpdateDomainOutput, error) { if params == nil { params = &UpdateDomainInput{} @@ -63,14 +60,13 @@ type UpdateDomainInput struct { // The default number of days until the data within the domain expires. DefaultExpirationDays *int32 - // The process of matching duplicate profiles. If Matching = true, Amazon Connect + // The process of matching duplicate profiles. If Matching = true , Amazon Connect // Customer Profiles starts a weekly batch process called Identity Resolution Job. // If you do not specify a date and time for Identity Resolution Job to run, by // default it runs every Saturday at 12AM UTC to detect duplicate profiles in your - // domains. After the Identity Resolution Job completes, use the GetMatches - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) + // domains. After the Identity Resolution Job completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest, you can download the results from S3. + // in the MatchingRequest , you can download the results from S3. Matching *types.MatchingRequest // The tags used to organize, track, or control access for this resource. @@ -108,14 +104,13 @@ type UpdateDomainOutput struct { // The default number of days until the data within the domain expires. DefaultExpirationDays *int32 - // The process of matching duplicate profiles. If Matching = true, Amazon Connect + // The process of matching duplicate profiles. If Matching = true , Amazon Connect // Customer Profiles starts a weekly batch process called Identity Resolution Job. // If you do not specify a date and time for Identity Resolution Job to run, by // default it runs every Saturday at 12AM UTC to detect duplicate profiles in your - // domains. After the Identity Resolution Job completes, use the GetMatches - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) + // domains. After the Identity Resolution Job completes, use the GetMatches (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest, you can download the results from S3. + // in the MatchingRequest , you can download the results from S3. Matching *types.MatchingResponse // The tags used to organize, track, or control access for this resource. diff --git a/service/customerprofiles/api_op_UpdateProfile.go b/service/customerprofiles/api_op_UpdateProfile.go index dab40eb630e..0b7d9279424 100644 --- a/service/customerprofiles/api_op_UpdateProfile.go +++ b/service/customerprofiles/api_op_UpdateProfile.go @@ -48,8 +48,8 @@ type UpdateProfileInput struct { // Any additional information relevant to the customer’s profile. AdditionalInformation *string - // A generic address associated with the customer that is not mailing, shipping, or - // billing. + // A generic address associated with the customer that is not mailing, shipping, + // or billing. Address *types.UpdateAddress // A key value pair of attributes of a customer profile. diff --git a/service/customerprofiles/doc.go b/service/customerprofiles/doc.go index 22c5b62991f..ab79abb833f 100644 --- a/service/customerprofiles/doc.go +++ b/service/customerprofiles/doc.go @@ -9,6 +9,6 @@ // applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise // resource planning (ERP), with contact history from your Amazon Connect contact // center. If you're new to Amazon Connect, you might find it helpful to review the -// Amazon Connect Administrator Guide -// (https://docs.aws.amazon.com/connect/latest/adminguide/). +// Amazon Connect Administrator Guide (https://docs.aws.amazon.com/connect/latest/adminguide/) +// . package customerprofiles diff --git a/service/customerprofiles/types/enums.go b/service/customerprofiles/types/enums.go index 17b2d14f8e2..a40905f6b76 100644 --- a/service/customerprofiles/types/enums.go +++ b/service/customerprofiles/types/enums.go @@ -28,9 +28,9 @@ const ( DataPullModeComplete DataPullMode = "Complete" ) -// Values returns all known values for DataPullMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DataPullMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DataPullMode) Values() []DataPullMode { return []DataPullMode{ "Incremental", @@ -178,9 +178,9 @@ const ( MarketoConnectorOperatorNoOp MarketoConnectorOperator = "NO_OP" ) -// Values returns all known values for MarketoConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MarketoConnectorOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MarketoConnectorOperator) Values() []MarketoConnectorOperator { return []MarketoConnectorOperator{ "PROJECTION", @@ -253,9 +253,9 @@ const ( PartyTypeOther PartyType = "OTHER" ) -// Values returns all known values for PartyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for PartyType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (PartyType) Values() []PartyType { return []PartyType{ "INDIVIDUAL", @@ -567,9 +567,9 @@ const ( WorkflowTypeAppflowIntegration WorkflowType = "APPFLOW_INTEGRATION" ) -// Values returns all known values for WorkflowType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WorkflowType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WorkflowType) Values() []WorkflowType { return []WorkflowType{ "APPFLOW_INTEGRATION", @@ -596,9 +596,9 @@ const ( ZendeskConnectorOperatorNoOp ZendeskConnectorOperator = "NO_OP" ) -// Values returns all known values for ZendeskConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ZendeskConnectorOperator. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ZendeskConnectorOperator) Values() []ZendeskConnectorOperator { return []ZendeskConnectorOperator{ "PROJECTION", diff --git a/service/customerprofiles/types/types.go b/service/customerprofiles/types/types.go index 40ea1f63e0d..915ed636d6e 100644 --- a/service/customerprofiles/types/types.go +++ b/service/customerprofiles/types/types.go @@ -8,12 +8,9 @@ import ( ) // A data type pair that consists of a KeyName and Values list that is used in -// conjunction with the KeyName -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName) -// and Values -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values) -// parameters to search for profiles using the SearchProfiles -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) +// conjunction with the KeyName (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName) +// and Values (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values) +// parameters to search for profiles using the SearchProfiles (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) // API. type AdditionalSearchKey struct { @@ -30,8 +27,8 @@ type AdditionalSearchKey struct { noSmithyDocumentSerde } -// A generic address associated with the customer that is not mailing, shipping, or -// billing. +// A generic address associated with the customer that is not mailing, shipping, +// or billing. type Address struct { // The first line of a customer address. @@ -67,7 +64,7 @@ type Address struct { noSmithyDocumentSerde } -// Details for workflow of type APPFLOW_INTEGRATION. +// Details for workflow of type APPFLOW_INTEGRATION . type AppflowIntegration struct { // The configurations that control how Customer Profiles retrieves data from the @@ -77,7 +74,7 @@ type AppflowIntegration struct { // This member is required. FlowDefinition *FlowDefinition - // Batches in workflow of type APPFLOW_INTEGRATION. + // Batches in workflow of type APPFLOW_INTEGRATION . Batches []Batch noSmithyDocumentSerde @@ -226,19 +223,17 @@ type ConflictResolution struct { // How the auto-merging process should resolve conflicts between different // profiles. - // - // * RECENCY: Uses the data that was most recently updated. - // - // * SOURCE: - // Uses the data from a specific source. For example, if a company has been aquired - // or two departments have merged, data from the specified source is used. If two - // duplicate profiles are from the same source, then RECENCY is used again. + // - RECENCY : Uses the data that was most recently updated. + // - SOURCE : Uses the data from a specific source. For example, if a company has + // been aquired or two departments have merged, data from the specified source is + // used. If two duplicate profiles are from the same source, then RECENCY is used + // again. // // This member is required. ConflictResolvingModel ConflictResolvingModel // The ObjectType name that is used to resolve profile merging conflicts when - // choosing SOURCE as the ConflictResolvingModel. + // choosing SOURCE as the ConflictResolvingModel . SourceName *string noSmithyDocumentSerde @@ -301,8 +296,8 @@ type DomainStats struct { // writes result files. You need to give Customer Profiles service principal write // permission to your S3 bucket. Otherwise, you'll get an exception in the API // response. For an example policy, see Amazon Connect Customer Profiles -// cross-service confused deputy prevention -// (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service). +// cross-service confused deputy prevention (https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service) +// . type ExportingConfig struct { // The S3 location where Identity Resolution Jobs write result files. @@ -401,8 +396,8 @@ type FlowDefinition struct { // This member is required. FlowName *string - // The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide - // for encryption. + // The Amazon Resource Name of the AWS Key Management Service (KMS) key you + // provide for encryption. // // This member is required. KmsArn *string @@ -431,8 +426,7 @@ type FlowDefinition struct { } // A data type pair that consists of a KeyName and Values list that were used to -// find a profile returned in response to a SearchProfiles -// (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) +// find a profile returned in response to a SearchProfiles (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) // request. type FoundByKeyValue struct { @@ -470,31 +464,19 @@ type IdentityResolutionJob struct { Message *string // The status of the Identity Resolution Job. - // - // * PENDING: The Identity Resolution - // Job is scheduled but has not started yet. If you turn off the Identity - // Resolution feature in your domain, jobs in the PENDING state are deleted. - // - // * - // PREPROCESSING: The Identity Resolution Job is loading your data. - // - // * - // FIND_MATCHING: The Identity Resolution Job is using the machine learning model - // to identify profiles that belong to the same matching group. - // - // * MERGING: The - // Identity Resolution Job is merging duplicate profiles. - // - // * COMPLETED: The - // Identity Resolution Job completed successfully. - // - // * PARTIAL_SUCCESS: There's a - // system error and not all of the data is merged. The Identity Resolution Job - // writes a message indicating the source of the problem. - // - // * FAILED: The Identity - // Resolution Job did not merge any data. It writes a message indicating the source - // of the problem. + // - PENDING : The Identity Resolution Job is scheduled but has not started yet. + // If you turn off the Identity Resolution feature in your domain, jobs in the + // PENDING state are deleted. + // - PREPROCESSING : The Identity Resolution Job is loading your data. + // - FIND_MATCHING : The Identity Resolution Job is using the machine learning + // model to identify profiles that belong to the same matching group. + // - MERGING : The Identity Resolution Job is merging duplicate profiles. + // - COMPLETED : The Identity Resolution Job completed successfully. + // - PARTIAL_SUCCESS : There's a system error and not all of the data is merged. + // The Identity Resolution Job writes a message indicating the source of the + // problem. + // - FAILED : The Identity Resolution Job did not merge any data. It writes a + // message indicating the source of the problem. Status IdentityResolutionJobStatus noSmithyDocumentSerde @@ -599,9 +581,9 @@ type ListIntegrationItem struct { // This member is required. Uri *string - // Boolean that shows if the Flow that's associated with the Integration is created - // in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in - // flowDefinition. + // Boolean that shows if the Flow that's associated with the Integration is + // created in Amazon Appflow, or with ObjectTypeName equals _unstructured via + // API/CLI in flowDefinition. IsUnstructured *bool // The name of the profile object type. @@ -609,9 +591,9 @@ type ListIntegrationItem struct { // A map in which each key is an event type from an external application such as // Segment or Shopify, and each value is an ObjectTypeName (template) used to - // ingest the event. It supports the following event types: SegmentIdentify, - // ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, - // ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders. + // ingest the event. It supports the following event types: SegmentIdentify , + // ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , + // ShopifyUpdateDraftOrders , ShopifyCreateOrders , and ShopifyUpdatedOrders . ObjectTypeNames map[string]string // The tags used to organize, track, or control access for this resource. @@ -817,8 +799,8 @@ type ObjectTypeField struct { // The content type of the field. Used for determining equality when searching. ContentType FieldContentType - // A field of a ProfileObject. For example: _source.FirstName, where “_source” is a - // ProfileObjectType of a Zendesk user and “FirstName” is a field in that + // A field of a ProfileObject. For example: _source.FirstName, where “_source” is + // a ProfileObjectType of a Zendesk user and “FirstName” is a field in that // ObjectType. Source *string @@ -860,8 +842,8 @@ type Profile struct { // Any additional information relevant to the customer’s profile. AdditionalInformation *string - // A generic address associated with the customer that is not mailing, shipping, or - // billing. + // A generic address associated with the customer that is not mailing, shipping, + // or billing. Address *Address // A key value pair of attributes of a customer profile. @@ -889,28 +871,21 @@ type Profile struct { // The customer’s first name. FirstName *string - // A list of items used to find a profile returned in a SearchProfiles - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) + // A list of items used to find a profile returned in a SearchProfiles (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) // response. An item is a key-value(s) pair that matches an attribute in the // profile. If the optional AdditionalSearchKeys parameter was included in the - // SearchProfiles - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) + // SearchProfiles (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) // request, the FoundByItems list should be interpreted based on the // LogicalOperator used in the request: - // - // * AND - The profile included in the - // response matched all of the search keys specified in the request. The - // FoundByItems will include all of the key-value(s) pairs that were specified in - // the request (as this is a requirement of AND search logic). - // - // * OR - The profile - // included in the response matched at least one of the search keys specified in - // the request. The FoundByItems will include each of the key-value(s) pairs that - // the profile was found by. - // - // The OR relationship is the default behavior if the - // LogicalOperator parameter is not included in the SearchProfiles - // (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) + // - AND - The profile included in the response matched all of the search keys + // specified in the request. The FoundByItems will include all of the + // key-value(s) pairs that were specified in the request (as this is a requirement + // of AND search logic). + // - OR - The profile included in the response matched at least one of the search + // keys specified in the request. The FoundByItems will include each of the + // key-value(s) pairs that the profile was found by. + // The OR relationship is the default behavior if the LogicalOperator parameter is + // not included in the SearchProfiles (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html) // request. FoundByItems []FoundByKeyValue @@ -1023,8 +998,8 @@ type SalesforceSourceProperties struct { noSmithyDocumentSerde } -// Specifies the configuration details of a scheduled-trigger flow that you define. -// Currently, these settings only apply to the scheduled-trigger type. +// Specifies the configuration details of a scheduled-trigger flow that you +// define. Currently, these settings only apply to the scheduled-trigger type. type ScheduledTriggerProperties struct { // The scheduling expression that determines the rate at which the schedule will @@ -1092,8 +1067,8 @@ type SourceConnectorProperties struct { noSmithyDocumentSerde } -// Contains information about the configuration of the source connector used in the -// flow. +// Contains information about the configuration of the source connector used in +// the flow. type SourceFlowConfig struct { // The type of connector, such as Salesforce, Marketo, and so on. diff --git a/service/databasemigrationservice/api_client.go b/service/databasemigrationservice/api_client.go index 4e977cedccd..523ab768c99 100644 --- a/service/databasemigrationservice/api_client.go +++ b/service/databasemigrationservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/databasemigrationservice/api_op_AddTagsToResource.go b/service/databasemigrationservice/api_op_AddTagsToResource.go index 855d4d93616..9fee8b4b3b7 100644 --- a/service/databasemigrationservice/api_op_AddTagsToResource.go +++ b/service/databasemigrationservice/api_op_AddTagsToResource.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds metadata tags to an DMS resource, including replication instance, endpoint, -// subnet group, and migration task. These tags can also be used with cost -// allocation reporting to track cost associated with DMS resources, or used in a -// Condition statement in an IAM policy for DMS. For more information, see Tag -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html) data type -// description. +// Adds metadata tags to an DMS resource, including replication instance, +// endpoint, subnet group, and migration task. These tags can also be used with +// cost allocation reporting to track cost associated with DMS resources, or used +// in a Condition statement in an IAM policy for DMS. For more information, see Tag (https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html) +// data type description. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} diff --git a/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go b/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go index 02996daa71f..0d7607c2145 100644 --- a/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go +++ b/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go @@ -31,22 +31,17 @@ func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *Appl type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. Valid values: - // os-upgrade, system-update, db-upgrade + // os-upgrade , system-update , db-upgrade // // This member is required. ApplyAction *string // A value that specifies the type of opt-in request, or undoes an opt-in request. - // You can't undo an opt-in request of type immediate. Valid values: - // - // * immediate - - // Apply the maintenance action immediately. - // - // * next-maintenance - Apply the - // maintenance action during the next maintenance window for the resource. - // - // * - // undo-opt-in - Cancel any existing next-maintenance opt-in requests. + // You can't undo an opt-in request of type immediate . Valid values: + // - immediate - Apply the maintenance action immediately. + // - next-maintenance - Apply the maintenance action during the next maintenance + // window for the resource. + // - undo-opt-in - Cancel any existing next-maintenance opt-in requests. // // This member is required. OptInType *string diff --git a/service/databasemigrationservice/api_op_BatchStartRecommendations.go b/service/databasemigrationservice/api_op_BatchStartRecommendations.go index 8c21196d1e1..2db29663917 100644 --- a/service/databasemigrationservice/api_op_BatchStartRecommendations.go +++ b/service/databasemigrationservice/api_op_BatchStartRecommendations.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts the analysis of up to 20 source databases to recommend target engines for -// each source database. This is a batch version of StartRecommendations -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartRecommendations.html). -// The result of analysis of each source database is reported individually in the +// Starts the analysis of up to 20 source databases to recommend target engines +// for each source database. This is a batch version of StartRecommendations (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartRecommendations.html) +// . The result of analysis of each source database is reported individually in the // response. Because the batch request can result in a combination of successful // and unsuccessful actions, you should check for batch errors even when the call -// returns an HTTP status code of 200. +// returns an HTTP status code of 200 . func (c *Client) BatchStartRecommendations(ctx context.Context, params *BatchStartRecommendationsInput, optFns ...func(*Options)) (*BatchStartRecommendationsOutput, error) { if params == nil { params = &BatchStartRecommendationsInput{} diff --git a/service/databasemigrationservice/api_op_CreateEndpoint.go b/service/databasemigrationservice/api_op_CreateEndpoint.go index 2471bd55880..9042f8223b1 100644 --- a/service/databasemigrationservice/api_op_CreateEndpoint.go +++ b/service/databasemigrationservice/api_op_CreateEndpoint.go @@ -41,16 +41,16 @@ type CreateEndpointInput struct { // This member is required. EndpointIdentifier *string - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target . // // This member is required. EndpointType types.ReplicationEndpointTypeValue // The type of engine for the endpoint. Valid values, depending on the EndpointType - // value, include "mysql", "oracle", "postgres", "mariadb", "aurora", - // "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", - // "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", - // "docdb", "sqlserver", "neptune", and "babelfish". + // value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , + // "aurora-postgresql" , "opensearch" , "redshift" , "s3" , "db2" , "db2-zos" , + // "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , + // "elasticsearch" , "docdb" , "sqlserver" , "neptune" , and "babelfish" . // // This member is required. EngineName *string @@ -58,21 +58,16 @@ type CreateEndpointInput struct { // The Amazon Resource Name (ARN) for the certificate. CertificateArn *string - // The name of the endpoint database. For a MySQL source or target endpoint, do not - // specify DatabaseName. To migrate to a specific database, use this setting and - // targetDbType. + // The name of the endpoint database. For a MySQL source or target endpoint, do + // not specify DatabaseName. To migrate to a specific database, use this setting + // and targetDbType . DatabaseName *string // The settings in JSON format for the DMS transfer type of source endpoint. // Possible settings include the following: - // - // * ServiceAccessRoleArn - The Amazon - // Resource Name (ARN) used by the service access IAM role. The role must allow the - // iam:PassRole action. - // - // * BucketName - The name of the S3 bucket to - // use. - // + // - ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service + // access IAM role. The role must allow the iam:PassRole action. + // - BucketName - The name of the S3 bucket to use. // Shorthand syntax for these settings is as follows: // ServiceAccessRoleArn=string,BucketName=string JSON syntax for these settings is // as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", } @@ -81,17 +76,15 @@ type CreateEndpointInput struct { // Provides information that defines a DocumentDB endpoint. DocDbSettings *types.DocDbSettings - // Settings in JSON format for the target Amazon DynamoDB endpoint. For information - // about other available settings, see Using Object Mapping to Migrate Data to - // DynamoDB - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) + // Settings in JSON format for the target Amazon DynamoDB endpoint. For + // information about other available settings, see Using Object Mapping to Migrate + // Data to DynamoDB (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) // in the Database Migration Service User Guide. DynamoDbSettings *types.DynamoDbSettings - // Settings in JSON format for the target OpenSearch endpoint. For more information - // about the available settings, see Extra Connection Attributes When Using - // OpenSearch as a Target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) + // Settings in JSON format for the target OpenSearch endpoint. For more + // information about the available settings, see Extra Connection Attributes When + // Using OpenSearch as a Target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) // in the Database Migration Service User Guide. ElasticsearchSettings *types.ElasticsearchSettings @@ -102,9 +95,8 @@ type CreateEndpointInput struct { // specified as a name-value pair associated by an equal sign (=). Multiple // attributes are separated by a semicolon (;) with no additional white space. For // information on the attributes available for connecting your source or target - // endpoint, see Working with DMS Endpoints - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the - // Database Migration Service User Guide. + // endpoint, see Working with DMS Endpoints (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) + // in the Database Migration Service User Guide. ExtraConnectionAttributes *string // Settings in JSON format for the source GCP MySQL endpoint. @@ -112,71 +104,60 @@ type CreateEndpointInput struct { // Settings in JSON format for the source IBM Db2 LUW endpoint. For information // about other available settings, see Extra connection attributes when using Db2 - // LUW as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) + // LUW as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) // in the Database Migration Service User Guide. IBMDb2Settings *types.IBMDb2Settings // Settings in JSON format for the target Apache Kafka endpoint. For more // information about the available settings, see Using object mapping to migrate - // data to a Kafka topic - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) + // data to a Kafka topic (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) // in the Database Migration Service User Guide. KafkaSettings *types.KafkaSettings - // Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. - // For more information about the available settings, see Using object mapping to - // migrate data to a Kinesis data stream - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) + // Settings in JSON format for the target endpoint for Amazon Kinesis Data + // Streams. For more information about the available settings, see Using object + // mapping to migrate data to a Kinesis data stream (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) // in the Database Migration Service User Guide. KinesisSettings *types.KinesisSettings // An KMS key identifier that is used to encrypt the connection parameters for the - // endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string - // Settings in JSON format for the source and target Microsoft SQL Server endpoint. - // For information about other available settings, see Extra connection attributes - // when using SQL Server as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) - // and Extra connection attributes when using SQL Server as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) + // Settings in JSON format for the source and target Microsoft SQL Server + // endpoint. For information about other available settings, see Extra connection + // attributes when using SQL Server as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) + // and Extra connection attributes when using SQL Server as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) // in the Database Migration Service User Guide. MicrosoftSQLServerSettings *types.MicrosoftSQLServerSettings // Settings in JSON format for the source MongoDB endpoint. For more information // about the available settings, see Endpoint configuration settings when using - // MongoDB as a source for Database Migration Service - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) + // MongoDB as a source for Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) // in the Database Migration Service User Guide. MongoDbSettings *types.MongoDbSettings // Settings in JSON format for the source and target MySQL endpoint. For - // information about other available settings, see Extra connection attributes when - // using MySQL as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using MySQL as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) // and Extra connection attributes when using a MySQL-compatible database as a - // target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) + // target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) // in the Database Migration Service User Guide. MySQLSettings *types.MySQLSettings // Settings in JSON format for the target Amazon Neptune endpoint. For more // information about the available settings, see Specifying graph-mapping rules - // using Gremlin and R2RML for Amazon Neptune as a target - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) + // using Gremlin and R2RML for Amazon Neptune as a target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) // in the Database Migration Service User Guide. NeptuneSettings *types.NeptuneSettings // Settings in JSON format for the source and target Oracle endpoint. For - // information about other available settings, see Extra connection attributes when - // using Oracle as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) - // and Extra connection attributes when using Oracle as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using Oracle as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) + // and Extra connection attributes when using Oracle as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) // in the Database Migration Service User Guide. OracleSettings *types.OracleSettings @@ -187,11 +168,9 @@ type CreateEndpointInput struct { Port *int32 // Settings in JSON format for the source and target PostgreSQL endpoint. For - // information about other available settings, see Extra connection attributes when - // using PostgreSQL as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) - // and Extra connection attributes when using PostgreSQL as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using PostgreSQL as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) + // and Extra connection attributes when using PostgreSQL as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) // in the Database Migration Service User Guide. PostgreSQLSettings *types.PostgreSQLSettings @@ -206,16 +185,15 @@ type CreateEndpointInput struct { // for this parameter can have up to 31 characters. It can contain only ASCII // letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain // two consecutive hyphens, and can only begin with a letter, such as - // Example-App-ARN1. For example, this value might result in the EndpointArn value - // arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a - // ResourceIdentifier value, DMS generates a default identifier value for the end - // of EndpointArn. + // Example-App-ARN1 . For example, this value might result in the EndpointArn + // value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't + // specify a ResourceIdentifier value, DMS generates a default identifier value + // for the end of EndpointArn . ResourceIdentifier *string // Settings in JSON format for the target Amazon S3 endpoint. For more information // about the available settings, see Extra Connection Attributes When Using Amazon - // S3 as a Target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) + // S3 as a Target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) // in the Database Migration Service User Guide. S3Settings *types.S3Settings @@ -231,11 +209,9 @@ type CreateEndpointInput struct { SslMode types.DmsSslModeValue // Settings in JSON format for the source and target SAP ASE endpoint. For - // information about other available settings, see Extra connection attributes when - // using SAP ASE as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) - // and Extra connection attributes when using SAP ASE as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using SAP ASE as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) + // and Extra connection attributes when using SAP ASE as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) // in the Database Migration Service User Guide. SybaseSettings *types.SybaseSettings diff --git a/service/databasemigrationservice/api_op_CreateEventSubscription.go b/service/databasemigrationservice/api_op_CreateEventSubscription.go index 12214ce8d38..6220766ec10 100644 --- a/service/databasemigrationservice/api_op_CreateEventSubscription.go +++ b/service/databasemigrationservice/api_op_CreateEventSubscription.go @@ -12,19 +12,18 @@ import ( ) // Creates an DMS event notification subscription. You can specify the type of -// source (SourceType) you want to be notified of, provide a list of DMS source IDs -// (SourceIds) that triggers the events, and provide a list of event categories -// (EventCategories) for events you want to be notified of. If you specify both the -// SourceType and SourceIds, such as SourceType = replication-instance and -// SourceIdentifier = my-replinstance, you will be notified of all the replication -// instance events for the specified source. If you specify a SourceType but don't -// specify a SourceIdentifier, you receive notice of the events for that source -// type for all your DMS sources. If you don't specify either SourceType nor -// SourceIdentifier, you will be notified of events generated from all DMS sources -// belonging to your customer account. For more information about DMS events, see -// Working with Events and Notifications -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the -// Database Migration Service User Guide. +// source ( SourceType ) you want to be notified of, provide a list of DMS source +// IDs ( SourceIds ) that triggers the events, and provide a list of event +// categories ( EventCategories ) for events you want to be notified of. If you +// specify both the SourceType and SourceIds , such as SourceType = +// replication-instance and SourceIdentifier = my-replinstance , you will be +// notified of all the replication instance events for the specified source. If you +// specify a SourceType but don't specify a SourceIdentifier , you receive notice +// of the events for that source type for all your DMS sources. If you don't +// specify either SourceType nor SourceIdentifier , you will be notified of events +// generated from all DMS sources belonging to your customer account. For more +// information about DMS events, see Working with Events and Notifications (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) +// in the Database Migration Service User Guide. func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { params = &CreateEventSubscriptionInput{} @@ -49,8 +48,8 @@ type CreateEventSubscriptionInput struct { // This member is required. SnsTopicArn *string - // The name of the DMS event notification subscription. This name must be less than - // 255 characters. + // The name of the DMS event notification subscription. This name must be less + // than 255 characters. // // This member is required. SubscriptionName *string @@ -60,9 +59,8 @@ type CreateEventSubscriptionInput struct { Enabled *bool // A list of event categories for a source type that you want to subscribe to. For - // more information, see Working with Events and Notifications - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the - // Database Migration Service User Guide. + // more information, see Working with Events and Notifications (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) + // in the Database Migration Service User Guide. EventCategories []string // A list of identifiers for which DMS provides notification events. If you don't @@ -74,8 +72,8 @@ type CreateEventSubscriptionInput struct { // The type of DMS resource that generates the events. For example, if you want to // be notified of events generated by a replication instance, you set this - // parameter to replication-instance. If this value isn't specified, all events are - // returned. Valid values: replication-instance | replication-task + // parameter to replication-instance . If this value isn't specified, all events + // are returned. Valid values: replication-instance | replication-task SourceType *string // One or more tags to be assigned to the event subscription. diff --git a/service/databasemigrationservice/api_op_CreateFleetAdvisorCollector.go b/service/databasemigrationservice/api_op_CreateFleetAdvisorCollector.go index fd513491c26..5dcc3bac3b5 100644 --- a/service/databasemigrationservice/api_op_CreateFleetAdvisorCollector.go +++ b/service/databasemigrationservice/api_op_CreateFleetAdvisorCollector.go @@ -28,7 +28,7 @@ func (c *Client) CreateFleetAdvisorCollector(ctx context.Context, params *Create type CreateFleetAdvisorCollectorInput struct { - // The name of your Fleet Advisor collector (for example, sample-collector). + // The name of your Fleet Advisor collector (for example, sample-collector ). // // This member is required. CollectorName *string diff --git a/service/databasemigrationservice/api_op_CreateReplicationInstance.go b/service/databasemigrationservice/api_op_CreateReplicationInstance.go index 7040b8697ae..d2b074f62a6 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationInstance.go +++ b/service/databasemigrationservice/api_op_CreateReplicationInstance.go @@ -14,11 +14,10 @@ import ( // Creates the replication instance using the specified parameters. DMS requires // that your account have certain roles with appropriate permissions before you can // create a replication instance. For information on the required roles, see -// Creating the IAM Roles to Use With the CLI and DMS API -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole). -// For information on the required permissions, see IAM Permissions Needed to Use -// DMS -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions). +// Creating the IAM Roles to Use With the CLI and DMS API (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole) +// . For information on the required permissions, see IAM Permissions Needed to +// Use DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions) +// . func (c *Client) CreateReplicationInstance(ctx context.Context, params *CreateReplicationInstanceInput, optFns ...func(*Options)) (*CreateReplicationInstanceOutput, error) { if params == nil { params = &CreateReplicationInstanceInput{} @@ -38,25 +37,19 @@ type CreateReplicationInstanceInput struct { // The compute and memory capacity of the replication instance as defined for the // specified replication instance class. For example to specify the instance class - // dms.c4.large, set this parameter to "dms.c4.large". For more information on the + // dms.c4.large, set this parameter to "dms.c4.large" . For more information on the // settings and capacities for the available replication instance classes, see - // Selecting the right DMS replication instance for your migration - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). + // Selecting the right DMS replication instance for your migration (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) + // . // // This member is required. ReplicationInstanceClass *string // The replication instance identifier. This parameter is stored as a lowercase // string. Constraints: - // - // * Must contain 1-63 alphanumeric characters or hyphens. - // - // * - // First character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain 1-63 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. // Example: myrepinstance // // This member is required. @@ -68,12 +61,12 @@ type CreateReplicationInstanceInput struct { // A value that indicates whether minor engine upgrades are applied automatically // to the replication instance during the maintenance window. This parameter - // defaults to true. Default: true When AutoMinorVersionUpgrade is enabled, DMS + // defaults to true . Default: true When AutoMinorVersionUpgrade is enabled, DMS // uses the current default engine version when you create a replication instance. - // For example, if you set EngineVersion to a lower version number than the current - // default version, DMS uses the default version. If AutoMinorVersionUpgrade isn’t - // enabled when you create a replication instance, DMS uses the engine version - // specified by the EngineVersion parameter. + // For example, if you set EngineVersion to a lower version number than the + // current default version, DMS uses the default version. If + // AutoMinorVersionUpgrade isn’t enabled when you create a replication instance, + // DMS uses the engine version specified by the EngineVersion parameter. AutoMinorVersionUpgrade *bool // The Availability Zone where the replication instance will be created. The @@ -94,14 +87,14 @@ type CreateReplicationInstanceInput struct { EngineVersion *string // An KMS key identifier that is used to encrypt the data on the replication - // instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // instance. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string // Specifies whether the replication instance is a Multi-AZ deployment. You can't - // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true . MultiAZ *bool // The type of IP address protocol used by a replication instance, such as IPv4 @@ -118,7 +111,7 @@ type CreateReplicationInstanceInput struct { // Specifies the accessibility options for the replication instance. A value of // true represents an instance with a public IP address. A value of false - // represents an instance with a private IP address. The default value is true. + // represents an instance with a private IP address. The default value is true . PubliclyAccessible *bool // A subnet group to associate with the replication instance. @@ -129,10 +122,10 @@ type CreateReplicationInstanceInput struct { // for this parameter can have up to 31 characters. It can contain only ASCII // letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain // two consecutive hyphens, and can only begin with a letter, such as - // Example-App-ARN1. For example, this value might result in the EndpointArn value - // arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a - // ResourceIdentifier value, DMS generates a default identifier value for the end - // of EndpointArn. + // Example-App-ARN1 . For example, this value might result in the EndpointArn + // value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't + // specify a ResourceIdentifier value, DMS generates a default identifier value + // for the end of EndpointArn . ResourceIdentifier *string // One or more tags to be assigned to the replication instance. diff --git a/service/databasemigrationservice/api_op_CreateReplicationTask.go b/service/databasemigrationservice/api_op_CreateReplicationTask.go index 9b65dfc3af9..6a8a0103f0e 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationTask.go +++ b/service/databasemigrationservice/api_op_CreateReplicationTask.go @@ -41,14 +41,9 @@ type CreateReplicationTaskInput struct { ReplicationInstanceArn *string // An identifier for the replication task. Constraints: - // - // * Must contain 1-255 - // alphanumeric characters or hyphens. - // - // * First character must be a letter. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. + // - Must contain 1-255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. ReplicationTaskIdentifier *string @@ -58,9 +53,8 @@ type CreateReplicationTaskInput struct { // This member is required. SourceEndpointArn *string - // The table mappings for the task, in JSON format. For more information, see Using - // Table Mapping to Specify Task Settings - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) + // The table mappings for the task, in JSON format. For more information, see + // Using Table Mapping to Specify Task Settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) // in the Database Migration Service User Guide. // // This member is required. @@ -82,8 +76,8 @@ type CreateReplicationTaskInput struct { // should already be created and associated with the source endpoint. You can // verify this by setting the slotName extra connection attribute to the name of // this logical replication slot. For more information, see Extra Connection - // Attributes When Using PostgreSQL as a Source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib). + // Attributes When Using PostgreSQL as a Source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) + // . CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either @@ -92,15 +86,14 @@ type CreateReplicationTaskInput struct { // --cdc-start-time “2018-03-08T12:12:12” CdcStartTime *time.Time - // Indicates when you want a change data capture (CDC) operation to stop. The value - // can be either server time or commit time. Server time example: + // Indicates when you want a change data capture (CDC) operation to stop. The + // value can be either server time or commit time. Server time example: // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: // --cdc-stop-position “commit_time: 2018-02-09T12:12:12“ CdcStopPosition *string // Overall settings for the task, in JSON format. For more information, see - // Specifying Task Settings for Database Migration Service Tasks - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) + // Specifying Task Settings for Database Migration Service Tasks (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) // in the Database Migration Service User Guide. ReplicationTaskSettings *string @@ -109,10 +102,10 @@ type CreateReplicationTaskInput struct { // for this parameter can have up to 31 characters. It can contain only ASCII // letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain // two consecutive hyphens, and can only begin with a letter, such as - // Example-App-ARN1. For example, this value might result in the EndpointArn value - // arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a - // ResourceIdentifier value, DMS generates a default identifier value for the end - // of EndpointArn. + // Example-App-ARN1 . For example, this value might result in the EndpointArn + // value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don't + // specify a ResourceIdentifier value, DMS generates a default identifier value + // for the end of EndpointArn . ResourceIdentifier *string // One or more tags to be assigned to the replication task. @@ -120,9 +113,8 @@ type CreateReplicationTaskInput struct { // Supplemental information that the task requires to migrate the data for certain // source and target endpoints. For more information, see Specifying Supplemental - // Data for Task Settings - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in - // the Database Migration Service User Guide. + // Data for Task Settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) + // in the Database Migration Service User Guide. TaskData *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_DescribeAccountAttributes.go b/service/databasemigrationservice/api_op_DescribeAccountAttributes.go index df75de2686f..02465df83af 100644 --- a/service/databasemigrationservice/api_op_DescribeAccountAttributes.go +++ b/service/databasemigrationservice/api_op_DescribeAccountAttributes.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all of the DMS attributes for a customer account. These attributes include -// DMS quotas for the account and a unique account identifier in a particular DMS -// region. DMS quotas include a list of resource quotas supported by the account, -// such as the number of replication instances allowed. The description for each -// resource quota, includes the quota name, current usage toward that quota, and -// the quota's maximum value. DMS uses the unique account identifier to name each -// artifact used by DMS in the given region. This command does not take any -// parameters. +// Lists all of the DMS attributes for a customer account. These attributes +// include DMS quotas for the account and a unique account identifier in a +// particular DMS region. DMS quotas include a list of resource quotas supported by +// the account, such as the number of replication instances allowed. The +// description for each resource quota, includes the quota name, current usage +// toward that quota, and the quota's maximum value. DMS uses the unique account +// identifier to name each artifact used by DMS in the given region. This command +// does not take any parameters. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} @@ -44,13 +44,13 @@ type DescribeAccountAttributesOutput struct { AccountQuotas []types.AccountQuota // A unique DMS identifier for an account in a particular Amazon Web Services - // Region. The value of this identifier has the following format: c99999999999. DMS - // uses this identifier to name artifacts. For example, DMS uses this identifier to - // name the default Amazon S3 bucket for storing task assessment reports in a given - // Amazon Web Services Region. The format of this S3 bucket name is the following: - // dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this - // default S3 bucket: dms-111122223333-c44445555666. DMS supports the - // UniqueAccountIdentifier parameter in versions 3.1.4 and later. + // Region. The value of this identifier has the following format: c99999999999 . + // DMS uses this identifier to name artifacts. For example, DMS uses this + // identifier to name the default Amazon S3 bucket for storing task assessment + // reports in a given Amazon Web Services Region. The format of this S3 bucket name + // is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example + // name for this default S3 bucket: dms-111122223333-c44445555666 . DMS supports + // the UniqueAccountIdentifier parameter in versions 3.1.4 and later. UniqueAccountIdentifier *string // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go b/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go index 2c7170a3fa2..66fd5de0ea5 100644 --- a/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go +++ b/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go @@ -48,12 +48,12 @@ type DescribeApplicableIndividualAssessmentsInput struct { // Optional pagination token provided by a previous request. If this parameter is // specified, the response includes only records beyond the marker, up to the value - // specified by MaxRecords. + // specified by MaxRecords . Marker *string - // Maximum number of records to include in the response. If more records exist than - // the specified MaxRecords value, a pagination token called a marker is included - // in the response so that the remaining results can be retrieved. + // Maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. MaxRecords *int32 // Name of the migration type that each provided individual assessment must @@ -85,15 +85,14 @@ type DescribeApplicableIndividualAssessmentsOutput struct { // assessment run that you start based on the specified request parameters. For // more information on the available individual assessments, including // compatibility with different migration task configurations, see Working with - // premigration assessment runs - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) + // premigration assessment runs (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) // in the Database Migration Service User Guide. IndividualAssessmentNames []string // Pagination token returned for you to pass to a subsequent request. If you pass // this token as the Marker value in a subsequent request, the response includes // only records beyond the marker, up to the value specified in the request by - // MaxRecords. + // MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -162,20 +161,20 @@ func (c *Client) addOperationDescribeApplicableIndividualAssessmentsMiddlewares( return nil } -// DescribeApplicableIndividualAssessmentsAPIClient is a client that implements the -// DescribeApplicableIndividualAssessments operation. +// DescribeApplicableIndividualAssessmentsAPIClient is a client that implements +// the DescribeApplicableIndividualAssessments operation. type DescribeApplicableIndividualAssessmentsAPIClient interface { DescribeApplicableIndividualAssessments(context.Context, *DescribeApplicableIndividualAssessmentsInput, ...func(*Options)) (*DescribeApplicableIndividualAssessmentsOutput, error) } var _ DescribeApplicableIndividualAssessmentsAPIClient = (*Client)(nil) -// DescribeApplicableIndividualAssessmentsPaginatorOptions is the paginator options -// for DescribeApplicableIndividualAssessments +// DescribeApplicableIndividualAssessmentsPaginatorOptions is the paginator +// options for DescribeApplicableIndividualAssessments type DescribeApplicableIndividualAssessmentsPaginatorOptions struct { - // Maximum number of records to include in the response. If more records exist than - // the specified MaxRecords value, a pagination token called a marker is included - // in the response so that the remaining results can be retrieved. + // Maximum number of records to include in the response. If more records exist + // than the specified MaxRecords value, a pagination token called a marker is + // included in the response so that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeCertificates.go b/service/databasemigrationservice/api_op_DescribeCertificates.go index f548224f81d..a7f7ec89602 100644 --- a/service/databasemigrationservice/api_op_DescribeCertificates.go +++ b/service/databasemigrationservice/api_op_DescribeCertificates.go @@ -31,12 +31,12 @@ func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCerti type DescribeCertificatesInput struct { // Filters applied to the certificates described in the form of key-value pairs. - // Valid values are certificate-arn and certificate-id. + // Valid values are certificate-arn and certificate-id . Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/databasemigrationservice/api_op_DescribeConnections.go b/service/databasemigrationservice/api_op_DescribeConnections.go index 008cc179a47..48f39516694 100644 --- a/service/databasemigrationservice/api_op_DescribeConnections.go +++ b/service/databasemigrationservice/api_op_DescribeConnections.go @@ -42,7 +42,7 @@ type DescribeConnectionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -61,7 +61,7 @@ type DescribeConnectionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -133,8 +133,8 @@ func (c *Client) addOperationDescribeConnectionsMiddlewares(stack *middleware.St return nil } -// DescribeConnectionsAPIClient is a client that implements the DescribeConnections -// operation. +// DescribeConnectionsAPIClient is a client that implements the +// DescribeConnections operation. type DescribeConnectionsAPIClient interface { DescribeConnections(context.Context, *DescribeConnectionsInput, ...func(*Options)) (*DescribeConnectionsOutput, error) } @@ -241,9 +241,10 @@ type TestConnectionSucceedsWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TestConnectionSucceedsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TestConnectionSucceedsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -283,9 +284,9 @@ func NewTestConnectionSucceedsWaiter(client DescribeConnectionsAPIClient, optFns } } -// Wait calls the waiter function for TestConnectionSucceeds waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for TestConnectionSucceeds waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *TestConnectionSucceedsWaiter) Wait(ctx context.Context, params *DescribeConnectionsInput, maxWaitDur time.Duration, optFns ...func(*TestConnectionSucceedsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/databasemigrationservice/api_op_DescribeEndpointSettings.go b/service/databasemigrationservice/api_op_DescribeEndpointSettings.go index 8e1227ce1d2..1ee910c27a0 100644 --- a/service/databasemigrationservice/api_op_DescribeEndpointSettings.go +++ b/service/databasemigrationservice/api_op_DescribeEndpointSettings.go @@ -38,7 +38,7 @@ type DescribeEndpointSettingsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -57,7 +57,7 @@ type DescribeEndpointSettingsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeEndpointTypes.go b/service/databasemigrationservice/api_op_DescribeEndpointTypes.go index f2c5b68900e..74c80b5364d 100644 --- a/service/databasemigrationservice/api_op_DescribeEndpointTypes.go +++ b/service/databasemigrationservice/api_op_DescribeEndpointTypes.go @@ -36,7 +36,7 @@ type DescribeEndpointTypesInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -52,7 +52,7 @@ type DescribeEndpointTypesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The types of endpoints that are supported. diff --git a/service/databasemigrationservice/api_op_DescribeEndpoints.go b/service/databasemigrationservice/api_op_DescribeEndpoints.go index 60edb190020..4f3caaa356a 100644 --- a/service/databasemigrationservice/api_op_DescribeEndpoints.go +++ b/service/databasemigrationservice/api_op_DescribeEndpoints.go @@ -41,7 +41,7 @@ type DescribeEndpointsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -60,7 +60,7 @@ type DescribeEndpointsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -238,9 +238,9 @@ type EndpointDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EndpointDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EndpointDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -280,9 +280,9 @@ func NewEndpointDeletedWaiter(client DescribeEndpointsAPIClient, optFns ...func( } } -// Wait calls the waiter function for EndpointDeleted waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for EndpointDeleted waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *EndpointDeletedWaiter) Wait(ctx context.Context, params *DescribeEndpointsInput, maxWaitDur time.Duration, optFns ...func(*EndpointDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/databasemigrationservice/api_op_DescribeEventCategories.go b/service/databasemigrationservice/api_op_DescribeEventCategories.go index 1fa061857da..e43eda71297 100644 --- a/service/databasemigrationservice/api_op_DescribeEventCategories.go +++ b/service/databasemigrationservice/api_op_DescribeEventCategories.go @@ -13,9 +13,8 @@ import ( // Lists categories for all event source types, or, if specified, for a specified // source type. You can see a list of the event categories and source types in -// Working with Events and Notifications -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the -// Database Migration Service User Guide. +// Working with Events and Notifications (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) +// in the Database Migration Service User Guide. func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, optFns ...func(*Options)) (*DescribeEventCategoriesOutput, error) { if params == nil { params = &DescribeEventCategoriesInput{} diff --git a/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go b/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go index d410526d177..2b9bbb60238 100644 --- a/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go +++ b/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go @@ -13,9 +13,9 @@ import ( ) // Lists all the event subscriptions for a customer account. The description of a -// subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, -// SourceID, CreationTime, and Status. If you specify SubscriptionName, this action -// lists the description for that subscription. +// subscription includes SubscriptionName , SNSTopicARN , CustomerID , SourceType , +// SourceID , CreationTime , and Status . If you specify SubscriptionName , this +// action lists the description for that subscription. func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error) { if params == nil { params = &DescribeEventSubscriptionsInput{} @@ -39,7 +39,7 @@ type DescribeEventSubscriptionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -61,7 +61,7 @@ type DescribeEventSubscriptionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeEvents.go b/service/databasemigrationservice/api_op_DescribeEvents.go index cd4f1598b6d..83055954215 100644 --- a/service/databasemigrationservice/api_op_DescribeEvents.go +++ b/service/databasemigrationservice/api_op_DescribeEvents.go @@ -13,11 +13,10 @@ import ( "time" ) -// Lists events for a given source identifier and source type. You can also specify -// a start and end time. For more information on DMS events, see Working with -// Events and Notifications -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the -// Database Migration Service User Guide. +// Lists events for a given source identifier and source type. You can also +// specify a start and end time. For more information on DMS events, see Working +// with Events and Notifications (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) +// in the Database Migration Service User Guide. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -44,12 +43,12 @@ type DescribeEventsInput struct { // A list of event categories for the source type that you've chosen. EventCategories []string - // Filters applied to events. The only valid filter is replication-instance-id. + // Filters applied to events. The only valid filter is replication-instance-id . Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -78,7 +77,7 @@ type DescribeEventsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go index 05bed02c13c..c29afe213a2 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go @@ -30,16 +30,11 @@ func (c *Client) DescribeFleetAdvisorCollectors(ctx context.Context, params *Des type DescribeFleetAdvisorCollectorsInput struct { - // If you specify any of the following filters, the output includes information for - // only those collectors that meet the filter criteria: - // - // * collector-referenced-id - // – The ID of the collector agent, for example - // d4610ac5-e323-4ad9-bc50-eaf7249dfe9d. - // - // * collector-name – The name of the - // collector agent. - // + // If you specify any of the following filters, the output includes information + // for only those collectors that meet the filter criteria: + // - collector-referenced-id – The ID of the collector agent, for example + // d4610ac5-e323-4ad9-bc50-eaf7249dfe9d . + // - collector-name – The name of the collector agent. // An example is: describe-fleet-advisor-collectors --filter // Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d" Filters []types.Filter @@ -58,8 +53,8 @@ type DescribeFleetAdvisorCollectorsInput struct { type DescribeFleetAdvisorCollectorsOutput struct { - // Provides descriptions of the Fleet Advisor collectors, including the collectors' - // name and ID, and the latest inventory data. + // Provides descriptions of the Fleet Advisor collectors, including the + // collectors' name and ID, and the latest inventory data. Collectors []types.CollectorResponse // If NextToken is returned, there are more results available. The value of diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go index 48e7c821cf6..9ff7293e207 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go @@ -30,27 +30,16 @@ func (c *Client) DescribeFleetAdvisorDatabases(ctx context.Context, params *Desc type DescribeFleetAdvisorDatabasesInput struct { - // If you specify any of the following filters, the output includes information for - // only those databases that meet the filter criteria: - // - // * database-id – The ID of - // the database. - // - // * database-name – The name of the database. - // - // * database-engine – - // The name of the database engine. - // - // * server-ip-address – The IP address of the - // database server. - // - // * database-ip-address – The IP address of the database. - // - // * - // collector-name – The name of the associated Fleet Advisor collector. - // - // An example - // is: describe-fleet-advisor-databases --filter Name="database-id",Values="45" + // If you specify any of the following filters, the output includes information + // for only those databases that meet the filter criteria: + // - database-id – The ID of the database. + // - database-name – The name of the database. + // - database-engine – The name of the database engine. + // - server-ip-address – The IP address of the database server. + // - database-ip-address – The IP address of the database. + // - collector-name – The name of the associated Fleet Advisor collector. + // An example is: describe-fleet-advisor-databases --filter + // Name="database-id",Values="45" Filters []types.Filter // Sets the maximum number of records returned in the response. diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go index 469de2dcaab..4aedd85699c 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go @@ -31,14 +31,11 @@ func (c *Client) DescribeFleetAdvisorSchemaObjectSummary(ctx context.Context, pa type DescribeFleetAdvisorSchemaObjectSummaryInput struct { - // If you specify any of the following filters, the output includes information for - // only those schema objects that meet the filter criteria: - // - // * schema-id – The ID - // of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d. - // - // Example: - // describe-fleet-advisor-schema-object-summary --filter + // If you specify any of the following filters, the output includes information + // for only those schema objects that meet the filter criteria: + // - schema-id – The ID of the schema, for example + // d4610ac5-e323-4ad9-bc50-eaf7249dfe9d . + // Example: describe-fleet-advisor-schema-object-summary --filter // Name="schema-id",Values="50" Filters []types.Filter @@ -134,16 +131,16 @@ func (c *Client) addOperationDescribeFleetAdvisorSchemaObjectSummaryMiddlewares( return nil } -// DescribeFleetAdvisorSchemaObjectSummaryAPIClient is a client that implements the -// DescribeFleetAdvisorSchemaObjectSummary operation. +// DescribeFleetAdvisorSchemaObjectSummaryAPIClient is a client that implements +// the DescribeFleetAdvisorSchemaObjectSummary operation. type DescribeFleetAdvisorSchemaObjectSummaryAPIClient interface { DescribeFleetAdvisorSchemaObjectSummary(context.Context, *DescribeFleetAdvisorSchemaObjectSummaryInput, ...func(*Options)) (*DescribeFleetAdvisorSchemaObjectSummaryOutput, error) } var _ DescribeFleetAdvisorSchemaObjectSummaryAPIClient = (*Client)(nil) -// DescribeFleetAdvisorSchemaObjectSummaryPaginatorOptions is the paginator options -// for DescribeFleetAdvisorSchemaObjectSummary +// DescribeFleetAdvisorSchemaObjectSummaryPaginatorOptions is the paginator +// options for DescribeFleetAdvisorSchemaObjectSummary type DescribeFleetAdvisorSchemaObjectSummaryPaginatorOptions struct { // Sets the maximum number of records returned in the response. Limit int32 diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go index ce0e09fd243..04e915b6564 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go @@ -30,36 +30,19 @@ func (c *Client) DescribeFleetAdvisorSchemas(ctx context.Context, params *Descri type DescribeFleetAdvisorSchemasInput struct { - // If you specify any of the following filters, the output includes information for - // only those schemas that meet the filter criteria: - // - // * complexity – The schema's - // complexity, for example Simple. - // - // * database-id – The ID of the schema's - // database. - // - // * database-ip-address – The IP address of the schema's database. - // - // * - // database-name – The name of the schema's database. - // - // * database-engine – The name - // of the schema database's engine. - // - // * original-schema-name – The name of the - // schema's database's main schema. - // - // * schema-id – The ID of the schema, for - // example 15. - // - // * schema-name – The name of the schema. - // - // * server-ip-address – The - // IP address of the schema database's server. - // - // An example is: - // describe-fleet-advisor-schemas --filter Name="schema-id",Values="50" + // If you specify any of the following filters, the output includes information + // for only those schemas that meet the filter criteria: + // - complexity – The schema's complexity, for example Simple . + // - database-id – The ID of the schema's database. + // - database-ip-address – The IP address of the schema's database. + // - database-name – The name of the schema's database. + // - database-engine – The name of the schema database's engine. + // - original-schema-name – The name of the schema's database's main schema. + // - schema-id – The ID of the schema, for example 15 . + // - schema-name – The name of the schema. + // - server-ip-address – The IP address of the schema database's server. + // An example is: describe-fleet-advisor-schemas --filter + // Name="schema-id",Values="50" Filters []types.Filter // Sets the maximum number of records returned in the response. diff --git a/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go b/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go index 8f18cd13b9c..f7ac03c1758 100644 --- a/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go +++ b/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go @@ -33,7 +33,7 @@ type DescribeOrderableReplicationInstancesInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -49,7 +49,7 @@ type DescribeOrderableReplicationInstancesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The order-able replication instances available. diff --git a/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go b/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go index c9570f66dc9..4109d09ae0f 100644 --- a/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go +++ b/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go @@ -35,7 +35,7 @@ type DescribePendingMaintenanceActionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -54,7 +54,7 @@ type DescribePendingMaintenanceActionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The pending maintenance action. diff --git a/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go b/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go index bfd3d4052ea..d4ce9b2a70f 100644 --- a/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go +++ b/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a paginated list of limitations for recommendations of target Amazon Web -// Services engines. +// Returns a paginated list of limitations for recommendations of target Amazon +// Web Services engines. func (c *Client) DescribeRecommendationLimitations(ctx context.Context, params *DescribeRecommendationLimitationsInput, optFns ...func(*Options)) (*DescribeRecommendationLimitationsOutput, error) { if params == nil { params = &DescribeRecommendationLimitationsInput{} @@ -39,13 +39,13 @@ type DescribeRecommendationLimitationsInput struct { // in the response so that you can retrieve the remaining results. MaxRecords *int32 - // Specifies the unique pagination token that makes it possible to display the next - // page of results. If this parameter is specified, the response includes only - // records beyond the marker, up to the value specified by MaxRecords. If NextToken - // is returned by a previous response, there are more results available. The value - // of NextToken is a unique pagination token for each page. Make the call again - // using the returned token to retrieve the next page. Keep all other arguments - // unchanged. + // Specifies the unique pagination token that makes it possible to display the + // next page of results. If this parameter is specified, the response includes only + // records beyond the marker, up to the value specified by MaxRecords . If + // NextToken is returned by a previous response, there are more results available. + // The value of NextToken is a unique pagination token for each page. Make the + // call again using the returned token to retrieve the next page. Keep all other + // arguments unchanged. NextToken *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_DescribeRecommendations.go b/service/databasemigrationservice/api_op_DescribeRecommendations.go index 5e0700a24f0..6de0f1eede0 100644 --- a/service/databasemigrationservice/api_op_DescribeRecommendations.go +++ b/service/databasemigrationservice/api_op_DescribeRecommendations.go @@ -40,13 +40,13 @@ type DescribeRecommendationsInput struct { // in the response so that you can retrieve the remaining results. MaxRecords *int32 - // Specifies the unique pagination token that makes it possible to display the next - // page of results. If this parameter is specified, the response includes only - // records beyond the marker, up to the value specified by MaxRecords. If NextToken - // is returned by a previous response, there are more results available. The value - // of NextToken is a unique pagination token for each page. Make the call again - // using the returned token to retrieve the next page. Keep all other arguments - // unchanged. + // Specifies the unique pagination token that makes it possible to display the + // next page of results. If this parameter is specified, the response includes only + // records beyond the marker, up to the value specified by MaxRecords . If + // NextToken is returned by a previous response, there are more results available. + // The value of NextToken is a unique pagination token for each page. Make the + // call again using the returned token to retrieve the next page. Keep all other + // arguments unchanged. NextToken *string noSmithyDocumentSerde @@ -60,8 +60,8 @@ type DescribeRecommendationsOutput struct { // again using the returned token and keeping all other arguments unchanged. NextToken *string - // The list of recommendations of target engines that Fleet Advisor created for the - // source database. + // The list of recommendations of target engines that Fleet Advisor created for + // the source database. Recommendations []types.Recommendation // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go b/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go index d112288917d..592b894cfc1 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go @@ -37,7 +37,7 @@ type DescribeReplicationInstanceTaskLogsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -53,14 +53,14 @@ type DescribeReplicationInstanceTaskLogsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The Amazon Resource Name (ARN) of the replication instance. ReplicationInstanceArn *string - // An array of replication task log metadata. Each member of the array contains the - // replication task name, ARN, and task log size (in bytes). + // An array of replication task log metadata. Each member of the array contains + // the replication task name, ARN, and task log size (in bytes). ReplicationInstanceTaskLogs []types.ReplicationInstanceTaskLog // Metadata pertaining to the operation's result. @@ -140,8 +140,8 @@ type DescribeReplicationInstanceTaskLogsAPIClient interface { var _ DescribeReplicationInstanceTaskLogsAPIClient = (*Client)(nil) -// DescribeReplicationInstanceTaskLogsPaginatorOptions is the paginator options for -// DescribeReplicationInstanceTaskLogs +// DescribeReplicationInstanceTaskLogsPaginatorOptions is the paginator options +// for DescribeReplicationInstanceTaskLogs type DescribeReplicationInstanceTaskLogsPaginatorOptions struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is diff --git a/service/databasemigrationservice/api_op_DescribeReplicationInstances.go b/service/databasemigrationservice/api_op_DescribeReplicationInstances.go index 6fdffb328bc..92fa8225cad 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationInstances.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationInstances.go @@ -43,7 +43,7 @@ type DescribeReplicationInstancesInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -59,7 +59,7 @@ type DescribeReplicationInstancesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The replication instances described. @@ -244,10 +244,10 @@ type ReplicationInstanceAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationInstanceAvailableWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationInstanceAvailableWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -519,8 +519,8 @@ type ReplicationInstanceDeletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationInstanceDeletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationInstanceDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go b/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go index 25ba8c1d350..d82c24481c9 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go @@ -36,7 +36,7 @@ type DescribeReplicationSubnetGroupsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -52,7 +52,7 @@ type DescribeReplicationSubnetGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A description of the replication subnet groups. diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go index 314d6f208c7..08822c22da6 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go @@ -15,8 +15,7 @@ import ( // Returns the task assessment results from the Amazon S3 bucket that DMS creates // in your Amazon Web Services account. This action always returns the latest // results. For more information about DMS task assessments, see Creating a task -// assessment report -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) +// assessment report (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) // in the Database Migration Service User Guide. func (c *Client) DescribeReplicationTaskAssessmentResults(ctx context.Context, params *DescribeReplicationTaskAssessmentResultsInput, optFns ...func(*Options)) (*DescribeReplicationTaskAssessmentResultsOutput, error) { if params == nil { @@ -37,7 +36,7 @@ type DescribeReplicationTaskAssessmentResultsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -61,7 +60,7 @@ type DescribeReplicationTaskAssessmentResultsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The task assessment report. diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go index 087e75f59f1..ace395cadbf 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go @@ -36,13 +36,13 @@ func (c *Client) DescribeReplicationTaskAssessmentRuns(ctx context.Context, para type DescribeReplicationTaskAssessmentRunsInput struct { // Filters applied to the premigration assessment runs described in the form of - // key-value pairs. Valid filter names: replication-task-assessment-run-arn, - // replication-task-arn, replication-instance-arn, status + // key-value pairs. Valid filter names: replication-task-assessment-run-arn , + // replication-task-arn , replication-instance-arn , status Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -55,13 +55,13 @@ type DescribeReplicationTaskAssessmentRunsInput struct { type DescribeReplicationTaskAssessmentRunsOutput struct { - // A pagination token returned for you to pass to a subsequent request. If you pass - // this token as the Marker value in a subsequent request, the response includes - // only records beyond the marker, up to the value specified in the request by - // MaxRecords. + // A pagination token returned for you to pass to a subsequent request. If you + // pass this token as the Marker value in a subsequent request, the response + // includes only records beyond the marker, up to the value specified in the + // request by MaxRecords . Marker *string - // One or more premigration assessment runs as specified by Filters. + // One or more premigration assessment runs as specified by Filters . ReplicationTaskAssessmentRuns []types.ReplicationTaskAssessmentRun // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go index 5e5997820db..ffbd5ec74a8 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go @@ -32,14 +32,14 @@ func (c *Client) DescribeReplicationTaskIndividualAssessments(ctx context.Contex type DescribeReplicationTaskIndividualAssessmentsInput struct { - // Filters applied to the individual assessments described in the form of key-value - // pairs. Valid filter names: replication-task-assessment-run-arn, - // replication-task-arn, status + // Filters applied to the individual assessments described in the form of + // key-value pairs. Valid filter names: replication-task-assessment-run-arn , + // replication-task-arn , status Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -52,13 +52,13 @@ type DescribeReplicationTaskIndividualAssessmentsInput struct { type DescribeReplicationTaskIndividualAssessmentsOutput struct { - // A pagination token returned for you to pass to a subsequent request. If you pass - // this token as the Marker value in a subsequent request, the response includes - // only records beyond the marker, up to the value specified in the request by - // MaxRecords. + // A pagination token returned for you to pass to a subsequent request. If you + // pass this token as the Marker value in a subsequent request, the response + // includes only records beyond the marker, up to the value specified in the + // request by MaxRecords . Marker *string - // One or more individual assessments as specified by Filters. + // One or more individual assessments as specified by Filters . ReplicationTaskIndividualAssessments []types.ReplicationTaskIndividualAssessment // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTasks.go b/service/databasemigrationservice/api_op_DescribeReplicationTasks.go index 00799294d82..6232dc3b3af 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTasks.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTasks.go @@ -36,13 +36,13 @@ func (c *Client) DescribeReplicationTasks(ctx context.Context, params *DescribeR type DescribeReplicationTasksInput struct { - // Filters applied to replication tasks. Valid filter names: replication-task-arn | - // replication-task-id | migration-type | endpoint-arn | replication-instance-arn + // Filters applied to replication tasks. Valid filter names: replication-task-arn + // | replication-task-id | migration-type | endpoint-arn | replication-instance-arn Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -53,7 +53,7 @@ type DescribeReplicationTasksInput struct { // An option to set to avoid returning information about settings. Use this to // reduce overhead when setting information is too large. To use this option, - // choose true; otherwise, choose false (the default). + // choose true ; otherwise, choose false (the default). WithoutSettings *bool noSmithyDocumentSerde @@ -63,7 +63,7 @@ type DescribeReplicationTasksOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A description of the replication tasks. @@ -247,9 +247,10 @@ type ReplicationTaskDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationTaskDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationTaskDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -289,9 +290,9 @@ func NewReplicationTaskDeletedWaiter(client DescribeReplicationTasksAPIClient, o } } -// Wait calls the waiter function for ReplicationTaskDeleted waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for ReplicationTaskDeleted waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *ReplicationTaskDeletedWaiter) Wait(ctx context.Context, params *DescribeReplicationTasksInput, maxWaitDur time.Duration, optFns ...func(*ReplicationTaskDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -518,9 +519,10 @@ type ReplicationTaskReadyWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationTaskReadyWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationTaskReadyWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -886,9 +888,10 @@ type ReplicationTaskRunningWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationTaskRunningWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationTaskRunningWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -928,9 +931,9 @@ func NewReplicationTaskRunningWaiter(client DescribeReplicationTasksAPIClient, o } } -// Wait calls the waiter function for ReplicationTaskRunning waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for ReplicationTaskRunning waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *ReplicationTaskRunningWaiter) Wait(ctx context.Context, params *DescribeReplicationTasksInput, maxWaitDur time.Duration, optFns ...func(*ReplicationTaskRunningWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -1254,9 +1257,10 @@ type ReplicationTaskStoppedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationTaskStoppedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationTaskStoppedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1296,9 +1300,9 @@ func NewReplicationTaskStoppedWaiter(client DescribeReplicationTasksAPIClient, o } } -// Wait calls the waiter function for ReplicationTaskStopped waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for ReplicationTaskStopped waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *ReplicationTaskStoppedWaiter) Wait(ctx context.Context, params *DescribeReplicationTasksInput, maxWaitDur time.Duration, optFns ...func(*ReplicationTaskStoppedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/databasemigrationservice/api_op_DescribeSchemas.go b/service/databasemigrationservice/api_op_DescribeSchemas.go index 630534d956b..08fff37c2b3 100644 --- a/service/databasemigrationservice/api_op_DescribeSchemas.go +++ b/service/databasemigrationservice/api_op_DescribeSchemas.go @@ -36,7 +36,7 @@ type DescribeSchemasInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -52,7 +52,7 @@ type DescribeSchemasOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The described schema. diff --git a/service/databasemigrationservice/api_op_DescribeTableStatistics.go b/service/databasemigrationservice/api_op_DescribeTableStatistics.go index ffd4b43e4b1..a1bb740aae1 100644 --- a/service/databasemigrationservice/api_op_DescribeTableStatistics.go +++ b/service/databasemigrationservice/api_op_DescribeTableStatistics.go @@ -46,7 +46,7 @@ type DescribeTableStatisticsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -62,7 +62,7 @@ type DescribeTableStatisticsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The Amazon Resource Name (ARN) of the replication task. diff --git a/service/databasemigrationservice/api_op_ModifyEndpoint.go b/service/databasemigrationservice/api_op_ModifyEndpoint.go index a2a3367178c..e4dfcaac1d9 100644 --- a/service/databasemigrationservice/api_op_ModifyEndpoint.go +++ b/service/databasemigrationservice/api_op_ModifyEndpoint.go @@ -42,43 +42,35 @@ type ModifyEndpointInput struct { // The Amazon Resource Name (ARN) of the certificate used for SSL connection. CertificateArn *string - // The name of the endpoint database. For a MySQL source or target endpoint, do not - // specify DatabaseName. + // The name of the endpoint database. For a MySQL source or target endpoint, do + // not specify DatabaseName. DatabaseName *string // The settings in JSON format for the DMS transfer type of source endpoint. // Attributes include the following: - // - // * serviceAccessRoleArn - The Amazon Resource - // Name (ARN) used by the service access IAM role. The role must allow the - // iam:PassRole action. - // - // * BucketName - The name of the S3 bucket to - // use. - // - // Shorthand syntax for these settings is as follows: - // ServiceAccessRoleArn=string ,BucketName=string JSON syntax for these settings is - // as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"} + // - serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service + // access IAM role. The role must allow the iam:PassRole action. + // - BucketName - The name of the S3 bucket to use. + // Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string + // ,BucketName=string JSON syntax for these settings is as follows: { + // "ServiceAccessRoleArn": "string", "BucketName": "string"} DmsTransferSettings *types.DmsTransferSettings - // Settings in JSON format for the source DocumentDB endpoint. For more information - // about the available settings, see the configuration properties section in Using - // DocumentDB as a Target for Database Migration Service - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) + // Settings in JSON format for the source DocumentDB endpoint. For more + // information about the available settings, see the configuration properties + // section in Using DocumentDB as a Target for Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) // in the Database Migration Service User Guide. DocDbSettings *types.DocDbSettings - // Settings in JSON format for the target Amazon DynamoDB endpoint. For information - // about other available settings, see Using Object Mapping to Migrate Data to - // DynamoDB - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) + // Settings in JSON format for the target Amazon DynamoDB endpoint. For + // information about other available settings, see Using Object Mapping to Migrate + // Data to DynamoDB (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) // in the Database Migration Service User Guide. DynamoDbSettings *types.DynamoDbSettings - // Settings in JSON format for the target OpenSearch endpoint. For more information - // about the available settings, see Extra Connection Attributes When Using - // OpenSearch as a Target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) + // Settings in JSON format for the target OpenSearch endpoint. For more + // information about the available settings, see Extra Connection Attributes When + // Using OpenSearch as a Target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) // in the Database Migration Service User Guide. ElasticsearchSettings *types.ElasticsearchSettings @@ -87,36 +79,32 @@ type ModifyEndpointInput struct { // contain two consecutive hyphens. EndpointIdentifier *string - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target . EndpointType types.ReplicationEndpointTypeValue // The database engine name. Valid values, depending on the EndpointType, include - // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and - // "babelfish". + // "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , + // "redshift" , "s3" , "db2" , "db2-zos" , "azuredb" , "sybase" , "dynamodb" , + // "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , + // "neptune" , and "babelfish" . EngineName *string - // If this attribute is Y, the current call to ModifyEndpoint replaces all existing - // endpoint settings with the exact settings that you specify in this call. If this - // attribute is N, the current call to ModifyEndpoint does two things: - // - // * It - // replaces any endpoint settings that already exist with new values, for settings - // with the same names. - // - // * It creates new endpoint settings that you specify in the - // call, for settings with different names. - // - // For example, if you call - // create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the - // following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... - // --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the - // following settings: '{"a":1,"b":2}'. However, suppose that you follow this with - // a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... - // for that same endpoint again. Then the endpoint has the following settings: - // '{"b":2}'. All existing settings are replaced with the exact settings that you - // specify. + // If this attribute is Y, the current call to ModifyEndpoint replaces all + // existing endpoint settings with the exact settings that you specify in this + // call. If this attribute is N, the current call to ModifyEndpoint does two + // things: + // - It replaces any endpoint settings that already exist with new values, for + // settings with the same names. + // - It creates new endpoint settings that you specify in the call, for settings + // with different names. + // For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ... , + // the endpoint has the following endpoint settings: '{"a":1}' . If you then call + // modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the + // endpoint has the following settings: '{"a":1,"b":2}' . However, suppose that you + // follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' + // --exact-settings ... for that same endpoint again. Then the endpoint has the + // following settings: '{"b":2}' . All existing settings are replaced with the + // exact settings that you specify. ExactSettings *bool // The external table definition. @@ -131,65 +119,54 @@ type ModifyEndpointInput struct { // Settings in JSON format for the source IBM Db2 LUW endpoint. For information // about other available settings, see Extra connection attributes when using Db2 - // LUW as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) + // LUW as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) // in the Database Migration Service User Guide. IBMDb2Settings *types.IBMDb2Settings // Settings in JSON format for the target Apache Kafka endpoint. For more // information about the available settings, see Using object mapping to migrate - // data to a Kafka topic - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) + // data to a Kafka topic (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) // in the Database Migration Service User Guide. KafkaSettings *types.KafkaSettings - // Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. - // For more information about the available settings, see Using object mapping to - // migrate data to a Kinesis data stream - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) + // Settings in JSON format for the target endpoint for Amazon Kinesis Data + // Streams. For more information about the available settings, see Using object + // mapping to migrate data to a Kinesis data stream (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) // in the Database Migration Service User Guide. KinesisSettings *types.KinesisSettings - // Settings in JSON format for the source and target Microsoft SQL Server endpoint. - // For information about other available settings, see Extra connection attributes - // when using SQL Server as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) - // and Extra connection attributes when using SQL Server as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) + // Settings in JSON format for the source and target Microsoft SQL Server + // endpoint. For information about other available settings, see Extra connection + // attributes when using SQL Server as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) + // and Extra connection attributes when using SQL Server as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) // in the Database Migration Service User Guide. MicrosoftSQLServerSettings *types.MicrosoftSQLServerSettings // Settings in JSON format for the source MongoDB endpoint. For more information // about the available settings, see the configuration properties section in // Endpoint configuration settings when using MongoDB as a source for Database - // Migration Service - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) + // Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) // in the Database Migration Service User Guide. MongoDbSettings *types.MongoDbSettings // Settings in JSON format for the source and target MySQL endpoint. For - // information about other available settings, see Extra connection attributes when - // using MySQL as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using MySQL as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) // and Extra connection attributes when using a MySQL-compatible database as a - // target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) + // target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) // in the Database Migration Service User Guide. MySQLSettings *types.MySQLSettings // Settings in JSON format for the target Amazon Neptune endpoint. For more // information about the available settings, see Specifying graph-mapping rules - // using Gremlin and R2RML for Amazon Neptune as a target - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) + // using Gremlin and R2RML for Amazon Neptune as a target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) // in the Database Migration Service User Guide. NeptuneSettings *types.NeptuneSettings // Settings in JSON format for the source and target Oracle endpoint. For - // information about other available settings, see Extra connection attributes when - // using Oracle as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) - // and Extra connection attributes when using Oracle as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using Oracle as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) + // and Extra connection attributes when using Oracle as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) // in the Database Migration Service User Guide. OracleSettings *types.OracleSettings @@ -200,11 +177,9 @@ type ModifyEndpointInput struct { Port *int32 // Settings in JSON format for the source and target PostgreSQL endpoint. For - // information about other available settings, see Extra connection attributes when - // using PostgreSQL as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) - // and Extra connection attributes when using PostgreSQL as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using PostgreSQL as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) + // and Extra connection attributes when using PostgreSQL as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) // in the Database Migration Service User Guide. PostgreSQLSettings *types.PostgreSQLSettings @@ -216,8 +191,7 @@ type ModifyEndpointInput struct { // Settings in JSON format for the target Amazon S3 endpoint. For more information // about the available settings, see Extra Connection Attributes When Using Amazon - // S3 as a Target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) + // S3 as a Target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) // in the Database Migration Service User Guide. S3Settings *types.S3Settings @@ -228,15 +202,13 @@ type ModifyEndpointInput struct { // endpoint. The role must allow the iam:PassRole action. ServiceAccessRoleArn *string - // The SSL mode used to connect to the endpoint. The default value is none. + // The SSL mode used to connect to the endpoint. The default value is none . SslMode types.DmsSslModeValue // Settings in JSON format for the source and target SAP ASE endpoint. For - // information about other available settings, see Extra connection attributes when - // using SAP ASE as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) - // and Extra connection attributes when using SAP ASE as a target for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) + // information about other available settings, see Extra connection attributes + // when using SAP ASE as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) + // and Extra connection attributes when using SAP ASE as a target for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) // in the Database Migration Service User Guide. SybaseSettings *types.SybaseSettings diff --git a/service/databasemigrationservice/api_op_ModifyReplicationInstance.go b/service/databasemigrationservice/api_op_ModifyReplicationInstance.go index 9ebf74f7cfa..b69f49f6989 100644 --- a/service/databasemigrationservice/api_op_ModifyReplicationInstance.go +++ b/service/databasemigrationservice/api_op_ModifyReplicationInstance.go @@ -56,29 +56,23 @@ type ModifyReplicationInstanceInput struct { // doesn't result in an outage, except in the case described following. The change // is asynchronously applied as soon as possible. An outage does result if these // factors apply: - // - // * This parameter is set to true during the maintenance - // window. - // - // * A newer minor version is available. - // - // * DMS has enabled automatic - // patching for the given engine version. - // - // When AutoMinorVersionUpgrade is enabled, - // DMS uses the current default engine version when you modify a replication - // instance. For example, if you set EngineVersion to a lower version number than - // the current default version, DMS uses the default version. If - // AutoMinorVersionUpgrade isn’t enabled when you modify a replication instance, - // DMS uses the engine version specified by the EngineVersion parameter. + // - This parameter is set to true during the maintenance window. + // - A newer minor version is available. + // - DMS has enabled automatic patching for the given engine version. + // When AutoMinorVersionUpgrade is enabled, DMS uses the current default engine + // version when you modify a replication instance. For example, if you set + // EngineVersion to a lower version number than the current default version, DMS + // uses the default version. If AutoMinorVersionUpgrade isn’t enabled when you + // modify a replication instance, DMS uses the engine version specified by the + // EngineVersion parameter. AutoMinorVersionUpgrade *bool // The engine version number of the replication instance. When modifying a major - // engine version of an instance, also set AllowMajorVersionUpgrade to true. + // engine version of an instance, also set AllowMajorVersionUpgrade to true . EngineVersion *string // Specifies whether the replication instance is a Multi-AZ deployment. You can't - // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true . MultiAZ *bool // The type of IP address protocol used by a replication instance, such as IPv4 @@ -98,10 +92,10 @@ type ModifyReplicationInstanceInput struct { // The compute and memory capacity of the replication instance as defined for the // specified replication instance class. For example to specify the instance class - // dms.c4.large, set this parameter to "dms.c4.large". For more information on the + // dms.c4.large, set this parameter to "dms.c4.large" . For more information on the // settings and capacities for the available replication instance classes, see - // Selecting the right DMS replication instance for your migration - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). + // Selecting the right DMS replication instance for your migration (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) + // . ReplicationInstanceClass *string // The replication instance identifier. This parameter is stored as a lowercase diff --git a/service/databasemigrationservice/api_op_ModifyReplicationTask.go b/service/databasemigrationservice/api_op_ModifyReplicationTask.go index 3e4d7605390..b1a8ee7fcda 100644 --- a/service/databasemigrationservice/api_op_ModifyReplicationTask.go +++ b/service/databasemigrationservice/api_op_ModifyReplicationTask.go @@ -14,9 +14,8 @@ import ( // Modifies the specified replication task. You can't modify the task endpoints. // The task must be stopped before you can modify it. For more information about -// DMS tasks, see Working with Migration Tasks -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the -// Database Migration Service User Guide. +// DMS tasks, see Working with Migration Tasks (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) +// in the Database Migration Service User Guide. func (c *Client) ModifyReplicationTask(ctx context.Context, params *ModifyReplicationTaskInput, optFns ...func(*Options)) (*ModifyReplicationTaskOutput, error) { if params == nil { params = &ModifyReplicationTaskInput{} @@ -50,8 +49,8 @@ type ModifyReplicationTaskInput struct { // should already be created and associated with the source endpoint. You can // verify this by setting the slotName extra connection attribute to the name of // this logical replication slot. For more information, see Extra Connection - // Attributes When Using PostgreSQL as a Source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib). + // Attributes When Using PostgreSQL as a Source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) + // . CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either @@ -60,8 +59,8 @@ type ModifyReplicationTaskInput struct { // --cdc-start-time “2018-03-08T12:12:12” CdcStartTime *time.Time - // Indicates when you want a change data capture (CDC) operation to stop. The value - // can be either server time or commit time. Server time example: + // Indicates when you want a change data capture (CDC) operation to stop. The + // value can be either server time or commit time. Server time example: // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: // --cdc-stop-position “commit_time: 2018-02-09T12:12:12“ CdcStopPosition *string @@ -70,30 +69,24 @@ type ModifyReplicationTaskInput struct { MigrationType types.MigrationTypeValue // The replication task identifier. Constraints: - // - // * Must contain 1-255 alphanumeric - // characters or hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens. + // - Must contain 1-255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. ReplicationTaskIdentifier *string // JSON file that contains settings for the task, such as task metadata settings. ReplicationTaskSettings *string - // When using the CLI or boto3, provide the path of the JSON file that contains the - // table mappings. Precede the path with file://. For example, --table-mappings - // file://mappingfile.json. When working with the DMS API, provide the JSON as the - // parameter value. + // When using the CLI or boto3, provide the path of the JSON file that contains + // the table mappings. Precede the path with file:// . For example, + // --table-mappings file://mappingfile.json . When working with the DMS API, + // provide the JSON as the parameter value. TableMappings *string // Supplemental information that the task requires to migrate the data for certain // source and target endpoints. For more information, see Specifying Supplemental - // Data for Task Settings - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in - // the Database Migration Service User Guide. + // Data for Task Settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) + // in the Database Migration Service User Guide. TaskData *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_RebootReplicationInstance.go b/service/databasemigrationservice/api_op_RebootReplicationInstance.go index 50efe0e277a..607b0ff5c3f 100644 --- a/service/databasemigrationservice/api_op_RebootReplicationInstance.go +++ b/service/databasemigrationservice/api_op_RebootReplicationInstance.go @@ -35,16 +35,16 @@ type RebootReplicationInstanceInput struct { // This member is required. ReplicationInstanceArn *string - // If this parameter is true, the reboot is conducted through a Multi-AZ failover. - // If the instance isn't configured for Multi-AZ, then you can't specify true. ( - // --force-planned-failover and --force-failover can't both be set to true.) + // If this parameter is true , the reboot is conducted through a Multi-AZ failover. + // If the instance isn't configured for Multi-AZ, then you can't specify true . ( + // --force-planned-failover and --force-failover can't both be set to true .) ForceFailover *bool - // If this parameter is true, the reboot is conducted through a planned Multi-AZ + // If this parameter is true , the reboot is conducted through a planned Multi-AZ // failover where resources are released and cleaned up prior to conducting the // failover. If the instance isn''t configured for Multi-AZ, then you can't specify - // true. ( --force-planned-failover and --force-failover can't both be set to - // true.) + // true . ( --force-planned-failover and --force-failover can't both be set to true + // .) ForcePlannedFailover *bool noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_ReloadTables.go b/service/databasemigrationservice/api_op_ReloadTables.go index 745f8a61cfe..74a68841e63 100644 --- a/service/databasemigrationservice/api_op_ReloadTables.go +++ b/service/databasemigrationservice/api_op_ReloadTables.go @@ -41,8 +41,8 @@ type ReloadTablesInput struct { // This member is required. TablesToReload []types.TableToReload - // Options for reload. Specify data-reload to reload the data and re-validate it if - // validation is enabled. Specify validate-only to re-validate the table. This + // Options for reload. Specify data-reload to reload the data and re-validate it + // if validation is enabled. Specify validate-only to re-validate the table. This // option applies only when validation is enabled for the task. Valid values: // data-reload, validate-only Default value is data-reload. ReloadOption types.ReloadOptionValue diff --git a/service/databasemigrationservice/api_op_RemoveTagsFromResource.go b/service/databasemigrationservice/api_op_RemoveTagsFromResource.go index 592fd39e292..1d4674aa8c7 100644 --- a/service/databasemigrationservice/api_op_RemoveTagsFromResource.go +++ b/service/databasemigrationservice/api_op_RemoveTagsFromResource.go @@ -11,9 +11,8 @@ import ( ) // Removes metadata tags from an DMS resource, including replication instance, -// endpoint, subnet group, and migration task. For more information, see Tag -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html) data type -// description. +// endpoint, subnet group, and migration task. For more information, see Tag (https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html) +// data type description. func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { params = &RemoveTagsFromResourceInput{} diff --git a/service/databasemigrationservice/api_op_RunFleetAdvisorLsaAnalysis.go b/service/databasemigrationservice/api_op_RunFleetAdvisorLsaAnalysis.go index e12146e6321..3eb557828c1 100644 --- a/service/databasemigrationservice/api_op_RunFleetAdvisorLsaAnalysis.go +++ b/service/databasemigrationservice/api_op_RunFleetAdvisorLsaAnalysis.go @@ -36,7 +36,7 @@ type RunFleetAdvisorLsaAnalysisOutput struct { // The ID of the LSA analysis run. LsaAnalysisId *string - // The status of the LSA analysis, for example COMPLETED. + // The status of the LSA analysis, for example COMPLETED . Status *string // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_StartRecommendations.go b/service/databasemigrationservice/api_op_StartRecommendations.go index 2bffb884d8b..e151d39f7e0 100644 --- a/service/databasemigrationservice/api_op_StartRecommendations.go +++ b/service/databasemigrationservice/api_op_StartRecommendations.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts the analysis of your source database to provide recommendations of target -// engines. You can create recommendations for multiple source databases using -// BatchStartRecommendations -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_BatchStartRecommendations.html). +// Starts the analysis of your source database to provide recommendations of +// target engines. You can create recommendations for multiple source databases +// using BatchStartRecommendations (https://docs.aws.amazon.com/dms/latest/APIReference/API_BatchStartRecommendations.html) +// . func (c *Client) StartRecommendations(ctx context.Context, params *StartRecommendationsInput, optFns ...func(*Options)) (*StartRecommendationsOutput, error) { if params == nil { params = &StartRecommendationsInput{} diff --git a/service/databasemigrationservice/api_op_StartReplicationTask.go b/service/databasemigrationservice/api_op_StartReplicationTask.go index ce7765d7388..be2d9b8eebe 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTask.go +++ b/service/databasemigrationservice/api_op_StartReplicationTask.go @@ -13,9 +13,8 @@ import ( ) // Starts the replication task. For more information about DMS tasks, see Working -// with Migration Tasks -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the -// Database Migration Service User Guide. +// with Migration Tasks (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) +// in the Database Migration Service User Guide. func (c *Client) StartReplicationTask(ctx context.Context, params *StartReplicationTaskInput, optFns ...func(*Options)) (*StartReplicationTaskOutput, error) { if params == nil { params = &StartReplicationTaskInput{} @@ -39,15 +38,15 @@ type StartReplicationTaskInput struct { ReplicationTaskArn *string // The type of replication task to start. When the migration type is full-load or - // full-load-and-cdc, the only valid value for the first run of the task is - // start-replication. This option will start the migration. You can also use + // full-load-and-cdc , the only valid value for the first run of the task is + // start-replication . This option will start the migration. You can also use // ReloadTables to reload specific tables that failed during migration instead of // restarting the task. The resume-processing option isn't applicable for a // full-load task, because you can't resume partially loaded tables during the full // load phase. For a full-load-and-cdc task, DMS migrates table data, and then // applies data changes that occur on the source. To load all the tables again, and - // start capturing source changes, use reload-target. Otherwise use - // resume-processing, to replicate the changes from the last stop position. + // start capturing source changes, use reload-target . Otherwise use + // resume-processing , to replicate the changes from the last stop position. // // This member is required. StartReplicationTaskType types.StartReplicationTaskTypeValue @@ -63,8 +62,8 @@ type StartReplicationTaskInput struct { // should already be created and associated with the source endpoint. You can // verify this by setting the slotName extra connection attribute to the name of // this logical replication slot. For more information, see Extra Connection - // Attributes When Using PostgreSQL as a Source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib). + // Attributes When Using PostgreSQL as a Source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) + // . CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either @@ -73,8 +72,8 @@ type StartReplicationTaskInput struct { // --cdc-start-time “2018-03-08T12:12:12” CdcStartTime *time.Time - // Indicates when you want a change data capture (CDC) operation to stop. The value - // can be either server time or commit time. Server time example: + // Indicates when you want a change data capture (CDC) operation to stop. The + // value can be either server time or commit time. Server time example: // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: // --cdc-stop-position “commit_time: 2018-02-09T12:12:12“ CdcStopPosition *string diff --git a/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go b/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go index 2a0483f2039..fbf311c2897 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go +++ b/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go @@ -14,16 +14,12 @@ import ( // Starts the replication task assessment for unsupported data types in the source // database. You can only use this operation for a task if the following conditions // are true: +// - The task must be in the stopped state. +// - The task must have successful connections to the source and target. // -// * The task must be in the stopped state. -// -// * The task must have -// successful connections to the source and target. -// -// If either of these conditions -// are not met, an InvalidResourceStateFault error will result. For information -// about DMS task assessments, see Creating a task assessment report -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) +// If either of these conditions are not met, an InvalidResourceStateFault error +// will result. For information about DMS task assessments, see Creating a task +// assessment report (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) // in the Database Migration Service User Guide. func (c *Client) StartReplicationTaskAssessment(ctx context.Context, params *StartReplicationTaskAssessmentInput, optFns ...func(*Options)) (*StartReplicationTaskAssessmentOutput, error) { if params == nil { diff --git a/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go b/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go index 05afa0190ab..14dada1e5ec 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go +++ b/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go @@ -60,7 +60,7 @@ type StartReplicationTaskAssessmentRunInput struct { // Space-separated list of names for specific individual assessments that you want // to exclude. These names come from the default list of individual assessments // that DMS supports for the associated migration task. This task is specified by - // ReplicationTaskArn. You can't set a value for Exclude if you also set a value + // ReplicationTaskArn . You can't set a value for Exclude if you also set a value // for IncludeOnly in the API operation. To identify the names of the default // individual assessments that DMS supports for the associated migration task, run // the DescribeApplicableIndividualAssessments operation using its own @@ -70,7 +70,7 @@ type StartReplicationTaskAssessmentRunInput struct { // Space-separated list of names for specific individual assessments that you want // to include. These names come from the default list of individual assessments // that DMS supports for the associated migration task. This task is specified by - // ReplicationTaskArn. You can't set a value for IncludeOnly if you also set a + // ReplicationTaskArn . You can't set a value for IncludeOnly if you also set a // value for Exclude in the API operation. To identify the names of the default // individual assessments that DMS supports for the associated migration task, run // the DescribeApplicableIndividualAssessments operation using its own @@ -80,18 +80,14 @@ type StartReplicationTaskAssessmentRunInput struct { // Encryption mode that you can specify to encrypt the results of this assessment // run. If you don't specify this request parameter, DMS stores the assessment run // results without encryption. You can specify one of the options following: - // - // * - // "SSE_S3" – The server-side encryption provided as a default by Amazon S3. - // - // * - // "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use - // either a custom KMS encryption key that you specify or the default KMS - // encryption key that DMS provides. + // - "SSE_S3" – The server-side encryption provided as a default by Amazon S3. + // - "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use + // either a custom KMS encryption key that you specify or the default KMS + // encryption key that DMS provides. ResultEncryptionMode *string // ARN of a custom KMS encryption key that you specify when you set - // ResultEncryptionMode to "SSE_KMS". + // ResultEncryptionMode to "SSE_KMS ". ResultKmsKeyArn *string // Folder within an Amazon S3 bucket where you want DMS to store the results of diff --git a/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go b/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go index 931ef5c9138..811ff878acc 100644 --- a/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go +++ b/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go @@ -20,8 +20,7 @@ import ( // version 3.4.6, some types of events might not be available when you use Amazon // EventBridge. To call this operation, make sure that you have certain permissions // added to your user account. For more information, see Migrating event -// subscriptions to Amazon EventBridge -// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge) +// subscriptions to Amazon EventBridge (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge) // in the Amazon Web Services Database Migration Service User Guide. func (c *Client) UpdateSubscriptionsToEventBridge(ctx context.Context, params *UpdateSubscriptionsToEventBridgeInput, optFns ...func(*Options)) (*UpdateSubscriptionsToEventBridgeOutput, error) { if params == nil { diff --git a/service/databasemigrationservice/doc.go b/service/databasemigrationservice/doc.go index 1da2fc87ced..c09e1a8a705 100644 --- a/service/databasemigrationservice/doc.go +++ b/service/databasemigrationservice/doc.go @@ -10,7 +10,6 @@ // homogeneous migrations such as Oracle to Oracle, as well as heterogeneous // migrations between different database platforms, such as Oracle to MySQL or SQL // Server to PostgreSQL. For more information about DMS, see What Is Database -// Migration Service? -// (https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) in the Database -// Migration Service User Guide. +// Migration Service? (https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html) +// in the Database Migration Service User Guide. package databasemigrationservice diff --git a/service/databasemigrationservice/types/enums.go b/service/databasemigrationservice/types/enums.go index 3d93758d71d..26aecda7483 100644 --- a/service/databasemigrationservice/types/enums.go +++ b/service/databasemigrationservice/types/enums.go @@ -54,9 +54,9 @@ const ( CannedAclForObjectsValueBucketOwnerFullControl CannedAclForObjectsValue = "bucket-owner-full-control" ) -// Values returns all known values for CannedAclForObjectsValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CannedAclForObjectsValue. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CannedAclForObjectsValue) Values() []CannedAclForObjectsValue { return []CannedAclForObjectsValue{ "none", @@ -260,9 +260,9 @@ const ( EndpointSettingTypeValueEnum EndpointSettingTypeValue = "enum" ) -// Values returns all known values for EndpointSettingTypeValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointSettingTypeValue. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointSettingTypeValue) Values() []EndpointSettingTypeValue { return []EndpointSettingTypeValue{ "string", @@ -300,8 +300,8 @@ const ( KafkaSecurityProtocolSaslSsl KafkaSecurityProtocol = "sasl-ssl" ) -// Values returns all known values for KafkaSecurityProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for KafkaSecurityProtocol. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (KafkaSecurityProtocol) Values() []KafkaSecurityProtocol { return []KafkaSecurityProtocol{ @@ -491,9 +491,10 @@ const ( ReplicationEndpointTypeValueTarget ReplicationEndpointTypeValue = "target" ) -// Values returns all known values for ReplicationEndpointTypeValue. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReplicationEndpointTypeValue. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ReplicationEndpointTypeValue) Values() []ReplicationEndpointTypeValue { return []ReplicationEndpointTypeValue{ "source", @@ -545,9 +546,9 @@ const ( SslSecurityProtocolValueSslEncryption SslSecurityProtocolValue = "ssl-encryption" ) -// Values returns all known values for SslSecurityProtocolValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SslSecurityProtocolValue. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SslSecurityProtocolValue) Values() []SslSecurityProtocolValue { return []SslSecurityProtocolValue{ "plaintext", @@ -584,9 +585,9 @@ const ( TargetDbTypeMultipleDatabases TargetDbType = "multiple-databases" ) -// Values returns all known values for TargetDbType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetDbType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetDbType) Values() []TargetDbType { return []TargetDbType{ "specific-database", diff --git a/service/databasemigrationservice/types/types.go b/service/databasemigrationservice/types/types.go index 4ed405579ca..fb3f6c6b5c7 100644 --- a/service/databasemigrationservice/types/types.go +++ b/service/databasemigrationservice/types/types.go @@ -24,8 +24,7 @@ type AccountQuota struct { } // The name of an Availability Zone for use during database migration. -// AvailabilityZone is an optional parameter to the CreateReplicationInstance -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationInstance.html) +// AvailabilityZone is an optional parameter to the CreateReplicationInstance (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationInstance.html) // operation, and it’s value relates to the Amazon Web Services Region of an // endpoint. For example, the availability zone of an endpoint in the us-east-1 // region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d. @@ -74,8 +73,8 @@ type Certificate struct { // The contents of a .pem file, which contains an X.509 certificate. CertificatePem *string - // The location of an imported Oracle Wallet certificate for use with SSL. Example: - // filebase64("${path.root}/rds-ca-2019-root.sso") + // The location of an imported Oracle Wallet certificate for use with SSL. + // Example: filebase64("${path.root}/rds-ca-2019-root.sso") CertificateWallet []byte // The key length of the cryptographic algorithm being used. @@ -102,8 +101,8 @@ type CollectorHealthCheck struct { // Whether the local collector can access its Amazon S3 bucket. LocalCollectorS3Access *bool - // Whether the role that you provided when creating the Fleet Advisor collector has - // sufficient permissions to access the Fleet Advisor web collector. + // Whether the role that you provided when creating the Fleet Advisor collector + // has sufficient permissions to access the Fleet Advisor web collector. WebCollectorGrantedRoleBasedAccess *bool // Whether the web collector can access its Amazon S3 bucket. @@ -198,15 +197,10 @@ type Connection struct { ReplicationInstanceIdentifier *string // The connection status. This parameter can return one of the following values: - // - // * - // "successful" - // - // * "testing" - // - // * "failed" - // - // * "deleting" + // - "successful" + // - "testing" + // - "failed" + // - "deleting" Status *string noSmithyDocumentSerde @@ -216,15 +210,15 @@ type Connection struct { type DatabaseInstanceSoftwareDetailsResponse struct { // The database engine of a database in a Fleet Advisor collector inventory, for - // example Microsoft SQL Server. + // example Microsoft SQL Server . Engine *string // The database engine edition of a database in a Fleet Advisor collector - // inventory, for example Express. + // inventory, for example Express . EngineEdition *string // The database engine version of a database in a Fleet Advisor collector - // inventory, for example 2019. + // inventory, for example 2019 . EngineVersion *string // The operating system architecture of the database. @@ -233,11 +227,11 @@ type DatabaseInstanceSoftwareDetailsResponse struct { // The service pack level of the database. ServicePack *string - // The support level of the database, for example Mainstream support. + // The support level of the database, for example Mainstream support . SupportLevel *string // Information about the database engine software, for example Mainstream support - // ends on November 14th, 2024. + // ends on November 14th, 2024 . Tooltip *string noSmithyDocumentSerde @@ -275,7 +269,7 @@ type DatabaseResponse struct { type DatabaseShortInfoResponse struct { // The database engine of a database in a Fleet Advisor collector inventory, for - // example PostgreSQL. + // example PostgreSQL . DatabaseEngine *string // The ID of a database in a Fleet Advisor collector inventory. @@ -310,23 +304,23 @@ type DocDbSettings struct { DatabaseName *string // Indicates the number of documents to preview to determine the document - // organization. Use this setting when NestingLevel is set to "one". Must be a - // positive value greater than 0. Default value is 1000. + // organization. Use this setting when NestingLevel is set to "one" . Must be a + // positive value greater than 0 . Default value is 1000 . DocsToInvestigate *int32 - // Specifies the document ID. Use this setting when NestingLevel is set to "none". - // Default value is "false". + // Specifies the document ID. Use this setting when NestingLevel is set to "none" . + // Default value is "false" . ExtractDocId *bool // The KMS key identifier that is used to encrypt the content on the replication - // instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // instance. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string - // Specifies either document or table mode. Default value is "none". Specify "none" - // to use document mode. Specify "one" to use table mode. + // Specifies either document or table mode. Default value is "none" . Specify + // "none" to use document mode. Specify "one" to use table mode. NestingLevel NestingLevelValue // The password for the user account you use to access the DocumentDB source @@ -338,16 +332,15 @@ type DocDbSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the DocumentDB endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -396,16 +389,17 @@ type ElasticsearchSettings struct { // OpenSearch cluster. ErrorRetryDuration *int32 - // The maximum percentage of records that can fail to be written before a full load - // operation stops. To avoid early failure, this counter is only effective after - // 1000 records are transferred. OpenSearch also has the concept of error + // The maximum percentage of records that can fail to be written before a full + // load operation stops. To avoid early failure, this counter is only effective + // after 1000 records are transferred. OpenSearch also has the concept of error // monitoring during the last 10 minutes of an Observation Window. If transfer of // all records fail in the last 10 minutes, the full load operation stops. FullLoadErrorPercentage *int32 - // Set this option to true for DMS to migrate documentation using the documentation - // type _doc. OpenSearch and an Elasticsearch cluster only support the _doc - // documentation type in versions 7. x and later. The default value is false. + // Set this option to true for DMS to migrate documentation using the + // documentation type _doc . OpenSearch and an Elasticsearch cluster only support + // the _doc documentation type in versions 7. x and later. The default value is + // false . UseNewMappingType *bool noSmithyDocumentSerde @@ -413,12 +407,9 @@ type ElasticsearchSettings struct { // Describes an endpoint of a database instance in response to operations such as // the following: -// -// * CreateEndpoint -// -// * DescribeEndpoint -// -// * ModifyEndpoint +// - CreateEndpoint +// - DescribeEndpoint +// - ModifyEndpoint type Endpoint struct { // The Amazon Resource Name (ARN) used for SSL connection to the endpoint. @@ -450,7 +441,7 @@ type Endpoint struct { // contain two consecutive hyphens. EndpointIdentifier *string - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target . EndpointType ReplicationEndpointTypeValue // The expanded name for the engine name. For example, if the EngineName parameter @@ -458,10 +449,10 @@ type Endpoint struct { EngineDisplayName *string // The database engine name. Valid values, depending on the EndpointType, include - // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and - // "babelfish". + // "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , + // "redshift" , "s3" , "db2" , "db2-zos" , "azuredb" , "sybase" , "dynamodb" , + // "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , + // "neptune" , and "babelfish" . EngineName *string // Value returned by a call to CreateEndpoint that can be used for cross-account @@ -482,8 +473,8 @@ type Endpoint struct { // IBMDb2Settings structure. IBMDb2Settings *IBMDb2Settings - // The settings for the Apache Kafka target endpoint. For more information, see the - // KafkaSettings structure. + // The settings for the Apache Kafka target endpoint. For more information, see + // the KafkaSettings structure. KafkaSettings *KafkaSettings // The settings for the Amazon Kinesis target endpoint. For more information, see @@ -491,10 +482,10 @@ type Endpoint struct { KinesisSettings *KinesisSettings // An KMS key identifier that is used to encrypt the connection parameters for the - // endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string // The settings for the Microsoft SQL Server source and target endpoint. For more @@ -505,8 +496,8 @@ type Endpoint struct { // MongoDbSettings structure. MongoDbSettings *MongoDbSettings - // The settings for the MySQL source and target endpoint. For more information, see - // the MySQLSettings structure. + // The settings for the MySQL source and target endpoint. For more information, + // see the MySQLSettings structure. MySQLSettings *MySQLSettings // The settings for the Amazon Neptune target endpoint. For more information, see @@ -542,7 +533,7 @@ type Endpoint struct { // role must allow the iam:PassRole action. ServiceAccessRoleArn *string - // The SSL mode used to connect to the endpoint. The default value is none. + // The SSL mode used to connect to the endpoint. The default value is none . SslMode DmsSslModeValue // The status of the endpoint. @@ -566,16 +557,16 @@ type EndpointSetting struct { Applicability *string // The default value of the endpoint setting if no value is specified using - // CreateEndpoint or ModifyEndpoint. + // CreateEndpoint or ModifyEndpoint . DefaultValue *string // Enumerated values to use for this endpoint. EnumValues []string - // The maximum value of an endpoint setting that is of type int. + // The maximum value of an endpoint setting that is of type int . IntValueMax *int32 - // The minimum value of an endpoint setting that is of type int. + // The minimum value of an endpoint setting that is of type int . IntValueMin *int32 // The name that you want to give the endpoint settings. @@ -584,7 +575,7 @@ type EndpointSetting struct { // A value that marks this endpoint setting as sensitive. Sensitive *bool - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target . Type EndpointSettingTypeValue // The unit of measure for this endpoint setting. @@ -618,8 +609,7 @@ type Event struct { } // Lists categories of events subscribed to, and generated by, the applicable DMS -// resource type. This data type appears in response to the DescribeEventCategories -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html) +// resource type. This data type appears in response to the DescribeEventCategories (https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html) // action. type EventCategoryGroup struct { @@ -722,14 +712,10 @@ type FleetAdvisorSchemaObjectResponse struct { // The type of the schema object, as reported by the database engine. Examples // include the following: - // - // * function - // - // * trigger - // - // * SYSTEM_TABLE - // - // * QUEUE + // - function + // - trigger + // - SYSTEM_TABLE + // - QUEUE ObjectType *string // The ID of a schema object in a Fleet Advisor collector inventory. @@ -747,9 +733,9 @@ type GcpMySQLSettings struct { // of a file containing the script. AfterConnectScript *string - // Cleans and recreates table metadata information on the replication instance when - // a mismatch occurs. For example, in a situation where running an alter DDL on the - // table could result in different information about the table cached in the + // Cleans and recreates table metadata information on the replication instance + // when a mismatch occurs. For example, in a situation where running an alter DDL + // on the table could result in different information about the table cached in the // replication instance. CleanSourceMetadataOnMismatch *bool @@ -762,8 +748,8 @@ type GcpMySQLSettings struct { DatabaseName *string // Specifies how often to check the binary log for new changes/events when the - // database is idle. The default is five seconds. Example: eventsPollInterval=5; In - // the example, DMS checks for changes in the binary logs every five seconds. + // database is idle. The default is five seconds. Example: eventsPollInterval=5; + // In the example, DMS checks for changes in the binary logs every five seconds. EventsPollInterval *int32 // Specifies the maximum size (in KB) of any .csv file used to transfer data to a @@ -789,12 +775,11 @@ type GcpMySQLSettings struct { // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the MySQL endpoint. You can specify one of two sets // of values for these permissions. You can specify the values for this setting and - // SecretsManagerSecretId. Or you can specify clear-text values for UserName, - // Password, ServerName, and Port. You can't specify both. For more information on - // creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and + // SecretsManagerSecretId . Or you can specify clear-text values for UserName , + // Password , ServerName , and Port . You can't specify both. For more information + // on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and // SecretsManagerSecretId required to access it, see Using secrets to access - // Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -840,16 +825,15 @@ type IBMDb2Settings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the Db2 LUW endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -889,57 +873,56 @@ type KafkaSettings struct { // A comma-separated list of one or more broker locations in your Kafka cluster // that host your Kafka instance. Specify each broker location in the form // broker-hostname-or-ip:port . For example, - // "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and + // "ec2-12-345-678-901.compute-1.amazonaws.com:2345" . For more information and // examples of specifying a list of broker locations, see Using Apache Kafka as a - // target for Database Migration Service - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the - // Database Migration Service User Guide. + // target for Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) + // in the Database Migration Service User Guide. Broker *string // Shows detailed control information for table definition, column definition, and - // table and column changes in the Kafka message output. The default is false. + // table and column changes in the Kafka message output. The default is false . IncludeControlDetails *bool - // Include NULL and empty columns for records migrated to the endpoint. The default - // is false. + // Include NULL and empty columns for records migrated to the endpoint. The + // default is false . IncludeNullAndEmpty *bool // Shows the partition value within the Kafka message output unless the partition - // type is schema-table-type. The default is false. + // type is schema-table-type . The default is false . IncludePartitionValue *bool // Includes any data definition language (DDL) operations that change the table in - // the control data, such as rename-table, drop-table, add-column, drop-column, and - // rename-column. The default is false. + // the control data, such as rename-table , drop-table , add-column , drop-column , + // and rename-column . The default is false . IncludeTableAlterOperations *bool // Provides detailed transaction information from the source database. This // information includes a commit timestamp, a log position, and values for - // transaction_id, previous transaction_id, and transaction_record_id (the record - // offset within a transaction). The default is false. + // transaction_id , previous transaction_id , and transaction_record_id (the + // record offset within a transaction). The default is false . IncludeTransactionDetails *bool - // The output format for the records created on the endpoint. The message format is - // JSON (default) or JSON_UNFORMATTED (a single line with no tab). + // The output format for the records created on the endpoint. The message format + // is JSON (default) or JSON_UNFORMATTED (a single line with no tab). MessageFormat MessageFormatValue // The maximum size in bytes for records created on the endpoint The default is // 1,000,000. MessageMaxBytes *int32 - // Set this optional parameter to true to avoid adding a '0x' prefix to raw data in - // hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB - // column type in hexadecimal format moving from an Oracle source to a Kafka + // Set this optional parameter to true to avoid adding a '0x' prefix to raw data + // in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the + // LOB column type in hexadecimal format moving from an Oracle source to a Kafka // target. Use the NoHexPrefix endpoint setting to enable migration of RAW data // type columns without adding the '0x' prefix. NoHexPrefix *bool // Prefixes schema and table names to partition values, when the partition type is - // primary-key-type. Doing this increases data distribution among Kafka partitions. - // For example, suppose that a SysBench schema has thousands of tables and each - // table has only limited range for a primary key. In this case, the same primary - // key is sent from thousands of tables to the same partition, which causes - // throttling. The default is false. + // primary-key-type . Doing this increases data distribution among Kafka + // partitions. For example, suppose that a SysBench schema has thousands of tables + // and each table has only limited range for a primary key. In this case, the same + // primary key is sent from thousands of tables to the same partition, which causes + // throttling. The default is false . PartitionIncludeSchemaTable *bool // For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by @@ -958,8 +941,8 @@ type KafkaSettings struct { SaslUsername *string // Set secure connection to a Kafka target endpoint using Transport Layer Security - // (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. - // sasl-ssl requires SaslUsername and SaslPassword. + // (TLS). Options include ssl-encryption , ssl-authentication , and sasl-ssl . + // sasl-ssl requires SaslUsername and SaslPassword . SecurityProtocol KafkaSecurityProtocol // The Amazon Resource Name (ARN) for the private certificate authority (CA) cert @@ -985,51 +968,51 @@ type KafkaSettings struct { noSmithyDocumentSerde } -// Provides information that describes an Amazon Kinesis Data Stream endpoint. This -// information includes the output format of records applied to the endpoint and -// details of transaction and control table data information. +// Provides information that describes an Amazon Kinesis Data Stream endpoint. +// This information includes the output format of records applied to the endpoint +// and details of transaction and control table data information. type KinesisSettings struct { // Shows detailed control information for table definition, column definition, and - // table and column changes in the Kinesis message output. The default is false. + // table and column changes in the Kinesis message output. The default is false . IncludeControlDetails *bool - // Include NULL and empty columns for records migrated to the endpoint. The default - // is false. + // Include NULL and empty columns for records migrated to the endpoint. The + // default is false . IncludeNullAndEmpty *bool // Shows the partition value within the Kinesis message output, unless the - // partition type is schema-table-type. The default is false. + // partition type is schema-table-type . The default is false . IncludePartitionValue *bool // Includes any data definition language (DDL) operations that change the table in - // the control data, such as rename-table, drop-table, add-column, drop-column, and - // rename-column. The default is false. + // the control data, such as rename-table , drop-table , add-column , drop-column , + // and rename-column . The default is false . IncludeTableAlterOperations *bool // Provides detailed transaction information from the source database. This // information includes a commit timestamp, a log position, and values for - // transaction_id, previous transaction_id, and transaction_record_id (the record - // offset within a transaction). The default is false. + // transaction_id , previous transaction_id , and transaction_record_id (the + // record offset within a transaction). The default is false . IncludeTransactionDetails *bool - // The output format for the records created on the endpoint. The message format is - // JSON (default) or JSON_UNFORMATTED (a single line with no tab). + // The output format for the records created on the endpoint. The message format + // is JSON (default) or JSON_UNFORMATTED (a single line with no tab). MessageFormat MessageFormatValue - // Set this optional parameter to true to avoid adding a '0x' prefix to raw data in - // hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB - // column type in hexadecimal format moving from an Oracle source to an Amazon + // Set this optional parameter to true to avoid adding a '0x' prefix to raw data + // in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the + // LOB column type in hexadecimal format moving from an Oracle source to an Amazon // Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW // data type columns without adding the '0x' prefix. NoHexPrefix *bool // Prefixes schema and table names to partition values, when the partition type is - // primary-key-type. Doing this increases data distribution among Kinesis shards. + // primary-key-type . Doing this increases data distribution among Kinesis shards. // For example, suppose that a SysBench schema has thousands of tables and each // table has only limited range for a primary key. In this case, the same primary // key is sent from thousands of tables to the same shard, which causes throttling. - // The default is false. + // The default is false . PartitionIncludeSchemaTable *bool // The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the @@ -1058,15 +1041,15 @@ type Limitation struct { // avoid this limitation. Description *string - // The name of the target engine that Fleet Advisor should use in the target engine - // recommendation. Valid values include "rds-aurora-mysql", - // "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and - // "rds-postgresql". + // The name of the target engine that Fleet Advisor should use in the target + // engine recommendation. Valid values include "rds-aurora-mysql" , + // "rds-aurora-postgresql" , "rds-mysql" , "rds-oracle" , "rds-sql-server" , and + // "rds-postgresql" . EngineName *string // The impact of the limitation. You can use this parameter to prioritize - // limitations that you want to address. Valid values include "Blocker", "High", - // "Medium", and "Low". + // limitations that you want to address. Valid values include "Blocker" , "High" , + // "Medium" , and "Low" . Impact *string // The name of the limitation. Describes unsupported database features, migration @@ -1103,13 +1086,13 @@ type MicrosoftSQLServerSettings struct { // Endpoint TCP port. Port *int32 - // Cleans and recreates table metadata information on the replication instance when - // a mismatch occurs. An example is a situation where running an alter DDL + // Cleans and recreates table metadata information on the replication instance + // when a mismatch occurs. An example is a situation where running an alter DDL // statement on a table might result in different information about the table // cached in the replication instance. QuerySingleAlwaysOnNode *bool - // When this attribute is set to Y, DMS only reads changes from transaction log + // When this attribute is set to Y , DMS only reads changes from transaction log // backups and doesn't read from the active transaction log file during ongoing // replication. Setting this parameter to Y enables you to control active // transaction log file growth during full load and ongoing replication tasks. @@ -1133,16 +1116,15 @@ type MicrosoftSQLServerSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the SQL Server endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -1151,18 +1133,16 @@ type MicrosoftSQLServerSettings struct { SecretsManagerSecretId *string // Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server - // instance, this is the output of DescribeDBInstances - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), - // in the Endpoint - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address - // field. + // instance, this is the output of DescribeDBInstances (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) + // , in the Endpoint (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) + // .Address field. ServerName *string // Indicates the mode used to fetch CDC data. TlogAccessMode TlogAccessMode // Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR - // data types during migration. The default value is true. + // data types during migration. The default value is true . TrimSpaceInChar *bool // Use this to attribute to transfer data for full-load operations using BCP. When @@ -1170,7 +1150,7 @@ type MicrosoftSQLServerSettings struct { // table, you must disable the use BCP for loading table option. UseBcpFullLoad *bool - // When this attribute is set to Y, DMS processes third-party transaction log + // When this attribute is set to Y , DMS processes third-party transaction log // backups if they are created in native format. UseThirdPartyBackupDevice *bool @@ -1184,40 +1164,41 @@ type MicrosoftSQLServerSettings struct { type MongoDbSettings struct { // The authentication mechanism you use to access the MongoDB source endpoint. For - // the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For - // MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't - // used when AuthType is set to "no". + // the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For + // MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn't + // used when AuthType is set to "no" . AuthMechanism AuthMechanismValue - // The MongoDB database name. This setting isn't used when AuthType is set to "no". - // The default is "admin". + // The MongoDB database name. This setting isn't used when AuthType is set to "no" + // . The default is "admin" . AuthSource *string - // The authentication type you use to access the MongoDB source endpoint. When when - // set to "no", user name and password parameters are not used and can be empty. + // The authentication type you use to access the MongoDB source endpoint. When + // when set to "no" , user name and password parameters are not used and can be + // empty. AuthType AuthTypeValue // The database name on the MongoDB source endpoint. DatabaseName *string // Indicates the number of documents to preview to determine the document - // organization. Use this setting when NestingLevel is set to "one". Must be a - // positive value greater than 0. Default value is 1000. + // organization. Use this setting when NestingLevel is set to "one" . Must be a + // positive value greater than 0 . Default value is 1000 . DocsToInvestigate *string - // Specifies the document ID. Use this setting when NestingLevel is set to "none". - // Default value is "false". + // Specifies the document ID. Use this setting when NestingLevel is set to "none" . + // Default value is "false" . ExtractDocId *string // The KMS key identifier that is used to encrypt the content on the replication - // instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // instance. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string - // Specifies either document or table mode. Default value is "none". Specify "none" - // to use document mode. Specify "one" to use table mode. + // Specifies either document or table mode. Default value is "none" . Specify + // "none" to use document mode. Specify "one" to use table mode. NestingLevel NestingLevelValue // The password for the user account you use to access the MongoDB source endpoint. @@ -1228,16 +1209,15 @@ type MongoDbSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the MongoDB endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -1263,9 +1243,9 @@ type MySQLSettings struct { // of a file containing the script. AfterConnectScript *string - // Cleans and recreates table metadata information on the replication instance when - // a mismatch occurs. For example, in a situation where running an alter DDL on the - // table could result in different information about the table cached in the + // Cleans and recreates table metadata information on the replication instance + // when a mismatch occurs. For example, in a situation where running an alter DDL + // on the table could result in different information about the table cached in the // replication instance. CleanSourceMetadataOnMismatch *bool @@ -1278,8 +1258,8 @@ type MySQLSettings struct { DatabaseName *string // Specifies how often to check the binary log for new changes/events when the - // database is idle. The default is five seconds. Example: eventsPollInterval=5; In - // the example, DMS checks for changes in the binary logs every five seconds. + // database is idle. The default is five seconds. Example: eventsPollInterval=5; + // In the example, DMS checks for changes in the binary logs every five seconds. EventsPollInterval *int32 // Specifies the maximum size (in KB) of any .csv file used to transfer data to a @@ -1301,16 +1281,15 @@ type MySQLSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the MySQL endpoint. You can specify one of two sets // of values for these permissions. You can specify the values for this setting and - // SecretsManagerSecretId. Or you can specify clear-text values for UserName, - // Password, ServerName, and Port. You can't specify both. For more information on - // creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and + // SecretsManagerSecretId . Or you can specify clear-text values for UserName , + // Password , ServerName , and Port . You can't specify both. For more information + // on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and // SecretsManagerSecretId required to access it, see Using secrets to access - // Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -1319,13 +1298,11 @@ type MySQLSettings struct { SecretsManagerSecretId *string // The host name of the endpoint database. For an Amazon RDS MySQL instance, this - // is the output of DescribeDBInstances - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), - // in the Endpoint - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address - // field. For an Aurora MySQL instance, this is the output of DescribeDBClusters - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), - // in the Endpoint field. + // is the output of DescribeDBInstances (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) + // , in the Endpoint (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) + // .Address field. For an Aurora MySQL instance, this is the output of + // DescribeDBClusters (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html) + // , in the Endpoint field. ServerName *string // Specifies the time zone for the source MySQL database. Example: @@ -1333,7 +1310,7 @@ type MySQLSettings struct { ServerTimezone *string // Specifies where to migrate source tables on the target, either to a single - // database or multiple databases. If you specify SPECIFIC_DATABASE, specify the + // database or multiple databases. If you specify SPECIFIC_DATABASE , specify the // database name using the DatabaseName parameter of the Endpoint object. Example: // targetDbType=MULTIPLE_DATABASES TargetDbType TargetDbType @@ -1366,9 +1343,9 @@ type NeptuneSettings struct { ErrorRetryDuration *int32 // If you want Identity and Access Management (IAM) authorization enabled for this - // endpoint, set this parameter to true. Then attach the appropriate IAM policy - // document to your service role specified by ServiceAccessRoleArn. The default is - // false. + // endpoint, set this parameter to true . Then attach the appropriate IAM policy + // document to your service role specified by ServiceAccessRoleArn . The default is + // false . IamAuthEnabled *bool // The maximum size in kilobytes of migrated graph data stored in a .csv file @@ -1384,8 +1361,7 @@ type NeptuneSettings struct { // The Amazon Resource Name (ARN) of the service role that you created for the // Neptune target endpoint. The role must allow the iam:PassRole action. For more // information, see Creating an IAM Service Role for Accessing Amazon Neptune as a - // Target - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) + // Target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) // in the Database Migration Service User Guide. ServiceAccessRoleArn *string @@ -1411,10 +1387,9 @@ type OracleSettings struct { // attribute is useful in the case of a switchover. In this case, DMS needs to know // which destination to get archive redo logs from to read changes. This need // arises because the previous primary instance is now a standby instance after - // switchover. Although DMS supports the use of the Oracle RESETLOGS option to open - // the database, never use RESETLOGS unless necessary. For additional information - // about RESETLOGS, see RMAN Data Repair Concepts - // (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) + // switchover. Although DMS supports the use of the Oracle RESETLOGS option to + // open the database, never use RESETLOGS unless necessary. For additional + // information about RESETLOGS , see RMAN Data Repair Concepts (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) // in the Oracle Database Backup and Recovery User's Guide. AdditionalArchivedLogDestId *int32 @@ -1423,47 +1398,47 @@ type OracleSettings struct { AllowSelectNestedTables *bool // Specifies the ID of the destination for the archived redo logs. This value - // should be the same as a number in the dest_id column of the v$archived_log view. - // If you work with an additional redo log destination, use the + // should be the same as a number in the dest_id column of the v$archived_log + // view. If you work with an additional redo log destination, use the // AdditionalArchivedLogDestId option to specify the additional destination ID. // Doing this improves performance by ensuring that the correct logs are accessed // from the outset. ArchivedLogDestId *int32 - // When this field is set to Y, DMS only accesses the archived redo logs. If the + // When this field is set to Y , DMS only accesses the archived redo logs. If the // archived redo logs are stored on Automatic Storage Management (ASM) only, the // DMS user account needs to be granted ASM privileges. ArchivedLogsOnly *bool // For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) - // password. You can set this value from the asm_user_password value. You set + // password. You can set this value from the asm_user_password value. You set // this value as part of the comma-separated value that you set to the Password // request parameter when you create the endpoint to access transaction logs using // Binary Reader. For more information, see Configuration for change data capture - // (CDC) on an Oracle source database - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). + // (CDC) on an Oracle source database (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) + // . AsmPassword *string // For an Oracle source endpoint, your ASM server address. You can set this value // from the asm_server value. You set asm_server as part of the extra connection // attribute string to access an Oracle server with Binary Reader that uses ASM. // For more information, see Configuration for change data capture (CDC) on an - // Oracle source database - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). + // Oracle source database (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) + // . AsmServer *string // For an Oracle source endpoint, your ASM user name. You can set this value from // the asm_user value. You set asm_user as part of the extra connection attribute // string to access an Oracle server with Binary Reader that uses ASM. For more - // information, see Configuration for change data capture (CDC) on an Oracle source - // database - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). + // information, see Configuration for change data capture (CDC) on an Oracle + // source database (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration) + // . AsmUser *string - // Specifies whether the length of a character column is in bytes or in characters. - // To indicate that the character column length is in characters, set this - // attribute to CHAR. Otherwise, the character column length is in bytes. Example: - // charLengthSemantics=CHAR; + // Specifies whether the length of a character column is in bytes or in + // characters. To indicate that the character column length is in characters, set + // this attribute to CHAR . Otherwise, the character column length is in bytes. + // Example: charLengthSemantics=CHAR; CharLengthSemantics CharLengthSemantics // When true, converts timestamps with the timezone datatype to their UTC value. @@ -1472,14 +1447,14 @@ type OracleSettings struct { // Database name for the endpoint. DatabaseName *string - // When set to true, this attribute helps to increase the commit rate on the Oracle - // target database by writing directly to tables and not writing a trail to + // When set to true , this attribute helps to increase the commit rate on the + // Oracle target database by writing directly to tables and not writing a trail to // database logs. DirectPathNoLog *bool - // When set to true, this attribute specifies a parallel load when - // useDirectPathFullLoad is set to Y. This attribute also only applies when you use - // the DMS parallel load feature. Note that the target table cannot have any + // When set to true , this attribute specifies a parallel load when + // useDirectPathFullLoad is set to Y . This attribute also only applies when you + // use the DMS parallel load feature. Note that the target table cannot have any // constraints or indexes. DirectPathParallelLoad *bool @@ -1500,15 +1475,14 @@ type OracleSettings struct { // apply the following settings. archivedLogDestId=1; // ExtraArchivedLogDestIds=[2,3,4] Although DMS supports the use of the Oracle // RESETLOGS option to open the database, never use RESETLOGS unless it's - // necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts - // (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) + // necessary. For more information about RESETLOGS , see RMAN Data Repair Concepts (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) // in the Oracle Database Backup and Recovery User's Guide. ExtraArchivedLogDestIds []int32 - // When set to true, this attribute causes a task to fail if the actual size of an - // LOB column is greater than the specified LobMaxSize. If a task is set to limited - // LOB mode and this option is set to true, the task fails instead of truncating - // the LOB data. + // When set to true , this attribute causes a task to fail if the actual size of an + // LOB column is greater than the specified LobMaxSize . If a task is set to + // limited LOB mode and this option is set to true , the task fails instead of + // truncating the LOB data. FailTasksOnLobTruncation *bool // Specifies the number scale. You can select a scale up to 38, or you can select @@ -1533,13 +1507,13 @@ type OracleSettings struct { // Endpoint TCP port. Port *int32 - // Set this attribute to change the number of read-ahead blocks that DMS configures - // to perform a change data capture (CDC) load using Oracle Automatic Storage - // Management (ASM). You can specify an integer value between 1000 (the default) - // and 200,000 (the maximum). + // Set this attribute to change the number of read-ahead blocks that DMS + // configures to perform a change data capture (CDC) load using Oracle Automatic + // Storage Management (ASM). You can specify an integer value between 1000 (the + // default) and 200,000 (the maximum). ReadAheadBlocks *int32 - // When set to true, this attribute supports tablespace replication. + // When set to true , this attribute supports tablespace replication. ReadTableSpaceName *bool // Set this attribute to true in order to use the Binary Reader to capture change @@ -1554,32 +1528,30 @@ type OracleSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the Oracle endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string // Required only if your Oracle endpoint uses Automatic Storage Management (ASM). // The full ARN of the IAM role that specifies DMS as the trusted entity and grants - // the required permissions to access the SecretsManagerOracleAsmSecret. This + // the required permissions to access the SecretsManagerOracleAsmSecret . This // SecretsManagerOracleAsmSecret has the secret value that allows access to the // Oracle ASM of the endpoint. You can specify one of two sets of values for these // permissions. You can specify the values for this setting and - // SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for - // AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more + // SecretsManagerOracleAsmSecretId . Or you can specify clear-text values for + // AsmUserName , AsmPassword , and AsmServerName . You can't specify both. For more // information on creating this SecretsManagerOracleAsmSecret and the // SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId // required to access it, see Using secrets to access Database Migration Service - // resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerOracleAsmAccessRoleArn *string @@ -1594,12 +1566,11 @@ type OracleSettings struct { // For an Oracle source endpoint, the transparent data encryption (TDE) password // required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary - // Reader. It is also the TDE_Password part of the comma-separated value you set + // Reader. It is also the TDE_Password part of the comma-separated value you set // to the Password request parameter when you create the endpoint. The // SecurityDbEncryptian setting is related to this SecurityDbEncryptionName - // setting. For more information, see Supported encryption methods for using - // Oracle as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) + // setting. For more information, see Supported encryption methods for using + // Oracle as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) // in the Database Migration Service User Guide. SecurityDbEncryption *string @@ -1607,19 +1578,16 @@ type OracleSettings struct { // encryption (TDE) of the columns and tablespaces in an Oracle source database // that is encrypted using TDE. The key value is the value of the // SecurityDbEncryption setting. For more information on setting the key name value - // of SecurityDbEncryptionName, see the information and example for setting the + // of SecurityDbEncryptionName , see the information and example for setting the // securityDbEncryptionName extra connection attribute in Supported encryption - // methods for using Oracle as a source for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) + // methods for using Oracle as a source for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) // in the Database Migration Service User Guide. SecurityDbEncryptionName *string // Fully qualified domain name of the endpoint. For an Amazon RDS Oracle instance, - // this is the output of DescribeDBInstances - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), - // in the Endpoint - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address - // field. + // this is the output of DescribeDBInstances (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) + // , in the Endpoint (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) + // .Address field. ServerName *string // Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS @@ -1637,7 +1605,7 @@ type OracleSettings struct { StandbyDelayTime *int32 // Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR - // data types during migration. The default value is true. + // data types during migration. The default value is true . TrimSpaceInChar *bool // Set this attribute to true in order to use the Binary Reader to capture change @@ -1646,11 +1614,11 @@ type OracleSettings struct { UseAlternateFolderForOnline *bool // Set this attribute to Y to capture change data using the Binary Reader utility. - // Set UseLogminerReader to N to set this attribute to Y. To use Binary Reader with - // Amazon RDS for Oracle as the source, you set additional attributes. For more - // information about using this setting with Oracle Automatic Storage Management - // (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC). + // Set UseLogminerReader to N to set this attribute to Y. To use Binary Reader + // with Amazon RDS for Oracle as the source, you set additional attributes. For + // more information about using this setting with Oracle Automatic Storage + // Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) + // . UseBFile *bool // Set this attribute to Y to have DMS use a direct path full load. Specify this @@ -1659,12 +1627,11 @@ type OracleSettings struct { // load. UseDirectPathFullLoad *bool - // Set this attribute to Y to capture change data using the Oracle LogMiner utility - // (the default). Set this attribute to N if you want to access the redo logs as a - // binary file. When you set UseLogminerReader to N, also set UseBfile to Y. For - // more information on this setting and using Oracle ASM, see Using Oracle - // LogMiner or DMS Binary Reader for CDC - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) + // Set this attribute to Y to capture change data using the Oracle LogMiner + // utility (the default). Set this attribute to N if you want to access the redo + // logs as a binary file. When you set UseLogminerReader to N, also set UseBfile + // to Y. For more information on this setting and using Oracle ASM, see Using + // Oracle LogMiner or DMS Binary Reader for CDC (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) // in the DMS User Guide. UseLogminerReader *bool @@ -1714,10 +1681,10 @@ type OrderableReplicationInstance struct { // The compute and memory capacity of the replication instance as defined for the // specified replication instance class. For example to specify the instance class - // dms.c4.large, set this parameter to "dms.c4.large". For more information on the + // dms.c4.large, set this parameter to "dms.c4.large" . For more information on the // settings and capacities for the available replication instance classes, see - // Selecting the right DMS replication instance for your migration - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). + // Selecting the right DMS replication instance for your migration (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) + // . ReplicationInstanceClass *string // The type of storage used by the replication instance. @@ -1744,8 +1711,8 @@ type PendingMaintenanceAction struct { // resource. This date takes into account opt-in requests received from the // ApplyPendingMaintenanceAction API operation, and also the AutoAppliedAfterDate // and ForcedApplyDate parameter values. This value is blank if an opt-in request - // has not been received and nothing has been specified for AutoAppliedAfterDate or - // ForcedApplyDate. + // has not been received and nothing has been specified for AutoAppliedAfterDate + // or ForcedApplyDate . CurrentApplyDate *time.Time // A description providing more detail about the maintenance action. @@ -1773,30 +1740,30 @@ type PostgreSQLSettings struct { // To capture DDL events, DMS creates various artifacts in the PostgreSQL database // when the task starts. You can later remove these artifacts. If this value is set - // to N, you don't have to create tables or triggers on the source database. + // to N , you don't have to create tables or triggers on the source database. CaptureDdls *bool // Database name for the endpoint. DatabaseName *string - // The schema in which the operational DDL database artifacts are created. Example: - // ddlArtifactsSchema=xyzddlschema; + // The schema in which the operational DDL database artifacts are created. + // Example: ddlArtifactsSchema=xyzddlschema; DdlArtifactsSchema *string // Sets the client statement timeout for the PostgreSQL instance, in seconds. The // default value is 60 seconds. Example: executeTimeout=100; ExecuteTimeout *int32 - // When set to true, this value causes a task to fail if the actual size of a LOB - // column is greater than the specified LobMaxSize. If task is set to Limited LOB + // When set to true , this value causes a task to fail if the actual size of a LOB + // column is greater than the specified LobMaxSize . If task is set to Limited LOB // mode and this option is set to true, the task fails instead of truncating the // LOB data. FailTasksOnLobTruncation *bool - // The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing - // this, it prevents idle logical replication slots from holding onto old WAL logs, - // which can result in storage full situations on the source. This heartbeat keeps - // restart_lsn moving and prevents storage full scenarios. + // The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By + // doing this, it prevents idle logical replication slots from holding onto old WAL + // logs, which can result in storage full situations on the source. This heartbeat + // keeps restart_lsn moving and prevents storage full scenarios. HeartbeatEnable *bool // Sets the WAL heartbeat frequency (in minutes). @@ -1806,7 +1773,7 @@ type PostgreSQLSettings struct { HeartbeatSchema *string // When true, lets PostgreSQL migrate the boolean type as boolean. By default, - // PostgreSQL migrates booleans as varchar(5). + // PostgreSQL migrates booleans as varchar(5) . MapBooleanAsBoolean *bool // Specifies the maximum size (in KB) of any .csv file used to transfer data to @@ -1824,16 +1791,15 @@ type PostgreSQLSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the PostgreSQL endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -1842,36 +1808,31 @@ type PostgreSQLSettings struct { SecretsManagerSecretId *string // The host name of the endpoint database. For an Amazon RDS PostgreSQL instance, - // this is the output of DescribeDBInstances - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), - // in the Endpoint - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html).Address - // field. For an Aurora PostgreSQL instance, this is the output of - // DescribeDBClusters - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), - // in the Endpoint field. + // this is the output of DescribeDBInstances (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) + // , in the Endpoint (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) + // .Address field. For an Aurora PostgreSQL instance, this is the output of + // DescribeDBClusters (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html) + // , in the Endpoint field. ServerName *string - // Sets the name of a previously created logical replication slot for a change data - // capture (CDC) load of the PostgreSQL source instance. When used with the + // Sets the name of a previously created logical replication slot for a change + // data capture (CDC) load of the PostgreSQL source instance. When used with the // CdcStartPosition request parameter for the DMS API , this attribute also makes // it possible to use native CDC start points. DMS verifies that the specified // logical replication slot exists before starting the CDC load task. It also - // verifies that the task was created with a valid setting of CdcStartPosition. If + // verifies that the task was created with a valid setting of CdcStartPosition . If // the specified slot doesn't exist or the task doesn't have a valid // CdcStartPosition setting, DMS raises an error. For more information about // setting the CdcStartPosition request parameter, see Determining a CDC native // start point in the Database Migration Service User Guide. For more information - // about using CdcStartPosition, see CreateReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html), - // StartReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html), - // and ModifyReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html). + // about using CdcStartPosition , see CreateReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) + // , StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) + // , and ModifyReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) + // . SlotName *string // Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR - // data types during migration. The default value is true. + // data types during migration. The default value is true . TrimSpaceInChar *bool // Endpoint connection user name. @@ -1886,7 +1847,7 @@ type RdsConfiguration struct { // Describes the deployment option for the recommended Amazon RDS DB instance. The // deployment options include Multi-AZ and Single-AZ deployments. Valid values - // include "MULTI_AZ" and "SINGLE_AZ". + // include "MULTI_AZ" and "SINGLE_AZ" . DeploymentOption *string // Describes the recommended target Amazon RDS engine edition. @@ -1985,9 +1946,9 @@ type Recommendation struct { // recommendation. DatabaseId *string - // The name of the target engine. Valid values include "rds-aurora-mysql", - // "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and - // "rds-postgresql". + // The name of the target engine. Valid values include "rds-aurora-mysql" , + // "rds-aurora-postgresql" , "rds-mysql" , "rds-oracle" , "rds-sql-server" , and + // "rds-postgresql" . EngineName *string // Indicates that this target is the rightsized migration destination. @@ -1998,8 +1959,8 @@ type Recommendation struct { // (production, development, or testing). Settings *RecommendationSettings - // The status of the target engine recommendation. Valid values include - // "alternate", "in-progress", "not-viable", and "recommended". + // The status of the target engine recommendation. Valid values include "alternate" + // , "in-progress" , "not-viable" , and "recommended" . Status *string noSmithyDocumentSerde @@ -2019,7 +1980,7 @@ type RecommendationSettings struct { // The size of your target instance. Fleet Advisor calculates this value based on // your data collection type, such as total capacity and resource utilization. - // Valid values include "total-capacity" and "utilization". + // Valid values include "total-capacity" and "utilization" . // // This member is required. InstanceSizingType *string @@ -2027,7 +1988,7 @@ type RecommendationSettings struct { // The deployment option for your target engine. For production databases, Fleet // Advisor chooses Multi-AZ deployment. For development or test databases, Fleet // Advisor chooses Single-AZ deployment. Valid values include "development" and - // "production". + // "production" . // // This member is required. WorkloadType *string @@ -2052,10 +2013,10 @@ type RedisSettings struct { // setting for a Redis target endpoint. AuthPassword *string - // The type of authentication to perform when connecting to a Redis target. Options - // include none, auth-token, and auth-role. The auth-token option requires an - // AuthPassword value to be provided. The auth-role option requires AuthUserName - // and AuthPassword values to be provided. + // The type of authentication to perform when connecting to a Redis target. + // Options include none , auth-token , and auth-role . The auth-token option + // requires an AuthPassword value to be provided. The auth-role option requires + // AuthUserName and AuthPassword values to be provided. AuthType RedisAuthTypeValue // The user name provided with the auth-role option of the AuthType setting for a @@ -2067,8 +2028,8 @@ type RedisSettings struct { SslCaCertificateArn *string // The connection to a Redis target endpoint using Transport Layer Security (TLS). - // Valid values include plaintext and ssl-encryption. The default is - // ssl-encryption. The ssl-encryption option makes an encrypted connection. + // Valid values include plaintext and ssl-encryption . The default is + // ssl-encryption . The ssl-encryption option makes an encrypted connection. // Optionally, you can identify an Amazon Resource Name (ARN) for an SSL // certificate authority (CA) using the SslCaCertificateArn setting. If an ARN // isn't given for a CA, DMS uses the Amazon root CA. The plaintext option doesn't @@ -2090,34 +2051,34 @@ type RedshiftSettings struct { // inserts a NULL value into that field. AcceptAnyDate *bool - // Code to run after connecting. This parameter should contain the code itself, not - // the name of a file containing the code. + // Code to run after connecting. This parameter should contain the code itself, + // not the name of a file containing the code. AfterConnectScript *string // An S3 folder where the comma-separated-value (.csv) files are stored before // being uploaded to the target Redshift cluster. For full load mode, DMS converts // source records into .csv files and loads them to the BucketFolder/TableID path. - // DMS uses the Redshift COPY command to upload the .csv files to the target table. - // The files are deleted once the COPY operation has finished. For more - // information, see COPY - // (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the Amazon - // Redshift Database Developer Guide. For change-data-capture (CDC) mode, DMS - // creates a NetChanges table, and loads the .csv files to this + // DMS uses the Redshift COPY command to upload the .csv files to the target + // table. The files are deleted once the COPY operation has finished. For more + // information, see COPY (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) + // in the Amazon Redshift Database Developer Guide. For change-data-capture (CDC) + // mode, DMS creates a NetChanges table, and loads the .csv files to this // BucketFolder/NetChangesTableID path. BucketFolder *string - // The name of the intermediate S3 bucket used to store .csv files before uploading - // data to Redshift. + // The name of the intermediate S3 bucket used to store .csv files before + // uploading data to Redshift. BucketName *string // If Amazon Redshift is configured to support case sensitive schema names, set - // CaseSensitiveNames to true. The default is false. + // CaseSensitiveNames to true . The default is false . CaseSensitiveNames *bool // If you set CompUpdate to true Amazon Redshift applies automatic compression if // the table is empty. This applies even if the table columns already have - // encodings other than RAW. If you set CompUpdate to false, automatic compression - // is disabled and existing column encodings aren't changed. The default is true. + // encodings other than RAW . If you set CompUpdate to false , automatic + // compression is disabled and existing column encodings aren't changed. The + // default is true . CompUpdate *bool // A value that sets the amount of time to wait (in milliseconds) before timing @@ -2128,25 +2089,25 @@ type RedshiftSettings struct { // with. DatabaseName *string - // The date format that you are using. Valid values are auto (case-sensitive), your - // date format string enclosed in quotes, or NULL. If this parameter is left unset - // (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most - // strings, even some that aren't supported when you use a date format string. If - // your date and time values use formats different from each other, set this to - // auto. + // The date format that you are using. Valid values are auto (case-sensitive), + // your date format string enclosed in quotes, or NULL. If this parameter is left + // unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes + // most strings, even some that aren't supported when you use a date format string. + // If your date and time values use formats different from each other, set this to + // auto . DateFormat *string // A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields - // as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default - // is false. + // as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The + // default is false . EmptyAsNull *bool // The type of server-side encryption that you want to use for your data. This // encryption type is part of the endpoint settings or the extra connections - // attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. - // For the ModifyEndpoint operation, you can change the existing value of the - // EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the - // existing value from SSE_S3 to SSE_KMS. To use SSE_S3, create an Identity and + // attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS + // . For the ModifyEndpoint operation, you can change the existing value of the + // EncryptionMode parameter from SSE_KMS to SSE_S3 . But you can’t change the + // existing value from SSE_S3 to SSE_KMS . To use SSE_S3 , create an Identity and // Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use // the following actions: "s3:PutObject", "s3:ListBucket" EncryptionMode EncryptionModeValue @@ -2154,15 +2115,15 @@ type RedshiftSettings struct { // This setting is only valid for a full-load migration task. Set ExplicitIds to // true to have tables with IDENTITY columns override their auto-generated values // with explicit values loaded from the source data files used to populate the - // tables. The default is false. + // tables. The default is false . ExplicitIds *bool // The number of threads used to upload a single file. This parameter accepts a // value from 1 through 64. It defaults to 10. The number of parallel streams used // to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more - // information, see Multipart upload overview - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). - // FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10. + // information, see Multipart upload overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) + // . FileTransferUploadStreams accepts a value from 1 through 64. It defaults to + // 10. FileTransferUploadStreams *int32 // The amount of time to wait (in milliseconds) before timing out of operations @@ -2171,7 +2132,7 @@ type RedshiftSettings struct { LoadTimeout *int32 // When true, lets Redshift migrate the boolean type as boolean. By default, - // Redshift migrates booleans as varchar(1). + // Redshift migrates booleans as varchar(1) . MapBooleanAsBoolean *bool // The maximum size (in KB) of any .csv file used to load data on an S3 bucket and @@ -2184,31 +2145,31 @@ type RedshiftSettings struct { // The port number for Amazon Redshift. The default value is 5439. Port *int32 - // A value that specifies to remove surrounding quotation marks from strings in the - // incoming data. All characters within the quotation marks, including delimiters, - // are retained. Choose true to remove quotation marks. The default is false. + // A value that specifies to remove surrounding quotation marks from strings in + // the incoming data. All characters within the quotation marks, including + // delimiters, are retained. Choose true to remove quotation marks. The default is + // false . RemoveQuotes *bool // A value that specifies to replaces the invalid characters specified in - // ReplaceInvalidChars, substituting the specified characters instead. The default - // is "?". + // ReplaceInvalidChars , substituting the specified characters instead. The default + // is "?" . ReplaceChars *string - // A list of characters that you want to replace. Use with ReplaceChars. + // A list of characters that you want to replace. Use with ReplaceChars . ReplaceInvalidChars *string // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the Amazon Redshift endpoint. You can specify one // of two sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -2219,7 +2180,7 @@ type RedshiftSettings struct { // The name of the Amazon Redshift cluster you are using. ServerName *string - // The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this + // The KMS key ID. If you are using SSE_KMS for the EncryptionMode , provide this // key ID. The key that you use needs an attached policy that enables IAM user // permissions and allows use of the key. ServerSideEncryptionKmsKeyId *string @@ -2229,21 +2190,21 @@ type RedshiftSettings struct { ServiceAccessRoleArn *string // The time format that you want to use. Valid values are auto (case-sensitive), - // 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using - // auto recognizes most strings, even some that aren't supported when you use a - // time format string. If your date and time values use formats different from each - // other, set this parameter to auto. + // 'timeformat_string' , 'epochsecs' , or 'epochmillisecs' . It defaults to 10. + // Using auto recognizes most strings, even some that aren't supported when you + // use a time format string. If your date and time values use formats different + // from each other, set this parameter to auto . TimeFormat *string // A value that specifies to remove the trailing white space characters from a // VARCHAR string. This parameter applies only to columns with a VARCHAR data type. - // Choose true to remove unneeded white space. The default is false. + // Choose true to remove unneeded white space. The default is false . TrimBlanks *bool // A value that specifies to truncate data in columns to the appropriate number of // characters, so that the data fits in the column. This parameter applies only to // columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. - // Choose true to truncate data. The default is false. + // Choose true to truncate data. The default is false . TruncateColumns *bool // An Amazon Redshift user name for a registered user. @@ -2286,8 +2247,8 @@ type ReplicationInstance struct { // instance. AllocatedStorage int32 - // Boolean value indicating if minor version upgrades will be automatically applied - // to the instance. + // Boolean value indicating if minor version upgrades will be automatically + // applied to the instance. AutoMinorVersionUpgrade bool // The Availability Zone for the instance. @@ -2300,7 +2261,7 @@ type ReplicationInstance struct { // The engine version number of the replication instance. If an engine version // number is not specified when a replication instance is created, the default is // the latest engine version available. When modifying a major engine version of an - // instance, also set AllowMajorVersionUpgrade to true. + // instance, also set AllowMajorVersionUpgrade to true . EngineVersion *string // The expiration date of the free replication instance that is part of the Free @@ -2311,14 +2272,14 @@ type ReplicationInstance struct { InstanceCreateTime *time.Time // An KMS key identifier that is used to encrypt the data on the replication - // instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses - // your default encryption key. KMS creates the default encryption key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default encryption key for each Amazon Web Services Region. + // instance. If you don't specify a value for the KmsKeyId parameter, then DMS + // uses your default encryption key. KMS creates the default encryption key for + // your Amazon Web Services account. Your Amazon Web Services account has a + // different default encryption key for each Amazon Web Services Region. KmsKeyId *string // Specifies whether the replication instance is a Multi-AZ deployment. You can't - // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true . MultiAZ bool // The type of IP address protocol used by a replication instance, such as IPv4 @@ -2335,7 +2296,7 @@ type ReplicationInstance struct { // Specifies the accessibility options for the replication instance. A value of // true represents an instance with a public IP address. A value of false - // represents an instance with a private IP address. The default value is true. + // represents an instance with a private IP address. The default value is true . PubliclyAccessible bool // The Amazon Resource Name (ARN) of the replication instance. @@ -2345,21 +2306,15 @@ type ReplicationInstance struct { // specified replication instance class. It is a required parameter, although a // default value is pre-selected in the DMS console. For more information on the // settings and capacities for the available replication instance classes, see - // Selecting the right DMS replication instance for your migration - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). + // Selecting the right DMS replication instance for your migration (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) + // . ReplicationInstanceClass *string // The replication instance identifier is a required parameter. This parameter is // stored as a lowercase string. Constraints: - // - // * Must contain 1-63 alphanumeric - // characters or hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens. - // + // - Must contain 1-63 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: myrepinstance ReplicationInstanceIdentifier *string @@ -2383,36 +2338,19 @@ type ReplicationInstance struct { ReplicationInstancePublicIpAddresses []string // The status of the replication instance. The possible return values include: - // - // * - // "available" - // - // * "creating" - // - // * "deleted" - // - // * "deleting" - // - // * "failed" - // - // * - // "modifying" - // - // * "upgrading" - // - // * "rebooting" - // - // * "resetting-master-credentials" - // - // * - // "storage-full" - // - // * "incompatible-credentials" - // - // * "incompatible-network" - // - // * - // "maintenance" + // - "available" + // - "creating" + // - "deleted" + // - "deleting" + // - "failed" + // - "modifying" + // - "upgrading" + // - "rebooting" + // - "resetting-master-credentials" + // - "storage-full" + // - "incompatible-credentials" + // - "incompatible-network" + // - "maintenance" ReplicationInstanceStatus *string // The subnet group for the replication instance. @@ -2444,8 +2382,7 @@ type ReplicationInstanceTaskLog struct { } // Provides information about the values of pending modifications to a replication -// instance. This data type is an object of the ReplicationInstance -// (https://docs.aws.amazon.com/dms/latest/APIReference/API_ReplicationInstance.html) +// instance. This data type is an object of the ReplicationInstance (https://docs.aws.amazon.com/dms/latest/APIReference/API_ReplicationInstance.html) // user-defined data type. type ReplicationPendingModifiedValues struct { @@ -2457,7 +2394,7 @@ type ReplicationPendingModifiedValues struct { EngineVersion *string // Specifies whether the replication instance is a Multi-AZ deployment. You can't - // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true. + // set the AvailabilityZone parameter if the Multi-AZ parameter is set to true . MultiAZ *bool // The type of IP address protocol used by a replication instance, such as IPv4 @@ -2467,9 +2404,9 @@ type ReplicationPendingModifiedValues struct { // The compute and memory capacity of the replication instance as defined for the // specified replication instance class. For more information on the settings and - // capacities for the available replication instance classes, see Selecting the - // right DMS replication instance for your migration - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). + // capacities for the available replication instance classes, see Selecting the + // right DMS replication instance for your migration (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) + // . ReplicationInstanceClass *string noSmithyDocumentSerde @@ -2515,8 +2452,8 @@ type ReplicationTask struct { // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” CdcStartPosition *string - // Indicates when you want a change data capture (CDC) operation to stop. The value - // can be either server time or commit time. Server time example: + // Indicates when you want a change data capture (CDC) operation to stop. The + // value can be either server time or commit time. Server time example: // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: // --cdc-stop-position “commit_time: 2018-02-09T12:12:12“ CdcStopPosition *string @@ -2528,8 +2465,8 @@ type ReplicationTask struct { MigrationType MigrationTypeValue // Indicates the last checkpoint that occurred during a change data capture (CDC) - // operation. You can provide this value to the CdcStartPosition parameter to start - // a CDC operation that begins at that checkpoint. + // operation. You can provide this value to the CdcStartPosition parameter to + // start a CDC operation that begins at that checkpoint. RecoveryCheckpoint *string // The ARN of the replication instance. @@ -2542,14 +2479,9 @@ type ReplicationTask struct { ReplicationTaskCreationDate *time.Time // The user-assigned replication task identifier or name. Constraints: - // - // * Must - // contain 1-255 alphanumeric characters or hyphens. - // - // * First character must be a - // letter. - // - // * Cannot end with a hyphen or contain two consecutive hyphens. + // - Must contain 1-255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. ReplicationTaskIdentifier *string // The settings for the replication task. @@ -2567,125 +2499,76 @@ type ReplicationTask struct { // The status of the replication task. This response parameter can return one of // the following values: - // - // * "moving" – The task is being moved in response to - // running the MoveReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) - // operation. - // - // * "creating" – The task is being created in response to running the - // CreateReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) - // operation. - // - // * "deleting" – The task is being deleted in response to running the - // DeleteReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html) - // operation. - // - // * "failed" – The task failed to successfully complete the database - // migration in response to running the StartReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) - // operation. - // - // * "failed-move" – The task failed to move in response to running the - // MoveReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) - // operation. - // - // * "modifying" – The task definition is being modified in response to - // running the ModifyReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) - // operation. - // - // * "ready" – The task is in a ready state where it can respond to - // other task operations, such as StartReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) - // or DeleteReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html). - // - // * - // "running" – The task is performing a database migration in response to running - // the StartReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) - // operation. - // - // * "starting" – The task is preparing to perform a database migration - // in response to running the StartReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) - // operation. - // - // * "stopped" – The task has stopped in response to running the - // StopReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) - // operation. - // - // * "stopping" – The task is preparing to stop in response to running - // the StopReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) - // operation. - // - // * "testing" – The database migration specified for this task is - // being tested in response to running either the StartReplicationTaskAssessmentRun - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) - // or the StartReplicationTaskAssessment - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) - // operation. StartReplicationTaskAssessmentRun - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) - // is an improved premigration task assessment operation. The - // StartReplicationTaskAssessment - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) - // operation assesses data type compatibility only between the source and target - // database of a given migration task. In contrast, - // StartReplicationTaskAssessmentRun - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) - // enables you to specify a variety of premigration task assessments in addition to - // data type compatibility. These assessments include ones for the validity of - // primary key definitions and likely issues with database migration performance, - // among others. + // - "moving" – The task is being moved in response to running the + // MoveReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) + // operation. + // - "creating" – The task is being created in response to running the + // CreateReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html) + // operation. + // - "deleting" – The task is being deleted in response to running the + // DeleteReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html) + // operation. + // - "failed" – The task failed to successfully complete the database migration + // in response to running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) + // operation. + // - "failed-move" – The task failed to move in response to running the + // MoveReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) + // operation. + // - "modifying" – The task definition is being modified in response to running + // the ModifyReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html) + // operation. + // - "ready" – The task is in a ready state where it can respond to other task + // operations, such as StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) + // or DeleteReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html) + // . + // - "running" – The task is performing a database migration in response to + // running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) + // operation. + // - "starting" – The task is preparing to perform a database migration in + // response to running the StartReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html) + // operation. + // - "stopped" – The task has stopped in response to running the + // StopReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) + // operation. + // - "stopping" – The task is preparing to stop in response to running the + // StopReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html) + // operation. + // - "testing" – The database migration specified for this task is being tested + // in response to running either the StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) + // or the StartReplicationTaskAssessment (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) + // operation. StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) + // is an improved premigration task assessment operation. The + // StartReplicationTaskAssessment (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html) + // operation assesses data type compatibility only between the source and target + // database of a given migration task. In contrast, + // StartReplicationTaskAssessmentRun (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html) + // enables you to specify a variety of premigration task assessments in addition to + // data type compatibility. These assessments include ones for the validity of + // primary key definitions and likely issues with database migration performance, + // among others. Status *string // The reason the replication task was stopped. This response parameter can return // one of the following values: - // - // * "Stop Reason NORMAL" - // - // * "Stop Reason - // RECOVERABLE_ERROR" - // - // * "Stop Reason FATAL_ERROR" - // - // * "Stop Reason - // FULL_LOAD_ONLY_FINISHED" - // - // * "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load - // completed, with cached changes not applied - // - // * "Stop Reason - // STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes - // applied - // - // * "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED" - // - // * "Stop Reason - // STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied - // - // * "Stop - // Reason STOPPED_DUE_TO_LOW_MEMORY" - // - // * "Stop Reason STOPPED_DUE_TO_LOW_DISK" - // - // * - // "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping - // task - // - // * "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for - // stopping task - // - // * "Stop Reason RECONFIGURATION_RESTART" - // - // * "Stop Reason - // RECYCLE_TASK" + // - "Stop Reason NORMAL" + // - "Stop Reason RECOVERABLE_ERROR" + // - "Stop Reason FATAL_ERROR" + // - "Stop Reason FULL_LOAD_ONLY_FINISHED" + // - "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached + // changes not applied + // - "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached + // changes applied + // - "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED" + // - "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL + // applied + // - "Stop Reason STOPPED_DUE_TO_LOW_MEMORY" + // - "Stop Reason STOPPED_DUE_TO_LOW_DISK" + // - "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping + // task + // - "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping + // task + // - "Stop Reason RECONFIGURATION_RESTART" + // - "Stop Reason RECYCLE_TASK" StopReason *string // Table mappings specified in the task. @@ -2695,17 +2578,15 @@ type ReplicationTask struct { TargetEndpointArn *string // The ARN of the replication instance to which this task is moved in response to - // running the MoveReplicationTask - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) + // running the MoveReplicationTask (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html) // operation. Otherwise, this response parameter isn't a member of the // ReplicationTask object. TargetReplicationInstanceArn *string // Supplemental information that the task requires to migrate the data for certain // source and target endpoints. For more information, see Specifying Supplemental - // Data for Task Settings - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in - // the Database Migration Service User Guide. + // Data for Task Settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) + // in the Database Migration Service User Guide. TaskData *string noSmithyDocumentSerde @@ -2790,39 +2671,24 @@ type ReplicationTaskAssessmentRun struct { ServiceAccessRoleArn *string // Assessment run status. This status can have one of the following values: - // - // * - // "cancelling" – The assessment run was canceled by the - // CancelReplicationTaskAssessmentRun operation. - // - // * "deleting" – The assessment run - // was deleted by the DeleteReplicationTaskAssessmentRun operation. - // - // * "failed" – - // At least one individual assessment completed with a failed status. - // - // * - // "error-provisioning" – An internal error occurred while resources were - // provisioned (during provisioning status). - // - // * "error-executing" – An internal - // error occurred while individual assessments ran (during running status). - // - // * - // "invalid state" – The assessment run is in an unknown state. - // - // * "passed" – All - // individual assessments have completed, and none has a failed status. - // - // * - // "provisioning" – Resources required to run individual assessments are being - // provisioned. - // - // * "running" – Individual assessments are being run. - // - // * "starting" - // – The assessment run is starting, but resources are not yet being provisioned - // for individual assessments. + // - "cancelling" – The assessment run was canceled by the + // CancelReplicationTaskAssessmentRun operation. + // - "deleting" – The assessment run was deleted by the + // DeleteReplicationTaskAssessmentRun operation. + // - "failed" – At least one individual assessment completed with a failed + // status. + // - "error-provisioning" – An internal error occurred while resources were + // provisioned (during provisioning status). + // - "error-executing" – An internal error occurred while individual assessments + // ran (during running status). + // - "invalid state" – The assessment run is in an unknown state. + // - "passed" – All individual assessments have completed, and none has a failed + // status. + // - "provisioning" – Resources required to run individual assessments are being + // provisioned. + // - "running" – Individual assessments are being run. + // - "starting" – The assessment run is starting, but resources are not yet being + // provisioned for individual assessments. Status *string noSmithyDocumentSerde @@ -2840,8 +2706,8 @@ type ReplicationTaskAssessmentRunProgress struct { noSmithyDocumentSerde } -// Provides information that describes an individual assessment from a premigration -// assessment run. +// Provides information that describes an individual assessment from a +// premigration assessment run. type ReplicationTaskIndividualAssessment struct { // Name of this individual assessment. @@ -2858,21 +2724,13 @@ type ReplicationTaskIndividualAssessment struct { // StartReplicationTaskAssessmentRun operation. ReplicationTaskIndividualAssessmentStartDate *time.Time - // Individual assessment status. This status can have one of the following - // values: - // - // * "cancelled" - // - // * "error" - // - // * "failed" - // - // * "passed" - // - // * "pending" - // - // * - // "running" + // Individual assessment status. This status can have one of the following values: + // - "cancelled" + // - "error" + // - "failed" + // - "passed" + // - "pending" + // - "running" Status *string noSmithyDocumentSerde @@ -2898,9 +2756,9 @@ type ReplicationTaskStats struct { // The date the replication task full load was started. FullLoadStartDate *time.Time - // The date the replication task was started either with a fresh start or a resume. - // For more information, see StartReplicationTaskType - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html#DMS-StartReplicationTask-request-StartReplicationTaskType). + // The date the replication task was started either with a fresh start or a + // resume. For more information, see StartReplicationTaskType (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html#DMS-StartReplicationTask-request-StartReplicationTaskType) + // . StartDate *time.Time // The date the replication task was stopped. @@ -2928,9 +2786,8 @@ type ResourcePendingMaintenanceActions struct { PendingMaintenanceActionDetails []PendingMaintenanceAction // The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance - // action applies to. For information about creating an ARN, see Constructing an - // Amazon Resource Name (ARN) for DMS - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Introduction.AWS.ARN.html) + // action applies to. For information about creating an ARN, see Constructing an + // Amazon Resource Name (ARN) for DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Introduction.AWS.ARN.html) // in the DMS documentation. ResourceIdentifier *string @@ -2940,18 +2797,18 @@ type ResourcePendingMaintenanceActions struct { // Settings for exporting data to Amazon S3. type S3Settings struct { - // An optional parameter that, when set to true or y, you can use to add column - // name information to the .csv output file. The default value is false. Valid - // values are true, false, y, and n. + // An optional parameter that, when set to true or y , you can use to add column + // name information to the .csv output file. The default value is false . Valid + // values are true , false , y , and n . AddColumnName *bool - // Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on - // string data. The default value is false. + // Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding + // on string data. The default value is false . AddTrailingPaddingCharacter *bool - // An optional parameter to set a folder name in the S3 bucket. If provided, tables - // are created in the path bucketFolder/schema_name/table_name/. If this parameter - // isn't specified, then the path used is schema_name/table_name/. + // An optional parameter to set a folder name in the S3 bucket. If provided, + // tables are created in the path bucketFolder/schema_name/table_name/ . If this + // parameter isn't specified, then the path used is schema_name/table_name/ . BucketFolder *string // The name of the S3 bucket. @@ -2959,31 +2816,29 @@ type S3Settings struct { // A value that enables DMS to specify a predefined (canned) access control list // for objects created in an Amazon S3 bucket as .csv or .parquet files. For more - // information about Amazon S3 canned ACLs, see Canned ACL - // (http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in - // the Amazon S3 Developer Guide. The default value is NONE. Valid values include - // NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, + // information about Amazon S3 canned ACLs, see Canned ACL (http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) + // in the Amazon S3 Developer Guide. The default value is NONE. Valid values + // include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, // AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL. CannedAclForObjects CannedAclForObjectsValue - // A value that enables a change data capture (CDC) load to write INSERT and UPDATE - // operations to .csv or .parquet (columnar storage) output files. The default - // setting is false, but when CdcInsertsAndUpdates is set to true or y, only - // INSERTs and UPDATEs from the source database are migrated to the .csv or + // A value that enables a change data capture (CDC) load to write INSERT and + // UPDATE operations to .csv or .parquet (columnar storage) output files. The + // default setting is false , but when CdcInsertsAndUpdates is set to true or y , + // only INSERTs and UPDATEs from the source database are migrated to the .csv or // .parquet file. For .csv file format only, how these INSERTs and UPDATEs are // recorded depends on the value of the IncludeOpForFullLoad parameter. If - // IncludeOpForFullLoad is set to true, the first field of every CDC record is set + // IncludeOpForFullLoad is set to true , the first field of every CDC record is set // to either I or U to indicate INSERT and UPDATE operations at the source. But if - // IncludeOpForFullLoad is set to false, CDC records are written without an + // IncludeOpForFullLoad is set to false , CDC records are written without an // indication of INSERT or UPDATE operations at the source. For more information // about how these settings work together, see Indicating Source DB Operations in - // Migrated S3 Data - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) + // Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) // in the Database Migration Service User Guide.. DMS supports the use of the // CdcInsertsAndUpdates parameter in versions 3.3.1 and later. CdcInsertsOnly and - // CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either - // CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not - // both. + // CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set + // either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, + // but not both. CdcInsertsAndUpdates *bool // A value that enables a change data capture (CDC) load to write only INSERT @@ -2991,15 +2846,14 @@ type S3Settings struct { // false setting), the first field in a .csv or .parquet record contains the letter // I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was // inserted, updated, or deleted at the source database for a CDC load to the - // target. If CdcInsertsOnly is set to true or y, only INSERTs from the source + // target. If CdcInsertsOnly is set to true or y , only INSERTs from the source // database are migrated to the .csv or .parquet file. For .csv format only, how - // these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If - // IncludeOpForFullLoad is set to true, the first field of every CDC record is set + // these INSERTs are recorded depends on the value of IncludeOpForFullLoad . If + // IncludeOpForFullLoad is set to true , the first field of every CDC record is set // to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is - // set to false, every CDC record is written without a first field to indicate the + // set to false , every CDC record is written without a first field to indicate the // INSERT operation at the source. For more information about how these settings - // work together, see Indicating Source DB Operations in Migrated S3 Data - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) + // work together, see Indicating Source DB Operations in Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) // in the Database Migration Service User Guide.. DMS supports the interaction // described preceding between the CdcInsertsOnly and IncludeOpForFullLoad // parameters in versions 3.1.4 and later. CdcInsertsOnly and CdcInsertsAndUpdates @@ -3007,10 +2861,10 @@ type S3Settings struct { // CdcInsertsAndUpdates to true for the same endpoint, but not both. CdcInsertsOnly *bool - // Maximum length of the interval, defined in seconds, after which to output a file - // to Amazon S3. When CdcMaxBatchInterval and CdcMinFileSize are both specified, - // the file write is triggered by whichever parameter condition is met first within - // an DMS CloudFormation template. The default value is 60 seconds. + // Maximum length of the interval, defined in seconds, after which to output a + // file to Amazon S3. When CdcMaxBatchInterval and CdcMinFileSize are both + // specified, the file write is triggered by whichever parameter condition is met + // first within an DMS CloudFormation template. The default value is 60 seconds. CdcMaxBatchInterval *int32 // Minimum file size, defined in kilobytes, to reach for a file output to Amazon @@ -3020,27 +2874,23 @@ type S3Settings struct { CdcMinFileSize *int32 // Specifies the folder path of CDC files. For an S3 source, this setting is - // required if a task captures change data; otherwise, it's optional. If CdcPath is - // set, DMS reads CDC files from this path and replicates the data changes to the - // target endpoint. For an S3 target if you set PreserveTransactions - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) - // to true, DMS verifies that you have set this parameter to a folder path on your + // required if a task captures change data; otherwise, it's optional. If CdcPath + // is set, DMS reads CDC files from this path and replicates the data changes to + // the target endpoint. For an S3 target if you set PreserveTransactions (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) + // to true , DMS verifies that you have set this parameter to a folder path on your // S3 target where DMS can save the transaction order for the CDC load. DMS creates // this CDC folder path in either your S3 target working directory or the S3 target - // location specified by BucketFolder - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) - // and BucketName - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName). - // For example, if you specify CdcPath as MyChangedData, and you specify BucketName - // as MyTargetBucket but do not specify BucketFolder, DMS creates the CDC folder - // path following: MyTargetBucket/MyChangedData. If you specify the same CdcPath, - // and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, - // DMS creates the CDC folder path following: - // MyTargetBucket/MyTargetData/MyChangedData. For more information on CDC including - // transaction order on an S3 target, see Capturing data changes (CDC) including - // transaction order on the S3 target - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). - // This setting is supported in DMS versions 3.4.2 and later. + // location specified by BucketFolder (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) + // and BucketName (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName) + // . For example, if you specify CdcPath as MyChangedData , and you specify + // BucketName as MyTargetBucket but do not specify BucketFolder , DMS creates the + // CDC folder path following: MyTargetBucket/MyChangedData . If you specify the + // same CdcPath , and you specify BucketName as MyTargetBucket and BucketFolder as + // MyTargetData , DMS creates the CDC folder path following: + // MyTargetBucket/MyTargetData/MyChangedData . For more information on CDC + // including transaction order on an S3 target, see Capturing data changes (CDC) + // including transaction order on the S3 target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) + // . This setting is supported in DMS versions 3.4.2 and later. CdcPath *string // An optional parameter to use GZIP to compress the target files. Set to GZIP to @@ -3054,8 +2904,7 @@ type S3Settings struct { CsvDelimiter *string // This setting only applies if your Amazon S3 output files during a change data - // capture (CDC) load are written in .csv format. If UseCsvNoSupValue - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) + // capture (CDC) load are written in .csv format. If UseCsvNoSupValue (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) // is set to true, specify a string value that you want DMS to use for all columns // not included in the supplemental log. If you do not specify a string value, DMS // uses the null value for these columns regardless of the UseCsvNoSupValue @@ -3067,114 +2916,91 @@ type S3Settings struct { // when writing to the target. For example, when target columns are not nullable, // you can use this option to differentiate between the empty string value and the // null value. So, if you set this parameter value to the empty string ("" or ''), - // DMS treats the empty string as the null value instead of NULL. The default value - // is NULL. Valid values include any valid string. + // DMS treats the empty string as the null value instead of NULL . The default + // value is NULL . Valid values include any valid string. CsvNullValue *string - // The delimiter used to separate rows in the .csv file for both source and target. - // The default is a carriage return (\n). + // The delimiter used to separate rows in the .csv file for both source and + // target. The default is a carriage return ( \n ). CsvRowDelimiter *string // The format of the data that you want to use for output. You can choose one of // the following: - // - // * csv : This is a row-based file format with comma-separated - // values (.csv). - // - // * parquet : Apache Parquet (.parquet) is a columnar storage file - // format that features efficient compression and provides faster query response. + // - csv : This is a row-based file format with comma-separated values (.csv). + // - parquet : Apache Parquet (.parquet) is a columnar storage file format that + // features efficient compression and provides faster query response. DataFormat DataFormatValue - // The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes - // (1 MiB). This number is used for .parquet file format only. + // The size of one data page in bytes. This parameter defaults to 1024 * 1024 + // bytes (1 MiB). This number is used for .parquet file format only. DataPageSize *int32 // Specifies a date separating delimiter to use during folder partitioning. The - // default value is SLASH. Use this parameter when DatePartitionedEnabled is set to - // true. + // default value is SLASH . Use this parameter when DatePartitionedEnabled is set + // to true . DatePartitionDelimiter DatePartitionDelimiterValue - // When set to true, this parameter partitions S3 bucket folders based on - // transaction commit dates. The default value is false. For more information about - // date-based folder partitioning, see Using date-based folder partitioning - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning). + // When set to true , this parameter partitions S3 bucket folders based on + // transaction commit dates. The default value is false . For more information + // about date-based folder partitioning, see Using date-based folder partitioning (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning) + // . DatePartitionEnabled *bool // Identifies the sequence of the date format to use during folder partitioning. - // The default value is YYYYMMDD. Use this parameter when DatePartitionedEnabled is - // set to true. + // The default value is YYYYMMDD . Use this parameter when DatePartitionedEnabled + // is set to true . DatePartitionSequence DatePartitionSequenceValue // When creating an S3 target endpoint, set DatePartitionTimezone to convert the // current UTC time into a specified time zone. The conversion occurs when a date // partition folder is created and a CDC filename is generated. The time zone // format is Area/Location. Use this parameter when DatePartitionedEnabled is set - // to true, as shown in the following example. + // to true , as shown in the following example. // s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": // "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", // "DatePartitionTimezone":"Asia/Seoul", "BucketName": "dms-nattarat-test"}' DatePartitionTimezone *string // The maximum size of an encoded dictionary page of a column. If the dictionary - // page exceeds this, this column is stored using an encoding type of PLAIN. This + // page exceeds this, this column is stored using an encoding type of PLAIN . This // parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a // dictionary page before it reverts to PLAIN encoding. This size is used for // .parquet file format only. DictPageSizeLimit *int32 - // A value that enables statistics for Parquet pages and row groups. Choose true to - // enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and - // MIN values. This parameter defaults to true. This value is used for .parquet - // file format only. + // A value that enables statistics for Parquet pages and row groups. Choose true + // to enable statistics, false to disable. Statistics include NULL , DISTINCT , MAX + // , and MIN values. This parameter defaults to true . This value is used for + // .parquet file format only. EnableStatistics *bool // The type of encoding you are using: - // - // * RLE_DICTIONARY uses a combination of - // bit-packing and run-length encoding to store repeated values more efficiently. - // This is the default. - // - // * PLAIN doesn't use encoding at all. Values are stored as - // they are. - // - // * PLAIN_DICTIONARY builds a dictionary of the values encountered in a - // given column. The dictionary is stored in a dictionary page for each column - // chunk. + // - RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to + // store repeated values more efficiently. This is the default. + // - PLAIN doesn't use encoding at all. Values are stored as they are. + // - PLAIN_DICTIONARY builds a dictionary of the values encountered in a given + // column. The dictionary is stored in a dictionary page for each column chunk. EncodingType EncodingTypeValue // The type of server-side encryption that you want to use for your data. This // encryption type is part of the endpoint settings or the extra connections - // attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. - // For the ModifyEndpoint operation, you can change the existing value of the - // EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the - // existing value from SSE_S3 to SSE_KMS. To use SSE_S3, you need an Identity and + // attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS + // . For the ModifyEndpoint operation, you can change the existing value of the + // EncryptionMode parameter from SSE_KMS to SSE_S3 . But you can’t change the + // existing value from SSE_S3 to SSE_KMS . To use SSE_S3 , you need an Identity and // Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to // use the following actions: - // - // * s3:CreateBucket - // - // * s3:ListBucket - // - // * - // s3:DeleteBucket - // - // * s3:GetBucketLocation - // - // * s3:GetObject - // - // * s3:PutObject - // - // * - // s3:DeleteObject - // - // * s3:GetObjectVersion - // - // * s3:GetBucketPolicy - // - // * - // s3:PutBucketPolicy - // - // * s3:DeleteBucketPolicy + // - s3:CreateBucket + // - s3:ListBucket + // - s3:DeleteBucket + // - s3:GetBucketLocation + // - s3:GetObject + // - s3:PutObject + // - s3:DeleteObject + // - s3:GetObjectVersion + // - s3:GetBucketPolicy + // - s3:PutBucketPolicy + // - s3:DeleteBucketPolicy EncryptionMode EncryptionModeValue // To specify a bucket owner and prevent sniping, you can use the @@ -3198,18 +3024,17 @@ type S3Settings struct { // A value that enables a full load to write INSERT operations to the // comma-separated value (.csv) output files only to indicate how the rows were - // added to the source database. DMS supports the IncludeOpForFullLoad parameter in - // versions 3.1.4 and later. For full load, records can only be inserted. By + // added to the source database. DMS supports the IncludeOpForFullLoad parameter + // in versions 3.1.4 and later. For full load, records can only be inserted. By // default (the false setting), no information is recorded in these output files // for a full load to indicate that the rows were inserted at the source database. - // If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I + // If IncludeOpForFullLoad is set to true or y , the INSERT is recorded as an I // annotation in the first field of the .csv file. This allows the format of your // target records from a full load to be consistent with the target records from a // CDC load. This setting works together with the CdcInsertsOnly and the // CdcInsertsAndUpdates parameters for output to .csv files only. For more // information about how these settings work together, see Indicating Source DB - // Operations in Migrated S3 Data - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) + // Operations in Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) // in the Database Migration Service User Guide.. IncludeOpForFullLoad *bool @@ -3221,7 +3046,7 @@ type S3Settings struct { // A value that specifies the precision of any TIMESTAMP column values that are // written to an Amazon S3 object file in .parquet format. DMS supports the // ParquetTimestampInMillisecond parameter in versions 3.1.4 and later. When - // ParquetTimestampInMillisecond is set to true or y, DMS writes all TIMESTAMP + // ParquetTimestampInMillisecond is set to true or y , DMS writes all TIMESTAMP // columns in a .parquet formatted file with millisecond precision. Otherwise, DMS // writes them with microsecond precision. Currently, Amazon Athena and Glue can // handle only millisecond precision for TIMESTAMP values. Set this parameter to @@ -3234,21 +3059,19 @@ type S3Settings struct { ParquetTimestampInMillisecond *bool // The version of the Apache Parquet format that you want to use: parquet_1_0 (the - // default) or parquet_2_0. + // default) or parquet_2_0 . ParquetVersion ParquetVersionValue - // If set to true, DMS saves the transaction order for a change data capture (CDC) - // load on the Amazon S3 target specified by CdcPath - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath). - // For more information, see Capturing data changes (CDC) including transaction - // order on the S3 target - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). - // This setting is supported in DMS versions 3.4.2 and later. + // If set to true , DMS saves the transaction order for a change data capture (CDC) + // load on the Amazon S3 target specified by CdcPath (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath) + // . For more information, see Capturing data changes (CDC) including transaction + // order on the S3 target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath) + // . This setting is supported in DMS versions 3.4.2 and later. PreserveTransactions *bool - // For an S3 source, when this value is set to true or y, each leading double + // For an S3 source, when this value is set to true or y , each leading double // quotation mark has to be followed by an ending double quotation mark. This - // formatting complies with RFC 4180. When this value is set to false or n, string + // formatting complies with RFC 4180. When this value is set to false or n , string // literals are copied to the target as is. In this case, a delimiter (row or // column) signals the end of the field. Thus, you can't use a delimiter as part of // the string, because it signals the end of the value. For an S3 target, an @@ -3257,7 +3080,8 @@ type S3Settings struct { // true or y using Amazon S3 as a target, if the data has quotation marks or // newline characters in it, DMS encloses the entire column with an additional pair // of double quotation marks ("). Every quotation mark within the data is repeated - // twice. The default value is true. Valid values include true, false, y, and n. + // twice. The default value is true . Valid values include true , false , y , and n + // . Rfc4180 *bool // The number of rows in a row group. A smaller row group size provides faster @@ -3267,8 +3091,8 @@ type S3Settings struct { // the max row group length in bytes (64 * 1024 * 1024). RowGroupLength *int32 - // If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key - // that you use needs an attached policy that enables Identity and Access + // If you are using SSE_KMS for the EncryptionMode , provide the KMS key ID. The + // key that you use needs an attached policy that enables Identity and Access // Management (IAM) user permissions and allows use of the key. Here is a CLI // example: aws dms create-endpoint --endpoint-identifier value --endpoint-type // target --engine-name s3 --s3-settings @@ -3276,41 +3100,40 @@ type S3Settings struct { ServerSideEncryptionKmsKeyId *string // The Amazon Resource Name (ARN) used by the service to access the IAM role. The - // role must allow the iam:PassRole action. It is a required parameter that enables - // DMS to write and read objects from an S3 bucket. + // role must allow the iam:PassRole action. It is a required parameter that + // enables DMS to write and read objects from an S3 bucket. ServiceAccessRoleArn *string - // A value that when nonblank causes DMS to add a column with timestamp information - // to the endpoint data for an Amazon S3 target. DMS supports the + // A value that when nonblank causes DMS to add a column with timestamp + // information to the endpoint data for an Amazon S3 target. DMS supports the // TimestampColumnName parameter in versions 3.1.4 and later. DMS includes an // additional STRING column in the .csv or .parquet object files of your migrated - // data when you set TimestampColumnName to a nonblank value. For a full load, each - // row of this timestamp column contains a timestamp for when the data was + // data when you set TimestampColumnName to a nonblank value. For a full load, + // each row of this timestamp column contains a timestamp for when the data was // transferred from the source to the target by DMS. For a change data capture // (CDC) load, each row of the timestamp column contains the timestamp for the // commit of that row in the source database. The string format for this timestamp - // column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this + // column value is yyyy-MM-dd HH:mm:ss.SSSSSS . By default, the precision of this // value is in microseconds. For a CDC load, the rounding of the precision depends // on the commit timestamp supported by DMS for the source database. When the - // AddColumnName parameter is set to true, DMS also includes a name for the - // timestamp column that you set with TimestampColumnName. + // AddColumnName parameter is set to true , DMS also includes a name for the + // timestamp column that you set with TimestampColumnName . TimestampColumnName *string // This setting applies if the S3 output files during a change data capture (CDC) // load are written in .csv format. If set to true for columns not included in the - // supplemental log, DMS uses the value specified by CsvNoSupValue - // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue). - // If not set or set to false, DMS uses the null value for these columns. This + // supplemental log, DMS uses the value specified by CsvNoSupValue (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue) + // . If not set or set to false , DMS uses the null value for these columns. This // setting is supported in DMS versions 3.4.1 and later. UseCsvNoSupValue *bool // When set to true, this parameter uses the task start time as the timestamp // column value instead of the time data is written to target. For full load, when - // useTaskStartTimeForFullLoadTimestamp is set to true, each row of the timestamp + // useTaskStartTimeForFullLoadTimestamp is set to true , each row of the timestamp // column contains the task start time. For CDC loads, each row of the timestamp // column contains the transaction commit time. When - // useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp in - // the timestamp column increments with the time data arrives at the target. + // useTaskStartTimeForFullLoadTimestamp is set to false , the full load timestamp + // in the timestamp column increments with the time data arrives at the target. UseTaskStartTimeForFullLoadTimestamp *bool noSmithyDocumentSerde @@ -3421,13 +3244,13 @@ type Subnet struct { noSmithyDocumentSerde } -// Provides information about types of supported endpoints in response to a request -// by the DescribeEndpointTypes operation. This information includes the type of -// endpoint, the database engine name, and whether change data capture (CDC) is -// supported. +// Provides information about types of supported endpoints in response to a +// request by the DescribeEndpointTypes operation. This information includes the +// type of endpoint, the database engine name, and whether change data capture +// (CDC) is supported. type SupportedEndpointType struct { - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target . EndpointType ReplicationEndpointTypeValue // The expanded name for the engine name. For example, if the EngineName parameter @@ -3435,10 +3258,10 @@ type SupportedEndpointType struct { EngineDisplayName *string // The database engine name. Valid values, depending on the EndpointType, include - // "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", - // "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", - // "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and - // "babelfish". + // "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , + // "redshift" , "s3" , "db2" , "db2-zos" , "azuredb" , "sybase" , "dynamodb" , + // "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "documentdb" , "sqlserver" , + // "neptune" , and "babelfish" . EngineName *string // The earliest DMS engine version that supports this endpoint engine. Note that @@ -3466,16 +3289,15 @@ type SybaseSettings struct { // The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the // trusted entity and grants the required permissions to access the value in - // SecretsManagerSecret. The role must allow the iam:PassRole action. + // SecretsManagerSecret . The role must allow the iam:PassRole action. // SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager // secret that allows access to the SAP ASE endpoint. You can specify one of two // sets of values for these permissions. You can specify the values for this - // setting and SecretsManagerSecretId. Or you can specify clear-text values for - // UserName, Password, ServerName, and Port. You can't specify both. For more + // setting and SecretsManagerSecretId . Or you can specify clear-text values for + // UserName , Password , ServerName , and Port . You can't specify both. For more // information on creating this SecretsManagerSecret and the // SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, - // see Using secrets to access Database Migration Service resources - // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // see Using secrets to access Database Migration Service resources (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) // in the Database Migration Service User Guide. SecretsManagerAccessRoleArn *string @@ -3496,8 +3318,8 @@ type SybaseSettings struct { // DescribeTableStatistics operation. type TableStatistics struct { - // The number of data definition language (DDL) statements used to build and modify - // the structure of your tables applied on the target. + // The number of data definition language (DDL) statements used to build and + // modify the structure of your tables applied on the target. AppliedDdls *int64 // The number of delete actions applied on a target table. @@ -3516,8 +3338,8 @@ type TableStatistics struct { // The number of delete actions performed on a table. Deletes int64 - // The number of rows that failed conditional checks during the full load operation - // (valid only for migrations where DynamoDB is the target). + // The number of rows that failed conditional checks during the full load + // operation (valid only for migrations where DynamoDB is the target). FullLoadCondtnlChkFailedRows int64 // The time when the full load operation completed. @@ -3527,8 +3349,8 @@ type TableStatistics struct { // only for migrations where DynamoDB is the target). FullLoadErrorRows int64 - // A value that indicates if the table was reloaded (true) or loaded as part of a - // new full load operation (false). + // A value that indicates if the table was reloaded ( true ) or loaded as part of a + // new full load operation ( false ). FullLoadReloaded *bool // The number of rows added during the full load operation. @@ -3565,40 +3387,23 @@ type TableStatistics struct { // The validation state of the table. This parameter can have the following // values: - // - // * Not enabled – Validation isn't enabled for the table in the migration - // task. - // - // * Pending records – Some records in the table are waiting for - // validation. - // - // * Mismatched records – Some records in the table don't match - // between the source and target. - // - // * Suspended records – Some records in the table - // couldn't be validated. - // - // * No primary key –The table couldn't be validated - // because it has no primary key. - // - // * Table error – The table wasn't validated - // because it's in an error state and some data wasn't migrated. - // - // * Validated – All - // rows in the table are validated. If the table is updated, the status can change - // from Validated. - // - // * Error – The table couldn't be validated because of an - // unexpected error. - // - // * Pending validation – The table is waiting validation. - // - // * - // Preparing table – Preparing the table enabled in the migration task for - // validation. - // - // * Pending revalidation – All rows in the table are pending - // validation after the table was updated. + // - Not enabled – Validation isn't enabled for the table in the migration task. + // - Pending records – Some records in the table are waiting for validation. + // - Mismatched records – Some records in the table don't match between the + // source and target. + // - Suspended records – Some records in the table couldn't be validated. + // - No primary key –The table couldn't be validated because it has no primary + // key. + // - Table error – The table wasn't validated because it's in an error state and + // some data wasn't migrated. + // - Validated – All rows in the table are validated. If the table is updated, + // the status can change from Validated. + // - Error – The table couldn't be validated because of an unexpected error. + // - Pending validation – The table is waiting validation. + // - Preparing table – Preparing the table enabled in the migration task for + // validation. + // - Pending revalidation – All rows in the table are pending validation after + // the table was updated. ValidationState *string // Additional details about the state of validation. @@ -3628,13 +3433,9 @@ type TableToReload struct { // A user-defined key-value pair that describes metadata added to an DMS resource // and that is used by operations such as the following: -// -// * AddTagsToResource -// -// * -// ListTagsForResource -// -// * RemoveTagsFromResource +// - AddTagsToResource +// - ListTagsForResource +// - RemoveTagsFromResource type Tag struct { // A key is the required name of the tag. The string value can be 1-128 Unicode diff --git a/service/databrew/api_client.go b/service/databrew/api_client.go index 57d3316b82b..83cfe52d1cf 100644 --- a/service/databrew/api_client.go +++ b/service/databrew/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/databrew/api_op_BatchDeleteRecipeVersion.go b/service/databrew/api_op_BatchDeleteRecipeVersion.go index 639ab1e2617..d61babd75ae 100644 --- a/service/databrew/api_op_BatchDeleteRecipeVersion.go +++ b/service/databrew/api_op_BatchDeleteRecipeVersion.go @@ -13,37 +13,22 @@ import ( // Deletes one or more versions of a recipe at a time. The entire request will be // rejected if: +// - The recipe does not exist. +// - There is an invalid version identifier in the list of versions. +// - The version list is empty. +// - The version list size exceeds 50. +// - The version list contains duplicate entries. // -// * The recipe does not exist. +// The request will complete successfully, but with partial failures, if: +// - A version does not exist. +// - A version is being used by a job. +// - You specify LATEST_WORKING , but it's being used by a project. +// - The version fails to be deleted. // -// * There is an invalid version -// identifier in the list of versions. -// -// * The version list is empty. -// -// * The version -// list size exceeds 50. -// -// * The version list contains duplicate entries. -// -// The -// request will complete successfully, but with partial failures, if: -// -// * A version -// does not exist. -// -// * A version is being used by a job. -// -// * You specify -// LATEST_WORKING, but it's being used by a project. -// -// * The version fails to be -// deleted. -// -// The LATEST_WORKING version will only be deleted if the recipe has no -// other versions. If you try to delete LATEST_WORKING while other versions exist -// (or if they can't be deleted), then LATEST_WORKING will be listed as partial -// failure in the response. +// The LATEST_WORKING version will only be deleted if the recipe has no other +// versions. If you try to delete LATEST_WORKING while other versions exist (or if +// they can't be deleted), then LATEST_WORKING will be listed as partial failure +// in the response. func (c *Client) BatchDeleteRecipeVersion(ctx context.Context, params *BatchDeleteRecipeVersionInput, optFns ...func(*Options)) (*BatchDeleteRecipeVersionOutput, error) { if params == nil { params = &BatchDeleteRecipeVersionInput{} @@ -67,7 +52,7 @@ type BatchDeleteRecipeVersionInput struct { Name *string // An array of version identifiers, for the recipe versions to be deleted. You can - // specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not + // specify numeric versions ( X.Y ) or LATEST_WORKING . LATEST_PUBLISHED is not // supported. // // This member is required. diff --git a/service/databrew/api_op_CreateProfileJob.go b/service/databrew/api_op_CreateProfileJob.go index 5906ac3cb62..7c46d8bea92 100644 --- a/service/databrew/api_op_CreateProfileJob.go +++ b/service/databrew/api_op_CreateProfileJob.go @@ -62,12 +62,8 @@ type CreateProfileJobInput struct { EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // SSE-KMS - Server-side encryption with KMS-managed keys. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode types.EncryptionMode // Sample configuration for profile jobs only. Determines the number of rows on @@ -90,7 +86,7 @@ type CreateProfileJobInput struct { Tags map[string]string // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 // List of validation configurations that are applied to the profile job. diff --git a/service/databrew/api_op_CreateProject.go b/service/databrew/api_op_CreateProject.go index c82ca35ad0c..4de063c7542 100644 --- a/service/databrew/api_op_CreateProject.go +++ b/service/databrew/api_op_CreateProject.go @@ -51,8 +51,8 @@ type CreateProjectInput struct { // This member is required. RoleArn *string - // Represents the sample size and sampling type for DataBrew to use for interactive - // data analysis. + // Represents the sample size and sampling type for DataBrew to use for + // interactive data analysis. Sample *types.Sample // Metadata tags to apply to this project. diff --git a/service/databrew/api_op_CreateRecipe.go b/service/databrew/api_op_CreateRecipe.go index 5eca3f67335..c5bc518b69e 100644 --- a/service/databrew/api_op_CreateRecipe.go +++ b/service/databrew/api_op_CreateRecipe.go @@ -29,8 +29,8 @@ func (c *Client) CreateRecipe(ctx context.Context, params *CreateRecipeInput, op type CreateRecipeInput struct { - // A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), - // hyphen (-), period (.), and space. + // A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, + // 0-9), hyphen (-), period (.), and space. // // This member is required. Name *string diff --git a/service/databrew/api_op_CreateRecipeJob.go b/service/databrew/api_op_CreateRecipeJob.go index a2146b4ced7..e6a32f349c4 100644 --- a/service/databrew/api_op_CreateRecipeJob.go +++ b/service/databrew/api_op_CreateRecipeJob.go @@ -58,12 +58,8 @@ type CreateRecipeJobInput struct { EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // Server-side encryption with keys managed by KMS. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - Server-side encryption with keys managed by KMS. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode types.EncryptionMode // Enables or disables Amazon CloudWatch logging for the job. If logging is @@ -91,7 +87,7 @@ type CreateRecipeJobInput struct { Tags map[string]string // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 noSmithyDocumentSerde diff --git a/service/databrew/api_op_CreateSchedule.go b/service/databrew/api_op_CreateSchedule.go index 52575fc41c0..07e1b8d9fa1 100644 --- a/service/databrew/api_op_CreateSchedule.go +++ b/service/databrew/api_op_CreateSchedule.go @@ -30,9 +30,8 @@ func (c *Client) CreateSchedule(ctx context.Context, params *CreateScheduleInput type CreateScheduleInput struct { // The date or dates and time or times when the jobs are to be run. For more - // information, see Cron expressions - // (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the Glue - // DataBrew Developer Guide. + // information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) + // in the Glue DataBrew Developer Guide. // // This member is required. CronExpression *string diff --git a/service/databrew/api_op_DeleteRecipeVersion.go b/service/databrew/api_op_DeleteRecipeVersion.go index 81bd6b6367f..2c5a434c206 100644 --- a/service/databrew/api_op_DeleteRecipeVersion.go +++ b/service/databrew/api_op_DeleteRecipeVersion.go @@ -33,8 +33,8 @@ type DeleteRecipeVersionInput struct { // This member is required. Name *string - // The version of the recipe to be deleted. You can specify a numeric versions - // (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported. + // The version of the recipe to be deleted. You can specify a numeric versions ( X.Y + // ) or LATEST_WORKING . LATEST_PUBLISHED is not supported. // // This member is required. RecipeVersion *string diff --git a/service/databrew/api_op_DescribeJob.go b/service/databrew/api_op_DescribeJob.go index b1a1c18a350..98cee1aa889 100644 --- a/service/databrew/api_op_DescribeJob.go +++ b/service/databrew/api_op_DescribeJob.go @@ -67,12 +67,8 @@ type DescribeJobOutput struct { EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // Server-side encryption with keys managed by KMS. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - Server-side encryption with keys managed by KMS. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode types.EncryptionMode // Sample configuration for profile jobs only. Determines the number of rows on @@ -120,16 +116,13 @@ type DescribeJobOutput struct { Tags map[string]string // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 // The job type, which must be one of the following: - // - // * PROFILE - The job analyzes - // the dataset to determine its size, data types, data distribution, and more. - // - // * - // RECIPE - The job applies one or more transformations to a dataset. + // - PROFILE - The job analyzes the dataset to determine its size, data types, + // data distribution, and more. + // - RECIPE - The job applies one or more transformations to a dataset. Type types.JobType // List of validation configurations that are applied to the profile job. diff --git a/service/databrew/api_op_DescribeProject.go b/service/databrew/api_op_DescribeProject.go index 9ba095617c7..b43e849ce5a 100644 --- a/service/databrew/api_op_DescribeProject.go +++ b/service/databrew/api_op_DescribeProject.go @@ -76,19 +76,14 @@ type DescribeProjectOutput struct { // DataBrew runs the job. RoleArn *string - // Represents the sample size and sampling type for DataBrew to use for interactive - // data analysis. + // Represents the sample size and sampling type for DataBrew to use for + // interactive data analysis. Sample *types.Sample // Describes the current state of the session: - // - // * PROVISIONING - allocating - // resources for the session. - // - // * INITIALIZING - getting the session ready for first - // use. - // - // * ASSIGNED - the session is ready for use. + // - PROVISIONING - allocating resources for the session. + // - INITIALIZING - getting the session ready for first use. + // - ASSIGNED - the session is ready for use. SessionStatus types.SessionStatus // Metadata tags associated with this project. diff --git a/service/databrew/api_op_DescribeSchedule.go b/service/databrew/api_op_DescribeSchedule.go index ef0547e5129..7b01909c8cd 100644 --- a/service/databrew/api_op_DescribeSchedule.go +++ b/service/databrew/api_op_DescribeSchedule.go @@ -51,9 +51,8 @@ type DescribeScheduleOutput struct { CreatedBy *string // The date or dates and time or times when the jobs are to be run for the - // schedule. For more information, see Cron expressions - // (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the Glue - // DataBrew Developer Guide. + // schedule. For more information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) + // in the Glue DataBrew Developer Guide. CronExpression *string // The name or names of one or more jobs to be run by using the schedule. diff --git a/service/databrew/api_op_ListRecipeVersions.go b/service/databrew/api_op_ListRecipeVersions.go index d3f5d1de448..840d4bdc825 100644 --- a/service/databrew/api_op_ListRecipeVersions.go +++ b/service/databrew/api_op_ListRecipeVersions.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING. +// Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING . func (c *Client) ListRecipeVersions(ctx context.Context, params *ListRecipeVersionsInput, optFns ...func(*Options)) (*ListRecipeVersionsOutput, error) { if params == nil { params = &ListRecipeVersionsInput{} diff --git a/service/databrew/api_op_ListRecipes.go b/service/databrew/api_op_ListRecipes.go index df306045805..87abe480dbe 100644 --- a/service/databrew/api_op_ListRecipes.go +++ b/service/databrew/api_op_ListRecipes.go @@ -37,7 +37,7 @@ type ListRecipesInput struct { NextToken *string // Return only those recipes with a version identifier of LATEST_WORKING or - // LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the + // LATEST_PUBLISHED . If RecipeVersion is omitted, ListRecipes returns all of the // LATEST_PUBLISHED recipe versions. Valid values: LATEST_WORKING | // LATEST_PUBLISHED RecipeVersion *string diff --git a/service/databrew/api_op_ListRulesets.go b/service/databrew/api_op_ListRulesets.go index 4ec3fb5d81b..2942cd19958 100644 --- a/service/databrew/api_op_ListRulesets.go +++ b/service/databrew/api_op_ListRulesets.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all rulesets available in the current account or rulesets associated with a -// specific resource (dataset). +// List all rulesets available in the current account or rulesets associated with +// a specific resource (dataset). func (c *Client) ListRulesets(ctx context.Context, params *ListRulesetsInput, optFns ...func(*Options)) (*ListRulesetsOutput, error) { if params == nil { params = &ListRulesetsInput{} diff --git a/service/databrew/api_op_SendProjectSessionAction.go b/service/databrew/api_op_SendProjectSessionAction.go index 2e0f21d64f5..f5437275194 100644 --- a/service/databrew/api_op_SendProjectSessionAction.go +++ b/service/databrew/api_op_SendProjectSessionAction.go @@ -45,9 +45,9 @@ type SendProjectSessionActionInput struct { // Represents a single step from a DataBrew recipe to be performed. RecipeStep *types.RecipeStep - // The index from which to preview a step. This index is used to preview the result - // of steps that have already been applied, so that the resulting view frame is - // from earlier in the view frame stack. + // The index from which to preview a step. This index is used to preview the + // result of steps that have already been applied, so that the resulting view frame + // is from earlier in the view frame stack. StepIndex *int32 // Represents the data being transformed during an action. diff --git a/service/databrew/api_op_UpdateProfileJob.go b/service/databrew/api_op_UpdateProfileJob.go index 56ebd4252aa..cc1c5576f28 100644 --- a/service/databrew/api_op_UpdateProfileJob.go +++ b/service/databrew/api_op_UpdateProfileJob.go @@ -56,12 +56,8 @@ type UpdateProfileJobInput struct { EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // Server-side encryption with keys managed by KMS. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - Server-side encryption with keys managed by KMS. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode types.EncryptionMode // Sample configuration for Profile Jobs only. Determines the number of rows on @@ -74,15 +70,15 @@ type UpdateProfileJobInput struct { // enabled, CloudWatch writes one log stream for each job run. LogSubscription types.LogSubscription - // The maximum number of compute nodes that DataBrew can use when the job processes - // data. + // The maximum number of compute nodes that DataBrew can use when the job + // processes data. MaxCapacity int32 // The maximum number of times to retry the job after a job run fails. MaxRetries int32 // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 // List of validation configurations that are applied to the profile job. diff --git a/service/databrew/api_op_UpdateProject.go b/service/databrew/api_op_UpdateProject.go index a8c9d490817..d6db6093eb2 100644 --- a/service/databrew/api_op_UpdateProject.go +++ b/service/databrew/api_op_UpdateProject.go @@ -40,8 +40,8 @@ type UpdateProjectInput struct { // This member is required. RoleArn *string - // Represents the sample size and sampling type for DataBrew to use for interactive - // data analysis. + // Represents the sample size and sampling type for DataBrew to use for + // interactive data analysis. Sample *types.Sample noSmithyDocumentSerde diff --git a/service/databrew/api_op_UpdateRecipeJob.go b/service/databrew/api_op_UpdateRecipeJob.go index 55d03f548c8..16551a401c3 100644 --- a/service/databrew/api_op_UpdateRecipeJob.go +++ b/service/databrew/api_op_UpdateRecipeJob.go @@ -53,12 +53,8 @@ type UpdateRecipeJobInput struct { EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // Server-side encryption with keys managed by KMS. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - Server-side encryption with keys managed by KMS. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode types.EncryptionMode // Enables or disables Amazon CloudWatch logging for the job. If logging is @@ -76,7 +72,7 @@ type UpdateRecipeJobInput struct { Outputs []types.Output // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 noSmithyDocumentSerde diff --git a/service/databrew/api_op_UpdateSchedule.go b/service/databrew/api_op_UpdateSchedule.go index 8cd4c7414ad..9de88b87d53 100644 --- a/service/databrew/api_op_UpdateSchedule.go +++ b/service/databrew/api_op_UpdateSchedule.go @@ -29,9 +29,8 @@ func (c *Client) UpdateSchedule(ctx context.Context, params *UpdateScheduleInput type UpdateScheduleInput struct { // The date or dates and time or times when the jobs are to be run. For more - // information, see Cron expressions - // (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the Glue - // DataBrew Developer Guide. + // information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) + // in the Glue DataBrew Developer Guide. // // This member is required. CronExpression *string diff --git a/service/databrew/types/enums.go b/service/databrew/types/enums.go index 935b630653d..465f5d08acc 100644 --- a/service/databrew/types/enums.go +++ b/service/databrew/types/enums.go @@ -182,8 +182,8 @@ const ( OrderAscending Order = "ASCENDING" ) -// Values returns all known values for Order. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Order. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Order) Values() []Order { return []Order{ @@ -199,9 +199,9 @@ const ( OrderedByLastModifiedDate OrderedBy = "LAST_MODIFIED_DATE" ) -// Values returns all known values for OrderedBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderedBy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OrderedBy) Values() []OrderedBy { return []OrderedBy{ "LAST_MODIFIED_DATE", @@ -222,9 +222,9 @@ const ( OutputFormatTableauhyper OutputFormat = "TABLEAUHYPER" ) -// Values returns all known values for OutputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OutputFormat) Values() []OutputFormat { return []OutputFormat{ "CSV", diff --git a/service/databrew/types/types.go b/service/databrew/types/types.go index cd33801d985..fb2bff1c5d2 100644 --- a/service/databrew/types/types.go +++ b/service/databrew/types/types.go @@ -62,8 +62,7 @@ type ColumnStatisticsConfiguration struct { type ConditionExpression struct { // A specific condition to apply to a recipe action. For more information, see - // Recipe structure - // (https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure) + // Recipe structure (https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure) // in the Glue DataBrew Developer Guide. // // This member is required. @@ -80,8 +79,8 @@ type ConditionExpression struct { noSmithyDocumentSerde } -// Represents a set of options that define how DataBrew will read a comma-separated -// value (CSV) file when creating a dataset from that file. +// Represents a set of options that define how DataBrew will read a +// comma-separated value (CSV) file when creating a dataset from that file. type CsvOptions struct { // A single character that specifies the delimiter being used in the CSV file. @@ -116,8 +115,8 @@ type DatabaseInputDefinition struct { // The table within the target database. DatabaseTableName *string - // Custom SQL to run against the provided Glue connection. This SQL will be used as - // the input for DataBrew projects and jobs. + // Custom SQL to run against the provided Glue connection. This SQL will be used + // as the input for DataBrew projects and jobs. QueryString *string // Represents an Amazon S3 location (bucket name, bucket owner, and object key) @@ -159,15 +158,15 @@ type DatabaseTableOutputOptions struct { // This member is required. TableName *string - // Represents an Amazon S3 location (bucket name and object key) where DataBrew can - // store intermediate results. + // Represents an Amazon S3 location (bucket name and object key) where DataBrew + // can store intermediate results. TempDirectory *S3Location noSmithyDocumentSerde } -// Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew -// dataset. +// Represents how metadata stored in the Glue Data Catalog is defined in a +// DataBrew dataset. type DataCatalogInputDefinition struct { // The name of a database in the Data Catalog. @@ -291,8 +290,8 @@ type DatasetParameter struct { // This member is required. Type ParameterType - // Optional boolean value that defines whether the captured value of this parameter - // should be used to create a new column in a dataset. + // Optional boolean value that defines whether the captured value of this + // parameter should be used to create a new column in a dataset. CreateColumn bool // Additional parameter options such as a format and a timezone. Required for @@ -335,53 +334,27 @@ type DatetimeOptions struct { type EntityDetectorConfiguration struct { // Entity types to detect. Can be any of the following: - // - // * USA_SSN - // - // * EMAIL - // - // * - // USA_ITIN - // - // * USA_PASSPORT_NUMBER - // - // * PHONE_NUMBER - // - // * USA_DRIVING_LICENSE - // - // * - // BANK_ACCOUNT - // - // * CREDIT_CARD - // - // * IP_ADDRESS - // - // * MAC_ADDRESS - // - // * USA_DEA_NUMBER - // - // * - // USA_HCPCS_CODE - // - // * USA_NATIONAL_PROVIDER_IDENTIFIER - // - // * USA_NATIONAL_DRUG_CODE - // - // * - // USA_HEALTH_INSURANCE_CLAIM_NUMBER - // - // * USA_MEDICARE_BENEFICIARY_IDENTIFIER - // - // * - // USA_CPT_CODE - // - // * PERSON_NAME - // - // * DATE - // - // The Entity type group USA_ALL is also - // supported, and includes all of the above entity types except PERSON_NAME and - // DATE. + // - USA_SSN + // - EMAIL + // - USA_ITIN + // - USA_PASSPORT_NUMBER + // - PHONE_NUMBER + // - USA_DRIVING_LICENSE + // - BANK_ACCOUNT + // - CREDIT_CARD + // - IP_ADDRESS + // - MAC_ADDRESS + // - USA_DEA_NUMBER + // - USA_HCPCS_CODE + // - USA_NATIONAL_PROVIDER_IDENTIFIER + // - USA_NATIONAL_DRUG_CODE + // - USA_HEALTH_INSURANCE_CLAIM_NUMBER + // - USA_MEDICARE_BENEFICIARY_IDENTIFIER + // - USA_CPT_CODE + // - PERSON_NAME + // - DATE + // The Entity type group USA_ALL is also supported, and includes all of the above + // entity types except PERSON_NAME and DATE. // // This member is required. EntityTypes []string @@ -421,22 +394,21 @@ type FilesLimit struct { // This member is required. MaxFiles int32 - // A criteria to use for Amazon S3 files sorting before their selection. By default - // uses DESCENDING order, i.e. most recent files are selected first. Another - // possible value is ASCENDING. + // A criteria to use for Amazon S3 files sorting before their selection. By + // default uses DESCENDING order, i.e. most recent files are selected first. + // Another possible value is ASCENDING. Order Order - // A criteria to use for Amazon S3 files sorting before their selection. By default - // uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed - // value. + // A criteria to use for Amazon S3 files sorting before their selection. By + // default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only + // allowed value. OrderedBy OrderedBy noSmithyDocumentSerde } // Represents a structure for defining parameter conditions. Supported conditions -// are described here: Supported conditions for dynamic datasets -// (https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) +// are described here: Supported conditions for dynamic datasets (https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) // in the Glue DataBrew Developer Guide. type FilterExpression struct { @@ -521,17 +493,12 @@ type Job struct { DatasetName *string // The Amazon Resource Name (ARN) of an encryption key that is used to protect the - // job output. For more information, see Encrypting data written by DataBrew jobs - // (https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) + // job output. For more information, see Encrypting data written by DataBrew jobs (https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) EncryptionKeyArn *string // The encryption mode for the job, which can be one of the following: - // - // * SSE-KMS - - // Server-side encryption with keys managed by KMS. - // - // * SSE-S3 - Server-side - // encryption with keys managed by Amazon S3. + // - SSE-KMS - Server-side encryption with keys managed by KMS. + // - SSE-S3 - Server-side encryption with keys managed by Amazon S3. EncryptionMode EncryptionMode // A sample configuration for profile jobs only, which determines the number of @@ -574,16 +541,13 @@ type Job struct { Tags map[string]string // The job's timeout in minutes. A job that attempts to run longer than this - // timeout period ends with a status of TIMEOUT. + // timeout period ends with a status of TIMEOUT . Timeout int32 // The job type of the job, which must be one of the following: - // - // * PROFILE - A job - // to analyze a dataset, to determine its size, data types, data distribution, and - // more. - // - // * RECIPE - A job to apply one or more transformations to a dataset. + // - PROFILE - A job to analyze a dataset, to determine its size, data types, + // data distribution, and more. + // - RECIPE - A job to apply one or more transformations to a dataset. Type JobType // List of validation configurations that are applied to the profile job. @@ -666,12 +630,9 @@ type JobSample struct { // A value that determines whether the profile job is run on the entire dataset or // a specified number of rows. This value must be one of the following: - // - // * - // FULL_DATASET - The profile job is run on the entire dataset. - // - // * CUSTOM_ROWS - - // The profile job is run on the number of rows specified in the Size parameter. + // - FULL_DATASET - The profile job is run on the entire dataset. + // - CUSTOM_ROWS - The profile job is run on the number of rows specified in the + // Size parameter. Mode SampleMode // The Size parameter is only required when the mode is CUSTOM_ROWS. The profile @@ -882,17 +843,12 @@ type Recipe struct { PublishedDate *time.Time // The identifier for the version for the recipe. Must be one of the following: - // - // * - // Numeric version (X.Y) - X and Y stand for major and minor version numbers. The - // maximum length of each is 6 digits, and neither can be negative values. Both X - // and Y are required, and "0.0" isn't a valid version. - // - // * LATEST_WORKING - the - // most recent valid version being developed in a DataBrew project. - // - // * - // LATEST_PUBLISHED - the most recent published version. + // - Numeric version ( X.Y ) - X and Y stand for major and minor version numbers. + // The maximum length of each is 6 digits, and neither can be negative values. Both + // X and Y are required, and "0.0" isn't a valid version. + // - LATEST_WORKING - the most recent valid version being developed in a DataBrew + // project. + // - LATEST_PUBLISHED - the most recent published version. RecipeVersion *string // The Amazon Resource Name (ARN) for the recipe. @@ -908,8 +864,8 @@ type Recipe struct { } // Represents a transformation and associated parameters that are used to apply a -// change to a DataBrew dataset. For more information, see Recipe actions reference -// (https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html). +// change to a DataBrew dataset. For more information, see Recipe actions reference (https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html) +// . type RecipeAction struct { // The name of a valid DataBrew transformation to be performed on the data. @@ -976,15 +932,14 @@ type Rule struct { // The expression which includes column references, condition names followed by // variable references, possibly grouped and combined with other conditions. For // example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 - // ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are - // substitution variables that should start with the ':' symbol. Depending on the - // context, substitution variables' values can be either an actual value or a + // ends_with :suffix1 or :col1 ends_with :suffix2) . Column and value references + // are substitution variables that should start with the ':' symbol. Depending on + // the context, substitution variables' values can be either an actual value or a // column name. These values are defined in the SubstitutionMap. If a // CheckExpression starts with a column reference, then ColumnSelectors in the rule // should be null. If ColumnSelectors has been defined, then there should be no // column reference in the left side of a condition, for example, is_between :val1 - // and :val2. For more information, see Available checks - // (https://docs.aws.amazon.com/databrew/latest/dg/profile.data-quality-available-checks.html) + // and :val2 . For more information, see Available checks (https://docs.aws.amazon.com/databrew/latest/dg/profile.data-quality-available-checks.html) // // This member is required. CheckExpression *string @@ -1084,8 +1039,8 @@ type S3Location struct { // output generated by recipe jobs. type S3TableOutputOptions struct { - // Represents an Amazon S3 location (bucket name and object key) where DataBrew can - // write output from a job. + // Represents an Amazon S3 location (bucket name and object key) where DataBrew + // can write output from a job. // // This member is required. Location *S3Location @@ -1093,8 +1048,8 @@ type S3TableOutputOptions struct { noSmithyDocumentSerde } -// Represents the sample size and sampling type for DataBrew to use for interactive -// data analysis. +// Represents the sample size and sampling type for DataBrew to use for +// interactive data analysis. type Sample struct { // The way in which DataBrew obtains rows from a dataset. diff --git a/service/dataexchange/api_client.go b/service/dataexchange/api_client.go index ed833284b59..353473b1bfd 100644 --- a/service/dataexchange/api_client.go +++ b/service/dataexchange/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/dataexchange/api_op_CreateDataSet.go b/service/dataexchange/api_op_CreateDataSet.go index ebaae186db6..a8400747c9d 100644 --- a/service/dataexchange/api_op_CreateDataSet.go +++ b/service/dataexchange/api_op_CreateDataSet.go @@ -78,8 +78,8 @@ type CreateDataSetOutput struct { // ENTITLED to the account (for subscribers). Origin types.Origin - // If the origin of this data set is ENTITLED, includes the details for the product - // on AWS Marketplace. + // If the origin of this data set is ENTITLED, includes the details for the + // product on AWS Marketplace. OriginDetails *types.OriginDetails // The data set ID of the owned data set corresponding to the entitled data set diff --git a/service/dataexchange/api_op_GetDataSet.go b/service/dataexchange/api_op_GetDataSet.go index 9f27540dc4a..ebeb75c9f1b 100644 --- a/service/dataexchange/api_op_GetDataSet.go +++ b/service/dataexchange/api_op_GetDataSet.go @@ -62,8 +62,8 @@ type GetDataSetOutput struct { // ENTITLED to the account (for subscribers). Origin types.Origin - // If the origin of this data set is ENTITLED, includes the details for the product - // on AWS Marketplace. + // If the origin of this data set is ENTITLED, includes the details for the + // product on AWS Marketplace. OriginDetails *types.OriginDetails // The data set ID of the owned data set corresponding to the entitled data set diff --git a/service/dataexchange/api_op_UpdateDataSet.go b/service/dataexchange/api_op_UpdateDataSet.go index 7242364ca34..5368e75383c 100644 --- a/service/dataexchange/api_op_UpdateDataSet.go +++ b/service/dataexchange/api_op_UpdateDataSet.go @@ -68,8 +68,8 @@ type UpdateDataSetOutput struct { // ENTITLED to the account (for subscribers). Origin types.Origin - // If the origin of this data set is ENTITLED, includes the details for the product - // on AWS Marketplace. + // If the origin of this data set is ENTITLED, includes the details for the + // product on AWS Marketplace. OriginDetails *types.OriginDetails // The data set ID of the owned data set corresponding to the entitled data set diff --git a/service/dataexchange/api_op_UpdateRevision.go b/service/dataexchange/api_op_UpdateRevision.go index 3962c72e9d2..bd3f1812a68 100644 --- a/service/dataexchange/api_op_UpdateRevision.go +++ b/service/dataexchange/api_op_UpdateRevision.go @@ -42,9 +42,9 @@ type UpdateRevisionInput struct { // An optional comment about the revision. Comment *string - // Finalizing a revision tells AWS Data Exchange that your changes to the assets in - // the revision are complete. After it's in this read-only state, you can publish - // the revision to your products. + // Finalizing a revision tells AWS Data Exchange that your changes to the assets + // in the revision are complete. After it's in this read-only state, you can + // publish the revision to your products. Finalized bool noSmithyDocumentSerde diff --git a/service/dataexchange/types/enums.go b/service/dataexchange/types/enums.go index 341ce8ce70c..24938c1bb1c 100644 --- a/service/dataexchange/types/enums.go +++ b/service/dataexchange/types/enums.go @@ -13,9 +13,9 @@ const ( AssetTypeLakeFormationDataPermission AssetType = "LAKE_FORMATION_DATA_PERMISSION" ) -// Values returns all known values for AssetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AssetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AssetType) Values() []AssetType { return []AssetType{ "S3_SNAPSHOT", @@ -122,8 +122,8 @@ const ( JobErrorResourceTypesDataSet JobErrorResourceTypes = "DATA_SET" ) -// Values returns all known values for JobErrorResourceTypes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for JobErrorResourceTypes. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (JobErrorResourceTypes) Values() []JobErrorResourceTypes { return []JobErrorResourceTypes{ @@ -158,9 +158,9 @@ const ( LFPermissionSelect LFPermission = "SELECT" ) -// Values returns all known values for LFPermission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LFPermission. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LFPermission) Values() []LFPermission { return []LFPermission{ "DESCRIBE", @@ -220,9 +220,9 @@ const ( LimitNameConcurrentInProgressJobsToCreateAmazonS3DataAccessAssetsFromS3Buckets LimitName = "Concurrent in progress jobs to create Amazon S3 data access assets from S3 buckets" ) -// Values returns all known values for LimitName. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LimitName. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LimitName) Values() []LimitName { return []LimitName{ "Products per account", @@ -281,9 +281,9 @@ const ( ProtocolTypeRest ProtocolType = "REST" ) -// Values returns all known values for ProtocolType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProtocolType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProtocolType) Values() []ProtocolType { return []ProtocolType{ "REST", @@ -301,9 +301,9 @@ const ( ResourceTypeEventAction ResourceType = "EVENT_ACTION" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "DATA_SET", @@ -344,8 +344,8 @@ const ( StateTimedOut State = "TIMED_OUT" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ diff --git a/service/dataexchange/types/types.go b/service/dataexchange/types/types.go index 2a91c46ade8..d9e28eb08b6 100644 --- a/service/dataexchange/types/types.go +++ b/service/dataexchange/types/types.go @@ -186,8 +186,8 @@ type AutoExportRevisionDestinationEntry struct { // A string representing the pattern for generated names of the individual assets // in the revision. For more information about key patterns, see Key patterns when - // exporting revisions - // (https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns). + // exporting revisions (https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns) + // . KeyPattern *string noSmithyDocumentSerde @@ -323,8 +323,8 @@ type DataSetEntry struct { // This member is required. UpdatedAt *time.Time - // If the origin of this data set is ENTITLED, includes the details for the product - // on AWS Marketplace. + // If the origin of this data set is ENTITLED, includes the details for the + // product on AWS Marketplace. OriginDetails *OriginDetails // The data set ID of the owned data set corresponding to the entitled data set @@ -540,8 +540,8 @@ type ExportServerSideEncryption struct { // This member is required. Type ServerSideEncryptionTypes - // The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the - // Amazon S3 objects. This parameter is required if you choose aws:kms as an + // The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt + // the Amazon S3 objects. This parameter is required if you choose aws:kms as an // encryption type. KmsKeyArn *string @@ -1169,8 +1169,8 @@ type RevisionDestinationEntry struct { // A string representing the pattern for generated names of the individual assets // in the revision. For more information about key patterns, see Key patterns when - // exporting revisions - // (https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns). + // exporting revisions (https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns) + // . KeyPattern *string noSmithyDocumentSerde @@ -1259,9 +1259,9 @@ type S3DataAccessAsset struct { // S3 keys made available using this asset. Keys []string - // List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used - // to encrypt S3 objects being shared in this S3 Data Access asset. Providers must - // include all AWS KMS keys used to encrypt these shared S3 objects. + // List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs + // used to encrypt S3 objects being shared in this S3 Data Access asset. Providers + // must include all AWS KMS keys used to encrypt these shared S3 objects. KmsKeysToGrant []KmsKeyToGrant // The automatically-generated bucket-style alias for your Amazon S3 Access Point. @@ -1289,8 +1289,8 @@ type S3DataAccessAssetSourceEntry struct { // The keys used to create the Amazon S3 data access. Keys []string - // List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used - // to encrypt S3 objects being shared in this S3 Data Access asset. + // List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs + // used to encrypt S3 objects being shared in this S3 Data Access asset. KmsKeysToGrant []KmsKeyToGrant noSmithyDocumentSerde diff --git a/service/datapipeline/api_client.go b/service/datapipeline/api_client.go index d9e6c1cc68d..5518dcd6b67 100644 --- a/service/datapipeline/api_client.go +++ b/service/datapipeline/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/datapipeline/api_op_ActivatePipeline.go b/service/datapipeline/api_op_ActivatePipeline.go index 802812fbb86..67f0507565c 100644 --- a/service/datapipeline/api_op_ActivatePipeline.go +++ b/service/datapipeline/api_op_ActivatePipeline.go @@ -15,8 +15,8 @@ import ( // Validates the specified pipeline and starts processing pipeline tasks. If the // pipeline does not pass validation, activation fails. If you need to pause the // pipeline to investigate an issue with a component, such as a data source or -// script, call DeactivatePipeline. To activate a finished pipeline, modify the end -// date for the pipeline and then activate it. POST / HTTP/1.1 Content-Type: +// script, call DeactivatePipeline . To activate a finished pipeline, modify the +// end date for the pipeline and then activate it. POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ActivatePipeline // Content-Length: 39 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, // 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": diff --git a/service/datapipeline/api_op_CreatePipeline.go b/service/datapipeline/api_op_CreatePipeline.go index 5fe73bf3d7a..21f52d86c17 100644 --- a/service/datapipeline/api_op_CreatePipeline.go +++ b/service/datapipeline/api_op_CreatePipeline.go @@ -48,13 +48,13 @@ type CreatePipelineInput struct { // A unique identifier. This identifier is not the same as the pipeline identifier // assigned by AWS Data Pipeline. You are responsible for defining the format and // ensuring the uniqueness of this identifier. You use this parameter to ensure - // idempotency during repeated calls to CreatePipeline. For example, if the first + // idempotency during repeated calls to CreatePipeline . For example, if the first // call to CreatePipeline does not succeed, you can pass in the same unique - // identifier and pipeline name combination on a subsequent call to CreatePipeline. - // CreatePipeline ensures that if a pipeline already exists with the same name and - // unique identifier, a new pipeline is not created. Instead, you'll receive the - // pipeline identifier from the previous attempt. The uniqueness of the name and - // unique identifier combination is scoped to the AWS account or IAM user + // identifier and pipeline name combination on a subsequent call to CreatePipeline + // . CreatePipeline ensures that if a pipeline already exists with the same name + // and unique identifier, a new pipeline is not created. Instead, you'll receive + // the pipeline identifier from the previous attempt. The uniqueness of the name + // and unique identifier combination is scoped to the AWS account or IAM user // credentials. // // This member is required. @@ -65,8 +65,7 @@ type CreatePipelineInput struct { // A list of tags to associate with the pipeline at creation. Tags let you control // access to pipelines. For more information, see Controlling User Access to - // Pipelines - // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) + // Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. Tags []types.Tag @@ -77,7 +76,7 @@ type CreatePipelineInput struct { type CreatePipelineOutput struct { // The ID that AWS Data Pipeline assigns the newly created pipeline. For example, - // df-06372391ZG65EXAMPLE. + // df-06372391ZG65EXAMPLE . // // This member is required. PipelineId *string diff --git a/service/datapipeline/api_op_DeactivatePipeline.go b/service/datapipeline/api_op_DeactivatePipeline.go index 468f2b406c4..3c197602db1 100644 --- a/service/datapipeline/api_op_DeactivatePipeline.go +++ b/service/datapipeline/api_op_DeactivatePipeline.go @@ -12,7 +12,7 @@ import ( // Deactivates the specified running pipeline. The pipeline is set to the // DEACTIVATING state until the deactivation process completes. To resume a -// deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes +// deactivated pipeline, use ActivatePipeline . By default, the pipeline resumes // from the last completed execution. Optionally, you can specify the date and time // to resume the pipeline. func (c *Client) DeactivatePipeline(ctx context.Context, params *DeactivatePipelineInput, optFns ...func(*Options)) (*DeactivatePipelineOutput, error) { @@ -38,8 +38,8 @@ type DeactivatePipelineInput struct { // This member is required. PipelineId *string - // Indicates whether to cancel any running objects. The default is true, which sets - // the state of any running objects to CANCELED. If this value is false, the + // Indicates whether to cancel any running objects. The default is true, which + // sets the state of any running objects to CANCELED . If this value is false, the // pipeline is deactivated after all running objects finish. CancelActive *bool diff --git a/service/datapipeline/api_op_DescribeObjects.go b/service/datapipeline/api_op_DescribeObjects.go index 699e9429333..9d136d0ab79 100644 --- a/service/datapipeline/api_op_DescribeObjects.go +++ b/service/datapipeline/api_op_DescribeObjects.go @@ -48,7 +48,7 @@ func (c *Client) DescribeObjects(ctx context.Context, params *DescribeObjectsInp type DescribeObjectsInput struct { // The IDs of the pipeline objects that contain the definitions to be described. - // You can pass as many as 25 identifiers in a single call to DescribeObjects. + // You can pass as many as 25 identifiers in a single call to DescribeObjects . // // This member is required. ObjectIds []string diff --git a/service/datapipeline/api_op_DescribePipelines.go b/service/datapipeline/api_op_DescribePipelines.go index 54cdc6782e5..cce98ba7b7e 100644 --- a/service/datapipeline/api_op_DescribePipelines.go +++ b/service/datapipeline/api_op_DescribePipelines.go @@ -17,7 +17,7 @@ import ( // retrieve metadata about pipelines that you or your IAM users have created. If // you are using an IAM user account, you can retrieve metadata about only those // pipelines for which you have read permissions. To retrieve the full pipeline -// definition instead of metadata about the pipeline, call GetPipelineDefinition. +// definition instead of metadata about the pipeline, call GetPipelineDefinition . // POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.DescribePipelines Content-Length: 70 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT @@ -53,7 +53,7 @@ func (c *Client) DescribePipelines(ctx context.Context, params *DescribePipeline type DescribePipelinesInput struct { // The IDs of the pipelines to describe. You can pass as many as 25 identifiers in - // a single call. To obtain pipeline IDs, call ListPipelines. + // a single call. To obtain pipeline IDs, call ListPipelines . // // This member is required. PipelineIds []string diff --git a/service/datapipeline/api_op_GetPipelineDefinition.go b/service/datapipeline/api_op_GetPipelineDefinition.go index b618b553372..efe6f512402 100644 --- a/service/datapipeline/api_op_GetPipelineDefinition.go +++ b/service/datapipeline/api_op_GetPipelineDefinition.go @@ -13,7 +13,7 @@ import ( // Gets the definition of the specified pipeline. You can call // GetPipelineDefinition to retrieve the pipeline definition that you provided -// using PutPipelineDefinition. POST / HTTP/1.1 Content-Type: +// using PutPipelineDefinition . POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.GetPipelineDefinition // Content-Length: 40 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, // 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": diff --git a/service/datapipeline/api_op_ListPipelines.go b/service/datapipeline/api_op_ListPipelines.go index 2ec6ad14f73..810dc494a9a 100644 --- a/service/datapipeline/api_op_ListPipelines.go +++ b/service/datapipeline/api_op_ListPipelines.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the pipeline identifiers for all active pipelines that you have permission -// to access. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 +// Lists the pipeline identifiers for all active pipelines that you have +// permission to access. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 // X-Amz-Target: DataPipeline.ListPipelines Content-Length: 14 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT // Authorization: AuthParams {} Status: x-amzn-RequestId: @@ -53,7 +53,7 @@ type ListPipelinesOutput struct { // The pipeline identifiers. If you require additional information about the // pipelines, you can use these identifiers to call DescribePipelines and - // GetPipelineDefinition. + // GetPipelineDefinition . // // This member is required. PipelineIdList []types.PipelineIdName diff --git a/service/datapipeline/api_op_PollForTask.go b/service/datapipeline/api_op_PollForTask.go index 25d48d0825e..e469e66d243 100644 --- a/service/datapipeline/api_op_PollForTask.go +++ b/service/datapipeline/api_op_PollForTask.go @@ -14,16 +14,16 @@ import ( // Task runners call PollForTask to receive a task to perform from AWS Data // Pipeline. The task runner specifies which tasks it can perform by setting a // value for the workerGroup parameter. The task returned can come from any of the -// pipelines that match the workerGroup value passed in by the task runner and that -// was launched using the IAM user credentials specified by the task runner. If -// tasks are ready in the work queue, PollForTask returns a response immediately. -// If no tasks are available in the queue, PollForTask uses long-polling and holds -// on to a poll connection for up to a 90 seconds, during which time the first -// newly scheduled task is handed to the task runner. To accomodate this, set the -// socket timeout in your task runner to 90 seconds. The task runner should not -// call PollForTask again on the same workerGroup until it receives a response, and -// this can take up to 90 seconds. POST / HTTP/1.1 Content-Type: -// application/x-amz-json-1.1 X-Amz-Target: DataPipeline.PollForTask +// pipelines that match the workerGroup value passed in by the task runner and +// that was launched using the IAM user credentials specified by the task runner. +// If tasks are ready in the work queue, PollForTask returns a response +// immediately. If no tasks are available in the queue, PollForTask uses +// long-polling and holds on to a poll connection for up to a 90 seconds, during +// which time the first newly scheduled task is handed to the task runner. To +// accomodate this, set the socket timeout in your task runner to 90 seconds. The +// task runner should not call PollForTask again on the same workerGroup until it +// receives a response, and this can take up to 90 seconds. POST / HTTP/1.1 +// Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.PollForTask // Content-Length: 59 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, // 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"workerGroup": // "MyworkerGroup", "hostname": "example.com"} x-amzn-RequestId: @@ -66,10 +66,10 @@ func (c *Client) PollForTask(ctx context.Context, params *PollForTaskInput, optF // Contains the parameters for PollForTask. type PollForTaskInput struct { - // The type of task the task runner is configured to accept and process. The worker - // group is set as a field on objects in the pipeline when they are created. You - // can only specify a single value for workerGroup in the call to PollForTask. - // There are no wildcard values permitted in workerGroup; the string must be an + // The type of task the task runner is configured to accept and process. The + // worker group is set as a field on objects in the pipeline when they are created. + // You can only specify a single value for workerGroup in the call to PollForTask . + // There are no wildcard values permitted in workerGroup ; the string must be an // exact, case-sensitive, match. // // This member is required. @@ -80,9 +80,8 @@ type PollForTaskInput struct { // Identity information for the EC2 instance that is hosting the task runner. You // can get this value from the instance using - // http://169.254.169.254/latest/meta-data/instance-id. For more information, see - // Instance Metadata - // (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) + // http://169.254.169.254/latest/meta-data/instance-id . For more information, see + // Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) // in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves // that your task runner is running on an EC2 instance, and ensures the proper AWS // Data Pipeline service charges are applied to your pipeline. @@ -95,9 +94,9 @@ type PollForTaskInput struct { type PollForTaskOutput struct { // The information needed to complete the task that is being assigned to the task - // runner. One of the fields returned in this object is taskId, which contains an + // runner. One of the fields returned in this object is taskId , which contains an // identifier for the task being assigned. The calling task runner uses taskId in - // subsequent calls to ReportTaskProgress and SetTaskStatus. + // subsequent calls to ReportTaskProgress and SetTaskStatus . TaskObject *types.TaskObject // Metadata pertaining to the operation's result. diff --git a/service/datapipeline/api_op_PutPipelineDefinition.go b/service/datapipeline/api_op_PutPipelineDefinition.go index 148fffedc22..9a6a73e85c7 100644 --- a/service/datapipeline/api_op_PutPipelineDefinition.go +++ b/service/datapipeline/api_op_PutPipelineDefinition.go @@ -16,21 +16,14 @@ import ( // validates the configuration as it adds it to the pipeline. Changes to the // pipeline are saved unless one of the following three validation errors exists in // the pipeline. +// - An object is missing a name or identifier field. +// - A string or reference field is empty. +// - The number of objects in the pipeline exceeds the maximum allowed objects. +// - The pipeline is in a FINISHED state. // -// * An object is missing a name or identifier field. -// -// * A string or -// reference field is empty. -// -// * The number of objects in the pipeline exceeds the -// maximum allowed objects. -// -// * The pipeline is in a FINISHED state. -// -// Pipeline -// object definitions are passed to the PutPipelineDefinition action and returned -// by the GetPipelineDefinition action. Example 1 This example sets an valid -// pipeline configuration and returns success. POST / HTTP/1.1 Content-Type: +// Pipeline object definitions are passed to the PutPipelineDefinition action and +// returned by the GetPipelineDefinition action. Example 1 This example sets an +// valid pipeline configuration and returns success. POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.PutPipelineDefinition // Content-Length: 914 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, // 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": @@ -115,11 +108,11 @@ type PutPipelineDefinitionOutput struct { Errored bool // The validation errors that are associated with the objects defined in - // pipelineObjects. + // pipelineObjects . ValidationErrors []types.ValidationError // The validation warnings that are associated with the objects defined in - // pipelineObjects. + // pipelineObjects . ValidationWarnings []types.ValidationWarning // Metadata pertaining to the operation's result. diff --git a/service/datapipeline/api_op_QueryObjects.go b/service/datapipeline/api_op_QueryObjects.go index 1a7cb44ebc2..200291b3170 100644 --- a/service/datapipeline/api_op_QueryObjects.go +++ b/service/datapipeline/api_op_QueryObjects.go @@ -12,15 +12,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Queries the specified pipeline for the names of objects that match the specified -// set of conditions. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 -// X-Amz-Target: DataPipeline.QueryObjects Content-Length: 123 Host: -// datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "query": -// {"selectors": [ ] }, "sphere": "INSTANCE", "marker": "", "limit": 10} -// x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9 Content-Type: -// application/x-amz-json-1.1 Content-Length: 72 Date: Mon, 12 Nov 2012 17:50:53 -// GMT {"hasMoreResults": false, "ids": ["@SayHello_1_2012-09-25T17:00:00"] } +// Queries the specified pipeline for the names of objects that match the +// specified set of conditions. POST / HTTP/1.1 Content-Type: +// application/x-amz-json-1.1 X-Amz-Target: DataPipeline.QueryObjects +// Content-Length: 123 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, +// 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": +// "df-06372391ZG65EXAMPLE", "query": {"selectors": [ ] }, "sphere": "INSTANCE", +// "marker": "", "limit": 10} x-amzn-RequestId: +// 14d704c1-0775-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 +// Content-Length: 72 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": false, +// "ids": ["@SayHello_1_2012-09-25T17:00:00"] } func (c *Client) QueryObjects(ctx context.Context, params *QueryObjectsInput, optFns ...func(*Options)) (*QueryObjectsOutput, error) { if params == nil { params = &QueryObjectsInput{} @@ -45,7 +46,7 @@ type QueryObjectsInput struct { PipelineId *string // Indicates whether the query applies to components or instances. The possible - // values are: COMPONENT, INSTANCE, and ATTEMPT. + // values are: COMPONENT , INSTANCE , and ATTEMPT . // // This member is required. Sphere *string diff --git a/service/datapipeline/api_op_ReportTaskProgress.go b/service/datapipeline/api_op_ReportTaskProgress.go index 015c1eefb58..febafb21ae5 100644 --- a/service/datapipeline/api_op_ReportTaskProgress.go +++ b/service/datapipeline/api_op_ReportTaskProgress.go @@ -11,15 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Task runners call ReportTaskProgress when assigned a task to acknowledge that it -// has the task. If the web service does not receive this acknowledgement within 2 -// minutes, it assigns the task in a subsequent PollForTask call. After this +// Task runners call ReportTaskProgress when assigned a task to acknowledge that +// it has the task. If the web service does not receive this acknowledgement within +// 2 minutes, it assigns the task in a subsequent PollForTask call. After this // initial acknowledgement, the task runner only needs to report progress every 15 // minutes to maintain its ownership of the task. You can change this reporting // time from 15 minutes by specifying a reportProgressTimeout field in your // pipeline. If a task runner does not report its status after 5 minutes, AWS Data // Pipeline assumes that the task runner is unable to process the task and -// reassigns the task in a subsequent response to PollForTask. Task runners should +// reassigns the task in a subsequent response to PollForTask . Task runners should // call ReportTaskProgress every 60 seconds. POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ReportTaskProgress // Content-Length: 832 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, @@ -48,7 +48,7 @@ func (c *Client) ReportTaskProgress(ctx context.Context, params *ReportTaskProgr type ReportTaskProgressInput struct { // The ID of the task assigned to the task runner. This value is provided in the - // response for PollForTask. + // response for PollForTask . // // This member is required. TaskId *string diff --git a/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go b/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go index 4d25b0e1b0e..f18c005c3e3 100644 --- a/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go +++ b/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go @@ -51,10 +51,11 @@ type ReportTaskRunnerHeartbeatInput struct { // The public DNS name of the task runner. Hostname *string - // The type of task the task runner is configured to accept and process. The worker - // group is set as a field on objects in the pipeline when they are created. You - // can only specify a single value for workerGroup. There are no wildcard values - // permitted in workerGroup; the string must be an exact, case-sensitive, match. + // The type of task the task runner is configured to accept and process. The + // worker group is set as a field on objects in the pipeline when they are created. + // You can only specify a single value for workerGroup . There are no wildcard + // values permitted in workerGroup ; the string must be an exact, case-sensitive, + // match. WorkerGroup *string noSmithyDocumentSerde diff --git a/service/datapipeline/api_op_SetStatus.go b/service/datapipeline/api_op_SetStatus.go index cf819334c2c..83aa83c2f04 100644 --- a/service/datapipeline/api_op_SetStatus.go +++ b/service/datapipeline/api_op_SetStatus.go @@ -14,8 +14,8 @@ import ( // be updated in the specified pipeline. This update might not occur immediately, // but is eventually consistent. The status that can be set depends on the type of // object (for example, DataNode or Activity). You cannot perform this operation on -// FINISHED pipelines and attempting to do so returns InvalidRequestException. POST -// / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// FINISHED pipelines and attempting to do so returns InvalidRequestException . +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.SetStatus Content-Length: 100 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT // Authorization: AuthParams {"pipelineId": "df-0634701J7KEXAMPLE", "objectIds": @@ -52,8 +52,8 @@ type SetStatusInput struct { // This member is required. PipelineId *string - // The status to be set on all the objects specified in objectIds. For components, - // use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED. + // The status to be set on all the objects specified in objectIds . For components, + // use PAUSE or RESUME . For instances, use TRY_CANCEL , RERUN , or MARK_FINISHED . // // This member is required. Status *string diff --git a/service/datapipeline/api_op_SetTaskStatus.go b/service/datapipeline/api_op_SetTaskStatus.go index 85b4794313a..3010697ef45 100644 --- a/service/datapipeline/api_op_SetTaskStatus.go +++ b/service/datapipeline/api_op_SetTaskStatus.go @@ -14,8 +14,8 @@ import ( // Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is // completed and provide information about the final status. A task runner makes // this call regardless of whether the task was sucessful. A task runner does not -// need to call SetTaskStatus for tasks that are canceled by the web service during -// a call to ReportTaskProgress. POST / HTTP/1.1 Content-Type: +// need to call SetTaskStatus for tasks that are canceled by the web service +// during a call to ReportTaskProgress . POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.SetTaskStatus // Content-Length: 847 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, // 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"taskId": @@ -42,12 +42,12 @@ func (c *Client) SetTaskStatus(ctx context.Context, params *SetTaskStatusInput, type SetTaskStatusInput struct { // The ID of the task assigned to the task runner. This value is provided in the - // response for PollForTask. + // response for PollForTask . // // This member is required. TaskId *string - // If FINISHED, the task successfully completed. If FAILED, the task ended + // If FINISHED , the task successfully completed. If FAILED , the task ended // unsuccessfully. Preconditions use false. // // This member is required. @@ -59,8 +59,8 @@ type SetTaskStatusInput struct { // reserved by the system. ErrorId *string - // If an error occurred during the task, this value specifies a text description of - // the error. This value is set on the physical attempt object. It is used to + // If an error occurred during the task, this value specifies a text description + // of the error. This value is set on the physical attempt object. It is used to // display error information to the user. The web service does not parse this // value. ErrorMessage *string diff --git a/service/datapipeline/api_op_ValidatePipelineDefinition.go b/service/datapipeline/api_op_ValidatePipelineDefinition.go index 583172a1de1..b8c341facd3 100644 --- a/service/datapipeline/api_op_ValidatePipelineDefinition.go +++ b/service/datapipeline/api_op_ValidatePipelineDefinition.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Validates the specified pipeline definition to ensure that it is well formed and -// can be run without error. Example 1 This example sets an valid pipeline +// Validates the specified pipeline definition to ensure that it is well formed +// and can be run without error. Example 1 This example sets an valid pipeline // configuration and returns success. POST / HTTP/1.1 Content-Type: // application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ValidatePipelineDefinition // Content-Length: 936 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, diff --git a/service/datapipeline/types/enums.go b/service/datapipeline/types/enums.go index 4dc9accd377..f3546d390ca 100644 --- a/service/datapipeline/types/enums.go +++ b/service/datapipeline/types/enums.go @@ -13,9 +13,9 @@ const ( OperatorTypeBetween OperatorType = "BETWEEN" ) -// Values returns all known values for OperatorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OperatorType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OperatorType) Values() []OperatorType { return []OperatorType{ "EQ", diff --git a/service/datapipeline/types/errors.go b/service/datapipeline/types/errors.go index 470097bb8e1..012ecddbee5 100644 --- a/service/datapipeline/types/errors.go +++ b/service/datapipeline/types/errors.go @@ -33,9 +33,9 @@ func (e *InternalServiceError) ErrorCode() string { } func (e *InternalServiceError) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request was not valid. Verify that your request was properly formatted, that -// the signature was generated with the correct credentials, and that you haven't -// exceeded any of the service limits for your account. +// The request was not valid. Verify that your request was properly formatted, +// that the signature was generated with the correct credentials, and that you +// haven't exceeded any of the service limits for your account. type InvalidRequestException struct { Message *string diff --git a/service/datapipeline/types/types.go b/service/datapipeline/types/types.go index 4c3ad0ed863..3749b797c4f 100644 --- a/service/datapipeline/types/types.go +++ b/service/datapipeline/types/types.go @@ -7,8 +7,8 @@ import ( ) // A key-value pair that describes a property of a pipeline object. The value is -// specified as either a string value (StringValue) or a reference to another -// object (RefValue) but not as both. +// specified as either a string value ( StringValue ) or a reference to another +// object ( RefValue ) but not as both. type Field struct { // The field identifier. @@ -27,16 +27,15 @@ type Field struct { // Identity information for the EC2 instance that is hosting the task runner. You // can get this value by calling a metadata URI from the EC2 instance. For more -// information, see Instance Metadata -// (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) +// information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) // in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves // that your task runner is running on an EC2 instance, and ensures the proper AWS // Data Pipeline service charges are applied to your pipeline. type InstanceIdentity struct { - // A description of an EC2 instance that is generated when the instance is launched - // and exposed to the instance via the instance metadata service in the form of a - // JSON representation of an object. + // A description of an EC2 instance that is generated when the instance is + // launched and exposed to the instance via the instance metadata service in the + // form of a JSON representation of an object. Document *string // A signature which can be used to verify the accuracy and authenticity of the @@ -46,57 +45,36 @@ type InstanceIdentity struct { noSmithyDocumentSerde } -// Contains a logical operation for comparing the value of a field with a specified -// value. +// Contains a logical operation for comparing the value of a field with a +// specified value. type Operator struct { - // The logical operation to be performed: equal (EQ), equal reference (REF_EQ), - // less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal - // reference (REF_EQ) can be used only with reference fields. The other comparison - // types can be used only with String fields. The comparison types you can use - // apply only to certain object fields, as detailed below. The comparison operators - // EQ and REF_EQ act on the following fields: - // - // * name - // - // * @sphere - // - // * parent - // - // * - // @componentParent - // - // * @instanceParent - // - // * @status - // - // * @scheduledStartTime - // - // * - // @scheduledEndTime - // - // * @actualStartTime - // - // * @actualEndTime - // - // The comparison - // operators GE, LE, and BETWEEN act on the following fields: - // - // * - // @scheduledStartTime - // - // * @scheduledEndTime - // - // * @actualStartTime - // - // * - // @actualEndTime - // - // Note that fields beginning with the at sign (@) are read-only - // and set by the web service. When you name fields, you should choose names - // containing only alpha-numeric values, as symbols may be reserved by AWS Data - // Pipeline. User-defined fields that you add to a pipeline should prefix their - // name with the string "my". + // The logical operation to be performed: equal ( EQ ), equal reference ( REF_EQ ), + // less than or equal ( LE ), greater than or equal ( GE ), or between ( BETWEEN ). + // Equal reference ( REF_EQ ) can be used only with reference fields. The other + // comparison types can be used only with String fields. The comparison types you + // can use apply only to certain object fields, as detailed below. The comparison + // operators EQ and REF_EQ act on the following fields: + // - name + // - @sphere + // - parent + // - @componentParent + // - @instanceParent + // - @status + // - @scheduledStartTime + // - @scheduledEndTime + // - @actualStartTime + // - @actualEndTime + // The comparison operators GE , LE , and BETWEEN act on the following fields: + // - @scheduledStartTime + // - @scheduledEndTime + // - @actualStartTime + // - @actualEndTime + // Note that fields beginning with the at sign (@) are read-only and set by the + // web service. When you name fields, you should choose names containing only + // alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. + // User-defined fields that you add to a pipeline should prefix their name with the + // string "my". Type OperatorType // The value that the actual field value will be compared with. @@ -167,8 +145,8 @@ type PipelineDescription struct { // This member is required. Name *string - // The pipeline identifier that was assigned by AWS Data Pipeline. This is a string - // of the form df-297EG78HU43EEXAMPLE. + // The pipeline identifier that was assigned by AWS Data Pipeline. This is a + // string of the form df-297EG78HU43EEXAMPLE . // // This member is required. PipelineId *string @@ -177,8 +155,7 @@ type PipelineDescription struct { Description *string // A list of tags to associated with a pipeline. Tags let you control access to - // pipelines. For more information, see Controlling User Access to Pipelines - // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) + // pipelines. For more information, see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. Tags []Tag @@ -189,7 +166,7 @@ type PipelineDescription struct { type PipelineIdName struct { // The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string - // of the form df-297EG78HU43EEXAMPLE. + // of the form df-297EG78HU43EEXAMPLE . Id *string // The name of the pipeline. @@ -241,8 +218,8 @@ type Selector struct { // condition fails. FieldName *string - // Contains a logical operation for comparing the value of a field with a specified - // value. + // Contains a logical operation for comparing the value of a field with a + // specified value. Operator *Operator noSmithyDocumentSerde @@ -250,22 +227,19 @@ type Selector struct { // Tags are key/value pairs defined by a user and associated with a pipeline to // control access. AWS Data Pipeline allows you to associate ten tags per pipeline. -// For more information, see Controlling User Access to Pipelines -// (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) +// For more information, see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. type Tag struct { // The key name of a tag defined by a user. For more information, see Controlling - // User Access to Pipelines - // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) + // User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. // // This member is required. Key *string - // The optional value portion of a tag defined by a user. For more information, see - // Controlling User Access to Pipelines - // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) + // The optional value portion of a tag defined by a user. For more information, + // see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. // // This member is required. @@ -277,8 +251,8 @@ type Tag struct { // Contains information about a pipeline task that is assigned to a task runner. type TaskObject struct { - // The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to - // track how many times a task is attempted. + // The ID of the pipeline task attempt object. AWS Data Pipeline uses this value + // to track how many times a task is attempted. AttemptId *string // Connection information for the location where the task runner will publish the diff --git a/service/datasync/api_client.go b/service/datasync/api_client.go index 29798db613f..475c92e8a7a 100644 --- a/service/datasync/api_client.go +++ b/service/datasync/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/datasync/api_op_CreateAgent.go b/service/datasync/api_op_CreateAgent.go index 9b321a84eee..d225057b760 100644 --- a/service/datasync/api_op_CreateAgent.go +++ b/service/datasync/api_op_CreateAgent.go @@ -47,7 +47,7 @@ type CreateAgentInput struct { // HTTP GET request with redirects that enable you to get the agent IP address // (port 80). Alternatively, you can get it from the DataSync console. The redirect // URL returned in the response provides you the activation key for your agent in - // the query string parameter activationKey. It might also include other + // the query string parameter activationKey . It might also include other // activation-related parameters; however, these are merely defaults. The arguments // you pass to this API call determine the actual configuration of your agent. For // more information, see Activating an Agent in the DataSync User Guide. @@ -59,9 +59,9 @@ type CreateAgentInput struct { // used to identify the agent in the console. AgentName *string - // The ARNs of the security groups used to protect your data transfer task subnets. - // See SecurityGroupArns - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns). + // The ARNs of the security groups used to protect your data transfer task + // subnets. See SecurityGroupArns (https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns) + // . SecurityGroupArns []string // The Amazon Resource Names (ARNs) of the subnets in which DataSync will create @@ -80,13 +80,12 @@ type CreateAgentInput struct { // characters: + - = . _ : / @. Tags []types.TagListEntry - // The ID of the VPC (virtual private cloud) endpoint that the agent has access to. - // This is the client-side VPC endpoint, also called a PrivateLink. If you don't - // have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service - // Configuration - // (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service) + // The ID of the VPC (virtual private cloud) endpoint that the agent has access + // to. This is the client-side VPC endpoint, also called a PrivateLink. If you + // don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service + // Configuration (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service) // in the Amazon VPC User Guide. VPC endpoint ID looks like this: - // vpce-01234d5aff67890e1. + // vpce-01234d5aff67890e1 . VpcEndpointId *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_CreateLocationEfs.go b/service/datasync/api_op_CreateLocationEfs.go index 51fa095d25b..f87f0d6809e 100644 --- a/service/datasync/api_op_CreateLocationEfs.go +++ b/service/datasync/api_op_CreateLocationEfs.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an endpoint for an Amazon EFS file system that DataSync can access for a -// transfer. For more information, see Creating a location for Amazon EFS -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html). +// Creates an endpoint for an Amazon EFS file system that DataSync can access for +// a transfer. For more information, see Creating a location for Amazon EFS (https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html) +// . func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error) { if params == nil { params = &CreateLocationEfsInput{} @@ -32,8 +32,8 @@ func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEf // CreateLocationEfsRequest type CreateLocationEfsInput struct { - // Specifies the subnet and security groups DataSync uses to access your Amazon EFS - // file system. + // Specifies the subnet and security groups DataSync uses to access your Amazon + // EFS file system. // // This member is required. Ec2Config *types.Ec2Config @@ -54,14 +54,14 @@ type CreateLocationEfsInput struct { // Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 // encryption when it copies data to or from the Amazon EFS file system. If you // specify an access point using AccessPointArn or an IAM role using - // FileSystemAccessRoleArn, you must set this parameter to TLS1_2. + // FileSystemAccessRoleArn , you must set this parameter to TLS1_2 . InTransitEncryption types.EfsInTransitEncryption // Specifies a mount path for your Amazon EFS file system. This is where DataSync // reads or writes data (depending on if this is a source or destination location). // By default, DataSync uses the root directory, but you can also include // subdirectories. You must specify a value with forward slashes (for example, - // /path/to/folder). + // /path/to/folder ). Subdirectory *string // Specifies the key-value pair that represents a tag that you want to add to the diff --git a/service/datasync/api_op_CreateLocationFsxLustre.go b/service/datasync/api_op_CreateLocationFsxLustre.go index e7c5980d4ca..70bf43c1a90 100644 --- a/service/datasync/api_op_CreateLocationFsxLustre.go +++ b/service/datasync/api_op_CreateLocationFsxLustre.go @@ -56,8 +56,8 @@ type CreateLocationFsxLustreInput struct { type CreateLocationFsxLustreOutput struct { - // The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's - // created. + // The Amazon Resource Name (ARN) of the FSx for Lustre file system location + // that's created. LocationArn *string // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_CreateLocationFsxOntap.go b/service/datasync/api_op_CreateLocationFsxOntap.go index 8f7df47786d..f2b818710f2 100644 --- a/service/datasync/api_op_CreateLocationFsxOntap.go +++ b/service/datasync/api_op_CreateLocationFsxOntap.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync -// can access for a transfer. For more information, see Creating a location for FSx -// for ONTAP -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html). +// Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that +// DataSync can access for a transfer. For more information, see Creating a +// location for FSx for ONTAP (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html) +// . func (c *Client) CreateLocationFsxOntap(ctx context.Context, params *CreateLocationFsxOntapInput, optFns ...func(*Options)) (*CreateLocationFsxOntapOutput, error) { if params == nil { params = &CreateLocationFsxOntapInput{} @@ -41,21 +41,16 @@ type CreateLocationFsxOntapInput struct { // Specifies the Amazon EC2 security groups that provide access to your file // system's preferred subnet. The security groups must allow outbound traffic on // the following ports (depending on the protocol you use): - // - // * Network File System - // (NFS): TCP ports 111, 635, and 2049 - // - // * Server Message Block (SMB): TCP port - // 445 - // - // Your file system's security groups must also allow inbound traffic on the - // same ports. + // - Network File System (NFS): TCP ports 111, 635, and 2049 + // - Server Message Block (SMB): TCP port 445 + // Your file system's security groups must also allow inbound traffic on the same + // ports. // // This member is required. SecurityGroupArns []string - // Specifies the ARN of the storage virtual machine (SVM) in your file system where - // you want to copy data to or from. + // Specifies the ARN of the storage virtual machine (SVM) in your file system + // where you want to copy data to or from. // // This member is required. StorageVirtualMachineArn *string @@ -63,11 +58,10 @@ type CreateLocationFsxOntapInput struct { // Specifies a path to the file share in the SVM where you'll copy your data. You // can specify a junction path (also known as a mount point), qtree path (for NFS // file shares), or share name (for SMB file shares). For example, your mount path - // might be /vol1, /vol1/tree1, or /share1. Don't specify a junction path in the + // might be /vol1 , /vol1/tree1 , or /share1 . Don't specify a junction path in the // SVM's root volume. For more information, see Managing FSx for ONTAP storage - // virtual machines - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the - // Amazon FSx for NetApp ONTAP User Guide. + // virtual machines (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) + // in the Amazon FSx for NetApp ONTAP User Guide. Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon diff --git a/service/datasync/api_op_CreateLocationFsxOpenZfs.go b/service/datasync/api_op_CreateLocationFsxOpenZfs.go index 042400f616e..18ab7f9de4a 100644 --- a/service/datasync/api_op_CreateLocationFsxOpenZfs.go +++ b/service/datasync/api_op_CreateLocationFsxOpenZfs.go @@ -12,10 +12,9 @@ import ( ) // Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can -// access for a transfer. For more information, see Creating a location for FSx for -// OpenZFS -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html). -// Request parameters related to SMB aren't supported with the +// access for a transfer. For more information, see Creating a location for FSx +// for OpenZFS (https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html) +// . Request parameters related to SMB aren't supported with the // CreateLocationFsxOpenZfs operation. func (c *Client) CreateLocationFsxOpenZfs(ctx context.Context, params *CreateLocationFsxOpenZfsInput, optFns ...func(*Options)) (*CreateLocationFsxOpenZfsOutput, error) { if params == nil { @@ -50,7 +49,7 @@ type CreateLocationFsxOpenZfsInput struct { // This member is required. SecurityGroupArns []string - // A subdirectory in the location's path that must begin with /fsx. DataSync uses + // A subdirectory in the location's path that must begin with /fsx . DataSync uses // this subdirectory to read or write data (depending on whether the file system is // a source or destination location). Subdirectory *string diff --git a/service/datasync/api_op_CreateLocationFsxWindows.go b/service/datasync/api_op_CreateLocationFsxWindows.go index 26a23bc3c9a..83d2e942536 100644 --- a/service/datasync/api_op_CreateLocationFsxWindows.go +++ b/service/datasync/api_op_CreateLocationFsxWindows.go @@ -44,19 +44,16 @@ type CreateLocationFsxWindowsInput struct { // Specifies the ARNs of the security groups that provide access to your file // system's preferred subnet. If you choose a security group that doesn't allow // connections from within itself, do one of the following: - // - // * Configure the - // security group to allow it to communicate within itself. - // - // * Choose a different - // security group that can communicate with the mount target's security group. + // - Configure the security group to allow it to communicate within itself. + // - Choose a different security group that can communicate with the mount + // target's security group. // // This member is required. SecurityGroupArns []string // Specifies the user who has the permissions to access files and folders in the // file system. For information about choosing a user name that ensures sufficient - // permissions to files, folders, and metadata, see user. + // permissions to files, folders, and metadata, see user . // // This member is required. User *string @@ -65,9 +62,9 @@ type CreateLocationFsxWindowsInput struct { // belongs to. Domain *string - // Specifies a mount path for your file system using forward slashes. This is where - // DataSync reads or writes data (depending on if this is a source or destination - // location). + // Specifies a mount path for your file system using forward slashes. This is + // where DataSync reads or writes data (depending on if this is a source or + // destination location). Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon diff --git a/service/datasync/api_op_CreateLocationHdfs.go b/service/datasync/api_op_CreateLocationHdfs.go index 0e157f7b0d9..71ddd9d4ca6 100644 --- a/service/datasync/api_op_CreateLocationHdfs.go +++ b/service/datasync/api_op_CreateLocationHdfs.go @@ -48,26 +48,27 @@ type CreateLocationHdfsInput struct { // This member is required. NameNodes []types.HdfsNameNode - // The size of data blocks to write into the HDFS cluster. The block size must be a - // multiple of 512 bytes. The default block size is 128 mebibytes (MiB). + // The size of data blocks to write into the HDFS cluster. The block size must be + // a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). BlockSize *int32 // The Kerberos key table (keytab) that contains mappings between the defined // Kerberos principal and the encrypted keys. You can load the keytab from a file // by providing the file's address. If you're using the CLI, it performs base64 // encoding for you. Otherwise, provide the base64-encoded text. If KERBEROS is - // specified for AuthenticationType, this parameter is required. + // specified for AuthenticationType , this parameter is required. KerberosKeytab []byte - // The krb5.conf file that contains the Kerberos configuration information. You can - // load the krb5.conf file by providing the file's address. If you're using the - // CLI, it performs the base64 encoding for you. Otherwise, provide the - // base64-encoded text. If KERBEROS is specified for AuthenticationType, this + // The krb5.conf file that contains the Kerberos configuration information. You + // can load the krb5.conf file by providing the file's address. If you're using + // the CLI, it performs the base64 encoding for you. Otherwise, provide the + // base64-encoded text. If KERBEROS is specified for AuthenticationType , this // parameter is required. KerberosKrb5Conf []byte - // The Kerberos principal with access to the files and folders on the HDFS cluster. - // If KERBEROS is specified for AuthenticationType, this parameter is required. + // The Kerberos principal with access to the files and folders on the HDFS + // cluster. If KERBEROS is specified for AuthenticationType , this parameter is + // required. KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). @@ -76,8 +77,8 @@ type CreateLocationHdfsInput struct { // The Quality of Protection (QOP) configuration specifies the Remote Procedure // Call (RPC) and data transfer protection settings configured on the Hadoop // Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, - // RpcProtection and DataTransferProtection default to PRIVACY. If you set - // RpcProtection or DataTransferProtection, the other parameter assumes the same + // RpcProtection and DataTransferProtection default to PRIVACY . If you set + // RpcProtection or DataTransferProtection , the other parameter assumes the same // value. QopConfiguration *types.QopConfiguration @@ -86,16 +87,16 @@ type CreateLocationHdfsInput struct { ReplicationFactor *int32 // The user name used to identify the client on the host operating system. If - // SIMPLE is specified for AuthenticationType, this parameter is required. + // SIMPLE is specified for AuthenticationType , this parameter is required. SimpleUser *string // A subdirectory in the HDFS cluster. This subdirectory is used to read data from // or write data to the HDFS cluster. If the subdirectory isn't specified, it will - // default to /. + // default to / . Subdirectory *string - // The key-value pair that represents the tag that you want to add to the location. - // The value can be an empty string. We recommend using tags to name your + // The key-value pair that represents the tag that you want to add to the + // location. The value can be an empty string. We recommend using tags to name your // resources. Tags []types.TagListEntry diff --git a/service/datasync/api_op_CreateLocationNfs.go b/service/datasync/api_op_CreateLocationNfs.go index 611430cbc65..4421dcd2286 100644 --- a/service/datasync/api_op_CreateLocationNfs.go +++ b/service/datasync/api_op_CreateLocationNfs.go @@ -33,8 +33,7 @@ type CreateLocationNfsInput struct { // Contains a list of Amazon Resource Names (ARNs) of agents that are used to // connect to an NFS server. If you are copying data to or from your Snowcone - // device, see NFS Server on Snowcone - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) + // device, see NFS Server on Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. // // This member is required. @@ -43,8 +42,7 @@ type CreateLocationNfsInput struct { // The name of the NFS server. This value is the IP address or Domain Name Service // (DNS) name of the NFS server. An agent that is installed on-premises uses this // hostname to mount the NFS server in a network. If you are copying data to or - // from your Snowcone device, see NFS Server on Snowcone - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) + // from your Snowcone device, see NFS Server on Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. This name must either be DNS-compliant or must be an IP // version 4 (IPv4) address. // @@ -55,18 +53,17 @@ type CreateLocationNfsInput struct { // source location or write data to the NFS destination. The NFS path should be a // path that's exported by the NFS server, or a subdirectory of that path. The path // should be such that it can be mounted by other NFS clients in your network. To - // see all the paths exported by your NFS server, run "showmount -e - // nfs-server-name" from an NFS client that has access to your server. You can - // specify any directory that appears in the results, and any subdirectory of that - // directory. Ensure that the NFS export is accessible without Kerberos - // authentication. To transfer all the data in the folder you specified, DataSync - // needs to have permissions to read all the data. To ensure this, either configure - // the NFS export with no_root_squash, or ensure that the permissions for all of - // the files that you want DataSync allow read access for all users. Doing either - // enables the agent to read the files. For the agent to access directories, you - // must additionally enable all execute access. If you are copying data to or from - // your Snowcone device, see NFS Server on Snowcone - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) + // see all the paths exported by your NFS server, run " showmount -e nfs-server-name + // " from an NFS client that has access to your server. You can specify any + // directory that appears in the results, and any subdirectory of that directory. + // Ensure that the NFS export is accessible without Kerberos authentication. To + // transfer all the data in the folder you specified, DataSync needs to have + // permissions to read all the data. To ensure this, either configure the NFS + // export with no_root_squash, or ensure that the permissions for all of the files + // that you want DataSync allow read access for all users. Doing either enables the + // agent to read the files. For the agent to access directories, you must + // additionally enable all execute access. If you are copying data to or from your + // Snowcone device, see NFS Server on Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. For information about NFS export configuration, see 18.7. // The /etc/exports Configuration File in the Red Hat Enterprise Linux // documentation. @@ -77,8 +74,8 @@ type CreateLocationNfsInput struct { // The NFS mount options that DataSync can use to mount your NFS share. MountOptions *types.NfsMountOptions - // The key-value pair that represents the tag that you want to add to the location. - // The value can be an empty string. We recommend using tags to name your + // The key-value pair that represents the tag that you want to add to the + // location. The value can be an empty string. We recommend using tags to name your // resources. Tags []types.TagListEntry diff --git a/service/datasync/api_op_CreateLocationObjectStorage.go b/service/datasync/api_op_CreateLocationObjectStorage.go index 294c9e9f915..60b5e2c51ed 100644 --- a/service/datasync/api_op_CreateLocationObjectStorage.go +++ b/service/datasync/api_op_CreateLocationObjectStorage.go @@ -12,8 +12,8 @@ import ( ) // Creates an endpoint for an object storage system that DataSync can access for a -// transfer. For more information, see Creating a location for object storage -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). +// transfer. For more information, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html) +// . func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error) { if params == nil { params = &CreateLocationObjectStorageInput{} @@ -43,8 +43,9 @@ type CreateLocationObjectStorageInput struct { // This member is required. BucketName *string - // Specifies the domain name or IP address of the object storage server. A DataSync - // agent uses this hostname to mount the object storage server in a network. + // Specifies the domain name or IP address of the object storage server. A + // DataSync agent uses this hostname to mount the object storage server in a + // network. // // This member is required. ServerHostname *string @@ -60,9 +61,9 @@ type CreateLocationObjectStorageInput struct { // Specifies a certificate to authenticate with an object storage system that uses // a private or self-signed certificate authority (CA). You must specify a // Base64-encoded .pem file (for example, - // file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up + // file:///home/user/.ssh/storage_sys_certificate.pem ). The certificate can be up // to 32768 bytes (before Base64 encoding). To use this parameter, configure - // ServerProtocol to HTTPS. + // ServerProtocol to HTTPS . ServerCertificate []byte // Specifies the port that your object storage server accepts inbound network diff --git a/service/datasync/api_op_CreateLocationS3.go b/service/datasync/api_op_CreateLocationS3.go index a89a49a6b69..3b0b15d844a 100644 --- a/service/datasync/api_op_CreateLocationS3.go +++ b/service/datasync/api_op_CreateLocationS3.go @@ -12,8 +12,8 @@ import ( ) // Creates an endpoint for an Amazon S3 bucket that DataSync can access for a -// transfer. For more information, see Create an Amazon S3 location -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli). +// transfer. For more information, see Create an Amazon S3 location (https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli) +// . func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error) { if params == nil { params = &CreateLocationS3Input{} @@ -48,27 +48,27 @@ type CreateLocationS3Input struct { // If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon // Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more // information about launching a DataSync agent on an Amazon Web Services Outpost, - // see Deploy your DataSync agent on Outposts - // (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent). + // see Deploy your DataSync agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent) + // . AgentArns []string // The Amazon S3 storage class that you want to store your files in when this // location is used as a task destination. For buckets in Amazon Web Services // Regions, the storage class defaults to Standard. For buckets on Outposts, the // storage class defaults to Amazon Web Services S3 Outposts. For more information - // about S3 storage classes, see Amazon S3 Storage Classes - // (http://aws.amazon.com/s3/storage-classes/). Some storage classes have behaviors - // that can affect your S3 storage cost. For detailed information, see - // Considerations when working with S3 storage classes in DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). + // about S3 storage classes, see Amazon S3 Storage Classes (http://aws.amazon.com/s3/storage-classes/) + // . Some storage classes have behaviors that can affect your S3 storage cost. For + // detailed information, see Considerations when working with S3 storage classes + // in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . S3StorageClass types.S3StorageClass // A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used // to read data from the S3 source location or write data to the S3 destination. Subdirectory *string - // The key-value pair that represents the tag that you want to add to the location. - // The value can be an empty string. We recommend using tags to name your + // The key-value pair that represents the tag that you want to add to the + // location. The value can be an empty string. We recommend using tags to name your // resources. Tags []types.TagListEntry diff --git a/service/datasync/api_op_CreateLocationSmb.go b/service/datasync/api_op_CreateLocationSmb.go index 6b8f92bf820..b5a641a6cc8 100644 --- a/service/datasync/api_op_CreateLocationSmb.go +++ b/service/datasync/api_op_CreateLocationSmb.go @@ -12,8 +12,8 @@ import ( ) // Creates an endpoint for a Server Message Block (SMB) file server that DataSync -// can access for a transfer. For more information, see Creating an SMB location -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html). +// can access for a transfer. For more information, see Creating an SMB location (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html) +// . func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error) { if params == nil { params = &CreateLocationSmbInput{} @@ -40,8 +40,7 @@ type CreateLocationSmbInput struct { // Specifies the password of the user who can mount your SMB file server and has // permission to access the files and folders involved in your transfer. For more - // information, see required permissions - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) + // information, see required permissions (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) // for SMB locations. // // This member is required. @@ -56,11 +55,10 @@ type CreateLocationSmbInput struct { // Specifies the name of the share exported by your SMB file server where DataSync // will read or write data. You can include a subdirectory in the share path (for - // example, /path/to/subdirectory). Make sure that other SMB clients in your + // example, /path/to/subdirectory ). Make sure that other SMB clients in your // network can also mount this path. To copy all data in the specified // subdirectory, DataSync must be able to mount the SMB share and access all of its - // data. For more information, see required permissions - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) + // data. For more information, see required permissions (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) // for SMB locations. // // This member is required. @@ -69,16 +67,14 @@ type CreateLocationSmbInput struct { // Specifies the user name that can mount your SMB file server and has permission // to access the files and folders involved in your transfer. For information about // choosing a user with the right level of access for your transfer, see required - // permissions - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) + // permissions (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) // for SMB locations. // // This member is required. User *string - // Specifies the Windows domain name that your SMB file server belongs to. For more - // information, see required permissions - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) + // Specifies the Windows domain name that your SMB file server belongs to. For + // more information, see required permissions (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) // for SMB locations. Domain *string diff --git a/service/datasync/api_op_CreateTask.go b/service/datasync/api_op_CreateTask.go index 44cd2f9d710..f94158e9159 100644 --- a/service/datasync/api_op_CreateTask.go +++ b/service/datasync/api_op_CreateTask.go @@ -50,12 +50,12 @@ type CreateTaskInput struct { // Specifies a list of filter rules that exclude specific data during your // transfer. For more information and examples, see Filtering data transferred by - // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) . Excludes []types.FilterRule // Specifies a list of filter rules that include specific data during your // transfer. For more information and examples, see Filtering data transferred by - // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) . Includes []types.FilterRule // The name of a task. This value is a text reference that is used to identify the @@ -65,14 +65,14 @@ type CreateTaskInput struct { // Specifies the configuration options for a task. Some options include preserving // file or object metadata and verifying data integrity. You can also override // these options before starting an individual run of a task (also known as a task - // execution). For more information, see StartTaskExecution - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html). + // execution). For more information, see StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) + // . Options *types.Options // Specifies a schedule used to periodically transfer files from a source to a // destination location. The schedule should be specified in UTC time. For more - // information, see Scheduling your task - // (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html). + // information, see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) + // . Schedule *types.TaskSchedule // Specifies the tags that you want to apply to the Amazon Resource Name (ARN) diff --git a/service/datasync/api_op_DeleteAgent.go b/service/datasync/api_op_DeleteAgent.go index b2173e926c4..5ee894060f5 100644 --- a/service/datasync/api_op_DeleteAgent.go +++ b/service/datasync/api_op_DeleteAgent.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an agent. To specify which agent to delete, use the Amazon Resource Name -// (ARN) of the agent in your request. The operation disassociates the agent from -// your Amazon Web Services account. However, it doesn't delete the agent virtual -// machine (VM) from your on-premises environment. +// Deletes an agent. To specify which agent to delete, use the Amazon Resource +// Name (ARN) of the agent in your request. The operation disassociates the agent +// from your Amazon Web Services account. However, it doesn't delete the agent +// virtual machine (VM) from your on-premises environment. func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error) { if params == nil { params = &DeleteAgentInput{} diff --git a/service/datasync/api_op_DescribeLocationEfs.go b/service/datasync/api_op_DescribeLocationEfs.go index 44c859f8165..d611fcf24bb 100644 --- a/service/datasync/api_op_DescribeLocationEfs.go +++ b/service/datasync/api_op_DescribeLocationEfs.go @@ -50,8 +50,8 @@ type DescribeLocationEfsOutput struct { // The time that the location was created. CreationTime *time.Time - // The subnet and security groups that DataSync uses to access your Amazon EFS file - // system. + // The subnet and security groups that DataSync uses to access your Amazon EFS + // file system. Ec2Config *types.Ec2Config // The Identity and Access Management (IAM) role that DataSync assumes when diff --git a/service/datasync/api_op_DescribeLocationFsxOntap.go b/service/datasync/api_op_DescribeLocationFsxOntap.go index a2e1fd0dc76..7665cde3b05 100644 --- a/service/datasync/api_op_DescribeLocationFsxOntap.go +++ b/service/datasync/api_op_DescribeLocationFsxOntap.go @@ -14,7 +14,7 @@ import ( // Provides details about how an DataSync location for an Amazon FSx for NetApp // ONTAP file system is configured. If your location uses SMB, the -// DescribeLocationFsxOntap operation doesn't actually return a Password. +// DescribeLocationFsxOntap operation doesn't actually return a Password . func (c *Client) DescribeLocationFsxOntap(ctx context.Context, params *DescribeLocationFsxOntapInput, optFns ...func(*Options)) (*DescribeLocationFsxOntapOutput, error) { if params == nil { params = &DescribeLocationFsxOntapInput{} diff --git a/service/datasync/api_op_DescribeLocationFsxOpenZfs.go b/service/datasync/api_op_DescribeLocationFsxOpenZfs.go index 45ec72d12e8..5d8b972489d 100644 --- a/service/datasync/api_op_DescribeLocationFsxOpenZfs.go +++ b/service/datasync/api_op_DescribeLocationFsxOpenZfs.go @@ -55,8 +55,8 @@ type DescribeLocationFsxOpenZfsOutput struct { // The type of protocol that DataSync uses to access your file system. Protocol *types.FsxProtocol - // The ARNs of the security groups that are configured for the FSx for OpenZFS file - // system. + // The ARNs of the security groups that are configured for the FSx for OpenZFS + // file system. SecurityGroupArns []string // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeLocationHdfs.go b/service/datasync/api_op_DescribeLocationHdfs.go index 9695a58ad89..cae6f70e1c3 100644 --- a/service/datasync/api_op_DescribeLocationHdfs.go +++ b/service/datasync/api_op_DescribeLocationHdfs.go @@ -53,8 +53,9 @@ type DescribeLocationHdfsOutput struct { // The time that the HDFS location was created. CreationTime *time.Time - // The Kerberos principal with access to the files and folders on the HDFS cluster. - // This parameter is used if the AuthenticationType is defined as KERBEROS. + // The Kerberos principal with access to the files and folders on the HDFS + // cluster. This parameter is used if the AuthenticationType is defined as KERBEROS + // . KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). @@ -79,7 +80,7 @@ type DescribeLocationHdfsOutput struct { ReplicationFactor *int32 // The user name used to identify the client on the host operating system. This - // parameter is used if the AuthenticationType is defined as SIMPLE. + // parameter is used if the AuthenticationType is defined as SIMPLE . SimpleUser *string // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeLocationObjectStorage.go b/service/datasync/api_op_DescribeLocationObjectStorage.go index f3e62693b91..d514cd13d3c 100644 --- a/service/datasync/api_op_DescribeLocationObjectStorage.go +++ b/service/datasync/api_op_DescribeLocationObjectStorage.go @@ -63,8 +63,8 @@ type DescribeLocationObjectStorageOutput struct { // your object storage system. ServerCertificate []byte - // The port that your object storage server accepts inbound network traffic on (for - // example, port 443). + // The port that your object storage server accepts inbound network traffic on + // (for example, port 443). ServerPort *int32 // The protocol that your object storage system uses to communicate. diff --git a/service/datasync/api_op_DescribeLocationS3.go b/service/datasync/api_op_DescribeLocationS3.go index c29e4f3e4c8..58cb0753e4d 100644 --- a/service/datasync/api_op_DescribeLocationS3.go +++ b/service/datasync/api_op_DescribeLocationS3.go @@ -42,11 +42,11 @@ type DescribeLocationS3Input struct { // DescribeLocationS3Response type DescribeLocationS3Output struct { - // If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource - // Name (ARNs) of the EC2 agents deployed on your Outpost. For more information - // about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy - // your DataSync agent on Outposts - // (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent). + // If you are using DataSync on an Amazon Web Services Outpost, the Amazon + // Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more + // information about launching a DataSync agent on an Amazon Web Services Outpost, + // see Deploy your DataSync agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent) + // . AgentArns []string // The time that the Amazon S3 bucket location was created. @@ -65,11 +65,11 @@ type DescribeLocationS3Output struct { // The Amazon S3 storage class that you chose to store your files in when this // location is used as a task destination. For more information about S3 storage - // classes, see Amazon S3 Storage Classes - // (http://aws.amazon.com/s3/storage-classes/). Some storage classes have behaviors - // that can affect your S3 storage cost. For detailed information, see - // Considerations when working with S3 storage classes in DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). + // classes, see Amazon S3 Storage Classes (http://aws.amazon.com/s3/storage-classes/) + // . Some storage classes have behaviors that can affect your S3 storage cost. For + // detailed information, see Considerations when working with S3 storage classes + // in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . S3StorageClass types.S3StorageClass // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeTask.go b/service/datasync/api_op_DescribeTask.go index 2c917ac82b0..5199a668914 100644 --- a/service/datasync/api_op_DescribeTask.go +++ b/service/datasync/api_op_DescribeTask.go @@ -58,26 +58,26 @@ type DescribeTaskOutput struct { DestinationLocationArn *string // The Amazon Resource Names (ARNs) of the network interfaces created for your - // destination location. For more information, see Network interface requirements - // (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces). + // destination location. For more information, see Network interface requirements (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) + // . DestinationNetworkInterfaceArns []string // Errors that DataSync encountered during execution of the task. You can use this // error code to help troubleshoot issues. ErrorCode *string - // Detailed description of an error that was encountered during the task execution. - // You can use this information to help troubleshoot issues. + // Detailed description of an error that was encountered during the task + // execution. You can use this information to help troubleshoot issues. ErrorDetail *string - // A list of filter rules that exclude specific data during your transfer. For more - // information and examples, see Filtering data transferred by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // A list of filter rules that exclude specific data during your transfer. For + // more information and examples, see Filtering data transferred by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) + // . Excludes []types.FilterRule - // A list of filter rules that include specific data during your transfer. For more - // information and examples, see Filtering data transferred by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // A list of filter rules that include specific data during your transfer. For + // more information and examples, see Filtering data transferred by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) + // . Includes []types.FilterRule // The name of the task that was described. @@ -86,8 +86,8 @@ type DescribeTaskOutput struct { // The configuration options that control the behavior of the StartTaskExecution // operation. Some options include preserving file or object metadata and verifying // data integrity. You can override these options for each task execution. For more - // information, see StartTaskExecution - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html). + // information, see StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) + // . Options *types.Options // The schedule used to periodically transfer files from a source to a destination @@ -98,8 +98,8 @@ type DescribeTaskOutput struct { SourceLocationArn *string // The Amazon Resource Names (ARNs) of the network interfaces created for your - // source location. For more information, see Network interface requirements - // (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces). + // source location. For more information, see Network interface requirements (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) + // . SourceNetworkInterfaceArns []string // The status of the task that was described. For detailed information about task diff --git a/service/datasync/api_op_DescribeTaskExecution.go b/service/datasync/api_op_DescribeTaskExecution.go index 7c555603c8e..53a3976d562 100644 --- a/service/datasync/api_op_DescribeTaskExecution.go +++ b/service/datasync/api_op_DescribeTaskExecution.go @@ -48,7 +48,7 @@ type DescribeTaskExecutionOutput struct { BytesCompressed int64 // The total number of bytes that are involved in the transfer. For the number of - // bytes sent over the network, see BytesCompressed. + // bytes sent over the network, see BytesCompressed . BytesTransferred int64 // The number of logical bytes written to the destination Amazon Web Services @@ -66,24 +66,24 @@ type DescribeTaskExecutionOutput struct { // destination locations and finding the delta that needs to be transferred. EstimatedFilesToTransfer int64 - // A list of filter rules that exclude specific data during your transfer. For more - // information and examples, see Filtering data transferred by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // A list of filter rules that exclude specific data during your transfer. For + // more information and examples, see Filtering data transferred by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) + // . Excludes []types.FilterRule // The actual number of files that was transferred over the network. This value is // calculated and updated on an ongoing basis during the TRANSFERRING phase of the // task execution. It's updated periodically when each file is read from the source // and sent over the network. If failures occur during a transfer, this value can - // be less than EstimatedFilesToTransfer. In some cases, this value can also be - // greater than EstimatedFilesToTransfer. This element is implementation-specific + // be less than EstimatedFilesToTransfer . In some cases, this value can also be + // greater than EstimatedFilesToTransfer . This element is implementation-specific // for some location types, so don't use it as an indicator for a correct file // number or to monitor your task execution. FilesTransferred int64 - // A list of filter rules that include specific data during your transfer. For more - // information and examples, see Filtering data transferred by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // A list of filter rules that include specific data during your transfer. For + // more information and examples, see Filtering data transferred by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) + // . Includes []types.FilterRule // Configures your DataSync task settings. These options include how DataSync @@ -108,7 +108,7 @@ type DescribeTaskExecutionOutput struct { // executed. For example, a TaskExecution value with the ARN // arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b // executed the task with the ARN - // arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2. + // arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2 . TaskExecutionArn *string // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_ListAgents.go b/service/datasync/api_op_ListAgents.go index 901d1444bab..bd1f82940e8 100644 --- a/service/datasync/api_op_ListAgents.go +++ b/service/datasync/api_op_ListAgents.go @@ -19,12 +19,11 @@ import ( // specify in your next request to fetch the next page of agents. ListAgents is // eventually consistent. This means the result of running the operation might not // reflect that you just created or deleted an agent. For example, if you create an -// agent with CreateAgent -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html) and -// then immediately run ListAgents, that agent might not show up in the list right -// away. In situations like this, you can always confirm whether an agent has been -// created (or deleted) by using DescribeAgent -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html). +// agent with CreateAgent (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html) +// and then immediately run ListAgents , that agent might not show up in the list +// right away. In situations like this, you can always confirm whether an agent has +// been created (or deleted) by using DescribeAgent (https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html) +// . func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error) { if params == nil { params = &ListAgentsInput{} @@ -47,8 +46,8 @@ type ListAgentsInput struct { // default, a response shows a maximum of 100 agents. MaxResults *int32 - // Specifies an opaque string that indicates the position to begin the next list of - // results in the response. + // Specifies an opaque string that indicates the position to begin the next list + // of results in the response. NextToken *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_ListLocations.go b/service/datasync/api_op_ListLocations.go index d7ccd042503..980599b9b55 100644 --- a/service/datasync/api_op_ListLocations.go +++ b/service/datasync/api_op_ListLocations.go @@ -35,8 +35,9 @@ func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, type ListLocationsInput struct { // You can use API filters to narrow down the list of resources returned by - // ListLocations. For example, to retrieve all tasks on a specific source location, - // you can use ListLocations with filter name LocationType S3 and Operator Equals. + // ListLocations . For example, to retrieve all tasks on a specific source + // location, you can use ListLocations with filter name LocationType S3 and + // Operator Equals . Filters []types.LocationFilter // The maximum number of locations to return. diff --git a/service/datasync/api_op_ListTagsForResource.go b/service/datasync/api_op_ListTagsForResource.go index eddab26cbcb..96f6d262af2 100644 --- a/service/datasync/api_op_ListTagsForResource.go +++ b/service/datasync/api_op_ListTagsForResource.go @@ -40,8 +40,8 @@ type ListTagsForResourceInput struct { // Specifies how many results that you want in the response. MaxResults *int32 - // Specifies an opaque string that indicates the position to begin the next list of - // results in the response. + // Specifies an opaque string that indicates the position to begin the next list + // of results in the response. NextToken *string noSmithyDocumentSerde @@ -126,8 +126,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/datasync/api_op_ListTasks.go b/service/datasync/api_op_ListTasks.go index 6fa97473782..b89e0e1e5cf 100644 --- a/service/datasync/api_op_ListTasks.go +++ b/service/datasync/api_op_ListTasks.go @@ -32,9 +32,9 @@ func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns . type ListTasksInput struct { // You can use API filters to narrow down the list of resources returned by - // ListTasks. For example, to retrieve all tasks on a specific source location, you - // can use ListTasks with filter name LocationId and Operator Equals with the ARN - // for the location. + // ListTasks . For example, to retrieve all tasks on a specific source location, + // you can use ListTasks with filter name LocationId and Operator Equals with the + // ARN for the location. Filters []types.TaskFilter // The maximum number of tasks to return. diff --git a/service/datasync/api_op_StartTaskExecution.go b/service/datasync/api_op_StartTaskExecution.go index 0b8e1af091b..b8ae7a804d0 100644 --- a/service/datasync/api_op_StartTaskExecution.go +++ b/service/datasync/api_op_StartTaskExecution.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an DataSync task. For each task, you can only run one task execution at a -// time. There are several phases to a task execution. For more information, see -// Task execution statuses -// (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses). +// Starts an DataSync task. For each task, you can only run one task execution at +// a time. There are several phases to a task execution. For more information, see +// Task execution statuses (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses) +// . func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error) { if params == nil { params = &StartTaskExecutionInput{} @@ -41,13 +41,13 @@ type StartTaskExecutionInput struct { // Specifies a list of filter rules that determines which files to exclude from a // task. The list contains a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example, - // "/folder1|/folder2". + // "/folder1|/folder2" . Excludes []types.FilterRule // Specifies a list of filter rules that determines which files to include when // running a task. The pattern should contain a single filter string that consists // of the patterns to include. The patterns are delimited by "|" (that is, a pipe), - // for example, "/folder1|/folder2". + // for example, "/folder1|/folder2" . Includes []types.FilterRule // Configures your DataSync task settings. These options include how DataSync diff --git a/service/datasync/api_op_UpdateLocationHdfs.go b/service/datasync/api_op_UpdateLocationHdfs.go index a19ecf90d71..877555baacf 100644 --- a/service/datasync/api_op_UpdateLocationHdfs.go +++ b/service/datasync/api_op_UpdateLocationHdfs.go @@ -50,9 +50,9 @@ type UpdateLocationHdfsInput struct { // for you. Otherwise, provide the base64-encoded text. KerberosKeytab []byte - // The krb5.conf file that contains the Kerberos configuration information. You can - // load the krb5.conf file by providing the file's address. If you're using the - // CLI, it performs the base64 encoding for you. Otherwise, provide the + // The krb5.conf file that contains the Kerberos configuration information. You + // can load the krb5.conf file by providing the file's address. If you're using + // the CLI, it performs the base64 encoding for you. Otherwise, provide the // base64-encoded text. KerberosKrb5Conf []byte diff --git a/service/datasync/api_op_UpdateLocationNfs.go b/service/datasync/api_op_UpdateLocationNfs.go index 52aa931036a..50abc7c5db3 100644 --- a/service/datasync/api_op_UpdateLocationNfs.go +++ b/service/datasync/api_op_UpdateLocationNfs.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates some of the parameters of a previously created location for Network File -// System (NFS) access. For information about creating an NFS location, see -// Creating a location for NFS -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html). +// Updates some of the parameters of a previously created location for Network +// File System (NFS) access. For information about creating an NFS location, see +// Creating a location for NFS (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html) +// . func (c *Client) UpdateLocationNfs(ctx context.Context, params *UpdateLocationNfsInput, optFns ...func(*Options)) (*UpdateLocationNfsOutput, error) { if params == nil { params = &UpdateLocationNfsInput{} @@ -48,18 +48,17 @@ type UpdateLocationNfsInput struct { // source location or write data to the NFS destination. The NFS path should be a // path that's exported by the NFS server, or a subdirectory of that path. The path // should be such that it can be mounted by other NFS clients in your network. To - // see all the paths exported by your NFS server, run "showmount -e - // nfs-server-name" from an NFS client that has access to your server. You can - // specify any directory that appears in the results, and any subdirectory of that - // directory. Ensure that the NFS export is accessible without Kerberos - // authentication. To transfer all the data in the folder that you specified, - // DataSync must have permissions to read all the data. To ensure this, either - // configure the NFS export with no_root_squash, or ensure that the files you want - // DataSync to access have permissions that allow read access for all users. Doing - // either option enables the agent to read the files. For the agent to access - // directories, you must additionally enable all execute access. If you are copying - // data to or from your Snowcone device, see NFS Server on Snowcone - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) + // see all the paths exported by your NFS server, run " showmount -e nfs-server-name + // " from an NFS client that has access to your server. You can specify any + // directory that appears in the results, and any subdirectory of that directory. + // Ensure that the NFS export is accessible without Kerberos authentication. To + // transfer all the data in the folder that you specified, DataSync must have + // permissions to read all the data. To ensure this, either configure the NFS + // export with no_root_squash , or ensure that the files you want DataSync to + // access have permissions that allow read access for all users. Doing either + // option enables the agent to read the files. For the agent to access directories, + // you must additionally enable all execute access. If you are copying data to or + // from your Snowcone device, see NFS Server on Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. For information about NFS export configuration, see 18.7. // The /etc/exports Configuration File in the Red Hat Enterprise Linux // documentation. diff --git a/service/datasync/api_op_UpdateLocationObjectStorage.go b/service/datasync/api_op_UpdateLocationObjectStorage.go index b2165e9dd22..61950b9d026 100644 --- a/service/datasync/api_op_UpdateLocationObjectStorage.go +++ b/service/datasync/api_op_UpdateLocationObjectStorage.go @@ -13,8 +13,8 @@ import ( // Updates some parameters of an existing object storage location that DataSync // accesses for a transfer. For information about creating a self-managed object -// storage location, see Creating a location for object storage -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). +// storage location, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html) +// . func (c *Client) UpdateLocationObjectStorage(ctx context.Context, params *UpdateLocationObjectStorageInput, optFns ...func(*Options)) (*UpdateLocationObjectStorageOutput, error) { if params == nil { params = &UpdateLocationObjectStorageInput{} @@ -52,9 +52,9 @@ type UpdateLocationObjectStorageInput struct { // Specifies a certificate to authenticate with an object storage system that uses // a private or self-signed certificate authority (CA). You must specify a // Base64-encoded .pem file (for example, - // file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up + // file:///home/user/.ssh/storage_sys_certificate.pem ). The certificate can be up // to 32768 bytes (before Base64 encoding). To use this parameter, configure - // ServerProtocol to HTTPS. Updating the certificate doesn't interfere with tasks + // ServerProtocol to HTTPS . Updating the certificate doesn't interfere with tasks // that you have in progress. ServerCertificate []byte diff --git a/service/datasync/api_op_UpdateLocationSmb.go b/service/datasync/api_op_UpdateLocationSmb.go index 06aa49d1a7a..29cd548271d 100644 --- a/service/datasync/api_op_UpdateLocationSmb.go +++ b/service/datasync/api_op_UpdateLocationSmb.go @@ -13,8 +13,8 @@ import ( // Updates some of the parameters of a previously created location for Server // Message Block (SMB) file system access. For information about creating an SMB -// location, see Creating a location for SMB -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html). +// location, see Creating a location for SMB (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html) +// . func (c *Client) UpdateLocationSmb(ctx context.Context, params *UpdateLocationSmbInput, optFns ...func(*Options)) (*UpdateLocationSmbOutput, error) { if params == nil { params = &UpdateLocationSmbInput{} @@ -57,25 +57,20 @@ type UpdateLocationSmbInput struct { // path that's exported by the SMB server, or a subdirectory of that path. The path // should be such that it can be mounted by other SMB clients in your network. // Subdirectory must be specified with forward slashes. For example, - // /path/to/folder. To transfer all the data in the folder that you specified, + // /path/to/folder . To transfer all the data in the folder that you specified, // DataSync must have permissions to mount the SMB share and to access all the data // in that share. To ensure this, do either of the following: - // - // * Ensure that the - // user/password specified belongs to the user who can mount the share and who has - // the appropriate permissions for all of the files and directories that you want - // DataSync to access. - // - // * Use credentials of a member of the Backup Operators group - // to mount the share. - // - // Doing either of these options enables the agent to access - // the data. For the agent to access directories, you must also enable all execute - // access. + // - Ensure that the user/password specified belongs to the user who can mount + // the share and who has the appropriate permissions for all of the files and + // directories that you want DataSync to access. + // - Use credentials of a member of the Backup Operators group to mount the + // share. + // Doing either of these options enables the agent to access the data. For the + // agent to access directories, you must also enable all execute access. Subdirectory *string - // The user who can mount the share has the permissions to access files and folders - // in the SMB share. + // The user who can mount the share has the permissions to access files and + // folders in the SMB share. User *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_UpdateTask.go b/service/datasync/api_op_UpdateTask.go index 229bb6afe34..0e4120a879b 100644 --- a/service/datasync/api_op_UpdateTask.go +++ b/service/datasync/api_op_UpdateTask.go @@ -35,18 +35,18 @@ type UpdateTaskInput struct { // This member is required. TaskArn *string - // The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log - // group. + // The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch + // log group. CloudWatchLogGroupArn *string // Specifies a list of filter rules that exclude specific data during your // transfer. For more information and examples, see Filtering data transferred by - // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) . Excludes []types.FilterRule // Specifies a list of filter rules that include specific data during your // transfer. For more information and examples, see Filtering data transferred by - // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). + // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) . Includes []types.FilterRule // The name of the task to update. @@ -63,8 +63,8 @@ type UpdateTaskInput struct { // destination location. You can configure your task to execute hourly, daily, // weekly or on specific days of the week. You control when in the day or hour you // want the task to execute. The time you specify is UTC time. For more - // information, see Scheduling your task - // (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html). + // information, see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) + // . Schedule *types.TaskSchedule noSmithyDocumentSerde diff --git a/service/datasync/api_op_UpdateTaskExecution.go b/service/datasync/api_op_UpdateTaskExecution.go index 781ff4b69ee..0b8662e1b46 100644 --- a/service/datasync/api_op_UpdateTaskExecution.go +++ b/service/datasync/api_op_UpdateTaskExecution.go @@ -13,10 +13,9 @@ import ( // Updates execution of a task. You can modify bandwidth throttling for a task // execution that is running or queued. For more information, see Adjusting -// Bandwidth Throttling for a Task Execution -// (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling). -// The only Option that can be modified by UpdateTaskExecution is BytesPerSecond -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond). +// Bandwidth Throttling for a Task Execution (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling) +// . The only Option that can be modified by UpdateTaskExecution is BytesPerSecond (https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) +// . func (c *Client) UpdateTaskExecution(ctx context.Context, params *UpdateTaskExecutionInput, optFns ...func(*Options)) (*UpdateTaskExecutionOutput, error) { if params == nil { params = &UpdateTaskExecutionInput{} diff --git a/service/datasync/doc.go b/service/datasync/doc.go index 8e8d0fec1a8..58286c132a3 100644 --- a/service/datasync/doc.go +++ b/service/datasync/doc.go @@ -8,6 +8,6 @@ // storage services. You also can use DataSync to transfer data between other cloud // providers and Amazon Web Services storage services. This API interface reference // includes documentation for using DataSync programmatically. For complete -// information, see the DataSync User Guide -// (https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html) . +// information, see the DataSync User Guide (https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html) +// . package datasync diff --git a/service/datasync/types/enums.go b/service/datasync/types/enums.go index 283226c9c0f..961771356ce 100644 --- a/service/datasync/types/enums.go +++ b/service/datasync/types/enums.go @@ -28,8 +28,8 @@ const ( AtimeBestEffort Atime = "BEST_EFFORT" ) -// Values returns all known values for Atime. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Atime. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Atime) Values() []Atime { return []Atime{ @@ -65,9 +65,9 @@ const ( EndpointTypeFips EndpointType = "FIPS" ) -// Values returns all known values for EndpointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndpointType) Values() []EndpointType { return []EndpointType{ "PUBLIC", @@ -224,8 +224,8 @@ const ( MtimePreserve Mtime = "PRESERVE" ) -// Values returns all known values for Mtime. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Mtime. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Mtime) Values() []Mtime { return []Mtime{ @@ -547,9 +547,9 @@ const ( TaskQueueingDisabled TaskQueueing = "DISABLED" ) -// Values returns all known values for TaskQueueing. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TaskQueueing. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TaskQueueing) Values() []TaskQueueing { return []TaskQueueing{ "ENABLED", @@ -589,9 +589,9 @@ const ( TransferModeAll TransferMode = "ALL" ) -// Values returns all known values for TransferMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TransferMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TransferMode) Values() []TransferMode { return []TransferMode{ "CHANGED", diff --git a/service/datasync/types/types.go b/service/datasync/types/types.go index 56dc41a69b6..923a788f659 100644 --- a/service/datasync/types/types.go +++ b/service/datasync/types/types.go @@ -7,8 +7,7 @@ import ( ) // Represents a single entry in a list (or array) of DataSync agents when you call -// the ListAgents -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) +// the ListAgents (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) // operation. type AgentListEntry struct { @@ -18,15 +17,15 @@ type AgentListEntry struct { // The name of an agent. Name *string - // The status of an agent. For more information, see DataSync agent statuses - // (https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html). + // The status of an agent. For more information, see DataSync agent statuses (https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html) + // . Status AgentStatus noSmithyDocumentSerde } -// The subnet and security groups that DataSync uses to access your Amazon EFS file -// system. +// The subnet and security groups that DataSync uses to access your Amazon EFS +// file system. type Ec2Config struct { // Specifies the Amazon Resource Names (ARNs) of the security groups associated @@ -35,19 +34,12 @@ type Ec2Config struct { // This member is required. SecurityGroupArns []string - // Specifies the ARN of a subnet where DataSync creates the network interfaces - // (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) + // Specifies the ARN of a subnet where DataSync creates the network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) // for managing traffic during your transfer. The subnet must be located: - // - // * In the - // same virtual private cloud (VPC) as the Amazon EFS file system. - // - // * In the same - // Availability Zone as at least one mount target for the Amazon EFS file - // system. - // - // You don't need to specify a subnet that includes a file system mount - // target. + // - In the same virtual private cloud (VPC) as the Amazon EFS file system. + // - In the same Availability Zone as at least one mount target for the Amazon + // EFS file system. + // You don't need to specify a subnet that includes a file system mount target. // // This member is required. SubnetArn *string @@ -59,8 +51,8 @@ type Ec2Config struct { // transferring files from source to destination. type FilterRule struct { - // The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule - // type. + // The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN + // rule type. FilterType FilterType // A single filter string that consists of the patterns to include or exclude. The @@ -99,8 +91,8 @@ type FsxProtocolNfs struct { // Specifies the Server Message Block (SMB) protocol configuration that DataSync // uses to access your Amazon FSx for NetApp ONTAP file system. For more -// information, see Accessing FSx for ONTAP file systems -// (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access). +// information, see Accessing FSx for ONTAP file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access) +// . type FsxProtocolSmb struct { // Specifies the password of a user who has permission to access your SVM. @@ -108,32 +100,23 @@ type FsxProtocolSmb struct { // This member is required. Password *string - // Specifies a user name that can mount the location and access the files, folders, - // and metadata that you need in the SVM. If you provide a user in your Active - // Directory, note the following: - // - // * If you're using Directory Service for - // Microsoft Active Directory, the user must be a member of the Amazon Web Services - // Delegated FSx Administrators group. - // - // * If you're using a self-managed Active - // Directory, the user must be a member of either the Domain Admins group or a - // custom group that you specified for file system administration when you created - // your file system. - // - // Make sure that the user has the permissions it needs to copy - // the data you want: - // - // * SE_TCB_NAME: Required to set object ownership and file - // metadata. With this privilege, you also can copy NTFS discretionary access lists - // (DACLs). - // - // * SE_SECURITY_NAME: May be needed to copy NTFS system access control - // lists (SACLs). This operation specifically requires the Windows privilege, which - // is granted to members of the Domain Admins group. If you configure your task to - // copy SACLs, make sure that the user has the required privileges. For information - // about copying SACLs, see Ownership and permissions-related options - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions). + // Specifies a user name that can mount the location and access the files, + // folders, and metadata that you need in the SVM. If you provide a user in your + // Active Directory, note the following: + // - If you're using Directory Service for Microsoft Active Directory, the user + // must be a member of the Amazon Web Services Delegated FSx Administrators group. + // - If you're using a self-managed Active Directory, the user must be a member + // of either the Domain Admins group or a custom group that you specified for file + // system administration when you created your file system. + // Make sure that the user has the permissions it needs to copy the data you want: + // - SE_TCB_NAME : Required to set object ownership and file metadata. With this + // privilege, you also can copy NTFS discretionary access lists (DACLs). + // - SE_SECURITY_NAME : May be needed to copy NTFS system access control lists + // (SACLs). This operation specifically requires the Windows privilege, which is + // granted to members of the Domain Admins group. If you configure your task to + // copy SACLs, make sure that the user has the required privileges. For information + // about copying SACLs, see Ownership and permissions-related options (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions) + // . // // This member is required. User *string @@ -170,21 +153,21 @@ type HdfsNameNode struct { noSmithyDocumentSerde } -// Narrow down the list of resources returned by ListLocations. For example, to see -// all your Amazon S3 locations, create a filter using "Name": "LocationType", -// "Operator": "Equals", and "Values": "S3". For more information, see filtering -// resources -// (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html). +// Narrow down the list of resources returned by ListLocations . For example, to +// see all your Amazon S3 locations, create a filter using "Name": "LocationType" , +// "Operator": "Equals" , and "Values": "S3" . For more information, see filtering +// resources (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html) +// . type LocationFilter struct { - // The name of the filter being used. Each API call supports a list of filters that - // are available for it (for example, LocationType for ListLocations). + // The name of the filter being used. Each API call supports a list of filters + // that are available for it (for example, LocationType for ListLocations ). // // This member is required. Name LocationFilterName // The operator that is used to compare filter values (for example, Equals or - // Contains). + // Contains ). // // This member is required. Operator Operator @@ -199,24 +182,22 @@ type LocationFilter struct { } // Represents a single entry in a list of locations. LocationListEntry returns an -// array that contains a list of locations when the ListLocations -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) +// array that contains a list of locations when the ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) // operation is called. type LocationListEntry struct { - // The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or - // Amazon EFS, the location is the export path. For Amazon S3, the location is the - // prefix path that you want to mount and use as the root of the location. + // The Amazon Resource Name (ARN) of the location. For Network File System (NFS) + // or Amazon EFS, the location is the export path. For Amazon S3, the location is + // the prefix path that you want to mount and use as the root of the location. LocationArn *string // Represents a list of URIs of a location. LocationUri returns an array that - // contains a list of locations when the ListLocations - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) - // operation is called. Format: TYPE://GLOBAL_ID/SUBDIR. TYPE designates the type - // of location (for example, nfs or s3). GLOBAL_ID is the globally unique + // contains a list of locations when the ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) + // operation is called. Format: TYPE://GLOBAL_ID/SUBDIR . TYPE designates the type + // of location (for example, nfs or s3 ). GLOBAL_ID is the globally unique // identifier of the resource that backs the location. An example for EFS is - // us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as - // myBucket. An example for NFS is a valid IPv4 address or a hostname that is + // us-east-2.fs-abcd1234 . An example for Amazon S3 is the bucket name, such as + // myBucket . An example for NFS is a valid IPv4 address or a hostname that is // compliant with Domain Name Service (DNS). SUBDIR is a valid file system path, // delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, // it's the export path to mount the location. For Amazon S3, it's the prefix path @@ -232,23 +213,16 @@ type NfsMountOptions struct { // Specifies the NFS version that you want DataSync to use when mounting your NFS // share. If the server refuses to use the version specified, the task fails. You // can specify the following options: - // - // * AUTOMATIC (default): DataSync chooses NFS - // version 4.1. - // - // * NFS3: Stateless protocol version that allows for asynchronous - // writes on the server. - // - // * NFSv4_0: Stateful, firewall-friendly protocol version - // that supports delegations and pseudo file systems. - // - // * NFSv4_1: Stateful protocol - // version that supports sessions, directory delegations, and parallel data - // processing. NFS version 4.1 also includes all features available in version - // 4.0. - // - // DataSync currently only supports NFS version 3 with Amazon FSx for NetApp - // ONTAP locations. + // - AUTOMATIC (default): DataSync chooses NFS version 4.1. + // - NFS3 : Stateless protocol version that allows for asynchronous writes on the + // server. + // - NFSv4_0 : Stateful, firewall-friendly protocol version that supports + // delegations and pseudo file systems. + // - NFSv4_1 : Stateful protocol version that supports sessions, directory + // delegations, and parallel data processing. NFS version 4.1 also includes all + // features available in version 4.0. + // DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP + // locations. Version NfsVersion noSmithyDocumentSerde @@ -274,41 +248,40 @@ type OnPremConfig struct { type Options struct { // Specifies whether to preserve metadata indicating the last time a file was read - // or written to. If you set Atime to BEST_EFFORT, DataSync attempts to preserve + // or written to. If you set Atime to BEST_EFFORT , DataSync attempts to preserve // the original Atime attribute on all source files (that is, the version before // the PREPARING phase of the task execution). The behavior of Atime isn't fully // standard across platforms, so DataSync can only do this on a best-effort basis. - // Default value: BEST_EFFORTBEST_EFFORT: Attempt to preserve the per-file Atime - // value (recommended). NONE: Ignore Atime. If Atime is set to BEST_EFFORT, Mtime - // must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. + // Default value: BEST_EFFORT BEST_EFFORT : Attempt to preserve the per-file Atime + // value (recommended). NONE : Ignore Atime . If Atime is set to BEST_EFFORT , + // Mtime must be set to PRESERVE . If Atime is set to NONE , Mtime must also be + // NONE . Atime Atime // Limits the bandwidth used by a DataSync task. For example, if you want DataSync - // to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). + // to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024 ). BytesPerSecond *int64 // Specifies the POSIX group ID (GID) of the file's owners. For more information, - // see Metadata copied by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). - // Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: - // Preserve the integer value of user ID (UID) and GID (recommended). NONE: Ignore - // UID and GID. + // see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) + // . Default value: INT_VALUE . This preserves the integer value of the ID. + // INT_VALUE : Preserve the integer value of user ID (UID) and GID (recommended). + // NONE : Ignore UID and GID. Gid Gid // Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs - // log group. To specify the log group, see CloudWatchLogGroupArn - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn). - // If you set LogLevel to OFF, no logs are published. BASIC publishes logs on + // log group. To specify the log group, see CloudWatchLogGroupArn (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) + // . If you set LogLevel to OFF , no logs are published. BASIC publishes logs on // errors for individual files transferred. TRANSFER publishes logs for every file // or object that is transferred and integrity checked. LogLevel LogLevel // Specifies whether to preserve metadata indicating the last time that a file was // written to before the PREPARING phase of your task execution. This option is - // required when you need to run the a task more than once. Default Value: - // PRESERVEPRESERVE: Preserve original Mtime (recommended) NONE: Ignore Mtime. If - // Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to - // NONE, Atime must also be set to NONE. + // required when you need to run the a task more than once. Default Value: PRESERVE + // PRESERVE : Preserve original Mtime (recommended) NONE : Ignore Mtime . If Mtime + // is set to PRESERVE , Atime must be set to BEST_EFFORT . If Mtime is set to NONE + // , Atime must also be set to NONE . Mtime Mtime // Specifies whether object tags are preserved when transferring between object @@ -317,36 +290,34 @@ type Options struct { ObjectTags ObjectTags // Specifies whether data at the destination location should be overwritten or - // preserved. If set to NEVER, a destination file for example will not be replaced + // preserved. If set to NEVER , a destination file for example will not be replaced // by a source file (even if the destination file differs from the source file). If // you modify files in the destination and you sync the files, you can use this // value to protect against overwriting those changes. Some storage classes have // specific behaviors that can affect your Amazon S3 storage cost. For detailed // information, see Considerations when working with Amazon S3 storage classes in - // DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). + // DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . OverwriteMode OverwriteMode - // Specifies which users or groups can access a file for a specific purpose such as - // reading, writing, or execution of the file. For more information, see Metadata - // copied by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). - // Default value: PRESERVEPRESERVE: Preserve POSIX-style permissions (recommended). - // NONE: Ignore permissions. DataSync can preserve extant permissions of a source - // location. + // Specifies which users or groups can access a file for a specific purpose such + // as reading, writing, or execution of the file. For more information, see + // Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) + // . Default value: PRESERVE PRESERVE : Preserve POSIX-style permissions + // (recommended). NONE : Ignore permissions. DataSync can preserve extant + // permissions of a source location. PosixPermissions PosixPermissions // Specifies whether files in the destination location that don't exist in the // source should be preserved. This option can affect your Amazon S3 storage cost. // If your task deletes objects, you might incur minimum storage duration charges // for certain storage classes. For detailed information, see Considerations when - // working with Amazon S3 storage classes in DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). - // Default value: PRESERVEPRESERVE: Ignore such destination files (recommended). - // REMOVE: Delete destination files that aren’t present in the source. If you set - // this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer - // all data, DataSync doesn't scan your destination location and doesn't know what - // to delete. + // working with Amazon S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . Default value: PRESERVE PRESERVE : Ignore such destination files + // (recommended). REMOVE : Delete destination files that aren’t present in the + // source. If you set this parameter to REMOVE , you can't set TransferMode to ALL + // . When you transfer all data, DataSync doesn't scan your destination location + // and doesn't know what to delete. PreserveDeletedFiles PreserveDeletedFiles // Specifies whether DataSync should preserve the metadata of block and character @@ -354,86 +325,75 @@ type Options struct { // metadata on the destination. DataSync copies only the name and metadata of such // devices. DataSync can't copy the actual contents of these devices because // they're nonterminal and don't return an end-of-file (EOF) marker. Default value: - // NONENONE: Ignore special devices (recommended). PRESERVE: Preserve character and - // block device metadata. This option currently isn't supported for Amazon EFS. + // NONE NONE : Ignore special devices (recommended). PRESERVE : Preserve character + // and block device metadata. This option currently isn't supported for Amazon EFS. PreserveDevices PreserveDevices - // Specifies which components of the SMB security descriptor are copied from source - // to destination objects. This value is only used for transfers between SMB and - // Amazon FSx for Windows File Server locations or between two FSx for Windows File - // Server locations. For more information, see how DataSync handles metadata - // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html). - // Default value: OWNER_DACLOWNER_DACL: For each copied object, DataSync copies the - // following metadata: - // - // * The object owner. - // - // * NTFS discretionary access control - // lists (DACLs), which determine whether to grant access to an object. DataSync - // won't copy NTFS system access control lists (SACLs) with this - // option. - // - // OWNER_DACL_SACL: For each copied object, DataSync copies the following + // Specifies which components of the SMB security descriptor are copied from + // source to destination objects. This value is only used for transfers between SMB + // and Amazon FSx for Windows File Server locations or between two FSx for Windows + // File Server locations. For more information, see how DataSync handles metadata (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html) + // . Default value: OWNER_DACL OWNER_DACL : For each copied object, DataSync copies + // the following metadata: + // - The object owner. + // - NTFS discretionary access control lists (DACLs), which determine whether to + // grant access to an object. DataSync won't copy NTFS system access control lists + // (SACLs) with this option. + // OWNER_DACL_SACL : For each copied object, DataSync copies the following // metadata: - // - // * The object owner. - // - // * NTFS discretionary access control lists - // (DACLs), which determine whether to grant access to an object. - // - // * SACLs, which - // are used by administrators to log attempts to access a secured object. Copying - // SACLs requires granting additional permissions to the Windows user that DataSync - // uses to access your SMB location. For information about choosing a user that - // ensures sufficient permissions to files, folders, and metadata, see user. - // - // NONE: - // None of the SMB security descriptor components are copied. Destination objects - // are owned by the user that was provided for accessing the destination location. - // DACLs and SACLs are set based on the destination server’s configuration. + // - The object owner. + // - NTFS discretionary access control lists (DACLs), which determine whether to + // grant access to an object. + // - SACLs, which are used by administrators to log attempts to access a secured + // object. Copying SACLs requires granting additional permissions to the Windows + // user that DataSync uses to access your SMB location. For information about + // choosing a user that ensures sufficient permissions to files, folders, and + // metadata, see user . + // NONE : None of the SMB security descriptor components are copied. Destination + // objects are owned by the user that was provided for accessing the destination + // location. DACLs and SACLs are set based on the destination server’s + // configuration. SecurityDescriptorCopyFlags SmbSecurityDescriptorCopyFlags - // Specifies whether tasks should be queued before executing the tasks. The default - // is ENABLED, which means the tasks will be queued. If you use the same agent to - // run multiple tasks, you can enable the tasks to run in series. For more - // information, see Queueing task executions - // (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution). + // Specifies whether tasks should be queued before executing the tasks. The + // default is ENABLED , which means the tasks will be queued. If you use the same + // agent to run multiple tasks, you can enable the tasks to run in series. For more + // information, see Queueing task executions (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution) + // . TaskQueueing TaskQueueing // Determines whether DataSync transfers only the data and metadata that differ // between the source and the destination location or transfers all the content - // from the source (without comparing what's in the destination). CHANGED: DataSync - // copies only data or metadata that is new or different content from the source - // location to the destination location. ALL: DataSync copies all source location - // content to the destination (without comparing what's in the destination). + // from the source (without comparing what's in the destination). CHANGED : + // DataSync copies only data or metadata that is new or different content from the + // source location to the destination location. ALL : DataSync copies all source + // location content to the destination (without comparing what's in the + // destination). TransferMode TransferMode - // Specifies the POSIX user ID (UID) of the file's owner. For more information, see - // Metadata copied by DataSync - // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). - // Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: - // Preserve the integer value of UID and group ID (GID) (recommended). NONE: Ignore - // UID and GID. + // Specifies the POSIX user ID (UID) of the file's owner. For more information, + // see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) + // . Default value: INT_VALUE . This preserves the integer value of the ID. + // INT_VALUE : Preserve the integer value of UID and group ID (GID) (recommended). + // NONE : Ignore UID and GID. Uid Uid // Specifies how and when DataSync checks the integrity of your data during a - // transfer. Default value: POINT_IN_TIME_CONSISTENTONLY_FILES_TRANSFERRED + // transfer. Default value: POINT_IN_TIME_CONSISTENT ONLY_FILES_TRANSFERRED // (recommended): DataSync calculates the checksum of transferred files and // metadata at the source location. At the end of the transfer, DataSync then // compares this checksum to the checksum calculated on those files at the // destination. We recommend this option when transferring to S3 Glacier Flexible // Retrieval or S3 Glacier Deep Archive storage classes. For more information, see - // Storage class considerations with Amazon S3 locations - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). - // POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync scans the entire - // source and destination to verify that both locations are fully synchronized. You - // can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 - // Glacier Deep Archive storage classes. For more information, see Storage class - // considerations with Amazon S3 locations - // (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). - // NONE: DataSync doesn't run additional verification at the end of the transfer. - // All data transmissions are still integrity-checked with checksum verification - // during the transfer. + // Storage class considerations with Amazon S3 locations (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . POINT_IN_TIME_CONSISTENT : At the end of the transfer, DataSync scans the + // entire source and destination to verify that both locations are fully + // synchronized. You can't use this option when transferring to S3 Glacier Flexible + // Retrieval or S3 Glacier Deep Archive storage classes. For more information, see + // Storage class considerations with Amazon S3 locations (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) + // . NONE : DataSync doesn't run additional verification at the end of the + // transfer. All data transmissions are still integrity-checked with checksum + // verification during the transfer. VerifyMode VerifyMode noSmithyDocumentSerde @@ -444,9 +404,8 @@ type Options struct { type PrivateLinkConfig struct { // The private endpoint that is configured for an agent that has access to IP - // addresses in a PrivateLink - // (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html). An - // agent that is configured with this endpoint will not be accessible over the + // addresses in a PrivateLink (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html) + // . An agent that is configured with this endpoint will not be accessible over the // public internet. PrivateLinkEndpoint *string @@ -455,8 +414,8 @@ type PrivateLinkConfig struct { // access to a VPC endpoint. SecurityGroupArns []string - // The Amazon Resource Names (ARNs) of the subnets that are configured for an agent - // activated in a VPC or an agent that has access to a VPC endpoint. + // The Amazon Resource Names (ARNs) of the subnets that are configured for an + // agent activated in a VPC or an agent that has access to a VPC endpoint. SubnetArns []string // The ID of the VPC endpoint that is configured for an agent. An agent that is @@ -506,26 +465,17 @@ type SmbMountOptions struct { // specific SMB version, but we recommend doing this only if DataSync has trouble // negotiating with the SMB file server automatically. These are the following // options for configuring the SMB version: - // - // * AUTOMATIC (default): DataSync and - // the SMB file server negotiate a protocol version that they mutually support. - // (DataSync supports SMB versions 1.0 and later.) This is the recommended option. - // If you instead choose a specific version that your file server doesn't support, - // you may get an Operation Not Supported error. - // - // * SMB3: Restricts the protocol - // negotiation to only SMB version 3.0.2. - // - // * SMB2: Restricts the protocol - // negotiation to only SMB version 2.1. - // - // * SMB2_0: Restricts the protocol - // negotiation to only SMB version 2.0. - // - // * SMB1: Restricts the protocol negotiation - // to only SMB version 1.0. The SMB1 option isn't available when creating an Amazon - // FSx for NetApp ONTAP location - // (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html). + // - AUTOMATIC (default): DataSync and the SMB file server negotiate a protocol + // version that they mutually support. (DataSync supports SMB versions 1.0 and + // later.) This is the recommended option. If you instead choose a specific version + // that your file server doesn't support, you may get an Operation Not Supported + // error. + // - SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2. + // - SMB2 : Restricts the protocol negotiation to only SMB version 2.1. + // - SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0. + // - SMB1 : Restricts the protocol negotiation to only SMB version 1.0. The SMB1 + // option isn't available when creating an Amazon FSx for NetApp ONTAP location (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html) + // . Version SmbVersion noSmithyDocumentSerde @@ -548,8 +498,7 @@ type TagListEntry struct { // Represents a single entry in a list of task executions. TaskExecutionListEntry // returns an array that contains a list of specific invocations of a task when the -// ListTaskExecutions -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) +// ListTaskExecutions (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) // operation is called. type TaskExecutionListEntry struct { @@ -562,17 +511,17 @@ type TaskExecutionListEntry struct { noSmithyDocumentSerde } -// Describes the detailed result of a TaskExecution operation. This result includes -// the time in milliseconds spent in each phase, the status of the task execution, -// and the errors encountered. +// Describes the detailed result of a TaskExecution operation. This result +// includes the time in milliseconds spent in each phase, the status of the task +// execution, and the errors encountered. type TaskExecutionResultDetail struct { // Errors that DataSync encountered during execution of the task. You can use this // error code to help troubleshoot issues. ErrorCode *string - // Detailed description of an error that was encountered during the task execution. - // You can use this information to help troubleshoot issues. + // Detailed description of an error that was encountered during the task + // execution. You can use this information to help troubleshoot issues. ErrorDetail *string // The total time in milliseconds that DataSync spent in the PREPARING phase. @@ -601,20 +550,20 @@ type TaskExecutionResultDetail struct { } // You can use API filters to narrow down the list of resources returned by -// ListTasks. For example, to retrieve all tasks on a source location, you can use +// ListTasks . For example, to retrieve all tasks on a source location, you can use // ListTasks with filter name LocationId and Operator Equals with the ARN for the -// location. For more information, see filtering DataSync resources -// (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html). +// location. For more information, see filtering DataSync resources (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html) +// . type TaskFilter struct { - // The name of the filter being used. Each API call supports a list of filters that - // are available for it. For example, LocationId for ListTasks. + // The name of the filter being used. Each API call supports a list of filters + // that are available for it. For example, LocationId for ListTasks . // // This member is required. Name TaskFilterName // The operator that is used to compare filter values (for example, Equals or - // Contains). + // Contains ). // // This member is required. Operator Operator @@ -629,8 +578,7 @@ type TaskFilter struct { } // Represents a single entry in a list of tasks. TaskListEntry returns an array -// that contains a list of tasks when the ListTasks -// (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) +// that contains a list of tasks when the ListTasks (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) // operation is called. A task includes the source and destination file systems to // sync and the options to use for the tasks. type TaskListEntry struct { @@ -648,8 +596,8 @@ type TaskListEntry struct { } // Specifies the schedule you want your task to use for repeated executions. For -// more information, see Schedule Expressions for Rules -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html). +// more information, see Schedule Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) +// . type TaskSchedule struct { // A cron expression that specifies when DataSync initiates a scheduled transfer diff --git a/service/dax/api_client.go b/service/dax/api_client.go index a3d01b0cf52..6bf6596d824 100644 --- a/service/dax/api_client.go +++ b/service/dax/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/dax/api_op_CreateCluster.go b/service/dax/api_op_CreateCluster.go index 25ab7cb403b..bd1966aa152 100644 --- a/service/dax/api_op_CreateCluster.go +++ b/service/dax/api_op_CreateCluster.go @@ -32,14 +32,9 @@ type CreateClusterInput struct { // The cluster identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * A name must contain from 1 to 20 alphanumeric characters or - // hyphens. - // - // * The first character must be a letter. - // - // * A name cannot end with a - // hyphen or contain two consecutive hyphens. + // - A name must contain from 1 to 20 alphanumeric characters or hyphens. + // - The first character must be a letter. + // - A name cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. ClusterName *string @@ -61,7 +56,7 @@ type CreateClusterInput struct { // you can create a multiple node cluster with one or more read replicas. To do // this, set ReplicationFactor to a number between 3 (one primary and two read // replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones - // parameter is provided, its length must equal the ReplicationFactor. AWS + // parameter is provided, its length must equal the ReplicationFactor . AWS // recommends that you have at least two read replicas per cluster. // // This member is required. @@ -74,11 +69,8 @@ type CreateClusterInput struct { AvailabilityZones []string // The type of encryption the cluster's endpoint should support. Values are: - // - // * - // NONE for no encryption - // - // * TLS for Transport Layer Security + // - NONE for no encryption + // - TLS for Transport Layer Security ClusterEndpointEncryptionType types.ClusterEndpointEncryptionType // A description of the cluster. @@ -95,25 +87,16 @@ type CreateClusterInput struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:05:00-sun:09:00 If you don't specify a preferred maintenance window when you - // create or modify a cache cluster, DAX assigns a 60-minute maintenance window on - // a randomly selected day of the week. + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:05:00-sun:09:00 If you don't specify a preferred maintenance + // window when you create or modify a cache cluster, DAX assigns a 60-minute + // maintenance window on a randomly selected day of the week. PreferredMaintenanceWindow *string // Represents the settings used to enable server-side encryption on the cluster. diff --git a/service/dax/api_op_DeleteParameterGroup.go b/service/dax/api_op_DeleteParameterGroup.go index d9bda6a011d..17faf071152 100644 --- a/service/dax/api_op_DeleteParameterGroup.go +++ b/service/dax/api_op_DeleteParameterGroup.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified parameter group. You cannot delete a parameter group if it -// is associated with any DAX clusters. +// Deletes the specified parameter group. You cannot delete a parameter group if +// it is associated with any DAX clusters. func (c *Client) DeleteParameterGroup(ctx context.Context, params *DeleteParameterGroupInput, optFns ...func(*Options)) (*DeleteParameterGroupOutput, error) { if params == nil { params = &DeleteParameterGroupInput{} diff --git a/service/dax/api_op_DeleteSubnetGroup.go b/service/dax/api_op_DeleteSubnetGroup.go index 414ce54c384..494d7e1591f 100644 --- a/service/dax/api_op_DeleteSubnetGroup.go +++ b/service/dax/api_op_DeleteSubnetGroup.go @@ -39,8 +39,8 @@ type DeleteSubnetGroupInput struct { type DeleteSubnetGroupOutput struct { - // A user-specified message for this action (i.e., a reason for deleting the subnet - // group). + // A user-specified message for this action (i.e., a reason for deleting the + // subnet group). DeletionMessage *string // Metadata pertaining to the operation's result. diff --git a/service/dax/api_op_DescribeClusters.go b/service/dax/api_op_DescribeClusters.go index 0d974dd545e..55c7e32fe44 100644 --- a/service/dax/api_op_DescribeClusters.go +++ b/service/dax/api_op_DescribeClusters.go @@ -43,14 +43,14 @@ type DescribeClustersInput struct { ClusterNames []string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string noSmithyDocumentSerde diff --git a/service/dax/api_op_DescribeDefaultParameters.go b/service/dax/api_op_DescribeDefaultParameters.go index 7e594bfa227..c045c8c0bf2 100644 --- a/service/dax/api_op_DescribeDefaultParameters.go +++ b/service/dax/api_op_DescribeDefaultParameters.go @@ -30,14 +30,14 @@ func (c *Client) DescribeDefaultParameters(ctx context.Context, params *Describe type DescribeDefaultParametersInput struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string noSmithyDocumentSerde diff --git a/service/dax/api_op_DescribeEvents.go b/service/dax/api_op_DescribeEvents.go index 776a081cc86..8071fbf449a 100644 --- a/service/dax/api_op_DescribeEvents.go +++ b/service/dax/api_op_DescribeEvents.go @@ -37,19 +37,19 @@ type DescribeEventsInput struct { // The number of minutes' worth of events to retrieve. Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. EndTime *time.Time // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The identifier of the event source for which events will be returned. If not @@ -60,8 +60,8 @@ type DescribeEventsInput struct { // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/dax/api_op_DescribeParameterGroups.go b/service/dax/api_op_DescribeParameterGroups.go index 1435f29f2cc..4951238131a 100644 --- a/service/dax/api_op_DescribeParameterGroups.go +++ b/service/dax/api_op_DescribeParameterGroups.go @@ -31,14 +31,14 @@ func (c *Client) DescribeParameterGroups(ctx context.Context, params *DescribePa type DescribeParameterGroupsInput struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The names of the parameter groups. @@ -52,8 +52,8 @@ type DescribeParameterGroupsOutput struct { // Provides an identifier to allow retrieval of paginated results. NextToken *string - // An array of parameter groups. Each element in the array represents one parameter - // group. + // An array of parameter groups. Each element in the array represents one + // parameter group. ParameterGroups []types.ParameterGroup // Metadata pertaining to the operation's result. diff --git a/service/dax/api_op_DescribeParameters.go b/service/dax/api_op_DescribeParameters.go index d562d6d6c60..0ca58848d4b 100644 --- a/service/dax/api_op_DescribeParameters.go +++ b/service/dax/api_op_DescribeParameters.go @@ -35,14 +35,14 @@ type DescribeParametersInput struct { ParameterGroupName *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // How the parameter is defined. For example, system denotes a system-defined diff --git a/service/dax/api_op_DescribeSubnetGroups.go b/service/dax/api_op_DescribeSubnetGroups.go index a4cc78d6a36..aa62c4b5c43 100644 --- a/service/dax/api_op_DescribeSubnetGroups.go +++ b/service/dax/api_op_DescribeSubnetGroups.go @@ -31,14 +31,14 @@ func (c *Client) DescribeSubnetGroups(ctx context.Context, params *DescribeSubne type DescribeSubnetGroupsInput struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. The value for MaxResults must be between - // 20 and 100. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. The value for MaxResults must be + // between 20 and 100. MaxResults *int32 // An optional token returned from a prior request. Use this token for pagination // of results from this action. If this parameter is specified, the response - // includes only results beyond the token, up to the value specified by MaxResults. + // includes only results beyond the token, up to the value specified by MaxResults . NextToken *string // The name of the subnet group. diff --git a/service/dax/api_op_ListTags.go b/service/dax/api_op_ListTags.go index 0521db4dc4f..d316c95d4de 100644 --- a/service/dax/api_op_ListTags.go +++ b/service/dax/api_op_ListTags.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all of the tags for a DAX cluster. You can call ListTags up to 10 times per -// second, per account. +// List all of the tags for a DAX cluster. You can call ListTags up to 10 times +// per second, per account. func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} diff --git a/service/dax/api_op_RebootNode.go b/service/dax/api_op_RebootNode.go index 4ef73a07b74..7b57deca3c3 100644 --- a/service/dax/api_op_RebootNode.go +++ b/service/dax/api_op_RebootNode.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reboots a single node of a DAX cluster. The reboot action takes place as soon as -// possible. During the reboot, the node status is set to REBOOTING. RebootNode +// Reboots a single node of a DAX cluster. The reboot action takes place as soon +// as possible. During the reboot, the node status is set to REBOOTING. RebootNode // restarts the DAX engine process and does not remove the contents of the cache. func (c *Client) RebootNode(ctx context.Context, params *RebootNodeInput, optFns ...func(*Options)) (*RebootNodeOutput, error) { if params == nil { diff --git a/service/dax/api_op_UpdateCluster.go b/service/dax/api_op_UpdateCluster.go index 7c51e02485c..5899eb3602b 100644 --- a/service/dax/api_op_UpdateCluster.go +++ b/service/dax/api_op_UpdateCluster.go @@ -51,7 +51,7 @@ type UpdateClusterInput struct { ParameterGroupName *string // A range of time when maintenance of DAX cluster software will be performed. For - // example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 + // example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 // minutes, and is performed automatically within the maintenance window. PreferredMaintenanceWindow *string diff --git a/service/dax/api_op_UpdateParameterGroup.go b/service/dax/api_op_UpdateParameterGroup.go index edb4db4a70e..bcf8afdbf21 100644 --- a/service/dax/api_op_UpdateParameterGroup.go +++ b/service/dax/api_op_UpdateParameterGroup.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a parameter group. You can modify up to 20 parameters -// in a single request by submitting a list parameter name and value pairs. +// Modifies the parameters of a parameter group. You can modify up to 20 +// parameters in a single request by submitting a list parameter name and value +// pairs. func (c *Client) UpdateParameterGroup(ctx context.Context, params *UpdateParameterGroupInput, optFns ...func(*Options)) (*UpdateParameterGroupOutput, error) { if params == nil { params = &UpdateParameterGroupInput{} @@ -38,8 +39,8 @@ type UpdateParameterGroupInput struct { // An array of name-value pairs for the parameters in the group. Each element in // the array represents a single parameter. record-ttl-millis and query-ttl-millis // are the only supported parameter names. For more details, see Configuring TTL - // Settings - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl). + // Settings (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl) + // . // // This member is required. ParameterNameValues []types.ParameterNameValue diff --git a/service/dax/types/enums.go b/service/dax/types/enums.go index 0fe9560c27d..1b1dd882921 100644 --- a/service/dax/types/enums.go +++ b/service/dax/types/enums.go @@ -48,9 +48,9 @@ const ( IsModifiableConditional IsModifiable = "CONDITIONAL" ) -// Values returns all known values for IsModifiable. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IsModifiable. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IsModifiable) Values() []IsModifiable { return []IsModifiable{ "TRUE", @@ -107,9 +107,9 @@ const ( SSEStatusDisabled SSEStatus = "DISABLED" ) -// Values returns all known values for SSEStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SSEStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SSEStatus) Values() []SSEStatus { return []SSEStatus{ "ENABLING", diff --git a/service/dax/types/errors.go b/service/dax/types/errors.go index 6c56304be02..10a8f3b512a 100644 --- a/service/dax/types/errors.go +++ b/service/dax/types/errors.go @@ -88,8 +88,8 @@ func (e *ClusterQuotaForCustomerExceededFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There are not enough system resources to create the cluster you requested (or to -// resize an already-existing cluster). +// There are not enough system resources to create the cluster you requested (or +// to resize an already-existing cluster). type InsufficientClusterCapacityFault struct { Message *string @@ -481,9 +481,9 @@ func (e *ServiceLinkedRoleNotFoundFault) ErrorCode() string { } func (e *ServiceLinkedRoleNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have reached the maximum number of x509 certificates that can be created for -// encrypted clusters in a 30 day period. Contact AWS customer support to discuss -// options for continuing to create encrypted clusters. +// You have reached the maximum number of x509 certificates that can be created +// for encrypted clusters in a 30 day period. Contact AWS customer support to +// discuss options for continuing to create encrypted clusters. type ServiceQuotaExceededException struct { Message *string diff --git a/service/dax/types/types.go b/service/dax/types/types.go index 9dba5656fdb..05ffe84e9c8 100644 --- a/service/dax/types/types.go +++ b/service/dax/types/types.go @@ -23,9 +23,7 @@ type Cluster struct { ClusterDiscoveryEndpoint *Endpoint // The type of encryption supported by the cluster's endpoint. Values are: - // - // * NONE - // for no encryption TLS for Transport Layer Security + // - NONE for no encryption TLS for Transport Layer Security ClusterEndpointEncryptionType ClusterEndpointEncryptionType // The name of the DAX cluster. @@ -58,7 +56,7 @@ type Cluster struct { ParameterGroup *ParameterGroupStatus // A range of time when maintenance of DAX cluster software will be performed. For - // example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 + // example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 // minutes, and is performed automatically within the maintenance window. PreferredMaintenanceWindow *string @@ -138,11 +136,11 @@ type Node struct { // A system-generated identifier for the node. NodeId *string - // The current status of the node. For example: available. + // The current status of the node. For example: available . NodeStatus *string // The status of the parameter group associated with this node. For example, - // in-sync. + // in-sync . ParameterGroupStatus *string noSmithyDocumentSerde @@ -183,11 +181,11 @@ type Parameter struct { AllowedValues *string // The conditions under which changes to this parameter can be applied. For - // example, requires-reboot indicates that a new value for this parameter will only - // take effect if a node is rebooted. + // example, requires-reboot indicates that a new value for this parameter will + // only take effect if a node is rebooted. ChangeType ChangeType - // The data type of the parameter. For example, integer: + // The data type of the parameter. For example, integer : DataType *string // A description of the parameter @@ -202,8 +200,8 @@ type Parameter struct { // The name of the parameter. ParameterName *string - // Determines whether the parameter can be applied to any nodes, or only nodes of a - // particular type. + // Determines whether the parameter can be applied to any nodes, or only nodes of + // a particular type. ParameterType ParameterType // The value for the parameter. @@ -272,17 +270,10 @@ type SecurityGroupMembership struct { type SSEDescription struct { // The current state of server-side encryption: - // - // * ENABLING - Server-side - // encryption is being enabled. - // - // * ENABLED - Server-side encryption is enabled. - // - // * - // DISABLING - Server-side encryption is being disabled. - // - // * DISABLED - Server-side - // encryption is disabled. + // - ENABLING - Server-side encryption is being enabled. + // - ENABLED - Server-side encryption is enabled. + // - DISABLING - Server-side encryption is being disabled. + // - DISABLED - Server-side encryption is disabled. Status SSEStatus noSmithyDocumentSerde @@ -314,11 +305,8 @@ type Subnet struct { } // Represents the output of one of the following actions: -// -// * CreateSubnetGroup -// -// * -// ModifySubnetGroup +// - CreateSubnetGroup +// - ModifySubnetGroup type SubnetGroup struct { // The description of the subnet group. @@ -336,11 +324,11 @@ type SubnetGroup struct { noSmithyDocumentSerde } -// A description of a tag. Every tag is a key-value pair. You can add up to 50 tags -// to a single DAX cluster. AWS-assigned tag names and values are automatically -// assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names -// do not count towards the tag limit of 50. User-assigned tag names have the -// prefix user:. You cannot backdate the application of a tag. +// A description of a tag. Every tag is a key-value pair. You can add up to 50 +// tags to a single DAX cluster. AWS-assigned tag names and values are +// automatically assigned the aws: prefix, which the user cannot assign. +// AWS-assigned tag names do not count towards the tag limit of 50. User-assigned +// tag names have the prefix user: . You cannot backdate the application of a tag. type Tag struct { // The key for the tag. Tag keys are case sensitive. Every DAX cluster can only diff --git a/service/detective/api_client.go b/service/detective/api_client.go index a80d74b5918..fe78b08c616 100644 --- a/service/detective/api_client.go +++ b/service/detective/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/detective/api_op_AcceptInvitation.go b/service/detective/api_op_AcceptInvitation.go index 05421eab1ed..2f2e83074cc 100644 --- a/service/detective/api_op_AcceptInvitation.go +++ b/service/detective/api_op_AcceptInvitation.go @@ -13,7 +13,7 @@ import ( // Accepts an invitation for the member account to contribute data to a behavior // graph. This operation can only be called by an invited member account. The // request provides the ARN of behavior graph. The member account status in the -// graph must be INVITED. +// graph must be INVITED . func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationInput, optFns ...func(*Options)) (*AcceptInvitationOutput, error) { if params == nil { params = &AcceptInvitationInput{} @@ -32,7 +32,7 @@ func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationI type AcceptInvitationInput struct { // The ARN of the behavior graph that the member account is accepting the - // invitation for. The member account status in the behavior graph must be INVITED. + // invitation for. The member account status in the behavior graph must be INVITED . // // This member is required. GraphArn *string diff --git a/service/detective/api_op_CreateGraph.go b/service/detective/api_op_CreateGraph.go index 0d381d5aa41..fbc7b4ada50 100644 --- a/service/detective/api_op_CreateGraph.go +++ b/service/detective/api_op_CreateGraph.go @@ -22,8 +22,8 @@ import ( // the new behavior graph. CreateGraph triggers a process to create the // corresponding data tables for the new behavior graph. An account can only be the // administrator account for one behavior graph within a Region. If the same -// account calls CreateGraph with the same administrator account, it always returns -// the same behavior graph ARN. It does not create a new behavior graph. +// account calls CreateGraph with the same administrator account, it always +// returns the same behavior graph ARN. It does not create a new behavior graph. func (c *Client) CreateGraph(ctx context.Context, params *CreateGraphInput, optFns ...func(*Options)) (*CreateGraphOutput, error) { if params == nil { params = &CreateGraphInput{} diff --git a/service/detective/api_op_CreateMembers.go b/service/detective/api_op_CreateMembers.go index d4b6dc11e41..9fb095e185a 100644 --- a/service/detective/api_op_CreateMembers.go +++ b/service/detective/api_op_CreateMembers.go @@ -12,29 +12,26 @@ import ( ) // CreateMembers is used to send invitations to accounts. For the organization -// behavior graph, the Detective administrator account uses CreateMembers to enable -// organization accounts as member accounts. For invited accounts, CreateMembers -// sends a request to invite the specified Amazon Web Services accounts to be -// member accounts in the behavior graph. This operation can only be called by the -// administrator account for a behavior graph. CreateMembers verifies the accounts -// and then invites the verified accounts. The administrator can optionally specify -// to not send invitation emails to the member accounts. This would be used when -// the administrator manages their member accounts centrally. For organization -// accounts in the organization behavior graph, CreateMembers attempts to enable -// the accounts. The organization accounts do not receive invitations. The request -// provides the behavior graph ARN and the list of accounts to invite or to enable. -// The response separates the requested accounts into two lists: -// -// * The accounts -// that CreateMembers was able to process. For invited accounts, includes member -// accounts that are being verified, that have passed verification and are to be -// invited, and that have failed verification. For organization accounts in the -// organization behavior graph, includes accounts that can be enabled and that -// cannot be enabled. -// -// * The accounts that CreateMembers was unable to process. -// This list includes accounts that were already invited to be member accounts in -// the behavior graph. +// behavior graph, the Detective administrator account uses CreateMembers to +// enable organization accounts as member accounts. For invited accounts, +// CreateMembers sends a request to invite the specified Amazon Web Services +// accounts to be member accounts in the behavior graph. This operation can only be +// called by the administrator account for a behavior graph. CreateMembers +// verifies the accounts and then invites the verified accounts. The administrator +// can optionally specify to not send invitation emails to the member accounts. +// This would be used when the administrator manages their member accounts +// centrally. For organization accounts in the organization behavior graph, +// CreateMembers attempts to enable the accounts. The organization accounts do not +// receive invitations. The request provides the behavior graph ARN and the list of +// accounts to invite or to enable. The response separates the requested accounts +// into two lists: +// - The accounts that CreateMembers was able to process. For invited accounts, +// includes member accounts that are being verified, that have passed verification +// and are to be invited, and that have failed verification. For organization +// accounts in the organization behavior graph, includes accounts that can be +// enabled and that cannot be enabled. +// - The accounts that CreateMembers was unable to process. This list includes +// accounts that were already invited to be member accounts in the behavior graph. func (c *Client) CreateMembers(ctx context.Context, params *CreateMembersInput, optFns ...func(*Options)) (*CreateMembersOutput, error) { if params == nil { params = &CreateMembersInput{} @@ -66,8 +63,8 @@ type CreateMembersInput struct { // This member is required. GraphArn *string - // if set to true, then the invited accounts do not receive email notifications. By - // default, this is set to false, and the invited accounts receive email + // if set to true , then the invited accounts do not receive email notifications. + // By default, this is set to false , and the invited accounts receive email // notifications. Organization accounts in the organization behavior graph do not // receive email notifications. DisableEmailNotification bool @@ -87,8 +84,8 @@ type CreateMembersOutput struct { // are being enabled. Members []types.MemberDetail - // The list of accounts for which Detective was unable to process the invitation or - // enablement request. For each account, the list provides the reason why the + // The list of accounts for which Detective was unable to process the invitation + // or enablement request. For each account, the list provides the reason why the // request could not be processed. The list includes accounts that are already // member accounts in the behavior graph. UnprocessedAccounts []types.UnprocessedAccount diff --git a/service/detective/api_op_DeleteMembers.go b/service/detective/api_op_DeleteMembers.go index 17dd8cde723..2f258f48d48 100644 --- a/service/detective/api_op_DeleteMembers.go +++ b/service/detective/api_op_DeleteMembers.go @@ -57,8 +57,8 @@ type DeleteMembersInput struct { type DeleteMembersOutput struct { - // The list of Amazon Web Services account identifiers for the member accounts that - // Detective successfully removed from the behavior graph. + // The list of Amazon Web Services account identifiers for the member accounts + // that Detective successfully removed from the behavior graph. AccountIds []string // The list of member accounts that Detective was not able to remove from the diff --git a/service/detective/api_op_DescribeOrganizationConfiguration.go b/service/detective/api_op_DescribeOrganizationConfiguration.go index e7088fd19c1..d2dbd35e16d 100644 --- a/service/detective/api_op_DescribeOrganizationConfiguration.go +++ b/service/detective/api_op_DescribeOrganizationConfiguration.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the configuration for the organization behavior graph. -// Currently indicates whether to automatically enable new organization accounts as -// member accounts. Can only be called by the Detective administrator account for -// the organization. +// Returns information about the configuration for the organization behavior +// graph. Currently indicates whether to automatically enable new organization +// accounts as member accounts. Can only be called by the Detective administrator +// account for the organization. func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error) { if params == nil { params = &DescribeOrganizationConfigurationInput{} diff --git a/service/detective/api_op_DisassociateMembership.go b/service/detective/api_op_DisassociateMembership.go index 0c475b469dd..25806294946 100644 --- a/service/detective/api_op_DisassociateMembership.go +++ b/service/detective/api_op_DisassociateMembership.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the member account from the specified behavior graph. This operation can -// only be called by an invited member account that has the ENABLED status. +// Removes the member account from the specified behavior graph. This operation +// can only be called by an invited member account that has the ENABLED status. // DisassociateMembership cannot be called by an organization account in the // organization behavior graph. For the organization behavior graph, the Detective // administrator account determines which organization accounts to enable or @@ -34,7 +34,7 @@ func (c *Client) DisassociateMembership(ctx context.Context, params *Disassociat type DisassociateMembershipInput struct { // The ARN of the behavior graph to remove the member account from. The member - // account's member status in the behavior graph must be ENABLED. + // account's member status in the behavior graph must be ENABLED . // // This member is required. GraphArn *string diff --git a/service/detective/api_op_ListGraphs.go b/service/detective/api_op_ListGraphs.go index bc84b386116..52d44674d1e 100644 --- a/service/detective/api_op_ListGraphs.go +++ b/service/detective/api_op_ListGraphs.go @@ -12,10 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of behavior graphs that the calling account is an administrator -// account of. This operation can only be called by an administrator account. -// Because an account can currently only be the administrator of one behavior graph -// within a Region, the results always contain a single behavior graph. +// Returns the list of behavior graphs that the calling account is an +// administrator account of. This operation can only be called by an administrator +// account. Because an account can currently only be the administrator of one +// behavior graph within a Region, the results always contain a single behavior +// graph. func (c *Client) ListGraphs(ctx context.Context, params *ListGraphsInput, optFns ...func(*Options)) (*ListGraphsOutput, error) { if params == nil { params = &ListGraphsInput{} diff --git a/service/detective/api_op_ListInvitations.go b/service/detective/api_op_ListInvitations.go index adc3d60336c..2ad32a35c1c 100644 --- a/service/detective/api_op_ListInvitations.go +++ b/service/detective/api_op_ListInvitations.go @@ -40,9 +40,9 @@ type ListInvitationsInput struct { // which is currently 200. MaxResults *int32 - // For requests to retrieve the next page of results, the pagination token that was - // returned with the previous page of results. The initial request does not include - // a pagination token. + // For requests to retrieve the next page of results, the pagination token that + // was returned with the previous page of results. The initial request does not + // include a pagination token. NextToken *string noSmithyDocumentSerde diff --git a/service/detective/api_op_ListMembers.go b/service/detective/api_op_ListMembers.go index c7924d8d3fc..1df81209d83 100644 --- a/service/detective/api_op_ListMembers.go +++ b/service/detective/api_op_ListMembers.go @@ -39,14 +39,14 @@ type ListMembersInput struct { // This member is required. GraphArn *string - // The maximum number of member accounts to include in the response. The total must - // be less than the overall limit on the number of results to return, which is + // The maximum number of member accounts to include in the response. The total + // must be less than the overall limit on the number of results to return, which is // currently 200. MaxResults *int32 - // For requests to retrieve the next page of member account results, the pagination - // token that was returned with the previous page of results. The initial request - // does not include a pagination token. + // For requests to retrieve the next page of member account results, the + // pagination token that was returned with the previous page of results. The + // initial request does not include a pagination token. NextToken *string noSmithyDocumentSerde @@ -145,8 +145,8 @@ var _ ListMembersAPIClient = (*Client)(nil) // ListMembersPaginatorOptions is the paginator options for ListMembers type ListMembersPaginatorOptions struct { - // The maximum number of member accounts to include in the response. The total must - // be less than the overall limit on the number of results to return, which is + // The maximum number of member accounts to include in the response. The total + // must be less than the overall limit on the number of results to return, which is // currently 200. Limit int32 diff --git a/service/detective/api_op_ListOrganizationAdminAccounts.go b/service/detective/api_op_ListOrganizationAdminAccounts.go index a551b6efeca..266d797f655 100644 --- a/service/detective/api_op_ListOrganizationAdminAccounts.go +++ b/service/detective/api_op_ListOrganizationAdminAccounts.go @@ -47,8 +47,8 @@ type ListOrganizationAdminAccountsOutput struct { // The list of Detective administrator accounts. Administrators []types.Administrator - // If there are more accounts remaining in the results, then this is the pagination - // token to use to request the next page of accounts. + // If there are more accounts remaining in the results, then this is the + // pagination token to use to request the next page of accounts. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/detective/api_op_RejectInvitation.go b/service/detective/api_op_RejectInvitation.go index 03eec34b119..5637a0acd27 100644 --- a/service/detective/api_op_RejectInvitation.go +++ b/service/detective/api_op_RejectInvitation.go @@ -33,7 +33,7 @@ func (c *Client) RejectInvitation(ctx context.Context, params *RejectInvitationI type RejectInvitationInput struct { // The ARN of the behavior graph to reject the invitation to. The member account's - // current member status in the behavior graph must be INVITED. + // current member status in the behavior graph must be INVITED . // // This member is required. GraphArn *string diff --git a/service/detective/api_op_StartMonitoringMember.go b/service/detective/api_op_StartMonitoringMember.go index e9b01b44df3..01207bd4341 100644 --- a/service/detective/api_op_StartMonitoringMember.go +++ b/service/detective/api_op_StartMonitoringMember.go @@ -11,14 +11,11 @@ import ( ) // Sends a request to enable data ingest for a member account that has a status of -// ACCEPTED_BUT_DISABLED. For valid member accounts, the status is updated as +// ACCEPTED_BUT_DISABLED . For valid member accounts, the status is updated as // follows. -// -// * If Detective enabled the member account, then the new status is -// ENABLED. -// -// * If Detective cannot enable the member account, the status remains -// ACCEPTED_BUT_DISABLED. +// - If Detective enabled the member account, then the new status is ENABLED . +// - If Detective cannot enable the member account, the status remains +// ACCEPTED_BUT_DISABLED . func (c *Client) StartMonitoringMember(ctx context.Context, params *StartMonitoringMemberInput, optFns ...func(*Options)) (*StartMonitoringMemberOutput, error) { if params == nil { params = &StartMonitoringMemberInput{} @@ -37,7 +34,7 @@ func (c *Client) StartMonitoringMember(ctx context.Context, params *StartMonitor type StartMonitoringMemberInput struct { // The account ID of the member account to try to enable. The account must be an - // invited member account with a status of ACCEPTED_BUT_DISABLED. + // invited member account with a status of ACCEPTED_BUT_DISABLED . // // This member is required. AccountId *string diff --git a/service/detective/api_op_UntagResource.go b/service/detective/api_op_UntagResource.go index 5b6e2d6c8c2..53931239803 100644 --- a/service/detective/api_op_UntagResource.go +++ b/service/detective/api_op_UntagResource.go @@ -33,8 +33,8 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // The tag keys of the tags to remove from the behavior graph. You can remove up to - // 50 tags at a time. + // The tag keys of the tags to remove from the behavior graph. You can remove up + // to 50 tags at a time. // // This member is required. TagKeys []string diff --git a/service/detective/doc.go b/service/detective/doc.go index fa88ee8cfbf..49141c40ad5 100644 --- a/service/detective/doc.go +++ b/service/detective/doc.go @@ -26,51 +26,30 @@ // behavior graphs that belong to the Region that is associated with the currently // selected endpoint. The administrator account for a behavior graph can use the // Detective API to do the following: -// -// * Enable and disable Detective. Enabling -// Detective creates a new behavior graph. -// -// * View the list of member accounts in a -// behavior graph. -// -// * Add member accounts to a behavior graph. -// -// * Remove member -// accounts from a behavior graph. -// -// * Apply tags to a behavior graph. -// -// The -// organization management account can use the Detective API to select the +// - Enable and disable Detective. Enabling Detective creates a new behavior +// graph. +// - View the list of member accounts in a behavior graph. +// - Add member accounts to a behavior graph. +// - Remove member accounts from a behavior graph. +// - Apply tags to a behavior graph. +// +// The organization management account can use the Detective API to select the // delegated administrator for Detective. The Detective administrator account for // an organization can use the Detective API to do the following: -// -// * Perform all of -// the functions of an administrator account. -// -// * Determine whether to automatically -// enable new organization accounts as member accounts in the organization behavior -// graph. -// -// An invited member account can use the Detective API to do the -// following: -// -// * View the list of behavior graphs that they are invited to. -// -// * -// Accept an invitation to contribute to a behavior graph. -// -// * Decline an invitation -// to contribute to a behavior graph. -// -// * Remove their account from a behavior -// graph. -// -// All API actions are logged as CloudTrail events. See Logging Detective -// API Calls with CloudTrail -// (https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html). -// We replaced the term "master account" with the term "administrator account." An -// administrator account is used to centrally manage multiple accounts. In the case -// of Detective, the administrator account manages the accounts in their behavior -// graph. +// - Perform all of the functions of an administrator account. +// - Determine whether to automatically enable new organization accounts as +// member accounts in the organization behavior graph. +// +// An invited member account can use the Detective API to do the following: +// - View the list of behavior graphs that they are invited to. +// - Accept an invitation to contribute to a behavior graph. +// - Decline an invitation to contribute to a behavior graph. +// - Remove their account from a behavior graph. +// +// All API actions are logged as CloudTrail events. See Logging Detective API +// Calls with CloudTrail (https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html) +// . We replaced the term "master account" with the term "administrator account." +// An administrator account is used to centrally manage multiple accounts. In the +// case of Detective, the administrator account manages the accounts in their +// behavior graph. package detective diff --git a/service/detective/types/enums.go b/service/detective/types/enums.go index cda16a68696..c15cb5154b1 100644 --- a/service/detective/types/enums.go +++ b/service/detective/types/enums.go @@ -29,9 +29,10 @@ const ( DatasourcePackageIngestStateDisabled DatasourcePackageIngestState = "DISABLED" ) -// Values returns all known values for DatasourcePackageIngestState. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DatasourcePackageIngestState. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DatasourcePackageIngestState) Values() []DatasourcePackageIngestState { return []DatasourcePackageIngestState{ "STARTED", @@ -49,9 +50,9 @@ const ( ErrorCodeInternalError ErrorCode = "INTERNAL_ERROR" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "INVALID_GRAPH_ARN", @@ -107,9 +108,9 @@ const ( MemberStatusAcceptedButDisabled MemberStatus = "ACCEPTED_BUT_DISABLED" ) -// Values returns all known values for MemberStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MemberStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MemberStatus) Values() []MemberStatus { return []MemberStatus{ "INVITED", diff --git a/service/detective/types/errors.go b/service/detective/types/errors.go index 54f72fd4e81..565e90c404f 100644 --- a/service/detective/types/errors.go +++ b/service/detective/types/errors.go @@ -118,18 +118,13 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // This request cannot be completed for one of the following reasons. -// -// * The -// request would cause the number of member accounts in the behavior graph to -// exceed the maximum allowed. A behavior graph cannot have more than 1200 member -// accounts. -// -// * The request would cause the data rate for the behavior graph to -// exceed the maximum allowed. -// -// * Detective is unable to verify the data rate for -// the member account. This is usually because the member account is not enrolled -// in Amazon GuardDuty. +// - The request would cause the number of member accounts in the behavior graph +// to exceed the maximum allowed. A behavior graph cannot have more than 1200 +// member accounts. +// - The request would cause the data rate for the behavior graph to exceed the +// maximum allowed. +// - Detective is unable to verify the data rate for the member account. This is +// usually because the member account is not enrolled in Amazon GuardDuty. type ServiceQuotaExceededException struct { Message *string @@ -157,8 +152,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request cannot be completed because too many other requests are occurring at -// the same time. +// The request cannot be completed because too many other requests are occurring +// at the same time. type TooManyRequestsException struct { Message *string diff --git a/service/detective/types/types.go b/service/detective/types/types.go index 742ffc32c5b..298e2dfeeae 100644 --- a/service/detective/types/types.go +++ b/service/detective/types/types.go @@ -33,7 +33,7 @@ type Administrator struct { AccountId *string // The date and time when the Detective administrator account was enabled. The - // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . DelegationTime *time.Time // The ARN of the organization behavior graph. @@ -61,7 +61,7 @@ type DatasourcePackageUsageInfo struct { VolumeUsageInBytes *int64 // The data and time when the member account data volume was last updated. The - // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . VolumeUsageUpdateTime *time.Time noSmithyDocumentSerde @@ -74,7 +74,7 @@ type Graph struct { Arn *string // The date and time that the behavior graph was created. The value is an ISO8601 - // formatted string. For example, 2021-08-18T16:35:56.284Z. + // formatted string. For example, 2021-08-18T16:35:56.284Z . CreatedTime *time.Time noSmithyDocumentSerde @@ -93,17 +93,13 @@ type MemberDetail struct { // The state of a data source package for the behavior graph. DatasourcePackageIngestStates map[string]DatasourcePackageIngestState - // For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the - // member account is not enabled. The reason can have one of the following - // values: - // - // * VOLUME_TOO_HIGH - Indicates that adding the member account would - // cause the data volume for the behavior graph to be too high. - // - // * VOLUME_UNKNOWN - - // Indicates that Detective is unable to verify the data volume for the member - // account. This is usually because the member account is not enrolled in Amazon - // GuardDuty. + // For member accounts with a status of ACCEPTED_BUT_DISABLED , the reason that the + // member account is not enabled. The reason can have one of the following values: + // - VOLUME_TOO_HIGH - Indicates that adding the member account would cause the + // data volume for the behavior graph to be too high. + // - VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data + // volume for the member account. This is usually because the member account is not + // enrolled in Amazon GuardDuty. DisabledReason MemberDisabledReason // The Amazon Web Services account root user email address for the member account. @@ -113,13 +109,13 @@ type MemberDetail struct { GraphArn *string // The type of behavior graph membership. For an organization account in the - // organization behavior graph, the type is ORGANIZATION. For an account that was - // invited to a behavior graph, the type is INVITATION. + // organization behavior graph, the type is ORGANIZATION . For an account that was + // invited to a behavior graph, the type is INVITATION . InvitationType InvitationType // For invited accounts, the date and time that Detective sent the invitation to // the account. The value is an ISO8601 formatted string. For example, - // 2021-08-18T16:35:56.284Z. + // 2021-08-18T16:35:56.284Z . InvitedTime *time.Time // The Amazon Web Services account identifier of the administrator account for the @@ -141,7 +137,7 @@ type MemberDetail struct { PercentOfGraphUtilization *float64 // The date and time when the graph utilization percentage was last updated. The - // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . // // Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage // instead. @@ -149,43 +145,35 @@ type MemberDetail struct { // The current membership status of the member account. The status can have one of // the following values: - // - // * INVITED - For invited accounts only. Indicates that the - // member was sent an invitation but has not yet responded. - // - // * - // VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective - // is verifying that the account identifier and email address provided for the - // member account match. If they do match, then Detective sends the invitation. If - // the email address and account identifier don't match, then the member cannot be - // added to the behavior graph. For organization accounts in the organization - // behavior graph, indicates that Detective is verifying that the account belongs - // to the organization. - // - // * VERIFICATION_FAILED - For invited accounts only. - // Indicates that the account and email address provided for the member account do - // not match, and Detective did not send an invitation to the account. - // - // * ENABLED - - // Indicates that the member account currently contributes data to the behavior - // graph. For invited accounts, the member account accepted the invitation. For - // organization accounts in the organization behavior graph, the Detective - // administrator account enabled the organization account as a member account. - // - // * - // ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by - // the Detective administrator account, but is prevented from contributing data to - // the behavior graph. DisabledReason provides the reason why the member account is - // not enabled. - // - // Invited accounts that declined an invitation or that were removed - // from the behavior graph are not included. In the organization behavior graph, + // - INVITED - For invited accounts only. Indicates that the member was sent an + // invitation but has not yet responded. + // - VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that + // Detective is verifying that the account identifier and email address provided + // for the member account match. If they do match, then Detective sends the + // invitation. If the email address and account identifier don't match, then the + // member cannot be added to the behavior graph. For organization accounts in the + // organization behavior graph, indicates that Detective is verifying that the + // account belongs to the organization. + // - VERIFICATION_FAILED - For invited accounts only. Indicates that the account + // and email address provided for the member account do not match, and Detective + // did not send an invitation to the account. + // - ENABLED - Indicates that the member account currently contributes data to + // the behavior graph. For invited accounts, the member account accepted the + // invitation. For organization accounts in the organization behavior graph, the + // Detective administrator account enabled the organization account as a member + // account. + // - ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled + // by the Detective administrator account, but is prevented from contributing data + // to the behavior graph. DisabledReason provides the reason why the member + // account is not enabled. + // Invited accounts that declined an invitation or that were removed from the + // behavior graph are not included. In the organization behavior graph, // organization accounts that the Detective administrator account did not enable // are not included. Status MemberStatus // The date and time that the member account was last updated. The value is an - // ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . UpdatedTime *time.Time // Details on the volume of usage for each data source package in a behavior graph. @@ -198,7 +186,7 @@ type MemberDetail struct { VolumeUsageInBytes *int64 // The data and time when the member account data volume was last updated. The - // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . // // Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage // instead. @@ -226,7 +214,7 @@ type MembershipDatasources struct { type TimestampForCollection struct { // The data and time when data collection began for a source package. The value is - // an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z. + // an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z . Timestamp *time.Time noSmithyDocumentSerde @@ -252,8 +240,8 @@ type UnprocessedGraph struct { // The ARN of the organization behavior graph. GraphArn *string - // The reason data source package information could not be processed for a behavior - // graph. + // The reason data source package information could not be processed for a + // behavior graph. Reason *string noSmithyDocumentSerde diff --git a/service/devicefarm/api_client.go b/service/devicefarm/api_client.go index 7e80050f21d..5c35564097f 100644 --- a/service/devicefarm/api_client.go +++ b/service/devicefarm/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/devicefarm/api_op_CreateInstanceProfile.go b/service/devicefarm/api_op_CreateInstanceProfile.go index df520eb9565..8c6e282fdd6 100644 --- a/service/devicefarm/api_op_CreateInstanceProfile.go +++ b/service/devicefarm/api_op_CreateInstanceProfile.go @@ -40,15 +40,15 @@ type CreateInstanceProfileInput struct { // An array of strings that specifies the list of app packages that should not be // cleaned up from the device after a test run. The list of packages is considered - // only if you set packageCleanup to true. + // only if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string - // When set to true, Device Farm removes app packages after a test run. The default - // value is false for private devices. + // When set to true , Device Farm removes app packages after a test run. The + // default value is false for private devices. PackageCleanup *bool - // When set to true, Device Farm reboots the instance after a test run. The default - // value is true. + // When set to true , Device Farm reboots the instance after a test run. The + // default value is true . RebootAfterUse *bool noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_CreateRemoteAccessSession.go b/service/devicefarm/api_op_CreateRemoteAccessSession.go index d07363e674f..733be82f7d5 100644 --- a/service/devicefarm/api_op_CreateRemoteAccessSession.go +++ b/service/devicefarm/api_op_CreateRemoteAccessSession.go @@ -43,9 +43,9 @@ type CreateRemoteAccessSessionInput struct { // Unique identifier for the client. If you want access to multiple devices on the // same client, you should pass the same clientId value in each call to - // CreateRemoteAccessSession. This identifier is required only if - // remoteDebugEnabled is set to true. Remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // CreateRemoteAccessSession . This identifier is required only if + // remoteDebugEnabled is set to true . Remote debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . ClientId *string // The configuration information for the remote access session request. @@ -56,27 +56,22 @@ type CreateRemoteAccessSessionInput struct { InstanceArn *string // The interaction mode of the remote access session. Valid values are: + // - INTERACTIVE: You can interact with the iOS device by viewing, touching, and + // rotating the screen. You cannot run XCUITest framework-based tests in this mode. // - // * - // INTERACTIVE: You can interact with the iOS device by viewing, touching, and - // rotating the screen. You cannot run XCUITest framework-based tests in this - // mode. - // - // * NO_VIDEO: You are connected to the device, but cannot interact with it - // or view the screen. This mode has the fastest test execution speed. You can run - // XCUITest framework-based tests in this mode. - // - // * VIDEO_ONLY: You can view the - // screen, but cannot touch or rotate it. You can run XCUITest framework-based - // tests and watch the screen in this mode. + // - NO_VIDEO: You are connected to the device, but cannot interact with it or + // view the screen. This mode has the fastest test execution speed. You can run + // XCUITest framework-based tests in this mode. + // - VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can + // run XCUITest framework-based tests and watch the screen in this mode. InteractionMode types.InteractionMode // The name of the remote access session to create. Name *string // Set to true if you want to access devices remotely for debugging in your remote - // access session. Remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // access session. Remote debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . RemoteDebugEnabled *bool // The Amazon Resource Name (ARN) for the app to be recorded in the remote access @@ -86,16 +81,16 @@ type CreateRemoteAccessSessionInput struct { // Set to true to enable remote recording for the remote access session. RemoteRecordEnabled *bool - // When set to true, for private devices, Device Farm does not sign your app again. - // For public devices, Device Farm always signs your apps again. For more + // When set to true , for private devices, Device Farm does not sign your app + // again. For public devices, Device Farm always signs your apps again. For more // information on how Device Farm modifies your uploads during tests, see Do you // modify my app? (http://aws.amazon.com/device-farm/faqs/) SkipAppResign *bool // Ignored. The public key of the ssh key pair you want to use for connecting to // remote devices in your remote debugging session. This key is required only if - // remoteDebugEnabled is set to true. Remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // remoteDebugEnabled is set to true . Remote debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . SshPublicKey *string noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_CreateTestGridUrl.go b/service/devicefarm/api_op_CreateTestGridUrl.go index 523a884ce4f..3832e40eac9 100644 --- a/service/devicefarm/api_op_CreateTestGridUrl.go +++ b/service/devicefarm/api_op_CreateTestGridUrl.go @@ -35,7 +35,7 @@ type CreateTestGridUrlInput struct { // This member is required. ExpiresInSeconds *int32 - // ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the + // ARN (from CreateTestGridProject or ListTestGridProjects ) to associate with the // short-term URL. // // This member is required. @@ -50,7 +50,7 @@ type CreateTestGridUrlOutput struct { Expires *time.Time // A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to - // be passed to a RemoteWebDriver. + // be passed to a RemoteWebDriver . Url *string // Metadata pertaining to the operation's result. diff --git a/service/devicefarm/api_op_CreateUpload.go b/service/devicefarm/api_op_CreateUpload.go index 00eb9670a4a..07bd5c66f36 100644 --- a/service/devicefarm/api_op_CreateUpload.go +++ b/service/devicefarm/api_op_CreateUpload.go @@ -30,10 +30,11 @@ func (c *Client) CreateUpload(ctx context.Context, params *CreateUploadInput, op // Represents a request to the create upload operation. type CreateUploadInput struct { - // The upload's file name. The name should not contain any forward slashes (/). If - // you are uploading an iOS app, the file name must end with the .ipa extension. If - // you are uploading an Android app, the file name must end with the .apk - // extension. For all others, the file name must end with the .zip file extension. + // The upload's file name. The name should not contain any forward slashes ( / ). + // If you are uploading an iOS app, the file name must end with the .ipa + // extension. If you are uploading an Android app, the file name must end with the + // .apk extension. For all others, the file name must end with the .zip file + // extension. // // This member is required. Name *string @@ -44,92 +45,45 @@ type CreateUploadInput struct { ProjectArn *string // The upload's upload type. Must be one of the following values: - // - // * ANDROID_APP - // - // * - // IOS_APP - // - // * WEB_APP - // - // * EXTERNAL_DATA - // - // * APPIUM_JAVA_JUNIT_TEST_PACKAGE - // - // * - // APPIUM_JAVA_TESTNG_TEST_PACKAGE - // - // * APPIUM_PYTHON_TEST_PACKAGE - // - // * - // APPIUM_NODE_TEST_PACKAGE - // - // * APPIUM_RUBY_TEST_PACKAGE - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE - // - // * - // APPIUM_WEB_PYTHON_TEST_PACKAGE - // - // * APPIUM_WEB_NODE_TEST_PACKAGE - // - // * - // APPIUM_WEB_RUBY_TEST_PACKAGE - // - // * CALABASH_TEST_PACKAGE - // - // * - // INSTRUMENTATION_TEST_PACKAGE - // - // * UIAUTOMATION_TEST_PACKAGE - // - // * - // UIAUTOMATOR_TEST_PACKAGE - // - // * XCTEST_TEST_PACKAGE - // - // * XCTEST_UI_TEST_PACKAGE - // - // * - // APPIUM_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_PYTHON_TEST_SPEC - // - // * APPIUM_NODE_TEST_SPEC - // - // * APPIUM_RUBY_TEST_SPEC - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_WEB_PYTHON_TEST_SPEC - // - // * APPIUM_WEB_NODE_TEST_SPEC - // - // * - // APPIUM_WEB_RUBY_TEST_SPEC - // - // * INSTRUMENTATION_TEST_SPEC - // - // * - // XCTEST_UI_TEST_SPEC - // - // If you call CreateUpload with WEB_APP specified, AWS Device - // Farm throws an ArgumentException error. + // - ANDROID_APP + // - IOS_APP + // - WEB_APP + // - EXTERNAL_DATA + // - APPIUM_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_PYTHON_TEST_PACKAGE + // - APPIUM_NODE_TEST_PACKAGE + // - APPIUM_RUBY_TEST_PACKAGE + // - APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_WEB_PYTHON_TEST_PACKAGE + // - APPIUM_WEB_NODE_TEST_PACKAGE + // - APPIUM_WEB_RUBY_TEST_PACKAGE + // - CALABASH_TEST_PACKAGE + // - INSTRUMENTATION_TEST_PACKAGE + // - UIAUTOMATION_TEST_PACKAGE + // - UIAUTOMATOR_TEST_PACKAGE + // - XCTEST_TEST_PACKAGE + // - XCTEST_UI_TEST_PACKAGE + // - APPIUM_JAVA_JUNIT_TEST_SPEC + // - APPIUM_JAVA_TESTNG_TEST_SPEC + // - APPIUM_PYTHON_TEST_SPEC + // - APPIUM_NODE_TEST_SPEC + // - APPIUM_RUBY_TEST_SPEC + // - APPIUM_WEB_JAVA_JUNIT_TEST_SPEC + // - APPIUM_WEB_JAVA_TESTNG_TEST_SPEC + // - APPIUM_WEB_PYTHON_TEST_SPEC + // - APPIUM_WEB_NODE_TEST_SPEC + // - APPIUM_WEB_RUBY_TEST_SPEC + // - INSTRUMENTATION_TEST_SPEC + // - XCTEST_UI_TEST_SPEC + // If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an + // ArgumentException error. // // This member is required. Type types.UploadType - // The upload's content type (for example, application/octet-stream). + // The upload's content type (for example, application/octet-stream ). ContentType *string noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_DeleteTestGridProject.go b/service/devicefarm/api_op_DeleteTestGridProject.go index e731632ca59..0254f36657b 100644 --- a/service/devicefarm/api_op_DeleteTestGridProject.go +++ b/service/devicefarm/api_op_DeleteTestGridProject.go @@ -31,7 +31,7 @@ func (c *Client) DeleteTestGridProject(ctx context.Context, params *DeleteTestGr type DeleteTestGridProjectInput struct { // The ARN of the project to delete, from CreateTestGridProject or - // ListTestGridProjects. + // ListTestGridProjects . // // This member is required. ProjectArn *string diff --git a/service/devicefarm/api_op_GetDevicePoolCompatibility.go b/service/devicefarm/api_op_GetDevicePoolCompatibility.go index 8338ed8b5c9..ee55a84e41c 100644 --- a/service/devicefarm/api_op_GetDevicePoolCompatibility.go +++ b/service/devicefarm/api_op_GetDevicePoolCompatibility.go @@ -46,48 +46,25 @@ type GetDevicePoolCompatibilityInput struct { // The test type for the specified device pool. Allowed values include the // following: - // - // * BUILTIN_FUZZ. - // - // * BUILTIN_EXPLORER. For Android, an app explorer - // that traverses an Android app, interacting with it and capturing screenshots at - // the same time. - // - // * APPIUM_JAVA_JUNIT. - // - // * APPIUM_JAVA_TESTNG. - // - // * APPIUM_PYTHON. - // - // * - // APPIUM_NODE. - // - // * APPIUM_RUBY. - // - // * APPIUM_WEB_JAVA_JUNIT. - // - // * - // APPIUM_WEB_JAVA_TESTNG. - // - // * APPIUM_WEB_PYTHON. - // - // * APPIUM_WEB_NODE. - // - // * - // APPIUM_WEB_RUBY. - // - // * CALABASH. - // - // * INSTRUMENTATION. - // - // * UIAUTOMATION. - // - // * - // UIAUTOMATOR. - // - // * XCTEST. - // - // * XCTEST_UI. + // - BUILTIN_FUZZ. + // - BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android + // app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT. + // - APPIUM_JAVA_TESTNG. + // - APPIUM_PYTHON. + // - APPIUM_NODE. + // - APPIUM_RUBY. + // - APPIUM_WEB_JAVA_JUNIT. + // - APPIUM_WEB_JAVA_TESTNG. + // - APPIUM_WEB_PYTHON. + // - APPIUM_WEB_NODE. + // - APPIUM_WEB_RUBY. + // - CALABASH. + // - INSTRUMENTATION. + // - UIAUTOMATION. + // - UIAUTOMATOR. + // - XCTEST. + // - XCTEST_UI. TestType types.TestType noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_GetOfferingStatus.go b/service/devicefarm/api_op_GetOfferingStatus.go index dfedf12e11a..eb4e1387128 100644 --- a/service/devicefarm/api_op_GetOfferingStatus.go +++ b/service/devicefarm/api_op_GetOfferingStatus.go @@ -16,8 +16,8 @@ import ( // account. The response indicates how many offerings are currently available and // the offerings that will be available in the next period. The API returns a // NotEligible error if the user is not permitted to invoke the operation. If you -// must be able to invoke this operation, contact aws-devicefarm-support@amazon.com -// (mailto:aws-devicefarm-support@amazon.com). +// must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) +// . func (c *Client) GetOfferingStatus(ctx context.Context, params *GetOfferingStatusInput, optFns ...func(*Options)) (*GetOfferingStatusOutput, error) { if params == nil { params = &GetOfferingStatusInput{} diff --git a/service/devicefarm/api_op_GetRemoteAccessSession.go b/service/devicefarm/api_op_GetRemoteAccessSession.go index da9dbc10b90..ae84ca82c55 100644 --- a/service/devicefarm/api_op_GetRemoteAccessSession.go +++ b/service/devicefarm/api_op_GetRemoteAccessSession.go @@ -31,8 +31,8 @@ func (c *Client) GetRemoteAccessSession(ctx context.Context, params *GetRemoteAc // session. type GetRemoteAccessSessionInput struct { - // The Amazon Resource Name (ARN) of the remote access session about which you want - // to get session information. + // The Amazon Resource Name (ARN) of the remote access session about which you + // want to get session information. // // This member is required. Arn *string diff --git a/service/devicefarm/api_op_GetTestGridProject.go b/service/devicefarm/api_op_GetTestGridProject.go index b8134138fae..2f58b308259 100644 --- a/service/devicefarm/api_op_GetTestGridProject.go +++ b/service/devicefarm/api_op_GetTestGridProject.go @@ -30,7 +30,7 @@ func (c *Client) GetTestGridProject(ctx context.Context, params *GetTestGridProj type GetTestGridProjectInput struct { // The ARN of the Selenium testing project, from either CreateTestGridProject or - // ListTestGridProjects. + // ListTestGridProjects . // // This member is required. ProjectArn *string @@ -40,7 +40,7 @@ type GetTestGridProjectInput struct { type GetTestGridProjectOutput struct { - // A TestGridProject. + // A TestGridProject . TestGridProject *types.TestGridProject // Metadata pertaining to the operation's result. diff --git a/service/devicefarm/api_op_GetTestGridSession.go b/service/devicefarm/api_op_GetTestGridSession.go index 5d4c47b4453..0784b0a1729 100644 --- a/service/devicefarm/api_op_GetTestGridSession.go +++ b/service/devicefarm/api_op_GetTestGridSession.go @@ -11,15 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A session is an instance of a browser created through a RemoteWebDriver with the -// URL from CreateTestGridUrlResult$url. You can use the following to look up +// A session is an instance of a browser created through a RemoteWebDriver with +// the URL from CreateTestGridUrlResult$url . You can use the following to look up // sessions: -// -// * The session ARN (GetTestGridSessionRequest$sessionArn). -// -// * The -// project ARN and a session ID (GetTestGridSessionRequest$projectArn and -// GetTestGridSessionRequest$sessionId). +// - The session ARN ( GetTestGridSessionRequest$sessionArn ). +// - The project ARN and a session ID ( GetTestGridSessionRequest$projectArn and +// GetTestGridSessionRequest$sessionId ). func (c *Client) GetTestGridSession(ctx context.Context, params *GetTestGridSessionInput, optFns ...func(*Options)) (*GetTestGridSessionOutput, error) { if params == nil { params = &GetTestGridSessionInput{} @@ -38,10 +35,10 @@ func (c *Client) GetTestGridSession(ctx context.Context, params *GetTestGridSess type GetTestGridSessionInput struct { // The ARN for the project that this session belongs to. See CreateTestGridProject - // and ListTestGridProjects. + // and ListTestGridProjects . ProjectArn *string - // An ARN that uniquely identifies a TestGridSession. + // An ARN that uniquely identifies a TestGridSession . SessionArn *string // An ID associated with this session. diff --git a/service/devicefarm/api_op_InstallToRemoteAccessSession.go b/service/devicefarm/api_op_InstallToRemoteAccessSession.go index 43cf0820908..4c21384bee1 100644 --- a/service/devicefarm/api_op_InstallToRemoteAccessSession.go +++ b/service/devicefarm/api_op_InstallToRemoteAccessSession.go @@ -47,8 +47,8 @@ type InstallToRemoteAccessSessionInput struct { noSmithyDocumentSerde } -// Represents the response from the server after AWS Device Farm makes a request to -// install to a remote access session. +// Represents the response from the server after AWS Device Farm makes a request +// to install to a remote access session. type InstallToRemoteAccessSessionOutput struct { // An app to upload or that has been uploaded. diff --git a/service/devicefarm/api_op_ListArtifacts.go b/service/devicefarm/api_op_ListArtifacts.go index f09a58d25e8..c7028d915a0 100644 --- a/service/devicefarm/api_op_ListArtifacts.go +++ b/service/devicefarm/api_op_ListArtifacts.go @@ -37,12 +37,9 @@ type ListArtifactsInput struct { Arn *string // The artifacts' type. Allowed values include: - // - // * FILE - // - // * LOG - // - // * SCREENSHOT + // - FILE + // - LOG + // - SCREENSHOT // // This member is required. Type types.ArtifactCategory diff --git a/service/devicefarm/api_op_ListDevicePools.go b/service/devicefarm/api_op_ListDevicePools.go index bd56cdb6d66..47bb6e55263 100644 --- a/service/devicefarm/api_op_ListDevicePools.go +++ b/service/devicefarm/api_op_ListDevicePools.go @@ -41,12 +41,9 @@ type ListDevicePoolsInput struct { NextToken *string // The device pools' type. Allowed values include: - // - // * CURATED: A device pool that - // is created and managed by AWS Device Farm. - // - // * PRIVATE: A device pool that is - // created and managed by the device pool developer. + // - CURATED: A device pool that is created and managed by AWS Device Farm. + // - PRIVATE: A device pool that is created and managed by the device pool + // developer. Type types.DevicePoolType noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_ListDevices.go b/service/devicefarm/api_op_ListDevices.go index 28385537b56..ecdb2fd0ade 100644 --- a/service/devicefarm/api_op_ListDevices.go +++ b/service/devicefarm/api_op_ListDevices.go @@ -36,77 +36,42 @@ type ListDevicesInput struct { // Used to select a set of devices. A filter is made up of an attribute, an // operator, and one or more values. - // - // * Attribute: The aspect of a device such as - // platform or model used as the selection criteria in a device filter. Allowed - // values include: - // - // * ARN: The Amazon Resource Name (ARN) of the device (for - // example, arn:aws:devicefarm:us-west-2::device:12345Example). - // - // * PLATFORM: The - // device platform. Valid values are ANDROID or IOS. - // - // * OS_VERSION: The operating - // system version (for example, 10.3.2). - // - // * MODEL: The device model (for example, - // iPad 5th Gen). - // - // * AVAILABILITY: The current availability of the device. Valid - // values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. - // - // * - // FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET. - // - // * - // MANUFACTURER: The device manufacturer (for example, Apple). - // - // * - // REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid - // values are TRUE or FALSE. - // - // * REMOTE_DEBUG_ENABLED: Whether the device is enabled - // for remote debugging. Valid values are TRUE or FALSE. Because remote debugging - // is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html), - // this attribute is ignored. - // - // * INSTANCE_ARN: The Amazon Resource Name (ARN) of - // the device instance. - // - // * INSTANCE_LABELS: The label of the device instance. - // - // * - // FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE. - // - // * Operator: The - // filter operator. - // - // * The EQUALS operator is available for every attribute except - // INSTANCE_LABELS. - // - // * The CONTAINS operator is available for the INSTANCE_LABELS - // and MODEL attributes. - // - // * The IN and NOT_IN operators are available for the ARN, - // OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. - // - // * The LESS_THAN, - // GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also - // available for the OS_VERSION attribute. - // - // * Values: An array of one or more - // filter values. - // - // * The IN and NOT_IN operators take a values array that has one - // or more elements. - // - // * The other operators require an array with a single - // element. - // - // * In a request, the AVAILABILITY attribute takes the following values: - // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. + // - Attribute: The aspect of a device such as platform or model used as the + // selection criteria in a device filter. Allowed values include: + // - ARN: The Amazon Resource Name (ARN) of the device (for example, + // arn:aws:devicefarm:us-west-2::device:12345Example ). + // - PLATFORM: The device platform. Valid values are ANDROID or IOS. + // - OS_VERSION: The operating system version (for example, 10.3.2). + // - MODEL: The device model (for example, iPad 5th Gen). + // - AVAILABILITY: The current availability of the device. Valid values are + // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. + // - FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET. + // - MANUFACTURER: The device manufacturer (for example, Apple). + // - REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. + // Valid values are TRUE or FALSE. + // - REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. + // Valid values are TRUE or FALSE. Because remote debugging is no longer + // supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // , this attribute is ignored. + // - INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. + // - INSTANCE_LABELS: The label of the device instance. + // - FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE. + // - Operator: The filter operator. + // - The EQUALS operator is available for every attribute except + // INSTANCE_LABELS. + // - The CONTAINS operator is available for the INSTANCE_LABELS and MODEL + // attributes. + // - The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, + // MANUFACTURER, and INSTANCE_ARN attributes. + // - The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and + // GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION + // attribute. + // - Values: An array of one or more filter values. + // - The IN and NOT_IN operators take a values array that has one or more + // elements. + // - The other operators require an array with a single element. + // - In a request, the AVAILABILITY attribute takes the following values: + // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. Filters []types.DeviceFilter // An identifier that was returned from the previous call to this operation, which diff --git a/service/devicefarm/api_op_ListNetworkProfiles.go b/service/devicefarm/api_op_ListNetworkProfiles.go index 9e524e76037..6392acffe50 100644 --- a/service/devicefarm/api_op_ListNetworkProfiles.go +++ b/service/devicefarm/api_op_ListNetworkProfiles.go @@ -29,8 +29,8 @@ func (c *Client) ListNetworkProfiles(ctx context.Context, params *ListNetworkPro type ListNetworkProfilesInput struct { - // The Amazon Resource Name (ARN) of the project for which you want to list network - // profiles. + // The Amazon Resource Name (ARN) of the project for which you want to list + // network profiles. // // This member is required. Arn *string @@ -39,8 +39,8 @@ type ListNetworkProfilesInput struct { // can be used to return the next set of items in the list. NextToken *string - // The type of network profile to return information about. Valid values are listed - // here. + // The type of network profile to return information about. Valid values are + // listed here. Type types.NetworkProfileType noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_ListOfferingTransactions.go b/service/devicefarm/api_op_ListOfferingTransactions.go index 8bb7397d640..81fe393c73c 100644 --- a/service/devicefarm/api_op_ListOfferingTransactions.go +++ b/service/devicefarm/api_op_ListOfferingTransactions.go @@ -16,8 +16,8 @@ import ( // transactions for an AWS account. The list is paginated and ordered by a // descending timestamp (most recent transactions are first). The API returns a // NotEligible error if the user is not permitted to invoke the operation. If you -// must be able to invoke this operation, contact aws-devicefarm-support@amazon.com -// (mailto:aws-devicefarm-support@amazon.com). +// must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) +// . func (c *Client) ListOfferingTransactions(ctx context.Context, params *ListOfferingTransactionsInput, optFns ...func(*Options)) (*ListOfferingTransactionsOutput, error) { if params == nil { params = &ListOfferingTransactionsInput{} diff --git a/service/devicefarm/api_op_ListOfferings.go b/service/devicefarm/api_op_ListOfferings.go index d69708aafb1..988f27feb9a 100644 --- a/service/devicefarm/api_op_ListOfferings.go +++ b/service/devicefarm/api_op_ListOfferings.go @@ -16,8 +16,8 @@ import ( // API. Each offering record indicates the recurring price per unit and the // frequency for that offering. The API returns a NotEligible error if the user is // not permitted to invoke the operation. If you must be able to invoke this -// operation, contact aws-devicefarm-support@amazon.com -// (mailto:aws-devicefarm-support@amazon.com). +// operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) +// . func (c *Client) ListOfferings(ctx context.Context, params *ListOfferingsInput, optFns ...func(*Options)) (*ListOfferingsOutput, error) { if params == nil { params = &ListOfferingsInput{} diff --git a/service/devicefarm/api_op_ListRemoteAccessSessions.go b/service/devicefarm/api_op_ListRemoteAccessSessions.go index cf76e719e0b..b94248caec1 100644 --- a/service/devicefarm/api_op_ListRemoteAccessSessions.go +++ b/service/devicefarm/api_op_ListRemoteAccessSessions.go @@ -43,8 +43,8 @@ type ListRemoteAccessSessionsInput struct { noSmithyDocumentSerde } -// Represents the response from the server after AWS Device Farm makes a request to -// return information about the remote access session. +// Represents the response from the server after AWS Device Farm makes a request +// to return information about the remote access session. type ListRemoteAccessSessionsOutput struct { // An identifier that was returned from the previous call to this operation, which diff --git a/service/devicefarm/api_op_ListTagsForResource.go b/service/devicefarm/api_op_ListTagsForResource.go index 537314568de..a46a2be32fe 100644 --- a/service/devicefarm/api_op_ListTagsForResource.go +++ b/service/devicefarm/api_op_ListTagsForResource.go @@ -30,9 +30,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource or resources for which to list - // tags. You can associate tags with the following Device Farm resources: PROJECT, - // RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, - // DEVICE, and VPCE_CONFIGURATION. + // tags. You can associate tags with the following Device Farm resources: PROJECT , + // RUN , NETWORK_PROFILE , INSTANCE_PROFILE , DEVICE_INSTANCE , SESSION , + // DEVICE_POOL , DEVICE , and VPCE_CONFIGURATION . // // This member is required. ResourceARN *string diff --git a/service/devicefarm/api_op_ListTestGridProjects.go b/service/devicefarm/api_op_ListTestGridProjects.go index 864bb20f08d..40bbcb17555 100644 --- a/service/devicefarm/api_op_ListTestGridProjects.go +++ b/service/devicefarm/api_op_ListTestGridProjects.go @@ -45,7 +45,7 @@ type ListTestGridProjectsOutput struct { // paginated request. NextToken *string - // The list of TestGridProjects, based on a ListTestGridProjectsRequest. + // The list of TestGridProjects, based on a ListTestGridProjectsRequest . TestGridProjects []types.TestGridProject // Metadata pertaining to the operation's result. diff --git a/service/devicefarm/api_op_ListTestGridSessionActions.go b/service/devicefarm/api_op_ListTestGridSessionActions.go index 18328761de8..59207a6ab42 100644 --- a/service/devicefarm/api_op_ListTestGridSessionActions.go +++ b/service/devicefarm/api_op_ListTestGridSessionActions.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the actions taken in a TestGridSession. +// Returns a list of the actions taken in a TestGridSession . func (c *Client) ListTestGridSessionActions(ctx context.Context, params *ListTestGridSessionActionsInput, optFns ...func(*Options)) (*ListTestGridSessionActionsOutput, error) { if params == nil { params = &ListTestGridSessionActionsInput{} diff --git a/service/devicefarm/api_op_ListTestGridSessionArtifacts.go b/service/devicefarm/api_op_ListTestGridSessionArtifacts.go index 7fa4b545b29..e86aff29a32 100644 --- a/service/devicefarm/api_op_ListTestGridSessionArtifacts.go +++ b/service/devicefarm/api_op_ListTestGridSessionArtifacts.go @@ -30,7 +30,7 @@ func (c *Client) ListTestGridSessionArtifacts(ctx context.Context, params *ListT type ListTestGridSessionArtifactsInput struct { - // The ARN of a TestGridSession. + // The ARN of a TestGridSession . // // This member is required. SessionArn *string @@ -49,7 +49,7 @@ type ListTestGridSessionArtifactsInput struct { type ListTestGridSessionArtifactsOutput struct { - // A list of test grid session artifacts for a TestGridSession. + // A list of test grid session artifacts for a TestGridSession . Artifacts []types.TestGridSessionArtifact // Pagination token. diff --git a/service/devicefarm/api_op_ListTestGridSessions.go b/service/devicefarm/api_op_ListTestGridSessions.go index 245c1fdff03..572b9590ddb 100644 --- a/service/devicefarm/api_op_ListTestGridSessions.go +++ b/service/devicefarm/api_op_ListTestGridSessions.go @@ -13,7 +13,7 @@ import ( "time" ) -// Retrieves a list of sessions for a TestGridProject. +// Retrieves a list of sessions for a TestGridProject . func (c *Client) ListTestGridSessions(ctx context.Context, params *ListTestGridSessionsInput, optFns ...func(*Options)) (*ListTestGridSessionsOutput, error) { if params == nil { params = &ListTestGridSessionsInput{} @@ -31,7 +31,7 @@ func (c *Client) ListTestGridSessions(ctx context.Context, params *ListTestGridS type ListTestGridSessionsInput struct { - // ARN of a TestGridProject. + // ARN of a TestGridProject . // // This member is required. ProjectArn *string @@ -65,7 +65,7 @@ type ListTestGridSessionsOutput struct { // Pagination token. NextToken *string - // The sessions that match the criteria in a ListTestGridSessionsRequest. + // The sessions that match the criteria in a ListTestGridSessionsRequest . TestGridSessions []types.TestGridSession // Metadata pertaining to the operation's result. diff --git a/service/devicefarm/api_op_ListUniqueProblems.go b/service/devicefarm/api_op_ListUniqueProblems.go index e6c35dd6c6d..b667ffbfca9 100644 --- a/service/devicefarm/api_op_ListUniqueProblems.go +++ b/service/devicefarm/api_op_ListUniqueProblems.go @@ -15,7 +15,7 @@ import ( // Gets information about unique problems, such as exceptions or crashes. Unique // problems are defined as a single instance of an error across a run, job, or // suite. For example, if a call in your application consistently raises an -// exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems +// exception ( OutOfBoundsException in MyActivity.java:386 ), ListUniqueProblems // returns a single entry instead of many individual entries for that exception. func (c *Client) ListUniqueProblems(ctx context.Context, params *ListUniqueProblemsInput, optFns ...func(*Options)) (*ListUniqueProblemsOutput, error) { if params == nil { @@ -56,21 +56,13 @@ type ListUniqueProblemsOutput struct { NextToken *string // Information about the unique problems. Allowed values include: - // - // * PENDING - // - // * - // PASSED - // - // * WARNED - // - // * FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED UniqueProblems map[string][]types.UniqueProblem // Metadata pertaining to the operation's result. diff --git a/service/devicefarm/api_op_ListUploads.go b/service/devicefarm/api_op_ListUploads.go index e9533277d31..34c7679a5a9 100644 --- a/service/devicefarm/api_op_ListUploads.go +++ b/service/devicefarm/api_op_ListUploads.go @@ -42,83 +42,38 @@ type ListUploadsInput struct { NextToken *string // The type of upload. Must be one of the following values: - // - // * ANDROID_APP - // - // * - // IOS_APP - // - // * WEB_APP - // - // * EXTERNAL_DATA - // - // * APPIUM_JAVA_JUNIT_TEST_PACKAGE - // - // * - // APPIUM_JAVA_TESTNG_TEST_PACKAGE - // - // * APPIUM_PYTHON_TEST_PACKAGE - // - // * - // APPIUM_NODE_TEST_PACKAGE - // - // * APPIUM_RUBY_TEST_PACKAGE - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE - // - // * - // APPIUM_WEB_PYTHON_TEST_PACKAGE - // - // * APPIUM_WEB_NODE_TEST_PACKAGE - // - // * - // APPIUM_WEB_RUBY_TEST_PACKAGE - // - // * CALABASH_TEST_PACKAGE - // - // * - // INSTRUMENTATION_TEST_PACKAGE - // - // * UIAUTOMATION_TEST_PACKAGE - // - // * - // UIAUTOMATOR_TEST_PACKAGE - // - // * XCTEST_TEST_PACKAGE - // - // * XCTEST_UI_TEST_PACKAGE - // - // * - // APPIUM_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_PYTHON_TEST_SPEC - // - // * APPIUM_NODE_TEST_SPEC - // - // * APPIUM_RUBY_TEST_SPEC - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_WEB_PYTHON_TEST_SPEC - // - // * APPIUM_WEB_NODE_TEST_SPEC - // - // * - // APPIUM_WEB_RUBY_TEST_SPEC - // - // * INSTRUMENTATION_TEST_SPEC - // - // * XCTEST_UI_TEST_SPEC + // - ANDROID_APP + // - IOS_APP + // - WEB_APP + // - EXTERNAL_DATA + // - APPIUM_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_PYTHON_TEST_PACKAGE + // - APPIUM_NODE_TEST_PACKAGE + // - APPIUM_RUBY_TEST_PACKAGE + // - APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_WEB_PYTHON_TEST_PACKAGE + // - APPIUM_WEB_NODE_TEST_PACKAGE + // - APPIUM_WEB_RUBY_TEST_PACKAGE + // - CALABASH_TEST_PACKAGE + // - INSTRUMENTATION_TEST_PACKAGE + // - UIAUTOMATION_TEST_PACKAGE + // - UIAUTOMATOR_TEST_PACKAGE + // - XCTEST_TEST_PACKAGE + // - XCTEST_UI_TEST_PACKAGE + // - APPIUM_JAVA_JUNIT_TEST_SPEC + // - APPIUM_JAVA_TESTNG_TEST_SPEC + // - APPIUM_PYTHON_TEST_SPEC + // - APPIUM_NODE_TEST_SPEC + // - APPIUM_RUBY_TEST_SPEC + // - APPIUM_WEB_JAVA_JUNIT_TEST_SPEC + // - APPIUM_WEB_JAVA_TESTNG_TEST_SPEC + // - APPIUM_WEB_PYTHON_TEST_SPEC + // - APPIUM_WEB_NODE_TEST_SPEC + // - APPIUM_WEB_RUBY_TEST_SPEC + // - INSTRUMENTATION_TEST_SPEC + // - XCTEST_UI_TEST_SPEC Type types.UploadType noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_PurchaseOffering.go b/service/devicefarm/api_op_PurchaseOffering.go index 60026431974..9756e2d36bc 100644 --- a/service/devicefarm/api_op_PurchaseOffering.go +++ b/service/devicefarm/api_op_PurchaseOffering.go @@ -15,7 +15,7 @@ import ( // latest total purchased quantity for an offering, unless the renewal was // overridden. The API returns a NotEligible error if the user is not permitted to // invoke the operation. If you must be able to invoke this operation, contact -// aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com). +// aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) . func (c *Client) PurchaseOffering(ctx context.Context, params *PurchaseOfferingInput, optFns ...func(*Options)) (*PurchaseOfferingOutput, error) { if params == nil { params = &PurchaseOfferingInput{} diff --git a/service/devicefarm/api_op_RenewOffering.go b/service/devicefarm/api_op_RenewOffering.go index b8dda576dbc..7475ff4d36f 100644 --- a/service/devicefarm/api_op_RenewOffering.go +++ b/service/devicefarm/api_op_RenewOffering.go @@ -12,10 +12,10 @@ import ( ) // Explicitly sets the quantity of devices to renew for an offering, starting from -// the effectiveDate of the next period. The API returns a NotEligible error if the -// user is not permitted to invoke the operation. If you must be able to invoke -// this operation, contact aws-devicefarm-support@amazon.com -// (mailto:aws-devicefarm-support@amazon.com). +// the effectiveDate of the next period. The API returns a NotEligible error if +// the user is not permitted to invoke the operation. If you must be able to invoke +// this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) +// . func (c *Client) RenewOffering(ctx context.Context, params *RenewOfferingInput, optFns ...func(*Options)) (*RenewOfferingOutput, error) { if params == nil { params = &RenewOfferingInput{} diff --git a/service/devicefarm/api_op_ScheduleRun.go b/service/devicefarm/api_op_ScheduleRun.go index f4d1aaac6de..cd3b75cfa76 100644 --- a/service/devicefarm/api_op_ScheduleRun.go +++ b/service/devicefarm/api_op_ScheduleRun.go @@ -41,7 +41,7 @@ type ScheduleRunInput struct { Test *types.ScheduleRunTest // The ARN of an application package to run tests against, created with - // CreateUpload. See ListUploads. + // CreateUpload . See ListUploads . AppArn *string // Information about the settings for the run to be scheduled. diff --git a/service/devicefarm/api_op_StopRemoteAccessSession.go b/service/devicefarm/api_op_StopRemoteAccessSession.go index 7087233efca..c969d6a30bf 100644 --- a/service/devicefarm/api_op_StopRemoteAccessSession.go +++ b/service/devicefarm/api_op_StopRemoteAccessSession.go @@ -38,8 +38,8 @@ type StopRemoteAccessSessionInput struct { noSmithyDocumentSerde } -// Represents the response from the server that describes the remote access session -// when AWS Device Farm stops the session. +// Represents the response from the server that describes the remote access +// session when AWS Device Farm stops the session. type StopRemoteAccessSessionOutput struct { // A container that represents the metadata from the service about the remote diff --git a/service/devicefarm/api_op_TagResource.go b/service/devicefarm/api_op_TagResource.go index 41d412029cb..0fb8d522cce 100644 --- a/service/devicefarm/api_op_TagResource.go +++ b/service/devicefarm/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource are not specified in the request parameters, they // are not changed. When a resource is deleted, the tags associated with that // resource are also deleted. @@ -33,9 +33,9 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource or resources to which to add - // tags. You can associate tags with the following Device Farm resources: PROJECT, - // RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, - // DEVICE, and VPCE_CONFIGURATION. + // tags. You can associate tags with the following Device Farm resources: PROJECT , + // RUN , NETWORK_PROFILE , INSTANCE_PROFILE , DEVICE_INSTANCE , SESSION , + // DEVICE_POOL , DEVICE , and VPCE_CONFIGURATION . // // This member is required. ResourceARN *string diff --git a/service/devicefarm/api_op_UntagResource.go b/service/devicefarm/api_op_UntagResource.go index deca42bafc3..a7dd673c28f 100644 --- a/service/devicefarm/api_op_UntagResource.go +++ b/service/devicefarm/api_op_UntagResource.go @@ -28,10 +28,10 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource or resources from which to delete - // tags. You can associate tags with the following Device Farm resources: PROJECT, - // RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, - // DEVICE, and VPCE_CONFIGURATION. + // The Amazon Resource Name (ARN) of the resource or resources from which to + // delete tags. You can associate tags with the following Device Farm resources: + // PROJECT , RUN , NETWORK_PROFILE , INSTANCE_PROFILE , DEVICE_INSTANCE , SESSION , + // DEVICE_POOL , DEVICE , and VPCE_CONFIGURATION . // // This member is required. ResourceARN *string diff --git a/service/devicefarm/api_op_UpdateDevicePool.go b/service/devicefarm/api_op_UpdateDevicePool.go index df652a2abb7..415cbac2081 100644 --- a/service/devicefarm/api_op_UpdateDevicePool.go +++ b/service/devicefarm/api_op_UpdateDevicePool.go @@ -38,11 +38,11 @@ type UpdateDevicePoolInput struct { Arn *string // Sets whether the maxDevices parameter applies to your device pool. If you set - // this parameter to true, the maxDevices parameter does not apply, and Device Farm - // does not limit the number of devices that it adds to your device pool. In this - // case, Device Farm adds all available devices that meet the criteria specified in - // the rules parameter. If you use this parameter in your request, you cannot use - // the maxDevices parameter in the same request. + // this parameter to true , the maxDevices parameter does not apply, and Device + // Farm does not limit the number of devices that it adds to your device pool. In + // this case, Device Farm adds all available devices that meet the criteria + // specified in the rules parameter. If you use this parameter in your request, + // you cannot use the maxDevices parameter in the same request. ClearMaxDevices *bool // A description of the device pool to update. diff --git a/service/devicefarm/api_op_UpdateInstanceProfile.go b/service/devicefarm/api_op_UpdateInstanceProfile.go index dea8eccc944..412b25b7e2b 100644 --- a/service/devicefarm/api_op_UpdateInstanceProfile.go +++ b/service/devicefarm/api_op_UpdateInstanceProfile.go @@ -39,7 +39,7 @@ type UpdateInstanceProfileInput struct { // An array of strings that specifies the list of app packages that should not be // cleaned up from the device after a test run is over. The list of packages is - // only considered if you set packageCleanup to true. + // only considered if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string // The updated name for your instance profile. @@ -50,7 +50,7 @@ type UpdateInstanceProfileInput struct { PackageCleanup *bool // The updated choice for whether you want to reboot the device after use. The - // default value is true. + // default value is true . RebootAfterUse *bool noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_UpdateNetworkProfile.go b/service/devicefarm/api_op_UpdateNetworkProfile.go index f2e0a023758..f78a2742aee 100644 --- a/service/devicefarm/api_op_UpdateNetworkProfile.go +++ b/service/devicefarm/api_op_UpdateNetworkProfile.go @@ -56,8 +56,8 @@ type UpdateNetworkProfileInput struct { // The name of the network profile about which you are returning information. Name *string - // The type of network profile to return information about. Valid values are listed - // here. + // The type of network profile to return information about. Valid values are + // listed here. Type types.NetworkProfileType // The data throughput rate in bits per second, as an integer from 0 to 104857600. diff --git a/service/devicefarm/api_op_UpdateUpload.go b/service/devicefarm/api_op_UpdateUpload.go index da65c269c94..8166bbc042c 100644 --- a/service/devicefarm/api_op_UpdateUpload.go +++ b/service/devicefarm/api_op_UpdateUpload.go @@ -34,7 +34,7 @@ type UpdateUploadInput struct { // This member is required. Arn *string - // The upload's content type (for example, application/x-yaml). + // The upload's content type (for example, application/x-yaml ). ContentType *string // Set to true if the YAML file has changed and must be updated. Otherwise, set to diff --git a/service/devicefarm/doc.go b/service/devicefarm/doc.go index 4507e5bc9ef..0e4ea16d938 100644 --- a/service/devicefarm/doc.go +++ b/service/devicefarm/doc.go @@ -4,17 +4,13 @@ // AWS Device Farm. // // Welcome to the AWS Device Farm API documentation, which contains APIs for: -// -// * -// Testing on desktop browsers Device Farm makes it possible for you to test your -// web applications on desktop browsers using Selenium. The APIs for desktop -// browser testing contain TestGrid in their names. For more information, see -// Testing Web Applications on Selenium with Device Farm -// (https://docs.aws.amazon.com/devicefarm/latest/testgrid/). -// -// * Testing on real -// mobile devices Device Farm makes it possible for you to test apps on physical -// phones, tablets, and other devices in the cloud. For more information, see the -// Device Farm Developer Guide -// (https://docs.aws.amazon.com/devicefarm/latest/developerguide/). +// - Testing on desktop browsers Device Farm makes it possible for you to test +// your web applications on desktop browsers using Selenium. The APIs for desktop +// browser testing contain TestGrid in their names. For more information, see +// Testing Web Applications on Selenium with Device Farm (https://docs.aws.amazon.com/devicefarm/latest/testgrid/) +// . +// - Testing on real mobile devices Device Farm makes it possible for you to +// test apps on physical phones, tablets, and other devices in the cloud. For more +// information, see the Device Farm Developer Guide (https://docs.aws.amazon.com/devicefarm/latest/developerguide/) +// . package devicefarm diff --git a/service/devicefarm/types/enums.go b/service/devicefarm/types/enums.go index 9f6cbbf8ea3..6a5e95704e8 100644 --- a/service/devicefarm/types/enums.go +++ b/service/devicefarm/types/enums.go @@ -56,9 +56,9 @@ const ( ArtifactTypeTestspecOutput ArtifactType = "TESTSPEC_OUTPUT" ) -// Values returns all known values for ArtifactType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ArtifactType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ArtifactType) Values() []ArtifactType { return []ArtifactType{ "UNKNOWN", @@ -117,9 +117,9 @@ const ( CurrencyCodeUsd CurrencyCode = "USD" ) -// Values returns all known values for CurrencyCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CurrencyCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CurrencyCode) Values() []CurrencyCode { return []CurrencyCode{ "USD", @@ -206,8 +206,8 @@ const ( DeviceFilterAttributeFleetType DeviceFilterAttribute = "FLEET_TYPE" ) -// Values returns all known values for DeviceFilterAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DeviceFilterAttribute. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DeviceFilterAttribute) Values() []DeviceFilterAttribute { return []DeviceFilterAttribute{ @@ -445,9 +445,9 @@ const ( OfferingTypeRecurring OfferingType = "RECURRING" ) -// Values returns all known values for OfferingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OfferingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OfferingType) Values() []OfferingType { return []OfferingType{ "RECURRING", @@ -461,9 +461,9 @@ const ( RecurringChargeFrequencyMonthly RecurringChargeFrequency = "MONTHLY" ) -// Values returns all known values for RecurringChargeFrequency. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecurringChargeFrequency. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RecurringChargeFrequency) Values() []RecurringChargeFrequency { return []RecurringChargeFrequency{ "MONTHLY", @@ -484,9 +484,9 @@ const ( RuleOperatorContains RuleOperator = "CONTAINS" ) -// Values returns all known values for RuleOperator. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RuleOperator. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RuleOperator) Values() []RuleOperator { return []RuleOperator{ "EQUALS", @@ -596,8 +596,8 @@ const ( TestGridSessionStatusErrored TestGridSessionStatus = "ERRORED" ) -// Values returns all known values for TestGridSessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TestGridSessionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TestGridSessionStatus) Values() []TestGridSessionStatus { return []TestGridSessionStatus{ @@ -691,9 +691,9 @@ const ( UploadStatusFailed UploadStatus = "FAILED" ) -// Values returns all known values for UploadStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UploadStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UploadStatus) Values() []UploadStatus { return []UploadStatus{ "INITIALIZED", diff --git a/service/devicefarm/types/errors.go b/service/devicefarm/types/errors.go index f287a08685a..88019bc032f 100644 --- a/service/devicefarm/types/errors.go +++ b/service/devicefarm/types/errors.go @@ -273,8 +273,8 @@ func (e *TagOperationException) ErrorCode() string { } func (e *TagOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request doesn't comply with the AWS Identity and Access Management (IAM) tag -// policy. Correct your request and then retry it. +// The request doesn't comply with the AWS Identity and Access Management (IAM) +// tag policy. Correct your request and then retry it. type TagPolicyException struct { Message *string @@ -302,8 +302,8 @@ func (e *TagPolicyException) ErrorCode() string { } func (e *TagPolicyException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The list of tags on the repository is over the limit. The maximum number of tags -// that can be applied to a repository is 50. +// The list of tags on the repository is over the limit. The maximum number of +// tags that can be applied to a repository is 50. type TooManyTagsException struct { Message *string diff --git a/service/devicefarm/types/types.go b/service/devicefarm/types/types.go index ec3e8966195..2aafd161d51 100644 --- a/service/devicefarm/types/types.go +++ b/service/devicefarm/types/types.go @@ -25,10 +25,10 @@ type AccountSettings struct { // represents one of the IDs returned by the ListOfferings command. MaxSlots map[string]int32 - // When set to true, for private devices, Device Farm does not sign your app again. - // For public devices, Device Farm always signs your apps again. For more - // information about how Device Farm re-signs your apps, see Do you modify my app? - // (http://aws.amazon.com/device-farm/faqs/) in the AWS Device Farm FAQs. + // When set to true , for private devices, Device Farm does not sign your app + // again. For public devices, Device Farm always signs your apps again. For more + // information about how Device Farm re-signs your apps, see Do you modify my app? (http://aws.amazon.com/device-farm/faqs/) + // in the AWS Device Farm FAQs. SkipAppResign *bool // Information about an AWS account's usage of free trial device minutes. @@ -58,71 +58,35 @@ type Artifact struct { Name *string // The artifact's type. Allowed values include the following: - // - // * UNKNOWN - // - // * - // SCREENSHOT - // - // * DEVICE_LOG - // - // * MESSAGE_LOG - // - // * VIDEO_LOG - // - // * RESULT_LOG - // - // * - // SERVICE_LOG - // - // * WEBKIT_LOG - // - // * INSTRUMENTATION_OUTPUT - // - // * EXERCISER_MONKEY_OUTPUT: - // the artifact (log) generated by an Android fuzz test. - // - // * CALABASH_JSON_OUTPUT - // - // * - // CALABASH_PRETTY_OUTPUT - // - // * CALABASH_STANDARD_OUTPUT - // - // * - // CALABASH_JAVA_XML_OUTPUT - // - // * AUTOMATION_OUTPUT - // - // * APPIUM_SERVER_OUTPUT - // - // * - // APPIUM_JAVA_OUTPUT - // - // * APPIUM_JAVA_XML_OUTPUT - // - // * APPIUM_PYTHON_OUTPUT - // - // * - // APPIUM_PYTHON_XML_OUTPUT - // - // * EXPLORER_EVENT_LOG - // - // * EXPLORER_SUMMARY_LOG - // - // * - // APPLICATION_CRASH_REPORT - // - // * XCTEST_LOG - // - // * VIDEO - // - // * CUSTOMER_ARTIFACT - // - // * - // CUSTOMER_ARTIFACT_LOG - // - // * TESTSPEC_OUTPUT + // - UNKNOWN + // - SCREENSHOT + // - DEVICE_LOG + // - MESSAGE_LOG + // - VIDEO_LOG + // - RESULT_LOG + // - SERVICE_LOG + // - WEBKIT_LOG + // - INSTRUMENTATION_OUTPUT + // - EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz + // test. + // - CALABASH_JSON_OUTPUT + // - CALABASH_PRETTY_OUTPUT + // - CALABASH_STANDARD_OUTPUT + // - CALABASH_JAVA_XML_OUTPUT + // - AUTOMATION_OUTPUT + // - APPIUM_SERVER_OUTPUT + // - APPIUM_JAVA_OUTPUT + // - APPIUM_JAVA_XML_OUTPUT + // - APPIUM_PYTHON_OUTPUT + // - APPIUM_PYTHON_XML_OUTPUT + // - EXPLORER_EVENT_LOG + // - EXPLORER_SUMMARY_LOG + // - APPLICATION_CRASH_REPORT + // - XCTEST_LOG + // - VIDEO + // - CUSTOMER_ARTIFACT + // - CUSTOMER_ARTIFACT_LOG + // - TESTSPEC_OUTPUT Type ArtifactType // The presigned Amazon S3 URL that can be used with a GET request to download the @@ -159,15 +123,15 @@ type Counters struct { noSmithyDocumentSerde } -// Represents the amount of CPU that an app is using on a physical device. Does not -// represent system-wide CPU usage. +// Represents the amount of CPU that an app is using on a physical device. Does +// not represent system-wide CPU usage. type CPU struct { // The CPU's architecture (for example, x86 or ARM). Architecture *string - // The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 - // GHz CPU is expressed as 1200000000. + // The clock speed of the device's CPU, expressed in hertz (Hz). For example, a + // 1.2 GHz CPU is expressed as 1200000000. Clock *float64 // The CPU's frequency. @@ -190,8 +154,8 @@ type CreateRemoteAccessSessionConfiguration struct { // A JSON object that specifies the paths where the artifacts generated by the // customer's tests, on the device or in the test environment, are pulled from. -// Specify deviceHostPaths and optionally specify either iosPaths or androidPaths. -// For web app tests, you can specify both iosPaths and androidPaths. +// Specify deviceHostPaths and optionally specify either iosPaths or androidPaths . +// For web app tests, you can specify both iosPaths and androidPaths . type CustomerArtifactPaths struct { // Comma-separated list of paths on the Android device where the artifacts @@ -202,8 +166,8 @@ type CustomerArtifactPaths struct { // artifacts generated by the customer's tests are pulled from. DeviceHostPaths []string - // Comma-separated list of paths on the iOS device where the artifacts generated by - // the customer's tests are pulled from. + // Comma-separated list of paths on the iOS device where the artifacts generated + // by the customer's tests are pulled from. IosPaths []string noSmithyDocumentSerde @@ -233,10 +197,8 @@ type Device struct { FleetType *string // The device's form factor. Allowed values include: - // - // * PHONE - // - // * TABLET + // - PHONE + // - TABLET FormFactor DeviceFormFactor // The device's heap size, expressed in bytes. @@ -267,10 +229,8 @@ type Device struct { Os *string // The device's platform. Allowed values include: - // - // * ANDROID - // - // * IOS + // - ANDROID + // - IOS Platform DevicePlatform // The device's radio. @@ -280,8 +240,8 @@ type Device struct { RemoteAccessEnabled *bool // This flag is set to true if remote debugging is enabled for the device. Remote - // debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . RemoteDebugEnabled *bool // The resolution of the device. @@ -292,34 +252,34 @@ type Device struct { // Represents a device filter used to select a set of devices to be included in a // test run. This data structure is passed in as the deviceSelectionConfiguration -// parameter to ScheduleRun. For an example of the JSON request syntax, see -// ScheduleRun. It is also passed in as the filters parameter to ListDevices. For -// an example of the JSON request syntax, see ListDevices. +// parameter to ScheduleRun . For an example of the JSON request syntax, see +// ScheduleRun . It is also passed in as the filters parameter to ListDevices . For +// an example of the JSON request syntax, see ListDevices . type DeviceFilter struct { // The aspect of a device such as platform or model used as the selection criteria // in a device filter. The supported operators for each attribute are provided in // the following list. ARN The Amazon Resource Name (ARN) of the device (for - // example, arn:aws:devicefarm:us-west-2::device:12345Example). Supported - // operators: EQUALS, IN, NOT_IN PLATFORM The device platform. Valid values are + // example, arn:aws:devicefarm:us-west-2::device:12345Example ). Supported + // operators: EQUALS , IN , NOT_IN PLATFORM The device platform. Valid values are // ANDROID or IOS. Supported operators: EQUALS OS_VERSION The operating system - // version (for example, 10.3.2). Supported operators: EQUALS, GREATER_THAN, - // GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN MODEL The - // device model (for example, iPad 5th Gen). Supported operators: CONTAINS, EQUALS, - // IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are - // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. Supported - // operators: EQUALS FORM_FACTOR The device form factor. Valid values are PHONE or - // TABLET. Supported operators: EQUALS MANUFACTURER The device manufacturer (for - // example, Apple). Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED - // Whether the device is enabled for remote access. Valid values are TRUE or FALSE. - // Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled - // for remote debugging. Valid values are TRUE or FALSE. Supported operators: - // EQUALS Because remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html), - // this filter is ignored. INSTANCE_ARN The Amazon Resource Name (ARN) of the - // device instance. Supported operators: EQUALS, IN, NOT_IN INSTANCE_LABELS The - // label of the device instance. Supported operators: CONTAINS FLEET_TYPE The fleet - // type. Valid values are PUBLIC or PRIVATE. Supported operators: EQUALS + // version (for example, 10.3.2). Supported operators: EQUALS , GREATER_THAN , + // GREATER_THAN_OR_EQUALS , IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN MODEL + // The device model (for example, iPad 5th Gen). Supported operators: CONTAINS , + // EQUALS , IN , NOT_IN AVAILABILITY The current availability of the device. Valid + // values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. + // Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values + // are PHONE or TABLET. Supported operators: EQUALS MANUFACTURER The device + // manufacturer (for example, Apple). Supported operators: EQUALS , IN , NOT_IN + // REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid + // values are TRUE or FALSE. Supported operators: EQUALS REMOTE_DEBUG_ENABLED + // Whether the device is enabled for remote debugging. Valid values are TRUE or + // FALSE. Supported operators: EQUALS Because remote debugging is no longer + // supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // , this filter is ignored. INSTANCE_ARN The Amazon Resource Name (ARN) of the + // device instance. Supported operators: EQUALS , IN , NOT_IN INSTANCE_LABELS The + // label of the device instance. Supported operators: CONTAINS FLEET_TYPE The + // fleet type. Valid values are PUBLIC or PRIVATE. Supported operators: EQUALS // // This member is required. Attribute DeviceFilterAttribute @@ -330,27 +290,16 @@ type DeviceFilter struct { // This member is required. Operator RuleOperator - // An array of one or more filter values used in a device filter. Operator - // Values - // - // * The IN and NOT_IN operators can take a values array that has more than - // one element. - // - // * The other operators require an array with a single - // element. - // + // An array of one or more filter values used in a device filter. Operator Values + // - The IN and NOT_IN operators can take a values array that has more than one + // element. + // - The other operators require an array with a single element. // Attribute Values - // - // * The PLATFORM attribute can be set to ANDROID or - // IOS. - // - // * The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, - // BUSY, or TEMPORARY_NOT_AVAILABLE. - // - // * The FORM_FACTOR attribute can be set to - // PHONE or TABLET. - // - // * The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE. + // - The PLATFORM attribute can be set to ANDROID or IOS. + // - The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, + // or TEMPORARY_NOT_AVAILABLE. + // - The FORM_FACTOR attribute can be set to PHONE or TABLET. + // - The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE. // // This member is required. Values []string @@ -424,12 +373,9 @@ type DevicePool struct { Rules []Rule // The device pool's type. Allowed values include: - // - // * CURATED: A device pool that - // is created and managed by AWS Device Farm. - // - // * PRIVATE: A device pool that is - // created and managed by the device pool developer. + // - CURATED: A device pool that is created and managed by AWS Device Farm. + // - PRIVATE: A device pool that is created and managed by the device pool + // developer. Type DevicePoolType noSmithyDocumentSerde @@ -452,93 +398,51 @@ type DevicePoolCompatibilityResult struct { // Represents the device filters used in a test run and the maximum number of // devices to be included in the run. It is passed in as the -// deviceSelectionConfiguration request parameter in ScheduleRun. +// deviceSelectionConfiguration request parameter in ScheduleRun . type DeviceSelectionConfiguration struct { // Used to dynamically select a set of devices for a test run. A filter is made up // of an attribute, an operator, and one or more values. - // - // * Attribute The aspect of - // a device such as platform or model used as the selection criteria in a device - // filter. Allowed values include: - // - // * ARN: The Amazon Resource Name (ARN) of the - // device (for example, arn:aws:devicefarm:us-west-2::device:12345Example). - // - // * - // PLATFORM: The device platform. Valid values are ANDROID or IOS. - // - // * OS_VERSION: - // The operating system version (for example, 10.3.2). - // - // * MODEL: The device model - // (for example, iPad 5th Gen). - // - // * AVAILABILITY: The current availability of the - // device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or - // TEMPORARY_NOT_AVAILABLE. - // - // * FORM_FACTOR: The device form factor. Valid values - // are PHONE or TABLET. - // - // * MANUFACTURER: The device manufacturer (for example, - // Apple). - // - // * REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote - // access. Valid values are TRUE or FALSE. - // - // * REMOTE_DEBUG_ENABLED: Whether the - // device is enabled for remote debugging. Valid values are TRUE or FALSE. Because - // remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html), - // this filter is ignored. - // - // * INSTANCE_ARN: The Amazon Resource Name (ARN) of the - // device instance. - // - // * INSTANCE_LABELS: The label of the device instance. - // - // * - // FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE. - // - // * Operator The - // filter operator. - // - // * The EQUALS operator is available for every attribute except - // INSTANCE_LABELS. - // - // * The CONTAINS operator is available for the INSTANCE_LABELS - // and MODEL attributes. - // - // * The IN and NOT_IN operators are available for the ARN, - // OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. - // - // * The LESS_THAN, - // GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also - // available for the OS_VERSION attribute. - // - // * Values An array of one or more filter - // values. Operator Values - // - // * The IN and NOT_IN operators can take a values array - // that has more than one element. - // - // * The other operators require an array with a - // single element. - // - // Attribute Values - // - // * The PLATFORM attribute can be set to - // ANDROID or IOS. - // - // * The AVAILABILITY attribute can be set to AVAILABLE, - // HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. - // - // * The FORM_FACTOR attribute - // can be set to PHONE or TABLET. - // - // * The FLEET_TYPE attribute can be set to PUBLIC - // or PRIVATE. + // - Attribute The aspect of a device such as platform or model used as the + // selection criteria in a device filter. Allowed values include: + // - ARN: The Amazon Resource Name (ARN) of the device (for example, + // arn:aws:devicefarm:us-west-2::device:12345Example ). + // - PLATFORM: The device platform. Valid values are ANDROID or IOS. + // - OS_VERSION: The operating system version (for example, 10.3.2). + // - MODEL: The device model (for example, iPad 5th Gen). + // - AVAILABILITY: The current availability of the device. Valid values are + // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. + // - FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET. + // - MANUFACTURER: The device manufacturer (for example, Apple). + // - REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. + // Valid values are TRUE or FALSE. + // - REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. + // Valid values are TRUE or FALSE. Because remote debugging is no longer + // supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // , this filter is ignored. + // - INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. + // - INSTANCE_LABELS: The label of the device instance. + // - FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE. + // - Operator The filter operator. + // - The EQUALS operator is available for every attribute except + // INSTANCE_LABELS. + // - The CONTAINS operator is available for the INSTANCE_LABELS and MODEL + // attributes. + // - The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, + // MANUFACTURER, and INSTANCE_ARN attributes. + // - The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and + // GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION + // attribute. + // - Values An array of one or more filter values. Operator Values + // - The IN and NOT_IN operators can take a values array that has more than one + // element. + // - The other operators require an array with a single element. Attribute + // Values + // - The PLATFORM attribute can be set to ANDROID or IOS. + // - The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, + // or TEMPORARY_NOT_AVAILABLE. + // - The FORM_FACTOR attribute can be set to PHONE or TABLET. + // - The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE. // // This member is required. Filters []DeviceFilter @@ -551,9 +455,9 @@ type DeviceSelectionConfiguration struct { noSmithyDocumentSerde } -// Contains the run results requested by the device selection configuration and how -// many devices were returned. For an example of the JSON response syntax, see -// ScheduleRun. +// Contains the run results requested by the device selection configuration and +// how many devices were returned. For an example of the JSON response syntax, see +// ScheduleRun . type DeviceSelectionResult struct { // The filters in a device selection result. @@ -584,10 +488,10 @@ type ExecutionConfiguration struct { // The number of minutes a test run executes before it times out. JobTimeoutMinutes *int32 - // When set to true, for private devices, Device Farm does not sign your app again. - // For public devices, Device Farm always signs your apps again. For more - // information about how Device Farm re-signs your apps, see Do you modify my app? - // (http://aws.amazon.com/device-farm/faqs/) in the AWS Device Farm FAQs. + // When set to true , for private devices, Device Farm does not sign your app + // again. For public devices, Device Farm always signs your apps again. For more + // information about how Device Farm re-signs your apps, see Do you modify my app? (http://aws.amazon.com/device-farm/faqs/) + // in the AWS Device Farm FAQs. SkipAppResign *bool // Set to true to enable video capture. Otherwise, set to false. The default is @@ -604,20 +508,12 @@ type IncompatibilityMessage struct { Message *string // The type of incompatibility. Allowed values include: - // - // * ARN - // - // * FORM_FACTOR (for - // example, phone or tablet) - // - // * MANUFACTURER - // - // * PLATFORM (for example, Android or - // iOS) - // - // * REMOTE_ACCESS_ENABLED - // - // * APPIUM_VERSION + // - ARN + // - FORM_FACTOR (for example, phone or tablet) + // - MANUFACTURER + // - PLATFORM (for example, Android or iOS) + // - REMOTE_ACCESS_ENABLED + // - APPIUM_VERSION Type DeviceAttribute noSmithyDocumentSerde @@ -634,18 +530,18 @@ type InstanceProfile struct { // An array of strings containing the list of app packages that should not be // cleaned up from the device after a test run completes. The list of packages is - // considered only if you set packageCleanup to true. + // considered only if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string // The name of the instance profile. Name *string - // When set to true, Device Farm removes app packages after a test run. The default - // value is false for private devices. + // When set to true , Device Farm removes app packages after a test run. The + // default value is false for private devices. PackageCleanup *bool - // When set to true, Device Farm reboots the instance after a test run. The default - // value is true. + // When set to true , Device Farm reboots the instance after a test run. The + // default value is true . RebootAfterUse *bool noSmithyDocumentSerde @@ -679,95 +575,53 @@ type Job struct { Name *string // The job's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * WARNED - // - // * - // FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED Result ExecutionResult // The job's start time. Started *time.Time // The job's status. Allowed values include: - // - // * PENDING - // - // * PENDING_CONCURRENCY - // - // * - // PENDING_DEVICE - // - // * PROCESSING - // - // * SCHEDULING - // - // * PREPARING - // - // * RUNNING - // - // * - // COMPLETED - // - // * STOPPING + // - PENDING + // - PENDING_CONCURRENCY + // - PENDING_DEVICE + // - PROCESSING + // - SCHEDULING + // - PREPARING + // - RUNNING + // - COMPLETED + // - STOPPING Status ExecutionStatus // The job's stop time. Stopped *time.Time // The job's type. Allowed values include the following: - // - // * BUILTIN_FUZZ - // - // * - // BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, - // interacting with it and capturing screenshots at the same time. - // - // * - // APPIUM_JAVA_JUNIT - // - // * APPIUM_JAVA_TESTNG - // - // * APPIUM_PYTHON - // - // * APPIUM_NODE - // - // * - // APPIUM_RUBY - // - // * APPIUM_WEB_JAVA_JUNIT - // - // * APPIUM_WEB_JAVA_TESTNG - // - // * - // APPIUM_WEB_PYTHON - // - // * APPIUM_WEB_NODE - // - // * APPIUM_WEB_RUBY - // - // * CALABASH - // - // * - // INSTRUMENTATION - // - // * UIAUTOMATION - // - // * UIAUTOMATOR - // - // * XCTEST - // - // * XCTEST_UI + // - BUILTIN_FUZZ + // - BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android + // app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT + // - APPIUM_JAVA_TESTNG + // - APPIUM_PYTHON + // - APPIUM_NODE + // - APPIUM_RUBY + // - APPIUM_WEB_JAVA_JUNIT + // - APPIUM_WEB_JAVA_TESTNG + // - APPIUM_WEB_PYTHON + // - APPIUM_WEB_NODE + // - APPIUM_WEB_RUBY + // - CALABASH + // - INSTRUMENTATION + // - UIAUTOMATION + // - UIAUTOMATOR + // - XCTEST + // - XCTEST_UI Type TestType // This value is set to true if video capture is enabled. Otherwise, it is set to @@ -865,13 +719,13 @@ type Offering struct { // The ID that corresponds to a device offering. Id *string - // The platform of the device (for example, ANDROID or IOS). + // The platform of the device (for example, ANDROID or IOS ). Platform DevicePlatform // Specifies whether there are recurring charges for the offering. RecurringCharges []RecurringCharge - // The type of offering (for example, RECURRING) for a device. + // The type of offering (for example, RECURRING ) for a device. Type OfferingType noSmithyDocumentSerde @@ -941,21 +795,13 @@ type Problem struct { Message *string // The problem's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * WARNED - // - // * - // FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED Result ExecutionResult // Information about the associated run. @@ -1042,15 +888,15 @@ type RemoteAccessSession struct { Arn *string // The billing method of the remote access session. Possible values include METERED - // or UNMETERED. For more information about metered devices, see AWS Device Farm - // terminology - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology). + // or UNMETERED . For more information about metered devices, see AWS Device Farm + // terminology (https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology) + // . BillingMethod BillingMethod - // Unique identifier of your client for the remote access session. Only returned if - // remote debugging is enabled for the remote access session. Remote debugging is - // no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // Unique identifier of your client for the remote access session. Only returned + // if remote debugging is enabled for the remote access session. Remote debugging + // is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . ClientId *string // The date and time the remote access session was created. @@ -1065,8 +911,8 @@ type RemoteAccessSession struct { // Unique device identifier for the remote device. Only returned if remote // debugging is enabled for the remote access session. Remote debugging is no - // longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . DeviceUdid *string // The endpoint for the remote access sesssion. @@ -1074,27 +920,22 @@ type RemoteAccessSession struct { // IP address of the EC2 host where you need to connect to remotely debug devices. // Only returned if remote debugging is enabled for the remote access session. - // Remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // Remote debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . HostAddress *string // The ARN of the instance. InstanceArn *string // The interaction mode of the remote access session. Valid values are: - // - // * - // INTERACTIVE: You can interact with the iOS device by viewing, touching, and - // rotating the screen. You cannot run XCUITest framework-based tests in this - // mode. - // - // * NO_VIDEO: You are connected to the device, but cannot interact with it - // or view the screen. This mode has the fastest test execution speed. You can run - // XCUITest framework-based tests in this mode. - // - // * VIDEO_ONLY: You can view the - // screen, but cannot touch or rotate it. You can run XCUITest framework-based - // tests and watch the screen in this mode. + // - INTERACTIVE: You can interact with the iOS device by viewing, touching, and + // rotating the screen. You cannot run XCUITest framework-based tests in this mode. + // + // - NO_VIDEO: You are connected to the device, but cannot interact with it or + // view the screen. This mode has the fastest test execution speed. You can run + // XCUITest framework-based tests in this mode. + // - VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can + // run XCUITest framework-based tests and watch the screen in this mode. InteractionMode InteractionMode // A message about the remote access session. @@ -1104,8 +945,8 @@ type RemoteAccessSession struct { Name *string // This flag is set to true if remote debugging is enabled for the remote access - // session. Remote debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html). + // session. Remote debugging is no longer supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // . RemoteDebugEnabled *bool // The ARN for the app to be recorded in the remote access session. @@ -1116,53 +957,34 @@ type RemoteAccessSession struct { RemoteRecordEnabled *bool // The result of the remote access session. Can be any of the following: - // - // * - // PENDING. - // - // * PASSED. - // - // * WARNED. - // - // * FAILED. - // - // * SKIPPED. - // - // * ERRORED. - // - // * STOPPED. + // - PENDING. + // - PASSED. + // - WARNED. + // - FAILED. + // - SKIPPED. + // - ERRORED. + // - STOPPED. Result ExecutionResult - // When set to true, for private devices, Device Farm does not sign your app again. - // For public devices, Device Farm always signs your apps again. For more - // information about how Device Farm re-signs your apps, see Do you modify my app? - // (http://aws.amazon.com/device-farm/faqs/) in the AWS Device Farm FAQs. + // When set to true , for private devices, Device Farm does not sign your app + // again. For public devices, Device Farm always signs your apps again. For more + // information about how Device Farm re-signs your apps, see Do you modify my app? (http://aws.amazon.com/device-farm/faqs/) + // in the AWS Device Farm FAQs. SkipAppResign *bool // The date and time the remote access session was started. Started *time.Time // The status of the remote access session. Can be any of the following: - // - // * - // PENDING. - // - // * PENDING_CONCURRENCY. - // - // * PENDING_DEVICE. - // - // * PROCESSING. - // - // * - // SCHEDULING. - // - // * PREPARING. - // - // * RUNNING. - // - // * COMPLETED. - // - // * STOPPING. + // - PENDING. + // - PENDING_CONCURRENCY. + // - PENDING_DEVICE. + // - PROCESSING. + // - SCHEDULING. + // - PREPARING. + // - RUNNING. + // - COMPLETED. + // - STOPPING. Status ExecutionStatus // The date and time the remote access session was stopped. @@ -1190,31 +1012,31 @@ type Resolution struct { // Represents a condition for a device pool. type Rule struct { - // The rule's stringified attribute. For example, specify the value as "\"abc\"". + // The rule's stringified attribute. For example, specify the value as "\"abc\"" . // The supported operators for each attribute are provided in the following list. // APPIUM_VERSION The Appium version for the test. Supported operators: CONTAINS // ARN The Amazon Resource Name (ARN) of the device (for example, - // arn:aws:devicefarm:us-west-2::device:12345Example. Supported operators: EQUALS, - // IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are - // AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. Supported - // operators: EQUALS FLEET_TYPE The fleet type. Valid values are PUBLIC or PRIVATE. - // Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are - // PHONE or TABLET. Supported operators: EQUALS, IN, NOT_IN INSTANCE_ARN The Amazon - // Resource Name (ARN) of the device instance. Supported operators: IN, NOT_IN - // INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS - // MANUFACTURER The device manufacturer (for example, Apple). Supported operators: - // EQUALS, IN, NOT_IN MODEL The device model, such as Apple iPad Air 2 or Google - // Pixel. Supported operators: CONTAINS, EQUALS, IN, NOT_IN OS_VERSION The - // operating system version (for example, 10.3.2). Supported operators: EQUALS, - // GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN - // PLATFORM The device platform. Valid values are ANDROID or IOS. Supported - // operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is - // enabled for remote access. Valid values are TRUE or FALSE. Supported operators: - // EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. - // Valid values are TRUE or FALSE. Supported operators: EQUALS Because remote - // debugging is no longer supported - // (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html), - // this filter is ignored. + // arn:aws:devicefarm:us-west-2::device:12345Example . Supported operators: EQUALS + // , IN , NOT_IN AVAILABILITY The current availability of the device. Valid values + // are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE. Supported + // operators: EQUALS FLEET_TYPE The fleet type. Valid values are PUBLIC or + // PRIVATE. Supported operators: EQUALS FORM_FACTOR The device form factor. Valid + // values are PHONE or TABLET. Supported operators: EQUALS , IN , NOT_IN + // INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported + // operators: IN , NOT_IN INSTANCE_LABELS The label of the device instance. + // Supported operators: CONTAINS MANUFACTURER The device manufacturer (for + // example, Apple). Supported operators: EQUALS , IN , NOT_IN MODEL The device + // model, such as Apple iPad Air 2 or Google Pixel. Supported operators: CONTAINS , + // EQUALS , IN , NOT_IN OS_VERSION The operating system version (for example, + // 10.3.2). Supported operators: EQUALS , GREATER_THAN , GREATER_THAN_OR_EQUALS , + // IN , LESS_THAN , LESS_THAN_OR_EQUALS , NOT_IN PLATFORM The device platform. + // Valid values are ANDROID or IOS. Supported operators: EQUALS , IN , NOT_IN + // REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid + // values are TRUE or FALSE. Supported operators: EQUALS REMOTE_DEBUG_ENABLED + // Whether the device is enabled for remote debugging. Valid values are TRUE or + // FALSE. Supported operators: EQUALS Because remote debugging is no longer + // supported (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html) + // , this filter is ignored. Attribute DeviceAttribute // Specifies how Device Farm compares the rule's attribute to the value. For the @@ -1237,8 +1059,8 @@ type Run struct { // The run's ARN. Arn *string - // Specifies the billing method for a test run: metered or unmetered. If the - // parameter is not specified, the default value is metered. If you have unmetered + // Specifies the billing method for a test run: metered or unmetered . If the + // parameter is not specified, the default value is metered . If you have unmetered // device slots, you must set this to unmetered to use them. Otherwise, the run is // counted toward metered device minutes. BillingMethod BillingMethod @@ -1292,34 +1114,24 @@ type Run struct { ParsingResultUrl *string // The run's platform. Allowed values include: - // - // * ANDROID - // - // * IOS + // - ANDROID + // - IOS Platform DevicePlatform // Information about the radio states for the run. Radios *Radios // The run's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * WARNED - // - // * - // FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED Result ExecutionResult - // Supporting field for the result field. Set only if result is SKIPPED. + // Supporting field for the result field. Set only if result is SKIPPED . // PARSING_FAILED if the result is skipped because of test package parsing failure. ResultCode ExecutionResultCode @@ -1327,36 +1139,25 @@ type Run struct { // the same seed value between tests ensures identical event sequences. Seed *int32 - // When set to true, for private devices, Device Farm does not sign your app again. - // For public devices, Device Farm always signs your apps again. For more - // information about how Device Farm re-signs your apps, see Do you modify my app? - // (http://aws.amazon.com/device-farm/faqs/) in the AWS Device Farm FAQs. + // When set to true , for private devices, Device Farm does not sign your app + // again. For public devices, Device Farm always signs your apps again. For more + // information about how Device Farm re-signs your apps, see Do you modify my app? (http://aws.amazon.com/device-farm/faqs/) + // in the AWS Device Farm FAQs. SkipAppResign *bool // The run's start time. Started *time.Time // The run's status. Allowed values include: - // - // * PENDING - // - // * PENDING_CONCURRENCY - // - // * - // PENDING_DEVICE - // - // * PROCESSING - // - // * SCHEDULING - // - // * PREPARING - // - // * RUNNING - // - // * - // COMPLETED - // - // * STOPPING + // - PENDING + // - PENDING_CONCURRENCY + // - PENDING_DEVICE + // - PROCESSING + // - SCHEDULING + // - PREPARING + // - RUNNING + // - COMPLETED + // - STOPPING Status ExecutionStatus // The run's stop time. @@ -1369,48 +1170,25 @@ type Run struct { TotalJobs *int32 // The run's type. Must be one of the following values: - // - // * BUILTIN_FUZZ - // - // * - // BUILTIN_EXPLORER For Android, an app explorer that traverses an Android app, - // interacting with it and capturing screenshots at the same time. - // - // * - // APPIUM_JAVA_JUNIT - // - // * APPIUM_JAVA_TESTNG - // - // * APPIUM_PYTHON - // - // * APPIUM_NODE - // - // * - // APPIUM_RUBY - // - // * APPIUM_WEB_JAVA_JUNIT - // - // * APPIUM_WEB_JAVA_TESTNG - // - // * - // APPIUM_WEB_PYTHON - // - // * APPIUM_WEB_NODE - // - // * APPIUM_WEB_RUBY - // - // * CALABASH - // - // * - // INSTRUMENTATION - // - // * UIAUTOMATION - // - // * UIAUTOMATOR - // - // * XCTEST - // - // * XCTEST_UI + // - BUILTIN_FUZZ + // - BUILTIN_EXPLORER For Android, an app explorer that traverses an Android + // app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT + // - APPIUM_JAVA_TESTNG + // - APPIUM_PYTHON + // - APPIUM_NODE + // - APPIUM_RUBY + // - APPIUM_WEB_JAVA_JUNIT + // - APPIUM_WEB_JAVA_TESTNG + // - APPIUM_WEB_PYTHON + // - APPIUM_WEB_NODE + // - APPIUM_WEB_RUBY + // - CALABASH + // - INSTRUMENTATION + // - UIAUTOMATION + // - UIAUTOMATOR + // - XCTEST + // - XCTEST_UI Type TestType // The VPC security groups and subnets that are attached to a project. @@ -1429,50 +1207,28 @@ type Sample struct { Arn *string // The sample's type. Must be one of the following values: - // - // * CPU: A CPU sample - // type. This is expressed as the app processing CPU time (including child - // processes) as reported by process, as a percentage. - // - // * MEMORY: A memory usage - // sample type. This is expressed as the total proportional set size of an app - // process, in kilobytes. - // - // * NATIVE_AVG_DRAWTIME - // - // * NATIVE_FPS - // - // * NATIVE_FRAMES - // - // * - // NATIVE_MAX_DRAWTIME - // - // * NATIVE_MIN_DRAWTIME - // - // * OPENGL_AVG_DRAWTIME - // - // * - // OPENGL_FPS - // - // * OPENGL_FRAMES - // - // * OPENGL_MAX_DRAWTIME - // - // * OPENGL_MIN_DRAWTIME - // - // * - // RX - // - // * RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, - // by app process. - // - // * THREADS: A threads sample type. This is expressed as the - // total number of threads per app process. - // - // * TX - // - // * TX_RATE: The total number of - // bytes per second (TCP and UDP) that are received, by app process. + // - CPU: A CPU sample type. This is expressed as the app processing CPU time + // (including child processes) as reported by process, as a percentage. + // - MEMORY: A memory usage sample type. This is expressed as the total + // proportional set size of an app process, in kilobytes. + // - NATIVE_AVG_DRAWTIME + // - NATIVE_FPS + // - NATIVE_FRAMES + // - NATIVE_MAX_DRAWTIME + // - NATIVE_MIN_DRAWTIME + // - OPENGL_AVG_DRAWTIME + // - OPENGL_FPS + // - OPENGL_FRAMES + // - OPENGL_MAX_DRAWTIME + // - OPENGL_MIN_DRAWTIME + // - RX + // - RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, + // by app process. + // - THREADS: A threads sample type. This is expressed as the total number of + // threads per app process. + // - TX + // - TX_RATE: The total number of bytes per second (TCP and UDP) that are + // received, by app process. Type SampleType // The presigned Amazon S3 URL that can be used with a GET request to download the @@ -1489,8 +1245,8 @@ type ScheduleRunConfiguration struct { // A list of upload ARNs for app packages to be installed with your app. AuxiliaryApps []string - // Specifies the billing method for a test run: metered or unmetered. If the - // parameter is not specified, the default value is metered. If you have purchased + // Specifies the billing method for a test run: metered or unmetered . If the + // parameter is not specified, the default value is metered . If you have purchased // unmetered device slots, you must set this parameter to unmetered to make use of // them. Otherwise, your run counts against your metered time. BillingMethod BillingMethod @@ -1520,53 +1276,31 @@ type ScheduleRunConfiguration struct { noSmithyDocumentSerde } -// Represents test settings. This data structure is passed in as the test parameter -// to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun. +// Represents test settings. This data structure is passed in as the test +// parameter to ScheduleRun. For an example of the JSON request syntax, see +// ScheduleRun . type ScheduleRunTest struct { // The test's type. Must be one of the following values: - // - // * BUILTIN_FUZZ - // - // * - // BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, - // interacting with it and capturing screenshots at the same time. - // - // * - // APPIUM_JAVA_JUNIT - // - // * APPIUM_JAVA_TESTNG - // - // * APPIUM_PYTHON - // - // * APPIUM_NODE - // - // * - // APPIUM_RUBY - // - // * APPIUM_WEB_JAVA_JUNIT - // - // * APPIUM_WEB_JAVA_TESTNG - // - // * - // APPIUM_WEB_PYTHON - // - // * APPIUM_WEB_NODE - // - // * APPIUM_WEB_RUBY - // - // * CALABASH - // - // * - // INSTRUMENTATION - // - // * UIAUTOMATION - // - // * UIAUTOMATOR - // - // * XCTEST - // - // * XCTEST_UI + // - BUILTIN_FUZZ + // - BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android + // app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT + // - APPIUM_JAVA_TESTNG + // - APPIUM_PYTHON + // - APPIUM_NODE + // - APPIUM_RUBY + // - APPIUM_WEB_JAVA_JUNIT + // - APPIUM_WEB_JAVA_TESTNG + // - APPIUM_WEB_PYTHON + // - APPIUM_WEB_NODE + // - APPIUM_WEB_RUBY + // - CALABASH + // - INSTRUMENTATION + // - UIAUTOMATION + // - UIAUTOMATOR + // - XCTEST + // - XCTEST_UI // // This member is required. Type TestType @@ -1576,99 +1310,48 @@ type ScheduleRunTest struct { // The test's parameters, such as test framework parameters and fixture settings. // Parameters are represented by name-value pairs of strings. For all tests: - // - // * - // app_performance_monitoring: Performance monitoring is enabled by default. Set - // this parameter to false to disable it. - // + // - app_performance_monitoring : Performance monitoring is enabled by default. + // Set this parameter to false to disable it. // For Calabash tests: - // - // * profile: A - // cucumber profile (for example, my_profile_name). - // - // * tags: You can limit - // execution to features or scenarios that have (or don't have) certain tags (for - // example, @smoke or @smoke,~@wip). - // + // - profile: A cucumber profile (for example, my_profile_name ). + // - tags: You can limit execution to features or scenarios that have (or don't + // have) certain tags (for example, @smoke or @smoke,~@wip). // For Appium tests (all types): - // - // * - // appium_version: The Appium version. Currently supported values are 1.6.5 (and - // later), latest, and default. - // - // * latest runs the latest Appium version supported - // by Device Farm (1.9.1). - // - // * For default, Device Farm selects a compatible version - // of Appium for the device. The current behavior is to run 1.7.2 on Android - // devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later. - // - // * This behavior - // is subject to change. - // + // - appium_version: The Appium version. Currently supported values are 1.6.5 + // (and later), latest, and default. + // - latest runs the latest Appium version supported by Device Farm (1.9.1). + // - For default, Device Farm selects a compatible version of Appium for the + // device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and + // earlier and 1.7.2 for iOS 10 and later. + // - This behavior is subject to change. // For fuzz tests (Android only): - // - // * event_count: The number - // of events, between 1 and 10000, that the UI fuzz test should perform. - // - // * - // throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait - // between events. - // - // * seed: A seed to use for randomizing the UI fuzz test. Using - // the same seed value between tests ensures identical event sequences. - // - // For - // Explorer tests: - // - // * username: A user name to use if the Explorer encounters a - // login form. If not supplied, no user name is inserted. - // - // * password: A password - // to use if the Explorer encounters a login form. If not supplied, no password is - // inserted. - // + // - event_count: The number of events, between 1 and 10000, that the UI fuzz + // test should perform. + // - throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should + // wait between events. + // - seed: A seed to use for randomizing the UI fuzz test. Using the same seed + // value between tests ensures identical event sequences. + // For Explorer tests: + // - username: A user name to use if the Explorer encounters a login form. If + // not supplied, no user name is inserted. + // - password: A password to use if the Explorer encounters a login form. If not + // supplied, no password is inserted. // For Instrumentation: - // - // * filter: A test filter string. Examples: - // - // * - // Running a single test case: com.android.abc.Test1 - // - // * Running a single test: - // com.android.abc.Test1#smoke - // - // * Running multiple tests: - // com.android.abc.Test1,com.android.abc.Test2 - // + // - filter: A test filter string. Examples: + // - Running a single test case: com.android.abc.Test1 + // - Running a single test: com.android.abc.Test1#smoke + // - Running multiple tests: com.android.abc.Test1,com.android.abc.Test2 // For XCTest and XCTestUI: - // - // * filter: - // A test filter string. Examples: - // - // * Running a single test class: LoginTests - // - // * - // Running a multiple test classes: LoginTests,SmokeTests - // - // * Running a single test: - // LoginTests/testValid - // - // * Running multiple tests: - // LoginTests/testValid,LoginTests/testInvalid - // + // - filter: A test filter string. Examples: + // - Running a single test class: LoginTests + // - Running a multiple test classes: LoginTests,SmokeTests + // - Running a single test: LoginTests/testValid + // - Running multiple tests: LoginTests/testValid,LoginTests/testInvalid // For UIAutomator: - // - // * filter: A test - // filter string. Examples: - // - // * Running a single test case: com.android.abc.Test1 - // - // * - // Running a single test: com.android.abc.Test1#smoke - // - // * Running multiple tests: - // com.android.abc.Test1,com.android.abc.Test2 + // - filter: A test filter string. Examples: + // - Running a single test case: com.android.abc.Test1 + // - Running a single test: com.android.abc.Test1#smoke + // - Running multiple tests: com.android.abc.Test1,com.android.abc.Test2 Parameters map[string]string // The ARN of the uploaded test to be run. @@ -1702,95 +1385,53 @@ type Suite struct { Name *string // The suite's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * WARNED - // - // * - // FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED Result ExecutionResult // The suite's start time. Started *time.Time // The suite's status. Allowed values include: - // - // * PENDING - // - // * PENDING_CONCURRENCY - // - // * - // PENDING_DEVICE - // - // * PROCESSING - // - // * SCHEDULING - // - // * PREPARING - // - // * RUNNING - // - // * - // COMPLETED - // - // * STOPPING + // - PENDING + // - PENDING_CONCURRENCY + // - PENDING_DEVICE + // - PROCESSING + // - SCHEDULING + // - PREPARING + // - RUNNING + // - COMPLETED + // - STOPPING Status ExecutionStatus // The suite's stop time. Stopped *time.Time // The suite's type. Must be one of the following values: - // - // * BUILTIN_FUZZ - // - // * - // BUILTIN_EXPLORER Only available for Android; an app explorer that traverses an - // Android app, interacting with it and capturing screenshots at the same time. - // - // * - // APPIUM_JAVA_JUNIT - // - // * APPIUM_JAVA_TESTNG - // - // * APPIUM_PYTHON - // - // * APPIUM_NODE - // - // * - // APPIUM_RUBY - // - // * APPIUM_WEB_JAVA_JUNIT - // - // * APPIUM_WEB_JAVA_TESTNG - // - // * - // APPIUM_WEB_PYTHON - // - // * APPIUM_WEB_NODE - // - // * APPIUM_WEB_RUBY - // - // * CALABASH - // - // * - // INSTRUMENTATION - // - // * UIAUTOMATION - // - // * UIAUTOMATOR - // - // * XCTEST - // - // * XCTEST_UI + // - BUILTIN_FUZZ + // - BUILTIN_EXPLORER Only available for Android; an app explorer that traverses + // an Android app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT + // - APPIUM_JAVA_TESTNG + // - APPIUM_PYTHON + // - APPIUM_NODE + // - APPIUM_RUBY + // - APPIUM_WEB_JAVA_JUNIT + // - APPIUM_WEB_JAVA_TESTNG + // - APPIUM_WEB_PYTHON + // - APPIUM_WEB_NODE + // - APPIUM_WEB_RUBY + // - CALABASH + // - INSTRUMENTATION + // - UIAUTOMATION + // - UIAUTOMATOR + // - XCTEST + // - XCTEST_UI Type TestType noSmithyDocumentSerde @@ -1839,95 +1480,53 @@ type Test struct { Name *string // The test's result. Allowed values include: - // - // * PENDING - // - // * PASSED - // - // * WARNED - // - // * - // FAILED - // - // * SKIPPED - // - // * ERRORED - // - // * STOPPED + // - PENDING + // - PASSED + // - WARNED + // - FAILED + // - SKIPPED + // - ERRORED + // - STOPPED Result ExecutionResult // The test's start time. Started *time.Time // The test's status. Allowed values include: - // - // * PENDING - // - // * PENDING_CONCURRENCY - // - // * - // PENDING_DEVICE - // - // * PROCESSING - // - // * SCHEDULING - // - // * PREPARING - // - // * RUNNING - // - // * - // COMPLETED - // - // * STOPPING + // - PENDING + // - PENDING_CONCURRENCY + // - PENDING_DEVICE + // - PROCESSING + // - SCHEDULING + // - PREPARING + // - RUNNING + // - COMPLETED + // - STOPPING Status ExecutionStatus // The test's stop time. Stopped *time.Time // The test's type. Must be one of the following values: - // - // * BUILTIN_FUZZ - // - // * - // BUILTIN_EXPLORER For Android, an app explorer that traverses an Android app, - // interacting with it and capturing screenshots at the same time. - // - // * - // APPIUM_JAVA_JUNIT - // - // * APPIUM_JAVA_TESTNG - // - // * APPIUM_PYTHON - // - // * APPIUM_NODE - // - // * - // APPIUM_RUBY - // - // * APPIUM_WEB_JAVA_JUNIT - // - // * APPIUM_WEB_JAVA_TESTNG - // - // * - // APPIUM_WEB_PYTHON - // - // * APPIUM_WEB_NODE - // - // * APPIUM_WEB_RUBY - // - // * CALABASH - // - // * - // INSTRUMENTATION - // - // * UIAUTOMATION - // - // * UIAUTOMATOR - // - // * XCTEST - // - // * XCTEST_UI + // - BUILTIN_FUZZ + // - BUILTIN_EXPLORER For Android, an app explorer that traverses an Android + // app, interacting with it and capturing screenshots at the same time. + // - APPIUM_JAVA_JUNIT + // - APPIUM_JAVA_TESTNG + // - APPIUM_PYTHON + // - APPIUM_NODE + // - APPIUM_RUBY + // - APPIUM_WEB_JAVA_JUNIT + // - APPIUM_WEB_JAVA_TESTNG + // - APPIUM_WEB_PYTHON + // - APPIUM_WEB_NODE + // - APPIUM_WEB_RUBY + // - CALABASH + // - INSTRUMENTATION + // - UIAUTOMATION + // - UIAUTOMATOR + // - XCTEST + // - XCTEST_UI Type TestType noSmithyDocumentSerde @@ -1955,7 +1554,7 @@ type TestGridProject struct { } // A TestGridSession is a single instance of a browser launched from the URL -// provided by a call to CreateTestGridUrl. +// provided by a call to CreateTestGridUrl . type TestGridSession struct { // The ARN of the session. @@ -2069,14 +1668,11 @@ type Upload struct { Arn *string // The upload's category. Allowed values include: - // - // * CURATED: An upload managed by - // AWS Device Farm. - // - // * PRIVATE: An upload managed by the AWS Device Farm customer. + // - CURATED: An upload managed by AWS Device Farm. + // - PRIVATE: An upload managed by the AWS Device Farm customer. Category UploadCategory - // The upload's content type (for example, application/octet-stream). + // The upload's content type (for example, application/octet-stream ). ContentType *string // When the upload was created. @@ -2094,95 +1690,45 @@ type Upload struct { Name *string // The upload's status. Must be one of the following values: - // - // * FAILED - // - // * - // INITIALIZED - // - // * PROCESSING - // - // * SUCCEEDED + // - FAILED + // - INITIALIZED + // - PROCESSING + // - SUCCEEDED Status UploadStatus // The upload's type. Must be one of the following values: - // - // * ANDROID_APP - // - // * - // IOS_APP - // - // * WEB_APP - // - // * EXTERNAL_DATA - // - // * APPIUM_JAVA_JUNIT_TEST_PACKAGE - // - // * - // APPIUM_JAVA_TESTNG_TEST_PACKAGE - // - // * APPIUM_PYTHON_TEST_PACKAGE - // - // * - // APPIUM_NODE_TEST_PACKAGE - // - // * APPIUM_RUBY_TEST_PACKAGE - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE - // - // * - // APPIUM_WEB_PYTHON_TEST_PACKAGE - // - // * APPIUM_WEB_NODE_TEST_PACKAGE - // - // * - // APPIUM_WEB_RUBY_TEST_PACKAGE - // - // * CALABASH_TEST_PACKAGE - // - // * - // INSTRUMENTATION_TEST_PACKAGE - // - // * UIAUTOMATION_TEST_PACKAGE - // - // * - // UIAUTOMATOR_TEST_PACKAGE - // - // * XCTEST_TEST_PACKAGE - // - // * XCTEST_UI_TEST_PACKAGE - // - // * - // APPIUM_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_PYTHON_TEST_SPEC - // - // * APPIUM_NODE_TEST_SPEC - // - // * APPIUM_RUBY_TEST_SPEC - // - // * - // APPIUM_WEB_JAVA_JUNIT_TEST_SPEC - // - // * APPIUM_WEB_JAVA_TESTNG_TEST_SPEC - // - // * - // APPIUM_WEB_PYTHON_TEST_SPEC - // - // * APPIUM_WEB_NODE_TEST_SPEC - // - // * - // APPIUM_WEB_RUBY_TEST_SPEC - // - // * INSTRUMENTATION_TEST_SPEC - // - // * XCTEST_UI_TEST_SPEC + // - ANDROID_APP + // - IOS_APP + // - WEB_APP + // - EXTERNAL_DATA + // - APPIUM_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_PYTHON_TEST_PACKAGE + // - APPIUM_NODE_TEST_PACKAGE + // - APPIUM_RUBY_TEST_PACKAGE + // - APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE + // - APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE + // - APPIUM_WEB_PYTHON_TEST_PACKAGE + // - APPIUM_WEB_NODE_TEST_PACKAGE + // - APPIUM_WEB_RUBY_TEST_PACKAGE + // - CALABASH_TEST_PACKAGE + // - INSTRUMENTATION_TEST_PACKAGE + // - UIAUTOMATION_TEST_PACKAGE + // - UIAUTOMATOR_TEST_PACKAGE + // - XCTEST_TEST_PACKAGE + // - XCTEST_UI_TEST_PACKAGE + // - APPIUM_JAVA_JUNIT_TEST_SPEC + // - APPIUM_JAVA_TESTNG_TEST_SPEC + // - APPIUM_PYTHON_TEST_SPEC + // - APPIUM_NODE_TEST_SPEC + // - APPIUM_RUBY_TEST_SPEC + // - APPIUM_WEB_JAVA_JUNIT_TEST_SPEC + // - APPIUM_WEB_JAVA_TESTNG_TEST_SPEC + // - APPIUM_WEB_PYTHON_TEST_SPEC + // - APPIUM_WEB_NODE_TEST_SPEC + // - APPIUM_WEB_RUBY_TEST_SPEC + // - INSTRUMENTATION_TEST_SPEC + // - XCTEST_UI_TEST_SPEC Type UploadType // The presigned Amazon S3 URL that was used to store a file using a PUT request. diff --git a/service/devopsguru/api_client.go b/service/devopsguru/api_client.go index 9f36bca685b..2d27a95ba55 100644 --- a/service/devopsguru/api_client.go +++ b/service/devopsguru/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/devopsguru/api_op_AddNotificationChannel.go b/service/devopsguru/api_op_AddNotificationChannel.go index a6baf017e9d..8aca0910caf 100644 --- a/service/devopsguru/api_op_AddNotificationChannel.go +++ b/service/devopsguru/api_op_AddNotificationChannel.go @@ -17,17 +17,16 @@ import ( // policy to it that grants DevOps Guru permission to it notifications. DevOps Guru // adds the required policy on your behalf to send notifications using Amazon SNS // in your account. DevOps Guru only supports standard SNS topics. For more -// information, see Permissions for cross account Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// If you use an Amazon SNS topic in another account, you must attach a policy to +// information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) +// . If you use an Amazon SNS topic in another account, you must attach a policy to // it that grants DevOps Guru permission to it notifications. DevOps Guru adds the // required policy on your behalf to send notifications using Amazon SNS in your // account. For more information, see Permissions for cross account Amazon SNS // topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web // Services Key Management Service customer-managed key (CMK), then you must add // permissions to the CMK. For more information, see Permissions for Amazon Web -// Services KMS–encrypted Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html). +// Services KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// . func (c *Client) AddNotificationChannel(ctx context.Context, params *AddNotificationChannelInput, optFns ...func(*Options)) (*AddNotificationChannelOutput, error) { if params == nil { params = &AddNotificationChannelInput{} diff --git a/service/devopsguru/api_op_DescribeAccountOverview.go b/service/devopsguru/api_op_DescribeAccountOverview.go index 7b1817bcc96..7392283f5cc 100644 --- a/service/devopsguru/api_op_DescribeAccountOverview.go +++ b/service/devopsguru/api_op_DescribeAccountOverview.go @@ -48,8 +48,8 @@ type DescribeAccountOverviewInput struct { type DescribeAccountOverviewOutput struct { - // The Mean Time to Recover (MTTR) for all closed insights that were created during - // the time range passed in. + // The Mean Time to Recover (MTTR) for all closed insights that were created + // during the time range passed in. // // This member is required. MeanTimeToRecoverInMilliseconds *int64 diff --git a/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go b/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go index 1fe2b0b5fd2..300249e73be 100644 --- a/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go +++ b/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go @@ -82,29 +82,23 @@ type DescribeOrganizationResourceCollectionHealthOutput struct { // resources from different services to indicate that the resources are related. // For example, you can assign the same tag to an Amazon DynamoDB table resource // that you assign to an Lambda function. For more information about using tags, - // see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []types.TagHealth // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_DescribeResourceCollectionHealth.go b/service/devopsguru/api_op_DescribeResourceCollectionHealth.go index 34bbd7cf3f2..eb9ded93d09 100644 --- a/service/devopsguru/api_op_DescribeResourceCollectionHealth.go +++ b/service/devopsguru/api_op_DescribeResourceCollectionHealth.go @@ -76,29 +76,23 @@ type DescribeResourceCollectionHealthOutput struct { // the same tag to resources from different services to indicate that the resources // are related. For example, you can assign the same tag to an Amazon DynamoDB // table resource that you assign to an Lambda function. For more information about - // using tags, see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []types.TagHealth // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_DescribeServiceIntegration.go b/service/devopsguru/api_op_DescribeServiceIntegration.go index 4c59096f2a4..170ea16d15d 100644 --- a/service/devopsguru/api_op_DescribeServiceIntegration.go +++ b/service/devopsguru/api_op_DescribeServiceIntegration.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the integration status of services that are integrated with DevOps Guru. -// The one service that can be integrated with DevOps Guru is Amazon Web Services -// Systems Manager, which can be used to create an OpsItem for each generated -// insight. +// Returns the integration status of services that are integrated with DevOps +// Guru. The one service that can be integrated with DevOps Guru is Amazon Web +// Services Systems Manager, which can be used to create an OpsItem for each +// generated insight. func (c *Client) DescribeServiceIntegration(ctx context.Context, params *DescribeServiceIntegrationInput, optFns ...func(*Options)) (*DescribeServiceIntegrationOutput, error) { if params == nil { params = &DescribeServiceIntegrationInput{} diff --git a/service/devopsguru/api_op_GetCostEstimation.go b/service/devopsguru/api_op_GetCostEstimation.go index 31bcee487d0..eb1d71b2ed0 100644 --- a/service/devopsguru/api_op_GetCostEstimation.go +++ b/service/devopsguru/api_op_GetCostEstimation.go @@ -14,9 +14,8 @@ import ( // Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon // Web Services resources. For more information, see Estimate your Amazon DevOps -// Guru costs -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) -// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +// Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/) . func (c *Client) GetCostEstimation(ctx context.Context, params *GetCostEstimationInput, optFns ...func(*Options)) (*GetCostEstimationOutput, error) { if params == nil { params = &GetCostEstimationInput{} @@ -55,8 +54,8 @@ type GetCostEstimationOutput struct { // DevOps Guru cost estimate. ResourceCollection *types.CostEstimationResourceCollectionFilter - // The status of creating this cost estimate. If it's still in progress, the status - // ONGOING is returned. If it is finished, the status COMPLETED is returned. + // The status of creating this cost estimate. If it's still in progress, the + // status ONGOING is returned. If it is finished, the status COMPLETED is returned. Status types.CostEstimationStatus // The start and end time of the cost estimation. diff --git a/service/devopsguru/api_op_GetResourceCollection.go b/service/devopsguru/api_op_GetResourceCollection.go index 1f646068684..c4eb2a70080 100644 --- a/service/devopsguru/api_op_GetResourceCollection.go +++ b/service/devopsguru/api_op_GetResourceCollection.go @@ -55,8 +55,8 @@ type GetResourceCollectionOutput struct { // operation. If there are no more pages, this value is null. NextToken *string - // The requested list of Amazon Web Services resource collections. The two types of - // Amazon Web Services resource collections supported are Amazon Web Services + // The requested list of Amazon Web Services resource collections. The two types + // of Amazon Web Services resource collections supported are Amazon Web Services // CloudFormation stacks and Amazon Web Services resources that contain the same // Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web // Services resources that are defined in the stacks or that are tagged using the diff --git a/service/devopsguru/api_op_ListAnomaliesForInsight.go b/service/devopsguru/api_op_ListAnomaliesForInsight.go index dced20a237f..2c417582318 100644 --- a/service/devopsguru/api_op_ListAnomaliesForInsight.go +++ b/service/devopsguru/api_op_ListAnomaliesForInsight.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the anomalies that belong to an insight that you specify using -// its ID. +// Returns a list of the anomalies that belong to an insight that you specify +// using its ID. func (c *Client) ListAnomaliesForInsight(ctx context.Context, params *ListAnomaliesForInsightInput, optFns ...func(*Options)) (*ListAnomaliesForInsightOutput, error) { if params == nil { params = &ListAnomaliesForInsightInput{} diff --git a/service/devopsguru/api_op_ListInsights.go b/service/devopsguru/api_op_ListInsights.go index ef588854eb2..15c175aba83 100644 --- a/service/devopsguru/api_op_ListInsights.go +++ b/service/devopsguru/api_op_ListInsights.go @@ -13,8 +13,8 @@ import ( ) // Returns a list of insights in your Amazon Web Services account. You can specify -// which insights are returned by their start time and status (ONGOING, CLOSED, or -// ANY). +// which insights are returned by their start time and status ( ONGOING , CLOSED , +// or ANY ). func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, optFns ...func(*Options)) (*ListInsightsOutput, error) { if params == nil { params = &ListInsightsInput{} diff --git a/service/devopsguru/api_op_ListMonitoredResources.go b/service/devopsguru/api_op_ListMonitoredResources.go index 42d69461ca2..b8c5f093420 100644 --- a/service/devopsguru/api_op_ListMonitoredResources.go +++ b/service/devopsguru/api_op_ListMonitoredResources.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of all log groups that are being monitored and tagged by DevOps -// Guru. +// Returns the list of all log groups that are being monitored and tagged by +// DevOps Guru. func (c *Client) ListMonitoredResources(ctx context.Context, params *ListMonitoredResourcesInput, optFns ...func(*Options)) (*ListMonitoredResourcesOutput, error) { if params == nil { params = &ListMonitoredResourcesInput{} diff --git a/service/devopsguru/api_op_ListRecommendations.go b/service/devopsguru/api_op_ListRecommendations.go index 7e474bfc590..7e60a1e956d 100644 --- a/service/devopsguru/api_op_ListRecommendations.go +++ b/service/devopsguru/api_op_ListRecommendations.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListRecommendationsMiddlewares(stack *middleware.St return nil } -// ListRecommendationsAPIClient is a client that implements the ListRecommendations -// operation. +// ListRecommendationsAPIClient is a client that implements the +// ListRecommendations operation. type ListRecommendationsAPIClient interface { ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error) } diff --git a/service/devopsguru/api_op_SearchInsights.go b/service/devopsguru/api_op_SearchInsights.go index a047fc39e32..01c63948b7d 100644 --- a/service/devopsguru/api_op_SearchInsights.go +++ b/service/devopsguru/api_op_SearchInsights.go @@ -13,11 +13,11 @@ import ( ) // Returns a list of insights in your Amazon Web Services account. You can specify -// which insights are returned by their start time, one or more statuses (ONGOING -// or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE -// or PROACTIVE). Use the Filters parameter to specify status and severity search -// parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your -// search. +// which insights are returned by their start time, one or more statuses ( ONGOING +// or CLOSED ), one or more severities ( LOW , MEDIUM , and HIGH ), and type ( +// REACTIVE or PROACTIVE ). Use the Filters parameter to specify status and +// severity search parameters. Use the Type parameter to specify REACTIVE or +// PROACTIVE in your search. func (c *Client) SearchInsights(ctx context.Context, params *SearchInsightsInput, optFns ...func(*Options)) (*SearchInsightsOutput, error) { if params == nil { params = &SearchInsightsInput{} @@ -41,7 +41,7 @@ type SearchInsightsInput struct { // This member is required. StartTimeRange *types.StartTimeRange - // The type of insights you are searching for (REACTIVE or PROACTIVE). + // The type of insights you are searching for ( REACTIVE or PROACTIVE ). // // This member is required. Type types.InsightType diff --git a/service/devopsguru/api_op_SearchOrganizationInsights.go b/service/devopsguru/api_op_SearchOrganizationInsights.go index d688ed29f04..3d4dc902a2c 100644 --- a/service/devopsguru/api_op_SearchOrganizationInsights.go +++ b/service/devopsguru/api_op_SearchOrganizationInsights.go @@ -13,9 +13,9 @@ import ( ) // Returns a list of insights in your organization. You can specify which insights -// are returned by their start time, one or more statuses (ONGOING, CLOSED, and -// CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or -// PROACTIVE). Use the Filters parameter to specify status and severity search +// are returned by their start time, one or more statuses ( ONGOING , CLOSED , and +// CLOSED ), one or more severities ( LOW , MEDIUM , and HIGH ), and type ( REACTIVE +// or PROACTIVE ). Use the Filters parameter to specify status and severity search // parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your // search. func (c *Client) SearchOrganizationInsights(ctx context.Context, params *SearchOrganizationInsightsInput, optFns ...func(*Options)) (*SearchOrganizationInsightsOutput, error) { @@ -45,7 +45,7 @@ type SearchOrganizationInsightsInput struct { // This member is required. StartTimeRange *types.StartTimeRange - // The type of insights you are searching for (REACTIVE or PROACTIVE). + // The type of insights you are searching for ( REACTIVE or PROACTIVE ). // // This member is required. Type types.InsightType diff --git a/service/devopsguru/doc.go b/service/devopsguru/doc.go index fa6076c75ab..d548f6d0d79 100644 --- a/service/devopsguru/doc.go +++ b/service/devopsguru/doc.go @@ -10,14 +10,12 @@ // resources are analyzed. When anomalous behavior is detected, DevOps Guru creates // an insight that includes recommendations, related events, and related metrics // that can help you improve your operational applications. For more information, -// see What is Amazon DevOps Guru -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html). You can -// specify 1 or 2 Amazon Simple Notification Service topics so you are notified -// every time a new insight is created. You can also enable DevOps Guru to generate -// an OpsItem in Amazon Web Services Systems Manager for each insight to help you -// manage and track your work addressing insights. To learn about the DevOps Guru -// workflow, see How DevOps Guru works -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works). -// To learn about DevOps Guru concepts, see Concepts in DevOps Guru -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html). +// see What is Amazon DevOps Guru (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html) +// . You can specify 1 or 2 Amazon Simple Notification Service topics so you are +// notified every time a new insight is created. You can also enable DevOps Guru to +// generate an OpsItem in Amazon Web Services Systems Manager for each insight to +// help you manage and track your work addressing insights. To learn about the +// DevOps Guru workflow, see How DevOps Guru works (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works) +// . To learn about DevOps Guru concepts, see Concepts in DevOps Guru (https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html) +// . package devopsguru diff --git a/service/devopsguru/types/enums.go b/service/devopsguru/types/enums.go index 60c84329fca..86b383d2b29 100644 --- a/service/devopsguru/types/enums.go +++ b/service/devopsguru/types/enums.go @@ -93,8 +93,8 @@ const ( CloudWatchMetricsStatP50 CloudWatchMetricsStat = "p50" ) -// Values returns all known values for CloudWatchMetricsStat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CloudWatchMetricsStat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchMetricsStat) Values() []CloudWatchMetricsStat { return []CloudWatchMetricsStat{ @@ -217,8 +217,8 @@ const ( InsightFeedbackOptionDataIncorrect InsightFeedbackOption = "DATA_INCORRECT" ) -// Values returns all known values for InsightFeedbackOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InsightFeedbackOption. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InsightFeedbackOption) Values() []InsightFeedbackOption { return []InsightFeedbackOption{ diff --git a/service/devopsguru/types/types.go b/service/devopsguru/types/types.go index ca4b248f8e7..475adcce7b1 100644 --- a/service/devopsguru/types/types.go +++ b/service/devopsguru/types/types.go @@ -24,8 +24,8 @@ type AccountHealth struct { noSmithyDocumentSerde } -// Information about the number of open reactive and proactive insights that can be -// used to gauge the health of your system. +// Information about the number of open reactive and proactive insights that can +// be used to gauge the health of your system. type AccountInsightHealth struct { // An integer that specifies the number of open proactive insights in your Amazon @@ -39,9 +39,9 @@ type AccountInsightHealth struct { noSmithyDocumentSerde } -// Information about your account's integration with Amazon CodeGuru Profiler. This -// returns whether DevOps Guru is configured to consume recommendations generated -// from Amazon CodeGuru Profiler. +// Information about your account's integration with Amazon CodeGuru Profiler. +// This returns whether DevOps Guru is configured to consume recommendations +// generated from Amazon CodeGuru Profiler. type AmazonCodeGuruProfilerIntegration struct { // The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is @@ -77,7 +77,7 @@ type AnomalousLogGroup struct { } // A time range that specifies when DevOps Guru opens and then closes an anomaly. -// This is different from AnomalyTimeRange, which specifies the time range when +// This is different from AnomalyTimeRange , which specifies the time range when // DevOps Guru actually observes the anomalous behavior. type AnomalyReportedTimeRange struct { @@ -92,10 +92,10 @@ type AnomalyReportedTimeRange struct { noSmithyDocumentSerde } -// The Amazon Web Services resources in which DevOps Guru detected unusual behavior -// that resulted in the generation of an anomaly. When DevOps Guru detects multiple -// related anomalies, it creates and insight with details about the anomalous -// behavior and suggestions about how to correct the problem. +// The Amazon Web Services resources in which DevOps Guru detected unusual +// behavior that resulted in the generation of an anomaly. When DevOps Guru detects +// multiple related anomalies, it creates and insight with details about the +// anomalous behavior and suggestions about how to correct the problem. type AnomalyResource struct { // The name of the Amazon Web Services resource. @@ -139,7 +139,7 @@ type AnomalySourceMetadata struct { } // A time range that specifies when the observed unusual behavior in an anomaly -// started and ended. This is different from AnomalyReportedTimeRange, which +// started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. type AnomalyTimeRange struct { @@ -156,9 +156,8 @@ type AnomalyTimeRange struct { // Information about Amazon Web Services CloudFormation stacks. You can use up to // 500 stacks to specify which Amazon Web Services resources in your account to -// analyze. For more information, see Stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in -// the Amazon Web Services CloudFormation User Guide. +// analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the Amazon Web Services CloudFormation User Guide. type CloudFormationCollection struct { // An array of CloudFormation stack names. @@ -169,9 +168,8 @@ type CloudFormationCollection struct { // Information about Amazon Web Services CloudFormation stacks. You can use up to // 500 stacks to specify which Amazon Web Services resources in your account to -// analyze. For more information, see Stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in -// the Amazon Web Services CloudFormation User Guide. +// analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the Amazon Web Services CloudFormation User Guide. type CloudFormationCollectionFilter struct { // An array of CloudFormation stack names. @@ -184,9 +182,8 @@ type CloudFormationCollectionFilter struct { // monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. // The maximum number of stacks you can specify for a cost estimate is one. The // estimate created is for the cost to analyze the Amazon Web Services resources -// defined by the stack. For more information, see Stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in -// the Amazon Web Services CloudFormation User Guide. +// defined by the stack. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the Amazon Web Services CloudFormation User Guide. type CloudFormationCostEstimationResourceCollectionFilter struct { // An array of CloudFormation stack names. Its size is fixed at 1 item. @@ -249,13 +246,12 @@ type CloudWatchMetricsDetail struct { Period int32 // The type of statistic associated with the CloudWatch metric. For more - // information, see Statistics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) + // information, see Statistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) // in the Amazon CloudWatch User Guide. Stat CloudWatchMetricsStat - // The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, - // Count, and Percent. + // The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds + // , Count , and Percent . Unit *string noSmithyDocumentSerde @@ -265,8 +261,7 @@ type CloudWatchMetricsDetail struct { // analyzes the resources in your account for operational problems and anomalous // behavior. A dimension is a name/value pair that is part of the identity of a // metric. A metric can have up to 10 dimensions. For more information, see -// Dimensions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension) +// Dimensions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension) // in the Amazon CloudWatch User Guide. type CloudWatchMetricsDimension struct { @@ -281,44 +276,37 @@ type CloudWatchMetricsDimension struct { // Information about a filter used to specify which Amazon Web Services resources // are analyzed to create a monthly DevOps Guru cost estimate. For more -// information, see Estimate your Amazon DevOps Guru costs -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) -// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +// information, see Estimate your Amazon DevOps Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/) . type CostEstimationResourceCollectionFilter struct { // An object that specifies the CloudFormation stack that defines the Amazon Web // Services resources used to create a monthly estimate for DevOps Guru. CloudFormation *CloudFormationCostEstimationResourceCollectionFilter - // The Amazon Web Services tags used to filter the resource collection that is used - // for a cost estimate. Tags help you identify and organize your Amazon Web + // The Amazon Web Services tags used to filter the resource collection that is + // used for a cost estimate. Tags help you identify and organize your Amazon Web // Services resources. Many Amazon Web Services services support tagging, so you // can assign the same tag to resources from different services to indicate that // the resources are related. For example, you can assign the same tag to an Amazon // DynamoDB table resource that you assign to an Lambda function. For more - // information about using tags, see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // information about using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []TagCostEstimationResourceCollectionFilter noSmithyDocumentSerde @@ -354,8 +342,8 @@ type EndTimeRange struct { // recommendations to improve your operational solutions. type Event struct { - // The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found - // the event. + // The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , where DevOps Guru analysis + // found the event. DataSource EventDataSource // The class of the event. The class specifies what the event is related to, such @@ -449,8 +437,8 @@ type InsightFeedback struct { noSmithyDocumentSerde } -// Information about the number of open reactive and proactive insights that can be -// used to gauge the health of your system. +// Information about the number of open reactive and proactive insights that can +// be used to gauge the health of your system. type InsightHealth struct { // The Meant Time to Recover (MTTR) for the insight. @@ -493,7 +481,7 @@ type ListAnomaliesForInsightFilters struct { // called. type ListEventsFilters struct { - // The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned. + // The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , of the events you want returned. DataSource EventDataSource // The class of the events you want to filter for, such as an infrastructure @@ -537,7 +525,7 @@ type ListInsightsAnyStatusFilter struct { noSmithyDocumentSerde } -// Used to filter for insights that have the status CLOSED. +// Used to filter for insights that have the status CLOSED . type ListInsightsClosedStatusFilter struct { // A time range used to specify when the behavior of the filtered insights ended. @@ -553,7 +541,7 @@ type ListInsightsClosedStatusFilter struct { noSmithyDocumentSerde } -// Used to filter for insights that have the status ONGOING. +// Used to filter for insights that have the status ONGOING . type ListInsightsOngoingStatusFilter struct { // Use to filter for either REACTIVE or PROACTIVE insights. @@ -568,15 +556,15 @@ type ListInsightsOngoingStatusFilter struct { type ListInsightsStatusFilter struct { // A ListInsightsAnyStatusFilter that specifies insights of any status that are - // either REACTIVE or PROACTIVE. + // either REACTIVE or PROACTIVE . Any *ListInsightsAnyStatusFilter // A ListInsightsClosedStatusFilter that specifies closed insights that are either - // REACTIVE or PROACTIVE. + // REACTIVE or PROACTIVE . Closed *ListInsightsClosedStatusFilter // A ListInsightsAnyStatusFilter that specifies ongoing insights that are either - // REACTIVE or PROACTIVE. + // REACTIVE or PROACTIVE . Ongoing *ListInsightsOngoingStatusFilter noSmithyDocumentSerde @@ -695,17 +683,16 @@ type MonitoredResourceIdentifier struct { // Guru permission to it notifications. DevOps Guru adds the required policy on // your behalf to send notifications using Amazon SNS in your account. DevOps Guru // only supports standard SNS topics. For more information, see Permissions for -// cross account Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// If you use an Amazon SNS topic in another account, you must attach a policy to +// cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) +// . If you use an Amazon SNS topic in another account, you must attach a policy to // it that grants DevOps Guru permission to it notifications. DevOps Guru adds the // required policy on your behalf to send notifications using Amazon SNS in your // account. For more information, see Permissions for cross account Amazon SNS // topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web // Services Key Management Service customer-managed key (CMK), then you must add // permissions to the CMK. For more information, see Permissions for Amazon Web -// Services KMS–encrypted Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html). +// Services KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// . type NotificationChannel struct { // A NotificationChannelConfig object that contains information about configured @@ -729,17 +716,16 @@ type NotificationChannelConfig struct { // permission to it notifications. DevOps Guru adds the required policy on your // behalf to send notifications using Amazon SNS in your account. DevOps Guru only // supports standard SNS topics. For more information, see Permissions for cross - // account Amazon SNS topics - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). - // If you use an Amazon SNS topic in another account, you must attach a policy to + // account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) + // . If you use an Amazon SNS topic in another account, you must attach a policy to // it that grants DevOps Guru permission to it notifications. DevOps Guru adds the // required policy on your behalf to send notifications using Amazon SNS in your // account. For more information, see Permissions for cross account Amazon SNS // topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web // Services Key Management Service customer-managed key (CMK), then you must add // permissions to the CMK. For more information, see Permissions for Amazon Web - // Services KMS–encrypted Amazon SNS topics - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html). + // Services KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) + // . // // This member is required. Sns *SnsChannelConfig @@ -764,10 +750,10 @@ type NotificationFilterConfig struct { // new insight is created. MessageTypes []NotificationMessageType - // The severity levels that you want to receive notifications for. For example, you - // can choose to receive notifications only for insights with HIGH and MEDIUM - // severity levels. For more information, see Understanding insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities). + // The severity levels that you want to receive notifications for. For example, + // you can choose to receive notifications only for insights with HIGH and MEDIUM + // severity levels. For more information, see Understanding insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // . Severities []InsightSeverity noSmithyDocumentSerde @@ -798,7 +784,7 @@ type OpsCenterIntegrationConfig struct { // A logical grouping of Performance Insights metrics for a related subject area. // For example, the db.sql dimension group consists of the following dimensions: -// db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id. Each +// db.sql.id , db.sql.db_id , db.sql.statement , and db.sql.tokenized_id . Each // response element returns a maximum of 500 bytes. For larger elements, such as // SQL statements, only the first 500 bytes are returned. Amazon RDS Performance // Insights enables you to monitor and explore different dimensions of database @@ -808,106 +794,61 @@ type OpsCenterIntegrationConfig struct { // data for each time point in the queried time range. Each time point decomposes // overall load in relation to the requested dimensions, measured at that time // point. Examples include SQL, Wait event, User, and Host. -// -// * To learn more about -// Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora -// User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). -// -// * -// To learn more about Performance Insights and Amazon RDS DB instances, go to the -// Amazon RDS User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +// - To learn more about Performance Insights and Amazon Aurora DB instances, go +// to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) +// . +// - To learn more about Performance Insights and Amazon RDS DB instances, go to +// the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) +// . type PerformanceInsightsMetricDimensionGroup struct { // A list of specific dimensions from a dimension group. If this parameter is not // present, then it signifies that all of the dimensions in the group were // requested or are present in the response. Valid values for elements in the // Dimensions array are: - // - // * db.application.name - The name of the application that - // is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) - // - // * - // db.host.id - The host ID of the connected client (all engines) - // - // * db.host.name - - // The host name of the connected client (all engines) - // - // * db.name - The name of the - // database to which the client is connected (only Aurora PostgreSQL, Amazon RDS - // PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) - // - // * db.session_type.name - // - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) - // - // * - // db.sql.id - The SQL ID generated by Performance Insights (all engines) - // - // * - // db.sql.db_id - The SQL ID generated by the database (all engines) - // - // * - // db.sql.statement - The SQL text that is being executed (all engines) - // - // * - // db.sql.tokenized_id - // - // * db.sql_tokenized.id - The SQL digest ID generated by - // Performance Insights (all engines) - // - // * db.sql_tokenized.db_id - SQL digest ID - // generated by the database (all engines) - // - // * db.sql_tokenized.statement - The SQL - // digest text (all engines) - // - // * db.user.id - The ID of the user logged in to the - // database (all engines) - // - // * db.user.name - The name of the user logged in to the - // database (all engines) - // - // * db.wait_event.name - The event for which the backend - // is waiting (all engines) - // - // * db.wait_event.type - The type of event for which the - // backend is waiting (all engines) - // - // * db.wait_event_type.name - The name of the - // event type for which the backend is waiting (all engines) + // - db.application.name - The name of the application that is connected to the + // database (only Aurora PostgreSQL and RDS PostgreSQL) + // - db.host.id - The host ID of the connected client (all engines) + // - db.host.name - The host name of the connected client (all engines) + // - db.name - The name of the database to which the client is connected (only + // Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and + // MariaDB) + // - db.session_type.name - The type of the current session (only Aurora + // PostgreSQL and RDS PostgreSQL) + // - db.sql.id - The SQL ID generated by Performance Insights (all engines) + // - db.sql.db_id - The SQL ID generated by the database (all engines) + // - db.sql.statement - The SQL text that is being executed (all engines) + // - db.sql.tokenized_id + // - db.sql_tokenized.id - The SQL digest ID generated by Performance Insights + // (all engines) + // - db.sql_tokenized.db_id - SQL digest ID generated by the database (all + // engines) + // - db.sql_tokenized.statement - The SQL digest text (all engines) + // - db.user.id - The ID of the user logged in to the database (all engines) + // - db.user.name - The name of the user logged in to the database (all engines) + // - db.wait_event.name - The event for which the backend is waiting (all + // engines) + // - db.wait_event.type - The type of event for which the backend is waiting (all + // engines) + // - db.wait_event_type.name - The name of the event type for which the backend + // is waiting (all engines) Dimensions []string // The name of the dimension group. Its valid values are: - // - // * db - The name of the - // database to which the client is connected (only Aurora PostgreSQL, Amazon RDS - // PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) - // - // * db.application - The - // name of the application that is connected to the database (only Aurora - // PostgreSQL and RDS PostgreSQL) - // - // * db.host - The host name of the connected - // client (all engines) - // - // * db.session_type - The type of the current session (only - // Aurora PostgreSQL and RDS PostgreSQL) - // - // * db.sql - The SQL that is currently - // executing (all engines) - // - // * db.sql_tokenized - The SQL digest (all engines) - // - // * - // db.wait_event - The event for which the database backend is waiting (all - // engines) - // - // * db.wait_event_type - The type of event for which the database - // backend is waiting (all engines) - // - // * db.user - The user logged in to the database - // (all engines) + // - db - The name of the database to which the client is connected (only Aurora + // PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) + // - db.application - The name of the application that is connected to the + // database (only Aurora PostgreSQL and RDS PostgreSQL) + // - db.host - The host name of the connected client (all engines) + // - db.session_type - The type of the current session (only Aurora PostgreSQL + // and RDS PostgreSQL) + // - db.sql - The SQL that is currently executing (all engines) + // - db.sql_tokenized - The SQL digest (all engines) + // - db.wait_event - The event for which the database backend is waiting (all + // engines) + // - db.wait_event_type - The type of event for which the database backend is + // waiting (all engines) + // - db.user - The user logged in to the database (all engines) Group *string // The maximum number of items to fetch for this dimension group. @@ -917,9 +858,8 @@ type PerformanceInsightsMetricDimensionGroup struct { } // A single query to be processed. Use these parameters to query the Performance -// Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more -// information, see GetResourceMetrics -// (https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html) +// Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For +// more information, see GetResourceMetrics (https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html) // in the Amazon RDS Performance Insights API Reference. Amazon RDS Performance // Insights enables you to monitor and explore different dimensions of database // load based on data captured from a running DB instance. DB load is measured as @@ -928,26 +868,19 @@ type PerformanceInsightsMetricDimensionGroup struct { // data for each time point in the queried time range. Each time point decomposes // overall load in relation to the requested dimensions, measured at that time // point. Examples include SQL, Wait event, User, and Host. -// -// * To learn more about -// Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora -// User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). -// -// * -// To learn more about Performance Insights and Amazon RDS DB instances, go to the -// Amazon RDS User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +// - To learn more about Performance Insights and Amazon Aurora DB instances, go +// to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) +// . +// - To learn more about Performance Insights and Amazon RDS DB instances, go to +// the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) +// . type PerformanceInsightsMetricQuery struct { // One or more filters to apply to a Performance Insights GetResourceMetrics API // query. Restrictions: - // - // * Any number of filters by the same dimension, as - // specified in the GroupBy parameter. - // - // * A single filter for any other dimension - // in this dimension group. + // - Any number of filters by the same dimension, as specified in the GroupBy + // parameter. + // - A single filter for any other dimension in this dimension group. Filter map[string]string // The specification for how to aggregate the data points from a Performance @@ -959,20 +892,16 @@ type PerformanceInsightsMetricQuery struct { // The name of the meteric used used when querying an Performance Insights // GetResourceMetrics API for anomaly metrics. Valid values for Metric are: - // - // * - // db.load.avg - a scaled representation of the number of active sessions for the - // database engine. - // - // * db.sampledload.avg - the raw number of active sessions for - // the database engine. - // - // If the number of active sessions is less than an internal - // Performance Insights threshold, db.load.avg and db.sampledload.avg are the same - // value. If the number of active sessions is greater than the internal threshold, - // Performance Insights samples the active sessions, with db.load.avg showing the - // scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg - // less than db.load.avg. For most use cases, you can query db.load.avg only. + // - db.load.avg - a scaled representation of the number of active sessions for + // the database engine. + // - db.sampledload.avg - the raw number of active sessions for the database + // engine. + // If the number of active sessions is less than an internal Performance Insights + // threshold, db.load.avg and db.sampledload.avg are the same value. If the number + // of active sessions is greater than the internal threshold, Performance Insights + // samples the active sessions, with db.load.avg showing the scaled values, + // db.sampledload.avg showing the raw values, and db.sampledload.avg less than + // db.load.avg . For most use cases, you can query db.load.avg only. Metric *string noSmithyDocumentSerde @@ -986,28 +915,24 @@ type PerformanceInsightsMetricQuery struct { // for each time point in the queried time range. Each time point decomposes // overall load in relation to the requested dimensions, measured at that time // point. Examples include SQL, Wait event, User, and Host. -// -// * To learn more about -// Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora -// User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). -// -// * -// To learn more about Performance Insights and Amazon RDS DB instances, go to the -// Amazon RDS User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). +// - To learn more about Performance Insights and Amazon Aurora DB instances, go +// to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) +// . +// - To learn more about Performance Insights and Amazon RDS DB instances, go to +// the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) +// . type PerformanceInsightsMetricsDetail struct { // The name used for a specific Performance Insights metric. MetricDisplayName *string // A single query to be processed for the metric. For more information, see - // PerformanceInsightsMetricQuery - // (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsMetricQuery.html). + // PerformanceInsightsMetricQuery (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsMetricQuery.html) + // . MetricQuery *PerformanceInsightsMetricQuery - // For more information, see PerformanceInsightsReferenceData - // (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceData.html). + // For more information, see PerformanceInsightsReferenceData (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceData.html) + // . ReferenceData []PerformanceInsightsReferenceData // The metric statistics during the anomalous period detected by DevOps Guru; @@ -1047,8 +972,8 @@ type PerformanceInsightsReferenceComparisonValues struct { type PerformanceInsightsReferenceData struct { // The specific reference values used to evaluate the Performance Insights. For - // more information, see PerformanceInsightsReferenceComparisonValues - // (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html). + // more information, see PerformanceInsightsReferenceComparisonValues (https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html) + // . ComparisonValues *PerformanceInsightsReferenceComparisonValues // The name of the reference data. @@ -1104,7 +1029,7 @@ type PredictionTimeRange struct { noSmithyDocumentSerde } -// Information about an anomaly. This object is returned by ListAnomalies. +// Information about an anomaly. This object is returned by ListAnomalies . type ProactiveAnomaly struct { // An AnomalyReportedTimeRange object that specifies the time range between when @@ -1115,7 +1040,7 @@ type ProactiveAnomaly struct { AnomalyResources []AnomalyResource // A time range that specifies when the observed unusual behavior in an anomaly - // started and ended. This is different from AnomalyReportedTimeRange, which + // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange @@ -1148,8 +1073,7 @@ type ProactiveAnomaly struct { // The severity of the anomaly. The severity of anomalies that generate an insight // determine that insight's severity. For more information, see Understanding - // insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity AnomalySeverity @@ -1180,7 +1104,7 @@ type ProactiveAnomalySummary struct { AnomalyResources []AnomalyResource // A time range that specifies when the observed unusual behavior in an anomaly - // started and ended. This is different from AnomalyReportedTimeRange, which + // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange @@ -1213,8 +1137,7 @@ type ProactiveAnomalySummary struct { // The severity of the anomaly. The severity of anomalies that generate an insight // determine that insight's severity. For more information, see Understanding - // insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity AnomalySeverity @@ -1234,7 +1157,7 @@ type ProactiveAnomalySummary struct { noSmithyDocumentSerde } -// Details about a proactive insight. This object is returned by ListInsights. +// Details about a proactive insight. This object is returned by ListInsights . type ProactiveInsight struct { // Describes the proactive insight. @@ -1264,8 +1187,7 @@ type ProactiveInsight struct { ResourceCollection *ResourceCollection // The severity of the insight. For more information, see Understanding insight - // severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1314,8 +1236,7 @@ type ProactiveInsightSummary struct { ServiceCollection *ServiceCollection // The severity of the insight. For more information, see Understanding insight - // severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1325,7 +1246,7 @@ type ProactiveInsightSummary struct { noSmithyDocumentSerde } -// Details about a proactive insight. This object is returned by DescribeInsight. +// Details about a proactive insight. This object is returned by DescribeInsight . type ProactiveOrganizationInsightSummary struct { // The ID of the Amazon Web Services account. @@ -1361,8 +1282,7 @@ type ProactiveOrganizationInsightSummary struct { ServiceCollection *ServiceCollection // An array of severity values used to search for insights. For more information, - // see Understanding insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // see Understanding insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1372,7 +1292,7 @@ type ProactiveOrganizationInsightSummary struct { noSmithyDocumentSerde } -// Details about a reactive anomaly. This object is returned by ListAnomalies. +// Details about a reactive anomaly. This object is returned by ListAnomalies . type ReactiveAnomaly struct { // An AnomalyReportedTimeRange object that specifies the time range between when @@ -1384,7 +1304,7 @@ type ReactiveAnomaly struct { AnomalyResources []AnomalyResource // A time range that specifies when the observed unusual behavior in an anomaly - // started and ended. This is different from AnomalyReportedTimeRange, which + // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange @@ -1416,8 +1336,7 @@ type ReactiveAnomaly struct { // The severity of the anomaly. The severity of anomalies that generate an insight // determine that insight's severity. For more information, see Understanding - // insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity AnomalySeverity @@ -1429,12 +1348,9 @@ type ReactiveAnomaly struct { Status AnomalyStatus // The type of the reactive anomaly. It can be one of the following types. - // - // * - // CAUSAL - the anomaly can cause a new insight. - // - // * CONTEXTUAL - the anomaly - // contains additional information about an insight or its causal anomaly. + // - CAUSAL - the anomaly can cause a new insight. + // - CONTEXTUAL - the anomaly contains additional information about an insight or + // its causal anomaly. Type AnomalyType noSmithyDocumentSerde @@ -1452,7 +1368,7 @@ type ReactiveAnomalySummary struct { AnomalyResources []AnomalyResource // A time range that specifies when the observed unusual behavior in an anomaly - // started and ended. This is different from AnomalyReportedTimeRange, which + // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange @@ -1484,8 +1400,7 @@ type ReactiveAnomalySummary struct { // The severity of the anomaly. The severity of anomalies that generate an insight // determine that insight's severity. For more information, see Understanding - // insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity AnomalySeverity @@ -1497,18 +1412,15 @@ type ReactiveAnomalySummary struct { Status AnomalyStatus // The type of the reactive anomaly. It can be one of the following types. - // - // * - // CAUSAL - the anomaly can cause a new insight. - // - // * CONTEXTUAL - the anomaly - // contains additional information about an insight or its causal anomaly. + // - CAUSAL - the anomaly can cause a new insight. + // - CONTEXTUAL - the anomaly contains additional information about an insight or + // its causal anomaly. Type AnomalyType noSmithyDocumentSerde } -// Information about a reactive insight. This object is returned by ListInsights. +// Information about a reactive insight. This object is returned by ListInsights . type ReactiveInsight struct { // Describes the reactive insight. @@ -1534,8 +1446,7 @@ type ReactiveInsight struct { ResourceCollection *ResourceCollection // The severity of the insight. For more information, see Understanding insight - // severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1581,8 +1492,7 @@ type ReactiveInsightSummary struct { ServiceCollection *ServiceCollection // The severity of the insight. For more information, see Understanding insight - // severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1592,8 +1502,8 @@ type ReactiveInsightSummary struct { noSmithyDocumentSerde } -// Information about a reactive insight. This object is returned by -// DescribeInsight. +// Information about a reactive insight. This object is returned by DescribeInsight +// . type ReactiveOrganizationInsightSummary struct { // The ID of the Amazon Web Services account. @@ -1625,8 +1535,7 @@ type ReactiveOrganizationInsightSummary struct { ServiceCollection *ServiceCollection // An array of severity values used to search for insights. For more information, - // see Understanding insight severities - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) + // see Understanding insight severities (https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) // in the Amazon DevOps Guru User Guide. Severity InsightSeverity @@ -1691,10 +1600,9 @@ type RecommendationRelatedAnomalyResource struct { // The type of the resource. Resource types take the same form that is used by // Amazon Web Services CloudFormation resource type identifiers, - // service-provider::service-name::data-type-name. For example, - // AWS::RDS::DBCluster. For more information, see Amazon Web Services resource and - // property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // service-provider::service-name::data-type-name . For example, + // AWS::RDS::DBCluster . For more information, see Amazon Web Services resource + // and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the Amazon Web Services CloudFormation User Guide. Type *string @@ -1740,8 +1648,8 @@ type RecommendationRelatedEvent struct { noSmithyDocumentSerde } -// Information about an Amazon Web Services resource that emitted and event that is -// related to a recommendation in an insight. +// Information about an Amazon Web Services resource that emitted and event that +// is related to a recommendation in an insight. type RecommendationRelatedEventResource struct { // The name of the resource that emitted the event. This corresponds to the Name @@ -1775,29 +1683,23 @@ type ResourceCollection struct { // the same tag to resources from different services to indicate that the resources // are related. For example, you can assign the same tag to an Amazon DynamoDB // table resource that you assign to an Lambda function. For more information about - // using tags, see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []TagCollection noSmithyDocumentSerde @@ -1809,9 +1711,8 @@ type ResourceCollectionFilter struct { // Information about Amazon Web Services CloudFormation stacks. You can use up to // 500 stacks to specify which Amazon Web Services resources in your account to - // analyze. For more information, see Stacks - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in - // the Amazon Web Services CloudFormation User Guide. + // analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) + // in the Amazon Web Services CloudFormation User Guide. CloudFormation *CloudFormationCollectionFilter // The Amazon Web Services tags used to filter the resources in the resource @@ -1820,38 +1721,32 @@ type ResourceCollectionFilter struct { // the same tag to resources from different services to indicate that the resources // are related. For example, you can assign the same tag to an Amazon DynamoDB // table resource that you assign to an Lambda function. For more information about - // using tags, see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []TagCollectionFilter noSmithyDocumentSerde } // Specifies values used to filter responses when searching for insights. You can -// use a ResourceCollection, ServiceCollection, array of severities, and an array +// use a ResourceCollection , ServiceCollection , array of severities, and an array // of status values. Each filter type contains one or more values to search for. If -// you specify multiple filter types, the filter types are joined with an AND, and +// you specify multiple filter types, the filter types are joined with an AND , and // the request returns only results that match all of the specified filters. type SearchInsightsFilters struct { @@ -1959,9 +1854,8 @@ type ServiceIntegrationConfig struct { // An object that contains information about the estimated monthly cost to analyze // an Amazon Web Services resource. For more information, see Estimate your Amazon -// DevOps Guru costs -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) -// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +// DevOps Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/) . type ServiceResourceCost struct { // The total estimated monthly cost to analyze the active resources for this @@ -1973,8 +1867,8 @@ type ServiceResourceCost struct { Count int32 // The state of the resource. The resource is ACTIVE if it produces metrics, - // events, or logs within an hour, otherwise it is INACTIVE. You pay for the number - // of active Amazon Web Services resource hours analyzed for each resource. + // events, or logs within an hour, otherwise it is INACTIVE . You pay for the + // number of active Amazon Web Services resource hours analyzed for each resource. // Inactive resources are not charged. State CostEstimationServiceResourceState @@ -1982,30 +1876,28 @@ type ServiceResourceCost struct { Type *string // The price per hour to analyze the resources in the service. For more - // information, see Estimate your Amazon DevOps Guru costs - // (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) - // and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). + // information, see Estimate your Amazon DevOps Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) + // and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/) . UnitCost float64 noSmithyDocumentSerde } -// Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service -// topic. If you use an Amazon SNS topic in another account, you must attach a -// policy to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon SNS -// in your account. DevOps Guru only supports standard SNS topics. For more -// information, see Permissions for cross account Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// If you use an Amazon SNS topic in another account, you must attach a policy to +// Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification +// Service topic. If you use an Amazon SNS topic in another account, you must +// attach a policy to it that grants DevOps Guru permission to it notifications. +// DevOps Guru adds the required policy on your behalf to send notifications using +// Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For +// more information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) +// . If you use an Amazon SNS topic in another account, you must attach a policy to // it that grants DevOps Guru permission to it notifications. DevOps Guru adds the // required policy on your behalf to send notifications using Amazon SNS in your // account. For more information, see Permissions for cross account Amazon SNS // topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web // Services Key Management Service customer-managed key (CMK), then you must add // permissions to the CMK. For more information, see Permissions for Amazon Web -// Services KMS–encrypted Amazon SNS topics -// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html). +// Services KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// . type SnsChannelConfig struct { // The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. @@ -2031,50 +1923,45 @@ type StartTimeRange struct { // tagging, so you can assign the same tag to resources from different services to // indicate that the resources are related. For example, you can assign the same // tag to an Amazon DynamoDB table resource that you assign to an Lambda function. -// For more information about using tags, see the Tagging best practices -// (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) +// For more information about using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. +// - A tag key (for example, CostCenter , Environment , Project , or Secret ). +// Tag keys are case-sensitive. +// - An optional field known as a tag value (for example, 111122223333 , +// Production , or a team name). Omitting the tag value is the same as using an +// empty string. Like tag keys, tag values are case-sensitive. // -// * A tag key (for -// example, CostCenter, Environment, Project, or Secret). Tag keys are -// case-sensitive. -// -// * An optional field known as a tag value (for example, -// 111122223333, Production, or a team name). Omitting the tag value is the same as -// using an empty string. Like tag keys, tag values are case-sensitive. -// -// Together -// these are known as key-value pairs. The string used for a key in a tag that you -// use to define your resource coverage must begin with the prefix Devops-guru-. -// The tag key might be DevOps-Guru-deployment-application or -// devops-guru-rds-application. When you create a key, the case of characters in +// Together these are known as key-value pairs. The string used for a key in a tag +// that you use to define your resource coverage must begin with the prefix +// Devops-guru- . The tag key might be DevOps-Guru-deployment-application or +// devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds -// and a key named DevOps-Guru-RDS, and these act as two different keys. Possible +// and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or -// Devops-Guru-production-application/containers. +// Devops-Guru-production-application/containers . type TagCollection struct { // An Amazon Web Services tag key that is used to identify the Amazon Web Services // resources that DevOps Guru analyzes. All Amazon Web Services resources in your // account and Region tagged with this key make up your DevOps Guru application and // analysis boundary. The string used for a key in a tag that you use to define - // your resource coverage must begin with the prefix Devops-guru-. The tag key - // might be DevOps-Guru-deployment-application or devops-guru-rds-application. When - // you create a key, the case of characters in the key can be whatever you choose. - // After you create a key, it is case-sensitive. For example, DevOps Guru works - // with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act - // as two different keys. Possible key/value pairs in your application might be - // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // your resource coverage must begin with the prefix Devops-guru- . The tag key + // might be DevOps-Guru-deployment-application or devops-guru-rds-application . + // When you create a key, the case of characters in the key can be whatever you + // choose. After you create a key, it is case-sensitive. For example, DevOps Guru + // works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and + // these act as two different keys. Possible key/value pairs in your application + // might be Devops-Guru-production-application/RDS or + // Devops-Guru-production-application/containers . // // This member is required. AppBoundaryKey *string // The values in an Amazon Web Services tag collection. The tag's value is an // optional field used to associate a string with the tag key (for example, - // 111122223333, Production, or a team name). The key and value are the tag's key + // 111122223333 , Production , or a team name). The key and value are the tag's key // pair. Omitting the tag value is the same as using an empty string. Like tag // keys, tag values are case-sensitive. You can specify a maximum of 256 characters // for a tag value. @@ -2094,21 +1981,21 @@ type TagCollectionFilter struct { // resources that DevOps Guru analyzes. All Amazon Web Services resources in your // account and Region tagged with this key make up your DevOps Guru application and // analysis boundary. The string used for a key in a tag that you use to define - // your resource coverage must begin with the prefix Devops-guru-. The tag key - // might be DevOps-Guru-deployment-application or devops-guru-rds-application. When - // you create a key, the case of characters in the key can be whatever you choose. - // After you create a key, it is case-sensitive. For example, DevOps Guru works - // with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act - // as two different keys. Possible key/value pairs in your application might be - // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // your resource coverage must begin with the prefix Devops-guru- . The tag key + // might be DevOps-Guru-deployment-application or devops-guru-rds-application . + // When you create a key, the case of characters in the key can be whatever you + // choose. After you create a key, it is case-sensitive. For example, DevOps Guru + // works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and + // these act as two different keys. Possible key/value pairs in your application + // might be Devops-Guru-production-application/RDS or + // Devops-Guru-production-application/containers . // // This member is required. AppBoundaryKey *string // The values in an Amazon Web Services tag collection. The tag's value is an // optional field used to associate a string with the tag key (for example, - // 111122223333, Production, or a team name). The key and value are the tag's key + // 111122223333 , Production , or a team name). The key and value are the tag's key // pair. Omitting the tag value is the same as using an empty string. Like tag // keys, tag values are case-sensitive. You can specify a maximum of 256 characters // for a tag value. @@ -2124,30 +2011,29 @@ type TagCollectionFilter struct { // to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services // resources. The maximum number of tags you can specify for a cost estimate is // one. The estimate created is for the cost to analyze the Amazon Web Services -// resources defined by the tag. For more information, see Stacks -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in -// the Amazon Web Services CloudFormation User Guide. +// resources defined by the tag. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the Amazon Web Services CloudFormation User Guide. type TagCostEstimationResourceCollectionFilter struct { // An Amazon Web Services tag key that is used to identify the Amazon Web Services // resources that DevOps Guru analyzes. All Amazon Web Services resources in your // account and Region tagged with this key make up your DevOps Guru application and // analysis boundary. The string used for a key in a tag that you use to define - // your resource coverage must begin with the prefix Devops-guru-. The tag key - // might be DevOps-Guru-deployment-application or devops-guru-rds-application. When - // you create a key, the case of characters in the key can be whatever you choose. - // After you create a key, it is case-sensitive. For example, DevOps Guru works - // with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act - // as two different keys. Possible key/value pairs in your application might be - // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // your resource coverage must begin with the prefix Devops-guru- . The tag key + // might be DevOps-Guru-deployment-application or devops-guru-rds-application . + // When you create a key, the case of characters in the key can be whatever you + // choose. After you create a key, it is case-sensitive. For example, DevOps Guru + // works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and + // these act as two different keys. Possible key/value pairs in your application + // might be Devops-Guru-production-application/RDS or + // Devops-Guru-production-application/containers . // // This member is required. AppBoundaryKey *string // The values in an Amazon Web Services tag collection. The tag's value is an // optional field used to associate a string with the tag key (for example, - // 111122223333, Production, or a team name). The key and value are the tag's key + // 111122223333 , Production , or a team name). The key and value are the tag's key // pair. Omitting the tag value is the same as using an empty string. Like tag // keys, tag values are case-sensitive. You can specify a maximum of 256 characters // for a tag value. @@ -2170,14 +2056,14 @@ type TagHealth struct { // resources that DevOps Guru analyzes. All Amazon Web Services resources in your // account and Region tagged with this key make up your DevOps Guru application and // analysis boundary. The string used for a key in a tag that you use to define - // your resource coverage must begin with the prefix Devops-guru-. The tag key - // might be DevOps-Guru-deployment-application or devops-guru-rds-application. When - // you create a key, the case of characters in the key can be whatever you choose. - // After you create a key, it is case-sensitive. For example, DevOps Guru works - // with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act - // as two different keys. Possible key/value pairs in your application might be - // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // your resource coverage must begin with the prefix Devops-guru- . The tag key + // might be DevOps-Guru-deployment-application or devops-guru-rds-application . + // When you create a key, the case of characters in the key can be whatever you + // choose. After you create a key, it is case-sensitive. For example, DevOps Guru + // works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and + // these act as two different keys. Possible key/value pairs in your application + // might be Devops-Guru-production-application/RDS or + // Devops-Guru-production-application/containers . AppBoundaryKey *string // Information about the health of the Amazon Web Services resources in your @@ -2187,8 +2073,8 @@ type TagHealth struct { Insight *InsightHealth // The value in an Amazon Web Services tag. The tag's value is an optional field - // used to associate a string with the tag key (for example, 111122223333, - // Production, or a team name). The key and value are the tag's key pair. Omitting + // used to associate a string with the tag key (for example, 111122223333 , + // Production , or a team name). The key and value are the tag's key pair. Omitting // the tag value is the same as using an empty string. Like tag keys, tag values // are case-sensitive. You can specify a maximum of 256 characters for a tag value. TagValue *string @@ -2208,8 +2094,8 @@ type TimestampMetricValuePair struct { noSmithyDocumentSerde } -// Contains the names of Amazon Web Services CloudFormation stacks used to update a -// collection of stacks. You can specify up to 500 Amazon Web Services +// Contains the names of Amazon Web Services CloudFormation stacks used to update +// a collection of stacks. You can specify up to 500 Amazon Web Services // CloudFormation stacks. type UpdateCloudFormationCollectionFilter struct { @@ -2224,8 +2110,8 @@ type UpdateCloudFormationCollectionFilter struct { // resources. type UpdateResourceCollectionFilter struct { - // A collection of Amazon Web Services CloudFormation stacks. You can specify up to - // 500 Amazon Web Services CloudFormation stacks. + // A collection of Amazon Web Services CloudFormation stacks. You can specify up + // to 500 Amazon Web Services CloudFormation stacks. CloudFormation *UpdateCloudFormationCollectionFilter // The updated Amazon Web Services tags used to filter the resources in the @@ -2234,29 +2120,23 @@ type UpdateResourceCollectionFilter struct { // can assign the same tag to resources from different services to indicate that // the resources are related. For example, you can assign the same tag to an Amazon // DynamoDB table resource that you assign to an Lambda function. For more - // information about using tags, see the Tagging best practices - // (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) + // information about using tags, see the Tagging best practices (https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) // whitepaper. Each Amazon Web Services tag has two parts. - // - // * A tag key (for - // example, CostCenter, Environment, Project, or Secret). Tag keys are - // case-sensitive. - // - // * An optional field known as a tag value (for example, - // 111122223333, Production, or a team name). Omitting the tag value is the same as - // using an empty string. Like tag keys, tag values are case-sensitive. - // - // Together - // these are known as key-value pairs. The string used for a key in a tag that you - // use to define your resource coverage must begin with the prefix Devops-guru-. - // The tag key might be DevOps-Guru-deployment-application or - // devops-guru-rds-application. When you create a key, the case of characters in + // - A tag key (for example, CostCenter , Environment , Project , or Secret ). + // Tag keys are case-sensitive. + // - An optional field known as a tag value (for example, 111122223333 , + // Production , or a team name). Omitting the tag value is the same as using an + // empty string. Like tag keys, tag values are case-sensitive. + // Together these are known as key-value pairs. The string used for a key in a tag + // that you use to define your resource coverage must begin with the prefix + // Devops-guru- . The tag key might be DevOps-Guru-deployment-application or + // devops-guru-rds-application . When you create a key, the case of characters in // the key can be whatever you choose. After you create a key, it is // case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds - // and a key named DevOps-Guru-RDS, and these act as two different keys. Possible + // and a key named DevOps-Guru-RDS , and these act as two different keys. Possible // key/value pairs in your application might be // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // Devops-Guru-production-application/containers . Tags []UpdateTagCollectionFilter noSmithyDocumentSerde @@ -2286,21 +2166,21 @@ type UpdateTagCollectionFilter struct { // resources that DevOps Guru analyzes. All Amazon Web Services resources in your // account and Region tagged with this key make up your DevOps Guru application and // analysis boundary. The string used for a key in a tag that you use to define - // your resource coverage must begin with the prefix Devops-guru-. The tag key - // might be DevOps-Guru-deployment-application or devops-guru-rds-application. When - // you create a key, the case of characters in the key can be whatever you choose. - // After you create a key, it is case-sensitive. For example, DevOps Guru works - // with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act - // as two different keys. Possible key/value pairs in your application might be - // Devops-Guru-production-application/RDS or - // Devops-Guru-production-application/containers. + // your resource coverage must begin with the prefix Devops-guru- . The tag key + // might be DevOps-Guru-deployment-application or devops-guru-rds-application . + // When you create a key, the case of characters in the key can be whatever you + // choose. After you create a key, it is case-sensitive. For example, DevOps Guru + // works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and + // these act as two different keys. Possible key/value pairs in your application + // might be Devops-Guru-production-application/RDS or + // Devops-Guru-production-application/containers . // // This member is required. AppBoundaryKey *string // The values in an Amazon Web Services tag collection. The tag's value is an // optional field used to associate a string with the tag key (for example, - // 111122223333, Production, or a team name). The key and value are the tag's key + // 111122223333 , Production , or a team name). The key and value are the tag's key // pair. Omitting the tag value is the same as using an empty string. Like tag // keys, tag values are case-sensitive. You can specify a maximum of 256 characters // for a tag value. diff --git a/service/directconnect/api_client.go b/service/directconnect/api_client.go index e623270e332..6d250253a75 100644 --- a/service/directconnect/api_client.go +++ b/service/directconnect/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go index 2f527f6e0a0..5da1732f8f0 100644 --- a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go @@ -47,8 +47,7 @@ type AcceptDirectConnectGatewayAssociationProposalInput struct { ProposalId *string // 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) + // 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 Direct Connect User Guide. OverrideAllowedPrefixesToDirectConnectGateway []types.RouteFilterPrefix diff --git a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go index b8094015fd3..400f63fd736 100644 --- a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go +++ b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go @@ -12,10 +12,10 @@ import ( "time" ) -// Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on -// an interconnect. Allocates a VLAN number and a specified amount of bandwidth for -// use by a hosted connection on the specified interconnect. Intended for use by -// Direct Connect Partners only. +// Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection +// on an interconnect. Allocates a VLAN number and a specified amount of bandwidth +// for use by a hosted connection on the specified interconnect. Intended for use +// by Direct Connect Partners only. // // Deprecated: This operation has been deprecated. func (c *Client) AllocateConnectionOnInterconnect(ctx context.Context, params *AllocateConnectionOnInterconnectInput, optFns ...func(*Options)) (*AllocateConnectionOnInterconnectOutput, error) { @@ -92,39 +92,24 @@ type AllocateConnectionOnInterconnectOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -156,8 +141,8 @@ type AllocateConnectionOnInterconnectOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_AllocateHostedConnection.go b/service/directconnect/api_op_AllocateHostedConnection.go index 85c4fd79396..3cefb3dbf70 100644 --- a/service/directconnect/api_op_AllocateHostedConnection.go +++ b/service/directconnect/api_op_AllocateHostedConnection.go @@ -95,39 +95,24 @@ type AllocateHostedConnectionOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -159,8 +144,8 @@ type AllocateHostedConnectionOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_AllocatePrivateVirtualInterface.go b/service/directconnect/api_op_AllocatePrivateVirtualInterface.go index e1ee332733c..6ef6b48f248 100644 --- a/service/directconnect/api_op_AllocatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePrivateVirtualInterface.go @@ -13,7 +13,7 @@ import ( // Provisions a private virtual interface to be owned by the specified Amazon Web // Services account. Virtual interfaces created using this action must be confirmed -// by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual +// by the owner using ConfirmPrivateVirtualInterface . Until then, the virtual // interface is in the Confirming state and is not available to handle traffic. func (c *Client) AllocatePrivateVirtualInterface(ctx context.Context, params *AllocatePrivateVirtualInterfaceInput, optFns ...func(*Options)) (*AllocatePrivateVirtualInterfaceOutput, error) { if params == nil { @@ -99,8 +99,8 @@ type AllocatePrivateVirtualInterfaceOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -126,49 +126,34 @@ type AllocatePrivateVirtualInterfaceOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/api_op_AllocatePublicVirtualInterface.go b/service/directconnect/api_op_AllocatePublicVirtualInterface.go index ba16b641161..4da1caf9fb1 100644 --- a/service/directconnect/api_op_AllocatePublicVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePublicVirtualInterface.go @@ -15,7 +15,7 @@ import ( // Services account. The owner of a connection calls this function to provision a // public virtual interface to be owned by the specified Amazon Web Services // account. Virtual interfaces created using this function must be confirmed by the -// owner using ConfirmPublicVirtualInterface. Until this step has been completed, +// owner using ConfirmPublicVirtualInterface . Until this step has been completed, // the virtual interface is in the confirming state and is not available to handle // traffic. When creating an IPv6 public virtual interface, omit the Amazon address // and customer address. IPv6 addresses are automatically assigned from the Amazon @@ -104,8 +104,8 @@ type AllocatePublicVirtualInterfaceOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -131,49 +131,34 @@ type AllocatePublicVirtualInterfaceOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/api_op_AllocateTransitVirtualInterface.go b/service/directconnect/api_op_AllocateTransitVirtualInterface.go index 16f73755c94..35cef26ba91 100644 --- a/service/directconnect/api_op_AllocateTransitVirtualInterface.go +++ b/service/directconnect/api_op_AllocateTransitVirtualInterface.go @@ -16,7 +16,7 @@ import ( // your Direct Connect gateway. The owner of a connection provisions a transit // virtual interface to be owned by the specified Amazon Web Services account. // After you create a transit virtual interface, it must be confirmed by the owner -// using ConfirmTransitVirtualInterface. Until this step has been completed, the +// using ConfirmTransitVirtualInterface . Until this step has been completed, the // transit virtual interface is in the requested state and is not available to // handle traffic. func (c *Client) AllocateTransitVirtualInterface(ctx context.Context, params *AllocateTransitVirtualInterfaceInput, optFns ...func(*Options)) (*AllocateTransitVirtualInterfaceOutput, error) { diff --git a/service/directconnect/api_op_AssociateConnectionWithLag.go b/service/directconnect/api_op_AssociateConnectionWithLag.go index a47dbdc2817..94300795f94 100644 --- a/service/directconnect/api_op_AssociateConnectionWithLag.go +++ b/service/directconnect/api_op_AssociateConnectionWithLag.go @@ -81,39 +81,24 @@ type AssociateConnectionWithLagOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -145,8 +130,8 @@ type AssociateConnectionWithLagOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_AssociateHostedConnection.go b/service/directconnect/api_op_AssociateHostedConnection.go index 0ee644565c9..859ed00403d 100644 --- a/service/directconnect/api_op_AssociateHostedConnection.go +++ b/service/directconnect/api_op_AssociateHostedConnection.go @@ -73,39 +73,24 @@ type AssociateHostedConnectionOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -137,8 +122,8 @@ type AssociateHostedConnectionOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_AssociateMacSecKey.go b/service/directconnect/api_op_AssociateMacSecKey.go index 42823915f48..542f9d4a58a 100644 --- a/service/directconnect/api_op_AssociateMacSecKey.go +++ b/service/directconnect/api_op_AssociateMacSecKey.go @@ -13,10 +13,9 @@ import ( // Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity // Association Key (CAK) pair with an Direct Connect dedicated connection. You must -// supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request. +// supply either the secretARN, or the CKN/CAK ( ckn and cak ) pair in the request. // For information about MAC Security (MACsec) key considerations, see MACsec -// pre-shared CKN/CAK key considerations -// (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-key-consideration) +// pre-shared CKN/CAK key considerations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-key-consideration) // in the Direct Connect User Guide. func (c *Client) AssociateMacSecKey(ctx context.Context, params *AssociateMacSecKeyInput, optFns ...func(*Options)) (*AssociateMacSecKeyOutput, error) { if params == nil { diff --git a/service/directconnect/api_op_AssociateVirtualInterface.go b/service/directconnect/api_op_AssociateVirtualInterface.go index 0b5bf7ff401..84e0313781f 100644 --- a/service/directconnect/api_op_AssociateVirtualInterface.go +++ b/service/directconnect/api_op_AssociateVirtualInterface.go @@ -17,7 +17,7 @@ import ( // associated virtual interface with a conflicting VLAN number or a conflicting IP // address, the operation fails. Virtual interfaces associated with a hosted // connection cannot be associated with a LAG; hosted connections must be migrated -// along with their virtual interfaces using AssociateHostedConnection. To +// along with their virtual interfaces using AssociateHostedConnection . To // reassociate a virtual interface to a new connection or LAG, the requester must // own either the virtual interface itself or the connection to which the virtual // interface is currently associated. Additionally, the requester must own the @@ -100,8 +100,8 @@ type AssociateVirtualInterfaceOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -127,49 +127,34 @@ type AssociateVirtualInterfaceOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/api_op_ConfirmConnection.go b/service/directconnect/api_op_ConfirmConnection.go index 2fdc81ca18a..ce4d7050943 100644 --- a/service/directconnect/api_op_ConfirmConnection.go +++ b/service/directconnect/api_op_ConfirmConnection.go @@ -43,35 +43,20 @@ type ConfirmConnectionInput struct { type ConfirmConnectionOutput struct { // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_ConfirmCustomerAgreement.go b/service/directconnect/api_op_ConfirmCustomerAgreement.go index 10032ca423a..27c4daf2bc0 100644 --- a/service/directconnect/api_op_ConfirmCustomerAgreement.go +++ b/service/directconnect/api_op_ConfirmCustomerAgreement.go @@ -38,7 +38,7 @@ type ConfirmCustomerAgreementInput struct { type ConfirmCustomerAgreementOutput struct { // The status of the customer agreement when the connection was created. This will - // be either signed or unsigned. + // be either signed or unsigned . Status *string // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go b/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go index ba8105cdc6d..3c3d4425639 100644 --- a/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go @@ -49,40 +49,25 @@ type ConfirmPrivateVirtualInterfaceInput struct { type ConfirmPrivateVirtualInterfaceOutput struct { // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_ConfirmPublicVirtualInterface.go b/service/directconnect/api_op_ConfirmPublicVirtualInterface.go index 84270c28fe6..bb6d5abd4ce 100644 --- a/service/directconnect/api_op_ConfirmPublicVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmPublicVirtualInterface.go @@ -42,40 +42,25 @@ type ConfirmPublicVirtualInterfaceInput struct { type ConfirmPublicVirtualInterfaceOutput struct { // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go index 263379cffe7..13a9fc81b03 100644 --- a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go @@ -48,40 +48,25 @@ type ConfirmTransitVirtualInterfaceInput struct { type ConfirmTransitVirtualInterfaceOutput struct { // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_CreateBGPPeer.go b/service/directconnect/api_op_CreateBGPPeer.go index 52d09e0d993..1247235008f 100644 --- a/service/directconnect/api_op_CreateBGPPeer.go +++ b/service/directconnect/api_op_CreateBGPPeer.go @@ -23,8 +23,8 @@ import ( // 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend // to use the customer router peer IP address as the source and destination for // traffic. Instead you should use RFC 1918 or other addressing, and specify the -// address yourself. For more information about RFC 1918 see Address Allocation -// for Private Internets (https://datatracker.ietf.org/doc/html/rfc1918). For a +// address yourself. For more information about RFC 1918 see Address Allocation +// for Private Internets (https://datatracker.ietf.org/doc/html/rfc1918) . For a // public virtual interface, the Autonomous System Number (ASN) must be private or // already on the allow list for the virtual interface. func (c *Client) CreateBGPPeer(ctx context.Context, params *CreateBGPPeerInput, optFns ...func(*Options)) (*CreateBGPPeerOutput, error) { diff --git a/service/directconnect/api_op_CreateConnection.go b/service/directconnect/api_op_CreateConnection.go index 3445accaefe..6c940e58f92 100644 --- a/service/directconnect/api_op_CreateConnection.go +++ b/service/directconnect/api_op_CreateConnection.go @@ -16,11 +16,11 @@ import ( // location. A connection links your internal network to an Direct Connect location // over a standard Ethernet fiber-optic cable. One end of the cable is connected to // your router, the other to an Direct Connect router. To find the locations for -// your Region, use DescribeLocations. You can automatically add the new connection -// to a link aggregation group (LAG) by specifying a LAG ID in the request. This -// ensures that the new connection is allocated on the same Direct Connect endpoint -// that hosts the specified LAG. If there are no available ports on the endpoint, -// the request fails and no connection is created. +// your Region, use DescribeLocations . You can automatically add the new +// connection to a link aggregation group (LAG) by specifying a LAG ID in the +// request. This ensures that the new connection is allocated on the same Direct +// Connect endpoint that hosts the specified LAG. If there are no available ports +// on the endpoint, the request fails and no connection is created. func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error) { if params == nil { params = &CreateConnectionInput{} @@ -61,8 +61,7 @@ type CreateConnectionInput struct { // Indicates whether you want the connection to support MAC Security (MACsec). MAC // Security (MACsec) is only available on dedicated connections. For information - // about MAC Security (MACsec) prerequisties, see MACsec prerequisties - // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) + // about MAC Security (MACsec) prerequisties, see MACsec prerequisties (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) // in the Direct Connect User Guide. RequestMACSec *bool @@ -97,39 +96,24 @@ type CreateConnectionOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -161,8 +145,8 @@ type CreateConnectionOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go b/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go index 88747b26926..b94eabc5a35 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go @@ -38,8 +38,7 @@ type CreateDirectConnectGatewayAssociationInput struct { // The Amazon VPC prefixes to advertise to the Direct Connect gateway This // parameter is required when you create an association to a transit 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) + // 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 Direct Connect User Guide. AddAllowedPrefixesToDirectConnectGateway []types.RouteFilterPrefix diff --git a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go index ff233f7e29a..74b53082da6 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a proposal to associate the specified virtual private gateway or transit -// gateway with the specified Direct Connect gateway. You can associate a Direct -// Connect gateway and virtual private gateway or transit gateway that is owned by -// any Amazon Web Services account. +// Creates a proposal to associate the specified virtual private gateway or +// transit gateway with the specified Direct Connect gateway. You can associate a +// Direct Connect gateway and virtual private gateway or transit gateway that is +// owned by any Amazon Web Services account. func (c *Client) CreateDirectConnectGatewayAssociationProposal(ctx context.Context, params *CreateDirectConnectGatewayAssociationProposalInput, optFns ...func(*Options)) (*CreateDirectConnectGatewayAssociationProposalOutput, error) { if params == nil { params = &CreateDirectConnectGatewayAssociationProposalInput{} diff --git a/service/directconnect/api_op_CreateInterconnect.go b/service/directconnect/api_op_CreateInterconnect.go index a5ca07de50c..4830add20a6 100644 --- a/service/directconnect/api_op_CreateInterconnect.go +++ b/service/directconnect/api_op_CreateInterconnect.go @@ -25,7 +25,7 @@ import ( // the specified LAG. If there are no available ports on the endpoint, the request // fails and no interconnect is created. For each end customer, the Direct Connect // Partner provisions a connection on their interconnect by calling -// AllocateHostedConnection. The end customer can then connect to Amazon Web +// AllocateHostedConnection . The end customer can then connect to Amazon Web // Services resources by creating a virtual interface on their connection, using // the VLAN assigned to them by the Direct Connect Partner. Intended for use by // Direct Connect Partners only. @@ -102,27 +102,15 @@ type CreateInterconnectOutput struct { InterconnectName *string // The state of the interconnect. The following are the possible values: - // - // * - // requested: The initial state of an interconnect. The interconnect stays in the - // requested state until the Letter of Authorization (LOA) is sent to the - // customer. - // - // * pending: The interconnect is approved, and is being initialized. - // - // * - // available: The network link is up, and the interconnect is ready for use. - // - // * - // down: The network link is down. - // - // * deleting: The interconnect is being - // deleted. - // - // * deleted: The interconnect is deleted. - // - // * unknown: The state of the - // interconnect is not available. + // - requested : The initial state of an interconnect. The interconnect stays in + // the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The interconnect is approved, and is being initialized. + // - available : The network link is up, and the interconnect is ready for use. + // - down : The network link is down. + // - deleting : The interconnect is being deleted. + // - deleted : The interconnect is deleted. + // - unknown : The state of the interconnect is not available. InterconnectState types.InterconnectState // Indicates whether jumbo frames (9001 MTU) are supported. diff --git a/service/directconnect/api_op_CreateLag.go b/service/directconnect/api_op_CreateLag.go index 770dbf9b523..fa406366b5a 100644 --- a/service/directconnect/api_op_CreateLag.go +++ b/service/directconnect/api_op_CreateLag.go @@ -80,8 +80,7 @@ type CreateLagInput struct { // Indicates whether the connection will support MAC Security (MACsec). All // connections in the LAG must be capable of supporting MAC Security (MACsec). For - // information about MAC Security (MACsec) prerequisties, see MACsec prerequisties - // (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) + // information about MAC Security (MACsec) prerequisties, see MACsec prerequisties (https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites) // in the Direct Connect User Guide. RequestMACSec *bool @@ -116,8 +115,8 @@ type CreateLagOutput struct { // possible values are 1Gbps and 10Gbps. ConnectionsBandwidth *string - // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt, - // should_encrypt, and must_encrypt. + // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt , + // should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the LAG supports a secondary BGP peer in the same address @@ -134,26 +133,14 @@ type CreateLagOutput struct { LagName *string // The state of the LAG. The following are the possible values: - // - // * requested: The - // initial state of a LAG. The LAG stays in the requested state until the Letter of - // Authorization (LOA) is available. - // - // * pending: The LAG has been approved and is - // being initialized. - // - // * available: The network link is established and the LAG is - // ready for use. - // - // * down: The network link is down. - // - // * deleting: The LAG is being - // deleted. - // - // * deleted: The LAG is deleted. - // - // * unknown: The state of the LAG is not - // available. + // - requested : The initial state of a LAG. The LAG stays in the requested state + // until the Letter of Authorization (LOA) is available. + // - pending : The LAG has been approved and is being initialized. + // - available : The network link is established and the LAG is ready for use. + // - down : The network link is down. + // - deleting : The LAG is being deleted. + // - deleted : The LAG is deleted. + // - unknown : The state of the LAG is not available. LagState types.LagState // The location of the LAG. @@ -169,8 +156,8 @@ type CreateLagOutput struct { // for the LAG itself to be operational. MinimumLinks int32 - // The number of physical dedicated connections bundled by the LAG, up to a maximum - // of 10. + // The number of physical dedicated connections bundled by the LAG, up to a + // maximum of 10. NumberOfConnections int32 // The ID of the Amazon Web Services account that owns the LAG. diff --git a/service/directconnect/api_op_CreatePrivateVirtualInterface.go b/service/directconnect/api_op_CreatePrivateVirtualInterface.go index d31769ab670..9116f033bab 100644 --- a/service/directconnect/api_op_CreatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_CreatePrivateVirtualInterface.go @@ -22,8 +22,8 @@ import ( // physical connection if it wasn't updated to support jumbo frames. Updating the // connection disrupts network connectivity for all virtual interfaces associated // with the connection for up to 30 seconds. To check whether your connection -// supports jumbo frames, call DescribeConnections. To check whether your virtual -// interface supports jumbo frames, call DescribeVirtualInterfaces. +// supports jumbo frames, call DescribeConnections . To check whether your virtual +// interface supports jumbo frames, call DescribeVirtualInterfaces . func (c *Client) CreatePrivateVirtualInterface(ctx context.Context, params *CreatePrivateVirtualInterfaceInput, optFns ...func(*Options)) (*CreatePrivateVirtualInterfaceOutput, error) { if params == nil { params = &CreatePrivateVirtualInterfaceInput{} @@ -102,8 +102,8 @@ type CreatePrivateVirtualInterfaceOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -129,49 +129,34 @@ type CreatePrivateVirtualInterfaceOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/api_op_CreatePublicVirtualInterface.go b/service/directconnect/api_op_CreatePublicVirtualInterface.go index 24a7ed56517..bc20d962ba1 100644 --- a/service/directconnect/api_op_CreatePublicVirtualInterface.go +++ b/service/directconnect/api_op_CreatePublicVirtualInterface.go @@ -14,9 +14,9 @@ import ( // Creates a public virtual interface. A virtual interface is the VLAN that // transports Direct Connect traffic. A public virtual interface supports sending // traffic to public services of Amazon Web Services such as Amazon S3. When -// creating an IPv6 public virtual interface (addressFamily is ipv6), leave the -// customer and amazon address fields blank to use auto-assigned IPv6 space. Custom -// IPv6 addresses are not supported. +// creating an IPv6 public virtual interface ( addressFamily is ipv6 ), leave the +// customer and amazon address fields blank to use auto-assigned IPv6 space. +// Custom IPv6 addresses are not supported. func (c *Client) CreatePublicVirtualInterface(ctx context.Context, params *CreatePublicVirtualInterfaceInput, optFns ...func(*Options)) (*CreatePublicVirtualInterfaceOutput, error) { if params == nil { params = &CreatePublicVirtualInterfaceInput{} @@ -95,8 +95,8 @@ type CreatePublicVirtualInterfaceOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -122,49 +122,34 @@ type CreatePublicVirtualInterfaceOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/api_op_CreateTransitVirtualInterface.go b/service/directconnect/api_op_CreateTransitVirtualInterface.go index f856a9047ef..b6a39e76334 100644 --- a/service/directconnect/api_op_CreateTransitVirtualInterface.go +++ b/service/directconnect/api_op_CreateTransitVirtualInterface.go @@ -24,9 +24,9 @@ import ( // update to the underlying physical connection if it wasn't updated to support // jumbo frames. Updating the connection disrupts network connectivity for all // virtual interfaces associated with the connection for up to 30 seconds. To check -// whether your connection supports jumbo frames, call DescribeConnections. To +// whether your connection supports jumbo frames, call DescribeConnections . To // check whether your virtual interface supports jumbo frames, call -// DescribeVirtualInterfaces. +// DescribeVirtualInterfaces . func (c *Client) CreateTransitVirtualInterface(ctx context.Context, params *CreateTransitVirtualInterfaceInput, optFns ...func(*Options)) (*CreateTransitVirtualInterfaceOutput, error) { if params == nil { params = &CreateTransitVirtualInterfaceInput{} diff --git a/service/directconnect/api_op_DeleteConnection.go b/service/directconnect/api_op_DeleteConnection.go index 155641b4906..699c367bef2 100644 --- a/service/directconnect/api_op_DeleteConnection.go +++ b/service/directconnect/api_op_DeleteConnection.go @@ -66,39 +66,24 @@ type DeleteConnectionOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -130,8 +115,8 @@ type DeleteConnectionOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go b/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go index aa963a0764e..70ba0ae1935 100644 --- a/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the association between the specified Direct Connect gateway and virtual -// private gateway. We recommend that you specify the associationID to delete the -// association. Alternatively, if you own virtual gateway and a Direct Connect -// gateway association, you can specify the virtualGatewayId and +// Deletes the association between the specified Direct Connect gateway and +// virtual private gateway. We recommend that you specify the associationID to +// delete the association. Alternatively, if you own virtual gateway and a Direct +// Connect gateway association, you can specify the virtualGatewayId and // directConnectGatewayId to delete an association. func (c *Client) DeleteDirectConnectGatewayAssociation(ctx context.Context, params *DeleteDirectConnectGatewayAssociationInput, optFns ...func(*Options)) (*DeleteDirectConnectGatewayAssociationOutput, error) { if params == nil { diff --git a/service/directconnect/api_op_DeleteInterconnect.go b/service/directconnect/api_op_DeleteInterconnect.go index f77dbea53c5..be5297f7e54 100644 --- a/service/directconnect/api_op_DeleteInterconnect.go +++ b/service/directconnect/api_op_DeleteInterconnect.go @@ -41,27 +41,15 @@ type DeleteInterconnectInput struct { type DeleteInterconnectOutput struct { // The state of the interconnect. The following are the possible values: - // - // * - // requested: The initial state of an interconnect. The interconnect stays in the - // requested state until the Letter of Authorization (LOA) is sent to the - // customer. - // - // * pending: The interconnect is approved, and is being initialized. - // - // * - // available: The network link is up, and the interconnect is ready for use. - // - // * - // down: The network link is down. - // - // * deleting: The interconnect is being - // deleted. - // - // * deleted: The interconnect is deleted. - // - // * unknown: The state of the - // interconnect is not available. + // - requested : The initial state of an interconnect. The interconnect stays in + // the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The interconnect is approved, and is being initialized. + // - available : The network link is up, and the interconnect is ready for use. + // - down : The network link is down. + // - deleting : The interconnect is being deleted. + // - deleted : The interconnect is deleted. + // - unknown : The state of the interconnect is not available. InterconnectState types.InterconnectState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_DeleteLag.go b/service/directconnect/api_op_DeleteLag.go index af71f07c406..9e5d5ba8513 100644 --- a/service/directconnect/api_op_DeleteLag.go +++ b/service/directconnect/api_op_DeleteLag.go @@ -63,8 +63,8 @@ type DeleteLagOutput struct { // possible values are 1Gbps and 10Gbps. ConnectionsBandwidth *string - // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt, - // should_encrypt, and must_encrypt. + // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt , + // should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the LAG supports a secondary BGP peer in the same address @@ -81,26 +81,14 @@ type DeleteLagOutput struct { LagName *string // The state of the LAG. The following are the possible values: - // - // * requested: The - // initial state of a LAG. The LAG stays in the requested state until the Letter of - // Authorization (LOA) is available. - // - // * pending: The LAG has been approved and is - // being initialized. - // - // * available: The network link is established and the LAG is - // ready for use. - // - // * down: The network link is down. - // - // * deleting: The LAG is being - // deleted. - // - // * deleted: The LAG is deleted. - // - // * unknown: The state of the LAG is not - // available. + // - requested : The initial state of a LAG. The LAG stays in the requested state + // until the Letter of Authorization (LOA) is available. + // - pending : The LAG has been approved and is being initialized. + // - available : The network link is established and the LAG is ready for use. + // - down : The network link is down. + // - deleting : The LAG is being deleted. + // - deleted : The LAG is deleted. + // - unknown : The state of the LAG is not available. LagState types.LagState // The location of the LAG. @@ -116,8 +104,8 @@ type DeleteLagOutput struct { // for the LAG itself to be operational. MinimumLinks int32 - // The number of physical dedicated connections bundled by the LAG, up to a maximum - // of 10. + // The number of physical dedicated connections bundled by the LAG, up to a + // maximum of 10. NumberOfConnections int32 // The ID of the Amazon Web Services account that owns the LAG. diff --git a/service/directconnect/api_op_DeleteVirtualInterface.go b/service/directconnect/api_op_DeleteVirtualInterface.go index ddd05852aa3..3fc09175662 100644 --- a/service/directconnect/api_op_DeleteVirtualInterface.go +++ b/service/directconnect/api_op_DeleteVirtualInterface.go @@ -40,40 +40,25 @@ type DeleteVirtualInterfaceInput struct { type DeleteVirtualInterfaceOutput struct { // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_DescribeConnectionLoa.go b/service/directconnect/api_op_DescribeConnectionLoa.go index b3115371748..2a22593f14f 100644 --- a/service/directconnect/api_op_DescribeConnectionLoa.go +++ b/service/directconnect/api_op_DescribeConnectionLoa.go @@ -15,9 +15,8 @@ import ( // Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document // that your APN partner or service provider uses when establishing your cross // connect to Amazon Web Services at the colocation facility. For more information, -// see Requesting Cross Connects at Direct Connect Locations -// (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) in -// the Direct Connect User Guide. +// see Requesting Cross Connects at Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. // // Deprecated: This operation has been deprecated. func (c *Client) DescribeConnectionLoa(ctx context.Context, params *DescribeConnectionLoaInput, optFns ...func(*Options)) (*DescribeConnectionLoaOutput, error) { diff --git a/service/directconnect/api_op_DescribeCustomerMetadata.go b/service/directconnect/api_op_DescribeCustomerMetadata.go index abf79c242d9..4d92ad9492a 100644 --- a/service/directconnect/api_op_DescribeCustomerMetadata.go +++ b/service/directconnect/api_op_DescribeCustomerMetadata.go @@ -37,17 +37,13 @@ type DescribeCustomerMetadataOutput struct { // The list of customer agreements. Agreements []types.CustomerAgreement - // The type of network-to-network interface (NNI) partner. The partner type will be - // one of the following: - // - // * V1: This partner can only allocate 50Mbps, 100Mbps, - // 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections. - // - // * V2: This - // partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections. - // - // * - // nonPartner: The customer is not a partner. + // The type of network-to-network interface (NNI) partner. The partner type will + // be one of the following: + // - V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, + // 400Mbps, or 500Mbps subgigabit connections. + // - V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted + // connections. + // - nonPartner: The customer is not a partner. NniPartnerType types.NniPartnerType // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go index 39296873abf..85cb1177fce 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go @@ -13,24 +13,15 @@ import ( // Lists the associations between your Direct Connect gateways and virtual private // gateways and transit gateways. You must specify one of the following: -// -// * A -// Direct Connect gateway The response contains all virtual private gateways and -// transit gateways associated with the Direct Connect gateway. -// -// * A virtual -// private gateway The response contains the Direct Connect gateway. -// -// * A transit -// gateway The response contains the Direct Connect gateway. -// -// * A Direct Connect -// gateway and a virtual private gateway The response contains the association -// between the Direct Connect gateway and virtual private gateway. -// -// * A Direct -// Connect gateway and a transit gateway The response contains the association -// between the Direct Connect gateway and transit gateway. +// - A Direct Connect gateway The response contains all virtual private gateways +// and transit gateways associated with the Direct Connect gateway. +// - A virtual private gateway The response contains the Direct Connect gateway. +// - A transit gateway The response contains the Direct Connect gateway. +// - A Direct Connect gateway and a virtual private gateway The response +// contains the association between the Direct Connect gateway and virtual private +// gateway. +// - A Direct Connect gateway and a transit gateway The response contains the +// association between the Direct Connect gateway and transit gateway. func (c *Client) DescribeDirectConnectGatewayAssociations(ctx context.Context, params *DescribeDirectConnectGatewayAssociationsInput, optFns ...func(*Options)) (*DescribeDirectConnectGatewayAssociationsOutput, error) { if params == nil { params = &DescribeDirectConnectGatewayAssociationsInput{} diff --git a/service/directconnect/api_op_DescribeInterconnectLoa.go b/service/directconnect/api_op_DescribeInterconnectLoa.go index 7f04d4c2c33..e6ef4fcccbd 100644 --- a/service/directconnect/api_op_DescribeInterconnectLoa.go +++ b/service/directconnect/api_op_DescribeInterconnectLoa.go @@ -15,9 +15,8 @@ import ( // interconnect. The Letter of Authorization - Connecting Facility Assignment // (LOA-CFA) is a document that is used when establishing your cross connect to // Amazon Web Services at the colocation facility. For more information, see -// Requesting Cross Connects at Direct Connect Locations -// (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) in -// the Direct Connect User Guide. +// Requesting Cross Connects at Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. // // Deprecated: This operation has been deprecated. func (c *Client) DescribeInterconnectLoa(ctx context.Context, params *DescribeInterconnectLoaInput, optFns ...func(*Options)) (*DescribeInterconnectLoaOutput, error) { @@ -46,8 +45,8 @@ type DescribeInterconnectLoaInput struct { // application/pdf. LoaContentType types.LoaContentType - // The name of the service provider who establishes connectivity on your behalf. If - // you supply this parameter, the LOA-CFA lists the provider name alongside your + // The name of the service provider who establishes connectivity on your behalf. + // If you supply this parameter, the LOA-CFA lists the provider name alongside your // company name as the requester of the cross connect. ProviderName *string diff --git a/service/directconnect/api_op_DescribeLoa.go b/service/directconnect/api_op_DescribeLoa.go index 407a020abac..8eb7b4aa90c 100644 --- a/service/directconnect/api_op_DescribeLoa.go +++ b/service/directconnect/api_op_DescribeLoa.go @@ -15,9 +15,8 @@ import ( // (LAG). The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is // a document that is used when establishing your cross connect to Amazon Web // Services at the colocation facility. For more information, see Requesting Cross -// Connects at Direct Connect Locations -// (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) in -// the Direct Connect User Guide. +// Connects at Direct Connect Locations (https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html) +// in the Direct Connect User Guide. func (c *Client) DescribeLoa(ctx context.Context, params *DescribeLoaInput, optFns ...func(*Options)) (*DescribeLoaOutput, error) { if params == nil { params = &DescribeLoaInput{} @@ -44,9 +43,9 @@ type DescribeLoaInput struct { // application/pdf. LoaContentType types.LoaContentType - // The name of the service provider who establishes connectivity on your behalf. If - // you specify this parameter, the LOA-CFA lists the provider name alongside your - // company name as the requester of the cross connect. + // The name of the service provider who establishes connectivity on your behalf. + // If you specify this parameter, the LOA-CFA lists the provider name alongside + // your company name as the requester of the cross connect. ProviderName *string noSmithyDocumentSerde diff --git a/service/directconnect/api_op_DescribeLocations.go b/service/directconnect/api_op_DescribeLocations.go index aac80e3e460..c3221eb7330 100644 --- a/service/directconnect/api_op_DescribeLocations.go +++ b/service/directconnect/api_op_DescribeLocations.go @@ -13,7 +13,7 @@ import ( // Lists the Direct Connect locations in the current Amazon Web Services Region. // These are the locations that can be selected when calling CreateConnection or -// CreateInterconnect. +// CreateInterconnect . func (c *Client) DescribeLocations(ctx context.Context, params *DescribeLocationsInput, optFns ...func(*Options)) (*DescribeLocationsOutput, error) { if params == nil { params = &DescribeLocationsInput{} diff --git a/service/directconnect/api_op_DescribeRouterConfiguration.go b/service/directconnect/api_op_DescribeRouterConfiguration.go index 3fb31829279..7dd64991f05 100644 --- a/service/directconnect/api_op_DescribeRouterConfiguration.go +++ b/service/directconnect/api_op_DescribeRouterConfiguration.go @@ -36,7 +36,7 @@ type DescribeRouterConfigurationInput struct { VirtualInterfaceId *string // Identifies the router by a combination of vendor, platform, and software - // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. + // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124 . RouterTypeIdentifier *string noSmithyDocumentSerde diff --git a/service/directconnect/api_op_DescribeVirtualGateways.go b/service/directconnect/api_op_DescribeVirtualGateways.go index 14f1fde3baa..a80e99d5754 100644 --- a/service/directconnect/api_op_DescribeVirtualGateways.go +++ b/service/directconnect/api_op_DescribeVirtualGateways.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the virtual private gateways owned by the Amazon Web Services account. You -// can create one or more Direct Connect private virtual interfaces linked to a +// Lists the virtual private gateways owned by the Amazon Web Services account. +// You can create one or more Direct Connect private virtual interfaces linked to a // virtual private gateway. func (c *Client) DescribeVirtualGateways(ctx context.Context, params *DescribeVirtualGatewaysInput, optFns ...func(*Options)) (*DescribeVirtualGatewaysOutput, error) { if params == nil { diff --git a/service/directconnect/api_op_DisassociateConnectionFromLag.go b/service/directconnect/api_op_DisassociateConnectionFromLag.go index c2cd693ef68..82e80975104 100644 --- a/service/directconnect/api_op_DisassociateConnectionFromLag.go +++ b/service/directconnect/api_op_DisassociateConnectionFromLag.go @@ -14,8 +14,8 @@ import ( // Disassociates a connection from a link aggregation group (LAG). The connection // is interrupted and re-established as a standalone connection (the connection is -// not deleted; to delete the connection, use the DeleteConnection request). If the -// LAG has associated virtual interfaces or hosted connections, they remain +// not deleted; to delete the connection, use the DeleteConnection request). If +// the LAG has associated virtual interfaces or hosted connections, they remain // associated with the LAG. A disassociated connection owned by an Direct Connect // Partner is automatically converted to an interconnect. If disassociating the // connection would cause the LAG to fall below its setting for minimum number of @@ -77,39 +77,24 @@ type DisassociateConnectionFromLagOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -141,8 +126,8 @@ type DisassociateConnectionFromLagOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_StartBgpFailoverTest.go b/service/directconnect/api_op_StartBgpFailoverTest.go index 9fa18e03404..ecf136d6709 100644 --- a/service/directconnect/api_op_StartBgpFailoverTest.go +++ b/service/directconnect/api_op_StartBgpFailoverTest.go @@ -15,11 +15,10 @@ import ( // meets your resiliency requirements by placing the BGP peering session in the // DOWN state. You can then send traffic to verify that there are no outages. You // can run the test on public, private, transit, and hosted virtual interfaces. You -// can use ListVirtualInterfaceTestHistory -// (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html) +// can use ListVirtualInterfaceTestHistory (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html) // to view the virtual interface test history. If you need to stop the test before -// the test interval completes, use StopBgpFailoverTest -// (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.html). +// the test interval completes, use StopBgpFailoverTest (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.html) +// . func (c *Client) StartBgpFailoverTest(ctx context.Context, params *StartBgpFailoverTestInput, optFns ...func(*Options)) (*StartBgpFailoverTestOutput, error) { if params == nil { params = &StartBgpFailoverTestInput{} diff --git a/service/directconnect/api_op_UpdateConnection.go b/service/directconnect/api_op_UpdateConnection.go index 8c13da4523c..23bddeeacaf 100644 --- a/service/directconnect/api_op_UpdateConnection.go +++ b/service/directconnect/api_op_UpdateConnection.go @@ -14,11 +14,8 @@ import ( // Updates the Direct Connect dedicated connection configuration. You can update // the following parameters for a connection: -// -// * The connection name -// -// * The -// connection's MAC Security (MACsec) encryption mode. +// - The connection name +// - The connection's MAC Security (MACsec) encryption mode. func (c *Client) UpdateConnection(ctx context.Context, params *UpdateConnectionInput, optFns ...func(*Options)) (*UpdateConnectionOutput, error) { if params == nil { params = &UpdateConnectionInput{} @@ -46,7 +43,7 @@ type UpdateConnectionInput struct { ConnectionName *string // The connection MAC Security (MACsec) encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string noSmithyDocumentSerde @@ -77,39 +74,24 @@ type UpdateConnectionOutput struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState types.ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -141,8 +123,8 @@ type UpdateConnectionOutput struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_UpdateDirectConnectGateway.go b/service/directconnect/api_op_UpdateDirectConnectGateway.go index 830000508d1..7aa3d356d45 100644 --- a/service/directconnect/api_op_UpdateDirectConnectGateway.go +++ b/service/directconnect/api_op_UpdateDirectConnectGateway.go @@ -44,8 +44,8 @@ type UpdateDirectConnectGatewayInput struct { type UpdateDirectConnectGatewayOutput struct { - // Information about a Direct Connect gateway, which enables you to connect virtual - // interfaces and virtual private gateway or transit gateways. + // Information about a Direct Connect gateway, which enables you to connect + // virtual interfaces and virtual private gateway or transit gateways. DirectConnectGateway *types.DirectConnectGateway // Metadata pertaining to the operation's result. diff --git a/service/directconnect/api_op_UpdateLag.go b/service/directconnect/api_op_UpdateLag.go index d2ffcf9a7e7..356d21c17a6 100644 --- a/service/directconnect/api_op_UpdateLag.go +++ b/service/directconnect/api_op_UpdateLag.go @@ -13,22 +13,16 @@ import ( // Updates the attributes of the specified link aggregation group (LAG). You can // update the following LAG attributes: +// - The name of the LAG. +// - The value for the minimum number of connections that must be operational +// for the LAG itself to be operational. +// - The LAG's MACsec encryption mode. Amazon Web Services assigns this value to +// each connection which is part of the LAG. +// - The tags // -// * The name of the LAG. -// -// * The value for -// the minimum number of connections that must be operational for the LAG itself to -// be operational. -// -// * The LAG's MACsec encryption mode. Amazon Web Services assigns -// this value to each connection which is part of the LAG. -// -// * The tags -// -// If you -// adjust the threshold value for the minimum number of operational connections, -// ensure that the new value does not cause the LAG to fall below the threshold and -// become non-operational. +// If you adjust the threshold value for the minimum number of operational +// connections, ensure that the new value does not cause the LAG to fall below the +// threshold and become non-operational. func (c *Client) UpdateLag(ctx context.Context, params *UpdateLagInput, optFns ...func(*Options)) (*UpdateLagOutput, error) { if params == nil { params = &UpdateLagInput{} @@ -90,8 +84,8 @@ type UpdateLagOutput struct { // possible values are 1Gbps and 10Gbps. ConnectionsBandwidth *string - // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt, - // should_encrypt, and must_encrypt. + // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt , + // should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the LAG supports a secondary BGP peer in the same address @@ -108,26 +102,14 @@ type UpdateLagOutput struct { LagName *string // The state of the LAG. The following are the possible values: - // - // * requested: The - // initial state of a LAG. The LAG stays in the requested state until the Letter of - // Authorization (LOA) is available. - // - // * pending: The LAG has been approved and is - // being initialized. - // - // * available: The network link is established and the LAG is - // ready for use. - // - // * down: The network link is down. - // - // * deleting: The LAG is being - // deleted. - // - // * deleted: The LAG is deleted. - // - // * unknown: The state of the LAG is not - // available. + // - requested : The initial state of a LAG. The LAG stays in the requested state + // until the Letter of Authorization (LOA) is available. + // - pending : The LAG has been approved and is being initialized. + // - available : The network link is established and the LAG is ready for use. + // - down : The network link is down. + // - deleting : The LAG is being deleted. + // - deleted : The LAG is deleted. + // - unknown : The state of the LAG is not available. LagState types.LagState // The location of the LAG. @@ -143,8 +125,8 @@ type UpdateLagOutput struct { // for the LAG itself to be operational. MinimumLinks int32 - // The number of physical dedicated connections bundled by the LAG, up to a maximum - // of 10. + // The number of physical dedicated connections bundled by the LAG, up to a + // maximum of 10. NumberOfConnections int32 // The ID of the Amazon Web Services account that owns the LAG. diff --git a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go index b3c0d229621..53dd3d96f31 100644 --- a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go +++ b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go @@ -16,9 +16,9 @@ import ( // update to the underlying physical connection if it wasn't updated to support // jumbo frames. Updating the connection disrupts network connectivity for all // virtual interfaces associated with the connection for up to 30 seconds. To check -// whether your connection supports jumbo frames, call DescribeConnections. To +// whether your connection supports jumbo frames, call DescribeConnections . To // check whether your virtual q interface supports jumbo frames, call -// DescribeVirtualInterfaces. +// DescribeVirtualInterfaces . func (c *Client) UpdateVirtualInterfaceAttributes(ctx context.Context, params *UpdateVirtualInterfaceAttributesInput, optFns ...func(*Options)) (*UpdateVirtualInterfaceAttributesOutput, error) { if params == nil { params = &UpdateVirtualInterfaceAttributesInput{} @@ -44,8 +44,8 @@ type UpdateVirtualInterfaceAttributesInput struct { // Indicates whether to enable or disable SiteLink. EnableSiteLink *bool - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The name of the virtual private interface. @@ -102,8 +102,8 @@ type UpdateVirtualInterfaceAttributesOutput struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -129,49 +129,34 @@ type UpdateVirtualInterfaceAttributesOutput struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState types.VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directconnect/types/enums.go b/service/directconnect/types/enums.go index 51cb3119a8e..b26845c4d5b 100644 --- a/service/directconnect/types/enums.go +++ b/service/directconnect/types/enums.go @@ -31,9 +31,9 @@ const ( BGPPeerStateDeleted BGPPeerState = "deleted" ) -// Values returns all known values for BGPPeerState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BGPPeerState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BGPPeerState) Values() []BGPPeerState { return []BGPPeerState{ "verifying", @@ -53,9 +53,9 @@ const ( BGPStatusUnknown BGPStatus = "unknown" ) -// Values returns all known values for BGPStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BGPStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BGPStatus) Values() []BGPStatus { return []BGPStatus{ "up", @@ -351,8 +351,8 @@ const ( VirtualInterfaceStateUnknown VirtualInterfaceState = "unknown" ) -// Values returns all known values for VirtualInterfaceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VirtualInterfaceState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VirtualInterfaceState) Values() []VirtualInterfaceState { return []VirtualInterfaceState{ diff --git a/service/directconnect/types/types.go b/service/directconnect/types/types.go index 8eaffd20bcb..900e0621c3b 100644 --- a/service/directconnect/types/types.go +++ b/service/directconnect/types/types.go @@ -54,34 +54,21 @@ type BGPPeer struct { BgpPeerId *string // The state of the BGP peer. The following are the possible values: - // - // * verifying: - // The BGP peering addresses or ASN require validation before the BGP peer can be - // created. This state applies only to public virtual interfaces. - // - // * pending: The - // BGP peer is created, and remains in this state until it is ready to be - // established. - // - // * available: The BGP peer is ready to be established. - // - // * deleting: - // The BGP peer is being deleted. - // - // * deleted: The BGP peer is deleted and cannot be - // established. + // - verifying : The BGP peering addresses or ASN require validation before the + // BGP peer can be created. This state applies only to public virtual interfaces. + // - pending : The BGP peer is created, and remains in this state until it is + // ready to be established. + // - available : The BGP peer is ready to be established. + // - deleting : The BGP peer is being deleted. + // - deleted : The BGP peer is deleted and cannot be established. BgpPeerState BGPPeerState // The status of the BGP peer. The following are the possible values: + // - up : The BGP peer is established. This state does not indicate the state of + // the routing function. Ensure that you are receiving routes over the BGP session. // - // * up: The - // BGP peer is established. This state does not indicate the state of the routing - // function. Ensure that you are receiving routes over the BGP session. - // - // * down: - // The BGP peer is down. - // - // * unknown: The BGP peer status is not available. + // - down : The BGP peer is down. + // - unknown : The BGP peer status is not available. BgpStatus BGPStatus // The IP address assigned to the customer interface. @@ -115,39 +102,24 @@ type Connection struct { ConnectionName *string // The state of the connection. The following are the possible values: - // - // * ordering: - // The initial state of a hosted connection provisioned on an interconnect. The - // connection stays in the ordering state until the owner of the hosted connection - // confirms or declines the connection order. - // - // * requested: The initial state of a - // standard connection. The connection stays in the requested state until the - // Letter of Authorization (LOA) is sent to the customer. - // - // * pending: The - // connection has been approved and is being initialized. - // - // * available: The network - // link is up and the connection is ready for use. - // - // * down: The network link is - // down. - // - // * deleting: The connection is being deleted. - // - // * deleted: The connection - // has been deleted. - // - // * rejected: A hosted connection in the ordering state enters - // the rejected state if it is deleted by the customer. - // - // * unknown: The state of - // the connection is not available. + // - ordering : The initial state of a hosted connection provisioned on an + // interconnect. The connection stays in the ordering state until the owner of the + // hosted connection confirms or declines the connection order. + // - requested : The initial state of a standard connection. The connection stays + // in the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The connection has been approved and is being initialized. + // - available : The network link is up and the connection is ready for use. + // - down : The network link is down. + // - deleting : The connection is being deleted. + // - deleted : The connection has been deleted. + // - rejected : A hosted connection in the ordering state enters the rejected + // state if it is deleted by the customer. + // - unknown : The state of the connection is not available. ConnectionState ConnectionState // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt, should_encrypt, and must_encrypt. + // no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -179,8 +151,8 @@ type Connection struct { PartnerName *string // The MAC Security (MACsec) port link status of the connection. The valid values - // are Encryption Up, which means that there is an active Connection Key Name, or - // Encryption Down. + // are Encryption Up , which means that there is an active Connection Key Name, or + // Encryption Down . PortEncryptionStatus *string // The name of the service provider associated with the connection. @@ -210,8 +182,8 @@ type CustomerAgreement struct { noSmithyDocumentSerde } -// Information about a Direct Connect gateway, which enables you to connect virtual -// interfaces and virtual private gateway or transit gateways. +// Information about a Direct Connect gateway, which enables you to connect +// virtual interfaces and virtual private gateway or transit gateways. type DirectConnectGateway struct { // The autonomous system number (ASN) for the Amazon side of the connection. @@ -223,20 +195,11 @@ type DirectConnectGateway struct { // The name of the Direct Connect gateway. DirectConnectGatewayName *string - // The state of the Direct Connect gateway. The following are the possible - // values: - // - // * pending: The initial state after calling - // CreateDirectConnectGateway. - // - // * available: The Direct Connect gateway is ready - // for use. - // - // * deleting: The initial state after calling - // DeleteDirectConnectGateway. - // - // * deleted: The Direct Connect gateway is deleted - // and cannot pass traffic. + // The state of the Direct Connect gateway. The following are the possible values: + // - pending : The initial state after calling CreateDirectConnectGateway . + // - available : The Direct Connect gateway is ready for use. + // - deleting : The initial state after calling DeleteDirectConnectGateway . + // - deleted : The Direct Connect gateway is deleted and cannot pass traffic. DirectConnectGatewayState DirectConnectGatewayState // The ID of the Amazon Web Services account that owns the Direct Connect gateway. @@ -262,26 +225,18 @@ type DirectConnectGatewayAssociation struct { AssociationId *string // The state of the association. The following are the possible values: - // - // * - // associating: The initial state after calling - // CreateDirectConnectGatewayAssociation. - // - // * associated: The Direct Connect gateway - // and virtual private gateway or transit gateway are successfully associated and - // ready to pass traffic. - // - // * disassociating: The initial state after calling - // DeleteDirectConnectGatewayAssociation. - // - // * disassociated: The virtual private - // gateway or transit gateway is disassociated from the Direct Connect gateway. - // Traffic flow between the Direct Connect gateway and virtual private gateway or - // transit gateway is stopped. - // - // * updating: The CIDR blocks for the virtual private - // gateway or transit gateway are currently being updated. This could be new CIDR - // blocks added or current CIDR blocks removed. + // - associating : The initial state after calling + // CreateDirectConnectGatewayAssociation . + // - associated : The Direct Connect gateway and virtual private gateway or + // transit gateway are successfully associated and ready to pass traffic. + // - disassociating : The initial state after calling + // DeleteDirectConnectGatewayAssociation . + // - disassociated : The virtual private gateway or transit gateway is + // disassociated from the Direct Connect gateway. Traffic flow between the Direct + // Connect gateway and virtual private gateway or transit gateway is stopped. + // - updating : The CIDR blocks for the virtual private gateway or transit + // gateway are currently being updated. This could be new CIDR blocks added or + // current CIDR blocks removed. AssociationState DirectConnectGatewayAssociationState // The ID of the Direct Connect gateway. @@ -328,17 +283,12 @@ type DirectConnectGatewayAssociationProposal struct { ProposalId *string // The state of the proposal. The following are possible values: - // - // * accepted: The - // proposal has been accepted. The Direct Connect gateway association is available - // to use in this state. - // - // * deleted: The proposal has been deleted by the owner - // that made the proposal. The Direct Connect gateway association cannot be used in - // this state. - // - // * requested: The proposal has been requested. The Direct Connect - // gateway association cannot be used in this state. + // - accepted : The proposal has been accepted. The Direct Connect gateway + // association is available to use in this state. + // - deleted : The proposal has been deleted by the owner that made the proposal. + // The Direct Connect gateway association cannot be used in this state. + // - requested : The proposal has been requested. The Direct Connect gateway + // association cannot be used in this state. ProposalState DirectConnectGatewayAssociationProposalState // The Amazon VPC prefixes to advertise to the Direct Connect gateway. @@ -352,20 +302,14 @@ type DirectConnectGatewayAssociationProposal struct { type DirectConnectGatewayAttachment struct { // The state of the attachment. The following are the possible values: - // - // * - // attaching: The initial state after a virtual interface is created using the - // Direct Connect gateway. - // - // * attached: The Direct Connect gateway and virtual - // interface are attached and ready to pass traffic. - // - // * detaching: The initial - // state after calling DeleteVirtualInterface. - // - // * detached: The virtual interface - // is detached from the Direct Connect gateway. Traffic flow between the Direct - // Connect gateway and virtual interface is stopped. + // - attaching : The initial state after a virtual interface is created using the + // Direct Connect gateway. + // - attached : The Direct Connect gateway and virtual interface are attached and + // ready to pass traffic. + // - detaching : The initial state after calling DeleteVirtualInterface . + // - detached : The virtual interface is detached from the Direct Connect + // gateway. Traffic flow between the Direct Connect gateway and virtual interface + // is stopped. AttachmentState DirectConnectGatewayAttachmentState // The type of attachment. @@ -418,27 +362,15 @@ type Interconnect struct { InterconnectName *string // The state of the interconnect. The following are the possible values: - // - // * - // requested: The initial state of an interconnect. The interconnect stays in the - // requested state until the Letter of Authorization (LOA) is sent to the - // customer. - // - // * pending: The interconnect is approved, and is being initialized. - // - // * - // available: The network link is up, and the interconnect is ready for use. - // - // * - // down: The network link is down. - // - // * deleting: The interconnect is being - // deleted. - // - // * deleted: The interconnect is deleted. - // - // * unknown: The state of the - // interconnect is not available. + // - requested : The initial state of an interconnect. The interconnect stays in + // the requested state until the Letter of Authorization (LOA) is sent to the + // customer. + // - pending : The interconnect is approved, and is being initialized. + // - available : The network link is up, and the interconnect is ready for use. + // - down : The network link is down. + // - deleting : The interconnect is being deleted. + // - deleted : The interconnect is deleted. + // - unknown : The state of the interconnect is not available. InterconnectState InterconnectState // Indicates whether jumbo frames (9001 MTU) are supported. @@ -490,8 +422,8 @@ type Lag struct { // possible values are 1Gbps and 10Gbps. ConnectionsBandwidth *string - // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt, - // should_encrypt, and must_encrypt. + // The LAG MAC Security (MACsec) encryption mode. The valid values are no_encrypt , + // should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the LAG supports a secondary BGP peer in the same address @@ -508,26 +440,14 @@ type Lag struct { LagName *string // The state of the LAG. The following are the possible values: - // - // * requested: The - // initial state of a LAG. The LAG stays in the requested state until the Letter of - // Authorization (LOA) is available. - // - // * pending: The LAG has been approved and is - // being initialized. - // - // * available: The network link is established and the LAG is - // ready for use. - // - // * down: The network link is down. - // - // * deleting: The LAG is being - // deleted. - // - // * deleted: The LAG is deleted. - // - // * unknown: The state of the LAG is not - // available. + // - requested : The initial state of a LAG. The LAG stays in the requested state + // until the Letter of Authorization (LOA) is available. + // - pending : The LAG has been approved and is being initialized. + // - available : The network link is established and the LAG is ready for use. + // - down : The network link is down. + // - deleting : The LAG is being deleted. + // - deleted : The LAG is deleted. + // - unknown : The state of the LAG is not available. LagState LagState // The location of the LAG. @@ -543,8 +463,8 @@ type Lag struct { // for the LAG itself to be operational. MinimumLinks int32 - // The number of physical dedicated connections bundled by the LAG, up to a maximum - // of 10. + // The number of physical dedicated connections bundled by the LAG, up to a + // maximum of 10. NumberOfConnections int32 // The ID of the Amazon Web Services account that owns the LAG. @@ -615,20 +535,14 @@ type MacSecKey struct { StartOn *string // The state of the MAC Security (MACsec) secret key. The possible values are: - // - // * - // associating: The MAC Security (MACsec) secret key is being validated and not yet - // associated with the connection or LAG. - // - // * associated: The MAC Security (MACsec) - // secret key is validated and associated with the connection or LAG. - // - // * - // disassociating: The MAC Security (MACsec) secret key is being disassociated from - // the connection or LAG - // - // * disassociated: The MAC Security (MACsec) secret key is - // no longer associated with the connection or LAG. + // - associating : The MAC Security (MACsec) secret key is being validated and + // not yet associated with the connection or LAG. + // - associated : The MAC Security (MACsec) secret key is validated and + // associated with the connection or LAG. + // - disassociating : The MAC Security (MACsec) secret key is being disassociated + // from the connection or LAG + // - disassociated : The MAC Security (MACsec) secret key is no longer associated + // with the connection or LAG. State *string noSmithyDocumentSerde @@ -666,9 +580,9 @@ type NewPrivateVirtualInterface struct { // This member is required. Asn int32 - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). // // This member is required. VirtualInterfaceName *string @@ -697,8 +611,8 @@ type NewPrivateVirtualInterface struct { // Indicates whether to enable or disable SiteLink. EnableSiteLink *bool - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The tags associated with the private virtual interface. @@ -719,9 +633,9 @@ type NewPrivateVirtualInterfaceAllocation struct { // This member is required. Asn int32 - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). // // This member is required. VirtualInterfaceName *string @@ -744,8 +658,8 @@ type NewPrivateVirtualInterfaceAllocation struct { // The IP address assigned to the customer interface. CustomerAddress *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The tags associated with the private virtual interface. @@ -763,9 +677,9 @@ type NewPublicVirtualInterface struct { // This member is required. Asn int32 - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). // // This member is required. VirtualInterfaceName *string @@ -807,9 +721,9 @@ type NewPublicVirtualInterfaceAllocation struct { // This member is required. Asn int32 - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). // // This member is required. VirtualInterfaceName *string @@ -868,16 +782,16 @@ type NewTransitVirtualInterface struct { // Indicates whether to enable or disable SiteLink. EnableSiteLink *bool - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The tags associated with the transitive virtual interface. Tags []Tag - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The ID of the VLAN. @@ -906,16 +820,16 @@ type NewTransitVirtualInterfaceAllocation struct { // The IP address assigned to the customer interface. CustomerAddress *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The tags associated with the transitive virtual interface. Tags []Tag - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The ID of the VLAN. @@ -954,7 +868,7 @@ type RouterType struct { Platform *string // Identifies the router by a combination of vendor, platform, and software - // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124. + // version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124 . RouterTypeIdentifier *string // The router software. @@ -994,18 +908,11 @@ type VirtualGateway struct { // The state of the virtual private gateway. The following are the possible // values: - // - // * pending: Initial state after creating the virtual private gateway. - // - // * - // available: Ready for use by a private virtual interface. - // - // * deleting: Initial - // state after deleting the virtual private gateway. - // - // * deleted: The virtual - // private gateway is deleted. The private virtual interface is unable to send - // traffic over this gateway. + // - pending : Initial state after creating the virtual private gateway. + // - available : Ready for use by a private virtual interface. + // - deleting : Initial state after deleting the virtual private gateway. + // - deleted : The virtual private gateway is deleted. The private virtual + // interface is unable to send traffic over this gateway. VirtualGatewayState *string noSmithyDocumentSerde @@ -1059,8 +966,8 @@ type VirtualInterface struct { // The location of the connection. Location *string - // The maximum transmission unit (MTU), in bytes. The supported values are 1500 and - // 9001. The default value is 1500. + // The maximum transmission unit (MTU), in bytes. The supported values are 1500 + // and 9001. The default value is 1500. Mtu *int32 // The ID of the Amazon Web Services account that owns the virtual interface. @@ -1086,49 +993,34 @@ type VirtualInterface struct { // The ID of the virtual interface. VirtualInterfaceId *string - // The name of the virtual interface assigned by the customer network. The name has - // a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a - // hyphen (-). + // The name of the virtual interface assigned by the customer network. The name + // has a maximum of 100 characters. The following are valid characters: a-z, 0-9 + // and a hyphen (-). VirtualInterfaceName *string // The state of the virtual interface. The following are the possible values: - // - // * - // confirming: The creation of the virtual interface is pending confirmation from - // the virtual interface owner. If the owner of the virtual interface is different - // from the owner of the connection on which it is provisioned, then the virtual - // interface will remain in this state until it is confirmed by the virtual - // interface owner. - // - // * verifying: This state only applies to public virtual - // interfaces. Each public virtual interface needs validation before the virtual - // interface can be created. - // - // * pending: A virtual interface is in this state from - // the time that it is created until the virtual interface is ready to forward - // traffic. - // - // * available: A virtual interface that is able to forward traffic. - // - // * - // down: A virtual interface that is BGP down. - // - // * deleting: A virtual interface is - // in this state immediately after calling DeleteVirtualInterface until it can no - // longer forward traffic. - // - // * deleted: A virtual interface that cannot forward - // traffic. - // - // * rejected: The virtual interface owner has declined creation of the - // virtual interface. If a virtual interface in the Confirming state is deleted by - // the virtual interface owner, the virtual interface enters the Rejected state. - // - // * - // unknown: The state of the virtual interface is not available. + // - confirming : The creation of the virtual interface is pending confirmation + // from the virtual interface owner. If the owner of the virtual interface is + // different from the owner of the connection on which it is provisioned, then the + // virtual interface will remain in this state until it is confirmed by the virtual + // interface owner. + // - verifying : This state only applies to public virtual interfaces. Each + // public virtual interface needs validation before the virtual interface can be + // created. + // - pending : A virtual interface is in this state from the time that it is + // created until the virtual interface is ready to forward traffic. + // - available : A virtual interface that is able to forward traffic. + // - down : A virtual interface that is BGP down. + // - deleting : A virtual interface is in this state immediately after calling + // DeleteVirtualInterface until it can no longer forward traffic. + // - deleted : A virtual interface that cannot forward traffic. + // - rejected : The virtual interface owner has declined creation of the virtual + // interface. If a virtual interface in the Confirming state is deleted by the + // virtual interface owner, the virtual interface enters the Rejected state. + // - unknown : The state of the virtual interface is not available. VirtualInterfaceState VirtualInterfaceState - // The type of virtual interface. The possible values are private and public. + // The type of virtual interface. The possible values are private and public . VirtualInterfaceType *string // The ID of the VLAN. diff --git a/service/directoryservice/api_client.go b/service/directoryservice/api_client.go index e4c435b0d79..ba8799680e7 100644 --- a/service/directoryservice/api_client.go +++ b/service/directoryservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/directoryservice/api_op_AddIpRoutes.go b/service/directoryservice/api_op_AddIpRoutes.go index bfb08afed3d..1c42459346e 100644 --- a/service/directoryservice/api_op_AddIpRoutes.go +++ b/service/directoryservice/api_op_AddIpRoutes.go @@ -19,8 +19,8 @@ import ( // Before you call AddIpRoutes, ensure that all of the required permissions have // been explicitly granted through a policy. For details about what permissions are // required to run the AddIpRoutes operation, see Directory Service API -// Permissions: Actions, Resources, and Conditions Reference -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html). +// Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html) +// . func (c *Client) AddIpRoutes(ctx context.Context, params *AddIpRoutesInput, optFns ...func(*Options)) (*AddIpRoutesOutput, error) { if params == nil { params = &AddIpRoutesInput{} @@ -43,8 +43,8 @@ type AddIpRoutesInput struct { // This member is required. DirectoryId *string - // IP address blocks, using CIDR format, of the traffic to route. This is often the - // IP address block of the DNS server used for your self-managed domain. + // IP address blocks, using CIDR format, of the traffic to route. This is often + // the IP address block of the DNS server used for your self-managed domain. // // This member is required. IpRoutes []types.IpRoute @@ -52,64 +52,27 @@ type AddIpRoutesInput struct { // If set to true, updates the inbound and outbound rules of the security group // that has the description: "Amazon Web Services created security group for // directory ID directory controllers." Following are the new rules: Inbound: - // - // * - // Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 - // - // * Type: - // Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 - // - // * Type: Custom - // UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 - // - // * Type: Custom UDP Rule, - // Protocol: UDP, Range: 389, Source: 0.0.0.0/0 - // - // * Type: Custom UDP Rule, Protocol: - // UDP, Range: 464, Source: 0.0.0.0/0 - // - // * Type: Custom UDP Rule, Protocol: UDP, - // Range: 445, Source: 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: - // 88, Source: 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 135, - // Source: 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: - // 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: - // 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: - // 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: - // 0.0.0.0/0 - // - // * Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: - // 0.0.0.0/0 - // - // * Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 - // - // * - // Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 - // - // * Type: LDAP, - // Protocol: TCP, Range: 389, Source: 0.0.0.0/0 - // - // * Type: All ICMP, Protocol: All, - // Range: N/A, Source: 0.0.0.0/0 - // + // - Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0 + // - Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 + // - Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 + // - Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0 + // - Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0 + // - Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 + // - Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 + // - Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0 + // - Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0 + // - Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 + // - Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0 // Outbound: - // - // * Type: All traffic, Protocol: All, - // Range: All, Destination: 0.0.0.0/0 - // - // These security rules impact an internal - // network interface that is not exposed publicly. + // - Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0 + // These security rules impact an internal network interface that is not exposed + // publicly. UpdateSecurityGroupForDirectoryControllers bool noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_AddRegion.go b/service/directoryservice/api_op_AddRegion.go index ac2b3c9d9f1..35c880f936d 100644 --- a/service/directoryservice/api_op_AddRegion.go +++ b/service/directoryservice/api_op_AddRegion.go @@ -34,8 +34,8 @@ type AddRegionInput struct { // This member is required. DirectoryId *string - // The name of the Region where you want to add domain controllers for replication. - // For example, us-east-1. + // The name of the Region where you want to add domain controllers for + // replication. For example, us-east-1 . // // This member is required. RegionName *string diff --git a/service/directoryservice/api_op_CancelSchemaExtension.go b/service/directoryservice/api_op_CancelSchemaExtension.go index 3ea728baccd..8a7b87f9570 100644 --- a/service/directoryservice/api_op_CancelSchemaExtension.go +++ b/service/directoryservice/api_op_CancelSchemaExtension.go @@ -13,7 +13,7 @@ import ( // Cancels an in-progress schema extension to a Microsoft AD directory. Once a // schema extension has started replicating to all domain controllers, the task can // no longer be canceled. A schema extension can be canceled during any of the -// following states; Initializing, CreatingSnapshot, and UpdatingSchema. +// following states; Initializing , CreatingSnapshot , and UpdatingSchema . func (c *Client) CancelSchemaExtension(ctx context.Context, params *CancelSchemaExtensionInput, optFns ...func(*Options)) (*CancelSchemaExtensionOutput, error) { if params == nil { params = &CancelSchemaExtensionInput{} diff --git a/service/directoryservice/api_op_ConnectDirectory.go b/service/directoryservice/api_op_ConnectDirectory.go index e24eaff10c1..6e085de7ea7 100644 --- a/service/directoryservice/api_op_ConnectDirectory.go +++ b/service/directoryservice/api_op_ConnectDirectory.go @@ -12,11 +12,11 @@ import ( ) // Creates an AD Connector to connect to a self-managed directory. Before you call -// ConnectDirectory, ensure that all of the required permissions have been +// ConnectDirectory , ensure that all of the required permissions have been // explicitly granted through a policy. For details about what permissions are // required to run the ConnectDirectory operation, see Directory Service API -// Permissions: Actions, Resources, and Conditions Reference -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html). +// Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html) +// . func (c *Client) ConnectDirectory(ctx context.Context, params *ConnectDirectoryInput, optFns ...func(*Options)) (*ConnectDirectoryOutput, error) { if params == nil { params = &ConnectDirectoryInput{} @@ -42,7 +42,7 @@ type ConnectDirectoryInput struct { ConnectSettings *types.DirectoryConnectSettings // The fully qualified name of your self-managed directory, such as - // corp.example.com. + // corp.example.com . // // This member is required. Name *string @@ -60,7 +60,7 @@ type ConnectDirectoryInput struct { // A description for the directory. Description *string - // The NetBIOS name of your self-managed directory, such as CORP. + // The NetBIOS name of your self-managed directory, such as CORP . ShortName *string // The tags to be assigned to AD Connector. diff --git a/service/directoryservice/api_op_CreateAlias.go b/service/directoryservice/api_op_CreateAlias.go index d60e6c1671f..0c0b5252475 100644 --- a/service/directoryservice/api_op_CreateAlias.go +++ b/service/directoryservice/api_op_CreateAlias.go @@ -12,7 +12,7 @@ import ( // Creates an alias for a directory and assigns the alias to the directory. The // alias is used to construct the access URL for the directory, such as -// http://.awsapps.com. After an alias has been created, it cannot be deleted or +// http://.awsapps.com . After an alias has been created, it cannot be deleted or // reused, so this operation should only be used when absolutely necessary. func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { diff --git a/service/directoryservice/api_op_CreateConditionalForwarder.go b/service/directoryservice/api_op_CreateConditionalForwarder.go index d5873d69480..6eebaf922fa 100644 --- a/service/directoryservice/api_op_CreateConditionalForwarder.go +++ b/service/directoryservice/api_op_CreateConditionalForwarder.go @@ -29,13 +29,13 @@ func (c *Client) CreateConditionalForwarder(ctx context.Context, params *CreateC return out, nil } -// Initiates the creation of a conditional forwarder for your Directory Service for -// Microsoft Active Directory. Conditional forwarders are required in order to set -// up a trust relationship with another domain. +// Initiates the creation of a conditional forwarder for your Directory Service +// for Microsoft Active Directory. Conditional forwarders are required in order to +// set up a trust relationship with another domain. type CreateConditionalForwarderInput struct { - // The directory ID of the Amazon Web Services directory for which you are creating - // the conditional forwarder. + // The directory ID of the Amazon Web Services directory for which you are + // creating the conditional forwarder. // // This member is required. DirectoryId *string diff --git a/service/directoryservice/api_op_CreateDirectory.go b/service/directoryservice/api_op_CreateDirectory.go index 8589d169061..5efa8f735e5 100644 --- a/service/directoryservice/api_op_CreateDirectory.go +++ b/service/directoryservice/api_op_CreateDirectory.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Simple AD directory. For more information, see Simple Active Directory -// (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) -// in the Directory Service Admin Guide. Before you call CreateDirectory, ensure +// Creates a Simple AD directory. For more information, see Simple Active Directory (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) +// in the Directory Service Admin Guide. Before you call CreateDirectory , ensure // that all of the required permissions have been explicitly granted through a // policy. For details about what permissions are required to run the // CreateDirectory operation, see Directory Service API Permissions: Actions, -// Resources, and Conditions Reference -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html). +// Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html) +// . func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error) { if params == nil { params = &CreateDirectoryInput{} @@ -37,7 +36,7 @@ func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInp // Contains the inputs for the CreateDirectory operation. type CreateDirectoryInput struct { - // The fully qualified name for the directory, such as corp.example.com. + // The fully qualified name for the directory, such as corp.example.com . // // This member is required. Name *string @@ -45,31 +44,20 @@ type CreateDirectoryInput struct { // The password for the directory administrator. The directory creation process // creates a directory administrator account with the user name Administrator and // this password. If you need to change the password for the administrator account, - // you can use the ResetUserPassword API call. The regex pattern for this string is - // made up of the following conditions: - // - // * Length (?=^.{8,64}$) – Must be between 8 - // and 64 characters - // - // AND any 3 of the following password complexity rules required - // by Active Directory: - // - // * Numbers and upper case and lowercase - // (?=.*\d)(?=.*[A-Z])(?=.*[a-z]) - // - // * Numbers and special characters and lower case - // (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z]) - // - // * Special characters and upper case and - // lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z]) - // - // * Numbers and upper case - // and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]) - // - // For additional - // information about how Active Directory passwords are enforced, see Password must - // meet complexity requirements - // (https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements) + // you can use the ResetUserPassword API call. The regex pattern for this string + // is made up of the following conditions: + // - Length (?=^.{8,64}$) – Must be between 8 and 64 characters + // AND any 3 of the following password complexity rules required by Active + // Directory: + // - Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z]) + // - Numbers and special characters and lower case + // (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z]) + // - Special characters and upper case and lower case + // (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z]) + // - Numbers and upper case and special characters + // (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]) + // For additional information about how Active Directory passwords are enforced, + // see Password must meet complexity requirements (https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements) // on the Microsoft website. // // This member is required. @@ -83,7 +71,7 @@ type CreateDirectoryInput struct { // A description for the directory. Description *string - // The NetBIOS name of the directory, such as CORP. + // The NetBIOS name of the directory, such as CORP . ShortName *string // The tags to be assigned to the Simple AD directory. diff --git a/service/directoryservice/api_op_CreateLogSubscription.go b/service/directoryservice/api_op_CreateLogSubscription.go index 354e60f809f..c459a4a53b8 100644 --- a/service/directoryservice/api_op_CreateLogSubscription.go +++ b/service/directoryservice/api_op_CreateLogSubscription.go @@ -30,8 +30,8 @@ func (c *Client) CreateLogSubscription(ctx context.Context, params *CreateLogSub type CreateLogSubscriptionInput struct { - // Identifier of the directory to which you want to subscribe and receive real-time - // logs to your specified CloudWatch log group. + // Identifier of the directory to which you want to subscribe and receive + // real-time logs to your specified CloudWatch log group. // // This member is required. DirectoryId *string diff --git a/service/directoryservice/api_op_CreateMicrosoftAD.go b/service/directoryservice/api_op_CreateMicrosoftAD.go index 2f89e8fe9b0..fea9d952d90 100644 --- a/service/directoryservice/api_op_CreateMicrosoftAD.go +++ b/service/directoryservice/api_op_CreateMicrosoftAD.go @@ -12,14 +12,13 @@ import ( ) // Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more -// information, see Managed Microsoft AD -// (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) +// information, see Managed Microsoft AD (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) // in the Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure // that all of the required permissions have been explicitly granted through a // policy. For details about what permissions are required to run the // CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, -// Resources, and Conditions Reference -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html). +// Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html) +// . func (c *Client) CreateMicrosoftAD(ctx context.Context, params *CreateMicrosoftADInput, optFns ...func(*Options)) (*CreateMicrosoftADOutput, error) { if params == nil { params = &CreateMicrosoftADInput{} @@ -39,13 +38,13 @@ func (c *Client) CreateMicrosoftAD(ctx context.Context, params *CreateMicrosoftA type CreateMicrosoftADInput struct { // The fully qualified domain name for the Managed Microsoft AD directory, such as - // corp.example.com. This name will resolve inside your VPC only. It does not need + // corp.example.com . This name will resolve inside your VPC only. It does not need // to be publicly resolvable. // // This member is required. Name *string - // The password for the default administrative user named Admin. If you need to + // The password for the default administrative user named Admin . If you need to // change the password for the administrator account, you can use the // ResetUserPassword API call. // @@ -61,13 +60,13 @@ type CreateMicrosoftADInput struct { // Services console Directory Details page after the directory is created. Description *string - // Managed Microsoft AD is available in two editions: Standard and Enterprise. + // Managed Microsoft AD is available in two editions: Standard and Enterprise . // Enterprise is the default. Edition types.DirectoryEdition - // The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS + // The NetBIOS name for your domain, such as CORP . If you don't specify a NetBIOS // name, it will default to the first part of your directory DNS. For example, CORP - // for the directory DNS corp.example.com. + // for the directory DNS corp.example.com . ShortName *string // The tags to be assigned to the Managed Microsoft AD directory. diff --git a/service/directoryservice/api_op_DeleteDirectory.go b/service/directoryservice/api_op_DeleteDirectory.go index b2715d9bc5c..756e038af0a 100644 --- a/service/directoryservice/api_op_DeleteDirectory.go +++ b/service/directoryservice/api_op_DeleteDirectory.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Directory Service directory. Before you call DeleteDirectory, ensure +// Deletes an Directory Service directory. Before you call DeleteDirectory , ensure // that all of the required permissions have been explicitly granted through a // policy. For details about what permissions are required to run the // DeleteDirectory operation, see Directory Service API Permissions: Actions, -// Resources, and Conditions Reference -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html). +// Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html) +// . func (c *Client) DeleteDirectory(ctx context.Context, params *DeleteDirectoryInput, optFns ...func(*Options)) (*DeleteDirectoryOutput, error) { if params == nil { params = &DeleteDirectoryInput{} diff --git a/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go b/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go index 3f9f0475156..905cb10c7df 100644 --- a/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go +++ b/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go @@ -38,12 +38,12 @@ type DescribeClientAuthenticationSettingsInput struct { // This member is required. DirectoryId *string - // The maximum number of items to return. If this value is zero, the maximum number - // of items is specified by the limitations of the operation. + // The maximum number of items to return. If this value is zero, the maximum + // number of items is specified by the limitations of the operation. Limit *int32 // The DescribeClientAuthenticationSettingsResult.NextToken value from a previous - // call to DescribeClientAuthenticationSettings. Pass null if this is the first + // call to DescribeClientAuthenticationSettings . Pass null if this is the first // call. NextToken *string @@ -57,14 +57,15 @@ type DescribeClientAuthenticationSettingsInput struct { type DescribeClientAuthenticationSettingsOutput struct { - // Information about the type of client authentication for the specified directory. - // The following information is retrieved: The date and time when the status of the - // client authentication type was last updated, whether the client authentication - // type is enabled or disabled, and the type of client authentication. + // Information about the type of client authentication for the specified + // directory. The following information is retrieved: The date and time when the + // status of the client authentication type was last updated, whether the client + // authentication type is enabled or disabled, and the type of client + // authentication. ClientAuthenticationSettingsInfo []types.ClientAuthenticationSettingInfo - // The next token used to retrieve the client authentication settings if the number - // of setting types exceeds page limit and there is another page. + // The next token used to retrieve the client authentication settings if the + // number of setting types exceeds page limit and there is another page. NextToken *string // Metadata pertaining to the operation's result. @@ -147,8 +148,8 @@ var _ DescribeClientAuthenticationSettingsAPIClient = (*Client)(nil) // DescribeClientAuthenticationSettingsPaginatorOptions is the paginator options // for DescribeClientAuthenticationSettings type DescribeClientAuthenticationSettingsPaginatorOptions struct { - // The maximum number of items to return. If this value is zero, the maximum number - // of items is specified by the limitations of the operation. + // The maximum number of items to return. If this value is zero, the maximum + // number of items is specified by the limitations of the operation. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/directoryservice/api_op_DescribeDirectories.go b/service/directoryservice/api_op_DescribeDirectories.go index 15720782d37..75cc1656e6c 100644 --- a/service/directoryservice/api_op_DescribeDirectories.go +++ b/service/directoryservice/api_op_DescribeDirectories.go @@ -39,17 +39,17 @@ func (c *Client) DescribeDirectories(ctx context.Context, params *DescribeDirect // Contains the inputs for the DescribeDirectories operation. type DescribeDirectoriesInput struct { - // A list of identifiers of the directories for which to obtain the information. If - // this member is null, all directories that belong to the current account are + // A list of identifiers of the directories for which to obtain the information. + // If this member is null, all directories that belong to the current account are // returned. An empty list results in an InvalidParameterException being thrown. DirectoryIds []string - // The maximum number of items to return. If this value is zero, the maximum number - // of items is specified by the limitations of the operation. + // The maximum number of items to return. If this value is zero, the maximum + // number of items is specified by the limitations of the operation. Limit *int32 // The DescribeDirectoriesResult.NextToken value from a previous call to - // DescribeDirectories. Pass null if this is the first call. + // DescribeDirectories . Pass null if this is the first call. NextToken *string noSmithyDocumentSerde @@ -136,8 +136,8 @@ func (c *Client) addOperationDescribeDirectoriesMiddlewares(stack *middleware.St return nil } -// DescribeDirectoriesAPIClient is a client that implements the DescribeDirectories -// operation. +// DescribeDirectoriesAPIClient is a client that implements the +// DescribeDirectories operation. type DescribeDirectoriesAPIClient interface { DescribeDirectories(context.Context, *DescribeDirectoriesInput, ...func(*Options)) (*DescribeDirectoriesOutput, error) } @@ -147,8 +147,8 @@ var _ DescribeDirectoriesAPIClient = (*Client)(nil) // DescribeDirectoriesPaginatorOptions is the paginator options for // DescribeDirectories type DescribeDirectoriesPaginatorOptions struct { - // The maximum number of items to return. If this value is zero, the maximum number - // of items is specified by the limitations of the operation. + // The maximum number of items to return. If this value is zero, the maximum + // number of items is specified by the limitations of the operation. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/directoryservice/api_op_DescribeDomainControllers.go b/service/directoryservice/api_op_DescribeDomainControllers.go index 8ebb37daaf3..44aa2606274 100644 --- a/service/directoryservice/api_op_DescribeDomainControllers.go +++ b/service/directoryservice/api_op_DescribeDomainControllers.go @@ -44,7 +44,7 @@ type DescribeDomainControllersInput struct { Limit *int32 // The DescribeDomainControllers.NextToken value from a previous call to - // DescribeDomainControllers. Pass null if this is the first call. + // DescribeDomainControllers . Pass null if this is the first call. NextToken *string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_DescribeEventTopics.go b/service/directoryservice/api_op_DescribeEventTopics.go index 358fd24136b..ece407f3bff 100644 --- a/service/directoryservice/api_op_DescribeEventTopics.go +++ b/service/directoryservice/api_op_DescribeEventTopics.go @@ -48,8 +48,8 @@ type DescribeEventTopicsInput struct { // The result of a DescribeEventTopic request. type DescribeEventTopicsOutput struct { - // A list of Amazon SNS topic names that receive status messages from the specified - // Directory ID. + // A list of Amazon SNS topic names that receive status messages from the + // specified Directory ID. EventTopics []types.EventTopic // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeLDAPSSettings.go b/service/directoryservice/api_op_DescribeLDAPSSettings.go index b53d03ae815..9924b86bae1 100644 --- a/service/directoryservice/api_op_DescribeLDAPSSettings.go +++ b/service/directoryservice/api_op_DescribeLDAPSSettings.go @@ -50,8 +50,8 @@ type DescribeLDAPSSettingsInput struct { type DescribeLDAPSSettingsOutput struct { - // Information about LDAP security for the specified directory, including status of - // enablement, state last updated date time, and the reason for the state. + // Information about LDAP security for the specified directory, including status + // of enablement, state last updated date time, and the reason for the state. LDAPSSettingsInfo []types.LDAPSSettingInfo // The next token used to retrieve the LDAPS settings if the number of setting diff --git a/service/directoryservice/api_op_DescribeRegions.go b/service/directoryservice/api_op_DescribeRegions.go index aa86b289539..961b5ba9345 100644 --- a/service/directoryservice/api_op_DescribeRegions.go +++ b/service/directoryservice/api_op_DescribeRegions.go @@ -37,10 +37,10 @@ type DescribeRegionsInput struct { DirectoryId *string // The DescribeRegionsResult.NextToken value from a previous call to - // DescribeRegions. Pass null if this is the first call. + // DescribeRegions . Pass null if this is the first call. NextToken *string - // The name of the Region. For example, us-east-1. + // The name of the Region. For example, us-east-1 . RegionName *string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_DescribeSettings.go b/service/directoryservice/api_op_DescribeSettings.go index bb4d6f0a462..ff4b19c2f2f 100644 --- a/service/directoryservice/api_op_DescribeSettings.go +++ b/service/directoryservice/api_op_DescribeSettings.go @@ -36,7 +36,7 @@ type DescribeSettingsInput struct { DirectoryId *string // The DescribeSettingsResult.NextToken value from a previous call to - // DescribeSettings. Pass null if this is the first call. + // DescribeSettings . Pass null if this is the first call. NextToken *string // The status of the directory settings for which to retrieve information. @@ -56,9 +56,9 @@ type DescribeSettingsOutput struct { NextToken *string // The list of SettingEntry objects that were retrieved. It is possible that this - // list contains less than the number of items specified in the Limit member of the - // request. This occurs if there are less than the requested number of items left - // to retrieve, or if the limitations of the operation have been exceeded. + // list contains less than the number of items specified in the Limit member of + // the request. This occurs if there are less than the requested number of items + // left to retrieve, or if the limitations of the operation have been exceeded. SettingEntries []types.SettingEntry // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeSharedDirectories.go b/service/directoryservice/api_op_DescribeSharedDirectories.go index 4edb2d9d75a..b508ad14d41 100644 --- a/service/directoryservice/api_op_DescribeSharedDirectories.go +++ b/service/directoryservice/api_op_DescribeSharedDirectories.go @@ -39,7 +39,7 @@ type DescribeSharedDirectoriesInput struct { Limit *int32 // The DescribeSharedDirectoriesResult.NextToken value from a previous call to - // DescribeSharedDirectories. Pass null if this is the first call. + // DescribeSharedDirectories . Pass null if this is the first call. NextToken *string // A list of identifiers of all shared directories in your account. diff --git a/service/directoryservice/api_op_DescribeSnapshots.go b/service/directoryservice/api_op_DescribeSnapshots.go index 45e99b9f0b1..c592d8f8c59 100644 --- a/service/directoryservice/api_op_DescribeSnapshots.go +++ b/service/directoryservice/api_op_DescribeSnapshots.go @@ -43,7 +43,7 @@ type DescribeSnapshotsInput struct { Limit *int32 // The DescribeSnapshotsResult.NextToken value from a previous call to - // DescribeSnapshots. Pass null if this is the first call. + // DescribeSnapshots . Pass null if this is the first call. NextToken *string // A list of identifiers of the snapshots to obtain the information for. If this @@ -57,8 +57,8 @@ type DescribeSnapshotsInput struct { // Contains the results of the DescribeSnapshots operation. type DescribeSnapshotsOutput struct { - // If not null, more results are available. Pass this value in the NextToken member - // of a subsequent call to DescribeSnapshots. + // If not null, more results are available. Pass this value in the NextToken + // member of a subsequent call to DescribeSnapshots . NextToken *string // The list of Snapshot objects that were retrieved. It is possible that this list diff --git a/service/directoryservice/api_op_DescribeTrusts.go b/service/directoryservice/api_op_DescribeTrusts.go index 2871e249605..db3c339f1fe 100644 --- a/service/directoryservice/api_op_DescribeTrusts.go +++ b/service/directoryservice/api_op_DescribeTrusts.go @@ -42,8 +42,8 @@ type DescribeTrustsInput struct { // The maximum number of objects to return. Limit *int32 - // The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. - // Pass null if this is the first call. + // The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts + // . Pass null if this is the first call. NextToken *string // A list of identifiers of the trust relationships for which to obtain the diff --git a/service/directoryservice/api_op_DescribeUpdateDirectory.go b/service/directoryservice/api_op_DescribeUpdateDirectory.go index ab80719b570..dc3e78da92c 100644 --- a/service/directoryservice/api_op_DescribeUpdateDirectory.go +++ b/service/directoryservice/api_op_DescribeUpdateDirectory.go @@ -40,8 +40,8 @@ type DescribeUpdateDirectoryInput struct { // This member is required. UpdateType types.UpdateType - // The DescribeUpdateDirectoryResult. NextToken value from a previous call to - // DescribeUpdateDirectory. Pass null if this is the first call. + // The DescribeUpdateDirectoryResult . NextToken value from a previous call to + // DescribeUpdateDirectory . Pass null if this is the first call. NextToken *string // The name of the Region. diff --git a/service/directoryservice/api_op_EnableRadius.go b/service/directoryservice/api_op_EnableRadius.go index 191e8eb5b25..fadad5787cc 100644 --- a/service/directoryservice/api_op_EnableRadius.go +++ b/service/directoryservice/api_op_EnableRadius.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables multi-factor authentication (MFA) with the Remote Authentication Dial In -// User Service (RADIUS) server for an AD Connector or Microsoft AD directory. +// Enables multi-factor authentication (MFA) with the Remote Authentication Dial +// In User Service (RADIUS) server for an AD Connector or Microsoft AD directory. func (c *Client) EnableRadius(ctx context.Context, params *EnableRadiusInput, optFns ...func(*Options)) (*EnableRadiusOutput, error) { if params == nil { params = &EnableRadiusInput{} diff --git a/service/directoryservice/api_op_ListCertificates.go b/service/directoryservice/api_op_ListCertificates.go index f7268f5ca82..9aaaace6113 100644 --- a/service/directoryservice/api_op_ListCertificates.go +++ b/service/directoryservice/api_op_ListCertificates.go @@ -41,7 +41,7 @@ type ListCertificatesInput struct { // A token for requesting another page of certificates if the NextToken response // element indicates that more certificates are available. Use the value of the - // returned NextToken element in your request until the token comes back as null. + // returned NextToken element in your request until the token comes back as null . // Pass null if this is the first call. NextToken *string diff --git a/service/directoryservice/api_op_ListIpRoutes.go b/service/directoryservice/api_op_ListIpRoutes.go index 314b2554e7b..0d4a6e21892 100644 --- a/service/directoryservice/api_op_ListIpRoutes.go +++ b/service/directoryservice/api_op_ListIpRoutes.go @@ -40,8 +40,8 @@ type ListIpRoutesInput struct { // items is specified by the limitations of the operation. Limit *int32 - // The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null - // if this is the first call. + // The ListIpRoutes.NextToken value from a previous call to ListIpRoutes . Pass + // null if this is the first call. NextToken *string noSmithyDocumentSerde @@ -49,7 +49,7 @@ type ListIpRoutesInput struct { type ListIpRoutesOutput struct { - // A list of IpRoutes. + // A list of IpRoute s. IpRoutesInfo []types.IpRouteInfo // If not null, more results are available. Pass this value for the NextToken diff --git a/service/directoryservice/api_op_ListSchemaExtensions.go b/service/directoryservice/api_op_ListSchemaExtensions.go index f8a1b00f14e..a08d9aa1d61 100644 --- a/service/directoryservice/api_op_ListSchemaExtensions.go +++ b/service/directoryservice/api_op_ListSchemaExtensions.go @@ -40,7 +40,7 @@ type ListSchemaExtensionsInput struct { Limit *int32 // The ListSchemaExtensions.NextToken value from a previous call to - // ListSchemaExtensions. Pass null if this is the first call. + // ListSchemaExtensions . Pass null if this is the first call. NextToken *string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_ListTagsForResource.go b/service/directoryservice/api_op_ListTagsForResource.go index 23e6bb11c8b..fb2bc8f681a 100644 --- a/service/directoryservice/api_op_ListTagsForResource.go +++ b/service/directoryservice/api_op_ListTagsForResource.go @@ -121,8 +121,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/directoryservice/api_op_RegisterCertificate.go b/service/directoryservice/api_op_RegisterCertificate.go index 1923fd962c2..5de29b6ab0c 100644 --- a/service/directoryservice/api_op_RegisterCertificate.go +++ b/service/directoryservice/api_op_RegisterCertificate.go @@ -44,7 +44,7 @@ type RegisterCertificateInput struct { ClientCertAuthSettings *types.ClientCertAuthSettings // The function that the registered certificate performs. Valid values include - // ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. + // ClientLDAPS or ClientCertAuth . The default value is ClientLDAPS . Type types.CertificateType noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_ResetUserPassword.go b/service/directoryservice/api_op_ResetUserPassword.go index b8276302739..384f4e0e877 100644 --- a/service/directoryservice/api_op_ResetUserPassword.go +++ b/service/directoryservice/api_op_ResetUserPassword.go @@ -13,19 +13,15 @@ import ( // Resets the password for any user in your Managed Microsoft AD or Simple AD // directory. You can reset the password for any user in your directory with the // following exceptions: -// -// * For Simple AD, you cannot reset the password for any -// user that is a member of either the Domain Admins or Enterprise Admins group -// except for the administrator user. -// -// * For Managed Microsoft AD, you can only -// reset the password for a user that is in an OU based off of the NetBIOS name -// that you typed when you created your directory. For example, you cannot reset -// the password for a user in the Amazon Web Services Reserved OU. For more -// information about the OU structure for an Managed Microsoft AD directory, see -// What Gets Created -// (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html) -// in the Directory Service Administration Guide. +// - For Simple AD, you cannot reset the password for any user that is a member +// of either the Domain Admins or Enterprise Admins group except for the +// administrator user. +// - For Managed Microsoft AD, you can only reset the password for a user that +// is in an OU based off of the NetBIOS name that you typed when you created your +// directory. For example, you cannot reset the password for a user in the Amazon +// Web Services Reserved OU. For more information about the OU structure for an +// Managed Microsoft AD directory, see What Gets Created (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html) +// in the Directory Service Administration Guide. func (c *Client) ResetUserPassword(ctx context.Context, params *ResetUserPasswordInput, optFns ...func(*Options)) (*ResetUserPasswordOutput, error) { if params == nil { params = &ResetUserPasswordInput{} diff --git a/service/directoryservice/api_op_RestoreFromSnapshot.go b/service/directoryservice/api_op_RestoreFromSnapshot.go index 47582eb8be1..3b360cd30d6 100644 --- a/service/directoryservice/api_op_RestoreFromSnapshot.go +++ b/service/directoryservice/api_op_RestoreFromSnapshot.go @@ -15,7 +15,7 @@ import ( // date are overwritten. This action returns as soon as the restore operation is // initiated. You can monitor the progress of the restore operation by calling the // DescribeDirectories operation with the directory identifier. When the -// DirectoryDescription.Stage value changes to Active, the restore operation is +// DirectoryDescription.Stage value changes to Active , the restore operation is // complete. func (c *Client) RestoreFromSnapshot(ctx context.Context, params *RestoreFromSnapshotInput, optFns ...func(*Options)) (*RestoreFromSnapshotOutput, error) { if params == nil { diff --git a/service/directoryservice/api_op_ShareDirectory.go b/service/directoryservice/api_op_ShareDirectory.go index 7e9d3e8770c..9178882e4bc 100644 --- a/service/directoryservice/api_op_ShareDirectory.go +++ b/service/directoryservice/api_op_ShareDirectory.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Shares a specified directory (DirectoryId) in your Amazon Web Services account +// Shares a specified directory ( DirectoryId ) in your Amazon Web Services account // (directory owner) with another Amazon Web Services account (directory consumer). // With this operation you can use your directory from any Amazon Web Services // account and from any Amazon VPC within an Amazon Web Services Region. When you @@ -21,9 +21,9 @@ import ( // The shared directory is visible in all VPCs in the directory consumer account. // The ShareMethod parameter determines whether the specified directory can be // shared between Amazon Web Services accounts inside the same Amazon Web Services -// organization (ORGANIZATIONS). It also determines whether you can share the +// organization ( ORGANIZATIONS ). It also determines whether you can share the // directory with any other Amazon Web Services account either inside or outside of -// the organization (HANDSHAKE). The ShareNotes parameter is only used when +// the organization ( HANDSHAKE ). The ShareNotes parameter is only used when // HANDSHAKE is called, which sends a directory sharing request to the directory // consumer. func (c *Client) ShareDirectory(ctx context.Context, params *ShareDirectoryInput, optFns ...func(*Options)) (*ShareDirectoryOutput, error) { @@ -50,9 +50,9 @@ type ShareDirectoryInput struct { DirectoryId *string // The method used when sharing a directory to determine whether the directory - // should be shared within your Amazon Web Services organization (ORGANIZATIONS) or - // with any Amazon Web Services account by sending a directory sharing request - // (HANDSHAKE). + // should be shared within your Amazon Web Services organization ( ORGANIZATIONS ) + // or with any Amazon Web Services account by sending a directory sharing request ( + // HANDSHAKE ). // // This member is required. ShareMethod types.ShareMethod @@ -74,7 +74,7 @@ type ShareDirectoryInput struct { type ShareDirectoryOutput struct { // Identifier of the directory that is stored in the directory consumer account - // that is shared from the specified directory (DirectoryId). + // that is shared from the specified directory ( DirectoryId ). SharedDirectoryId *string // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_UnshareDirectory.go b/service/directoryservice/api_op_UnshareDirectory.go index 513ca5753d9..a2e2249621b 100644 --- a/service/directoryservice/api_op_UnshareDirectory.go +++ b/service/directoryservice/api_op_UnshareDirectory.go @@ -47,7 +47,7 @@ type UnshareDirectoryInput struct { type UnshareDirectoryOutput struct { // Identifier of the directory stored in the directory consumer account that is to - // be unshared from the specified directory (DirectoryId). + // be unshared from the specified directory ( DirectoryId ). SharedDirectoryId *string // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/doc.go b/service/directoryservice/doc.go index 7b824c96b0e..40f8a92625a 100644 --- a/service/directoryservice/doc.go +++ b/service/directoryservice/doc.go @@ -8,14 +8,12 @@ // Amazon Web Services resources with an existing self-managed Microsoft Active // Directory. This guide provides detailed information about Directory Service // operations, data types, parameters, and errors. For information about Directory -// Services features, see Directory Service -// (https://aws.amazon.com/directoryservice/) and the Directory Service -// Administration Guide -// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html). -// Amazon Web Services provides SDKs that consist of libraries and sample code for -// various programming languages and platforms (Java, Ruby, .Net, iOS, Android, +// Services features, see Directory Service (https://aws.amazon.com/directoryservice/) +// and the Directory Service Administration Guide (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html) +// . Amazon Web Services provides SDKs that consist of libraries and sample code +// for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, // etc.). The SDKs provide a convenient way to create programmatic access to // Directory Service and other Amazon Web Services services. For more information // about the Amazon Web Services SDKs, including how to download and install them, -// see Tools for Amazon Web Services (http://aws.amazon.com/tools/). +// see Tools for Amazon Web Services (http://aws.amazon.com/tools/) . package directoryservice diff --git a/service/directoryservice/types/enums.go b/service/directoryservice/types/enums.go index 0be80ffb2fc..e18b00084c9 100644 --- a/service/directoryservice/types/enums.go +++ b/service/directoryservice/types/enums.go @@ -72,9 +72,9 @@ const ( ClientAuthenticationTypeSmartCardOrPassword ClientAuthenticationType = "SmartCardOrPassword" ) -// Values returns all known values for ClientAuthenticationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClientAuthenticationType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientAuthenticationType) Values() []ClientAuthenticationType { return []ClientAuthenticationType{ "SmartCard", @@ -93,9 +93,10 @@ const ( DirectoryConfigurationStatusDefault DirectoryConfigurationStatus = "Default" ) -// Values returns all known values for DirectoryConfigurationStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DirectoryConfigurationStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DirectoryConfigurationStatus) Values() []DirectoryConfigurationStatus { return []DirectoryConfigurationStatus{ "Requested", @@ -283,9 +284,9 @@ const ( LDAPSTypeClient LDAPSType = "Client" ) -// Values returns all known values for LDAPSType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LDAPSType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LDAPSType) Values() []LDAPSType { return []LDAPSType{ "Client", @@ -300,9 +301,9 @@ const ( OSVersionVersion2019 OSVersion = "SERVER_2019" ) -// Values returns all known values for OSVersion. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OSVersion. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OSVersion) Values() []OSVersion { return []OSVersion{ "SERVER_2012", @@ -320,9 +321,10 @@ const ( RadiusAuthenticationProtocolMschapv2 RadiusAuthenticationProtocol = "MS-CHAPv2" ) -// Values returns all known values for RadiusAuthenticationProtocol. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RadiusAuthenticationProtocol. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RadiusAuthenticationProtocol) Values() []RadiusAuthenticationProtocol { return []RadiusAuthenticationProtocol{ "PAP", @@ -341,9 +343,9 @@ const ( RadiusStatusFailed RadiusStatus = "Failed" ) -// Values returns all known values for RadiusStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RadiusStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RadiusStatus) Values() []RadiusStatus { return []RadiusStatus{ "Creating", @@ -401,8 +403,8 @@ const ( SchemaExtensionStatusCompleted SchemaExtensionStatus = "Completed" ) -// Values returns all known values for SchemaExtensionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SchemaExtensionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SchemaExtensionStatus) Values() []SchemaExtensionStatus { return []SchemaExtensionStatus{ @@ -514,9 +516,9 @@ const ( SnapshotTypeManual SnapshotType = "Manual" ) -// Values returns all known values for SnapshotType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SnapshotType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SnapshotType) Values() []SnapshotType { return []SnapshotType{ "Auto", @@ -626,9 +628,9 @@ const ( TrustTypeExternal TrustType = "External" ) -// Values returns all known values for TrustType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TrustType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TrustType) Values() []TrustType { return []TrustType{ "Forest", @@ -645,9 +647,9 @@ const ( UpdateStatusUpdateFailed UpdateStatus = "UpdateFailed" ) -// Values returns all known values for UpdateStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpdateStatus) Values() []UpdateStatus { return []UpdateStatus{ "Updated", diff --git a/service/directoryservice/types/errors.go b/service/directoryservice/types/errors.go index 9ce2852bacd..1fbad15309c 100644 --- a/service/directoryservice/types/errors.go +++ b/service/directoryservice/types/errors.go @@ -407,8 +407,8 @@ func (e *DirectoryUnavailableException) ErrorCode() string { } func (e *DirectoryUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The maximum allowed number of domain controllers per directory was exceeded. The -// default limit per directory is 20 domain controllers. +// The maximum allowed number of domain controllers per directory was exceeded. +// The default limit per directory is 20 domain controllers. type DomainControllerLimitExceededException struct { Message *string @@ -606,8 +606,8 @@ func (e *InvalidClientAuthStatusException) ErrorCode() string { } func (e *InvalidClientAuthStatusException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The LDAP activities could not be performed because they are limited by the LDAPS -// status. +// The LDAP activities could not be performed because they are limited by the +// LDAPS status. type InvalidLDAPSStatusException struct { Message *string diff --git a/service/directoryservice/types/types.go b/service/directoryservice/types/types.go index ff62c34410a..56c7b7fcc24 100644 --- a/service/directoryservice/types/types.go +++ b/service/directoryservice/types/types.go @@ -45,7 +45,7 @@ type Certificate struct { StateReason *string // The function that the registered certificate performs. Valid values include - // ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. + // ClientLDAPS or ClientCertAuth . The default value is ClientLDAPS . Type CertificateType noSmithyDocumentSerde @@ -67,7 +67,7 @@ type CertificateInfo struct { State CertificateState // The function that the registered certificate performs. Valid values include - // ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS. + // ClientLDAPS or ClientCertAuth . The default value is ClientLDAPS . Type CertificateType noSmithyDocumentSerde @@ -125,8 +125,9 @@ type Computer struct { // another domain. type ConditionalForwarder struct { - // The IP addresses of the remote DNS server associated with RemoteDomainName. This - // is the IP address of the DNS server that your conditional forwarder points to. + // The IP addresses of the remote DNS server associated with RemoteDomainName. + // This is the IP address of the DNS server that your conditional forwarder points + // to. DnsIpAddrs []string // The fully qualified domain name (FQDN) of the remote domains pointed to by the @@ -134,7 +135,7 @@ type ConditionalForwarder struct { RemoteDomainName *string // The replication scope of the conditional forwarder. The only allowed value is - // Domain, which will replicate the conditional forwarder to all of the domain + // Domain , which will replicate the conditional forwarder to all of the domain // controllers for your Amazon Web Services directory. ReplicationScope ReplicationScope @@ -153,13 +154,9 @@ type DirectoryConnectSettings struct { // The user name of an account in your self-managed directory that is used to // connect to the directory. This account must have the following permissions: - // - // * - // Read users and groups - // - // * Create computer objects - // - // * Join computers to the domain + // - Read users and groups + // - Create computer objects + // - Join computers to the domain // // This member is required. CustomerUserName *string @@ -204,13 +201,13 @@ type DirectoryConnectSettingsDescription struct { // Contains information about an Directory Service directory. type DirectoryDescription struct { - // The access URL for the directory, such as http://.awsapps.com. If no alias has - // been created for the directory, is the directory identifier, such as - // d-XXXXXXXXXX. + // The access URL for the directory, such as http://.awsapps.com . If no alias has + // been created for the directory, is the directory identifier, such as + // d-XXXXXXXXXX . AccessUrl *string - // The alias for the directory. If no alias has been created for the directory, the - // alias is the directory identifier, such as d-XXXXXXXXXX. + // The alias for the directory. If no alias has been created for the directory, + // the alias is the directory identifier, such as d-XXXXXXXXXX . Alias *string // A DirectoryConnectSettingsDescription object that contains additional @@ -261,9 +258,9 @@ type DirectoryDescription struct { RegionsInfo *RegionsInfo // The method used when sharing a directory to determine whether the directory - // should be shared within your Amazon Web Services organization (ORGANIZATIONS) or - // with any Amazon Web Services account by sending a shared directory request - // (HANDSHAKE). + // should be shared within your Amazon Web Services organization ( ORGANIZATIONS ) + // or with any Amazon Web Services account by sending a shared directory request ( + // HANDSHAKE ). ShareMethod ShareMethod // A directory share request that is sent by the directory owner to the directory @@ -281,7 +278,7 @@ type DirectoryDescription struct { Size DirectorySize // Indicates if single sign-on is enabled for the directory. For more information, - // see EnableSso and DisableSso. + // see EnableSso and DisableSso . SsoEnabled bool // The current stage of the directory. @@ -453,10 +450,10 @@ type IpRouteInfo struct { // The date and time the address block was added to the directory. AddedDateTime *time.Time - // IP address block in the IpRoute. + // IP address block in the IpRoute . CidrIp *string - // Description of the IpRouteInfo. + // Description of the IpRouteInfo . Description *string // Identifier (ID) of the directory associated with the IP addresses. @@ -537,8 +534,8 @@ type OwnerDirectoryDescription struct { noSmithyDocumentSerde } -// Contains information about a Remote Authentication Dial In User Service (RADIUS) -// server. +// Contains information about a Remote Authentication Dial In User Service +// (RADIUS) server. type RadiusSettings struct { // The protocol specified for your RADIUS endpoints. @@ -589,7 +586,7 @@ type RegionDescription struct { // Specifies when the Region replication began. LaunchTime *time.Time - // The name of the Region. For example, us-east-1. + // The name of the Region. For example, us-east-1 . RegionName *string // Specifies whether the Region is the primary Region or an additional Region. @@ -611,8 +608,8 @@ type RegionDescription struct { // replication. type RegionsInfo struct { - // Lists the Regions where the directory has been replicated, excluding the primary - // Region. + // Lists the Regions where the directory has been replicated, excluding the + // primary Region. AdditionalRegions []string // The Region where the Managed Microsoft AD directory was originally created. @@ -639,7 +636,7 @@ type SchemaExtensionInfo struct { // The current status of the schema extension. SchemaExtensionStatus SchemaExtensionStatus - // The reason for the SchemaExtensionStatus. + // The reason for the SchemaExtensionStatus . SchemaExtensionStatusReason *string // The date and time that the schema extension started being applied to the @@ -658,7 +655,7 @@ type Setting struct { Name *string // The value of the directory setting for which to retrieve information. For - // example, for TLS_1_0, the valid values are: Enable and Disable. + // example, for TLS_1_0 , the valid values are: Enable and Disable . // // This member is required. Value *string @@ -692,7 +689,7 @@ type SettingEntry struct { // The overall status of the request to update the directory setting request. If // the directory setting is deployed in more than one region, and the request fails - // in any region, the overall status is Failed. + // in any region, the overall status is Failed . RequestStatus DirectoryConfigurationStatus // The last status message for the directory status request. @@ -701,7 +698,7 @@ type SettingEntry struct { // The value that was last requested for the directory setting. RequestedValue *string - // The type of directory setting. For example, Protocol or Cipher. + // The type of directory setting. For example, Protocol or Cipher . Type *string noSmithyDocumentSerde @@ -717,17 +714,17 @@ type SharedDirectory struct { // The date and time that the shared directory was last updated. LastUpdatedDateTime *time.Time - // Identifier of the directory owner account, which contains the directory that has - // been shared to the consumer account. + // Identifier of the directory owner account, which contains the directory that + // has been shared to the consumer account. OwnerAccountId *string // Identifier of the directory in the directory owner account. OwnerDirectoryId *string // The method used when sharing a directory to determine whether the directory - // should be shared within your Amazon Web Services organization (ORGANIZATIONS) or - // with any Amazon Web Services account by sending a shared directory request - // (HANDSHAKE). + // should be shared within your Amazon Web Services organization ( ORGANIZATIONS ) + // or with any Amazon Web Services account by sending a shared directory request ( + // HANDSHAKE ). ShareMethod ShareMethod // A directory share request that is sent by the directory owner to the directory @@ -739,7 +736,7 @@ type SharedDirectory struct { ShareStatus ShareStatus // Identifier of the directory consumer account that has access to the shared - // directory (OwnerDirectoryId) in the directory owner account. + // directory ( OwnerDirectoryId ) in the directory owner account. SharedAccountId *string // Identifier of the shared directory in the directory consumer account. This @@ -915,7 +912,7 @@ type UpdateInfoEntry struct { noSmithyDocumentSerde } -// The value for a given type of UpdateSettings. +// The value for a given type of UpdateSettings . type UpdateValue struct { // The OS update related settings. diff --git a/service/dlm/api_client.go b/service/dlm/api_client.go index 4bd36473e8d..1d6d8fcc5b2 100644 --- a/service/dlm/api_client.go +++ b/service/dlm/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "DLM" const ServiceAPIVersion = "2018-01-12" -// Client provides the API client to make operations call for Amazon Data Lifecycle -// Manager. +// Client provides the API client to make operations call for Amazon Data +// Lifecycle Manager. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/dlm/api_op_DeleteLifecyclePolicy.go b/service/dlm/api_op_DeleteLifecyclePolicy.go index 060fe7c3bf5..10197e0f0f2 100644 --- a/service/dlm/api_op_DeleteLifecyclePolicy.go +++ b/service/dlm/api_op_DeleteLifecyclePolicy.go @@ -12,8 +12,8 @@ import ( // Deletes the specified lifecycle policy and halts the automated operations that // the policy specified. For more information about deleting a policy, see Delete -// lifecycle policies -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#delete). +// lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#delete) +// . func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error) { if params == nil { params = &DeleteLifecyclePolicyInput{} diff --git a/service/dlm/api_op_GetLifecyclePolicies.go b/service/dlm/api_op_GetLifecyclePolicies.go index 7dfdc943197..36446d22de5 100644 --- a/service/dlm/api_op_GetLifecyclePolicies.go +++ b/service/dlm/api_op_GetLifecyclePolicies.go @@ -12,7 +12,7 @@ import ( ) // Gets summary information about all or the specified data lifecycle policies. To -// get complete information about a policy, use GetLifecyclePolicy. +// get complete information about a policy, use GetLifecyclePolicy . func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecyclePoliciesInput, optFns ...func(*Options)) (*GetLifecyclePoliciesOutput, error) { if params == nil { params = &GetLifecyclePoliciesInput{} @@ -39,12 +39,12 @@ type GetLifecyclePoliciesInput struct { // The activation state. State types.GettablePolicyStateValues - // The tags to add to objects created by the policy. Tags are strings in the format - // key=value. These user-defined tags are added in addition to the Amazon Web - // Services-added lifecycle tags. + // The tags to add to objects created by the policy. Tags are strings in the + // format key=value . These user-defined tags are added in addition to the Amazon + // Web Services-added lifecycle tags. TagsToAdd []string - // The target tag for a policy. Tags are strings in the format key=value. + // The target tag for a policy. Tags are strings in the format key=value . TargetTags []string noSmithyDocumentSerde diff --git a/service/dlm/api_op_UpdateLifecyclePolicy.go b/service/dlm/api_op_UpdateLifecyclePolicy.go index 9fd3087423d..bea0dd3fad0 100644 --- a/service/dlm/api_op_UpdateLifecyclePolicy.go +++ b/service/dlm/api_op_UpdateLifecyclePolicy.go @@ -12,8 +12,8 @@ import ( ) // Updates the specified lifecycle policy. For more information about updating a -// policy, see Modify lifecycle policies -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#modify). +// policy, see Modify lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-modify-delete.html#modify) +// . func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, optFns ...func(*Options)) (*UpdateLifecyclePolicyOutput, error) { if params == nil { params = &UpdateLifecyclePolicyInput{} diff --git a/service/dlm/doc.go b/service/dlm/doc.go index e65a43db336..e5e9ed1f217 100644 --- a/service/dlm/doc.go +++ b/service/dlm/doc.go @@ -3,12 +3,11 @@ // Package dlm provides the API client, operations, and parameter types for Amazon // Data Lifecycle Manager. // -// Amazon Data Lifecycle Manager With Amazon Data Lifecycle Manager, you can manage -// the lifecycle of your Amazon Web Services resources. You create lifecycle +// Amazon Data Lifecycle Manager With Amazon Data Lifecycle Manager, you can +// manage the lifecycle of your Amazon Web Services resources. You create lifecycle // policies, which are used to automate operations on the specified resources. // Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For // information about using Amazon Data Lifecycle Manager with Amazon EBS, see -// Amazon Data Lifecycle Manager -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html) in -// the Amazon EC2 User Guide. +// Amazon Data Lifecycle Manager (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html) +// in the Amazon EC2 User Guide. package dlm diff --git a/service/dlm/types/types.go b/service/dlm/types/types.go index 0cb43f33983..b3a55c71047 100644 --- a/service/dlm/types/types.go +++ b/service/dlm/types/types.go @@ -27,9 +27,9 @@ type Action struct { // retention period. type ArchiveRetainRule struct { - // Information about retention period in the Amazon EBS Snapshots Archive. For more - // information, see Archive Amazon EBS snapshots - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html). + // Information about retention period in the Amazon EBS Snapshots Archive. For + // more information, see Archive Amazon EBS snapshots (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html) + // . // // This member is required. RetentionArchiveTier *RetentionArchiveTier @@ -50,17 +50,14 @@ type ArchiveRule struct { // [Snapshot and AMI policies only] Specifies when the policy should create // snapshots or AMIs. -// -// * You must specify either CronExpression, or Interval, -// IntervalUnit, and Times. -// -// * If you need to specify an ArchiveRule for the -// schedule, then you must specify a creation frequency of at least 28 days. +// - You must specify either CronExpression, or Interval, IntervalUnit, and +// Times. +// - If you need to specify an ArchiveRule for the schedule, then you must +// specify a creation frequency of at least 28 days. type CreateRule struct { - // The schedule, as a Cron expression. The schedule interval must be between 1 hour - // and 1 year. For more information, see Cron expressions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) + // The schedule, as a Cron expression. The schedule interval must be between 1 + // hour and 1 year. For more information, see Cron expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) // in the Amazon CloudWatch User Guide. CronExpression *string @@ -73,8 +70,8 @@ type CreateRule struct { // [Snapshot policies only] Specifies the destination for snapshots created by the // policy. To create snapshots in the same Region as the source resource, specify - // CLOUD. To create snapshots on the same Outpost as the source resource, specify - // OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default. If the + // CLOUD . To create snapshots on the same Outpost as the source resource, specify + // OUTPOST_LOCAL . If you omit this parameter, CLOUD is used by default. If the // policy targets resources in an Amazon Web Services Region, then you must create // snapshots in the same Region as the source resource. If the policy targets // resources on an Outpost, then you can create snapshots on the same Outpost as @@ -90,9 +87,9 @@ type CreateRule struct { noSmithyDocumentSerde } -// [Event-based policies only] Specifies a cross-Region copy action for event-based -// policies. To specify a cross-Region copy rule for snapshot and AMI policies, use -// CrossRegionCopyRule. +// [Event-based policies only] Specifies a cross-Region copy action for +// event-based policies. To specify a cross-Region copy rule for snapshot and AMI +// policies, use CrossRegionCopyRule . type CrossRegionCopyAction struct { // The encryption settings for the copied snapshot. @@ -117,15 +114,15 @@ type CrossRegionCopyAction struct { // copies created by an AMI policy. type CrossRegionCopyDeprecateRule struct { - // The period after which to deprecate the cross-Region AMI copies. The period must - // be less than or equal to the cross-Region AMI copy retention period, and it + // The period after which to deprecate the cross-Region AMI copies. The period + // must be less than or equal to the cross-Region AMI copy retention period, and it // can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or // 3650 days. Interval int32 // The unit of time in which to measure the Interval. For example, to deprecate a - // cross-Region AMI copy after 3 months, specify Interval=3 and - // IntervalUnit=MONTHS. + // cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS + // . IntervalUnit RetentionIntervalUnitValues noSmithyDocumentSerde @@ -136,20 +133,20 @@ type CrossRegionCopyDeprecateRule struct { // After the retention period expires, the cross-Region copy is deleted. type CrossRegionCopyRetainRule struct { - // The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is - // 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. + // The amount of time to retain a cross-Region snapshot or AMI copy. The maximum + // is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. Interval int32 - // The unit of time for time-based retention. For example, to retain a cross-Region - // copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS. + // The unit of time for time-based retention. For example, to retain a + // cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS . IntervalUnit RetentionIntervalUnitValues noSmithyDocumentSerde } -// [Snapshot and AMI policies only] Specifies a cross-Region copy rule for snapshot -// and AMI policies. To specify a cross-Region copy action for event-based polices, -// use CrossRegionCopyAction. +// [Snapshot and AMI policies only] Specifies a cross-Region copy rule for +// snapshot and AMI policies. To specify a cross-Region copy action for event-based +// polices, use CrossRegionCopyAction . type CrossRegionCopyRule struct { // To encrypt a copy of an unencrypted snapshot if encryption by default is not @@ -160,16 +157,16 @@ type CrossRegionCopyRule struct { // This member is required. Encrypted *bool - // The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this - // parameter is not specified, the default KMS key for the account is used. + // The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If + // this parameter is not specified, the default KMS key for the account is used. CmkArn *string // Indicates whether to copy all user-defined tags from the source snapshot or AMI // to the cross-Region copy. CopyTags *bool - // [AMI policies only] The AMI deprecation rule for cross-Region AMI copies created - // by the rule. + // [AMI policies only] The AMI deprecation rule for cross-Region AMI copies + // created by the rule. DeprecateRule *CrossRegionCopyDeprecateRule // The retention rule that indicates how long the cross-Region snapshot or AMI @@ -190,8 +187,8 @@ type CrossRegionCopyRule struct { noSmithyDocumentSerde } -// [AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI -// lifecycle policy. For age-based schedules, you must specify Interval and +// [AMI policies only] Specifies an AMI deprecation rule for AMIs created by an +// AMI lifecycle policy. For age-based schedules, you must specify Interval and // IntervalUnit. For count-based schedules, you must specify Count. type DeprecateRule struct { @@ -224,8 +221,8 @@ type EncryptionConfiguration struct { // This member is required. Encrypted *bool - // The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this - // parameter is not specified, the default KMS key for the account is used. + // The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If + // this parameter is not specified, the default KMS key for the account is used. CmkArn *string noSmithyDocumentSerde @@ -235,10 +232,10 @@ type EncryptionConfiguration struct { // policy. type EventParameters struct { - // The snapshot description that can trigger the policy. The description pattern is - // specified using a regular expression. The policy runs only if a snapshot with a - // description that matches the specified pattern is shared with your account. For - // example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ + // The snapshot description that can trigger the policy. The description pattern + // is specified using a regular expression. The policy runs only if a snapshot with + // a description that matches the specified pattern is shared with your account. + // For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ // configures the policy to run only if snapshots created by policy // policy-1234567890abcdef0 are shared with your account. // @@ -276,8 +273,8 @@ type EventSource struct { noSmithyDocumentSerde } -// [Snapshot policies only] Specifies a rule for enabling fast snapshot restore for -// snapshots created by snapshot policies. You can enable fast snapshot restore +// [Snapshot policies only] Specifies a rule for enabling fast snapshot restore +// for snapshots created by snapshot policies. You can enable fast snapshot restore // based on either a count or a time interval. type FastRestoreRule struct { @@ -369,13 +366,13 @@ type LifecyclePolicySummary struct { // attached to an instance, then Amazon Data Lifecycle Manager will not create any // snapshots for the affected instance, and it will emit a SnapshotsCreateFailed // Amazon CloudWatch metric. For more information, see Monitor your policies using -// Amazon CloudWatch -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html). +// Amazon CloudWatch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html) +// . type Parameters struct { // [Snapshot policies that target instances only] Indicates whether to exclude the - // root volume from multi-volume snapshot sets. The default is false. If you - // specify true, then the root volumes attached to targeted instances will be + // root volume from multi-volume snapshot sets. The default is false . If you + // specify true , then the root volumes attached to targeted instances will be // excluded from the multi-volume snapshot sets created by the policy. ExcludeBootVolume *bool @@ -420,20 +417,20 @@ type PolicyDetails struct { // create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify // EVENT_BASED_POLICY to create an event-based policy that performs specific // actions when a defined event occurs in your Amazon Web Services account. The - // default is EBS_SNAPSHOT_MANAGEMENT. + // default is EBS_SNAPSHOT_MANAGEMENT . PolicyType PolicyTypeValues - // [Snapshot and AMI policies only] The location of the resources to backup. If the - // source resources are located in an Amazon Web Services Region, specify CLOUD. If - // the source resources are located on an Outpost in your account, specify OUTPOST. - // If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of - // the specified type with matching target tags across all of the Outposts in your - // account. + // [Snapshot and AMI policies only] The location of the resources to backup. If + // the source resources are located in an Amazon Web Services Region, specify CLOUD + // . If the source resources are located on an Outpost in your account, specify + // OUTPOST . If you specify OUTPOST , Amazon Data Lifecycle Manager backs up all + // resources of the specified type with matching target tags across all of the + // Outposts in your account. ResourceLocations []ResourceLocationValues - // [Snapshot policies only] The target resource type for snapshot and AMI lifecycle - // policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE - // to create multi-volume snapshots from the volumes for an instance. + // [Snapshot policies only] The target resource type for snapshot and AMI + // lifecycle policies. Use VOLUME to create snapshots of individual volumes or use + // INSTANCE to create multi-volume snapshots from the volumes for an instance. ResourceTypes []ResourceTypeValues // [Snapshot and AMI policies only] The schedules of policy-defined actions for @@ -450,30 +447,27 @@ type PolicyDetails struct { // [Snapshot and AMI policies only] Specifies a retention rule for snapshots // created by snapshot policies, or for AMIs created by AMI policies. For snapshot -// policies that have an ArchiveRule, this retention rule applies to standard tier +// policies that have an ArchiveRule , this retention rule applies to standard tier // retention. When the retention threshold is met, snapshots are moved from the // standard to the archive tier. For snapshot policies that do not have an // ArchiveRule, snapshots are permanently deleted when this retention threshold is // met. You can retain snapshots based on either a count or a time interval. -// -// * -// Count-based retention You must specify Count. If you specify an ArchiveRule for -// the schedule, then you can specify a retention count of 0 to archive snapshots -// immediately after creation. If you specify a FastRestoreRule, ShareRule, or a -// CrossRegionCopyRule, then you must specify a retention count of 1 or more. -// -// * -// Age-based retention You must specify Interval and IntervalUnit. If you specify -// an ArchiveRule for the schedule, then you can specify a retention interval of 0 -// days to archive snapshots immediately after creation. If you specify a -// FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a -// retention interval of 1 day or more. +// - Count-based retention You must specify Count. If you specify an ArchiveRule +// for the schedule, then you can specify a retention count of 0 to archive +// snapshots immediately after creation. If you specify a FastRestoreRule , +// ShareRule , or a CrossRegionCopyRule , then you must specify a retention count +// of 1 or more. +// - Age-based retention You must specify Interval and IntervalUnit. If you +// specify an ArchiveRule for the schedule, then you can specify a retention +// interval of 0 days to archive snapshots immediately after creation. If you +// specify a FastRestoreRule , ShareRule , or a CrossRegionCopyRule , then you +// must specify a retention interval of 1 day or more. type RetainRule struct { // The number of snapshots to retain for each volume, up to a maximum of 1000. For - // example if you want to retain a maximum of three snapshots, specify 3. When the + // example if you want to retain a maximum of three snapshots, specify 3 . When the // fourth snapshot is created, the oldest retained snapshot is deleted, or it is - // moved to the archive tier if you have specified an ArchiveRule. + // moved to the archive tier if you have specified an ArchiveRule . Count int32 // The amount of time to retain each snapshot. The maximum is 100 years. This is @@ -481,9 +475,9 @@ type RetainRule struct { Interval int32 // The unit of time for time-based retention. For example, to retain snapshots for - // 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been - // retained for 3 months, it is deleted, or it is moved to the archive tier if you - // have specified an ArchiveRule. + // 3 months, specify Interval=3 and IntervalUnit=MONTHS . Once the snapshot has + // been retained for 3 months, it is deleted, or it is moved to the archive tier if + // you have specified an ArchiveRule . IntervalUnit RetentionIntervalUnitValues noSmithyDocumentSerde @@ -495,8 +489,8 @@ type RetainRule struct { // in the archive tier for a minimum of 90 days. For count-based schedules, you // must specify Count. For age-based schedules, you must specify Interval and // IntervalUnit. For more information about using snapshot archiving, see -// Considerations for snapshot lifecycle policies -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive). +// Considerations for snapshot lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive) +// . type RetentionArchiveTier struct { // The maximum number of snapshots to retain in the archive storage tier for each @@ -506,13 +500,13 @@ type RetentionArchiveTier struct { // for at least 90 days. Count int32 - // Specifies the period of time to retain snapshots in the archive tier. After this - // period expires, the snapshot is permanently deleted. + // Specifies the period of time to retain snapshots in the archive tier. After + // this period expires, the snapshot is permanently deleted. Interval int32 // The unit of time in which to measure the Interval. For example, to retain a // snapshots in the archive tier for 6 months, specify Interval=6 and - // IntervalUnit=MONTHS. + // IntervalUnit=MONTHS . IntervalUnit RetentionIntervalUnitValues noSmithyDocumentSerde @@ -522,26 +516,26 @@ type RetentionArchiveTier struct { // lifecycle policy. type Schedule struct { - // [Snapshot policies that target volumes only] The snapshot archiving rule for the - // schedule. When you specify an archiving rule, snapshots are automatically moved - // from the standard tier to the archive tier once the schedule's retention + // [Snapshot policies that target volumes only] The snapshot archiving rule for + // the schedule. When you specify an archiving rule, snapshots are automatically + // moved from the standard tier to the archive tier once the schedule's retention // threshold is met. Snapshots are then retained in the archive tier for the // archive retention period that you specify. For more information about using - // snapshot archiving, see Considerations for snapshot lifecycle policies - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive). + // snapshot archiving, see Considerations for snapshot lifecycle policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive) + // . ArchiveRule *ArchiveRule - // Copy all user-defined tags on a source volume to snapshots of the volume created - // by this policy. + // Copy all user-defined tags on a source volume to snapshots of the volume + // created by this policy. CopyTags bool // The creation rule. CreateRule *CreateRule - // Specifies a rule for copying snapshots or AMIs across regions. You can't specify - // cross-Region copy rules for policies that create snapshots on an Outpost. If the - // policy creates snapshots in a Region, then snapshots can be copied to up to - // three Regions or Outposts. + // Specifies a rule for copying snapshots or AMIs across regions. You can't + // specify cross-Region copy rules for policies that create snapshots on an + // Outpost. If the policy creates snapshots in a Region, then snapshots can be + // copied to up to three Regions or Outposts. CrossRegionCopyRules []CrossRegionCopyRule // [AMI policies only] The AMI deprecation rule for the schedule. @@ -567,7 +561,7 @@ type Schedule struct { // [AMI policies and snapshot policies that target instances only] A collection of // key/value pairs with values determined dynamically when the policy is executed. // Keys may be any valid Amazon EC2 tag key. Values must be in one of the two - // following formats: $(instance-id) or $(timestamp). Variable tags are only valid + // following formats: $(instance-id) or $(timestamp) . Variable tags are only valid // for EBS Snapshot Management – Instance policies. VariableTags []Tag diff --git a/service/docdb/api_client.go b/service/docdb/api_client.go index 46080b200f5..bd53a381194 100644 --- a/service/docdb/api_client.go +++ b/service/docdb/api_client.go @@ -117,7 +117,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/docdb/api_op_AddSourceIdentifierToSubscription.go b/service/docdb/api_op_AddSourceIdentifierToSubscription.go index 82042ae4e6c..45f83087ef8 100644 --- a/service/docdb/api_op_AddSourceIdentifierToSubscription.go +++ b/service/docdb/api_op_AddSourceIdentifierToSubscription.go @@ -27,22 +27,16 @@ func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params * return out, nil } -// Represents the input to AddSourceIdentifierToSubscription. +// Represents the input to AddSourceIdentifierToSubscription . type AddSourceIdentifierToSubscriptionInput struct { // The identifier of the event source to be added: - // - // * If the source type is an - // instance, a DBInstanceIdentifier must be provided. - // - // * If the source type is a - // security group, a DBSecurityGroupName must be provided. - // - // * If the source type is - // a parameter group, a DBParameterGroupName must be provided. - // - // * If the source - // type is a snapshot, a DBSnapshotIdentifier must be provided. + // - If the source type is an instance, a DBInstanceIdentifier must be provided. + // - If the source type is a security group, a DBSecurityGroupName must be + // provided. + // - If the source type is a parameter group, a DBParameterGroupName must be + // provided. + // - If the source type is a snapshot, a DBSnapshotIdentifier must be provided. // // This member is required. SourceIdentifier *string diff --git a/service/docdb/api_op_AddTagsToResource.go b/service/docdb/api_op_AddTagsToResource.go index 22a96a87300..261ad0bca41 100644 --- a/service/docdb/api_op_AddTagsToResource.go +++ b/service/docdb/api_op_AddTagsToResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with -// cost allocation reporting to track costs that are associated with Amazon +// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags +// with cost allocation reporting to track costs that are associated with Amazon // DocumentDB resources or in a Condition statement in an Identity and Access // Management (IAM) policy for Amazon DocumentDB. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { @@ -30,7 +30,7 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc return out, nil } -// Represents the input to AddTagsToResource. +// Represents the input to AddTagsToResource . type AddTagsToResourceInput struct { // The Amazon DocumentDB resource that the tags are added to. This value is an diff --git a/service/docdb/api_op_ApplyPendingMaintenanceAction.go b/service/docdb/api_op_ApplyPendingMaintenanceAction.go index 759e56e323a..349d12dd3f9 100644 --- a/service/docdb/api_op_ApplyPendingMaintenanceAction.go +++ b/service/docdb/api_op_ApplyPendingMaintenanceAction.go @@ -28,26 +28,21 @@ func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *Appl return out, nil } -// Represents the input to ApplyPendingMaintenanceAction. +// Represents the input to ApplyPendingMaintenanceAction . type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. Valid values: - // system-update, db-upgrade + // system-update , db-upgrade // // This member is required. ApplyAction *string // A value that specifies the type of opt-in request or undoes an opt-in request. // An opt-in request of type immediate can't be undone. Valid values: - // - // * immediate - // - Apply the maintenance action immediately. - // - // * next-maintenance - Apply the - // maintenance action during the next maintenance window for the resource. - // - // * - // undo-opt-in - Cancel any existing next-maintenance opt-in requests. + // - immediate - Apply the maintenance action immediately. + // - next-maintenance - Apply the maintenance action during the next maintenance + // window for the resource. + // - undo-opt-in - Cancel any existing next-maintenance opt-in requests. // // This member is required. OptInType *string @@ -63,7 +58,7 @@ type ApplyPendingMaintenanceActionInput struct { type ApplyPendingMaintenanceActionOutput struct { - // Represents the output of ApplyPendingMaintenanceAction. + // Represents the output of ApplyPendingMaintenanceAction . ResourcePendingMaintenanceActions *types.ResourcePendingMaintenanceActions // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_CopyDBClusterParameterGroup.go b/service/docdb/api_op_CopyDBClusterParameterGroup.go index 48449b7d143..dbf4b92f078 100644 --- a/service/docdb/api_op_CopyDBClusterParameterGroup.go +++ b/service/docdb/api_op_CopyDBClusterParameterGroup.go @@ -27,23 +27,18 @@ func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDB return out, nil } -// Represents the input to CopyDBClusterParameterGroup. +// Represents the input to CopyDBClusterParameterGroup . type CopyDBClusterParameterGroupInput struct { // The identifier or Amazon Resource Name (ARN) for the source cluster parameter // group. Constraints: - // - // * Must specify a valid cluster parameter group. - // - // * If the - // source cluster parameter group is in the same Amazon Web Services Region as the - // copy, specify a valid parameter group identifier; for example, - // my-db-cluster-param-group, or a valid ARN. - // - // * If the source parameter group is - // in a different Amazon Web Services Region than the copy, specify a valid cluster - // parameter group ARN; for example, - // arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group. + // - Must specify a valid cluster parameter group. + // - If the source cluster parameter group is in the same Amazon Web Services + // Region as the copy, specify a valid parameter group identifier; for example, + // my-db-cluster-param-group , or a valid ARN. + // - If the source parameter group is in a different Amazon Web Services Region + // than the copy, specify a valid cluster parameter group ARN; for example, + // arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group . // // This member is required. SourceDBClusterParameterGroupIdentifier *string @@ -54,18 +49,10 @@ type CopyDBClusterParameterGroupInput struct { TargetDBClusterParameterGroupDescription *string // The identifier for the copied cluster parameter group. Constraints: - // - // * Cannot be - // null, empty, or blank. - // - // * Must contain from 1 to 255 letters, numbers, or - // hyphens. - // - // * The first character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Cannot be null, empty, or blank. + // - Must contain from 1 to 255 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster-param-group1 // // This member is required. diff --git a/service/docdb/api_op_CopyDBClusterSnapshot.go b/service/docdb/api_op_CopyDBClusterSnapshot.go index f033975ac98..f2c44a4afd5 100644 --- a/service/docdb/api_op_CopyDBClusterSnapshot.go +++ b/service/docdb/api_op_CopyDBClusterSnapshot.go @@ -35,22 +35,16 @@ func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBCluste return out, nil } -// Represents the input to CopyDBClusterSnapshot. +// Represents the input to CopyDBClusterSnapshot . type CopyDBClusterSnapshotInput struct { // The identifier of the cluster snapshot to copy. This parameter is not case // sensitive. Constraints: - // - // * Must specify a valid system snapshot in the available - // state. - // - // * If the source snapshot is in the same Amazon Web Services Region as - // the copy, specify a valid snapshot identifier. - // - // * If the source snapshot is in a - // different Amazon Web Services Region than the copy, specify a valid cluster - // snapshot ARN. - // + // - Must specify a valid system snapshot in the available state. + // - If the source snapshot is in the same Amazon Web Services Region as the + // copy, specify a valid snapshot identifier. + // - If the source snapshot is in a different Amazon Web Services Region than + // the copy, specify a valid cluster snapshot ARN. // Example: my-cluster-snapshot1 // // This member is required. @@ -58,35 +52,28 @@ type CopyDBClusterSnapshotInput struct { // The identifier of the new cluster snapshot to create from the source cluster // snapshot. This parameter is not case sensitive. Constraints: - // - // * Must contain - // from 1 to 63 letters, numbers, or hyphens. - // - // * The first character must be a - // letter. - // - // * Cannot end with a hyphen or contain two consecutive - // hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster-snapshot2 // // This member is required. TargetDBClusterSnapshotIdentifier *string // Set to true to copy all tags from the source cluster snapshot to the target - // cluster snapshot, and otherwise false. The default is false. + // cluster snapshot, and otherwise false . The default is false . CopyTags *bool // The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon // Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS // encryption key. If you copy an encrypted cluster snapshot from your Amazon Web // Services account, you can specify a value for KmsKeyId to encrypt the copy with - // a new KMS encryption key. If you don't specify a value for KmsKeyId, then the + // a new KMS encryption key. If you don't specify a value for KmsKeyId , then the // copy of the cluster snapshot is encrypted with the same KMS key as the source // cluster snapshot. If you copy an encrypted cluster snapshot that is shared from - // another Amazon Web Services account, then you must specify a value for KmsKeyId. - // To copy an encrypted cluster snapshot to another Amazon Web Services Region, set - // KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the + // another Amazon Web Services account, then you must specify a value for KmsKeyId + // . To copy an encrypted cluster snapshot to another Amazon Web Services Region, + // set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the // cluster snapshot in the destination Region. KMS encryption keys are specific to // the Amazon Web Services Region that they are created in, and you can't use // encryption keys from one Amazon Web Services Region in another Amazon Web @@ -94,34 +81,28 @@ type CopyDBClusterSnapshotInput struct { // for the KmsKeyId parameter, an error is returned. KmsKeyId *string - // The URL that contains a Signature Version 4 signed request for - // theCopyDBClusterSnapshot API action in the Amazon Web Services Region that - // contains the source cluster snapshot to copy. You must use the PreSignedUrl - // parameter when copying a cluster snapshot from another Amazon Web Services - // Region. If you are using an Amazon Web Services SDK tool or the CLI, you can - // specify SourceRegion (or --source-region for the CLI) instead of specifying - // PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL - // that is a valid request for the operation that can be executed in the source - // Amazon Web Services Region. The presigned URL must be a valid request for the + // The URL that contains a Signature Version 4 signed request for the + // CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains + // the source cluster snapshot to copy. You must use the PreSignedUrl parameter + // when copying a cluster snapshot from another Amazon Web Services Region. If you + // are using an Amazon Web Services SDK tool or the CLI, you can specify + // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl + // manually. Specifying SourceRegion autogenerates a pre-signed URL that is a + // valid request for the operation that can be executed in the source Amazon Web + // Services Region. The presigned URL must be a valid request for the // CopyDBClusterSnapshot API action that can be executed in the source Amazon Web // Services Region that contains the cluster snapshot to be copied. The presigned // URL request must contain the following parameter values: - // - // * SourceRegion - The - // ID of the region that contains the snapshot to be copied. - // - // * - // SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster - // snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) - // format for the source Amazon Web Services Region. For example, if you are - // copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services - // Region, then your SourceDBClusterSnapshotIdentifier looks something like the - // following: - // arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot. - // - // * - // TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot - // to be created. This parameter isn't case sensitive. + // - SourceRegion - The ID of the region that contains the snapshot to be copied. + // - SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted + // cluster snapshot to be copied. This identifier must be in the Amazon Resource + // Name (ARN) format for the source Amazon Web Services Region. For example, if you + // are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services + // Region, then your SourceDBClusterSnapshotIdentifier looks something like the + // following: + // arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot . + // - TargetDBClusterSnapshotIdentifier - The identifier for the new cluster + // snapshot to be created. This parameter isn't case sensitive. PreSignedUrl *string // The AWS region the resource is in. The presigned URL will be created with this @@ -131,8 +112,8 @@ type CopyDBClusterSnapshotInput struct { // The tags to be assigned to the cluster snapshot. Tags []types.Tag - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/docdb/api_op_CreateDBCluster.go b/service/docdb/api_op_CreateDBCluster.go index 811c5934707..71c4570eee8 100644 --- a/service/docdb/api_op_CreateDBCluster.go +++ b/service/docdb/api_op_CreateDBCluster.go @@ -29,20 +29,14 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp return out, nil } -// Represents the input to CreateDBCluster. +// Represents the input to CreateDBCluster . type CreateDBClusterInput struct { // The cluster identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * The - // first character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster // // This member is required. @@ -59,28 +53,27 @@ type CreateDBClusterInput struct { // The number of days for which automated backups are retained. You must specify a // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35. + // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The name of the cluster parameter group to associate with this cluster. DBClusterParameterGroupName *string // A subnet group to associate with this cluster. Constraints: Must match the name - // of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + // of an existing DBSubnetGroup . Must not be default. Example: mySubnetgroup DBSubnetGroupName *string - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. + // Specifies whether this cluster can be deleted. If DeletionProtection is + // enabled, the cluster cannot be deleted unless it is modified and + // DeletionProtection is disabled. DeletionProtection protects clusters from being + // accidentally deleted. DeletionProtection *bool // A list of log types that need to be enabled for exporting to Amazon CloudWatch // Logs. You can enable audit logs or profiler logs. For more information, see - // Auditing Amazon DocumentDB Events - // (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) - // and Profiling Amazon DocumentDB Operations - // (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html). + // Auditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) + // and Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html) + // . EnableCloudwatchLogsExports []string // The version number of the database engine to use. The --engine-version will @@ -97,14 +90,12 @@ type CreateDBClusterInput struct { // cluster using the same Amazon Web Services account that owns the KMS encryption // key that is used to encrypt the new cluster, you can use the KMS key alias // instead of the ARN for the KMS encryption key. If an encryption key is not - // specified in KmsKeyId: - // - // * If the StorageEncrypted parameter is true, Amazon - // DocumentDB uses your default encryption key. - // - // KMS creates the default encryption - // key for your Amazon Web Services account. Your Amazon Web Services account has a - // different default encryption key for each Amazon Web Services Regions. + // specified in KmsKeyId : + // - If the StorageEncrypted parameter is true , Amazon DocumentDB uses your + // default encryption key. + // KMS creates the default encryption key for your Amazon Web Services account. + // Your Amazon Web Services account has a different default encryption key for each + // Amazon Web Services Regions. KmsKeyId *string // The password for the master database user. This password can contain any @@ -113,14 +104,9 @@ type CreateDBClusterInput struct { MasterUserPassword *string // The name of the master user for the cluster. Constraints: - // - // * Must be from 1 to - // 63 letters or numbers. - // - // * The first character must be a letter. - // - // * Cannot be a - // reserved word for the chosen database engine. + // - Must be from 1 to 63 letters or numbers. + // - The first character must be a letter. + // - Cannot be a reserved word for the chosen database engine. MasterUsername *string // The port number on which the instances in the cluster accept connections. @@ -133,16 +119,10 @@ type CreateDBClusterInput struct { // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon // Web Services Region. Constraints: - // - // * Must be in the format hh24:mi-hh24:mi. - // - // * - // Must be in Universal Coordinated Time (UTC). - // - // * Must not conflict with the - // preferred maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal @@ -165,8 +145,8 @@ type CreateDBClusterInput struct { // A list of EC2 VPC security groups to associate with this cluster. VpcSecurityGroupIds []string - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/docdb/api_op_CreateDBClusterParameterGroup.go b/service/docdb/api_op_CreateDBClusterParameterGroup.go index 885dab695f1..0e64701cede 100644 --- a/service/docdb/api_op_CreateDBClusterParameterGroup.go +++ b/service/docdb/api_op_CreateDBClusterParameterGroup.go @@ -17,15 +17,13 @@ import ( // instances in the cluster. In Amazon DocumentDB, you cannot make modifications // directly to the default.docdb3.6 cluster parameter group. If your Amazon // DocumentDB cluster is using the default cluster parameter group and you want to -// modify a value in it, you must first create a new parameter group -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) -// or copy an existing parameter group -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), -// modify it, and then apply the modified parameter group to your cluster. For the -// new cluster parameter group and associated settings to take effect, you must +// modify a value in it, you must first create a new parameter group (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) +// or copy an existing parameter group (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html) +// , modify it, and then apply the modified parameter group to your cluster. For +// the new cluster parameter group and associated settings to take effect, you must // then reboot the instances in the cluster without failover. For more information, -// see Modifying Amazon DocumentDB Cluster Parameter Groups -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html). +// see Modifying Amazon DocumentDB Cluster Parameter Groups (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html) +// . func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { params = &CreateDBClusterParameterGroupInput{} @@ -41,16 +39,12 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea return out, nil } -// Represents the input of CreateDBClusterParameterGroup. +// Represents the input of CreateDBClusterParameterGroup . type CreateDBClusterParameterGroupInput struct { // The name of the cluster parameter group. Constraints: - // - // * Must not match the name - // of an existing DBClusterParameterGroup. - // - // This value is stored as a lowercase - // string. + // - Must not match the name of an existing DBClusterParameterGroup . + // This value is stored as a lowercase string. // // This member is required. DBClusterParameterGroupName *string diff --git a/service/docdb/api_op_CreateDBClusterSnapshot.go b/service/docdb/api_op_CreateDBClusterSnapshot.go index d31bbf55878..20841603ec2 100644 --- a/service/docdb/api_op_CreateDBClusterSnapshot.go +++ b/service/docdb/api_op_CreateDBClusterSnapshot.go @@ -27,15 +27,12 @@ func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBCl return out, nil } -// Represents the input of CreateDBClusterSnapshot. +// Represents the input of CreateDBClusterSnapshot . type CreateDBClusterSnapshotInput struct { // The identifier of the cluster to create a snapshot for. This parameter is not // case sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. - // + // - Must match the identifier of an existing DBCluster . // Example: my-cluster // // This member is required. @@ -43,15 +40,9 @@ type CreateDBClusterSnapshotInput struct { // The identifier of the cluster snapshot. This parameter is stored as a lowercase // string. Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or - // hyphens. - // - // * The first character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster-snapshot1 // // This member is required. diff --git a/service/docdb/api_op_CreateDBInstance.go b/service/docdb/api_op_CreateDBInstance.go index fa51d227787..0ec0240e743 100644 --- a/service/docdb/api_op_CreateDBInstance.go +++ b/service/docdb/api_op_CreateDBInstance.go @@ -27,7 +27,7 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI return out, nil } -// Represents the input to CreateDBInstance. +// Represents the input to CreateDBInstance . type CreateDBInstanceInput struct { // The identifier of the cluster that the instance will belong to. @@ -35,22 +35,16 @@ type CreateDBInstanceInput struct { // This member is required. DBClusterIdentifier *string - // The compute and memory capacity of the instance; for example, db.r5.large. + // The compute and memory capacity of the instance; for example, db.r5.large . // // This member is required. DBInstanceClass *string // The instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * The - // first character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance // // This member is required. @@ -70,13 +64,13 @@ type CreateDBInstanceInput struct { // Region. Example: us-east-1d AvailabilityZone *string - // A value that indicates whether to copy tags from the DB instance to snapshots of - // the DB instance. By default, tags are not copied. + // A value that indicates whether to copy tags from the DB instance to snapshots + // of the DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool // A value that indicates whether to enable Performance Insights for the DB - // Instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html). + // Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) + // . EnablePerformanceInsights *bool // The KMS key identifier for encryption of Performance Insights data. The KMS key @@ -87,11 +81,11 @@ type CreateDBInstanceInput struct { // KMS key for each Amazon Web Services region. PerformanceInsightsKMSKeyId *string - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region, occurring on a random day of the week. Valid days: Mon, - // Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. + // The time range each week during which system maintenance can occur, in + // Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default + // is a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Web Services Region, occurring on a random day of the week. Valid days: + // Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string // A value that specifies the order in which an Amazon DocumentDB replica is diff --git a/service/docdb/api_op_CreateDBSubnetGroup.go b/service/docdb/api_op_CreateDBSubnetGroup.go index df9708e3666..77ae601b272 100644 --- a/service/docdb/api_op_CreateDBSubnetGroup.go +++ b/service/docdb/api_op_CreateDBSubnetGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new subnet group. subnet groups must contain at least one subnet in at -// least two Availability Zones in the Amazon Web Services Region. +// Creates a new subnet group. subnet groups must contain at least one subnet in +// at least two Availability Zones in the Amazon Web Services Region. func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnetGroupInput, optFns ...func(*Options)) (*CreateDBSubnetGroupOutput, error) { if params == nil { params = &CreateDBSubnetGroupInput{} @@ -28,7 +28,7 @@ func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnet return out, nil } -// Represents the input to CreateDBSubnetGroup. +// Represents the input to CreateDBSubnetGroup . type CreateDBSubnetGroupInput struct { // The description for the subnet group. diff --git a/service/docdb/api_op_CreateEventSubscription.go b/service/docdb/api_op_CreateEventSubscription.go index 207ee7e925a..40779604e35 100644 --- a/service/docdb/api_op_CreateEventSubscription.go +++ b/service/docdb/api_op_CreateEventSubscription.go @@ -16,18 +16,18 @@ import ( // DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an // ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the // topic. The ARN is displayed in the Amazon SNS console. You can specify the type -// of source (SourceType) that you want to be notified of. You can also provide a -// list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you -// can provide a list of event categories (EventCategories) for events that you -// want to be notified of. For example, you can specify SourceType = db-instance, +// of source ( SourceType ) that you want to be notified of. You can also provide a +// list of Amazon DocumentDB sources ( SourceIds ) that trigger the events, and you +// can provide a list of event categories ( EventCategories ) for events that you +// want to be notified of. For example, you can specify SourceType = db-instance , // SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, -// Backup. If you specify both the SourceType and SourceIds (such as SourceType = -// db-instance and SourceIdentifier = myDBInstance1), you are notified of all the +// Backup . If you specify both the SourceType and SourceIds (such as SourceType = +// db-instance and SourceIdentifier = myDBInstance1 ), you are notified of all the // db-instance events for the specified source. If you specify a SourceType but do -// not specify a SourceIdentifier, you receive notice of the events for that source -// type for all your Amazon DocumentDB sources. If you do not specify either the -// SourceType or the SourceIdentifier, you are notified of events generated from -// all Amazon DocumentDB sources belonging to your customer account. +// not specify a SourceIdentifier , you receive notice of the events for that +// source type for all your Amazon DocumentDB sources. If you do not specify either +// the SourceType or the SourceIdentifier , you are notified of events generated +// from all Amazon DocumentDB sources belonging to your customer account. func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { params = &CreateEventSubscriptionInput{} @@ -43,7 +43,7 @@ func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEven return out, nil } -// Represents the input to CreateEventSubscription. +// Represents the input to CreateEventSubscription . type CreateEventSubscriptionInput struct { // The Amazon Resource Name (ARN) of the SNS topic created for event notification. @@ -69,27 +69,19 @@ type CreateEventSubscriptionInput struct { // not specified, then all sources are included in the response. An identifier must // begin with a letter and must contain only ASCII letters, digits, and hyphens; it // can't end with a hyphen or contain two consecutive hyphens. Constraints: - // - // * If - // SourceIds are provided, SourceType must also be provided. - // - // * If the source type - // is an instance, a DBInstanceIdentifier must be provided. - // - // * If the source type - // is a security group, a DBSecurityGroupName must be provided. - // - // * If the source - // type is a parameter group, a DBParameterGroupName must be provided. - // - // * If the - // source type is a snapshot, a DBSnapshotIdentifier must be provided. + // - If SourceIds are provided, SourceType must also be provided. + // - If the source type is an instance, a DBInstanceIdentifier must be provided. + // - If the source type is a security group, a DBSecurityGroupName must be + // provided. + // - If the source type is a parameter group, a DBParameterGroupName must be + // provided. + // - If the source type is a snapshot, a DBSnapshotIdentifier must be provided. SourceIds []string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by an instance, you would set this parameter to - // db-instance. If this value is not specified, all events are returned. Valid - // values: db-instance, db-cluster, db-parameter-group, db-security-group, + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by an instance, you would set this parameter to + // db-instance . If this value is not specified, all events are returned. Valid + // values: db-instance , db-cluster , db-parameter-group , db-security-group , // db-cluster-snapshot SourceType *string diff --git a/service/docdb/api_op_CreateGlobalCluster.go b/service/docdb/api_op_CreateGlobalCluster.go index 3d6713a3b0c..d072d4dc9a0 100644 --- a/service/docdb/api_op_CreateGlobalCluster.go +++ b/service/docdb/api_op_CreateGlobalCluster.go @@ -35,7 +35,7 @@ func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalCl return out, nil } -// Represents the input to CreateGlobalCluster. +// Represents the input to CreateGlobalCluster . type CreateGlobalClusterInput struct { // The cluster identifier of the new global cluster. diff --git a/service/docdb/api_op_DeleteDBCluster.go b/service/docdb/api_op_DeleteDBCluster.go index 34f711acd4c..35f2219f48b 100644 --- a/service/docdb/api_op_DeleteDBCluster.go +++ b/service/docdb/api_op_DeleteDBCluster.go @@ -29,34 +29,28 @@ func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInp return out, nil } -// Represents the input to DeleteDBCluster. +// Represents the input to DeleteDBCluster . type DeleteDBClusterInput struct { // The cluster identifier for the cluster to be deleted. This parameter isn't case // sensitive. Constraints: - // - // * Must match an existing DBClusterIdentifier. + // - Must match an existing DBClusterIdentifier . // // This member is required. DBClusterIdentifier *string // The cluster snapshot identifier of the new cluster snapshot created when - // SkipFinalSnapshot is set to false. Specifying this parameter and also setting + // SkipFinalSnapshot is set to false . Specifying this parameter and also setting // the SkipFinalShapshot parameter to true results in an error. Constraints: - // - // * - // Must be from 1 to 255 letters, numbers, or hyphens. - // - // * The first character must - // be a letter. - // - // * Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be from 1 to 255 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. FinalDBSnapshotIdentifier *string // Determines whether a final cluster snapshot is created before the cluster is // deleted. If true is specified, no cluster snapshot is created. If false is // specified, a cluster snapshot is created before the DB cluster is deleted. If - // SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier + // SkipFinalSnapshot is false , you must specify a FinalDBSnapshotIdentifier // parameter. Default: false SkipFinalSnapshot bool diff --git a/service/docdb/api_op_DeleteDBClusterParameterGroup.go b/service/docdb/api_op_DeleteDBClusterParameterGroup.go index c63b19e0e03..f67d2d2b09d 100644 --- a/service/docdb/api_op_DeleteDBClusterParameterGroup.go +++ b/service/docdb/api_op_DeleteDBClusterParameterGroup.go @@ -27,18 +27,13 @@ func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *Dele return out, nil } -// Represents the input to DeleteDBClusterParameterGroup. +// Represents the input to DeleteDBClusterParameterGroup . type DeleteDBClusterParameterGroupInput struct { // The name of the cluster parameter group. Constraints: - // - // * Must be the name of an - // existing cluster parameter group. - // - // * You can't delete a default cluster - // parameter group. - // - // * Cannot be associated with any clusters. + // - Must be the name of an existing cluster parameter group. + // - You can't delete a default cluster parameter group. + // - Cannot be associated with any clusters. // // This member is required. DBClusterParameterGroupName *string diff --git a/service/docdb/api_op_DeleteDBClusterSnapshot.go b/service/docdb/api_op_DeleteDBClusterSnapshot.go index b7eb9e14181..0e63a6f6b52 100644 --- a/service/docdb/api_op_DeleteDBClusterSnapshot.go +++ b/service/docdb/api_op_DeleteDBClusterSnapshot.go @@ -29,7 +29,7 @@ func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBCl return out, nil } -// Represents the input to DeleteDBClusterSnapshot. +// Represents the input to DeleteDBClusterSnapshot . type DeleteDBClusterSnapshotInput struct { // The identifier of the cluster snapshot to delete. Constraints: Must be the name diff --git a/service/docdb/api_op_DeleteDBInstance.go b/service/docdb/api_op_DeleteDBInstance.go index 2d8512a3065..2b2ab04d4d7 100644 --- a/service/docdb/api_op_DeleteDBInstance.go +++ b/service/docdb/api_op_DeleteDBInstance.go @@ -27,13 +27,12 @@ func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceI return out, nil } -// Represents the input to DeleteDBInstance. +// Represents the input to DeleteDBInstance . type DeleteDBInstanceInput struct { // The instance identifier for the instance to be deleted. This parameter isn't // case sensitive. Constraints: - // - // * Must match the name of an existing instance. + // - Must match the name of an existing instance. // // This member is required. DBInstanceIdentifier *string diff --git a/service/docdb/api_op_DeleteDBSubnetGroup.go b/service/docdb/api_op_DeleteDBSubnetGroup.go index 406d76aff6c..23470f4b0d2 100644 --- a/service/docdb/api_op_DeleteDBSubnetGroup.go +++ b/service/docdb/api_op_DeleteDBSubnetGroup.go @@ -27,11 +27,11 @@ func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnet return out, nil } -// Represents the input to DeleteDBSubnetGroup. +// Represents the input to DeleteDBSubnetGroup . type DeleteDBSubnetGroupInput struct { // The name of the database subnet group to delete. You can't delete the default - // subnet group. Constraints: Must match the name of an existing DBSubnetGroup. + // subnet group. Constraints: Must match the name of an existing DBSubnetGroup . // Must not be default. Example: mySubnetgroup // // This member is required. diff --git a/service/docdb/api_op_DeleteEventSubscription.go b/service/docdb/api_op_DeleteEventSubscription.go index fba2fb3057d..c1ee3e8889a 100644 --- a/service/docdb/api_op_DeleteEventSubscription.go +++ b/service/docdb/api_op_DeleteEventSubscription.go @@ -27,7 +27,7 @@ func (c *Client) DeleteEventSubscription(ctx context.Context, params *DeleteEven return out, nil } -// Represents the input to DeleteEventSubscription. +// Represents the input to DeleteEventSubscription . type DeleteEventSubscriptionInput struct { // The name of the Amazon DocumentDB event notification subscription that you want diff --git a/service/docdb/api_op_DeleteGlobalCluster.go b/service/docdb/api_op_DeleteGlobalCluster.go index 0805d207604..43f79b9389d 100644 --- a/service/docdb/api_op_DeleteGlobalCluster.go +++ b/service/docdb/api_op_DeleteGlobalCluster.go @@ -29,7 +29,7 @@ func (c *Client) DeleteGlobalCluster(ctx context.Context, params *DeleteGlobalCl return out, nil } -// Represents the input to DeleteGlobalCluster. +// Represents the input to DeleteGlobalCluster . type DeleteGlobalClusterInput struct { // The cluster identifier of the global cluster being deleted. diff --git a/service/docdb/api_op_DescribeCertificates.go b/service/docdb/api_op_DescribeCertificates.go index c02c1b59347..31748b93564 100644 --- a/service/docdb/api_op_DescribeCertificates.go +++ b/service/docdb/api_op_DescribeCertificates.go @@ -35,8 +35,7 @@ type DescribeCertificatesInput struct { // information for only the specified certificate is returned. If this parameter is // omitted, a list of up to MaxRecords certificates is returned. This parameter is // not case sensitive. Constraints - // - // * Must match an existing CertificateIdentifier. + // - Must match an existing CertificateIdentifier . CertificateIdentifier *string // This parameter is not currently supported. @@ -44,17 +43,15 @@ type DescribeCertificatesInput struct { // An optional pagination token provided by a previous DescribeCertificates // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: - // - // * Minimum: 20 - // - // * Maximum: 100 + // - Minimum: 20 + // - Maximum: 100 MaxRecords *int32 noSmithyDocumentSerde @@ -66,7 +63,7 @@ type DescribeCertificatesOutput struct { Certificates []types.Certificate // An optional pagination token provided if the number of records retrieved is - // greater than MaxRecords. If this parameter is specified, the marker specifies + // greater than MaxRecords . If this parameter is specified, the marker specifies // the next record in the list. Including the value of Marker in the next call to // DescribeCertificates results in the next page of certificates. Marker *string @@ -155,10 +152,8 @@ type DescribeCertificatesPaginatorOptions struct { // than the specified MaxRecords value, a pagination token called a marker is // included in the response so that the remaining results can be retrieved. // Default: 100 Constraints: - // - // * Minimum: 20 - // - // * Maximum: 100 + // - Minimum: 20 + // - Maximum: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/docdb/api_op_DescribeDBClusterParameterGroups.go b/service/docdb/api_op_DescribeDBClusterParameterGroups.go index 723a98214d8..2986aac7652 100644 --- a/service/docdb/api_op_DescribeDBClusterParameterGroups.go +++ b/service/docdb/api_op_DescribeDBClusterParameterGroups.go @@ -30,14 +30,12 @@ func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *D return out, nil } -// Represents the input to DescribeDBClusterParameterGroups. +// Represents the input to DescribeDBClusterParameterGroups . type DescribeDBClusterParameterGroupsInput struct { // The name of a specific cluster parameter group to return details for. // Constraints: - // - // * If provided, must match the name of an existing - // DBClusterParameterGroup. + // - If provided, must match the name of an existing DBClusterParameterGroup . DBClusterParameterGroupName *string // This parameter is not currently supported. @@ -45,7 +43,7 @@ type DescribeDBClusterParameterGroupsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -57,7 +55,7 @@ type DescribeDBClusterParameterGroupsInput struct { noSmithyDocumentSerde } -// Represents the output of DBClusterParameterGroups. +// Represents the output of DBClusterParameterGroups . type DescribeDBClusterParameterGroupsOutput struct { // A list of cluster parameter groups. @@ -65,7 +63,7 @@ type DescribeDBClusterParameterGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeDBClusterParameters.go b/service/docdb/api_op_DescribeDBClusterParameters.go index accdde32b1a..93162cd57f5 100644 --- a/service/docdb/api_op_DescribeDBClusterParameters.go +++ b/service/docdb/api_op_DescribeDBClusterParameters.go @@ -28,14 +28,12 @@ func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *Descri return out, nil } -// Represents the input to DescribeDBClusterParameters. +// Represents the input to DescribeDBClusterParameters . type DescribeDBClusterParametersInput struct { // The name of a specific cluster parameter group to return parameter details for. // Constraints: - // - // * If provided, must match the name of an existing - // DBClusterParameterGroup. + // - If provided, must match the name of an existing DBClusterParameterGroup . // // This member is required. DBClusterParameterGroupName *string @@ -45,7 +43,7 @@ type DescribeDBClusterParametersInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -55,18 +53,18 @@ type DescribeDBClusterParametersInput struct { MaxRecords *int32 // A value that indicates to return only parameters for a specific source. - // Parameter sources can be engine, service, or customer. + // Parameter sources can be engine , service , or customer . Source *string noSmithyDocumentSerde } -// Represents the output of DBClusterParameterGroup. +// Represents the output of DBClusterParameterGroup . type DescribeDBClusterParametersOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Provides a list of parameters for the cluster parameter group. diff --git a/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go b/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go index ef00fc79d27..737130f2b60 100644 --- a/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go @@ -15,9 +15,9 @@ import ( // cluster snapshot. When you share snapshots with other Amazon Web Services // accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and // a list of IDs for the Amazon Web Services accounts that are authorized to copy -// or restore the manual cluster snapshot. If all is included in the list of values -// for the restore attribute, then the manual cluster snapshot is public and can be -// copied or restored by all Amazon Web Services accounts. +// or restore the manual cluster snapshot. If all is included in the list of +// values for the restore attribute, then the manual cluster snapshot is public +// and can be copied or restored by all Amazon Web Services accounts. func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotAttributesInput{} @@ -33,7 +33,7 @@ func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params return out, nil } -// Represents the input to DescribeDBClusterSnapshotAttributes. +// Represents the input to DescribeDBClusterSnapshotAttributes . type DescribeDBClusterSnapshotAttributesInput struct { // The identifier for the cluster snapshot to describe the attributes for. diff --git a/service/docdb/api_op_DescribeDBClusterSnapshots.go b/service/docdb/api_op_DescribeDBClusterSnapshots.go index a38197472de..a79785bb42d 100644 --- a/service/docdb/api_op_DescribeDBClusterSnapshots.go +++ b/service/docdb/api_op_DescribeDBClusterSnapshots.go @@ -29,44 +29,39 @@ func (c *Client) DescribeDBClusterSnapshots(ctx context.Context, params *Describ return out, nil } -// Represents the input to DescribeDBClusterSnapshots. +// Represents the input to DescribeDBClusterSnapshots . type DescribeDBClusterSnapshotsInput struct { // The ID of the cluster to retrieve the list of cluster snapshots for. This // parameter can't be used with the DBClusterSnapshotIdentifier parameter. This // parameter is not case sensitive. Constraints: - // - // * If provided, must match the - // identifier of an existing DBCluster. + // - If provided, must match the identifier of an existing DBCluster . DBClusterIdentifier *string - // A specific cluster snapshot identifier to describe. This parameter can't be used - // with the DBClusterIdentifier parameter. This value is stored as a lowercase - // string. Constraints: - // - // * If provided, must match the identifier of an existing - // DBClusterSnapshot. - // - // * If this identifier is for an automated snapshot, the - // SnapshotType parameter must also be specified. + // A specific cluster snapshot identifier to describe. This parameter can't be + // used with the DBClusterIdentifier parameter. This value is stored as a + // lowercase string. Constraints: + // - If provided, must match the identifier of an existing DBClusterSnapshot . + // - If this identifier is for an automated snapshot, the SnapshotType parameter + // must also be specified. DBClusterSnapshotIdentifier *string // This parameter is not currently supported. Filters []types.Filter // Set to true to include manual cluster snapshots that are public and can be - // copied or restored by any Amazon Web Services account, and otherwise false. The - // default is false. + // copied or restored by any Amazon Web Services account, and otherwise false . The + // default is false . IncludePublic bool // Set to true to include shared manual cluster snapshots from other Amazon Web // Services accounts that this Amazon Web Services account has been given - // permission to copy or restore, and otherwise false. The default is false. + // permission to copy or restore, and otherwise false . The default is false . IncludeShared bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -77,35 +72,27 @@ type DescribeDBClusterSnapshotsInput struct { // The type of cluster snapshots to be returned. You can specify one of the // following values: - // - // * automated - Return all cluster snapshots that Amazon - // DocumentDB has automatically created for your Amazon Web Services account. - // - // * - // manual - Return all cluster snapshots that you have manually created for your - // Amazon Web Services account. - // - // * shared - Return all manual cluster snapshots - // that have been shared to your Amazon Web Services account. - // - // * public - Return - // all cluster snapshots that have been marked as public. - // - // If you don't specify a - // SnapshotType value, then both automated and manual cluster snapshots are - // returned. You can include shared cluster snapshots with these results by setting - // the IncludeShared parameter to true. You can include public cluster snapshots - // with these results by setting theIncludePublic parameter to true. The - // IncludeShared and IncludePublic parameters don't apply for SnapshotType values - // of manual or automated. The IncludePublic parameter doesn't apply when - // SnapshotType is set to shared. The IncludeShared parameter doesn't apply when - // SnapshotType is set to public. + // - automated - Return all cluster snapshots that Amazon DocumentDB has + // automatically created for your Amazon Web Services account. + // - manual - Return all cluster snapshots that you have manually created for + // your Amazon Web Services account. + // - shared - Return all manual cluster snapshots that have been shared to your + // Amazon Web Services account. + // - public - Return all cluster snapshots that have been marked as public. + // If you don't specify a SnapshotType value, then both automated and manual + // cluster snapshots are returned. You can include shared cluster snapshots with + // these results by setting the IncludeShared parameter to true . You can include + // public cluster snapshots with these results by setting the IncludePublic + // parameter to true . The IncludeShared and IncludePublic parameters don't apply + // for SnapshotType values of manual or automated . The IncludePublic parameter + // doesn't apply when SnapshotType is set to shared . The IncludeShared parameter + // doesn't apply when SnapshotType is set to public . SnapshotType *string noSmithyDocumentSerde } -// Represents the output of DescribeDBClusterSnapshots. +// Represents the output of DescribeDBClusterSnapshots . type DescribeDBClusterSnapshotsOutput struct { // Provides a list of cluster snapshots. @@ -113,7 +100,7 @@ type DescribeDBClusterSnapshotsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeDBClusters.go b/service/docdb/api_op_DescribeDBClusters.go index fedabb57d2d..2d5f84faa9a 100644 --- a/service/docdb/api_op_DescribeDBClusters.go +++ b/service/docdb/api_op_DescribeDBClusters.go @@ -33,28 +33,24 @@ func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClust return out, nil } -// Represents the input to DescribeDBClusters. +// Represents the input to DescribeDBClusters . type DescribeDBClustersInput struct { // The user-provided cluster identifier. If this parameter is specified, // information from only the specific cluster is returned. This parameter isn't // case sensitive. Constraints: - // - // * If provided, must match an existing - // DBClusterIdentifier. + // - If provided, must match an existing DBClusterIdentifier . DBClusterIdentifier *string // A filter that specifies one or more clusters to describe. Supported filters: - // - // * - // db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names - // (ARNs). The results list only includes information about the clusters identified - // by these ARNs. + // - db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource + // Names (ARNs). The results list only includes information about the clusters + // identified by these ARNs. Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -66,7 +62,7 @@ type DescribeDBClustersInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeDBClusters. +// Represents the output of DescribeDBClusters . type DescribeDBClustersOutput struct { // A list of clusters. @@ -74,7 +70,7 @@ type DescribeDBClustersOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeDBEngineVersions.go b/service/docdb/api_op_DescribeDBEngineVersions.go index 81bdaf0731c..fcb2fb2fcc0 100644 --- a/service/docdb/api_op_DescribeDBEngineVersions.go +++ b/service/docdb/api_op_DescribeDBEngineVersions.go @@ -28,13 +28,12 @@ func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeD return out, nil } -// Represents the input to DescribeDBEngineVersions. +// Represents the input to DescribeDBEngineVersions . type DescribeDBEngineVersionsInput struct { // The name of a specific parameter group family to return details for. // Constraints: - // - // * If provided, must match an existing DBParameterGroupFamily. + // - If provided, must match an existing DBParameterGroupFamily . DBParameterGroupFamily *string // Indicates that only the default version of the specified engine or engine and @@ -51,18 +50,18 @@ type DescribeDBEngineVersionsInput struct { Filters []types.Filter // If this parameter is specified and the requested engine supports the - // CharacterSetName parameter for CreateDBInstance, the response includes a list of - // supported character sets for each engine version. + // CharacterSetName parameter for CreateDBInstance , the response includes a list + // of supported character sets for each engine version. ListSupportedCharacterSets *bool // If this parameter is specified and the requested engine supports the TimeZone - // parameter for CreateDBInstance, the response includes a list of supported time + // parameter for CreateDBInstance , the response includes a list of supported time // zones for each engine version. ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -74,7 +73,7 @@ type DescribeDBEngineVersionsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeDBEngineVersions. +// Represents the output of DescribeDBEngineVersions . type DescribeDBEngineVersionsOutput struct { // Detailed information about one or more engine versions. @@ -82,7 +81,7 @@ type DescribeDBEngineVersionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeDBInstances.go b/service/docdb/api_op_DescribeDBInstances.go index 711462cf0f3..2207ce276e1 100644 --- a/service/docdb/api_op_DescribeDBInstances.go +++ b/service/docdb/api_op_DescribeDBInstances.go @@ -35,33 +35,27 @@ func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInst return out, nil } -// Represents the input to DescribeDBInstances. +// Represents the input to DescribeDBInstances . type DescribeDBInstancesInput struct { // The user-provided instance identifier. If this parameter is specified, // information from only the specific instance is returned. This parameter isn't // case sensitive. Constraints: - // - // * If provided, must match the identifier of an - // existing DBInstance. + // - If provided, must match the identifier of an existing DBInstance . DBInstanceIdentifier *string // A filter that specifies one or more instances to describe. Supported filters: - // - // * - // db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names - // (ARNs). The results list includes only the information about the instances that - // are associated with the clusters that are identified by these ARNs. - // - // * - // db-instance-id - Accepts instance identifiers and instance ARNs. The results - // list includes only the information about the instances that are identified by - // these ARNs. + // - db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource + // Names (ARNs). The results list includes only the information about the instances + // that are associated with the clusters that are identified by these ARNs. + // - db-instance-id - Accepts instance identifiers and instance ARNs. The results + // list includes only the information about the instances that are identified by + // these ARNs. Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -73,7 +67,7 @@ type DescribeDBInstancesInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeDBInstances. +// Represents the output of DescribeDBInstances . type DescribeDBInstancesOutput struct { // Detailed information about one or more instances. @@ -81,7 +75,7 @@ type DescribeDBInstancesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -153,8 +147,8 @@ func (c *Client) addOperationDescribeDBInstancesMiddlewares(stack *middleware.St return nil } -// DescribeDBInstancesAPIClient is a client that implements the DescribeDBInstances -// operation. +// DescribeDBInstancesAPIClient is a client that implements the +// DescribeDBInstances operation. type DescribeDBInstancesAPIClient interface { DescribeDBInstances(context.Context, *DescribeDBInstancesInput, ...func(*Options)) (*DescribeDBInstancesOutput, error) } @@ -261,9 +255,10 @@ type DBInstanceAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -303,9 +298,9 @@ func NewDBInstanceAvailableWaiter(client DescribeDBInstancesAPIClient, optFns .. } } -// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *DBInstanceAvailableWaiter) Wait(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -556,9 +551,9 @@ type DBInstanceDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -606,10 +601,10 @@ func (w *DBInstanceDeletedWaiter) Wait(ctx context.Context, params *DescribeDBIn return err } -// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *DBInstanceDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceDeletedWaiterOptions)) (*DescribeDBInstancesOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/docdb/api_op_DescribeDBSubnetGroups.go b/service/docdb/api_op_DescribeDBSubnetGroups.go index 45922fc3a82..d6e68fa6f48 100644 --- a/service/docdb/api_op_DescribeDBSubnetGroups.go +++ b/service/docdb/api_op_DescribeDBSubnetGroups.go @@ -14,7 +14,7 @@ import ( // Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is // specified, the list will contain only the descriptions of the specified -// DBSubnetGroup. +// DBSubnetGroup . func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBSubnetGroupsInput, optFns ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error) { if params == nil { params = &DescribeDBSubnetGroupsInput{} @@ -30,7 +30,7 @@ func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBS return out, nil } -// Represents the input to DescribeDBSubnetGroups. +// Represents the input to DescribeDBSubnetGroups . type DescribeDBSubnetGroupsInput struct { // The name of the subnet group to return details for. @@ -41,7 +41,7 @@ type DescribeDBSubnetGroupsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -53,7 +53,7 @@ type DescribeDBSubnetGroupsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeDBSubnetGroups. +// Represents the output of DescribeDBSubnetGroups . type DescribeDBSubnetGroupsOutput struct { // Detailed information about one or more subnet groups. @@ -61,7 +61,7 @@ type DescribeDBSubnetGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go b/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go index 8d6cc07d8a8..73133896a12 100644 --- a/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go @@ -28,7 +28,7 @@ func (c *Client) DescribeEngineDefaultClusterParameters(ctx context.Context, par return out, nil } -// Represents the input to DescribeEngineDefaultClusterParameters. +// Represents the input to DescribeEngineDefaultClusterParameters . type DescribeEngineDefaultClusterParametersInput struct { // The name of the cluster parameter group family to return the engine parameter @@ -42,7 +42,7 @@ type DescribeEngineDefaultClusterParametersInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/docdb/api_op_DescribeEventCategories.go b/service/docdb/api_op_DescribeEventCategories.go index 7d252e2d484..3a64270b624 100644 --- a/service/docdb/api_op_DescribeEventCategories.go +++ b/service/docdb/api_op_DescribeEventCategories.go @@ -28,20 +28,20 @@ func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEv return out, nil } -// Represents the input to DescribeEventCategories. +// Represents the input to DescribeEventCategories . type DescribeEventCategoriesInput struct { // This parameter is not currently supported. Filters []types.Filter - // The type of source that is generating the events. Valid values: db-instance, - // db-parameter-group, db-security-group + // The type of source that is generating the events. Valid values: db-instance , + // db-parameter-group , db-security-group SourceType *string noSmithyDocumentSerde } -// Represents the output of DescribeEventCategories. +// Represents the output of DescribeEventCategories . type DescribeEventCategoriesOutput struct { // A list of event category maps. diff --git a/service/docdb/api_op_DescribeEventSubscriptions.go b/service/docdb/api_op_DescribeEventSubscriptions.go index a37a50ed851..ae29520877f 100644 --- a/service/docdb/api_op_DescribeEventSubscriptions.go +++ b/service/docdb/api_op_DescribeEventSubscriptions.go @@ -13,9 +13,9 @@ import ( ) // Lists all the subscription descriptions for a customer account. The description -// for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, -// SourceType, SourceID, CreationTime, and Status. If you specify a -// SubscriptionName, lists the description for that subscription. +// for a subscription includes SubscriptionName , SNSTopicARN , CustomerID , +// SourceType , SourceID , CreationTime , and Status . If you specify a +// SubscriptionName , lists the description for that subscription. func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error) { if params == nil { params = &DescribeEventSubscriptionsInput{} @@ -31,7 +31,7 @@ func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *Describ return out, nil } -// Represents the input to DescribeEventSubscriptions. +// Represents the input to DescribeEventSubscriptions . type DescribeEventSubscriptionsInput struct { // This parameter is not currently supported. @@ -39,7 +39,7 @@ type DescribeEventSubscriptionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -55,7 +55,7 @@ type DescribeEventSubscriptionsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeEventSubscriptions. +// Represents the output of DescribeEventSubscriptions . type DescribeEventSubscriptionsOutput struct { // A list of event subscriptions. @@ -63,7 +63,7 @@ type DescribeEventSubscriptionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeEvents.go b/service/docdb/api_op_DescribeEvents.go index b0c79dce32a..c84583d2513 100644 --- a/service/docdb/api_op_DescribeEvents.go +++ b/service/docdb/api_op_DescribeEvents.go @@ -33,14 +33,14 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput return out, nil } -// Represents the input to DescribeEvents. +// Represents the input to DescribeEvents . type DescribeEventsInput struct { // The number of minutes to retrieve events for. Default: 60 Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. Example: 2009-07-08T18:00Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. Example: 2009-07-08T18:00Z EndTime *time.Time // A list of event categories that trigger notifications for an event notification @@ -52,7 +52,7 @@ type DescribeEventsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -63,38 +63,28 @@ type DescribeEventsInput struct { // The identifier of the event source for which events are returned. If not // specified, then all sources are included in the response. Constraints: - // - // * If - // SourceIdentifier is provided, SourceType must also be provided. - // - // * If the source - // type is DBInstance, a DBInstanceIdentifier must be provided. - // - // * If the source - // type is DBSecurityGroup, a DBSecurityGroupName must be provided. - // - // * If the - // source type is DBParameterGroup, a DBParameterGroupName must be provided. - // - // * If - // the source type is DBSnapshot, a DBSnapshotIdentifier must be provided. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. + // - If SourceIdentifier is provided, SourceType must also be provided. + // - If the source type is DBInstance , a DBInstanceIdentifier must be provided. + // - If the source type is DBSecurityGroup , a DBSecurityGroupName must be + // provided. + // - If the source type is DBParameterGroup , a DBParameterGroupName must be + // provided. + // - If the source type is DBSnapshot , a DBSnapshotIdentifier must be provided. + // - Cannot end with a hyphen or contain two consecutive hyphens. SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. Example: 2009-07-08T18:00Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. Example: 2009-07-08T18:00Z StartTime *time.Time noSmithyDocumentSerde } -// Represents the output of DescribeEvents. +// Represents the output of DescribeEvents . type DescribeEventsOutput struct { // Detailed information about one or more events. @@ -102,7 +92,7 @@ type DescribeEventsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_DescribeGlobalClusters.go b/service/docdb/api_op_DescribeGlobalClusters.go index 790be13c7a4..bb0a5f351e9 100644 --- a/service/docdb/api_op_DescribeGlobalClusters.go +++ b/service/docdb/api_op_DescribeGlobalClusters.go @@ -44,7 +44,7 @@ type DescribeGlobalClustersInput struct { // An optional pagination token provided by a previous DescribeGlobalClusters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go index c429aa64bb7..3b91b201551 100644 --- a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go @@ -28,7 +28,7 @@ func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params return out, nil } -// Represents the input to DescribeOrderableDBInstanceOptions. +// Represents the input to DescribeOrderableDBInstanceOptions . type DescribeOrderableDBInstanceOptionsInput struct { // The name of the engine to retrieve instance options for. @@ -53,7 +53,7 @@ type DescribeOrderableDBInstanceOptionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -69,12 +69,12 @@ type DescribeOrderableDBInstanceOptionsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeOrderableDBInstanceOptions. +// Represents the output of DescribeOrderableDBInstanceOptions . type DescribeOrderableDBInstanceOptionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The options that are available for a particular orderable instance. diff --git a/service/docdb/api_op_DescribePendingMaintenanceActions.go b/service/docdb/api_op_DescribePendingMaintenanceActions.go index 7745a341e10..a3d39d97ff9 100644 --- a/service/docdb/api_op_DescribePendingMaintenanceActions.go +++ b/service/docdb/api_op_DescribePendingMaintenanceActions.go @@ -29,24 +29,22 @@ func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params * return out, nil } -// Represents the input to DescribePendingMaintenanceActions. +// Represents the input to DescribePendingMaintenanceActions . type DescribePendingMaintenanceActionsInput struct { // A filter that specifies one or more resources to return pending maintenance // actions for. Supported filters: - // - // * db-cluster-id - Accepts cluster identifiers - // and cluster Amazon Resource Names (ARNs). The results list includes only pending - // maintenance actions for the clusters identified by these ARNs. - // - // * db-instance-id - // - Accepts instance identifiers and instance ARNs. The results list includes only - // pending maintenance actions for the DB instances identified by these ARNs. + // - db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource + // Names (ARNs). The results list includes only pending maintenance actions for the + // clusters identified by these ARNs. + // - db-instance-id - Accepts instance identifiers and instance ARNs. The results + // list includes only pending maintenance actions for the DB instances identified + // by these ARNs. Filters []types.Filter // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -61,12 +59,12 @@ type DescribePendingMaintenanceActionsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribePendingMaintenanceActions. +// Represents the output of DescribePendingMaintenanceActions . type DescribePendingMaintenanceActionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maintenance actions to be applied. diff --git a/service/docdb/api_op_FailoverDBCluster.go b/service/docdb/api_op_FailoverDBCluster.go index 4b0dcba54a2..b4acf05ed3e 100644 --- a/service/docdb/api_op_FailoverDBCluster.go +++ b/service/docdb/api_op_FailoverDBCluster.go @@ -32,18 +32,17 @@ func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBCluste return out, nil } -// Represents the input to FailoverDBCluster. +// Represents the input to FailoverDBCluster . type FailoverDBClusterInput struct { // A cluster identifier to force a failover for. This parameter is not case // sensitive. Constraints: - // - // * Must match the identifier of an existing DBCluster. + // - Must match the identifier of an existing DBCluster . DBClusterIdentifier *string // The name of the instance to promote to the primary instance. You must specify // the instance identifier for an Amazon DocumentDB replica in the cluster. For - // example, mydbcluster-replica1. + // example, mydbcluster-replica1 . TargetDBInstanceIdentifier *string noSmithyDocumentSerde diff --git a/service/docdb/api_op_ListTagsForResource.go b/service/docdb/api_op_ListTagsForResource.go index 4852c0779fa..8d10a2680d8 100644 --- a/service/docdb/api_op_ListTagsForResource.go +++ b/service/docdb/api_op_ListTagsForResource.go @@ -27,7 +27,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes return out, nil } -// Represents the input to ListTagsForResource. +// Represents the input to ListTagsForResource . type ListTagsForResourceInput struct { // The Amazon DocumentDB resource with tags to be listed. This value is an Amazon @@ -42,7 +42,7 @@ type ListTagsForResourceInput struct { noSmithyDocumentSerde } -// Represents the output of ListTagsForResource. +// Represents the output of ListTagsForResource . type ListTagsForResourceOutput struct { // A list of one or more tags. diff --git a/service/docdb/api_op_ModifyDBCluster.go b/service/docdb/api_op_ModifyDBCluster.go index 4f916b82ad5..56267668018 100644 --- a/service/docdb/api_op_ModifyDBCluster.go +++ b/service/docdb/api_op_ModifyDBCluster.go @@ -29,14 +29,12 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp return out, nil } -// Represents the input to ModifyDBCluster. +// Represents the input to ModifyDBCluster . type ModifyDBClusterInput struct { - // The cluster identifier for the cluster that is being modified. This parameter is - // not case sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. + // The cluster identifier for the cluster that is being modified. This parameter + // is not case sensitive. Constraints: + // - Must match the identifier of an existing DBCluster . // // This member is required. DBClusterIdentifier *string @@ -44,18 +42,17 @@ type ModifyDBClusterInput struct { // A value that specifies whether the changes in this request and any pending // changes are asynchronously applied as soon as possible, regardless of the // PreferredMaintenanceWindow setting for the cluster. If this parameter is set to - // false, changes to the cluster are applied during the next maintenance window. + // false , changes to the cluster are applied during the next maintenance window. // The ApplyImmediately parameter affects only the NewDBClusterIdentifier and - // MasterUserPassword values. If you set this parameter value to false, the changes - // to the NewDBClusterIdentifier and MasterUserPassword values are applied during - // the next maintenance window. All other changes are applied immediately, + // MasterUserPassword values. If you set this parameter value to false , the + // changes to the NewDBClusterIdentifier and MasterUserPassword values are applied + // during the next maintenance window. All other changes are applied immediately, // regardless of the value of the ApplyImmediately parameter. Default: false ApplyImmediately bool // The number of days for which automated backups are retained. You must specify a // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35. + // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The configuration setting for the log types to be enabled for export to Amazon @@ -67,9 +64,10 @@ type ModifyDBClusterInput struct { // The name of the cluster parameter group to use for the cluster. DBClusterParameterGroupName *string - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. + // Specifies whether this cluster can be deleted. If DeletionProtection is + // enabled, the cluster cannot be deleted unless it is modified and + // DeletionProtection is disabled. DeletionProtection protects clusters from being + // accidentally deleted. DeletionProtection *bool // The version number of the database engine to which you want to upgrade. @@ -83,36 +81,24 @@ type ModifyDBClusterInput struct { // The new cluster identifier for the cluster when renaming a cluster. This value // is stored as a lowercase string. Constraints: - // - // * Must contain from 1 to 63 - // letters, numbers, or hyphens. - // - // * The first character must be a letter. - // - // * Cannot - // end with a hyphen or contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster2 NewDBClusterIdentifier *string - // The port number on which the cluster accepts connections. Constraints: Must be a - // value from 1150 to 65535. Default: The same port as the original cluster. + // The port number on which the cluster accepts connections. Constraints: Must be + // a value from 1150 to 65535 . Default: The same port as the original cluster. Port *int32 // The daily time range during which automated backups are created if automated - // backups are enabled, using the BackupRetentionPeriod parameter. The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. Constraints: - // - // * Must be in the format hh24:mi-hh24:mi. - // - // * - // Must be in Universal Coordinated Time (UTC). - // - // * Must not conflict with the - // preferred maintenance window. - // - // * Must be at least 30 minutes. + // backups are enabled, using the BackupRetentionPeriod parameter. The default is + // a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Web Services Region. Constraints: + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal diff --git a/service/docdb/api_op_ModifyDBClusterParameterGroup.go b/service/docdb/api_op_ModifyDBClusterParameterGroup.go index 8105e51f945..884baf6b61f 100644 --- a/service/docdb/api_op_ModifyDBClusterParameterGroup.go +++ b/service/docdb/api_op_ModifyDBClusterParameterGroup.go @@ -12,8 +12,8 @@ import ( ) // Modifies the parameters of a cluster parameter group. To modify more than one -// parameter, submit a list of the following: ParameterName, ParameterValue, and -// ApplyMethod. A maximum of 20 parameters can be modified in a single request. +// parameter, submit a list of the following: ParameterName , ParameterValue , and +// ApplyMethod . A maximum of 20 parameters can be modified in a single request. // Changes to dynamic parameters are applied immediately. Changes to static // parameters require a reboot or maintenance window before the change can take // effect. After you create a cluster parameter group, you should wait at least 5 @@ -38,7 +38,7 @@ func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *Modi return out, nil } -// Represents the input to ModifyDBClusterParameterGroup. +// Represents the input to ModifyDBClusterParameterGroup . type ModifyDBClusterParameterGroupInput struct { // The name of the cluster parameter group to modify. @@ -58,17 +58,10 @@ type ModifyDBClusterParameterGroupInput struct { type ModifyDBClusterParameterGroupOutput struct { // The name of a cluster parameter group. Constraints: - // - // * Must be from 1 to 255 - // letters or numbers. - // - // * The first character must be a letter. - // - // * Cannot end with - // a hyphen or contain two consecutive hyphens. - // - // This value is stored as a - // lowercase string. + // - Must be from 1 to 255 letters or numbers. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go index e30b18a98b8..066b76bab93 100644 --- a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go @@ -13,10 +13,10 @@ import ( // Adds an attribute and values to, or removes an attribute and values from, a // manual cluster snapshot. To share a manual cluster snapshot with other Amazon -// Web Services accounts, specify restore as the AttributeName, and use the +// Web Services accounts, specify restore as the AttributeName , and use the // ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts -// that are authorized to restore the manual cluster snapshot. Use the value all to -// make the manual cluster snapshot public, which means that it can be copied or +// that are authorized to restore the manual cluster snapshot. Use the value all +// to make the manual cluster snapshot public, which means that it can be copied or // restored by all Amazon Web Services accounts. Do not add the all value for any // manual cluster snapshots that contain private information that you don't want // available to all Amazon Web Services accounts. If a manual cluster snapshot is @@ -38,12 +38,12 @@ func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *M return out, nil } -// Represents the input to ModifyDBClusterSnapshotAttribute. +// Represents the input to ModifyDBClusterSnapshotAttribute . type ModifyDBClusterSnapshotAttributeInput struct { // The name of the cluster snapshot attribute to modify. To manage authorization // for other Amazon Web Services accounts to copy or restore a manual cluster - // snapshot, set this value to restore. + // snapshot, set this value to restore . // // This member is required. AttributeName *string @@ -54,22 +54,22 @@ type ModifyDBClusterSnapshotAttributeInput struct { DBClusterSnapshotIdentifier *string // A list of cluster snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other Amazon Web Services accounts to copy or + // AttributeName . To authorize other Amazon Web Services accounts to copy or // restore a manual cluster snapshot, set this list to include one or more Amazon // Web Services account IDs. To make the manual cluster snapshot restorable by any - // Amazon Web Services account, set it to all. Do not add the all value for any + // Amazon Web Services account, set it to all . Do not add the all value for any // manual cluster snapshots that contain private information that you don't want to // be available to all Amazon Web Services accounts. ValuesToAdd []string // A list of cluster snapshot attributes to remove from the attribute specified by - // AttributeName. To remove authorization for other Amazon Web Services accounts to - // copy or restore a manual cluster snapshot, set this list to include one or more - // Amazon Web Services account identifiers. To remove authorization for any Amazon - // Web Services account to copy or restore the cluster snapshot, set it to all . If - // you specify all, an Amazon Web Services account whose account ID is explicitly - // added to the restore attribute can still copy or restore a manual cluster - // snapshot. + // AttributeName . To remove authorization for other Amazon Web Services accounts + // to copy or restore a manual cluster snapshot, set this list to include one or + // more Amazon Web Services account identifiers. To remove authorization for any + // Amazon Web Services account to copy or restore the cluster snapshot, set it to + // all . If you specify all , an Amazon Web Services account whose account ID is + // explicitly added to the restore attribute can still copy or restore a manual + // cluster snapshot. ValuesToRemove []string noSmithyDocumentSerde diff --git a/service/docdb/api_op_ModifyDBInstance.go b/service/docdb/api_op_ModifyDBInstance.go index 7385e9083f3..8657d1bc170 100644 --- a/service/docdb/api_op_ModifyDBInstance.go +++ b/service/docdb/api_op_ModifyDBInstance.go @@ -29,13 +29,12 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI return out, nil } -// Represents the input to ModifyDBInstance. +// Represents the input to ModifyDBInstance . type ModifyDBInstanceInput struct { // The instance identifier. This value is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance . // // This member is required. DBInstanceIdentifier *string @@ -43,7 +42,7 @@ type ModifyDBInstanceInput struct { // Specifies whether the modifications in this request and any pending // modifications are asynchronously applied as soon as possible, regardless of the // PreferredMaintenanceWindow setting for the instance. If this parameter is set to - // false, changes to the instance are applied during the next maintenance window. + // false , changes to the instance are applied during the next maintenance window. // Some parameter changes can cause an outage and are applied on the next reboot. // Default: false ApplyImmediately bool @@ -59,32 +58,26 @@ type ModifyDBInstanceInput struct { // snapshots of the DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool - // The new compute and memory capacity of the instance; for example, db.r5.large. + // The new compute and memory capacity of the instance; for example, db.r5.large . // Not all instance classes are available in all Amazon Web Services Regions. If // you modify the instance class, an outage occurs during the change. The change is - // applied during the next maintenance window, unless ApplyImmediately is specified - // as true for this request. Default: Uses existing setting. + // applied during the next maintenance window, unless ApplyImmediately is + // specified as true for this request. Default: Uses existing setting. DBInstanceClass *string // A value that indicates whether to enable Performance Insights for the DB - // Instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html). + // Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) + // . EnablePerformanceInsights *bool - // The new instance identifier for the instance when renaming an instance. When you - // change the instance identifier, an instance reboot occurs immediately if you set - // Apply Immediately to true. It occurs during the next maintenance window if you - // set Apply Immediately to false. This value is stored as a lowercase string. + // The new instance identifier for the instance when renaming an instance. When + // you change the instance identifier, an instance reboot occurs immediately if you + // set Apply Immediately to true . It occurs during the next maintenance window if + // you set Apply Immediately to false . This value is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * The - // first character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance NewDBInstanceIdentifier *string diff --git a/service/docdb/api_op_ModifyDBSubnetGroup.go b/service/docdb/api_op_ModifyDBSubnetGroup.go index ea411e7393b..7b905f32bb7 100644 --- a/service/docdb/api_op_ModifyDBSubnetGroup.go +++ b/service/docdb/api_op_ModifyDBSubnetGroup.go @@ -28,12 +28,12 @@ func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnet return out, nil } -// Represents the input to ModifyDBSubnetGroup. +// Represents the input to ModifyDBSubnetGroup . type ModifyDBSubnetGroupInput struct { // The name for the subnet group. This value is stored as a lowercase string. You // can't modify the default subnet group. Constraints: Must match the name of an - // existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + // existing DBSubnetGroup . Must not be default. Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string diff --git a/service/docdb/api_op_ModifyEventSubscription.go b/service/docdb/api_op_ModifyEventSubscription.go index 111a650504a..d2ecc49786b 100644 --- a/service/docdb/api_op_ModifyEventSubscription.go +++ b/service/docdb/api_op_ModifyEventSubscription.go @@ -27,7 +27,7 @@ func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEven return out, nil } -// Represents the input to ModifyEventSubscription. +// Represents the input to ModifyEventSubscription . type ModifyEventSubscriptionInput struct { // The name of the Amazon DocumentDB event notification subscription. @@ -45,10 +45,10 @@ type ModifyEventSubscriptionInput struct { // The ARN is created by Amazon SNS when you create a topic and subscribe to it. SnsTopicArn *string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by an instance, set this parameter to db-instance. - // If this value is not specified, all events are returned. Valid values: - // db-instance, db-parameter-group, db-security-group + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by an instance, set this parameter to + // db-instance . If this value is not specified, all events are returned. Valid + // values: db-instance , db-parameter-group , db-security-group SourceType *string noSmithyDocumentSerde diff --git a/service/docdb/api_op_ModifyGlobalCluster.go b/service/docdb/api_op_ModifyGlobalCluster.go index 25905b9aa70..d4a25b8f795 100644 --- a/service/docdb/api_op_ModifyGlobalCluster.go +++ b/service/docdb/api_op_ModifyGlobalCluster.go @@ -30,14 +30,12 @@ func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalCl return out, nil } -// Represents the input to ModifyGlobalCluster. +// Represents the input to ModifyGlobalCluster . type ModifyGlobalClusterInput struct { // The identifier for the global cluster being modified. This parameter isn't // case-sensitive. Constraints: - // - // * Must match the identifier of an existing global - // cluster. + // - Must match the identifier of an existing global cluster. // // This member is required. GlobalClusterIdentifier *string @@ -48,11 +46,8 @@ type ModifyGlobalClusterInput struct { // The new identifier for a global cluster when you modify a global cluster. This // value is stored as a lowercase string. - // - // * Must contain from 1 to 63 letters, - // numbers, or hyphens The first character must be a letter Can't end with a hyphen - // or contain two consecutive hyphens - // + // - Must contain from 1 to 63 letters, numbers, or hyphens The first character + // must be a letter Can't end with a hyphen or contain two consecutive hyphens // Example: my-cluster2 NewGlobalClusterIdentifier *string diff --git a/service/docdb/api_op_RebootDBInstance.go b/service/docdb/api_op_RebootDBInstance.go index 028dbdfcc54..60cff885567 100644 --- a/service/docdb/api_op_RebootDBInstance.go +++ b/service/docdb/api_op_RebootDBInstance.go @@ -32,18 +32,17 @@ func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceI return out, nil } -// Represents the input to RebootDBInstance. +// Represents the input to RebootDBInstance . type RebootDBInstanceInput struct { // The instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance . // // This member is required. DBInstanceIdentifier *string - // When true, the reboot is conducted through a Multi-AZ failover. Constraint: You + // When true , the reboot is conducted through a Multi-AZ failover. Constraint: You // can't specify true if the instance is not configured for Multi-AZ. ForceFailover *bool diff --git a/service/docdb/api_op_RemoveFromGlobalCluster.go b/service/docdb/api_op_RemoveFromGlobalCluster.go index 7c2249ae542..4fce3b2d8e1 100644 --- a/service/docdb/api_op_RemoveFromGlobalCluster.go +++ b/service/docdb/api_op_RemoveFromGlobalCluster.go @@ -30,7 +30,7 @@ func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFrom return out, nil } -// Represents the input to RemoveFromGlobalCluster. +// Represents the input to RemoveFromGlobalCluster . type RemoveFromGlobalClusterInput struct { // The Amazon Resource Name (ARN) identifying the cluster that was detached from diff --git a/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go b/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go index 6aaa9458d15..922ace9de67 100644 --- a/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go +++ b/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go @@ -28,7 +28,7 @@ func (c *Client) RemoveSourceIdentifierFromSubscription(ctx context.Context, par return out, nil } -// Represents the input to RemoveSourceIdentifierFromSubscription. +// Represents the input to RemoveSourceIdentifierFromSubscription . type RemoveSourceIdentifierFromSubscriptionInput struct { // The source identifier to be removed from the subscription, such as the instance diff --git a/service/docdb/api_op_RemoveTagsFromResource.go b/service/docdb/api_op_RemoveTagsFromResource.go index d522ca1af94..c0d3d33abe1 100644 --- a/service/docdb/api_op_RemoveTagsFromResource.go +++ b/service/docdb/api_op_RemoveTagsFromResource.go @@ -26,7 +26,7 @@ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsF return out, nil } -// Represents the input to RemoveTagsFromResource. +// Represents the input to RemoveTagsFromResource . type RemoveTagsFromResourceInput struct { // The Amazon DocumentDB resource that the tags are removed from. This value is an diff --git a/service/docdb/api_op_ResetDBClusterParameterGroup.go b/service/docdb/api_op_ResetDBClusterParameterGroup.go index ffc9f15ff81..dbee512bb8a 100644 --- a/service/docdb/api_op_ResetDBClusterParameterGroup.go +++ b/service/docdb/api_op_ResetDBClusterParameterGroup.go @@ -13,7 +13,7 @@ import ( // Modifies the parameters of a cluster parameter group to the default value. To // reset specific parameters, submit a list of the following: ParameterName and -// ApplyMethod. To reset the entire cluster parameter group, specify the +// ApplyMethod . To reset the entire cluster parameter group, specify the // DBClusterParameterGroupName and ResetAllParameters parameters. When you reset // the entire group, dynamic parameters are updated immediately and static // parameters are set to pending-reboot to take effect on the next DB instance @@ -33,7 +33,7 @@ func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *Reset return out, nil } -// Represents the input to ResetDBClusterParameterGroup. +// Represents the input to ResetDBClusterParameterGroup . type ResetDBClusterParameterGroupInput struct { // The name of the cluster parameter group to reset. @@ -41,14 +41,15 @@ type ResetDBClusterParameterGroupInput struct { // This member is required. DBClusterParameterGroupName *string - // A list of parameter names in the cluster parameter group to reset to the default - // values. You can't use this parameter if the ResetAllParameters parameter is set - // to true. + // A list of parameter names in the cluster parameter group to reset to the + // default values. You can't use this parameter if the ResetAllParameters + // parameter is set to true . Parameters []types.Parameter // A value that is set to true to reset all parameters in the cluster parameter - // group to their default values, and false otherwise. You can't use this parameter - // if there is a list of parameter names specified for the Parameters parameter. + // group to their default values, and false otherwise. You can't use this + // parameter if there is a list of parameter names specified for the Parameters + // parameter. ResetAllParameters bool noSmithyDocumentSerde @@ -58,17 +59,10 @@ type ResetDBClusterParameterGroupInput struct { type ResetDBClusterParameterGroupOutput struct { // The name of a cluster parameter group. Constraints: - // - // * Must be from 1 to 255 - // letters or numbers. - // - // * The first character must be a letter. - // - // * Cannot end with - // a hyphen or contain two consecutive hyphens. - // - // This value is stored as a - // lowercase string. + // - Must be from 1 to 255 letters or numbers. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go index 5d7c36cc85d..492682da09d 100644 --- a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go @@ -32,20 +32,14 @@ func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *Resto return out, nil } -// Represents the input to RestoreDBClusterFromSnapshot. +// Represents the input to RestoreDBClusterFromSnapshot . type RestoreDBClusterFromSnapshotInput struct { // The name of the cluster to create from the snapshot or cluster snapshot. This // parameter isn't case sensitive. Constraints: - // - // * Must contain from 1 to 63 - // letters, numbers, or hyphens. - // - // * The first character must be a letter. - // - // * Cannot - // end with a hyphen or contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-snapshot-id // // This member is required. @@ -57,12 +51,10 @@ type RestoreDBClusterFromSnapshotInput struct { // This member is required. Engine *string - // The identifier for the snapshot or cluster snapshot to restore from. You can use - // either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. - // However, you can use only the ARN to specify a snapshot. Constraints: - // - // * Must - // match the identifier of an existing snapshot. + // The identifier for the snapshot or cluster snapshot to restore from. You can + // use either the name or the Amazon Resource Name (ARN) to specify a cluster + // snapshot. However, you can use only the ARN to specify a snapshot. Constraints: + // - Must match the identifier of an existing snapshot. // // This member is required. SnapshotIdentifier *string @@ -80,13 +72,14 @@ type RestoreDBClusterFromSnapshotInput struct { DBClusterParameterGroupName *string // The name of the subnet group to use for the new cluster. Constraints: If - // provided, must match the name of an existing DBSubnetGroup. Example: + // provided, must match the name of an existing DBSubnetGroup . Example: // mySubnetgroup DBSubnetGroupName *string - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. + // Specifies whether this cluster can be deleted. If DeletionProtection is + // enabled, the cluster cannot be deleted unless it is modified and + // DeletionProtection is disabled. DeletionProtection protects clusters from being + // accidentally deleted. DeletionProtection *bool // A list of log types that must be enabled for exporting to Amazon CloudWatch @@ -103,18 +96,15 @@ type RestoreDBClusterFromSnapshotInput struct { // new cluster, then you can use the KMS key alias instead of the ARN for the KMS // encryption key. If you do not specify a value for the KmsKeyId parameter, then // the following occurs: - // - // * If the snapshot or cluster snapshot in - // SnapshotIdentifier is encrypted, then the restored cluster is encrypted using - // the KMS key that was used to encrypt the snapshot or the cluster snapshot. - // - // * If - // the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, - // then the restored DB cluster is not encrypted. + // - If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then + // the restored cluster is encrypted using the KMS key that was used to encrypt the + // snapshot or the cluster snapshot. + // - If the snapshot or the cluster snapshot in SnapshotIdentifier is not + // encrypted, then the restored DB cluster is not encrypted. KmsKeyId *string // The port number on which the new cluster accepts connections. Constraints: Must - // be a value from 1150 to 65535. Default: The same port as the original cluster. + // be a value from 1150 to 65535 . Default: The same port as the original cluster. Port *int32 // The tags to be assigned to the restored cluster. diff --git a/service/docdb/api_op_RestoreDBClusterToPointInTime.go b/service/docdb/api_op_RestoreDBClusterToPointInTime.go index 55f759537d0..154710274a6 100644 --- a/service/docdb/api_op_RestoreDBClusterToPointInTime.go +++ b/service/docdb/api_op_RestoreDBClusterToPointInTime.go @@ -12,11 +12,11 @@ import ( "time" ) -// Restores a cluster to an arbitrary point in time. Users can restore to any point -// in time before LatestRestorableTime for up to BackupRetentionPeriod days. The -// target cluster is created from the source cluster with the same configuration as -// the original cluster, except that the new cluster is created with the default -// security group. +// Restores a cluster to an arbitrary point in time. Users can restore to any +// point in time before LatestRestorableTime for up to BackupRetentionPeriod days. +// The target cluster is created from the source cluster with the same +// configuration as the original cluster, except that the new cluster is created +// with the default security group. func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error) { if params == nil { params = &RestoreDBClusterToPointInTimeInput{} @@ -32,37 +32,31 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest return out, nil } -// Represents the input to RestoreDBClusterToPointInTime. +// Represents the input to RestoreDBClusterToPointInTime . type RestoreDBClusterToPointInTimeInput struct { // The name of the new cluster to be created. Constraints: - // - // * Must contain from 1 - // to 63 letters, numbers, or hyphens. - // - // * The first character must be a letter. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. DBClusterIdentifier *string // The identifier of the source cluster from which to restore. Constraints: - // - // * Must - // match the identifier of an existing DBCluster. + // - Must match the identifier of an existing DBCluster . // // This member is required. SourceDBClusterIdentifier *string - // The subnet group name to use for the new cluster. Constraints: If provided, must - // match the name of an existing DBSubnetGroup. Example: mySubnetgroup + // The subnet group name to use for the new cluster. Constraints: If provided, + // must match the name of an existing DBSubnetGroup . Example: mySubnetgroup DBSubnetGroupName *string - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. + // Specifies whether this cluster can be deleted. If DeletionProtection is + // enabled, the cluster cannot be deleted unless it is modified and + // DeletionProtection is disabled. DeletionProtection protects clusters from being + // accidentally deleted. DeletionProtection *bool // A list of log types that must be enabled for exporting to Amazon CloudWatch @@ -79,53 +73,37 @@ type RestoreDBClusterToPointInTimeInput struct { // cluster. The new DB cluster is encrypted with the KMS key identified by the // KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, // then the following occurs: - // - // * If the cluster is encrypted, then the restored - // cluster is encrypted using the KMS key that was used to encrypt the source - // cluster. - // - // * If the cluster is not encrypted, then the restored cluster is not - // encrypted. - // - // If DBClusterIdentifier refers to a cluster that is not encrypted, - // then the restore request is rejected. + // - If the cluster is encrypted, then the restored cluster is encrypted using + // the KMS key that was used to encrypt the source cluster. + // - If the cluster is not encrypted, then the restored cluster is not + // encrypted. + // If DBClusterIdentifier refers to a cluster that is not encrypted, then the + // restore request is rejected. KmsKeyId *string // The port number on which the new cluster accepts connections. Constraints: Must - // be a value from 1150 to 65535. Default: The default port for the engine. + // be a value from 1150 to 65535 . Default: The default port for the engine. Port *int32 // The date and time to restore the cluster to. Valid values: A time in Universal // Coordinated Time (UTC) format. Constraints: - // - // * Must be before the latest - // restorable time for the instance. - // - // * Must be specified if the - // UseLatestRestorableTime parameter is not provided. - // - // * Cannot be specified if the - // UseLatestRestorableTime parameter is true. - // - // * Cannot be specified if the - // RestoreType parameter is copy-on-write. - // + // - Must be before the latest restorable time for the instance. + // - Must be specified if the UseLatestRestorableTime parameter is not provided. + // - Cannot be specified if the UseLatestRestorableTime parameter is true . + // - Cannot be specified if the RestoreType parameter is copy-on-write . // Example: 2015-03-07T23:45:00Z RestoreToTime *time.Time // The type of restore to be performed. You can specify one of the following // values: - // - // * full-copy - The new DB cluster is restored as a full copy of the - // source DB cluster. - // - // * copy-on-write - The new DB cluster is restored as a clone - // of the source DB cluster. - // - // Constraints: You can't specify copy-on-write if the - // engine version of the source DB cluster is earlier than 1.11. If you don't - // specify a RestoreType value, then the new DB cluster is restored as a full copy - // of the source DB cluster. + // - full-copy - The new DB cluster is restored as a full copy of the source DB + // cluster. + // - copy-on-write - The new DB cluster is restored as a clone of the source DB + // cluster. + // Constraints: You can't specify copy-on-write if the engine version of the + // source DB cluster is earlier than 1.11. If you don't specify a RestoreType + // value, then the new DB cluster is restored as a full copy of the source DB + // cluster. RestoreType *string // The tags to be assigned to the restored cluster. diff --git a/service/docdb/api_op_StartDBCluster.go b/service/docdb/api_op_StartDBCluster.go index 6f80ceb8dfd..4b83c10ab0d 100644 --- a/service/docdb/api_op_StartDBCluster.go +++ b/service/docdb/api_op_StartDBCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restarts the stopped cluster that is specified by DBClusterIdentifier. For more -// information, see Stopping and Starting an Amazon DocumentDB Cluster -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html). +// Restarts the stopped cluster that is specified by DBClusterIdentifier . For more +// information, see Stopping and Starting an Amazon DocumentDB Cluster (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) +// . func (c *Client) StartDBCluster(ctx context.Context, params *StartDBClusterInput, optFns ...func(*Options)) (*StartDBClusterOutput, error) { if params == nil { params = &StartDBClusterInput{} diff --git a/service/docdb/api_op_StopDBCluster.go b/service/docdb/api_op_StopDBCluster.go index 92468baa907..6fb6b715852 100644 --- a/service/docdb/api_op_StopDBCluster.go +++ b/service/docdb/api_op_StopDBCluster.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops the running cluster that is specified by DBClusterIdentifier. The cluster +// Stops the running cluster that is specified by DBClusterIdentifier . The cluster // must be in the available state. For more information, see Stopping and Starting -// an Amazon DocumentDB Cluster -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html). +// an Amazon DocumentDB Cluster (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) +// . func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error) { if params == nil { params = &StopDBClusterInput{} diff --git a/service/docdb/types/errors.go b/service/docdb/types/errors.go index 5c71abb75e9..0331500f332 100644 --- a/service/docdb/types/errors.go +++ b/service/docdb/types/errors.go @@ -895,8 +895,8 @@ func (e *InvalidDBInstanceStateFault) ErrorCode() string { } func (e *InvalidDBInstanceStateFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The parameter group is in use, or it is in a state that is not valid. If you are -// trying to delete the parameter group, you can't delete it when the parameter +// The parameter group is in use, or it is in a state that is not valid. If you +// are trying to delete the parameter group, you can't delete it when the parameter // group is in this state. type InvalidDBParameterGroupStateFault struct { Message *string diff --git a/service/docdb/types/types.go b/service/docdb/types/types.go index 203f73f43cc..464bb1ca308 100644 --- a/service/docdb/types/types.go +++ b/service/docdb/types/types.go @@ -68,8 +68,8 @@ type DBCluster struct { // your behalf. AssociatedRoles []DBClusterRole - // Provides the list of Amazon EC2 Availability Zones that instances in the cluster - // can be created in. + // Provides the list of Amazon EC2 Availability Zones that instances in the + // cluster can be created in. AvailabilityZones []string // Specifies the number of days for which automatic snapshots are retained. @@ -104,9 +104,10 @@ type DBCluster struct { // cluster is accessed. DbClusterResourceId *string - // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, - // the cluster cannot be deleted unless it is modified and DeletionProtection is - // disabled. DeletionProtection protects clusters from being accidentally deleted. + // Specifies whether this cluster can be deleted. If DeletionProtection is + // enabled, the cluster cannot be deleted unless it is modified and + // DeletionProtection is disabled. DeletionProtection protects clusters from being + // accidentally deleted. DeletionProtection bool // The earliest time to which a database can be restored with point-in-time @@ -129,11 +130,11 @@ type DBCluster struct { // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string - // If StorageEncrypted is true, the KMS key identifier for the encrypted cluster. + // If StorageEncrypted is true , the KMS key identifier for the encrypted cluster. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // Contains the master user name for the cluster. @@ -149,7 +150,7 @@ type DBCluster struct { Port *int32 // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in @@ -230,8 +231,8 @@ type DBClusterParameterGroup struct { noSmithyDocumentSerde } -// Describes an Identity and Access Management (IAM) role that is associated with a -// cluster. +// Describes an Identity and Access Management (IAM) role that is associated with +// a cluster. type DBClusterRole struct { // The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB @@ -240,17 +241,12 @@ type DBClusterRole struct { // Describes the state of association between the IAMrole and the cluster. The // Status property returns one of the following values: - // - // * ACTIVE - The IAMrole ARN - // is associated with the cluster and can be used to access other Amazon Web - // Services services on your behalf. - // - // * PENDING - The IAMrole ARN is being - // associated with the cluster. - // - // * INVALID - The IAMrole ARN is associated with the - // cluster, but the cluster cannot assume the IAMrole to access other Amazon Web - // Services services on your behalf. + // - ACTIVE - The IAMrole ARN is associated with the cluster and can be used to + // access other Amazon Web Services services on your behalf. + // - PENDING - The IAMrole ARN is being associated with the cluster. + // - INVALID - The IAMrole ARN is associated with the cluster, but the cluster + // cannot assume the IAMrole to access other Amazon Web Services services on your + // behalf. Status *string noSmithyDocumentSerde @@ -259,8 +255,8 @@ type DBClusterRole struct { // Detailed information about a cluster snapshot. type DBClusterSnapshot struct { - // Provides the list of Amazon EC2 Availability Zones that instances in the cluster - // snapshot can be restored in. + // Provides the list of Amazon EC2 Availability Zones that instances in the + // cluster snapshot can be restored in. AvailabilityZones []string // Specifies the time when the cluster was created, in Universal Coordinated Time @@ -283,7 +279,7 @@ type DBClusterSnapshot struct { // Provides the version of the database engine for this cluster snapshot. EngineVersion *string - // If StorageEncrypted is true, the KMS key identifier for the encrypted cluster + // If StorageEncrypted is true , the KMS key identifier for the encrypted cluster // snapshot. KmsKeyId *string @@ -330,9 +326,9 @@ type DBClusterSnapshotAttribute struct { // or restore the manual cluster snapshot. AttributeName *string - // The values for the manual cluster snapshot attribute. If the AttributeName field - // is set to restore, then this element returns a list of IDs of the Amazon Web - // Services accounts that are authorized to copy or restore the manual cluster + // The values for the manual cluster snapshot attribute. If the AttributeName + // field is set to restore , then this element returns a list of IDs of the Amazon + // Web Services accounts that are authorized to copy or restore the manual cluster // snapshot. If a value of all is in the list, then the manual cluster snapshot is // public and available for any Amazon Web Services account to copy or restore. AttributeValues []string @@ -401,8 +397,8 @@ type DBInstance struct { // The identifier of the CA certificate for this DB instance. CACertificateIdentifier *string - // A value that indicates whether to copy tags from the DB instance to snapshots of - // the DB instance. By default, tags are not copied. + // A value that indicates whether to copy tags from the DB instance to snapshots + // of the DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool // Contains the name of the cluster that the instance is a member of if the @@ -447,11 +443,11 @@ type DBInstance struct { // Provides the date and time that the instance was created. InstanceCreateTime *time.Time - // If StorageEncrypted is true, the KMS key identifier for the encrypted instance. + // If StorageEncrypted is true , the KMS key identifier for the encrypted instance. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // Specifies that changes to the instance are pending. This element is included @@ -459,7 +455,7 @@ type DBInstance struct { PendingModifiedValues *PendingModifiedValues // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in @@ -472,7 +468,7 @@ type DBInstance struct { PromotionTier *int32 // Not supported. Amazon DocumentDB does not currently support public endpoints. - // The value of PubliclyAccessible is always false. + // The value of PubliclyAccessible is always false . PubliclyAccessible bool // The status of a read replica. If the instance is not a read replica, this is @@ -500,10 +496,10 @@ type DBInstanceStatusInfo struct { Normal bool // Status of the instance. For a StatusType of read replica, the values can be - // replicating, error, stopped, or terminated. + // replicating , error, stopped , or terminated . Status *string - // This value is currently "read replication." + // This value is currently " read replication ." StatusType *string noSmithyDocumentSerde @@ -559,7 +555,7 @@ type EngineDefaults struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The parameters of a particular cluster parameter group family. @@ -635,9 +631,9 @@ type EventSubscription struct { SourceType *string // The status of the Amazon DocumentDB event notification subscription. - // Constraints: Can be one of the following: creating, modifying, deleting, active, - // no-permission, topic-not-exist The no-permission status indicates that Amazon - // DocumentDB no longer has permission to post to the SNS topic. The + // Constraints: Can be one of the following: creating , modifying , deleting , + // active , no-permission , topic-not-exist The no-permission status indicates + // that Amazon DocumentDB no longer has permission to post to the SNS topic. The // topic-not-exist status indicates that the topic was deleted after the // subscription was created. Status *string @@ -714,9 +710,9 @@ type GlobalClusterMember struct { // The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster. DBClusterArn *string - // Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, - // has read-write capability) for the Amazon DocumentDB global cluster with which - // it is associated. + // Specifies whether the Amazon DocumentDB cluster is the primary cluster (that + // is, has read-write capability) for the Amazon DocumentDB global cluster with + // which it is associated. IsWriter bool // The Amazon Resource Name (ARN) for each read-only secondary cluster associated @@ -768,7 +764,7 @@ type Parameter struct { // Provides a description of the parameter. Description *string - // Indicates whether (true) or not (false) the parameter can be modified. Some + // Indicates whether ( true ) or not ( false ) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable bool @@ -834,12 +830,12 @@ type PendingMaintenanceAction struct { noSmithyDocumentSerde } -// One or more modified settings for an instance. These modified settings have been -// requested, but haven't been applied yet. +// One or more modified settings for an instance. These modified settings have +// been requested, but haven't been applied yet. type PendingModifiedValues struct { - // Contains the new AllocatedStorage size for then instance that will be applied or - // is currently being applied. + // Contains the new AllocatedStorage size for then instance that will be applied + // or is currently being applied. AllocatedStorage *int32 // Specifies the pending number of days for which automated backups are retained. @@ -867,8 +863,8 @@ type PendingModifiedValues struct { // or is currently being applied. Iops *int32 - // The license model for the instance. Valid values: license-included, - // bring-your-own-license, general-public-license + // The license model for the instance. Valid values: license-included , + // bring-your-own-license , general-public-license LicenseModel *string // Contains the pending or currently in-progress change of the master credentials @@ -891,7 +887,7 @@ type PendingModifiedValues struct { noSmithyDocumentSerde } -// Represents the output of ApplyPendingMaintenanceAction. +// Represents the output of ApplyPendingMaintenanceAction . type ResourcePendingMaintenanceActions struct { // A list that provides details about the pending maintenance actions for the @@ -925,14 +921,14 @@ type Subnet struct { type Tag struct { // The required name of the tag. The string value can be from 1 to 128 Unicode - // characters in length and can't be prefixed with "aws:" or "rds:". The string can - // contain only the set of Unicode letters, digits, white space, '_', '.', '/', + // characters in length and can't be prefixed with " aws: " or " rds: ". The string + // can contain only the set of Unicode letters, digits, white space, '_', '.', '/', // '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Key *string // The optional value of the tag. The string value can be from 1 to 256 Unicode - // characters in length and can't be prefixed with "aws:" or "rds:". The string can - // contain only the set of Unicode letters, digits, white space, '_', '.', '/', + // characters in length and can't be prefixed with " aws: " or " rds: ". The string + // can contain only the set of Unicode letters, digits, white space, '_', '.', '/', // '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Value *string @@ -943,7 +939,7 @@ type Tag struct { type UpgradeTarget struct { // A value that indicates whether the target version is applied to any source DB - // instances that have AutoMinorVersionUpgrade set to true. + // instances that have AutoMinorVersionUpgrade set to true . AutoUpgrade bool // The version of the database engine that an instance can be upgraded to. diff --git a/service/docdbelastic/api_client.go b/service/docdbelastic/api_client.go index d14f8ac0748..f58c38214b2 100644 --- a/service/docdbelastic/api_client.go +++ b/service/docdbelastic/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/docdbelastic/api_op_CreateCluster.go b/service/docdbelastic/api_op_CreateCluster.go index 8e0ebf191a3..2a245fe33f0 100644 --- a/service/docdbelastic/api_op_CreateCluster.go +++ b/service/docdbelastic/api_op_CreateCluster.go @@ -31,26 +31,18 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { // The name of the Elastic DocumentDB cluster administrator. Constraints: - // - // * Must - // be from 1 to 63 letters or numbers. - // - // * The first character must be a letter. - // - // * - // Cannot be a reserved word. + // - Must be from 1 to 63 letters or numbers. + // - The first character must be a letter. + // - Cannot be a reserved word. // // This member is required. AdminUserName *string // The password for the Elastic DocumentDB cluster administrator and can contain // any printable ASCII characters. Constraints: - // - // * Must contain from 8 to 100 - // characters. - // - // * Cannot contain a forward slash (/), double quote ("), or the "at" - // symbol (@). + // - Must contain from 8 to 100 characters. + // - Cannot contain a forward slash (/), double quote ("), or the "at" symbol + // (@). // // This member is required. AdminUserPassword *string @@ -62,15 +54,9 @@ type CreateClusterInput struct { // The name of the new Elastic DocumentDB cluster. This parameter is stored as a // lowercase string. Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or - // hyphens. - // - // * The first character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster // // This member is required. @@ -89,10 +75,10 @@ type CreateClusterInput struct { // The client token for the Elastic DocumentDB cluster. ClientToken *string - // The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster. The - // KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. - // If you are creating a cluster using the same Amazon account that owns this KMS - // encryption key, you can use the KMS key alias instead of the ARN as the KMS + // The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster. + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are creating a cluster using the same Amazon account that owns this + // KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS // encryption key. If an encryption key is not specified, Elastic DocumentDB uses // the default encryption key that KMS creates for your account. Your account has a // different default encryption key for each Amazon Region. diff --git a/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go b/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go index 9d036bdea06..f90f6ba539e 100644 --- a/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go +++ b/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go @@ -39,10 +39,10 @@ type RestoreClusterFromSnapshotInput struct { // This member is required. SnapshotArn *string - // The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster. The - // KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. - // If you are creating a cluster using the same Amazon account that owns this KMS - // encryption key, you can use the KMS key alias instead of the ARN as the KMS + // The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster. + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are creating a cluster using the same Amazon account that owns this + // KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS // encryption key. If an encryption key is not specified here, Elastic DocumentDB // uses the default encryption key that KMS creates for your account. Your account // has a different default encryption key for each Amazon Region. diff --git a/service/docdbelastic/api_op_UpdateCluster.go b/service/docdbelastic/api_op_UpdateCluster.go index 16058b57d31..75a27004221 100644 --- a/service/docdbelastic/api_op_UpdateCluster.go +++ b/service/docdbelastic/api_op_UpdateCluster.go @@ -37,8 +37,8 @@ type UpdateClusterInput struct { // This member is required. ClusterArn *string - // The password for the Elastic DocumentDB cluster administrator. This password can - // contain any printable ASCII character except forward slash (/), double quote + // The password for the Elastic DocumentDB cluster administrator. This password + // can contain any printable ASCII character except forward slash (/), double quote // ("), or the "at" symbol (@). Constraints: Must contain from 8 to 100 characters. AdminUserPassword *string diff --git a/service/docdbelastic/types/errors.go b/service/docdbelastic/types/errors.go index d43c802d1b5..26a553853da 100644 --- a/service/docdbelastic/types/errors.go +++ b/service/docdbelastic/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// An exception that occurs when there are not sufficient permissions to perform an -// action. +// An exception that occurs when there are not sufficient permissions to perform +// an action. type AccessDeniedException struct { Message *string diff --git a/service/drs/api_client.go b/service/drs/api_client.go index 70962ca1739..ec06971bb56 100644 --- a/service/drs/api_client.go +++ b/service/drs/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/drs/api_op_CreateReplicationConfigurationTemplate.go b/service/drs/api_op_CreateReplicationConfigurationTemplate.go index 8d676b7397a..719efc06ee1 100644 --- a/service/drs/api_op_CreateReplicationConfigurationTemplate.go +++ b/service/drs/api_op_CreateReplicationConfigurationTemplate.go @@ -35,8 +35,8 @@ type CreateReplicationConfigurationTemplateInput struct { // This member is required. AssociateDefaultSecurityGroup *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. // // This member is required. BandwidthThrottling int64 @@ -124,8 +124,8 @@ type CreateReplicationConfigurationTemplateOutput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. diff --git a/service/drs/api_op_DescribeJobLogItems.go b/service/drs/api_op_DescribeJobLogItems.go index fd1efbdab96..0a55c6934bb 100644 --- a/service/drs/api_op_DescribeJobLogItems.go +++ b/service/drs/api_op_DescribeJobLogItems.go @@ -121,8 +121,8 @@ func (c *Client) addOperationDescribeJobLogItemsMiddlewares(stack *middleware.St return nil } -// DescribeJobLogItemsAPIClient is a client that implements the DescribeJobLogItems -// operation. +// DescribeJobLogItemsAPIClient is a client that implements the +// DescribeJobLogItems operation. type DescribeJobLogItemsAPIClient interface { DescribeJobLogItems(context.Context, *DescribeJobLogItemsInput, ...func(*Options)) (*DescribeJobLogItemsOutput, error) } diff --git a/service/drs/api_op_GetReplicationConfiguration.go b/service/drs/api_op_GetReplicationConfiguration.go index 63a6230eab1..2950207ef02 100644 --- a/service/drs/api_op_GetReplicationConfiguration.go +++ b/service/drs/api_op_GetReplicationConfiguration.go @@ -47,8 +47,8 @@ type GetReplicationConfigurationOutput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. diff --git a/service/drs/api_op_ListExtensibleSourceServers.go b/service/drs/api_op_ListExtensibleSourceServers.go index 759666c8043..08156f9d031 100644 --- a/service/drs/api_op_ListExtensibleSourceServers.go +++ b/service/drs/api_op_ListExtensibleSourceServers.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of source servers on a staging account that are extensible, which -// means that: a. The source server is not already extended into this Account. b. -// The source server on the Account we’re reading from is not an extension of -// another source server. +// Returns a list of source servers on a staging account that are extensible, +// which means that: a. The source server is not already extended into this +// Account. b. The source server on the Account we’re reading from is not an +// extension of another source server. func (c *Client) ListExtensibleSourceServers(ctx context.Context, params *ListExtensibleSourceServersInput, optFns ...func(*Options)) (*ListExtensibleSourceServersOutput, error) { if params == nil { params = &ListExtensibleSourceServersInput{} diff --git a/service/drs/api_op_ListStagingAccounts.go b/service/drs/api_op_ListStagingAccounts.go index f81888e9078..56f8c1d2934 100644 --- a/service/drs/api_op_ListStagingAccounts.go +++ b/service/drs/api_op_ListStagingAccounts.go @@ -113,8 +113,8 @@ func (c *Client) addOperationListStagingAccountsMiddlewares(stack *middleware.St return nil } -// ListStagingAccountsAPIClient is a client that implements the ListStagingAccounts -// operation. +// ListStagingAccountsAPIClient is a client that implements the +// ListStagingAccounts operation. type ListStagingAccountsAPIClient interface { ListStagingAccounts(context.Context, *ListStagingAccountsInput, ...func(*Options)) (*ListStagingAccountsOutput, error) } diff --git a/service/drs/api_op_UpdateReplicationConfiguration.go b/service/drs/api_op_UpdateReplicationConfiguration.go index 592c7b3d293..fc23360e320 100644 --- a/service/drs/api_op_UpdateReplicationConfiguration.go +++ b/service/drs/api_op_UpdateReplicationConfiguration.go @@ -42,8 +42,8 @@ type UpdateReplicationConfigurationInput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. @@ -99,8 +99,8 @@ type UpdateReplicationConfigurationOutput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. diff --git a/service/drs/api_op_UpdateReplicationConfigurationTemplate.go b/service/drs/api_op_UpdateReplicationConfigurationTemplate.go index e6665fc141c..2fa86dbc00d 100644 --- a/service/drs/api_op_UpdateReplicationConfigurationTemplate.go +++ b/service/drs/api_op_UpdateReplicationConfigurationTemplate.go @@ -45,8 +45,8 @@ type UpdateReplicationConfigurationTemplateInput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. @@ -104,8 +104,8 @@ type UpdateReplicationConfigurationTemplateOutput struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. diff --git a/service/drs/doc.go b/service/drs/doc.go index c701d9516e8..5ba84b0515b 100644 --- a/service/drs/doc.go +++ b/service/drs/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package drs provides the API client, operations, and parameter types for Elastic -// Disaster Recovery Service. +// Package drs provides the API client, operations, and parameter types for +// Elastic Disaster Recovery Service. // // AWS Elastic Disaster Recovery Service. package drs diff --git a/service/drs/types/enums.go b/service/drs/types/enums.go index dddb4969a12..7c73a6f77ba 100644 --- a/service/drs/types/enums.go +++ b/service/drs/types/enums.go @@ -61,8 +61,8 @@ const ( DataReplicationInitiationStepNameStartDataTransfer DataReplicationInitiationStepName = "START_DATA_TRANSFER" ) -// Values returns all known values for DataReplicationInitiationStepName. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DataReplicationInitiationStepName. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DataReplicationInitiationStepName) Values() []DataReplicationInitiationStepName { @@ -233,9 +233,9 @@ const ( FailbackReplicationErrorFailedToStartDataTransfer FailbackReplicationError = "FAILED_TO_START_DATA_TRANSFER" ) -// Values returns all known values for FailbackReplicationError. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FailbackReplicationError. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FailbackReplicationError) Values() []FailbackReplicationError { return []FailbackReplicationError{ "AGENT_NOT_SEEN", @@ -373,9 +373,9 @@ const ( JobStatusCompleted JobStatus = "COMPLETED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "PENDING", @@ -473,9 +473,9 @@ const ( LaunchStatusTerminated LaunchStatus = "TERMINATED" ) -// Values returns all known values for LaunchStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LaunchStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LaunchStatus) Values() []LaunchStatus { return []LaunchStatus{ "PENDING", diff --git a/service/drs/types/types.go b/service/drs/types/types.go index 4ec17d81f0b..33883ddaac4 100644 --- a/service/drs/types/types.go +++ b/service/drs/types/types.go @@ -183,12 +183,12 @@ type DescribeSourceServersRequestFilters struct { // instance id, a VMware uuid or a mac address. HardwareId *string - // An array of Source Servers IDs that should be returned. An empty array means all - // Source Servers. + // An array of Source Servers IDs that should be returned. An empty array means + // all Source Servers. SourceServerIDs []string - // An array of staging account IDs that extended source servers belong to. An empty - // array means all source servers will be shown. + // An array of staging account IDs that extended source servers belong to. An + // empty array means all source servers will be shown. StagingAccountIDs []string noSmithyDocumentSerde @@ -393,8 +393,8 @@ type ParticipatingServer struct { noSmithyDocumentSerde } -// A rule in the Point in Time (PIT) policy representing when to take snapshots and -// how long to retain them for. +// A rule in the Point in Time (PIT) policy representing when to take snapshots +// and how long to retain them for. type PITPolicyRule struct { // How often, in the chosen units, a snapshot should be taken. @@ -439,8 +439,8 @@ type RecoveryInstance struct { // An object representing failback related information of the Recovery Instance. Failback *RecoveryInstanceFailback - // Whether this Recovery Instance was created for a drill or for an actual Recovery - // event. + // Whether this Recovery Instance was created for a drill or for an actual + // Recovery event. IsDrill *bool // The ID of the Job that created the Recovery Instance. @@ -710,8 +710,8 @@ type ReplicationConfigurationTemplate struct { // added disks. AutoReplicateNewDisks *bool - // Configure bandwidth throttling for the outbound data transfer rate of the Source - // Server in Mbps. + // Configure bandwidth throttling for the outbound data transfer rate of the + // Source Server in Mbps. BandwidthThrottling int64 // Whether to create a Public IP for the Recovery Instance by default. @@ -847,8 +847,8 @@ type SourceServer struct { // Staging information related to source server. type StagingArea struct { - // Shows an error message that occurred when DRS tried to access the staging source - // server. In this case StagingArea$status will have value EXTENSION_ERROR + // Shows an error message that occurred when DRS tried to access the staging + // source server. In this case StagingArea$status will have value EXTENSION_ERROR ErrorMessage *string // Account ID of the account to which source server belongs. If this source server @@ -858,10 +858,10 @@ type StagingArea struct { // Arn of the staging source server if this source server is extended StagingSourceServerArn *string - // Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a - // source server that is replicating in the current account. (b) EXTENDED - Source - // server is extended from a staging source server. In this case, the value of - // stagingSourceServerArn is pointing to the Arn of the source server in the + // Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is + // a source server that is replicating in the current account. (b) EXTENDED - + // Source server is extended from a staging source server. In this case, the value + // of stagingSourceServerArn is pointing to the Arn of the source server in the // staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing // staging source server. In this case, errorMessage field will contain an error // message that explains what happened. @@ -893,8 +893,8 @@ type StartRecoveryRequestSourceServer struct { // This member is required. SourceServerID *string - // The ID of a Recovery Snapshot we want to recover from. Omit this field to launch - // from the latest data by taking an on-demand snapshot. + // The ID of a Recovery Snapshot we want to recover from. Omit this field to + // launch from the latest data by taking an on-demand snapshot. RecoverySnapshotID *string noSmithyDocumentSerde diff --git a/service/dynamodb/api_client.go b/service/dynamodb/api_client.go index d917d447a82..9db640b313c 100644 --- a/service/dynamodb/api_client.go +++ b/service/dynamodb/api_client.go @@ -146,7 +146,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/dynamodb/api_op_BatchExecuteStatement.go b/service/dynamodb/api_op_BatchExecuteStatement.go index 0aec64420f1..1e1142a0ef8 100644 --- a/service/dynamodb/api_op_BatchExecuteStatement.go +++ b/service/dynamodb/api_op_BatchExecuteStatement.go @@ -18,8 +18,7 @@ import ( // consist of either read statements or write statements, you cannot mix both in // one batch. A HTTP 200 response does not mean that all statements in the // BatchExecuteStatement succeeded. Error details for individual statements can be -// found under the Error -// (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error) +// found under the Error (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error) // field of the BatchStatementResponse for each statement. func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) { if params == nil { @@ -45,19 +44,14 @@ type BatchExecuteStatementInput struct { // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_BatchGetItem.go b/service/dynamodb/api_op_BatchGetItem.go index 79bab0f4a56..3e378c1f245 100644 --- a/service/dynamodb/api_op_BatchGetItem.go +++ b/service/dynamodb/api_op_BatchGetItem.go @@ -19,27 +19,26 @@ import ( // 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 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 +// 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 +// 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 dataset. If none of the -// items can be processed due to insufficient provisioned throughput on all of the -// tables in the request, then BatchGetItem returns a -// ProvisionedThroughputExceededException. If at least one of the items is +// 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 dataset. If none +// of the items can be processed due to insufficient provisioned throughput 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. If DynamoDB returns +// returning the keys of the unread items in UnprocessedKeys . If DynamoDB returns // any unprocessed items, you should retry the batch operation on those items. // However, we strongly recommend that you use an exponential backoff algorithm. If // you retry the batch operation immediately, the underlying read or write requests // can still fail due to throttling on the individual 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) +// Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) // in the Amazon DynamoDB Developer Guide. By default, BatchGetItem performs // eventually consistent reads on every table in the request. If you want strongly // consistent reads instead, you can set ConsistentRead to true for any or all @@ -50,8 +49,7 @@ import ( // ProjectionExpression parameter. 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 Working -// with Tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) +// with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) // in the Amazon DynamoDB Developer Guide. func (c *Client) BatchGetItem(ctx context.Context, params *BatchGetItemInput, optFns ...func(*Options)) (*BatchGetItemOutput, error) { if params == nil { @@ -75,91 +73,58 @@ type BatchGetItemInput struct { // or more items to retrieve from that table. Each table name can be used only once // per BatchGetItem request. Each element in the map of items to retrieve consists // of the following: - // - // * ConsistentRead - If true, a strongly consistent read is - // used; if false (the default), an eventually consistent read is used. - // - // * - // ExpressionAttributeNames - One or more substitution tokens for attribute names - // in the ProjectionExpression parameter. The following are some use cases for - // using ExpressionAttributeNames: - // - // * To access an attribute whose name conflicts - // with a DynamoDB reserved word. - // - // * To create a placeholder for repeating - // occurrences of an attribute name in an expression. - // - // * To prevent special - // characters in an attribute name from being misinterpreted in an expression. - // - // Use - // the # character in an expression to dereference an attribute name. For example, - // consider the following attribute name: - // - // * Percentile - // - // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 - // 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. - // - // * Keys - An array of primary key - // attribute values that define specific items in the table. For each primary key, - // you must provide all of the key attributes. For example, with a simple primary - // key, you only need to provide the partition key value. For a composite key, you - // must provide both the partition key value and the sort key value. - // - // * - // ProjectionExpression - A string that identifies one or more attributes 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 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. - // - // * AttributesToGet - This is a legacy - // parameter. Use ProjectionExpression instead. For more information, see - // AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) - // in the Amazon DynamoDB Developer Guide. + // - ConsistentRead - If true , a strongly consistent read is used; if false (the + // default), an eventually consistent read is used. + // - ExpressionAttributeNames - One or more substitution tokens for attribute + // names in the ProjectionExpression parameter. The following are some use cases + // for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. Use the # character in an expression to + // dereference an attribute name. For example, consider the following attribute + // name: + // - Percentile 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 + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} 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 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. + // - Keys - An array of primary key attribute values that define specific items + // in the table. For each primary key, you must provide all of the key attributes. + // For example, with a simple primary key, you only need to provide the partition + // key value. For a composite key, you must provide both the partition key value + // and the sort key value. + // - ProjectionExpression - A string that identifies one or more attributes 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 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. + // - AttributesToGet - This is a legacy parameter. Use ProjectionExpression + // instead. For more information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // in the Amazon DynamoDB Developer Guide. // // This member is required. RequestItems map[string]types.KeysAndAttributes // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde @@ -170,11 +135,8 @@ type BatchGetItemOutput struct { // The read capacity units consumed by the entire BatchGetItem operation. Each // element consists of: - // - // * TableName - The table that consumed the provisioned - // throughput. - // - // * CapacityUnits - The total number of capacity units consumed. + // - TableName - The table that consumed the provisioned throughput. + // - CapacityUnits - The total number of capacity units consumed. ConsumedCapacity []types.ConsumedCapacity // A map of table name to a list of items. Each object in Responses consists of a @@ -183,25 +145,20 @@ type BatchGetItemOutput struct { Responses map[string][]map[string]types.AttributeValue // A map of tables and their respective keys that were not processed with the - // current response. The UnprocessedKeys value is in the same form as RequestItems, - // so the value can be provided directly to a subsequent BatchGetItem operation. + // current response. The UnprocessedKeys value is in the same form as RequestItems + // , so the value can be provided directly to a subsequent BatchGetItem operation. // For more information, see RequestItems in the Request Parameters section. Each // element consists of: - // - // * Keys - An array of primary key attribute values that - // define specific items in the table. - // - // * ProjectionExpression - One or more - // attributes to be retrieved from the table or index. By default, all attributes - // are returned. If a requested attribute is not found, it does not appear in the - // result. - // - // * ConsistentRead - The consistency of a read operation. If set to true, - // then a strongly consistent read is used; otherwise, an eventually consistent - // read is used. - // - // If there are no unprocessed keys remaining, the response contains - // an empty UnprocessedKeys map. + // - Keys - An array of primary key attribute values that define specific items + // in the table. + // - ProjectionExpression - One or more attributes to be retrieved from the table + // or index. By default, all attributes are returned. If a requested attribute is + // not found, it does not appear in the result. + // - ConsistentRead - The consistency of a read operation. If set to true , then + // a strongly consistent read is used; otherwise, an eventually consistent read is + // used. + // If there are no unprocessed keys remaining, the response contains an empty + // UnprocessedKeys map. UnprocessedKeys map[string]types.KeysAndAttributes // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_BatchWriteItem.go b/service/dynamodb/api_op_BatchWriteItem.go index a9bf9082a18..e38b05f096c 100644 --- a/service/dynamodb/api_op_BatchWriteItem.go +++ b/service/dynamodb/api_op_BatchWriteItem.go @@ -14,18 +14,17 @@ import ( ) // The BatchWriteItem operation puts or deletes multiple items in one or more -// tables. A single call to BatchWriteItem can transmit up to 16MB of data over the -// network, consisting of up to 25 item put or delete operations. While individual -// items can be up to 400 KB once stored, it's important to note that an item's -// representation might be greater than 400KB while being sent in DynamoDB's JSON -// format for the API call. For more details on this distinction, see Naming Rules -// and Data Types -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html). -// BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on -// an existing item, that item's values will be overwritten by the operation and it -// will appear like it was updated. To update items, we recommend you use the -// UpdateItem action. The individual PutItem and DeleteItem operations specified in -// BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any +// tables. A single call to BatchWriteItem can transmit up to 16MB of data over +// the network, consisting of up to 25 item put or delete operations. While +// individual items can be up to 400 KB once stored, it's important to note that an +// item's representation might be greater than 400KB while being sent in DynamoDB's +// JSON format for the API call. For more details on this distinction, see Naming +// Rules and Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html) +// . BatchWriteItem cannot update items. If you perform a BatchWriteItem operation +// on an existing item, that item's values will be overwritten by the operation and +// it will appear like it was updated. To update items, we recommend you use the +// UpdateItem action. The individual PutItem and DeleteItem operations specified +// in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any // requested operations fail because the table's provisioned throughput is exceeded // or an internal processing failure occurs, the failed operations are returned in // the UnprocessedItems response parameter. You can investigate and optionally @@ -34,22 +33,21 @@ import ( // request with those unprocessed items until all items have been processed. 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 +// 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 backoff algorithm. If you retry the batch // operation immediately, the underlying read or write requests can still fail due // to throttling on the individual 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#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 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 +// to succeed. 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 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 logic to manage the threads. With // languages that don't support threading, you must update or delete the specified // items one at a time. In both situations, BatchWriteItem performs the specified @@ -60,28 +58,17 @@ import ( // not. Delete operations on nonexistent items consume one write capacity unit. If // one or more of the following is true, DynamoDB rejects the entire batch write // operation: -// -// * One or more tables specified in the BatchWriteItem request does -// not exist. -// -// * Primary key attributes specified on an item in the request do not -// match those in the corresponding table's primary key schema. -// -// * You try to -// perform multiple operations on the same item in the same BatchWriteItem request. -// For example, you cannot put and delete the same item in the same BatchWriteItem -// request. -// -// * Your request contains at least two items with identical hash and -// range keys (which essentially is two put operations). -// -// * There are more than 25 -// requests in the batch. -// -// * Any individual item in a batch exceeds 400 KB. -// -// * The -// total request size exceeds 16 MB. +// - One or more tables specified in the BatchWriteItem request does not exist. +// - Primary key attributes specified on an item in the request do not match +// those in the corresponding table's primary key schema. +// - You try to perform multiple operations on the same item in the same +// BatchWriteItem request. For example, you cannot put and delete the same item +// in the same BatchWriteItem request. +// - Your request contains at least two items with identical hash and range keys +// (which essentially is two put operations). +// - There are more than 25 requests in the batch. +// - Any individual item in a batch exceeds 400 KB. +// - The total request size exceeds 16 MB. func (c *Client) BatchWriteItem(ctx context.Context, params *BatchWriteItemInput, optFns ...func(*Options)) (*BatchWriteItemOutput, error) { if params == nil { params = &BatchWriteItemInput{} @@ -100,57 +87,46 @@ func (c *Client) BatchWriteItem(ctx context.Context, params *BatchWriteItemInput // Represents the input of a BatchWriteItem operation. type BatchWriteItemInput struct { - // A map of one or more table names and, for each table, a list of operations to be - // performed (DeleteRequest or PutRequest). Each element in the map consists of the - // following: - // - // * DeleteRequest - Perform a DeleteItem operation on the specified - // item. The item to be deleted is identified by a Key subelement: - // - // * Key - A map - // of primary key attribute values that uniquely identify the item. Each entry in - // this map consists of an attribute name and an attribute value. For each primary - // key, you must provide all of the key attributes. For example, with a simple - // primary key, you only need to provide a value for the partition key. For a - // composite primary key, you must provide values for both the partition key and - // the sort key. - // - // * PutRequest - Perform a PutItem operation on the specified item. - // The item to be put is identified by an Item subelement: - // - // * Item - A map of - // attributes 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 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. + // A map of one or more table names and, for each table, a list of operations to + // be performed ( DeleteRequest or PutRequest ). Each element in the map consists + // of the following: + // - DeleteRequest - Perform a DeleteItem operation on the specified item. The + // item to be deleted is identified by a Key subelement: + // - Key - A map of primary key attribute values that uniquely identify the item. + // Each entry in this map consists of an attribute name and an attribute value. For + // each primary key, you must provide all of the key attributes. For example, with + // a simple primary key, you only need to provide a value for the partition key. + // For a composite primary key, you must provide values for both the partition key + // and the sort key. + // - PutRequest - Perform a PutItem operation on the specified item. The item to + // be put is identified by an Item subelement: + // - Item - A map of attributes 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 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. // // This member is required. RequestItems map[string][]types.WriteRequest // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // Determines whether item collection metrics are returned. If set to SIZE, the + // Determines whether item collection metrics are returned. If set to SIZE , the // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. + // during the operation are returned in the response. If set to NONE (the + // default), no statistics are returned. ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics noSmithyDocumentSerde @@ -159,63 +135,48 @@ type BatchWriteItemInput struct { // Represents the output of a BatchWriteItem operation. type BatchWriteItemOutput struct { - // The capacity units consumed by the entire BatchWriteItem operation. Each element - // consists of: - // - // * TableName - The table that consumed the provisioned - // throughput. - // - // * CapacityUnits - The total number of capacity units consumed. + // The capacity units consumed by the entire BatchWriteItem operation. Each + // element consists of: + // - TableName - The table that consumed the provisioned throughput. + // - CapacityUnits - The total number of capacity units consumed. ConsumedCapacity []types.ConsumedCapacity // A list of tables that were processed by BatchWriteItem and, for each table, // information about any item collections that were affected by individual // DeleteItem or PutItem operations. Each entry consists of the following // subelements: - // - // * ItemCollectionKey - The partition key value of the item - // collection. This is the same as the partition key value of the item. - // - // * - // SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This - // is a two-element array containing a lower bound and an upper bound for the - // estimate. The estimate includes the size of all the items in the table, plus the - // size of all attributes projected into all of the local secondary indexes on the - // table. Use this estimate to measure whether a local secondary index is - // approaching its size limit. The estimate is subject to change over time; - // therefore, do not rely on the precision or accuracy of the estimate. + // - ItemCollectionKey - The partition key value of the item collection. This is + // the same as the partition key value of the item. + // - SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. + // This is a two-element array containing a lower bound and an upper bound for the + // estimate. The estimate includes the size of all the items in the table, plus the + // size of all attributes projected into all of the local secondary indexes on the + // table. Use this estimate to measure whether a local secondary index is + // approaching its size limit. The estimate is subject to change over time; + // therefore, do not rely on the precision or accuracy of the estimate. ItemCollectionMetrics map[string][]types.ItemCollectionMetrics // A map of tables and requests against those tables that were not processed. The - // UnprocessedItems value is in the same form as RequestItems, so you can provide + // UnprocessedItems value is in the same form as RequestItems , so you can provide // this value directly to a subsequent BatchWriteItem operation. For more // information, see RequestItems in the Request Parameters section. Each // UnprocessedItems entry consists of a table name and, for that table, a list of - // operations to perform (DeleteRequest or PutRequest). - // - // * DeleteRequest - Perform - // a DeleteItem operation on the specified item. The item to be deleted is - // identified by a Key subelement: - // - // * Key - A map of primary key attribute values - // that uniquely identify the item. Each entry in this map consists of an attribute - // name and an attribute value. - // - // * PutRequest - Perform a PutItem operation on the - // specified item. The item to be put is identified by an Item subelement: - // - // * Item - // - A map of attributes 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. - // - // If there are no - // unprocessed items remaining, the response contains an empty UnprocessedItems - // map. + // operations to perform ( DeleteRequest or PutRequest ). + // - DeleteRequest - Perform a DeleteItem operation on the specified item. The + // item to be deleted is identified by a Key subelement: + // - Key - A map of primary key attribute values that uniquely identify the item. + // Each entry in this map consists of an attribute name and an attribute value. + // - PutRequest - Perform a PutItem operation on the specified item. The item to + // be put is identified by an Item subelement: + // - Item - A map of attributes 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. + // If there are no unprocessed items remaining, the response contains an empty + // UnprocessedItems map. UnprocessedItems map[string][]types.WriteRequest // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_CreateBackup.go b/service/dynamodb/api_op_CreateBackup.go index f1a382e8ff9..486fcf1e94f 100644 --- a/service/dynamodb/api_op_CreateBackup.go +++ b/service/dynamodb/api_op_CreateBackup.go @@ -27,15 +27,10 @@ import ( // 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: -// -// * Global secondary indexes (GSIs) -// -// * Local secondary -// indexes (LSIs) -// -// * Streams -// -// * Provisioned read and write capacity +// - Global secondary indexes (GSIs) +// - Local secondary indexes (LSIs) +// - Streams +// - Provisioned read and write capacity func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) { if params == nil { params = &CreateBackupInput{} diff --git a/service/dynamodb/api_op_CreateGlobalTable.go b/service/dynamodb/api_op_CreateGlobalTable.go index 79009e60995..426bcb73936 100644 --- a/service/dynamodb/api_op_CreateGlobalTable.go +++ b/service/dynamodb/api_op_CreateGlobalTable.go @@ -16,58 +16,40 @@ import ( // 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. This operation only applies to Version 2017.11.29 -// (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). -// If you want to add a new replica table to a global table, each of the following -// conditions must be true: +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . If you want to add a new replica table to a global table, each of the +// following conditions must be true: +// - The table must have the same primary key as all of the other replicas. +// - The table must have the same name as all of the other replicas. +// - The table must have DynamoDB Streams enabled, with the stream containing +// both the new and the old images of the item. +// - None of the replica tables in the global table can contain any data. // -// * The table must have the same primary key as all of -// the other replicas. +// If global secondary indexes are specified, then the following conditions must +// also be met: +// - The global secondary indexes must have the same name. +// - The global secondary indexes must have the same hash key and sort key (if +// present). // -// * The table must have the same name as all of the other -// replicas. +// If local secondary indexes are specified, then the following conditions must +// also be met: +// - The local secondary indexes must have the same name. +// - The local secondary indexes must have the same hash key and sort key (if +// present). // -// * The table must have DynamoDB Streams enabled, with the stream -// containing both the new and the old images of the item. -// -// * None of the replica -// tables in the global table can contain any data. -// -// If global secondary indexes -// are specified, then the following conditions must also be met: -// -// * The global -// secondary indexes must have the same name. -// -// * The global secondary indexes must -// have the same hash key and sort key (if present). -// -// If local secondary indexes -// are specified, then the following conditions must also be met: -// -// * The local -// secondary indexes must have the same name. -// -// * The local secondary indexes must -// have the same hash key and sort key (if present). -// -// Write capacity settings -// should be set consistently across your replica tables and secondary indexes. -// DynamoDB strongly recommends enabling auto scaling to manage the write capacity -// settings for all of your global tables replicas and indexes. If you prefer to -// manage write capacity settings manually, you should provision equal replicated -// write capacity units to your replica tables. You should also provision equal -// replicated write capacity units to matching secondary indexes across your global -// table. +// Write capacity settings should be set consistently across your replica tables +// and secondary indexes. DynamoDB strongly recommends enabling auto scaling to +// manage the write capacity settings for all of your global tables replicas and +// indexes. If you prefer to manage write capacity settings manually, you should +// provision equal replicated write capacity units to your replica tables. You +// should also provision equal replicated write capacity units to matching +// secondary indexes across your global table. func (c *Client) CreateGlobalTable(ctx context.Context, params *CreateGlobalTableInput, optFns ...func(*Options)) (*CreateGlobalTableOutput, error) { if params == nil { params = &CreateGlobalTableInput{} diff --git a/service/dynamodb/api_op_CreateTable.go b/service/dynamodb/api_op_CreateTable.go index af6bd7b54bd..2d62d4c7b06 100644 --- a/service/dynamodb/api_op_CreateTable.go +++ b/service/dynamodb/api_op_CreateTable.go @@ -17,14 +17,14 @@ import ( // Services 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. CreateTable is an asynchronous operation. Upon receiving a CreateTable -// request, DynamoDB immediately returns a response with a TableStatus of CREATING. -// After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can +// request, DynamoDB immediately returns a response with a TableStatus of CREATING +// . After the table is created, DynamoDB sets the TableStatus to ACTIVE . You can // perform read and write operations only on an ACTIVE table. You can optionally -// define secondary indexes on the new table, as part of the CreateTable operation. -// If you want to create multiple tables with secondary indexes on them, you must -// create the tables sequentially. Only one table with secondary indexes can be in -// the CREATING state at any given time. You can use the DescribeTable action to -// check the table status. +// define secondary indexes on the new table, as part of the CreateTable +// operation. If you want to create multiple tables with secondary indexes on them, +// you must create the tables sequentially. Only one table with secondary indexes +// can be in the CREATING state at any given time. You can use the DescribeTable +// action to check the table status. func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { params = &CreateTableInput{} @@ -50,21 +50,13 @@ type CreateTableInput struct { // Specifies the attributes that make up the primary key for a table or an index. // The attributes in KeySchema must also be defined in the AttributeDefinitions - // array. For more information, see Data Model - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html) + // array. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html) // in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is // composed of: - // - // * AttributeName - The name of this key attribute. - // - // * KeyType - The - // role that the key attribute will assume: - // - // * HASH - partition key - // - // * RANGE - sort - // key - // + // - AttributeName - The name of this key attribute. + // - KeyType - The role that the key attribute will assume: + // - 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 the DynamoDB usage of an internal hash function to // evenly distribute data items across partitions, based on their partition key @@ -72,11 +64,10 @@ type CreateTableInput struct { // "range attribute" derives from the way DynamoDB stores items with the same // partition key physically close together, in sorted order by the sort key value. // For a simple primary key (partition key), you must provide exactly one element - // with a KeyType of HASH. For a composite primary key (partition key and sort + // with a KeyType of HASH . For a composite primary key (partition key and sort // key), you must provide 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 Working with Tables - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key) + // must have a KeyType of HASH , and the second element must have a KeyType of + // RANGE . 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. // // This member is required. @@ -89,16 +80,12 @@ type CreateTableInput struct { // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. - // - // * PROVISIONED - We recommend using - // PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to - // Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - // - // * - // PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable - // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + // - PROVISIONED - We recommend using PROVISIONED for predictable workloads. + // PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual) + // . + // - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable + // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand) + // . BillingMode types.BillingMode // Indicates whether deletion protection is to be enabled (true) or disabled @@ -107,40 +94,25 @@ type CreateTableInput struct { // One or more global secondary indexes (the maximum is 20) to be created on the // table. Each global secondary index in the array includes the following: - // - // * - // IndexName - The name of the global secondary index. Must be unique only for this - // table. - // - // * KeySchema - Specifies the key schema for the global secondary - // index. - // - // * Projection - Specifies attributes that are copied (projected) from the - // table into the index. These are in addition to the primary key attributes and - // index key attributes, which are automatically projected. Each attribute - // 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 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 across all of the - // secondary indexes, must not exceed 100. If you project the same attribute into - // two different indexes, this counts as two distinct attributes when determining - // the total. - // - // * ProvisionedThroughput - The provisioned throughput settings for - // the global secondary index, consisting of read and write capacity units. + // - IndexName - The name of the global secondary index. Must be unique only for + // this table. + // - KeySchema - Specifies the key schema for the global secondary index. + // - Projection - Specifies attributes that are copied (projected) from the table + // into the index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. Each attribute 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 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 across all of the secondary indexes, must not exceed + // 100. If you project the same attribute into two different indexes, this counts + // as two distinct attributes when determining the total. + // - ProvisionedThroughput - The provisioned throughput settings for the global + // secondary index, consisting of read and write capacity units. GlobalSecondaryIndexes []types.GlobalSecondaryIndex // One or more local secondary indexes (the maximum is 5) to be created on the @@ -148,46 +120,32 @@ type CreateTableInput struct { // size limit per partition key value; otherwise, the size of a local secondary // index is unconstrained. Each local secondary index in the array includes the // following: - // - // * IndexName - The name of the local secondary index. Must be unique - // only for this table. - // - // * KeySchema - Specifies the key schema for the local - // secondary index. The key schema must begin with the same partition key as the - // table. - // - // * Projection - Specifies attributes that are copied (projected) from the - // table into the index. These are in addition to the primary key attributes and - // index key attributes, which are automatically projected. Each attribute - // 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 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 across all of the - // secondary indexes, must not exceed 100. If you project the same attribute into - // two different indexes, this counts as two distinct attributes when determining - // the total. + // - IndexName - The name of the local secondary index. Must be unique only for + // this table. + // - KeySchema - Specifies the key schema for the local secondary index. The key + // schema must begin with the same partition key as the table. + // - Projection - Specifies attributes that are copied (projected) from the table + // into the index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. Each attribute 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 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 across all of the secondary indexes, must not exceed + // 100. If you project the same attribute into two different indexes, this counts + // as two distinct attributes when determining the total. LocalSecondaryIndexes []types.LocalSecondaryIndex // Represents the provisioned throughput settings for a specified table or index. // The settings can be modified using the UpdateTable operation. If you set - // BillingMode as PROVISIONED, you must specify this property. If you set - // BillingMode as PAY_PER_REQUEST, you cannot specify this property. For current + // BillingMode as PROVISIONED , you must specify this property. If you set + // BillingMode as PAY_PER_REQUEST , you cannot specify this property. For current // minimum and maximum provisioned throughput values, see Service, Account, and - // Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *types.ProvisionedThroughput @@ -195,36 +153,28 @@ type CreateTableInput struct { SSESpecification *types.SSESpecification // The settings for DynamoDB Streams on the table. These settings consist of: - // - // * - // 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 for StreamViewType are: - // - // * KEYS_ONLY - Only the key attributes of - // the modified item are written to the stream. - // - // * NEW_IMAGE - The entire item, as - // it appears after it was modified, is written to the stream. - // - // * OLD_IMAGE - The - // entire item, as it appeared before it was modified, is written to the stream. - // - // * - // NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are - // written to the stream. + // - 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 for + // StreamViewType are: + // - KEYS_ONLY - Only the key attributes of the modified item are written to the + // stream. + // - NEW_IMAGE - The entire item, as it appears after it was modified, is written + // to the stream. + // - OLD_IMAGE - The entire item, as it appeared before it was modified, is + // written to the stream. + // - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are + // written to the stream. StreamSpecification *types.StreamSpecification // The table class of the new table. Valid values are STANDARD and - // STANDARD_INFREQUENT_ACCESS. + // STANDARD_INFREQUENT_ACCESS . TableClass types.TableClass // A list of key-value pairs to label the table. For more information, see Tagging - // for DynamoDB - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html). + // for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_DeleteItem.go b/service/dynamodb/api_op_DeleteItem.go index 95d94ff396a..e49e9df23e2 100644 --- a/service/dynamodb/api_op_DeleteItem.go +++ b/service/dynamodb/api_op_DeleteItem.go @@ -16,12 +16,12 @@ import ( // Deletes a single item in a table by primary key. You can perform a conditional // delete operation that deletes the item if it exists, or if it has an expected // attribute value. In addition to deleting an item, you can also return the item's -// attribute values in the same operation, using the ReturnValues parameter. Unless -// you specify conditions, the DeleteItem is an idempotent operation; running it -// multiple times on the same item or attribute does not result in an error -// response. Conditional deletes are useful for deleting items only if specific -// conditions are met. If those conditions are met, DynamoDB performs the delete. -// Otherwise, the item is not deleted. +// attribute values in the same operation, using the ReturnValues parameter. +// Unless you specify conditions, the DeleteItem is an idempotent operation; +// running it multiple times on the same item or attribute does not result in an +// error response. Conditional deletes are useful for deleting items only if +// specific conditions are met. If those conditions are met, DynamoDB performs the +// delete. Otherwise, the item is not deleted. func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns ...func(*Options)) (*DeleteItemOutput, error) { if params == nil { params = &DeleteItemInput{} @@ -40,8 +40,8 @@ func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns // Represents the input of a DeleteItem operation. type DeleteItemInput struct { - // A map of attribute names to AttributeValue objects, representing the primary key - // of the item to delete. For the primary key, you must provide all of the key + // A map of attribute names to AttributeValue objects, representing the primary + // key of the item to delete. For the primary key, you must provide all of the key // attributes. For example, with a simple primary key, you only need to provide a // value for the partition key. For a composite primary key, you must provide // values for both the partition key and the sort key. @@ -56,73 +56,45 @@ type DeleteItemInput struct { // A condition that must be satisfied in order for a conditional DeleteItem to // succeed. An expression can contain any of the following: - // - // * Functions: - // attribute_exists | attribute_not_exists | attribute_type | contains | - // begins_with | size These function names are case-sensitive. - // - // * Comparison - // operators: = | <> | < | > | <= | >= | BETWEEN | IN - // - // * Logical operators: AND | - // OR | NOT - // - // For more information about condition expressions, see Condition - // Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // - Functions: attribute_exists | attribute_not_exists | attribute_type | + // contains | begins_with | size These function names are case-sensitive. + // - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN + // - Logical operators: AND | OR | NOT + // 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 // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) // in the Amazon DynamoDB Developer Guide. Expected map[string]types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -134,49 +106,38 @@ type DeleteItemInput struct { // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // 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]types.AttributeValue // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // Determines whether item collection metrics are returned. If set to SIZE, the + // Determines whether item collection metrics are returned. If set to SIZE , the // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. + // during the operation are returned in the response. If set to NONE (the + // default), no statistics are returned. ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics // Use ReturnValues if you want to get the item attributes as they appeared before - // they were deleted. For DeleteItem, the valid values are: - // - // * NONE - If - // ReturnValues is not specified, or if its value is NONE, then nothing is - // returned. (This setting is the default for ReturnValues.) - // - // * ALL_OLD - The - // content of the old item is returned. - // - // There is no additional cost associated - // with requesting a return value aside from the small network and processing - // overhead of receiving a larger response. No read capacity units are consumed. - // The ReturnValues parameter is used by several DynamoDB operations; however, - // DeleteItem does not recognize any values other than NONE or ALL_OLD. + // they were deleted. For DeleteItem , the valid values are: + // - NONE - If ReturnValues is not specified, or if its value is NONE , then + // nothing is returned. (This setting is the default for ReturnValues .) + // - ALL_OLD - The content of the old item is returned. + // There is no additional cost associated with requesting a return value aside + // from the small network and processing overhead of receiving a larger response. + // No read capacity units are consumed. The ReturnValues parameter is used by + // several DynamoDB operations; however, DeleteItem does not recognize any values + // other than NONE or ALL_OLD . ReturnValues types.ReturnValue noSmithyDocumentSerde @@ -194,8 +155,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) + // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity @@ -204,19 +164,15 @@ type DeleteItemOutput struct { // ReturnItemCollectionMetrics parameter was specified. If the table does not have // any local secondary indexes, this information is not returned in the response. // Each ItemCollectionMetrics element consists of: - // - // * ItemCollectionKey - The - // partition key value of the item collection. This is the same as the partition - // key value of the item itself. - // - // * SizeEstimateRangeGB - An estimate of item - // collection size, in gigabytes. This value is a two-element array containing a - // lower bound and an upper bound for the estimate. The estimate includes the size - // of all the items in the table, plus the size of all attributes projected into - // all of the local secondary indexes on that table. Use this estimate to measure - // whether a local secondary index is approaching its size limit. The estimate is - // subject to change over time; therefore, do not rely on the precision or accuracy - // of the estimate. + // - ItemCollectionKey - The partition key value of the item collection. This is + // the same as the partition key value of the item itself. + // - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. + // This value is a two-element array containing a lower bound and an upper bound + // for the estimate. The estimate includes the size of all the items in the table, + // plus the size of all attributes projected into all of the local secondary + // indexes on that table. Use this estimate to measure whether a local secondary + // index is approaching its size limit. The estimate is subject to change over + // time; therefore, do not rely on the precision or accuracy of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_DeleteTable.go b/service/dynamodb/api_op_DeleteTable.go index c204ac8f2c0..7f86db4d46d 100644 --- a/service/dynamodb/api_op_DeleteTable.go +++ b/service/dynamodb/api_op_DeleteTable.go @@ -14,20 +14,20 @@ import ( ) // The DeleteTable operation deletes a table and all of its items. After a -// DeleteTable request, the specified table is in the DELETING state until DynamoDB -// completes the deletion. If the table is in the ACTIVE state, you can delete it. -// If a table is in CREATING or UPDATING states, then DynamoDB returns a -// ResourceInUseException. If the specified table does not exist, DynamoDB returns -// a ResourceNotFoundException. If table is already in the DELETING state, no error -// is returned. This operation only applies to Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// DeleteTable request, the specified table is in the DELETING state until +// DynamoDB completes the deletion. If the table is in the ACTIVE state, you can +// delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns +// a ResourceInUseException . If the specified table does not exist, DynamoDB +// returns a ResourceNotFoundException . If table is already in the DELETING +// state, no error is returned. This operation only applies to Version 2019.11.21 +// (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // of global tables. DynamoDB might continue to accept data read and write -// operations, such as GetItem and PutItem, on a table in the DELETING state until -// the table deletion is complete. When you delete a table, any indexes on that -// table are also deleted. If you have DynamoDB Streams enabled on the table, then -// the corresponding stream on that table goes into the DISABLED state, and the -// stream is automatically deleted after 24 hours. Use the DescribeTable action to -// check the status of the table. +// operations, such as GetItem and PutItem , on a table in the DELETING state +// until the table deletion is complete. When you delete a table, any indexes on +// that table are also deleted. If you have DynamoDB Streams enabled on the table, +// then the corresponding stream on that table goes into the DISABLED state, and +// the stream is automatically deleted after 24 hours. Use the DescribeTable +// action to check the status of the table. func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) { if params == nil { params = &DeleteTableInput{} diff --git a/service/dynamodb/api_op_DescribeContinuousBackups.go b/service/dynamodb/api_op_DescribeContinuousBackups.go index b09fbcbc9e6..6af245a1eaa 100644 --- a/service/dynamodb/api_op_DescribeContinuousBackups.go +++ b/service/dynamodb/api_op_DescribeContinuousBackups.go @@ -14,14 +14,14 @@ import ( ) // Checks the status of continuous backups and point in time recovery on the -// specified table. Continuous backups are ENABLED on all tables at table creation. -// If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to -// ENABLED. 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. You can call DescribeContinuousBackups at a maximum rate of 10 -// times per second. +// specified table. Continuous backups are ENABLED on all tables at table +// creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will +// be set to ENABLED. 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. You can call DescribeContinuousBackups at a maximum rate of +// 10 times per second. func (c *Client) DescribeContinuousBackups(ctx context.Context, params *DescribeContinuousBackupsInput, optFns ...func(*Options)) (*DescribeContinuousBackupsOutput, error) { if params == nil { params = &DescribeContinuousBackupsInput{} diff --git a/service/dynamodb/api_op_DescribeContributorInsights.go b/service/dynamodb/api_op_DescribeContributorInsights.go index df7316bdbea..5a79fadaa5d 100644 --- a/service/dynamodb/api_op_DescribeContributorInsights.go +++ b/service/dynamodb/api_op_DescribeContributorInsights.go @@ -50,23 +50,17 @@ type DescribeContributorInsightsOutput struct { // Current status of contributor insights. ContributorInsightsStatus types.ContributorInsightsStatus - // Returns information about the last failure that was encountered. The most common - // exceptions for a FAILED status are: - // - // * LimitExceededException - Per-account - // Amazon CloudWatch Contributor Insights rule limit reached. Please disable - // Contributor Insights for other tables/indexes OR disable Contributor Insights - // rules before retrying. - // - // * AccessDeniedException - Amazon CloudWatch Contributor - // Insights rules cannot be modified due to insufficient permissions. - // - // * - // AccessDeniedException - Failed to create service-linked role for Contributor - // Insights due to insufficient permissions. - // - // * InternalServerError - Failed to - // create Amazon CloudWatch Contributor Insights rules. Please retry request. + // Returns information about the last failure that was encountered. The most + // common exceptions for a FAILED status are: + // - LimitExceededException - Per-account Amazon CloudWatch Contributor Insights + // rule limit reached. Please disable Contributor Insights for other tables/indexes + // OR disable Contributor Insights rules before retrying. + // - AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot + // be modified due to insufficient permissions. + // - AccessDeniedException - Failed to create service-linked role for + // Contributor Insights due to insufficient permissions. + // - InternalServerError - Failed to create Amazon CloudWatch Contributor + // Insights rules. Please retry request. FailureException *types.FailureException // The name of the global secondary index being described. diff --git a/service/dynamodb/api_op_DescribeEndpoints.go b/service/dynamodb/api_op_DescribeEndpoints.go index b9e2177d2e8..5b64e57da82 100644 --- a/service/dynamodb/api_op_DescribeEndpoints.go +++ b/service/dynamodb/api_op_DescribeEndpoints.go @@ -14,8 +14,8 @@ import ( // Returns the regional endpoint information. This action must be included in your // VPC endpoint policies, or access to the DescribeEndpoints API will be denied. // For more information on policy permissions, please see Internetwork traffic -// privacy -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints). +// privacy (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints) +// . func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpointsInput, optFns ...func(*Options)) (*DescribeEndpointsOutput, error) { if params == nil { params = &DescribeEndpointsInput{} diff --git a/service/dynamodb/api_op_DescribeGlobalTable.go b/service/dynamodb/api_op_DescribeGlobalTable.go index 90fbc18f798..707b1b792d9 100644 --- a/service/dynamodb/api_op_DescribeGlobalTable.go +++ b/service/dynamodb/api_op_DescribeGlobalTable.go @@ -14,17 +14,14 @@ import ( ) // Returns information about the specified global table. This operation only -// applies to Version 2017.11.29 (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . func (c *Client) DescribeGlobalTable(ctx context.Context, params *DescribeGlobalTableInput, optFns ...func(*Options)) (*DescribeGlobalTableOutput, error) { if params == nil { params = &DescribeGlobalTableInput{} diff --git a/service/dynamodb/api_op_DescribeGlobalTableSettings.go b/service/dynamodb/api_op_DescribeGlobalTableSettings.go index 5bc4e250335..c1c874e7232 100644 --- a/service/dynamodb/api_op_DescribeGlobalTableSettings.go +++ b/service/dynamodb/api_op_DescribeGlobalTableSettings.go @@ -14,17 +14,14 @@ import ( ) // Describes Region-specific settings for a global table. This operation only -// applies to Version 2017.11.29 (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . func (c *Client) DescribeGlobalTableSettings(ctx context.Context, params *DescribeGlobalTableSettingsInput, optFns ...func(*Options)) (*DescribeGlobalTableSettingsOutput, error) { if params == nil { params = &DescribeGlobalTableSettingsInput{} diff --git a/service/dynamodb/api_op_DescribeImport.go b/service/dynamodb/api_op_DescribeImport.go index 8c3a3190692..99624cfc035 100644 --- a/service/dynamodb/api_op_DescribeImport.go +++ b/service/dynamodb/api_op_DescribeImport.go @@ -39,8 +39,8 @@ type DescribeImportInput struct { type DescribeImportOutput struct { - // Represents the properties of the table created for the import, and parameters of - // the import. The import parameters include import status, how many items were + // Represents the properties of the table created for the import, and parameters + // of the import. The import parameters include import status, how many items were // processed, and how many errors were encountered. // // This member is required. diff --git a/service/dynamodb/api_op_DescribeLimits.go b/service/dynamodb/api_op_DescribeLimits.go index 404e4b82caa..736d5fa410c 100644 --- a/service/dynamodb/api_op_DescribeLimits.go +++ b/service/dynamodb/api_op_DescribeLimits.go @@ -18,54 +18,38 @@ import ( // the account has initial quotas 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 quotas that apply when you create a -// table there. For more information, see Service, Account, and Table Quotas -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) +// table there. For more information, see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // page in the Amazon DynamoDB Developer Guide. Although you can increase these -// quotas by filing a case at Amazon Web Services Support Center -// (https://console.aws.amazon.com/support/home#/), obtaining the increase is not -// instantaneous. The DescribeLimits action lets you write code to compare the -// capacity you are currently using to those quotas imposed by your account so that -// you have enough time to apply for an increase before you hit a quota. For -// example, you could use one of the Amazon Web Services SDKs to do the -// following: +// quotas by filing a case at Amazon Web Services Support Center (https://console.aws.amazon.com/support/home#/) +// , obtaining the increase is not instantaneous. The DescribeLimits action lets +// you write code to compare the capacity you are currently using to those quotas +// imposed by your account so that you have enough time to apply for an increase +// before you hit a quota. For example, you could use one of the Amazon Web +// Services SDKs to do the following: +// - Call DescribeLimits for a particular Region to obtain your current account +// quotas 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 +// units. Zero them both. +// - Call ListTables to obtain a list of all your DynamoDB tables. +// - For each table name listed by ListTables , do the following: +// - Call DescribeTable with the table name. +// - Use the data returned by DescribeTable to add the read capacity units and +// write capacity units provisioned for the table itself to your variables. +// - If the table has one or more global secondary indexes (GSIs), loop over +// these GSIs and add their provisioned capacity values to your variables as well. +// - Report the account quotas for that Region returned by DescribeLimits , along +// with the total current provisioned capacity levels you have calculated. // -// * Call DescribeLimits for a particular Region to obtain your current -// account quotas 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 units. Zero them both. -// -// * Call -// ListTables to obtain a list of all your DynamoDB tables. -// -// * For each table name -// listed by ListTables, do the following: -// -// * Call DescribeTable with the table -// name. -// -// * Use the data returned by DescribeTable to add the read capacity units -// and write capacity units provisioned for the table itself to your variables. -// -// * -// If the table has one or more global secondary indexes (GSIs), loop over these -// GSIs and add their provisioned capacity values to your variables as well. -// -// * -// Report the account quotas 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 quotas. The -// per-table quotas apply only when you are creating a new table. They restrict the -// sum of the provisioned capacity of the new table itself and all its global -// secondary indexes. For existing tables and their GSIs, DynamoDB doesn't let you -// increase provisioned capacity extremely rapidly, but the only quota that applies -// is that the aggregate provisioned capacity over all your tables and GSIs cannot -// exceed either of the per-account quotas. DescribeLimits should only be called -// periodically. You can expect throttling errors if you call it more than once in -// a minute. The DescribeLimits Request element has no content. +// This will let you see whether you are getting close to your account-level +// quotas. The per-table quotas apply only when you are creating a new table. They +// restrict the sum of the provisioned capacity of the new table itself and all its +// global secondary indexes. For existing tables and their GSIs, DynamoDB doesn't +// let you increase provisioned capacity extremely rapidly, but the only quota that +// applies is that the aggregate provisioned capacity over all your tables and GSIs +// cannot exceed either of the per-account quotas. DescribeLimits should only be +// called periodically. You can expect throttling errors if you call it more than +// once in a minute. The DescribeLimits Request element has no content. func (c *Client) DescribeLimits(ctx context.Context, params *DescribeLimitsInput, optFns ...func(*Options)) (*DescribeLimitsOutput, error) { if params == nil { params = &DescribeLimitsInput{} @@ -93,8 +77,8 @@ type DescribeLimitsOutput struct { // across all of your tables in this Region. AccountMaxReadCapacityUnits *int64 - // The maximum total write capacity units that your account allows you to provision - // across all of your tables in this Region. + // The maximum total write capacity units that your account allows you to + // provision across all of your tables in this Region. AccountMaxWriteCapacityUnits *int64 // The maximum read capacity units that your account allows you to provision for a @@ -102,8 +86,8 @@ type DescribeLimitsOutput struct { // units provisioned for its global secondary indexes (GSIs). TableMaxReadCapacityUnits *int64 - // 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 capacity + // 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 capacity // units provisioned for its global secondary indexes (GSIs). TableMaxWriteCapacityUnits *int64 diff --git a/service/dynamodb/api_op_DescribeTable.go b/service/dynamodb/api_op_DescribeTable.go index c5f63b84ab3..599c8fe1d53 100644 --- a/service/dynamodb/api_op_DescribeTable.go +++ b/service/dynamodb/api_op_DescribeTable.go @@ -20,10 +20,9 @@ import ( // Returns information about the table, including the current status of the table, // when it was created, the primary key schema, and any indexes on the table. This -// operation only applies to Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // of global tables. If you issue a DescribeTable request immediately after a -// CreateTable request, DynamoDB might return a ResourceNotFoundException. This is +// CreateTable request, DynamoDB might return a ResourceNotFoundException . This is // because DescribeTable uses an eventually consistent query, and the metadata for // your table might not be available at that moment. Wait for a few seconds, and // then try the DescribeTable request again. @@ -197,9 +196,9 @@ type TableExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TableExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TableExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -363,9 +362,9 @@ type TableNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TableNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TableNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go b/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go index 0702643eca5..4acb11f7f7a 100644 --- a/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go +++ b/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go @@ -12,8 +12,7 @@ import ( ) // Describes auto scaling settings across replicas of the global table at once. -// This operation only applies to Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// This operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // of global tables. func (c *Client) DescribeTableReplicaAutoScaling(ctx context.Context, params *DescribeTableReplicaAutoScalingInput, optFns ...func(*Options)) (*DescribeTableReplicaAutoScalingOutput, error) { if params == nil { diff --git a/service/dynamodb/api_op_ExecuteStatement.go b/service/dynamodb/api_op_ExecuteStatement.go index 9bb0956a1a4..f7d19e7bf09 100644 --- a/service/dynamodb/api_op_ExecuteStatement.go +++ b/service/dynamodb/api_op_ExecuteStatement.go @@ -12,7 +12,7 @@ import ( ) // This operation allows you to perform reads and singleton writes on data stored -// in DynamoDB, using PartiQL. For PartiQL reads (SELECT statement), if the total +// in DynamoDB, using PartiQL. For PartiQL reads ( SELECT statement), if the total // number of processed items exceeds the maximum dataset size limit of 1 MB, the // read stops and results are returned to the user as a LastEvaluatedKey value to // continue the read in a subsequent operation. If the filter criteria in WHERE @@ -21,7 +21,7 @@ import ( // (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any // filtering to the results using WHERE clause). If LastEvaluatedKey is present in // the response, you need to paginate the result set. If NextToken is present, you -// need to paginate the result set and include NextToken. +// need to paginate the result set and include NextToken . func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error) { if params == nil { params = &ExecuteStatementInput{} @@ -44,7 +44,7 @@ type ExecuteStatementInput struct { // This member is required. Statement *string - // The consistency of a read operation. If set to true, then a strongly consistent + // The consistency of a read operation. If set to true , then a strongly consistent // read is used; otherwise, an eventually consistent read is used. ConsistentRead *bool @@ -67,19 +67,14 @@ type ExecuteStatementInput struct { // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde @@ -90,8 +85,7 @@ type ExecuteStatementOutput struct { // The capacity units consumed by an 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 - // request asked for it. For more information, see Provisioned Throughput - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // request asked for it. For more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity diff --git a/service/dynamodb/api_op_ExecuteTransaction.go b/service/dynamodb/api_op_ExecuteTransaction.go index 267702bf32d..b79e8da2554 100644 --- a/service/dynamodb/api_op_ExecuteTransaction.go +++ b/service/dynamodb/api_op_ExecuteTransaction.go @@ -17,8 +17,7 @@ import ( // read statements or write statements, you cannot mix both in one transaction. The // EXISTS function is an exception and can be used to check the condition of // specific attributes of the item in a similar manner to ConditionCheck in the -// TransactWriteItems -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems) +// TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems) // API. func (c *Client) ExecuteTransaction(ctx context.Context, params *ExecuteTransactionInput, optFns ...func(*Options)) (*ExecuteTransactionOutput, error) { if params == nil { @@ -48,10 +47,9 @@ type ExecuteTransactionInput struct { // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response. For more information, see - // TransactGetItems - // (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html) - // and TransactWriteItems - // (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html). + // TransactGetItems (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html) + // and TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html) + // . ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_ExportTableToPointInTime.go b/service/dynamodb/api_op_ExportTableToPointInTime.go index 66f6821e62e..cc7380c8a8f 100644 --- a/service/dynamodb/api_op_ExportTableToPointInTime.go +++ b/service/dynamodb/api_op_ExportTableToPointInTime.go @@ -51,11 +51,11 @@ type ExportTableToPointInTimeInput struct { // token for more than 8 hours, 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 8-hour idempotency window, DynamoDB returns an - // ImportConflictException. + // ImportConflictException . ClientToken *string // The format for the exported data. Valid values for ExportFormat are - // DYNAMODB_JSON or ION. + // DYNAMODB_JSON or ION . ExportFormat types.ExportFormat // Time in the past from which to export table data, counted in seconds from the @@ -73,11 +73,8 @@ type ExportTableToPointInTimeInput struct { // Type of encryption used on the bucket where export data will be stored. Valid // values for S3SseAlgorithm are: - // - // * AES256 - server-side encryption with Amazon S3 - // managed keys - // - // * KMS - server-side encryption with KMS managed keys + // - AES256 - server-side encryption with Amazon S3 managed keys + // - KMS - server-side encryption with KMS managed keys S3SseAlgorithm types.S3SseAlgorithm // The ID of the KMS managed key used to encrypt the S3 bucket where export data diff --git a/service/dynamodb/api_op_GetItem.go b/service/dynamodb/api_op_GetItem.go index aacb4d2eacc..03e02725972 100644 --- a/service/dynamodb/api_op_GetItem.go +++ b/service/dynamodb/api_op_GetItem.go @@ -17,9 +17,9 @@ import ( // primary key. If there is no matching item, GetItem does not return any data and // there will be no Item element in the response. GetItem provides an eventually // consistent read by default. If your application requires a strongly consistent -// read, set ConsistentRead to true. Although a strongly consistent read might take -// more time than an eventually consistent read, it always returns the last updated -// value. +// read, set ConsistentRead to true . Although a strongly consistent read might +// take more time than an eventually consistent read, it always returns the last +// updated value. func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...func(*Options)) (*GetItemOutput, error) { if params == nil { params = &GetItemInput{} @@ -38,8 +38,8 @@ func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...fu // Represents the input of a GetItem operation. type GetItemInput struct { - // A map of attribute names to AttributeValue objects, representing the primary key - // of the item to retrieve. For the primary key, you must provide all of the + // A map of attribute names to AttributeValue objects, representing the primary + // key of the item to retrieve. For the primary key, you must provide all of the // attributes. For example, with a simple primary key, you only need to provide a // value for the partition key. For a composite primary key, you must provide // values for both the partition key and the sort key. @@ -53,54 +53,36 @@ type GetItemInput struct { TableName *string // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []string - // Determines the read consistency model: If set to true, then the operation uses + // Determines the read consistency model: If set to true , then the operation uses // strongly consistent reads; otherwise, the operation uses eventually consistent // reads. ConsistentRead *bool // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -109,26 +91,20 @@ type GetItemInput struct { // attributes in the expression must be separated by commas. 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde @@ -137,17 +113,16 @@ type GetItemInput struct { // Represents the output of a GetItem operation. type GetItemOutput struct { - // The capacity units consumed by the GetItem 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/ProvisionedThroughput.html#ItemSizeCalculations.Reads) + // The capacity units consumed by the GetItem 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/ProvisionedThroughput.html#ItemSizeCalculations.Reads) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity // A map of attribute names to AttributeValue objects, as specified by - // ProjectionExpression. + // ProjectionExpression . Item map[string]types.AttributeValue // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_ImportTable.go b/service/dynamodb/api_op_ImportTable.go index 763f8e49fa1..00d08b14c0d 100644 --- a/service/dynamodb/api_op_ImportTable.go +++ b/service/dynamodb/api_op_ImportTable.go @@ -30,8 +30,8 @@ func (c *Client) ImportTable(ctx context.Context, params *ImportTableInput, optF type ImportTableInput struct { - // The format of the source data. Valid values for ImportFormat are CSV, - // DYNAMODB_JSON or ION. + // The format of the source data. Valid values for ImportFormat are CSV , + // DYNAMODB_JSON or ION . // // This member is required. InputFormat types.InputFormat @@ -67,8 +67,8 @@ type ImportTableInput struct { type ImportTableOutput struct { - // Represents the properties of the table created for the import, and parameters of - // the import. The import parameters include import status, how many items were + // Represents the properties of the table created for the import, and parameters + // of the import. The import parameters include import status, how many items were // processed, and how many errors were encountered. // // This member is required. diff --git a/service/dynamodb/api_op_ListBackups.go b/service/dynamodb/api_op_ListBackups.go index ebff617a41d..845b27f8e24 100644 --- a/service/dynamodb/api_op_ListBackups.go +++ b/service/dynamodb/api_op_ListBackups.go @@ -14,8 +14,8 @@ import ( "time" ) -// List backups associated with an Amazon Web Services account. To list backups for -// a given table, specify TableName. ListBackups returns a paginated list of +// List backups associated with an Amazon Web Services account. To list backups +// for a given table, specify TableName . ListBackups returns a paginated list of // results with at most 1 MB worth of items in a page. You can also specify a // 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 boundaries are for the @@ -40,14 +40,10 @@ type ListBackupsInput struct { // The backups from the table specified by BackupType are listed. Where BackupType // can be: - // - // * USER - On-demand backup created by you. (The default setting if no - // other backup types are specified.) - // - // * SYSTEM - On-demand backup automatically - // created by DynamoDB. - // - // * ALL - All types of on-demand backups (USER and SYSTEM). + // - USER - On-demand backup created by you. (The default setting if no other + // backup types are specified.) + // - SYSTEM - On-demand backup automatically created by DynamoDB. + // - ALL - All types of on-demand backups (USER and SYSTEM). BackupType types.BackupTypeFilter // LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last @@ -82,11 +78,11 @@ type ListBackupsOutput struct { // 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. 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 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. + // the next page of results. 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 + // 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 // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_ListExports.go b/service/dynamodb/api_op_ListExports.go index 3395a00876c..d0098f8673e 100644 --- a/service/dynamodb/api_op_ListExports.go +++ b/service/dynamodb/api_op_ListExports.go @@ -34,7 +34,7 @@ type ListExportsInput struct { MaxResults *int32 // An optional string that, if supplied, must be copied from the output of a - // previous call to ListExports. When provided in this manner, the API fetches the + // previous call to ListExports . When provided in this manner, the API fetches the // next page of results. NextToken *string diff --git a/service/dynamodb/api_op_ListGlobalTables.go b/service/dynamodb/api_op_ListGlobalTables.go index 3e854b8b0bb..d18b9125568 100644 --- a/service/dynamodb/api_op_ListGlobalTables.go +++ b/service/dynamodb/api_op_ListGlobalTables.go @@ -14,17 +14,14 @@ import ( ) // Lists all global tables that have a replica in the specified Region. This -// operation only applies to Version 2017.11.29 (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . func (c *Client) ListGlobalTables(ctx context.Context, params *ListGlobalTablesInput, optFns ...func(*Options)) (*ListGlobalTablesOutput, error) { if params == nil { params = &ListGlobalTablesInput{} diff --git a/service/dynamodb/api_op_ListImports.go b/service/dynamodb/api_op_ListImports.go index df8575e134c..23d545b6ee6 100644 --- a/service/dynamodb/api_op_ListImports.go +++ b/service/dynamodb/api_op_ListImports.go @@ -31,7 +31,7 @@ func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optF type ListImportsInput struct { // An optional string that, if supplied, must be copied from the output of a - // previous call to ListImports. When provided in this manner, the API fetches the + // previous call to ListImports . When provided in this manner, the API fetches the // next page of results. NextToken *string diff --git a/service/dynamodb/api_op_ListTables.go b/service/dynamodb/api_op_ListTables.go index 4882b636fc2..2b4bad97d76 100644 --- a/service/dynamodb/api_op_ListTables.go +++ b/service/dynamodb/api_op_ListTables.go @@ -48,9 +48,9 @@ type ListTablesInput struct { // Represents the output of a ListTables operation. type ListTablesOutput struct { - // The name of the last table in the current page of results. Use this value as the - // ExclusiveStartTableName in a new request to obtain the next page of results, - // until all the table names are returned. If you do not receive a + // The name of the last table in the current page of results. Use this value as + // the ExclusiveStartTableName in a new request to obtain the next page of + // results, until all the table names are returned. If you do not receive a // LastEvaluatedTableName value in the response, this means that there are no more // table names to be retrieved. LastEvaluatedTableName *string diff --git a/service/dynamodb/api_op_ListTagsOfResource.go b/service/dynamodb/api_op_ListTagsOfResource.go index 1c62390ddf9..6abd8459b11 100644 --- a/service/dynamodb/api_op_ListTagsOfResource.go +++ b/service/dynamodb/api_op_ListTagsOfResource.go @@ -13,10 +13,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up -// to 10 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) +// List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource +// up to 10 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. func (c *Client) ListTagsOfResource(ctx context.Context, params *ListTagsOfResourceInput, optFns ...func(*Options)) (*ListTagsOfResourceOutput, error) { if params == nil { diff --git a/service/dynamodb/api_op_PutItem.go b/service/dynamodb/api_op_PutItem.go index c944a6a5cd3..9662b6aa54d 100644 --- a/service/dynamodb/api_op_PutItem.go +++ b/service/dynamodb/api_op_PutItem.go @@ -13,14 +13,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new item, or replaces an old item with a new item. If an item that has -// the same primary key as the new item already exists in the specified table, the -// new item completely replaces the existing item. You can perform a conditional -// put operation (add a new item if one with the specified primary key doesn't -// exist), or replace an existing item if it has certain attribute values. You can -// return the item's attribute values in the same operation, using the ReturnValues -// parameter. When you add an item, the primary key attributes are the only -// required attributes. Empty String and Binary attribute values are allowed. +// Creates a new item, or replaces an old item with a new item. If an item that +// has the same primary key as the new item already exists in the specified table, +// the new item completely replaces the existing item. You can perform a +// conditional put operation (add a new item if one with the specified primary key +// doesn't exist), or replace an existing item if it has certain attribute values. +// You can return the item's attribute values in the same operation, using the +// ReturnValues parameter. When you add an item, the primary key attributes are the +// only required attributes. Empty String and Binary attribute values are allowed. // Attribute values of type String and Binary must have a length greater than zero // if the attribute is used as a key attribute for a table or index. Set type // attributes cannot be empty. Invalid Requests with empty values will be rejected @@ -29,8 +29,7 @@ import ( // attribute_not_exists function with the name of the attribute being used as the // partition key for the table. Since every record must contain that attribute, the // attribute_not_exists function will only succeed if no matching item exists. For -// more information about PutItem, see Working with Items -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) +// more information about PutItem , see Working with Items (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) // in the Amazon DynamoDB Developer Guide. func (c *Client) PutItem(ctx context.Context, params *PutItemInput, optFns ...func(*Options)) (*PutItemOutput, error) { if params == nil { @@ -61,8 +60,7 @@ type PutItemInput struct { // Empty String and Binary attribute values are allowed. Attribute values of type // String and Binary must have a length greater than zero if the attribute is used // as a key attribute for a table or index. For more information about primary - // keys, see Primary Key - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey) + // 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. // @@ -76,73 +74,45 @@ type PutItemInput struct { // A condition that must be satisfied in order for a conditional PutItem operation // to succeed. An expression can contain any of the following: - // - // * Functions: - // attribute_exists | attribute_not_exists | attribute_type | contains | - // begins_with | size These function names are case-sensitive. - // - // * Comparison - // operators: = | <> | < | > | <= | >= | BETWEEN | IN - // - // * Logical operators: AND | - // OR | NOT - // - // For more information on condition expressions, see Condition - // Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // - Functions: attribute_exists | attribute_not_exists | attribute_type | + // contains | begins_with | size These function names are case-sensitive. + // - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN + // - Logical operators: AND | OR | NOT + // 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 // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) // in the Amazon DynamoDB Developer Guide. Expected map[string]types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -154,51 +124,39 @@ type PutItemInput struct { // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // 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]types.AttributeValue // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // Determines whether item collection metrics are returned. If set to SIZE, the + // Determines whether item collection metrics are returned. If set to SIZE , the // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. + // during the operation are returned in the response. If set to NONE (the + // default), no statistics are returned. ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics // Use ReturnValues if you want to get the item attributes as they appeared before - // they were updated with the PutItem request. For PutItem, the valid values - // are: - // - // * NONE - If ReturnValues is not specified, or if its value is NONE, then - // nothing is returned. (This setting is the default for ReturnValues.) - // - // * ALL_OLD - // - If PutItem overwrote an attribute name-value pair, then the content of the old - // item is returned. - // - // The values returned are strongly consistent. There is no - // additional cost associated with requesting a return value aside from the small - // network and processing overhead of receiving a larger response. No read capacity - // units are consumed. The ReturnValues parameter is used by several DynamoDB - // operations; however, PutItem does not recognize any values other than NONE or - // ALL_OLD. + // they were updated with the PutItem request. For PutItem , the valid values are: + // - NONE - If ReturnValues is not specified, or if its value is NONE , then + // nothing is returned. (This setting is the default for ReturnValues .) + // - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the + // content of the old item is returned. + // The values returned are strongly consistent. There is no additional cost + // associated with requesting a return value aside from the small network and + // processing overhead of receiving a larger response. No read capacity units are + // consumed. The ReturnValues parameter is used by several DynamoDB operations; + // however, PutItem does not recognize any values other than NONE or ALL_OLD . ReturnValues types.ReturnValue noSmithyDocumentSerde @@ -208,16 +166,15 @@ type PutItemInput struct { type PutItemOutput struct { // The attribute values as they appeared before the PutItem operation, but only if - // ReturnValues is specified as ALL_OLD in the request. Each element consists of an - // attribute name and an attribute value. + // ReturnValues is specified as ALL_OLD in the request. Each element consists of + // an attribute name and an attribute value. Attributes map[string]types.AttributeValue - // The capacity units consumed by the PutItem 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) + // The capacity units consumed by the PutItem 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) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity @@ -226,19 +183,15 @@ type PutItemOutput struct { // ReturnItemCollectionMetrics parameter was specified. If the table does not have // any local secondary indexes, this information is not returned in the response. // Each ItemCollectionMetrics element consists of: - // - // * ItemCollectionKey - The - // partition key value of the item collection. This is the same as the partition - // key value of the item itself. - // - // * SizeEstimateRangeGB - An estimate of item - // collection size, in gigabytes. This value is a two-element array containing a - // lower bound and an upper bound for the estimate. The estimate includes the size - // of all the items in the table, plus the size of all attributes projected into - // all of the local secondary indexes on that table. Use this estimate to measure - // whether a local secondary index is approaching its size limit. The estimate is - // subject to change over time; therefore, do not rely on the precision or accuracy - // of the estimate. + // - ItemCollectionKey - The partition key value of the item collection. This is + // the same as the partition key value of the item itself. + // - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. + // This value is a two-element array containing a lower bound and an upper bound + // for the estimate. The estimate includes the size of all the items in the table, + // plus the size of all attributes projected into all of the local secondary + // indexes on that table. Use this estimate to measure whether a local secondary + // index is approaching its size limit. The estimate is subject to change over + // time; therefore, do not rely on the precision or accuracy of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_Query.go b/service/dynamodb/api_op_Query.go index 53beb27cc96..9cb4385dee3 100644 --- a/service/dynamodb/api_op_Query.go +++ b/service/dynamodb/api_op_Query.go @@ -20,37 +20,36 @@ import ( // provide a specific value for the partition key. The Query operation will return // all of the items from the table or index with that partition key value. You can // optionally narrow the scope of the Query operation by specifying a sort key -// value and a comparison operator in KeyConditionExpression. To further refine the -// Query results, you can optionally provide a FilterExpression. A FilterExpression -// determines which items within the results should be returned to you. All of the -// other results are discarded. A Query operation always returns a result set. If -// no matching items are found, the result set will be empty. Queries that do not -// return results consume the minimum number of read capacity units for that type -// of read operation. DynamoDB calculates the number of read capacity units -// consumed based on item size, not on the amount of data that is returned to an -// application. The number of capacity units consumed will be the same whether you -// request all of the attributes (the default behavior) or just some of them (using -// a projection expression). The number will also be the same whether or not you -// use a FilterExpression. Query results are always sorted by the sort key value. -// If the data type of the sort key is Number, the results are returned in numeric -// order; otherwise, the results are returned in order of UTF-8 bytes. By default, -// the sort order is ascending. To reverse the order, set the ScanIndexForward -// parameter to false. A single Query 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, see Paginating the Results -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination) +// value and a comparison operator in KeyConditionExpression . To further refine +// the Query results, you can optionally provide a FilterExpression . A +// FilterExpression determines which items within the results should be returned to +// you. All of the other results are discarded. A Query operation always returns a +// result set. If no matching items are found, the result set will be empty. +// Queries that do not return results consume the minimum number of read capacity +// units for that type of read operation. DynamoDB calculates the number of read +// capacity units consumed based on item size, not on the amount of data that is +// returned to an application. The number of capacity units consumed will be the +// same whether you request all of the attributes (the default behavior) or just +// some of them (using a projection expression). The number will also be the same +// whether or not you use a FilterExpression . Query results are always sorted by +// the sort key value. If the data type of the sort key is Number, the results are +// returned in numeric order; otherwise, the results are returned in order of UTF-8 +// bytes. By default, the sort order is ascending. To reverse the order, set the +// ScanIndexForward parameter to false. A single Query 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, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination) // in the Amazon DynamoDB Developer Guide. FilterExpression is applied after a // Query finishes, but before the results are returned. A FilterExpression cannot // contain partition key or sort key attributes. You need to specify those -// attributes in the KeyConditionExpression. A Query operation can return an empty -// result set and a LastEvaluatedKey if all the items read for the page of results -// are filtered out. You can query a table, a local secondary index, or a global -// secondary index. For a query on a table or on a local secondary index, you can -// set the ConsistentRead parameter to true and obtain a strongly consistent -// result. Global secondary indexes support eventually consistent reads only, so do -// not specify ConsistentRead when querying a global secondary index. +// attributes in the KeyConditionExpression . A Query operation can return an +// empty result set and a LastEvaluatedKey if all the items read for the page of +// results are filtered out. You can query a table, a local secondary index, or a +// global secondary index. For a query on a table or on a local secondary index, +// you can set the ConsistentRead parameter to true and obtain a strongly +// consistent result. Global secondary indexes support eventually consistent reads +// only, so do not specify ConsistentRead when querying a global secondary index. func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -75,68 +74,49 @@ type QueryInput struct { TableName *string // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []string // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator - // Determines the read consistency model: If set to true, then the operation uses + // Determines the read consistency model: If set to true , then the operation uses // strongly consistent reads; otherwise, the operation uses eventually consistent // reads. Strongly consistent reads are not supported on global secondary indexes. - // If you query a global secondary index with ConsistentRead set to true, you will - // receive a ValidationException. + // If you query a global secondary index with ConsistentRead set to true , you will + // receive a ValidationException . ConsistentRead *bool // 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 set data types - // are allowed. + // value that was returned for LastEvaluatedKey in the previous operation. The + // data type for ExclusiveStartKey must be String, Number, or Binary. No set data + // types are allowed. ExclusiveStartKey map[string]types.AttributeValue // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -148,8 +128,7 @@ type QueryInput struct { // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Specifying Conditions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // expression attribute values, see Specifying Conditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]types.AttributeValue @@ -159,8 +138,7 @@ type QueryInput struct { // key attributes. You cannot define a filter expression based on a partition key // or a sort key. A FilterExpression is applied after the items have already been // read; the process of filtering does not consume any additional read capacity - // units. For more information, see Filter Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression) + // units. For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression) // in the Amazon DynamoDB Developer Guide. FilterExpression *string @@ -177,8 +155,8 @@ type QueryInput struct { // partition key value but different sort key values. The partition key equality // test is required, and must be specified in the following format: // partitionKeyName = :partitionkeyval If you also want to provide a condition for - // the sort key, it must be combined using AND with the condition for the sort key. - // Following is an example, using the = comparison operator for the sort key: + // the sort key, it must be combined using AND with the condition for the sort + // key. Following is an example, using the = comparison operator for the sort key: // partitionKeyName // = // @@ -188,66 +166,45 @@ type QueryInput struct { // // sortKeyName // - // - // = - // + // = // :sortkeyval Valid comparisons for the sort key condition are as follows: - // - // * - // sortKeyName=:sortkeyval - true if the sort key value is equal to :sortkeyval. - // - // * - // sortKeyName<:sortkeyval - true if the sort key value is less than - // :sortkeyval. - // - // * sortKeyName<=:sortkeyval - true if the sort key value is less - // than or equal to :sortkeyval. - // - // * sortKeyName>:sortkeyval - true if the sort key - // value is greater than :sortkeyval. - // - // * sortKeyName>= :sortkeyval - true if the - // sort key value is greater than or equal to :sortkeyval. - // - // * - // sortKeyNameBETWEEN:sortkeyval1AND:sortkeyval2 - true if the sort key value is - // greater than or equal to :sortkeyval1, and less than or equal to - // :sortkeyval2. - // - // * begins_with (sortKeyName, :sortkeyval) - true if the sort key - // value begins with a particular operand. (You cannot use this function with a - // sort key that is of type Number.) Note that the function name begins_with is - // case-sensitive. - // - // Use the ExpressionAttributeValues parameter to replace tokens - // such as :partitionval and :sortval with actual values at runtime. You can - // optionally use the ExpressionAttributeNames parameter to replace the names of - // the partition key and sort key with placeholder tokens. This option might be + // - sortKeyName = :sortkeyval - true if the sort key value is equal to + // :sortkeyval . + // - sortKeyName < :sortkeyval - true if the sort key value is less than + // :sortkeyval . + // - sortKeyName <= :sortkeyval - true if the sort key value is less than or + // equal to :sortkeyval . + // - sortKeyName > :sortkeyval - true if the sort key value is greater than + // :sortkeyval . + // - sortKeyName >= :sortkeyval - true if the sort key value is greater than or + // equal to :sortkeyval . + // - sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key + // value is greater than or equal to :sortkeyval1 , and less than or equal to + // :sortkeyval2 . + // - begins_with ( sortKeyName , :sortkeyval ) - true if the sort key value + // begins with a particular operand. (You cannot use this function with a sort key + // that is of type Number.) Note that the function name begins_with is + // case-sensitive. + // Use the ExpressionAttributeValues parameter to replace tokens such as + // :partitionval and :sortval with actual values at runtime. You can optionally + // use the ExpressionAttributeNames parameter to replace the names of the + // partition key and sort key with placeholder tokens. This option might be // necessary if an attribute name conflicts with a DynamoDB reserved word. For // example, the following KeyConditionExpression parameter causes an error because // Size is a reserved word: - // - // * Size = :myval - // - // To work around this, define a - // placeholder (such a #S) to represent the attribute name Size. - // KeyConditionExpression then is as follows: - // - // * #S = :myval - // - // For a list of - // reserved words, see Reserved Words - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) + // - Size = :myval + // To work around this, define a placeholder (such a #S ) to represent the + // attribute name Size. KeyConditionExpression then is as follows: + // - #S = :myval + // For a list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) // in the Amazon DynamoDB Developer Guide. For more information on - // ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders - // for Attribute Names and Values - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html) + // ExpressionAttributeNames and ExpressionAttributeValues , see Using Placeholders + // for Attribute Names and Values (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html) // in the Amazon DynamoDB Developer Guide. KeyConditionExpression *string // This is a legacy parameter. Use KeyConditionExpression instead. For more - // information, see KeyConditions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) + // information, see KeyConditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) // in the Amazon DynamoDB Developer Guide. KeyConditions map[string]types.Condition @@ -259,8 +216,7 @@ type QueryInput struct { // 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) + // For more information, see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit *int32 @@ -269,88 +225,73 @@ type QueryInput struct { // 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 Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string // This is a legacy parameter. Use FilterExpression instead. For more information, - // see QueryFilter - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) + // see QueryFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) // in the Amazon DynamoDB Developer Guide. QueryFilter map[string]types.Condition // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity // Specifies the order for index traversal: If true (default), the traversal is - // performed in ascending order; if false, the traversal is performed in descending - // order. Items with the same partition key value are stored in sorted order by - // sort key. If the sort key data type is Number, the results are stored in numeric - // order. For type String, the results are stored in order of UTF-8 bytes. For type - // Binary, DynamoDB treats each byte of the binary data as unsigned. If - // ScanIndexForward is true, DynamoDB returns the results in the order in which - // they are stored (by sort key value). This is the default behavior. If - // ScanIndexForward is false, DynamoDB reads the results in reverse order by sort - // key value, and then returns the results to the client. + // performed in ascending order; if false , the traversal is performed in + // descending order. Items with the same partition key value are stored in sorted + // order by sort key. If the sort key data type is Number, the results are stored + // in numeric order. For type String, the results are stored in order of UTF-8 + // bytes. For type Binary, DynamoDB treats each byte of the binary data as + // unsigned. If ScanIndexForward is true , DynamoDB returns the results in the + // order in which they are stored (by sort key value). This is the default + // behavior. If ScanIndexForward is false , DynamoDB reads the results in reverse + // order by sort key value, and then returns the results to the client. ScanIndexForward *bool // The attributes to be returned in the result. You can retrieve all item // attributes, specific item attributes, the count of matching items, or in the // case of an index, some or all of the attributes projected into the index. - // - // * - // 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 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 configured - // to project all attributes, this return value is equivalent to specifying - // ALL_ATTRIBUTES. - // - // * COUNT - Returns the number of matching items, rather than the - // matching items themselves. Note that this uses the same quantity of read - // capacity units as getting the items, and is subject to the same item size - // calculations. - // - // * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in - // ProjectionExpression. This return value is equivalent to specifying - // ProjectionExpression 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 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 ProjectionExpression are specified, - // DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and - // ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and - // ProjectionExpression together in a single request, unless the value for Select - // is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying - // ProjectionExpression without any value for Select.) If you use the - // ProjectionExpression parameter, then the value for Select can only be - // SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. + // - 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 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 + // configured to project all attributes, this return value is equivalent to + // specifying ALL_ATTRIBUTES . + // - COUNT - Returns the number of matching items, rather than the matching items + // themselves. Note that this uses the same quantity of read capacity units as + // getting the items, and is subject to the same item size calculations. + // - SPECIFIC_ATTRIBUTES - Returns only the attributes listed in + // ProjectionExpression . This return value is equivalent to specifying + // ProjectionExpression 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 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 ProjectionExpression are specified, DynamoDB defaults to + // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when + // accessing an index. You cannot use both Select and ProjectionExpression + // together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES + // . (This usage is equivalent to specifying ProjectionExpression without any + // value for Select .) If you use the ProjectionExpression parameter, then the + // value for Select can only be SPECIFIC_ATTRIBUTES . Any other value for Select + // will return an error. Select types.Select noSmithyDocumentSerde @@ -363,8 +304,7 @@ type QueryOutput 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) + // Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity @@ -390,10 +330,9 @@ type QueryOutput struct { // The number of items evaluated, before any QueryFilter is applied. A high // ScannedCount value with few, or no, Count results indicates an inefficient Query - // operation. For more information, see Count and ScannedCount - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) + // operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count. + // request, then ScannedCount is the same as Count . ScannedCount int32 // Metadata pertaining to the operation's result. @@ -531,8 +470,7 @@ type QueryPaginatorOptions struct { // 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) + // For more information, see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit int32 } diff --git a/service/dynamodb/api_op_RestoreTableFromBackup.go b/service/dynamodb/api_op_RestoreTableFromBackup.go index 52dd86e33d2..d87518c9fdc 100644 --- a/service/dynamodb/api_op_RestoreTableFromBackup.go +++ b/service/dynamodb/api_op_RestoreTableFromBackup.go @@ -17,20 +17,12 @@ import ( // to 4 concurrent restores (any type of restore) in a given account. You can call // RestoreTableFromBackup at a maximum rate of 10 times per second. You must // manually set up the following on the restored table: -// -// * Auto scaling policies -// -// * -// IAM policies -// -// * Amazon CloudWatch metrics and alarms -// -// * Tags -// -// * Stream -// settings -// -// * Time to Live (TTL) settings +// - Auto scaling policies +// - IAM policies +// - Amazon CloudWatch metrics and alarms +// - Tags +// - Stream settings +// - Time to Live (TTL) settings func (c *Client) RestoreTableFromBackup(ctx context.Context, params *RestoreTableFromBackupInput, optFns ...func(*Options)) (*RestoreTableFromBackupOutput, error) { if params == nil { params = &RestoreTableFromBackupInput{} diff --git a/service/dynamodb/api_op_RestoreTableToPointInTime.go b/service/dynamodb/api_op_RestoreTableToPointInTime.go index d47565e742d..c2af0201e58 100644 --- a/service/dynamodb/api_op_RestoreTableToPointInTime.go +++ b/service/dynamodb/api_op_RestoreTableToPointInTime.go @@ -15,43 +15,27 @@ import ( ) // Restores the specified table to the specified point in time within -// EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your +// EarliestRestorableDateTime and LatestRestorableDateTime . You can restore your // table to any point in time during the last 35 days. Any number of users can // execute up to 4 concurrent restores (any type of restore) in a given account. // When you restore using point in time recovery, DynamoDB restores your table data // to the state based on the selected date and time (day:hour:minute:second) to a // new table. Along with data, the following are also included on the new restored // table using point in time recovery: +// - Global secondary indexes (GSIs) +// - Local secondary indexes (LSIs) +// - Provisioned read and write capacity +// - Encryption settings All these settings come from the current settings of +// the source table at the time of restore. // -// * Global secondary indexes (GSIs) -// -// * Local -// secondary indexes (LSIs) -// -// * Provisioned read and write capacity -// -// * Encryption -// settings All these settings come from the current settings of the source table -// at the time of restore. -// -// You must manually set up the following on the restored -// table: -// -// * Auto scaling policies -// -// * IAM policies -// -// * Amazon CloudWatch metrics and -// alarms -// -// * Tags -// -// * Stream settings -// -// * Time to Live (TTL) settings -// -// * Point in -// time recovery settings +// You must manually set up the following on the restored table: +// - Auto scaling policies +// - IAM policies +// - Amazon CloudWatch metrics and alarms +// - Tags +// - Stream settings +// - Time to Live (TTL) settings +// - Point in time recovery settings func (c *Client) RestoreTableToPointInTime(ctx context.Context, params *RestoreTableToPointInTimeInput, optFns ...func(*Options)) (*RestoreTableToPointInTimeOutput, error) { if params == nil { params = &RestoreTableToPointInTimeInput{} diff --git a/service/dynamodb/api_op_Scan.go b/service/dynamodb/api_op_Scan.go index d4f640aefc1..7e20b6df158 100644 --- a/service/dynamodb/api_op_Scan.go +++ b/service/dynamodb/api_op_Scan.go @@ -22,20 +22,18 @@ import ( // limit. A scan can result in no table data meeting the filter criteria. 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) +// 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. Scan operations proceed sequentially; // however, for faster performance on a large table or secondary index, // applications can request a parallel Scan operation by providing the Segment and -// TotalSegments parameters. For more information, see Parallel Scan -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) +// TotalSegments parameters. For more information, see Parallel Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) // in the Amazon DynamoDB Developer Guide. Scan uses eventually consistent reads // when accessing the data in a table; therefore, the result set might not include // the changes to data in the table immediately before the operation began. If you -// need a consistent copy of the data, as of the time that the Scan begins, you can -// set the ConsistentRead parameter to true. +// need a consistent copy of the data, as of the time that the Scan begins, you +// can set the ConsistentRead parameter to true . func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Options)) (*ScanOutput, error) { if params == nil { params = &ScanInput{} @@ -55,86 +53,61 @@ func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Op type ScanInput struct { // The name of the table containing the requested items; or, if you provide - // IndexName, the name of the table to which that index belongs. + // IndexName , the name of the table to which that index belongs. // // This member is required. TableName *string // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see AttributesToGet - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) + // information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []string // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator // A Boolean value that determines the read consistency model during the scan: - // - // * - // 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). - // - // * 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. - // - // The default setting for ConsistentRead is false. The ConsistentRead - // parameter is not supported on global secondary indexes. If you scan a global - // secondary index with ConsistentRead set to true, you will receive a - // ValidationException. + // - 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 ). + // - 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. + // The default setting for ConsistentRead is false . The ConsistentRead parameter + // is not supported on global secondary indexes. If you scan a global secondary + // index with ConsistentRead set to true, you will receive a ValidationException . ConsistentRead *bool // 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 set data types - // are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey - // must specify the same segment whose previous Scan returned the corresponding - // value of LastEvaluatedKey. + // value that was returned for LastEvaluatedKey in the previous operation. The + // data type for ExclusiveStartKey must be String, Number or Binary. No set data + // types are allowed. In a parallel scan, a Scan request that includes + // ExclusiveStartKey must specify the same segment whose previous Scan returned + // the corresponding value of LastEvaluatedKey . ExclusiveStartKey map[string]types.AttributeValue // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -146,8 +119,7 @@ type ScanInput struct { // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // 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]types.AttributeValue @@ -155,14 +127,13 @@ type ScanInput struct { // operation, but before the data is returned to you. Items that do not satisfy the // FilterExpression criteria are not returned. A FilterExpression is applied after // the items have already been read; the process of filtering does not consume any - // additional read capacity units. For more information, see Filter Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression) + // additional read capacity units. For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression) // in the Amazon DynamoDB Developer Guide. FilterExpression *string // The name of a secondary index to scan. This index can be any local secondary // index or global secondary index. Note that if you use the IndexName parameter, - // you must also provide TableName. + // you must also provide TableName . IndexName *string // The maximum number of items to evaluate (not necessarily the number of matching @@ -173,8 +144,7 @@ type ScanInput struct { // 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 Working with Queries - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) + // For more information, see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit *int32 @@ -183,31 +153,24 @@ type ScanInput struct { // 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 Specifying 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 // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity // This is a legacy parameter. Use FilterExpression instead. For more information, - // see ScanFilter - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) + // see ScanFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) // in the Amazon DynamoDB Developer Guide. ScanFilter map[string]types.Condition @@ -215,55 +178,47 @@ type ScanInput struct { // scanned by an application worker. Segment IDs are zero-based, so the first // segment is always 0. For example, if you want to use four application threads to // scan a table or an index, then the first thread specifies a Segment value of 0, - // the second thread specifies 1, and so on. The value of LastEvaluatedKey returned - // from a parallel Scan request must be used as ExclusiveStartKey with the same - // segment ID in a subsequent Scan operation. The value for Segment must be greater - // than or equal to 0, and less than the value provided for TotalSegments. If you - // provide Segment, you must also provide TotalSegments. + // the second thread specifies 1, and so on. The value of LastEvaluatedKey + // returned from a parallel Scan request must be used as ExclusiveStartKey with + // the same segment ID in a subsequent Scan operation. The value for Segment must + // be greater than or equal to 0, and less than the value provided for + // TotalSegments . If you provide Segment , you must also provide TotalSegments . Segment *int32 // The attributes to be returned in the result. You can retrieve all item // attributes, specific item attributes, the count of matching items, or in the // case of an index, some or all of the attributes projected into the index. - // - // * - // 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 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 configured - // to project all attributes, this return value is equivalent to specifying - // ALL_ATTRIBUTES. - // - // * COUNT - Returns the number of matching items, rather than the - // matching items themselves. Note that this uses the same quantity of read - // capacity units as getting the items, and is subject to the same item size - // calculations. - // - // * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in - // ProjectionExpression. This return value is equivalent to specifying - // ProjectionExpression 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 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 ProjectionExpression are specified, DynamoDB - // defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES - // when accessing an index. You cannot use both Select and ProjectionExpression - // together in a single request, unless the value for Select is - // SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying - // ProjectionExpression without any value for Select.) If you use the - // ProjectionExpression parameter, then the value for Select can only be - // SPECIFIC_ATTRIBUTES. Any other value for Select will return an error. + // - 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 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 + // configured to project all attributes, this return value is equivalent to + // specifying ALL_ATTRIBUTES . + // - COUNT - Returns the number of matching items, rather than the matching items + // themselves. Note that this uses the same quantity of read capacity units as + // getting the items, and is subject to the same item size calculations. + // - SPECIFIC_ATTRIBUTES - Returns only the attributes listed in + // ProjectionExpression . This return value is equivalent to specifying + // ProjectionExpression 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 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 ProjectionExpression are specified, DynamoDB defaults to + // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when + // accessing an index. You cannot use both Select and ProjectionExpression + // together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES + // . (This usage is equivalent to specifying ProjectionExpression without any + // value for Select .) If you use the ProjectionExpression parameter, then the + // value for Select can only be SPECIFIC_ATTRIBUTES . Any other value for Select + // will return an error. Select types.Select // For a parallel Scan request, TotalSegments represents the total number of @@ -273,8 +228,8 @@ type ScanInput struct { // scan a table or an index, specify a TotalSegments value of 4. The value for // TotalSegments must be greater than or equal to 1, and less than or equal to // 1000000. If you specify a TotalSegments value of 1, the Scan operation will be - // sequential rather than parallel. If you specify TotalSegments, you must also - // specify Segment. + // sequential rather than parallel. If you specify TotalSegments , you must also + // specify Segment . TotalSegments *int32 noSmithyDocumentSerde @@ -287,15 +242,14 @@ type ScanOutput 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/ProvisionedThroughput.html#ItemSizeCalculations.Reads) + // Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity // The number of items in the response. If you set ScanFilter in the request, then // Count is the number of items returned after the filter was applied, and // ScannedCount is the number of matching items before the filter was applied. If - // you did not use a filter in the request, then Count is the same as ScannedCount. + // you did not use a filter in the request, then Count is the same as ScannedCount . Count int32 // An array of item attributes that match the scan criteria. Each element in this @@ -313,10 +267,9 @@ type ScanOutput struct { // The number of items evaluated, before any ScanFilter is applied. A high // ScannedCount value with few, or no, Count results indicates an inefficient Scan - // operation. For more information, see Count and ScannedCount - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) + // operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count. + // request, then ScannedCount is the same as Count . ScannedCount int32 // Metadata pertaining to the operation's result. @@ -454,8 +407,7 @@ type ScanPaginatorOptions struct { // 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 Working with Queries - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) + // For more information, see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit int32 } diff --git a/service/dynamodb/api_op_TagResource.go b/service/dynamodb/api_op_TagResource.go index 61ed87fd729..6bfaa31bba2 100644 --- a/service/dynamodb/api_op_TagResource.go +++ b/service/dynamodb/api_op_TagResource.go @@ -17,8 +17,7 @@ import ( // 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 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) +// Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) // in the Amazon DynamoDB Developer Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/dynamodb/api_op_TransactGetItems.go b/service/dynamodb/api_op_TransactGetItems.go index d1fcb4eab68..50a98dce072 100644 --- a/service/dynamodb/api_op_TransactGetItems.go +++ b/service/dynamodb/api_op_TransactGetItems.go @@ -16,23 +16,16 @@ import ( // 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 100 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 +// 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 Amazon Web Services account or Region. The // aggregate size of the items in the transaction cannot exceed 4 MB. DynamoDB // rejects the entire TransactGetItems request if any of the following is true: -// -// * -// A conflicting operation is in the process of updating an item to be read. -// -// * -// There is insufficient provisioned capacity for the transaction to be -// completed. -// -// * There is a user error, such as an invalid data format. -// -// * The -// aggregate size of the items in the transaction exceeded 4 MB. +// - A conflicting operation is in the process of updating an item to be read. +// - There is insufficient provisioned capacity for the transaction to be +// completed. +// - There is a user error, such as an invalid data format. +// - The aggregate size of the items in the transaction exceeded 4 MB. func (c *Client) TransactGetItems(ctx context.Context, params *TransactGetItemsInput, optFns ...func(*Options)) (*TransactGetItemsOutput, error) { if params == nil { params = &TransactGetItemsInput{} @@ -66,15 +59,15 @@ type TransactGetItemsInput struct { type TransactGetItemsOutput struct { - // If the ReturnConsumedCapacity value was TOTAL, this is an array of + // If the ReturnConsumedCapacity value was TOTAL , this is an array of // ConsumedCapacity objects, one for each table addressed by TransactGetItem // objects in the TransactItems parameter. These ConsumedCapacity objects report // the read-capacity units consumed by the TransactGetItems call in that table. ConsumedCapacity []types.ConsumedCapacity - // An ordered array of up to 100 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 + // An ordered array of up to 100 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. If a requested item could not be // retrieved, the corresponding ItemResponse object is Null, or if the requested // item has no projected attributes, the corresponding ItemResponse object is an diff --git a/service/dynamodb/api_op_TransactWriteItems.go b/service/dynamodb/api_op_TransactWriteItems.go index 70514356bbf..ee98d544a79 100644 --- a/service/dynamodb/api_op_TransactWriteItems.go +++ b/service/dynamodb/api_op_TransactWriteItems.go @@ -13,63 +13,46 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// TransactWriteItems is a synchronous write operation that groups up to 100 action -// requests. These actions can target items in different tables, but not in +// TransactWriteItems is a synchronous write operation that groups up to 100 +// action requests. These actions can target items in different tables, but not in // different Amazon Web Services accounts or Regions, and no two actions can target // the same item. For example, you cannot both ConditionCheck and Update the same // item. The aggregate size of the items in the transaction cannot exceed 4 MB. The // actions are completed atomically so that either all of them succeed, or all of // them fail. They are defined by the following objects: +// - Put — Initiates a PutItem operation to write a new item. This structure +// 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 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 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 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 +// to retrieve the item's attributes if the condition is not met. // -// * Put — Initiates a -// PutItem operation to write a new item. This structure 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 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 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 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 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. -// -// * 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 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. +// DynamoDB rejects the entire TransactWriteItems request if any of the following +// is true: +// - A condition in one of the condition expressions is not met. +// - 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 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. func (c *Client) TransactWriteItems(ctx context.Context, params *TransactWriteItemsInput, optFns ...func(*Options)) (*TransactWriteItemsOutput, error) { if params == nil { params = &TransactWriteItemsInput{} @@ -88,8 +71,8 @@ func (c *Client) TransactWriteItems(ctx context.Context, params *TransactWriteIt type TransactWriteItemsInput struct { // An ordered array of up to 100 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 Amazon Web Services + // a ConditionCheck , Put , Update , or Delete object. These can operate on items + // in different tables, but the tables must reside in the same Amazon Web Services // account and Region, and no two of them can operate on the same item. // // This member is required. @@ -114,22 +97,17 @@ type TransactWriteItemsInput struct { // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // Determines whether item collection metrics are returned. If set to SIZE, the + // Determines whether item collection metrics are returned. If set to SIZE , the // response includes statistics about item collections (if any), that were modified // during the operation and are returned in the response. If set to NONE (the // default), no statistics are returned. @@ -147,7 +125,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][]types.ItemCollectionMetrics // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_UntagResource.go b/service/dynamodb/api_op_UntagResource.go index 2d73ba4b76a..73cce98f759 100644 --- a/service/dynamodb/api_op_UntagResource.go +++ b/service/dynamodb/api_op_UntagResource.go @@ -14,8 +14,7 @@ import ( // Removes the association of tags from an Amazon DynamoDB resource. You can 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) +// tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) // in the Amazon DynamoDB Developer Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // A list of tag keys. Existing tags of the resource whose keys are members of this - // list will be removed from the DynamoDB resource. + // A list of tag keys. Existing tags of the resource whose keys are members of + // this list will be removed from the DynamoDB resource. // // This member is required. TagKeys []string diff --git a/service/dynamodb/api_op_UpdateContinuousBackups.go b/service/dynamodb/api_op_UpdateContinuousBackups.go index 112544e2a3e..2f3e9cc8d0f 100644 --- a/service/dynamodb/api_op_UpdateContinuousBackups.go +++ b/service/dynamodb/api_op_UpdateContinuousBackups.go @@ -15,11 +15,11 @@ import ( // UpdateContinuousBackups enables or disables point in time recovery for the // specified table. A successful UpdateContinuousBackups call returns the current -// ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at +// ContinuousBackupsDescription . Continuous backups are ENABLED on all tables at // table creation. 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. LatestRestorableDateTime is typically 5 minutes +// 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. func (c *Client) UpdateContinuousBackups(ctx context.Context, params *UpdateContinuousBackupsInput, optFns ...func(*Options)) (*UpdateContinuousBackupsOutput, error) { diff --git a/service/dynamodb/api_op_UpdateGlobalTable.go b/service/dynamodb/api_op_UpdateGlobalTable.go index f012be25a8b..7290b57c86d 100644 --- a/service/dynamodb/api_op_UpdateGlobalTable.go +++ b/service/dynamodb/api_op_UpdateGlobalTable.go @@ -17,36 +17,25 @@ import ( // already exist to be able to use this operation. Any replica to be added 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. This operation only applies to Version 2017.11.29 (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// capacity units. This operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). -// This operation only applies to Version 2017.11.29 -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. If you are using global tables Version 2019.11.21 -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) -// you can use DescribeTable -// (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html) +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. If you are using global tables Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// you can use DescribeTable (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html) // instead. Although you can use UpdateGlobalTable to add replicas and remove // replicas in a single request, for simplicity we recommend that you issue // separate requests for adding or removing replicas. If global secondary indexes // are specified, then the following conditions must also be met: -// -// * The global -// secondary indexes must have the same name. -// -// * The global secondary indexes must -// have the same hash key and sort key (if present). -// -// * The global secondary -// indexes must have the same provisioned and maximum write capacity units. +// - The global secondary indexes must have the same name. +// - The global secondary indexes must have the same hash key and sort key (if +// present). +// - The global secondary indexes must have the same provisioned and maximum +// write capacity units. func (c *Client) UpdateGlobalTable(ctx context.Context, params *UpdateGlobalTableInput, optFns ...func(*Options)) (*UpdateGlobalTableOutput, error) { if params == nil { params = &UpdateGlobalTableInput{} diff --git a/service/dynamodb/api_op_UpdateGlobalTableSettings.go b/service/dynamodb/api_op_UpdateGlobalTableSettings.go index d721a80cedf..1c1d0b37f23 100644 --- a/service/dynamodb/api_op_UpdateGlobalTableSettings.go +++ b/service/dynamodb/api_op_UpdateGlobalTableSettings.go @@ -14,17 +14,14 @@ import ( ) // Updates settings for a global table. This operation only applies to Version -// 2017.11.29 (Legacy) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) -// of global tables. We recommend using Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) +// of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // when creating new global tables, as it provides greater flexibility, higher // efficiency and consumes less write capacity than 2017.11.29 (Legacy). To -// determine which version you are using, see Determining the version -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). -// To update existing global tables from version 2017.11.29 (Legacy) to version -// 2019.11.21 (Current), see Updating global tables -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html). +// determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html) +// . To update existing global tables from version 2017.11.29 (Legacy) to version +// 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html) +// . func (c *Client) UpdateGlobalTableSettings(ctx context.Context, params *UpdateGlobalTableSettingsInput, optFns ...func(*Options)) (*UpdateGlobalTableSettingsOutput, error) { if params == nil { params = &UpdateGlobalTableSettingsInput{} @@ -49,20 +46,16 @@ type UpdateGlobalTableSettingsInput struct { // The billing mode of the global table. If GlobalTableBillingMode is not // specified, the global table defaults to PROVISIONED capacity billing mode. - // - // * - // PROVISIONED - We recommend using PROVISIONED for predictable workloads. - // PROVISIONED sets the billing mode to Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - // - // * - // PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable - // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + // - PROVISIONED - We recommend using PROVISIONED for predictable workloads. + // PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual) + // . + // - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable + // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand) + // . GlobalTableBillingMode types.BillingMode - // Represents the settings of a global secondary index for a global table that will - // be modified. + // Represents the settings of a global secondary index for a global table that + // will be modified. GlobalTableGlobalSecondaryIndexSettingsUpdate []types.GlobalTableGlobalSecondaryIndexSettingsUpdate // Auto scaling settings for managing provisioned write capacity for the global diff --git a/service/dynamodb/api_op_UpdateItem.go b/service/dynamodb/api_op_UpdateItem.go index ad9d26ffced..55fb95d15c6 100644 --- a/service/dynamodb/api_op_UpdateItem.go +++ b/service/dynamodb/api_op_UpdateItem.go @@ -38,11 +38,11 @@ func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns // Represents the input of an UpdateItem operation. type UpdateItemInput struct { - // The primary key of the item to be updated. Each element consists of an attribute - // name and a value for that attribute. For the primary key, you must provide all - // of the attributes. For example, with a simple primary key, you only need to - // provide a value for the partition key. For a composite primary key, you must - // provide values for both the partition key and the sort key. + // The primary key of the item to be updated. Each element consists of an + // attribute name and a value for that attribute. For the primary key, you must + // provide all of the attributes. For example, with a simple primary key, you only + // need to provide a value for the partition key. For a composite primary key, you + // must provide values for both the partition key and the sort key. // // This member is required. Key map[string]types.AttributeValue @@ -53,79 +53,51 @@ type UpdateItemInput struct { TableName *string // This is a legacy parameter. Use UpdateExpression instead. For more information, - // see AttributeUpdates - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) + // see AttributeUpdates (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) // in the Amazon DynamoDB Developer Guide. AttributeUpdates map[string]types.AttributeValueUpdate - // A condition that must be satisfied in order for a conditional update to succeed. - // An expression can contain any of the following: - // - // * Functions: attribute_exists | - // attribute_not_exists | attribute_type | contains | begins_with | size These - // function names are case-sensitive. - // - // * Comparison operators: = | <> | < | > | <= - // | >= | BETWEEN | IN - // - // * Logical operators: AND | OR | NOT - // - // For more information - // about condition expressions, see Specifying Conditions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // A condition that must be satisfied in order for a conditional update to + // succeed. An expression can contain any of the following: + // - Functions: attribute_exists | attribute_not_exists | attribute_type | + // contains | begins_with | size These function names are case-sensitive. + // - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN + // - Logical operators: AND | OR | NOT + // 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 // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see ConditionalOperator - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) + // information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator types.ConditionalOperator // This is a legacy parameter. Use ConditionExpression instead. For more - // information, see Expected - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) + // information, see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) // in the Amazon DynamoDB Developer Guide. Expected map[string]types.ExpectedAttributeValue // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 - // about expression attribute names, see Specifying Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 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 @@ -137,128 +109,95 @@ type UpdateItemInput struct { // ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, // ":disc":{"S":"Discontinued"} } You could then use these values in an expression, // such as this: ProductStatus IN (:avail, :back, :disc) For more information on - // expression attribute values, see Condition Expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) + // 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]types.AttributeValue // Determines the level of detail about either provisioned or on-demand throughput // consumption that is returned in the response: - // - // * INDEXES - The response includes - // the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity - // for each table and secondary index that was accessed. Note that some operations, - // such as GetItem and BatchGetItem, do not access any indexes at all. In these - // cases, specifying INDEXES will only return ConsumedCapacity information for - // table(s). - // - // * TOTAL - The response includes only the aggregate ConsumedCapacity - // for the operation. - // - // * NONE - No ConsumedCapacity details are included in the - // response. + // - INDEXES - The response includes the aggregate ConsumedCapacity for the + // operation, together with ConsumedCapacity for each table and secondary index + // that was accessed. Note that some operations, such as GetItem and BatchGetItem + // , do not access any indexes at all. In these cases, specifying INDEXES will + // only return ConsumedCapacity information for table(s). + // - TOTAL - The response includes only the aggregate ConsumedCapacity for the + // operation. + // - NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity types.ReturnConsumedCapacity - // Determines whether item collection metrics are returned. If set to SIZE, the + // Determines whether item collection metrics are returned. If set to SIZE , the // response includes statistics about item collections, if any, that were modified - // during the operation are returned in the response. If set to NONE (the default), - // no statistics are returned. + // during the operation are returned in the response. If set to NONE (the + // default), no statistics are returned. ReturnItemCollectionMetrics types.ReturnItemCollectionMetrics - // Use ReturnValues if you want to get the item attributes as they appear before or - // after they are successfully updated. For UpdateItem, the valid values are: - // - // * - // NONE - If ReturnValues is not specified, or if its value is NONE, then nothing - // is returned. (This setting is the default for ReturnValues.) - // - // * ALL_OLD - - // Returns all of the attributes of the item, as they appeared before the - // UpdateItem operation. - // - // * UPDATED_OLD - Returns only the updated attributes, as - // they appeared before the UpdateItem operation. - // - // * ALL_NEW - Returns all of the - // attributes of the item, as they appear after the UpdateItem operation. - // - // * - // UPDATED_NEW - Returns only the updated attributes, as they appear after the - // UpdateItem operation. - // - // There is no additional cost associated with requesting a - // return value aside from the small network and processing overhead of receiving a - // larger response. No read capacity units are consumed. The values returned are - // strongly consistent. + // Use ReturnValues if you want to get the item attributes as they appear before + // or after they are successfully updated. For UpdateItem , the valid values are: + // - NONE - If ReturnValues is not specified, or if its value is NONE , then + // nothing is returned. (This setting is the default for ReturnValues .) + // - ALL_OLD - Returns all of the attributes of the item, as they appeared before + // the UpdateItem operation. + // - UPDATED_OLD - Returns only the updated attributes, as they appeared before + // the UpdateItem operation. + // - ALL_NEW - Returns all of the attributes of the item, as they appear after + // the UpdateItem operation. + // - UPDATED_NEW - Returns only the updated attributes, as they appear after the + // UpdateItem operation. + // There is no additional cost associated with requesting a return value aside + // from the small network and processing overhead of receiving a larger response. + // No read capacity units are consumed. The values returned are strongly + // consistent. ReturnValues types.ReturnValue // An expression that defines one or more attributes to be updated, the action 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 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 + :valSET supports the following - // functions: - // - // * if_not_exists (path, operand) - if the item does not contain an - // attribute at the specified path, then if_not_exists evaluates to operand; - // otherwise, it evaluates to path. You can use this function to avoid overwriting - // an attribute that may already be present in the item. - // - // * list_append (operand, - // operand) - evaluates to a list with a new element added to it. You can append - // the new element to the start or the end of the list by reversing the order of - // the operands. - // - // These function names are case-sensitive. - // - // * REMOVE - Removes one - // or more attributes from an item. - // - // * ADD - Adds the specified value to the item, - // if the attribute does not already exist. If the attribute does exist, then the - // behavior of ADD depends on the data type of the attribute: - // - // * If the existing - // attribute is a number, and if Value is also a number, then Value is - // mathematically added to the existing attribute. If Value is a negative number, - // then it is subtracted from the existing attribute. If you use ADD to increment - // or decrement a number value for an item that doesn't exist before the update, - // DynamoDB uses 0 as the initial value. Similarly, if you use ADD for an existing - // item to increment or decrement an attribute value that doesn't exist before the - // update, DynamoDB uses 0 as the initial value. For example, suppose that the item - // you want to update doesn't have an attribute named itemcount, but you decide to - // ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount - // attribute, set its initial value to 0, and finally add 3 to it. The result will - // be a new itemcount attribute in the item, with a value of 3. - // - // * If the existing - // data type is a set and if Value is also a set, then Value is added to the - // existing set. For example, if the attribute value is the set [1,2], and the ADD - // action specified [3], then the final attribute value is [1,2,3]. An error occurs - // if an ADD action is specified for a set attribute and the attribute type - // specified does not match the existing set type. Both sets must have the same - // primitive data type. For example, if the existing data type is a set of strings, - // the Value must also be a set of strings. - // - // The ADD action only supports Number - // and set data types. In addition, ADD can only be used on top-level attributes, - // not nested attributes. - // - // * DELETE - Deletes an element from a set. If a set of - // values is specified, then those values are subtracted from the old set. For - // example, if the attribute value was the set [a,b,c] and the DELETE action - // specifies [a,c], then the final attribute value is [b]. Specifying an empty set - // is an error. The DELETE action only supports set data types. In addition, DELETE - // can only be used on top-level attributes, not nested attributes. - // - // You can have - // many actions in a single expression, such as the following: SET a=:value1, - // b=:value2 DELETE :value3, :value4, :value5 For more information on update - // expressions, see Modifying Items and Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html) + // available for UpdateExpression . + // - SET - Adds one or more attributes and values to an item. If any of these + // 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 at + // the specified path, then if_not_exists evaluates to operand; otherwise, it + // evaluates to path. You can use this function to avoid overwriting an attribute + // that may already be present in the item. + // - list_append (operand, operand) - evaluates to a list with a new element + // added to it. You can append the new element to the start or the end of the list + // by reversing the order of the operands. These function names are + // case-sensitive. + // - REMOVE - Removes one or more attributes from an item. + // - ADD - Adds the specified value to the item, if the attribute does not + // already exist. If the attribute does exist, then the behavior of ADD depends + // on the data type of the attribute: + // - If the existing attribute is a number, and if Value is also a number, then + // Value is mathematically added to the existing attribute. If Value is a + // negative number, then it is subtracted from the existing attribute. If you use + // ADD to increment or decrement a number value for an item that doesn't exist + // before the update, DynamoDB uses 0 as the initial value. Similarly, if you use + // ADD for an existing item to increment or decrement an attribute value that + // doesn't exist before the update, DynamoDB uses 0 as the initial value. For + // example, suppose that the item you want to update doesn't have an attribute + // named itemcount , but you decide to ADD the number 3 to this attribute anyway. + // DynamoDB will create the itemcount attribute, set its initial value to 0 , and + // finally add 3 to it. The result will be a new itemcount attribute in the item, + // with a value of 3 . + // - If the existing data type is a set and if Value is also a set, then Value is + // added to the existing set. For example, if the attribute value is the set + // [1,2] , and the ADD action specified [3] , then the final attribute value is + // [1,2,3] . An error occurs if an ADD action is specified for a set attribute + // and the attribute type specified does not match the existing set type. Both sets + // must have the same primitive data type. For example, if the existing data type + // is a set of strings, the Value must also be a set of strings. The ADD action + // only supports Number and set data types. In addition, ADD can only be used on + // top-level attributes, not nested attributes. + // - DELETE - Deletes an element from a set. If a set of values is specified, + // then those values are subtracted from the old set. For example, if the attribute + // value was the set [a,b,c] and the DELETE action specifies [a,c] , then the + // final attribute value is [b] . Specifying an empty set is an error. The DELETE + // action only supports set data types. In addition, DELETE can only be used on + // top-level attributes, not nested attributes. + // You can have many actions in a single expression, such as the following: SET + // a=:value1, b=:value2 DELETE :value3, :value4, :value5 For more information on + // update expressions, see Modifying Items and Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html) // in the Amazon DynamoDB Developer Guide. UpdateExpression *string @@ -278,8 +217,7 @@ type UpdateItemOutput 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/ProvisionedThroughput.html#ItemSizeCalculations.Reads) + // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *types.ConsumedCapacity @@ -288,19 +226,15 @@ type UpdateItemOutput struct { // ReturnItemCollectionMetrics parameter was specified. If the table does not have // any local secondary indexes, this information is not returned in the response. // Each ItemCollectionMetrics element consists of: - // - // * ItemCollectionKey - The - // partition key value of the item collection. This is the same as the partition - // key value of the item itself. - // - // * SizeEstimateRangeGB - An estimate of item - // collection size, in gigabytes. This value is a two-element array containing a - // lower bound and an upper bound for the estimate. The estimate includes the size - // of all the items in the table, plus the size of all attributes projected into - // all of the local secondary indexes on that table. Use this estimate to measure - // whether a local secondary index is approaching its size limit. The estimate is - // subject to change over time; therefore, do not rely on the precision or accuracy - // of the estimate. + // - ItemCollectionKey - The partition key value of the item collection. This is + // the same as the partition key value of the item itself. + // - SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. + // This value is a two-element array containing a lower bound and an upper bound + // for the estimate. The estimate includes the size of all the items in the table, + // plus the size of all attributes projected into all of the local secondary + // indexes on that table. Use this estimate to measure whether a local secondary + // index is approaching its size limit. The estimate is subject to change over + // time; therefore, do not rely on the precision or accuracy of the estimate. ItemCollectionMetrics *types.ItemCollectionMetrics // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_UpdateTable.go b/service/dynamodb/api_op_UpdateTable.go index 4eabb4717e8..e82b770b98c 100644 --- a/service/dynamodb/api_op_UpdateTable.go +++ b/service/dynamodb/api_op_UpdateTable.go @@ -15,24 +15,17 @@ import ( // Modifies the provisioned throughput settings, global secondary indexes, or // DynamoDB Streams settings for a given table. This operation only applies to -// Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) -// of global tables. You can only perform one of the following operations at -// once: +// Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// of global tables. You can only perform one of the following operations at once: +// - Modify the provisioned throughput settings of the table. +// - Remove a global secondary index from the table. +// - Create a new global secondary index on the table. After the index begins +// backfilling, you can use UpdateTable to perform other operations. // -// * Modify the provisioned throughput settings of the table. -// -// * Remove a -// global secondary index from the table. -// -// * 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 status changes from ACTIVE to UPDATING. While it is -// UPDATING, you cannot issue another UpdateTable request. When the table returns -// to the ACTIVE state, the UpdateTable operation is complete. +// UpdateTable is an asynchronous operation; while it is executing, the table +// status changes from ACTIVE to UPDATING . While it is UPDATING , you cannot issue +// another UpdateTable request. When the table returns to the ACTIVE state, the +// UpdateTable operation is complete. func (c *Client) UpdateTable(ctx context.Context, params *UpdateTableInput, optFns ...func(*Options)) (*UpdateTableOutput, error) { if params == nil { params = &UpdateTableInput{} @@ -66,16 +59,12 @@ type UpdateTableInput struct { // provisioned capacity values must be set. The initial provisioned capacity values // are estimated based on the consumed read and write capacity of your table and // global secondary indexes over the past 30 minutes. - // - // * PROVISIONED - We recommend - // using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode - // to Provisioned Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). - // - // * - // PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable - // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + // - PROVISIONED - We recommend using PROVISIONED for predictable workloads. + // PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual) + // . + // - PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable + // workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand) + // . BillingMode types.BillingMode // Indicates whether deletion protection is to be enabled (true) or disabled @@ -84,29 +73,20 @@ type UpdateTableInput struct { // An array of one or more global secondary indexes for the table. For each index // in the array, you can request one action: - // - // * Create - add a new global secondary - // index to the table. - // - // * Update - modify the provisioned throughput settings of an - // existing global secondary index. - // - // * Delete - remove a global secondary index - // from the table. - // - // You can create or delete only one global secondary index per - // UpdateTable operation. For more information, see Managing Global Secondary - // Indexes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html) + // - Create - add a new global secondary index to the table. + // - Update - modify the provisioned throughput settings of an existing global + // secondary index. + // - Delete - remove a global secondary index from the table. + // You can create or delete only one global secondary index per UpdateTable + // operation. For more information, see Managing Global Secondary Indexes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html) // in the Amazon DynamoDB Developer Guide. GlobalSecondaryIndexUpdates []types.GlobalSecondaryIndexUpdate // The new provisioned throughput settings for the specified table or index. ProvisionedThroughput *types.ProvisionedThroughput - // A list of replica update actions (create, delete, or update) for the table. This - // property only applies to Version 2019.11.21 (Current) - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) + // A list of replica update actions (create, delete, or update) for the table. + // This property only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // of global tables. ReplicaUpdates []types.ReplicationGroupUpdate @@ -120,7 +100,7 @@ type UpdateTableInput struct { StreamSpecification *types.StreamSpecification // The table class of the table to be updated. Valid values are STANDARD and - // STANDARD_INFREQUENT_ACCESS. + // STANDARD_INFREQUENT_ACCESS . TableClass types.TableClass noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go index 5261fa0cf25..9643ebffb8c 100644 --- a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go +++ b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates auto scaling settings on your global tables at once. This operation only -// applies to Version 2019.11.21 (Current) -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) +// Updates auto scaling settings on your global tables at once. This operation +// only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) // of global tables. func (c *Client) UpdateTableReplicaAutoScaling(ctx context.Context, params *UpdateTableReplicaAutoScalingInput, optFns ...func(*Options)) (*UpdateTableReplicaAutoScalingOutput, error) { if params == nil { @@ -41,8 +40,8 @@ type UpdateTableReplicaAutoScalingInput struct { // replica to be updated. GlobalSecondaryIndexUpdates []types.GlobalSecondaryIndexAutoScalingUpdate - // Represents the auto scaling settings to be modified for a global table or global - // secondary index. + // Represents the auto scaling settings to be modified for a global table or + // global secondary index. ProvisionedWriteCapacityAutoScalingUpdate *types.AutoScalingSettingsUpdate // Represents the auto scaling settings of replicas of the table that will be diff --git a/service/dynamodb/api_op_UpdateTimeToLive.go b/service/dynamodb/api_op_UpdateTimeToLive.go index 81aa34fecc1..b283baa69a3 100644 --- a/service/dynamodb/api_op_UpdateTimeToLive.go +++ b/service/dynamodb/api_op_UpdateTimeToLive.go @@ -15,12 +15,12 @@ import ( // 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 +// 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. TTL compares the current time -// in epoch time format to the time stored in the TTL attribute of an item. If the -// epoch time value stored in the attribute is less than the current time, the item -// is marked as expired and subsequently deleted. The epoch time format is the +// one hour duration result in a ValidationException . TTL compares the current +// time in epoch time format to the time stored in the TTL attribute of an item. If +// the epoch time value stored in the attribute is less than the current time, the +// item is marked as expired and subsequently deleted. The epoch time format is the // number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC. DynamoDB // deletes expired items on a best-effort basis to ensure availability of // throughput for other data operations. DynamoDB typically deletes expired items @@ -29,9 +29,8 @@ import ( // 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 a -// standard delete operation. For more information, see Time To Live -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) in -// the Amazon DynamoDB Developer Guide. +// standard delete operation. For more information, see Time To Live (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) +// in the Amazon DynamoDB Developer Guide. func (c *Client) UpdateTimeToLive(ctx context.Context, params *UpdateTimeToLiveInput, optFns ...func(*Options)) (*UpdateTimeToLiveOutput, error) { if params == nil { params = &UpdateTimeToLiveInput{} @@ -55,8 +54,8 @@ type UpdateTimeToLiveInput struct { // This member is required. TableName *string - // 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 for the + // specified table. // // This member is required. TimeToLiveSpecification *types.TimeToLiveSpecification diff --git a/service/dynamodb/types/enums.go b/service/dynamodb/types/enums.go index d00c6689de9..5a99a7cc5b0 100644 --- a/service/dynamodb/types/enums.go +++ b/service/dynamodb/types/enums.go @@ -31,9 +31,9 @@ const ( BackupStatusAvailable BackupStatus = "AVAILABLE" ) -// Values returns all known values for BackupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BackupStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BackupStatus) Values() []BackupStatus { return []BackupStatus{ "CREATING", @@ -288,9 +288,9 @@ const ( ExportFormatIon ExportFormat = "ION" ) -// Values returns all known values for ExportFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportFormat) Values() []ExportFormat { return []ExportFormat{ "DYNAMODB_JSON", @@ -307,9 +307,9 @@ const ( ExportStatusFailed ExportStatus = "FAILED" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "IN_PROGRESS", @@ -351,9 +351,9 @@ const ( ImportStatusFailed ImportStatus = "FAILED" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "IN_PROGRESS", @@ -662,9 +662,9 @@ const ( SSEStatusUpdating SSEStatus = "UPDATING" ) -// Values returns all known values for SSEStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SSEStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SSEStatus) Values() []SSEStatus { return []SSEStatus{ "ENABLING", diff --git a/service/dynamodb/types/errors.go b/service/dynamodb/types/errors.go index 79f40bd759a..c24ee60a60f 100644 --- a/service/dynamodb/types/errors.go +++ b/service/dynamodb/types/errors.go @@ -114,8 +114,8 @@ func (e *ContinuousBackupsUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was an attempt to insert an item with the same primary key as an item that -// already exists in the DynamoDB table. +// There was an attempt to insert an item with the same primary key as an item +// that already exists in the DynamoDB table. type DuplicateItemException struct { Message *string @@ -274,9 +274,9 @@ func (e *IdempotentParameterMismatchException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was a conflict when importing from the specified S3 source. This can occur -// when the current import conflicts with a previous import request that had the -// same client token. +// There was a conflict when importing from the specified S3 source. This can +// occur when the current import conflicts with a previous import request that had +// the same client token. type ImportConflictException struct { Message *string @@ -458,8 +458,8 @@ func (e *InvalidRestoreTimeException) ErrorCode() string { } func (e *InvalidRestoreTimeException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An item collection is too large. This exception is only returned for tables that -// have one or more local secondary indexes. +// An item collection is too large. This exception is only returned for tables +// that have one or more local secondary indexes. type ItemCollectionSizeLimitExceededException struct { Message *string @@ -489,14 +489,14 @@ func (e *ItemCollectionSizeLimitExceededException) ErrorFault() smithy.ErrorFaul // There is no limit to the number of daily on-demand backups that can be taken. // For most purposes, up to 500 simultaneous table operations are allowed per -// account. These operations include CreateTable, UpdateTable, -// DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and -// RestoreTableToPointInTime. When you are creating a table with one or more -// secondary indexes, you can have up to 250 such requests running at a time. -// However, if the table or index specifications are complex, then DynamoDB might -// temporarily reduce the number of concurrent operations. When importing into -// DynamoDB, up to 50 simultaneous import table operations are allowed per account. -// There is a soft account quota of 2,500 tables. +// account. These operations include CreateTable , UpdateTable , DeleteTable , +// UpdateTimeToLive , RestoreTableFromBackup , and RestoreTableToPointInTime . When +// you are creating a table with one or more secondary indexes, you can have up to +// 250 such requests running at a time. However, if the table or index +// specifications are complex, then DynamoDB might temporarily reduce the number of +// concurrent operations. When importing into DynamoDB, up to 50 simultaneous +// import table operations are allowed per account. There is a soft account quota +// of 2,500 tables. type LimitExceededException struct { Message *string @@ -554,8 +554,7 @@ func (e *PointInTimeRecoveryUnavailableException) ErrorFault() smithy.ErrorFault // automatically retry requests that receive this exception. Your request is // eventually successful, unless your retry queue is too large to finish. Reduce // the frequency of requests and use exponential backoff. For more information, go -// to Error Retries and Exponential Backoff -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) +// to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) // in the Amazon DynamoDB Developer Guide. type ProvisionedThroughputExceededException struct { Message *string @@ -636,9 +635,9 @@ func (e *ReplicaNotFoundException) ErrorCode() string { } func (e *ReplicaNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Throughput exceeds the current throughput quota for your account. Please contact -// Amazon Web Services Support (https://aws.amazon.com/support) to request a quota -// increase. +// Throughput exceeds the current throughput quota for your account. Please +// contact Amazon Web Services Support (https://aws.amazon.com/support) to request +// a quota increase. type RequestLimitExceeded struct { Message *string @@ -693,7 +692,7 @@ func (e *ResourceInUseException) ErrorCode() string { func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation tried to access a nonexistent table or index. The resource might -// not be specified correctly, or its status might not be ACTIVE. +// not be specified correctly, or its status might not be ACTIVE . type ResourceNotFoundException struct { Message *string @@ -801,152 +800,87 @@ func (e *TableNotFoundException) ErrorFault() smithy.ErrorFault { return smithy. // The entire transaction request was canceled. DynamoDB cancels a // TransactWriteItems request under the following circumstances: -// -// * A condition in -// one of the condition expressions is not met. -// -// * A table in the -// TransactWriteItems request is in a different account or region. -// -// * More than one -// action in the TransactWriteItems operation targets the same item. -// -// * There is -// insufficient provisioned capacity for the transaction to be completed. -// -// * An -// item size becomes too large (larger than 400 KB), or a local secondary index -// (LSI) becomes too large, or a similar validation error occurs because of changes -// made by the transaction. -// -// * There is a user error, such as an invalid data -// format. -// -// DynamoDB cancels a TransactGetItems request under the following -// circumstances: -// -// * There is an ongoing TransactGetItems operation that conflicts -// with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. -// In this case the TransactGetItems operation fails with a -// TransactionCanceledException. -// -// * A table in the TransactGetItems request is in a -// different account or region. -// -// * There is insufficient provisioned capacity for -// the transaction to be completed. -// -// * There is a user error, such as an invalid -// data format. +// - A condition in one of the condition expressions is not met. +// - A table in the TransactWriteItems request is in a different account or +// region. +// - More than one action in the TransactWriteItems operation targets the same +// item. +// - There is insufficient provisioned capacity for the transaction to be +// completed. +// - An item size becomes too large (larger than 400 KB), or a local secondary +// index (LSI) becomes too large, or a similar validation error occurs because of +// changes made by the transaction. +// - There is a user error, such as an invalid data format. +// +// DynamoDB cancels a TransactGetItems request under the following circumstances: +// - There is an ongoing TransactGetItems operation that conflicts with a +// concurrent PutItem , UpdateItem , DeleteItem or TransactWriteItems request. In +// this case the TransactGetItems operation fails with a +// TransactionCanceledException . +// - A table in the TransactGetItems request is in a different account or region. +// - There is insufficient provisioned capacity for the transaction to be +// completed. +// - There is a user error, such as an invalid data format. // // If using Java, DynamoDB lists the cancellation reasons on the // CancellationReasons property. This property is not set for other languages. // Transaction cancellation reasons are ordered in the order of requested items, if // an item has no error it will have None code and Null message. Cancellation // reason codes and possible error messages: -// -// * No Errors: -// -// * Code: None -// -// * -// Message: null -// -// * Conditional Check Failed: -// -// * Code: ConditionalCheckFailed -// -// * -// Message: The conditional request failed. -// -// * Item Collection Size Limit -// Exceeded: -// -// * Code: ItemCollectionSizeLimitExceeded -// -// * Message: Collection size -// exceeded. -// -// * Transaction Conflict: -// -// * Code: TransactionConflict -// -// * Message: -// Transaction is ongoing for the item. -// -// * Provisioned Throughput Exceeded: -// -// * -// Code: ProvisionedThroughputExceeded -// -// * Messages: -// -// * The level of configured -// provisioned throughput for the table was exceeded. Consider increasing your -// provisioning level with the UpdateTable API. This Message is received when -// provisioned throughput is exceeded is on a provisioned DynamoDB table. -// -// * The -// level of configured provisioned throughput for one or more global secondary -// indexes of the table was exceeded. Consider increasing your provisioning level -// for the under-provisioned global secondary indexes with the UpdateTable API. -// This message is returned when provisioned throughput is exceeded is on a -// provisioned GSI. -// -// * Throttling Error: -// -// * Code: ThrottlingError -// -// * Messages: -// -// * -// Throughput exceeds the current capacity of your table or index. DynamoDB is -// automatically scaling your table or index so please try again shortly. If -// exceptions persist, check if you have a hot key: -// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. -// This message is returned when writes get throttled on an On-Demand table as -// DynamoDB is automatically scaling the table. -// -// * Throughput exceeds the current -// capacity for one or more global secondary indexes. DynamoDB is automatically -// scaling your index so please try again shortly. This message is returned when -// writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling -// the GSI. -// -// * Validation Error: -// -// * Code: ValidationError -// -// * Messages: -// -// * One or -// more parameter values were invalid. -// -// * The update expression attempted to update -// the secondary index key beyond allowed size limits. -// -// * The update expression -// attempted to update the secondary index key to unsupported type. -// -// * An operand -// in the update expression has an incorrect data type. -// -// * Item size to update has -// exceeded the maximum allowed size. -// -// * Number overflow. Attempting to store a -// number with magnitude larger than supported range. -// -// * Type mismatch for -// attribute to update. -// -// * Nesting Levels have exceeded supported limits. -// -// * The -// document path provided in the update expression is invalid for update. -// -// * The -// provided expression refers to an attribute that does not exist in the item. +// - No Errors: +// - Code: None +// - Message: null +// - Conditional Check Failed: +// - Code: ConditionalCheckFailed +// - Message: The conditional request failed. +// - Item Collection Size Limit Exceeded: +// - Code: ItemCollectionSizeLimitExceeded +// - Message: Collection size exceeded. +// - Transaction Conflict: +// - Code: TransactionConflict +// - Message: Transaction is ongoing for the item. +// - Provisioned Throughput Exceeded: +// - Code: ProvisionedThroughputExceeded +// - Messages: +// - The level of configured provisioned throughput for the table was exceeded. +// Consider increasing your provisioning level with the UpdateTable API. This +// Message is received when provisioned throughput is exceeded is on a provisioned +// DynamoDB table. +// - The level of configured provisioned throughput for one or more global +// secondary indexes of the table was exceeded. Consider increasing your +// provisioning level for the under-provisioned global secondary indexes with the +// UpdateTable API. This message is returned when provisioned throughput is +// exceeded is on a provisioned GSI. +// - Throttling Error: +// - Code: ThrottlingError +// - Messages: +// - Throughput exceeds the current capacity of your table or index. DynamoDB is +// automatically scaling your table or index so please try again shortly. If +// exceptions persist, check if you have a hot key: +// https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. +// This message is returned when writes get throttled on an On-Demand table as +// DynamoDB is automatically scaling the table. +// - Throughput exceeds the current capacity for one or more global secondary +// indexes. DynamoDB is automatically scaling your index so please try again +// shortly. This message is returned when writes get throttled on an On-Demand GSI +// as DynamoDB is automatically scaling the GSI. +// - Validation Error: +// - Code: ValidationError +// - Messages: +// - One or more parameter values were invalid. +// - The update expression attempted to update the secondary index key beyond +// allowed size limits. +// - The update expression attempted to update the secondary index key to +// unsupported type. +// - An operand in the update expression has an incorrect data type. +// - Item size to update has exceeded the maximum allowed size. +// - Number overflow. Attempting to store a number with magnitude larger than +// supported range. +// - Type mismatch for attribute to update. +// - Nesting Levels have exceeded supported limits. +// - The document path provided in the update expression is invalid for update. +// - The provided expression refers to an attribute that does not exist in the +// item. type TransactionCanceledException struct { Message *string @@ -1000,50 +934,32 @@ func (e *TransactionConflictException) ErrorCode() string { } func (e *TransactionConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The transaction with the given request token is already in progress. Recommended -// Settings This is a general recommendation for handling the -// TransactionInProgressException. These settings help ensure that the client +// The transaction with the given request token is already in progress. +// Recommended Settings This is a general recommendation for handling the +// TransactionInProgressException . These settings help ensure that the client // retries will trigger completion of the ongoing TransactWriteItems request. -// -// * -// Set clientExecutionTimeout to a value that allows at least one retry to be -// processed after 5 seconds have elapsed since the first attempt for the -// TransactWriteItems operation. -// -// * Set socketTimeout to a value a little lower -// than the requestTimeout setting. -// -// * requestTimeout should be set based on the -// time taken for the individual retries of a single HTTP request for your use -// case, but setting it to 1 second or higher should work well to reduce chances of -// retries and TransactionInProgressException errors. -// -// * Use exponential backoff -// when retrying and tune backoff if needed. -// -// Assuming default retry policy -// (https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), -// example timeout settings based on the guidelines above are as follows: Example +// - Set clientExecutionTimeout to a value that allows at least one retry to be +// processed after 5 seconds have elapsed since the first attempt for the +// TransactWriteItems operation. +// - Set socketTimeout to a value a little lower than the requestTimeout setting. +// - requestTimeout should be set based on the time taken for the individual +// retries of a single HTTP request for your use case, but setting it to 1 second +// or higher should work well to reduce chances of retries and +// TransactionInProgressException errors. +// - Use exponential backoff when retrying and tune backoff if needed. +// +// Assuming default retry policy (https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97) +// , example timeout settings based on the guidelines above are as follows: Example // timeline: -// -// * 0-1000 first attempt -// -// * 1000-1500 first sleep/delay (default retry -// policy uses 500 ms as base delay for 4xx errors) -// -// * 1500-2500 second attempt -// -// * -// 2500-3500 second sleep/delay (500 * 2, exponential backoff) -// -// * 3500-4500 third -// attempt -// -// * 4500-6500 third sleep/delay (500 * 2^2) -// -// * 6500-7500 fourth attempt -// (this can trigger inline recovery since 5 seconds have elapsed since the first -// attempt reached TC) +// - 0-1000 first attempt +// - 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay +// for 4xx errors) +// - 1500-2500 second attempt +// - 2500-3500 second sleep/delay (500 * 2, exponential backoff) +// - 3500-4500 third attempt +// - 4500-6500 third sleep/delay (500 * 2^2) +// - 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds +// have elapsed since the first attempt reached TC) type TransactionInProgressException struct { Message *string diff --git a/service/dynamodb/types/types.go b/service/dynamodb/types/types.go index ce3446b1be3..3445ae345ee 100644 --- a/service/dynamodb/types/types.go +++ b/service/dynamodb/types/types.go @@ -19,12 +19,10 @@ type ArchivalSummary struct { // time format. ArchivalDateTime *time.Time - // The reason DynamoDB archived the table. Currently, the only possible value - // is: - // - // * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the - // table's KMS key being inaccessible for more than seven days. An On-Demand backup - // was created at the archival time. + // The reason DynamoDB archived the table. Currently, the only possible value is: + // - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the + // table's KMS key being inaccessible for more than seven days. An On-Demand backup + // was created at the archival time. ArchivalReason *string noSmithyDocumentSerde @@ -39,14 +37,9 @@ type AttributeDefinition struct { AttributeName *string // The data type for the attribute, where: - // - // * S - the attribute is of type - // String - // - // * N - the attribute is of type Number - // - // * B - the attribute is of type - // Binary + // - S - the attribute is of type String + // - N - the attribute is of type Number + // - B - the attribute is of type Binary // // This member is required. AttributeType ScalarAttributeType @@ -56,8 +49,7 @@ type AttributeDefinition struct { // Represents the data for an attribute. Each attribute value is described as a // name-value pair. The name is the data type, and the value is the data itself. -// For more information, see Data Types -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) +// For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) // in the Amazon DynamoDB Developer Guide. // // The following types satisfy this interface: @@ -186,72 +178,55 @@ func (*AttributeValueMemberSS) isAttributeValue() {} // be rejected with a ValidationException exception. type AttributeValueUpdate struct { - // Specifies how to perform the update. Valid values are PUT (default), DELETE, and - // ADD. The behavior depends on whether the specified primary key already exists in - // the table. If an item with the specified Key is found in the table: - // - // * PUT - - // Adds the specified attribute to the item. If the attribute already exists, it is - // replaced by the new value. - // - // * DELETE - If no value is specified, the attribute - // and its value are removed from the item. The data type of the specified value - // must match the existing value's data type. If a set of values is specified, then - // those values are subtracted from the old set. For example, if the attribute - // value was the set [a,b,c] and the DELETE action specified [a,c], then the final - // attribute value would be [b]. Specifying an empty set is an error. - // - // * ADD - If - // the attribute does not already exist, then the attribute and its values are - // added to the item. If the attribute does exist, then the behavior of ADD depends - // on the data type of the attribute: - // - // * If the existing attribute is a number, and - // if Value is also a number, then the Value is mathematically added to the - // existing attribute. If Value is a negative number, then it is subtracted from - // the existing attribute. If you use ADD to increment or decrement a number value - // for an item that doesn't exist before the update, DynamoDB uses 0 as the initial - // value. In addition, if you use ADD to update an existing item, and intend to - // increment or decrement an attribute value which does not yet exist, DynamoDB - // uses 0 as the initial value. For example, suppose that the item you want to - // update does not yet have an attribute named itemcount, but you decide to ADD the - // number 3 to this attribute anyway, even though it currently does not exist. - // DynamoDB will create the itemcount attribute, set its initial value to 0, and - // finally add 3 to it. The result will be a new itemcount attribute in the item, - // with a value of 3. - // - // * If the existing data type is a set, and if the Value is - // also a set, then the Value is added to the existing set. (This is a set - // operation, not mathematical addition.) For example, if the attribute value was - // the set [1,2], and the ADD action specified [3], then the final attribute value - // would be [1,2,3]. An error occurs if an Add action is specified for a set - // attribute and the attribute type specified does not match the existing set type. - // Both sets must have the same primitive data type. For example, if the existing - // data type is a set of strings, the Value must also be a set of strings. The same - // holds true for number sets and binary sets. - // - // This action is only valid for an - // existing attribute whose data type is number or is a set. Do not use ADD for any - // other data types. - // + // Specifies how to perform the update. Valid values are PUT (default), DELETE , + // and ADD . The behavior depends on whether the specified primary key already + // exists in the table. If an item with the specified Key is found in the table: + // - PUT - Adds the specified attribute to the item. If the attribute already + // exists, it is replaced by the new value. + // - DELETE - If no value is specified, the attribute and its value are removed + // from the item. The data type of the specified value must match the existing + // value's data type. If a set of values is specified, then those values are + // subtracted from the old set. For example, if the attribute value was the set + // [a,b,c] and the DELETE action specified [a,c] , then the final attribute value + // would be [b] . Specifying an empty set is an error. + // - ADD - If the attribute does not already exist, then the attribute and its + // values are added to the item. If the attribute does exist, then the behavior of + // ADD depends on the data type of the attribute: + // - If the existing attribute is a number, and if Value is also a number, then + // the Value is mathematically added to the existing attribute. If Value is a + // negative number, then it is subtracted from the existing attribute. If you use + // ADD to increment or decrement a number value for an item that doesn't exist + // before the update, DynamoDB uses 0 as the initial value. In addition, if you use + // ADD to update an existing item, and intend to increment or decrement an + // attribute value which does not yet exist, DynamoDB uses 0 as the initial + // value. For example, suppose that the item you want to update does not yet have + // an attribute named itemcount, but you decide to ADD the number 3 to this + // attribute anyway, even though it currently does not exist. DynamoDB will create + // the itemcount attribute, set its initial value to 0 , and finally add 3 to it. + // The result will be a new itemcount attribute in the item, with a value of 3 . + // - If the existing data type is a set, and if the Value is also a set, then the + // Value is added to the existing set. (This is a set operation, not mathematical + // addition.) For example, if the attribute value was the set [1,2] , and the ADD + // action specified [3] , then the final attribute value would be [1,2,3] . An + // error occurs if an Add action is specified for a set attribute and the attribute + // type specified does not match the existing set type. Both sets must have the + // same primitive data type. For example, if the existing data type is a set of + // strings, the Value must also be a set of strings. The same holds true for + // number sets and binary sets. This action is only valid for an existing + // attribute whose data type is number or is a set. Do not use ADD for any other + // data types. // If no item with the specified Key is found: - // - // * PUT - DynamoDB - // creates a new item with the specified primary key, and then adds the - // attribute. - // - // * DELETE - Nothing happens; there is no attribute to delete. - // - // * ADD - // - DynamoDB creates a new item with the supplied primary key and number (or set) - // for the attribute value. The only data types allowed are number, number set, - // string set or binary set. + // - PUT - DynamoDB creates a new item with the specified primary key, and then + // adds the attribute. + // - DELETE - Nothing happens; there is no attribute to delete. + // - ADD - DynamoDB creates a new item with the supplied primary key and number + // (or set) for the attribute value. The only data types allowed are number, number + // set, string set or binary set. Action AttributeAction // Represents the data for an attribute. Each attribute value is described as a // name-value pair. The name is the data type, and the value is the data itself. - // For more information, see Data Types - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) + // For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) // in the Amazon DynamoDB Developer Guide. Value AttributeValue @@ -308,8 +283,8 @@ type AutoScalingSettingsDescription struct { noSmithyDocumentSerde } -// Represents the auto scaling settings to be modified for a global table or global -// secondary index. +// Represents the auto scaling settings to be modified for a global table or +// global secondary index. type AutoScalingSettingsUpdate struct { // Disabled auto scaling for this global table or global secondary index. @@ -442,17 +417,12 @@ type BackupDetails struct { BackupStatus BackupStatus // BackupType: - // - // * USER - You create and manage these using the on-demand backup - // feature. - // - // * SYSTEM - If you delete a table with point-in-time recovery enabled, - // a SYSTEM backup is automatically created and is retained for 35 days (at no - // additional cost). System backups allow you to restore the deleted table to the - // state it was in just before the point of deletion. - // - // * AWS_BACKUP - On-demand - // backup created by you from Backup service. + // - USER - You create and manage these using the on-demand backup feature. + // - SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM + // backup is automatically created and is retained for 35 days (at no additional + // cost). System backups allow you to restore the deleted table to the state it was + // in just before the point of deletion. + // - AWS_BACKUP - On-demand backup created by you from Backup service. // // This member is required. BackupType BackupType @@ -461,8 +431,8 @@ type BackupDetails struct { // This SYSTEM on-demand backup expires automatically 35 days after its creation. BackupExpiryDateTime *time.Time - // Size of the backup in bytes. DynamoDB updates this value approximately every six - // hours. Recent changes might not be reflected in this value. + // Size of the backup in bytes. DynamoDB updates this value approximately every + // six hours. Recent changes might not be reflected in this value. BackupSizeBytes *int64 noSmithyDocumentSerde @@ -491,17 +461,12 @@ type BackupSummary struct { BackupStatus BackupStatus // BackupType: - // - // * USER - You create and manage these using the on-demand backup - // feature. - // - // * SYSTEM - If you delete a table with point-in-time recovery enabled, - // a SYSTEM backup is automatically created and is retained for 35 days (at no - // additional cost). System backups allow you to restore the deleted table to the - // state it was in just before the point of deletion. - // - // * AWS_BACKUP - On-demand - // backup created by you from Backup service. + // - USER - You create and manage these using the on-demand backup feature. + // - SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM + // backup is automatically created and is retained for 35 days (at no additional + // cost). System backups allow you to restore the deleted table to the state it was + // in just before the point of deletion. + // - AWS_BACKUP - On-demand backup created by you from Backup service. BackupType BackupType // ARN associated with the table. @@ -562,25 +527,21 @@ type BatchStatementResponse struct { // Contains the details for the read/write capacity mode. This page talks about // PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these -// modes, see Read/write capacity mode -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html). -// You may need to switch to on-demand mode at least once in order to return a +// modes, see Read/write capacity mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html) +// . You may need to switch to on-demand mode at least once in order to return a // BillingModeSummary response. type BillingModeSummary struct { // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. - // - // * PROVISIONED - Sets the - // read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for - // predictable workloads. - // - // * PAY_PER_REQUEST - Sets the read/write capacity mode to - // PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + // - PROVISIONED - Sets the read/write capacity mode to PROVISIONED . We + // recommend using PROVISIONED for predictable workloads. + // - PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST . We + // recommend using PAY_PER_REQUEST for unpredictable workloads. BillingMode BillingMode - // Represents the time when PAY_PER_REQUEST was last set as the read/write capacity - // mode. + // Represents the time when PAY_PER_REQUEST was last set as the read/write + // capacity mode. LastUpdateToPayPerRequestDateTime *time.Time noSmithyDocumentSerde @@ -622,129 +583,106 @@ type Capacity struct { } // Represents the selection criteria for a Query or Scan operation: -// -// * For a Query -// operation, Condition is used for specifying the KeyConditions to use when -// querying a table or an index. For KeyConditions, only the following comparison -// operators are supported: EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEENCondition -// is also used in a QueryFilter, which evaluates the query results and returns -// only the desired values. -// -// * For a Scan operation, Condition is used in a -// ScanFilter, which evaluates the scan results and returns only the desired -// values. +// - For a Query operation, Condition is used for specifying the KeyConditions to +// use when querying a table or an index. For KeyConditions , only the following +// comparison operators are supported: EQ | LE | LT | GE | GT | BEGINS_WITH | +// BETWEEN Condition is also used in a QueryFilter , which evaluates the query +// results and returns only the desired values. +// - For a Scan operation, Condition is used in a ScanFilter , which evaluates +// the scan results and returns only the desired values. type Condition struct { // A comparator for evaluating attributes. For example, equals, greater than, less - // than, etc. The following comparison operators are available: EQ | NE | LE | LT | - // GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN - // The following are descriptions of each comparison operator. - // - // * EQ : Equal. EQ is - // supported for all data types, including lists and maps. AttributeValueList can - // contain only one AttributeValue element of type String, Number, Binary, String - // Set, Number Set, or Binary Set. If an item contains an AttributeValue element of - // a different type than the one provided in the request, the value does not match. - // For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal - // {"NS":["6", "2", "1"]}. - // - // * NE : Not equal. NE is supported for all data types, - // including lists and maps. AttributeValueList can contain only one AttributeValue - // of type String, Number, Binary, String Set, Number Set, or Binary Set. If an - // item contains an AttributeValue of a different type than the one provided in the - // request, the value does not match. For example, {"S":"6"} does not equal - // {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. - // - // * LE : Less - // than or equal. AttributeValueList can contain only one AttributeValue element of - // type String, Number, or Binary (not a set type). If an item contains an - // AttributeValue element of a different type than the one provided in the request, - // the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, - // {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. - // - // * LT : Less than. - // AttributeValueList can contain only one AttributeValue of type String, Number, - // or Binary (not a set type). If an item contains an AttributeValue element of a - // different type than the one provided in the request, the value does not match. - // For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not - // compare to {"NS":["6", "2", "1"]}. - // - // * GE : Greater than or equal. - // AttributeValueList can contain only one AttributeValue element of type String, - // Number, or Binary (not a set type). If an item contains an AttributeValue - // element of a different type than the one provided in the request, the value does - // not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does - // not compare to {"NS":["6", "2", "1"]}. - // - // * GT : Greater than. AttributeValueList - // can contain only one AttributeValue element of type String, Number, or Binary - // (not a set type). If an item contains an AttributeValue element of a different - // type than the one provided in the request, the value does not match. For - // example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to - // {"NS":["6", "2", "1"]}. - // - // * NOT_NULL : The attribute exists. NOT_NULL is - // supported for all data types, including lists and maps. This operator tests for - // the existence of an attribute, not its data type. If the data type of attribute - // "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. - // This result is because the attribute "a" exists; its data type is not relevant - // to the NOT_NULL comparison operator. - // - // * NULL : The attribute does not exist. - // NULL is supported for all data types, including lists and maps. This operator - // tests for the nonexistence of an attribute, not its data type. If the data type - // of attribute "a" is null, and you evaluate it using NULL, the result is a - // Boolean false. This is because the attribute "a" exists; its data type is not - // relevant to the NULL comparison operator. - // - // * CONTAINS : Checks for a - // subsequence, or value in a set. AttributeValueList can contain only one - // AttributeValue element of type String, Number, or Binary (not a set type). If - // the target attribute of the comparison is of type String, then the operator - // checks for a substring match. If the target attribute of the comparison is of - // type Binary, then the operator looks for a subsequence of the target that - // matches the input. If the target attribute of the comparison is a set ("SS", - // "NS", or "BS"), then the operator evaluates to true if it finds an exact match - // with any member of the set. CONTAINS is supported for lists: When evaluating "a - // CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a - // list. - // - // * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a - // value in a set. AttributeValueList can contain only one AttributeValue element - // of type String, Number, or Binary (not a set type). If the target attribute of - // the comparison is a String, then the operator checks for the absence of a - // substring match. If the target attribute of the comparison is Binary, then the - // operator checks for the absence of a subsequence of the target that matches the - // input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), - // then the operator evaluates to true if it does not find an exact match with any - // member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT - // CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a - // list. - // - // * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only - // one AttributeValue of type String or Binary (not a Number or a set type). The - // target attribute of the comparison must be of type String or Binary (not a - // Number or a set type). - // - // * IN : Checks for matching elements in a list. - // AttributeValueList can contain one or more AttributeValue elements of type - // String, Number, or Binary. These attributes are compared against an existing - // attribute of an item. If any elements of the input are equal to the item - // attribute, the expression evaluates to true. - // - // * BETWEEN : Greater than or equal - // to the first value, and less than or equal to the second value. - // AttributeValueList must contain two AttributeValue elements of the same type, - // either String, Number, or Binary (not a set type). A target attribute matches if - // the target value is greater than, or equal to, the first element and less than, - // or equal to, the second element. If an item contains an AttributeValue element - // of a different type than the one provided in the request, the value does not - // match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} - // does not compare to {"NS":["6", "2", "1"]} - // - // For usage examples of - // AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) + // than, etc. The following comparison operators are available: EQ | NE | LE | LT + // | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | + // BETWEEN The following are descriptions of each comparison operator. + // - EQ : Equal. EQ is supported for all data types, including lists and maps. + // AttributeValueList can contain only one AttributeValue element of type String, + // Number, Binary, String Set, Number Set, or Binary Set. If an item contains an + // AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} . + // - NE : Not equal. NE is supported for all data types, including lists and + // maps. AttributeValueList can contain only one AttributeValue of type String, + // Number, Binary, String Set, Number Set, or Binary Set. If an item contains an + // AttributeValue of a different type than the one provided in the request, the + // value does not match. For example, {"S":"6"} does not equal {"N":"6"} . Also, + // {"N":"6"} does not equal {"NS":["6", "2", "1"]} . + // - LE : Less than or equal. AttributeValueList can contain only one + // AttributeValue element of type String, Number, or Binary (not a set type). If + // an item contains an AttributeValue element of a different type than the one + // provided in the request, the value does not match. For example, {"S":"6"} does + // not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} . + // - LT : Less than. AttributeValueList can contain only one AttributeValue of + // type String, Number, or Binary (not a set type). If an item contains an + // AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} . + // - GE : Greater than or equal. AttributeValueList can contain only one + // AttributeValue element of type String, Number, or Binary (not a set type). If + // an item contains an AttributeValue element of a different type than the one + // provided in the request, the value does not match. For example, {"S":"6"} does + // not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} . + // - GT : Greater than. AttributeValueList can contain only one AttributeValue + // element of type String, Number, or Binary (not a set type). If an item contains + // an AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} . + // - NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, + // including lists and maps. This operator tests for the existence of an attribute, + // not its data type. If the data type of attribute " a " is null, and you + // evaluate it using NOT_NULL , the result is a Boolean true . This result is + // because the attribute " a " exists; its data type is not relevant to the + // NOT_NULL comparison operator. + // - NULL : The attribute does not exist. NULL is supported for all data types, + // including lists and maps. This operator tests for the nonexistence of an + // attribute, not its data type. If the data type of attribute " a " is null, and + // you evaluate it using NULL , the result is a Boolean false . This is because + // the attribute " a " exists; its data type is not relevant to the NULL + // comparison operator. + // - CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList + // can contain only one AttributeValue element of type String, Number, or Binary + // (not a set type). If the target attribute of the comparison is of type String, + // then the operator checks for a substring match. If the target attribute of the + // comparison is of type Binary, then the operator looks for a subsequence of the + // target that matches the input. If the target attribute of the comparison is a + // set (" SS ", " NS ", or " BS "), then the operator evaluates to true if it + // finds an exact match with any member of the set. CONTAINS is supported for + // lists: When evaluating " a CONTAINS b ", " a " can be a list; however, " b " + // cannot be a set, a map, or a list. + // - NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in + // a set. AttributeValueList can contain only one AttributeValue element of type + // String, Number, or Binary (not a set type). If the target attribute of the + // comparison is a String, then the operator checks for the absence of a substring + // match. If the target attribute of the comparison is Binary, then the operator + // checks for the absence of a subsequence of the target that matches the input. If + // the target attribute of the comparison is a set (" SS ", " NS ", or " BS "), + // then the operator evaluates to true if it does not find an exact match with any + // member of the set. NOT_CONTAINS is supported for lists: When evaluating " a + // NOT CONTAINS b ", " a " can be a list; however, " b " cannot be a set, a map, + // or a list. + // - BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one + // AttributeValue of type String or Binary (not a Number or a set type). The + // target attribute of the comparison must be of type String or Binary (not a + // Number or a set type). + // - IN : Checks for matching elements in a list. AttributeValueList can contain + // one or more AttributeValue elements of type String, Number, or Binary. These + // attributes are compared against an existing attribute of an item. If any + // elements of the input are equal to the item attribute, the expression evaluates + // to true. + // - BETWEEN : Greater than or equal to the first value, and less than or equal + // to the second value. AttributeValueList must contain two AttributeValue + // elements of the same type, either String, Number, or Binary (not a set type). A + // target attribute matches if the target value is greater than, or equal to, the + // first element and less than, or equal to, the second element. If an item + // contains an AttributeValue element of a different type than the one provided + // in the request, the value does not match. For example, {"S":"6"} does not + // compare to {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} + // For usage examples of AttributeValueList and ComparisonOperator , see Legacy + // Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) // in the Amazon DynamoDB Developer Guide. // // This member is required. @@ -754,11 +692,10 @@ type Condition struct { // values in the list depends on the ComparisonOperator being used. For type // Number, value comparisons are numeric. String value comparisons for greater // than, equals, or less than are based on ASCII character code values. For - // example, a is greater than A, and a is greater than B. For a list of code - // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). For Binary, - // DynamoDB treats each byte of the binary data as unsigned when it compares binary - // values. + // example, a is greater than A , and a is greater than B . For a list of code + // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) + // . For Binary, DynamoDB treats each byte of the binary data as unsigned when it + // compares binary values. AttributeValueList []AttributeValue noSmithyDocumentSerde @@ -768,16 +705,15 @@ type Condition struct { // condition of specific attributes of the item. type ConditionCheck struct { - // A condition that must be satisfied in order for a conditional update to succeed. - // For more information, see Condition expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) + // A condition that must be satisfied in order for a conditional update to + // succeed. For more information, see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) // in the Amazon DynamoDB Developer Guide. // // This member is required. ConditionExpression *string - // The primary key of the item to be checked. Each element consists of an attribute - // name and a value for that attribute. + // The primary key of the item to be checked. Each element consists of an + // attribute name and a value for that attribute. // // This member is required. Key map[string]AttributeValue @@ -788,19 +724,17 @@ type ConditionCheck struct { TableName *string // One or more substitution tokens for attribute names in an expression. For more - // information, see Expression attribute names - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html) + // information, see Expression attribute names (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string // One or more values that can be substituted in an expression. For more - // information, see Condition expressions - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) + // information, see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]AttributeValue // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the - // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the + // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure , the // valid values are: NONE and ALL_OLD. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure @@ -810,8 +744,7 @@ type ConditionCheck struct { // The capacity units consumed by an 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 -// request asked for it. For more information, see Provisioned Throughput -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) +// request asked for it. For more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. type ConsumedCapacity struct { @@ -893,8 +826,7 @@ type CreateGlobalSecondaryIndexAction struct { // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, - // see Service, Account, and Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughput @@ -926,7 +858,7 @@ type CreateReplicationGroupMemberAction struct { // The KMS key that should be used for KMS encryption in the new replica. To // specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias // ARN. Note that you should only provide this parameter if the key is different - // from the default DynamoDB KMS key alias/aws/dynamodb. + // from the default DynamoDB KMS key alias/aws/dynamodb . KMSMasterKeyId *string // Replica-specific provisioned throughput. If not specified, uses the source @@ -958,8 +890,8 @@ type CsvOptions struct { // Represents a request to perform a DeleteItem operation. type Delete struct { - // The primary key of the item to be deleted. Each element consists of an attribute - // name and a value for that attribute. + // The primary key of the item to be deleted. Each element consists of an + // attribute name and a value for that attribute. // // This member is required. Key map[string]AttributeValue @@ -979,7 +911,7 @@ type Delete struct { ExpressionAttributeValues map[string]AttributeValue // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete - // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: + // condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are: // NONE and ALL_OLD. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure @@ -1022,9 +954,9 @@ type DeleteReplicationGroupMemberAction struct { // Represents a request to perform a DeleteItem operation on an item. type DeleteRequest struct { - // A map of attribute name to attribute values, representing the primary key of the - // item to delete. All of the table's primary key attributes must be specified, and - // their data types must match those of the table's key schema. + // A map of attribute name to attribute values, representing the primary key of + // the item to delete. All of the table's primary key attributes must be specified, + // and their data types must match those of the table's key schema. // // This member is required. Key map[string]AttributeValue @@ -1049,181 +981,151 @@ type Endpoint struct { } // Represents a condition to be compared with an attribute value. This condition -// can be used with DeleteItem, PutItem, or UpdateItem operations; if the +// can be used with DeleteItem , PutItem , or UpdateItem operations; if the // comparison evaluates to true, the operation succeeds; if not, the operation // fails. You can use ExpectedAttributeValue in one of two different ways: +// - Use AttributeValueList to specify one or more values to compare against an +// attribute. Use ComparisonOperator to specify how you want to perform the +// comparison. If the comparison evaluates to true, then the conditional operation +// succeeds. +// - Use Value to specify a value that DynamoDB will compare against an +// attribute. If the values match, then ExpectedAttributeValue evaluates to true +// and the conditional operation succeeds. Optionally, you can also set Exists to +// false, indicating that you do not expect to find the attribute value in the +// table. In this case, the conditional operation succeeds only if the comparison +// evaluates to false. // -// * Use -// AttributeValueList to specify one or more values to compare against an -// attribute. Use ComparisonOperator to specify how you want to perform the -// comparison. If the comparison evaluates to true, then the conditional operation -// succeeds. -// -// * Use Value to specify a value that DynamoDB will compare against an -// attribute. If the values match, then ExpectedAttributeValue evaluates to true -// and the conditional operation succeeds. Optionally, you can also set Exists to -// false, indicating that you do not expect to find the attribute value in the -// table. In this case, the conditional operation succeeds only if the comparison -// evaluates to false. -// -// Value and Exists are incompatible with AttributeValueList -// and ComparisonOperator. Note that if you use both sets of parameters at once, -// DynamoDB will return a ValidationException exception. +// Value and Exists are incompatible with AttributeValueList and ComparisonOperator +// . Note that if you use both sets of parameters at once, DynamoDB will return a +// ValidationException exception. type ExpectedAttributeValue struct { // One or more values to evaluate against the supplied attribute. The number of // values in the list depends on the ComparisonOperator being used. For type // Number, value comparisons are numeric. String value comparisons for greater // than, equals, or less than are based on ASCII character code values. For - // example, a is greater than A, and a is greater than B. For a list of code - // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). For Binary, - // DynamoDB treats each byte of the binary data as unsigned when it compares binary - // values. For information on specifying data types in JSON, see JSON Data Format - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html) + // example, a is greater than A , and a is greater than B . For a list of code + // values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) + // . For Binary, DynamoDB treats each byte of the binary data as unsigned when it + // compares binary values. For information on specifying data types in JSON, see + // JSON Data Format (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html) // in the Amazon DynamoDB Developer Guide. AttributeValueList []AttributeValue - // A comparator for evaluating attributes in the AttributeValueList. For example, + // A comparator for evaluating attributes in the AttributeValueList . For example, // equals, greater than, less than, etc. The following comparison operators are // available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | // NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each // comparison operator. - // - // * EQ : Equal. EQ is supported for all data types, - // including lists and maps. AttributeValueList can contain only one AttributeValue - // element of type String, Number, Binary, String Set, Number Set, or Binary Set. - // If an item contains an AttributeValue element of a different type than the one - // provided in the request, the value does not match. For example, {"S":"6"} does - // not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. - // - // * - // NE : Not equal. NE is supported for all data types, including lists and maps. - // AttributeValueList can contain only one AttributeValue of type String, Number, - // Binary, String Set, Number Set, or Binary Set. If an item contains an - // AttributeValue of a different type than the one provided in the request, the - // value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, - // {"N":"6"} does not equal {"NS":["6", "2", "1"]}. - // - // * LE : Less than or equal. - // AttributeValueList can contain only one AttributeValue element of type String, - // Number, or Binary (not a set type). If an item contains an AttributeValue - // element of a different type than the one provided in the request, the value does - // not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does - // not compare to {"NS":["6", "2", "1"]}. - // - // * LT : Less than. AttributeValueList can - // contain only one AttributeValue of type String, Number, or Binary (not a set - // type). If an item contains an AttributeValue element of a different type than - // the one provided in the request, the value does not match. For example, - // {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to - // {"NS":["6", "2", "1"]}. - // - // * GE : Greater than or equal. AttributeValueList can - // contain only one AttributeValue element of type String, Number, or Binary (not a - // set type). If an item contains an AttributeValue element of a different type - // than the one provided in the request, the value does not match. For example, - // {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to - // {"NS":["6", "2", "1"]}. - // - // * GT : Greater than. AttributeValueList can contain - // only one AttributeValue element of type String, Number, or Binary (not a set - // type). If an item contains an AttributeValue element of a different type than - // the one provided in the request, the value does not match. For example, - // {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to - // {"NS":["6", "2", "1"]}. - // - // * NOT_NULL : The attribute exists. NOT_NULL is - // supported for all data types, including lists and maps. This operator tests for - // the existence of an attribute, not its data type. If the data type of attribute - // "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. - // This result is because the attribute "a" exists; its data type is not relevant - // to the NOT_NULL comparison operator. - // - // * NULL : The attribute does not exist. - // NULL is supported for all data types, including lists and maps. This operator - // tests for the nonexistence of an attribute, not its data type. If the data type - // of attribute "a" is null, and you evaluate it using NULL, the result is a - // Boolean false. This is because the attribute "a" exists; its data type is not - // relevant to the NULL comparison operator. - // - // * CONTAINS : Checks for a - // subsequence, or value in a set. AttributeValueList can contain only one - // AttributeValue element of type String, Number, or Binary (not a set type). If - // the target attribute of the comparison is of type String, then the operator - // checks for a substring match. If the target attribute of the comparison is of - // type Binary, then the operator looks for a subsequence of the target that - // matches the input. If the target attribute of the comparison is a set ("SS", - // "NS", or "BS"), then the operator evaluates to true if it finds an exact match - // with any member of the set. CONTAINS is supported for lists: When evaluating "a - // CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a - // list. - // - // * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a - // value in a set. AttributeValueList can contain only one AttributeValue element - // of type String, Number, or Binary (not a set type). If the target attribute of - // the comparison is a String, then the operator checks for the absence of a - // substring match. If the target attribute of the comparison is Binary, then the - // operator checks for the absence of a subsequence of the target that matches the - // input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), - // then the operator evaluates to true if it does not find an exact match with any - // member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT - // CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a - // list. - // - // * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only - // one AttributeValue of type String or Binary (not a Number or a set type). The - // target attribute of the comparison must be of type String or Binary (not a - // Number or a set type). - // - // * IN : Checks for matching elements in a list. - // AttributeValueList can contain one or more AttributeValue elements of type - // String, Number, or Binary. These attributes are compared against an existing - // attribute of an item. If any elements of the input are equal to the item - // attribute, the expression evaluates to true. - // - // * BETWEEN : Greater than or equal - // to the first value, and less than or equal to the second value. - // AttributeValueList must contain two AttributeValue elements of the same type, - // either String, Number, or Binary (not a set type). A target attribute matches if - // the target value is greater than, or equal to, the first element and less than, - // or equal to, the second element. If an item contains an AttributeValue element - // of a different type than the one provided in the request, the value does not - // match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} - // does not compare to {"NS":["6", "2", "1"]} + // - EQ : Equal. EQ is supported for all data types, including lists and maps. + // AttributeValueList can contain only one AttributeValue element of type String, + // Number, Binary, String Set, Number Set, or Binary Set. If an item contains an + // AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} . + // - NE : Not equal. NE is supported for all data types, including lists and + // maps. AttributeValueList can contain only one AttributeValue of type String, + // Number, Binary, String Set, Number Set, or Binary Set. If an item contains an + // AttributeValue of a different type than the one provided in the request, the + // value does not match. For example, {"S":"6"} does not equal {"N":"6"} . Also, + // {"N":"6"} does not equal {"NS":["6", "2", "1"]} . + // - LE : Less than or equal. AttributeValueList can contain only one + // AttributeValue element of type String, Number, or Binary (not a set type). If + // an item contains an AttributeValue element of a different type than the one + // provided in the request, the value does not match. For example, {"S":"6"} does + // not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} . + // - LT : Less than. AttributeValueList can contain only one AttributeValue of + // type String, Number, or Binary (not a set type). If an item contains an + // AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} . + // - GE : Greater than or equal. AttributeValueList can contain only one + // AttributeValue element of type String, Number, or Binary (not a set type). If + // an item contains an AttributeValue element of a different type than the one + // provided in the request, the value does not match. For example, {"S":"6"} does + // not equal {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} . + // - GT : Greater than. AttributeValueList can contain only one AttributeValue + // element of type String, Number, or Binary (not a set type). If an item contains + // an AttributeValue element of a different type than the one provided in the + // request, the value does not match. For example, {"S":"6"} does not equal + // {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} . + // - NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, + // including lists and maps. This operator tests for the existence of an attribute, + // not its data type. If the data type of attribute " a " is null, and you + // evaluate it using NOT_NULL , the result is a Boolean true . This result is + // because the attribute " a " exists; its data type is not relevant to the + // NOT_NULL comparison operator. + // - NULL : The attribute does not exist. NULL is supported for all data types, + // including lists and maps. This operator tests for the nonexistence of an + // attribute, not its data type. If the data type of attribute " a " is null, and + // you evaluate it using NULL , the result is a Boolean false . This is because + // the attribute " a " exists; its data type is not relevant to the NULL + // comparison operator. + // - CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList + // can contain only one AttributeValue element of type String, Number, or Binary + // (not a set type). If the target attribute of the comparison is of type String, + // then the operator checks for a substring match. If the target attribute of the + // comparison is of type Binary, then the operator looks for a subsequence of the + // target that matches the input. If the target attribute of the comparison is a + // set (" SS ", " NS ", or " BS "), then the operator evaluates to true if it + // finds an exact match with any member of the set. CONTAINS is supported for + // lists: When evaluating " a CONTAINS b ", " a " can be a list; however, " b " + // cannot be a set, a map, or a list. + // - NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in + // a set. AttributeValueList can contain only one AttributeValue element of type + // String, Number, or Binary (not a set type). If the target attribute of the + // comparison is a String, then the operator checks for the absence of a substring + // match. If the target attribute of the comparison is Binary, then the operator + // checks for the absence of a subsequence of the target that matches the input. If + // the target attribute of the comparison is a set (" SS ", " NS ", or " BS "), + // then the operator evaluates to true if it does not find an exact match with any + // member of the set. NOT_CONTAINS is supported for lists: When evaluating " a + // NOT CONTAINS b ", " a " can be a list; however, " b " cannot be a set, a map, + // or a list. + // - BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one + // AttributeValue of type String or Binary (not a Number or a set type). The + // target attribute of the comparison must be of type String or Binary (not a + // Number or a set type). + // - IN : Checks for matching elements in a list. AttributeValueList can contain + // one or more AttributeValue elements of type String, Number, or Binary. These + // attributes are compared against an existing attribute of an item. If any + // elements of the input are equal to the item attribute, the expression evaluates + // to true. + // - BETWEEN : Greater than or equal to the first value, and less than or equal + // to the second value. AttributeValueList must contain two AttributeValue + // elements of the same type, either String, Number, or Binary (not a set type). A + // target attribute matches if the target value is greater than, or equal to, the + // first element and less than, or equal to, the second element. If an item + // contains an AttributeValue element of a different type than the one provided + // in the request, the value does not match. For example, {"S":"6"} does not + // compare to {"N":"6"} . Also, {"N":"6"} does not compare to {"NS":["6", "2", + // "1"]} ComparisonOperator ComparisonOperator // Causes DynamoDB to evaluate the value before attempting a conditional // operation: - // - // * If Exists is true, DynamoDB will check to see if that attribute - // value already exists in the table. If it is found, then the operation succeeds. - // If it is not found, the operation fails with a ConditionCheckFailedException. - // - // * - // If Exists is false, DynamoDB assumes that the attribute value does not exist in - // the table. If in fact the value does not exist, then the assumption is valid and - // the operation succeeds. If the value is found, despite the assumption that it - // does not exist, the operation fails with a ConditionCheckFailedException. - // - // The - // default setting for Exists is true. If you supply a Value all by itself, - // DynamoDB assumes the attribute exists: You don't have to set Exists to true, + // - If Exists is true , DynamoDB will check to see if that attribute value + // already exists in the table. If it is found, then the operation succeeds. If it + // is not found, the operation fails with a ConditionCheckFailedException . + // - If Exists is false , DynamoDB assumes that the attribute value does not + // exist in the table. If in fact the value does not exist, then the assumption is + // valid and the operation succeeds. If the value is found, despite the assumption + // that it does not exist, the operation fails with a + // ConditionCheckFailedException . + // The default setting for Exists is true . If you supply a Value all by itself, + // DynamoDB assumes the attribute exists: You don't have to set Exists to true , // because it is implied. DynamoDB returns a ValidationException if: - // - // * Exists is - // true but there is no Value to check. (You expect a value to exist, but don't - // specify what that value is.) - // - // * Exists is false but you also provide a Value. - // (You cannot expect an attribute to have a value, while also expecting it not to - // exist.) + // - Exists is true but there is no Value to check. (You expect a value to exist, + // but don't specify what that value is.) + // - Exists is false but you also provide a Value . (You cannot expect an + // attribute to have a value, while also expecting it not to exist.) Exists *bool // Represents the data for the expected attribute. Each attribute value is // described as a name-value pair. The name is the data type, and the value is the - // data itself. For more information, see Data Types - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) + // data itself. For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) // in the Amazon DynamoDB Developer Guide. Value AttributeValue @@ -1248,7 +1150,7 @@ type ExportDescription struct { ExportArn *string // The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON - // or ION. + // or ION . ExportFormat ExportFormat // The name of the manifest file for the export task. @@ -1282,15 +1184,12 @@ type ExportDescription struct { // Type of encryption used on the bucket where export data is stored. Valid values // for S3SseAlgorithm are: - // - // * AES256 - server-side encryption with Amazon S3 - // managed keys - // - // * KMS - server-side encryption with KMS managed keys + // - AES256 - server-side encryption with Amazon S3 managed keys + // - KMS - server-side encryption with KMS managed keys S3SseAlgorithm S3SseAlgorithm - // The ID of the KMS managed key used to encrypt the S3 bucket where export data is - // stored (if applicable). + // The ID of the KMS managed key used to encrypt the S3 bucket where export data + // is stored (if applicable). S3SseKmsKeyId *string // The time at which the export task began. @@ -1369,15 +1268,11 @@ type GlobalSecondaryIndex struct { // The complete key schema for a global secondary index, which consists of one or // more pairs of attribute names and key types: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. @@ -1385,17 +1280,16 @@ type GlobalSecondaryIndex struct { // This member is required. KeySchema []KeySchemaElement - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // Represents attributes that are copied (projected) from the table into the + // global secondary index. These are in addition to the primary key attributes and + // index key attributes, which are automatically projected. // // This member is required. Projection *Projection // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, - // see Service, Account, and Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughput @@ -1409,8 +1303,8 @@ type GlobalSecondaryIndexAutoScalingUpdate struct { // The name of the global secondary index. IndexName *string - // Represents the auto scaling settings to be modified for a global table or global - // secondary index. + // Represents the auto scaling settings to be modified for a global table or + // global secondary index. ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate noSmithyDocumentSerde @@ -1419,17 +1313,17 @@ type GlobalSecondaryIndexAutoScalingUpdate struct { // Represents the properties of a global secondary index. type GlobalSecondaryIndexDescription struct { - // Indicates whether the index is currently backfilling. Backfilling is the process - // of reading items from the table and determining whether they can be added to the - // index. (Not all items will qualify: For example, a partition key cannot have any - // duplicate values.) If an item can be added to the index, DynamoDB will do so. - // After all items have been processed, the backfilling operation is complete and - // Backfilling is false. You can delete an index that is being created during the - // Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. - // You can't delete the index that is being created when IndexStatus is set to - // CREATING and Backfilling is false. For indexes that were created during a - // CreateTable operation, the Backfilling attribute does not appear in the - // DescribeTable output. + // Indicates whether the index is currently backfilling. Backfilling is the + // process of reading items from the table and determining whether they can be + // added to the index. (Not all items will qualify: For example, a partition key + // cannot have any duplicate values.) If an item can be added to the index, + // DynamoDB will do so. After all items have been processed, the backfilling + // operation is complete and Backfilling is false. You can delete an index that is + // being created during the Backfilling phase when IndexStatus is set to CREATING + // and Backfilling is true. You can't delete the index that is being created when + // IndexStatus is set to CREATING and Backfilling is false. For indexes that were + // created during a CreateTable operation, the Backfilling attribute does not + // appear in the DescribeTable output. Backfilling *bool // The Amazon Resource Name (ARN) that uniquely identifies the index. @@ -1444,16 +1338,10 @@ type GlobalSecondaryIndexDescription struct { IndexSizeBytes *int64 // The current state of the global secondary index: - // - // * CREATING - The index is - // being created. - // - // * UPDATING - The index is being updated. - // - // * DELETING - The index - // is being deleted. - // - // * ACTIVE - The index is ready for use. + // - CREATING - The index is being created. + // - UPDATING - The index is being updated. + // - DELETING - The index is being deleted. + // - ACTIVE - The index is ready for use. IndexStatus IndexStatus // The number of items in the specified index. DynamoDB updates this value @@ -1463,29 +1351,24 @@ type GlobalSecondaryIndexDescription struct { // The complete key schema for a global secondary index, which consists of one or // more pairs of attribute names and key types: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. KeySchema []KeySchemaElement - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // Represents attributes that are copied (projected) from the table into the + // global secondary index. These are in addition to the primary key attributes and + // index key attributes, which are automatically projected. Projection *Projection // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, - // see Service, Account, and Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughputDescription @@ -1501,23 +1384,19 @@ type GlobalSecondaryIndexInfo struct { // The complete key schema for a global secondary index, which consists of one or // more pairs of attribute names and key types: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. KeySchema []KeySchemaElement - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // Represents attributes that are copied (projected) from the table into the + // global secondary index. These are in addition to the primary key attributes and + // index key attributes, which are automatically projected. Projection *Projection // Represents the provisioned throughput settings for the specified global @@ -1528,30 +1407,19 @@ type GlobalSecondaryIndexInfo struct { } // Represents one of the following: -// -// * A new global secondary index to be added to -// an existing table. -// -// * New provisioned throughput parameters for an existing -// global secondary index. -// -// * An existing global secondary index to be removed from -// an existing table. +// - A new global secondary index to be added to an existing table. +// - New provisioned throughput parameters for an existing global secondary +// index. +// - An existing global secondary index to be removed from an existing table. type GlobalSecondaryIndexUpdate struct { // The parameters required for creating a global secondary index on an existing // table: - // - // * IndexName - // - // * KeySchema - // - // * AttributeDefinitions - // - // * Projection - // - // * - // ProvisionedThroughput + // - IndexName + // - KeySchema + // - AttributeDefinitions + // - Projection + // - ProvisionedThroughput Create *CreateGlobalSecondaryIndexAction // The name of an existing global secondary index to be removed. @@ -1589,16 +1457,10 @@ type GlobalTableDescription struct { GlobalTableName *string // The current state of the global table: - // - // * CREATING - The global table is being - // created. - // - // * UPDATING - The global table is being updated. - // - // * DELETING - The - // global table is being deleted. - // - // * ACTIVE - The global table is ready for use. + // - CREATING - The global table is being created. + // - UPDATING - The global table is being updated. + // - DELETING - The global table is being deleted. + // - ACTIVE - The global table is ready for use. GlobalTableStatus GlobalTableStatus // The Regions where the global table has replicas. @@ -1607,8 +1469,8 @@ type GlobalTableDescription struct { noSmithyDocumentSerde } -// Represents the settings of a global secondary index for a global table that will -// be modified. +// Represents the settings of a global secondary index for a global table that +// will be modified. type GlobalTableGlobalSecondaryIndexSettingsUpdate struct { // The name of the global secondary index. The name must be unique among all other @@ -1645,7 +1507,7 @@ type ImportSummary struct { // The status of the import operation. ImportStatus ImportStatus - // The format of the source data. Valid values are CSV, DYNAMODB_JSON or ION. + // The format of the source data. Valid values are CSV , DYNAMODB_JSON or ION . InputFormat InputFormat // The path and S3 bucket of the source file that is being imported. This includes @@ -1665,12 +1527,12 @@ type ImportSummary struct { // Represents the properties of the table being imported into. type ImportTableDescription struct { - // The client token that was provided for the import task. Reusing the client token - // on retry makes a call to ImportTable idempotent. + // The client token that was provided for the import task. Reusing the client + // token on retry makes a call to ImportTable idempotent. ClientToken *string - // The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the - // target table. + // The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with + // the target table. CloudWatchLogGroupArn *string // The time at which the creation of the table associated with this import task @@ -1745,10 +1607,10 @@ type InputFormatOptions struct { noSmithyDocumentSerde } -// Information about item collections, if any, that were affected by the operation. -// ItemCollectionMetrics is only returned if the request asked for it. If the table -// does not have any local secondary indexes, this information is not returned in -// the response. +// Information about item collections, if any, that were affected by the +// operation. ItemCollectionMetrics is only returned if the request asked for it. +// If the table does not have any local secondary indexes, this information is not +// returned in the response. type ItemCollectionMetrics struct { // The partition key value of the item collection. This value is the same as the @@ -1790,53 +1652,35 @@ type KeysAndAttributes struct { Keys []map[string]AttributeValue // This is a legacy parameter. Use ProjectionExpression instead. For more - // information, see Legacy Conditional Parameters - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) + // information, see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []string - // The consistency of a read operation. If set to true, then a strongly consistent + // The consistency of a read operation. If set to true , then a strongly consistent // read is used; otherwise, an eventually consistent read is used. ConsistentRead *bool // One or more substitution tokens for attribute names in an expression. The - // following are some use cases for using ExpressionAttributeNames: - // - // * To access an - // attribute whose name conflicts with a DynamoDB reserved word. - // - // * To create a - // placeholder for repeating occurrences of an attribute name in an expression. - // - // * - // To prevent special characters in an attribute name from being misinterpreted in - // an expression. - // - // Use the # character in an expression to dereference an attribute - // name. For example, consider the following attribute name: - // - // * Percentile - // - // The - // name of this attribute conflicts with a reserved word, so it cannot be used + // following are some use cases for using ExpressionAttributeNames : + // - To access an attribute whose name conflicts with a DynamoDB reserved word. + // - To create a placeholder for repeating occurrences of an attribute name in + // an expression. + // - To prevent special characters in an attribute name from being + // misinterpreted in an expression. + // Use the # character in an expression to dereference an attribute name. For + // example, consider the following attribute name: + // - Percentile + // 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) + // 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 - // the following for ExpressionAttributeNames: - // - // * {"#P":"Percentile"} - // - // 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 - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // the following for ExpressionAttributeNames : + // - {"#P":"Percentile"} + // 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]string @@ -1845,8 +1689,7 @@ type KeysAndAttributes struct { // attributes in the ProjectionExpression 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 Item Attributes - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) + // more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string @@ -1859,8 +1702,8 @@ type KeysAndAttributes struct { // For example, a simple primary key would be represented by one KeySchemaElement // (for the partition key). A composite primary key would require one // KeySchemaElement for the partition key, and another KeySchemaElement for the -// sort key. A KeySchemaElement must be a scalar, top-level attribute (not a nested -// attribute). The data type must be one of String, Number, or Binary. The +// sort key. A KeySchemaElement must be a scalar, top-level attribute (not a +// nested attribute). The data type must be one of String, Number, or Binary. The // attribute cannot be nested within a List or a Map. type KeySchemaElement struct { @@ -1870,15 +1713,11 @@ type KeySchemaElement struct { AttributeName *string // The role that this key attribute will assume: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. @@ -1913,14 +1752,10 @@ type LocalSecondaryIndex struct { // This member is required. IndexName *string - // The complete key schema for the local secondary index, consisting of one or more - // pairs of attribute names and key types: - // - // * HASH - partition key - // - // * RANGE - sort - // key - // + // The complete key schema for the local secondary index, consisting of one or + // more pairs of attribute names and key types: + // - 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's usage of an internal hash function to // evenly distribute data items across partitions, based on their partition key @@ -1960,14 +1795,10 @@ type LocalSecondaryIndexDescription struct { // value. ItemCount *int64 - // The complete key schema for the local secondary index, consisting of one or more - // pairs of attribute names and key types: - // - // * HASH - partition key - // - // * RANGE - sort - // key - // + // The complete key schema for the local secondary index, consisting of one or + // more pairs of attribute names and key types: + // - 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's usage of an internal hash function to // evenly distribute data items across partitions, based on their partition key @@ -1976,9 +1807,9 @@ type LocalSecondaryIndexDescription struct { // partition key physically close together, in sorted order by the sort key value. KeySchema []KeySchemaElement - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // Represents attributes that are copied (projected) from the table into the + // global secondary index. These are in addition to the primary key attributes and + // index key attributes, which are automatically projected. Projection *Projection noSmithyDocumentSerde @@ -1993,23 +1824,19 @@ type LocalSecondaryIndexInfo struct { // The complete key schema for a local secondary index, which consists of one or // more pairs of attribute names and key types: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. KeySchema []KeySchemaElement - // Represents attributes that are copied (projected) from the table into the global - // secondary index. These are in addition to the primary key attributes and index - // key attributes, which are automatically projected. + // Represents attributes that are copied (projected) from the table into the + // global secondary index. These are in addition to the primary key attributes and + // index key attributes, which are automatically projected. Projection *Projection noSmithyDocumentSerde @@ -2040,11 +1867,8 @@ type PointInTimeRecoveryDescription struct { LatestRestorableDateTime *time.Time // The current state of point in time recovery: - // - // * ENABLED - Point in time recovery - // is enabled. - // - // * DISABLED - Point in time recovery is disabled. + // - ENABLED - Point in time recovery is enabled. + // - DISABLED - Point in time recovery is disabled. PointInTimeRecoveryStatus PointInTimeRecoveryStatus noSmithyDocumentSerde @@ -2075,16 +1899,10 @@ type Projection struct { NonKeyAttributes []string // The set of attributes that are projected into the index: - // - // * KEYS_ONLY - Only the - // index and primary keys are projected into the index. - // - // * INCLUDE - In addition to - // the attributes described in KEYS_ONLY, the secondary index will include other - // non-key attributes that you specify. - // - // * ALL - All of the table attributes are - // projected into the index. + // - KEYS_ONLY - Only the index and primary keys are projected into the index. + // - INCLUDE - In addition to the attributes described in KEYS_ONLY , the + // secondary index will include other non-key attributes that you specify. + // - ALL - All of the table attributes are projected into the index. ProjectionType ProjectionType noSmithyDocumentSerde @@ -2093,15 +1911,13 @@ type Projection struct { // Represents the provisioned throughput settings for a specified table or index. // The settings can be modified using the UpdateTable operation. For current // minimum and maximum provisioned throughput values, see Service, Account, and -// Table Quotas -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) +// Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. type ProvisionedThroughput struct { // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. For more information, see Specifying - // Read and Write Requirements - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) + // DynamoDB returns a ThrottlingException . For more information, see Specifying + // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. If read/write capacity mode is // PAY_PER_REQUEST the value is set to 0. // @@ -2109,9 +1925,8 @@ type ProvisionedThroughput struct { ReadCapacityUnits *int64 // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. For more information, see Specifying Read and Write - // Requirements - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) + // ThrottlingException . For more information, see Specifying Read and Write + // Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. If read/write capacity mode is // PAY_PER_REQUEST the value is set to 0. // @@ -2121,8 +1936,8 @@ type ProvisionedThroughput struct { noSmithyDocumentSerde } -// Represents the provisioned throughput settings for the table, consisting of read -// and write capacity units, along with data about increases and decreases. +// Represents the provisioned throughput settings for the table, consisting of +// read and write capacity units, along with data about increases and decreases. type ProvisionedThroughputDescription struct { // The date and time of the last provisioned throughput decrease for this table. @@ -2133,19 +1948,18 @@ type ProvisionedThroughputDescription struct { // The number of provisioned throughput decreases for this table during this UTC // calendar day. For current maximums on provisioned throughput decreases, see - // Service, Account, and Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. NumberOfDecreasesToday *int64 // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. Eventually consistent reads require less - // effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per - // second provides 100 eventually consistent ReadCapacityUnits per second. + // DynamoDB returns a ThrottlingException . Eventually consistent reads require + // less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits + // per second provides 100 eventually consistent ReadCapacityUnits per second. ReadCapacityUnits *int64 // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. + // ThrottlingException . WriteCapacityUnits *int64 noSmithyDocumentSerde @@ -2165,11 +1979,11 @@ type ProvisionedThroughputOverride struct { // Represents a request to perform a PutItem operation. type Put struct { - // A map of attribute name to attribute values, representing the primary key of the - // item to be written by PutItem. All of the table's primary key attributes must be - // specified, and their data types must match those of the table's key schema. If - // any attributes are present in the item that are part of an index key schema for - // the table, their types must match the index key schema. + // A map of attribute name to attribute values, representing the primary key of + // the item to be written by PutItem . All of the table's primary key attributes + // must be specified, and their data types must match those of the table's key + // schema. If any attributes are present in the item that are part of an index key + // schema for the table, their types must match the index key schema. // // This member is required. Item map[string]AttributeValue @@ -2189,7 +2003,7 @@ type Put struct { ExpressionAttributeValues map[string]AttributeValue // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put - // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: + // condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are: // NONE and ALL_OLD. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure @@ -2200,7 +2014,7 @@ type Put struct { type PutRequest struct { // A map of attribute name to attribute values, representing the primary key of an - // item to be processed by PutItem. All of the table's primary key attributes must + // item to be processed by PutItem . All of the table's primary key attributes must // be specified, and their data types must match those of the table's key schema. // If any attributes are present in the item that are part of an index key schema // for the table, their types must match the index key schema. @@ -2238,16 +2052,10 @@ type ReplicaAutoScalingDescription struct { ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription // The current state of the replica: - // - // * CREATING - The replica is being created. - // - // * - // UPDATING - The replica is being updated. - // - // * DELETING - The replica is being - // deleted. - // - // * ACTIVE - The replica is ready for use. + // - CREATING - The replica is being created. + // - UPDATING - The replica is being updated. + // - DELETING - The replica is being deleted. + // - ACTIVE - The replica is ready for use. ReplicaStatus ReplicaStatus noSmithyDocumentSerde @@ -2265,8 +2073,8 @@ type ReplicaAutoScalingUpdate struct { // modified. ReplicaGlobalSecondaryIndexUpdates []ReplicaGlobalSecondaryIndexAutoScalingUpdate - // Represents the auto scaling settings to be modified for a global table or global - // secondary index. + // Represents the auto scaling settings to be modified for a global table or + // global secondary index. ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate noSmithyDocumentSerde @@ -2293,35 +2101,26 @@ type ReplicaDescription struct { ReplicaInaccessibleDateTime *time.Time // The current state of the replica: - // - // * CREATING - The replica is being created. - // - // * - // UPDATING - The replica is being updated. - // - // * DELETING - The replica is being - // deleted. - // - // * ACTIVE - The replica is ready for use. - // - // * REGION_DISABLED - The - // replica is inaccessible because the Amazon Web Services Region has been - // disabled. If the Amazon Web Services Region remains inaccessible for more than - // 20 hours, DynamoDB will remove this replica from the replication group. The - // replica will not be deleted and replication will stop from and to this - // region. - // - // * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt - // the table is inaccessible. If the KMS key remains inaccessible for more than 20 - // hours, DynamoDB will remove this replica from the replication group. The replica - // will not be deleted and replication will stop from and to this region. + // - CREATING - The replica is being created. + // - UPDATING - The replica is being updated. + // - DELETING - The replica is being deleted. + // - ACTIVE - The replica is ready for use. + // - REGION_DISABLED - The replica is inaccessible because the Amazon Web + // Services Region has been disabled. If the Amazon Web Services Region remains + // inaccessible for more than 20 hours, DynamoDB will remove this replica from the + // replication group. The replica will not be deleted and replication will stop + // from and to this region. + // - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table + // is inaccessible. If the KMS key remains inaccessible for more than 20 hours, + // DynamoDB will remove this replica from the replication group. The replica will + // not be deleted and replication will stop from and to this region. ReplicaStatus ReplicaStatus // Detailed information about the replica status. ReplicaStatusDescription *string - // Specifies the progress of a Create, Update, or Delete action on the replica as a - // percentage. + // Specifies the progress of a Create, Update, or Delete action on the replica as + // a percentage. ReplicaStatusPercentProgress *string // Contains details of the table class. @@ -2352,17 +2151,11 @@ type ReplicaGlobalSecondaryIndexAutoScalingDescription struct { IndexName *string // The current state of the replica global secondary index: - // - // * CREATING - The index - // is being created. - // - // * UPDATING - The table/index configuration is being updated. - // The table/index remains available for data operations when UPDATING - // - // * DELETING - // - The index is being deleted. - // - // * ACTIVE - The index is ready for use. + // - CREATING - The index is being created. + // - UPDATING - The table/index configuration is being updated. The table/index + // remains available for data operations when UPDATING + // - DELETING - The index is being deleted. + // - ACTIVE - The index is ready for use. IndexStatus IndexStatus // Represents the auto scaling settings for a global table or global secondary @@ -2383,8 +2176,8 @@ type ReplicaGlobalSecondaryIndexAutoScalingUpdate struct { // The name of the global secondary index. IndexName *string - // Represents the auto scaling settings to be modified for a global table or global - // secondary index. + // Represents the auto scaling settings to be modified for a global table or + // global secondary index. ProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate noSmithyDocumentSerde @@ -2412,17 +2205,10 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { IndexName *string // The current status of the global secondary index: - // - // * CREATING - The global - // secondary index is being created. - // - // * UPDATING - The global secondary index is - // being updated. - // - // * DELETING - The global secondary index is being deleted. - // - // * - // ACTIVE - The global secondary index is ready for use. + // - CREATING - The global secondary index is being created. + // - UPDATING - The global secondary index is being updated. + // - DELETING - The global secondary index is being deleted. + // - ACTIVE - The global secondary index is ready for use. IndexStatus IndexStatus // Auto scaling settings for a global secondary index replica's read capacity @@ -2430,7 +2216,7 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. + // DynamoDB returns a ThrottlingException . ProvisionedReadCapacityUnits *int64 // Auto scaling settings for a global secondary index replica's write capacity @@ -2438,14 +2224,14 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. + // ThrottlingException . ProvisionedWriteCapacityUnits *int64 noSmithyDocumentSerde } -// Represents the settings of a global secondary index for a global table that will -// be modified. +// Represents the settings of a global secondary index for a global table that +// will be modified. type ReplicaGlobalSecondaryIndexSettingsUpdate struct { // The name of the global secondary index. The name must be unique among all other @@ -2459,7 +2245,7 @@ type ReplicaGlobalSecondaryIndexSettingsUpdate struct { ProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. + // DynamoDB returns a ThrottlingException . ProvisionedReadCapacityUnits *int64 noSmithyDocumentSerde @@ -2483,9 +2269,8 @@ type ReplicaSettingsDescription struct { ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. For more information, see Specifying - // Read and Write Requirements - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) + // DynamoDB returns a ThrottlingException . For more information, see Specifying + // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedReadCapacityUnits *int64 @@ -2493,23 +2278,16 @@ type ReplicaSettingsDescription struct { ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. For more information, see Specifying Read and Write - // Requirements - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) + // ThrottlingException . For more information, see Specifying Read and Write + // Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedWriteCapacityUnits *int64 // The current state of the Region: - // - // * CREATING - The Region is being created. - // - // * - // UPDATING - The Region is being updated. - // - // * DELETING - The Region is being - // deleted. - // - // * ACTIVE - The Region is ready for use. + // - CREATING - The Region is being created. + // - UPDATING - The Region is being updated. + // - DELETING - The Region is being deleted. + // - ACTIVE - The Region is ready for use. ReplicaStatus ReplicaStatus // Contains details of the table class. @@ -2526,17 +2304,16 @@ type ReplicaSettingsUpdate struct { // This member is required. RegionName *string - // Represents the settings of a global secondary index for a global table that will - // be modified. + // Represents the settings of a global secondary index for a global table that + // will be modified. ReplicaGlobalSecondaryIndexSettingsUpdate []ReplicaGlobalSecondaryIndexSettingsUpdate // Auto scaling settings for managing a global table replica's read capacity units. ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. For more information, see Specifying - // Read and Write Requirements - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) + // DynamoDB returns a ThrottlingException . For more information, see Specifying + // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. ReplicaProvisionedReadCapacityUnits *int64 @@ -2548,22 +2325,17 @@ type ReplicaSettingsUpdate struct { } // Represents one of the following: +// - A new replica to be added to an existing regional table or global table. +// This request invokes the CreateTableReplica action in the destination Region. +// - New parameters for an existing replica. This request invokes the UpdateTable +// action in the destination Region. +// - An existing replica to be deleted. The request invokes the +// DeleteTableReplica action in the destination Region, deleting the replica and +// all if its items in the destination Region. // -// * A new replica to be added to an existing -// regional table or global table. This request invokes the CreateTableReplica -// action in the destination Region. -// -// * New parameters for an existing replica. -// This request invokes the UpdateTable action in the destination Region. -// -// * An -// existing replica to be deleted. The request invokes the DeleteTableReplica -// action in the destination Region, deleting the replica and all if its items in -// the destination Region. -// -// When you manually remove a table or global table -// replica, you do not automatically remove any associated scalable targets, -// scaling policies, or CloudWatch alarms. +// When you manually remove a table or global table replica, you do not +// automatically remove any associated scalable targets, scaling policies, or +// CloudWatch alarms. type ReplicationGroupUpdate struct { // The parameters required for creating a replica for the table. @@ -2579,14 +2351,9 @@ type ReplicationGroupUpdate struct { } // Represents one of the following: -// -// * A new replica to be added to an existing -// global table. -// -// * New parameters for an existing replica. -// -// * An existing replica -// to be removed from an existing global table. +// - A new replica to be added to an existing global table. +// - New parameters for an existing replica. +// - An existing replica to be removed from an existing global table. type ReplicaUpdate struct { // The parameters required for creating a replica on an existing global table. @@ -2668,13 +2435,10 @@ type SourceTableDetails struct { // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. - // - // * PROVISIONED - Sets the - // read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for - // predictable workloads. - // - // * PAY_PER_REQUEST - Sets the read/write capacity mode to - // PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads. + // - PROVISIONED - Sets the read/write capacity mode to PROVISIONED . We + // recommend using PROVISIONED for predictable workloads. + // - PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST . We + // recommend using PAY_PER_REQUEST for unpredictable workloads. BillingMode BillingMode // Number of items in the table. Note that this is an approximate value. @@ -2730,19 +2494,14 @@ type SSEDescription struct { KMSMasterKeyArn *string // Server-side encryption type. The only supported value is: - // - // * KMS - Server-side - // encryption that uses Key Management Service. The key is stored in your account - // and is managed by KMS (KMS charges apply). + // - KMS - Server-side encryption that uses Key Management Service. The key is + // stored in your account and is managed by KMS (KMS charges apply). SSEType SSEType // Represents the current state of server-side encryption. The only supported // values are: - // - // * ENABLED - Server-side encryption is enabled. - // - // * UPDATING - - // Server-side encryption is being updated. + // - ENABLED - Server-side encryption is enabled. + // - UPDATING - Server-side encryption is being updated. Status SSEStatus noSmithyDocumentSerde @@ -2761,14 +2520,12 @@ type SSESpecification struct { // The KMS key that should be used for the KMS encryption. To specify a key, use // its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you // should only provide this parameter if the key is different from the default - // DynamoDB key alias/aws/dynamodb. + // DynamoDB key alias/aws/dynamodb . KMSMasterKeyId *string // Server-side encryption type. The only supported value is: - // - // * KMS - Server-side - // encryption that uses Key Management Service. The key is stored in your account - // and is managed by KMS (KMS charges apply). + // - KMS - Server-side encryption that uses Key Management Service. The key is + // stored in your account and is managed by KMS (KMS charges apply). SSEType SSEType noSmithyDocumentSerde @@ -2786,18 +2543,14 @@ type StreamSpecification struct { // When an item in the table is modified, StreamViewType determines what // information is written to the stream for this table. Valid values for // StreamViewType are: - // - // * KEYS_ONLY - Only the key attributes of the modified item - // are written to the stream. - // - // * NEW_IMAGE - The entire item, as it appears after - // it was modified, is written to the stream. - // - // * OLD_IMAGE - The entire item, as it - // appeared before it was modified, is written to the stream. - // - // * NEW_AND_OLD_IMAGES - // - Both the new and the old item images of the item are written to the stream. + // - KEYS_ONLY - Only the key attributes of the modified item are written to the + // stream. + // - NEW_IMAGE - The entire item, as it appears after it was modified, is written + // to the stream. + // - OLD_IMAGE - The entire item, as it appeared before it was modified, is + // written to the stream. + // - NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are + // written to the stream. StreamViewType StreamViewType noSmithyDocumentSerde @@ -2813,16 +2566,10 @@ type TableAutoScalingDescription struct { TableName *string // The current state of the table: - // - // * CREATING - The table is being created. - // - // * - // UPDATING - The table is being updated. - // - // * DELETING - The table is being - // deleted. - // - // * ACTIVE - The table is ready for use. + // - CREATING - The table is being created. + // - UPDATING - The table is being updated. + // - DELETING - The table is being deleted. + // - ACTIVE - The table is ready for use. TableStatus TableStatus noSmithyDocumentSerde @@ -2835,7 +2582,7 @@ type TableClassSummary struct { LastUpdateDateTime *time.Time // The table class of the specified table. Valid values are STANDARD and - // STANDARD_INFREQUENT_ACCESS. + // STANDARD_INFREQUENT_ACCESS . TableClass TableClass noSmithyDocumentSerde @@ -2871,8 +2618,7 @@ type TableCreationParameters struct { // Represents the provisioned throughput settings for a specified table or index. // The settings can be modified using the UpdateTable operation. For current // minimum and maximum provisioned throughput values, see Service, Account, and - // Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughput @@ -2891,18 +2637,15 @@ type TableDescription struct { // An array of AttributeDefinition objects. Each of these objects describes one // attribute in the table and index key schema. Each AttributeDefinition object in // this array is composed of: - // - // * AttributeName - The name of the attribute. - // - // * - // AttributeType - The data type for the attribute. + // - AttributeName - The name of the attribute. + // - AttributeType - The data type for the attribute. AttributeDefinitions []AttributeDefinition // Contains the details for the read/write capacity mode. BillingModeSummary *BillingModeSummary - // The date and time when the table was created, in UNIX epoch time - // (http://www.epochconverter.com/) format. + // The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/) + // format. CreationDateTime *time.Time // Indicates whether deletion protection is enabled (true) or disabled (false) on @@ -2911,82 +2654,52 @@ type TableDescription struct { // The global secondary indexes, if any, on the table. Each index is scoped to a // given partition key value. Each element is composed of: - // - // * Backfilling - If - // true, then the index is currently in the backfilling phase. Backfilling occurs - // only when a new global secondary index is added to the table. It is the process - // by which DynamoDB populates the new index with data from the table. (This - // attribute does not appear for indexes that were created during a CreateTable - // operation.) You can delete an index that is being created during the Backfilling - // phase when IndexStatus is set to CREATING and Backfilling is true. You can't - // delete the index that is being created when IndexStatus is set to CREATING and - // Backfilling is false. (This attribute does not appear for indexes that were - // created during a CreateTable operation.) - // - // * IndexName - The name of the global - // secondary index. - // - // * IndexSizeBytes - The total size of the global secondary - // index, in bytes. DynamoDB updates this value approximately every six hours. - // Recent changes might not be reflected in this value. - // - // * IndexStatus - The - // current status of the global secondary index: - // - // * CREATING - The index is being - // created. - // - // * UPDATING - The index is being updated. - // - // * DELETING - The index is - // being deleted. - // - // * ACTIVE - The index is ready for use. - // - // * ItemCount - The number - // of items in the global secondary index. DynamoDB updates this value - // approximately every six hours. Recent changes might not be reflected in this - // value. - // - // * KeySchema - Specifies the complete index key schema. The attribute - // names in the key schema must be between 1 and 255 characters (inclusive). The - // key schema must begin with the same partition key as the table. - // - // * Projection - - // Specifies attributes that are copied (projected) from the table into the index. - // These are in addition to the primary key attributes and index key attributes, - // which are automatically projected. Each attribute specification is composed - // of: - // - // * ProjectionType - One of the following: - // - // * KEYS_ONLY - Only the index and - // primary keys are projected into the index. - // - // * INCLUDE - In addition to the - // attributes described in KEYS_ONLY, the secondary index will include other - // non-key attributes that you specify. - // - // * 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 across all of the secondary - // indexes, must not exceed 100. If you project the same attribute into two - // different indexes, this counts as two distinct attributes when determining the - // total. - // - // * ProvisionedThroughput - The provisioned throughput settings for the - // global secondary index, consisting of read and write capacity units, along with - // data about increases and decreases. - // - // If the table is in the DELETING state, no - // information about indexes will be returned. + // - Backfilling - If true, then the index is currently in the backfilling phase. + // Backfilling occurs only when a new global secondary index is added to the table. + // It is the process by which DynamoDB populates the new index with data from the + // table. (This attribute does not appear for indexes that were created during a + // CreateTable operation.) You can delete an index that is being created during + // the Backfilling phase when IndexStatus is set to CREATING and Backfilling is + // true. You can't delete the index that is being created when IndexStatus is set + // to CREATING and Backfilling is false. (This attribute does not appear for + // indexes that were created during a CreateTable operation.) + // - IndexName - The name of the global secondary index. + // - IndexSizeBytes - The total size of the global secondary index, in bytes. + // DynamoDB updates this value approximately every six hours. Recent changes might + // not be reflected in this value. + // - IndexStatus - The current status of the global secondary index: + // - CREATING - The index is being created. + // - UPDATING - The index is being updated. + // - DELETING - The index is being deleted. + // - ACTIVE - The index is ready for use. + // - ItemCount - The number of items in the global secondary index. DynamoDB + // updates this value approximately every six hours. Recent changes might not be + // reflected in this value. + // - KeySchema - Specifies the complete index key schema. The attribute names in + // the key schema must be between 1 and 255 characters (inclusive). The key schema + // must begin with the same partition key as the table. + // - Projection - Specifies attributes that are copied (projected) from the table + // into the index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. Each attribute specification + // is composed of: + // - ProjectionType - One of the following: + // - KEYS_ONLY - Only the index and primary keys are projected into the index. + // - INCLUDE - In addition to the attributes described in KEYS_ONLY , the + // secondary index will include other non-key attributes that you specify. + // - 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 across all of the secondary indexes, must not exceed + // 100. If you project the same attribute into two different indexes, this counts + // as two distinct attributes when determining the total. + // - ProvisionedThroughput - The provisioned throughput settings for the global + // secondary index, consisting of read and write capacity units, along with data + // about increases and decreases. + // If the table is in the DELETING state, no information about indexes will be + // returned. GlobalSecondaryIndexes []GlobalSecondaryIndexDescription - // Represents the version of global tables - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) + // Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) // in use, if the table is replicated across Amazon Web Services Regions. GlobalTableVersion *string @@ -2996,28 +2709,17 @@ type TableDescription struct { ItemCount *int64 // The primary key structure for the table. Each KeySchemaElement consists of: - // - // * - // AttributeName - The name of the attribute. - // - // * 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'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 stores items with the same partition key physically close - // together, in sorted order by the sort key value. - // - // For more information about - // primary keys, see Primary Key - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) + // - AttributeName - The name of the attribute. + // - 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'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 stores + // items with the same partition key physically close together, in sorted order by + // the sort key value. + // For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) // in the Amazon DynamoDB Developer Guide. KeySchema []KeySchemaElement @@ -3025,67 +2727,46 @@ type TableDescription struct { // this table. LatestStreamArn *string - // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is - // not a unique identifier for the stream, because it is possible that a stream + // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel + // is not a unique identifier for the stream, because it is possible that a stream // from another table might have the same timestamp. However, the combination of // the following three elements is guaranteed to be unique: - // - // * Amazon Web Services - // customer ID - // - // * Table name - // - // * StreamLabel + // - Amazon Web Services customer ID + // - Table name + // - StreamLabel LatestStreamLabel *string // Represents one or more local secondary indexes on the table. Each index is // scoped to a given partition key value. Tables with one or more local secondary // indexes are subject to an item collection size limit, where the amount of data - // within a given item collection cannot exceed 10 GB. Each element is composed - // of: - // - // * IndexName - The name of the local secondary index. - // - // * KeySchema - - // Specifies the complete index key schema. The attribute names in the key schema - // must be between 1 and 255 characters (inclusive). The key schema must begin with - // the same partition key as the table. - // - // * Projection - Specifies attributes that - // are copied (projected) from the table into the index. These are in addition to - // the primary key attributes and index key attributes, which are automatically - // projected. Each attribute 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 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 across all of the secondary indexes, must not exceed 100. If you project - // the same attribute into two different indexes, this counts as two distinct - // attributes when determining the total. - // - // * IndexSizeBytes - Represents the total - // size of the index, in bytes. DynamoDB updates this value approximately every six - // hours. Recent changes might not be reflected in this value. - // - // * ItemCount - - // Represents the number of items in the index. DynamoDB updates this value - // approximately every six hours. Recent changes might not be reflected in this - // value. - // - // If the table is in the DELETING state, no information about indexes will - // be returned. + // within a given item collection cannot exceed 10 GB. Each element is composed of: + // + // - IndexName - The name of the local secondary index. + // - KeySchema - Specifies the complete index key schema. The attribute names in + // the key schema must be between 1 and 255 characters (inclusive). The key schema + // must begin with the same partition key as the table. + // - Projection - Specifies attributes that are copied (projected) from the table + // into the index. These are in addition to the primary key attributes and index + // key attributes, which are automatically projected. Each attribute 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 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 across all of the secondary indexes, must not exceed + // 100. If you project the same attribute into two different indexes, this counts + // as two distinct attributes when determining the total. + // - IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB + // updates this value approximately every six hours. Recent changes might not be + // reflected in this value. + // - ItemCount - Represents the number of items in the index. DynamoDB updates + // this value approximately every six hours. Recent changes might not be reflected + // in this value. + // If the table is in the DELETING state, no information about indexes will be + // returned. LocalSecondaryIndexes []LocalSecondaryIndexDescription // The provisioned throughput settings for the table, consisting of read and write @@ -3122,29 +2803,19 @@ type TableDescription struct { TableSizeBytes *int64 // The current state of the table: - // - // * CREATING - The table is being created. - // - // * - // UPDATING - The table/index configuration is being updated. The table/index - // remains available for data operations when UPDATING. - // - // * DELETING - The table is - // being deleted. - // - // * ACTIVE - The table is ready for use. - // - // * - // INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in - // inaccessible. Table operations may fail due to failure to use the KMS key. - // DynamoDB will initiate the table archival process when a table's KMS key remains - // inaccessible for more than seven days. - // - // * ARCHIVING - The table is being - // archived. Operations are not allowed until archival is complete. - // - // * ARCHIVED - - // The table has been archived. See the ArchivalReason for more information. + // - CREATING - The table is being created. + // - UPDATING - The table/index configuration is being updated. The table/index + // remains available for data operations when UPDATING . + // - DELETING - The table is being deleted. + // - ACTIVE - The table is ready for use. + // - INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table + // in inaccessible. Table operations may fail due to failure to use the KMS key. + // DynamoDB will initiate the table archival process when a table's KMS key remains + // inaccessible for more than seven days. + // - ARCHIVING - The table is being archived. Operations are not allowed until + // archival is complete. + // - ARCHIVED - The table has been archived. See the ArchivalReason for more + // information. TableStatus TableStatus noSmithyDocumentSerde @@ -3152,12 +2823,11 @@ type TableDescription struct { // Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a // single DynamoDB table. Amazon Web Services-assigned tag names and values are -// automatically assigned the aws: prefix, which the user cannot assign. Amazon Web -// Services-assigned tag names do not count towards the tag limit of 50. -// User-assigned tag names have the prefix user: in the Cost Allocation Report. You -// cannot backdate the application of a tag. For an overview on tagging DynamoDB -// resources, see Tagging for DynamoDB -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) +// automatically assigned the aws: prefix, which the user cannot assign. Amazon +// Web Services-assigned tag names do not count towards the tag limit of 50. +// User-assigned tag names have the prefix user: in the Cost Allocation Report. +// You cannot backdate the application of a tag. 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. type Tag struct { @@ -3192,8 +2862,8 @@ type TimeToLiveDescription struct { // specified table. type TimeToLiveSpecification struct { - // The name of the TTL 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. // // This member is required. AttributeName *string @@ -3209,9 +2879,9 @@ type TimeToLiveSpecification struct { // Specifies an item to be retrieved as part of the transaction. type TransactGetItem struct { - // Contains the primary key that identifies the item to get, together with the name - // of the table that contains the item, and optionally the specific attributes of - // the item to retrieve. + // Contains the primary key that identifies the item to get, together with the + // name of the table that contains the item, and optionally the specific attributes + // of the item to retrieve. // // This member is required. Get *Get @@ -3241,8 +2911,8 @@ type TransactWriteItem struct { // Represents a request to perform an UpdateItem operation. type Update struct { - // The primary key of the item to be updated. Each element consists of an attribute - // name and a value for that attribute. + // The primary key of the item to be updated. Each element consists of an + // attribute name and a value for that attribute. // // This member is required. Key map[string]AttributeValue @@ -3268,7 +2938,7 @@ type Update struct { ExpressionAttributeValues map[string]AttributeValue // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update - // condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: + // condition fails. For ReturnValuesOnConditionCheckFailure , the valid values are: // NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure @@ -3286,8 +2956,7 @@ type UpdateGlobalSecondaryIndexAction struct { // Represents the provisioned throughput settings for the specified global // secondary index. For current minimum and maximum provisioned throughput values, - // see Service, Account, and Table Quotas - // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) + // see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. // // This member is required. @@ -3310,7 +2979,7 @@ type UpdateReplicationGroupMemberAction struct { // The KMS key of the replica that should be used for KMS encryption. To specify a // key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note // that you should only provide this parameter if the key is different from the - // default DynamoDB KMS key alias/aws/dynamodb. + // default DynamoDB KMS key alias/aws/dynamodb . KMSMasterKeyId *string // Replica-specific provisioned throughput. If not specified, uses the source @@ -3324,8 +2993,8 @@ type UpdateReplicationGroupMemberAction struct { noSmithyDocumentSerde } -// Represents an operation to perform - either DeleteItem or PutItem. You can only -// request one of these operations, not both, in a single WriteRequest. If you do +// Represents an operation to perform - either DeleteItem or PutItem . You can only +// request one of these operations, not both, in a single WriteRequest . If you do // need to perform both of these operations, you need to provide two separate // WriteRequest objects. type WriteRequest struct { diff --git a/service/dynamodbstreams/api_client.go b/service/dynamodbstreams/api_client.go index c43f966f368..833ce3e5e9a 100644 --- a/service/dynamodbstreams/api_client.go +++ b/service/dynamodbstreams/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/dynamodbstreams/api_op_DescribeStream.go b/service/dynamodbstreams/api_op_DescribeStream.go index fddf66301b7..fe9cbc480ce 100644 --- a/service/dynamodbstreams/api_op_DescribeStream.go +++ b/service/dynamodbstreams/api_op_DescribeStream.go @@ -16,7 +16,7 @@ import ( // corresponding DynamoDB table. You can call DescribeStream at a maximum rate of // 10 times per second. Each shard in the stream has a SequenceNumberRange // associated with it. If the SequenceNumberRange has a StartingSequenceNumber but -// no EndingSequenceNumber, then the shard is still open (able to receive more +// no EndingSequenceNumber , then the shard is still open (able to receive more // stream records). If both StartingSequenceNumber and EndingSequenceNumber are // present, then that shard is closed and can no longer receive more data. func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error) { diff --git a/service/dynamodbstreams/api_op_GetRecords.go b/service/dynamodbstreams/api_op_GetRecords.go index 0025290fc42..567881d4bd8 100644 --- a/service/dynamodbstreams/api_op_GetRecords.go +++ b/service/dynamodbstreams/api_op_GetRecords.go @@ -53,7 +53,7 @@ type GetRecordsInput struct { type GetRecordsOutput struct { // The next position in the shard from which to start sequentially reading stream - // records. If set to null, the shard has been closed and the requested iterator + // records. If set to null , the shard has been closed and the requested iterator // will not return any more data. NextShardIterator *string diff --git a/service/dynamodbstreams/api_op_GetShardIterator.go b/service/dynamodbstreams/api_op_GetShardIterator.go index ed2b39c6a96..33697dd9b21 100644 --- a/service/dynamodbstreams/api_op_GetShardIterator.go +++ b/service/dynamodbstreams/api_op_GetShardIterator.go @@ -13,8 +13,8 @@ import ( // Returns a shard iterator. A shard iterator provides information about how to // retrieve the stream records from within a shard. Use the shard iterator in a -// subsequent GetRecords request to read the stream records from the shard. A shard -// iterator expires 15 minutes after it is returned to the requester. +// subsequent GetRecords request to read the stream records from the shard. A +// shard iterator expires 15 minutes after it is returned to the requester. func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorInput, optFns ...func(*Options)) (*GetShardIteratorOutput, error) { if params == nil { params = &GetShardIteratorInput{} @@ -40,22 +40,16 @@ type GetShardIteratorInput struct { // Determines how the shard iterator is used to start reading stream records from // the shard: - // - // * AT_SEQUENCE_NUMBER - Start reading exactly from the position - // denoted by a specific sequence number. - // - // * AFTER_SEQUENCE_NUMBER - Start reading - // right after the position denoted by a specific sequence number. - // - // * TRIM_HORIZON - // - Start reading at the last (untrimmed) stream record, which is the oldest - // record in the shard. In DynamoDB Streams, there is a 24 hour limit on data - // retention. Stream records whose age exceeds this limit are subject to removal - // (trimming) from the stream. - // - // * LATEST - Start reading just after the most recent - // stream record in the shard, so that you always read the most recent data in the - // shard. + // - AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a + // specific sequence number. + // - AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a + // specific sequence number. + // - TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is + // the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on + // data retention. Stream records whose age exceeds this limit are subject to + // removal (trimming) from the stream. + // - LATEST - Start reading just after the most recent stream record in the + // shard, so that you always read the most recent data in the shard. // // This member is required. ShardIteratorType types.ShardIteratorType diff --git a/service/dynamodbstreams/api_op_ListStreams.go b/service/dynamodbstreams/api_op_ListStreams.go index 0285afe5ea3..2f5b59a2403 100644 --- a/service/dynamodbstreams/api_op_ListStreams.go +++ b/service/dynamodbstreams/api_op_ListStreams.go @@ -13,8 +13,8 @@ import ( // Returns an array of stream ARNs associated with the current account and // endpoint. If the TableName parameter is present, then ListStreams will return -// only the streams ARNs for that table. You can call ListStreams at a maximum rate -// of 5 times per second. +// only the streams ARNs for that table. You can call ListStreams at a maximum +// rate of 5 times per second. func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { if params == nil { params = &ListStreamsInput{} diff --git a/service/dynamodbstreams/doc.go b/service/dynamodbstreams/doc.go index 910bc55da19..6c1902cb960 100644 --- a/service/dynamodbstreams/doc.go +++ b/service/dynamodbstreams/doc.go @@ -1,11 +1,10 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package dynamodbstreams provides the API client, operations, and parameter types -// for Amazon DynamoDB Streams. +// Package dynamodbstreams provides the API client, operations, and parameter +// types for Amazon DynamoDB Streams. // // Amazon DynamoDB Amazon DynamoDB Streams provides API actions for accessing // streams and processing stream records. To learn more about application -// development with Streams, see Capturing Table Activity with DynamoDB Streams -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) +// development with Streams, see Capturing Table Activity with DynamoDB Streams (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) // in the Amazon DynamoDB Developer Guide. package dynamodbstreams diff --git a/service/dynamodbstreams/types/enums.go b/service/dynamodbstreams/types/enums.go index 02d35c61637..9bf4e095381 100644 --- a/service/dynamodbstreams/types/enums.go +++ b/service/dynamodbstreams/types/enums.go @@ -72,9 +72,9 @@ const ( StreamStatusDisabled StreamStatus = "DISABLED" ) -// Values returns all known values for StreamStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StreamStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StreamStatus) Values() []StreamStatus { return []StreamStatus{ "ENABLING", diff --git a/service/dynamodbstreams/types/errors.go b/service/dynamodbstreams/types/errors.go index c1a3fe73872..4155bbcf917 100644 --- a/service/dynamodbstreams/types/errors.go +++ b/service/dynamodbstreams/types/errors.go @@ -63,14 +63,14 @@ func (e *InternalServerError) ErrorFault() smithy.ErrorFault { return smithy.Fau // There is no limit to the number of daily on-demand backups that can be taken. // For most purposes, up to 500 simultaneous table operations are allowed per -// account. These operations include CreateTable, UpdateTable, -// DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and -// RestoreTableToPointInTime. When you are creating a table with one or more -// secondary indexes, you can have up to 250 such requests running at a time. -// However, if the table or index specifications are complex, then DynamoDB might -// temporarily reduce the number of concurrent operations. When importing into -// DynamoDB, up to 50 simultaneous import table operations are allowed per account. -// There is a soft account quota of 2,500 tables. +// account. These operations include CreateTable , UpdateTable , DeleteTable , +// UpdateTimeToLive , RestoreTableFromBackup , and RestoreTableToPointInTime . When +// you are creating a table with one or more secondary indexes, you can have up to +// 250 such requests running at a time. However, if the table or index +// specifications are complex, then DynamoDB might temporarily reduce the number of +// concurrent operations. When importing into DynamoDB, up to 50 simultaneous +// import table operations are allowed per account. There is a soft account quota +// of 2,500 tables. type LimitExceededException struct { Message *string @@ -97,7 +97,7 @@ func (e *LimitExceededException) ErrorCode() string { func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation tried to access a nonexistent table or index. The resource might -// not be specified correctly, or its status might not be ACTIVE. +// not be specified correctly, or its status might not be ACTIVE . type ResourceNotFoundException struct { Message *string @@ -127,14 +127,11 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // DynamoDB Streams, there is a 24 hour limit on data retention. Stream records // whose age exceeds this limit are subject to removal (trimming) from the stream. // You might receive a TrimmedDataAccessException if: -// -// * You request a shard -// iterator with a sequence number older than the trim point (24 hours). -// -// * You -// obtain a shard iterator, but before you use the iterator in a GetRecords -// request, a stream record in the shard exceeds the 24 hour period and is trimmed. -// This causes the iterator to access a record that no longer exists. +// - You request a shard iterator with a sequence number older than the trim +// point (24 hours). +// - You obtain a shard iterator, but before you use the iterator in a GetRecords +// request, a stream record in the shard exceeds the 24 hour period and is trimmed. +// This causes the iterator to access a record that no longer exists. type TrimmedDataAccessException struct { Message *string diff --git a/service/dynamodbstreams/types/types.go b/service/dynamodbstreams/types/types.go index be732543388..8d0a3ccf7cf 100644 --- a/service/dynamodbstreams/types/types.go +++ b/service/dynamodbstreams/types/types.go @@ -9,8 +9,7 @@ import ( // Represents the data for an attribute. Each attribute value is described as a // name-value pair. The name is the data type, and the value is the data itself. -// For more information, see Data Types -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) +// For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) // in the Amazon DynamoDB Developer Guide. // // The following types satisfy this interface: @@ -149,8 +148,8 @@ type Identity struct { // For example, a simple primary key would be represented by one KeySchemaElement // (for the partition key). A composite primary key would require one // KeySchemaElement for the partition key, and another KeySchemaElement for the -// sort key. A KeySchemaElement must be a scalar, top-level attribute (not a nested -// attribute). The data type must be one of String, Number, or Binary. The +// sort key. A KeySchemaElement must be a scalar, top-level attribute (not a +// nested attribute). The data type must be one of String, Number, or Binary. The // attribute cannot be nested within a List or a Map. type KeySchemaElement struct { @@ -160,15 +159,11 @@ type KeySchemaElement struct { AttributeName *string // The role that this key attribute will assume: - // - // * 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's usage of an internal hash function - // to evenly distribute data items across partitions, based on their partition key + // - 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'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 stores items with the same // partition key physically close together, in sorted order by the sort key value. @@ -194,35 +189,26 @@ type Record struct { EventID *string // The type of data modification that was performed on the DynamoDB table: - // - // * - // INSERT - a new item was added to the table. - // - // * MODIFY - one or more of an - // existing item's attributes were modified. - // - // * REMOVE - the item was deleted from - // the table + // - INSERT - a new item was added to the table. + // - MODIFY - one or more of an existing item's attributes were modified. + // - REMOVE - the item was deleted from the table EventName OperationType // The AWS service from which the stream record originated. For DynamoDB Streams, - // this is aws:dynamodb. + // this is aws:dynamodb . EventSource *string // The version number of the stream record format. This number is updated whenever // the structure of Record is modified. Client applications must not assume that // eventVersion will remain at a particular value, as this number is subject to - // change at any time. In general, eventVersion will only increase as the low-level - // DynamoDB Streams API evolves. + // change at any time. In general, eventVersion will only increase as the + // low-level DynamoDB Streams API evolves. EventVersion *string // Items that are deleted by the Time to Live process after expiration have the // following fields: - // - // * Records[].userIdentity.type "Service" - // - // * - // Records[].userIdentity.principalId "dynamodb.amazonaws.com" + // - Records[].userIdentity.type "Service" + // - Records[].userIdentity.principalId "dynamodb.amazonaws.com" UserIdentity *Identity noSmithyDocumentSerde @@ -232,8 +218,8 @@ type Record struct { // within a shard. type SequenceNumberRange struct { - // The last sequence number for the stream records contained within a shard. String - // contains numeric characters only. + // The last sequence number for the stream records contained within a shard. + // String contains numeric characters only. EndingSequenceNumber *string // The first sequence number for the stream records contained within a shard. @@ -264,17 +250,13 @@ type Stream struct { // The Amazon Resource Name (ARN) for the stream. StreamArn *string - // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is - // not a unique identifier for the stream, because it is possible that a stream + // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel + // is not a unique identifier for the stream, because it is possible that a stream // from another table might have the same timestamp. However, the combination of // the following three elements is guaranteed to be unique: - // - // * the AWS customer - // ID. - // - // * the table name - // - // * the StreamLabel + // - the AWS customer ID. + // - the table name + // - the StreamLabel StreamLabel *string // The DynamoDB table with which the stream is associated. @@ -307,47 +289,31 @@ type StreamDescription struct { // The Amazon Resource Name (ARN) for the stream. StreamArn *string - // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is - // not a unique identifier for the stream, because it is possible that a stream + // A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel + // is not a unique identifier for the stream, because it is possible that a stream // from another table might have the same timestamp. However, the combination of // the following three elements is guaranteed to be unique: - // - // * the AWS customer - // ID. - // - // * the table name - // - // * the StreamLabel + // - the AWS customer ID. + // - the table name + // - the StreamLabel StreamLabel *string // Indicates the current status of the stream: - // - // * ENABLING - Streams is currently - // being enabled on the DynamoDB table. - // - // * ENABLED - the stream is enabled. - // - // * - // DISABLING - Streams is currently being disabled on the DynamoDB table. - // - // * - // DISABLED - the stream is disabled. + // - ENABLING - Streams is currently being enabled on the DynamoDB table. + // - ENABLED - the stream is enabled. + // - DISABLING - Streams is currently being disabled on the DynamoDB table. + // - DISABLED - the stream is disabled. StreamStatus StreamStatus // Indicates the format of the records within this stream: - // - // * KEYS_ONLY - only the - // key attributes of items that were modified in the DynamoDB table. - // - // * NEW_IMAGE - - // entire items from the table, as they appeared after they were modified. - // - // * - // OLD_IMAGE - entire items from the table, as they appeared before they were - // modified. - // - // * NEW_AND_OLD_IMAGES - both the new and the old images of the items - // from the table. + // - KEYS_ONLY - only the key attributes of items that were modified in the + // DynamoDB table. + // - NEW_IMAGE - entire items from the table, as they appeared after they were + // modified. + // - OLD_IMAGE - entire items from the table, as they appeared before they were + // modified. + // - NEW_AND_OLD_IMAGES - both the new and the old images of the items from the + // table. StreamViewType StreamViewType // The DynamoDB table with which the stream is associated. @@ -381,17 +347,10 @@ type StreamRecord struct { // The type of data from the modified DynamoDB item that was captured in this // stream record: - // - // * KEYS_ONLY - only the key attributes of the modified item. - // - // * - // NEW_IMAGE - the entire item, as it appeared after it was modified. - // - // * OLD_IMAGE - // - the entire item, as it appeared before it was modified. - // - // * NEW_AND_OLD_IMAGES - // - both the new and the old item images of the item. + // - KEYS_ONLY - only the key attributes of the modified item. + // - NEW_IMAGE - the entire item, as it appeared after it was modified. + // - OLD_IMAGE - the entire item, as it appeared before it was modified. + // - NEW_AND_OLD_IMAGES - both the new and the old item images of the item. StreamViewType StreamViewType noSmithyDocumentSerde diff --git a/service/ebs/api_client.go b/service/ebs/api_client.go index b8efb2249b9..aa809f8c79d 100644 --- a/service/ebs/api_client.go +++ b/service/ebs/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ebs/api_op_CompleteSnapshot.go b/service/ebs/api_op_CompleteSnapshot.go index 14a4580edcc..9ae0f8f6332 100644 --- a/service/ebs/api_op_CompleteSnapshot.go +++ b/service/ebs/api_op_CompleteSnapshot.go @@ -12,8 +12,8 @@ import ( ) // Seals and completes the snapshot after all of the required blocks of data have -// been written to it. Completing the snapshot changes the status to completed. You -// cannot write new blocks to a snapshot after it has been completed. +// been written to it. Completing the snapshot changes the status to completed . +// You cannot write new blocks to a snapshot after it has been completed. func (c *Client) CompleteSnapshot(ctx context.Context, params *CompleteSnapshotInput, optFns ...func(*Options)) (*CompleteSnapshotOutput, error) { if params == nil { params = &CompleteSnapshotInput{} @@ -49,11 +49,11 @@ type CompleteSnapshotInput struct { Checksum *string // The aggregation method used to generate the checksum. Currently, the only - // supported aggregation method is LINEAR. + // supported aggregation method is LINEAR . ChecksumAggregationMethod types.ChecksumAggregationMethod // The algorithm used to generate the checksum. Currently, the only supported - // algorithm is SHA256. + // algorithm is SHA256 . ChecksumAlgorithm types.ChecksumAlgorithm noSmithyDocumentSerde diff --git a/service/ebs/api_op_GetSnapshotBlock.go b/service/ebs/api_op_GetSnapshotBlock.go index 87b78b70cf3..1a569e6b989 100644 --- a/service/ebs/api_op_GetSnapshotBlock.go +++ b/service/ebs/api_op_GetSnapshotBlock.go @@ -33,7 +33,8 @@ type GetSnapshotBlockInput struct { // The block index of the block in which to read the data. A block index is a // logical index in units of 512 KiB blocks. To identify the block index, divide // the logical offset of the data in the logical volume by the block size (logical - // offset of data/524288). The logical offset of the data must be 512 KiB aligned. + // offset of data/ 524288 ). The logical offset of the data must be 512 KiB + // aligned. // // This member is required. BlockIndex *int32 @@ -46,9 +47,8 @@ type GetSnapshotBlockInput struct { // The ID of the snapshot containing the block from which to get data. If the // specified snapshot is encrypted, you must have permission to use the KMS key - // that was used to encrypt the snapshot. For more information, see Using - // encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) + // that was used to encrypt the snapshot. For more information, see Using + // encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) // in the Amazon Elastic Compute Cloud User Guide. // // This member is required. diff --git a/service/ebs/api_op_ListChangedBlocks.go b/service/ebs/api_op_ListChangedBlocks.go index a466f01fcac..0b5f462467f 100644 --- a/service/ebs/api_op_ListChangedBlocks.go +++ b/service/ebs/api_op_ListChangedBlocks.go @@ -55,9 +55,9 @@ type ListChangedBlocksInput struct { // StartingBlockIndex is ignored. NextToken *string - // The block index from which the comparison should start. The list in the response - // will start from this block index or the next valid block index in the snapshots. - // If you specify NextToken, then StartingBlockIndex is ignored. + // The block index from which the comparison should start. The list in the + // response will start from this block index or the next valid block index in the + // snapshots. If you specify NextToken, then StartingBlockIndex is ignored. StartingBlockIndex *int32 noSmithyDocumentSerde diff --git a/service/ebs/api_op_PutSnapshotBlock.go b/service/ebs/api_op_PutSnapshotBlock.go index f8a1fa02728..9b24c59c972 100644 --- a/service/ebs/api_op_PutSnapshotBlock.go +++ b/service/ebs/api_op_PutSnapshotBlock.go @@ -40,8 +40,7 @@ type PutSnapshotBlockInput struct { // Signature Version 4 signing process. It is validated against a checksum // generated by Amazon EBS to ensure the validity and authenticity of the data. If // the checksums do not correspond, the request fails. For more information, see - // Using checksums with the EBS direct APIs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums) + // Using checksums with the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums) // in the Amazon Elastic Compute Cloud User Guide. // // This member is required. @@ -50,7 +49,8 @@ type PutSnapshotBlockInput struct { // The block index of the block in which to write the data. A block index is a // logical index in units of 512 KiB blocks. To identify the block index, divide // the logical offset of the data in the logical volume by the block size (logical - // offset of data/524288). The logical offset of the data must be 512 KiB aligned. + // offset of data/ 524288 ). The logical offset of the data must be 512 KiB + // aligned. // // This member is required. BlockIndex *int32 @@ -62,7 +62,7 @@ type PutSnapshotBlockInput struct { Checksum *string // The algorithm used to generate the checksum. Currently, the only supported - // algorithm is SHA256. + // algorithm is SHA256 . // // This member is required. ChecksumAlgorithm types.ChecksumAlgorithm @@ -75,8 +75,7 @@ type PutSnapshotBlockInput struct { // The ID of the snapshot. If the specified snapshot is encrypted, you must have // permission to use the KMS key that was used to encrypt the snapshot. For more - // information, see Using encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) + // information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) // in the Amazon Elastic Compute Cloud User Guide.. // // This member is required. diff --git a/service/ebs/api_op_StartSnapshot.go b/service/ebs/api_op_StartSnapshot.go index 3038d0966ae..02c17a71068 100644 --- a/service/ebs/api_op_StartSnapshot.go +++ b/service/ebs/api_op_StartSnapshot.go @@ -14,8 +14,7 @@ import ( ) // Creates a new Amazon EBS snapshot. The new snapshot enters the pending state -// after the request completes. After creating the snapshot, use PutSnapshotBlock -// (https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html) +// after the request completes. After creating the snapshot, use PutSnapshotBlock (https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html) // to write blocks of data to the snapshot. func (c *Client) StartSnapshot(ctx context.Context, params *StartSnapshotInput, optFns ...func(*Options)) (*StartSnapshotOutput, error) { if params == nil { @@ -45,8 +44,7 @@ type StartSnapshotInput struct { // subsequent retries with the same client token return the result from the // original successful request and they have no additional effect. If you do not // specify a client token, one is automatically generated by the Amazon Web - // Services SDK. For more information, see Idempotency for StartSnapshot API - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html) + // Services SDK. For more information, see Idempotency for StartSnapshot API (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html) // in the Amazon Elastic Compute Cloud User Guide. ClientToken *string @@ -55,49 +53,40 @@ type StartSnapshotInput struct { // Indicates whether to encrypt the snapshot. You can't specify Encrypted and // ParentSnapshotId in the same request. If you specify both parameters, the - // request fails with ValidationException. The encryption status of the snapshot + // request fails with ValidationException . The encryption status of the snapshot // depends on the values that you specify for Encrypted, KmsKeyArn, and // ParentSnapshotId, and whether your Amazon Web Services account is enabled for - // encryption by default - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default). - // For more information, see Using encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) + // encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) + // . For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) // in the Amazon Elastic Compute Cloud User Guide. To create an encrypted snapshot, // you must have permission to use the KMS key. For more information, see - // Permissions to use Key Management Service keys - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) + // Permissions to use Key Management Service keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) // in the Amazon Elastic Compute Cloud User Guide. Encrypted *bool // The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be // used to encrypt the snapshot. The encryption status of the snapshot depends on // the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and - // whether your Amazon Web Services account is enabled for encryption by default - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default). - // For more information, see Using encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) + // whether your Amazon Web Services account is enabled for encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) + // . For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) // in the Amazon Elastic Compute Cloud User Guide. To create an encrypted snapshot, // you must have permission to use the KMS key. For more information, see - // Permissions to use Key Management Service keys - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) + // Permissions to use Key Management Service keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) // in the Amazon Elastic Compute Cloud User Guide. KmsKeyArn *string // The ID of the parent snapshot. If there is no parent snapshot, or if you are // creating the first snapshot for an on-premises volume, omit this parameter. You // can't specify ParentSnapshotId and Encrypted in the same request. If you specify - // both parameters, the request fails with ValidationException. The encryption + // both parameters, the request fails with ValidationException . The encryption // status of the snapshot depends on the values that you specify for Encrypted, // KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is - // enabled for encryption by default - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default). - // For more information, see Using encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) + // enabled for encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) + // . For more information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html) // in the Amazon Elastic Compute Cloud User Guide. If you specify an encrypted // parent snapshot, you must have permission to use the KMS key that was used to - // encrypt the parent snapshot. For more information, see Permissions to use Key - // Management Service keys - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) + // encrypt the parent snapshot. For more information, see Permissions to use Key + // Management Service keys (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions) // in the Amazon Elastic Compute Cloud User Guide. ParentSnapshotId *string @@ -106,14 +95,9 @@ type StartSnapshotInput struct { // The amount of time (in minutes) after which the snapshot is automatically // cancelled if: - // - // * No blocks are written to the snapshot. - // - // * The snapshot is not - // completed after writing the last block of data. - // - // If no value is specified, the - // timeout defaults to 60 minutes. + // - No blocks are written to the snapshot. + // - The snapshot is not completed after writing the last block of data. + // If no value is specified, the timeout defaults to 60 minutes. Timeout *int32 noSmithyDocumentSerde @@ -147,9 +131,8 @@ type StartSnapshotOutput struct { Status types.Status // The tags applied to the snapshot. You can specify up to 50 tags per snapshot. - // For more information, see Tagging your Amazon EC2 resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the - // Amazon Elastic Compute Cloud User Guide. + // For more information, see Tagging your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) + // in the Amazon Elastic Compute Cloud User Guide. Tags []types.Tag // The size of the volume, in GiB. diff --git a/service/ebs/doc.go b/service/ebs/doc.go index 7e04d8b18bc..2d188ee7ce1 100644 --- a/service/ebs/doc.go +++ b/service/ebs/doc.go @@ -20,11 +20,9 @@ // detailed information about the actions, data types, parameters, and errors of // the EBS direct APIs. For more information about the elements that make up the // EBS direct APIs, and examples of how to use them effectively, see Accessing the -// Contents of an Amazon EBS Snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html) +// Contents of an Amazon EBS Snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html) // in the Amazon Elastic Compute Cloud User Guide. For more information about the // supported Amazon Web Services Regions, endpoints, and service quotas for the EBS -// direct APIs, see Amazon Elastic Block Store Endpoints and Quotas -// (https://docs.aws.amazon.com/general/latest/gr/ebs-service.html) in the Amazon -// Web Services General Reference. +// direct APIs, see Amazon Elastic Block Store Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/ebs-service.html) +// in the Amazon Web Services General Reference. package ebs diff --git a/service/ebs/types/errors.go b/service/ebs/types/errors.go index 0d74825ce29..251478d928e 100644 --- a/service/ebs/types/errors.go +++ b/service/ebs/types/errors.go @@ -36,8 +36,7 @@ func (e *AccessDeniedException) ErrorCode() string { func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have reached the limit for concurrent API requests. For more information, -// see Optimizing performance of the EBS direct APIs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance) +// see Optimizing performance of the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance) // in the Amazon Elastic Compute Cloud User Guide. type ConcurrentLimitExceededException struct { Message *string @@ -116,8 +115,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The number of API requests has exceed the maximum allowed API request throttling -// limit. +// The number of API requests has exceed the maximum allowed API request +// throttling limit. type RequestThrottledException struct { Message *string diff --git a/service/ebs/types/types.go b/service/ebs/types/types.go index 56a5dd95c04..76b9cf01cb6 100644 --- a/service/ebs/types/types.go +++ b/service/ebs/types/types.go @@ -18,8 +18,8 @@ type Block struct { noSmithyDocumentSerde } -// A block of data in an Amazon Elastic Block Store snapshot that is different from -// another snapshot of the same volume/snapshot lineage. +// A block of data in an Amazon Elastic Block Store snapshot that is different +// from another snapshot of the same volume/snapshot lineage. type ChangedBlock struct { // The block index. diff --git a/service/ec2/api_client.go b/service/ec2/api_client.go index 330b347d9ec..8c125349712 100644 --- a/service/ec2/api_client.go +++ b/service/ec2/api_client.go @@ -125,7 +125,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ec2/api_op_AcceptAddressTransfer.go b/service/ec2/api_op_AcceptAddressTransfer.go index bcc35dd3e98..1c6fc819f13 100644 --- a/service/ec2/api_op_AcceptAddressTransfer.go +++ b/service/ec2/api_op_AcceptAddressTransfer.go @@ -12,8 +12,7 @@ import ( ) // Accepts an Elastic IP address transfer. For more information, see Accept a -// transferred Elastic IP address -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept) +// transferred Elastic IP address (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) AcceptAddressTransfer(ctx context.Context, params *AcceptAddressTransferInput, optFns ...func(*Options)) (*AcceptAddressTransferOutput, error) { if params == nil { @@ -39,13 +38,13 @@ type AcceptAddressTransferInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // tag: - The key/value combination of a tag assigned to the resource. Use the tag + // tag : - The key/value combination of a tag assigned to the resource. Use the tag // key in the filter name and the tag value as the filter value. For example, to - // find all resources that have a tag with the key Owner and the value TeamA, + // find all resources that have a tag with the key Owner and the value TeamA , // specify tag:Owner for the filter name and TeamA for the filter value. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go index bce398d838c..f174a5c3dad 100644 --- a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go @@ -39,8 +39,8 @@ type AcceptReservedInstancesExchangeQuoteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The configuration of the target Convertible Reserved Instance to exchange for @@ -50,7 +50,7 @@ type AcceptReservedInstancesExchangeQuoteInput struct { noSmithyDocumentSerde } -// The result of the exchange and whether it was successful. +// The result of the exchange and whether it was successful . type AcceptReservedInstancesExchangeQuoteOutput struct { // The ID of the successful exchange. diff --git a/service/ec2/api_op_AcceptTransitGatewayMulticastDomainAssociations.go b/service/ec2/api_op_AcceptTransitGatewayMulticastDomainAssociations.go index aec9e712fde..893b2f84b62 100644 --- a/service/ec2/api_op_AcceptTransitGatewayMulticastDomainAssociations.go +++ b/service/ec2/api_op_AcceptTransitGatewayMulticastDomainAssociations.go @@ -31,8 +31,8 @@ type AcceptTransitGatewayMulticastDomainAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of the subnets to associate with the transit gateway multicast domain. diff --git a/service/ec2/api_op_AcceptTransitGatewayPeeringAttachment.go b/service/ec2/api_op_AcceptTransitGatewayPeeringAttachment.go index 4e902e307eb..a562bdcc2a5 100644 --- a/service/ec2/api_op_AcceptTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_AcceptTransitGatewayPeeringAttachment.go @@ -37,8 +37,8 @@ type AcceptTransitGatewayPeeringAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go b/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go index 791a24b1ee0..f09319b294d 100644 --- a/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go @@ -39,8 +39,8 @@ type AcceptTransitGatewayVpcAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AcceptVpcEndpointConnections.go b/service/ec2/api_op_AcceptVpcEndpointConnections.go index b545266dbd7..1e5df36907f 100644 --- a/service/ec2/api_op_AcceptVpcEndpointConnections.go +++ b/service/ec2/api_op_AcceptVpcEndpointConnections.go @@ -41,8 +41,8 @@ type AcceptVpcEndpointConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AcceptVpcPeeringConnection.go b/service/ec2/api_op_AcceptVpcPeeringConnection.go index b89a0f4f800..fc34732f9dc 100644 --- a/service/ec2/api_op_AcceptVpcPeeringConnection.go +++ b/service/ec2/api_op_AcceptVpcPeeringConnection.go @@ -12,8 +12,8 @@ import ( ) // Accept a VPC peering connection request. To accept a request, the VPC peering -// connection must be in the pending-acceptance state, and you must be the owner of -// the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC +// connection must be in the pending-acceptance state, and you must be the owner +// of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC // peering connection requests. For an inter-Region VPC peering connection request, // you must accept the VPC peering connection in the Region of the accepter VPC. func (c *Client) AcceptVpcPeeringConnection(ctx context.Context, params *AcceptVpcPeeringConnectionInput, optFns ...func(*Options)) (*AcceptVpcPeeringConnectionOutput, error) { @@ -41,8 +41,8 @@ type AcceptVpcPeeringConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AdvertiseByoipCidr.go b/service/ec2/api_op_AdvertiseByoipCidr.go index 9856df5c6a8..8be26ffddef 100644 --- a/service/ec2/api_op_AdvertiseByoipCidr.go +++ b/service/ec2/api_op_AdvertiseByoipCidr.go @@ -22,7 +22,7 @@ import ( // advertising it through Amazon Web Services. It can take a few minutes before // traffic to the specified addresses starts routing to Amazon Web Services because // of BGP propagation delays. To stop advertising the BYOIP CIDR, use -// WithdrawByoipCidr. +// WithdrawByoipCidr . func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipCidrInput, optFns ...func(*Options)) (*AdvertiseByoipCidrOutput, error) { if params == nil { params = &AdvertiseByoipCidrInput{} @@ -48,8 +48,8 @@ type AdvertiseByoipCidrInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AllocateAddress.go b/service/ec2/api_op_AllocateAddress.go index bc4181371ed..8b46b53b443 100644 --- a/service/ec2/api_op_AllocateAddress.go +++ b/service/ec2/api_op_AllocateAddress.go @@ -19,18 +19,16 @@ import ( // Services or from an address pool created from a public IPv4 address range that // you have brought to Amazon Web Services for use with your Amazon Web Services // resources using bring your own IP addresses (BYOIP). For more information, see -// Bring Your Own IP Addresses (BYOIP) -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the -// Amazon Elastic Compute Cloud User Guide. [EC2-VPC] If you release an Elastic IP -// address, you might be able to recover it. You cannot recover an Elastic IP -// address that you released after it is allocated to another Amazon Web Services -// account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to -// recover an Elastic IP address that you released, specify it in this operation. -// An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. -// By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region -// and 5 Elastic IP addresses for EC2-VPC per Region. For more information, see -// Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) +// in the Amazon Elastic Compute Cloud User Guide. [EC2-VPC] If you release an +// Elastic IP address, you might be able to recover it. You cannot recover an +// Elastic IP address that you released after it is allocated to another Amazon Web +// Services account. You cannot recover an Elastic IP address for EC2-Classic. To +// attempt to recover an Elastic IP address that you released, specify it in this +// operation. An Elastic IP address is for use either in the EC2-Classic platform +// or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic +// per Region and 5 Elastic IP addresses for EC2-VPC per Region. For more +// information, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. You can allocate a carrier IP // address which is a public IP address from a telecommunication carrier, to a // network interface which resides in a subnet in a Wavelength Zone (for example an @@ -66,20 +64,19 @@ type AllocateAddressInput struct { // Indicates whether the Elastic IP address is for use with instances in a VPC or // instances in EC2-Classic. Default: If the Region supports EC2-Classic, the - // default is standard. Otherwise, the default is vpc. + // default is standard . Otherwise, the default is vpc . Domain types.DomainType // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // A unique set of Availability Zones, Local Zones, or Wavelength Zones from which // Amazon Web Services advertises IP addresses. Use this parameter to limit the IP // address to this location. IP addresses cannot move between network border - // groups. Use DescribeAvailabilityZones - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) + // groups. Use DescribeAvailabilityZones (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) // to view the network border groups. You cannot use a network border group with // EC2 Classic. If you attempt this operation on EC2 Classic, you receive an // InvalidParameterCombination error. @@ -98,8 +95,8 @@ type AllocateAddressInput struct { type AllocateAddressOutput struct { - // [EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of - // the Elastic IP address for use with instances in a VPC. + // [EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation + // of the Elastic IP address for use with instances in a VPC. AllocationId *string // The carrier IP address. This option is only available for network interfaces @@ -112,8 +109,8 @@ type AllocateAddressOutput struct { // The ID of the customer-owned address pool. CustomerOwnedIpv4Pool *string - // Indicates whether the Elastic IP address is for use with instances in a VPC - // (vpc) or instances in EC2-Classic (standard). + // Indicates whether the Elastic IP address is for use with instances in a VPC ( vpc + // ) or instances in EC2-Classic ( standard ). Domain types.DomainType // The set of Availability Zones, Local Zones, or Wavelength Zones from which diff --git a/service/ec2/api_op_AllocateHosts.go b/service/ec2/api_op_AllocateHosts.go index aecd54cc3ea..281f7c851f5 100644 --- a/service/ec2/api_op_AllocateHosts.go +++ b/service/ec2/api_op_AllocateHosts.go @@ -44,25 +44,22 @@ type AllocateHostsInput struct { // Indicates whether the host accepts any untargeted instance launches that match // its instance type configuration, or if it only accepts Host tenancy instance // launches that specify its unique host ID. For more information, see - // Understanding auto-placement and affinity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) + // Understanding auto-placement and affinity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) // in the Amazon EC2 User Guide. Default: on AutoPlacement types.AutoPlacement // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Indicates whether to enable or disable host maintenance for the Dedicated Host. - // For more information, see Host maintenance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) + // For more information, see Host maintenance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) // in the Amazon EC2 User Guide. HostMaintenance types.HostMaintenance // Indicates whether to enable or disable host recovery for the Dedicated Host. - // Host recovery is disabled by default. For more information, see Host recovery - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) + // Host recovery is disabled by default. For more information, see Host recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) // in the Amazon EC2 User Guide. Default: off HostRecovery types.HostRecovery diff --git a/service/ec2/api_op_AllocateIpamPoolCidr.go b/service/ec2/api_op_AllocateIpamPoolCidr.go index 1d87f35e8b1..a9638ec353b 100644 --- a/service/ec2/api_op_AllocateIpamPoolCidr.go +++ b/service/ec2/api_op_AllocateIpamPoolCidr.go @@ -14,9 +14,8 @@ import ( // Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment // from an IPAM pool to another IPAM pool or to a resource. For more information, -// see Allocate CIDRs -// (https://docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html) in the -// Amazon VPC IPAM User Guide. This action creates an allocation with strong +// see Allocate CIDRs (https://docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html) +// in the Amazon VPC IPAM User Guide. This action creates an allocation with strong // consistency. The returned CIDR will not overlap with any other allocations from // the same pool. func (c *Client) AllocateIpamPoolCidr(ctx context.Context, params *AllocateIpamPoolCidrInput, optFns ...func(*Options)) (*AllocateIpamPoolCidrOutput, error) { @@ -42,22 +41,17 @@ type AllocateIpamPoolCidrInput struct { IpamPoolId *string // The CIDR you would like to allocate from the IPAM pool. Note the following: - // - // * - // If there is no DefaultNetmaskLength allocation rule set on the pool, you must - // specify either the NetmaskLength or the CIDR. - // - // * If the DefaultNetmaskLength - // allocation rule is set on the pool, you can specify either the NetmaskLength or - // the CIDR and the DefaultNetmaskLength allocation rule will be ignored. - // - // Possible - // values: Any available IPv4 or IPv6 CIDR. + // - If there is no DefaultNetmaskLength allocation rule set on the pool, you + // must specify either the NetmaskLength or the CIDR. + // - If the DefaultNetmaskLength allocation rule is set on the pool, you can + // specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength + // allocation rule will be ignored. + // Possible values: Any available IPv4 or IPv6 CIDR. Cidr *string // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the allocation. @@ -69,23 +63,19 @@ type AllocateIpamPoolCidrInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The netmask length of the CIDR you would like to allocate from the IPAM pool. // Note the following: - // - // * If there is no DefaultNetmaskLength allocation rule set - // on the pool, you must specify either the NetmaskLength or the CIDR. - // - // * If the - // DefaultNetmaskLength allocation rule is set on the pool, you can specify either - // the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will - // be ignored. - // - // Possible netmask lengths for IPv4 addresses are 0 - 32. Possible - // netmask lengths for IPv6 addresses are 0 - 128. + // - If there is no DefaultNetmaskLength allocation rule set on the pool, you + // must specify either the NetmaskLength or the CIDR. + // - If the DefaultNetmaskLength allocation rule is set on the pool, you can + // specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength + // allocation rule will be ignored. + // Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask + // lengths for IPv6 addresses are 0 - 128. NetmaskLength *int32 // A preview of the next available CIDR in a pool. diff --git a/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go b/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go index e39c7d6e1f1..6b8e6aeb166 100644 --- a/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go +++ b/service/ec2/api_op_ApplySecurityGroupsToClientVpnTargetNetwork.go @@ -48,8 +48,8 @@ type ApplySecurityGroupsToClientVpnTargetNetworkInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssignIpv6Addresses.go b/service/ec2/api_op_AssignIpv6Addresses.go index 014f11629da..ea69f12e701 100644 --- a/service/ec2/api_op_AssignIpv6Addresses.go +++ b/service/ec2/api_op_AssignIpv6Addresses.go @@ -15,15 +15,13 @@ import ( // IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR // block range. You can assign as many IPv6 addresses to a network interface as you // can assign private IPv4 addresses, and the limit varies per instance type. For -// information, see IP Addresses Per Network Interface Per Instance Type -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) +// information, see IP Addresses Per Network Interface Per Instance Type (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) // in the Amazon Elastic Compute Cloud User Guide. You must specify either the IPv6 // addresses or the IPv6 address count in the request. You can optionally use // Prefix Delegation on the network interface. You must specify either the IPV6 // Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For -// information, see Assigning prefixes to Amazon EC2 network interfaces -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the -// Amazon Elastic Compute Cloud User Guide. +// information, see Assigning prefixes to Amazon EC2 network interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) AssignIpv6Addresses(ctx context.Context, params *AssignIpv6AddressesInput, optFns ...func(*Options)) (*AssignIpv6AddressesOutput, error) { if params == nil { params = &AssignIpv6AddressesInput{} @@ -62,8 +60,8 @@ type AssignIpv6AddressesInput struct { // option. Ipv6PrefixCount *int32 - // One or more IPv6 prefixes assigned to the network interface. You cannot use this - // option if you use the Ipv6PrefixCount option. + // One or more IPv6 prefixes assigned to the network interface. You cannot use + // this option if you use the Ipv6PrefixCount option. Ipv6Prefixes []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssignPrivateIpAddresses.go b/service/ec2/api_op_AssignPrivateIpAddresses.go index 15290146f3f..816544389f6 100644 --- a/service/ec2/api_op_AssignPrivateIpAddresses.go +++ b/service/ec2/api_op_AssignPrivateIpAddresses.go @@ -16,11 +16,9 @@ import ( // can specify the number of secondary IP addresses to be automatically assigned // within the subnet's CIDR block range. The number of secondary IP addresses that // you can assign to an instance varies by instance type. For information about -// instance types, see Instance Types -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the -// Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP -// addresses, see Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// instance types, see Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) +// in the Amazon Elastic Compute Cloud User Guide. For more information about +// Elastic IP addresses, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. When you move a secondary // private IP address to another network interface, any Elastic IP address that is // associated with the IP address is also moved. Remapping an IP address is an @@ -30,9 +28,8 @@ import ( // IP addresses or the IP address count in the request. You can optionally use // Prefix Delegation on the network interface. You must specify either the IPv4 // Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For -// information, see Assigning prefixes to Amazon EC2 network interfaces -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the -// Amazon Elastic Compute Cloud User Guide. +// information, see Assigning prefixes to Amazon EC2 network interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) AssignPrivateIpAddresses(ctx context.Context, params *AssignPrivateIpAddressesInput, optFns ...func(*Options)) (*AssignPrivateIpAddressesOutput, error) { if params == nil { params = &AssignPrivateIpAddressesInput{} @@ -66,13 +63,13 @@ type AssignPrivateIpAddressesInput struct { // option. Ipv4PrefixCount *int32 - // One or more IPv4 prefixes assigned to the network interface. You cannot use this - // option if you use the Ipv4PrefixCount option. + // One or more IPv4 prefixes assigned to the network interface. You cannot use + // this option if you use the Ipv4PrefixCount option. Ipv4Prefixes []string - // The IP addresses to be assigned as a secondary private IP address to the network - // interface. You can't specify this parameter when also specifying a number of - // secondary IP addresses. If you don't specify an IP address, Amazon EC2 + // The IP addresses to be assigned as a secondary private IP address to the + // network interface. You can't specify this parameter when also specifying a + // number of secondary IP addresses. If you don't specify an IP address, Amazon EC2 // automatically selects an IP address within the subnet range. PrivateIpAddresses []string diff --git a/service/ec2/api_op_AssignPrivateNatGatewayAddress.go b/service/ec2/api_op_AssignPrivateNatGatewayAddress.go index f5b13b7db1c..3b62b533286 100644 --- a/service/ec2/api_op_AssignPrivateNatGatewayAddress.go +++ b/service/ec2/api_op_AssignPrivateNatGatewayAddress.go @@ -12,8 +12,7 @@ import ( ) // Assigns one or more private IPv4 addresses to a private NAT gateway. For more -// information, see Work with NAT gateways -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with) +// information, see Work with NAT gateways (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) AssignPrivateNatGatewayAddress(ctx context.Context, params *AssignPrivateNatGatewayAddressInput, optFns ...func(*Options)) (*AssignPrivateNatGatewayAddressOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type AssignPrivateNatGatewayAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The number of private IP addresses to assign to the NAT gateway. You can't diff --git a/service/ec2/api_op_AssociateAddress.go b/service/ec2/api_op_AssociateAddress.go index 55120f8aff2..23bd507189c 100644 --- a/service/ec2/api_op_AssociateAddress.go +++ b/service/ec2/api_op_AssociateAddress.go @@ -14,8 +14,7 @@ import ( // in subnets in Wavelength Zones) with an instance or a network interface. Before // you can use an Elastic IP address, you must allocate it to your account. An // Elastic IP address is for use in either the EC2-Classic platform or in a VPC. -// For more information, see Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// For more information, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. [EC2-Classic, VPC in an // EC2-VPC-only account] If the Elastic IP address is already associated with a // different instance, it is disassociated from that instance and associated with @@ -33,12 +32,10 @@ import ( // group. This is an idempotent operation. If you perform the operation more than // once, Amazon EC2 doesn't return an error, and you may be charged for each time // the Elastic IP address is remapped to the same instance. For more information, -// see the Elastic IP Addresses section of Amazon EC2 Pricing -// (http://aws.amazon.com/ec2/pricing/). We are retiring EC2-Classic. We recommend -// that you migrate from EC2-Classic to a VPC. For more information, see Migrate -// from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// see the Elastic IP Addresses section of Amazon EC2 Pricing (http://aws.amazon.com/ec2/pricing/) +// . We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) AssociateAddress(ctx context.Context, params *AssociateAddressInput, optFns ...func(*Options)) (*AssociateAddressOutput, error) { if params == nil { params = &AssociateAddressInput{} @@ -69,8 +66,8 @@ type AssociateAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the instance. The instance must have exactly one attached network diff --git a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go index 25518d73faa..302ca1c4521 100644 --- a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go @@ -19,7 +19,7 @@ import ( // Availability Zone redundancy. If you specified a VPC when you created the Client // VPN endpoint or if you have previous subnet associations, the specified subnet // must be in the same VPC. To specify a subnet that's in a different VPC, you must -// first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the +// first modify the Client VPN endpoint ( ModifyClientVpnEndpoint ) and change the // VPC that's associated with it. func (c *Client) AssociateClientVpnTargetNetwork(ctx context.Context, params *AssociateClientVpnTargetNetworkInput, optFns ...func(*Options)) (*AssociateClientVpnTargetNetworkOutput, error) { if params == nil { @@ -49,14 +49,14 @@ type AssociateClientVpnTargetNetworkInput struct { SubnetId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateDhcpOptions.go b/service/ec2/api_op_AssociateDhcpOptions.go index 59bfc13880d..71c8b570d68 100644 --- a/service/ec2/api_op_AssociateDhcpOptions.go +++ b/service/ec2/api_op_AssociateDhcpOptions.go @@ -17,9 +17,8 @@ import ( // instances. They automatically pick up the changes within a few hours, depending // on how frequently the instance renews its DHCP lease. You can explicitly renew // the lease using the operating system on the instance. For more information, see -// DHCP options sets -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the -// Amazon Virtual Private Cloud User Guide. +// DHCP options sets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) AssociateDhcpOptions(ctx context.Context, params *AssociateDhcpOptionsInput, optFns ...func(*Options)) (*AssociateDhcpOptionsOutput, error) { if params == nil { params = &AssociateDhcpOptionsInput{} @@ -37,8 +36,8 @@ func (c *Client) AssociateDhcpOptions(ctx context.Context, params *AssociateDhcp type AssociateDhcpOptionsInput struct { - // The ID of the DHCP options set, or default to associate no DHCP options with the - // VPC. + // The ID of the DHCP options set, or default to associate no DHCP options with + // the VPC. // // This member is required. DhcpOptionsId *string @@ -50,8 +49,8 @@ type AssociateDhcpOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go b/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go index 7d223b203d0..fe1b0db6277 100644 --- a/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go +++ b/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go @@ -13,20 +13,18 @@ import ( // Associates an Identity and Access Management (IAM) role with an Certificate // Manager (ACM) certificate. This enables the certificate to be used by the ACM // for Nitro Enclaves application inside an enclave. For more information, see -// Certificate Manager for Nitro Enclaves -// (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) in -// the Amazon Web Services Nitro Enclaves User Guide. When the IAM role is +// Certificate Manager for Nitro Enclaves (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) +// in the Amazon Web Services Nitro Enclaves User Guide. When the IAM role is // associated with the ACM certificate, the certificate, certificate chain, and // encrypted private key are placed in an Amazon S3 location that only the // associated IAM role can access. The private key of the certificate is encrypted // with an Amazon Web Services managed key that has an attached attestation-based // key policy. To enable the IAM role to access the Amazon S3 object, you must -// grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the -// command. To enable the IAM role to access the KMS key, you must grant it +// grant it permission to call s3:GetObject on the Amazon S3 bucket returned by +// the command. To enable the IAM role to access the KMS key, you must grant it // permission to call kms:Decrypt on the KMS key returned by the command. For more -// information, see Grant the role permission to access the certificate and -// encryption key -// (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) +// information, see Grant the role permission to access the certificate and +// encryption key (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) // in the Amazon Web Services Nitro Enclaves User Guide. func (c *Client) AssociateEnclaveCertificateIamRole(ctx context.Context, params *AssociateEnclaveCertificateIamRoleInput, optFns ...func(*Options)) (*AssociateEnclaveCertificateIamRoleOutput, error) { if params == nil { @@ -50,16 +48,16 @@ type AssociateEnclaveCertificateIamRoleInput struct { // This member is required. CertificateArn *string - // The ARN of the IAM role to associate with the ACM certificate. You can associate - // up to 16 IAM roles with an ACM certificate. + // The ARN of the IAM role to associate with the ACM certificate. You can + // associate up to 16 IAM roles with an ACM certificate. // // This member is required. RoleArn *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -70,9 +68,9 @@ type AssociateEnclaveCertificateIamRoleOutput struct { // The name of the Amazon S3 bucket to which the certificate was uploaded. CertificateS3BucketName *string - // The Amazon S3 object key where the certificate, certificate chain, and encrypted - // private key bundle are stored. The object key is formatted as follows: - // role_arn/certificate_arn. + // The Amazon S3 object key where the certificate, certificate chain, and + // encrypted private key bundle are stored. The object key is formatted as follows: + // role_arn / certificate_arn . CertificateS3ObjectKey *string // The ID of the KMS key used to encrypt the private key of the certificate. diff --git a/service/ec2/api_op_AssociateInstanceEventWindow.go b/service/ec2/api_op_AssociateInstanceEventWindow.go index 105c9b9e6eb..194d7b92b59 100644 --- a/service/ec2/api_op_AssociateInstanceEventWindow.go +++ b/service/ec2/api_op_AssociateInstanceEventWindow.go @@ -13,9 +13,8 @@ import ( // Associates one or more targets with an event window. Only one type of target // (instance IDs, Dedicated Host IDs, or tags) can be specified with an event -// window. For more information, see Define event windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// window. For more information, see Define event windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) AssociateInstanceEventWindow(ctx context.Context, params *AssociateInstanceEventWindowInput, optFns ...func(*Options)) (*AssociateInstanceEventWindowOutput, error) { if params == nil { params = &AssociateInstanceEventWindowInput{} @@ -45,8 +44,8 @@ type AssociateInstanceEventWindowInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateIpamResourceDiscovery.go b/service/ec2/api_op_AssociateIpamResourceDiscovery.go index 21593a44f04..b12b27d1b32 100644 --- a/service/ec2/api_op_AssociateIpamResourceDiscovery.go +++ b/service/ec2/api_op_AssociateIpamResourceDiscovery.go @@ -47,8 +47,8 @@ type AssociateIpamResourceDiscoveryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Tag specifications. @@ -59,8 +59,8 @@ type AssociateIpamResourceDiscoveryInput struct { type AssociateIpamResourceDiscoveryOutput struct { - // A resource discovery association. An associated resource discovery is a resource - // discovery that has been associated with an IPAM. + // A resource discovery association. An associated resource discovery is a + // resource discovery that has been associated with an IPAM. IpamResourceDiscoveryAssociation *types.IpamResourceDiscoveryAssociation // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_AssociateNatGatewayAddress.go b/service/ec2/api_op_AssociateNatGatewayAddress.go index f9d1d3adb1a..c8fc0560ef8 100644 --- a/service/ec2/api_op_AssociateNatGatewayAddress.go +++ b/service/ec2/api_op_AssociateNatGatewayAddress.go @@ -12,13 +12,11 @@ import ( ) // Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public -// NAT gateway. For more information, see Work with NAT gateways -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with) +// NAT gateway. For more information, see Work with NAT gateways (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with) // in the Amazon Virtual Private Cloud User Guide. By default, you can associate up // to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by // requesting a quota adjustment. For more information, see Elastic IP address -// quotas -// (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips) +// quotas (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) AssociateNatGatewayAddress(ctx context.Context, params *AssociateNatGatewayAddressInput, optFns ...func(*Options)) (*AssociateNatGatewayAddressOutput, error) { if params == nil { @@ -49,8 +47,8 @@ type AssociateNatGatewayAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The private IPv4 addresses that you want to assign to the NAT gateway. diff --git a/service/ec2/api_op_AssociateRouteTable.go b/service/ec2/api_op_AssociateRouteTable.go index 5a9edbe4f48..b71bc5ca085 100644 --- a/service/ec2/api_op_AssociateRouteTable.go +++ b/service/ec2/api_op_AssociateRouteTable.go @@ -16,9 +16,8 @@ import ( // causes traffic from the subnet or gateway to be routed according to the routes // in the route table. The action returns an association ID, which you need in // order to disassociate the route table later. A route table can be associated -// with multiple subnets. For more information, see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// with multiple subnets. For more information, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) AssociateRouteTable(ctx context.Context, params *AssociateRouteTableInput, optFns ...func(*Options)) (*AssociateRouteTableOutput, error) { if params == nil { params = &AssociateRouteTableInput{} @@ -43,8 +42,8 @@ type AssociateRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the internet gateway or virtual private gateway. @@ -58,8 +57,8 @@ type AssociateRouteTableInput struct { type AssociateRouteTableOutput struct { - // The route table association ID. This ID is required for disassociating the route - // table. + // The route table association ID. This ID is required for disassociating the + // route table. AssociationId *string // The state of the association. diff --git a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go index a9cf1c57a17..8702006dbf6 100644 --- a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go @@ -14,8 +14,7 @@ import ( // Associates the specified subnets and transit gateway attachments with the // specified transit gateway multicast domain. The transit gateway attachment must // be in the available state before you can add a resource. Use -// DescribeTransitGatewayAttachments -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html) +// DescribeTransitGatewayAttachments (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html) // to see the state of the attachment. func (c *Client) AssociateTransitGatewayMulticastDomain(ctx context.Context, params *AssociateTransitGatewayMulticastDomainInput, optFns ...func(*Options)) (*AssociateTransitGatewayMulticastDomainOutput, error) { if params == nil { @@ -52,8 +51,8 @@ type AssociateTransitGatewayMulticastDomainInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateTransitGatewayPolicyTable.go b/service/ec2/api_op_AssociateTransitGatewayPolicyTable.go index 782cd293c0b..5164f45cfe1 100644 --- a/service/ec2/api_op_AssociateTransitGatewayPolicyTable.go +++ b/service/ec2/api_op_AssociateTransitGatewayPolicyTable.go @@ -35,16 +35,16 @@ type AssociateTransitGatewayPolicyTableInput struct { // This member is required. TransitGatewayAttachmentId *string - // The ID of the transit gateway policy table to associate with the transit gateway - // attachment. + // The ID of the transit gateway policy table to associate with the transit + // gateway attachment. // // This member is required. TransitGatewayPolicyTableId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateTransitGatewayRouteTable.go b/service/ec2/api_op_AssociateTransitGatewayRouteTable.go index bb040557cee..a0c63a3c5c5 100644 --- a/service/ec2/api_op_AssociateTransitGatewayRouteTable.go +++ b/service/ec2/api_op_AssociateTransitGatewayRouteTable.go @@ -42,8 +42,8 @@ type AssociateTransitGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AssociateTrunkInterface.go b/service/ec2/api_op_AssociateTrunkInterface.go index 20aa95fca3a..4c27b985544 100644 --- a/service/ec2/api_op_AssociateTrunkInterface.go +++ b/service/ec2/api_op_AssociateTrunkInterface.go @@ -15,9 +15,8 @@ import ( // This API action is currently in limited preview only. If you are interested in // using this feature, contact your account manager. Associates a branch network // interface with a trunk network interface. Before you create the association, run -// the create-network-interface -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) -// command and set --interface-type to trunk. You must also create a network +// the create-network-interface (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) +// command and set --interface-type to trunk . You must also create a network // interface for each branch network interface that you want to associate with the // trunk network interface. func (c *Client) AssociateTrunkInterface(ctx context.Context, params *AssociateTrunkInterfaceInput, optFns ...func(*Options)) (*AssociateTrunkInterfaceOutput, error) { @@ -48,14 +47,14 @@ type AssociateTrunkInterfaceInput struct { TrunkInterfaceId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The application key. This applies to the GRE protocol. @@ -70,12 +69,12 @@ type AssociateTrunkInterfaceInput struct { type AssociateTrunkInterfaceOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string - // Information about the association between the trunk network interface and branch - // network interface. + // Information about the association between the trunk network interface and + // branch network interface. InterfaceAssociation *types.TrunkInterfaceAssociation // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_AssociateVpcCidrBlock.go b/service/ec2/api_op_AssociateVpcCidrBlock.go index 1093cfaac75..3b721a1eecc 100644 --- a/service/ec2/api_op_AssociateVpcCidrBlock.go +++ b/service/ec2/api_op_AssociateVpcCidrBlock.go @@ -13,13 +13,11 @@ import ( // Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR // block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 -// address pool that you provisioned through bring your own IP addresses (BYOIP -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html)). The IPv6 -// CIDR block size is fixed at /56. You must specify one of the following in the -// request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR -// block. For more information about associating CIDR blocks with your VPC and -// applicable restrictions, see VPC and subnet sizing -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing) +// address pool that you provisioned through bring your own IP addresses ( BYOIP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) +// ). The IPv6 CIDR block size is fixed at /56. You must specify one of the +// following in the request: an IPv4 CIDR block, an IPv6 pool, or an +// Amazon-provided IPv6 CIDR block. For more information about associating CIDR +// blocks with your VPC and applicable restrictions, see VPC and subnet sizing (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#VPC_Sizing) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) AssociateVpcCidrBlock(ctx context.Context, params *AssociateVpcCidrBlockInput, optFns ...func(*Options)) (*AssociateVpcCidrBlockOutput, error) { if params == nil { @@ -51,39 +49,37 @@ type AssociateVpcCidrBlockInput struct { // An IPv4 CIDR block to associate with the VPC. CidrBlock *string - // Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information - // about Amazon VPC IP Address Manager (IPAM), see What is IPAM? - // (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon - // VPC IPAM User Guide. + // Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more + // information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. Ipv4IpamPoolId *string // The netmask length of the IPv4 CIDR you would like to associate from an Amazon - // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is - // IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the - // Amazon VPC IPAM User Guide. + // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What + // is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in + // the Amazon VPC IPAM User Guide. Ipv4NetmaskLength *int32 - // An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in - // the request. To let Amazon choose the IPv6 CIDR block for you, omit this + // An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool + // in the request. To let Amazon choose the IPv6 CIDR block for you, omit this // parameter. Ipv6CidrBlock *string // The name of the location from which we advertise the IPV6 CIDR block. Use this // parameter to limit the CIDR block to this location. You must set - // AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one IPv6 - // CIDR block association per network border group. + // AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one + // IPv6 CIDR block association per network border group. Ipv6CidrBlockNetworkBorderGroup *string // Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more - // information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? - // (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon - // VPC IPAM User Guide. + // information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. Ipv6IpamPoolId *string // The netmask length of the IPv6 CIDR you would like to associate from an Amazon - // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is - // IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the - // Amazon VPC IPAM User Guide. + // VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What + // is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in + // the Amazon VPC IPAM User Guide. Ipv6NetmaskLength *int32 // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. diff --git a/service/ec2/api_op_AttachClassicLinkVpc.go b/service/ec2/api_op_AttachClassicLinkVpc.go index 904151f47bc..cc2be276df0 100644 --- a/service/ec2/api_op_AttachClassicLinkVpc.go +++ b/service/ec2/api_op_AttachClassicLinkVpc.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Links an EC2-Classic instance to a -// ClassicLink-enabled VPC through one or more of the VPC's security groups. You +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Links an EC2-Classic instance to +// a ClassicLink-enabled VPC through one or more of the VPC's security groups. You // cannot link an EC2-Classic instance to more than one VPC at a time. You can only // link an instance that's in the running state. An instance is automatically // unlinked from a VPC when it's stopped - you can link it to the VPC again when @@ -57,8 +56,8 @@ type AttachClassicLinkVpcInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AttachInternetGateway.go b/service/ec2/api_op_AttachInternetGateway.go index beb5e61ce1b..43a8cf58f30 100644 --- a/service/ec2/api_op_AttachInternetGateway.go +++ b/service/ec2/api_op_AttachInternetGateway.go @@ -12,8 +12,8 @@ import ( // Attaches an internet gateway or a virtual private gateway to a VPC, enabling // connectivity between the internet and the VPC. For more information about your -// VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide -// (https://docs.aws.amazon.com/vpc/latest/userguide/). +// VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide (https://docs.aws.amazon.com/vpc/latest/userguide/) +// . func (c *Client) AttachInternetGateway(ctx context.Context, params *AttachInternetGatewayInput, optFns ...func(*Options)) (*AttachInternetGatewayOutput, error) { if params == nil { params = &AttachInternetGatewayInput{} @@ -43,8 +43,8 @@ type AttachInternetGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AttachNetworkInterface.go b/service/ec2/api_op_AttachNetworkInterface.go index af9fc67acb9..ee5f5e46e4f 100644 --- a/service/ec2/api_op_AttachNetworkInterface.go +++ b/service/ec2/api_op_AttachNetworkInterface.go @@ -47,8 +47,8 @@ type AttachNetworkInterfaceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Configures ENA Express for the network interface that this action attaches to diff --git a/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go b/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go index c5d42ccaf10..9d5b220d80c 100644 --- a/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go @@ -43,14 +43,14 @@ type AttachVerifiedAccessTrustProviderInput struct { VerifiedAccessTrustProviderId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AttachVolume.go b/service/ec2/api_op_AttachVolume.go index 949d3b6d005..ceee102ba8f 100644 --- a/service/ec2/api_op_AttachVolume.go +++ b/service/ec2/api_op_AttachVolume.go @@ -15,30 +15,20 @@ import ( // Attaches an EBS volume to a running or stopped instance and exposes it to the // instance with the specified device name. Encrypted EBS volumes must be attached // to instances that support Amazon EBS encryption. For more information, see -// Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. After you attach an EBS volume, you -// must make it available. For more information, see Make an EBS volume available -// for use -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html). If -// a volume has an Amazon Web Services Marketplace product code: +// Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. After you attach an EBS volume, +// you must make it available. For more information, see Make an EBS volume +// available for use (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html) +// . If a volume has an Amazon Web Services Marketplace product code: +// - The volume can be attached only to a stopped instance. +// - Amazon Web Services Marketplace product codes are copied from the volume to +// the instance. +// - You must be subscribed to the product. +// - The instance type and operating system of the instance must support the +// product. For example, you can't detach a volume from a Windows instance and +// attach it to a Linux instance. // -// * The volume can -// be attached only to a stopped instance. -// -// * Amazon Web Services Marketplace -// product codes are copied from the volume to the instance. -// -// * You must be -// subscribed to the product. -// -// * The instance type and operating system of the -// instance must support the product. For example, you can't detach a volume from a -// Windows instance and attach it to a Linux instance. -// -// For more information, see -// Attach an Amazon EBS volume to an instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html) +// For more information, see Attach an Amazon EBS volume to an instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, optFns ...func(*Options)) (*AttachVolumeOutput, error) { if params == nil { @@ -57,7 +47,7 @@ func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, op type AttachVolumeInput struct { - // The device name (for example, /dev/sdh or xvdh). + // The device name (for example, /dev/sdh or xvdh ). // // This member is required. Device *string @@ -75,8 +65,8 @@ type AttachVolumeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AttachVpnGateway.go b/service/ec2/api_op_AttachVpnGateway.go index 25e94082efe..39306a2606b 100644 --- a/service/ec2/api_op_AttachVpnGateway.go +++ b/service/ec2/api_op_AttachVpnGateway.go @@ -45,8 +45,8 @@ type AttachVpnGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AuthorizeClientVpnIngress.go b/service/ec2/api_op_AuthorizeClientVpnIngress.go index 01a5d8a5fc4..f21c82814fe 100644 --- a/service/ec2/api_op_AuthorizeClientVpnIngress.go +++ b/service/ec2/api_op_AuthorizeClientVpnIngress.go @@ -45,8 +45,8 @@ type AuthorizeClientVpnIngressInput struct { TargetNetworkCidr *string // The ID of the group to grant access to, for example, the Active Directory group - // or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not - // specified. + // or identity provider (IdP) group. Required if AuthorizeAllGroups is false or + // not specified. AccessGroupId *string // Indicates whether to grant access to all clients. Specify true to grant all @@ -55,8 +55,8 @@ type AuthorizeClientVpnIngressInput struct { AuthorizeAllGroups *bool // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A brief description of the authorization rule. @@ -64,8 +64,8 @@ type AuthorizeClientVpnIngressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go index d3939ca87ba..6e358fad2f9 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go @@ -15,15 +15,15 @@ import ( // use with a VPC. An outbound rule permits instances to send traffic to the // specified IPv4 or IPv6 CIDR address ranges, or to the instances that are // associated with the specified source security groups. When specifying an -// outbound rule for your security group in a VPC, the IpPermissions must include a -// destination for the traffic. You specify a protocol for each rule (for example, -// TCP). For the TCP and UDP protocols, you must also specify the destination port -// or port range. For the ICMP protocol, you must also specify the ICMP type and -// code. You can use -1 for the type or code to mean all types or all codes. Rule -// changes are propagated to affected instances as quickly as possible. However, a -// small delay might occur. For information about VPC security group quotas, see -// Amazon VPC quotas -// (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html). +// outbound rule for your security group in a VPC, the IpPermissions must include +// a destination for the traffic. You specify a protocol for each rule (for +// example, TCP). For the TCP and UDP protocols, you must also specify the +// destination port or port range. For the ICMP protocol, you must also specify the +// ICMP type and code. You can use -1 for the type or code to mean all types or all +// codes. Rule changes are propagated to affected instances as quickly as possible. +// However, a small delay might occur. For information about VPC security group +// quotas, see Amazon VPC quotas (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) +// . func (c *Client) AuthorizeSecurityGroupEgress(ctx context.Context, params *AuthorizeSecurityGroupEgressInput, optFns ...func(*Options)) (*AuthorizeSecurityGroupEgressOutput, error) { if params == nil { params = &AuthorizeSecurityGroupEgressInput{} @@ -51,15 +51,15 @@ type AuthorizeSecurityGroupEgressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Not supported. Use a set of IP permissions to specify the port. FromPort *int32 - // The sets of IP permissions. You can't specify a destination security group and a - // CIDR IP address range in the same set of permissions. + // The sets of IP permissions. You can't specify a destination security group and + // a CIDR IP address range in the same set of permissions. IpPermissions []types.IpPermission // Not supported. Use a set of IP permissions to specify the protocol name or diff --git a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go index 7d83e7d20ff..210c8035a7e 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go @@ -21,12 +21,10 @@ import ( // specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all // codes. Rule changes are propagated to instances within the security group as // quickly as possible. However, a small delay might occur. For more information -// about VPC security group quotas, see Amazon VPC quotas -// (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html). We -// are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// about VPC security group quotas, see Amazon VPC quotas (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) +// . We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) AuthorizeSecurityGroupIngress(ctx context.Context, params *AuthorizeSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeSecurityGroupIngressOutput, error) { if params == nil { params = &AuthorizeSecurityGroupIngressInput{} @@ -52,8 +50,8 @@ type AuthorizeSecurityGroupIngressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // If the protocol is TCP or UDP, this is the start of the port range. If the @@ -76,13 +74,12 @@ type AuthorizeSecurityGroupIngressInput struct { // The sets of IP permissions. IpPermissions []types.IpPermission - // The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). To - // specify icmpv6, use a set of IP permissions. [VPC only] Use -1 to specify all - // protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic - // on all ports is allowed, regardless of any ports you specify. Alternatively, use - // a set of IP permissions to specify multiple rules and a description for the - // rule. + // The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // ). To specify icmpv6 , use a set of IP permissions. [VPC only] Use -1 to + // specify all protocols. If you specify -1 or a protocol other than tcp , udp , or + // icmp , traffic on all ports is allowed, regardless of any ports you specify. + // Alternatively, use a set of IP permissions to specify multiple rules and a + // description for the rule. IpProtocol *string // [EC2-Classic, default VPC] The name of the source security group. You can't diff --git a/service/ec2/api_op_BundleInstance.go b/service/ec2/api_op_BundleInstance.go index 9ed7189315d..5199e4e1b2d 100644 --- a/service/ec2/api_op_BundleInstance.go +++ b/service/ec2/api_op_BundleInstance.go @@ -47,8 +47,8 @@ type BundleInstanceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelBundleTask.go b/service/ec2/api_op_CancelBundleTask.go index efa7255a293..194d8b2107f 100644 --- a/service/ec2/api_op_CancelBundleTask.go +++ b/service/ec2/api_op_CancelBundleTask.go @@ -37,8 +37,8 @@ type CancelBundleTaskInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelCapacityReservation.go b/service/ec2/api_op_CancelCapacityReservation.go index 82f464cda5d..05666d01bc4 100644 --- a/service/ec2/api_op_CancelCapacityReservation.go +++ b/service/ec2/api_op_CancelCapacityReservation.go @@ -11,7 +11,7 @@ import ( ) // Cancels the specified Capacity Reservation, releases the reserved capacity, and -// changes the Capacity Reservation's state to cancelled. Instances running in the +// changes the Capacity Reservation's state to cancelled . Instances running in the // reserved capacity continue running until you stop them. Stopped instances that // target the Capacity Reservation can no longer launch. Modify these instances to // either target a different Capacity Reservation, launch On-Demand Instance @@ -41,8 +41,8 @@ type CancelCapacityReservationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelCapacityReservationFleets.go b/service/ec2/api_op_CancelCapacityReservationFleets.go index 7eb3a98b3d9..4f7ab400463 100644 --- a/service/ec2/api_op_CancelCapacityReservationFleets.go +++ b/service/ec2/api_op_CancelCapacityReservationFleets.go @@ -13,16 +13,11 @@ import ( // Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity // Reservation Fleet, the following happens: -// -// * The Capacity Reservation Fleet's -// status changes to cancelled. -// -// * The individual Capacity Reservations in the -// Fleet are cancelled. Instances running in the Capacity Reservations at the time -// of cancelling the Fleet continue to run in shared capacity. -// -// * The Fleet stops -// creating new Capacity Reservations. +// - The Capacity Reservation Fleet's status changes to cancelled . +// - The individual Capacity Reservations in the Fleet are cancelled. Instances +// running in the Capacity Reservations at the time of cancelling the Fleet +// continue to run in shared capacity. +// - The Fleet stops creating new Capacity Reservations. func (c *Client) CancelCapacityReservationFleets(ctx context.Context, params *CancelCapacityReservationFleetsInput, optFns ...func(*Options)) (*CancelCapacityReservationFleetsOutput, error) { if params == nil { params = &CancelCapacityReservationFleetsInput{} @@ -47,8 +42,8 @@ type CancelCapacityReservationFleetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelConversionTask.go b/service/ec2/api_op_CancelConversionTask.go index c1b3ed5f472..655c46c0d86 100644 --- a/service/ec2/api_op_CancelConversionTask.go +++ b/service/ec2/api_op_CancelConversionTask.go @@ -15,8 +15,8 @@ import ( // partially uploaded volume or instance. If the conversion is complete or is in // the process of transferring the final disk image, the command fails and returns // an exception. For more information, see Importing a Virtual Machine Using the -// Amazon EC2 CLI -// (https://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ec2-cli-vmimport-export.html). +// Amazon EC2 CLI (https://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ec2-cli-vmimport-export.html) +// . func (c *Client) CancelConversionTask(ctx context.Context, params *CancelConversionTaskInput, optFns ...func(*Options)) (*CancelConversionTaskOutput, error) { if params == nil { params = &CancelConversionTaskInput{} @@ -41,8 +41,8 @@ type CancelConversionTaskInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The reason for canceling the conversion task. diff --git a/service/ec2/api_op_CancelExportTask.go b/service/ec2/api_op_CancelExportTask.go index 133ff3a0483..fec8226e91c 100644 --- a/service/ec2/api_op_CancelExportTask.go +++ b/service/ec2/api_op_CancelExportTask.go @@ -31,7 +31,7 @@ func (c *Client) CancelExportTask(ctx context.Context, params *CancelExportTaskI type CancelExportTaskInput struct { - // The ID of the export task. This is the ID returned by CreateInstanceExportTask. + // The ID of the export task. This is the ID returned by CreateInstanceExportTask . // // This member is required. ExportTaskId *string diff --git a/service/ec2/api_op_CancelImageLaunchPermission.go b/service/ec2/api_op_CancelImageLaunchPermission.go index ab4dd90ad95..d93946a44db 100644 --- a/service/ec2/api_op_CancelImageLaunchPermission.go +++ b/service/ec2/api_op_CancelImageLaunchPermission.go @@ -11,9 +11,8 @@ import ( ) // Removes your Amazon Web Services account from the launch permissions for the -// specified AMI. For more information, see Cancel having an AMI shared with your -// Amazon Web Services account -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html) +// specified AMI. For more information, see Cancel having an AMI shared with your +// Amazon Web Services account (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html) // in the Amazon EC2 User Guide. func (c *Client) CancelImageLaunchPermission(ctx context.Context, params *CancelImageLaunchPermissionInput, optFns ...func(*Options)) (*CancelImageLaunchPermissionOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type CancelImageLaunchPermissionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelImportTask.go b/service/ec2/api_op_CancelImportTask.go index ae58f42fd1b..95e1725cea1 100644 --- a/service/ec2/api_op_CancelImportTask.go +++ b/service/ec2/api_op_CancelImportTask.go @@ -33,8 +33,8 @@ type CancelImportTaskInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the import image or import snapshot task to be canceled. diff --git a/service/ec2/api_op_CancelReservedInstancesListing.go b/service/ec2/api_op_CancelReservedInstancesListing.go index 95682e46a82..9594accb4ee 100644 --- a/service/ec2/api_op_CancelReservedInstancesListing.go +++ b/service/ec2/api_op_CancelReservedInstancesListing.go @@ -12,9 +12,8 @@ import ( ) // Cancels the specified Reserved Instance listing in the Reserved Instance -// Marketplace. For more information, see Reserved Instance Marketplace -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in -// the Amazon EC2 User Guide. +// Marketplace. For more information, see Reserved Instance Marketplace (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) +// in the Amazon EC2 User Guide. func (c *Client) CancelReservedInstancesListing(ctx context.Context, params *CancelReservedInstancesListingInput, optFns ...func(*Options)) (*CancelReservedInstancesListingOutput, error) { if params == nil { params = &CancelReservedInstancesListingInput{} diff --git a/service/ec2/api_op_CancelSpotFleetRequests.go b/service/ec2/api_op_CancelSpotFleetRequests.go index d93d2c9e99a..365fba1fc8c 100644 --- a/service/ec2/api_op_CancelSpotFleetRequests.go +++ b/service/ec2/api_op_CancelSpotFleetRequests.go @@ -44,15 +44,15 @@ type CancelSpotFleetRequestsInput struct { // Indicates whether to terminate the associated instances when the Spot Fleet // request is canceled. The default is to terminate the instances. To let the // instances continue to run after the Spot Fleet request is canceled, specify - // no-terminate-instances. + // no-terminate-instances . // // This member is required. TerminateInstances *bool // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CancelSpotInstanceRequests.go b/service/ec2/api_op_CancelSpotInstanceRequests.go index 44804376666..a6868f10696 100644 --- a/service/ec2/api_op_CancelSpotInstanceRequests.go +++ b/service/ec2/api_op_CancelSpotInstanceRequests.go @@ -38,8 +38,8 @@ type CancelSpotInstanceRequestsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ConfirmProductInstance.go b/service/ec2/api_op_ConfirmProductInstance.go index bfad4916266..869dd43a89e 100644 --- a/service/ec2/api_op_ConfirmProductInstance.go +++ b/service/ec2/api_op_ConfirmProductInstance.go @@ -42,8 +42,8 @@ type ConfirmProductInstanceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CopyFpgaImage.go b/service/ec2/api_op_CopyFpgaImage.go index 43c71eeebd2..14167315b9c 100644 --- a/service/ec2/api_op_CopyFpgaImage.go +++ b/service/ec2/api_op_CopyFpgaImage.go @@ -39,8 +39,8 @@ type CopyFpgaImageInput struct { SourceRegion *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // The description for the new AFI. @@ -48,8 +48,8 @@ type CopyFpgaImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name for the new AFI. The default is the name of the source AFI. diff --git a/service/ec2/api_op_CopyImage.go b/service/ec2/api_op_CopyImage.go index 006183d791c..a21878b3c6b 100644 --- a/service/ec2/api_op_CopyImage.go +++ b/service/ec2/api_op_CopyImage.go @@ -10,12 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates the copy of an AMI. You can copy an AMI from one Region to another, or -// from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, -// from one Outpost to another, or within the same Outpost. To copy an AMI to -// another partition, see CreateStoreImageTask -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html). -// To copy an AMI from one Region to another, specify the source Region using the +// Initiates the copy of an AMI. You can copy an AMI from one Region to another, +// or from a Region to an Outpost. You can't copy an AMI from an Outpost to a +// Region, from one Outpost to another, or within the same Outpost. To copy an AMI +// to another partition, see CreateStoreImageTask (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html) +// . To copy an AMI from one Region to another, specify the source Region using the // SourceRegion parameter, and specify the destination Region using its endpoint. // Copies of encrypted backing snapshots for the AMI are encrypted. Copies of // unencrypted backing snapshots remain unencrypted, unless you set Encrypted @@ -25,13 +24,11 @@ import ( // Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are // encrypted by default using the default encryption key for the Region, or a // different key that you specify in the request using KmsKeyId. Outposts do not -// support unencrypted snapshots. For more information, Amazon EBS local snapshots -// on Outposts -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) +// support unencrypted snapshots. For more information, Amazon EBS local snapshots +// on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) // in the Amazon EC2 User Guide. For more information about the prerequisites and -// limits when copying an AMI, see Copy an AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) in the -// Amazon EC2 User Guide. +// limits when copying an AMI, see Copy an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) +// in the Amazon EC2 User Guide. func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns ...func(*Options)) (*CopyImageOutput, error) { if params == nil { params = &CopyImageInput{} @@ -66,20 +63,15 @@ type CopyImageInput struct { SourceRegion *string // Unique, case-sensitive identifier you provide to ensure idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. ClientToken *string // Indicates whether to include your user-defined AMI tags when copying the AMI. // The following tags will not be copied: - // - // * System tags (prefixed with aws:) - // - // * - // For public and shared AMIs, user-defined tags that are attached by other Amazon - // Web Services accounts - // + // - System tags (prefixed with aws: ) + // - For public and shared AMIs, user-defined tags that are attached by other + // Amazon Web Services accounts // Default: Your user-defined AMI tags are not copied. CopyImageTags *bool @@ -90,51 +82,40 @@ type CopyImageInput struct { // specify this parameter when copying an AMI from an Amazon Web Services Region to // an Outpost. The AMI must be in the Region of the destination Outpost. You cannot // copy an AMI from an Outpost to a Region, from one Outpost to another, or within - // the same Outpost. For more information, see Copy AMIs from an Amazon Web - // Services Region to an Outpost - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#copy-amis) + // the same Outpost. For more information, see Copy AMIs from an Amazon Web + // Services Region to an Outpost (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#copy-amis) // in the Amazon EC2 User Guide. DestinationOutpostArn *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specifies whether the destination snapshots of the copied image should be // encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot // create an unencrypted copy of an encrypted snapshot. The default KMS key for // Amazon EBS is used unless you specify a non-default Key Management Service (KMS) - // KMS key using KmsKeyId. For more information, see Amazon EBS encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon EC2 User Guide. + // KMS key using KmsKeyId . For more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // in the Amazon EC2 User Guide. Encrypted *bool - // The identifier of the symmetric Key Management Service (KMS) KMS key to use when - // creating encrypted volumes. If this parameter is not specified, your Amazon Web - // Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you - // must also set the encrypted state to true. You can specify a KMS key using any - // of the following: - // - // * Key ID. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Key alias. For example, - // alias/ExampleAlias. - // - // * Key ARN. For example, - // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Alias ARN. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // authenticates the KMS key asynchronously. Therefore, if you specify an - // identifier that is not valid, the action can appear to complete, but eventually - // fails. The specified KMS key must exist in the destination Region. Amazon EBS - // does not support asymmetric KMS keys. + // The identifier of the symmetric Key Management Service (KMS) KMS key to use + // when creating encrypted volumes. If this parameter is not specified, your Amazon + // Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, + // you must also set the encrypted state to true . You can specify a KMS key using + // any of the following: + // - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + // - Key alias. For example, alias/ExampleAlias. + // - Key ARN. For example, + // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // - Alias ARN. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you + // specify an identifier that is not valid, the action can appear to complete, but + // eventually fails. The specified KMS key must exist in the destination Region. + // Amazon EBS does not support asymmetric KMS keys. KmsKeyId *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_CopySnapshot.go b/service/ec2/api_op_CopySnapshot.go index a4648c5e05f..0c9091c7ee0 100644 --- a/service/ec2/api_op_CopySnapshot.go +++ b/service/ec2/api_op_CopySnapshot.go @@ -13,10 +13,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You -// can copy a snapshot within the same Region, from one Region to another, or from -// a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, -// from one Outpost to another, or within the same Outpost. You can use the +// Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. +// You can copy a snapshot within the same Region, from one Region to another, or +// from a Region to an Outpost. You can't copy a snapshot from an Outpost to a +// Region, from one Outpost to another, or within the same Outpost. You can use the // snapshot to create EBS volumes or Amazon Machine Images (AMIs). When copying // snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. // Copies of unencrypted snapshots remain unencrypted, unless you enable encryption @@ -27,13 +27,11 @@ import ( // snapshot. Snapshots copied to an Outpost are encrypted by default using the // default encryption key for the Region, or a different key that you specify in // the request using KmsKeyId. Outposts do not support unencrypted snapshots. For -// more information, Amazon EBS local snapshots on Outposts -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) +// more information, Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) // in the Amazon Elastic Compute Cloud User Guide. Snapshots created by copying // another snapshot have an arbitrary volume ID that should not be used for any -// purpose. For more information, see Copy an Amazon EBS snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html) in -// the Amazon Elastic Compute Cloud User Guide. +// purpose. For more information, see Copy an Amazon EBS snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error) { if params == nil { params = &CopySnapshotInput{} @@ -68,62 +66,49 @@ type CopySnapshotInput struct { // Only specify this parameter when copying a snapshot from an Amazon Web Services // Region to an Outpost. The snapshot must be in the Region for the destination // Outpost. You cannot copy a snapshot from an Outpost to a Region, from one - // Outpost to another, or within the same Outpost. For more information, see Copy - // snapshots from an Amazon Web Services Region to an Outpost - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#copy-snapshots) + // Outpost to another, or within the same Outpost. For more information, see Copy + // snapshots from an Amazon Web Services Region to an Outpost (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#copy-snapshots) // in the Amazon Elastic Compute Cloud User Guide. DestinationOutpostArn *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // To encrypt a copy of an unencrypted snapshot if encryption by default is not // enabled, enable encryption using this parameter. Otherwise, omit this parameter. // Encrypted snapshots are encrypted, even if you omit this parameter and // encryption by default is not enabled. You cannot set this parameter to false. - // For more information, see Amazon EBS encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. + // For more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // in the Amazon Elastic Compute Cloud User Guide. Encrypted *bool - // The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS - // encryption. If this parameter is not specified, your KMS key for Amazon EBS is - // used. If KmsKeyId is specified, the encrypted state must be true. You can + // The identifier of the Key Management Service (KMS) KMS key to use for Amazon + // EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS + // is used. If KmsKeyId is specified, the encrypted state must be true . You can // specify the KMS key using any of the following: - // - // * Key ID. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Key alias. For example, - // alias/ExampleAlias. - // - // * Key ARN. For example, - // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Alias ARN. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // authenticates the KMS key asynchronously. Therefore, if you specify an ID, - // alias, or ARN that is not valid, the action can appear to complete, but - // eventually fails. + // - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + // - Key alias. For example, alias/ExampleAlias. + // - Key ARN. For example, + // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // - Alias ARN. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you + // specify an ID, alias, or ARN that is not valid, the action can appear to + // complete, but eventually fails. KmsKeyId *string // When you copy an encrypted source snapshot using the Amazon EC2 Query API, you // must supply a pre-signed URL. This parameter is optional for unencrypted - // snapshots. For more information, see Query requests - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html). - // The PresignedUrl should use the snapshot source endpoint, the CopySnapshot - // action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion + // snapshots. For more information, see Query requests (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html) + // . The PresignedUrl should use the snapshot source endpoint, the CopySnapshot + // action, and include the SourceRegion , SourceSnapshotId , and DestinationRegion // parameters. The PresignedUrl must be signed using Amazon Web Services Signature // Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm // for this parameter uses the same logic that is described in Authenticating - // Requests: Using Query Parameters (Amazon Web Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // Requests: Using Query Parameters (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) // in the Amazon Simple Storage Service API Reference. An invalid or improperly // signed PresignedUrl will cause the copy operation to fail asynchronously, and // the snapshot will move to an error state. @@ -132,8 +117,8 @@ type CopySnapshotInput struct { // The tags to apply to the new snapshot. TagSpecifications []types.TagSpecification - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCapacityReservation.go b/service/ec2/api_op_CreateCapacityReservation.go index 79683d37afe..a7e9e59a16d 100644 --- a/service/ec2/api_op_CreateCapacityReservation.go +++ b/service/ec2/api_op_CreateCapacityReservation.go @@ -18,8 +18,7 @@ import ( // selectively add capacity reservations and still get the Regional RI discounts // for that usage. By creating Capacity Reservations, you ensure that you always // have access to Amazon EC2 capacity when you need it, for as long as you need it. -// For more information, see Capacity Reservations -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) +// For more information, see Capacity Reservations (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) // in the Amazon EC2 User Guide. Your request to create a Capacity Reservation // could fail if Amazon EC2 does not have sufficient capacity to fulfill the // request. If your request fails due to Amazon EC2 capacity constraints, either @@ -30,8 +29,7 @@ import ( // On-Demand Instance limit for the selected instance type. If your request fails // due to limit constraints, increase your On-Demand Instance limit for the // required instance type and try again. For more information about increasing your -// instance limits, see Amazon EC2 Service Quotas -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) +// instance limits, see Amazon EC2 Service Quotas (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) // in the Amazon EC2 User Guide. func (c *Client) CreateCapacityReservation(ctx context.Context, params *CreateCapacityReservationInput, optFns ...func(*Options)) (*CreateCapacityReservationOutput, error) { if params == nil { @@ -61,9 +59,8 @@ type CreateCapacityReservationInput struct { InstancePlatform types.CapacityReservationInstancePlatform // The instance type for which to reserve capacity. For more information, see - // Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. // // This member is required. InstanceType *string @@ -75,14 +72,14 @@ type CreateCapacityReservationInput struct { AvailabilityZoneId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether the Capacity Reservation supports EBS-optimized instances. @@ -96,23 +93,20 @@ type CreateCapacityReservationInput struct { // Reservation expires, the reserved capacity is released and you can no longer // launch instances into it. The Capacity Reservation's state changes to expired // when it reaches its end date and time. You must provide an EndDate value if - // EndDateType is limited. Omit EndDate if EndDateType is unlimited. If the - // EndDateType is limited, the Capacity Reservation is cancelled within an hour + // EndDateType is limited . Omit EndDate if EndDateType is unlimited . If the + // EndDateType is limited , the Capacity Reservation is cancelled within an hour // from the specified time. For example, if you specify 5/31/2019, 13:30:55, the // Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on // 5/31/2019. EndDate *time.Time - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation - // can have one of the following end types: - // - // * unlimited - The Capacity Reservation - // remains active until you explicitly cancel it. Do not provide an EndDate if the - // EndDateType is unlimited. - // - // * limited - The Capacity Reservation expires - // automatically at a specified date and time. You must provide an EndDate value if - // the EndDateType value is limited. + // Indicates the way in which the Capacity Reservation ends. A Capacity + // Reservation can have one of the following end types: + // - unlimited - The Capacity Reservation remains active until you explicitly + // cancel it. Do not provide an EndDate if the EndDateType is unlimited . + // - limited - The Capacity Reservation expires automatically at a specified date + // and time. You must provide an EndDate value if the EndDateType value is + // limited . EndDateType types.EndDateType // Deprecated. @@ -120,18 +114,14 @@ type CreateCapacityReservationInput struct { // Indicates the type of instance launches that the Capacity Reservation accepts. // The options include: - // - // * open - The Capacity Reservation automatically matches - // all instances that have matching attributes (instance type, platform, and - // Availability Zone). Instances that have matching attributes run in the Capacity - // Reservation automatically without specifying any additional parameters. - // - // * - // targeted - The Capacity Reservation only accepts instances that have matching - // attributes (instance type, platform, and Availability Zone), and explicitly - // target the Capacity Reservation. This ensures that only permitted instances can - // use the reserved capacity. - // + // - open - The Capacity Reservation automatically matches all instances that + // have matching attributes (instance type, platform, and Availability Zone). + // Instances that have matching attributes run in the Capacity Reservation + // automatically without specifying any additional parameters. + // - targeted - The Capacity Reservation only accepts instances that have + // matching attributes (instance type, platform, and Availability Zone), and + // explicitly target the Capacity Reservation. This ensures that only permitted + // instances can use the reserved capacity. // Default: open InstanceMatchCriteria types.InstanceMatchCriteria @@ -139,11 +129,10 @@ type CreateCapacityReservationInput struct { // Reservation. OutpostArn *string - // The Amazon Resource Name (ARN) of the cluster placement group in which to create - // the Capacity Reservation. For more information, see Capacity Reservations for - // cluster placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the Amazon - // EC2 User Guide. + // The Amazon Resource Name (ARN) of the cluster placement group in which to + // create the Capacity Reservation. For more information, see Capacity + // Reservations for cluster placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) + // in the Amazon EC2 User Guide. PlacementGroupArn *string // The tags to apply to the Capacity Reservation during launch. @@ -151,13 +140,10 @@ type CreateCapacityReservationInput struct { // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can // have one of the following tenancy settings: - // - // * default - The Capacity - // Reservation is created on hardware that is shared with other Amazon Web Services - // accounts. - // - // * dedicated - The Capacity Reservation is created on single-tenant - // hardware that is dedicated to a single Amazon Web Services account. + // - default - The Capacity Reservation is created on hardware that is shared + // with other Amazon Web Services accounts. + // - dedicated - The Capacity Reservation is created on single-tenant hardware + // that is dedicated to a single Amazon Web Services account. Tenancy types.CapacityReservationTenancy noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCapacityReservationFleet.go b/service/ec2/api_op_CreateCapacityReservationFleet.go index 57402356814..bc0eefcdef5 100644 --- a/service/ec2/api_op_CreateCapacityReservationFleet.go +++ b/service/ec2/api_op_CreateCapacityReservationFleet.go @@ -14,8 +14,7 @@ import ( ) // Creates a Capacity Reservation Fleet. For more information, see Create a -// Capacity Reservation Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet) +// Capacity Reservation Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet) // in the Amazon EC2 User Guide. func (c *Client) CreateCapacityReservationFleet(ctx context.Context, params *CreateCapacityReservationFleetInput, optFns ...func(*Options)) (*CreateCapacityReservationFleetOutput, error) { if params == nil { @@ -43,8 +42,7 @@ type CreateCapacityReservationFleetInput struct { // Fleet. This value, together with the instance type weights that you assign to // each instance type used by the Fleet determine the number of instances for which // the Fleet reserves capacity. Both values are based on units that make sense for - // your workload. For more information, see Total target capacity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) + // your workload. For more information, see Total target capacity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) // in the Amazon EC2 User Guide. // // This member is required. @@ -52,28 +50,27 @@ type CreateCapacityReservationFleetInput struct { // The strategy used by the Capacity Reservation Fleet to determine which of the // specified instance types to use. Currently, only the prioritized allocation - // strategy is supported. For more information, see Allocation strategy - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) + // strategy is supported. For more information, see Allocation strategy (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) // in the Amazon EC2 User Guide. Valid values: prioritized AllocationStrategy *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The date and time at which the Capacity Reservation Fleet expires. When the // Capacity Reservation Fleet expires, its state changes to expired and all of the // Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet // expires within an hour after the specified time. For example, if you specify - // 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire - // between 13:30:55 and 14:30:55 on 5/31/2019. + // 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire + // between 13:30:55 and 14:30:55 on 5/31/2019 . EndDate *time.Time // Indicates the type of instance launches that the Capacity Reservation Fleet @@ -85,21 +82,17 @@ type CreateCapacityReservationFleetInput struct { // Fleet to use its reserved capacity. InstanceMatchCriteria types.FleetInstanceMatchCriteria - // The tags to assign to the Capacity Reservation Fleet. The tags are automatically - // assigned to the Capacity Reservations in the Fleet. + // The tags to assign to the Capacity Reservation Fleet. The tags are + // automatically assigned to the Capacity Reservations in the Fleet. TagSpecifications []types.TagSpecification // Indicates the tenancy of the Capacity Reservation Fleet. All Capacity // Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet // can have one of the following tenancy settings: - // - // * default - The Capacity - // Reservation Fleet is created on hardware that is shared with other Amazon Web - // Services accounts. - // - // * dedicated - The Capacity Reservations are created on - // single-tenant hardware that is dedicated to a single Amazon Web Services - // account. + // - default - The Capacity Reservation Fleet is created on hardware that is + // shared with other Amazon Web Services accounts. + // - dedicated - The Capacity Reservations are created on single-tenant hardware + // that is dedicated to a single Amazon Web Services account. Tenancy types.FleetCapacityReservationTenancy noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCarrierGateway.go b/service/ec2/api_op_CreateCarrierGateway.go index d8e4045fbc4..a120c065676 100644 --- a/service/ec2/api_op_CreateCarrierGateway.go +++ b/service/ec2/api_op_CreateCarrierGateway.go @@ -13,8 +13,7 @@ import ( ) // Creates a carrier gateway. For more information about carrier gateways, see -// Carrier gateways -// (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) +// Carrier gateways (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) // in the Amazon Web Services Wavelength Developer Guide. func (c *Client) CreateCarrierGateway(ctx context.Context, params *CreateCarrierGatewayInput, optFns ...func(*Options)) (*CreateCarrierGatewayOutput, error) { if params == nil { @@ -39,14 +38,14 @@ type CreateCarrierGatewayInput struct { VpcId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to associate with the carrier gateway. diff --git a/service/ec2/api_op_CreateClientVpnEndpoint.go b/service/ec2/api_op_CreateClientVpnEndpoint.go index dee56a13178..529d67ebb44 100644 --- a/service/ec2/api_op_CreateClientVpnEndpoint.go +++ b/service/ec2/api_op_CreateClientVpnEndpoint.go @@ -50,23 +50,16 @@ type CreateClientVpnEndpointInput struct { // Information about the client connection logging options. If you enable client // connection logging, data about client connections is sent to a Cloudwatch Logs // log stream. The following information is logged: - // - // * Client connection - // requests - // - // * Client connection results (successful and unsuccessful) - // - // * Reasons - // for unsuccessful client connection requests - // - // * Client connection termination - // time + // - Client connection requests + // - Client connection results (successful and unsuccessful) + // - Reasons for unsuccessful client connection requests + // - Client connection termination time // // This member is required. ConnectionLogOptions *types.ConnectionLogOptions // The ARN of the server certificate. For more information, see the Certificate - // Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/). + // Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/) . // // This member is required. ServerCertificateArn *string @@ -74,13 +67,13 @@ type CreateClientVpnEndpointInput struct { // The options for managing connection authorization for new client connections. ClientConnectOptions *types.ClientConnectOptions - // Options for enabling a customizable text banner that will be displayed on Amazon - // Web Services provided clients when a VPN session is established. + // Options for enabling a customizable text banner that will be displayed on + // Amazon Web Services provided clients when a VPN session is established. ClientLoginBannerOptions *types.ClientLoginBannerOptions // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A brief description of the Client VPN endpoint. @@ -93,8 +86,8 @@ type CreateClientVpnEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of one or more security groups to apply to the target network. You must @@ -111,8 +104,7 @@ type CreateClientVpnEndpointInput struct { // Indicates whether split-tunnel is enabled on the Client VPN endpoint. By // default, split-tunnel on a VPN endpoint is disabled. For information about - // split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint - // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) + // split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) // in the Client VPN Administrator Guide. SplitTunnel *bool diff --git a/service/ec2/api_op_CreateClientVpnRoute.go b/service/ec2/api_op_CreateClientVpnRoute.go index f933eeea685..851cbd441ea 100644 --- a/service/ec2/api_op_CreateClientVpnRoute.go +++ b/service/ec2/api_op_CreateClientVpnRoute.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has -// a route table that describes the available destination network routes. Each +// Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint +// has a route table that describes the available destination network routes. Each // route in the route table specifies the path for traffic to specific resources or // networks. func (c *Client) CreateClientVpnRoute(ctx context.Context, params *CreateClientVpnRouteInput, optFns ...func(*Options)) (*CreateClientVpnRouteOutput, error) { @@ -40,32 +40,25 @@ type CreateClientVpnRouteInput struct { // The IPv4 address range, in CIDR notation, of the route destination. For // example: - // - // * To add a route for Internet access, enter 0.0.0.0/0 - // - // * To add a - // route for a peered VPC, enter the peered VPC's IPv4 CIDR range - // - // * To add a route - // for an on-premises network, enter the Amazon Web Services Site-to-Site VPN - // connection's IPv4 CIDR range - // - // * To add a route for the local network, enter the - // client CIDR range + // - To add a route for Internet access, enter 0.0.0.0/0 + // - To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range + // - To add a route for an on-premises network, enter the Amazon Web Services + // Site-to-Site VPN connection's IPv4 CIDR range + // - To add a route for the local network, enter the client CIDR range // // This member is required. DestinationCidrBlock *string // The ID of the subnet through which you want to route traffic. The specified // subnet must be an existing target network of the Client VPN endpoint. - // Alternatively, if you're adding a route for the local network, specify local. + // Alternatively, if you're adding a route for the local network, specify local . // // This member is required. TargetVpcSubnetId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A brief description of the route. @@ -73,8 +66,8 @@ type CreateClientVpnRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCoipCidr.go b/service/ec2/api_op_CreateCoipCidr.go index 5f14ab657f2..e9423842bb0 100644 --- a/service/ec2/api_op_CreateCoipCidr.go +++ b/service/ec2/api_op_CreateCoipCidr.go @@ -41,8 +41,8 @@ type CreateCoipCidrInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCoipPool.go b/service/ec2/api_op_CreateCoipPool.go index 7a19cf1fd21..0855f6bb107 100644 --- a/service/ec2/api_op_CreateCoipPool.go +++ b/service/ec2/api_op_CreateCoipPool.go @@ -36,8 +36,8 @@ type CreateCoipPoolInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the CoIP address pool. diff --git a/service/ec2/api_op_CreateCustomerGateway.go b/service/ec2/api_op_CreateCustomerGateway.go index f0a3da9823f..f935f3e86cc 100644 --- a/service/ec2/api_op_CreateCustomerGateway.go +++ b/service/ec2/api_op_CreateCustomerGateway.go @@ -19,12 +19,12 @@ import ( // (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You // can use an existing ASN assigned to your network. If you don't have an ASN // already, you can use a private ASN. For more information, see Customer gateway -// options for your Site-to-Site VPN connection -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html) in the Amazon -// Web Services Site-to-Site VPN User Guide. To create more than one customer -// gateway with the same VPN type, IP address, and BGP ASN, specify a unique device -// name for each customer gateway. An identical request returns information about -// the existing customer gateway; it doesn't create a new customer gateway. +// options for your Site-to-Site VPN connection (https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. To create more than one +// customer gateway with the same VPN type, IP address, and BGP ASN, specify a +// unique device name for each customer gateway. An identical request returns +// information about the existing customer gateway; it doesn't create a new +// customer gateway. func (c *Client) CreateCustomerGateway(ctx context.Context, params *CreateCustomerGatewayInput, optFns ...func(*Options)) (*CreateCustomerGatewayOutput, error) { if params == nil { params = &CreateCustomerGatewayInput{} @@ -43,7 +43,7 @@ func (c *Client) CreateCustomerGateway(ctx context.Context, params *CreateCustom // Contains the parameters for CreateCustomerGateway. type CreateCustomerGatewayInput struct { - // The type of VPN connection that this customer gateway supports (ipsec.1). + // The type of VPN connection that this customer gateway supports ( ipsec.1 ). // // This member is required. Type types.GatewayType @@ -60,8 +60,8 @@ type CreateCustomerGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // IPv4 address for the customer gateway device's outside interface. The address diff --git a/service/ec2/api_op_CreateDefaultSubnet.go b/service/ec2/api_op_CreateDefaultSubnet.go index 4beb579b833..25b326bfce0 100644 --- a/service/ec2/api_op_CreateDefaultSubnet.go +++ b/service/ec2/api_op_CreateDefaultSubnet.go @@ -13,8 +13,7 @@ import ( // Creates a default subnet with a size /20 IPv4 CIDR block in the specified // Availability Zone in your default VPC. You can have only one default subnet per -// Availability Zone. For more information, see Creating a default subnet -// (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet) +// Availability Zone. For more information, see Creating a default subnet (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateDefaultSubnet(ctx context.Context, params *CreateDefaultSubnetInput, optFns ...func(*Options)) (*CreateDefaultSubnetOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type CreateDefaultSubnetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether to create an IPv6 only subnet. If you already have a default diff --git a/service/ec2/api_op_CreateDefaultVpc.go b/service/ec2/api_op_CreateDefaultVpc.go index 371118e505b..2998ad0c4b8 100644 --- a/service/ec2/api_op_CreateDefaultVpc.go +++ b/service/ec2/api_op_CreateDefaultVpc.go @@ -13,20 +13,17 @@ import ( // Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in // each Availability Zone. For more information about the components of a default -// VPC, see Default VPC and default subnets -// (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) in the -// Amazon Virtual Private Cloud User Guide. You cannot specify the components of -// the default VPC yourself. If you deleted your previous default VPC, you can -// create a default VPC. You cannot have more than one default VPC per Region. If -// your account supports EC2-Classic, you cannot use this action to create a -// default VPC in a Region that supports EC2-Classic. If you want a default VPC in -// a Region that supports EC2-Classic, see "I really want a default VPC for my -// existing EC2 account. Is that possible?" in the Default VPCs FAQ -// (http://aws.amazon.com/vpc/faqs/#Default_VPCs). We are retiring EC2-Classic. We -// recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// VPC, see Default VPC and default subnets (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) +// in the Amazon Virtual Private Cloud User Guide. You cannot specify the +// components of the default VPC yourself. If you deleted your previous default +// VPC, you can create a default VPC. You cannot have more than one default VPC per +// Region. If your account supports EC2-Classic, you cannot use this action to +// create a default VPC in a Region that supports EC2-Classic. If you want a +// default VPC in a Region that supports EC2-Classic, see "I really want a default +// VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ (http://aws.amazon.com/vpc/faqs/#Default_VPCs) +// . We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateDefaultVpc(ctx context.Context, params *CreateDefaultVpcInput, optFns ...func(*Options)) (*CreateDefaultVpcOutput, error) { if params == nil { params = &CreateDefaultVpcInput{} @@ -46,8 +43,8 @@ type CreateDefaultVpcInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateDhcpOptions.go b/service/ec2/api_op_CreateDhcpOptions.go index d9bfb9bb855..9e161875ee4 100644 --- a/service/ec2/api_op_CreateDhcpOptions.go +++ b/service/ec2/api_op_CreateDhcpOptions.go @@ -15,46 +15,37 @@ import ( // associate it with the VPC, causing all existing and new instances that you // launch in the VPC to use this set of DHCP options. The following are the // individual DHCP options you can specify. For more information about the options, -// see RFC 2132 (http://www.ietf.org/rfc/rfc2132.txt). +// see RFC 2132 (http://www.ietf.org/rfc/rfc2132.txt) . +// - domain-name-servers - The IP addresses of up to four domain name servers, or +// AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If +// specifying more than one domain name server, specify the IP addresses in a +// single parameter, separated by commas. To have your instance receive a custom +// DNS hostname as specified in domain-name , you must set domain-name-servers to +// a custom DNS server. +// - domain-name - If you're using AmazonProvidedDNS in us-east-1 , specify +// ec2.internal . If you're using AmazonProvidedDNS in another Region, specify +// region.compute.internal (for example, ap-northeast-1.compute.internal ). +// Otherwise, specify a domain name (for example, ExampleCompany.com ). This +// value is used to complete unqualified DNS hostnames. Important: Some Linux +// operating systems accept multiple domain names separated by spaces. However, +// Windows and other Linux operating systems treat the value as a single domain, +// which results in unexpected behavior. If your DHCP options set is associated +// with a VPC that has instances with multiple operating systems, specify only one +// domain name. +// - ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) +// servers. +// - netbios-name-servers - The IP addresses of up to four NetBIOS name servers. +// - netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that +// you specify 2 (broadcast and multicast are not currently supported). For more +// information about these node types, see RFC 2132 (http://www.ietf.org/rfc/rfc2132.txt) +// . // -// * domain-name-servers - The -// IP addresses of up to four domain name servers, or AmazonProvidedDNS. The -// default DHCP option set specifies AmazonProvidedDNS. If specifying more than one -// domain name server, specify the IP addresses in a single parameter, separated by -// commas. To have your instance receive a custom DNS hostname as specified in -// domain-name, you must set domain-name-servers to a custom DNS server. -// -// * -// domain-name - If you're using AmazonProvidedDNS in us-east-1, specify -// ec2.internal. If you're using AmazonProvidedDNS in another Region, specify -// region.compute.internal (for example, ap-northeast-1.compute.internal). -// Otherwise, specify a domain name (for example, ExampleCompany.com). This value -// is used to complete unqualified DNS hostnames. Important: Some Linux operating -// systems accept multiple domain names separated by spaces. However, Windows and -// other Linux operating systems treat the value as a single domain, which results -// in unexpected behavior. If your DHCP options set is associated with a VPC that -// has instances with multiple operating systems, specify only one domain name. -// -// * -// ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) -// servers. -// -// * netbios-name-servers - The IP addresses of up to four NetBIOS name -// servers. -// -// * netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We -// recommend that you specify 2 (broadcast and multicast are not currently -// supported). For more information about these node types, see RFC 2132 -// (http://www.ietf.org/rfc/rfc2132.txt). -// -// Your VPC automatically starts out with a -// set of DHCP options that includes only a DNS server that we provide -// (AmazonProvidedDNS). If you create a set of options, and if your VPC has an -// internet gateway, make sure to set the domain-name-servers option either to -// AmazonProvidedDNS or to a domain name server of your choice. For more -// information, see DHCP options sets -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the -// Amazon Virtual Private Cloud User Guide. +// Your VPC automatically starts out with a set of DHCP options that includes only +// a DNS server that we provide (AmazonProvidedDNS). If you create a set of +// options, and if your VPC has an internet gateway, make sure to set the +// domain-name-servers option either to AmazonProvidedDNS or to a domain name +// server of your choice. For more information, see DHCP options sets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateDhcpOptions(ctx context.Context, params *CreateDhcpOptionsInput, optFns ...func(*Options)) (*CreateDhcpOptionsOutput, error) { if params == nil { params = &CreateDhcpOptionsInput{} @@ -79,8 +70,8 @@ type CreateDhcpOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the DHCP option. diff --git a/service/ec2/api_op_CreateEgressOnlyInternetGateway.go b/service/ec2/api_op_CreateEgressOnlyInternetGateway.go index 9c494b7266f..2b2be1a46df 100644 --- a/service/ec2/api_op_CreateEgressOnlyInternetGateway.go +++ b/service/ec2/api_op_CreateEgressOnlyInternetGateway.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only -// internet gateway is used to enable outbound communication over IPv6 from -// instances in your VPC to the internet, and prevents hosts outside of your VPC -// from initiating an IPv6 connection with your instance. +// [IPv6 only] Creates an egress-only internet gateway for your VPC. An +// egress-only internet gateway is used to enable outbound communication over IPv6 +// from instances in your VPC to the internet, and prevents hosts outside of your +// VPC from initiating an IPv6 connection with your instance. func (c *Client) CreateEgressOnlyInternetGateway(ctx context.Context, params *CreateEgressOnlyInternetGatewayInput, optFns ...func(*Options)) (*CreateEgressOnlyInternetGatewayOutput, error) { if params == nil { params = &CreateEgressOnlyInternetGatewayInput{} @@ -38,14 +38,14 @@ type CreateEgressOnlyInternetGatewayInput struct { VpcId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the egress-only internet gateway. diff --git a/service/ec2/api_op_CreateFleet.go b/service/ec2/api_op_CreateFleet.go index a17fb26962b..c301df6ca77 100644 --- a/service/ec2/api_op_CreateFleet.go +++ b/service/ec2/api_op_CreateFleet.go @@ -14,9 +14,8 @@ import ( // Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple // launch specifications that vary by instance type, AMI, Availability Zone, or -// subnet. For more information, see EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the -// Amazon EC2 User Guide. +// subnet. For more information, see EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) +// in the Amazon EC2 User Guide. func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error) { if params == nil { params = &CreateFleetInput{} @@ -45,8 +44,8 @@ type CreateFleetInput struct { TargetCapacitySpecification *types.TargetCapacitySpecificationRequest // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Reserved. @@ -54,22 +53,21 @@ type CreateFleetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether running instances should be terminated if the total target // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - // Supported only for fleets of type maintain. + // Supported only for fleets of type maintain . ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy // Describes the configuration of On-Demand Instances in an EC2 Fleet. OnDemandOptions *types.OnDemandOptionsRequest // Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported - // only for fleets of type maintain. For more information, see EC2 Fleet health - // checks - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) + // only for fleets of type maintain . For more information, see EC2 Fleet health + // checks (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) // in the Amazon EC2 User Guide. ReplaceUnhealthyInstances *bool @@ -77,38 +75,31 @@ type CreateFleetInput struct { SpotOptions *types.SpotOptionsRequest // The key-value pair for tagging the EC2 Fleet request on creation. For more - // information, see Tagging your resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). - // If the fleet type is instant, specify a resource type of fleet to tag the fleet - // or instance to tag the instances at launch. If the fleet type is maintain or - // request, specify a resource type of fleet to tag the fleet. You cannot specify a - // resource type of instance. To tag instances at launch, specify the tags in a - // launch template - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template). + // information, see Tagging your resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) + // . If the fleet type is instant , specify a resource type of fleet to tag the + // fleet or instance to tag the instances at launch. If the fleet type is maintain + // or request , specify a resource type of fleet to tag the fleet. You cannot + // specify a resource type of instance . To tag instances at launch, specify the + // tags in a launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) + // . TagSpecifications []types.TagSpecification // Indicates whether running instances should be terminated when the EC2 Fleet // expires. TerminateInstancesWithExpiration *bool - // The fleet type. The default value is maintain. - // - // * maintain - The EC2 Fleet - // places an asynchronous request for your desired capacity, and continues to - // maintain your desired Spot capacity by replenishing interrupted Spot - // Instances. - // - // * request - The EC2 Fleet places an asynchronous one-time request - // for your desired capacity, but does submit Spot requests in alternative capacity - // pools if Spot capacity is unavailable, and does not maintain Spot capacity if - // Spot Instances are interrupted. - // - // * instant - The EC2 Fleet places a synchronous - // one-time request for your desired capacity, and returns errors for any instances - // that could not be launched. - // - // For more information, see EC2 Fleet request types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) + // The fleet type. The default value is maintain . + // - maintain - The EC2 Fleet places an asynchronous request for your desired + // capacity, and continues to maintain your desired Spot capacity by replenishing + // interrupted Spot Instances. + // - request - The EC2 Fleet places an asynchronous one-time request for your + // desired capacity, but does submit Spot requests in alternative capacity pools if + // Spot capacity is unavailable, and does not maintain Spot capacity if Spot + // Instances are interrupted. + // - instant - The EC2 Fleet places a synchronous one-time request for your + // desired capacity, and returns errors for any instances that could not be + // launched. + // For more information, see EC2 Fleet request types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) // in the Amazon EC2 User Guide. Type types.FleetType @@ -129,14 +120,14 @@ type CreateFleetInput struct { type CreateFleetOutput struct { // Information about the instances that could not be launched by the fleet. - // Supported only for fleets of type instant. + // Supported only for fleets of type instant . Errors []types.CreateFleetError // The ID of the EC2 Fleet. FleetId *string // Information about the instances that were launched by the fleet. Supported only - // for fleets of type instant. + // for fleets of type instant . Instances []types.CreateFleetInstance // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_CreateFlowLogs.go b/service/ec2/api_op_CreateFlowLogs.go index a4174af9120..c4e0a1c5d66 100644 --- a/service/ec2/api_op_CreateFlowLogs.go +++ b/service/ec2/api_op_CreateFlowLogs.go @@ -15,16 +15,14 @@ import ( // specific network interface, subnet, or VPC. Flow log data for a monitored // network interface is recorded as flow log records, which are log events // consisting of fields that describe the traffic flow. For more information, see -// Flow log records -// (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) +// Flow log records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) // in the Amazon Virtual Private Cloud User Guide. When publishing to CloudWatch // Logs, flow log records are published to a log group, and each network interface // has a unique log stream in the log group. When publishing to Amazon S3, flow log // records for all of the monitored network interfaces are published to a single // log file object that is stored in the specified bucket. For more information, -// see VPC Flow Logs -// (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) in the Amazon -// Virtual Private Cloud User Guide. +// see VPC Flow Logs (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateFlowLogs(ctx context.Context, params *CreateFlowLogsInput, optFns ...func(*Options)) (*CreateFlowLogsOutput, error) { if params == nil { params = &CreateFlowLogsInput{} @@ -42,7 +40,7 @@ func (c *Client) CreateFlowLogs(ctx context.Context, params *CreateFlowLogsInput type CreateFlowLogsInput struct { - // The IDs of the resources to monitor. For example, if the resource type is VPC, + // The IDs of the resources to monitor. For example, if the resource type is VPC , // specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway // resource types. Maximum of 1000 for the other resource types. // @@ -55,8 +53,8 @@ type CreateFlowLogsInput struct { ResourceType types.FlowLogsResourceType // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // The ARN of the IAM role that allows Amazon EC2 to publish flow logs across @@ -73,26 +71,22 @@ type CreateFlowLogsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The destination for the flow log data. The meaning of this parameter depends on // the destination type. - // - // * If the destination type is cloud-watch-logs, specify - // the ARN of a CloudWatch Logs log group. For example: - // arn:aws:logs:region:account_id:log-group:my_group Alternatively, use the - // LogGroupName parameter. - // - // * If the destination type is s3, specify the ARN of an - // S3 bucket. For example: arn:aws:s3:::my_bucket/my_subfolder/ The subfolder is - // optional. Note that you can't use AWSLogs as a subfolder name. - // - // * If the - // destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data - // Firehose delivery stream. For example: - // arn:aws:firehose:region:account_id:deliverystream:my_stream + // - If the destination type is cloud-watch-logs , specify the ARN of a + // CloudWatch Logs log group. For example: + // arn:aws:logs:region:account_id:log-group:my_group Alternatively, use the + // LogGroupName parameter. + // - If the destination type is s3 , specify the ARN of an S3 bucket. For + // example: arn:aws:s3:::my_bucket/my_subfolder/ The subfolder is optional. Note + // that you can't use AWSLogs as a subfolder name. + // - If the destination type is kinesis-data-firehose , specify the ARN of a + // Kinesis Data Firehose delivery stream. For example: + // arn:aws:firehose:region:account_id:deliverystream:my_stream LogDestination *string // The type of destination for the flow log data. Default: cloud-watch-logs @@ -102,10 +96,8 @@ type CreateFlowLogsInput struct { // which they should appear. If you omit this parameter, the flow log is created // using the default format. If you specify this parameter, you must include at // least one field. For more information about the available fields, see Flow log - // records - // (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) - // in the Amazon VPC User Guide or Transit Gateway Flow Log records - // (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) + // records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records) + // in the Amazon VPC User Guide or Transit Gateway Flow Log records (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) // in the Amazon Web Services Transit Gateway Guide. Specify the fields using the // ${field-id} format, separated by spaces. For the CLI, surround this parameter // value with single quotes on Linux or double quotes on Windows. @@ -113,16 +105,15 @@ type CreateFlowLogsInput struct { // The name of a new or existing CloudWatch Logs log group where Amazon EC2 // publishes your flow logs. This parameter is valid only if the destination type - // is cloud-watch-logs. + // is cloud-watch-logs . LogGroupName *string // The maximum interval of time during which a flow of packets is captured and // aggregated into a flow log record. The possible values are 60 seconds (1 minute) // or 600 seconds (10 minutes). This parameter must be 60 seconds for transit // gateway resource types. When a network interface is attached to a Nitro-based - // instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances), - // the aggregation interval is always 60 seconds or less, regardless of the value + // instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // , the aggregation interval is always 60 seconds or less, regardless of the value // that you specify. Default: 600 MaxAggregationInterval *int32 diff --git a/service/ec2/api_op_CreateFpgaImage.go b/service/ec2/api_op_CreateFpgaImage.go index 4e30e638479..229dea10080 100644 --- a/service/ec2/api_op_CreateFpgaImage.go +++ b/service/ec2/api_op_CreateFpgaImage.go @@ -16,7 +16,7 @@ import ( // check the output logs. An AFI contains the FPGA bitstream that is ready to // download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated // instances. For more information, see the Amazon Web Services FPGA Hardware -// Development Kit (https://github.com/aws/aws-fpga/). +// Development Kit (https://github.com/aws/aws-fpga/) . func (c *Client) CreateFpgaImage(ctx context.Context, params *CreateFpgaImageInput, optFns ...func(*Options)) (*CreateFpgaImageOutput, error) { if params == nil { params = &CreateFpgaImageInput{} @@ -41,8 +41,8 @@ type CreateFpgaImageInput struct { InputStorageLocation *types.StorageLocation // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the AFI. @@ -50,8 +50,8 @@ type CreateFpgaImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The location in Amazon S3 for the output logs. diff --git a/service/ec2/api_op_CreateImage.go b/service/ec2/api_op_CreateImage.go index c73737d2add..0fddbd041b9 100644 --- a/service/ec2/api_op_CreateImage.go +++ b/service/ec2/api_op_CreateImage.go @@ -24,8 +24,7 @@ import ( // addition to the root device volume, the new AMI contains block device mapping // information for those volumes. When you launch an instance from this new AMI, // the instance automatically launches with those additional volumes. For more -// information, see Create an Amazon EBS-backed Linux AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) +// information, see Create an Amazon EBS-backed Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error) { if params == nil { @@ -66,35 +65,31 @@ type CreateImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // By default, when Amazon EC2 creates the new AMI, it reboots the instance so that - // it can take snapshots of the attached volumes while data is at rest, in order to - // ensure a consistent state. You can set the NoReboot parameter to true in the API - // request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from - // shutting down and rebooting the instance. If you choose to bypass the shutdown - // and reboot process by setting the NoReboot parameter to true in the API request, - // or by using the --no-reboot option in the CLI, we can't guarantee the file - // system integrity of the created image. Default: false (follow standard reboot - // process) + // By default, when Amazon EC2 creates the new AMI, it reboots the instance so + // that it can take snapshots of the attached volumes while data is at rest, in + // order to ensure a consistent state. You can set the NoReboot parameter to true + // in the API request, or use the --no-reboot option in the CLI to prevent Amazon + // EC2 from shutting down and rebooting the instance. If you choose to bypass the + // shutdown and reboot process by setting the NoReboot parameter to true in the + // API request, or by using the --no-reboot option in the CLI, we can't guarantee + // the file system integrity of the created image. Default: false (follow standard + // reboot process) NoReboot *bool - // The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the - // snapshots, or both. - // - // * To tag the AMI, the value for ResourceType must be - // image. - // - // * To tag the snapshots that are created of the root volume and of other - // Amazon EBS volumes that are attached to the instance, the value for ResourceType - // must be snapshot. The same tag is applied to all of the snapshots that are - // created. - // - // If you specify other values for ResourceType, the request fails. To - // tag an AMI or snapshot after it has been created, see CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // The tags to apply to the AMI and snapshots on creation. You can tag the AMI, + // the snapshots, or both. + // - To tag the AMI, the value for ResourceType must be image . + // - To tag the snapshots that are created of the root volume and of other + // Amazon EBS volumes that are attached to the instance, the value for + // ResourceType must be snapshot . The same tag is applied to all of the + // snapshots that are created. + // If you specify other values for ResourceType , the request fails. To tag an AMI + // or snapshot after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) + // . TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateInstanceEventWindow.go b/service/ec2/api_op_CreateInstanceEventWindow.go index 9d0e1d63aac..8b139ad67e6 100644 --- a/service/ec2/api_op_CreateInstanceEventWindow.go +++ b/service/ec2/api_op_CreateInstanceEventWindow.go @@ -21,16 +21,11 @@ import ( // AssociateInstanceEventWindow API. Event windows are applicable only for // scheduled events that stop, reboot, or terminate instances. Event windows are // not applicable for: +// - Expedited scheduled events and network maintenance events. +// - Unscheduled maintenance such as AutoRecovery and unplanned reboots. // -// * Expedited scheduled events and network maintenance -// events. -// -// * Unscheduled maintenance such as AutoRecovery and unplanned -// reboots. -// -// For more information, see Define event windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// For more information, see Define event windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) CreateInstanceEventWindow(ctx context.Context, params *CreateInstanceEventWindowInput, optFns ...func(*Options)) (*CreateInstanceEventWindowOutput, error) { if params == nil { params = &CreateInstanceEventWindowInput{} @@ -48,36 +43,25 @@ func (c *Client) CreateInstanceEventWindow(ctx context.Context, params *CreateIn type CreateInstanceEventWindowInput struct { - // The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If + // The cron expression for the event window, for example, * 0-4,20-23 * * 1,5 . If // you specify a cron expression, you can't specify a time range. Constraints: - // - // * - // Only hour and day of the week values are supported. - // - // * For day of the week - // values, you can specify either integers 0 through 6, or alternative single - // values SUN through SAT. - // - // * The minute, month, and year must be specified by - // *. - // - // * The hour value must be one or a multiple range, for example, 0-4 or - // 0-4,20-23. - // - // * Each hour range must be >= 2 hours, for example, 0-2 or 20-23. - // - // * - // The event window must be >= 4 hours. The combined total time ranges in the event - // window must be >= 4 hours. - // - // For more information about cron expressions, see - // cron (https://en.wikipedia.org/wiki/Cron) on the Wikipedia website. + // - Only hour and day of the week values are supported. + // - For day of the week values, you can specify either integers 0 through 6 , or + // alternative single values SUN through SAT . + // - The minute, month, and year must be specified by * . + // - The hour value must be one or a multiple range, for example, 0-4 or + // 0-4,20-23 . + // - Each hour range must be >= 2 hours, for example, 0-2 or 20-23 . + // - The event window must be >= 4 hours. The combined total time ranges in the + // event window must be >= 4 hours. + // For more information about cron expressions, see cron (https://en.wikipedia.org/wiki/Cron) + // on the Wikipedia website. CronExpression *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name of the event window. diff --git a/service/ec2/api_op_CreateInstanceExportTask.go b/service/ec2/api_op_CreateInstanceExportTask.go index 70005555f55..9dfd3912434 100644 --- a/service/ec2/api_op_CreateInstanceExportTask.go +++ b/service/ec2/api_op_CreateInstanceExportTask.go @@ -14,9 +14,8 @@ import ( // Exports a running or stopped instance to an Amazon S3 bucket. For information // about the supported operating systems, image formats, and known limitations for // the types of instances you can export, see Exporting an instance as a VM Using -// VM Import/Export -// (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html) in the VM -// Import/Export User Guide. +// VM Import/Export (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html) +// in the VM Import/Export User Guide. func (c *Client) CreateInstanceExportTask(ctx context.Context, params *CreateInstanceExportTaskInput, optFns ...func(*Options)) (*CreateInstanceExportTaskOutput, error) { if params == nil { params = &CreateInstanceExportTaskInput{} diff --git a/service/ec2/api_op_CreateInternetGateway.go b/service/ec2/api_op_CreateInternetGateway.go index 72c253c60b2..e821a9b0df5 100644 --- a/service/ec2/api_op_CreateInternetGateway.go +++ b/service/ec2/api_op_CreateInternetGateway.go @@ -12,9 +12,9 @@ import ( ) // Creates an internet gateway for use with a VPC. After creating the internet -// gateway, you attach it to a VPC using AttachInternetGateway. For more +// gateway, you attach it to a VPC using AttachInternetGateway . For more // information about your VPC and internet gateway, see the Amazon Virtual Private -// Cloud User Guide (https://docs.aws.amazon.com/vpc/latest/userguide/). +// Cloud User Guide (https://docs.aws.amazon.com/vpc/latest/userguide/) . func (c *Client) CreateInternetGateway(ctx context.Context, params *CreateInternetGatewayInput, optFns ...func(*Options)) (*CreateInternetGatewayOutput, error) { if params == nil { params = &CreateInternetGatewayInput{} @@ -34,8 +34,8 @@ type CreateInternetGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the internet gateway. diff --git a/service/ec2/api_op_CreateIpam.go b/service/ec2/api_op_CreateIpam.go index 014c6470ce9..1b709104cd7 100644 --- a/service/ec2/api_op_CreateIpam.go +++ b/service/ec2/api_op_CreateIpam.go @@ -16,9 +16,8 @@ import ( // can use to automate your IP address management workflows including assigning, // tracking, troubleshooting, and auditing IP addresses across Amazon Web Services // Regions and accounts throughout your Amazon Web Services Organization. For more -// information, see Create an IPAM -// (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the Amazon VPC -// IPAM User Guide. +// information, see Create an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) CreateIpam(ctx context.Context, params *CreateIpamInput, optFns ...func(*Options)) (*CreateIpamOutput, error) { if params == nil { params = &CreateIpamInput{} @@ -37,8 +36,8 @@ func (c *Client) CreateIpam(ctx context.Context, params *CreateIpamInput, optFns type CreateIpamInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the IPAM. @@ -46,8 +45,8 @@ type CreateIpamInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The operating Regions for the IPAM. Operating Regions are Amazon Web Services @@ -60,7 +59,7 @@ type CreateIpamInput struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateIpamPool.go b/service/ec2/api_op_CreateIpamPool.go index 51e5bfe0e0f..3be7467abfa 100644 --- a/service/ec2/api_op_CreateIpamPool.go +++ b/service/ec2/api_op_CreateIpamPool.go @@ -17,9 +17,8 @@ import ( // organize your IP addresses according to your routing and security needs. For // example, if you have separate routing and security needs for development and // production applications, you can create a pool for each. For more information, -// see Create a top-level pool -// (https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) in the Amazon -// VPC IPAM User Guide. +// see Create a top-level pool (https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) CreateIpamPool(ctx context.Context, params *CreateIpamPoolInput, optFns ...func(*Options)) (*CreateIpamPoolOutput, error) { if params == nil { params = &CreateIpamPoolInput{} @@ -53,14 +52,14 @@ type CreateIpamPoolInput struct { // allocations will default to 10.0.0.0/16. AllocationDefaultNetmaskLength *int32 - // The maximum netmask length possible for CIDR allocations in this IPAM pool to be - // compliant. The maximum netmask length must be greater than the minimum netmask - // length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask - // lengths for IPv6 addresses are 0 - 128. + // The maximum netmask length possible for CIDR allocations in this IPAM pool to + // be compliant. The maximum netmask length must be greater than the minimum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. AllocationMaxNetmaskLength *int32 - // The minimum netmask length required for CIDR allocations in this IPAM pool to be - // compliant. The minimum netmask length must be less than the maximum netmask + // The minimum netmask length required for CIDR allocations in this IPAM pool to + // be compliant. The minimum netmask length must be less than the maximum netmask // length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask // lengths for IPv6 addresses are 0 - 128. AllocationMinNetmaskLength *int32 @@ -83,13 +82,13 @@ type CreateIpamPoolInput struct { // them only. A locale must be set on the pool for this feature to work. AutoImport *bool - // Limits which service in Amazon Web Services that the pool can be used in. "ec2", - // for example, allows users to use space for Elastic IP addresses and VPCs. + // Limits which service in Amazon Web Services that the pool can be used in. + // "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. AwsService types.IpamPoolAwsService // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the IPAM pool. @@ -97,8 +96,8 @@ type CreateIpamPoolInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // In IPAM, the locale is the Amazon Web Services Region where you want to make an @@ -112,18 +111,17 @@ type CreateIpamPoolInput struct { Locale *string // The IP address source for pools in the public scope. Only used for provisioning - // IP address CIDRs to pools in the public scope. Default is byoip. For more - // information, see Create IPv6 pools - // (https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in - // the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided - // IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For - // information on increasing the default limit, see Quotas for your IPAM - // (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the Amazon VPC - // IPAM User Guide. + // IP address CIDRs to pools in the public scope. Default is byoip . For more + // information, see Create IPv6 pools (https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) + // in the Amazon VPC IPAM User Guide. By default, you can add only one + // Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is + // amazon . For information on increasing the default limit, see Quotas for your + // IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the + // Amazon VPC IPAM User Guide. PublicIpSource types.IpamPoolPublicIpSource // Determines if the pool is publicly advertisable. This option is not available - // for pools with AddressFamily set to ipv4. + // for pools with AddressFamily set to ipv4 . PubliclyAdvertisable *bool // The ID of the source IPAM pool. Use this option to create a pool within an @@ -133,7 +131,7 @@ type CreateIpamPoolInput struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateIpamResourceDiscovery.go b/service/ec2/api_op_CreateIpamResourceDiscovery.go index 80d4d4dcb59..9544851a913 100644 --- a/service/ec2/api_op_CreateIpamResourceDiscovery.go +++ b/service/ec2/api_op_CreateIpamResourceDiscovery.go @@ -40,8 +40,8 @@ type CreateIpamResourceDiscoveryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Operating Regions for the IPAM resource discovery. Operating Regions are Amazon diff --git a/service/ec2/api_op_CreateIpamScope.go b/service/ec2/api_op_CreateIpamScope.go index 45dae685246..7e50752a165 100644 --- a/service/ec2/api_op_CreateIpamScope.go +++ b/service/ec2/api_op_CreateIpamScope.go @@ -17,9 +17,8 @@ import ( // for a single network. The private scope is intended for all private IP address // space. The public scope is intended for all public IP address space. Scopes // enable you to reuse IP addresses across multiple unconnected networks without -// causing IP address overlap or conflict. For more information, see Add a scope -// (https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html) in the Amazon -// VPC IPAM User Guide. +// causing IP address overlap or conflict. For more information, see Add a scope (https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) CreateIpamScope(ctx context.Context, params *CreateIpamScopeInput, optFns ...func(*Options)) (*CreateIpamScopeOutput, error) { if params == nil { params = &CreateIpamScopeInput{} @@ -43,8 +42,8 @@ type CreateIpamScopeInput struct { IpamId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the scope you're creating. @@ -52,13 +51,13 @@ type CreateIpamScopeInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateKeyPair.go b/service/ec2/api_op_CreateKeyPair.go index 2ce74cb7db1..c9f89432e5c 100644 --- a/service/ec2/api_op_CreateKeyPair.go +++ b/service/ec2/api_op_CreateKeyPair.go @@ -19,10 +19,9 @@ import ( // Amazon EC2 returns an error. The key pair returned to you is available only in // the Amazon Web Services Region in which you create it. If you prefer, you can // create your own key pair using a third-party tool and upload it to any Region -// using ImportKeyPair. You can have up to 5,000 key pairs per Amazon Web Services -// Region. For more information, see Amazon EC2 key pairs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the -// Amazon Elastic Compute Cloud User Guide. +// using ImportKeyPair . You can have up to 5,000 key pairs per Amazon Web Services +// Region. For more information, see Amazon EC2 key pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, optFns ...func(*Options)) (*CreateKeyPairOutput, error) { if params == nil { params = &CreateKeyPairInput{} @@ -47,8 +46,8 @@ type CreateKeyPairInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The format of the key pair. Default: pem @@ -67,11 +66,10 @@ type CreateKeyPairInput struct { // Describes a key pair. type CreateKeyPairOutput struct { - // * For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded - // private key. - // - // * For ED25519 key pairs, the key fingerprint is the base64-encoded - // SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. + // - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER + // encoded private key. + // - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 + // digest, which is the default for OpenSSH, starting with OpenSSH 6.8. KeyFingerprint *string // An unencrypted PEM encoded RSA or ED25519 private key. diff --git a/service/ec2/api_op_CreateLaunchTemplate.go b/service/ec2/api_op_CreateLaunchTemplate.go index f66c97cfa9c..107dee1b3c0 100644 --- a/service/ec2/api_op_CreateLaunchTemplate.go +++ b/service/ec2/api_op_CreateLaunchTemplate.go @@ -12,16 +12,14 @@ import ( ) // Creates a launch template. A launch template contains the parameters to launch -// an instance. When you launch an instance using RunInstances, you can specify a +// an instance. When you launch an instance using RunInstances , you can specify a // launch template instead of providing the launch parameters in the request. For -// more information, see Launch an instance from a launch template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// more information, see Launch an instance from a launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) // in the Amazon Elastic Compute Cloud User Guide. If you want to clone an existing // launch template as the basis for creating a new launch template, you can use the // Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. // For more information, see Create a launch template from an existing launch -// template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template) +// template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template-from-existing-launch-template) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateLaunchTemplate(ctx context.Context, params *CreateLaunchTemplateInput, optFns ...func(*Options)) (*CreateLaunchTemplateOutput, error) { if params == nil { @@ -51,22 +49,20 @@ type CreateLaunchTemplateInput struct { LaunchTemplateName *string // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraint: Maximum 128 ASCII characters. ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the launch template on creation. To tag the launch - // template, the resource type must be launch-template. To specify the tags for the - // resources that are created when an instance is launched, you must use the - // TagSpecifications parameter in the launch template data - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) + // template, the resource type must be launch-template . To specify the tags for + // the resources that are created when an instance is launched, you must use the + // TagSpecifications parameter in the launch template data (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) // structure. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateLaunchTemplateVersion.go b/service/ec2/api_op_CreateLaunchTemplateVersion.go index ba5bfb84f2f..f94c04fcb9d 100644 --- a/service/ec2/api_op_CreateLaunchTemplateVersion.go +++ b/service/ec2/api_op_CreateLaunchTemplateVersion.go @@ -18,8 +18,7 @@ import ( // immutable; after you create a launch template, you can't modify it. Instead, you // can create a new version of the launch template that includes any changes you // require. For more information, see Modify a launch template (manage launch -// template versions) -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions) +// template versions) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateLaunchTemplateVersion(ctx context.Context, params *CreateLaunchTemplateVersionInput, optFns ...func(*Options)) (*CreateLaunchTemplateVersionOutput, error) { if params == nil { @@ -44,37 +43,35 @@ type CreateLaunchTemplateVersionInput struct { LaunchTemplateData *types.RequestLaunchTemplateData // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraint: Maximum 128 ASCII characters. ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the launch template. You must specify either the LaunchTemplateId or - // the LaunchTemplateName, but not both. + // the LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId, but not both. + // LaunchTemplateId , but not both. LaunchTemplateName *string - // If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID - // is displayed in the response for imageID. For more information, see Use a - // Systems Manager parameter instead of an AMI ID - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) + // If true , and if a Systems Manager parameter is specified for ImageId , the AMI + // ID is displayed in the response for imageID . For more information, see Use a + // Systems Manager parameter instead of an AMI ID (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) // in the Amazon Elastic Compute Cloud User Guide. Default: false ResolveAlias *bool // The version number of the launch template version on which to base the new // version. The new version inherits the same launch parameters as the source - // version, except for parameters that you specify in LaunchTemplateData. Snapshots - // applied to the block device mapping are ignored when creating a new version - // unless they are explicitly included. + // version, except for parameters that you specify in LaunchTemplateData . + // Snapshots applied to the block device mapping are ignored when creating a new + // version unless they are explicitly included. SourceVersion *string // A description for the version of the launch template. diff --git a/service/ec2/api_op_CreateLocalGatewayRoute.go b/service/ec2/api_op_CreateLocalGatewayRoute.go index 2f006df6c35..ba052bbff0f 100644 --- a/service/ec2/api_op_CreateLocalGatewayRoute.go +++ b/service/ec2/api_op_CreateLocalGatewayRoute.go @@ -13,11 +13,8 @@ import ( // Creates a static route for the specified local gateway route table. You must // specify one of the following targets: -// -// * LocalGatewayVirtualInterfaceGroupId -// -// * -// NetworkInterfaceId +// - LocalGatewayVirtualInterfaceGroupId +// - NetworkInterfaceId func (c *Client) CreateLocalGatewayRoute(ctx context.Context, params *CreateLocalGatewayRouteInput, optFns ...func(*Options)) (*CreateLocalGatewayRouteOutput, error) { if params == nil { params = &CreateLocalGatewayRouteInput{} @@ -44,15 +41,15 @@ type CreateLocalGatewayRouteInput struct { // most specific match. DestinationCidrBlock *string - // The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. + // The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock . // You cannot use DestinationPrefixListId and DestinationCidrBlock in the same // request. DestinationPrefixListId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the virtual interface group. diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTable.go b/service/ec2/api_op_CreateLocalGatewayRouteTable.go index 3871eedf274..61374128dac 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTable.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTable.go @@ -36,8 +36,8 @@ type CreateLocalGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The mode of the local gateway route table. diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go b/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go index 023118104f5..7045800e4d1 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go @@ -41,8 +41,8 @@ type CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags assigned to the local gateway route table virtual interface group diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go b/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go index bad406ff26b..6c74fd89420 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTableVpcAssociation.go @@ -41,8 +41,8 @@ type CreateLocalGatewayRouteTableVpcAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the local gateway route table VPC association. diff --git a/service/ec2/api_op_CreateManagedPrefixList.go b/service/ec2/api_op_CreateManagedPrefixList.go index 30146305347..34b3c8c523c 100644 --- a/service/ec2/api_op_CreateManagedPrefixList.go +++ b/service/ec2/api_op_CreateManagedPrefixList.go @@ -42,21 +42,20 @@ type CreateManagedPrefixListInput struct { MaxEntries *int32 // A name for the prefix list. Constraints: Up to 255 characters in length. The - // name cannot start with com.amazonaws. + // name cannot start with com.amazonaws . // // This member is required. PrefixListName *string // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraints: Up to 255 UTF-8 characters in length. + // request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraints: Up to 255 UTF-8 characters in length. ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more entries for the prefix list. diff --git a/service/ec2/api_op_CreateNatGateway.go b/service/ec2/api_op_CreateNatGateway.go index dd281802364..e6a17f34abb 100644 --- a/service/ec2/api_op_CreateNatGateway.go +++ b/service/ec2/api_op_CreateNatGateway.go @@ -53,9 +53,8 @@ type CreateNatGatewayInput struct { AllocationId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 64 ASCII characters. + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraint: Maximum 64 ASCII characters. ClientToken *string // Indicates whether the NAT gateway supports public or private connectivity. The @@ -64,8 +63,8 @@ type CreateNatGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The private IPv4 address to assign to the NAT gateway. If you don't provide an @@ -73,21 +72,18 @@ type CreateNatGatewayInput struct { PrivateIpAddress *string // Secondary EIP allocation IDs. For more information about secondary addresses, - // see Create a NAT gateway - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) + // see Create a NAT gateway (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) // in the Amazon Virtual Private Cloud User Guide. SecondaryAllocationIds []string // [Private NAT gateway only] The number of secondary private IPv4 addresses you // want to assign to the NAT gateway. For more information about secondary - // addresses, see Create a NAT gateway - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) + // addresses, see Create a NAT gateway (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) // in the Amazon Virtual Private Cloud User Guide. SecondaryPrivateIpAddressCount *int32 // Secondary private IPv4 addresses. For more information about secondary - // addresses, see Create a NAT gateway - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) + // addresses, see Create a NAT gateway (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) // in the Amazon Virtual Private Cloud User Guide. SecondaryPrivateIpAddresses []string @@ -99,8 +95,8 @@ type CreateNatGatewayInput struct { type CreateNatGatewayOutput struct { - // Unique, case-sensitive identifier to ensure the idempotency of the request. Only - // returned if a client token was provided in the request. + // Unique, case-sensitive identifier to ensure the idempotency of the request. + // Only returned if a client token was provided in the request. ClientToken *string // Information about the NAT gateway. diff --git a/service/ec2/api_op_CreateNetworkAcl.go b/service/ec2/api_op_CreateNetworkAcl.go index a747a6f1711..d0792539566 100644 --- a/service/ec2/api_op_CreateNetworkAcl.go +++ b/service/ec2/api_op_CreateNetworkAcl.go @@ -13,9 +13,8 @@ import ( // Creates a network ACL in a VPC. Network ACLs provide an optional layer of // security (in addition to security groups) for the instances in your VPC. For -// more information, see Network ACLs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) in the Amazon -// Virtual Private Cloud User Guide. +// more information, see Network ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateNetworkAcl(ctx context.Context, params *CreateNetworkAclInput, optFns ...func(*Options)) (*CreateNetworkAclOutput, error) { if params == nil { params = &CreateNetworkAclInput{} @@ -40,8 +39,8 @@ type CreateNetworkAclInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the network ACL. diff --git a/service/ec2/api_op_CreateNetworkAclEntry.go b/service/ec2/api_op_CreateNetworkAclEntry.go index f64d2b884a0..c8e591d03c1 100644 --- a/service/ec2/api_op_CreateNetworkAclEntry.go +++ b/service/ec2/api_op_CreateNetworkAclEntry.go @@ -22,9 +22,8 @@ import ( // easier to add a rule between existing ones without having to renumber the rules. // After you add an entry, you can't modify it; you must either replace it, or // create an entry and delete the old one. For more information about network ACLs, -// see Network ACLs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) in the Amazon -// Virtual Private Cloud User Guide. +// see Network ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateNetworkAclEntry(ctx context.Context, params *CreateNetworkAclEntryInput, optFns ...func(*Options)) (*CreateNetworkAclEntryOutput, error) { if params == nil { params = &CreateNetworkAclEntryInput{} @@ -42,8 +41,8 @@ func (c *Client) CreateNetworkAclEntry(ctx context.Context, params *CreateNetwor type CreateNetworkAclEntryInput struct { - // Indicates whether this is an egress rule (rule is applied to traffic leaving the - // subnet). + // Indicates whether this is an egress rule (rule is applied to traffic leaving + // the subnet). // // This member is required. Egress *bool @@ -53,8 +52,8 @@ type CreateNetworkAclEntryInput struct { // This member is required. NetworkAclId *string - // The protocol number. A value of "-1" means all protocols. If you specify "-1" or - // a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on + // The protocol number. A value of "-1" means all protocols. If you specify "-1" + // or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on // all ports is allowed, regardless of any ports or ICMP types or codes that you // specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, // traffic for all ICMP types and codes allowed, regardless of any that you @@ -77,22 +76,22 @@ type CreateNetworkAclEntryInput struct { RuleNumber *int32 // The IPv4 network range to allow or deny, in CIDR notation (for example - // 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for - // example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. + // 172.16.0.0/24 ). We modify the specified CIDR block to its canonical form; for + // example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 . CidrBlock *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying + // protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. IcmpTypeCode *types.IcmpTypeCode // The IPv6 network range to allow or deny, in CIDR notation (for example - // 2001:db8:1234:1a00::/64). + // 2001:db8:1234:1a00::/64 ). Ipv6CidrBlock *string // TCP or UDP protocols: The range of ports the rule applies to. Required if diff --git a/service/ec2/api_op_CreateNetworkInsightsAccessScope.go b/service/ec2/api_op_CreateNetworkInsightsAccessScope.go index f1067366751..be27156472a 100644 --- a/service/ec2/api_op_CreateNetworkInsightsAccessScope.go +++ b/service/ec2/api_op_CreateNetworkInsightsAccessScope.go @@ -16,8 +16,8 @@ import ( // enables cloud networking and cloud operations teams to verify that their // networks on Amazon Web Services conform to their network security and governance // objectives. For more information, see the Amazon Web Services Network Access -// Analyzer Guide -// (https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/). +// Analyzer Guide (https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/) +// . func (c *Client) CreateNetworkInsightsAccessScope(ctx context.Context, params *CreateNetworkInsightsAccessScopeInput, optFns ...func(*Options)) (*CreateNetworkInsightsAccessScopeOutput, error) { if params == nil { params = &CreateNetworkInsightsAccessScopeInput{} @@ -36,16 +36,16 @@ func (c *Client) CreateNetworkInsightsAccessScope(ctx context.Context, params *C type CreateNetworkInsightsAccessScopeInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . // // This member is required. ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The paths to exclude. diff --git a/service/ec2/api_op_CreateNetworkInsightsPath.go b/service/ec2/api_op_CreateNetworkInsightsPath.go index 7bc1e28065d..7c7492a75b0 100644 --- a/service/ec2/api_op_CreateNetworkInsightsPath.go +++ b/service/ec2/api_op_CreateNetworkInsightsPath.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a path to analyze for reachability. Reachability Analyzer enables you to -// analyze and debug network reachability between two resources in your virtual -// private cloud (VPC). For more information, see the Reachability Analyzer Guide -// (https://docs.aws.amazon.com/vpc/latest/reachability/). +// Creates a path to analyze for reachability. Reachability Analyzer enables you +// to analyze and debug network reachability between two resources in your virtual +// private cloud (VPC). For more information, see the Reachability Analyzer Guide (https://docs.aws.amazon.com/vpc/latest/reachability/) +// . func (c *Client) CreateNetworkInsightsPath(ctx context.Context, params *CreateNetworkInsightsPathInput, optFns ...func(*Options)) (*CreateNetworkInsightsPathOutput, error) { if params == nil { params = &CreateNetworkInsightsPathInput{} @@ -34,8 +34,8 @@ func (c *Client) CreateNetworkInsightsPath(ctx context.Context, params *CreateNe type CreateNetworkInsightsPathInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . // // This member is required. ClientToken *string @@ -63,8 +63,8 @@ type CreateNetworkInsightsPathInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Scopes the analysis to network paths that match specific filters at the diff --git a/service/ec2/api_op_CreateNetworkInterface.go b/service/ec2/api_op_CreateNetworkInterface.go index 75babc412e7..6cea731ac97 100644 --- a/service/ec2/api_op_CreateNetworkInterface.go +++ b/service/ec2/api_op_CreateNetworkInterface.go @@ -14,12 +14,10 @@ import ( // Creates a network interface in the specified subnet. The number of IP addresses // you can assign to a network interface varies by instance type. For more -// information, see IP Addresses Per ENI Per Instance Type -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) +// information, see IP Addresses Per ENI Per Instance Type (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) // in the Amazon Virtual Private Cloud User Guide. For more information about -// network interfaces, see Elastic network interfaces -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the -// Amazon Elastic Compute Cloud User Guide. +// network interfaces, see Elastic network interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateNetworkInterface(ctx context.Context, params *CreateNetworkInterfaceInput, optFns ...func(*Options)) (*CreateNetworkInterfaceOutput, error) { if params == nil { params = &CreateNetworkInterfaceInput{} @@ -43,8 +41,8 @@ type CreateNetworkInterfaceInput struct { SubnetId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the network interface. @@ -52,15 +50,15 @@ type CreateNetworkInterfaceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of one or more security groups. Groups []string - // The type of network interface. The default is interface. The only supported - // values are efa and trunk. + // The type of network interface. The default is interface . The only supported + // values are efa and trunk . InterfaceType types.NetworkInterfaceCreationType // The number of IPv4 prefixes that Amazon Web Services automatically assigns to @@ -78,8 +76,8 @@ type CreateNetworkInterfaceInput struct { // automatically selects the IPv6 addresses from the subnet range. You can't // specify a count of IPv6 addresses using this parameter if you've specified one // of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of - // IPv6 prefixes. If your subnet has the AssignIpv6AddressOnCreation attribute set, - // you can override that setting by specifying 0 as the IPv6 address count. + // IPv6 prefixes. If your subnet has the AssignIpv6AddressOnCreation attribute + // set, you can override that setting by specifying 0 as the IPv6 address count. Ipv6AddressCount *int32 // The IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't @@ -111,13 +109,13 @@ type CreateNetworkInterfaceInput struct { // prefixes, or a count of IPv4 prefixes. PrivateIpAddresses []types.PrivateIpAddressSpecification - // The number of secondary private IPv4 addresses to assign to a network interface. - // When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these - // IP addresses within the subnet's IPv4 CIDR range. You can't specify this option - // and specify more than one private IP address using privateIpAddresses. You can't - // specify a count of private IPv4 addresses if you've specified one of the - // following: specific private IPv4 addresses, specific IPv4 prefixes, or a count - // of IPv4 prefixes. + // The number of secondary private IPv4 addresses to assign to a network + // interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 + // selects these IP addresses within the subnet's IPv4 CIDR range. You can't + // specify this option and specify more than one private IP address using + // privateIpAddresses . You can't specify a count of private IPv4 addresses if + // you've specified one of the following: specific private IPv4 addresses, specific + // IPv4 prefixes, or a count of IPv4 prefixes. SecondaryPrivateIpAddressCount *int32 // The tags to apply to the new network interface. diff --git a/service/ec2/api_op_CreateNetworkInterfacePermission.go b/service/ec2/api_op_CreateNetworkInterfacePermission.go index 0b3fb26bb6e..29119435dae 100644 --- a/service/ec2/api_op_CreateNetworkInterfacePermission.go +++ b/service/ec2/api_op_CreateNetworkInterfacePermission.go @@ -51,8 +51,8 @@ type CreateNetworkInterfacePermissionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreatePlacementGroup.go b/service/ec2/api_op_CreatePlacementGroup.go index 9b15be46953..173ee67cf0a 100644 --- a/service/ec2/api_op_CreatePlacementGroup.go +++ b/service/ec2/api_op_CreatePlacementGroup.go @@ -18,9 +18,8 @@ import ( // throughput. A spread placement group places instances on distinct hardware. A // partition placement group places groups of instances in different partitions, // where instances in one partition do not share the same hardware with instances -// in another partition. For more information, see Placement groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in -// the Amazon EC2 User Guide. +// in another partition. For more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) +// in the Amazon EC2 User Guide. func (c *Client) CreatePlacementGroup(ctx context.Context, params *CreatePlacementGroupInput, optFns ...func(*Options)) (*CreatePlacementGroupOutput, error) { if params == nil { params = &CreatePlacementGroupInput{} @@ -40,23 +39,20 @@ type CreatePlacementGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // A name for the placement group. Must be unique within the scope of your account // for the Region. Constraints: Up to 255 ASCII characters GroupName *string - // The number of partitions. Valid only when Strategy is set to partition. + // The number of partitions. Valid only when Strategy is set to partition . PartitionCount *int32 // Determines how placement groups spread instances. - // - // * Host – You can use host - // only with Outpost placement groups. - // - // * Rack – No usage restrictions. + // - Host – You can use host only with Outpost placement groups. + // - Rack – No usage restrictions. SpreadLevel types.SpreadLevel // The placement strategy. diff --git a/service/ec2/api_op_CreatePublicIpv4Pool.go b/service/ec2/api_op_CreatePublicIpv4Pool.go index f1ac0e52a4d..96cc1361f63 100644 --- a/service/ec2/api_op_CreatePublicIpv4Pool.go +++ b/service/ec2/api_op_CreatePublicIpv4Pool.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool -// required for the public IPv4 CIDRs that you own and bring to Amazon Web Services -// to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, -// use IPAM pools only. To monitor the status of pool creation, use -// DescribePublicIpv4Pools -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html). +// Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address +// pool required for the public IPv4 CIDRs that you own and bring to Amazon Web +// Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, +// however, use IPAM pools only. To monitor the status of pool creation, use +// DescribePublicIpv4Pools (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html) +// . func (c *Client) CreatePublicIpv4Pool(ctx context.Context, params *CreatePublicIpv4PoolInput, optFns ...func(*Options)) (*CreatePublicIpv4PoolOutput, error) { if params == nil { params = &CreatePublicIpv4PoolInput{} @@ -36,13 +36,13 @@ type CreatePublicIpv4PoolInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateReplaceRootVolumeTask.go b/service/ec2/api_op_CreateReplaceRootVolumeTask.go index 97adea9026f..737f52266da 100644 --- a/service/ec2/api_op_CreateReplaceRootVolumeTask.go +++ b/service/ec2/api_op_CreateReplaceRootVolumeTask.go @@ -16,9 +16,8 @@ import ( // that is restored to the original root volume's launch state, that is restored to // a specific snapshot taken from the original root volume, or that is restored // from an AMI that has the same key characteristics as that of the instance. For -// more information, see Replace a root volume -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) in the -// Amazon Elastic Compute Cloud User Guide. +// more information, see Replace a root volume (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateReplaceRootVolumeTask(ctx context.Context, params *CreateReplaceRootVolumeTaskInput, optFns ...func(*Options)) (*CreateReplaceRootVolumeTaskOutput, error) { if params == nil { params = &CreateReplaceRootVolumeTaskInput{} @@ -44,25 +43,25 @@ type CreateReplaceRootVolumeTaskInput struct { // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, a randomly generated token is // used for the request to ensure idempotency. For more information, see Ensuring - // idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Indicates whether to automatically delete the original root volume after the // root volume replacement task completes. To delete the original root volume, - // specify true. If you choose to keep the original root volume after the + // specify true . If you choose to keep the original root volume after the // replacement task completes, you must manually delete it when you no longer need // it. DeleteReplacedRootVolume *bool // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The ID of the AMI to use to restore the root volume. The specified AMI must have - // the same product code, billing information, architecture type, and + // The ID of the AMI to use to restore the root volume. The specified AMI must + // have the same product code, billing information, architecture type, and // virtualization type as that of the instance. If you want to restore the // replacement volume from a specific snapshot, or if you want to restore it to its // launch state, omit this parameter. diff --git a/service/ec2/api_op_CreateReservedInstancesListing.go b/service/ec2/api_op_CreateReservedInstancesListing.go index 38992252021..b25dd07a11d 100644 --- a/service/ec2/api_op_CreateReservedInstancesListing.go +++ b/service/ec2/api_op_CreateReservedInstancesListing.go @@ -27,9 +27,8 @@ import ( // for them. Your Standard Reserved Instance listings then become available for // purchase. To view the details of your Standard Reserved Instance listing, you // can use the DescribeReservedInstancesListings operation. For more information, -// see Reserved Instance Marketplace -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in -// the Amazon EC2 User Guide. +// see Reserved Instance Marketplace (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) +// in the Amazon EC2 User Guide. func (c *Client) CreateReservedInstancesListing(ctx context.Context, params *CreateReservedInstancesListingInput, optFns ...func(*Options)) (*CreateReservedInstancesListingOutput, error) { if params == nil { params = &CreateReservedInstancesListingInput{} @@ -50,8 +49,8 @@ type CreateReservedInstancesListingInput struct { // Unique, case-sensitive identifier you provide to ensure idempotency of your // listings. This helps avoid duplicate listings. For more information, see - // Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . // // This member is required. ClientToken *string diff --git a/service/ec2/api_op_CreateRestoreImageTask.go b/service/ec2/api_op_CreateRestoreImageTask.go index d8f658ea3cb..1a75ffa00bd 100644 --- a/service/ec2/api_op_CreateRestoreImageTask.go +++ b/service/ec2/api_op_CreateRestoreImageTask.go @@ -12,15 +12,12 @@ import ( ) // Starts a task that restores an AMI from an Amazon S3 object that was previously -// created by using CreateStoreImageTask -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html). -// To use this API, you must have the required permissions. For more information, -// see Permissions for storing and restoring AMIs using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) -// in the Amazon EC2 User Guide. For more information, see Store and restore an AMI -// using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in -// the Amazon EC2 User Guide. +// created by using CreateStoreImageTask (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html) +// . To use this API, you must have the required permissions. For more information, +// see Permissions for storing and restoring AMIs using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) +// in the Amazon EC2 User Guide. For more information, see Store and restore an +// AMI using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) +// in the Amazon EC2 User Guide. func (c *Client) CreateRestoreImageTask(ctx context.Context, params *CreateRestoreImageTaskInput, optFns ...func(*Options)) (*CreateRestoreImageTaskOutput, error) { if params == nil { params = &CreateRestoreImageTaskInput{} @@ -50,8 +47,8 @@ type CreateRestoreImageTaskInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name for the restored AMI. The name must be unique for AMIs in the Region @@ -61,12 +58,9 @@ type CreateRestoreImageTaskInput struct { // The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, // the snapshots, or both. - // - // * To tag the AMI, the value for ResourceType must be - // image. - // - // * To tag the snapshots, the value for ResourceType must be snapshot. The - // same tag is applied to all of the snapshots that are created. + // - To tag the AMI, the value for ResourceType must be image . + // - To tag the snapshots, the value for ResourceType must be snapshot . The same + // tag is applied to all of the snapshots that are created. TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateRoute.go b/service/ec2/api_op_CreateRoute.go index 2a7ab272b08..f36dd277e14 100644 --- a/service/ec2/api_op_CreateRoute.go +++ b/service/ec2/api_op_CreateRoute.go @@ -14,20 +14,16 @@ import ( // destination CIDR block or a prefix list ID. You must also specify exactly one of // the resources from the parameter list. When determining how to route traffic, we // use the route with the most specific match. For example, traffic is destined for -// the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 +// the IPv4 address 192.0.2.3 , and the route table includes the following two IPv4 // routes: +// - 192.0.2.0/24 (goes to some target A) +// - 192.0.2.0/28 (goes to some target B) // -// * 192.0.2.0/24 (goes to some target A) -// -// * 192.0.2.0/28 (goes to some -// target B) -// -// Both routes apply to the traffic destined for 192.0.2.3. However, the -// second route in the list covers a smaller number of IP addresses and is -// therefore more specific, so we use that route to determine where to target the -// traffic. For more information about route tables, see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// Both routes apply to the traffic destined for 192.0.2.3 . However, the second +// route in the list covers a smaller number of IP addresses and is therefore more +// specific, so we use that route to determine where to target the traffic. For +// more information about route tables, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error) { if params == nil { params = &CreateRouteInput{} @@ -59,8 +55,8 @@ type CreateRouteInput struct { // The IPv4 CIDR address block used for the destination match. Routing decisions // are based on the most specific match. We modify the specified CIDR block to its - // canonical form; for example, if you specify 100.68.0.18/18, we modify it to - // 100.68.0.0/18. + // canonical form; for example, if you specify 100.68.0.18/18 , we modify it to + // 100.68.0.0/18 . DestinationCidrBlock *string // The IPv6 CIDR block used for the destination match. Routing decisions are based @@ -72,8 +68,8 @@ type CreateRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // [IPv6 traffic only] The ID of an egress-only internet gateway. diff --git a/service/ec2/api_op_CreateRouteTable.go b/service/ec2/api_op_CreateRouteTable.go index b5439145427..46a16871134 100644 --- a/service/ec2/api_op_CreateRouteTable.go +++ b/service/ec2/api_op_CreateRouteTable.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a route table for the specified VPC. After you create a route table, you -// can add routes and associate the table with a subnet. For more information, see -// Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// Creates a route table for the specified VPC. After you create a route table, +// you can add routes and associate the table with a subnet. For more information, +// see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateRouteTable(ctx context.Context, params *CreateRouteTableInput, optFns ...func(*Options)) (*CreateRouteTableOutput, error) { if params == nil { params = &CreateRouteTableInput{} @@ -40,8 +39,8 @@ type CreateRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the route table. diff --git a/service/ec2/api_op_CreateSecurityGroup.go b/service/ec2/api_op_CreateSecurityGroup.go index e9597974aee..678b2f29c2d 100644 --- a/service/ec2/api_op_CreateSecurityGroup.go +++ b/service/ec2/api_op_CreateSecurityGroup.go @@ -13,10 +13,8 @@ import ( // Creates a security group. A security group acts as a virtual firewall for your // instance to control inbound and outbound traffic. For more information, see -// Amazon EC2 security groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) -// in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC -// (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) +// Amazon EC2 security groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) +// in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) // in the Amazon Virtual Private Cloud User Guide. When you create a security // group, you specify a friendly name of your choice. You can have a security group // for use in EC2-Classic with the same name as a security group for use in a VPC. @@ -27,15 +25,13 @@ import ( // instance, the instance is launched into the appropriate default security group. // A default security group includes a default rule that grants instances // unrestricted network access to each other. You can add or remove rules from your -// security groups using AuthorizeSecurityGroupIngress, -// AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and -// RevokeSecurityGroupEgress. For more information about VPC security group limits, -// see Amazon VPC Limits -// (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html). We -// are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// security groups using AuthorizeSecurityGroupIngress , +// AuthorizeSecurityGroupEgress , RevokeSecurityGroupIngress , and +// RevokeSecurityGroupEgress . For more information about VPC security group +// limits, see Amazon VPC Limits (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) +// . We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateSecurityGroup(ctx context.Context, params *CreateSecurityGroupInput, optFns ...func(*Options)) (*CreateSecurityGroupOutput, error) { if params == nil { params = &CreateSecurityGroupInput{} @@ -61,16 +57,16 @@ type CreateSecurityGroupInput struct { Description *string // The name of the security group. Constraints: Up to 255 characters in length. - // Cannot start with sg-. Constraints for EC2-Classic: ASCII characters Constraints - // for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // Cannot start with sg- . Constraints for EC2-Classic: ASCII characters + // Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* // // This member is required. GroupName *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the security group. diff --git a/service/ec2/api_op_CreateSnapshot.go b/service/ec2/api_op_CreateSnapshot.go index be832bf8bdd..d0890ad399a 100644 --- a/service/ec2/api_op_CreateSnapshot.go +++ b/service/ec2/api_op_CreateSnapshot.go @@ -29,20 +29,17 @@ import ( // cannot pause all file writes to the volume, you should unmount the volume from // within the instance, issue the snapshot command, and then remount the volume to // ensure a consistent and complete snapshot. You may remount and use your volume -// while the snapshot status is pending. When you create a snapshot for an EBS +// while the snapshot status is pending . When you create a snapshot for an EBS // volume that serves as a root device, we recommend that you stop the instance // before taking the snapshot. Snapshots that are taken from encrypted volumes are // automatically encrypted. Volumes that are created from encrypted snapshots are // also automatically encrypted. Your encrypted volumes and any associated // snapshots always remain protected. You can tag your snapshots during creation. -// For more information, see Tag your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon Elastic Compute Cloud User Guide. For more information, see Amazon -// Elastic Block Store -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) and Amazon -// EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// For more information, see Tag your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon Elastic Compute Cloud User Guide. For more information, see +// Amazon Elastic Block Store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html) +// and Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} @@ -70,28 +67,21 @@ type CreateSnapshotInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Resource Name (ARN) of the Outpost on which to create a local // snapshot. - // - // * To create a snapshot of a volume in a Region, omit this parameter. - // The snapshot is created in the same Region as the volume. - // - // * To create a - // snapshot of a volume on an Outpost and store the snapshot in the Region, omit - // this parameter. The snapshot is created in the Region for the Outpost. - // - // * To - // create a snapshot of a volume on an Outpost and store the snapshot on an - // Outpost, specify the ARN of the destination Outpost. The snapshot must be - // created on the same Outpost as the volume. - // - // For more information, see Create - // local snapshots from volumes on an Outpost - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-snapshot) + // - To create a snapshot of a volume in a Region, omit this parameter. The + // snapshot is created in the same Region as the volume. + // - To create a snapshot of a volume on an Outpost and store the snapshot in + // the Region, omit this parameter. The snapshot is created in the Region for the + // Outpost. + // - To create a snapshot of a volume on an Outpost and store the snapshot on an + // Outpost, specify the ARN of the destination Outpost. The snapshot must be + // created on the same Outpost as the volume. + // For more information, see Create local snapshots from volumes on an Outpost (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-snapshot) // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string @@ -109,7 +99,7 @@ type CreateSnapshotOutput struct { // the original volume or snapshot copy. Because data encryption keys are inherited // by volumes created from snapshots, and vice versa, if snapshots share the same // data encryption key identifier, then they belong to the same volume/snapshot - // lineage. This parameter is only returned by DescribeSnapshots. + // lineage. This parameter is only returned by DescribeSnapshots . DataEncryptionKeyId *string // The description for the snapshot. @@ -123,12 +113,11 @@ type CreateSnapshotOutput struct { KmsKeyId *string // The ARN of the Outpost on which the snapshot is stored. For more information, - // see Amazon EBS local snapshots on Outposts - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) in - // the Amazon Elastic Compute Cloud User Guide. + // see Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) + // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string - // The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). + // The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon ). // This is not the user-configured Amazon Web Services account alias set using the // IAM console. OwnerAlias *string @@ -157,7 +146,7 @@ type CreateSnapshotOutput struct { // operation fails (for example, if the proper Key Management Service (KMS) // permissions are not obtained) this field displays error state details to help // you diagnose why the error occurred. This parameter is only returned by - // DescribeSnapshots. + // DescribeSnapshots . StateMessage *string // The storage tier in which the snapshot is stored. standard indicates that the diff --git a/service/ec2/api_op_CreateSnapshots.go b/service/ec2/api_op_CreateSnapshots.go index f67be544249..6bc29858198 100644 --- a/service/ec2/api_op_CreateSnapshots.go +++ b/service/ec2/api_op_CreateSnapshots.go @@ -51,29 +51,22 @@ type CreateSnapshotsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Resource Name (ARN) of the Outpost on which to create the local // snapshots. - // - // * To create snapshots from an instance in a Region, omit this - // parameter. The snapshots are created in the same Region as the instance. - // - // * To - // create snapshots from an instance on an Outpost and store the snapshots in the - // Region, omit this parameter. The snapshots are created in the Region for the - // Outpost. - // - // * To create snapshots from an instance on an Outpost and store the - // snapshots on an Outpost, specify the ARN of the destination Outpost. The - // snapshots must be created on the same Outpost as the instance. - // - // For more - // information, see Create multi-volume local snapshots from instances on an - // Outpost - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-multivol-snapshot) + // - To create snapshots from an instance in a Region, omit this parameter. The + // snapshots are created in the same Region as the instance. + // - To create snapshots from an instance on an Outpost and store the snapshots + // in the Region, omit this parameter. The snapshots are created in the Region for + // the Outpost. + // - To create snapshots from an instance on an Outpost and store the snapshots + // on an Outpost, specify the ARN of the destination Outpost. The snapshots must be + // created on the same Outpost as the instance. + // For more information, see Create multi-volume local snapshots from instances + // on an Outpost (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-multivol-snapshot) // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string diff --git a/service/ec2/api_op_CreateSpotDatafeedSubscription.go b/service/ec2/api_op_CreateSpotDatafeedSubscription.go index 343a6eabb7c..ae7f5fa3214 100644 --- a/service/ec2/api_op_CreateSpotDatafeedSubscription.go +++ b/service/ec2/api_op_CreateSpotDatafeedSubscription.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a data feed for Spot Instances, enabling you to view Spot Instance usage -// logs. You can create one data feed per Amazon Web Services account. For more -// information, see Spot Instance data feed -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) in -// the Amazon EC2 User Guide for Linux Instances. +// Creates a data feed for Spot Instances, enabling you to view Spot Instance +// usage logs. You can create one data feed per Amazon Web Services account. For +// more information, see Spot Instance data feed (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) +// in the Amazon EC2 User Guide for Linux Instances. func (c *Client) CreateSpotDatafeedSubscription(ctx context.Context, params *CreateSpotDatafeedSubscriptionInput, optFns ...func(*Options)) (*CreateSpotDatafeedSubscriptionOutput, error) { if params == nil { params = &CreateSpotDatafeedSubscriptionInput{} @@ -35,8 +34,7 @@ func (c *Client) CreateSpotDatafeedSubscription(ctx context.Context, params *Cre type CreateSpotDatafeedSubscriptionInput struct { // The name of the Amazon S3 bucket in which to store the Spot Instance data feed. - // For more information about bucket names, see Rules for bucket naming - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) + // For more information about bucket names, see Rules for bucket naming (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) // in the Amazon S3 Developer Guide. // // This member is required. @@ -44,8 +42,8 @@ type CreateSpotDatafeedSubscriptionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The prefix for the data feed file names. diff --git a/service/ec2/api_op_CreateStoreImageTask.go b/service/ec2/api_op_CreateStoreImageTask.go index de796a8ee58..0e4707f9265 100644 --- a/service/ec2/api_op_CreateStoreImageTask.go +++ b/service/ec2/api_op_CreateStoreImageTask.go @@ -13,12 +13,10 @@ import ( // Stores an AMI as a single object in an Amazon S3 bucket. To use this API, you // must have the required permissions. For more information, see Permissions for -// storing and restoring AMIs using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) -// in the Amazon EC2 User Guide. For more information, see Store and restore an AMI -// using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in -// the Amazon EC2 User Guide. +// storing and restoring AMIs using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) +// in the Amazon EC2 User Guide. For more information, see Store and restore an +// AMI using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) +// in the Amazon EC2 User Guide. func (c *Client) CreateStoreImageTask(ctx context.Context, params *CreateStoreImageTaskInput, optFns ...func(*Options)) (*CreateStoreImageTaskOutput, error) { if params == nil { params = &CreateStoreImageTaskInput{} @@ -50,8 +48,8 @@ type CreateStoreImageTaskInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. diff --git a/service/ec2/api_op_CreateSubnet.go b/service/ec2/api_op_CreateSubnet.go index 2d121b64389..96c26fc3aaa 100644 --- a/service/ec2/api_op_CreateSubnet.go +++ b/service/ec2/api_op_CreateSubnet.go @@ -27,9 +27,8 @@ import ( // middle. When you stop an instance in a subnet, it retains its private IPv4 // address. It's therefore possible to have a subnet with no running instances // (they're all stopped), but no remaining IP addresses available. For more -// information, see Subnets -// (https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the -// Amazon Virtual Private Cloud User Guide. +// information, see Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateSubnet(ctx context.Context, params *CreateSubnetInput, optFns ...func(*Options)) (*CreateSubnetOutput, error) { if params == nil { params = &CreateSubnetInput{} @@ -52,13 +51,12 @@ type CreateSubnetInput struct { // This member is required. VpcId *string - // The Availability Zone or Local Zone for the subnet. Default: Amazon Web Services - // selects one for you. If you create more than one subnet in your VPC, we do not - // necessarily select a different zone for each subnet. To create a subnet in a - // Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. - // For information about the Regions that support Local Zones, see Available - // Regions - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions) + // The Availability Zone or Local Zone for the subnet. Default: Amazon Web + // Services selects one for you. If you create more than one subnet in your VPC, we + // do not necessarily select a different zone for each subnet. To create a subnet + // in a Local Zone, set this value to the Local Zone ID, for example + // us-west-2-lax-1a . For information about the Regions that support Local Zones, + // see Available Regions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions) // in the Amazon Elastic Compute Cloud User Guide. To create a subnet in an // Outpost, set this value to the Availability Zone for the Outpost and specify the // Outpost ARN. @@ -68,15 +66,15 @@ type CreateSubnetInput struct { AvailabilityZoneId *string // The IPv4 network range for the subnet, in CIDR notation. For example, - // 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for - // example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. This + // 10.0.0.0/24 . We modify the specified CIDR block to its canonical form; for + // example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 . This // parameter is not supported for an IPv6 only subnet. CidrBlock *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IPv6 network range for the subnet, in CIDR notation. The subnet size must diff --git a/service/ec2/api_op_CreateSubnetCidrReservation.go b/service/ec2/api_op_CreateSubnetCidrReservation.go index 6f44675010c..289cc395613 100644 --- a/service/ec2/api_op_CreateSubnetCidrReservation.go +++ b/service/ec2/api_op_CreateSubnetCidrReservation.go @@ -12,8 +12,7 @@ import ( ) // Creates a subnet CIDR reservation. For information about subnet CIDR -// reservations, see Subnet CIDR reservations -// (https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) +// reservations, see Subnet CIDR reservations (https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) CreateSubnetCidrReservation(ctx context.Context, params *CreateSubnetCidrReservationInput, optFns ...func(*Options)) (*CreateSubnetCidrReservationOutput, error) { if params == nil { @@ -38,16 +37,13 @@ type CreateSubnetCidrReservationInput struct { Cidr *string // The type of reservation. The following are valid values: - // - // * prefix: The Amazon - // EC2 Prefix Delegation feature assigns the IP addresses to network interfaces - // that are associated with an instance. For information about Prefix Delegation, - // see Prefix Delegation for Amazon EC2 network interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-delegation.html) - // in the Amazon Elastic Compute Cloud User Guide. - // - // * explicit: You manually assign - // the IP addresses to resources that reside in your subnet. + // - prefix : The Amazon EC2 Prefix Delegation feature assigns the IP addresses + // to network interfaces that are associated with an instance. For information + // about Prefix Delegation, see Prefix Delegation for Amazon EC2 network + // interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-delegation.html) + // in the Amazon Elastic Compute Cloud User Guide. + // - explicit : You manually assign the IP addresses to resources that reside in + // your subnet. // // This member is required. ReservationType types.SubnetCidrReservationType @@ -62,8 +58,8 @@ type CreateSubnetCidrReservationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the subnet CIDR reservation. diff --git a/service/ec2/api_op_CreateTags.go b/service/ec2/api_op_CreateTags.go index a9135f28c8f..18594f6fda2 100644 --- a/service/ec2/api_op_CreateTags.go +++ b/service/ec2/api_op_CreateTags.go @@ -11,16 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or overwrites only the specified tags for the specified Amazon EC2 resource -// or resources. When you specify an existing tag key, the value is overwritten -// with the new value. Each resource can have a maximum of 50 tags. Each tag -// consists of a key and optional value. Tag keys must be unique per resource. For -// more information about tags, see Tag your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon Elastic Compute Cloud User Guide. For more information about creating IAM -// policies that control users' access to resources based on tags, see Supported -// resource-level permissions for Amazon EC2 API actions -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html) +// Adds or overwrites only the specified tags for the specified Amazon EC2 +// resource or resources. When you specify an existing tag key, the value is +// overwritten with the new value. Each resource can have a maximum of 50 tags. +// Each tag consists of a key and optional value. Tag keys must be unique per +// resource. For more information about tags, see Tag your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon Elastic Compute Cloud User Guide. For more information about +// creating IAM policies that control users' access to resources based on tags, see +// Supported resource-level permissions for Amazon EC2 API actions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error) { if params == nil { @@ -45,17 +43,17 @@ type CreateTagsInput struct { // This member is required. Resources []string - // The tags. The value parameter is required, but if you don't want the tag to have - // a value, specify the parameter with no value, and we set the value to an empty - // string. + // The tags. The value parameter is required, but if you don't want the tag to + // have a value, specify the parameter with no value, and we set the value to an + // empty string. // // This member is required. Tags []types.Tag // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateTrafficMirrorFilter.go b/service/ec2/api_op_CreateTrafficMirrorFilter.go index 0fe9a05359e..3dcce484c3e 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilter.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilter.go @@ -14,11 +14,9 @@ import ( // Creates a Traffic Mirror filter. A Traffic Mirror filter is a set of rules that // defines the traffic to mirror. By default, no traffic is mirrored. To mirror -// traffic, use CreateTrafficMirrorFilterRule -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm) +// traffic, use CreateTrafficMirrorFilterRule (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm) // to add Traffic Mirror rules to the filter. The rules you add define what traffic -// gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html) +// gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html) // to mirror supported network services. func (c *Client) CreateTrafficMirrorFilter(ctx context.Context, params *CreateTrafficMirrorFilterInput, optFns ...func(*Options)) (*CreateTrafficMirrorFilterOutput, error) { if params == nil { @@ -38,8 +36,8 @@ func (c *Client) CreateTrafficMirrorFilter(ctx context.Context, params *CreateTr type CreateTrafficMirrorFilterInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the Traffic Mirror filter. @@ -47,8 +45,8 @@ type CreateTrafficMirrorFilterInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to a Traffic Mirror filter. @@ -60,8 +58,8 @@ type CreateTrafficMirrorFilterInput struct { type CreateTrafficMirrorFilterOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Information about the Traffic Mirror filter. diff --git a/service/ec2/api_op_CreateTrafficMirrorFilterRule.go b/service/ec2/api_op_CreateTrafficMirrorFilterRule.go index c27e8491bbd..2e53c0da71c 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilterRule.go @@ -65,8 +65,8 @@ type CreateTrafficMirrorFilterRuleInput struct { TrafficMirrorFilterId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the Traffic Mirror rule. @@ -77,14 +77,13 @@ type CreateTrafficMirrorFilterRuleInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The protocol, for example UDP, to assign to the Traffic Mirror rule. For - // information about the protocol value, see Protocol Numbers - // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on - // the Internet Assigned Numbers Authority (IANA) website. + // information about the protocol value, see Protocol Numbers (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // on the Internet Assigned Numbers Authority (IANA) website. Protocol *int32 // The source port range. @@ -96,8 +95,8 @@ type CreateTrafficMirrorFilterRuleInput struct { type CreateTrafficMirrorFilterRuleOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The Traffic Mirror rule. diff --git a/service/ec2/api_op_CreateTrafficMirrorSession.go b/service/ec2/api_op_CreateTrafficMirrorSession.go index a3f57b98840..5a5d4ea1b6e 100644 --- a/service/ec2/api_op_CreateTrafficMirrorSession.go +++ b/service/ec2/api_op_CreateTrafficMirrorSession.go @@ -18,8 +18,7 @@ import ( // mirror, for example all TCP traffic. The Traffic Mirror source and the Traffic // Mirror target (monitoring appliances) can be in the same VPC, or in a different // VPC connected via VPC peering or a transit gateway. By default, no traffic is -// mirrored. Use CreateTrafficMirrorFilter -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm) +// mirrored. Use CreateTrafficMirrorFilter (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm) // to create filter rules that specify the traffic to mirror. func (c *Client) CreateTrafficMirrorSession(ctx context.Context, params *CreateTrafficMirrorSessionInput, optFns ...func(*Options)) (*CreateTrafficMirrorSessionOutput, error) { if params == nil { @@ -61,8 +60,8 @@ type CreateTrafficMirrorSessionInput struct { TrafficMirrorTargetId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the Traffic Mirror session. @@ -70,8 +69,8 @@ type CreateTrafficMirrorSessionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The number of bytes in each packet to mirror. These are bytes after the VXLAN @@ -87,8 +86,8 @@ type CreateTrafficMirrorSessionInput struct { TagSpecifications []types.TagSpecification // The VXLAN ID for the Traffic Mirror session. For more information about the - // VXLAN protocol, see RFC 7348 (https://tools.ietf.org/html/rfc7348). If you do - // not specify a VirtualNetworkId, an account-wide unique id is chosen at random. + // VXLAN protocol, see RFC 7348 (https://tools.ietf.org/html/rfc7348) . If you do + // not specify a VirtualNetworkId , an account-wide unique id is chosen at random. VirtualNetworkId *int32 noSmithyDocumentSerde @@ -97,8 +96,8 @@ type CreateTrafficMirrorSessionInput struct { type CreateTrafficMirrorSessionOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Information about the Traffic Mirror session. diff --git a/service/ec2/api_op_CreateTrafficMirrorTarget.go b/service/ec2/api_op_CreateTrafficMirrorTarget.go index a72f818b883..e6a62ee9425 100644 --- a/service/ec2/api_op_CreateTrafficMirrorTarget.go +++ b/service/ec2/api_op_CreateTrafficMirrorTarget.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a target for your Traffic Mirror session. A Traffic Mirror target is the -// destination for mirrored traffic. The Traffic Mirror source and the Traffic +// Creates a target for your Traffic Mirror session. A Traffic Mirror target is +// the destination for mirrored traffic. The Traffic Mirror source and the Traffic // Mirror target (monitoring appliances) can be in the same VPC, or in different // VPCs connected via VPC peering or a transit gateway. A Traffic Mirror target can // be a network interface, a Network Load Balancer, or a Gateway Load Balancer // endpoint. To use the target in a Traffic Mirror session, use -// CreateTrafficMirrorSession -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm). +// CreateTrafficMirrorSession (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm) +// . func (c *Client) CreateTrafficMirrorTarget(ctx context.Context, params *CreateTrafficMirrorTargetInput, optFns ...func(*Options)) (*CreateTrafficMirrorTargetOutput, error) { if params == nil { params = &CreateTrafficMirrorTargetInput{} @@ -38,8 +38,8 @@ func (c *Client) CreateTrafficMirrorTarget(ctx context.Context, params *CreateTr type CreateTrafficMirrorTargetInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the Traffic Mirror target. @@ -47,8 +47,8 @@ type CreateTrafficMirrorTargetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the Gateway Load Balancer endpoint. @@ -70,8 +70,8 @@ type CreateTrafficMirrorTargetInput struct { type CreateTrafficMirrorTargetOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Information about the Traffic Mirror target. diff --git a/service/ec2/api_op_CreateTransitGateway.go b/service/ec2/api_op_CreateTransitGateway.go index f6b42fee504..fd3284370dd 100644 --- a/service/ec2/api_op_CreateTransitGateway.go +++ b/service/ec2/api_op_CreateTransitGateway.go @@ -14,10 +14,10 @@ import ( // Creates a transit gateway. You can use a transit gateway to interconnect your // virtual private clouds (VPC) and on-premises networks. After the transit gateway // enters the available state, you can attach your VPCs and VPN connections to the -// transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment. To +// transit gateway. To attach your VPCs, use CreateTransitGatewayVpcAttachment . To // attach a VPN connection, use CreateCustomerGateway to create a customer gateway // and specify the ID of the customer gateway and the ID of the transit gateway in -// a call to CreateVpnConnection. When you create a transit gateway, we create a +// a call to CreateVpnConnection . When you create a transit gateway, we create a // default transit gateway route table and use it as the default association route // table and the default propagation route table. You can use // CreateTransitGatewayRouteTable to create additional transit gateway route @@ -49,8 +49,8 @@ type CreateTransitGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The transit gateway options. diff --git a/service/ec2/api_op_CreateTransitGatewayConnect.go b/service/ec2/api_op_CreateTransitGatewayConnect.go index f4c9f6f17fd..a84c1617147 100644 --- a/service/ec2/api_op_CreateTransitGatewayConnect.go +++ b/service/ec2/api_op_CreateTransitGatewayConnect.go @@ -46,8 +46,8 @@ type CreateTransitGatewayConnectInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the Connect attachment. diff --git a/service/ec2/api_op_CreateTransitGatewayConnectPeer.go b/service/ec2/api_op_CreateTransitGatewayConnectPeer.go index cdcb8c1d4cf..210c16fb4f1 100644 --- a/service/ec2/api_op_CreateTransitGatewayConnectPeer.go +++ b/service/ec2/api_op_CreateTransitGatewayConnectPeer.go @@ -14,8 +14,7 @@ import ( // Creates a Connect peer for a specified transit gateway Connect attachment // between a transit gateway and an appliance. The peer address and transit gateway // address must be the same IP address family (IPv4 or IPv6). For more information, -// see Connect peers -// (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer) +// see Connect peers (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer) // in the Transit Gateways Guide. func (c *Client) CreateTransitGatewayConnectPeer(ctx context.Context, params *CreateTransitGatewayConnectPeerInput, optFns ...func(*Options)) (*CreateTransitGatewayConnectPeerOutput, error) { if params == nil { @@ -34,10 +33,11 @@ func (c *Client) CreateTransitGatewayConnectPeer(ctx context.Context, params *Cr type CreateTransitGatewayConnectPeerInput struct { - // The range of inside IP addresses that are used for BGP peering. You must specify - // a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from - // the range must be configured on the appliance as the BGP IP address. You can - // also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range. + // The range of inside IP addresses that are used for BGP peering. You must + // specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first + // address from the range must be configured on the appliance as the BGP IP + // address. You can also optionally specify a size /125 IPv6 CIDR block from the + // fd00::/8 range. // // This member is required. InsideCidrBlocks []string @@ -58,8 +58,8 @@ type CreateTransitGatewayConnectPeerInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the Connect peer. diff --git a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go index 111b35ce3b6..f281ed4d917 100644 --- a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go @@ -13,8 +13,7 @@ import ( // Creates a multicast domain using the specified transit gateway. The transit // gateway must be in the available state before you create a domain. Use -// DescribeTransitGateways -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html) +// DescribeTransitGateways (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html) // to see the state of transit gateway. func (c *Client) CreateTransitGatewayMulticastDomain(ctx context.Context, params *CreateTransitGatewayMulticastDomainInput, optFns ...func(*Options)) (*CreateTransitGatewayMulticastDomainOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type CreateTransitGatewayMulticastDomainInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The options for the transit gateway multicast domain. diff --git a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go index eb9fe593573..43a654168e6 100644 --- a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go @@ -55,8 +55,8 @@ type CreateTransitGatewayPeeringAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Requests a transit gateway peering attachment. diff --git a/service/ec2/api_op_CreateTransitGatewayPolicyTable.go b/service/ec2/api_op_CreateTransitGatewayPolicyTable.go index 69a1664b5af..a47515cdfed 100644 --- a/service/ec2/api_op_CreateTransitGatewayPolicyTable.go +++ b/service/ec2/api_op_CreateTransitGatewayPolicyTable.go @@ -36,8 +36,8 @@ type CreateTransitGatewayPolicyTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags specification for the transit gateway policy table created during the diff --git a/service/ec2/api_op_CreateTransitGatewayPrefixListReference.go b/service/ec2/api_op_CreateTransitGatewayPrefixListReference.go index b93e8ee1a20..4e067db7fac 100644 --- a/service/ec2/api_op_CreateTransitGatewayPrefixListReference.go +++ b/service/ec2/api_op_CreateTransitGatewayPrefixListReference.go @@ -45,8 +45,8 @@ type CreateTransitGatewayPrefixListReferenceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment to which traffic is routed. diff --git a/service/ec2/api_op_CreateTransitGatewayRoute.go b/service/ec2/api_op_CreateTransitGatewayRoute.go index c04309bc9bd..c8f40e0395d 100644 --- a/service/ec2/api_op_CreateTransitGatewayRoute.go +++ b/service/ec2/api_op_CreateTransitGatewayRoute.go @@ -45,8 +45,8 @@ type CreateTransitGatewayRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment. diff --git a/service/ec2/api_op_CreateTransitGatewayRouteTable.go b/service/ec2/api_op_CreateTransitGatewayRouteTable.go index 8132d0f86de..fc2c97de49b 100644 --- a/service/ec2/api_op_CreateTransitGatewayRouteTable.go +++ b/service/ec2/api_op_CreateTransitGatewayRouteTable.go @@ -36,8 +36,8 @@ type CreateTransitGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the transit gateway route table. diff --git a/service/ec2/api_op_CreateTransitGatewayRouteTableAnnouncement.go b/service/ec2/api_op_CreateTransitGatewayRouteTableAnnouncement.go index 1b4159adad6..ccd3472f495 100644 --- a/service/ec2/api_op_CreateTransitGatewayRouteTableAnnouncement.go +++ b/service/ec2/api_op_CreateTransitGatewayRouteTableAnnouncement.go @@ -41,8 +41,8 @@ type CreateTransitGatewayRouteTableAnnouncementInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags specifications applied to the transit gateway route table announcement. diff --git a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go index 781ca395841..1df6806c3e4 100644 --- a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches the specified VPC to the specified transit gateway. If you attach a VPC -// with a CIDR range that overlaps the CIDR range of a VPC that is already +// Attaches the specified VPC to the specified transit gateway. If you attach a +// VPC with a CIDR range that overlaps the CIDR range of a VPC that is already // attached, the new VPC CIDR range is not propagated to the default propagation // route table. To send VPC traffic to an attached transit gateway, add a route to -// the VPC route table using CreateRoute. +// the VPC route table using CreateRoute . func (c *Client) CreateTransitGatewayVpcAttachment(ctx context.Context, params *CreateTransitGatewayVpcAttachmentInput, optFns ...func(*Options)) (*CreateTransitGatewayVpcAttachmentOutput, error) { if params == nil { params = &CreateTransitGatewayVpcAttachmentInput{} @@ -33,10 +33,10 @@ func (c *Client) CreateTransitGatewayVpcAttachment(ctx context.Context, params * type CreateTransitGatewayVpcAttachmentInput struct { - // The IDs of one or more subnets. You can specify only one subnet per Availability - // Zone. You must specify at least one subnet, but we recommend that you specify - // two subnets for better availability. The transit gateway uses one IP address - // from each specified subnet. + // The IDs of one or more subnets. You can specify only one subnet per + // Availability Zone. You must specify at least one subnet, but we recommend that + // you specify two subnets for better availability. The transit gateway uses one IP + // address from each specified subnet. // // This member is required. SubnetIds []string @@ -53,8 +53,8 @@ type CreateTransitGatewayVpcAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The VPC attachment options. diff --git a/service/ec2/api_op_CreateVerifiedAccessEndpoint.go b/service/ec2/api_op_CreateVerifiedAccessEndpoint.go index 5715a75dbdc..4e9d8c73638 100644 --- a/service/ec2/api_op_CreateVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_CreateVerifiedAccessEndpoint.go @@ -65,8 +65,8 @@ type CreateVerifiedAccessEndpointInput struct { VerifiedAccessGroupId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access endpoint. @@ -74,16 +74,16 @@ type CreateVerifiedAccessEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The load balancer details if creating the Amazon Web Services Verified Access - // endpoint as load-balancertype. + // endpoint as load-balancer type. LoadBalancerOptions *types.CreateVerifiedAccessEndpointLoadBalancerOptions // The network interface details if creating the Amazon Web Services Verified - // Access endpoint as network-interfacetype. + // Access endpoint as network-interface type. NetworkInterfaceOptions *types.CreateVerifiedAccessEndpointEniOptions // The Amazon Web Services Verified Access policy document. diff --git a/service/ec2/api_op_CreateVerifiedAccessGroup.go b/service/ec2/api_op_CreateVerifiedAccessGroup.go index 7b5dfbb649a..e8559a06ace 100644 --- a/service/ec2/api_op_CreateVerifiedAccessGroup.go +++ b/service/ec2/api_op_CreateVerifiedAccessGroup.go @@ -42,8 +42,8 @@ type CreateVerifiedAccessGroupInput struct { VerifiedAccessInstanceId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access group. @@ -51,8 +51,8 @@ type CreateVerifiedAccessGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Web Services Verified Access policy document. diff --git a/service/ec2/api_op_CreateVerifiedAccessInstance.go b/service/ec2/api_op_CreateVerifiedAccessInstance.go index ddfd661cb11..2ef9b64eaf3 100644 --- a/service/ec2/api_op_CreateVerifiedAccessInstance.go +++ b/service/ec2/api_op_CreateVerifiedAccessInstance.go @@ -33,8 +33,8 @@ func (c *Client) CreateVerifiedAccessInstance(ctx context.Context, params *Creat type CreateVerifiedAccessInstanceInput struct { // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access instance. @@ -42,8 +42,8 @@ type CreateVerifiedAccessInstanceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to assign to the Amazon Web Services Verified Access instance. diff --git a/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go b/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go index 496298478ad..9790d611bc9 100644 --- a/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go @@ -45,8 +45,8 @@ type CreateVerifiedAccessTrustProviderInput struct { TrustProviderType types.TrustProviderType // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access trust provider. @@ -60,11 +60,11 @@ type CreateVerifiedAccessTrustProviderInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The OpenID Connect details for an oidc-type, user-identity based trust provider. + // The OpenID Connect details for an oidc -type, user-identity based trust provider. OidcOptions *types.CreateVerifiedAccessTrustProviderOidcOptions // The tags to assign to the Amazon Web Services Verified Access trust provider. diff --git a/service/ec2/api_op_CreateVolume.go b/service/ec2/api_op_CreateVolume.go index 723018046d9..28982d46ce0 100644 --- a/service/ec2/api_op_CreateVolume.go +++ b/service/ec2/api_op_CreateVolume.go @@ -19,14 +19,11 @@ import ( // snapshot are propagated to the volume. You can create encrypted volumes. // Encrypted volumes must be attached to instances that support Amazon EBS // encryption. Volumes that are created from encrypted snapshots are also -// automatically encrypted. For more information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. You can tag your volumes during -// creation. For more information, see Tag your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon Elastic Compute Cloud User Guide. For more information, see Create an -// Amazon EBS volume -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html) +// automatically encrypted. For more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. You can tag your volumes during +// creation. For more information, see Tag your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon Elastic Compute Cloud User Guide. For more information, see +// Create an Amazon EBS volume (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateVolume(ctx context.Context, params *CreateVolumeInput, optFns ...func(*Options)) (*CreateVolumeOutput, error) { if params == nil { @@ -51,79 +48,62 @@ type CreateVolumeInput struct { AvailabilityZone *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether the volume should be encrypted. The effect of setting the // encryption state to true depends on the volume origin (new or from a snapshot), // starting encryption state, ownership, and whether encryption by default is - // enabled. For more information, see Encryption by default - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) + // enabled. For more information, see Encryption by default (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) // in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes // must be attached to instances that support Amazon EBS encryption. For more - // information, see Supported instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). + // information, see Supported instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) + // . Encrypted *bool - // The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, - // this represents the number of IOPS that are provisioned for the volume. For gp2 - // volumes, this represents the baseline performance of the volume and the rate at - // which the volume accumulates I/O credits for bursting. The following are the - // supported values for each volume type: - // - // * gp3: 3,000-16,000 IOPS - // - // * io1: - // 100-64,000 IOPS - // - // * io2: 100-64,000 IOPS - // - // io1 and io2 volumes support up to - // 64,000 IOPS only on Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families support performance up to 32,000 IOPS. This parameter is - // required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. - // This parameter is not supported for gp2, st1, sc1, or standard volumes. + // The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 + // volumes, this represents the number of IOPS that are provisioned for the volume. + // For gp2 volumes, this represents the baseline performance of the volume and the + // rate at which the volume accumulates I/O credits for bursting. The following are + // the supported values for each volume type: + // - gp3 : 3,000-16,000 IOPS + // - io1 : 100-64,000 IOPS + // - io2 : 100-64,000 IOPS + // io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the + // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // . Other instance families support performance up to 32,000 IOPS. This parameter + // is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. + // This parameter is not supported for gp2 , st1 , sc1 , or standard volumes. Iops *int32 - // The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS - // encryption. If this parameter is not specified, your KMS key for Amazon EBS is - // used. If KmsKeyId is specified, the encrypted state must be true. You can + // The identifier of the Key Management Service (KMS) KMS key to use for Amazon + // EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS + // is used. If KmsKeyId is specified, the encrypted state must be true . You can // specify the KMS key using any of the following: - // - // * Key ID. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Key alias. For example, - // alias/ExampleAlias. - // - // * Key ARN. For example, - // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Alias ARN. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // authenticates the KMS key asynchronously. Therefore, if you specify an ID, - // alias, or ARN that is not valid, the action can appear to complete, but - // eventually fails. + // - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + // - Key alias. For example, alias/ExampleAlias. + // - Key ARN. For example, + // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // - Alias ARN. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you + // specify an ID, alias, or ARN that is not valid, the action can appear to + // complete, but eventually fails. KmsKeyId *string - // Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, - // you can attach the volume to up to 16 Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // Indicates whether to enable Amazon EBS Multi-Attach. If you enable + // Multi-Attach, you can attach the volume to up to 16 Instances built on the + // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) // in the same Availability Zone. This parameter is supported with io1 and io2 - // volumes only. For more information, see Amazon EBS Multi-Attach - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) in - // the Amazon Elastic Compute Cloud User Guide. + // volumes only. For more information, see Amazon EBS Multi-Attach (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) + // in the Amazon Elastic Compute Cloud User Guide. MultiAttachEnabled *bool // The Amazon Resource Name (ARN) of the Outpost. @@ -133,20 +113,14 @@ type CreateVolumeInput struct { // volume size. If you specify a snapshot, the default is the snapshot size. You // can specify a volume size that is equal to or larger than the snapshot size. The // following are the supported volumes sizes for each volume type: - // - // * gp2 and gp3: - // 1-16,384 - // - // * io1 and io2: 4-16,384 - // - // * st1 and sc1: 125-16,384 - // - // * standard: - // 1-1,024 + // - gp2 and gp3 : 1-16,384 + // - io1 and io2 : 4-16,384 + // - st1 and sc1 : 125-16,384 + // - standard : 1-1,024 Size *int32 - // The snapshot from which to create the volume. You must specify either a snapshot - // ID or a volume size. + // The snapshot from which to create the volume. You must specify either a + // snapshot ID or a volume size. SnapshotId *string // The tags to apply to the volume during creation. @@ -158,24 +132,14 @@ type CreateVolumeInput struct { Throughput *int32 // The volume type. This parameter can be one of the following values: - // - // * General - // Purpose SSD: gp2 | gp3 - // - // * Provisioned IOPS SSD: io1 | io2 - // - // * Throughput - // Optimized HDD: st1 - // - // * Cold HDD: sc1 - // - // * Magnetic: standard - // - // Throughput Optimized - // HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes. For more - // information, see Amazon EBS volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon Elastic Compute Cloud User Guide. Default: gp2 + // - General Purpose SSD: gp2 | gp3 + // - Provisioned IOPS SSD: io1 | io2 + // - Throughput Optimized HDD: st1 + // - Cold HDD: sc1 + // - Magnetic: standard + // Throughput Optimized HDD ( st1 ) and Cold HDD ( sc1 ) volumes can't be used as + // boot volumes. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon Elastic Compute Cloud User Guide. Default: gp2 VolumeType types.VolumeType noSmithyDocumentSerde @@ -199,10 +163,10 @@ type CreateVolumeOutput struct { // Indicates whether the volume was created using fast snapshot restore. FastRestored *bool - // The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, - // this represents the number of IOPS that are provisioned for the volume. For gp2 - // volumes, this represents the baseline performance of the volume and the rate at - // which the volume accumulates I/O credits for bursting. + // The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 + // volumes, this represents the number of IOPS that are provisioned for the volume. + // For gp2 volumes, this represents the baseline performance of the volume and the + // rate at which the volume accumulates I/O credits for bursting. Iops *int32 // The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that diff --git a/service/ec2/api_op_CreateVpc.go b/service/ec2/api_op_CreateVpc.go index 8b2bdf20516..e6f318f6007 100644 --- a/service/ec2/api_op_CreateVpc.go +++ b/service/ec2/api_op_CreateVpc.go @@ -11,23 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a VPC with the specified CIDR blocks. For more information, see VPC CIDR -// blocks -// (https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html#vpc-cidr-blocks) +// Creates a VPC with the specified CIDR blocks. For more information, see VPC +// CIDR blocks (https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html#vpc-cidr-blocks) // in the Amazon Virtual Private Cloud User Guide. You can optionally request an // IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block // from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address -// pool that you provisioned through bring your own IP addresses (BYOIP -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html)). By -// default, each instance that you launch in the VPC has the default DHCP options, -// which include only a default DNS server that we provide (AmazonProvidedDNS). For -// more information, see DHCP option sets -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the -// Amazon Virtual Private Cloud User Guide. You can specify the instance tenancy -// value for the VPC when you create it. You can't change this value for the VPC -// after you create it. For more information, see Dedicated Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) in -// the Amazon Elastic Compute Cloud User Guide. +// pool that you provisioned through bring your own IP addresses ( BYOIP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) +// ). By default, each instance that you launch in the VPC has the default DHCP +// options, which include only a default DNS server that we provide +// (AmazonProvidedDNS). For more information, see DHCP option sets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) +// in the Amazon Virtual Private Cloud User Guide. You can specify the instance +// tenancy value for the VPC when you create it. You can't change this value for +// the VPC after you create it. For more information, see Dedicated Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateVpc(ctx context.Context, params *CreateVpcInput, optFns ...func(*Options)) (*CreateVpcOutput, error) { if params == nil { params = &CreateVpcInput{} @@ -50,20 +46,20 @@ type CreateVpcInput struct { // block. AmazonProvidedIpv6CidrBlock *bool - // The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. + // The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16 . // We modify the specified CIDR block to its canonical form; for example, if you - // specify 100.68.0.18/18, we modify it to 100.68.0.0/18. + // specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 . CidrBlock *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The tenancy options for instances launched into the VPC. For default, instances + // The tenancy options for instances launched into the VPC. For default , instances // are launched with shared tenancy by default. You can launch instances with any - // tenancy into a shared tenancy VPC. For dedicated, instances are launched as + // tenancy into a shared tenancy VPC. For dedicated , instances are launched as // dedicated tenancy instances by default. You can only launch instances with a // tenancy of dedicated or host into a dedicated tenancy VPC. Important: The host // value cannot be used with this parameter. Use the default or dedicated values @@ -71,9 +67,8 @@ type CreateVpcInput struct { InstanceTenancy types.Tenancy // The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For - // more information, see What is IPAM? - // (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon - // VPC IPAM User Guide. + // more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. Ipv4IpamPoolId *string // The netmask length of the IPv4 CIDR you want to allocate to this VPC from an @@ -96,9 +91,8 @@ type CreateVpcInput struct { // CIDR. IPAM is a VPC feature that you can use to automate your IP address // management workflows including assigning, tracking, troubleshooting, and // auditing IP addresses across Amazon Web Services Regions and accounts throughout - // your Amazon Web Services Organization. For more information, see What is IPAM? - // (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon - // VPC IPAM User Guide. + // your Amazon Web Services Organization. For more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) + // in the Amazon VPC IPAM User Guide. Ipv6IpamPoolId *string // The netmask length of the IPv6 CIDR you want to allocate to this VPC from an diff --git a/service/ec2/api_op_CreateVpcEndpoint.go b/service/ec2/api_op_CreateVpcEndpoint.go index 126e8c34abf..1f3f3c5f70c 100644 --- a/service/ec2/api_op_CreateVpcEndpoint.go +++ b/service/ec2/api_op_CreateVpcEndpoint.go @@ -15,8 +15,8 @@ import ( // create a private connection between your VPC and the service. The service may be // provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or // another Amazon Web Services account. For more information, see the Amazon Web -// Services PrivateLink Guide -// (https://docs.aws.amazon.com/vpc/latest/privatelink/). +// Services PrivateLink Guide (https://docs.aws.amazon.com/vpc/latest/privatelink/) +// . func (c *Client) CreateVpcEndpoint(ctx context.Context, params *CreateVpcEndpointInput, optFns ...func(*Options)) (*CreateVpcEndpointOutput, error) { if params == nil { params = &CreateVpcEndpointInput{} @@ -45,8 +45,8 @@ type CreateVpcEndpointInput struct { VpcId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The DNS options for the endpoint. @@ -54,8 +54,8 @@ type CreateVpcEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address type for the endpoint. @@ -70,13 +70,13 @@ type CreateVpcEndpointInput struct { // (Interface endpoint) Indicates whether to associate a private hosted zone with // the specified VPC. The private hosted zone contains a record set for the default // public DNS name for the service for the Region (for example, - // kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of + // kinesis.us-east-1.amazonaws.com ), which resolves to the private IP addresses of // the endpoint network interfaces in the VPC. This enables you to make requests to // the default public DNS name for the service instead of the public DNS names that // are automatically generated by the VPC endpoint service. To use a private hosted - // zone, you must set the following VPC attributes to true: enableDnsHostnames and - // enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes. Default: - // true + // zone, you must set the following VPC attributes to true : enableDnsHostnames + // and enableDnsSupport . Use ModifyVpcAttribute to set the VPC attributes. + // Default: true PrivateDnsEnabled *bool // (Gateway endpoint) The route table IDs. diff --git a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go index 36c99a5c2fc..f69f383a356 100644 --- a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go +++ b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go @@ -34,8 +34,8 @@ func (c *Client) CreateVpcEndpointConnectionNotification(ctx context.Context, pa type CreateVpcEndpointConnectionNotificationInput struct { - // The endpoint events for which to receive notifications. Valid values are Accept, - // Connect, Delete, and Reject. + // The endpoint events for which to receive notifications. Valid values are Accept + // , Connect , Delete , and Reject . // // This member is required. ConnectionEvents []string @@ -46,14 +46,14 @@ type CreateVpcEndpointConnectionNotificationInput struct { ConnectionNotificationArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the endpoint service. diff --git a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go index 0f3a71fea51..fb60729c0b9 100644 --- a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go @@ -14,20 +14,15 @@ import ( // Creates a VPC endpoint service to which service consumers (Amazon Web Services // accounts, users, and IAM roles) can connect. Before you create an endpoint // service, you must create one of the following for your service: +// - A Network Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/) +// . Service consumers connect to your service using an interface endpoint. +// - A Gateway Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/) +// . Service consumers connect to your service using a Gateway Load Balancer +// endpoint. // -// * A Network -// Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/). Service -// consumers connect to your service using an interface endpoint. -// -// * A Gateway Load -// Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/). -// Service consumers connect to your service using a Gateway Load Balancer -// endpoint. -// -// If you set the private DNS name, you must prove that you own the -// private DNS domain name. For more information, see the Amazon Web Services -// PrivateLink Guide (https://docs.aws.amazon.com/vpc/latest/privatelink/). +// If you set the private DNS name, you must prove that you own the private DNS +// domain name. For more information, see the Amazon Web Services PrivateLink Guide (https://docs.aws.amazon.com/vpc/latest/privatelink/) +// . func (c *Client) CreateVpcEndpointServiceConfiguration(ctx context.Context, params *CreateVpcEndpointServiceConfigurationInput, optFns ...func(*Options)) (*CreateVpcEndpointServiceConfigurationOutput, error) { if params == nil { params = &CreateVpcEndpointServiceConfigurationInput{} @@ -50,14 +45,14 @@ type CreateVpcEndpointServiceConfigurationInput struct { AcceptanceRequired *bool // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Resource Names (ARNs) of the Gateway Load Balancers. @@ -70,7 +65,7 @@ type CreateVpcEndpointServiceConfigurationInput struct { // endpoint service. PrivateDnsName *string - // The supported IP address types. The possible values are ipv4 and ipv6. + // The supported IP address types. The possible values are ipv4 and ipv6 . SupportedIpAddressTypes []string // The tags to associate with the service. diff --git a/service/ec2/api_op_CreateVpcPeeringConnection.go b/service/ec2/api_op_CreateVpcPeeringConnection.go index 05631b7d45a..3741dac1419 100644 --- a/service/ec2/api_op_CreateVpcPeeringConnection.go +++ b/service/ec2/api_op_CreateVpcPeeringConnection.go @@ -11,18 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests a VPC peering connection between two VPCs: a requester VPC that you own -// and an accepter VPC with which to create the connection. The accepter VPC can -// belong to another Amazon Web Services account and can be in a different Region -// to the requester VPC. The requester VPC and accepter VPC cannot have overlapping -// CIDR blocks. Limitations and rules apply to a VPC peering connection. For more -// information, see the limitations -// (https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations) +// Requests a VPC peering connection between two VPCs: a requester VPC that you +// own and an accepter VPC with which to create the connection. The accepter VPC +// can belong to another Amazon Web Services account and can be in a different +// Region to the requester VPC. The requester VPC and accepter VPC cannot have +// overlapping CIDR blocks. Limitations and rules apply to a VPC peering +// connection. For more information, see the limitations (https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations) // section in the VPC Peering Guide. The owner of the accepter VPC must accept the // peering request to activate the peering connection. The VPC peering connection // request expires after 7 days, after which it cannot be accepted or rejected. If // you create a VPC peering connection request between VPCs with overlapping CIDR -// blocks, the VPC peering connection has a status of failed. +// blocks, the VPC peering connection has a status of failed . func (c *Client) CreateVpcPeeringConnection(ctx context.Context, params *CreateVpcPeeringConnectionInput, optFns ...func(*Options)) (*CreateVpcPeeringConnectionOutput, error) { if params == nil { params = &CreateVpcPeeringConnectionInput{} @@ -47,17 +46,17 @@ type CreateVpcPeeringConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Web Services account ID of the owner of the accepter VPC. Default: // Your Amazon Web Services account ID PeerOwnerId *string - // The Region code for the accepter VPC, if the accepter VPC is located in a Region - // other than the Region in which you make the request. Default: The Region in - // which you make the request. + // The Region code for the accepter VPC, if the accepter VPC is located in a + // Region other than the Region in which you make the request. Default: The Region + // in which you make the request. PeerRegion *string // The ID of the VPC with which you are creating the VPC peering connection. You diff --git a/service/ec2/api_op_CreateVpnConnection.go b/service/ec2/api_op_CreateVpnConnection.go index a7e2192fcf3..efe6cca7918 100644 --- a/service/ec2/api_op_CreateVpnConnection.go +++ b/service/ec2/api_op_CreateVpnConnection.go @@ -12,7 +12,7 @@ import ( ) // Creates a VPN connection between an existing virtual private gateway or transit -// gateway and a customer gateway. The supported connection type is ipsec.1. The +// gateway and a customer gateway. The supported connection type is ipsec.1 . The // response includes information that you need to give to your network // administrator to configure your customer gateway. We strongly recommend that you // use HTTPS when calling this operation because the response contains sensitive @@ -21,9 +21,8 @@ import ( // VPN connection, you must reconfigure your customer gateway with the new // information returned from this call. This is an idempotent operation. If you // perform the operation more than once, Amazon EC2 doesn't return an error. For -// more information, see Amazon Web Services Site-to-Site VPN -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// more information, see Amazon Web Services Site-to-Site VPN (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) CreateVpnConnection(ctx context.Context, params *CreateVpnConnectionInput, optFns ...func(*Options)) (*CreateVpnConnectionOutput, error) { if params == nil { params = &CreateVpnConnectionInput{} @@ -47,15 +46,15 @@ type CreateVpnConnectionInput struct { // This member is required. CustomerGatewayId *string - // The type of VPN connection (ipsec.1). + // The type of VPN connection ( ipsec.1 ). // // This member is required. Type *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The options for the VPN connection. @@ -68,8 +67,8 @@ type CreateVpnConnectionInput struct { // specify a virtual private gateway. TransitGatewayId *string - // The ID of the virtual private gateway. If you specify a virtual private gateway, - // you cannot specify a transit gateway. + // The ID of the virtual private gateway. If you specify a virtual private + // gateway, you cannot specify a transit gateway. VpnGatewayId *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateVpnConnectionRoute.go b/service/ec2/api_op_CreateVpnConnectionRoute.go index fce5cf69989..1ad28fbce3e 100644 --- a/service/ec2/api_op_CreateVpnConnectionRoute.go +++ b/service/ec2/api_op_CreateVpnConnectionRoute.go @@ -13,9 +13,8 @@ import ( // Creates a static route associated with a VPN connection between an existing // virtual private gateway and a VPN customer gateway. The static route allows // traffic to be routed from the virtual private gateway to the VPN customer -// gateway. For more information, see Amazon Web Services Site-to-Site VPN -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// gateway. For more information, see Amazon Web Services Site-to-Site VPN (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) CreateVpnConnectionRoute(ctx context.Context, params *CreateVpnConnectionRouteInput, optFns ...func(*Options)) (*CreateVpnConnectionRouteOutput, error) { if params == nil { params = &CreateVpnConnectionRouteInput{} diff --git a/service/ec2/api_op_CreateVpnGateway.go b/service/ec2/api_op_CreateVpnGateway.go index 0dd581267e1..90b31d56200 100644 --- a/service/ec2/api_op_CreateVpnGateway.go +++ b/service/ec2/api_op_CreateVpnGateway.go @@ -50,8 +50,8 @@ type CreateVpnGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the virtual private gateway. diff --git a/service/ec2/api_op_DeleteCarrierGateway.go b/service/ec2/api_op_DeleteCarrierGateway.go index cf6bf4a3a47..6b85710554d 100644 --- a/service/ec2/api_op_DeleteCarrierGateway.go +++ b/service/ec2/api_op_DeleteCarrierGateway.go @@ -13,8 +13,8 @@ import ( // Deletes a carrier gateway. If you do not delete the route that contains the // carrier gateway as the Target, the route is a blackhole route. For information -// about how to delete a route, see DeleteRoute -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html). +// about how to delete a route, see DeleteRoute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html) +// . func (c *Client) DeleteCarrierGateway(ctx context.Context, params *DeleteCarrierGatewayInput, optFns ...func(*Options)) (*DeleteCarrierGatewayOutput, error) { if params == nil { params = &DeleteCarrierGatewayInput{} @@ -39,8 +39,8 @@ type DeleteCarrierGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteClientVpnEndpoint.go b/service/ec2/api_op_DeleteClientVpnEndpoint.go index 061bbd7aa9d..d395da85d41 100644 --- a/service/ec2/api_op_DeleteClientVpnEndpoint.go +++ b/service/ec2/api_op_DeleteClientVpnEndpoint.go @@ -37,8 +37,8 @@ type DeleteClientVpnEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteClientVpnRoute.go b/service/ec2/api_op_DeleteClientVpnRoute.go index 41d725743c8..eda081f063a 100644 --- a/service/ec2/api_op_DeleteClientVpnRoute.go +++ b/service/ec2/api_op_DeleteClientVpnRoute.go @@ -45,8 +45,8 @@ type DeleteClientVpnRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the target subnet used by the route. diff --git a/service/ec2/api_op_DeleteCoipCidr.go b/service/ec2/api_op_DeleteCoipCidr.go index a220270edf6..732dd19f1dd 100644 --- a/service/ec2/api_op_DeleteCoipCidr.go +++ b/service/ec2/api_op_DeleteCoipCidr.go @@ -41,8 +41,8 @@ type DeleteCoipCidrInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteCoipPool.go b/service/ec2/api_op_DeleteCoipPool.go index 472472ed640..dd78629cdf1 100644 --- a/service/ec2/api_op_DeleteCoipPool.go +++ b/service/ec2/api_op_DeleteCoipPool.go @@ -36,8 +36,8 @@ type DeleteCoipPoolInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteCustomerGateway.go b/service/ec2/api_op_DeleteCustomerGateway.go index d87f68145c8..a41344c626f 100644 --- a/service/ec2/api_op_DeleteCustomerGateway.go +++ b/service/ec2/api_op_DeleteCustomerGateway.go @@ -37,8 +37,8 @@ type DeleteCustomerGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteDhcpOptions.go b/service/ec2/api_op_DeleteDhcpOptions.go index 2e6ccb9457e..d4294d1a33c 100644 --- a/service/ec2/api_op_DeleteDhcpOptions.go +++ b/service/ec2/api_op_DeleteDhcpOptions.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified set of DHCP options. You must disassociate the set of DHCP -// options before you can delete it. You can disassociate the set of DHCP options -// by associating either a new set of options or the default set of options with -// the VPC. +// Deletes the specified set of DHCP options. You must disassociate the set of +// DHCP options before you can delete it. You can disassociate the set of DHCP +// options by associating either a new set of options or the default set of options +// with the VPC. func (c *Client) DeleteDhcpOptions(ctx context.Context, params *DeleteDhcpOptionsInput, optFns ...func(*Options)) (*DeleteDhcpOptionsOutput, error) { if params == nil { params = &DeleteDhcpOptionsInput{} @@ -38,8 +38,8 @@ type DeleteDhcpOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteEgressOnlyInternetGateway.go b/service/ec2/api_op_DeleteEgressOnlyInternetGateway.go index 5ec37545ef8..7b0fe081f2c 100644 --- a/service/ec2/api_op_DeleteEgressOnlyInternetGateway.go +++ b/service/ec2/api_op_DeleteEgressOnlyInternetGateway.go @@ -35,8 +35,8 @@ type DeleteEgressOnlyInternetGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteFleets.go b/service/ec2/api_op_DeleteFleets.go index c77a7909718..429e40e8173 100644 --- a/service/ec2/api_op_DeleteFleets.go +++ b/service/ec2/api_op_DeleteFleets.go @@ -19,18 +19,14 @@ import ( // interrupted or you terminate them manually. For instant fleets, EC2 Fleet must // terminate the instances when the fleet is deleted. A deleted instant fleet with // running instances is not supported. Restrictions +// - You can delete up to 25 instant fleets in a single request. If you exceed +// this number, no instant fleets are deleted and an error is returned. There is +// no restriction on the number of fleets of type maintain or request that can be +// deleted in a single request. +// - Up to 1000 instances can be terminated in a single request to delete instant +// fleets. // -// * You can delete up to 25 -// instant fleets in a single request. If you exceed this number, no instant fleets -// are deleted and an error is returned. There is no restriction on the number of -// fleets of type maintain or request that can be deleted in a single request. -// -// * -// Up to 1000 instances can be terminated in a single request to delete instant -// fleets. -// -// For more information, see Delete an EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet) +// For more information, see Delete an EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet) // in the Amazon EC2 User Guide. func (c *Client) DeleteFleets(ctx context.Context, params *DeleteFleetsInput, optFns ...func(*Options)) (*DeleteFleetsOutput, error) { if params == nil { @@ -56,9 +52,9 @@ type DeleteFleetsInput struct { // Indicates whether to terminate the associated instances when the EC2 Fleet is // deleted. The default is to terminate the instances. To let the instances - // continue to run after the EC2 Fleet is deleted, specify no-terminate-instances. - // Supported only for fleets of type maintain and request. For instant fleets, you - // cannot specify NoTerminateInstances. A deleted instant fleet with running + // continue to run after the EC2 Fleet is deleted, specify no-terminate-instances . + // Supported only for fleets of type maintain and request . For instant fleets, + // you cannot specify NoTerminateInstances . A deleted instant fleet with running // instances is not supported. // // This member is required. @@ -66,8 +62,8 @@ type DeleteFleetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteFlowLogs.go b/service/ec2/api_op_DeleteFlowLogs.go index ac3800fbc82..d83caed4d3f 100644 --- a/service/ec2/api_op_DeleteFlowLogs.go +++ b/service/ec2/api_op_DeleteFlowLogs.go @@ -36,8 +36,8 @@ type DeleteFlowLogsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteFpgaImage.go b/service/ec2/api_op_DeleteFpgaImage.go index 5235ed51cf6..186f7ce9c20 100644 --- a/service/ec2/api_op_DeleteFpgaImage.go +++ b/service/ec2/api_op_DeleteFpgaImage.go @@ -35,8 +35,8 @@ type DeleteFpgaImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteInstanceEventWindow.go b/service/ec2/api_op_DeleteInstanceEventWindow.go index a4fc2aa9782..3aa7617d2da 100644 --- a/service/ec2/api_op_DeleteInstanceEventWindow.go +++ b/service/ec2/api_op_DeleteInstanceEventWindow.go @@ -12,9 +12,8 @@ import ( ) // Deletes the specified event window. For more information, see Define event -// windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) DeleteInstanceEventWindow(ctx context.Context, params *DeleteInstanceEventWindowInput, optFns ...func(*Options)) (*DeleteInstanceEventWindowOutput, error) { if params == nil { params = &DeleteInstanceEventWindowInput{} @@ -39,12 +38,12 @@ type DeleteInstanceEventWindowInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // Specify true to force delete the event window. Use the force delete parameter if - // the event window is currently associated with targets. + // Specify true to force delete the event window. Use the force delete parameter + // if the event window is currently associated with targets. ForceDelete *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteInternetGateway.go b/service/ec2/api_op_DeleteInternetGateway.go index 362b9d51603..bda1c27f528 100644 --- a/service/ec2/api_op_DeleteInternetGateway.go +++ b/service/ec2/api_op_DeleteInternetGateway.go @@ -36,8 +36,8 @@ type DeleteInternetGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteIpam.go b/service/ec2/api_op_DeleteIpam.go index 15e6e59a03f..048d7d1a7d0 100644 --- a/service/ec2/api_op_DeleteIpam.go +++ b/service/ec2/api_op_DeleteIpam.go @@ -41,29 +41,20 @@ type DeleteIpamInput struct { // and any allocations in the pools in private scopes. You cannot delete the IPAM // with this option if there is a pool in your public scope. If you use this // option, IPAM does the following: - // - // * Deallocates any CIDRs allocated to VPC - // resources (such as VPCs) in pools in private scopes. No VPC resources are - // deleted as a result of enabling this option. The CIDR associated with the - // resource will no longer be allocated from an IPAM pool, but the CIDR itself will - // remain unchanged. - // - // * Deprovisions all IPv4 CIDRs provisioned to IPAM pools in - // private scopes. - // - // * Deletes all IPAM pools in private scopes. - // - // * Deletes all - // non-default private scopes in the IPAM. - // - // * Deletes the default public and - // private scopes and the IPAM. + // - Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in + // private scopes. No VPC resources are deleted as a result of enabling this + // option. The CIDR associated with the resource will no longer be allocated from + // an IPAM pool, but the CIDR itself will remain unchanged. + // - Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes. + // - Deletes all IPAM pools in private scopes. + // - Deletes all non-default private scopes in the IPAM. + // - Deletes the default public and private scopes and the IPAM. Cascade *bool // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteIpamPool.go b/service/ec2/api_op_DeleteIpamPool.go index a3e871c571b..f04a9cf0914 100644 --- a/service/ec2/api_op_DeleteIpamPool.go +++ b/service/ec2/api_op_DeleteIpamPool.go @@ -13,13 +13,10 @@ import ( // Delete an IPAM pool. You cannot delete an IPAM pool if there are allocations in // it or CIDRs provisioned to it. To release allocations, see -// ReleaseIpamPoolAllocation -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html). -// To deprovision pool CIDRs, see DeprovisionIpamPoolCidr -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html). -// For more information, see Delete a pool -// (https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html) in the -// Amazon VPC IPAM User Guide. +// ReleaseIpamPoolAllocation (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html) +// . To deprovision pool CIDRs, see DeprovisionIpamPoolCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html) +// . For more information, see Delete a pool (https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) DeleteIpamPool(ctx context.Context, params *DeleteIpamPoolInput, optFns ...func(*Options)) (*DeleteIpamPoolOutput, error) { if params == nil { params = &DeleteIpamPoolInput{} @@ -44,8 +41,8 @@ type DeleteIpamPoolInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteIpamResourceDiscovery.go b/service/ec2/api_op_DeleteIpamResourceDiscovery.go index 1cdab9a3066..ff94026adc9 100644 --- a/service/ec2/api_op_DeleteIpamResourceDiscovery.go +++ b/service/ec2/api_op_DeleteIpamResourceDiscovery.go @@ -38,8 +38,8 @@ type DeleteIpamResourceDiscoveryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteIpamScope.go b/service/ec2/api_op_DeleteIpamScope.go index f5359689057..5b91a3e4926 100644 --- a/service/ec2/api_op_DeleteIpamScope.go +++ b/service/ec2/api_op_DeleteIpamScope.go @@ -12,9 +12,8 @@ import ( ) // Delete the scope for an IPAM. You cannot delete the default scopes. For more -// information, see Delete a scope -// (https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html) in the -// Amazon VPC IPAM User Guide. +// information, see Delete a scope (https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) DeleteIpamScope(ctx context.Context, params *DeleteIpamScopeInput, optFns ...func(*Options)) (*DeleteIpamScopeOutput, error) { if params == nil { params = &DeleteIpamScopeInput{} @@ -39,8 +38,8 @@ type DeleteIpamScopeInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteKeyPair.go b/service/ec2/api_op_DeleteKeyPair.go index 0e9c67c92cc..8a192e827a7 100644 --- a/service/ec2/api_op_DeleteKeyPair.go +++ b/service/ec2/api_op_DeleteKeyPair.go @@ -30,8 +30,8 @@ type DeleteKeyPairInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name of the key pair. diff --git a/service/ec2/api_op_DeleteLaunchTemplate.go b/service/ec2/api_op_DeleteLaunchTemplate.go index de9a521f05f..a15d44218af 100644 --- a/service/ec2/api_op_DeleteLaunchTemplate.go +++ b/service/ec2/api_op_DeleteLaunchTemplate.go @@ -32,16 +32,16 @@ type DeleteLaunchTemplateInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the launch template. You must specify either the LaunchTemplateId or - // the LaunchTemplateName, but not both. + // the LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify either the LaunchTemplateName - // or the LaunchTemplateId, but not both. + // or the LaunchTemplateId , but not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLaunchTemplateVersions.go b/service/ec2/api_op_DeleteLaunchTemplateVersions.go index ba3a71cc924..9f16047ab4c 100644 --- a/service/ec2/api_op_DeleteLaunchTemplateVersions.go +++ b/service/ec2/api_op_DeleteLaunchTemplateVersions.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more versions of a launch template. You cannot delete the default -// version of a launch template; you must first assign a different version as the -// default. If the default version is the only version for the launch template, you -// must delete the entire launch template using DeleteLaunchTemplate. +// Deletes one or more versions of a launch template. You cannot delete the +// default version of a launch template; you must first assign a different version +// as the default. If the default version is the only version for the launch +// template, you must delete the entire launch template using DeleteLaunchTemplate . func (c *Client) DeleteLaunchTemplateVersions(ctx context.Context, params *DeleteLaunchTemplateVersionsInput, optFns ...func(*Options)) (*DeleteLaunchTemplateVersionsOutput, error) { if params == nil { params = &DeleteLaunchTemplateVersionsInput{} @@ -39,16 +39,16 @@ type DeleteLaunchTemplateVersionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the launch template. You must specify either the LaunchTemplateId or - // the LaunchTemplateName, but not both. + // the LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify either the LaunchTemplateName - // or the LaunchTemplateId, but not both. + // or the LaunchTemplateId , but not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLocalGatewayRoute.go b/service/ec2/api_op_DeleteLocalGatewayRoute.go index d1a8254bd14..58d3619117a 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRoute.go +++ b/service/ec2/api_op_DeleteLocalGatewayRoute.go @@ -37,14 +37,14 @@ type DeleteLocalGatewayRouteInput struct { // The CIDR range for the route. This must match the CIDR for the route exactly. DestinationCidrBlock *string - // Use a prefix list in place of DestinationCidrBlock. You cannot use + // Use a prefix list in place of DestinationCidrBlock . You cannot use // DestinationPrefixListId and DestinationCidrBlock in the same request. DestinationPrefixListId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLocalGatewayRouteTable.go b/service/ec2/api_op_DeleteLocalGatewayRouteTable.go index ee8d8080df4..bc384d45468 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRouteTable.go +++ b/service/ec2/api_op_DeleteLocalGatewayRouteTable.go @@ -36,8 +36,8 @@ type DeleteLocalGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go b/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go index 35e145e34ec..90d45229ab6 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go +++ b/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go @@ -36,8 +36,8 @@ type DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLocalGatewayRouteTableVpcAssociation.go b/service/ec2/api_op_DeleteLocalGatewayRouteTableVpcAssociation.go index 1bef56f6814..7d8c054c284 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRouteTableVpcAssociation.go +++ b/service/ec2/api_op_DeleteLocalGatewayRouteTableVpcAssociation.go @@ -36,8 +36,8 @@ type DeleteLocalGatewayRouteTableVpcAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteManagedPrefixList.go b/service/ec2/api_op_DeleteManagedPrefixList.go index 09b5849faee..9067002f507 100644 --- a/service/ec2/api_op_DeleteManagedPrefixList.go +++ b/service/ec2/api_op_DeleteManagedPrefixList.go @@ -37,8 +37,8 @@ type DeleteManagedPrefixListInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNatGateway.go b/service/ec2/api_op_DeleteNatGateway.go index 1f2a9f21ae4..b45568ceb5d 100644 --- a/service/ec2/api_op_DeleteNatGateway.go +++ b/service/ec2/api_op_DeleteNatGateway.go @@ -38,8 +38,8 @@ type DeleteNatGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkAcl.go b/service/ec2/api_op_DeleteNetworkAcl.go index a831886809a..9f93fe2178e 100644 --- a/service/ec2/api_op_DeleteNetworkAcl.go +++ b/service/ec2/api_op_DeleteNetworkAcl.go @@ -36,8 +36,8 @@ type DeleteNetworkAclInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkAclEntry.go b/service/ec2/api_op_DeleteNetworkAclEntry.go index 84b84b2baa3..3a6e81055c6 100644 --- a/service/ec2/api_op_DeleteNetworkAclEntry.go +++ b/service/ec2/api_op_DeleteNetworkAclEntry.go @@ -46,8 +46,8 @@ type DeleteNetworkAclEntryInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInsightsAccessScope.go b/service/ec2/api_op_DeleteNetworkInsightsAccessScope.go index 4ee1601cc3c..f8618a011e0 100644 --- a/service/ec2/api_op_DeleteNetworkInsightsAccessScope.go +++ b/service/ec2/api_op_DeleteNetworkInsightsAccessScope.go @@ -35,8 +35,8 @@ type DeleteNetworkInsightsAccessScopeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInsightsAccessScopeAnalysis.go b/service/ec2/api_op_DeleteNetworkInsightsAccessScopeAnalysis.go index f5274a37310..dd9e7abec8c 100644 --- a/service/ec2/api_op_DeleteNetworkInsightsAccessScopeAnalysis.go +++ b/service/ec2/api_op_DeleteNetworkInsightsAccessScopeAnalysis.go @@ -35,8 +35,8 @@ type DeleteNetworkInsightsAccessScopeAnalysisInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInsightsAnalysis.go b/service/ec2/api_op_DeleteNetworkInsightsAnalysis.go index b695d001f3a..f98633a1319 100644 --- a/service/ec2/api_op_DeleteNetworkInsightsAnalysis.go +++ b/service/ec2/api_op_DeleteNetworkInsightsAnalysis.go @@ -35,8 +35,8 @@ type DeleteNetworkInsightsAnalysisInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInsightsPath.go b/service/ec2/api_op_DeleteNetworkInsightsPath.go index b94321bf8ba..a24b1fe232b 100644 --- a/service/ec2/api_op_DeleteNetworkInsightsPath.go +++ b/service/ec2/api_op_DeleteNetworkInsightsPath.go @@ -35,8 +35,8 @@ type DeleteNetworkInsightsPathInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInterface.go b/service/ec2/api_op_DeleteNetworkInterface.go index b96b187c8ef..0c4790b2ba7 100644 --- a/service/ec2/api_op_DeleteNetworkInterface.go +++ b/service/ec2/api_op_DeleteNetworkInterface.go @@ -37,8 +37,8 @@ type DeleteNetworkInterfaceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteNetworkInterfacePermission.go b/service/ec2/api_op_DeleteNetworkInterfacePermission.go index 807a76c969d..1c9f11e3029 100644 --- a/service/ec2/api_op_DeleteNetworkInterfacePermission.go +++ b/service/ec2/api_op_DeleteNetworkInterfacePermission.go @@ -39,8 +39,8 @@ type DeleteNetworkInterfacePermissionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specify true to remove the permission even if the network interface is attached diff --git a/service/ec2/api_op_DeletePlacementGroup.go b/service/ec2/api_op_DeletePlacementGroup.go index a8eead5b407..37bfe4da315 100644 --- a/service/ec2/api_op_DeletePlacementGroup.go +++ b/service/ec2/api_op_DeletePlacementGroup.go @@ -12,9 +12,8 @@ import ( // Deletes the specified placement group. You must terminate all instances in the // placement group before you can delete the placement group. For more information, -// see Placement groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in -// the Amazon EC2 User Guide. +// see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) +// in the Amazon EC2 User Guide. func (c *Client) DeletePlacementGroup(ctx context.Context, params *DeletePlacementGroupInput, optFns ...func(*Options)) (*DeletePlacementGroupOutput, error) { if params == nil { params = &DeletePlacementGroupInput{} @@ -39,8 +38,8 @@ type DeletePlacementGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeletePublicIpv4Pool.go b/service/ec2/api_op_DeletePublicIpv4Pool.go index f6ca4f89884..5890271a2cb 100644 --- a/service/ec2/api_op_DeletePublicIpv4Pool.go +++ b/service/ec2/api_op_DeletePublicIpv4Pool.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required -// for the public IPv4 CIDRs that you own and bring to Amazon Web Services to -// manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use -// IPAM pools only. +// Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool +// required for the public IPv4 CIDRs that you own and bring to Amazon Web Services +// to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, +// use IPAM pools only. func (c *Client) DeletePublicIpv4Pool(ctx context.Context, params *DeletePublicIpv4PoolInput, optFns ...func(*Options)) (*DeletePublicIpv4PoolOutput, error) { if params == nil { params = &DeletePublicIpv4PoolInput{} @@ -38,8 +38,8 @@ type DeletePublicIpv4PoolInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteQueuedReservedInstances.go b/service/ec2/api_op_DeleteQueuedReservedInstances.go index d3a527fb817..6a8bf3bcd2b 100644 --- a/service/ec2/api_op_DeleteQueuedReservedInstances.go +++ b/service/ec2/api_op_DeleteQueuedReservedInstances.go @@ -36,8 +36,8 @@ type DeleteQueuedReservedInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteRoute.go b/service/ec2/api_op_DeleteRoute.go index b9ca73a0a0f..105cd11a6fa 100644 --- a/service/ec2/api_op_DeleteRoute.go +++ b/service/ec2/api_op_DeleteRoute.go @@ -33,12 +33,12 @@ type DeleteRouteInput struct { // This member is required. RouteTableId *string - // The IPv4 CIDR range for the route. The value you specify must match the CIDR for - // the route exactly. + // The IPv4 CIDR range for the route. The value you specify must match the CIDR + // for the route exactly. DestinationCidrBlock *string - // The IPv6 CIDR range for the route. The value you specify must match the CIDR for - // the route exactly. + // The IPv6 CIDR range for the route. The value you specify must match the CIDR + // for the route exactly. DestinationIpv6CidrBlock *string // The ID of the prefix list for the route. @@ -46,8 +46,8 @@ type DeleteRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteRouteTable.go b/service/ec2/api_op_DeleteRouteTable.go index ab5cb9cffe0..26aff477ceb 100644 --- a/service/ec2/api_op_DeleteRouteTable.go +++ b/service/ec2/api_op_DeleteRouteTable.go @@ -36,8 +36,8 @@ type DeleteRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteSecurityGroup.go b/service/ec2/api_op_DeleteSecurityGroup.go index c05be2cf5e1..ba181429a9d 100644 --- a/service/ec2/api_op_DeleteSecurityGroup.go +++ b/service/ec2/api_op_DeleteSecurityGroup.go @@ -12,8 +12,8 @@ import ( // Deletes a security group. If you attempt to delete a security group that is // associated with an instance, or is referenced by another security group, the -// operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in -// EC2-VPC. We are retiring EC2-Classic. We recommend that you migrate from +// operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation +// in EC2-VPC. We are retiring EC2-Classic. We recommend that you migrate from // EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a // VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in // the Amazon Elastic Compute Cloud User Guide. @@ -36,8 +36,8 @@ type DeleteSecurityGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the security group. Required for a nondefault VPC. diff --git a/service/ec2/api_op_DeleteSnapshot.go b/service/ec2/api_op_DeleteSnapshot.go index 111ce40b217..18ce399eb75 100644 --- a/service/ec2/api_op_DeleteSnapshot.go +++ b/service/ec2/api_op_DeleteSnapshot.go @@ -18,8 +18,7 @@ import ( // have access to all the information needed to restore the volume. You cannot // delete a snapshot of the root device of an EBS volume used by a registered AMI. // You must first de-register the AMI before you can delete the snapshot. For more -// information, see Delete an Amazon EBS snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html) +// information, see Delete an Amazon EBS snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error) { if params == nil { @@ -45,8 +44,8 @@ type DeleteSnapshotInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteSpotDatafeedSubscription.go b/service/ec2/api_op_DeleteSpotDatafeedSubscription.go index 35491109697..be0e23cf341 100644 --- a/service/ec2/api_op_DeleteSpotDatafeedSubscription.go +++ b/service/ec2/api_op_DeleteSpotDatafeedSubscription.go @@ -31,8 +31,8 @@ type DeleteSpotDatafeedSubscriptionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteSubnet.go b/service/ec2/api_op_DeleteSubnet.go index 05c69654a29..a844283fdb5 100644 --- a/service/ec2/api_op_DeleteSubnet.go +++ b/service/ec2/api_op_DeleteSubnet.go @@ -36,8 +36,8 @@ type DeleteSubnetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteSubnetCidrReservation.go b/service/ec2/api_op_DeleteSubnetCidrReservation.go index 4b964f2b0a3..98d4c7a3475 100644 --- a/service/ec2/api_op_DeleteSubnetCidrReservation.go +++ b/service/ec2/api_op_DeleteSubnetCidrReservation.go @@ -36,8 +36,8 @@ type DeleteSubnetCidrReservationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTags.go b/service/ec2/api_op_DeleteTags.go index f9f2e7ba799..640d47270b7 100644 --- a/service/ec2/api_op_DeleteTags.go +++ b/service/ec2/api_op_DeleteTags.go @@ -12,10 +12,9 @@ import ( ) // Deletes the specified set of tags from the specified set of resources. To list -// the current tags, use DescribeTags. For more information about tags, see Tag -// your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon Elastic Compute Cloud User Guide. +// the current tags, use DescribeTags . For more information about tags, see Tag +// your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error) { if params == nil { params = &DeleteTagsInput{} @@ -41,8 +40,8 @@ type DeleteTagsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to delete. Specify a tag key and an optional tag value to delete diff --git a/service/ec2/api_op_DeleteTrafficMirrorFilter.go b/service/ec2/api_op_DeleteTrafficMirrorFilter.go index 458225cec39..c94e94f82e1 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorFilter.go +++ b/service/ec2/api_op_DeleteTrafficMirrorFilter.go @@ -36,8 +36,8 @@ type DeleteTrafficMirrorFilterInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTrafficMirrorFilterRule.go b/service/ec2/api_op_DeleteTrafficMirrorFilterRule.go index b52ea71c158..6ce54e46557 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_DeleteTrafficMirrorFilterRule.go @@ -35,8 +35,8 @@ type DeleteTrafficMirrorFilterRuleInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTrafficMirrorSession.go b/service/ec2/api_op_DeleteTrafficMirrorSession.go index cc0247bcb8d..209db558d87 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorSession.go +++ b/service/ec2/api_op_DeleteTrafficMirrorSession.go @@ -35,8 +35,8 @@ type DeleteTrafficMirrorSessionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTrafficMirrorTarget.go b/service/ec2/api_op_DeleteTrafficMirrorTarget.go index 14137c9bc11..f653fcde196 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorTarget.go +++ b/service/ec2/api_op_DeleteTrafficMirrorTarget.go @@ -36,8 +36,8 @@ type DeleteTrafficMirrorTargetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGateway.go b/service/ec2/api_op_DeleteTransitGateway.go index 5af86cf22cd..c113a20e08e 100644 --- a/service/ec2/api_op_DeleteTransitGateway.go +++ b/service/ec2/api_op_DeleteTransitGateway.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayConnect.go b/service/ec2/api_op_DeleteTransitGatewayConnect.go index 4434a59bd79..85e019efe69 100644 --- a/service/ec2/api_op_DeleteTransitGatewayConnect.go +++ b/service/ec2/api_op_DeleteTransitGatewayConnect.go @@ -37,8 +37,8 @@ type DeleteTransitGatewayConnectInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayConnectPeer.go b/service/ec2/api_op_DeleteTransitGatewayConnectPeer.go index 9b233a0dd4b..b9314a56e45 100644 --- a/service/ec2/api_op_DeleteTransitGatewayConnectPeer.go +++ b/service/ec2/api_op_DeleteTransitGatewayConnectPeer.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayConnectPeerInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go b/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go index 0a12c818c4a..292ddf85477 100644 --- a/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_DeleteTransitGatewayMulticastDomain.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayMulticastDomainInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayPeeringAttachment.go b/service/ec2/api_op_DeleteTransitGatewayPeeringAttachment.go index 76723e8df18..33c8bd150cb 100644 --- a/service/ec2/api_op_DeleteTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_DeleteTransitGatewayPeeringAttachment.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayPeeringAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayPolicyTable.go b/service/ec2/api_op_DeleteTransitGatewayPolicyTable.go index b199f0aeb53..6eee081fcc5 100644 --- a/service/ec2/api_op_DeleteTransitGatewayPolicyTable.go +++ b/service/ec2/api_op_DeleteTransitGatewayPolicyTable.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayPolicyTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayPrefixListReference.go b/service/ec2/api_op_DeleteTransitGatewayPrefixListReference.go index 297a62cd2ca..422228a9c3b 100644 --- a/service/ec2/api_op_DeleteTransitGatewayPrefixListReference.go +++ b/service/ec2/api_op_DeleteTransitGatewayPrefixListReference.go @@ -42,8 +42,8 @@ type DeleteTransitGatewayPrefixListReferenceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayRoute.go b/service/ec2/api_op_DeleteTransitGatewayRoute.go index f80404fa764..a082387c91c 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRoute.go +++ b/service/ec2/api_op_DeleteTransitGatewayRoute.go @@ -41,8 +41,8 @@ type DeleteTransitGatewayRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go index 293754c5d34..43712fd66a2 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go +++ b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go @@ -37,8 +37,8 @@ type DeleteTransitGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayRouteTableAnnouncement.go b/service/ec2/api_op_DeleteTransitGatewayRouteTableAnnouncement.go index af72189ac44..8a684843ca9 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRouteTableAnnouncement.go +++ b/service/ec2/api_op_DeleteTransitGatewayRouteTableAnnouncement.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayRouteTableAnnouncementInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTransitGatewayVpcAttachment.go b/service/ec2/api_op_DeleteTransitGatewayVpcAttachment.go index 7539cd207e4..0841b8db328 100644 --- a/service/ec2/api_op_DeleteTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_DeleteTransitGatewayVpcAttachment.go @@ -36,8 +36,8 @@ type DeleteTransitGatewayVpcAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go b/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go index db9230e9f35..02cd3a8ea16 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go @@ -36,14 +36,14 @@ type DeleteVerifiedAccessEndpointInput struct { VerifiedAccessEndpointId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVerifiedAccessGroup.go b/service/ec2/api_op_DeleteVerifiedAccessGroup.go index 82dc6f7a452..e1a020ad189 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessGroup.go +++ b/service/ec2/api_op_DeleteVerifiedAccessGroup.go @@ -36,14 +36,14 @@ type DeleteVerifiedAccessGroupInput struct { VerifiedAccessGroupId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVerifiedAccessInstance.go b/service/ec2/api_op_DeleteVerifiedAccessInstance.go index 0c819ebff78..260d50f308a 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessInstance.go +++ b/service/ec2/api_op_DeleteVerifiedAccessInstance.go @@ -36,14 +36,14 @@ type DeleteVerifiedAccessInstanceInput struct { VerifiedAccessInstanceId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go b/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go index a1350fd8b46..8f4f2e9c31f 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go @@ -36,14 +36,14 @@ type DeleteVerifiedAccessTrustProviderInput struct { VerifiedAccessTrustProviderId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVolume.go b/service/ec2/api_op_DeleteVolume.go index 9c132308aae..aeabd7c763b 100644 --- a/service/ec2/api_op_DeleteVolume.go +++ b/service/ec2/api_op_DeleteVolume.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified EBS volume. The volume must be in the available state (not -// attached to an instance). The volume can remain in the deleting state for -// several minutes. For more information, see Delete an Amazon EBS volume -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html) +// Deletes the specified EBS volume. The volume must be in the available state +// (not attached to an instance). The volume can remain in the deleting state for +// several minutes. For more information, see Delete an Amazon EBS volume (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type DeleteVolumeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpc.go b/service/ec2/api_op_DeleteVpc.go index 8dfd60a7f3c..f4c783d7ca9 100644 --- a/service/ec2/api_op_DeleteVpc.go +++ b/service/ec2/api_op_DeleteVpc.go @@ -39,8 +39,8 @@ type DeleteVpcInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go b/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go index 31fca069db1..5d27ec95e47 100644 --- a/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go +++ b/service/ec2/api_op_DeleteVpcEndpointConnectionNotifications.go @@ -36,8 +36,8 @@ type DeleteVpcEndpointConnectionNotificationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpcEndpointServiceConfigurations.go b/service/ec2/api_op_DeleteVpcEndpointServiceConfigurations.go index 8bfde81742b..3e60f344658 100644 --- a/service/ec2/api_op_DeleteVpcEndpointServiceConfigurations.go +++ b/service/ec2/api_op_DeleteVpcEndpointServiceConfigurations.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified VPC endpoint service configurations. Before you can delete -// an endpoint service configuration, you must reject any Available or +// Deletes the specified VPC endpoint service configurations. Before you can +// delete an endpoint service configuration, you must reject any Available or // PendingAcceptance interface endpoint connections that are attached to the // service. func (c *Client) DeleteVpcEndpointServiceConfigurations(ctx context.Context, params *DeleteVpcEndpointServiceConfigurationsInput, optFns ...func(*Options)) (*DeleteVpcEndpointServiceConfigurationsOutput, error) { @@ -39,8 +39,8 @@ type DeleteVpcEndpointServiceConfigurationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpcEndpoints.go b/service/ec2/api_op_DeleteVpcEndpoints.go index 7dcf819b599..4701053bf99 100644 --- a/service/ec2/api_op_DeleteVpcEndpoints.go +++ b/service/ec2/api_op_DeleteVpcEndpoints.go @@ -41,8 +41,8 @@ type DeleteVpcEndpointsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpcPeeringConnection.go b/service/ec2/api_op_DeleteVpcPeeringConnection.go index 935a5fdaad8..302d280d798 100644 --- a/service/ec2/api_op_DeleteVpcPeeringConnection.go +++ b/service/ec2/api_op_DeleteVpcPeeringConnection.go @@ -39,8 +39,8 @@ type DeleteVpcPeeringConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpnConnection.go b/service/ec2/api_op_DeleteVpnConnection.go index 89702e4d663..4187f1159a2 100644 --- a/service/ec2/api_op_DeleteVpnConnection.go +++ b/service/ec2/api_op_DeleteVpnConnection.go @@ -46,8 +46,8 @@ type DeleteVpnConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteVpnGateway.go b/service/ec2/api_op_DeleteVpnGateway.go index f546dbecdaf..3680a15e0d2 100644 --- a/service/ec2/api_op_DeleteVpnGateway.go +++ b/service/ec2/api_op_DeleteVpnGateway.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified virtual private gateway. You must first detach the virtual -// private gateway from the VPC. Note that you don't need to delete the virtual -// private gateway if you plan to delete and recreate the VPN connection between -// your VPC and your network. +// Deletes the specified virtual private gateway. You must first detach the +// virtual private gateway from the VPC. Note that you don't need to delete the +// virtual private gateway if you plan to delete and recreate the VPN connection +// between your VPC and your network. func (c *Client) DeleteVpnGateway(ctx context.Context, params *DeleteVpnGatewayInput, optFns ...func(*Options)) (*DeleteVpnGatewayOutput, error) { if params == nil { params = &DeleteVpnGatewayInput{} @@ -39,8 +39,8 @@ type DeleteVpnGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeprovisionByoipCidr.go b/service/ec2/api_op_DeprovisionByoipCidr.go index a018e4ec944..b463d0ac5cb 100644 --- a/service/ec2/api_op_DeprovisionByoipCidr.go +++ b/service/ec2/api_op_DeprovisionByoipCidr.go @@ -33,16 +33,16 @@ func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionBy type DeprovisionByoipCidrInput struct { - // The address range, in CIDR notation. The prefix must be the same prefix that you - // specified when you provisioned the address range. + // The address range, in CIDR notation. The prefix must be the same prefix that + // you specified when you provisioned the address range. // // This member is required. Cidr *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeprovisionIpamPoolCidr.go b/service/ec2/api_op_DeprovisionIpamPoolCidr.go index 503ac9c8beb..35d28a3d463 100644 --- a/service/ec2/api_op_DeprovisionIpamPoolCidr.go +++ b/service/ec2/api_op_DeprovisionIpamPoolCidr.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from -// a pool that has a source pool, the CIDR is recycled back into the source pool. -// For more information, see Deprovision pool CIDRs -// (https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html) in the -// Amazon VPC IPAM User Guide. +// Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR +// from a pool that has a source pool, the CIDR is recycled back into the source +// pool. For more information, see Deprovision pool CIDRs (https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) DeprovisionIpamPoolCidr(ctx context.Context, params *DeprovisionIpamPoolCidrInput, optFns ...func(*Options)) (*DeprovisionIpamPoolCidrOutput, error) { if params == nil { params = &DeprovisionIpamPoolCidrInput{} @@ -43,8 +42,8 @@ type DeprovisionIpamPoolCidrInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeprovisionPublicIpv4PoolCidr.go b/service/ec2/api_op_DeprovisionPublicIpv4PoolCidr.go index 24fbaabd0a1..b92b131aeb3 100644 --- a/service/ec2/api_op_DeprovisionPublicIpv4PoolCidr.go +++ b/service/ec2/api_op_DeprovisionPublicIpv4PoolCidr.go @@ -29,8 +29,8 @@ func (c *Client) DeprovisionPublicIpv4PoolCidr(ctx context.Context, params *Depr type DeprovisionPublicIpv4PoolCidrInput struct { // The CIDR you want to deprovision from the pool. Enter the CIDR you want to - // deprovision with a netmask of /32. You must rerun this command for each IP - // address in the CIDR range. If your CIDR is a /24, you will have to run this + // deprovision with a netmask of /32 . You must rerun this command for each IP + // address in the CIDR range. If your CIDR is a /24 , you will have to run this // command to deprovision each of the 256 IP addresses in the /24 CIDR. // // This member is required. @@ -43,8 +43,8 @@ type DeprovisionPublicIpv4PoolCidrInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeregisterImage.go b/service/ec2/api_op_DeregisterImage.go index 819356386ed..b7fe3fe3b36 100644 --- a/service/ec2/api_op_DeregisterImage.go +++ b/service/ec2/api_op_DeregisterImage.go @@ -13,9 +13,8 @@ import ( // Deregisters the specified AMI. After you deregister an AMI, it can't be used to // launch new instances. If you deregister an AMI that matches a Recycle Bin // retention rule, the AMI is retained in the Recycle Bin for the specified -// retention period. For more information, see Recycle Bin -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the -// Amazon EC2 User Guide. When you deregister an AMI, it doesn't affect any +// retention period. For more information, see Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) +// in the Amazon EC2 User Guide. When you deregister an AMI, it doesn't affect any // instances that you've already launched from the AMI. You'll continue to incur // usage costs for those instances until you terminate them. When you deregister an // Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the @@ -47,8 +46,8 @@ type DeregisterImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go b/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go index 94b4a0fef49..1da03f4fda1 100644 --- a/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go +++ b/service/ec2/api_op_DeregisterInstanceEventNotificationAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregisters tag keys to prevent tags that have the specified tag keys from being -// included in scheduled event notifications for resources in the Region. +// Deregisters tag keys to prevent tags that have the specified tag keys from +// being included in scheduled event notifications for resources in the Region. func (c *Client) DeregisterInstanceEventNotificationAttributes(ctx context.Context, params *DeregisterInstanceEventNotificationAttributesInput, optFns ...func(*Options)) (*DeregisterInstanceEventNotificationAttributesOutput, error) { if params == nil { params = &DeregisterInstanceEventNotificationAttributesInput{} @@ -32,8 +32,8 @@ type DeregisterInstanceEventNotificationAttributesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Information about the tag keys to deregister. diff --git a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupMembers.go b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupMembers.go index cb21a50b82d..b0ab93ea1f5 100644 --- a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupMembers.go +++ b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupMembers.go @@ -32,8 +32,8 @@ type DeregisterTransitGatewayMulticastGroupMembersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address assigned to the transit gateway multicast group. diff --git a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go index aeac236a546..aebdfcf4ca9 100644 --- a/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go +++ b/service/ec2/api_op_DeregisterTransitGatewayMulticastGroupSources.go @@ -32,8 +32,8 @@ type DeregisterTransitGatewayMulticastGroupSourcesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address assigned to the transit gateway multicast group. diff --git a/service/ec2/api_op_DescribeAccountAttributes.go b/service/ec2/api_op_DescribeAccountAttributes.go index f22c449c4c2..85b5b3c6ec6 100644 --- a/service/ec2/api_op_DescribeAccountAttributes.go +++ b/service/ec2/api_op_DescribeAccountAttributes.go @@ -13,36 +13,24 @@ import ( // Describes attributes of your Amazon Web Services account. The following are the // supported account attributes: +// - supported-platforms : Indicates whether your account can launch instances +// into EC2-Classic and EC2-VPC, or only into EC2-VPC. +// - default-vpc : The ID of the default VPC for your account, or none . +// - max-instances : This attribute is no longer supported. The returned value +// does not reflect your actual vCPU limit for running On-Demand Instances. For +// more information, see On-Demand Instance Limits (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-on-demand-instances.html#ec2-on-demand-instances-limits) +// in the Amazon Elastic Compute Cloud User Guide. +// - vpc-max-security-groups-per-interface : The maximum number of security +// groups that you can assign to a network interface. +// - max-elastic-ips : The maximum number of Elastic IP addresses that you can +// allocate for use with EC2-Classic. +// - vpc-max-elastic-ips : The maximum number of Elastic IP addresses that you +// can allocate for use with EC2-VPC. // -// * supported-platforms: Indicates whether your -// account can launch instances into EC2-Classic and EC2-VPC, or only into -// EC2-VPC. -// -// * default-vpc: The ID of the default VPC for your account, or none. -// -// * -// max-instances: This attribute is no longer supported. The returned value does -// not reflect your actual vCPU limit for running On-Demand Instances. For more -// information, see On-Demand Instance Limits -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-on-demand-instances.html#ec2-on-demand-instances-limits) -// in the Amazon Elastic Compute Cloud User Guide. -// -// * -// vpc-max-security-groups-per-interface: The maximum number of security groups -// that you can assign to a network interface. -// -// * max-elastic-ips: The maximum -// number of Elastic IP addresses that you can allocate for use with -// EC2-Classic. -// -// * vpc-max-elastic-ips: The maximum number of Elastic IP addresses -// that you can allocate for use with EC2-VPC. -// -// We are retiring EC2-Classic on -// August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For -// more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide. +// We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate +// from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic +// to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} @@ -65,8 +53,8 @@ type DescribeAccountAttributesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeAddressTransfers.go b/service/ec2/api_op_DescribeAddressTransfers.go index 8f3b5f95ac3..8cfb2425dab 100644 --- a/service/ec2/api_op_DescribeAddressTransfers.go +++ b/service/ec2/api_op_DescribeAddressTransfers.go @@ -13,8 +13,7 @@ import ( ) // Describes an Elastic IP address transfer. For more information, see Transfer -// Elastic IP addresses -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) +// Elastic IP addresses (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) DescribeAddressTransfers(ctx context.Context, params *DescribeAddressTransfersInput, optFns ...func(*Options)) (*DescribeAddressTransfersOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type DescribeAddressTransfersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of address transfers to return in one page of results. diff --git a/service/ec2/api_op_DescribeAddresses.go b/service/ec2/api_op_DescribeAddresses.go index 0f27bd01f6c..896e7f806f5 100644 --- a/service/ec2/api_op_DescribeAddresses.go +++ b/service/ec2/api_op_DescribeAddresses.go @@ -13,13 +13,11 @@ import ( // Describes the specified Elastic IP addresses or all of your Elastic IP // addresses. An Elastic IP address is for use in either the EC2-Classic platform -// or in a VPC. For more information, see Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// or in a VPC. For more information, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. We are retiring EC2-Classic. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeAddresses(ctx context.Context, params *DescribeAddressesInput, optFns ...func(*Options)) (*DescribeAddressesOutput, error) { if params == nil { params = &DescribeAddressesInput{} @@ -42,50 +40,31 @@ type DescribeAddressesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * - // allocation-id - [EC2-VPC] The allocation ID for the address. - // - // * association-id - - // [EC2-VPC] The association ID for the address. - // - // * domain - Indicates whether the - // address is for use in EC2-Classic (standard) or in a VPC (vpc). - // - // * instance-id - - // The ID of the instance the address is associated with, if any. - // - // * - // network-border-group - A unique set of Availability Zones, Local Zones, or - // Wavelength Zones from where Amazon Web Services advertises IP addresses. - // - // * - // network-interface-id - [EC2-VPC] The ID of the network interface that the - // address is associated with, if any. - // - // * network-interface-owner-id - The Amazon - // Web Services account ID of the owner. - // - // * private-ip-address - [EC2-VPC] The - // private IP address associated with the Elastic IP address. - // - // * public-ip - The - // Elastic IP address, or the carrier IP address. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. + // - allocation-id - [EC2-VPC] The allocation ID for the address. + // - association-id - [EC2-VPC] The association ID for the address. + // - domain - Indicates whether the address is for use in EC2-Classic ( standard + // ) or in a VPC ( vpc ). + // - instance-id - The ID of the instance the address is associated with, if any. + // - network-border-group - A unique set of Availability Zones, Local Zones, or + // Wavelength Zones from where Amazon Web Services advertises IP addresses. + // - network-interface-id - [EC2-VPC] The ID of the network interface that the + // address is associated with, if any. + // - network-interface-owner-id - The Amazon Web Services account ID of the + // owner. + // - private-ip-address - [EC2-VPC] The private IP address associated with the + // Elastic IP address. + // - public-ip - The Elastic IP address, or the carrier IP address. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // One or more Elastic IP addresses. Default: Describes all your Elastic IP diff --git a/service/ec2/api_op_DescribeAddressesAttribute.go b/service/ec2/api_op_DescribeAddressesAttribute.go index 9359dbd5159..618a043adfc 100644 --- a/service/ec2/api_op_DescribeAddressesAttribute.go +++ b/service/ec2/api_op_DescribeAddressesAttribute.go @@ -13,8 +13,8 @@ import ( ) // Describes the attributes of the specified Elastic IP addresses. For -// requirements, see Using reverse DNS for email applications -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS). +// requirements, see Using reverse DNS for email applications (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS) +// . func (c *Client) DescribeAddressesAttribute(ctx context.Context, params *DescribeAddressesAttributeInput, optFns ...func(*Options)) (*DescribeAddressesAttributeOutput, error) { if params == nil { params = &DescribeAddressesAttributeInput{} @@ -40,8 +40,8 @@ type DescribeAddressesAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeAggregateIdFormat.go b/service/ec2/api_op_DescribeAggregateIdFormat.go index b16b41eb441..f6ac50e5bb2 100644 --- a/service/ec2/api_op_DescribeAggregateIdFormat.go +++ b/service/ec2/api_op_DescribeAggregateIdFormat.go @@ -22,7 +22,7 @@ import ( // network-interface-attachment | prefix-list | reservation | route-table | // route-table-association | security-group | snapshot | subnet | // subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | -// vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. +// vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway . func (c *Client) DescribeAggregateIdFormat(ctx context.Context, params *DescribeAggregateIdFormatInput, optFns ...func(*Options)) (*DescribeAggregateIdFormatOutput, error) { if params == nil { params = &DescribeAggregateIdFormatInput{} @@ -42,8 +42,8 @@ type DescribeAggregateIdFormatInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeAvailabilityZones.go b/service/ec2/api_op_DescribeAvailabilityZones.go index 985ceae7279..c5413726320 100644 --- a/service/ec2/api_op_DescribeAvailabilityZones.go +++ b/service/ec2/api_op_DescribeAvailabilityZones.go @@ -15,8 +15,7 @@ import ( // available to you. If there is an event impacting a zone, you can use this // request to view the state and any provided messages for that zone. For more // information about Availability Zones, Local Zones, and Wavelength Zones, see -// Regions and zones -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) +// Regions and zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeAvailabilityZones(ctx context.Context, params *DescribeAvailabilityZonesInput, optFns ...func(*Options)) (*DescribeAvailabilityZonesOutput, error) { if params == nil { @@ -42,48 +41,33 @@ type DescribeAvailabilityZonesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * group-name - For Availability Zones, use the Region name. For - // Local Zones, use the name of the group associated with the Local Zone (for - // example, us-west-2-lax-1) For Wavelength Zones, use the name of the group - // associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). - // - // * - // message - The Zone message. - // - // * opt-in-status - The opt-in status (opted-in | - // not-opted-in | opt-in-not-required). - // - // * parent-zoneID - The ID of the zone that - // handles some of the Local Zone and Wavelength Zone control plane operations, - // such as API calls. - // - // * parent-zoneName - The ID of the zone that handles some of - // the Local Zone and Wavelength Zone control plane operations, such as API - // calls. - // - // * region-name - The name of the Region for the Zone (for example, - // us-east-1). - // - // * state - The state of the Availability Zone, the Local Zone, or - // the Wavelength Zone (available). - // - // * zone-id - The ID of the Availability Zone - // (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the - // Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). - // - // * zone-name - The name - // of the Availability Zone (for example, us-east-1a), the Local Zone (for example, - // us-west-2-lax-1a), or the Wavelength Zone (for example, - // us-east-1-wl1-bos-wlz-1). - // - // * zone-type - The type of zone (availability-zone | - // local-zone | wavelength-zone). + // - group-name - For Availability Zones, use the Region name. For Local Zones, + // use the name of the group associated with the Local Zone (for example, + // us-west-2-lax-1 ) For Wavelength Zones, use the name of the group associated + // with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1 ). + // - message - The Zone message. + // - opt-in-status - The opt-in status ( opted-in | not-opted-in | + // opt-in-not-required ). + // - parent-zoneID - The ID of the zone that handles some of the Local Zone and + // Wavelength Zone control plane operations, such as API calls. + // - parent-zoneName - The ID of the zone that handles some of the Local Zone and + // Wavelength Zone control plane operations, such as API calls. + // - region-name - The name of the Region for the Zone (for example, us-east-1 ). + // - state - The state of the Availability Zone, the Local Zone, or the + // Wavelength Zone ( available ). + // - zone-id - The ID of the Availability Zone (for example, use1-az1 ), the + // Local Zone (for example, usw2-lax1-az1 ), or the Wavelength Zone (for example, + // us-east-1-wl1-bos-wlz-1 ). + // - zone-name - The name of the Availability Zone (for example, us-east-1a ), + // the Local Zone (for example, us-west-2-lax-1a ), or the Wavelength Zone (for + // example, us-east-1-wl1-bos-wlz-1 ). + // - zone-type - The type of zone ( availability-zone | local-zone | + // wavelength-zone ). Filters []types.Filter // The IDs of the Availability Zones, Local Zones, and Wavelength Zones. diff --git a/service/ec2/api_op_DescribeAwsNetworkPerformanceMetricSubscriptions.go b/service/ec2/api_op_DescribeAwsNetworkPerformanceMetricSubscriptions.go index e312737c7b4..7d11bb0d866 100644 --- a/service/ec2/api_op_DescribeAwsNetworkPerformanceMetricSubscriptions.go +++ b/service/ec2/api_op_DescribeAwsNetworkPerformanceMetricSubscriptions.go @@ -32,8 +32,8 @@ type DescribeAwsNetworkPerformanceMetricSubscriptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. diff --git a/service/ec2/api_op_DescribeBundleTasks.go b/service/ec2/api_op_DescribeBundleTasks.go index 7c6f9d7eb6c..577b9f287a9 100644 --- a/service/ec2/api_op_DescribeBundleTasks.go +++ b/service/ec2/api_op_DescribeBundleTasks.go @@ -43,39 +43,23 @@ type DescribeBundleTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * bundle-id - The ID of the bundle task. - // - // * error-code - If the - // task failed, the error code returned. - // - // * error-message - If the task failed, the - // error message returned. - // - // * instance-id - The ID of the instance. - // - // * progress - - // The level of task completion, as a percentage (for example, 20%). - // - // * s3-bucket - - // The Amazon S3 bucket to store the AMI. - // - // * s3-prefix - The beginning of the AMI - // name. - // - // * start-time - The time the task started (for example, - // 2013-09-15T17:15:20.000Z). - // - // * state - The state of the task (pending | - // waiting-for-shutdown | bundling | storing | cancelling | complete | failed). - // - // * - // update-time - The time of the most recent update for the task. + // - bundle-id - The ID of the bundle task. + // - error-code - If the task failed, the error code returned. + // - error-message - If the task failed, the error message returned. + // - instance-id - The ID of the instance. + // - progress - The level of task completion, as a percentage (for example, 20%). + // - s3-bucket - The Amazon S3 bucket to store the AMI. + // - s3-prefix - The beginning of the AMI name. + // - start-time - The time the task started (for example, + // 2013-09-15T17:15:20.000Z). + // - state - The state of the task ( pending | waiting-for-shutdown | bundling | + // storing | cancelling | complete | failed ). + // - update-time - The time of the most recent update for the task. Filters []types.Filter noSmithyDocumentSerde @@ -152,8 +136,8 @@ func (c *Client) addOperationDescribeBundleTasksMiddlewares(stack *middleware.St return nil } -// DescribeBundleTasksAPIClient is a client that implements the DescribeBundleTasks -// operation. +// DescribeBundleTasksAPIClient is a client that implements the +// DescribeBundleTasks operation. type DescribeBundleTasksAPIClient interface { DescribeBundleTasks(context.Context, *DescribeBundleTasksInput, ...func(*Options)) (*DescribeBundleTasksOutput, error) } @@ -173,8 +157,8 @@ type BundleTaskCompleteWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BundleTaskCompleteWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BundleTaskCompleteWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/ec2/api_op_DescribeByoipCidrs.go b/service/ec2/api_op_DescribeByoipCidrs.go index fb694cc6bd0..333553fde2a 100644 --- a/service/ec2/api_op_DescribeByoipCidrs.go +++ b/service/ec2/api_op_DescribeByoipCidrs.go @@ -13,9 +13,9 @@ import ( ) // Describes the IP address ranges that were specified in calls to -// ProvisionByoipCidr. To describe the address pools that were created when you -// provisioned the address ranges, use DescribePublicIpv4Pools or -// DescribeIpv6Pools. +// ProvisionByoipCidr . To describe the address pools that were created when you +// provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools +// . func (c *Client) DescribeByoipCidrs(ctx context.Context, params *DescribeByoipCidrsInput, optFns ...func(*Options)) (*DescribeByoipCidrsOutput, error) { if params == nil { params = &DescribeByoipCidrsInput{} @@ -41,8 +41,8 @@ type DescribeByoipCidrsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The token for the next page of results. diff --git a/service/ec2/api_op_DescribeCapacityReservationFleets.go b/service/ec2/api_op_DescribeCapacityReservationFleets.go index 59d104e2ee9..65ae66a77d3 100644 --- a/service/ec2/api_op_DescribeCapacityReservationFleets.go +++ b/service/ec2/api_op_DescribeCapacityReservationFleets.go @@ -35,24 +35,18 @@ type DescribeCapacityReservationFleetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * state - The state of the Fleet (submitted | modifying | - // active | partially_fulfilled | expiring | expired | cancelling | cancelled | - // failed). - // - // * instance-match-criteria - The instance matching criteria for the - // Fleet. Only open is supported. - // - // * tenancy - The tenancy of the Fleet (default | - // dedicated). - // - // * allocation-strategy - The allocation strategy used by the Fleet. - // Only prioritized is supported. + // - state - The state of the Fleet ( submitted | modifying | active | + // partially_fulfilled | expiring | expired | cancelling | cancelled | failed ). + // - instance-match-criteria - The instance matching criteria for the Fleet. Only + // open is supported. + // - tenancy - The tenancy of the Fleet ( default | dedicated ). + // - allocation-strategy - The allocation strategy used by the Fleet. Only + // prioritized is supported. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeCapacityReservations.go b/service/ec2/api_op_DescribeCapacityReservations.go index c23dcbfb0a3..ad1e25701db 100644 --- a/service/ec2/api_op_DescribeCapacityReservations.go +++ b/service/ec2/api_op_DescribeCapacityReservations.go @@ -37,97 +37,64 @@ type DescribeCapacityReservationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * instance-type - The type of instance for which the - // Capacity Reservation reserves capacity. - // - // * owner-id - The ID of the Amazon Web - // Services account that owns the Capacity Reservation. - // - // * instance-platform - The - // type of operating system for which the Capacity Reservation reserves - // capacity. - // - // * availability-zone - The Availability Zone of the Capacity - // Reservation. - // - // * tenancy - Indicates the tenancy of the Capacity Reservation. A - // Capacity Reservation can have one of the following tenancy settings: - // - // * default - // - The Capacity Reservation is created on hardware that is shared with other - // Amazon Web Services accounts. - // - // * dedicated - The Capacity Reservation is created - // on single-tenant hardware that is dedicated to a single Amazon Web Services - // account. - // - // * outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which - // the Capacity Reservation was created. - // - // * state - The current state of the - // Capacity Reservation. A Capacity Reservation can be in one of the following - // states: - // - // * active- The Capacity Reservation is active and the capacity is - // available for your use. - // - // * expired - The Capacity Reservation expired - // automatically at the date and time specified in your request. The reserved - // capacity is no longer available for your use. - // - // * cancelled - The Capacity - // Reservation was cancelled. The reserved capacity is no longer available for your - // use. - // - // * pending - The Capacity Reservation request was successful but the - // capacity provisioning is still pending. - // - // * failed - The Capacity Reservation - // request has failed. A request might fail due to invalid request parameters, - // capacity constraints, or instance limit constraints. Failed requests are - // retained for 60 minutes. - // - // * start-date - The date and time at which the Capacity - // Reservation was started. - // - // * end-date - The date and time at which the Capacity - // Reservation expires. When a Capacity Reservation expires, the reserved capacity - // is released and you can no longer launch instances into it. The Capacity - // Reservation's state changes to expired when it reaches its end date and time. - // - // * - // end-date-type - Indicates the way in which the Capacity Reservation ends. A - // Capacity Reservation can have one of the following end types: - // - // * unlimited - The - // Capacity Reservation remains active until you explicitly cancel it. - // - // * limited - - // The Capacity Reservation expires automatically at a specified date and time. - // - // * - // instance-match-criteria - Indicates the type of instance launches that the - // Capacity Reservation accepts. The options include: - // - // * open - The Capacity - // Reservation accepts all instances that have matching attributes (instance type, - // platform, and Availability Zone). Instances that have matching attributes launch - // into the Capacity Reservation automatically without specifying any additional - // parameters. - // - // * targeted - The Capacity Reservation only accepts instances that - // have matching attributes (instance type, platform, and Availability Zone), and - // explicitly target the Capacity Reservation. This ensures that only permitted - // instances can use the reserved capacity. - // - // * placement-group-arn - The ARN of the - // cluster placement group in which the Capacity Reservation was created. + // - instance-type - The type of instance for which the Capacity Reservation + // reserves capacity. + // - owner-id - The ID of the Amazon Web Services account that owns the Capacity + // Reservation. + // - instance-platform - The type of operating system for which the Capacity + // Reservation reserves capacity. + // - availability-zone - The Availability Zone of the Capacity Reservation. + // - tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity + // Reservation can have one of the following tenancy settings: + // - default - The Capacity Reservation is created on hardware that is shared + // with other Amazon Web Services accounts. + // - dedicated - The Capacity Reservation is created on single-tenant hardware + // that is dedicated to a single Amazon Web Services account. + // - outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the + // Capacity Reservation was created. + // - state - The current state of the Capacity Reservation. A Capacity + // Reservation can be in one of the following states: + // - active - The Capacity Reservation is active and the capacity is available + // for your use. + // - expired - The Capacity Reservation expired automatically at the date and + // time specified in your request. The reserved capacity is no longer available for + // your use. + // - cancelled - The Capacity Reservation was cancelled. The reserved capacity is + // no longer available for your use. + // - pending - The Capacity Reservation request was successful but the capacity + // provisioning is still pending. + // - failed - The Capacity Reservation request has failed. A request might fail + // due to invalid request parameters, capacity constraints, or instance limit + // constraints. Failed requests are retained for 60 minutes. + // - start-date - The date and time at which the Capacity Reservation was + // started. + // - end-date - The date and time at which the Capacity Reservation expires. When + // a Capacity Reservation expires, the reserved capacity is released and you can no + // longer launch instances into it. The Capacity Reservation's state changes to + // expired when it reaches its end date and time. + // - end-date-type - Indicates the way in which the Capacity Reservation ends. A + // Capacity Reservation can have one of the following end types: + // - unlimited - The Capacity Reservation remains active until you explicitly + // cancel it. + // - limited - The Capacity Reservation expires automatically at a specified date + // and time. + // - instance-match-criteria - Indicates the type of instance launches that the + // Capacity Reservation accepts. The options include: + // - open - The Capacity Reservation accepts all instances that have matching + // attributes (instance type, platform, and Availability Zone). Instances that have + // matching attributes launch into the Capacity Reservation automatically without + // specifying any additional parameters. + // - targeted - The Capacity Reservation only accepts instances that have + // matching attributes (instance type, platform, and Availability Zone), and + // explicitly target the Capacity Reservation. This ensures that only permitted + // instances can use the reserved capacity. + // - placement-group-arn - The ARN of the cluster placement group in which the + // Capacity Reservation was created. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeCarrierGateways.go b/service/ec2/api_op_DescribeCarrierGateways.go index 77ca363a416..787d54808d8 100644 --- a/service/ec2/api_op_DescribeCarrierGateways.go +++ b/service/ec2/api_op_DescribeCarrierGateways.go @@ -35,33 +35,23 @@ type DescribeCarrierGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * carrier-gateway-id - The ID of the carrier gateway. - // - // * - // state - The state of the carrier gateway (pending | failed | available | - // deleting | deleted). - // - // * owner-id - The Amazon Web Services account ID of the - // owner of the carrier gateway. - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. - // - // * vpc-id - The ID of the VPC associated with the - // carrier gateway. + // - carrier-gateway-id - The ID of the carrier gateway. + // - state - The state of the carrier gateway ( pending | failed | available | + // deleting | deleted ). + // - owner-id - The Amazon Web Services account ID of the owner of the carrier + // gateway. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC associated with the carrier gateway. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeClassicLinkInstances.go b/service/ec2/api_op_DescribeClassicLinkInstances.go index d76f1e3a917..33ade09f865 100644 --- a/service/ec2/api_op_DescribeClassicLinkInstances.go +++ b/service/ec2/api_op_DescribeClassicLinkInstances.go @@ -38,30 +38,22 @@ type DescribeClassicLinkInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * group-id - The ID of a VPC security group that's - // associated with the instance. - // - // * instance-id - The ID of the instance. - // - // * tag: - - // The key/value combination of a tag assigned to the resource. Use the tag key in - // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. - // - // * vpc-id - The - // ID of the VPC to which the instance is linked. vpc-id - The ID of the VPC that - // the instance is linked to. + // - group-id - The ID of a VPC security group that's associated with the + // instance. + // - instance-id - The ID of the instance. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC to which the instance is linked. vpc-id - The ID + // of the VPC that the instance is linked to. Filters []types.Filter // One or more instance IDs. Must be instances linked to a VPC through ClassicLink. @@ -69,9 +61,8 @@ type DescribeClassicLinkInstancesInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // Constraint: If the value is greater than 1000, we return only 1000 items. + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Constraint: If the value is greater than 1000, we return only 1000 items. MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -169,9 +160,8 @@ var _ DescribeClassicLinkInstancesAPIClient = (*Client)(nil) type DescribeClassicLinkInstancesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // Constraint: If the value is greater than 1000, we return only 1000 items. + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Constraint: If the value is greater than 1000, we return only 1000 items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go index 91f49995e1b..36d69bcdedd 100644 --- a/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go +++ b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go @@ -37,20 +37,16 @@ type DescribeClientVpnAuthorizationRulesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * description - // - The description of the authorization rule. - // - // * destination-cidr - The CIDR of - // the network to which the authorization rule applies. - // - // * group-id - The ID of the - // Active Directory group to which the authorization rule grants access. + // - description - The description of the authorization rule. + // - destination-cidr - The CIDR of the network to which the authorization rule + // applies. + // - group-id - The ID of the Active Directory group to which the authorization + // rule grants access. Filters []types.Filter // The maximum number of results to return for the request in a single page. The @@ -150,8 +146,8 @@ type DescribeClientVpnAuthorizationRulesAPIClient interface { var _ DescribeClientVpnAuthorizationRulesAPIClient = (*Client)(nil) -// DescribeClientVpnAuthorizationRulesPaginatorOptions is the paginator options for -// DescribeClientVpnAuthorizationRules +// DescribeClientVpnAuthorizationRulesPaginatorOptions is the paginator options +// for DescribeClientVpnAuthorizationRules type DescribeClientVpnAuthorizationRulesPaginatorOptions struct { // The maximum number of results to return for the request in a single page. The // remaining results can be seen by sending another request with the nextToken diff --git a/service/ec2/api_op_DescribeClientVpnConnections.go b/service/ec2/api_op_DescribeClientVpnConnections.go index 8b35f2a3498..ca9019537e8 100644 --- a/service/ec2/api_op_DescribeClientVpnConnections.go +++ b/service/ec2/api_op_DescribeClientVpnConnections.go @@ -38,18 +38,14 @@ type DescribeClientVpnConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * - // connection-id - The ID of the connection. - // - // * username - For Active Directory - // client authentication, the user name of the client who established the client - // connection. + // - connection-id - The ID of the connection. + // - username - For Active Directory client authentication, the user name of the + // client who established the client connection. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeClientVpnEndpoints.go b/service/ec2/api_op_DescribeClientVpnEndpoints.go index 8160ace7b72..a357c429a58 100644 --- a/service/ec2/api_op_DescribeClientVpnEndpoints.go +++ b/service/ec2/api_op_DescribeClientVpnEndpoints.go @@ -35,17 +35,13 @@ type DescribeClientVpnEndpointsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * endpoint-id - // - The ID of the Client VPN endpoint. - // - // * transport-protocol - The transport - // protocol (tcp | udp). + // - endpoint-id - The ID of the Client VPN endpoint. + // - transport-protocol - The transport protocol ( tcp | udp ). Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeClientVpnRoutes.go b/service/ec2/api_op_DescribeClientVpnRoutes.go index fc8220f2e10..2c752ad813c 100644 --- a/service/ec2/api_op_DescribeClientVpnRoutes.go +++ b/service/ec2/api_op_DescribeClientVpnRoutes.go @@ -37,20 +37,15 @@ type DescribeClientVpnRoutesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * - // destination-cidr - The CIDR of the route destination. - // - // * origin - How the route - // was associated with the Client VPN endpoint (associate | add-route). - // - // * - // target-subnet - The ID of the subnet through which traffic is routed. + // - destination-cidr - The CIDR of the route destination. + // - origin - How the route was associated with the Client VPN endpoint ( + // associate | add-route ). + // - target-subnet - The ID of the subnet through which traffic is routed. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go index a9f2b6cd77c..d649c2add2b 100644 --- a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go +++ b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go @@ -40,20 +40,14 @@ type DescribeClientVpnTargetNetworksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * - // association-id - The ID of the association. - // - // * target-network-id - The ID of the - // subnet specified as the target network. - // - // * vpc-id - The ID of the VPC in which - // the target network is located. + // - association-id - The ID of the association. + // - target-network-id - The ID of the subnet specified as the target network. + // - vpc-id - The ID of the VPC in which the target network is located. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeCoipPools.go b/service/ec2/api_op_DescribeCoipPools.go index 21a2d54034b..61e7f090494 100644 --- a/service/ec2/api_op_DescribeCoipPools.go +++ b/service/ec2/api_op_DescribeCoipPools.go @@ -33,16 +33,14 @@ type DescribeCoipPoolsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * coip-pool.local-gateway-route-table-id - The ID of the - // local gateway route table. - // - // * coip-pool.pool-id - The ID of the address pool. + // - coip-pool.local-gateway-route-table-id - The ID of the local gateway route + // table. + // - coip-pool.pool-id - The ID of the address pool. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeConversionTasks.go b/service/ec2/api_op_DescribeConversionTasks.go index 562f7df5e7f..808ff15a45c 100644 --- a/service/ec2/api_op_DescribeConversionTasks.go +++ b/service/ec2/api_op_DescribeConversionTasks.go @@ -17,10 +17,10 @@ import ( ) // Describes the specified conversion tasks or all your conversion tasks. For more -// information, see the VM Import/Export User Guide -// (https://docs.aws.amazon.com/vm-import/latest/userguide/). For information about -// the import manifest referenced by this API action, see VM Import Manifest -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). +// information, see the VM Import/Export User Guide (https://docs.aws.amazon.com/vm-import/latest/userguide/) +// . For information about the import manifest referenced by this API action, see +// VM Import Manifest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html) +// . func (c *Client) DescribeConversionTasks(ctx context.Context, params *DescribeConversionTasksInput, optFns ...func(*Options)) (*DescribeConversionTasksOutput, error) { if params == nil { params = &DescribeConversionTasksInput{} @@ -43,8 +43,8 @@ type DescribeConversionTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -143,8 +143,8 @@ type ConversionTaskCancelledWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ConversionTaskCancelledWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ConversionTaskCancelledWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -320,8 +320,8 @@ type ConversionTaskCompletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ConversionTaskCompletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ConversionTaskCompletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -545,9 +545,10 @@ type ConversionTaskDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ConversionTaskDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ConversionTaskDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeCustomerGateways.go b/service/ec2/api_op_DescribeCustomerGateways.go index 458e7515301..fa18db1c2fe 100644 --- a/service/ec2/api_op_DescribeCustomerGateways.go +++ b/service/ec2/api_op_DescribeCustomerGateways.go @@ -17,9 +17,8 @@ import ( ) // Describes one or more of your VPN customer gateways. For more information, see -// Amazon Web Services Site-to-Site VPN -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// Amazon Web Services Site-to-Site VPN (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) DescribeCustomerGateways(ctx context.Context, params *DescribeCustomerGatewaysInput, optFns ...func(*Options)) (*DescribeCustomerGatewaysOutput, error) { if params == nil { params = &DescribeCustomerGatewaysInput{} @@ -43,36 +42,26 @@ type DescribeCustomerGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * bgp-asn - The customer gateway's Border Gateway Protocol - // (BGP) Autonomous System Number (ASN). - // - // * customer-gateway-id - The ID of the - // customer gateway. - // - // * ip-address - The IP address of the customer gateway - // device's external interface. - // - // * state - The state of the customer gateway - // (pending | available | deleting | deleted). - // - // * type - The type of customer - // gateway. Currently, the only supported type is ipsec.1. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. + // - bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous + // System Number (ASN). + // - customer-gateway-id - The ID of the customer gateway. + // - ip-address - The IP address of the customer gateway device's external + // interface. + // - state - The state of the customer gateway ( pending | available | deleting | + // deleted ). + // - type - The type of customer gateway. Currently, the only supported type is + // ipsec.1 . + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter noSmithyDocumentSerde @@ -172,8 +161,8 @@ type CustomerGatewayAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CustomerGatewayAvailableWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CustomerGatewayAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/ec2/api_op_DescribeDhcpOptions.go b/service/ec2/api_op_DescribeDhcpOptions.go index 9c34e8eac79..266ebcfd054 100644 --- a/service/ec2/api_op_DescribeDhcpOptions.go +++ b/service/ec2/api_op_DescribeDhcpOptions.go @@ -13,9 +13,8 @@ import ( ) // Describes one or more of your DHCP options sets. For more information, see DHCP -// options sets -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the -// Amazon Virtual Private Cloud User Guide. +// options sets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) DescribeDhcpOptions(ctx context.Context, params *DescribeDhcpOptionsInput, optFns ...func(*Options)) (*DescribeDhcpOptionsOutput, error) { if params == nil { params = &DescribeDhcpOptionsInput{} @@ -39,38 +38,28 @@ type DescribeDhcpOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * dhcp-options-id - The ID of a DHCP options set. - // - // * key - - // The key for one of the options (for example, domain-name). - // - // * value - The value - // for one of the options. - // - // * owner-id - The ID of the Amazon Web Services account - // that owns the DHCP options set. - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. + // - dhcp-options-id - The ID of a DHCP options set. + // - key - The key for one of the options (for example, domain-name ). + // - value - The value for one of the options. + // - owner-id - The ID of the Amazon Web Services account that owns the DHCP + // options set. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -155,8 +144,8 @@ func (c *Client) addOperationDescribeDhcpOptionsMiddlewares(stack *middleware.St return nil } -// DescribeDhcpOptionsAPIClient is a client that implements the DescribeDhcpOptions -// operation. +// DescribeDhcpOptionsAPIClient is a client that implements the +// DescribeDhcpOptions operation. type DescribeDhcpOptionsAPIClient interface { DescribeDhcpOptions(context.Context, *DescribeDhcpOptionsInput, ...func(*Options)) (*DescribeDhcpOptionsOutput, error) } @@ -168,8 +157,8 @@ var _ DescribeDhcpOptionsAPIClient = (*Client)(nil) type DescribeDhcpOptionsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go b/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go index 5d1ebc5bc00..1787367b239 100644 --- a/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go +++ b/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go @@ -32,30 +32,26 @@ type DescribeEgressOnlyInternetGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more egress-only internet gateway IDs. EgressOnlyInternetGatewayIds []string // One or more filters. - // - // * tag: - The key/value combination of a tag assigned to - // the resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -153,8 +149,8 @@ var _ DescribeEgressOnlyInternetGatewaysAPIClient = (*Client)(nil) type DescribeEgressOnlyInternetGatewaysPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeElasticGpus.go b/service/ec2/api_op_DescribeElasticGpus.go index 6c13d0ec977..60e8fc43afa 100644 --- a/service/ec2/api_op_DescribeElasticGpus.go +++ b/service/ec2/api_op_DescribeElasticGpus.go @@ -12,8 +12,8 @@ import ( ) // Describes the Elastic Graphics accelerator associated with your instances. For -// more information about Elastic Graphics, see Amazon Elastic Graphics -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html). +// more information about Elastic Graphics, see Amazon Elastic Graphics (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) +// . func (c *Client) DescribeElasticGpus(ctx context.Context, params *DescribeElasticGpusInput, optFns ...func(*Options)) (*DescribeElasticGpusOutput, error) { if params == nil { params = &DescribeElasticGpusInput{} @@ -33,29 +33,24 @@ type DescribeElasticGpusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Elastic Graphics accelerator IDs. ElasticGpuIds []string // The filters. - // - // * availability-zone - The Availability Zone in which the Elastic - // Graphics accelerator resides. - // - // * elastic-gpu-health - The status of the Elastic - // Graphics accelerator (OK | IMPAIRED). - // - // * elastic-gpu-state - The state of the - // Elastic Graphics accelerator (ATTACHED). - // - // * elastic-gpu-type - The type of - // Elastic Graphics accelerator; for example, eg1.medium. - // - // * instance-id - The ID - // of the instance to which the Elastic Graphics accelerator is associated. + // - availability-zone - The Availability Zone in which the Elastic Graphics + // accelerator resides. + // - elastic-gpu-health - The status of the Elastic Graphics accelerator ( OK | + // IMPAIRED ). + // - elastic-gpu-state - The state of the Elastic Graphics accelerator ( ATTACHED + // ). + // - elastic-gpu-type - The type of Elastic Graphics accelerator; for example, + // eg1.medium . + // - instance-id - The ID of the instance to which the Elastic Graphics + // accelerator is associated. Filters []types.Filter // The maximum number of results to return in a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeExportImageTasks.go b/service/ec2/api_op_DescribeExportImageTasks.go index 6d2ac468a02..fbbfdce3b24 100644 --- a/service/ec2/api_op_DescribeExportImageTasks.go +++ b/service/ec2/api_op_DescribeExportImageTasks.go @@ -32,15 +32,15 @@ type DescribeExportImageTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of the export image tasks. ExportImageTaskIds []string - // Filter tasks using the task-state filter and one of the following values: - // active, completed, deleting, or deleted. + // Filter tasks using the task-state filter and one of the following values: active + // , completed , deleting , or deleted . Filters []types.Filter // The maximum number of results to return in a single call. diff --git a/service/ec2/api_op_DescribeExportTasks.go b/service/ec2/api_op_DescribeExportTasks.go index 84af290e6d1..eabc5e28d01 100644 --- a/service/ec2/api_op_DescribeExportTasks.go +++ b/service/ec2/api_op_DescribeExportTasks.go @@ -115,8 +115,8 @@ func (c *Client) addOperationDescribeExportTasksMiddlewares(stack *middleware.St return nil } -// DescribeExportTasksAPIClient is a client that implements the DescribeExportTasks -// operation. +// DescribeExportTasksAPIClient is a client that implements the +// DescribeExportTasks operation. type DescribeExportTasksAPIClient interface { DescribeExportTasks(context.Context, *DescribeExportTasksInput, ...func(*Options)) (*DescribeExportTasksOutput, error) } @@ -137,9 +137,10 @@ type ExportTaskCancelledWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ExportTaskCancelledWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ExportTaskCancelledWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -179,9 +180,9 @@ func NewExportTaskCancelledWaiter(client DescribeExportTasksAPIClient, optFns .. } } -// Wait calls the waiter function for ExportTaskCancelled waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ExportTaskCancelled waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ExportTaskCancelledWaiter) Wait(ctx context.Context, params *DescribeExportTasksInput, maxWaitDur time.Duration, optFns ...func(*ExportTaskCancelledWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -313,9 +314,10 @@ type ExportTaskCompletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ExportTaskCompletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ExportTaskCompletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -355,9 +357,9 @@ func NewExportTaskCompletedWaiter(client DescribeExportTasksAPIClient, optFns .. } } -// Wait calls the waiter function for ExportTaskCompleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ExportTaskCompleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ExportTaskCompletedWaiter) Wait(ctx context.Context, params *DescribeExportTasksInput, maxWaitDur time.Duration, optFns ...func(*ExportTaskCompletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/ec2/api_op_DescribeFastLaunchImages.go b/service/ec2/api_op_DescribeFastLaunchImages.go index db387a77e25..61da11a68fb 100644 --- a/service/ec2/api_op_DescribeFastLaunchImages.go +++ b/service/ec2/api_op_DescribeFastLaunchImages.go @@ -32,23 +32,16 @@ type DescribeFastLaunchImagesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Use the following filters to streamline results. - // - // * resource-type - The resource - // type for pre-provisioning. - // - // * launch-template - The launch template that is - // associated with the pre-provisioned Windows AMI. - // - // * owner-id - The owner ID for - // the pre-provisioning resource. - // - // * state - The current state of fast launching - // for the Windows AMI. + // - resource-type - The resource type for pre-provisioning. + // - launch-template - The launch template that is associated with the + // pre-provisioned Windows AMI. + // - owner-id - The owner ID for the pre-provisioning resource. + // - state - The current state of fast launching for the Windows AMI. Filters []types.Filter // Details for one or more Windows AMI image IDs. @@ -56,8 +49,8 @@ type DescribeFastLaunchImagesInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -156,8 +149,8 @@ var _ DescribeFastLaunchImagesAPIClient = (*Client)(nil) type DescribeFastLaunchImagesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeFastSnapshotRestores.go b/service/ec2/api_op_DescribeFastSnapshotRestores.go index be93e037a01..dbef9c3e58c 100644 --- a/service/ec2/api_op_DescribeFastSnapshotRestores.go +++ b/service/ec2/api_op_DescribeFastSnapshotRestores.go @@ -32,29 +32,23 @@ type DescribeFastSnapshotRestoresInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. The possible values are: - // - // * availability-zone: The Availability - // Zone of the snapshot. - // - // * owner-id: The ID of the Amazon Web Services account - // that enabled fast snapshot restore on the snapshot. - // - // * snapshot-id: The ID of - // the snapshot. - // - // * state: The state of fast snapshot restores for the snapshot - // (enabling | optimizing | enabled | disabling | disabled). + // - availability-zone : The Availability Zone of the snapshot. + // - owner-id : The ID of the Amazon Web Services account that enabled fast + // snapshot restore on the snapshot. + // - snapshot-id : The ID of the snapshot. + // - state : The state of fast snapshot restores for the snapshot ( enabling | + // optimizing | enabled | disabling | disabled ). Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -152,8 +146,8 @@ var _ DescribeFastSnapshotRestoresAPIClient = (*Client)(nil) type DescribeFastSnapshotRestoresPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeFleetHistory.go b/service/ec2/api_op_DescribeFleetHistory.go index 39efcfd20c9..79724ae9de1 100644 --- a/service/ec2/api_op_DescribeFleetHistory.go +++ b/service/ec2/api_op_DescribeFleetHistory.go @@ -16,9 +16,8 @@ import ( // Fleet events are delayed by up to 30 seconds before they can be described. This // ensures that you can query by the last evaluated time and not miss a recorded // event. EC2 Fleet events are available for 48 hours. For more information, see -// Monitor fleet events using Amazon EventBridge -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) in the -// Amazon EC2 User Guide. +// Monitor fleet events using Amazon EventBridge (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeFleetHistory(ctx context.Context, params *DescribeFleetHistoryInput, optFns ...func(*Options)) (*DescribeFleetHistoryOutput, error) { if params == nil { params = &DescribeFleetHistoryInput{} @@ -49,8 +48,8 @@ type DescribeFleetHistoryInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The type of events to describe. By default, all events are described. @@ -58,8 +57,8 @@ type DescribeFleetHistoryInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from diff --git a/service/ec2/api_op_DescribeFleetInstances.go b/service/ec2/api_op_DescribeFleetInstances.go index 64f9420fbc7..96671351c89 100644 --- a/service/ec2/api_op_DescribeFleetInstances.go +++ b/service/ec2/api_op_DescribeFleetInstances.go @@ -12,8 +12,7 @@ import ( ) // Describes the running instances for the specified EC2 Fleet. For more -// information, see Monitor your EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) +// information, see Monitor your EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) // in the Amazon EC2 User Guide. func (c *Client) DescribeFleetInstances(ctx context.Context, params *DescribeFleetInstancesInput, optFns ...func(*Options)) (*DescribeFleetInstancesOutput, error) { if params == nil { @@ -39,19 +38,18 @@ type DescribeFleetInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * instance-type - The instance type. + // - instance-type - The instance type. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from diff --git a/service/ec2/api_op_DescribeFleets.go b/service/ec2/api_op_DescribeFleets.go index c82f279b49e..f52cf0c2ccf 100644 --- a/service/ec2/api_op_DescribeFleets.go +++ b/service/ec2/api_op_DescribeFleets.go @@ -13,8 +13,7 @@ import ( ) // Describes the specified EC2 Fleets or all of your EC2 Fleets. For more -// information, see Monitor your EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) +// information, see Monitor your EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) // in the Amazon EC2 User Guide. func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput, optFns ...func(*Options)) (*DescribeFleetsOutput, error) { if params == nil { @@ -35,39 +34,31 @@ type DescribeFleetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * activity-status - The progress of the EC2 Fleet ( error | - // pending-fulfillment | pending-termination | fulfilled). - // - // * - // excess-capacity-termination-policy - Indicates whether to terminate running - // instances if the target capacity is decreased below the current EC2 Fleet size - // (true | false). - // - // * fleet-state - The state of the EC2 Fleet (submitted | active - // | deleted | failed | deleted-running | deleted-terminating | modifying). - // - // * - // replace-unhealthy-instances - Indicates whether EC2 Fleet should replace - // unhealthy instances (true | false). - // - // * type - The type of request (instant | - // request | maintain). + // - activity-status - The progress of the EC2 Fleet ( error | + // pending-fulfillment | pending-termination | fulfilled ). + // - excess-capacity-termination-policy - Indicates whether to terminate running + // instances if the target capacity is decreased below the current EC2 Fleet size ( + // true | false ). + // - fleet-state - The state of the EC2 Fleet ( submitted | active | deleted | + // failed | deleted-running | deleted-terminating | modifying ). + // - replace-unhealthy-instances - Indicates whether EC2 Fleet should replace + // unhealthy instances ( true | false ). + // - type - The type of request ( instant | request | maintain ). Filters []types.Filter - // The IDs of the EC2 Fleets. If a fleet is of type instant, you must specify the + // The IDs of the EC2 Fleets. If a fleet is of type instant , you must specify the // fleet ID, otherwise it does not appear in the response. FleetIds []string // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -164,8 +155,8 @@ var _ DescribeFleetsAPIClient = (*Client)(nil) type DescribeFleetsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeFlowLogs.go b/service/ec2/api_op_DescribeFlowLogs.go index 83034ec2578..7382c75c950 100644 --- a/service/ec2/api_op_DescribeFlowLogs.go +++ b/service/ec2/api_op_DescribeFlowLogs.go @@ -34,38 +34,24 @@ type DescribeFlowLogsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * deliver-log-status - The status of the logs delivery - // (SUCCESS | FAILED). - // - // * log-destination-type - The type of destination for the - // flow log data (cloud-watch-logs | s3 | kinesis-data-firehose). - // - // * flow-log-id - - // The ID of the flow log. - // - // * log-group-name - The name of the log group. - // - // * - // resource-id - The ID of the VPC, subnet, or network interface. - // - // * traffic-type - - // The type of traffic (ACCEPT | REJECT | ALL). - // - // * tag: - The key/value combination - // of a tag assigned to the resource. Use the tag key in the filter name and the - // tag value as the filter value. For example, to find all resources that have a - // tag with the key Owner and the value TeamA, specify tag:Owner for the filter - // name and TeamA for the filter value. - // - // * tag-key - The key of a tag assigned to - // the resource. Use this filter to find all resources assigned a tag with a - // specific key, regardless of the tag value. + // - deliver-log-status - The status of the logs delivery ( SUCCESS | FAILED ). + // - log-destination-type - The type of destination for the flow log data ( + // cloud-watch-logs | s3 | kinesis-data-firehose ). + // - flow-log-id - The ID of the flow log. + // - log-group-name - The name of the log group. + // - resource-id - The ID of the VPC, subnet, or network interface. + // - traffic-type - The type of traffic ( ACCEPT | REJECT | ALL ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filter []types.Filter // One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. @@ -73,8 +59,8 @@ type DescribeFlowLogsInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token to request the next page of items. Pagination continues from the end @@ -171,8 +157,8 @@ var _ DescribeFlowLogsAPIClient = (*Client)(nil) type DescribeFlowLogsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeFpgaImageAttribute.go b/service/ec2/api_op_DescribeFpgaImageAttribute.go index 11a3fe36a21..e7581cfb37f 100644 --- a/service/ec2/api_op_DescribeFpgaImageAttribute.go +++ b/service/ec2/api_op_DescribeFpgaImageAttribute.go @@ -41,8 +41,8 @@ type DescribeFpgaImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeFpgaImages.go b/service/ec2/api_op_DescribeFpgaImages.go index e9fe35645bf..8927bd84d74 100644 --- a/service/ec2/api_op_DescribeFpgaImages.go +++ b/service/ec2/api_op_DescribeFpgaImages.go @@ -34,46 +34,27 @@ type DescribeFpgaImagesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * create-time - The creation time of the AFI. - // - // * fpga-image-id - - // The FPGA image identifier (AFI ID). - // - // * fpga-image-global-id - The global FPGA - // image identifier (AGFI ID). - // - // * name - The name of the AFI. - // - // * owner-id - The - // Amazon Web Services account ID of the AFI owner. - // - // * product-code - The product - // code. - // - // * shell-version - The version of the Amazon Web Services Shell that was - // used to create the bitstream. - // - // * state - The state of the AFI (pending | failed - // | available | unavailable). - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. - // - // * update-time - The time of the most recent - // update. + // - create-time - The creation time of the AFI. + // - fpga-image-id - The FPGA image identifier (AFI ID). + // - fpga-image-global-id - The global FPGA image identifier (AGFI ID). + // - name - The name of the AFI. + // - owner-id - The Amazon Web Services account ID of the AFI owner. + // - product-code - The product code. + // - shell-version - The version of the Amazon Web Services Shell that was used + // to create the bitstream. + // - state - The state of the AFI ( pending | failed | available | unavailable ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - update-time - The time of the most recent update. Filters []types.Filter // The AFI IDs. @@ -85,9 +66,9 @@ type DescribeFpgaImagesInput struct { // The token to retrieve the next page of results. NextToken *string - // Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner - // is the sender of the request), or an Amazon Web Services owner alias (valid - // values are amazon | aws-marketplace). + // Filters the AFI by owner. Specify an Amazon Web Services account ID, self + // (owner is the sender of the request), or an Amazon Web Services owner alias + // (valid values are amazon | aws-marketplace ). Owners []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeHostReservationOfferings.go b/service/ec2/api_op_DescribeHostReservationOfferings.go index 4c146798552..01dc6c09405 100644 --- a/service/ec2/api_op_DescribeHostReservationOfferings.go +++ b/service/ec2/api_op_DescribeHostReservationOfferings.go @@ -18,8 +18,7 @@ import ( // Hosts. When purchasing an offering, ensure that the instance family and Region // of the offering matches that of the Dedicated Hosts with which it is to be // associated. For more information about supported instance types, see Dedicated -// Hosts -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) +// Hosts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) // in the Amazon EC2 User Guide. func (c *Client) DescribeHostReservationOfferings(ctx context.Context, params *DescribeHostReservationOfferingsInput, optFns ...func(*Options)) (*DescribeHostReservationOfferingsOutput, error) { if params == nil { @@ -39,12 +38,9 @@ func (c *Client) DescribeHostReservationOfferings(ctx context.Context, params *D type DescribeHostReservationOfferingsInput struct { // The filters. - // - // * instance-family - The instance family of the offering (for - // example, m4). - // - // * payment-option - The payment option (NoUpfront | PartialUpfront - // | AllUpfront). + // - instance-family - The instance family of the offering (for example, m4 ). + // - payment-option - The payment option ( NoUpfront | PartialUpfront | + // AllUpfront ). Filter []types.Filter // This is the maximum duration of the reservation to purchase, specified in diff --git a/service/ec2/api_op_DescribeHostReservations.go b/service/ec2/api_op_DescribeHostReservations.go index 5dffd1614c9..6bb18a158f2 100644 --- a/service/ec2/api_op_DescribeHostReservations.go +++ b/service/ec2/api_op_DescribeHostReservations.go @@ -31,25 +31,17 @@ func (c *Client) DescribeHostReservations(ctx context.Context, params *DescribeH type DescribeHostReservationsInput struct { // The filters. - // - // * instance-family - The instance family (for example, m4). - // - // * - // payment-option - The payment option (NoUpfront | PartialUpfront | - // AllUpfront). - // - // * state - The state of the reservation (payment-pending | - // payment-failed | active | retired). - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. + // - instance-family - The instance family (for example, m4 ). + // - payment-option - The payment option ( NoUpfront | PartialUpfront | + // AllUpfront ). + // - state - The state of the reservation ( payment-pending | payment-failed | + // active | retired ). + // - tag: - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filter []types.Filter // The host reservation IDs. diff --git a/service/ec2/api_op_DescribeHosts.go b/service/ec2/api_op_DescribeHosts.go index cf3c8e695e5..e2165d182e0 100644 --- a/service/ec2/api_op_DescribeHosts.go +++ b/service/ec2/api_op_DescribeHosts.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results -// describe only the Dedicated Hosts in the Region you're currently using. All -// listed instances consume capacity on your Dedicated Host. Dedicated Hosts that -// have recently been released are listed with the state released. +// Describes the specified Dedicated Hosts or all your Dedicated Hosts. The +// results describe only the Dedicated Hosts in the Region you're currently using. +// All listed instances consume capacity on your Dedicated Host. Dedicated Hosts +// that have recently been released are listed with the state released . func (c *Client) DescribeHosts(ctx context.Context, params *DescribeHostsInput, optFns ...func(*Options)) (*DescribeHostsOutput, error) { if params == nil { params = &DescribeHostsInput{} @@ -34,29 +34,18 @@ func (c *Client) DescribeHosts(ctx context.Context, params *DescribeHostsInput, type DescribeHostsInput struct { // The filters. - // - // * auto-placement - Whether auto-placement is enabled or disabled - // (on | off). - // - // * availability-zone - The Availability Zone of the host. - // - // * - // client-token - The idempotency token that you provided when you allocated the - // host. - // - // * host-reservation-id - The ID of the reservation assigned to this - // host. - // - // * instance-type - The instance type size that the Dedicated Host is - // configured to support. - // - // * state - The allocation state of the Dedicated Host - // (available | under-assessment | permanent-failure | released | - // released-permanent-failure). - // - // * tag-key - The key of a tag assigned to the - // resource. Use this filter to find all resources assigned a tag with a specific - // key, regardless of the tag value. + // - auto-placement - Whether auto-placement is enabled or disabled ( on | off ). + // - availability-zone - The Availability Zone of the host. + // - client-token - The idempotency token that you provided when you allocated + // the host. + // - host-reservation-id - The ID of the reservation assigned to this host. + // - instance-type - The instance type size that the Dedicated Host is configured + // to support. + // - state - The allocation state of the Dedicated Host ( available | + // under-assessment | permanent-failure | released | released-permanent-failure + // ). + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filter []types.Filter // The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. diff --git a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go index ec4294ad68e..2832be706b7 100644 --- a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go +++ b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go @@ -34,17 +34,15 @@ type DescribeIamInstanceProfileAssociationsInput struct { AssociationIds []string // The filters. - // - // * instance-id - The ID of the instance. - // - // * state - The state of - // the association (associating | associated | disassociating). + // - instance-id - The ID of the instance. + // - state - The state of the association ( associating | associated | + // disassociating ). Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -142,8 +140,8 @@ var _ DescribeIamInstanceProfileAssociationsAPIClient = (*Client)(nil) type DescribeIamInstanceProfileAssociationsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeIdFormat.go b/service/ec2/api_op_DescribeIdFormat.go index 59049fabc24..e87ca2ea71e 100644 --- a/service/ec2/api_op_DescribeIdFormat.go +++ b/service/ec2/api_op_DescribeIdFormat.go @@ -15,15 +15,15 @@ import ( // example, to view which resource types are enabled for longer IDs. This request // only returns information about resource types whose ID formats can be modified; // it does not return information about other resource types. The following -// resource types support longer IDs: bundle | conversion-task | customer-gateway | -// dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | +// resource types support longer IDs: bundle | conversion-task | customer-gateway +// | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | // flow-log | image | import-task | instance | internet-gateway | network-acl | // network-acl-association | network-interface | network-interface-attachment | // prefix-list | reservation | route-table | route-table-association | // security-group | snapshot | subnet | subnet-cidr-block-association | volume | // vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | -// vpn-connection | vpn-gateway. These settings apply to the IAM user who makes the -// request; they do not apply to the entire Amazon Web Services account. By +// vpn-connection | vpn-gateway . These settings apply to the IAM user who makes +// the request; they do not apply to the entire Amazon Web Services account. By // default, an IAM user defaults to the same settings as the root user, unless they // explicitly override the settings by running the ModifyIdFormat command. // Resources created with longer IDs are visible to all IAM users, regardless of diff --git a/service/ec2/api_op_DescribeIdentityIdFormat.go b/service/ec2/api_op_DescribeIdentityIdFormat.go index bc70c60d61b..813841bf0b6 100644 --- a/service/ec2/api_op_DescribeIdentityIdFormat.go +++ b/service/ec2/api_op_DescribeIdentityIdFormat.go @@ -15,18 +15,17 @@ import ( // role, or root user. For example, you can view the resource types that are // enabled for longer IDs. This request only returns information about resource // types whose ID formats can be modified; it does not return information about -// other resource types. For more information, see Resource IDs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the -// Amazon Elastic Compute Cloud User Guide. The following resource types support -// longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | -// elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image -// | import-task | instance | internet-gateway | network-acl | +// other resource types. For more information, see Resource IDs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) +// in the Amazon Elastic Compute Cloud User Guide. The following resource types +// support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options +// | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | +// image | import-task | instance | internet-gateway | network-acl | // network-acl-association | network-interface | network-interface-attachment | // prefix-list | reservation | route-table | route-table-association | // security-group | snapshot | subnet | subnet-cidr-block-association | volume | // vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | -// vpn-connection | vpn-gateway. These settings apply to the principal specified in -// the request. They do not apply to the principal that makes the request. +// vpn-connection | vpn-gateway . These settings apply to the principal specified +// in the request. They do not apply to the principal that makes the request. func (c *Client) DescribeIdentityIdFormat(ctx context.Context, params *DescribeIdentityIdFormatInput, optFns ...func(*Options)) (*DescribeIdentityIdFormatOutput, error) { if params == nil { params = &DescribeIdentityIdFormatInput{} diff --git a/service/ec2/api_op_DescribeImageAttribute.go b/service/ec2/api_op_DescribeImageAttribute.go index 9dcb04185c6..a227ba53e73 100644 --- a/service/ec2/api_op_DescribeImageAttribute.go +++ b/service/ec2/api_op_DescribeImageAttribute.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified attribute of the specified AMI. You can specify only one -// attribute at a time. +// Describes the specified attribute of the specified AMI. You can specify only +// one attribute at a time. func (c *Client) DescribeImageAttribute(ctx context.Context, params *DescribeImageAttributeInput, optFns ...func(*Options)) (*DescribeImageAttributeOutput, error) { if params == nil { params = &DescribeImageAttributeInput{} @@ -45,8 +45,8 @@ type DescribeImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -67,23 +67,21 @@ type DescribeImageAttributeOutput struct { // The ID of the AMI. ImageId *string - // If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched + // If v2.0 , it indicates that IMDSv2 is specified in the AMI. Instances launched // from this AMI will have HttpTokens automatically set to required so that, by // default, the instance requires that IMDSv2 is used when requesting instance - // metadata. In addition, HttpPutResponseHopLimit is set to 2. For more - // information, see Configure the AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) + // metadata. In addition, HttpPutResponseHopLimit is set to 2 . For more + // information, see Configure the AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) // in the Amazon EC2 User Guide. ImdsSupport *types.AttributeValue // The kernel ID. KernelId *types.AttributeValue - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the AMI was last used to launch an EC2 - // instance. When the AMI is used to launch an instance, there is a 24-hour delay - // before that usage is reported. lastLaunchedTime data is available starting April - // 2017. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the AMI was last used to launch an EC2 instance. When the AMI is used to + // launch an instance, there is a 24-hour delay before that usage is reported. + // lastLaunchedTime data is available starting April 2017. LastLaunchedTime *types.AttributeValue // The launch permissions. @@ -99,17 +97,15 @@ type DescribeImageAttributeOutput struct { // interface is enabled. SriovNetSupport *types.AttributeValue - // If the image is configured for NitroTPM support, the value is v2.0. + // If the image is configured for NitroTPM support, the value is v2.0 . TpmSupport *types.AttributeValue // Base64 representation of the non-volatile UEFI variable store. To retrieve the - // UEFI data, use the GetInstanceUefiData - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) + // UEFI data, use the GetInstanceUefiData (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) // command. You can inspect and modify the UEFI data by using the python-uefivars // tool (https://github.com/awslabs/python-uefivars) on GitHub. For more - // information, see UEFI Secure Boot - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in - // the Amazon EC2 User Guide. + // information, see UEFI Secure Boot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) + // in the Amazon EC2 User Guide. UefiData *types.AttributeValue // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_DescribeImages.go b/service/ec2/api_op_DescribeImages.go index 76b793a1628..a803da622a5 100644 --- a/service/ec2/api_op_DescribeImages.go +++ b/service/ec2/api_op_DescribeImages.go @@ -19,10 +19,10 @@ import ( "time" ) -// Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of -// the images available to you. The images available to you include public images, -// private images that you own, and private images owned by other Amazon Web -// Services accounts for which you have explicit launch permissions. Recently +// Describes the specified images (AMIs, AKIs, and ARIs) available to you or all +// of the images available to you. The images available to you include public +// images, private images that you own, and private images owned by other Amazon +// Web Services accounts for which you have explicit launch permissions. Recently // deregistered images appear in the returned results for a short interval and then // return empty results. After all instances that reference a deregistered AMI are // terminated, specifying the ID of the image will eventually return an error @@ -46,133 +46,77 @@ type DescribeImagesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Scopes the images by users with explicit launch permissions. Specify an Amazon // Web Services account ID, self (the sender of the request), or all (public // AMIs). - // - // * If you specify an Amazon Web Services account ID that is not your own, - // only AMIs shared with that specific Amazon Web Services account ID are returned. - // However, AMIs that are shared with the account’s organization or organizational - // unit (OU) are not returned. - // - // * If you specify self or your own Amazon Web - // Services account ID, AMIs shared with your account are returned. In addition, - // AMIs that are shared with the organization or OU of which you are member are - // also returned. - // - // * If you specify all, all public AMIs are returned. + // - If you specify an Amazon Web Services account ID that is not your own, only + // AMIs shared with that specific Amazon Web Services account ID are returned. + // However, AMIs that are shared with the account’s organization or organizational + // unit (OU) are not returned. + // - If you specify self or your own Amazon Web Services account ID, AMIs shared + // with your account are returned. In addition, AMIs that are shared with the + // organization or OU of which you are member are also returned. + // - If you specify all , all public AMIs are returned. ExecutableUsers []string // The filters. - // - // * architecture - The image architecture (i386 | x86_64 | - // arm64). - // - // * block-device-mapping.delete-on-termination - A Boolean value that - // indicates whether the Amazon EBS volume is deleted on instance termination. - // - // * - // block-device-mapping.device-name - The device name specified in the block device - // mapping (for example, /dev/sdh or xvdh). - // - // * block-device-mapping.snapshot-id - - // The ID of the snapshot used for the Amazon EBS volume. - // - // * - // block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in - // GiB. - // - // * block-device-mapping.volume-type - The volume type of the Amazon EBS - // volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard). - // - // * - // block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS - // volume is encrypted. - // - // * creation-date - The time when the image was created, in - // the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for - // example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, - // 2021-09-29T*, which matches an entire day. - // - // * description - The description of - // the image (provided during image creation). - // - // * ena-support - A Boolean that - // indicates whether enhanced networking with ENA is enabled. - // - // * hypervisor - The - // hypervisor type (ovm | xen). - // - // * image-id - The ID of the image. - // - // * image-type - - // The image type (machine | kernel | ramdisk). - // - // * is-public - A Boolean that - // indicates whether the image is public. - // - // * kernel-id - The kernel ID. - // - // * - // manifest-location - The location of the image manifest. - // - // * name - The name of - // the AMI (provided during image creation). - // - // * owner-alias - The owner alias - // (amazon | aws-marketplace). The valid aliases are defined in an - // Amazon-maintained list. This is not the Amazon Web Services account alias that - // can be set using the IAM console. We recommend that you use the Owner request - // parameter instead of this filter. - // - // * owner-id - The Amazon Web Services account - // ID of the owner. We recommend that you use the Owner request parameter instead - // of this filter. - // - // * platform - The platform. The only supported value is - // windows. - // - // * product-code - The product code. - // - // * product-code.type - The type of - // the product code (marketplace). - // - // * ramdisk-id - The RAM disk ID. - // - // * - // root-device-name - The device name of the root device volume (for example, - // /dev/sda1). - // - // * root-device-type - The type of the root device volume (ebs | - // instance-store). - // - // * state - The state of the image (available | pending | - // failed). - // - // * state-reason-code - The reason code for the state change. - // - // * - // state-reason-message - The message for the state change. - // - // * sriov-net-support - - // A value of simple indicates that enhanced networking with the Intel 82599 VF - // interface is enabled. - // - // * tag: - The key/value combination of a tag assigned to - // the resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. - // - // * virtualization-type - The virtualization type (paravirtual | hvm). + // - architecture - The image architecture ( i386 | x86_64 | arm64 ). + // - block-device-mapping.delete-on-termination - A Boolean value that indicates + // whether the Amazon EBS volume is deleted on instance termination. + // - block-device-mapping.device-name - The device name specified in the block + // device mapping (for example, /dev/sdh or xvdh ). + // - block-device-mapping.snapshot-id - The ID of the snapshot used for the + // Amazon EBS volume. + // - block-device-mapping.volume-size - The volume size of the Amazon EBS volume, + // in GiB. + // - block-device-mapping.volume-type - The volume type of the Amazon EBS volume ( + // io1 | io2 | gp2 | gp3 | sc1 | st1 | standard ). + // - block-device-mapping.encrypted - A Boolean that indicates whether the Amazon + // EBS volume is encrypted. + // - creation-date - The time when the image was created, in the ISO 8601 format + // in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, + // 2021-09-29T11:04:43.305Z . You can use a wildcard ( * ), for example, + // 2021-09-29T* , which matches an entire day. + // - description - The description of the image (provided during image creation). + // - ena-support - A Boolean that indicates whether enhanced networking with ENA + // is enabled. + // - hypervisor - The hypervisor type ( ovm | xen ). + // - image-id - The ID of the image. + // - image-type - The image type ( machine | kernel | ramdisk ). + // - is-public - A Boolean that indicates whether the image is public. + // - kernel-id - The kernel ID. + // - manifest-location - The location of the image manifest. + // - name - The name of the AMI (provided during image creation). + // - owner-alias - The owner alias ( amazon | aws-marketplace ). The valid + // aliases are defined in an Amazon-maintained list. This is not the Amazon Web + // Services account alias that can be set using the IAM console. We recommend that + // you use the Owner request parameter instead of this filter. + // - owner-id - The Amazon Web Services account ID of the owner. We recommend + // that you use the Owner request parameter instead of this filter. + // - platform - The platform. The only supported value is windows . + // - product-code - The product code. + // - product-code.type - The type of the product code ( marketplace ). + // - ramdisk-id - The RAM disk ID. + // - root-device-name - The device name of the root device volume (for example, + // /dev/sda1 ). + // - root-device-type - The type of the root device volume ( ebs | instance-store + // ). + // - state - The state of the image ( available | pending | failed ). + // - state-reason-code - The reason code for the state change. + // - state-reason-message - The message for the state change. + // - sriov-net-support - A value of simple indicates that enhanced networking + // with the Intel 82599 VF interface is enabled. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - virtualization-type - The virtualization type ( paravirtual | hvm ). Filters []types.Filter // The image IDs. Default: Describes all images available to you. @@ -185,8 +129,8 @@ type DescribeImagesInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -194,8 +138,8 @@ type DescribeImagesInput struct { NextToken *string // Scopes the results to images with the specified owners. You can specify a - // combination of Amazon Web Services account IDs, self, amazon, and - // aws-marketplace. If you omit this parameter, the results include all images for + // combination of Amazon Web Services account IDs, self , amazon , and + // aws-marketplace . If you omit this parameter, the results include all images for // which you have launch permissions, regardless of ownership. Owners []string @@ -289,8 +233,8 @@ var _ DescribeImagesAPIClient = (*Client)(nil) type DescribeImagesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -383,9 +327,9 @@ type ImageAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -582,9 +526,9 @@ type ImageExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeImportImageTasks.go b/service/ec2/api_op_DescribeImportImageTasks.go index 232e4e2c69c..ab68feaf472 100644 --- a/service/ec2/api_op_DescribeImportImageTasks.go +++ b/service/ec2/api_op_DescribeImportImageTasks.go @@ -33,12 +33,12 @@ type DescribeImportImageTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // Filter tasks using the task-state filter and one of the following values: - // active, completed, deleting, or deleted. + // Filter tasks using the task-state filter and one of the following values: active + // , completed , deleting , or deleted . Filters []types.Filter // The IDs of the import image tasks. diff --git a/service/ec2/api_op_DescribeImportSnapshotTasks.go b/service/ec2/api_op_DescribeImportSnapshotTasks.go index 83f36d22464..5a5c2becc79 100644 --- a/service/ec2/api_op_DescribeImportSnapshotTasks.go +++ b/service/ec2/api_op_DescribeImportSnapshotTasks.go @@ -36,8 +36,8 @@ type DescribeImportSnapshotTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. @@ -239,9 +239,9 @@ type SnapshotImportedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SnapshotImportedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SnapshotImportedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeInstanceAttribute.go b/service/ec2/api_op_DescribeInstanceAttribute.go index f339939cda4..13ecd8c3d46 100644 --- a/service/ec2/api_op_DescribeInstanceAttribute.go +++ b/service/ec2/api_op_DescribeInstanceAttribute.go @@ -46,8 +46,8 @@ type DescribeInstanceAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -60,10 +60,10 @@ type DescribeInstanceAttributeOutput struct { BlockDeviceMappings []types.InstanceBlockDeviceMapping // To enable the instance for Amazon Web Services Stop Protection, set this - // parameter to true; otherwise, set it to false. + // parameter to true ; otherwise, set it to false . DisableApiStop *types.AttributeBooleanValue - // If the value is true, you can't terminate the instance through the Amazon EC2 + // If the value is true , you can't terminate the instance through the Amazon EC2 // console, CLI, or API; otherwise, you can. DisableApiTermination *types.AttributeBooleanValue @@ -74,7 +74,7 @@ type DescribeInstanceAttributeOutput struct { EnaSupport *types.AttributeBooleanValue // To enable the instance for Amazon Web Services Nitro Enclaves, set this - // parameter to true; otherwise, set it to false. + // parameter to true ; otherwise, set it to false . EnclaveOptions *types.EnclaveOptions // The security groups associated with the instance. @@ -99,13 +99,13 @@ type DescribeInstanceAttributeOutput struct { // The RAM disk ID. RamdiskId *types.AttributeValue - // The device name of the root device volume (for example, /dev/sda1). + // The device name of the root device volume (for example, /dev/sda1 ). RootDeviceName *types.AttributeValue // Enable or disable source/destination checks, which ensure that the instance is // either the source or the destination of any traffic that it receives. If the - // value is true, source/destination checks are enabled; otherwise, they are - // disabled. The default value is true. You must disable source/destination checks + // value is true , source/destination checks are enabled; otherwise, they are + // disabled. The default value is true . You must disable source/destination checks // if the instance runs services such as network address translation, routing, or // firewalls. SourceDestCheck *types.AttributeBooleanValue diff --git a/service/ec2/api_op_DescribeInstanceCreditSpecifications.go b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go index 9fa6c6dd673..a6fb492bec2 100644 --- a/service/ec2/api_op_DescribeInstanceCreditSpecifications.go +++ b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go @@ -12,23 +12,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the credit option for CPU usage of the specified burstable performance -// instances. The credit options are standard and unlimited. If you do not specify -// an instance ID, Amazon EC2 returns burstable performance instances with the -// unlimited credit option, as well as instances that were previously configured as -// T2, T3, and T3a with the unlimited credit option. For example, if you resize a -// T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 -// returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 -// returns the credit option (standard or unlimited) of those instances. If you -// specify an instance ID that is not valid, such as an instance that is not a -// burstable performance instance, an error is returned. Recently terminated -// instances might appear in the returned results. This interval is usually less -// than one hour. If an Availability Zone is experiencing a service disruption and -// you specify instance IDs in the affected zone, or do not specify any instance -// IDs at all, the call fails. If you specify only instance IDs in an unaffected -// zone, the call works normally. For more information, see Burstable performance -// instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) +// Describes the credit option for CPU usage of the specified burstable +// performance instances. The credit options are standard and unlimited . If you do +// not specify an instance ID, Amazon EC2 returns burstable performance instances +// with the unlimited credit option, as well as instances that were previously +// configured as T2, T3, and T3a with the unlimited credit option. For example, if +// you resize a T2 instance, while it is configured as unlimited , to an M4 +// instance, Amazon EC2 returns the M4 instance. If you specify one or more +// instance IDs, Amazon EC2 returns the credit option ( standard or unlimited ) of +// those instances. If you specify an instance ID that is not valid, such as an +// instance that is not a burstable performance instance, an error is returned. +// Recently terminated instances might appear in the returned results. This +// interval is usually less than one hour. If an Availability Zone is experiencing +// a service disruption and you specify instance IDs in the affected zone, or do +// not specify any instance IDs at all, the call fails. If you specify only +// instance IDs in an unaffected zone, the call works normally. For more +// information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. func (c *Client) DescribeInstanceCreditSpecifications(ctx context.Context, params *DescribeInstanceCreditSpecificationsInput, optFns ...func(*Options)) (*DescribeInstanceCreditSpecificationsOutput, error) { if params == nil { @@ -49,13 +48,12 @@ type DescribeInstanceCreditSpecificationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * instance-id - The ID of the instance. + // - instance-id - The ID of the instance. Filters []types.Filter // The instance IDs. Default: Describes all your instances. Constraints: Maximum @@ -64,9 +62,8 @@ type DescribeInstanceCreditSpecificationsInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // call. MaxResults *int32 @@ -165,9 +162,8 @@ var _ DescribeInstanceCreditSpecificationsAPIClient = (*Client)(nil) type DescribeInstanceCreditSpecificationsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // call. Limit int32 diff --git a/service/ec2/api_op_DescribeInstanceEventNotificationAttributes.go b/service/ec2/api_op_DescribeInstanceEventNotificationAttributes.go index 52f9a0eb44f..b1484327bdc 100644 --- a/service/ec2/api_op_DescribeInstanceEventNotificationAttributes.go +++ b/service/ec2/api_op_DescribeInstanceEventNotificationAttributes.go @@ -32,8 +32,8 @@ type DescribeInstanceEventNotificationAttributesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeInstanceEventWindows.go b/service/ec2/api_op_DescribeInstanceEventWindows.go index 96b5f65a066..78268d74998 100644 --- a/service/ec2/api_op_DescribeInstanceEventWindows.go +++ b/service/ec2/api_op_DescribeInstanceEventWindows.go @@ -12,16 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified event windows or all event windows. If you specify event -// window IDs, the output includes information for only the specified event +// Describes the specified event windows or all event windows. If you specify +// event window IDs, the output includes information for only the specified event // windows. If you specify filters, the output includes information for only those // event windows that meet the filter criteria. If you do not specify event windows // IDs or filters, the output includes information for all event windows, which can // affect performance. We recommend that you use pagination to ensure that the // operation returns quickly and successfully. For more information, see Define -// event windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// event windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeInstanceEventWindows(ctx context.Context, params *DescribeInstanceEventWindowsInput, optFns ...func(*Options)) (*DescribeInstanceEventWindowsOutput, error) { if params == nil { params = &DescribeInstanceEventWindowsInput{} @@ -42,44 +41,32 @@ type DescribeInstanceEventWindowsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * dedicated-host-id - The event windows associated with - // the specified Dedicated Host ID. - // - // * event-window-name - The event windows - // associated with the specified names. - // - // * instance-id - The event windows - // associated with the specified instance ID. - // - // * instance-tag - The event windows - // associated with the specified tag and value. - // - // * instance-tag-key - The event - // windows associated with the specified tag key, regardless of the value. - // - // * - // instance-tag-value - The event windows associated with the specified tag value, - // regardless of the key. - // - // * tag: - The key/value combination of a tag assigned to - // the event window. Use the tag key in the filter name and the tag value as the - // filter value. For example, to find all resources that have a tag with the key - // Owner and the value CMX, specify tag:Owner for the filter name and CMX for the - // filter value. - // - // * tag-key - The key of a tag assigned to the event window. Use - // this filter to find all event windows that have a tag with a specific key, - // regardless of the tag value. - // - // * tag-value - The value of a tag assigned to the - // event window. Use this filter to find all event windows that have a tag with a - // specific value, regardless of the tag key. + // - dedicated-host-id - The event windows associated with the specified + // Dedicated Host ID. + // - event-window-name - The event windows associated with the specified names. + // - instance-id - The event windows associated with the specified instance ID. + // - instance-tag - The event windows associated with the specified tag and + // value. + // - instance-tag-key - The event windows associated with the specified tag key, + // regardless of the value. + // - instance-tag-value - The event windows associated with the specified tag + // value, regardless of the key. + // - tag: - The key/value combination of a tag assigned to the event window. Use + // the tag key in the filter name and the tag value as the filter value. For + // example, to find all resources that have a tag with the key Owner and the + // value CMX , specify tag:Owner for the filter name and CMX for the filter + // value. + // - tag-key - The key of a tag assigned to the event window. Use this filter to + // find all event windows that have a tag with a specific key, regardless of the + // tag value. + // - tag-value - The value of a tag assigned to the event window. Use this filter + // to find all event windows that have a tag with a specific value, regardless of + // the tag key. Filters []types.Filter // The IDs of the event windows. diff --git a/service/ec2/api_op_DescribeInstanceStatus.go b/service/ec2/api_op_DescribeInstanceStatus.go index 74c6661d774..9bbab3ab413 100644 --- a/service/ec2/api_op_DescribeInstanceStatus.go +++ b/service/ec2/api_op_DescribeInstanceStatus.go @@ -22,27 +22,19 @@ import ( // default, only running instances are described, unless you specifically indicate // to return the status of all instances. Instance status includes the following // components: -// -// * Status checks - Amazon EC2 performs status checks on running EC2 -// instances to identify hardware and software issues. For more information, see -// Status checks for your instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html) -// and Troubleshoot instances with failed status checks -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html) -// in the Amazon EC2 User Guide. -// -// * Scheduled events - Amazon EC2 can schedule -// events (such as reboot, stop, or terminate) for your instances related to -// hardware issues, software updates, or system maintenance. For more information, -// see Scheduled events for your instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) -// in the Amazon EC2 User Guide. -// -// * Instance state - You can manage your instances -// from the moment you launch them through their termination. For more information, -// see Instance lifecycle -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) -// in the Amazon EC2 User Guide. +// - Status checks - Amazon EC2 performs status checks on running EC2 instances +// to identify hardware and software issues. For more information, see Status +// checks for your instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html) +// and Troubleshoot instances with failed status checks (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html) +// in the Amazon EC2 User Guide. +// - Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or +// terminate) for your instances related to hardware issues, software updates, or +// system maintenance. For more information, see Scheduled events for your +// instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) +// in the Amazon EC2 User Guide. +// - Instance state - You can manage your instances from the moment you launch +// them through their termination. For more information, see Instance lifecycle (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeInstanceStatus(ctx context.Context, params *DescribeInstanceStatusInput, optFns ...func(*Options)) (*DescribeInstanceStatusOutput, error) { if params == nil { params = &DescribeInstanceStatusInput{} @@ -62,62 +54,41 @@ type DescribeInstanceStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * availability-zone - The Availability Zone of the instance. - // - // * - // event.code - The code for the scheduled event (instance-reboot | system-reboot | - // system-maintenance | instance-retirement | instance-stop). - // - // * event.description - // - A description of the event. - // - // * event.instance-event-id - The ID of the event - // whose date and time you are modifying. - // - // * event.not-after - The latest end time - // for the scheduled event (for example, 2014-09-15T17:15:20.000Z). - // - // * - // event.not-before - The earliest start time for the scheduled event (for example, - // 2014-09-15T17:15:20.000Z). - // - // * event.not-before-deadline - The deadline for - // starting the event (for example, 2014-09-15T17:15:20.000Z). - // - // * - // instance-state-code - The code for the instance state, as a 16-bit unsigned - // integer. The high byte is used for internal purposes and should be ignored. The - // low byte is set based on the state represented. The valid values are 0 - // (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and - // 80 (stopped). - // - // * instance-state-name - The state of the instance (pending | - // running | shutting-down | terminated | stopping | stopped). - // - // * - // instance-status.reachability - Filters on instance status where the name is - // reachability (passed | failed | initializing | insufficient-data). - // - // * - // instance-status.status - The status of the instance (ok | impaired | - // initializing | insufficient-data | not-applicable). - // - // * - // system-status.reachability - Filters on system status where the name is - // reachability (passed | failed | initializing | insufficient-data). - // - // * - // system-status.status - The system status of the instance (ok | impaired | - // initializing | insufficient-data | not-applicable). + // - availability-zone - The Availability Zone of the instance. + // - event.code - The code for the scheduled event ( instance-reboot | + // system-reboot | system-maintenance | instance-retirement | instance-stop ). + // - event.description - A description of the event. + // - event.instance-event-id - The ID of the event whose date and time you are + // modifying. + // - event.not-after - The latest end time for the scheduled event (for example, + // 2014-09-15T17:15:20.000Z ). + // - event.not-before - The earliest start time for the scheduled event (for + // example, 2014-09-15T17:15:20.000Z ). + // - event.not-before-deadline - The deadline for starting the event (for + // example, 2014-09-15T17:15:20.000Z ). + // - instance-state-code - The code for the instance state, as a 16-bit unsigned + // integer. The high byte is used for internal purposes and should be ignored. The + // low byte is set based on the state represented. The valid values are 0 + // (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and + // 80 (stopped). + // - instance-state-name - The state of the instance ( pending | running | + // shutting-down | terminated | stopping | stopped ). + // - instance-status.reachability - Filters on instance status where the name is + // reachability ( passed | failed | initializing | insufficient-data ). + // - instance-status.status - The status of the instance ( ok | impaired | + // initializing | insufficient-data | not-applicable ). + // - system-status.reachability - Filters on system status where the name is + // reachability ( passed | failed | initializing | insufficient-data ). + // - system-status.status - The system status of the instance ( ok | impaired | + // initializing | insufficient-data | not-applicable ). Filters []types.Filter - // When true, includes the health status for all instances. When false, includes + // When true , includes the health status for all instances. When false , includes // the health status for running instances only. Default: false IncludeAllInstances *bool @@ -127,9 +98,8 @@ type DescribeInstanceStatusInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // request. MaxResults *int32 @@ -228,9 +198,8 @@ var _ DescribeInstanceStatusAPIClient = (*Client)(nil) type DescribeInstanceStatusPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // request. Limit int32 @@ -324,9 +293,9 @@ type InstanceStatusOkWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceStatusOkWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceStatusOkWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -511,9 +480,9 @@ type SystemStatusOkWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SystemStatusOkWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SystemStatusOkWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeInstanceTypeOfferings.go b/service/ec2/api_op_DescribeInstanceTypeOfferings.go index 01bae05e514..868dddb1619 100644 --- a/service/ec2/api_op_DescribeInstanceTypeOfferings.go +++ b/service/ec2/api_op_DescribeInstanceTypeOfferings.go @@ -34,18 +34,15 @@ type DescribeInstanceTypeOfferingsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * location - - // This depends on the location type. For example, if the location type is region - // (default), the location is the Region code (for example, us-east-2.) - // - // * - // instance-type - The instance type. For example, c5.2xlarge. + // - location - This depends on the location type. For example, if the location + // type is region (default), the location is the Region code (for example, + // us-east-2 .) + // - instance-type - The instance type. For example, c5.2xlarge . Filters []types.Filter // The location type. @@ -53,8 +50,8 @@ type DescribeInstanceTypeOfferingsInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -152,8 +149,8 @@ var _ DescribeInstanceTypeOfferingsAPIClient = (*Client)(nil) type DescribeInstanceTypeOfferingsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeInstanceTypes.go b/service/ec2/api_op_DescribeInstanceTypes.go index 770dc391a2b..790e7836ba6 100644 --- a/service/ec2/api_op_DescribeInstanceTypes.go +++ b/service/ec2/api_op_DescribeInstanceTypes.go @@ -33,183 +33,105 @@ type DescribeInstanceTypesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - // * - // auto-recovery-supported - Indicates whether auto recovery is supported (true | - // false). - // - // * bare-metal - Indicates whether it is a bare metal instance type (true - // | false). - // - // * burstable-performance-supported - Indicates whether it is a - // burstable performance instance type (true | false). - // - // * current-generation - - // Indicates whether this instance type is the latest generation instance type of - // an instance family (true | false). - // - // * - // ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth - // performance for an EBS-optimized instance type, in Mbps. - // - // * - // ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage - // operations per second for an EBS-optimized instance type. - // - // * - // ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline - // throughput performance for an EBS-optimized instance type, in MB/s. - // - // * - // ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth - // performance for an EBS-optimized instance type, in Mbps. - // - // * - // ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage - // operations per second for an EBS-optimized instance type. - // - // * - // ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput - // performance for an EBS-optimized instance type, in MB/s. - // - // * - // ebs-info.ebs-optimized-support - Indicates whether the instance type is - // EBS-optimized (supported | unsupported | default). - // - // * - // ebs-info.encryption-support - Indicates whether EBS encryption is supported - // (supported | unsupported). - // - // * ebs-info.nvme-support - Indicates whether - // non-volatile memory express (NVMe) is supported for EBS volumes (required | - // supported | unsupported). - // - // * free-tier-eligible - Indicates whether the instance - // type is eligible to use in the free tier (true | false). - // - // * - // hibernation-supported - Indicates whether On-Demand hibernation is supported - // (true | false). - // - // * hypervisor - The hypervisor (nitro | xen). - // - // * - // instance-storage-info.disk.count - The number of local disks. - // - // * - // instance-storage-info.disk.size-in-gb - The storage size of each instance - // storage disk, in GB. - // - // * instance-storage-info.disk.type - The storage technology - // for the local instance storage disks (hdd | ssd). - // - // * - // instance-storage-info.encryption-support - Indicates whether data is encrypted - // at rest (required | supported | unsupported). - // - // * - // instance-storage-info.nvme-support - Indicates whether non-volatile memory - // express (NVMe) is supported for instance store (required | supported | - // unsupported). - // - // * instance-storage-info.total-size-in-gb - The total amount of - // storage available from all local instance storage, in GB. - // - // * - // instance-storage-supported - Indicates whether the instance type has local - // instance storage (true | false). - // - // * instance-type - The instance type (for - // example c5.2xlarge or c5*). - // - // * memory-info.size-in-mib - The memory size. - // - // * - // network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic - // Fabric Adapters (EFAs) per instance. - // - // * network-info.efa-supported - Indicates - // whether the instance type supports Elastic Fabric Adapter (EFA) (true | - // false). - // - // * network-info.ena-support - Indicates whether Elastic Network Adapter - // (ENA) is supported or required (required | supported | unsupported). - // - // * - // network-info.encryption-in-transit-supported - Indicates whether the instance - // type automatically encrypts in-transit traffic between instances (true | - // false). - // - // * network-info.ipv4-addresses-per-interface - The maximum number of - // private IPv4 addresses per network interface. - // - // * - // network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 - // addresses per network interface. - // - // * network-info.ipv6-supported - Indicates - // whether the instance type supports IPv6 (true | false). - // - // * - // network-info.maximum-network-cards - The maximum number of network cards per - // instance. - // - // * network-info.maximum-network-interfaces - The maximum number of - // network interfaces per instance. - // - // * network-info.network-performance - The - // network performance (for example, "25 Gigabit"). - // - // * - // processor-info.supported-architecture - The CPU architecture (arm64 | i386 | - // x86_64). - // - // * processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, - // in GHz. - // - // * supported-boot-mode - The boot mode (legacy-bios | uefi). - // - // * - // supported-root-device-type - The root device type (ebs | instance-store). - // - // * - // supported-usage-class - The usage class (on-demand | spot). - // - // * - // supported-virtualization-type - The virtualization type (hvm | paravirtual). - // - // * - // vcpu-info.default-cores - The default number of cores for the instance type. - // - // * - // vcpu-info.default-threads-per-core - The default number of threads per core for - // the instance type. - // - // * vcpu-info.default-vcpus - The default number of vCPUs for - // the instance type. - // - // * vcpu-info.valid-cores - The number of cores that can be - // configured for the instance type. - // - // * vcpu-info.valid-threads-per-core - The - // number of threads per core that can be configured for the instance type. For - // example, "1" or "1,2". + // - auto-recovery-supported - Indicates whether auto recovery is supported ( true + // | false ). + // - bare-metal - Indicates whether it is a bare metal instance type ( true | + // false ). + // - burstable-performance-supported - Indicates whether it is a burstable + // performance instance type ( true | false ). + // - current-generation - Indicates whether this instance type is the latest + // generation instance type of an instance family ( true | false ). + // - ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline + // bandwidth performance for an EBS-optimized instance type, in Mbps. + // - ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output + // storage operations per second for an EBS-optimized instance type. + // - ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline + // throughput performance for an EBS-optimized instance type, in MB/s. + // - ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum + // bandwidth performance for an EBS-optimized instance type, in Mbps. + // - ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage + // operations per second for an EBS-optimized instance type. + // - ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum + // throughput performance for an EBS-optimized instance type, in MB/s. + // - ebs-info.ebs-optimized-support - Indicates whether the instance type is + // EBS-optimized ( supported | unsupported | default ). + // - ebs-info.encryption-support - Indicates whether EBS encryption is supported ( + // supported | unsupported ). + // - ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) + // is supported for EBS volumes ( required | supported | unsupported ). + // - free-tier-eligible - Indicates whether the instance type is eligible to use + // in the free tier ( true | false ). + // - hibernation-supported - Indicates whether On-Demand hibernation is supported + // ( true | false ). + // - hypervisor - The hypervisor ( nitro | xen ). + // - instance-storage-info.disk.count - The number of local disks. + // - instance-storage-info.disk.size-in-gb - The storage size of each instance + // storage disk, in GB. + // - instance-storage-info.disk.type - The storage technology for the local + // instance storage disks ( hdd | ssd ). + // - instance-storage-info.encryption-support - Indicates whether data is + // encrypted at rest ( required | supported | unsupported ). + // - instance-storage-info.nvme-support - Indicates whether non-volatile memory + // express (NVMe) is supported for instance store ( required | supported | + // unsupported ). + // - instance-storage-info.total-size-in-gb - The total amount of storage + // available from all local instance storage, in GB. + // - instance-storage-supported - Indicates whether the instance type has local + // instance storage ( true | false ). + // - instance-type - The instance type (for example c5.2xlarge or c5*). + // - memory-info.size-in-mib - The memory size. + // - network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic + // Fabric Adapters (EFAs) per instance. + // - network-info.efa-supported - Indicates whether the instance type supports + // Elastic Fabric Adapter (EFA) ( true | false ). + // - network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) + // is supported or required ( required | supported | unsupported ). + // - network-info.encryption-in-transit-supported - Indicates whether the + // instance type automatically encrypts in-transit traffic between instances ( + // true | false ). + // - network-info.ipv4-addresses-per-interface - The maximum number of private + // IPv4 addresses per network interface. + // - network-info.ipv6-addresses-per-interface - The maximum number of private + // IPv6 addresses per network interface. + // - network-info.ipv6-supported - Indicates whether the instance type supports + // IPv6 ( true | false ). + // - network-info.maximum-network-cards - The maximum number of network cards per + // instance. + // - network-info.maximum-network-interfaces - The maximum number of network + // interfaces per instance. + // - network-info.network-performance - The network performance (for example, "25 + // Gigabit"). + // - processor-info.supported-architecture - The CPU architecture ( arm64 | i386 + // | x86_64 ). + // - processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz. + // - supported-boot-mode - The boot mode ( legacy-bios | uefi ). + // - supported-root-device-type - The root device type ( ebs | instance-store ). + // - supported-usage-class - The usage class ( on-demand | spot ). + // - supported-virtualization-type - The virtualization type ( hvm | paravirtual + // ). + // - vcpu-info.default-cores - The default number of cores for the instance type. + // - vcpu-info.default-threads-per-core - The default number of threads per core + // for the instance type. + // - vcpu-info.default-vcpus - The default number of vCPUs for the instance type. + // - vcpu-info.valid-cores - The number of cores that can be configured for the + // instance type. + // - vcpu-info.valid-threads-per-core - The number of threads per core that can + // be configured for the instance type. For example, "1" or "1,2". Filters []types.Filter - // The instance types. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // The instance types. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. InstanceTypes []types.InstanceType // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -221,9 +143,8 @@ type DescribeInstanceTypesInput struct { type DescribeInstanceTypesOutput struct { - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. InstanceTypes []types.InstanceTypeInfo // The token to include in another request to get the next page of items. This @@ -309,8 +230,8 @@ var _ DescribeInstanceTypesAPIClient = (*Client)(nil) type DescribeInstanceTypesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeInstances.go b/service/ec2/api_op_DescribeInstances.go index 77f49d90a08..b7ff8b5fe74 100644 --- a/service/ec2/api_op_DescribeInstances.go +++ b/service/ec2/api_op_DescribeInstances.go @@ -19,11 +19,11 @@ import ( "time" ) -// Describes the specified instances or all instances. If you specify instance IDs, -// the output includes information for only the specified instances. If you specify -// filters, the output includes information for only those instances that meet the -// filter criteria. If you do not specify instance IDs or filters, the output -// includes information for all instances, which can affect performance. We +// Describes the specified instances or all instances. If you specify instance +// IDs, the output includes information for only the specified instances. If you +// specify filters, the output includes information for only those instances that +// meet the filter criteria. If you do not specify instance IDs or filters, the +// output includes information for all instances, which can affect performance. We // recommend that you use pagination to ensure that the operation returns quickly // and successfully. If you specify an instance ID that is not valid, an error is // returned. If you specify an instance that you do not own, it is not included in @@ -52,326 +52,176 @@ type DescribeInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * affinity - The affinity setting for an instance running on a - // Dedicated Host (default | host). - // - // * architecture - The instance architecture - // (i386 | x86_64 | arm64). - // - // * availability-zone - The Availability Zone of the - // instance. - // - // * block-device-mapping.attach-time - The attach time for an EBS - // volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z. - // - // * - // block-device-mapping.delete-on-termination - A Boolean that indicates whether - // the EBS volume is deleted on instance termination. - // - // * - // block-device-mapping.device-name - The device name specified in the block device - // mapping (for example, /dev/sdh or xvdh). - // - // * block-device-mapping.status - The - // status for the EBS volume (attaching | attached | detaching | detached). - // - // * - // block-device-mapping.volume-id - The volume ID of the EBS volume. - // - // * - // capacity-reservation-id - The ID of the Capacity Reservation into which the - // instance was launched. - // - // * client-token - The idempotency token you provided when - // you launched the instance. - // - // * dns-name - The public DNS name of the instance. - // - // * - // group-id - The ID of the security group for the instance. EC2-Classic only. - // - // * - // group-name - The name of the security group for the instance. EC2-Classic - // only. - // - // * hibernation-options.configured - A Boolean that indicates whether the - // instance is enabled for hibernation. A value of true means that the instance is - // enabled for hibernation. - // - // * host-id - The ID of the Dedicated Host on which the - // instance is running, if applicable. - // - // * hypervisor - The hypervisor type of the - // instance (ovm | xen). The value xen is used for both Xen and Nitro - // hypervisors. - // - // * iam-instance-profile.arn - The instance profile associated with - // the instance. Specified as an ARN. - // - // * image-id - The ID of the image used to - // launch the instance. - // - // * instance-id - The ID of the instance. - // - // * - // instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled - // Instance (spot | scheduled). - // - // * instance-state-code - The state of the instance, - // as a 16-bit unsigned integer. The high byte is used for internal purposes and - // should be ignored. The low byte is set based on the state represented. The valid - // values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 - // (stopping), and 80 (stopped). - // - // * instance-state-name - The state of the instance - // (pending | running | shutting-down | terminated | stopping | stopped). - // - // * - // instance-type - The type of instance (for example, t2.micro). - // - // * - // instance.group-id - The ID of the security group for the instance. - // - // * - // instance.group-name - The name of the security group for the instance. - // - // * - // ip-address - The public IPv4 address of the instance. - // - // * kernel-id - The kernel - // ID. - // - // * key-name - The name of the key pair used when the instance was - // launched. - // - // * launch-index - When launching multiple instances, this is the index - // for the instance in the launch group (for example, 0, 1, 2, and so on). - // - // * - // launch-time - The time when the instance was launched, in the ISO 8601 format in - // the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, - // 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, - // which matches an entire day. - // - // * metadata-options.http-tokens - The metadata - // request authorization state (optional | required) - // - // * - // metadata-options.http-put-response-hop-limit - The HTTP metadata request put - // response hop limit (integer, possible values 1 to 64) - // - // * - // metadata-options.http-endpoint - The status of access to the HTTP metadata - // endpoint on your instance (enabled | disabled) - // - // * - // metadata-options.instance-metadata-tags - The status of access to instance tags - // from the instance metadata (enabled | disabled) - // - // * monitoring-state - Indicates - // whether detailed monitoring is enabled (disabled | enabled). - // - // * - // network-interface.addresses.private-ip-address - The private IPv4 address - // associated with the network interface. - // - // * network-interface.addresses.primary - - // Specifies whether the IPv4 address of the network interface is the primary - // private IPv4 address. - // - // * network-interface.addresses.association.public-ip - The - // ID of the association of an Elastic IP address (IPv4) with a network - // interface. - // - // * network-interface.addresses.association.ip-owner-id - The owner ID - // of the private IPv4 address associated with the network interface. - // - // * - // network-interface.association.public-ip - The address of the Elastic IP address - // (IPv4) bound to the network interface. - // - // * - // network-interface.association.ip-owner-id - The owner of the Elastic IP address - // (IPv4) associated with the network interface. - // - // * - // network-interface.association.allocation-id - The allocation ID returned when - // you allocated the Elastic IP address (IPv4) for your network interface. - // - // * - // network-interface.association.association-id - The association ID returned when - // the network interface was associated with an IPv4 address. - // - // * - // network-interface.attachment.attachment-id - The ID of the interface - // attachment. - // - // * network-interface.attachment.instance-id - The ID of the instance - // to which the network interface is attached. - // - // * - // network-interface.attachment.instance-owner-id - The owner ID of the instance to - // which the network interface is attached. - // - // * - // network-interface.attachment.device-index - The device index to which the - // network interface is attached. - // - // * network-interface.attachment.status - The - // status of the attachment (attaching | attached | detaching | detached). - // - // * - // network-interface.attachment.attach-time - The time that the network interface - // was attached to an instance. - // - // * - // network-interface.attachment.delete-on-termination - Specifies whether the - // attachment is deleted when an instance is terminated. - // - // * - // network-interface.availability-zone - The Availability Zone for the network - // interface. - // - // * network-interface.description - The description of the network - // interface. - // - // * network-interface.group-id - The ID of a security group associated - // with the network interface. - // - // * network-interface.group-name - The name of a - // security group associated with the network interface. - // - // * - // network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with - // the network interface. - // - // * network-interface.mac-address - The MAC address of the - // network interface. - // - // * network-interface.network-interface-id - The ID of the - // network interface. - // - // * network-interface.owner-id - The ID of the owner of the - // network interface. - // - // * network-interface.private-dns-name - The private DNS name - // of the network interface. - // - // * network-interface.requester-id - The requester ID - // for the network interface. - // - // * network-interface.requester-managed - Indicates - // whether the network interface is being managed by Amazon Web Services. - // - // * - // network-interface.status - The status of the network interface (available) | - // in-use). - // - // * network-interface.source-dest-check - Whether the network interface - // performs source/destination checking. A value of true means that checking is - // enabled, and false means that checking is disabled. The value must be false for - // the network interface to perform network address translation (NAT) in your - // VPC. - // - // * network-interface.subnet-id - The ID of the subnet for the network - // interface. - // - // * network-interface.vpc-id - The ID of the VPC for the network - // interface. - // - // * outpost-arn - The Amazon Resource Name (ARN) of the Outpost. - // - // * - // owner-id - The Amazon Web Services account ID of the instance owner. - // - // * - // placement-group-name - The name of the placement group for the instance. - // - // * - // placement-partition-number - The partition in which the instance is located. - // - // * - // platform - The platform. To list only Windows instances, use windows. - // - // * - // private-dns-name - The private IPv4 DNS name of the instance. - // - // * - // private-ip-address - The private IPv4 address of the instance. - // - // * product-code - - // The product code associated with the AMI used to launch the instance. - // - // * - // product-code.type - The type of product code (devpay | marketplace). - // - // * - // ramdisk-id - The RAM disk ID. - // - // * reason - The reason for the current state of - // the instance (for example, shows "User Initiated [date]" when you stop or - // terminate the instance). Similar to the state-reason-code filter. - // - // * - // requester-id - The ID of the entity that launched the instance on your behalf - // (for example, Amazon Web Services Management Console, Auto Scaling, and so - // on). - // - // * reservation-id - The ID of the instance's reservation. A reservation ID - // is created any time you launch an instance. A reservation ID has a one-to-one - // relationship with an instance launch request, but can be associated with more - // than one instance if you launch multiple instances using the same launch - // request. For example, if you launch one instance, you get one reservation ID. If - // you launch ten instances using the same launch request, you also get one - // reservation ID. - // - // * root-device-name - The device name of the root device volume - // (for example, /dev/sda1). - // - // * root-device-type - The type of the root device - // volume (ebs | instance-store). - // - // * source-dest-check - Indicates whether the - // instance performs source/destination checking. A value of true means that - // checking is enabled, and false means that checking is disabled. The value must - // be false for the instance to perform network address translation (NAT) in your - // VPC. - // - // * spot-instance-request-id - The ID of the Spot Instance request. - // - // * - // state-reason-code - The reason code for the state change. - // - // * - // state-reason-message - A message that describes the state change. - // - // * subnet-id - - // The ID of the subnet for the instance. - // - // * tag: - The key/value combination of a - // tag assigned to the resource. Use the tag key in the filter name and the tag - // value as the filter value. For example, to find all resources that have a tag - // with the key Owner and the value TeamA, specify tag:Owner for the filter name - // and TeamA for the filter value. - // - // * tag-key - The key of a tag assigned to the - // resource. Use this filter to find all resources that have a tag with a specific - // key, regardless of the tag value. - // - // * tenancy - The tenancy of an instance - // (dedicated | default | host). - // - // * virtualization-type - The virtualization type - // of the instance (paravirtual | hvm). - // - // * vpc-id - The ID of the VPC that the - // instance is running in. + // - affinity - The affinity setting for an instance running on a Dedicated Host ( + // default | host ). + // - architecture - The instance architecture ( i386 | x86_64 | arm64 ). + // - availability-zone - The Availability Zone of the instance. + // - block-device-mapping.attach-time - The attach time for an EBS volume mapped + // to the instance, for example, 2010-09-15T17:15:20.000Z . + // - block-device-mapping.delete-on-termination - A Boolean that indicates + // whether the EBS volume is deleted on instance termination. + // - block-device-mapping.device-name - The device name specified in the block + // device mapping (for example, /dev/sdh or xvdh ). + // - block-device-mapping.status - The status for the EBS volume ( attaching | + // attached | detaching | detached ). + // - block-device-mapping.volume-id - The volume ID of the EBS volume. + // - capacity-reservation-id - The ID of the Capacity Reservation into which the + // instance was launched. + // - client-token - The idempotency token you provided when you launched the + // instance. + // - dns-name - The public DNS name of the instance. + // - group-id - The ID of the security group for the instance. EC2-Classic only. + // - group-name - The name of the security group for the instance. EC2-Classic + // only. + // - hibernation-options.configured - A Boolean that indicates whether the + // instance is enabled for hibernation. A value of true means that the instance + // is enabled for hibernation. + // - host-id - The ID of the Dedicated Host on which the instance is running, if + // applicable. + // - hypervisor - The hypervisor type of the instance ( ovm | xen ). The value + // xen is used for both Xen and Nitro hypervisors. + // - iam-instance-profile.arn - The instance profile associated with the + // instance. Specified as an ARN. + // - image-id - The ID of the image used to launch the instance. + // - instance-id - The ID of the instance. + // - instance-lifecycle - Indicates whether this is a Spot Instance or a + // Scheduled Instance ( spot | scheduled ). + // - instance-state-code - The state of the instance, as a 16-bit unsigned + // integer. The high byte is used for internal purposes and should be ignored. The + // low byte is set based on the state represented. The valid values are: 0 + // (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and + // 80 (stopped). + // - instance-state-name - The state of the instance ( pending | running | + // shutting-down | terminated | stopping | stopped ). + // - instance-type - The type of instance (for example, t2.micro ). + // - instance.group-id - The ID of the security group for the instance. + // - instance.group-name - The name of the security group for the instance. + // - ip-address - The public IPv4 address of the instance. + // - kernel-id - The kernel ID. + // - key-name - The name of the key pair used when the instance was launched. + // - launch-index - When launching multiple instances, this is the index for the + // instance in the launch group (for example, 0, 1, 2, and so on). + // - launch-time - The time when the instance was launched, in the ISO 8601 + // format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, + // 2021-09-29T11:04:43.305Z . You can use a wildcard ( * ), for example, + // 2021-09-29T* , which matches an entire day. + // - metadata-options.http-tokens - The metadata request authorization state ( + // optional | required ) + // - metadata-options.http-put-response-hop-limit - The HTTP metadata request put + // response hop limit (integer, possible values 1 to 64 ) + // - metadata-options.http-endpoint - The status of access to the HTTP metadata + // endpoint on your instance ( enabled | disabled ) + // - metadata-options.instance-metadata-tags - The status of access to instance + // tags from the instance metadata ( enabled | disabled ) + // - monitoring-state - Indicates whether detailed monitoring is enabled ( + // disabled | enabled ). + // - network-interface.addresses.private-ip-address - The private IPv4 address + // associated with the network interface. + // - network-interface.addresses.primary - Specifies whether the IPv4 address of + // the network interface is the primary private IPv4 address. + // - network-interface.addresses.association.public-ip - The ID of the + // association of an Elastic IP address (IPv4) with a network interface. + // - network-interface.addresses.association.ip-owner-id - The owner ID of the + // private IPv4 address associated with the network interface. + // - network-interface.association.public-ip - The address of the Elastic IP + // address (IPv4) bound to the network interface. + // - network-interface.association.ip-owner-id - The owner of the Elastic IP + // address (IPv4) associated with the network interface. + // - network-interface.association.allocation-id - The allocation ID returned + // when you allocated the Elastic IP address (IPv4) for your network interface. + // - network-interface.association.association-id - The association ID returned + // when the network interface was associated with an IPv4 address. + // - network-interface.attachment.attachment-id - The ID of the interface + // attachment. + // - network-interface.attachment.instance-id - The ID of the instance to which + // the network interface is attached. + // - network-interface.attachment.instance-owner-id - The owner ID of the + // instance to which the network interface is attached. + // - network-interface.attachment.device-index - The device index to which the + // network interface is attached. + // - network-interface.attachment.status - The status of the attachment ( + // attaching | attached | detaching | detached ). + // - network-interface.attachment.attach-time - The time that the network + // interface was attached to an instance. + // - network-interface.attachment.delete-on-termination - Specifies whether the + // attachment is deleted when an instance is terminated. + // - network-interface.availability-zone - The Availability Zone for the network + // interface. + // - network-interface.description - The description of the network interface. + // - network-interface.group-id - The ID of a security group associated with the + // network interface. + // - network-interface.group-name - The name of a security group associated with + // the network interface. + // - network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated + // with the network interface. + // - network-interface.mac-address - The MAC address of the network interface. + // - network-interface.network-interface-id - The ID of the network interface. + // - network-interface.owner-id - The ID of the owner of the network interface. + // - network-interface.private-dns-name - The private DNS name of the network + // interface. + // - network-interface.requester-id - The requester ID for the network interface. + // - network-interface.requester-managed - Indicates whether the network + // interface is being managed by Amazon Web Services. + // - network-interface.status - The status of the network interface ( available ) + // | in-use ). + // - network-interface.source-dest-check - Whether the network interface performs + // source/destination checking. A value of true means that checking is enabled, + // and false means that checking is disabled. The value must be false for the + // network interface to perform network address translation (NAT) in your VPC. + // - network-interface.subnet-id - The ID of the subnet for the network + // interface. + // - network-interface.vpc-id - The ID of the VPC for the network interface. + // - outpost-arn - The Amazon Resource Name (ARN) of the Outpost. + // - owner-id - The Amazon Web Services account ID of the instance owner. + // - placement-group-name - The name of the placement group for the instance. + // - placement-partition-number - The partition in which the instance is located. + // - platform - The platform. To list only Windows instances, use windows . + // - private-dns-name - The private IPv4 DNS name of the instance. + // - private-ip-address - The private IPv4 address of the instance. + // - product-code - The product code associated with the AMI used to launch the + // instance. + // - product-code.type - The type of product code ( devpay | marketplace ). + // - ramdisk-id - The RAM disk ID. + // - reason - The reason for the current state of the instance (for example, + // shows "User Initiated [date]" when you stop or terminate the instance). Similar + // to the state-reason-code filter. + // - requester-id - The ID of the entity that launched the instance on your + // behalf (for example, Amazon Web Services Management Console, Auto Scaling, and + // so on). + // - reservation-id - The ID of the instance's reservation. A reservation ID is + // created any time you launch an instance. A reservation ID has a one-to-one + // relationship with an instance launch request, but can be associated with more + // than one instance if you launch multiple instances using the same launch + // request. For example, if you launch one instance, you get one reservation ID. If + // you launch ten instances using the same launch request, you also get one + // reservation ID. + // - root-device-name - The device name of the root device volume (for example, + // /dev/sda1 ). + // - root-device-type - The type of the root device volume ( ebs | instance-store + // ). + // - source-dest-check - Indicates whether the instance performs + // source/destination checking. A value of true means that checking is enabled, + // and false means that checking is disabled. The value must be false for the + // instance to perform network address translation (NAT) in your VPC. + // - spot-instance-request-id - The ID of the Spot Instance request. + // - state-reason-code - The reason code for the state change. + // - state-reason-message - A message that describes the state change. + // - subnet-id - The ID of the subnet for the instance. + // - tag: - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources that have a tag with a specific key, regardless of the tag value. + // - tenancy - The tenancy of an instance ( dedicated | default | host ). + // - virtualization-type - The virtualization type of the instance ( paravirtual + // | hvm ). + // - vpc-id - The ID of the VPC that the instance is running in. Filters []types.Filter // The instance IDs. Default: Describes all your instances. @@ -379,9 +229,8 @@ type DescribeInstancesInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // request. MaxResults *int32 @@ -479,9 +328,8 @@ var _ DescribeInstancesAPIClient = (*Client)(nil) type DescribeInstancesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the instance IDs parameter in the same + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the instance IDs parameter in the same // request. Limit int32 @@ -575,9 +423,9 @@ type InstanceExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -751,9 +599,9 @@ type InstanceRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceRunningWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceRunningWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -793,9 +641,9 @@ func NewInstanceRunningWaiter(client DescribeInstancesAPIClient, optFns ...func( } } -// Wait calls the waiter function for InstanceRunning waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for InstanceRunning waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *InstanceRunningWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceRunningWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -1010,9 +858,9 @@ type InstanceStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceStoppedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceStoppedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -1052,9 +900,9 @@ func NewInstanceStoppedWaiter(client DescribeInstancesAPIClient, optFns ...func( } } -// Wait calls the waiter function for InstanceStopped waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for InstanceStopped waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *InstanceStoppedWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceStoppedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -1233,8 +1081,8 @@ type InstanceTerminatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceTerminatedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceTerminatedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/ec2/api_op_DescribeInternetGateways.go b/service/ec2/api_op_DescribeInternetGateways.go index fa033eaf57e..48a0ecc5edd 100644 --- a/service/ec2/api_op_DescribeInternetGateways.go +++ b/service/ec2/api_op_DescribeInternetGateways.go @@ -39,33 +39,23 @@ type DescribeInternetGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * attachment.state - The current state of the attachment - // between the gateway and the VPC (available). Present only if a VPC is - // attached. - // - // * attachment.vpc-id - The ID of an attached VPC. - // - // * - // internet-gateway-id - The ID of the Internet gateway. - // - // * owner-id - The ID of - // the Amazon Web Services account that owns the internet gateway. - // - // * tag: - The - // key/value combination of a tag assigned to the resource. Use the tag key in the - // filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. + // - attachment.state - The current state of the attachment between the gateway + // and the VPC ( available ). Present only if a VPC is attached. + // - attachment.vpc-id - The ID of an attached VPC. + // - internet-gateway-id - The ID of the Internet gateway. + // - owner-id - The ID of the Amazon Web Services account that owns the internet + // gateway. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // One or more internet gateway IDs. Default: Describes all your internet gateways. @@ -73,8 +63,8 @@ type DescribeInternetGatewaysInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -172,8 +162,8 @@ var _ DescribeInternetGatewaysAPIClient = (*Client)(nil) type DescribeInternetGatewaysPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -268,9 +258,10 @@ type InternetGatewayExistsWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InternetGatewayExistsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InternetGatewayExistsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeIpamPools.go b/service/ec2/api_op_DescribeIpamPools.go index ef33ef219c9..4da3c929ce7 100644 --- a/service/ec2/api_op_DescribeIpamPools.go +++ b/service/ec2/api_op_DescribeIpamPools.go @@ -32,13 +32,13 @@ type DescribeIpamPoolsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The IDs of the IPAM pools you would like information on. diff --git a/service/ec2/api_op_DescribeIpamResourceDiscoveries.go b/service/ec2/api_op_DescribeIpamResourceDiscoveries.go index a810e9d5829..fc6169522d1 100644 --- a/service/ec2/api_op_DescribeIpamResourceDiscoveries.go +++ b/service/ec2/api_op_DescribeIpamResourceDiscoveries.go @@ -34,8 +34,8 @@ type DescribeIpamResourceDiscoveriesInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The resource discovery filters. diff --git a/service/ec2/api_op_DescribeIpamResourceDiscoveryAssociations.go b/service/ec2/api_op_DescribeIpamResourceDiscoveryAssociations.go index 6815b089287..f177051b97f 100644 --- a/service/ec2/api_op_DescribeIpamResourceDiscoveryAssociations.go +++ b/service/ec2/api_op_DescribeIpamResourceDiscoveryAssociations.go @@ -34,8 +34,8 @@ type DescribeIpamResourceDiscoveryAssociationsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The resource discovery association filters. diff --git a/service/ec2/api_op_DescribeIpamScopes.go b/service/ec2/api_op_DescribeIpamScopes.go index 54bc75678a5..2405fcd6489 100644 --- a/service/ec2/api_op_DescribeIpamScopes.go +++ b/service/ec2/api_op_DescribeIpamScopes.go @@ -32,13 +32,13 @@ type DescribeIpamScopesInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The IDs of the scopes you want information on. diff --git a/service/ec2/api_op_DescribeIpams.go b/service/ec2/api_op_DescribeIpams.go index caca0df37dd..89bf399f6db 100644 --- a/service/ec2/api_op_DescribeIpams.go +++ b/service/ec2/api_op_DescribeIpams.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get information about your IPAM pools. For more information, see What is IPAM? -// (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon -// VPC IPAM User Guide. +// Get information about your IPAM pools. For more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) DescribeIpams(ctx context.Context, params *DescribeIpamsInput, optFns ...func(*Options)) (*DescribeIpamsOutput, error) { if params == nil { params = &DescribeIpamsInput{} @@ -34,13 +33,13 @@ type DescribeIpamsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The IDs of the IPAMs you want information on. diff --git a/service/ec2/api_op_DescribeIpv6Pools.go b/service/ec2/api_op_DescribeIpv6Pools.go index 4c2af8fd401..1627eba2129 100644 --- a/service/ec2/api_op_DescribeIpv6Pools.go +++ b/service/ec2/api_op_DescribeIpv6Pools.go @@ -32,21 +32,17 @@ type DescribeIpv6PoolsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * tag: - The key/value combination of a tag assigned to - // the resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeKeyPairs.go b/service/ec2/api_op_DescribeKeyPairs.go index bd847cbdcfd..af6d55176ff 100644 --- a/service/ec2/api_op_DescribeKeyPairs.go +++ b/service/ec2/api_op_DescribeKeyPairs.go @@ -19,10 +19,9 @@ import ( "time" ) -// Describes the specified key pairs or all of your key pairs. For more information -// about key pairs, see Amazon EC2 key pairs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Describes the specified key pairs or all of your key pairs. For more +// information about key pairs, see Amazon EC2 key pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeKeyPairs(ctx context.Context, params *DescribeKeyPairsInput, optFns ...func(*Options)) (*DescribeKeyPairsOutput, error) { if params == nil { params = &DescribeKeyPairsInput{} @@ -42,31 +41,23 @@ type DescribeKeyPairsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * key-pair-id - The ID of the key pair. - // - // * fingerprint - The - // fingerprint of the key pair. - // - // * key-name - The name of the key pair. - // - // * tag-key - // - The key of a tag assigned to the resource. Use this filter to find all - // resources assigned a tag with a specific key, regardless of the tag value. - // - // * - // tag: - The key/value combination of a tag assigned to the resource. Use the tag - // key in the filter name and the tag value as the filter value. For example, to - // find all resources that have a tag with the key Owner and the value TeamA, - // specify tag:Owner for the filter name and TeamA for the filter value. + // - key-pair-id - The ID of the key pair. + // - fingerprint - The fingerprint of the key pair. + // - key-name - The name of the key pair. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. Filters []types.Filter - // If true, the public key material is included in the response. Default: false + // If true , the public key material is included in the response. Default: false IncludePublicKey *bool // The key pair names. Default: Describes all of your key pairs. @@ -170,8 +161,8 @@ type KeyPairExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, KeyPairExistsWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, KeyPairExistsWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -220,9 +211,10 @@ func (w *KeyPairExistsWaiter) Wait(ctx context.Context, params *DescribeKeyPairs return err } -// WaitForOutput calls the waiter function for KeyPairExists waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for KeyPairExists waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *KeyPairExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeKeyPairsInput, maxWaitDur time.Duration, optFns ...func(*KeyPairExistsWaiterOptions)) (*DescribeKeyPairsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/ec2/api_op_DescribeLaunchTemplateVersions.go b/service/ec2/api_op_DescribeLaunchTemplateVersions.go index caab8a26af8..5a3156946b0 100644 --- a/service/ec2/api_op_DescribeLaunchTemplateVersions.go +++ b/service/ec2/api_op_DescribeLaunchTemplateVersions.go @@ -35,65 +35,43 @@ type DescribeLaunchTemplateVersionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * create-time - The time the launch template version was - // created. - // - // * ebs-optimized - A boolean that indicates whether the instance is - // optimized for Amazon EBS I/O. - // - // * http-endpoint - Indicates whether the HTTP - // metadata endpoint on your instances is enabled (enabled | disabled). - // - // * - // http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance - // metadata service is enabled (enabled | disabled). - // - // * host-resource-group-arn - - // The ARN of the host resource group in which to launch the instances. - // - // * - // http-tokens - The state of token usage for your instance metadata requests - // (optional | required). - // - // * iam-instance-profile - The ARN of the IAM instance - // profile. - // - // * image-id - The ID of the AMI. - // - // * instance-type - The instance - // type. - // - // * is-default-version - A boolean that indicates whether the launch - // template version is the default version. - // - // * kernel-id - The kernel ID. - // - // * - // license-configuration-arn - The ARN of the license configuration. - // - // * - // network-card-index - The index of the network card. - // - // * ram-disk-id - The RAM - // disk ID. + // - create-time - The time the launch template version was created. + // - ebs-optimized - A boolean that indicates whether the instance is optimized + // for Amazon EBS I/O. + // - http-endpoint - Indicates whether the HTTP metadata endpoint on your + // instances is enabled ( enabled | disabled ). + // - http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance + // metadata service is enabled ( enabled | disabled ). + // - host-resource-group-arn - The ARN of the host resource group in which to + // launch the instances. + // - http-tokens - The state of token usage for your instance metadata requests ( + // optional | required ). + // - iam-instance-profile - The ARN of the IAM instance profile. + // - image-id - The ID of the AMI. + // - instance-type - The instance type. + // - is-default-version - A boolean that indicates whether the launch template + // version is the default version. + // - kernel-id - The kernel ID. + // - license-configuration-arn - The ARN of the license configuration. + // - network-card-index - The index of the network card. + // - ram-disk-id - The RAM disk ID. Filters []types.Filter // The ID of the launch template. To describe one or more versions of a specified // launch template, you must specify either the LaunchTemplateId or the - // LaunchTemplateName, but not both. To describe all the latest or default launch + // LaunchTemplateName , but not both. To describe all the latest or default launch // template versions in your account, you must omit this parameter. LaunchTemplateId *string - // The name of the launch template. To describe one or more versions of a specified - // launch template, you must specify either the LaunchTemplateName or the - // LaunchTemplateId, but not both. To describe all the latest or default launch - // template versions in your account, you must omit this parameter. + // The name of the launch template. To describe one or more versions of a + // specified launch template, you must specify either the LaunchTemplateName or + // the LaunchTemplateId , but not both. To describe all the latest or default + // launch template versions in your account, you must omit this parameter. LaunchTemplateName *string // The maximum number of results to return in a single call. To retrieve the @@ -110,23 +88,22 @@ type DescribeLaunchTemplateVersionsInput struct { // The token to request the next page of results. NextToken *string - // If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID - // is displayed in the response for imageId. If false, and if a Systems Manager - // parameter is specified for ImageId, the parameter is displayed in the response - // for imageId. For more information, see Use a Systems Manager parameter instead - // of an AMI ID - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) + // If true , and if a Systems Manager parameter is specified for ImageId , the AMI + // ID is displayed in the response for imageId . If false , and if a Systems + // Manager parameter is specified for ImageId , the parameter is displayed in the + // response for imageId . For more information, see Use a Systems Manager + // parameter instead of an AMI ID (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) // in the Amazon Elastic Compute Cloud User Guide. Default: false ResolveAlias *bool // One or more versions of the launch template. Valid values depend on whether you // are describing a specified launch template (by ID or name) or all launch // templates in your account. To describe one or more versions of a specified - // launch template, valid values are $Latest, $Default, and numbers. To describe + // launch template, valid values are $Latest , $Default , and numbers. To describe // all launch templates in your account that are defined as the latest version, the - // valid value is $Latest. To describe all launch templates in your account that - // are defined as the default version, the valid value is $Default. You can specify - // $Latest and $Default in the same request. You cannot specify numbers. + // valid value is $Latest . To describe all launch templates in your account that + // are defined as the default version, the valid value is $Default . You can + // specify $Latest and $Default in the same request. You cannot specify numbers. Versions []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeLaunchTemplates.go b/service/ec2/api_op_DescribeLaunchTemplates.go index 53825a19ad2..40c2895e14d 100644 --- a/service/ec2/api_op_DescribeLaunchTemplates.go +++ b/service/ec2/api_op_DescribeLaunchTemplates.go @@ -32,26 +32,19 @@ type DescribeLaunchTemplatesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * create-time - The time the launch template was - // created. - // - // * launch-template-name - The name of the launch template. - // - // * tag: - - // The key/value combination of a tag assigned to the resource. Use the tag key in - // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. + // - create-time - The time the launch template was created. + // - launch-template-name - The name of the launch template. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // One or more launch template IDs. diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go index 6ac5f19c431..59fd57d5b5f 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go @@ -33,33 +33,22 @@ type DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsInput struct // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-gateway-id - The ID of a local gateway. - // - // * - // local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local - // gateway route table for the virtual interface group. - // - // * - // local-gateway-route-table-id - The ID of the local gateway route table. - // - // * - // local-gateway-route-table-virtual-interface-group-association-id - The ID of the - // association. - // - // * local-gateway-route-table-virtual-interface-group-id - The ID of - // the virtual interface group. - // - // * owner-id - The ID of the Amazon Web Services - // account that owns the local gateway virtual interface group association. - // - // * - // state - The state of the association. + // - local-gateway-id - The ID of a local gateway. + // - local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local + // gateway route table for the virtual interface group. + // - local-gateway-route-table-id - The ID of the local gateway route table. + // - local-gateway-route-table-virtual-interface-group-association-id - The ID of + // the association. + // - local-gateway-route-table-virtual-interface-group-id - The ID of the virtual + // interface group. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway virtual interface group association. + // - state - The state of the association. Filters []types.Filter // The IDs of the associations. diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go index 21051abe7c7..e06e9827811 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go @@ -33,32 +33,20 @@ type DescribeLocalGatewayRouteTableVpcAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-gateway-id - The ID of a local gateway. - // - // * - // local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local - // gateway route table for the association. - // - // * local-gateway-route-table-id - The - // ID of the local gateway route table. - // - // * - // local-gateway-route-table-vpc-association-id - The ID of the association. - // - // * - // owner-id - The ID of the Amazon Web Services account that owns the local gateway - // route table for the association. - // - // * state - The state of the association. - // - // * - // vpc-id - The ID of the VPC. + // - local-gateway-id - The ID of a local gateway. + // - local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local + // gateway route table for the association. + // - local-gateway-route-table-id - The ID of the local gateway route table. + // - local-gateway-route-table-vpc-association-id - The ID of the association. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway route table for the association. + // - state - The state of the association. + // - vpc-id - The ID of the VPC. Filters []types.Filter // The IDs of the associations. diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go index ebf63b6e5a6..b8aed436fae 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go @@ -33,28 +33,19 @@ type DescribeLocalGatewayRouteTablesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-gateway-id - The ID of a local gateway. - // - // * - // local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local - // gateway route table. - // - // * local-gateway-route-table-id - The ID of a local gateway - // route table. - // - // * outpost-arn - The Amazon Resource Name (ARN) of the Outpost. - // - // * - // owner-id - The ID of the Amazon Web Services account that owns the local gateway - // route table. - // - // * state - The state of the local gateway route table. + // - local-gateway-id - The ID of a local gateway. + // - local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local + // gateway route table. + // - local-gateway-route-table-id - The ID of a local gateway route table. + // - outpost-arn - The Amazon Resource Name (ARN) of the Outpost. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway route table. + // - state - The state of the local gateway route table. Filters []types.Filter // The IDs of the local gateway route tables. diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go index 52b8649dc1d..e8a6c4cd02e 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go @@ -32,23 +32,17 @@ type DescribeLocalGatewayVirtualInterfaceGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-gateway-id - The ID of a local gateway. - // - // * - // local-gateway-virtual-interface-group-id - The ID of the virtual interface - // group. - // - // * local-gateway-virtual-interface-id - The ID of the virtual - // interface. - // - // * owner-id - The ID of the Amazon Web Services account that owns the - // local gateway virtual interface group. + // - local-gateway-id - The ID of a local gateway. + // - local-gateway-virtual-interface-group-id - The ID of the virtual interface + // group. + // - local-gateway-virtual-interface-id - The ID of the virtual interface. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway virtual interface group. Filters []types.Filter // The IDs of the virtual interface groups. diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go index 29f798acac8..725fded98f8 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go @@ -32,33 +32,21 @@ type DescribeLocalGatewayVirtualInterfacesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-address - The local address. - // - // * local-bgp-asn - - // The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local - // gateway. - // - // * local-gateway-id - The ID of the local gateway. - // - // * - // local-gateway-virtual-interface-id - The ID of the virtual interface. - // - // * - // owner-id - The ID of the Amazon Web Services account that owns the local gateway - // virtual interface. - // - // * peer-address - The peer address. - // - // * peer-bgp-asn - The - // peer BGP ASN. - // - // * vlan - The ID of the VLAN. + // - local-address - The local address. + // - local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number + // (ASN) of the local gateway. + // - local-gateway-id - The ID of the local gateway. + // - local-gateway-virtual-interface-id - The ID of the virtual interface. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway virtual interface. + // - peer-address - The peer address. + // - peer-bgp-asn - The peer BGP ASN. + // - vlan - The ID of the VLAN. Filters []types.Filter // The IDs of the virtual interfaces. diff --git a/service/ec2/api_op_DescribeLocalGateways.go b/service/ec2/api_op_DescribeLocalGateways.go index 178e6be2cda..d1c05afe630 100644 --- a/service/ec2/api_op_DescribeLocalGateways.go +++ b/service/ec2/api_op_DescribeLocalGateways.go @@ -33,22 +33,16 @@ type DescribeLocalGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * local-gateway-id - The ID of a local gateway. - // - // * - // outpost-arn - The Amazon Resource Name (ARN) of the Outpost. - // - // * owner-id - The - // ID of the Amazon Web Services account that owns the local gateway. - // - // * state - - // The state of the association. + // - local-gateway-id - The ID of a local gateway. + // - outpost-arn - The Amazon Resource Name (ARN) of the Outpost. + // - owner-id - The ID of the Amazon Web Services account that owns the local + // gateway. + // - state - The state of the association. Filters []types.Filter // The IDs of the local gateways. diff --git a/service/ec2/api_op_DescribeManagedPrefixLists.go b/service/ec2/api_op_DescribeManagedPrefixLists.go index b30055ea67f..c97e58df0d6 100644 --- a/service/ec2/api_op_DescribeManagedPrefixLists.go +++ b/service/ec2/api_op_DescribeManagedPrefixLists.go @@ -13,8 +13,8 @@ import ( ) // Describes your managed prefix lists and any Amazon Web Services-managed prefix -// lists. To view the entries for your prefix list, use -// GetManagedPrefixListEntries. +// lists. To view the entries for your prefix list, use GetManagedPrefixListEntries +// . func (c *Client) DescribeManagedPrefixLists(ctx context.Context, params *DescribeManagedPrefixListsInput, optFns ...func(*Options)) (*DescribeManagedPrefixListsOutput, error) { if params == nil { params = &DescribeManagedPrefixListsInput{} @@ -34,19 +34,14 @@ type DescribeManagedPrefixListsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * owner-id - The ID of the prefix list owner. - // - // * - // prefix-list-id - The ID of the prefix list. - // - // * prefix-list-name - The name of - // the prefix list. + // - owner-id - The ID of the prefix list owner. + // - prefix-list-id - The ID of the prefix list. + // - prefix-list-name - The name of the prefix list. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeMovingAddresses.go b/service/ec2/api_op_DescribeMovingAddresses.go index 105d497443d..55e7cac2d78 100644 --- a/service/ec2/api_op_DescribeMovingAddresses.go +++ b/service/ec2/api_op_DescribeMovingAddresses.go @@ -35,14 +35,13 @@ type DescribeMovingAddressesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * moving-status - The status of the Elastic IP address - // (MovingToVpc | RestoringToClassic). + // - moving-status - The status of the Elastic IP address ( MovingToVpc | + // RestoringToClassic ). Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeNatGateways.go b/service/ec2/api_op_DescribeNatGateways.go index caa3576973f..97740af8a0d 100644 --- a/service/ec2/api_op_DescribeNatGateways.go +++ b/service/ec2/api_op_DescribeNatGateways.go @@ -38,38 +38,28 @@ type DescribeNatGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * nat-gateway-id - The ID of the NAT gateway. - // - // * state - - // The state of the NAT gateway (pending | failed | available | deleting | - // deleted). - // - // * subnet-id - The ID of the subnet in which the NAT gateway - // resides. - // - // * tag: - The key/value combination of a tag assigned to the resource. - // Use the tag key in the filter name and the tag value as the filter value. For - // example, to find all resources that have a tag with the key Owner and the value - // TeamA, specify tag:Owner for the filter name and TeamA for the filter value. - // - // * - // tag-key - The key of a tag assigned to the resource. Use this filter to find all - // resources assigned a tag with a specific key, regardless of the tag value. - // - // * - // vpc-id - The ID of the VPC in which the NAT gateway resides. + // - nat-gateway-id - The ID of the NAT gateway. + // - state - The state of the NAT gateway ( pending | failed | available | + // deleting | deleted ). + // - subnet-id - The ID of the subnet in which the NAT gateway resides. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC in which the NAT gateway resides. Filter []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // One or more NAT gateway IDs. @@ -157,8 +147,8 @@ func (c *Client) addOperationDescribeNatGatewaysMiddlewares(stack *middleware.St return nil } -// DescribeNatGatewaysAPIClient is a client that implements the DescribeNatGateways -// operation. +// DescribeNatGatewaysAPIClient is a client that implements the +// DescribeNatGateways operation. type DescribeNatGatewaysAPIClient interface { DescribeNatGateways(context.Context, *DescribeNatGatewaysInput, ...func(*Options)) (*DescribeNatGatewaysOutput, error) } @@ -170,8 +160,8 @@ var _ DescribeNatGatewaysAPIClient = (*Client)(nil) type DescribeNatGatewaysPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -265,9 +255,10 @@ type NatGatewayAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NatGatewayAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NatGatewayAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -307,9 +298,9 @@ func NewNatGatewayAvailableWaiter(client DescribeNatGatewaysAPIClient, optFns .. } } -// Wait calls the waiter function for NatGatewayAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for NatGatewayAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *NatGatewayAvailableWaiter) Wait(ctx context.Context, params *DescribeNatGatewaysInput, maxWaitDur time.Duration, optFns ...func(*NatGatewayAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -524,9 +515,9 @@ type NatGatewayDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NatGatewayDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NatGatewayDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -574,10 +565,10 @@ func (w *NatGatewayDeletedWaiter) Wait(ctx context.Context, params *DescribeNatG return err } -// WaitForOutput calls the waiter function for NatGatewayDeleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for NatGatewayDeleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *NatGatewayDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeNatGatewaysInput, maxWaitDur time.Duration, optFns ...func(*NatGatewayDeletedWaiterOptions)) (*DescribeNatGatewaysOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/ec2/api_op_DescribeNetworkAcls.go b/service/ec2/api_op_DescribeNetworkAcls.go index 93cf35082d5..7bd3d87eee8 100644 --- a/service/ec2/api_op_DescribeNetworkAcls.go +++ b/service/ec2/api_op_DescribeNetworkAcls.go @@ -34,78 +34,45 @@ type DescribeNetworkAclsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * association.association-id - The ID of an association ID - // for the ACL. - // - // * association.network-acl-id - The ID of the network ACL involved - // in the association. - // - // * association.subnet-id - The ID of the subnet involved in - // the association. - // - // * default - Indicates whether the ACL is the default network - // ACL for the VPC. - // - // * entry.cidr - The IPv4 CIDR range specified in the entry. - // - // * - // entry.icmp.code - The ICMP code specified in the entry, if any. - // - // * - // entry.icmp.type - The ICMP type specified in the entry, if any. - // - // * - // entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. - // - // * - // entry.port-range.from - The start of the port range specified in the entry. - // - // * - // entry.port-range.to - The end of the port range specified in the entry. - // - // * - // entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a - // protocol number). - // - // * entry.rule-action - Allows or denies the matching traffic - // (allow | deny). - // - // * entry.egress - A Boolean that indicates the type of rule. - // Specify true for egress rules, or false for ingress rules. - // - // * entry.rule-number - // - The number of an entry (in other words, rule) in the set of ACL entries. - // - // * - // network-acl-id - The ID of the network ACL. - // - // * owner-id - The ID of the Amazon - // Web Services account that owns the network ACL. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. - // - // * vpc-id - The ID of the VPC - // for the network ACL. + // - association.association-id - The ID of an association ID for the ACL. + // - association.network-acl-id - The ID of the network ACL involved in the + // association. + // - association.subnet-id - The ID of the subnet involved in the association. + // - default - Indicates whether the ACL is the default network ACL for the VPC. + // - entry.cidr - The IPv4 CIDR range specified in the entry. + // - entry.icmp.code - The ICMP code specified in the entry, if any. + // - entry.icmp.type - The ICMP type specified in the entry, if any. + // - entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. + // - entry.port-range.from - The start of the port range specified in the entry. + // - entry.port-range.to - The end of the port range specified in the entry. + // - entry.protocol - The protocol specified in the entry ( tcp | udp | icmp or a + // protocol number). + // - entry.rule-action - Allows or denies the matching traffic ( allow | deny ). + // - entry.egress - A Boolean that indicates the type of rule. Specify true for + // egress rules, or false for ingress rules. + // - entry.rule-number - The number of an entry (in other words, rule) in the set + // of ACL entries. + // - network-acl-id - The ID of the network ACL. + // - owner-id - The ID of the Amazon Web Services account that owns the network + // ACL. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC for the network ACL. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // One or more network ACL IDs. Default: Describes all your network ACLs. @@ -193,8 +160,8 @@ func (c *Client) addOperationDescribeNetworkAclsMiddlewares(stack *middleware.St return nil } -// DescribeNetworkAclsAPIClient is a client that implements the DescribeNetworkAcls -// operation. +// DescribeNetworkAclsAPIClient is a client that implements the +// DescribeNetworkAcls operation. type DescribeNetworkAclsAPIClient interface { DescribeNetworkAcls(context.Context, *DescribeNetworkAclsInput, ...func(*Options)) (*DescribeNetworkAclsOutput, error) } @@ -206,8 +173,8 @@ var _ DescribeNetworkAclsAPIClient = (*Client)(nil) type DescribeNetworkAclsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeNetworkInsightsAccessScopeAnalyses.go b/service/ec2/api_op_DescribeNetworkInsightsAccessScopeAnalyses.go index e319f8c3a2f..3063ba7b635 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsAccessScopeAnalyses.go +++ b/service/ec2/api_op_DescribeNetworkInsightsAccessScopeAnalyses.go @@ -41,8 +41,8 @@ type DescribeNetworkInsightsAccessScopeAnalysesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // There are no supported filters. diff --git a/service/ec2/api_op_DescribeNetworkInsightsAccessScopes.go b/service/ec2/api_op_DescribeNetworkInsightsAccessScopes.go index b68cd18aa3a..98217c3da74 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsAccessScopes.go +++ b/service/ec2/api_op_DescribeNetworkInsightsAccessScopes.go @@ -32,8 +32,8 @@ type DescribeNetworkInsightsAccessScopesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // There are no supported filters. @@ -135,8 +135,8 @@ type DescribeNetworkInsightsAccessScopesAPIClient interface { var _ DescribeNetworkInsightsAccessScopesAPIClient = (*Client)(nil) -// DescribeNetworkInsightsAccessScopesPaginatorOptions is the paginator options for -// DescribeNetworkInsightsAccessScopes +// DescribeNetworkInsightsAccessScopesPaginatorOptions is the paginator options +// for DescribeNetworkInsightsAccessScopes type DescribeNetworkInsightsAccessScopesPaginatorOptions 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. diff --git a/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go b/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go index 4a29d4cb3ea..5317f499df2 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go +++ b/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go @@ -39,25 +39,22 @@ type DescribeNetworkInsightsAnalysesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. The following are the possible values: - // - // * path-found - A Boolean - // value that indicates whether a feasible path is found. - // - // * status - The status of - // the analysis (running | succeeded | failed). + // - path-found - A Boolean value that indicates whether a feasible path is + // found. + // - status - The status of the analysis (running | succeeded | failed). Filters []types.Filter // 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 *int32 - // The ID of the network insights analyses. You must specify either analysis IDs or - // a path ID. + // The ID of the network insights analyses. You must specify either analysis IDs + // or a path ID. NetworkInsightsAnalysisIds []string // The ID of the path. You must specify either a path ID or analysis IDs. diff --git a/service/ec2/api_op_DescribeNetworkInsightsPaths.go b/service/ec2/api_op_DescribeNetworkInsightsPaths.go index 677c367272c..29926dc164d 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsPaths.go +++ b/service/ec2/api_op_DescribeNetworkInsightsPaths.go @@ -32,44 +32,28 @@ type DescribeNetworkInsightsPathsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. The following are the possible values: - // - // * destination - The ID of - // the resource. - // - // * filter-at-source.source-address - The source IPv4 address at - // the source. - // - // * filter-at-source.source-port-range - The source port range at the - // source. - // - // * filter-at-source.destination-address - The destination IPv4 address - // at the source. - // - // * filter-at-source.destination-port-range - The destination port - // range at the source. - // - // * filter-at-destination.source-address - The source IPv4 - // address at the destination. - // - // * filter-at-destination.source-port-range - The - // source port range at the destination. - // - // * - // filter-at-destination.destination-address - The destination IPv4 address at the - // destination. - // - // * filter-at-destination.destination-port-range - The destination - // port range at the destination. - // - // * protocol - The protocol. - // - // * source - The ID of - // the resource. + // - destination - The ID of the resource. + // - filter-at-source.source-address - The source IPv4 address at the source. + // - filter-at-source.source-port-range - The source port range at the source. + // - filter-at-source.destination-address - The destination IPv4 address at the + // source. + // - filter-at-source.destination-port-range - The destination port range at the + // source. + // - filter-at-destination.source-address - The source IPv4 address at the + // destination. + // - filter-at-destination.source-port-range - The source port range at the + // destination. + // - filter-at-destination.destination-address - The destination IPv4 address at + // the destination. + // - filter-at-destination.destination-port-range - The destination port range + // at the destination. + // - protocol - The protocol. + // - source - The ID of the resource. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go b/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go index e14e845e1e2..7d6974d55d3 100644 --- a/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_DescribeNetworkInterfaceAttribute.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a network interface attribute. You can specify only one attribute at a -// time. +// Describes a network interface attribute. You can specify only one attribute at +// a time. func (c *Client) DescribeNetworkInterfaceAttribute(ctx context.Context, params *DescribeNetworkInterfaceAttributeInput, optFns ...func(*Options)) (*DescribeNetworkInterfaceAttributeOutput, error) { if params == nil { params = &DescribeNetworkInterfaceAttributeInput{} @@ -41,8 +41,8 @@ type DescribeNetworkInterfaceAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go index 061e8a401e5..40ea0a42845 100644 --- a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go +++ b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go @@ -32,29 +32,22 @@ func (c *Client) DescribeNetworkInterfacePermissions(ctx context.Context, params type DescribeNetworkInterfacePermissionsInput struct { // One or more filters. - // - // * - // network-interface-permission.network-interface-permission-id - The ID of the - // permission. - // - // * network-interface-permission.network-interface-id - The ID of the - // network interface. - // - // * network-interface-permission.aws-account-id - The Amazon - // Web Services account ID. - // - // * network-interface-permission.aws-service - The - // Amazon Web Service. - // - // * network-interface-permission.permission - The type of - // permission (INSTANCE-ATTACH | EIP-ASSOCIATE). + // - network-interface-permission.network-interface-permission-id - The ID of the + // permission. + // - network-interface-permission.network-interface-id - The ID of the network + // interface. + // - network-interface-permission.aws-account-id - The Amazon Web Services + // account ID. + // - network-interface-permission.aws-service - The Amazon Web Service. + // - network-interface-permission.permission - The type of permission ( + // INSTANCE-ATTACH | EIP-ASSOCIATE ). Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. If this // parameter is not specified, up to 50 results are returned by default. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The network interface permission IDs. @@ -151,14 +144,14 @@ type DescribeNetworkInterfacePermissionsAPIClient interface { var _ DescribeNetworkInterfacePermissionsAPIClient = (*Client)(nil) -// DescribeNetworkInterfacePermissionsPaginatorOptions is the paginator options for -// DescribeNetworkInterfacePermissions +// DescribeNetworkInterfacePermissionsPaginatorOptions is the paginator options +// for DescribeNetworkInterfacePermissions type DescribeNetworkInterfacePermissionsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. If this // parameter is not specified, up to 50 results are returned by default. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeNetworkInterfaces.go b/service/ec2/api_op_DescribeNetworkInterfaces.go index acf556f241c..b7ee1bd9d53 100644 --- a/service/ec2/api_op_DescribeNetworkInterfaces.go +++ b/service/ec2/api_op_DescribeNetworkInterfaces.go @@ -39,142 +39,88 @@ type DescribeNetworkInterfacesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * addresses.private-ip-address - The private IPv4 - // addresses associated with the network interface. - // - // * addresses.primary - Whether - // the private IPv4 address is the primary IP address associated with the network - // interface. - // - // * addresses.association.public-ip - The association ID returned when - // the network interface was associated with the Elastic IP address (IPv4). - // - // * - // addresses.association.owner-id - The owner ID of the addresses associated with - // the network interface. - // - // * association.association-id - The association ID - // returned when the network interface was associated with an IPv4 address. - // - // * - // association.allocation-id - The allocation ID returned when you allocated the - // Elastic IP address (IPv4) for your network interface. - // - // * association.ip-owner-id - // - The owner of the Elastic IP address (IPv4) associated with the network - // interface. - // - // * association.public-ip - The address of the Elastic IP address - // (IPv4) bound to the network interface. - // - // * association.public-dns-name - The - // public DNS name for the network interface (IPv4). - // - // * attachment.attachment-id - - // The ID of the interface attachment. - // - // * attachment.attach-time - The time that - // the network interface was attached to an instance. - // - // * - // attachment.delete-on-termination - Indicates whether the attachment is deleted - // when an instance is terminated. - // - // * attachment.device-index - The device index to - // which the network interface is attached. - // - // * attachment.instance-id - The ID of - // the instance to which the network interface is attached. - // - // * - // attachment.instance-owner-id - The owner ID of the instance to which the network - // interface is attached. - // - // * attachment.status - The status of the attachment - // (attaching | attached | detaching | detached). - // - // * availability-zone - The - // Availability Zone of the network interface. - // - // * description - The description of - // the network interface. - // - // * group-id - The ID of a security group associated with - // the network interface. - // - // * group-name - The name of a security group associated - // with the network interface. - // - // * ipv6-addresses.ipv6-address - An IPv6 address - // associated with the network interface. - // - // * interface-type - The type of network - // interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa - // | gateway_load_balancer | gateway_load_balancer_endpoint | - // global_accelerator_managed | interface | iot_rules_managed | lambda | - // load_balancer | nat_gateway | network_load_balancer | quicksight | - // transit_gateway | trunk | vpc_endpoint). - // - // * mac-address - The MAC address of the - // network interface. - // - // * network-interface-id - The ID of the network interface. - // - // * - // owner-id - The Amazon Web Services account ID of the network interface owner. - // - // * - // private-ip-address - The private IPv4 address or addresses of the network - // interface. - // - // * private-dns-name - The private DNS name of the network interface - // (IPv4). - // - // * requester-id - The alias or Amazon Web Services account ID of the - // principal or service that created the network interface. - // - // * requester-managed - - // Indicates whether the network interface is being managed by an Amazon Web - // Service (for example, Amazon Web Services Management Console, Auto Scaling, and - // so on). - // - // * source-dest-check - Indicates whether the network interface performs - // source/destination checking. A value of true means checking is enabled, and - // false means checking is disabled. The value must be false for the network - // interface to perform network address translation (NAT) in your VPC. - // - // * status - - // The status of the network interface. If the network interface is not attached to - // an instance, the status is available; if a network interface is attached to an - // instance the status is in-use. - // - // * subnet-id - The ID of the subnet for the - // network interface. - // - // * tag: - The key/value combination of a tag assigned to the - // resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. - // - // * vpc-id - The ID of the VPC for the network interface. + // - addresses.private-ip-address - The private IPv4 addresses associated with + // the network interface. + // - addresses.primary - Whether the private IPv4 address is the primary IP + // address associated with the network interface. + // - addresses.association.public-ip - The association ID returned when the + // network interface was associated with the Elastic IP address (IPv4). + // - addresses.association.owner-id - The owner ID of the addresses associated + // with the network interface. + // - association.association-id - The association ID returned when the network + // interface was associated with an IPv4 address. + // - association.allocation-id - The allocation ID returned when you allocated + // the Elastic IP address (IPv4) for your network interface. + // - association.ip-owner-id - The owner of the Elastic IP address (IPv4) + // associated with the network interface. + // - association.public-ip - The address of the Elastic IP address (IPv4) bound + // to the network interface. + // - association.public-dns-name - The public DNS name for the network interface + // (IPv4). + // - attachment.attachment-id - The ID of the interface attachment. + // - attachment.attach-time - The time that the network interface was attached to + // an instance. + // - attachment.delete-on-termination - Indicates whether the attachment is + // deleted when an instance is terminated. + // - attachment.device-index - The device index to which the network interface is + // attached. + // - attachment.instance-id - The ID of the instance to which the network + // interface is attached. + // - attachment.instance-owner-id - The owner ID of the instance to which the + // network interface is attached. + // - attachment.status - The status of the attachment ( attaching | attached | + // detaching | detached ). + // - availability-zone - The Availability Zone of the network interface. + // - description - The description of the network interface. + // - group-id - The ID of a security group associated with the network interface. + // - group-name - The name of a security group associated with the network + // interface. + // - ipv6-addresses.ipv6-address - An IPv6 address associated with the network + // interface. + // - interface-type - The type of network interface ( api_gateway_managed | + // aws_codestar_connections_managed | branch | efa | gateway_load_balancer | + // gateway_load_balancer_endpoint | global_accelerator_managed | interface | + // iot_rules_managed | lambda | load_balancer | nat_gateway | + // network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint ). + // - mac-address - The MAC address of the network interface. + // - network-interface-id - The ID of the network interface. + // - owner-id - The Amazon Web Services account ID of the network interface + // owner. + // - private-ip-address - The private IPv4 address or addresses of the network + // interface. + // - private-dns-name - The private DNS name of the network interface (IPv4). + // - requester-id - The alias or Amazon Web Services account ID of the principal + // or service that created the network interface. + // - requester-managed - Indicates whether the network interface is being managed + // by an Amazon Web Service (for example, Amazon Web Services Management Console, + // Auto Scaling, and so on). + // - source-dest-check - Indicates whether the network interface performs + // source/destination checking. A value of true means checking is enabled, and + // false means checking is disabled. The value must be false for the network + // interface to perform network address translation (NAT) in your VPC. + // - status - The status of the network interface. If the network interface is + // not attached to an instance, the status is available ; if a network interface + // is attached to an instance the status is in-use . + // - subnet-id - The ID of the subnet for the network interface. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC for the network interface. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. You cannot // specify this parameter and the network interface IDs parameter in the same - // request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The network interface IDs. Default: Describes all your network interfaces. @@ -276,8 +222,8 @@ type DescribeNetworkInterfacesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. You cannot // specify this parameter and the network interface IDs parameter in the same - // request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -372,8 +318,8 @@ type NetworkInterfaceAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NetworkInterfaceAvailableWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NetworkInterfaceAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -424,10 +370,10 @@ func (w *NetworkInterfaceAvailableWaiter) Wait(ctx context.Context, params *Desc return err } -// WaitForOutput calls the waiter function for NetworkInterfaceAvailable waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for NetworkInterfaceAvailable waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *NetworkInterfaceAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeNetworkInterfacesInput, maxWaitDur time.Duration, optFns ...func(*NetworkInterfaceAvailableWaiterOptions)) (*DescribeNetworkInterfacesOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/ec2/api_op_DescribePlacementGroups.go b/service/ec2/api_op_DescribePlacementGroups.go index 71f07852fa8..04f1130b5ae 100644 --- a/service/ec2/api_op_DescribePlacementGroups.go +++ b/service/ec2/api_op_DescribePlacementGroups.go @@ -12,9 +12,8 @@ import ( ) // Describes the specified placement groups or all of your placement groups. For -// more information, see Placement groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in -// the Amazon EC2 User Guide. +// more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribePlacementGroups(ctx context.Context, params *DescribePlacementGroupsInput, optFns ...func(*Options)) (*DescribePlacementGroupsOutput, error) { if params == nil { params = &DescribePlacementGroupsInput{} @@ -34,42 +33,31 @@ type DescribePlacementGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * group-name - The name of the placement group. - // - // * group-arn - The - // Amazon Resource Name (ARN) of the placement group. - // - // * spread-level - The spread - // level for the placement group (host | rack). - // - // * state - The state of the - // placement group (pending | available | deleting | deleted). - // - // * strategy - The - // strategy of the placement group (cluster | spread | partition). - // - // * tag: - The - // key/value combination of a tag assigned to the resource. Use the tag key in the - // filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // that have a tag with a specific key, regardless of the tag value. + // - group-name - The name of the placement group. + // - group-arn - The Amazon Resource Name (ARN) of the placement group. + // - spread-level - The spread level for the placement group ( host | rack ). + // - state - The state of the placement group ( pending | available | deleting | + // deleted ). + // - strategy - The strategy of the placement group ( cluster | spread | + // partition ). + // - tag: - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources that have a tag with a specific key, regardless of the tag value. Filters []types.Filter // The IDs of the placement groups. GroupIds []string - // The names of the placement groups. Default: Describes all your placement groups, - // or only those otherwise specified. + // The names of the placement groups. Default: Describes all your placement + // groups, or only those otherwise specified. GroupNames []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribePrefixLists.go b/service/ec2/api_op_DescribePrefixLists.go index 2514ef49e50..29bdf8ceb7a 100644 --- a/service/ec2/api_op_DescribePrefixLists.go +++ b/service/ec2/api_op_DescribePrefixLists.go @@ -35,16 +35,13 @@ type DescribePrefixListsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * prefix-list-id: The ID of a prefix list. - // - // * - // prefix-list-name: The name of a prefix list. + // - prefix-list-id : The ID of a prefix list. + // - prefix-list-name : The name of a prefix list. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the @@ -135,8 +132,8 @@ func (c *Client) addOperationDescribePrefixListsMiddlewares(stack *middleware.St return nil } -// DescribePrefixListsAPIClient is a client that implements the DescribePrefixLists -// operation. +// DescribePrefixListsAPIClient is a client that implements the +// DescribePrefixLists operation. type DescribePrefixListsAPIClient interface { DescribePrefixLists(context.Context, *DescribePrefixListsInput, ...func(*Options)) (*DescribePrefixListsOutput, error) } diff --git a/service/ec2/api_op_DescribePrincipalIdFormat.go b/service/ec2/api_op_DescribePrincipalIdFormat.go index fc01360d56f..ea176fa1ba9 100644 --- a/service/ec2/api_op_DescribePrincipalIdFormat.go +++ b/service/ec2/api_op_DescribePrincipalIdFormat.go @@ -20,11 +20,11 @@ import ( // ID settings. The following resource types support longer IDs: bundle | // conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | // elastic-ip-association | export-task | flow-log | image | import-task | instance -// | internet-gateway | network-acl | network-acl-association | network-interface | -// network-interface-attachment | prefix-list | reservation | route-table | +// | internet-gateway | network-acl | network-acl-association | network-interface +// | network-interface-attachment | prefix-list | reservation | route-table | // route-table-association | security-group | snapshot | subnet | // subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | -// vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway. +// vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway . func (c *Client) DescribePrincipalIdFormat(ctx context.Context, params *DescribePrincipalIdFormatInput, optFns ...func(*Options)) (*DescribePrincipalIdFormatOutput, error) { if params == nil { params = &DescribePrincipalIdFormatInput{} @@ -44,8 +44,8 @@ type DescribePrincipalIdFormatInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return in a single call. To retrieve the diff --git a/service/ec2/api_op_DescribePublicIpv4Pools.go b/service/ec2/api_op_DescribePublicIpv4Pools.go index 03bbde66f16..347d7e28051 100644 --- a/service/ec2/api_op_DescribePublicIpv4Pools.go +++ b/service/ec2/api_op_DescribePublicIpv4Pools.go @@ -31,16 +31,12 @@ func (c *Client) DescribePublicIpv4Pools(ctx context.Context, params *DescribePu type DescribePublicIpv4PoolsInput struct { // One or more filters. - // - // * tag: - The key/value combination of a tag assigned to - // the resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeRegions.go b/service/ec2/api_op_DescribeRegions.go index 908a0c2d0d9..a36d84de34b 100644 --- a/service/ec2/api_op_DescribeRegions.go +++ b/service/ec2/api_op_DescribeRegions.go @@ -12,13 +12,11 @@ import ( ) // Describes the Regions that are enabled for your account, or all Regions. For a -// list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud -// endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/ec2-service.html). For -// information about enabling and disabling Regions for your account, see Managing -// Amazon Web Services Regions -// (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon -// Web Services General Reference. +// list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud +// endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/ec2-service.html) +// . For information about enabling and disabling Regions for your account, see +// Managing Amazon Web Services Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) +// in the Amazon Web Services General Reference. func (c *Client) DescribeRegions(ctx context.Context, params *DescribeRegionsInput, optFns ...func(*Options)) (*DescribeRegionsOutput, error) { if params == nil { params = &DescribeRegionsInput{} @@ -42,20 +40,16 @@ type DescribeRegionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * endpoint - The endpoint of the Region (for example, - // ec2.us-east-1.amazonaws.com). - // - // * opt-in-status - The opt-in status of the Region - // (opt-in-not-required | opted-in | not-opted-in). - // - // * region-name - The name of - // the Region (for example, us-east-1). + // - endpoint - The endpoint of the Region (for example, + // ec2.us-east-1.amazonaws.com ). + // - opt-in-status - The opt-in status of the Region ( opt-in-not-required | + // opted-in | not-opted-in ). + // - region-name - The name of the Region (for example, us-east-1 ). Filters []types.Filter // The names of the Regions. You can specify any Regions, whether they are enabled diff --git a/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go b/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go index 32c97a0cbd8..87a60f1f262 100644 --- a/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go +++ b/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go @@ -13,9 +13,8 @@ import ( ) // Describes a root volume replacement task. For more information, see Replace a -// root volume -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) in the -// Amazon Elastic Compute Cloud User Guide. +// root volume (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeReplaceRootVolumeTasks(ctx context.Context, params *DescribeReplaceRootVolumeTasksInput, optFns ...func(*Options)) (*DescribeReplaceRootVolumeTasksOutput, error) { if params == nil { params = &DescribeReplaceRootVolumeTasksInput{} @@ -35,20 +34,19 @@ type DescribeReplaceRootVolumeTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Filter to use: - // - // * instance-id - The ID of the instance for which the root volume - // replacement task was created. + // - instance-id - The ID of the instance for which the root volume replacement + // task was created. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -149,8 +147,8 @@ var _ DescribeReplaceRootVolumeTasksAPIClient = (*Client)(nil) type DescribeReplaceRootVolumeTasksPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeReservedInstances.go b/service/ec2/api_op_DescribeReservedInstances.go index 3506743c25e..a86c3abc1bf 100644 --- a/service/ec2/api_op_DescribeReservedInstances.go +++ b/service/ec2/api_op_DescribeReservedInstances.go @@ -12,8 +12,7 @@ import ( ) // Describes one or more of the Reserved Instances that you purchased. For more -// information about Reserved Instances, see Reserved Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) +// information about Reserved Instances, see Reserved Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) // in the Amazon EC2 User Guide. func (c *Client) DescribeReservedInstances(ctx context.Context, params *DescribeReservedInstancesInput, optFns ...func(*Options)) (*DescribeReservedInstancesOutput, error) { if params == nil { @@ -35,63 +34,44 @@ type DescribeReservedInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * availability-zone - The Availability Zone where the - // Reserved Instance can be used. - // - // * duration - The duration of the Reserved - // Instance (one year or three years), in seconds (31536000 | 94608000). - // - // * end - - // The time when the Reserved Instance expires (for example, - // 2015-08-07T11:54:42.000Z). - // - // * fixed-price - The purchase price of the Reserved - // Instance (for example, 9800.0). - // - // * instance-type - The instance type that is - // covered by the reservation. - // - // * scope - The scope of the Reserved Instance - // (Region or Availability Zone). - // - // * product-description - The Reserved Instance - // product platform description. Instances that include (Amazon VPC) in the product - // platform description will only be displayed to EC2-Classic account holders and - // are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | - // SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux - // (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows - // (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server - // Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server - // Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server - // Enterprise (Amazon VPC)). - // - // * reserved-instances-id - The ID of the Reserved - // Instance. - // - // * start - The time at which the Reserved Instance purchase request - // was placed (for example, 2014-08-07T11:54:42.000Z). - // - // * state - The state of the - // Reserved Instance (payment-pending | active | payment-failed | retired). - // - // * tag: - // - The key/value combination of a tag assigned to the resource. Use the tag key - // in the filter name and the tag value as the filter value. For example, to find - // all resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. - // - // * usage-price - // - The usage price of the Reserved Instance, per hour (for example, 0.84). + // - availability-zone - The Availability Zone where the Reserved Instance can be + // used. + // - duration - The duration of the Reserved Instance (one year or three years), + // in seconds ( 31536000 | 94608000 ). + // - end - The time when the Reserved Instance expires (for example, + // 2015-08-07T11:54:42.000Z). + // - fixed-price - The purchase price of the Reserved Instance (for example, + // 9800.0). + // - instance-type - The instance type that is covered by the reservation. + // - scope - The scope of the Reserved Instance ( Region or Availability Zone ). + // - product-description - The Reserved Instance product platform description. + // Instances that include (Amazon VPC) in the product platform description will + // only be displayed to EC2-Classic account holders and are for use with Amazon VPC + // ( Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) + // | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat + // Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | + // Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon + // VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) + // | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise + // (Amazon VPC) ). + // - reserved-instances-id - The ID of the Reserved Instance. + // - start - The time at which the Reserved Instance purchase request was placed + // (for example, 2014-08-07T11:54:42.000Z). + // - state - The state of the Reserved Instance ( payment-pending | active | + // payment-failed | retired ). + // - tag: - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - usage-price - The usage price of the Reserved Instance, per hour (for + // example, 0.84). Filters []types.Filter // Describes whether the Reserved Instance is Standard or Convertible. diff --git a/service/ec2/api_op_DescribeReservedInstancesListings.go b/service/ec2/api_op_DescribeReservedInstancesListings.go index 050a25da90b..77c3b98ea68 100644 --- a/service/ec2/api_op_DescribeReservedInstancesListings.go +++ b/service/ec2/api_op_DescribeReservedInstancesListings.go @@ -24,9 +24,8 @@ import ( // Marketplace first sells the lowest priced Reserved Instances to you, and // continues to sell available Reserved Instance listings to you until your demand // is met. You are charged based on the total price of all of the listings that you -// purchase. For more information, see Reserved Instance Marketplace -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in -// the Amazon EC2 User Guide. +// purchase. For more information, see Reserved Instance Marketplace (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeReservedInstancesListings(ctx context.Context, params *DescribeReservedInstancesListingsInput, optFns ...func(*Options)) (*DescribeReservedInstancesListingsOutput, error) { if params == nil { params = &DescribeReservedInstancesListingsInput{} @@ -46,17 +45,11 @@ func (c *Client) DescribeReservedInstancesListings(ctx context.Context, params * type DescribeReservedInstancesListingsInput struct { // One or more filters. - // - // * reserved-instances-id - The ID of the Reserved - // Instances. - // - // * reserved-instances-listing-id - The ID of the Reserved Instances - // listing. - // - // * status - The status of the Reserved Instance listing (pending | - // active | cancelled | closed). - // - // * status-message - The reason for the status. + // - reserved-instances-id - The ID of the Reserved Instances. + // - reserved-instances-listing-id - The ID of the Reserved Instances listing. + // - status - The status of the Reserved Instance listing ( pending | active | + // cancelled | closed ). + // - status-message - The reason for the status. Filters []types.Filter // One or more Reserved Instance IDs. diff --git a/service/ec2/api_op_DescribeReservedInstancesModifications.go b/service/ec2/api_op_DescribeReservedInstancesModifications.go index e7ca28048e6..ceb2b83d7f5 100644 --- a/service/ec2/api_op_DescribeReservedInstancesModifications.go +++ b/service/ec2/api_op_DescribeReservedInstancesModifications.go @@ -16,9 +16,8 @@ import ( // specified, information about all your Reserved Instances modification requests // is returned. If a modification ID is specified, only information about the // specific modification is returned. For more information, see Modifying Reserved -// Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) in the -// Amazon EC2 User Guide. +// Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeReservedInstancesModifications(ctx context.Context, params *DescribeReservedInstancesModificationsInput, optFns ...func(*Options)) (*DescribeReservedInstancesModificationsOutput, error) { if params == nil { params = &DescribeReservedInstancesModificationsInput{} @@ -38,49 +37,26 @@ func (c *Client) DescribeReservedInstancesModifications(ctx context.Context, par type DescribeReservedInstancesModificationsInput struct { // One or more filters. - // - // * client-token - The idempotency token for the - // modification request. - // - // * create-date - The time when the modification request - // was created. - // - // * effective-date - The time when the modification becomes - // effective. - // - // * modification-result.reserved-instances-id - The ID for the - // Reserved Instances created as part of the modification request. This ID is only - // available when the status of the modification is fulfilled. - // - // * - // modification-result.target-configuration.availability-zone - The Availability - // Zone for the new Reserved Instances. - // - // * - // modification-result.target-configuration.instance-count - The number of new - // Reserved Instances. - // - // * modification-result.target-configuration.instance-type - - // The instance type of the new Reserved Instances. - // - // * - // modification-result.target-configuration.platform - The network platform of the - // new Reserved Instances (EC2-Classic | EC2-VPC). - // - // * reserved-instances-id - The - // ID of the Reserved Instances modified. - // - // * reserved-instances-modification-id - - // The ID of the modification request. - // - // * status - The status of the Reserved - // Instances modification request (processing | fulfilled | failed). - // - // * - // status-message - The reason for the status. - // - // * update-date - The time when the - // modification request was last updated. + // - client-token - The idempotency token for the modification request. + // - create-date - The time when the modification request was created. + // - effective-date - The time when the modification becomes effective. + // - modification-result.reserved-instances-id - The ID for the Reserved + // Instances created as part of the modification request. This ID is only available + // when the status of the modification is fulfilled . + // - modification-result.target-configuration.availability-zone - The + // Availability Zone for the new Reserved Instances. + // - modification-result.target-configuration.instance-count - The number of new + // Reserved Instances. + // - modification-result.target-configuration.instance-type - The instance type + // of the new Reserved Instances. + // - modification-result.target-configuration.platform - The network platform of + // the new Reserved Instances ( EC2-Classic | EC2-VPC ). + // - reserved-instances-id - The ID of the Reserved Instances modified. + // - reserved-instances-modification-id - The ID of the modification request. + // - status - The status of the Reserved Instances modification request ( + // processing | fulfilled | failed ). + // - status-message - The reason for the status. + // - update-date - The time when the modification request was last updated. Filters []types.Filter // The token to retrieve the next page of results. diff --git a/service/ec2/api_op_DescribeReservedInstancesOfferings.go b/service/ec2/api_op_DescribeReservedInstancesOfferings.go index e52eabdaff0..363456671b9 100644 --- a/service/ec2/api_op_DescribeReservedInstancesOfferings.go +++ b/service/ec2/api_op_DescribeReservedInstancesOfferings.go @@ -19,9 +19,8 @@ import ( // the actual time used. If you have listed your own Reserved Instances for sale in // the Reserved Instance Marketplace, they will be excluded from these results. // This is to ensure that you do not purchase your own Reserved Instances. For more -// information, see Reserved Instance Marketplace -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in -// the Amazon EC2 User Guide. +// information, see Reserved Instance Marketplace (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeReservedInstancesOfferings(ctx context.Context, params *DescribeReservedInstancesOfferingsInput, optFns ...func(*Options)) (*DescribeReservedInstancesOfferingsOutput, error) { if params == nil { params = &DescribeReservedInstancesOfferingsInput{} @@ -45,49 +44,36 @@ type DescribeReservedInstancesOfferingsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * availability-zone - The Availability Zone where the - // Reserved Instance can be used. - // - // * duration - The duration of the Reserved - // Instance (for example, one year or three years), in seconds (31536000 | - // 94608000). - // - // * fixed-price - The purchase price of the Reserved Instance (for - // example, 9800.0). - // - // * instance-type - The instance type that is covered by the - // reservation. - // - // * marketplace - Set to true to show only Reserved Instance - // Marketplace offerings. When this filter is not used, which is the default - // behavior, all offerings from both Amazon Web Services and the Reserved Instance - // Marketplace are listed. - // - // * product-description - The Reserved Instance product - // platform description. Instances that include (Amazon VPC) in the product - // platform description will only be displayed to EC2-Classic account holders and - // are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux - // | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux - // (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows - // (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server - // Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server - // Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server - // Enterprise (Amazon VPC)) - // - // * reserved-instances-offering-id - The Reserved - // Instances offering ID. - // - // * scope - The scope of the Reserved Instance - // (Availability Zone or Region). - // - // * usage-price - The usage price of the Reserved - // Instance, per hour (for example, 0.84). + // - availability-zone - The Availability Zone where the Reserved Instance can be + // used. + // - duration - The duration of the Reserved Instance (for example, one year or + // three years), in seconds ( 31536000 | 94608000 ). + // - fixed-price - The purchase price of the Reserved Instance (for example, + // 9800.0). + // - instance-type - The instance type that is covered by the reservation. + // - marketplace - Set to true to show only Reserved Instance Marketplace + // offerings. When this filter is not used, which is the default behavior, all + // offerings from both Amazon Web Services and the Reserved Instance Marketplace + // are listed. + // - product-description - The Reserved Instance product platform description. + // Instances that include (Amazon VPC) in the product platform description will + // only be displayed to EC2-Classic account holders and are for use with Amazon + // VPC. ( Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon + // VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red + // Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | + // Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon + // VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) + // | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise + // (Amazon VPC) ) + // - reserved-instances-offering-id - The Reserved Instances offering ID. + // - scope - The scope of the Reserved Instance ( Availability Zone or Region ). + // - usage-price - The usage price of the Reserved Instance, per hour (for + // example, 0.84). Filters []types.Filter // Include Reserved Instance Marketplace offerings in the response. @@ -100,18 +86,17 @@ type DescribeReservedInstancesOfferingsInput struct { // Default: default InstanceTenancy types.Tenancy - // The instance type that the reservation will cover (for example, m1.small). For - // more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // The instance type that the reservation will cover (for example, m1.small ). For + // more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. InstanceType types.InstanceType // The maximum duration (in seconds) to filter when searching for offerings. // Default: 94608000 (3 years) MaxDuration *int64 - // The maximum number of instances to filter when searching for offerings. Default: - // 20 + // The maximum number of instances to filter when searching for offerings. + // Default: 20 MaxInstanceCount *int32 // The maximum number of results to return for the request in a single page. The @@ -126,7 +111,7 @@ type DescribeReservedInstancesOfferingsInput struct { // The token to retrieve the next page of results. NextToken *string - // The offering class of the Reserved Instance. Can be standard or convertible. + // The offering class of the Reserved Instance. Can be standard or convertible . OfferingClass types.OfferingClassType // The Reserved Instance offering type. If you are using tools that predate the diff --git a/service/ec2/api_op_DescribeRouteTables.go b/service/ec2/api_op_DescribeRouteTables.go index 26c382e0fbb..0eee5e2fa5d 100644 --- a/service/ec2/api_op_DescribeRouteTables.go +++ b/service/ec2/api_op_DescribeRouteTables.go @@ -16,9 +16,8 @@ import ( // associated with a route table. If a subnet is not explicitly associated with any // route table, it is implicitly associated with the main route table. This command // does not return the subnet ID for implicit associations. For more information, -// see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) DescribeRouteTables(ctx context.Context, params *DescribeRouteTablesInput, optFns ...func(*Options)) (*DescribeRouteTablesOutput, error) { if params == nil { params = &DescribeRouteTablesInput{} @@ -38,89 +37,58 @@ type DescribeRouteTablesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * association.route-table-association-id - The ID of an - // association ID for the route table. - // - // * association.route-table-id - The ID of - // the route table involved in the association. - // - // * association.subnet-id - The ID - // of the subnet involved in the association. - // - // * association.main - Indicates - // whether the route table is the main route table for the VPC (true | false). - // Route tables that do not have an association ID are not returned in the - // response. - // - // * owner-id - The ID of the Amazon Web Services account that owns the - // route table. - // - // * route-table-id - The ID of the route table. - // - // * - // route.destination-cidr-block - The IPv4 CIDR range specified in a route in the - // table. - // - // * route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a - // route in the route table. - // - // * route.destination-prefix-list-id - The ID (prefix) - // of the Amazon Web Service specified in a route in the table. - // - // * - // route.egress-only-internet-gateway-id - The ID of an egress-only Internet - // gateway specified in a route in the route table. - // - // * route.gateway-id - The ID of - // a gateway specified in a route in the table. - // - // * route.instance-id - The ID of an - // instance specified in a route in the table. - // - // * route.nat-gateway-id - The ID of - // a NAT gateway. - // - // * route.transit-gateway-id - The ID of a transit gateway. - // - // * - // route.origin - Describes how the route was created. CreateRouteTable indicates - // that the route was automatically created when the route table was created; - // CreateRoute indicates that the route was manually added to the route table; - // EnableVgwRoutePropagation indicates that the route was propagated by route - // propagation. - // - // * route.state - The state of a route in the route table (active | - // blackhole). The blackhole state indicates that the route's target isn't - // available (for example, the specified gateway isn't attached to the VPC, the - // specified NAT instance has been terminated, and so on). - // - // * - // route.vpc-peering-connection-id - The ID of a VPC peering connection specified - // in a route in the table. - // - // * tag: - The key/value combination of a tag assigned - // to the resource. Use the tag key in the filter name and the tag value as the - // filter value. For example, to find all resources that have a tag with the key - // Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for - // the filter value. - // - // * tag-key - The key of a tag assigned to the resource. Use - // this filter to find all resources assigned a tag with a specific key, regardless - // of the tag value. - // - // * vpc-id - The ID of the VPC for the route table. + // - association.route-table-association-id - The ID of an association ID for the + // route table. + // - association.route-table-id - The ID of the route table involved in the + // association. + // - association.subnet-id - The ID of the subnet involved in the association. + // - association.main - Indicates whether the route table is the main route table + // for the VPC ( true | false ). Route tables that do not have an association ID + // are not returned in the response. + // - owner-id - The ID of the Amazon Web Services account that owns the route + // table. + // - route-table-id - The ID of the route table. + // - route.destination-cidr-block - The IPv4 CIDR range specified in a route in + // the table. + // - route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route + // in the route table. + // - route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service + // specified in a route in the table. + // - route.egress-only-internet-gateway-id - The ID of an egress-only Internet + // gateway specified in a route in the route table. + // - route.gateway-id - The ID of a gateway specified in a route in the table. + // - route.instance-id - The ID of an instance specified in a route in the table. + // - route.nat-gateway-id - The ID of a NAT gateway. + // - route.transit-gateway-id - The ID of a transit gateway. + // - route.origin - Describes how the route was created. CreateRouteTable + // indicates that the route was automatically created when the route table was + // created; CreateRoute indicates that the route was manually added to the route + // table; EnableVgwRoutePropagation indicates that the route was propagated by + // route propagation. + // - route.state - The state of a route in the route table ( active | blackhole + // ). The blackhole state indicates that the route's target isn't available (for + // example, the specified gateway isn't attached to the VPC, the specified NAT + // instance has been terminated, and so on). + // - route.vpc-peering-connection-id - The ID of a VPC peering connection + // specified in a route in the table. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC for the route table. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -209,8 +177,8 @@ func (c *Client) addOperationDescribeRouteTablesMiddlewares(stack *middleware.St return nil } -// DescribeRouteTablesAPIClient is a client that implements the DescribeRouteTables -// operation. +// DescribeRouteTablesAPIClient is a client that implements the +// DescribeRouteTables operation. type DescribeRouteTablesAPIClient interface { DescribeRouteTables(context.Context, *DescribeRouteTablesInput, ...func(*Options)) (*DescribeRouteTablesOutput, error) } @@ -222,8 +190,8 @@ var _ DescribeRouteTablesAPIClient = (*Client)(nil) type DescribeRouteTablesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeScheduledInstanceAvailability.go b/service/ec2/api_op_DescribeScheduledInstanceAvailability.go index 0c13269735a..c144f5fd4fd 100644 --- a/service/ec2/api_op_DescribeScheduledInstanceAvailability.go +++ b/service/ec2/api_op_DescribeScheduledInstanceAvailability.go @@ -17,8 +17,8 @@ import ( // minimum required duration of 1,200 hours per year. For example, the minimum // daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the // minimum monthly schedule is 100 hours. After you find a schedule that meets your -// needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that -// schedule. +// needs, call PurchaseScheduledInstances to purchase Scheduled Instances with +// that schedule. func (c *Client) DescribeScheduledInstanceAvailability(ctx context.Context, params *DescribeScheduledInstanceAvailabilityInput, optFns ...func(*Options)) (*DescribeScheduledInstanceAvailabilityOutput, error) { if params == nil { params = &DescribeScheduledInstanceAvailabilityInput{} @@ -49,22 +49,15 @@ type DescribeScheduledInstanceAvailabilityInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * availability-zone - The Availability Zone (for example, - // us-west-2a). - // - // * instance-type - The instance type (for example, c4.large). - // - // * - // network-platform - The network platform (EC2-Classic or EC2-VPC). - // - // * platform - - // The platform (Linux/UNIX or Windows). + // - availability-zone - The Availability Zone (for example, us-west-2a ). + // - instance-type - The instance type (for example, c4.large ). + // - network-platform - The network platform ( EC2-Classic or EC2-VPC ). + // - platform - The platform ( Linux/UNIX or Windows ). Filters []types.Filter // The maximum number of results to return in a single call. This value can be @@ -76,9 +69,10 @@ type DescribeScheduledInstanceAvailabilityInput struct { // MinSlotDurationInHours and less than 1,720. MaxSlotDurationInHours *int32 - // The minimum available duration, in hours. The minimum required duration is 1,200 - // hours per year. For example, the minimum daily schedule is 4 hours, the minimum - // weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. + // The minimum available duration, in hours. The minimum required duration is + // 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the + // minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 + // hours. MinSlotDurationInHours *int32 // The token for the next set of results. diff --git a/service/ec2/api_op_DescribeScheduledInstances.go b/service/ec2/api_op_DescribeScheduledInstances.go index e51c8c09015..b2ff0ec1846 100644 --- a/service/ec2/api_op_DescribeScheduledInstances.go +++ b/service/ec2/api_op_DescribeScheduledInstances.go @@ -33,22 +33,15 @@ type DescribeScheduledInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * availability-zone - The Availability Zone (for example, - // us-west-2a). - // - // * instance-type - The instance type (for example, c4.large). - // - // * - // network-platform - The network platform (EC2-Classic or EC2-VPC). - // - // * platform - - // The platform (Linux/UNIX or Windows). + // - availability-zone - The Availability Zone (for example, us-west-2a ). + // - instance-type - The instance type (for example, c4.large ). + // - network-platform - The network platform ( EC2-Classic or EC2-VPC ). + // - platform - The platform ( Linux/UNIX or Windows ). Filters []types.Filter // The maximum number of results to return in a single call. This value can be diff --git a/service/ec2/api_op_DescribeSecurityGroupReferences.go b/service/ec2/api_op_DescribeSecurityGroupReferences.go index 87431e7b71b..cc7d340006d 100644 --- a/service/ec2/api_op_DescribeSecurityGroupReferences.go +++ b/service/ec2/api_op_DescribeSecurityGroupReferences.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// [VPC only] Describes the VPCs on the other side of a VPC peering connection that -// are referencing the security groups you've specified in this request. +// [VPC only] Describes the VPCs on the other side of a VPC peering connection +// that are referencing the security groups you've specified in this request. func (c *Client) DescribeSecurityGroupReferences(ctx context.Context, params *DescribeSecurityGroupReferencesInput, optFns ...func(*Options)) (*DescribeSecurityGroupReferencesOutput, error) { if params == nil { params = &DescribeSecurityGroupReferencesInput{} @@ -37,8 +37,8 @@ type DescribeSecurityGroupReferencesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeSecurityGroupRules.go b/service/ec2/api_op_DescribeSecurityGroupRules.go index 38f174b0320..a8876fdc46b 100644 --- a/service/ec2/api_op_DescribeSecurityGroupRules.go +++ b/service/ec2/api_op_DescribeSecurityGroupRules.go @@ -32,29 +32,24 @@ type DescribeSecurityGroupRulesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * group-id - The ID of the security group. - // - // * - // security-group-rule-id - The ID of the security group rule. - // - // * tag: - The - // key/value combination of a tag assigned to the resource. Use the tag key in the - // filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. + // - group-id - The ID of the security group. + // - security-group-rule-id - The ID of the security group rule. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. This value // can be between 5 and 1000. If this parameter is not specified, then all items - // are returned. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // are returned. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -156,8 +151,8 @@ type DescribeSecurityGroupRulesPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. This value // can be between 5 and 1000. If this parameter is not specified, then all items - // are returned. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // are returned. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeSecurityGroups.go b/service/ec2/api_op_DescribeSecurityGroups.go index ece0afffc8d..bc0856cd510 100644 --- a/service/ec2/api_op_DescribeSecurityGroups.go +++ b/service/ec2/api_op_DescribeSecurityGroups.go @@ -21,15 +21,12 @@ import ( // Describes the specified security groups or all of your security groups. A // security group is for use with instances either in the EC2-Classic platform or -// in a specific VPC. For more information, see Amazon EC2 security groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) -// in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC -// (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) +// in a specific VPC. For more information, see Amazon EC2 security groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) +// in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) // in the Amazon Virtual Private Cloud User Guide. We are retiring EC2-Classic. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeSecurityGroups(ctx context.Context, params *DescribeSecurityGroupsInput, optFns ...func(*Options)) (*DescribeSecurityGroupsOutput, error) { if params == nil { params = &DescribeSecurityGroupsInput{} @@ -49,101 +46,60 @@ type DescribeSecurityGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. If using multiple filters for rules, the results include security // groups for which any combination of rules - not necessarily a single rule - // match all filters. - // - // * description - The description of the security group. - // - // * - // egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group - // rule. - // - // * egress.ip-permission.from-port - For an outbound rule, the start of - // port range for the TCP and UDP protocols, or an ICMP type number. - // - // * - // egress.ip-permission.group-id - The ID of a security group that has been - // referenced in an outbound security group rule. - // - // * - // egress.ip-permission.group-name - The name of a security group that is - // referenced in an outbound security group rule. - // - // * egress.ip-permission.ipv6-cidr - // - An IPv6 CIDR block for an outbound security group rule. - // - // * - // egress.ip-permission.prefix-list-id - The ID of a prefix list to which a - // security group rule allows outbound access. - // - // * egress.ip-permission.protocol - - // The IP protocol for an outbound security group rule (tcp | udp | icmp, a - // protocol number, or -1 for all protocols). - // - // * egress.ip-permission.to-port - For - // an outbound rule, the end of port range for the TCP and UDP protocols, or an - // ICMP code. - // - // * egress.ip-permission.user-id - The ID of an Amazon Web Services - // account that has been referenced in an outbound security group rule. - // - // * group-id - // - The ID of the security group. - // - // * group-name - The name of the security - // group. - // - // * ip-permission.cidr - An IPv4 CIDR block for an inbound security group - // rule. - // - // * ip-permission.from-port - For an inbound rule, the start of port range - // for the TCP and UDP protocols, or an ICMP type number. - // - // * ip-permission.group-id - // - The ID of a security group that has been referenced in an inbound security - // group rule. - // - // * ip-permission.group-name - The name of a security group that is - // referenced in an inbound security group rule. - // - // * ip-permission.ipv6-cidr - An - // IPv6 CIDR block for an inbound security group rule. - // - // * - // ip-permission.prefix-list-id - The ID of a prefix list from which a security - // group rule allows inbound access. - // - // * ip-permission.protocol - The IP protocol - // for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 - // for all protocols). - // - // * ip-permission.to-port - For an inbound rule, the end of - // port range for the TCP and UDP protocols, or an ICMP code. - // - // * - // ip-permission.user-id - The ID of an Amazon Web Services account that has been - // referenced in an inbound security group rule. - // - // * owner-id - The Amazon Web - // Services account ID of the owner of the security group. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. - // - // * vpc-id - The ID of the VPC - // specified when the security group was created. + // - description - The description of the security group. + // - egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security + // group rule. + // - egress.ip-permission.from-port - For an outbound rule, the start of port + // range for the TCP and UDP protocols, or an ICMP type number. + // - egress.ip-permission.group-id - The ID of a security group that has been + // referenced in an outbound security group rule. + // - egress.ip-permission.group-name - The name of a security group that is + // referenced in an outbound security group rule. + // - egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security + // group rule. + // - egress.ip-permission.prefix-list-id - The ID of a prefix list to which a + // security group rule allows outbound access. + // - egress.ip-permission.protocol - The IP protocol for an outbound security + // group rule ( tcp | udp | icmp , a protocol number, or -1 for all protocols). + // - egress.ip-permission.to-port - For an outbound rule, the end of port range + // for the TCP and UDP protocols, or an ICMP code. + // - egress.ip-permission.user-id - The ID of an Amazon Web Services account that + // has been referenced in an outbound security group rule. + // - group-id - The ID of the security group. + // - group-name - The name of the security group. + // - ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule. + // - ip-permission.from-port - For an inbound rule, the start of port range for + // the TCP and UDP protocols, or an ICMP type number. + // - ip-permission.group-id - The ID of a security group that has been referenced + // in an inbound security group rule. + // - ip-permission.group-name - The name of a security group that is referenced + // in an inbound security group rule. + // - ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group + // rule. + // - ip-permission.prefix-list-id - The ID of a prefix list from which a security + // group rule allows inbound access. + // - ip-permission.protocol - The IP protocol for an inbound security group rule ( + // tcp | udp | icmp , a protocol number, or -1 for all protocols). + // - ip-permission.to-port - For an inbound rule, the end of port range for the + // TCP and UDP protocols, or an ICMP code. + // - ip-permission.user-id - The ID of an Amazon Web Services account that has + // been referenced in an inbound security group rule. + // - owner-id - The Amazon Web Services account ID of the owner of the security + // group. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC specified when the security group was created. Filters []types.Filter // The IDs of the security groups. Required for security groups in a nondefault @@ -159,8 +115,8 @@ type DescribeSecurityGroupsInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. This value // can be between 5 and 1000. If this parameter is not specified, then all items - // are returned. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // are returned. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -259,8 +215,8 @@ type DescribeSecurityGroupsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. This value // can be between 5 and 1000. If this parameter is not specified, then all items - // are returned. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // are returned. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -354,9 +310,10 @@ type SecurityGroupExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SecurityGroupExistsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SecurityGroupExistsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -396,9 +353,9 @@ func NewSecurityGroupExistsWaiter(client DescribeSecurityGroupsAPIClient, optFns } } -// Wait calls the waiter function for SecurityGroupExists waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for SecurityGroupExists waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *SecurityGroupExistsWaiter) Wait(ctx context.Context, params *DescribeSecurityGroupsInput, maxWaitDur time.Duration, optFns ...func(*SecurityGroupExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/ec2/api_op_DescribeSnapshotAttribute.go b/service/ec2/api_op_DescribeSnapshotAttribute.go index 26a78815a53..52481e34c88 100644 --- a/service/ec2/api_op_DescribeSnapshotAttribute.go +++ b/service/ec2/api_op_DescribeSnapshotAttribute.go @@ -13,9 +13,8 @@ import ( // Describes the specified attribute of the specified snapshot. You can specify // only one attribute at a time. For more information about EBS snapshots, see -// Amazon EBS snapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Amazon EBS snapshots (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeSnapshotAttribute(ctx context.Context, params *DescribeSnapshotAttributeInput, optFns ...func(*Options)) (*DescribeSnapshotAttributeOutput, error) { if params == nil { params = &DescribeSnapshotAttributeInput{} @@ -45,8 +44,8 @@ type DescribeSnapshotAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeSnapshotTierStatus.go b/service/ec2/api_op_DescribeSnapshotTierStatus.go index 673be697615..16e9656bb01 100644 --- a/service/ec2/api_op_DescribeSnapshotTierStatus.go +++ b/service/ec2/api_op_DescribeSnapshotTierStatus.go @@ -32,28 +32,24 @@ type DescribeSnapshotTierStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * snapshot-id - The snapshot ID. - // - // * volume-id - The ID of the - // volume the snapshot is for. - // - // * last-tiering-operation - The state of the last - // archive or restore action. (archival-in-progress | archival-completed | - // archival-failed | permanent-restore-in-progress | permanent-restore-completed | - // permanent-restore-failed | temporary-restore-in-progress | - // temporary-restore-completed | temporary-restore-failed) + // - snapshot-id - The snapshot ID. + // - volume-id - The ID of the volume the snapshot is for. + // - last-tiering-operation - The state of the last archive or restore action. ( + // archival-in-progress | archival-completed | archival-failed | + // permanent-restore-in-progress | permanent-restore-completed | + // permanent-restore-failed | temporary-restore-in-progress | + // temporary-restore-completed | temporary-restore-failed ) Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -151,8 +147,8 @@ var _ DescribeSnapshotTierStatusAPIClient = (*Client)(nil) type DescribeSnapshotTierStatusPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeSnapshots.go b/service/ec2/api_op_DescribeSnapshots.go index ae5a9a2d9b5..9eeedad4595 100644 --- a/service/ec2/api_op_DescribeSnapshots.go +++ b/service/ec2/api_op_DescribeSnapshots.go @@ -20,44 +20,36 @@ import ( // snapshots available to you. The snapshots available to you include public // snapshots, private snapshots that you own, and private snapshots owned by other // Amazon Web Services accounts for which you have explicit create volume -// permissions. The create volume permissions fall into the following -// categories: +// permissions. The create volume permissions fall into the following categories: +// - public: The owner of the snapshot granted create volume permissions for the +// snapshot to the all group. All Amazon Web Services accounts have create volume +// permissions for these snapshots. +// - explicit: The owner of the snapshot granted create volume permissions to a +// specific Amazon Web Services account. +// - implicit: An Amazon Web Services account has implicit create volume +// permissions for all snapshots it owns. // -// * public: The owner of the snapshot granted create volume -// permissions for the snapshot to the all group. All Amazon Web Services accounts -// have create volume permissions for these snapshots. -// -// * explicit: The owner of -// the snapshot granted create volume permissions to a specific Amazon Web Services -// account. -// -// * implicit: An Amazon Web Services account has implicit create volume -// permissions for all snapshots it owns. -// -// The list of snapshots returned can be -// filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services -// accounts with create volume permissions. If no options are specified, Amazon EC2 -// returns all snapshots for which you have create volume permissions. If you -// specify one or more snapshot IDs, only snapshots that have the specified IDs are -// returned. If you specify an invalid snapshot ID, an error is returned. If you -// specify a snapshot ID for which you do not have access, it is not included in -// the returned results. If you specify one or more snapshot owners using the -// OwnerIds option, only snapshots from the specified owners and for which you have -// access are returned. The results can include the Amazon Web Services account IDs -// of the specified owners, amazon for snapshots owned by Amazon, or self for -// snapshots that you own. If you specify a list of restorable users, only -// snapshots with create snapshot permissions for those users are returned. You can -// specify Amazon Web Services account IDs (if you own the snapshots), self for -// snapshots for which you own or have explicit permissions, or all for public -// snapshots. If you are describing a long list of snapshots, we recommend that you -// paginate the output to make the list more manageable. For more information, see -// Pagination -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). -// To get the state of fast snapshot restores for a snapshot, use -// DescribeFastSnapshotRestores. For more information about EBS snapshots, see -// Amazon EBS snapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html) in the -// Amazon Elastic Compute Cloud User Guide. +// The list of snapshots returned can be filtered by specifying snapshot IDs, +// snapshot owners, or Amazon Web Services accounts with create volume permissions. +// If no options are specified, Amazon EC2 returns all snapshots for which you have +// create volume permissions. If you specify one or more snapshot IDs, only +// snapshots that have the specified IDs are returned. If you specify an invalid +// snapshot ID, an error is returned. If you specify a snapshot ID for which you do +// not have access, it is not included in the returned results. If you specify one +// or more snapshot owners using the OwnerIds option, only snapshots from the +// specified owners and for which you have access are returned. The results can +// include the Amazon Web Services account IDs of the specified owners, amazon for +// snapshots owned by Amazon, or self for snapshots that you own. If you specify a +// list of restorable users, only snapshots with create snapshot permissions for +// those users are returned. You can specify Amazon Web Services account IDs (if +// you own the snapshots), self for snapshots for which you own or have explicit +// permissions, or all for public snapshots. If you are describing a long list of +// snapshots, we recommend that you paginate the output to make the list more +// manageable. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) +// . To get the state of fast snapshot restores for a snapshot, use +// DescribeFastSnapshotRestores . For more information about EBS snapshots, see +// Amazon EBS snapshots (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} @@ -77,62 +69,40 @@ type DescribeSnapshotsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * description - A description of the snapshot. - // - // * encrypted - - // Indicates whether the snapshot is encrypted (true | false) - // - // * owner-alias - The - // owner alias, from an Amazon-maintained list (amazon). This is not the - // user-configured Amazon Web Services account alias set using the IAM console. We - // recommend that you use the related parameter instead of this filter. - // - // * owner-id - // - The Amazon Web Services account ID of the owner. We recommend that you use the - // related parameter instead of this filter. - // - // * progress - The progress of the - // snapshot, as a percentage (for example, 80%). - // - // * snapshot-id - The snapshot - // ID. - // - // * start-time - The time stamp when the snapshot was initiated. - // - // * status - - // The status of the snapshot (pending | completed | error). - // - // * storage-tier - The - // storage tier of the snapshot (archive | standard). - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. - // - // * volume-id - The ID of the - // volume the snapshot is for. - // - // * volume-size - The size of the volume, in GiB. + // - description - A description of the snapshot. + // - encrypted - Indicates whether the snapshot is encrypted ( true | false ) + // - owner-alias - The owner alias, from an Amazon-maintained list ( amazon ). + // This is not the user-configured Amazon Web Services account alias set using the + // IAM console. We recommend that you use the related parameter instead of this + // filter. + // - owner-id - The Amazon Web Services account ID of the owner. We recommend + // that you use the related parameter instead of this filter. + // - progress - The progress of the snapshot, as a percentage (for example, 80%). + // - snapshot-id - The snapshot ID. + // - start-time - The time stamp when the snapshot was initiated. + // - status - The status of the snapshot ( pending | completed | error ). + // - storage-tier - The storage tier of the snapshot ( archive | standard ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - volume-id - The ID of the volume the snapshot is for. + // - volume-size - The size of the volume, in GiB. Filters []types.Filter // The maximum number of snapshots to return for this request. This value can be // between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are // returned. If this parameter is not used, then the request returns all snapshots. // You cannot specify this parameter and the snapshot IDs parameter in the same - // request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -140,7 +110,7 @@ type DescribeSnapshotsInput struct { NextToken *string // Scopes the results to snapshots with the specified owners. You can specify a - // combination of Amazon Web Services account IDs, self, and amazon. + // combination of Amazon Web Services account IDs, self , and amazon . OwnerIds []string // The IDs of the Amazon Web Services accounts that can create volumes from the @@ -243,8 +213,8 @@ type DescribeSnapshotsPaginatorOptions struct { // between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are // returned. If this parameter is not used, then the request returns all snapshots. // You cannot specify this parameter and the snapshot IDs parameter in the same - // request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -337,9 +307,9 @@ type SnapshotCompletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SnapshotCompletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SnapshotCompletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -387,10 +357,10 @@ func (w *SnapshotCompletedWaiter) Wait(ctx context.Context, params *DescribeSnap return err } -// WaitForOutput calls the waiter function for SnapshotCompleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for SnapshotCompleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *SnapshotCompletedWaiter) WaitForOutput(ctx context.Context, params *DescribeSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*SnapshotCompletedWaiterOptions)) (*DescribeSnapshotsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/ec2/api_op_DescribeSpotDatafeedSubscription.go b/service/ec2/api_op_DescribeSpotDatafeedSubscription.go index ba0c5f855a4..1d7752e73b8 100644 --- a/service/ec2/api_op_DescribeSpotDatafeedSubscription.go +++ b/service/ec2/api_op_DescribeSpotDatafeedSubscription.go @@ -12,9 +12,8 @@ import ( ) // Describes the data feed for Spot Instances. For more information, see Spot -// Instance data feed -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) in -// the Amazon EC2 User Guide for Linux Instances. +// Instance data feed (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) +// in the Amazon EC2 User Guide for Linux Instances. func (c *Client) DescribeSpotDatafeedSubscription(ctx context.Context, params *DescribeSpotDatafeedSubscriptionInput, optFns ...func(*Options)) (*DescribeSpotDatafeedSubscriptionOutput, error) { if params == nil { params = &DescribeSpotDatafeedSubscriptionInput{} @@ -35,8 +34,8 @@ type DescribeSpotDatafeedSubscriptionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeSpotFleetInstances.go b/service/ec2/api_op_DescribeSpotFleetInstances.go index 683d2ae74e8..6eb3185aab3 100644 --- a/service/ec2/api_op_DescribeSpotFleetInstances.go +++ b/service/ec2/api_op_DescribeSpotFleetInstances.go @@ -37,14 +37,14 @@ type DescribeSpotFleetInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token to include in another request to get the next page of items. This diff --git a/service/ec2/api_op_DescribeSpotFleetRequestHistory.go b/service/ec2/api_op_DescribeSpotFleetRequestHistory.go index 1e8b3baab26..4d54f3cd85a 100644 --- a/service/ec2/api_op_DescribeSpotFleetRequestHistory.go +++ b/service/ec2/api_op_DescribeSpotFleetRequestHistory.go @@ -16,9 +16,8 @@ import ( // time. Spot Fleet events are delayed by up to 30 seconds before they can be // described. This ensures that you can query by the last evaluated time and not // miss a recorded event. Spot Fleet events are available for 48 hours. For more -// information, see Monitor fleet events using Amazon EventBridge -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) in the -// Amazon EC2 User Guide. +// information, see Monitor fleet events using Amazon EventBridge (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeSpotFleetRequestHistory(ctx context.Context, params *DescribeSpotFleetRequestHistoryInput, optFns ...func(*Options)) (*DescribeSpotFleetRequestHistoryOutput, error) { if params == nil { params = &DescribeSpotFleetRequestHistoryInput{} @@ -50,8 +49,8 @@ type DescribeSpotFleetRequestHistoryInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The type of events to describe. By default, all events are described. @@ -59,8 +58,8 @@ type DescribeSpotFleetRequestHistoryInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token to include in another request to get the next page of items. This diff --git a/service/ec2/api_op_DescribeSpotFleetRequests.go b/service/ec2/api_op_DescribeSpotFleetRequests.go index c1514a296fd..59bb12f2592 100644 --- a/service/ec2/api_op_DescribeSpotFleetRequests.go +++ b/service/ec2/api_op_DescribeSpotFleetRequests.go @@ -34,14 +34,14 @@ type DescribeSpotFleetRequestsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token to include in another request to get the next page of items. This @@ -143,8 +143,8 @@ var _ DescribeSpotFleetRequestsAPIClient = (*Client)(nil) type DescribeSpotFleetRequestsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeSpotInstanceRequests.go b/service/ec2/api_op_DescribeSpotInstanceRequests.go index 7b5cb9beb0d..e51487a98ad 100644 --- a/service/ec2/api_op_DescribeSpotInstanceRequests.go +++ b/service/ec2/api_op_DescribeSpotInstanceRequests.go @@ -20,17 +20,16 @@ import ( // Describes the specified Spot Instance requests. You can use // DescribeSpotInstanceRequests to find a running Spot Instance by examining the -// response. If the status of the Spot Instance is fulfilled, the instance ID +// response. If the status of the Spot Instance is fulfilled , the instance ID // appears in the response and contains the identifier of the instance. -// Alternatively, you can use DescribeInstances -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances) -// with a filter to look for instances where the instance lifecycle is spot. We +// Alternatively, you can use DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances) +// with a filter to look for instances where the instance lifecycle is spot . We // recommend that you set MaxResults to a value between 5 and 1000 to limit the // number of items returned. This paginates the output, which makes the list more // manageable and returns the items faster. If the list of items exceeds your // MaxResults value, then that number of items is returned along with a NextToken -// value that can be passed to a subsequent DescribeSpotInstanceRequests request to -// retrieve the remaining items. Spot Instance requests are deleted four hours +// value that can be passed to a subsequent DescribeSpotInstanceRequests request +// to retrieve the remaining items. Spot Instance requests are deleted four hours // after they are canceled and their instances are terminated. func (c *Client) DescribeSpotInstanceRequests(ctx context.Context, params *DescribeSpotInstanceRequestsInput, optFns ...func(*Options)) (*DescribeSpotInstanceRequestsOutput, error) { if params == nil { @@ -52,145 +51,81 @@ type DescribeSpotInstanceRequestsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * availability-zone-group - The Availability Zone - // group. - // - // * create-time - The time stamp when the Spot Instance request was - // created. - // - // * fault-code - The fault code related to the request. - // - // * fault-message - // - The fault message related to the request. - // - // * instance-id - The ID of the - // instance that fulfilled the request. - // - // * launch-group - The Spot Instance launch - // group. - // - // * launch.block-device-mapping.delete-on-termination - Indicates whether - // the EBS volume is deleted on instance termination. - // - // * - // launch.block-device-mapping.device-name - The device name for the volume in the - // block device mapping (for example, /dev/sdh or xvdh). - // - // * - // launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS - // volume. - // - // * launch.block-device-mapping.volume-size - The size of the EBS volume, - // in GiB. - // - // * launch.block-device-mapping.volume-type - The type of EBS volume: gp2 - // for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput - // Optimized HDD, sc1for Cold HDD, or standard for Magnetic. - // - // * launch.group-id - - // The ID of the security group for the instance. - // - // * launch.group-name - The name - // of the security group for the instance. - // - // * launch.image-id - The ID of the - // AMI. - // - // * launch.instance-type - The type of instance (for example, m3.medium). - // - // * - // launch.kernel-id - The kernel ID. - // - // * launch.key-name - The name of the key pair - // the instance launched with. - // - // * launch.monitoring-enabled - Whether detailed - // monitoring is enabled for the Spot Instance. - // - // * launch.ramdisk-id - The RAM disk - // ID. - // - // * launched-availability-zone - The Availability Zone in which the request - // is launched. - // - // * network-interface.addresses.primary - Indicates whether the IP - // address is the primary private IP address. - // - // * - // network-interface.delete-on-termination - Indicates whether the network - // interface is deleted when the instance is terminated. - // - // * - // network-interface.description - A description of the network interface. - // - // * - // network-interface.device-index - The index of the device for the network - // interface attachment on the instance. - // - // * network-interface.group-id - The ID of - // the security group associated with the network interface. - // - // * - // network-interface.network-interface-id - The ID of the network interface. - // - // * - // network-interface.private-ip-address - The primary private IP address of the - // network interface. - // - // * network-interface.subnet-id - The ID of the subnet for the - // instance. - // - // * product-description - The product description associated with the - // instance (Linux/UNIX | Windows). - // - // * spot-instance-request-id - The Spot Instance - // request ID. - // - // * spot-price - The maximum hourly price for any Spot Instance - // launched to fulfill the request. - // - // * state - The state of the Spot Instance - // request (open | active | closed | cancelled | failed). Spot request status - // information can help you track your Amazon EC2 Spot Instance requests. For more - // information, see Spot request status - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html) - // in the Amazon EC2 User Guide for Linux Instances. - // - // * status-code - The short - // code describing the most recent evaluation of your Spot Instance request. - // - // * - // status-message - The message explaining the status of the Spot Instance - // request. - // - // * tag: - The key/value combination of a tag assigned to the resource. - // Use the tag key in the filter name and the tag value as the filter value. For - // example, to find all resources that have a tag with the key Owner and the value - // TeamA, specify tag:Owner for the filter name and TeamA for the filter value. - // - // * - // tag-key - The key of a tag assigned to the resource. Use this filter to find all - // resources assigned a tag with a specific key, regardless of the tag value. - // - // * - // type - The type of Spot Instance request (one-time | persistent). - // - // * valid-from - // - The start date of the request. - // - // * valid-until - The end date of the request. + // - availability-zone-group - The Availability Zone group. + // - create-time - The time stamp when the Spot Instance request was created. + // - fault-code - The fault code related to the request. + // - fault-message - The fault message related to the request. + // - instance-id - The ID of the instance that fulfilled the request. + // - launch-group - The Spot Instance launch group. + // - launch.block-device-mapping.delete-on-termination - Indicates whether the + // EBS volume is deleted on instance termination. + // - launch.block-device-mapping.device-name - The device name for the volume in + // the block device mapping (for example, /dev/sdh or xvdh ). + // - launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS + // volume. + // - launch.block-device-mapping.volume-size - The size of the EBS volume, in + // GiB. + // - launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for + // General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput + // Optimized HDD, sc1 for Cold HDD, or standard for Magnetic. + // - launch.group-id - The ID of the security group for the instance. + // - launch.group-name - The name of the security group for the instance. + // - launch.image-id - The ID of the AMI. + // - launch.instance-type - The type of instance (for example, m3.medium ). + // - launch.kernel-id - The kernel ID. + // - launch.key-name - The name of the key pair the instance launched with. + // - launch.monitoring-enabled - Whether detailed monitoring is enabled for the + // Spot Instance. + // - launch.ramdisk-id - The RAM disk ID. + // - launched-availability-zone - The Availability Zone in which the request is + // launched. + // - network-interface.addresses.primary - Indicates whether the IP address is + // the primary private IP address. + // - network-interface.delete-on-termination - Indicates whether the network + // interface is deleted when the instance is terminated. + // - network-interface.description - A description of the network interface. + // - network-interface.device-index - The index of the device for the network + // interface attachment on the instance. + // - network-interface.group-id - The ID of the security group associated with + // the network interface. + // - network-interface.network-interface-id - The ID of the network interface. + // - network-interface.private-ip-address - The primary private IP address of the + // network interface. + // - network-interface.subnet-id - The ID of the subnet for the instance. + // - product-description - The product description associated with the instance ( + // Linux/UNIX | Windows ). + // - spot-instance-request-id - The Spot Instance request ID. + // - spot-price - The maximum hourly price for any Spot Instance launched to + // fulfill the request. + // - state - The state of the Spot Instance request ( open | active | closed | + // cancelled | failed ). Spot request status information can help you track your + // Amazon EC2 Spot Instance requests. For more information, see Spot request + // status (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html) + // in the Amazon EC2 User Guide for Linux Instances. + // - status-code - The short code describing the most recent evaluation of your + // Spot Instance request. + // - status-message - The message explaining the status of the Spot Instance + // request. + // - tag: - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - type - The type of Spot Instance request ( one-time | persistent ). + // - valid-from - The start date of the request. + // - valid-until - The end date of the request. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -292,8 +227,8 @@ var _ DescribeSpotInstanceRequestsAPIClient = (*Client)(nil) type DescribeSpotInstanceRequestsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -389,10 +324,10 @@ type SpotInstanceRequestFulfilledWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SpotInstanceRequestFulfilledWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SpotInstanceRequestFulfilledWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeSpotPriceHistory.go b/service/ec2/api_op_DescribeSpotPriceHistory.go index ec8f217cbe3..47d5da99a72 100644 --- a/service/ec2/api_op_DescribeSpotPriceHistory.go +++ b/service/ec2/api_op_DescribeSpotPriceHistory.go @@ -14,8 +14,7 @@ import ( ) // Describes the Spot price history. For more information, see Spot Instance -// pricing history -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html) +// pricing history (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html) // in the Amazon EC2 User Guide for Linux Instances. When you specify a start and // end time, the operation returns the prices of the instance types within that // time range. It also returns the last price change before the start time, which @@ -43,8 +42,8 @@ type DescribeSpotPriceHistoryInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The date and time, up to the current date, from which to stop retrieving the @@ -52,25 +51,18 @@ type DescribeSpotPriceHistoryInput struct { EndTime *time.Time // One or more filters. - // - // * availability-zone - The Availability Zone for which - // prices should be returned. - // - // * instance-type - The type of instance (for example, - // m3.medium). - // - // * product-description - The product description for the Spot price - // (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX - // (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | - // Windows (Amazon VPC)). - // - // * spot-price - The Spot price. The value must match - // exactly (or use wildcards; greater than or less than comparison is not - // supported). - // - // * timestamp - The time stamp of the Spot price history, in UTC - // format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). - // Greater than or less than comparison is not supported. + // - availability-zone - The Availability Zone for which prices should be + // returned. + // - instance-type - The type of instance (for example, m3.medium ). + // - product-description - The product description for the Spot price ( Linux/UNIX + // | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | + // Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows + // (Amazon VPC) ). + // - spot-price - The Spot price. The value must match exactly (or use wildcards; + // greater than or less than comparison is not supported). + // - timestamp - The time stamp of the Spot price history, in UTC format (for + // example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or + // less than comparison is not supported. Filters []types.Filter // Filters the results by the specified instance types. @@ -78,8 +70,8 @@ type DescribeSpotPriceHistoryInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -185,8 +177,8 @@ var _ DescribeSpotPriceHistoryAPIClient = (*Client)(nil) type DescribeSpotPriceHistoryPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeStaleSecurityGroups.go b/service/ec2/api_op_DescribeStaleSecurityGroups.go index 5409525bc27..8ae652db73a 100644 --- a/service/ec2/api_op_DescribeStaleSecurityGroups.go +++ b/service/ec2/api_op_DescribeStaleSecurityGroups.go @@ -40,14 +40,14 @@ type DescribeStaleSecurityGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -148,8 +148,8 @@ var _ DescribeStaleSecurityGroupsAPIClient = (*Client)(nil) type DescribeStaleSecurityGroupsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeStoreImageTasks.go b/service/ec2/api_op_DescribeStoreImageTasks.go index ed578d741bb..cc660e4b801 100644 --- a/service/ec2/api_op_DescribeStoreImageTasks.go +++ b/service/ec2/api_op_DescribeStoreImageTasks.go @@ -15,16 +15,14 @@ import ( // Describes the progress of the AMI store tasks. You can describe the store tasks // for specified AMIs. If you don't specify the AMIs, you get a paginated list of // store tasks from the last 31 days. For each AMI task, the response indicates if -// the task is InProgress, Completed, or Failed. For tasks InProgress, the response -// shows the estimated progress as a percentage. Tasks are listed in reverse -// chronological order. Currently, only tasks from the past 31 days can be viewed. -// To use this API, you must have the required permissions. For more information, -// see Permissions for storing and restoring AMIs using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) -// in the Amazon EC2 User Guide. For more information, see Store and restore an AMI -// using Amazon S3 -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in -// the Amazon EC2 User Guide. +// the task is InProgress , Completed , or Failed . For tasks InProgress , the +// response shows the estimated progress as a percentage. Tasks are listed in +// reverse chronological order. Currently, only tasks from the past 31 days can be +// viewed. To use this API, you must have the required permissions. For more +// information, see Permissions for storing and restoring AMIs using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions) +// in the Amazon EC2 User Guide. For more information, see Store and restore an +// AMI using Amazon S3 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) +// in the Amazon EC2 User Guide. func (c *Client) DescribeStoreImageTasks(ctx context.Context, params *DescribeStoreImageTasksInput, optFns ...func(*Options)) (*DescribeStoreImageTasksOutput, error) { if params == nil { params = &DescribeStoreImageTasksInput{} @@ -44,17 +42,15 @@ type DescribeStoreImageTasksInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * task-state - Returns tasks in a certain state (InProgress | - // Completed | Failed) - // - // * bucket - Returns task information for tasks that targeted - // a specific bucket. For the filter value, specify the bucket name. + // - task-state - Returns tasks in a certain state ( InProgress | Completed | + // Failed ) + // - bucket - Returns task information for tasks that targeted a specific bucket. + // For the filter value, specify the bucket name. Filters []types.Filter // The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a @@ -63,9 +59,8 @@ type DescribeStoreImageTasksInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the ImageIDs parameter in the same call. + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the ImageIDs parameter in the same call. MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -163,9 +158,8 @@ var _ DescribeStoreImageTasksAPIClient = (*Client)(nil) type DescribeStoreImageTasksPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). - // You cannot specify this parameter and the ImageIDs parameter in the same call. + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . You cannot specify this parameter and the ImageIDs parameter in the same call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeSubnets.go b/service/ec2/api_op_DescribeSubnets.go index b9d4f5d11b1..1d43099b3fb 100644 --- a/service/ec2/api_op_DescribeSubnets.go +++ b/service/ec2/api_op_DescribeSubnets.go @@ -38,111 +38,73 @@ type DescribeSubnetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * availability-zone - The Availability Zone for the - // subnet. You can also use availabilityZone as the filter name. - // - // * - // availability-zone-id - The ID of the Availability Zone for the subnet. You can - // also use availabilityZoneId as the filter name. - // - // * available-ip-address-count - - // The number of IPv4 addresses in the subnet that are available. - // - // * cidr-block - - // The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match - // the subnet's CIDR block for information to be returned for the subnet. You can - // also use cidr or cidrBlock as the filter names. - // - // * customer-owned-ipv4-pool - - // The customer-owned IPv4 address pool associated with the subnet. - // - // * - // default-for-az - Indicates whether this is the default subnet for the - // Availability Zone (true | false). You can also use defaultForAz as the filter - // name. - // - // * enable-dns64 - Indicates whether DNS queries made to the - // Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 - // addresses for IPv4-only destinations. - // - // * enable-lni-at-device-index - Indicates - // the device position for local network interfaces in this subnet. For example, 1 - // indicates local network interfaces in this subnet are the secondary network - // interface (eth1). - // - // * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR - // block associated with the subnet. - // - // * ipv6-cidr-block-association.association-id - // - An association ID for an IPv6 CIDR block associated with the subnet. - // - // * - // ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated - // with the subnet. - // - // * ipv6-native - Indicates whether this is an IPv6 only subnet - // (true | false). - // - // * map-customer-owned-ip-on-launch - Indicates whether a network - // interface created in this subnet (including a network interface created by - // RunInstances) receives a customer-owned IPv4 address. - // - // * map-public-ip-on-launch - // - Indicates whether instances launched in this subnet receive a public IPv4 - // address. - // - // * outpost-arn - The Amazon Resource Name (ARN) of the Outpost. - // - // * - // owner-id - The ID of the Amazon Web Services account that owns the subnet. - // - // * - // private-dns-name-options-on-launch.hostname-type - The type of hostname to - // assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 - // and IPv6) subnets, an instance DNS name can be based on the instance IPv4 - // address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an - // instance DNS name must be based on the instance ID (resource-name). - // - // * - // private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates - // whether to respond to DNS queries for instance hostnames with DNS A records. - // - // * - // private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. - // - // * state - The state of the subnet (pending | available). - // - // * subnet-arn - // - The Amazon Resource Name (ARN) of the subnet. - // - // * subnet-id - The ID of the - // subnet. - // - // * tag: - The key/value combination of a tag assigned to the resource. - // Use the tag key in the filter name and the tag value as the filter value. For - // example, to find all resources that have a tag with the key Owner and the value - // TeamA, specify tag:Owner for the filter name and TeamA for the filter value. - // - // * - // tag-key - The key of a tag assigned to the resource. Use this filter to find all - // resources assigned a tag with a specific key, regardless of the tag value. - // - // * - // vpc-id - The ID of the VPC for the subnet. + // - availability-zone - The Availability Zone for the subnet. You can also use + // availabilityZone as the filter name. + // - availability-zone-id - The ID of the Availability Zone for the subnet. You + // can also use availabilityZoneId as the filter name. + // - available-ip-address-count - The number of IPv4 addresses in the subnet that + // are available. + // - cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify + // must exactly match the subnet's CIDR block for information to be returned for + // the subnet. You can also use cidr or cidrBlock as the filter names. + // - customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated + // with the subnet. + // - default-for-az - Indicates whether this is the default subnet for the + // Availability Zone ( true | false ). You can also use defaultForAz as the + // filter name. + // - enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS + // Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only + // destinations. + // - enable-lni-at-device-index - Indicates the device position for local network + // interfaces in this subnet. For example, 1 indicates local network interfaces + // in this subnet are the secondary network interface (eth1). + // - ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated + // with the subnet. + // - ipv6-cidr-block-association.association-id - An association ID for an IPv6 + // CIDR block associated with the subnet. + // - ipv6-cidr-block-association.state - The state of an IPv6 CIDR block + // associated with the subnet. + // - ipv6-native - Indicates whether this is an IPv6 only subnet ( true | false + // ). + // - map-customer-owned-ip-on-launch - Indicates whether a network interface + // created in this subnet (including a network interface created by RunInstances + // ) receives a customer-owned IPv4 address. + // - map-public-ip-on-launch - Indicates whether instances launched in this + // subnet receive a public IPv4 address. + // - outpost-arn - The Amazon Resource Name (ARN) of the Outpost. + // - owner-id - The ID of the Amazon Web Services account that owns the subnet. + // - private-dns-name-options-on-launch.hostname-type - The type of hostname to + // assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 + // and IPv6) subnets, an instance DNS name can be based on the instance IPv4 + // address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an + // instance DNS name must be based on the instance ID (resource-name). + // - private-dns-name-options-on-launch.enable-resource-name-dns-a-record - + // Indicates whether to respond to DNS queries for instance hostnames with DNS A + // records. + // - private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - + // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA + // records. + // - state - The state of the subnet ( pending | available ). + // - subnet-arn - The Amazon Resource Name (ARN) of the subnet. + // - subnet-id - The ID of the subnet. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC for the subnet. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -242,8 +204,8 @@ var _ DescribeSubnetsAPIClient = (*Client)(nil) type DescribeSubnetsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -336,9 +298,9 @@ type SubnetAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SubnetAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SubnetAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -378,9 +340,9 @@ func NewSubnetAvailableWaiter(client DescribeSubnetsAPIClient, optFns ...func(*S } } -// Wait calls the waiter function for SubnetAvailable waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for SubnetAvailable waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *SubnetAvailableWaiter) Wait(ctx context.Context, params *DescribeSubnetsInput, maxWaitDur time.Duration, optFns ...func(*SubnetAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/ec2/api_op_DescribeTags.go b/service/ec2/api_op_DescribeTags.go index 802ff78cd1d..3e92eafe97d 100644 --- a/service/ec2/api_op_DescribeTags.go +++ b/service/ec2/api_op_DescribeTags.go @@ -13,9 +13,8 @@ import ( ) // Describes the specified tags for your EC2 resources. For more information about -// tags, see Tag your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon Elastic Compute Cloud User Guide. +// tags, see Tag your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { params = &DescribeTagsInput{} @@ -35,36 +34,30 @@ type DescribeTagsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * key - The tag key. - // - // * resource-id - The ID of the resource. - // - // * - // resource-type - The resource type (customer-gateway | dedicated-host | - // dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | - // instance | internet-gateway | key-pair | launch-template | natgateway | - // network-acl | network-interface | placement-group | reserved-instances | - // route-table | security-group | snapshot | spot-instances-request | subnet | - // volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | - // vpn-connection | vpn-gateway). - // - // * tag: - The key/value combination of the tag. - // For example, specify "tag:Owner" for the filter name and "TeamA" for the filter - // value to find resources with the tag "Owner=TeamA". - // - // * value - The tag value. + // - key - The tag key. + // - resource-id - The ID of the resource. + // - resource-type - The resource type ( customer-gateway | dedicated-host | + // dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | + // instance | internet-gateway | key-pair | launch-template | natgateway | + // network-acl | network-interface | placement-group | reserved-instances | + // route-table | security-group | snapshot | spot-instances-request | subnet | + // volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | + // vpn-connection | vpn-gateway ). + // - tag : - The key/value combination of the tag. For example, specify + // "tag:Owner" for the filter name and "TeamA" for the filter value to find + // resources with the tag "Owner=TeamA". + // - value - The tag value. Filters []types.Filter // The maximum number of items to return for this request. This value can be // between 5 and 1000. To get the next page of items, make another request with the - // token returned in the output. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // token returned in the output. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -160,8 +153,8 @@ var _ DescribeTagsAPIClient = (*Client)(nil) type DescribeTagsPaginatorOptions struct { // The maximum number of items to return for this request. This value can be // between 5 and 1000. To get the next page of items, make another request with the - // token returned in the output. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // token returned in the output. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeTrafficMirrorFilters.go b/service/ec2/api_op_DescribeTrafficMirrorFilters.go index 8c99d058c69..f2d0be3dbdd 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorFilters.go +++ b/service/ec2/api_op_DescribeTrafficMirrorFilters.go @@ -32,17 +32,13 @@ type DescribeTrafficMirrorFiltersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * description: The Traffic Mirror - // filter description. - // - // * traffic-mirror-filter-id: The ID of the Traffic Mirror - // filter. + // - description : The Traffic Mirror filter description. + // - traffic-mirror-filter-id : The ID of the Traffic Mirror filter. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTrafficMirrorSessions.go b/service/ec2/api_op_DescribeTrafficMirrorSessions.go index c54018e84b3..81020b77c81 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorSessions.go +++ b/service/ec2/api_op_DescribeTrafficMirrorSessions.go @@ -33,37 +33,21 @@ type DescribeTrafficMirrorSessionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * description: The Traffic Mirror - // session description. - // - // * network-interface-id: The ID of the Traffic Mirror - // session network interface. - // - // * owner-id: The ID of the account that owns the - // Traffic Mirror session. - // - // * packet-length: The assigned number of packets to - // mirror. - // - // * session-number: The assigned session number. - // - // * - // traffic-mirror-filter-id: The ID of the Traffic Mirror filter. - // - // * - // traffic-mirror-session-id: The ID of the Traffic Mirror session. - // - // * - // traffic-mirror-target-id: The ID of the Traffic Mirror target. - // - // * - // virtual-network-id: The virtual network ID of the Traffic Mirror session. + // - description : The Traffic Mirror session description. + // - network-interface-id : The ID of the Traffic Mirror session network + // interface. + // - owner-id : The ID of the account that owns the Traffic Mirror session. + // - packet-length : The assigned number of packets to mirror. + // - session-number : The assigned session number. + // - traffic-mirror-filter-id : The ID of the Traffic Mirror filter. + // - traffic-mirror-session-id : The ID of the Traffic Mirror session. + // - traffic-mirror-target-id : The ID of the Traffic Mirror target. + // - virtual-network-id : The virtual network ID of the Traffic Mirror session. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTrafficMirrorTargets.go b/service/ec2/api_op_DescribeTrafficMirrorTargets.go index 8e256a0da61..6c982580162 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorTargets.go +++ b/service/ec2/api_op_DescribeTrafficMirrorTargets.go @@ -32,26 +32,18 @@ type DescribeTrafficMirrorTargetsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * description: The Traffic Mirror - // target description. - // - // * network-interface-id: The ID of the Traffic Mirror - // session network interface. - // - // * network-load-balancer-arn: The Amazon Resource - // Name (ARN) of the Network Load Balancer that is associated with the session. - // - // * - // owner-id: The ID of the account that owns the Traffic Mirror session. - // - // * - // traffic-mirror-target-id: The ID of the Traffic Mirror target. + // - description : The Traffic Mirror target description. + // - network-interface-id : The ID of the Traffic Mirror session network + // interface. + // - network-load-balancer-arn : The Amazon Resource Name (ARN) of the Network + // Load Balancer that is associated with the session. + // - owner-id : The ID of the account that owns the Traffic Mirror session. + // - traffic-mirror-target-id : The ID of the Traffic Mirror target. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayAttachments.go b/service/ec2/api_op_DescribeTransitGatewayAttachments.go index ab32c870c81..ccbffe0c97a 100644 --- a/service/ec2/api_op_DescribeTransitGatewayAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayAttachments.go @@ -34,41 +34,27 @@ type DescribeTransitGatewayAttachmentsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * association.state - The state - // of the association (associating | associated | disassociating). - // - // * - // association.transit-gateway-route-table-id - The ID of the route table for the - // transit gateway. - // - // * resource-id - The ID of the resource. - // - // * resource-owner-id - - // The ID of the Amazon Web Services account that owns the resource. - // - // * - // resource-type - The resource type. Valid values are vpc | vpn | - // direct-connect-gateway | peering | connect. - // - // * state - The state of the - // attachment. Valid values are available | deleted | deleting | failed | failing | - // initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | - // rejected | rejecting. - // - // * transit-gateway-attachment-id - The ID of the - // attachment. - // - // * transit-gateway-id - The ID of the transit gateway. - // - // * - // transit-gateway-owner-id - The ID of the Amazon Web Services account that owns - // the transit gateway. + // - association.state - The state of the association ( associating | associated + // | disassociating ). + // - association.transit-gateway-route-table-id - The ID of the route table for + // the transit gateway. + // - resource-id - The ID of the resource. + // - resource-owner-id - The ID of the Amazon Web Services account that owns the + // resource. + // - resource-type - The resource type. Valid values are vpc | vpn | + // direct-connect-gateway | peering | connect . + // - state - The state of the attachment. Valid values are available | deleted | + // deleting | failed | failing | initiatingRequest | modifying | + // pendingAcceptance | pending | rollingBack | rejected | rejecting . + // - transit-gateway-attachment-id - The ID of the attachment. + // - transit-gateway-id - The ID of the transit gateway. + // - transit-gateway-owner-id - The ID of the Amazon Web Services account that + // owns the transit gateway. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go b/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go index 64df1e69812..e7641dd77c9 100644 --- a/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go +++ b/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go @@ -32,20 +32,15 @@ type DescribeTransitGatewayConnectPeersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * state - The state of the - // Connect peer (pending | available | deleting | deleted). - // - // * - // transit-gateway-attachment-id - The ID of the attachment. - // - // * - // transit-gateway-connect-peer-id - The ID of the Connect peer. + // - state - The state of the Connect peer ( pending | available | deleting | + // deleted ). + // - transit-gateway-attachment-id - The ID of the attachment. + // - transit-gateway-connect-peer-id - The ID of the Connect peer. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayConnects.go b/service/ec2/api_op_DescribeTransitGatewayConnects.go index 4989e1c74d0..986e812d874 100644 --- a/service/ec2/api_op_DescribeTransitGatewayConnects.go +++ b/service/ec2/api_op_DescribeTransitGatewayConnects.go @@ -32,28 +32,19 @@ type DescribeTransitGatewayConnectsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * options.protocol - The tunnel - // protocol (gre). - // - // * state - The state of the attachment (initiating | - // initiatingRequest | pendingAcceptance | rollingBack | pending | available | - // modifying | deleting | deleted | failed | rejected | rejecting | failing). - // - // * - // transit-gateway-attachment-id - The ID of the Connect attachment. - // - // * - // transit-gateway-id - The ID of the transit gateway. - // - // * - // transport-transit-gateway-attachment-id - The ID of the transit gateway - // attachment from which the Connect attachment was created. + // - options.protocol - The tunnel protocol ( gre ). + // - state - The state of the attachment ( initiating | initiatingRequest | + // pendingAcceptance | rollingBack | pending | available | modifying | deleting | + // deleted | failed | rejected | rejecting | failing ). + // - transit-gateway-attachment-id - The ID of the Connect attachment. + // - transit-gateway-id - The ID of the transit gateway. + // - transport-transit-gateway-attachment-id - The ID of the transit gateway + // attachment from which the Connect attachment was created. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go index 0cd49e0bd1d..954864c3616 100644 --- a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go +++ b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go @@ -32,21 +32,16 @@ type DescribeTransitGatewayMulticastDomainsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * state - The state of the - // transit gateway multicast domain. Valid values are pending | available | - // deleting | deleted. - // - // * transit-gateway-id - The ID of the transit gateway. - // - // * - // transit-gateway-multicast-domain-id - The ID of the transit gateway multicast - // domain. + // - state - The state of the transit gateway multicast domain. Valid values are + // pending | available | deleting | deleted . + // - transit-gateway-id - The ID of the transit gateway. + // - transit-gateway-multicast-domain-id - The ID of the transit gateway + // multicast domain. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go index d3d757741a6..49381c242ea 100644 --- a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go @@ -32,38 +32,25 @@ type DescribeTransitGatewayPeeringAttachmentsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * transit-gateway-attachment-id - - // The ID of the transit gateway attachment. - // - // * local-owner-id - The ID of your - // Amazon Web Services account. - // - // * remote-owner-id - The ID of the Amazon Web - // Services account in the remote Region that owns the transit gateway. - // - // * state - - // The state of the peering attachment. Valid values are available | deleted | - // deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance - // | pending | rollingBack | rejected | rejecting). - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources that have a tag - // with a specific key, regardless of the tag value. - // - // * transit-gateway-id - The ID - // of the transit gateway. + // - transit-gateway-attachment-id - The ID of the transit gateway attachment. + // - local-owner-id - The ID of your Amazon Web Services account. + // - remote-owner-id - The ID of the Amazon Web Services account in the remote + // Region that owns the transit gateway. + // - state - The state of the peering attachment. Valid values are available | + // deleted | deleting | failed | failing | initiatingRequest | modifying | + // pendingAcceptance | pending | rollingBack | rejected | rejecting ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources that have a tag with a specific key, regardless of the tag value. + // - transit-gateway-id - The ID of the transit gateway. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayPolicyTables.go b/service/ec2/api_op_DescribeTransitGatewayPolicyTables.go index 5c49fcd3e67..377f10025ca 100644 --- a/service/ec2/api_op_DescribeTransitGatewayPolicyTables.go +++ b/service/ec2/api_op_DescribeTransitGatewayPolicyTables.go @@ -32,8 +32,8 @@ type DescribeTransitGatewayPolicyTablesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters associated with the transit gateway policy table. diff --git a/service/ec2/api_op_DescribeTransitGatewayRouteTableAnnouncements.go b/service/ec2/api_op_DescribeTransitGatewayRouteTableAnnouncements.go index 36a780c11bc..7e918af443e 100644 --- a/service/ec2/api_op_DescribeTransitGatewayRouteTableAnnouncements.go +++ b/service/ec2/api_op_DescribeTransitGatewayRouteTableAnnouncements.go @@ -32,8 +32,8 @@ type DescribeTransitGatewayRouteTableAnnouncementsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters associated with the transit gateway policy table. diff --git a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go index c753d60d87b..9a79e902a26 100644 --- a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go @@ -33,27 +33,19 @@ type DescribeTransitGatewayRouteTablesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * default-association-route-table - // - Indicates whether this is the default association route table for the transit - // gateway (true | false). - // - // * default-propagation-route-table - Indicates whether - // this is the default propagation route table for the transit gateway (true | - // false). - // - // * state - The state of the route table (available | deleting | deleted - // | pending). - // - // * transit-gateway-id - The ID of the transit gateway. - // - // * - // transit-gateway-route-table-id - The ID of the transit gateway route table. + // - default-association-route-table - Indicates whether this is the default + // association route table for the transit gateway ( true | false ). + // - default-propagation-route-table - Indicates whether this is the default + // propagation route table for the transit gateway ( true | false ). + // - state - The state of the route table ( available | deleting | deleted | + // pending ). + // - transit-gateway-id - The ID of the transit gateway. + // - transit-gateway-route-table-id - The ID of the transit gateway route table. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go index 63477876eee..067f36d09b0 100644 --- a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go @@ -33,24 +33,17 @@ type DescribeTransitGatewayVpcAttachmentsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * state - The state of the - // attachment. Valid values are available | deleted | deleting | failed | failing | - // initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | - // rejected | rejecting. - // - // * transit-gateway-attachment-id - The ID of the - // attachment. - // - // * transit-gateway-id - The ID of the transit gateway. - // - // * vpc-id - - // The ID of the VPC. + // - state - The state of the attachment. Valid values are available | deleted | + // deleting | failed | failing | initiatingRequest | modifying | + // pendingAcceptance | pending | rollingBack | rejected | rejecting . + // - transit-gateway-attachment-id - The ID of the attachment. + // - transit-gateway-id - The ID of the transit gateway. + // - vpc-id - The ID of the VPC. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTransitGateways.go b/service/ec2/api_op_DescribeTransitGateways.go index cdbc5c1e5a9..efc23b86870 100644 --- a/service/ec2/api_op_DescribeTransitGateways.go +++ b/service/ec2/api_op_DescribeTransitGateways.go @@ -33,49 +33,34 @@ type DescribeTransitGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * - // options.propagation-default-route-table-id - The ID of the default propagation - // route table. - // - // * options.amazon-side-asn - The private ASN for the Amazon side of - // a BGP session. - // - // * options.association-default-route-table-id - The ID of the - // default association route table. - // - // * options.auto-accept-shared-attachments - - // Indicates whether there is automatic acceptance of attachment requests (enable | - // disable). - // - // * options.default-route-table-association - Indicates whether - // resource attachments are automatically associated with the default association - // route table (enable | disable). - // - // * options.default-route-table-propagation - - // Indicates whether resource attachments automatically propagate routes to the - // default propagation route table (enable | disable). - // - // * options.dns-support - - // Indicates whether DNS support is enabled (enable | disable). - // - // * - // options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol - // support is enabled (enable | disable). - // - // * owner-id - The ID of the Amazon Web - // Services account that owns the transit gateway. - // - // * state - The state of the - // transit gateway (available | deleted | deleting | modifying | pending). - // - // * - // transit-gateway-id - The ID of the transit gateway. + // - options.propagation-default-route-table-id - The ID of the default + // propagation route table. + // - options.amazon-side-asn - The private ASN for the Amazon side of a BGP + // session. + // - options.association-default-route-table-id - The ID of the default + // association route table. + // - options.auto-accept-shared-attachments - Indicates whether there is + // automatic acceptance of attachment requests ( enable | disable ). + // - options.default-route-table-association - Indicates whether resource + // attachments are automatically associated with the default association route + // table ( enable | disable ). + // - options.default-route-table-propagation - Indicates whether resource + // attachments automatically propagate routes to the default propagation route + // table ( enable | disable ). + // - options.dns-support - Indicates whether DNS support is enabled ( enable | + // disable ). + // - options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol + // support is enabled ( enable | disable ). + // - owner-id - The ID of the Amazon Web Services account that owns the transit + // gateway. + // - state - The state of the transit gateway ( available | deleted | deleting | + // modifying | pending ). + // - transit-gateway-id - The ID of the transit gateway. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go b/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go index aee4039a22f..74da6953967 100644 --- a/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go +++ b/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go @@ -37,16 +37,13 @@ type DescribeTrunkInterfaceAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * gre-key - The ID of a trunk interface association. - // - // * - // interface-protocol - The interface protocol. Valid values are VLAN and GRE. + // - gre-key - The ID of a trunk interface association. + // - interface-protocol - The interface protocol. Valid values are VLAN and GRE . Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeVerifiedAccessEndpoints.go b/service/ec2/api_op_DescribeVerifiedAccessEndpoints.go index 257bfcf2345..5a2ebdc4235 100644 --- a/service/ec2/api_op_DescribeVerifiedAccessEndpoints.go +++ b/service/ec2/api_op_DescribeVerifiedAccessEndpoints.go @@ -32,8 +32,8 @@ type DescribeVerifiedAccessEndpointsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. diff --git a/service/ec2/api_op_DescribeVerifiedAccessGroups.go b/service/ec2/api_op_DescribeVerifiedAccessGroups.go index 7808e6d5f3a..64192a62e8d 100644 --- a/service/ec2/api_op_DescribeVerifiedAccessGroups.go +++ b/service/ec2/api_op_DescribeVerifiedAccessGroups.go @@ -32,8 +32,8 @@ type DescribeVerifiedAccessGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. diff --git a/service/ec2/api_op_DescribeVerifiedAccessInstanceLoggingConfigurations.go b/service/ec2/api_op_DescribeVerifiedAccessInstanceLoggingConfigurations.go index 32b256eeca2..7a52ea1c359 100644 --- a/service/ec2/api_op_DescribeVerifiedAccessInstanceLoggingConfigurations.go +++ b/service/ec2/api_op_DescribeVerifiedAccessInstanceLoggingConfigurations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the current logging configuration for the Amazon Web Services Verified -// Access instances. +// Describes the current logging configuration for the Amazon Web Services +// Verified Access instances. func (c *Client) DescribeVerifiedAccessInstanceLoggingConfigurations(ctx context.Context, params *DescribeVerifiedAccessInstanceLoggingConfigurationsInput, optFns ...func(*Options)) (*DescribeVerifiedAccessInstanceLoggingConfigurationsOutput, error) { if params == nil { params = &DescribeVerifiedAccessInstanceLoggingConfigurationsInput{} @@ -33,8 +33,8 @@ type DescribeVerifiedAccessInstanceLoggingConfigurationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. diff --git a/service/ec2/api_op_DescribeVerifiedAccessInstances.go b/service/ec2/api_op_DescribeVerifiedAccessInstances.go index 690dcc5821c..76e3395135f 100644 --- a/service/ec2/api_op_DescribeVerifiedAccessInstances.go +++ b/service/ec2/api_op_DescribeVerifiedAccessInstances.go @@ -32,8 +32,8 @@ type DescribeVerifiedAccessInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. diff --git a/service/ec2/api_op_DescribeVerifiedAccessTrustProviders.go b/service/ec2/api_op_DescribeVerifiedAccessTrustProviders.go index 07940acdc51..9793df55592 100644 --- a/service/ec2/api_op_DescribeVerifiedAccessTrustProviders.go +++ b/service/ec2/api_op_DescribeVerifiedAccessTrustProviders.go @@ -32,8 +32,8 @@ type DescribeVerifiedAccessTrustProvidersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. Filter names and values are case-sensitive. diff --git a/service/ec2/api_op_DescribeVolumeAttribute.go b/service/ec2/api_op_DescribeVolumeAttribute.go index 92c796b856d..b96a594d924 100644 --- a/service/ec2/api_op_DescribeVolumeAttribute.go +++ b/service/ec2/api_op_DescribeVolumeAttribute.go @@ -44,8 +44,8 @@ type DescribeVolumeAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeVolumeStatus.go b/service/ec2/api_op_DescribeVolumeStatus.go index b155f56ae31..0d9a74aa4ad 100644 --- a/service/ec2/api_op_DescribeVolumeStatus.go +++ b/service/ec2/api_op_DescribeVolumeStatus.go @@ -12,31 +12,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the status of the specified volumes. Volume status provides the result -// of the checks performed on your volumes to determine events that can impair the -// performance of your volumes. The performance of a volume can be affected if an -// issue occurs on the volume's underlying host. If the volume's underlying host -// experiences a power outage or system issue, after the system is restored, there -// could be data inconsistencies on the volume. Volume events notify you if this -// occurs. Volume actions notify you if any action needs to be taken in response to -// the event. The DescribeVolumeStatus operation provides the following information -// about the specified volumes: Status: Reflects the current status of the volume. -// The possible values are ok, impaired , warning, or insufficient-data. If all -// checks pass, the overall status of the volume is ok. If the check fails, the -// overall status is impaired. If the status is insufficient-data, then the checks -// might still be taking place on your volume at the time. We recommend that you -// retry the request. For more information about volume status, see Monitor the -// status of your volumes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html) +// Describes the status of the specified volumes. Volume status provides the +// result of the checks performed on your volumes to determine events that can +// impair the performance of your volumes. The performance of a volume can be +// affected if an issue occurs on the volume's underlying host. If the volume's +// underlying host experiences a power outage or system issue, after the system is +// restored, there could be data inconsistencies on the volume. Volume events +// notify you if this occurs. Volume actions notify you if any action needs to be +// taken in response to the event. The DescribeVolumeStatus operation provides the +// following information about the specified volumes: Status: Reflects the current +// status of the volume. The possible values are ok , impaired , warning , or +// insufficient-data . If all checks pass, the overall status of the volume is ok . +// If the check fails, the overall status is impaired . If the status is +// insufficient-data , then the checks might still be taking place on your volume +// at the time. We recommend that you retry the request. For more information about +// volume status, see Monitor the status of your volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html) // in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a // volume status and might require you to take action. For example, if your volume // returns an impaired status, then the volume event might be -// potential-data-inconsistency. This means that your volume has been affected by +// potential-data-inconsistency . This means that your volume has been affected by // an issue with the underlying host, has all I/O operations disabled, and might // have inconsistent data. Actions: Reflect the actions you might have to take in // response to an event. For example, if the status of the volume is impaired and -// the volume event shows potential-data-inconsistency, then the action shows -// enable-volume-io. This means that you may want to enable the I/O operations for +// the volume event shows potential-data-inconsistency , then the action shows +// enable-volume-io . This means that you may want to enable the I/O operations for // the volume by calling the EnableVolumeIO action and then check the volume for // data consistency. Volume status is based on the volume status checks, and does // not reflect the volume state. Therefore, volume status does not indicate volumes @@ -60,48 +59,30 @@ type DescribeVolumeStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * action.code - The action code for the event (for example, - // enable-volume-io). - // - // * action.description - A description of the action. - // - // * - // action.event-id - The event ID associated with the action. - // - // * availability-zone - // - The Availability Zone of the instance. - // - // * event.description - A description of - // the event. - // - // * event.event-id - The event ID. - // - // * event.event-type - The event - // type (for io-enabled: passed | failed; for io-performance: - // io-performance:degraded | io-performance:severely-degraded | - // io-performance:stalled). - // - // * event.not-after - The latest end time for the - // event. - // - // * event.not-before - The earliest start time for the event. - // - // * - // volume-status.details-name - The cause for volume-status.status (io-enabled | - // io-performance). - // - // * volume-status.details-status - The status of - // volume-status.details-name (for io-enabled: passed | failed; for io-performance: - // normal | degraded | severely-degraded | stalled). - // - // * volume-status.status - The - // status of the volume (ok | impaired | warning | insufficient-data). + // - action.code - The action code for the event (for example, enable-volume-io + // ). + // - action.description - A description of the action. + // - action.event-id - The event ID associated with the action. + // - availability-zone - The Availability Zone of the instance. + // - event.description - A description of the event. + // - event.event-id - The event ID. + // - event.event-type - The event type (for io-enabled : passed | failed ; for + // io-performance : io-performance:degraded | io-performance:severely-degraded | + // io-performance:stalled ). + // - event.not-after - The latest end time for the event. + // - event.not-before - The earliest start time for the event. + // - volume-status.details-name - The cause for volume-status.status ( io-enabled + // | io-performance ). + // - volume-status.details-status - The status of volume-status.details-name (for + // io-enabled : passed | failed ; for io-performance : normal | degraded | + // severely-degraded | stalled ). + // - volume-status.status - The status of the volume ( ok | impaired | warning | + // insufficient-data ). Filters []types.Filter // The maximum number of items to return for this request. To get the next page of @@ -109,8 +90,8 @@ type DescribeVolumeStatusInput struct { // can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 // results are returned. If this parameter is not used, then all items are // returned. You cannot specify this parameter and the volume IDs parameter in the - // same request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // same request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -214,8 +195,8 @@ type DescribeVolumeStatusPaginatorOptions struct { // can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 // results are returned. If this parameter is not used, then all items are // returned. You cannot specify this parameter and the volume IDs parameter in the - // same request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // same request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeVolumes.go b/service/ec2/api_op_DescribeVolumes.go index 1aae7e31d32..99510400cc5 100644 --- a/service/ec2/api_op_DescribeVolumes.go +++ b/service/ec2/api_op_DescribeVolumes.go @@ -20,11 +20,9 @@ import ( // Describes the specified EBS volumes or all of your EBS volumes. If you are // describing a long list of volumes, we recommend that you paginate the output to -// make the list more manageable. For more information, see Pagination -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). -// For more information about EBS volumes, see Amazon EBS volumes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html) in the -// Amazon Elastic Compute Cloud User Guide. +// make the list more manageable. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) +// . For more information about EBS volumes, see Amazon EBS volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInput, optFns ...func(*Options)) (*DescribeVolumesOutput, error) { if params == nil { params = &DescribeVolumesInput{} @@ -44,74 +42,47 @@ type DescribeVolumesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * attachment.attach-time - The time stamp when the attachment - // initiated. - // - // * attachment.delete-on-termination - Whether the volume is deleted - // on instance termination. - // - // * attachment.device - The device name specified in the - // block device mapping (for example, /dev/sda1). - // - // * attachment.instance-id - The - // ID of the instance the volume is attached to. - // - // * attachment.status - The - // attachment state (attaching | attached | detaching). - // - // * availability-zone - The - // Availability Zone in which the volume was created. - // - // * create-time - The time - // stamp when the volume was created. - // - // * encrypted - Indicates whether the volume - // is encrypted (true | false) - // - // * multi-attach-enabled - Indicates whether the - // volume is enabled for Multi-Attach (true | false) - // - // * fast-restored - Indicates - // whether the volume was created from a snapshot that is enabled for fast snapshot - // restore (true | false). - // - // * size - The size of the volume, in GiB. - // - // * snapshot-id - // - The snapshot from which the volume was created. - // - // * status - The state of the - // volume (creating | available | in-use | deleting | deleted | error). - // - // * tag: - - // The key/value combination of a tag assigned to the resource. Use the tag key in - // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. - // - // * volume-id - - // The volume ID. - // - // * volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | - // io2 | st1 | sc1| standard) + // - attachment.attach-time - The time stamp when the attachment initiated. + // - attachment.delete-on-termination - Whether the volume is deleted on instance + // termination. + // - attachment.device - The device name specified in the block device mapping + // (for example, /dev/sda1 ). + // - attachment.instance-id - The ID of the instance the volume is attached to. + // - attachment.status - The attachment state ( attaching | attached | detaching + // ). + // - availability-zone - The Availability Zone in which the volume was created. + // - create-time - The time stamp when the volume was created. + // - encrypted - Indicates whether the volume is encrypted ( true | false ) + // - multi-attach-enabled - Indicates whether the volume is enabled for + // Multi-Attach ( true | false ) + // - fast-restored - Indicates whether the volume was created from a snapshot + // that is enabled for fast snapshot restore ( true | false ). + // - size - The size of the volume, in GiB. + // - snapshot-id - The snapshot from which the volume was created. + // - status - The state of the volume ( creating | available | in-use | deleting + // | deleted | error ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - volume-id - The volume ID. + // - volume-type - The Amazon EBS volume type ( gp2 | gp3 | io1 | io2 | st1 | sc1 + // | standard ) Filters []types.Filter // The maximum number of volumes to return for this request. This value can be // between 5 and 500; if you specify a value larger than 500, only 500 items are // returned. If this parameter is not used, then all items are returned. You cannot // specify this parameter and the volume IDs parameter in the same request. For - // more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -213,8 +184,8 @@ type DescribeVolumesPaginatorOptions struct { // between 5 and 500; if you specify a value larger than 500, only 500 items are // returned. If this parameter is not used, then all items are returned. You cannot // specify this parameter and the volume IDs parameter in the same request. For - // more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -307,9 +278,9 @@ type VolumeAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VolumeAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VolumeAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -349,9 +320,9 @@ func NewVolumeAvailableWaiter(client DescribeVolumesAPIClient, optFns ...func(*V } } -// Wait calls the waiter function for VolumeAvailable waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for VolumeAvailable waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *VolumeAvailableWaiter) Wait(ctx context.Context, params *DescribeVolumesInput, maxWaitDur time.Duration, optFns ...func(*VolumeAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -506,8 +477,8 @@ type VolumeDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VolumeDeletedWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VolumeDeletedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -556,9 +527,10 @@ func (w *VolumeDeletedWaiter) Wait(ctx context.Context, params *DescribeVolumesI return err } -// WaitForOutput calls the waiter function for VolumeDeleted waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for VolumeDeleted waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *VolumeDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeVolumesInput, maxWaitDur time.Duration, optFns ...func(*VolumeDeletedWaiterOptions)) (*DescribeVolumesOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -692,9 +664,9 @@ type VolumeInUseWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VolumeInUseWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VolumeInUseWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeVolumesModifications.go b/service/ec2/api_op_DescribeVolumesModifications.go index 2841e7b68ac..bc73a1e2d52 100644 --- a/service/ec2/api_op_DescribeVolumesModifications.go +++ b/service/ec2/api_op_DescribeVolumesModifications.go @@ -17,10 +17,8 @@ import ( // will be null. If a volume has been modified more than once, the output includes // only the most recent modification request. You can also use CloudWatch Events to // check the status of a modification to an EBS volume. For information about -// CloudWatch Events, see the Amazon CloudWatch Events User Guide -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/). For more -// information, see Monitor the progress of volume modifications -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html) +// CloudWatch Events, see the Amazon CloudWatch Events User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/) +// . For more information, see Monitor the progress of volume modifications (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeVolumesModifications(ctx context.Context, params *DescribeVolumesModificationsInput, optFns ...func(*Options)) (*DescribeVolumesModificationsOutput, error) { if params == nil { @@ -41,48 +39,32 @@ type DescribeVolumesModificationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * modification-state - The current modification state (modifying | - // optimizing | completed | failed). - // - // * original-iops - The original IOPS rate of - // the volume. - // - // * original-size - The original size of the volume, in GiB. - // - // * - // original-volume-type - The original volume type of the volume (standard | io1 | - // io2 | gp2 | sc1 | st1). - // - // * originalMultiAttachEnabled - Indicates whether - // Multi-Attach support was enabled (true | false). - // - // * start-time - The - // modification start time. - // - // * target-iops - The target IOPS rate of the volume. - // - // * - // target-size - The target size of the volume, in GiB. - // - // * target-volume-type - The - // target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). - // - // * - // targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be - // enabled (true | false). - // - // * volume-id - The ID of the volume. + // - modification-state - The current modification state (modifying | optimizing + // | completed | failed). + // - original-iops - The original IOPS rate of the volume. + // - original-size - The original size of the volume, in GiB. + // - original-volume-type - The original volume type of the volume (standard | + // io1 | io2 | gp2 | sc1 | st1). + // - originalMultiAttachEnabled - Indicates whether Multi-Attach support was + // enabled (true | false). + // - start-time - The modification start time. + // - target-iops - The target IOPS rate of the volume. + // - target-size - The target size of the volume, in GiB. + // - target-volume-type - The target volume type of the volume (standard | io1 | + // io2 | gp2 | sc1 | st1). + // - targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be + // enabled (true | false). + // - volume-id - The ID of the volume. Filters []types.Filter // The maximum number of results (up to a limit of 500) to be returned in a - // paginated request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // paginated request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned by a previous paginated request. Pagination continues from @@ -182,8 +164,8 @@ var _ DescribeVolumesModificationsAPIClient = (*Client)(nil) // DescribeVolumesModifications type DescribeVolumesModificationsPaginatorOptions struct { // The maximum number of results (up to a limit of 500) to be returned in a - // paginated request. For more information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // paginated request. For more information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeVpcAttribute.go b/service/ec2/api_op_DescribeVpcAttribute.go index 84c33effa65..f7cada678f0 100644 --- a/service/ec2/api_op_DescribeVpcAttribute.go +++ b/service/ec2/api_op_DescribeVpcAttribute.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified attribute of the specified VPC. You can specify only one -// attribute at a time. +// Describes the specified attribute of the specified VPC. You can specify only +// one attribute at a time. func (c *Client) DescribeVpcAttribute(ctx context.Context, params *DescribeVpcAttributeInput, optFns ...func(*Options)) (*DescribeVpcAttributeOutput, error) { if params == nil { params = &DescribeVpcAttributeInput{} @@ -42,8 +42,8 @@ type DescribeVpcAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -52,12 +52,12 @@ type DescribeVpcAttributeInput struct { type DescribeVpcAttributeOutput struct { // Indicates whether the instances launched in the VPC get DNS hostnames. If this - // attribute is true, instances in the VPC get DNS hostnames; otherwise, they do + // attribute is true , instances in the VPC get DNS hostnames; otherwise, they do // not. EnableDnsHostnames *types.AttributeBooleanValue // Indicates whether DNS resolution is enabled for the VPC. If this attribute is - // true, the Amazon DNS server resolves DNS hostnames for your instances to their + // true , the Amazon DNS server resolves DNS hostnames for your instances to their // corresponding IP addresses; otherwise, it does not. EnableDnsSupport *types.AttributeBooleanValue diff --git a/service/ec2/api_op_DescribeVpcClassicLink.go b/service/ec2/api_op_DescribeVpcClassicLink.go index bb736f7654a..6f3fddaeb89 100644 --- a/service/ec2/api_op_DescribeVpcClassicLink.go +++ b/service/ec2/api_op_DescribeVpcClassicLink.go @@ -13,9 +13,8 @@ import ( // Describes the ClassicLink status of one or more VPCs. We are retiring // EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more -// information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeVpcClassicLink(ctx context.Context, params *DescribeVpcClassicLinkInput, optFns ...func(*Options)) (*DescribeVpcClassicLinkOutput, error) { if params == nil { params = &DescribeVpcClassicLinkInput{} @@ -35,24 +34,19 @@ type DescribeVpcClassicLinkInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * is-classic-link-enabled - Whether the VPC is enabled for - // ClassicLink (true | false). - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. + // - is-classic-link-enabled - Whether the VPC is enabled for ClassicLink ( true + // | false ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // One or more VPCs for which you want to describe the ClassicLink status. diff --git a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go index 15fcf2969c7..2b4b0e6eae1 100644 --- a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go @@ -12,17 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Describes the ClassicLink DNS support -// status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic -// instance resolves to its private IP address when addressed from an instance in -// the VPC to which it's linked. Similarly, the DNS hostname of an instance in a -// VPC resolves to its private IP address when addressed from a linked EC2-Classic -// instance. For more information, see ClassicLink -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in -// the Amazon Elastic Compute Cloud User Guide. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Describes the ClassicLink DNS +// support status of one or more VPCs. If enabled, the DNS hostname of a linked +// EC2-Classic instance resolves to its private IP address when addressed from an +// instance in the VPC to which it's linked. Similarly, the DNS hostname of an +// instance in a VPC resolves to its private IP address when addressed from a +// linked EC2-Classic instance. For more information, see ClassicLink (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DescribeVpcClassicLinkDnsSupport(ctx context.Context, params *DescribeVpcClassicLinkDnsSupportInput, optFns ...func(*Options)) (*DescribeVpcClassicLinkDnsSupportOutput, error) { if params == nil { params = &DescribeVpcClassicLinkDnsSupportInput{} @@ -42,8 +40,8 @@ type DescribeVpcClassicLinkDnsSupportInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -144,8 +142,8 @@ var _ DescribeVpcClassicLinkDnsSupportAPIClient = (*Client)(nil) type DescribeVpcClassicLinkDnsSupportPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go b/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go index daf888166e0..23e12fcd857 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go @@ -36,28 +36,18 @@ type DescribeVpcEndpointConnectionNotificationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * connection-notification-arn - The ARN of the SNS topic for the - // notification. - // - // * connection-notification-id - The ID of the notification. - // - // * - // connection-notification-state - The state of the notification (Enabled | - // Disabled). - // - // * connection-notification-type - The type of notification - // (Topic). - // - // * service-id - The ID of the endpoint service. - // - // * vpc-endpoint-id - - // The ID of the VPC endpoint. + // - connection-notification-arn - The ARN of the SNS topic for the notification. + // - connection-notification-id - The ID of the notification. + // - connection-notification-state - The state of the notification ( Enabled | + // Disabled ). + // - connection-notification-type - The type of notification ( Topic ). + // - service-id - The ID of the endpoint service. + // - vpc-endpoint-id - The ID of the VPC endpoint. Filters []types.Filter // The maximum number of results to return in a single call. To retrieve the diff --git a/service/ec2/api_op_DescribeVpcEndpointConnections.go b/service/ec2/api_op_DescribeVpcEndpointConnections.go index ea29dfc40be..ef3ea9b523c 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnections.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnections.go @@ -33,25 +33,18 @@ type DescribeVpcEndpointConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * ip-address-type - The IP address type (ipv4 | ipv6). - // - // * - // service-id - The ID of the service. - // - // * vpc-endpoint-owner - The ID of the Amazon - // Web Services account ID that owns the endpoint. - // - // * vpc-endpoint-state - The - // state of the endpoint (pendingAcceptance | pending | available | deleting | - // deleted | rejected | failed). - // - // * vpc-endpoint-id - The ID of the endpoint. + // - ip-address-type - The IP address type ( ipv4 | ipv6 ). + // - service-id - The ID of the service. + // - vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns + // the endpoint. + // - vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending + // | available | deleting | deleted | rejected | failed ). + // - vpc-endpoint-id - The ID of the endpoint. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go index afb6cd06039..3a23a0c79bb 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go +++ b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go @@ -33,32 +33,22 @@ type DescribeVpcEndpointServiceConfigurationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * service-name - The name of the service. - // - // * service-id - The ID - // of the service. - // - // * service-state - The state of the service (Pending | Available - // | Deleting | Deleted | Failed). - // - // * supported-ip-address-types - The IP address - // type (ipv4 | ipv6). - // - // * tag: - The key/value combination of a tag assigned to the - // resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. + // - service-name - The name of the service. + // - service-id - The ID of the service. + // - service-state - The state of the service ( Pending | Available | Deleting | + // Deleted | Failed ). + // - supported-ip-address-types - The IP address type ( ipv4 | ipv6 ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go index 68d3626864b..2fd575e8d5b 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the principals (service consumers) that are permitted to discover your -// VPC endpoint service. +// Describes the principals (service consumers) that are permitted to discover +// your VPC endpoint service. func (c *Client) DescribeVpcEndpointServicePermissions(ctx context.Context, params *DescribeVpcEndpointServicePermissionsInput, optFns ...func(*Options)) (*DescribeVpcEndpointServicePermissionsOutput, error) { if params == nil { params = &DescribeVpcEndpointServicePermissionsInput{} @@ -38,16 +38,14 @@ type DescribeVpcEndpointServicePermissionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * principal - The ARN of the principal. - // - // * principal-type - The - // principal type (All | Service | OrganizationUnit | Account | User | Role). + // - principal - The ARN of the principal. + // - principal-type - The principal type ( All | Service | OrganizationUnit | + // Account | User | Role ). Filters []types.Filter // The maximum number of results to return for the request in a single page. The diff --git a/service/ec2/api_op_DescribeVpcEndpointServices.go b/service/ec2/api_op_DescribeVpcEndpointServices.go index da68c9b3b7c..4edb6f8e459 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServices.go +++ b/service/ec2/api_op_DescribeVpcEndpointServices.go @@ -16,8 +16,8 @@ import ( // Availability Zones, and the consumer views the VPC endpoint service information, // the response only includes the common Availability Zones. For example, when the // service provider account uses us-east-1a and us-east-1c and the consumer uses -// us-east-1a and us-east-1b, the response includes the VPC endpoint services in -// the common Availability Zone, us-east-1a. +// us-east-1a and us-east-1b , the response includes the VPC endpoint services in +// the common Availability Zone, us-east-1a . func (c *Client) DescribeVpcEndpointServices(ctx context.Context, params *DescribeVpcEndpointServicesInput, optFns ...func(*Options)) (*DescribeVpcEndpointServicesOutput, error) { if params == nil { params = &DescribeVpcEndpointServicesInput{} @@ -37,32 +37,23 @@ type DescribeVpcEndpointServicesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * owner - The ID or alias of the Amazon Web Services account that - // owns the service. - // - // * service-name - The name of the service. - // - // * service-type - - // The type of service (Interface | Gateway | GatewayLoadBalancer). - // - // * - // supported-ip-address-types - The IP address type (ipv4 | ipv6). - // - // * tag: - The - // key/value combination of a tag assigned to the resource. Use the tag key in the - // filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify - // tag:Owner for the filter name and TeamA for the filter value. - // - // * tag-key - The - // key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. + // - owner - The ID or alias of the Amazon Web Services account that owns the + // service. + // - service-name - The name of the service. + // - service-type - The type of service ( Interface | Gateway | + // GatewayLoadBalancer ). + // - supported-ip-address-types - The IP address type ( ipv4 | ipv6 ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of items to return for this request. The request returns a diff --git a/service/ec2/api_op_DescribeVpcEndpoints.go b/service/ec2/api_op_DescribeVpcEndpoints.go index 7e88fc9bc9b..b3f00f1239c 100644 --- a/service/ec2/api_op_DescribeVpcEndpoints.go +++ b/service/ec2/api_op_DescribeVpcEndpoints.go @@ -32,38 +32,25 @@ type DescribeVpcEndpointsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters. - // - // * ip-address-type - The IP address type (ipv4 | ipv6). - // - // * - // service-name - The name of the service. - // - // * tag: - The key/value combination of a - // tag assigned to the resource. Use the tag key in the filter name and the tag - // value as the filter value. For example, to find all resources that have a tag - // with the key Owner and the value TeamA, specify tag:Owner for the filter name - // and TeamA for the filter value. - // - // * tag-key - The key of a tag assigned to the - // resource. Use this filter to find all resources assigned a tag with a specific - // key, regardless of the tag value. - // - // * vpc-id - The ID of the VPC in which the - // endpoint resides. - // - // * vpc-endpoint-id - The ID of the endpoint. - // - // * - // vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | - // available | deleting | deleted | rejected | failed). - // - // * vpc-endpoint-type - The - // type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer). + // - ip-address-type - The IP address type ( ipv4 | ipv6 ). + // - service-name - The name of the service. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC in which the endpoint resides. + // - vpc-endpoint-id - The ID of the endpoint. + // - vpc-endpoint-state - The state of the endpoint ( pendingAcceptance | pending + // | available | deleting | deleted | rejected | failed ). + // - vpc-endpoint-type - The type of VPC endpoint ( Interface | Gateway | + // GatewayLoadBalancer ). Filters []types.Filter // The maximum number of items to return for this request. The request returns a diff --git a/service/ec2/api_op_DescribeVpcPeeringConnections.go b/service/ec2/api_op_DescribeVpcPeeringConnections.go index 487031a8315..fc91846c253 100644 --- a/service/ec2/api_op_DescribeVpcPeeringConnections.go +++ b/service/ec2/api_op_DescribeVpcPeeringConnections.go @@ -38,59 +38,38 @@ type DescribeVpcPeeringConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * accepter-vpc-info.cidr-block - The IPv4 CIDR block of - // the accepter VPC. - // - // * accepter-vpc-info.owner-id - The ID of the Amazon Web - // Services account that owns the accepter VPC. - // - // * accepter-vpc-info.vpc-id - The - // ID of the accepter VPC. - // - // * expiration-time - The expiration date and time for - // the VPC peering connection. - // - // * requester-vpc-info.cidr-block - The IPv4 CIDR - // block of the requester's VPC. - // - // * requester-vpc-info.owner-id - The ID of the - // Amazon Web Services account that owns the requester VPC. - // - // * - // requester-vpc-info.vpc-id - The ID of the requester VPC. - // - // * status-code - The - // status of the VPC peering connection (pending-acceptance | failed | expired | - // provisioning | active | deleting | deleted | rejected). - // - // * status-message - A - // message that provides more information about the status of the VPC peering - // connection, if applicable. - // - // * tag: - The key/value combination of a tag assigned - // to the resource. Use the tag key in the filter name and the tag value as the - // filter value. For example, to find all resources that have a tag with the key - // Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for - // the filter value. - // - // * tag-key - The key of a tag assigned to the resource. Use - // this filter to find all resources assigned a tag with a specific key, regardless - // of the tag value. - // - // * vpc-peering-connection-id - The ID of the VPC peering - // connection. + // - accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. + // - accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that + // owns the accepter VPC. + // - accepter-vpc-info.vpc-id - The ID of the accepter VPC. + // - expiration-time - The expiration date and time for the VPC peering + // connection. + // - requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC. + // - requester-vpc-info.owner-id - The ID of the Amazon Web Services account that + // owns the requester VPC. + // - requester-vpc-info.vpc-id - The ID of the requester VPC. + // - status-code - The status of the VPC peering connection ( pending-acceptance + // | failed | expired | provisioning | active | deleting | deleted | rejected ). + // - status-message - A message that provides more information about the status + // of the VPC peering connection, if applicable. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-peering-connection-id - The ID of the VPC peering connection. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -192,8 +171,8 @@ var _ DescribeVpcPeeringConnectionsAPIClient = (*Client)(nil) type DescribeVpcPeeringConnectionsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -289,8 +268,8 @@ type VpcPeeringConnectionDeletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpcPeeringConnectionDeletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpcPeeringConnectionDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -480,8 +459,8 @@ type VpcPeeringConnectionExistsWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpcPeeringConnectionExistsWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpcPeeringConnectionExistsWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/ec2/api_op_DescribeVpcs.go b/service/ec2/api_op_DescribeVpcs.go index 83b2c95e751..826feb77646 100644 --- a/service/ec2/api_op_DescribeVpcs.go +++ b/service/ec2/api_op_DescribeVpcs.go @@ -38,69 +38,45 @@ type DescribeVpcsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * cidr - The primary IPv4 CIDR block of the VPC. The CIDR - // block you specify must exactly match the VPC's CIDR block for information to be - // returned for the VPC. Must contain the slash followed by one or two digits (for - // example, /28). - // - // * cidr-block-association.cidr-block - An IPv4 CIDR block - // associated with the VPC. - // - // * cidr-block-association.association-id - The - // association ID for an IPv4 CIDR block associated with the VPC. - // - // * - // cidr-block-association.state - The state of an IPv4 CIDR block associated with - // the VPC. - // - // * dhcp-options-id - The ID of a set of DHCP options. - // - // * - // ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with - // the VPC. - // - // * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address - // pool from which the IPv6 CIDR block is allocated. - // - // * - // ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR - // block associated with the VPC. - // - // * ipv6-cidr-block-association.state - The state - // of an IPv6 CIDR block associated with the VPC. - // - // * is-default - Indicates whether - // the VPC is the default VPC. - // - // * owner-id - The ID of the Amazon Web Services - // account that owns the VPC. - // - // * state - The state of the VPC (pending | - // available). - // - // * tag: - The key/value combination of a tag assigned to the - // resource. Use the tag key in the filter name and the tag value as the filter - // value. For example, to find all resources that have a tag with the key Owner and - // the value TeamA, specify tag:Owner for the filter name and TeamA for the filter - // value. - // - // * tag-key - The key of a tag assigned to the resource. Use this filter - // to find all resources assigned a tag with a specific key, regardless of the tag - // value. - // - // * vpc-id - The ID of the VPC. + // - cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify + // must exactly match the VPC's CIDR block for information to be returned for the + // VPC. Must contain the slash followed by one or two digits (for example, /28 ). + // - cidr-block-association.cidr-block - An IPv4 CIDR block associated with the + // VPC. + // - cidr-block-association.association-id - The association ID for an IPv4 CIDR + // block associated with the VPC. + // - cidr-block-association.state - The state of an IPv4 CIDR block associated + // with the VPC. + // - dhcp-options-id - The ID of a set of DHCP options. + // - ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated + // with the VPC. + // - ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from + // which the IPv6 CIDR block is allocated. + // - ipv6-cidr-block-association.association-id - The association ID for an IPv6 + // CIDR block associated with the VPC. + // - ipv6-cidr-block-association.state - The state of an IPv6 CIDR block + // associated with the VPC. + // - is-default - Indicates whether the VPC is the default VPC. + // - owner-id - The ID of the Amazon Web Services account that owns the VPC. + // - state - The state of the VPC ( pending | available ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - vpc-id - The ID of the VPC. Filters []types.Filter // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -199,8 +175,8 @@ var _ DescribeVpcsAPIClient = (*Client)(nil) type DescribeVpcsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -293,9 +269,9 @@ type VpcAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpcAvailableWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpcAvailableWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -467,9 +443,9 @@ type VpcExistsWaiterOptions struct { // must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpcExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpcExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeVpnConnections.go b/service/ec2/api_op_DescribeVpnConnections.go index b183f071136..9c6461924e0 100644 --- a/service/ec2/api_op_DescribeVpnConnections.go +++ b/service/ec2/api_op_DescribeVpnConnections.go @@ -17,9 +17,8 @@ import ( ) // Describes one or more of your VPN connections. For more information, see Amazon -// Web Services Site-to-Site VPN -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// Web Services Site-to-Site VPN (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) DescribeVpnConnections(ctx context.Context, params *DescribeVpnConnectionsInput, optFns ...func(*Options)) (*DescribeVpnConnectionsOutput, error) { if params == nil { params = &DescribeVpnConnectionsInput{} @@ -40,53 +39,37 @@ type DescribeVpnConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. + // - customer-gateway-configuration - The configuration information for the + // customer gateway. + // - customer-gateway-id - The ID of a customer gateway associated with the VPN + // connection. + // - state - The state of the VPN connection ( pending | available | deleting | + // deleted ). + // - option.static-routes-only - Indicates whether the connection has static + // routes only. Used for devices that do not support Border Gateway Protocol (BGP). // - // * customer-gateway-configuration - The configuration - // information for the customer gateway. - // - // * customer-gateway-id - The ID of a - // customer gateway associated with the VPN connection. - // - // * state - The state of the - // VPN connection (pending | available | deleting | deleted). - // - // * - // option.static-routes-only - Indicates whether the connection has static routes - // only. Used for devices that do not support Border Gateway Protocol (BGP). - // - // * - // route.destination-cidr-block - The destination CIDR block. This corresponds to - // the subnet used in a customer data center. - // - // * bgp-asn - The BGP Autonomous - // System Number (ASN) associated with a BGP device. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. - // - // * type - The type of VPN - // connection. Currently the only supported type is ipsec.1. - // - // * vpn-connection-id - - // The ID of the VPN connection. - // - // * vpn-gateway-id - The ID of a virtual private - // gateway associated with the VPN connection. - // - // * transit-gateway-id - The ID of a - // transit gateway associated with the VPN connection. + // - route.destination-cidr-block - The destination CIDR block. This corresponds + // to the subnet used in a customer data center. + // - bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP + // device. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - type - The type of VPN connection. Currently the only supported type is + // ipsec.1 . + // - vpn-connection-id - The ID of the VPN connection. + // - vpn-gateway-id - The ID of a virtual private gateway associated with the VPN + // connection. + // - transit-gateway-id - The ID of a transit gateway associated with the VPN + // connection. Filters []types.Filter // One or more VPN connection IDs. Default: Describes your VPN connections. @@ -189,9 +172,10 @@ type VpnConnectionAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpnConnectionAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpnConnectionAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -231,9 +215,9 @@ func NewVpnConnectionAvailableWaiter(client DescribeVpnConnectionsAPIClient, opt } } -// Wait calls the waiter function for VpnConnectionAvailable waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for VpnConnectionAvailable waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *VpnConnectionAvailableWaiter) Wait(ctx context.Context, params *DescribeVpnConnectionsInput, maxWaitDur time.Duration, optFns ...func(*VpnConnectionAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -413,9 +397,10 @@ type VpnConnectionDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VpnConnectionDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VpnConnectionDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_DescribeVpnGateways.go b/service/ec2/api_op_DescribeVpnGateways.go index e284a64147a..0aacdbc8dd7 100644 --- a/service/ec2/api_op_DescribeVpnGateways.go +++ b/service/ec2/api_op_DescribeVpnGateways.go @@ -12,9 +12,8 @@ import ( ) // Describes one or more of your virtual private gateways. For more information, -// see Amazon Web Services Site-to-Site VPN -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// see Amazon Web Services Site-to-Site VPN (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) DescribeVpnGateways(ctx context.Context, params *DescribeVpnGatewaysInput, optFns ...func(*Options)) (*DescribeVpnGatewaysOutput, error) { if params == nil { params = &DescribeVpnGatewaysInput{} @@ -35,43 +34,29 @@ type DescribeVpnGatewaysInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * amazon-side-asn - The Autonomous System Number (ASN) for - // the Amazon side of the gateway. - // - // * attachment.state - The current state of the - // attachment between the gateway and the VPC (attaching | attached | detaching | - // detached). - // - // * attachment.vpc-id - The ID of an attached VPC. - // - // * - // availability-zone - The Availability Zone for the virtual private gateway (if - // applicable). - // - // * state - The state of the virtual private gateway (pending | - // available | deleting | deleted). - // - // * tag: - The key/value combination of a tag - // assigned to the resource. Use the tag key in the filter name and the tag value - // as the filter value. For example, to find all resources that have a tag with the - // key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA - // for the filter value. - // - // * tag-key - The key of a tag assigned to the resource. - // Use this filter to find all resources assigned a tag with a specific key, - // regardless of the tag value. - // - // * type - The type of virtual private gateway. - // Currently the only supported type is ipsec.1. - // - // * vpn-gateway-id - The ID of the - // virtual private gateway. + // - amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of + // the gateway. + // - attachment.state - The current state of the attachment between the gateway + // and the VPC ( attaching | attached | detaching | detached ). + // - attachment.vpc-id - The ID of an attached VPC. + // - availability-zone - The Availability Zone for the virtual private gateway + // (if applicable). + // - state - The state of the virtual private gateway ( pending | available | + // deleting | deleted ). + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. + // - type - The type of virtual private gateway. Currently the only supported + // type is ipsec.1 . + // - vpn-gateway-id - The ID of the virtual private gateway. Filters []types.Filter // One or more virtual private gateway IDs. Default: Describes all your virtual diff --git a/service/ec2/api_op_DetachClassicLinkVpc.go b/service/ec2/api_op_DetachClassicLinkVpc.go index 63d6cb60a8e..56627af92d7 100644 --- a/service/ec2/api_op_DetachClassicLinkVpc.go +++ b/service/ec2/api_op_DetachClassicLinkVpc.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Unlinks (detaches) a linked EC2-Classic -// instance from a VPC. After the instance has been unlinked, the VPC security -// groups are no longer associated with it. An instance is automatically unlinked -// from a VPC when it's stopped. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Unlinks (detaches) a linked +// EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC +// security groups are no longer associated with it. An instance is automatically +// unlinked from a VPC when it's stopped. func (c *Client) DetachClassicLinkVpc(ctx context.Context, params *DetachClassicLinkVpcInput, optFns ...func(*Options)) (*DetachClassicLinkVpcOutput, error) { if params == nil { params = &DetachClassicLinkVpcInput{} @@ -46,8 +45,8 @@ type DetachClassicLinkVpcInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachInternetGateway.go b/service/ec2/api_op_DetachInternetGateway.go index 1b297d66d5e..d48c49139a5 100644 --- a/service/ec2/api_op_DetachInternetGateway.go +++ b/service/ec2/api_op_DetachInternetGateway.go @@ -42,8 +42,8 @@ type DetachInternetGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachNetworkInterface.go b/service/ec2/api_op_DetachNetworkInterface.go index 227e93d4c2b..f63c4075fc3 100644 --- a/service/ec2/api_op_DetachNetworkInterface.go +++ b/service/ec2/api_op_DetachNetworkInterface.go @@ -36,26 +36,20 @@ type DetachNetworkInterfaceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specifies whether to force a detachment. - // - // * Use the Force parameter only as a - // last resort to detach a network interface from a failed instance. - // - // * If you use - // the Force parameter to detach a network interface, you might not be able to - // attach a different network interface to the same index on the instance without - // first stopping and starting the instance. - // - // * If you force the detachment of a - // network interface, the instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // might not get updated. This means that the attributes associated with the - // detached network interface might still be visible. The instance metadata will - // get updated when you stop and start the instance. + // - Use the Force parameter only as a last resort to detach a network interface + // from a failed instance. + // - If you use the Force parameter to detach a network interface, you might not + // be able to attach a different network interface to the same index on the + // instance without first stopping and starting the instance. + // - If you force the detachment of a network interface, the instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // might not get updated. This means that the attributes associated with the + // detached network interface might still be visible. The instance metadata will + // get updated when you stop and start the instance. Force *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go b/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go index 99ed304b420..d405681fc59 100644 --- a/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go @@ -41,14 +41,14 @@ type DetachVerifiedAccessTrustProviderInput struct { VerifiedAccessTrustProviderId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachVolume.go b/service/ec2/api_op_DetachVolume.go index 997a20e80c9..91eebd64040 100644 --- a/service/ec2/api_op_DetachVolume.go +++ b/service/ec2/api_op_DetachVolume.go @@ -21,8 +21,7 @@ import ( // instance is running. To detach the root volume, stop the instance first. When a // volume with an Amazon Web Services Marketplace product code is detached from an // instance, the product code is no longer associated with the instance. For more -// information, see Detach an Amazon EBS volume -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html) +// information, see Detach an Amazon EBS volume (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DetachVolume(ctx context.Context, params *DetachVolumeInput, optFns ...func(*Options)) (*DetachVolumeOutput, error) { if params == nil { @@ -51,8 +50,8 @@ type DetachVolumeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Forces detachment if the previous detachment attempt did not occur cleanly (for diff --git a/service/ec2/api_op_DetachVpnGateway.go b/service/ec2/api_op_DetachVpnGateway.go index 79732464957..077c76cb106 100644 --- a/service/ec2/api_op_DetachVpnGateway.go +++ b/service/ec2/api_op_DetachVpnGateway.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches a virtual private gateway from a VPC. You do this if you're planning to -// turn off the VPC and not use it anymore. You can confirm a virtual private +// Detaches a virtual private gateway from a VPC. You do this if you're planning +// to turn off the VPC and not use it anymore. You can confirm a virtual private // gateway has been completely detached from a VPC by describing the virtual // private gateway (any attachments to the virtual private gateway are also // described). You must wait for the attachment's state to switch to detached @@ -47,8 +47,8 @@ type DetachVpnGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableAddressTransfer.go b/service/ec2/api_op_DisableAddressTransfer.go index cd141a4314d..121732d3dc3 100644 --- a/service/ec2/api_op_DisableAddressTransfer.go +++ b/service/ec2/api_op_DisableAddressTransfer.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables Elastic IP address transfer. For more information, see Transfer Elastic -// IP addresses -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) +// Disables Elastic IP address transfer. For more information, see Transfer +// Elastic IP addresses (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) DisableAddressTransfer(ctx context.Context, params *DisableAddressTransferInput, optFns ...func(*Options)) (*DisableAddressTransferOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type DisableAddressTransferInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableAwsNetworkPerformanceMetricSubscription.go b/service/ec2/api_op_DisableAwsNetworkPerformanceMetricSubscription.go index 4b4657aeed5..179fc583f52 100644 --- a/service/ec2/api_op_DisableAwsNetworkPerformanceMetricSubscription.go +++ b/service/ec2/api_op_DisableAwsNetworkPerformanceMetricSubscription.go @@ -30,20 +30,20 @@ func (c *Client) DisableAwsNetworkPerformanceMetricSubscription(ctx context.Cont type DisableAwsNetworkPerformanceMetricSubscriptionInput struct { // The target Region or Availability Zone that the metric subscription is disabled - // for. For example, eu-north-1. + // for. For example, eu-north-1 . Destination *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The metric used for the disabled subscription. Metric types.MetricType // The source Region or Availability Zone that the metric subscription is disabled - // for. For example, us-east-1. + // for. For example, us-east-1 . Source *string // The statistic used for the disabled subscription. diff --git a/service/ec2/api_op_DisableEbsEncryptionByDefault.go b/service/ec2/api_op_DisableEbsEncryptionByDefault.go index 4cfb2dbf14e..52b1f4e889e 100644 --- a/service/ec2/api_op_DisableEbsEncryptionByDefault.go +++ b/service/ec2/api_op_DisableEbsEncryptionByDefault.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables EBS encryption by default for your account in the current Region. After -// you disable encryption by default, you can still create encrypted volumes by -// enabling encryption when you create each volume. Disabling encryption by default -// does not change the encryption status of your existing volumes. For more -// information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Disables EBS encryption by default for your account in the current Region. +// After you disable encryption by default, you can still create encrypted volumes +// by enabling encryption when you create each volume. Disabling encryption by +// default does not change the encryption status of your existing volumes. For more +// information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DisableEbsEncryptionByDefault(ctx context.Context, params *DisableEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*DisableEbsEncryptionByDefaultOutput, error) { if params == nil { params = &DisableEbsEncryptionByDefaultInput{} @@ -36,8 +35,8 @@ type DisableEbsEncryptionByDefaultInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableFastLaunch.go b/service/ec2/api_op_DisableFastLaunch.go index 66c39e172fc..94b75e2a9c2 100644 --- a/service/ec2/api_op_DisableFastLaunch.go +++ b/service/ec2/api_op_DisableFastLaunch.go @@ -42,8 +42,8 @@ type DisableFastLaunchInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Forces the image settings to turn off faster launching for your Windows AMI. @@ -70,12 +70,12 @@ type DisableFastLaunchOutput struct { // The owner of the Windows AMI for which faster launching was turned off. OwnerId *string - // The pre-provisioning resource type that must be cleaned after turning off faster - // launching for the Windows AMI. Supported values include: snapshot. + // The pre-provisioning resource type that must be cleaned after turning off + // faster launching for the Windows AMI. Supported values include: snapshot . ResourceType types.FastLaunchResourceType - // Parameters that were used for faster launching for the Windows AMI before faster - // launching was turned off. This informs the clean-up process. + // Parameters that were used for faster launching for the Windows AMI before + // faster launching was turned off. This informs the clean-up process. SnapshotConfiguration *types.FastLaunchSnapshotConfigurationResponse // The current state of faster launching for the specified Windows AMI. diff --git a/service/ec2/api_op_DisableFastSnapshotRestores.go b/service/ec2/api_op_DisableFastSnapshotRestores.go index bdd6faaf003..d0282a32546 100644 --- a/service/ec2/api_op_DisableFastSnapshotRestores.go +++ b/service/ec2/api_op_DisableFastSnapshotRestores.go @@ -30,20 +30,20 @@ func (c *Client) DisableFastSnapshotRestores(ctx context.Context, params *Disabl type DisableFastSnapshotRestoresInput struct { - // One or more Availability Zones. For example, us-east-2a. + // One or more Availability Zones. For example, us-east-2a . // // This member is required. AvailabilityZones []string - // The IDs of one or more snapshots. For example, snap-1234567890abcdef0. + // The IDs of one or more snapshots. For example, snap-1234567890abcdef0 . // // This member is required. SourceSnapshotIds []string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableImageDeprecation.go b/service/ec2/api_op_DisableImageDeprecation.go index b4908320980..719df1d9aa9 100644 --- a/service/ec2/api_op_DisableImageDeprecation.go +++ b/service/ec2/api_op_DisableImageDeprecation.go @@ -11,9 +11,8 @@ import ( ) // Cancels the deprecation of the specified AMI. For more information, see -// Deprecate an AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) in the -// Amazon EC2 User Guide. +// Deprecate an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) +// in the Amazon EC2 User Guide. func (c *Client) DisableImageDeprecation(ctx context.Context, params *DisableImageDeprecationInput, optFns ...func(*Options)) (*DisableImageDeprecationOutput, error) { if params == nil { params = &DisableImageDeprecationInput{} @@ -38,8 +37,8 @@ type DisableImageDeprecationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go b/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go index b2ebb09f5c2..650131deb9d 100644 --- a/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go +++ b/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go @@ -11,9 +11,8 @@ import ( ) // Disable the IPAM account. For more information, see Enable integration with -// Organizations -// (https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) in the -// Amazon VPC IPAM User Guide. +// Organizations (https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) DisableIpamOrganizationAdminAccount(ctx context.Context, params *DisableIpamOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableIpamOrganizationAdminAccountOutput, error) { if params == nil { params = &DisableIpamOrganizationAdminAccountInput{} @@ -38,8 +37,8 @@ type DisableIpamOrganizationAdminAccountInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableSerialConsoleAccess.go b/service/ec2/api_op_DisableSerialConsoleAccess.go index 648d98b81ad..a1d30a9c916 100644 --- a/service/ec2/api_op_DisableSerialConsoleAccess.go +++ b/service/ec2/api_op_DisableSerialConsoleAccess.go @@ -12,8 +12,7 @@ import ( // Disables access to the EC2 serial console of all instances for your account. By // default, access to the EC2 serial console is disabled for your account. For more -// information, see Manage account access to the EC2 serial console -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) +// information, see Manage account access to the EC2 serial console (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) // in the Amazon EC2 User Guide. func (c *Client) DisableSerialConsoleAccess(ctx context.Context, params *DisableSerialConsoleAccessInput, optFns ...func(*Options)) (*DisableSerialConsoleAccessOutput, error) { if params == nil { @@ -34,8 +33,8 @@ type DisableSerialConsoleAccessInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -43,9 +42,9 @@ type DisableSerialConsoleAccessInput struct { type DisableSerialConsoleAccessOutput struct { - // If true, access to the EC2 serial console of all instances is enabled for your - // account. If false, access to the EC2 serial console of all instances is disabled - // for your account. + // If true , access to the EC2 serial console of all instances is enabled for your + // account. If false , access to the EC2 serial console of all instances is + // disabled for your account. SerialConsoleAccessEnabled *bool // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go b/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go index dabd12748fe..611d71ca533 100644 --- a/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go +++ b/service/ec2/api_op_DisableTransitGatewayRouteTablePropagation.go @@ -37,8 +37,8 @@ type DisableTransitGatewayRouteTablePropagationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment. diff --git a/service/ec2/api_op_DisableVgwRoutePropagation.go b/service/ec2/api_op_DisableVgwRoutePropagation.go index 8c3720bdd70..3b548c1941d 100644 --- a/service/ec2/api_op_DisableVgwRoutePropagation.go +++ b/service/ec2/api_op_DisableVgwRoutePropagation.go @@ -42,8 +42,8 @@ type DisableVgwRoutePropagationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableVpcClassicLink.go b/service/ec2/api_op_DisableVpcClassicLink.go index 665350d7ce7..33651dc4110 100644 --- a/service/ec2/api_op_DisableVpcClassicLink.go +++ b/service/ec2/api_op_DisableVpcClassicLink.go @@ -13,9 +13,8 @@ import ( // Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that // has EC2-Classic instances linked to it. We are retiring EC2-Classic. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DisableVpcClassicLink(ctx context.Context, params *DisableVpcClassicLinkInput, optFns ...func(*Options)) (*DisableVpcClassicLinkOutput, error) { if params == nil { params = &DisableVpcClassicLinkInput{} @@ -40,8 +39,8 @@ type DisableVpcClassicLinkInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go b/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go index 30307c51c5e..3e2ec320efa 100644 --- a/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go @@ -12,9 +12,8 @@ import ( // Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve // to public IP addresses when addressed between a linked EC2-Classic instance and -// instances in the VPC to which it's linked. For more information, see ClassicLink -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in -// the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the +// instances in the VPC to which it's linked. For more information, see ClassicLink (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) +// in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the // request. We are retiring EC2-Classic. We recommend that you migrate from // EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a // VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in diff --git a/service/ec2/api_op_DisassociateAddress.go b/service/ec2/api_op_DisassociateAddress.go index fe9d5f5e4fa..404178d0600 100644 --- a/service/ec2/api_op_DisassociateAddress.go +++ b/service/ec2/api_op_DisassociateAddress.go @@ -12,14 +12,12 @@ import ( // Disassociates an Elastic IP address from the instance or network interface it's // associated with. An Elastic IP address is for use in either the EC2-Classic -// platform or in a VPC. For more information, see Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// platform or in a VPC. For more information, see Elastic IP Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. We are retiring EC2-Classic. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. If you -// perform the operation more than once, Amazon EC2 doesn't return an error. +// Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. +// If you perform the operation more than once, Amazon EC2 doesn't return an error. func (c *Client) DisassociateAddress(ctx context.Context, params *DisassociateAddressInput, optFns ...func(*Options)) (*DisassociateAddressOutput, error) { if params == nil { params = &DisassociateAddressInput{} @@ -42,8 +40,8 @@ type DisassociateAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // [EC2-Classic] The Elastic IP address. Required for EC2-Classic. diff --git a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go index 1a6c5a17e44..25778934046 100644 --- a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go @@ -12,18 +12,11 @@ import ( ) // Disassociates a target network from the specified Client VPN endpoint. When you -// disassociate the last target network from a Client VPN, the following -// happens: -// -// * The route that was automatically added for the VPC is deleted -// -// * All -// active client connections are terminated -// -// * New client connections are -// disallowed -// -// * The Client VPN endpoint's status changes to pending-associate +// disassociate the last target network from a Client VPN, the following happens: +// - The route that was automatically added for the VPC is deleted +// - All active client connections are terminated +// - New client connections are disallowed +// - The Client VPN endpoint's status changes to pending-associate func (c *Client) DisassociateClientVpnTargetNetwork(ctx context.Context, params *DisassociateClientVpnTargetNetworkInput, optFns ...func(*Options)) (*DisassociateClientVpnTargetNetworkOutput, error) { if params == nil { params = &DisassociateClientVpnTargetNetworkInput{} @@ -53,8 +46,8 @@ type DisassociateClientVpnTargetNetworkInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateEnclaveCertificateIamRole.go b/service/ec2/api_op_DisassociateEnclaveCertificateIamRole.go index b5697715bb7..9ed03fee52e 100644 --- a/service/ec2/api_op_DisassociateEnclaveCertificateIamRole.go +++ b/service/ec2/api_op_DisassociateEnclaveCertificateIamRole.go @@ -45,8 +45,8 @@ type DisassociateEnclaveCertificateIamRoleInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateInstanceEventWindow.go b/service/ec2/api_op_DisassociateInstanceEventWindow.go index 6399d7fbb58..6c937a13820 100644 --- a/service/ec2/api_op_DisassociateInstanceEventWindow.go +++ b/service/ec2/api_op_DisassociateInstanceEventWindow.go @@ -12,9 +12,8 @@ import ( ) // Disassociates one or more targets from an event window. For more information, -// see Define event windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// see Define event windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) DisassociateInstanceEventWindow(ctx context.Context, params *DisassociateInstanceEventWindowInput, optFns ...func(*Options)) (*DisassociateInstanceEventWindowOutput, error) { if params == nil { params = &DisassociateInstanceEventWindowInput{} @@ -44,8 +43,8 @@ type DisassociateInstanceEventWindowInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateIpamResourceDiscovery.go b/service/ec2/api_op_DisassociateIpamResourceDiscovery.go index 6a0e007bd6c..f42035e05bf 100644 --- a/service/ec2/api_op_DisassociateIpamResourceDiscovery.go +++ b/service/ec2/api_op_DisassociateIpamResourceDiscovery.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery -// is an IPAM component that enables IPAM to manage and monitor resources that -// belong to the owning account. +// Disassociates a resource discovery from an Amazon VPC IPAM. A resource +// discovery is an IPAM component that enables IPAM to manage and monitor resources +// that belong to the owning account. func (c *Client) DisassociateIpamResourceDiscovery(ctx context.Context, params *DisassociateIpamResourceDiscoveryInput, optFns ...func(*Options)) (*DisassociateIpamResourceDiscoveryOutput, error) { if params == nil { params = &DisassociateIpamResourceDiscoveryInput{} @@ -38,8 +38,8 @@ type DisassociateIpamResourceDiscoveryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateNatGatewayAddress.go b/service/ec2/api_op_DisassociateNatGatewayAddress.go index 53a92cbbef3..227ef91448a 100644 --- a/service/ec2/api_op_DisassociateNatGatewayAddress.go +++ b/service/ec2/api_op_DisassociateNatGatewayAddress.go @@ -13,8 +13,7 @@ import ( // Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. // You cannot disassociate your primary EIP. For more information, see Edit -// secondary IP address associations -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary) +// secondary IP address associations (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary) // in the Amazon Virtual Private Cloud User Guide. While disassociating is in // progress, you cannot associate/disassociate additional EIPs while the // connections are being drained. You are, however, allowed to delete the NAT @@ -52,12 +51,12 @@ type DisassociateNatGatewayAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The maximum amount of time to wait (in seconds) before forcibly releasing the IP - // addresses if connections are still in progress. Default value is 350 seconds. + // The maximum amount of time to wait (in seconds) before forcibly releasing the + // IP addresses if connections are still in progress. Default value is 350 seconds. MaxDrainDurationSeconds *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateRouteTable.go b/service/ec2/api_op_DisassociateRouteTable.go index 06739ce34e4..434a8b74b69 100644 --- a/service/ec2/api_op_DisassociateRouteTable.go +++ b/service/ec2/api_op_DisassociateRouteTable.go @@ -13,9 +13,8 @@ import ( // Disassociates a subnet or gateway from a route table. After you perform this // action, the subnet no longer uses the routes in the route table. Instead, it // uses the routes in the VPC's main route table. For more information about route -// tables, see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// tables, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) DisassociateRouteTable(ctx context.Context, params *DisassociateRouteTableInput, optFns ...func(*Options)) (*DisassociateRouteTableOutput, error) { if params == nil { params = &DisassociateRouteTableInput{} @@ -41,8 +40,8 @@ type DisassociateRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go b/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go index e602f2720e4..454b9e272b8 100644 --- a/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_DisassociateTransitGatewayMulticastDomain.go @@ -46,8 +46,8 @@ type DisassociateTransitGatewayMulticastDomainInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateTransitGatewayPolicyTable.go b/service/ec2/api_op_DisassociateTransitGatewayPolicyTable.go index 206965f474d..7a536db0494 100644 --- a/service/ec2/api_op_DisassociateTransitGatewayPolicyTable.go +++ b/service/ec2/api_op_DisassociateTransitGatewayPolicyTable.go @@ -41,8 +41,8 @@ type DisassociateTransitGatewayPolicyTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go b/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go index 77a2b08dbeb..98b85fb9bef 100644 --- a/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go +++ b/service/ec2/api_op_DisassociateTransitGatewayRouteTable.go @@ -41,8 +41,8 @@ type DisassociateTransitGatewayRouteTableInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DisassociateTrunkInterface.go b/service/ec2/api_op_DisassociateTrunkInterface.go index 199cce8be78..bfdebc333c3 100644 --- a/service/ec2/api_op_DisassociateTrunkInterface.go +++ b/service/ec2/api_op_DisassociateTrunkInterface.go @@ -37,14 +37,14 @@ type DisassociateTrunkInterfaceInput struct { AssociationId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -53,8 +53,8 @@ type DisassociateTrunkInterfaceInput struct { type DisassociateTrunkInterfaceOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // Returns true if the request succeeds; otherwise, it returns an error. diff --git a/service/ec2/api_op_DisassociateVpcCidrBlock.go b/service/ec2/api_op_DisassociateVpcCidrBlock.go index 581a48d8c44..dfb9028485f 100644 --- a/service/ec2/api_op_DisassociateVpcCidrBlock.go +++ b/service/ec2/api_op_DisassociateVpcCidrBlock.go @@ -12,11 +12,10 @@ import ( ) // Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must -// specify its association ID. You can get the association ID by using -// DescribeVpcs. You must detach or delete all gateways and resources that are -// associated with the CIDR block before you can disassociate it. You cannot -// disassociate the CIDR block with which you originally created the VPC (the -// primary CIDR block). +// specify its association ID. You can get the association ID by using DescribeVpcs +// . You must detach or delete all gateways and resources that are associated with +// the CIDR block before you can disassociate it. You cannot disassociate the CIDR +// block with which you originally created the VPC (the primary CIDR block). func (c *Client) DisassociateVpcCidrBlock(ctx context.Context, params *DisassociateVpcCidrBlockInput, optFns ...func(*Options)) (*DisassociateVpcCidrBlockOutput, error) { if params == nil { params = &DisassociateVpcCidrBlockInput{} diff --git a/service/ec2/api_op_EnableAddressTransfer.go b/service/ec2/api_op_EnableAddressTransfer.go index 74e92163e88..676e9f4474c 100644 --- a/service/ec2/api_op_EnableAddressTransfer.go +++ b/service/ec2/api_op_EnableAddressTransfer.go @@ -12,8 +12,7 @@ import ( ) // Enables Elastic IP address transfer. For more information, see Transfer Elastic -// IP addresses -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) +// IP addresses (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) // in the Amazon Virtual Private Cloud User Guide. func (c *Client) EnableAddressTransfer(ctx context.Context, params *EnableAddressTransferInput, optFns ...func(*Options)) (*EnableAddressTransferOutput, error) { if params == nil { @@ -44,8 +43,8 @@ type EnableAddressTransferInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableAwsNetworkPerformanceMetricSubscription.go b/service/ec2/api_op_EnableAwsNetworkPerformanceMetricSubscription.go index 48bc386a58e..4940e02d030 100644 --- a/service/ec2/api_op_EnableAwsNetworkPerformanceMetricSubscription.go +++ b/service/ec2/api_op_EnableAwsNetworkPerformanceMetricSubscription.go @@ -30,20 +30,20 @@ func (c *Client) EnableAwsNetworkPerformanceMetricSubscription(ctx context.Conte type EnableAwsNetworkPerformanceMetricSubscriptionInput struct { // The target Region or Availability Zone that the metric subscription is enabled - // for. For example, eu-west-1. + // for. For example, eu-west-1 . Destination *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The metric used for the enabled subscription. Metric types.MetricType // The source Region or Availability Zone that the metric subscription is enabled - // for. For example, us-east-1. + // for. For example, us-east-1 . Source *string // The statistic used for the enabled subscription. diff --git a/service/ec2/api_op_EnableEbsEncryptionByDefault.go b/service/ec2/api_op_EnableEbsEncryptionByDefault.go index 0edf76bf52b..f82755eb246 100644 --- a/service/ec2/api_op_EnableEbsEncryptionByDefault.go +++ b/service/ec2/api_op_EnableEbsEncryptionByDefault.go @@ -13,15 +13,14 @@ import ( // Enables EBS encryption by default for your account in the current Region. After // you enable encryption by default, the EBS volumes that you create are always // encrypted, either using the default KMS key or the KMS key that you specified -// when you created each volume. For more information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. You can specify the default KMS key for -// encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. -// Enabling encryption by default has no effect on the encryption status of your -// existing volumes. After you enable encryption by default, you can no longer -// launch instances using instance types that do not support encryption. For more -// information, see Supported instance types -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). +// when you created each volume. For more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. You can specify the default KMS +// key for encryption by default using ModifyEbsDefaultKmsKeyId or +// ResetEbsDefaultKmsKeyId . Enabling encryption by default has no effect on the +// encryption status of your existing volumes. After you enable encryption by +// default, you can no longer launch instances using instance types that do not +// support encryption. For more information, see Supported instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) +// . func (c *Client) EnableEbsEncryptionByDefault(ctx context.Context, params *EnableEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*EnableEbsEncryptionByDefaultOutput, error) { if params == nil { params = &EnableEbsEncryptionByDefaultInput{} @@ -41,8 +40,8 @@ type EnableEbsEncryptionByDefaultInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableFastLaunch.go b/service/ec2/api_op_EnableFastLaunch.go index 067ae00bfc0..94b07983ce3 100644 --- a/service/ec2/api_op_EnableFastLaunch.go +++ b/service/ec2/api_op_EnableFastLaunch.go @@ -43,13 +43,13 @@ type EnableFastLaunchInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The launch template to use when launching Windows instances from pre-provisioned - // snapshots. Launch template parameters can include either the name or ID of the - // launch template, but not both. + // The launch template to use when launching Windows instances from + // pre-provisioned snapshots. Launch template parameters can include either the + // name or ID of the launch template, but not both. LaunchTemplate *types.FastLaunchLaunchTemplateSpecificationRequest // The maximum number of instances that Amazon EC2 can launch at the same time to @@ -58,12 +58,12 @@ type EnableFastLaunchInput struct { MaxParallelLaunches *int32 // The type of resource to use for pre-provisioning the Windows AMI for faster - // launching. Supported values include: snapshot, which is the default value. + // launching. Supported values include: snapshot , which is the default value. ResourceType *string - // Configuration settings for creating and managing the snapshots that are used for - // pre-provisioning the Windows AMI for faster launching. The associated - // ResourceType must be snapshot. + // Configuration settings for creating and managing the snapshots that are used + // for pre-provisioning the Windows AMI for faster launching. The associated + // ResourceType must be snapshot . SnapshotConfiguration *types.FastLaunchSnapshotConfigurationRequest noSmithyDocumentSerde @@ -90,9 +90,9 @@ type EnableFastLaunchOutput struct { // faster launching. ResourceType types.FastLaunchResourceType - // Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses - // for faster launches from the Windows AMI. This property is returned when the - // associated resourceType is snapshot. + // Settings to create and manage the pre-provisioned snapshots that Amazon EC2 + // uses for faster launches from the Windows AMI. This property is returned when + // the associated resourceType is snapshot . SnapshotConfiguration *types.FastLaunchSnapshotConfigurationResponse // The current state of faster launching for the specified Windows AMI. diff --git a/service/ec2/api_op_EnableFastSnapshotRestores.go b/service/ec2/api_op_EnableFastSnapshotRestores.go index b1bd03a7e61..8cc5d2e6b76 100644 --- a/service/ec2/api_op_EnableFastSnapshotRestores.go +++ b/service/ec2/api_op_EnableFastSnapshotRestores.go @@ -14,10 +14,9 @@ import ( // Enables fast snapshot restores for the specified snapshots in the specified // Availability Zones. You get the full benefit of fast snapshot restores after // they enter the enabled state. To get the current state of fast snapshot -// restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, -// use DisableFastSnapshotRestores. For more information, see Amazon EBS fast -// snapshot restore -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-fast-snapshot-restore.html) +// restores, use DescribeFastSnapshotRestores . To disable fast snapshot restores, +// use DisableFastSnapshotRestores . For more information, see Amazon EBS fast +// snapshot restore (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-fast-snapshot-restore.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) EnableFastSnapshotRestores(ctx context.Context, params *EnableFastSnapshotRestoresInput, optFns ...func(*Options)) (*EnableFastSnapshotRestoresOutput, error) { if params == nil { @@ -36,12 +35,12 @@ func (c *Client) EnableFastSnapshotRestores(ctx context.Context, params *EnableF type EnableFastSnapshotRestoresInput struct { - // One or more Availability Zones. For example, us-east-2a. + // One or more Availability Zones. For example, us-east-2a . // // This member is required. AvailabilityZones []string - // The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can + // The IDs of one or more snapshots. For example, snap-1234567890abcdef0 . You can // specify a snapshot that was shared with you from another Amazon Web Services // account. // @@ -50,8 +49,8 @@ type EnableFastSnapshotRestoresInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableImageDeprecation.go b/service/ec2/api_op_EnableImageDeprecation.go index 8ca887367de..99a91d63af6 100644 --- a/service/ec2/api_op_EnableImageDeprecation.go +++ b/service/ec2/api_op_EnableImageDeprecation.go @@ -12,9 +12,8 @@ import ( ) // Enables deprecation of the specified AMI at the specified date and time. For -// more information, see Deprecate an AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) in the -// Amazon EC2 User Guide. +// more information, see Deprecate an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) +// in the Amazon EC2 User Guide. func (c *Client) EnableImageDeprecation(ctx context.Context, params *EnableImageDeprecationInput, optFns ...func(*Options)) (*EnableImageDeprecationOutput, error) { if params == nil { params = &EnableImageDeprecationInput{} @@ -48,8 +47,8 @@ type EnableImageDeprecationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go b/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go index 2ce00b440dd..f10d8f46f60 100644 --- a/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go +++ b/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go @@ -12,9 +12,8 @@ import ( // Enable an Organizations member account as the IPAM admin account. You cannot // select the Organizations management account as the IPAM admin account. For more -// information, see Enable integration with Organizations -// (https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) in the -// Amazon VPC IPAM User Guide. +// information, see Enable integration with Organizations (https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) EnableIpamOrganizationAdminAccount(ctx context.Context, params *EnableIpamOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableIpamOrganizationAdminAccountOutput, error) { if params == nil { params = &EnableIpamOrganizationAdminAccountInput{} @@ -39,8 +38,8 @@ type EnableIpamOrganizationAdminAccountInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go b/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go index f099349ef9b..8fd7912cbe0 100644 --- a/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go +++ b/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go @@ -34,8 +34,8 @@ type EnableReachabilityAnalyzerOrganizationSharingInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableSerialConsoleAccess.go b/service/ec2/api_op_EnableSerialConsoleAccess.go index 7079ad3a164..32661267061 100644 --- a/service/ec2/api_op_EnableSerialConsoleAccess.go +++ b/service/ec2/api_op_EnableSerialConsoleAccess.go @@ -12,8 +12,7 @@ import ( // Enables access to the EC2 serial console of all instances for your account. By // default, access to the EC2 serial console is disabled for your account. For more -// information, see Manage account access to the EC2 serial console -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) +// information, see Manage account access to the EC2 serial console (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) // in the Amazon EC2 User Guide. func (c *Client) EnableSerialConsoleAccess(ctx context.Context, params *EnableSerialConsoleAccessInput, optFns ...func(*Options)) (*EnableSerialConsoleAccessOutput, error) { if params == nil { @@ -34,8 +33,8 @@ type EnableSerialConsoleAccessInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -43,9 +42,9 @@ type EnableSerialConsoleAccessInput struct { type EnableSerialConsoleAccessOutput struct { - // If true, access to the EC2 serial console of all instances is enabled for your - // account. If false, access to the EC2 serial console of all instances is disabled - // for your account. + // If true , access to the EC2 serial console of all instances is enabled for your + // account. If false , access to the EC2 serial console of all instances is + // disabled for your account. SerialConsoleAccessEnabled *bool // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go b/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go index 95e32073721..155e68819ad 100644 --- a/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go +++ b/service/ec2/api_op_EnableTransitGatewayRouteTablePropagation.go @@ -37,8 +37,8 @@ type EnableTransitGatewayRouteTablePropagationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment. diff --git a/service/ec2/api_op_EnableVgwRoutePropagation.go b/service/ec2/api_op_EnableVgwRoutePropagation.go index 94112843362..10742fc4fb2 100644 --- a/service/ec2/api_op_EnableVgwRoutePropagation.go +++ b/service/ec2/api_op_EnableVgwRoutePropagation.go @@ -45,8 +45,8 @@ type EnableVgwRoutePropagationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableVolumeIO.go b/service/ec2/api_op_EnableVolumeIO.go index 9c752b9def6..561376fb971 100644 --- a/service/ec2/api_op_EnableVolumeIO.go +++ b/service/ec2/api_op_EnableVolumeIO.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables I/O operations for a volume that had I/O operations disabled because the -// data on the volume was potentially inconsistent. +// Enables I/O operations for a volume that had I/O operations disabled because +// the data on the volume was potentially inconsistent. func (c *Client) EnableVolumeIO(ctx context.Context, params *EnableVolumeIOInput, optFns ...func(*Options)) (*EnableVolumeIOOutput, error) { if params == nil { params = &EnableVolumeIOInput{} @@ -36,8 +36,8 @@ type EnableVolumeIOInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableVpcClassicLink.go b/service/ec2/api_op_EnableVpcClassicLink.go index c64b631213e..0f6fe7dba43 100644 --- a/service/ec2/api_op_EnableVpcClassicLink.go +++ b/service/ec2/api_op_EnableVpcClassicLink.go @@ -10,18 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Enables a VPC for ClassicLink. You can -// then link EC2-Classic instances to your ClassicLink-enabled VPC to allow +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Enables a VPC for ClassicLink. +// You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow // communication over private IP addresses. You cannot enable your VPC for // ClassicLink if any of your VPC route tables have existing routes for address // ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs // in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see -// ClassicLink -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in -// the Amazon Elastic Compute Cloud User Guide. +// ClassicLink (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) EnableVpcClassicLink(ctx context.Context, params *EnableVpcClassicLinkInput, optFns ...func(*Options)) (*EnableVpcClassicLinkOutput, error) { if params == nil { params = &EnableVpcClassicLinkInput{} @@ -46,8 +44,8 @@ type EnableVpcClassicLinkInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go b/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go index c9746bb20fb..a895b185a1a 100644 --- a/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go @@ -10,17 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Enables a VPC to support DNS hostname -// resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic -// instance resolves to its private IP address when addressed from an instance in -// the VPC to which it's linked. Similarly, the DNS hostname of an instance in a -// VPC resolves to its private IP address when addressed from a linked EC2-Classic -// instance. For more information, see ClassicLink -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in -// the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Enables a VPC to support DNS +// hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked +// EC2-Classic instance resolves to its private IP address when addressed from an +// instance in the VPC to which it's linked. Similarly, the DNS hostname of an +// instance in a VPC resolves to its private IP address when addressed from a +// linked EC2-Classic instance. For more information, see ClassicLink (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) +// in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the // request. func (c *Client) EnableVpcClassicLinkDnsSupport(ctx context.Context, params *EnableVpcClassicLinkDnsSupportInput, optFns ...func(*Options)) (*EnableVpcClassicLinkDnsSupportOutput, error) { if params == nil { diff --git a/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go b/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go index e86f765fa4a..70f4b8d160f 100644 --- a/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go +++ b/service/ec2/api_op_ExportClientVpnClientCertificateRevocationList.go @@ -37,8 +37,8 @@ type ExportClientVpnClientCertificateRevocationListInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ExportClientVpnClientConfiguration.go b/service/ec2/api_op_ExportClientVpnClientConfiguration.go index 061ab32cc44..113d2a8b598 100644 --- a/service/ec2/api_op_ExportClientVpnClientConfiguration.go +++ b/service/ec2/api_op_ExportClientVpnClientConfiguration.go @@ -38,8 +38,8 @@ type ExportClientVpnClientConfigurationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ExportImage.go b/service/ec2/api_op_ExportImage.go index d49bf8c91c8..92e8a0477ef 100644 --- a/service/ec2/api_op_ExportImage.go +++ b/service/ec2/api_op_ExportImage.go @@ -13,9 +13,8 @@ import ( ) // Exports an Amazon Machine Image (AMI) to a VM file. For more information, see -// Exporting a VM directly from an Amazon Machine Image (AMI) -// (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html) in -// the VM Import/Export User Guide. +// Exporting a VM directly from an Amazon Machine Image (AMI) (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html) +// in the VM Import/Export User Guide. func (c *Client) ExportImage(ctx context.Context, params *ExportImageInput, optFns ...func(*Options)) (*ExportImageOutput, error) { if params == nil { params = &ExportImageInput{} @@ -57,13 +56,13 @@ type ExportImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The name of the role that grants VM Import/Export permission to export images to - // your Amazon S3 bucket. If this parameter is not specified, the default role is - // named 'vmimport'. + // The name of the role that grants VM Import/Export permission to export images + // to your Amazon S3 bucket. If this parameter is not specified, the default role + // is named 'vmimport'. RoleName *string // The tags to apply to the export image task during creation. @@ -89,15 +88,15 @@ type ExportImageOutput struct { // The percent complete of the export image task. Progress *string - // The name of the role that grants VM Import/Export permission to export images to - // your Amazon S3 bucket. + // The name of the role that grants VM Import/Export permission to export images + // to your Amazon S3 bucket. RoleName *string // Information about the destination Amazon S3 bucket. S3ExportLocation *types.ExportTaskS3Location - // The status of the export image task. The possible values are active, completed, - // deleting, and deleted. + // The status of the export image task. The possible values are active , completed + // , deleting , and deleted . Status *string // The status message for the export image task. diff --git a/service/ec2/api_op_ExportTransitGatewayRoutes.go b/service/ec2/api_op_ExportTransitGatewayRoutes.go index b411b593b82..06e22827e82 100644 --- a/service/ec2/api_op_ExportTransitGatewayRoutes.go +++ b/service/ec2/api_op_ExportTransitGatewayRoutes.go @@ -14,8 +14,7 @@ import ( // Exports routes from the specified transit gateway route table to the specified // S3 bucket. By default, all routes are exported. Alternatively, you can filter by // CIDR range. The routes are saved to the specified bucket in a JSON file. For -// more information, see Export Route Tables to Amazon S3 -// (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables) +// more information, see Export Route Tables to Amazon S3 (https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables) // in Transit Gateways. func (c *Client) ExportTransitGatewayRoutes(ctx context.Context, params *ExportTransitGatewayRoutesInput, optFns ...func(*Options)) (*ExportTransitGatewayRoutesOutput, error) { if params == nil { @@ -46,40 +45,26 @@ type ExportTransitGatewayRoutesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * - // attachment.transit-gateway-attachment-id - The id of the transit gateway - // attachment. - // - // * attachment.resource-id - The resource id of the transit gateway - // attachment. - // - // * route-search.exact-match - The exact match of the specified - // filter. - // - // * route-search.longest-prefix-match - The longest prefix that matches - // the route. - // - // * route-search.subnet-of-match - The routes with a subnet that match - // the specified CIDR filter. - // - // * route-search.supernet-of-match - The routes with a - // CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and - // 10.0.1.0/31 routes in your route table and you specify supernet-of-match as - // 10.0.1.0/30, then the result returns 10.0.1.0/29. - // - // * state - The state of the - // route (active | blackhole). - // - // * transit-gateway-route-destination-cidr-block - - // The CIDR range. - // - // * type - The type of route (propagated | static). + // - attachment.transit-gateway-attachment-id - The id of the transit gateway + // attachment. + // - attachment.resource-id - The resource id of the transit gateway attachment. + // - route-search.exact-match - The exact match of the specified filter. + // - route-search.longest-prefix-match - The longest prefix that matches the + // route. + // - route-search.subnet-of-match - The routes with a subnet that match the + // specified CIDR filter. + // - route-search.supernet-of-match - The routes with a CIDR that encompass the + // CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your + // route table and you specify supernet-of-match as 10.0.1.0/30, then the result + // returns 10.0.1.0/29. + // - state - The state of the route ( active | blackhole ). + // - transit-gateway-route-destination-cidr-block - The CIDR range. + // - type - The type of route ( propagated | static ). Filters []types.Filter noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetAssociatedEnclaveCertificateIamRoles.go b/service/ec2/api_op_GetAssociatedEnclaveCertificateIamRoles.go index 1f26fcc536a..b767e2dbfbd 100644 --- a/service/ec2/api_op_GetAssociatedEnclaveCertificateIamRoles.go +++ b/service/ec2/api_op_GetAssociatedEnclaveCertificateIamRoles.go @@ -41,8 +41,8 @@ type GetAssociatedEnclaveCertificateIamRolesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go b/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go index 061477b6e33..e07fd33f0af 100644 --- a/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go +++ b/service/ec2/api_op_GetAssociatedIpv6PoolCidrs.go @@ -38,8 +38,8 @@ type GetAssociatedIpv6PoolCidrsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetAwsNetworkPerformanceData.go b/service/ec2/api_op_GetAwsNetworkPerformanceData.go index 5ee30192cae..3dd9c0af173 100644 --- a/service/ec2/api_op_GetAwsNetworkPerformanceData.go +++ b/service/ec2/api_op_GetAwsNetworkPerformanceData.go @@ -36,12 +36,12 @@ type GetAwsNetworkPerformanceDataInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The ending time for the performance data request. The end time must be formatted - // as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z. + // The ending time for the performance data request. The end time must be + // formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z . EndTime *time.Time // The maximum number of results to return with a single call. To retrieve the @@ -52,7 +52,7 @@ type GetAwsNetworkPerformanceDataInput struct { NextToken *string // The starting time for the performance data request. The starting time must be - // formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z. + // formatted as yyyy-mm-ddThh:mm:ss . For example, 2022-06-10T12:00:00.000Z . StartTime *time.Time noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetCapacityReservationUsage.go b/service/ec2/api_op_GetCapacityReservationUsage.go index 0b2105abd64..96d4fefc254 100644 --- a/service/ec2/api_op_GetCapacityReservationUsage.go +++ b/service/ec2/api_op_GetCapacityReservationUsage.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets usage information about a Capacity Reservation. If the Capacity Reservation -// is shared, it shows usage information for the Capacity Reservation owner and -// each Amazon Web Services account that is currently using the shared capacity. If -// the Capacity Reservation is not shared, it shows only the Capacity Reservation -// owner's usage. +// Gets usage information about a Capacity Reservation. If the Capacity +// Reservation is shared, it shows usage information for the Capacity Reservation +// owner and each Amazon Web Services account that is currently using the shared +// capacity. If the Capacity Reservation is not shared, it shows only the Capacity +// Reservation owner's usage. func (c *Client) GetCapacityReservationUsage(ctx context.Context, params *GetCapacityReservationUsageInput, optFns ...func(*Options)) (*GetCapacityReservationUsageOutput, error) { if params == nil { params = &GetCapacityReservationUsageInput{} @@ -40,8 +40,8 @@ type GetCapacityReservationUsageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return for the request in a single page. The @@ -78,25 +78,18 @@ type GetCapacityReservationUsageOutput struct { // The current state of the Capacity Reservation. A Capacity Reservation can be in // one of the following states: - // - // * active - The Capacity Reservation is active and - // the capacity is available for your use. - // - // * expired - The Capacity Reservation - // expired automatically at the date and time specified in your request. The - // reserved capacity is no longer available for your use. - // - // * cancelled - The - // Capacity Reservation was cancelled. The reserved capacity is no longer available - // for your use. - // - // * pending - The Capacity Reservation request was successful but - // the capacity provisioning is still pending. - // - // * failed - The Capacity Reservation - // request has failed. A request might fail due to invalid request parameters, - // capacity constraints, or instance limit constraints. Failed requests are - // retained for 60 minutes. + // - active - The Capacity Reservation is active and the capacity is available + // for your use. + // - expired - The Capacity Reservation expired automatically at the date and + // time specified in your request. The reserved capacity is no longer available for + // your use. + // - cancelled - The Capacity Reservation was cancelled. The reserved capacity is + // no longer available for your use. + // - pending - The Capacity Reservation request was successful but the capacity + // provisioning is still pending. + // - failed - The Capacity Reservation request has failed. A request might fail + // due to invalid request parameters, capacity constraints, or instance limit + // constraints. Failed requests are retained for 60 minutes. State types.CapacityReservationState // The number of instances for which the Capacity Reservation reserves capacity. diff --git a/service/ec2/api_op_GetCoipPoolUsage.go b/service/ec2/api_op_GetCoipPoolUsage.go index 37c57ead3f4..676e102f6ff 100644 --- a/service/ec2/api_op_GetCoipPoolUsage.go +++ b/service/ec2/api_op_GetCoipPoolUsage.go @@ -36,24 +36,17 @@ type GetCoipPoolUsageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * coip-address-usage.allocation-id - The allocation ID of - // the address. - // - // * coip-address-usage.aws-account-id - The ID of the Amazon Web - // Services account that is using the customer-owned IP address. - // - // * - // coip-address-usage.aws-service - The Amazon Web Services service that is using - // the customer-owned IP address. - // - // * coip-address-usage.co-ip - The customer-owned - // IP address. + // - coip-address-usage.allocation-id - The allocation ID of the address. + // - coip-address-usage.aws-account-id - The ID of the Amazon Web Services + // account that is using the customer-owned IP address. + // - coip-address-usage.aws-service - The Amazon Web Services service that is + // using the customer-owned IP address. + // - coip-address-usage.co-ip - The customer-owned IP address. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetConsoleOutput.go b/service/ec2/api_op_GetConsoleOutput.go index de234a68b9d..ced2e29cd8d 100644 --- a/service/ec2/api_op_GetConsoleOutput.go +++ b/service/ec2/api_op_GetConsoleOutput.go @@ -21,8 +21,7 @@ import ( // the most recent 64 KB of console output is available. You can optionally // retrieve the latest serial console output at any time during the instance // lifecycle. This option is supported on instance types that use the Nitro -// hypervisor. For more information, see Instance console output -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) +// hypervisor. For more information, see Instance console output (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) // in the Amazon EC2 User Guide. func (c *Client) GetConsoleOutput(ctx context.Context, params *GetConsoleOutputInput, optFns ...func(*Options)) (*GetConsoleOutputOutput, error) { if params == nil { @@ -48,12 +47,12 @@ type GetConsoleOutputInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // When enabled, retrieves the latest console output for the instance. Default: - // disabled (false) + // disabled ( false ) Latest *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetConsoleScreenshot.go b/service/ec2/api_op_GetConsoleScreenshot.go index 8dda68eed7d..09ed150495a 100644 --- a/service/ec2/api_op_GetConsoleScreenshot.go +++ b/service/ec2/api_op_GetConsoleScreenshot.go @@ -36,11 +36,11 @@ type GetConsoleScreenshotInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // When set to true, acts as keystroke input and wakes up an instance that's in + // When set to true , acts as keystroke input and wakes up an instance that's in // standby or "sleep" mode. WakeUp *bool diff --git a/service/ec2/api_op_GetDefaultCreditSpecification.go b/service/ec2/api_op_GetDefaultCreditSpecification.go index 438d7d01d95..ab1f4d2a61d 100644 --- a/service/ec2/api_op_GetDefaultCreditSpecification.go +++ b/service/ec2/api_op_GetDefaultCreditSpecification.go @@ -12,8 +12,7 @@ import ( ) // Describes the default credit option for CPU usage of a burstable performance -// instance family. For more information, see Burstable performance instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) +// instance family. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. func (c *Client) GetDefaultCreditSpecification(ctx context.Context, params *GetDefaultCreditSpecificationInput, optFns ...func(*Options)) (*GetDefaultCreditSpecificationOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type GetDefaultCreditSpecificationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetEbsDefaultKmsKeyId.go b/service/ec2/api_op_GetEbsDefaultKmsKeyId.go index 775ea24ab63..b3a8b343837 100644 --- a/service/ec2/api_op_GetEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_GetEbsDefaultKmsKeyId.go @@ -12,10 +12,9 @@ import ( // Describes the default KMS key for EBS encryption by default for your account in // this Region. You can change the default KMS key for encryption by default using -// ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. For more information, see -// Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId . For more information, see +// Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) GetEbsDefaultKmsKeyId(ctx context.Context, params *GetEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*GetEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &GetEbsDefaultKmsKeyIdInput{} @@ -35,8 +34,8 @@ type GetEbsDefaultKmsKeyIdInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetEbsEncryptionByDefault.go b/service/ec2/api_op_GetEbsEncryptionByDefault.go index 6e4499eb011..0f080608b78 100644 --- a/service/ec2/api_op_GetEbsEncryptionByDefault.go +++ b/service/ec2/api_op_GetEbsEncryptionByDefault.go @@ -11,9 +11,8 @@ import ( ) // Describes whether EBS encryption by default is enabled for your account in the -// current Region. For more information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// current Region. For more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) GetEbsEncryptionByDefault(ctx context.Context, params *GetEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*GetEbsEncryptionByDefaultOutput, error) { if params == nil { params = &GetEbsEncryptionByDefaultInput{} @@ -33,8 +32,8 @@ type GetEbsEncryptionByDefaultInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go b/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go index 19c6225f962..b45914b2ce8 100644 --- a/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go +++ b/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go @@ -15,19 +15,12 @@ import ( // integration of VPC flow logs with Amazon Athena. This make it easier for you to // query and gain insights from VPC flow logs data. Based on the information that // you provide, we configure resources in the template to do the following: -// -// * -// Create a table in Athena that maps fields to a custom log format -// -// * Create a -// Lambda function that updates the table with new partitions on a daily, weekly, -// or monthly basis -// -// * Create a table partitioned between two timestamps in the -// past -// -// * Create a set of named queries in Athena that you can use to get started -// quickly +// - Create a table in Athena that maps fields to a custom log format +// - Create a Lambda function that updates the table with new partitions on a +// daily, weekly, or monthly basis +// - Create a table partitioned between two timestamps in the past +// - Create a set of named queries in Athena that you can use to get started +// quickly func (c *Client) GetFlowLogsIntegrationTemplate(ctx context.Context, params *GetFlowLogsIntegrationTemplateInput, optFns ...func(*Options)) (*GetFlowLogsIntegrationTemplateOutput, error) { if params == nil { params = &GetFlowLogsIntegrationTemplateInput{} @@ -63,8 +56,8 @@ type GetFlowLogsIntegrationTemplateInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetGroupsForCapacityReservation.go b/service/ec2/api_op_GetGroupsForCapacityReservation.go index 321abfdfa79..930ee3e9ec1 100644 --- a/service/ec2/api_op_GetGroupsForCapacityReservation.go +++ b/service/ec2/api_op_GetGroupsForCapacityReservation.go @@ -39,8 +39,8 @@ type GetGroupsForCapacityReservationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return for the request in a single page. The @@ -57,8 +57,8 @@ type GetGroupsForCapacityReservationInput struct { type GetGroupsForCapacityReservationOutput struct { - // Information about the resource groups to which the Capacity Reservation has been - // added. + // Information about the resource groups to which the Capacity Reservation has + // been added. CapacityReservationGroups []types.CapacityReservationGroup // The token to use to retrieve the next page of results. This value is null when diff --git a/service/ec2/api_op_GetHostReservationPurchasePreview.go b/service/ec2/api_op_GetHostReservationPurchasePreview.go index 2914c0f9ac0..8f54d730a18 100644 --- a/service/ec2/api_op_GetHostReservationPurchasePreview.go +++ b/service/ec2/api_op_GetHostReservationPurchasePreview.go @@ -48,7 +48,7 @@ type GetHostReservationPurchasePreviewInput struct { type GetHostReservationPurchasePreviewOutput struct { // The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are - // specified. At this time, the only supported currency is USD. + // specified. At this time, the only supported currency is USD . CurrencyCode types.CurrencyCodeValues // The purchase information of the Dedicated Host reservation and the Dedicated diff --git a/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go b/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go index fe3cbf3da40..558090c938c 100644 --- a/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go +++ b/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go @@ -12,23 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of instance types with the specified instance attributes. You can -// use the response to preview the instance types without launching instances. Note -// that the response does not consider capacity. When you specify multiple +// Returns a list of instance types with the specified instance attributes. You +// can use the response to preview the instance types without launching instances. +// Note that the response does not consider capacity. When you specify multiple // parameters, you get instance types that satisfy all of the specified parameters. // If you specify multiple values for a parameter, you get instance types that // satisfy any of the specified values. For more information, see Preview instance -// types with specified attributes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html#spotfleet-get-instance-types-from-instance-requirements), -// Attribute-based instance type selection for EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), -// Attribute-based instance type selection for Spot Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), -// and Spot placement score -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) +// types with specified attributes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html#spotfleet-get-instance-types-from-instance-requirements) +// , Attribute-based instance type selection for EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) +// , Attribute-based instance type selection for Spot Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) +// , and Spot placement score (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) // in the Amazon EC2 User Guide, and Creating an Auto Scaling group using -// attribute-based instance type selection -// (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) +// attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) // in the Amazon EC2 Auto Scaling User Guide. func (c *Client) GetInstanceTypesFromInstanceRequirements(ctx context.Context, params *GetInstanceTypesFromInstanceRequirementsInput, optFns ...func(*Options)) (*GetInstanceTypesFromInstanceRequirementsOutput, error) { if params == nil { @@ -64,14 +59,14 @@ type GetInstanceTypesFromInstanceRequirementsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -172,8 +167,8 @@ var _ GetInstanceTypesFromInstanceRequirementsAPIClient = (*Client)(nil) type GetInstanceTypesFromInstanceRequirementsPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_GetInstanceUefiData.go b/service/ec2/api_op_GetInstanceUefiData.go index 03df7d0edcf..019e0804664 100644 --- a/service/ec2/api_op_GetInstanceUefiData.go +++ b/service/ec2/api_op_GetInstanceUefiData.go @@ -12,16 +12,15 @@ import ( // A binary representation of the UEFI variable store. Only non-volatile variables // are stored. This is a base64 encoded and zlib compressed binary value that must -// be properly encoded. When you use register-image -// (https://docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html) to -// create an AMI, you can create an exact copy of your variable store by passing +// be properly encoded. When you use register-image (https://docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html) +// to create an AMI, you can create an exact copy of your variable store by passing // the UEFI data in the UefiData parameter. You can modify the UEFI data by using -// the python-uefivars tool (https://github.com/awslabs/python-uefivars) on GitHub. -// You can use the tool to convert the UEFI data into a human-readable format -// (JSON), which you can inspect and modify, and then convert back into the binary -// format to use with register-image. For more information, see UEFI Secure Boot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in -// the Amazon EC2 User Guide. +// the python-uefivars tool (https://github.com/awslabs/python-uefivars) on +// GitHub. You can use the tool to convert the UEFI data into a human-readable +// format (JSON), which you can inspect and modify, and then convert back into the +// binary format to use with register-image. For more information, see UEFI Secure +// Boot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) +// in the Amazon EC2 User Guide. func (c *Client) GetInstanceUefiData(ctx context.Context, params *GetInstanceUefiDataInput, optFns ...func(*Options)) (*GetInstanceUefiDataOutput, error) { if params == nil { params = &GetInstanceUefiDataInput{} @@ -46,8 +45,8 @@ type GetInstanceUefiDataInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetIpamAddressHistory.go b/service/ec2/api_op_GetIpamAddressHistory.go index f740c69ebb0..3571e71b9e0 100644 --- a/service/ec2/api_op_GetIpamAddressHistory.go +++ b/service/ec2/api_op_GetIpamAddressHistory.go @@ -14,9 +14,8 @@ import ( ) // Retrieve historical information about a CIDR within an IPAM scope. For more -// information, see View the history of IP addresses -// (https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) in the -// Amazon VPC IPAM User Guide. +// information, see View the history of IP addresses (https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) GetIpamAddressHistory(ctx context.Context, params *GetIpamAddressHistoryInput, optFns ...func(*Options)) (*GetIpamAddressHistoryOutput, error) { if params == nil { params = &GetIpamAddressHistoryInput{} @@ -48,8 +47,8 @@ type GetIpamAddressHistoryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The end of the time period for which you are looking for history. If you omit diff --git a/service/ec2/api_op_GetIpamDiscoveredAccounts.go b/service/ec2/api_op_GetIpamDiscoveredAccounts.go index 7f671b1cb5d..dd21dec02cc 100644 --- a/service/ec2/api_op_GetIpamDiscoveredAccounts.go +++ b/service/ec2/api_op_GetIpamDiscoveredAccounts.go @@ -46,8 +46,8 @@ type GetIpamDiscoveredAccountsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Discovered account filters. diff --git a/service/ec2/api_op_GetIpamDiscoveredResourceCidrs.go b/service/ec2/api_op_GetIpamDiscoveredResourceCidrs.go index 579fda50083..438d8b38d2d 100644 --- a/service/ec2/api_op_GetIpamDiscoveredResourceCidrs.go +++ b/service/ec2/api_op_GetIpamDiscoveredResourceCidrs.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the resource CIDRs that are monitored as part of a resource discovery. A -// discovered resource is a resource CIDR monitored under a resource discovery. The -// following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and -// Elastic IP addresses. +// Returns the resource CIDRs that are monitored as part of a resource discovery. +// A discovered resource is a resource CIDR monitored under a resource discovery. +// The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, +// and Elastic IP addresses. func (c *Client) GetIpamDiscoveredResourceCidrs(ctx context.Context, params *GetIpamDiscoveredResourceCidrsInput, optFns ...func(*Options)) (*GetIpamDiscoveredResourceCidrsOutput, error) { if params == nil { params = &GetIpamDiscoveredResourceCidrsInput{} @@ -45,8 +45,8 @@ type GetIpamDiscoveredResourceCidrsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Filters. diff --git a/service/ec2/api_op_GetIpamPoolAllocations.go b/service/ec2/api_op_GetIpamPoolAllocations.go index 5fec91fee44..e711b4800a6 100644 --- a/service/ec2/api_op_GetIpamPoolAllocations.go +++ b/service/ec2/api_op_GetIpamPoolAllocations.go @@ -13,12 +13,9 @@ import ( ) // Get a list of all the CIDR allocations in an IPAM pool. If you use this action -// after AllocateIpamPoolCidr -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html) -// or ReleaseIpamPoolAllocation -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html), -// note that all EC2 API actions follow an eventual consistency -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/query-api-troubleshooting.html#eventual-consistency) +// after AllocateIpamPoolCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html) +// or ReleaseIpamPoolAllocation (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html) +// , note that all EC2 API actions follow an eventual consistency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/query-api-troubleshooting.html#eventual-consistency) // model. func (c *Client) GetIpamPoolAllocations(ctx context.Context, params *GetIpamPoolAllocationsInput, optFns ...func(*Options)) (*GetIpamPoolAllocationsOutput, error) { if params == nil { @@ -44,13 +41,13 @@ type GetIpamPoolAllocationsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The ID of the allocation. diff --git a/service/ec2/api_op_GetIpamPoolCidrs.go b/service/ec2/api_op_GetIpamPoolCidrs.go index e48bcdda4be..8031c6f20d6 100644 --- a/service/ec2/api_op_GetIpamPoolCidrs.go +++ b/service/ec2/api_op_GetIpamPoolCidrs.go @@ -37,13 +37,13 @@ type GetIpamPoolCidrsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The maximum number of results to return in the request. diff --git a/service/ec2/api_op_GetIpamResourceCidrs.go b/service/ec2/api_op_GetIpamResourceCidrs.go index c43e7aa67c4..cb9b10ab2bd 100644 --- a/service/ec2/api_op_GetIpamResourceCidrs.go +++ b/service/ec2/api_op_GetIpamResourceCidrs.go @@ -41,13 +41,13 @@ type GetIpamResourceCidrsInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters for the request. For more information about filtering, see - // Filtering CLI output - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). + // Filtering CLI output (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) + // . Filters []types.Filter // The ID of the IPAM pool that the resource is in. diff --git a/service/ec2/api_op_GetLaunchTemplateData.go b/service/ec2/api_op_GetLaunchTemplateData.go index 27b14d44908..4a638523b8c 100644 --- a/service/ec2/api_op_GetLaunchTemplateData.go +++ b/service/ec2/api_op_GetLaunchTemplateData.go @@ -14,10 +14,10 @@ import ( // Retrieves the configuration data of the specified instance. You can use this // data to create a launch template. This action calls on other describe actions to // get instance information. Depending on your instance configuration, you may need -// to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, -// DescribeInstanceCreditSpecifications, DescribeVolumes, -// DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* -// depending on your instance requirements. +// to allow the following actions in your IAM policy: DescribeSpotInstanceRequests +// , DescribeInstanceCreditSpecifications , DescribeVolumes , +// DescribeInstanceAttribute , and DescribeElasticGpus . Or, you can allow +// describe* depending on your instance requirements. func (c *Client) GetLaunchTemplateData(ctx context.Context, params *GetLaunchTemplateDataInput, optFns ...func(*Options)) (*GetLaunchTemplateDataOutput, error) { if params == nil { params = &GetLaunchTemplateDataInput{} @@ -42,8 +42,8 @@ type GetLaunchTemplateDataInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetManagedPrefixListAssociations.go b/service/ec2/api_op_GetManagedPrefixListAssociations.go index 1a7eb459109..d634e7d0685 100644 --- a/service/ec2/api_op_GetManagedPrefixListAssociations.go +++ b/service/ec2/api_op_GetManagedPrefixListAssociations.go @@ -38,8 +38,8 @@ type GetManagedPrefixListAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetManagedPrefixListEntries.go b/service/ec2/api_op_GetManagedPrefixListEntries.go index c3fdc31f9bb..d7679dd489d 100644 --- a/service/ec2/api_op_GetManagedPrefixListEntries.go +++ b/service/ec2/api_op_GetManagedPrefixListEntries.go @@ -37,8 +37,8 @@ type GetManagedPrefixListEntriesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetNetworkInsightsAccessScopeAnalysisFindings.go b/service/ec2/api_op_GetNetworkInsightsAccessScopeAnalysisFindings.go index ce4d8da6731..4a6ede5c746 100644 --- a/service/ec2/api_op_GetNetworkInsightsAccessScopeAnalysisFindings.go +++ b/service/ec2/api_op_GetNetworkInsightsAccessScopeAnalysisFindings.go @@ -36,8 +36,8 @@ type GetNetworkInsightsAccessScopeAnalysisFindingsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetNetworkInsightsAccessScopeContent.go b/service/ec2/api_op_GetNetworkInsightsAccessScopeContent.go index 16d19fe0011..52aaebc95a6 100644 --- a/service/ec2/api_op_GetNetworkInsightsAccessScopeContent.go +++ b/service/ec2/api_op_GetNetworkInsightsAccessScopeContent.go @@ -36,8 +36,8 @@ type GetNetworkInsightsAccessScopeContentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetPasswordData.go b/service/ec2/api_op_GetPasswordData.go index 4fb46eb2013..dad7739b2db 100644 --- a/service/ec2/api_op_GetPasswordData.go +++ b/service/ec2/api_op_GetPasswordData.go @@ -19,18 +19,16 @@ import ( // Retrieves the encrypted administrator password for a running Windows instance. // The Windows password is generated at boot by the EC2Config service or EC2Launch // scripts (Windows Server 2016 and later). This usually only happens the first -// time an instance is launched. For more information, see EC2Config -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/UsingConfig_WinAMI.html) -// and EC2Launch -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2launch.html) in the -// Amazon EC2 User Guide. For the EC2Config service, the password is not generated -// for rebundled AMIs unless Ec2SetPassword is enabled before bundling. The -// password is encrypted using the key pair that you specified when you launched -// the instance. You must provide the corresponding key pair file. When you launch -// an instance, password generation and encryption may take a few minutes. If you -// try to retrieve the password before it's available, the output returns an empty -// string. We recommend that you wait up to 15 minutes after launching an instance -// before trying to retrieve the generated password. +// time an instance is launched. For more information, see EC2Config (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/UsingConfig_WinAMI.html) +// and EC2Launch (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2launch.html) +// in the Amazon EC2 User Guide. For the EC2Config service, the password is not +// generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling. +// The password is encrypted using the key pair that you specified when you +// launched the instance. You must provide the corresponding key pair file. When +// you launch an instance, password generation and encryption may take a few +// minutes. If you try to retrieve the password before it's available, the output +// returns an empty string. We recommend that you wait up to 15 minutes after +// launching an instance before trying to retrieve the generated password. func (c *Client) GetPasswordData(ctx context.Context, params *GetPasswordDataInput, optFns ...func(*Options)) (*GetPasswordDataOutput, error) { if params == nil { params = &GetPasswordDataInput{} @@ -55,8 +53,8 @@ type GetPasswordDataInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -165,9 +163,10 @@ type PasswordDataAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, PasswordDataAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, PasswordDataAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go index fb066980926..f8c01d62da2 100644 --- a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go @@ -41,8 +41,8 @@ type GetReservedInstancesExchangeQuoteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The configuration of the target Convertible Reserved Instance to exchange for @@ -58,7 +58,7 @@ type GetReservedInstancesExchangeQuoteOutput struct { // The currency of the transaction. CurrencyCode *string - // If true, the exchange is valid. If false, the exchange cannot be completed. + // If true , the exchange is valid. If false , the exchange cannot be completed. IsValidExchange *bool // The new end date of the reservation term. diff --git a/service/ec2/api_op_GetSerialConsoleAccessStatus.go b/service/ec2/api_op_GetSerialConsoleAccessStatus.go index d186003471a..22b2b4510e7 100644 --- a/service/ec2/api_op_GetSerialConsoleAccessStatus.go +++ b/service/ec2/api_op_GetSerialConsoleAccessStatus.go @@ -13,8 +13,7 @@ import ( // Retrieves the access status of your account to the EC2 serial console of all // instances. By default, access to the EC2 serial console is disabled for your // account. For more information, see Manage account access to the EC2 serial -// console -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) +// console (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) // in the Amazon EC2 User Guide. func (c *Client) GetSerialConsoleAccessStatus(ctx context.Context, params *GetSerialConsoleAccessStatusInput, optFns ...func(*Options)) (*GetSerialConsoleAccessStatusOutput, error) { if params == nil { @@ -35,8 +34,8 @@ type GetSerialConsoleAccessStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -44,9 +43,9 @@ type GetSerialConsoleAccessStatusInput struct { type GetSerialConsoleAccessStatusOutput struct { - // If true, access to the EC2 serial console of all instances is enabled for your - // account. If false, access to the EC2 serial console of all instances is disabled - // for your account. + // If true , access to the EC2 serial console of all instances is enabled for your + // account. If false , access to the EC2 serial console of all instances is + // disabled for your account. SerialConsoleAccessEnabled *bool // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_GetSpotPlacementScores.go b/service/ec2/api_op_GetSpotPlacementScores.go index 7c14f606a72..d7ebdd53c46 100644 --- a/service/ec2/api_op_GetSpotPlacementScores.go +++ b/service/ec2/api_op_GetSpotPlacementScores.go @@ -16,9 +16,8 @@ import ( // the specified target capacity and compute requirements. You can specify your // compute requirements either by using InstanceRequirementsWithMetadata and // letting Amazon EC2 choose the optimal instance types to fulfill your Spot -// request, or you can specify the instance types by using InstanceTypes. For more -// information, see Spot placement score -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) +// request, or you can specify the instance types by using InstanceTypes . For more +// information, see Spot placement score (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) // in the Amazon EC2 User Guide. func (c *Client) GetSpotPlacementScores(ctx context.Context, params *GetSpotPlacementScoresInput, optFns ...func(*Options)) (*GetSpotPlacementScoresOutput, error) { if params == nil { @@ -44,26 +43,26 @@ type GetSpotPlacementScoresInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with those attributes. If you specify - // InstanceRequirementsWithMetadata, you can't specify InstanceTypes. + // InstanceRequirementsWithMetadata , you can't specify InstanceTypes . InstanceRequirementsWithMetadata *types.InstanceRequirementsWithMetadataRequest - // The instance types. We recommend that you specify at least three instance types. - // If you specify one or two instance types, or specify variations of a single - // instance type (for example, an m3.xlarge with and without instance storage), the - // returned placement score will always be low. If you specify InstanceTypes, you - // can't specify InstanceRequirementsWithMetadata. + // The instance types. We recommend that you specify at least three instance + // types. If you specify one or two instance types, or specify variations of a + // single instance type (for example, an m3.xlarge with and without instance + // storage), the returned placement score will always be low. If you specify + // InstanceTypes , you can't specify InstanceRequirementsWithMetadata . InstanceTypes []string // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -71,7 +70,7 @@ type GetSpotPlacementScoresInput struct { NextToken *string // The Regions used to narrow down the list of Regions to be scored. Enter the - // Region code, for example, us-east-1. + // Region code, for example, us-east-1 . RegionNames []string // Specify true so that the response returns a list of scored Availability Zones. @@ -93,11 +92,11 @@ type GetSpotPlacementScoresOutput struct { // value is null when there are no more items to return. NextToken *string - // The Spot placement score for the top 10 Regions or Availability Zones, scored on - // a scale from 1 to 10. Each score
 reflects how likely it is that each Region or - // Availability Zone will succeed at fulfilling the specified target capacity
 at - // the time of the Spot placement score request. A score of 10 means that your Spot - // capacity request is highly likely to succeed in that Region or Availability + // The Spot placement score for the top 10 Regions or Availability Zones, scored + // on a scale from 1 to 10. Each score
 reflects how likely it is that each Region + // or Availability Zone will succeed at fulfilling the specified target capacity + // at the time of the Spot placement score request. A score of 10 means that your + // Spot capacity request is highly likely to succeed in that Region or Availability // Zone. If you request a Spot placement score for Regions, a high score assumes // that your fleet request will be configured to use all Availability Zones and the // capacity-optimized allocation strategy. If you request a Spot placement score @@ -190,8 +189,8 @@ var _ GetSpotPlacementScoresAPIClient = (*Client)(nil) type GetSpotPlacementScoresPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_GetSubnetCidrReservations.go b/service/ec2/api_op_GetSubnetCidrReservations.go index f1da5b1bc32..243e533e396 100644 --- a/service/ec2/api_op_GetSubnetCidrReservations.go +++ b/service/ec2/api_op_GetSubnetCidrReservations.go @@ -36,26 +36,19 @@ type GetSubnetCidrReservationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * reservationType - The type of reservation (prefix | - // explicit). - // - // * subnet-id - The ID of the subnet. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Use the tag key in the filter - // name and the tag value as the filter value. For example, to find all resources - // that have a tag with the key Owner and the value TeamA, specify tag:Owner for - // the filter name and TeamA for the filter value. - // - // * tag-key - The key of a tag - // assigned to the resource. Use this filter to find all resources assigned a tag - // with a specific key, regardless of the tag value. + // - reservationType - The type of reservation ( prefix | explicit ). + // - subnet-id - The ID of the subnet. + // - tag : - The key/value combination of a tag assigned to the resource. Use the + // tag key in the filter name and the tag value as the filter value. For example, + // to find all resources that have a tag with the key Owner and the value TeamA , + // specify tag:Owner for the filter name and TeamA for the filter value. + // - tag-key - The key of a tag assigned to the resource. Use this filter to find + // all resources assigned a tag with a specific key, regardless of the tag value. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go index 330fea42aa8..4b14ad5302c 100644 --- a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go +++ b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go @@ -38,14 +38,12 @@ type GetTransitGatewayAttachmentPropagationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * transit-gateway-route-table-id - // - The ID of the transit gateway route table. + // - transit-gateway-route-table-id - The ID of the transit gateway route table. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the @@ -136,16 +134,16 @@ func (c *Client) addOperationGetTransitGatewayAttachmentPropagationsMiddlewares( return nil } -// GetTransitGatewayAttachmentPropagationsAPIClient is a client that implements the -// GetTransitGatewayAttachmentPropagations operation. +// GetTransitGatewayAttachmentPropagationsAPIClient is a client that implements +// the GetTransitGatewayAttachmentPropagations operation. type GetTransitGatewayAttachmentPropagationsAPIClient interface { GetTransitGatewayAttachmentPropagations(context.Context, *GetTransitGatewayAttachmentPropagationsInput, ...func(*Options)) (*GetTransitGatewayAttachmentPropagationsOutput, error) } var _ GetTransitGatewayAttachmentPropagationsAPIClient = (*Client)(nil) -// GetTransitGatewayAttachmentPropagationsPaginatorOptions is the paginator options -// for GetTransitGatewayAttachmentPropagations +// GetTransitGatewayAttachmentPropagationsPaginatorOptions is the paginator +// options for GetTransitGatewayAttachmentPropagations type GetTransitGatewayAttachmentPropagationsPaginatorOptions 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. diff --git a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go index f2d209143fd..3d077608e58 100644 --- a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go @@ -38,26 +38,17 @@ type GetTransitGatewayMulticastDomainAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * resource-id - The ID of the - // resource. - // - // * resource-type - The type of resource. The valid value is: vpc. - // - // * - // state - The state of the subnet association. Valid values are associated | - // associating | disassociated | disassociating. - // - // * subnet-id - The ID of the - // subnet. - // - // * transit-gateway-attachment-id - The id of the transit gateway - // attachment. + // - resource-id - The ID of the resource. + // - resource-type - The type of resource. The valid value is: vpc . + // - state - The state of the subnet association. Valid values are associated | + // associating | disassociated | disassociating . + // - subnet-id - The ID of the subnet. + // - transit-gateway-attachment-id - The id of the transit gateway attachment. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetTransitGatewayPolicyTableAssociations.go b/service/ec2/api_op_GetTransitGatewayPolicyTableAssociations.go index 184e842dd59..82065b022f5 100644 --- a/service/ec2/api_op_GetTransitGatewayPolicyTableAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayPolicyTableAssociations.go @@ -37,8 +37,8 @@ type GetTransitGatewayPolicyTableAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters associated with the transit gateway policy table. diff --git a/service/ec2/api_op_GetTransitGatewayPolicyTableEntries.go b/service/ec2/api_op_GetTransitGatewayPolicyTableEntries.go index 120ed1e39e0..eaaf1b9892d 100644 --- a/service/ec2/api_op_GetTransitGatewayPolicyTableEntries.go +++ b/service/ec2/api_op_GetTransitGatewayPolicyTableEntries.go @@ -36,8 +36,8 @@ type GetTransitGatewayPolicyTableEntriesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The filters associated with the transit gateway policy table. diff --git a/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go b/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go index b5fee978c86..c7617db04e6 100644 --- a/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go +++ b/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the prefix list references in a specified transit gateway -// route table. +// Gets information about the prefix list references in a specified transit +// gateway route table. func (c *Client) GetTransitGatewayPrefixListReferences(ctx context.Context, params *GetTransitGatewayPrefixListReferencesInput, optFns ...func(*Options)) (*GetTransitGatewayPrefixListReferencesOutput, error) { if params == nil { params = &GetTransitGatewayPrefixListReferencesInput{} @@ -38,32 +38,21 @@ type GetTransitGatewayPrefixListReferencesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * attachment.resource-id - The ID - // of the resource for the attachment. - // - // * attachment.resource-type - The type of - // resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway - // | peering. - // - // * attachment.transit-gateway-attachment-id - The ID of the - // attachment. - // - // * is-blackhole - Whether traffic matching the route is blocked - // (true | false). - // - // * prefix-list-id - The ID of the prefix list. - // - // * - // prefix-list-owner-id - The ID of the owner of the prefix list. - // - // * state - The - // state of the prefix list reference (pending | available | modifying | deleting). + // - attachment.resource-id - The ID of the resource for the attachment. + // - attachment.resource-type - The type of resource for the attachment. Valid + // values are vpc | vpn | direct-connect-gateway | peering . + // - attachment.transit-gateway-attachment-id - The ID of the attachment. + // - is-blackhole - Whether traffic matching the route is blocked ( true | false + // ). + // - prefix-list-id - The ID of the prefix list. + // - prefix-list-owner-id - The ID of the owner of the prefix list. + // - state - The state of the prefix list reference ( pending | available | + // modifying | deleting ). Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go index 0c79089cbbd..d46a06336b7 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go @@ -38,20 +38,15 @@ type GetTransitGatewayRouteTableAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * resource-id - The ID of the - // resource. - // - // * resource-type - The resource type. Valid values are vpc | vpn | - // direct-connect-gateway | peering | connect. - // - // * transit-gateway-attachment-id - - // The ID of the attachment. + // - resource-id - The ID of the resource. + // - resource-type - The resource type. Valid values are vpc | vpn | + // direct-connect-gateway | peering | connect . + // - transit-gateway-attachment-id - The ID of the attachment. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the @@ -142,16 +137,16 @@ func (c *Client) addOperationGetTransitGatewayRouteTableAssociationsMiddlewares( return nil } -// GetTransitGatewayRouteTableAssociationsAPIClient is a client that implements the -// GetTransitGatewayRouteTableAssociations operation. +// GetTransitGatewayRouteTableAssociationsAPIClient is a client that implements +// the GetTransitGatewayRouteTableAssociations operation. type GetTransitGatewayRouteTableAssociationsAPIClient interface { GetTransitGatewayRouteTableAssociations(context.Context, *GetTransitGatewayRouteTableAssociationsInput, ...func(*Options)) (*GetTransitGatewayRouteTableAssociationsOutput, error) } var _ GetTransitGatewayRouteTableAssociationsAPIClient = (*Client)(nil) -// GetTransitGatewayRouteTableAssociationsPaginatorOptions is the paginator options -// for GetTransitGatewayRouteTableAssociations +// GetTransitGatewayRouteTableAssociationsPaginatorOptions is the paginator +// options for GetTransitGatewayRouteTableAssociations type GetTransitGatewayRouteTableAssociationsPaginatorOptions 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. diff --git a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go index 3b1625146df..dcf98e13180 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go @@ -38,20 +38,15 @@ type GetTransitGatewayRouteTablePropagationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * resource-id - The ID of the - // resource. - // - // * resource-type - The resource type. Valid values are vpc | vpn | - // direct-connect-gateway | peering | connect. - // - // * transit-gateway-attachment-id - - // The ID of the attachment. + // - resource-id - The ID of the resource. + // - resource-type - The resource type. Valid values are vpc | vpn | + // direct-connect-gateway | peering | connect . + // - transit-gateway-attachment-id - The ID of the attachment. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the @@ -142,16 +137,16 @@ func (c *Client) addOperationGetTransitGatewayRouteTablePropagationsMiddlewares( return nil } -// GetTransitGatewayRouteTablePropagationsAPIClient is a client that implements the -// GetTransitGatewayRouteTablePropagations operation. +// GetTransitGatewayRouteTablePropagationsAPIClient is a client that implements +// the GetTransitGatewayRouteTablePropagations operation. type GetTransitGatewayRouteTablePropagationsAPIClient interface { GetTransitGatewayRouteTablePropagations(context.Context, *GetTransitGatewayRouteTablePropagationsInput, ...func(*Options)) (*GetTransitGatewayRouteTablePropagationsOutput, error) } var _ GetTransitGatewayRouteTablePropagationsAPIClient = (*Client)(nil) -// GetTransitGatewayRouteTablePropagationsPaginatorOptions is the paginator options -// for GetTransitGatewayRouteTablePropagations +// GetTransitGatewayRouteTablePropagationsPaginatorOptions is the paginator +// options for GetTransitGatewayRouteTablePropagations type GetTransitGatewayRouteTablePropagationsPaginatorOptions 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. diff --git a/service/ec2/api_op_GetVerifiedAccessEndpointPolicy.go b/service/ec2/api_op_GetVerifiedAccessEndpointPolicy.go index 0bc17d9a170..14541b912b3 100644 --- a/service/ec2/api_op_GetVerifiedAccessEndpointPolicy.go +++ b/service/ec2/api_op_GetVerifiedAccessEndpointPolicy.go @@ -35,8 +35,8 @@ type GetVerifiedAccessEndpointPolicyInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetVerifiedAccessGroupPolicy.go b/service/ec2/api_op_GetVerifiedAccessGroupPolicy.go index eae0e2e2724..c05eae36daa 100644 --- a/service/ec2/api_op_GetVerifiedAccessGroupPolicy.go +++ b/service/ec2/api_op_GetVerifiedAccessGroupPolicy.go @@ -35,8 +35,8 @@ type GetVerifiedAccessGroupPolicyInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetVpnConnectionDeviceSampleConfiguration.go b/service/ec2/api_op_GetVpnConnectionDeviceSampleConfiguration.go index a6a4ca01423..a36a53e3cfe 100644 --- a/service/ec2/api_op_GetVpnConnectionDeviceSampleConfiguration.go +++ b/service/ec2/api_op_GetVpnConnectionDeviceSampleConfiguration.go @@ -42,12 +42,12 @@ type GetVpnConnectionDeviceSampleConfigurationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IKE version to be used in the sample configuration file for your customer - // gateway device. You can specify one of the following versions: ikev1 or ikev2. + // gateway device. You can specify one of the following versions: ikev1 or ikev2 . InternetKeyExchangeVersion *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetVpnConnectionDeviceTypes.go b/service/ec2/api_op_GetVpnConnectionDeviceTypes.go index 849fd6f7ad5..66405e36ff3 100644 --- a/service/ec2/api_op_GetVpnConnectionDeviceTypes.go +++ b/service/ec2/api_op_GetVpnConnectionDeviceTypes.go @@ -15,9 +15,8 @@ import ( // Obtain a list of customer gateway devices for which sample configuration files // can be provided. The request has no additional parameters. You can also see the // list of device types with sample configuration files available under Your -// customer gateway device -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// customer gateway device (https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) GetVpnConnectionDeviceTypes(ctx context.Context, params *GetVpnConnectionDeviceTypesInput, optFns ...func(*Options)) (*GetVpnConnectionDeviceTypesOutput, error) { if params == nil { params = &GetVpnConnectionDeviceTypesInput{} @@ -37,8 +36,8 @@ type GetVpnConnectionDeviceTypesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of results returned by GetVpnConnectionDeviceTypes in @@ -63,13 +62,13 @@ type GetVpnConnectionDeviceTypesInput struct { type GetVpnConnectionDeviceTypesOutput struct { // The NextToken value to include in a future GetVpnConnectionDeviceTypes request. - // When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, + // When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults , // this value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string - // List of customer gateway devices that have a sample configuration file available - // for use. + // List of customer gateway devices that have a sample configuration file + // available for use. VpnConnectionDeviceTypes []types.VpnConnectionDeviceType // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_GetVpnTunnelReplacementStatus.go b/service/ec2/api_op_GetVpnTunnelReplacementStatus.go index 1b0e0d9e06f..8f3b0e4481b 100644 --- a/service/ec2/api_op_GetVpnTunnelReplacementStatus.go +++ b/service/ec2/api_op_GetVpnTunnelReplacementStatus.go @@ -41,8 +41,8 @@ type GetVpnTunnelReplacementStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go index 547f5b456ef..8bbe2c53f5c 100644 --- a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go +++ b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go @@ -32,8 +32,7 @@ func (c *Client) ImportClientVpnClientCertificateRevocationList(ctx context.Cont type ImportClientVpnClientCertificateRevocationListInput struct { // The client certificate revocation list file. For more information, see Generate - // a Client Certificate Revocation List - // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate) + // a Client Certificate Revocation List (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate) // in the Client VPN Administrator Guide. // // This member is required. @@ -47,8 +46,8 @@ type ImportClientVpnClientCertificateRevocationListInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ImportImage.go b/service/ec2/api_op_ImportImage.go index d01d1bdd7d8..c181ba83de0 100644 --- a/service/ec2/api_op_ImportImage.go +++ b/service/ec2/api_op_ImportImage.go @@ -13,17 +13,14 @@ import ( // To import your virtual machines (VMs) with a console-based experience, you can // use the Import virtual machine images to Amazon Web Services template in the -// Migration Hub Orchestrator console -// (https://console.aws.amazon.com/migrationhub/orchestrator). For more -// information, see the Migration Hub Orchestrator User Guide -// (https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html). -// Import single or multi-volume disk images or EBS snapshots into an Amazon +// Migration Hub Orchestrator console (https://console.aws.amazon.com/migrationhub/orchestrator) +// . For more information, see the Migration Hub Orchestrator User Guide (https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html) +// . Import single or multi-volume disk images or EBS snapshots into an Amazon // Machine Image (AMI). Amazon Web Services VM Import/Export strongly recommends // specifying a value for either the --license-type or --usage-operation parameter // when you create a new VM Import task. This ensures your operating system is // licensed appropriately and your billing is optimized. For more information, see -// Importing a VM as an image using VM Import/Export -// (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html) +// Importing a VM as an image using VM Import/Export (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html) // in the VM Import/Export User Guide. func (c *Client) ImportImage(ctx context.Context, params *ImportImageInput, optFns ...func(*Options)) (*ImportImageOutput, error) { if params == nil { @@ -62,15 +59,14 @@ type ImportImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // Specifies whether the destination AMI of the imported image should be encrypted. - // The default KMS key for EBS is used unless you specify a non-default KMS key - // using KmsKeyId. For more information, see Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. + // Specifies whether the destination AMI of the imported image should be + // encrypted. The default KMS key for EBS is used unless you specify a non-default + // KMS key using KmsKeyId . For more information, see Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // in the Amazon Elastic Compute Cloud User Guide. Encrypted *bool // The target hypervisor platform. Valid values: xen @@ -81,32 +77,24 @@ type ImportImageInput struct { // this parameter is not specified, the default KMS key for EBS is used. If a // KmsKeyId is specified, the Encrypted flag must also be set. The KMS key // identifier may be provided in any of the following formats: - // - // * Key ID - // - // * Key - // alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region - // of the key, the Amazon Web Services account ID of the key owner, the alias - // namespace, and then the key alias. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // * ARN using key ID. The - // ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, - // the Amazon Web Services account ID of the key owner, the key namespace, and then - // the key ID. For example, - // arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. - // - // * - // ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed - // by the Region of the key, the Amazon Web Services account ID of the key owner, - // the alias namespace, and then the key alias. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // parses KmsKeyId asynchronously, meaning that the action you call may appear to - // complete even though you provided an invalid identifier. This action will - // eventually report failure. The specified KMS key must exist in the Region that - // the AMI is being copied to. Amazon EBS does not support asymmetric KMS keys. + // - Key ID + // - Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the + // Region of the key, the Amazon Web Services account ID of the key owner, the + // alias namespace, and then the key alias. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // - ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by + // the Region of the key, the Amazon Web Services account ID of the key owner, the + // key namespace, and then the key ID. For example, + // arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. + // - ARN using key alias. The alias ARN contains the arn:aws:kms namespace, + // followed by the Region of the key, the Amazon Web Services account ID of the key + // owner, the alias namespace, and then the key alias. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you + // call may appear to complete even though you provided an invalid identifier. This + // action will eventually report failure. The specified KMS key must exist in the + // Region that the AMI is being copied to. Amazon EBS does not support asymmetric + // KMS keys. KmsKeyId *string // The ARNs of the license configurations. @@ -117,10 +105,9 @@ type ImportImageInput struct { // license or BYOL to retain the source-system license. Leaving this parameter // undefined is the same as choosing AWS when importing a Windows Server operating // system, and the same as choosing BYOL when importing a Windows client operating - // system (such as Windows 10) or a Linux operating system. To use BYOL, you must + // system (such as Windows 10) or a Linux operating system. To use BYOL , you must // have existing licenses with rights to use these licenses in a third party cloud, - // such as Amazon Web Services. For more information, see Prerequisites - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image) + // such as Amazon Web Services. For more information, see Prerequisites (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image) // in the VM Import/Export User Guide. LicenseType *string @@ -133,8 +120,7 @@ type ImportImageInput struct { // The tags to apply to the import image task during creation. TagSpecifications []types.TagSpecification - // The usage operation value. For more information, see Licensing options - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites) + // The usage operation value. For more information, see Licensing options (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites) // in the VM Import/Export User Guide. UsageOperation *string diff --git a/service/ec2/api_op_ImportInstance.go b/service/ec2/api_op_ImportInstance.go index b167eeea103..b960b5ee28e 100644 --- a/service/ec2/api_op_ImportInstance.go +++ b/service/ec2/api_op_ImportInstance.go @@ -15,11 +15,10 @@ import ( // This API action supports only single-volume VMs. To import multi-volume VMs, use // ImportImage instead. This API action is not supported by the Command Line // Interface (CLI). For information about using the Amazon EC2 CLI, which is -// deprecated, see Importing a VM to Amazon EC2 -// (https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#UsingVirtualMachinesinAmazonEC2) +// deprecated, see Importing a VM to Amazon EC2 (https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#UsingVirtualMachinesinAmazonEC2) // in the Amazon EC2 CLI Reference PDF file. For information about the import -// manifest referenced by this API action, see VM Import Manifest -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). +// manifest referenced by this API action, see VM Import Manifest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html) +// . func (c *Client) ImportInstance(ctx context.Context, params *ImportInstanceInput, optFns ...func(*Options)) (*ImportInstanceOutput, error) { if params == nil { params = &ImportInstanceInput{} @@ -50,8 +49,8 @@ type ImportInstanceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The launch specification. diff --git a/service/ec2/api_op_ImportKeyPair.go b/service/ec2/api_op_ImportKeyPair.go index 53a413a6a1b..a22ed1196b2 100644 --- a/service/ec2/api_op_ImportKeyPair.go +++ b/service/ec2/api_op_ImportKeyPair.go @@ -12,14 +12,13 @@ import ( ) // Imports the public key from an RSA or ED25519 key pair that you created with a -// third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services +// third-party tool. Compare this with CreateKeyPair , in which Amazon Web Services // creates the key pair and gives the keys to you (Amazon Web Services keeps a copy // of the public key). With ImportKeyPair, you create the key pair and give Amazon // Web Services just the public key. The private key is never transferred between // you and Amazon Web Services. For more information about key pairs, see Amazon -// EC2 key pairs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the -// Amazon Elastic Compute Cloud User Guide. +// EC2 key pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ImportKeyPair(ctx context.Context, params *ImportKeyPairInput, optFns ...func(*Options)) (*ImportKeyPairOutput, error) { if params == nil { params = &ImportKeyPairInput{} @@ -42,16 +41,16 @@ type ImportKeyPairInput struct { // This member is required. KeyName *string - // The public key. For API calls, the text must be base64-encoded. For command line - // tools, base64 encoding is performed for you. + // The public key. For API calls, the text must be base64-encoded. For command + // line tools, base64 encoding is performed for you. // // This member is required. PublicKeyMaterial []byte // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply to the imported key pair. @@ -62,12 +61,11 @@ type ImportKeyPairInput struct { type ImportKeyPairOutput struct { - // * For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as - // specified in section 4 of RFC 4716. - // - // * For ED25519 key pairs, the key - // fingerprint is the base64-encoded SHA-256 digest, which is the default for - // OpenSSH, starting with OpenSSH 6.8 (http://www.openssh.com/txt/release-6.8). + // - For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as + // specified in section 4 of RFC 4716. + // - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 + // digest, which is the default for OpenSSH, starting with OpenSSH 6.8 (http://www.openssh.com/txt/release-6.8) + // . KeyFingerprint *string // The key pair name that you provided. diff --git a/service/ec2/api_op_ImportSnapshot.go b/service/ec2/api_op_ImportSnapshot.go index 22925d9c07d..dfef004cb7d 100644 --- a/service/ec2/api_op_ImportSnapshot.go +++ b/service/ec2/api_op_ImportSnapshot.go @@ -12,8 +12,7 @@ import ( ) // Imports a disk into an EBS snapshot. For more information, see Importing a disk -// as a snapshot using VM Import/Export -// (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html) +// as a snapshot using VM Import/Export (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html) // in the VM Import/Export User Guide. func (c *Client) ImportSnapshot(ctx context.Context, params *ImportSnapshotInput, optFns ...func(*Options)) (*ImportSnapshotOutput, error) { if params == nil { @@ -46,15 +45,14 @@ type ImportSnapshotInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specifies whether the destination snapshot of the imported image should be // encrypted. The default KMS key for EBS is used unless you specify a non-default - // KMS key using KmsKeyId. For more information, see Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the - // Amazon Elastic Compute Cloud User Guide. + // KMS key using KmsKeyId . For more information, see Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // in the Amazon Elastic Compute Cloud User Guide. Encrypted *bool // An identifier for the symmetric KMS key to use when creating the encrypted @@ -62,33 +60,24 @@ type ImportSnapshotInput struct { // key; if this parameter is not specified, the default KMS key for EBS is used. If // a KmsKeyId is specified, the Encrypted flag must also be set. The KMS key // identifier may be provided in any of the following formats: - // - // * Key ID - // - // * Key - // alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region - // of the key, the Amazon Web Services account ID of the key owner, the alias - // namespace, and then the key alias. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // * ARN using key ID. The - // ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, - // the Amazon Web Services account ID of the key owner, the key namespace, and then - // the key ID. For example, - // arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. - // - // * - // ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed - // by the Region of the key, the Amazon Web Services account ID of the key owner, - // the alias namespace, and then the key alias. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // parses KmsKeyId asynchronously, meaning that the action you call may appear to - // complete even though you provided an invalid identifier. This action will - // eventually report failure. The specified KMS key must exist in the Region that - // the snapshot is being copied to. Amazon EBS does not support asymmetric KMS - // keys. + // - Key ID + // - Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the + // Region of the key, the Amazon Web Services account ID of the key owner, the + // alias namespace, and then the key alias. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // - ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by + // the Region of the key, the Amazon Web Services account ID of the key owner, the + // key namespace, and then the key ID. For example, + // arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. + // - ARN using key alias. The alias ARN contains the arn:aws:kms namespace, + // followed by the Region of the key, the Amazon Web Services account ID of the key + // owner, the alias namespace, and then the key alias. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you + // call may appear to complete even though you provided an invalid identifier. This + // action will eventually report failure. The specified KMS key must exist in the + // Region that the snapshot is being copied to. Amazon EBS does not support + // asymmetric KMS keys. KmsKeyId *string // The name of the role to use when not using the default role, 'vmimport'. diff --git a/service/ec2/api_op_ImportVolume.go b/service/ec2/api_op_ImportVolume.go index f92267df5e0..7af80213b32 100644 --- a/service/ec2/api_op_ImportVolume.go +++ b/service/ec2/api_op_ImportVolume.go @@ -11,16 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an import volume task using metadata from the specified disk image. This -// API action supports only single-volume VMs. To import multi-volume VMs, use -// ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead. -// This API action is not supported by the Command Line Interface (CLI). For -// information about using the Amazon EC2 CLI, which is deprecated, see Importing -// Disks to Amazon EBS -// (https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#importing-your-volumes-into-amazon-ebs) +// Creates an import volume task using metadata from the specified disk image. +// This API action supports only single-volume VMs. To import multi-volume VMs, use +// ImportImage instead. To import a disk to a snapshot, use ImportSnapshot +// instead. This API action is not supported by the Command Line Interface (CLI). +// For information about using the Amazon EC2 CLI, which is deprecated, see +// Importing Disks to Amazon EBS (https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#importing-your-volumes-into-amazon-ebs) // in the Amazon EC2 CLI Reference PDF file. For information about the import -// manifest referenced by this API action, see VM Import Manifest -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). +// manifest referenced by this API action, see VM Import Manifest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html) +// . func (c *Client) ImportVolume(ctx context.Context, params *ImportVolumeInput, optFns ...func(*Options)) (*ImportVolumeOutput, error) { if params == nil { params = &ImportVolumeInput{} @@ -58,8 +57,8 @@ type ImportVolumeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ListImagesInRecycleBin.go b/service/ec2/api_op_ListImagesInRecycleBin.go index 349bf7d96b4..79057dbf54c 100644 --- a/service/ec2/api_op_ListImagesInRecycleBin.go +++ b/service/ec2/api_op_ListImagesInRecycleBin.go @@ -13,9 +13,8 @@ import ( ) // Lists one or more AMIs that are currently in the Recycle Bin. For more -// information, see Recycle Bin -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the -// Amazon EC2 User Guide. +// information, see Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) +// in the Amazon EC2 User Guide. func (c *Client) ListImagesInRecycleBin(ctx context.Context, params *ListImagesInRecycleBinInput, optFns ...func(*Options)) (*ListImagesInRecycleBinOutput, error) { if params == nil { params = &ListImagesInRecycleBinInput{} @@ -35,8 +34,8 @@ type ListImagesInRecycleBinInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that @@ -45,8 +44,8 @@ type ListImagesInRecycleBinInput struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -144,8 +143,8 @@ var _ ListImagesInRecycleBinAPIClient = (*Client)(nil) type ListImagesInRecycleBinPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_ListSnapshotsInRecycleBin.go b/service/ec2/api_op_ListSnapshotsInRecycleBin.go index c56ee47fbeb..1af4f90a72d 100644 --- a/service/ec2/api_op_ListSnapshotsInRecycleBin.go +++ b/service/ec2/api_op_ListSnapshotsInRecycleBin.go @@ -32,14 +32,14 @@ type ListSnapshotsInRecycleBinInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . MaxResults *int32 // The token returned from a previous paginated request. Pagination continues from @@ -141,8 +141,8 @@ var _ ListSnapshotsInRecycleBinAPIClient = (*Client)(nil) type ListSnapshotsInRecycleBinPaginatorOptions struct { // The maximum number of items to return for this request. To get the next page of // items, make another request with the token returned in the output. For more - // information, see Pagination - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). + // information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination) + // . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_ModifyAddressAttribute.go b/service/ec2/api_op_ModifyAddressAttribute.go index bdbf7bbc410..14ab5aede1c 100644 --- a/service/ec2/api_op_ModifyAddressAttribute.go +++ b/service/ec2/api_op_ModifyAddressAttribute.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an attribute of the specified Elastic IP address. For requirements, see -// Using reverse DNS for email applications -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS). +// Modifies an attribute of the specified Elastic IP address. For requirements, +// see Using reverse DNS for email applications (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS) +// . func (c *Client) ModifyAddressAttribute(ctx context.Context, params *ModifyAddressAttributeInput, optFns ...func(*Options)) (*ModifyAddressAttributeOutput, error) { if params == nil { params = &ModifyAddressAttributeInput{} @@ -41,8 +41,8 @@ type ModifyAddressAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go index 73141743f4a..ea259061dd3 100644 --- a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go +++ b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go @@ -12,9 +12,8 @@ import ( ) // Changes the opt-in status of the Local Zone and Wavelength Zone group for your -// account. Use DescribeAvailabilityZones -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) -// to view the value for GroupName. +// account. Use DescribeAvailabilityZones (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) +// to view the value for GroupName . func (c *Client) ModifyAvailabilityZoneGroup(ctx context.Context, params *ModifyAvailabilityZoneGroupInput, optFns ...func(*Options)) (*ModifyAvailabilityZoneGroupOutput, error) { if params == nil { params = &ModifyAvailabilityZoneGroupInput{} @@ -39,9 +38,8 @@ type ModifyAvailabilityZoneGroupInput struct { GroupName *string // Indicates whether you are opted in to the Local Zone group or Wavelength Zone - // group. The only valid value is opted-in. You must contact Amazon Web Services - // Support - // (https://console.aws.amazon.com/support/home#/case/create%3FissueType=customer-service%26serviceCode=general-info%26getting-started%26categoryCode=using-aws%26services) + // group. The only valid value is opted-in . You must contact Amazon Web Services + // Support (https://console.aws.amazon.com/support/home#/case/create%3FissueType=customer-service%26serviceCode=general-info%26getting-started%26categoryCode=using-aws%26services) // to opt out of a Local Zone or Wavelength Zone group. // // This member is required. @@ -49,8 +47,8 @@ type ModifyAvailabilityZoneGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyCapacityReservation.go b/service/ec2/api_op_ModifyCapacityReservation.go index af9f6355212..49ce46f7951 100644 --- a/service/ec2/api_op_ModifyCapacityReservation.go +++ b/service/ec2/api_op_ModifyCapacityReservation.go @@ -48,8 +48,8 @@ type ModifyCapacityReservationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The date and time at which the Capacity Reservation expires. When a Capacity @@ -59,19 +59,15 @@ type ModifyCapacityReservationInput struct { // within an hour from the specified time. For example, if you specify 5/31/2019, // 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and // 14:30:55 on 5/31/2019. You must provide an EndDate value if EndDateType is - // limited. Omit EndDate if EndDateType is unlimited. + // limited . Omit EndDate if EndDateType is unlimited . EndDate *time.Time - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation - // can have one of the following end types: - // - // * unlimited - The Capacity Reservation - // remains active until you explicitly cancel it. Do not provide an EndDate value - // if EndDateType is unlimited. - // - // * limited - The Capacity Reservation expires - // automatically at a specified date and time. You must provide an EndDate value if - // EndDateType is limited. + // Indicates the way in which the Capacity Reservation ends. A Capacity + // Reservation can have one of the following end types: + // - unlimited - The Capacity Reservation remains active until you explicitly + // cancel it. Do not provide an EndDate value if EndDateType is unlimited . + // - limited - The Capacity Reservation expires automatically at a specified date + // and time. You must provide an EndDate value if EndDateType is limited . EndDateType types.EndDateType // The number of instances for which to reserve capacity. The number of instances diff --git a/service/ec2/api_op_ModifyCapacityReservationFleet.go b/service/ec2/api_op_ModifyCapacityReservationFleet.go index df0c43767a3..424cd70e3ee 100644 --- a/service/ec2/api_op_ModifyCapacityReservationFleet.go +++ b/service/ec2/api_op_ModifyCapacityReservationFleet.go @@ -11,12 +11,12 @@ import ( "time" ) -// Modifies a Capacity Reservation Fleet. When you modify the total target capacity -// of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity -// Reservations, or modifies or cancels existing Capacity Reservations in the Fleet -// to meet the new total target capacity. When you modify the end date for the -// Fleet, the end dates for all of the individual Capacity Reservations in the -// Fleet are updated accordingly. +// Modifies a Capacity Reservation Fleet. When you modify the total target +// capacity of a Capacity Reservation Fleet, the Fleet automatically creates new +// Capacity Reservations, or modifies or cancels existing Capacity Reservations in +// the Fleet to meet the new total target capacity. When you modify the end date +// for the Fleet, the end dates for all of the individual Capacity Reservations in +// the Fleet are updated accordingly. func (c *Client) ModifyCapacityReservationFleet(ctx context.Context, params *ModifyCapacityReservationFleetInput, optFns ...func(*Options)) (*ModifyCapacityReservationFleetOutput, error) { if params == nil { params = &ModifyCapacityReservationFleetInput{} @@ -41,22 +41,22 @@ type ModifyCapacityReservationFleetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The date and time at which the Capacity Reservation Fleet expires. When the // Capacity Reservation Fleet expires, its state changes to expired and all of the // Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet // expires within an hour after the specified time. For example, if you specify - // 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire - // between 13:30:55 and 14:30:55 on 5/31/2019. You can't specify EndDate and + // 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire + // between 13:30:55 and 14:30:55 on 5/31/2019 . You can't specify EndDate and // RemoveEndDate in the same request. EndDate *time.Time - // Indicates whether to remove the end date from the Capacity Reservation Fleet. If - // you remove the end date, the Capacity Reservation Fleet does not expire and it - // remains active until you explicitly cancel it using the + // Indicates whether to remove the end date from the Capacity Reservation Fleet. + // If you remove the end date, the Capacity Reservation Fleet does not expire and + // it remains active until you explicitly cancel it using the // CancelCapacityReservationFleet action. You can't specify RemoveEndDate and // EndDate in the same request. RemoveEndDate *bool @@ -65,8 +65,7 @@ type ModifyCapacityReservationFleetInput struct { // Fleet. This value, together with the instance type weights that you assign to // each instance type used by the Fleet determine the number of instances for which // the Fleet reserves capacity. Both values are based on units that make sense for - // your workload. For more information, see Total target capacity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) + // your workload. For more information, see Total target capacity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) // in the Amazon EC2 User Guide. TotalTargetCapacity *int32 diff --git a/service/ec2/api_op_ModifyClientVpnEndpoint.go b/service/ec2/api_op_ModifyClientVpnEndpoint.go index fe144458b36..0e6531800bb 100644 --- a/service/ec2/api_op_ModifyClientVpnEndpoint.go +++ b/service/ec2/api_op_ModifyClientVpnEndpoint.go @@ -38,37 +38,30 @@ type ModifyClientVpnEndpointInput struct { // The options for managing connection authorization for new client connections. ClientConnectOptions *types.ClientConnectOptions - // Options for enabling a customizable text banner that will be displayed on Amazon - // Web Services provided clients when a VPN session is established. + // Options for enabling a customizable text banner that will be displayed on + // Amazon Web Services provided clients when a VPN session is established. ClientLoginBannerOptions *types.ClientLoginBannerOptions // Information about the client connection logging options. If you enable client // connection logging, data about client connections is sent to a Cloudwatch Logs // log stream. The following information is logged: - // - // * Client connection - // requests - // - // * Client connection results (successful and unsuccessful) - // - // * Reasons - // for unsuccessful client connection requests - // - // * Client connection termination - // time + // - Client connection requests + // - Client connection results (successful and unsuccessful) + // - Reasons for unsuccessful client connection requests + // - Client connection termination time ConnectionLogOptions *types.ConnectionLogOptions // A brief description of the Client VPN endpoint. Description *string - // Information about the DNS servers to be used by Client VPN connections. A Client - // VPN endpoint can have up to two DNS servers. + // Information about the DNS servers to be used by Client VPN connections. A + // Client VPN endpoint can have up to two DNS servers. DnsServers *types.DnsServersOptionsModifyStructure // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of one or more security groups to apply to the target network. @@ -86,8 +79,7 @@ type ModifyClientVpnEndpointInput struct { SessionTimeoutHours *int32 // Indicates whether the VPN is split-tunnel. For information about split-tunnel - // VPN endpoints, see Split-tunnel Client VPN endpoint - // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) + // VPN endpoints, see Split-tunnel Client VPN endpoint (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) // in the Client VPN Administrator Guide. SplitTunnel *bool diff --git a/service/ec2/api_op_ModifyDefaultCreditSpecification.go b/service/ec2/api_op_ModifyDefaultCreditSpecification.go index aafc7d5ef83..f1691a3a5a7 100644 --- a/service/ec2/api_op_ModifyDefaultCreditSpecification.go +++ b/service/ec2/api_op_ModifyDefaultCreditSpecification.go @@ -21,8 +21,7 @@ import ( // instances are launched during this operation, they might not get the new credit // option until the zone is updated. To verify whether the update has occurred, you // can call GetDefaultCreditSpecification and check DefaultCreditSpecification for -// updates. For more information, see Burstable performance instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) +// updates. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. func (c *Client) ModifyDefaultCreditSpecification(ctx context.Context, params *ModifyDefaultCreditSpecificationInput, optFns ...func(*Options)) (*ModifyDefaultCreditSpecificationOutput, error) { if params == nil { @@ -41,8 +40,8 @@ func (c *Client) ModifyDefaultCreditSpecification(ctx context.Context, params *M type ModifyDefaultCreditSpecificationInput struct { - // The credit option for CPU usage of the instance family. Valid Values: standard | - // unlimited + // The credit option for CPU usage of the instance family. Valid Values: standard + // | unlimited // // This member is required. CpuCredits *string @@ -54,8 +53,8 @@ type ModifyDefaultCreditSpecificationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go b/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go index c740a110d53..2a761a6a95a 100644 --- a/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go @@ -15,12 +15,12 @@ import ( // KMS key in each Region for use with encryption by default. If you change the // default KMS key to a symmetric customer managed KMS key, it is used instead of // the Amazon Web Services managed KMS key. To reset the default KMS key to the -// Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon -// EBS does not support asymmetric KMS keys. If you delete or disable the customer -// managed KMS key that you specified for use with encryption by default, your -// instances will fail to launch. For more information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId . +// Amazon EBS does not support asymmetric KMS keys. If you delete or disable the +// customer managed KMS key that you specified for use with encryption by default, +// your instances will fail to launch. For more information, see Amazon EBS +// encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ModifyEbsDefaultKmsKeyId(ctx context.Context, params *ModifyEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*ModifyEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &ModifyEbsDefaultKmsKeyIdInput{} @@ -38,36 +38,27 @@ func (c *Client) ModifyEbsDefaultKmsKeyId(ctx context.Context, params *ModifyEbs type ModifyEbsDefaultKmsKeyIdInput struct { - // The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS - // encryption. If this parameter is not specified, your KMS key for Amazon EBS is - // used. If KmsKeyId is specified, the encrypted state must be true. You can + // The identifier of the Key Management Service (KMS) KMS key to use for Amazon + // EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS + // is used. If KmsKeyId is specified, the encrypted state must be true . You can // specify the KMS key using any of the following: - // - // * Key ID. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Key alias. For example, - // alias/ExampleAlias. - // - // * Key ARN. For example, - // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Alias ARN. For example, - // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. - // - // Amazon Web Services - // authenticates the KMS key asynchronously. Therefore, if you specify an ID, - // alias, or ARN that is not valid, the action can appear to complete, but - // eventually fails. Amazon EBS does not support asymmetric KMS keys. + // - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + // - Key alias. For example, alias/ExampleAlias. + // - Key ARN. For example, + // arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // - Alias ARN. For example, + // arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. + // Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you + // specify an ID, alias, or ARN that is not valid, the action can appear to + // complete, but eventually fails. Amazon EBS does not support asymmetric KMS keys. // // This member is required. KmsKeyId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyFleet.go b/service/ec2/api_op_ModifyFleet.go index 44a87d91fa5..a65064432f6 100644 --- a/service/ec2/api_op_ModifyFleet.go +++ b/service/ec2/api_op_ModifyFleet.go @@ -12,23 +12,23 @@ import ( ) // Modifies the specified EC2 Fleet. You can only modify an EC2 Fleet request of -// type maintain. While the EC2 Fleet is being modified, it is in the modifying +// type maintain . While the EC2 Fleet is being modified, it is in the modifying // state. To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet // launches the additional Spot Instances according to the allocation strategy for -// the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet -// launches instances using the Spot Instance pool with the lowest price. If the -// allocation strategy is diversified, the EC2 Fleet distributes the instances -// across the Spot Instance pools. If the allocation strategy is -// capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with -// optimal capacity for the number of instances that are launching. To scale down -// your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any -// open requests that exceed the new target capacity. You can request that the EC2 -// Fleet terminate Spot Instances until the size of the fleet no longer exceeds the -// new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet +// the EC2 Fleet request. If the allocation strategy is lowest-price , the EC2 +// Fleet launches instances using the Spot Instance pool with the lowest price. If +// the allocation strategy is diversified , the EC2 Fleet distributes the instances +// across the Spot Instance pools. If the allocation strategy is capacity-optimized +// , EC2 Fleet launches instances from Spot Instance pools with optimal capacity +// for the number of instances that are launching. To scale down your EC2 Fleet, +// decrease its target capacity. First, the EC2 Fleet cancels any open requests +// that exceed the new target capacity. You can request that the EC2 Fleet +// terminate Spot Instances until the size of the fleet no longer exceeds the new +// target capacity. If the allocation strategy is lowest-price , the EC2 Fleet // terminates the instances with the highest price per unit. If the allocation -// strategy is capacity-optimized, the EC2 Fleet terminates the instances in the +// strategy is capacity-optimized , the EC2 Fleet terminates the instances in the // Spot Instance pools that have the least available Spot Instance capacity. If the -// allocation strategy is diversified, the EC2 Fleet terminates instances across +// allocation strategy is diversified , the EC2 Fleet terminates instances across // the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep // the fleet at its current size, but not replace any Spot Instances that are // interrupted or that you terminate manually. If you are finished with your EC2 @@ -61,13 +61,13 @@ type ModifyFleetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether running instances should be terminated if the total target // capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - // Supported only for fleets of type maintain. + // Supported only for fleets of type maintain . ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy // The launch template and overrides. @@ -81,7 +81,7 @@ type ModifyFleetInput struct { type ModifyFleetOutput struct { - // If the request succeeds, the response returns true. If the request fails, no + // If the request succeeds, the response returns true . If the request fails, no // response is returned, and instead an error message is returned. Return *bool diff --git a/service/ec2/api_op_ModifyFpgaImageAttribute.go b/service/ec2/api_op_ModifyFpgaImageAttribute.go index fd6beca0eb8..2805ef5394b 100644 --- a/service/ec2/api_op_ModifyFpgaImageAttribute.go +++ b/service/ec2/api_op_ModifyFpgaImageAttribute.go @@ -42,8 +42,8 @@ type ModifyFpgaImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The load permission for the AFI. @@ -63,8 +63,8 @@ type ModifyFpgaImageAttributeInput struct { // attribute. UserGroups []string - // The Amazon Web Services account IDs. This parameter is valid only when modifying - // the loadPermission attribute. + // The Amazon Web Services account IDs. This parameter is valid only when + // modifying the loadPermission attribute. UserIds []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyHosts.go b/service/ec2/api_op_ModifyHosts.go index b16d66d5313..54b7c189ca0 100644 --- a/service/ec2/api_op_ModifyHosts.go +++ b/service/ec2/api_op_ModifyHosts.go @@ -46,14 +46,12 @@ type ModifyHostsInput struct { AutoPlacement types.AutoPlacement // Indicates whether to enable or disable host maintenance for the Dedicated Host. - // For more information, see Host maintenance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) + // For more information, see Host maintenance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) // in the Amazon EC2 User Guide. HostMaintenance types.HostMaintenance - // Indicates whether to enable or disable host recovery for the Dedicated Host. For - // more information, see Host recovery - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) + // Indicates whether to enable or disable host recovery for the Dedicated Host. + // For more information, see Host recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) // in the Amazon EC2 User Guide. HostRecovery types.HostRecovery diff --git a/service/ec2/api_op_ModifyIdFormat.go b/service/ec2/api_op_ModifyIdFormat.go index 5c226f4bbd6..49f68db7a08 100644 --- a/service/ec2/api_op_ModifyIdFormat.go +++ b/service/ec2/api_op_ModifyIdFormat.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the ID format for the specified resource on a per-Region basis. You can -// specify that resources should receive longer IDs (17-character IDs) when they -// are created. This request can only be used to modify longer ID settings for +// Modifies the ID format for the specified resource on a per-Region basis. You +// can specify that resources should receive longer IDs (17-character IDs) when +// they are created. This request can only be used to modify longer ID settings for // resource types that are within the opt-in period. Resources currently in their // opt-in period include: bundle | conversion-task | customer-gateway | // dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | @@ -20,17 +20,16 @@ import ( // network-acl-association | network-interface | network-interface-attachment | // prefix-list | route-table | route-table-association | security-group | subnet | // subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint -// | vpc-peering-connection | vpn-connection | vpn-gateway. This setting applies to -// the IAM user who makes the request; it does not apply to the entire Amazon Web -// Services account. By default, an IAM user defaults to the same settings as the -// root user. If you're using this action as the root user, then these settings +// | vpc-peering-connection | vpn-connection | vpn-gateway . This setting applies +// to the IAM user who makes the request; it does not apply to the entire Amazon +// Web Services account. By default, an IAM user defaults to the same settings as +// the root user. If you're using this action as the root user, then these settings // apply to the entire account, unless an IAM user explicitly overrides these -// settings for themselves. For more information, see Resource IDs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the -// Amazon Elastic Compute Cloud User Guide. Resources created with longer IDs are -// visible to all IAM roles and users, regardless of these settings and provided -// that they have permission to use the relevant Describe command for the resource -// type. +// settings for themselves. For more information, see Resource IDs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) +// in the Amazon Elastic Compute Cloud User Guide. Resources created with longer +// IDs are visible to all IAM roles and users, regardless of these settings and +// provided that they have permission to use the relevant Describe command for the +// resource type. func (c *Client) ModifyIdFormat(ctx context.Context, params *ModifyIdFormatInput, optFns ...func(*Options)) (*ModifyIdFormatOutput, error) { if params == nil { params = &ModifyIdFormatInput{} @@ -50,11 +49,11 @@ type ModifyIdFormatInput struct { // The type of resource: bundle | conversion-task | customer-gateway | dhcp-options // | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | - // image | import-task | internet-gateway | network-acl | network-acl-association | - // network-interface | network-interface-attachment | prefix-list | route-table | - // route-table-association | security-group | subnet | + // image | import-task | internet-gateway | network-acl | network-acl-association + // | network-interface | network-interface-attachment | prefix-list | route-table + // | route-table-association | security-group | subnet | // subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint - // | vpc-peering-connection | vpn-connection | vpn-gateway. Alternatively, use the + // | vpc-peering-connection | vpn-connection | vpn-gateway . Alternatively, use the // all-current option to include all resource types that are currently within their // opt-in period for longer IDs. // diff --git a/service/ec2/api_op_ModifyIdentityIdFormat.go b/service/ec2/api_op_ModifyIdentityIdFormat.go index f18a19e84b1..a04f5ffda8f 100644 --- a/service/ec2/api_op_ModifyIdentityIdFormat.go +++ b/service/ec2/api_op_ModifyIdentityIdFormat.go @@ -21,14 +21,13 @@ import ( // | network-acl-association | network-interface | network-interface-attachment | // prefix-list | route-table | route-table-association | security-group | subnet | // subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint -// | vpc-peering-connection | vpn-connection | vpn-gateway. For more information, -// see Resource IDs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the -// Amazon Elastic Compute Cloud User Guide. This setting applies to the principal -// specified in the request; it does not apply to the principal that makes the -// request. Resources created with longer IDs are visible to all IAM roles and -// users, regardless of these settings and provided that they have permission to -// use the relevant Describe command for the resource type. +// | vpc-peering-connection | vpn-connection | vpn-gateway . For more information, +// see Resource IDs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) +// in the Amazon Elastic Compute Cloud User Guide. This setting applies to the +// principal specified in the request; it does not apply to the principal that +// makes the request. Resources created with longer IDs are visible to all IAM +// roles and users, regardless of these settings and provided that they have +// permission to use the relevant Describe command for the resource type. func (c *Client) ModifyIdentityIdFormat(ctx context.Context, params *ModifyIdentityIdFormatInput, optFns ...func(*Options)) (*ModifyIdentityIdFormatOutput, error) { if params == nil { params = &ModifyIdentityIdFormatInput{} @@ -55,11 +54,11 @@ type ModifyIdentityIdFormatInput struct { // The type of resource: bundle | conversion-task | customer-gateway | dhcp-options // | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | - // image | import-task | internet-gateway | network-acl | network-acl-association | - // network-interface | network-interface-attachment | prefix-list | route-table | - // route-table-association | security-group | subnet | + // image | import-task | internet-gateway | network-acl | network-acl-association + // | network-interface | network-interface-attachment | prefix-list | route-table + // | route-table-association | security-group | subnet | // subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint - // | vpc-peering-connection | vpn-connection | vpn-gateway. Alternatively, use the + // | vpc-peering-connection | vpn-connection | vpn-gateway . Alternatively, use the // all-current option to include all resource types that are currently within their // opt-in period for longer IDs. // diff --git a/service/ec2/api_op_ModifyImageAttribute.go b/service/ec2/api_op_ModifyImageAttribute.go index d88cab48009..bc05397c054 100644 --- a/service/ec2/api_op_ModifyImageAttribute.go +++ b/service/ec2/api_op_ModifyImageAttribute.go @@ -13,8 +13,8 @@ import ( // Modifies the specified attribute of the specified AMI. You can specify only one // attribute at a time. To specify the attribute, you can use the Attribute -// parameter, or one of the following parameters: Description, ImdsSupport, or -// LaunchPermission. Images with an Amazon Web Services Marketplace product code +// parameter, or one of the following parameters: Description , ImdsSupport , or +// LaunchPermission . Images with an Amazon Web Services Marketplace product code // cannot be made public. To enable the SriovNetSupport enhanced networking // attribute of an image, enable SriovNetSupport on an instance and create an AMI // from the instance. @@ -50,49 +50,48 @@ type ModifyImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched // from this AMI will have HttpTokens automatically set to required so that, by // default, the instance requires that IMDSv2 is used when requesting instance - // metadata. In addition, HttpPutResponseHopLimit is set to 2. For more - // information, see Configure the AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) + // metadata. In addition, HttpPutResponseHopLimit is set to 2 . For more + // information, see Configure the AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) // in the Amazon EC2 User Guide. Do not use this parameter unless your AMI software - // supports IMDSv2. After you set the value to v2.0, you can't undo it. The only + // supports IMDSv2. After you set the value to v2.0 , you can't undo it. The only // way to “reset” your AMI is to create a new AMI from the underlying snapshot. ImdsSupport *types.AttributeValue // A new launch permission for the AMI. LaunchPermission *types.LaunchPermissionModifications - // The operation type. This parameter can be used only when the Attribute parameter - // is launchPermission. + // The operation type. This parameter can be used only when the Attribute + // parameter is launchPermission . OperationType types.OperationType // The Amazon Resource Name (ARN) of an organization. This parameter can be used - // only when the Attribute parameter is launchPermission. + // only when the Attribute parameter is launchPermission . OrganizationArns []string // The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter - // can be used only when the Attribute parameter is launchPermission. + // can be used only when the Attribute parameter is launchPermission . OrganizationalUnitArns []string // Not supported. ProductCodes []string - // The user groups. This parameter can be used only when the Attribute parameter is - // launchPermission. + // The user groups. This parameter can be used only when the Attribute parameter + // is launchPermission . UserGroups []string // The Amazon Web Services account IDs. This parameter can be used only when the - // Attribute parameter is launchPermission. + // Attribute parameter is launchPermission . UserIds []string // The value of the attribute being modified. This parameter can be used only when - // the Attribute parameter is description or imdsSupport. + // the Attribute parameter is description or imdsSupport . Value *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceAttribute.go b/service/ec2/api_op_ModifyInstanceAttribute.go index 4e848f51d19..eabc7a6801d 100644 --- a/service/ec2/api_op_ModifyInstanceAttribute.go +++ b/service/ec2/api_op_ModifyInstanceAttribute.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified attribute of the specified instance. You can specify only -// one attribute at a time. Note: Using this action to change the security groups -// associated with an elastic network interface (ENI) attached to an instance in a -// VPC can result in an error if the instance has more than one ENI. To change the -// security groups associated with an ENI attached to an instance that has multiple -// ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action. To -// modify some attributes, the instance must be stopped. For more information, see -// Modify a stopped instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html) +// Modifies the specified attribute of the specified instance. You can specify +// only one attribute at a time. Note: Using this action to change the security +// groups associated with an elastic network interface (ENI) attached to an +// instance in a VPC can result in an error if the instance has more than one ENI. +// To change the security groups associated with an ENI attached to an instance +// that has multiple ENIs, we recommend that you use the +// ModifyNetworkInterfaceAttribute action. To modify some attributes, the instance +// must be stopped. For more information, see Modify a stopped instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html) // in the Amazon EC2 User Guide. func (c *Client) ModifyInstanceAttribute(ctx context.Context, params *ModifyInstanceAttributeInput, optFns ...func(*Options)) (*ModifyInstanceAttributeOutput, error) { if params == nil { @@ -52,28 +51,27 @@ type ModifyInstanceAttributeInput struct { // Modifies the DeleteOnTermination attribute for volumes that are currently // attached. The volume must be owned by the caller. If no value is specified for - // DeleteOnTermination, the default is true and the volume is deleted when the + // DeleteOnTermination , the default is true and the volume is deleted when the // instance is terminated. To add instance store volumes to an Amazon EBS-backed // instance, you must add them when you launch the instance. For more information, - // see Update the block device mapping when launching an instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM) + // see Update the block device mapping when launching an instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM) // in the Amazon EC2 User Guide. BlockDeviceMappings []types.InstanceBlockDeviceMappingSpecification // Indicates whether an instance is enabled for stop protection. For more - // information, see Stop Protection - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection). + // information, see Stop Protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) + // . DisableApiStop *types.AttributeBooleanValue - // If the value is true, you can't terminate the instance using the Amazon EC2 + // If the value is true , you can't terminate the instance using the Amazon EC2 // console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot // Instances. DisableApiTermination *types.AttributeBooleanValue // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specifies whether the instance is optimized for Amazon EBS I/O. This @@ -83,9 +81,9 @@ type ModifyInstanceAttributeInput struct { // using an EBS Optimized instance. EbsOptimized *types.AttributeBooleanValue - // Set to true to enable enhanced networking with ENA for the instance. This option - // is supported only for HVM instances. Specifying this option with a PV instance - // can make it unreachable. + // Set to true to enable enhanced networking with ENA for the instance. This + // option is supported only for HVM instances. Specifying this option with a PV + // instance can make it unreachable. EnaSupport *types.AttributeBooleanValue // [EC2-VPC] Replaces the security groups of the instance with the specified @@ -99,26 +97,25 @@ type ModifyInstanceAttributeInput struct { InstanceInitiatedShutdownBehavior *types.AttributeValue // Changes the instance type to the specified value. For more information, see - // Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. If the instance type is not valid, the error returned is - // InvalidInstanceAttributeValue. + // Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. If the instance type is not valid, the error + // returned is InvalidInstanceAttributeValue . InstanceType *types.AttributeValue // Changes the instance's kernel to the specified value. We recommend that you use - // PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). + // PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) + // . Kernel *types.AttributeValue // Changes the instance's RAM disk to the specified value. We recommend that you - // use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). + // use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) + // . Ramdisk *types.AttributeValue // Enable or disable source/destination checks, which ensure that the instance is // either the source or the destination of any traffic that it receives. If the - // value is true, source/destination checks are enabled; otherwise, they are - // disabled. The default value is true. You must disable source/destination checks + // value is true , source/destination checks are enabled; otherwise, they are + // disabled. The default value is true . You must disable source/destination checks // if the instance runs services such as network address translation, routing, or // firewalls. SourceDestCheck *types.AttributeBooleanValue @@ -136,8 +133,8 @@ type ModifyInstanceAttributeInput struct { // base64-encoded text. UserData *types.BlobAttributeValue - // A new value for the attribute. Use only with the kernel, ramdisk, userData, - // disableApiTermination, or instanceInitiatedShutdownBehavior attribute. + // A new value for the attribute. Use only with the kernel , ramdisk , userData , + // disableApiTermination , or instanceInitiatedShutdownBehavior attribute. Value *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go b/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go index 29e292d33f1..3a36a01fd3d 100644 --- a/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go +++ b/service/ec2/api_op_ModifyInstanceCapacityReservationAttributes.go @@ -44,8 +44,8 @@ type ModifyInstanceCapacityReservationAttributesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceCreditSpecification.go b/service/ec2/api_op_ModifyInstanceCreditSpecification.go index 6922844a7a4..f7fe7328a5a 100644 --- a/service/ec2/api_op_ModifyInstanceCreditSpecification.go +++ b/service/ec2/api_op_ModifyInstanceCreditSpecification.go @@ -12,9 +12,8 @@ import ( ) // Modifies the credit option for CPU usage on a running or stopped burstable -// performance instance. The credit options are standard and unlimited. For more -// information, see Burstable performance instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) +// performance instance. The credit options are standard and unlimited . For more +// information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. func (c *Client) ModifyInstanceCreditSpecification(ctx context.Context, params *ModifyInstanceCreditSpecificationInput, optFns ...func(*Options)) (*ModifyInstanceCreditSpecificationOutput, error) { if params == nil { @@ -39,14 +38,14 @@ type ModifyInstanceCreditSpecificationInput struct { InstanceCreditSpecifications []types.InstanceCreditSpecificationRequest // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceEventStartTime.go b/service/ec2/api_op_ModifyInstanceEventStartTime.go index 4324adf285d..25d63436c9f 100644 --- a/service/ec2/api_op_ModifyInstanceEventStartTime.go +++ b/service/ec2/api_op_ModifyInstanceEventStartTime.go @@ -47,8 +47,8 @@ type ModifyInstanceEventStartTimeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceEventWindow.go b/service/ec2/api_op_ModifyInstanceEventWindow.go index 9e55ec8aa61..539f30f6a9a 100644 --- a/service/ec2/api_op_ModifyInstanceEventWindow.go +++ b/service/ec2/api_op_ModifyInstanceEventWindow.go @@ -17,9 +17,8 @@ import ( // AssociateInstanceEventWindow and DisassociateInstanceEventWindow API. If Amazon // Web Services has already scheduled an event, modifying an event window won't // change the time of the scheduled event. For more information, see Define event -// windows for scheduled events -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the -// Amazon EC2 User Guide. +// windows for scheduled events (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) +// in the Amazon EC2 User Guide. func (c *Client) ModifyInstanceEventWindow(ctx context.Context, params *ModifyInstanceEventWindowInput, optFns ...func(*Options)) (*ModifyInstanceEventWindowOutput, error) { if params == nil { params = &ModifyInstanceEventWindowInput{} @@ -42,35 +41,25 @@ type ModifyInstanceEventWindowInput struct { // This member is required. InstanceEventWindowId *string - // The cron expression of the event window, for example, * 0-4,20-23 * * 1,5. + // The cron expression of the event window, for example, * 0-4,20-23 * * 1,5 . // Constraints: - // - // * Only hour and day of the week values are supported. - // - // * For day - // of the week values, you can specify either integers 0 through 6, or alternative - // single values SUN through SAT. - // - // * The minute, month, and year must be specified - // by *. - // - // * The hour value must be one or a multiple range, for example, 0-4 or - // 0-4,20-23. - // - // * Each hour range must be >= 2 hours, for example, 0-2 or 20-23. - // - // * - // The event window must be >= 4 hours. The combined total time ranges in the event - // window must be >= 4 hours. - // - // For more information about cron expressions, see - // cron (https://en.wikipedia.org/wiki/Cron) on the Wikipedia website. + // - Only hour and day of the week values are supported. + // - For day of the week values, you can specify either integers 0 through 6 , or + // alternative single values SUN through SAT . + // - The minute, month, and year must be specified by * . + // - The hour value must be one or a multiple range, for example, 0-4 or + // 0-4,20-23 . + // - Each hour range must be >= 2 hours, for example, 0-2 or 20-23 . + // - The event window must be >= 4 hours. The combined total time ranges in the + // event window must be >= 4 hours. + // For more information about cron expressions, see cron (https://en.wikipedia.org/wiki/Cron) + // on the Wikipedia website. CronExpression *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name of the event window. diff --git a/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go b/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go index cf45394ac0f..3130885397e 100644 --- a/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go +++ b/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go @@ -14,8 +14,8 @@ import ( // Modifies the recovery behavior of your instance to disable simplified automatic // recovery or set the recovery behavior to default. The default configuration will // not enable simplified automatic recovery for an unsupported instance type. For -// more information, see Simplified automatic recovery -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery). +// more information, see Simplified automatic recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery) +// . func (c *Client) ModifyInstanceMaintenanceOptions(ctx context.Context, params *ModifyInstanceMaintenanceOptionsInput, optFns ...func(*Options)) (*ModifyInstanceMaintenanceOptionsOutput, error) { if params == nil { params = &ModifyInstanceMaintenanceOptionsInput{} @@ -43,8 +43,8 @@ type ModifyInstanceMaintenanceOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceMetadataOptions.go b/service/ec2/api_op_ModifyInstanceMetadataOptions.go index f68d37ebcca..3141536566c 100644 --- a/service/ec2/api_op_ModifyInstanceMetadataOptions.go +++ b/service/ec2/api_op_ModifyInstanceMetadataOptions.go @@ -17,8 +17,7 @@ import ( // API responds with a state of “pending”. After the parameter modifications are // successfully applied to the instance, the state of the modifications changes // from “pending” to “applied” in subsequent describe-instances API calls. For more -// information, see Instance metadata and user data -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) +// information, see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon EC2 User Guide. func (c *Client) ModifyInstanceMetadataOptions(ctx context.Context, params *ModifyInstanceMetadataOptionsInput, optFns ...func(*Options)) (*ModifyInstanceMetadataOptionsOutput, error) { if params == nil { @@ -44,13 +43,13 @@ type ModifyInstanceMetadataOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Enables or disables the HTTP metadata endpoint on your instances. If this // parameter is not specified, the existing state is maintained. If you specify a - // value of disabled, you cannot access your instance metadata. + // value of disabled , you cannot access your instance metadata. HttpEndpoint types.InstanceMetadataEndpointState // Enables or disables the IPv6 endpoint for the instance metadata service. This @@ -64,29 +63,24 @@ type ModifyInstanceMetadataOptionsInput struct { HttpPutResponseHopLimit *int32 // IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in - // other words, set the use of IMDSv2 to optional) or required (in other words, set - // the use of IMDSv2 to required). - // - // * optional - When IMDSv2 is optional, you can - // choose to retrieve instance metadata with or without a session token in your - // request. If you retrieve the IAM role credentials without a token, the IMDSv1 - // role credentials are returned. If you retrieve the IAM role credentials using a - // valid session token, the IMDSv2 role credentials are returned. - // - // * required - - // When IMDSv2 is required, you must send a session token with any instance - // metadata retrieval requests. In this state, retrieving the IAM role credentials - // always returns IMDSv2 credentials; IMDSv1 credentials are not - // available. - // + // other words, set the use of IMDSv2 to optional ) or required (in other words, + // set the use of IMDSv2 to required ). + // - optional - When IMDSv2 is optional, you can choose to retrieve instance + // metadata with or without a session token in your request. If you retrieve the + // IAM role credentials without a token, the IMDSv1 role credentials are returned. + // If you retrieve the IAM role credentials using a valid session token, the IMDSv2 + // role credentials are returned. + // - required - When IMDSv2 is required, you must send a session token with any + // instance metadata retrieval requests. In this state, retrieving the IAM role + // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not + // available. // Default: optional HttpTokens types.HttpTokensState // Set to enabled to allow access to instance tags from the instance metadata. Set // to disabled to turn off access to instance tags from the instance metadata. For - // more information, see Work with instance tags using the instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). - // Default: disabled + // more information, see Work with instance tags using the instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // . Default: disabled InstanceMetadataTags types.InstanceMetadataTagsState noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstancePlacement.go b/service/ec2/api_op_ModifyInstancePlacement.go index 1b083ea0ff3..15786e22c5f 100644 --- a/service/ec2/api_op_ModifyInstancePlacement.go +++ b/service/ec2/api_op_ModifyInstancePlacement.go @@ -13,28 +13,20 @@ import ( // Modifies the placement attributes for a specified instance. You can do the // following: +// - Modify the affinity between an instance and a Dedicated Host (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) +// . When affinity is set to host and the instance is not associated with a +// specific Dedicated Host, the next time the instance is launched, it is +// automatically associated with the host on which it lands. If the instance is +// restarted or rebooted, this relationship persists. +// - Change the Dedicated Host with which an instance is associated. +// - Change the instance tenancy of an instance. +// - Move an instance to or from a placement group (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) +// . // -// * Modify the affinity between an instance and a Dedicated Host -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html). -// When affinity is set to host and the instance is not associated with a specific -// Dedicated Host, the next time the instance is launched, it is automatically -// associated with the host on which it lands. If the instance is restarted or -// rebooted, this relationship persists. -// -// * Change the Dedicated Host with which an -// instance is associated. -// -// * Change the instance tenancy of an instance. -// -// * Move -// an instance to or from a placement group -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html). -// -// At -// least one attribute for affinity, host ID, tenancy, or placement group name must -// be specified in the request. Affinity and tenancy can be modified in the same -// request. To modify the host ID, tenancy, placement group, or partition for an -// instance, the instance must be in the stopped state. +// At least one attribute for affinity, host ID, tenancy, or placement group name +// must be specified in the request. Affinity and tenancy can be modified in the +// same request. To modify the host ID, tenancy, placement group, or partition for +// an instance, the instance must be in the stopped state. func (c *Client) ModifyInstancePlacement(ctx context.Context, params *ModifyInstancePlacementInput, optFns ...func(*Options)) (*ModifyInstancePlacementOutput, error) { if params == nil { params = &ModifyInstancePlacementInput{} @@ -60,15 +52,15 @@ type ModifyInstancePlacementInput struct { // The affinity setting for the instance. Affinity types.Affinity - // The Group Id of a placement group. You must specify the Placement Group Group Id - // to launch an instance in a shared placement group. + // The Group Id of a placement group. You must specify the Placement Group Group + // Id to launch an instance in a shared placement group. GroupId *string // The name of the placement group in which to place the instance. For spread - // placement groups, the instance must have a tenancy of default. For cluster and + // placement groups, the instance must have a tenancy of default . For cluster and // partition placement groups, the instance must have a tenancy of default or - // dedicated. To remove an instance from a placement group, specify an empty string - // (""). + // dedicated . To remove an instance from a placement group, specify an empty + // string (""). GroupName *string // The ID of the Dedicated Host with which to associate the instance. @@ -78,11 +70,11 @@ type ModifyInstancePlacementInput struct { HostResourceGroupArn *string // The number of the partition in which to place the instance. Valid only if the - // placement group strategy is set to partition. + // placement group strategy is set to partition . PartitionNumber *int32 // The tenancy for the instance. For T3 instances, you can't change the tenancy - // from dedicated to host, or from host to dedicated. Attempting to make one of + // from dedicated to host , or from host to dedicated . Attempting to make one of // these unsupported tenancy changes results in the InvalidTenancy error code. Tenancy types.HostTenancy diff --git a/service/ec2/api_op_ModifyIpam.go b/service/ec2/api_op_ModifyIpam.go index 898934cd44b..a25be17dc21 100644 --- a/service/ec2/api_op_ModifyIpam.go +++ b/service/ec2/api_op_ModifyIpam.go @@ -47,8 +47,8 @@ type ModifyIpamInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The operating Regions to remove. diff --git a/service/ec2/api_op_ModifyIpamPool.go b/service/ec2/api_op_ModifyIpamPool.go index 8d427fc89ff..8fea34c6fec 100644 --- a/service/ec2/api_op_ModifyIpamPool.go +++ b/service/ec2/api_op_ModifyIpamPool.go @@ -36,10 +36,9 @@ type ModifyIpamPoolInput struct { // This member is required. IpamPoolId *string - // Add tag allocation rules to a pool. For more information about allocation rules, - // see Create a top-level pool - // (https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) in the Amazon - // VPC IPAM User Guide. + // Add tag allocation rules to a pool. For more information about allocation + // rules, see Create a top-level pool (https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) + // in the Amazon VPC IPAM User Guide. AddAllocationResourceTags []types.RequestIpamResourceTag // The default netmask length for allocations added to this pool. If, for example, @@ -47,27 +46,27 @@ type ModifyIpamPoolInput struct { // allocations will default to 10.0.0.0/16. AllocationDefaultNetmaskLength *int32 - // The maximum netmask length possible for CIDR allocations in this IPAM pool to be - // compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // The maximum netmask length possible for CIDR allocations in this IPAM pool to + // be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible // netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must // be greater than the minimum netmask length. AllocationMaxNetmaskLength *int32 - // The minimum netmask length required for CIDR allocations in this IPAM pool to be - // compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // The minimum netmask length required for CIDR allocations in this IPAM pool to + // be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible // netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must // be less than the maximum netmask length. AllocationMinNetmaskLength *int32 - // If true, IPAM will continuously look for resources within the CIDR range of this - // pool and automatically import them as allocations into your IPAM. The CIDRs that - // will be allocated for these resources must not already be allocated to other - // resources in order for the import to succeed. IPAM will import a CIDR regardless - // of its compliance with the pool's allocation rules, so a resource might be - // imported and subsequently marked as noncompliant. If IPAM discovers multiple - // CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers - // multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. - // A locale must be set on the pool for this feature to work. + // If true, IPAM will continuously look for resources within the CIDR range of + // this pool and automatically import them as allocations into your IPAM. The CIDRs + // that will be allocated for these resources must not already be allocated to + // other resources in order for the import to succeed. IPAM will import a CIDR + // regardless of its compliance with the pool's allocation rules, so a resource + // might be imported and subsequently marked as noncompliant. If IPAM discovers + // multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM + // discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of + // them only. A locale must be set on the pool for this feature to work. AutoImport *bool // Clear the default netmask length allocation rule for this pool. @@ -78,8 +77,8 @@ type ModifyIpamPoolInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Remove tag allocation rules from a pool. diff --git a/service/ec2/api_op_ModifyIpamResourceCidr.go b/service/ec2/api_op_ModifyIpamResourceCidr.go index 5cc34fbf860..c37f20572e7 100644 --- a/service/ec2/api_op_ModifyIpamResourceCidr.go +++ b/service/ec2/api_op_ModifyIpamResourceCidr.go @@ -15,10 +15,8 @@ import ( // between scopes and ignore resource CIDRs that you do not want to manage. If set // to false, the resource will not be tracked for overlap, it cannot be // auto-imported into a pool, and it will be removed from any pool it has an -// allocation in. For more information, see Move resource CIDRs between scopes -// (https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html) and Change -// the monitoring state of resource CIDRs -// (https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html) +// allocation in. For more information, see Move resource CIDRs between scopes (https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html) +// and Change the monitoring state of resource CIDRs (https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html) // in the Amazon VPC IPAM User Guide. func (c *Client) ModifyIpamResourceCidr(ctx context.Context, params *ModifyIpamResourceCidrInput, optFns ...func(*Options)) (*ModifyIpamResourceCidrOutput, error) { if params == nil { @@ -42,8 +40,8 @@ type ModifyIpamResourceCidrInput struct { // This member is required. CurrentIpamScopeId *string - // Determines if the resource is monitored by IPAM. If a resource is monitored, the - // resource is discovered by IPAM and you can view details about the resource’s + // Determines if the resource is monitored by IPAM. If a resource is monitored, + // the resource is discovered by IPAM and you can view details about the resource’s // CIDR. // // This member is required. @@ -69,8 +67,8 @@ type ModifyIpamResourceCidrInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyIpamResourceDiscovery.go b/service/ec2/api_op_ModifyIpamResourceDiscovery.go index 69cda3c4d1f..9d1b5018bf0 100644 --- a/service/ec2/api_op_ModifyIpamResourceDiscovery.go +++ b/service/ec2/api_op_ModifyIpamResourceDiscovery.go @@ -46,8 +46,8 @@ type ModifyIpamResourceDiscoveryInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Remove operating Regions. diff --git a/service/ec2/api_op_ModifyIpamScope.go b/service/ec2/api_op_ModifyIpamScope.go index 87df9064763..189871504b7 100644 --- a/service/ec2/api_op_ModifyIpamScope.go +++ b/service/ec2/api_op_ModifyIpamScope.go @@ -39,8 +39,8 @@ type ModifyIpamScopeInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyLaunchTemplate.go b/service/ec2/api_op_ModifyLaunchTemplate.go index f5e801f7ff8..4a658222b5b 100644 --- a/service/ec2/api_op_ModifyLaunchTemplate.go +++ b/service/ec2/api_op_ModifyLaunchTemplate.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies a launch template. You can specify which version of the launch template -// to set as the default version. When launching an instance, the default version -// applies when a launch template version is not specified. +// Modifies a launch template. You can specify which version of the launch +// template to set as the default version. When launching an instance, the default +// version applies when a launch template version is not specified. func (c *Client) ModifyLaunchTemplate(ctx context.Context, params *ModifyLaunchTemplateInput, optFns ...func(*Options)) (*ModifyLaunchTemplateOutput, error) { if params == nil { params = &ModifyLaunchTemplateInput{} @@ -32,9 +32,8 @@ func (c *Client) ModifyLaunchTemplate(ctx context.Context, params *ModifyLaunchT type ModifyLaunchTemplateInput struct { // Unique, case-sensitive identifier you provide to ensure the idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraint: Maximum 128 ASCII characters. + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraint: Maximum 128 ASCII characters. ClientToken *string // The version number of the launch template to set as the default version. @@ -42,16 +41,16 @@ type ModifyLaunchTemplateInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the launch template. You must specify either the LaunchTemplateId or - // the LaunchTemplateName, but not both. + // the LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify either the LaunchTemplateName - // or the LaunchTemplateId, but not both. + // or the LaunchTemplateId , but not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyLocalGatewayRoute.go b/service/ec2/api_op_ModifyLocalGatewayRoute.go index ba9c1946458..a5c6a06d6d7 100644 --- a/service/ec2/api_op_ModifyLocalGatewayRoute.go +++ b/service/ec2/api_op_ModifyLocalGatewayRoute.go @@ -38,15 +38,15 @@ type ModifyLocalGatewayRouteInput struct { // match the CIDR of an existing route in the table. DestinationCidrBlock *string - // The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. + // The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock . // You cannot use DestinationPrefixListId and DestinationCidrBlock in the same // request. DestinationPrefixListId *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the virtual interface group. diff --git a/service/ec2/api_op_ModifyManagedPrefixList.go b/service/ec2/api_op_ModifyManagedPrefixList.go index bc0e73113ab..4d41b381a29 100644 --- a/service/ec2/api_op_ModifyManagedPrefixList.go +++ b/service/ec2/api_op_ModifyManagedPrefixList.go @@ -45,15 +45,15 @@ type ModifyManagedPrefixListInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The maximum number of entries for the prefix list. You cannot modify the entries - // of a prefix list and modify the size of a prefix list at the same time. If any - // of the resources that reference the prefix list cannot support the new maximum - // size, the modify operation fails. Check the state message for the IDs of the - // first ten resources that do not support the new maximum size. + // The maximum number of entries for the prefix list. You cannot modify the + // entries of a prefix list and modify the size of a prefix list at the same time. + // If any of the resources that reference the prefix list cannot support the new + // maximum size, the modify operation fails. Check the state message for the IDs of + // the first ten resources that do not support the new maximum size. MaxEntries *int32 // A name for the prefix list. diff --git a/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go b/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go index ed3b6f85da2..0d81b163ee2 100644 --- a/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_ModifyNetworkInterfaceAttribute.go @@ -46,24 +46,24 @@ type ModifyNetworkInterfaceAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Updates the ENA Express configuration for the network interface that’s attached // to the instance. EnaSrdSpecification *types.EnaSrdSpecification - // Changes the security groups for the network interface. The new set of groups you - // specify replaces the current set. You must specify at least one group, even if - // it's just the default security group in the VPC. You must specify the ID of the - // security group, not the name. + // Changes the security groups for the network interface. The new set of groups + // you specify replaces the current set. You must specify at least one group, even + // if it's just the default security group in the VPC. You must specify the ID of + // the security group, not the name. Groups []string // Enable or disable source/destination checks, which ensure that the instance is // either the source or the destination of any traffic that it receives. If the - // value is true, source/destination checks are enabled; otherwise, they are - // disabled. The default value is true. You must disable source/destination checks + // value is true , source/destination checks are enabled; otherwise, they are + // disabled. The default value is true . You must disable source/destination checks // if the instance runs services such as network address translation, routing, or // firewalls. SourceDestCheck *types.AttributeBooleanValue diff --git a/service/ec2/api_op_ModifyPrivateDnsNameOptions.go b/service/ec2/api_op_ModifyPrivateDnsNameOptions.go index cf2235043ab..d468350b88e 100644 --- a/service/ec2/api_op_ModifyPrivateDnsNameOptions.go +++ b/service/ec2/api_op_ModifyPrivateDnsNameOptions.go @@ -36,12 +36,12 @@ type ModifyPrivateDnsNameOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord *bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A diff --git a/service/ec2/api_op_ModifyReservedInstances.go b/service/ec2/api_op_ModifyReservedInstances.go index d6fe557e757..082400701a6 100644 --- a/service/ec2/api_op_ModifyReservedInstances.go +++ b/service/ec2/api_op_ModifyReservedInstances.go @@ -14,13 +14,11 @@ import ( // Modifies the configuration of your Reserved Instances, such as the Availability // Zone, instance count, or instance type. The Reserved Instances to be modified // must be identical, except for Availability Zone, network platform, and instance -// type. For more information, see Modifying Reserved Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) in the -// Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you +// type. For more information, see Modifying Reserved Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) +// in the Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you // migrate from EC2-Classic to a VPC. For more information, see Migrate from -// EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ModifyReservedInstances(ctx context.Context, params *ModifyReservedInstancesInput, optFns ...func(*Options)) (*ModifyReservedInstancesOutput, error) { if params == nil { params = &ModifyReservedInstancesInput{} @@ -50,8 +48,8 @@ type ModifyReservedInstancesInput struct { TargetConfigurations []types.ReservedInstancesConfiguration // A unique, case-sensitive token you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifySecurityGroupRules.go b/service/ec2/api_op_ModifySecurityGroupRules.go index e7650f8768b..f10c58a8bb8 100644 --- a/service/ec2/api_op_ModifySecurityGroupRules.go +++ b/service/ec2/api_op_ModifySecurityGroupRules.go @@ -41,8 +41,8 @@ type ModifySecurityGroupRulesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifySnapshotAttribute.go b/service/ec2/api_op_ModifySnapshotAttribute.go index 990a359d061..f473fdaa37b 100644 --- a/service/ec2/api_op_ModifySnapshotAttribute.go +++ b/service/ec2/api_op_ModifySnapshotAttribute.go @@ -19,8 +19,7 @@ import ( // operation. Encrypted snapshots and snapshots with Amazon Web Services // Marketplace product codes cannot be made public. Snapshots encrypted with your // default KMS key cannot be shared with other accounts. For more information about -// modifying snapshot permissions, see Share a snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html) +// modifying snapshot permissions, see Share a snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ModifySnapshotAttribute(ctx context.Context, params *ModifySnapshotAttributeInput, optFns ...func(*Options)) (*ModifySnapshotAttributeOutput, error) { if params == nil { @@ -53,8 +52,8 @@ type ModifySnapshotAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The group to modify for the snapshot. diff --git a/service/ec2/api_op_ModifySnapshotTier.go b/service/ec2/api_op_ModifySnapshotTier.go index 52495e3a7a9..921eeed4370 100644 --- a/service/ec2/api_op_ModifySnapshotTier.go +++ b/service/ec2/api_op_ModifySnapshotTier.go @@ -12,12 +12,11 @@ import ( "time" ) -// Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to -// a full snapshot that includes all of the blocks of data that were written to the -// volume at the time the snapshot was created, and moved from the standard tier to -// the archive tier. For more information, see Archive Amazon EBS snapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-archive.html) in -// the Amazon Elastic Compute Cloud User Guide. +// Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted +// to a full snapshot that includes all of the blocks of data that were written to +// the volume at the time the snapshot was created, and moved from the standard +// tier to the archive tier. For more information, see Archive Amazon EBS snapshots (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-archive.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ModifySnapshotTier(ctx context.Context, params *ModifySnapshotTierInput, optFns ...func(*Options)) (*ModifySnapshotTierOutput, error) { if params == nil { params = &ModifySnapshotTierInput{} @@ -42,11 +41,11 @@ type ModifySnapshotTierInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The name of the storage tier. You must specify archive. + // The name of the storage tier. You must specify archive . StorageTier types.TargetStorageTier noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifySpotFleetRequest.go b/service/ec2/api_op_ModifySpotFleetRequest.go index 7e226a27939..5a025f15e0a 100644 --- a/service/ec2/api_op_ModifySpotFleetRequest.go +++ b/service/ec2/api_op_ModifySpotFleetRequest.go @@ -12,28 +12,28 @@ import ( ) // Modifies the specified Spot Fleet request. You can only modify a Spot Fleet -// request of type maintain. While the Spot Fleet request is being modified, it is +// request of type maintain . While the Spot Fleet request is being modified, it is // in the modifying state. To scale up your Spot Fleet, increase its target // capacity. The Spot Fleet launches the additional Spot Instances according to the // allocation strategy for the Spot Fleet request. If the allocation strategy is -// lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with -// the lowest price. If the allocation strategy is diversified, the Spot Fleet -// distributes the instances across the Spot Instance pools. If the allocation -// strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance -// pools with optimal capacity for the number of instances that are launching. To -// scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet -// cancels any open requests that exceed the new target capacity. You can request -// that the Spot Fleet terminate Spot Instances until the size of the fleet no -// longer exceeds the new target capacity. If the allocation strategy is -// lowestPrice, the Spot Fleet terminates the instances with the highest price per -// unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates -// the instances in the Spot Instance pools that have the least available Spot -// Instance capacity. If the allocation strategy is diversified, the Spot Fleet -// terminates instances across the Spot Instance pools. Alternatively, you can -// request that the Spot Fleet keep the fleet at its current size, but not replace -// any Spot Instances that are interrupted or that you terminate manually. If you -// are finished with your Spot Fleet for now, but will use it again later, you can -// set the target capacity to 0. +// lowestPrice , the Spot Fleet launches instances using the Spot Instance pool +// with the lowest price. If the allocation strategy is diversified , the Spot +// Fleet distributes the instances across the Spot Instance pools. If the +// allocation strategy is capacityOptimized , Spot Fleet launches instances from +// Spot Instance pools with optimal capacity for the number of instances that are +// launching. To scale down your Spot Fleet, decrease its target capacity. First, +// the Spot Fleet cancels any open requests that exceed the new target capacity. +// You can request that the Spot Fleet terminate Spot Instances until the size of +// the fleet no longer exceeds the new target capacity. If the allocation strategy +// is lowestPrice , the Spot Fleet terminates the instances with the highest price +// per unit. If the allocation strategy is capacityOptimized , the Spot Fleet +// terminates the instances in the Spot Instance pools that have the least +// available Spot Instance capacity. If the allocation strategy is diversified , +// the Spot Fleet terminates instances across the Spot Instance pools. +// Alternatively, you can request that the Spot Fleet keep the fleet at its current +// size, but not replace any Spot Instances that are interrupted or that you +// terminate manually. If you are finished with your Spot Fleet for now, but will +// use it again later, you can set the target capacity to 0. func (c *Client) ModifySpotFleetRequest(ctx context.Context, params *ModifySpotFleetRequestInput, optFns ...func(*Options)) (*ModifySpotFleetRequestOutput, error) { if params == nil { params = &ModifySpotFleetRequestInput{} @@ -62,13 +62,13 @@ type ModifySpotFleetRequestInput struct { // Indicates whether running instances should be terminated if the target capacity // of the Spot Fleet request is decreased below the current size of the Spot Fleet. - // Supported only for fleets of type maintain. + // Supported only for fleets of type maintain . ExcessCapacityTerminationPolicy types.ExcessCapacityTerminationPolicy // The launch template and overrides. You can only use this parameter if you - // specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. - // If you specified LaunchSpecifications in your Spot Fleet request, then omit this - // parameter. + // specified a launch template ( LaunchTemplateConfigs ) in your Spot Fleet + // request. If you specified LaunchSpecifications in your Spot Fleet request, then + // omit this parameter. LaunchTemplateConfigs []types.LaunchTemplateConfig // The number of On-Demand Instances in the fleet. @@ -83,7 +83,7 @@ type ModifySpotFleetRequestInput struct { // Contains the output of ModifySpotFleetRequest. type ModifySpotFleetRequestOutput struct { - // If the request succeeds, the response returns true. If the request fails, no + // If the request succeeds, the response returns true . If the request fails, no // response is returned, and instead an error message is returned. Return *bool diff --git a/service/ec2/api_op_ModifySubnetAttribute.go b/service/ec2/api_op_ModifySubnetAttribute.go index 01473bf6af4..3960fecbf31 100644 --- a/service/ec2/api_op_ModifySubnetAttribute.go +++ b/service/ec2/api_op_ModifySubnetAttribute.go @@ -13,24 +13,14 @@ import ( // Modifies a subnet attribute. You can only modify one attribute at a time. Use // this action to modify subnets on Amazon Web Services Outposts. +// - To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch +// and CustomerOwnedIpv4Pool . These two parameters act as a single attribute. +// - To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex +// or DisableLniAtDeviceIndex . // -// * To modify a -// subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and -// CustomerOwnedIpv4Pool. These two parameters act as a single attribute. -// -// * To -// modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or -// DisableLniAtDeviceIndex. -// -// For more information about Amazon Web Services -// Outposts, see the following: -// -// * Outpost servers -// (https://docs.aws.amazon.com/outposts/latest/userguide/how-servers-work.html) -// -// * -// Outpost racks -// (https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html) +// For more information about Amazon Web Services Outposts, see the following: +// - Outpost servers (https://docs.aws.amazon.com/outposts/latest/userguide/how-servers-work.html) +// - Outpost racks (https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html) func (c *Client) ModifySubnetAttribute(ctx context.Context, params *ModifySubnetAttributeInput, optFns ...func(*Options)) (*ModifySubnetAttributeOutput, error) { if params == nil { params = &ModifySubnetAttributeInput{} @@ -53,16 +43,16 @@ type ModifySubnetAttributeInput struct { // This member is required. SubnetId *string - // Specify true to indicate that network interfaces created in the specified subnet - // should be assigned an IPv6 address. This includes a network interface that's - // created when launching an instance into the subnet (the instance therefore - // receives an IPv6 address). If you enable the IPv6 addressing feature for your - // subnet, your network interface or instance only receives an IPv6 address if it's - // created using version 2016-11-15 or later of the Amazon EC2 API. + // Specify true to indicate that network interfaces created in the specified + // subnet should be assigned an IPv6 address. This includes a network interface + // that's created when launching an instance into the subnet (the instance + // therefore receives an IPv6 address). If you enable the IPv6 addressing feature + // for your subnet, your network interface or instance only receives an IPv6 + // address if it's created using version 2016-11-15 or later of the Amazon EC2 API. AssignIpv6AddressOnCreation *types.AttributeBooleanValue // The customer-owned IPv4 address pool associated with the subnet. You must set - // this value when you specify true for MapCustomerOwnedIpOnLaunch. + // this value when you specify true for MapCustomerOwnedIpOnLaunch . CustomerOwnedIpv4Pool *string // Specify true to indicate that local network interfaces at the current position @@ -79,8 +69,8 @@ type ModifySubnetAttributeInput struct { // network interface (eth0). EnableLniAtDeviceIndex *int32 - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecordOnLaunch *types.AttributeBooleanValue // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -89,8 +79,8 @@ type ModifySubnetAttributeInput struct { // Specify true to indicate that network interfaces attached to instances created // in the specified subnet should be assigned a customer-owned IPv4 address. When - // this value is true, you must specify the customer-owned IP pool using - // CustomerOwnedIpv4Pool. + // this value is true , you must specify the customer-owned IP pool using + // CustomerOwnedIpv4Pool . MapCustomerOwnedIpOnLaunch *types.AttributeBooleanValue // Specify true to indicate that network interfaces attached to instances created diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go index aa8bce40ffd..67d3dbe2bfd 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go @@ -45,8 +45,8 @@ type ModifyTrafficMirrorFilterNetworkServicesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The network service, for example Amazon DNS, that you no longer want to mirror. diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go index 057e0021e4c..940fabcb41f 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go @@ -46,16 +46,16 @@ type ModifyTrafficMirrorFilterRuleInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The protocol, for example TCP, to assign to the Traffic Mirror rule. Protocol *int32 - // The properties that you want to remove from the Traffic Mirror filter rule. When - // you remove a property from a Traffic Mirror filter rule, the property is set to - // the default. + // The properties that you want to remove from the Traffic Mirror filter rule. + // When you remove a property from a Traffic Mirror filter rule, the property is + // set to the default. RemoveFields []types.TrafficMirrorFilterRuleField // The action to assign to the rule. diff --git a/service/ec2/api_op_ModifyTrafficMirrorSession.go b/service/ec2/api_op_ModifyTrafficMirrorSession.go index 105f8821f39..36a64c0827e 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorSession.go +++ b/service/ec2/api_op_ModifyTrafficMirrorSession.go @@ -39,8 +39,8 @@ type ModifyTrafficMirrorSessionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The number of bytes in each packet to mirror. These are bytes after the VXLAN @@ -50,8 +50,8 @@ type ModifyTrafficMirrorSessionInput struct { // want to mirror the entire packet. PacketLength *int32 - // The properties that you want to remove from the Traffic Mirror session. When you - // remove a property from a Traffic Mirror session, the property is set to the + // The properties that you want to remove from the Traffic Mirror session. When + // you remove a property from a Traffic Mirror session, the property is set to the // default. RemoveFields []types.TrafficMirrorSessionField diff --git a/service/ec2/api_op_ModifyTransitGateway.go b/service/ec2/api_op_ModifyTransitGateway.go index 24bb5f12d00..1999e1086c1 100644 --- a/service/ec2/api_op_ModifyTransitGateway.go +++ b/service/ec2/api_op_ModifyTransitGateway.go @@ -41,8 +41,8 @@ type ModifyTransitGatewayInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The options to modify. diff --git a/service/ec2/api_op_ModifyTransitGatewayPrefixListReference.go b/service/ec2/api_op_ModifyTransitGatewayPrefixListReference.go index b204cd10b66..2a5cd10e74f 100644 --- a/service/ec2/api_op_ModifyTransitGatewayPrefixListReference.go +++ b/service/ec2/api_op_ModifyTransitGatewayPrefixListReference.go @@ -45,8 +45,8 @@ type ModifyTransitGatewayPrefixListReferenceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment to which traffic is routed. diff --git a/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go b/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go index ac00860e708..1eec45c0c2f 100644 --- a/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_ModifyTransitGatewayVpcAttachment.go @@ -40,8 +40,8 @@ type ModifyTransitGatewayVpcAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The new VPC attachment options. diff --git a/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go b/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go index d4646cc50cf..96434f63704 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go @@ -36,8 +36,8 @@ type ModifyVerifiedAccessEndpointInput struct { VerifiedAccessEndpointId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access endpoint. @@ -45,12 +45,12 @@ type ModifyVerifiedAccessEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The load balancer details if creating the Amazon Web Services Verified Access - // endpoint as load-balancertype. + // endpoint as load-balancer type. LoadBalancerOptions *types.ModifyVerifiedAccessEndpointLoadBalancerOptions // The network interface options. diff --git a/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go b/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go index 60328900c9d..f937acf1ca9 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go +++ b/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go @@ -40,14 +40,14 @@ type ModifyVerifiedAccessEndpointPolicyInput struct { VerifiedAccessEndpointId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Web Services Verified Access policy document. diff --git a/service/ec2/api_op_ModifyVerifiedAccessGroup.go b/service/ec2/api_op_ModifyVerifiedAccessGroup.go index bed196549fa..c6391d1b409 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessGroup.go +++ b/service/ec2/api_op_ModifyVerifiedAccessGroup.go @@ -36,8 +36,8 @@ type ModifyVerifiedAccessGroupInput struct { VerifiedAccessGroupId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access group. @@ -45,8 +45,8 @@ type ModifyVerifiedAccessGroupInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the Amazon Web Services Verified Access instance. diff --git a/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go b/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go index 08dca2c73e5..6ebf825660f 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go +++ b/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go @@ -40,14 +40,14 @@ type ModifyVerifiedAccessGroupPolicyInput struct { VerifiedAccessGroupId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Web Services Verified Access policy document. diff --git a/service/ec2/api_op_ModifyVerifiedAccessInstance.go b/service/ec2/api_op_ModifyVerifiedAccessInstance.go index 78adeff3bd1..e62b4012d91 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessInstance.go +++ b/service/ec2/api_op_ModifyVerifiedAccessInstance.go @@ -36,8 +36,8 @@ type ModifyVerifiedAccessInstanceInput struct { VerifiedAccessInstanceId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access instance. @@ -45,8 +45,8 @@ type ModifyVerifiedAccessInstanceInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go b/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go index 828d4f76260..03c7ac54492 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go +++ b/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go @@ -42,14 +42,14 @@ type ModifyVerifiedAccessInstanceLoggingConfigurationInput struct { VerifiedAccessInstanceId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go b/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go index 775dd9387d7..e17ad62b888 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go @@ -37,8 +37,8 @@ type ModifyVerifiedAccessTrustProviderInput struct { VerifiedAccessTrustProviderId *string // A unique, case-sensitive token that you provide to ensure idempotency of your - // modification request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // modification request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A description for the Amazon Web Services Verified Access trust provider. @@ -46,11 +46,11 @@ type ModifyVerifiedAccessTrustProviderInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The OpenID Connect details for an oidc-type, user-identity based trust provider. + // The OpenID Connect details for an oidc -type, user-identity based trust provider. OidcOptions *types.ModifyVerifiedAccessTrustProviderOidcOptions noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVolume.go b/service/ec2/api_op_ModifyVolume.go index a04f4fb8a77..721da4348d3 100644 --- a/service/ec2/api_op_ModifyVolume.go +++ b/service/ec2/api_op_ModifyVolume.go @@ -15,24 +15,19 @@ import ( // size, volume type, and IOPS capacity. If your EBS volume is attached to a // current-generation EC2 instance type, you might be able to apply these changes // without stopping the instance or detaching the volume from it. For more -// information about modifying EBS volumes, see Amazon EBS Elastic Volumes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html) -// (Linux instances) or Amazon EBS Elastic Volumes -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-modify-volume.html) +// information about modifying EBS volumes, see Amazon EBS Elastic Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html) +// (Linux instances) or Amazon EBS Elastic Volumes (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-modify-volume.html) // (Windows instances). When you complete a resize operation on your volume, you // need to extend the volume's file-system size to take advantage of the new -// storage capacity. For more information, see Extend a Linux file system -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-expand-volume.html#recognize-expanded-volume-linux) -// or Extend a Windows file system -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-expand-volume.html#recognize-expanded-volume-windows). -// You can use CloudWatch Events to check the status of a modification to an EBS +// storage capacity. For more information, see Extend a Linux file system (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-expand-volume.html#recognize-expanded-volume-linux) +// or Extend a Windows file system (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ebs-expand-volume.html#recognize-expanded-volume-windows) +// . You can use CloudWatch Events to check the status of a modification to an EBS // volume. For information about CloudWatch Events, see the Amazon CloudWatch -// Events User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/). -// You can also track the status of a modification using -// DescribeVolumesModifications. For information about tracking status changes -// using either method, see Monitor the progress of volume modifications -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html). -// With previous-generation instance types, resizing an EBS volume might require +// Events User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/) +// . You can also track the status of a modification using +// DescribeVolumesModifications . For information about tracking status changes +// using either method, see Monitor the progress of volume modifications (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html) +// . With previous-generation instance types, resizing an EBS volume might require // detaching and reattaching the volume or stopping and restarting the instance. // After modifying a volume, you must wait at least six hours and ensure that the // volume is in the in-use or available state before you can modify the same @@ -61,61 +56,46 @@ type ModifyVolumeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The target IOPS rate of the volume. This parameter is valid only for gp3, io1, + // The target IOPS rate of the volume. This parameter is valid only for gp3 , io1 , // and io2 volumes. The following are the supported values for each volume type: - // - // * - // gp3: 3,000-16,000 IOPS - // - // * io1: 100-64,000 IOPS - // - // * io2: 100-64,000 IOPS - // - // Default: - // The existing value is retained if you keep the same volume type. If you change - // the volume type to io1, io2, or gp3, the default is 3,000. + // - gp3 : 3,000-16,000 IOPS + // - io1 : 100-64,000 IOPS + // - io2 : 100-64,000 IOPS + // Default: The existing value is retained if you keep the same volume type. If + // you change the volume type to io1 , io2 , or gp3 , the default is 3,000. Iops *int32 - // Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, - // you can attach the volume to up to 16 Nitro-based instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // Specifies whether to enable Amazon EBS Multi-Attach. If you enable + // Multi-Attach, you can attach the volume to up to 16 Nitro-based instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) // in the same Availability Zone. This parameter is supported with io1 and io2 - // volumes only. For more information, see Amazon EBS Multi-Attach - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) in - // the Amazon Elastic Compute Cloud User Guide. + // volumes only. For more information, see Amazon EBS Multi-Attach (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) + // in the Amazon Elastic Compute Cloud User Guide. MultiAttachEnabled *bool // The target size of the volume, in GiB. The target volume size must be greater // than or equal to the existing size of the volume. The following are the // supported volumes sizes for each volume type: - // - // * gp2 and gp3: 1-16,384 - // - // * io1 - // and io2: 4-16,384 - // - // * st1 and sc1: 125-16,384 - // - // * standard: 1-1,024 - // - // Default: The - // existing size is retained. + // - gp2 and gp3 : 1-16,384 + // - io1 and io2 : 4-16,384 + // - st1 and sc1 : 125-16,384 + // - standard : 1-1,024 + // Default: The existing size is retained. Size *int32 // The target throughput of the volume, in MiB/s. This parameter is valid only for // gp3 volumes. The maximum value is 1,000. Default: The existing value is retained - // if the source and target volume type is gp3. Otherwise, the default value is + // if the source and target volume type is gp3 . Otherwise, the default value is // 125. Valid Range: Minimum value of 125. Maximum value of 1000. Throughput *int32 // The target EBS volume type of the volume. For more information, see Amazon EBS - // volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon Elastic Compute Cloud User Guide. Default: The existing type is retained. + // volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon Elastic Compute Cloud User Guide. Default: The existing type is + // retained. VolumeType types.VolumeType noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVolumeAttribute.go b/service/ec2/api_op_ModifyVolumeAttribute.go index df855e7a90f..a819e7fe3a8 100644 --- a/service/ec2/api_op_ModifyVolumeAttribute.go +++ b/service/ec2/api_op_ModifyVolumeAttribute.go @@ -45,8 +45,8 @@ type ModifyVolumeAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpcEndpoint.go b/service/ec2/api_op_ModifyVpcEndpoint.go index 394ea7e71f9..35d5ba6b7e5 100644 --- a/service/ec2/api_op_ModifyVpcEndpoint.go +++ b/service/ec2/api_op_ModifyVpcEndpoint.go @@ -13,8 +13,8 @@ import ( // Modifies attributes of a specified VPC endpoint. The attributes that you can // modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load -// Balancer). For more information, see the Amazon Web Services PrivateLink Guide -// (https://docs.aws.amazon.com/vpc/latest/privatelink/). +// Balancer). For more information, see the Amazon Web Services PrivateLink Guide (https://docs.aws.amazon.com/vpc/latest/privatelink/) +// . func (c *Client) ModifyVpcEndpoint(ctx context.Context, params *ModifyVpcEndpointInput, optFns ...func(*Options)) (*ModifyVpcEndpointOutput, error) { if params == nil { params = &ModifyVpcEndpointInput{} @@ -54,8 +54,8 @@ type ModifyVpcEndpointInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address type for the endpoint. diff --git a/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go b/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go index 70c49c34243..769f2edf1df 100644 --- a/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go +++ b/service/ec2/api_op_ModifyVpcEndpointConnectionNotification.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies a connection notification for VPC endpoint or VPC endpoint service. You -// can change the SNS topic for the notification, or the events for which to be +// Modifies a connection notification for VPC endpoint or VPC endpoint service. +// You can change the SNS topic for the notification, or the events for which to be // notified. func (c *Client) ModifyVpcEndpointConnectionNotification(ctx context.Context, params *ModifyVpcEndpointConnectionNotificationInput, optFns ...func(*Options)) (*ModifyVpcEndpointConnectionNotificationOutput, error) { if params == nil { @@ -35,8 +35,8 @@ type ModifyVpcEndpointConnectionNotificationInput struct { // This member is required. ConnectionNotificationId *string - // The events for the endpoint. Valid values are Accept, Connect, Delete, and - // Reject. + // The events for the endpoint. Valid values are Accept , Connect , Delete , and + // Reject . ConnectionEvents []string // The ARN for the SNS topic for the notification. @@ -44,8 +44,8 @@ type ModifyVpcEndpointConnectionNotificationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go index d51bf9387e7..30d0b27eff3 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go @@ -54,8 +54,8 @@ type ModifyVpcEndpointServiceConfigurationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // (Interface endpoint configuration) The private DNS name to assign to the diff --git a/service/ec2/api_op_ModifyVpcEndpointServicePayerResponsibility.go b/service/ec2/api_op_ModifyVpcEndpointServicePayerResponsibility.go index b7d8602cb17..7d3f0c55d3b 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServicePayerResponsibility.go +++ b/service/ec2/api_op_ModifyVpcEndpointServicePayerResponsibility.go @@ -43,8 +43,8 @@ type ModifyVpcEndpointServicePayerResponsibilityInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go index 42028512db5..839d3aed46e 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go @@ -46,8 +46,8 @@ type ModifyVpcEndpointServicePermissionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Resource Names (ARN) of the principals. Permissions are revoked for diff --git a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go index e501c0dc965..67a350759ab 100644 --- a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go +++ b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go @@ -11,36 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Modifies the VPC peering connection -// options on one side of a VPC peering connection. You can do the following: +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Modifies the VPC peering +// connection options on one side of a VPC peering connection. You can do the +// following: +// - Enable/disable communication over the peering connection between an +// EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances +// in the peer VPC. +// - Enable/disable communication over the peering connection between instances +// in your VPC and an EC2-Classic instance that's linked to the peer VPC. +// - Enable/disable the ability to resolve public DNS hostnames to private IP +// addresses when queried from instances in the peer VPC. // -// * -// Enable/disable communication over the peering connection between an EC2-Classic -// instance that's linked to your VPC (using ClassicLink) and instances in the peer -// VPC. -// -// * Enable/disable communication over the peering connection between -// instances in your VPC and an EC2-Classic instance that's linked to the peer -// VPC. -// -// * Enable/disable the ability to resolve public DNS hostnames to private IP -// addresses when queried from instances in the peer VPC. -// -// If the peered VPCs are -// in the same Amazon Web Services account, you can enable DNS resolution for -// queries from the local VPC. This ensures that queries from the local VPC resolve -// to private IP addresses in the peer VPC. This option is not available if the -// peered VPCs are in different Amazon Web Services accounts or different Regions. -// For peered VPCs in different Amazon Web Services accounts, each Amazon Web -// Services account owner must initiate a separate request to modify the peering -// connection options. For inter-region peering connections, you must use the -// Region for the requester VPC to modify the requester VPC peering options and the -// Region for the accepter VPC to modify the accepter VPC peering options. To -// verify which VPCs are the accepter and the requester for a VPC peering -// connection, use the DescribeVpcPeeringConnections command. +// If the peered VPCs are in the same Amazon Web Services account, you can enable +// DNS resolution for queries from the local VPC. This ensures that queries from +// the local VPC resolve to private IP addresses in the peer VPC. This option is +// not available if the peered VPCs are in different Amazon Web Services accounts +// or different Regions. For peered VPCs in different Amazon Web Services accounts, +// each Amazon Web Services account owner must initiate a separate request to +// modify the peering connection options. For inter-region peering connections, you +// must use the Region for the requester VPC to modify the requester VPC peering +// options and the Region for the accepter VPC to modify the accepter VPC peering +// options. To verify which VPCs are the accepter and the requester for a VPC +// peering connection, use the DescribeVpcPeeringConnections command. func (c *Client) ModifyVpcPeeringConnectionOptions(ctx context.Context, params *ModifyVpcPeeringConnectionOptionsInput, optFns ...func(*Options)) (*ModifyVpcPeeringConnectionOptionsOutput, error) { if params == nil { params = &ModifyVpcPeeringConnectionOptionsInput{} @@ -68,8 +62,8 @@ type ModifyVpcPeeringConnectionOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The VPC peering connection options for the requester VPC. diff --git a/service/ec2/api_op_ModifyVpcTenancy.go b/service/ec2/api_op_ModifyVpcTenancy.go index 87e62600a93..898c5dff001 100644 --- a/service/ec2/api_op_ModifyVpcTenancy.go +++ b/service/ec2/api_op_ModifyVpcTenancy.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the instance tenancy attribute of the specified VPC. You can change the -// instance tenancy attribute of a VPC to default only. You cannot change the -// instance tenancy attribute to dedicated. After you modify the tenancy of the -// VPC, any new instances that you launch into the VPC have a tenancy of default, +// Modifies the instance tenancy attribute of the specified VPC. You can change +// the instance tenancy attribute of a VPC to default only. You cannot change the +// instance tenancy attribute to dedicated . After you modify the tenancy of the +// VPC, any new instances that you launch into the VPC have a tenancy of default , // unless you specify otherwise during launch. The tenancy of any existing // instances in the VPC is not affected. For more information, see Dedicated -// Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) in -// the Amazon Elastic Compute Cloud User Guide. +// Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ModifyVpcTenancy(ctx context.Context, params *ModifyVpcTenancyInput, optFns ...func(*Options)) (*ModifyVpcTenancyOutput, error) { if params == nil { params = &ModifyVpcTenancyInput{} @@ -49,8 +48,8 @@ type ModifyVpcTenancyInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpnConnection.go b/service/ec2/api_op_ModifyVpnConnection.go index 1c491de96b6..5e7e82d6cdb 100644 --- a/service/ec2/api_op_ModifyVpnConnection.go +++ b/service/ec2/api_op_ModifyVpnConnection.go @@ -14,29 +14,21 @@ import ( // Modifies the customer gateway or the target gateway of an Amazon Web Services // Site-to-Site VPN connection. To modify the target gateway, the following // migration options are available: +// - An existing virtual private gateway to a new virtual private gateway +// - An existing virtual private gateway to a transit gateway +// - An existing transit gateway to a new transit gateway +// - An existing transit gateway to a virtual private gateway // -// * An existing virtual private gateway to a new -// virtual private gateway -// -// * An existing virtual private gateway to a transit -// gateway -// -// * An existing transit gateway to a new transit gateway -// -// * An existing -// transit gateway to a virtual private gateway -// -// Before you perform the migration -// to the new gateway, you must configure the new gateway. Use CreateVpnGateway to -// create a virtual private gateway, or CreateTransitGateway to create a transit -// gateway. This step is required when you migrate from a virtual private gateway -// with static routes to a transit gateway. You must delete the static routes -// before you migrate to the new gateway. Keep a copy of the static route before -// you delete it. You will need to add back these routes to the transit gateway -// after the VPN connection migration is complete. After you migrate to the new -// gateway, you might need to modify your VPC route table. Use CreateRoute and -// DeleteRoute to make the changes described in Update VPC route tables -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing) +// Before you perform the migration to the new gateway, you must configure the new +// gateway. Use CreateVpnGateway to create a virtual private gateway, or +// CreateTransitGateway to create a transit gateway. This step is required when you +// migrate from a virtual private gateway with static routes to a transit gateway. +// You must delete the static routes before you migrate to the new gateway. Keep a +// copy of the static route before you delete it. You will need to add back these +// routes to the transit gateway after the VPN connection migration is complete. +// After you migrate to the new gateway, you might need to modify your VPC route +// table. Use CreateRoute and DeleteRoute to make the changes described in Update +// VPC route tables (https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing) // in the Amazon Web Services Site-to-Site VPN User Guide. When the new gateway is // a transit gateway, modify the transit gateway route table to allow traffic // between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use @@ -73,15 +65,15 @@ type ModifyVpnConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the transit gateway. TransitGatewayId *string - // The ID of the virtual private gateway at the Amazon Web Services side of the VPN - // connection. + // The ID of the virtual private gateway at the Amazon Web Services side of the + // VPN connection. VpnGatewayId *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpnConnectionOptions.go b/service/ec2/api_op_ModifyVpnConnectionOptions.go index 6285a603fbc..64e82275aa9 100644 --- a/service/ec2/api_op_ModifyVpnConnectionOptions.go +++ b/service/ec2/api_op_ModifyVpnConnectionOptions.go @@ -40,8 +40,8 @@ type ModifyVpnConnectionOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. diff --git a/service/ec2/api_op_ModifyVpnTunnelCertificate.go b/service/ec2/api_op_ModifyVpnTunnelCertificate.go index 7fdf32d1e58..94e36aa3859 100644 --- a/service/ec2/api_op_ModifyVpnTunnelCertificate.go +++ b/service/ec2/api_op_ModifyVpnTunnelCertificate.go @@ -41,8 +41,8 @@ type ModifyVpnTunnelCertificateInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpnTunnelOptions.go b/service/ec2/api_op_ModifyVpnTunnelOptions.go index e96dcb986da..be69b69f4cc 100644 --- a/service/ec2/api_op_ModifyVpnTunnelOptions.go +++ b/service/ec2/api_op_ModifyVpnTunnelOptions.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN -// connection. You can modify multiple options for a tunnel in a single request, -// but you can only modify one tunnel at a time. For more information, see -// Site-to-Site VPN tunnel options for your Site-to-Site VPN connection -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html) in the Amazon -// Web Services Site-to-Site VPN User Guide. +// Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site +// VPN connection. You can modify multiple options for a tunnel in a single +// request, but you can only modify one tunnel at a time. For more information, see +// Site-to-Site VPN tunnel options for your Site-to-Site VPN connection (https://docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. func (c *Client) ModifyVpnTunnelOptions(ctx context.Context, params *ModifyVpnTunnelOptionsInput, optFns ...func(*Options)) (*ModifyVpnTunnelOptionsOutput, error) { if params == nil { params = &ModifyVpnTunnelOptionsInput{} @@ -51,8 +50,8 @@ type ModifyVpnTunnelOptionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Choose whether or not to trigger immediate tunnel replacement. Valid values: diff --git a/service/ec2/api_op_MonitorInstances.go b/service/ec2/api_op_MonitorInstances.go index 2f76deddc8e..0bcff6ed591 100644 --- a/service/ec2/api_op_MonitorInstances.go +++ b/service/ec2/api_op_MonitorInstances.go @@ -12,11 +12,10 @@ import ( ) // Enables detailed monitoring for a running instance. Otherwise, basic monitoring -// is enabled. For more information, see Monitor your instances using CloudWatch -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) in -// the Amazon EC2 User Guide. To disable detailed monitoring, see -// UnmonitorInstances -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html). +// is enabled. For more information, see Monitor your instances using CloudWatch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) +// in the Amazon EC2 User Guide. To disable detailed monitoring, see +// UnmonitorInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html) +// . func (c *Client) MonitorInstances(ctx context.Context, params *MonitorInstancesInput, optFns ...func(*Options)) (*MonitorInstancesOutput, error) { if params == nil { params = &MonitorInstancesInput{} @@ -41,8 +40,8 @@ type MonitorInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_MoveAddressToVpc.go b/service/ec2/api_op_MoveAddressToVpc.go index 1305913a502..cde7c611c51 100644 --- a/service/ec2/api_op_MoveAddressToVpc.go +++ b/service/ec2/api_op_MoveAddressToVpc.go @@ -19,9 +19,8 @@ import ( // move an Elastic IP address that was originally allocated for use in the EC2-VPC // platform to the EC2-Classic platform. We are retiring EC2-Classic. We recommend // that you migrate from EC2-Classic to a VPC. For more information, see Migrate -// from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) MoveAddressToVpc(ctx context.Context, params *MoveAddressToVpcInput, optFns ...func(*Options)) (*MoveAddressToVpcOutput, error) { if params == nil { params = &MoveAddressToVpcInput{} @@ -46,8 +45,8 @@ type MoveAddressToVpcInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_MoveByoipCidrToIpam.go b/service/ec2/api_op_MoveByoipCidrToIpam.go index 70f7b63d593..92eac19f3d7 100644 --- a/service/ec2/api_op_MoveByoipCidrToIpam.go +++ b/service/ec2/api_op_MoveByoipCidrToIpam.go @@ -15,8 +15,8 @@ import ( // BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a // public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a // new IP address to Amazon Web Services for the first time, complete the steps in -// Tutorial: BYOIP address CIDRs to IPAM -// (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam.html). +// Tutorial: BYOIP address CIDRs to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam.html) +// . func (c *Client) MoveByoipCidrToIpam(ctx context.Context, params *MoveByoipCidrToIpamInput, optFns ...func(*Options)) (*MoveByoipCidrToIpamOutput, error) { if params == nil { params = &MoveByoipCidrToIpamInput{} @@ -51,8 +51,8 @@ type MoveByoipCidrToIpamInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ProvisionByoipCidr.go b/service/ec2/api_op_ProvisionByoipCidr.go index 050cd1763f1..468e1905a25 100644 --- a/service/ec2/api_op_ProvisionByoipCidr.go +++ b/service/ec2/api_op_ProvisionByoipCidr.go @@ -14,17 +14,16 @@ import ( // Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services // resources through bring your own IP addresses (BYOIP) and creates a // corresponding address pool. After the address range is provisioned, it is ready -// to be advertised using AdvertiseByoipCidr. Amazon Web Services verifies that you -// own the address range and are authorized to advertise it. You must ensure that -// the address range is registered to you and that you created an RPKI ROA to +// to be advertised using AdvertiseByoipCidr . Amazon Web Services verifies that +// you own the address range and are authorized to advertise it. You must ensure +// that the address range is registered to you and that you created an RPKI ROA to // authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more -// information, see Bring your own IP addresses (BYOIP) -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the -// Amazon Elastic Compute Cloud User Guide. Provisioning an address range is an -// asynchronous operation, so the call returns immediately, but the address range -// is not ready to use until its status changes from pending-provision to -// provisioned. To monitor the status of an address range, use DescribeByoipCidrs. -// To allocate an Elastic IP address from your IPv4 address pool, use +// information, see Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) +// in the Amazon Elastic Compute Cloud User Guide. Provisioning an address range is +// an asynchronous operation, so the call returns immediately, but the address +// range is not ready to use until its status changes from pending-provision to +// provisioned . To monitor the status of an address range, use DescribeByoipCidrs +// . To allocate an Elastic IP address from your IPv4 address pool, use // AllocateAddress with either the specific address from the address pool or the ID // of the address pool. func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipCidrInput, optFns ...func(*Options)) (*ProvisionByoipCidrOutput, error) { @@ -61,8 +60,8 @@ type ProvisionByoipCidrInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Reserved. diff --git a/service/ec2/api_op_ProvisionIpamPoolCidr.go b/service/ec2/api_op_ProvisionIpamPoolCidr.go index dfa3a41e6a0..315c46cbac0 100644 --- a/service/ec2/api_op_ProvisionIpamPoolCidr.go +++ b/service/ec2/api_op_ProvisionIpamPoolCidr.go @@ -12,11 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs -// to a top-level pool or to transfer a CIDR from a top-level pool to a pool within -// it. For more information, see Provision CIDRs to pools -// (https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html) in the Amazon -// VPC IPAM User Guide. +// Provision a CIDR to an IPAM pool. You can use this action to provision new +// CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool +// within it. For more information, see Provision CIDRs to pools (https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. func (c *Client) ProvisionIpamPoolCidr(ctx context.Context, params *ProvisionIpamPoolCidrInput, optFns ...func(*Options)) (*ProvisionIpamPoolCidrOutput, error) { if params == nil { params = &ProvisionIpamPoolCidrInput{} @@ -49,14 +48,14 @@ type ProvisionIpamPoolCidrInput struct { CidrAuthorizationContext *types.IpamCidrAuthorizationContext // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The netmask length of the CIDR you'd like to provision to a pool. Can be used diff --git a/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go b/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go index 6f4a480241c..c3f21f8f815 100644 --- a/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go +++ b/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go @@ -49,8 +49,8 @@ type ProvisionPublicIpv4PoolCidrInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_PurchaseHostReservation.go b/service/ec2/api_op_PurchaseHostReservation.go index 5e332ca8294..4da1a585861 100644 --- a/service/ec2/api_op_PurchaseHostReservation.go +++ b/service/ec2/api_op_PurchaseHostReservation.go @@ -43,20 +43,20 @@ type PurchaseHostReservationInput struct { OfferingId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string - // The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice - // amounts are specified. At this time, the only supported currency is USD. + // The currency in which the totalUpfrontPrice , LimitPrice , and totalHourlyPrice + // amounts are specified. At this time, the only supported currency is USD . CurrencyCode types.CurrencyCodeValues - // The specified limit is checked against the total upfront cost of the reservation - // (calculated as the offering's upfront cost multiplied by the host count). If the - // total upfront cost is greater than the specified price limit, the request fails. - // This is used to ensure that the purchase does not exceed the expected upfront - // cost of the purchase. At this time, the only supported currency is USD. For - // example, to indicate a limit price of USD 100, specify 100.00. + // The specified limit is checked against the total upfront cost of the + // reservation (calculated as the offering's upfront cost multiplied by the host + // count). If the total upfront cost is greater than the specified price limit, the + // request fails. This is used to ensure that the purchase does not exceed the + // expected upfront cost of the purchase. At this time, the only supported currency + // is USD . For example, to indicate a limit price of USD 100, specify 100.00. LimitPrice *string // The tags to apply to the Dedicated Host Reservation during purchase. @@ -68,12 +68,12 @@ type PurchaseHostReservationInput struct { type PurchaseHostReservationOutput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are - // specified. At this time, the only supported currency is USD. + // specified. At this time, the only supported currency is USD . CurrencyCode types.CurrencyCodeValues // Describes the details of the purchase. diff --git a/service/ec2/api_op_PurchaseReservedInstancesOffering.go b/service/ec2/api_op_PurchaseReservedInstancesOffering.go index d667a6d1745..e95d8a59ebf 100644 --- a/service/ec2/api_op_PurchaseReservedInstancesOffering.go +++ b/service/ec2/api_op_PurchaseReservedInstancesOffering.go @@ -17,17 +17,14 @@ import ( // Use DescribeReservedInstancesOfferings to get a list of Reserved Instance // offerings that match your specifications. After you've purchased a Reserved // Instance, you can check for your new Reserved Instance with -// DescribeReservedInstances. To queue a purchase for a future date and time, +// DescribeReservedInstances . To queue a purchase for a future date and time, // specify a purchase time. If you do not specify a purchase time, the default is -// the current time. For more information, see Reserved Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) -// and Reserved Instance Marketplace -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in -// the Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you +// the current time. For more information, see Reserved Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) +// and Reserved Instance Marketplace (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) +// in the Amazon EC2 User Guide. We are retiring EC2-Classic. We recommend that you // migrate from EC2-Classic to a VPC. For more information, see Migrate from -// EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) PurchaseReservedInstancesOffering(ctx context.Context, params *PurchaseReservedInstancesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedInstancesOfferingOutput, error) { if params == nil { params = &PurchaseReservedInstancesOfferingInput{} @@ -58,16 +55,16 @@ type PurchaseReservedInstancesOfferingInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Specified for Reserved Instance Marketplace offerings to limit the total order // and ensure that the Reserved Instances are not purchased at unexpected prices. LimitPrice *types.ReservedInstanceLimitPrice - // The time at which to purchase the Reserved Instance, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). + // The time at which to purchase the Reserved Instance, in UTC format (for + // example, YYYY-MM-DDTHH:MM:SSZ). PurchaseTime *time.Time noSmithyDocumentSerde @@ -78,8 +75,7 @@ type PurchaseReservedInstancesOfferingOutput struct { // The IDs of the purchased Reserved Instances. If your purchase crosses into a // discounted pricing tier, the final Reserved Instances IDs might change. For more - // information, see Crossing pricing tiers - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-reserved-instances-application.html#crossing-pricing-tiers) + // information, see Crossing pricing tiers (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-reserved-instances-application.html#crossing-pricing-tiers) // in the Amazon Elastic Compute Cloud User Guide. ReservedInstancesId *string diff --git a/service/ec2/api_op_PurchaseScheduledInstances.go b/service/ec2/api_op_PurchaseScheduledInstances.go index 5959b2a65f7..3e9eb451f6a 100644 --- a/service/ec2/api_op_PurchaseScheduledInstances.go +++ b/service/ec2/api_op_PurchaseScheduledInstances.go @@ -44,14 +44,14 @@ type PurchaseScheduledInstancesInput struct { PurchaseRequests []types.PurchaseRequest // Unique, case-sensitive identifier that ensures the idempotency of the request. - // For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RebootInstances.go b/service/ec2/api_op_RebootInstances.go index d763e3b5d2e..0f51a03b9de 100644 --- a/service/ec2/api_op_RebootInstances.go +++ b/service/ec2/api_op_RebootInstances.go @@ -10,14 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests a reboot of the specified instances. This operation is asynchronous; it -// only queues a request to reboot the specified instances. The operation succeeds -// if the instances are valid and belong to you. Requests to reboot terminated -// instances are ignored. If an instance does not cleanly shut down within a few -// minutes, Amazon EC2 performs a hard reboot. For more information about -// troubleshooting, see Troubleshoot an unreachable instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html) in -// the Amazon EC2 User Guide. +// Requests a reboot of the specified instances. This operation is asynchronous; +// it only queues a request to reboot the specified instances. The operation +// succeeds if the instances are valid and belong to you. Requests to reboot +// terminated instances are ignored. If an instance does not cleanly shut down +// within a few minutes, Amazon EC2 performs a hard reboot. For more information +// about troubleshooting, see Troubleshoot an unreachable instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html) +// in the Amazon EC2 User Guide. func (c *Client) RebootInstances(ctx context.Context, params *RebootInstancesInput, optFns ...func(*Options)) (*RebootInstancesOutput, error) { if params == nil { params = &RebootInstancesInput{} @@ -42,8 +41,8 @@ type RebootInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RegisterImage.go b/service/ec2/api_op_RegisterImage.go index f537ddafeb1..7e8cec6cd04 100644 --- a/service/ec2/api_op_RegisterImage.go +++ b/service/ec2/api_op_RegisterImage.go @@ -13,11 +13,10 @@ import ( // Registers an AMI. When you're creating an AMI, this is the final step you must // complete before you can launch an instance from the AMI. For more information -// about creating AMIs, see Create your own AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html) in -// the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, -// CreateImage creates and registers the AMI in a single request, so you don't have -// to register the AMI yourself. We recommend that you always use CreateImage +// about creating AMIs, see Create your own AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html) +// in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, +// CreateImage creates and registers the AMI in a single request, so you don't +// have to register the AMI yourself. We recommend that you always use CreateImage // unless you have a specific reason to use RegisterImage. If needed, you can // deregister an AMI at any time. Any modifications you make to an AMI backed by an // instance store volume invalidates its registration. If you make changes to an @@ -28,36 +27,28 @@ import ( // volume using the block device mapping. If the snapshot is encrypted, or // encryption by default is enabled, the root volume of an instance launched from // the AMI is encrypted. For more information, see Create a Linux AMI from a -// snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot) -// and Use encryption with Amazon EBS-backed AMIs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. Amazon Web Services Marketplace product -// codes If any snapshots have Amazon Web Services Marketplace product codes, they -// are copied to the new AMI. Windows and some Linux distributions, such as Red Hat -// Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon -// EC2 billing product code associated with an AMI to verify the subscription -// status for package updates. To create a new AMI for operating systems that -// require a billing product code, instead of registering the AMI, do the following -// to preserve the billing product code association: +// snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot) +// and Use encryption with Amazon EBS-backed AMIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. Amazon Web Services Marketplace +// product codes If any snapshots have Amazon Web Services Marketplace product +// codes, they are copied to the new AMI. Windows and some Linux distributions, +// such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), +// use the Amazon EC2 billing product code associated with an AMI to verify the +// subscription status for package updates. To create a new AMI for operating +// systems that require a billing product code, instead of registering the AMI, do +// the following to preserve the billing product code association: +// - Launch an instance from an existing AMI with that billing product code. +// - Customize the instance. +// - Create an AMI from the instance using CreateImage . // -// * Launch an instance from an -// existing AMI with that billing product code. -// -// * Customize the instance. -// -// * -// Create an AMI from the instance using CreateImage. -// -// If you purchase a Reserved -// Instance to apply to an On-Demand Instance that was launched from an AMI with a -// billing product code, make sure that the Reserved Instance has the matching -// billing product code. If you purchase a Reserved Instance without the matching -// billing product code, the Reserved Instance will not be applied to the On-Demand -// Instance. For information about how to obtain the platform details and billing -// information of an AMI, see Understand AMI billing information -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) in -// the Amazon EC2 User Guide. +// If you purchase a Reserved Instance to apply to an On-Demand Instance that was +// launched from an AMI with a billing product code, make sure that the Reserved +// Instance has the matching billing product code. If you purchase a Reserved +// Instance without the matching billing product code, the Reserved Instance will +// not be applied to the On-Demand Instance. For information about how to obtain +// the platform details and billing information of an AMI, see Understand AMI +// billing information (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) +// in the Amazon EC2 User Guide. func (c *Client) RegisterImage(ctx context.Context, params *RegisterImageInput, optFns ...func(*Options)) (*RegisterImageOutput, error) { if params == nil { params = &RegisterImageInput{} @@ -83,7 +74,7 @@ type RegisterImageInput struct { // This member is required. Name *string - // The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For + // The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386 . For // instance store-backed AMIs, the architecture specified in the manifest file. Architecture types.ArchitectureValues @@ -92,11 +83,9 @@ type RegisterImageInput struct { // codes, you can publish AMIs that include billable software and list them on the // Amazon Web Services Marketplace. You must first register as a seller on the // Amazon Web Services Marketplace. For more information, see Getting started as a - // seller - // (https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html) - // and AMI-based products - // (https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html) in - // the Amazon Web Services Marketplace Seller Guide. + // seller (https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html) + // and AMI-based products (https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html) + // in the Amazon Web Services Marketplace Seller Guide. BillingProducts []string // The block device mapping entries. If you specify an Amazon EBS volume using the @@ -104,8 +93,7 @@ type RegisterImageInput struct { // volume. If you create an AMI on an Outpost, then all backing snapshots must be // on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that // include local snapshots can be used to launch instances on the same Outpost - // only. For more information, Amazon EBS local snapshots on Outposts - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) + // only. For more information, Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) // in the Amazon EC2 User Guide. BlockDeviceMappings []types.BlockDeviceMapping @@ -121,30 +109,28 @@ type RegisterImageInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // Set to true to enable enhanced networking with ENA for the AMI and any instances - // that you launch from the AMI. This option is supported only for HVM AMIs. - // Specifying this option with a PV AMI can make instances launched from the AMI - // unreachable. + // Set to true to enable enhanced networking with ENA for the AMI and any + // instances that you launch from the AMI. This option is supported only for HVM + // AMIs. Specifying this option with a PV AMI can make instances launched from the + // AMI unreachable. EnaSupport *bool // The full path to your AMI manifest in Amazon S3 storage. The specified bucket // must have the aws-exec-read canned access control list (ACL) to ensure that it - // can be accessed by Amazon EC2. For more information, see Canned ACLs - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) + // can be accessed by Amazon EC2. For more information, see Canned ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) // in the Amazon S3 Service Developer Guide. ImageLocation *string // Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched // from this AMI will have HttpTokens automatically set to required so that, by // default, the instance requires that IMDSv2 is used when requesting instance - // metadata. In addition, HttpPutResponseHopLimit is set to 2. For more - // information, see Configure the AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) - // in the Amazon EC2 User Guide. If you set the value to v2.0, make sure that your + // metadata. In addition, HttpPutResponseHopLimit is set to 2 . For more + // information, see Configure the AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) + // in the Amazon EC2 User Guide. If you set the value to v2.0 , make sure that your // AMI software can support IMDSv2. ImdsSupport types.ImdsSupportValues @@ -154,7 +140,7 @@ type RegisterImageInput struct { // The ID of the RAM disk. RamdiskId *string - // The device name of the root device volume (for example, /dev/sda1). + // The device name of the root device volume (for example, /dev/sda1 ). RootDeviceName *string // Set to simple to enable enhanced networking with the Intel 82599 Virtual @@ -165,22 +151,19 @@ type RegisterImageInput struct { SriovNetSupport *string // Set to v2.0 to enable Trusted Platform Module (TPM) support. For more - // information, see NitroTPM - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the - // Amazon EC2 User Guide. + // information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) + // in the Amazon EC2 User Guide. TpmSupport types.TpmSupportValues // Base64 representation of the non-volatile UEFI variable store. To retrieve the - // UEFI data, use the GetInstanceUefiData - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) + // UEFI data, use the GetInstanceUefiData (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) // command. You can inspect and modify the UEFI data by using the python-uefivars // tool (https://github.com/awslabs/python-uefivars) on GitHub. For more - // information, see UEFI Secure Boot - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in - // the Amazon EC2 User Guide. + // information, see UEFI Secure Boot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) + // in the Amazon EC2 User Guide. UefiData *string - // The type of virtualization (hvm | paravirtual). Default: paravirtual + // The type of virtualization ( hvm | paravirtual ). Default: paravirtual VirtualizationType *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go b/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go index 20c33d3847a..09fbc045811 100644 --- a/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go +++ b/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a set of tag keys to include in scheduled event notifications for your -// resources. To remove tags, use DeregisterInstanceEventNotificationAttributes -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html). +// Registers a set of tag keys to include in scheduled event notifications for +// your resources. To remove tags, use +// DeregisterInstanceEventNotificationAttributes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html) +// . func (c *Client) RegisterInstanceEventNotificationAttributes(ctx context.Context, params *RegisterInstanceEventNotificationAttributesInput, optFns ...func(*Options)) (*RegisterInstanceEventNotificationAttributesOutput, error) { if params == nil { params = &RegisterInstanceEventNotificationAttributesInput{} @@ -33,8 +34,8 @@ type RegisterInstanceEventNotificationAttributesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Information about the tag keys to register. diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go index 1702f896c4c..a014a353df3 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers members (network interfaces) with the transit gateway multicast group. -// A member is a network interface associated with a supported EC2 instance that -// receives multicast traffic. For information about supported instances, see -// Multicast Consideration -// (https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) +// Registers members (network interfaces) with the transit gateway multicast +// group. A member is a network interface associated with a supported EC2 instance +// that receives multicast traffic. For information about supported instances, see +// Multicast Consideration (https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) // in Amazon VPC Transit Gateways. After you add the members, use -// SearchTransitGatewayMulticastGroups -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) +// SearchTransitGatewayMulticastGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) // to verify that the members were added to the transit gateway multicast group. func (c *Client) RegisterTransitGatewayMulticastGroupMembers(ctx context.Context, params *RegisterTransitGatewayMulticastGroupMembersInput, optFns ...func(*Options)) (*RegisterTransitGatewayMulticastGroupMembersOutput, error) { if params == nil { @@ -50,8 +48,8 @@ type RegisterTransitGatewayMulticastGroupMembersInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address assigned to the transit gateway multicast group. diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go index 556817f3711..79a8d085073 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go @@ -14,11 +14,9 @@ import ( // Registers sources (network interfaces) with the specified transit gateway // multicast group. A multicast source is a network interface attached to a // supported instance that sends multicast traffic. For information about supported -// instances, see Multicast Considerations -// (https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) +// instances, see Multicast Considerations (https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits) // in Amazon VPC Transit Gateways. After you add the source, use -// SearchTransitGatewayMulticastGroups -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) +// SearchTransitGatewayMulticastGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) // to verify that the source was added to the multicast group. func (c *Client) RegisterTransitGatewayMulticastGroupSources(ctx context.Context, params *RegisterTransitGatewayMulticastGroupSourcesInput, optFns ...func(*Options)) (*RegisterTransitGatewayMulticastGroupSourcesOutput, error) { if params == nil { @@ -50,8 +48,8 @@ type RegisterTransitGatewayMulticastGroupSourcesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IP address assigned to the transit gateway multicast group. diff --git a/service/ec2/api_op_RejectTransitGatewayMulticastDomainAssociations.go b/service/ec2/api_op_RejectTransitGatewayMulticastDomainAssociations.go index 0f747fa5abe..cfb803b3936 100644 --- a/service/ec2/api_op_RejectTransitGatewayMulticastDomainAssociations.go +++ b/service/ec2/api_op_RejectTransitGatewayMulticastDomainAssociations.go @@ -32,8 +32,8 @@ type RejectTransitGatewayMulticastDomainAssociationsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The IDs of the subnets to associate with the transit gateway multicast domain. diff --git a/service/ec2/api_op_RejectTransitGatewayPeeringAttachment.go b/service/ec2/api_op_RejectTransitGatewayPeeringAttachment.go index 900d5ebdc94..971d13702e6 100644 --- a/service/ec2/api_op_RejectTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_RejectTransitGatewayPeeringAttachment.go @@ -36,8 +36,8 @@ type RejectTransitGatewayPeeringAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go index a5bb0fd4c5a..7d59212d696 100644 --- a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go @@ -39,8 +39,8 @@ type RejectTransitGatewayVpcAttachmentInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RejectVpcEndpointConnections.go b/service/ec2/api_op_RejectVpcEndpointConnections.go index 3d780f462cf..a6e6898d7cc 100644 --- a/service/ec2/api_op_RejectVpcEndpointConnections.go +++ b/service/ec2/api_op_RejectVpcEndpointConnections.go @@ -41,8 +41,8 @@ type RejectVpcEndpointConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RejectVpcPeeringConnection.go b/service/ec2/api_op_RejectVpcPeeringConnection.go index e1765ca6358..2aea3af75da 100644 --- a/service/ec2/api_op_RejectVpcPeeringConnection.go +++ b/service/ec2/api_op_RejectVpcPeeringConnection.go @@ -14,7 +14,7 @@ import ( // the pending-acceptance state. Use the DescribeVpcPeeringConnections request to // view your outstanding VPC peering connection requests. To delete an active VPC // peering connection, or to delete a VPC peering connection request that you -// initiated, use DeleteVpcPeeringConnection. +// initiated, use DeleteVpcPeeringConnection . func (c *Client) RejectVpcPeeringConnection(ctx context.Context, params *RejectVpcPeeringConnectionInput, optFns ...func(*Options)) (*RejectVpcPeeringConnectionOutput, error) { if params == nil { params = &RejectVpcPeeringConnectionInput{} @@ -39,8 +39,8 @@ type RejectVpcPeeringConnectionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ReleaseAddress.go b/service/ec2/api_op_ReleaseAddress.go index 7676230146a..26c410ebc78 100644 --- a/service/ec2/api_op_ReleaseAddress.go +++ b/service/ec2/api_op_ReleaseAddress.go @@ -13,20 +13,20 @@ import ( // Releases the specified Elastic IP address. [EC2-Classic, default VPC] Releasing // an Elastic IP address automatically disassociates it from any instance that it's // associated with. To disassociate an Elastic IP address without releasing it, use -// DisassociateAddress. We are retiring EC2-Classic. We recommend that you migrate -// from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to -// a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in -// the Amazon Elastic Compute Cloud User Guide. [Nondefault VPC] You must use +// DisassociateAddress . We are retiring EC2-Classic. We recommend that you migrate +// from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic +// to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. [Nondefault VPC] You must use // DisassociateAddress to disassociate the Elastic IP address before you can -// release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). +// release it. Otherwise, Amazon EC2 returns an error ( InvalidIPAddress.InUse ). // After releasing an Elastic IP address, it is released to the IP address pool. Be // sure to update your DNS records and any servers or devices that communicate with // the address. If you attempt to release an Elastic IP address that you already -// released, you'll get an AuthFailure error if the address is already allocated to -// another Amazon Web Services account. [EC2-VPC] After you release an Elastic IP -// address for use in a VPC, you might be able to recover it. For more information, -// see AllocateAddress. For more information, see Elastic IP Addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// released, you'll get an AuthFailure error if the address is already allocated +// to another Amazon Web Services account. [EC2-VPC] After you release an Elastic +// IP address for use in a VPC, you might be able to recover it. For more +// information, see AllocateAddress . For more information, see Elastic IP +// Addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ReleaseAddress(ctx context.Context, params *ReleaseAddressInput, optFns ...func(*Options)) (*ReleaseAddressOutput, error) { if params == nil { @@ -50,8 +50,8 @@ type ReleaseAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The set of Availability Zones, Local Zones, or Wavelength Zones from which diff --git a/service/ec2/api_op_ReleaseIpamPoolAllocation.go b/service/ec2/api_op_ReleaseIpamPoolAllocation.go index cdf4675cc74..73822847a91 100644 --- a/service/ec2/api_op_ReleaseIpamPoolAllocation.go +++ b/service/ec2/api_op_ReleaseIpamPoolAllocation.go @@ -13,13 +13,10 @@ import ( // Release an allocation within an IPAM pool. You can only use this action to // release manual allocations. To remove an allocation for a resource without // deleting the resource, set its monitored state to false using -// ModifyIpamResourceCidr -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html). -// For more information, see Release an allocation -// (https://docs.aws.amazon.com/vpc/latest/ipam/release-pool-alloc-ipam.html) in -// the Amazon VPC IPAM User Guide. All EC2 API actions follow an eventual -// consistency -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/query-api-troubleshooting.html#eventual-consistency) +// ModifyIpamResourceCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html) +// . For more information, see Release an allocation (https://docs.aws.amazon.com/vpc/latest/ipam/release-pool-alloc-ipam.html) +// in the Amazon VPC IPAM User Guide. All EC2 API actions follow an eventual +// consistency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/query-api-troubleshooting.html#eventual-consistency) // model. func (c *Client) ReleaseIpamPoolAllocation(ctx context.Context, params *ReleaseIpamPoolAllocationInput, optFns ...func(*Options)) (*ReleaseIpamPoolAllocationOutput, error) { if params == nil { @@ -55,8 +52,8 @@ type ReleaseIpamPoolAllocationInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go index d2eb6930648..c052ab29fbd 100644 --- a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go +++ b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replaces an IAM instance profile for the specified running instance. You can use -// this action to change the IAM instance profile that's associated with an +// Replaces an IAM instance profile for the specified running instance. You can +// use this action to change the IAM instance profile that's associated with an // instance without having to disassociate the existing IAM instance profile first. // Use DescribeIamInstanceProfileAssociations to get the association ID. func (c *Client) ReplaceIamInstanceProfileAssociation(ctx context.Context, params *ReplaceIamInstanceProfileAssociationInput, optFns ...func(*Options)) (*ReplaceIamInstanceProfileAssociationOutput, error) { diff --git a/service/ec2/api_op_ReplaceNetworkAclAssociation.go b/service/ec2/api_op_ReplaceNetworkAclAssociation.go index ddaadfc8ba4..7ad3f133ddb 100644 --- a/service/ec2/api_op_ReplaceNetworkAclAssociation.go +++ b/service/ec2/api_op_ReplaceNetworkAclAssociation.go @@ -12,9 +12,8 @@ import ( // Changes which network ACL a subnet is associated with. By default when you // create a subnet, it's automatically associated with the default network ACL. For -// more information, see Network ACLs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) in the Amazon -// Virtual Private Cloud User Guide. This is an idempotent operation. +// more information, see Network ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_ACLs.html) +// in the Amazon Virtual Private Cloud User Guide. This is an idempotent operation. func (c *Client) ReplaceNetworkAclAssociation(ctx context.Context, params *ReplaceNetworkAclAssociationInput, optFns ...func(*Options)) (*ReplaceNetworkAclAssociationOutput, error) { if params == nil { params = &ReplaceNetworkAclAssociationInput{} @@ -45,8 +44,8 @@ type ReplaceNetworkAclAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ReplaceNetworkAclEntry.go b/service/ec2/api_op_ReplaceNetworkAclEntry.go index bb2b6338ae4..29b87f18a1a 100644 --- a/service/ec2/api_op_ReplaceNetworkAclEntry.go +++ b/service/ec2/api_op_ReplaceNetworkAclEntry.go @@ -31,8 +31,8 @@ func (c *Client) ReplaceNetworkAclEntry(ctx context.Context, params *ReplaceNetw type ReplaceNetworkAclEntryInput struct { - // Indicates whether to replace the egress rule. Default: If no value is specified, - // we replace the ingress rule. + // Indicates whether to replace the egress rule. Default: If no value is + // specified, we replace the ingress rule. // // This member is required. Egress *bool @@ -42,8 +42,8 @@ type ReplaceNetworkAclEntryInput struct { // This member is required. NetworkAclId *string - // The protocol number. A value of "-1" means all protocols. If you specify "-1" or - // a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on + // The protocol number. A value of "-1" means all protocols. If you specify "-1" + // or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on // all ports is allowed, regardless of any ports or ICMP types or codes that you // specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, // traffic for all ICMP types and codes allowed, regardless of any that you @@ -64,21 +64,21 @@ type ReplaceNetworkAclEntryInput struct { RuleNumber *int32 // The IPv4 network range to allow or deny, in CIDR notation (for example - // 172.16.0.0/24). + // 172.16.0.0/24 ). CidrBlock *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - // 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. + // ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying + // protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. IcmpTypeCode *types.IcmpTypeCode // The IPv6 network range to allow or deny, in CIDR notation (for example - // 2001:bd8:1234:1a00::/64). + // 2001:bd8:1234:1a00::/64 ). Ipv6CidrBlock *string // TCP or UDP protocols: The range of ports the rule applies to. Required if diff --git a/service/ec2/api_op_ReplaceRoute.go b/service/ec2/api_op_ReplaceRoute.go index 50d7afcc2da..56df2feac82 100644 --- a/service/ec2/api_op_ReplaceRoute.go +++ b/service/ec2/api_op_ReplaceRoute.go @@ -13,9 +13,8 @@ import ( // Replaces an existing route within a route table in a VPC. You must specify // either a destination CIDR block or a prefix list ID. You must also specify // exactly one of the resources from the parameter list, or reset the local route -// to its default target. For more information, see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. +// to its default target. For more information, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. func (c *Client) ReplaceRoute(ctx context.Context, params *ReplaceRouteInput, optFns ...func(*Options)) (*ReplaceRouteOutput, error) { if params == nil { params = &ReplaceRouteInput{} @@ -57,8 +56,8 @@ type ReplaceRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // [IPv6 traffic only] The ID of an egress-only internet gateway. @@ -73,7 +72,7 @@ type ReplaceRouteInput struct { // The ID of the local gateway. LocalGatewayId *string - // Specifies whether to reset the local route to its default target (local). + // Specifies whether to reset the local route to its default target ( local ). LocalTarget *bool // [IPv4 traffic only] The ID of a NAT gateway. diff --git a/service/ec2/api_op_ReplaceRouteTableAssociation.go b/service/ec2/api_op_ReplaceRouteTableAssociation.go index 6cd30dc454f..4e175e4f357 100644 --- a/service/ec2/api_op_ReplaceRouteTableAssociation.go +++ b/service/ec2/api_op_ReplaceRouteTableAssociation.go @@ -14,10 +14,9 @@ import ( // Changes the route table associated with a given subnet, internet gateway, or // virtual private gateway in a VPC. After the operation completes, the subnet or // gateway uses the routes in the new route table. For more information about route -// tables, see Route tables -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the -// Amazon Virtual Private Cloud User Guide. You can also use this operation to -// change which table is the main route table in the VPC. Specify the main route +// tables, see Route tables (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) +// in the Amazon Virtual Private Cloud User Guide. You can also use this operation +// to change which table is the main route table in the VPC. Specify the main route // table's association ID and the route table ID of the new main route table. func (c *Client) ReplaceRouteTableAssociation(ctx context.Context, params *ReplaceRouteTableAssociationInput, optFns ...func(*Options)) (*ReplaceRouteTableAssociationOutput, error) { if params == nil { @@ -48,8 +47,8 @@ type ReplaceRouteTableAssociationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ReplaceTransitGatewayRoute.go b/service/ec2/api_op_ReplaceTransitGatewayRoute.go index 01794ff872c..c9f0d22661b 100644 --- a/service/ec2/api_op_ReplaceTransitGatewayRoute.go +++ b/service/ec2/api_op_ReplaceTransitGatewayRoute.go @@ -45,8 +45,8 @@ type ReplaceTransitGatewayRouteInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the attachment. diff --git a/service/ec2/api_op_ReplaceVpnTunnel.go b/service/ec2/api_op_ReplaceVpnTunnel.go index f026f1b73fd..35ce8117c07 100644 --- a/service/ec2/api_op_ReplaceVpnTunnel.go +++ b/service/ec2/api_op_ReplaceVpnTunnel.go @@ -43,8 +43,8 @@ type ReplaceVpnTunnelInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ReportInstanceStatus.go b/service/ec2/api_op_ReportInstanceStatus.go index 2b618b95545..467c686a9fb 100644 --- a/service/ec2/api_op_ReportInstanceStatus.go +++ b/service/ec2/api_op_ReportInstanceStatus.go @@ -14,10 +14,10 @@ import ( // Submits feedback about the status of an instance. The instance must be in the // running state. If your experience with the instance differs from the instance -// status returned by DescribeInstanceStatus, use ReportInstanceStatus to report +// status returned by DescribeInstanceStatus , use ReportInstanceStatus to report // your experience with the instance. Amazon EC2 collects this information to // improve the accuracy of status checks. Use of this action does not change the -// value returned by DescribeInstanceStatus. +// value returned by DescribeInstanceStatus . func (c *Client) ReportInstanceStatus(ctx context.Context, params *ReportInstanceStatusInput, optFns ...func(*Options)) (*ReportInstanceStatusOutput, error) { if params == nil { params = &ReportInstanceStatusInput{} @@ -41,34 +41,18 @@ type ReportInstanceStatusInput struct { Instances []string // The reason codes that describe the health state of your instance. - // - // * - // instance-stuck-in-state: My instance is stuck in a state. - // - // * unresponsive: My - // instance is unresponsive. - // - // * not-accepting-credentials: My instance is not - // accepting my credentials. - // - // * password-not-available: A password is not available - // for my instance. - // - // * performance-network: My instance is experiencing performance - // problems that I believe are network related. - // - // * performance-instance-store: My - // instance is experiencing performance problems that I believe are related to the - // instance stores. - // - // * performance-ebs-volume: My instance is experiencing - // performance problems that I believe are related to an EBS volume. - // - // * - // performance-other: My instance is experiencing performance problems. - // - // * other: - // [explain using the description parameter] + // - instance-stuck-in-state : My instance is stuck in a state. + // - unresponsive : My instance is unresponsive. + // - not-accepting-credentials : My instance is not accepting my credentials. + // - password-not-available : A password is not available for my instance. + // - performance-network : My instance is experiencing performance problems that + // I believe are network related. + // - performance-instance-store : My instance is experiencing performance + // problems that I believe are related to the instance stores. + // - performance-ebs-volume : My instance is experiencing performance problems + // that I believe are related to an EBS volume. + // - performance-other : My instance is experiencing performance problems. + // - other : [explain using the description parameter] // // This member is required. ReasonCodes []types.ReportInstanceReasonCodes @@ -83,8 +67,8 @@ type ReportInstanceStatusInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The time at which the reported instance health state ended. diff --git a/service/ec2/api_op_RequestSpotFleet.go b/service/ec2/api_op_RequestSpotFleet.go index e828e799a7b..c34639dae78 100644 --- a/service/ec2/api_op_RequestSpotFleet.go +++ b/service/ec2/api_op_RequestSpotFleet.go @@ -26,12 +26,10 @@ import ( // specify tags for the Spot Fleet request and instances launched by the fleet. You // cannot tag other resource types in a Spot Fleet request because only the // spot-fleet-request and instance resource types are supported. For more -// information, see Spot Fleet requests -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html) +// information, see Spot Fleet requests (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html) // in the Amazon EC2 User Guide. We strongly discourage using the RequestSpotFleet // API because it is a legacy API with no planned investment. For options for -// requesting Spot Instances, see Which is the best Spot request method to use? -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) +// requesting Spot Instances, see Which is the best Spot request method to use? (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) // in the Amazon EC2 User Guide. func (c *Client) RequestSpotFleet(ctx context.Context, params *RequestSpotFleetInput, optFns ...func(*Options)) (*RequestSpotFleetOutput, error) { if params == nil { @@ -58,8 +56,8 @@ type RequestSpotFleetInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RequestSpotInstances.go b/service/ec2/api_op_RequestSpotInstances.go index 3514b37f4b8..febabf398cb 100644 --- a/service/ec2/api_op_RequestSpotInstances.go +++ b/service/ec2/api_op_RequestSpotInstances.go @@ -13,18 +13,15 @@ import ( ) // Creates a Spot Instance request. For more information, see Spot Instance -// requests -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html) in the -// Amazon EC2 User Guide for Linux Instances. We strongly discourage using the -// RequestSpotInstances API because it is a legacy API with no planned investment. -// For options for requesting Spot Instances, see Which is the best Spot request -// method to use? -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) +// requests (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html) +// in the Amazon EC2 User Guide for Linux Instances. We strongly discourage using +// the RequestSpotInstances API because it is a legacy API with no planned +// investment. For options for requesting Spot Instances, see Which is the best +// Spot request method to use? (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) // in the Amazon EC2 User Guide for Linux Instances. We are retiring EC2-Classic. // We recommend that you migrate from EC2-Classic to a VPC. For more information, -// see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide for Linux Instances. +// see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide for Linux Instances. func (c *Client) RequestSpotInstances(ctx context.Context, params *RequestSpotInstancesInput, optFns ...func(*Options)) (*RequestSpotInstancesOutput, error) { if params == nil { params = &RequestSpotInstancesInput{} @@ -65,43 +62,42 @@ type RequestSpotInstancesInput struct { BlockDurationMinutes *int32 // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to Ensure Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) // in the Amazon EC2 User Guide for Linux Instances. ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of Spot Instances to launch. Default: 1 InstanceCount *int32 - // The behavior when a Spot Instance is interrupted. The default is terminate. + // The behavior when a Spot Instance is interrupted. The default is terminate . InstanceInterruptionBehavior types.InstanceInterruptionBehavior - // The instance launch group. Launch groups are Spot Instances that launch together - // and terminate together. Default: Instances are launched and terminated + // The instance launch group. Launch groups are Spot Instances that launch + // together and terminate together. Default: Instances are launched and terminated // individually LaunchGroup *string // The launch specification. LaunchSpecification *types.RequestSpotLaunchSpecification - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string // The key-value pair for tagging the Spot Instance request on creation. The value - // for ResourceType must be spot-instances-request, otherwise the Spot Instance + // for ResourceType must be spot-instances-request , otherwise the Spot Instance // request fails. To tag the Spot Instance request after it has been created, see - // CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) + // . TagSpecifications []types.TagSpecification // The Spot Instance request type. Default: one-time @@ -117,15 +113,13 @@ type RequestSpotInstancesInput struct { ValidFrom *time.Time // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). - // - // * For a - // persistent request, the request remains active until the ValidUntil date and - // time is reached. Otherwise, the request remains active until you cancel it. - // - // * - // For a one-time request, the request remains active until all instances launch, - // the request is canceled, or the ValidUntil date and time is reached. By default, - // the request is valid for 7 days from the date the request was created. + // - For a persistent request, the request remains active until the ValidUntil + // date and time is reached. Otherwise, the request remains active until you cancel + // it. + // - For a one-time request, the request remains active until all instances + // launch, the request is canceled, or the ValidUntil date and time is reached. + // By default, the request is valid for 7 days from the date the request was + // created. ValidUntil *time.Time noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetAddressAttribute.go b/service/ec2/api_op_ResetAddressAttribute.go index 25ae2076b6f..fcab04b6a1e 100644 --- a/service/ec2/api_op_ResetAddressAttribute.go +++ b/service/ec2/api_op_ResetAddressAttribute.go @@ -12,8 +12,8 @@ import ( ) // Resets the attribute of the specified IP address. For requirements, see Using -// reverse DNS for email applications -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS). +// reverse DNS for email applications (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS) +// . func (c *Client) ResetAddressAttribute(ctx context.Context, params *ResetAddressAttributeInput, optFns ...func(*Options)) (*ResetAddressAttributeOutput, error) { if params == nil { params = &ResetAddressAttributeInput{} @@ -43,8 +43,8 @@ type ResetAddressAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go b/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go index 7880617b03e..f831541f11f 100644 --- a/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Resets the default KMS key for EBS encryption for your account in this Region to -// the Amazon Web Services managed KMS key for EBS. After resetting the default KMS -// key to the Amazon Web Services managed KMS key, you can continue to encrypt by a -// customer managed KMS key by specifying it when you create the volume. For more -// information, see Amazon EBS encryption -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Resets the default KMS key for EBS encryption for your account in this Region +// to the Amazon Web Services managed KMS key for EBS. After resetting the default +// KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt +// by a customer managed KMS key by specifying it when you create the volume. For +// more information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ResetEbsDefaultKmsKeyId(ctx context.Context, params *ResetEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*ResetEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &ResetEbsDefaultKmsKeyIdInput{} @@ -36,8 +35,8 @@ type ResetEbsDefaultKmsKeyIdInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetFpgaImageAttribute.go b/service/ec2/api_op_ResetFpgaImageAttribute.go index 5523638335e..012e3333bfa 100644 --- a/service/ec2/api_op_ResetFpgaImageAttribute.go +++ b/service/ec2/api_op_ResetFpgaImageAttribute.go @@ -40,8 +40,8 @@ type ResetFpgaImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetImageAttribute.go b/service/ec2/api_op_ResetImageAttribute.go index 53f621d68c6..b9dd3b59e2f 100644 --- a/service/ec2/api_op_ResetImageAttribute.go +++ b/service/ec2/api_op_ResetImageAttribute.go @@ -43,8 +43,8 @@ type ResetImageAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetInstanceAttribute.go b/service/ec2/api_op_ResetInstanceAttribute.go index 92070db4bcc..2a280caf316 100644 --- a/service/ec2/api_op_ResetInstanceAttribute.go +++ b/service/ec2/api_op_ResetInstanceAttribute.go @@ -12,12 +12,11 @@ import ( ) // Resets an attribute of an instance to its default value. To reset the kernel or -// ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, -// the instance can be either running or stopped. The sourceDestCheck attribute +// ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck +// , the instance can be either running or stopped. The sourceDestCheck attribute // controls whether source/destination checking is enabled. The default value is -// true, which means checking is enabled. This value must be false for a NAT -// instance to perform NAT. For more information, see NAT Instances -// (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) +// true , which means checking is enabled. This value must be false for a NAT +// instance to perform NAT. For more information, see NAT Instances (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) // in the Amazon VPC User Guide. func (c *Client) ResetInstanceAttribute(ctx context.Context, params *ResetInstanceAttributeInput, optFns ...func(*Options)) (*ResetInstanceAttributeOutput, error) { if params == nil { @@ -37,7 +36,7 @@ func (c *Client) ResetInstanceAttribute(ctx context.Context, params *ResetInstan type ResetInstanceAttributeInput struct { // The attribute to reset. You can only reset the following attributes: kernel | - // ramdisk | sourceDestCheck. + // ramdisk | sourceDestCheck . // // This member is required. Attribute types.InstanceAttributeName @@ -49,8 +48,8 @@ type ResetInstanceAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetNetworkInterfaceAttribute.go b/service/ec2/api_op_ResetNetworkInterfaceAttribute.go index f648eaae1ae..9016ba86102 100644 --- a/service/ec2/api_op_ResetNetworkInterfaceAttribute.go +++ b/service/ec2/api_op_ResetNetworkInterfaceAttribute.go @@ -37,11 +37,11 @@ type ResetNetworkInterfaceAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The source/destination checking attribute. Resets the value to true. + // The source/destination checking attribute. Resets the value to true . SourceDestCheck *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ResetSnapshotAttribute.go b/service/ec2/api_op_ResetSnapshotAttribute.go index f5fd73e08b0..830f26cdd92 100644 --- a/service/ec2/api_op_ResetSnapshotAttribute.go +++ b/service/ec2/api_op_ResetSnapshotAttribute.go @@ -12,8 +12,7 @@ import ( ) // Resets permission settings for the specified snapshot. For more information -// about modifying snapshot permissions, see Share a snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html) +// about modifying snapshot permissions, see Share a snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) ResetSnapshotAttribute(ctx context.Context, params *ResetSnapshotAttributeInput, optFns ...func(*Options)) (*ResetSnapshotAttributeOutput, error) { if params == nil { @@ -45,8 +44,8 @@ type ResetSnapshotAttributeInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RestoreAddressToClassic.go b/service/ec2/api_op_RestoreAddressToClassic.go index 44553479cb5..69349eb1d59 100644 --- a/service/ec2/api_op_RestoreAddressToClassic.go +++ b/service/ec2/api_op_RestoreAddressToClassic.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restores an Elastic IP address that was previously moved to the EC2-VPC platform -// back to the EC2-Classic platform. You cannot move an Elastic IP address that was -// originally allocated for use in EC2-VPC. The Elastic IP address must not be -// associated with an instance or network interface. We are retiring EC2-Classic. -// We recommend that you migrate from EC2-Classic to a VPC. For more information, -// see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Restores an Elastic IP address that was previously moved to the EC2-VPC +// platform back to the EC2-Classic platform. You cannot move an Elastic IP address +// that was originally allocated for use in EC2-VPC. The Elastic IP address must +// not be associated with an instance or network interface. We are retiring +// EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more +// information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) RestoreAddressToClassic(ctx context.Context, params *RestoreAddressToClassicInput, optFns ...func(*Options)) (*RestoreAddressToClassicOutput, error) { if params == nil { params = &RestoreAddressToClassicInput{} @@ -43,8 +42,8 @@ type RestoreAddressToClassicInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RestoreImageFromRecycleBin.go b/service/ec2/api_op_RestoreImageFromRecycleBin.go index 405a6f120f9..e059b5b6a06 100644 --- a/service/ec2/api_op_RestoreImageFromRecycleBin.go +++ b/service/ec2/api_op_RestoreImageFromRecycleBin.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restores an AMI from the Recycle Bin. For more information, see Recycle Bin -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the -// Amazon EC2 User Guide. +// Restores an AMI from the Recycle Bin. For more information, see Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) +// in the Amazon EC2 User Guide. func (c *Client) RestoreImageFromRecycleBin(ctx context.Context, params *RestoreImageFromRecycleBinInput, optFns ...func(*Options)) (*RestoreImageFromRecycleBinOutput, error) { if params == nil { params = &RestoreImageFromRecycleBinInput{} @@ -37,8 +36,8 @@ type RestoreImageFromRecycleBinInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RestoreManagedPrefixListVersion.go b/service/ec2/api_op_RestoreManagedPrefixListVersion.go index 0800fe6af52..36c0e7b5fc9 100644 --- a/service/ec2/api_op_RestoreManagedPrefixListVersion.go +++ b/service/ec2/api_op_RestoreManagedPrefixListVersion.go @@ -47,8 +47,8 @@ type RestoreManagedPrefixListVersionInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go b/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go index 58be950574b..3ffb45c9b3d 100644 --- a/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go +++ b/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go @@ -13,8 +13,7 @@ import ( ) // Restores a snapshot from the Recycle Bin. For more information, see Restore -// snapshots from the Recycle Bin -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps) +// snapshots from the Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) RestoreSnapshotFromRecycleBin(ctx context.Context, params *RestoreSnapshotFromRecycleBinInput, optFns ...func(*Options)) (*RestoreSnapshotFromRecycleBinOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type RestoreSnapshotFromRecycleBinInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde @@ -56,9 +55,8 @@ type RestoreSnapshotFromRecycleBinOutput struct { Encrypted *bool // The ARN of the Outpost on which the snapshot is stored. For more information, - // see Amazon EBS local snapshots on Outposts - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) in - // the Amazon Elastic Compute Cloud User Guide. + // see Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) + // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string // The ID of the Amazon Web Services account that owns the EBS snapshot. diff --git a/service/ec2/api_op_RestoreSnapshotTier.go b/service/ec2/api_op_RestoreSnapshotTier.go index 9e8945b9906..8831f5f27b5 100644 --- a/service/ec2/api_op_RestoreSnapshotTier.go +++ b/service/ec2/api_op_RestoreSnapshotTier.go @@ -13,11 +13,9 @@ import ( // Restores an archived Amazon EBS snapshot for use temporarily or permanently, or // modifies the restore period or restore type for a snapshot that was previously -// temporarily restored. For more information see Restore an archived snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#restore-archived-snapshot) -// and modify the restore period or restore type for a temporarily restored -// snapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#modify-temp-restore-period) +// temporarily restored. For more information see Restore an archived snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#restore-archived-snapshot) +// and modify the restore period or restore type for a temporarily restored +// snapshot (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#modify-temp-restore-period) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) RestoreSnapshotTier(ctx context.Context, params *RestoreSnapshotTierInput, optFns ...func(*Options)) (*RestoreSnapshotTierOutput, error) { if params == nil { @@ -43,8 +41,8 @@ type RestoreSnapshotTierInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether to permanently restore an archived snapshot. To permanently @@ -56,7 +54,7 @@ type RestoreSnapshotTierInput struct { // snapshot. Required for temporary restores only. The snapshot will be // automatically re-archived after this period. To temporarily restore an archived // snapshot, specify the number of days and omit the PermanentRestore parameter or - // set it to false. + // set it to false . TemporaryRestoreDays *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_RevokeClientVpnIngress.go b/service/ec2/api_op_RevokeClientVpnIngress.go index d2c45f25c0a..233851c423d 100644 --- a/service/ec2/api_op_RevokeClientVpnIngress.go +++ b/service/ec2/api_op_RevokeClientVpnIngress.go @@ -46,8 +46,8 @@ type RevokeClientVpnIngressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether access should be revoked for all clients. diff --git a/service/ec2/api_op_RevokeSecurityGroupEgress.go b/service/ec2/api_op_RevokeSecurityGroupEgress.go index ba550d04365..e28e2288c4f 100644 --- a/service/ec2/api_op_RevokeSecurityGroupEgress.go +++ b/service/ec2/api_op_RevokeSecurityGroupEgress.go @@ -53,15 +53,15 @@ type RevokeSecurityGroupEgressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Not supported. Use a set of IP permissions to specify the port. FromPort *int32 - // The sets of IP permissions. You can't specify a destination security group and a - // CIDR IP address range in the same set of permissions. + // The sets of IP permissions. You can't specify a destination security group and + // a CIDR IP address range in the same set of permissions. IpPermissions []types.IpPermission // Not supported. Use a set of IP permissions to specify the protocol name or @@ -91,8 +91,7 @@ type RevokeSecurityGroupEgressOutput struct { Return *bool // The outbound rules that were unknown to the service. In some cases, - // unknownIpPermissionSet might be in a different format from the request - // parameter. + // unknownIpPermissionSet might be in a different format from the request parameter. UnknownIpPermissions []types.IpPermission // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_RevokeSecurityGroupIngress.go b/service/ec2/api_op_RevokeSecurityGroupIngress.go index 997b2b73fd7..0dd3a277d88 100644 --- a/service/ec2/api_op_RevokeSecurityGroupIngress.go +++ b/service/ec2/api_op_RevokeSecurityGroupIngress.go @@ -26,9 +26,8 @@ import ( // changes are propagated to instances within the security group as quickly as // possible. However, a small delay might occur. We are retiring EC2-Classic. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. func (c *Client) RevokeSecurityGroupIngress(ctx context.Context, params *RevokeSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeSecurityGroupIngressOutput, error) { if params == nil { params = &RevokeSecurityGroupIngressInput{} @@ -52,8 +51,8 @@ type RevokeSecurityGroupIngressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // If the protocol is TCP or UDP, this is the start of the port range. If the @@ -71,13 +70,12 @@ type RevokeSecurityGroupIngressInput struct { // security groups in a nondefault VPC, you must specify the security group ID. GroupName *string - // The sets of IP permissions. You can't specify a source security group and a CIDR - // IP address range in the same set of permissions. + // The sets of IP permissions. You can't specify a source security group and a + // CIDR IP address range in the same set of permissions. IpPermissions []types.IpPermission - // The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use - // -1 to specify all. + // The IP protocol name ( tcp , udp , icmp ) or number (see Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // ). Use -1 to specify all. IpProtocol *string // The IDs of the security group rules. @@ -112,8 +110,7 @@ type RevokeSecurityGroupIngressOutput struct { Return *bool // The inbound rules that were unknown to the service. In some cases, - // unknownIpPermissionSet might be in a different format from the request - // parameter. + // unknownIpPermissionSet might be in a different format from the request parameter. UnknownIpPermissions []types.IpPermission // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_RunInstances.go b/service/ec2/api_op_RunInstances.go index 8e4e475695f..7770dfee0fb 100644 --- a/service/ec2/api_op_RunInstances.go +++ b/service/ec2/api_op_RunInstances.go @@ -15,63 +15,45 @@ import ( // Launches the specified number of instances using an AMI for which you have // permissions. You can specify a number of options, or leave the default options. // The following rules apply: +// - [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from +// your default VPC for you. If you don't have a default VPC, you must specify a +// subnet ID in the request. +// - [EC2-Classic] If don't specify an Availability Zone, we choose one for you. +// - Some instance types must be launched into a VPC. If you do not have a +// default VPC, or if you do not specify a subnet ID, the request fails. For more +// information, see Instance types available only in a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types) +// . +// - [EC2-VPC] All instances have a network interface with a primary private +// IPv4 address. If you don't specify this address, we choose one from the IPv4 +// range of your subnet. +// - Not all instance types support IPv6 addresses. For more information, see +// Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) +// . +// - If you don't specify a security group ID, we use the default security +// group. For more information, see Security groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) +// . +// - If any of the AMIs have a product code attached for which the user has not +// subscribed, the request fails. // -// * [EC2-VPC] If you don't specify a subnet ID, we -// choose a default subnet from your default VPC for you. If you don't have a -// default VPC, you must specify a subnet ID in the request. -// -// * [EC2-Classic] If -// don't specify an Availability Zone, we choose one for you. -// -// * Some instance -// types must be launched into a VPC. If you do not have a default VPC, or if you -// do not specify a subnet ID, the request fails. For more information, see -// Instance types available only in a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types). -// -// * -// [EC2-VPC] All instances have a network interface with a primary private IPv4 -// address. If you don't specify this address, we choose one from the IPv4 range of -// your subnet. -// -// * Not all instance types support IPv6 addresses. For more -// information, see Instance types -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). -// -// * If -// you don't specify a security group ID, we use the default security group. For -// more information, see Security groups -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). -// -// * -// If any of the AMIs have a product code attached for which the user has not -// subscribed, the request fails. -// -// You can create a launch template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html), -// which is a resource that contains the parameters to launch an instance. When you -// launch an instance using RunInstances, you can specify the launch template +// You can create a launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// , which is a resource that contains the parameters to launch an instance. When +// you launch an instance using RunInstances , you can specify the launch template // instead of specifying the launch parameters. To ensure faster instance launches, // break up large requests into smaller batches. For example, create five separate // launch requests for 100 instances each instead of one launch request for 500 // instances. An instance is ready for you to use when it's in the running state. -// You can check the state of your instance using DescribeInstances. You can tag +// You can check the state of your instance using DescribeInstances . You can tag // instances and EBS volumes during launch, after launch, or both. For more -// information, see CreateTags and Tagging your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html). Linux -// instances have access to the public key of the key pair at boot. You can use -// this key to provide secure access to the instance. Amazon EC2 public images use -// this feature to provide secure access without passwords. For more information, -// see Key pairs -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html). For -// troubleshooting, see What to do if an instance immediately terminates -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html), -// and Troubleshooting connecting to your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html). -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide. +// information, see CreateTags and Tagging your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// . Linux instances have access to the public key of the key pair at boot. You can +// use this key to provide secure access to the instance. Amazon EC2 public images +// use this feature to provide secure access without passwords. For more +// information, see Key pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) +// . For troubleshooting, see What to do if an instance immediately terminates (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html) +// , and Troubleshooting connecting to your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html) +// . We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide. func (c *Client) RunInstances(ctx context.Context, params *RunInstancesInput, optFns ...func(*Options)) (*RunInstancesOutput, error) { if params == nil { params = &RunInstancesInput{} @@ -91,24 +73,22 @@ type RunInstancesInput struct { // The maximum number of instances to launch. If you specify more instances than // Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the - // largest possible number of instances above MinCount. Constraints: Between 1 and + // largest possible number of instances above MinCount . Constraints: Between 1 and // the maximum number you're allowed for the specified instance type. For more // information about the default limits, and how to request an increase, see How - // many instances can I run in Amazon EC2 - // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in - // the Amazon EC2 FAQ. + // many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) + // in the Amazon EC2 FAQ. // // This member is required. MaxCount *int32 - // The minimum number of instances to launch. If you specify a minimum that is more - // instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 - // launches no instances. Constraints: Between 1 and the maximum number you're - // allowed for the specified instance type. For more information about the default - // limits, and how to request an increase, see How many instances can I run in - // Amazon EC2 - // (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) in - // the Amazon EC2 General FAQ. + // The minimum number of instances to launch. If you specify a minimum that is + // more instances than Amazon EC2 can launch in the target Availability Zone, + // Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number + // you're allowed for the specified instance type. For more information about the + // default limits, and how to request an increase, see How many instances can I + // run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2) + // in the Amazon EC2 General FAQ. // // This member is required. MinCount *int32 @@ -118,59 +98,53 @@ type RunInstancesInput struct { // The block device mapping, which defines the EBS volumes and instance store // volumes to attach to the instance at launch. For more information, see Block - // device mappings - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) + // device mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) // in the Amazon EC2 User Guide. BlockDeviceMappings []types.BlockDeviceMapping // Information about the Capacity Reservation targeting option. If you do not // specify this parameter, the instance's Capacity Reservation preference defaults - // to open, which enables it to run in any open Capacity Reservation that has + // to open , which enables it to run in any open Capacity Reservation that has // matching attributes (instance type, platform, Availability Zone). CapacityReservationSpecification *types.CapacityReservationSpecification // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, a randomly generated token is // used for the request to ensure idempotency. For more information, see Ensuring - // Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraints: Maximum 64 ASCII characters + // Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraints: Maximum 64 ASCII characters ClientToken *string - // The CPU options for the instance. For more information, see Optimize CPU options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) + // The CPU options for the instance. For more information, see Optimize CPU options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon EC2 User Guide. CpuOptions *types.CpuOptionsRequest // The credit option for CPU usage of the burstable performance instance. Valid - // values are standard and unlimited. To change this attribute after launch, use - // ModifyInstanceCreditSpecification - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). - // For more information, see Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // values are standard and unlimited . To change this attribute after launch, use + // ModifyInstanceCreditSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html) + // . For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. Default: standard (T2 instances) or unlimited // (T3/T3a/T4g instances) For T3 instances with host tenancy, only standard is // supported. CreditSpecification *types.CreditSpecificationRequest // Indicates whether an instance is enabled for stop protection. For more - // information, see Stop protection - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection). + // information, see Stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) + // . DisableApiStop *bool - // If you set this parameter to true, you can't terminate the instance using the + // If you set this parameter to true , you can't terminate the instance using the // Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute - // after launch, use ModifyInstanceAttribute - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). - // Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you + // after launch, use ModifyInstanceAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) + // . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you // can terminate the instance by running the shutdown command from the instance. // Default: false DisableApiTermination *bool // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Indicates whether the instance is optimized for Amazon EBS I/O. This @@ -183,8 +157,7 @@ type RunInstancesInput struct { // An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource // that you can attach to your Windows instance to accelerate the graphics // performance of your applications. For more information, see Amazon EC2 Elastic - // GPUs - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) + // GPUs (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html) // in the Amazon EC2 User Guide. ElasticGpuSpecification []types.ElasticGpuSpecification @@ -202,17 +175,15 @@ type RunInstancesInput struct { ElasticInferenceAccelerators []types.ElasticInferenceAccelerator // Indicates whether the instance is enabled for Amazon Web Services Nitro - // Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? - // (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the - // Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon Web - // Services Nitro Enclaves and hibernation on the same instance. + // Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) + // in the Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon + // Web Services Nitro Enclaves and hibernation on the same instance. EnclaveOptions *types.EnclaveOptionsRequest // Indicates whether an instance is enabled for hibernation. For more information, - // see Hibernate your instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon EC2 User Guide. You can't enable hibernation and Amazon Web Services - // Nitro Enclaves on the same instance. + // see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) + // in the Amazon EC2 User Guide. You can't enable hibernation and Amazon Web + // Services Nitro Enclaves on the same instance. HibernationOptions *types.HibernationOptionsRequest // The name or Amazon Resource Name (ARN) of an IAM instance profile. @@ -227,14 +198,13 @@ type RunInstancesInput struct { // Default: stop InstanceInitiatedShutdownBehavior types.ShutdownBehavior - // The market (purchasing) option for the instances. For RunInstances, persistent + // The market (purchasing) option for the instances. For RunInstances , persistent // Spot Instance requests are only supported when InstanceInterruptionBehavior is - // set to either hibernate or stop. + // set to either hibernate or stop . InstanceMarketOptions *types.InstanceMarketOptionsRequest - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. Default: m1.small + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. Default: m1.small InstanceType types.InstanceType // [EC2-VPC] The number of IPv6 addresses to associate with the primary network @@ -253,22 +223,19 @@ type RunInstancesInput struct { Ipv6Addresses []types.InstanceIpv6Address // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and - // RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // RAM disks. For more information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) // in the Amazon EC2 User Guide. KernelId *string - // The name of the key pair. You can create a key pair using CreateKeyPair - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) - // or ImportKeyPair - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html). - // If you do not specify a key pair, you can't connect to the instance unless you + // The name of the key pair. You can create a key pair using CreateKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) + // or ImportKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) + // . If you do not specify a key pair, you can't connect to the instance unless you // choose an AMI that is configured to allow users another way to log in. KeyName *string // The launch template to use to launch the instances. Any parameters that you - // specify in RunInstances override the same parameters in the launch template. You - // can specify either the name or ID of a launch template, but not both. + // specify in RunInstances override the same parameters in the launch template. + // You can specify either the name or ID of a launch template, but not both. LaunchTemplate *types.LaunchTemplateSpecification // The license configurations. @@ -278,8 +245,8 @@ type RunInstancesInput struct { MaintenanceOptions *types.InstanceMaintenanceOptionsRequest // The metadata options for the instance. For more information, see Instance - // metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). + // metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // . MetadataOptions *types.InstanceMetadataOptionsRequest // Specifies whether detailed monitoring is enabled for the instance. @@ -293,8 +260,8 @@ type RunInstancesInput struct { // The placement for the instance. Placement *types.Placement - // The options for the instance hostname. The default values are inherited from the - // subnet. + // The options for the instance hostname. The default values are inherited from + // the subnet. PrivateDnsNameOptions *types.PrivateDnsNameOptionsRequest // [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 @@ -310,16 +277,14 @@ type RunInstancesInput struct { // launch. Check the kernel requirements for information about whether you need to // specify a RAM disk. To find kernel requirements, go to the Amazon Web Services // Resource Center and search for the kernel ID. We recommend that you use PV-GRUB - // instead of kernels and RAM disks. For more information, see PV-GRUB - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // instead of kernels and RAM disks. For more information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) // in the Amazon EC2 User Guide. RamdiskId *string // The IDs of the security groups. You can create a security group using - // CreateSecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). - // If you specify a network interface, you must specify any security groups as part - // of the network interface. + // CreateSecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html) + // . If you specify a network interface, you must specify any security groups as + // part of the network interface. SecurityGroupIds []string // [EC2-Classic, default VPC] The names of the security groups. If you specify a @@ -334,31 +299,21 @@ type RunInstancesInput struct { // The tags to apply to the resources that are created during instance launch. You // can specify tags for the following resources only: - // - // * Instances - // - // * Volumes - // - // * - // Elastic graphics - // - // * Spot Instance requests - // - // * Network interfaces - // - // To tag a - // resource after it has been created, see CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // - Instances + // - Volumes + // - Elastic graphics + // - Spot Instance requests + // - Network interfaces + // To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) + // . TagSpecifications []types.TagSpecification // The user data script to make available to the instance. For more information, - // see Run commands on your Linux instance at launch - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and Run - // commands on your Windows instance at launch - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html). - // If you are using a command line tool, base64-encoding is performed for you, and - // you can load the text from a file. Otherwise, you must provide base64-encoded - // text. User data is limited to 16 KB. + // see Run commands on your Linux instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) + // and Run commands on your Windows instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html) + // . If you are using a command line tool, base64-encoding is performed for you, + // and you can load the text from a file. Otherwise, you must provide + // base64-encoded text. User data is limited to 16 KB. UserData *string noSmithyDocumentSerde @@ -378,8 +333,8 @@ type RunInstancesOutput struct { // The ID of the Amazon Web Services account that owns the reservation. OwnerId *string - // The ID of the requester that launched the instances on your behalf (for example, - // Amazon Web Services Management Console or Auto Scaling). + // The ID of the requester that launched the instances on your behalf (for + // example, Amazon Web Services Management Console or Auto Scaling). RequesterId *string // The ID of the reservation. diff --git a/service/ec2/api_op_RunScheduledInstances.go b/service/ec2/api_op_RunScheduledInstances.go index 4941ca2254e..c9faf60b810 100644 --- a/service/ec2/api_op_RunScheduledInstances.go +++ b/service/ec2/api_op_RunScheduledInstances.go @@ -14,12 +14,11 @@ import ( // Launches the specified Scheduled Instances. Before you can launch a Scheduled // Instance, you must purchase it and obtain an identifier using -// PurchaseScheduledInstances. You must launch a Scheduled Instance during its +// PurchaseScheduledInstances . You must launch a Scheduled Instance during its // scheduled time period. You can't stop or reboot a Scheduled Instance, but you // can terminate it as needed. If you terminate a Scheduled Instance before the // current scheduled time period ends, you can launch it again after a few minutes. -// For more information, see Scheduled Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-scheduled-instances.html) +// For more information, see Scheduled Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-scheduled-instances.html) // in the Amazon EC2 User Guide. func (c *Client) RunScheduledInstances(ctx context.Context, params *RunScheduledInstancesInput, optFns ...func(*Options)) (*RunScheduledInstancesOutput, error) { if params == nil { @@ -51,14 +50,14 @@ type RunScheduledInstancesInput struct { ScheduledInstanceId *string // Unique, case-sensitive identifier that ensures the idempotency of the request. - // For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The number of instances. Default: 1 diff --git a/service/ec2/api_op_SearchLocalGatewayRoutes.go b/service/ec2/api_op_SearchLocalGatewayRoutes.go index 13b70e27a4a..34eb3ee0a45 100644 --- a/service/ec2/api_op_SearchLocalGatewayRoutes.go +++ b/service/ec2/api_op_SearchLocalGatewayRoutes.go @@ -37,33 +37,23 @@ type SearchLocalGatewayRoutesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. - // - // * prefix-list-id - The ID of the prefix list. - // - // * - // route-search.exact-match - The exact match of the specified filter. - // - // * - // route-search.longest-prefix-match - The longest prefix that matches the - // route. - // - // * route-search.subnet-of-match - The routes with a subnet that match the - // specified CIDR filter. - // - // * route-search.supernet-of-match - The routes with a - // CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and - // 10.0.1.0/31 routes in your route table and you specify supernet-of-match as - // 10.0.1.0/30, then the result returns 10.0.1.0/29. - // - // * state - The state of the - // route. - // - // * type - The route type. + // - prefix-list-id - The ID of the prefix list. + // - route-search.exact-match - The exact match of the specified filter. + // - route-search.longest-prefix-match - The longest prefix that matches the + // route. + // - route-search.subnet-of-match - The routes with a subnet that match the + // specified CIDR filter. + // - route-search.supernet-of-match - The routes with a CIDR that encompass the + // CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your + // route table and you specify supernet-of-match as 10.0.1.0/30, then the result + // returns 10.0.1.0/29. + // - state - The state of the route. + // - type - The route type. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the diff --git a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go index be520e56685..e045d037b54 100644 --- a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go +++ b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go @@ -38,37 +38,23 @@ type SearchTransitGatewayMulticastGroupsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // One or more filters. The possible values are: - // - // * group-ip-address - The IP - // address of the transit gateway multicast group. - // - // * is-group-member - The - // resource is a group member. Valid values are true | false. - // - // * is-group-source - - // The resource is a group source. Valid values are true | false. - // - // * member-type - - // The member type. Valid values are igmp | static. - // - // * resource-id - The ID of the - // resource. - // - // * resource-type - The type of resource. Valid values are vpc | vpn | - // direct-connect-gateway | tgw-peering. - // - // * source-type - The source type. Valid - // values are igmp | static. - // - // * subnet-id - The ID of the subnet. - // - // * - // transit-gateway-attachment-id - The id of the transit gateway attachment. + // - group-ip-address - The IP address of the transit gateway multicast group. + // - is-group-member - The resource is a group member. Valid values are true | + // false . + // - is-group-source - The resource is a group source. Valid values are true | + // false . + // - member-type - The member type. Valid values are igmp | static . + // - resource-id - The ID of the resource. + // - resource-type - The type of resource. Valid values are vpc | vpn | + // direct-connect-gateway | tgw-peering . + // - source-type - The source type. Valid values are igmp | static . + // - subnet-id - The ID of the subnet. + // - transit-gateway-attachment-id - The id of the transit gateway attachment. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the @@ -167,8 +153,8 @@ type SearchTransitGatewayMulticastGroupsAPIClient interface { var _ SearchTransitGatewayMulticastGroupsAPIClient = (*Client)(nil) -// SearchTransitGatewayMulticastGroupsPaginatorOptions is the paginator options for -// SearchTransitGatewayMulticastGroups +// SearchTransitGatewayMulticastGroupsPaginatorOptions is the paginator options +// for SearchTransitGatewayMulticastGroups type SearchTransitGatewayMulticastGroupsPaginatorOptions 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. diff --git a/service/ec2/api_op_SearchTransitGatewayRoutes.go b/service/ec2/api_op_SearchTransitGatewayRoutes.go index 7f6226e1a4a..d9ae4510e27 100644 --- a/service/ec2/api_op_SearchTransitGatewayRoutes.go +++ b/service/ec2/api_op_SearchTransitGatewayRoutes.go @@ -30,39 +30,23 @@ func (c *Client) SearchTransitGatewayRoutes(ctx context.Context, params *SearchT type SearchTransitGatewayRoutesInput struct { // One or more filters. The possible values are: - // - // * - // attachment.transit-gateway-attachment-id- The id of the transit gateway - // attachment. - // - // * attachment.resource-id - The resource id of the transit gateway - // attachment. - // - // * attachment.resource-type - The attachment resource type. Valid - // values are vpc | vpn | direct-connect-gateway | peering | connect. - // - // * - // prefix-list-id - The ID of the prefix list. - // - // * route-search.exact-match - The - // exact match of the specified filter. - // - // * route-search.longest-prefix-match - The - // longest prefix that matches the route. - // - // * route-search.subnet-of-match - The - // routes with a subnet that match the specified CIDR filter. - // - // * - // route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR - // filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your - // route table and you specify supernet-of-match as 10.0.1.0/30, then the result - // returns 10.0.1.0/29. - // - // * state - The state of the route (active | blackhole). - // - // * - // type - The type of route (propagated | static). + // - attachment.transit-gateway-attachment-id - The id of the transit gateway + // attachment. + // - attachment.resource-id - The resource id of the transit gateway attachment. + // - attachment.resource-type - The attachment resource type. Valid values are + // vpc | vpn | direct-connect-gateway | peering | connect . + // - prefix-list-id - The ID of the prefix list. + // - route-search.exact-match - The exact match of the specified filter. + // - route-search.longest-prefix-match - The longest prefix that matches the + // route. + // - route-search.subnet-of-match - The routes with a subnet that match the + // specified CIDR filter. + // - route-search.supernet-of-match - The routes with a CIDR that encompass the + // CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your + // route table and you specify supernet-of-match as 10.0.1.0/30, then the result + // returns 10.0.1.0/29. + // - state - The state of the route ( active | blackhole ). + // - type - The type of route ( propagated | static ). // // This member is required. Filters []types.Filter @@ -74,8 +58,8 @@ type SearchTransitGatewayRoutesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The maximum number of routes to return. diff --git a/service/ec2/api_op_SendDiagnosticInterrupt.go b/service/ec2/api_op_SendDiagnosticInterrupt.go index 581637b0780..6b33f998729 100644 --- a/service/ec2/api_op_SendDiagnosticInterrupt.go +++ b/service/ec2/api_op_SendDiagnosticInterrupt.go @@ -21,10 +21,8 @@ import ( // operating system is configured to perform the required diagnostic tasks. For // more information about configuring your operating system to generate a crash // dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt -// (for advanced users) -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/diagnostic-interrupt.html) -// (Linux instances) or Send a diagnostic interrupt (for advanced users) -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/diagnostic-interrupt.html) +// (for advanced users) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/diagnostic-interrupt.html) +// (Linux instances) or Send a diagnostic interrupt (for advanced users) (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/diagnostic-interrupt.html) // (Windows instances). func (c *Client) SendDiagnosticInterrupt(ctx context.Context, params *SendDiagnosticInterruptInput, optFns ...func(*Options)) (*SendDiagnosticInterruptOutput, error) { if params == nil { @@ -50,8 +48,8 @@ type SendDiagnosticInterruptInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_StartInstances.go b/service/ec2/api_op_StartInstances.go index 18821a93130..9b30c4225c6 100644 --- a/service/ec2/api_op_StartInstances.go +++ b/service/ec2/api_op_StartInstances.go @@ -25,10 +25,9 @@ import ( // attempt to start a T3 instance with host tenancy and the unlimted CPU credit // option, the request fails. The unlimited CPU credit option is not supported on // Dedicated Hosts. Before you start the instance, either change its CPU credit -// option to standard, or change its tenancy to default or dedicated. For more -// information, see Stop and start your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the -// Amazon EC2 User Guide. +// option to standard , or change its tenancy to default or dedicated . For more +// information, see Stop and start your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) +// in the Amazon EC2 User Guide. func (c *Client) StartInstances(ctx context.Context, params *StartInstancesInput, optFns ...func(*Options)) (*StartInstancesOutput, error) { if params == nil { params = &StartInstancesInput{} @@ -56,8 +55,8 @@ type StartInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go b/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go index 513f334c7b2..3133e250b84 100644 --- a/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go +++ b/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go @@ -31,8 +31,8 @@ func (c *Client) StartNetworkInsightsAccessScopeAnalysis(ctx context.Context, pa type StartNetworkInsightsAccessScopeAnalysisInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . // // This member is required. ClientToken *string @@ -44,8 +44,8 @@ type StartNetworkInsightsAccessScopeAnalysisInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The tags to apply. diff --git a/service/ec2/api_op_StartNetworkInsightsAnalysis.go b/service/ec2/api_op_StartNetworkInsightsAnalysis.go index 2ea31a0be44..42e3e3744e2 100644 --- a/service/ec2/api_op_StartNetworkInsightsAnalysis.go +++ b/service/ec2/api_op_StartNetworkInsightsAnalysis.go @@ -32,8 +32,8 @@ func (c *Client) StartNetworkInsightsAnalysis(ctx context.Context, params *Start type StartNetworkInsightsAnalysisInput struct { // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . // // This member is required. ClientToken *string @@ -48,8 +48,8 @@ type StartNetworkInsightsAnalysisInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The Amazon Resource Names (ARN) of the resources that the path must traverse. diff --git a/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go b/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go index a5cf995cb09..9a3a0acf010 100644 --- a/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go +++ b/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go @@ -39,8 +39,8 @@ type StartVpcEndpointServicePrivateDnsVerificationInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_StopInstances.go b/service/ec2/api_op_StopInstances.go index bee760100a4..83441c1feb3 100644 --- a/service/ec2/api_op_StopInstances.go +++ b/service/ec2/api_op_StopInstances.go @@ -12,25 +12,20 @@ import ( ) // Stops an Amazon EBS-backed instance. For more information, see Stop and start -// your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the -// Amazon EC2 User Guide. You can use the Stop action to hibernate an instance if -// the instance is enabled for hibernation -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#enabling-hibernation) -// and it meets the hibernation prerequisites -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). -// For more information, see Hibernate your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the -// Amazon EC2 User Guide. We don't charge usage for a stopped instance, or data -// transfer fees; however, your root partition Amazon EBS volume remains and +// your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) +// in the Amazon EC2 User Guide. You can use the Stop action to hibernate an +// instance if the instance is enabled for hibernation (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#enabling-hibernation) +// and it meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites) +// . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) +// in the Amazon EC2 User Guide. We don't charge usage for a stopped instance, or +// data transfer fees; however, your root partition Amazon EBS volume remains and // continues to persist your data, and you are charged for Amazon EBS volume usage. // Every time you start your instance, Amazon EC2 charges a one-minute minimum for // instance usage, and thereafter charges per second for instance usage. You can't // stop or hibernate instance store-backed instances. You can't use the Stop action // to hibernate Spot Instances, but you can specify that Amazon EC2 should // hibernate Spot Instances when they are interrupted. For more information, see -// Hibernating interrupted Spot Instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances) +// Hibernating interrupted Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances) // in the Amazon EC2 User Guide. When you stop or hibernate an instance, we shut it // down. You can restart your instance at any time. Before stopping or hibernating // an instance, make sure it is in a state from which it can be restarted. Stopping @@ -42,13 +37,11 @@ import ( // persist. When you terminate an instance, the root device and any other devices // attached during the instance launch are automatically deleted. For more // information about the differences between rebooting, stopping, hibernating, and -// terminating instances, see Instance lifecycle -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) +// terminating instances, see Instance lifecycle (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) // in the Amazon EC2 User Guide. When you stop an instance, we attempt to shut it // down forcibly after a short while. If your instance appears stuck in the // stopping state after a period of time, there may be an issue with the underlying -// host computer. For more information, see Troubleshoot stopping your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html) +// host computer. For more information, see Troubleshoot stopping your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html) // in the Amazon EC2 User Guide. func (c *Client) StopInstances(ctx context.Context, params *StopInstancesInput, optFns ...func(*Options)) (*StopInstancesOutput, error) { if params == nil { @@ -74,8 +67,8 @@ type StopInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // Forces the instances to stop. The instances do not have an opportunity to flush @@ -86,9 +79,8 @@ type StopInstancesInput struct { // Hibernates the instance if the instance was enabled for hibernation at launch. // If the instance cannot hibernate successfully, a normal shutdown occurs. For - // more information, see Hibernate your instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon EC2 User Guide. Default: false + // more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) + // in the Amazon EC2 User Guide. Default: false Hibernate *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_TerminateClientVpnConnections.go b/service/ec2/api_op_TerminateClientVpnConnections.go index e79d02251ab..dcb9450d1fb 100644 --- a/service/ec2/api_op_TerminateClientVpnConnections.go +++ b/service/ec2/api_op_TerminateClientVpnConnections.go @@ -41,8 +41,8 @@ type TerminateClientVpnConnectionsInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The name of the user who initiated the connection. Use this option to terminate diff --git a/service/ec2/api_op_TerminateInstances.go b/service/ec2/api_op_TerminateInstances.go index 4807b76ac19..65dc549a565 100644 --- a/service/ec2/api_op_TerminateInstances.go +++ b/service/ec2/api_op_TerminateInstances.go @@ -18,54 +18,38 @@ import ( // multiple instances across multiple Availability Zones, and one or more of the // specified instances are enabled for termination protection, the request fails // with the following results: +// - The specified instances that are in the same Availability Zone as the +// protected instance are not terminated. +// - The specified instances that are in different Availability Zones, where no +// other specified instances are protected, are successfully terminated. // -// * The specified instances that are in the same -// Availability Zone as the protected instance are not terminated. +// For example, say you have the following instances: +// - Instance A: us-east-1a ; Not protected +// - Instance B: us-east-1a ; Not protected +// - Instance C: us-east-1b ; Protected +// - Instance D: us-east-1b ; not protected // -// * The specified -// instances that are in different Availability Zones, where no other specified -// instances are protected, are successfully terminated. +// If you attempt to terminate all of these instances in the same request, the +// request reports failure with the following results: +// - Instance A and Instance B are successfully terminated because none of the +// specified instances in us-east-1a are enabled for termination protection. +// - Instance C and Instance D fail to terminate because at least one of the +// specified instances in us-east-1b (Instance C) is enabled for termination +// protection. // -// For example, say you have -// the following instances: -// -// * Instance A: us-east-1a; Not protected -// -// * Instance B: -// us-east-1a; Not protected -// -// * Instance C: us-east-1b; Protected -// -// * Instance D: -// us-east-1b; not protected -// -// If you attempt to terminate all of these instances in -// the same request, the request reports failure with the following results: -// -// * -// Instance A and Instance B are successfully terminated because none of the -// specified instances in us-east-1a are enabled for termination protection. -// -// * -// Instance C and Instance D fail to terminate because at least one of the -// specified instances in us-east-1b (Instance C) is enabled for termination -// protection. -// -// Terminated instances remain visible after termination (for -// approximately one hour). By default, Amazon EC2 deletes all EBS volumes that -// were attached when the instance launched. Volumes attached after instance launch -// continue running. You can stop, start, and terminate EBS-backed instances. You -// can only terminate instance store-backed instances. What happens to an instance -// differs if you stop it or terminate it. For example, when you stop an instance, -// the root device and any other devices attached to the instance persist. When you -// terminate an instance, any attached EBS volumes with the DeleteOnTermination -// block device mapping parameter set to true are automatically deleted. For more -// information about the differences between stopping and terminating instances, -// see Instance lifecycle -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) +// Terminated instances remain visible after termination (for approximately one +// hour). By default, Amazon EC2 deletes all EBS volumes that were attached when +// the instance launched. Volumes attached after instance launch continue running. +// You can stop, start, and terminate EBS-backed instances. You can only terminate +// instance store-backed instances. What happens to an instance differs if you stop +// it or terminate it. For example, when you stop an instance, the root device and +// any other devices attached to the instance persist. When you terminate an +// instance, any attached EBS volumes with the DeleteOnTermination block device +// mapping parameter set to true are automatically deleted. For more information +// about the differences between stopping and terminating instances, see Instance +// lifecycle (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) // in the Amazon EC2 User Guide. For more information about troubleshooting, see -// Troubleshooting terminating your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html) +// Troubleshooting terminating your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html) // in the Amazon EC2 User Guide. func (c *Client) TerminateInstances(ctx context.Context, params *TerminateInstancesInput, optFns ...func(*Options)) (*TerminateInstancesOutput, error) { if params == nil { @@ -92,8 +76,8 @@ type TerminateInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go b/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go index 3b7c57a56b9..4c9ef36c580 100644 --- a/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go +++ b/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go @@ -13,8 +13,7 @@ import ( // Unassigns secondary private IPv4 addresses from a private NAT gateway. You // cannot unassign your primary private IP. For more information, see Edit -// secondary IP address associations -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary) +// secondary IP address associations (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary) // in the Amazon Virtual Private Cloud User Guide. While unassigning is in // progress, you cannot assign/unassign additional IP addresses while the // connections are being drained. You are, however, allowed to delete the NAT @@ -52,12 +51,12 @@ type UnassignPrivateNatGatewayAddressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool - // The maximum amount of time to wait (in seconds) before forcibly releasing the IP - // addresses if connections are still in progress. Default value is 350 seconds. + // The maximum amount of time to wait (in seconds) before forcibly releasing the + // IP addresses if connections are still in progress. Default value is 350 seconds. MaxDrainDurationSeconds *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_UnmonitorInstances.go b/service/ec2/api_op_UnmonitorInstances.go index 77e3a7066b0..e8b9525f287 100644 --- a/service/ec2/api_op_UnmonitorInstances.go +++ b/service/ec2/api_op_UnmonitorInstances.go @@ -12,9 +12,8 @@ import ( ) // Disables detailed monitoring for a running instance. For more information, see -// Monitoring your instances and volumes -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) in -// the Amazon EC2 User Guide. +// Monitoring your instances and volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) +// in the Amazon EC2 User Guide. func (c *Client) UnmonitorInstances(ctx context.Context, params *UnmonitorInstancesInput, optFns ...func(*Options)) (*UnmonitorInstancesOutput, error) { if params == nil { params = &UnmonitorInstancesInput{} @@ -39,8 +38,8 @@ type UnmonitorInstancesInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go index 044463cd04e..6bf48eca3cd 100644 --- a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go +++ b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsEgress.go @@ -34,8 +34,8 @@ type UpdateSecurityGroupRuleDescriptionsEgressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the security group. You must specify either the security group ID or @@ -51,8 +51,8 @@ type UpdateSecurityGroupRuleDescriptionsEgressInput struct { // permissions or the description. IpPermissions []types.IpPermission - // The description for the egress security group rules. You must specify either the - // description or the IP permissions. + // The description for the egress security group rules. You must specify either + // the description or the IP permissions. SecurityGroupRuleDescriptions []types.SecurityGroupRuleDescription noSmithyDocumentSerde diff --git a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go index b0e008c390b..7119ae67d93 100644 --- a/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go +++ b/service/ec2/api_op_UpdateSecurityGroupRuleDescriptionsIngress.go @@ -34,8 +34,8 @@ type UpdateSecurityGroupRuleDescriptionsIngressInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // The ID of the security group. You must specify either the security group ID or diff --git a/service/ec2/api_op_WithdrawByoipCidr.go b/service/ec2/api_op_WithdrawByoipCidr.go index 998d948e40b..c807c846d79 100644 --- a/service/ec2/api_op_WithdrawByoipCidr.go +++ b/service/ec2/api_op_WithdrawByoipCidr.go @@ -40,8 +40,8 @@ type WithdrawByoipCidrInput struct { // Checks whether you have the required permissions for the action, without // actually making the request, and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool noSmithyDocumentSerde diff --git a/service/ec2/doc.go b/service/ec2/doc.go index 7e807c5fa23..5f0bc65ae55 100644 --- a/service/ec2/doc.go +++ b/service/ec2/doc.go @@ -13,22 +13,13 @@ // block level storage volumes for use with EC2 instances. EBS volumes are highly // available // -// and reliable storage volumes that can be attached to any running -// instance and used like a hard drive. To learn more, see the following -// resources: -// -// * Amazon EC2: Amazon EC2 product page (http://aws.amazon.com/ec2), -// Amazon EC2 documentation (https://docs.aws.amazon.com/ec2/index.html) -// -// * Amazon -// EBS: Amazon EBS product page (http://aws.amazon.com/ebs), Amazon EBS -// documentation (https://docs.aws.amazon.com/ebs/index.html) -// -// * Amazon VPC: Amazon -// VPC product page (http://aws.amazon.com/vpc), Amazon VPC documentation -// (https://docs.aws.amazon.com/vpc/index.html) -// -// * VPN: VPN product page -// (http://aws.amazon.com/vpn), VPN documentation -// (https://docs.aws.amazon.com/vpn/index.html) +// and reliable storage volumes that can be attached to any running instance and +// used like a hard drive. To learn more, see the following resources: +// - Amazon EC2: Amazon EC2 product page (http://aws.amazon.com/ec2) , Amazon +// EC2 documentation (https://docs.aws.amazon.com/ec2/index.html) +// - Amazon EBS: Amazon EBS product page (http://aws.amazon.com/ebs) , Amazon +// EBS documentation (https://docs.aws.amazon.com/ebs/index.html) +// - Amazon VPC: Amazon VPC product page (http://aws.amazon.com/vpc) , Amazon +// VPC documentation (https://docs.aws.amazon.com/vpc/index.html) +// - VPN: VPN product page (http://aws.amazon.com/vpn) , VPN documentation (https://docs.aws.amazon.com/vpn/index.html) package ec2 diff --git a/service/ec2/types/enums.go b/service/ec2/types/enums.go index 67b1fe931ea..c46c49d5727 100644 --- a/service/ec2/types/enums.go +++ b/service/ec2/types/enums.go @@ -159,8 +159,8 @@ const ( AddressTransferStatusAccepted AddressTransferStatus = "accepted" ) -// Values returns all known values for AddressTransferStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AddressTransferStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AddressTransferStatus) Values() []AddressTransferStatus { return []AddressTransferStatus{ @@ -365,8 +365,8 @@ const ( AssociatedNetworkTypeVpc AssociatedNetworkType = "vpc" ) -// Values returns all known values for AssociatedNetworkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AssociatedNetworkType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AssociatedNetworkType) Values() []AssociatedNetworkType { return []AssociatedNetworkType{ @@ -385,8 +385,8 @@ const ( AssociationStatusCodeDisassociated AssociationStatusCode = "disassociated" ) -// Values returns all known values for AssociationStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AssociationStatusCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AssociationStatusCode) Values() []AssociationStatusCode { return []AssociationStatusCode{ @@ -428,8 +428,8 @@ const ( AutoAcceptSharedAssociationsValueDisable AutoAcceptSharedAssociationsValue = "disable" ) -// Values returns all known values for AutoAcceptSharedAssociationsValue. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AutoAcceptSharedAssociationsValue. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AutoAcceptSharedAssociationsValue) Values() []AutoAcceptSharedAssociationsValue { @@ -506,8 +506,8 @@ const ( AvailabilityZoneStateUnavailable AvailabilityZoneState = "unavailable" ) -// Values returns all known values for AvailabilityZoneState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AvailabilityZoneState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AvailabilityZoneState) Values() []AvailabilityZoneState { return []AvailabilityZoneState{ @@ -527,9 +527,9 @@ const ( BareMetalExcluded BareMetal = "excluded" ) -// Values returns all known values for BareMetal. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BareMetal. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BareMetal) Values() []BareMetal { return []BareMetal{ "included", @@ -574,9 +574,9 @@ const ( BgpStatusDown BgpStatus = "down" ) -// Values returns all known values for BgpStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BgpStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BgpStatus) Values() []BgpStatus { return []BgpStatus{ "up", @@ -592,9 +592,9 @@ const ( BootModeTypeUefi BootModeType = "uefi" ) -// Values returns all known values for BootModeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BootModeType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BootModeType) Values() []BootModeType { return []BootModeType{ "legacy-bios", @@ -859,9 +859,9 @@ const ( CapacityReservationStateFailed CapacityReservationState = "failed" ) -// Values returns all known values for CapacityReservationState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CapacityReservationState. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationState) Values() []CapacityReservationState { return []CapacityReservationState{ "active", @@ -1048,9 +1048,9 @@ const ( ClientVpnRouteStatusCodeDeleting ClientVpnRouteStatusCode = "deleting" ) -// Values returns all known values for ClientVpnRouteStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClientVpnRouteStatusCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnRouteStatusCode) Values() []ClientVpnRouteStatusCode { return []ClientVpnRouteStatusCode{ "creating", @@ -1228,8 +1228,8 @@ const ( DefaultRouteTableAssociationValueDisable DefaultRouteTableAssociationValue = "disable" ) -// Values returns all known values for DefaultRouteTableAssociationValue. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DefaultRouteTableAssociationValue. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DefaultRouteTableAssociationValue) Values() []DefaultRouteTableAssociationValue { @@ -1247,8 +1247,8 @@ const ( DefaultRouteTablePropagationValueDisable DefaultRouteTablePropagationValue = "disable" ) -// Values returns all known values for DefaultRouteTablePropagationValue. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DefaultRouteTablePropagationValue. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DefaultRouteTablePropagationValue) Values() []DefaultRouteTablePropagationValue { @@ -1307,9 +1307,9 @@ const ( DeleteQueuedReservedInstancesErrorCodeUnexpectedError DeleteQueuedReservedInstancesErrorCode = "unexpected-error" ) -// Values returns all known values for DeleteQueuedReservedInstancesErrorCode. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for DeleteQueuedReservedInstancesErrorCode. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (DeleteQueuedReservedInstancesErrorCode) Values() []DeleteQueuedReservedInstancesErrorCode { return []DeleteQueuedReservedInstancesErrorCode{ @@ -1327,8 +1327,8 @@ const ( DestinationFileFormatParquet DestinationFileFormat = "parquet" ) -// Values returns all known values for DestinationFileFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DestinationFileFormat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DestinationFileFormat) Values() []DestinationFileFormat { return []DestinationFileFormat{ @@ -1420,9 +1420,9 @@ const ( DnsNameStateFailed DnsNameState = "failed" ) -// Values returns all known values for DnsNameState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DnsNameState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DnsNameState) Values() []DnsNameState { return []DnsNameState{ "pendingVerification", @@ -1668,9 +1668,9 @@ const ( EventCodeInstanceStop EventCode = "instance-stop" ) -// Values returns all known values for EventCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventCode) Values() []EventCode { return []EventCode{ "instance-reboot", @@ -1691,9 +1691,9 @@ const ( EventTypeInformation EventType = "information" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "instanceChange", @@ -1817,9 +1817,10 @@ const ( FastSnapshotRestoreStateCodeDisabled FastSnapshotRestoreStateCode = "disabled" ) -// Values returns all known values for FastSnapshotRestoreStateCode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FastSnapshotRestoreStateCode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (FastSnapshotRestoreStateCode) Values() []FastSnapshotRestoreStateCode { return []FastSnapshotRestoreStateCode{ "enabling", @@ -1988,9 +1989,9 @@ const ( FleetReplacementStrategyLaunchBeforeTerminate FleetReplacementStrategy = "launch-before-terminate" ) -// Values returns all known values for FleetReplacementStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FleetReplacementStrategy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetReplacementStrategy) Values() []FleetReplacementStrategy { return []FleetReplacementStrategy{ "launch", @@ -2035,9 +2036,9 @@ const ( FleetTypeInstant FleetType = "instant" ) -// Values returns all known values for FleetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FleetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FleetType) Values() []FleetType { return []FleetType{ "request", @@ -2178,9 +2179,9 @@ const ( HostnameTypeResourceName HostnameType = "resource-name" ) -// Values returns all known values for HostnameType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HostnameType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HostnameType) Values() []HostnameType { return []HostnameType{ "ip-name", @@ -2196,9 +2197,9 @@ const ( HostRecoveryOff HostRecovery = "off" ) -// Values returns all known values for HostRecovery. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HostRecovery. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HostRecovery) Values() []HostRecovery { return []HostRecovery{ "on", @@ -2425,8 +2426,8 @@ const ( InstanceAttributeNameDisableApiStop InstanceAttributeName = "disableApiStop" ) -// Values returns all known values for InstanceAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceAttributeName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceAttributeName) Values() []InstanceAttributeName { return []InstanceAttributeName{ @@ -2495,9 +2496,9 @@ const ( InstanceEventWindowStateDeleted InstanceEventWindowState = "deleted" ) -// Values returns all known values for InstanceEventWindowState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceEventWindowState. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceEventWindowState) Values() []InstanceEventWindowState { return []InstanceEventWindowState{ "creating", @@ -2552,9 +2553,10 @@ const ( InstanceInterruptionBehaviorTerminate InstanceInterruptionBehavior = "terminate" ) -// Values returns all known values for InstanceInterruptionBehavior. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceInterruptionBehavior. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (InstanceInterruptionBehavior) Values() []InstanceInterruptionBehavior { return []InstanceInterruptionBehavior{ "hibernate", @@ -2589,8 +2591,8 @@ const ( InstanceLifecycleTypeScheduled InstanceLifecycleType = "scheduled" ) -// Values returns all known values for InstanceLifecycleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceLifecycleType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceLifecycleType) Values() []InstanceLifecycleType { return []InstanceLifecycleType{ @@ -2607,8 +2609,8 @@ const ( InstanceMatchCriteriaTargeted InstanceMatchCriteria = "targeted" ) -// Values returns all known values for InstanceMatchCriteria. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceMatchCriteria. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceMatchCriteria) Values() []InstanceMatchCriteria { return []InstanceMatchCriteria{ @@ -2644,9 +2646,10 @@ const ( InstanceMetadataOptionsStateApplied InstanceMetadataOptionsState = "applied" ) -// Values returns all known values for InstanceMetadataOptionsState. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceMetadataOptionsState. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (InstanceMetadataOptionsState) Values() []InstanceMetadataOptionsState { return []InstanceMetadataOptionsState{ "pending", @@ -3385,9 +3388,9 @@ const ( InstanceTypeR6idnMetal InstanceType = "r6idn.metal" ) -// Values returns all known values for InstanceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InstanceType) Values() []InstanceType { return []InstanceType{ "a1.medium", @@ -4080,8 +4083,8 @@ const ( InterfaceProtocolTypeGre InterfaceProtocolType = "GRE" ) -// Values returns all known values for InterfaceProtocolType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InterfaceProtocolType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InterfaceProtocolType) Values() []InterfaceProtocolType { return []InterfaceProtocolType{ @@ -4185,9 +4188,9 @@ const ( IpamDiscoveryFailureCodeUnauthorizedFailure IpamDiscoveryFailureCode = "unauthorized-failure" ) -// Values returns all known values for IpamDiscoveryFailureCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for IpamDiscoveryFailureCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamDiscoveryFailureCode) Values() []IpamDiscoveryFailureCode { return []IpamDiscoveryFailureCode{ "assume-role-failure", @@ -4548,9 +4551,9 @@ const ( IpamStateRestoreInProgress IpamState = "restore-in-progress" ) -// Values returns all known values for IpamState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for IpamState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (IpamState) Values() []IpamState { return []IpamState{ "create-in-progress", @@ -4594,9 +4597,9 @@ const ( KeyFormatPpk KeyFormat = "ppk" ) -// Values returns all known values for KeyFormat. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for KeyFormat. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (KeyFormat) Values() []KeyFormat { return []KeyFormat{ "pem", @@ -4694,10 +4697,10 @@ const ( LaunchTemplateInstanceMetadataEndpointStateEnabled LaunchTemplateInstanceMetadataEndpointState = "enabled" ) -// Values returns all known values for LaunchTemplateInstanceMetadataEndpointState. -// Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// Values returns all known values for +// LaunchTemplateInstanceMetadataEndpointState. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this +// slice is not guaranteed to be stable across updates. func (LaunchTemplateInstanceMetadataEndpointState) Values() []LaunchTemplateInstanceMetadataEndpointState { return []LaunchTemplateInstanceMetadataEndpointState{ "disabled", @@ -4772,9 +4775,9 @@ const ( ListingStatePending ListingState = "pending" ) -// Values returns all known values for ListingState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListingState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ListingState) Values() []ListingState { return []ListingState{ "available", @@ -4856,8 +4859,8 @@ const ( LocalGatewayRouteTypePropagated LocalGatewayRouteType = "propagated" ) -// Values returns all known values for LocalGatewayRouteType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LocalGatewayRouteType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LocalGatewayRouteType) Values() []LocalGatewayRouteType { return []LocalGatewayRouteType{ @@ -4875,9 +4878,9 @@ const ( LocalStorageExcluded LocalStorage = "excluded" ) -// Values returns all known values for LocalStorage. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LocalStorage. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LocalStorage) Values() []LocalStorage { return []LocalStorage{ "included", @@ -4913,9 +4916,9 @@ const ( LocationTypeAvailabilityZoneId LocationType = "availability-zone-id" ) -// Values returns all known values for LocationType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LocationType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LocationType) Values() []LocationType { return []LocationType{ "region", @@ -5002,8 +5005,8 @@ const ( ModifyAvailabilityZoneOptInStatusNotOptedIn ModifyAvailabilityZoneOptInStatus = "not-opted-in" ) -// Values returns all known values for ModifyAvailabilityZoneOptInStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for ModifyAvailabilityZoneOptInStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (ModifyAvailabilityZoneOptInStatus) Values() []ModifyAvailabilityZoneOptInStatus { @@ -5061,8 +5064,8 @@ const ( MulticastSupportValueDisable MulticastSupportValue = "disable" ) -// Values returns all known values for MulticastSupportValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MulticastSupportValue. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MulticastSupportValue) Values() []MulticastSupportValue { return []MulticastSupportValue{ @@ -5152,9 +5155,10 @@ const ( NetworkInterfaceCreationTypeTrunk NetworkInterfaceCreationType = "trunk" ) -// Values returns all known values for NetworkInterfaceCreationType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NetworkInterfaceCreationType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (NetworkInterfaceCreationType) Values() []NetworkInterfaceCreationType { return []NetworkInterfaceCreationType{ "efa", @@ -5639,9 +5643,9 @@ const ( RecurringChargeFrequencyHourly RecurringChargeFrequency = "Hourly" ) -// Values returns all known values for RecurringChargeFrequency. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecurringChargeFrequency. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RecurringChargeFrequency) Values() []RecurringChargeFrequency { return []RecurringChargeFrequency{ "Hourly", @@ -5776,8 +5780,8 @@ const ( ReservedInstanceStateQueuedDeleted ReservedInstanceState = "queued-deleted" ) -// Values returns all known values for ReservedInstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReservedInstanceState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReservedInstanceState) Values() []ReservedInstanceState { return []ReservedInstanceState{ @@ -5913,9 +5917,9 @@ const ( ResourceTypeIpamResourceDiscoveryAssociation ResourceType = "ipam-resource-discovery-association" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "capacity-reservation", @@ -6135,8 +6139,8 @@ const ( ScopeRegional Scope = "Region" ) -// Values returns all known values for Scope. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Scope. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Scope) Values() []Scope { return []Scope{ @@ -6192,9 +6196,9 @@ const ( ServiceStateFailed ServiceState = "Failed" ) -// Values returns all known values for ServiceState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServiceState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServiceState) Values() []ServiceState { return []ServiceState{ "Pending", @@ -6251,8 +6255,8 @@ const ( SnapshotAttributeNameCreateVolumePermission SnapshotAttributeName = "createVolumePermission" ) -// Values returns all known values for SnapshotAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SnapshotAttributeName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SnapshotAttributeName) Values() []SnapshotAttributeName { return []SnapshotAttributeName{ @@ -6404,8 +6408,8 @@ const ( StateExpired State = "Expired" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ @@ -6542,9 +6546,9 @@ const ( SubnetCidrBlockStateCodeFailed SubnetCidrBlockStateCode = "failed" ) -// Values returns all known values for SubnetCidrBlockStateCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SubnetCidrBlockStateCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SubnetCidrBlockStateCode) Values() []SubnetCidrBlockStateCode { return []SubnetCidrBlockStateCode{ "associating", @@ -6766,9 +6770,10 @@ const ( TrafficMirrorFilterRuleFieldDescription TrafficMirrorFilterRuleField = "description" ) -// Values returns all known values for TrafficMirrorFilterRuleField. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrafficMirrorFilterRuleField. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (TrafficMirrorFilterRuleField) Values() []TrafficMirrorFilterRuleField { return []TrafficMirrorFilterRuleField{ "destination-port-range", @@ -7071,9 +7076,9 @@ const ( TransitGatewayPrefixListReferenceStateDeleting TransitGatewayPrefixListReferenceState = "deleting" ) -// Values returns all known values for TransitGatewayPrefixListReferenceState. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for TransitGatewayPrefixListReferenceState. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (TransitGatewayPrefixListReferenceState) Values() []TransitGatewayPrefixListReferenceState { return []TransitGatewayPrefixListReferenceState{ @@ -7118,9 +7123,9 @@ const ( TransitGatewayRouteStateDeleted TransitGatewayRouteState = "deleted" ) -// Values returns all known values for TransitGatewayRouteState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TransitGatewayRouteState. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRouteState) Values() []TransitGatewayRouteState { return []TransitGatewayRouteState{ "pending", @@ -7286,8 +7291,8 @@ const ( TunnelInsideIpVersionIpv6 TunnelInsideIpVersion = "ipv6" ) -// Values returns all known values for TunnelInsideIpVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TunnelInsideIpVersion. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TunnelInsideIpVersion) Values() []TunnelInsideIpVersion { return []TunnelInsideIpVersion{ @@ -7368,8 +7373,8 @@ const ( UserTrustProviderTypeOidc UserTrustProviderType = "oidc" ) -// Values returns all known values for UserTrustProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for UserTrustProviderType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (UserTrustProviderType) Values() []UserTrustProviderType { return []UserTrustProviderType{ @@ -7505,8 +7510,8 @@ const ( VolumeAttachmentStateBusy VolumeAttachmentState = "busy" ) -// Values returns all known values for VolumeAttachmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VolumeAttachmentState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VolumeAttachmentState) Values() []VolumeAttachmentState { return []VolumeAttachmentState{ @@ -7682,8 +7687,8 @@ const ( VpcCidrBlockStateCodeFailed VpcCidrBlockStateCode = "failed" ) -// Values returns all known values for VpcCidrBlockStateCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VpcCidrBlockStateCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VpcCidrBlockStateCode) Values() []VpcCidrBlockStateCode { return []VpcCidrBlockStateCode{ diff --git a/service/ec2/types/types.go b/service/ec2/types/types.go index 6f45290f28b..6b8a563b07a 100644 --- a/service/ec2/types/types.go +++ b/service/ec2/types/types.go @@ -11,12 +11,12 @@ import ( // Services Inferentia chips) on an instance. type AcceleratorCount struct { - // The maximum number of accelerators. If this parameter is not specified, there is - // no maximum limit. + // The maximum number of accelerators. If this parameter is not specified, there + // is no maximum limit. Max *int32 - // The minimum number of accelerators. If this parameter is not specified, there is - // no minimum limit. + // The minimum number of accelerators. If this parameter is not specified, there + // is no minimum limit. Min *int32 noSmithyDocumentSerde @@ -24,11 +24,11 @@ type AcceleratorCount struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web // Services Inferentia chips) on an instance. To exclude accelerator-enabled -// instance types, set Max to 0. +// instance types, set Max to 0 . type AcceleratorCountRequest struct { // The maximum number of accelerators. To specify no maximum limit, omit this - // parameter. To exclude accelerator-enabled instance types, set Max to 0. + // parameter. To exclude accelerator-enabled instance types, set Max to 0 . Max *int32 // The minimum number of accelerators. To specify no minimum limit, omit this @@ -139,8 +139,8 @@ type AccountAttributeValue struct { type ActiveInstance struct { // The health status of the instance. If the status of either the instance status - // check or the system status check is impaired, the health status of the instance - // is unhealthy. Otherwise, the health status is healthy. + // check or the system status check is impaired , the health status of the instance + // is unhealthy . Otherwise, the health status is healthy . InstanceHealth InstanceHealthStatus // The ID of the instance. @@ -188,8 +188,8 @@ type AddIpamOperatingRegion struct { } // Describes an additional detail for a path analysis. For more information, see -// Reachability Analyzer additional detail codes -// (https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html). +// Reachability Analyzer additional detail codes (https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html) +// . type AdditionalDetail struct { // The additional detail code. @@ -254,7 +254,7 @@ type Address struct { CustomerOwnedIpv4Pool *string // Indicates whether this Elastic IP address is for use with instances in - // EC2-Classic (standard) or instances in a VPC (vpc). + // EC2-Classic ( standard ) or instances in a VPC ( vpc ). Domain DomainType // The ID of the instance that the address is associated with (if any). @@ -304,8 +304,7 @@ type AddressAttribute struct { } // Details on the Elastic IP address transfer. For more information, see Transfer -// Elastic IP addresses -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) +// Elastic IP addresses (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) // in the Amazon Virtual Private Cloud User Guide. type AddressTransfer struct { @@ -492,22 +491,15 @@ type AnalysisRouteTableRoute struct { NetworkInterfaceId *string // Describes how the route was created. The following are the possible values: - // - // * - // CreateRouteTable - The route was automatically created when the route table was - // created. - // - // * CreateRoute - The route was manually added to the route table. - // - // * - // EnableVgwRoutePropagation - The route was propagated by route propagation. + // - CreateRouteTable - The route was automatically created when the route table + // was created. + // - CreateRoute - The route was manually added to the route table. + // - EnableVgwRoutePropagation - The route was propagated by route propagation. Origin *string // The state. The following are the possible values: - // - // * active - // - // * blackhole + // - active + // - blackhole State *string // The ID of a transit gateway. @@ -526,10 +518,8 @@ type AnalysisSecurityGroupRule struct { Cidr *string // The direction. The following are the possible values: - // - // * egress - // - // * ingress + // - egress + // - ingress Direction *string // The port range. @@ -565,9 +555,9 @@ type AssociatedRole struct { // The name of the Amazon S3 bucket in which the Amazon S3 object is stored. CertificateS3BucketName *string - // The key of the Amazon S3 object ey where the certificate, certificate chain, and - // encrypted private key bundle is stored. The object key is formated as follows: - // role_arn/certificate_arn. + // The key of the Amazon S3 object ey where the certificate, certificate chain, + // and encrypted private key bundle is stored. The object key is formated as + // follows: role_arn / certificate_arn . CertificateS3ObjectKey *string // The ID of the KMS customer master key (CMK) used to encrypt the private key. @@ -637,8 +627,8 @@ type AttachmentEnaSrdSpecification struct { noSmithyDocumentSerde } -// Describes the ENA Express configuration for UDP traffic on the network interface -// that's attached to the instance. +// Describes the ENA Express configuration for UDP traffic on the network +// interface that's attached to the instance. type AttachmentEnaSrdUdpSpecification struct { // Indicates whether UDP traffic to and from the instance uses ENA Express. To @@ -651,7 +641,7 @@ type AttachmentEnaSrdUdpSpecification struct { // Describes a value for a resource attribute that is a Boolean value. type AttributeBooleanValue struct { - // The attribute value. The valid values are true or false. + // The attribute value. The valid values are true or false . Value *bool noSmithyDocumentSerde @@ -697,9 +687,9 @@ type AuthorizationRule struct { type AvailabilityZone struct { // For Availability Zones, this parameter has the same value as the Region name. - // For Local Zones, the name of the associated group, for example us-west-2-lax-1. + // For Local Zones, the name of the associated group, for example us-west-2-lax-1 . // For Wavelength Zones, the name of the associated group, for example - // us-east-1-wl1-bos-wlz-1. + // us-east-1-wl1-bos-wlz-1 . GroupName *string // Any messages about the Availability Zone, Local Zone, or Wavelength Zone. @@ -709,8 +699,8 @@ type AvailabilityZone struct { NetworkBorderGroup *string // For Availability Zones, this parameter always has the value of - // opt-in-not-required. For Local Zones and Wavelength Zones, this parameter is the - // opt-in status. The possible values are opted-in, and not-opted-in. + // opt-in-not-required . For Local Zones and Wavelength Zones, this parameter is + // the opt-in status. The possible values are opted-in , and not-opted-in . OptInStatus AvailabilityZoneOptInStatus // The ID of the zone that handles some of the Local Zone or Wavelength Zone @@ -725,7 +715,7 @@ type AvailabilityZone struct { RegionName *string // The state of the Availability Zone, Local Zone, or Wavelength Zone. This value - // is always available. + // is always available . State AvailabilityZoneState // The ID of the Availability Zone, Local Zone, or Wavelength Zone. @@ -734,8 +724,8 @@ type AvailabilityZone struct { // The name of the Availability Zone, Local Zone, or Wavelength Zone. ZoneName *string - // The type of zone. The valid values are availability-zone, local-zone, and - // wavelength-zone. + // The type of zone. The valid values are availability-zone , local-zone , and + // wavelength-zone . ZoneType *string noSmithyDocumentSerde @@ -767,9 +757,8 @@ type AvailableCapacity struct { } // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more -// information, see Amazon EBS–optimized instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the -// Amazon EC2 User Guide. +// information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) +// in the Amazon EC2 User Guide. type BaselineEbsBandwidthMbps struct { // The maximum baseline bandwidth, in Mbps. If this parameter is not specified, @@ -784,9 +773,8 @@ type BaselineEbsBandwidthMbps struct { } // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more -// information, see Amazon EBS–optimized instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the -// Amazon EC2 User Guide. +// information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) +// in the Amazon EC2 User Guide. type BaselineEbsBandwidthMbpsRequest struct { // The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this @@ -810,7 +798,7 @@ type BlobAttributeValue struct { // store volumes to attach to an instance at launch. type BlockDeviceMapping struct { - // The device name (for example, /dev/sdh or xvdh). + // The device name (for example, /dev/sdh or xvdh ). DeviceName *string // Parameters used to automatically set up EBS volumes when the instance is @@ -822,16 +810,16 @@ type BlockDeviceMapping struct { // regardless of the assigned value. NoDevice *string - // The virtual device name (ephemeralN). Instance store volumes are numbered + // The virtual device name ( ephemeral N). Instance store volumes are numbered // starting from 0. An instance type with 2 available instance store volumes can - // specify mappings for ephemeral0 and ephemeral1. The number of available instance - // store volumes depends on the instance type. After you connect to the instance, - // you must mount the volume. NVMe instance store volumes are automatically - // enumerated and assigned a device name. Including them in your block device - // mapping has no effect. Constraints: For M3 instances, you must specify instance - // store volumes in the block device mapping for the instance. When you launch an - // M3 instance, we ignore any instance store volumes specified in the block device - // mapping for the AMI. + // specify mappings for ephemeral0 and ephemeral1 . The number of available + // instance store volumes depends on the instance type. After you connect to the + // instance, you must mount the volume. NVMe instance store volumes are + // automatically enumerated and assigned a device name. Including them in your + // block device mapping has no effect. Constraints: For M3 instances, you must + // specify instance store volumes in the block device mapping for the instance. + // When you launch an M3 instance, we ignore any instance store volumes specified + // in the block device mapping for the AMI. VirtualName *string noSmithyDocumentSerde @@ -867,7 +855,7 @@ type BundleTask struct { noSmithyDocumentSerde } -// Describes an error for BundleInstance. +// Describes an error for BundleInstance . type BundleTaskError struct { // The error code. @@ -965,8 +953,8 @@ type CancelSpotFleetRequestsSuccessItem struct { // Information about instance capacity usage for a Capacity Reservation. type CapacityAllocation struct { - // The usage type. used indicates that the instance capacity is in use by instances - // that are running in the Capacity Reservation. + // The usage type. used indicates that the instance capacity is in use by + // instances that are running in the Capacity Reservation. AllocationType AllocationType // The amount of instance capacity associated with the usage. For example a value @@ -1019,14 +1007,12 @@ type CapacityReservation struct { // when it reaches its end date and time. EndDate *time.Time - // Indicates the way in which the Capacity Reservation ends. A Capacity Reservation - // can have one of the following end types: - // - // * unlimited - The Capacity Reservation - // remains active until you explicitly cancel it. - // - // * limited - The Capacity - // Reservation expires automatically at a specified date and time. + // Indicates the way in which the Capacity Reservation ends. A Capacity + // Reservation can have one of the following end types: + // - unlimited - The Capacity Reservation remains active until you explicitly + // cancel it. + // - limited - The Capacity Reservation expires automatically at a specified date + // and time. EndDateType EndDateType // Deprecated. @@ -1034,17 +1020,14 @@ type CapacityReservation struct { // Indicates the type of instance launches that the Capacity Reservation accepts. // The options include: - // - // * open - The Capacity Reservation accepts all instances - // that have matching attributes (instance type, platform, and Availability Zone). - // Instances that have matching attributes launch into the Capacity Reservation - // automatically without specifying any additional parameters. - // - // * targeted - The - // Capacity Reservation only accepts instances that have matching attributes - // (instance type, platform, and Availability Zone), and explicitly target the - // Capacity Reservation. This ensures that only permitted instances can use the - // reserved capacity. + // - open - The Capacity Reservation accepts all instances that have matching + // attributes (instance type, platform, and Availability Zone). Instances that have + // matching attributes launch into the Capacity Reservation automatically without + // specifying any additional parameters. + // - targeted - The Capacity Reservation only accepts instances that have + // matching attributes (instance type, platform, and Availability Zone), and + // explicitly target the Capacity Reservation. This ensures that only permitted + // instances can use the reserved capacity. InstanceMatchCriteria InstanceMatchCriteria // The type of operating system for which the Capacity Reservation reserves @@ -1062,10 +1045,9 @@ type CapacityReservation struct { OwnerId *string // The Amazon Resource Name (ARN) of the cluster placement group in which the - // Capacity Reservation was created. For more information, see Capacity - // Reservations for cluster placement groups - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the Amazon - // EC2 User Guide. + // Capacity Reservation was created. For more information, see Capacity + // Reservations for cluster placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) + // in the Amazon EC2 User Guide. PlacementGroupArn *string // The date and time at which the Capacity Reservation was started. @@ -1073,25 +1055,18 @@ type CapacityReservation struct { // The current state of the Capacity Reservation. A Capacity Reservation can be in // one of the following states: - // - // * active - The Capacity Reservation is active and - // the capacity is available for your use. - // - // * expired - The Capacity Reservation - // expired automatically at the date and time specified in your request. The - // reserved capacity is no longer available for your use. - // - // * cancelled - The - // Capacity Reservation was cancelled. The reserved capacity is no longer available - // for your use. - // - // * pending - The Capacity Reservation request was successful but - // the capacity provisioning is still pending. - // - // * failed - The Capacity Reservation - // request has failed. A request might fail due to invalid request parameters, - // capacity constraints, or instance limit constraints. Failed requests are - // retained for 60 minutes. + // - active - The Capacity Reservation is active and the capacity is available + // for your use. + // - expired - The Capacity Reservation expired automatically at the date and + // time specified in your request. The reserved capacity is no longer available for + // your use. + // - cancelled - The Capacity Reservation was cancelled. The reserved capacity is + // no longer available for your use. + // - pending - The Capacity Reservation request was successful but the capacity + // provisioning is still pending. + // - failed - The Capacity Reservation request has failed. A request might fail + // due to invalid request parameters, capacity constraints, or instance limit + // constraints. Failed requests are retained for 60 minutes. State CapacityReservationState // Any tags assigned to the Capacity Reservation. @@ -1099,13 +1074,10 @@ type CapacityReservation struct { // Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can // have one of the following tenancy settings: - // - // * default - The Capacity - // Reservation is created on hardware that is shared with other Amazon Web Services - // accounts. - // - // * dedicated - The Capacity Reservation is created on single-tenant - // hardware that is dedicated to a single Amazon Web Services account. + // - default - The Capacity Reservation is created on hardware that is shared + // with other Amazon Web Services accounts. + // - dedicated - The Capacity Reservation is created on single-tenant hardware + // that is dedicated to a single Amazon Web Services account. Tenancy CapacityReservationTenancy // The total number of instances for which the Capacity Reservation reserves @@ -1120,8 +1092,7 @@ type CapacityReservationFleet struct { // The strategy used by the Capacity Reservation Fleet to determine which of the // specified instance types to use. For more information, see For more information, - // see Allocation strategy - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) + // see Allocation strategy (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) // in the Amazon EC2 User Guide. AllocationStrategy *string @@ -1150,66 +1121,47 @@ type CapacityReservationFleet struct { InstanceTypeSpecifications []FleetCapacityReservation // The state of the Capacity Reservation Fleet. Possible states include: - // - // * - // submitted - The Capacity Reservation Fleet request has been submitted and Amazon - // Elastic Compute Cloud is preparing to create the Capacity Reservations. - // - // * - // modifying - The Capacity Reservation Fleet is being modified. The Fleet remains - // in this state until the modification is complete. - // - // * active - The Capacity - // Reservation Fleet has fulfilled its total target capacity and it is attempting - // to maintain this capacity. The Fleet remains in this state until it is modified - // or deleted. - // - // * partially_fulfilled - The Capacity Reservation Fleet has - // partially fulfilled its total target capacity. There is insufficient Amazon EC2 - // to fulfill the total target capacity. The Fleet is attempting to asynchronously - // fulfill its total target capacity. - // - // * expiring - The Capacity Reservation Fleet - // has reach its end date and it is in the process of expiring. One or more of its - // Capacity reservations might still be active. - // - // * expired - The Capacity - // Reservation Fleet has reach its end date. The Fleet and its Capacity - // Reservations are expired. The Fleet can't create new Capacity Reservations. - // - // * - // cancelling - The Capacity Reservation Fleet is in the process of being - // cancelled. One or more of its Capacity reservations might still be active. - // - // * - // cancelled - The Capacity Reservation Fleet has been manually cancelled. The - // Fleet and its Capacity Reservations are cancelled and the Fleet can't create new - // Capacity Reservations. - // - // * failed - The Capacity Reservation Fleet failed to - // reserve capacity for the specified instance types. + // - submitted - The Capacity Reservation Fleet request has been submitted and + // Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations. + // - modifying - The Capacity Reservation Fleet is being modified. The Fleet + // remains in this state until the modification is complete. + // - active - The Capacity Reservation Fleet has fulfilled its total target + // capacity and it is attempting to maintain this capacity. The Fleet remains in + // this state until it is modified or deleted. + // - partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled + // its total target capacity. There is insufficient Amazon EC2 to fulfill the total + // target capacity. The Fleet is attempting to asynchronously fulfill its total + // target capacity. + // - expiring - The Capacity Reservation Fleet has reach its end date and it is + // in the process of expiring. One or more of its Capacity reservations might still + // be active. + // - expired - The Capacity Reservation Fleet has reach its end date. The Fleet + // and its Capacity Reservations are expired. The Fleet can't create new Capacity + // Reservations. + // - cancelling - The Capacity Reservation Fleet is in the process of being + // cancelled. One or more of its Capacity reservations might still be active. + // - cancelled - The Capacity Reservation Fleet has been manually cancelled. The + // Fleet and its Capacity Reservations are cancelled and the Fleet can't create new + // Capacity Reservations. + // - failed - The Capacity Reservation Fleet failed to reserve capacity for the + // specified instance types. State CapacityReservationFleetState // The tags assigned to the Capacity Reservation Fleet. Tags []Tag // The tenancy of the Capacity Reservation Fleet. Tenancies include: - // - // * default - - // The Capacity Reservation Fleet is created on hardware that is shared with other - // Amazon Web Services accounts. - // - // * dedicated - The Capacity Reservation Fleet is - // created on single-tenant hardware that is dedicated to a single Amazon Web - // Services account. + // - default - The Capacity Reservation Fleet is created on hardware that is + // shared with other Amazon Web Services accounts. + // - dedicated - The Capacity Reservation Fleet is created on single-tenant + // hardware that is dedicated to a single Amazon Web Services account. Tenancy FleetCapacityReservationTenancy // The capacity units that have been fulfilled. TotalFulfilledCapacity *float64 // The total number of capacity units for which the Capacity Reservation Fleet - // reserves capacity. For more information, see Total target capacity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) + // reserves capacity. For more information, see Total target capacity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) // in the Amazon EC2 User Guide. TotalTargetCapacity *int32 @@ -1245,23 +1197,21 @@ type CapacityReservationGroup struct { // Describes the strategy for using unused Capacity Reservations for fulfilling // On-Demand capacity. This strategy can only be used if the EC2 Fleet is of type -// instant. For more information about Capacity Reservations, see On-Demand -// Capacity Reservations -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) +// instant . For more information about Capacity Reservations, see On-Demand +// Capacity Reservations (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) // in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an -// EC2 Fleet, see EC2 Fleet example configurations -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in -// the Amazon EC2 User Guide. +// EC2 Fleet, see EC2 Fleet example configurations (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) +// in the Amazon EC2 User Guide. type CapacityReservationOptions struct { // Indicates whether to use unused Capacity Reservations for fulfilling On-Demand - // capacity. If you specify use-capacity-reservations-first, the fleet uses unused + // capacity. If you specify use-capacity-reservations-first , the fleet uses unused // Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand // capacity. If multiple instance pools have unused Capacity Reservations, the - // On-Demand allocation strategy (lowest-price or prioritized) is applied. If the + // On-Demand allocation strategy ( lowest-price or prioritized ) is applied. If the // number of unused Capacity Reservations is less than the On-Demand target // capacity, the remaining On-Demand target capacity is launched according to the - // On-Demand allocation strategy (lowest-price or prioritized). If you do not + // On-Demand allocation strategy ( lowest-price or prioritized ). If you do not // specify a value, the fleet fulfils the On-Demand capacity according to the // chosen On-Demand allocation strategy. UsageStrategy FleetCapacityReservationUsageStrategy @@ -1271,23 +1221,21 @@ type CapacityReservationOptions struct { // Describes the strategy for using unused Capacity Reservations for fulfilling // On-Demand capacity. This strategy can only be used if the EC2 Fleet is of type -// instant. For more information about Capacity Reservations, see On-Demand -// Capacity Reservations -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) +// instant . For more information about Capacity Reservations, see On-Demand +// Capacity Reservations (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) // in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an -// EC2 Fleet, see EC2 Fleet example configurations -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in -// the Amazon EC2 User Guide. +// EC2 Fleet, see EC2 Fleet example configurations (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) +// in the Amazon EC2 User Guide. type CapacityReservationOptionsRequest struct { // Indicates whether to use unused Capacity Reservations for fulfilling On-Demand - // capacity. If you specify use-capacity-reservations-first, the fleet uses unused + // capacity. If you specify use-capacity-reservations-first , the fleet uses unused // Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand // capacity. If multiple instance pools have unused Capacity Reservations, the - // On-Demand allocation strategy (lowest-price or prioritized) is applied. If the + // On-Demand allocation strategy ( lowest-price or prioritized ) is applied. If the // number of unused Capacity Reservations is less than the On-Demand target // capacity, the remaining On-Demand target capacity is launched according to the - // On-Demand allocation strategy (lowest-price or prioritized). If you do not + // On-Demand allocation strategy ( lowest-price or prioritized ). If you do not // specify a value, the fleet fulfils the On-Demand capacity according to the // chosen On-Demand allocation strategy. UsageStrategy FleetCapacityReservationUsageStrategy @@ -1297,7 +1245,7 @@ type CapacityReservationOptionsRequest struct { // Describes an instance's Capacity Reservation targeting option. You can specify // only one parameter at a time. If you specify CapacityReservationPreference and -// CapacityReservationTarget, the request fails. Use the +// CapacityReservationTarget , the request fails. Use the // CapacityReservationPreference parameter to configure the instance to run as an // On-Demand Instance or to run in any open Capacity Reservation that has matching // attributes (instance type, platform, Availability Zone). Use the @@ -1307,13 +1255,10 @@ type CapacityReservationSpecification struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: - // - // * open - The instance can run in any open Capacity Reservation that - // has matching attributes (instance type, platform, Availability Zone). - // - // * none - - // The instance avoids running in a Capacity Reservation even if one is available. - // The instance runs as an On-Demand Instance. + // - open - The instance can run in any open Capacity Reservation that has + // matching attributes (instance type, platform, Availability Zone). + // - none - The instance avoids running in a Capacity Reservation even if one is + // available. The instance runs as an On-Demand Instance. CapacityReservationPreference CapacityReservationPreference // Information about the target Capacity Reservation or Capacity Reservation group. @@ -1333,13 +1278,10 @@ type CapacityReservationSpecificationResponse struct { // Describes the instance's Capacity Reservation preferences. Possible preferences // include: - // - // * open - The instance can run in any open Capacity Reservation that - // has matching attributes (instance type, platform, Availability Zone). - // - // * none - - // The instance avoids running in a Capacity Reservation even if one is available. - // The instance runs in On-Demand capacity. + // - open - The instance can run in any open Capacity Reservation that has + // matching attributes (instance type, platform, Availability Zone). + // - none - The instance avoids running in a Capacity Reservation even if one is + // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference // Information about the targeted Capacity Reservation or Capacity Reservation @@ -1416,8 +1358,7 @@ type CertificateAuthenticationRequest struct { // Provides authorization for Amazon to bring a specific IP address range to a // specific Amazon Web Services account using bring your own IP addresses (BYOIP). -// For more information, see Configuring your BYOIP address range -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#prepare-for-byoip) +// For more information, see Configuring your BYOIP address range (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#prepare-for-byoip) // in the Amazon Elastic Compute Cloud User Guide. type CidrAuthorizationContext struct { @@ -1455,10 +1396,9 @@ type ClassicLinkDnsSupport struct { noSmithyDocumentSerde } -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Describes a linked EC2-Classic +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Describes a linked EC2-Classic // instance. type ClassicLinkInstance struct { @@ -1557,8 +1497,8 @@ type ClientData struct { noSmithyDocumentSerde } -// Options for enabling a customizable text banner that will be displayed on Amazon -// Web Services provided clients when a VPN session is established. +// Options for enabling a customizable text banner that will be displayed on +// Amazon Web Services provided clients when a VPN session is established. type ClientLoginBannerOptions struct { // Customizable text that will be displayed in a banner on Amazon Web Services @@ -1590,8 +1530,7 @@ type ClientLoginBannerResponseOptions struct { } // Describes the authentication methods used by a Client VPN endpoint. For more -// information, see Authentication -// (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html) +// information, see Authentication (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html) // in the Client VPN Administrator Guide. type ClientVpnAuthentication struct { @@ -1611,21 +1550,20 @@ type ClientVpnAuthentication struct { } // Describes the authentication method to be used by a Client VPN endpoint. For -// more information, see Authentication -// (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) +// more information, see Authentication (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) // in the Client VPN Administrator Guide. type ClientVpnAuthenticationRequest struct { // Information about the Active Directory to be used, if applicable. You must - // provide this information if Type is directory-service-authentication. + // provide this information if Type is directory-service-authentication . ActiveDirectory *DirectoryServiceAuthenticationRequest // Information about the IAM SAML identity provider to be used, if applicable. You - // must provide this information if Type is federated-authentication. + // must provide this information if Type is federated-authentication . FederatedAuthentication *FederatedAuthenticationRequest - // Information about the authentication certificates to be used, if applicable. You - // must provide this information if Type is certificate-authentication. + // Information about the authentication certificates to be used, if applicable. + // You must provide this information if Type is certificate-authentication . MutualAuthentication *CertificateAuthenticationRequest // The type of client authentication to be used. @@ -1730,8 +1668,8 @@ type ClientVpnEndpoint struct { // The options for managing connection authorization for new client connections. ClientConnectOptions *ClientConnectResponseOptions - // Options for enabling a customizable text banner that will be displayed on Amazon - // Web Services provided clients when a VPN session is established. + // Options for enabling a customizable text banner that will be displayed on + // Amazon Web Services provided clients when a VPN session is established. ClientLoginBannerOptions *ClientLoginBannerResponseOptions // The ID of the Client VPN endpoint. @@ -1771,8 +1709,7 @@ type ClientVpnEndpoint struct { // Indicates whether split-tunnel is enabled in the Client VPN endpoint. For // information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN - // endpoint - // (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) + // endpoint (https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) // in the Client VPN Administrator Guide. SplitTunnel *bool @@ -1813,21 +1750,15 @@ type ClientVpnEndpointAttributeStatus struct { type ClientVpnEndpointStatus struct { // The state of the Client VPN endpoint. Possible states include: - // - // * - // pending-associate - The Client VPN endpoint has been created but no target - // networks have been associated. The Client VPN endpoint cannot accept - // connections. - // - // * available - The Client VPN endpoint has been created and a - // target network has been associated. The Client VPN endpoint can accept - // connections. - // - // * deleting - The Client VPN endpoint is being deleted. The Client - // VPN endpoint cannot accept connections. - // - // * deleted - The Client VPN endpoint has - // been deleted. The Client VPN endpoint cannot accept connections. + // - pending-associate - The Client VPN endpoint has been created but no target + // networks have been associated. The Client VPN endpoint cannot accept + // connections. + // - available - The Client VPN endpoint has been created and a target network + // has been associated. The Client VPN endpoint can accept connections. + // - deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint + // cannot accept connections. + // - deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint + // cannot accept connections. Code ClientVpnEndpointStatusCode // A message about the status of the Client VPN endpoint. @@ -1881,14 +1812,14 @@ type ClientVpnRouteStatus struct { // Options for sending VPN tunnel logs to CloudWatch. type CloudWatchLogOptions struct { - // Status of VPN tunnel logging feature. Default value is False. Valid values: True - // | False + // Status of VPN tunnel logging feature. Default value is False . Valid values: + // True | False LogEnabled *bool // The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. LogGroupArn *string - // Configured log format. Default format is json. Valid values: json | text + // Configured log format. Default format is json . Valid values: json | text LogOutputFormat *string noSmithyDocumentSerde @@ -1897,14 +1828,14 @@ type CloudWatchLogOptions struct { // Options for sending VPN tunnel logs to CloudWatch. type CloudWatchLogOptionsSpecification struct { - // Enable or disable VPN tunnel logging feature. Default value is False. Valid + // Enable or disable VPN tunnel logging feature. Default value is False . Valid // values: True | False LogEnabled *bool // The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. LogGroupArn *string - // Set log format. Default format is json. Valid values: json | text + // Set log format. Default format is json . Valid values: json | text LogOutputFormat *string noSmithyDocumentSerde @@ -2003,8 +1934,8 @@ type ConnectionLogResponseOptions struct { // Describes a connection notification for a VPC endpoint or VPC endpoint service. type ConnectionNotification struct { - // The events for the notification. Valid values are Accept, Connect, Delete, and - // Reject. + // The events for the notification. Valid values are Accept , Connect , Delete , + // and Reject . ConnectionEvents []string // The ARN of the SNS topic for the notification. @@ -2078,7 +2009,7 @@ type CpuOptionsRequest struct { CoreCount *int32 // The number of threads per CPU core. To disable multithreading for the instance, - // specify a value of 1. Otherwise, specify the default value of 2. + // specify a value of 1 . Otherwise, specify the default value of 2 . ThreadsPerCore *int32 noSmithyDocumentSerde @@ -2088,13 +2019,13 @@ type CpuOptionsRequest struct { type CreateFleetError struct { // The error code that indicates why the instance could not be launched. For more - // information about error codes, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // information about error codes, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html) + // . ErrorCode *string // The error message that describes why the instance could not be launched. For - // more information about error messages, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // more information about error messages, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html) + // . ErrorMessage *string // The launch templates and overrides that were used for launching the instances. @@ -2147,8 +2078,8 @@ type CreateTransitGatewayConnectRequestOptions struct { // The options for the transit gateway multicast domain. type CreateTransitGatewayMulticastDomainRequestOptions struct { - // Indicates whether to automatically accept cross-account subnet associations that - // are associated with the transit gateway multicast domain. + // Indicates whether to automatically accept cross-account subnet associations + // that are associated with the transit gateway multicast domain. AutoAcceptSharedAssociations AutoAcceptSharedAssociationsValue // Specify whether to enable Internet Group Management Protocol (IGMP) version 2 @@ -2162,8 +2093,8 @@ type CreateTransitGatewayMulticastDomainRequestOptions struct { noSmithyDocumentSerde } -// Describes whether dynamic routing is enabled or disabled for the transit gateway -// peering request. +// Describes whether dynamic routing is enabled or disabled for the transit +// gateway peering request. type CreateTransitGatewayPeeringAttachmentRequestOptions struct { // Indicates whether dynamic routing is enabled or disabled. @@ -2175,15 +2106,15 @@ type CreateTransitGatewayPeeringAttachmentRequestOptions struct { // Describes the options for a VPC attachment. type CreateTransitGatewayVpcAttachmentRequestOptions struct { - // Enable or disable support for appliance mode. If enabled, a traffic flow between - // a source and destination uses the same Availability Zone for the VPC attachment - // for the lifetime of that flow. The default is disable. + // Enable or disable support for appliance mode. If enabled, a traffic flow + // between a source and destination uses the same Availability Zone for the VPC + // attachment for the lifetime of that flow. The default is disable . ApplianceModeSupport ApplianceModeSupportValue - // Enable or disable DNS support. The default is enable. + // Enable or disable DNS support. The default is enable . DnsSupport DnsSupportValue - // Enable or disable IPv6 support. The default is disable. + // Enable or disable IPv6 support. The default is disable . Ipv6Support Ipv6SupportValue noSmithyDocumentSerde @@ -2247,9 +2178,9 @@ type CreateVerifiedAccessTrustProviderOidcOptions struct { // The OIDC issuer. Issuer *string - // OpenID Connect (OIDC) scopes are used by an application during authentication to - // authorize access to a user's details. Each scope returns a specific set of user - // attributes. + // OpenID Connect (OIDC) scopes are used by an application during authentication + // to authorize access to a user's details. Each scope returns a specific set of + // user attributes. Scope *string // The OIDC token endpoint. @@ -2265,7 +2196,7 @@ type CreateVerifiedAccessTrustProviderOidcOptions struct { // volume permissions for a volume. type CreateVolumePermission struct { - // The group to be added or removed. The possible value is all. + // The group to be added or removed. The possible value is all . Group PermissionGroup // The ID of the Amazon Web Services account to be added or removed. @@ -2327,14 +2258,14 @@ type CustomerGateway struct { // The IP address of the customer gateway device's outside interface. IpAddress *string - // The current state of the customer gateway (pending | available | deleting | - // deleted). + // The current state of the customer gateway ( pending | available | deleting | + // deleted ). State *string // Any tags assigned to the customer gateway. Tags []Tag - // The type of VPN connection the customer gateway supports (ipsec.1). + // The type of VPN connection the customer gateway supports ( ipsec.1 ). Type *string noSmithyDocumentSerde @@ -2344,15 +2275,15 @@ type CustomerGateway struct { type DataQuery struct { // The Region or Availability Zone that's the target for the data query. For - // example, eu-north-1. + // example, eu-north-1 . Destination *string // A user-defined ID associated with a data query that's returned in the - // dataResponse identifying the query. For example, if you set the Id to - // MyQuery01in the query, the dataResponse identifies the query as MyQuery01. + // dataResponse identifying the query. For example, if you set the Id to MyQuery01 + // in the query, the dataResponse identifies the query as MyQuery01 . Id *string - // The metric, aggregation-latency, indicating that network latency is aggregated + // The metric, aggregation-latency , indicating that network latency is aggregated // for the query. This is the only supported metric. Metric MetricType @@ -2360,25 +2291,25 @@ type DataQuery struct { Period PeriodType // The Region or Availability Zone that's the source for the data query. For - // example, us-east-1. + // example, us-east-1 . Source *string - // The metric data aggregation period, p50, between the specified startDate and - // endDate. For example, a metric of five_minutes is the median of all the data + // The metric data aggregation period, p50 , between the specified startDate and + // endDate . For example, a metric of five_minutes is the median of all the data // points gathered within those five minutes. p50 is the only supported metric. Statistic StatisticType noSmithyDocumentSerde } -// The response to a DataQuery. +// The response to a DataQuery . type DataResponse struct { // The Region or Availability Zone that's the destination for the data query. For - // example, eu-west-1. + // example, eu-west-1 . Destination *string - // The ID passed in the DataQuery. + // The ID passed in the DataQuery . Id *string // The metric used for the network performance request. Only aggregate-latency is @@ -2392,7 +2323,7 @@ type DataResponse struct { Period PeriodType // The Region or Availability Zone that's the source for the data query. For - // example, us-east-1. + // example, us-east-1 . Source *string // The statistic used for the network performance request. @@ -2522,7 +2453,7 @@ type DescribeFastLaunchImagesSuccessItem struct { OwnerId *string // The resource type that is used for pre-provisioning the Windows AMI. Supported - // values include: snapshot. + // values include: snapshot . ResourceType FastLaunchResourceType // A group of parameters that are used for pre-provisioning the associated Windows @@ -2567,8 +2498,8 @@ type DescribeFastSnapshotRestoreSuccessItem struct { // snapshot. This is intended for future use. OwnerAlias *string - // The ID of the Amazon Web Services account that enabled fast snapshot restores on - // the snapshot. + // The ID of the Amazon Web Services account that enabled fast snapshot restores + // on the snapshot. OwnerId *string // The ID of the snapshot. @@ -2578,13 +2509,10 @@ type DescribeFastSnapshotRestoreSuccessItem struct { State FastSnapshotRestoreStateCode // The reason for the state transition. The possible values are as follows: - // - // * - // Client.UserInitiated - The state successfully transitioned to enabling or - // disabling. - // - // * Client.UserInitiated - Lifecycle state transition - The state - // successfully transitioned to optimizing, enabled, or disabled. + // - Client.UserInitiated - The state successfully transitioned to enabling or + // disabling . + // - Client.UserInitiated - Lifecycle state transition - The state successfully + // transitioned to optimizing , enabled , or disabled . StateTransitionReason *string noSmithyDocumentSerde @@ -2594,13 +2522,13 @@ type DescribeFastSnapshotRestoreSuccessItem struct { type DescribeFleetError struct { // The error code that indicates why the instance could not be launched. For more - // information about error codes, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // information about error codes, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html) + // . ErrorCode *string // The error message that describes why the instance could not be launched. For - // more information about error messages, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // more information about error messages, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html) + // . ErrorMessage *string // The launch templates and overrides that were used for launching the instances. @@ -2642,15 +2570,15 @@ type DescribeFleetsInstances struct { // Describes the destination options for a flow log. type DestinationOptionsRequest struct { - // The format for the flow log. The default is plain-text. + // The format for the flow log. The default is plain-text . FileFormat DestinationFileFormat - // Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon - // S3. The default is false. + // Indicates whether to use Hive-compatible prefixes for flow logs stored in + // Amazon S3. The default is false . HiveCompatiblePartitions *bool // Indicates whether to partition the flow log per hour. This reduces the cost and - // response time for queries. The default is false. + // response time for queries. The default is false . PerHourPartition *bool noSmithyDocumentSerde @@ -2662,8 +2590,8 @@ type DestinationOptionsResponse struct { // The format for the flow log. FileFormat DestinationFileFormat - // Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon - // S3. + // Indicates whether to use Hive-compatible prefixes for flow logs stored in + // Amazon S3. HiveCompatiblePartitions *bool // Indicates whether to partition the flow log per hour. @@ -2730,8 +2658,8 @@ type DirectoryServiceAuthenticationRequest struct { noSmithyDocumentSerde } -// Contains information about the errors that occurred when disabling fast snapshot -// restores. +// Contains information about the errors that occurred when disabling fast +// snapshot restores. type DisableFastSnapshotRestoreErrorItem struct { // The errors. @@ -2793,8 +2721,8 @@ type DisableFastSnapshotRestoreSuccessItem struct { // snapshot. This is intended for future use. OwnerAlias *string - // The ID of the Amazon Web Services account that enabled fast snapshot restores on - // the snapshot. + // The ID of the Amazon Web Services account that enabled fast snapshot restores + // on the snapshot. OwnerId *string // The ID of the snapshot. @@ -2804,13 +2732,10 @@ type DisableFastSnapshotRestoreSuccessItem struct { State FastSnapshotRestoreStateCode // The reason for the state transition. The possible values are as follows: - // - // * - // Client.UserInitiated - The state successfully transitioned to enabling or - // disabling. - // - // * Client.UserInitiated - Lifecycle state transition - The state - // successfully transitioned to optimizing, enabled, or disabled. + // - Client.UserInitiated - The state successfully transitioned to enabling or + // disabling . + // - Client.UserInitiated - Lifecycle state transition - The state successfully + // transitioned to optimizing , enabled , or disabled . StateTransitionReason *string noSmithyDocumentSerde @@ -2842,11 +2767,10 @@ type DiskImageDescription struct { // A presigned URL for the import manifest stored in Amazon S3. For information // about creating a presigned URL for an Amazon S3 object, read the "Query String - // Request Authentication Alternative" section of the Authenticating REST Requests - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) topic - // in the Amazon Simple Storage Service Developer Guide. For information about the - // import manifest referenced by this API action, see VM Import Manifest - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). + // Request Authentication Alternative" section of the Authenticating REST Requests (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) + // topic in the Amazon Simple Storage Service Developer Guide. For information + // about the import manifest referenced by this API action, see VM Import Manifest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html) + // . ImportManifestUrl *string // The size of the disk image, in GiB. @@ -2871,11 +2795,10 @@ type DiskImageDetail struct { // A presigned URL for the import manifest stored in Amazon S3 and presented here // as an Amazon S3 presigned URL. For information about creating a presigned URL // for an Amazon S3 object, read the "Query String Request Authentication - // Alternative" section of the Authenticating REST Requests - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) topic - // in the Amazon Simple Storage Service Developer Guide. For information about the - // import manifest referenced by this API action, see VM Import Manifest - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). + // Alternative" section of the Authenticating REST Requests (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) + // topic in the Amazon Simple Storage Service Developer Guide. For information + // about the import manifest referenced by this API action, see VM Import Manifest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html) + // . // // This member is required. ImportManifestUrl *string @@ -2952,9 +2875,9 @@ type DnsOptionsSpecification struct { // Information about the DNS server to be used. type DnsServersOptionsModifyStructure struct { - // The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can - // specify up to two DNS servers. Ensure that the DNS servers can be reached by the - // clients. The specified values overwrite the existing values. + // The IPv4 address range, in CIDR notation, of the DNS servers to be used. You + // can specify up to two DNS servers. Ensure that the DNS servers can be reached by + // the clients. The specified values overwrite the existing values. CustomDnsServers []string // Indicates whether DNS servers should be used. Specify False to delete the @@ -2968,8 +2891,7 @@ type DnsServersOptionsModifyStructure struct { type EbsBlockDevice struct { // Indicates whether the EBS volume is deleted on instance termination. For more - // information, see Preserving Amazon EBS volumes on instance termination - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) + // information, see Preserving Amazon EBS volumes on instance termination (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) // in the Amazon EC2 User Guide. DeleteOnTermination *bool @@ -2977,74 +2899,59 @@ type EbsBlockDevice struct { // restored from a backing snapshot. The effect of setting the encryption state to // true depends on the volume origin (new or from a snapshot), starting encryption // state, ownership, and whether encryption by default is enabled. For more - // information, see Amazon EBS encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) + // information, see Amazon EBS encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) // in the Amazon EC2 User Guide. In no case can you remove encryption from an // encrypted volume. Encrypted volumes can only be attached to instances that // support Amazon EBS encryption. For more information, see Supported instance - // types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). - // This parameter is not returned by DescribeImageAttribute. For CreateImage and - // RegisterImage, whether you can include this parameter, and the allowed values - // differ depending on the type of block device mapping you are creating. - // - // * If you - // are creating a block device mapping for a new (empty) volume, you can include - // this parameter, and specify either true for an encrypted volume, or false for an - // unencrypted volume. If you omit this parameter, it defaults to false - // (unencrypted). - // - // * If you are creating a block device mapping from an existing - // encrypted or unencrypted snapshot, you must omit this parameter. If you include - // this parameter, the request will fail, regardless of the value that you - // specify. - // - // * If you are creating a block device mapping from an existing - // unencrypted volume, you can include this parameter, but you must specify false. - // If you specify true, the request will fail. In this case, we recommend that you - // omit the parameter. - // - // * If you are creating a block device mapping from an - // existing encrypted volume, you can include this parameter, and specify either - // true or false. However, if you specify false, the parameter is ignored and the - // block device mapping is always encrypted. In this case, we recommend that you - // omit the parameter. + // types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) + // . This parameter is not returned by DescribeImageAttribute . For CreateImage + // and RegisterImage , whether you can include this parameter, and the allowed + // values differ depending on the type of block device mapping you are creating. + // - If you are creating a block device mapping for a new (empty) volume, you + // can include this parameter, and specify either true for an encrypted volume, + // or false for an unencrypted volume. If you omit this parameter, it defaults to + // false (unencrypted). + // - If you are creating a block device mapping from an existing encrypted or + // unencrypted snapshot, you must omit this parameter. If you include this + // parameter, the request will fail, regardless of the value that you specify. + // - If you are creating a block device mapping from an existing unencrypted + // volume, you can include this parameter, but you must specify false . If you + // specify true , the request will fail. In this case, we recommend that you omit + // the parameter. + // - If you are creating a block device mapping from an existing encrypted + // volume, you can include this parameter, and specify either true or false . + // However, if you specify false , the parameter is ignored and the block device + // mapping is always encrypted. In this case, we recommend that you omit the + // parameter. Encrypted *bool - // The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, - // this represents the number of IOPS that are provisioned for the volume. For gp2 - // volumes, this represents the baseline performance of the volume and the rate at - // which the volume accumulates I/O credits for bursting. The following are the - // supported values for each volume type: - // - // * gp3: 3,000-16,000 IOPS - // - // * io1: - // 100-64,000 IOPS - // - // * io2: 100-64,000 IOPS - // - // For io1 and io2 volumes, we guarantee - // 64,000 IOPS only for Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families guarantee performance up to 32,000 IOPS. This parameter - // is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. - // This parameter is not supported for gp2, st1, sc1, or standard volumes. + // The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 + // volumes, this represents the number of IOPS that are provisioned for the volume. + // For gp2 volumes, this represents the baseline performance of the volume and the + // rate at which the volume accumulates I/O credits for bursting. The following are + // the supported values for each volume type: + // - gp3 : 3,000-16,000 IOPS + // - io1 : 100-64,000 IOPS + // - io2 : 100-64,000 IOPS + // For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on + // the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // . Other instance families guarantee performance up to 32,000 IOPS. This + // parameter is required for io1 and io2 volumes. The default for gp3 volumes is + // 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard + // volumes. Iops *int32 // Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK // under which the EBS volume is encrypted. This parameter is only supported on - // BlockDeviceMapping objects called by RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html), - // RequestSpotFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), - // and RequestSpotInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html). + // BlockDeviceMapping objects called by RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // , RequestSpotFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html) + // , and RequestSpotInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) + // . KmsKeyId *string // The ARN of the Outpost on which the snapshot is stored. This parameter is only - // supported on BlockDeviceMapping objects called by CreateImage - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html). + // supported on BlockDeviceMapping objects called by CreateImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html) + // . OutpostArn *string // The ID of the snapshot. @@ -3058,22 +2965,15 @@ type EbsBlockDevice struct { // volume size. If you specify a snapshot, the default is the snapshot size. You // can specify a volume size that is equal to or larger than the snapshot size. The // following are the supported volumes sizes for each volume type: - // - // * gp2 and - // gp3:1-16,384 - // - // * io1 and io2: 4-16,384 - // - // * st1 and sc1: 125-16,384 - // - // * standard: - // 1-1,024 + // - gp2 and gp3 :1-16,384 + // - io1 and io2 : 4-16,384 + // - st1 and sc1 : 125-16,384 + // - standard : 1-1,024 VolumeSize *int32 - // The volume type. For more information, see Amazon EBS volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the - // IOPS that the volume supports. + // The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon EC2 User Guide. If the volume type is io1 or io2 , you must + // specify the IOPS that the volume supports. VolumeType VolumeType noSmithyDocumentSerde @@ -3086,9 +2986,8 @@ type EbsInfo struct { EbsOptimizedInfo *EbsOptimizedInfo // Indicates whether the instance type is Amazon EBS-optimized. For more - // information, see Amazon EBS-optimized instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in - // Amazon EC2 User Guide. + // information, see Amazon EBS-optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) + // in Amazon EC2 User Guide. EbsOptimizedSupport EbsOptimizedSupport // Indicates whether Amazon EBS encryption is supported. @@ -3241,9 +3140,8 @@ type ElasticGpus struct { type ElasticGpuSpecification struct { // The type of Elastic Graphics accelerator. For more information about the values - // to specify for Type, see Elastic Graphics Basics - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), - // specifically the Elastic Graphics accelerator column, in the Amazon Elastic + // to specify for Type , see Elastic Graphics Basics (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics) + // , specifically the Elastic Graphics accelerator column, in the Amazon Elastic // Compute Cloud User Guide for Windows Instances. // // This member is required. @@ -3264,14 +3162,14 @@ type ElasticGpuSpecificationResponse struct { // Describes an elastic inference accelerator. type ElasticInferenceAccelerator struct { - // The type of elastic inference accelerator. The possible values are eia1.medium, - // eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge. + // The type of elastic inference accelerator. The possible values are eia1.medium , + // eia1.large , eia1.xlarge , eia2.medium , eia2.large , and eia2.xlarge . // // This member is required. Type *string - // The number of elastic inference accelerators to attach to the instance. Default: - // 1 + // The number of elastic inference accelerators to attach to the instance. + // Default: 1 Count *int32 noSmithyDocumentSerde @@ -3360,8 +3258,8 @@ type EnableFastSnapshotRestoreSuccessItem struct { // snapshot. This is intended for future use. OwnerAlias *string - // The ID of the Amazon Web Services account that enabled fast snapshot restores on - // the snapshot. + // The ID of the Amazon Web Services account that enabled fast snapshot restores + // on the snapshot. OwnerId *string // The ID of the snapshot. @@ -3371,28 +3269,25 @@ type EnableFastSnapshotRestoreSuccessItem struct { State FastSnapshotRestoreStateCode // The reason for the state transition. The possible values are as follows: - // - // * - // Client.UserInitiated - The state successfully transitioned to enabling or - // disabling. - // - // * Client.UserInitiated - Lifecycle state transition - The state - // successfully transitioned to optimizing, enabled, or disabled. + // - Client.UserInitiated - The state successfully transitioned to enabling or + // disabling . + // - Client.UserInitiated - Lifecycle state transition - The state successfully + // transitioned to optimizing , enabled , or disabled . StateTransitionReason *string noSmithyDocumentSerde } -// ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology -// to increase the maximum bandwidth used per stream and minimize tail latency of -// network traffic between EC2 instances. With ENA Express, you can communicate -// between two EC2 instances in the same subnet within the same account, or in -// different accounts. Both sending and receiving instances must have ENA Express -// enabled. To improve the reliability of network packet delivery, ENA Express -// reorders network packets on the receiving end by default. However, some -// UDP-based applications are designed to handle network packets that are out of -// order to reduce the overhead for packet delivery at the network layer. When ENA -// Express is enabled, you can specify whether UDP network traffic uses it. +// ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) +// technology to increase the maximum bandwidth used per stream and minimize tail +// latency of network traffic between EC2 instances. With ENA Express, you can +// communicate between two EC2 instances in the same subnet within the same +// account, or in different accounts. Both sending and receiving instances must +// have ENA Express enabled. To improve the reliability of network packet delivery, +// ENA Express reorders network packets on the receiving end by default. However, +// some UDP-based applications are designed to handle network packets that are out +// of order to reduce the overhead for packet delivery at the network layer. When +// ENA Express is enabled, you can specify whether UDP network traffic uses it. type EnaSrdSpecification struct { // Indicates whether ENA Express is enabled for the network interface. @@ -3423,7 +3318,7 @@ type EnaSrdUdpSpecification struct { // Enclaves. type EnclaveOptions struct { - // If this parameter is set to true, the instance is enabled for Amazon Web + // If this parameter is set to true , the instance is enabled for Amazon Web // Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services // Nitro Enclaves. Enabled *bool @@ -3432,13 +3327,12 @@ type EnclaveOptions struct { } // Indicates whether the instance is enabled for Amazon Web Services Nitro -// Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? -// (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the -// Amazon Web Services Nitro Enclaves User Guide. +// Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) +// in the Amazon Web Services Nitro Enclaves User Guide. type EnclaveOptionsRequest struct { // To enable the instance for Amazon Web Services Nitro Enclaves, set this - // parameter to true. + // parameter to true . Enabled *bool noSmithyDocumentSerde @@ -3451,95 +3345,59 @@ type EventInformation struct { EventDescription *string // The event. error events: - // - // * iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet - // does not have the required permissions either to launch or terminate an - // instance. - // - // * allLaunchSpecsTemporarilyBlacklisted - None of the configurations - // are valid, and several attempts to launch instances have failed. For more - // information, see the description of the event. - // - // * spotInstanceCountLimitExceeded - // - You've reached the limit on the number of Spot Instances that you can - // launch. - // - // * spotFleetRequestConfigurationInvalid - The configuration is not - // valid. For more information, see the description of the - // event. - // + // - iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required + // permissions either to launch or terminate an instance. + // - allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, + // and several attempts to launch instances have failed. For more information, see + // the description of the event. + // - spotInstanceCountLimitExceeded - You've reached the limit on the number of + // Spot Instances that you can launch. + // - spotFleetRequestConfigurationInvalid - The configuration is not valid. For + // more information, see the description of the event. // fleetRequestChange events: - // - // * active - The EC2 Fleet or Spot Fleet - // request has been validated and Amazon EC2 is attempting to maintain the target - // number of running instances. - // - // * deleted (EC2 Fleet) / cancelled (Spot Fleet) - - // The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no - // running instances. The EC2 Fleet or Spot Fleet will be deleted two days after - // its instances are terminated. - // - // * deleted_running (EC2 Fleet) / cancelled_running - // (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled - // and does not launch additional instances. Its existing instances continue to run - // until they are interrupted or terminated. The request remains in this state - // until all instances are interrupted or terminated. - // - // * deleted_terminating (EC2 - // Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the - // Spot Fleet request is canceled and its instances are terminating. The request - // remains in this state until all instances are terminated. - // - // * expired - The EC2 - // Fleet or Spot Fleet request has expired. If the request was created with - // TerminateInstancesWithExpiration set, a subsequent terminated event indicates - // that the instances are terminated. - // - // * modify_in_progress - The EC2 Fleet or Spot - // Fleet request is being modified. The request remains in this state until the - // modification is fully processed. - // - // * modify_succeeded - The EC2 Fleet or Spot - // Fleet request was modified. - // - // * submitted - The EC2 Fleet or Spot Fleet request - // is being evaluated and Amazon EC2 is preparing to launch the target number of - // instances. - // - // * progress - The EC2 Fleet or Spot Fleet request is in the process - // of being fulfilled. - // + // - active - The EC2 Fleet or Spot Fleet request has been validated and Amazon + // EC2 is attempting to maintain the target number of running instances. + // - deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or + // the Spot Fleet request is canceled and has no running instances. The EC2 Fleet + // or Spot Fleet will be deleted two days after its instances are terminated. + // - deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet + // is deleted or the Spot Fleet request is canceled and does not launch additional + // instances. Its existing instances continue to run until they are interrupted or + // terminated. The request remains in this state until all instances are + // interrupted or terminated. + // - deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The + // EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are + // terminating. The request remains in this state until all instances are + // terminated. + // - expired - The EC2 Fleet or Spot Fleet request has expired. If the request + // was created with TerminateInstancesWithExpiration set, a subsequent terminated + // event indicates that the instances are terminated. + // - modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. + // The request remains in this state until the modification is fully processed. + // - modify_succeeded - The EC2 Fleet or Spot Fleet request was modified. + // - submitted - The EC2 Fleet or Spot Fleet request is being evaluated and + // Amazon EC2 is preparing to launch the target number of instances. + // - progress - The EC2 Fleet or Spot Fleet request is in the process of being + // fulfilled. // instanceChange events: - // - // * launched - A new instance was - // launched. - // - // * terminated - An instance was terminated by the user. - // - // * - // termination_notified - An instance termination notification was sent when a Spot - // Instance was terminated by Amazon EC2 during scale-down, when the target - // capacity of the fleet was modified down, for example, from a target capacity of - // 4 to a target capacity of 3. - // + // - launched - A new instance was launched. + // - terminated - An instance was terminated by the user. + // - termination_notified - An instance termination notification was sent when a + // Spot Instance was terminated by Amazon EC2 during scale-down, when the target + // capacity of the fleet was modified down, for example, from a target capacity of + // 4 to a target capacity of 3. // Information events: - // - // * fleetProgressHalted - The - // price in every launch specification is not valid because it is below the Spot - // price (all the launch specifications have produced launchSpecUnusable events). A - // launch specification might become valid if the Spot price changes. - // - // * - // launchSpecTemporarilyBlacklisted - The configuration is not valid and several - // attempts to launch instances have failed. For more information, see the - // description of the event. - // - // * launchSpecUnusable - The price in a launch - // specification is not valid because it is below the Spot price. - // - // * - // registerWithLoadBalancersFailed - An attempt to register instances with load - // balancers failed. For more information, see the description of the event. + // - fleetProgressHalted - The price in every launch specification is not valid + // because it is below the Spot price (all the launch specifications have produced + // launchSpecUnusable events). A launch specification might become valid if the + // Spot price changes. + // - launchSpecTemporarilyBlacklisted - The configuration is not valid and + // several attempts to launch instances have failed. For more information, see the + // description of the event. + // - launchSpecUnusable - The price in a launch specification is not valid + // because it is below the Spot price. + // - registerWithLoadBalancersFailed - An attempt to register instances with load + // balancers failed. For more information, see the description of the event. EventSubType *string // The ID of the instance. This information is available only for instanceChange @@ -3549,9 +3407,9 @@ type EventInformation struct { noSmithyDocumentSerde } -// Describes an explanation code for an unreachable path. For more information, see -// Reachability Analyzer explanation codes -// (https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html). +// Describes an explanation code for an unreachable path. For more information, +// see Reachability Analyzer explanation codes (https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) +// . type Explanation struct { // The network ACL. @@ -3597,10 +3455,8 @@ type Explanation struct { DestinationVpc *AnalysisComponent // The direction. The following are the possible values: - // - // * egress - // - // * ingress + // - egress + // - ingress Direction *string // The load balancer listener. @@ -3738,8 +3594,8 @@ type ExportImageTask struct { // Information about the destination Amazon S3 bucket. S3ExportLocation *ExportTaskS3Location - // The status of the export image task. The possible values are active, completed, - // deleting, and deleted. + // The status of the export image task. The possible values are active , completed + // , deleting , and deleted . Status *string // The status message for the export image task. @@ -3807,8 +3663,8 @@ type ExportTaskS3LocationRequest struct { // Describes the format and location for the export task. type ExportToS3Task struct { - // The container format used to combine disk images with metadata (such as OVF). If - // absent, only the disk image is exported. + // The container format used to combine disk images with metadata (such as OVF). + // If absent, only the disk image is exported. ContainerFormat ContainerFormat // The format for the exported image. @@ -3816,9 +3672,8 @@ type ExportToS3Task struct { // The Amazon S3 bucket for the destination image. The destination bucket must // exist and have an access control list (ACL) attached that specifies the - // Region-specific canonical account ID for the Grantee. For more information about - // the ACL to your S3 bucket, see Prerequisites - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) + // Region-specific canonical account ID for the Grantee . For more information + // about the ACL to your S3 bucket, see Prerequisites (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) // in the VM Import/Export User Guide. S3Bucket *string @@ -3831,8 +3686,8 @@ type ExportToS3Task struct { // Describes an export instance task. type ExportToS3TaskSpecification struct { - // The container format used to combine disk images with metadata (such as OVF). If - // absent, only the disk image is exported. + // The container format used to combine disk images with metadata (such as OVF). + // If absent, only the disk image is exported. ContainerFormat ContainerFormat // The format for the exported image. @@ -3840,9 +3695,8 @@ type ExportToS3TaskSpecification struct { // The Amazon S3 bucket for the destination image. The destination bucket must // exist and have an access control list (ACL) attached that specifies the - // Region-specific canonical account ID for the Grantee. For more information about - // the ACL to your S3 bucket, see Prerequisites - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) + // Region-specific canonical account ID for the Grantee . For more information + // about the ACL to your S3 bucket, see Prerequisites (https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) // in the VM Import/Export User Guide. S3Bucket *string @@ -3878,8 +3732,8 @@ type FailedQueuedPurchaseDeletion struct { } // Request to create a launch template for a fast-launch enabled Windows AMI. Note -// - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not -// both. +// - You can specify either the LaunchTemplateName or the LaunchTemplateId , but +// not both. type FastLaunchLaunchTemplateSpecificationRequest struct { // The version of the launch template to use for faster launching for a Windows @@ -3915,8 +3769,8 @@ type FastLaunchLaunchTemplateSpecificationResponse struct { noSmithyDocumentSerde } -// Configuration settings for creating and managing pre-provisioned snapshots for a -// fast-launch enabled Windows AMI. +// Configuration settings for creating and managing pre-provisioned snapshots for +// a fast-launch enabled Windows AMI. type FastLaunchSnapshotConfigurationRequest struct { // The number of pre-provisioned snapshots to keep on hand for a fast-launch @@ -3926,8 +3780,8 @@ type FastLaunchSnapshotConfigurationRequest struct { noSmithyDocumentSerde } -// Configuration settings for creating and managing pre-provisioned snapshots for a -// fast-launch enabled Windows AMI. +// Configuration settings for creating and managing pre-provisioned snapshots for +// a fast-launch enabled Windows AMI. type FastLaunchSnapshotConfigurationResponse struct { // The number of pre-provisioned snapshots requested to keep on hand for a @@ -3966,7 +3820,7 @@ type FederatedAuthenticationRequest struct { // A filter name and value pair that is used to return a more specific list of // results from a describe operation. Filters can be used to match a set of // resources by specific criteria, such as tags, attributes, or IDs. If you specify -// multiple filters, the filters are joined with an AND, and the request returns +// multiple filters, the filters are joined with an AND , and the request returns // only results that match all of the specified filters. type Filter struct { @@ -3974,7 +3828,7 @@ type Filter struct { Name *string // The filter values. Filter values are case-sensitive. If you specify multiple - // values for a filter, the values are joined with an OR, and the request returns + // values for a filter, the values are joined with an OR , and the request returns // all results that match any of the specified values. Values []string @@ -4002,13 +3856,13 @@ type FirewallStatefulRule struct { // The destination IP addresses, in CIDR notation. Destinations []string - // The direction. The possible values are FORWARD and ANY. + // The direction. The possible values are FORWARD and ANY . Direction *string // The protocol. Protocol *string - // The rule action. The possible values are pass, drop, and alert. + // The rule action. The possible values are pass , drop , and alert . RuleAction *string // The ARN of the stateful rule group. @@ -4038,7 +3892,7 @@ type FirewallStatelessRule struct { // The protocols. Protocols []int32 - // The rule action. The possible values are pass, drop, and forward_to_site. + // The rule action. The possible values are pass , drop , and forward_to_site . RuleAction *string // The ARN of the stateless rule group. @@ -4074,8 +3928,7 @@ type FleetCapacityReservation struct { EbsOptimized *bool // The number of capacity units fulfilled by the Capacity Reservation. For more - // information, see Total target capacity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) + // information, see Total target capacity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) // in the Amazon EC2 User Guide. FulfilledCapacity *float64 @@ -4087,8 +3940,7 @@ type FleetCapacityReservation struct { InstanceType InstanceType // The priority of the instance type in the Capacity Reservation Fleet. For more - // information, see Instance type priority - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) + // information, see Instance type priority (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) // in the Amazon EC2 User Guide. Priority *int32 @@ -4097,8 +3949,7 @@ type FleetCapacityReservation struct { TotalInstanceCount *int32 // The weight of the instance type in the Capacity Reservation Fleet. For more - // information, see Instance type weight - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight) + // information, see Instance type weight (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight) // in the Amazon EC2 User Guide. Weight *float64 @@ -4108,17 +3959,16 @@ type FleetCapacityReservation struct { // Describes an EC2 Fleet. type FleetData struct { - // The progress of the EC2 Fleet. If there is an error, the status is error. After - // all requests are placed, the status is pending_fulfillment. If the size of the + // The progress of the EC2 Fleet. If there is an error, the status is error . After + // all requests are placed, the status is pending_fulfillment . If the size of the // EC2 Fleet is equal to or greater than its target capacity, the status is - // fulfilled. If the size of the EC2 Fleet is decreased, the status is + // fulfilled . If the size of the EC2 Fleet is decreased, the status is // pending_termination while instances are terminating. ActivityStatus FleetActivityStatus // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). - // Constraints: Maximum 64 ASCII characters + // the request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . Constraints: Maximum 64 ASCII characters ClientToken *string // Reserved. @@ -4128,12 +3978,12 @@ type FleetData struct { CreateTime *time.Time // Information about the instances that could not be launched by the fleet. Valid - // only when Type is set to instant. + // only when Type is set to instant . Errors []DescribeFleetError // Indicates whether running instances should be terminated if the target capacity // of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported - // only for fleets of type maintain. + // only for fleets of type maintain . ExcessCapacityTerminationPolicy FleetExcessCapacityTerminationPolicy // The ID of the EC2 Fleet. @@ -4150,8 +4000,8 @@ type FleetData struct { // On-Demand capacity. FulfilledOnDemandCapacity *float64 - // Information about the instances that were launched by the fleet. Valid only when - // Type is set to instant. + // Information about the instances that were launched by the fleet. Valid only + // when Type is set to instant . Instances []DescribeFleetsInstances // The launch template and overrides. @@ -4161,9 +4011,8 @@ type FleetData struct { OnDemandOptions *OnDemandOptions // Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported - // only for fleets of type maintain. For more information, see EC2 Fleet health - // checks - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) + // only for fleets of type maintain . For more information, see EC2 Fleet health + // checks (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) // in the Amazon EC2 User Guide. ReplaceUnhealthyInstances *bool @@ -4176,7 +4025,7 @@ type FleetData struct { // The number of units to request. You can choose to set the target capacity in // terms of instances or a performance characteristic that is important to your // application workload, such as vCPUs, memory, or I/O. If the request type is - // maintain, you can specify a target capacity of 0 and add capacity later. + // maintain , you can specify a target capacity of 0 and add capacity later. TargetCapacitySpecification *TargetCapacitySpecification // Indicates whether running instances should be terminated when the EC2 Fleet @@ -4190,7 +4039,7 @@ type FleetData struct { // in alternative capacity pools if capacity is unavailable. To maintain a certain // target capacity, EC2 Fleet places the required requests to meet this target // capacity. It also automatically replenishes any interrupted Spot Instances. - // Default: maintain. + // Default: maintain . Type FleetType // The start date and time of the request, in UTC format (for example, @@ -4228,7 +4077,7 @@ type FleetLaunchTemplateConfigRequest struct { LaunchTemplateSpecification *FleetLaunchTemplateSpecificationRequest // Any parameters that you specify override the same parameters in the launch - // template. For fleets of type request and maintain, a maximum of 300 items is + // template. For fleets of type request and maintain , a maximum of 300 items is // allowed across all launch templates. Overrides []FleetLaunchTemplateOverridesRequest @@ -4247,30 +4096,30 @@ type FleetLaunchTemplateOverrides struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with those attributes. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements - // The instance type. mac1.metal is not supported as a launch template override. If - // you specify InstanceType, you can't specify InstanceRequirements. + // The instance type. mac1.metal is not supported as a launch template override. + // If you specify InstanceType , you can't specify InstanceRequirements . InstanceType InstanceType - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. MaxPrice *string // The location where the instance launched, if applicable. Placement *PlacementResponse // The priority for the launch template override. The highest priority is launched - // first. If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses - // priority to determine which launch template override to use first in fulfilling - // On-Demand capacity. If the Spot AllocationStrategy is set to - // capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis + // first. If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet + // uses priority to determine which launch template override to use first in + // fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to + // capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis // to determine which launch template override to use in fulfilling Spot capacity, - // but optimizes for capacity first. Valid values are whole numbers starting at 0. + // but optimizes for capacity first. Valid values are whole numbers starting at 0 . // The lower the number, the higher the priority. If no number is set, the override // has the lowest priority. You can set the same priority for different launch // template overrides. @@ -4297,30 +4146,30 @@ type FleetLaunchTemplateOverridesRequest struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with those attributes. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirementsRequest - // The instance type. mac1.metal is not supported as a launch template override. If - // you specify InstanceType, you can't specify InstanceRequirements. + // The instance type. mac1.metal is not supported as a launch template override. + // If you specify InstanceType , you can't specify InstanceRequirements . InstanceType InstanceType - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. MaxPrice *string // The location where the instance launched, if applicable. Placement *Placement // The priority for the launch template override. The highest priority is launched - // first. If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses - // priority to determine which launch template override to use first in fulfilling - // On-Demand capacity. If the Spot AllocationStrategy is set to - // capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis + // first. If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet + // uses priority to determine which launch template override to use first in + // fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to + // capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis // to determine which launch template override to use in fulfilling Spot capacity, - // but optimizes for capacity first. Valid values are whole numbers starting at 0. + // but optimizes for capacity first. Valid values are whole numbers starting at 0 . // The lower the number, the higher the priority. If no number is set, the launch // template override has the lowest priority. You can set the same priority for // different launch template overrides. @@ -4328,7 +4177,7 @@ type FleetLaunchTemplateOverridesRequest struct { // The IDs of the subnets in which to launch the instances. Separate multiple // subnet IDs using commas (for example, subnet-1234abcdeexample1, - // subnet-0987cdef6example2). A request of type instant can have only one subnet + // subnet-0987cdef6example2 ). A request of type instant can have only one subnet // ID. SubnetId *string @@ -4341,23 +4190,22 @@ type FleetLaunchTemplateOverridesRequest struct { // The Amazon EC2 launch template that can be used by a Spot Fleet to configure // Amazon EC2 instances. You must specify either the ID or name of the launch // template in the request, but not both. For information about launch templates, -// see Launch an instance from a launch template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// see Launch an instance from a launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) // in the Amazon EC2 User Guide. type FleetLaunchTemplateSpecification struct { // The ID of the launch template. You must specify the LaunchTemplateId or the - // LaunchTemplateName, but not both. + // LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId, but not both. + // LaunchTemplateId , but not both. LaunchTemplateName *string - // The launch template version number, $Latest, or $Default. You must specify a - // value, otherwise the request fails. If the value is $Latest, Amazon EC2 uses the - // latest version of the launch template. If the value is $Default, Amazon EC2 uses - // the default version of the launch template. + // The launch template version number, $Latest , or $Default . You must specify a + // value, otherwise the request fails. If the value is $Latest , Amazon EC2 uses + // the latest version of the launch template. If the value is $Default , Amazon EC2 + // uses the default version of the launch template. Version *string noSmithyDocumentSerde @@ -4366,33 +4214,32 @@ type FleetLaunchTemplateSpecification struct { // The Amazon EC2 launch template that can be used by an EC2 Fleet to configure // Amazon EC2 instances. You must specify either the ID or name of the launch // template in the request, but not both. For information about launch templates, -// see Launch an instance from a launch template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// see Launch an instance from a launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) // in the Amazon EC2 User Guide. type FleetLaunchTemplateSpecificationRequest struct { // The ID of the launch template. You must specify the LaunchTemplateId or the - // LaunchTemplateName, but not both. + // LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId, but not both. + // LaunchTemplateId , but not both. LaunchTemplateName *string - // The launch template version number, $Latest, or $Default. You must specify a - // value, otherwise the request fails. If the value is $Latest, Amazon EC2 uses the - // latest version of the launch template. If the value is $Default, Amazon EC2 uses - // the default version of the launch template. + // The launch template version number, $Latest , or $Default . You must specify a + // value, otherwise the request fails. If the value is $Latest , Amazon EC2 uses + // the latest version of the launch template. If the value is $Default , Amazon EC2 + // uses the default version of the launch template. Version *string noSmithyDocumentSerde } -// The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at -// an elevated risk of being interrupted. +// The strategy to use when Amazon EC2 emits a signal that your Spot Instance is +// at an elevated risk of being interrupted. type FleetSpotCapacityRebalance struct { - // The replacement strategy to use. Only available for fleets of type maintain. + // The replacement strategy to use. Only available for fleets of type maintain . // launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance // notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet // does not terminate the instances that receive a rebalance notification. You can @@ -4400,14 +4247,14 @@ type FleetSpotCapacityRebalance struct { // all instances while they are running. launch-before-terminate - EC2 Fleet // launches a new replacement Spot Instance when a rebalance notification is // emitted for an existing Spot Instance in the fleet, and then, after a delay that - // you specify (in TerminationDelay), terminates the instances that received a + // you specify (in TerminationDelay ), terminates the instances that received a // rebalance notification. ReplacementStrategy FleetReplacementStrategy - // The amount of time (in seconds) that Amazon EC2 waits before terminating the old - // Spot Instance after launching a new replacement Spot Instance. Required when - // ReplacementStrategy is set to launch-before-terminate. Not valid when - // ReplacementStrategy is set to launch. Valid values: Minimum value of 120 + // The amount of time (in seconds) that Amazon EC2 waits before terminating the + // old Spot Instance after launching a new replacement Spot Instance. Required when + // ReplacementStrategy is set to launch-before-terminate . Not valid when + // ReplacementStrategy is set to launch . Valid values: Minimum value of 120 // seconds. Maximum value of 7200 seconds. TerminationDelay *int32 @@ -4416,12 +4263,11 @@ type FleetSpotCapacityRebalance struct { // The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance // notification signal that your Spot Instance is at an elevated risk of being -// interrupted. For more information, see Capacity rebalancing -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) +// interrupted. For more information, see Capacity rebalancing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) // in the Amazon EC2 User Guide. type FleetSpotCapacityRebalanceRequest struct { - // The replacement strategy to use. Only available for fleets of type maintain. + // The replacement strategy to use. Only available for fleets of type maintain . // launch - EC2 Fleet launches a replacement Spot Instance when a rebalance // notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet // does not terminate the instances that receive a rebalance notification. You can @@ -4429,14 +4275,14 @@ type FleetSpotCapacityRebalanceRequest struct { // all instances while they are running. launch-before-terminate - EC2 Fleet // launches a replacement Spot Instance when a rebalance notification is emitted // for an existing Spot Instance in the fleet, and then, after a delay that you - // specify (in TerminationDelay), terminates the instances that received a + // specify (in TerminationDelay ), terminates the instances that received a // rebalance notification. ReplacementStrategy FleetReplacementStrategy - // The amount of time (in seconds) that Amazon EC2 waits before terminating the old - // Spot Instance after launching a new replacement Spot Instance. Required when - // ReplacementStrategy is set to launch-before-terminate. Not valid when - // ReplacementStrategy is set to launch. Valid values: Minimum value of 120 + // The amount of time (in seconds) that Amazon EC2 waits before terminating the + // old Spot Instance after launching a new replacement Spot Instance. Required when + // ReplacementStrategy is set to launch-before-terminate . Not valid when + // ReplacementStrategy is set to launch . Valid values: Minimum value of 120 // seconds. Maximum value of 7200 seconds. TerminationDelay *int32 @@ -4447,8 +4293,8 @@ type FleetSpotCapacityRebalanceRequest struct { // being interrupted. type FleetSpotMaintenanceStrategies struct { - // The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at - // an elevated risk of being interrupted. + // The strategy to use when Amazon EC2 emits a signal that your Spot Instance is + // at an elevated risk of being interrupted. CapacityRebalance *FleetSpotCapacityRebalance noSmithyDocumentSerde @@ -4458,8 +4304,8 @@ type FleetSpotMaintenanceStrategies struct { // being interrupted. type FleetSpotMaintenanceStrategiesRequest struct { - // The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at - // an elevated risk of being interrupted. + // The strategy to use when Amazon EC2 emits a signal that your Spot Instance is + // at an elevated risk of being interrupted. CapacityRebalance *FleetSpotCapacityRebalanceRequest noSmithyDocumentSerde @@ -4486,7 +4332,7 @@ type FlowLog struct { // The ARN of the IAM role allows the service to publish logs to CloudWatch Logs. DeliverLogsPermissionArn *string - // The status of the logs delivery (SUCCESS | FAILED). + // The status of the logs delivery ( SUCCESS | FAILED ). DeliverLogsStatus *string // The destination options. @@ -4495,7 +4341,7 @@ type FlowLog struct { // The ID of the flow log. FlowLogId *string - // The status of the flow log (ACTIVE). + // The status of the flow log ( ACTIVE ). FlowLogStatus *string // The Amazon Resource Name (ARN) of the destination for the flow log data. @@ -4512,10 +4358,9 @@ type FlowLog struct { // The maximum interval of time, in seconds, during which a flow of packets is // captured and aggregated into a flow log record. When a network interface is - // attached to a Nitro-based instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances), - // the aggregation interval is always 60 seconds (1 minute) or less, regardless of - // the specified value. Valid Values: 60 | 600 + // attached to a Nitro-based instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // , the aggregation interval is always 60 seconds (1 minute) or less, regardless + // of the specified value. Valid Values: 60 | 600 MaxAggregationInterval *int32 // The ID of the resource being monitored. @@ -4581,8 +4426,8 @@ type FpgaImage struct { // The name of the AFI. Name *string - // The alias of the AFI owner. Possible values include self, amazon, and - // aws-marketplace. + // The alias of the AFI owner. Possible values include self , amazon , and + // aws-marketplace . OwnerAlias *string // The ID of the Amazon Web Services account that owns the AFI. @@ -4634,25 +4479,18 @@ type FpgaImageAttribute struct { noSmithyDocumentSerde } -// Describes the state of the bitstream generation process for an Amazon FPGA image -// (AFI). +// Describes the state of the bitstream generation process for an Amazon FPGA +// image (AFI). type FpgaImageState struct { // The state. The following are the possible values: - // - // * pending - AFI bitstream - // generation is in progress. - // - // * available - The AFI is available for use. - // - // * - // failed - AFI bitstream generation failed. - // - // * unavailable - The AFI is no longer - // available for use. + // - pending - AFI bitstream generation is in progress. + // - available - The AFI is available for use. + // - failed - AFI bitstream generation failed. + // - unavailable - The AFI is no longer available for use. Code FpgaImageStateCode - // If the state is failed, this is the error message. + // If the state is failed , this is the error message. Message *string noSmithyDocumentSerde @@ -4722,30 +4560,26 @@ type GroupIdentifier struct { noSmithyDocumentSerde } -// Indicates whether your instance is configured for hibernation. This parameter is -// valid only if the instance meets the hibernation prerequisites -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). -// For more information, see Hibernate your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the -// Amazon EC2 User Guide. +// Indicates whether your instance is configured for hibernation. This parameter +// is valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites) +// . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) +// in the Amazon EC2 User Guide. type HibernationOptions struct { - // If this parameter is set to true, your instance is enabled for hibernation; + // If this parameter is set to true , your instance is enabled for hibernation; // otherwise, it is not enabled for hibernation. Configured *bool noSmithyDocumentSerde } -// Indicates whether your instance is configured for hibernation. This parameter is -// valid only if the instance meets the hibernation prerequisites -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). -// For more information, see Hibernate your instance -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the -// Amazon EC2 User Guide. +// Indicates whether your instance is configured for hibernation. This parameter +// is valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites) +// . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) +// in the Amazon EC2 User Guide. type HibernationOptionsRequest struct { - // If you set this parameter to true, your instance is enabled for hibernation. + // If you set this parameter to true , your instance is enabled for hibernation. // Default: false Configured *bool @@ -4759,17 +4593,11 @@ type HistoryRecord struct { EventInformation *EventInformation // The event type. - // - // * error - An error with the Spot Fleet request. - // - // * - // fleetRequestChange - A change in the status or configuration of the Spot Fleet - // request. - // - // * instanceChange - An instance was launched or terminated. - // - // * - // Information - An informational event. + // - error - An error with the Spot Fleet request. + // - fleetRequestChange - A change in the status or configuration of the Spot + // Fleet request. + // - instanceChange - An instance was launched or terminated. + // - Information - An informational event. EventType EventType // The date and time of the event, in UTC format (for example, @@ -4802,8 +4630,8 @@ type Host struct { AllocationTime *time.Time // Indicates whether the Dedicated Host supports multiple instance types of the - // same instance family. If the value is on, the Dedicated Host supports multiple - // instance types in the instance family. If the value is off, the Dedicated Host + // same instance family. If the value is on , the Dedicated Host supports multiple + // instance types in the instance family. If the value is off , the Dedicated Host // supports a single instance type only. AllowsMultipleInstanceTypes AllowsMultipleInstanceTypes @@ -4820,8 +4648,8 @@ type Host struct { AvailableCapacity *AvailableCapacity // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The ID of the Dedicated Host. @@ -4845,7 +4673,7 @@ type Host struct { Instances []HostInstance // Indicates whether the Dedicated Host is in a host resource group. If - // memberOfServiceLinkedResourceGroup is true, the host is in a host resource + // memberOfServiceLinkedResourceGroup is true , the host is in a host resource // group; otherwise, it is not. MemberOfServiceLinkedResourceGroup *bool @@ -4874,7 +4702,7 @@ type HostInstance struct { // The ID of instance that is running on the Dedicated Host. InstanceId *string - // The instance type (for example, m3.medium) of the running instance. + // The instance type (for example, m3.medium ) of the running instance. InstanceType *string // The ID of the Amazon Web Services account that owns the instance. @@ -4916,11 +4744,11 @@ type HostProperties struct { // The number of cores on the Dedicated Host. Cores *int32 - // The instance family supported by the Dedicated Host. For example, m5. + // The instance family supported by the Dedicated Host. For example, m5 . InstanceFamily *string - // The instance type supported by the Dedicated Host. For example, m5.large. If the - // host supports multiple instance types, no instanceType is returned. + // The instance type supported by the Dedicated Host. For example, m5.large . If + // the host supports multiple instance types, no instanceType is returned. InstanceType *string // The number of sockets on the Dedicated Host. @@ -4938,12 +4766,12 @@ type HostReservation struct { // The number of Dedicated Hosts the reservation is associated with. Count *int32 - // The currency in which the upfrontPrice and hourlyPrice amounts are specified. At - // this time, the only supported currency is USD. + // The currency in which the upfrontPrice and hourlyPrice amounts are specified. + // At this time, the only supported currency is USD . CurrencyCode CurrencyCodeValues // The length of the reservation's term, specified in seconds. Can be 31536000 (1 - // year) | 94608000 (3 years). + // year) | 94608000 (3 years) . Duration *int32 // The date and time that the reservation ends. @@ -5086,9 +4914,8 @@ type Image struct { // Any block device mapping entries. BlockDeviceMappings []BlockDeviceMapping - // The boot mode of the image. For more information, see Boot modes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the - // Amazon EC2 User Guide. + // The boot mode of the image. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) + // in the Amazon EC2 User Guide. BootMode BootModeValues // The date and time the image was created. @@ -5114,19 +4941,18 @@ type Image struct { // The location of the AMI. ImageLocation *string - // The Amazon Web Services account alias (for example, amazon, self) or the Amazon - // Web Services account ID of the AMI owner. + // The Amazon Web Services account alias (for example, amazon , self ) or the + // Amazon Web Services account ID of the AMI owner. ImageOwnerAlias *string // The type of image. ImageType ImageTypeValues - // If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched + // If v2.0 , it indicates that IMDSv2 is specified in the AMI. Instances launched // from this AMI will have HttpTokens automatically set to required so that, by // default, the instance requires that IMDSv2 is used when requesting instance - // metadata. In addition, HttpPutResponseHopLimit is set to 2. For more - // information, see Configure the AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) + // metadata. In addition, HttpPutResponseHopLimit is set to 2 . For more + // information, see Configure the AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) // in the Amazon EC2 User Guide. ImdsSupport ImdsSupportValues @@ -5144,9 +4970,8 @@ type Image struct { Platform PlatformValues // The platform details associated with the billing code of the AMI. For more - // information, see Understand AMI billing information - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) in - // the Amazon EC2 User Guide. + // information, see Understand AMI billing information (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) + // in the Amazon EC2 User Guide. PlatformDetails *string // Any product codes associated with the AMI. @@ -5161,18 +4986,18 @@ type Image struct { // images. RamdiskId *string - // The device name of the root device volume (for example, /dev/sda1). + // The device name of the root device volume (for example, /dev/sda1 ). RootDeviceName *string - // The type of root device used by the AMI. The AMI can use an Amazon EBS volume or - // an instance store volume. + // The type of root device used by the AMI. The AMI can use an Amazon EBS volume + // or an instance store volume. RootDeviceType DeviceType // Specifies whether enhanced networking with the Intel 82599 Virtual Function // interface is enabled. SriovNetSupport *string - // The current state of the AMI. If the state is available, the image is + // The current state of the AMI. If the state is available , the image is // successfully registered and can be used to launch an instance. State ImageState @@ -5182,23 +5007,18 @@ type Image struct { // Any tags assigned to the image. Tags []Tag - // If the image is configured for NitroTPM support, the value is v2.0. For more - // information, see NitroTPM - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the - // Amazon EC2 User Guide. + // If the image is configured for NitroTPM support, the value is v2.0 . For more + // information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) + // in the Amazon EC2 User Guide. TpmSupport TpmSupportValues - // The operation of the Amazon EC2 instance and the billing code that is associated - // with the AMI. usageOperation corresponds to the lineitem/Operation - // (https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation) + // The operation of the Amazon EC2 instance and the billing code that is + // associated with the AMI. usageOperation corresponds to the lineitem/Operation (https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation) // column on your Amazon Web Services Cost and Usage Report and in the Amazon Web - // Services Price List API - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html). - // You can view these fields on the Instances or AMIs pages in the Amazon EC2 - // console, or in the responses that are returned by the DescribeImages - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) - // command in the Amazon EC2 API, or the describe-images - // (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html) + // Services Price List API (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html) + // . You can view these fields on the Instances or AMIs pages in the Amazon EC2 + // console, or in the responses that are returned by the DescribeImages (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) + // command in the Amazon EC2 API, or the describe-images (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html) // command in the CLI. UsageOperation *string @@ -5301,8 +5121,8 @@ type ImportImageTask struct { // The identifier for the KMS key that was used to create the encrypted image. KmsKeyId *string - // The ARNs of the license configurations that are associated with the import image - // task. + // The ARNs of the license configurations that are associated with the import + // image task. LicenseSpecifications []ImportImageLicenseConfigurationResponse // The license type of the virtual machine. @@ -5352,8 +5172,7 @@ type ImportInstanceLaunchSpecification struct { InstanceInitiatedShutdownBehavior ShutdownBehavior // The instance type. For more information about the instance types that you can - // import, see Instance Types - // (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types) + // import, see Instance Types (https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types) // in the VM Import/Export User Guide. InstanceType InstanceType @@ -5496,13 +5315,12 @@ type Instance struct { // Any block device mapping entries for the instance. BlockDeviceMappings []InstanceBlockDeviceMapping - // The boot mode that was specified by the AMI. If the value is uefi-preferred, the - // AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is - // the boot mode that is used to boot the instance at launch or start. The - // operating system contained in the AMI must be configured to support the - // specified boot mode. For more information, see Boot modes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the - // Amazon EC2 User Guide. + // The boot mode that was specified by the AMI. If the value is uefi-preferred , + // the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode + // parameter is the boot mode that is used to boot the instance at launch or start. + // The operating system contained in the AMI must be configured to support the + // specified boot mode. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) + // in the Amazon EC2 User Guide. BootMode BootModeValues // The ID of the Capacity Reservation. @@ -5519,9 +5337,8 @@ type Instance struct { CpuOptions *CpuOptions // The boot mode that is used to boot the instance at launch or start. For more - // information, see Boot modes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the - // Amazon EC2 User Guide. + // information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) + // in the Amazon EC2 User Guide. CurrentInstanceBootMode InstanceBootModeValues // Indicates whether the instance is optimized for Amazon EBS I/O. This @@ -5604,8 +5421,7 @@ type Instance struct { Platform PlatformValues // The platform details value for the instance. For more information, see AMI - // billing information fields - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) + // billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) // in the Amazon EC2 User Guide. PlatformDetails *string @@ -5628,8 +5444,8 @@ type Instance struct { ProductCodes []ProductCode // (IPv4 only) The public DNS name assigned to the instance. This name is not - // available until the instance enters the running state. For EC2-VPC, this name is - // only available if you've enabled DNS hostnames for your VPC. + // available until the instance enters the running state. For EC2-VPC, this name + // is only available if you've enabled DNS hostnames for your VPC. PublicDnsName *string // The public IPv4 address, or the Carrier IP address assigned to the instance, if @@ -5640,7 +5456,7 @@ type Instance struct { // The RAM disk associated with this instance, if applicable. RamdiskId *string - // The device name of the root device volume (for example, /dev/sda1). + // The device name of the root device volume (for example, /dev/sda1 ). RootDeviceName *string // The root device type used by the AMI. The AMI can use an EBS volume or an @@ -5675,15 +5491,13 @@ type Instance struct { // Any tags assigned to the instance. Tags []Tag - // If the instance is configured for NitroTPM support, the value is v2.0. For more - // information, see NitroTPM - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the - // Amazon EC2 User Guide. + // If the instance is configured for NitroTPM support, the value is v2.0 . For more + // information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) + // in the Amazon EC2 User Guide. TpmSupport *string // The usage operation value for the instance. For more information, see AMI - // billing information fields - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) + // billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) // in the Amazon EC2 User Guide. UsageOperation *string @@ -5702,7 +5516,7 @@ type Instance struct { // Describes a block device mapping. type InstanceBlockDeviceMapping struct { - // The device name (for example, /dev/sdh or xvdh). + // The device name (for example, /dev/sdh or xvdh ). DeviceName *string // Parameters used to automatically set up EBS volumes when the instance is @@ -5715,7 +5529,7 @@ type InstanceBlockDeviceMapping struct { // Describes a block device mapping entry. type InstanceBlockDeviceMappingSpecification struct { - // The device name (for example, /dev/sdh or xvdh). + // The device name (for example, /dev/sdh or xvdh ). DeviceName *string // Parameters used to automatically set up EBS volumes when the instance is @@ -5752,7 +5566,7 @@ type InstanceCapacity struct { // Describes a Reserved Instance listing state. type InstanceCount struct { - // The number of listed Reserved Instances in the state specified by the state. + // The number of listed Reserved Instances in the state specified by the state . InstanceCount *int32 // The states of the listed Reserved Instances. @@ -5783,8 +5597,8 @@ type InstanceCreditSpecificationRequest struct { InstanceId *string // The credit option for CPU usage of the instance. Valid values: standard | - // unlimited T3 instances with host tenancy do not support the unlimited CPU credit - // option. + // unlimited T3 instances with host tenancy do not support the unlimited CPU + // credit option. CpuCredits *string noSmithyDocumentSerde @@ -5817,9 +5631,9 @@ type InstanceEventWindow struct { noSmithyDocumentSerde } -// One or more targets associated with the specified event window. Only one type of -// target (instance ID, instance tag, or Dedicated Host ID) can be associated with -// an event window. +// One or more targets associated with the specified event window. Only one type +// of target (instance ID, instance tag, or Dedicated Host ID) can be associated +// with an event window. type InstanceEventWindowAssociationRequest struct { // The IDs of the Dedicated Hosts to associate with the event window. @@ -5933,8 +5747,8 @@ type InstanceExportDetails struct { // instance family. type InstanceFamilyCreditSpecification struct { - // The default credit option for CPU usage of the instance family. Valid values are - // standard and unlimited. + // The default credit option for CPU usage of the instance family. Valid values + // are standard and unlimited . CpuCredits *string // The instance family. @@ -5992,9 +5806,9 @@ type InstanceMaintenanceOptions struct { // The maintenance options for the instance. type InstanceMaintenanceOptionsRequest struct { - // Disables the automatic recovery behavior of your instance or sets it to default. - // For more information, see Simplified automatic recovery - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery). + // Disables the automatic recovery behavior of your instance or sets it to + // default. For more information, see Simplified automatic recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery) + // . AutoRecovery InstanceAutoRecoveryState noSmithyDocumentSerde @@ -6015,8 +5829,9 @@ type InstanceMarketOptionsRequest struct { // The metadata options for the instance. type InstanceMetadataOptionsRequest struct { - // Enables or disables the HTTP metadata endpoint on your instances. If you specify - // a value of disabled, you cannot access your instance metadata. Default: enabled + // Enables or disables the HTTP metadata endpoint on your instances. If you + // specify a value of disabled , you cannot access your instance metadata. Default: + // enabled HttpEndpoint InstanceMetadataEndpointState // Enables or disables the IPv6 endpoint for the instance metadata service. @@ -6028,29 +5843,24 @@ type InstanceMetadataOptionsRequest struct { HttpPutResponseHopLimit *int32 // IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in - // other words, set the use of IMDSv2 to optional) or required (in other words, set - // the use of IMDSv2 to required). - // - // * optional - When IMDSv2 is optional, you can - // choose to retrieve instance metadata with or without a session token in your - // request. If you retrieve the IAM role credentials without a token, the IMDSv1 - // role credentials are returned. If you retrieve the IAM role credentials using a - // valid session token, the IMDSv2 role credentials are returned. - // - // * required - - // When IMDSv2 is required, you must send a session token with any instance - // metadata retrieval requests. In this state, retrieving the IAM role credentials - // always returns IMDSv2 credentials; IMDSv1 credentials are not - // available. - // + // other words, set the use of IMDSv2 to optional ) or required (in other words, + // set the use of IMDSv2 to required ). + // - optional - When IMDSv2 is optional, you can choose to retrieve instance + // metadata with or without a session token in your request. If you retrieve the + // IAM role credentials without a token, the IMDSv1 role credentials are returned. + // If you retrieve the IAM role credentials using a valid session token, the IMDSv2 + // role credentials are returned. + // - required - When IMDSv2 is required, you must send a session token with any + // instance metadata retrieval requests. In this state, retrieving the IAM role + // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not + // available. // Default: optional HttpTokens HttpTokensState // Set to enabled to allow access to instance tags from the instance metadata. Set // to disabled to turn off access to instance tags from the instance metadata. For - // more information, see Work with instance tags using the instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). - // Default: disabled + // more information, see Work with instance tags using the instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // . Default: disabled InstanceMetadataTags InstanceMetadataTagsState noSmithyDocumentSerde @@ -6060,11 +5870,11 @@ type InstanceMetadataOptionsRequest struct { type InstanceMetadataOptionsResponse struct { // Indicates whether the HTTP metadata endpoint on your instances is enabled or - // disabled. If the value is disabled, you cannot access your instance metadata. + // disabled. If the value is disabled , you cannot access your instance metadata. HttpEndpoint InstanceMetadataEndpointState - // Indicates whether the IPv6 endpoint for the instance metadata service is enabled - // or disabled. + // Indicates whether the IPv6 endpoint for the instance metadata service is + // enabled or disabled. HttpProtocolIpv6 InstanceMetadataProtocolState // The desired HTTP PUT response hop limit for instance metadata requests. The @@ -6073,28 +5883,24 @@ type InstanceMetadataOptionsResponse struct { HttpPutResponseHopLimit *int32 // IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is - // optional (in other words, indicates whether the use of IMDSv2 is optional) or - // required (in other words, indicates whether the use of IMDSv2 is required). - // - // * - // optional - When IMDSv2 is optional, you can choose to retrieve instance metadata - // with or without a session token in your request. If you retrieve the IAM role - // credentials without a token, the IMDSv1 role credentials are returned. If you - // retrieve the IAM role credentials using a valid session token, the IMDSv2 role - // credentials are returned. - // - // * required - When IMDSv2 is required, you must send a - // session token with any instance metadata retrieval requests. In this state, - // retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 - // credentials are not available. - // + // optional (in other words, indicates whether the use of IMDSv2 is optional ) or + // required (in other words, indicates whether the use of IMDSv2 is required ). + // - optional - When IMDSv2 is optional, you can choose to retrieve instance + // metadata with or without a session token in your request. If you retrieve the + // IAM role credentials without a token, the IMDSv1 role credentials are returned. + // If you retrieve the IAM role credentials using a valid session token, the IMDSv2 + // role credentials are returned. + // - required - When IMDSv2 is required, you must send a session token with any + // instance metadata retrieval requests. In this state, retrieving the IAM role + // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not + // available. // Default: optional HttpTokens HttpTokensState // Indicates whether access to instance tags from the instance metadata is enabled // or disabled. For more information, see Work with instance tags using the - // instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). + // instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // . InstanceMetadataTags InstanceMetadataTagsState // The state of the metadata option changes. pending - The metadata options are @@ -6231,19 +6037,18 @@ type InstanceNetworkInterfaceSpecification struct { // Indicates whether to assign a carrier IP address to the network interface. You // can only assign a carrier IP address to a network interface that is in a subnet // in a Wavelength Zone. For more information about carrier IP addresses, see - // Carrier IP address - // (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) + // Carrier IP address (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) // in the Amazon Web Services Wavelength Developer Guide. AssociateCarrierIpAddress *bool - // Indicates whether to assign a public IPv4 address to an instance you launch in a - // VPC. The public IP address can only be assigned to a network interface for eth0, - // and can only be assigned to a new network interface, not an existing one. You - // cannot specify more than one network interface in the request. If launching into - // a default subnet, the default value is true. + // Indicates whether to assign a public IPv4 address to an instance you launch in + // a VPC. The public IP address can only be assigned to a network interface for + // eth0, and can only be assigned to a new network interface, not an existing one. + // You cannot specify more than one network interface in the request. If launching + // into a default subnet, the default value is true . AssociatePublicIpAddress *bool - // If set to true, the interface is deleted when the instance is terminated. You + // If set to true , the interface is deleted when the instance is terminated. You // can specify true only if creating a new network interface when launching an // instance. DeleteOnTermination *bool @@ -6252,9 +6057,9 @@ type InstanceNetworkInterfaceSpecification struct { // interface when launching an instance. Description *string - // The position of the network interface in the attachment order. A primary network - // interface has a device index of 0. If you specify a network interface when - // launching an instance, you must specify the device index. + // The position of the network interface in the attachment order. A primary + // network interface has a device index of 0. If you specify a network interface + // when launching an instance, you must specify the device index. DeviceIndex *int32 // The IDs of the security groups for the network interface. Applies only if @@ -6295,12 +6100,11 @@ type InstanceNetworkInterfaceSpecification struct { // The index of the network card. Some instance types support multiple network // cards. The primary network interface must be assigned to network card index 0. - // The default is network card index 0. If you are using RequestSpotInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) + // The default is network card index 0. If you are using RequestSpotInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) // to create Spot Instances, omit this parameter because you can’t specify the // network card index when using this API. To specify the network card index, use - // RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html). + // RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // . NetworkCardIndex *int32 // The ID of the network interface. If you are creating a Spot Fleet, omit this @@ -6310,23 +6114,20 @@ type InstanceNetworkInterfaceSpecification struct { // The private IPv4 address of the network interface. Applies only if creating a // network interface when launching an instance. You cannot specify this option if - // you're launching more than one instance in a RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // you're launching more than one instance in a RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) // request. PrivateIpAddress *string // The private IPv4 addresses to assign to the network interface. Only one private // IPv4 address can be designated as primary. You cannot specify this option if - // you're launching more than one instance in a RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // you're launching more than one instance in a RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) // request. PrivateIpAddresses []PrivateIpAddressSpecification // The number of secondary private IPv4 addresses. You can't specify this option // and specify more than one private IP address using the private IP addresses // option. You cannot specify this option if you're launching more than one - // instance in a RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) + // instance in a RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) // request. SecondaryPrivateIpAddressCount *int32 @@ -6363,77 +6164,45 @@ type InstancePrivateIpAddress struct { // types that satisfy any of the specified values. To limit the list of instance // types from which Amazon EC2 can identify matching instance types, you can use // one of the following parameters, but not both in the same request: +// - AllowedInstanceTypes - The instance types to include in the list. All other +// instance types are ignored, even if they match your specified attributes. +// - ExcludedInstanceTypes - The instance types to exclude from the list, even if +// they match your specified attributes. // -// * -// AllowedInstanceTypes - The instance types to include in the list. All other -// instance types are ignored, even if they match your specified attributes. -// -// * -// ExcludedInstanceTypes - The instance types to exclude from the list, even if -// they match your specified attributes. -// -// You must specify VCpuCount and MemoryMiB. -// All other attributes are optional. Any unspecified optional attribute is set to -// its default. For more information, see Attribute-based instance type selection -// for EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), -// Attribute-based instance type selection for Spot Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), -// and Spot placement score -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) +// You must specify VCpuCount and MemoryMiB . All other attributes are optional. +// Any unspecified optional attribute is set to its default. For more information, +// see Attribute-based instance type selection for EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) +// , Attribute-based instance type selection for Spot Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) +// , and Spot placement score (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) // in the Amazon EC2 User Guide. type InstanceRequirements struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web // Services Inferentia chips) on an instance. To exclude accelerator-enabled - // instance types, set Max to 0. Default: No minimum or maximum limits + // instance types, set Max to 0 . Default: No minimum or maximum limits AcceleratorCount *AcceleratorCount // Indicates whether instance types must have accelerators by specific // manufacturers. - // - // * For instance types with NVIDIA devices, specify nvidia. - // - // * For - // instance types with AMD devices, specify amd. - // - // * For instance types with Amazon - // Web Services devices, specify amazon-web-services. - // - // * For instance types with - // Xilinx devices, specify xilinx. - // + // - For instance types with NVIDIA devices, specify nvidia . + // - For instance types with AMD devices, specify amd . + // - For instance types with Amazon Web Services devices, specify + // amazon-web-services . + // - For instance types with Xilinx devices, specify xilinx . // Default: Any manufacturer AcceleratorManufacturers []AcceleratorManufacturer // The accelerators that must be on the instance type. - // - // * For instance types with - // NVIDIA A100 GPUs, specify a100. - // - // * For instance types with NVIDIA V100 GPUs, - // specify v100. - // - // * For instance types with NVIDIA K80 GPUs, specify k80. - // - // * For - // instance types with NVIDIA T4 GPUs, specify t4. - // - // * For instance types with - // NVIDIA M60 GPUs, specify m60. - // - // * For instance types with AMD Radeon Pro V520 - // GPUs, specify radeon-pro-v520. - // - // * For instance types with Xilinx VU9P FPGAs, - // specify vu9p. - // - // * For instance types with Amazon Web Services Inferentia chips, - // specify inferentia. - // - // * For instance types with NVIDIA GRID K520 GPUs, specify - // k520. - // + // - For instance types with NVIDIA A100 GPUs, specify a100 . + // - For instance types with NVIDIA V100 GPUs, specify v100 . + // - For instance types with NVIDIA K80 GPUs, specify k80 . + // - For instance types with NVIDIA T4 GPUs, specify t4 . + // - For instance types with NVIDIA M60 GPUs, specify m60 . + // - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . + // - For instance types with Xilinx VU9P FPGAs, specify vu9p . + // - For instance types with Amazon Web Services Inferentia chips, specify + // inferentia . + // - For instance types with NVIDIA GRID K520 GPUs, specify k520 . // Default: Any accelerator AcceleratorNames []AcceleratorName @@ -6442,127 +6211,88 @@ type InstanceRequirements struct { AcceleratorTotalMemoryMiB *AcceleratorTotalMemoryMiB // The accelerator types that must be on the instance type. - // - // * For instance types - // with GPU accelerators, specify gpu. - // - // * For instance types with FPGA - // accelerators, specify fpga. - // - // * For instance types with inference accelerators, - // specify inference. - // + // - For instance types with GPU accelerators, specify gpu . + // - For instance types with FPGA accelerators, specify fpga . + // - For instance types with inference accelerators, specify inference . // Default: Any accelerator type AcceleratorTypes []AcceleratorType // The instance types to apply your specified attributes against. All other // instance types are ignored, even if they match your specified attributes. You - // can use strings with one or more wild cards, represented by an asterisk (*), to - // allow an instance type, size, or generation. The following are examples: - // m5.8xlarge, c5*.*, m5a.*, r*, *3*. For example, if you specify c5*,Amazon EC2 - // will allow the entire C5 instance family, which includes all C5a and C5n - // instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance - // types, but not the M5n instance types. If you specify AllowedInstanceTypes, you - // can't specify ExcludedInstanceTypes. Default: All instance types + // can use strings with one or more wild cards, represented by an asterisk ( * ), + // to allow an instance type, size, or generation. The following are examples: + // m5.8xlarge , c5*.* , m5a.* , r* , *3* . For example, if you specify c5* ,Amazon + // EC2 will allow the entire C5 instance family, which includes all C5a and C5n + // instance types. If you specify m5a.* , Amazon EC2 will allow all the M5a + // instance types, but not the M5n instance types. If you specify + // AllowedInstanceTypes , you can't specify ExcludedInstanceTypes . Default: All + // instance types AllowedInstanceTypes []string // Indicates whether bare metal instance types must be included, excluded, or // required. - // - // * To include bare metal instance types, specify included. - // - // * To - // require only bare metal instance types, specify required. - // - // * To exclude bare - // metal instance types, specify excluded. - // + // - To include bare metal instance types, specify included . + // - To require only bare metal instance types, specify required . + // - To exclude bare metal instance types, specify excluded . // Default: excluded BareMetal BareMetal // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more - // information, see Amazon EBS–optimized instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the - // Amazon EC2 User Guide. Default: No minimum or maximum limits + // information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) + // in the Amazon EC2 User Guide. Default: No minimum or maximum limits BaselineEbsBandwidthMbps *BaselineEbsBandwidthMbps - // Indicates whether burstable performance T instance types are included, excluded, - // or required. For more information, see Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). - // - // * - // To include burstable performance instance types, specify included. - // - // * To require - // only burstable performance instance types, specify required. - // - // * To exclude - // burstable performance instance types, specify excluded. - // + // Indicates whether burstable performance T instance types are included, + // excluded, or required. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // . + // - To include burstable performance instance types, specify included . + // - To require only burstable performance instance types, specify required . + // - To exclude burstable performance instance types, specify excluded . // Default: excluded BurstablePerformance BurstablePerformance // The CPU manufacturers to include. - // - // * For instance types with Intel CPUs, specify - // intel. - // - // * For instance types with AMD CPUs, specify amd. - // - // * For instance types - // with Amazon Web Services CPUs, specify amazon-web-services. - // - // Don't confuse the - // CPU manufacturer with the CPU architecture. Instances will be launched with a - // compatible CPU architecture based on the Amazon Machine Image (AMI) that you - // specify in your launch template. Default: Any manufacturer + // - For instance types with Intel CPUs, specify intel . + // - For instance types with AMD CPUs, specify amd . + // - For instance types with Amazon Web Services CPUs, specify + // amazon-web-services . + // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be + // launched with a compatible CPU architecture based on the Amazon Machine Image + // (AMI) that you specify in your launch template. Default: Any manufacturer CpuManufacturers []CpuManufacturer // The instance types to exclude. You can use strings with one or more wild cards, - // represented by an asterisk (*), to exclude an instance type, size, or - // generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*. For - // example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance - // family, which includes all C5a and C5n instance types. If you specify m5a.*, + // represented by an asterisk ( * ), to exclude an instance type, size, or + // generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* . + // For example, if you specify c5* ,Amazon EC2 will exclude the entire C5 instance + // family, which includes all C5a and C5n instance types. If you specify m5a.* , // Amazon EC2 will exclude all the M5a instance types, but not the M5n instance - // types. If you specify ExcludedInstanceTypes, you can't specify - // AllowedInstanceTypes. Default: No excluded instance types + // types. If you specify ExcludedInstanceTypes , you can't specify + // AllowedInstanceTypes . Default: No excluded instance types ExcludedInstanceTypes []string // Indicates whether current or previous generation instance types are included. // The current generation instance types are recommended for use. Current // generation instance types are typically the latest two to three generations in - // each instance family. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. For current generation instance types, specify current. - // For previous generation instance types, specify previous. Default: Current and - // previous generation instance types + // each instance family. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. For current generation instance types, specify + // current . For previous generation instance types, specify previous . Default: + // Current and previous generation instance types InstanceGenerations []InstanceGeneration // Indicates whether instance types with instance store volumes are included, - // excluded, or required. For more information, Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide. - // - // * To include instance types with instance store - // volumes, specify included. - // - // * To require only instance types with instance store - // volumes, specify required. - // - // * To exclude instance types with instance store - // volumes, specify excluded. - // + // excluded, or required. For more information, Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide. + // - To include instance types with instance store volumes, specify included . + // - To require only instance types with instance store volumes, specify required + // . + // - To exclude instance types with instance store volumes, specify excluded . // Default: included LocalStorage LocalStorage // The type of local storage that is required. - // - // * For instance types with hard disk - // drive (HDD) storage, specify hdd. - // - // * For instance types with solid state drive - // (SSD) storage, specify ssd. - // + // - For instance types with hard disk drive (HDD) storage, specify hdd . + // - For instance types with solid state drive (SSD) storage, specify ssd . // Default: hdd and ssd LocalStorageTypes []LocalStorageType @@ -6587,20 +6317,17 @@ type InstanceRequirements struct { // attributes. When Amazon EC2 selects instance types with your attributes, it // excludes instance types priced above your threshold. The parameter accepts an // integer, which Amazon EC2 interprets as a percentage. To turn off price - // protection, specify a high value, such as 999999. This parameter is not - // supported for GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) - // and GetInstanceTypesFromInstanceRequirements - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). - // If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection + // protection, specify a high value, such as 999999 . This parameter is not + // supported for GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // and GetInstanceTypesFromInstanceRequirements (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) + // . If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection // threshold is applied based on the per-vCPU or per-memory price instead of the // per-instance price. Default: 20 OnDemandMaxPricePercentageOverLowestPrice *int32 // Indicates whether instance types must support hibernation for On-Demand - // Instances. This parameter is not supported for GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html). - // Default: false + // Instances. This parameter is not supported for GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // . Default: false RequireHibernateSupport *bool // The price protection threshold for Spot Instances. This is the maximum you’ll @@ -6609,12 +6336,10 @@ type InstanceRequirements struct { // Amazon EC2 selects instance types with your attributes, it excludes instance // types priced above your threshold. The parameter accepts an integer, which // Amazon EC2 interprets as a percentage. To turn off price protection, specify a - // high value, such as 999999. This parameter is not supported for - // GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) - // and GetInstanceTypesFromInstanceRequirements - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). - // If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection + // high value, such as 999999 . This parameter is not supported for + // GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // and GetInstanceTypesFromInstanceRequirements (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) + // . If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection // threshold is applied based on the per-vCPU or per-memory price instead of the // per-instance price. Default: 100 SpotMaxPricePercentageOverLowestPrice *int32 @@ -6636,24 +6361,16 @@ type InstanceRequirements struct { // types that satisfy any of the specified values. To limit the list of instance // types from which Amazon EC2 can identify matching instance types, you can use // one of the following parameters, but not both in the same request: +// - AllowedInstanceTypes - The instance types to include in the list. All other +// instance types are ignored, even if they match your specified attributes. +// - ExcludedInstanceTypes - The instance types to exclude from the list, even if +// they match your specified attributes. // -// * -// AllowedInstanceTypes - The instance types to include in the list. All other -// instance types are ignored, even if they match your specified attributes. -// -// * -// ExcludedInstanceTypes - The instance types to exclude from the list, even if -// they match your specified attributes. -// -// You must specify VCpuCount and MemoryMiB. -// All other attributes are optional. Any unspecified optional attribute is set to -// its default. For more information, see Attribute-based instance type selection -// for EC2 Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), -// Attribute-based instance type selection for Spot Fleet -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), -// and Spot placement score -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) +// You must specify VCpuCount and MemoryMiB . All other attributes are optional. +// Any unspecified optional attribute is set to its default. For more information, +// see Attribute-based instance type selection for EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) +// , Attribute-based instance type selection for Spot Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html) +// , and Spot placement score (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) // in the Amazon EC2 User Guide. type InstanceRequirementsRequest struct { @@ -6669,54 +6386,30 @@ type InstanceRequirementsRequest struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web // Services Inferentia chips) on an instance. To exclude accelerator-enabled - // instance types, set Max to 0. Default: No minimum or maximum limits + // instance types, set Max to 0 . Default: No minimum or maximum limits AcceleratorCount *AcceleratorCountRequest // Indicates whether instance types must have accelerators by specific // manufacturers. - // - // * For instance types with NVIDIA devices, specify nvidia. - // - // * For - // instance types with AMD devices, specify amd. - // - // * For instance types with Amazon - // Web Services devices, specify amazon-web-services. - // - // * For instance types with - // Xilinx devices, specify xilinx. - // + // - For instance types with NVIDIA devices, specify nvidia . + // - For instance types with AMD devices, specify amd . + // - For instance types with Amazon Web Services devices, specify + // amazon-web-services . + // - For instance types with Xilinx devices, specify xilinx . // Default: Any manufacturer AcceleratorManufacturers []AcceleratorManufacturer // The accelerators that must be on the instance type. - // - // * For instance types with - // NVIDIA A100 GPUs, specify a100. - // - // * For instance types with NVIDIA V100 GPUs, - // specify v100. - // - // * For instance types with NVIDIA K80 GPUs, specify k80. - // - // * For - // instance types with NVIDIA T4 GPUs, specify t4. - // - // * For instance types with - // NVIDIA M60 GPUs, specify m60. - // - // * For instance types with AMD Radeon Pro V520 - // GPUs, specify radeon-pro-v520. - // - // * For instance types with Xilinx VU9P FPGAs, - // specify vu9p. - // - // * For instance types with Amazon Web Services Inferentia chips, - // specify inferentia. - // - // * For instance types with NVIDIA GRID K520 GPUs, specify - // k520. - // + // - For instance types with NVIDIA A100 GPUs, specify a100 . + // - For instance types with NVIDIA V100 GPUs, specify v100 . + // - For instance types with NVIDIA K80 GPUs, specify k80 . + // - For instance types with NVIDIA T4 GPUs, specify t4 . + // - For instance types with NVIDIA M60 GPUs, specify m60 . + // - For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520 . + // - For instance types with Xilinx VU9P FPGAs, specify vu9p . + // - For instance types with Amazon Web Services Inferentia chips, specify + // inferentia . + // - For instance types with NVIDIA GRID K520 GPUs, specify k520 . // Default: Any accelerator AcceleratorNames []AcceleratorName @@ -6725,127 +6418,88 @@ type InstanceRequirementsRequest struct { AcceleratorTotalMemoryMiB *AcceleratorTotalMemoryMiBRequest // The accelerator types that must be on the instance type. - // - // * To include instance - // types with GPU hardware, specify gpu. - // - // * To include instance types with FPGA - // hardware, specify fpga. - // - // * To include instance types with inference hardware, - // specify inference. - // + // - To include instance types with GPU hardware, specify gpu . + // - To include instance types with FPGA hardware, specify fpga . + // - To include instance types with inference hardware, specify inference . // Default: Any accelerator type AcceleratorTypes []AcceleratorType // The instance types to apply your specified attributes against. All other // instance types are ignored, even if they match your specified attributes. You - // can use strings with one or more wild cards, represented by an asterisk (*), to - // allow an instance type, size, or generation. The following are examples: - // m5.8xlarge, c5*.*, m5a.*, r*, *3*. For example, if you specify c5*,Amazon EC2 - // will allow the entire C5 instance family, which includes all C5a and C5n - // instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance - // types, but not the M5n instance types. If you specify AllowedInstanceTypes, you - // can't specify ExcludedInstanceTypes. Default: All instance types + // can use strings with one or more wild cards, represented by an asterisk ( * ), + // to allow an instance type, size, or generation. The following are examples: + // m5.8xlarge , c5*.* , m5a.* , r* , *3* . For example, if you specify c5* ,Amazon + // EC2 will allow the entire C5 instance family, which includes all C5a and C5n + // instance types. If you specify m5a.* , Amazon EC2 will allow all the M5a + // instance types, but not the M5n instance types. If you specify + // AllowedInstanceTypes , you can't specify ExcludedInstanceTypes . Default: All + // instance types AllowedInstanceTypes []string // Indicates whether bare metal instance types must be included, excluded, or // required. - // - // * To include bare metal instance types, specify included. - // - // * To - // require only bare metal instance types, specify required. - // - // * To exclude bare - // metal instance types, specify excluded. - // + // - To include bare metal instance types, specify included . + // - To require only bare metal instance types, specify required . + // - To exclude bare metal instance types, specify excluded . // Default: excluded BareMetal BareMetal // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more - // information, see Amazon EBS–optimized instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the - // Amazon EC2 User Guide. Default: No minimum or maximum limits + // information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) + // in the Amazon EC2 User Guide. Default: No minimum or maximum limits BaselineEbsBandwidthMbps *BaselineEbsBandwidthMbpsRequest - // Indicates whether burstable performance T instance types are included, excluded, - // or required. For more information, see Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). - // - // * - // To include burstable performance instance types, specify included. - // - // * To require - // only burstable performance instance types, specify required. - // - // * To exclude - // burstable performance instance types, specify excluded. - // + // Indicates whether burstable performance T instance types are included, + // excluded, or required. For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // . + // - To include burstable performance instance types, specify included . + // - To require only burstable performance instance types, specify required . + // - To exclude burstable performance instance types, specify excluded . // Default: excluded BurstablePerformance BurstablePerformance // The CPU manufacturers to include. - // - // * For instance types with Intel CPUs, specify - // intel. - // - // * For instance types with AMD CPUs, specify amd. - // - // * For instance types - // with Amazon Web Services CPUs, specify amazon-web-services. - // - // Don't confuse the - // CPU manufacturer with the CPU architecture. Instances will be launched with a - // compatible CPU architecture based on the Amazon Machine Image (AMI) that you - // specify in your launch template. Default: Any manufacturer + // - For instance types with Intel CPUs, specify intel . + // - For instance types with AMD CPUs, specify amd . + // - For instance types with Amazon Web Services CPUs, specify + // amazon-web-services . + // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be + // launched with a compatible CPU architecture based on the Amazon Machine Image + // (AMI) that you specify in your launch template. Default: Any manufacturer CpuManufacturers []CpuManufacturer // The instance types to exclude. You can use strings with one or more wild cards, - // represented by an asterisk (*), to exclude an instance family, type, size, or - // generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*. For - // example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance - // family, which includes all C5a and C5n instance types. If you specify m5a.*, + // represented by an asterisk ( * ), to exclude an instance family, type, size, or + // generation. The following are examples: m5.8xlarge , c5*.* , m5a.* , r* , *3* . + // For example, if you specify c5* ,Amazon EC2 will exclude the entire C5 instance + // family, which includes all C5a and C5n instance types. If you specify m5a.* , // Amazon EC2 will exclude all the M5a instance types, but not the M5n instance - // types. If you specify ExcludedInstanceTypes, you can't specify - // AllowedInstanceTypes. Default: No excluded instance types + // types. If you specify ExcludedInstanceTypes , you can't specify + // AllowedInstanceTypes . Default: No excluded instance types ExcludedInstanceTypes []string // Indicates whether current or previous generation instance types are included. // The current generation instance types are recommended for use. Current // generation instance types are typically the latest two to three generations in - // each instance family. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. For current generation instance types, specify current. - // For previous generation instance types, specify previous. Default: Current and - // previous generation instance types + // each instance family. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. For current generation instance types, specify + // current . For previous generation instance types, specify previous . Default: + // Current and previous generation instance types InstanceGenerations []InstanceGeneration // Indicates whether instance types with instance store volumes are included, - // excluded, or required. For more information, Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide. - // - // * To include instance types with instance store - // volumes, specify included. - // - // * To require only instance types with instance store - // volumes, specify required. - // - // * To exclude instance types with instance store - // volumes, specify excluded. - // + // excluded, or required. For more information, Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide. + // - To include instance types with instance store volumes, specify included . + // - To require only instance types with instance store volumes, specify required + // . + // - To exclude instance types with instance store volumes, specify excluded . // Default: included LocalStorage LocalStorage // The type of local storage that is required. - // - // * For instance types with hard disk - // drive (HDD) storage, specify hdd. - // - // * For instance types with solid state drive - // (SSD) storage, specify ssd. - // + // - For instance types with hard disk drive (HDD) storage, specify hdd . + // - For instance types with solid state drive (SSD) storage, specify ssd . // Default: hdd and ssd LocalStorageTypes []LocalStorageType @@ -6867,34 +6521,29 @@ type InstanceRequirementsRequest struct { // attributes. When Amazon EC2 selects instance types with your attributes, it // excludes instance types priced above your threshold. The parameter accepts an // integer, which Amazon EC2 interprets as a percentage. To turn off price - // protection, specify a high value, such as 999999. This parameter is not - // supported for GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) - // and GetInstanceTypesFromInstanceRequirements - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). - // If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection + // protection, specify a high value, such as 999999 . This parameter is not + // supported for GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // and GetInstanceTypesFromInstanceRequirements (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) + // . If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection // threshold is applied based on the per-vCPU or per-memory price instead of the // per-instance price. Default: 20 OnDemandMaxPricePercentageOverLowestPrice *int32 // Indicates whether instance types must support hibernation for On-Demand - // Instances. This parameter is not supported for GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html). - // Default: false + // Instances. This parameter is not supported for GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // . Default: false RequireHibernateSupport *bool - // The price protection threshold for Spot Instance. This is the maximum you’ll pay - // for an Spot Instance, expressed as a percentage above the least expensive + // The price protection threshold for Spot Instance. This is the maximum you’ll + // pay for an Spot Instance, expressed as a percentage above the least expensive // current generation M, C, or R instance type with your specified attributes. When // Amazon EC2 selects instance types with your attributes, it excludes instance // types priced above your threshold. The parameter accepts an integer, which // Amazon EC2 interprets as a percentage. To turn off price protection, specify a - // high value, such as 999999. This parameter is not supported for - // GetSpotPlacementScores - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) - // and GetInstanceTypesFromInstanceRequirements - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html). - // If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection + // high value, such as 999999 . This parameter is not supported for + // GetSpotPlacementScores (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) + // and GetInstanceTypesFromInstanceRequirements (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) + // . If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection // threshold is applied based on the per-vCPU or per-memory price instead of the // per-instance price. Default: 100 SpotMaxPricePercentageOverLowestPrice *int32 @@ -6909,7 +6558,7 @@ type InstanceRequirementsRequest struct { // The architecture type, virtualization type, and other attributes for the // instance types. When you specify instance attributes, Amazon EC2 will identify // instance types with those attributes. If you specify -// InstanceRequirementsWithMetadataRequest, you can't specify InstanceTypes. +// InstanceRequirementsWithMetadataRequest , you can't specify InstanceTypes . type InstanceRequirementsWithMetadataRequest struct { // The architecture type. @@ -6936,10 +6585,10 @@ type InstanceSpecification struct { // Excludes the root volume from being snapshotted. ExcludeBootVolume *bool - // The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot - // set. If you specify the ID of the root volume, the request fails. To exclude the - // root volume, use ExcludeBootVolume. You can specify up to 40 volume IDs per - // request. + // The IDs of the data (non-root) volumes to exclude from the multi-volume + // snapshot set. If you specify the ID of the root volume, the request fails. To + // exclude the root volume, use ExcludeBootVolume. You can specify up to 40 volume + // IDs per request. ExcludeDataVolumeIds []string noSmithyDocumentSerde @@ -6954,23 +6603,14 @@ type InstanceState struct { // ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals // decimal values between 0 and 255. The valid values for instance-state-code will // all be in the range of the low byte and they are: - // - // * 0 : pending - // - // * 16 : - // running - // - // * 32 : shutting-down - // - // * 48 : terminated - // - // * 64 : stopping - // - // * 80 : - // stopped - // - // You can ignore the high byte value by zeroing out all of the bits above - // 2^8 or 256 in decimal. + // - 0 : pending + // - 16 : running + // - 32 : shutting-down + // - 48 : terminated + // - 64 : stopping + // - 80 : stopped + // You can ignore the high byte value by zeroing out all of the bits above 2^8 or + // 256 in decimal. Code *int32 // The current state of the instance. @@ -7156,9 +6796,8 @@ type InstanceTypeInfo struct { // Indicates whether instance storage is supported. InstanceStorageSupported *bool - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. InstanceType InstanceType // Describes the memory for the instance type. @@ -7173,9 +6812,8 @@ type InstanceTypeInfo struct { // Describes the processor. ProcessorInfo *ProcessorInfo - // The supported boot modes. For more information, see Boot modes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the - // Amazon EC2 User Guide. + // The supported boot modes. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) + // in the Amazon EC2 User Guide. SupportedBootModes []BootModeType // The supported root device types. @@ -7205,14 +6843,13 @@ type InstanceTypeInfoFromInstanceRequirements struct { // The instance types offered. type InstanceTypeOffering struct { - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. InstanceType InstanceType - // The identifier for the location. This depends on the location type. For example, - // if the location type is region, the location is the Region code (for example, - // us-east-2.) + // The identifier for the location. This depends on the location type. For + // example, if the location type is region , the location is the Region code (for + // example, us-east-2 .) Location *string // The location type. @@ -7279,9 +6916,8 @@ type InternetGatewayAttachment struct { // IPAM is a VPC feature that you can use to automate your IP address management // workflows including assigning, tracking, troubleshooting, and auditing IP // addresses across Amazon Web Services Regions and accounts throughout your Amazon -// Web Services Organization. For more information, see What is IPAM? -// (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the Amazon -// VPC IPAM User Guide. +// Web Services Organization. For more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) +// in the Amazon VPC IPAM User Guide. type Ipam struct { // The IPAM's default resource discovery association ID. @@ -7323,9 +6959,8 @@ type Ipam struct { ResourceDiscoveryAssociationCount *int32 // The number of scopes in the IPAM. The scope quota is 5. For more information on - // quotas, see Quotas in IPAM - // (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the Amazon VPC - // IPAM User Guide. + // quotas, see Quotas in IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) + // in the Amazon VPC IPAM User Guide. ScopeCount *int32 // The state of the IPAM. @@ -7333,7 +6968,7 @@ type Ipam struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. Tags []Tag @@ -7341,17 +6976,15 @@ type Ipam struct { } // The historical record of a CIDR within an IPAM scope. For more information, see -// View the history of IP addresses -// (https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) in the -// Amazon VPC IPAM User Guide. +// View the history of IP addresses (https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) +// in the Amazon VPC IPAM User Guide. type IpamAddressHistoryRecord struct { // The CIDR of the resource. ResourceCidr *string // The compliance status of a resource. For more information on compliance - // statuses, see Monitor CIDR usage by resource - // (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // statuses, see Monitor CIDR usage by resource (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) // in the Amazon VPC IPAM User Guide. ResourceComplianceStatus IpamComplianceStatus @@ -7361,10 +6994,9 @@ type IpamAddressHistoryRecord struct { // The name of the resource. ResourceName *string - // The overlap status of an IPAM resource. The overlap status tells you if the CIDR - // for a resource overlaps with another CIDR in the scope. For more information on - // overlap statuses, see Monitor CIDR usage by resource - // (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // The overlap status of an IPAM resource. The overlap status tells you if the + // CIDR for a resource overlaps with another CIDR in the scope. For more + // information on overlap statuses, see Monitor CIDR usage by resource (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) // in the Amazon VPC IPAM User Guide. ResourceOverlapStatus IpamOverlapStatus @@ -7415,8 +7047,8 @@ type IpamDiscoveredAccount struct { // The account ID. AccountId *string - // The Amazon Web Services Region that the account information is returned from. An - // account can be discovered in multiple regions and will have a separate + // The Amazon Web Services Region that the account information is returned from. + // An account can be discovered in multiple regions and will have a separate // discovered account for each Region. DiscoveryRegion *string @@ -7441,20 +7073,15 @@ type IpamDiscoveredResourceCidr struct { // The percentage of IP address space in use. To convert the decimal to a // percentage, multiply the decimal by 100. Note the following: - // - // * For resources - // that are VPCs, this is the percentage of IP address space in the VPC that's - // taken up by subnet CIDRs. - // - // * For resources that are subnets, if the subnet has - // an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in - // the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the - // percentage of IPv6 address space in use is not represented. The percentage of - // IPv6 address space in use cannot currently be calculated. - // - // * For resources that - // are public IPv4 pools, this is the percentage of IP address space in the pool - // that's been allocated to Elastic IP addresses (EIPs). + // - For resources that are VPCs, this is the percentage of IP address space in + // the VPC that's taken up by subnet CIDRs. + // - For resources that are subnets, if the subnet has an IPv4 CIDR provisioned + // to it, this is the percentage of IPv4 address space in the subnet that's in use. + // If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address + // space in use is not represented. The percentage of IPv6 address space in use + // cannot currently be calculated. + // - For resources that are public IPv4 pools, this is the percentage of IP + // address space in the pool that's been allocated to Elastic IP addresses (EIPs). IpUsage *float64 // The resource discovery ID. @@ -7491,28 +7118,17 @@ type IpamDiscoveredResourceCidr struct { type IpamDiscoveryFailureReason struct { // The discovery failure code. - // - // * assume-role-failure - IPAM could not assume the - // Amazon Web Services IAM service-linked role. This could be because of any of the - // following: - // - // * SLR has not been created yet and IPAM is still creating it. - // - // * You - // have opted-out of the IPAM home Region. - // - // * Account you are using as your IPAM - // account has been suspended. - // - // * throttling-failure - IPAM account is already - // using the allotted transactions per second and IPAM is receiving a throttling - // error when assuming the Amazon Web Services IAM SLR. - // - // * unauthorized-failure - - // Amazon Web Services account making the request is not authorized. For more - // information, see AuthFailure - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) in - // the Amazon Elastic Compute Cloud API Reference. + // - assume-role-failure - IPAM could not assume the Amazon Web Services IAM + // service-linked role. This could be because of any of the following: + // - SLR has not been created yet and IPAM is still creating it. + // - You have opted-out of the IPAM home Region. + // - Account you are using as your IPAM account has been suspended. + // - throttling-failure - IPAM account is already using the allotted transactions + // per second and IPAM is receiving a throttling error when assuming the Amazon Web + // Services IAM SLR. + // - unauthorized-failure - Amazon Web Services account making the request is not + // authorized. For more information, see AuthFailure (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) + // in the Amazon Elastic Compute Cloud API Reference. Code IpamDiscoveryFailureCode // The discovery failure message. @@ -7549,14 +7165,14 @@ type IpamPool struct { // allocations will default to 10.0.0.0/16. AllocationDefaultNetmaskLength *int32 - // The maximum netmask length possible for CIDR allocations in this IPAM pool to be - // compliant. The maximum netmask length must be greater than the minimum netmask - // length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask - // lengths for IPv6 addresses are 0 - 128. + // The maximum netmask length possible for CIDR allocations in this IPAM pool to + // be compliant. The maximum netmask length must be greater than the minimum + // netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible + // netmask lengths for IPv6 addresses are 0 - 128. AllocationMaxNetmaskLength *int32 - // The minimum netmask length required for CIDR allocations in this IPAM pool to be - // compliant. The minimum netmask length must be less than the maximum netmask + // The minimum netmask length required for CIDR allocations in this IPAM pool to + // be compliant. The minimum netmask length must be less than the maximum netmask // length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask // lengths for IPv6 addresses are 0 - 128. AllocationMinNetmaskLength *int32 @@ -7579,8 +7195,8 @@ type IpamPool struct { // them only. A locale must be set on the pool for this feature to work. AutoImport *bool - // Limits which service in Amazon Web Services that the pool can be used in. "ec2", - // for example, allows users to use space for Elastic IP addresses and VPCs. + // Limits which service in Amazon Web Services that the pool can be used in. + // "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. AwsService IpamPoolAwsService // The description of the IPAM pool. @@ -7623,24 +7239,21 @@ type IpamPool struct { OwnerId *string // The depth of pools in your IPAM pool. The pool depth quota is 10. For more - // information, see Quotas in IPAM - // (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the Amazon VPC - // IPAM User Guide. + // information, see Quotas in IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) + // in the Amazon VPC IPAM User Guide. PoolDepth *int32 // The IP address source for pools in the public scope. Only used for provisioning - // IP address CIDRs to pools in the public scope. Default is BYOIP. For more - // information, see Create IPv6 pools - // (https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in - // the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided - // IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the - // default limit, see Quotas for your IPAM - // (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the Amazon VPC - // IPAM User Guide. + // IP address CIDRs to pools in the public scope. Default is BYOIP . For more + // information, see Create IPv6 pools (https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) + // in the Amazon VPC IPAM User Guide. By default, you can add only one + // Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on + // increasing the default limit, see Quotas for your IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) + // in the Amazon VPC IPAM User Guide. PublicIpSource IpamPoolPublicIpSource // Determines if a pool is publicly advertisable. This option is not available for - // pools with AddressFamily set to ipv4. + // pools with AddressFamily set to ipv4 . PubliclyAdvertisable *bool // The ID of the source IPAM pool. You can use this option to create an IPAM pool @@ -7655,7 +7268,7 @@ type IpamPool struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. Tags []Tag @@ -7666,9 +7279,9 @@ type IpamPool struct { // pool or to a resource. type IpamPoolAllocation struct { - // The CIDR for the allocation. A CIDR is a representation of an IP address and its - // associated network mask (or netmask) and refers to a range of IP addresses. An - // IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32. + // The CIDR for the allocation. A CIDR is a representation of an IP address and + // its associated network mask (or netmask) and refers to a range of IP addresses. + // An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 . Cidr *string // A description of the pool allocation. @@ -7697,8 +7310,8 @@ type IpamPoolCidr struct { // The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP // address and its associated network mask (or netmask) and refers to a range of IP - // addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is - // 2001:DB8::/32. + // addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is + // 2001:DB8::/32 . Cidr *string // Details related to why an IPAM pool CIDR failed to be provisioned. @@ -7735,27 +7348,21 @@ type IpamPoolCidrFailureReason struct { type IpamResourceCidr struct { // The compliance status of the IPAM resource. For more information on compliance - // statuses, see Monitor CIDR usage by resource - // (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // statuses, see Monitor CIDR usage by resource (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) // in the Amazon VPC IPAM User Guide. ComplianceStatus IpamComplianceStatus // The percentage of IP address space in use. To convert the decimal to a // percentage, multiply the decimal by 100. Note the following: - // - // * For resources - // that are VPCs, this is the percentage of IP address space in the VPC that's - // taken up by subnet CIDRs. - // - // * For resources that are subnets, if the subnet has - // an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in - // the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the - // percentage of IPv6 address space in use is not represented. The percentage of - // IPv6 address space in use cannot currently be calculated. - // - // * For resources that - // are public IPv4 pools, this is the percentage of IP address space in the pool - // that's been allocated to Elastic IP addresses (EIPs). + // - For resources that are VPCs, this is the percentage of IP address space in + // the VPC that's taken up by subnet CIDRs. + // - For resources that are subnets, if the subnet has an IPv4 CIDR provisioned + // to it, this is the percentage of IPv4 address space in the subnet that's in use. + // If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address + // space in use is not represented. The percentage of IPv6 address space in use + // cannot currently be calculated. + // - For resources that are public IPv4 pools, this is the percentage of IP + // address space in the pool that's been allocated to Elastic IP addresses (EIPs). IpUsage *float64 // The IPAM ID for an IPAM resource. @@ -7768,15 +7375,13 @@ type IpamResourceCidr struct { IpamScopeId *string // The management state of the resource. For more information about management - // states, see Monitor CIDR usage by resource - // (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // states, see Monitor CIDR usage by resource (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) // in the Amazon VPC IPAM User Guide. ManagementState IpamManagementState - // The overlap status of an IPAM resource. The overlap status tells you if the CIDR - // for a resource overlaps with another CIDR in the scope. For more information on - // overlap statuses, see Monitor CIDR usage by resource - // (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) + // The overlap status of an IPAM resource. The overlap status tells you if the + // CIDR for a resource overlaps with another CIDR in the scope. For more + // information on overlap statuses, see Monitor CIDR usage by resource (https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) // in the Amazon VPC IPAM User Guide. OverlapStatus IpamOverlapStatus @@ -7823,8 +7428,9 @@ type IpamResourceDiscovery struct { // The resource discovery Region. IpamResourceDiscoveryRegion *string - // Defines if the resource discovery is the default. The default resource discovery - // is the resource discovery automatically created when you create an IPAM. + // Defines if the resource discovery is the default. The default resource + // discovery is the resource discovery automatically created when you create an + // IPAM. IsDefault *bool // The operating Regions for the resource discovery. Operating Regions are Amazon @@ -7837,41 +7443,20 @@ type IpamResourceDiscovery struct { OwnerId *string // The lifecycle state of the resource discovery. - // - // * create-in-progress - Resource - // discovery is being created. - // - // * create-complete - Resource discovery creation is - // complete. - // - // * create-failed - Resource discovery creation has failed. - // - // * - // modify-in-progress - Resource discovery is being modified. - // - // * modify-complete - - // Resource discovery modification is complete. - // - // * modify-failed - Resource - // discovery modification has failed. - // - // * delete-in-progress - Resource discovery is - // being deleted. - // - // * delete-complete - Resource discovery deletion is complete. - // - // * - // delete-failed - Resource discovery deletion has failed. - // - // * isolate-in-progress - - // Amazon Web Services account that created the resource discovery has been removed - // and the resource discovery is being isolated. - // - // * isolate-complete - Resource - // discovery isolation is complete. - // - // * restore-in-progress - Amazon Web Services - // account that created the resource discovery and was isolated has been restored. + // - create-in-progress - Resource discovery is being created. + // - create-complete - Resource discovery creation is complete. + // - create-failed - Resource discovery creation has failed. + // - modify-in-progress - Resource discovery is being modified. + // - modify-complete - Resource discovery modification is complete. + // - modify-failed - Resource discovery modification has failed. + // - delete-in-progress - Resource discovery is being deleted. + // - delete-complete - Resource discovery deletion is complete. + // - delete-failed - Resource discovery deletion has failed. + // - isolate-in-progress - Amazon Web Services account that created the resource + // discovery has been removed and the resource discovery is being isolated. + // - isolate-complete - Resource discovery isolation is complete. + // - restore-in-progress - Amazon Web Services account that created the resource + // discovery and was isolated has been restored. State IpamResourceDiscoveryState // A tag is a label that you assign to an Amazon Web Services resource. Each tag @@ -7914,46 +7499,28 @@ type IpamResourceDiscoveryAssociation struct { OwnerId *string // The resource discovery status. - // - // * active - Connection or permissions required to - // read the results of the resource discovery are intact. - // - // * not-found - Connection - // or permissions required to read the results of the resource discovery are - // broken. This may happen if the owner of the resource discovery stopped sharing - // it or deleted the resource discovery. Verify the resource discovery still exists - // and the Amazon Web Services RAM resource share is still intact. + // - active - Connection or permissions required to read the results of the + // resource discovery are intact. + // - not-found - Connection or permissions required to read the results of the + // resource discovery are broken. This may happen if the owner of the resource + // discovery stopped sharing it or deleted the resource discovery. Verify the + // resource discovery still exists and the Amazon Web Services RAM resource share + // is still intact. ResourceDiscoveryStatus IpamAssociatedResourceDiscoveryStatus // The lifecycle state of the association when you associate or disassociate a // resource discovery. - // - // * associate-in-progress - Resource discovery is being - // associated. - // - // * associate-complete - Resource discovery association is - // complete. - // - // * associate-failed - Resource discovery association has failed. - // - // * - // disassociate-in-progress - Resource discovery is being disassociated. - // - // * - // disassociate-complete - Resource discovery disassociation is complete. - // - // * - // disassociate-failed - Resource discovery disassociation has failed. - // - // * - // isolate-in-progress - Amazon Web Services account that created the resource - // discovery association has been removed and the resource discovery associatation - // is being isolated. - // - // * isolate-complete - Resource discovery isolation is - // complete.. - // - // * restore-in-progress - Resource discovery is being restored. + // - associate-in-progress - Resource discovery is being associated. + // - associate-complete - Resource discovery association is complete. + // - associate-failed - Resource discovery association has failed. + // - disassociate-in-progress - Resource discovery is being disassociated. + // - disassociate-complete - Resource discovery disassociation is complete. + // - disassociate-failed - Resource discovery disassociation has failed. + // - isolate-in-progress - Amazon Web Services account that created the resource + // discovery association has been removed and the resource discovery associatation + // is being isolated. + // - isolate-complete - Resource discovery isolation is complete.. + // - restore-in-progress - Resource discovery is being restored. State IpamResourceDiscoveryAssociationState // A tag is a label that you assign to an Amazon Web Services resource. Each tag @@ -7966,12 +7533,12 @@ type IpamResourceDiscoveryAssociation struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all -// resources that have a tag with the key Owner and the value TeamA, specify +// resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. type IpamResourceTag struct { - // The key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. + // The key of a tag assigned to the resource. Use this filter to find all + // resources assigned a tag with a specific key, regardless of the tag value. Key *string // The value of the tag. @@ -7985,9 +7552,8 @@ type IpamResourceTag struct { // private scope is intended for all private IP address space. The public scope is // intended for all public IP address space. Scopes enable you to reuse IP // addresses across multiple unconnected networks without causing IP address -// overlap or conflict. For more information, see How IPAM works -// (https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html) in the -// Amazon VPC IPAM User Guide. +// overlap or conflict. For more information, see How IPAM works (https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html) +// in the Amazon VPC IPAM User Guide. type IpamScope struct { // The description of the scope. @@ -8022,7 +7588,7 @@ type IpamScope struct { // The key/value combination of a tag assigned to the resource. Use the tag key in // the filter name and the tag value as the filter value. For example, to find all - // resources that have a tag with the key Owner and the value TeamA, specify + // resources that have a tag with the key Owner and the value TeamA , specify // tag:Owner for the filter name and TeamA for the filter value. Tags []Tag @@ -8038,13 +7604,14 @@ type IpPermission struct { // ICMP/ICMPv6 codes. FromPort *int32 - // The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). [VPC - // only] Use -1 to specify all protocols. When authorizing security group rules, - // specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows - // traffic on all ports, regardless of any port range you specify. For tcp, udp, - // and icmp, you must specify a port range. For icmpv6, the port range is optional; - // if you omit the port range, traffic for all types and codes is allowed. + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol + // Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // ). [VPC only] Use -1 to specify all protocols. When authorizing security group + // rules, specifying -1 or a protocol number other than tcp , udp , icmp , or + // icmpv6 allows traffic on all ports, regardless of any port range you specify. + // For tcp , udp , and icmp , you must specify a port range. For icmpv6 , the port + // range is optional; if you omit the port range, traffic for all types and codes + // is allowed. IpProtocol *string // The IPv4 ranges. @@ -8087,9 +7654,8 @@ type IpRange struct { type Ipv4PrefixSpecification struct { // The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network - // interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the - // Amazon Elastic Compute Cloud User Guide. + // interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) + // in the Amazon Elastic Compute Cloud User Guide. Ipv4Prefix *string noSmithyDocumentSerde @@ -8099,9 +7665,8 @@ type Ipv4PrefixSpecification struct { type Ipv4PrefixSpecificationRequest struct { // The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network - // interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the - // Amazon Elastic Compute Cloud User Guide. + // interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) + // in the Amazon Elastic Compute Cloud User Guide. Ipv4Prefix *string noSmithyDocumentSerde @@ -8201,33 +7766,24 @@ type Ipv6Range struct { type KeyPairInfo struct { // If you used Amazon EC2 to create the key pair, this is the date and time when - // the key was created, in ISO 8601 date-time format - // (https://www.iso.org/iso-8601-date-and-time-format.html), in the UTC time zone. - // If you imported an existing key pair to Amazon EC2, this is the date and time - // the key was imported, in ISO 8601 date-time format - // (https://www.iso.org/iso-8601-date-and-time-format.html), in the UTC time zone. + // the key was created, in ISO 8601 date-time format (https://www.iso.org/iso-8601-date-and-time-format.html) + // , in the UTC time zone. If you imported an existing key pair to Amazon EC2, this + // is the date and time the key was imported, in ISO 8601 date-time format (https://www.iso.org/iso-8601-date-and-time-format.html) + // , in the UTC time zone. CreateTime *time.Time // If you used CreateKeyPair to create the key pair: - // - // * For RSA key pairs, the key - // fingerprint is the SHA-1 digest of the DER encoded private key. - // - // * For ED25519 - // key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is - // the default for OpenSSH, starting with OpenSSH 6.8 - // (http://www.openssh.com/txt/release-6.8). - // - // If you used ImportKeyPair to provide - // Amazon Web Services the public key: - // - // * For RSA key pairs, the key fingerprint is - // the MD5 public key fingerprint as specified in section 4 of RFC4716. - // - // * For - // ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, - // which is the default for OpenSSH, starting with OpenSSH 6.8 - // (http://www.openssh.com/txt/release-6.8). + // - For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER + // encoded private key. + // - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 + // digest, which is the default for OpenSSH, starting with OpenSSH 6.8 (http://www.openssh.com/txt/release-6.8) + // . + // If you used ImportKeyPair to provide Amazon Web Services the public key: + // - For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as + // specified in section 4 of RFC4716. + // - For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 + // digest, which is the default for OpenSSH, starting with OpenSSH 6.8 (http://www.openssh.com/txt/release-6.8) + // . KeyFingerprint *string // The name of the key pair. @@ -8272,8 +7828,8 @@ type LaunchPermission struct { // The Amazon Resource Name (ARN) of an organizational unit (OU). OrganizationalUnitArn *string - // The Amazon Web Services account ID. Constraints: Up to 10 000 account IDs can be - // specified in a single request. + // The Amazon Web Services account ID. Constraints: Up to 10 000 account IDs can + // be specified in a single request. UserId *string noSmithyDocumentSerde @@ -8443,13 +7999,10 @@ type LaunchTemplateCapacityReservationSpecificationRequest struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: - // - // * open - The instance can run in any open Capacity Reservation that - // has matching attributes (instance type, platform, Availability Zone). - // - // * none - - // The instance avoids running in a Capacity Reservation even if one is available. - // The instance runs in On-Demand capacity. + // - open - The instance can run in any open Capacity Reservation that has + // matching attributes (instance type, platform, Availability Zone). + // - none - The instance avoids running in a Capacity Reservation even if one is + // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference // Information about the target Capacity Reservation or Capacity Reservation group. @@ -8463,13 +8016,10 @@ type LaunchTemplateCapacityReservationSpecificationResponse struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: - // - // * open - The instance can run in any open Capacity Reservation that - // has matching attributes (instance type, platform, Availability Zone). - // - // * none - - // The instance avoids running in a Capacity Reservation even if one is available. - // The instance runs in On-Demand capacity. + // - open - The instance can run in any open Capacity Reservation that has + // matching attributes (instance type, platform, Availability Zone). + // - none - The instance avoids running in a Capacity Reservation even if one is + // available. The instance runs in On-Demand capacity. CapacityReservationPreference CapacityReservationPreference // Information about the target Capacity Reservation or Capacity Reservation group. @@ -8511,7 +8061,7 @@ type LaunchTemplateCpuOptionsRequest struct { CoreCount *int32 // The number of threads per CPU core. To disable multithreading for the instance, - // specify a value of 1. Otherwise, specify the default value of 2. + // specify a value of 1 . Otherwise, specify the default value of 2 . ThreadsPerCore *int32 noSmithyDocumentSerde @@ -8558,25 +8108,19 @@ type LaunchTemplateEbsBlockDeviceRequest struct { // volume from a snapshot, you can't specify an encryption value. Encrypted *bool - // The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, - // this represents the number of IOPS that are provisioned for the volume. For gp2 - // volumes, this represents the baseline performance of the volume and the rate at - // which the volume accumulates I/O credits for bursting. The following are the - // supported values for each volume type: - // - // * gp3: 3,000-16,000 IOPS - // - // * io1: - // 100-64,000 IOPS - // - // * io2: 100-64,000 IOPS - // - // For io1 and io2 volumes, we guarantee - // 64,000 IOPS only for Instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families guarantee performance up to 32,000 IOPS. This parameter - // is supported for io1, io2, and gp3 volumes only. This parameter is not supported - // for gp2, st1, sc1, or standard volumes. + // The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 + // volumes, this represents the number of IOPS that are provisioned for the volume. + // For gp2 volumes, this represents the baseline performance of the volume and the + // rate at which the volume accumulates I/O credits for bursting. The following are + // the supported values for each volume type: + // - gp3 : 3,000-16,000 IOPS + // - io1 : 100-64,000 IOPS + // - io2 : 100-64,000 IOPS + // For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on + // the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // . Other instance families guarantee performance up to 32,000 IOPS. This + // parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is + // not supported for gp2 , st1 , sc1 , or standard volumes. Iops *int32 // The ARN of the symmetric Key Management Service (KMS) CMK used for encryption. @@ -8590,22 +8134,16 @@ type LaunchTemplateEbsBlockDeviceRequest struct { Throughput *int32 // The size of the volume, in GiBs. You must specify either a snapshot ID or a - // volume size. The following are the supported volumes sizes for each volume - // type: - // - // * gp2 and gp3: 1-16,384 - // - // * io1 and io2: 4-16,384 + // volume size. The following are the supported volumes sizes for each volume type: // - // * st1 and sc1: - // 125-16,384 - // - // * standard: 1-1,024 + // - gp2 and gp3 : 1-16,384 + // - io1 and io2 : 4-16,384 + // - st1 and sc1 : 125-16,384 + // - standard : 1-1,024 VolumeSize *int32 - // The volume type. For more information, see Amazon EBS volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon Elastic Compute Cloud User Guide. + // The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon Elastic Compute Cloud User Guide. VolumeType VolumeType noSmithyDocumentSerde @@ -8620,8 +8158,8 @@ type LaunchTemplateElasticInferenceAccelerator struct { // This member is required. Type *string - // The number of elastic inference accelerators to attach to the instance. Default: - // 1 + // The number of elastic inference accelerators to attach to the instance. + // Default: 1 Count *int32 noSmithyDocumentSerde @@ -8630,8 +8168,8 @@ type LaunchTemplateElasticInferenceAccelerator struct { // Describes an elastic inference accelerator. type LaunchTemplateElasticInferenceAcceleratorResponse struct { - // The number of elastic inference accelerators to attach to the instance. Default: - // 1 + // The number of elastic inference accelerators to attach to the instance. + // Default: 1 Count *int32 // The type of elastic inference accelerator. The possible values are eia1.medium, @@ -8645,7 +8183,7 @@ type LaunchTemplateElasticInferenceAcceleratorResponse struct { // Enclaves. type LaunchTemplateEnclaveOptions struct { - // If this parameter is set to true, the instance is enabled for Amazon Web + // If this parameter is set to true , the instance is enabled for Amazon Web // Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services // Nitro Enclaves. Enabled *bool @@ -8654,13 +8192,12 @@ type LaunchTemplateEnclaveOptions struct { } // Indicates whether the instance is enabled for Amazon Web Services Nitro -// Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? -// (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the -// Amazon Web Services Nitro Enclaves User Guide. +// Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) +// in the Amazon Web Services Nitro Enclaves User Guide. type LaunchTemplateEnclaveOptionsRequest struct { // To enable the instance for Amazon Web Services Nitro Enclaves, set this - // parameter to true. + // parameter to true . Enabled *bool noSmithyDocumentSerde @@ -8669,7 +8206,7 @@ type LaunchTemplateEnclaveOptionsRequest struct { // Indicates whether an instance is configured for hibernation. type LaunchTemplateHibernationOptions struct { - // If this parameter is set to true, the instance is enabled for hibernation; + // If this parameter is set to true , the instance is enabled for hibernation; // otherwise, it is not enabled for hibernation. Configured *bool @@ -8677,11 +8214,11 @@ type LaunchTemplateHibernationOptions struct { } // Indicates whether the instance is configured for hibernation. This parameter is -// valid only if the instance meets the hibernation prerequisites -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). +// valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) +// . type LaunchTemplateHibernationOptionsRequest struct { - // If you set this parameter to true, the instance is enabled for hibernation. + // If you set this parameter to true , the instance is enabled for hibernation. // Default: false Configured *bool @@ -8724,9 +8261,9 @@ type LaunchTemplateInstanceMaintenanceOptions struct { // The maintenance options of your instance. type LaunchTemplateInstanceMaintenanceOptionsRequest struct { - // Disables the automatic recovery behavior of your instance or sets it to default. - // For more information, see Simplified automatic recovery - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery). + // Disables the automatic recovery behavior of your instance or sets it to + // default. For more information, see Simplified automatic recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery) + // . AutoRecovery LaunchTemplateAutoRecoveryState noSmithyDocumentSerde @@ -8757,14 +8294,13 @@ type LaunchTemplateInstanceMarketOptionsRequest struct { } // The metadata options for the instance. For more information, see Instance -// metadata and user data -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) +// metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon Elastic Compute Cloud User Guide. type LaunchTemplateInstanceMetadataOptions struct { // Enables or disables the HTTP metadata endpoint on your instances. If the - // parameter is not specified, the default state is enabled. If you specify a value - // of disabled, you will not be able to access your instance metadata. + // parameter is not specified, the default state is enabled . If you specify a + // value of disabled , you will not be able to access your instance metadata. HttpEndpoint LaunchTemplateInstanceMetadataEndpointState // Enables or disables the IPv6 endpoint for the instance metadata service. @@ -8776,22 +8312,21 @@ type LaunchTemplateInstanceMetadataOptions struct { // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 - // Indicates whether IMDSv2 is optional or required. optional - When IMDSv2 is + // Indicates whether IMDSv2 is optional or required . optional - When IMDSv2 is // optional, you can choose to retrieve instance metadata with or without a session // token in your request. If you retrieve the IAM role credentials without a token, // the IMDSv1 role credentials are returned. If you retrieve the IAM role // credentials using a valid session token, the IMDSv2 role credentials are - // returned. required - When IMDSv2 is required, you must send a session token with - // any instance metadata retrieval requests. In this state, retrieving the IAM role - // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not + // returned. required - When IMDSv2 is required, you must send a session token + // with any instance metadata retrieval requests. In this state, retrieving the IAM + // role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not // available. Default: optional HttpTokens LaunchTemplateHttpTokensState // Set to enabled to allow access to instance tags from the instance metadata. Set // to disabled to turn off access to instance tags from the instance metadata. For - // more information, see Work with instance tags using the instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). - // Default: disabled + // more information, see Work with instance tags using the instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // . Default: disabled InstanceMetadataTags LaunchTemplateInstanceMetadataTagsState // The state of the metadata option changes. pending - The metadata options are @@ -8804,14 +8339,13 @@ type LaunchTemplateInstanceMetadataOptions struct { } // The metadata options for the instance. For more information, see Instance -// metadata and user data -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) +// metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon Elastic Compute Cloud User Guide. type LaunchTemplateInstanceMetadataOptionsRequest struct { // Enables or disables the HTTP metadata endpoint on your instances. If the - // parameter is not specified, the default state is enabled. If you specify a value - // of disabled, you will not be able to access your instance metadata. + // parameter is not specified, the default state is enabled . If you specify a + // value of disabled , you will not be able to access your instance metadata. HttpEndpoint LaunchTemplateInstanceMetadataEndpointState // Enables or disables the IPv6 endpoint for the instance metadata service. @@ -8824,29 +8358,24 @@ type LaunchTemplateInstanceMetadataOptionsRequest struct { HttpPutResponseHopLimit *int32 // IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in - // other words, set the use of IMDSv2 to optional) or required (in other words, set - // the use of IMDSv2 to required). - // - // * optional - When IMDSv2 is optional, you can - // choose to retrieve instance metadata with or without a session token in your - // request. If you retrieve the IAM role credentials without a token, the IMDSv1 - // role credentials are returned. If you retrieve the IAM role credentials using a - // valid session token, the IMDSv2 role credentials are returned. - // - // * required - - // When IMDSv2 is required, you must send a session token with any instance - // metadata retrieval requests. In this state, retrieving the IAM role credentials - // always returns IMDSv2 credentials; IMDSv1 credentials are not - // available. - // + // other words, set the use of IMDSv2 to optional ) or required (in other words, + // set the use of IMDSv2 to required ). + // - optional - When IMDSv2 is optional, you can choose to retrieve instance + // metadata with or without a session token in your request. If you retrieve the + // IAM role credentials without a token, the IMDSv1 role credentials are returned. + // If you retrieve the IAM role credentials using a valid session token, the IMDSv2 + // role credentials are returned. + // - required - When IMDSv2 is required, you must send a session token with any + // instance metadata retrieval requests. In this state, retrieving the IAM role + // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not + // available. // Default: optional HttpTokens LaunchTemplateHttpTokensState // Set to enabled to allow access to instance tags from the instance metadata. Set // to disabled to turn off access to instance tags from the instance metadata. For - // more information, see Work with instance tags using the instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). - // Default: disabled + // more information, see Work with instance tags using the instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // . Default: disabled InstanceMetadataTags LaunchTemplateInstanceMetadataTagsState noSmithyDocumentSerde @@ -8858,13 +8387,12 @@ type LaunchTemplateInstanceNetworkInterfaceSpecification struct { // Indicates whether to associate a Carrier IP address with eth0 for a new network // interface. Use this option when you launch an instance in a Wavelength Zone and // want to associate a Carrier IP address with the network interface. For more - // information about Carrier IP addresses, see Carrier IP addresses - // (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) + // information about Carrier IP addresses, see Carrier IP addresses (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) // in the Wavelength Developer Guide. AssociateCarrierIpAddress *bool - // Indicates whether to associate a public IPv4 address with eth0 for a new network - // interface. + // Indicates whether to associate a public IPv4 address with eth0 for a new + // network interface. AssociatePublicIpAddress *bool // Indicates whether the network interface is deleted when the instance is @@ -8930,8 +8458,7 @@ type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { // Associates a Carrier IP address with eth0 for a new network interface. Use this // option when you launch an instance in a Wavelength Zone and want to associate a // Carrier IP address with the network interface. For more information about - // Carrier IP addresses, see Carrier IP addresses - // (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) + // Carrier IP addresses, see Carrier IP addresses (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) // in the Wavelength Developer Guide. AssociateCarrierIpAddress *bool @@ -8952,10 +8479,9 @@ type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { Groups []string // The type of network interface. To create an Elastic Fabric Adapter (EFA), - // specify efa. For more information, see Elastic Fabric Adapter - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the Amazon - // Elastic Compute Cloud User Guide. If you are not creating an EFA, specify - // interface or omit this parameter. Valid values: interface | efa + // specify efa . For more information, see Elastic Fabric Adapter (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) + // in the Amazon Elastic Compute Cloud User Guide. If you are not creating an EFA, + // specify interface or omit this parameter. Valid values: interface | efa InterfaceType *string // The number of IPv4 prefixes to be automatically assigned to the network @@ -9035,29 +8561,29 @@ type LaunchTemplateOverrides struct { // will identify instance types with the provided requirements, and then use your // On-Demand and Spot allocation strategies to launch instances from these instance // types, in the same way as when you specify a list of instance types. If you - // specify InstanceRequirements, you can't specify InstanceType. + // specify InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements // The instance type. InstanceType InstanceType // The priority for the launch template override. The highest priority is launched - // first. If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses + // first. If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses // priority to determine which launch template override to use first in fulfilling // On-Demand capacity. If the Spot AllocationStrategy is set to - // capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to - // determine which launch template override to use in fulfilling Spot capacity, but - // optimizes for capacity first. Valid values are whole numbers starting at 0. The - // lower the number, the higher the priority. If no number is set, the launch + // capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis + // to determine which launch template override to use in fulfilling Spot capacity, + // but optimizes for capacity first. Valid values are whole numbers starting at 0 . + // The lower the number, the higher the priority. If no number is set, the launch // template override has the lowest priority. You can set the same priority for // different launch template overrides. Priority *float64 - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string // The ID of the subnet in which to launch the instances. @@ -9092,7 +8618,7 @@ type LaunchTemplatePlacement struct { HostResourceGroupArn *string // The number of the partition the instance should launch in. Valid only if the - // placement group strategy is set to partition. + // placement group strategy is set to partition . PartitionNumber *int32 // Reserved for future use. @@ -9114,8 +8640,8 @@ type LaunchTemplatePlacementRequest struct { // The Availability Zone for the instance. AvailabilityZone *string - // The Group Id of a placement group. You must specify the Placement Group Group Id - // to launch an instance in a shared placement group. + // The Group Id of a placement group. You must specify the Placement Group Group + // Id to launch an instance in a shared placement group. GroupId *string // The name of the placement group for the instance. @@ -9125,11 +8651,11 @@ type LaunchTemplatePlacementRequest struct { HostId *string // The ARN of the host resource group in which to launch the instances. If you - // specify a host resource group ARN, omit the Tenancy parameter or set it to host. + // specify a host resource group ARN, omit the Tenancy parameter or set it to host . HostResourceGroupArn *string // The number of the partition the instance should launch in. Valid only if the - // placement group strategy is set to partition. + // placement group strategy is set to partition . PartitionNumber *int32 // Reserved for future use. @@ -9145,8 +8671,8 @@ type LaunchTemplatePlacementRequest struct { // Describes the options for instance hostnames. type LaunchTemplatePrivateDnsNameOptions struct { - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord *bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -9162,8 +8688,8 @@ type LaunchTemplatePrivateDnsNameOptions struct { // Describes the options for instance hostnames. type LaunchTemplatePrivateDnsNameOptionsRequest struct { - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord *bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -9183,8 +8709,8 @@ type LaunchTemplatePrivateDnsNameOptionsRequest struct { // Describes the monitoring for the instance. type LaunchTemplatesMonitoring struct { - // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - // enabled. + // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring + // is enabled. Enabled *bool noSmithyDocumentSerde @@ -9205,16 +8731,16 @@ type LaunchTemplatesMonitoringRequest struct { type LaunchTemplateSpecification struct { // The ID of the launch template. You must specify the LaunchTemplateId or the - // LaunchTemplateName, but not both. + // LaunchTemplateName , but not both. LaunchTemplateId *string // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId, but not both. + // LaunchTemplateId , but not both. LaunchTemplateName *string - // The launch template version number, $Latest, or $Default. If the value is - // $Latest, Amazon EC2 uses the latest version of the launch template. If the value - // is $Default, Amazon EC2 uses the default version of the launch template. + // The launch template version number, $Latest , or $Default . If the value is + // $Latest , Amazon EC2 uses the latest version of the launch template. If the + // value is $Default , Amazon EC2 uses the default version of the launch template. // Default: The default version of the launch template. Version *string @@ -9231,11 +8757,11 @@ type LaunchTemplateSpotMarketOptions struct { // The behavior when a Spot Instance is interrupted. InstanceInterruptionBehavior InstanceInterruptionBehavior - // The maximum hourly price you're willing to pay for the Spot Instances. We do not - // recommend using this parameter because it can lead to increased interruptions. - // If you do not specify this parameter, you will pay the current Spot price. If - // you specify a maximum price, your Spot Instances will be interrupted more - // frequently than if you do not specify this parameter. + // The maximum hourly price you're willing to pay for the Spot Instances. We do + // not recommend using this parameter because it can lead to increased + // interruptions. If you do not specify this parameter, you will pay the current + // Spot price. If you specify a maximum price, your Spot Instances will be + // interrupted more frequently than if you do not specify this parameter. MaxPrice *string // The Spot Instance request type. @@ -9256,14 +8782,14 @@ type LaunchTemplateSpotMarketOptionsRequest struct { // Deprecated. BlockDurationMinutes *int32 - // The behavior when a Spot Instance is interrupted. The default is terminate. + // The behavior when a Spot Instance is interrupted. The default is terminate . InstanceInterruptionBehavior InstanceInterruptionBehavior - // The maximum hourly price you're willing to pay for the Spot Instances. We do not - // recommend using this parameter because it can lead to increased interruptions. - // If you do not specify this parameter, you will pay the current Spot price. If - // you specify a maximum price, your Spot Instances will be interrupted more - // frequently than if you do not specify this parameter. + // The maximum hourly price you're willing to pay for the Spot Instances. We do + // not recommend using this parameter because it can lead to increased + // interruptions. If you do not specify this parameter, you will pay the current + // Spot price. If you specify a maximum price, your Spot Instances will be + // interrupted more frequently than if you do not specify this parameter. MaxPrice *string // The Spot Instance request type. @@ -9271,15 +8797,11 @@ type LaunchTemplateSpotMarketOptionsRequest struct { // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported // only for persistent requests. - // - // * For a persistent request, the request remains - // active until the ValidUntil date and time is reached. Otherwise, the request - // remains active until you cancel it. - // - // * For a one-time request, ValidUntil is not - // supported. The request remains active until all instances launch or you cancel - // the request. - // + // - For a persistent request, the request remains active until the ValidUntil + // date and time is reached. Otherwise, the request remains active until you cancel + // it. + // - For a one-time request, ValidUntil is not supported. The request remains + // active until all instances launch or you cancel the request. // Default: 7 days from the current date ValidUntil *time.Time @@ -9306,8 +8828,8 @@ type LaunchTemplateTagSpecificationRequest struct { // can be tagged. However, when creating a launch template, you can specify tags // for the following resource types only: instance | volume | elastic-gpu | // network-interface | spot-instances-request To tag a resource after it has been - // created, see CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + // created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) + // . ResourceType ResourceType // The tags to apply to the resource. @@ -9364,8 +8886,8 @@ type LicenseConfigurationRequest struct { noSmithyDocumentSerde } -// Describes the Classic Load Balancers and target groups to attach to a Spot Fleet -// request. +// Describes the Classic Load Balancers and target groups to attach to a Spot +// Fleet request. type LoadBalancersConfig struct { // The Classic Load Balancers. @@ -9698,12 +9220,12 @@ type MemoryGiBPerVCpu struct { // The minimum and maximum amount of memory per vCPU, in GiB. type MemoryGiBPerVCpuRequest struct { - // The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit - // this parameter. + // The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, + // omit this parameter. Max *float64 - // The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit - // this parameter. + // The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, + // omit this parameter. Min *float64 noSmithyDocumentSerde @@ -9735,7 +9257,7 @@ type MemoryMiB struct { // The minimum and maximum amount of memory, in MiB. type MemoryMiBRequest struct { - // The minimum amount of memory, in MiB. To specify no minimum limit, specify 0. + // The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 . // // This member is required. Min *int32 @@ -9747,18 +9269,18 @@ type MemoryMiBRequest struct { noSmithyDocumentSerde } -// Indicates whether the network was healthy or degraded at a particular point. The -// value is aggregated from the startDate to the endDate. Currently only +// Indicates whether the network was healthy or degraded at a particular point. +// The value is aggregated from the startDate to the endDate . Currently only // five_minutes is supported. type MetricPoint struct { // The end date for the metric point. The ending time must be formatted as - // yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z. + // yyyy-mm-ddThh:mm:ss . For example, 2022-06-12T12:00:00.000Z . EndDate *time.Time - // The start date for the metric point. The starting date for the metric point. The - // starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, - // 2022-06-10T12:00:00.000Z. + // The start date for the metric point. The starting date for the metric point. + // The starting time must be formatted as yyyy-mm-ddThh:mm:ss . For example, + // 2022-06-10T12:00:00.000Z . StartDate *time.Time // The status of the metric point. @@ -9815,15 +9337,15 @@ type ModifyTransitGatewayOptions struct { // Describes the options for a VPC attachment. type ModifyTransitGatewayVpcAttachmentRequestOptions struct { - // Enable or disable support for appliance mode. If enabled, a traffic flow between - // a source and destination uses the same Availability Zone for the VPC attachment - // for the lifetime of that flow. The default is disable. + // Enable or disable support for appliance mode. If enabled, a traffic flow + // between a source and destination uses the same Availability Zone for the VPC + // attachment for the lifetime of that flow. The default is disable . ApplianceModeSupport ApplianceModeSupportValue - // Enable or disable DNS support. The default is enable. + // Enable or disable DNS support. The default is enable . DnsSupport DnsSupportValue - // Enable or disable IPv6 support. The default is enable. + // Enable or disable IPv6 support. The default is enable . Ipv6Support Ipv6SupportValue noSmithyDocumentSerde @@ -9857,12 +9379,12 @@ type ModifyVerifiedAccessEndpointLoadBalancerOptions struct { noSmithyDocumentSerde } -// OpenID Connect options for an oidc-type, user-identity based trust provider. +// OpenID Connect options for an oidc -type, user-identity based trust provider. type ModifyVerifiedAccessTrustProviderOidcOptions struct { - // OpenID Connect (OIDC) scopes are used by an application during authentication to - // authorize access to a user's details. Each scope returns a specific set of user - // attributes. + // OpenID Connect (OIDC) scopes are used by an application during authentication + // to authorize access to a user's details. Each scope returns a specific set of + // user attributes. Scope *string noSmithyDocumentSerde @@ -9900,8 +9422,8 @@ type ModifyVpnTunnelOptionsSpecification struct { // AES256-GCM-16 Phase1EncryptionAlgorithms []Phase1EncryptionAlgorithmsRequestListValue - // One or more integrity algorithms that are permitted for the VPN tunnel for phase - // 1 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 + // One or more integrity algorithms that are permitted for the VPN tunnel for + // phase 1 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Phase1IntegrityAlgorithms []Phase1IntegrityAlgorithmsRequestListValue // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A @@ -9918,31 +9440,31 @@ type ModifyVpnTunnelOptionsSpecification struct { // AES256-GCM-16 Phase2EncryptionAlgorithms []Phase2EncryptionAlgorithmsRequestListValue - // One or more integrity algorithms that are permitted for the VPN tunnel for phase - // 2 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 + // One or more integrity algorithms that are permitted for the VPN tunnel for + // phase 2 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Phase2IntegrityAlgorithms []Phase2IntegrityAlgorithmsRequestListValue // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A // value between 900 and 3,600. The value must be less than the value for - // Phase1LifetimeSeconds. Default: 3600 + // Phase1LifetimeSeconds . Default: 3600 Phase2LifetimeSeconds *int32 - // The pre-shared key (PSK) to establish initial authentication between the virtual - // private gateway and the customer gateway. Constraints: Allowed characters are - // alphanumeric characters, periods (.), and underscores (_). Must be between 8 and - // 64 characters in length and cannot start with zero (0). + // The pre-shared key (PSK) to establish initial authentication between the + // virtual private gateway and the customer gateway. Constraints: Allowed + // characters are alphanumeric characters, periods (.), and underscores (_). Must + // be between 8 and 64 characters in length and cannot start with zero (0). PreSharedKey *string - // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during - // which the rekey time is randomly selected. Constraints: A value between 0 and - // 100. Default: 100 + // The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) + // during which the rekey time is randomly selected. Constraints: A value between 0 + // and 100. Default: 100 RekeyFuzzPercentage *int32 // The margin time, in seconds, before the phase 2 lifetime expires, during which // the Amazon Web Services side of the VPN connection performs an IKE rekey. The // exact time of the rekey is randomly selected based on the value for - // RekeyFuzzPercentage. Constraints: A value between 60 and half of - // Phase2LifetimeSeconds. Default: 540 + // RekeyFuzzPercentage . Constraints: A value between 60 and half of + // Phase2LifetimeSeconds . Default: 540 RekeyMarginTimeSeconds *int32 // The number of packets in an IKE replay window. Constraints: A value between 64 @@ -9959,22 +9481,13 @@ type ModifyVpnTunnelOptionsSpecification struct { // must be unique across all VPN connections that use the same virtual private // gateway. Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The // following CIDR blocks are reserved and cannot be used: - // - // * 169.254.0.0/30 - // - // * - // 169.254.1.0/30 - // - // * 169.254.2.0/30 - // - // * 169.254.3.0/30 - // - // * 169.254.4.0/30 - // - // * - // 169.254.5.0/30 - // - // * 169.254.169.252/30 + // - 169.254.0.0/30 + // - 169.254.1.0/30 + // - 169.254.2.0/30 + // - 169.254.3.0/30 + // - 169.254.4.0/30 + // - 169.254.5.0/30 + // - 169.254.169.252/30 TunnelInsideCidr *string // The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks @@ -9988,8 +9501,8 @@ type ModifyVpnTunnelOptionsSpecification struct { // Describes the monitoring of an instance. type Monitoring struct { - // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - // enabled. + // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring + // is enabled. State MonitoringState noSmithyDocumentSerde @@ -9997,13 +9510,12 @@ type Monitoring struct { // Describes the status of a moving Elastic IP address. We are retiring // EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more -// information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. type MovingAddressStatus struct { - // The status of the Elastic IP address that's being moved to the EC2-VPC platform, - // or restored to the EC2-Classic platform. + // The status of the Elastic IP address that's being moved to the EC2-VPC + // platform, or restored to the EC2-Classic platform. MoveStatus MoveStatus // The Elastic IP address. @@ -10025,66 +9537,51 @@ type NatGateway struct { DeleteTime *time.Time // If the NAT gateway could not be created, specifies the error code for the - // failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | + // failure. ( InsufficientFreeAddressesInSubnet | Gateway.NotAttached | // InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | - // InvalidSubnetID.NotFound) + // InvalidSubnetID.NotFound ) FailureCode *string // If the NAT gateway could not be created, specifies the error message for the // failure, that corresponds to the error code. - // - // * For - // InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to - // create this NAT gateway" - // - // * For Gateway.NotAttached: "Network vpc-xxxxxxxx has - // no Internet gateway attached" - // - // * For InvalidAllocationID.NotFound: "Elastic IP - // address eipalloc-xxxxxxxx could not be associated with this NAT gateway" - // - // * For - // Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already - // associated" - // - // * For InternalError: "Network interface eni-xxxxxxxx, created and - // used internally by this NAT gateway is in an invalid state. Please try - // again." - // - // * For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx - // does not exist or could not be found." + // - For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free + // addresses to create this NAT gateway" + // - For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway + // attached" + // - For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx + // could not be associated with this NAT gateway" + // - For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is + // already associated" + // - For InternalError: "Network interface eni-xxxxxxxx, created and used + // internally by this NAT gateway is in an invalid state. Please try again." + // - For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does + // not exist or could not be found." FailureMessage *string - // Information about the IP addresses and network interface associated with the NAT - // gateway. + // Information about the IP addresses and network interface associated with the + // NAT gateway. NatGatewayAddresses []NatGatewayAddress // The ID of the NAT gateway. NatGatewayId *string - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . ProvisionedBandwidth *ProvisionedBandwidth // The state of the NAT gateway. - // - // * pending: The NAT gateway is being created and - // is not ready to process traffic. - // - // * failed: The NAT gateway could not be - // created. Check the failureCode and failureMessage fields for the reason. - // - // * - // available: The NAT gateway is able to process traffic. This status remains until - // you delete the NAT gateway, and does not indicate the health of the NAT - // gateway. - // - // * deleting: The NAT gateway is in the process of being terminated and - // may still be processing traffic. - // - // * deleted: The NAT gateway has been terminated - // and is no longer processing traffic. + // - pending : The NAT gateway is being created and is not ready to process + // traffic. + // - failed : The NAT gateway could not be created. Check the failureCode and + // failureMessage fields for the reason. + // - available : The NAT gateway is able to process traffic. This status remains + // until you delete the NAT gateway, and does not indicate the health of the NAT + // gateway. + // - deleting : The NAT gateway is in the process of being terminated and may + // still be processing traffic. + // - deleted : The NAT gateway has been terminated and is no longer processing + // traffic. State NatGatewayState // The ID of the subnet in which the NAT gateway is located. @@ -10211,8 +9708,7 @@ type NetworkAclEntry struct { // achieve the minimum bandwidth. Amazon EC2 will identify instance types that // support the specified minimum bandwidth, but the actual bandwidth of your // instance might go below the specified minimum at times. For more information, -// see Available instance bandwidth -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) +// see Available instance bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) // in the Amazon EC2 User Guide. type NetworkBandwidthGbps struct { @@ -10232,8 +9728,7 @@ type NetworkBandwidthGbps struct { // achieve the minimum bandwidth. Amazon EC2 will identify instance types that // support the specified minimum bandwidth, but the actual bandwidth of your // instance might go below the specified minimum at times. For more information, -// see Available instance bandwidth -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) +// see Available instance bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) // in the Amazon EC2 User Guide. type NetworkBandwidthGbpsRequest struct { @@ -10398,8 +9893,8 @@ type NetworkInsightsAnalysis struct { AlternatePathHints []AlternatePathHint // The explanations. For more information, see Reachability Analyzer explanation - // codes - // (https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html). + // codes (https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) + // . Explanations []Explanation // The Amazon Resource Names (ARN) of the resources that the path must traverse. @@ -10429,7 +9924,7 @@ type NetworkInsightsAnalysis struct { // The status of the network insights analysis. Status AnalysisStatus - // The status message, if the status is failed. + // The status message, if the status is failed . StatusMessage *string // Potential intermediate accounts. @@ -10496,8 +9991,8 @@ type NetworkInsightsPath struct { // Describes a network interface. type NetworkInterface struct { - // The association information for an Elastic IP address (IPv4) associated with the - // network interface. + // The association information for an Elastic IP address (IPv4) associated with + // the network interface. Association *NetworkInterfaceAssociation // The network interface attachment. @@ -10507,7 +10002,7 @@ type NetworkInterface struct { AvailabilityZone *string // Indicates whether a network interface with an IPv6 address is unreachable from - // the public internet. If the value is true, inbound traffic from the internet is + // the public internet. If the value is true , inbound traffic from the internet is // dropped and you cannot assign an elastic IP address to the network interface. // The network interface is reachable from peered VPCs and resources connected // through a transit gateway, including on-premises networks. @@ -10679,12 +10174,12 @@ type NetworkInterfaceCount struct { // The minimum and maximum number of network interfaces. type NetworkInterfaceCountRequest struct { - // The maximum number of network interfaces. To specify no maximum limit, omit this - // parameter. + // The maximum number of network interfaces. To specify no maximum limit, omit + // this parameter. Max *int32 - // The minimum number of network interfaces. To specify no minimum limit, omit this - // parameter. + // The minimum number of network interfaces. To specify no minimum limit, omit + // this parameter. Min *int32 noSmithyDocumentSerde @@ -10738,8 +10233,8 @@ type NetworkInterfacePermissionState struct { // Describes the private IPv4 address of a network interface. type NetworkInterfacePrivateIpAddress struct { - // The association information for an Elastic IP address (IPv4) associated with the - // network interface. + // The association information for an Elastic IP address (IPv4) associated with + // the network interface. Association *NetworkInterfaceAssociation // Indicates whether this IPv4 address is the primary private IPv4 address of the @@ -10805,24 +10300,24 @@ type OnDemandOptions struct { AllocationStrategy FleetOnDemandAllocationStrategy // The strategy for using unused Capacity Reservations for fulfilling On-Demand - // capacity. Supported only for fleets of type instant. + // capacity. Supported only for fleets of type instant . CapacityReservationOptions *CapacityReservationOptions // The maximum amount per hour for On-Demand Instances that you're willing to pay. MaxTotalPrice *string - // The minimum target capacity for On-Demand Instances in the fleet. If the minimum - // target capacity is not reached, the fleet launches no instances. Supported only - // for fleets of type instant. At least one of the following must be specified: - // SingleAvailabilityZone | SingleInstanceType + // The minimum target capacity for On-Demand Instances in the fleet. If the + // minimum target capacity is not reached, the fleet launches no instances. + // Supported only for fleets of type instant . At least one of the following must + // be specified: SingleAvailabilityZone | SingleInstanceType MinTargetCapacity *int32 // Indicates that the fleet launches all On-Demand Instances into a single - // Availability Zone. Supported only for fleets of type instant. + // Availability Zone. Supported only for fleets of type instant . SingleAvailabilityZone *bool // Indicates that the fleet uses a single instance type to launch all On-Demand - // Instances in the fleet. Supported only for fleets of type instant. + // Instances in the fleet. Supported only for fleets of type instant . SingleInstanceType *bool noSmithyDocumentSerde @@ -10839,24 +10334,24 @@ type OnDemandOptionsRequest struct { AllocationStrategy FleetOnDemandAllocationStrategy // The strategy for using unused Capacity Reservations for fulfilling On-Demand - // capacity. Supported only for fleets of type instant. + // capacity. Supported only for fleets of type instant . CapacityReservationOptions *CapacityReservationOptionsRequest // The maximum amount per hour for On-Demand Instances that you're willing to pay. MaxTotalPrice *string - // The minimum target capacity for On-Demand Instances in the fleet. If the minimum - // target capacity is not reached, the fleet launches no instances. Supported only - // for fleets of type instant. At least one of the following must be specified: - // SingleAvailabilityZone | SingleInstanceType + // The minimum target capacity for On-Demand Instances in the fleet. If the + // minimum target capacity is not reached, the fleet launches no instances. + // Supported only for fleets of type instant . At least one of the following must + // be specified: SingleAvailabilityZone | SingleInstanceType MinTargetCapacity *int32 // Indicates that the fleet launches all On-Demand Instances into a single - // Availability Zone. Supported only for fleets of type instant. + // Availability Zone. Supported only for fleets of type instant . SingleAvailabilityZone *bool // Indicates that the fleet uses a single instance type to launch all On-Demand - // Instances in the fleet. Supported only for fleets of type instant. + // Instances in the fleet. Supported only for fleets of type instant . SingleInstanceType *bool noSmithyDocumentSerde @@ -11074,11 +10569,10 @@ type PeeringAttachmentStatus struct { noSmithyDocumentSerde } -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Describes the VPC peering connection -// options. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Describes the VPC peering +// connection options. type PeeringConnectionOptions struct { // If true, the public DNS hostnames of instances in the specified VPC resolve to @@ -11096,10 +10590,10 @@ type PeeringConnectionOptions struct { noSmithyDocumentSerde } -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. The VPC peering connection options. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. The VPC peering connection +// options. type PeeringConnectionOptionsRequest struct { // If true, enables a local VPC to resolve public DNS hostnames to private IP @@ -11253,43 +10747,41 @@ type Phase2IntegrityAlgorithmsRequestListValue struct { type Placement struct { // The affinity setting for the instance on the Dedicated Host. This parameter is - // not supported for CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or - // ImportInstance - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html). + // not supported for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // or ImportInstance (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) + // . Affinity *string // The Availability Zone of the instance. If not specified, an Availability Zone // will be automatically chosen for you based on the load balancing criteria for - // the Region. This parameter is not supported for CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). + // the Region. This parameter is not supported for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // . AvailabilityZone *string - // The ID of the placement group that the instance is in. If you specify GroupId, - // you can't specify GroupName. + // The ID of the placement group that the instance is in. If you specify GroupId , + // you can't specify GroupName . GroupId *string // The name of the placement group that the instance is in. If you specify - // GroupName, you can't specify GroupId. + // GroupName , you can't specify GroupId . GroupName *string // The ID of the Dedicated Host on which the instance resides. This parameter is - // not supported for CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or - // ImportInstance - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html). + // not supported for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // or ImportInstance (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) + // . HostId *string // The ARN of the host resource group in which to launch the instances. If you - // specify this parameter, either omit the Tenancy parameter or set it to host. - // This parameter is not supported for CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). + // specify this parameter, either omit the Tenancy parameter or set it to host . + // This parameter is not supported for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // . HostResourceGroupArn *string - // The number of the partition that the instance is in. Valid only if the placement - // group strategy is set to partition. This parameter is not supported for - // CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). + // The number of the partition that the instance is in. Valid only if the + // placement group strategy is set to partition . This parameter is not supported + // for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // . PartitionNumber *int32 // Reserved for future use. @@ -11297,10 +10789,8 @@ type Placement struct { // The tenancy of the instance (if the instance is running in a VPC). An instance // with a tenancy of dedicated runs on single-tenant hardware. This parameter is - // not supported for CreateFleet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). The - // host tenancy is not supported for ImportInstance - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) + // not supported for CreateFleet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) + // . The host tenancy is not supported for ImportInstance (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) // or for T3 instances that are configured for the unlimited CPU credit option. Tenancy Tenancy @@ -11319,7 +10809,7 @@ type PlacementGroup struct { // The name of the placement group. GroupName *string - // The number of partitions. Valid only if strategy is set to partition. + // The number of partitions. Valid only if strategy is set to partition . PartitionCount *int32 // The spread level for the placement group. Only Outpost placement groups can be @@ -11433,18 +10923,18 @@ type PrefixListId struct { // Describes the price for a Reserved Instance. type PriceSchedule struct { - // The current price schedule, as determined by the term remaining for the Reserved - // Instance in the listing. A specific price schedule is always in effect, but only - // one price schedule can be active at any time. Take, for example, a Reserved - // Instance listing that has five months remaining in its term. When you specify - // price schedules for five months and two months, this means that schedule 1, - // covering the first three months of the remaining term, will be active during + // The current price schedule, as determined by the term remaining for the + // Reserved Instance in the listing. A specific price schedule is always in effect, + // but only one price schedule can be active at any time. Take, for example, a + // Reserved Instance listing that has five months remaining in its term. When you + // specify price schedules for five months and two months, this means that schedule + // 1, covering the first three months of the remaining term, will be active during // months 5, 4, and 3. Then schedule 2, covering the last two months of the term, // will be active for months 2 and 1. Active *bool // The currency for transacting the Reserved Instance resale. At this time, the - // only supported currency is USD. + // only supported currency is USD . CurrencyCode CurrencyCodeValues // The fixed price for the term. @@ -11461,7 +10951,7 @@ type PriceSchedule struct { type PriceScheduleSpecification struct { // The currency for transacting the Reserved Instance resale. At this time, the - // only supported currency is USD. + // only supported currency is USD . CurrencyCode CurrencyCodeValues // The fixed price for the term. @@ -11511,18 +11001,18 @@ type PrivateDnsDetails struct { type PrivateDnsNameConfiguration struct { // The name of the record subdomain the service provider needs to create. The - // service provider adds the value text to the name. + // service provider adds the value text to the name . Name *string // The verification state of the VPC endpoint service. >Consumers of the endpoint - // service can use the private name only when the state is verified. + // service can use the private name only when the state is verified . State DnsNameState // The endpoint service verification type, for example TXT. Type *string - // The value the service provider adds to the private DNS name domain record before - // verification. + // The value the service provider adds to the private DNS name domain record + // before verification. Value *string noSmithyDocumentSerde @@ -11551,8 +11041,8 @@ type PrivateDnsNameOptionsOnLaunch struct { // Describes the options for instance hostnames. type PrivateDnsNameOptionsRequest struct { - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord *bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -11571,8 +11061,8 @@ type PrivateDnsNameOptionsRequest struct { // Describes the options for instance hostnames. type PrivateDnsNameOptionsResponse struct { - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord *bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -11631,34 +11121,34 @@ type PropagatingVgw struct { noSmithyDocumentSerde } -// Reserved. If you need to sustain traffic greater than the documented limits -// (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact -// us through the Support Center (https://console.aws.amazon.com/support/home?). +// Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) +// , contact us through the Support Center (https://console.aws.amazon.com/support/home?) +// . type ProvisionedBandwidth struct { - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . ProvisionTime *time.Time - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . Provisioned *string - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . RequestTime *time.Time - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . Requested *string - // Reserved. If you need to sustain traffic greater than the documented limits - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact - // us through the Support Center (https://console.aws.amazon.com/support/home?). + // Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) + // , contact us through the Support Center (https://console.aws.amazon.com/support/home?) + // . Status *string noSmithyDocumentSerde @@ -11729,8 +11219,8 @@ type PublicIpv4PoolRange struct { // Describes the result of the purchase. type Purchase struct { - // The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At - // this time, the only supported currency is USD. + // The currency in which the UpfrontPrice and HourlyPrice amounts are specified. + // At this time, the only supported currency is USD . CurrencyCode CurrencyCodeValues // The duration of the reservation's term in seconds. @@ -11745,8 +11235,8 @@ type Purchase struct { // The hourly price of the reservation per hour. HourlyPrice *string - // The instance family on the Dedicated Host that the reservation can be associated - // with. + // The instance family on the Dedicated Host that the reservation can be + // associated with. InstanceFamily *string // The payment option for the reservation. @@ -11813,8 +11303,8 @@ type Region struct { // The Region service endpoint. Endpoint *string - // The Region opt-in status. The possible values are opt-in-not-required, opted-in, - // and not-opted-in. + // The Region opt-in status. The possible values are opt-in-not-required , opted-in + // , and not-opted-in . OptInStatus *string // The name of the Region. @@ -11893,29 +11383,18 @@ type ReplaceRootVolumeTask struct { Tags []Tag // The state of the task. The task can be in one of the following states: - // - // * - // pending - the replacement volume is being created. - // - // * in-progress - the original - // volume is being detached and the replacement volume is being attached. - // - // * - // succeeded - the replacement volume has been successfully attached to the - // instance and the instance is available. - // - // * failing - the replacement task is in - // the process of failing. - // - // * failed - the replacement task has failed but the - // original root volume is still attached. - // - // * failing-detached - the replacement - // task is in the process of failing. The instance might have no root volume - // attached. - // - // * failed-detached - the replacement task has failed and the instance - // has no root volume attached. + // - pending - the replacement volume is being created. + // - in-progress - the original volume is being detached and the replacement + // volume is being attached. + // - succeeded - the replacement volume has been successfully attached to the + // instance and the instance is available. + // - failing - the replacement task is in the process of failing. + // - failed - the replacement task has failed but the original root volume is + // still attached. + // - failing-detached - the replacement task is in the process of failing. The + // instance might have no root volume attached. + // - failed-detached - the replacement task has failed and the instance has no + // root volume attached. TaskState ReplaceRootVolumeTaskState noSmithyDocumentSerde @@ -11936,8 +11415,8 @@ type RequestFilterPortRange struct { // A tag on an IPAM resource. type RequestIpamResourceTag struct { - // The key of a tag assigned to the resource. Use this filter to find all resources - // assigned a tag with a specific key, regardless of the tag value. + // The key of a tag assigned to the resource. Use this filter to find all + // resources assigned a tag with a specific key, regardless of the tag value. Key *string // The value for the tag. @@ -11946,22 +11425,21 @@ type RequestIpamResourceTag struct { noSmithyDocumentSerde } -// The information to include in the launch template. You must specify at least one -// parameter for the launch template data. +// The information to include in the launch template. You must specify at least +// one parameter for the launch template data. type RequestLaunchTemplateData struct { // The block device mapping. BlockDeviceMappings []LaunchTemplateBlockDeviceMappingRequest - // The Capacity Reservation targeting option. If you do not specify this parameter, - // the instance's Capacity Reservation preference defaults to open, which enables - // it to run in any open Capacity Reservation that has matching attributes - // (instance type, platform, Availability Zone). + // The Capacity Reservation targeting option. If you do not specify this + // parameter, the instance's Capacity Reservation preference defaults to open , + // which enables it to run in any open Capacity Reservation that has matching + // attributes (instance type, platform, Availability Zone). CapacityReservationSpecification *LaunchTemplateCapacityReservationSpecificationRequest // The CPU options for the instance. For more information, see Optimizing CPU - // Options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) + // Options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. CpuOptions *LaunchTemplateCpuOptionsRequest @@ -11969,16 +11447,14 @@ type RequestLaunchTemplateData struct { CreditSpecification *CreditSpecificationRequest // Indicates whether to enable the instance for stop protection. For more - // information, see Stop protection - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) + // information, see Stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) // in the Amazon Elastic Compute Cloud User Guide. DisableApiStop *bool - // If you set this parameter to true, you can't terminate the instance using the + // If you set this parameter to true , you can't terminate the instance using the // Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute - // after launch, use ModifyInstanceAttribute - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). - // Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you + // after launch, use ModifyInstanceAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) + // . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you // can terminate the instance by running the shutdown command from the instance. DisableApiTermination *bool @@ -11996,18 +11472,15 @@ type RequestLaunchTemplateData struct { ElasticInferenceAccelerators []LaunchTemplateElasticInferenceAccelerator // Indicates whether the instance is enabled for Amazon Web Services Nitro - // Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? - // (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the - // Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon Web - // Services Nitro Enclaves and hibernation on the same instance. + // Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) + // in the Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon + // Web Services Nitro Enclaves and hibernation on the same instance. EnclaveOptions *LaunchTemplateEnclaveOptionsRequest // Indicates whether an instance is enabled for hibernation. This parameter is - // valid only if the instance meets the hibernation prerequisites - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). - // For more information, see Hibernate your instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon Elastic Compute Cloud User Guide. + // valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html) + // . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) + // in the Amazon Elastic Compute Cloud User Guide. HibernationOptions *LaunchTemplateHibernationOptionsRequest // The name or Amazon Resource Name (ARN) of an IAM instance profile. @@ -12015,21 +11488,11 @@ type RequestLaunchTemplateData struct { // The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, // which will resolve to an AMI ID on launch. Valid formats: - // - // * - // ami-17characters00000 - // - // * resolve:ssm:parameter-name - // - // * - // resolve:ssm:parameter-name:version-number - // - // * - // resolve:ssm:parameter-name:label - // - // For more information, see Use a Systems - // Manager parameter to find an AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) + // - ami-17characters00000 + // - resolve:ssm:parameter-name + // - resolve:ssm:parameter-name:version-number + // - resolve:ssm:parameter-name:label + // For more information, see Use a Systems Manager parameter to find an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) // in the Amazon Elastic Compute Cloud User Guide. ImageId *string @@ -12043,26 +11506,22 @@ type RequestLaunchTemplateData struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with these attributes. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirementsRequest - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. If you specify InstanceType, you can't - // specify InstanceRequirements. + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon Elastic Compute Cloud User Guide. If you specify InstanceType , + // you can't specify InstanceRequirements . InstanceType InstanceType // The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and - // RAM disks. For more information, see User provided kernels - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // RAM disks. For more information, see User provided kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) // in the Amazon Elastic Compute Cloud User Guide. KernelId *string - // The name of the key pair. You can create a key pair using CreateKeyPair - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) - // or ImportKeyPair - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html). - // If you do not specify a key pair, you can't connect to the instance unless you + // The name of the key pair. You can create a key pair using CreateKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) + // or ImportKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html) + // . If you do not specify a key pair, you can't connect to the instance unless you // choose an AMI that is configured to allow users another way to log in. KeyName *string @@ -12073,8 +11532,7 @@ type RequestLaunchTemplateData struct { MaintenanceOptions *LaunchTemplateInstanceMaintenanceOptionsRequest // The metadata options for the instance. For more information, see Instance - // metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon Elastic Compute Cloud User Guide. MetadataOptions *LaunchTemplateInstanceMetadataOptionsRequest @@ -12088,20 +11546,18 @@ type RequestLaunchTemplateData struct { // The placement for the instance. Placement *LaunchTemplatePlacementRequest - // The options for the instance hostname. The default values are inherited from the - // subnet. + // The options for the instance hostname. The default values are inherited from + // the subnet. PrivateDnsNameOptions *LaunchTemplatePrivateDnsNameOptionsRequest - // The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels and - // RAM disks. For more information, see User provided kernels - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) + // The ID of the RAM disk. We recommend that you use PV-GRUB instead of kernels + // and RAM disks. For more information, see User provided kernels (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) // in the Amazon Elastic Compute Cloud User Guide. RamDiskId *string // One or more security group IDs. You can create a security group using - // CreateSecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). - // You cannot specify both a security group ID and security name in the same + // CreateSecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html) + // . You cannot specify both a security group ID and security name in the same // request. SecurityGroupIds []string @@ -12112,39 +11568,25 @@ type RequestLaunchTemplateData struct { // The tags to apply to the resources that are created during instance launch. You // can specify tags for the following resources only: - // - // * Instances - // - // * Volumes - // - // * - // Elastic graphics - // - // * Spot Instance requests - // - // * Network interfaces - // - // To tag a - // resource after it has been created, see CreateTags - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To - // tag the launch template itself, you must use the TagSpecification - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) + // - Instances + // - Volumes + // - Elastic graphics + // - Spot Instance requests + // - Network interfaces + // To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) + // . To tag the launch template itself, you must use the TagSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) // parameter. TagSpecifications []LaunchTemplateTagSpecificationRequest - // The user data to make available to the instance. You must provide base64-encoded - // text. User data is limited to 16 KB. For more information, see Run commands on - // your Linux instance at launch - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or - // Work with instance user data - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) + // The user data to make available to the instance. You must provide + // base64-encoded text. User data is limited to 16 KB. For more information, see + // Run commands on your Linux instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) + // (Linux) or Work with instance user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) // (Windows) in the Amazon Elastic Compute Cloud User Guide. If you are creating // the launch template for use with Batch, the user data must be provided in the - // MIME multi-part archive format - // (https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). - // For more information, see Amazon EC2 user data in launch templates - // (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in - // the Batch User Guide. + // MIME multi-part archive format (https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive) + // . For more information, see Amazon EC2 user data in launch templates (https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) + // in the Batch User Guide. UserData *string noSmithyDocumentSerde @@ -12230,8 +11672,8 @@ type Reservation struct { // The ID of the Amazon Web Services account that owns the reservation. OwnerId *string - // The ID of the requester that launched the instances on your behalf (for example, - // Amazon Web Services Management Console or Auto Scaling). + // The ID of the requester that launched the instances on your behalf (for + // example, Amazon Web Services Management Console or Auto Scaling). RequesterId *string // The ID of the reservation. @@ -12249,10 +11691,10 @@ type ReservationFleetInstanceSpecification struct { // Availability Zone. AvailabilityZone *string - // The ID of the Availability Zone in which the Capacity Reservation Fleet reserves - // the capacity. A Capacity Reservation Fleet can't span Availability Zones. All - // instance type specifications that you specify for the Fleet must use the same - // Availability Zone. + // The ID of the Availability Zone in which the Capacity Reservation Fleet + // reserves the capacity. A Capacity Reservation Fleet can't span Availability + // Zones. All instance type specifications that you specify for the Fleet must use + // the same Availability Zone. AvailabilityZoneId *string // Indicates whether the Capacity Reservation Fleet supports EBS-optimized @@ -12271,9 +11713,8 @@ type ReservationFleetInstanceSpecification struct { // The priority to assign to the instance type. This value is used to determine // which of the instance types specified for the Fleet should be prioritized for - // use. A lower value indicates a high priority. For more information, see Instance - // type priority - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) + // use. A lower value indicates a high priority. For more information, see + // Instance type priority (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) // in the Amazon EC2 User Guide. Priority *int32 @@ -12281,8 +11722,7 @@ type ReservationFleetInstanceSpecification struct { // value, together with the total target capacity that you specify for the Fleet // determine the number of instances for which the Fleet reserves capacity. Both // values are based on units that make sense for your workload. For more - // information, see Total target capacity - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) + // information, see Total target capacity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) // in the Amazon EC2 User Guide. Weight *float64 @@ -12295,8 +11735,8 @@ type ReservationValue struct { // The hourly rate of the reservation. HourlyPrice *string - // The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * - // number of hours remaining). + // The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice + // * number of hours remaining). RemainingTotalValue *string // The remaining upfront cost of the reservation. @@ -12312,8 +11752,8 @@ type ReservedInstanceLimitPrice struct { // the total order (instanceCount * price). Amount *float64 - // The currency in which the limitPrice amount is specified. At this time, the only - // supported currency is USD. + // The currency in which the limitPrice amount is specified. At this time, the + // only supported currency is USD . CurrencyCode CurrencyCodeValues noSmithyDocumentSerde @@ -12338,7 +11778,7 @@ type ReservedInstances struct { AvailabilityZone *string // The currency of the Reserved Instance. It's specified using ISO 4217 standard - // currency codes. At this time, the only supported currency is USD. + // currency codes. At this time, the only supported currency is USD . CurrencyCode CurrencyCodeValues // The duration of the Reserved Instance, in seconds. @@ -12429,8 +11869,8 @@ type ReservedInstancesId struct { type ReservedInstancesListing struct { // A unique, case-sensitive key supplied by the client to ensure that the request - // is idempotent. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // is idempotent. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The time the listing was created. @@ -12451,8 +11891,8 @@ type ReservedInstancesListing struct { // The status of the Reserved Instance listing. Status ListingStatus - // The reason for the current status of the Reserved Instance listing. The response - // can be blank. + // The reason for the current status of the Reserved Instance listing. The + // response can be blank. StatusMessage *string // Any tags assigned to the resource. @@ -12468,8 +11908,8 @@ type ReservedInstancesListing struct { type ReservedInstancesModification struct { // A unique, case-sensitive key supplied by the client to ensure that the request - // is idempotent. For more information, see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // is idempotent. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // The time when the modification request was created. @@ -12522,7 +11962,7 @@ type ReservedInstancesOffering struct { // The currency of the Reserved Instance offering you are purchasing. It's // specified using ISO 4217 standard currency codes. At this time, the only - // supported currency is USD. + // supported currency is USD . CurrencyCode CurrencyCodeValues // The duration of the Reserved Instance, in seconds. @@ -12539,11 +11979,11 @@ type ReservedInstancesOffering struct { // Indicates whether the offering is available through the Reserved Instance // Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance - // Marketplace offering, this is true. + // Marketplace offering, this is true . Marketplace *bool // If convertible it can be exchanged for Reserved Instances of the same or higher - // monetary value, with different configurations. If standard, it is not possible + // monetary value, with different configurations. If standard , it is not possible // to perform an exchange. OfferingClass OfferingClassType @@ -12620,8 +12060,7 @@ type ResponseLaunchTemplateData struct { CapacityReservationSpecification *LaunchTemplateCapacityReservationSpecificationResponse // The CPU options for the instance. For more information, see Optimizing CPU - // options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) + // options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. CpuOptions *LaunchTemplateCpuOptions @@ -12629,12 +12068,11 @@ type ResponseLaunchTemplateData struct { CreditSpecification *CreditSpecification // Indicates whether the instance is enabled for stop protection. For more - // information, see Stop protection - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) + // information, see Stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) // in the Amazon Elastic Compute Cloud User Guide. DisableApiStop *bool - // If set to true, indicates that the instance cannot be terminated using the + // If set to true , indicates that the instance cannot be terminated using the // Amazon EC2 console, command line tool, or API. DisableApiTermination *bool @@ -12652,9 +12090,8 @@ type ResponseLaunchTemplateData struct { EnclaveOptions *LaunchTemplateEnclaveOptions // Indicates whether an instance is configured for hibernation. For more - // information, see Hibernate your instance - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the - // Amazon Elastic Compute Cloud User Guide. + // information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) + // in the Amazon Elastic Compute Cloud User Guide. HibernationOptions *LaunchTemplateHibernationOptions // The IAM instance profile. @@ -12663,21 +12100,13 @@ type ResponseLaunchTemplateData struct { // The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter // will resolve to the ID of the AMI at instance launch. The value depends on what // you specified in the request. The possible values are: - // - // * If an AMI ID was - // specified in the request, then this is the AMI ID. - // - // * If a Systems Manager - // parameter was specified in the request, and ResolveAlias was configured as true, - // then this is the AMI ID that the parameter is mapped to in the Parameter - // Store. - // - // * If a Systems Manager parameter was specified in the request, and - // ResolveAlias was configured as false, then this is the parameter value. - // - // For - // more information, see Use a Systems Manager parameter instead of an AMI ID - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) + // - If an AMI ID was specified in the request, then this is the AMI ID. + // - If a Systems Manager parameter was specified in the request, and + // ResolveAlias was configured as true , then this is the AMI ID that the + // parameter is mapped to in the Parameter Store. + // - If a Systems Manager parameter was specified in the request, and + // ResolveAlias was configured as false , then this is the parameter value. + // For more information, see Use a Systems Manager parameter instead of an AMI ID (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id) // in the Amazon Elastic Compute Cloud User Guide. ImageId *string @@ -12690,7 +12119,7 @@ type ResponseLaunchTemplateData struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with these attributes. If you specify - // InstanceRequirements, you can't specify InstanceTypes. + // InstanceRequirements , you can't specify InstanceTypes . InstanceRequirements *InstanceRequirements // The instance type. @@ -12709,8 +12138,7 @@ type ResponseLaunchTemplateData struct { MaintenanceOptions *LaunchTemplateInstanceMaintenanceOptions // The metadata options for the instance. For more information, see Instance - // metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon Elastic Compute Cloud User Guide. MetadataOptions *LaunchTemplateInstanceMetadataOptions @@ -12785,15 +12213,10 @@ type Route struct { NetworkInterfaceId *string // Describes how the route was created. - // - // * CreateRouteTable - The route was - // automatically created when the route table was created. - // - // * CreateRoute - The - // route was manually added to the route table. - // - // * EnableVgwRoutePropagation - The - // route was propagated by route propagation. + // - CreateRouteTable - The route was automatically created when the route table + // was created. + // - CreateRoute - The route was manually added to the route table. + // - EnableVgwRoutePropagation - The route was propagated by route propagation. Origin RouteOrigin // The state of the route. The blackhole state indicates that the route's target @@ -12892,7 +12315,7 @@ type RuleGroupTypePair struct { // The ARN of the rule group. RuleGroupArn *string - // The rule group type. The possible values are Domain List and Suricata. + // The rule group type. The possible values are Domain List and Suricata . RuleGroupType *string noSmithyDocumentSerde @@ -12913,8 +12336,8 @@ type RuleOption struct { // Describes the monitoring of an instance. type RunInstancesMonitoringEnabled struct { - // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - // enabled. + // Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring + // is enabled. // // This member is required. Enabled *bool @@ -12922,14 +12345,13 @@ type RunInstancesMonitoringEnabled struct { noSmithyDocumentSerde } -// The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. -// For more information, see Categorizing your storage using tags -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) in -// the Amazon Simple Storage Service User Guide. +// The tags to apply to the AMI object that will be stored in the Amazon S3 +// bucket. For more information, see Categorizing your storage using tags (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) +// in the Amazon Simple Storage Service User Guide. type S3ObjectTag struct { // The key of the tag. Constraints: Tag keys are case-sensitive and can be up to - // 128 Unicode characters in length. May not begin with aws:. + // 128 Unicode characters in length. May not begin with aws :. Key *string // The value of the tag. Constraints: Tag values are case-sensitive and can be up @@ -12945,9 +12367,8 @@ type S3Storage struct { // The access key ID of the owner of the bucket. Before you specify a value for // your access key ID, review and follow the guidance in Best Practices for Amazon - // Web Services accounts - // (https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html) in - // the Account ManagementReference Guide. + // Web Services accounts (https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html) + // in the Account ManagementReference Guide. AWSAccessKeyId *string // The bucket in which to store the AMI. You can specify a bucket that you already @@ -12958,8 +12379,8 @@ type S3Storage struct { // The beginning of the file name of the AMI. Prefix *string - // An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into - // Amazon S3 on your behalf. + // An Amazon S3 upload policy that gives Amazon EC2 permission to upload items + // into Amazon S3 on your behalf. UploadPolicy []byte // The signature of the JSON document. @@ -12986,13 +12407,13 @@ type ScheduledInstance struct { // The instance type. InstanceType *string - // The network platform (EC2-Classic or EC2-VPC). + // The network platform ( EC2-Classic or EC2-VPC ). NetworkPlatform *string // The time for the next schedule to start. NextSlotStartTime *time.Time - // The platform (Linux/UNIX or Windows). + // The platform ( Linux/UNIX or Windows ). Platform *string // The time that the previous schedule ended or will end. @@ -13043,10 +12464,10 @@ type ScheduledInstanceAvailability struct { // The minimum term. The only possible value is 365 days. MinTermDurationInDays *int32 - // The network platform (EC2-Classic or EC2-VPC). + // The network platform ( EC2-Classic or EC2-VPC ). NetworkPlatform *string - // The platform (Linux/UNIX or Windows). + // The platform ( Linux/UNIX or Windows ). Platform *string // The purchase token. This token expires in two hours. @@ -13067,10 +12488,10 @@ type ScheduledInstanceAvailability struct { // Describes the recurring schedule for a Scheduled Instance. type ScheduledInstanceRecurrence struct { - // The frequency (Daily, Weekly, or Monthly). + // The frequency ( Daily , Weekly , or Monthly ). Frequency *string - // The interval quantity. The interval unit depends on the value of frequency. For + // The interval quantity. The interval unit depends on the value of frequency . For // example, every 2 weeks or every 2 months. Interval *int32 @@ -13079,11 +12500,11 @@ type ScheduledInstanceRecurrence struct { // Sunday). OccurrenceDaySet []int32 - // Indicates whether the occurrence is relative to the end of the specified week or - // month. + // Indicates whether the occurrence is relative to the end of the specified week + // or month. OccurrenceRelativeToEnd *bool - // The unit for occurrenceDaySet (DayOfWeek or DayOfMonth). + // The unit for occurrenceDaySet ( DayOfWeek or DayOfMonth ). OccurrenceUnit *string noSmithyDocumentSerde @@ -13092,10 +12513,10 @@ type ScheduledInstanceRecurrence struct { // Describes the recurring schedule for a Scheduled Instance. type ScheduledInstanceRecurrenceRequest struct { - // The frequency (Daily, Weekly, or Monthly). + // The frequency ( Daily , Weekly , or Monthly ). Frequency *string - // The interval quantity. The interval unit depends on the value of Frequency. For + // The interval quantity. The interval unit depends on the value of Frequency . For // example, every 2 weeks or every 2 months. Interval *int32 @@ -13105,11 +12526,11 @@ type ScheduledInstanceRecurrenceRequest struct { // is relative to the end of the month, you can specify only a single day. OccurrenceDays []int32 - // Indicates whether the occurrence is relative to the end of the specified week or - // month. You can't specify this value with a daily schedule. + // Indicates whether the occurrence is relative to the end of the specified week + // or month. You can't specify this value with a daily schedule. OccurrenceRelativeToEnd *bool - // The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required + // The unit for OccurrenceDays ( DayOfWeek or DayOfMonth ). This value is required // for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You // can't specify this value with a daily schedule. OccurrenceUnit *string @@ -13120,7 +12541,7 @@ type ScheduledInstanceRecurrenceRequest struct { // Describes a block device mapping for a Scheduled Instance. type ScheduledInstancesBlockDeviceMapping struct { - // The device name (for example, /dev/sdh or xvdh). + // The device name (for example, /dev/sdh or xvdh ). DeviceName *string // Parameters used to set up EBS volumes automatically when the instance is @@ -13130,14 +12551,14 @@ type ScheduledInstancesBlockDeviceMapping struct { // To omit the device from the block device mapping, specify an empty string. NoDevice *string - // The virtual device name (ephemeralN). Instance store volumes are numbered + // The virtual device name ( ephemeral N). Instance store volumes are numbered // starting from 0. An instance type with two available instance store volumes can - // specify mappings for ephemeral0 and ephemeral1. The number of available instance - // store volumes depends on the instance type. After you connect to the instance, - // you must mount the volume. Constraints: For M3 instances, you must specify - // instance store volumes in the block device mapping for the instance. When you - // launch an M3 instance, we ignore any instance store volumes specified in the - // block device mapping for the AMI. + // specify mappings for ephemeral0 and ephemeral1 . The number of available + // instance store volumes depends on the instance type. After you connect to the + // instance, you must mount the volume. Constraints: For M3 instances, you must + // specify instance store volumes in the block device mapping for the instance. + // When you launch an M3 instance, we ignore any instance store volumes specified + // in the block device mapping for the AMI. VirtualName *string noSmithyDocumentSerde @@ -13154,15 +12575,13 @@ type ScheduledInstancesEbs struct { Encrypted *bool // The number of I/O operations per second (IOPS) to provision for an io1 or io2 - // volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. + // volume, with a maximum ratio of 50 IOPS/GiB for io1 , and 500 IOPS/GiB for io2 . // Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 - // is guaranteed only on instances built on the Nitro System - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). - // Other instance families guarantee performance up to 32,000 IOPS. For more - // information, see Amazon EBS volume types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the - // Amazon EC2 User Guide. This parameter is valid only for Provisioned IOPS SSD - // (io1 and io2) volumes. + // is guaranteed only on instances built on the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) + // . Other instance families guarantee performance up to 32,000 IOPS. For more + // information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // in the Amazon EC2 User Guide. This parameter is valid only for Provisioned IOPS + // SSD ( io1 and io2 ) volumes. Iops *int32 // The ID of the snapshot. @@ -13173,7 +12592,7 @@ type ScheduledInstancesEbs struct { VolumeSize *int32 // The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS - // SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for + // SSD, Throughput Optimized HDD for st1 , Cold HDD for sc1 , or standard for // Magnetic. Default: gp2 VolumeType *string @@ -13203,7 +12622,7 @@ type ScheduledInstancesIpv6Address struct { // Describes the launch specification for a Scheduled Instance. If you are // launching the Scheduled Instance in EC2-VPC, you must specify the ID of the -// subnet. You can specify the subnet using either SubnetId or NetworkInterface. +// subnet. You can specify the subnet using either SubnetId or NetworkInterface . type ScheduledInstancesLaunchSpecification struct { // The ID of the Amazon Machine Image (AMI). @@ -13273,7 +12692,7 @@ type ScheduledInstancesNetworkInterface struct { // VPC. The public IPv4 address can only be assigned to a network interface for // eth0, and can only be assigned to a new network interface, not an existing one. // You cannot specify more than one network interface in the request. If launching - // into a default subnet, the default value is true. + // into a default subnet, the default value is true . AssociatePublicIpAddress *bool // Indicates whether to delete the interface when the instance is terminated. @@ -13328,8 +12747,8 @@ type ScheduledInstancesPlacement struct { // Describes a private IPv4 address for a Scheduled Instance. type ScheduledInstancesPrivateIpAddressConfig struct { - // Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary - // IPv4 address. + // Indicates whether this is a primary IPv4 address. Otherwise, this is a + // secondary IPv4 address. Primary *bool // The IPv4 address. @@ -13419,9 +12838,9 @@ type SecurityGroupRule struct { // The ID of the Amazon Web Services account that owns the security group. GroupOwnerId *string - // The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use - // -1 to specify all protocols. + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol + // Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // ). Use -1 to specify all protocols. IpProtocol *string // Indicates whether the security group rule is an outbound rule. @@ -13464,19 +12883,14 @@ type SecurityGroupRuleDescription struct { // Describes a security group rule. You must specify exactly one of the following // parameters, based on the rule type: +// - CidrIpv4 +// - CidrIpv6 +// - PrefixListId +// - ReferencedGroupId // -// * CidrIpv4 -// -// * CidrIpv6 -// -// * PrefixListId -// -// * -// ReferencedGroupId -// -// When you modify a rule, you cannot change the rule type. For -// example, if the rule uses an IPv4 address range, you must use CidrIpv4 to -// specify a new IPv4 address range. +// When you modify a rule, you cannot change the rule type. For example, if the +// rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 +// address range. type SecurityGroupRuleRequest struct { // The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix @@ -13496,9 +12910,9 @@ type SecurityGroupRuleRequest struct { // ICMP/ICMPv6 codes. FromPort *int32 - // The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use - // -1 to specify all protocols. + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol + // Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // ). Use -1 to specify all protocols. IpProtocol *string // The ID of the prefix list. @@ -13610,7 +13024,7 @@ type ServiceDetail struct { PrivateDnsName *string // The verification state of the VPC endpoint service. Consumers of the endpoint - // service cannot use the private name when the state is not verified. + // service cannot use the private name when the state is not verified . PrivateDnsNameVerificationState DnsNameState // The private DNS names assigned to the VPC endpoint service. @@ -13685,7 +13099,7 @@ type Snapshot struct { // the original volume or snapshot copy. Because data encryption keys are inherited // by volumes created from snapshots, and vice versa, if snapshots share the same // data encryption key identifier, then they belong to the same volume/snapshot - // lineage. This parameter is only returned by DescribeSnapshots. + // lineage. This parameter is only returned by DescribeSnapshots . DataEncryptionKeyId *string // The description for the snapshot. @@ -13699,12 +13113,11 @@ type Snapshot struct { KmsKeyId *string // The ARN of the Outpost on which the snapshot is stored. For more information, - // see Amazon EBS local snapshots on Outposts - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) in - // the Amazon Elastic Compute Cloud User Guide. + // see Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) + // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string - // The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). + // The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon ). // This is not the user-configured Amazon Web Services account alias set using the // IAM console. OwnerAlias *string @@ -13733,7 +13146,7 @@ type Snapshot struct { // operation fails (for example, if the proper Key Management Service (KMS) // permissions are not obtained) this field displays error state details to help // you diagnose why the error occurred. This parameter is only returned by - // DescribeSnapshots. + // DescribeSnapshots . StateMessage *string // The storage tier in which the snapshot is stored. standard indicates that the @@ -13822,9 +13235,8 @@ type SnapshotInfo struct { Encrypted *bool // The ARN of the Outpost on which the snapshot is stored. For more information, - // see Amazon EBS local snapshots on Outposts - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) in - // the Amazon Elastic Compute Cloud User Guide. + // see Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html) + // in the Amazon Elastic Compute Cloud User Guide. OutpostArn *string // Account id used when creating this snapshot. @@ -13964,12 +13376,11 @@ type SnapshotTierStatus struct { // The Spot Instance replacement strategy to use when Amazon EC2 emits a signal // that your Spot Instance is at an elevated risk of being interrupted. For more -// information, see Capacity rebalancing -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) +// information, see Capacity rebalancing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) // in the Amazon EC2 User Guide for Linux Instances. type SpotCapacityRebalance struct { - // The replacement strategy to use. Only available for fleets of type maintain. + // The replacement strategy to use. Only available for fleets of type maintain . // launch - Spot Fleet launches a new replacement Spot Instance when a rebalance // notification is emitted for an existing Spot Instance in the fleet. Spot Fleet // does not terminate the instances that receive a rebalance notification. You can @@ -13977,14 +13388,14 @@ type SpotCapacityRebalance struct { // all instances while they are running. launch-before-terminate - Spot Fleet // launches a new replacement Spot Instance when a rebalance notification is // emitted for an existing Spot Instance in the fleet, and then, after a delay that - // you specify (in TerminationDelay), terminates the instances that received a + // you specify (in TerminationDelay ), terminates the instances that received a // rebalance notification. ReplacementStrategy ReplacementStrategy - // The amount of time (in seconds) that Amazon EC2 waits before terminating the old - // Spot Instance after launching a new replacement Spot Instance. Required when - // ReplacementStrategy is set to launch-before-terminate. Not valid when - // ReplacementStrategy is set to launch. Valid values: Minimum value of 120 + // The amount of time (in seconds) that Amazon EC2 waits before terminating the + // old Spot Instance after launching a new replacement Spot Instance. Required when + // ReplacementStrategy is set to launch-before-terminate . Not valid when + // ReplacementStrategy is set to launch . Valid values: Minimum value of 120 // seconds. Maximum value of 7200 seconds. TerminationDelay *int32 @@ -14014,9 +13425,9 @@ type SpotDatafeedSubscription struct { // Describes the launch specification for one or more Spot Instances. If you // include On-Demand capacity in your fleet request or want to specify an EFA -// network device, you can't use SpotFleetLaunchSpecification; you must use -// LaunchTemplateConfig -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html). +// network device, you can't use SpotFleetLaunchSpecification ; you must use +// LaunchTemplateConfig (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) +// . type SpotFleetLaunchSpecification struct { // Deprecated. @@ -14044,7 +13455,7 @@ type SpotFleetLaunchSpecification struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with those attributes. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements // The instance type. @@ -14062,17 +13473,17 @@ type SpotFleetLaunchSpecification struct { // One or more network interfaces. If you specify a network interface, you must // specify subnet IDs and security group IDs using the network interface. // SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter - // (EFA). To specify an EFA, you must use LaunchTemplateConfig - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html). + // (EFA). To specify an EFA, you must use LaunchTemplateConfig (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) + // . NetworkInterfaces []InstanceNetworkInterfaceSpecification // The placement information. Placement *SpotPlacement - // The ID of the RAM disk. Some kernels require additional drivers at launch. Check - // the kernel requirements for information about whether you need to specify a RAM - // disk. To find kernel requirements, refer to the Amazon Web Services Resource - // Center and search for the kernel ID. + // The ID of the RAM disk. Some kernels require additional drivers at launch. + // Check the kernel requirements for information about whether you need to specify + // a RAM disk. To find kernel requirements, refer to the Amazon Web Services + // Resource Center and search for the kernel ID. RamdiskId *string // One or more security groups. When requesting instances in a VPC, you must @@ -14080,11 +13491,11 @@ type SpotFleetLaunchSpecification struct { // EC2-Classic, you can specify the names or the IDs of the security groups. SecurityGroups []GroupIdentifier - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string // The IDs of the subnets in which to launch the instances. To specify multiple @@ -14123,9 +13534,9 @@ type SpotFleetMonitoring struct { type SpotFleetRequestConfig struct { // The progress of the Spot Fleet request. If there is an error, the status is - // error. After all requests are placed, the status is pending_fulfillment. If the - // size of the fleet is equal to or greater than its target capacity, the status is - // fulfilled. If the size of the fleet is decreased, the status is + // error . After all requests are placed, the status is pending_fulfillment . If + // the size of the fleet is equal to or greater than its target capacity, the + // status is fulfilled . If the size of the fleet is decreased, the status is // pending_termination while Spot Instances are terminating. ActivityStatus ActivityStatus @@ -14152,13 +13563,11 @@ type SpotFleetRequestConfigData struct { // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role // that grants the Spot Fleet the permission to request, launch, terminate, and tag - // instances on your behalf. For more information, see Spot Fleet prerequisites - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) + // instances on your behalf. For more information, see Spot Fleet prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) // in the Amazon EC2 User Guide. Spot Fleet can terminate Spot Instances on your - // behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests) + // behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests) // or when the Spot Fleet request expires, if you set - // TerminateInstancesWithExpiration. + // TerminateInstancesWithExpiration . // // This member is required. IamFleetRole *string @@ -14166,7 +13575,7 @@ type SpotFleetRequestConfigData struct { // The number of units to request for the Spot Fleet. You can choose to set the // target capacity in terms of instances or a performance characteristic that is // important to your application workload, such as vCPUs, memory, or I/O. If the - // request type is maintain, you can specify a target capacity of 0 and add + // request type is maintain , you can specify a target capacity of 0 and add // capacity later. // // This member is required. @@ -14174,8 +13583,7 @@ type SpotFleetRequestConfigData struct { // The strategy that determines how to allocate the target Spot Instance capacity // across the Spot Instance pools specified by the Spot Fleet launch configuration. - // For more information, see Allocation strategies for Spot Instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) + // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. priceCapacityOptimized (recommended) Spot Fleet // identifies the pools with the highest capacity availability for the number of // instances that are launching. This means that we will request Spot Instances @@ -14185,13 +13593,13 @@ type SpotFleetRequestConfigData struct { // capacity availability for the number of instances that are launching. This means // that we will request Spot Instances from the pools that we believe have the // lowest chance of interruption in the near term. To give certain instance types a - // higher chance of launching first, use capacityOptimizedPrioritized. Set a + // higher chance of launching first, use capacityOptimizedPrioritized . Set a // priority for each instance type by using the Priority parameter for - // LaunchTemplateOverrides. You can assign the same priority to different - // LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, - // but optimizes for capacity first. capacityOptimizedPrioritized is supported only - // if your Spot Fleet uses a launch template. Note that if the - // OnDemandAllocationStrategy is set to prioritized, the same priority is applied + // LaunchTemplateOverrides . You can assign the same priority to different + // LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, + // but optimizes for capacity first. capacityOptimizedPrioritized is supported + // only if your Spot Fleet uses a launch template. Note that if the + // OnDemandAllocationStrategy is set to prioritized , the same priority is applied // when fulfilling On-Demand capacity. diversified Spot Fleet requests instances // from all of the Spot Instance pools that you specify. lowestPrice Spot Fleet // requests instances from the lowest priced Spot Instance pool that has available @@ -14207,8 +13615,8 @@ type SpotFleetRequestConfigData struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of your listings. This helps to avoid duplicate listings. For more information, - // see Ensuring Idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). + // see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // . ClientToken *string // Reserved. @@ -14216,18 +13624,18 @@ type SpotFleetRequestConfigData struct { // Indicates whether running instances should be terminated if you decrease the // target capacity of the Spot Fleet request below the current size of the Spot - // Fleet. Supported only for fleets of type maintain. + // Fleet. Supported only for fleets of type maintain . ExcessCapacityTerminationPolicy ExcessCapacityTerminationPolicy // The number of units fulfilled by this request compared to the set target // capacity. You cannot set this value. FulfilledCapacity *float64 - // The behavior when a Spot Instance is interrupted. The default is terminate. + // The behavior when a Spot Instance is interrupted. The default is terminate . InstanceInterruptionBehavior InstanceInterruptionBehavior // The number of Spot pools across which to allocate your target Spot capacity. - // Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet + // Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet // selects the cheapest Spot pools and evenly allocates your target Spot capacity // across the number of Spot pools that you specify. Note that Spot Fleet attempts // to draw Spot Instances from the number of pools that you specify on a best @@ -14240,28 +13648,28 @@ type SpotFleetRequestConfigData struct { InstancePoolsToUseCount *int32 // The launch specifications for the Spot Fleet request. If you specify - // LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include - // On-Demand capacity in your request, you must use LaunchTemplateConfigs. + // LaunchSpecifications , you can't specify LaunchTemplateConfigs . If you include + // On-Demand capacity in your request, you must use LaunchTemplateConfigs . LaunchSpecifications []SpotFleetLaunchSpecification - // The launch template and overrides. If you specify LaunchTemplateConfigs, you - // can't specify LaunchSpecifications. If you include On-Demand capacity in your - // request, you must use LaunchTemplateConfigs. + // The launch template and overrides. If you specify LaunchTemplateConfigs , you + // can't specify LaunchSpecifications . If you include On-Demand capacity in your + // request, you must use LaunchTemplateConfigs . LaunchTemplateConfigs []LaunchTemplateConfig - // One or more Classic Load Balancers and target groups to attach to the Spot Fleet - // request. Spot Fleet registers the running Spot Instances with the specified - // Classic Load Balancers and target groups. With Network Load Balancers, Spot - // Fleet cannot register instances that have the following instance types: C1, CC1, - // CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. + // One or more Classic Load Balancers and target groups to attach to the Spot + // Fleet request. Spot Fleet registers the running Spot Instances with the + // specified Classic Load Balancers and target groups. With Network Load Balancers, + // Spot Fleet cannot register instances that have the following instance types: C1, + // CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. LoadBalancersConfig *LoadBalancersConfig // The order of the launch template overrides to use in fulfilling On-Demand - // capacity. If you specify lowestPrice, Spot Fleet uses price to determine the - // order, launching the lowest price first. If you specify prioritized, Spot Fleet + // capacity. If you specify lowestPrice , Spot Fleet uses price to determine the + // order, launching the lowest price first. If you specify prioritized , Spot Fleet // uses the priority that you assign to each Spot Fleet launch template override, // launching the highest priority first. If you do not specify a value, Spot Fleet - // defaults to lowestPrice. + // defaults to lowestPrice . OnDemandAllocationStrategy OnDemandAllocationStrategy // The number of On-Demand units fulfilled by this request compared to the set @@ -14281,7 +13689,7 @@ type SpotFleetRequestConfigData struct { // The number of On-Demand units to request. You can choose to set the target // capacity in terms of instances or a performance characteristic that is important // to your application workload, such as vCPUs, memory, or I/O. If the request type - // is maintain, you can specify a target capacity of 0 and add capacity later. + // is maintain , you can specify a target capacity of 0 and add capacity later. OnDemandTargetCapacity *int32 // Indicates whether Spot Fleet should replace unhealthy instances. @@ -14301,23 +13709,21 @@ type SpotFleetRequestConfigData struct { // target capacity. SpotMaxTotalPrice *string - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string - // The key-value pair for tagging the Spot Fleet request on creation. The value for - // ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. - // To tag instances at launch, specify the tags in the launch template - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) - // (valid only if you use LaunchTemplateConfigs) or in the - // SpotFleetTagSpecification - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) - // (valid only if you use LaunchSpecifications). For information about tagging - // after launch, see Tagging Your Resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). + // The key-value pair for tagging the Spot Fleet request on creation. The value + // for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request + // fails. To tag instances at launch, specify the tags in the launch template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) + // (valid only if you use LaunchTemplateConfigs ) or in the + // SpotFleetTagSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) + // (valid only if you use LaunchSpecifications ). For information about tagging + // after launch, see Tagging Your Resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) + // . TagSpecifications []TagSpecification // The unit for the target capacity. TargetCapacityUnitType can only be specified @@ -14330,17 +13736,17 @@ type SpotFleetRequestConfigData struct { TerminateInstancesWithExpiration *bool // The type of request. Indicates whether the Spot Fleet only requests the target - // capacity or also attempts to maintain it. When this value is request, the Spot + // capacity or also attempts to maintain it. When this value is request , the Spot // Fleet only places the required requests. It does not attempt to replenish Spot // Instances if capacity is diminished, nor does it submit requests in alternative - // Spot pools if capacity is not available. When this value is maintain, the Spot + // Spot pools if capacity is not available. When this value is maintain , the Spot // Fleet maintains the target capacity. The Spot Fleet places the required requests // to meet capacity and automatically replenishes any interrupted instances. - // Default: maintain. instant is listed but is not used by Spot Fleet. + // Default: maintain . instant is listed but is not used by Spot Fleet. Type FleetType - // The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By - // default, Amazon EC2 starts fulfilling the request immediately. + // The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). + // By default, Amazon EC2 starts fulfilling the request immediately. ValidFrom *time.Time // The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). @@ -14356,9 +13762,9 @@ type SpotFleetRequestConfigData struct { type SpotFleetTagSpecification struct { // The type of resource. Currently, the only resource type that is supported is - // instance. To tag the Spot Fleet request on creation, use the TagSpecifications - // parameter in SpotFleetRequestConfigData - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html). + // instance . To tag the Spot Fleet request on creation, use the TagSpecifications + // parameter in SpotFleetRequestConfigData (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) + // . ResourceType ResourceType // The tags. @@ -14373,16 +13779,16 @@ type SpotInstanceRequest struct { // Deprecated. ActualBlockHourlyPrice *string - // The Availability Zone group. If you specify the same Availability Zone group for - // all Spot Instance requests, all Spot Instances are launched in the same + // The Availability Zone group. If you specify the same Availability Zone group + // for all Spot Instance requests, all Spot Instances are launched in the same // Availability Zone. AvailabilityZoneGroup *string // Deprecated. BlockDurationMinutes *int32 - // The date and time when the Spot Instance request was created, in UTC format (for - // example, YYYY-MM-DDTHH:MM:SSZ). + // The date and time when the Spot Instance request was created, in UTC format + // (for example, YYYY-MM-DDTHH:MM:SSZ). CreateTime *time.Time // The fault codes for the Spot Instance request, if any. @@ -14395,8 +13801,8 @@ type SpotInstanceRequest struct { // The behavior when a Spot Instance is interrupted. InstanceInterruptionBehavior InstanceInterruptionBehavior - // The instance launch group. Launch groups are Spot Instances that launch together - // and terminate together. + // The instance launch group. Launch groups are Spot Instances that launch + // together and terminate together. LaunchGroup *string // Additional information for launching instances. @@ -14411,16 +13817,15 @@ type SpotInstanceRequest struct { // The ID of the Spot Instance request. SpotInstanceRequestId *string - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string // The state of the Spot Instance request. Spot request status information helps - // track your Spot Instance requests. For more information, see Spot request status - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html) + // track your Spot Instance requests. For more information, see Spot request status (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html) // in the Amazon EC2 User Guide for Linux Instances. State SpotInstanceState @@ -14438,15 +13843,13 @@ type SpotInstanceRequest struct { ValidFrom *time.Time // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). - // - // * For a - // persistent request, the request remains active until the validUntil date and - // time is reached. Otherwise, the request remains active until you cancel it. - // - // * - // For a one-time request, the request remains active until all instances launch, - // the request is canceled, or the validUntil date and time is reached. By default, - // the request is valid for 7 days from the date the request was created. + // - For a persistent request, the request remains active until the validUntil + // date and time is reached. Otherwise, the request remains active until you cancel + // it. + // - For a one-time request, the request remains active until all instances + // launch, the request is canceled, or the validUntil date and time is reached. + // By default, the request is valid for 7 days from the date the request was + // created. ValidUntil *time.Time noSmithyDocumentSerde @@ -14467,8 +13870,7 @@ type SpotInstanceStateFault struct { // Describes the status of a Spot Instance request. type SpotInstanceStatus struct { - // The status code. For a list of status codes, see Spot request status codes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand) + // The status code. For a list of status codes, see Spot request status codes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand) // in the Amazon EC2 User Guide for Linux Instances. Code *string @@ -14488,8 +13890,7 @@ type SpotMaintenanceStrategies struct { // The Spot Instance replacement strategy to use when Amazon EC2 emits a signal // that your Spot Instance is at an elevated risk of being interrupted. For more - // information, see Capacity rebalancing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) + // information, see Capacity rebalancing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) // in the Amazon EC2 User Guide for Linux Instances. CapacityRebalance *SpotCapacityRebalance @@ -14502,7 +13903,7 @@ type SpotMarketOptions struct { // Deprecated. BlockDurationMinutes *int32 - // The behavior when a Spot Instance is interrupted. The default is terminate. + // The behavior when a Spot Instance is interrupted. The default is terminate . InstanceInterruptionBehavior InstanceInterruptionBehavior // The maximum hourly price that you're willing to pay for a Spot Instance. We do @@ -14512,22 +13913,18 @@ type SpotMarketOptions struct { // interrupted more frequently than if you do not specify this parameter. MaxPrice *string - // The Spot Instance request type. For RunInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances), - // persistent Spot Instance requests are only supported when the instance - // interruption behavior is either hibernate or stop. + // The Spot Instance request type. For RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances) + // , persistent Spot Instance requests are only supported when the instance + // interruption behavior is either hibernate or stop . SpotInstanceType SpotInstanceType // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported // only for persistent requests. - // - // * For a persistent request, the request remains - // active until the ValidUntil date and time is reached. Otherwise, the request - // remains active until you cancel it. - // - // * For a one-time request, ValidUntil is not - // supported. The request remains active until all instances launch or you cancel - // the request. + // - For a persistent request, the request remains active until the ValidUntil + // date and time is reached. Otherwise, the request remains active until you cancel + // it. + // - For a one-time request, ValidUntil is not supported. The request remains + // active until all instances launch or you cancel the request. ValidUntil *time.Time noSmithyDocumentSerde @@ -14538,8 +13935,7 @@ type SpotOptions struct { // The strategy that determines how to allocate the target Spot Instance capacity // across the Spot Instance pools specified by the EC2 Fleet launch configuration. - // For more information, see Allocation strategies for Spot Instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) + // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. price-capacity-optimized (recommended) EC2 Fleet // identifies the pools with the highest capacity availability for the number of // instances that are launching. This means that we will request Spot Instances @@ -14549,13 +13945,13 @@ type SpotOptions struct { // capacity availability for the number of instances that are launching. This means // that we will request Spot Instances from the pools that we believe have the // lowest chance of interruption in the near term. To give certain instance types a - // higher chance of launching first, use capacity-optimized-prioritized. Set a + // higher chance of launching first, use capacity-optimized-prioritized . Set a // priority for each instance type by using the Priority parameter for - // LaunchTemplateOverrides. You can assign the same priority to different - // LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, + // LaunchTemplateOverrides . You can assign the same priority to different + // LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, // but optimizes for capacity first. capacity-optimized-prioritized is supported // only if your EC2 Fleet uses a launch template. Note that if the On-Demand - // AllocationStrategy is set to prioritized, the same priority is applied when + // AllocationStrategy is set to prioritized , the same priority is applied when // fulfilling On-Demand capacity. diversified EC2 Fleet requests instances from all // of the Spot Instance pools that you specify. lowest-price EC2 Fleet requests // instances from the lowest priced Spot Instance pool that has available capacity. @@ -14573,24 +13969,24 @@ type SpotOptions struct { InstanceInterruptionBehavior SpotInstanceInterruptionBehavior // The number of Spot pools across which to allocate your target Spot capacity. - // Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects - // the cheapest Spot pools and evenly allocates your target Spot capacity across - // the number of Spot pools that you specify. Note that EC2 Fleet attempts to draw - // Spot Instances from the number of pools that you specify on a best effort basis. - // If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 - // Fleet will continue to fulfill your request by drawing from the next cheapest - // pool. To ensure that your target capacity is met, you might receive Spot - // Instances from more than the number of pools that you specified. Similarly, if - // most of the pools have no Spot capacity, you might receive your full target - // capacity from fewer than the number of pools that you specified. + // Supported only when AllocationStrategy is set to lowest-price . EC2 Fleet + // selects the cheapest Spot pools and evenly allocates your target Spot capacity + // across the number of Spot pools that you specify. Note that EC2 Fleet attempts + // to draw Spot Instances from the number of pools that you specify on a best + // effort basis. If a pool runs out of Spot capacity before fulfilling your target + // capacity, EC2 Fleet will continue to fulfill your request by drawing from the + // next cheapest pool. To ensure that your target capacity is met, you might + // receive Spot Instances from more than the number of pools that you specified. + // Similarly, if most of the pools have no Spot capacity, you might receive your + // full target capacity from fewer than the number of pools that you specified. InstancePoolsToUseCount *int32 // The strategies for managing your workloads on your Spot Instances that will be // interrupted. Currently only the capacity rebalance strategy is available. MaintenanceStrategies *FleetSpotMaintenanceStrategies - // The maximum amount per hour for Spot Instances that you're willing to pay. We do - // not recommend using this parameter because it can lead to increased + // The maximum amount per hour for Spot Instances that you're willing to pay. We + // do not recommend using this parameter because it can lead to increased // interruptions. If you do not specify this parameter, you will pay the current // Spot price. If you specify a maximum price, your Spot Instances will be // interrupted more frequently than if you do not specify this parameter. @@ -14598,16 +13994,16 @@ type SpotOptions struct { // The minimum target capacity for Spot Instances in the fleet. If the minimum // target capacity is not reached, the fleet launches no instances. Supported only - // for fleets of type instant. At least one of the following must be specified: + // for fleets of type instant . At least one of the following must be specified: // SingleAvailabilityZone | SingleInstanceType MinTargetCapacity *int32 // Indicates that the fleet launches all Spot Instances into a single Availability - // Zone. Supported only for fleets of type instant. + // Zone. Supported only for fleets of type instant . SingleAvailabilityZone *bool // Indicates that the fleet uses a single instance type to launch all Spot - // Instances in the fleet. Supported only for fleets of type instant. + // Instances in the fleet. Supported only for fleets of type instant . SingleInstanceType *bool noSmithyDocumentSerde @@ -14618,8 +14014,7 @@ type SpotOptionsRequest struct { // The strategy that determines how to allocate the target Spot Instance capacity // across the Spot Instance pools specified by the EC2 Fleet launch configuration. - // For more information, see Allocation strategies for Spot Instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) + // For more information, see Allocation strategies for Spot Instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) // in the Amazon EC2 User Guide. price-capacity-optimized (recommended) EC2 Fleet // identifies the pools with the highest capacity availability for the number of // instances that are launching. This means that we will request Spot Instances @@ -14629,13 +14024,13 @@ type SpotOptionsRequest struct { // capacity availability for the number of instances that are launching. This means // that we will request Spot Instances from the pools that we believe have the // lowest chance of interruption in the near term. To give certain instance types a - // higher chance of launching first, use capacity-optimized-prioritized. Set a + // higher chance of launching first, use capacity-optimized-prioritized . Set a // priority for each instance type by using the Priority parameter for - // LaunchTemplateOverrides. You can assign the same priority to different - // LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, + // LaunchTemplateOverrides . You can assign the same priority to different + // LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, // but optimizes for capacity first. capacity-optimized-prioritized is supported // only if your EC2 Fleet uses a launch template. Note that if the On-Demand - // AllocationStrategy is set to prioritized, the same priority is applied when + // AllocationStrategy is set to prioritized , the same priority is applied when // fulfilling On-Demand capacity. diversified EC2 Fleet requests instances from all // of the Spot Instance pools that you specify. lowest-price EC2 Fleet requests // instances from the lowest priced Spot Instance pool that has available capacity. @@ -14653,7 +14048,7 @@ type SpotOptionsRequest struct { InstanceInterruptionBehavior SpotInstanceInterruptionBehavior // The number of Spot pools across which to allocate your target Spot capacity. - // Supported only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet + // Supported only when Spot AllocationStrategy is set to lowest-price . EC2 Fleet // selects the cheapest Spot pools and evenly allocates your target Spot capacity // across the number of Spot pools that you specify. Note that EC2 Fleet attempts // to draw Spot Instances from the number of pools that you specify on a best @@ -14669,8 +14064,8 @@ type SpotOptionsRequest struct { // being interrupted. MaintenanceStrategies *FleetSpotMaintenanceStrategiesRequest - // The maximum amount per hour for Spot Instances that you're willing to pay. We do - // not recommend using this parameter because it can lead to increased + // The maximum amount per hour for Spot Instances that you're willing to pay. We + // do not recommend using this parameter because it can lead to increased // interruptions. If you do not specify this parameter, you will pay the current // Spot price. If you specify a maximum price, your Spot Instances will be // interrupted more frequently than if you do not specify this parameter. @@ -14678,16 +14073,16 @@ type SpotOptionsRequest struct { // The minimum target capacity for Spot Instances in the fleet. If the minimum // target capacity is not reached, the fleet launches no instances. Supported only - // for fleets of type instant. At least one of the following must be specified: + // for fleets of type instant . At least one of the following must be specified: // SingleAvailabilityZone | SingleInstanceType MinTargetCapacity *int32 // Indicates that the fleet launches all Spot Instances into a single Availability - // Zone. Supported only for fleets of type instant. + // Zone. Supported only for fleets of type instant . SingleAvailabilityZone *bool // Indicates that the fleet uses a single instance type to launch all Spot - // Instances in the fleet. Supported only for fleets of type instant. + // Instances in the fleet. Supported only for fleets of type instant . SingleInstanceType *bool noSmithyDocumentSerde @@ -14696,8 +14091,8 @@ type SpotOptionsRequest struct { // Describes Spot Instance placement. type SpotPlacement struct { - // The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, - // separate them using commas; for example, "us-west-2a, us-west-2b". + // The Availability Zone. [Spot Fleet only] To specify multiple Availability + // Zones, separate them using commas; for example, "us-west-2a, us-west-2b". AvailabilityZone *string // The name of the placement group. @@ -14723,19 +14118,19 @@ type SpotPlacementScore struct { // The Region. Region *string - // The placement score, on a scale from 1 to 10. A score of 10 indicates that your - // Spot request is highly likely to succeed in this Region or Availability Zone. A - // score of 1 indicates that your Spot request is not likely to succeed. + // The placement score, on a scale from 1 to 10 . A score of 10 indicates that + // your Spot request is highly likely to succeed in this Region or Availability + // Zone. A score of 1 indicates that your Spot request is not likely to succeed. Score *int32 noSmithyDocumentSerde } -// The maximum price per unit hour that you are willing to pay for a Spot Instance. -// We do not recommend using this parameter because it can lead to increased -// interruptions. If you do not specify this parameter, you will pay the current -// Spot price. If you specify a maximum price, your instances will be interrupted -// more frequently than if you do not specify this parameter. +// The maximum price per unit hour that you are willing to pay for a Spot +// Instance. We do not recommend using this parameter because it can lead to +// increased interruptions. If you do not specify this parameter, you will pay the +// current Spot price. If you specify a maximum price, your instances will be +// interrupted more frequently than if you do not specify this parameter. type SpotPrice struct { // The Availability Zone. @@ -14747,11 +14142,11 @@ type SpotPrice struct { // A general description of the AMI. ProductDescription RIProductDescription - // The maximum price per unit hour that you are willing to pay for a Spot Instance. - // We do not recommend using this parameter because it can lead to increased - // interruptions. If you do not specify this parameter, you will pay the current - // Spot price. If you specify a maximum price, your instances will be interrupted - // more frequently than if you do not specify this parameter. + // The maximum price per unit hour that you are willing to pay for a Spot + // Instance. We do not recommend using this parameter because it can lead to + // increased interruptions. If you do not specify this parameter, you will pay the + // current Spot price. If you specify a maximum price, your instances will be + // interrupted more frequently than if you do not specify this parameter. SpotPrice *string // The date and time the request was created, in UTC format (for example, @@ -14768,8 +14163,9 @@ type StaleIpPermission struct { // number. A value of -1 indicates all ICMP types. FromPort *int32 - // The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers) - // (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + // The IP protocol name (for tcp , udp , and icmp ) or number (see Protocol + // Numbers) (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // . IpProtocol *string // The IP ranges. Not applicable for stale security group rules. @@ -14778,8 +14174,8 @@ type StaleIpPermission struct { // The prefix list IDs. Not applicable for stale security group rules. PrefixListIds []string - // The end of the port range for the TCP and UDP protocols, or an ICMP type number. - // A value of -1 indicates all ICMP types. + // The end of the port range for the TCP and UDP protocols, or an ICMP type + // number. A value of -1 indicates all ICMP types. ToPort *int32 // The security group pairs. Returns the ID of the referenced security group and @@ -14820,49 +14216,31 @@ type StateReason struct { Code *string // The message for the state change. - // - // * Server.InsufficientInstanceCapacity: There - // was insufficient capacity available to satisfy the launch request. - // - // * - // Server.InternalError: An internal error caused the instance to terminate during - // launch. - // - // * Server.ScheduledStop: The instance was stopped due to a scheduled - // retirement. - // - // * Server.SpotInstanceShutdown: The instance was stopped because the - // number of Spot requests with a maximum price equal to or higher than the Spot - // price exceeded available capacity or because of an increase in the Spot - // price. - // - // * Server.SpotInstanceTermination: The instance was terminated because - // the number of Spot requests with a maximum price equal to or higher than the - // Spot price exceeded available capacity or because of an increase in the Spot - // price. - // - // * Client.InstanceInitiatedShutdown: The instance was shut down using the - // shutdown -h command from the instance. - // - // * Client.InstanceTerminated: The - // instance was terminated or rebooted during AMI creation. - // - // * - // Client.InternalError: A client error caused the instance to terminate during - // launch. - // - // * Client.InvalidSnapshot.NotFound: The specified snapshot was not - // found. - // - // * Client.UserInitiatedHibernate: Hibernation was initiated on the - // instance. - // - // * Client.UserInitiatedShutdown: The instance was shut down using the - // Amazon EC2 API. - // - // * Client.VolumeLimitExceeded: The limit on the number of EBS - // volumes or total storage was exceeded. Decrease usage or request an increase in - // your account limits. + // - Server.InsufficientInstanceCapacity : There was insufficient capacity + // available to satisfy the launch request. + // - Server.InternalError : An internal error caused the instance to terminate + // during launch. + // - Server.ScheduledStop : The instance was stopped due to a scheduled + // retirement. + // - Server.SpotInstanceShutdown : The instance was stopped because the number of + // Spot requests with a maximum price equal to or higher than the Spot price + // exceeded available capacity or because of an increase in the Spot price. + // - Server.SpotInstanceTermination : The instance was terminated because the + // number of Spot requests with a maximum price equal to or higher than the Spot + // price exceeded available capacity or because of an increase in the Spot price. + // - Client.InstanceInitiatedShutdown : The instance was shut down using the + // shutdown -h command from the instance. + // - Client.InstanceTerminated : The instance was terminated or rebooted during + // AMI creation. + // - Client.InternalError : A client error caused the instance to terminate + // during launch. + // - Client.InvalidSnapshot.NotFound : The specified snapshot was not found. + // - Client.UserInitiatedHibernate : Hibernation was initiated on the instance. + // - Client.UserInitiatedShutdown : The instance was shut down using the Amazon + // EC2 API. + // - Client.VolumeLimitExceeded : The limit on the number of EBS volumes or total + // storage was exceeded. Decrease usage or request an increase in your account + // limits. Message *string noSmithyDocumentSerde @@ -14908,7 +14286,7 @@ type StoreImageTaskResult struct { // succeeds, null is returned. StoreTaskFailureReason *string - // The state of the store task (InProgress, Completed, or Failed). + // The state of the store task ( InProgress , Completed , or Failed ). StoreTaskState *string // The time the task started. @@ -14921,7 +14299,7 @@ type StoreImageTaskResult struct { type Subnet struct { // Indicates whether a network interface created in this subnet (including a - // network interface created by RunInstances) receives an IPv6 address. + // network interface created by RunInstances ) receives an IPv6 address. AssignIpv6AddressOnCreation *bool // The Availability Zone of the subnet. @@ -14959,7 +14337,7 @@ type Subnet struct { Ipv6Native *bool // Indicates whether a network interface created in this subnet (including a - // network interface created by RunInstances) receives a customer-owned IPv4 + // network interface created by RunInstances ) receives a customer-owned IPv4 // address. MapCustomerOwnedIpOnLaunch *bool @@ -15065,7 +14443,7 @@ type SubnetIpv6CidrBlockAssociation struct { type Subscription struct { // The Region or Availability Zone that's the target for the subscription. For - // example, eu-west-1. + // example, eu-west-1 . Destination *string // The metric used for the subscription. @@ -15075,7 +14453,7 @@ type Subscription struct { Period PeriodType // The Region or Availability Zone that's the source for the subscription. For - // example, us-east-1. + // example, us-east-1 . Source *string // The statistic used for the subscription. @@ -15107,7 +14485,7 @@ type SuccessfulQueuedPurchaseDeletion struct { type Tag struct { // The key of the tag. Constraints: Tag keys are case-sensitive and accept a - // maximum of 127 Unicode characters. May not begin with aws:. + // maximum of 127 Unicode characters. May not begin with aws: . Key *string // The value of the tag. Constraints: Tag values are case-sensitive and accept a @@ -15155,29 +14533,28 @@ type TagSpecification struct { // The number of units to request. You can choose to set the target capacity in // terms of instances or a performance characteristic that is important to your // application workload, such as vCPUs, memory, or I/O. If the request type is -// maintain, you can specify a target capacity of 0 and add capacity later. You can -// use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance -// MaxTotalPrice, or both to ensure that your fleet cost does not exceed your +// maintain , you can specify a target capacity of 0 and add capacity later. You +// can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance +// MaxTotalPrice , or both to ensure that your fleet cost does not exceed your // budget. If you set a maximum price per hour for the On-Demand Instances and Spot // Instances in your request, EC2 Fleet will launch instances until it reaches the // maximum amount that you're willing to pay. When the maximum amount you're // willing to pay is reached, the fleet stops launching instances even if it hasn’t // met the target capacity. The MaxTotalPrice parameters are located in -// OnDemandOptions -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html) -// and SpotOptions -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions). +// OnDemandOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html) +// and SpotOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions) +// . type TargetCapacitySpecification struct { - // The default TotalTargetCapacity, which is either Spot or On-Demand. + // The default TotalTargetCapacity , which is either Spot or On-Demand . DefaultTargetCapacityType DefaultTargetCapacityType // The number of On-Demand units to request. If you specify a target capacity for // Spot units, you cannot specify a target capacity for On-Demand units. OnDemandTargetCapacity *int32 - // The maximum number of Spot units to launch. If you specify a target capacity for - // On-Demand units, you cannot specify a target capacity for Spot units. + // The maximum number of Spot units to launch. If you specify a target capacity + // for On-Demand units, you cannot specify a target capacity for Spot units. SpotTargetCapacity *int32 // The unit for the target capacity. TargetCapacityUnitType can only be specified @@ -15185,16 +14562,16 @@ type TargetCapacitySpecification struct { // instances) TargetCapacityUnitType TargetCapacityUnitType - // The number of units to request, filled using DefaultTargetCapacityType. + // The number of units to request, filled using DefaultTargetCapacityType . TotalTargetCapacity *int32 noSmithyDocumentSerde } -// The number of units to request. You can choose to set the target capacity as the -// number of instances. Or you can set the target capacity to a performance +// The number of units to request. You can choose to set the target capacity as +// the number of instances. Or you can set the target capacity to a performance // characteristic that is important to your application workload, such as vCPUs, -// memory, or I/O. If the request type is maintain, you can specify a target +// memory, or I/O. If the request type is maintain , you can specify a target // capacity of 0 and add capacity later. You can use the On-Demand Instance // MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both // parameters to ensure that your fleet cost does not exceed your budget. If you @@ -15202,18 +14579,17 @@ type TargetCapacitySpecification struct { // your request, EC2 Fleet will launch instances until it reaches the maximum // amount that you're willing to pay. When the maximum amount you're willing to pay // is reached, the fleet stops launching instances even if it hasn’t met the target -// capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest) -// and SpotOptionsRequest -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest). +// capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest) +// and SpotOptionsRequest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest) +// . type TargetCapacitySpecificationRequest struct { - // The number of units to request, filled using DefaultTargetCapacityType. + // The number of units to request, filled using DefaultTargetCapacityType . // // This member is required. TotalTargetCapacity *int32 - // The default TotalTargetCapacity, which is either Spot or On-Demand. + // The default TotalTargetCapacity , which is either Spot or On-Demand . DefaultTargetCapacityType DefaultTargetCapacityType // The number of On-Demand units to request. @@ -15304,9 +14680,9 @@ type TargetNetwork struct { // The total value of the new Convertible Reserved Instances. type TargetReservationValue struct { - // The total value of the Convertible Reserved Instances that make up the exchange. - // This is the sum of the list value, remaining upfront price, and additional - // upfront cost of the exchange. + // The total value of the Convertible Reserved Instances that make up the + // exchange. This is the sum of the list value, remaining upfront price, and + // additional upfront cost of the exchange. ReservationValue *ReservationValue // The configuration of the Convertible Reserved Instances that make up the @@ -15459,8 +14835,8 @@ type TrafficMirrorPortRange struct { // Information about the Traffic Mirror filter rule port range. type TrafficMirrorPortRangeRequest struct { - // The first port in the Traffic Mirror port range. This applies to the TCP and UDP - // protocols. + // The first port in the Traffic Mirror port range. This applies to the TCP and + // UDP protocols. FromPort *int32 // The last port in the Traffic Mirror port range. This applies to the TCP and UDP @@ -15902,7 +15278,7 @@ type TransitGatewayMulticastGroup struct { // Indicates that the resource is a transit gateway multicast group member. GroupSource *bool - // The member type (for example, static). + // The member type (for example, static ). MemberType MembershipType // The ID of the transit gateway attachment. @@ -16038,8 +15414,8 @@ type TransitGatewayPeeringAttachment struct { // Describes dynamic routing for the transit gateway peering attachment. type TransitGatewayPeeringAttachmentOptions struct { - // Describes whether dynamic routing is enabled or disabled for the transit gateway - // peering attachment. + // Describes whether dynamic routing is enabled or disabled for the transit + // gateway peering attachment. DynamicRouting DynamicRoutingValue noSmithyDocumentSerde @@ -16208,7 +15584,7 @@ type TransitGatewayRequestOptions struct { // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. // The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for - // 32-bit ASNs. The default is 64512. + // 32-bit ASNs. The default is 64512 . AmazonSideAsn *int64 // Enable or disable automatic acceptance of attachment requests. Disabled by @@ -16229,8 +15605,8 @@ type TransitGatewayRequestOptions struct { // Indicates whether multicast is enabled on the transit gateway MulticastSupport MulticastSupportValue - // One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 - // CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6. + // One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size + // /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6. TransitGatewayCidrBlocks []string // Enable or disable Equal Cost Multipath Protocol support. Enabled by default. @@ -16405,10 +15781,8 @@ type TransitGatewayRouteTableRoute struct { ResourceType *string // The route origin. The following are the possible values: - // - // * static - // - // * propagated + // - static + // - propagated RouteOrigin *string // The state of the route. @@ -16466,9 +15840,9 @@ type TransitGatewayVpcAttachmentOptions struct { noSmithyDocumentSerde } -// Currently available in limited preview only. If you are interested in using this -// feature, contact your account manager. Information about an association between -// a branch network interface with a trunk network interface. +// Currently available in limited preview only. If you are interested in using +// this feature, contact your account manager. Information about an association +// between a branch network interface with a trunk network interface. type TrunkInterfaceAssociation struct { // The ID of the association. @@ -16480,7 +15854,7 @@ type TrunkInterfaceAssociation struct { // The application key when you use the GRE protocol. GreKey *int32 - // The interface protocol. Valid values are VLAN and GRE. + // The interface protocol. Valid values are VLAN and GRE . InterfaceProtocol InterfaceProtocolType // The tags for the trunk interface association. @@ -16546,8 +15920,8 @@ type TunnelOption struct { // The lifetime for phase 2 of the IKE negotiation, in seconds. Phase2LifetimeSeconds *int32 - // The pre-shared key (PSK) to establish initial authentication between the virtual - // private gateway and the customer gateway. + // The pre-shared key (PSK) to establish initial authentication between the + // virtual private gateway and the customer gateway. PreSharedKey *string // The percentage of the rekey window determined by RekeyMarginTimeSeconds during @@ -16613,8 +15987,8 @@ type UnsuccessfulItem struct { } // Information about the error that occurred. For more information about errors, -// see Error codes -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html). +// see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) +// . type UnsuccessfulItemError struct { // The error code. @@ -16653,9 +16027,9 @@ type UserBucketDetails struct { // Describes the user data for an instance. type UserData struct { - // The user data. If you are using an Amazon Web Services SDK or command line tool, - // Base64-encoding is performed for you, and you can load the text from a file. - // Otherwise, you must provide Base64-encoded text. + // The user data. If you are using an Amazon Web Services SDK or command line + // tool, Base64-encoding is performed for you, and you can load the text from a + // file. Otherwise, you must provide Base64-encoded text. Data *string noSmithyDocumentSerde @@ -16663,9 +16037,8 @@ type UserData struct { // Describes a security group and Amazon Web Services account ID pair. We are // retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. -// For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. +// For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. type UserIdGroupPair struct { // A description for the security group rule that references this user ID group @@ -16707,13 +16080,13 @@ type UserIdGroupPair struct { type ValidationError struct { // The error code that indicates why the parameter or parameter combination is not - // valid. For more information about error codes, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html). + // valid. For more information about error codes, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) + // . Code *string // The error message that describes why the parameter or parameter combination is - // not valid. For more information about error messages, see Error codes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html). + // not valid. For more information about error messages, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) + // . Message *string noSmithyDocumentSerde @@ -16737,7 +16110,7 @@ type VCpuCountRange struct { // maximum limit. Max *int32 - // The minimum number of vCPUs. If the value is 0, there is no minimum limit. + // The minimum number of vCPUs. If the value is 0 , there is no minimum limit. Min *int32 noSmithyDocumentSerde @@ -16746,7 +16119,7 @@ type VCpuCountRange struct { // The minimum and maximum number of vCPUs. type VCpuCountRangeRequest struct { - // The minimum number of vCPUs. To specify no minimum limit, specify 0. + // The minimum number of vCPUs. To specify no minimum limit, specify 0 . // // This member is required. Min *int32 @@ -16820,7 +16193,7 @@ type VerifiedAccessEndpoint struct { LastUpdatedTime *string // The load balancer details if creating the Amazon Web Services Verified Access - // endpoint as load-balancertype. + // endpoint as load-balancer type. LoadBalancerOptions *VerifiedAccessEndpointLoadBalancerOptions // The options for network-interface type endpoint. @@ -17121,7 +16494,7 @@ type VerifiedAccessTrustProvider struct { // The last updated time. LastUpdatedTime *string - // The OpenID Connect details for an oidc-type, user-identity based trust provider. + // The OpenID Connect details for an oidc -type, user-identity based trust provider. OidcOptions *OidcOptions // The identifier to be used when working with policy rules. @@ -17206,10 +16579,10 @@ type Volume struct { // Indicates whether the volume was created using fast snapshot restore. FastRestored *bool - // The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, - // this represents the number of IOPS that are provisioned for the volume. For gp2 - // volumes, this represents the baseline performance of the volume and the rate at - // which the volume accumulates I/O credits for bursting. + // The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 + // volumes, this represents the number of IOPS that are provisioned for the volume. + // For gp2 volumes, this represents the baseline performance of the volume and the + // rate at which the volume accumulates I/O credits for bursting. Iops *int32 // The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that @@ -17281,8 +16654,8 @@ type VolumeDetail struct { noSmithyDocumentSerde } -// Describes the modification status of an EBS volume. If the volume has never been -// modified, some element values will be null. +// Describes the modification status of an EBS volume. If the volume has never +// been modified, some element values will be null. type VolumeModification struct { // The modification completion or failure time. @@ -17340,7 +16713,7 @@ type VolumeModification struct { // Describes a volume status operation code. type VolumeStatusAction struct { - // The code identifying the operation, for example, enable-volume-io. + // The code identifying the operation, for example, enable-volume-io . Code *string // A description of the operation. @@ -17517,11 +16890,10 @@ type VpcCidrBlockState struct { noSmithyDocumentSerde } -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Describes whether a VPC is enabled for -// ClassicLink. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Describes whether a VPC is +// enabled for ClassicLink. type VpcClassicLink struct { // Indicates whether the VPC is enabled for ClassicLink. @@ -17657,7 +17029,7 @@ type VpcIpv6CidrBlockAssociation struct { // The name of the unique set of Availability Zones, Local Zones, or Wavelength // Zones from which Amazon Web Services advertises IP addresses, for example, - // us-east-1-wl1-bos-wlz-1. + // us-east-1-wl1-bos-wlz-1 . NetworkBorderGroup *string noSmithyDocumentSerde @@ -17666,8 +17038,8 @@ type VpcIpv6CidrBlockAssociation struct { // Describes a VPC peering connection. type VpcPeeringConnection struct { - // Information about the accepter VPC. CIDR block information is only returned when - // describing an active VPC peering connection. + // Information about the accepter VPC. CIDR block information is only returned + // when describing an active VPC peering connection. AccepterVpcInfo *VpcPeeringConnectionVpcInfo // The time that an unaccepted VPC peering connection will expire. @@ -17689,11 +17061,10 @@ type VpcPeeringConnection struct { noSmithyDocumentSerde } -// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a -// VPC. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon Elastic Compute Cloud User Guide. Describes the VPC peering connection -// options. +// We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to +// a VPC. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon Elastic Compute Cloud User Guide. Describes the VPC peering +// connection options. type VpcPeeringConnectionOptionsDescription struct { // Indicates whether a local VPC can resolve public DNS hostnames to private IP @@ -17755,8 +17126,8 @@ type VpcPeeringConnectionVpcInfo struct { type VpnConnection struct { // The category of the VPN connection. A value of VPN indicates an Amazon Web - // Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services - // Classic VPN connection. + // Services VPN connection. A value of VPN-Classic indicates an Amazon Web + // Services Classic VPN connection. Category *string // The ARN of the core network. @@ -17801,18 +17172,17 @@ type VpnConnection struct { // The ID of the VPN connection. VpnConnectionId *string - // The ID of the virtual private gateway at the Amazon Web Services side of the VPN - // connection. + // The ID of the virtual private gateway at the Amazon Web Services side of the + // VPN connection. VpnGatewayId *string noSmithyDocumentSerde } -// List of customer gateway devices that have a sample configuration file available -// for use. You can also see the list of device types with sample configuration -// files available under Your customer gateway device -// (https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html) in the Amazon Web -// Services Site-to-Site VPN User Guide. +// List of customer gateway devices that have a sample configuration file +// available for use. You can also see the list of device types with sample +// configuration files available under Your customer gateway device (https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html) +// in the Amazon Web Services Site-to-Site VPN User Guide. type VpnConnectionDeviceType struct { // Customer gateway device platform. @@ -17852,8 +17222,8 @@ type VpnConnectionOptions struct { // The IPv6 CIDR on the Amazon Web Services side of the VPN connection. RemoteIpv6NetworkCidr *string - // Indicates whether the VPN connection uses static routes only. Static routes must - // be used for devices that don't support BGP. + // Indicates whether the VPN connection uses static routes only. Static routes + // must be used for devices that don't support BGP. StaticRoutesOnly *bool // The transit gateway attachment ID in use for the VPN tunnel. @@ -17894,13 +17264,14 @@ type VpnConnectionOptionsSpecification struct { // ::/0 RemoteIpv6NetworkCidr *string - // Indicate whether the VPN connection uses static routes only. If you are creating - // a VPN connection for a device that does not support BGP, you must specify true. - // Use CreateVpnConnectionRoute to create a static route. Default: false + // Indicate whether the VPN connection uses static routes only. If you are + // creating a VPN connection for a device that does not support BGP, you must + // specify true . Use CreateVpnConnectionRoute to create a static route. Default: + // false StaticRoutesOnly *bool // The transit gateway attachment ID to use for the VPN tunnel. Required if - // OutsideIpAddressType is set to PrivateIpv4. + // OutsideIpAddressType is set to PrivateIpv4 . TransportTransitGatewayAttachmentId *string // Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. Default: ipv4 @@ -18005,8 +17376,8 @@ type VpnTunnelOptionsSpecification struct { // AES256-GCM-16 Phase1EncryptionAlgorithms []Phase1EncryptionAlgorithmsRequestListValue - // One or more integrity algorithms that are permitted for the VPN tunnel for phase - // 1 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 + // One or more integrity algorithms that are permitted for the VPN tunnel for + // phase 1 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Phase1IntegrityAlgorithms []Phase1IntegrityAlgorithmsRequestListValue // The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A @@ -18023,31 +17394,31 @@ type VpnTunnelOptionsSpecification struct { // AES256-GCM-16 Phase2EncryptionAlgorithms []Phase2EncryptionAlgorithmsRequestListValue - // One or more integrity algorithms that are permitted for the VPN tunnel for phase - // 2 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 + // One or more integrity algorithms that are permitted for the VPN tunnel for + // phase 2 IKE negotiations. Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512 Phase2IntegrityAlgorithms []Phase2IntegrityAlgorithmsRequestListValue // The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A // value between 900 and 3,600. The value must be less than the value for - // Phase1LifetimeSeconds. Default: 3600 + // Phase1LifetimeSeconds . Default: 3600 Phase2LifetimeSeconds *int32 - // The pre-shared key (PSK) to establish initial authentication between the virtual - // private gateway and customer gateway. Constraints: Allowed characters are - // alphanumeric characters, periods (.), and underscores (_). Must be between 8 and - // 64 characters in length and cannot start with zero (0). + // The pre-shared key (PSK) to establish initial authentication between the + // virtual private gateway and customer gateway. Constraints: Allowed characters + // are alphanumeric characters, periods (.), and underscores (_). Must be between 8 + // and 64 characters in length and cannot start with zero (0). PreSharedKey *string - // The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during - // which the rekey time is randomly selected. Constraints: A value between 0 and - // 100. Default: 100 + // The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) + // during which the rekey time is randomly selected. Constraints: A value between 0 + // and 100. Default: 100 RekeyFuzzPercentage *int32 // The margin time, in seconds, before the phase 2 lifetime expires, during which // the Amazon Web Services side of the VPN connection performs an IKE rekey. The // exact time of the rekey is randomly selected based on the value for - // RekeyFuzzPercentage. Constraints: A value between 60 and half of - // Phase2LifetimeSeconds. Default: 540 + // RekeyFuzzPercentage . Constraints: A value between 60 and half of + // Phase2LifetimeSeconds . Default: 540 RekeyMarginTimeSeconds *int32 // The number of packets in an IKE replay window. Constraints: A value between 64 @@ -18064,22 +17435,13 @@ type VpnTunnelOptionsSpecification struct { // must be unique across all VPN connections that use the same virtual private // gateway. Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The // following CIDR blocks are reserved and cannot be used: - // - // * 169.254.0.0/30 - // - // * - // 169.254.1.0/30 - // - // * 169.254.2.0/30 - // - // * 169.254.3.0/30 - // - // * 169.254.4.0/30 - // - // * - // 169.254.5.0/30 - // - // * 169.254.169.252/30 + // - 169.254.0.0/30 + // - 169.254.1.0/30 + // - 169.254.2.0/30 + // - 169.254.3.0/30 + // - 169.254.4.0/30 + // - 169.254.5.0/30 + // - 169.254.169.252/30 TunnelInsideCidr *string // The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks diff --git a/service/ec2instanceconnect/api_client.go b/service/ec2instanceconnect/api_client.go index 63dc0553a07..72945db5525 100644 --- a/service/ec2instanceconnect/api_client.go +++ b/service/ec2instanceconnect/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go index 64c719274b8..ae2d9c976bc 100644 --- a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go +++ b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go @@ -12,8 +12,7 @@ import ( // Pushes an SSH public key to the specified EC2 instance for use by the specified // user. The key remains for 60 seconds. For more information, see Connect to your -// Linux instance using EC2 Instance Connect -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html) +// Linux instance using EC2 Instance Connect (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html) // in the Amazon EC2 User Guide. func (c *Client) SendSSHPublicKey(ctx context.Context, params *SendSSHPublicKeyInput, optFns ...func(*Options)) (*SendSSHPublicKeyOutput, error) { if params == nil { diff --git a/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go b/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go index 71bc2fdc905..c5d4e8aaab2 100644 --- a/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go +++ b/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go @@ -12,9 +12,8 @@ import ( // Pushes an SSH public key to the specified EC2 instance. The key remains for 60 // seconds, which gives you 60 seconds to establish a serial console connection to -// the instance using SSH. For more information, see EC2 Serial Console -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html) in -// the Amazon EC2 User Guide. +// the instance using SSH. For more information, see EC2 Serial Console (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html) +// in the Amazon EC2 User Guide. func (c *Client) SendSerialConsoleSSHPublicKey(ctx context.Context, params *SendSerialConsoleSSHPublicKeyInput, optFns ...func(*Options)) (*SendSerialConsoleSSHPublicKeyOutput, error) { if params == nil { params = &SendSerialConsoleSSHPublicKeyInput{} @@ -39,8 +38,7 @@ type SendSerialConsoleSSHPublicKeyInput struct { // The public key material. To use the public key, you must have the matching // private key. For information about the supported key formats and lengths, see - // Requirements for key pairs - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws) + // Requirements for key pairs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws) // in the Amazon EC2 User Guide. // // This member is required. diff --git a/service/ec2instanceconnect/types/errors.go b/service/ec2instanceconnect/types/errors.go index 2a7f422b506..ce3cef5579b 100644 --- a/service/ec2instanceconnect/types/errors.go +++ b/service/ec2instanceconnect/types/errors.go @@ -169,8 +169,7 @@ func (e *InvalidArgsException) ErrorFault() smithy.ErrorFault { return smithy.Fa // Your account is not authorized to use the EC2 Serial Console. To authorize your // account, run the EnableSerialConsoleAccess API. For more information, see -// EnableSerialConsoleAccess -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableSerialConsoleAccess.html) +// EnableSerialConsoleAccess (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableSerialConsoleAccess.html) // in the Amazon EC2 API Reference. type SerialConsoleAccessDisabledException struct { Message *string diff --git a/service/ecr/api_client.go b/service/ecr/api_client.go index c51da783083..add37d360a5 100644 --- a/service/ecr/api_client.go +++ b/service/ecr/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ecr/api_op_BatchCheckLayerAvailability.go b/service/ecr/api_op_BatchCheckLayerAvailability.go index cea7521f689..83b924c83f2 100644 --- a/service/ecr/api_op_BatchCheckLayerAvailability.go +++ b/service/ecr/api_op_BatchCheckLayerAvailability.go @@ -57,8 +57,8 @@ type BatchCheckLayerAvailabilityOutput struct { // Any failures associated with the call. Failures []types.LayerFailure - // A list of image layer objects corresponding to the image layer references in the - // request. + // A list of image layer objects corresponding to the image layer references in + // the request. Layers []types.Layer // Metadata pertaining to the operation's result. diff --git a/service/ecr/api_op_BatchDeleteImage.go b/service/ecr/api_op_BatchDeleteImage.go index 80c9d5b5cf4..5b194d0e375 100644 --- a/service/ecr/api_op_BatchDeleteImage.go +++ b/service/ecr/api_op_BatchDeleteImage.go @@ -12,7 +12,7 @@ import ( ) // Deletes a list of specified images within a repository. Images are specified -// with either an imageTag or imageDigest. You can remove a tag from an image by +// with either an imageTag or imageDigest . You can remove a tag from an image by // specifying the image's tag in your request. When you remove the last tag from an // image, the image is deleted from your repository. You can completely delete an // image (and all of its tags) by specifying the image's digest in your request. @@ -32,11 +32,11 @@ func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageI } // Deletes specified images within a specified repository. Images are specified -// with either the imageTag or imageDigest. +// with either the imageTag or imageDigest . type BatchDeleteImageInput struct { - // A list of image ID references that correspond to images to delete. The format of - // the imageIds reference is imageTag=tag or imageDigest=digest. + // A list of image ID references that correspond to images to delete. The format + // of the imageIds reference is imageTag=tag or imageDigest=digest . // // This member is required. ImageIds []types.ImageIdentifier diff --git a/service/ecr/api_op_BatchGetImage.go b/service/ecr/api_op_BatchGetImage.go index b2724f89a54..4ac9a8cffde 100644 --- a/service/ecr/api_op_BatchGetImage.go +++ b/service/ecr/api_op_BatchGetImage.go @@ -12,7 +12,7 @@ import ( ) // Gets detailed information for an image. Images are specified with either an -// imageTag or imageDigest. When an image is pulled, the BatchGetImage API is +// imageTag or imageDigest . When an image is pulled, the BatchGetImage API is // called once to retrieve the image manifest. func (c *Client) BatchGetImage(ctx context.Context, params *BatchGetImageInput, optFns ...func(*Options)) (*BatchGetImageOutput, error) { if params == nil { @@ -32,7 +32,7 @@ func (c *Client) BatchGetImage(ctx context.Context, params *BatchGetImageInput, type BatchGetImageInput struct { // A list of image ID references that correspond to images to describe. The format - // of the imageIds reference is imageTag=tag or imageDigest=digest. + // of the imageIds reference is imageTag=tag or imageDigest=digest . // // This member is required. ImageIds []types.ImageIdentifier diff --git a/service/ecr/api_op_CreateRepository.go b/service/ecr/api_op_CreateRepository.go index 1f22e5c8217..74478c365d3 100644 --- a/service/ecr/api_op_CreateRepository.go +++ b/service/ecr/api_op_CreateRepository.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a repository. For more information, see Amazon ECR repositories -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in -// the Amazon Elastic Container Registry User Guide. +// Creates a repository. For more information, see Amazon ECR repositories (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) +// in the Amazon Elastic Container Registry User Guide. func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { params = &CreateRepositoryInput{} @@ -32,8 +31,8 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI type CreateRepositoryInput struct { // The name to use for the repository. The repository name may be specified on its - // own (such as nginx-web-app) or it can be prepended with a namespace to group the - // repository into a category (such as project-a/nginx-web-app). + // own (such as nginx-web-app ) or it can be prepended with a namespace to group + // the repository into a category (such as project-a/nginx-web-app ). // // This member is required. RepositoryName *string @@ -47,8 +46,8 @@ type CreateRepositoryInput struct { // repository. ImageScanningConfiguration *types.ImageScanningConfiguration - // The tag mutability setting for the repository. If this parameter is omitted, the - // default setting of MUTABLE will be used which will allow image tags to be + // The tag mutability setting for the repository. If this parameter is omitted, + // the default setting of MUTABLE will be used which will allow image tags to be // overwritten. If IMMUTABLE is specified, all image tags within the repository // will be immutable which will prevent them from being overwritten. ImageTagMutability types.ImageTagMutability diff --git a/service/ecr/api_op_DescribeImageScanFindings.go b/service/ecr/api_op_DescribeImageScanFindings.go index 5908d7ed0a3..9ee4da1c2b5 100644 --- a/service/ecr/api_op_DescribeImageScanFindings.go +++ b/service/ecr/api_op_DescribeImageScanFindings.go @@ -45,11 +45,11 @@ type DescribeImageScanFindingsInput struct { RepositoryName *string // The maximum number of image scan results returned by DescribeImageScanFindings - // in paginated output. When this parameter is used, DescribeImageScanFindings only - // returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another DescribeImageScanFindings request with the returned nextToken value. - // This value can be between 1 and 1000. If this parameter is not used, then + // in paginated output. When this parameter is used, DescribeImageScanFindings + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another DescribeImageScanFindings request with the returned nextToken + // value. This value can be between 1 and 1000. If this parameter is not used, then // DescribeImageScanFindings returns up to 100 results and a nextToken value, if // applicable. MaxResults *int32 @@ -81,7 +81,7 @@ type DescribeImageScanFindingsOutput struct { ImageScanStatus *types.ImageScanStatus // The nextToken value to include in a future DescribeImageScanFindings request. - // When the results of a DescribeImageScanFindings request exceed maxResults, this + // When the results of a DescribeImageScanFindings request exceed maxResults , this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string @@ -173,11 +173,11 @@ var _ DescribeImageScanFindingsAPIClient = (*Client)(nil) // DescribeImageScanFindings type DescribeImageScanFindingsPaginatorOptions struct { // The maximum number of image scan results returned by DescribeImageScanFindings - // in paginated output. When this parameter is used, DescribeImageScanFindings only - // returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another DescribeImageScanFindings request with the returned nextToken value. - // This value can be between 1 and 1000. If this parameter is not used, then + // in paginated output. When this parameter is used, DescribeImageScanFindings + // only returns maxResults results in a single page along with a nextToken + // response element. The remaining results of the initial request can be seen by + // sending another DescribeImageScanFindings request with the returned nextToken + // value. This value can be between 1 and 1000. If this parameter is not used, then // DescribeImageScanFindings returns up to 100 results and a nextToken value, if // applicable. Limit int32 @@ -273,9 +273,9 @@ type ImageScanCompleteWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageScanCompleteWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageScanCompleteWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -323,10 +323,10 @@ func (w *ImageScanCompleteWaiter) Wait(ctx context.Context, params *DescribeImag return err } -// WaitForOutput calls the waiter function for ImageScanComplete waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for ImageScanComplete waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *ImageScanCompleteWaiter) WaitForOutput(ctx context.Context, params *DescribeImageScanFindingsInput, maxWaitDur time.Duration, optFns ...func(*ImageScanCompleteWaiterOptions)) (*DescribeImageScanFindingsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/ecr/api_op_DescribeImages.go b/service/ecr/api_op_DescribeImages.go index f4b654290b8..35137a8c39f 100644 --- a/service/ecr/api_op_DescribeImages.go +++ b/service/ecr/api_op_DescribeImages.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns metadata about the images in a repository. Beginning with Docker version -// 1.9, the Docker client compresses image layers before pushing them to a V2 -// Docker registry. The output of the docker images command shows the uncompressed -// image size, so it may return a larger image size than the image sizes returned -// by DescribeImages. +// Returns metadata about the images in a repository. Beginning with Docker +// version 1.9, the Docker client compresses image layers before pushing them to a +// V2 Docker registry. The output of the docker images command shows the +// uncompressed image size, so it may return a larger image size than the image +// sizes returned by DescribeImages . func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) { if params == nil { params = &DescribeImagesInput{} @@ -45,21 +45,21 @@ type DescribeImagesInput struct { // The list of image IDs for the requested repository. ImageIds []types.ImageIdentifier - // The maximum number of repository results returned by DescribeImages in paginated - // output. When this parameter is used, DescribeImages only returns maxResults - // results in a single page along with a nextToken response element. The remaining - // results of the initial request can be seen by sending another DescribeImages - // request with the returned nextToken value. This value can be between 1 and 1000. - // If this parameter is not used, then DescribeImages returns up to 100 results and - // a nextToken value, if applicable. This option cannot be used when you specify - // images with imageIds. + // The maximum number of repository results returned by DescribeImages in + // paginated output. When this parameter is used, DescribeImages only returns + // maxResults results in a single page along with a nextToken response element. + // The remaining results of the initial request can be seen by sending another + // DescribeImages request with the returned nextToken value. This value can be + // between 1 and 1000. If this parameter is not used, then DescribeImages returns + // up to 100 results and a nextToken value, if applicable. This option cannot be + // used when you specify images with imageIds . MaxResults *int32 // The nextToken value returned from a previous paginated DescribeImages request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. - // This option cannot be used when you specify images with imageIds. + // This option cannot be used when you specify images with imageIds . NextToken *string // The Amazon Web Services account ID associated with the registry that contains @@ -76,8 +76,8 @@ type DescribeImagesOutput struct { ImageDetails []types.ImageDetail // The nextToken value to include in a future DescribeImages request. When the - // results of a DescribeImages request exceed maxResults, this value can be used to - // retrieve the next page of results. This value is null when there are no more + // results of a DescribeImages request exceed maxResults , this value can be used + // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string @@ -160,14 +160,14 @@ var _ DescribeImagesAPIClient = (*Client)(nil) // DescribeImagesPaginatorOptions is the paginator options for DescribeImages type DescribeImagesPaginatorOptions struct { - // The maximum number of repository results returned by DescribeImages in paginated - // output. When this parameter is used, DescribeImages only returns maxResults - // results in a single page along with a nextToken response element. The remaining - // results of the initial request can be seen by sending another DescribeImages - // request with the returned nextToken value. This value can be between 1 and 1000. - // If this parameter is not used, then DescribeImages returns up to 100 results and - // a nextToken value, if applicable. This option cannot be used when you specify - // images with imageIds. + // The maximum number of repository results returned by DescribeImages in + // paginated output. When this parameter is used, DescribeImages only returns + // maxResults results in a single page along with a nextToken response element. + // The remaining results of the initial request can be seen by sending another + // DescribeImages request with the returned nextToken value. This value can be + // between 1 and 1000. If this parameter is not used, then DescribeImages returns + // up to 100 results and a nextToken value, if applicable. This option cannot be + // used when you specify images with imageIds . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecr/api_op_DescribePullThroughCacheRules.go b/service/ecr/api_op_DescribePullThroughCacheRules.go index 2bfefbd7a93..11332be2b97 100644 --- a/service/ecr/api_op_DescribePullThroughCacheRules.go +++ b/service/ecr/api_op_DescribePullThroughCacheRules.go @@ -65,7 +65,7 @@ type DescribePullThroughCacheRulesOutput struct { // The nextToken value to include in a future DescribePullThroughCacheRulesRequest // request. When the results of a DescribePullThroughCacheRulesRequest request - // exceed maxResults, this value can be used to retrieve the next page of results. + // exceed maxResults , this value can be used to retrieve the next page of results. // This value is null when there are no more results to return. NextToken *string diff --git a/service/ecr/api_op_DescribeRepositories.go b/service/ecr/api_op_DescribeRepositories.go index cef08268c3e..0d6171d3f46 100644 --- a/service/ecr/api_op_DescribeRepositories.go +++ b/service/ecr/api_op_DescribeRepositories.go @@ -31,13 +31,14 @@ func (c *Client) DescribeRepositories(ctx context.Context, params *DescribeRepos type DescribeRepositoriesInput struct { // The maximum number of repository results returned by DescribeRepositories in - // paginated output. When this parameter is used, DescribeRepositories only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // DescribeRepositories request with the returned nextToken value. This value can - // be between 1 and 1000. If this parameter is not used, then DescribeRepositories - // returns up to 100 results and a nextToken value, if applicable. This option - // cannot be used when you specify repositories with repositoryNames. + // paginated output. When this parameter is used, DescribeRepositories only + // returns maxResults results in a single page along with a nextToken response + // element. The remaining results of the initial request can be seen by sending + // another DescribeRepositories request with the returned nextToken value. This + // value can be between 1 and 1000. If this parameter is not used, then + // DescribeRepositories returns up to 100 results and a nextToken value, if + // applicable. This option cannot be used when you specify repositories with + // repositoryNames . MaxResults *int32 // The nextToken value returned from a previous paginated DescribeRepositories @@ -45,7 +46,7 @@ type DescribeRepositoriesInput struct { // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. This option cannot be used when you specify repositories with - // repositoryNames. This token should be treated as an opaque identifier that is + // repositoryNames . This token should be treated as an opaque identifier that is // only used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string @@ -65,7 +66,7 @@ type DescribeRepositoriesInput struct { type DescribeRepositoriesOutput struct { // The nextToken value to include in a future DescribeRepositories request. When - // the results of a DescribeRepositories request exceed maxResults, this value can + // the results of a DescribeRepositories request exceed maxResults , this value can // be used to retrieve the next page of results. This value is null when there are // no more results to return. NextToken *string @@ -151,13 +152,14 @@ var _ DescribeRepositoriesAPIClient = (*Client)(nil) // DescribeRepositories type DescribeRepositoriesPaginatorOptions struct { // The maximum number of repository results returned by DescribeRepositories in - // paginated output. When this parameter is used, DescribeRepositories only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // DescribeRepositories request with the returned nextToken value. This value can - // be between 1 and 1000. If this parameter is not used, then DescribeRepositories - // returns up to 100 results and a nextToken value, if applicable. This option - // cannot be used when you specify repositories with repositoryNames. + // paginated output. When this parameter is used, DescribeRepositories only + // returns maxResults results in a single page along with a nextToken response + // element. The remaining results of the initial request can be seen by sending + // another DescribeRepositories request with the returned nextToken value. This + // value can be between 1 and 1000. If this parameter is not used, then + // DescribeRepositories returns up to 100 results and a nextToken value, if + // applicable. This option cannot be used when you specify repositories with + // repositoryNames . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecr/api_op_GetAuthorizationToken.go b/service/ecr/api_op_GetAuthorizationToken.go index 4d6dfbbd66f..87ae0d67fe7 100644 --- a/service/ecr/api_op_GetAuthorizationToken.go +++ b/service/ecr/api_op_GetAuthorizationToken.go @@ -17,8 +17,7 @@ import ( // hours. The authorizationToken returned is a base64 encoded string that can be // decoded and used in a docker login command to authenticate to a registry. The // CLI offers an get-login-password command that simplifies the login process. For -// more information, see Registry authentication -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth) +// more information, see Registry authentication (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth) // in the Amazon Elastic Container Registry User Guide. func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error) { if params == nil { diff --git a/service/ecr/api_op_GetDownloadUrlForLayer.go b/service/ecr/api_op_GetDownloadUrlForLayer.go index 82b584fe38b..b61f5161a7e 100644 --- a/service/ecr/api_op_GetDownloadUrlForLayer.go +++ b/service/ecr/api_op_GetDownloadUrlForLayer.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. -// You can only get URLs for image layers that are referenced in an image. When an -// image is pulled, the GetDownloadUrlForLayer API is called once per image layer -// that is not already cached. This operation is used by the Amazon ECR proxy and -// is not generally used by customers for pulling and pushing images. In most +// Retrieves the pre-signed Amazon S3 download URL corresponding to an image +// layer. You can only get URLs for image layers that are referenced in an image. +// When an image is pulled, the GetDownloadUrlForLayer API is called once per image +// layer that is not already cached. This operation is used by the Amazon ECR proxy +// and is not generally used by customers for pulling and pushing images. In most // cases, you should use the docker CLI to pull, tag, and push images. func (c *Client) GetDownloadUrlForLayer(ctx context.Context, params *GetDownloadUrlForLayerInput, optFns ...func(*Options)) (*GetDownloadUrlForLayerOutput, error) { if params == nil { diff --git a/service/ecr/api_op_GetLifecyclePolicyPreview.go b/service/ecr/api_op_GetLifecyclePolicyPreview.go index 5114fd1b06b..fcdbb70b3ee 100644 --- a/service/ecr/api_op_GetLifecyclePolicyPreview.go +++ b/service/ecr/api_op_GetLifecyclePolicyPreview.go @@ -50,13 +50,13 @@ type GetLifecyclePolicyPreviewInput struct { // The maximum number of repository results returned by // GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is // used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a - // single page along with a nextToken
 response element. The remaining results of + // single page along with a nextToken 
 response element. The remaining results of // the initial request can be seen by sending
 another - // GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. + // GetLifecyclePolicyPreviewRequest request with the returned nextToken 
 value. // This value can be between 1 and 1000. If this
 parameter is not used, then // GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken // value, if
 applicable. This option cannot be used when you specify images with - // imageIds. + // imageIds . MaxResults *int32 // The nextToken value returned from a previous paginated @@ -64,7 +64,7 @@ type GetLifecyclePolicyPreviewInput struct { // results exceeded the value of that parameter. Pagination continues from the end // of the
 previous results that returned the nextToken value. This value is
 null // when there are no more results to return. This option cannot be used when you - // specify images with imageIds. + // specify images with imageIds . NextToken *string // The Amazon Web Services account ID associated with the registry that contains @@ -81,7 +81,7 @@ type GetLifecyclePolicyPreviewOutput struct { LifecyclePolicyText *string // The nextToken value to include in a future GetLifecyclePolicyPreview request. - // When the results of a GetLifecyclePolicyPreview request exceed maxResults, this + // When the results of a GetLifecyclePolicyPreview request exceed maxResults , this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string @@ -184,13 +184,13 @@ type GetLifecyclePolicyPreviewPaginatorOptions struct { // The maximum number of repository results returned by // GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is // used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a - // single page along with a nextToken
 response element. The remaining results of + // single page along with a nextToken 
 response element. The remaining results of // the initial request can be seen by sending
 another - // GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. + // GetLifecyclePolicyPreviewRequest request with the returned nextToken 
 value. // This value can be between 1 and 1000. If this
 parameter is not used, then // GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken // value, if
 applicable. This option cannot be used when you specify images with - // imageIds. + // imageIds . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -286,10 +286,10 @@ type LifecyclePolicyPreviewCompleteWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LifecyclePolicyPreviewCompleteWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LifecyclePolicyPreviewCompleteWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ecr/api_op_ListImages.go b/service/ecr/api_op_ListImages.go index b3d096d5b76..d6e832d2a77 100644 --- a/service/ecr/api_op_ListImages.go +++ b/service/ecr/api_op_ListImages.go @@ -14,7 +14,7 @@ import ( // Lists all the image IDs for the specified repository. You can filter images // based on whether or not they are tagged by using the tagStatus filter and -// specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your +// specifying either TAGGED , UNTAGGED or ANY . For example, you can filter your // results to return only UNTAGGED images and then pipe that result to a // BatchDeleteImage operation to delete them. Or, you can filter your results to // return only TAGGED images to list all of the tags in your repository. @@ -74,7 +74,7 @@ type ListImagesOutput struct { ImageIds []types.ImageIdentifier // The nextToken value to include in a future ListImages request. When the results - // of a ListImages request exceed maxResults, this value can be used to retrieve + // of a ListImages request exceed maxResults , this value can be used to retrieve // the next page of results. This value is null when there are no more results to // return. NextToken *string diff --git a/service/ecr/api_op_PutImage.go b/service/ecr/api_op_PutImage.go index 631a9b408c5..f8d5295d8f2 100644 --- a/service/ecr/api_op_PutImage.go +++ b/service/ecr/api_op_PutImage.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates the image manifest and tags associated with an image. When an -// image is pushed and all new image layers have been uploaded, the PutImage API is -// called once to create or update the image manifest and the tags associated with -// the image. This operation is used by the Amazon ECR proxy and is not generally -// used by customers for pulling and pushing images. In most cases, you should use -// the docker CLI to pull, tag, and push images. +// Creates or updates the image manifest and tags associated with an image. When +// an image is pushed and all new image layers have been uploaded, the PutImage API +// is called once to create or update the image manifest and the tags associated +// with the image. This operation is used by the Amazon ECR proxy and is not +// generally used by customers for pulling and pushing images. In most cases, you +// should use the docker CLI to pull, tag, and push images. func (c *Client) PutImage(ctx context.Context, params *PutImageInput, optFns ...func(*Options)) (*PutImageOutput, error) { if params == nil { params = &PutImageInput{} diff --git a/service/ecr/api_op_PutImageScanningConfiguration.go b/service/ecr/api_op_PutImageScanningConfiguration.go index 74d8fe45635..a462b4dd014 100644 --- a/service/ecr/api_op_PutImageScanningConfiguration.go +++ b/service/ecr/api_op_PutImageScanningConfiguration.go @@ -13,7 +13,7 @@ import ( // The PutImageScanningConfiguration API is being deprecated, in favor of // specifying the image scanning configuration at the registry level. For more -// information, see PutRegistryScanningConfiguration. Updates the image scanning +// information, see PutRegistryScanningConfiguration . Updates the image scanning // configuration for the specified repository. func (c *Client) PutImageScanningConfiguration(ctx context.Context, params *PutImageScanningConfigurationInput, optFns ...func(*Options)) (*PutImageScanningConfigurationOutput, error) { if params == nil { diff --git a/service/ecr/api_op_PutImageTagMutability.go b/service/ecr/api_op_PutImageTagMutability.go index 5e42488a1ad..596251d3173 100644 --- a/service/ecr/api_op_PutImageTagMutability.go +++ b/service/ecr/api_op_PutImageTagMutability.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the image tag mutability settings for the specified repository. For more -// information, see Image tag mutability -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) +// Updates the image tag mutability settings for the specified repository. For +// more information, see Image tag mutability (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) // in the Amazon Elastic Container Registry User Guide. func (c *Client) PutImageTagMutability(ctx context.Context, params *PutImageTagMutabilityInput, optFns ...func(*Options)) (*PutImageTagMutabilityOutput, error) { if params == nil { diff --git a/service/ecr/api_op_PutLifecyclePolicy.go b/service/ecr/api_op_PutLifecyclePolicy.go index 782382eefe6..40cc5e1dbfe 100644 --- a/service/ecr/api_op_PutLifecyclePolicy.go +++ b/service/ecr/api_op_PutLifecyclePolicy.go @@ -11,8 +11,8 @@ import ( ) // Creates or updates the lifecycle policy for the specified repository. For more -// information, see Lifecycle policy template -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). +// information, see Lifecycle policy template (https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) +// . func (c *Client) PutLifecyclePolicy(ctx context.Context, params *PutLifecyclePolicyInput, optFns ...func(*Options)) (*PutLifecyclePolicyOutput, error) { if params == nil { params = &PutLifecyclePolicyInput{} diff --git a/service/ecr/api_op_PutRegistryPolicy.go b/service/ecr/api_op_PutRegistryPolicy.go index b253e0e0fcc..0d975f7dd34 100644 --- a/service/ecr/api_op_PutRegistryPolicy.go +++ b/service/ecr/api_op_PutRegistryPolicy.go @@ -13,8 +13,7 @@ import ( // Creates or updates the permissions policy for your registry. A registry policy // is used to specify permissions for another Amazon Web Services account and is // used when configuring cross-account replication. For more information, see -// Registry permissions -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) +// Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) // in the Amazon Elastic Container Registry User Guide. func (c *Client) PutRegistryPolicy(ctx context.Context, params *PutRegistryPolicyInput, optFns ...func(*Options)) (*PutRegistryPolicyOutput, error) { if params == nil { @@ -33,9 +32,8 @@ func (c *Client) PutRegistryPolicy(ctx context.Context, params *PutRegistryPolic type PutRegistryPolicyInput struct { - // The JSON policy text to apply to your registry. The policy text follows the same - // format as IAM policy text. For more information, see Registry permissions - // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) + // The JSON policy text to apply to your registry. The policy text follows the + // same format as IAM policy text. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) // in the Amazon Elastic Container Registry User Guide. // // This member is required. diff --git a/service/ecr/api_op_PutRegistryScanningConfiguration.go b/service/ecr/api_op_PutRegistryScanningConfiguration.go index fe20cf376ed..083175ef766 100644 --- a/service/ecr/api_op_PutRegistryScanningConfiguration.go +++ b/service/ecr/api_op_PutRegistryScanningConfiguration.go @@ -29,13 +29,14 @@ func (c *Client) PutRegistryScanningConfiguration(ctx context.Context, params *P type PutRegistryScanningConfigurationInput struct { - // The scanning rules to use for the registry. A scanning rule is used to determine - // which repository filters are used and at what frequency scanning will occur. + // The scanning rules to use for the registry. A scanning rule is used to + // determine which repository filters are used and at what frequency scanning will + // occur. Rules []types.RegistryScanningRule // The scanning type to set for the registry. When a registry scanning - // configuration is not defined, by default the BASIC scan type is used. When basic - // scanning is used, you may specify filters to determine which individual + // configuration is not defined, by default the BASIC scan type is used. When + // basic scanning is used, you may specify filters to determine which individual // repositories, or all repositories, are scanned when new images are pushed to // those repositories. Alternatively, you can do manual scans of images with basic // scanning. When the ENHANCED scan type is set, Amazon Inspector provides diff --git a/service/ecr/api_op_PutReplicationConfiguration.go b/service/ecr/api_op_PutReplicationConfiguration.go index e8e84df6eb0..8285f1543dd 100644 --- a/service/ecr/api_op_PutReplicationConfiguration.go +++ b/service/ecr/api_op_PutReplicationConfiguration.go @@ -16,12 +16,11 @@ import ( // DescribeRegistry API action. The first time the PutReplicationConfiguration API // is called, a service-linked IAM role is created in your account for the // replication process. For more information, see Using service-linked roles for -// Amazon ECR -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) +// Amazon ECR (https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) // in the Amazon Elastic Container Registry User Guide. When configuring // cross-account replication, the destination account must grant the source account // permission to replicate. This permission is controlled using a registry -// permissions policy. For more information, see PutRegistryPolicy. +// permissions policy. For more information, see PutRegistryPolicy . func (c *Client) PutReplicationConfiguration(ctx context.Context, params *PutReplicationConfigurationInput, optFns ...func(*Options)) (*PutReplicationConfigurationOutput, error) { if params == nil { params = &PutReplicationConfigurationInput{} diff --git a/service/ecr/api_op_SetRepositoryPolicy.go b/service/ecr/api_op_SetRepositoryPolicy.go index 1078970c70c..c041ba3af6e 100644 --- a/service/ecr/api_op_SetRepositoryPolicy.go +++ b/service/ecr/api_op_SetRepositoryPolicy.go @@ -11,8 +11,7 @@ import ( ) // Applies a repository policy to the specified repository to control access -// permissions. For more information, see Amazon ECR Repository policies -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) +// permissions. For more information, see Amazon ECR Repository policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) // in the Amazon Elastic Container Registry User Guide. func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error) { if params == nil { @@ -32,8 +31,7 @@ func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryP type SetRepositoryPolicyInput struct { // The JSON repository policy text to apply to the repository. For more - // information, see Amazon ECR repository policies - // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) + // information, see Amazon ECR repository policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) // in the Amazon Elastic Container Registry User Guide. // // This member is required. @@ -44,8 +42,8 @@ type SetRepositoryPolicyInput struct { // This member is required. RepositoryName *string - // If the policy you are attempting to set on a repository policy would prevent you - // from setting another policy in the future, you must force the + // If the policy you are attempting to set on a repository policy would prevent + // you from setting another policy in the future, you must force the // SetRepositoryPolicy operation. This is intended to prevent accidental repository // lock outs. Force bool diff --git a/service/ecr/api_op_StartImageScan.go b/service/ecr/api_op_StartImageScan.go index 8a9785f49b4..5abf1aaded8 100644 --- a/service/ecr/api_op_StartImageScan.go +++ b/service/ecr/api_op_StartImageScan.go @@ -13,9 +13,8 @@ import ( // Starts an image vulnerability scan. An image scan can only be started once per // 24 hours on an individual image. This limit includes if an image was scanned on -// initial push. For more information, see Image scanning -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) in -// the Amazon Elastic Container Registry User Guide. +// initial push. For more information, see Image scanning (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) +// in the Amazon Elastic Container Registry User Guide. func (c *Client) StartImageScan(ctx context.Context, params *StartImageScanInput, optFns ...func(*Options)) (*StartImageScanOutput, error) { if params == nil { params = &StartImageScanInput{} diff --git a/service/ecr/api_op_StartLifecyclePolicyPreview.go b/service/ecr/api_op_StartLifecyclePolicyPreview.go index 1169ac4432a..a7765289c25 100644 --- a/service/ecr/api_op_StartLifecyclePolicyPreview.go +++ b/service/ecr/api_op_StartLifecyclePolicyPreview.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a preview of a lifecycle policy for the specified repository. This allows -// you to see the results before associating the lifecycle policy with the +// Starts a preview of a lifecycle policy for the specified repository. This +// allows you to see the results before associating the lifecycle policy with the // repository. func (c *Client) StartLifecyclePolicyPreview(ctx context.Context, params *StartLifecyclePolicyPreviewInput, optFns ...func(*Options)) (*StartLifecyclePolicyPreviewOutput, error) { if params == nil { diff --git a/service/ecr/api_op_UploadLayerPart.go b/service/ecr/api_op_UploadLayerPart.go index 4acf7e5b0cc..3b65f612c7d 100644 --- a/service/ecr/api_op_UploadLayerPart.go +++ b/service/ecr/api_op_UploadLayerPart.go @@ -59,9 +59,9 @@ type UploadLayerPartInput struct { // This member is required. UploadId *string - // The Amazon Web Services account ID associated with the registry to which you are - // uploading layer parts. If you do not specify a registry, the default registry is - // assumed. + // The Amazon Web Services account ID associated with the registry to which you + // are uploading layer parts. If you do not specify a registry, the default + // registry is assumed. RegistryId *string noSmithyDocumentSerde diff --git a/service/ecr/doc.go b/service/ecr/doc.go index 602df615b1e..cd150610d4e 100644 --- a/service/ecr/doc.go +++ b/service/ecr/doc.go @@ -3,14 +3,14 @@ // Package ecr provides the API client, operations, and parameter types for Amazon // EC2 Container Registry. // -// Amazon Elastic Container Registry Amazon Elastic Container Registry (Amazon ECR) -// is a managed container image registry service. Customers can use the familiar -// Docker CLI, or their preferred client, to push, pull, and manage images. Amazon -// ECR provides a secure, scalable, and reliable registry for your Docker or Open -// Container Initiative (OCI) images. Amazon ECR supports private repositories with -// resource-based permissions using IAM so that specific users or Amazon EC2 -// instances can access repositories and images. Amazon ECR has service endpoints -// in each supported Region. For more information, see Amazon ECR endpoints -// (https://docs.aws.amazon.com/general/latest/gr/ecr.html) in the Amazon Web -// Services General Reference. +// Amazon Elastic Container Registry Amazon Elastic Container Registry (Amazon +// ECR) is a managed container image registry service. Customers can use the +// familiar Docker CLI, or their preferred client, to push, pull, and manage +// images. Amazon ECR provides a secure, scalable, and reliable registry for your +// Docker or Open Container Initiative (OCI) images. Amazon ECR supports private +// repositories with resource-based permissions using IAM so that specific users or +// Amazon EC2 instances can access repositories and images. Amazon ECR has service +// endpoints in each supported Region. For more information, see Amazon ECR +// endpoints (https://docs.aws.amazon.com/general/latest/gr/ecr.html) in the Amazon +// Web Services General Reference. package ecr diff --git a/service/ecr/types/enums.go b/service/ecr/types/enums.go index 9356aabf1bb..d782c4ec9c2 100644 --- a/service/ecr/types/enums.go +++ b/service/ecr/types/enums.go @@ -154,9 +154,10 @@ const ( LifecyclePolicyPreviewStatusFailed LifecyclePolicyPreviewStatus = "FAILED" ) -// Values returns all known values for LifecyclePolicyPreviewStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for LifecyclePolicyPreviewStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (LifecyclePolicyPreviewStatus) Values() []LifecyclePolicyPreviewStatus { return []LifecyclePolicyPreviewStatus{ "IN_PROGRESS", @@ -246,9 +247,10 @@ const ( ScanningRepositoryFilterTypeWildcard ScanningRepositoryFilterType = "WILDCARD" ) -// Values returns all known values for ScanningRepositoryFilterType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ScanningRepositoryFilterType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ScanningRepositoryFilterType) Values() []ScanningRepositoryFilterType { return []ScanningRepositoryFilterType{ "WILDCARD", @@ -312,9 +314,9 @@ const ( TagStatusAny TagStatus = "ANY" ) -// Values returns all known values for TagStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TagStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TagStatus) Values() []TagStatus { return []TagStatus{ "TAGGED", diff --git a/service/ecr/types/errors.go b/service/ecr/types/errors.go index 3f72008bd63..4b4782c5a5d 100644 --- a/service/ecr/types/errors.go +++ b/service/ecr/types/errors.go @@ -167,8 +167,8 @@ func (e *InvalidLayerException) ErrorCode() string { } func (e *InvalidLayerException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The layer part size is not valid, or the first byte specified is not consecutive -// to the last byte of a previous layer part upload. +// The layer part size is not valid, or the first byte specified is not +// consecutive to the last byte of a previous layer part upload. type InvalidLayerPartException struct { Message *string @@ -308,8 +308,8 @@ func (e *LayerAlreadyExistsException) ErrorCode() string { } func (e *LayerAlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified layer is not available because it is not associated with an image. -// Unassociated image layers may be cleaned up at any time. +// The specified layer is not available because it is not associated with an +// image. Unassociated image layers may be cleaned up at any time. type LayerInaccessibleException struct { Message *string @@ -361,8 +361,8 @@ func (e *LayerPartTooSmallException) ErrorCode() string { } func (e *LayerPartTooSmallException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified layers could not be found, or the specified layer is not valid for -// this repository. +// The specified layers could not be found, or the specified layer is not valid +// for this repository. type LayersNotFoundException struct { Message *string @@ -471,10 +471,9 @@ func (e *LifecyclePolicyPreviewNotFoundException) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// The operation did not succeed because it would have exceeded a service limit for -// your account. For more information, see Amazon ECR service quotas -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) in -// the Amazon Elastic Container Registry User Guide. +// The operation did not succeed because it would have exceeded a service limit +// for your account. For more information, see Amazon ECR service quotas (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) +// in the Amazon Elastic Container Registry User Guide. type LimitExceededException struct { Message *string @@ -663,9 +662,9 @@ func (e *RepositoryNotEmptyException) ErrorCode() string { } func (e *RepositoryNotEmptyException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified repository could not be found. Check the spelling of the specified -// repository and ensure that you are performing operations on the correct -// registry. +// The specified repository could not be found. Check the spelling of the +// specified repository and ensure that you are performing operations on the +// correct registry. type RepositoryNotFoundException struct { Message *string @@ -771,8 +770,8 @@ func (e *ServerException) ErrorCode() string { } func (e *ServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The list of tags on the repository is over the limit. The maximum number of tags -// that can be applied to a repository is 50. +// The list of tags on the repository is over the limit. The maximum number of +// tags that can be applied to a repository is 50. type TooManyTagsException struct { Message *string diff --git a/service/ecr/types/types.go b/service/ecr/types/types.go index 22afaab801d..42509094007 100644 --- a/service/ecr/types/types.go +++ b/service/ecr/types/types.go @@ -26,7 +26,7 @@ type AuthorizationData struct { // A base64-encoded string that contains authorization data for the specified // Amazon ECR registry. When the string is decoded, it is presented in the format - // user:password for private registry authentication using docker login. + // user:password for private registry authentication using docker login . AuthorizationToken *string // The Unix time in seconds and milliseconds when the authorization token expires. @@ -35,8 +35,8 @@ type AuthorizationData struct { // The registry URL to use for this authorization token in a docker login command. // The Amazon ECR registry URL format is - // https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, - // https://012345678910.dkr.ecr.us-east-1.amazonaws.com.. + // https://aws_account_id.dkr.ecr.region.amazonaws.com . For example, + // https://012345678910.dkr.ecr.us-east-1.amazonaws.com .. ProxyEndpoint *string noSmithyDocumentSerde @@ -128,7 +128,7 @@ type CvssScoreDetails struct { type DescribeImagesFilter struct { // The tag status with which to filter your DescribeImages results. You can filter - // results based on whether they are TAGGED or UNTAGGED. + // results based on whether they are TAGGED or UNTAGGED . TagStatus TagStatus noSmithyDocumentSerde @@ -142,8 +142,7 @@ type DescribeImagesFilter struct { // require any action on your part. For more control over the encryption of the // contents of your repository, you can use server-side encryption with Key // Management Service key stored in Key Management Service (KMS) to encrypt your -// images. For more information, see Amazon ECR encryption at rest -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) +// images. For more information, see Amazon ECR encryption at rest (https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) // in the Amazon Elastic Container Registry User Guide. type EncryptionConfiguration struct { @@ -153,14 +152,12 @@ type EncryptionConfiguration struct { // can either use the default Amazon Web Services managed KMS key for Amazon ECR, // or specify your own KMS key, which you already created. For more information, // see Protecting data using server-side encryption with an KMS key stored in Key - // Management Service (SSE-KMS) - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the - // Amazon Simple Storage Service Console Developer Guide. If you use the AES256 - // encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed - // encryption keys which encrypts the images in the repository using an AES-256 - // encryption algorithm. For more information, see Protecting data using - // server-side encryption with Amazon S3-managed encryption keys (SSE-S3) - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) + // Management Service (SSE-KMS) (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // in the Amazon Simple Storage Service Console Developer Guide. If you use the + // AES256 encryption type, Amazon ECR uses server-side encryption with Amazon + // S3-managed encryption keys which encrypts the images in the repository using an + // AES-256 encryption algorithm. For more information, see Protecting data using + // server-side encryption with Amazon S3-managed encryption keys (SSE-S3) (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) // in the Amazon Simple Storage Service Console Developer Guide. // // This member is required. @@ -276,19 +273,19 @@ type ImageDetail struct { // Docker version 1.9, the Docker client compresses image layers before pushing // them to a V2 Docker registry. The output of the docker images command shows the // uncompressed image size, so it may return a larger image size than the image - // sizes returned by DescribeImages. + // sizes returned by DescribeImages . ImageSizeInBytes *int64 // The list of tags associated with this image. ImageTags []string - // The date and time, expressed in standard JavaScript date format, when Amazon ECR - // recorded the last image pull. Amazon ECR refreshes the last image pull timestamp - // at least once every 24 hours. For example, if you pull an image once a day then - // the lastRecordedPullTime timestamp will indicate the exact time that the image - // was last pulled. However, if you pull an image once an hour, because Amazon ECR - // refreshes the lastRecordedPullTime timestamp at least once every 24 hours, the - // result may not be the exact time that the image was last pulled. + // The date and time, expressed in standard JavaScript date format, when Amazon + // ECR recorded the last image pull. Amazon ECR refreshes the last image pull + // timestamp at least once every 24 hours. For example, if you pull an image once a + // day then the lastRecordedPullTime timestamp will indicate the exact time that + // the image was last pulled. However, if you pull an image once an hour, because + // Amazon ECR refreshes the lastRecordedPullTime timestamp at least once every 24 + // hours, the result may not be the exact time that the image was last pulled. LastRecordedPullTime *time.Time // The Amazon Web Services account ID associated with the registry to which this @@ -408,10 +405,9 @@ type ImageScanFindingsSummary struct { type ImageScanningConfiguration struct { // The setting that determines whether images are scanned after being pushed to a - // repository. If set to true, images will be scanned after being pushed. If this + // repository. If set to true , images will be scanned after being pushed. If this // parameter is not specified, it will default to false and images will not be - // scanned unless a scan is manually started with the API_StartImageScan - // (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.html) + // scanned unless a scan is manually started with the API_StartImageScan (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.html) // API. ScanOnPush bool @@ -444,7 +440,7 @@ type Layer struct { // The media type of the layer, such as // application/vnd.docker.image.rootfs.diff.tar.gzip or - // application/vnd.oci.image.layer.v1.tar+gzip. + // application/vnd.oci.image.layer.v1.tar+gzip . MediaType *string noSmithyDocumentSerde @@ -518,7 +514,7 @@ type LifecyclePolicyRuleAction struct { type ListImagesFilter struct { // The tag status with which to filter your ListImages results. You can filter - // results based on whether they are TAGGED or UNTAGGED. + // results based on whether they are TAGGED or UNTAGGED . TagStatus TagStatus noSmithyDocumentSerde @@ -570,8 +566,8 @@ type PullThroughCacheRule struct { // The Amazon ECR repository prefix associated with the pull through cache rule. EcrRepositoryPrefix *string - // The Amazon Web Services account ID associated with the registry the pull through - // cache rule is associated with. + // The Amazon Web Services account ID associated with the registry the pull + // through cache rule is associated with. RegistryId *string // The upstream registry URL associated with the pull through cache rule. @@ -615,7 +611,7 @@ type RegistryScanningRule struct { // The frequency that scans are performed at for a private registry. When the // ENHANCED scan type is specified, the supported scan frequencies are - // CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the + // CONTINUOUS_SCAN and SCAN_ON_PUSH . When the BASIC scan type is specified, the // SCAN_ON_PUSH and MANUAL scan frequencies are supported. // // This member is required. @@ -704,7 +700,7 @@ type Repository struct { // The Amazon Resource Name (ARN) that identifies the repository. The ARN contains // the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web // Services account ID of the repository owner, repository namespace, and - // repository name. For example, arn:aws:ecr:region:012345678910:repository/test. + // repository name. For example, arn:aws:ecr:region:012345678910:repository/test . RepositoryArn *string // The name of the repository. @@ -730,8 +726,8 @@ type RepositoryFilter struct { // This member is required. Filter *string - // The repository filter type. The only supported value is PREFIX_MATCH, which is a - // repository name prefix specified with the filter parameter. + // The repository filter type. The only supported value is PREFIX_MATCH , which is + // a repository name prefix specified with the filter parameter. // // This member is required. FilterType RepositoryFilterType @@ -797,16 +793,15 @@ type Resource struct { // Contains details about the resource involved in the finding. type ResourceDetails struct { - // An object that contains details about the Amazon ECR container image involved in - // the finding. + // An object that contains details about the Amazon ECR container image involved + // in the finding. AwsEcrContainerImage *AwsEcrContainerImageDetails noSmithyDocumentSerde } // The details of a scanning repository filter. For more information on how to use -// filters, see Using filters -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) +// filters, see Using filters (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) // in the Amazon Elastic Container Registry User Guide. type ScanningRepositoryFilter struct { diff --git a/service/ecrpublic/api_client.go b/service/ecrpublic/api_client.go index dfd012e2ffe..f6d77354334 100644 --- a/service/ecrpublic/api_client.go +++ b/service/ecrpublic/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ecrpublic/api_op_BatchCheckLayerAvailability.go b/service/ecrpublic/api_op_BatchCheckLayerAvailability.go index 1fdd19c53a5..3caede8d21d 100644 --- a/service/ecrpublic/api_op_BatchCheckLayerAvailability.go +++ b/service/ecrpublic/api_op_BatchCheckLayerAvailability.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Checks the availability of one or more image layers that are within a repository -// in a public registry. When an image is pushed to a repository, each image layer -// is checked to verify if it has been uploaded before. If it has been uploaded, -// then the image layer is skipped. This operation is used by the Amazon ECR proxy -// and is not generally used by customers for pulling and pushing images. In most -// cases, you should use the docker CLI to pull, tag, and push images. +// Checks the availability of one or more image layers that are within a +// repository in a public registry. When an image is pushed to a repository, each +// image layer is checked to verify if it has been uploaded before. If it has been +// uploaded, then the image layer is skipped. This operation is used by the Amazon +// ECR proxy and is not generally used by customers for pulling and pushing images. +// In most cases, you should use the docker CLI to pull, tag, and push images. func (c *Client) BatchCheckLayerAvailability(ctx context.Context, params *BatchCheckLayerAvailabilityInput, optFns ...func(*Options)) (*BatchCheckLayerAvailabilityOutput, error) { if params == nil { params = &BatchCheckLayerAvailabilityInput{} diff --git a/service/ecrpublic/api_op_BatchDeleteImage.go b/service/ecrpublic/api_op_BatchDeleteImage.go index fe6bb8b8344..83d865e23e8 100644 --- a/service/ecrpublic/api_op_BatchDeleteImage.go +++ b/service/ecrpublic/api_op_BatchDeleteImage.go @@ -12,7 +12,7 @@ import ( ) // Deletes a list of specified images that are within a repository in a public -// registry. Images are specified with either an imageTag or imageDigest. You can +// registry. Images are specified with either an imageTag or imageDigest . You can // remove a tag from an image by specifying the image's tag in your request. When // you remove the last tag from an image, the image is deleted from your // repository. You can completely delete an image (and all of its tags) by @@ -34,8 +34,8 @@ func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageI type BatchDeleteImageInput struct { - // A list of image ID references that correspond to images to delete. The format of - // the imageIds reference is imageTag=tag or imageDigest=digest. + // A list of image ID references that correspond to images to delete. The format + // of the imageIds reference is imageTag=tag or imageDigest=digest . // // This member is required. ImageIds []types.ImageIdentifier diff --git a/service/ecrpublic/api_op_CreateRepository.go b/service/ecrpublic/api_op_CreateRepository.go index 09b91ba11bc..75c5bdf8c44 100644 --- a/service/ecrpublic/api_op_CreateRepository.go +++ b/service/ecrpublic/api_op_CreateRepository.go @@ -12,9 +12,8 @@ import ( ) // Creates a repository in a public registry. For more information, see Amazon ECR -// repositories -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in -// the Amazon Elastic Container Registry User Guide. +// repositories (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) +// in the Amazon Elastic Container Registry User Guide. func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { params = &CreateRepositoryInput{} @@ -34,8 +33,8 @@ type CreateRepositoryInput struct { // The name to use for the repository. This appears publicly in the Amazon ECR // Public Gallery. The repository name can be specified on its own (for example - // nginx-web-app) or prepended with a namespace to group the repository into a - // category (for example project-a/nginx-web-app). + // nginx-web-app ) or prepended with a namespace to group the repository into a + // category (for example project-a/nginx-web-app ). // // This member is required. RepositoryName *string diff --git a/service/ecrpublic/api_op_DeleteRepository.go b/service/ecrpublic/api_op_DeleteRepository.go index a655731b1b4..d9f4015c449 100644 --- a/service/ecrpublic/api_op_DeleteRepository.go +++ b/service/ecrpublic/api_op_DeleteRepository.go @@ -37,8 +37,8 @@ type DeleteRepositoryInput struct { // This member is required. RepositoryName *string - // The force option can be used to delete a repository that contains images. If the - // force option is not used, the repository must be empty prior to deletion. + // The force option can be used to delete a repository that contains images. If + // the force option is not used, the repository must be empty prior to deletion. Force bool // The Amazon Web Services account ID that's associated with the public registry diff --git a/service/ecrpublic/api_op_DescribeImageTags.go b/service/ecrpublic/api_op_DescribeImageTags.go index 5ebe4b2091c..99255155046 100644 --- a/service/ecrpublic/api_op_DescribeImageTags.go +++ b/service/ecrpublic/api_op_DescribeImageTags.go @@ -35,21 +35,21 @@ type DescribeImageTagsInput struct { // This member is required. RepositoryName *string - // The maximum number of repository results that's returned by DescribeImageTags in - // paginated output. When this parameter is used, DescribeImageTags only returns - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another - // DescribeImageTags request with the returned nextToken value. This value can be - // between 1 and 1000. If this parameter isn't used, then DescribeImageTags returns - // up to 100 results and a nextToken value, if applicable. If you specify images - // with imageIds, you can't use this option. + // The maximum number of repository results that's returned by DescribeImageTags + // in paginated output. When this parameter is used, DescribeImageTags only + // returns maxResults results in a single page along with a nextToken response + // element. You can see the remaining results of the initial request by sending + // another DescribeImageTags request with the returned nextToken value. This value + // can be between 1 and 1000. If this parameter isn't used, then DescribeImageTags + // returns up to 100 results and a nextToken value, if applicable. If you specify + // images with imageIds , you can't use this option. MaxResults *int32 // The nextToken value that's returned from a previous paginated DescribeImageTags // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. If there are no more results to return, this value - // is null. If you specify images with imageIds, you can't use this option. + // returned the nextToken value. If there are no more results to return, this + // value is null . If you specify images with imageIds , you can't use this option. NextToken *string // The Amazon Web Services account ID that's associated with the public registry @@ -66,9 +66,9 @@ type DescribeImageTagsOutput struct { ImageTagDetails []types.ImageTagDetail // The nextToken value to include in a future DescribeImageTags request. When the - // results of a DescribeImageTags request exceed maxResults, you can use this value - // to retrieve the next page of results. If there are no more results to return, - // this value is null. + // results of a DescribeImageTags request exceed maxResults , you can use this + // value to retrieve the next page of results. If there are no more results to + // return, this value is null . NextToken *string // Metadata pertaining to the operation's result. @@ -150,14 +150,14 @@ var _ DescribeImageTagsAPIClient = (*Client)(nil) // DescribeImageTagsPaginatorOptions is the paginator options for DescribeImageTags type DescribeImageTagsPaginatorOptions struct { - // The maximum number of repository results that's returned by DescribeImageTags in - // paginated output. When this parameter is used, DescribeImageTags only returns - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another - // DescribeImageTags request with the returned nextToken value. This value can be - // between 1 and 1000. If this parameter isn't used, then DescribeImageTags returns - // up to 100 results and a nextToken value, if applicable. If you specify images - // with imageIds, you can't use this option. + // The maximum number of repository results that's returned by DescribeImageTags + // in paginated output. When this parameter is used, DescribeImageTags only + // returns maxResults results in a single page along with a nextToken response + // element. You can see the remaining results of the initial request by sending + // another DescribeImageTags request with the returned nextToken value. This value + // can be between 1 and 1000. If this parameter isn't used, then DescribeImageTags + // returns up to 100 results and a nextToken value, if applicable. If you specify + // images with imageIds , you can't use this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecrpublic/api_op_DescribeImages.go b/service/ecrpublic/api_op_DescribeImages.go index 947ce9c158e..d8bc555d525 100644 --- a/service/ecrpublic/api_op_DescribeImages.go +++ b/service/ecrpublic/api_op_DescribeImages.go @@ -16,7 +16,7 @@ import ( // registry. Beginning with Docker version 1.9, the Docker client compresses image // layers before pushing them to a V2 Docker registry. The output of the docker // images command shows the uncompressed image size. Therefore, it might return a -// larger image size than the image sizes that are returned by DescribeImages. +// larger image size than the image sizes that are returned by DescribeImages . func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) { if params == nil { params = &DescribeImagesInput{} @@ -44,19 +44,19 @@ type DescribeImagesInput struct { // The maximum number of repository results that's returned by DescribeImages in // paginated output. When this parameter is used, DescribeImages only returns - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another + // maxResults results in a single page along with a nextToken response element. + // You can see the remaining results of the initial request by sending another // DescribeImages request with the returned nextToken value. This value can be - // between 1 and 1000. If this parameter isn't used, then DescribeImages returns up - // to 100 results and a nextToken value, if applicable. If you specify images with - // imageIds, you can't use this option. + // between 1 and 1000. If this parameter isn't used, then DescribeImages returns + // up to 100 results and a nextToken value, if applicable. If you specify images + // with imageIds , you can't use this option. MaxResults *int32 // The nextToken value that's returned from a previous paginated DescribeImages // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. If there are no more results to return, this value - // is null. If you specify images with imageIds, you can't use this option. + // returned the nextToken value. If there are no more results to return, this + // value is null . If you specify images with imageIds , you can't use this option. NextToken *string // The Amazon Web Services account ID that's associated with the public registry @@ -73,9 +73,9 @@ type DescribeImagesOutput struct { ImageDetails []types.ImageDetail // The nextToken value to include in a future DescribeImages request. When the - // results of a DescribeImages request exceed maxResults, you can use this value to - // retrieve the next page of results. If there are no more results to return, this - // value is null. + // results of a DescribeImages request exceed maxResults , you can use this value + // to retrieve the next page of results. If there are no more results to return, + // this value is null . NextToken *string // Metadata pertaining to the operation's result. @@ -159,12 +159,12 @@ var _ DescribeImagesAPIClient = (*Client)(nil) type DescribeImagesPaginatorOptions struct { // The maximum number of repository results that's returned by DescribeImages in // paginated output. When this parameter is used, DescribeImages only returns - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another + // maxResults results in a single page along with a nextToken response element. + // You can see the remaining results of the initial request by sending another // DescribeImages request with the returned nextToken value. This value can be - // between 1 and 1000. If this parameter isn't used, then DescribeImages returns up - // to 100 results and a nextToken value, if applicable. If you specify images with - // imageIds, you can't use this option. + // between 1 and 1000. If this parameter isn't used, then DescribeImages returns + // up to 100 results and a nextToken value, if applicable. If you specify images + // with imageIds , you can't use this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecrpublic/api_op_DescribeRegistries.go b/service/ecrpublic/api_op_DescribeRegistries.go index 3915ffae7e4..a49d6b64a84 100644 --- a/service/ecrpublic/api_op_DescribeRegistries.go +++ b/service/ecrpublic/api_op_DescribeRegistries.go @@ -34,17 +34,19 @@ type DescribeRegistriesInput struct { // in paginated output. When this parameter is used, DescribeRegistries only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending - // another DescribeRegistries request with the returned nextToken value. This value - // can be between 1 and 1000. If this parameter isn't used, then DescribeRegistries - // returns up to 100 results and a nextToken value, if applicable. + // another DescribeRegistries request with the returned nextToken value. This + // value can be between 1 and 1000. If this parameter isn't used, then + // DescribeRegistries returns up to 100 results and a nextToken value, if + // applicable. MaxResults *int32 // The nextToken value that's returned from a previous paginated DescribeRegistries // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. If there are no more results to return, this value - // is null. This token should be treated as an opaque identifier that is only used - // to retrieve the next items in a list and not for other programmatic purposes. + // returned the nextToken value. If there are no more results to return, this + // value is null . This token should be treated as an opaque identifier that is + // only used to retrieve the next items in a list and not for other programmatic + // purposes. NextToken *string noSmithyDocumentSerde @@ -58,9 +60,9 @@ type DescribeRegistriesOutput struct { Registries []types.Registry // The nextToken value to include in a future DescribeRepositories request. If the - // results of a DescribeRepositories request exceed maxResults, you can use this + // results of a DescribeRepositories request exceed maxResults , you can use this // value to retrieve the next page of results. If there are no more results, this - // value is null. + // value is null . NextToken *string // Metadata pertaining to the operation's result. @@ -144,9 +146,10 @@ type DescribeRegistriesPaginatorOptions struct { // in paginated output. When this parameter is used, DescribeRegistries only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending - // another DescribeRegistries request with the returned nextToken value. This value - // can be between 1 and 1000. If this parameter isn't used, then DescribeRegistries - // returns up to 100 results and a nextToken value, if applicable. + // another DescribeRegistries request with the returned nextToken value. This + // value can be between 1 and 1000. If this parameter isn't used, then + // DescribeRegistries returns up to 100 results and a nextToken value, if + // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecrpublic/api_op_DescribeRepositories.go b/service/ecrpublic/api_op_DescribeRepositories.go index a3d10f00ae3..1b716c51231 100644 --- a/service/ecrpublic/api_op_DescribeRepositories.go +++ b/service/ecrpublic/api_op_DescribeRepositories.go @@ -37,15 +37,15 @@ type DescribeRepositoriesInput struct { // another DescribeRepositories request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRepositories returns up to 100 results and a nextToken value, if - // applicable. If you specify repositories with repositoryNames, you can't use this - // option. + // applicable. If you specify repositories with repositoryNames , you can't use + // this option. MaxResults *int32 // The nextToken value that's returned from a previous paginated // DescribeRepositories request where maxResults was used and the results exceeded // the value of that parameter. Pagination continues from the end of the previous // results that returned the nextToken value. If there are no more results to - // return, this value is null. If you specify repositories with repositoryNames, + // return, this value is null . If you specify repositories with repositoryNames , // you can't use this option. This token should be treated as an opaque identifier // that is only used to retrieve the next items in a list and not for other // programmatic purposes. @@ -66,9 +66,9 @@ type DescribeRepositoriesInput struct { type DescribeRepositoriesOutput struct { // The nextToken value to include in a future DescribeRepositories request. When - // the results of a DescribeRepositories request exceed maxResults, this value can + // the results of a DescribeRepositories request exceed maxResults , this value can // be used to retrieve the next page of results. If there are no more results to - // return, this value is null. + // return, this value is null . NextToken *string // A list of repository objects corresponding to valid repositories. @@ -158,8 +158,8 @@ type DescribeRepositoriesPaginatorOptions struct { // another DescribeRepositories request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRepositories returns up to 100 results and a nextToken value, if - // applicable. If you specify repositories with repositoryNames, you can't use this - // option. + // applicable. If you specify repositories with repositoryNames , you can't use + // this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecrpublic/api_op_PutImage.go b/service/ecrpublic/api_op_PutImage.go index 9cec3eca716..8a2c3f2462d 100644 --- a/service/ecrpublic/api_op_PutImage.go +++ b/service/ecrpublic/api_op_PutImage.go @@ -47,9 +47,9 @@ type PutImageInput struct { // The image digest of the image manifest that corresponds to the image. ImageDigest *string - // The media type of the image manifest. If you push an image manifest that doesn't - // contain the mediaType field, you must specify the imageManifestMediaType in the - // request. + // The media type of the image manifest. If you push an image manifest that + // doesn't contain the mediaType field, you must specify the imageManifestMediaType + // in the request. ImageManifestMediaType *string // The tag to associate with the image. This parameter is required for images that diff --git a/service/ecrpublic/api_op_SetRepositoryPolicy.go b/service/ecrpublic/api_op_SetRepositoryPolicy.go index d96f3c7ca60..5208c357d8d 100644 --- a/service/ecrpublic/api_op_SetRepositoryPolicy.go +++ b/service/ecrpublic/api_op_SetRepositoryPolicy.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Applies a repository policy to the specified public repository to control access -// permissions. For more information, see Amazon ECR Repository Policies -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) +// Applies a repository policy to the specified public repository to control +// access permissions. For more information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) // in the Amazon Elastic Container Registry User Guide. func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error) { if params == nil { @@ -32,8 +31,7 @@ func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryP type SetRepositoryPolicyInput struct { // The JSON repository policy text to apply to the repository. For more - // information, see Amazon ECR Repository Policies - // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) + // information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) // in the Amazon Elastic Container Registry User Guide. // // This member is required. @@ -44,9 +42,9 @@ type SetRepositoryPolicyInput struct { // This member is required. RepositoryName *string - // If the policy that you want to set on a repository policy would prevent you from - // setting another policy in the future, you must force the SetRepositoryPolicy - // operation. This prevents accidental repository lockouts. + // If the policy that you want to set on a repository policy would prevent you + // from setting another policy in the future, you must force the + // SetRepositoryPolicy operation. This prevents accidental repository lockouts. Force bool // The Amazon Web Services account ID that's associated with the registry that diff --git a/service/ecrpublic/api_op_TagResource.go b/service/ecrpublic/api_op_TagResource.go index 198ff4f5e9b..a5e842a8c29 100644 --- a/service/ecrpublic/api_op_TagResource.go +++ b/service/ecrpublic/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource aren't specified in the request parameters, they // aren't changed. When a resource is deleted, the tags associated with that // resource are also deleted. diff --git a/service/ecrpublic/doc.go b/service/ecrpublic/doc.go index 00b64b49395..8706038fd3f 100644 --- a/service/ecrpublic/doc.go +++ b/service/ecrpublic/doc.go @@ -10,6 +10,6 @@ // images. Amazon ECR provides a secure, scalable, and reliable registry for your // Docker or Open Container Initiative (OCI) images. Amazon ECR supports public // repositories with this API. For information about the Amazon ECR API for private -// repositories, see Amazon Elastic Container Registry API Reference -// (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html). +// repositories, see Amazon Elastic Container Registry API Reference (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html) +// . package ecrpublic diff --git a/service/ecrpublic/types/errors.go b/service/ecrpublic/types/errors.go index e9fd62e1b2f..24f4d43c762 100644 --- a/service/ecrpublic/types/errors.go +++ b/service/ecrpublic/types/errors.go @@ -306,8 +306,8 @@ func (e *LayerPartTooSmallException) ErrorCode() string { } func (e *LayerPartTooSmallException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified layers can't be found, or the specified layer isn't valid for this -// repository. +// The specified layers can't be found, or the specified layer isn't valid for +// this repository. type LayersNotFoundException struct { Message *string @@ -334,9 +334,8 @@ func (e *LayersNotFoundException) ErrorCode() string { func (e *LayersNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation didn't succeed because it would have exceeded a service limit for -// your account. For more information, see Amazon ECR Service Quotas -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) in -// the Amazon Elastic Container Registry User Guide. +// your account. For more information, see Amazon ECR Service Quotas (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) +// in the Amazon Elastic Container Registry User Guide. type LimitExceededException struct { Message *string @@ -575,8 +574,8 @@ func (e *ServerException) ErrorCode() string { } func (e *ServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The list of tags on the repository is over the limit. The maximum number of tags -// that can be applied to a repository is 50. +// The list of tags on the repository is over the limit. The maximum number of +// tags that can be applied to a repository is 50. type TooManyTagsException struct { Message *string diff --git a/service/ecrpublic/types/types.go b/service/ecrpublic/types/types.go index 3c6325434d0..b24a2f4e4b7 100644 --- a/service/ecrpublic/types/types.go +++ b/service/ecrpublic/types/types.go @@ -10,9 +10,9 @@ import ( // An authorization token data object that corresponds to a public registry. type AuthorizationData struct { - // A base64-encoded string that contains authorization data for a public Amazon ECR - // registry. When the string is decoded, it's presented in the format user:password - // for public registry authentication using docker login. + // A base64-encoded string that contains authorization data for a public Amazon + // ECR registry. When the string is decoded, it's presented in the format + // user:password for public registry authentication using docker login . AuthorizationToken *string // The Unix time in seconds and milliseconds when the authorization token expires. @@ -65,7 +65,7 @@ type ImageDetail struct { // version 1.9, the Docker client compresses image layers before pushing them to a // V2 Docker registry. The output of the docker images command shows the // uncompressed image size, so it might return a larger image size than the image - // sizes that are returned by DescribeImages. + // sizes that are returned by DescribeImages . ImageSizeInBytes *int64 // The list of tags that's associated with this image. @@ -137,7 +137,7 @@ type Layer struct { // The media type of the layer, such as // application/vnd.docker.image.rootfs.diff.tar.gzip or - // application/vnd.oci.image.layer.v1.tar+gzip. + // application/vnd.oci.image.layer.v1.tar+gzip . MediaType *string noSmithyDocumentSerde @@ -180,7 +180,7 @@ type ReferencedImageDetail struct { // version 1.9, the Docker client compresses image layers before pushing them to a // V2 Docker registry. The output of the docker images command shows the // uncompressed image size, so it might return a larger image size than the image - // sizes that are returned by DescribeImages. + // sizes that are returned by DescribeImages . ImageSizeInBytes *int64 noSmithyDocumentSerde @@ -223,13 +223,12 @@ type Registry struct { // An object representing the aliases for a public registry. A public registry is // given an alias when it's created. However, a custom alias can be set using the -// Amazon ECR console. For more information, see Registries -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html) in the -// Amazon Elastic Container Registry User Guide. +// Amazon ECR console. For more information, see Registries (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html) +// in the Amazon Elastic Container Registry User Guide. type RegistryAlias struct { - // Indicates whether the registry alias is the default alias for the registry. When - // the first public repository is created, your public registry is assigned a + // Indicates whether the registry alias is the default alias for the registry. + // When the first public repository is created, your public registry is assigned a // default registry alias. // // This member is required. @@ -281,7 +280,7 @@ type Repository struct { // The Amazon Resource Name (ARN) that identifies the repository. The ARN contains // the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web // Services account ID of the repository owner, repository namespace, and - // repository name. For example, arn:aws:ecr:region:012345678910:repository/test. + // repository name. For example, arn:aws:ecr:region:012345678910:repository/test . RepositoryArn *string // The name of the repository. @@ -298,13 +297,13 @@ type Repository struct { // ECR Public Gallery. type RepositoryCatalogData struct { - // The longform description of the contents of the repository. This text appears in - // the repository details on the Amazon ECR Public Gallery. + // The longform description of the contents of the repository. This text appears + // in the repository details on the Amazon ECR Public Gallery. AboutText *string // The architecture tags that are associated with the repository. Only supported // operating system tags appear publicly in the Amazon ECR Public Gallery. For more - // information, see RepositoryCatalogDataInput. + // information, see RepositoryCatalogDataInput . Architectures []string // The short description of the repository. @@ -319,7 +318,7 @@ type RepositoryCatalogData struct { // The operating system tags that are associated with the repository. Only // supported operating system tags appear publicly in the Amazon ECR Public - // Gallery. For more information, see RepositoryCatalogDataInput. + // Gallery. For more information, see RepositoryCatalogDataInput . OperatingSystems []string // The longform usage details of the contents of the repository. The usage text @@ -329,8 +328,8 @@ type RepositoryCatalogData struct { noSmithyDocumentSerde } -// An object that contains the catalog data for a repository. This data is publicly -// visible in the Amazon ECR Public Gallery. +// An object that contains the catalog data for a repository. This data is +// publicly visible in the Amazon ECR Public Gallery. type RepositoryCatalogDataInput struct { // A detailed description of the contents of the repository. It's publicly visible @@ -343,23 +342,19 @@ type RepositoryCatalogDataInput struct { // tag is added to your repository catalog data, it's associated with the // repository and can be retrieved using the API but isn't discoverable in the // Amazon ECR Public Gallery. - // - // * ARM - // - // * ARM 64 - // - // * x86 - // - // * x86-64 + // - ARM + // - ARM 64 + // - x86 + // - x86-64 Architectures []string - // A short description of the contents of the repository. This text appears in both - // the image details and also when searching for repositories on the Amazon ECR - // Public Gallery. + // A short description of the contents of the repository. This text appears in + // both the image details and also when searching for repositories on the Amazon + // ECR Public Gallery. Description *string - // The base64-encoded repository logo payload. The repository logo is only publicly - // visible in the Amazon ECR Public Gallery for verified accounts. + // The base64-encoded repository logo payload. The repository logo is only + // publicly visible in the Amazon ECR Public Gallery for verified accounts. LogoImageBlob []byte // The operating systems that the images in the repository are compatible with. On @@ -368,10 +363,8 @@ type RepositoryCatalogDataInput struct { // tag is added to your repository catalog data, it's associated with the // repository and can be retrieved using the API but isn't discoverable in the // Amazon ECR Public Gallery. - // - // * Linux - // - // * Windows + // - Linux + // - Windows OperatingSystems []string // Detailed information about how to use the contents of the repository. It's diff --git a/service/ecs/api_client.go b/service/ecs/api_client.go index c35ce106ccd..4617c64d32e 100644 --- a/service/ecs/api_client.go +++ b/service/ecs/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ecs/api_op_CreateCapacityProvider.go b/service/ecs/api_op_CreateCapacityProvider.go index f3344b9c3a4..45ee8a1d9ca 100644 --- a/service/ecs/api_op_CreateCapacityProvider.go +++ b/service/ecs/api_op_CreateCapacityProvider.go @@ -41,7 +41,8 @@ type CreateCapacityProviderInput struct { // The name of the capacity provider. Up to 255 characters are allowed. They // include letters (both upper and lowercase letters), numbers, underscores (_), - // and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate". + // and hyphens (-). The name can't be prefixed with " aws ", " ecs ", or " fargate + // ". // // This member is required. Name *string @@ -49,31 +50,20 @@ type CreateCapacityProviderInput struct { // The metadata that you apply to the capacity provider to categorize and organize // them more conveniently. Each tag consists of a key and an optional value. You // define both of them. The following basic restrictions apply to tags: - // - // * Maximum - // number of tags per resource - 50 - // - // * For each resource, each tag key must be - // unique, and each tag key can have only one value. - // - // * Maximum key length - 128 - // Unicode characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in - // UTF-8 - // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable in - // UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ecs/api_op_CreateCluster.go b/service/ecs/api_op_CreateCluster.go index 0d03d60edbd..9ec79effe33 100644 --- a/service/ecs/api_op_CreateCluster.go +++ b/service/ecs/api_op_CreateCluster.go @@ -13,14 +13,13 @@ import ( // Creates a new Amazon ECS cluster. By default, your account receives a default // cluster when you launch your first container instance. However, you can create -// your own cluster with a unique name with the CreateCluster action. When you call -// the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS -// service-linked role for your account. This is so that it can manage required +// your own cluster with a unique name with the CreateCluster action. When you +// call the CreateCluster API operation, Amazon ECS attempts to create the Amazon +// ECS service-linked role for your account. This is so that it can manage required // resources in other Amazon Web Services services on your behalf. However, if the // user that makes the call doesn't have permissions to create the service-linked -// role, it isn't created. For more information, see Using service-linked roles for -// Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// role, it isn't created. For more information, see Using service-linked roles +// for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { @@ -42,26 +41,22 @@ type CreateClusterInput struct { // The short name of one or more capacity providers to associate with the cluster. // A capacity provider must be associated with a cluster before it can be included // as part of the default capacity provider strategy of the cluster or used in a - // capacity provider strategy when calling the CreateService - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) - // or RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) + // capacity provider strategy when calling the CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) + // or RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) // actions. If specifying a capacity provider that uses an Auto Scaling group, the // capacity provider must be created but not associated with another cluster. New // Auto Scaling group capacity providers can be created with the - // CreateCapacityProvider - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) - // API operation. To use a Fargate capacity provider, specify either the FARGATE or - // FARGATE_SPOT capacity providers. The Fargate capacity providers are available to - // all accounts and only need to be associated with a cluster to be used. The - // PutCapacityProvider - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) + // CreateCapacityProvider (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) + // API operation. To use a Fargate capacity provider, specify either the FARGATE + // or FARGATE_SPOT capacity providers. The Fargate capacity providers are + // available to all accounts and only need to be associated with a cluster to be + // used. The PutCapacityProvider (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) // API operation is used to update the list of available capacity providers for a // cluster after the cluster is created. CapacityProviders []string // The name of your cluster. If you don't specify a name for your cluster, you - // create a cluster that's named default. Up to 255 letters (uppercase and + // create a cluster that's named default . Up to 255 letters (uppercase and // lowercase), numbers, underscores, and hyphens are allowed. ClusterName *string @@ -70,10 +65,8 @@ type CreateClusterInput struct { // The capacity provider strategy to set as the default for the cluster. After a // default capacity provider strategy is set for a cluster, when you call the - // CreateService - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) - // or RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) + // CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) + // or RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) // APIs with no capacity provider strategy or launch type specified, the default // capacity provider strategy for the cluster is used. If a default capacity // provider strategy isn't defined for a cluster when it was created, it can be @@ -84,52 +77,40 @@ type CreateClusterInput struct { // default Service Connect namespace, any new services with Service Connect turned // on that are created in the cluster are added as client services in the // namespace. This setting only applies to new services that set the enabled - // parameter to true in the ServiceConnectConfiguration. You can set the namespace - // of each service individually in the ServiceConnectConfiguration to override this - // default parameter. Tasks that run in a namespace can use short names to connect - // to services in the namespace. Tasks can connect to services across all of the - // clusters in the namespace. Tasks connect through a managed proxy container that - // collects logs and metrics for increased visibility. Only the tasks that Amazon - // ECS services create are supported with Service Connect. For more information, - // see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // parameter to true in the ServiceConnectConfiguration . You can set the namespace + // of each service individually in the ServiceConnectConfiguration to override + // this default parameter. Tasks that run in a namespace can use short names to + // connect to services in the namespace. Tasks can connect to services across all + // of the clusters in the namespace. Tasks connect through a managed proxy + // container that collects logs and metrics for increased visibility. Only the + // tasks that Amazon ECS services create are supported with Service Connect. For + // more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectDefaults *types.ClusterServiceConnectDefaultsRequest // The setting to use when creating a cluster. This parameter is used to turn on // CloudWatch Container Insights for a cluster. If this value is specified, it // overrides the containerInsights value set with PutAccountSetting or - // PutAccountSettingDefault. + // PutAccountSettingDefault . Settings []types.ClusterSetting // The metadata that you apply to the cluster to help you categorize and organize // them. Each tag consists of a key and an optional value. You define both. The // following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50 - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ecs/api_op_CreateService.go b/service/ecs/api_op_CreateService.go index 8778d9ffb8a..37844de65b8 100644 --- a/service/ecs/api_op_CreateService.go +++ b/service/ecs/api_op_CreateService.go @@ -13,11 +13,11 @@ import ( // Runs and maintains your desired number of tasks from a specified task // definition. If the number of tasks running in a service drops below the -// desiredCount, Amazon ECS runs another copy of the task in the specified cluster. -// To update an existing service, see the UpdateService action. Starting April 15, -// 2023, Amazon Web Services will not onboard new customers to Amazon Elastic -// Inference (EI), and will help current customers migrate their workloads to -// options that offer better price and performance. After April 15, 2023, new +// desiredCount , Amazon ECS runs another copy of the task in the specified +// cluster. To update an existing service, see the UpdateService action. Starting +// April 15, 2023, Amazon Web Services will not onboard new customers to Amazon +// Elastic Inference (EI), and will help current customers migrate their workloads +// to options that offer better price and performance. After April 15, 2023, new // customers will not be able to launch instances with Amazon EI accelerators in // Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used // Amazon EI at least once during the past 30-day period are considered current @@ -25,82 +25,72 @@ import ( // maintaining the desired count of tasks in your service, you can optionally run // your service behind one or more load balancers. The load balancers distribute // traffic across the tasks that are associated with the service. For more -// information, see Service load balancing -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) +// information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) // in the Amazon Elastic Container Service Developer Guide. Tasks for services that // don't use a load balancer are considered healthy if they're in the RUNNING // state. Tasks for services that use a load balancer are considered healthy if // they're in the RUNNING state and are reported as healthy by the load balancer. // There are two service scheduler strategies available: +// - REPLICA - The replica scheduling strategy places and maintains your desired +// number of tasks across your cluster. By default, the service scheduler spreads +// tasks across Availability Zones. You can use task placement strategies and +// constraints to customize task placement decisions. For more information, see +// Service scheduler concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) +// in the Amazon Elastic Container Service Developer Guide. +// - DAEMON - The daemon scheduling strategy deploys exactly one task on each +// active container instance that meets all of the task placement constraints that +// you specify in your cluster. The service scheduler also evaluates the task +// placement constraints for running tasks. It also stops tasks that don't meet the +// placement constraints. When using this strategy, you don't need to specify a +// desired number of tasks, a task placement strategy, or use Service Auto Scaling +// policies. For more information, see Service scheduler concepts (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) +// in the Amazon Elastic Container Service Developer Guide. // -// * REPLICA - The replica -// scheduling strategy places and maintains your desired number of tasks across -// your cluster. By default, the service scheduler spreads tasks across -// Availability Zones. You can use task placement strategies and constraints to -// customize task placement decisions. For more information, see Service scheduler -// concepts -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) -// in the Amazon Elastic Container Service Developer Guide. -// -// * DAEMON - The daemon -// scheduling strategy deploys exactly one task on each active container instance -// that meets all of the task placement constraints that you specify in your -// cluster. The service scheduler also evaluates the task placement constraints for -// running tasks. It also stops tasks that don't meet the placement constraints. -// When using this strategy, you don't need to specify a desired number of tasks, a -// task placement strategy, or use Service Auto Scaling policies. For more -// information, see Service scheduler concepts -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) -// in the Amazon Elastic Container Service Developer Guide. -// -// You can optionally -// specify a deployment configuration for your service. The deployment is initiated -// by changing properties. For example, the deployment might be initiated by the -// task definition or by your desired count of a service. This is done with an -// UpdateService operation. The default value for a replica service for -// minimumHealthyPercent is 100%. The default value for a daemon service for -// minimumHealthyPercent is 0%. If a service uses the ECS deployment controller, -// the minimum healthy percent represents a lower limit on the number of tasks in a -// service that must remain in the RUNNING state during a deployment. Specifically, -// it represents it as a percentage of your desired number of tasks (rounded up to +// You can optionally specify a deployment configuration for your service. The +// deployment is initiated by changing properties. For example, the deployment +// might be initiated by the task definition or by your desired count of a service. +// This is done with an UpdateService operation. The default value for a replica +// service for minimumHealthyPercent is 100%. The default value for a daemon +// service for minimumHealthyPercent is 0%. If a service uses the ECS deployment +// controller, the minimum healthy percent represents a lower limit on the number +// of tasks in a service that must remain in the RUNNING state during a +// deployment. Specifically, it represents it as a percentage of your desired +// number of tasks (rounded up to the nearest integer). This happens when any of +// your container instances are in the DRAINING state if the service contains +// tasks using the EC2 launch type. Using this parameter, you can deploy without +// using additional cluster capacity. For example, if you set your service to have +// desired number of four tasks and a minimum healthy percent of 50%, the scheduler +// might stop two existing tasks to free up cluster capacity before starting two +// new tasks. If they're in the RUNNING state, tasks for services that don't use a +// load balancer are considered healthy . If they're in the RUNNING state and +// reported as healthy by the load balancer, tasks for services that do use a load +// balancer are considered healthy . The default value for minimum healthy percent +// is 100%. If a service uses the ECS deployment controller, the maximum percent +// parameter represents an upper limit on the number of tasks in a service that are +// allowed in the RUNNING or PENDING state during a deployment. Specifically, it +// represents it as a percentage of the desired number of tasks (rounded down to // the nearest integer). This happens when any of your container instances are in // the DRAINING state if the service contains tasks using the EC2 launch type. -// Using this parameter, you can deploy without using additional cluster capacity. -// For example, if you set your service to have desired number of four tasks and a -// minimum healthy percent of 50%, the scheduler might stop two existing tasks to -// free up cluster capacity before starting two new tasks. If they're in the -// RUNNING state, tasks for services that don't use a load balancer are considered -// healthy . If they're in the RUNNING state and reported as healthy by the load -// balancer, tasks for services that do use a load balancer are considered healthy -// . The default value for minimum healthy percent is 100%. If a service uses the -// ECS deployment controller, the maximum percent parameter represents an upper -// limit on the number of tasks in a service that are allowed in the RUNNING or -// PENDING state during a deployment. Specifically, it represents it as a -// percentage of the desired number of tasks (rounded down to the nearest integer). -// This happens when any of your container instances are in the DRAINING state if -// the service contains tasks using the EC2 launch type. Using this parameter, you -// can define the deployment batch size. For example, if your service has a desired -// number of four tasks and a maximum percent value of 200%, the scheduler may -// start four new tasks before stopping the four older tasks (provided that the -// cluster resources required to do this are available). The default value for -// maximum percent is 200%. If a service uses either the CODE_DEPLOY or EXTERNAL -// deployment controller types and tasks that use the EC2 launch type, the minimum -// healthy percent and maximum percent values are used only to define the lower and -// upper limit on the number of the tasks in the service that remain in the RUNNING -// state. This is while the container instances are in the DRAINING state. If the -// tasks in the service use the Fargate launch type, the minimum healthy percent -// and maximum percent values aren't used. This is the case even if they're -// currently visible when describing your service. When creating a service that -// uses the EXTERNAL deployment controller, you can specify only parameters that -// aren't controlled at the task set level. The only required parameter is the -// service name. You control your services using the CreateTaskSet operation. For -// more information, see Amazon ECS deployment types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// Using this parameter, you can define the deployment batch size. For example, if +// your service has a desired number of four tasks and a maximum percent value of +// 200%, the scheduler may start four new tasks before stopping the four older +// tasks (provided that the cluster resources required to do this are available). +// The default value for maximum percent is 200%. If a service uses either the +// CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 +// launch type, the minimum healthy percent and maximum percent values are used +// only to define the lower and upper limit on the number of the tasks in the +// service that remain in the RUNNING state. This is while the container instances +// are in the DRAINING state. If the tasks in the service use the Fargate launch +// type, the minimum healthy percent and maximum percent values aren't used. This +// is the case even if they're currently visible when describing your service. When +// creating a service that uses the EXTERNAL deployment controller, you can +// specify only parameters that aren't controlled at the task set level. The only +// required parameter is the service name. You control your services using the +// CreateTaskSet operation. For more information, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. When the service // scheduler launches new tasks, it determines task placement. For information // about task placement and task placement strategies, see Amazon ECS task -// placement -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html) +// placement (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { @@ -128,14 +118,14 @@ type CreateServiceInput struct { ServiceName *string // The capacity provider strategy to use for the service. If a - // capacityProviderStrategy is specified, the launchType parameter must be omitted. - // If no capacityProviderStrategy or launchType is specified, the + // capacityProviderStrategy is specified, the launchType parameter must be + // omitted. If no capacityProviderStrategy or launchType is specified, the // defaultCapacityProviderStrategy for the cluster is used. A capacity provider // strategy may contain a maximum of 6 capacity providers. CapacityProviderStrategy []types.CapacityProviderStrategyItem - // An identifier that you provide to ensure the idempotency of the request. It must - // be unique and is case sensitive. Up to 32 ASCII characters are allowed. + // An identifier that you provide to ensure the idempotency of the request. It + // must be unique and is case sensitive. Up to 32 ASCII characters are allowed. ClientToken *string // The short name or full Amazon Resource Name (ARN) of the cluster that you run @@ -147,8 +137,8 @@ type CreateServiceInput struct { // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *types.DeploymentConfiguration - // The deployment controller to use for the service. If no deployment controller is - // specified, the default value of ECS is used. + // The deployment controller to use for the service. If no deployment controller + // is specified, the default value of ECS is used. DeploymentController *types.DeploymentController // The number of instantiations of the specified task definition to place and keep @@ -157,14 +147,13 @@ type CreateServiceInput struct { DesiredCount *int32 // Specifies whether to turn on Amazon ECS managed tags for the tasks within the - // service. For more information, see Tagging your Amazon ECS resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // service. For more information, see Tagging your Amazon ECS resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool - // Determines whether the execute command functionality is enabled for the service. - // If true, this enables execute command functionality on all containers in the - // service tasks. + // Determines whether the execute command functionality is enabled for the + // service. If true , this enables execute command functionality on all containers + // in the service tasks. EnableExecuteCommand bool // The period of time, in seconds, that the Amazon ECS service scheduler ignores @@ -173,9 +162,8 @@ type CreateServiceInput struct { // balancer. If your service has a load balancer defined and you don't specify a // health check grace period value, the default value of 0 is used. If you do not // use an Elastic Load Balancing, we recommend that you use the startPeriod in the - // task definition health check parameters. For more information, see Health check - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). - // If your service's tasks take a while to start and respond to Elastic Load + // task definition health check parameters. For more information, see Health check (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html) + // . If your service's tasks take a while to start and respond to Elastic Load // Balancing health checks, you can specify a health check grace period of up to // 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service // scheduler ignores health check status. This grace period can prevent the service @@ -184,40 +172,36 @@ type CreateServiceInput struct { HealthCheckGracePeriodSeconds *int32 // The infrastructure that you run your service on. For more information, see - // Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. The FARGATE launch type - // runs your tasks on Fargate On-Demand infrastructure. Fargate Spot infrastructure - // is available for use but a capacity provider strategy must be used. For more - // information, see Fargate capacity providers - // (https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html) - // in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks on - // Amazon EC2 instances registered to your cluster. The EXTERNAL launch type runs - // your tasks on your on-premises server or virtual machine (VM) capacity + // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. The FARGATE launch + // type runs your tasks on Fargate On-Demand infrastructure. Fargate Spot + // infrastructure is available for use but a capacity provider strategy must be + // used. For more information, see Fargate capacity providers (https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html) + // in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks + // on Amazon EC2 instances registered to your cluster. The EXTERNAL launch type + // runs your tasks on your on-premises server or virtual machine (VM) capacity // registered to your cluster. A service can use either a launch type or a capacity // provider strategy. If a launchType is specified, the capacityProviderStrategy // parameter must be omitted. LaunchType types.LaunchType - // A load balancer object representing the load balancers to use with your service. - // For more information, see Service load balancing - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) + // A load balancer object representing the load balancers to use with your + // service. For more information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) // in the Amazon Elastic Container Service Developer Guide. If the service uses the - // rolling update (ECS) deployment controller and using either an Application Load - // Balancer or Network Load Balancer, you must specify one or more target group - // ARNs to attach to the service. The service-linked role is required for services - // that use multiple target groups. For more information, see Using service-linked - // roles for Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) + // rolling update ( ECS ) deployment controller and using either an Application + // Load Balancer or Network Load Balancer, you must specify one or more target + // group ARNs to attach to the service. The service-linked role is required for + // services that use multiple target groups. For more information, see Using + // service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. If the service uses the // CODE_DEPLOY deployment controller, the service is required to use either an // Application Load Balancer or Network Load Balancer. When creating an CodeDeploy // deployment group, you specify two target groups (referred to as a - // targetGroupPair). During a deployment, CodeDeploy determines which task set in - // your service has the status PRIMARY, and it associates one target group with it. - // Then, it also associates the other target group with the replacement task set. - // The load balancer can also have up to two listeners: a required listener for - // production traffic and an optional listener that you can use to perform + // targetGroupPair ). During a deployment, CodeDeploy determines which task set in + // your service has the status PRIMARY , and it associates one target group with + // it. Then, it also associates the other target group with the replacement task + // set. The load balancer can also have up to two listeners: a required listener + // for production traffic and an optional listener that you can use to perform // validation tests with Lambda functions before routing production traffic to it. // If you use the CODE_DEPLOY deployment controller, these values can be changed // when updating the service. For Application Load Balancers and Network Load @@ -232,11 +216,11 @@ type CreateServiceInput struct { // name must be as it appears in a container definition. The target group ARN // parameter must be omitted. When a task from this service is placed on a // container instance, the container instance is registered with the load balancer - // that's specified here. Services with tasks that use the awsvpc network mode (for - // example, those with the Fargate launch type) only support Application Load + // that's specified here. Services with tasks that use the awsvpc network mode + // (for example, those with the Fargate launch type) only support Application Load // Balancers and Network Load Balancers. Classic Load Balancers aren't supported. // Also, when you create any target groups for these services, you must choose ip - // as the target type, not instance. This is because tasks that use the awsvpc + // as the target type, not instance . This is because tasks that use the awsvpc // network mode are associated with an elastic network interface, not an Amazon EC2 // instance. LoadBalancers []types.LoadBalancer @@ -244,8 +228,7 @@ type CreateServiceInput struct { // The network configuration for the service. This parameter is required for task // definitions that use the awsvpc network mode to receive their own elastic // network interface, and it isn't supported for other network modes. For more - // information, see Task networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // information, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *types.NetworkConfiguration @@ -254,23 +237,21 @@ type CreateServiceInput struct { // constraints in the task definition and those specified at runtime. PlacementConstraints []types.PlacementConstraint - // The placement strategy objects to use for tasks in your service. You can specify - // a maximum of 5 strategy rules for each service. + // The placement strategy objects to use for tasks in your service. You can + // specify a maximum of 5 strategy rules for each service. PlacementStrategy []types.PlacementStrategy // The platform version that your tasks in the service are running on. A platform // version is specified only for tasks using the Fargate launch type. If one isn't // specified, the LATEST platform version is used. For more information, see - // Fargate platform versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags aren't propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags aren't propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use the TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) // API action. PropagateTags types.PropagateTags @@ -285,38 +266,33 @@ type CreateServiceInput struct { // mode or if the service is configured to use service discovery, an external // deployment controller, multiple target groups, or Elastic Inference accelerators // in which case you don't specify a role here. For more information, see Using - // service-linked roles for Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) + // service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. If your specified role - // has a path other than /, then you must either specify the full role ARN (this is - // recommended) or prefix the role name with the path. For example, if a role with - // the name bar has a path of /foo/ then you would specify /foo/bar as the role - // name. For more information, see Friendly names and paths - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) + // has a path other than / , then you must either specify the full role ARN (this + // is recommended) or prefix the role name with the path. For example, if a role + // with the name bar has a path of /foo/ then you would specify /foo/bar as the + // role name. For more information, see Friendly names and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) // in the IAM User Guide. Role *string // The scheduling strategy to use for the service. For more information, see - // Services - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). - // There are two service scheduler strategies available: - // - // * REPLICA-The replica - // scheduling strategy places and maintains the desired number of tasks across your - // cluster. By default, the service scheduler spreads tasks across Availability - // Zones. You can use task placement strategies and constraints to customize task - // placement decisions. This scheduler strategy is required if the service uses the - // CODE_DEPLOY or EXTERNAL deployment controller types. - // - // * DAEMON-The daemon - // scheduling strategy deploys exactly one task on each active container instance - // that meets all of the task placement constraints that you specify in your - // cluster. The service scheduler also evaluates the task placement constraints for - // running tasks and will stop tasks that don't meet the placement constraints. - // When you're using this strategy, you don't need to specify a desired number of - // tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks - // using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment - // controller types don't support the DAEMON scheduling strategy. + // Services (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) + // . There are two service scheduler strategies available: + // - REPLICA -The replica scheduling strategy places and maintains the desired + // number of tasks across your cluster. By default, the service scheduler spreads + // tasks across Availability Zones. You can use task placement strategies and + // constraints to customize task placement decisions. This scheduler strategy is + // required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller + // types. + // - DAEMON -The daemon scheduling strategy deploys exactly one task on each + // active container instance that meets all of the task placement constraints that + // you specify in your cluster. The service scheduler also evaluates the task + // placement constraints for running tasks and will stop tasks that don't meet the + // placement constraints. When you're using this strategy, you don't need to + // specify a desired number of tasks, a task placement strategy, or use Service + // Auto Scaling policies. Tasks using the Fargate launch type or the CODE_DEPLOY + // or EXTERNAL deployment controller types don't support the DAEMON scheduling + // strategy. SchedulingStrategy types.SchedulingStrategy // The configuration for this service to discover and connect to services, and be @@ -325,15 +301,13 @@ type CreateServiceInput struct { // Tasks can connect to services across all of the clusters in the namespace. Tasks // connect through a managed proxy container that collects logs and metrics for // increased visibility. Only the tasks that Amazon ECS services create are - // supported with Service Connect. For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectConfiguration *types.ServiceConnectConfiguration // The details of the service discovery registry to associate with this service. - // For more information, see Service discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - // Each service may be associated with one service registry. Multiple service + // For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) + // . Each service may be associated with one service registry. Multiple service // registries for each service isn't supported. ServiceRegistries []types.ServiceRegistry @@ -341,37 +315,26 @@ type CreateServiceInput struct { // them. Each tag consists of a key and an optional value, both of which you // define. When a service is deleted, the tags are deleted as well. The following // basic restrictions apply to tags: - // - // * Maximum number of tags per resource - 50 - // - // * - // For each resource, each tag key must be unique, and each tag key can have only - // one value. - // - // * Maximum key length - 128 Unicode characters in UTF-8 - // - // * Maximum - // value length - 256 Unicode characters in UTF-8 - // - // * If your tagging schema is used - // across multiple services and resources, remember that other services may have - // restrictions on allowed characters. Generally allowed characters are: letters, - // numbers, and spaces representable in UTF-8, and the following characters: + - = - // . _ : / @. - // - // * Tag keys and values are case-sensitive. - // - // * Do not use aws:, AWS:, - // or any upper or lowercase combination of such as a prefix for either keys or - // values as it is reserved for Amazon Web Services use. You cannot edit or delete - // tag keys or values with this prefix. Tags with this prefix do not count against - // your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag - // The family and revision (family:revision) or full ARN of the task definition to - // run in your service. If a revision isn't specified, the latest ACTIVE revision - // is used. A task definition must be specified if the service uses either the ECS - // or CODE_DEPLOY deployment controllers. + // The family and revision ( family:revision ) or full ARN of the task definition + // to run in your service. If a revision isn't specified, the latest ACTIVE + // revision is used. A task definition must be specified if the service uses either + // the ECS or CODE_DEPLOY deployment controllers. TaskDefinition *string noSmithyDocumentSerde @@ -382,10 +345,10 @@ type CreateServiceOutput struct { // The full description of your service following the create call. A service will // return either a capacityProviderStrategy or launchType parameter, but not both, // depending where one was specified when it was created. If a service is using the - // ECS deployment controller, the deploymentController and taskSets parameters will - // not be returned. if the service uses the CODE_DEPLOY deployment controller, the - // deploymentController, taskSets and deployments parameters will be returned, - // however the deployments parameter will be an empty list. + // ECS deployment controller, the deploymentController and taskSets parameters + // will not be returned. if the service uses the CODE_DEPLOY deployment + // controller, the deploymentController , taskSets and deployments parameters will + // be returned, however the deployments parameter will be an empty list. Service *types.Service // Metadata pertaining to the operation's result. diff --git a/service/ecs/api_op_CreateTaskSet.go b/service/ecs/api_op_CreateTaskSet.go index ed4b6b7eba0..7a3c4fb8ca3 100644 --- a/service/ecs/api_op_CreateTaskSet.go +++ b/service/ecs/api_op_CreateTaskSet.go @@ -13,8 +13,7 @@ import ( // Create a task set in the specified cluster and service. This is used when a // service uses the EXTERNAL deployment controller type. For more information, see -// Amazon ECS deployment types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) CreateTaskSet(ctx context.Context, params *CreateTaskSetInput, optFns ...func(*Options)) (*CreateTaskSetOutput, error) { if params == nil { @@ -64,8 +63,8 @@ type CreateTaskSetInput struct { // CreateCapacityProvider API operation. To use a Fargate capacity provider, // specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate // capacity providers are available to all accounts and only need to be associated - // with a cluster to be used. The PutClusterCapacityProviders API operation is used - // to update the list of available capacity providers for a cluster after the + // with a cluster to be used. The PutClusterCapacityProviders API operation is + // used to update the list of available capacity providers for a cluster after the // cluster is created. CapacityProviderStrategy []types.CapacityProviderStrategyItem @@ -74,15 +73,14 @@ type CreateTaskSetInput struct { // allowed. ClientToken *string - // An optional non-unique tag that identifies this task set in external systems. If - // the task set is associated with a service discovery registry, the tasks in this - // task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the - // provided value. + // An optional non-unique tag that identifies this task set in external systems. + // If the task set is associated with a service discovery registry, the tasks in + // this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to + // the provided value. ExternalId *string // The launch type that new tasks in the task set uses. For more information, see - // Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. If a launchType is // specified, the capacityProviderStrategy parameter must be omitted. LaunchType types.LaunchType @@ -105,39 +103,28 @@ type CreateTaskSetInput struct { Scale *types.Scale // The details of the service discovery registries to assign to this task set. For - // more information, see Service discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + // more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) + // . ServiceRegistries []types.ServiceRegistry // The metadata that you apply to the task set to help you categorize and organize // them. Each tag consists of a key and an optional value. You define both. When a // service is deleted, the tags are deleted. The following basic restrictions apply // to tags: - // - // * Maximum number of tags per resource - 50 - // - // * For each resource, each - // tag key must be unique, and each tag key can have only one value. - // - // * Maximum key - // length - 128 Unicode characters in UTF-8 - // - // * Maximum value length - 256 Unicode - // characters in UTF-8 - // - // * If your tagging schema is used across multiple services - // and resources, remember that other services may have restrictions on allowed - // characters. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag - // keys and values are case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or - // lowercase combination of such as a prefix for either keys or values as it is - // reserved for Amazon Web Services use. You cannot edit or delete tag keys or - // values with this prefix. Tags with this prefix do not count against your tags - // per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ecs/api_op_DeleteAccountSetting.go b/service/ecs/api_op_DeleteAccountSetting.go index 918f60b36a3..72434dc2f56 100644 --- a/service/ecs/api_op_DeleteAccountSetting.go +++ b/service/ecs/api_op_DeleteAccountSetting.go @@ -30,8 +30,8 @@ func (c *Client) DeleteAccountSetting(ctx context.Context, params *DeleteAccount type DeleteAccountSettingInput struct { - // The resource name to disable the account setting for. If serviceLongArnFormat is - // specified, the ARN for your Amazon ECS services is affected. If + // The resource name to disable the account setting for. If serviceLongArnFormat + // is specified, the ARN for your Amazon ECS services is affected. If // taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS // tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and // resource ID for your Amazon ECS container instances is affected. If @@ -41,11 +41,11 @@ type DeleteAccountSettingInput struct { // This member is required. Name types.SettingName - // The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the - // root user. If you specify the root user, it disables the account setting for all - // users, roles, and the root user of the account unless a user or role explicitly - // overrides these settings. If this field is omitted, the setting is changed only - // for the authenticated user. + // The Amazon Resource Name (ARN) of the principal. It can be an user, role, or + // the root user. If you specify the root user, it disables the account setting for + // all users, roles, and the root user of the account unless a user or role + // explicitly overrides these settings. If this field is omitted, the setting is + // changed only for the authenticated user. PrincipalArn *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_DeleteAttributes.go b/service/ecs/api_op_DeleteAttributes.go index b922dc4b2f1..8d0fd9cd45c 100644 --- a/service/ecs/api_op_DeleteAttributes.go +++ b/service/ecs/api_op_DeleteAttributes.go @@ -29,10 +29,10 @@ func (c *Client) DeleteAttributes(ctx context.Context, params *DeleteAttributesI type DeleteAttributesInput struct { - // The attributes to delete from your resource. You can specify up to 10 attributes - // for each request. For custom attributes, specify the attribute name and target - // ID, but don't specify the value. If you specify the target ID using the short - // form, you must also specify the target type. + // The attributes to delete from your resource. You can specify up to 10 + // attributes for each request. For custom attributes, specify the attribute name + // and target ID, but don't specify the value. If you specify the target ID using + // the short form, you must also specify the target type. // // This member is required. Attributes []types.Attribute diff --git a/service/ecs/api_op_DeleteCluster.go b/service/ecs/api_op_DeleteCluster.go index 82f18d369da..71d0235f0bc 100644 --- a/service/ecs/api_op_DeleteCluster.go +++ b/service/ecs/api_op_DeleteCluster.go @@ -12,12 +12,12 @@ import ( ) // Deletes the specified cluster. The cluster transitions to the INACTIVE state. -// Clusters with an INACTIVE status might remain discoverable in your account for a -// period of time. However, this behavior is subject to change in the future. We +// Clusters with an INACTIVE status might remain discoverable in your account for +// a period of time. However, this behavior is subject to change in the future. We // don't recommend that you rely on INACTIVE clusters persisting. You must // deregister all container instances from this cluster before you may delete it. // You can list the container instances in a cluster with ListContainerInstances -// and deregister them with DeregisterContainerInstance. +// and deregister them with DeregisterContainerInstance . func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error) { if params == nil { params = &DeleteClusterInput{} diff --git a/service/ecs/api_op_DeleteService.go b/service/ecs/api_op_DeleteService.go index d55d8ea32cd..6024b74107a 100644 --- a/service/ecs/api_op_DeleteService.go +++ b/service/ecs/api_op_DeleteService.go @@ -14,18 +14,18 @@ import ( // Deletes a specified service within a cluster. You can delete a service if you // have no running tasks in it and the desired task count is zero. If the service // is actively maintaining tasks, you can't delete it, and you must update the -// service to a desired task count of zero. For more information, see -// UpdateService. When you delete a service, if there are still running tasks that -// require cleanup, the service status moves from ACTIVE to DRAINING, and the -// service is no longer visible in the console or in the ListServices API -// operation. After all tasks have transitioned to either STOPPING or STOPPED -// status, the service status moves from DRAINING to INACTIVE. Services in the -// DRAINING or INACTIVE status can still be viewed with the DescribeServices API -// operation. However, in the future, INACTIVE services may be cleaned up and -// purged from Amazon ECS record keeping, and DescribeServices calls on those -// services return a ServiceNotFoundException error. If you attempt to create a new -// service with the same name as an existing service in either ACTIVE or DRAINING -// status, you receive an error. +// service to a desired task count of zero. For more information, see UpdateService +// . When you delete a service, if there are still running tasks that require +// cleanup, the service status moves from ACTIVE to DRAINING , and the service is +// no longer visible in the console or in the ListServices API operation. After +// all tasks have transitioned to either STOPPING or STOPPED status, the service +// status moves from DRAINING to INACTIVE . Services in the DRAINING or INACTIVE +// status can still be viewed with the DescribeServices API operation. However, in +// the future, INACTIVE services may be cleaned up and purged from Amazon ECS +// record keeping, and DescribeServices calls on those services return a +// ServiceNotFoundException error. If you attempt to create a new service with the +// same name as an existing service in either ACTIVE or DRAINING status, you +// receive an error. func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error) { if params == nil { params = &DeleteServiceInput{} @@ -53,7 +53,7 @@ type DeleteServiceInput struct { // assumed. Cluster *string - // If true, allows you to delete a service even if it wasn't scaled down to zero + // If true , allows you to delete a service even if it wasn't scaled down to zero // tasks. It's only necessary to use this if the service uses the REPLICA // scheduling strategy. Force *bool diff --git a/service/ecs/api_op_DeleteTaskDefinitions.go b/service/ecs/api_op_DeleteTaskDefinitions.go index 9c52153bdc6..a60946f7c84 100644 --- a/service/ecs/api_op_DeleteTaskDefinitions.go +++ b/service/ecs/api_op_DeleteTaskDefinitions.go @@ -13,18 +13,17 @@ import ( // Deletes one or more task definitions. You must deregister a task definition // revision before you delete it. For more information, see -// DeregisterTaskDefinition -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html). -// When you delete a task definition revision, it is immediately transitions from -// the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a -// DELETE_IN_PROGRESS task definition revision continue to run without disruption. -// Existing services that reference a DELETE_IN_PROGRESS task definition revision -// can still scale up or down by modifying the service's desired count. You can't -// use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new -// services. You also can't update an existing service to reference a -// DELETE_IN_PROGRESS task definition revision. A task definition revision will -// stay in DELETE_IN_PROGRESS status until all the associated tasks and services -// have been terminated. +// DeregisterTaskDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html) +// . When you delete a task definition revision, it is immediately transitions from +// the INACTIVE to DELETE_IN_PROGRESS . Existing tasks and services that reference +// a DELETE_IN_PROGRESS task definition revision continue to run without +// disruption. Existing services that reference a DELETE_IN_PROGRESS task +// definition revision can still scale up or down by modifying the service's +// desired count. You can't use a DELETE_IN_PROGRESS task definition revision to +// run new tasks or create new services. You also can't update an existing service +// to reference a DELETE_IN_PROGRESS task definition revision. A task definition +// revision will stay in DELETE_IN_PROGRESS status until all the associated tasks +// and services have been terminated. func (c *Client) DeleteTaskDefinitions(ctx context.Context, params *DeleteTaskDefinitionsInput, optFns ...func(*Options)) (*DeleteTaskDefinitionsOutput, error) { if params == nil { params = &DeleteTaskDefinitionsInput{} @@ -42,9 +41,9 @@ func (c *Client) DeleteTaskDefinitions(ctx context.Context, params *DeleteTaskDe type DeleteTaskDefinitionsInput struct { - // The family and revision (family:revision) or full Amazon Resource Name (ARN) of - // the task definition to delete. You must specify a revision. You can specify up - // to 10 task definitions as a comma separated list. + // The family and revision ( family:revision ) or full Amazon Resource Name (ARN) + // of the task definition to delete. You must specify a revision . You can specify + // up to 10 task definitions as a comma separated list. // // This member is required. TaskDefinitions []string diff --git a/service/ecs/api_op_DeleteTaskSet.go b/service/ecs/api_op_DeleteTaskSet.go index 0fabbd8b851..f91634f5cf7 100644 --- a/service/ecs/api_op_DeleteTaskSet.go +++ b/service/ecs/api_op_DeleteTaskSet.go @@ -13,8 +13,7 @@ import ( // Deletes a specified task set within a service. This is used when a service uses // the EXTERNAL deployment controller type. For more information, see Amazon ECS -// deployment types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) DeleteTaskSet(ctx context.Context, params *DeleteTaskSetInput, optFns ...func(*Options)) (*DeleteTaskSetOutput, error) { if params == nil { @@ -50,7 +49,7 @@ type DeleteTaskSetInput struct { // This member is required. TaskSet *string - // If true, you can delete a task set even if it hasn't been scaled down to zero. + // If true , you can delete a task set even if it hasn't been scaled down to zero. Force *bool noSmithyDocumentSerde diff --git a/service/ecs/api_op_DeregisterContainerInstance.go b/service/ecs/api_op_DeregisterContainerInstance.go index 1bce46de057..30486ea7a6c 100644 --- a/service/ecs/api_op_DeregisterContainerInstance.go +++ b/service/ecs/api_op_DeregisterContainerInstance.go @@ -40,8 +40,7 @@ func (c *Client) DeregisterContainerInstance(ctx context.Context, params *Deregi type DeregisterContainerInstanceInput struct { // The container instance ID or full ARN of the container instance to deregister. - // For more information about the ARN format, see Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + // For more information about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) // in the Amazon ECS Developer Guide. // // This member is required. @@ -53,9 +52,9 @@ type DeregisterContainerInstanceInput struct { Cluster *string // Forces the container instance to be deregistered. If you have tasks running on - // the container instance when you deregister it with the force option, these tasks - // remain running until you terminate the instance or the tasks stop through some - // other means, but they're orphaned (no longer monitored or accounted for by + // the container instance when you deregister it with the force option, these + // tasks remain running until you terminate the instance or the tasks stop through + // some other means, but they're orphaned (no longer monitored or accounted for by // Amazon ECS). If an orphaned task on your container instance is part of an Amazon // ECS service, then the service scheduler starts another copy of that task, on a // different container instance if possible. Any containers in orphaned service diff --git a/service/ecs/api_op_DeregisterTaskDefinition.go b/service/ecs/api_op_DeregisterTaskDefinition.go index 4803c8c061d..772ed9db492 100644 --- a/service/ecs/api_op_DeregisterTaskDefinition.go +++ b/service/ecs/api_op_DeregisterTaskDefinition.go @@ -12,7 +12,7 @@ import ( ) // Deregisters the specified task definition by family and revision. Upon -// deregistration, the task definition is marked as INACTIVE. Existing tasks and +// deregistration, the task definition is marked as INACTIVE . Existing tasks and // services that reference an INACTIVE task definition continue to run without // disruption. Existing services that reference an INACTIVE task definition can // still scale up or down by modifying the service's desired count. If you want to @@ -25,8 +25,8 @@ import ( // However, this behavior is subject to change in the future. We don't recommend // that you rely on INACTIVE task definitions persisting beyond the lifecycle of // any associated tasks and services. You must deregister a task definition -// revision before you delete it. For more information, see DeleteTaskDefinitions -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html). +// revision before you delete it. For more information, see DeleteTaskDefinitions (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html) +// . func (c *Client) DeregisterTaskDefinition(ctx context.Context, params *DeregisterTaskDefinitionInput, optFns ...func(*Options)) (*DeregisterTaskDefinitionOutput, error) { if params == nil { params = &DeregisterTaskDefinitionInput{} @@ -44,8 +44,8 @@ func (c *Client) DeregisterTaskDefinition(ctx context.Context, params *Deregiste type DeregisterTaskDefinitionInput struct { - // The family and revision (family:revision) or full Amazon Resource Name (ARN) of - // the task definition to deregister. You must specify a revision. + // The family and revision ( family:revision ) or full Amazon Resource Name (ARN) + // of the task definition to deregister. You must specify a revision . // // This member is required. TaskDefinition *string diff --git a/service/ecs/api_op_DescribeCapacityProviders.go b/service/ecs/api_op_DescribeCapacityProviders.go index f071cfbde63..5c9d7693fbc 100644 --- a/service/ecs/api_op_DescribeCapacityProviders.go +++ b/service/ecs/api_op_DescribeCapacityProviders.go @@ -40,12 +40,12 @@ type DescribeCapacityProvidersInput struct { // The maximum number of account setting results returned by // DescribeCapacityProviders in paginated output. When this parameter is used, - // DescribeCapacityProviders only returns maxResults results in a single page along - // with a nextToken response element. The remaining results of the initial request - // can be seen by sending another DescribeCapacityProviders request with the - // returned nextToken value. This value can be between 1 and 10. If this parameter - // is not used, then DescribeCapacityProviders returns up to 10 results and a - // nextToken value if applicable. + // DescribeCapacityProviders only returns maxResults results in a single page + // along with a nextToken response element. The remaining results of the initial + // request can be seen by sending another DescribeCapacityProviders request with + // the returned nextToken value. This value can be between 1 and 10. If this + // parameter is not used, then DescribeCapacityProviders returns up to 10 results + // and a nextToken value if applicable. MaxResults *int32 // The nextToken value returned from a previous paginated DescribeCapacityProviders @@ -68,7 +68,7 @@ type DescribeCapacityProvidersOutput struct { Failures []types.Failure // The nextToken value to include in a future DescribeCapacityProviders request. - // When the results of a DescribeCapacityProviders request exceed maxResults, this + // When the results of a DescribeCapacityProviders request exceed maxResults , this // value can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string diff --git a/service/ecs/api_op_DescribeContainerInstances.go b/service/ecs/api_op_DescribeContainerInstances.go index b263ee3b6bf..ba4bea44333 100644 --- a/service/ecs/api_op_DescribeContainerInstances.go +++ b/service/ecs/api_op_DescribeContainerInstances.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more container instances. Returns metadata about each container -// instance requested. +// Describes one or more container instances. Returns metadata about each +// container instance requested. func (c *Client) DescribeContainerInstances(ctx context.Context, params *DescribeContainerInstancesInput, optFns ...func(*Options)) (*DescribeContainerInstancesOutput, error) { if params == nil { params = &DescribeContainerInstancesInput{} diff --git a/service/ecs/api_op_DescribeServices.go b/service/ecs/api_op_DescribeServices.go index 057fcbc528c..2cea9e1c9ba 100644 --- a/service/ecs/api_op_DescribeServices.go +++ b/service/ecs/api_op_DescribeServices.go @@ -35,8 +35,8 @@ func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesI type DescribeServicesInput struct { - // A list of services to describe. You may specify up to 10 services to describe in - // a single operation. + // A list of services to describe. You may specify up to 10 services to describe + // in a single operation. // // This member is required. Services []string @@ -47,9 +47,9 @@ type DescribeServicesInput struct { // describing were launched in any cluster other than the default cluster. Cluster *string - // Determines whether you want to see the resource tags for the service. If TAGS is - // specified, the tags are included in the response. If this field is omitted, tags - // aren't included in the response. + // Determines whether you want to see the resource tags for the service. If TAGS + // is specified, the tags are included in the response. If this field is omitted, + // tags aren't included in the response. Include []types.ServiceField noSmithyDocumentSerde @@ -153,9 +153,9 @@ type ServicesInactiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServicesInactiveWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServicesInactiveWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -344,9 +344,9 @@ type ServicesStableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServicesStableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServicesStableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ecs/api_op_DescribeTaskDefinition.go b/service/ecs/api_op_DescribeTaskDefinition.go index 8c0610cd0dc..2fbd600bde4 100644 --- a/service/ecs/api_op_DescribeTaskDefinition.go +++ b/service/ecs/api_op_DescribeTaskDefinition.go @@ -32,9 +32,9 @@ func (c *Client) DescribeTaskDefinition(ctx context.Context, params *DescribeTas type DescribeTaskDefinitionInput struct { - // The family for the latest ACTIVE revision, family and revision (family:revision) - // for a specific revision in the family, or full Amazon Resource Name (ARN) of the - // task definition to describe. + // The family for the latest ACTIVE revision, family and revision ( family:revision + // ) for a specific revision in the family, or full Amazon Resource Name (ARN) of + // the task definition to describe. // // This member is required. TaskDefinition *string @@ -52,31 +52,20 @@ type DescribeTaskDefinitionOutput struct { // The metadata that's applied to the task definition to help you categorize and // organize them. Each tag consists of a key and an optional value. You define // both. The following basic restrictions apply to tags: - // - // * Maximum number of tags - // per resource - 50 - // - // * For each resource, each tag key must be unique, and each - // tag key can have only one value. - // - // * Maximum key length - 128 Unicode characters - // in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag // The full task definition description. diff --git a/service/ecs/api_op_DescribeTaskSets.go b/service/ecs/api_op_DescribeTaskSets.go index 44f35ab334c..3e8404e960d 100644 --- a/service/ecs/api_op_DescribeTaskSets.go +++ b/service/ecs/api_op_DescribeTaskSets.go @@ -13,8 +13,7 @@ import ( // Describes the task sets in the specified cluster and service. This is used when // a service uses the EXTERNAL deployment controller type. For more information, -// see Amazon ECS Deployment Types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) DescribeTaskSets(ctx context.Context, params *DescribeTaskSetsInput, optFns ...func(*Options)) (*DescribeTaskSetsOutput, error) { if params == nil { diff --git a/service/ecs/api_op_DescribeTasks.go b/service/ecs/api_op_DescribeTasks.go index eba05ff4b2c..aab74f1347f 100644 --- a/service/ecs/api_op_DescribeTasks.go +++ b/service/ecs/api_op_DescribeTasks.go @@ -151,9 +151,9 @@ type TasksRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TasksRunningWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TasksRunningWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -373,9 +373,9 @@ type TasksStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TasksStoppedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TasksStoppedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ecs/api_op_DiscoverPollEndpoint.go b/service/ecs/api_op_DiscoverPollEndpoint.go index cc13eb6d811..bcaf5321121 100644 --- a/service/ecs/api_op_DiscoverPollEndpoint.go +++ b/service/ecs/api_op_DiscoverPollEndpoint.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is only used by the Amazon ECS agent, and it is not intended for use -// outside of the agent. Returns an endpoint for the Amazon ECS agent to poll for -// updates. +// This action is only used by the Amazon ECS agent, and it is not intended for +// use outside of the agent. Returns an endpoint for the Amazon ECS agent to poll +// for updates. func (c *Client) DiscoverPollEndpoint(ctx context.Context, params *DiscoverPollEndpointInput, optFns ...func(*Options)) (*DiscoverPollEndpointOutput, error) { if params == nil { params = &DiscoverPollEndpointInput{} @@ -35,8 +35,7 @@ type DiscoverPollEndpointInput struct { Cluster *string // The container instance ID or full ARN of the container instance. For more - // information about the ARN format, see Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + // information about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) // in the Amazon ECS Developer Guide. ContainerInstance *string @@ -48,9 +47,8 @@ type DiscoverPollEndpointOutput struct { // The endpoint for the Amazon ECS agent to poll. Endpoint *string - // The endpoint for the Amazon ECS agent to poll for Service Connect configuration. - // For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // The endpoint for the Amazon ECS agent to poll for Service Connect + // configuration. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectEndpoint *string diff --git a/service/ecs/api_op_ExecuteCommand.go b/service/ecs/api_op_ExecuteCommand.go index 2131d093ff2..a0bde09650e 100644 --- a/service/ecs/api_op_ExecuteCommand.go +++ b/service/ecs/api_op_ExecuteCommand.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs a command remotely on a container within a task. If you use a condition key -// in your IAM policy to refine the conditions for the policy statement, for +// Runs a command remotely on a container within a task. If you use a condition +// key in your IAM policy to refine the conditions for the policy statement, for // example limit the actions to a specific cluster, you receive an // AccessDeniedException when there is a mismatch between the condition key value // and the corresponding parameter value. For information about required -// permissions and considerations, see Using Amazon ECS Exec for debugging -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.htm) in -// the Amazon ECS Developer Guide. +// permissions and considerations, see Using Amazon ECS Exec for debugging (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.htm) +// in the Amazon ECS Developer Guide. func (c *Client) ExecuteCommand(ctx context.Context, params *ExecuteCommandInput, optFns ...func(*Options)) (*ExecuteCommandOutput, error) { if params == nil { params = &ExecuteCommandInput{} @@ -55,8 +54,8 @@ type ExecuteCommandInput struct { // in. If you do not specify a cluster, the default cluster is assumed. Cluster *string - // The name of the container to execute the command on. A container name only needs - // to be specified for tasks containing multiple containers. + // The name of the container to execute the command on. A container name only + // needs to be specified for tasks containing multiple containers. Container *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_GetTaskProtection.go b/service/ecs/api_op_GetTaskProtection.go index 3c78fb55ffa..2536a296356 100644 --- a/service/ecs/api_op_GetTaskProtection.go +++ b/service/ecs/api_op_GetTaskProtection.go @@ -47,15 +47,10 @@ type GetTaskProtectionOutput struct { Failures []types.Failure // A list of tasks with the following information. - // - // * taskArn: The task ARN. - // - // * - // protectionEnabled: The protection status of the task. If scale-in protection is - // enabled for a task, the value is true. Otherwise, it is false. - // - // * - // expirationDate: The epoch time when protection for the task will expire. + // - taskArn : The task ARN. + // - protectionEnabled : The protection status of the task. If scale-in + // protection is enabled for a task, the value is true . Otherwise, it is false . + // - expirationDate : The epoch time when protection for the task will expire. ProtectedTasks []types.ProtectedTask // Metadata pertaining to the operation's result. diff --git a/service/ecs/api_op_ListAccountSettings.go b/service/ecs/api_op_ListAccountSettings.go index 16c9001b262..d02f0ba1050 100644 --- a/service/ecs/api_op_ListAccountSettings.go +++ b/service/ecs/api_op_ListAccountSettings.go @@ -30,19 +30,20 @@ func (c *Client) ListAccountSettings(ctx context.Context, params *ListAccountSet type ListAccountSettingsInput struct { - // Determines whether to return the effective settings. If true, the account + // Determines whether to return the effective settings. If true , the account // settings for the root user or the default setting for the principalArn are - // returned. If false, the account settings for the principalArn are returned if + // returned. If false , the account settings for the principalArn are returned if // they're set. Otherwise, no account settings are returned. EffectiveSettings bool - // The maximum number of account setting results returned by ListAccountSettings in - // paginated output. When this parameter is used, ListAccountSettings only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // ListAccountSettings request with the returned nextToken value. This value can be - // between 1 and 10. If this parameter isn't used, then ListAccountSettings returns - // up to 10 results and a nextToken value if applicable. + // The maximum number of account setting results returned by ListAccountSettings + // in paginated output. When this parameter is used, ListAccountSettings only + // returns maxResults results in a single page along with a nextToken response + // element. The remaining results of the initial request can be seen by sending + // another ListAccountSettings request with the returned nextToken value. This + // value can be between 1 and 10. If this parameter isn't used, then + // ListAccountSettings returns up to 10 results and a nextToken value if + // applicable. MaxResults int32 // The name of the account setting you want to list the settings for. @@ -51,9 +52,9 @@ type ListAccountSettingsInput struct { // The nextToken value returned from a ListAccountSettings request indicating that // more results are available to fulfill the request and further calls will be // needed. If maxResults was provided, it's possible the number of results to be - // fewer than maxResults. This token should be treated as an opaque identifier that - // is only used to retrieve the next items in a list and not for other programmatic - // purposes. + // fewer than maxResults . This token should be treated as an opaque identifier + // that is only used to retrieve the next items in a list and not for other + // programmatic purposes. NextToken *string // The ARN of the principal, which can be a user, role, or the root user. If this @@ -71,10 +72,10 @@ type ListAccountSettingsInput struct { type ListAccountSettingsOutput struct { - // The nextToken value to include in a future ListAccountSettings request. When the - // results of a ListAccountSettings request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListAccountSettings request. When + // the results of a ListAccountSettings request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // The account settings for the resource. @@ -146,8 +147,8 @@ func (c *Client) addOperationListAccountSettingsMiddlewares(stack *middleware.St return nil } -// ListAccountSettingsAPIClient is a client that implements the ListAccountSettings -// operation. +// ListAccountSettingsAPIClient is a client that implements the +// ListAccountSettings operation. type ListAccountSettingsAPIClient interface { ListAccountSettings(context.Context, *ListAccountSettingsInput, ...func(*Options)) (*ListAccountSettingsOutput, error) } @@ -157,13 +158,14 @@ var _ ListAccountSettingsAPIClient = (*Client)(nil) // ListAccountSettingsPaginatorOptions is the paginator options for // ListAccountSettings type ListAccountSettingsPaginatorOptions struct { - // The maximum number of account setting results returned by ListAccountSettings in - // paginated output. When this parameter is used, ListAccountSettings only returns - // maxResults results in a single page along with a nextToken response element. The - // remaining results of the initial request can be seen by sending another - // ListAccountSettings request with the returned nextToken value. This value can be - // between 1 and 10. If this parameter isn't used, then ListAccountSettings returns - // up to 10 results and a nextToken value if applicable. + // The maximum number of account setting results returned by ListAccountSettings + // in paginated output. When this parameter is used, ListAccountSettings only + // returns maxResults results in a single page along with a nextToken response + // element. The remaining results of the initial request can be seen by sending + // another ListAccountSettings request with the returned nextToken value. This + // value can be between 1 and 10. If this parameter isn't used, then + // ListAccountSettings returns up to 10 results and a nextToken value if + // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecs/api_op_ListAttributes.go b/service/ecs/api_op_ListAttributes.go index aa317fce4ce..ae1362eeead 100644 --- a/service/ecs/api_op_ListAttributes.go +++ b/service/ecs/api_op_ListAttributes.go @@ -12,13 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the attributes for Amazon ECS resources within a specified target type and -// cluster. When you specify a target type and cluster, ListAttributes returns a -// list of attribute objects, one for each attribute on each resource. You can +// Lists the attributes for Amazon ECS resources within a specified target type +// and cluster. When you specify a target type and cluster, ListAttributes returns +// a list of attribute objects, one for each attribute on each resource. You can // filter the list of results to a single attribute name to only return results // that have that name. You can also filter the results by attribute name and // value. You can do this, for example, to see which container instances in a -// cluster are running a Linux AMI (ecs.os-type=linux). +// cluster are running a Linux AMI ( ecs.os-type=linux ). func (c *Client) ListAttributes(ctx context.Context, params *ListAttributesInput, optFns ...func(*Options)) (*ListAttributesOutput, error) { if params == nil { params = &ListAttributesInput{} @@ -64,7 +64,7 @@ type ListAttributesInput struct { // The nextToken value returned from a ListAttributes request indicating that more // results are available to fulfill the request and further calls are needed. If // maxResults was provided, it's possible the number of results to be fewer than - // maxResults. This token should be treated as an opaque identifier that is only + // maxResults . This token should be treated as an opaque identifier that is only // used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string @@ -78,8 +78,8 @@ type ListAttributesOutput struct { Attributes []types.Attribute // The nextToken value to include in a future ListAttributes request. When the - // results of a ListAttributes request exceed maxResults, this value can be used to - // retrieve the next page of results. This value is null when there are no more + // results of a ListAttributes request exceed maxResults , this value can be used + // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/ecs/api_op_ListClusters.go b/service/ecs/api_op_ListClusters.go index 58357bad38e..49fea26ce88 100644 --- a/service/ecs/api_op_ListClusters.go +++ b/service/ecs/api_op_ListClusters.go @@ -41,7 +41,7 @@ type ListClustersInput struct { // The nextToken value returned from a ListClusters request indicating that more // results are available to fulfill the request and further calls are needed. If // maxResults was provided, it's possible the number of results to be fewer than - // maxResults. This token should be treated as an opaque identifier that is only + // maxResults . This token should be treated as an opaque identifier that is only // used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string @@ -56,7 +56,7 @@ type ListClustersOutput struct { ClusterArns []string // The nextToken value to include in a future ListClusters request. When the - // results of a ListClusters request exceed maxResults, this value can be used to + // results of a ListClusters request exceed maxResults , this value can be used to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/ecs/api_op_ListContainerInstances.go b/service/ecs/api_op_ListContainerInstances.go index 17f23bd8c50..2cfda3029aa 100644 --- a/service/ecs/api_op_ListContainerInstances.go +++ b/service/ecs/api_op_ListContainerInstances.go @@ -12,11 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of container instances in a specified cluster. You can filter the -// results of a ListContainerInstances operation with cluster query language +// Returns a list of container instances in a specified cluster. You can filter +// the results of a ListContainerInstances operation with cluster query language // statements inside the filter parameter. For more information, see Cluster Query -// Language -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) +// Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) ListContainerInstances(ctx context.Context, params *ListContainerInstancesInput, optFns ...func(*Options)) (*ListContainerInstancesOutput, error) { if params == nil { @@ -41,8 +40,7 @@ type ListContainerInstancesInput struct { Cluster *string // You can filter the results of a ListContainerInstances operation with cluster - // query language statements. For more information, see Cluster Query Language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // query language statements. For more information, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Filter *string @@ -59,16 +57,16 @@ type ListContainerInstancesInput struct { // The nextToken value returned from a ListContainerInstances request indicating // that more results are available to fulfill the request and further calls are // needed. If maxResults was provided, it's possible the number of results to be - // fewer than maxResults. This token should be treated as an opaque identifier that - // is only used to retrieve the next items in a list and not for other programmatic - // purposes. + // fewer than maxResults . This token should be treated as an opaque identifier + // that is only used to retrieve the next items in a list and not for other + // programmatic purposes. NextToken *string // Filters the container instances by status. For example, if you specify the // DRAINING status, the results include only container instances that have been set - // to DRAINING using UpdateContainerInstancesState. If you don't specify this + // to DRAINING using UpdateContainerInstancesState . If you don't specify this // parameter, the default is to include container instances set to all states other - // than INACTIVE. + // than INACTIVE . Status types.ContainerInstanceStatus noSmithyDocumentSerde @@ -81,7 +79,7 @@ type ListContainerInstancesOutput struct { ContainerInstanceArns []string // The nextToken value to include in a future ListContainerInstances request. When - // the results of a ListContainerInstances request exceed maxResults, this value + // the results of a ListContainerInstances request exceed maxResults , this value // can be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string diff --git a/service/ecs/api_op_ListServices.go b/service/ecs/api_op_ListServices.go index 821c6724555..adf50bb0cbb 100644 --- a/service/ecs/api_op_ListServices.go +++ b/service/ecs/api_op_ListServices.go @@ -32,8 +32,8 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op type ListServicesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster to use when - // filtering the ListServices results. If you do not specify a cluster, the default - // cluster is assumed. + // filtering the ListServices results. If you do not specify a cluster, the + // default cluster is assumed. Cluster *string // The launch type to use when filtering the ListServices results. @@ -51,7 +51,7 @@ type ListServicesInput struct { // The nextToken value returned from a ListServices request indicating that more // results are available to fulfill the request and further calls will be needed. // If maxResults was provided, it is possible the number of results to be fewer - // than maxResults. This token should be treated as an opaque identifier that is + // than maxResults . This token should be treated as an opaque identifier that is // only used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string @@ -65,7 +65,7 @@ type ListServicesInput struct { type ListServicesOutput struct { // The nextToken value to include in a future ListServices request. When the - // results of a ListServices request exceed maxResults, this value can be used to + // results of a ListServices request exceed maxResults , this value can be used to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/ecs/api_op_ListServicesByNamespace.go b/service/ecs/api_op_ListServicesByNamespace.go index 056e484cdb3..88c0f5e1eb0 100644 --- a/service/ecs/api_op_ListServicesByNamespace.go +++ b/service/ecs/api_op_ListServicesByNamespace.go @@ -15,8 +15,7 @@ import ( // namespace. This list might include services in different clusters. In contrast, // ListServices can only list services in one cluster at a time. If you need to // filter the list of services in a single cluster by various parameters, use -// ListServices. For more information, see Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// ListServices . For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) ListServicesByNamespace(ctx context.Context, params *ListServicesByNamespaceInput, optFns ...func(*Options)) (*ListServicesByNamespaceOutput, error) { if params == nil { @@ -35,14 +34,13 @@ func (c *Client) ListServicesByNamespace(ctx context.Context, params *ListServic type ListServicesByNamespaceInput struct { - // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace - // to list the services in. Tasks that run in a namespace can use short names to - // connect to services in the namespace. Tasks can connect to services across all - // of the clusters in the namespace. Tasks connect through a managed proxy - // container that collects logs and metrics for increased visibility. Only the - // tasks that Amazon ECS services create are supported with Service Connect. For - // more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map + // namespace to list the services in. Tasks that run in a namespace can use short + // names to connect to services in the namespace. Tasks can connect to services + // across all of the clusters in the namespace. Tasks connect through a managed + // proxy container that collects logs and metrics for increased visibility. Only + // the tasks that Amazon ECS services create are supported with Service Connect. + // For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. // // This member is required. @@ -61,7 +59,7 @@ type ListServicesByNamespaceInput struct { // The nextToken value that's returned from a ListServicesByNamespace request. It // indicates that more results are available to fulfill the request and further // calls are needed. If maxResults is returned, it is possible the number of - // results is less than maxResults. + // results is less than maxResults . NextToken *string noSmithyDocumentSerde @@ -69,10 +67,10 @@ type ListServicesByNamespaceInput struct { type ListServicesByNamespaceOutput struct { - // The nextToken value to include in a future ListServicesByNamespace request. When - // the results of a ListServicesByNamespace request exceed maxResults, this value - // can be used to retrieve the next page of results. When there are no more results - // to return, this value is null. + // The nextToken value to include in a future ListServicesByNamespace request. + // When the results of a ListServicesByNamespace request exceed maxResults , this + // value can be used to retrieve the next page of results. When there are no more + // results to return, this value is null . NextToken *string // The list of full ARN entries for each service that's associated with the diff --git a/service/ecs/api_op_ListTaskDefinitionFamilies.go b/service/ecs/api_op_ListTaskDefinitionFamilies.go index 6349c652aaf..5e97d274d01 100644 --- a/service/ecs/api_op_ListTaskDefinitionFamilies.go +++ b/service/ecs/api_op_ListTaskDefinitionFamilies.go @@ -16,7 +16,7 @@ import ( // This list includes task definition families that no longer have any ACTIVE task // definition revisions. You can filter out task definition families that don't // contain any ACTIVE task definition revisions by setting the status parameter to -// ACTIVE. You can also filter the results with the familyPrefix parameter. +// ACTIVE . You can also filter the results with the familyPrefix parameter. func (c *Client) ListTaskDefinitionFamilies(ctx context.Context, params *ListTaskDefinitionFamiliesInput, optFns ...func(*Options)) (*ListTaskDefinitionFamiliesOutput, error) { if params == nil { params = &ListTaskDefinitionFamiliesInput{} @@ -35,33 +35,33 @@ func (c *Client) ListTaskDefinitionFamilies(ctx context.Context, params *ListTas type ListTaskDefinitionFamiliesInput struct { // The familyPrefix is a string that's used to filter the results of - // ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition - // family names that begin with the familyPrefix string are returned. + // ListTaskDefinitionFamilies . If you specify a familyPrefix , only task + // definition family names that begin with the familyPrefix string are returned. FamilyPrefix *string // The maximum number of task definition family results that // ListTaskDefinitionFamilies returned in paginated output. When this parameter is - // used, ListTaskDefinitions only returns maxResults results in a single page along - // with a nextToken response element. The remaining results of the initial request - // can be seen by sending another ListTaskDefinitionFamilies request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a - // nextToken value if applicable. + // used, ListTaskDefinitions only returns maxResults results in a single page + // along with a nextToken response element. The remaining results of the initial + // request can be seen by sending another ListTaskDefinitionFamilies request with + // the returned nextToken value. This value can be between 1 and 100. If this + // parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results + // and a nextToken value if applicable. MaxResults *int32 // The nextToken value returned from a ListTaskDefinitionFamilies request // indicating that more results are available to fulfill the request and further // calls will be needed. If maxResults was provided, it is possible the number of - // results to be fewer than maxResults. This token should be treated as an opaque + // results to be fewer than maxResults . This token should be treated as an opaque // identifier that is only used to retrieve the next items in a list and not for // other programmatic purposes. NextToken *string // The task definition family status to filter the ListTaskDefinitionFamilies // results with. By default, both ACTIVE and INACTIVE task definition families are - // listed. If this parameter is set to ACTIVE, only task definition families that + // listed. If this parameter is set to ACTIVE , only task definition families that // have an ACTIVE task definition revision are returned. If this parameter is set - // to INACTIVE, only task definition families that do not have any ACTIVE task + // to INACTIVE , only task definition families that do not have any ACTIVE task // definition revisions are returned. If you paginate the resulting output, be sure // to keep the status value constant in each subsequent request. Status types.TaskDefinitionFamilyStatus @@ -76,9 +76,9 @@ type ListTaskDefinitionFamiliesOutput struct { Families []string // The nextToken value to include in a future ListTaskDefinitionFamilies request. - // When the results of a ListTaskDefinitionFamilies request exceed maxResults, this - // value can be used to retrieve the next page of results. This value is null when - // there are no more results to return. + // When the results of a ListTaskDefinitionFamilies request exceed maxResults , + // this value can be used to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -160,12 +160,12 @@ var _ ListTaskDefinitionFamiliesAPIClient = (*Client)(nil) type ListTaskDefinitionFamiliesPaginatorOptions struct { // The maximum number of task definition family results that // ListTaskDefinitionFamilies returned in paginated output. When this parameter is - // used, ListTaskDefinitions only returns maxResults results in a single page along - // with a nextToken response element. The remaining results of the initial request - // can be seen by sending another ListTaskDefinitionFamilies request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a - // nextToken value if applicable. + // used, ListTaskDefinitions only returns maxResults results in a single page + // along with a nextToken response element. The remaining results of the initial + // request can be seen by sending another ListTaskDefinitionFamilies request with + // the returned nextToken value. This value can be between 1 and 100. If this + // parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results + // and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecs/api_op_ListTaskDefinitions.go b/service/ecs/api_op_ListTaskDefinitions.go index 744aea0d3bd..8c2920459f4 100644 --- a/service/ecs/api_op_ListTaskDefinitions.go +++ b/service/ecs/api_op_ListTaskDefinitions.go @@ -50,13 +50,13 @@ type ListTaskDefinitionsInput struct { // The nextToken value returned from a ListTaskDefinitions request indicating that // more results are available to fulfill the request and further calls will be // needed. If maxResults was provided, it is possible the number of results to be - // fewer than maxResults. This token should be treated as an opaque identifier that - // is only used to retrieve the next items in a list and not for other programmatic - // purposes. + // fewer than maxResults . This token should be treated as an opaque identifier + // that is only used to retrieve the next items in a list and not for other + // programmatic purposes. NextToken *string - // The order to sort the results in. Valid values are ASC and DESC. By default, - // (ASC) task definitions are listed lexicographically by family name and in + // The order to sort the results in. Valid values are ASC and DESC . By default, ( + // ASC ) task definitions are listed lexicographically by family name and in // ascending numerical order by revision so that the newest task definitions in a // family are listed last. Setting this parameter to DESC reverses the sort order // on family name and revision. This is so that the newest task definitions in a @@ -65,7 +65,7 @@ type ListTaskDefinitionsInput struct { // The task definition status to filter the ListTaskDefinitions results with. By // default, only ACTIVE task definitions are listed. By setting this parameter to - // INACTIVE, you can view task definitions that are INACTIVE as long as an active + // INACTIVE , you can view task definitions that are INACTIVE as long as an active // task or service still references them. If you paginate the resulting output, be // sure to keep the status value constant in each subsequent request. Status types.TaskDefinitionStatus @@ -75,10 +75,10 @@ type ListTaskDefinitionsInput struct { type ListTaskDefinitionsOutput struct { - // The nextToken value to include in a future ListTaskDefinitions request. When the - // results of a ListTaskDefinitions request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListTaskDefinitions request. When + // the results of a ListTaskDefinitions request exceed maxResults , this value can + // be used to retrieve the next page of results. This value is null when there are + // no more results to return. NextToken *string // The list of task definition Amazon Resource Name (ARN) entries for the @@ -151,8 +151,8 @@ func (c *Client) addOperationListTaskDefinitionsMiddlewares(stack *middleware.St return nil } -// ListTaskDefinitionsAPIClient is a client that implements the ListTaskDefinitions -// operation. +// ListTaskDefinitionsAPIClient is a client that implements the +// ListTaskDefinitions operation. type ListTaskDefinitionsAPIClient interface { ListTaskDefinitions(context.Context, *ListTaskDefinitionsInput, ...func(*Options)) (*ListTaskDefinitionsOutput, error) } diff --git a/service/ecs/api_op_ListTasks.go b/service/ecs/api_op_ListTasks.go index 9b0b09f573d..9697493f6db 100644 --- a/service/ecs/api_op_ListTasks.go +++ b/service/ecs/api_op_ListTasks.go @@ -46,12 +46,12 @@ type ListTasksInput struct { // The task desired status to use when filtering the ListTasks results. Specifying // a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set - // the desired status to STOPPED. This can be useful for debugging tasks that + // the desired status to STOPPED . This can be useful for debugging tasks that // aren't starting properly or have died or finished. The default status filter is - // RUNNING, which shows tasks that Amazon ECS has set the desired status to - // RUNNING. Although you can filter results based on a desired status of PENDING, + // RUNNING , which shows tasks that Amazon ECS has set the desired status to + // RUNNING . Although you can filter results based on a desired status of PENDING , // this doesn't return any results. Amazon ECS never sets the desired status of a - // task to that value (only a task's lastStatus may have a value of PENDING). + // task to that value (only a task's lastStatus may have a value of PENDING ). DesiredStatus types.DesiredStatus // The name of the task definition family to use when filtering the ListTasks @@ -66,16 +66,16 @@ type ListTasksInput struct { // When this parameter is used, ListTasks only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListTasks request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // isn't used, then ListTasks returns up to 100 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 100. If this + // parameter isn't used, then ListTasks returns up to 100 results and a nextToken + // value if applicable. MaxResults *int32 // The nextToken value returned from a ListTasks request indicating that more // results are available to fulfill the request and further calls will be needed. - // If maxResults was provided, it's possible the number of results to be fewer than - // maxResults. This token should be treated as an opaque identifier that is only - // used to retrieve the next items in a list and not for other programmatic + // If maxResults was provided, it's possible the number of results to be fewer + // than maxResults . This token should be treated as an opaque identifier that is + // only used to retrieve the next items in a list and not for other programmatic // purposes. NextToken *string @@ -94,8 +94,8 @@ type ListTasksInput struct { type ListTasksOutput struct { // The nextToken value to include in a future ListTasks request. When the results - // of a ListTasks request exceed maxResults, this value can be used to retrieve the - // next page of results. This value is null when there are no more results to + // of a ListTasks request exceed maxResults , this value can be used to retrieve + // the next page of results. This value is null when there are no more results to // return. NextToken *string @@ -181,9 +181,9 @@ type ListTasksPaginatorOptions struct { // When this parameter is used, ListTasks only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListTasks request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // isn't used, then ListTasks returns up to 100 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 100. If this + // parameter isn't used, then ListTasks returns up to 100 results and a nextToken + // value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ecs/api_op_PutAccountSetting.go b/service/ecs/api_op_PutAccountSetting.go index f0baf6357b7..1907aa1875a 100644 --- a/service/ecs/api_op_PutAccountSetting.go +++ b/service/ecs/api_op_PutAccountSetting.go @@ -14,29 +14,26 @@ import ( // Modifies an account setting. Account settings are set on a per-Region basis. If // you change the account setting for the root user, the default settings for all // of the users and roles that no individual account setting was specified are -// reset for. For more information, see Account Settings -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html) +// reset for. For more information, see Account Settings (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html) // in the Amazon Elastic Container Service Developer Guide. When -// serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are -// specified, the Amazon Resource Name (ARN) and resource ID format of the resource -// type for a specified user, role, or the root user for an account is affected. -// The opt-in and opt-out account setting must be set for each Amazon ECS resource -// separately. The ARN and resource ID format of a resource is defined by the -// opt-in status of the user or role that created the resource. You must turn on -// this setting to use Amazon ECS features such as resource tagging. When +// serviceLongArnFormat , taskLongArnFormat , or containerInstanceLongArnFormat +// are specified, the Amazon Resource Name (ARN) and resource ID format of the +// resource type for a specified user, role, or the root user for an account is +// affected. The opt-in and opt-out account setting must be set for each Amazon ECS +// resource separately. The ARN and resource ID format of a resource is defined by +// the opt-in status of the user or role that created the resource. You must turn +// on this setting to use Amazon ECS features such as resource tagging. When // awsvpcTrunking is specified, the elastic network interface (ENI) limit for any // new container instances that support the feature is changed. If awsvpcTrunking // is enabled, any new container instances that support the feature are launched // have the increased ENI limits available to them. For more information, see -// Elastic Network Interface Trunking -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html) +// Elastic Network Interface Trunking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html) // in the Amazon Elastic Container Service Developer Guide. When containerInsights // is specified, the default setting indicating whether CloudWatch Container // Insights is enabled for your clusters is changed. If containerInsights is // enabled, any new clusters that are created will have Container Insights enabled // unless you disable it during cluster creation. For more information, see -// CloudWatch Container Insights -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) +// CloudWatch Container Insights (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) PutAccountSetting(ctx context.Context, params *PutAccountSettingInput, optFns ...func(*Options)) (*PutAccountSettingOutput, error) { if params == nil { @@ -69,7 +66,7 @@ type PutAccountSettingInput struct { Name types.SettingName // The account setting value for the specified principal ARN. Accepted values are - // enabled and disabled. + // enabled and disabled . // // This member is required. Value *string diff --git a/service/ecs/api_op_PutAccountSettingDefault.go b/service/ecs/api_op_PutAccountSettingDefault.go index c89c508b6e9..751cf9f10e7 100644 --- a/service/ecs/api_op_PutAccountSettingDefault.go +++ b/service/ecs/api_op_PutAccountSettingDefault.go @@ -41,15 +41,14 @@ type PutAccountSettingDefaultInput struct { // for CloudWatch Container Insights for your clusters is affected. Fargate is // transitioning from task count-based quotas to vCPU-based quotas. You can set the // name to fargateVCPULimit to opt in or opt out of the vCPU-based quotas. For - // information about the opt in timeline, see Fargate vCPU-based quotas timeline - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#fargate-quota-timeline) + // information about the opt in timeline, see Fargate vCPU-based quotas timeline (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#fargate-quota-timeline) // in the Amazon ECS Developer Guide. // // This member is required. Name types.SettingName // The account setting value for the specified principal ARN. Accepted values are - // enabled and disabled. + // enabled and disabled . // // This member is required. Value *string diff --git a/service/ecs/api_op_PutAttributes.go b/service/ecs/api_op_PutAttributes.go index 7b2331094d6..11e2748cd69 100644 --- a/service/ecs/api_op_PutAttributes.go +++ b/service/ecs/api_op_PutAttributes.go @@ -13,9 +13,8 @@ import ( // Create or update an attribute on an Amazon ECS resource. If the attribute // doesn't exist, it's created. If the attribute exists, its value is replaced with -// the specified value. To delete an attribute, use DeleteAttributes. For more -// information, see Attributes -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) +// the specified value. To delete an attribute, use DeleteAttributes . For more +// information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) PutAttributes(ctx context.Context, params *PutAttributesInput, optFns ...func(*Options)) (*PutAttributesOutput, error) { if params == nil { diff --git a/service/ecs/api_op_PutClusterCapacityProviders.go b/service/ecs/api_op_PutClusterCapacityProviders.go index 20fb674fbae..0326be085ca 100644 --- a/service/ecs/api_op_PutClusterCapacityProviders.go +++ b/service/ecs/api_op_PutClusterCapacityProviders.go @@ -23,7 +23,7 @@ import ( // a task on a cluster, if no capacity provider or launch type is specified, then // the cluster's default capacity provider strategy is used. We recommend that you // define a default capacity provider strategy for your cluster. However, you must -// specify an empty array ([]) to bypass defining a default strategy. +// specify an empty array ( [] ) to bypass defining a default strategy. func (c *Client) PutClusterCapacityProviders(ctx context.Context, params *PutClusterCapacityProvidersInput, optFns ...func(*Options)) (*PutClusterCapacityProvidersOutput, error) { if params == nil { params = &PutClusterCapacityProvidersInput{} diff --git a/service/ecs/api_op_RegisterContainerInstance.go b/service/ecs/api_op_RegisterContainerInstance.go index ac59d3b9966..1f29b5dbaa7 100644 --- a/service/ecs/api_op_RegisterContainerInstance.go +++ b/service/ecs/api_op_RegisterContainerInstance.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is only used by the Amazon ECS agent, and it is not intended for use -// outside of the agent. Registers an EC2 instance into the specified cluster. This -// instance becomes available to place containers on. +// This action is only used by the Amazon ECS agent, and it is not intended for +// use outside of the agent. Registers an EC2 instance into the specified cluster. +// This instance becomes available to place containers on. func (c *Client) RegisterContainerInstance(ctx context.Context, params *RegisterContainerInstanceInput, optFns ...func(*Options)) (*RegisterContainerInstanceOutput, error) { if params == nil { params = &RegisterContainerInstanceInput{} @@ -56,34 +56,23 @@ type RegisterContainerInstanceInput struct { // device type is a GPU. PlatformDevices []types.PlatformDevice - // The metadata that you apply to the container instance to help you categorize and - // organize them. Each tag consists of a key and an optional value. You define + // The metadata that you apply to the container instance to help you categorize + // and organize them. Each tag consists of a key and an optional value. You define // both. The following basic restrictions apply to tags: - // - // * Maximum number of tags - // per resource - 50 - // - // * For each resource, each tag key must be unique, and each - // tag key can have only one value. - // - // * Maximum key length - 128 Unicode characters - // in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag // The resources available on the instance. diff --git a/service/ecs/api_op_RegisterTaskDefinition.go b/service/ecs/api_op_RegisterTaskDefinition.go index 164e97ea48c..793ed474081 100644 --- a/service/ecs/api_op_RegisterTaskDefinition.go +++ b/service/ecs/api_op_RegisterTaskDefinition.go @@ -12,27 +12,23 @@ import ( ) // Registers a new task definition from the supplied family and -// containerDefinitions. Optionally, you can add data volumes to your containers +// containerDefinitions . Optionally, you can add data volumes to your containers // with the volumes parameter. For more information about task definition -// parameters and defaults, see Amazon ECS Task Definitions -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) +// parameters and defaults, see Amazon ECS Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon Elastic Container Service Developer Guide. You can specify a role // for your task with the taskRoleArn parameter. When you specify a role for a // task, its containers can then use the latest versions of the CLI or SDKs to make // API requests to the Amazon Web Services services that are specified in the // policy that's associated with the role. For more information, see IAM Roles for -// Tasks -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) +// Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. You can specify a // Docker networking mode for the containers in your task definition with the // networkMode parameter. The available network modes correspond to those described -// in Network settings -// (https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker -// run reference. If you specify the awsvpc network mode, the task is allocated an -// elastic network interface, and you must specify a NetworkConfiguration when you -// create a service or run a task with the task definition. For more information, -// see Task Networking -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) +// in Network settings (https://docs.docker.com/engine/reference/run/#/network-settings) +// in the Docker run reference. If you specify the awsvpc network mode, the task +// is allocated an elastic network interface, and you must specify a +// NetworkConfiguration when you create a service or run a task with the task +// definition. For more information, see Task Networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) RegisterTaskDefinition(ctx context.Context, params *RegisterTaskDefinitionInput, optFns ...func(*Options)) (*RegisterTaskDefinitionOutput, error) { if params == nil { @@ -58,68 +54,55 @@ type RegisterTaskDefinitionInput struct { ContainerDefinitions []types.ContainerDefinition // You must specify a family for a task definition. You can use it track multiple - // versions of the same task definition. The family is used as a name for your task - // definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, - // and hyphens are allowed. + // versions of the same task definition. The family is used as a name for your + // task definition. Up to 255 letters (uppercase and lowercase), numbers, + // underscores, and hyphens are allowed. // // This member is required. Family *string // The number of CPU units used by the task. It can be expressed as an integer - // using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 - // vCPU or 1 vcpu) in a task definition. String values are converted to an integer + // using CPU units (for example, 1024 ) or as a string using vCPUs (for example, 1 + // vCPU or 1 vcpu ) in a task definition. String values are converted to an integer // indicating the CPU units when the task definition is registered. Task-level CPU // and memory parameters are ignored for Windows containers. We recommend // specifying container-level resources for Windows containers. If you're using the // EC2 launch type, this field is optional. Supported values are between 128 CPU - // units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a + // units ( 0.125 vCPUs) and 10240 CPU units ( 10 vCPUs). If you do not specify a // value, the parameter is ignored. If you're using the Fargate launch type, this // field is required and you must use one of the following values, which determines - // your range of supported values for the memory parameter: The CPU units cannot be - // less than 1 vCPU when you use Windows containers on Fargate. - // - // * 256 (.25 vCPU) - - // Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - // - // * 512 (.5 vCPU) - // - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - // - // * - // 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), - // 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - // - // * 2048 (2 vCPU) - Available - // memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // - // * - // 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in - // increments of 1024 (1 GB) - // - // * 8192 (8 vCPU) - Available memory values: 16 GB and - // 60 GB in 4 GB increments This option requires Linux platform 1.4.0 or later. - // - // * - // 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments - // This option requires Linux platform 1.4.0 or later. + // your range of supported values for the memory parameter: The CPU units cannot + // be less than 1 vCPU when you use Windows containers on Fargate. + // - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 + // GB) + // - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 + // GB), 4096 (4 GB) + // - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 + // GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + // - 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in + // increments of 1024 (1 GB) + // - 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in + // increments of 1024 (1 GB) + // - 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments + // This option requires Linux platform 1.4.0 or later. + // - 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments + // This option requires Linux platform 1.4.0 or later. Cpu *string - // The amount of ephemeral storage to allocate for the task. This parameter is used - // to expand the total amount of ephemeral storage available, beyond the default - // amount, for tasks hosted on Fargate. For more information, see Fargate task - // storage - // (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) + // The amount of ephemeral storage to allocate for the task. This parameter is + // used to expand the total amount of ephemeral storage available, beyond the + // default amount, for tasks hosted on Fargate. For more information, see Fargate + // task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) // in the Amazon ECS User Guide for Fargate. This parameter is only supported for // tasks hosted on Fargate using the following platform versions: - // - // * Linux platform - // version 1.4.0 or later. + // - Linux platform version 1.4.0 or later. EphemeralStorage *types.EphemeralStorage - // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon - // ECS container agent permission to make Amazon Web Services API calls on your - // behalf. The task execution IAM role is required depending on the requirements of - // your task. For more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // The Amazon Resource Name (ARN) of the task execution role that grants the + // Amazon ECS container agent permission to make Amazon Web Services API calls on + // your behalf. The task execution IAM role is required depending on the + // requirements of your task. For more information, see Amazon ECS task execution + // IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) // in the Amazon Elastic Container Service Developer Guide. ExecutionRoleArn *string @@ -127,79 +110,63 @@ type RegisterTaskDefinitionInput struct { InferenceAccelerators []types.InferenceAccelerator // The IPC resource namespace to use for the containers in the task. The valid - // values are host, task, or none. If host is specified, then all containers within - // the tasks that specified the host IPC mode on the same container instance share - // the same IPC resources with the host Amazon EC2 instance. If task is specified, - // all containers within the specified task share the same IPC resources. If none - // is specified, then IPC resources within the containers of a task are private and - // not shared with other containers in a task or on the container instance. If no - // value is specified, then the IPC resource namespace sharing depends on the - // Docker daemon setting on the container instance. For more information, see IPC - // settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in - // the Docker run reference. If the host IPC mode is used, be aware that there is a - // heightened risk of undesired IPC namespace expose. For more information, see - // Docker security (https://docs.docker.com/engine/security/security/). If you are - // setting namespaced kernel parameters using systemControls for the containers in - // the task, the following will apply to your IPC resource namespace. For more - // information, see System Controls - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) + // values are host , task , or none . If host is specified, then all containers + // within the tasks that specified the host IPC mode on the same container + // instance share the same IPC resources with the host Amazon EC2 instance. If task + // is specified, all containers within the specified task share the same IPC + // resources. If none is specified, then IPC resources within the containers of a + // task are private and not shared with other containers in a task or on the + // container instance. If no value is specified, then the IPC resource namespace + // sharing depends on the Docker daemon setting on the container instance. For more + // information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) + // in the Docker run reference. If the host IPC mode is used, be aware that there + // is a heightened risk of undesired IPC namespace expose. For more information, + // see Docker security (https://docs.docker.com/engine/security/security/) . If you + // are setting namespaced kernel parameters using systemControls for the + // containers in the task, the following will apply to your IPC resource namespace. + // For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that use - // the host IPC mode, IPC namespace related systemControls are not supported. - // - // * - // For tasks that use the task IPC mode, IPC namespace related systemControls will - // apply to all containers within a task. - // - // This parameter is not supported for - // Windows containers or tasks run on Fargate. + // - For tasks that use the host IPC mode, IPC namespace related systemControls + // are not supported. + // - For tasks that use the task IPC mode, IPC namespace related systemControls + // will apply to all containers within a task. + // This parameter is not supported for Windows containers or tasks run on Fargate. IpcMode types.IpcMode // The amount of memory (in MiB) used by the task. It can be expressed as an - // integer using MiB (for example ,1024) or as a string using GB (for example, 1GB - // or 1 GB) in a task definition. String values are converted to an integer + // integer using MiB (for example , 1024 ) or as a string using GB (for example, + // 1GB or 1 GB ) in a task definition. String values are converted to an integer // indicating the MiB when the task definition is registered. Task-level CPU and // memory parameters are ignored for Windows containers. We recommend specifying // container-level resources for Windows containers. If using the EC2 launch type, // this field is optional. If using the Fargate launch type, this field is required // and you must use one of the following values. This determines your range of - // supported values for the cpu parameter. The CPU units cannot be less than 1 vCPU - // when you use Windows containers on Fargate. - // - // * 512 (0.5 GB), 1024 (1 GB), 2048 - // (2 GB) - Available cpu values: 256 (.25 vCPU) - // - // * 1024 (1 GB), 2048 (2 GB), 3072 - // (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) - // - // * 2048 (2 GB), 3072 - // (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - - // Available cpu values: 1024 (1 vCPU) - // - // * Between 4096 (4 GB) and 16384 (16 GB) in - // increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) - // - // * Between 8192 - // (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: - // 4096 (4 vCPU) - // - // * Between 16 GB and 60 GB in 4 GB increments - Available cpu - // values: 8192 (8 vCPU) This option requires Linux platform 1.4.0 or later. - // - // * - // Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 - // vCPU) This option requires Linux platform 1.4.0 or later. + // supported values for the cpu parameter. The CPU units cannot be less than 1 + // vCPU when you use Windows containers on Fargate. + // - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 + // vCPU) + // - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: + // 512 (.5 vCPU) + // - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 + // GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) + // - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - + // Available cpu values: 2048 (2 vCPU) + // - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - + // Available cpu values: 4096 (4 vCPU) + // - Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 + // vCPU) This option requires Linux platform 1.4.0 or later. + // - Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 + // vCPU) This option requires Linux platform 1.4.0 or later. Memory *string // The Docker networking mode to use for the containers in the task. The valid - // values are none, bridge, awsvpc, and host. If no network mode is specified, the - // default is bridge. For Amazon ECS tasks on Fargate, the awsvpc network mode is - // required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode - // can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc - // can be used. If the network mode is set to none, you cannot specify port - // mappings in your container definitions, and the tasks containers do not have - // external connectivity. The host and awsvpc network modes offer the highest + // values are none , bridge , awsvpc , and host . If no network mode is specified, + // the default is bridge . For Amazon ECS tasks on Fargate, the awsvpc network + // mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any + // network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, + // or awsvpc can be used. If the network mode is set to none , you cannot specify + // port mappings in your container definitions, and the tasks containers do not + // have external connectivity. The host and awsvpc network modes offer the highest // networking performance for containers because they use the EC2 network stack // instead of the virtualized network stack provided by the bridge mode. With the // host and awsvpc network modes, exposed container ports are mapped directly to @@ -207,31 +174,29 @@ type RegisterTaskDefinitionInput struct { // network interface port (for the awsvpc network mode), so you cannot take // advantage of dynamic host port mappings. When using the host network mode, you // should not run containers using the root user (UID 0). It is considered best - // practice to use a non-root user. If the network mode is awsvpc, the task is + // practice to use a non-root user. If the network mode is awsvpc , the task is // allocated an elastic network interface, and you must specify a // NetworkConfiguration value when you create a service or run a task with the task - // definition. For more information, see Task Networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // definition. For more information, see Task Networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. If the network mode is - // host, you cannot run multiple instantiations of the same task on a single + // host , you cannot run multiple instantiations of the same task on a single // container instance when port mappings are used. For more information, see - // Network settings - // (https://docs.docker.com/engine/reference/run/#network-settings) in the Docker - // run reference. + // Network settings (https://docs.docker.com/engine/reference/run/#network-settings) + // in the Docker run reference. NetworkMode types.NetworkMode // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks + // are host or task . If host is specified, then all containers within the tasks // that specified the host PID mode on the same container instance share the same // process namespace with the host Amazon EC2 instance. If task is specified, all // containers within the specified task share the same process namespace. If no // value is specified, the default is a private namespace. For more information, - // see PID settings - // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker - // run reference. If the host PID mode is used, be aware that there is a heightened - // risk of undesired process namespace expose. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/). This parameter is - // not supported for Windows containers or tasks run on Fargate. + // see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) + // in the Docker run reference. If the host PID mode is used, be aware that there + // is a heightened risk of undesired process namespace expose. For more + // information, see Docker security (https://docs.docker.com/engine/security/security/) + // . This parameter is not supported for Windows containers or tasks run on + // Fargate. PidMode types.PidMode // An array of placement constraint objects to use for the task. You can specify a @@ -239,14 +204,13 @@ type RegisterTaskDefinitionInput struct { // task definition and those specified at runtime. PlacementConstraints []types.TaskDefinitionPlacementConstraint - // The configuration details for the App Mesh proxy. For tasks hosted on Amazon EC2 - // instances, the container instances require at least version 1.26.0 of the + // The configuration details for the App Mesh proxy. For tasks hosted on Amazon + // EC2 instances, the container instances require at least version 1.26.0 of the // container agent and at least version 1.26.0-1 of the ecs-init package to use a // proxy configuration. If your container instances are launched from the Amazon // ECS-optimized AMI version 20190301 or later, then they contain the required - // versions of the container agent and ecs-init. For more information, see Amazon - // ECS-optimized AMI versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html) + // versions of the container agent and ecs-init . For more information, see Amazon + // ECS-optimized AMI versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html) // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *types.ProxyConfiguration @@ -265,38 +229,26 @@ type RegisterTaskDefinitionInput struct { // The metadata that you apply to the task definition to help you categorize and // organize them. Each tag consists of a key and an optional value. You define both // of them. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * - // If your tagging schema is used across multiple services and resources, remember - // that other services may have restrictions on allowed characters. Generally - // allowed characters are: letters, numbers, and spaces representable in UTF-8, and - // the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag // The short name or full Amazon Resource Name (ARN) of the IAM role that // containers in this task can assume. All containers in this task are granted the - // permissions that are specified in this role. For more information, see IAM Roles - // for Tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // permissions that are specified in this role. For more information, see IAM + // Roles for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string diff --git a/service/ecs/api_op_RunTask.go b/service/ecs/api_op_RunTask.go index 4eee6f1b241..eb3a240d234 100644 --- a/service/ecs/api_op_RunTask.go +++ b/service/ecs/api_op_RunTask.go @@ -14,8 +14,7 @@ import ( // Starts a new task using the specified task definition. You can allow Amazon ECS // to place tasks for you, or you can customize how Amazon ECS places tasks using // placement constraints and placement strategies. For more information, see -// Scheduling Tasks -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) +// Scheduling Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) // in the Amazon Elastic Container Service Developer Guide. Alternatively, you can // use StartTask to use your own scheduler or place tasks manually on specific // container instances. Starting April 15, 2023, Amazon Web Services will not @@ -30,20 +29,17 @@ import ( // means that the result of an API command you run that affects your Amazon ECS // resources might not be immediately visible to all subsequent commands you run. // Keep this in mind when you carry out an API command that immediately follows a -// previous API command. To manage eventual consistency, you can do the -// following: -// -// * Confirm the state of the resource before you run a command to -// modify it. Run the DescribeTasks command using an exponential backoff algorithm -// to ensure that you allow enough time for the previous command to propagate -// through the system. To do this, run the DescribeTasks command repeatedly, -// starting with a couple of seconds of wait time and increasing gradually up to -// five minutes of wait time. -// -// * Add wait time between subsequent commands, even if -// the DescribeTasks command returns an accurate response. Apply an exponential -// backoff algorithm starting with a couple of seconds of wait time, and increase -// gradually up to about five minutes of wait time. +// previous API command. To manage eventual consistency, you can do the following: +// - Confirm the state of the resource before you run a command to modify it. +// Run the DescribeTasks command using an exponential backoff algorithm to ensure +// that you allow enough time for the previous command to propagate through the +// system. To do this, run the DescribeTasks command repeatedly, starting with a +// couple of seconds of wait time and increasing gradually up to five minutes of +// wait time. +// - Add wait time between subsequent commands, even if the DescribeTasks +// command returns an accurate response. Apply an exponential backoff algorithm +// starting with a couple of seconds of wait time, and increase gradually up to +// about five minutes of wait time. func (c *Client) RunTask(ctx context.Context, params *RunTaskInput, optFns ...func(*Options)) (*RunTaskOutput, error) { if params == nil { params = &RunTaskInput{} @@ -61,33 +57,32 @@ func (c *Client) RunTask(ctx context.Context, params *RunTaskInput, optFns ...fu type RunTaskInput struct { - // The family and revision (family:revision) or full ARN of the task definition to - // run. If a revision isn't specified, the latest ACTIVE revision is used. When you - // create a policy for run-task, you can set the resource to be the latest task + // The family and revision ( family:revision ) or full ARN of the task definition + // to run. If a revision isn't specified, the latest ACTIVE revision is used. When + // you create a policy for run-task, you can set the resource to be the latest task // definition revision, or a specific revision. The full ARN value must match the // value that you specified as the Resource of the principal's permissions policy. // When you specify the policy resource as the latest task definition version (by // setting the Resource in the policy to - // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName), then set - // this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName. - // When you specify the policy resource as a specific task definition version (by + // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName ), then set + // this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName + // . When you specify the policy resource as a specific task definition version (by // setting the Resource in the policy to // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or - // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*), then set + // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:* ), then set // this value to - // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1. For more - // information, see Policy Resources for Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources) + // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 . For more + // information, see Policy Resources for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources) // in the Amazon Elastic Container Service developer Guide. // // This member is required. TaskDefinition *string // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be omitted. - // If no capacityProviderStrategy or launchType is specified, the + // capacityProviderStrategy is specified, the launchType parameter must be + // omitted. If no capacityProviderStrategy or launchType is specified, the // defaultCapacityProviderStrategy for the cluster is used. When you use cluster - // auto scaling, you must specify capacityProviderStrategy and not launchType. A + // auto scaling, you must specify capacityProviderStrategy and not launchType . A // capacity provider strategy may contain a maximum of 6 capacity providers. CapacityProviderStrategy []types.CapacityProviderStrategyItem @@ -95,48 +90,44 @@ type RunTaskInput struct { // task on. If you do not specify a cluster, the default cluster is assumed. Cluster *string - // The number of instantiations of the specified task to place on your cluster. You - // can specify up to 10 tasks for each call. + // The number of instantiations of the specified task to place on your cluster. + // You can specify up to 10 tasks for each call. Count *int32 // Specifies whether to use Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool // Determines whether to use the execute command functionality for the containers - // in this task. If true, this enables execute command functionality on all - // containers in the task. If true, then the task definition must have a task role, - // or you must provide one as an override. + // in this task. If true , this enables execute command functionality on all + // containers in the task. If true , then the task definition must have a task + // role, or you must provide one as an override. EnableExecuteCommand bool // The name of the task group to associate with the task. The default value is the - // family name of the task definition (for example, family:my-family-name). + // family name of the task definition (for example, family:my-family-name ). Group *string // The infrastructure to run your standalone task on. For more information, see - // Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) - // in the Amazon Elastic Container Service Developer Guide. The FARGATE launch type - // runs your tasks on Fargate On-Demand infrastructure. Fargate Spot infrastructure - // is available for use but a capacity provider strategy must be used. For more - // information, see Fargate capacity providers - // (https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html) - // in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks on - // Amazon EC2 instances registered to your cluster. The EXTERNAL launch type runs - // your tasks on your on-premises server or virtual machine (VM) capacity + // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // in the Amazon Elastic Container Service Developer Guide. The FARGATE launch + // type runs your tasks on Fargate On-Demand infrastructure. Fargate Spot + // infrastructure is available for use but a capacity provider strategy must be + // used. For more information, see Fargate capacity providers (https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html) + // in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks + // on Amazon EC2 instances registered to your cluster. The EXTERNAL launch type + // runs your tasks on your on-premises server or virtual machine (VM) capacity // registered to your cluster. A task can use either a launch type or a capacity // provider strategy. If a launchType is specified, the capacityProviderStrategy // parameter must be omitted. When you use cluster auto scaling, you must specify - // capacityProviderStrategy and not launchType. + // capacityProviderStrategy and not launchType . LaunchType types.LaunchType // The network configuration for the task. This parameter is required for task // definitions that use the awsvpc network mode to receive their own elastic // network interface, and it isn't supported for other network modes. For more - // information, see Task networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // information, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *types.NetworkConfiguration @@ -150,31 +141,30 @@ type RunTaskInput struct { // limit includes the JSON formatting characters of the override structure. Overrides *types.TaskOverride - // An array of placement constraint objects to use for the task. You can specify up - // to 10 constraints for each task (including constraints in the task definition + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints for each task (including constraints in the task definition // and those specified at runtime). PlacementConstraints []types.PlacementConstraint - // The placement strategy objects to use for the task. You can specify a maximum of - // 5 strategy rules for each task. + // The placement strategy objects to use for the task. You can specify a maximum + // of 5 strategy rules for each task. PlacementStrategy []types.PlacementStrategy // The platform version the task uses. A platform version is only specified for // tasks hosted on Fargate. If one isn't specified, the LATEST platform version is - // used. For more information, see Fargate platform versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // used. For more information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags aren't propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource API action. An error will be received if you specify the SERVICE - // option when running a task. + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags aren't propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use the TagResource API action. An error will be received if you + // specify the SERVICE option when running a task. PropagateTags types.PropagateTags - // The reference ID to use for the task. The reference ID can have a maximum length - // of 1024 characters. + // The reference ID to use for the task. The reference ID can have a maximum + // length of 1024 characters. ReferenceId *string // An optional tag specified when a task is started. For example, if you @@ -190,31 +180,20 @@ type RunTaskInput struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * - // If your tagging schema is used across multiple services and resources, remember - // that other services may have restrictions on allowed characters. Generally - // allowed characters are: letters, numbers, and spaces representable in UTF-8, and - // the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ecs/api_op_StartTask.go b/service/ecs/api_op_StartTask.go index 52319171735..02cb3a6d604 100644 --- a/service/ecs/api_op_StartTask.go +++ b/service/ecs/api_op_StartTask.go @@ -20,8 +20,7 @@ import ( // EC2. However, customers who have used Amazon EI at least once during the past // 30-day period are considered current customers and will be able to continue // using the service. Alternatively, you can use RunTask to place tasks for you. -// For more information, see Scheduling Tasks -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) +// For more information, see Scheduling Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) StartTask(ctx context.Context, params *StartTaskInput, optFns ...func(*Options)) (*StartTaskOutput, error) { if params == nil { @@ -40,14 +39,15 @@ func (c *Client) StartTask(ctx context.Context, params *StartTaskInput, optFns . type StartTaskInput struct { - // The container instance IDs or full ARN entries for the container instances where - // you would like to place your task. You can specify up to 10 container instances. + // The container instance IDs or full ARN entries for the container instances + // where you would like to place your task. You can specify up to 10 container + // instances. // // This member is required. ContainerInstances []string - // The family and revision (family:revision) or full ARN of the task definition to - // start. If a revision isn't specified, the latest ACTIVE revision is used. + // The family and revision ( family:revision ) or full ARN of the task definition + // to start. If a revision isn't specified, the latest ACTIVE revision is used. // // This member is required. TaskDefinition *string @@ -57,21 +57,20 @@ type StartTaskInput struct { Cluster *string // Specifies whether to use Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool // Whether or not the execute command functionality is enabled for the task. If - // true, this enables execute command functionality on all containers in the task. + // true , this enables execute command functionality on all containers in the task. EnableExecuteCommand bool // The name of the task group to associate with the task. The default value is the // family name of the task definition (for example, family:my-family-name). Group *string - // The VPC subnet and security group configuration for tasks that receive their own - // elastic network interface by using the awsvpc networking mode. + // The VPC subnet and security group configuration for tasks that receive their + // own elastic network interface by using the awsvpc networking mode. NetworkConfiguration *types.NetworkConfiguration // A list of container overrides in JSON format that specify the name of a @@ -104,31 +103,20 @@ type StartTaskInput struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you // define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * - // If your tagging schema is used across multiple services and resources, remember - // that other services may have restrictions on allowed characters. Generally - // allowed characters are: letters, numbers, and spaces representable in UTF-8, and - // the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ecs/api_op_StopTask.go b/service/ecs/api_op_StopTask.go index 6e363735f63..64d96d18754 100644 --- a/service/ecs/api_op_StopTask.go +++ b/service/ecs/api_op_StopTask.go @@ -16,11 +16,10 @@ import ( // containers running in the task. This results in a SIGTERM value and a default // 30-second timeout, after which the SIGKILL value is sent and the containers are // forcibly stopped. If the container handles the SIGTERM value gracefully and -// exits within 30 seconds from receiving it, no SIGKILL value is sent. The default -// 30-second timeout can be configured on the Amazon ECS container agent with the -// ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS -// Container Agent Configuration -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) +// exits within 30 seconds from receiving it, no SIGKILL value is sent. The +// default 30-second timeout can be configured on the Amazon ECS container agent +// with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon +// ECS Container Agent Configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) StopTask(ctx context.Context, params *StopTaskInput, optFns ...func(*Options)) (*StopTaskOutput, error) { if params == nil { diff --git a/service/ecs/api_op_SubmitAttachmentStateChanges.go b/service/ecs/api_op_SubmitAttachmentStateChanges.go index 7108d8ad43c..cd7bfa10302 100644 --- a/service/ecs/api_op_SubmitAttachmentStateChanges.go +++ b/service/ecs/api_op_SubmitAttachmentStateChanges.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is only used by the Amazon ECS agent, and it is not intended for use -// outside of the agent. Sent to acknowledge that an attachment changed states. +// This action is only used by the Amazon ECS agent, and it is not intended for +// use outside of the agent. Sent to acknowledge that an attachment changed states. func (c *Client) SubmitAttachmentStateChanges(ctx context.Context, params *SubmitAttachmentStateChangesInput, optFns ...func(*Options)) (*SubmitAttachmentStateChangesOutput, error) { if params == nil { params = &SubmitAttachmentStateChangesInput{} diff --git a/service/ecs/api_op_SubmitContainerStateChange.go b/service/ecs/api_op_SubmitContainerStateChange.go index 94f0e50c51f..b65ad1a1c06 100644 --- a/service/ecs/api_op_SubmitContainerStateChange.go +++ b/service/ecs/api_op_SubmitContainerStateChange.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is only used by the Amazon ECS agent, and it is not intended for use -// outside of the agent. Sent to acknowledge that a container changed states. +// This action is only used by the Amazon ECS agent, and it is not intended for +// use outside of the agent. Sent to acknowledge that a container changed states. func (c *Client) SubmitContainerStateChange(ctx context.Context, params *SubmitContainerStateChangeInput, optFns ...func(*Options)) (*SubmitContainerStateChangeOutput, error) { if params == nil { params = &SubmitContainerStateChangeInput{} diff --git a/service/ecs/api_op_SubmitTaskStateChange.go b/service/ecs/api_op_SubmitTaskStateChange.go index 52279f1a460..92bcc0c52bf 100644 --- a/service/ecs/api_op_SubmitTaskStateChange.go +++ b/service/ecs/api_op_SubmitTaskStateChange.go @@ -12,8 +12,8 @@ import ( "time" ) -// This action is only used by the Amazon ECS agent, and it is not intended for use -// outside of the agent. Sent to acknowledge that a task changed states. +// This action is only used by the Amazon ECS agent, and it is not intended for +// use outside of the agent. Sent to acknowledge that a task changed states. func (c *Client) SubmitTaskStateChange(ctx context.Context, params *SubmitTaskStateChangeInput, optFns ...func(*Options)) (*SubmitTaskStateChangeOutput, error) { if params == nil { params = &SubmitTaskStateChangeInput{} diff --git a/service/ecs/api_op_TagResource.go b/service/ecs/api_op_TagResource.go index f639f04c447..6ba486314ab 100644 --- a/service/ecs/api_op_TagResource.go +++ b/service/ecs/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource aren't specified in the request parameters, they // aren't changed. When a resource is deleted, the tags that are associated with // that resource are deleted as well. @@ -41,31 +41,20 @@ type TagResourceInput struct { // The tags to add to the resource. A tag is an array of key-value pairs. The // following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50 - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. // // This member is required. Tags []types.Tag diff --git a/service/ecs/api_op_UpdateCluster.go b/service/ecs/api_op_UpdateCluster.go index fff1a726d26..60c99ccaf83 100644 --- a/service/ecs/api_op_UpdateCluster.go +++ b/service/ecs/api_op_UpdateCluster.go @@ -41,15 +41,14 @@ type UpdateClusterInput struct { // default Service Connect namespace, any new services with Service Connect turned // on that are created in the cluster are added as client services in the // namespace. This setting only applies to new services that set the enabled - // parameter to true in the ServiceConnectConfiguration. You can set the namespace - // of each service individually in the ServiceConnectConfiguration to override this - // default parameter. Tasks that run in a namespace can use short names to connect - // to services in the namespace. Tasks can connect to services across all of the - // clusters in the namespace. Tasks connect through a managed proxy container that - // collects logs and metrics for increased visibility. Only the tasks that Amazon - // ECS services create are supported with Service Connect. For more information, - // see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // parameter to true in the ServiceConnectConfiguration . You can set the namespace + // of each service individually in the ServiceConnectConfiguration to override + // this default parameter. Tasks that run in a namespace can use short names to + // connect to services in the namespace. Tasks can connect to services across all + // of the clusters in the namespace. Tasks connect through a managed proxy + // container that collects logs and metrics for increased visibility. Only the + // tasks that Amazon ECS services create are supported with Service Connect. For + // more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectDefaults *types.ClusterServiceConnectDefaultsRequest diff --git a/service/ecs/api_op_UpdateClusterSettings.go b/service/ecs/api_op_UpdateClusterSettings.go index 0b798c8a2c9..14b27b9622e 100644 --- a/service/ecs/api_op_UpdateClusterSettings.go +++ b/service/ecs/api_op_UpdateClusterSettings.go @@ -37,12 +37,12 @@ type UpdateClusterSettingsInput struct { // The setting to use by default for a cluster. This parameter is used to turn on // CloudWatch Container Insights for a cluster. If this value is specified, it // overrides the containerInsights value set with PutAccountSetting or - // PutAccountSettingDefault. Currently, if you delete an existing cluster that does - // not have Container Insights turned on, and then create a new cluster with the - // same name with Container Insights tuned on, Container Insights will not actually - // be turned on. If you want to preserve the same name for your existing cluster - // and turn on Container Insights, you must wait 7 days before you can re-create - // it. + // PutAccountSettingDefault . Currently, if you delete an existing cluster that + // does not have Container Insights turned on, and then create a new cluster with + // the same name with Container Insights tuned on, Container Insights will not + // actually be turned on. If you want to preserve the same name for your existing + // cluster and turn on Container Insights, you must wait 7 days before you can + // re-create it. // // This member is required. Settings []types.ClusterSetting diff --git a/service/ecs/api_op_UpdateContainerAgent.go b/service/ecs/api_op_UpdateContainerAgent.go index ff885f06494..6a98fe547ee 100644 --- a/service/ecs/api_op_UpdateContainerAgent.go +++ b/service/ecs/api_op_UpdateContainerAgent.go @@ -19,16 +19,14 @@ import ( // isn't supported for container instances using the Amazon ECS-optimized Amazon // Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init // package. This updates the agent. For more information, see Updating the Amazon -// ECS container agent -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html) +// ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html) // in the Amazon Elastic Container Service Developer Guide. Agent updates with the // UpdateContainerAgent API operation do not apply to Windows container instances. // We recommend that you launch new container instances to update the agent version // in your Windows clusters. The UpdateContainerAgent API requires an Amazon // ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and // running. For help updating the Amazon ECS container agent on other operating -// systems, see Manually updating the Amazon ECS container agent -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent) +// systems, see Manually updating the Amazon ECS container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) UpdateContainerAgent(ctx context.Context, params *UpdateContainerAgentInput, optFns ...func(*Options)) (*UpdateContainerAgentOutput, error) { if params == nil { diff --git a/service/ecs/api_op_UpdateContainerInstancesState.go b/service/ecs/api_op_UpdateContainerInstancesState.go index 2b5aa455a45..031d66424f8 100644 --- a/service/ecs/api_op_UpdateContainerInstancesState.go +++ b/service/ecs/api_op_UpdateContainerInstancesState.go @@ -17,39 +17,36 @@ import ( // to perform system updates, update the Docker daemon, or scale down the cluster // size. A container instance can't be changed to DRAINING until it has reached an // ACTIVE status. If the instance is in any other status, an error will be -// received. When you set a container instance to DRAINING, Amazon ECS prevents new -// tasks from being scheduled for placement on the container instance and +// received. When you set a container instance to DRAINING , Amazon ECS prevents +// new tasks from being scheduled for placement on the container instance and // replacement service tasks are started on other container instances in the // cluster if the resources are available. Service tasks on the container instance // that are in the PENDING state are stopped immediately. Service tasks on the // container instance that are in the RUNNING state are stopped and replaced // according to the service's deployment configuration parameters, -// minimumHealthyPercent and maximumPercent. You can change the deployment -// configuration of your service using UpdateService. +// minimumHealthyPercent and maximumPercent . You can change the deployment +// configuration of your service using UpdateService . +// - If minimumHealthyPercent is below 100%, the scheduler can ignore +// desiredCount temporarily during task replacement. For example, desiredCount is +// four tasks, a minimum of 50% allows the scheduler to stop two existing tasks +// before starting two new tasks. If the minimum is 100%, the service scheduler +// can't remove existing tasks until the replacement tasks are considered healthy. +// Tasks for services that do not use a load balancer are considered healthy if +// they're in the RUNNING state. Tasks for services that use a load balancer are +// considered healthy if they're in the RUNNING state and are reported as healthy +// by the load balancer. +// - The maximumPercent parameter represents an upper limit on the number of +// running tasks during task replacement. You can use this to define the +// replacement batch size. For example, if desiredCount is four tasks, a maximum +// of 200% starts four new tasks before stopping the four tasks to be drained, +// provided that the cluster resources required to do this are available. If the +// maximum is 100%, then replacement tasks can't start until the draining tasks +// have stopped. // -// * If minimumHealthyPercent -// is below 100%, the scheduler can ignore desiredCount temporarily during task -// replacement. For example, desiredCount is four tasks, a minimum of 50% allows -// the scheduler to stop two existing tasks before starting two new tasks. If the -// minimum is 100%, the service scheduler can't remove existing tasks until the -// replacement tasks are considered healthy. Tasks for services that do not use a -// load balancer are considered healthy if they're in the RUNNING state. Tasks for -// services that use a load balancer are considered healthy if they're in the -// RUNNING state and are reported as healthy by the load balancer. -// -// * The -// maximumPercent parameter represents an upper limit on the number of running -// tasks during task replacement. You can use this to define the replacement batch -// size. For example, if desiredCount is four tasks, a maximum of 200% starts four -// new tasks before stopping the four tasks to be drained, provided that the -// cluster resources required to do this are available. If the maximum is 100%, -// then replacement tasks can't start until the draining tasks have stopped. -// -// Any -// PENDING or RUNNING tasks that do not belong to a service aren't affected. You -// must wait for them to finish or stop them manually. A container instance has +// Any PENDING or RUNNING tasks that do not belong to a service aren't affected. +// You must wait for them to finish or stop them manually. A container instance has // completed draining when it has no more RUNNING tasks. You can verify this using -// ListTasks. When a container instance has been drained, you can set a container +// ListTasks . When a container instance has been drained, you can set a container // instance to ACTIVE status and once it has reached that status the Amazon ECS // scheduler can begin scheduling tasks on the instance again. func (c *Client) UpdateContainerInstancesState(ctx context.Context, params *UpdateContainerInstancesStateInput, optFns ...func(*Options)) (*UpdateContainerInstancesStateOutput, error) { @@ -75,9 +72,9 @@ type UpdateContainerInstancesStateInput struct { ContainerInstances []string // The container instance state to update the container instance with. The only - // valid values for this action are ACTIVE and DRAINING. A container instance can + // valid values for this action are ACTIVE and DRAINING . A container instance can // only be updated to DRAINING status once it has reached an ACTIVE state. If a - // container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED + // container instance is in REGISTERING , DEREGISTERING , or REGISTRATION_FAILED // state you can describe the container instance but can't update the container // instance state. // diff --git a/service/ecs/api_op_UpdateService.go b/service/ecs/api_op_UpdateService.go index 2088823f318..26d4c0617f6 100644 --- a/service/ecs/api_op_UpdateService.go +++ b/service/ecs/api_op_UpdateService.go @@ -11,112 +11,91 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a service. For services using the rolling update -// (ECS) you can update the desired count, deployment configuration, network +// Modifies the parameters of a service. For services using the rolling update ( ECS +// ) you can update the desired count, deployment configuration, network // configuration, load balancers, service registries, enable ECS managed tags // option, propagate tags option, task placement constraints and strategies, and // task definition. When you update any of these parameters, Amazon ECS starts new -// tasks with the new configuration. For services using the blue/green -// (CODE_DEPLOY) deployment controller, only the desired count, deployment -// configuration, health check grace period, task placement constraints and -// strategies, enable ECS managed tags option, and propagate tags can be updated -// using this API. If the network configuration, platform version, task definition, -// or load balancer need to be updated, create a new CodeDeploy deployment. For -// more information, see CreateDeployment -// (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) +// tasks with the new configuration. For services using the blue/green ( CODE_DEPLOY +// ) deployment controller, only the desired count, deployment configuration, +// health check grace period, task placement constraints and strategies, enable ECS +// managed tags option, and propagate tags can be updated using this API. If the +// network configuration, platform version, task definition, or load balancer need +// to be updated, create a new CodeDeploy deployment. For more information, see +// CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) // in the CodeDeploy API Reference. For services using an external deployment // controller, you can update only the desired count, task placement constraints // and strategies, health check grace period, enable ECS managed tags option, and // propagate tags option, using this API. If the launch type, load balancer, // network configuration, platform version, or task definition need to be updated, -// create a new task set For more information, see CreateTaskSet. You can add to or -// subtract from the number of instantiations of a task definition in a service by -// specifying the cluster that the service is running in and a new desiredCount +// create a new task set For more information, see CreateTaskSet . You can add to +// or subtract from the number of instantiations of a task definition in a service +// by specifying the cluster that the service is running in and a new desiredCount // parameter. If you have updated the Docker image of your application, you can // create a new task definition with that image and deploy it to your service. The // service scheduler uses the minimum healthy percent and maximum percent // parameters (in the service's deployment configuration) to determine the // deployment strategy. If your updated Docker image uses the same tag as what is -// in the existing task definition for your service (for example, my_image:latest), -// you don't need to create a new revision of your task definition. You can update -// the service using the forceNewDeployment option. The new tasks launched by the -// deployment pull the current image/tag combination from your repository when they -// start. You can also update the deployment configuration of a service. When a -// deployment is triggered by updating the task definition of a service, the +// in the existing task definition for your service (for example, my_image:latest +// ), you don't need to create a new revision of your task definition. You can +// update the service using the forceNewDeployment option. The new tasks launched +// by the deployment pull the current image/tag combination from your repository +// when they start. You can also update the deployment configuration of a service. +// When a deployment is triggered by updating the task definition of a service, the // service scheduler uses the deployment configuration parameters, -// minimumHealthyPercent and maximumPercent, to determine the deployment -// strategy. +// minimumHealthyPercent and maximumPercent , to determine the deployment strategy. +// - If minimumHealthyPercent is below 100%, the scheduler can ignore +// desiredCount temporarily during a deployment. For example, if desiredCount is +// four tasks, a minimum of 50% allows the scheduler to stop two existing tasks +// before starting two new tasks. Tasks for services that don't use a load balancer +// are considered healthy if they're in the RUNNING state. Tasks for services +// that use a load balancer are considered healthy if they're in the RUNNING +// state and are reported as healthy by the load balancer. +// - The maximumPercent parameter represents an upper limit on the number of +// running tasks during a deployment. You can use it to define the deployment batch +// size. For example, if desiredCount is four tasks, a maximum of 200% starts +// four new tasks before stopping the four older tasks (provided that the cluster +// resources required to do this are available). // -// * If minimumHealthyPercent is below 100%, the scheduler can ignore -// desiredCount temporarily during a deployment. For example, if desiredCount is -// four tasks, a minimum of 50% allows the scheduler to stop two existing tasks -// before starting two new tasks. Tasks for services that don't use a load balancer -// are considered healthy if they're in the RUNNING state. Tasks for services that -// use a load balancer are considered healthy if they're in the RUNNING state and -// are reported as healthy by the load balancer. +// When UpdateService stops a task during a deployment, the equivalent of docker +// stop is issued to the containers running in the task. This results in a SIGTERM +// and a 30-second timeout. After this, SIGKILL is sent and the containers are +// forcibly stopped. If the container handles the SIGTERM gracefully and exits +// within 30 seconds from receiving it, no SIGKILL is sent. When the service +// scheduler launches new tasks, it determines task placement in your cluster with +// the following logic. +// - Determine which of the container instances in your cluster can support your +// service's task definition. For example, they have the required CPU, memory, +// ports, and container instance attributes. +// - By default, the service scheduler attempts to balance tasks across +// Availability Zones in this manner even though you can choose a different +// placement strategy. +// - Sort the valid container instances by the fewest number of running tasks +// for this service in the same Availability Zone as the instance. For example, if +// zone A has one running service task and zones B and C each have zero, valid +// container instances in either zone B or C are considered optimal for placement. +// - Place the new service task on a valid container instance in an optimal +// Availability Zone (based on the previous steps), favoring container instances +// with the fewest number of running tasks for this service. // -// * The maximumPercent parameter -// represents an upper limit on the number of running tasks during a deployment. -// You can use it to define the deployment batch size. For example, if desiredCount -// is four tasks, a maximum of 200% starts four new tasks before stopping the four -// older tasks (provided that the cluster resources required to do this are -// available). +// When the service scheduler stops running tasks, it attempts to maintain balance +// across the Availability Zones in your cluster using the following logic: +// - Sort the container instances by the largest number of running tasks for +// this service in the same Availability Zone as the instance. For example, if zone +// A has one running service task and zones B and C each have two, container +// instances in either zone B or C are considered optimal for termination. +// - Stop the task on a container instance in an optimal Availability Zone +// (based on the previous steps), favoring container instances with the largest +// number of running tasks for this service. // -// When UpdateService stops a task during a deployment, the equivalent -// of docker stop is issued to the containers running in the task. This results in -// a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the -// containers are forcibly stopped. If the container handles the SIGTERM gracefully -// and exits within 30 seconds from receiving it, no SIGKILL is sent. When the -// service scheduler launches new tasks, it determines task placement in your -// cluster with the following logic. -// -// * Determine which of the container instances -// in your cluster can support your service's task definition. For example, they -// have the required CPU, memory, ports, and container instance attributes. -// -// * By -// default, the service scheduler attempts to balance tasks across Availability -// Zones in this manner even though you can choose a different placement -// strategy. -// -// * Sort the valid container instances by the fewest number of running -// tasks for this service in the same Availability Zone as the instance. For -// example, if zone A has one running service task and zones B and C each have -// zero, valid container instances in either zone B or C are considered optimal for -// placement. -// -// * Place the new service task on a valid container instance in an -// optimal Availability Zone (based on the previous steps), favoring container -// instances with the fewest number of running tasks for this service. -// -// When the -// service scheduler stops running tasks, it attempts to maintain balance across -// the Availability Zones in your cluster using the following logic: -// -// * Sort the -// container instances by the largest number of running tasks for this service in -// the same Availability Zone as the instance. For example, if zone A has one -// running service task and zones B and C each have two, container instances in -// either zone B or C are considered optimal for termination. -// -// * Stop the task on a -// container instance in an optimal Availability Zone (based on the previous -// steps), favoring container instances with the largest number of running tasks -// for this service. -// -// You must have a service-linked role when you update any of -// the following service properties. If you specified a custom role when you -// created the service, Amazon ECS automatically replaces the roleARN -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn) +// You must have a service-linked role when you update any of the following +// service properties. If you specified a custom role when you created the service, +// Amazon ECS automatically replaces the roleARN (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn) // associated with the service with the ARN of your service-linked role. For more -// information, see Service-linked roles -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// information, see Service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. -// -// * loadBalancers, -// -// * -// serviceRegistries +// - loadBalancers, +// - serviceRegistries func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { if params == nil { params = &UpdateServiceInput{} @@ -139,8 +118,8 @@ type UpdateServiceInput struct { // This member is required. Service *string - // The capacity provider strategy to update the service to use. if the service uses - // the default capacity provider strategy for the cluster, the service can be + // The capacity provider strategy to update the service to use. if the service + // uses the default capacity provider strategy for the cluster, the service can be // updated to use one or more capacity providers as opposed to the default capacity // provider strategy. However, when a service is using a capacity provider strategy // that's not the default capacity provider strategy, the service can't be updated @@ -155,8 +134,8 @@ type UpdateServiceInput struct { // CreateCapacityProvider API operation. To use a Fargate capacity provider, // specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate // capacity providers are available to all accounts and only need to be associated - // with a cluster to be used. The PutClusterCapacityProviders API operation is used - // to update the list of available capacity providers for a cluster after the + // with a cluster to be used. The PutClusterCapacityProviders API operation is + // used to update the list of available capacity providers for a cluster after the // cluster is created. CapacityProviderStrategy []types.CapacityProviderStrategyItem @@ -174,15 +153,14 @@ type UpdateServiceInput struct { DesiredCount *int32 // Determines whether to turn on Amazon ECS managed tags for the tasks in the - // service. For more information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // service. For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. Only tasks launched // after the update will reflect the update. To update the tags on all tasks, set - // forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated - // tags. + // forceNewDeployment to true , so that Amazon ECS starts new tasks with the + // updated tags. EnableECSManagedTags *bool - // If true, this enables execute command functionality on all task containers. If + // If true , this enables execute command functionality on all task containers. If // you do not want to override the value that was set when the service was created, // you can set this to null when performing this action. EnableExecuteCommand *bool @@ -190,8 +168,8 @@ type UpdateServiceInput struct { // Determines whether to force a new deployment of the service. By default, // deployments aren't forced. You can use this option to start a new deployment // with no service definition changes. For example, you can update a service's - // tasks to use a newer Docker image with the same image/tag combination - // (my_image:latest) or to roll Fargate tasks onto a newer platform version. + // tasks to use a newer Docker image with the same image/tag combination ( + // my_image:latest ) or to roll Fargate tasks onto a newer platform version. ForceNewDeployment bool // The period of time, in seconds, that the Amazon ECS service scheduler ignores @@ -215,19 +193,15 @@ type UpdateServiceInput struct { // You can update from a single target group to multiple target groups and from // multiple target groups to a single target group. For services that use // blue/green deployments, you can update Elastic Load Balancing target groups by - // using CreateDeployment - // (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) + // using CreateDeployment (https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) // through CodeDeploy. Note that multiple target groups are not supported for - // blue/green deployments. For more information see Register multiple target groups - // with a service - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) + // blue/green deployments. For more information see Register multiple target + // groups with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) // in the Amazon Elastic Container Service Developer Guide. For services that use // the external deployment controller, you can add, update, or remove load - // balancers by using CreateTaskSet - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html). - // Note that multiple target groups are not supported for external deployments. For - // more information see Register multiple target groups with a service - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) + // balancers by using CreateTaskSet (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html) + // . Note that multiple target groups are not supported for external deployments. + // For more information see Register multiple target groups with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) // in the Amazon Elastic Container Service Developer Guide. You can remove existing // loadBalancers by passing an empty list. LoadBalancers []types.LoadBalancer @@ -244,8 +218,8 @@ type UpdateServiceInput struct { // specified at runtime. PlacementConstraints []types.PlacementConstraint - // The task placement strategy objects to update the service to use. If no value is - // specified, the existing placement strategy for the service will remain + // The task placement strategy objects to update the service to use. If no value + // is specified, the existing placement strategy for the service will remain // unchanged. If this value is specified, it will override the existing placement // strategy defined for the service. To remove an existing placement strategy, // specify an empty object. You can specify a maximum of five strategy rules for @@ -254,17 +228,16 @@ type UpdateServiceInput struct { // The platform version that your tasks in the service run on. A platform version // is only specified for tasks using the Fargate launch type. If a platform version - // is not specified, the LATEST platform version is used. For more information, see - // Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // is not specified, the LATEST platform version is used. For more information, + // see Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Determines whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags aren't propagated. Only tasks - // launched after the update will reflect the update. To update the tags on all - // tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with - // the updated tags. + // Determines whether to propagate the tags from the task definition or the + // service to the task. If no value is specified, the tags aren't propagated. Only + // tasks launched after the update will reflect the update. To update the tags on + // all tasks, set forceNewDeployment to true , so that Amazon ECS starts new tasks + // with the updated tags. PropagateTags types.PropagateTags // The configuration for this service to discover and connect to services, and be @@ -273,25 +246,23 @@ type UpdateServiceInput struct { // Tasks can connect to services across all of the clusters in the namespace. Tasks // connect through a managed proxy container that collects logs and metrics for // increased visibility. Only the tasks that Amazon ECS services create are - // supported with Service Connect. For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // supported with Service Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectConfiguration *types.ServiceConnectConfiguration // The details for the service discovery registries to assign to this service. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). - // When you add, update, or remove the service registries configuration, Amazon ECS - // starts new tasks with the updated service registries configuration, and then + // more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) + // . When you add, update, or remove the service registries configuration, Amazon + // ECS starts new tasks with the updated service registries configuration, and then // stops the old tasks when the new tasks are running. You can remove existing // serviceRegistries by passing an empty list. ServiceRegistries []types.ServiceRegistry - // The family and revision (family:revision) or full ARN of the task definition to - // run in your service. If a revision is not specified, the latest ACTIVE revision - // is used. If you modify the task definition with UpdateService, Amazon ECS spawns - // a task with the new version of the task definition and then stops an old task - // after the new version is running. + // The family and revision ( family:revision ) or full ARN of the task definition + // to run in your service. If a revision is not specified, the latest ACTIVE + // revision is used. If you modify the task definition with UpdateService , Amazon + // ECS spawns a task with the new version of the task definition and then stops an + // old task after the new version is running. TaskDefinition *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go index 06d3cb99b96..f6c6c2e9512 100644 --- a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go +++ b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go @@ -14,8 +14,7 @@ import ( // Modifies which task set in a service is the primary task set. Any parameters // that are updated on the primary task set in a service will transition to the // service. This is used when a service uses the EXTERNAL deployment controller -// type. For more information, see Amazon ECS Deployment Types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// type. For more information, see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) UpdateServicePrimaryTaskSet(ctx context.Context, params *UpdateServicePrimaryTaskSetInput, optFns ...func(*Options)) (*UpdateServicePrimaryTaskSetOutput, error) { if params == nil { diff --git a/service/ecs/api_op_UpdateTaskProtection.go b/service/ecs/api_op_UpdateTaskProtection.go index 5a1fc50d707..16b737fb128 100644 --- a/service/ecs/api_op_UpdateTaskProtection.go +++ b/service/ecs/api_op_UpdateTaskProtection.go @@ -13,28 +13,24 @@ import ( // Updates the protection status of a task. You can set protectionEnabled to true // to protect your task from termination during scale-in events from Service -// Autoscaling -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) -// or deployments -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). -// Task-protection, by default, expires after 2 hours at which point Amazon ECS +// Autoscaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) +// or deployments (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// . Task-protection, by default, expires after 2 hours at which point Amazon ECS // unsets the protectionEnabled property making the task eligible for termination // by a subsequent scale-in event. You can specify a custom expiration period for // task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the // custom expiration period, set the expiresInMinutes property. The // expiresInMinutes property is always reset when you invoke this operation for a -// task that already has protectionEnabled set to true. You can keep extending the +// task that already has protectionEnabled set to true . You can keep extending the // protection expiration period of a task by invoking this operation repeatedly. To -// learn more about Amazon ECS task protection, see Task scale-in protection -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html) +// learn more about Amazon ECS task protection, see Task scale-in protection (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html) // in the Amazon Elastic Container Service Developer Guide . This operation is only // supported for tasks belonging to an Amazon ECS service. Invoking this operation // for a standalone task will result in an TASK_NOT_VALID failure. For more -// information, see API failure reasons -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html). -// If you prefer to set task protection from within the container, we recommend -// using the Task scale-in protection endpoint -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html). +// information, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) +// . If you prefer to set task protection from within the container, we recommend +// using the Task scale-in protection endpoint (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html) +// . func (c *Client) UpdateTaskProtection(ctx context.Context, params *UpdateTaskProtectionInput, optFns ...func(*Options)) (*UpdateTaskProtectionOutput, error) { if params == nil { params = &UpdateTaskProtectionInput{} @@ -58,8 +54,8 @@ type UpdateTaskProtectionInput struct { // This member is required. Cluster *string - // Specify true to mark a task for protection and false to unset protection, making - // it eligible for termination. + // Specify true to mark a task for protection and false to unset protection, + // making it eligible for termination. // // This member is required. ProtectionEnabled bool @@ -69,12 +65,12 @@ type UpdateTaskProtectionInput struct { // This member is required. Tasks []string - // If you set protectionEnabled to true, you can specify the duration for task + // If you set protectionEnabled to true , you can specify the duration for task // protection in minutes. You can specify a value from 1 minute to up to 2,880 // minutes (48 hours). During this time, your task will not be terminated by // scale-in events from Service Auto Scaling or deployments. After this time period - // lapses, protectionEnabled will be reset to false. If you don’t specify the time, - // then the task is automatically protected for 120 minutes (2 hours). + // lapses, protectionEnabled will be reset to false . If you don’t specify the + // time, then the task is automatically protected for 120 minutes (2 hours). ExpiresInMinutes *int32 noSmithyDocumentSerde @@ -86,15 +82,10 @@ type UpdateTaskProtectionOutput struct { Failures []types.Failure // A list of tasks with the following information. - // - // * taskArn: The task ARN. - // - // * - // protectionEnabled: The protection status of the task. If scale-in protection is - // enabled for a task, the value is true. Otherwise, it is false. - // - // * - // expirationDate: The epoch time when protection for the task will expire. + // - taskArn : The task ARN. + // - protectionEnabled : The protection status of the task. If scale-in + // protection is enabled for a task, the value is true . Otherwise, it is false . + // - expirationDate : The epoch time when protection for the task will expire. ProtectedTasks []types.ProtectedTask // Metadata pertaining to the operation's result. diff --git a/service/ecs/api_op_UpdateTaskSet.go b/service/ecs/api_op_UpdateTaskSet.go index 54112961e8c..e716fec6320 100644 --- a/service/ecs/api_op_UpdateTaskSet.go +++ b/service/ecs/api_op_UpdateTaskSet.go @@ -12,8 +12,7 @@ import ( ) // Modifies a task set. This is used when a service uses the EXTERNAL deployment -// controller type. For more information, see Amazon ECS Deployment Types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// controller type. For more information, see Amazon ECS Deployment Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. func (c *Client) UpdateTaskSet(ctx context.Context, params *UpdateTaskSetInput, optFns ...func(*Options)) (*UpdateTaskSetOutput, error) { if params == nil { diff --git a/service/ecs/types/enums.go b/service/ecs/types/enums.go index 3acf984d7a5..759732a4936 100644 --- a/service/ecs/types/enums.go +++ b/service/ecs/types/enums.go @@ -73,8 +73,8 @@ const ( CapacityProviderFieldTags CapacityProviderField = "TAGS" ) -// Values returns all known values for CapacityProviderField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CapacityProviderField. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CapacityProviderField) Values() []CapacityProviderField { return []CapacityProviderField{ @@ -112,9 +112,10 @@ const ( CapacityProviderUpdateStatusUpdateFailed CapacityProviderUpdateStatus = "UPDATE_FAILED" ) -// Values returns all known values for CapacityProviderUpdateStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CapacityProviderUpdateStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (CapacityProviderUpdateStatus) Values() []CapacityProviderUpdateStatus { return []CapacityProviderUpdateStatus{ "DELETE_IN_PROGRESS", @@ -137,9 +138,9 @@ const ( ClusterFieldTags ClusterField = "TAGS" ) -// Values returns all known values for ClusterField. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterField. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClusterField) Values() []ClusterField { return []ClusterField{ "ATTACHMENTS", @@ -194,9 +195,9 @@ const ( ConnectivityDisconnected Connectivity = "DISCONNECTED" ) -// Values returns all known values for Connectivity. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Connectivity. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Connectivity) Values() []Connectivity { return []Connectivity{ "CONNECTED", @@ -295,9 +296,9 @@ const ( DeploymentControllerTypeExternal DeploymentControllerType = "EXTERNAL" ) -// Values returns all known values for DeploymentControllerType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeploymentControllerType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentControllerType) Values() []DeploymentControllerType { return []DeploymentControllerType{ "ECS", @@ -427,8 +428,8 @@ const ( ExecuteCommandLoggingOverride ExecuteCommandLogging = "OVERRIDE" ) -// Values returns all known values for ExecuteCommandLogging. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ExecuteCommandLogging. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ExecuteCommandLogging) Values() []ExecuteCommandLogging { return []ExecuteCommandLogging{ @@ -465,9 +466,9 @@ const ( HealthStatusUnknown HealthStatus = "UNKNOWN" ) -// Values returns all known values for HealthStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HealthStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HealthStatus) Values() []HealthStatus { return []HealthStatus{ "HEALTHY", @@ -486,9 +487,9 @@ const ( InstanceHealthCheckStateInitializing InstanceHealthCheckState = "INITIALIZING" ) -// Values returns all known values for InstanceHealthCheckState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceHealthCheckState. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceHealthCheckState) Values() []InstanceHealthCheckState { return []InstanceHealthCheckState{ "OK", @@ -568,9 +569,9 @@ const ( LogDriverAwsfirelens LogDriver = "awsfirelens" ) -// Values returns all known values for LogDriver. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LogDriver. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LogDriver) Values() []LogDriver { return []LogDriver{ "json-file", @@ -626,9 +627,10 @@ const ( ManagedTerminationProtectionDisabled ManagedTerminationProtection = "DISABLED" ) -// Values returns all known values for ManagedTerminationProtection. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ManagedTerminationProtection. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ManagedTerminationProtection) Values() []ManagedTerminationProtection { return []ManagedTerminationProtection{ "ENABLED", @@ -733,8 +735,8 @@ const ( PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" ) -// Values returns all known values for PlacementStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PlacementStrategyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategyType) Values() []PlacementStrategyType { return []PlacementStrategyType{ @@ -804,9 +806,9 @@ const ( ResourceTypeInferenceAccelerator ResourceType = "InferenceAccelerator" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "GPU", @@ -821,9 +823,9 @@ const ( ScaleUnitPercent ScaleUnit = "PERCENT" ) -// Values returns all known values for ScaleUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ScaleUnit. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ScaleUnit) Values() []ScaleUnit { return []ScaleUnit{ "PERCENT", @@ -856,8 +858,8 @@ const ( ScopeShared Scope = "shared" ) -// Values returns all known values for Scope. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Scope. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Scope) Values() []Scope { return []Scope{ @@ -873,9 +875,9 @@ const ( ServiceFieldTags ServiceField = "TAGS" ) -// Values returns all known values for ServiceField. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServiceField. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServiceField) Values() []ServiceField { return []ServiceField{ "TAGS", @@ -914,9 +916,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", @@ -1038,9 +1040,9 @@ const ( TaskFieldTags TaskField = "TAGS" ) -// Values returns all known values for TaskField. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TaskField. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TaskField) Values() []TaskField { return []TaskField{ "TAGS", @@ -1054,9 +1056,9 @@ const ( TaskSetFieldTags TaskSetField = "TAGS" ) -// Values returns all known values for TaskSetField. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TaskSetField. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TaskSetField) Values() []TaskSetField { return []TaskSetField{ "TAGS", @@ -1075,9 +1077,9 @@ const ( TaskStopCodeTerminationNotice TaskStopCode = "TerminationNotice" ) -// Values returns all known values for TaskStopCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TaskStopCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TaskStopCode) Values() []TaskStopCode { return []TaskStopCode{ "TaskFailedToStart", diff --git a/service/ecs/types/errors.go b/service/ecs/types/errors.go index 0eacc593200..5fb6bc05662 100644 --- a/service/ecs/types/errors.go +++ b/service/ecs/types/errors.go @@ -34,8 +34,8 @@ func (e *AccessDeniedException) ErrorCode() string { func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You can apply up to 10 custom attributes for each resource. You can view the -// attributes of a resource with ListAttributes. You can remove existing attributes -// on a resource with DeleteAttributes. +// attributes of a resource with ListAttributes . You can remove existing +// attributes on a resource with DeleteAttributes . type AttributeLimitExceededException struct { Message *string @@ -62,7 +62,7 @@ func (e *AttributeLimitExceededException) ErrorCode() string { func (e *AttributeLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Your Amazon Web Services account was blocked. For more information, contact -// Amazon Web Services Support (http://aws.amazon.com/contact-us/). +// Amazon Web Services Support (http://aws.amazon.com/contact-us/) . type BlockedException struct { Message *string @@ -119,7 +119,7 @@ func (e *ClientException) ErrorFault() smithy.ErrorFault { return smithy.FaultCl // You can't delete a cluster that has registered container instances. First, // deregister the container instances before you can delete the cluster. For more -// information, see DeregisterContainerInstance. +// information, see DeregisterContainerInstance . type ClusterContainsContainerInstancesException struct { Message *string @@ -149,7 +149,7 @@ func (e *ClusterContainsContainerInstancesException) ErrorFault() smithy.ErrorFa // You can't delete a cluster that contains services. First, update the service to // reduce its desired task count to 0, and then delete the service. For more -// information, see UpdateService and DeleteService. +// information, see UpdateService and DeleteService . type ClusterContainsServicesException struct { Message *string @@ -202,7 +202,7 @@ func (e *ClusterContainsTasksException) ErrorCode() string { func (e *ClusterContainsTasksException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified cluster wasn't found. You can view your available clusters with -// ListClusters. Amazon ECS clusters are Region specific. +// ListClusters . Amazon ECS clusters are Region specific. type ClusterNotFoundException struct { Message *string @@ -228,8 +228,8 @@ func (e *ClusterNotFoundException) ErrorCode() string { } func (e *ClusterNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified parameter isn't valid. Review the available parameters for the API -// request. +// The specified parameter isn't valid. Review the available parameters for the +// API request. type InvalidParameterException struct { Message *string @@ -281,10 +281,11 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon ECS can't determine the current version of the Amazon ECS container agent -// on the container instance and doesn't have enough information to proceed with an -// update. This could be because the agent running on the container instance is a -// previous or custom version that doesn't use our version information. +// Amazon ECS can't determine the current version of the Amazon ECS container +// agent on the container instance and doesn't have enough information to proceed +// with an update. This could be because the agent running on the container +// instance is a previous or custom version that doesn't use our version +// information. type MissingVersionException struct { Message *string @@ -499,7 +500,7 @@ func (e *ServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultSe // The specified service isn't active. You can't update a service that's inactive. // If you have previously deleted a service, you can re-create it with -// CreateService. +// CreateService . type ServiceNotActiveException struct { Message *string @@ -526,7 +527,7 @@ func (e *ServiceNotActiveException) ErrorCode() string { func (e *ServiceNotActiveException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified service wasn't found. You can view your available services with -// ListServices. Amazon ECS services are cluster specific and Region specific. +// ListServices . Amazon ECS services are cluster specific and Region specific. type ServiceNotFoundException struct { Message *string @@ -552,22 +553,16 @@ func (e *ServiceNotFoundException) ErrorCode() string { } func (e *ServiceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The execute command cannot run. This error can be caused by any of the following -// configuration issues: +// The execute command cannot run. This error can be caused by any of the +// following configuration issues: +// - Incorrect IAM permissions +// - The SSM agent is not installed or is not running +// - There is an interface Amazon VPC endpoint for Amazon ECS, but there is not +// one for for Systems Manager Session Manager // -// * Incorrect IAM permissions -// -// * The SSM agent is not -// installed or is not running -// -// * There is an interface Amazon VPC endpoint for -// Amazon ECS, but there is not one for for Systems Manager Session Manager -// -// For -// information about how to troubleshoot the issues, see Troubleshooting issues -// with ECS Exec -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) in -// the Amazon Elastic Container Service Developer Guide. +// For information about how to troubleshoot the issues, see Troubleshooting +// issues with ECS Exec (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) +// in the Amazon Elastic Container Service Developer Guide. type TargetNotConnectedException struct { Message *string @@ -594,7 +589,7 @@ func (e *TargetNotConnectedException) ErrorCode() string { func (e *TargetNotConnectedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified target wasn't found. You can view your available container -// instances with ListContainerInstances. Amazon ECS container instances are +// instances with ListContainerInstances . Amazon ECS container instances are // cluster-specific and Region-specific. type TargetNotFoundException struct { Message *string @@ -622,7 +617,7 @@ func (e *TargetNotFoundException) ErrorCode() string { func (e *TargetNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified task set wasn't found. You can view your available task sets with -// DescribeTaskSets. Task sets are specific to each cluster, service and Region. +// DescribeTaskSets . Task sets are specific to each cluster, service and Region. type TaskSetNotFoundException struct { Message *string @@ -676,7 +671,7 @@ func (e *UnsupportedFeatureException) ErrorFault() smithy.ErrorFault { return sm // There's already a current Amazon ECS container agent update in progress on the // container instance that's specified. If the container agent becomes disconnected -// while it's in a transitional stage, such as PENDING or STAGING, the update +// while it's in a transitional stage, such as PENDING or STAGING , the update // process can get stuck in that state. However, when the agent reconnects, it // resumes where it stopped previously. type UpdateInProgressException struct { diff --git a/service/ecs/types/types.go b/service/ecs/types/types.go index f22ac1aa901..860dd4d9e29 100644 --- a/service/ecs/types/types.go +++ b/service/ecs/types/types.go @@ -18,11 +18,11 @@ type Attachment struct { // The unique identifier for the attachment. Id *string - // The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, - // ATTACHED, DETACHING, DETACHED, DELETED, and FAILED. + // The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING + // , ATTACHED , DETACHING , DETACHED , DELETED , and FAILED . Status *string - // The type of the attachment, such as ElasticNetworkInterface. + // The type of the attachment, such as ElasticNetworkInterface . Type *string noSmithyDocumentSerde @@ -46,8 +46,7 @@ type AttachmentStateChange struct { // An attribute is a name-value pair that's associated with an Amazon ECS object. // Use attributes to extend the Amazon ECS data model by adding custom metadata to -// your resources. For more information, see Attributes -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) +// your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. type Attribute struct { @@ -66,10 +65,10 @@ type Attribute struct { // if you use the short form ID for a resource instead of the full ARN. TargetType TargetType - // The value of the attribute. The value must contain between 1 and 128 characters. - // It can contain letters (uppercase and lowercase), numbers, hyphens (-), - // underscores (_), periods (.), at signs (@), forward slashes (/), back slashes - // (\), colons (:), or spaces. The value can't start or end with a space. + // The value of the attribute. The value must contain between 1 and 128 + // characters. It can contain letters (uppercase and lowercase), numbers, hyphens + // (-), underscores (_), periods (.), at signs (@), forward slashes (/), back + // slashes (\), colons (:), or spaces. The value can't start or end with a space. Value *string noSmithyDocumentSerde @@ -94,8 +93,7 @@ type AutoScalingGroupProvider struct { // prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks // from being terminated during a scale-in action. The Auto Scaling group and each // instance in the Auto Scaling group must have instance protection from scale-in - // actions enabled as well. For more information, see Instance Protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) + // actions enabled as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) // in the Auto Scaling User Guide. When managed termination protection is off, your // Amazon EC2 instances aren't protected from termination when the Auto Scaling // group scales in. @@ -118,8 +116,7 @@ type AutoScalingGroupProviderUpdate struct { // instances in an Auto Scaling group that contain tasks from being terminated // during a scale-in action. The Auto Scaling group and each instance in the Auto // Scaling group must have instance protection from scale-in actions on. For more - // information, see Instance Protection - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) + // information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) // in the Auto Scaling User Guide. When managed termination protection is off, your // Amazon EC2 instances aren't protected from termination when the Auto Scaling // group scales in. @@ -132,20 +129,20 @@ type AutoScalingGroupProviderUpdate struct { type AwsVpcConfiguration struct { // The IDs of the subnets associated with the task or service. There's a limit of - // 16 subnets that can be specified per AwsVpcConfiguration. All specified subnets + // 16 subnets that can be specified per AwsVpcConfiguration . All specified subnets // must be from the same VPC. // // This member is required. Subnets []string // Whether the task's elastic network interface receives a public IP address. The - // default value is DISABLED. + // default value is DISABLED . AssignPublicIp AssignPublicIp - // The IDs of the security groups associated with the task or service. If you don't - // specify a security group, the default security group for the VPC is used. + // The IDs of the security groups associated with the task or service. If you + // don't specify a security group, the default security group for the VPC is used. // There's a limit of 5 security groups that can be specified per - // AwsVpcConfiguration. All specified security groups must be from the same VPC. + // AwsVpcConfiguration . All specified security groups must be from the same VPC. SecurityGroups []string noSmithyDocumentSerde @@ -171,39 +168,28 @@ type CapacityProvider struct { // The metadata that you apply to the capacity provider to help you categorize and // organize it. Each tag consists of a key and an optional value. You define both. // The following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50 - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag // The update status of the capacity provider. The following are the possible // states that is returned. DELETE_IN_PROGRESS The capacity provider is in the // process of being deleted. DELETE_COMPLETE The capacity provider was successfully - // deleted and has an INACTIVE status. DELETE_FAILED The capacity provider can't be - // deleted. The update status reason provides further details about why the delete - // failed. + // deleted and has an INACTIVE status. DELETE_FAILED The capacity provider can't + // be deleted. The update status reason provides further details about why the + // delete failed. UpdateStatus CapacityProviderUpdateStatus // The update status reason. This provides further details about the update status @@ -213,19 +199,20 @@ type CapacityProvider struct { noSmithyDocumentSerde } -// The details of a capacity provider strategy. A capacity provider strategy can be -// set when using the RunTask or CreateCluster APIs or as the default capacity +// The details of a capacity provider strategy. A capacity provider strategy can +// be set when using the RunTask or CreateCluster APIs or as the default capacity // provider strategy for a cluster with the CreateCluster API. Only capacity // providers that are already associated with a cluster and have an ACTIVE or // UPDATING status can be used in a capacity provider strategy. The // PutClusterCapacityProviders API is used to associate a capacity provider with a // cluster. If specifying a capacity provider that uses an Auto Scaling group, the // capacity provider must already be created. New Auto Scaling group capacity -// providers can be created with the CreateCapacityProvider API operation. To use a -// Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity -// providers. The Fargate capacity providers are available to all accounts and only -// need to be associated with a cluster to be used in a capacity provider strategy. -// A capacity provider strategy may contain a maximum of 6 capacity providers. +// providers can be created with the CreateCapacityProvider API operation. To use +// a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT +// capacity providers. The Fargate capacity providers are available to all accounts +// and only need to be associated with a cluster to be used in a capacity provider +// strategy. A capacity provider strategy may contain a maximum of 6 capacity +// providers. type CapacityProviderStrategyItem struct { // The short name of the capacity provider. @@ -239,21 +226,22 @@ type CapacityProviderStrategyItem struct { // used. Base int32 - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. The weight value is - // taken into consideration after the base value, if defined, is satisfied. If no - // weight value is specified, the default value of 0 is used. When multiple - // capacity providers are specified within a capacity provider strategy, at least - // one of the capacity providers must have a weight value greater than zero and any - // capacity providers with a weight of 0 can't be used to place tasks. If you - // specify multiple capacity providers in a strategy that all have a weight of 0, - // any RunTask or CreateService actions using the capacity provider strategy will - // fail. An example scenario for using weights is defining a strategy that contains - // two capacity providers and both have a weight of 1, then when the base is - // satisfied, the tasks will be split evenly across the two capacity providers. - // Using that same logic, if you specify a weight of 1 for capacityProviderA and a - // weight of 4 for capacityProviderB, then for every one task that's run using - // capacityProviderA, four tasks would use capacityProviderB. + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight + // value is taken into consideration after the base value, if defined, is + // satisfied. If no weight value is specified, the default value of 0 is used. + // When multiple capacity providers are specified within a capacity provider + // strategy, at least one of the capacity providers must have a weight value + // greater than zero and any capacity providers with a weight of 0 can't be used + // to place tasks. If you specify multiple capacity providers in a strategy that + // all have a weight of 0 , any RunTask or CreateService actions using the + // capacity provider strategy will fail. An example scenario for using weights is + // defining a strategy that contains two capacity providers and both have a weight + // of 1 , then when the base is satisfied, the tasks will be split evenly across + // the two capacity providers. Using that same logic, if you specify a weight of 1 + // for capacityProviderA and a weight of 4 for capacityProviderB, then for every + // one task that's run using capacityProviderA, four tasks would use + // capacityProviderB. Weight int32 noSmithyDocumentSerde @@ -266,7 +254,7 @@ type CapacityProviderStrategyItem struct { type Cluster struct { // The number of services that are running on the cluster in an ACTIVE state. You - // can view these services with ListServices. + // can view these services with ListServices . ActiveServicesCount int32 // The resources attached to a cluster. When using a capacity provider with a @@ -283,9 +271,8 @@ type Cluster struct { // The capacity providers associated with the cluster. CapacityProviders []string - // The Amazon Resource Name (ARN) that identifies the cluster. For more information - // about the ARN format, see Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + // The Amazon Resource Name (ARN) that identifies the cluster. For more + // information about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) // in the Amazon ECS Developer Guide. ClusterArn *string @@ -314,15 +301,14 @@ type Cluster struct { // default Service Connect namespace, any new services with Service Connect turned // on that are created in the cluster are added as client services in the // namespace. This setting only applies to new services that set the enabled - // parameter to true in the ServiceConnectConfiguration. You can set the namespace - // of each service individually in the ServiceConnectConfiguration to override this - // default parameter. Tasks that run in a namespace can use short names to connect - // to services in the namespace. Tasks can connect to services across all of the - // clusters in the namespace. Tasks connect through a managed proxy container that - // collects logs and metrics for increased visibility. Only the tasks that Amazon - // ECS services create are supported with Service Connect. For more information, - // see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // parameter to true in the ServiceConnectConfiguration . You can set the namespace + // of each service individually in the ServiceConnectConfiguration to override + // this default parameter. Tasks that run in a namespace can use short names to + // connect to services in the namespace. Tasks can connect to services across all + // of the clusters in the namespace. Tasks connect through a managed proxy + // container that collects logs and metrics for increased visibility. Only the + // tasks that Amazon ECS services create are supported with Service Connect. For + // more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectDefaults *ClusterServiceConnectDefaults @@ -332,25 +318,14 @@ type Cluster struct { // Additional information about your clusters that are separated by launch type. // They include the following: - // - // * runningEC2TasksCount - // - // * - // RunningFargateTasksCount - // - // * pendingEC2TasksCount - // - // * pendingFargateTasksCount - // - // * - // activeEC2ServiceCount - // - // * activeFargateServiceCount - // - // * drainingEC2ServiceCount - // - // * - // drainingFargateServiceCount + // - runningEC2TasksCount + // - RunningFargateTasksCount + // - pendingEC2TasksCount + // - pendingFargateTasksCount + // - activeEC2ServiceCount + // - activeFargateServiceCount + // - drainingEC2ServiceCount + // - drainingFargateServiceCount Statistics []KeyValuePair // The status of the cluster. The following are the possible states that are @@ -370,31 +345,20 @@ type Cluster struct { // The metadata that you apply to the cluster to help you categorize and organize // them. Each tag consists of a key and an optional value. You define both. The // following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50 - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag noSmithyDocumentSerde @@ -413,15 +377,14 @@ type ClusterConfiguration struct { // default Service Connect namespace, any new services with Service Connect turned // on that are created in the cluster are added as client services in the // namespace. This setting only applies to new services that set the enabled -// parameter to true in the ServiceConnectConfiguration. You can set the namespace -// of each service individually in the ServiceConnectConfiguration to override this -// default parameter. Tasks that run in a namespace can use short names to connect -// to services in the namespace. Tasks can connect to services across all of the -// clusters in the namespace. Tasks connect through a managed proxy container that -// collects logs and metrics for increased visibility. Only the tasks that Amazon -// ECS services create are supported with Service Connect. For more information, -// see Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// parameter to true in the ServiceConnectConfiguration . You can set the namespace +// of each service individually in the ServiceConnectConfiguration to override +// this default parameter. Tasks that run in a namespace can use short names to +// connect to services in the namespace. Tasks can connect to services across all +// of the clusters in the namespace. Tasks connect through a managed proxy +// container that collects logs and metrics for increased visibility. Only the +// tasks that Amazon ECS services create are supported with Service Connect. For +// more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. type ClusterServiceConnectDefaults struct { @@ -437,34 +400,33 @@ type ClusterServiceConnectDefaults struct { // default Service Connect namespace, any new services with Service Connect turned // on that are created in the cluster are added as client services in the // namespace. This setting only applies to new services that set the enabled -// parameter to true in the ServiceConnectConfiguration. You can set the namespace -// of each service individually in the ServiceConnectConfiguration to override this -// default parameter. Tasks that run in a namespace can use short names to connect -// to services in the namespace. Tasks can connect to services across all of the -// clusters in the namespace. Tasks connect through a managed proxy container that -// collects logs and metrics for increased visibility. Only the tasks that Amazon -// ECS services create are supported with Service Connect. For more information, -// see Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// parameter to true in the ServiceConnectConfiguration . You can set the namespace +// of each service individually in the ServiceConnectConfiguration to override +// this default parameter. Tasks that run in a namespace can use short names to +// connect to services in the namespace. Tasks can connect to services across all +// of the clusters in the namespace. Tasks connect through a managed proxy +// container that collects logs and metrics for increased visibility. Only the +// tasks that Amazon ECS services create are supported with Service Connect. For +// more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. type ClusterServiceConnectDefaultsRequest struct { - // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace - // that's used when you create a service and don't specify a Service Connect - // configuration. The namespace name can include up to 1024 characters. The name is - // case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), - // less than (<), or slash (/). If you enter an existing namespace name or ARN, - // then that namespace will be used. Any namespace type is supported. The namespace - // must be in this account and this Amazon Web Services Region. If you enter a new - // name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map - // namespace with the "API calls" method of instance discovery only. This instance - // discovery method is the "HTTP" namespace type in the Command Line Interface. - // Other types of instance discovery aren't used by Service Connect. If you update - // the service with an empty string "" for the namespace name, the cluster - // configuration for Service Connect is removed. Note that the namespace will - // remain in Cloud Map and must be deleted separately. For more information about - // Cloud Map, see Working with Services (https://docs.aws.amazon.com/) in the Cloud - // Map Developer Guide. + // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map + // namespace that's used when you create a service and don't specify a Service + // Connect configuration. The namespace name can include up to 1024 characters. The + // name is case-sensitive. The name can't include hyphens (-), tilde (~), greater + // than (>), less than (<), or slash (/). If you enter an existing namespace name + // or ARN, then that namespace will be used. Any namespace type is supported. The + // namespace must be in this account and this Amazon Web Services Region. If you + // enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a + // Cloud Map namespace with the "API calls" method of instance discovery only. This + // instance discovery method is the "HTTP" namespace type in the Command Line + // Interface. Other types of instance discovery aren't used by Service Connect. If + // you update the service with an empty string "" for the namespace name, the + // cluster configuration for Service Connect is removed. Note that the namespace + // will remain in Cloud Map and must be deleted separately. For more information + // about Cloud Map, see Working with Services (https://docs.aws.amazon.com/) in + // the Cloud Map Developer Guide. // // This member is required. Namespace *string @@ -476,17 +438,16 @@ type ClusterServiceConnectDefaultsRequest struct { // CloudWatch Container Insights for a cluster. type ClusterSetting struct { - // The name of the cluster setting. The only supported value is containerInsights. + // The name of the cluster setting. The only supported value is containerInsights . Name ClusterSettingName // The value to set for the cluster setting. The supported values are enabled and - // disabled. If enabled is specified, CloudWatch Container Insights will be enabled - // for the cluster, otherwise it will be off unless the containerInsights account - // setting is turned on. If a cluster value is specified, it will override the - // containerInsights value set with PutAccountSetting - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) - // or PutAccountSettingDefault - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html). + // disabled . If enabled is specified, CloudWatch Container Insights will be + // enabled for the cluster, otherwise it will be off unless the containerInsights + // account setting is turned on. If a cluster value is specified, it will override + // the containerInsights value set with PutAccountSetting (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) + // or PutAccountSettingDefault (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html) + // . Value *string noSmithyDocumentSerde @@ -509,7 +470,7 @@ type Container struct { GpuIds []string // The health status of the container. If health checks aren't configured for this - // container in its task definition, then it reports the health status as UNKNOWN. + // container in its task definition, then it reports the health status as UNKNOWN . HealthStatus HealthStatus // The image used for the container. @@ -540,8 +501,8 @@ type Container struct { // The network interfaces associated with the container. NetworkInterfaces []NetworkInterface - // A short (255 max characters) human-readable string to provide additional details - // about a running or stopped container. + // A short (255 max characters) human-readable string to provide additional + // details about a running or stopped container. Reason *string // The ID of the Docker container. @@ -558,60 +519,52 @@ type Container struct { type ContainerDefinition struct { // The command that's passed to the container. This parameter maps to Cmd in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // COMMAND parameter to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). For more - // information, see https://docs.docker.com/engine/reference/builder/#cmd - // (https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple - // arguments, each argument is a separated string in the array. + // Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . For more information, see + // https://docs.docker.com/engine/reference/builder/#cmd (https://docs.docker.com/engine/reference/builder/#cmd) + // . If there are multiple arguments, each argument is a separated string in the + // array. Command []string // The number of cpu units reserved for the container. This parameter maps to - // CpuShares in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // field is optional for tasks using the Fargate launch type, and the only + // CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This field is optional for tasks using the Fargate launch type, and the only // requirement is that the total amount of CPU reserved for all containers within a - // task be lower than the task-level cpu value. You can determine the number of CPU - // units that are available per EC2 instance type by multiplying the vCPUs listed - // for that instance type on the Amazon EC2 Instances - // (http://aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux - // containers share unallocated CPU units with other containers on the container - // instance with the same ratio as their allocated amount. For example, if you run - // a single-container task on a single-core instance type with 512 CPU units - // specified for that container, and that's the only task running on the container - // instance, that container could use the full 1,024 CPU unit share at any given - // time. However, if you launched another copy of the same task on that container - // instance, each task is guaranteed a minimum of 512 CPU units when needed. - // Moreover, each container could float to higher CPU usage if the other container - // was not using it. If both tasks were 100% active all of the time, they would be - // limited to 512 CPU units. On Linux container instances, the Docker daemon on the - // container instance uses the CPU value to calculate the relative CPU share ratios - // for running containers. For more information, see CPU share constraint - // (https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the - // Docker documentation. The minimum valid CPU share value that the Linux kernel - // allows is 2. However, the CPU parameter isn't required, and you can use CPU - // values below 2 in your container definitions. For CPU values below 2 (including - // null), the behavior varies based on your Amazon ECS container agent version: - // - // * - // Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed - // to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 - // are passed to Docker as 1, which the Linux kernel converts to two CPU shares. - // - // * - // Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 - // are passed to Docker as 2. - // - // On Windows container instances, the CPU limit is - // enforced as an absolute limit, or a quota. Windows containers only have access - // to the specified amount of CPU that's described in the task definition. A null - // or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of - // one CPU. + // task be lower than the task-level cpu value. You can determine the number of + // CPU units that are available per EC2 instance type by multiplying the vCPUs + // listed for that instance type on the Amazon EC2 Instances (http://aws.amazon.com/ec2/instance-types/) + // detail page by 1,024. Linux containers share unallocated CPU units with other + // containers on the container instance with the same ratio as their allocated + // amount. For example, if you run a single-container task on a single-core + // instance type with 512 CPU units specified for that container, and that's the + // only task running on the container instance, that container could use the full + // 1,024 CPU unit share at any given time. However, if you launched another copy of + // the same task on that container instance, each task is guaranteed a minimum of + // 512 CPU units when needed. Moreover, each container could float to higher CPU + // usage if the other container was not using it. If both tasks were 100% active + // all of the time, they would be limited to 512 CPU units. On Linux container + // instances, the Docker daemon on the container instance uses the CPU value to + // calculate the relative CPU share ratios for running containers. For more + // information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#cpu-share-constraint) + // in the Docker documentation. The minimum valid CPU share value that the Linux + // kernel allows is 2. However, the CPU parameter isn't required, and you can use + // CPU values below 2 in your container definitions. For CPU values below 2 + // (including null), the behavior varies based on your Amazon ECS container agent + // version: + // - Agent versions less than or equal to 1.1.0: Null and zero CPU values are + // passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU + // values of 1 are passed to Docker as 1, which the Linux kernel converts to two + // CPU shares. + // - Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values + // of 1 are passed to Docker as 2. + // On Windows container instances, the CPU limit is enforced as an absolute limit, + // or a quota. Windows containers only have access to the specified amount of CPU + // that's described in the task definition. A null or zero CPU value is passed to + // Docker as 0 , which Windows interprets as 1% of one CPU. Cpu int32 // The dependencies defined for container startup and shutdown. A container can @@ -621,59 +574,46 @@ type ContainerDefinition struct { // at least version 1.26.0 of the container agent to turn on container // dependencies. However, we recommend using the latest container agent version. // For information about checking your agent version and updating to the latest - // version, see Updating the Amazon ECS Container Agent - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) // in the Amazon Elastic Container Service Developer Guide. If you're using an // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of // the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container - // agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + // agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. For tasks using the // Fargate launch type, the task or service requires the following platforms: - // - // * - // Linux platform version 1.3.0 or later. - // - // * Windows platform version 1.0.0 or - // later. + // - Linux platform version 1.3.0 or later. + // - Windows platform version 1.0.0 or later. DependsOn []ContainerDependency // When this parameter is true, networking is off within the container. This - // parameter maps to NetworkDisabled in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). This - // parameter is not supported for Windows containers. + // parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) . + // This parameter is not supported for Windows containers. DisableNetworking *bool - // A list of DNS search domains that are presented to the container. This parameter - // maps to DnsSearch in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --dns-search option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter is not supported for Windows containers. + // A list of DNS search domains that are presented to the container. This + // parameter maps to DnsSearch in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter is not supported for Windows containers. DnsSearchDomains []string // A list of DNS servers that are presented to the container. This parameter maps - // to Dns in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --dns - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter is not supported for Windows containers. + // to Dns in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --dns option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter is not supported for Windows containers. DnsServers []string // A key/value map of labels to add to the container. This parameter maps to Labels - // in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --label option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter requires version 1.18 of the Docker Remote API or greater on your - // container instance. To check the Docker Remote API version on your container - // instance, log in to your container instance and run the following command: sudo - // docker version --format '{{.Server.APIVersion}}' + // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --label option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter requires version 1.18 of the Docker Remote API or greater on + // your container instance. To check the Docker Remote API version on your + // container instance, log in to your container instance and run the following + // command: sudo docker version --format '{{.Server.APIVersion}}' DockerLabels map[string]string // A list of strings to provide custom labels for SELinux and AppArmor multi-level @@ -681,230 +621,197 @@ type ContainerDefinition struct { // Fargate launch type. With Windows containers, this parameter can be used to // reference a credential spec file when configuring a container for Active // Directory authentication. For more information, see Using gMSAs for Windows - // Containers - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) + // Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) // in the Amazon Elastic Container Service Developer Guide. This parameter maps to - // SecurityOpt in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --security-opt option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). The - // Amazon ECS container agent running on a container instance must register with - // the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables - // before containers placed on that instance can use these security options. For - // more information, see Amazon ECS Container Agent Configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // SecurityOpt in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --security-opt option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . The Amazon ECS container agent running on a container instance must register + // with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment + // variables before containers placed on that instance can use these security + // options. For more information, see Amazon ECS Container Agent Configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. For more information - // about valid values, see Docker Run Security Configuration - // (https://docs.docker.com/engine/reference/run/#security-configuration). Valid - // values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | + // about valid values, see Docker Run Security Configuration (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | // "credentialspec:CredentialSpecFilePath" DockerSecurityOptions []string // Early versions of the Amazon ECS container agent don't properly handle - // entryPoint parameters. If you have problems using entryPoint, update your + // entryPoint parameters. If you have problems using entryPoint , update your // container agent or enter your commands and arguments as command array items // instead. The entry point that's passed to the container. This parameter maps to - // Entrypoint in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --entrypoint option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). For more - // information, see https://docs.docker.com/engine/reference/builder/#entrypoint - // (https://docs.docker.com/engine/reference/builder/#entrypoint). + // Entrypoint in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . For more information, see + // https://docs.docker.com/engine/reference/builder/#entrypoint (https://docs.docker.com/engine/reference/builder/#entrypoint) + // . EntryPoint []string // The environment variables to pass to a container. This parameter maps to Env in - // the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --env - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). We don't - // recommend that you use plaintext environment variables for sensitive + // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --env option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . We don't recommend that you use plaintext environment variables for sensitive // information, such as credential data. Environment []KeyValuePair // A list of files containing the environment variables to pass to a container. - // This parameter maps to the --env-file option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). You can - // specify up to ten environment files. The file must have a .env file extension. - // Each line in an environment file contains an environment variable in + // This parameter maps to the --env-file option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . You can specify up to ten environment files. The file must have a .env file + // extension. Each line in an environment file contains an environment variable in // VARIABLE=VALUE format. Lines beginning with # are treated as comments and are // ignored. For more information about the environment variable file syntax, see - // Declare default environment variables in file - // (https://docs.docker.com/compose/env-file/). If there are environment variables - // specified using the environment parameter in a container definition, they take - // precedence over the variables contained within an environment file. If multiple - // environment files are specified that contain the same variable, they're - // processed from the top down. We recommend that you use unique variable names. - // For more information, see Specifying Environment Variables - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) + // Declare default environment variables in file (https://docs.docker.com/compose/env-file/) + // . If there are environment variables specified using the environment parameter + // in a container definition, they take precedence over the variables contained + // within an environment file. If multiple environment files are specified that + // contain the same variable, they're processed from the top down. We recommend + // that you use unique variable names. For more information, see Specifying + // Environment Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. EnvironmentFiles []EnvironmentFile - // If the essential parameter of a container is marked as true, and that container + // If the essential parameter of a container is marked as true , and that container // fails or stops for any reason, all other containers that are part of the task - // are stopped. If the essential parameter of a container is marked as false, its + // are stopped. If the essential parameter of a container is marked as false , its // failure doesn't affect the rest of the containers in a task. If this parameter // is omitted, a container is assumed to be essential. All tasks must have at least // one essential container. If you have an application that's composed of multiple // containers, group containers that are used for a common purpose into components, // and separate the different components into multiple task definitions. For more - // information, see Application Architecture - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) + // information, see Application Architecture (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) // in the Amazon Elastic Container Service Developer Guide. Essential *bool // A list of hostnames and IP address mappings to append to the /etc/hosts file on - // the container. This parameter maps to ExtraHosts in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --add-host option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter isn't supported for Windows containers or tasks that use the awsvpc - // network mode. + // the container. This parameter maps to ExtraHosts in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --add-host option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter isn't supported for Windows containers or tasks that use the + // awsvpc network mode. ExtraHosts []HostEntry // The FireLens configuration for the container. This is used to specify and // configure a log router for container logs. For more information, see Custom Log - // Routing - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) + // Routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) // in the Amazon Elastic Container Service Developer Guide. FirelensConfiguration *FirelensConfiguration // The container health check command and associated configuration parameters for - // the container. This parameter maps to HealthCheck in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // HEALTHCHECK parameter of docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // the container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . HealthCheck *HealthCheck // The hostname to use for your container. This parameter maps to Hostname in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --hostname option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). The - // hostname parameter is not supported if you're using the awsvpc network mode. + // Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . The hostname parameter is not supported if you're using the awsvpc network + // mode. Hostname *string // The image used to start a container. This string is passed directly to the // Docker daemon. By default, images in the Docker Hub registry are available. - // Other repositories are specified with either repository-url/image:tag or + // Other repositories are specified with either repository-url/image:tag or // repository-url/image@digest . Up to 255 letters (uppercase and lowercase), // numbers, hyphens, underscores, colons, periods, forward slashes, and number - // signs are allowed. This parameter maps to Image in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the IMAGE - // parameter of docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). - // - // * When - // a new task starts, the Amazon ECS container agent pulls the latest version of - // the specified image and tag for the container to use. However, subsequent - // updates to a repository image aren't propagated to already running tasks. - // - // * - // Images in Amazon ECR repositories can be specified by either using the full - // registry/repository:tag or registry/repository@digest. For example, - // 012345678910.dkr.ecr..amazonaws.com/:latest or - // 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. - // - // * - // Images in official repositories on Docker Hub use a single name (for example, - // ubuntu or mongo). - // - // * Images in other repositories on Docker Hub are qualified - // with an organization name (for example, amazon/amazon-ecs-agent). - // - // * Images in - // other online repositories are qualified further by a domain name (for example, - // quay.io/assemblyline/ubuntu). + // signs are allowed. This parameter maps to Image in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . + // - When a new task starts, the Amazon ECS container agent pulls the latest + // version of the specified image and tag for the container to use. However, + // subsequent updates to a repository image aren't propagated to already running + // tasks. + // - Images in Amazon ECR repositories can be specified by either using the full + // registry/repository:tag or registry/repository@digest . For example, + // 012345678910.dkr.ecr..amazonaws.com/:latest or + // 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE + // . + // - Images in official repositories on Docker Hub use a single name (for + // example, ubuntu or mongo ). + // - Images in other repositories on Docker Hub are qualified with an + // organization name (for example, amazon/amazon-ecs-agent ). + // - Images in other online repositories are qualified further by a domain name + // (for example, quay.io/assemblyline/ubuntu ). Image *string - // When this parameter is true, you can deploy containerized applications that + // When this parameter is true , you can deploy containerized applications that // require stdin or a tty to be allocated. This parameter maps to OpenStdin in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --interactive option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --interactive option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Interactive *bool - // The links parameter allows containers to communicate with each other without the - // need for port mappings. This parameter is only supported if the network mode of - // a task definition is bridge. The name:internalName construct is analogous to - // name:alias in Docker links. Up to 255 letters (uppercase and lowercase), + // The links parameter allows containers to communicate with each other without + // the need for port mappings. This parameter is only supported if the network mode + // of a task definition is bridge . The name:internalName construct is analogous + // to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), // numbers, underscores, and hyphens are allowed. For more information about - // linking Docker containers, go to Legacy container links - // (https://docs.docker.com/network/links/) in the Docker documentation. This - // parameter maps to Links in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --link - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter is not supported for Windows containers. Containers that are + // linking Docker containers, go to Legacy container links (https://docs.docker.com/network/links/) + // in the Docker documentation. This parameter maps to Links in the Create a + // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --link option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter is not supported for Windows containers. Containers that are // collocated on a single container instance may be able to communicate with each // other without requiring links or host port mappings. Network isolation is // achieved on the container instance using security groups and VPC settings. Links []string // Linux-specific modifications that are applied to the container, such as Linux - // kernel capabilities. For more information see KernelCapabilities. This parameter - // is not supported for Windows containers. + // kernel capabilities. For more information see KernelCapabilities . This + // parameter is not supported for Windows containers. LinuxParameters *LinuxParameters // The log configuration specification for the container. This parameter maps to - // LogConfig in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --log-driver option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). By - // default, containers use the same logging driver that the Docker daemon uses. - // However the container can use a different logging driver than the Docker daemon - // by specifying a log driver with this parameter in the container definition. To - // use a different logging driver for a container, the log system must be - // configured properly on the container instance (or on a different log server for - // remote logging options). For more information about the options for different - // supported log drivers, see Configure logging drivers - // (https://docs.docker.com/engine/admin/logging/overview/) in the Docker - // documentation. Amazon ECS currently supports a subset of the logging drivers - // available to the Docker daemon (shown in the LogConfiguration data type). - // Additional log drivers may be available in future releases of the Amazon ECS - // container agent. This parameter requires version 1.18 of the Docker Remote API - // or greater on your container instance. To check the Docker Remote API version on - // your container instance, log in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' The Amazon ECS - // container agent running on a container instance must register the logging - // drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS - // environment variable before containers placed on that instance can use these log - // configuration options. For more information, see Amazon ECS Container Agent - // Configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . By default, containers use the same logging driver that the Docker daemon + // uses. However the container can use a different logging driver than the Docker + // daemon by specifying a log driver with this parameter in the container + // definition. To use a different logging driver for a container, the log system + // must be configured properly on the container instance (or on a different log + // server for remote logging options). For more information about the options for + // different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) + // in the Docker documentation. Amazon ECS currently supports a subset of the + // logging drivers available to the Docker daemon (shown in the LogConfiguration + // data type). Additional log drivers may be available in future releases of the + // Amazon ECS container agent. This parameter requires version 1.18 of the Docker + // Remote API or greater on your container instance. To check the Docker Remote API + // version on your container instance, log in to your container instance and run + // the following command: sudo docker version --format '{{.Server.APIVersion}}' + // The Amazon ECS container agent running on a container instance must register the + // logging drivers available on that instance with the + // ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on + // that instance can use these log configuration options. For more information, see + // Amazon ECS Container Agent Configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. LogConfiguration *LogConfiguration // The amount (in MiB) of memory to present to the container. If your container // attempts to exceed the memory specified here, the container is killed. The total // amount of memory reserved for all containers within a task must be lower than - // the task memory value, if one is specified. This parameter maps to Memory in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --memory option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If using - // the Fargate launch type, this parameter is optional. If using the EC2 launch - // type, you must specify either a task-level memory value or a container-level - // memory value. If you specify both a container-level memory and memoryReservation - // value, memory must be greater than memoryReservation. If you specify - // memoryReservation, then that value is subtracted from the available memory - // resources for the container instance where the container is placed. Otherwise, - // the value of memory is used. The Docker 20.10.0 or later daemon reserves a - // minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of - // memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a - // minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of - // memory for your containers. + // the task memory value, if one is specified. This parameter maps to Memory in + // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If using the Fargate launch type, this parameter is optional. If using the EC2 + // launch type, you must specify either a task-level memory value or a + // container-level memory value. If you specify both a container-level memory and + // memoryReservation value, memory must be greater than memoryReservation . If you + // specify memoryReservation , then that value is subtracted from the available + // memory resources for the container instance where the container is placed. + // Otherwise, the value of memory is used. The Docker 20.10.0 or later daemon + // reserves a minimum of 6 MiB of memory for a container. So, don't specify less + // than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier + // daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify + // less than 4 MiB of memory for your containers. Memory *int32 // The soft limit (in MiB) of memory to reserve for the container. When system @@ -912,97 +819,88 @@ type ContainerDefinition struct { // to this soft limit. However, your container can consume more memory when it // needs to, up to either the hard limit specified with the memory parameter (if // applicable), or all of the available memory on the container instance, whichever - // comes first. This parameter maps to MemoryReservation in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --memory-reservation option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If a - // task-level memory value is not specified, you must specify a non-zero integer - // for one or both of memory or memoryReservation in a container definition. If you - // specify both, memory must be greater than memoryReservation. If you specify - // memoryReservation, then that value is subtracted from the available memory - // resources for the container instance where the container is placed. Otherwise, - // the value of memory is used. For example, if your container normally uses 128 - // MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of - // time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 - // MiB. This configuration would allow the container to only reserve 128 MiB of - // memory from the remaining resources on the container instance, but also allow - // the container to consume more memory resources when needed. The Docker 20.10.0 - // or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't - // specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or - // earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't - // specify less than 4 MiB of memory for your containers. + // comes first. This parameter maps to MemoryReservation in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If a task-level memory value is not specified, you must specify a non-zero + // integer for one or both of memory or memoryReservation in a container + // definition. If you specify both, memory must be greater than memoryReservation . + // If you specify memoryReservation , then that value is subtracted from the + // available memory resources for the container instance where the container is + // placed. Otherwise, the value of memory is used. For example, if your container + // normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory + // for short periods of time, you can set a memoryReservation of 128 MiB, and a + // memory hard limit of 300 MiB. This configuration would allow the container to + // only reserve 128 MiB of memory from the remaining resources on the container + // instance, but also allow the container to consume more memory resources when + // needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory + // for a container. So, don't specify less than 6 MiB of memory for your + // containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB + // of memory for a container. So, don't specify less than 4 MiB of memory for your + // containers. MemoryReservation *int32 // The mount points for data volumes in your container. This parameter maps to - // Volumes in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --volume option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). Windows - // containers can mount whole directories on the same drive as $env:ProgramData. - // Windows containers can't mount directories on a different drive, and mount point - // can't be across drives. + // Volumes in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Windows containers can mount whole directories on the same drive as + // $env:ProgramData . Windows containers can't mount directories on a different + // drive, and mount point can't be across drives. MountPoints []MountPoint // The name of a container. If you're linking multiple containers together in a // task definition, the name of one container can be entered in the links of // another container to connect the containers. Up to 255 letters (uppercase and // lowercase), numbers, underscores, and hyphens are allowed. This parameter maps - // to name in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --name - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // to name in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --name option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Name *string // The list of port mappings for the container. Port mappings allow containers to // access ports on the host container instance to send or receive traffic. For task - // definitions that use the awsvpc network mode, only specify the containerPort. - // The hostPort can be left blank or it must be the same value as the - // containerPort. Port mappings on Windows use the NetNAT gateway address rather - // than localhost. There's no loopback for port mappings on Windows, so you can't - // access a container's mapped port from the host itself. This parameter maps to - // PortBindings in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --publish option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If the - // network mode of a task definition is set to none, then you can't specify port - // mappings. If the network mode of a task definition is set to host, then host - // ports must either be undefined or they must match the container port in the port - // mapping. After a task reaches the RUNNING status, manual and automatic host and - // container port assignments are visible in the Network Bindings section of a - // container description for a selected task in the Amazon ECS console. The - // assignments are also visible in the networkBindings section DescribeTasks - // responses. + // definitions that use the awsvpc network mode, only specify the containerPort . + // The hostPort can be left blank or it must be the same value as the containerPort + // . Port mappings on Windows use the NetNAT gateway address rather than localhost + // . There's no loopback for port mappings on Windows, so you can't access a + // container's mapped port from the host itself. This parameter maps to + // PortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --publish option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If the network mode of a task definition is set to none , then you can't + // specify port mappings. If the network mode of a task definition is set to host , + // then host ports must either be undefined or they must match the container port + // in the port mapping. After a task reaches the RUNNING status, manual and + // automatic host and container port assignments are visible in the Network + // Bindings section of a container description for a selected task in the Amazon + // ECS console. The assignments are also visible in the networkBindings section + // DescribeTasks responses. PortMappings []PortMapping // When this parameter is true, the container is given elevated privileges on the // host container instance (similar to the root user). This parameter maps to - // Privileged in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --privileged option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter is not supported for Windows containers or tasks run on Fargate. + // Privileged in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter is not supported for Windows containers or tasks run on + // Fargate. Privileged *bool - // When this parameter is true, a TTY is allocated. This parameter maps to Tty in - // the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --tty - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // When this parameter is true , a TTY is allocated. This parameter maps to Tty in + // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --tty option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . PseudoTerminal *bool - // When this parameter is true, the container is given read-only access to its root - // file system. This parameter maps to ReadonlyRootfs in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --read-only option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter is not supported for Windows containers. + // When this parameter is true, the container is given read-only access to its + // root file system. This parameter maps to ReadonlyRootfs in the Create a + // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --read-only option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter is not supported for Windows containers. ReadonlyRootFilesystem *bool // The private repository authentication credentials to use. @@ -1013,148 +911,116 @@ type ContainerDefinition struct { ResourceRequirements []ResourceRequirement // The secrets to pass to the container. For more information, see Specifying - // Sensitive Data - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) + // Sensitive Data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) // in the Amazon Elastic Container Service Developer Guide. Secrets []Secret // Time duration (in seconds) to wait before giving up on resolving dependencies // for a container. For example, you specify two containers in a task definition - // with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, - // or HEALTHY status. If a startTimeout value is specified for containerB and it + // with containerA having a dependency on containerB reaching a COMPLETE , SUCCESS + // , or HEALTHY status. If a startTimeout value is specified for containerB and it // doesn't reach the desired status within that time then containerA gives up and // not start. This results in the task transitioning to a STOPPED state. When the // ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's // enforced independently from this start timeout value. For tasks using the // Fargate launch type, the task or service requires the following platforms: - // - // * - // Linux platform version 1.3.0 or later. - // - // * Windows platform version 1.0.0 or - // later. - // - // For tasks using the EC2 launch type, your container instances require at - // least version 1.26.0 of the container agent to use a container start timeout - // value. However, we recommend using the latest container agent version. For - // information about checking your agent version and updating to the latest - // version, see Updating the Amazon ECS Container Agent - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // - Linux platform version 1.3.0 or later. + // - Windows platform version 1.0.0 or later. + // For tasks using the EC2 launch type, your container instances require at least + // version 1.26.0 of the container agent to use a container start timeout value. + // However, we recommend using the latest container agent version. For information + // about checking your agent version and updating to the latest version, see + // Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) // in the Amazon Elastic Container Service Developer Guide. If you're using an - // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of - // the ecs-init package. If your container instances are launched from version + // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 + // of the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container - // agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + // agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. StartTimeout *int32 // Time duration (in seconds) to wait before the container is forcefully killed if // it doesn't exit normally on its own. For tasks using the Fargate launch type, // the task or service requires the following platforms: - // - // * Linux platform version - // 1.3.0 or later. - // - // * Windows platform version 1.0.0 or later. - // - // The max stop - // timeout value is 120 seconds and if the parameter is not specified, the default - // value of 30 seconds is used. For tasks that use the EC2 launch type, if the - // stopTimeout parameter isn't specified, the value set for the Amazon ECS - // container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used. If - // neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent - // configuration variable are set, then the default values of 30 seconds for Linux - // containers and 30 seconds on Windows containers are used. Your container + // - Linux platform version 1.3.0 or later. + // - Windows platform version 1.0.0 or later. + // The max stop timeout value is 120 seconds and if the parameter is not + // specified, the default value of 30 seconds is used. For tasks that use the EC2 + // launch type, if the stopTimeout parameter isn't specified, the value set for + // the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT + // is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT + // agent configuration variable are set, then the default values of 30 seconds for + // Linux containers and 30 seconds on Windows containers are used. Your container // instances require at least version 1.26.0 of the container agent to use a // container stop timeout value. However, we recommend using the latest container // agent version. For information about checking your agent version and updating to - // the latest version, see Updating the Amazon ECS Container Agent - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) + // the latest version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) // in the Amazon Elastic Container Service Developer Guide. If you're using an // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of // the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container - // agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + // agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. StopTimeout *int32 // A list of namespaced kernel parameters to set in the container. This parameter - // maps to Sysctls in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --sysctl option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). We don't - // recommended that you specify network-related systemControls parameters for - // multiple containers in a single task that also uses either the awsvpc or host - // network modes. For tasks that use the awsvpc network mode, the container that's - // started last determines which systemControls parameters take effect. For tasks - // that use the host network mode, it changes the container instance's namespaced - // kernel parameters as well as the containers. + // maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . We don't recommended that you specify network-related systemControls + // parameters for multiple containers in a single task that also uses either the + // awsvpc or host network modes. For tasks that use the awsvpc network mode, the + // container that's started last determines which systemControls parameters take + // effect. For tasks that use the host network mode, it changes the container + // instance's namespaced kernel parameters as well as the containers. SystemControls []SystemControl // A list of ulimits to set in the container. If a ulimit value is specified in a // task definition, it overrides the default values set by Docker. This parameter - // maps to Ulimits in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --ulimit option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). Valid - // naming values are displayed in the Ulimit data type. Amazon ECS tasks hosted on - // Fargate use the default resource limit values set by the operating system with - // the exception of the nofile resource limit parameter which Fargate overrides. - // The nofile resource limit sets a restriction on the number of open files that a - // container can use. The default nofile soft limit is 1024 and the default hard - // limit is 4096. This parameter requires version 1.18 of the Docker Remote API or - // greater on your container instance. To check the Docker Remote API version on - // your container instance, log in to your container instance and run the following - // command: sudo docker version --format '{{.Server.APIVersion}}' This parameter is - // not supported for Windows containers. + // maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Valid naming values are displayed in the Ulimit data type. Amazon ECS tasks + // hosted on Fargate use the default resource limit values set by the operating + // system with the exception of the nofile resource limit parameter which Fargate + // overrides. The nofile resource limit sets a restriction on the number of open + // files that a container can use. The default nofile soft limit is 1024 and the + // default hard limit is 4096 . This parameter requires version 1.18 of the Docker + // Remote API or greater on your container instance. To check the Docker Remote API + // version on your container instance, log in to your container instance and run + // the following command: sudo docker version --format '{{.Server.APIVersion}}' + // This parameter is not supported for Windows containers. Ulimits []Ulimit // The user to use inside the container. This parameter maps to User in the Create - // a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the --user - // option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). When - // running tasks using the host network mode, don't run containers using the root - // user (UID 0). We recommend using a non-root user for better security. You can - // specify the user using the following formats. If specifying a UID or GID, you - // must specify it as a positive integer. - // - // * user - // - // * user:group - // - // * uid - // - // * - // uid:gid - // - // * user:gid - // - // * uid:group - // - // This parameter is not supported for Windows - // containers. + // a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --user option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . When running tasks using the host network mode, don't run containers using + // the root user (UID 0). We recommend using a non-root user for better security. + // You can specify the user using the following formats. If specifying a UID or + // GID, you must specify it as a positive integer. + // - user + // - user:group + // - uid + // - uid:gid + // - user:gid + // - uid:group + // This parameter is not supported for Windows containers. User *string // Data volumes to mount from another container. This parameter maps to VolumesFrom - // in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --volumes-from option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . VolumesFrom []VolumeFrom // The working directory to run commands inside the container in. This parameter - // maps to WorkingDir in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --workdir option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). + // maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . WorkingDirectory *string noSmithyDocumentSerde @@ -1166,45 +1032,34 @@ type ContainerDefinition struct { // instances require at least version 1.26.0 of the container agent to use // container dependencies. However, we recommend using the latest container agent // version. For information about checking your agent version and updating to the -// latest version, see Updating the Amazon ECS Container Agent -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) +// latest version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) // in the Amazon Elastic Container Service Developer Guide. If you're using an // Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of // the ecs-init package. If your container instances are launched from version // 20190301 or later, then they contain the required versions of the container -// agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) +// agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. For tasks that use the // Fargate launch type, the task or service requires the following platforms: -// -// * -// Linux platform version 1.3.0 or later. -// -// * Windows platform version 1.0.0 or -// later. +// - Linux platform version 1.3.0 or later. +// - Windows platform version 1.0.0 or later. type ContainerDependency struct { // The dependency condition of the container. The following are the available // conditions and their behavior: - // - // * START - This condition emulates the behavior - // of links and volumes today. It validates that a dependent container is started - // before permitting other containers to start. - // - // * COMPLETE - This condition - // validates that a dependent container runs to completion (exits) before - // permitting other containers to start. This can be useful for nonessential - // containers that run a script and then exit. This condition can't be set on an - // essential container. - // - // * SUCCESS - This condition is the same as COMPLETE, but it - // also requires that the container exits with a zero status. This condition can't - // be set on an essential container. - // - // * HEALTHY - This condition validates that the - // dependent container passes its Docker health check before permitting other - // containers to start. This requires that the dependent container has health - // checks configured. This condition is confirmed only at task startup. + // - START - This condition emulates the behavior of links and volumes today. It + // validates that a dependent container is started before permitting other + // containers to start. + // - COMPLETE - This condition validates that a dependent container runs to + // completion (exits) before permitting other containers to start. This can be + // useful for nonessential containers that run a script and then exit. This + // condition can't be set on an essential container. + // - SUCCESS - This condition is the same as COMPLETE , but it also requires that + // the container exits with a zero status. This condition can't be set on an + // essential container. + // - HEALTHY - This condition validates that the dependent container passes its + // Docker health check before permitting other containers to start. This requires + // that the dependent container has health checks configured. This condition is + // confirmed only at task startup. // // This member is required. Condition ContainerCondition @@ -1221,13 +1076,13 @@ type ContainerDependency struct { // been registered with a cluster. type ContainerInstance struct { - // This parameter returns true if the agent is connected to Amazon ECS. An instance - // with an agent that may be unhealthy or stopped return false. Only instances - // connected to an agent can accept task placement requests. + // This parameter returns true if the agent is connected to Amazon ECS. An + // instance with an agent that may be unhealthy or stopped return false . Only + // instances connected to an agent can accept task placement requests. AgentConnected bool // The status of the most recent agent update. If an update wasn't ever requested, - // this value is NULL. + // this value is NULL . AgentUpdateStatus AgentUpdateStatus // The resources attached to a container instance, such as an elastic network @@ -1243,8 +1098,7 @@ type ContainerInstance struct { CapacityProviderName *string // The Amazon Resource Name (ARN) of the container instance. For more information - // about the ARN format, see Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + // about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) // in the Amazon ECS Developer Guide. ContainerInstanceArn *string @@ -1276,15 +1130,15 @@ type ContainerInstance struct { // new tasks. For port resource types, this parameter describes the ports that were // reserved by the Amazon ECS container agent (at instance registration time) and // any task containers that have reserved port mappings on the host (with the host - // or bridge network mode). Any port that's not specified here is available for new - // tasks. + // or bridge network mode). Any port that's not specified here is available for + // new tasks. RemainingResources []Resource // The number of tasks on the container instance that are in the RUNNING status. RunningTasksCount int32 - // The status of the container instance. The valid values are REGISTERING, - // REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING. If your + // The status of the container instance. The valid values are REGISTERING , + // REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING . If your // account has opted in to the awsvpcTrunking account setting, then any newly // registered container instance will transition to a REGISTERING status while the // trunk elastic network interface is provisioned for the instance. If the @@ -1292,46 +1146,34 @@ type ContainerInstance struct { // status. You can describe the container instance and see the reason for failure // in the statusReason parameter. Once the container instance is terminated, the // instance transitions to a DEREGISTERING status while the trunk elastic network - // interface is deprovisioned. The instance then transitions to an INACTIVE status. - // The ACTIVE status indicates that the container instance can accept tasks. The - // DRAINING indicates that new tasks aren't placed on the container instance and - // any service tasks running on the container instance are removed if possible. For - // more information, see Container instance draining - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) + // interface is deprovisioned. The instance then transitions to an INACTIVE + // status. The ACTIVE status indicates that the container instance can accept + // tasks. The DRAINING indicates that new tasks aren't placed on the container + // instance and any service tasks running on the container instance are removed if + // possible. For more information, see Container instance draining (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) // in the Amazon Elastic Container Service Developer Guide. Status *string // The reason that the container instance reached its current status. StatusReason *string - // The metadata that you apply to the container instance to help you categorize and - // organize them. Each tag consists of a key and an optional value. You define + // The metadata that you apply to the container instance to help you categorize + // and organize them. Each tag consists of a key and an optional value. You define // both. The following basic restrictions apply to tags: - // - // * Maximum number of tags - // per resource - 50 - // - // * For each resource, each tag key must be unique, and each - // tag key can have only one value. - // - // * Maximum key length - 128 Unicode characters - // in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag // The version counter for the container instance. Every time a container instance @@ -1339,8 +1181,8 @@ type ContainerInstance struct { // incremented. If you're replicating your Amazon ECS container instance state with // CloudWatch Events, you can compare the version of a container instance reported // by the Amazon ECS APIs with the version reported in CloudWatch Events for the - // container instance (inside the detail object) to verify that the version in your - // event stream is current. + // container instance (inside the detail object) to verify that the version in + // your event stream is current. Version int64 // The version information for the Amazon ECS container agent and Docker daemon @@ -1357,25 +1199,25 @@ type ContainerInstanceHealthStatus struct { // status. Details []InstanceHealthCheckResult - // The overall health status of the container instance. This is an aggregate status - // of all container instance health checks. + // The overall health status of the container instance. This is an aggregate + // status of all container instance health checks. OverallStatus InstanceHealthCheckState noSmithyDocumentSerde } // The overrides that are sent to a container. An empty container override can be -// passed in. An example of an empty container override is {"containerOverrides": [ -// ] }. If a non-empty container override is specified, the name parameter must be -// included. +// passed in. An example of an empty container override is {"containerOverrides": +// [ ] } . If a non-empty container override is specified, the name parameter must +// be included. type ContainerOverride struct { - // The command to send to the container that overrides the default command from the - // Docker image or the task definition. You must also specify a container name. + // The command to send to the container that overrides the default command from + // the Docker image or the task definition. You must also specify a container name. Command []string - // The number of cpu units reserved for the container, instead of the default value - // from the task definition. You must also specify a container name. + // The number of cpu units reserved for the container, instead of the default + // value from the task definition. You must also specify a container name. Cpu *int32 // The environment variables to send to the container. You can add new environment @@ -1398,8 +1240,8 @@ type ContainerOverride struct { // default value from the task definition. You must also specify a container name. MemoryReservation *int32 - // The name of the container that receives the override. This parameter is required - // if any override is specified. + // The name of the container that receives the override. This parameter is + // required if any override is specified. Name *string // The type and amount of a resource to assign to a container, instead of the @@ -1451,24 +1293,23 @@ type Deployment struct { // deploy or maintain. DesiredCount int32 - // The number of consecutively failed tasks in the deployment. A task is considered - // a failure if the service scheduler can't launch the task, the task doesn't - // transition to a RUNNING state, or if it fails any of its defined health checks - // and is stopped. Once a service deployment has one or more successfully running - // tasks, the failed task count resets to zero and stops being evaluated. + // The number of consecutively failed tasks in the deployment. A task is + // considered a failure if the service scheduler can't launch the task, the task + // doesn't transition to a RUNNING state, or if it fails any of its defined health + // checks and is stopped. Once a service deployment has one or more successfully + // running tasks, the failed task count resets to zero and stops being evaluated. FailedTasks int32 // The ID of the deployment. Id *string // The launch type the tasks in the service are using. For more information, see - // Amazon ECS Launch Types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // Amazon ECS Launch Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType - // The VPC subnet and security group configuration for tasks that receive their own - // elastic network interface by using the awsvpc networking mode. + // The VPC subnet and security group configuration for tasks that receive their + // own elastic network interface by using the awsvpc networking mode. NetworkConfiguration *NetworkConfiguration // The number of tasks in the deployment that are in the PENDING status. @@ -1476,26 +1317,25 @@ type Deployment struct { // The operating system that your tasks in the service, or tasks are running on. A // platform family is specified only for tasks using the Fargate launch type. All - // tasks that run as part of this service must use the same platformFamily value as - // the service, for example, LINUX.. + // tasks that run as part of this service must use the same platformFamily value + // as the service, for example, LINUX. . PlatformFamily *string // The platform version that your tasks in the service run on. A platform version // is only specified for tasks using the Fargate launch type. If one isn't // specified, the LATEST platform version is used. For more information, see - // Fargate Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // The rolloutState of a service is only returned for services that use the rolling - // update (ECS) deployment type that aren't behind a Classic Load Balancer. The - // rollout state of the deployment. When a service deployment is started, it begins - // in an IN_PROGRESS state. When the service reaches a steady state, the deployment - // transitions to a COMPLETED state. If the service fails to reach a steady state - // and circuit breaker is enabled, the deployment transitions to a FAILED state. A - // deployment in FAILED state doesn't launch any new tasks. For more information, - // see DeploymentCircuitBreaker. + // The rolloutState of a service is only returned for services that use the + // rolling update ( ECS ) deployment type that aren't behind a Classic Load + // Balancer. The rollout state of the deployment. When a service deployment is + // started, it begins in an IN_PROGRESS state. When the service reaches a steady + // state, the deployment transitions to a COMPLETED state. If the service fails to + // reach a steady state and circuit breaker is enabled, the deployment transitions + // to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. + // For more information, see DeploymentCircuitBreaker . RolloutState DeploymentRolloutState // A description of the rollout state of a deployment. @@ -1504,17 +1344,16 @@ type Deployment struct { // The number of tasks in the deployment that are in the RUNNING status. RunningCount int32 - // The details of the Service Connect configuration that's used by this deployment. - // Compare the configuration between multiple deployments when troubleshooting - // issues with new deployments. The configuration for this service to discover and - // connect to services, and be discovered by, and connected from, other services - // within a namespace. Tasks that run in a namespace can use short names to connect - // to services in the namespace. Tasks can connect to services across all of the - // clusters in the namespace. Tasks connect through a managed proxy container that - // collects logs and metrics for increased visibility. Only the tasks that Amazon - // ECS services create are supported with Service Connect. For more information, - // see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // The details of the Service Connect configuration that's used by this + // deployment. Compare the configuration between multiple deployments when + // troubleshooting issues with new deployments. The configuration for this service + // to discover and connect to services, and be discovered by, and connected from, + // other services within a namespace. Tasks that run in a namespace can use short + // names to connect to services in the namespace. Tasks can connect to services + // across all of the clusters in the namespace. Tasks connect through a managed + // proxy container that collects logs and metrics for increased visibility. Only + // the tasks that Amazon ECS services create are supported with Service Connect. + // For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. ServiceConnectConfiguration *ServiceConnectConfiguration @@ -1544,8 +1383,7 @@ type Deployment struct { // deployment to failed. Set the rollback parameter to have Amazon ECS to roll back // your service to the last completed deployment after a failure. You can only use // the DeploymentAlarms method to detect failures when the DeploymentController is -// set to ECS (rolling update). For more information, see Rolling update -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) +// set to ECS (rolling update). For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) // in the Amazon Elastic Container Service Developer Guide . type DeploymentAlarms struct { @@ -1560,9 +1398,9 @@ type DeploymentAlarms struct { // This member is required. Enable bool - // Determines whether to configure Amazon ECS to roll back the service if a service - // deployment fails. If rollback is used, when a service deployment fails, the - // service is rolled back to the last deployment that completed successfully. + // Determines whether to configure Amazon ECS to roll back the service if a + // service deployment fails. If rollback is used, when a service deployment fails, + // the service is rolled back to the last deployment that completed successfully. // // This member is required. Rollback bool @@ -1571,13 +1409,12 @@ type DeploymentAlarms struct { } // The deployment circuit breaker can only be used for services using the rolling -// update (ECS) deployment type. The deployment circuit breaker determines whether -// a service deployment will fail if the service can't reach a steady state. If -// enabled, a service deployment will transition to a failed state and stop -// launching new tasks. You can also configure Amazon ECS to roll back your service -// to the last completed deployment after a failure. For more information, see -// Rolling update -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) +// update ( ECS ) deployment type. The deployment circuit breaker determines +// whether a service deployment will fail if the service can't reach a steady +// state. If enabled, a service deployment will transition to a failed state and +// stop launching new tasks. You can also configure Amazon ECS to roll back your +// service to the last completed deployment after a failure. For more information, +// see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) // in the Amazon Elastic Container Service Developer Guide. type DeploymentCircuitBreaker struct { @@ -1586,9 +1423,9 @@ type DeploymentCircuitBreaker struct { // This member is required. Enable bool - // Determines whether to configure Amazon ECS to roll back the service if a service - // deployment fails. If rollback is on, when a service deployment fails, the - // service is rolled back to the last deployment that completed successfully. + // Determines whether to configure Amazon ECS to roll back the service if a + // service deployment fails. If rollback is on, when a service deployment fails, + // the service is rolled back to the last deployment that completed successfully. // // This member is required. Rollback bool @@ -1604,81 +1441,70 @@ type DeploymentConfiguration struct { Alarms *DeploymentAlarms // The deployment circuit breaker can only be used for services using the rolling - // update (ECS) deployment type. The deployment circuit breaker determines whether - // a service deployment will fail if the service can't reach a steady state. If you - // use the deployment circuit breaker, a service deployment will transition to a - // failed state and stop launching new tasks. If you use the rollback option, when - // a service deployment fails, the service is rolled back to the last deployment - // that completed successfully. For more information, see Rolling update - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) + // update ( ECS ) deployment type. The deployment circuit breaker determines + // whether a service deployment will fail if the service can't reach a steady + // state. If you use the deployment circuit breaker, a service deployment will + // transition to a failed state and stop launching new tasks. If you use the + // rollback option, when a service deployment fails, the service is rolled back to + // the last deployment that completed successfully. For more information, see + // Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) // in the Amazon Elastic Container Service Developer Guide DeploymentCircuitBreaker *DeploymentCircuitBreaker - // If a service is using the rolling update (ECS) deployment type, the + // If a service is using the rolling update ( ECS ) deployment type, the // maximumPercent parameter represents an upper limit on the number of your // service's tasks that are allowed in the RUNNING or PENDING state during a // deployment, as a percentage of the desiredCount (rounded down to the nearest // integer). This parameter enables you to define the deployment batch size. For // example, if your service is using the REPLICA service scheduler and has a - // desiredCount of four tasks and a maximumPercent value of 200%, the scheduler may - // start four new tasks before stopping the four older tasks (provided that the + // desiredCount of four tasks and a maximumPercent value of 200%, the scheduler + // may start four new tasks before stopping the four older tasks (provided that the // cluster resources required to do this are available). The default maximumPercent - // value for a service using the REPLICA service scheduler is 200%. If a service is - // using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks - // that use the EC2 launch type, the maximum percent value is set to the default - // value and is used to define the upper limit on the number of the tasks in the - // service that remain in the RUNNING state while the container instances are in - // the DRAINING state. If the tasks in the service use the Fargate launch type, the - // maximum percent value is not used, although it is returned when describing your - // service. + // value for a service using the REPLICA service scheduler is 200%. If a service + // is using either the blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types and + // tasks that use the EC2 launch type, the maximum percent value is set to the + // default value and is used to define the upper limit on the number of the tasks + // in the service that remain in the RUNNING state while the container instances + // are in the DRAINING state. If the tasks in the service use the Fargate launch + // type, the maximum percent value is not used, although it is returned when + // describing your service. MaximumPercent *int32 - // If a service is using the rolling update (ECS) deployment type, the + // If a service is using the rolling update ( ECS ) deployment type, the // minimumHealthyPercent represents a lower limit on the number of your service's - // tasks that must remain in the RUNNING state during a deployment, as a percentage - // of the desiredCount (rounded up to the nearest integer). This parameter enables - // you to deploy without using additional cluster capacity. For example, if your - // service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the - // service scheduler may stop two existing tasks to free up cluster capacity before - // starting two new tasks. For services that do not use a load balancer, the - // following should be noted: - // - // * A service is considered healthy if all essential - // containers within the tasks in the service pass their health checks. - // - // * If a - // task has no essential containers with a health check defined, the service - // scheduler will wait for 40 seconds after a task reaches a RUNNING state before - // the task is counted towards the minimum healthy percent total. - // - // * If a task has - // one or more essential containers with a health check defined, the service - // scheduler will wait for the task to reach a healthy status before counting it - // towards the minimum healthy percent total. A task is considered healthy when all - // essential containers within the task have passed their health checks. The amount - // of time the service scheduler can wait for is determined by the container health - // check settings. - // - // For services are that do use a load balancer, the following - // should be noted: - // - // * If a task has no essential containers with a health check - // defined, the service scheduler will wait for the load balancer target group - // health check to return a healthy status before counting the task towards the - // minimum healthy percent total. - // - // * If a task has an essential container with a - // health check defined, the service scheduler will wait for both the task to reach - // a healthy status and the load balancer target group health check to return a - // healthy status before counting the task towards the minimum healthy percent - // total. - // - // If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL + // tasks that must remain in the RUNNING state during a deployment, as a + // percentage of the desiredCount (rounded up to the nearest integer). This + // parameter enables you to deploy without using additional cluster capacity. For + // example, if your service has a desiredCount of four tasks and a + // minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks + // to free up cluster capacity before starting two new tasks. For services that do + // not use a load balancer, the following should be noted: + // - A service is considered healthy if all essential containers within the + // tasks in the service pass their health checks. + // - If a task has no essential containers with a health check defined, the + // service scheduler will wait for 40 seconds after a task reaches a RUNNING + // state before the task is counted towards the minimum healthy percent total. + // - If a task has one or more essential containers with a health check defined, + // the service scheduler will wait for the task to reach a healthy status before + // counting it towards the minimum healthy percent total. A task is considered + // healthy when all essential containers within the task have passed their health + // checks. The amount of time the service scheduler can wait for is determined by + // the container health check settings. + // For services are that do use a load balancer, the following should be noted: + // - If a task has no essential containers with a health check defined, the + // service scheduler will wait for the load balancer target group health check to + // return a healthy status before counting the task towards the minimum healthy + // percent total. + // - If a task has an essential container with a health check defined, the + // service scheduler will wait for both the task to reach a healthy status and the + // load balancer target group health check to return a healthy status before + // counting the task towards the minimum healthy percent total. + // If a service is using either the blue/green ( CODE_DEPLOY ) or EXTERNAL // deployment types and is running tasks that use the EC2 launch type, the minimum // healthy percent value is set to the default value and is used to define the // lower limit on the number of the tasks in the service that remain in the RUNNING // state while the container instances are in the DRAINING state. If a service is - // using either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and is + // using either the blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types and is // running tasks that use the Fargate launch type, the minimum healthy percent // value is not used, although it is returned when describing your service. MinimumHealthyPercent *int32 @@ -1687,21 +1513,20 @@ type DeploymentConfiguration struct { } // The deployment controller to use for the service. For more information, see -// Amazon ECS deployment types -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) +// Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // in the Amazon Elastic Container Service Developer Guide. type DeploymentController struct { // The deployment controller type to use. There are three deployment controller - // types available: ECS The rolling update (ECS) deployment type involves replacing - // the current running version of the container with the latest version. The number - // of containers Amazon ECS adds or removes from the service during a rolling - // update is controlled by adjusting the minimum and maximum number of healthy - // tasks allowed during a service deployment, as specified in the - // DeploymentConfiguration. CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment + // types available: ECS The rolling update ( ECS ) deployment type involves + // replacing the current running version of the container with the latest version. + // The number of containers Amazon ECS adds or removes from the service during a + // rolling update is controlled by adjusting the minimum and maximum number of + // healthy tasks allowed during a service deployment, as specified in the + // DeploymentConfiguration . CODE_DEPLOY The blue/green ( CODE_DEPLOY ) deployment // type uses the blue/green deployment model powered by CodeDeploy, which allows // you to verify a new deployment of a service before sending production traffic to - // it. EXTERNAL The external (EXTERNAL) deployment type enables you to use any + // it. EXTERNAL The external ( EXTERNAL ) deployment type enables you to use any // third-party deployment controller for full control over the deployment process // for an Amazon ECS service. // @@ -1722,20 +1547,22 @@ type Device struct { // The path inside the container at which to expose the host device. ContainerPath *string - // The explicit permissions to provide to the container for the device. By default, - // the container has permissions for read, write, and mknod for the device. + // The explicit permissions to provide to the container for the device. By + // default, the container has permissions for read , write , and mknod for the + // device. Permissions []DeviceCgroupPermission noSmithyDocumentSerde } -// This parameter is specified when you're using Docker volumes. Docker volumes are -// only supported when you're using the EC2 launch type. Windows containers only -// support the use of the local driver. To use bind mounts, specify a host instead. +// This parameter is specified when you're using Docker volumes. Docker volumes +// are only supported when you're using the EC2 launch type. Windows containers +// only support the use of the local driver. To use bind mounts, specify a host +// instead. type DockerVolumeConfiguration struct { - // If this value is true, the Docker volume is created if it doesn't already exist. - // This field is only used if the scope is shared. + // If this value is true , the Docker volume is created if it doesn't already + // exist. This field is only used if the scope is shared . Autoprovision *bool // The Docker volume driver to use. The driver value must match the driver name @@ -1743,35 +1570,31 @@ type DockerVolumeConfiguration struct { // installed using the Docker plugin CLI, use docker plugin ls to retrieve the // driver name from your container instance. If the driver was installed using // another method, use Docker plugin discovery to retrieve the driver name. For - // more information, see Docker plugin discovery - // (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This - // parameter maps to Driver in the Create a volume - // (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // xxdriver option to docker volume create - // (https://docs.docker.com/engine/reference/commandline/volume_create/). + // more information, see Docker plugin discovery (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery) + // . This parameter maps to Driver in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the xxdriver option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/) + // . Driver *string // A map of Docker driver-specific options passed through. This parameter maps to - // DriverOpts in the Create a volume - // (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the xxopt - // option to docker volume create - // (https://docs.docker.com/engine/reference/commandline/volume_create/). + // DriverOpts in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the xxopt option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/) + // . DriverOpts map[string]string // Custom metadata to add to your Docker volume. This parameter maps to Labels in - // the Create a volume - // (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // xxlabel option to docker volume create - // (https://docs.docker.com/engine/reference/commandline/volume_create/). + // the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the xxlabel option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/) + // . Labels map[string]string // The scope for the Docker volume that determines its lifecycle. Docker volumes - // that are scoped to a task are automatically provisioned when the task starts and - // destroyed when the task stops. Docker volumes that are scoped as shared persist - // after the task stops. + // that are scoped to a task are automatically provisioned when the task starts + // and destroyed when the task stops. Docker volumes that are scoped as shared + // persist after the task stops. Scope Scope noSmithyDocumentSerde @@ -1780,30 +1603,28 @@ type DockerVolumeConfiguration struct { // The authorization configuration details for the Amazon EFS file system. type EFSAuthorizationConfig struct { - // The Amazon EFS access point ID to use. If an access point is specified, the root - // directory value specified in the EFSVolumeConfiguration must either be omitted - // or set to / which will enforce the path set on the EFS access point. If an - // access point is used, transit encryption must be enabled in the - // EFSVolumeConfiguration. For more information, see Working with Amazon EFS access - // points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the - // Amazon Elastic File System User Guide. + // The Amazon EFS access point ID to use. If an access point is specified, the + // root directory value specified in the EFSVolumeConfiguration must either be + // omitted or set to / which will enforce the path set on the EFS access point. If + // an access point is used, transit encryption must be enabled in the + // EFSVolumeConfiguration . For more information, see Working with Amazon EFS + // access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) + // in the Amazon Elastic File System User Guide. AccessPointId *string // Determines whether to use the Amazon ECS task role defined in a task definition // when mounting the Amazon EFS file system. If enabled, transit encryption must be - // enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default - // value of DISABLED is used. For more information, see Using Amazon EFS access - // points - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) + // enabled in the EFSVolumeConfiguration . If this parameter is omitted, the + // default value of DISABLED is used. For more information, see Using Amazon EFS + // access points (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) // in the Amazon Elastic Container Service Developer Guide. Iam EFSAuthorizationConfigIAM noSmithyDocumentSerde } -// This parameter is specified when you're using an Amazon Elastic File System file -// system for task storage. For more information, see Amazon EFS volumes -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) +// This parameter is specified when you're using an Amazon Elastic File System +// file system for task storage. For more information, see Amazon EFS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) // in the Amazon Elastic Container Service Developer Guide. type EFSVolumeConfiguration struct { @@ -1817,55 +1638,48 @@ type EFSVolumeConfiguration struct { // The directory within the Amazon EFS file system to mount as the root directory // inside the host. If this parameter is omitted, the root of the Amazon EFS volume - // will be used. Specifying / will have the same effect as omitting this parameter. - // If an EFS access point is specified in the authorizationConfig, the root - // directory parameter must either be omitted or set to / which will enforce the - // path set on the EFS access point. + // will be used. Specifying / will have the same effect as omitting this + // parameter. If an EFS access point is specified in the authorizationConfig , the + // root directory parameter must either be omitted or set to / which will enforce + // the path set on the EFS access point. RootDirectory *string // Determines whether to use encryption for Amazon EFS data in transit between the // Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if // Amazon EFS IAM authorization is used. If this parameter is omitted, the default - // value of DISABLED is used. For more information, see Encrypting data in transit - // (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the - // Amazon Elastic File System User Guide. + // value of DISABLED is used. For more information, see Encrypting data in transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) + // in the Amazon Elastic File System User Guide. TransitEncryption EFSTransitEncryption // The port to use when sending encrypted data between the Amazon ECS host and the // Amazon EFS server. If you do not specify a transit encryption port, it will use // the port selection strategy that the Amazon EFS mount helper uses. For more - // information, see EFS mount helper - // (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the Amazon - // Elastic File System User Guide. + // information, see EFS mount helper (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) + // in the Amazon Elastic File System User Guide. TransitEncryptionPort *int32 noSmithyDocumentSerde } -// A list of files containing the environment variables to pass to a container. You -// can specify up to ten environment files. The file must have a .env file +// A list of files containing the environment variables to pass to a container. +// You can specify up to ten environment files. The file must have a .env file // extension. Each line in an environment file should contain an environment // variable in VARIABLE=VALUE format. Lines beginning with # are treated as // comments and are ignored. For more information about the environment variable -// file syntax, see Declare default environment variables in file -// (https://docs.docker.com/compose/env-file/). If there are environment variables -// specified using the environment parameter in a container definition, they take -// precedence over the variables contained within an environment file. If multiple -// environment files are specified that contain the same variable, they're -// processed from the top down. We recommend that you use unique variable names. -// For more information, see Specifying environment variables -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) +// file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/) +// . If there are environment variables specified using the environment parameter +// in a container definition, they take precedence over the variables contained +// within an environment file. If multiple environment files are specified that +// contain the same variable, they're processed from the top down. We recommend +// that you use unique variable names. For more information, see Specifying +// environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. This parameter is only // supported for tasks hosted on Fargate using the following platform versions: -// -// * -// Linux platform version 1.4.0 or later. -// -// * Windows platform version 1.0.0 or -// later. +// - Linux platform version 1.4.0 or later. +// - Windows platform version 1.0.0 or later. type EnvironmentFile struct { - // The file type to use. The only supported value is s3. + // The file type to use. The only supported value is s3 . // // This member is required. Type EnvironmentFileType @@ -1879,11 +1693,10 @@ type EnvironmentFile struct { noSmithyDocumentSerde } -// The amount of ephemeral storage to allocate for the task. This parameter is used -// to expand the total amount of ephemeral storage available, beyond the default -// amount, for tasks hosted on Fargate. For more information, see Fargate task -// storage -// (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) +// The amount of ephemeral storage to allocate for the task. This parameter is +// used to expand the total amount of ephemeral storage available, beyond the +// default amount, for tasks hosted on Fargate. For more information, see Fargate +// task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) // in the Amazon ECS User Guide for Fargate. This parameter is only supported for // tasks hosted on Fargate using Linux platform version 1.4.0 or later. This // parameter is not supported for Windows containers on Fargate. @@ -1912,17 +1725,12 @@ type ExecuteCommandConfiguration struct { // The log setting to use for redirecting logs for your execute command results. // The following log settings are available. - // - // * NONE: The execute command session - // is not logged. - // - // * DEFAULT: The awslogs configuration in the task definition is - // used. If no logging parameter is specified, it defaults to this value. If no - // awslogs log driver is configured in the task definition, the output won't be - // logged. - // - // * OVERRIDE: Specify the logging details as a part of logConfiguration. - // If the OVERRIDE logging option is specified, the logConfiguration is required. + // - NONE : The execute command session is not logged. + // - DEFAULT : The awslogs configuration in the task definition is used. If no + // logging parameter is specified, it defaults to this value. If no awslogs log + // driver is configured in the task definition, the output won't be logged. + // - OVERRIDE : Specify the logging details as a part of logConfiguration . If + // the OVERRIDE logging option is specified, the logConfiguration is required. Logging ExecuteCommandLogging noSmithyDocumentSerde @@ -1954,8 +1762,7 @@ type ExecuteCommandLogConfiguration struct { noSmithyDocumentSerde } -// A failed resource. For a list of common causes, see API failure reasons -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) +// A failed resource. For a list of common causes, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) // in the Amazon Elastic Container Service Developer Guide. type Failure struct { @@ -1973,12 +1780,11 @@ type Failure struct { // The FireLens configuration for the container. This is used to specify and // configure a log router for container logs. For more information, see Custom log -// routing -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) +// routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) // in the Amazon Elastic Container Service Developer Guide. type FirelensConfiguration struct { - // The log router to use. The valid values are fluentd or fluentbit. + // The log router to use. The valid values are fluentd or fluentbit . // // This member is required. Type FirelensConfigurationType @@ -1987,10 +1793,9 @@ type FirelensConfiguration struct { // can be used to specify a custom configuration file or to add additional // metadata, such as the task, task definition, cluster, and container instance // details to the log event. If specified, the syntax to use is - // "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. - // For more information, see Creating a task definition that uses a FireLens - // configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef) + // "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"} + // . For more information, see Creating a task definition that uses a FireLens + // configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef) // in the Amazon Elastic Container Service Developer Guide. Tasks hosted on Fargate // only support the file configuration file type. Options map[string]string @@ -1999,24 +1804,21 @@ type FirelensConfiguration struct { } // The authorization configuration details for Amazon FSx for Windows File Server -// file system. See FSxWindowsFileServerVolumeConfiguration -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) +// file system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) // in the Amazon ECS API Reference. For more information and the input format, see -// Amazon FSx for Windows File Server Volumes -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) +// Amazon FSx for Windows File Server Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) // in the Amazon Elastic Container Service Developer Guide. type FSxWindowsFileServerAuthorizationConfig struct { - // The authorization credential option to use. The authorization credential options - // can be provided using either the Amazon Resource Name (ARN) of an Secrets - // Manager secret or SSM Parameter Store parameter. The ARN refers to the stored - // credentials. + // The authorization credential option to use. The authorization credential + // options can be provided using either the Amazon Resource Name (ARN) of an + // Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the + // stored credentials. // // This member is required. CredentialsParameter *string - // A fully qualified domain name hosted by an Directory Service - // (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) + // A fully qualified domain name hosted by an Directory Service (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) // Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2. // // This member is required. @@ -2025,11 +1827,9 @@ type FSxWindowsFileServerAuthorizationConfig struct { noSmithyDocumentSerde } -// This parameter is specified when you're using Amazon FSx for Windows File Server -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system -// for task storage. For more information and the input format, see Amazon FSx for -// Windows File Server volumes -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) +// This parameter is specified when you're using Amazon FSx for Windows File Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) +// file system for task storage. For more information and the input format, see +// Amazon FSx for Windows File Server volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) // in the Amazon Elastic Container Service Developer Guide. type FSxWindowsFileServerVolumeConfiguration struct { @@ -2044,8 +1844,8 @@ type FSxWindowsFileServerVolumeConfiguration struct { // This member is required. FileSystemId *string - // The directory within the Amazon FSx for Windows File Server file system to mount - // as the root directory inside the host. + // The directory within the Amazon FSx for Windows File Server file system to + // mount as the root directory inside the host. // // This member is required. RootDirectory *string @@ -2056,8 +1856,8 @@ type FSxWindowsFileServerVolumeConfiguration struct { // An object representing a container health check. Health check parameters that // are specified in a container definition override any Docker health checks that // exist in the container image (such as those specified in a parent image or from -// the image's Dockerfile). This configuration maps to the HEALTHCHECK parameter of -// docker run (https://docs.docker.com/engine/reference/run/). The Amazon ECS +// the image's Dockerfile). This configuration maps to the HEALTHCHECK parameter +// of docker run (https://docs.docker.com/engine/reference/run/) . The Amazon ECS // container agent only monitors and reports on the health checks specified in the // task definition. Amazon ECS does not monitor Docker health checks that are // embedded in a container image and not specified in the container definition. @@ -2066,65 +1866,49 @@ type FSxWindowsFileServerVolumeConfiguration struct { // health status of both individual containers and a task with the DescribeTasks // API operation or when viewing the task details in the console. The following // describes the possible healthStatus values for a container: +// - HEALTHY -The container health check has passed successfully. +// - UNHEALTHY -The container health check has failed. +// - UNKNOWN -The container health check is being evaluated or there's no +// container health check defined. // -// * HEALTHY-The -// container health check has passed successfully. -// -// * UNHEALTHY-The container -// health check has failed. -// -// * UNKNOWN-The container health check is being -// evaluated or there's no container health check defined. -// -// The following describes -// the possible healthStatus values for a task. The container health check status -// of non-essential containers don't have an effect on the health status of a -// task. -// -// * HEALTHY-All essential containers within the task have passed their -// health checks. +// The following describes the possible healthStatus values for a task. The +// container health check status of non-essential containers don't have an effect +// on the health status of a task. +// - HEALTHY -All essential containers within the task have passed their health +// checks. +// - UNHEALTHY -One or more essential containers have failed their health check. +// - UNKNOWN -The essential containers within the task are still having their +// health checks evaluated, there are only nonessential containers with health +// checks defined, or there are no container health checks defined. // -// * UNHEALTHY-One or more essential containers have failed their -// health check. -// -// * UNKNOWN-The essential containers within the task are still -// having their health checks evaluated, there are only nonessential containers -// with health checks defined, or there are no container health checks defined. -// -// If -// a task is run manually, and not as part of a service, the task will continue its -// lifecycle regardless of its health status. For tasks that are part of a service, -// if the task reports as unhealthy then the task will be stopped and the service -// scheduler will replace it. The following are notes about container health check -// support: -// -// * Container health checks require version 1.17.0 or greater of the -// Amazon ECS container agent. For more information, see Updating the Amazon ECS -// container agent -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). -// -// * -// Container health checks are supported for Fargate tasks if you're using platform -// version 1.1.0 or greater. For more information, see Fargate platform versions -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). -// -// * -// Container health checks aren't supported for tasks that are part of a service -// that's configured to use a Classic Load Balancer. +// If a task is run manually, and not as part of a service, the task will continue +// its lifecycle regardless of its health status. For tasks that are part of a +// service, if the task reports as unhealthy then the task will be stopped and the +// service scheduler will replace it. The following are notes about container +// health check support: +// - Container health checks require version 1.17.0 or greater of the Amazon ECS +// container agent. For more information, see Updating the Amazon ECS container +// agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) +// . +// - Container health checks are supported for Fargate tasks if you're using +// platform version 1.1.0 or greater. For more information, see Fargate platform +// versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) +// . +// - Container health checks aren't supported for tasks that are part of a +// service that's configured to use a Classic Load Balancer. type HealthCheck struct { // A string array representing the command that the container runs to determine if - // it is healthy. The string array must start with CMD to run the command arguments - // directly, or CMD-SHELL to run the command with the container's default shell. - // When you use the Amazon Web Services Management Console JSON panel, the Command - // Line Interface, or the APIs, enclose the list of commands in double quotes and - // brackets. [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] You don't - // include the double quotes and brackets when you use the Amazon Web Services - // Management Console. CMD-SHELL, curl -f http://localhost/ || exit 1 An exit code - // of 0 indicates success, and non-zero exit code indicates failure. For more - // information, see HealthCheck in the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/). + // it is healthy. The string array must start with CMD to run the command + // arguments directly, or CMD-SHELL to run the command with the container's + // default shell. When you use the Amazon Web Services Management Console JSON + // panel, the Command Line Interface, or the APIs, enclose the list of commands in + // double quotes and brackets. [ "CMD-SHELL", "curl -f http://localhost/ || exit + // 1" ] You don't include the double quotes and brackets when you use the Amazon + // Web Services Management Console. CMD-SHELL, curl -f http://localhost/ || exit 1 + // An exit code of 0 indicates success, and non-zero exit code indicates failure. + // For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) . // // This member is required. Command []string @@ -2140,9 +1924,9 @@ type HealthCheck struct { // The optional grace period to provide containers time to bootstrap before failed // health checks count towards the maximum number of retries. You can specify - // between 0 and 300 seconds. By default, the startPeriod is off. If a health check - // succeeds within the startPeriod, then the container is considered healthy and - // any subsequent failures count toward the maximum number of retries. + // between 0 and 300 seconds. By default, the startPeriod is off. If a health + // check succeeds within the startPeriod , then the container is considered healthy + // and any subsequent failures count toward the maximum number of retries. StartPeriod *int32 // The time period in seconds to wait for a health check to succeed before it is @@ -2154,7 +1938,7 @@ type HealthCheck struct { } // Hostnames and IP address entries that are added to the /etc/hosts file of a -// container via the extraHosts parameter of its ContainerDefinition. +// container via the extraHosts parameter of its ContainerDefinition . type HostEntry struct { // The hostname to use in the /etc/hosts entry. @@ -2173,9 +1957,9 @@ type HostEntry struct { // Details on a container instance bind mount host volume. type HostVolumeProperties struct { - // When the host parameter is used, specify a sourcePath to declare the path on the - // host container instance that's presented to the container. If this parameter is - // empty, then the Docker daemon has assigned a host path for you. If the host + // When the host parameter is used, specify a sourcePath to declare the path on + // the host container instance that's presented to the container. If this parameter + // is empty, then the Docker daemon has assigned a host path for you. If the host // parameter contains a sourcePath file location, then the data volume persists at // the specified location on the host container instance until you delete it // manually. If the sourcePath value doesn't exist on the host container instance, @@ -2188,14 +1972,13 @@ type HostVolumeProperties struct { } // Details on an Elastic Inference accelerator. For more information, see Working -// with Amazon Elastic Inference on Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) +// with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) // in the Amazon Elastic Container Service Developer Guide. type InferenceAccelerator struct { // The Elastic Inference accelerator device name. The deviceName must also be - // referenced in a container definition as a ResourceRequirement - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html). + // referenced in a container definition as a ResourceRequirement (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html) + // . // // This member is required. DeviceName *string @@ -2211,8 +1994,7 @@ type InferenceAccelerator struct { // Details on an Elastic Inference accelerator task override. This parameter is // used to override the Elastic Inference accelerator specified in the task // definition. For more information, see Working with Amazon Elastic Inference on -// Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) +// Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) // in the Amazon Elastic Container Service Developer Guide. type InferenceAcceleratorOverride struct { @@ -2248,39 +2030,36 @@ type InstanceHealthCheckResult struct { // The Linux capabilities for the container that are added to or dropped from the // default configuration provided by Docker. For more information about the default // capabilities and the non-default available capabilities, see Runtime privilege -// and Linux capabilities -// (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) +// and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) // in the Docker run reference. For more detailed information about these Linux -// capabilities, see the capabilities(7) -// (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. +// capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) +// Linux manual page. type KernelCapabilities struct { // The Linux capabilities for the container that have been added to the default // configuration provided by Docker. This parameter maps to CapAdd in the Create a // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the --cap-add option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). Tasks - // launched on Fargate only support adding the SYS_PTRACE kernel capability. Valid - // values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | - // "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | - // "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | - // "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | - // "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | - // "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | - // "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | - // "SYSLOG" | "WAKE_ALARM" + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Tasks launched on Fargate only support adding the SYS_PTRACE kernel + // capability. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | + // "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | + // "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | + // "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | + // "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | + // "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | + // "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | + // "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM" Add []string - // The Linux capabilities for the container that have been removed from the default - // configuration provided by Docker. This parameter maps to CapDrop in the Create a - // container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) - // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and - // the --cap-drop option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). Valid - // values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | - // "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | - // "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | + // The Linux capabilities for the container that have been removed from the + // default configuration provided by Docker. This parameter maps to CapDrop in the + // Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | + // "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" + // | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | // "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | // "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | // "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | @@ -2298,16 +2077,16 @@ type KeyValuePair struct { // the environment variable. Name *string - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. Value *string noSmithyDocumentSerde } // The Linux-specific options that are applied to the container, such as Linux -// KernelCapabilities -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). +// KernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) +// . type LinuxParameters struct { // The Linux capabilities for the container that are added to or dropped from the @@ -2317,78 +2096,70 @@ type LinuxParameters struct { Capabilities *KernelCapabilities // Any host devices to expose to the container. This parameter maps to Devices in - // the Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --device option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If - // you're using tasks that use the Fargate launch type, the devices parameter isn't - // supported. + // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --device option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If you're using tasks that use the Fargate launch type, the devices parameter + // isn't supported. Devices []Device // Run an init process inside the container that forwards signals and reaps - // processes. This parameter maps to the --init option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). This - // parameter requires version 1.25 of the Docker Remote API or greater on your - // container instance. To check the Docker Remote API version on your container - // instance, log in to your container instance and run the following command: sudo - // docker version --format '{{.Server.APIVersion}}' + // processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . This parameter requires version 1.25 of the Docker Remote API or greater on + // your container instance. To check the Docker Remote API version on your + // container instance, log in to your container instance and run the following + // command: sudo docker version --format '{{.Server.APIVersion}}' InitProcessEnabled *bool // The total amount of swap memory (in MiB) a container can use. This parameter - // will be translated to the --memory-swap option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration) where the - // value would be the sum of the container memory plus the maxSwap value. If a - // maxSwap value of 0 is specified, the container will not use swap. Accepted - // values are 0 or any positive integer. If the maxSwap parameter is omitted, the - // container will use the swap configuration for the container instance it is - // running on. A maxSwap value must be set for the swappiness parameter to be used. - // If you're using tasks that use the Fargate launch type, the maxSwap parameter - // isn't supported. + // will be translated to the --memory-swap option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // where the value would be the sum of the container memory plus the maxSwap + // value. If a maxSwap value of 0 is specified, the container will not use swap. + // Accepted values are 0 or any positive integer. If the maxSwap parameter is + // omitted, the container will use the swap configuration for the container + // instance it is running on. A maxSwap value must be set for the swappiness + // parameter to be used. If you're using tasks that use the Fargate launch type, + // the maxSwap parameter isn't supported. MaxSwap *int32 // The value for the size (in MiB) of the /dev/shm volume. This parameter maps to - // the --shm-size option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If you - // are using tasks that use the Fargate launch type, the sharedMemorySize parameter - // is not supported. + // the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If you are using tasks that use the Fargate launch type, the sharedMemorySize + // parameter is not supported. SharedMemorySize *int32 // This allows you to tune a container's memory swappiness behavior. A swappiness // value of 0 will cause swapping to not happen unless absolutely necessary. A // swappiness value of 100 will cause pages to be swapped very aggressively. - // Accepted values are whole numbers between 0 and 100. If the swappiness parameter - // is not specified, a default value of 60 is used. If a value is not specified for - // maxSwap then this parameter is ignored. This parameter maps to the - // --memory-swappiness option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If - // you're using tasks that use the Fargate launch type, the swappiness parameter - // isn't supported. + // Accepted values are whole numbers between 0 and 100 . If the swappiness + // parameter is not specified, a default value of 60 is used. If a value is not + // specified for maxSwap then this parameter is ignored. This parameter maps to + // the --memory-swappiness option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If you're using tasks that use the Fargate launch type, the swappiness + // parameter isn't supported. Swappiness *int32 // The container path, mount options, and size (in MiB) of the tmpfs mount. This - // parameter maps to the --tmpfs option to docker run - // (https://docs.docker.com/engine/reference/run/#security-configuration). If - // you're using tasks that use the Fargate launch type, the tmpfs parameter isn't - // supported. + // parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) + // . If you're using tasks that use the Fargate launch type, the tmpfs parameter + // isn't supported. Tmpfs []Tmpfs noSmithyDocumentSerde } -// The load balancer configuration to use with a service or task set. When you add, -// update, or remove a load balancer configuration, Amazon ECS starts a new +// The load balancer configuration to use with a service or task set. When you +// add, update, or remove a load balancer configuration, Amazon ECS starts a new // deployment with the updated Elastic Load Balancing configuration. This causes // tasks to register to and deregister from load balancers. We recommend that you // verify this on a test environment before you update the Elastic Load Balancing // configuration. A service-linked role is required for services that use multiple -// target groups. For more information, see Using service-linked roles -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) +// target groups. For more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. type LoadBalancer struct { - // The name of the container (as it appears in a container definition) to associate - // with the load balancer. + // The name of the container (as it appears in a container definition) to + // associate with the load balancer. ContainerName *string // The port on the container to associate with the load balancer. This port must @@ -2410,70 +2181,57 @@ type LoadBalancer struct { // you're using a Classic Load Balancer, omit the target group ARN. For services // using the ECS deployment controller, you can specify one or multiple target // groups. For more information, see Registering multiple target groups with a - // service - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) + // service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) // in the Amazon Elastic Container Service Developer Guide. For services using the // CODE_DEPLOY deployment controller, you're required to define two target groups // for the load balancer. For more information, see Blue/green deployment with - // CodeDeploy - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) + // CodeDeploy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) // in the Amazon Elastic Container Service Developer Guide. If your service's task // definition uses the awsvpc network mode, you must choose ip as the target type, - // not instance. Do this when creating your target groups because tasks that use - // the awsvpc network mode are associated with an elastic network interface, not an - // Amazon EC2 instance. This network mode is required for the Fargate launch type. + // not instance . Do this when creating your target groups because tasks that use + // the awsvpc network mode are associated with an elastic network interface, not + // an Amazon EC2 instance. This network mode is required for the Fargate launch + // type. TargetGroupArn *string noSmithyDocumentSerde } -// The log configuration for the container. This parameter maps to LogConfig in the -// Create a container -// (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of -// the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the -// --log-driver option to docker run -// (https://docs.docker.com/engine/reference/commandline/run/). By default, -// containers use the same logging driver that the Docker daemon uses. However, the -// container might use a different logging driver than the Docker daemon by -// specifying a log driver configuration in the container definition. For more -// information about the options for different supported log drivers, see Configure -// logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the -// Docker documentation. Understand the following when specifying a log +// The log configuration for the container. This parameter maps to LogConfig in +// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) +// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) +// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/) +// . By default, containers use the same logging driver that the Docker daemon +// uses. However, the container might use a different logging driver than the +// Docker daemon by specifying a log driver configuration in the container +// definition. For more information about the options for different supported log +// drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) +// in the Docker documentation. Understand the following when specifying a log // configuration for your containers. -// -// * Amazon ECS currently supports a subset of -// the logging drivers available to the Docker daemon (shown in the valid values -// below). Additional log drivers may be available in future releases of the Amazon -// ECS container agent. -// -// * This parameter requires version 1.18 of the Docker -// Remote API or greater on your container instance. -// -// * For tasks that are hosted -// on Amazon EC2 instances, the Amazon ECS container agent must register the -// available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment -// variable before containers placed on that instance can use these log -// configuration options. For more information, see Amazon ECS container agent -// configuration -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) -// in the Amazon Elastic Container Service Developer Guide. -// -// * For tasks that are -// on Fargate, because you don't have access to the underlying infrastructure your -// tasks are hosted on, any additional software needed must be installed outside of -// the task. For example, the Fluentd output aggregators or a remote host running -// Logstash to send Gelf logs to. +// - Amazon ECS currently supports a subset of the logging drivers available to +// the Docker daemon (shown in the valid values below). Additional log drivers may +// be available in future releases of the Amazon ECS container agent. +// - This parameter requires version 1.18 of the Docker Remote API or greater on +// your container instance. +// - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container +// agent must register the available logging drivers with the +// ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on +// that instance can use these log configuration options. For more information, see +// Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) +// in the Amazon Elastic Container Service Developer Guide. +// - For tasks that are on Fargate, because you don't have access to the +// underlying infrastructure your tasks are hosted on, any additional software +// needed must be installed outside of the task. For example, the Fluentd output +// aggregators or a remote host running Logstash to send Gelf logs to. type LogConfiguration struct { - // The log driver to use for the container. For tasks on Fargate, the supported log - // drivers are awslogs, splunk, and awsfirelens. For tasks hosted on Amazon EC2 - // instances, the supported log drivers are awslogs, fluentd, gelf, json-file, - // journald, logentries,syslog, splunk, and awsfirelens. For more information about - // using the awslogs log driver, see Using the awslogs log driver - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) + // The log driver to use for the container. For tasks on Fargate, the supported + // log drivers are awslogs , splunk , and awsfirelens . For tasks hosted on Amazon + // EC2 instances, the supported log drivers are awslogs , fluentd , gelf , + // json-file , journald , logentries , syslog , splunk , and awsfirelens . For more + // information about using the awslogs log driver, see Using the awslogs log driver (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) // in the Amazon Elastic Container Service Developer Guide. For more information - // about using the awsfirelens log driver, see Custom log routing - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) + // about using the awsfirelens log driver, see Custom log routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) // in the Amazon Elastic Container Service Developer Guide. If you have a custom // driver that isn't listed, you can fork the Amazon ECS container agent project // that's available on GitHub (https://github.com/aws/amazon-ecs-agent) and @@ -2492,8 +2250,7 @@ type LogConfiguration struct { Options map[string]string // The secrets to pass to the log configuration. For more information, see - // Specifying sensitive data - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) + // Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) // in the Amazon Elastic Container Service Developer Guide. SecretOptions []Secret @@ -2510,7 +2267,7 @@ type ManagedAgent struct { LastStatus *string // The name of the managed agent. When the execute command feature is enabled, the - // managed agent name is ExecuteCommandAgent. + // managed agent name is ExecuteCommandAgent . Name ManagedAgentName // The reason for why the managed agent is in the state it is in. @@ -2548,8 +2305,7 @@ type ManagedAgentStateChange struct { // actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling // policy using an Amazon ECS managed CloudWatch metric with the specified // targetCapacity value as the target value for the metric. For more information, -// see Using managed scaling -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) +// see Using managed scaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling) // in the Amazon Elastic Container Service Developer Guide. If managed scaling is // off, the user must manage the scaling of the Auto Scaling group. type ManagedScaling struct { @@ -2559,15 +2315,15 @@ type ManagedScaling struct { // omitted, the default value of 300 seconds is used. InstanceWarmupPeriod *int32 - // The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one - // time. The scale in process is not affected by this parameter. If this parameter - // is omitted, the default value of 1 is used. + // The maximum number of Amazon EC2 instances that Amazon ECS will scale out at + // one time. The scale in process is not affected by this parameter. If this + // parameter is omitted, the default value of 1 is used. MaximumScalingStepSize *int32 - // The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one - // time. The scale in process is not affected by this parameter If this parameter - // is omitted, the default value of 1 is used. When additional capacity is - // required, Amazon ECS will scale up the minimum scaling step size even if the + // The minimum number of Amazon EC2 instances that Amazon ECS will scale out at + // one time. The scale in process is not affected by this parameter If this + // parameter is omitted, the default value of 1 is used. When additional capacity + // is required, Amazon ECS will scale up the minimum scaling step size even if the // actual demand is less than the minimum scaling step size. If you use a capacity // provider with an Auto Scaling group configured with more than one Amazon EC2 // instance type or Availability Zone, Amazon ECS will scale up by the exact @@ -2579,9 +2335,9 @@ type ManagedScaling struct { Status ManagedScalingStatus // The target capacity utilization as a percentage for the capacity provider. The - // specified value must be greater than 0 and less than or equal to 100. For + // specified value must be greater than 0 and less than or equal to 100 . For // example, if you want the capacity provider to maintain 10% spare capacity, then - // that means the utilization is 90%, so use a targetCapacity of 90. The default + // that means the utilization is 90%, so use a targetCapacity of 90 . The default // value of 100 percent results in the Amazon EC2 instances in your Auto Scaling // group being completely used. TargetCapacity *int32 @@ -2595,21 +2351,21 @@ type MountPoint struct { // The path on the container to mount the host volume at. ContainerPath *string - // If this value is true, the container has read-only access to the volume. If this - // value is false, then the container can write to the volume. The default value is - // false. + // If this value is true , the container has read-only access to the volume. If + // this value is false , then the container can write to the volume. The default + // value is false . ReadOnly *bool // The name of the volume to mount. Must be a volume name referenced in the name - // parameter of task definition volume. + // parameter of task definition volume . SourceVolume *string noSmithyDocumentSerde } // Details on the network bindings between a container and its host container -// instance. After a task reaches the RUNNING status, manual and automatic host and -// container port assignments are visible in the networkBindings section of +// instance. After a task reaches the RUNNING status, manual and automatic host +// and container port assignments are visible in the networkBindings section of // DescribeTasks API responses. type NetworkBinding struct { @@ -2620,58 +2376,33 @@ type NetworkBinding struct { ContainerPort *int32 // The port number range on the container that's bound to the dynamically mapped - // host port range. The following rules apply when you specify a - // containerPortRange: - // - // * You must use either the bridge network mode or the awsvpc - // network mode. - // - // * This parameter is available for both the EC2 and Fargate launch - // types. - // - // * This parameter is available for both the Linux and Windows operating - // systems. - // - // * The container instance must have at least version 1.67.0 of the - // container agent and at least version 1.67.0-1 of the ecs-init package - // - // * You can - // specify a maximum of 100 port ranges per container. - // - // * You do not specify a - // hostPortRange. The value of the hostPortRange is set as follows: - // - // * For - // containers in a task with the awsvpc network mode, the hostPort is set to the - // same value as the containerPort. This is a static mapping strategy. - // - // * For - // containers in a task with the bridge network mode, the Amazon ECS agent finds - // open host ports from the default ephemeral range and passes it to docker to bind - // them to the container ports. - // - // * The containerPortRange valid values are between - // 1 and 65535. - // - // * A port can only be included in one port mapping per - // container. - // - // * You cannot specify overlapping port ranges. - // - // * The first port in - // the range must be less than last port in the range. - // - // * Docker recommends that - // you turn off the docker-proxy in the Docker daemon config file when you have a - // large number of ports. For more information, see Issue #11185 - // (https://github.com/moby/moby/issues/11185) on the Github website. For - // information about how to turn off the docker-proxy in the Docker daemon config - // file, see Docker daemon - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) - // in the Amazon ECS Developer Guide. - // - // You can call DescribeTasks - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) + // host port range. The following rules apply when you specify a containerPortRange + // : + // - You must use either the bridge network mode or the awsvpc network mode. + // - This parameter is available for both the EC2 and Fargate launch types. + // - This parameter is available for both the Linux and Windows operating + // systems. + // - The container instance must have at least version 1.67.0 of the container + // agent and at least version 1.67.0-1 of the ecs-init package + // - You can specify a maximum of 100 port ranges per container. + // - You do not specify a hostPortRange . The value of the hostPortRange is set + // as follows: + // - For containers in a task with the awsvpc network mode, the hostPort is set + // to the same value as the containerPort . This is a static mapping strategy. + // - For containers in a task with the bridge network mode, the Amazon ECS agent + // finds open host ports from the default ephemeral range and passes it to docker + // to bind them to the container ports. + // - The containerPortRange valid values are between 1 and 65535. + // - A port can only be included in one port mapping per container. + // - You cannot specify overlapping port ranges. + // - The first port in the range must be less than last port in the range. + // - Docker recommends that you turn off the docker-proxy in the Docker daemon + // config file when you have a large number of ports. For more information, see + // Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github + // website. For information about how to turn off the docker-proxy in the Docker + // daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) + // in the Amazon ECS Developer Guide. + // You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) // to view the hostPortRange which are the host ports that are bound to the // container ports. ContainerPortRange *string @@ -2715,18 +2446,16 @@ type NetworkInterface struct { noSmithyDocumentSerde } -// An object representing a constraint on task placement. For more information, see -// Task placement constraints -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// An object representing a constraint on task placement. For more information, +// see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. If you're using the // Fargate launch type, task placement constraints aren't supported. type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. The expression // can have a maximum length of 2000 characters. You can't specify an expression if - // the constraint type is distinctInstance. For more information, see Cluster query - // language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // the constraint type is distinctInstance . For more information, see Cluster + // query language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string @@ -2739,17 +2468,16 @@ type PlacementConstraint struct { } // The task placement strategy for a task or service. For more information, see -// Task placement strategies -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// Task placement strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) // in the Amazon Elastic Container Service Developer Guide. type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement - // strategy, valid values are instanceId (or host, which has the same effect), or + // strategy, valid values are instanceId (or host , which has the same effect), or // any platform or custom attribute that's applied to a container instance, such as - // attribute:ecs.availability-zone. For the binpack placement strategy, valid - // values are cpu and memory. For the random placement strategy, this field is not - // used. + // attribute:ecs.availability-zone . For the binpack placement strategy, valid + // values are cpu and memory . For the random placement strategy, this field is + // not used. Field *string // The type of placement strategy. The random placement strategy randomly places @@ -2768,15 +2496,15 @@ type PlacementStrategy struct { // device type is a GPU. type PlatformDevice struct { - // The ID for the GPUs on the container instance. The available GPU IDs can also be - // obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json - // file. + // The ID for the GPUs on the container instance. The available GPU IDs can also + // be obtained on the container instance in the + // /var/lib/ecs/gpu/nvidia_gpu_info.json file. // // This member is required. Id *string // The type of device that's available on the container instance. The only - // supported value is GPU. + // supported value is GPU . // // This member is required. Type PlatformDeviceType @@ -2784,14 +2512,14 @@ type PlatformDevice struct { noSmithyDocumentSerde } -// Port mappings allow containers to access ports on the host container instance to -// send or receive traffic. Port mappings are specified as part of the container +// Port mappings allow containers to access ports on the host container instance +// to send or receive traffic. Port mappings are specified as part of the container // definition. If you use containers in a task with the awsvpc or host network -// mode, specify the exposed ports using containerPort. The hostPort can be left -// blank or it must be the same value as the containerPort. You can't expose the +// mode, specify the exposed ports using containerPort . The hostPort can be left +// blank or it must be the same value as the containerPort . You can't expose the // same container port for multiple protocols. If you attempt this, an error is -// returned. After a task reaches the RUNNING status, manual and automatic host and -// container port assignments are visible in the networkBindings section of +// returned. After a task reaches the RUNNING status, manual and automatic host +// and container port assignments are visible in the networkBindings section of // DescribeTasks API responses. type PortMapping struct { @@ -2807,110 +2535,78 @@ type PortMapping struct { // across all of the clusters in the namespace. Tasks connect through a managed // proxy container that collects logs and metrics for increased visibility. Only // the tasks that Amazon ECS services create are supported with Service Connect. - // For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. AppProtocol ApplicationProtocol // The port number on the container that's bound to the user-specified or // automatically assigned host port. If you use containers in a task with the - // awsvpc or host network mode, specify the exposed ports using containerPort. If + // awsvpc or host network mode, specify the exposed ports using containerPort . If // you use containers in a task with the bridge network mode and you specify a // container port and not a host port, your container automatically receives a host - // port in the ephemeral port range. For more information, see hostPort. Port + // port in the ephemeral port range. For more information, see hostPort . Port // mappings that are automatically assigned in this way do not count toward the 100 // reserved ports limit of a container instance. ContainerPort *int32 // The port number range on the container that's bound to the dynamically mapped - // host port range. The following rules apply when you specify a - // containerPortRange: - // - // * You must use either the bridge network mode or the awsvpc - // network mode. - // - // * This parameter is available for both the EC2 and Fargate launch - // types. - // - // * This parameter is available for both the Linux and Windows operating - // systems. - // - // * The container instance must have at least version 1.67.0 of the - // container agent and at least version 1.67.0-1 of the ecs-init package - // - // * You can - // specify a maximum of 100 port ranges per container. - // - // * You do not specify a - // hostPortRange. The value of the hostPortRange is set as follows: - // - // * For - // containers in a task with the awsvpc network mode, the hostPort is set to the - // same value as the containerPort. This is a static mapping strategy. - // - // * For - // containers in a task with the bridge network mode, the Amazon ECS agent finds - // open host ports from the default ephemeral range and passes it to docker to bind - // them to the container ports. - // - // * The containerPortRange valid values are between - // 1 and 65535. - // - // * A port can only be included in one port mapping per - // container. - // - // * You cannot specify overlapping port ranges. - // - // * The first port in - // the range must be less than last port in the range. - // - // * Docker recommends that - // you turn off the docker-proxy in the Docker daemon config file when you have a - // large number of ports. For more information, see Issue #11185 - // (https://github.com/moby/moby/issues/11185) on the Github website. For - // information about how to turn off the docker-proxy in the Docker daemon config - // file, see Docker daemon - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) - // in the Amazon ECS Developer Guide. - // - // You can call DescribeTasks - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) + // host port range. The following rules apply when you specify a containerPortRange + // : + // - You must use either the bridge network mode or the awsvpc network mode. + // - This parameter is available for both the EC2 and Fargate launch types. + // - This parameter is available for both the Linux and Windows operating + // systems. + // - The container instance must have at least version 1.67.0 of the container + // agent and at least version 1.67.0-1 of the ecs-init package + // - You can specify a maximum of 100 port ranges per container. + // - You do not specify a hostPortRange . The value of the hostPortRange is set + // as follows: + // - For containers in a task with the awsvpc network mode, the hostPort is set + // to the same value as the containerPort . This is a static mapping strategy. + // - For containers in a task with the bridge network mode, the Amazon ECS agent + // finds open host ports from the default ephemeral range and passes it to docker + // to bind them to the container ports. + // - The containerPortRange valid values are between 1 and 65535. + // - A port can only be included in one port mapping per container. + // - You cannot specify overlapping port ranges. + // - The first port in the range must be less than last port in the range. + // - Docker recommends that you turn off the docker-proxy in the Docker daemon + // config file when you have a large number of ports. For more information, see + // Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github + // website. For information about how to turn off the docker-proxy in the Docker + // daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) + // in the Amazon ECS Developer Guide. + // You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) // to view the hostPortRange which are the host ports that are bound to the // container ports. ContainerPortRange *string // The port number on the container instance to reserve for your container. If you - // specify a containerPortRange, leave this field empty and the value of the + // specify a containerPortRange , leave this field empty and the value of the // hostPort is set as follows: - // - // * For containers in a task with the awsvpc network - // mode, the hostPort is set to the same value as the containerPort. This is a - // static mapping strategy. - // - // * For containers in a task with the bridge network - // mode, the Amazon ECS agent finds open ports on the host and automaticaly binds - // them to the container ports. This is a dynamic mapping strategy. - // - // If you use - // containers in a task with the awsvpc or host network mode, the hostPort can - // either be left blank or set to the same value as the containerPort. If you use - // containers in a task with the bridge network mode, you can specify a - // non-reserved host port for your container port mapping, or you can omit the - // hostPort (or set it to 0) while specifying a containerPort and your container + // - For containers in a task with the awsvpc network mode, the hostPort is set + // to the same value as the containerPort . This is a static mapping strategy. + // - For containers in a task with the bridge network mode, the Amazon ECS agent + // finds open ports on the host and automaticaly binds them to the container ports. + // This is a dynamic mapping strategy. + // If you use containers in a task with the awsvpc or host network mode, the + // hostPort can either be left blank or set to the same value as the containerPort + // . If you use containers in a task with the bridge network mode, you can specify + // a non-reserved host port for your container port mapping, or you can omit the + // hostPort (or set it to 0 ) while specifying a containerPort and your container // automatically receives a port in the ephemeral port range for your container // instance operating system and Docker version. The default ephemeral port range // for Docker version 1.6.0 and later is listed on the instance under - // /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, - // the default ephemeral port range from 49153 through 65535 is used. Do not - // attempt to specify a host port in the ephemeral port range as these are reserved - // for automatic assignment. In general, ports below 32768 are outside of the - // ephemeral port range. The default reserved ports are 22 for SSH, the Docker + // /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is + // unavailable, the default ephemeral port range from 49153 through 65535 is used. + // Do not attempt to specify a host port in the ephemeral port range as these are + // reserved for automatic assignment. In general, ports below 32768 are outside of + // the ephemeral port range. The default reserved ports are 22 for SSH, the Docker // ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any // host port that was previously specified in a running task is also reserved while // the task is running. That is, after a task stops, the host port is released. The // current reserved ports are displayed in the remainingResources of - // DescribeContainerInstances - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) + // DescribeContainerInstances (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) // output. A container instance can have up to 100 reserved ports at a time. This // number includes the default reserved ports. Automatically assigned ports aren't // included in the 100 reserved ports quota. @@ -2921,28 +2617,27 @@ type PortMapping struct { // serviceConnectConfiguration of a service. The name can include up to 64 // characters. The characters can include lowercase letters, numbers, underscores // (_), and hyphens (-). The name can't start with a hyphen. For more information, - // see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. Name *string - // The protocol used for the port mapping. Valid values are tcp and udp. The - // default is tcp. + // The protocol used for the port mapping. Valid values are tcp and udp . The + // default is tcp . Protocol TransportProtocol noSmithyDocumentSerde } -// An object representing the protection status details for a task. You can set the -// protection status with the UpdateTaskProtection API and get the status of tasks -// with the GetTaskProtection API. +// An object representing the protection status details for a task. You can set +// the protection status with the UpdateTaskProtection API and get the status of +// tasks with the GetTaskProtection API. type ProtectedTask struct { // The epoch time when protection for the task will expire. ExpirationDate *time.Time // The protection status of the task. If scale-in protection is on for a task, the - // value is true. Otherwise, it is false. + // value is true . Otherwise, it is false . ProtectionEnabled bool // The task ARN. @@ -2956,9 +2651,8 @@ type ProtectedTask struct { // container agent and at least version 1.26.0-1 of the ecs-init package to use a // proxy configuration. If your container instances are launched from the Amazon // ECS optimized AMI version 20190301 or later, then they contain the required -// versions of the container agent and ecs-init. For more information, see Amazon -// ECS-optimized Linux AMI -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) +// versions of the container agent and ecs-init . For more information, see Amazon +// ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) type ProxyConfiguration struct { // The name of the container that will serve as the App Mesh proxy. @@ -2968,38 +2662,30 @@ type ProxyConfiguration struct { // The set of network configuration parameters to provide the Container Network // Interface (CNI) plugin, specified as key-value pairs. - // - // * IgnoredUID - (Required) - // The user ID (UID) of the proxy container as defined by the user parameter in a - // container definition. This is used to ensure the proxy ignores its own traffic. - // If IgnoredGID is specified, this field can be empty. - // - // * IgnoredGID - (Required) - // The group ID (GID) of the proxy container as defined by the user parameter in a - // container definition. This is used to ensure the proxy ignores its own traffic. - // If IgnoredUID is specified, this field can be empty. - // - // * AppPorts - (Required) - // The list of ports that the application uses. Network traffic to these ports is - // forwarded to the ProxyIngressPort and ProxyEgressPort. - // - // * ProxyIngressPort - - // (Required) Specifies the port that incoming traffic to the AppPorts is directed - // to. - // - // * ProxyEgressPort - (Required) Specifies the port that outgoing traffic - // from the AppPorts is directed to. - // - // * EgressIgnoredPorts - (Required) The egress - // traffic going to the specified ports is ignored and not redirected to the - // ProxyEgressPort. It can be an empty list. - // - // * EgressIgnoredIPs - (Required) The - // egress traffic going to the specified IP addresses is ignored and not redirected - // to the ProxyEgressPort. It can be an empty list. + // - IgnoredUID - (Required) The user ID (UID) of the proxy container as defined + // by the user parameter in a container definition. This is used to ensure the + // proxy ignores its own traffic. If IgnoredGID is specified, this field can be + // empty. + // - IgnoredGID - (Required) The group ID (GID) of the proxy container as defined + // by the user parameter in a container definition. This is used to ensure the + // proxy ignores its own traffic. If IgnoredUID is specified, this field can be + // empty. + // - AppPorts - (Required) The list of ports that the application uses. Network + // traffic to these ports is forwarded to the ProxyIngressPort and + // ProxyEgressPort . + // - ProxyIngressPort - (Required) Specifies the port that incoming traffic to + // the AppPorts is directed to. + // - ProxyEgressPort - (Required) Specifies the port that outgoing traffic from + // the AppPorts is directed to. + // - EgressIgnoredPorts - (Required) The egress traffic going to the specified + // ports is ignored and not redirected to the ProxyEgressPort . It can be an + // empty list. + // - EgressIgnoredIPs - (Required) The egress traffic going to the specified IP + // addresses is ignored and not redirected to the ProxyEgressPort . It can be an + // empty list. Properties []KeyValuePair - // The proxy type. The only supported value is APPMESH. + // The proxy type. The only supported value is APPMESH . Type ProxyConfigurationType noSmithyDocumentSerde @@ -3035,7 +2721,7 @@ type Resource struct { // precision floating-point type. LongValue int64 - // The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a + // The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a // user-defined resource. Name *string @@ -3043,7 +2729,7 @@ type Resource struct { // type. StringSetValue []string - // The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET. + // The type of the resource. Valid values: INTEGER , DOUBLE , LONG , or STRINGSET . Type *string noSmithyDocumentSerde @@ -3051,26 +2737,23 @@ type Resource struct { // The type and amount of a resource to assign to a container. The supported // resource types are GPUs and Elastic Inference accelerators. For more -// information, see Working with GPUs on Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or -// Working with Amazon Elastic Inference on Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/url-ecs-dev;ecs-inference.html) +// information, see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) +// or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/url-ecs-dev;ecs-inference.html) // in the Amazon Elastic Container Service Developer Guide type ResourceRequirement struct { // The type of resource to assign to a container. The supported values are GPU or - // InferenceAccelerator. + // InferenceAccelerator . // // This member is required. Type ResourceType - // The value for the specified resource type. If the GPU type is used, the value is - // the number of physical GPUs the Amazon ECS container agent reserves for the + // The value for the specified resource type. If the GPU type is used, the value + // is the number of physical GPUs the Amazon ECS container agent reserves for the // container. The number of GPUs that's reserved for all containers in a task can't // exceed the number of available GPUs on the container instance that the task is // launched on. If the InferenceAccelerator type is used, the value matches the - // deviceName for an InferenceAccelerator - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) + // deviceName for an InferenceAccelerator (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) // specified in a task definition. // // This member is required. @@ -3080,14 +2763,13 @@ type ResourceRequirement struct { } // Information about the platform for the Amazon ECS service or task. For more -// information about RuntimePlatform, see RuntimePlatform -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) +// information about RuntimePlatform , see RuntimePlatform (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) // in the Amazon Elastic Container Service Developer Guide. type RuntimePlatform struct { // The CPU architecture. You can run your Linux tasks on an ARM-based platform by - // setting the value to ARM64. This option is available for tasks that run on Linux - // Amazon EC2 instance or Linux containers on Fargate. + // setting the value to ARM64 . This option is available for tasks that run on + // Linux Amazon EC2 instance or Linux containers on Fargate. CpuArchitecture CPUArchitecture // The operating system. @@ -3103,7 +2785,7 @@ type Scale struct { // The unit of measure for the scale value. Unit ScaleUnit - // The value, specified as a percent total of a service's desiredCount, to scale + // The value, specified as a percent total of a service's desiredCount , to scale // the task set. Accepted values are numbers between 0 and 100. Value float64 @@ -3112,17 +2794,12 @@ type Scale struct { // An object representing the secret to expose to your container. Secrets can be // exposed to a container in the following ways: +// - To inject sensitive data into your containers as environment variables, use +// the secrets container definition parameter. +// - To reference sensitive information in the log configuration of a container, +// use the secretOptions container definition parameter. // -// * To inject sensitive data into -// your containers as environment variables, use the secrets container definition -// parameter. -// -// * To reference sensitive information in the log configuration of a -// container, use the secretOptions container definition parameter. -// -// For more -// information, see Specifying sensitive data -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) +// For more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) // in the Amazon Elastic Container Service Developer Guide. type Secret struct { @@ -3134,10 +2811,8 @@ type Secret struct { // The secret to expose to the container. The supported values are either the full // ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM // Parameter Store. For information about the require Identity and Access - // Management permissions, see Required IAM permissions for Amazon ECS secrets - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) - // (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) + // Management permissions, see Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) + // (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) // (for Systems Manager Parameter store) in the Amazon Elastic Container Service // Developer Guide. If the SSM Parameter Store parameter exists in the same Region // as the task you're launching, then you can use either the full ARN or name of @@ -3153,8 +2828,9 @@ type Secret struct { // Details on a service within a cluster. type Service struct { - // The capacity provider strategy the service uses. When using the DescribeServices - // API, this field is omitted if the service was created using a launch type. + // The capacity provider strategy the service uses. When using the + // DescribeServices API, this field is omitted if the service was created using a + // launch type. CapacityProviderStrategy []CapacityProviderStrategyItem // The Amazon Resource Name (ARN) of the cluster that hosts the service. @@ -3178,18 +2854,17 @@ type Service struct { // The desired number of instantiations of the task definition to keep running on // the service. This value is specified when the service is created with - // CreateService, and it can be modified with UpdateService. + // CreateService , and it can be modified with UpdateService . DesiredCount int32 // Determines whether to use Amazon ECS managed tags for the tasks in the service. - // For more information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool - // Determines whether the execute command functionality is enabled for the service. - // If true, the execute command functionality is enabled for all containers in - // tasks as part of the service. + // Determines whether the execute command functionality is enabled for the + // service. If true , the execute command functionality is enabled for all + // containers in tasks as part of the service. EnableExecuteCommand bool // The event stream for your service. A maximum of 100 of the latest events are @@ -3210,8 +2885,8 @@ type Service struct { // load balancer. The container name is as it appears in a container definition. LoadBalancers []LoadBalancer - // The VPC subnet and security group configuration for tasks that receive their own - // elastic network interface by using the awsvpc networking mode. + // The VPC subnet and security group configuration for tasks that receive their + // own elastic network interface by using the awsvpc networking mode. NetworkConfiguration *NetworkConfiguration // The number of tasks in the cluster that are in the PENDING state. @@ -3223,26 +2898,25 @@ type Service struct { // The placement strategy that determines how tasks for the service are placed. PlacementStrategy []PlacementStrategy - // The operating system that your tasks in the service run on. A platform family is - // specified only for tasks using the Fargate launch type. All tasks that run as + // The operating system that your tasks in the service run on. A platform family + // is specified only for tasks using the Fargate launch type. All tasks that run as // part of this service must use the same platformFamily value as the service (for - // example, LINUX). + // example, LINUX ). PlatformFamily *string // The platform version to run your service on. A platform version is only // specified for tasks that are hosted on Fargate. If one isn't specified, the // LATEST platform version is used. For more information, see Fargate Platform - // Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Determines whether to propagate the tags from the task definition or the service - // to the task. If no value is specified, the tags aren't propagated. + // Determines whether to propagate the tags from the task definition or the + // service to the task. If no value is specified, the tags aren't propagated. PropagateTags PropagateTags - // The ARN of the IAM role that's associated with the service. It allows the Amazon - // ECS container agent to register container instances with an Elastic Load + // The ARN of the IAM role that's associated with the service. It allows the + // Amazon ECS container agent to register container instances with an Elastic Load // Balancing load balancer. RoleArn *string @@ -3250,27 +2924,22 @@ type Service struct { RunningCount int32 // The scheduling strategy to use for the service. For more information, see - // Services - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). - // There are two service scheduler strategies available. - // - // * REPLICA-The replica - // scheduling strategy places and maintains the desired number of tasks across your - // cluster. By default, the service scheduler spreads tasks across Availability - // Zones. You can use task placement strategies and constraints to customize task - // placement decisions. - // - // * DAEMON-The daemon scheduling strategy deploys exactly - // one task on each active container instance. This task meets all of the task - // placement constraints that you specify in your cluster. The service scheduler - // also evaluates the task placement constraints for running tasks. It stop tasks - // that don't meet the placement constraints. Fargate tasks don't support the - // DAEMON scheduling strategy. + // Services (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) + // . There are two service scheduler strategies available. + // - REPLICA -The replica scheduling strategy places and maintains the desired + // number of tasks across your cluster. By default, the service scheduler spreads + // tasks across Availability Zones. You can use task placement strategies and + // constraints to customize task placement decisions. + // - DAEMON -The daemon scheduling strategy deploys exactly one task on each + // active container instance. This task meets all of the task placement constraints + // that you specify in your cluster. The service scheduler also evaluates the task + // placement constraints for running tasks. It stop tasks that don't meet the + // placement constraints. Fargate tasks don't support the DAEMON scheduling + // strategy. SchedulingStrategy SchedulingStrategy // The ARN that identifies the service. For more information about the ARN format, - // see Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + // see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) // in the Amazon ECS Developer Guide. ServiceArn *string @@ -3281,46 +2950,35 @@ type Service struct { ServiceName *string // The details for the service discovery registries to assign to this service. For - // more information, see Service Discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + // more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) + // . ServiceRegistries []ServiceRegistry - // The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. + // The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE . Status *string // The metadata that you apply to the service to help you categorize and organize // them. Each tag consists of a key and an optional value. You define bot the key // and value. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * - // If your tagging schema is used across multiple services and resources, remember - // that other services may have restrictions on allowed characters. Generally - // allowed characters are: letters, numbers, and spaces representable in UTF-8, and - // the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag // The task definition to use for tasks in the service. This value is specified - // when the service is created with CreateService, and it can be modified with - // UpdateService. + // when the service is created with CreateService , and it can be modified with + // UpdateService . TaskDefinition *string // Information about a set of Amazon ECS tasks in either an CodeDeploy or an @@ -3339,16 +2997,14 @@ type Service struct { // across all of the clusters in the namespace. Tasks connect through a managed // proxy container that collects logs and metrics for increased visibility. Only // the tasks that Amazon ECS services create are supported with Service Connect. -// For more information, see Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. type ServiceConnectClientAlias struct { // The listening port number for the Service Connect proxy. This port is available // inside of all of the tasks within the same namespace. To avoid changing your // applications in client Amazon ECS services, set this to the same port that the - // client application uses by default. For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // client application uses by default. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. // // This member is required. @@ -3361,11 +3017,10 @@ type ServiceConnectClientAlias struct { // (.). The name can't start with a hyphen. If this parameter isn't specified, the // default value of discoveryName.namespace is used. If the discoveryName isn't // specified, the port mapping name from the task definition is used in - // portName.namespace. To avoid changing your applications in client Amazon ECS + // portName.namespace . To avoid changing your applications in client Amazon ECS // services, set this to the same name that the client application uses by default. - // For example, a few common names are database, db, or the lowercase name of a - // database, such as mysql or redis. For more information, see Service Connect - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) + // For example, a few common names are database , db , or the lowercase name of a + // database, such as mysql or redis . For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. DnsName *string @@ -3379,8 +3034,7 @@ type ServiceConnectClientAlias struct { // to services across all of the clusters in the namespace. Tasks connect through a // managed proxy container that collects logs and metrics for increased visibility. // Only the tasks that Amazon ECS services create are supported with Service -// Connect. For more information, see Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. type ServiceConnectConfiguration struct { @@ -3389,47 +3043,37 @@ type ServiceConnectConfiguration struct { // This member is required. Enabled bool - // The log configuration for the container. This parameter maps to LogConfig in the - // Create a container - // (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of - // the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the - // --log-driver option to docker run - // (https://docs.docker.com/engine/reference/commandline/run/). By default, - // containers use the same logging driver that the Docker daemon uses. However, the - // container might use a different logging driver than the Docker daemon by - // specifying a log driver configuration in the container definition. For more - // information about the options for different supported log drivers, see Configure - // logging drivers (https://docs.docker.com/engine/admin/logging/overview/) in the - // Docker documentation. Understand the following when specifying a log + // The log configuration for the container. This parameter maps to LogConfig in + // the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) + // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/) + // . By default, containers use the same logging driver that the Docker daemon + // uses. However, the container might use a different logging driver than the + // Docker daemon by specifying a log driver configuration in the container + // definition. For more information about the options for different supported log + // drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) + // in the Docker documentation. Understand the following when specifying a log // configuration for your containers. - // - // * Amazon ECS currently supports a subset of - // the logging drivers available to the Docker daemon (shown in the valid values - // below). Additional log drivers may be available in future releases of the Amazon - // ECS container agent. - // - // * This parameter requires version 1.18 of the Docker - // Remote API or greater on your container instance. - // - // * For tasks that are hosted - // on Amazon EC2 instances, the Amazon ECS container agent must register the - // available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment - // variable before containers placed on that instance can use these log - // configuration options. For more information, see Amazon ECS container agent - // configuration - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) - // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that are - // on Fargate, because you don't have access to the underlying infrastructure your - // tasks are hosted on, any additional software needed must be installed outside of - // the task. For example, the Fluentd output aggregators or a remote host running - // Logstash to send Gelf logs to. + // - Amazon ECS currently supports a subset of the logging drivers available to + // the Docker daemon (shown in the valid values below). Additional log drivers may + // be available in future releases of the Amazon ECS container agent. + // - This parameter requires version 1.18 of the Docker Remote API or greater on + // your container instance. + // - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container + // agent must register the available logging drivers with the + // ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on + // that instance can use these log configuration options. For more information, see + // Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) + // in the Amazon Elastic Container Service Developer Guide. + // - For tasks that are on Fargate, because you don't have access to the + // underlying infrastructure your tasks are hosted on, any additional software + // needed must be installed outside of the task. For example, the Fluentd output + // aggregators or a remote host running Logstash to send Gelf logs to. LogConfiguration *LogConfiguration - // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace - // for use with Service Connect. The namespace must be in the same Amazon Web - // Services Region as the Amazon ECS service and cluster. The type of namespace + // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map + // namespace for use with Service Connect. The namespace must be in the same Amazon + // Web Services Region as the Amazon ECS service and cluster. The type of namespace // doesn't affect Service Connect. For more information about Cloud Map, see // Working with Services (https://docs.aws.amazon.com/) in the Cloud Map Developer // Guide. @@ -3450,8 +3094,7 @@ type ServiceConnectConfiguration struct { } // The Service Connect service object configuration. For more information, see -// Service Connect -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) +// Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) // in the Amazon Elastic Container Service Developer Guide. type ServiceConnectService struct { @@ -3466,22 +3109,22 @@ type ServiceConnectService struct { // client aliases that you can have in this list is 1. Each alias ("endpoint") is a // fully-qualified name and port number that other Amazon ECS tasks ("clients") can // use to connect to this service. Each name and port mapping must be unique within - // the namespace. For each ServiceConnectService, you must provide at least one - // clientAlias with one port. + // the namespace. For each ServiceConnectService , you must provide at least one + // clientAlias with one port . ClientAliases []ServiceConnectClientAlias // The discoveryName is the name of the new Cloud Map service that Amazon ECS // creates for this Amazon ECS service. This must be unique within the Cloud Map // namespace. The name can contain up to 64 characters. The name can include // lowercase letters, numbers, underscores (_), and hyphens (-). The name can't - // start with a hyphen. If the discoveryName isn't specified, the port mapping name - // from the task definition is used in portName.namespace. + // start with a hyphen. If the discoveryName isn't specified, the port mapping + // name from the task definition is used in portName.namespace . DiscoveryName *string // The port number for the Service Connect proxy to listen on. Use the value of // this field to bypass the proxy for traffic on the port number specified in the - // named portMapping in the task definition of this application, and then use it in - // your VPC security groups to allow traffic into the proxy for this Amazon ECS + // named portMapping in the task definition of this application, and then use it + // in your VPC security groups to allow traffic into the proxy for this Amazon ECS // service. In awsvpc mode and Fargate, the default value is the container port // number. The container port number is in the portMapping in the task definition. // In bridge mode, the default value is the ephemeral port of the Service Connect @@ -3512,7 +3155,7 @@ type ServiceConnectServiceResource struct { // contain up to 64 characters. The name can include lowercase letters, numbers, // underscores (_), and hyphens (-). The name can't start with a hyphen. If the // discoveryName isn't specified, the port mapping name from the task definition is - // used in portName.namespace. + // used in portName.namespace . DiscoveryName *string noSmithyDocumentSerde @@ -3564,8 +3207,8 @@ type ServiceRegistry struct { Port *int32 // The Amazon Resource Name (ARN) of the service registry. The currently supported - // service registry is Cloud Map. For more information, see CreateService - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). + // service registry is Cloud Map. For more information, see CreateService (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) + // . RegistryArn *string noSmithyDocumentSerde @@ -3581,8 +3224,8 @@ type Session struct { // uses to send commands and receive output from the container. StreamUrl *string - // An encrypted token value containing session and caller information. It's used to - // authenticate the connection to the container. + // An encrypted token value containing session and caller information. It's used + // to authenticate the connection to the container. TokenValue *string noSmithyDocumentSerde @@ -3605,30 +3248,25 @@ type Setting struct { } // A list of namespaced kernel parameters to set in the container. This parameter -// maps to Sysctls in the Create a container -// (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of -// the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) and the -// --sysctl option to docker run -// (https://docs.docker.com/engine/reference/run/#security-configuration). We don't -// recommend that you specify network-related systemControls parameters for -// multiple containers in a single task. This task also uses either the awsvpc or -// host network mode. It does it for the following reasons. -// -// * For tasks that use -// the awsvpc network mode, if you set systemControls for any container, it applies -// to all containers in the task. If you set different systemControls for multiple -// containers in a single task, the container that's started last determines which -// systemControls take effect. -// -// * For tasks that use the host network mode, the -// systemControls parameter applies to the container instance's kernel parameter -// and that of all containers of any tasks running on that container instance. +// maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) +// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) +// and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration) +// . We don't recommend that you specify network-related systemControls parameters +// for multiple containers in a single task. This task also uses either the awsvpc +// or host network mode. It does it for the following reasons. +// - For tasks that use the awsvpc network mode, if you set systemControls for +// any container, it applies to all containers in the task. If you set different +// systemControls for multiple containers in a single task, the container that's +// started last determines which systemControls take effect. +// - For tasks that use the host network mode, the systemControls parameter +// applies to the container instance's kernel parameter and that of all containers +// of any tasks running on that container instance. type SystemControl struct { // The namespaced kernel parameter to set a value for. Namespace *string - // The value for the namespaced kernel parameter that's specified in namespace. + // The value for the namespaced kernel parameter that's specified in namespace . Value *string noSmithyDocumentSerde @@ -3637,31 +3275,20 @@ type SystemControl struct { // The metadata that you apply to a resource to help you categorize and organize // them. Each tag consists of a key and an optional value. You define them. The // following basic restrictions apply to tags: -// -// * Maximum number of tags per -// resource - 50 -// -// * For each resource, each tag key must be unique, and each tag -// key can have only one value. -// -// * Maximum key length - 128 Unicode characters in -// UTF-8 -// -// * Maximum value length - 256 Unicode characters in UTF-8 -// -// * If your -// tagging schema is used across multiple services and resources, remember that -// other services may have restrictions on allowed characters. Generally allowed -// characters are: letters, numbers, and spaces representable in UTF-8, and the -// following characters: + - = . _ : / @. -// -// * Tag keys and values are -// case-sensitive. -// -// * Do not use aws:, AWS:, or any upper or lowercase combination -// of such as a prefix for either keys or values as it is reserved for Amazon Web -// Services use. You cannot edit or delete tag keys or values with this prefix. -// Tags with this prefix do not count against your tags per resource limit. +// - Maximum number of tags per resource - 50 +// - For each resource, each tag key must be unique, and each tag key can have +// only one value. +// - Maximum key length - 128 Unicode characters in UTF-8 +// - Maximum value length - 256 Unicode characters in UTF-8 +// - If your tagging schema is used across multiple services and resources, +// remember that other services may have restrictions on allowed characters. +// Generally allowed characters are: letters, numbers, and spaces representable in +// UTF-8, and the following characters: + - = . _ : / @. +// - Tag keys and values are case-sensitive. +// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a +// prefix for either keys or values as it is reserved for Amazon Web Services use. +// You cannot edit or delete tag keys or values with this prefix. Tags with this +// prefix do not count against your tags per resource limit. type Tag struct { // One part of a key-value pair that make up a tag. A key is a general label that @@ -3678,8 +3305,8 @@ type Tag struct { // Details on a task in a cluster. type Task struct { - // The Elastic Network Adapter that's associated with the task if the task uses the - // awsvpc network mode. + // The Elastic Network Adapter that's associated with the task if the task uses + // the awsvpc network mode. Attachments []Attachment // The attributes of the task @@ -3707,51 +3334,41 @@ type Task struct { Containers []Container // The number of CPU units used by the task as expressed in a task definition. It - // can be expressed as an integer using CPU units (for example, 1024). It can also - // be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu). String + // can be expressed as an integer using CPU units (for example, 1024 ). It can also + // be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu ). String // values are converted to an integer that indicates the CPU units when the task // definition is registered. If you use the EC2 launch type, this field is - // optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU - // units (10 vCPUs). If you use the Fargate launch type, this field is required. - // You must use one of the following values. These values determine the range of - // supported values for the memory parameter: The CPU units cannot be less than 1 - // vCPU when you use Windows containers on Fargate. - // - // * 256 (.25 vCPU) - Available - // memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - // - // * 512 (.5 vCPU) - - // Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - // - // * - // 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), - // 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - // - // * 2048 (2 vCPU) - Available - // memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // - // * - // 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in - // increments of 1024 (1 GB) - // - // * 8192 (8 vCPU) - Available memory values: 16 GB and - // 60 GB in 4 GB increments This option requires Linux platform 1.4.0 or later. - // - // * - // 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments - // This option requires Linux platform 1.4.0 or later. + // optional. Supported values are between 128 CPU units ( 0.125 vCPUs) and 10240 + // CPU units ( 10 vCPUs). If you use the Fargate launch type, this field is + // required. You must use one of the following values. These values determine the + // range of supported values for the memory parameter: The CPU units cannot be + // less than 1 vCPU when you use Windows containers on Fargate. + // - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 + // GB) + // - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 + // GB), 4096 (4 GB) + // - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 + // GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + // - 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in + // increments of 1024 (1 GB) + // - 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in + // increments of 1024 (1 GB) + // - 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments + // This option requires Linux platform 1.4.0 or later. + // - 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments + // This option requires Linux platform 1.4.0 or later. Cpu *string // The Unix timestamp for the time when the task was created. More specifically, // it's for the time when the task entered the PENDING state. CreatedAt *time.Time - // The desired status of the task. For more information, see Task Lifecycle - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). + // The desired status of the task. For more information, see Task Lifecycle (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html) + // . DesiredStatus *string // Determines whether execute command functionality is enabled for this task. If - // true, execute command functionality is enabled on all the containers in the + // true , execute command functionality is enabled on all the containers in the // task. EnableExecuteCommand bool @@ -3766,61 +3383,50 @@ type Task struct { // The health status for the task. It's determined by the health of the essential // containers in the task. If all essential containers in the task are reporting as - // HEALTHY, the task status also reports as HEALTHY. If any essential containers in - // the task are reporting as UNHEALTHY or UNKNOWN, the task status also reports as - // UNHEALTHY or UNKNOWN. The Amazon ECS container agent doesn't monitor or report - // on Docker health checks that are embedded in a container image and not specified - // in the container definition. For example, this includes those specified in a - // parent image or from the image's Dockerfile. Health check parameters that are - // specified in a container definition override any Docker health checks that are - // found in the container image. + // HEALTHY , the task status also reports as HEALTHY . If any essential containers + // in the task are reporting as UNHEALTHY or UNKNOWN , the task status also reports + // as UNHEALTHY or UNKNOWN . The Amazon ECS container agent doesn't monitor or + // report on Docker health checks that are embedded in a container image and not + // specified in the container definition. For example, this includes those + // specified in a parent image or from the image's Dockerfile. Health check + // parameters that are specified in a container definition override any Docker + // health checks that are found in the container image. HealthStatus HealthStatus // The Elastic Inference accelerator that's associated with the task. InferenceAccelerators []InferenceAccelerator - // The last known status for the task. For more information, see Task Lifecycle - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html). + // The last known status for the task. For more information, see Task Lifecycle (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html) + // . LastStatus *string - // The infrastructure where your task runs on. For more information, see Amazon ECS - // launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // The infrastructure where your task runs on. For more information, see Amazon + // ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType // The amount of memory (in MiB) that the task uses as expressed in a task - // definition. It can be expressed as an integer using MiB (for example, 1024). If - // it's expressed as a string using GB (for example, 1GB or 1 GB), it's converted + // definition. It can be expressed as an integer using MiB (for example, 1024 ). If + // it's expressed as a string using GB (for example, 1GB or 1 GB ), it's converted // to an integer indicating the MiB when the task definition is registered. If you // use the EC2 launch type, this field is optional. If you use the Fargate launch // type, this field is required. You must use one of the following values. The // value that you choose determines the range of supported values for the cpu // parameter. - // - // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 - // (.25 vCPU) - // - // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu - // values: 512 (.5 vCPU) - // - // * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), - // 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) - // - // * - // Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available - // cpu values: 2048 (2 vCPU) - // - // * Between 8192 (8 GB) and 30720 (30 GB) in increments - // of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) - // - // * Between 16 GB and 60 GB - // in 4 GB increments - Available cpu values: 8192 (8 vCPU) This option requires - // Linux platform 1.4.0 or later. - // - // * Between 32GB and 120 GB in 8 GB increments - - // Available cpu values: 16384 (16 vCPU) This option requires Linux platform 1.4.0 - // or later. + // - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 + // vCPU) + // - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: + // 512 (.5 vCPU) + // - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 + // GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) + // - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - + // Available cpu values: 2048 (2 vCPU) + // - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - + // Available cpu values: 4096 (4 vCPU) + // - Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 + // vCPU) This option requires Linux platform 1.4.0 or later. + // - Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 + // vCPU) This option requires Linux platform 1.4.0 or later. Memory *string // One or more container overrides. @@ -3829,14 +3435,13 @@ type Task struct { // The operating system that your tasks are running on. A platform family is // specified only for tasks that use the Fargate launch type. All tasks that run as // part of this service must use the same platformFamily value as the service (for - // example, LINUX.). + // example, LINUX. ). PlatformFamily *string // The platform version where your task runs on. A platform version is only // specified for tasks that use the Fargate launch type. If you didn't specify one, // the LATEST platform version is used. For more information, see Fargate Platform - // Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string @@ -3855,22 +3460,14 @@ type Task struct { // task, the startedBy parameter contains the deployment ID of that service. StartedBy *string - // The stop code indicating why a task was stopped. The stoppedReason might contain - // additional details. The following are valid values: - // - // * TaskFailedToStart - // - // * - // EssentialContainerExited - // - // * UserInitiated - // - // * TerminationNotice - // - // * - // ServiceSchedulerInitiated - // - // * SpotInterruption + // The stop code indicating why a task was stopped. The stoppedReason might + // contain additional details. The following are valid values: + // - TaskFailedToStart + // - EssentialContainerExited + // - UserInitiated + // - TerminationNotice + // - ServiceSchedulerInitiated + // - SpotInterruption StopCode TaskStopCode // The Unix timestamp for the time when the task was stopped. More specifically, @@ -3881,38 +3478,27 @@ type Task struct { // The reason that the task was stopped. StoppedReason *string - // The Unix timestamp for the time when the task stops. More specifically, it's for - // the time when the task transitions from the RUNNING state to STOPPED. + // The Unix timestamp for the time when the task stops. More specifically, it's + // for the time when the task transitions from the RUNNING state to STOPPED . StoppingAt *time.Time // The metadata that you apply to the task to help you categorize and organize the // task. Each tag consists of a key and an optional value. You define both the key // and value. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50 - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * - // If your tagging schema is used across multiple services and resources, remember - // that other services may have restrictions on allowed characters. Generally - // allowed characters are: letters, numbers, and spaces representable in UTF-8, and - // the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag // The Amazon Resource Name (ARN) of the task. @@ -3939,15 +3525,13 @@ type Task struct { type TaskDefinition struct { // The task launch types the task definition validated against during task - // definition registration. For more information, see Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // definition registration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. Compatibilities []Compatibility // A list of container definitions in JSON format that describe the different // containers that make up your task. For more information about container - // definition parameters and defaults, see Amazon ECS Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // definition parameters and defaults, see Amazon ECS Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon Elastic Container Service Developer Guide. ContainerDefinitions []ContainerDefinition @@ -3955,31 +3539,22 @@ type TaskDefinition struct { // field is optional. Any value can be used. If you use the Fargate launch type, // this field is required. You must use one of the following values. The value that // you choose determines your range of valid values for the memory parameter. The - // CPU units cannot be less than 1 vCPU when you use Windows containers on - // Fargate. - // - // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), - // 2048 (2 GB) - // - // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 - // GB), 3072 (3 GB), 4096 (4 GB) - // - // * 1024 (1 vCPU) - Available memory values: 2048 - // (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 - // GB) - // - // * 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in - // increments of 1024 (1 GB) - // - // * 4096 (4 vCPU) - Available memory values: 8192 (8 - // GB) and 30720 (30 GB) in increments of 1024 (1 GB) - // - // * 8192 (8 vCPU) - Available - // memory values: 16 GB and 60 GB in 4 GB increments This option requires Linux - // platform 1.4.0 or later. - // - // * 16384 (16vCPU) - Available memory values: 32GB and - // 120 GB in 8 GB increments This option requires Linux platform 1.4.0 or later. + // CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + // + // - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 + // GB) + // - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 + // GB), 4096 (4 GB) + // - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 + // GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + // - 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in + // increments of 1024 (1 GB) + // - 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in + // increments of 1024 (1 GB) + // - 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments + // This option requires Linux platform 1.4.0 or later. + // - 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments + // This option requires Linux platform 1.4.0 or later. Cpu *string // The Unix timestamp for the time when the task definition was deregistered. @@ -3988,11 +3563,11 @@ type TaskDefinition struct { // The ephemeral storage settings to use for tasks run with the task definition. EphemeralStorage *EphemeralStorage - // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon - // ECS container agent permission to make Amazon Web Services API calls on your - // behalf. The task execution IAM role is required depending on the requirements of - // your task. For more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // The Amazon Resource Name (ARN) of the task execution role that grants the + // Amazon ECS container agent permission to make Amazon Web Services API calls on + // your behalf. The task execution IAM role is required depending on the + // requirements of your task. For more information, see Amazon ECS task execution + // IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) // in the Amazon Elastic Container Service Developer Guide. ExecutionRoleArn *string @@ -4008,79 +3583,62 @@ type TaskDefinition struct { InferenceAccelerators []InferenceAccelerator // The IPC resource namespace to use for the containers in the task. The valid - // values are host, task, or none. If host is specified, then all containers within - // the tasks that specified the host IPC mode on the same container instance share - // the same IPC resources with the host Amazon EC2 instance. If task is specified, - // all containers within the specified task share the same IPC resources. If none - // is specified, then IPC resources within the containers of a task are private and - // not shared with other containers in a task or on the container instance. If no - // value is specified, then the IPC resource namespace sharing depends on the - // Docker daemon setting on the container instance. For more information, see IPC - // settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in - // the Docker run reference. If the host IPC mode is used, be aware that there is a - // heightened risk of undesired IPC namespace expose. For more information, see - // Docker security (https://docs.docker.com/engine/security/security/). If you are - // setting namespaced kernel parameters using systemControls for the containers in - // the task, the following will apply to your IPC resource namespace. For more - // information, see System Controls - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) + // values are host , task , or none . If host is specified, then all containers + // within the tasks that specified the host IPC mode on the same container + // instance share the same IPC resources with the host Amazon EC2 instance. If task + // is specified, all containers within the specified task share the same IPC + // resources. If none is specified, then IPC resources within the containers of a + // task are private and not shared with other containers in a task or on the + // container instance. If no value is specified, then the IPC resource namespace + // sharing depends on the Docker daemon setting on the container instance. For more + // information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) + // in the Docker run reference. If the host IPC mode is used, be aware that there + // is a heightened risk of undesired IPC namespace expose. For more information, + // see Docker security (https://docs.docker.com/engine/security/security/) . If you + // are setting namespaced kernel parameters using systemControls for the + // containers in the task, the following will apply to your IPC resource namespace. + // For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) // in the Amazon Elastic Container Service Developer Guide. - // - // * For tasks that use - // the host IPC mode, IPC namespace related systemControls are not supported. - // - // * - // For tasks that use the task IPC mode, IPC namespace related systemControls will - // apply to all containers within a task. - // - // This parameter is not supported for - // Windows containers or tasks run on Fargate. + // - For tasks that use the host IPC mode, IPC namespace related systemControls + // are not supported. + // - For tasks that use the task IPC mode, IPC namespace related systemControls + // will apply to all containers within a task. + // This parameter is not supported for Windows containers or tasks run on Fargate. IpcMode IpcMode - // The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 - // instances, you must specify either a task-level memory value or a + // The amount (in MiB) of memory used by the task. If your tasks runs on Amazon + // EC2 instances, you must specify either a task-level memory value or a // container-level memory value. This field is optional and any value can be used. // If a task-level memory value is specified, the container-level memory value is // optional. For more information regarding container-level memory and memory - // reservation, see ContainerDefinition - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). - // If your tasks runs on Fargate, this field is required. You must use one of the + // reservation, see ContainerDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html) + // . If your tasks runs on Fargate, this field is required. You must use one of the // following values. The value you choose determines your range of valid values for // the cpu parameter. - // - // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu - // values: 256 (.25 vCPU) - // - // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - - // Available cpu values: 512 (.5 vCPU) - // - // * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), - // 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 - // (1 vCPU) - // - // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - - // Available cpu values: 2048 (2 vCPU) - // - // * Between 8192 (8 GB) and 30720 (30 GB) in - // increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) - // - // * Between 16 GB - // and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU) This option - // requires Linux platform 1.4.0 or later. - // - // * Between 32GB and 120 GB in 8 GB - // increments - Available cpu values: 16384 (16 vCPU) This option requires Linux - // platform 1.4.0 or later. + // - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 + // vCPU) + // - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: + // 512 (.5 vCPU) + // - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 + // GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) + // - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - + // Available cpu values: 2048 (2 vCPU) + // - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - + // Available cpu values: 4096 (4 vCPU) + // - Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 + // vCPU) This option requires Linux platform 1.4.0 or later. + // - Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 + // vCPU) This option requires Linux platform 1.4.0 or later. Memory *string // The Docker networking mode to use for the containers in the task. The valid - // values are none, bridge, awsvpc, and host. If no network mode is specified, the - // default is bridge. For Amazon ECS tasks on Fargate, the awsvpc network mode is - // required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode - // can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc - // can be used. If the network mode is set to none, you cannot specify port - // mappings in your container definitions, and the tasks containers do not have - // external connectivity. The host and awsvpc network modes offer the highest + // values are none , bridge , awsvpc , and host . If no network mode is specified, + // the default is bridge . For Amazon ECS tasks on Fargate, the awsvpc network + // mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any + // network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, + // or awsvpc can be used. If the network mode is set to none , you cannot specify + // port mappings in your container definitions, and the tasks containers do not + // have external connectivity. The host and awsvpc network modes offer the highest // networking performance for containers because they use the EC2 network stack // instead of the virtualized network stack provided by the bridge mode. With the // host and awsvpc network modes, exposed container ports are mapped directly to @@ -4088,31 +3646,29 @@ type TaskDefinition struct { // network interface port (for the awsvpc network mode), so you cannot take // advantage of dynamic host port mappings. When using the host network mode, you // should not run containers using the root user (UID 0). It is considered best - // practice to use a non-root user. If the network mode is awsvpc, the task is + // practice to use a non-root user. If the network mode is awsvpc , the task is // allocated an elastic network interface, and you must specify a // NetworkConfiguration value when you create a service or run a task with the task - // definition. For more information, see Task Networking - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) + // definition. For more information, see Task Networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. If the network mode is - // host, you cannot run multiple instantiations of the same task on a single + // host , you cannot run multiple instantiations of the same task on a single // container instance when port mappings are used. For more information, see - // Network settings - // (https://docs.docker.com/engine/reference/run/#network-settings) in the Docker - // run reference. + // Network settings (https://docs.docker.com/engine/reference/run/#network-settings) + // in the Docker run reference. NetworkMode NetworkMode // The process namespace to use for the containers in the task. The valid values - // are host or task. If host is specified, then all containers within the tasks + // are host or task . If host is specified, then all containers within the tasks // that specified the host PID mode on the same container instance share the same // process namespace with the host Amazon EC2 instance. If task is specified, all // containers within the specified task share the same process namespace. If no // value is specified, the default is a private namespace. For more information, - // see PID settings - // (https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker - // run reference. If the host PID mode is used, be aware that there is a heightened - // risk of undesired process namespace expose. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/). This parameter is - // not supported for Windows containers or tasks run on Fargate. + // see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) + // in the Docker run reference. If the host PID mode is used, be aware that there + // is a heightened risk of undesired process namespace expose. For more + // information, see Docker security (https://docs.docker.com/engine/security/security/) + // . This parameter is not supported for Windows containers or tasks run on + // Fargate. PidMode PidMode // An array of placement constraint objects to use for tasks. This parameter isn't @@ -4124,8 +3680,7 @@ type TaskDefinition struct { // version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your // container instances are launched from the Amazon ECS optimized AMI version // 20190301 or later, they contain the required versions of the container agent and - // ecs-init. For more information, see Amazon ECS-optimized Linux AMI - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) + // ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration @@ -4140,22 +3695,20 @@ type TaskDefinition struct { // some standard attributes to the instance. You can apply custom attributes. These // are specified as key-value pairs using the Amazon ECS console or the // PutAttributes API. These attributes are used when determining task placement for - // tasks hosted on Amazon EC2 instances. For more information, see Attributes - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) + // tasks hosted on Amazon EC2 instances. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) // in the Amazon Elastic Container Service Developer Guide. This parameter isn't // supported for tasks run on Fargate. RequiresAttributes []Attribute // The task launch types the task definition was validated against. For more - // information, see Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. RequiresCompatibilities []Compatibility // The revision of the task in a particular family. The revision is a version // number of a task definition in a family. When you register a task definition for - // the first time, the revision is 1. Each time that you register a new revision of - // a task definition in the same family, the revision value always increases by + // the first time, the revision is 1 . Each time that you register a new revision + // of a task definition in the same family, the revision value always increases by // one. This is even if you deregistered previous revisions in this family. Revision int32 @@ -4173,20 +3726,17 @@ type TaskDefinition struct { // The short name or full Amazon Resource Name (ARN) of the Identity and Access // Management role that grants containers in the task permission to call Amazon Web - // Services APIs on your behalf. For more information, see Amazon ECS Task Role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // Services APIs on your behalf. For more information, see Amazon ECS Task Role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on // Windows require that the -EnableTaskIAMRole option is set when you launch the // Amazon ECS-optimized Windows AMI. Your containers must also run some // configuration code to use the feature. For more information, see Windows IAM - // roles for tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) + // roles for tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string // The list of data volume definitions for the task. For more information, see - // Using data volumes in tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) + // Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) // in the Amazon Elastic Container Service Developer Guide. The host and sourcePath // parameters aren't supported for tasks run on Fargate. Volumes []Volume @@ -4195,20 +3745,18 @@ type TaskDefinition struct { } // An object representing a constraint on task placement in the task definition. -// For more information, see Task placement constraints -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// For more information, see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. Task placement // constraints aren't supported for tasks run on Fargate. type TaskDefinitionPlacementConstraint struct { // A cluster query language expression to apply to the constraint. For more - // information, see Cluster query language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // information, see Cluster query language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string - // The type of constraint. The MemberOf constraint restricts selection to be from a - // group of valid candidates. + // The type of constraint. The MemberOf constraint restricts selection to be from + // a group of valid candidates. Type TaskDefinitionPlacementConstraintType noSmithyDocumentSerde @@ -4224,18 +3772,13 @@ type TaskOverride struct { Cpu *string // The ephemeral storage setting override for the task. This parameter is only - // supported for tasks hosted on Fargate that use the following platform - // versions: - // - // * Linux platform version 1.4.0 or later. - // - // * Windows platform version - // 1.0.0 or later. + // supported for tasks hosted on Fargate that use the following platform versions: + // - Linux platform version 1.4.0 or later. + // - Windows platform version 1.0.0 or later. EphemeralStorage *EphemeralStorage - // The Amazon Resource Name (ARN) of the task execution role override for the task. - // For more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // The Amazon Resource Name (ARN) of the task execution role override for the + // task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) // in the Amazon Elastic Container Service Developer Guide. ExecutionRoleArn *string @@ -4247,8 +3790,7 @@ type TaskOverride struct { // The Amazon Resource Name (ARN) of the role that containers in this task can // assume. All containers in this task are granted the permissions that are - // specified in this role. For more information, see IAM Role for Tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // specified in this role. For more information, see IAM Role for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string @@ -4288,8 +3830,7 @@ type TaskSet struct { Id *string // The launch type the tasks in the task set are using. For more information, see - // Amazon ECS launch types - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) + // Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType @@ -4300,9 +3841,9 @@ type TaskSet struct { NetworkConfiguration *NetworkConfiguration // The number of tasks in the task set that are in the PENDING status during a - // deployment. A task in the PENDING state is preparing to enter the RUNNING state. - // A task set enters the PENDING status when it launches for the first time or when - // it's restarted after being in the STOPPED state. + // deployment. A task in the PENDING state is preparing to enter the RUNNING + // state. A task set enters the PENDING status when it launches for the first time + // or when it's restarted after being in the STOPPED state. PendingCount int32 // The operating system that your tasks in the set are running on. A platform @@ -4312,8 +3853,7 @@ type TaskSet struct { // The Fargate platform version where the tasks in the task set are running. A // platform version is only specified for tasks run on Fargate. For more - // information, see Fargate platform versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string @@ -4328,28 +3868,20 @@ type TaskSet struct { // The Amazon Resource Name (ARN) of the service the task set exists in. ServiceArn *string - // The details for the service discovery registries to assign to this task set. For - // more information, see Service discovery - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + // The details for the service discovery registries to assign to this task set. + // For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) + // . ServiceRegistries []ServiceRegistry // The stability status. This indicates whether the task set has reached a steady - // state. If the following conditions are met, the task set are in STEADY_STATE: - // - // * - // The task runningCount is equal to the computedDesiredCount. - // - // * The pendingCount - // is 0. - // - // * There are no tasks that are running on container instances in the - // DRAINING status. - // - // * All tasks are reporting a healthy status from the load - // balancers, service discovery, and container health checks. - // - // If any of those - // conditions aren't met, the stability status returns STABILIZING. + // state. If the following conditions are met, the task set are in STEADY_STATE : + // - The task runningCount is equal to the computedDesiredCount . + // - The pendingCount is 0 . + // - There are no tasks that are running on container instances in the DRAINING + // status. + // - All tasks are reporting a healthy status from the load balancers, service + // discovery, and container health checks. + // If any of those conditions aren't met, the stability status returns STABILIZING . StabilityStatus StabilityStatus // The Unix timestamp for the time when the task set stability status was @@ -4357,44 +3889,33 @@ type TaskSet struct { StabilityStatusAt *time.Time // The tag specified when a task set is started. If an CodeDeploy deployment - // created the task set, the startedBy parameter is CODE_DEPLOY. If an external + // created the task set, the startedBy parameter is CODE_DEPLOY . If an external // deployment created the task set, the startedBy field isn't used. StartedBy *string - // The status of the task set. The following describes each state. PRIMARY The task - // set is serving production traffic. ACTIVE The task set isn't serving production - // traffic. DRAINING The tasks in the task set are being stopped, and their - // corresponding targets are being deregistered from their target group. + // The status of the task set. The following describes each state. PRIMARY The + // task set is serving production traffic. ACTIVE The task set isn't serving + // production traffic. DRAINING The tasks in the task set are being stopped, and + // their corresponding targets are being deregistered from their target group. Status *string // The metadata that you apply to the task set to help you categorize and organize // them. Each tag consists of a key and an optional value. You define both. The // following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50 - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8 - // - // * Maximum value length - 256 Unicode characters in UTF-8 - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case-sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for either keys or values as it is reserved for Amazon Web - // Services use. You cannot edit or delete tag keys or values with this prefix. - // Tags with this prefix do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50 + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8 + // - Maximum value length - 256 Unicode characters in UTF-8 + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case-sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for either keys or values as it is reserved for Amazon Web Services use. + // You cannot edit or delete tag keys or values with this prefix. Tags with this + // prefix do not count against your tags per resource limit. Tags []Tag // The task definition that the task set is using. @@ -4422,8 +3943,8 @@ type Tmpfs struct { // This member is required. Size int32 - // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | - // "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | + // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" + // | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | // "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | // "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | // "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | @@ -4434,12 +3955,12 @@ type Tmpfs struct { noSmithyDocumentSerde } -// The ulimit settings to pass to the container. Amazon ECS tasks hosted on Fargate -// use the default resource limit values set by the operating system with the -// exception of the nofile resource limit parameter which Fargate overrides. The -// nofile resource limit sets a restriction on the number of open files that a +// The ulimit settings to pass to the container. Amazon ECS tasks hosted on +// Fargate use the default resource limit values set by the operating system with +// the exception of the nofile resource limit parameter which Fargate overrides. +// The nofile resource limit sets a restriction on the number of open files that a // container can use. The default nofile soft limit is 1024 and the default hard -// limit is 4096. You can specify the ulimit settings for a container in a task +// limit is 4096 . You can specify the ulimit settings for a container in a task // definition. type Ulimit struct { @@ -4448,7 +3969,7 @@ type Ulimit struct { // This member is required. HardLimit int32 - // The type of the ulimit. + // The type of the ulimit . // // This member is required. Name UlimitName @@ -4480,17 +4001,17 @@ type VersionInfo struct { } // A data volume that's used in a task definition. For tasks that use the Amazon -// Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows -// tasks that use Amazon FSx for Windows File Server file system, specify a -// fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, -// specify a DockerVolumeConfiguration. For tasks that use a bind mount host -// volume, specify a host and optional sourcePath. For more information, see Using -// Data Volumes in Tasks -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). +// Elastic File System (Amazon EFS), specify an efsVolumeConfiguration . For +// Windows tasks that use Amazon FSx for Windows File Server file system, specify a +// fsxWindowsFileServerVolumeConfiguration . For tasks that use a Docker volume, +// specify a DockerVolumeConfiguration . For tasks that use a bind mount host +// volume, specify a host and optional sourcePath . For more information, see +// Using Data Volumes in Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) +// . type Volume struct { - // This parameter is specified when you use Docker volumes. Windows containers only - // support the use of the local driver. To use bind mounts, specify the host + // This parameter is specified when you use Docker volumes. Windows containers + // only support the use of the local driver. To use bind mounts, specify the host // parameter instead. Docker volumes aren't supported by tasks run on Fargate. DockerVolumeConfiguration *DockerVolumeConfiguration @@ -4498,8 +4019,8 @@ type Volume struct { // system for task storage. EfsVolumeConfiguration *EFSVolumeConfiguration - // This parameter is specified when you use Amazon FSx for Windows File Server file - // system for task storage. + // This parameter is specified when you use Amazon FSx for Windows File Server + // file system for task storage. FsxWindowsFileServerVolumeConfiguration *FSxWindowsFileServerVolumeConfiguration // This parameter is specified when you use bind mount host volumes. The contents @@ -4508,15 +4029,15 @@ type Volume struct { // empty, then the Docker daemon assigns a host path for your data volume. However, // the data isn't guaranteed to persist after the containers that are associated // with it stop running. Windows containers can mount whole directories on the same - // drive as $env:ProgramData. Windows containers can't mount directories on a + // drive as $env:ProgramData . Windows containers can't mount directories on a // different drive, and mount point can't be across drives. For example, you can - // mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or - // D:\:C:\my\path. + // mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or + // D:\:C:\my\path . Host *HostVolumeProperties // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, // underscores, and hyphens are allowed. This name is referenced in the - // sourceVolume parameter of container definition mountPoints. + // sourceVolume parameter of container definition mountPoints . Name *string noSmithyDocumentSerde @@ -4525,9 +4046,9 @@ type Volume struct { // Details on a data volume from another container in the same task definition. type VolumeFrom struct { - // If this value is true, the container has read-only access to the volume. If this - // value is false, then the container can write to the volume. The default value is - // false. + // If this value is true , the container has read-only access to the volume. If + // this value is false , then the container can write to the volume. The default + // value is false . ReadOnly *bool // The name of another container within the same task definition to mount volumes diff --git a/service/efs/api_client.go b/service/efs/api_client.go index 0b9d93d7696..d13bc0c8fea 100644 --- a/service/efs/api_client.go +++ b/service/efs/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/efs/api_op_CreateAccessPoint.go b/service/efs/api_op_CreateAccessPoint.go index 69b54773e64..2790762b0ea 100644 --- a/service/efs/api_op_CreateAccessPoint.go +++ b/service/efs/api_op_CreateAccessPoint.go @@ -19,13 +19,13 @@ import ( // the NFS client. The file system path is exposed as the access point's root // directory. Applications using the access point can only access data in the // application's own directory and any subdirectories. To learn more, see Mounting -// a file system using EFS access points -// (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html). If multiple -// requests to create access points on the same file system are sent in quick -// succession, and the file system is near the limit of 1000 access points, you may -// experience a throttling response for these requests. This is to ensure that the -// file system does not exceed the stated access point limit. This operation -// requires permissions for the elasticfilesystem:CreateAccessPoint action. +// a file system using EFS access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) +// . If multiple requests to create access points on the same file system are sent +// in quick succession, and the file system is near the limit of 1000 access +// points, you may experience a throttling response for these requests. This is to +// ensure that the file system does not exceed the stated access point limit. This +// operation requires permissions for the elasticfilesystem:CreateAccessPoint +// action. func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error) { if params == nil { params = &CreateAccessPointInput{} @@ -63,8 +63,8 @@ type CreateAccessPointInput struct { // access point. The clients using the access point can only access the root // directory and below. If the RootDirectory > Path specified does not exist, EFS // creates it and applies the CreationInfo settings when a client connects to an - // access point. When specifying a RootDirectory, you must provide the Path, and - // the CreationInfo. Amazon EFS creates a root directory only if you have provided + // access point. When specifying a RootDirectory , you must provide the Path , and + // the CreationInfo . Amazon EFS creates a root directory only if you have provided // the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do // not provide this information, Amazon EFS does not create the root directory. If // the root directory does not exist, attempts to mount using the access point will @@ -109,8 +109,8 @@ type CreateAccessPointOutput struct { // using the access point. PosixUser *types.PosixUser - // The directory on the Amazon EFS file system that the access point exposes as the - // root directory to NFS clients using the access point. + // The directory on the Amazon EFS file system that the access point exposes as + // the root directory to NFS clients using the access point. RootDirectory *types.RootDirectory // The tags associated with the access point, presented as an array of Tag objects. diff --git a/service/efs/api_op_CreateFileSystem.go b/service/efs/api_op_CreateFileSystem.go index 713598fffeb..84810481dd1 100644 --- a/service/efs/api_op_CreateFileSystem.go +++ b/service/efs/api_op_CreateFileSystem.go @@ -13,33 +13,27 @@ import ( "time" ) -// Creates a new, empty file system. The operation requires a creation token in the -// request that Amazon EFS uses to ensure idempotent creation (calling the +// Creates a new, empty file system. The operation requires a creation token in +// the request that Amazon EFS uses to ensure idempotent creation (calling the // operation with same creation token has no effect). If a file system does not // currently exist that is owned by the caller's Amazon Web Services account with // the specified creation token, this operation does the following: +// - Creates a new, empty file system. The file system will have an Amazon EFS +// assigned ID, and an initial lifecycle state creating . +// - Returns with the description of the created file system. // -// * Creates a -// new, empty file system. The file system will have an Amazon EFS assigned ID, and -// an initial lifecycle state creating. -// -// * Returns with the description of the -// created file system. -// -// Otherwise, this operation returns a -// FileSystemAlreadyExists error with the ID of the existing file system. For basic -// use cases, you can use a randomly generated UUID for the creation token. The -// idempotent operation allows you to retry a CreateFileSystem call without risk of -// creating an extra file system. This can happen when an initial call fails in a -// way that leaves it uncertain whether or not a file system was actually created. -// An example might be that a transport level timeout occurred or your connection -// was reset. As long as you use the same creation token, if the initial call had -// succeeded in creating a file system, the client can learn of its existence from -// the FileSystemAlreadyExists error. For more information, see Creating a file -// system -// (https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1) +// Otherwise, this operation returns a FileSystemAlreadyExists error with the ID +// of the existing file system. For basic use cases, you can use a randomly +// generated UUID for the creation token. The idempotent operation allows you to +// retry a CreateFileSystem call without risk of creating an extra file system. +// This can happen when an initial call fails in a way that leaves it uncertain +// whether or not a file system was actually created. An example might be that a +// transport level timeout occurred or your connection was reset. As long as you +// use the same creation token, if the initial call had succeeded in creating a +// file system, the client can learn of its existence from the +// FileSystemAlreadyExists error. For more information, see Creating a file system (https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1) // in the Amazon EFS User Guide. The CreateFileSystem call returns while the file -// system's lifecycle state is still creating. You can check the file system +// system's lifecycle state is still creating . You can check the file system // creation status by calling the DescribeFileSystems operation, which among other // things returns the file system state. This operation accepts an optional // PerformanceMode parameter that you choose for your file system. We recommend @@ -47,16 +41,15 @@ import ( // maxIO performance mode can scale to higher levels of aggregate throughput and // operations per second with a tradeoff of slightly higher latencies for most file // operations. The performance mode can't be changed after the file system has been -// created. For more information, see Amazon EFS performance modes -// (https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html). -// You can set the throughput mode for the file system using the ThroughputMode +// created. For more information, see Amazon EFS performance modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html) +// . You can set the throughput mode for the file system using the ThroughputMode // parameter. After the file system is fully created, Amazon EFS sets its lifecycle -// state to available, at which point you can create one or more mount targets for -// the file system in your VPC. For more information, see CreateMountTarget. You +// state to available , at which point you can create one or more mount targets for +// the file system in your VPC. For more information, see CreateMountTarget . You // mount your Amazon EFS file system on an EC2 instances in your VPC by using the -// mount target. For more information, see Amazon EFS: How it Works -// (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html). This operation -// requires permissions for the elasticfilesystem:CreateFileSystem action. +// mount target. For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html) +// . This operation requires permissions for the elasticfilesystem:CreateFileSystem +// action. func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemInput, optFns ...func(*Options)) (*CreateFileSystemOutput, error) { if params == nil { params = &CreateFileSystemInput{} @@ -74,96 +67,84 @@ func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemI type CreateFileSystemInput struct { - // A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent - // creation. + // A string of up to 64 ASCII characters. Amazon EFS uses this to ensure + // idempotent creation. // // This member is required. CreationToken *string // Used to create a file system that uses One Zone storage classes. It specifies // the Amazon Web Services Availability Zone in which to create the file system. - // Use the format us-east-1a to specify the Availability Zone. For more information - // about One Zone storage classes, see Using EFS storage classes - // (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon - // EFS User Guide. One Zone storage classes are not available in all Availability - // Zones in Amazon Web Services Regions where Amazon EFS is available. + // Use the format us-east-1a to specify the Availability Zone. For more + // information about One Zone storage classes, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // in the Amazon EFS User Guide. One Zone storage classes are not available in all + // Availability Zones in Amazon Web Services Regions where Amazon EFS is available. AvailabilityZoneName *string // Specifies whether automatic backups are enabled on the file system that you are - // creating. Set the value to true to enable automatic backups. If you are creating - // a file system that uses One Zone storage classes, automatic backups are enabled - // by default. For more information, see Automatic backups - // (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups) in - // the Amazon EFS User Guide. Default is false. However, if you specify an - // AvailabilityZoneName, the default is true. Backup is not available in all Amazon - // Web Services Regions where Amazon EFS is available. + // creating. Set the value to true to enable automatic backups. If you are + // creating a file system that uses One Zone storage classes, automatic backups are + // enabled by default. For more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups) + // in the Amazon EFS User Guide. Default is false . However, if you specify an + // AvailabilityZoneName , the default is true . Backup is not available in all + // Amazon Web Services Regions where Amazon EFS is available. Backup *bool // A Boolean value that, if true, creates an encrypted file system. When creating // an encrypted file system, you have the option of specifying an existing Key // Management Service key (KMS key). If you don't specify a KMS key, then the - // default KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect the + // default KMS key for Amazon EFS, /aws/elasticfilesystem , is used to protect the // encrypted file system. Encrypted *bool - // The ID of the KMS key that you want to use to protect the encrypted file system. - // This parameter is required only if you want to use a non-default KMS key. If - // this parameter is not specified, the default KMS key for Amazon EFS is used. You - // can specify a KMS key ID using the following formats: - // - // * Key ID - A unique - // identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * ARN - // - An Amazon Resource Name (ARN) for the key, for example - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Key alias - A previously created display name for a key, for example - // alias/projectKey1. - // - // * Key alias ARN - An ARN for a key alias, for example - // arn:aws:kms:us-west-2:444455556666:alias/projectKey1. - // - // If you use KmsKeyId, you - // must set the CreateFileSystemRequest$Encrypted parameter to true. EFS accepts - // only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file - // systems. + // The ID of the KMS key that you want to use to protect the encrypted file + // system. This parameter is required only if you want to use a non-default KMS + // key. If this parameter is not specified, the default KMS key for Amazon EFS is + // used. You can specify a KMS key ID using the following formats: + // - Key ID - A unique identifier of the key, for example + // 1234abcd-12ab-34cd-56ef-1234567890ab . + // - ARN - An Amazon Resource Name (ARN) for the key, for example + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Key alias - A previously created display name for a key, for example + // alias/projectKey1 . + // - Key alias ARN - An ARN for a key alias, for example + // arn:aws:kms:us-west-2:444455556666:alias/projectKey1 . + // If you use KmsKeyId , you must set the CreateFileSystemRequest$Encrypted + // parameter to true. EFS accepts only symmetric KMS keys. You cannot use + // asymmetric KMS keys with Amazon EFS file systems. KmsKeyId *string - // The performance mode of the file system. We recommend generalPurpose performance - // mode for most file systems. File systems using the maxIO performance mode can - // scale to higher levels of aggregate throughput and operations per second with a - // tradeoff of slightly higher latencies for most file operations. The performance - // mode can't be changed after the file system has been created. The maxIO mode is - // not supported on file systems using One Zone storage classes. + // The performance mode of the file system. We recommend generalPurpose + // performance mode for most file systems. File systems using the maxIO + // performance mode can scale to higher levels of aggregate throughput and + // operations per second with a tradeoff of slightly higher latencies for most file + // operations. The performance mode can't be changed after the file system has been + // created. The maxIO mode is not supported on file systems using One Zone storage + // classes. PerformanceMode types.PerformanceMode // The throughput, measured in MiB/s, that you want to provision for a file system - // that you're creating. Valid values are 1-1024. Required if ThroughputMode is set - // to provisioned. The upper limit for throughput is 1024 MiB/s. To increase this - // limit, contact Amazon Web Services Support. For more information, see Amazon EFS - // quotas that you can increase - // (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the - // Amazon EFS User Guide. + // that you're creating. Valid values are 1-1024. Required if ThroughputMode is + // set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase + // this limit, contact Amazon Web Services Support. For more information, see + // Amazon EFS quotas that you can increase (https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) + // in the Amazon EFS User Guide. ProvisionedThroughputInMibps *float64 // Use to create one or more tags associated with the file system. Each tag is a // user-defined key-value pair. Name your file system on creation by including a // "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more - // information, see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []types.Tag - // Specifies the throughput mode for the file system. The mode can be bursting, - // provisioned, or elastic. If you set ThroughputMode to provisioned, you must also - // set a value for ProvisionedThroughputInMibps. After you create the file system, - // you can decrease your file system's throughput in Provisioned Throughput mode or - // change between the throughput modes, with certain time restrictions. For more - // information, see Specifying throughput with provisioned mode - // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) - // in the Amazon EFS User Guide. Default is bursting. + // Specifies the throughput mode for the file system. The mode can be bursting , + // provisioned , or elastic . If you set ThroughputMode to provisioned , you must + // also set a value for ProvisionedThroughputInMibps . After you create the file + // system, you can decrease your file system's throughput in Provisioned Throughput + // mode or change between the throughput modes, with certain time restrictions. For + // more information, see Specifying throughput with provisioned mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) + // in the Amazon EFS User Guide. Default is bursting . ThroughputMode types.ThroughputMode noSmithyDocumentSerde @@ -194,7 +175,7 @@ type CreateFileSystemOutput struct { LifeCycleState types.LifeCycleState // The current number of mount targets that the file system has. For more - // information, see CreateMountTarget. + // information, see CreateMountTarget . // // This member is required. NumberOfMountTargets int32 @@ -235,17 +216,16 @@ type CreateFileSystemOutput struct { // Describes the Amazon Web Services Availability Zone in which the file system is // located, and is valid only for file systems using One Zone storage classes. For - // more information, see Using EFS storage classes - // (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon - // EFS User Guide. + // more information, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // in the Amazon EFS User Guide. AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . + // Example with sample data: // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 FileSystemArn *string @@ -253,18 +233,17 @@ type CreateFileSystemOutput struct { KmsKeyId *string // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the - // value in this field. + // see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns + // the value in this field. Name *string // The amount of provisioned throughput, measured in MiB/s, for the file system. - // Valid for file systems using ThroughputMode set to provisioned. + // Valid for file systems using ThroughputMode set to provisioned . ProvisionedThroughputInMibps *float64 - // Displays the file system's throughput mode. For more information, see Throughput - // modes - // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) in - // the Amazon EFS User Guide. + // Displays the file system's throughput mode. For more information, see + // Throughput modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) + // in the Amazon EFS User Guide. ThroughputMode types.ThroughputMode // Metadata pertaining to the operation's result. diff --git a/service/efs/api_op_CreateMountTarget.go b/service/efs/api_op_CreateMountTarget.go index 7d1193574af..135c41916c5 100644 --- a/service/efs/api_op_CreateMountTarget.go +++ b/service/efs/api_op_CreateMountTarget.go @@ -23,104 +23,70 @@ import ( // located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the // DescribeFileSystems response object to get this information. Use the subnetId // associated with the file system's Availability Zone when creating the mount -// target. For more information, see Amazon EFS: How it Works -// (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html). To create a mount -// target for a file system, the file system's lifecycle state must be available. -// For more information, see DescribeFileSystems. In the request, provide the -// following: -// -// * The file system ID for which you are creating the mount target. -// -// * -// A subnet ID, which determines the following: -// -// * The VPC in which Amazon EFS -// creates the mount target -// -// * The Availability Zone in which Amazon EFS creates -// the mount target -// -// * The IP address range from which Amazon EFS selects the IP -// address of the mount target (if you don't specify an IP address in the -// request) -// -// After creating the mount target, Amazon EFS returns a response that -// includes, a MountTargetId and an IpAddress. You use this IP address when -// mounting the file system in an EC2 instance. You can also use the mount target's -// DNS name when mounting the file system. The EC2 instance on which you mount the -// file system by using the mount target can resolve the mount target's DNS name to -// its IP address. For more information, see How it Works: Implementation Overview -// (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation). -// Note that you can create mount targets for a file system in only one VPC, and +// target. For more information, see Amazon EFS: How it Works (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html) +// . To create a mount target for a file system, the file system's lifecycle state +// must be available . For more information, see DescribeFileSystems . In the +// request, provide the following: +// - The file system ID for which you are creating the mount target. +// - A subnet ID, which determines the following: +// - The VPC in which Amazon EFS creates the mount target +// - The Availability Zone in which Amazon EFS creates the mount target +// - The IP address range from which Amazon EFS selects the IP address of the +// mount target (if you don't specify an IP address in the request) +// +// After creating the mount target, Amazon EFS returns a response that includes, a +// MountTargetId and an IpAddress . You use this IP address when mounting the file +// system in an EC2 instance. You can also use the mount target's DNS name when +// mounting the file system. The EC2 instance on which you mount the file system by +// using the mount target can resolve the mount target's DNS name to its IP +// address. For more information, see How it Works: Implementation Overview (https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation) +// . Note that you can create mount targets for a file system in only one VPC, and // there can be only one mount target per Availability Zone. That is, if the file // system already has one or more mount targets created for it, the subnet // specified in the request to add another mount target must meet the following // requirements: -// -// * Must belong to the same VPC as the subnets of the existing -// mount targets -// -// * Must not be in the same Availability Zone as any of the subnets -// of the existing mount targets -// -// If the request satisfies the requirements, Amazon -// EFS does the following: -// -// * Creates a new mount target in the specified -// subnet. -// -// * Also creates a new network interface in the subnet as follows: -// -// * If -// the request provides an IpAddress, Amazon EFS assigns that IP address to the -// network interface. Otherwise, Amazon EFS assigns a free address in the subnet -// (in the same way that the Amazon EC2 CreateNetworkInterface call does when a -// request does not specify a primary private IP address). -// -// * If the request -// provides SecurityGroups, this network interface is associated with those -// security groups. Otherwise, it belongs to the default security group for the -// subnet's VPC. -// -// * Assigns the description Mount target fsmt-id for file system -// fs-id where fsmt-id is the mount target ID, and fs-id is the -// FileSystemId. -// -// * Sets the requesterManaged property of the network interface to -// true, and the requesterId value to EFS. -// -// Each Amazon EFS mount target has one -// corresponding requester-managed EC2 network interface. After the network -// interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount -// target's description to the network interface ID, and the IpAddress field to its -// address. If network interface creation fails, the entire CreateMountTarget -// operation fails. -// -// The CreateMountTarget call returns only after creating the -// network interface, but while the mount target state is still creating, you can -// check the mount target creation status by calling the DescribeMountTargets -// operation, which among other things returns the mount target state. We recommend -// that you create a mount target in each of the Availability Zones. There are cost -// considerations for using a file system in an Availability Zone through a mount -// target created in another Availability Zone. For more information, see Amazon -// EFS (http://aws.amazon.com/efs/). In addition, by always using a mount target -// local to the instance's Availability Zone, you eliminate a partial failure -// scenario. If the Availability Zone in which your mount target is created goes -// down, then you can't access your file system through that mount target. This -// operation requires permissions for the following action on the file system: -// -// * -// elasticfilesystem:CreateMountTarget -// -// This operation also requires permissions -// for the following Amazon EC2 actions: -// -// * ec2:DescribeSubnets -// -// * -// ec2:DescribeNetworkInterfaces -// -// * ec2:CreateNetworkInterface +// - Must belong to the same VPC as the subnets of the existing mount targets +// - Must not be in the same Availability Zone as any of the subnets of the +// existing mount targets +// +// If the request satisfies the requirements, Amazon EFS does the following: +// - Creates a new mount target in the specified subnet. +// - Also creates a new network interface in the subnet as follows: +// - If the request provides an IpAddress , Amazon EFS assigns that IP address to +// the network interface. Otherwise, Amazon EFS assigns a free address in the +// subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does +// when a request does not specify a primary private IP address). +// - If the request provides SecurityGroups , this network interface is +// associated with those security groups. Otherwise, it belongs to the default +// security group for the subnet's VPC. +// - Assigns the description Mount target fsmt-id for file system fs-id where +// fsmt-id is the mount target ID, and fs-id is the FileSystemId . +// - Sets the requesterManaged property of the network interface to true , and +// the requesterId value to EFS . Each Amazon EFS mount target has one +// corresponding requester-managed EC2 network interface. After the network +// interface is created, Amazon EFS sets the NetworkInterfaceId field in the +// mount target's description to the network interface ID, and the IpAddress +// field to its address. If network interface creation fails, the entire +// CreateMountTarget operation fails. +// +// The CreateMountTarget call returns only after creating the network interface, +// but while the mount target state is still creating , you can check the mount +// target creation status by calling the DescribeMountTargets operation, which +// among other things returns the mount target state. We recommend that you create +// a mount target in each of the Availability Zones. There are cost considerations +// for using a file system in an Availability Zone through a mount target created +// in another Availability Zone. For more information, see Amazon EFS (http://aws.amazon.com/efs/) +// . In addition, by always using a mount target local to the instance's +// Availability Zone, you eliminate a partial failure scenario. If the Availability +// Zone in which your mount target is created goes down, then you can't access your +// file system through that mount target. This operation requires permissions for +// the following action on the file system: +// - elasticfilesystem:CreateMountTarget +// +// This operation also requires permissions for the following Amazon EC2 actions: +// - ec2:DescribeSubnets +// - ec2:DescribeNetworkInterfaces +// - ec2:CreateNetworkInterface func (c *Client) CreateMountTarget(ctx context.Context, params *CreateMountTargetInput, optFns ...func(*Options)) (*CreateMountTargetOutput, error) { if params == nil { params = &CreateMountTargetInput{} @@ -153,7 +119,7 @@ type CreateMountTargetInput struct { // Valid IPv4 address within the address range of the specified subnet. IpAddress *string - // Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for + // Up to five VPC security group IDs, of the form sg-xxxxxxxx . These must be for // the same VPC as subnet specified. SecurityGroups []string diff --git a/service/efs/api_op_CreateReplicationConfiguration.go b/service/efs/api_op_CreateReplicationConfiguration.go index cef3f37eb1b..b55a325d927 100644 --- a/service/efs/api_op_CreateReplicationConfiguration.go +++ b/service/efs/api_op_CreateReplicationConfiguration.go @@ -17,64 +17,48 @@ import ( // replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) in // the Amazon EFS User Guide. The replication configuration specifies the // following: +// - Source file system - An existing EFS file system that you want replicated. +// The source file system cannot be a destination file system in an existing +// replication configuration. +// - Destination file system configuration - The configuration of the +// destination file system to which the source file system will be replicated. +// There can only be one destination file system in a replication configuration. +// The destination file system configuration consists of the following properties: +// - Amazon Web Services Region - The Amazon Web Services Region in which the +// destination file system is created. Amazon EFS replication is available in all +// Amazon Web Services Regions that Amazon EFS is available in, except Africa (Cape +// Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe (Milan), and +// Middle East (Bahrain). +// - Availability Zone - If you want the destination file system to use EFS One +// Zone availability and durability, you must specify the Availability Zone to +// create the file system in. For more information about EFS storage classes, see +// Amazon EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) +// in the Amazon EFS User Guide. +// - Encryption - All destination file systems are created with encryption at +// rest enabled. You can specify the Key Management Service (KMS) key that is used +// to encrypt the destination file system. If you don't specify a KMS key, your +// service-managed KMS key for Amazon EFS is used. After the file system is +// created, you cannot change the KMS key. // -// * Source file system - An existing EFS file system that you want -// replicated. The source file system cannot be a destination file system in an -// existing replication configuration. -// -// * Destination file system configuration - -// The configuration of the destination file system to which the source file system -// will be replicated. There can only be one destination file system in a -// replication configuration. The destination file system configuration consists of -// the following properties: -// -// * Amazon Web Services Region - The Amazon Web -// Services Region in which the destination file system is created. Amazon EFS -// replication is available in all Amazon Web Services Regions that Amazon EFS is -// available in, except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific -// (Jakarta), Europe (Milan), and Middle East (Bahrain). -// -// * Availability Zone - If -// you want the destination file system to use EFS One Zone availability and -// durability, you must specify the Availability Zone to create the file system in. -// For more information about EFS storage classes, see Amazon EFS storage classes -// (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon -// EFS User Guide. -// -// * Encryption - All destination file systems are created with -// encryption at rest enabled. You can specify the Key Management Service (KMS) key -// that is used to encrypt the destination file system. If you don't specify a KMS -// key, your service-managed KMS key for Amazon EFS is used. After the file system -// is created, you cannot change the KMS key. -// -// The following properties are set by -// default: -// -// * Performance mode - The destination file system's performance mode -// matches that of the source file system, unless the destination file system uses -// EFS One Zone storage. In that case, the General Purpose performance mode is -// used. The performance mode cannot be changed. -// -// * Throughput mode - The -// destination file system's throughput mode matches that of the source file -// system. After the file system is created, you can modify the throughput -// mode. +// The following properties are set by default: +// - Performance mode - The destination file system's performance mode matches +// that of the source file system, unless the destination file system uses EFS One +// Zone storage. In that case, the General Purpose performance mode is used. The +// performance mode cannot be changed. +// - Throughput mode - The destination file system's throughput mode matches +// that of the source file system. After the file system is created, you can modify +// the throughput mode. // // The following properties are turned off by default: +// - Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering +// are not enabled on the destination file system. After the destination file +// system is created, you can enable EFS lifecycle management and EFS +// Intelligent-Tiering. +// - Automatic backups - Automatic daily backups not enabled on the destination +// file system. After the file system is created, you can change this setting. // -// * Lifecycle -// management - EFS lifecycle management and EFS Intelligent-Tiering are not -// enabled on the destination file system. After the destination file system is -// created, you can enable EFS lifecycle management and EFS Intelligent-Tiering. -// -// * -// Automatic backups - Automatic daily backups not enabled on the destination file -// system. After the file system is created, you can change this setting. -// -// For more -// information, see Amazon EFS replication -// (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) in the Amazon -// EFS User Guide. +// For more information, see Amazon EFS replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) +// in the Amazon EFS User Guide. func (c *Client) CreateReplicationConfiguration(ctx context.Context, params *CreateReplicationConfigurationInput, optFns ...func(*Options)) (*CreateReplicationConfigurationOutput, error) { if params == nil { params = &CreateReplicationConfigurationInput{} diff --git a/service/efs/api_op_CreateTags.go b/service/efs/api_op_CreateTags.go index 0674d9b158e..76039f532f7 100644 --- a/service/efs/api_op_CreateTags.go +++ b/service/efs/api_op_CreateTags.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS -// resources, use the API action. Creates or overwrites tags associated with a file -// system. Each tag is a key-value pair. If a tag key specified in the request +// DEPRECATED - CreateTags is deprecated and not maintained. To create tags for +// EFS resources, use the API action. Creates or overwrites tags associated with a +// file system. Each tag is a key-value pair. If a tag key specified in the request // already exists on the file system, this operation overwrites its value with the // value provided in the request. If you add the Name tag to your file system, -// Amazon EFS returns it in the response to the DescribeFileSystems operation. This -// operation requires permission for the elasticfilesystem:CreateTags action. +// Amazon EFS returns it in the response to the DescribeFileSystems operation. +// This operation requires permission for the elasticfilesystem:CreateTags action. // // Deprecated: Use TagResource. func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error) { @@ -37,8 +37,8 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns type CreateTagsInput struct { - // The ID of the file system whose tags you want to modify (String). This operation - // modifies the tags only, not the file system. + // The ID of the file system whose tags you want to modify (String). This + // operation modifies the tags only, not the file system. // // This member is required. FileSystemId *string diff --git a/service/efs/api_op_DeleteFileSystem.go b/service/efs/api_op_DeleteFileSystem.go index 8889701f160..584578d4ba2 100644 --- a/service/efs/api_op_DeleteFileSystem.go +++ b/service/efs/api_op_DeleteFileSystem.go @@ -10,21 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a file system, permanently severing access to its contents. Upon return, -// the file system no longer exists and you can't access any contents of the -// deleted file system. You need to manually delete mount targets attached to a +// Deletes a file system, permanently severing access to its contents. Upon +// return, the file system no longer exists and you can't access any contents of +// the deleted file system. You need to manually delete mount targets attached to a // file system before you can delete an EFS file system. This step is performed for // you when you use the Amazon Web Services console to delete a file system. You // cannot delete a file system that is part of an EFS Replication configuration. // You need to delete the replication configuration first. You can't delete a file // system that is in use. That is, if the file system has any mount targets, you // must first delete them. For more information, see DescribeMountTargets and -// DeleteMountTarget. The DeleteFileSystem call returns while the file system state -// is still deleting. You can check the file system deletion status by calling the -// DescribeFileSystems operation, which returns a list of file systems in your -// account. If you pass file system ID or creation token for the deleted file -// system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This -// operation requires permissions for the elasticfilesystem:DeleteFileSystem +// DeleteMountTarget . The DeleteFileSystem call returns while the file system +// state is still deleting . You can check the file system deletion status by +// calling the DescribeFileSystems operation, which returns a list of file systems +// in your account. If you pass file system ID or creation token for the deleted +// file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. +// This operation requires permissions for the elasticfilesystem:DeleteFileSystem // action. func (c *Client) DeleteFileSystem(ctx context.Context, params *DeleteFileSystemInput, optFns ...func(*Options)) (*DeleteFileSystemOutput, error) { if params == nil { diff --git a/service/efs/api_op_DeleteFileSystemPolicy.go b/service/efs/api_op_DeleteFileSystemPolicy.go index 4b7afbbc4b0..f5a816b1d5b 100644 --- a/service/efs/api_op_DeleteFileSystemPolicy.go +++ b/service/efs/api_op_DeleteFileSystemPolicy.go @@ -13,10 +13,9 @@ import ( // Deletes the FileSystemPolicy for the specified file system. The default // FileSystemPolicy goes into effect once the existing policy is deleted. For more // information about the default file system policy, see Using Resource-based -// Policies with EFS -// (https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html). This -// operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy -// action. +// Policies with EFS (https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html) +// . This operation requires permissions for the +// elasticfilesystem:DeleteFileSystemPolicy action. func (c *Client) DeleteFileSystemPolicy(ctx context.Context, params *DeleteFileSystemPolicyInput, optFns ...func(*Options)) (*DeleteFileSystemPolicyOutput, error) { if params == nil { params = &DeleteFileSystemPolicyInput{} @@ -34,7 +33,7 @@ func (c *Client) DeleteFileSystemPolicy(ctx context.Context, params *DeleteFileS type DeleteFileSystemPolicyInput struct { - // Specifies the EFS file system for which to delete the FileSystemPolicy. + // Specifies the EFS file system for which to delete the FileSystemPolicy . // // This member is required. FileSystemId *string diff --git a/service/efs/api_op_DeleteMountTarget.go b/service/efs/api_op_DeleteMountTarget.go index 9bd45cc91bb..83432a65309 100644 --- a/service/efs/api_op_DeleteMountTarget.go +++ b/service/efs/api_op_DeleteMountTarget.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified mount target. This operation forcibly breaks any mounts of -// the file system by using the mount target that is being deleted, which might +// Deletes the specified mount target. This operation forcibly breaks any mounts +// of the file system by using the mount target that is being deleted, which might // disrupt instances or applications using those mounts. To avoid applications // getting cut off abruptly, you might consider unmounting any mounts of the mount // target, if feasible. The operation also deletes the associated network @@ -20,17 +20,14 @@ import ( // created remains. You can mount an EC2 instance in your VPC by using another // mount target. This operation requires permissions for the following action on // the file system: +// - elasticfilesystem:DeleteMountTarget // -// * elasticfilesystem:DeleteMountTarget -// -// The DeleteMountTarget -// call returns while the mount target state is still deleting. You can check the -// mount target deletion by calling the DescribeMountTargets operation, which -// returns a list of mount target descriptions for the given file system. The -// operation also requires permissions for the following Amazon EC2 action on the -// mount target's network interface: -// -// * ec2:DeleteNetworkInterface +// The DeleteMountTarget call returns while the mount target state is still +// deleting . You can check the mount target deletion by calling the +// DescribeMountTargets operation, which returns a list of mount target +// descriptions for the given file system. The operation also requires permissions +// for the following Amazon EC2 action on the mount target's network interface: +// - ec2:DeleteNetworkInterface func (c *Client) DeleteMountTarget(ctx context.Context, params *DeleteMountTargetInput, optFns ...func(*Options)) (*DeleteMountTargetOutput, error) { if params == nil { params = &DeleteMountTargetInput{} diff --git a/service/efs/api_op_DeleteReplicationConfiguration.go b/service/efs/api_op_DeleteReplicationConfiguration.go index 28b293fc00d..779c470d389 100644 --- a/service/efs/api_op_DeleteReplicationConfiguration.go +++ b/service/efs/api_op_DeleteReplicationConfiguration.go @@ -15,7 +15,7 @@ import ( // which the destination file system is located. Deleting a replication // configuration ends the replication process. After a replication configuration is // deleted, the destination file system is no longer read-only. You can write to -// the destination file system after its status becomes Writeable. +// the destination file system after its status becomes Writeable . func (c *Client) DeleteReplicationConfiguration(ctx context.Context, params *DeleteReplicationConfigurationInput, optFns ...func(*Options)) (*DeleteReplicationConfigurationOutput, error) { if params == nil { params = &DeleteReplicationConfigurationInput{} diff --git a/service/efs/api_op_DeleteTags.go b/service/efs/api_op_DeleteTags.go index 9a7665ca712..980d8189c21 100644 --- a/service/efs/api_op_DeleteTags.go +++ b/service/efs/api_op_DeleteTags.go @@ -14,8 +14,7 @@ import ( // EFS resources, use the API action. Deletes the specified tags from a file // system. If the DeleteTags request includes a tag key that doesn't exist, Amazon // EFS ignores it and doesn't cause an error. For more information about tags and -// related restrictions, see Tag restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// related restrictions, see Tag restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management User Guide. This operation requires // permissions for the elasticfilesystem:DeleteTags action. // diff --git a/service/efs/api_op_DescribeAccessPoints.go b/service/efs/api_op_DescribeAccessPoints.go index 1763b89af3c..b09b30b123a 100644 --- a/service/efs/api_op_DescribeAccessPoints.go +++ b/service/efs/api_op_DescribeAccessPoints.go @@ -13,7 +13,7 @@ import ( ) // Returns the description of a specific Amazon EFS access point if the -// AccessPointId is provided. If you provide an EFS FileSystemId, it returns +// AccessPointId is provided. If you provide an EFS FileSystemId , it returns // descriptions of all access points for that file system. You can provide either // an AccessPointId or a FileSystemId in the request, but not both. This operation // requires permissions for the elasticfilesystem:DescribeAccessPoints action. @@ -35,11 +35,11 @@ func (c *Client) DescribeAccessPoints(ctx context.Context, params *DescribeAcces type DescribeAccessPointsInput struct { // (Optional) Specifies an EFS access point to describe in the response; mutually - // exclusive with FileSystemId. + // exclusive with FileSystemId . AccessPointId *string - // (Optional) If you provide a FileSystemId, EFS returns all access points for that - // file system; mutually exclusive with AccessPointId. + // (Optional) If you provide a FileSystemId , EFS returns all access points for + // that file system; mutually exclusive with AccessPointId . FileSystemId *string // (Optional) When retrieving all access points for a file system, you can @@ -47,8 +47,8 @@ type DescribeAccessPointsInput struct { // returned in a response. The default value is 100. MaxResults *int32 - // NextToken is present if the response is paginated. You can use NextMarker in the - // subsequent request to fetch the next page of access point descriptions. + // NextToken is present if the response is paginated. You can use NextMarker in + // the subsequent request to fetch the next page of access point descriptions. NextToken *string noSmithyDocumentSerde diff --git a/service/efs/api_op_DescribeAccountPreferences.go b/service/efs/api_op_DescribeAccountPreferences.go index f3d1721f3f5..5d1ba5852d1 100644 --- a/service/efs/api_op_DescribeAccountPreferences.go +++ b/service/efs/api_op_DescribeAccountPreferences.go @@ -13,7 +13,7 @@ import ( // Returns the account preferences settings for the Amazon Web Services account // associated with the user making the request, in the current Amazon Web Services -// Region. For more information, see Managing Amazon EFS resource IDs. +// Region. For more information, see Managing Amazon EFS resource IDs . func (c *Client) DescribeAccountPreferences(ctx context.Context, params *DescribeAccountPreferencesInput, optFns ...func(*Options)) (*DescribeAccountPreferencesOutput, error) { if params == nil { params = &DescribeAccountPreferencesInput{} @@ -46,13 +46,13 @@ type DescribeAccountPreferencesInput struct { type DescribeAccountPreferencesOutput struct { - // Present if there are more records than returned in the response. You can use the - // NextToken in the subsequent request to fetch the additional descriptions. + // Present if there are more records than returned in the response. You can use + // the NextToken in the subsequent request to fetch the additional descriptions. NextToken *string - // Describes the resource ID preference setting for the Amazon Web Services account - // associated with the user making the request, in the current Amazon Web Services - // Region. + // Describes the resource ID preference setting for the Amazon Web Services + // account associated with the user making the request, in the current Amazon Web + // Services Region. ResourceIdPreference *types.ResourceIdPreference // Metadata pertaining to the operation's result. diff --git a/service/efs/api_op_DescribeFileSystems.go b/service/efs/api_op_DescribeFileSystems.go index 0e75f3a9b91..7605afd216f 100644 --- a/service/efs/api_op_DescribeFileSystems.go +++ b/service/efs/api_op_DescribeFileSystems.go @@ -19,16 +19,16 @@ import ( // When retrieving all file system descriptions, you can optionally specify the // MaxItems parameter to limit the number of descriptions in a response. This // number is automatically set to 100. If more file system descriptions remain, -// Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, -// you should send a subsequent request with the Marker request parameter set to -// the value of NextMarker. To retrieve a list of your file system descriptions, -// this operation is used in an iterative process, where DescribeFileSystems is -// called first without the Marker and then the operation continues to call it with -// the Marker parameter set to the value of the NextMarker from the previous -// response until the response has no NextMarker. The order of file systems -// returned in the response of one DescribeFileSystems call and the order of file -// systems returned across the responses of a multi-call iteration is unspecified. -// This operation requires permissions for the +// Amazon EFS returns a NextMarker , an opaque token, in the response. In this +// case, you should send a subsequent request with the Marker request parameter +// set to the value of NextMarker . To retrieve a list of your file system +// descriptions, this operation is used in an iterative process, where +// DescribeFileSystems is called first without the Marker and then the operation +// continues to call it with the Marker parameter set to the value of the +// NextMarker from the previous response until the response has no NextMarker . The +// order of file systems returned in the response of one DescribeFileSystems call +// and the order of file systems returned across the responses of a multi-call +// iteration is unspecified. This operation requires permissions for the // elasticfilesystem:DescribeFileSystems action. func (c *Client) DescribeFileSystems(ctx context.Context, params *DescribeFileSystemsInput, optFns ...func(*Options)) (*DescribeFileSystemsOutput, error) { if params == nil { @@ -147,8 +147,8 @@ func (c *Client) addOperationDescribeFileSystemsMiddlewares(stack *middleware.St return nil } -// DescribeFileSystemsAPIClient is a client that implements the DescribeFileSystems -// operation. +// DescribeFileSystemsAPIClient is a client that implements the +// DescribeFileSystems operation. type DescribeFileSystemsAPIClient interface { DescribeFileSystems(context.Context, *DescribeFileSystemsInput, ...func(*Options)) (*DescribeFileSystemsOutput, error) } diff --git a/service/efs/api_op_DescribeLifecycleConfiguration.go b/service/efs/api_op_DescribeLifecycleConfiguration.go index 06388956378..ec876e4fd6b 100644 --- a/service/efs/api_op_DescribeLifecycleConfiguration.go +++ b/service/efs/api_op_DescribeLifecycleConfiguration.go @@ -16,7 +16,7 @@ import ( // identify which files to move to the EFS Infrequent Access (IA) storage class. // For a file system without a LifecycleConfiguration object, the call returns an // empty array in the response. When EFS Intelligent-Tiering is enabled, -// TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS. This operation +// TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS . This operation // requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration // operation. func (c *Client) DescribeLifecycleConfiguration(ctx context.Context, params *DescribeLifecycleConfigurationInput, optFns ...func(*Options)) (*DescribeLifecycleConfigurationOutput, error) { diff --git a/service/efs/api_op_DescribeMountTargetSecurityGroups.go b/service/efs/api_op_DescribeMountTargetSecurityGroups.go index 4ae6db567ac..b9cec87c7f2 100644 --- a/service/efs/api_op_DescribeMountTargetSecurityGroups.go +++ b/service/efs/api_op_DescribeMountTargetSecurityGroups.go @@ -12,15 +12,12 @@ import ( // Returns the security groups currently in effect for a mount target. This // operation requires that the network interface of the mount target has been -// created and the lifecycle state of the mount target is not deleted. This +// created and the lifecycle state of the mount target is not deleted . This // operation requires permissions for the following actions: -// -// * -// elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's -// file system. -// -// * ec2:DescribeNetworkInterfaceAttribute action on the mount -// target's network interface. +// - elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount +// target's file system. +// - ec2:DescribeNetworkInterfaceAttribute action on the mount target's network +// interface. func (c *Client) DescribeMountTargetSecurityGroups(ctx context.Context, params *DescribeMountTargetSecurityGroupsInput, optFns ...func(*Options)) (*DescribeMountTargetSecurityGroupsOutput, error) { if params == nil { params = &DescribeMountTargetSecurityGroupsInput{} diff --git a/service/efs/api_op_DescribeMountTargets.go b/service/efs/api_op_DescribeMountTargets.go index 508ee0eb63e..2d9eba5a2b1 100644 --- a/service/efs/api_op_DescribeMountTargets.go +++ b/service/efs/api_op_DescribeMountTargets.go @@ -15,8 +15,8 @@ import ( // target, for a file system. When requesting all of the current mount targets, the // order of mount targets returned in the response is unspecified. This operation // requires permissions for the elasticfilesystem:DescribeMountTargets action, on -// either the file system ID that you specify in FileSystemId, or on the file -// system of the mount target that you specify in MountTargetId. +// either the file system ID that you specify in FileSystemId , or on the file +// system of the mount target that you specify in MountTargetId . func (c *Client) DescribeMountTargets(ctx context.Context, params *DescribeMountTargetsInput, optFns ...func(*Options)) (*DescribeMountTargetsOutput, error) { if params == nil { params = &DescribeMountTargetsInput{} @@ -34,9 +34,9 @@ func (c *Client) DescribeMountTargets(ctx context.Context, params *DescribeMount type DescribeMountTargetsInput struct { - // (Optional) The ID of the access point whose mount targets that you want to list. - // It must be included in your request if a FileSystemId or MountTargetId is not - // included in your request. Accepts either an access point ID or ARN as input. + // (Optional) The ID of the access point whose mount targets that you want to + // list. It must be included in your request if a FileSystemId or MountTargetId is + // not included in your request. Accepts either an access point ID or ARN as input. AccessPointId *string // (Optional) ID of the file system whose mount targets you want to list (String). @@ -49,14 +49,15 @@ type DescribeMountTargetsInput struct { // previous returning call left off. Marker *string - // (Optional) Maximum number of mount targets to return in the response. Currently, - // this number is automatically set to 10, and other values are ignored. The - // response is paginated at 100 per page if you have more than 100 mount targets. + // (Optional) Maximum number of mount targets to return in the response. + // Currently, this number is automatically set to 10, and other values are ignored. + // The response is paginated at 100 per page if you have more than 100 mount + // targets. MaxItems *int32 // (Optional) ID of the mount target that you want to have described (String). It - // must be included in your request if FileSystemId is not included. Accepts either - // a mount target ID or ARN as input. + // must be included in your request if FileSystemId is not included. Accepts + // either a mount target ID or ARN as input. MountTargetId *string noSmithyDocumentSerde @@ -64,7 +65,7 @@ type DescribeMountTargetsInput struct { type DescribeMountTargetsOutput struct { - // If the request included the Marker, the response returns that value in this + // If the request included the Marker , the response returns that value in this // field. Marker *string diff --git a/service/efs/api_op_DescribeTags.go b/service/efs/api_op_DescribeTags.go index c0353b2440c..cd8e1db02f1 100644 --- a/service/efs/api_op_DescribeTags.go +++ b/service/efs/api_op_DescribeTags.go @@ -64,7 +64,7 @@ type DescribeTagsOutput struct { // This member is required. Tags []types.Tag - // If the request included a Marker, the response returns that value in this field. + // If the request included a Marker , the response returns that value in this field. Marker *string // If a value is present, there are more tags to return. In a subsequent request, diff --git a/service/efs/api_op_ListTagsForResource.go b/service/efs/api_op_ListTagsForResource.go index d46ee0e6c67..17123709995 100644 --- a/service/efs/api_op_ListTagsForResource.go +++ b/service/efs/api_op_ListTagsForResource.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/efs/api_op_ModifyMountTargetSecurityGroups.go b/service/efs/api_op_ModifyMountTargetSecurityGroups.go index 8e03e017f7d..fabc72e9b09 100644 --- a/service/efs/api_op_ModifyMountTargetSecurityGroups.go +++ b/service/efs/api_op_ModifyMountTargetSecurityGroups.go @@ -12,18 +12,16 @@ import ( // Modifies the set of security groups in effect for a mount target. When you // create a mount target, Amazon EFS also creates a new network interface. For more -// information, see CreateMountTarget. This operation replaces the security groups +// information, see CreateMountTarget . This operation replaces the security groups // in effect for the network interface associated with a mount target, with the // SecurityGroups provided in the request. This operation requires that the network // interface of the mount target has been created and the lifecycle state of the -// mount target is not deleted. The operation requires permissions for the +// mount target is not deleted . The operation requires permissions for the // following actions: -// -// * elasticfilesystem:ModifyMountTargetSecurityGroups action -// on the mount target's file system. -// -// * ec2:ModifyNetworkInterfaceAttribute action -// on the mount target's network interface. +// - elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount +// target's file system. +// - ec2:ModifyNetworkInterfaceAttribute action on the mount target's network +// interface. func (c *Client) ModifyMountTargetSecurityGroups(ctx context.Context, params *ModifyMountTargetSecurityGroupsInput, optFns ...func(*Options)) (*ModifyMountTargetSecurityGroupsOutput, error) { if params == nil { params = &ModifyMountTargetSecurityGroupsInput{} diff --git a/service/efs/api_op_PutAccountPreferences.go b/service/efs/api_op_PutAccountPreferences.go index 4a4efaf4c30..92d3985c155 100644 --- a/service/efs/api_op_PutAccountPreferences.go +++ b/service/efs/api_op_PutAccountPreferences.go @@ -16,9 +16,8 @@ import ( // resource IDs for new EFS file system and mount target resources. All existing // resource IDs are not affected by any changes you make. You can set the ID // preference during the opt-in period as EFS transitions to long resource IDs. For -// more information, see Managing Amazon EFS resource IDs -// (https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html). -// Starting in October, 2021, you will receive an error if you try to set the +// more information, see Managing Amazon EFS resource IDs (https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html) +// . Starting in October, 2021, you will receive an error if you try to set the // account preference to use the short 8 character format resource ID. Contact // Amazon Web Services support if you receive an error and must use short IDs for // file system and mount target resources. @@ -42,9 +41,9 @@ type PutAccountPreferencesInput struct { // Specifies the EFS resource ID preference to set for the user's Amazon Web // Services account, in the current Amazon Web Services Region, either LONG_ID (17 // characters), or SHORT_ID (8 characters). Starting in October, 2021, you will - // receive an error when setting the account preference to SHORT_ID. Contact Amazon - // Web Services support if you receive an error and must use short IDs for file - // system and mount target resources. + // receive an error when setting the account preference to SHORT_ID . Contact + // Amazon Web Services support if you receive an error and must use short IDs for + // file system and mount target resources. // // This member is required. ResourceIdType types.ResourceIdType diff --git a/service/efs/api_op_PutFileSystemPolicy.go b/service/efs/api_op_PutFileSystemPolicy.go index 01b714feeb6..c93944755a8 100644 --- a/service/efs/api_op_PutFileSystemPolicy.go +++ b/service/efs/api_op_PutFileSystemPolicy.go @@ -16,10 +16,9 @@ import ( // be the default policy or an explicit policy set or updated using this API // operation. EFS file system policies have a 20,000 character limit. When an // explicit policy is set, it overrides the default policy. For more information -// about the default file system policy, see Default EFS File System Policy -// (https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy). -// EFS file system policies have a 20,000 character limit. This operation requires -// permissions for the elasticfilesystem:PutFileSystemPolicy action. +// about the default file system policy, see Default EFS File System Policy (https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy) +// . EFS file system policies have a 20,000 character limit. This operation +// requires permissions for the elasticfilesystem:PutFileSystemPolicy action. func (c *Client) PutFileSystemPolicy(ctx context.Context, params *PutFileSystemPolicyInput, optFns ...func(*Options)) (*PutFileSystemPolicyOutput, error) { if params == nil { params = &PutFileSystemPolicyInput{} @@ -46,8 +45,8 @@ type PutFileSystemPolicyInput struct { // The FileSystemPolicy that you're creating. Accepts a JSON formatted policy // definition. EFS file system policies have a 20,000 character limit. To find out // more about the elements that make up a file system policy, see EFS - // Resource-based Policies - // (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). + // Resource-based Policies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies) + // . // // This member is required. Policy *string @@ -59,7 +58,7 @@ type PutFileSystemPolicyInput struct { // this file system. Set BypassPolicyLockoutSafetyCheck to True only when you // intend to prevent the IAM principal that is making the request from making // subsequent PutFileSystemPolicy requests on this file system. The default value - // is False. + // is False . BypassPolicyLockoutSafetyCheck bool noSmithyDocumentSerde diff --git a/service/efs/api_op_PutLifecycleConfiguration.go b/service/efs/api_op_PutLifecycleConfiguration.go index d41de081163..958c5371c06 100644 --- a/service/efs/api_op_PutLifecycleConfiguration.go +++ b/service/efs/api_op_PutLifecycleConfiguration.go @@ -14,40 +14,31 @@ import ( // Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. // A LifecycleConfiguration consists of one or more LifecyclePolicy objects that // define the following: +// - EFS Lifecycle management - When Amazon EFS automatically transitions files +// in a file system into the lower-cost EFS Infrequent Access (IA) storage class. +// To enable EFS Lifecycle management, set the value of TransitionToIA to one of +// the available options. +// - EFS Intelligent-Tiering - When Amazon EFS automatically transitions files +// from IA back into the file system's primary storage class (EFS Standard or EFS +// One Zone Standard). To enable EFS Intelligent-Tiering, set the value of +// TransitionToPrimaryStorageClass to AFTER_1_ACCESS . // -// * EFS Lifecycle management - When Amazon EFS -// automatically transitions files in a file system into the lower-cost EFS -// Infrequent Access (IA) storage class. To enable EFS Lifecycle management, set -// the value of TransitionToIA to one of the available options. -// -// * EFS -// Intelligent-Tiering - When Amazon EFS automatically transitions files from IA -// back into the file system's primary storage class (EFS Standard or EFS One Zone -// Standard). To enable EFS Intelligent-Tiering, set the value of -// TransitionToPrimaryStorageClass to AFTER_1_ACCESS. -// -// For more information, see -// EFS Lifecycle Management -// (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html). Each -// Amazon EFS file system supports one lifecycle configuration, which applies to -// all files in the file system. If a LifecycleConfiguration object already exists -// for the specified file system, a PutLifecycleConfiguration call modifies the -// existing configuration. A PutLifecycleConfiguration call with an empty -// LifecyclePolicies array in the request body deletes any existing +// For more information, see EFS Lifecycle Management (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html) +// . Each Amazon EFS file system supports one lifecycle configuration, which +// applies to all files in the file system. If a LifecycleConfiguration object +// already exists for the specified file system, a PutLifecycleConfiguration call +// modifies the existing configuration. A PutLifecycleConfiguration call with an +// empty LifecyclePolicies array in the request body deletes any existing // LifecycleConfiguration and turns off lifecycle management and EFS -// Intelligent-Tiering for the file system. In the request, specify the -// following: -// -// * The ID for the file system for which you are enabling, disabling, -// or modifying lifecycle management and EFS Intelligent-Tiering. -// -// * A -// LifecyclePolicies array of LifecyclePolicy objects that define when files are -// moved into IA storage, and when they are moved back to Standard storage. Amazon -// EFS requires that each LifecyclePolicy object have only have a single -// transition, so the LifecyclePolicies array needs to be structured with separate -// LifecyclePolicy objects. See the example requests in the following section for -// more information. +// Intelligent-Tiering for the file system. In the request, specify the following: +// - The ID for the file system for which you are enabling, disabling, or +// modifying lifecycle management and EFS Intelligent-Tiering. +// - A LifecyclePolicies array of LifecyclePolicy objects that define when files +// are moved into IA storage, and when they are moved back to Standard storage. +// Amazon EFS requires that each LifecyclePolicy object have only have a single +// transition, so the LifecyclePolicies array needs to be structured with +// separate LifecyclePolicy objects. See the example requests in the following +// section for more information. // // This operation requires permissions for the // elasticfilesystem:PutLifecycleConfiguration operation. To apply a @@ -79,20 +70,16 @@ type PutLifecycleConfigurationInput struct { // An array of LifecyclePolicy objects that define the file system's // LifecycleConfiguration object. A LifecycleConfiguration object informs EFS // lifecycle management and EFS Intelligent-Tiering of the following: - // - // * When to - // move files in the file system from primary storage to the IA storage class. - // - // * - // When to move files that are in IA storage to primary storage. - // - // When using the - // put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API - // action, Amazon EFS requires that each LifecyclePolicy object have only a single - // transition. This means that in a request body, LifecyclePolicies must be - // structured as an array of LifecyclePolicy objects, one object for each - // transition, TransitionToIA, TransitionToPrimaryStorageClass. See the example - // requests in the following section for more information. + // - When to move files in the file system from primary storage to the IA + // storage class. + // - When to move files that are in IA storage to primary storage. + // When using the put-lifecycle-configuration CLI command or the + // PutLifecycleConfiguration API action, Amazon EFS requires that each + // LifecyclePolicy object have only a single transition. This means that in a + // request body, LifecyclePolicies must be structured as an array of + // LifecyclePolicy objects, one object for each transition, TransitionToIA , + // TransitionToPrimaryStorageClass . See the example requests in the following + // section for more information. // // This member is required. LifecyclePolicies []types.LifecyclePolicy diff --git a/service/efs/api_op_UntagResource.go b/service/efs/api_op_UntagResource.go index ffd841a89fd..dcd39e6f22f 100644 --- a/service/efs/api_op_UntagResource.go +++ b/service/efs/api_op_UntagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags from an EFS resource. You can remove tags from EFS file systems and -// access points using this API operation. This operation requires permissions for -// the elasticfilesystem:UntagResource action. +// Removes tags from an EFS resource. You can remove tags from EFS file systems +// and access points using this API operation. This operation requires permissions +// for the elasticfilesystem:UntagResource action. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/efs/api_op_UpdateFileSystem.go b/service/efs/api_op_UpdateFileSystem.go index 0edd547aec0..9b19c2c7575 100644 --- a/service/efs/api_op_UpdateFileSystem.go +++ b/service/efs/api_op_UpdateFileSystem.go @@ -44,8 +44,8 @@ type UpdateFileSystemInput struct { // (Optional) Updates the file system's throughput mode. If you're not updating // your throughput mode, you don't need to provide this value in your request. If - // you are changing the ThroughputMode to provisioned, you must also set a value - // for ProvisionedThroughputInMibps. + // you are changing the ThroughputMode to provisioned , you must also set a value + // for ProvisionedThroughputInMibps . ThroughputMode types.ThroughputMode noSmithyDocumentSerde @@ -76,7 +76,7 @@ type UpdateFileSystemOutput struct { LifeCycleState types.LifeCycleState // The current number of mount targets that the file system has. For more - // information, see CreateMountTarget. + // information, see CreateMountTarget . // // This member is required. NumberOfMountTargets int32 @@ -117,17 +117,16 @@ type UpdateFileSystemOutput struct { // Describes the Amazon Web Services Availability Zone in which the file system is // located, and is valid only for file systems using One Zone storage classes. For - // more information, see Using EFS storage classes - // (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon - // EFS User Guide. + // more information, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // in the Amazon EFS User Guide. AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . + // Example with sample data: // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 FileSystemArn *string @@ -135,18 +134,17 @@ type UpdateFileSystemOutput struct { KmsKeyId *string // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the - // value in this field. + // see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns + // the value in this field. Name *string // The amount of provisioned throughput, measured in MiB/s, for the file system. - // Valid for file systems using ThroughputMode set to provisioned. + // Valid for file systems using ThroughputMode set to provisioned . ProvisionedThroughputInMibps *float64 - // Displays the file system's throughput mode. For more information, see Throughput - // modes - // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) in - // the Amazon EFS User Guide. + // Displays the file system's throughput mode. For more information, see + // Throughput modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) + // in the Amazon EFS User Guide. ThroughputMode types.ThroughputMode // Metadata pertaining to the operation's result. diff --git a/service/efs/doc.go b/service/efs/doc.go index 497361ce46b..a216593a637 100644 --- a/service/efs/doc.go +++ b/service/efs/doc.go @@ -8,8 +8,7 @@ // the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, // growing and shrinking automatically as you add and remove files, so that your // applications have the storage they need, when they need it. For more -// information, see the Amazon Elastic File System API Reference -// (https://docs.aws.amazon.com/efs/latest/ug/api-reference.html) and the Amazon -// Elastic File System User Guide -// (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html). +// information, see the Amazon Elastic File System API Reference (https://docs.aws.amazon.com/efs/latest/ug/api-reference.html) +// and the Amazon Elastic File System User Guide (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) +// . package efs diff --git a/service/efs/types/errors.go b/service/efs/types/errors.go index f6d6296cf7e..658d49056b2 100644 --- a/service/efs/types/errors.go +++ b/service/efs/types/errors.go @@ -39,8 +39,8 @@ func (e *AccessPointAlreadyExists) ErrorFault() smithy.ErrorFault { return smith // Returned if the Amazon Web Services account has already created the maximum // number of access points allowed per file system. For more informaton, see -// https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region -// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region). +// https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region) +// . type AccessPointLimitExceeded struct { Message *string @@ -99,8 +99,8 @@ func (e *AccessPointNotFound) ErrorFault() smithy.ErrorFault { return smithy.Fau // Returned if the Availability Zone that was specified for a mount target is // different from the Availability Zone that was specified for One Zone storage. -// For more information, see Regional and One Zone storage redundancy -// (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html). +// For more information, see Regional and One Zone storage redundancy (https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html) +// . type AvailabilityZonesMismatch struct { Message *string @@ -358,8 +358,8 @@ func (e *IncorrectMountTargetState) ErrorCode() string { } func (e *IncorrectMountTargetState) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Returned if there's not enough capacity to provision additional throughput. This -// value might be returned when you try to create a file system in provisioned +// Returned if there's not enough capacity to provision additional throughput. +// This value might be returned when you try to create a file system in provisioned // throughput mode, when you attempt to increase the provisioned throughput of an // existing file system, or when you attempt to change an existing file system from // Bursting Throughput to Provisioned Throughput mode. Try again later. @@ -506,8 +506,8 @@ func (e *MountTargetConflict) ErrorCode() string { } func (e *MountTargetConflict) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Returned if there is no mount target with the specified ID found in the caller's -// Amazon Web Services account. +// Returned if there is no mount target with the specified ID found in the +// caller's Amazon Web Services account. type MountTargetNotFound struct { Message *string @@ -535,11 +535,10 @@ func (e *MountTargetNotFound) ErrorCode() string { } func (e *MountTargetNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The calling account has reached the limit for elastic network interfaces for the -// specific Amazon Web Services Region. Either delete some network interfaces or -// request that the account quota be raised. For more information, see Amazon VPC -// Quotas -// (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) +// The calling account has reached the limit for elastic network interfaces for +// the specific Amazon Web Services Region. Either delete some network interfaces +// or request that the account quota be raised. For more information, see Amazon +// VPC Quotas (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html) // in the Amazon VPC User Guide (see the Network interfaces per Region entry in the // Network interfaces table). type NetworkInterfaceLimitExceeded struct { @@ -742,8 +741,8 @@ func (e *SubnetNotFound) ErrorCode() string { func (e *SubnetNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Returned when the CreateAccessPoint API action is called too quickly and the -// number of Access Points on the file system is nearing the limit of 120 -// (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region). +// number of Access Points on the file system is nearing the limit of 120 (https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region) +// . type ThrottlingException struct { Message *string diff --git a/service/efs/types/types.go b/service/efs/types/types.go index 3551d2b0ab0..c9a096716db 100644 --- a/service/efs/types/types.go +++ b/service/efs/types/types.go @@ -36,8 +36,8 @@ type AccessPointDescription struct { // using the access point. PosixUser *PosixUser - // The directory on the Amazon EFS file system that the access point exposes as the - // root directory to NFS clients using the access point. + // The directory on the Amazon EFS file system that the access point exposes as + // the root directory to NFS clients using the access point. RootDirectory *RootDirectory // The tags associated with the access point, presented as an array of Tag objects. @@ -46,25 +46,17 @@ type AccessPointDescription struct { noSmithyDocumentSerde } -// The backup policy for the file system used to create automatic daily backups. If -// status has a value of ENABLED, the file system is being automatically backed up. -// For more information, see Automatic backups -// (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups). +// The backup policy for the file system used to create automatic daily backups. +// If status has a value of ENABLED , the file system is being automatically backed +// up. For more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups) +// . type BackupPolicy struct { // Describes the status of the file system's backup policy. - // - // * ENABLED - EFS is - // automatically backing up the file system. - // - // * ENABLING - EFS is turning on - // automatic backups for the file system. - // - // * DISABLED - Automatic back ups are - // turned off for the file system. - // - // * DISABLING - EFS is turning off automatic - // backups for the file system. + // - ENABLED - EFS is automatically backing up the file system. + // - ENABLING - EFS is turning on automatic backups for the file system. + // - DISABLED - Automatic back ups are turned off for the file system. + // - DISABLING - EFS is turning off automatic backups for the file system. // // This member is required. Status Status @@ -73,10 +65,10 @@ type BackupPolicy struct { } // Required if the RootDirectory > Path specified does not exist. Specifies the -// POSIX IDs and permissions to apply to the access point's RootDirectory > Path. +// POSIX IDs and permissions to apply to the access point's RootDirectory > Path . // If the access point root directory does not exist, EFS creates it with these // settings when a client connects to the access point. When specifying -// CreationInfo, you must include values for all properties. Amazon EFS creates a +// CreationInfo , you must include values for all properties. Amazon EFS creates a // root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and // permissions for the directory. If you do not provide this information, Amazon // EFS does not create the root directory. If the root directory does not exist, @@ -85,19 +77,19 @@ type BackupPolicy struct { // the file system using the access point will fail. type CreationInfo struct { - // Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from + // Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from // 0 to 2^32 (4294967295). // // This member is required. OwnerGid *int64 - // Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 - // to 2^32 (4294967295). + // Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from + // 0 to 2^32 (4294967295). // // This member is required. OwnerUid *int64 - // Specifies the POSIX permissions to apply to the RootDirectory, in the format of + // Specifies the POSIX permissions to apply to the RootDirectory , in the format of // an octal number representing the file's mode bits. // // This member is required. @@ -119,18 +111,19 @@ type Destination struct { // This member is required. Region *string - // Describes the status of the destination Amazon EFS file system. If the status is - // ERROR, the destination file system in the replication configuration is in a + // Describes the status of the destination Amazon EFS file system. If the status + // is ERROR , the destination file system in the replication configuration is in a // failed state and is unrecoverable. To access the file system data, restore a // backup of the failed file system to a new file system. // // This member is required. Status ReplicationStatus - // The time when the most recent sync was successfully completed on the destination - // file system. Any changes to data on the source file system that occurred before - // this time have been successfully replicated to the destination file system. Any - // changes that occurred after this time might not be fully replicated. + // The time when the most recent sync was successfully completed on the + // destination file system. Any changes to data on the source file system that + // occurred before this time have been successfully replicated to the destination + // file system. Any changes that occurred after this time might not be fully + // replicated. LastReplicatedTimestamp *time.Time noSmithyDocumentSerde @@ -146,22 +139,16 @@ type DestinationToCreate struct { // Specifies the Key Management Service (KMS) key that you want to use to encrypt // the destination file system. If you do not specify a KMS key, Amazon EFS uses - // your default KMS key for Amazon EFS, /aws/elasticfilesystem. This ID can be in + // your default KMS key for Amazon EFS, /aws/elasticfilesystem . This ID can be in // one of the following formats: - // - // * Key ID - The unique identifier of the key, for - // example 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * ARN - The Amazon Resource Name - // (ARN) for the key, for example - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * - // Key alias - A previously created display name for a key, for example - // alias/projectKey1. - // - // * Key alias ARN - The ARN for a key alias, for example - // arn:aws:kms:us-west-2:444455556666:alias/projectKey1. + // - Key ID - The unique identifier of the key, for example + // 1234abcd-12ab-34cd-56ef-1234567890ab . + // - ARN - The Amazon Resource Name (ARN) for the key, for example + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Key alias - A previously created display name for a key, for example + // alias/projectKey1 . + // - Key alias ARN - The ARN for a key alias, for example + // arn:aws:kms:us-west-2:444455556666:alias/projectKey1 . KmsKeyId *string // To create a file system that uses Regional storage, specify the Amazon Web @@ -196,7 +183,7 @@ type FileSystemDescription struct { LifeCycleState LifeCycleState // The current number of mount targets that the file system has. For more - // information, see CreateMountTarget. + // information, see CreateMountTarget . // // This member is required. NumberOfMountTargets int32 @@ -237,17 +224,16 @@ type FileSystemDescription struct { // Describes the Amazon Web Services Availability Zone in which the file system is // located, and is valid only for file systems using One Zone storage classes. For - // more information, see Using EFS storage classes - // (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the Amazon - // EFS User Guide. + // more information, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // in the Amazon EFS User Guide. AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. Encrypted *bool // The Amazon Resource Name (ARN) for the EFS file system, in the format - // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example - // with sample data: + // arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . + // Example with sample data: // arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567 FileSystemArn *string @@ -255,18 +241,17 @@ type FileSystemDescription struct { KmsKeyId *string // You can add tags to a file system, including a Name tag. For more information, - // see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the - // value in this field. + // see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns + // the value in this field. Name *string // The amount of provisioned throughput, measured in MiB/s, for the file system. - // Valid for file systems using ThroughputMode set to provisioned. + // Valid for file systems using ThroughputMode set to provisioned . ProvisionedThroughputInMibps *float64 - // Displays the file system's throughput mode. For more information, see Throughput - // modes - // (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) in - // the Amazon EFS User Guide. + // Displays the file system's throughput mode. For more information, see + // Throughput modes (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) + // in the Amazon EFS User Guide. ThroughputMode ThroughputMode noSmithyDocumentSerde @@ -286,12 +271,13 @@ type FileSystemSize struct { // This member is required. Value int64 - // The time at which the size of data, returned in the Value field, was determined. - // The value is the integer number of seconds since 1970-01-01T00:00:00Z. + // The time at which the size of data, returned in the Value field, was + // determined. The value is the integer number of seconds since + // 1970-01-01T00:00:00Z. Timestamp *time.Time - // The latest known metered size (in bytes) of data stored in the Infrequent Access - // storage class. + // The latest known metered size (in bytes) of data stored in the Infrequent + // Access storage class. ValueInIA *int64 // The latest known metered size (in bytes) of data stored in the Standard storage @@ -304,15 +290,14 @@ type FileSystemSize struct { // Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering // that specifies when to transition files into and out of the file system's // Infrequent Access (IA) storage class. For more information, see EFS -// Intelligent‐Tiering and EFS Lifecycle Management -// (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html). When -// using the put-lifecycle-configuration CLI command or the +// Intelligent‐Tiering and EFS Lifecycle Management (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html) +// . When using the put-lifecycle-configuration CLI command or the // PutLifecycleConfiguration API action, Amazon EFS requires that each // LifecyclePolicy object have only a single transition. This means that in a // request body, LifecyclePolicies must be structured as an array of -// LifecyclePolicy objects, one object for each transition, TransitionToIA, -// TransitionToPrimaryStorageClass. For more information, see the request examples -// in PutLifecycleConfiguration. +// LifecyclePolicy objects, one object for each transition, TransitionToIA , +// TransitionToPrimaryStorageClass . For more information, see the request examples +// in PutLifecycleConfiguration . type LifecyclePolicy struct { // Describes the period of time that a file is not accessed, after which it @@ -320,9 +305,9 @@ type LifecyclePolicy struct { // directory don't count as file access events. TransitionToIA TransitionToIARules - // Describes when to transition a file from IA storage to primary storage. Metadata - // operations such as listing the contents of a directory don't count as file - // access events. + // Describes when to transition a file from IA storage to primary storage. + // Metadata operations such as listing the contents of a directory don't count as + // file access events. TransitionToPrimaryStorageClass TransitionToPrimaryStorageClassRules noSmithyDocumentSerde @@ -448,7 +433,7 @@ type ResourceIdPreference struct { ResourceIdType ResourceIdType // Identifies the Amazon EFS resources to which the ID preference setting applies, - // FILE_SYSTEM and MOUNT_TARGET. + // FILE_SYSTEM and MOUNT_TARGET . Resources []Resource noSmithyDocumentSerde @@ -462,18 +447,18 @@ type ResourceIdPreference struct { type RootDirectory struct { // (Optional) Specifies the POSIX IDs and permissions to apply to the access - // point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS - // creates the root directory using the CreationInfo settings when a client - // connects to an access point. When specifying the CreationInfo, you must provide + // point's RootDirectory . If the RootDirectory > Path specified does not exist, + // EFS creates the root directory using the CreationInfo settings when a client + // connects to an access point. When specifying the CreationInfo , you must provide // values for all properties. If you do not provide CreationInfo and the specified - // RootDirectory > Path does not exist, attempts to mount the file system using the - // access point will fail. + // RootDirectory > Path does not exist, attempts to mount the file system using + // the access point will fail. CreationInfo *CreationInfo - // Specifies the path on the EFS file system to expose as the root directory to NFS - // clients using the access point to access the EFS file system. A path can have up - // to four subdirectories. If the specified path does not exist, you are required - // to provide the CreationInfo. + // Specifies the path on the EFS file system to expose as the root directory to + // NFS clients using the access point to access the EFS file system. A path can + // have up to four subdirectories. If the specified path does not exist, you are + // required to provide the CreationInfo . Path *string noSmithyDocumentSerde @@ -481,10 +466,10 @@ type RootDirectory struct { // A tag is a key-value pair. Allowed characters are letters, white space, and // numbers that can be represented in UTF-8, and the following characters: + - = . -// _ : /. +// _ : / . type Tag struct { - // The tag key (String). The key can't start with aws:. + // The tag key (String). The key can't start with aws: . // // This member is required. Key *string diff --git a/service/eks/api_client.go b/service/eks/api_client.go index ad228e80b82..2d1916674d9 100644 --- a/service/eks/api_client.go +++ b/service/eks/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/eks/api_op_AssociateIdentityProviderConfig.go b/service/eks/api_op_AssociateIdentityProviderConfig.go index 792fb203178..451b0e3d839 100644 --- a/service/eks/api_op_AssociateIdentityProviderConfig.go +++ b/service/eks/api_op_AssociateIdentityProviderConfig.go @@ -17,10 +17,9 @@ import ( // provider configuration and associate it to your cluster. After configuring // authentication to your cluster you can create Kubernetes roles and clusterroles // to assign permissions to the roles, and then bind the roles to the identities -// using Kubernetes rolebindings and clusterrolebindings. For more information see -// Using RBAC Authorization -// (https://kubernetes.io/docs/reference/access-authn-authz/rbac/) in the -// Kubernetes documentation. +// using Kubernetes rolebindings and clusterrolebindings . For more information see +// Using RBAC Authorization (https://kubernetes.io/docs/reference/access-authn-authz/rbac/) +// in the Kubernetes documentation. func (c *Client) AssociateIdentityProviderConfig(ctx context.Context, params *AssociateIdentityProviderConfigInput, optFns ...func(*Options)) (*AssociateIdentityProviderConfigOutput, error) { if params == nil { params = &AssociateIdentityProviderConfigInput{} diff --git a/service/eks/api_op_CreateAddon.go b/service/eks/api_op_CreateAddon.go index ca9ed1528a4..ff6365b34dd 100644 --- a/service/eks/api_op_CreateAddon.go +++ b/service/eks/api_op_CreateAddon.go @@ -14,9 +14,8 @@ import ( // Creates an Amazon EKS add-on. Amazon EKS add-ons help to automate the // provisioning and lifecycle management of common operational software for Amazon -// EKS clusters. For more information, see Amazon EKS add-ons -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the -// Amazon EKS User Guide. +// EKS clusters. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) +// in the Amazon EKS User Guide. func (c *Client) CreateAddon(ctx context.Context, params *CreateAddonInput, optFns ...func(*Options)) (*CreateAddonOutput, error) { if params == nil { params = &CreateAddonInput{} @@ -35,8 +34,7 @@ func (c *Client) CreateAddon(ctx context.Context, params *CreateAddonInput, optF type CreateAddonInput struct { // The name of the add-on. The name must match one of the names that - // DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) // returns. // // This member is required. @@ -48,8 +46,8 @@ type CreateAddonInput struct { ClusterName *string // The version of the add-on. The version must match one of the versions returned - // by DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). + // by DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // . AddonVersion *string // A unique, case-sensitive identifier that you provide to ensure the idempotency @@ -57,28 +55,22 @@ type CreateAddonInput struct { ClientRequestToken *string // The set of configuration values for the add-on that's created. The values that - // you provide are validated against the schema in DescribeAddonConfiguration - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html). + // you provide are validated against the schema in DescribeAddonConfiguration (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html) + // . ConfigurationValues *string // How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are // handled based on the value you choose: + // - None – If the self-managed version of the add-on is installed on your + // cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail. // - // * None – If the self-managed version of - // the add-on is installed on your cluster, Amazon EKS doesn't change the value. - // Creation of the add-on might fail. - // - // * Overwrite – If the self-managed version of - // the add-on is installed on your cluster and the Amazon EKS default value is - // different than the existing value, Amazon EKS changes the value to the Amazon - // EKS default value. - // - // * Preserve – Not supported. You can set this value when - // updating an add-on though. For more information, see UpdateAddon - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html). - // - // If - // you don't currently have the self-managed version of the add-on installed on + // - Overwrite – If the self-managed version of the add-on is installed on your + // cluster and the Amazon EKS default value is different than the existing value, + // Amazon EKS changes the value to the Amazon EKS default value. + // - Preserve – Not supported. You can set this value when updating an add-on + // though. For more information, see UpdateAddon (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) + // . + // If you don't currently have the self-managed version of the add-on installed on // your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to // default values, regardless of the option that you specify. ResolveConflicts types.ResolveConflicts @@ -87,12 +79,10 @@ type CreateAddonInput struct { // service account. The role must be assigned the IAM permissions required by the // add-on. If you don't specify an existing IAM role, then the add-on uses the // permissions assigned to the node IAM role. For more information, see Amazon EKS - // node IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the - // Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM - // OpenID Connect (OIDC) provider created for your cluster. For more information, - // see Enabling IAM roles for service accounts on your cluster - // (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) + // node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) + // in the Amazon EKS User Guide. To specify an existing IAM role, you must have an + // IAM OpenID Connect (OIDC) provider created for your cluster. For more + // information, see Enabling IAM roles for service accounts on your cluster (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) // in the Amazon EKS User Guide. ServiceAccountRoleArn *string @@ -105,9 +95,8 @@ type CreateAddonInput struct { type CreateAddonOutput struct { - // An Amazon EKS add-on. For more information, see Amazon EKS add-ons - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the - // Amazon EKS User Guide. + // An Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) + // in the Amazon EKS User Guide. Addon *types.Addon // Metadata pertaining to the operation's result. diff --git a/service/eks/api_op_CreateCluster.go b/service/eks/api_op_CreateCluster.go index 8e36d0ed2d7..9b09f41f44d 100644 --- a/service/eks/api_op_CreateCluster.go +++ b/service/eks/api_op_CreateCluster.go @@ -21,17 +21,15 @@ import ( // multiple Availability Zones and fronted by an Elastic Load Balancing Network // Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC // subnets to provide connectivity from the control plane instances to the nodes -// (for example, to support kubectl exec, logs, and proxy data flows). Amazon EKS -// nodes run in your Amazon Web Services account and connect to your cluster's +// (for example, to support kubectl exec , logs , and proxy data flows). Amazon +// EKS nodes run in your Amazon Web Services account and connect to your cluster's // control plane over the Kubernetes API server endpoint and a certificate file // that is created for your cluster. In most cases, it takes several minutes to // create a cluster. After you create an Amazon EKS cluster, you must configure // your Kubernetes tooling to communicate with the API server and launch nodes into -// your cluster. For more information, see Managing Cluster Authentication -// (https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and -// Launching Amazon EKS nodes -// (https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the -// Amazon EKS User Guide. +// your cluster. For more information, see Managing Cluster Authentication (https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) +// and Launching Amazon EKS nodes (https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) +// in the Amazon EKS User Guide. func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -56,22 +54,19 @@ type CreateClusterInput struct { // The VPC configuration that's used by the cluster control plane. Amazon EKS VPC // resources have specific requirements to work properly with Kubernetes. For more - // information, see Cluster VPC Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and Cluster - // Security Group Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the - // Amazon EKS User Guide. You must specify at least two subnets. You can specify up - // to five security groups. However, we recommend that you use a dedicated security - // group for your cluster control plane. + // information, see Cluster VPC Considerations (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) + // and Cluster Security Group Considerations (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) + // in the Amazon EKS User Guide. You must specify at least two subnets. You can + // specify up to five security groups. However, we recommend that you use a + // dedicated security group for your cluster control plane. // // This member is required. ResourcesVpcConfig *types.VpcConfigRequest - // The Amazon Resource Name (ARN) of the IAM role that provides permissions for the - // Kubernetes control plane to make calls to Amazon Web Services API operations on - // your behalf. For more information, see Amazon EKS Service IAM Role - // (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the - // Amazon EKS User Guide . + // The Amazon Resource Name (ARN) of the IAM role that provides permissions for + // the Kubernetes control plane to make calls to Amazon Web Services API operations + // on your behalf. For more information, see Amazon EKS Service IAM Role (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) + // in the Amazon EKS User Guide . // // This member is required. RoleArn *string @@ -88,17 +83,15 @@ type CreateClusterInput struct { // Enable or disable exporting the Kubernetes control plane logs for your cluster // to CloudWatch Logs. By default, cluster control plane logs aren't exported to - // CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs - // (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in - // the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data - // scanning rates apply to exported control plane logs. For more information, see - // CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). + // CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) + // in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and + // data scanning rates apply to exported control plane logs. For more information, + // see CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/) . Logging *types.Logging // An object representing the configuration of your local Amazon EKS cluster on an // Amazon Web Services Outpost. Before creating a local cluster on an Outpost, - // review Local clusters for Amazon EKS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html) + // review Local clusters for Amazon EKS on Amazon Web Services Outposts (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html) // in the Amazon EKS User Guide. This object isn't available for creating Amazon // EKS clusters on the Amazon Web Services cloud. OutpostConfig *types.OutpostConfigRequest diff --git a/service/eks/api_op_CreateFargateProfile.go b/service/eks/api_op_CreateFargateProfile.go index 17e84a67bed..5f3ed1924f5 100644 --- a/service/eks/api_op_CreateFargateProfile.go +++ b/service/eks/api_op_CreateFargateProfile.go @@ -23,22 +23,19 @@ import ( // selectors in the Fargate profile, then that pod is run on Fargate. When you // create a Fargate profile, you must specify a pod execution role to use with the // pods that are scheduled with the profile. This role is added to the cluster's -// Kubernetes Role Based Access Control -// (https://kubernetes.io/docs/admin/authorization/rbac/) (RBAC) for authorization -// so that the kubelet that is running on the Fargate infrastructure can register -// with your Amazon EKS cluster so that it can appear in your cluster as a node. -// The pod execution role also provides IAM permissions to the Fargate -// infrastructure to allow read access to Amazon ECR image repositories. For more -// information, see Pod Execution Role -// (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in -// the Amazon EKS User Guide. Fargate profiles are immutable. However, you can +// Kubernetes Role Based Access Control (https://kubernetes.io/docs/admin/authorization/rbac/) +// (RBAC) for authorization so that the kubelet that is running on the Fargate +// infrastructure can register with your Amazon EKS cluster so that it can appear +// in your cluster as a node. The pod execution role also provides IAM permissions +// to the Fargate infrastructure to allow read access to Amazon ECR image +// repositories. For more information, see Pod Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) +// in the Amazon EKS User Guide. Fargate profiles are immutable. However, you can // create a new updated profile to replace an existing profile and then delete the // original after the updated profile has finished creating. If any Fargate -// profiles in a cluster are in the DELETING status, you must wait for that Fargate -// profile to finish deleting before you can create any other profiles in that -// cluster. For more information, see Fargate Profile -// (https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the -// Amazon EKS User Guide. +// profiles in a cluster are in the DELETING status, you must wait for that +// Fargate profile to finish deleting before you can create any other profiles in +// that cluster. For more information, see Fargate Profile (https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) +// in the Amazon EKS User Guide. func (c *Client) CreateFargateProfile(ctx context.Context, params *CreateFargateProfileInput, optFns ...func(*Options)) (*CreateFargateProfileOutput, error) { if params == nil { params = &CreateFargateProfileInput{} @@ -70,9 +67,8 @@ type CreateFargateProfileInput struct { // match the selectors in the Fargate profile. The pod execution role allows // Fargate infrastructure to register with your cluster as a node, and it provides // read access to Amazon ECR image repositories. For more information, see Pod - // Execution Role - // (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in - // the Amazon EKS User Guide. + // Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) + // in the Amazon EKS User Guide. // // This member is required. PodExecutionRoleArn *string diff --git a/service/eks/api_op_CreateNodegroup.go b/service/eks/api_op_CreateNodegroup.go index 0ec7a25825e..32109a947b9 100644 --- a/service/eks/api_op_CreateNodegroup.go +++ b/service/eks/api_op_CreateNodegroup.go @@ -17,14 +17,12 @@ import ( // the cluster. All node groups are created with the latest AMI release version for // the respective minor Kubernetes version of the cluster, unless you deploy a // custom AMI using a launch template. For more information about using launch -// templates, see Launch template support -// (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html). An -// Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated -// Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS -// cluster. For more information, see Managed node groups -// (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in -// the Amazon EKS User Guide. Windows AMI types are only supported for commercial -// Regions that support Windows Amazon EKS. +// templates, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) +// . An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and +// associated Amazon EC2 instances that are managed by Amazon Web Services for an +// Amazon EKS cluster. For more information, see Managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) +// in the Amazon EKS User Guide. Windows AMI types are only supported for +// commercial Regions that support Windows Amazon EKS. func (c *Client) CreateNodegroup(ctx context.Context, params *CreateNodegroupInput, optFns ...func(*Options)) (*CreateNodegroupOutput, error) { if params == nil { params = &CreateNodegroupInput{} @@ -53,11 +51,9 @@ type CreateNodegroupInput struct { // through an IAM instance profile and associated policies. Before you can launch // nodes and register them into a cluster, you must create an IAM role for those // nodes to use when they are launched. For more information, see Amazon EKS node - // IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the - // Amazon EKS User Guide . If you specify launchTemplate, then don't specify - // IamInstanceProfile - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) + // IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) + // in the Amazon EKS User Guide . If you specify launchTemplate , then don't + // specify IamInstanceProfile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) // in your launch template, or the node group deployment will fail. For more // information about using launch templates with Amazon EKS, see Launch template // support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) @@ -72,8 +68,7 @@ type CreateNodegroupInput struct { NodegroupName *string // The subnets to use for the Auto Scaling group that is created for your node - // group. If you specify launchTemplate, then don't specify SubnetId - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) + // group. If you specify launchTemplate , then don't specify SubnetId (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) // in your launch template, or the node group deployment will fail. For more // information about using launch templates with Amazon EKS, see Launch template // support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) @@ -82,14 +77,13 @@ type CreateNodegroupInput struct { // This member is required. Subnets []string - // The AMI type for your node group. If you specify launchTemplate, and your launch - // template uses a custom AMI, then don't specify amiType, or the node group - // deployment will fail. If your launch template uses a Windows custom AMI, then - // add eks:kube-proxy-windows to your Windows nodes rolearn in the - // aws-authConfigMap. For more information about using launch templates with Amazon - // EKS, see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // The AMI type for your node group. If you specify launchTemplate , and your + // launch template uses a custom AMI, then don't specify amiType , or the node + // group deployment will fail. If your launch template uses a Windows custom AMI, + // then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth + // ConfigMap . For more information about using launch templates with Amazon EKS, + // see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. AmiType types.AMITypes // The capacity type for your node group. @@ -101,67 +95,60 @@ type CreateNodegroupInput struct { // The root device disk size (in GiB) for your node group instances. The default // disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB - // for Windows. If you specify launchTemplate, then don't specify diskSize, or the - // node group deployment will fail. For more information about using launch - // templates with Amazon EKS, see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // for Windows. If you specify launchTemplate , then don't specify diskSize , or + // the node group deployment will fail. For more information about using launch + // templates with Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. DiskSize *int32 - // Specify the instance types for a node group. If you specify a GPU instance type, - // make sure to also specify an applicable GPU AMI type with the amiType parameter. - // If you specify launchTemplate, then you can specify zero or one instance type in - // your launch template or you can specify 0-20 instance types for instanceTypes. - // If however, you specify an instance type in your launch template and specify any - // instanceTypes, the node group deployment will fail. If you don't specify an - // instance type in a launch template or for instanceTypes, then t3.medium is used, - // by default. If you specify Spot for capacityType, then we recommend specifying - // multiple values for instanceTypes. For more information, see Managed node group - // capacity types - // (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) - // and Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // Specify the instance types for a node group. If you specify a GPU instance + // type, make sure to also specify an applicable GPU AMI type with the amiType + // parameter. If you specify launchTemplate , then you can specify zero or one + // instance type in your launch template or you can specify 0-20 instance types for + // instanceTypes . If however, you specify an instance type in your launch template + // and specify any instanceTypes , the node group deployment will fail. If you + // don't specify an instance type in a launch template or for instanceTypes , then + // t3.medium is used, by default. If you specify Spot for capacityType , then we + // recommend specifying multiple values for instanceTypes . For more information, + // see Managed node group capacity types (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) + // and Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. InstanceTypes []string - // The Kubernetes labels to be applied to the nodes in the node group when they are - // created. + // The Kubernetes labels to be applied to the nodes in the node group when they + // are created. Labels map[string]string // An object representing a node group's launch template specification. If - // specified, then do not specify instanceTypes, diskSize, or remoteAccess and make - // sure that the launch template meets the requirements in - // launchTemplateSpecification. + // specified, then do not specify instanceTypes , diskSize , or remoteAccess and + // make sure that the launch template meets the requirements in + // launchTemplateSpecification . LaunchTemplate *types.LaunchTemplateSpecification // The AMI version of the Amazon EKS optimized AMI to use with your node group. By // default, the latest available AMI version for the node group's current - // Kubernetes version is used. For information about Linux versions, see Amazon EKS - // optimized Amazon Linux AMI versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) + // Kubernetes version is used. For information about Linux versions, see Amazon + // EKS optimized Amazon Linux AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) // in the Amazon EKS User Guide. Amazon EKS managed node groups support the // November 2022 and later releases of the Windows AMIs. For information about - // Windows versions, see Amazon EKS optimized Windows AMI versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) - // in the Amazon EKS User Guide. If you specify launchTemplate, and your launch - // template uses a custom AMI, then don't specify releaseVersion, or the node group - // deployment will fail. For more information about using launch templates with - // Amazon EKS, see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // Windows versions, see Amazon EKS optimized Windows AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) + // in the Amazon EKS User Guide. If you specify launchTemplate , and your launch + // template uses a custom AMI, then don't specify releaseVersion , or the node + // group deployment will fail. For more information about using launch templates + // with Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. ReleaseVersion *string // The remote access configuration to use with your node group. For Linux, the - // protocol is SSH. For Windows, the protocol is RDP. If you specify - // launchTemplate, then don't specify remoteAccess, or the node group deployment - // will fail. For more information about using launch templates with Amazon EKS, - // see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate + // , then don't specify remoteAccess , or the node group deployment will fail. For + // more information about using launch templates with Amazon EKS, see Launch + // template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. RemoteAccess *types.RemoteAccessConfig - // The scaling configuration details for the Auto Scaling group that is created for - // your node group. + // The scaling configuration details for the Auto Scaling group that is created + // for your node group. ScalingConfig *types.NodegroupScalingConfig // The metadata to apply to the node group to assist with categorization and @@ -171,19 +158,19 @@ type CreateNodegroupInput struct { Tags map[string]string // The Kubernetes taints to be applied to the nodes in the node group. For more - // information, see Node taints on managed node groups - // (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). + // information, see Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) + // . Taints []types.Taint // The node group update configuration. UpdateConfig *types.NodegroupUpdateConfig - // The Kubernetes version to use for your managed nodes. By default, the Kubernetes - // version of the cluster is used, and this is the only accepted specified value. - // If you specify launchTemplate, and your launch template uses a custom AMI, then - // don't specify version, or the node group deployment will fail. For more - // information about using launch templates with Amazon EKS, see Launch template - // support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // The Kubernetes version to use for your managed nodes. By default, the + // Kubernetes version of the cluster is used, and this is the only accepted + // specified value. If you specify launchTemplate , and your launch template uses a + // custom AMI, then don't specify version , or the node group deployment will fail. + // For more information about using launch templates with Amazon EKS, see Launch + // template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) // in the Amazon EKS User Guide. Version *string diff --git a/service/eks/api_op_DeleteAddon.go b/service/eks/api_op_DeleteAddon.go index 499c008c92e..2e579e3b058 100644 --- a/service/eks/api_op_DeleteAddon.go +++ b/service/eks/api_op_DeleteAddon.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an Amazon EKS add-on. When you remove the add-on, it will also be deleted -// from the cluster. You can always manually start an add-on on the cluster using -// the Kubernetes API. +// Delete an Amazon EKS add-on. When you remove the add-on, it will also be +// deleted from the cluster. You can always manually start an add-on on the cluster +// using the Kubernetes API. func (c *Client) DeleteAddon(ctx context.Context, params *DeleteAddonInput, optFns ...func(*Options)) (*DeleteAddonOutput, error) { if params == nil { params = &DeleteAddonInput{} @@ -32,8 +32,8 @@ func (c *Client) DeleteAddon(ctx context.Context, params *DeleteAddonInput, optF type DeleteAddonInput struct { // The name of the add-on. The name must match one of the names returned by - // ListAddons - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). + // ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html) + // . // // This member is required. AddonName *string @@ -53,9 +53,8 @@ type DeleteAddonInput struct { type DeleteAddonOutput struct { - // An Amazon EKS add-on. For more information, see Amazon EKS add-ons - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the - // Amazon EKS User Guide. + // An Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) + // in the Amazon EKS User Guide. Addon *types.Addon // Metadata pertaining to the operation's result. diff --git a/service/eks/api_op_DeleteCluster.go b/service/eks/api_op_DeleteCluster.go index 496f98efaa1..fd41e3c3a60 100644 --- a/service/eks/api_op_DeleteCluster.go +++ b/service/eks/api_op_DeleteCluster.go @@ -19,7 +19,7 @@ import ( // Cluster (https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) // in the Amazon EKS User Guide. If you have managed node groups or Fargate // profiles attached to the cluster, you must delete them first. For more -// information, see DeleteNodegroup and DeleteFargateProfile. +// information, see DeleteNodegroup and DeleteFargateProfile . func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error) { if params == nil { params = &DeleteClusterInput{} diff --git a/service/eks/api_op_DescribeAddon.go b/service/eks/api_op_DescribeAddon.go index f269399624a..609da3cb48e 100644 --- a/service/eks/api_op_DescribeAddon.go +++ b/service/eks/api_op_DescribeAddon.go @@ -36,8 +36,8 @@ func (c *Client) DescribeAddon(ctx context.Context, params *DescribeAddonInput, type DescribeAddonInput struct { // The name of the add-on. The name must match one of the names returned by - // ListAddons - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). + // ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html) + // . // // This member is required. AddonName *string @@ -52,9 +52,8 @@ type DescribeAddonInput struct { type DescribeAddonOutput struct { - // An Amazon EKS add-on. For more information, see Amazon EKS add-ons - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the - // Amazon EKS User Guide. + // An Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) + // in the Amazon EKS User Guide. Addon *types.Addon // Metadata pertaining to the operation's result. @@ -146,9 +145,9 @@ type AddonActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AddonActiveWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AddonActiveWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -339,9 +338,9 @@ type AddonDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AddonDeletedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AddonDeletedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/eks/api_op_DescribeAddonConfiguration.go b/service/eks/api_op_DescribeAddonConfiguration.go index 447cd9f2c27..3b8c1c0c39b 100644 --- a/service/eks/api_op_DescribeAddonConfiguration.go +++ b/service/eks/api_op_DescribeAddonConfiguration.go @@ -29,16 +29,15 @@ func (c *Client) DescribeAddonConfiguration(ctx context.Context, params *Describ type DescribeAddonConfigurationInput struct { // The name of the add-on. The name must match one of the names that - // DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) // returns. // // This member is required. AddonName *string // The version of the add-on. The version must match one of the versions returned - // by DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). + // by DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // . // // This member is required. AddonVersion *string @@ -52,8 +51,8 @@ type DescribeAddonConfigurationOutput struct { AddonName *string // The version of the add-on. The version must match one of the versions returned - // by DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). + // by DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // . AddonVersion *string // A JSON schema that's used to validate the configuration values that you provide diff --git a/service/eks/api_op_DescribeAddonVersions.go b/service/eks/api_op_DescribeAddonVersions.go index 59966d50275..f960767d276 100644 --- a/service/eks/api_op_DescribeAddonVersions.go +++ b/service/eks/api_op_DescribeAddonVersions.go @@ -13,8 +13,8 @@ import ( ) // Describes the versions for an add-on. Information such as the Kubernetes -// versions that you can use the add-on with, the owner, publisher, and the type of -// the add-on are returned. +// versions that you can use the add-on with, the owner , publisher , and the type +// of the add-on are returned. func (c *Client) DescribeAddonVersions(ctx context.Context, params *DescribeAddonVersionsInput, optFns ...func(*Options)) (*DescribeAddonVersionsOutput, error) { if params == nil { params = &DescribeAddonVersionsInput{} @@ -33,8 +33,8 @@ func (c *Client) DescribeAddonVersions(ctx context.Context, params *DescribeAddo type DescribeAddonVersionsInput struct { // The name of the add-on. The name must match one of the names returned by - // ListAddons - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). + // ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html) + // . AddonName *string // The Kubernetes versions that you can use the add-on with. @@ -51,15 +51,15 @@ type DescribeAddonVersionsInput struct { // for other programmatic purposes. NextToken *string - // The owner of the add-on. For valid owners, don't specify a value for this + // The owner of the add-on. For valid owners , don't specify a value for this // property. Owners []string - // The publisher of the add-on. For valid publishers, don't specify a value for + // The publisher of the add-on. For valid publishers , don't specify a value for // this property. Publishers []string - // The type of the add-on. For valid types, don't specify a value for this + // The type of the add-on. For valid types , don't specify a value for this // property. Types []string @@ -73,11 +73,11 @@ type DescribeAddonVersionsOutput struct { Addons []types.AddonInfo // The nextToken value returned from a previous paginated - // DescribeAddonVersionsResponse where maxResults was used and the results exceeded - // the value of that parameter. Pagination continues from the end of the previous - // results that returned the nextToken value. This token should be treated as an - // opaque identifier that is used only to retrieve the next items in a list and not - // for other programmatic purposes. + // DescribeAddonVersionsResponse where maxResults was used and the results + // exceeded the value of that parameter. Pagination continues from the end of the + // previous results that returned the nextToken value. This token should be + // treated as an opaque identifier that is used only to retrieve the next items in + // a list and not for other programmatic purposes. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/eks/api_op_DescribeCluster.go b/service/eks/api_op_DescribeCluster.go index 8f38f540e8e..44e57232456 100644 --- a/service/eks/api_op_DescribeCluster.go +++ b/service/eks/api_op_DescribeCluster.go @@ -19,11 +19,10 @@ import ( // Returns descriptive information about an Amazon EKS cluster. The API server // endpoint and certificate authority data returned by this operation are required -// for kubelet and kubectl to communicate with your Kubernetes API server. For more -// information, see Create a kubeconfig for Amazon EKS -// (https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html). The -// API server endpoint and certificate authority data aren't available until the -// cluster reaches the ACTIVE state. +// for kubelet and kubectl to communicate with your Kubernetes API server. For +// more information, see Create a kubeconfig for Amazon EKS (https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) +// . The API server endpoint and certificate authority data aren't available until +// the cluster reaches the ACTIVE state. func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error) { if params == nil { params = &DescribeClusterInput{} @@ -144,8 +143,8 @@ type ClusterActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterActiveWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterActiveWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -194,9 +193,10 @@ func (w *ClusterActiveWaiter) Wait(ctx context.Context, params *DescribeClusterI return err } -// WaitForOutput calls the waiter function for ClusterActive waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for ClusterActive waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *ClusterActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterActiveWaiterOptions)) (*DescribeClusterOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -337,9 +337,9 @@ type ClusterDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/eks/api_op_DescribeFargateProfile.go b/service/eks/api_op_DescribeFargateProfile.go index 6fb578a3ed2..b57007d8612 100644 --- a/service/eks/api_op_DescribeFargateProfile.go +++ b/service/eks/api_op_DescribeFargateProfile.go @@ -144,9 +144,10 @@ type FargateProfileActiveWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FargateProfileActiveWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FargateProfileActiveWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -322,9 +323,10 @@ type FargateProfileDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FargateProfileDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FargateProfileDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/eks/api_op_DescribeNodegroup.go b/service/eks/api_op_DescribeNodegroup.go index d176d40ab0c..960dd3466bb 100644 --- a/service/eks/api_op_DescribeNodegroup.go +++ b/service/eks/api_op_DescribeNodegroup.go @@ -143,9 +143,9 @@ type NodegroupActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NodegroupActiveWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NodegroupActiveWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -185,9 +185,9 @@ func NewNodegroupActiveWaiter(client DescribeNodegroupAPIClient, optFns ...func( } } -// Wait calls the waiter function for NodegroupActive waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for NodegroupActive waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *NodegroupActiveWaiter) Wait(ctx context.Context, params *DescribeNodegroupInput, maxWaitDur time.Duration, optFns ...func(*NodegroupActiveWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -320,9 +320,9 @@ type NodegroupDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NodegroupDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NodegroupDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/eks/api_op_DescribeUpdate.go b/service/eks/api_op_DescribeUpdate.go index 8c49f7d4b8f..46699bc5a2c 100644 --- a/service/eks/api_op_DescribeUpdate.go +++ b/service/eks/api_op_DescribeUpdate.go @@ -13,8 +13,8 @@ import ( // Returns descriptive information about an update against your Amazon EKS cluster // or associated managed node group or Amazon EKS add-on. When the status of the -// update is Succeeded, the update is complete. If an update fails, the status is -// Failed, and an error detail explains the reason for the failure. +// update is Succeeded , the update is complete. If an update fails, the status is +// Failed , and an error detail explains the reason for the failure. func (c *Client) DescribeUpdate(ctx context.Context, params *DescribeUpdateInput, optFns ...func(*Options)) (*DescribeUpdateOutput, error) { if params == nil { params = &DescribeUpdateInput{} @@ -43,13 +43,12 @@ type DescribeUpdateInput struct { UpdateId *string // The name of the add-on. The name must match one of the names returned by - // ListAddons - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). This - // parameter is required if the update is an add-on update. + // ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html) + // . This parameter is required if the update is an add-on update. AddonName *string - // The name of the Amazon EKS node group associated with the update. This parameter - // is required if the update is a node group update. + // The name of the Amazon EKS node group associated with the update. This + // parameter is required if the update is a node group update. NodegroupName *string noSmithyDocumentSerde diff --git a/service/eks/api_op_ListAddons.go b/service/eks/api_op_ListAddons.go index fc3b1455c6f..7f5b8510baf 100644 --- a/service/eks/api_op_ListAddons.go +++ b/service/eks/api_op_ListAddons.go @@ -39,8 +39,8 @@ type ListAddonsInput struct { // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another // ListAddonsRequest request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up - // to 100 results and a nextToken value, if applicable. + // between 1 and 100. If you don't use this parameter, ListAddonsRequest returns + // up to 100 results and a nextToken value, if applicable. MaxResults *int32 // The nextToken value returned from a previous paginated ListAddonsRequest where @@ -150,8 +150,8 @@ type ListAddonsPaginatorOptions struct { // results in a single page along with a nextToken response element. You can see // the remaining results of the initial request by sending another // ListAddonsRequest request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up - // to 100 results and a nextToken value, if applicable. + // between 1 and 100. If you don't use this parameter, ListAddonsRequest returns + // up to 100 results and a nextToken value, if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/eks/api_op_ListClusters.go b/service/eks/api_op_ListClusters.go index 29fe17aac9a..431ec82e84d 100644 --- a/service/eks/api_op_ListClusters.go +++ b/service/eks/api_op_ListClusters.go @@ -30,9 +30,9 @@ func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, op type ListClustersInput struct { - // Indicates whether external clusters are included in the returned list. Use 'all' - // to return connected clusters, or blank to return only Amazon EKS clusters. 'all' - // must be in lowercase otherwise an error occurs. + // Indicates whether external clusters are included in the returned list. Use ' all + // ' to return connected clusters, or blank to return only Amazon EKS clusters. ' + // all ' must be in lowercase otherwise an error occurs. Include []string // The maximum number of cluster results returned by ListClusters in paginated @@ -61,7 +61,7 @@ type ListClustersOutput struct { Clusters []string // The nextToken value to include in a future ListClusters request. When the - // results of a ListClusters request exceed maxResults, you can use this value to + // results of a ListClusters request exceed maxResults , you can use this value to // retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string diff --git a/service/eks/api_op_ListFargateProfiles.go b/service/eks/api_op_ListFargateProfiles.go index 84b7a0d68f5..2845721de85 100644 --- a/service/eks/api_op_ListFargateProfiles.go +++ b/service/eks/api_op_ListFargateProfiles.go @@ -36,13 +36,14 @@ type ListFargateProfilesInput struct { // This member is required. ClusterName *string - // The maximum number of Fargate profile results returned by ListFargateProfiles in - // paginated output. When you use this parameter, ListFargateProfiles returns only - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another - // ListFargateProfiles request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListFargateProfiles returns - // up to 100 results and a nextToken value if applicable. + // The maximum number of Fargate profile results returned by ListFargateProfiles + // in paginated output. When you use this parameter, ListFargateProfiles returns + // only maxResults results in a single page along with a nextToken response + // element. You can see the remaining results of the initial request by sending + // another ListFargateProfiles request with the returned nextToken value. This + // value can be between 1 and 100. If you don't use this parameter, + // ListFargateProfiles returns up to 100 results and a nextToken value if + // applicable. MaxResults *int32 // The nextToken value returned from a previous paginated ListFargateProfiles @@ -59,10 +60,10 @@ type ListFargateProfilesOutput struct { // A list of all of the Fargate profiles associated with the specified cluster. FargateProfileNames []string - // The nextToken value to include in a future ListFargateProfiles request. When the - // results of a ListFargateProfiles request exceed maxResults, you can use this - // value to retrieve the next page of results. This value is null when there are no - // more results to return. + // The nextToken value to include in a future ListFargateProfiles request. When + // the results of a ListFargateProfiles request exceed maxResults , you can use + // this value to retrieve the next page of results. This value is null when there + // are no more results to return. NextToken *string // Metadata pertaining to the operation's result. @@ -134,8 +135,8 @@ func (c *Client) addOperationListFargateProfilesMiddlewares(stack *middleware.St return nil } -// ListFargateProfilesAPIClient is a client that implements the ListFargateProfiles -// operation. +// ListFargateProfilesAPIClient is a client that implements the +// ListFargateProfiles operation. type ListFargateProfilesAPIClient interface { ListFargateProfiles(context.Context, *ListFargateProfilesInput, ...func(*Options)) (*ListFargateProfilesOutput, error) } @@ -145,13 +146,14 @@ var _ ListFargateProfilesAPIClient = (*Client)(nil) // ListFargateProfilesPaginatorOptions is the paginator options for // ListFargateProfiles type ListFargateProfilesPaginatorOptions struct { - // The maximum number of Fargate profile results returned by ListFargateProfiles in - // paginated output. When you use this parameter, ListFargateProfiles returns only - // maxResults results in a single page along with a nextToken response element. You - // can see the remaining results of the initial request by sending another - // ListFargateProfiles request with the returned nextToken value. This value can be - // between 1 and 100. If you don't use this parameter, ListFargateProfiles returns - // up to 100 results and a nextToken value if applicable. + // The maximum number of Fargate profile results returned by ListFargateProfiles + // in paginated output. When you use this parameter, ListFargateProfiles returns + // only maxResults results in a single page along with a nextToken response + // element. You can see the remaining results of the initial request by sending + // another ListFargateProfiles request with the returned nextToken value. This + // value can be between 1 and 100. If you don't use this parameter, + // ListFargateProfiles returns up to 100 results and a nextToken value if + // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/eks/api_op_ListNodegroups.go b/service/eks/api_op_ListNodegroups.go index 7f9a56ba0ab..c8dc6051016 100644 --- a/service/eks/api_op_ListNodegroups.go +++ b/service/eks/api_op_ListNodegroups.go @@ -36,13 +36,13 @@ type ListNodegroupsInput struct { // This member is required. ClusterName *string - // The maximum number of node group results returned by ListNodegroups in paginated - // output. When you use this parameter, ListNodegroups returns only maxResults - // results in a single page along with a nextToken response element. You can see - // the remaining results of the initial request by sending another ListNodegroups - // request with the returned nextToken value. This value can be between 1 and 100. - // If you don't use this parameter, ListNodegroups returns up to 100 results and a - // nextToken value if applicable. + // The maximum number of node group results returned by ListNodegroups in + // paginated output. When you use this parameter, ListNodegroups returns only + // maxResults results in a single page along with a nextToken response element. + // You can see the remaining results of the initial request by sending another + // ListNodegroups request with the returned nextToken value. This value can be + // between 1 and 100. If you don't use this parameter, ListNodegroups returns up + // to 100 results and a nextToken value if applicable. MaxResults *int32 // The nextToken value returned from a previous paginated ListNodegroups request @@ -57,8 +57,8 @@ type ListNodegroupsInput struct { type ListNodegroupsOutput struct { // The nextToken value to include in a future ListNodegroups request. When the - // results of a ListNodegroups request exceed maxResults, you can use this value to - // retrieve the next page of results. This value is null when there are no more + // results of a ListNodegroups request exceed maxResults , you can use this value + // to retrieve the next page of results. This value is null when there are no more // results to return. NextToken *string @@ -144,13 +144,13 @@ var _ ListNodegroupsAPIClient = (*Client)(nil) // ListNodegroupsPaginatorOptions is the paginator options for ListNodegroups type ListNodegroupsPaginatorOptions struct { - // The maximum number of node group results returned by ListNodegroups in paginated - // output. When you use this parameter, ListNodegroups returns only maxResults - // results in a single page along with a nextToken response element. You can see - // the remaining results of the initial request by sending another ListNodegroups - // request with the returned nextToken value. This value can be between 1 and 100. - // If you don't use this parameter, ListNodegroups returns up to 100 results and a - // nextToken value if applicable. + // The maximum number of node group results returned by ListNodegroups in + // paginated output. When you use this parameter, ListNodegroups returns only + // maxResults results in a single page along with a nextToken response element. + // You can see the remaining results of the initial request by sending another + // ListNodegroups request with the returned nextToken value. This value can be + // between 1 and 100. If you don't use this parameter, ListNodegroups returns up + // to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/eks/api_op_ListUpdates.go b/service/eks/api_op_ListUpdates.go index 84ea11b26ed..0bdcb8f3e6c 100644 --- a/service/eks/api_op_ListUpdates.go +++ b/service/eks/api_op_ListUpdates.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the updates associated with an Amazon EKS cluster or managed node group in -// your Amazon Web Services account, in the specified Region. +// Lists the updates associated with an Amazon EKS cluster or managed node group +// in your Amazon Web Services account, in the specified Region. func (c *Client) ListUpdates(ctx context.Context, params *ListUpdatesInput, optFns ...func(*Options)) (*ListUpdatesOutput, error) { if params == nil { params = &ListUpdatesInput{} @@ -39,16 +39,16 @@ type ListUpdatesInput struct { AddonName *string // The maximum number of update results returned by ListUpdates in paginated - // output. When you use this parameter, ListUpdates returns only maxResults results - // in a single page along with a nextToken response element. You can see the - // remaining results of the initial request by sending another ListUpdates request - // with the returned nextToken value. This value can be between 1 and 100. If you - // don't use this parameter, ListUpdates returns up to 100 results and a nextToken - // value if applicable. + // output. When you use this parameter, ListUpdates returns only maxResults + // results in a single page along with a nextToken response element. You can see + // the remaining results of the initial request by sending another ListUpdates + // request with the returned nextToken value. This value can be between 1 and 100. + // If you don't use this parameter, ListUpdates returns up to 100 results and a + // nextToken value if applicable. MaxResults *int32 - // The nextToken value returned from a previous paginated ListUpdates request where - // maxResults was used and the results exceeded the value of that parameter. + // The nextToken value returned from a previous paginated ListUpdates request + // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. NextToken *string @@ -61,10 +61,10 @@ type ListUpdatesInput struct { type ListUpdatesOutput struct { - // The nextToken value to include in a future ListUpdates request. When the results - // of a ListUpdates request exceed maxResults, you can use this value to retrieve - // the next page of results. This value is null when there are no more results to - // return. + // The nextToken value to include in a future ListUpdates request. When the + // results of a ListUpdates request exceed maxResults , you can use this value to + // retrieve the next page of results. This value is null when there are no more + // results to return. NextToken *string // A list of all the updates for the specified cluster and Region. @@ -149,12 +149,12 @@ var _ ListUpdatesAPIClient = (*Client)(nil) // ListUpdatesPaginatorOptions is the paginator options for ListUpdates type ListUpdatesPaginatorOptions struct { // The maximum number of update results returned by ListUpdates in paginated - // output. When you use this parameter, ListUpdates returns only maxResults results - // in a single page along with a nextToken response element. You can see the - // remaining results of the initial request by sending another ListUpdates request - // with the returned nextToken value. This value can be between 1 and 100. If you - // don't use this parameter, ListUpdates returns up to 100 results and a nextToken - // value if applicable. + // output. When you use this parameter, ListUpdates returns only maxResults + // results in a single page along with a nextToken response element. You can see + // the remaining results of the initial request by sending another ListUpdates + // request with the returned nextToken value. This value can be between 1 and 100. + // If you don't use this parameter, ListUpdates returns up to 100 results and a + // nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/eks/api_op_RegisterCluster.go b/service/eks/api_op_RegisterCluster.go index b156dff84f3..ceda43bbdd2 100644 --- a/service/eks/api_op_RegisterCluster.go +++ b/service/eks/api_op_RegisterCluster.go @@ -16,14 +16,13 @@ import ( // cluster can be connected to the Amazon EKS control plane to view current // information about the cluster and its nodes. Cluster connection requires two // steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control -// plane. Second, a Manifest -// (https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml) -// containing the activationID and activationCode must be applied to the Kubernetes -// cluster through it's native provider to provide visibility. After the Manifest -// is updated and applied, then the connected cluster is visible to the Amazon EKS -// control plane. If the Manifest is not applied within three days, then the -// connected cluster will no longer be visible and must be deregistered. See -// DeregisterCluster. +// plane. Second, a Manifest (https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml) +// containing the activationID and activationCode must be applied to the +// Kubernetes cluster through it's native provider to provide visibility. After the +// Manifest is updated and applied, then the connected cluster is visible to the +// Amazon EKS control plane. If the Manifest is not applied within three days, then +// the connected cluster will no longer be visible and must be deregistered. See +// DeregisterCluster . func (c *Client) RegisterCluster(ctx context.Context, params *RegisterClusterInput, optFns ...func(*Options)) (*RegisterClusterOutput, error) { if params == nil { params = &RegisterClusterInput{} diff --git a/service/eks/api_op_TagResource.go b/service/eks/api_op_TagResource.go index 9fb7ecee5d5..23b17d3cb83 100644 --- a/service/eks/api_op_TagResource.go +++ b/service/eks/api_op_TagResource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource are not specified in the request parameters, they // are not changed. When a resource is deleted, the tags associated with that // resource are deleted as well. Tags that you create for Amazon EKS resources do diff --git a/service/eks/api_op_UpdateAddon.go b/service/eks/api_op_UpdateAddon.go index 0c405d34def..303e7e812eb 100644 --- a/service/eks/api_op_UpdateAddon.go +++ b/service/eks/api_op_UpdateAddon.go @@ -31,8 +31,8 @@ func (c *Client) UpdateAddon(ctx context.Context, params *UpdateAddonInput, optF type UpdateAddonInput struct { // The name of the add-on. The name must match one of the names returned by - // ListAddons - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). + // ListAddons (https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html) + // . // // This member is required. AddonName *string @@ -43,8 +43,8 @@ type UpdateAddonInput struct { ClusterName *string // The version of the add-on. The version must match one of the versions returned - // by DescribeAddonVersions - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). + // by DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html) + // . AddonVersion *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of @@ -52,35 +52,29 @@ type UpdateAddonInput struct { ClientRequestToken *string // The set of configuration values for the add-on that's created. The values that - // you provide are validated against the schema in DescribeAddonConfiguration - // (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html). + // you provide are validated against the schema in DescribeAddonConfiguration (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonConfiguration.html) + // . ConfigurationValues *string // How to resolve field value conflicts for an Amazon EKS add-on if you've changed // a value from the Amazon EKS default value. Conflicts are handled based on the // option you choose: - // - // * None – Amazon EKS doesn't change the value. The update - // might fail. - // - // * Overwrite – Amazon EKS overwrites the changed value back to the - // Amazon EKS default value. - // - // * Preserve – Amazon EKS preserves the value. If you - // choose this option, we recommend that you test any field and value changes on a - // non-production cluster before updating the add-on on your production cluster. + // - None – Amazon EKS doesn't change the value. The update might fail. + // - Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS + // default value. + // - Preserve – Amazon EKS preserves the value. If you choose this option, we + // recommend that you test any field and value changes on a non-production cluster + // before updating the add-on on your production cluster. ResolveConflicts types.ResolveConflicts // The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's // service account. The role must be assigned the IAM permissions required by the // add-on. If you don't specify an existing IAM role, then the add-on uses the // permissions assigned to the node IAM role. For more information, see Amazon EKS - // node IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the - // Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM - // OpenID Connect (OIDC) provider created for your cluster. For more information, - // see Enabling IAM roles for service accounts on your cluster - // (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) + // node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) + // in the Amazon EKS User Guide. To specify an existing IAM role, you must have an + // IAM OpenID Connect (OIDC) provider created for your cluster. For more + // information, see Enabling IAM roles for service accounts on your cluster (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) // in the Amazon EKS User Guide. ServiceAccountRoleArn *string diff --git a/service/eks/api_op_UpdateClusterConfig.go b/service/eks/api_op_UpdateClusterConfig.go index 86d0899baa2..81cbc78b0dd 100644 --- a/service/eks/api_op_UpdateClusterConfig.go +++ b/service/eks/api_op_UpdateClusterConfig.go @@ -18,21 +18,19 @@ import ( // You can use this API operation to enable or disable exporting the Kubernetes // control plane logs for your cluster to CloudWatch Logs. By default, cluster // control plane logs aren't exported to CloudWatch Logs. For more information, see -// Amazon EKS Cluster Control Plane Logs -// (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in -// the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data -// scanning rates apply to exported control plane logs. For more information, see -// CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). You can also use -// this API operation to enable or disable public and private access to your -// cluster's Kubernetes API server endpoint. By default, public access is enabled, -// and private access is disabled. For more information, see Amazon EKS cluster -// endpoint access control -// (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the -// Amazon EKS User Guide . You can't update the subnets or security group IDs for -// an existing cluster. Cluster updates are asynchronous, and they should finish -// within a few minutes. During an update, the cluster status moves to UPDATING -// (this status transition is eventually consistent). When the update is complete -// (either Failed or Successful), the cluster status moves to Active. +// Amazon EKS Cluster Control Plane Logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) +// in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and +// data scanning rates apply to exported control plane logs. For more information, +// see CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/) . You can +// also use this API operation to enable or disable public and private access to +// your cluster's Kubernetes API server endpoint. By default, public access is +// enabled, and private access is disabled. For more information, see Amazon EKS +// cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) +// in the Amazon EKS User Guide . You can't update the subnets or security group +// IDs for an existing cluster. Cluster updates are asynchronous, and they should +// finish within a few minutes. During an update, the cluster status moves to +// UPDATING (this status transition is eventually consistent). When the update is +// complete (either Failed or Successful ), the cluster status moves to Active . func (c *Client) UpdateClusterConfig(ctx context.Context, params *UpdateClusterConfigInput, optFns ...func(*Options)) (*UpdateClusterConfigOutput, error) { if params == nil { params = &UpdateClusterConfigInput{} @@ -61,11 +59,10 @@ type UpdateClusterConfigInput struct { // Enable or disable exporting the Kubernetes control plane logs for your cluster // to CloudWatch Logs. By default, cluster control plane logs aren't exported to - // CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs - // (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in - // the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data - // scanning rates apply to exported control plane logs. For more information, see - // CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/). + // CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) + // in the Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and + // data scanning rates apply to exported control plane logs. For more information, + // see CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/) . Logging *types.Logging // An object representing the VPC configuration to use for an Amazon EKS cluster. diff --git a/service/eks/api_op_UpdateClusterVersion.go b/service/eks/api_op_UpdateClusterVersion.go index 2653a7e9018..4074f145369 100644 --- a/service/eks/api_op_UpdateClusterVersion.go +++ b/service/eks/api_op_UpdateClusterVersion.go @@ -18,7 +18,7 @@ import ( // DescribeUpdate API operation. Cluster updates are asynchronous, and they should // finish within a few minutes. During an update, the cluster status moves to // UPDATING (this status transition is eventually consistent). When the update is -// complete (either Failed or Successful), the cluster status moves to Active. If +// complete (either Failed or Successful ), the cluster status moves to Active . If // your cluster has managed node groups attached to it, all of your node groups’ // Kubernetes versions must match the cluster’s Kubernetes version in order to // update the cluster to a new Kubernetes version. diff --git a/service/eks/api_op_UpdateNodegroupConfig.go b/service/eks/api_op_UpdateNodegroupConfig.go index 154d9a2e73e..0b7ece0c80e 100644 --- a/service/eks/api_op_UpdateNodegroupConfig.go +++ b/service/eks/api_op_UpdateNodegroupConfig.go @@ -56,8 +56,8 @@ type UpdateNodegroupConfigInput struct { ScalingConfig *types.NodegroupScalingConfig // The Kubernetes taints to be applied to the nodes in the node group after the - // update. For more information, see Node taints on managed node groups - // (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). + // update. For more information, see Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) + // . Taints *types.UpdateTaintsPayload // The node group update configuration. diff --git a/service/eks/api_op_UpdateNodegroupVersion.go b/service/eks/api_op_UpdateNodegroupVersion.go index 1eff1a9f91c..affba0433ab 100644 --- a/service/eks/api_op_UpdateNodegroupVersion.go +++ b/service/eks/api_op_UpdateNodegroupVersion.go @@ -23,11 +23,9 @@ import ( // Kubernetes version in the request. You can update to the latest AMI version of // your cluster's current Kubernetes version by specifying your cluster's // Kubernetes version in the request. For information about Linux versions, see -// Amazon EKS optimized Amazon Linux AMI versions -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) -// in the Amazon EKS User Guide. For information about Windows versions, see Amazon -// EKS optimized Windows AMI versions -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) +// Amazon EKS optimized Amazon Linux AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) +// in the Amazon EKS User Guide. For information about Windows versions, see +// Amazon EKS optimized Windows AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) // in the Amazon EKS User Guide. You cannot roll back a node group to an earlier // Kubernetes version or AMI version. When a node in a managed node group is // terminated due to a scaling action or update, the pods in that node are drained @@ -80,29 +78,25 @@ type UpdateNodegroupVersionInput struct { // The AMI version of the Amazon EKS optimized AMI to use for the update. By // default, the latest available AMI version for the node group's Kubernetes // version is used. For information about Linux versions, see Amazon EKS optimized - // Amazon Linux AMI versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) + // Amazon Linux AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) // in the Amazon EKS User Guide. Amazon EKS managed node groups support the // November 2022 and later releases of the Windows AMIs. For information about - // Windows versions, see Amazon EKS optimized Windows AMI versions - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) - // in the Amazon EKS User Guide. If you specify launchTemplate, and your launch - // template uses a custom AMI, then don't specify releaseVersion, or the node group - // update will fail. For more information about using launch templates with Amazon - // EKS, see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // Windows versions, see Amazon EKS optimized Windows AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) + // in the Amazon EKS User Guide. If you specify launchTemplate , and your launch + // template uses a custom AMI, then don't specify releaseVersion , or the node + // group update will fail. For more information about using launch templates with + // Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. ReleaseVersion *string // The Kubernetes version to update to. If no version is specified, then the // Kubernetes version of the node group does not change. You can specify the // Kubernetes version of the cluster to update the node group to the latest AMI - // version of the cluster's Kubernetes version. If you specify launchTemplate, and - // your launch template uses a custom AMI, then don't specify version, or the node + // version of the cluster's Kubernetes version. If you specify launchTemplate , and + // your launch template uses a custom AMI, then don't specify version , or the node // group update will fail. For more information about using launch templates with - // Amazon EKS, see Launch template support - // (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the - // Amazon EKS User Guide. + // Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) + // in the Amazon EKS User Guide. Version *string noSmithyDocumentSerde diff --git a/service/eks/types/enums.go b/service/eks/types/enums.go index c6156bf5e4c..6e080d8de44 100644 --- a/service/eks/types/enums.go +++ b/service/eks/types/enums.go @@ -179,9 +179,9 @@ const ( ConfigStatusActive ConfigStatus = "ACTIVE" ) -// Values returns all known values for ConfigStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConfigStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ConfigStatus) Values() []ConfigStatus { return []ConfigStatus{ "CREATING", @@ -245,9 +245,9 @@ const ( ErrorCodeK8sResourceNotFound ErrorCode = "K8sResourceNotFound" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "SubnetNotFound", @@ -526,9 +526,9 @@ const ( UpdateStatusSuccessful UpdateStatus = "Successful" ) -// Values returns all known values for UpdateStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpdateStatus) Values() []UpdateStatus { return []UpdateStatus{ "InProgress", diff --git a/service/eks/types/errors.go b/service/eks/types/errors.go index 03722b63979..cadcc26ee55 100644 --- a/service/eks/types/errors.go +++ b/service/eks/types/errors.go @@ -64,9 +64,9 @@ func (e *BadRequestException) ErrorCode() string { } func (e *BadRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// These errors are usually caused by a client action. Actions can include using an -// action or resource on behalf of a user that doesn't have permissions to use the -// action or resource or specifying an identifier that is not valid. +// These errors are usually caused by a client action. Actions can include using +// an action or resource on behalf of a user that doesn't have permissions to use +// the action or resource or specifying an identifier that is not valid. type ClientException struct { Message *string @@ -246,8 +246,8 @@ func (e *ResourceLimitExceededException) ErrorCode() string { func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified resource could not be found. You can view your available clusters -// with ListClusters. You can view your available managed node groups with -// ListNodegroups. Amazon EKS clusters and node groups are Region-specific. +// with ListClusters . You can view your available managed node groups with +// ListNodegroups . Amazon EKS clusters and node groups are Region-specific. type ResourceNotFoundException struct { Message *string diff --git a/service/eks/types/types.go b/service/eks/types/types.go index 5654f016046..a2abbc22c63 100644 --- a/service/eks/types/types.go +++ b/service/eks/types/types.go @@ -7,9 +7,8 @@ import ( "time" ) -// An Amazon EKS add-on. For more information, see Amazon EKS add-ons -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the -// Amazon EKS User Guide. +// An Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) +// in the Amazon EKS User Guide. type Addon struct { // The Amazon Resource Name (ARN) of the add-on. @@ -201,23 +200,20 @@ type Cluster struct { OutpostConfig *OutpostConfigResponse // The platform version of your Amazon EKS cluster. For more information, see - // Platform Versions - // (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) in the - // Amazon EKS User Guide . + // Platform Versions (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) + // in the Amazon EKS User Guide . PlatformVersion *string // The VPC configuration used by the cluster control plane. Amazon EKS VPC // resources have specific requirements to work properly with Kubernetes. For more - // information, see Cluster VPC Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and Cluster - // Security Group Considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the - // Amazon EKS User Guide. + // information, see Cluster VPC Considerations (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) + // and Cluster Security Group Considerations (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) + // in the Amazon EKS User Guide. ResourcesVpcConfig *VpcConfigResponse - // The Amazon Resource Name (ARN) of the IAM role that provides permissions for the - // Kubernetes control plane to make calls to Amazon Web Services API operations on - // your behalf. + // The Amazon Resource Name (ARN) of the IAM role that provides permissions for + // the Kubernetes control plane to make calls to Amazon Web Services API operations + // on your behalf. RoleArn *string // The current status of the cluster. @@ -312,8 +308,8 @@ type ConnectorConfigResponse struct { // The cluster's cloud service provider. Provider *string - // The Amazon Resource Name (ARN) of the role to communicate with services from the - // connected Kubernetes cluster. + // The Amazon Resource Name (ARN) of the role to communicate with services from + // the connected Kubernetes cluster. RoleArn *string noSmithyDocumentSerde @@ -321,13 +317,12 @@ type ConnectorConfigResponse struct { // The placement configuration for all the control plane instances of your local // Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see -// Capacity considerations -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) +// Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) // in the Amazon EKS User Guide type ControlPlanePlacementRequest struct { - // The name of the placement group for the Kubernetes control plane instances. This - // setting can't be changed after cluster creation. + // The name of the placement group for the Kubernetes control plane instances. + // This setting can't be changed after cluster creation. GroupName *string noSmithyDocumentSerde @@ -335,8 +330,7 @@ type ControlPlanePlacementRequest struct { // The placement configuration for all the control plane instances of your local // Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see -// Capacity considerations -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) +// Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) // in the Amazon EKS User Guide. type ControlPlanePlacementResponse struct { @@ -362,28 +356,19 @@ type EncryptionConfig struct { type ErrorDetail struct { // A brief description of the error. - // - // * SubnetNotFound: We couldn't find one of the - // subnets associated with the cluster. - // - // * SecurityGroupNotFound: We couldn't find - // one of the security groups associated with the cluster. - // - // * EniLimitReached: You - // have reached the elastic network interface limit for your account. - // - // * - // IpNotAvailable: A subnet associated with the cluster doesn't have any free IP - // addresses. - // - // * AccessDenied: You don't have permissions to perform the specified - // operation. - // - // * OperationNotPermitted: The service role associated with the - // cluster doesn't have the required access permissions for Amazon EKS. - // - // * - // VpcIdNotFound: We couldn't find the VPC associated with the cluster. + // - SubnetNotFound: We couldn't find one of the subnets associated with the + // cluster. + // - SecurityGroupNotFound: We couldn't find one of the security groups + // associated with the cluster. + // - EniLimitReached: You have reached the elastic network interface limit for + // your account. + // - IpNotAvailable: A subnet associated with the cluster doesn't have any free + // IP addresses. + // - AccessDenied: You don't have permissions to perform the specified + // operation. + // - OperationNotPermitted: The service role associated with the cluster doesn't + // have the required access permissions for Amazon EKS. + // - VpcIdNotFound: We couldn't find the VPC associated with the cluster. ErrorCode ErrorCode // A more complete description of the error. @@ -412,9 +397,8 @@ type FargateProfile struct { // The Amazon Resource Name (ARN) of the pod execution role to use for pods that // match the selectors in the Fargate profile. For more information, see Pod - // Execution Role - // (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in - // the Amazon EKS User Guide. + // Execution Role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) + // in the Amazon EKS User Guide. PodExecutionRoleArn *string // The selectors to match for pods to use this Fargate profile. @@ -451,8 +435,8 @@ type FargateProfileSelector struct { // An object representing an identity provider. type Identity struct { - // An object representing the OpenID Connect (https://openid.net/connect/) identity - // provider information. + // An object representing the OpenID Connect (https://openid.net/connect/) + // identity provider information. Oidc *OIDC noSmithyDocumentSerde @@ -466,8 +450,8 @@ type IdentityProviderConfig struct { // This member is required. Name *string - // The type of the identity provider configuration. The only type available is - // oidc. + // The type of the identity provider configuration. The only type available is oidc + // . // // This member is required. Type *string @@ -488,75 +472,51 @@ type IdentityProviderConfigResponse struct { type Issue struct { // A brief description of the error. - // - // * AccessDenied: Amazon EKS or one or more of - // your managed nodes is failing to authenticate or authorize with your Kubernetes - // cluster API server. - // - // * AsgInstanceLaunchFailures: Your Auto Scaling group is - // experiencing failures while attempting to launch instances. - // - // * - // AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated - // with the managed node group. You may be able to recreate an Auto Scaling group - // with the same settings to recover. - // - // * ClusterUnreachable: Amazon EKS or one or - // more of your managed nodes is unable to to communicate with your Kubernetes - // cluster API server. This can happen if there are network disruptions or if API - // servers are timing out processing requests. - // - // * Ec2LaunchTemplateNotFound: We - // couldn't find the Amazon EC2 launch template for your managed node group. You - // may be able to recreate a launch template with the same settings to recover. - // - // * - // Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for - // your managed node group does not match the version that Amazon EKS created. You - // may be able to revert to the version that Amazon EKS created to recover. - // - // * - // Ec2SecurityGroupDeletionFailure: We could not delete the remote access security - // group for your managed node group. Remove any dependencies from the security - // group. - // - // * Ec2SecurityGroupNotFound: We couldn't find the cluster security group - // for the cluster. You must recreate your cluster. - // - // * - // Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a - // node group do not automatically assign public IP addresses to instances launched - // into it. If you want your instances to be assigned a public IP address, then you - // need to enable the auto-assign public IP address setting for the subnet. See - // Modifying the public IPv4 addressing attribute for your subnet - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip) - // in the Amazon VPC User Guide. - // - // * IamInstanceProfileNotFound: We couldn't find - // the IAM instance profile for your managed node group. You may be able to - // recreate an instance profile with the same settings to recover. - // - // * - // IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. - // You may be able to recreate an IAM role with the same settings to recover. - // - // * - // InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any - // more instances of the specified instance type. You may be able to request an - // Amazon EC2 instance limit increase to recover. - // - // * InsufficientFreeAddresses: One - // or more of the subnets associated with your managed node group does not have - // enough available IP addresses for new nodes. - // - // * InternalFailure: These errors - // are usually caused by an Amazon EKS server-side issue. - // - // * NodeCreationFailure: - // Your launched instances are unable to register with your Amazon EKS cluster. - // Common causes of this failure are insufficient node IAM role - // (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) - // permissions or lack of outbound internet access for the nodes. + // - AccessDenied: Amazon EKS or one or more of your managed nodes is failing to + // authenticate or authorize with your Kubernetes cluster API server. + // - AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures + // while attempting to launch instances. + // - AutoScalingGroupNotFound: We couldn't find the Auto Scaling group + // associated with the managed node group. You may be able to recreate an Auto + // Scaling group with the same settings to recover. + // - ClusterUnreachable: Amazon EKS or one or more of your managed nodes is + // unable to to communicate with your Kubernetes cluster API server. This can + // happen if there are network disruptions or if API servers are timing out + // processing requests. + // - Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template + // for your managed node group. You may be able to recreate a launch template with + // the same settings to recover. + // - Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version + // for your managed node group does not match the version that Amazon EKS created. + // You may be able to revert to the version that Amazon EKS created to recover. + // - Ec2SecurityGroupDeletionFailure: We could not delete the remote access + // security group for your managed node group. Remove any dependencies from the + // security group. + // - Ec2SecurityGroupNotFound: We couldn't find the cluster security group for + // the cluster. You must recreate your cluster. + // - Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for + // a node group do not automatically assign public IP addresses to instances + // launched into it. If you want your instances to be assigned a public IP address, + // then you need to enable the auto-assign public IP address setting for the + // subnet. See Modifying the public IPv4 addressing attribute for your subnet (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip) + // in the Amazon VPC User Guide. + // - IamInstanceProfileNotFound: We couldn't find the IAM instance profile for + // your managed node group. You may be able to recreate an instance profile with + // the same settings to recover. + // - IamNodeRoleNotFound: We couldn't find the IAM role for your managed node + // group. You may be able to recreate an IAM role with the same settings to + // recover. + // - InstanceLimitExceeded: Your Amazon Web Services account is unable to launch + // any more instances of the specified instance type. You may be able to request an + // Amazon EC2 instance limit increase to recover. + // - InsufficientFreeAddresses: One or more of the subnets associated with your + // managed node group does not have enough available IP addresses for new nodes. + // - InternalFailure: These errors are usually caused by an Amazon EKS + // server-side issue. + // - NodeCreationFailure: Your launched instances are unable to register with + // your Amazon EKS cluster. Common causes of this failure are insufficient node + // IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) + // permissions or lack of outbound internet access for the nodes. Code NodegroupIssueCode // The error message associated with the issue. @@ -574,37 +534,31 @@ type KubernetesNetworkConfigRequest struct { // Specify which IP family is used to assign Kubernetes pod and service IP // addresses. If you don't specify a value, ipv4 is used by default. You can only // specify an IP family when you create a cluster and can't change this value once - // the cluster is created. If you specify ipv6, the VPC and subnets that you + // the cluster is created. If you specify ipv6 , the VPC and subnets that you // specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned // to them. You can't specify ipv6 for clusters in China Regions. You can only - // specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the - // Amazon VPC CNI add-on. If you specify ipv6, then ensure that your VPC meets the - // requirements listed in the considerations listed in Assigning IPv6 addresses to - // pods and services - // (https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon - // EKS User Guide. Kubernetes assigns services IPv6 addresses from the unique local - // address range (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod - // addresses are assigned from the subnet's IPv6 CIDR. + // specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of + // the Amazon VPC CNI add-on. If you specify ipv6 , then ensure that your VPC meets + // the requirements listed in the considerations listed in Assigning IPv6 + // addresses to pods and services (https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) + // in the Amazon EKS User Guide. Kubernetes assigns services IPv6 addresses from + // the unique local address range (fc00::/7) . You can't specify a custom IPv6 + // CIDR block. Pod addresses are assigned from the subnet's IPv6 CIDR. IpFamily IpFamily // Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign // Kubernetes service IP addresses from. If you don't specify a block, Kubernetes - // assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We - // recommend that you specify a block that does not overlap with resources in other - // networks that are peered or connected to your VPC. The block must meet the + // assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. + // We recommend that you specify a block that does not overlap with resources in + // other networks that are peered or connected to your VPC. The block must meet the // following requirements: - // - // * Within one of the following private IP address - // blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16. - // - // * Doesn't overlap with - // any CIDR block assigned to the VPC that you selected for VPC. - // - // * Between /24 and - // /12. - // - // You can only specify a custom CIDR block when you create a cluster and - // can't change this value once the cluster is created. + // - Within one of the following private IP address blocks: 10.0.0.0/8 , + // 172.16.0.0/12 , or 192.168.0.0/16 . + // - Doesn't overlap with any CIDR block assigned to the VPC that you selected + // for VPC. + // - Between /24 and /12. + // You can only specify a custom CIDR block when you create a cluster and can't + // change this value once the cluster is created. ServiceIpv4Cidr *string noSmithyDocumentSerde @@ -615,9 +569,9 @@ type KubernetesNetworkConfigRequest struct { type KubernetesNetworkConfigResponse struct { // The IP family used to assign Kubernetes pod and service IP addresses. The IP - // family is always ipv4, unless you have a 1.21 or later cluster running version - // 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 when you created - // the cluster. + // family is always ipv4 , unless you have a 1.21 or later cluster running version + // 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 when you + // created the cluster. IpFamily IpFamily // The CIDR block that Kubernetes pod and service IP addresses are assigned from. @@ -628,40 +582,33 @@ type KubernetesNetworkConfigResponse struct { // created and it can't be changed. ServiceIpv4Cidr *string - // The CIDR block that Kubernetes pod and service IP addresses are assigned from if - // you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon - // VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. - // Kubernetes assigns service addresses from the unique local address range - // (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create - // the cluster. + // The CIDR block that Kubernetes pod and service IP addresses are assigned from + // if you created a 1.21 or later cluster with version 1.10.1 or later of the + // Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the + // cluster. Kubernetes assigns service addresses from the unique local address + // range ( fc00::/7 ) because you can't specify a custom IPv6 CIDR block when you + // create the cluster. ServiceIpv6Cidr *string noSmithyDocumentSerde } // An object representing a node group launch template specification. The launch -// template can't include SubnetId -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html), -// IamInstanceProfile -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html), -// RequestSpotInstances -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html), -// HibernationOptions -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html), -// or TerminateInstances -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TerminateInstances.html), -// or the node group deployment or update will fail. For more information about -// launch templates, see CreateLaunchTemplate -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) +// template can't include SubnetId (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) +// , IamInstanceProfile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) +// , RequestSpotInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) +// , HibernationOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html) +// , or TerminateInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TerminateInstances.html) +// , or the node group deployment or update will fail. For more information about +// launch templates, see CreateLaunchTemplate (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) // in the Amazon EC2 API Reference. For more information about using launch -// templates with Amazon EKS, see Launch template support -// (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the -// Amazon EKS User Guide. You must specify either the launch template ID or the -// launch template name in the request, but not both. +// templates with Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) +// in the Amazon EKS User Guide. You must specify either the launch template ID or +// the launch template name in the request, but not both. type LaunchTemplateSpecification struct { - // The ID of the launch template. You must specify either the launch template ID or - // the launch template name in the request, but not both. + // The ID of the launch template. You must specify either the launch template ID + // or the launch template name in the request, but not both. Id *string // The name of the launch template. You must specify either the launch template @@ -684,8 +631,8 @@ type Logging struct { noSmithyDocumentSerde } -// An object representing the enabled or disabled Kubernetes control plane logs for -// your cluster. +// An object representing the enabled or disabled Kubernetes control plane logs +// for your cluster. type LogSetup struct { // If a log type is enabled, that log type exports its control plane logs to @@ -716,7 +663,7 @@ type MarketplaceInformation struct { type Nodegroup struct { // If the node group was deployed using a launch template with a custom AMI, then - // this is CUSTOM. For node groups that weren't deployed using a launch template, + // this is CUSTOM . For node groups that weren't deployed using a launch template, // this is the AMI type that was specified in the node group configuration. AmiType AMITypes @@ -731,7 +678,7 @@ type Nodegroup struct { // If the node group wasn't deployed with a launch template, then this is the disk // size in the node group configuration. If the node group was deployed with a - // launch template, then this is null. + // launch template, then this is null . DiskSize *int32 // The health status of the node group. If there are issues with your node group's @@ -740,7 +687,7 @@ type Nodegroup struct { // If the node group wasn't deployed with a launch template, then this is the // instance type that is associated with the node group. If the node group was - // deployed with a launch template, then this is null. + // deployed with a launch template, then this is null . InstanceTypes []string // The Kubernetes labels applied to the nodes in the node group. Only labels that @@ -756,8 +703,8 @@ type Nodegroup struct { // modified. ModifiedAt *time.Time - // The IAM role associated with your node group. The Amazon EKS node kubelet daemon - // makes calls to Amazon Web Services APIs on your behalf. Nodes receive + // The IAM role associated with your node group. The Amazon EKS node kubelet + // daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive // permissions for these API calls through an IAM instance profile and associated // policies. NodeRole *string @@ -776,7 +723,7 @@ type Nodegroup struct { // If the node group wasn't deployed with a launch template, then this is the // remote access configuration that is associated with the node group. If the node - // group was deployed with a launch template, then this is null. + // group was deployed with a launch template, then this is null . RemoteAccess *RemoteAccessConfig // The resources associated with the node group, such as Auto Scaling groups and @@ -800,12 +747,12 @@ type Nodegroup struct { // group, such as the Amazon EC2 instances or subnets. Tags map[string]string - // The Kubernetes taints to be applied to the nodes in the node group when they are - // created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. + // The Kubernetes taints to be applied to the nodes in the node group when they + // are created. Effect is one of No_Schedule , Prefer_No_Schedule , or No_Execute . // Kubernetes taints can be used together with tolerations to control how workloads // are scheduled to your nodes. For more information, see Node taints on managed - // node groups - // (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). + // node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) + // . Taints []Taint // The node group update configuration. @@ -865,9 +812,8 @@ type NodegroupScalingConfig struct { // The maximum number of nodes that the managed node group can scale out to. For // information about the maximum number that you can specify, see Amazon EKS - // service quotas - // (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the - // Amazon EKS User Guide. + // service quotas (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) + // in the Amazon EKS User Guide. MaxSize *int32 // The minimum number of nodes that the managed node group can scale in to. @@ -917,8 +863,8 @@ type OidcIdentityProviderConfig struct { GroupsClaim *string // The prefix that is prepended to group claims to prevent clashes with existing - // names (such as system: groups). For example, the value oidc: creates group names - // like oidc:engineering and oidc:infra. The prefix can't contain system: + // names (such as system: groups). For example, the value oidc: creates group + // names like oidc:engineering and oidc:infra . The prefix can't contain system: GroupsPrefix *string // The ARN of the configuration. @@ -931,8 +877,8 @@ type OidcIdentityProviderConfig struct { // public signing keys for verifying tokens. IssuerUrl *string - // The key-value pairs that describe required claims in the identity token. If set, - // each claim is verified to be present in the token with a matching value. + // The key-value pairs that describe required claims in the identity token. If + // set, each claim is verified to be present in the token with a matching value. RequiredClaims map[string]string // The status of the OIDC identity provider. @@ -946,8 +892,8 @@ type OidcIdentityProviderConfig struct { // The JSON Web token (JWT) claim that is used as the username. UsernameClaim *string - // The prefix that is prepended to username claims to prevent clashes with existing - // names. The prefix can't contain system: + // The prefix that is prepended to username claims to prevent clashes with + // existing names. The prefix can't contain system: UsernamePrefix *string noSmithyDocumentSerde @@ -956,8 +902,7 @@ type OidcIdentityProviderConfig struct { // An object representing an OpenID Connect (OIDC) configuration. Before // associating an OIDC identity provider to your cluster, review the considerations // in Authenticating users for your cluster from an OpenID Connect identity -// provider -// (https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) +// provider (https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) // in the Amazon EKS User Guide. type OidcIdentityProviderConfigRequest struct { @@ -977,7 +922,7 @@ type OidcIdentityProviderConfigRequest struct { // should correspond to the iss claim in the provider's OIDC ID tokens. Per the // OIDC standard, path components are allowed but query parameters are not. // Typically the URL consists of only a hostname, like https://server.example.org - // or https://example.com. This URL should point to the level below + // or https://example.com . This URL should point to the level below // .well-known/openid-configuration and must be publicly accessible over the // internet. // @@ -989,27 +934,27 @@ type OidcIdentityProviderConfigRequest struct { // The prefix that is prepended to group claims to prevent clashes with existing // names (such as system: groups). For example, the value oidc: will create group - // names like oidc:engineering and oidc:infra. + // names like oidc:engineering and oidc:infra . GroupsPrefix *string - // The key value pairs that describe required claims in the identity token. If set, - // each claim is verified to be present in the token with a matching value. For the - // maximum number of claims that you can require, see Amazon EKS service quotas - // (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the - // Amazon EKS User Guide. + // The key value pairs that describe required claims in the identity token. If + // set, each claim is verified to be present in the token with a matching value. + // For the maximum number of claims that you can require, see Amazon EKS service + // quotas (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in + // the Amazon EKS User Guide. RequiredClaims map[string]string - // The JSON Web Token (JWT) claim to use as the username. The default is sub, which - // is expected to be a unique identifier of the end user. You can choose other - // claims, such as email or name, depending on the OpenID identity provider. Claims - // other than email are prefixed with the issuer URL to prevent naming clashes with - // other plug-ins. + // The JSON Web Token (JWT) claim to use as the username. The default is sub , + // which is expected to be a unique identifier of the end user. You can choose + // other claims, such as email or name , depending on the OpenID identity provider. + // Claims other than email are prefixed with the issuer URL to prevent naming + // clashes with other plug-ins. UsernameClaim *string - // The prefix that is prepended to username claims to prevent clashes with existing - // names. If you do not provide this field, and username is a value other than - // email, the prefix defaults to issuerurl#. You can use the value - to disable all - // prefixing. + // The prefix that is prepended to username claims to prevent clashes with + // existing names. If you do not provide this field, and username is a value other + // than email , the prefix defaults to issuerurl# . You can use the value - to + // disable all prefixing. UsernamePrefix *string noSmithyDocumentSerde @@ -1017,16 +962,14 @@ type OidcIdentityProviderConfigRequest struct { // The configuration of your local Amazon EKS cluster on an Amazon Web Services // Outpost. Before creating a cluster on an Outpost, review Creating a local -// cluster on an Outpost -// (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-create.html) +// cluster on an Outpost (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-create.html) // in the Amazon EKS User Guide. This API isn't available for Amazon EKS clusters // on the Amazon Web Services cloud. type OutpostConfigRequest struct { // The Amazon EC2 instance type that you want to use for your local Amazon EKS // cluster on Outposts. Choose an instance type based on the number of nodes that - // your cluster will have. For more information, see Capacity considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) + // your cluster will have. For more information, see Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) // in the Amazon EKS User Guide. The instance type that you specify is used for all // Kubernetes control plane instances. The instance type can't be changed after // cluster creation. The control plane is not automatically scaled by Amazon EKS. @@ -1034,16 +977,15 @@ type OutpostConfigRequest struct { // This member is required. ControlPlaneInstanceType *string - // The ARN of the Outpost that you want to use for your local Amazon EKS cluster on - // Outposts. Only a single Outpost ARN is supported. + // The ARN of the Outpost that you want to use for your local Amazon EKS cluster + // on Outposts. Only a single Outpost ARN is supported. // // This member is required. OutpostArns []string // An object representing the placement configuration for all the control plane // instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. - // For more information, see Capacity considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) + // For more information, see Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) // in the Amazon EKS User Guide. ControlPlanePlacement *ControlPlanePlacementRequest @@ -1069,8 +1011,7 @@ type OutpostConfigResponse struct { // An object representing the placement configuration for all the control plane // instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. - // For more information, see Capacity considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) + // For more information, see Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) // in the Amazon EKS User Guide. ControlPlanePlacement *ControlPlanePlacementResponse @@ -1083,8 +1024,7 @@ type Provider struct { // Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be // symmetric, created in the same region as the cluster, and if the KMS key was // created in a different account, the user must have access to the KMS key. For - // more information, see Allowing Users in Other Accounts to Use a KMS key - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) + // more information, see Allowing Users in Other Accounts to Use a KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) // in the Key Management Service Developer Guide. KeyArn *string @@ -1097,30 +1037,27 @@ type RemoteAccessConfig struct { // The Amazon EC2 SSH key name that provides access for SSH communication with the // nodes in the managed node group. For more information, see Amazon EC2 key pairs - // and Linux instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the - // Amazon Elastic Compute Cloud User Guide for Linux Instances. For Windows, an - // Amazon EC2 SSH key is used to obtain the RDP password. For more information, see - // Amazon EC2 key pairs and Windows instances - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in - // the Amazon Elastic Compute Cloud User Guide for Windows Instances. + // and Linux instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) + // in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For Windows, + // an Amazon EC2 SSH key is used to obtain the RDP password. For more information, + // see Amazon EC2 key pairs and Windows instances (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) + // in the Amazon Elastic Compute Cloud User Guide for Windows Instances. Ec2SshKey *string // The security group IDs that are allowed SSH access (port 22) to the nodes. For // Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't // specify a source security group when you create a managed node group, then the - // port on the nodes is opened to the internet (0.0.0.0/0). For more information, - // see Security Groups for Your VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in - // the Amazon Virtual Private Cloud User Guide. + // port on the nodes is opened to the internet ( 0.0.0.0/0 ). For more information, + // see Security Groups for Your VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) + // in the Amazon Virtual Private Cloud User Guide. SourceSecurityGroups []string noSmithyDocumentSerde } // A property that allows a node to repel a set of pods. For more information, see -// Node taints on managed node groups -// (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). +// Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) +// . type Taint struct { // The effect of the taint. @@ -1184,8 +1121,8 @@ type UpdateParam struct { } // An object representing the details of an update to a taints payload. For more -// information, see Node taints on managed node groups -// (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). +// information, see Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) +// . type UpdateTaintsPayload struct { // Kubernetes taints to be added or updated. @@ -1203,42 +1140,38 @@ type VpcConfigRequest struct { // Set this value to true to enable private access for your cluster's Kubernetes // API server endpoint. If you enable private access, Kubernetes API requests from // within your cluster's VPC use the private VPC endpoint. The default value for - // this parameter is false, which disables private access for your Kubernetes API + // this parameter is false , which disables private access for your Kubernetes API // server. If you disable private access and you have nodes or Fargate pods in the // cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks // for communication with the nodes or Fargate pods. For more information, see - // Amazon EKS cluster endpoint access control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . + // Amazon EKS cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) + // in the Amazon EKS User Guide . EndpointPrivateAccess *bool // Set this value to false to disable public access to your cluster's Kubernetes // API server endpoint. If you disable public access, your cluster's Kubernetes API // server can only receive requests from within the cluster VPC. The default value - // for this parameter is true, which enables public access for your Kubernetes API - // server. For more information, see Amazon EKS cluster endpoint access control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . + // for this parameter is true , which enables public access for your Kubernetes API + // server. For more information, see Amazon EKS cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) + // in the Amazon EKS User Guide . EndpointPublicAccess *bool // The CIDR blocks that are allowed access to your cluster's public Kubernetes API // server endpoint. Communication to the endpoint from addresses outside of the - // CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If + // CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If // you've disabled private endpoint access and you have nodes or Fargate pods in // the cluster, then ensure that you specify the necessary CIDR blocks. For more - // information, see Amazon EKS cluster endpoint access control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . + // information, see Amazon EKS cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) + // in the Amazon EKS User Guide . PublicAccessCidrs []string // Specify one or more security groups for the cross-account elastic network // interfaces that Amazon EKS creates to use that allow communication between your // nodes and the Kubernetes control plane. If you don't specify any security // groups, then familiarize yourself with the difference between Amazon EKS - // defaults for clusters deployed with Kubernetes. For more information, see Amazon - // EKS security group considerations - // (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the - // Amazon EKS User Guide . + // defaults for clusters deployed with Kubernetes. For more information, see + // Amazon EKS security group considerations (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) + // in the Amazon EKS User Guide . SecurityGroupIds []string // Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account @@ -1263,9 +1196,8 @@ type VpcConfigResponse struct { // endpoint instead of traversing the internet. If this value is disabled and you // have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs // includes the necessary CIDR blocks for communication with the nodes or Fargate - // pods. For more information, see Amazon EKS cluster endpoint access control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . + // pods. For more information, see Amazon EKS cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) + // in the Amazon EKS User Guide . EndpointPrivateAccess bool // This parameter indicates whether the Amazon EKS public API server endpoint is @@ -1276,17 +1208,16 @@ type VpcConfigResponse struct { // The CIDR blocks that are allowed access to your cluster's public Kubernetes API // server endpoint. Communication to the endpoint from addresses outside of the - // listed CIDR blocks is denied. The default value is 0.0.0.0/0. If you've disabled - // private endpoint access and you have nodes or Fargate pods in the cluster, then - // ensure that the necessary CIDR blocks are listed. For more information, see - // Amazon EKS cluster endpoint access control - // (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the - // Amazon EKS User Guide . + // listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've + // disabled private endpoint access and you have nodes or Fargate pods in the + // cluster, then ensure that the necessary CIDR blocks are listed. For more + // information, see Amazon EKS cluster endpoint access control (https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) + // in the Amazon EKS User Guide . PublicAccessCidrs []string - // The security groups associated with the cross-account elastic network interfaces - // that are used to allow communication between your nodes and the Kubernetes - // control plane. + // The security groups associated with the cross-account elastic network + // interfaces that are used to allow communication between your nodes and the + // Kubernetes control plane. SecurityGroupIds []string // The subnets associated with your cluster. diff --git a/service/elasticache/api_client.go b/service/elasticache/api_client.go index fce4f0ce90c..a3e9f703292 100644 --- a/service/elasticache/api_client.go +++ b/service/elasticache/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticache/api_op_AddTagsToResource.go b/service/elasticache/api_op_AddTagsToResource.go index d96bd3429e1..9f64ef7ea28 100644 --- a/service/elasticache/api_op_AddTagsToResource.go +++ b/service/elasticache/api_op_AddTagsToResource.go @@ -15,16 +15,14 @@ import ( // use tags to categorize and track all your ElastiCache resources, with the // exception of global replication group. When you add or remove tags on // replication groups, those actions will be replicated to all nodes in the -// replication group. For more information, see Resource-level permissions -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html). -// For example, you can use cost-allocation tags to your ElastiCache resources, +// replication group. For more information, see Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html) +// . For example, you can use cost-allocation tags to your ElastiCache resources, // Amazon generates a cost allocation report as a comma-separated value (CSV) file // with your usage and costs aggregated by your tags. You can apply tags that // represent business categories (such as cost centers, application names, or // owners) to organize your costs across multiple services. For more information, -// see Using Cost Allocation Tags in Amazon ElastiCache -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html) in -// the ElastiCache User Guide. +// see Using Cost Allocation Tags in Amazon ElastiCache (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html) +// in the ElastiCache User Guide. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -44,11 +42,11 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { // The Amazon Resource Name (ARN) of the resource to which the tags are to be - // added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or - // arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache + // added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster + // or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot . ElastiCache // resources are cluster and snapshot. For more information about ARNs, see Amazon - // Resource Names (ARNs) and Amazon Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Resource Names (ARNs) and Amazon Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. ResourceName *string @@ -62,7 +60,7 @@ type AddTagsToResourceInput struct { noSmithyDocumentSerde } -// Represents the output from the AddTagsToResource, ListTagsForResource, and +// Represents the output from the AddTagsToResource , ListTagsForResource , and // RemoveTagsFromResource operations. type AddTagsToResourceOutput struct { diff --git a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go index 9551ed0fd8c..3828b8d56b5 100644 --- a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go +++ b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows network ingress to a cache security group. Applications using ElastiCache -// must be running on Amazon EC2, and Amazon EC2 security groups are used as the -// authorization mechanism. You cannot authorize ingress from an Amazon EC2 -// security group in one region to an ElastiCache cluster in another region. +// Allows network ingress to a cache security group. Applications using +// ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are +// used as the authorization mechanism. You cannot authorize ingress from an Amazon +// EC2 security group in one region to an ElastiCache cluster in another region. func (c *Client) AuthorizeCacheSecurityGroupIngress(ctx context.Context, params *AuthorizeCacheSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeCacheSecurityGroupIngressOutput, error) { if params == nil { params = &AuthorizeCacheSecurityGroupIngressInput{} @@ -38,14 +38,14 @@ type AuthorizeCacheSecurityGroupIngressInput struct { // This member is required. CacheSecurityGroupName *string - // The Amazon EC2 security group to be authorized for ingress to the cache security - // group. + // The Amazon EC2 security group to be authorized for ingress to the cache + // security group. // // This member is required. EC2SecurityGroupName *string - // The Amazon account number of the Amazon EC2 security group owner. Note that this - // is not the same thing as an Amazon access key ID - you must provide a valid + // The Amazon account number of the Amazon EC2 security group owner. Note that + // this is not the same thing as an Amazon access key ID - you must provide a valid // Amazon account number for this parameter. // // This member is required. @@ -57,14 +57,9 @@ type AuthorizeCacheSecurityGroupIngressInput struct { type AuthorizeCacheSecurityGroupIngressOutput struct { // Represents the output of one of the following operations: - // - // * - // AuthorizeCacheSecurityGroupIngress - // - // * CreateCacheSecurityGroup - // - // * - // RevokeCacheSecurityGroupIngress + // - AuthorizeCacheSecurityGroupIngress + // - CreateCacheSecurityGroup + // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_BatchApplyUpdateAction.go b/service/elasticache/api_op_BatchApplyUpdateAction.go index 972a6dd2214..f4858e905e4 100644 --- a/service/elasticache/api_op_BatchApplyUpdateAction.go +++ b/service/elasticache/api_op_BatchApplyUpdateAction.go @@ -12,8 +12,8 @@ import ( ) // Apply the service update. For more information on service updates and applying -// them, see Applying Service Updates -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html). +// them, see Applying Service Updates (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/applying-updates.html) +// . func (c *Client) BatchApplyUpdateAction(ctx context.Context, params *BatchApplyUpdateActionInput, optFns ...func(*Options)) (*BatchApplyUpdateActionOutput, error) { if params == nil { params = &BatchApplyUpdateActionInput{} diff --git a/service/elasticache/api_op_BatchStopUpdateAction.go b/service/elasticache/api_op_BatchStopUpdateAction.go index 588200d5211..ce2fc849485 100644 --- a/service/elasticache/api_op_BatchStopUpdateAction.go +++ b/service/elasticache/api_op_BatchStopUpdateAction.go @@ -12,8 +12,8 @@ import ( ) // Stop the service update. For more information on service updates and stopping -// them, see Stopping Service Updates -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html). +// them, see Stopping Service Updates (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/stopping-self-service-updates.html) +// . func (c *Client) BatchStopUpdateAction(ctx context.Context, params *BatchStopUpdateActionInput, optFns ...func(*Options)) (*BatchStopUpdateActionOutput, error) { if params == nil { params = &BatchStopUpdateActionInput{} diff --git a/service/elasticache/api_op_CopySnapshot.go b/service/elasticache/api_op_CopySnapshot.go index aded4e1e455..75ed8c10a0b 100644 --- a/service/elasticache/api_op_CopySnapshot.go +++ b/service/elasticache/api_op_CopySnapshot.go @@ -16,62 +16,40 @@ import ( // create their own Amazon S3 buckets and copy snapshots to it. To control access // to your snapshots, use an IAM policy to control who has the ability to use the // CopySnapshot operation. For more information about using IAM to control the use -// of ElastiCache operations, see Exporting Snapshots -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) -// and Authentication & Access Control -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html). You -// could receive the following error messages. Error Messages -// -// * Error Message: The -// S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in -// the same region as your snapshot. For more information, see Step 1: Create an -// Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) -// in the ElastiCache User Guide. -// -// * Error Message: The S3 bucket %s does not -// exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. -// For more information, see Step 1: Create an Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) -// in the ElastiCache User Guide. -// -// * Error Message: The S3 bucket %s is not owned -// by the authenticated user. Solution: Create an Amazon S3 bucket in the same -// region as your snapshot. For more information, see Step 1: Create an Amazon S3 -// Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) -// in the ElastiCache User Guide. -// -// * Error Message: The authenticated user does not -// have sufficient permissions to perform the desired activity. Solution: Contact -// your system administrator to get the needed permissions. -// -// * Error Message: The -// S3 bucket %s already contains an object with key %s. Solution: Give the -// TargetSnapshotName a new and unique value. If exporting a snapshot, you could -// alternatively create a new Amazon S3 bucket and use this same value for -// TargetSnapshotName. -// -// * Error Message: ElastiCache has not been granted READ -// permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the -// bucket. For more information, see Step 2: Grant ElastiCache Access to Your -// Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) -// in the ElastiCache User Guide. -// -// * Error Message: ElastiCache has not been -// granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete -// permissions on the bucket. For more information, see Step 2: Grant ElastiCache -// Access to Your Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) -// in the ElastiCache User Guide. -// -// * Error Message: ElastiCache has not been -// granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions -// on the bucket. For more information, see Step 2: Grant ElastiCache Access to -// Your Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) -// in the ElastiCache User Guide. +// of ElastiCache operations, see Exporting Snapshots (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) +// and Authentication & Access Control (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html) +// . You could receive the following error messages. Error Messages +// - Error Message: The S3 bucket %s is outside of the region. Solution: Create +// an Amazon S3 bucket in the same region as your snapshot. For more information, +// see Step 1: Create an Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) +// in the ElastiCache User Guide. +// - Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon +// S3 bucket in the same region as your snapshot. For more information, see Step +// 1: Create an Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) +// in the ElastiCache User Guide. +// - Error Message: The S3 bucket %s is not owned by the authenticated user. +// Solution: Create an Amazon S3 bucket in the same region as your snapshot. For +// more information, see Step 1: Create an Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket) +// in the ElastiCache User Guide. +// - Error Message: The authenticated user does not have sufficient permissions +// to perform the desired activity. Solution: Contact your system administrator to +// get the needed permissions. +// - Error Message: The S3 bucket %s already contains an object with key %s. +// Solution: Give the TargetSnapshotName a new and unique value. If exporting a +// snapshot, you could alternatively create a new Amazon S3 bucket and use this +// same value for TargetSnapshotName . +// - Error Message: ElastiCache has not been granted READ permissions %s on the +// S3 Bucket. Solution: Add List and Read permissions on the bucket. For more +// information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) +// in the ElastiCache User Guide. +// - Error Message: ElastiCache has not been granted WRITE permissions %s on the +// S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more +// information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) +// in the ElastiCache User Guide. +// - Error Message: ElastiCache has not been granted READ_ACP permissions %s on +// the S3 Bucket. Solution: Add View Permissions on the bucket. For more +// information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) +// in the ElastiCache User Guide. func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error) { if params == nil { params = &CopySnapshotInput{} @@ -113,11 +91,9 @@ type CopySnapshotInput struct { // only when exporting a snapshot for external access. When using this parameter to // export a snapshot, be sure Amazon ElastiCache has the needed permissions to this // S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your - // Amazon S3 Bucket - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) + // Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access) // in the Amazon ElastiCache User Guide. For more information, see Exporting a - // Snapshot - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) + // Snapshot (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) // in the Amazon ElastiCache User Guide. TargetBucket *string diff --git a/service/elasticache/api_op_CreateCacheCluster.go b/service/elasticache/api_op_CreateCacheCluster.go index ede69ef286a..632dea13e90 100644 --- a/service/elasticache/api_op_CreateCacheCluster.go +++ b/service/elasticache/api_op_CreateCacheCluster.go @@ -34,14 +34,9 @@ type CreateCacheClusterInput struct { // The node group (shard) identifier. This parameter is stored as a lowercase // string. Constraints: - // - // * A name must contain from 1 to 50 alphanumeric characters - // or hyphens. - // - // * The first character must be a letter. - // - // * A name cannot end with a - // hyphen or contain two consecutive hyphens. + // - A name must contain from 1 to 50 alphanumeric characters or hyphens. + // - The first character must be a letter. + // - A name cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. CacheClusterId *string @@ -55,23 +50,16 @@ type CreateCacheClusterInput struct { // Reserved parameter. The password used to access a password protected server. // Password constraints: - // - // * Must be only printable ASCII characters. - // - // * Must be at - // least 16 characters and no more than 128 characters in length. - // - // * The only - // permitted printable special characters are !, &, #, $, ^, <, >, and -. Other - // printable special characters cannot be used in the AUTH token. - // - // For more - // information, see AUTH password (http://redis.io/commands/AUTH) at + // - Must be only printable ASCII characters. + // - Must be at least 16 characters and no more than 128 characters in length. + // - The only permitted printable special characters are !, &, #, $, ^, <, >, + // and -. Other printable special characters cannot be used in the AUTH token. + // For more information, see AUTH password (http://redis.io/commands/AUTH) at // http://redis.io/commands/AUTH. AuthToken *string - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade *bool @@ -79,79 +67,57 @@ type CreateCacheClusterInput struct { // following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower // cost when compared to their equivalent previous generation counterparts. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , // - // * - // General purpose: - // - // * Current generation: M6g node types (available only for Redis - // engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): - // cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, - // cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region - // availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string - // The name of the parameter group to associate with this cluster. If this argument - // is omitted, the default parameter group for the specified engine is used. You - // cannot use any parameter group which has cluster-enabled='yes' when creating a - // cluster. + // The name of the parameter group to associate with this cluster. If this + // argument is omitted, the default parameter group for the specified engine is + // used. You cannot use any parameter group which has cluster-enabled='yes' when + // creating a cluster. CacheParameterGroupName *string // A list of security group names to associate with this cluster. Use this @@ -159,12 +125,12 @@ type CreateCacheClusterInput struct { // Private Cloud (Amazon VPC). CacheSecurityGroupNames []string - // The name of the subnet group to be used for the cluster. Use this parameter only - // when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). - // If you're going to launch your cluster in an Amazon VPC, you need to create a - // subnet group before you start creating a cluster. For more information, see - // Subnets and Subnet Groups - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). + // The name of the subnet group to be used for the cluster. Use this parameter + // only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon + // VPC). If you're going to launch your cluster in an Amazon VPC, you need to + // create a subnet group before you start creating a cluster. For more information, + // see Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html) + // . CacheSubnetGroupName *string // The name of the cache engine to be used for this cluster. Valid values for this @@ -174,25 +140,24 @@ type CreateCacheClusterInput struct { // The version number of the cache engine to be used for this cluster. To view the // supported cache engine versions, use the DescribeCacheEngineVersions operation. // Important: You can upgrade to a newer engine version (see Selecting a Cache - // Engine and Version - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), - // but you cannot downgrade to an earlier engine version. If you want to use an + // Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) + // ), but you cannot downgrade to an earlier engine version. If you want to use an // earlier engine version, you must delete the existing cluster or replication // group and create it anew with the earlier engine version. EngineVersion *string - // The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 + // The network type you choose when modifying a cluster, either ipv4 | ipv6 . IPv6 // is supported for workloads using Redis engine version 6.2 onward or Memcached - // engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. LogDeliveryConfigurations []types.LogDeliveryConfigurationRequest - // Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using + // Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . NetworkType types.NetworkType // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) @@ -204,8 +169,8 @@ type CreateCacheClusterInput struct { // Redis, this value must be 1. For clusters running Memcached, this value must be // between 1 and 40. If you need more than 40 nodes for your Memcached cluster, // please fill out the ElastiCache Limit Increase Request form at - // http://aws.amazon.com/contact-us/elasticache-node-limit-request/ - // (http://aws.amazon.com/contact-us/elasticache-node-limit-request/). + // http://aws.amazon.com/contact-us/elasticache-node-limit-request/ (http://aws.amazon.com/contact-us/elasticache-node-limit-request/) + // . NumCacheNodes *int32 // Specifies whether the nodes in the cluster are created in a single outpost or @@ -218,7 +183,7 @@ type CreateCacheClusterInput struct { // The EC2 Availability Zone in which the cluster is created. All nodes belonging // to this cluster are placed in the preferred Availability Zone. If you want to // create your nodes across multiple Availability Zones, use - // PreferredAvailabilityZones. Default: System chosen Availability Zone. + // PreferredAvailabilityZones . Default: System chosen Availability Zone. PreferredAvailabilityZone *string // A list of the Availability Zones in which cache nodes are created. The order of @@ -226,7 +191,7 @@ type CreateCacheClusterInput struct { // Memcached. If you are creating your cluster in an Amazon VPC (recommended) you // can only locate nodes in Availability Zones that are associated with the subnets // in the selected subnet group. The number of Availability Zones listed must equal - // the value of NumCacheNodes. If you want all the nodes in the same Availability + // the value of NumCacheNodes . If you want all the nodes in the same Availability // Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone // multiple times in the list. Default: System chosen Availability Zones. PreferredAvailabilityZones []string @@ -249,7 +214,7 @@ type CreateCacheClusterInput struct { // enabled and the Availability Zone is not specified, the cluster is created in // Availability Zones that provide the best spread of read replicas across // Availability Zones. This parameter is only valid if the Engine parameter is - // redis. + // redis . ReplicationGroupId *string // One or more VPC security groups associated with the cluster. Use this parameter @@ -261,27 +226,27 @@ type CreateCacheClusterInput struct { // uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot // file is used to populate the node group (shard). The Amazon S3 object name in // the ARN cannot contain any commas. This parameter is only valid if the Engine - // parameter is redis. Example of an Amazon S3 ARN: + // parameter is redis . Example of an Amazon S3 ARN: // arn:aws:s3:::my_bucket/snapshot1.rdb SnapshotArns []string // The name of a Redis snapshot from which to restore data into the new node group // (shard). The snapshot status changes to restoring while the new node group // (shard) is being created. This parameter is only valid if the Engine parameter - // is redis. + // is redis . SnapshotName *string // The number of days for which ElastiCache retains automatic snapshots before // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot // taken today is retained for 5 days before being deleted. This parameter is only - // valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are + // valid if the Engine parameter is redis . Default: 0 (i.e., automatic backups are // disabled for this cache cluster). SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which ElastiCache begins taking a daily // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify // this parameter, ElastiCache automatically chooses an appropriate time range. - // This parameter is only valid if the Engine parameter is redis. + // This parameter is only valid if the Engine parameter is redis . SnapshotWindow *string // A list of tags to be added to this resource. diff --git a/service/elasticache/api_op_CreateCacheParameterGroup.go b/service/elasticache/api_op_CreateCacheParameterGroup.go index a238f764e8b..0bebc712e3c 100644 --- a/service/elasticache/api_op_CreateCacheParameterGroup.go +++ b/service/elasticache/api_op_CreateCacheParameterGroup.go @@ -18,14 +18,10 @@ import ( // of the default parameter group for the CacheParameterGroupFamily. To customize // the newly created CacheParameterGroup you can change the values of specific // parameters. For more information, see: -// -// * ModifyCacheParameterGroup -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) -// in the ElastiCache API Reference. -// -// * Parameters and Parameter Groups -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html) -// in the ElastiCache User Guide. +// - ModifyCacheParameterGroup (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) +// in the ElastiCache API Reference. +// - Parameters and Parameter Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html) +// in the ElastiCache User Guide. func (c *Client) CreateCacheParameterGroup(ctx context.Context, params *CreateCacheParameterGroupInput, optFns ...func(*Options)) (*CreateCacheParameterGroupOutput, error) { if params == nil { params = &CreateCacheParameterGroupInput{} diff --git a/service/elasticache/api_op_CreateCacheSecurityGroup.go b/service/elasticache/api_op_CreateCacheSecurityGroup.go index 9810d6ef52e..ea48fc2d87d 100644 --- a/service/elasticache/api_op_CreateCacheSecurityGroup.go +++ b/service/elasticache/api_op_CreateCacheSecurityGroup.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cache security group. Use a cache security group to control access -// to one or more clusters. Cache security groups are only used when you are +// Creates a new cache security group. Use a cache security group to control +// access to one or more clusters. Cache security groups are only used when you are // creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If // you are creating a cluster inside of a VPC, use a cache subnet group instead. -// For more information, see CreateCacheSubnetGroup -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html). +// For more information, see CreateCacheSubnetGroup (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html) +// . func (c *Client) CreateCacheSecurityGroup(ctx context.Context, params *CreateCacheSecurityGroupInput, optFns ...func(*Options)) (*CreateCacheSecurityGroupOutput, error) { if params == nil { params = &CreateCacheSecurityGroupInput{} @@ -35,9 +35,9 @@ func (c *Client) CreateCacheSecurityGroup(ctx context.Context, params *CreateCac // Represents the input of a CreateCacheSecurityGroup operation. type CreateCacheSecurityGroupInput struct { - // A name for the cache security group. This value is stored as a lowercase string. - // Constraints: Must contain no more than 255 alphanumeric characters. Cannot be - // the word "Default". Example: mysecuritygroup + // A name for the cache security group. This value is stored as a lowercase + // string. Constraints: Must contain no more than 255 alphanumeric characters. + // Cannot be the word "Default". Example: mysecuritygroup // // This member is required. CacheSecurityGroupName *string @@ -57,14 +57,9 @@ type CreateCacheSecurityGroupInput struct { type CreateCacheSecurityGroupOutput struct { // Represents the output of one of the following operations: - // - // * - // AuthorizeCacheSecurityGroupIngress - // - // * CreateCacheSecurityGroup - // - // * - // RevokeCacheSecurityGroupIngress + // - AuthorizeCacheSecurityGroupIngress + // - CreateCacheSecurityGroup + // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_CreateCacheSubnetGroup.go b/service/elasticache/api_op_CreateCacheSubnetGroup.go index 909d962d268..e7fe90fbe47 100644 --- a/service/elasticache/api_op_CreateCacheSubnetGroup.go +++ b/service/elasticache/api_op_CreateCacheSubnetGroup.go @@ -58,11 +58,8 @@ type CreateCacheSubnetGroupInput struct { type CreateCacheSubnetGroupOutput struct { // Represents the output of one of the following operations: - // - // * - // CreateCacheSubnetGroup - // - // * ModifyCacheSubnetGroup + // - CreateCacheSubnetGroup + // - ModifyCacheSubnetGroup CacheSubnetGroup *types.CacheSubnetGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_CreateGlobalReplicationGroup.go b/service/elasticache/api_op_CreateGlobalReplicationGroup.go index 050c6945757..886bfc14a99 100644 --- a/service/elasticache/api_op_CreateGlobalReplicationGroup.go +++ b/service/elasticache/api_op_CreateGlobalReplicationGroup.go @@ -15,15 +15,11 @@ import ( // cross-region replication. Using Global Datastore for Redis, you can create // cross-region read replica clusters for ElastiCache for Redis to enable // low-latency reads and disaster recovery across regions. For more information, -// see Replication Across Regions Using Global Datastore -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html). -// -// * -// The GlobalReplicationGroupIdSuffix is the name of the Global datastore. -// -// * The -// PrimaryReplicationGroupId represents the name of the primary cluster that -// accepts writes and will replicate updates to the secondary cluster. +// see Replication Across Regions Using Global Datastore (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html) +// . +// - The GlobalReplicationGroupIdSuffix is the name of the Global datastore. +// - The PrimaryReplicationGroupId represents the name of the primary cluster +// that accepts writes and will replicate updates to the secondary cluster. func (c *Client) CreateGlobalReplicationGroup(ctx context.Context, params *CreateGlobalReplicationGroupInput, optFns ...func(*Options)) (*CreateGlobalReplicationGroupOutput, error) { if params == nil { params = &CreateGlobalReplicationGroupInput{} @@ -47,9 +43,9 @@ type CreateGlobalReplicationGroupInput struct { // region will begin with "dsdfu" along with the suffix name you provide. The // suffix, combined with the auto-generated prefix, guarantees uniqueness of the // Global datastore name across multiple regions. For a full list of Amazon Regions - // and their respective Global datastore iD prefixes, see Using the Amazon CLI with - // Global datastores - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html). + // and their respective Global datastore iD prefixes, see Using the Amazon CLI + // with Global datastores (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html) + // . // // This member is required. GlobalReplicationGroupIdSuffix *string @@ -72,9 +68,8 @@ type CreateGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_CreateReplicationGroup.go b/service/elasticache/api_op_CreateReplicationGroup.go index b9c5700e38a..8641d0c5a81 100644 --- a/service/elasticache/api_op_CreateReplicationGroup.go +++ b/service/elasticache/api_op_CreateReplicationGroup.go @@ -28,19 +28,16 @@ import ( // replicas). Make sure there are enough available IP addresses to accommodate the // increase. Common pitfalls include the subnets in the subnet group have too small // a CIDR range or the subnets are shared and heavily used by other clusters. For -// more information, see Creating a Subnet Group -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html). -// For versions below 5.0.6, the limit is 250 per cluster. To request a limit -// increase, see Amazon Service Limits -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and -// choose the limit type Nodes per cluster per instance type. When a Redis (cluster -// mode disabled) replication group has been successfully created, you can add one -// or more read replicas to it, up to a total of 5 read replicas. If you need to -// increase or decrease the number of node groups (console: shards), you can avail -// yourself of ElastiCache for Redis' scaling. For more information, see Scaling -// ElastiCache for Redis Clusters -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html) in -// the ElastiCache User Guide. This operation is valid for Redis only. +// more information, see Creating a Subnet Group (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html) +// . For versions below 5.0.6, the limit is 250 per cluster. To request a limit +// increase, see Amazon Service Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// and choose the limit type Nodes per cluster per instance type. When a Redis +// (cluster mode disabled) replication group has been successfully created, you can +// add one or more read replicas to it, up to a total of 5 read replicas. If you +// need to increase or decrease the number of node groups (console: shards), you +// can avail yourself of ElastiCache for Redis' scaling. For more information, see +// Scaling ElastiCache for Redis Clusters (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html) +// in the ElastiCache User Guide. This operation is valid for Redis only. func (c *Client) CreateReplicationGroup(ctx context.Context, params *CreateReplicationGroupInput, optFns ...func(*Options)) (*CreateReplicationGroupOutput, error) { if params == nil { params = &CreateReplicationGroupInput{} @@ -66,47 +63,36 @@ type CreateReplicationGroupInput struct { // The replication group identifier. This parameter is stored as a lowercase // string. Constraints: - // - // * A name must contain from 1 to 40 alphanumeric characters - // or hyphens. - // - // * The first character must be a letter. - // - // * A name cannot end with a - // hyphen or contain two consecutive hyphens. + // - A name must contain from 1 to 40 alphanumeric characters or hyphens. + // - The first character must be a letter. + // - A name cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. ReplicationGroupId *string - // A flag that enables encryption at rest when set to true. You cannot modify the + // A flag that enables encryption at rest when set to true . You cannot modify the // value of AtRestEncryptionEnabled after the replication group is created. To // enable encryption at rest on a replication group you must set - // AtRestEncryptionEnabled to true when you create the replication group. Required: - // Only available when creating a replication group in an Amazon VPC using redis - // version 3.2.6, 4.x or later. Default: false + // AtRestEncryptionEnabled to true when you create the replication group. + // Required: Only available when creating a replication group in an Amazon VPC + // using redis version 3.2.6 , 4.x or later. Default: false AtRestEncryptionEnabled *bool // Reserved parameter. The password used to access a password protected server. // AuthToken can be specified only on replication groups where - // TransitEncryptionEnabled is true. For HIPAA compliance, you must specify - // TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. Password - // constraints: - // - // * Must be only printable ASCII characters. - // - // * Must be at least 16 - // characters and no more than 128 characters in length. - // - // * The only permitted - // printable special characters are !, &, #, $, ^, <, >, and -. Other printable - // special characters cannot be used in the AUTH token. - // - // For more information, see - // AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH. + // TransitEncryptionEnabled is true . For HIPAA compliance, you must specify + // TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup . + // Password constraints: + // - Must be only printable ASCII characters. + // - Must be at least 16 characters and no more than 128 characters in length. + // - The only permitted printable special characters are !, &, #, $, ^, <, >, + // and -. Other printable special characters cannot be used in the AUTH token. + // For more information, see AUTH password (http://redis.io/commands/AUTH) at + // http://redis.io/commands/AUTH. AuthToken *string - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade *bool @@ -119,73 +105,51 @@ type CreateReplicationGroupInput struct { // following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower // cost when compared to their equivalent previous generation counterparts. - // - // * - // General purpose: - // - // * Current generation: M6g node types (available only for Redis - // engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): - // cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, - // cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region - // availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , + // + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // The name of the parameter group to associate with this replication group. If @@ -193,13 +157,10 @@ type CreateReplicationGroupInput struct { // engine is used. If you are running Redis version 3.2.4 or later, only one node // group (shard), and want to use a default parameter group, we recommend that you // specify the parameter group by name. - // - // * To create a Redis (cluster mode - // disabled) replication group, use CacheParameterGroupName=default.redis3.2. - // - // * To - // create a Redis (cluster mode enabled) replication group, use - // CacheParameterGroupName=default.redis3.2.cluster.on. + // - To create a Redis (cluster mode disabled) replication group, use + // CacheParameterGroupName=default.redis3.2 . + // - To create a Redis (cluster mode enabled) replication group, use + // CacheParameterGroupName=default.redis3.2.cluster.on . CacheParameterGroupName *string // A list of cache security group names to associate with this replication group. @@ -208,26 +169,25 @@ type CreateReplicationGroupInput struct { // The name of the cache subnet group to be used for the replication group. If // you're going to launch your cluster in an Amazon VPC, you need to create a // subnet group before you start creating a cluster. For more information, see - // Subnets and Subnet Groups - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html). + // Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html) + // . CacheSubnetGroupName *string // Enables data tiering. Data tiering is only supported for replication groups // using the r6gd node type. This parameter must be set to true when using r6gd - // nodes. For more information, see Data tiering - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html). + // nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html) + // . DataTieringEnabled *bool // The name of the cache engine to be used for the clusters in this replication - // group. The value must be set to Redis. + // group. The value must be set to Redis . Engine *string // The version number of the cache engine to be used for the clusters in this // replication group. To view the supported cache engine versions, use the // DescribeCacheEngineVersions operation. Important: You can upgrade to a newer - // engine version (see Selecting a Cache Engine and Version - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) - // in the ElastiCache User Guide, but you cannot downgrade to an earlier engine + // engine version (see Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) + // ) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine // version. If you want to use an earlier engine version, you must delete the // existing cluster or replication group and create it anew with the earlier engine // version. @@ -237,9 +197,9 @@ type CreateReplicationGroupInput struct { GlobalReplicationGroupId *string // The network type you choose when creating a replication group, either ipv4 | - // ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or - // Memcached engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // ipv6 . IPv6 is supported for workloads using Redis engine version 6.2 onward or + // Memcached engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery types.IpDiscovery // The ID of the KMS key used to encrypt the disk in the cluster. @@ -249,18 +209,18 @@ type CreateReplicationGroupInput struct { LogDeliveryConfigurations []types.LogDeliveryConfigurationRequest // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For - // more information, see Minimizing Downtime: Multi-AZ - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html). + // more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) + // . MultiAZEnabled *bool - // Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using + // Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . NetworkType types.NetworkType // A list of node group (shard) configuration options. Each node group (shard) - // configuration has the following members: PrimaryAvailabilityZone, - // ReplicaAvailabilityZones, ReplicaCount, and Slots. If you're creating a Redis + // configuration has the following members: PrimaryAvailabilityZone , + // ReplicaAvailabilityZones , ReplicaCount , and Slots . If you're creating a Redis // (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you // can use this parameter to individually configure each node group (shard), or you // can omit this parameter. However, it is required when seeding a Redis (cluster @@ -276,15 +236,15 @@ type CreateReplicationGroupInput struct { // The number of clusters this replication group initially has. This parameter is // not used if there is more than one node group (shard). You should use - // ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of + // ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true , the value of // this parameter must be at least 2. If AutomaticFailoverEnabled is false you can // omit this parameter (it will default to 1), or you can explicitly set it to a // value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 // primary plus 5 replicas). NumCacheClusters *int32 - // An optional parameter that specifies the number of node groups (shards) for this - // Redis (cluster mode enabled) replication group. For Redis (cluster mode + // An optional parameter that specifies the number of node groups (shards) for + // this Redis (cluster mode enabled) replication group. For Redis (cluster mode // disabled) either omit this parameter or set it to 1. Default: 1 NumNodeGroups *int32 @@ -299,8 +259,8 @@ type CreateReplicationGroupInput struct { // You should use NodeGroupConfiguration instead. If you are creating your // replication group in an Amazon VPC (recommended), you can only locate clusters // in Availability Zones associated with the subnets in the selected subnet group. - // The number of Availability Zones listed must equal the value of - // NumCacheClusters. Default: system chosen Availability Zones. + // The number of Availability Zones listed must equal the value of NumCacheClusters + // . Default: system chosen Availability Zones. PreferredCacheClusterAZs []string // Specifies the weekly time range during which maintenance on the cluster is @@ -310,28 +270,19 @@ type CreateReplicationGroupInput struct { // cluster is performed. It is specified as a range in the format // ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 // minute period. Valid values for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * - // fri - // - // * sat - // + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string // The identifier of the cluster that serves as the primary for this replication - // group. This cluster must already exist and have a status of available. This - // parameter is not required if NumCacheClusters, NumNodeGroups, or + // group. This cluster must already exist and have a status of available . This + // parameter is not required if NumCacheClusters , NumNodeGroups , or // ReplicasPerNodeGroup is specified. PrimaryClusterId *string @@ -370,30 +321,30 @@ type CreateReplicationGroupInput struct { SnapshotWindow *string // A list of tags to be added to this resource. Tags are comma-separated key,value - // pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown - // following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. - // Tags on replication groups will be replicated to all nodes. + // pairs (e.g. Key= myKey , Value= myKeyValue . You can include multiple tags as + // shown following: Key= myKey , Value= myKeyValue Key= mySecondKey , Value= + // mySecondKeyValue . Tags on replication groups will be replicated to all nodes. Tags []types.Tag - // A flag that enables in-transit encryption when set to true. This parameter is - // valid only if the Engine parameter is redis, the EngineVersion parameter is - // 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. If you - // enable in-transit encryption, you must also specify a value for - // CacheSubnetGroup. Required: Only available when creating a replication group in - // an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false For HIPAA - // compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and - // a CacheSubnetGroup. + // A flag that enables in-transit encryption when set to true . This parameter is + // valid only if the Engine parameter is redis , the EngineVersion parameter is + // 3.2.6 , 4.x or later, and the cluster is being created in an Amazon VPC. If you + // enable in-transit encryption, you must also specify a value for CacheSubnetGroup + // . Required: Only available when creating a replication group in an Amazon VPC + // using redis version 3.2.6 , 4.x or later. Default: false For HIPAA compliance, + // you must specify TransitEncryptionEnabled as true , an AuthToken , and a + // CacheSubnetGroup . TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, - // with no downtime. When setting TransitEncryptionEnabled to true, you can set + // with no downtime. When setting TransitEncryptionEnabled to true , you can set // your TransitEncryptionMode to preferred in the same request, to allow both // encrypted and unencrypted connections at the same time. Once you migrate all // your Redis clients to use encrypted connections you can modify the value to // required to allow encrypted connections only. Setting TransitEncryptionMode to // required is a two-step process that requires you to first set the // TransitEncryptionMode to preferred first, after that you can set - // TransitEncryptionMode to required. + // TransitEncryptionMode to required . TransitEncryptionMode types.TransitEncryptionMode // The user group to associate with the replication group. diff --git a/service/elasticache/api_op_CreateSnapshot.go b/service/elasticache/api_op_CreateSnapshot.go index f95fab3941a..fc4e4210173 100644 --- a/service/elasticache/api_op_CreateSnapshot.go +++ b/service/elasticache/api_op_CreateSnapshot.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a copy of an entire cluster or replication group at a specific moment in -// time. This operation is valid for Redis only. +// Creates a copy of an entire cluster or replication group at a specific moment +// in time. This operation is valid for Redis only. func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} diff --git a/service/elasticache/api_op_CreateUser.go b/service/elasticache/api_op_CreateUser.go index 14299be7989..7f14d7a7bf3 100644 --- a/service/elasticache/api_op_CreateUser.go +++ b/service/elasticache/api_op_CreateUser.go @@ -12,8 +12,8 @@ import ( ) // For Redis engine version 6.0 onwards: Creates a Redis user. For more -// information, see Using Role Based Access Control (RBAC) -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html). +// information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) +// . func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} diff --git a/service/elasticache/api_op_CreateUserGroup.go b/service/elasticache/api_op_CreateUserGroup.go index a9dde9a7608..04bf8079a09 100644 --- a/service/elasticache/api_op_CreateUserGroup.go +++ b/service/elasticache/api_op_CreateUserGroup.go @@ -12,8 +12,7 @@ import ( ) // For Redis engine version 6.0 onwards: Creates a Redis user group. For more -// information, see Using Role Based Access Control (RBAC) -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) +// information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) func (c *Client) CreateUserGroup(ctx context.Context, params *CreateUserGroupInput, optFns ...func(*Options)) (*CreateUserGroupOutput, error) { if params == nil { params = &CreateUserGroupInput{} diff --git a/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go b/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go index 769d149b1f9..c27e67b4568 100644 --- a/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go @@ -29,8 +29,8 @@ func (c *Client) DecreaseNodeGroupsInGlobalReplicationGroup(ctx context.Context, type DecreaseNodeGroupsInGlobalReplicationGroupInput struct { - // Indicates that the shard reconfiguration process begins immediately. At present, - // the only permitted value for this parameter is true. + // Indicates that the shard reconfiguration process begins immediately. At + // present, the only permitted value for this parameter is true. // // This member is required. ApplyImmediately bool @@ -69,9 +69,8 @@ type DecreaseNodeGroupsInGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_DecreaseReplicaCount.go b/service/elasticache/api_op_DecreaseReplicaCount.go index 9eeab7a9a52..d02ac9fccc1 100644 --- a/service/elasticache/api_op_DecreaseReplicaCount.go +++ b/service/elasticache/api_op_DecreaseReplicaCount.go @@ -32,7 +32,7 @@ func (c *Client) DecreaseReplicaCount(ctx context.Context, params *DecreaseRepli type DecreaseReplicaCountInput struct { - // If True, the number of replica nodes is decreased immediately. + // If True , the number of replica nodes is decreased immediately. // ApplyImmediately=False is not currently supported. // // This member is required. @@ -49,22 +49,16 @@ type DecreaseReplicaCountInput struct { // replication groups, this is the number of replica nodes in each of the // replication group's node groups. The minimum number of replicas in a shard or // replication group is: - // - // * Redis (cluster mode disabled) - // - // * If Multi-AZ is - // enabled: 1 - // - // * If Multi-AZ is not enabled: 0 - // - // * Redis (cluster mode enabled): 0 - // (though you will not be able to failover to a replica if your primary node - // fails) + // - Redis (cluster mode disabled) + // - If Multi-AZ is enabled: 1 + // - If Multi-AZ is not enabled: 0 + // - Redis (cluster mode enabled): 0 (though you will not be able to failover to + // a replica if your primary node fails) NewReplicaCount *int32 // A list of ConfigureShard objects that can be used to configure each shard in a // Redis (cluster mode enabled) replication group. The ConfigureShard has three - // members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. + // members: NewReplicaCount , NodeGroupId , and PreferredAvailabilityZones . ReplicaConfiguration []types.ConfigureShard // A list of the node ids to remove from the replication group or node group diff --git a/service/elasticache/api_op_DeleteCacheCluster.go b/service/elasticache/api_op_DeleteCacheCluster.go index e978b258b24..5cffa145bd4 100644 --- a/service/elasticache/api_op_DeleteCacheCluster.go +++ b/service/elasticache/api_op_DeleteCacheCluster.go @@ -16,25 +16,13 @@ import ( // a successful response from this operation, Amazon ElastiCache immediately begins // deleting the cluster; you cannot cancel or revert this operation. This operation // is not valid for: -// -// * Redis (cluster mode enabled) clusters -// -// * Redis (cluster -// mode disabled) clusters -// -// * A cluster that is the last read replica of a -// replication group -// -// * A cluster that is the primary node of a replication -// group -// -// * A node group (shard) that has Multi-AZ mode enabled -// -// * A cluster from a -// Redis (cluster mode enabled) replication group -// -// * A cluster that is not in the -// available state +// - Redis (cluster mode enabled) clusters +// - Redis (cluster mode disabled) clusters +// - A cluster that is the last read replica of a replication group +// - A cluster that is the primary node of a replication group +// - A node group (shard) that has Multi-AZ mode enabled +// - A cluster from a Redis (cluster mode enabled) replication group +// - A cluster that is not in the available state func (c *Client) DeleteCacheCluster(ctx context.Context, params *DeleteCacheClusterInput, optFns ...func(*Options)) (*DeleteCacheClusterOutput, error) { if params == nil { params = &DeleteCacheClusterInput{} @@ -53,15 +41,15 @@ func (c *Client) DeleteCacheCluster(ctx context.Context, params *DeleteCacheClus // Represents the input of a DeleteCacheCluster operation. type DeleteCacheClusterInput struct { - // The cluster identifier for the cluster to be deleted. This parameter is not case - // sensitive. + // The cluster identifier for the cluster to be deleted. This parameter is not + // case sensitive. // // This member is required. CacheClusterId *string - // The user-supplied name of a final cluster snapshot. This is the unique name that - // identifies the snapshot. ElastiCache creates the snapshot, and then deletes the - // cluster immediately afterward. + // The user-supplied name of a final cluster snapshot. This is the unique name + // that identifies the snapshot. ElastiCache creates the snapshot, and then deletes + // the cluster immediately afterward. FinalSnapshotIdentifier *string noSmithyDocumentSerde diff --git a/service/elasticache/api_op_DeleteCacheParameterGroup.go b/service/elasticache/api_op_DeleteCacheParameterGroup.go index 43835b7aa93..89841fde716 100644 --- a/service/elasticache/api_op_DeleteCacheParameterGroup.go +++ b/service/elasticache/api_op_DeleteCacheParameterGroup.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified cache parameter group. You cannot delete a cache parameter -// group if it is associated with any cache clusters. You cannot delete the default -// cache parameter groups in your account. +// Deletes the specified cache parameter group. You cannot delete a cache +// parameter group if it is associated with any cache clusters. You cannot delete +// the default cache parameter groups in your account. func (c *Client) DeleteCacheParameterGroup(ctx context.Context, params *DeleteCacheParameterGroupInput, optFns ...func(*Options)) (*DeleteCacheParameterGroupOutput, error) { if params == nil { params = &DeleteCacheParameterGroupInput{} diff --git a/service/elasticache/api_op_DeleteGlobalReplicationGroup.go b/service/elasticache/api_op_DeleteGlobalReplicationGroup.go index 33edc412e3d..bbfe1eb024c 100644 --- a/service/elasticache/api_op_DeleteGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DeleteGlobalReplicationGroup.go @@ -12,23 +12,19 @@ import ( ) // Deleting a Global datastore is a two-step process: +// - First, you must DisassociateGlobalReplicationGroup to remove the secondary +// clusters in the Global datastore. +// - Once the Global datastore contains only the primary cluster, you can use +// the DeleteGlobalReplicationGroup API to delete the Global datastore while +// retainining the primary cluster using RetainPrimaryReplicationGroup=true . // -// * First, you must -// DisassociateGlobalReplicationGroup to remove the secondary clusters in the -// Global datastore. -// -// * Once the Global datastore contains only the primary -// cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global -// datastore while retainining the primary cluster using -// RetainPrimaryReplicationGroup=true. -// -// Since the Global Datastore has only a -// primary cluster, you can delete the Global Datastore while retaining the primary -// by setting RetainPrimaryReplicationGroup=true. The primary cluster is never -// deleted when deleting a Global Datastore. It can only be deleted when it no -// longer is associated with any Global Datastore. When you receive a successful -// response from this operation, Amazon ElastiCache immediately begins deleting the -// selected resources; you cannot cancel or revert this operation. +// Since the Global Datastore has only a primary cluster, you can delete the +// Global Datastore while retaining the primary by setting +// RetainPrimaryReplicationGroup=true . The primary cluster is never deleted when +// deleting a Global Datastore. It can only be deleted when it no longer is +// associated with any Global Datastore. When you receive a successful response +// from this operation, Amazon ElastiCache immediately begins deleting the selected +// resources; you cannot cancel or revert this operation. func (c *Client) DeleteGlobalReplicationGroup(ctx context.Context, params *DeleteGlobalReplicationGroupInput, optFns ...func(*Options)) (*DeleteGlobalReplicationGroupOutput, error) { if params == nil { params = &DeleteGlobalReplicationGroupInput{} @@ -65,9 +61,8 @@ type DeleteGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_DeleteReplicationGroup.go b/service/elasticache/api_op_DeleteReplicationGroup.go index baf9fe1dd5c..8649a005687 100644 --- a/service/elasticache/api_op_DeleteReplicationGroup.go +++ b/service/elasticache/api_op_DeleteReplicationGroup.go @@ -15,7 +15,7 @@ import ( // entire replication group, including the primary/primaries and all of the read // replicas. If the replication group has only one primary, you can optionally // delete only the read replicas, while retaining the primary by setting -// RetainPrimaryCluster=true. When you receive a successful response from this +// RetainPrimaryCluster=true . When you receive a successful response from this // operation, Amazon ElastiCache immediately begins deleting the selected // resources; you cannot cancel or revert this operation. This operation is valid // for Redis only. @@ -49,7 +49,7 @@ type DeleteReplicationGroupInput struct { // is taken, the replication group is immediately deleted. FinalSnapshotIdentifier *string - // If set to true, all of the read replicas are deleted, but the primary node is + // If set to true , all of the read replicas are deleted, but the primary node is // retained. RetainPrimaryCluster *bool diff --git a/service/elasticache/api_op_DeleteUser.go b/service/elasticache/api_op_DeleteUser.go index 73820e0834b..95570ad0327 100644 --- a/service/elasticache/api_op_DeleteUser.go +++ b/service/elasticache/api_op_DeleteUser.go @@ -13,8 +13,8 @@ import ( // For Redis engine version 6.0 onwards: Deletes a user. The user will be removed // from all user groups and in turn removed from all replication groups. For more -// information, see Using Role Based Access Control (RBAC) -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html). +// information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) +// . func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/elasticache/api_op_DeleteUserGroup.go b/service/elasticache/api_op_DeleteUserGroup.go index e761f2b0996..cf17156c028 100644 --- a/service/elasticache/api_op_DeleteUserGroup.go +++ b/service/elasticache/api_op_DeleteUserGroup.go @@ -13,8 +13,8 @@ import ( // For Redis engine version 6.0 onwards: Deletes a user group. The user group must // first be disassociated from the replication group before it can be deleted. For -// more information, see Using Role Based Access Control (RBAC) -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html). +// more information, see Using Role Based Access Control (RBAC) (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) +// . func (c *Client) DeleteUserGroup(ctx context.Context, params *DeleteUserGroupInput, optFns ...func(*Options)) (*DeleteUserGroupOutput, error) { if params == nil { params = &DeleteUserGroupInput{} diff --git a/service/elasticache/api_op_DescribeCacheClusters.go b/service/elasticache/api_op_DescribeCacheClusters.go index 058e80300a8..25081269b14 100644 --- a/service/elasticache/api_op_DescribeCacheClusters.go +++ b/service/elasticache/api_op_DescribeCacheClusters.go @@ -55,10 +55,10 @@ type DescribeCacheClustersInput struct { // sensitive. CacheClusterId *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -263,9 +263,10 @@ type CacheClusterAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CacheClusterAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CacheClusterAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -535,9 +536,10 @@ type CacheClusterDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CacheClusterDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CacheClusterDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -577,9 +579,9 @@ func NewCacheClusterDeletedWaiter(client DescribeCacheClustersAPIClient, optFns } } -// Wait calls the waiter function for CacheClusterDeleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for CacheClusterDeleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *CacheClusterDeletedWaiter) Wait(ctx context.Context, params *DescribeCacheClustersInput, maxWaitDur time.Duration, optFns ...func(*CacheClusterDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/elasticache/api_op_DescribeCacheEngineVersions.go b/service/elasticache/api_op_DescribeCacheEngineVersions.go index 6eef790224b..95d8cb79809 100644 --- a/service/elasticache/api_op_DescribeCacheEngineVersions.go +++ b/service/elasticache/api_op_DescribeCacheEngineVersions.go @@ -31,20 +31,16 @@ func (c *Client) DescribeCacheEngineVersions(ctx context.Context, params *Descri // Represents the input of a DescribeCacheEngineVersions operation. type DescribeCacheEngineVersionsInput struct { - // The name of a specific cache parameter group family to return details for. Valid - // values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | - // redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 Constraints: - // - // * - // Must be 1 to 255 alphanumeric characters - // - // * First character must be a letter - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens + // The name of a specific cache parameter group family to return details for. + // Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | + // redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 + // Constraints: + // - Must be 1 to 255 alphanumeric characters + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens CacheParameterGroupFamily *string - // If true, specifies that only the default version of the specified engine or + // If true , specifies that only the default version of the specified engine or // engine and major version combination is to be returned. DefaultOnly bool @@ -54,10 +50,10 @@ type DescribeCacheEngineVersionsInput struct { // The cache engine version to return. Example: 1.4.14 EngineVersion *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeCacheParameterGroups.go b/service/elasticache/api_op_DescribeCacheParameterGroups.go index c82d5be9b46..907eb78783a 100644 --- a/service/elasticache/api_op_DescribeCacheParameterGroups.go +++ b/service/elasticache/api_op_DescribeCacheParameterGroups.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of cache parameter group descriptions. If a cache parameter group -// name is specified, the list contains only the descriptions for that group. +// Returns a list of cache parameter group descriptions. If a cache parameter +// group name is specified, the list contains only the descriptions for that group. func (c *Client) DescribeCacheParameterGroups(ctx context.Context, params *DescribeCacheParameterGroupsInput, optFns ...func(*Options)) (*DescribeCacheParameterGroupsOutput, error) { if params == nil { params = &DescribeCacheParameterGroupsInput{} @@ -35,10 +35,10 @@ type DescribeCacheParameterGroupsInput struct { // The name of a specific cache parameter group to return details for. CacheParameterGroupName *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeCacheParameters.go b/service/elasticache/api_op_DescribeCacheParameters.go index 7de7483a8c4..a23658a2e77 100644 --- a/service/elasticache/api_op_DescribeCacheParameters.go +++ b/service/elasticache/api_op_DescribeCacheParameters.go @@ -36,10 +36,10 @@ type DescribeCacheParametersInput struct { // This member is required. CacheParameterGroupName *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeCacheSecurityGroups.go b/service/elasticache/api_op_DescribeCacheSecurityGroups.go index bd87cb3c194..10421992d1e 100644 --- a/service/elasticache/api_op_DescribeCacheSecurityGroups.go +++ b/service/elasticache/api_op_DescribeCacheSecurityGroups.go @@ -36,10 +36,10 @@ type DescribeCacheSecurityGroupsInput struct { // The name of the cache security group to return details for. CacheSecurityGroupName *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeCacheSubnetGroups.go b/service/elasticache/api_op_DescribeCacheSubnetGroups.go index 4fa5d4b9677..70c5ab64f23 100644 --- a/service/elasticache/api_op_DescribeCacheSubnetGroups.go +++ b/service/elasticache/api_op_DescribeCacheSubnetGroups.go @@ -37,10 +37,10 @@ type DescribeCacheSubnetGroupsInput struct { // The name of the cache subnet group to return details for. CacheSubnetGroupName *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeEngineDefaultParameters.go b/service/elasticache/api_op_DescribeEngineDefaultParameters.go index 1dd504f0f75..c742206c4fa 100644 --- a/service/elasticache/api_op_DescribeEngineDefaultParameters.go +++ b/service/elasticache/api_op_DescribeEngineDefaultParameters.go @@ -39,10 +39,10 @@ type DescribeEngineDefaultParametersInput struct { // This member is required. CacheParameterGroupFamily *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/elasticache/api_op_DescribeEvents.go b/service/elasticache/api_op_DescribeEvents.go index 4aa4d1c7e68..253b4352438 100644 --- a/service/elasticache/api_op_DescribeEvents.go +++ b/service/elasticache/api_op_DescribeEvents.go @@ -39,14 +39,14 @@ type DescribeEventsInput struct { // The number of minutes worth of events to retrieve. Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. Example: 2017-03-30T07:03:49.555Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. Example: 2017-03-30T07:03:49.555Z EndTime *time.Time - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -63,8 +63,8 @@ type DescribeEventsInput struct { // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. Example: 2017-03-30T07:03:49.555Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. Example: 2017-03-30T07:03:49.555Z StartTime *time.Time noSmithyDocumentSerde diff --git a/service/elasticache/api_op_DescribeGlobalReplicationGroups.go b/service/elasticache/api_op_DescribeGlobalReplicationGroups.go index fe196455c3c..c1c0096ad29 100644 --- a/service/elasticache/api_op_DescribeGlobalReplicationGroups.go +++ b/service/elasticache/api_op_DescribeGlobalReplicationGroups.go @@ -34,10 +34,10 @@ type DescribeGlobalReplicationGroupsInput struct { // The name of the Global datastore GlobalReplicationGroupId *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -56,9 +56,9 @@ type DescribeGlobalReplicationGroupsOutput struct { // Indicates the slot configuration and global identifier for each slice group. GlobalReplicationGroups []types.GlobalReplicationGroup - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string diff --git a/service/elasticache/api_op_DescribeReplicationGroups.go b/service/elasticache/api_op_DescribeReplicationGroups.go index a733be48363..0859fb920ad 100644 --- a/service/elasticache/api_op_DescribeReplicationGroups.go +++ b/service/elasticache/api_op_DescribeReplicationGroups.go @@ -38,10 +38,10 @@ func (c *Client) DescribeReplicationGroups(ctx context.Context, params *Describe // Represents the input of a DescribeReplicationGroups operation. type DescribeReplicationGroupsInput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -243,8 +243,8 @@ type ReplicationGroupAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationGroupAvailableWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationGroupAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -295,10 +295,10 @@ func (w *ReplicationGroupAvailableWaiter) Wait(ctx context.Context, params *Desc return err } -// WaitForOutput calls the waiter function for ReplicationGroupAvailable waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for ReplicationGroupAvailable waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *ReplicationGroupAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeReplicationGroupsInput, maxWaitDur time.Duration, optFns ...func(*ReplicationGroupAvailableWaiterOptions)) (*DescribeReplicationGroupsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -445,8 +445,8 @@ type ReplicationGroupDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReplicationGroupDeletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReplicationGroupDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/elasticache/api_op_DescribeReservedCacheNodes.go b/service/elasticache/api_op_DescribeReservedCacheNodes.go index 6160360e5bc..b56b0bf0031 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodes.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodes.go @@ -37,73 +37,51 @@ type DescribeReservedCacheNodesInput struct { // are supported by ElastiCache. Generally speaking, the current generation types // provide more memory and computational power at lower cost when compared to their // equivalent previous generation counterparts. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , // - // * General purpose: - // - // * Current - // generation: M6g node types (available only for Redis engine version 5.0.6 onward - // and for Memcached engine version 1.5.16 onward): cache.m6g.large, - // cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, - // cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported - // Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // The duration filter value, specified in years or seconds. Use this parameter to @@ -111,10 +89,10 @@ type DescribeReservedCacheNodesInput struct { // 94608000 Duration *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -133,8 +111,8 @@ type DescribeReservedCacheNodesInput struct { // reservations matching the specified product description. ProductDescription *string - // The reserved cache node identifier filter value. Use this parameter to show only - // the reservation that matches the specified reservation ID. + // The reserved cache node identifier filter value. Use this parameter to show + // only the reservation that matches the specified reservation ID. ReservedCacheNodeId *string // The offering identifier filter value. Use this parameter to show only purchased diff --git a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go index 3ffce0bd945..bf1073d4065 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go @@ -36,84 +36,62 @@ type DescribeReservedCacheNodesOfferingsInput struct { // supported by ElastiCache. Generally speaking, the current generation types // provide more memory and computational power at lower cost when compared to their // equivalent previous generation counterparts. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , // - // * General purpose: - // - // * Current - // generation: M6g node types (available only for Redis engine version 5.0.6 onward - // and for Memcached engine version 1.5.16 onward): cache.m6g.large, - // cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, - // cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported - // Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string - // Duration filter value, specified in years or seconds. Use this parameter to show - // only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | + // Duration filter value, specified in years or seconds. Use this parameter to + // show only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | // 94608000 Duration *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -224,8 +202,8 @@ type DescribeReservedCacheNodesOfferingsAPIClient interface { var _ DescribeReservedCacheNodesOfferingsAPIClient = (*Client)(nil) -// DescribeReservedCacheNodesOfferingsPaginatorOptions is the paginator options for -// DescribeReservedCacheNodesOfferings +// DescribeReservedCacheNodesOfferingsPaginatorOptions is the paginator options +// for DescribeReservedCacheNodesOfferings type DescribeReservedCacheNodesOfferingsPaginatorOptions struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so diff --git a/service/elasticache/api_op_DescribeServiceUpdates.go b/service/elasticache/api_op_DescribeServiceUpdates.go index bdbe6a48688..c4441f08f79 100644 --- a/service/elasticache/api_op_DescribeServiceUpdates.go +++ b/service/elasticache/api_op_DescribeServiceUpdates.go @@ -30,10 +30,10 @@ func (c *Client) DescribeServiceUpdates(ctx context.Context, params *DescribeSer type DescribeServiceUpdatesInput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response @@ -50,10 +50,10 @@ type DescribeServiceUpdatesInput struct { type DescribeServiceUpdatesOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // A list of service updates diff --git a/service/elasticache/api_op_DescribeSnapshots.go b/service/elasticache/api_op_DescribeSnapshots.go index 10d2275271f..f0aa7c50051 100644 --- a/service/elasticache/api_op_DescribeSnapshots.go +++ b/service/elasticache/api_op_DescribeSnapshots.go @@ -38,10 +38,10 @@ type DescribeSnapshotsInput struct { // snapshots associated with that specific cluster are described. CacheClusterId *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -62,7 +62,7 @@ type DescribeSnapshotsInput struct { // snapshot are described. SnapshotName *string - // If set to system, the output shows snapshots that were automatically created by + // If set to system , the output shows snapshots that were automatically created by // ElastiCache. If set to user the output shows snapshots that were manually // created. If omitted, the output shows both automatically and manually created // snapshots. @@ -74,10 +74,10 @@ type DescribeSnapshotsInput struct { // Represents the output of a DescribeSnapshots operation. type DescribeSnapshotsOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // A list of snapshots. Each item in the list contains detailed information about diff --git a/service/elasticache/api_op_DescribeUpdateActions.go b/service/elasticache/api_op_DescribeUpdateActions.go index 0e0ba8b3e01..5e8f252dc18 100644 --- a/service/elasticache/api_op_DescribeUpdateActions.go +++ b/service/elasticache/api_op_DescribeUpdateActions.go @@ -36,10 +36,10 @@ type DescribeUpdateActionsInput struct { // The Elasticache engine to which the update applies. Either Redis or Memcached Engine *string - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // The maximum number of records to include in the response @@ -69,10 +69,10 @@ type DescribeUpdateActionsInput struct { type DescribeUpdateActionsOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by - // MaxRecords. + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by + // MaxRecords . Marker *string // Returns a list of update actions diff --git a/service/elasticache/api_op_DescribeUserGroups.go b/service/elasticache/api_op_DescribeUserGroups.go index a706254d0d2..43462b56b32 100644 --- a/service/elasticache/api_op_DescribeUserGroups.go +++ b/service/elasticache/api_op_DescribeUserGroups.go @@ -30,9 +30,9 @@ func (c *Client) DescribeUserGroups(ctx context.Context, params *DescribeUserGro type DescribeUserGroupsInput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string @@ -49,9 +49,9 @@ type DescribeUserGroupsInput struct { type DescribeUserGroupsOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string diff --git a/service/elasticache/api_op_DescribeUsers.go b/service/elasticache/api_op_DescribeUsers.go index f6b2f3e5a2b..14a66d4502c 100644 --- a/service/elasticache/api_op_DescribeUsers.go +++ b/service/elasticache/api_op_DescribeUsers.go @@ -36,9 +36,9 @@ type DescribeUsersInput struct { // Filter to determine the list of User IDs to return. Filters []types.Filter - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string @@ -55,9 +55,9 @@ type DescribeUsersInput struct { type DescribeUsersOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. > Marker *string diff --git a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go index 2d267997445..992a8735e2c 100644 --- a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go @@ -56,9 +56,8 @@ type DisassociateGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go index 294e96fc935..f7f08f035ff 100644 --- a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go +++ b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go @@ -54,9 +54,8 @@ type FailoverGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go index 4f47638f024..cbac95ede1b 100644 --- a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go @@ -58,9 +58,8 @@ type IncreaseNodeGroupsInGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_IncreaseReplicaCount.go b/service/elasticache/api_op_IncreaseReplicaCount.go index 41d31db86cf..bbfb35cbc24 100644 --- a/service/elasticache/api_op_IncreaseReplicaCount.go +++ b/service/elasticache/api_op_IncreaseReplicaCount.go @@ -32,7 +32,7 @@ func (c *Client) IncreaseReplicaCount(ctx context.Context, params *IncreaseRepli type IncreaseReplicaCountInput struct { - // If True, the number of replica nodes is increased immediately. + // If True , the number of replica nodes is increased immediately. // ApplyImmediately=False is not currently supported. // // This member is required. @@ -52,7 +52,7 @@ type IncreaseReplicaCountInput struct { // A list of ConfigureShard objects that can be used to configure each shard in a // Redis (cluster mode enabled) replication group. The ConfigureShard has three - // members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones. + // members: NewReplicaCount , NodeGroupId , and PreferredAvailabilityZones . ReplicaConfiguration []types.ConfigureShard noSmithyDocumentSerde diff --git a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go index 19a090d9201..148ce266924 100644 --- a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go +++ b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go @@ -36,14 +36,14 @@ type ListAllowedNodeTypeModificationsInput struct { // The name of the cluster you want to scale up to a larger node instanced type. // ElastiCache uses the cluster id to identify the current node type of this // cluster and from that to create a list of node types you can scale up to. You - // must provide a value for either the CacheClusterId or the ReplicationGroupId. + // must provide a value for either the CacheClusterId or the ReplicationGroupId . CacheClusterId *string // The name of the replication group want to scale up to a larger node type. // ElastiCache uses the replication group id to identify the current node type // being used by this replication group, and from that to create a list of node // types you can scale up to. You must provide a value for either the - // CacheClusterId or the ReplicationGroupId. + // CacheClusterId or the ReplicationGroupId . ReplicationGroupId *string noSmithyDocumentSerde @@ -61,7 +61,7 @@ type ListAllowedNodeTypeModificationsOutput struct { // A string list, each element of which specifies a cache node type which you can // use to scale your cluster or replication group. When scaling up a Redis cluster - // or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a + // or replication group using ModifyCacheCluster or ModifyReplicationGroup , use a // value from this list for the CacheNodeType parameter. ScaleUpModifications []string diff --git a/service/elasticache/api_op_ListTagsForResource.go b/service/elasticache/api_op_ListTagsForResource.go index 7be05078fe3..10e9425dfc2 100644 --- a/service/elasticache/api_op_ListTagsForResource.go +++ b/service/elasticache/api_op_ListTagsForResource.go @@ -16,9 +16,8 @@ import ( // all your ElastiCache resources, with the exception of global replication group. // When you add or remove tags on replication groups, those actions will be // replicated to all nodes in the replication group. For more information, see -// Resource-level permissions -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html). -// If the cluster is not in the available state, ListTagsForResource returns an +// Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html) +// . If the cluster is not in the available state, ListTagsForResource returns an // error. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -40,10 +39,10 @@ type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource for which you want the list of // tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or - // arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more - // information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot . For more + // information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web + // Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. ResourceName *string @@ -51,7 +50,7 @@ type ListTagsForResourceInput struct { noSmithyDocumentSerde } -// Represents the output from the AddTagsToResource, ListTagsForResource, and +// Represents the output from the AddTagsToResource , ListTagsForResource , and // RemoveTagsFromResource operations. type ListTagsForResourceOutput struct { diff --git a/service/elasticache/api_op_ModifyCacheCluster.go b/service/elasticache/api_op_ModifyCacheCluster.go index 6e8fddd8e39..bff2ae2d40e 100644 --- a/service/elasticache/api_op_ModifyCacheCluster.go +++ b/service/elasticache/api_op_ModifyCacheCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the settings for a cluster. You can use this operation to change one or -// more cluster configuration parameters by specifying the parameters and the new -// values. +// Modifies the settings for a cluster. You can use this operation to change one +// or more cluster configuration parameters by specifying the parameters and the +// new values. func (c *Client) ModifyCacheCluster(ctx context.Context, params *ModifyCacheClusterInput, optFns ...func(*Options)) (*ModifyCacheClusterOutput, error) { if params == nil { params = &ModifyCacheClusterInput{} @@ -39,62 +39,50 @@ type ModifyCacheClusterInput struct { // Specifies whether the new nodes in this Memcached cluster are all created in a // single Availability Zone or created across multiple Availability Zones. Valid - // values: single-az | cross-az. This option is only supported for Memcached + // values: single-az | cross-az . This option is only supported for Memcached // clusters. You cannot specify single-az if the Memcached cluster already has // cache nodes in different Availability Zones. If cross-az is specified, existing // Memcached nodes remain in their current Availability Zone. Only newly created // nodes are located in different Availability Zones. AZMode types.AZMode - // If true, this parameter causes the modifications in this request and any pending - // modifications to be applied, asynchronously and as soon as possible, regardless - // of the PreferredMaintenanceWindow setting for the cluster. If false, changes to - // the cluster are applied on the next maintenance reboot, or the next failure - // reboot, whichever occurs first. If you perform a ModifyCacheCluster before a - // pending modification is applied, the pending modification is replaced by the - // newer modification. Valid values: true | false Default: false + // If true , this parameter causes the modifications in this request and any + // pending modifications to be applied, asynchronously and as soon as possible, + // regardless of the PreferredMaintenanceWindow setting for the cluster. If false , + // changes to the cluster are applied on the next maintenance reboot, or the next + // failure reboot, whichever occurs first. If you perform a ModifyCacheCluster + // before a pending modification is applied, the pending modification is replaced + // by the newer modification. Valid values: true | false Default: false ApplyImmediately bool // Reserved parameter. The password used to access a password protected server. // This parameter must be specified with the auth-token-update parameter. Password // constraints: - // - // * Must be only printable ASCII characters - // - // * Must be at least 16 - // characters and no more than 128 characters in length - // - // * Cannot contain any of - // the following characters: '/', '"', or '@', '%' - // - // For more information, see AUTH - // password at AUTH (http://redis.io/commands/AUTH). + // - Must be only printable ASCII characters + // - Must be at least 16 characters and no more than 128 characters in length + // - Cannot contain any of the following characters: '/', '"', or '@', '%' + // For more information, see AUTH password at AUTH (http://redis.io/commands/AUTH) . AuthToken *string // Specifies the strategy to use to update the AUTH token. This parameter must be // specified with the auth-token parameter. Possible values: - // - // * Rotate - // - // * Set - // - // For - // more information, see Authenticating Users with Redis AUTH - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) + // - Rotate + // - Set + // For more information, see Authenticating Users with Redis AUTH (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade *bool - // A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, - // 0002, etc.). This parameter is only valid when NumCacheNodes is less than the - // existing number of cache nodes. The number of cache node IDs supplied in this - // parameter must match the difference between the existing number of cache nodes - // in the cluster or pending cache nodes, whichever is greater, and the value of - // NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 - // pending cache nodes, and the number of cache nodes in this ModifyCacheCluster + // A list of cache node IDs to be removed. A node ID is a numeric identifier + // (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less + // than the existing number of cache nodes. The number of cache node IDs supplied + // in this parameter must match the difference between the existing number of cache + // nodes in the cluster or pending cache nodes, whichever is greater, and the value + // of NumCacheNodes in the request. For example: If you have 3 active cache nodes, + // 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster // call is 5, you must list 2 (7 - 5) cache node IDs to remove. CacheNodeIdsToRemove []string @@ -115,17 +103,16 @@ type ModifyCacheClusterInput struct { // The upgraded version of the cache engine to be run on the cache nodes. // Important: You can upgrade to a newer engine version (see Selecting a Cache - // Engine and Version - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), - // but you cannot downgrade to an earlier engine version. If you want to use an + // Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) + // ), but you cannot downgrade to an earlier engine version. If you want to use an // earlier engine version, you must delete the existing cluster and create it anew // with the earlier engine version. EngineVersion *string - // The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 + // The network type you choose when modifying a cluster, either ipv4 | ipv6 . IPv6 // is supported for workloads using Redis engine version 6.2 onward or Memcached - // engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. @@ -133,76 +120,46 @@ type ModifyCacheClusterInput struct { // This option is only supported on Memcached clusters. The list of Availability // Zones where the new Memcached cache nodes are created. This parameter is only - // valid when NumCacheNodes in the request is greater than the sum of the number of - // active cache nodes and the number of cache nodes pending creation (which may be - // zero). The number of Availability Zones supplied in this list must match the + // valid when NumCacheNodes in the request is greater than the sum of the number + // of active cache nodes and the number of cache nodes pending creation (which may + // be zero). The number of Availability Zones supplied in this list must match the // cache nodes being added in this request. Scenarios: - // - // * Scenario 1: You have 3 - // active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and - // optionally specify two Availability Zones for the two new nodes. - // - // * Scenario 2: - // You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) - // and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and - // optionally specify an Availability Zone for the new node. - // - // * Scenario 3: You - // want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all - // pending operations. - // - // The Availability Zone placement of nodes pending creation - // cannot be modified. If you wish to cancel any nodes pending creation, add 0 - // nodes by setting NumCacheNodes to the number of current nodes. If cross-az is - // specified, existing Memcached nodes remain in their current Availability Zone. - // Only newly created nodes can be located in different Availability Zones. For - // guidance on how to move existing Memcached nodes to different Availability - // Zones, see the Availability Zone Considerations section of Cache Node - // Considerations for Memcached - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html). - // Impact of new add/remove requests upon pending requests - // - // * Scenario-1 - // - // * Pending - // Action: Delete - // - // * New Request: Delete - // - // * Result: The new delete, pending or - // immediate, replaces the pending delete. - // - // * Scenario-2 - // - // * Pending Action: - // Delete - // - // * New Request: Create - // - // * Result: The new create, pending or immediate, - // replaces the pending delete. - // - // * Scenario-3 - // - // * Pending Action: Create - // - // * New - // Request: Delete - // - // * Result: The new delete, pending or immediate, replaces the - // pending create. - // - // * Scenario-4 - // - // * Pending Action: Create - // - // * New Request: - // Create - // - // * Result: The new create is added to the pending create. Important: If - // the new create request is Apply Immediately - Yes, all creates are performed - // immediately. If the new create request is Apply Immediately - No, all creates - // are pending. + // - Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify + // NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the + // two new nodes. + // - Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the + // scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + // + 1) and optionally specify an Availability Zone for the new node. + // - Scenario 3: You want to cancel all pending operations. Specify + // NumCacheNodes=3 to cancel all pending operations. + // The Availability Zone placement of nodes pending creation cannot be modified. + // If you wish to cancel any nodes pending creation, add 0 nodes by setting + // NumCacheNodes to the number of current nodes. If cross-az is specified, + // existing Memcached nodes remain in their current Availability Zone. Only newly + // created nodes can be located in different Availability Zones. For guidance on + // how to move existing Memcached nodes to different Availability Zones, see the + // Availability Zone Considerations section of Cache Node Considerations for + // Memcached (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html) + // . Impact of new add/remove requests upon pending requests + // - Scenario-1 + // - Pending Action: Delete + // - New Request: Delete + // - Result: The new delete, pending or immediate, replaces the pending delete. + // - Scenario-2 + // - Pending Action: Delete + // - New Request: Create + // - Result: The new create, pending or immediate, replaces the pending delete. + // - Scenario-3 + // - Pending Action: Create + // - New Request: Delete + // - Result: The new delete, pending or immediate, replaces the pending create. + // - Scenario-4 + // - Pending Action: Create + // - New Request: Create + // - Result: The new create is added to the pending create. Important: If the + // new create request is Apply Immediately - Yes, all creates are performed + // immediately. If the new create request is Apply Immediately - No, all creates + // are pending. NewAvailabilityZones []string // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications @@ -210,7 +167,7 @@ type ModifyCacheClusterInput struct { NotificationTopicArn *string // The status of the Amazon SNS notification topic. Notifications are sent only if - // the status is active. Valid values: active | inactive + // the status is active . Valid values: active | inactive NotificationTopicStatus *string // The number of cache nodes that the cluster should have. If the value for @@ -223,7 +180,7 @@ type ModifyCacheClusterInput struct { // nodes to remove. For clusters running Redis, this value must be 1. For clusters // running Memcached, this value must be between 1 and 40. Adding or removing // Memcached cache nodes can be applied immediately or as a pending operation (see - // ApplyImmediately). A pending operation to modify the number of cache nodes in a + // ApplyImmediately ). A pending operation to modify the number of cache nodes in a // cluster during its maintenance window, whether by adding or removing nodes in // accordance with the scale out architecture, is not queued. The customer's latest // request to add or remove nodes to the cluster overrides any previous pending @@ -244,23 +201,14 @@ type ModifyCacheClusterInput struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string // Specifies the VPC Security Groups associated with the cluster. This parameter diff --git a/service/elasticache/api_op_ModifyCacheParameterGroup.go b/service/elasticache/api_op_ModifyCacheParameterGroup.go index 813dd674094..23582d33472 100644 --- a/service/elasticache/api_op_ModifyCacheParameterGroup.go +++ b/service/elasticache/api_op_ModifyCacheParameterGroup.go @@ -37,9 +37,9 @@ type ModifyCacheParameterGroupInput struct { // This member is required. CacheParameterGroupName *string - // An array of parameter names and values for the parameter update. You must supply - // at least one parameter name and value; subsequent arguments are optional. A - // maximum of 20 parameters may be modified per request. + // An array of parameter names and values for the parameter update. You must + // supply at least one parameter name and value; subsequent arguments are optional. + // A maximum of 20 parameters may be modified per request. // // This member is required. ParameterNameValues []types.ParameterNameValue @@ -48,11 +48,8 @@ type ModifyCacheParameterGroupInput struct { } // Represents the output of one of the following operations: -// -// * -// ModifyCacheParameterGroup -// -// * ResetCacheParameterGroup +// - ModifyCacheParameterGroup +// - ResetCacheParameterGroup type ModifyCacheParameterGroupOutput struct { // The name of the cache parameter group. diff --git a/service/elasticache/api_op_ModifyCacheSubnetGroup.go b/service/elasticache/api_op_ModifyCacheSubnetGroup.go index ef4ea52413a..4a25ab4962a 100644 --- a/service/elasticache/api_op_ModifyCacheSubnetGroup.go +++ b/service/elasticache/api_op_ModifyCacheSubnetGroup.go @@ -30,9 +30,9 @@ func (c *Client) ModifyCacheSubnetGroup(ctx context.Context, params *ModifyCache // Represents the input of a ModifyCacheSubnetGroup operation. type ModifyCacheSubnetGroupInput struct { - // The name for the cache subnet group. This value is stored as a lowercase string. - // Constraints: Must contain no more than 255 alphanumeric characters or hyphens. - // Example: mysubnetgroup + // The name for the cache subnet group. This value is stored as a lowercase + // string. Constraints: Must contain no more than 255 alphanumeric characters or + // hyphens. Example: mysubnetgroup // // This member is required. CacheSubnetGroupName *string @@ -49,11 +49,8 @@ type ModifyCacheSubnetGroupInput struct { type ModifyCacheSubnetGroupOutput struct { // Represents the output of one of the following operations: - // - // * - // CreateCacheSubnetGroup - // - // * ModifyCacheSubnetGroup + // - CreateCacheSubnetGroup + // - ModifyCacheSubnetGroup CacheSubnetGroup *types.CacheSubnetGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go index 6789ff54509..764322131cc 100644 --- a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go +++ b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go @@ -53,8 +53,8 @@ type ModifyGlobalReplicationGroupInput struct { // be compatible with the major engine version used by the Global datastore. CacheParameterGroupName *string - // The upgraded version of the cache engine to be run on the clusters in the Global - // datastore. + // The upgraded version of the cache engine to be run on the clusters in the + // Global datastore. EngineVersion *string // A description of the Global datastore @@ -69,9 +69,8 @@ type ModifyGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_ModifyReplicationGroup.go b/service/elasticache/api_op_ModifyReplicationGroup.go index c3142c0c126..4db3f9474e2 100644 --- a/service/elasticache/api_op_ModifyReplicationGroup.go +++ b/service/elasticache/api_op_ModifyReplicationGroup.go @@ -12,15 +12,10 @@ import ( ) // Modifies the settings for a replication group. -// -// * Scaling for Amazon ElastiCache -// for Redis (cluster mode enabled) -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html) -// in the ElastiCache User Guide -// -// * ModifyReplicationGroupShardConfiguration -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html) -// in the ElastiCache API Reference +// - Scaling for Amazon ElastiCache for Redis (cluster mode enabled) (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html) +// in the ElastiCache User Guide +// - ModifyReplicationGroupShardConfiguration (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html) +// in the ElastiCache API Reference // // This operation is valid for Redis only. func (c *Client) ModifyReplicationGroup(ctx context.Context, params *ModifyReplicationGroupInput, optFns ...func(*Options)) (*ModifyReplicationGroupOutput, error) { @@ -46,44 +41,32 @@ type ModifyReplicationGroupInput struct { // This member is required. ReplicationGroupId *string - // If true, this parameter causes the modifications in this request and any pending - // modifications to be applied, asynchronously and as soon as possible, regardless - // of the PreferredMaintenanceWindow setting for the replication group. If false, - // changes to the nodes in the replication group are applied on the next + // If true , this parameter causes the modifications in this request and any + // pending modifications to be applied, asynchronously and as soon as possible, + // regardless of the PreferredMaintenanceWindow setting for the replication group. + // If false , changes to the nodes in the replication group are applied on the next // maintenance reboot, or the next failure reboot, whichever occurs first. Valid // values: true | false Default: false ApplyImmediately bool // Reserved parameter. The password used to access a password protected server. - // This parameter must be specified with the auth-token-update-strategy parameter. - // Password constraints: - // - // * Must be only printable ASCII characters - // - // * Must be at - // least 16 characters and no more than 128 characters in length - // - // * Cannot contain - // any of the following characters: '/', '"', or '@', '%' - // - // For more information, - // see AUTH password at AUTH (http://redis.io/commands/AUTH). + // This parameter must be specified with the auth-token-update-strategy + // parameter. Password constraints: + // - Must be only printable ASCII characters + // - Must be at least 16 characters and no more than 128 characters in length + // - Cannot contain any of the following characters: '/', '"', or '@', '%' + // For more information, see AUTH password at AUTH (http://redis.io/commands/AUTH) . AuthToken *string // Specifies the strategy to use to update the AUTH token. This parameter must be // specified with the auth-token parameter. Possible values: - // - // * Rotate - // - // * Set - // - // For - // more information, see Authenticating Users with Redis AUTH - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) + // - Rotate + // - Set + // For more information, see Authenticating Users with Redis AUTH (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) AuthTokenUpdateStrategy types.AuthTokenUpdateStrategyType - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade *bool @@ -104,22 +87,21 @@ type ModifyReplicationGroupInput struct { // replication group. This change is asynchronously applied as soon as possible. // This parameter can be used only with replication group containing clusters // running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: - // Must contain no more than 255 alphanumeric characters. Must not be Default. + // Must contain no more than 255 alphanumeric characters. Must not be Default . CacheSecurityGroupNames []string // The upgraded version of the cache engine to be run on the clusters in the // replication group. Important: You can upgrade to a newer engine version (see - // Selecting a Cache Engine and Version - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), - // but you cannot downgrade to an earlier engine version. If you want to use an + // Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) + // ), but you cannot downgrade to an earlier engine version. If you want to use an // earlier engine version, you must delete the existing replication group and // create it anew with the earlier engine version. EngineVersion *string - // The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 + // The network type you choose when modifying a cluster, either ipv4 | ipv6 . IPv6 // is supported for workloads using Redis engine version 6.2 onward or Memcached - // engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. @@ -139,7 +121,7 @@ type ModifyReplicationGroupInput struct { NotificationTopicArn *string // The status of the Amazon SNS notification topic for the replication group. - // Notifications are sent only if the status is active. Valid values: active | + // Notifications are sent only if the status is active . Valid values: active | // inactive NotificationTopicStatus *string @@ -147,23 +129,14 @@ type ModifyReplicationGroupInput struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string // For replication groups with a single primary, if this parameter is specified, @@ -191,7 +164,7 @@ type ModifyReplicationGroupInput struct { SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of the node group (shard) specified by SnapshottingClusterId. Example: + // snapshot of the node group (shard) specified by SnapshottingClusterId . Example: // 05:00-09:00 If you do not specify this parameter, ElastiCache automatically // chooses an appropriate time range. SnapshotWindow *string @@ -203,25 +176,25 @@ type ModifyReplicationGroupInput struct { // A flag that enables in-transit encryption when set to true. If you are enabling // in-transit encryption for an existing cluster, you must also set - // TransitEncryptionMode to preferred. + // TransitEncryptionMode to preferred . TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, - // with no downtime. You must set TransitEncryptionEnabled to true, for your - // existing cluster, and set TransitEncryptionMode to preferred in the same request - // to allow both encrypted and unencrypted connections at the same time. Once you - // migrate all your Redis clients to use encrypted connections you can set the - // value to required to allow encrypted connections only. Setting + // with no downtime. You must set TransitEncryptionEnabled to true , for your + // existing cluster, and set TransitEncryptionMode to preferred in the same + // request to allow both encrypted and unencrypted connections at the same time. + // Once you migrate all your Redis clients to use encrypted connections you can set + // the value to required to allow encrypted connections only. Setting // TransitEncryptionMode to required is a two-step process that requires you to // first set the TransitEncryptionMode to preferred first, after that you can set - // TransitEncryptionMode to required. + // TransitEncryptionMode to required . TransitEncryptionMode types.TransitEncryptionMode // The ID of the user group you are associating with the replication group. UserGroupIdsToAdd []string - // The ID of the user group to disassociate from the replication group, meaning the - // users in the group no longer can access the replication group. + // The ID of the user group to disassociate from the replication group, meaning + // the users in the group no longer can access the replication group. UserGroupIdsToRemove []string noSmithyDocumentSerde diff --git a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go index 39865fa6ac8..c997a335d9e 100644 --- a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go +++ b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go @@ -31,8 +31,8 @@ func (c *Client) ModifyReplicationGroupShardConfiguration(ctx context.Context, p // Represents the input for a ModifyReplicationGroupShardConfiguration operation. type ModifyReplicationGroupShardConfigurationInput struct { - // Indicates that the shard reconfiguration process begins immediately. At present, - // the only permitted value for this parameter is true. Value: true + // Indicates that the shard reconfiguration process begins immediately. At + // present, the only permitted value for this parameter is true . Value: true // // This member is required. ApplyImmediately bool @@ -51,24 +51,25 @@ type ModifyReplicationGroupShardConfigurationInput struct { // If the value of NodeGroupCount is less than the current number of node groups // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. - // NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. + // NodeGroupsToRemove is a list of NodeGroupId s to remove from the cluster. // ElastiCache for Redis will attempt to remove all node groups listed by // NodeGroupsToRemove from the cluster. NodeGroupsToRemove []string // If the value of NodeGroupCount is less than the current number of node groups // (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. - // NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. + // NodeGroupsToRetain is a list of NodeGroupId s to retain in the cluster. // ElastiCache for Redis will attempt to remove all node groups except those listed // by NodeGroupsToRetain from the cluster. NodeGroupsToRetain []string // Specifies the preferred availability zones for each node group in the cluster. - // If the value of NodeGroupCount is greater than the current number of node groups - // (shards), you can use this parameter to specify the preferred availability zones - // of the cluster's shards. If you omit this parameter ElastiCache selects - // availability zones for you. You can specify this parameter only if the value of - // NodeGroupCount is greater than the current number of node groups (shards). + // If the value of NodeGroupCount is greater than the current number of node + // groups (shards), you can use this parameter to specify the preferred + // availability zones of the cluster's shards. If you omit this parameter + // ElastiCache selects availability zones for you. You can specify this parameter + // only if the value of NodeGroupCount is greater than the current number of node + // groups (shards). ReshardingConfiguration []types.ReshardingConfiguration noSmithyDocumentSerde diff --git a/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go b/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go index a7b24e929f0..c4e63857d0c 100644 --- a/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go +++ b/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go @@ -13,10 +13,8 @@ import ( // Allows you to purchase a reserved cache node offering. Reserved nodes are not // eligible for cancellation and are non-refundable. For more information, see -// Managing Costs with Reserved Nodes -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html) -// for Redis or Managing Costs with Reserved Nodes -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html) +// Managing Costs with Reserved Nodes (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes.html) +// for Redis or Managing Costs with Reserved Nodes (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html) // for Memcached. func (c *Client) PurchaseReservedCacheNodesOffering(ctx context.Context, params *PurchaseReservedCacheNodesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedCacheNodesOfferingOutput, error) { if params == nil { diff --git a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go index 6f14c3a49a5..2e09dc88183 100644 --- a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go @@ -30,7 +30,7 @@ func (c *Client) RebalanceSlotsInGlobalReplicationGroup(ctx context.Context, par type RebalanceSlotsInGlobalReplicationGroupInput struct { - // If True, redistribution is applied immediately. + // If True , redistribution is applied immediately. // // This member is required. ApplyImmediately bool @@ -49,9 +49,8 @@ type RebalanceSlotsInGlobalReplicationGroupOutput struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. - // - // * The GlobalReplicationGroupIdSuffix represents the name of - // the Global datastore, which is what you use to associate a secondary cluster. + // - The GlobalReplicationGroupIdSuffix represents the name of the Global + // datastore, which is what you use to associate a secondary cluster. GlobalReplicationGroup *types.GlobalReplicationGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_RebootCacheCluster.go b/service/elasticache/api_op_RebootCacheCluster.go index ea556e4d77b..157af022240 100644 --- a/service/elasticache/api_op_RebootCacheCluster.go +++ b/service/elasticache/api_op_RebootCacheCluster.go @@ -20,8 +20,7 @@ import ( // cluster is currently supported on Memcached and Redis (cluster mode disabled) // clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. // If you make changes to parameters that require a Redis (cluster mode enabled) -// cluster reboot for the changes to be applied, see Rebooting a Cluster -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html) +// cluster reboot for the changes to be applied, see Rebooting a Cluster (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html) // for an alternate process. func (c *Client) RebootCacheCluster(ctx context.Context, params *RebootCacheClusterInput, optFns ...func(*Options)) (*RebootCacheClusterOutput, error) { if params == nil { diff --git a/service/elasticache/api_op_RemoveTagsFromResource.go b/service/elasticache/api_op_RemoveTagsFromResource.go index 1b00d867692..58b00d2e76d 100644 --- a/service/elasticache/api_op_RemoveTagsFromResource.go +++ b/service/elasticache/api_op_RemoveTagsFromResource.go @@ -16,8 +16,8 @@ import ( // to categorize and track all your ElastiCache resources, with the exception of // global replication group. When you add or remove tags on replication groups, // those actions will be replicated to all nodes in the replication group. For more -// information, see Resource-level permissions -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html). +// information, see Resource-level permissions (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html) +// . func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { params = &RemoveTagsFromResourceInput{} @@ -38,10 +38,10 @@ type RemoveTagsFromResourceInput struct { // The Amazon Resource Name (ARN) of the resource from which you want the tags // removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster - // or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more + // or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot . For more // information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. ResourceName *string @@ -54,7 +54,7 @@ type RemoveTagsFromResourceInput struct { noSmithyDocumentSerde } -// Represents the output from the AddTagsToResource, ListTagsForResource, and +// Represents the output from the AddTagsToResource , ListTagsForResource , and // RemoveTagsFromResource operations. type RemoveTagsFromResourceOutput struct { diff --git a/service/elasticache/api_op_ResetCacheParameterGroup.go b/service/elasticache/api_op_ResetCacheParameterGroup.go index 9a75d5490fc..2afacec0507 100644 --- a/service/elasticache/api_op_ResetCacheParameterGroup.go +++ b/service/elasticache/api_op_ResetCacheParameterGroup.go @@ -39,25 +39,22 @@ type ResetCacheParameterGroupInput struct { CacheParameterGroupName *string // An array of parameter names to reset to their default values. If - // ResetAllParameters is true, do not use ParameterNameValues. If - // ResetAllParameters is false, you must specify the name of at least one parameter - // to reset. + // ResetAllParameters is true , do not use ParameterNameValues . If + // ResetAllParameters is false , you must specify the name of at least one + // parameter to reset. ParameterNameValues []types.ParameterNameValue - // If true, all parameters in the cache parameter group are reset to their default - // values. If false, only the parameters listed by ParameterNameValues are reset to - // their default values. Valid values: true | false + // If true , all parameters in the cache parameter group are reset to their default + // values. If false , only the parameters listed by ParameterNameValues are reset + // to their default values. Valid values: true | false ResetAllParameters bool noSmithyDocumentSerde } // Represents the output of one of the following operations: -// -// * -// ModifyCacheParameterGroup -// -// * ResetCacheParameterGroup +// - ModifyCacheParameterGroup +// - ResetCacheParameterGroup type ResetCacheParameterGroupOutput struct { // The name of the cache parameter group. diff --git a/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go b/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go index 29df8a053c4..50d690360b5 100644 --- a/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go +++ b/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go @@ -41,8 +41,8 @@ type RevokeCacheSecurityGroupIngressInput struct { // This member is required. EC2SecurityGroupName *string - // The Amazon account number of the Amazon EC2 security group owner. Note that this - // is not the same thing as an Amazon access key ID - you must provide a valid + // The Amazon account number of the Amazon EC2 security group owner. Note that + // this is not the same thing as an Amazon access key ID - you must provide a valid // Amazon account number for this parameter. // // This member is required. @@ -54,14 +54,9 @@ type RevokeCacheSecurityGroupIngressInput struct { type RevokeCacheSecurityGroupIngressOutput struct { // Represents the output of one of the following operations: - // - // * - // AuthorizeCacheSecurityGroupIngress - // - // * CreateCacheSecurityGroup - // - // * - // RevokeCacheSecurityGroupIngress + // - AuthorizeCacheSecurityGroupIngress + // - CreateCacheSecurityGroup + // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_TestFailover.go b/service/elasticache/api_op_TestFailover.go index 07ae6105e41..28ae8acac72 100644 --- a/service/elasticache/api_op_TestFailover.go +++ b/service/elasticache/api_op_TestFailover.go @@ -18,52 +18,31 @@ import ( // operational tool for initiating a failover to overcome a problem you may have // with the cluster. Moreover, in certain conditions such as large-scale // operational events, Amazon may block this API. Note the following +// - A customer can use this operation to test automatic failover on up to 5 +// shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling +// 24-hour period. +// - If calling this operation on shards in different clusters (called +// replication groups in the API and CLI), the calls can be made concurrently. +// - If calling this operation multiple times on different shards in the same +// Redis (cluster mode enabled) replication group, the first node replacement must +// complete before a subsequent call can be made. +// - To determine whether the node replacement is complete you can check Events +// using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. +// Look for the following automatic failover related events, listed here in order +// of occurrance: +// - Replication group message: Test Failover API called for node group +// - Cache cluster message: Failover from primary node to replica node completed +// - Replication group message: Failover from primary node to replica node +// completed +// - Cache cluster message: Recovering cache nodes +// - Cache cluster message: Finished recovery for cache nodes For more +// information see: +// - Viewing ElastiCache Events (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html) +// in the ElastiCache User Guide +// - DescribeEvents (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html) +// in the ElastiCache API Reference // -// * A customer -// can use this operation to test automatic failover on up to 5 shards (called node -// groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period. -// -// * -// If calling this operation on shards in different clusters (called replication -// groups in the API and CLI), the calls can be made concurrently. -// -// * If calling -// this operation multiple times on different shards in the same Redis (cluster -// mode enabled) replication group, the first node replacement must complete before -// a subsequent call can be made. -// -// * To determine whether the node replacement is -// complete you can check Events using the Amazon ElastiCache console, the Amazon -// CLI, or the ElastiCache API. Look for the following automatic failover related -// events, listed here in order of occurrance: -// -// * Replication group message: Test -// Failover API called for node group -// -// * Cache cluster message: Failover from -// primary node to replica node completed -// -// * Replication group message: Failover -// from primary node to replica node completed -// -// * Cache cluster message: Recovering -// cache nodes -// -// * Cache cluster message: Finished recovery for cache nodes -// -// For -// more information see: -// -// * Viewing ElastiCache Events -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html) -// in the ElastiCache User Guide -// -// * DescribeEvents -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html) -// in the ElastiCache API Reference -// -// Also see, Testing Multi-AZ -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test) +// Also see, Testing Multi-AZ (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test) // in the ElastiCache User Guide. func (c *Client) TestFailover(ctx context.Context, params *TestFailoverInput, optFns ...func(*Options)) (*TestFailoverOutput, error) { if params == nil { @@ -89,8 +68,8 @@ type TestFailoverInput struct { // This member is required. NodeGroupId *string - // The name of the replication group (console: cluster) whose automatic failover is - // being tested by this operation. + // The name of the replication group (console: cluster) whose automatic failover + // is being tested by this operation. // // This member is required. ReplicationGroupId *string diff --git a/service/elasticache/doc.go b/service/elasticache/doc.go index 8cdb8345f62..ae72b3c85d4 100644 --- a/service/elasticache/doc.go +++ b/service/elasticache/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package elasticache provides the API client, operations, and parameter types for -// Amazon ElastiCache. +// Package elasticache provides the API client, operations, and parameter types +// for Amazon ElastiCache. // // Amazon ElastiCache Amazon ElastiCache is a web service that makes it easier to // set up, operate, and scale a distributed cache in the cloud. With ElastiCache, diff --git a/service/elasticache/types/enums.go b/service/elasticache/types/enums.go index 062b36103bd..662caa96ce3 100644 --- a/service/elasticache/types/enums.go +++ b/service/elasticache/types/enums.go @@ -30,8 +30,8 @@ const ( AuthTokenUpdateStatusRotating AuthTokenUpdateStatus = "ROTATING" ) -// Values returns all known values for AuthTokenUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AuthTokenUpdateStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AuthTokenUpdateStatus) Values() []AuthTokenUpdateStatus { return []AuthTokenUpdateStatus{ @@ -225,9 +225,9 @@ const ( LogFormatJson LogFormat = "json" ) -// Values returns all known values for LogFormat. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LogFormat. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LogFormat) Values() []LogFormat { return []LogFormat{ "text", @@ -299,8 +299,8 @@ const ( NodeUpdateInitiatedByCustomer NodeUpdateInitiatedBy = "customer" ) -// Values returns all known values for NodeUpdateInitiatedBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NodeUpdateInitiatedBy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NodeUpdateInitiatedBy) Values() []NodeUpdateInitiatedBy { return []NodeUpdateInitiatedBy{ @@ -382,8 +382,8 @@ const ( ServiceUpdateSeverityLow ServiceUpdateSeverity = "low" ) -// Values returns all known values for ServiceUpdateSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ServiceUpdateSeverity. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ServiceUpdateSeverity) Values() []ServiceUpdateSeverity { return []ServiceUpdateSeverity{ @@ -486,8 +486,8 @@ const ( TransitEncryptionModeRequired TransitEncryptionMode = "required" ) -// Values returns all known values for TransitEncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TransitEncryptionMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TransitEncryptionMode) Values() []TransitEncryptionMode { return []TransitEncryptionMode{ diff --git a/service/elasticache/types/errors.go b/service/elasticache/types/errors.go index 179c63a5227..dfd00fc2002 100644 --- a/service/elasticache/types/errors.go +++ b/service/elasticache/types/errors.go @@ -364,8 +364,8 @@ func (e *CacheSubnetGroupInUse) ErrorCode() string { } func (e *CacheSubnetGroupInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested cache subnet group name does not refer to an existing cache subnet -// group. +// The requested cache subnet group name does not refer to an existing cache +// subnet group. type CacheSubnetGroupNotFoundFault struct { Message *string @@ -613,8 +613,7 @@ func (e *GlobalReplicationGroupNotFoundFault) ErrorFault() smithy.ErrorFault { } // The requested cache node type is not available in the specified Availability -// Zone. For more information, see InsufficientCacheClusterCapacity -// (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) +// Zone. For more information, see InsufficientCacheClusterCapacity (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY) // in the ElastiCache User Guide. type InsufficientCacheClusterCapacityFault struct { Message *string @@ -1017,9 +1016,9 @@ func (e *InvalidVPCNetworkStateFault) ErrorCode() string { } func (e *InvalidVPCNetworkStateFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The node group specified by the NodeGroupId parameter could not be found. Please -// verify that the node group exists and that you spelled the NodeGroupId value -// correctly. +// The node group specified by the NodeGroupId parameter could not be found. +// Please verify that the node group exists and that you spelled the NodeGroupId +// value correctly. type NodeGroupNotFoundFault struct { Message *string @@ -1455,15 +1454,12 @@ func (e *SnapshotAlreadyExistsFault) ErrorCode() string { func (e *SnapshotAlreadyExistsFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You attempted one of the following operations: +// - Creating a snapshot of a Redis cluster running on a cache.t1.micro cache +// node. +// - Creating a snapshot of a cluster that is running Memcached rather than +// Redis. // -// * Creating a snapshot of a Redis -// cluster running on a cache.t1.micro cache node. -// -// * Creating a snapshot of a -// cluster that is running Memcached rather than Redis. -// -// Neither of these are -// supported by ElastiCache. +// Neither of these are supported by ElastiCache. type SnapshotFeatureNotSupportedFault struct { Message *string @@ -1623,8 +1619,8 @@ func (e *TagNotFoundFault) ErrorCode() string { } func (e *TagNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request cannot be processed because it would cause the resource to have more -// than the allowed number of tags. The maximum number of tags permitted on a +// The request cannot be processed because it would cause the resource to have +// more than the allowed number of tags. The maximum number of tags permitted on a // resource is 50. type TagQuotaPerResourceExceeded struct { Message *string diff --git a/service/elasticache/types/types.go b/service/elasticache/types/types.go index e0131ea7e5d..986e48fc3cc 100644 --- a/service/elasticache/types/types.go +++ b/service/elasticache/types/types.go @@ -22,7 +22,7 @@ type Authentication struct { // Specifies the authentication mode to use. type AuthenticationMode struct { - // Specifies the passwords to use for authentication if Type is set to password. + // Specifies the passwords to use for authentication if Type is set to password . Passwords []string // Specifies the authentication type. Possible options are IAM authentication, @@ -47,11 +47,11 @@ type CacheCluster struct { // The ARN (Amazon Resource Name) of the cache cluster. ARN *string - // A flag that enables encryption at-rest when set to true. You cannot modify the - // value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest - // encryption on a cluster you must set AtRestEncryptionEnabled to true when you - // create a cluster. Required: Only available when creating a replication group in - // an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + // A flag that enables encryption at-rest when set to true . You cannot modify the + // value of AtRestEncryptionEnabled after the cluster is created. To enable + // at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true + // when you create a cluster. Required: Only available when creating a replication + // group in an Amazon VPC using redis version 3.2.6 , 4.x or later. Default: false AtRestEncryptionEnabled *bool // A flag that enables using an AuthToken (password) when issuing Redis commands. @@ -61,8 +61,8 @@ type CacheCluster struct { // The date the auth token was last modified AuthTokenLastModifiedDate *time.Time - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade bool @@ -73,82 +73,60 @@ type CacheCluster struct { // that identifies a cluster. CacheClusterId *string - // The current state of this cluster, one of the following values: available, - // creating, deleted, deleting, incompatible-network, modifying, rebooting cluster - // nodes, restore-failed, or snapshotting. + // The current state of this cluster, one of the following values: available , + // creating , deleted , deleting , incompatible-network , modifying , rebooting + // cluster nodes , restore-failed , or snapshotting . CacheClusterStatus *string // The name of the compute and memory capacity node type for the cluster. The // following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower // cost when compared to their equivalent previous generation counterparts. - // - // * - // General purpose: - // - // * Current generation: M6g node types (available only for Redis - // engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): - // cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, - // cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region - // availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , + // + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // A list of cache nodes that are members of the cluster. @@ -173,24 +151,24 @@ type CacheCluster struct { // .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211 ConfigurationEndpoint *Endpoint - // The name of the cache engine (memcached or redis) to be used for this cluster. + // The name of the cache engine ( memcached or redis ) to be used for this cluster. Engine *string // The version of the cache engine that is used in this cluster. EngineVersion *string - // The network type associated with the cluster, either ipv4 | ipv6. IPv6 is + // The network type associated with the cluster, either ipv4 | ipv6 . IPv6 is // supported for workloads using Redis engine version 6.2 onward or Memcached - // engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery IpDiscovery // Returns the destination, format and type of the logs. LogDeliveryConfigurations []LogDeliveryConfiguration - // Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using + // Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . NetworkType NetworkType // Describes a notification topic and its status. Notification topics are used for @@ -198,8 +176,9 @@ type CacheCluster struct { // Service (SNS). NotificationConfiguration *NotificationConfiguration - // The number of cache nodes in the cluster. For clusters running Redis, this value - // must be 1. For clusters running Memcached, this value must be between 1 and 40. + // The number of cache nodes in the cluster. For clusters running Redis, this + // value must be 1. For clusters running Memcached, this value must be between 1 + // and 40. NumCacheNodes *int32 // A group of settings that are applied to the cluster in the future, or that are @@ -214,30 +193,21 @@ type CacheCluster struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string // The outpost ARN in which the cache cluster is created. PreferredOutpostArn *string - // The replication group to which this cluster belongs. If this field is empty, the - // cluster is not associated with any replication group. + // The replication group to which this cluster belongs. If this field is empty, + // the cluster is not associated with any replication group. ReplicationGroupId *string // A boolean value indicating whether log delivery is enabled for the replication @@ -257,9 +227,9 @@ type CacheCluster struct { // snapshot of your cluster. Example: 05:00-09:00 SnapshotWindow *string - // A flag that enables in-transit encryption when set to true. Required: Only + // A flag that enables in-transit encryption when set to true . Required: Only // available when creating a replication group in an Amazon VPC using redis version - // 3.2.6, 4.x or later. Default: false + // 3.2.6 , 4.x or later. Default: false TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, @@ -298,84 +268,63 @@ type CacheEngineVersion struct { // Generally speaking, the current generation types provide more memory and // computational power at lower cost when compared to their equivalent previous // generation counterparts. +// - General purpose: +// - Current generation: M6g node types (available only for Redis engine version +// 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large +// , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge +// , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see +// Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) +// M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , +// cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: +// cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , +// cache.m4.10xlarge T4g node types (available only for Redis engine version +// 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , +// cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , +// cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , +// cache.t2.small , cache.t2.medium +// - Previous generation: (not recommended. Existing clusters are still +// supported but creation of new clusters is not supported for these types.) T1 +// node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , +// cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , +// cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge +// - Compute optimized: +// - Previous generation: (not recommended. Existing clusters are still +// supported but creation of new clusters is not supported for these types.) C1 +// node types: cache.c1.xlarge +// - Memory optimized: +// - Current generation: R6g node types (available only for Redis engine version +// 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large +// , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge +// , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see +// Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) +// R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , +// cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: +// cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , +// cache.r4.8xlarge , cache.r4.16xlarge +// - Previous generation: (not recommended. Existing clusters are still +// supported but creation of new clusters is not supported for these types.) M2 +// node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node +// types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , // -// * General purpose: -// -// * Current generation: M6g node -// types (available only for Redis engine version 5.0.6 onward and for Memcached -// engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, -// cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, -// cache.m6g.16xlarge For region availability, see Supported Node Types -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, -// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: -// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, -// cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 -// onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, -// cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, -// cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, -// cache.t2.medium -// -// * Previous generation: (not recommended. Existing clusters are -// still supported but creation of new clusters is not supported for these types.) -// T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, -// cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, -// cache.m3.xlarge, cache.m3.2xlarge -// -// * Compute optimized: -// -// * Previous generation: -// (not recommended. Existing clusters are still supported but creation of new -// clusters is not supported for these types.) C1 node types: cache.c1.xlarge -// -// * -// Memory optimized: -// -// * Current generation: R6g node types (available only for -// Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 -// onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, -// cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For -// region availability, see Supported Node Types -// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, -// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: -// cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, -// cache.r4.8xlarge, cache.r4.16xlarge -// -// * Previous generation: (not recommended. -// Existing clusters are still supported but creation of new clusters is not -// supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, -// cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, -// cache.r3.2xlarge, -// -// cache.r3.4xlarge, cache.r3.8xlarge -// -// Additional node type -// info -// -// * All current generation instance types are created in Amazon VPC by -// default. -// -// * Redis append-only files (AOF) are not supported for T1 or T2 -// instances. -// -// * Redis Multi-AZ with automatic failover is not supported on T1 -// instances. -// -// * Redis configuration variables appendonly and appendfsync are not -// supported on Redis version 2.8.22 and later. +// cache.r3.4xlarge , cache.r3.8xlarge +// Additional node type info +// - All current generation instance types are created in Amazon VPC by default. +// - Redis append-only files (AOF) are not supported for T1 or T2 instances. +// - Redis Multi-AZ with automatic failover is not supported on T1 instances. +// - Redis configuration variables appendonly and appendfsync are not supported +// on Redis version 2.8.22 and later. type CacheNode struct { // The date and time when the cache node was created. CacheNodeCreateTime *time.Time - // The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). - // The combination of cluster ID and node ID uniquely identifies every cache node - // used in a customer's Amazon account. + // The cache node identifier. A node ID is a numeric identifier (0001, 0002, + // etc.). The combination of cluster ID and node ID uniquely identifies every cache + // node used in a customer's Amazon account. CacheNodeId *string - // The current state of this cache node, one of the following values: available, - // creating, rebooting, or deleting. + // The current state of this cache node, one of the following values: available , + // creating , rebooting , or deleting . CacheNodeStatus *string // The Availability Zone where this node was created and now resides. @@ -398,8 +347,8 @@ type CacheNode struct { } // A parameter that has a different value for each cache node type it is applied -// to. For example, in a Redis cluster, a cache.m1.large cache node type would have -// a larger maxmemory value than a cache.m1.small type. +// to. For example, in a Redis cluster, a cache.m1.large cache node type would +// have a larger maxmemory value than a cache.m1.small type. type CacheNodeTypeSpecificParameter struct { // The valid range of values for the parameter. @@ -408,10 +357,10 @@ type CacheNodeTypeSpecificParameter struct { // A list of cache node types and their corresponding values for this parameter. CacheNodeTypeSpecificValues []CacheNodeTypeSpecificValue - // Indicates whether a change to the parameter is applied immediately or requires a - // reboot for the change to be applied. You can force a reboot or wait until the - // next maintenance window's reboot. For more information, see Rebooting a Cluster - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html). + // Indicates whether a change to the parameter is applied immediately or requires + // a reboot for the change to be applied. You can force a reboot or wait until the + // next maintenance window's reboot. For more information, see Rebooting a Cluster (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html) + // . ChangeType ChangeType // The valid data type for the parameter. @@ -420,7 +369,7 @@ type CacheNodeTypeSpecificParameter struct { // A description of the parameter. Description *string - // Indicates whether (true) or not (false) the parameter can be modified. Some + // Indicates whether ( true ) or not ( false ) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable bool @@ -520,14 +469,9 @@ type CacheParameterGroupStatus struct { } // Represents the output of one of the following operations: -// -// * -// AuthorizeCacheSecurityGroupIngress -// -// * CreateCacheSecurityGroup -// -// * -// RevokeCacheSecurityGroupIngress +// - AuthorizeCacheSecurityGroupIngress +// - CreateCacheSecurityGroup +// - RevokeCacheSecurityGroupIngress type CacheSecurityGroup struct { // The ARN of the cache security group, @@ -564,11 +508,8 @@ type CacheSecurityGroupMembership struct { } // Represents the output of one of the following operations: -// -// * -// CreateCacheSubnetGroup -// -// * ModifyCacheSubnetGroup +// - CreateCacheSubnetGroup +// - ModifyCacheSubnetGroup type CacheSubnetGroup struct { // The ARN (Amazon Resource Name) of the cache subnet group. @@ -583,9 +524,9 @@ type CacheSubnetGroup struct { // A list of subnets associated with the cache subnet group. Subnets []Subnet - // Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis + // Either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Redis // engine version 6.2 onward or Memcached engine version 1.6.6 on all instances - // built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . SupportedNetworkTypes []NetworkType // The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. @@ -608,28 +549,23 @@ type CloudWatchLogsDestinationDetails struct { // NewReplicaCount, and PreferredAvailabilityZones. type ConfigureShard struct { - // The number of replicas you want in this node group at the end of this operation. - // The maximum value for NewReplicaCount is 5. The minimum value depends upon the - // type of Redis replication group you are working with. The minimum number of - // replicas in a shard or replication group is: - // - // * Redis (cluster mode disabled) - // - // * - // If Multi-AZ: 1 - // - // * If Multi-AZ: 0 - // - // * Redis (cluster mode enabled): 0 (though you - // will not be able to failover to a replica if your primary node fails) + // The number of replicas you want in this node group at the end of this + // operation. The maximum value for NewReplicaCount is 5. The minimum value + // depends upon the type of Redis replication group you are working with. The + // minimum number of replicas in a shard or replication group is: + // - Redis (cluster mode disabled) + // - If Multi-AZ: 1 + // - If Multi-AZ: 0 + // - Redis (cluster mode enabled): 0 (though you will not be able to failover to + // a replica if your primary node fails) // // This member is required. NewReplicaCount int32 // The 4-digit id for the node group you are configuring. For Redis (cluster mode // disabled) replication groups, the node group id is always 0001. To find a Redis - // (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html). + // (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html) + // . // // This member is required. NodeGroupId *string @@ -710,8 +646,8 @@ type EngineDefaults struct { // Specifies the name of the cache parameter group family to which the engine // default parameters apply. Valid values are: memcached1.4 | memcached1.5 | - // memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | - // redis6.x + // memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 + // | redis6.x CacheParameterGroupFamily *string // Provides an identifier to allow retrieval of paginated results. @@ -777,20 +713,19 @@ type GlobalNodeGroup struct { // cluster that resides in a different Amazon region. The secondary cluster accepts // only reads. The primary cluster automatically replicates updates to the // secondary cluster. -// -// * The GlobalReplicationGroupIdSuffix represents the name of -// the Global datastore, which is what you use to associate a secondary cluster. +// - The GlobalReplicationGroupIdSuffix represents the name of the Global +// datastore, which is what you use to associate a secondary cluster. type GlobalReplicationGroup struct { // The ARN (Amazon Resource Name) of the global replication group. ARN *string - // A flag that enables encryption at rest when set to true. You cannot modify the + // A flag that enables encryption at rest when set to true . You cannot modify the // value of AtRestEncryptionEnabled after the replication group is created. To // enable encryption at rest on a replication group you must set - // AtRestEncryptionEnabled to true when you create the replication group. Required: - // Only available when creating a replication group in an Amazon VPC using redis - // version 3.2.6, 4.x or later. + // AtRestEncryptionEnabled to true when you create the replication group. + // Required: Only available when creating a replication group in an Amazon VPC + // using redis version 3.2.6 , 4.x or later. AtRestEncryptionEnabled *bool // A flag that enables using an AuthToken (password) when issuing Redis commands. @@ -826,7 +761,7 @@ type GlobalReplicationGroup struct { // A flag that enables in-transit encryption when set to true. Required: Only // available when creating a replication group in an Amazon VPC using redis version - // 3.2.6, 4.x or later. + // 3.2.6 , 4.x or later. TransitEncryptionEnabled *bool noSmithyDocumentSerde @@ -846,8 +781,8 @@ type GlobalReplicationGroupInfo struct { noSmithyDocumentSerde } -// A member of a Global datastore. It contains the Replication Group Id, the Amazon -// region and the role of the replication group. +// A member of a Global datastore. It contains the Replication Group Id, the +// Amazon region and the role of the replication group. type GlobalReplicationGroupMember struct { // Indicates whether automatic failover is enabled for the replication group. @@ -884,7 +819,7 @@ type LogDeliveryConfiguration struct { // Firehose destination. DestinationDetails *DestinationDetails - // Returns the destination type, either cloudwatch-logs or kinesis-firehose. + // Returns the destination type, either cloudwatch-logs or kinesis-firehose . DestinationType DestinationType // Returns the log format, either JSON or TEXT. @@ -913,7 +848,7 @@ type LogDeliveryConfigurationRequest struct { // Specify either cloudwatch-logs or kinesis-firehose as the destination type. DestinationType DestinationType - // Specify if log delivery is enabled. Default true. + // Specify if log delivery is enabled. Default true . Enabled *bool // Specifies either JSON or TEXT @@ -950,16 +885,16 @@ type NodeGroup struct { // The keyspace for this node group (shard). Slots *string - // The current state of this replication group - creating, available, modifying, - // deleting. + // The current state of this replication group - creating , available , modifying , + // deleting . Status *string noSmithyDocumentSerde } // Node group (shard) configuration options. Each node group (shard) configuration -// has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, -// ReplicaCount. +// has the following: Slots , PrimaryAvailabilityZone , ReplicaAvailabilityZones , +// ReplicaCount . type NodeGroupConfiguration struct { // Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for @@ -985,7 +920,7 @@ type NodeGroupConfiguration struct { ReplicaOutpostArns []string // A string that specifies the keyspace for a particular node group. Keyspaces - // range from 0 to 16,383. The string is in the format startkey-endkey. Example: + // range from 0 to 16,383. The string is in the format startkey-endkey . Example: // "0-3999" Slots *string @@ -1002,7 +937,7 @@ type NodeGroupMember struct { // 0002, etc.). CacheNodeId *string - // The role that is currently assigned to the node - primary or replica. This + // The role that is currently assigned to the node - primary or replica . This // member is only applicable for Redis (cluster mode disabled) replication groups. CurrentRole *string @@ -1115,10 +1050,10 @@ type Parameter struct { // The valid range of values for the parameter. AllowedValues *string - // Indicates whether a change to the parameter is applied immediately or requires a - // reboot for the change to be applied. You can force a reboot or wait until the - // next maintenance window's reboot. For more information, see Rebooting a Cluster - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html). + // Indicates whether a change to the parameter is applied immediately or requires + // a reboot for the change to be applied. You can force a reboot or wait until the + // next maintenance window's reboot. For more information, see Rebooting a Cluster (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html) + // . ChangeType ChangeType // The valid data type for the parameter. @@ -1127,7 +1062,7 @@ type Parameter struct { // A description of the parameter. Description *string - // Indicates whether (true) or not (false) the parameter can be modified. Some + // Indicates whether ( true ) or not ( false ) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable bool @@ -1257,8 +1192,8 @@ type RegionalConfiguration struct { // This member is required. ReplicationGroupRegion *string - // A list of PreferredAvailabilityZones objects that specifies the configuration of - // a node group in the resharded cluster. + // A list of PreferredAvailabilityZones objects that specifies the configuration + // of a node group in the resharded cluster. // // This member is required. ReshardingConfiguration []ReshardingConfiguration @@ -1272,11 +1207,11 @@ type ReplicationGroup struct { // The ARN (Amazon Resource Name) of the replication group. ARN *string - // A flag that enables encryption at-rest when set to true. You cannot modify the + // A flag that enables encryption at-rest when set to true . You cannot modify the // value of AtRestEncryptionEnabled after the cluster is created. To enable // encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true // when you create a cluster. Required: Only available when creating a replication - // group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false + // group in an Amazon VPC using redis version 3.2.6 , 4.x or later. Default: false AtRestEncryptionEnabled *bool // A flag that enables using an AuthToken (password) when issuing Redis commands. @@ -1286,8 +1221,8 @@ type ReplicationGroup struct { // The date the auth token was last modified AuthTokenLastModifiedDate *time.Time - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade bool @@ -1309,8 +1244,8 @@ type ReplicationGroup struct { // Enables data tiering. Data tiering is only supported for replication groups // using the r6gd node type. This parameter must be set to true when using r6gd - // nodes. For more information, see Data tiering - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html). + // nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html) + // . DataTiering DataTieringStatus // The user supplied description of the replication group. @@ -1320,10 +1255,10 @@ type ReplicationGroup struct { // Global datastore. GlobalReplicationGroupInfo *GlobalReplicationGroupInfo - // The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 + // The network type you choose when modifying a cluster, either ipv4 | ipv6 . IPv6 // is supported for workloads using Redis engine version 6.2 onward or Memcached - // engine version 1.6.6 on all instances built on the Nitro system - // (https://aws.amazon.com/ec2/nitro/). + // engine version 1.6.6 on all instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) + // . IpDiscovery IpDiscovery // The ID of the KMS key used to encrypt the disk in the cluster. @@ -1339,13 +1274,12 @@ type ReplicationGroup struct { MemberClustersOutpostArns []string // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For - // more information, see Minimizing Downtime: Multi-AZ - // (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) + // more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) MultiAZ MultiAZStatus - // Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using + // Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // instances built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . NetworkType NetworkType // A list of node groups in this replication group. For Redis (cluster mode @@ -1373,20 +1307,20 @@ type ReplicationGroup struct { // The daily time range (in UTC) during which ElastiCache begins taking a daily // snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify // this parameter, ElastiCache automatically chooses an appropriate time range. - // This parameter is only valid if the Engine parameter is redis. + // This parameter is only valid if the Engine parameter is redis . SnapshotWindow *string // The cluster ID that is used as the daily snapshot source for the replication // group. SnapshottingClusterId *string - // The current state of this replication group - creating, available, modifying, - // deleting, create-failed, snapshotting. + // The current state of this replication group - creating , available , modifying , + // deleting , create-failed , snapshotting . Status *string - // A flag that enables in-transit encryption when set to true. Required: Only + // A flag that enables in-transit encryption when set to true . Required: Only // available when creating a replication group in an Amazon VPC using redis version - // 3.2.6, 4.x or later. Default: false + // 3.2.6 , 4.x or later. Default: false TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, @@ -1399,8 +1333,8 @@ type ReplicationGroup struct { noSmithyDocumentSerde } -// The settings to be applied to the Redis replication group, either immediately or -// during the next maintenance window. +// The settings to be applied to the Redis replication group, either immediately +// or during the next maintenance window. type ReplicationGroupPendingModifiedValues struct { // The auth token status @@ -1442,73 +1376,51 @@ type ReservedCacheNode struct { // supported by ElastiCache. Generally speaking, the current generation types // provide more memory and computational power at lower cost when compared to their // equivalent previous generation counterparts. - // - // * General purpose: - // - // * Current - // generation: M6g node types (available only for Redis engine version 5.0.6 onward - // and for Memcached engine version 1.5.16 onward): cache.m6g.large, - // cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, - // cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported - // Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , + // + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // The duration of the reservation in seconds. @@ -1555,73 +1467,51 @@ type ReservedCacheNodesOffering struct { // supported by ElastiCache. Generally speaking, the current generation types // provide more memory and computational power at lower cost when compared to their // equivalent previous generation counterparts. - // - // * General purpose: - // - // * Current - // generation: M6g node types (available only for Redis engine version 5.0.6 onward - // and for Memcached engine version 1.5.16 onward): cache.m6g.large, - // cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, - // cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported - // Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , + // + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // The duration of the offering. in seconds. @@ -1648,8 +1538,8 @@ type ReservedCacheNodesOffering struct { noSmithyDocumentSerde } -// A list of PreferredAvailabilityZones objects that specifies the configuration of -// a node group in the resharded cluster. +// A list of PreferredAvailabilityZones objects that specifies the configuration +// of a node group in the resharded cluster. type ReshardingConfiguration struct { // Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for @@ -1677,9 +1567,9 @@ type SecurityGroupMembership struct { // The identifier of the cache security group. SecurityGroupId *string - // The status of the cache security group membership. The status changes whenever a - // cache security group is modified, or when the cache security groups assigned to - // a cluster are modified. + // The status of the cache security group membership. The status changes whenever + // a cache security group is modified, or when the cache security groups assigned + // to a cluster are modified. Status *string noSmithyDocumentSerde @@ -1711,9 +1601,10 @@ type ServiceUpdate struct { // The unique ID of the service update ServiceUpdateName *string - // The recommendend date to apply the service update in order to ensure compliance. - // For information on compliance, see Self-Service Security Updates for Compliance - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service). + // The recommendend date to apply the service update in order to ensure + // compliance. For information on compliance, see Self-Service Security Updates + // for Compliance (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service) + // . ServiceUpdateRecommendedApplyByDate *time.Time // The date when the service update is initially available @@ -1747,8 +1638,8 @@ type Snapshot struct { // The ARN (Amazon Resource Name) of the snapshot. ARN *string - // If you are running Redis engine version 6.0 or later, set this parameter to yes - // if you want to opt-in to the next auto minor version upgrade campaign. This + // If you are running Redis engine version 6.0 or later, set this parameter to + // yes if you want to opt-in to the next auto minor version upgrade campaign. This // parameter is disabled for previous versions. AutoMinorVersionUpgrade bool @@ -1766,73 +1657,51 @@ type Snapshot struct { // The following node types are supported by ElastiCache. Generally speaking, the // current generation types provide more memory and computational power at lower // cost when compared to their equivalent previous generation counterparts. - // - // * - // General purpose: - // - // * Current generation: M6g node types (available only for Redis - // engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): - // cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, - // cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region - // availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, - // cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: - // cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, - // cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 - // onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, - // cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, - // cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, - // cache.t2.medium - // - // * Previous generation: (not recommended. Existing clusters are - // still supported but creation of new clusters is not supported for these types.) - // T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, - // cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, - // cache.m3.xlarge, cache.m3.2xlarge - // - // * Compute optimized: - // - // * Previous generation: - // (not recommended. Existing clusters are still supported but creation of new - // clusters is not supported for these types.) C1 node types: cache.c1.xlarge - // - // * - // Memory optimized: - // - // * Current generation: R6g node types (available only for - // Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 - // onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, - // cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For - // region availability, see Supported Node Types - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, - // cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: - // cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, - // cache.r4.8xlarge, cache.r4.16xlarge - // - // * Previous generation: (not recommended. - // Existing clusters are still supported but creation of new clusters is not - // supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, - // cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, - // cache.r3.2xlarge, - // - // cache.r3.4xlarge, cache.r3.8xlarge - // - // Additional node type - // info - // - // * All current generation instance types are created in Amazon VPC by - // default. - // - // * Redis append-only files (AOF) are not supported for T1 or T2 - // instances. - // - // * Redis Multi-AZ with automatic failover is not supported on T1 - // instances. - // - // * Redis configuration variables appendonly and appendfsync are not - // supported on Redis version 2.8.22 and later. + // - General purpose: + // - Current generation: M6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large + // , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge + // , cache.m6g.12xlarge , cache.m6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , + // cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: + // cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , + // cache.m4.10xlarge T4g node types (available only for Redis engine version + // 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , + // cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , + // cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , + // cache.t2.small , cache.t2.medium + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) T1 + // node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , + // cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , + // cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge + // - Compute optimized: + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) C1 + // node types: cache.c1.xlarge + // - Memory optimized: + // - Current generation: R6g node types (available only for Redis engine version + // 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large + // , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge + // , cache.r6g.12xlarge , cache.r6g.16xlarge For region availability, see + // Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) + // R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , + // cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: + // cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , + // cache.r4.8xlarge , cache.r4.16xlarge + // - Previous generation: (not recommended. Existing clusters are still + // supported but creation of new clusters is not supported for these types.) M2 + // node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node + // types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , + // + // cache.r3.4xlarge , cache.r3.8xlarge + // Additional node type info + // - All current generation instance types are created in Amazon VPC by default. + // - Redis append-only files (AOF) are not supported for T1 or T2 instances. + // - Redis Multi-AZ with automatic failover is not supported on T1 instances. + // - Redis configuration variables appendonly and appendfsync are not supported + // on Redis version 2.8.22 and later. CacheNodeType *string // The cache parameter group that is associated with the source cluster. @@ -1843,11 +1712,11 @@ type Snapshot struct { // Enables data tiering. Data tiering is only supported for replication groups // using the r6gd node type. This parameter must be set to true when using r6gd - // nodes. For more information, see Data tiering - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html). + // nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html) + // . DataTiering DataTieringStatus - // The name of the cache engine (memcached or redis) used by the source cluster. + // The name of the cache engine ( memcached or redis ) used by the source cluster. Engine *string // The version of the cache engine version that is used by the source cluster. @@ -1879,23 +1748,14 @@ type Snapshot struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 PreferredMaintenanceWindow *string // The ARN (Amazon Resource Name) of the preferred outpost. @@ -1907,8 +1767,8 @@ type Snapshot struct { // The unique identifier of the source replication group. ReplicationGroupId *string - // The name of a snapshot. For an automatic snapshot, the name is system-generated. - // For a manual snapshot, this is the user-provided name. + // The name of a snapshot. For an automatic snapshot, the name is + // system-generated. For a manual snapshot, this is the user-provided name. SnapshotName *string // For an automatic snapshot, the number of days for which ElastiCache retains the @@ -1919,12 +1779,12 @@ type Snapshot struct { // SnapshotRetentionLimit is set to zero (0), backups are turned off. SnapshotRetentionLimit *int32 - // Indicates whether the snapshot is from an automatic backup (automated) or was - // created manually (manual). + // Indicates whether the snapshot is from an automatic backup ( automated ) or was + // created manually ( manual ). SnapshotSource *string // The status of the snapshot. Valid values: creating | available | restoring | - // copying | deleting. + // copying | deleting . SnapshotStatus *string // The daily time range during which ElastiCache takes daily snapshots of the @@ -1956,9 +1816,9 @@ type Subnet struct { // The outpost ARN of the subnet. SubnetOutpost *SubnetOutpost - // Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis + // Either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Redis // engine version 6.2 onward or Memcached engine version 1.6.6 on all instances - // built on the Nitro system (https://aws.amazon.com/ec2/nitro/). + // built on the Nitro system (https://aws.amazon.com/ec2/nitro/) . SupportedNetworkTypes []NetworkType noSmithyDocumentSerde @@ -1973,11 +1833,11 @@ type SubnetOutpost struct { noSmithyDocumentSerde } -// A tag that can be added to an ElastiCache cluster or replication group. Tags are -// composed of a Key/Value pair. You can use tags to categorize and track all your -// ElastiCache resources, with the exception of global replication group. When you -// add or remove tags on replication groups, those actions will be replicated to -// all nodes in the replication group. A tag with a null Value is permitted. +// A tag that can be added to an ElastiCache cluster or replication group. Tags +// are composed of a Key/Value pair. You can use tags to categorize and track all +// your ElastiCache resources, with the exception of global replication group. When +// you add or remove tags on replication groups, those actions will be replicated +// to all nodes in the replication group. A tag with a null Value is permitted. type Tag struct { // The key for the tag. May not be null. @@ -2052,8 +1912,8 @@ type UpdateAction struct { ServiceUpdateName *string // The recommended date to apply the service update to ensure compliance. For - // information on compliance, see Self-Service Security Updates for Compliance - // (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service). + // information on compliance, see Self-Service Security Updates for Compliance (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/elasticache-compliance.html#elasticache-compliance-self-service) + // . ServiceUpdateRecommendedApplyByDate *time.Time // The date the update is first available diff --git a/service/elasticbeanstalk/api_client.go b/service/elasticbeanstalk/api_client.go index 83f99114718..f10a744ad74 100644 --- a/service/elasticbeanstalk/api_client.go +++ b/service/elasticbeanstalk/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go index a83ba1ca90f..235d4f2b8eb 100644 --- a/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go +++ b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go @@ -12,8 +12,8 @@ import ( ) // Applies a scheduled managed action immediately. A managed action can be applied -// only if its status is Scheduled. Get the status and action ID of a managed -// action with DescribeEnvironmentManagedActions. +// only if its status is Scheduled . Get the status and action ID of a managed +// action with DescribeEnvironmentManagedActions . func (c *Client) ApplyEnvironmentManagedAction(ctx context.Context, params *ApplyEnvironmentManagedActionInput, optFns ...func(*Options)) (*ApplyEnvironmentManagedActionOutput, error) { if params == nil { params = &ApplyEnvironmentManagedActionInput{} diff --git a/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go b/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go index e64fcb15dff..5801c4cd993 100644 --- a/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go +++ b/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go @@ -13,8 +13,7 @@ import ( // Add or change the operations role used by an environment. After this call is // made, Elastic Beanstalk uses the associated operations role for permissions to // downstream services during subsequent calls acting on this environment. For more -// information, see Operations roles -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) +// information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. func (c *Client) AssociateEnvironmentOperationsRole(ctx context.Context, params *AssociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*AssociateEnvironmentOperationsRoleOutput, error) { if params == nil { diff --git a/service/elasticbeanstalk/api_op_CheckDNSAvailability.go b/service/elasticbeanstalk/api_op_CheckDNSAvailability.go index 05058470d53..eb289c260d7 100644 --- a/service/elasticbeanstalk/api_op_CheckDNSAvailability.go +++ b/service/elasticbeanstalk/api_op_CheckDNSAvailability.go @@ -41,11 +41,8 @@ type CheckDNSAvailabilityInput struct { type CheckDNSAvailabilityOutput struct { // Indicates if the specified CNAME is available: - // - // * true : The CNAME is - // available. - // - // * false : The CNAME is not available. + // - true : The CNAME is available. + // - false : The CNAME is not available. Available *bool // The fully qualified CNAME to reserve when CreateEnvironment is called with the diff --git a/service/elasticbeanstalk/api_op_ComposeEnvironments.go b/service/elasticbeanstalk/api_op_ComposeEnvironments.go index aa264da71be..4eb4b2bc250 100644 --- a/service/elasticbeanstalk/api_op_ComposeEnvironments.go +++ b/service/elasticbeanstalk/api_op_ComposeEnvironments.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create or update a group of environments that each run a separate component of a -// single application. Takes a list of version labels that specify application +// Create or update a group of environments that each run a separate component of +// a single application. Takes a list of version labels that specify application // source bundles for each of the environments to create or update. The name of // each environment and other required information must be included in the source -// bundles in an environment manifest named env.yaml. See Compose Environments -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html) +// bundles in an environment manifest named env.yaml . See Compose Environments (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html) // for details. func (c *Client) ComposeEnvironments(ctx context.Context, params *ComposeEnvironmentsInput, optFns ...func(*Options)) (*ComposeEnvironmentsOutput, error) { if params == nil { @@ -41,15 +40,15 @@ type ComposeEnvironmentsInput struct { // The name of the group to which the target environments belong. Specify a group // name only if the environment name defined in each target environment's manifest - // ends with a + (plus) character. See Environment Manifest (env.yaml) - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) + // ends with a + (plus) character. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) // for details. GroupName *string - // A list of version labels, specifying one or more application source bundles that - // belong to the target application. Each source bundle must include an environment - // manifest that specifies the name of the environment and the name of the solution - // stack to use, and optionally can specify environment links to create. + // A list of version labels, specifying one or more application source bundles + // that belong to the target application. Each source bundle must include an + // environment manifest that specifies the name of the environment and the name of + // the solution stack to use, and optionally can specify environment links to + // create. VersionLabels []string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go index a5755f78c1c..3920084682f 100644 --- a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go @@ -14,8 +14,8 @@ import ( // Creates an application version for the specified application. You can create an // application version from a source bundle in Amazon S3, a commit in AWS // CodeCommit, or the output of an AWS CodeBuild build as follows: Specify a commit -// in an AWS CodeCommit repository with SourceBuildInformation. Specify a build in -// an AWS CodeBuild with SourceBuildInformation and BuildConfiguration. Specify a +// in an AWS CodeCommit repository with SourceBuildInformation . Specify a build in +// an AWS CodeBuild with SourceBuildInformation and BuildConfiguration . Specify a // source bundle in S3 with SourceBundle Omit both SourceBuildInformation and // SourceBundle to use the default sample application. After you create an // application version with a specified Amazon S3 bucket and key location, you @@ -40,13 +40,13 @@ func (c *Client) CreateApplicationVersion(ctx context.Context, params *CreateApp type CreateApplicationVersionInput struct { // The name of the application. If no application is found with this name, and - // AutoCreateApplication is false, returns an InvalidParameterValue error. + // AutoCreateApplication is false , returns an InvalidParameterValue error. // // This member is required. ApplicationName *string - // A label identifying this version. Constraint: Must be unique per application. If - // an application version already exists with this label for the specified + // A label identifying this version. Constraint: Must be unique per application. + // If an application version already exists with this label for the specified // application, AWS Elastic Beanstalk returns an InvalidParameterValue error. // // This member is required. @@ -62,14 +62,14 @@ type CreateApplicationVersionInput struct { // A description of this application version. Description *string - // Pre-processes and validates the environment manifest (env.yaml) and - // configuration files (*.config files in the .ebextensions folder) in the source + // Pre-processes and validates the environment manifest ( env.yaml ) and + // configuration files ( *.config files in the .ebextensions folder) in the source // bundle. Validating configuration files can identify issues prior to deploying // the application version to an environment. You must turn processing on for // application versions that you create using AWS CodeBuild or AWS CodeCommit. For // application versions built from a source bundle in Amazon S3, processing is - // optional. The Process option validates Elastic Beanstalk configuration files. It - // doesn't validate your application's configuration files, like proxy server or + // optional. The Process option validates Elastic Beanstalk configuration files. + // It doesn't validate your application's configuration files, like proxy server or // Docker configuration. Process *bool @@ -77,16 +77,16 @@ type CreateApplicationVersionInput struct { // for the application version. SourceBuildInformation *types.SourceBuildInformation - // The Amazon S3 bucket and key that identify the location of the source bundle for - // this version. The Amazon S3 bucket must be in the same region as the + // The Amazon S3 bucket and key that identify the location of the source bundle + // for this version. The Amazon S3 bucket must be in the same region as the // environment. Specify a source bundle in S3 or a commit in an AWS CodeCommit - // repository (with SourceBuildInformation), but not both. If neither SourceBundle + // repository (with SourceBuildInformation ), but not both. If neither SourceBundle // nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample // application. SourceBundle *types.S3Location - // Specifies the tags applied to the application version. Elastic Beanstalk applies - // these tags only to the application version. Environments that use the + // Specifies the tags applied to the application version. Elastic Beanstalk + // applies these tags only to the application version. Environments that use the // application version don't inherit the tags. Tags []types.Tag diff --git a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go index 0ff9d749a6a..302af79f984 100644 --- a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go @@ -17,15 +17,10 @@ import ( // settings in a configuration template. You can then use the configuration // template to deploy different versions of the application with the same // configuration settings. Templates aren't associated with any environment. The -// EnvironmentName response element is always null. Related Topics -// -// * -// DescribeConfigurationOptions -// -// * DescribeConfigurationSettings -// -// * -// ListAvailableSolutionStacks +// EnvironmentName response element is always null . Related Topics +// - DescribeConfigurationOptions +// - DescribeConfigurationSettings +// - ListAvailableSolutionStacks func (c *Client) CreateConfigurationTemplate(ctx context.Context, params *CreateConfigurationTemplateInput, optFns ...func(*Options)) (*CreateConfigurationTemplateOutput, error) { if params == nil { params = &CreateConfigurationTemplateInput{} @@ -50,8 +45,8 @@ type CreateConfigurationTemplateInput struct { // This member is required. ApplicationName *string - // The name of the configuration template. Constraint: This name must be unique per - // application. + // The name of the configuration template. Constraint: This name must be unique + // per application. // // This member is required. TemplateName *string @@ -61,44 +56,40 @@ type CreateConfigurationTemplateInput struct { // The ID of an environment whose settings you want to use to create the // configuration template. You must specify EnvironmentId if you don't specify - // PlatformArn, SolutionStackName, or SourceConfiguration. + // PlatformArn , SolutionStackName , or SourceConfiguration . EnvironmentId *string // Option values for the Elastic Beanstalk configuration, such as the instance // type. If specified, these values override the values obtained from the solution // stack or the source configuration template. For a complete list of Elastic - // Beanstalk configuration options, see Option Values - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in - // the AWS Elastic Beanstalk Developer Guide. + // Beanstalk configuration options, see Option Values (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) + // in the AWS Elastic Beanstalk Developer Guide. OptionSettings []types.ConfigurationOptionSetting - // The Amazon Resource Name (ARN) of the custom platform. For more information, see - // Custom Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) - // in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, then - // don't specify SolutionStackName. + // The Amazon Resource Name (ARN) of the custom platform. For more information, + // see Custom Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) + // in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn , then + // don't specify SolutionStackName . PlatformArn *string // The name of an Elastic Beanstalk solution stack (platform version) that this // configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 - // Java 7. A solution stack specifies the operating system, runtime, and + // Java 7 . A solution stack specifies the operating system, runtime, and // application server for a configuration template. It also determines the set of // configuration options as well as the possible and default values. For more - // information, see Supported Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) + // information, see Supported Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) // in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName - // if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the - // ListAvailableSolutionStacks - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html) + // if you don't specify PlatformArn , EnvironmentId , or SourceConfiguration . Use + // the ListAvailableSolutionStacks (https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html) // API to obtain a list of available solution stacks. SolutionStackName *string // An Elastic Beanstalk configuration template to base this one on. If specified, // Elastic Beanstalk uses the configuration values from the specified configuration // template to create a new configuration. Values specified in OptionSettings - // override any values obtained from the SourceConfiguration. You must specify - // SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or - // SolutionStackName. Constraint: If both solution stack name and source + // override any values obtained from the SourceConfiguration . You must specify + // SourceConfiguration if you don't specify PlatformArn , EnvironmentId , or + // SolutionStackName . Constraint: If both solution stack name and source // configuration are specified, the solution stack of the source configuration // template must match the specified solution stack name. SourceConfiguration *types.SourceConfiguration @@ -124,25 +115,18 @@ type CreateConfigurationTemplateOutput struct { // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration // set: - // - // * null: This configuration is not associated with a running - // environment. - // - // * pending: This is a draft configuration that is not deployed to - // the associated environment but is in the process of deploying. - // - // * deployed: This - // is the configuration that is currently deployed to the associated running - // environment. - // - // * failed: This is a draft configuration that failed to - // successfully deploy. + // - null : This configuration is not associated with a running environment. + // - pending : This is a draft configuration that is not deployed to the + // associated environment but is in the process of deploying. + // - deployed : This is the configuration that is currently deployed to the + // associated running environment. + // - failed : This is a draft configuration that failed to successfully deploy. DeploymentStatus types.ConfigurationDeploymentStatus // Describes this configuration set. Description *string - // If not null, the name of the environment for this configuration set. + // If not null , the name of the environment for this configuration set. EnvironmentName *string // A list of the configuration options and their values in this configuration set. @@ -154,7 +138,7 @@ type CreateConfigurationTemplateOutput struct { // The name of the solution stack this configuration set uses. SolutionStackName *string - // If not null, the name of the configuration template for this configuration set. + // If not null , the name of the configuration template for this configuration set. TemplateName *string // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_CreateEnvironment.go b/service/elasticbeanstalk/api_op_CreateEnvironment.go index 1376535b761..b276c308771 100644 --- a/service/elasticbeanstalk/api_op_CreateEnvironment.go +++ b/service/elasticbeanstalk/api_op_CreateEnvironment.go @@ -56,8 +56,7 @@ type CreateEnvironmentInput struct { // The name of the group to which the target environment belongs. Specify a group // name only if the environment's name is specified in an environment manifest and - // not with the environment name parameter. See Environment Manifest (env.yaml) - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) + // not with the environment name parameter. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) // for details. GroupName *string @@ -66,8 +65,7 @@ type CreateEnvironmentInput struct { // operations role for permissions to downstream services during this call and // during subsequent calls acting on this environment. To specify an operations // role, you must have the iam:PassRole permission for the role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string @@ -82,26 +80,24 @@ type CreateEnvironmentInput struct { OptionsToRemove []types.OptionSpecification // The Amazon Resource Name (ARN) of the custom platform to use with the - // environment. For more information, see Custom Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) - // in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn, don't - // specify SolutionStackName. + // environment. For more information, see Custom Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) + // in the AWS Elastic Beanstalk Developer Guide. If you specify PlatformArn , don't + // specify SolutionStackName . PlatformArn *string // The name of an Elastic Beanstalk solution stack (platform version) to use with // the environment. If specified, Elastic Beanstalk sets the configuration values // to the default values associated with the specified solution stack. For a list - // of current solution stacks, see Elastic Beanstalk Supported Platforms - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) - // in the AWS Elastic Beanstalk Platforms guide. If you specify SolutionStackName, - // don't specify PlatformArn or TemplateName. + // of current solution stacks, see Elastic Beanstalk Supported Platforms (https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) + // in the AWS Elastic Beanstalk Platforms guide. If you specify SolutionStackName , + // don't specify PlatformArn or TemplateName . SolutionStackName *string // Specifies the tags applied to resources in the environment. Tags []types.Tag // The name of the Elastic Beanstalk configuration template to use with the - // environment. If you specify TemplateName, then don't specify SolutionStackName. + // environment. If you specify TemplateName , then don't specify SolutionStackName . TemplateName *string // Specifies the tier to use in creating this environment. The environment tier @@ -159,33 +155,24 @@ type CreateEnvironmentOutput struct { // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: - // - // * Red: Indicates the environment - // is not responsive. Occurs when three or more consecutive failures occur for an - // environment. - // - // * Yellow: Indicates that something is wrong. Occurs when two - // consecutive failures occur for an environment. - // - // * Green: Indicates the - // environment is healthy and fully functional. - // - // * Grey: Default health for a new - // environment. The environment is not fully launched and health checks have not - // started or health checks are suspended during an UpdateEnvironment or - // RestartEnvironment request. - // + // - Red : Indicates the environment is not responsive. Occurs when three or more + // consecutive failures occur for an environment. + // - Yellow : Indicates that something is wrong. Occurs when two consecutive + // failures occur for an environment. + // - Green : Indicates the environment is healthy and fully functional. + // - Grey : Default health for a new environment. The environment is not fully + // launched and health checks have not started or health checks are suspended + // during an UpdateEnvironment or RestartEnvironment request. // Default: Grey Health types.EnvironmentHealth // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . HealthStatus types.EnvironmentHealthStatus // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string @@ -199,21 +186,13 @@ type CreateEnvironmentOutput struct { SolutionStackName *string // The current operational status of the environment: - // - // * Launching: Environment is - // in the process of initial deployment. - // - // * Updating: Environment is in the process - // of updating its configuration settings or application version. - // - // * Ready: - // Environment is available to have an action performed on it, such as update or - // terminate. - // - // * Terminating: Environment is in the shut-down process. - // - // * - // Terminated: Environment is not running. + // - Launching : Environment is in the process of initial deployment. + // - Updating : Environment is in the process of updating its configuration + // settings or application version. + // - Ready : Environment is available to have an action performed on it, such as + // update or terminate. + // - Terminating : Environment is in the shut-down process. + // - Terminated : Environment is not running. Status types.EnvironmentStatus // The name of the configuration template used to originally launch this diff --git a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go index 64bb0494f67..fd10d313057 100644 --- a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go @@ -40,9 +40,9 @@ type DeleteApplicationVersionInput struct { // This member is required. VersionLabel *string - // Set to true to delete the source bundle from your storage bucket. Otherwise, the - // application version is deleted only from Elastic Beanstalk and the source bundle - // remains in Amazon S3. + // Set to true to delete the source bundle from your storage bucket. Otherwise, + // the application version is deleted only from Elastic Beanstalk and the source + // bundle remains in Amazon S3. DeleteSourceBundle *bool noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go b/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go index e5dd6b03613..3808c82f8fc 100644 --- a/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go +++ b/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns attributes related to AWS Elastic Beanstalk that are associated with the -// calling AWS account. The result currently has one set of attributes—resource +// Returns attributes related to AWS Elastic Beanstalk that are associated with +// the calling AWS account. The result currently has one set of attributes—resource // quotas. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { diff --git a/service/elasticbeanstalk/api_op_DescribeApplications.go b/service/elasticbeanstalk/api_op_DescribeApplications.go index b52db570029..c2cc9383ec7 100644 --- a/service/elasticbeanstalk/api_op_DescribeApplications.go +++ b/service/elasticbeanstalk/api_op_DescribeApplications.go @@ -40,7 +40,7 @@ type DescribeApplicationsInput struct { // Result message containing a list of application descriptions. type DescribeApplicationsOutput struct { - // This parameter contains a list of ApplicationDescription. + // This parameter contains a list of ApplicationDescription . Applications []types.ApplicationDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go b/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go index 5e6b1a8c758..03a11fdb360 100644 --- a/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go +++ b/service/elasticbeanstalk/api_op_DescribeConfigurationOptions.go @@ -61,7 +61,7 @@ type DescribeConfigurationOptionsInput struct { // Describes the settings for a specified configuration set. type DescribeConfigurationOptionsOutput struct { - // A list of ConfigurationOptionDescription. + // A list of ConfigurationOptionDescription . Options []types.ConfigurationOptionDescription // The ARN of the platform version. diff --git a/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go b/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go index 6eb7e4074a6..048296ca2af 100644 --- a/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go +++ b/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go @@ -18,9 +18,7 @@ import ( // setting descriptions. One is the deployed configuration set, and the other is a // draft configuration of an environment that is either in the process of // deployment or that failed to deploy. Related Topics -// -// * -// DeleteEnvironmentConfiguration +// - DeleteEnvironmentConfiguration func (c *Client) DescribeConfigurationSettings(ctx context.Context, params *DescribeConfigurationSettingsInput, optFns ...func(*Options)) (*DescribeConfigurationSettingsOutput, error) { if params == nil { params = &DescribeConfigurationSettingsInput{} @@ -45,8 +43,8 @@ type DescribeConfigurationSettingsInput struct { // This member is required. ApplicationName *string - // The name of the environment to describe. Condition: You must specify either this - // or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk + // The name of the environment to describe. Condition: You must specify either + // this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk // returns an InvalidParameterCombination error. If you do not specify either, AWS // Elastic Beanstalk returns MissingRequiredParameter error. EnvironmentName *string @@ -65,7 +63,7 @@ type DescribeConfigurationSettingsInput struct { // environment. type DescribeConfigurationSettingsOutput struct { - // A list of ConfigurationSettingsDescription. + // A list of ConfigurationSettingsDescription . ConfigurationSettings []types.ConfigurationSettingsDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go index 43c6d78d1de..0a26b6fed07 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go @@ -33,8 +33,8 @@ func (c *Client) DescribeEnvironmentHealth(ctx context.Context, params *Describe // See the example below to learn how to create a request body. type DescribeEnvironmentHealthInput struct { - // Specify the response elements to return. To retrieve all attributes, set to All. - // If no attribute names are specified, returns the name of the environment. + // Specify the response elements to return. To retrieve all attributes, set to All + // . If no attribute names are specified, returns the name of the environment. AttributeNames []types.EnvironmentHealthAttribute // Specify the environment by ID. You must specify either this or an @@ -58,17 +58,15 @@ type DescribeEnvironmentHealthOutput struct { // status. Causes []string - // The health color - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // The health color (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) // of the environment. Color *string // The environment's name. EnvironmentName *string - // The health status - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) - // of the environment. For example, Ok. + // The health status (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // of the environment. For example, Ok . HealthStatus *string // Summary health information for the instances in the environment. @@ -77,8 +75,8 @@ type DescribeEnvironmentHealthOutput struct { // The date and time that the health information was retrieved. RefreshedAt *time.Time - // The environment's operational status. Ready, Launching, Updating, Terminating, - // or Terminated. + // The environment's operational status. Ready , Launching , Updating , Terminating + // , or Terminated . Status types.EnvironmentHealth // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go index 14e0526a242..bbf3e08b39b 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go @@ -122,16 +122,16 @@ func (c *Client) addOperationDescribeEnvironmentManagedActionHistoryMiddlewares( return nil } -// DescribeEnvironmentManagedActionHistoryAPIClient is a client that implements the -// DescribeEnvironmentManagedActionHistory operation. +// DescribeEnvironmentManagedActionHistoryAPIClient is a client that implements +// the DescribeEnvironmentManagedActionHistory operation. type DescribeEnvironmentManagedActionHistoryAPIClient interface { DescribeEnvironmentManagedActionHistory(context.Context, *DescribeEnvironmentManagedActionHistoryInput, ...func(*Options)) (*DescribeEnvironmentManagedActionHistoryOutput, error) } var _ DescribeEnvironmentManagedActionHistoryAPIClient = (*Client)(nil) -// DescribeEnvironmentManagedActionHistoryPaginatorOptions is the paginator options -// for DescribeEnvironmentManagedActionHistory +// DescribeEnvironmentManagedActionHistoryPaginatorOptions is the paginator +// options for DescribeEnvironmentManagedActionHistory type DescribeEnvironmentManagedActionHistoryPaginatorOptions struct { // The maximum number of items to return for a single request. Limit int32 diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go index 2f28513a544..320022bec15 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go @@ -46,7 +46,7 @@ type DescribeEnvironmentResourcesInput struct { // Result message containing a list of environment resource descriptions. type DescribeEnvironmentResourcesOutput struct { - // A list of EnvironmentResourceDescription. + // A list of EnvironmentResourceDescription . EnvironmentResources *types.EnvironmentResourceDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironments.go b/service/elasticbeanstalk/api_op_DescribeEnvironments.go index 16c7f542ed1..106d768089b 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironments.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironments.go @@ -47,13 +47,13 @@ type DescribeEnvironmentsInput struct { // include only those that have the specified names. EnvironmentNames []string - // Indicates whether to include deleted environments: true: Environments that have - // been deleted after IncludedDeletedBackTo are displayed. false: Do not include + // Indicates whether to include deleted environments: true : Environments that have + // been deleted after IncludedDeletedBackTo are displayed. false : Do not include // deleted environments. IncludeDeleted *bool - // If specified when IncludeDeleted is set to true, then environments deleted after - // this date are displayed. + // If specified when IncludeDeleted is set to true , then environments deleted + // after this date are displayed. IncludedDeletedBackTo *time.Time // For a paginated request. Specify a maximum number of environments to include in @@ -171,9 +171,9 @@ type EnvironmentExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EnvironmentExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EnvironmentExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -221,10 +221,10 @@ func (w *EnvironmentExistsWaiter) Wait(ctx context.Context, params *DescribeEnvi return err } -// WaitForOutput calls the waiter function for EnvironmentExists waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for EnvironmentExists waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *EnvironmentExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeEnvironmentsInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentExistsWaiterOptions)) (*DescribeEnvironmentsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -379,9 +379,10 @@ type EnvironmentTerminatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EnvironmentTerminatedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EnvironmentTerminatedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -586,8 +587,8 @@ type EnvironmentUpdatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EnvironmentUpdatedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EnvironmentUpdatedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/elasticbeanstalk/api_op_DescribeEvents.go b/service/elasticbeanstalk/api_op_DescribeEvents.go index 8d4aad28609..42e8834bd88 100644 --- a/service/elasticbeanstalk/api_op_DescribeEvents.go +++ b/service/elasticbeanstalk/api_op_DescribeEvents.go @@ -14,7 +14,7 @@ import ( ) // Returns list of event descriptions matching criteria up to the last 6 weeks. -// This action returns the most recent 1,000 events from the specified NextToken. +// This action returns the most recent 1,000 events from the specified NextToken . func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -37,16 +37,16 @@ type DescribeEventsInput struct { // include only those associated with this application. ApplicationName *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that occur up to, but not including, the EndTime. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those that occur up to, but not including, the EndTime . EndTime *time.Time - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // associated with this environment. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those associated with this environment. EnvironmentId *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // associated with this environment. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those associated with this environment. EnvironmentName *string // Specifies the maximum number of events that can be returned, beginning with the @@ -69,16 +69,16 @@ type DescribeEventsInput struct { // with the specified severity or higher. Severity types.EventSeverity - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that occur on or after this time. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those that occur on or after this time. StartTime *time.Time - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // that are associated with this environment configuration. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those that are associated with this environment configuration. TemplateName *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to those - // associated with this application version. + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // those associated with this application version. VersionLabel *string noSmithyDocumentSerde @@ -87,7 +87,7 @@ type DescribeEventsInput struct { // Result message wrapping a list of event descriptions. type DescribeEventsOutput struct { - // A list of EventDescription. + // A list of EventDescription . Events []types.EventDescription // If returned, this indicates that there are more results to obtain. Use this diff --git a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go index bc3d4a21647..a7eb7eb82b7 100644 --- a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go @@ -12,9 +12,9 @@ import ( "time" ) -// Retrieves detailed information about the health of instances in your AWS Elastic -// Beanstalk. This operation requires enhanced health reporting -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html). +// Retrieves detailed information about the health of instances in your AWS +// Elastic Beanstalk. This operation requires enhanced health reporting (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html) +// . func (c *Client) DescribeInstancesHealth(ctx context.Context, params *DescribeInstancesHealthInput, optFns ...func(*Options)) (*DescribeInstancesHealthOutput, error) { if params == nil { params = &DescribeInstancesHealthInput{} @@ -30,11 +30,12 @@ func (c *Client) DescribeInstancesHealth(ctx context.Context, params *DescribeIn return out, nil } -// Parameters for a call to DescribeInstancesHealth. +// Parameters for a call to DescribeInstancesHealth . type DescribeInstancesHealthInput struct { - // Specifies the response elements you wish to receive. To retrieve all attributes, - // set to All. If no attribute names are specified, returns a list of instances. + // Specifies the response elements you wish to receive. To retrieve all + // attributes, set to All . If no attribute names are specified, returns a list of + // instances. AttributeNames []types.InstancesHealthAttribute // Specify the AWS Elastic Beanstalk environment by ID. @@ -55,7 +56,7 @@ type DescribeInstancesHealthOutput struct { // Detailed health information about each instance. The output differs slightly // between Linux and Windows environments. There is a difference in the members - // that are supported under the type. + // that are supported under the type. InstanceHealthList []types.SingleInstanceHealth // Pagination token for the next page of results, if available. diff --git a/service/elasticbeanstalk/api_op_DescribePlatformVersion.go b/service/elasticbeanstalk/api_op_DescribePlatformVersion.go index d648ae29955..4367189ca54 100644 --- a/service/elasticbeanstalk/api_op_DescribePlatformVersion.go +++ b/service/elasticbeanstalk/api_op_DescribePlatformVersion.go @@ -12,10 +12,10 @@ import ( ) // Describes a platform version. Provides full details. Compare to -// ListPlatformVersions, which provides summary information about a list of +// ListPlatformVersions , which provides summary information about a list of // platform versions. For definitions of platform version and other -// platform-related terms, see AWS Elastic Beanstalk Platforms Glossary -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html). +// platform-related terms, see AWS Elastic Beanstalk Platforms Glossary (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html) +// . func (c *Client) DescribePlatformVersion(ctx context.Context, params *DescribePlatformVersionInput, optFns ...func(*Options)) (*DescribePlatformVersionOutput, error) { if params == nil { params = &DescribePlatformVersionInput{} diff --git a/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go b/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go index 10007392c01..f07698b0e86 100644 --- a/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go +++ b/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go @@ -13,8 +13,7 @@ import ( // Disassociate the operations role from an environment. After this call is made, // Elastic Beanstalk uses the caller's permissions for permissions to downstream // services during subsequent calls acting on this environment. For more -// information, see Operations roles -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) +// information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. func (c *Client) DisassociateEnvironmentOperationsRole(ctx context.Context, params *DisassociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*DisassociateEnvironmentOperationsRoleOutput, error) { if params == nil { diff --git a/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go b/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go index e8da058c447..776013b5bcc 100644 --- a/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go +++ b/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go @@ -35,7 +35,7 @@ type ListAvailableSolutionStacksInput struct { // A list of available AWS Elastic Beanstalk solution stacks. type ListAvailableSolutionStacksOutput struct { - // A list of available solution stacks and their SolutionStackDescription. + // A list of available solution stacks and their SolutionStackDescription . SolutionStackDetails []types.SolutionStackDescription // A list of available solution stacks. diff --git a/service/elasticbeanstalk/api_op_ListPlatformBranches.go b/service/elasticbeanstalk/api_op_ListPlatformBranches.go index c12d15bc58a..a5d9c57f42b 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformBranches.go +++ b/service/elasticbeanstalk/api_op_ListPlatformBranches.go @@ -15,8 +15,8 @@ import ( // Lists the platform branches available for your account in an AWS Region. // Provides summary information about each platform branch. For definitions of // platform branch and other platform-related terms, see AWS Elastic Beanstalk -// Platforms Glossary -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html). +// Platforms Glossary (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html) +// . func (c *Client) ListPlatformBranches(ctx context.Context, params *ListPlatformBranchesInput, optFns ...func(*Options)) (*ListPlatformBranchesOutput, error) { if params == nil { params = &ListPlatformBranchesInput{} @@ -35,38 +35,22 @@ func (c *Client) ListPlatformBranches(ctx context.Context, params *ListPlatformB type ListPlatformBranchesInput struct { // Criteria for restricting the resulting list of platform branches. The filter is - // evaluated as a logical conjunction (AND) of the separate SearchFilter terms. The - // following list shows valid attribute values for each of the SearchFilter terms. - // Most operators take a single value. The in and not_in operators can take + // evaluated as a logical conjunction (AND) of the separate SearchFilter terms. + // The following list shows valid attribute values for each of the SearchFilter + // terms. Most operators take a single value. The in and not_in operators can take // multiple values. - // - // * Attribute = BranchName: - // - // * Operator: = | != | begins_with | - // ends_with | contains | in | not_in - // - // * Attribute = LifecycleState: - // - // * Operator: = - // | != | in | not_in - // - // * Values: beta | supported | deprecated | retired - // - // * - // Attribute = PlatformName: - // - // * Operator: = | != | begins_with | ends_with | - // contains | in | not_in - // - // * Attribute = TierType: - // - // * Operator: = | != - // - // * Values: - // WebServer/Standard | Worker/SQS/HTTP - // - // Array size: limited to 10 SearchFilter - // objects. Within each SearchFilter item, the Values array is limited to 10 items. + // - Attribute = BranchName : + // - Operator : = | != | begins_with | ends_with | contains | in | not_in + // - Attribute = LifecycleState : + // - Operator : = | != | in | not_in + // - Values : beta | supported | deprecated | retired + // - Attribute = PlatformName : + // - Operator : = | != | begins_with | ends_with | contains | in | not_in + // - Attribute = TierType : + // - Operator : = | != + // - Values : WebServer/Standard | Worker/SQS/HTTP + // Array size: limited to 10 SearchFilter objects. Within each SearchFilter item, + // the Values array is limited to 10 items. Filters []types.SearchFilter // The maximum number of platform branch values returned in one call. @@ -83,7 +67,7 @@ type ListPlatformBranchesInput struct { type ListPlatformBranchesOutput struct { - // In a paginated request, if this value isn't null, it's the token that you can + // In a paginated request, if this value isn't null , it's the token that you can // pass in a subsequent request to get the next response page. NextToken *string diff --git a/service/elasticbeanstalk/api_op_ListPlatformVersions.go b/service/elasticbeanstalk/api_op_ListPlatformVersions.go index ac72c9609dd..eece14016e7 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformVersions.go +++ b/service/elasticbeanstalk/api_op_ListPlatformVersions.go @@ -14,10 +14,10 @@ import ( // Lists the platform versions available for your account in an AWS Region. // Provides summary information about each platform version. Compare to -// DescribePlatformVersion, which provides full details about a single platform +// DescribePlatformVersion , which provides full details about a single platform // version. For definitions of platform version and other platform-related terms, -// see AWS Elastic Beanstalk Platforms Glossary -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html). +// see AWS Elastic Beanstalk Platforms Glossary (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html) +// . func (c *Client) ListPlatformVersions(ctx context.Context, params *ListPlatformVersionsInput, optFns ...func(*Options)) (*ListPlatformVersionsOutput, error) { if params == nil { params = &ListPlatformVersionsInput{} @@ -53,7 +53,7 @@ type ListPlatformVersionsInput struct { type ListPlatformVersionsOutput struct { - // In a paginated request, if this value isn't null, it's the token that you can + // In a paginated request, if this value isn't null , it's the token that you can // pass in a subsequent request to get the next response page. NextToken *string diff --git a/service/elasticbeanstalk/api_op_ListTagsForResource.go b/service/elasticbeanstalk/api_op_ListTagsForResource.go index 201f9db8fb1..33e719606ff 100644 --- a/service/elasticbeanstalk/api_op_ListTagsForResource.go +++ b/service/elasticbeanstalk/api_op_ListTagsForResource.go @@ -14,8 +14,8 @@ import ( // Return the tags applied to an AWS Elastic Beanstalk resource. The response // contains a list of tag key-value pairs. Elastic Beanstalk supports tagging of // all of its resources. For details about resource tagging, see Tagging -// Application Resources -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html). +// Application Resources (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -33,8 +33,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resouce for which a tag list is requested. - // Must be the ARN of an Elastic Beanstalk resource. + // The Amazon Resource Name (ARN) of the resouce for which a tag list is + // requested. Must be the ARN of an Elastic Beanstalk resource. // // This member is required. ResourceArn *string diff --git a/service/elasticbeanstalk/api_op_RebuildEnvironment.go b/service/elasticbeanstalk/api_op_RebuildEnvironment.go index a7625efc37b..66df62dde3c 100644 --- a/service/elasticbeanstalk/api_op_RebuildEnvironment.go +++ b/service/elasticbeanstalk/api_op_RebuildEnvironment.go @@ -29,9 +29,9 @@ func (c *Client) RebuildEnvironment(ctx context.Context, params *RebuildEnvironm type RebuildEnvironmentInput struct { - // The ID of the environment to rebuild. Condition: You must specify either this or - // an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk - // returns MissingRequiredParameter error. + // The ID of the environment to rebuild. Condition: You must specify either this + // or an EnvironmentName, or both. If you do not specify either, AWS Elastic + // Beanstalk returns MissingRequiredParameter error. EnvironmentId *string // The name of the environment to rebuild. Condition: You must specify either this diff --git a/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go index 4120bed7fca..c0871bdd0e4 100644 --- a/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates a request to compile the specified type of information of the deployed -// environment. Setting the InfoType to tail compiles the last lines from the -// application server log files of every Amazon EC2 instance in your environment. -// Setting the InfoType to bundle compresses the application server log files for -// every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not -// support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. -// Related Topics -// -// * RetrieveEnvironmentInfo +// Initiates a request to compile the specified type of information of the +// deployed environment. Setting the InfoType to tail compiles the last lines from +// the application server log files of every Amazon EC2 instance in your +// environment. Setting the InfoType to bundle compresses the application server +// log files for every Amazon EC2 instance into a .zip file. Legacy and .NET +// containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain +// the set of logs. Related Topics +// - RetrieveEnvironmentInfo func (c *Client) RequestEnvironmentInfo(ctx context.Context, params *RequestEnvironmentInfoInput, optFns ...func(*Options)) (*RequestEnvironmentInfoOutput, error) { if params == nil { params = &RequestEnvironmentInfoInput{} @@ -45,15 +44,17 @@ type RequestEnvironmentInfoInput struct { InfoType types.EnvironmentInfoType // The ID of the environment of the requested data. If no such environment is - // found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: - // You must specify either this or an EnvironmentName, or both. If you do not - // specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + // found, RequestEnvironmentInfo returns an InvalidParameterValue error. + // Condition: You must specify either this or an EnvironmentName, or both. If you + // do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter + // error. EnvironmentId *string // The name of the environment of the requested data. If no such environment is - // found, RequestEnvironmentInfo returns an InvalidParameterValue error. Condition: - // You must specify either this or an EnvironmentId, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + // found, RequestEnvironmentInfo returns an InvalidParameterValue error. + // Condition: You must specify either this or an EnvironmentId, or both. If you do + // not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter + // error. EnvironmentName *string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_RestartAppServer.go b/service/elasticbeanstalk/api_op_RestartAppServer.go index 38b1d894bd3..f32f245b35d 100644 --- a/service/elasticbeanstalk/api_op_RestartAppServer.go +++ b/service/elasticbeanstalk/api_op_RestartAppServer.go @@ -29,9 +29,9 @@ func (c *Client) RestartAppServer(ctx context.Context, params *RestartAppServerI type RestartAppServerInput struct { - // The ID of the environment to restart the server for. Condition: You must specify - // either this or an EnvironmentName, or both. If you do not specify either, AWS - // Elastic Beanstalk returns MissingRequiredParameter error. + // The ID of the environment to restart the server for. Condition: You must + // specify either this or an EnvironmentName, or both. If you do not specify + // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. EnvironmentId *string // The name of the environment to restart the server for. Condition: You must diff --git a/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go index 2590d82ddf9..8bcd5ba58a0 100644 --- a/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go @@ -13,8 +13,7 @@ import ( // Retrieves the compiled information from a RequestEnvironmentInfo request. // Related Topics -// -// * RequestEnvironmentInfo +// - RequestEnvironmentInfo func (c *Client) RetrieveEnvironmentInfo(ctx context.Context, params *RetrieveEnvironmentInfoInput, optFns ...func(*Options)) (*RetrieveEnvironmentInfoOutput, error) { if params == nil { params = &RetrieveEnvironmentInfoInput{} @@ -30,7 +29,7 @@ func (c *Client) RetrieveEnvironmentInfo(ctx context.Context, params *RetrieveEn return out, nil } -// Request to download logs retrieved with RequestEnvironmentInfo. +// Request to download logs retrieved with RequestEnvironmentInfo . type RetrieveEnvironmentInfoInput struct { // The type of information to retrieve. diff --git a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go index 8559460f7d6..a985e27ae63 100644 --- a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go +++ b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go @@ -30,27 +30,27 @@ func (c *Client) SwapEnvironmentCNAMEs(ctx context.Context, params *SwapEnvironm type SwapEnvironmentCNAMEsInput struct { // The ID of the destination environment. Condition: You must specify at least the - // DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify - // both. You must specify the SourceEnvironmentId with the - // DestinationEnvironmentId. + // DestinationEnvironmentID or the DestinationEnvironmentName . You may also + // specify both. You must specify the SourceEnvironmentId with the + // DestinationEnvironmentId . DestinationEnvironmentId *string // The name of the destination environment. Condition: You must specify at least - // the DestinationEnvironmentID or the DestinationEnvironmentName. You may also + // the DestinationEnvironmentID or the DestinationEnvironmentName . You may also // specify both. You must specify the SourceEnvironmentName with the - // DestinationEnvironmentName. + // DestinationEnvironmentName . DestinationEnvironmentName *string // The ID of the source environment. Condition: You must specify at least the - // SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If - // you specify the SourceEnvironmentId, you must specify the - // DestinationEnvironmentId. + // SourceEnvironmentID or the SourceEnvironmentName . You may also specify both. If + // you specify the SourceEnvironmentId , you must specify the + // DestinationEnvironmentId . SourceEnvironmentId *string // The name of the source environment. Condition: You must specify at least the - // SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If - // you specify the SourceEnvironmentName, you must specify the - // DestinationEnvironmentName. + // SourceEnvironmentID or the SourceEnvironmentName . You may also specify both. If + // you specify the SourceEnvironmentName , you must specify the + // DestinationEnvironmentName . SourceEnvironmentName *string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_TerminateEnvironment.go b/service/elasticbeanstalk/api_op_TerminateEnvironment.go index 0055af06b87..881896bd050 100644 --- a/service/elasticbeanstalk/api_op_TerminateEnvironment.go +++ b/service/elasticbeanstalk/api_op_TerminateEnvironment.go @@ -47,18 +47,12 @@ type TerminateEnvironmentInput struct { // Indicates whether the associated AWS resources should shut down when the // environment is terminated: - // - // * true: The specified environment as well as the - // associated AWS resources, such as Auto Scaling group and LoadBalancer, are - // terminated. - // - // * false: AWS Elastic Beanstalk resource management is removed from - // the environment, but the AWS resources continue to operate. - // - // For more - // information, see the AWS Elastic Beanstalk User Guide. - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/) Default: true Valid - // Values: true | false + // - true : The specified environment as well as the associated AWS resources, + // such as Auto Scaling group and LoadBalancer, are terminated. + // - false : AWS Elastic Beanstalk resource management is removed from the + // environment, but the AWS resources continue to operate. + // For more information, see the AWS Elastic Beanstalk User Guide. (https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/) + // Default: true Valid Values: true | false TerminateResources *bool noSmithyDocumentSerde @@ -106,33 +100,24 @@ type TerminateEnvironmentOutput struct { // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: - // - // * Red: Indicates the environment - // is not responsive. Occurs when three or more consecutive failures occur for an - // environment. - // - // * Yellow: Indicates that something is wrong. Occurs when two - // consecutive failures occur for an environment. - // - // * Green: Indicates the - // environment is healthy and fully functional. - // - // * Grey: Default health for a new - // environment. The environment is not fully launched and health checks have not - // started or health checks are suspended during an UpdateEnvironment or - // RestartEnvironment request. - // + // - Red : Indicates the environment is not responsive. Occurs when three or more + // consecutive failures occur for an environment. + // - Yellow : Indicates that something is wrong. Occurs when two consecutive + // failures occur for an environment. + // - Green : Indicates the environment is healthy and fully functional. + // - Grey : Default health for a new environment. The environment is not fully + // launched and health checks have not started or health checks are suspended + // during an UpdateEnvironment or RestartEnvironment request. // Default: Grey Health types.EnvironmentHealth // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . HealthStatus types.EnvironmentHealthStatus // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string @@ -146,21 +131,13 @@ type TerminateEnvironmentOutput struct { SolutionStackName *string // The current operational status of the environment: - // - // * Launching: Environment is - // in the process of initial deployment. - // - // * Updating: Environment is in the process - // of updating its configuration settings or application version. - // - // * Ready: - // Environment is available to have an action performed on it, such as update or - // terminate. - // - // * Terminating: Environment is in the shut-down process. - // - // * - // Terminated: Environment is not running. + // - Launching : Environment is in the process of initial deployment. + // - Updating : Environment is in the process of updating its configuration + // settings or application version. + // - Ready : Environment is available to have an action performed on it, such as + // update or terminate. + // - Terminating : Environment is in the shut-down process. + // - Terminated : Environment is not running. Status types.EnvironmentStatus // The name of the configuration template used to originally launch this diff --git a/service/elasticbeanstalk/api_op_UpdateApplication.go b/service/elasticbeanstalk/api_op_UpdateApplication.go index 43a35aeced0..59718bfd96e 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplication.go +++ b/service/elasticbeanstalk/api_op_UpdateApplication.go @@ -12,7 +12,7 @@ import ( ) // Updates the specified application to have the specified properties. If a -// property (for example, description) is not provided, the value remains +// property (for example, description ) is not provided, the value remains // unchanged. To clear these properties, specify an empty string. func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error) { if params == nil { diff --git a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go index 790daa43d72..38845ea9d6d 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified application version to have the specified properties. If a -// property (for example, description) is not provided, the value remains +// Updates the specified application version to have the specified properties. If +// a property (for example, description ) is not provided, the value remains // unchanged. To clear properties, specify an empty string. func (c *Client) UpdateApplicationVersion(ctx context.Context, params *UpdateApplicationVersionInput, optFns ...func(*Options)) (*UpdateApplicationVersionOutput, error) { if params == nil { diff --git a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go index 69c0f63458a..0d378838df1 100644 --- a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go @@ -12,12 +12,11 @@ import ( "time" ) -// Updates the specified configuration template to have the specified properties or -// configuration option values. If a property (for example, ApplicationName) is not -// provided, its value remains unchanged. To clear such properties, specify an +// Updates the specified configuration template to have the specified properties +// or configuration option values. If a property (for example, ApplicationName ) is +// not provided, its value remains unchanged. To clear such properties, specify an // empty string. Related Topics -// -// * DescribeConfigurationOptions +// - DescribeConfigurationOptions func (c *Client) UpdateConfigurationTemplate(ctx context.Context, params *UpdateConfigurationTemplateInput, optFns ...func(*Options)) (*UpdateConfigurationTemplateOutput, error) { if params == nil { params = &UpdateConfigurationTemplateInput{} @@ -79,25 +78,18 @@ type UpdateConfigurationTemplateOutput struct { // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration // set: - // - // * null: This configuration is not associated with a running - // environment. - // - // * pending: This is a draft configuration that is not deployed to - // the associated environment but is in the process of deploying. - // - // * deployed: This - // is the configuration that is currently deployed to the associated running - // environment. - // - // * failed: This is a draft configuration that failed to - // successfully deploy. + // - null : This configuration is not associated with a running environment. + // - pending : This is a draft configuration that is not deployed to the + // associated environment but is in the process of deploying. + // - deployed : This is the configuration that is currently deployed to the + // associated running environment. + // - failed : This is a draft configuration that failed to successfully deploy. DeploymentStatus types.ConfigurationDeploymentStatus // Describes this configuration set. Description *string - // If not null, the name of the environment for this configuration set. + // If not null , the name of the environment for this configuration set. EnvironmentName *string // A list of the configuration options and their values in this configuration set. @@ -109,7 +101,7 @@ type UpdateConfigurationTemplateOutput struct { // The name of the solution stack this configuration set uses. SolutionStackName *string - // If not null, the name of the configuration template for this configuration set. + // If not null , the name of the configuration template for this configuration set. TemplateName *string // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_UpdateEnvironment.go b/service/elasticbeanstalk/api_op_UpdateEnvironment.go index 62611ad7fbe..457cb7fe95e 100644 --- a/service/elasticbeanstalk/api_op_UpdateEnvironment.go +++ b/service/elasticbeanstalk/api_op_UpdateEnvironment.go @@ -41,8 +41,8 @@ type UpdateEnvironmentInput struct { // The name of the application with which the environment is associated. ApplicationName *string - // If this parameter is specified, AWS Elastic Beanstalk updates the description of - // this environment. + // If this parameter is specified, AWS Elastic Beanstalk updates the description + // of this environment. Description *string // The ID of the environment to update. If no environment with this ID exists, AWS @@ -60,8 +60,7 @@ type UpdateEnvironmentInput struct { // The name of the group to which the target environment belongs. Specify a group // name only if the environment's name is specified in an environment manifest and // not with the environment name or environment ID parameters. See Environment - // Manifest (env.yaml) - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) + // Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) // for details. GroupName *string @@ -81,9 +80,9 @@ type UpdateEnvironmentInput struct { // environment is updated. SolutionStackName *string - // If this parameter is specified, AWS Elastic Beanstalk deploys this configuration - // template to the environment. If no such configuration template is found, AWS - // Elastic Beanstalk returns an InvalidParameterValue error. + // If this parameter is specified, AWS Elastic Beanstalk deploys this + // configuration template to the environment. If no such configuration template is + // found, AWS Elastic Beanstalk returns an InvalidParameterValue error. TemplateName *string // This specifies the tier to use to update the environment. Condition: At this @@ -141,33 +140,24 @@ type UpdateEnvironmentOutput struct { // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: - // - // * Red: Indicates the environment - // is not responsive. Occurs when three or more consecutive failures occur for an - // environment. - // - // * Yellow: Indicates that something is wrong. Occurs when two - // consecutive failures occur for an environment. - // - // * Green: Indicates the - // environment is healthy and fully functional. - // - // * Grey: Default health for a new - // environment. The environment is not fully launched and health checks have not - // started or health checks are suspended during an UpdateEnvironment or - // RestartEnvironment request. - // + // - Red : Indicates the environment is not responsive. Occurs when three or more + // consecutive failures occur for an environment. + // - Yellow : Indicates that something is wrong. Occurs when two consecutive + // failures occur for an environment. + // - Green : Indicates the environment is healthy and fully functional. + // - Grey : Default health for a new environment. The environment is not fully + // launched and health checks have not started or health checks are suspended + // during an UpdateEnvironment or RestartEnvironment request. // Default: Grey Health types.EnvironmentHealth // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . HealthStatus types.EnvironmentHealthStatus // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string @@ -181,21 +171,13 @@ type UpdateEnvironmentOutput struct { SolutionStackName *string // The current operational status of the environment: - // - // * Launching: Environment is - // in the process of initial deployment. - // - // * Updating: Environment is in the process - // of updating its configuration settings or application version. - // - // * Ready: - // Environment is available to have an action performed on it, such as update or - // terminate. - // - // * Terminating: Environment is in the shut-down process. - // - // * - // Terminated: Environment is not running. + // - Launching : Environment is in the process of initial deployment. + // - Updating : Environment is in the process of updating its configuration + // settings or application version. + // - Ready : Environment is available to have an action performed on it, such as + // update or terminate. + // - Terminating : Environment is in the shut-down process. + // - Terminated : Environment is not running. Status types.EnvironmentStatus // The name of the configuration template used to originally launch this diff --git a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go index 55ca00214a3..13e3916f9a5 100644 --- a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go +++ b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go @@ -12,18 +12,18 @@ import ( ) // Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists -// can be passed: TagsToAdd for tags to add or update, and TagsToRemove. Elastic +// can be passed: TagsToAdd for tags to add or update, and TagsToRemove . Elastic // Beanstalk supports tagging of all of its resources. For details about resource -// tagging, see Tagging Application Resources -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html). -// If you create a custom IAM user policy to control permission to this operation, -// specify one of the following two virtual actions (or both) instead of the API -// operation name: elasticbeanstalk:AddTags Controls permission to call -// UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter. -// elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource -// and pass a list of tag keys to remove in the TagsToRemove parameter. For details -// about creating a custom user policy, see Creating a Custom User Policy -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies). +// tagging, see Tagging Application Resources (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html) +// . If you create a custom IAM user policy to control permission to this +// operation, specify one of the following two virtual actions (or both) instead of +// the API operation name: elasticbeanstalk:AddTags Controls permission to call +// UpdateTagsForResource and pass a list of tags to add in the TagsToAdd +// parameter. elasticbeanstalk:RemoveTags Controls permission to call +// UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove +// parameter. For details about creating a custom user policy, see Creating a +// Custom User Policy (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies) +// . func (c *Client) UpdateTagsForResource(ctx context.Context, params *UpdateTagsForResourceInput, optFns ...func(*Options)) (*UpdateTagsForResourceOutput, error) { if params == nil { params = &UpdateTagsForResourceInput{} @@ -47,13 +47,13 @@ type UpdateTagsForResourceInput struct { // This member is required. ResourceArn *string - // A list of tags to add or update. If a key of an existing tag is added, the tag's - // value is updated. Specify at least one of these parameters: TagsToAdd, - // TagsToRemove. + // A list of tags to add or update. If a key of an existing tag is added, the + // tag's value is updated. Specify at least one of these parameters: TagsToAdd , + // TagsToRemove . TagsToAdd []types.Tag // A list of tag keys to remove. If a tag key doesn't exist, it is silently - // ignored. Specify at least one of these parameters: TagsToAdd, TagsToRemove. + // ignored. Specify at least one of these parameters: TagsToAdd , TagsToRemove . TagsToRemove []string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go b/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go index f8931d43cca..323ff0bc4db 100644 --- a/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go +++ b/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go @@ -58,7 +58,7 @@ type ValidateConfigurationSettingsInput struct { // Provides a list of validation messages. type ValidateConfigurationSettingsOutput struct { - // A list of ValidationMessage. + // A list of ValidationMessage . Messages []types.ValidationMessage // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/doc.go b/service/elasticbeanstalk/doc.go index 5a9bb658c7e..42990c4b240 100644 --- a/service/elasticbeanstalk/doc.go +++ b/service/elasticbeanstalk/doc.go @@ -8,13 +8,11 @@ // Web Services cloud. For more information about this product, go to the AWS // Elastic Beanstalk (http://aws.amazon.com/elasticbeanstalk/) details page. The // location of the latest AWS Elastic Beanstalk WSDL is -// https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl -// (https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl). -// To install the Software Development Kits (SDKs), Integrated Development +// https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl (https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl) +// . To install the Software Development Kits (SDKs), Integrated Development // Environment (IDE) Toolkits, and command line tools that enable you to access the -// API, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/). +// API, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/) . // Endpoints For a list of region-specific endpoints that AWS Elastic Beanstalk -// supports, go to Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region) +// supports, go to Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region) // in the Amazon Web Services Glossary. package elasticbeanstalk diff --git a/service/elasticbeanstalk/types/enums.go b/service/elasticbeanstalk/types/enums.go index 7a2814a6718..40d104383ce 100644 --- a/service/elasticbeanstalk/types/enums.go +++ b/service/elasticbeanstalk/types/enums.go @@ -32,9 +32,9 @@ const ( ActionStatusUnknown ActionStatus = "Unknown" ) -// Values returns all known values for ActionStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActionStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ActionStatus) Values() []ActionStatus { return []ActionStatus{ "Scheduled", @@ -75,9 +75,9 @@ const ( ApplicationVersionStatusBuilding ApplicationVersionStatus = "Building" ) -// Values returns all known values for ApplicationVersionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ApplicationVersionStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationVersionStatus) Values() []ApplicationVersionStatus { return []ApplicationVersionStatus{ "Processed", @@ -137,9 +137,10 @@ const ( ConfigurationOptionValueTypeList ConfigurationOptionValueType = "List" ) -// Values returns all known values for ConfigurationOptionValueType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConfigurationOptionValueType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ConfigurationOptionValueType) Values() []ConfigurationOptionValueType { return []ConfigurationOptionValueType{ "Scalar", @@ -350,9 +351,9 @@ const ( InstancesHealthAttributeAll InstancesHealthAttribute = "All" ) -// Values returns all known values for InstancesHealthAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstancesHealthAttribute. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InstancesHealthAttribute) Values() []InstancesHealthAttribute { return []InstancesHealthAttribute{ "HealthStatus", diff --git a/service/elasticbeanstalk/types/errors.go b/service/elasticbeanstalk/types/errors.go index 14cb7e5df33..333d6095476 100644 --- a/service/elasticbeanstalk/types/errors.go +++ b/service/elasticbeanstalk/types/errors.go @@ -143,8 +143,8 @@ func (e *ManagedActionInvalidStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Unable to perform the specified operation because another operation that effects -// an element in this activity is already in progress. +// Unable to perform the specified operation because another operation that +// effects an element in this activity is already in progress. type OperationInProgressException struct { Message *string @@ -252,15 +252,11 @@ func (e *ResourceTypeNotSupportedException) ErrorCode() string { } func (e *ResourceTypeNotSupportedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified S3 bucket does not belong to the S3 region in which the service is -// running. The following regions are supported: -// -// * IAD/us-east-1 -// -// * -// PDX/us-west-2 -// -// * DUB/eu-west-1 +// The specified S3 bucket does not belong to the S3 region in which the service +// is running. The following regions are supported: +// - IAD/us-east-1 +// - PDX/us-west-2 +// - DUB/eu-west-1 type S3LocationNotInServiceRegionException struct { Message *string diff --git a/service/elasticbeanstalk/types/types.go b/service/elasticbeanstalk/types/types.go index 347a2393ea6..34e8c181ada 100644 --- a/service/elasticbeanstalk/types/types.go +++ b/service/elasticbeanstalk/types/types.go @@ -40,17 +40,17 @@ type ApplicationDescription struct { // Application request metrics for an AWS Elastic Beanstalk environment. type ApplicationMetrics struct { - // The amount of time that the metrics cover (usually 10 seconds). For example, you - // might have 5 requests (request_count) within the most recent time slice of 10 - // seconds (duration). + // The amount of time that the metrics cover (usually 10 seconds). For example, + // you might have 5 requests ( request_count ) within the most recent time slice of + // 10 seconds ( duration ). Duration *int32 // Represents the average latency for the slowest X percent of requests over the // last 10 seconds. Latencies are in seconds with one millisecond resolution. Latency *Latency - // Average number of requests handled by the web server per second over the last 10 - // seconds. + // Average number of requests handled by the web server per second over the last + // 10 seconds. RequestCount int32 // Represents the percentage of requests over the last 10 seconds that resulted in @@ -68,8 +68,8 @@ type ApplicationResourceLifecycleConfig struct { // The ARN of an IAM service role that Elastic Beanstalk has permission to assume. // The ServiceRole property is required the first time that you provide a - // VersionLifecycleConfig for the application in one of the supporting calls - // (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it + // VersionLifecycleConfig for the application in one of the supporting calls ( + // CreateApplication or UpdateApplicationResourceLifecycle ). After you provide it // once, in either one of the calls, Elastic Beanstalk persists the Service Role // with the application, and you don't need to specify it again in subsequent // UpdateApplicationResourceLifecycle calls. You can, however, specify it in @@ -114,24 +114,16 @@ type ApplicationVersionDescription struct { // application version during its creation. Many of the values are only applicable // if you specified True for the Process parameter of the CreateApplicationVersion // action. The following list describes the possible values. - // - // * Unprocessed – - // Application version wasn't pre-processed or validated. Elastic Beanstalk will - // validate configuration files during deployment of the application version to an - // environment. - // - // * Processing – Elastic Beanstalk is currently processing the - // application version. - // - // * Building – Application version is currently undergoing - // an AWS CodeBuild build. - // - // * Processed – Elastic Beanstalk was successfully - // pre-processed and validated. - // - // * Failed – Either the AWS CodeBuild build failed - // or configuration files didn't pass validation. This application version isn't - // usable. + // - Unprocessed – Application version wasn't pre-processed or validated. Elastic + // Beanstalk will validate configuration files during deployment of the application + // version to an environment. + // - Processing – Elastic Beanstalk is currently processing the application + // version. + // - Building – Application version is currently undergoing an AWS CodeBuild + // build. + // - Processed – Elastic Beanstalk was successfully pre-processed and validated. + // - Failed – Either the AWS CodeBuild build failed or configuration files didn't + // pass validation. This application version isn't usable. Status ApplicationVersionStatus // A unique identifier for the application version. @@ -140,20 +132,20 @@ type ApplicationVersionDescription struct { noSmithyDocumentSerde } -// The application version lifecycle settings for an application. Defines the rules -// that Elastic Beanstalk applies to an application's versions in order to avoid -// hitting the per-region limit for application versions. When Elastic Beanstalk -// deletes an application version from its database, you can no longer deploy that -// version to an environment. The source bundle remains in S3 unless you configure -// the rule to delete it. +// The application version lifecycle settings for an application. Defines the +// rules that Elastic Beanstalk applies to an application's versions in order to +// avoid hitting the per-region limit for application versions. When Elastic +// Beanstalk deletes an application version from its database, you can no longer +// deploy that version to an environment. The source bundle remains in S3 unless +// you configure the rule to delete it. type ApplicationVersionLifecycleConfig struct { // Specify a max age rule to restrict the length of time that application versions // are retained for an application. MaxAgeRule *MaxAgeRule - // Specify a max count rule to restrict the number of application versions that are - // retained for an application. + // Specify a max count rule to restrict the number of application versions that + // are retained for an application. MaxCountRule *MaxCountRule noSmithyDocumentSerde @@ -191,15 +183,9 @@ type BuildConfiguration struct { ArtifactName *string // Information about the compute resources the build project will use. - // - // * - // BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds - // - // * - // BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds - // - // * - // BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds + // - BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds + // - BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds + // - BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds ComputeType ComputeType // How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until @@ -224,17 +210,14 @@ type ConfigurationOptionDescription struct { // An indication of which action is required if the value for this configuration // option changes: - // - // * NoInterruption : There is no interruption to the environment - // or application availability. - // - // * RestartEnvironment : The environment is entirely - // restarted, all AWS resources are deleted and recreated, and the environment is - // unavailable during the process. - // - // * RestartApplicationServer : The environment is - // available the entire time. However, a short application outage occurs when the - // application servers on the running Amazon EC2 instances are restarted. + // - NoInterruption : There is no interruption to the environment or application + // availability. + // - RestartEnvironment : The environment is entirely restarted, all AWS + // resources are deleted and recreated, and the environment is unavailable during + // the process. + // - RestartApplicationServer : The environment is available the entire time. + // However, a short application outage occurs when the application servers on the + // running Amazon EC2 instances are restarted. ChangeSeverity *string // The default value for this configuration option. @@ -248,8 +231,8 @@ type ConfigurationOptionDescription struct { // value. MaxValue *int32 - // If specified, the configuration option must be a numeric value greater than this - // value. + // If specified, the configuration option must be a numeric value greater than + // this value. MinValue *int32 // The name of the configuration option. @@ -263,17 +246,12 @@ type ConfigurationOptionDescription struct { Regex *OptionRestrictionRegex // An indication of whether the user defined this configuration option: - // - // * true : - // This configuration option was defined by the user. It is a valid choice for - // specifying if this as an Option to Remove when updating configuration - // settings. - // - // * false : This configuration was not defined by the - // user. - // - // Constraint: You can remove only UserDefined options from a configuration. - // Valid Values: true | false + // - true : This configuration option was defined by the user. It is a valid + // choice for specifying if this as an Option to Remove when updating + // configuration settings. + // - false : This configuration was not defined by the user. + // Constraint: You can remove only UserDefined options from a configuration. Valid + // Values: true | false UserDefined *bool // If specified, values for the configuration option are selected from this list. @@ -281,20 +259,14 @@ type ConfigurationOptionDescription struct { // An indication of which type of values this option has and whether it is // allowable to select one or more than one of the possible values: - // - // * Scalar : - // Values for this option are a single selection from the possible values, or an - // unformatted string, or numeric value governed by the MIN/MAX/Regex - // constraints. - // - // * List : Values for this option are multiple selections from the - // possible values. - // - // * Boolean : Values for this option are either true or false - // . - // - // * Json : Values for this option are a JSON representation of a - // ConfigDocument. + // - Scalar : Values for this option are a single selection from the possible + // values, or an unformatted string, or numeric value governed by the + // MIN/MAX/Regex constraints. + // - List : Values for this option are multiple selections from the possible + // values. + // - Boolean : Values for this option are either true or false . + // - Json : Values for this option are a JSON representation of a ConfigDocument + // . ValueType ConfigurationOptionValueType noSmithyDocumentSerde @@ -302,9 +274,8 @@ type ConfigurationOptionDescription struct { // A specification identifying an individual configuration option along with its // current value. For a list of possible namespaces and option values, see Option -// Values -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in -// the AWS Elastic Beanstalk Developer Guide. +// Values (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) +// in the AWS Elastic Beanstalk Developer Guide. type ConfigurationOptionSetting struct { // A unique namespace that identifies the option's associated AWS resource. @@ -338,25 +309,18 @@ type ConfigurationSettingsDescription struct { // If this configuration set is associated with an environment, the // DeploymentStatus parameter indicates the deployment status of this configuration // set: - // - // * null: This configuration is not associated with a running - // environment. - // - // * pending: This is a draft configuration that is not deployed to - // the associated environment but is in the process of deploying. - // - // * deployed: This - // is the configuration that is currently deployed to the associated running - // environment. - // - // * failed: This is a draft configuration that failed to - // successfully deploy. + // - null : This configuration is not associated with a running environment. + // - pending : This is a draft configuration that is not deployed to the + // associated environment but is in the process of deploying. + // - deployed : This is the configuration that is currently deployed to the + // associated running environment. + // - failed : This is a draft configuration that failed to successfully deploy. DeploymentStatus ConfigurationDeploymentStatus // Describes this configuration set. Description *string - // If not null, the name of the environment for this configuration set. + // If not null , the name of the environment for this configuration set. EnvironmentName *string // A list of the configuration options and their values in this configuration set. @@ -368,7 +332,7 @@ type ConfigurationSettingsDescription struct { // The name of the solution stack this configuration set uses. SolutionStackName *string - // If not null, the name of the configuration template for this configuration set. + // If not null , the name of the configuration template for this configuration set. TemplateName *string noSmithyDocumentSerde @@ -427,22 +391,18 @@ type CustomAmi struct { // Information about an application version deployment. type Deployment struct { - // The ID of the deployment. This number increases by one each time that you deploy - // source code or change instance configuration settings. + // The ID of the deployment. This number increases by one each time that you + // deploy source code or change instance configuration settings. DeploymentId *int64 - // For in-progress deployments, the time that the deployment started. For completed - // deployments, the time that the deployment ended. + // For in-progress deployments, the time that the deployment started. For + // completed deployments, the time that the deployment ended. DeploymentTime *time.Time // The status of the deployment: - // - // * In Progress : The deployment is in progress. - // - // * - // Deployed : The deployment succeeded. - // - // * Failed : The deployment failed. + // - In Progress : The deployment is in progress. + // - Deployed : The deployment succeeded. + // - Failed : The deployment failed. Status *string // The version label of the application version in the deployment. @@ -493,33 +453,24 @@ type EnvironmentDescription struct { // Describes the health status of the environment. AWS Elastic Beanstalk indicates // the failure levels for a running environment: - // - // * Red: Indicates the environment - // is not responsive. Occurs when three or more consecutive failures occur for an - // environment. - // - // * Yellow: Indicates that something is wrong. Occurs when two - // consecutive failures occur for an environment. - // - // * Green: Indicates the - // environment is healthy and fully functional. - // - // * Grey: Default health for a new - // environment. The environment is not fully launched and health checks have not - // started or health checks are suspended during an UpdateEnvironment or - // RestartEnvironment request. - // + // - Red : Indicates the environment is not responsive. Occurs when three or more + // consecutive failures occur for an environment. + // - Yellow : Indicates that something is wrong. Occurs when two consecutive + // failures occur for an environment. + // - Green : Indicates the environment is healthy and fully functional. + // - Grey : Default health for a new environment. The environment is not fully + // launched and health checks have not started or health checks are suspended + // during an UpdateEnvironment or RestartEnvironment request. // Default: Grey Health EnvironmentHealth // Returns the health status of the application running in your environment. For - // more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . HealthStatus EnvironmentHealthStatus // The Amazon Resource Name (ARN) of the environment's operations role. For more - // information, see Operations roles - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) + // information, see Operations roles (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) // in the AWS Elastic Beanstalk Developer Guide. OperationsRole *string @@ -533,21 +484,13 @@ type EnvironmentDescription struct { SolutionStackName *string // The current operational status of the environment: - // - // * Launching: Environment is - // in the process of initial deployment. - // - // * Updating: Environment is in the process - // of updating its configuration settings or application version. - // - // * Ready: - // Environment is available to have an action performed on it, such as update or - // terminate. - // - // * Terminating: Environment is in the shut-down process. - // - // * - // Terminated: Environment is not running. + // - Launching : Environment is in the process of initial deployment. + // - Updating : Environment is in the process of updating its configuration + // settings or application version. + // - Ready : Environment is available to have an action performed on it, such as + // update or terminate. + // - Terminating : Environment is in the shut-down process. + // - Terminated : Environment is not running. Status EnvironmentStatus // The name of the configuration template used to originally launch this @@ -586,8 +529,7 @@ type EnvironmentInfoDescription struct { // A link to another environment, defined in the environment's manifest. Links // provide connection information in system properties that can be used to connect -// to another environment in the same group. See Environment Manifest (env.yaml) -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) +// to another environment in the same group. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) // for details. type EnvironmentLink struct { @@ -644,19 +586,13 @@ type EnvironmentResourcesDescription struct { type EnvironmentTier struct { // The name of this environment tier. Valid values: - // - // * For Web server tier – - // WebServer - // - // * For Worker tier – Worker + // - For Web server tier – WebServer + // - For Worker tier – Worker Name *string // The type of this environment tier. Valid values: - // - // * For Web server tier – - // Standard - // - // * For Worker tier – SQS/HTTP + // - For Web server tier – Standard + // - For Worker tier – SQS/HTTP Type *string // The version of this environment tier. When you don't set a value to it, Elastic @@ -711,8 +647,8 @@ type Instance struct { } // Represents summary information about the health of an instance. For more -// information, see Health Colors and Statuses -// (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). +// information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) +// . type InstanceHealthSummary struct { // Red. The health agent is reporting a high number of request failures or other @@ -853,8 +789,8 @@ type ManagedAction struct { // The type of managed action. ActionType ActionType - // The status of the managed action. If the action is Scheduled, you can apply it - // immediately with ApplyEnvironmentManagedAction. + // The status of the managed action. If the action is Scheduled , you can apply it + // immediately with ApplyEnvironmentManagedAction . Status ActionStatus // The start time of the maintenance window in which the managed action will @@ -894,8 +830,8 @@ type ManagedActionHistoryItem struct { noSmithyDocumentSerde } -// A lifecycle rule that deletes application versions after the specified number of -// days. +// A lifecycle rule that deletes application versions after the specified number +// of days. type MaxAgeRule struct { // Specify true to apply the rule, or false to disable it. @@ -932,8 +868,8 @@ type MaxCountRule struct { noSmithyDocumentSerde } -// A regular expression representing a restriction on a string configuration option -// value. +// A regular expression representing a restriction on a string configuration +// option value. type OptionRestrictionRegex struct { // A unique name representing this regular expression. @@ -967,10 +903,11 @@ type PlatformBranchSummary struct { // The name of the platform branch. BranchName *string - // An ordinal number that designates the order in which platform branches have been - // added to a platform. This can be helpful, for example, if your code calls the - // ListPlatformBranches action and then displays a list of platform branches. A - // larger BranchOrder value designates a newer platform branch within the platform. + // An ordinal number that designates the order in which platform branches have + // been added to a platform. This can be helpful, for example, if your code calls + // the ListPlatformBranches action and then displays a list of platform branches. + // A larger BranchOrder value designates a newer platform branch within the + // platform. BranchOrder int32 // The support life cycle state of the platform branch. Possible values: beta | @@ -1064,7 +1001,7 @@ type PlatformDescription struct { // filter is evaluated as follows: Type Operator Values[1] type PlatformFilter struct { - // The operator to apply to the Type with each of the Values. Valid values: = | != + // The operator to apply to the Type with each of the Values . Valid values: = | != // | < | <= | > | >= | contains | begins_with | ends_with Operator *string @@ -1074,20 +1011,13 @@ type PlatformFilter struct { // ProgrammingLanguageName | OperatingSystemName Type *string - // The list of values applied to the filtering platform version attribute. Only one - // value is supported for all current operators. The following list shows valid + // The list of values applied to the filtering platform version attribute. Only + // one value is supported for all current operators. The following list shows valid // filter values for some filter attributes. - // - // * PlatformStatus: Creating | Failed | - // Ready | Deleting | Deleted - // - // * PlatformLifecycleState: recommended - // - // * - // SupportedTier: WebServer/Standard | Worker/SQS/HTTP - // - // * SupportedAddon: Log/S3 | - // Monitoring/Healthd | WorkerDaemon/SQSD + // - PlatformStatus : Creating | Failed | Ready | Deleting | Deleted + // - PlatformLifecycleState : recommended + // - SupportedTier : WebServer/Standard | Worker/SQS/HTTP + // - SupportedAddon : Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD Values []string noSmithyDocumentSerde @@ -1175,8 +1105,8 @@ type Queue struct { noSmithyDocumentSerde } -// The AWS Elastic Beanstalk quota information for a single resource type in an AWS -// account. It reflects the resource's limits for this account. +// The AWS Elastic Beanstalk quota information for a single resource type in an +// AWS account. It reflects the resource's limits for this account. type ResourceQuota struct { // The maximum number of instances of this Elastic Beanstalk resource type that an @@ -1222,7 +1152,7 @@ type S3Location struct { // Describes criteria to restrict a list of results. For operators that apply a // single value to the attribute, the filter is evaluated as follows: Attribute -// Operator Values[1] Some operators, e.g. in, can apply multiple values. In this +// Operator Values[1] Some operators, e.g. in , can apply multiple values. In this // case, the filter is evaluated as a logical union (OR) of applications of the // operator to the attribute with each one of the values: (Attribute Operator // Values[1]) OR (Attribute Operator Values[2]) OR ... The valid values for @@ -1235,12 +1165,12 @@ type SearchFilter struct { // by API action. Attribute *string - // The operator to apply to the Attribute with each of the Values. Valid values - // vary by Attribute. + // The operator to apply to the Attribute with each of the Values . Valid values + // vary by Attribute . Operator *string // The list of values applied to the Attribute and Operator attributes. Number of - // values and valid values vary by Attribute. + // values and valid values vary by Attribute . Values []string noSmithyDocumentSerde @@ -1261,16 +1191,16 @@ type SingleInstanceHealth struct { Causes []string // Represents the color indicator that gives you information about the health of - // the EC2 instance. For more information, see Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // the EC2 instance. For more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . Color *string // Information about the most recent deployment to an instance. Deployment *Deployment // Returns the health status of the specified instance. For more information, see - // Health Colors and Statuses - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). + // Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) + // . HealthStatus *string // The ID of the Amazon EC2 instance. @@ -1305,32 +1235,25 @@ type SourceBuildInformation struct { // The location of the source code, as a formatted string, depending on the value // of SourceRepository - // - // * For CodeCommit, the format is the repository name and - // commit ID, separated by a forward slash. For example, - // my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a. - // - // * For S3, the format is - // the S3 bucket name and object key, separated by a forward slash. For example, - // my-s3-bucket/Folders/my-source-file. + // - For CodeCommit , the format is the repository name and commit ID, separated + // by a forward slash. For example, + // my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a . + // - For S3 , the format is the S3 bucket name and object key, separated by a + // forward slash. For example, my-s3-bucket/Folders/my-source-file . // // This member is required. SourceLocation *string // Location where the repository is stored. - // - // * CodeCommit - // - // * S3 + // - CodeCommit + // - S3 // // This member is required. SourceRepository SourceRepository // The type of repository. - // - // * Git - // - // * Zip + // - Git + // - Zip // // This member is required. SourceType SourceType @@ -1352,23 +1275,23 @@ type SourceConfiguration struct { // Represents the percentage of requests over the last 10 seconds that resulted in // each type of status code response. For more information, see Status Code -// Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). +// Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) . type StatusCodes struct { - // The percentage of requests over the last 10 seconds that resulted in a 2xx (200, - // 201, etc.) status code. + // The percentage of requests over the last 10 seconds that resulted in a 2xx + // (200, 201, etc.) status code. Status2xx *int32 - // The percentage of requests over the last 10 seconds that resulted in a 3xx (300, - // 301, etc.) status code. + // The percentage of requests over the last 10 seconds that resulted in a 3xx + // (300, 301, etc.) status code. Status3xx *int32 - // The percentage of requests over the last 10 seconds that resulted in a 4xx (400, - // 401, etc.) status code. + // The percentage of requests over the last 10 seconds that resulted in a 4xx + // (400, 401, etc.) status code. Status4xx *int32 - // The percentage of requests over the last 10 seconds that resulted in a 5xx (500, - // 501, etc.) status code. + // The percentage of requests over the last 10 seconds that resulted in a 5xx + // (500, 501, etc.) status code. Status5xx *int32 noSmithyDocumentSerde @@ -1381,8 +1304,8 @@ type SystemStatus struct { CPUUtilization *CPUUtilization // Load average in the last 1-minute, 5-minute, and 15-minute periods. For more - // information, see Operating System Metrics - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os). + // information, see Operating System Metrics (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os) + // . LoadAverage []float64 noSmithyDocumentSerde @@ -1422,12 +1345,10 @@ type ValidationMessage struct { OptionName *string // An indication of the severity of this message: - // - // * error: This message indicates - // that this is not a valid setting for an option. - // - // * warning: This message is - // providing information you should take into account. + // - error : This message indicates that this is not a valid setting for an + // option. + // - warning : This message is providing information you should take into + // account. Severity ValidationSeverity noSmithyDocumentSerde diff --git a/service/elasticinference/api_client.go b/service/elasticinference/api_client.go index 83b9b09468b..d29a09533cd 100644 --- a/service/elasticinference/api_client.go +++ b/service/elasticinference/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticinference/api_op_DescribeAccelerators.go b/service/elasticinference/api_op_DescribeAccelerators.go index 9c48a83f466..ec8f0bc7562 100644 --- a/service/elasticinference/api_op_DescribeAccelerators.go +++ b/service/elasticinference/api_op_DescribeAccelerators.go @@ -45,11 +45,11 @@ type DescribeAcceleratorsInput struct { // filter for. instance-id: can provide a list of EC2 instance ids to filter for. Filters []types.Filter - // The total number of items to return in the command's output. If the total number - // of items available is more than the value specified, a NextToken is provided in - // the command's output. To resume pagination, provide the NextToken value in the - // starting-token argument of a subsequent command. Do not use the NextToken - // response element directly outside of the AWS CLI. + // The total number of items to return in the command's output. If the total + // number of items available is more than the value specified, a NextToken is + // provided in the command's output. To resume pagination, provide the NextToken + // value in the starting-token argument of a subsequent command. Do not use the + // NextToken response element directly outside of the AWS CLI. MaxResults int32 // A token to specify where to start paginating. This is the NextToken from a @@ -145,11 +145,11 @@ var _ DescribeAcceleratorsAPIClient = (*Client)(nil) // DescribeAcceleratorsPaginatorOptions is the paginator options for // DescribeAccelerators type DescribeAcceleratorsPaginatorOptions struct { - // The total number of items to return in the command's output. If the total number - // of items available is more than the value specified, a NextToken is provided in - // the command's output. To resume pagination, provide the NextToken value in the - // starting-token argument of a subsequent command. Do not use the NextToken - // response element directly outside of the AWS CLI. + // The total number of items to return in the command's output. If the total + // number of items available is more than the value specified, a NextToken is + // provided in the command's output. To resume pagination, provide the NextToken + // value in the starting-token argument of a subsequent command. Do not use the + // NextToken response element directly outside of the AWS CLI. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticinference/types/enums.go b/service/elasticinference/types/enums.go index bb83c0f1a40..367131fd99e 100644 --- a/service/elasticinference/types/enums.go +++ b/service/elasticinference/types/enums.go @@ -11,9 +11,9 @@ const ( LocationTypeAvailabilityZoneId LocationType = "availability-zone-id" ) -// Values returns all known values for LocationType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LocationType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LocationType) Values() []LocationType { return []LocationType{ "region", diff --git a/service/elasticloadbalancing/api_client.go b/service/elasticloadbalancing/api_client.go index c335aad25c2..fc4ba77a46c 100644 --- a/service/elasticloadbalancing/api_client.go +++ b/service/elasticloadbalancing/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticloadbalancing/api_op_AddTags.go b/service/elasticloadbalancing/api_op_AddTags.go index 754c15fc368..2298ef65987 100644 --- a/service/elasticloadbalancing/api_op_AddTags.go +++ b/service/elasticloadbalancing/api_op_AddTags.go @@ -14,8 +14,7 @@ import ( // Adds the specified tags to the specified load balancer. Each load balancer can // have a maximum of 10 tags. Each tag consists of a key and an optional value. If // a tag with the same key is already associated with the load balancer, AddTags -// updates its value. For more information, see Tag Your Classic Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) +// updates its value. For more information, see Tag Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) // in the Classic Load Balancers Guide. func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go index fc9bd1483f1..247d7deb2ea 100644 --- a/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go @@ -13,8 +13,7 @@ import ( // Associates one or more security groups with your load balancer in a virtual // private cloud (VPC). The specified security groups override the previously // associated security groups. For more information, see Security Groups for Load -// Balancers in a VPC -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups) +// Balancers in a VPC (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups) // in the Classic Load Balancers Guide. func (c *Client) ApplySecurityGroupsToLoadBalancer(ctx context.Context, params *ApplySecurityGroupsToLoadBalancerInput, optFns ...func(*Options)) (*ApplySecurityGroupsToLoadBalancerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go index 4c17cedb4d3..621be905376 100644 --- a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go +++ b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more subnets to the set of configured subnets for the specified load -// balancer. The load balancer evenly distributes requests across all registered -// subnets. For more information, see Add or Remove Subnets for Your Load Balancer -// in a VPC -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html) +// Adds one or more subnets to the set of configured subnets for the specified +// load balancer. The load balancer evenly distributes requests across all +// registered subnets. For more information, see Add or Remove Subnets for Your +// Load Balancer in a VPC (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html) // in the Classic Load Balancers Guide. func (c *Client) AttachLoadBalancerToSubnets(ctx context.Context, params *AttachLoadBalancerToSubnetsInput, optFns ...func(*Options)) (*AttachLoadBalancerToSubnetsOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go b/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go index 1c0151f442e..c530900f815 100644 --- a/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go +++ b/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go @@ -13,8 +13,7 @@ import ( // Specifies the health check settings to use when evaluating the health state of // your EC2 instances. For more information, see Configure Health Checks for Your -// Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html) +// Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html) // in the Classic Load Balancers Guide. func (c *Client) ConfigureHealthCheck(ctx context.Context, params *ConfigureHealthCheckInput, optFns ...func(*Options)) (*ConfigureHealthCheckOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go b/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go index ee219be625f..bbadfbd35c2 100644 --- a/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go @@ -13,14 +13,14 @@ import ( // Generates a stickiness policy with sticky session lifetimes that follow that of // an application-generated cookie. This policy can be associated only with // HTTP/HTTPS listeners. This policy is similar to the policy created by -// CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic -// Load Balancing cookie, AWSELB, follows the lifetime of the application-generated -// cookie specified in the policy configuration. The load balancer only inserts a -// new stickiness cookie when the application response includes a new application -// cookie. If the application cookie is explicitly removed or expires, the session -// stops being sticky until a new application cookie is issued. For more -// information, see Application-Controlled Session Stickiness -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) +// CreateLBCookieStickinessPolicy , except that the lifetime of the special Elastic +// Load Balancing cookie, AWSELB , follows the lifetime of the +// application-generated cookie specified in the policy configuration. The load +// balancer only inserts a new stickiness cookie when the application response +// includes a new application cookie. If the application cookie is explicitly +// removed or expires, the session stops being sticky until a new application +// cookie is issued. For more information, see Application-Controlled Session +// Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) // in the Classic Load Balancers Guide. func (c *Client) CreateAppCookieStickinessPolicy(ctx context.Context, params *CreateAppCookieStickinessPolicyInput, optFns ...func(*Options)) (*CreateAppCookieStickinessPolicyOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go index 815df8dbf34..8121489f847 100644 --- a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go @@ -21,8 +21,7 @@ import ( // load-balancing algorithm. A cookie is inserted into the response for binding // subsequent requests from the same user to that server. The validity of the // cookie is based on the cookie expiration time, which is specified in the policy -// configuration. For more information, see Duration-Based Session Stickiness -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration) +// configuration. For more information, see Duration-Based Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration) // in the Classic Load Balancers Guide. func (c *Client) CreateLBCookieStickinessPolicy(ctx context.Context, params *CreateLBCookieStickinessPolicyInput, optFns ...func(*Options)) (*CreateLBCookieStickinessPolicyOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go index 9455a00e233..31fd6e092e9 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go @@ -13,14 +13,13 @@ import ( // Creates a Classic Load Balancer. You can add listeners, security groups, // subnets, and tags when you create your load balancer, or you can add them later -// using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, -// AttachLoadBalancerToSubnets, and AddTags. To describe your current load -// balancers, see DescribeLoadBalancers. When you are finished with a load -// balancer, you can delete it using DeleteLoadBalancer. You can create up to 20 +// using CreateLoadBalancerListeners , ApplySecurityGroupsToLoadBalancer , +// AttachLoadBalancerToSubnets , and AddTags . To describe your current load +// balancers, see DescribeLoadBalancers . When you are finished with a load +// balancer, you can delete it using DeleteLoadBalancer . You can create up to 20 // load balancers per region per account. You can request an increase for the // number of load balancers for your account. For more information, see Limits for -// Your Classic Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) +// Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) // in the Classic Load Balancers Guide. func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error) { if params == nil { @@ -41,8 +40,7 @@ func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalan type CreateLoadBalancerInput struct { // The listeners. For more information, see Listeners for Your Classic Load - // Balancer - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) + // Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. // // This member is required. @@ -57,14 +55,13 @@ type CreateLoadBalancerInput struct { // One or more Availability Zones from the same region as the load balancer. You // must specify at least one Availability Zone. You can add more Availability Zones - // after you create the load balancer using EnableAvailabilityZonesForLoadBalancer. + // after you create the load balancer using EnableAvailabilityZonesForLoadBalancer . AvailabilityZones []string - // The type of a load balancer. Valid only for load balancers in a VPC. By default, - // Elastic Load Balancing creates an Internet-facing load balancer with a DNS name - // that resolves to public IP addresses. For more information about Internet-facing - // and Internal load balancers, see Load Balancer Scheme - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme) + // The type of a load balancer. Valid only for load balancers in a VPC. By + // default, Elastic Load Balancing creates an Internet-facing load balancer with a + // DNS name that resolves to public IP addresses. For more information about + // Internet-facing and Internal load balancers, see Load Balancer Scheme (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme) // in the Elastic Load Balancing User Guide. Specify internal to create a load // balancer with a DNS name that resolves to private IP addresses. Scheme *string @@ -73,12 +70,11 @@ type CreateLoadBalancerInput struct { SecurityGroups []string // The IDs of the subnets in your VPC to attach to the load balancer. Specify one - // subnet per Availability Zone specified in AvailabilityZones. + // subnet per Availability Zone specified in AvailabilityZones . Subnets []string // A list of tags to assign to the load balancer. For more information about - // tagging your load balancer, see Tag Your Classic Load Balancer - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) + // tagging your load balancer, see Tag Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) // in the Classic Load Balancers Guide. Tags []types.Tag diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go index 0878d3e4160..5c133f87cfc 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go @@ -14,8 +14,7 @@ import ( // Creates one or more listeners for the specified load balancer. If a listener // with the specified port does not already exist, it is created; otherwise, the // properties of the new listener must match the properties of the existing -// listener. For more information, see Listeners for Your Classic Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) +// listener. For more information, see Listeners for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. func (c *Client) CreateLoadBalancerListeners(ctx context.Context, params *CreateLoadBalancerListenersInput, optFns ...func(*Options)) (*CreateLoadBalancerListenersOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go b/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go index 3c85f328f0d..127dced17a3 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go @@ -44,7 +44,7 @@ type CreateLoadBalancerPolicyInput struct { PolicyName *string // The name of the base policy type. To get the list of policy types, use - // DescribeLoadBalancerPolicyTypes. + // DescribeLoadBalancerPolicyTypes . // // This member is required. PolicyTypeName *string diff --git a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go index ea18950a241..8ed1c6a21f8 100644 --- a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go @@ -15,8 +15,7 @@ import ( // instance is deregistered, it no longer receives traffic from the load balancer. // You can use DescribeLoadBalancers to verify that the instance is deregistered // from the load balancer. For more information, see Register or De-Register EC2 -// Instances -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) +// Instances (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) // in the Classic Load Balancers Guide. func (c *Client) DeregisterInstancesFromLoadBalancer(ctx context.Context, params *DeregisterInstancesFromLoadBalancerInput, optFns ...func(*Options)) (*DeregisterInstancesFromLoadBalancerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go index b3af7900980..f26ec63fe94 100644 --- a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go +++ b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go @@ -12,8 +12,7 @@ import ( ) // Describes the current Elastic Load Balancing resource limits for your AWS -// account. For more information, see Limits for Your Classic Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) +// account. For more information, see Limits for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) // in the Classic Load Balancers Guide. func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go b/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go index b1f29ba7b76..fc8b07c5e2f 100644 --- a/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go +++ b/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go @@ -147,9 +147,10 @@ type AnyInstanceInServiceWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AnyInstanceInServiceWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AnyInstanceInServiceWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go index 5022d042832..4bcd2826636 100644 --- a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go +++ b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go @@ -15,10 +15,10 @@ import ( // types. The description of each type indicates how it can be used. For example, // some policies can be used only with layer 7 listeners, some policies can be used // only with layer 4 listeners, and some policies can be used only with your EC2 -// instances. You can use CreateLoadBalancerPolicy to create a policy configuration -// for any of these policy types. Then, depending on the policy type, use either -// SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to -// set the policy. +// instances. You can use CreateLoadBalancerPolicy to create a policy +// configuration for any of these policy types. Then, depending on the policy type, +// use either SetLoadBalancerPoliciesOfListener or +// SetLoadBalancerPoliciesForBackendServer to set the policy. func (c *Client) DescribeLoadBalancerPolicyTypes(ctx context.Context, params *DescribeLoadBalancerPolicyTypesInput, optFns ...func(*Options)) (*DescribeLoadBalancerPolicyTypesOutput, error) { if params == nil { params = &DescribeLoadBalancerPolicyTypesInput{} diff --git a/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go b/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go index 9d1ebed3175..b6666a47f17 100644 --- a/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go +++ b/service/elasticloadbalancing/api_op_DescribeLoadBalancers.go @@ -39,8 +39,8 @@ type DescribeLoadBalancersInput struct { // previous call.) Marker *string - // The maximum number of results to return with this call (a number from 1 to 400). - // The default is 400. + // The maximum number of results to return with this call (a number from 1 to + // 400). The default is 400. PageSize *int32 noSmithyDocumentSerde diff --git a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go index fa60f2e0b30..4a15390b595 100644 --- a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go @@ -12,13 +12,12 @@ import ( // Removes the specified Availability Zones from the set of Availability Zones for // the specified load balancer in EC2-Classic or a default VPC. For load balancers -// in a non-default VPC, use DetachLoadBalancerFromSubnets. There must be at least +// in a non-default VPC, use DetachLoadBalancerFromSubnets . There must be at least // one Availability Zone registered with a load balancer at all times. After an // Availability Zone is removed, all instances registered with the load balancer // that are in the removed Availability Zone go into the OutOfService state. Then, // the load balancer attempts to equally balance the traffic among its remaining -// Availability Zones. For more information, see Add or Remove Availability Zones -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) +// Availability Zones. For more information, see Add or Remove Availability Zones (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) // in the Classic Load Balancers Guide. func (c *Client) DisableAvailabilityZonesForLoadBalancer(ctx context.Context, params *DisableAvailabilityZonesForLoadBalancerInput, optFns ...func(*Options)) (*DisableAvailabilityZonesForLoadBalancerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go b/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go index 97533fac423..9d6e36f7cd2 100644 --- a/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go @@ -12,10 +12,9 @@ import ( // Adds the specified Availability Zones to the set of Availability Zones for the // specified load balancer in EC2-Classic or a default VPC. For load balancers in a -// non-default VPC, use AttachLoadBalancerToSubnets. The load balancer evenly +// non-default VPC, use AttachLoadBalancerToSubnets . The load balancer evenly // distributes requests across all its registered Availability Zones that contain -// instances. For more information, see Add or Remove Availability Zones -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) +// instances. For more information, see Add or Remove Availability Zones (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) // in the Classic Load Balancers Guide. func (c *Client) EnableAvailabilityZonesForLoadBalancer(ctx context.Context, params *EnableAvailabilityZonesForLoadBalancerInput, optFns ...func(*Options)) (*EnableAvailabilityZonesForLoadBalancerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go index ed0b19ac0cd..2cb2f48653c 100644 --- a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go +++ b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go @@ -12,26 +12,15 @@ import ( ) // Modifies the attributes of the specified load balancer. You can modify the load -// balancer attributes, such as AccessLogs, ConnectionDraining, and +// balancer attributes, such as AccessLogs , ConnectionDraining , and // CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify // the load balancer attribute ConnectionSettings by specifying an idle connection // timeout value for your load balancer. For more information, see the following in // the Classic Load Balancers Guide: -// -// * Cross-Zone Load Balancing -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) -// -// * -// Connection Draining -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) -// -// * -// Access Logs -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html) -// -// * -// Idle Connection Timeout -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) +// - Cross-Zone Load Balancing (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) +// - Connection Draining (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) +// - Access Logs (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html) +// - Idle Connection Timeout (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) func (c *Client) ModifyLoadBalancerAttributes(ctx context.Context, params *ModifyLoadBalancerAttributesInput, optFns ...func(*Options)) (*ModifyLoadBalancerAttributesOutput, error) { if params == nil { params = &ModifyLoadBalancerAttributesInput{} diff --git a/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go b/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go index 6946220e2a3..21a4fc15573 100644 --- a/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go @@ -19,15 +19,14 @@ import ( // VPC. Note that RegisterInstanceWithLoadBalancer completes when the request has // been registered. Instance registration takes a little time to complete. To check // the state of the registered instances, use DescribeLoadBalancers or -// DescribeInstanceHealth. After the instance is registered, it starts receiving +// DescribeInstanceHealth . After the instance is registered, it starts receiving // traffic and requests from the load balancer. Any instance that is not in one of // the Availability Zones registered for the load balancer is moved to the // OutOfService state. If an Availability Zone is added to the load balancer later, // any instances registered with the load balancer move to the InService state. To // deregister instances from a load balancer, use -// DeregisterInstancesFromLoadBalancer. For more information, see Register or -// De-Register EC2 Instances -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) +// DeregisterInstancesFromLoadBalancer . For more information, see Register or +// De-Register EC2 Instances (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) // in the Classic Load Balancers Guide. func (c *Client) RegisterInstancesWithLoadBalancer(ctx context.Context, params *RegisterInstancesWithLoadBalancerInput, optFns ...func(*Options)) (*RegisterInstancesWithLoadBalancerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go index ab7aa10ac7e..7e9bd6de47c 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go @@ -13,8 +13,7 @@ import ( // Sets the certificate that terminates the specified listener's SSL connections. // The specified certificate replaces any prior certificate that was used on the // same load balancer and port. For more information about updating your SSL -// certificate, see Replace the SSL Certificate for Your Load Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html) +// certificate, see Replace the SSL Certificate for Your Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html) // in the Classic Load Balancers Guide. func (c *Client) SetLoadBalancerListenerSSLCertificate(ctx context.Context, params *SetLoadBalancerListenerSSLCertificateInput, optFns ...func(*Options)) (*SetLoadBalancerListenerSSLCertificateOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go index d7d21dc7a8f..827321ca295 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go @@ -10,19 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replaces the set of policies associated with the specified port on which the EC2 -// instance is listening with a new set of policies. At this time, only the +// Replaces the set of policies associated with the specified port on which the +// EC2 instance is listening with a new set of policies. At this time, only the // back-end server authentication policy type can be applied to the instance ports; // this policy type is composed of multiple public key policies. Each time you use // SetLoadBalancerPoliciesForBackendServer to enable the policies, use the // PolicyNames parameter to list the policies that you want to enable. You can use // DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy // is associated with the EC2 instance. For more information about enabling -// back-end instance authentication, see Configure Back-end Instance Authentication -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt) +// back-end instance authentication, see Configure Back-end Instance Authentication (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt) // in the Classic Load Balancers Guide. For more information about Proxy Protocol, -// see Configure Proxy Protocol Support -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html) +// see Configure Proxy Protocol Support (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html) // in the Classic Load Balancers Guide. func (c *Client) SetLoadBalancerPoliciesForBackendServer(ctx context.Context, params *SetLoadBalancerPoliciesForBackendServerInput, optFns ...func(*Options)) (*SetLoadBalancerPoliciesForBackendServerOutput, error) { if params == nil { diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go index ed0fe16a08d..e48651ebbaf 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go @@ -12,13 +12,10 @@ import ( // Replaces the current set of policies for the specified load balancer port with // the specified set of policies. To enable back-end server authentication, use -// SetLoadBalancerPoliciesForBackendServer. For more information about setting -// policies, see Update the SSL Negotiation Configuration -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html), -// Duration-Based Session Stickiness -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration), -// and Application-Controlled Session Stickiness -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) +// SetLoadBalancerPoliciesForBackendServer . For more information about setting +// policies, see Update the SSL Negotiation Configuration (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html) +// , Duration-Based Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration) +// , and Application-Controlled Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) // in the Classic Load Balancers Guide. func (c *Client) SetLoadBalancerPoliciesOfListener(ctx context.Context, params *SetLoadBalancerPoliciesOfListenerInput, optFns ...func(*Options)) (*SetLoadBalancerPoliciesOfListenerOutput, error) { if params == nil { @@ -48,8 +45,8 @@ type SetLoadBalancerPoliciesOfListenerInput struct { // This member is required. LoadBalancerPort int32 - // The names of the policies. This list must include all policies to be enabled. If - // you omit a policy that is currently enabled, it is disabled. If the list is + // The names of the policies. This list must include all policies to be enabled. + // If you omit a policy that is currently enabled, it is disabled. If the list is // empty, all current policies are disabled. // // This member is required. diff --git a/service/elasticloadbalancing/doc.go b/service/elasticloadbalancing/doc.go index f8a6781234f..9027b14ce71 100644 --- a/service/elasticloadbalancing/doc.go +++ b/service/elasticloadbalancing/doc.go @@ -14,12 +14,12 @@ // supports three types of load balancers: Application Load Balancers, Network Load // Balancers, and Classic Load Balancers. You can select a load balancer based on // your application needs. For more information, see the Elastic Load Balancing -// User Guide (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/). -// This reference covers the 2012-06-01 API, which supports Classic Load Balancers. -// The 2015-12-01 API supports Application Load Balancers and Network Load -// Balancers. To get started, create a load balancer with one or more listeners -// using CreateLoadBalancer. Register your instances with the load balancer using -// RegisterInstancesWithLoadBalancer. All Elastic Load Balancing operations are -// idempotent, which means that they complete at most one time. If you repeat an -// operation, it succeeds with a 200 OK response code. +// User Guide (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/) +// . This reference covers the 2012-06-01 API, which supports Classic Load +// Balancers. The 2015-12-01 API supports Application Load Balancers and Network +// Load Balancers. To get started, create a load balancer with one or more +// listeners using CreateLoadBalancer . Register your instances with the load +// balancer using RegisterInstancesWithLoadBalancer . All Elastic Load Balancing +// operations are idempotent, which means that they complete at most one time. If +// you repeat an operation, it succeeds with a 200 OK response code. package elasticloadbalancing diff --git a/service/elasticloadbalancing/types/types.go b/service/elasticloadbalancing/types/types.go index 93e048546f3..155a82caf5f 100644 --- a/service/elasticloadbalancing/types/types.go +++ b/service/elasticloadbalancing/types/types.go @@ -23,7 +23,7 @@ type AccessLog struct { S3BucketName *string // The logical hierarchy you created for your Amazon S3 bucket, for example - // my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the + // my-bucket-prefix/prod . If the prefix is not provided, the log is placed at the // root level of the bucket. S3BucketPrefix *string @@ -34,11 +34,9 @@ type AccessLog struct { type AdditionalAttribute struct { // The name of the attribute. The following attribute is supported. - // - // * - // elb.http.desyncmitigationmode - Determines how the load balancer handles - // requests that might pose a security risk to your application. The possible - // values are monitor, defensive, and strictest. The default is defensive. + // - elb.http.desyncmitigationmode - Determines how the load balancer handles + // requests that might pose a security risk to your application. The possible + // values are monitor , defensive , and strictest . The default is defensive . Key *string // This value of the attribute. @@ -53,8 +51,8 @@ type AppCookieStickinessPolicy struct { // The name of the application cookie used for stickiness. CookieName *string - // The mnemonic name for the policy being created. The name must be unique within a - // set of policies for this load balancer. + // The mnemonic name for the policy being created. The name must be unique within + // a set of policies for this load balancer. PolicyName *string noSmithyDocumentSerde @@ -125,9 +123,9 @@ type HealthCheck struct { // This member is required. Interval int32 - // The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The - // range of valid ports is one (1) through 65535. TCP is the default, specified as - // a TCP: port pair, for example "TCP:5000". In this case, a health check simply + // The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. + // The range of valid ports is one (1) through 65535. TCP is the default, specified + // as a TCP: port pair, for example "TCP:5000". In this case, a health check simply // attempts to open a TCP connection to the instance on the specified port. Failure // to connect within the configured timeout is considered unhealthy. SSL is also // specified as SSL: port pair, for example, SSL:5000. For HTTP/HTTPS, you must @@ -170,46 +168,29 @@ type InstanceState struct { // A description of the instance state. This string can contain one or more of the // following messages. - // - // * N/A - // - // * A transient error occurred. Please try again - // later. - // - // * Instance has failed at least the UnhealthyThreshold number of health - // checks consecutively. - // - // * Instance has not passed the configured HealthyThreshold - // number of health checks consecutively. - // - // * Instance registration is still in - // progress. - // - // * Instance is in the EC2 Availability Zone for which LoadBalancer is - // not configured to route traffic to. - // - // * Instance is not currently registered with - // the LoadBalancer. - // - // * Instance deregistration currently in progress. - // - // * Disable - // Availability Zone is currently in progress. - // - // * Instance is in pending state. - // - // * - // Instance is in stopped state. - // - // * Instance is in terminated state. + // - N/A + // - A transient error occurred. Please try again later. + // - Instance has failed at least the UnhealthyThreshold number of health checks + // consecutively. + // - Instance has not passed the configured HealthyThreshold number of health + // checks consecutively. + // - Instance registration is still in progress. + // - Instance is in the EC2 Availability Zone for which LoadBalancer is not + // configured to route traffic to. + // - Instance is not currently registered with the LoadBalancer. + // - Instance deregistration currently in progress. + // - Disable Availability Zone is currently in progress. + // - Instance is in pending state. + // - Instance is in stopped state. + // - Instance is in terminated state. Description *string // The ID of the instance. InstanceId *string - // Information about the cause of OutOfService instances. Specifically, whether the - // cause is Elastic Load Balancing or the instance. Valid values: ELB | Instance | - // N/A + // Information about the cause of OutOfService instances. Specifically, whether + // the cause is Elastic Load Balancing or the instance. Valid values: ELB | + // Instance | N/A ReasonCode *string // The current state of the instance. Valid values: InService | OutOfService | @@ -241,13 +222,9 @@ type Limit struct { Max *string // The name of the limit. The possible values are: - // - // * classic-listeners - // - // * - // classic-load-balancers - // - // * classic-registered-instances + // - classic-listeners + // - classic-load-balancers + // - classic-registered-instances Name *string noSmithyDocumentSerde @@ -255,8 +232,7 @@ type Limit struct { // Information about a listener. For information about the protocols and the ports // supported by Elastic Load Balancing, see Listeners for Your Classic Load -// Balancer -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) +// Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. type Listener struct { @@ -282,10 +258,10 @@ type Listener struct { // If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or // SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be // HTTP or HTTPS. If there is another listener with the same InstancePort whose - // InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must - // also be secure. If there is another listener with the same InstancePort whose - // InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or - // TCP. + // InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol + // must also be secure. If there is another listener with the same InstancePort + // whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be + // HTTP or TCP. InstanceProtocol *string // The Amazon Resource Name (ARN) of the server certificate. @@ -311,8 +287,7 @@ type LoadBalancerAttributes struct { // If enabled, the load balancer captures detailed information of all requests and // delivers the information to the Amazon S3 bucket that you specify. For more - // information, see Enable Access Logs - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html) + // information, see Enable Access Logs (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html) // in the Classic Load Balancers Guide. AccessLog *AccessLog @@ -321,8 +296,7 @@ type LoadBalancerAttributes struct { // If enabled, the load balancer allows existing requests to complete before the // load balancer shifts traffic away from a deregistered or unhealthy instance. For - // more information, see Configure Connection Draining - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) + // more information, see Configure Connection Draining (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) // in the Classic Load Balancers Guide. ConnectionDraining *ConnectionDraining @@ -330,15 +304,13 @@ type LoadBalancerAttributes struct { // sent over the connection) for the specified duration. By default, Elastic Load // Balancing maintains a 60-second idle connection timeout for both front-end and // back-end connections of your load balancer. For more information, see Configure - // Idle Connection Timeout - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) + // Idle Connection Timeout (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) // in the Classic Load Balancers Guide. ConnectionSettings *ConnectionSettings // If enabled, the load balancer routes the request traffic evenly across all // instances regardless of the Availability Zones. For more information, see - // Configure Cross-Zone Load Balancing - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) + // Configure Cross-Zone Load Balancing (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) // in the Classic Load Balancers Guide. CrossZoneLoadBalancing *CrossZoneLoadBalancing @@ -355,8 +327,7 @@ type LoadBalancerDescription struct { BackendServerDescriptions []BackendServerDescription // The DNS name of the load balancer. For more information, see Configure a Custom - // Domain Name - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) + // Domain Name (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) // in the Classic Load Balancers Guide. CanonicalHostedZoneName *string @@ -385,8 +356,8 @@ type LoadBalancerDescription struct { Policies *Policies // The type of load balancer. Valid only for load balancers in a VPC. If Scheme is - // internet-facing, the load balancer has a public DNS name that resolves to a - // public IP address. If Scheme is internal, the load balancer has a public DNS + // internet-facing , the load balancer has a public DNS name that resolves to a + // public IP address. If Scheme is internal , the load balancer has a public DNS // name that resolves to a private IP address. Scheme *string @@ -412,10 +383,10 @@ type LoadBalancerDescription struct { // The policies for a load balancer. type Policies struct { - // The stickiness policies created using CreateAppCookieStickinessPolicy. + // The stickiness policies created using CreateAppCookieStickinessPolicy . AppCookieStickinessPolicies []AppCookieStickinessPolicy - // The stickiness policies created using CreateLBCookieStickinessPolicy. + // The stickiness policies created using CreateLBCookieStickinessPolicy . LBCookieStickinessPolicies []LBCookieStickinessPolicy // The policies other than the stickiness policies. @@ -454,21 +425,14 @@ type PolicyAttributeTypeDescription struct { // The name of the attribute. AttributeName *string - // The type of the attribute. For example, Boolean or Integer. + // The type of the attribute. For example, Boolean or Integer . AttributeType *string // The cardinality of the attribute. Valid values: - // - // * ONE(1) : Single value - // required - // - // * ZERO_OR_ONE(0..1) : Up to one value is allowed - // - // * ZERO_OR_MORE(0..*) - // : Optional. Multiple values are allowed - // - // * ONE_OR_MORE(1..*0) : Required. - // Multiple values are allowed + // - ONE(1) : Single value required + // - ZERO_OR_ONE(0..1) : Up to one value is allowed + // - ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed + // - ONE_OR_MORE(1..*0) : Required. Multiple values are allowed Cardinality *string // The default value of the attribute, if applicable. @@ -501,8 +465,8 @@ type PolicyTypeDescription struct { // A description of the policy type. Description *string - // The description of the policy attributes associated with the policies defined by - // Elastic Load Balancing. + // The description of the policy attributes associated with the policies defined + // by Elastic Load Balancing. PolicyAttributeTypeDescriptions []PolicyAttributeTypeDescription // The name of the policy type. diff --git a/service/elasticloadbalancingv2/api_client.go b/service/elasticloadbalancingv2/api_client.go index 957e0e0fc8d..556e7d5d155 100644 --- a/service/elasticloadbalancingv2/api_client.go +++ b/service/elasticloadbalancingv2/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go index b5aaa716453..f187addc55d 100644 --- a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go @@ -14,10 +14,8 @@ import ( // Adds the specified SSL server certificate to the certificate list for the // specified HTTPS or TLS listener. If the certificate in already in the // certificate list, the call is successful but the certificate is not added again. -// For more information, see HTTPS listeners -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html) -// in the Application Load Balancers Guide or TLS listeners -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) +// For more information, see HTTPS listeners (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html) +// in the Application Load Balancers Guide or TLS listeners (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) // in the Network Load Balancers Guide. func (c *Client) AddListenerCertificates(ctx context.Context, params *AddListenerCertificatesInput, optFns ...func(*Options)) (*AddListenerCertificatesOutput, error) { if params == nil { @@ -37,7 +35,7 @@ func (c *Client) AddListenerCertificates(ctx context.Context, params *AddListene type AddListenerCertificatesInput struct { // The certificate to add. You can specify one certificate per call. Set - // CertificateArn to the certificate ARN but do not set IsDefault. + // CertificateArn to the certificate ARN but do not set IsDefault . // // This member is required. Certificates []types.Certificate diff --git a/service/elasticloadbalancingv2/api_op_CreateListener.go b/service/elasticloadbalancingv2/api_op_CreateListener.go index 76d9dad809b..304f30cb065 100644 --- a/service/elasticloadbalancingv2/api_op_CreateListener.go +++ b/service/elasticloadbalancingv2/api_op_CreateListener.go @@ -13,22 +13,13 @@ import ( // Creates a listener for the specified Application Load Balancer, Network Load // Balancer, or Gateway Load Balancer. For more information, see the following: +// - Listeners for your Application Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html) +// - Listeners for your Network Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html) +// - Listeners for your Gateway Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-listeners.html) // -// * -// Listeners for your Application Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html) -// -// * -// Listeners for your Network Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html) -// -// * -// Listeners for your Gateway Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-listeners.html) -// -// This -// operation is idempotent, which means that it completes at most one time. If you -// attempt to create multiple listeners with the same settings, each call succeeds. +// This operation is idempotent, which means that it completes at most one time. +// If you attempt to create multiple listeners with the same settings, each call +// succeeds. func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error) { if params == nil { params = &CreateListenerInput{} @@ -57,28 +48,19 @@ type CreateListenerInput struct { LoadBalancerArn *string // [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) - // policy. You can specify one policy name. The following are the possible - // values: - // - // * HTTP1Only - // - // * HTTP2Only - // - // * HTTP2Optional - // - // * HTTP2Preferred - // - // * - // None - // - // For more information, see ALPN policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) + // policy. You can specify one policy name. The following are the possible values: + // - HTTP1Only + // - HTTP2Only + // - HTTP2Optional + // - HTTP2Preferred + // - None + // For more information, see ALPN policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) // in the Network Load Balancers Guide. AlpnPolicy []string // [HTTPS and TLS listeners] The default certificate for the listener. You must // provide exactly one certificate. Set CertificateArn to the certificate ARN but - // do not set IsDefault. + // do not set IsDefault . Certificates []types.Certificate // The port on which the load balancer is listening. You cannot specify a port for @@ -93,10 +75,8 @@ type CreateListenerInput struct { Protocol types.ProtocolEnum // [HTTPS and TLS listeners] The security policy that defines which protocols and - // ciphers are supported. For more information, see Security policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) - // in the Application Load Balancers Guide and Security policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) + // ciphers are supported. For more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) + // in the Application Load Balancers Guide and Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) // in the Network Load Balancers Guide. SslPolicy *string diff --git a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go index 830b12fe339..ab579aa448d 100644 --- a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go @@ -13,22 +13,13 @@ import ( // Creates an Application Load Balancer, Network Load Balancer, or Gateway Load // Balancer. For more information, see the following: +// - Application Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html) +// - Network Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html) +// - Gateway Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html) // -// * Application Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html) -// -// * -// Network Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html) -// -// * -// Gateway Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html) -// -// This -// operation is idempotent, which means that it completes at most one time. If you -// attempt to create multiple load balancers with the same settings, each call -// succeeds. +// This operation is idempotent, which means that it completes at most one time. +// If you attempt to create multiple load balancers with the same settings, each +// call succeeds. func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error) { if params == nil { params = &CreateLoadBalancerInput{} @@ -108,7 +99,7 @@ type CreateLoadBalancerInput struct { // The tags to assign to the load balancer. Tags []types.Tag - // The type of load balancer. The default is application. + // The type of load balancer. The default is application . Type types.LoadBalancerTypeEnum noSmithyDocumentSerde diff --git a/service/elasticloadbalancingv2/api_op_CreateRule.go b/service/elasticloadbalancingv2/api_op_CreateRule.go index 9947592b9bd..22bd7be96f3 100644 --- a/service/elasticloadbalancingv2/api_op_CreateRule.go +++ b/service/elasticloadbalancingv2/api_op_CreateRule.go @@ -16,8 +16,7 @@ import ( // actions, and one or more conditions. Rules are evaluated in priority order, from // the lowest value to the highest value. When the conditions for a rule are met, // its actions are performed. If the conditions for no rules are met, the actions -// for the default rule are performed. For more information, see Listener rules -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules) +// for the default rule are performed. For more information, see Listener rules (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules) // in the Application Load Balancers Guide. func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { diff --git a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go index 272117faec9..e0183e677ca 100644 --- a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go @@ -12,23 +12,13 @@ import ( ) // Creates a target group. For more information, see the following: +// - Target groups for your Application Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) +// - Target groups for your Network Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html) +// - Target groups for your Gateway Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html) // -// * Target -// groups for your Application Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) -// -// * -// Target groups for your Network Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html) -// -// * -// Target groups for your Gateway Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html) -// -// This -// operation is idempotent, which means that it completes at most one time. If you -// attempt to create multiple target groups with the same settings, each call -// succeeds. +// This operation is idempotent, which means that it completes at most one time. +// If you attempt to create multiple target groups with the same settings, each +// call succeeds. func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGroupInput, optFns ...func(*Options)) (*CreateTargetGroupOutput, error) { if params == nil { params = &CreateTargetGroupInput{} @@ -53,16 +43,16 @@ type CreateTargetGroupInput struct { // This member is required. Name *string - // Indicates whether health checks are enabled. If the target type is lambda, + // Indicates whether health checks are enabled. If the target type is lambda , // health checks are disabled by default but can be enabled. If the target type is - // instance, ip, or alb, health checks are always enabled and cannot be disabled. + // instance , ip , or alb , health checks are always enabled and cannot be disabled. HealthCheckEnabled *bool // The approximate amount of time, in seconds, between health checks of an // individual target. The range is 5-300. If the target group protocol is TCP, TLS, // UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group - // protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the - // default is 35 seconds. + // protocol is GENEVE, the default is 10 seconds. If the target type is lambda , + // the default is 35 seconds. HealthCheckIntervalSeconds *int32 // [HTTP/HTTPS health checks] The destination for health checks on the targets. @@ -71,10 +61,10 @@ type CreateTargetGroupInput struct { // /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. HealthCheckPath *string - // The port the load balancer uses when performing health checks on targets. If the - // protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, - // which is the port on which each target receives traffic from the load balancer. - // If the protocol is GENEVE, the default is port 80. + // The port the load balancer uses when performing health checks on targets. If + // the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is + // traffic-port , which is the port on which each target receives traffic from the + // load balancer. If the protocol is GENEVE, the default is port 80. HealthCheckPort *string // The protocol the load balancer uses when performing health checks on targets. @@ -89,19 +79,19 @@ type CreateTargetGroupInput struct { // failed health check. The range is 2–120 seconds. For target groups with a // protocol of HTTP, the default is 6 seconds. For target groups with a protocol of // TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol - // of GENEVE, the default is 5 seconds. If the target type is lambda, the default + // of GENEVE, the default is 5 seconds. If the target type is lambda , the default // is 30 seconds. HealthCheckTimeoutSeconds *int32 // The number of consecutive health check successes required before considering a // target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, // UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of - // GENEVE, the default is 5. If the target type is lambda, the default is 5. + // GENEVE, the default is 5. If the target type is lambda , the default is 5. HealthyThresholdCount *int32 // The type of IP address used for this target group. The possible values are ipv4 - // and ipv6. This is an optional parameter. If not specified, the IP address type - // defaults to ipv4. + // and ipv6 . This is an optional parameter. If not specified, the IP address type + // defaults to ipv4 . IpAddressType types.TargetGroupIpAddressTypeEnum // [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a @@ -127,7 +117,7 @@ type CreateTargetGroupInput struct { // [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send requests to // targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The - // default is HTTP1, which sends requests to targets using HTTP/1.1. + // default is HTTP1 , which sends requests to targets using HTTP/1.1. ProtocolVersion *string // The tags to assign to the target group. @@ -136,26 +126,19 @@ type CreateTargetGroupInput struct { // The type of target that you must specify when registering targets with this // target group. You can't specify targets for a target group using more than one // target type. - // - // * instance - Register targets by instance ID. This is the default - // value. - // - // * ip - Register targets by IP address. You can specify IP addresses from - // the subnets of the virtual private cloud (VPC) for the target group, the RFC - // 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 - // range (100.64.0.0/10). You can't specify publicly routable IP addresses. - // - // * - // lambda - Register a single Lambda function as a target. - // - // * alb - Register a - // single Application Load Balancer as a target. + // - instance - Register targets by instance ID. This is the default value. + // - ip - Register targets by IP address. You can specify IP addresses from the + // subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 + // range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range + // (100.64.0.0/10). You can't specify publicly routable IP addresses. + // - lambda - Register a single Lambda function as a target. + // - alb - Register a single Application Load Balancer as a target. TargetType types.TargetTypeEnum // The number of consecutive health check failures required before considering a // target unhealthy. The range is 2-10. If the target group protocol is TCP, // TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a - // protocol of GENEVE, the default is 2. If the target type is lambda, the default + // protocol of GENEVE, the default is 2. If the target type is lambda , the default // is 5. UnhealthyThresholdCount *int32 diff --git a/service/elasticloadbalancingv2/api_op_DeleteListener.go b/service/elasticloadbalancingv2/api_op_DeleteListener.go index 509aa5cfc40..f5220bdab06 100644 --- a/service/elasticloadbalancingv2/api_op_DeleteListener.go +++ b/service/elasticloadbalancingv2/api_op_DeleteListener.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified listener. Alternatively, your listener is deleted when you -// delete the load balancer to which it is attached. +// Deletes the specified listener. Alternatively, your listener is deleted when +// you delete the load balancer to which it is attached. func (c *Client) DeleteListener(ctx context.Context, params *DeleteListenerInput, optFns ...func(*Options)) (*DeleteListenerOutput, error) { if params == nil { params = &DeleteListenerInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go b/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go index da2a099ffbe..04fe5551067 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go +++ b/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go @@ -11,20 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the current Elastic Load Balancing resource limits for your Amazon Web -// Services account. For more information, see the following: -// -// * Quotas for your -// Application Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) -// -// * -// Quotas for your Network Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html) -// -// * -// Quotas for your Gateway Load Balancers -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/quotas-limits.html) +// Describes the current Elastic Load Balancing resource limits for your Amazon +// Web Services account. For more information, see the following: +// - Quotas for your Application Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) +// - Quotas for your Network Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html) +// - Quotas for your Gateway Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/quotas-limits.html) func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} @@ -57,8 +48,8 @@ type DescribeAccountLimitsOutput struct { // Information about the limits. Limits []types.Limit - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Metadata pertaining to the operation's result. diff --git a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go index a164b15651a..463b0077084 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go @@ -14,10 +14,8 @@ import ( // Describes the default certificate and the certificate list for the specified // HTTPS or TLS listener. If the default certificate is also in the certificate // list, it appears twice in the results (once with IsDefault set to true and once -// with IsDefault set to false). For more information, see SSL certificates -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates) -// in the Application Load Balancers Guide or Server certificates -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#tls-listener-certificate) +// with IsDefault set to false). For more information, see SSL certificates (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates) +// in the Application Load Balancers Guide or Server certificates (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#tls-listener-certificate) // in the Network Load Balancers Guide. func (c *Client) DescribeListenerCertificates(ctx context.Context, params *DescribeListenerCertificatesInput, optFns ...func(*Options)) (*DescribeListenerCertificatesOutput, error) { if params == nil { @@ -56,8 +54,8 @@ type DescribeListenerCertificatesOutput struct { // Information about the certificates. Certificates []types.Certificate - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Metadata pertaining to the operation's result. diff --git a/service/elasticloadbalancingv2/api_op_DescribeListeners.go b/service/elasticloadbalancingv2/api_op_DescribeListeners.go index e65dff37e30..23ce03afc39 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeListeners.go +++ b/service/elasticloadbalancingv2/api_op_DescribeListeners.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified listeners or the listeners for the specified Application -// Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify -// either a load balancer or one or more listeners. +// Describes the specified listeners or the listeners for the specified +// Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You +// must specify either a load balancer or one or more listeners. func (c *Client) DescribeListeners(ctx context.Context, params *DescribeListenersInput, optFns ...func(*Options)) (*DescribeListenersOutput, error) { if params == nil { params = &DescribeListenersInput{} @@ -53,8 +53,8 @@ type DescribeListenersOutput struct { // Information about the listeners. Listeners []types.Listener - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Metadata pertaining to the operation's result. diff --git a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go index 3e08d5c2a4d..26fc84d6fed 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go +++ b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go @@ -14,18 +14,12 @@ import ( // Describes the attributes for the specified Application Load Balancer, Network // Load Balancer, or Gateway Load Balancer. For more information, see the // following: -// -// * Load balancer attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes) -// in the Application Load Balancers Guide -// -// * Load balancer attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#load-balancer-attributes) -// in the Network Load Balancers Guide -// -// * Load balancer attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html#load-balancer-attributes) -// in the Gateway Load Balancers Guide +// - Load balancer attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes) +// in the Application Load Balancers Guide +// - Load balancer attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#load-balancer-attributes) +// in the Network Load Balancers Guide +// - Load balancer attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html#load-balancer-attributes) +// in the Gateway Load Balancers Guide func (c *Client) DescribeLoadBalancerAttributes(ctx context.Context, params *DescribeLoadBalancerAttributesInput, optFns ...func(*Options)) (*DescribeLoadBalancerAttributesOutput, error) { if params == nil { params = &DescribeLoadBalancerAttributesInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go index a31ce49b424..1a1a5109f96 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go +++ b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go @@ -58,8 +58,8 @@ type DescribeLoadBalancersOutput struct { // Information about the load balancers. LoadBalancers []types.LoadBalancer - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Metadata pertaining to the operation's result. @@ -221,9 +221,10 @@ type LoadBalancerAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LoadBalancerAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LoadBalancerAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -432,8 +433,8 @@ type LoadBalancerExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LoadBalancerExistsWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LoadBalancerExistsWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -592,9 +593,10 @@ type LoadBalancersDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LoadBalancersDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LoadBalancersDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/elasticloadbalancingv2/api_op_DescribeRules.go b/service/elasticloadbalancingv2/api_op_DescribeRules.go index 04809691f8a..3960f553c56 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeRules.go +++ b/service/elasticloadbalancingv2/api_op_DescribeRules.go @@ -48,8 +48,8 @@ type DescribeRulesInput struct { type DescribeRulesOutput struct { - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Information about the rules. diff --git a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go index 20597597d3d..fc62c8e8867 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go +++ b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go @@ -12,10 +12,8 @@ import ( ) // Describes the specified policies or all policies used for SSL negotiation. For -// more information, see Security policies -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) -// in the Application Load Balancers Guide or Security policies -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) +// more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) +// in the Application Load Balancers Guide or Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) // in the Network Load Balancers Guide. func (c *Client) DescribeSSLPolicies(ctx context.Context, params *DescribeSSLPoliciesInput, optFns ...func(*Options)) (*DescribeSSLPoliciesOutput, error) { if params == nil { @@ -53,8 +51,8 @@ type DescribeSSLPoliciesInput struct { type DescribeSSLPoliciesOutput struct { - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Information about the security policies. diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go b/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go index f89300f6830..a53d49344ed 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go @@ -13,18 +13,12 @@ import ( // Describes the attributes for the specified target group. For more information, // see the following: -// -// * Target group attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes) -// in the Application Load Balancers Guide -// -// * Target group attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-group-attributes) -// in the Network Load Balancers Guide -// -// * Target group attributes -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#target-group-attributes) -// in the Gateway Load Balancers Guide +// - Target group attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes) +// in the Application Load Balancers Guide +// - Target group attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-group-attributes) +// in the Network Load Balancers Guide +// - Target group attributes (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#target-group-attributes) +// in the Gateway Load Balancers Guide func (c *Client) DescribeTargetGroupAttributes(ctx context.Context, params *DescribeTargetGroupAttributesInput, optFns ...func(*Options)) (*DescribeTargetGroupAttributesOutput, error) { if params == nil { params = &DescribeTargetGroupAttributesInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go b/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go index ddc87329b30..1de1aa1471c 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetGroups.go @@ -54,8 +54,8 @@ type DescribeTargetGroupsInput struct { type DescribeTargetGroupsOutput struct { - // If there are additional results, this is the marker for the next set of results. - // Otherwise, this is null. + // If there are additional results, this is the marker for the next set of + // results. Otherwise, this is null. NextMarker *string // Information about the target groups. diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go index adc169fac11..ead60e25f7f 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go @@ -142,8 +142,8 @@ type TargetDeregisteredWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TargetDeregisteredWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TargetDeregisteredWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -329,9 +329,9 @@ type TargetInServiceWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TargetInServiceWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TargetInServiceWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -371,9 +371,9 @@ func NewTargetInServiceWaiter(client DescribeTargetHealthAPIClient, optFns ...fu } } -// Wait calls the waiter function for TargetInService waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for TargetInService waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *TargetInServiceWaiter) Wait(ctx context.Context, params *DescribeTargetHealthInput, maxWaitDur time.Duration, optFns ...func(*TargetInServiceWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/elasticloadbalancingv2/api_op_ModifyListener.go b/service/elasticloadbalancingv2/api_op_ModifyListener.go index a5108e86c3a..124e37f5c78 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyListener.go +++ b/service/elasticloadbalancingv2/api_op_ModifyListener.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replaces the specified properties of the specified listener. Any properties that -// you do not specify remain unchanged. Changing the protocol from HTTPS to HTTP, -// or from TLS to TCP, removes the security policy and default certificate +// Replaces the specified properties of the specified listener. Any properties +// that you do not specify remain unchanged. Changing the protocol from HTTPS to +// HTTP, or from TLS to TCP, removes the security policy and default certificate // properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, // you must add the security policy and default certificate properties. To add an // item to a list, remove an item from a list, or update an item in a list, you @@ -42,49 +42,38 @@ type ModifyListenerInput struct { ListenerArn *string // [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) - // policy. You can specify one policy name. The following are the possible - // values: - // - // * HTTP1Only - // - // * HTTP2Only - // - // * HTTP2Optional - // - // * HTTP2Preferred - // - // * - // None - // - // For more information, see ALPN policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) + // policy. You can specify one policy name. The following are the possible values: + // - HTTP1Only + // - HTTP2Only + // - HTTP2Optional + // - HTTP2Preferred + // - None + // For more information, see ALPN policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies) // in the Network Load Balancers Guide. AlpnPolicy []string // [HTTPS and TLS listeners] The default certificate for the listener. You must // provide exactly one certificate. Set CertificateArn to the certificate ARN but - // do not set IsDefault. + // do not set IsDefault . Certificates []types.Certificate // The actions for the default rule. DefaultActions []types.Action - // The port for connections from clients to the load balancer. You cannot specify a - // port for a Gateway Load Balancer. + // The port for connections from clients to the load balancer. You cannot specify + // a port for a Gateway Load Balancer. Port *int32 - // The protocol for connections from clients to the load balancer. Application Load - // Balancers support the HTTP and HTTPS protocols. Network Load Balancers support - // the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP - // or TCP_UDP if dual-stack mode is enabled. You cannot specify a protocol for a - // Gateway Load Balancer. + // The protocol for connections from clients to the load balancer. Application + // Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers + // support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol + // to UDP or TCP_UDP if dual-stack mode is enabled. You cannot specify a protocol + // for a Gateway Load Balancer. Protocol types.ProtocolEnum // [HTTPS and TLS listeners] The security policy that defines which protocols and - // ciphers are supported. For more information, see Security policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) - // in the Application Load Balancers Guide or Security policies - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) + // ciphers are supported. For more information, see Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) + // in the Application Load Balancers Guide or Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) // in the Network Load Balancers Guide. SslPolicy *string diff --git a/service/elasticloadbalancingv2/api_op_ModifyRule.go b/service/elasticloadbalancingv2/api_op_ModifyRule.go index 761b4933ac7..482a6a20b1e 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyRule.go +++ b/service/elasticloadbalancingv2/api_op_ModifyRule.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replaces the specified properties of the specified rule. Any properties that you -// do not specify are unchanged. To add an item to a list, remove an item from a -// list, or update an item in a list, you must provide the entire list. For +// Replaces the specified properties of the specified rule. Any properties that +// you do not specify are unchanged. To add an item to a list, remove an item from +// a list, or update an item in a list, you must provide the entire list. For // example, to add an action, specify a list with the current actions plus the new // action. func (c *Client) ModifyRule(ctx context.Context, params *ModifyRuleInput, optFns ...func(*Options)) (*ModifyRuleOutput, error) { diff --git a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go index 0c91257f6fb..038bf307a81 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go @@ -64,8 +64,8 @@ type ModifyTargetGroupInput struct { // response means a failed health check. HealthCheckTimeoutSeconds *int32 - // The number of consecutive health checks successes required before considering an - // unhealthy target healthy. + // The number of consecutive health checks successes required before considering + // an unhealthy target healthy. HealthyThresholdCount *int32 // [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a diff --git a/service/elasticloadbalancingv2/api_op_RemoveListenerCertificates.go b/service/elasticloadbalancingv2/api_op_RemoveListenerCertificates.go index 479c4659bb8..feb25a9b94f 100644 --- a/service/elasticloadbalancingv2/api_op_RemoveListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_RemoveListenerCertificates.go @@ -31,7 +31,7 @@ func (c *Client) RemoveListenerCertificates(ctx context.Context, params *RemoveL type RemoveListenerCertificatesInput struct { // The certificate to remove. You can specify one certificate per call. Set - // CertificateArn to the certificate ARN but do not set IsDefault. + // CertificateArn to the certificate ARN but do not set IsDefault . // // This member is required. Certificates []types.Certificate diff --git a/service/elasticloadbalancingv2/api_op_SetRulePriorities.go b/service/elasticloadbalancingv2/api_op_SetRulePriorities.go index 01a1681b5a6..c7ae12fb394 100644 --- a/service/elasticloadbalancingv2/api_op_SetRulePriorities.go +++ b/service/elasticloadbalancingv2/api_op_SetRulePriorities.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the priorities of the specified rules. You can reorder the rules as long as -// there are no priority conflicts in the new order. Any existing rules that you do -// not specify retain their current priority. +// Sets the priorities of the specified rules. You can reorder the rules as long +// as there are no priority conflicts in the new order. Any existing rules that you +// do not specify retain their current priority. func (c *Client) SetRulePriorities(ctx context.Context, params *SetRulePrioritiesInput, optFns ...func(*Options)) (*SetRulePrioritiesOutput, error) { if params == nil { params = &SetRulePrioritiesInput{} diff --git a/service/elasticloadbalancingv2/doc.go b/service/elasticloadbalancingv2/doc.go index 76b44a31532..c84a07ebc11 100644 --- a/service/elasticloadbalancingv2/doc.go +++ b/service/elasticloadbalancingv2/doc.go @@ -16,19 +16,13 @@ // load balancers: Application Load Balancers, Network Load Balancers, Gateway Load // Balancers, and Classic Load Balancers. This reference covers the following load // balancer types: +// - Application Load Balancer - Operates at the application layer (layer 7) and +// supports HTTP and HTTPS. +// - Network Load Balancer - Operates at the transport layer (layer 4) and +// supports TCP, TLS, and UDP. +// - Gateway Load Balancer - Operates at the network layer (layer 3). // -// * Application Load Balancer - Operates at the application layer -// (layer 7) and supports HTTP and HTTPS. -// -// * Network Load Balancer - Operates at -// the transport layer (layer 4) and supports TCP, TLS, and UDP. -// -// * Gateway Load -// Balancer - Operates at the network layer (layer 3). -// -// For more information, see -// the Elastic Load Balancing User Guide -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/). All -// Elastic Load Balancing operations are idempotent, which means that they complete -// at most one time. If you repeat an operation, it succeeds. +// For more information, see the Elastic Load Balancing User Guide (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/) +// . All Elastic Load Balancing operations are idempotent, which means that they +// complete at most one time. If you repeat an operation, it succeeds. package elasticloadbalancingv2 diff --git a/service/elasticloadbalancingv2/types/enums.go b/service/elasticloadbalancingv2/types/enums.go index 5248aa95e06..832bce22798 100644 --- a/service/elasticloadbalancingv2/types/enums.go +++ b/service/elasticloadbalancingv2/types/enums.go @@ -114,8 +114,8 @@ const ( LoadBalancerStateEnumFailed LoadBalancerStateEnum = "failed" ) -// Values returns all known values for LoadBalancerStateEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LoadBalancerStateEnum. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerStateEnum) Values() []LoadBalancerStateEnum { return []LoadBalancerStateEnum{ @@ -159,9 +159,9 @@ const ( ProtocolEnumGeneve ProtocolEnum = "GENEVE" ) -// Values returns all known values for ProtocolEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProtocolEnum. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProtocolEnum) Values() []ProtocolEnum { return []ProtocolEnum{ "HTTP", @@ -182,9 +182,10 @@ const ( RedirectActionStatusCodeEnumHttp302 RedirectActionStatusCodeEnum = "HTTP_302" ) -// Values returns all known values for RedirectActionStatusCodeEnum. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RedirectActionStatusCodeEnum. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RedirectActionStatusCodeEnum) Values() []RedirectActionStatusCodeEnum { return []RedirectActionStatusCodeEnum{ "HTTP_301", @@ -200,9 +201,10 @@ const ( TargetGroupIpAddressTypeEnumIpv6 TargetGroupIpAddressTypeEnum = "ipv6" ) -// Values returns all known values for TargetGroupIpAddressTypeEnum. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetGroupIpAddressTypeEnum. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (TargetGroupIpAddressTypeEnum) Values() []TargetGroupIpAddressTypeEnum { return []TargetGroupIpAddressTypeEnum{ "ipv4", @@ -260,8 +262,8 @@ const ( TargetHealthStateEnumUnavailable TargetHealthStateEnum = "unavailable" ) -// Values returns all known values for TargetHealthStateEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TargetHealthStateEnum. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TargetHealthStateEnum) Values() []TargetHealthStateEnum { return []TargetHealthStateEnum{ diff --git a/service/elasticloadbalancingv2/types/errors.go b/service/elasticloadbalancingv2/types/errors.go index d2c8fea5558..a44b7489162 100644 --- a/service/elasticloadbalancingv2/types/errors.go +++ b/service/elasticloadbalancingv2/types/errors.go @@ -406,8 +406,8 @@ func (e *InvalidSubnetException) ErrorCode() string { } func (e *InvalidSubnetException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified target does not exist, is not in the same VPC as the target group, -// or has an unsupported instance type. +// The specified target does not exist, is not in the same VPC as the target +// group, or has an unsupported instance type. type InvalidTargetException struct { Message *string @@ -934,9 +934,9 @@ func (e *TooManyTargetsException) ErrorCode() string { } func (e *TooManyTargetsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've reached the limit on the number of unique target groups per load balancer -// across all listeners. If a target group is used by multiple actions for a load -// balancer, it is counted as only one use. +// You've reached the limit on the number of unique target groups per load +// balancer across all listeners. If a target group is used by multiple actions for +// a load balancer, it is counted as only one use. type TooManyUniqueTargetGroupsPerLoadBalancerException struct { Message *string diff --git a/service/elasticloadbalancingv2/types/types.go b/service/elasticloadbalancingv2/types/types.go index 75a0fa46065..28f874de0b6 100644 --- a/service/elasticloadbalancingv2/types/types.go +++ b/service/elasticloadbalancingv2/types/types.go @@ -7,9 +7,9 @@ import ( "time" ) -// Information about an action. Each rule must include exactly one of the following -// types of actions: forward, fixed-response, or redirect, and it must be the last -// action to be performed. +// Information about an action. Each rule must include exactly one of the +// following types of actions: forward , fixed-response , or redirect , and it must +// be the last action to be performed. type Action struct { // The type of action. @@ -18,22 +18,22 @@ type Action struct { Type ActionTypeEnum // [HTTPS listeners] Information for using Amazon Cognito to authenticate users. - // Specify only when Type is authenticate-cognito. + // Specify only when Type is authenticate-cognito . AuthenticateCognitoConfig *AuthenticateCognitoActionConfig // [HTTPS listeners] Information about an identity provider that is compliant with - // OpenID Connect (OIDC). Specify only when Type is authenticate-oidc. + // OpenID Connect (OIDC). Specify only when Type is authenticate-oidc . AuthenticateOidcConfig *AuthenticateOidcActionConfig // [Application Load Balancer] Information for creating an action that returns a - // custom HTTP response. Specify only when Type is fixed-response. + // custom HTTP response. Specify only when Type is fixed-response . FixedResponseConfig *FixedResponseActionConfig // Information for creating an action that distributes requests among one or more // target groups. For Network Load Balancers, you can specify a single target - // group. Specify only when Type is forward. If you specify both ForwardConfig and - // TargetGroupArn, you can specify only one target group using ForwardConfig and it - // must be the same target group specified in TargetGroupArn. + // group. Specify only when Type is forward . If you specify both ForwardConfig + // and TargetGroupArn , you can specify only one target group using ForwardConfig + // and it must be the same target group specified in TargetGroupArn . ForwardConfig *ForwardActionConfig // The order for the action. This value is required for rules with multiple @@ -41,7 +41,7 @@ type Action struct { Order *int32 // [Application Load Balancer] Information for creating a redirect action. Specify - // only when Type is redirect. + // only when Type is redirect . RedirectConfig *RedirectActionConfig // The Amazon Resource Name (ARN) of the target group. Specify only when Type is @@ -78,17 +78,13 @@ type AuthenticateCognitoActionConfig struct { // The behavior if the user is not authenticated. The following are possible // values: - // - // * deny - Return an HTTP 401 Unauthorized error. - // - // * allow - Allow the - // request to be forwarded to the target. - // - // * authenticate - Redirect the request to - // the IdP authorization endpoint. This is the default value. + // - deny - Return an HTTP 401 Unauthorized error. + // - allow - Allow the request to be forwarded to the target. + // - authenticate - Redirect the request to the IdP authorization endpoint. This + // is the default value. OnUnauthenticatedRequest AuthenticateCognitoActionConditionalBehaviorEnum - // The set of user claims to be requested from the IdP. The default is openid. To + // The set of user claims to be requested from the IdP. The default is openid . To // verify which scope values your IdP supports and how to separate multiple values, // see the documentation for your IdP. Scope *string @@ -148,17 +144,13 @@ type AuthenticateOidcActionConfig struct { // The behavior if the user is not authenticated. The following are possible // values: - // - // * deny - Return an HTTP 401 Unauthorized error. - // - // * allow - Allow the - // request to be forwarded to the target. - // - // * authenticate - Redirect the request to - // the IdP authorization endpoint. This is the default value. + // - deny - Return an HTTP 401 Unauthorized error. + // - allow - Allow the request to be forwarded to the target. + // - authenticate - Redirect the request to the IdP authorization endpoint. This + // is the default value. OnUnauthenticatedRequest AuthenticateOidcActionConditionalBehaviorEnum - // The set of user claims to be requested from the IdP. The default is openid. To + // The set of user claims to be requested from the IdP. The default is openid . To // verify which scope values your IdP supports and how to separate multiple values, // see the documentation for your IdP. Scope *string @@ -181,10 +173,10 @@ type AuthenticateOidcActionConfig struct { // Information about an Availability Zone. type AvailabilityZone struct { - // [Network Load Balancers] If you need static IP addresses for your load balancer, - // you can specify one Elastic IP address per Availability Zone when you create an - // internal-facing load balancer. For internal load balancers, you can specify a - // private IP address from the IPv4 range of the subnet. + // [Network Load Balancers] If you need static IP addresses for your load + // balancer, you can specify one Elastic IP address per Availability Zone when you + // create an internal-facing load balancer. For internal load balancers, you can + // specify a private IP address from the IPv4 range of the subnet. LoadBalancerAddresses []LoadBalancerAddress // [Application Load Balancers on Outposts] The ID of the Outpost. @@ -274,21 +266,21 @@ type HostHeaderConditionConfig struct { // header fields. You can also define custom HTTP header fields. type HttpHeaderConditionConfig struct { - // The name of the HTTP header field. The maximum size is 40 characters. The header - // name is case insensitive. The allowed characters are specified by RFC 7230. - // Wildcards are not supported. You can't use an HTTP header condition to specify - // the host header. Use HostHeaderConditionConfig to specify a host header + // The name of the HTTP header field. The maximum size is 40 characters. The + // header name is case insensitive. The allowed characters are specified by RFC + // 7230. Wildcards are not supported. You can't use an HTTP header condition to + // specify the host header. Use HostHeaderConditionConfig to specify a host header // condition. HttpHeaderName *string - // The strings to compare against the value of the HTTP header. The maximum size of - // each string is 128 characters. The comparison strings are case insensitive. The - // following wildcard characters are supported: * (matches 0 or more characters) - // and ? (matches exactly 1 character). If the same header appears multiple times - // in the request, we search them in order until a match is found. If you specify - // multiple strings, the condition is satisfied if one of the strings matches the - // value of the HTTP header. To require that all of the strings are a match, create - // one condition per string. + // The strings to compare against the value of the HTTP header. The maximum size + // of each string is 128 characters. The comparison strings are case insensitive. + // The following wildcard characters are supported: * (matches 0 or more + // characters) and ? (matches exactly 1 character). If the same header appears + // multiple times in the request, we search them in order until a match is found. + // If you specify multiple strings, the condition is satisfied if one of the + // strings matches the value of the HTTP header. To require that all of the strings + // are a match, create one condition per string. Values []string noSmithyDocumentSerde @@ -296,9 +288,8 @@ type HttpHeaderConditionConfig struct { // Information about an HTTP method condition. HTTP defines a set of request // methods, also referred to as HTTP verbs. For more information, see the HTTP -// Method Registry -// (https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also -// define custom HTTP methods. +// Method Registry (https://www.iana.org/assignments/http-methods/http-methods.xhtml) +// . You can also define custom HTTP methods. type HttpRequestMethodConditionConfig struct { // The name of the request method. The maximum size is 40 characters. The allowed @@ -321,54 +312,24 @@ type Limit struct { Max *string // The name of the limit. The possible values are: - // - // * application-load-balancers - // - // * - // condition-values-per-alb-rule - // - // * condition-wildcards-per-alb-rule - // - // * - // gateway-load-balancers - // - // * gateway-load-balancers-per-vpc - // - // * - // geneve-target-groups - // - // * listeners-per-application-load-balancer - // - // * - // listeners-per-network-load-balancer - // - // * network-load-balancers - // - // * - // rules-per-application-load-balancer - // - // * target-groups - // - // * - // target-groups-per-action-on-application-load-balancer - // - // * - // target-groups-per-action-on-network-load-balancer - // - // * - // target-groups-per-application-load-balancer - // - // * - // targets-per-application-load-balancer - // - // * - // targets-per-availability-zone-per-gateway-load-balancer - // - // * - // targets-per-availability-zone-per-network-load-balancer - // - // * - // targets-per-network-load-balancer + // - application-load-balancers + // - condition-values-per-alb-rule + // - condition-wildcards-per-alb-rule + // - gateway-load-balancers + // - gateway-load-balancers-per-vpc + // - geneve-target-groups + // - listeners-per-application-load-balancer + // - listeners-per-network-load-balancer + // - network-load-balancers + // - rules-per-application-load-balancer + // - target-groups + // - target-groups-per-action-on-application-load-balancer + // - target-groups-per-action-on-network-load-balancer + // - target-groups-per-application-load-balancer + // - targets-per-application-load-balancer + // - targets-per-availability-zone-per-gateway-load-balancer + // - targets-per-availability-zone-per-network-load-balancer + // - targets-per-network-load-balancer Name *string noSmithyDocumentSerde @@ -485,102 +446,71 @@ type LoadBalancerAttribute struct { // The name of the attribute. The following attributes are supported by all load // balancers: - // - // * deletion_protection.enabled - Indicates whether deletion - // protection is enabled. The value is true or false. The default is false. - // - // * - // load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing - // is enabled. The possible values are true and false. The default for Network Load - // Balancers and Gateway Load Balancers is false. The default for Application Load - // Balancers is true, and cannot be changed. - // - // The following attributes are - // supported by both Application Load Balancers and Network Load Balancers: - // - // * - // access_logs.s3.enabled - Indicates whether access logs are enabled. The value is - // true or false. The default is false. - // - // * access_logs.s3.bucket - The name of the - // S3 bucket for the access logs. This attribute is required if access logs are - // enabled. The bucket must exist in the same region as the load balancer and have - // a bucket policy that grants Elastic Load Balancing permissions to write to the - // bucket. - // - // * access_logs.s3.prefix - The prefix for the location in the S3 bucket - // for the access logs. - // - // * ipv6.deny_all_igw_traffic - Blocks internet gateway - // (IGW) access to the load balancer. It is set to false for internet-facing load - // balancers and true for internal load balancers, preventing unintended access to - // your internal load balancer through an internet gateway. - // - // The following - // attributes are supported by only Application Load Balancers: - // - // * - // idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid - // range is 1-4000 seconds. The default is 60 seconds. - // - // * - // routing.http.desync_mitigation_mode - Determines how the load balancer handles - // requests that might pose a security risk to your application. The possible - // values are monitor, defensive, and strictest. The default is defensive. - // - // * - // routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers - // with invalid header fields are removed by the load balancer (true) or routed to - // targets (false). The default is false. - // - // * - // routing.http.preserve_host_header.enabled - Indicates whether the Application - // Load Balancer should preserve the Host header in the HTTP request and send it to - // the target without any change. The possible values are true and false. The - // default is false. - // - // * routing.http.x_amzn_tls_version_and_cipher_suite.enabled - - // Indicates whether the two headers (x-amzn-tls-version and - // x-amzn-tls-cipher-suite), which contain information about the negotiated TLS - // version and cipher suite, are added to the client request before sending it to - // the target. The x-amzn-tls-version header has information about the TLS protocol - // version negotiated with the client, and the x-amzn-tls-cipher-suite header has - // information about the cipher suite negotiated with the client. Both headers are - // in OpenSSL format. The possible values for the attribute are true and false. The - // default is false. - // - // * routing.http.xff_client_port.enabled - Indicates whether - // the X-Forwarded-For header should preserve the source port that the client used - // to connect to the load balancer. The possible values are true and false. The - // default is false. - // - // * routing.http.xff_header_processing.mode - Enables you to - // modify, preserve, or remove the X-Forwarded-For header in the HTTP request - // before the Application Load Balancer sends the request to the target. The - // possible values are append, preserve, and remove. The default is append. - // - // * If - // the value is append, the Application Load Balancer adds the client IP address - // (of the last hop) to the X-Forwarded-For header in the HTTP request before it - // sends it to targets. - // - // * If the value is preserve the Application Load Balancer - // preserves the X-Forwarded-For header in the HTTP request, and sends it to - // targets without any change. - // - // * If the value is remove, the Application Load - // Balancer removes the X-Forwarded-For header in the HTTP request before it sends - // it to targets. - // - // * routing.http2.enabled - Indicates whether HTTP/2 is enabled. - // The possible values are true and false. The default is true. Elastic Load - // Balancing requires that message header names contain only alphanumeric - // characters and hyphens. - // - // * waf.fail_open.enabled - Indicates whether to allow a - // WAF-enabled load balancer to route requests to targets if it is unable to - // forward the request to Amazon Web Services WAF. The possible values are true and - // false. The default is false. + // - deletion_protection.enabled - Indicates whether deletion protection is + // enabled. The value is true or false . The default is false . + // - load_balancing.cross_zone.enabled - Indicates whether cross-zone load + // balancing is enabled. The possible values are true and false . The default for + // Network Load Balancers and Gateway Load Balancers is false . The default for + // Application Load Balancers is true , and cannot be changed. + // The following attributes are supported by both Application Load Balancers and + // Network Load Balancers: + // - access_logs.s3.enabled - Indicates whether access logs are enabled. The + // value is true or false . The default is false . + // - access_logs.s3.bucket - The name of the S3 bucket for the access logs. This + // attribute is required if access logs are enabled. The bucket must exist in the + // same region as the load balancer and have a bucket policy that grants Elastic + // Load Balancing permissions to write to the bucket. + // - access_logs.s3.prefix - The prefix for the location in the S3 bucket for the + // access logs. + // - ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load + // balancer. It is set to false for internet-facing load balancers and true for + // internal load balancers, preventing unintended access to your internal load + // balancer through an internet gateway. + // The following attributes are supported by only Application Load Balancers: + // - idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid + // range is 1-4000 seconds. The default is 60 seconds. + // - routing.http.desync_mitigation_mode - Determines how the load balancer + // handles requests that might pose a security risk to your application. The + // possible values are monitor , defensive , and strictest . The default is + // defensive . + // - routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP + // headers with invalid header fields are removed by the load balancer ( true ) + // or routed to targets ( false ). The default is false . + // - routing.http.preserve_host_header.enabled - Indicates whether the + // Application Load Balancer should preserve the Host header in the HTTP request + // and send it to the target without any change. The possible values are true and + // false . The default is false . + // - routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether + // the two headers ( x-amzn-tls-version and x-amzn-tls-cipher-suite ), which + // contain information about the negotiated TLS version and cipher suite, are added + // to the client request before sending it to the target. The x-amzn-tls-version + // header has information about the TLS protocol version negotiated with the + // client, and the x-amzn-tls-cipher-suite header has information about the + // cipher suite negotiated with the client. Both headers are in OpenSSL format. The + // possible values for the attribute are true and false . The default is false . + // - routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For + // header should preserve the source port that the client used to connect to the + // load balancer. The possible values are true and false . The default is false . + // - routing.http.xff_header_processing.mode - Enables you to modify, preserve, + // or remove the X-Forwarded-For header in the HTTP request before the + // Application Load Balancer sends the request to the target. The possible values + // are append , preserve , and remove . The default is append . + // - If the value is append , the Application Load Balancer adds the client IP + // address (of the last hop) to the X-Forwarded-For header in the HTTP request + // before it sends it to targets. + // - If the value is preserve the Application Load Balancer preserves the + // X-Forwarded-For header in the HTTP request, and sends it to targets without + // any change. + // - If the value is remove , the Application Load Balancer removes the + // X-Forwarded-For header in the HTTP request before it sends it to targets. + // - routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible + // values are true and false . The default is true . Elastic Load Balancing + // requires that message header names contain only alphanumeric characters and + // hyphens. + // - waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load + // balancer to route requests to targets if it is unable to forward the request to + // Amazon Web Services WAF. The possible values are true and false . The default + // is false . Key *string // The value of the attribute. @@ -592,11 +522,11 @@ type LoadBalancerAttribute struct { // Information about the state of the load balancer. type LoadBalancerState struct { - // The state code. The initial state of the load balancer is provisioning. After + // The state code. The initial state of the load balancer is provisioning . After // the load balancer is fully set up and ready to route traffic, its state is - // active. If load balancer is routing traffic but does not have the resources it - // needs to scale, its state isactive_impaired. If the load balancer could not be - // set up, its state is failed. + // active . If load balancer is routing traffic but does not have the resources it + // needs to scale, its state is active_impaired . If the load balancer could not be + // set up, its state is failed . Code LoadBalancerStateEnum // A description of the state. @@ -614,8 +544,8 @@ type Matcher struct { // 12. GrpcCode *string - // For Application Load Balancers, you can specify values between 200 and 499, with - // the default value being 200. You can specify multiple values (for example, + // For Application Load Balancers, you can specify values between 200 and 499, + // with the default value being 200. You can specify multiple values (for example, // "200,202") or a range of values (for example, "200-299"). For Network Load // Balancers, you can specify values between 200 and 599, with the default value // being 200-399. You can specify multiple values (for example, "200,202") or a @@ -636,7 +566,7 @@ type PathPatternConditionConfig struct { // (matches exactly 1 character). If you specify multiple strings, the condition is // satisfied if one of them matches the request URL. The path pattern is compared // only to the path of the URL, not to its query string. To compare against the - // query string, use QueryStringConditionConfig. + // query string, use QueryStringConditionConfig . Values []string noSmithyDocumentSerde @@ -673,30 +603,23 @@ type QueryStringKeyValuePair struct { noSmithyDocumentSerde } -// Information about a redirect action. A URI consists of the following components: -// protocol://hostname:port/path?query. You must modify at least one of the -// following components to avoid a redirect loop: protocol, hostname, port, or +// Information about a redirect action. A URI consists of the following +// components: protocol://hostname:port/path?query. You must modify at least one of +// the following components to avoid a redirect loop: protocol, hostname, port, or // path. Any components that you do not modify retain their original values. You // can reuse URI components using the following reserved keywords: +// - #{protocol} +// - #{host} +// - #{port} +// - #{path} (the leading "/" is removed) +// - #{query} // -// * -// #{protocol} -// -// * #{host} -// -// * #{port} -// -// * #{path} (the leading "/" is removed) -// -// * -// #{query} -// -// For example, you can change the path to "/new/#{path}", the hostname -// to "example.#{host}", or the query to "#{query}&value=xyz". +// For example, you can change the path to "/new/#{path}", the hostname to +// "example.#{host}", or the query to "#{query}&value=xyz". type RedirectActionConfig struct { - // The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary - // (HTTP 302). + // The HTTP redirect code. The redirect is either permanent (HTTP 301) or + // temporary (HTTP 302). // // This member is required. StatusCode RedirectActionStatusCodeEnum @@ -712,8 +635,9 @@ type RedirectActionConfig struct { // The port. You can specify a value from 1 to 65535 or #{port}. Port *string - // The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP - // to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. + // The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect + // HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to + // HTTP. Protocol *string // The query parameters, URL-encoded when necessary, but not percent-encoded. Do @@ -728,13 +652,13 @@ type RedirectActionConfig struct { type Rule struct { // The actions. Each rule must include exactly one of the following types of - // actions: forward, redirect, or fixed-response, and it must be the last action to - // be performed. + // actions: forward , redirect , or fixed-response , and it must be the last action + // to be performed. Actions []Action // The conditions. Each rule can include zero or one of the following conditions: - // http-request-method, host-header, path-pattern, and source-ip, and zero or more - // of the following conditions: http-header and query-string. + // http-request-method , host-header , path-pattern , and source-ip , and zero or + // more of the following conditions: http-header and query-string . Conditions []RuleCondition // Indicates whether this is the default rule. @@ -749,85 +673,63 @@ type Rule struct { noSmithyDocumentSerde } -// Information about a condition for a rule. Each rule can optionally include up to -// one of each of the following conditions: http-request-method, host-header, -// path-pattern, and source-ip. Each rule can also optionally include one or more -// of each of the following conditions: http-header and query-string. Note that the -// value for a condition cannot be empty. +// Information about a condition for a rule. Each rule can optionally include up +// to one of each of the following conditions: http-request-method , host-header , +// path-pattern , and source-ip . Each rule can also optionally include one or more +// of each of the following conditions: http-header and query-string . Note that +// the value for a condition cannot be empty. type RuleCondition struct { // The field in the HTTP request. The following are the possible values: - // - // * - // http-header - // - // * http-request-method - // - // * host-header - // - // * path-pattern - // - // * - // query-string - // - // * source-ip + // - http-header + // - http-request-method + // - host-header + // - path-pattern + // - query-string + // - source-ip Field *string - // Information for a host header condition. Specify only when Field is host-header. + // Information for a host header condition. Specify only when Field is host-header . HostHeaderConfig *HostHeaderConditionConfig - // Information for an HTTP header condition. Specify only when Field is - // http-header. + // Information for an HTTP header condition. Specify only when Field is http-header + // . HttpHeaderConfig *HttpHeaderConditionConfig // Information for an HTTP method condition. Specify only when Field is - // http-request-method. + // http-request-method . HttpRequestMethodConfig *HttpRequestMethodConditionConfig // Information for a path pattern condition. Specify only when Field is - // path-pattern. + // path-pattern . PathPatternConfig *PathPatternConditionConfig // Information for a query string condition. Specify only when Field is - // query-string. + // query-string . QueryStringConfig *QueryStringConditionConfig - // Information for a source IP condition. Specify only when Field is source-ip. + // Information for a source IP condition. Specify only when Field is source-ip . SourceIpConfig *SourceIpConditionConfig - // The condition value. Specify only when Field is host-header or path-pattern. + // The condition value. Specify only when Field is host-header or path-pattern . // Alternatively, to specify multiple host names or multiple path patterns, use - // HostHeaderConfig or PathPatternConfig. If Field is host-header and you are not - // using HostHeaderConfig, you can specify a single host name (for example, - // my.example.com) in Values. A host name is case insensitive, can be up to 128 + // HostHeaderConfig or PathPatternConfig . If Field is host-header and you are not + // using HostHeaderConfig , you can specify a single host name (for example, + // my.example.com) in Values . A host name is case insensitive, can be up to 128 // characters in length, and can contain any of the following characters. - // - // * A-Z, - // a-z, 0-9 - // - // * - . - // - // * * (matches 0 or more characters) - // - // * ? (matches exactly 1 - // character) - // - // If Field is path-pattern and you are not using PathPatternConfig, - // you can specify a single path pattern (for example, /img/*) in Values. A path - // pattern is case-sensitive, can be up to 128 characters in length, and can - // contain any of the following characters. - // - // * A-Z, a-z, 0-9 - // - // * _ - . $ / ~ " ' @ : - // + - // - // * & (using &) - // - // * * (matches 0 or more characters) - // - // * ? (matches exactly 1 - // character) + // - A-Z, a-z, 0-9 + // - - . + // - * (matches 0 or more characters) + // - ? (matches exactly 1 character) + // If Field is path-pattern and you are not using PathPatternConfig , you can + // specify a single path pattern (for example, /img/*) in Values . A path pattern + // is case-sensitive, can be up to 128 characters in length, and can contain any of + // the following characters. + // - A-Z, a-z, 0-9 + // - _ - . $ / ~ " ' @ : + + // - & (using &) + // - * (matches 0 or more characters) + // - ? (matches exactly 1 character) Values []string noSmithyDocumentSerde @@ -856,7 +758,7 @@ type SourceIpConditionConfig struct { // condition is satisfied if the source IP address of the request matches one of // the CIDR blocks. This condition is not satisfied by the addresses in the // X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, - // use HttpHeaderConditionConfig. + // use HttpHeaderConditionConfig . Values []string noSmithyDocumentSerde @@ -928,32 +830,32 @@ type TagDescription struct { // Information about a target. type TargetDescription struct { - // The ID of the target. If the target type of the target group is instance, - // specify an instance ID. If the target type is ip, specify an IP address. If the - // target type is lambda, specify the ARN of the Lambda function. If the target - // type is alb, specify the ARN of the Application Load Balancer target. + // The ID of the target. If the target type of the target group is instance , + // specify an instance ID. If the target type is ip , specify an IP address. If the + // target type is lambda , specify the ARN of the Lambda function. If the target + // type is alb , specify the ARN of the Application Load Balancer target. // // This member is required. Id *string - // An Availability Zone or all. This determines whether the target receives traffic - // from the load balancer nodes in the specified Availability Zone or from all - // enabled Availability Zones for the load balancer. For Application Load Balancer - // target groups, the specified Availability Zone value is only applicable when - // cross-zone load balancing is off. Otherwise the parameter is ignored and treated - // as all. This parameter is not supported if the target type of the target group - // is instance or alb. If the target type is ip and the IP address is in a subnet - // of the VPC for the target group, the Availability Zone is automatically detected - // and this parameter is optional. If the IP address is outside the VPC, this - // parameter is required. For Application Load Balancer target groups with - // cross-zone load balancing off, if the target type is ip and the IP address is - // outside of the VPC for the target group, this should be an Availability Zone - // inside the VPC for the target group. If the target type is lambda, this - // parameter is optional and the only supported value is all. + // An Availability Zone or all . This determines whether the target receives + // traffic from the load balancer nodes in the specified Availability Zone or from + // all enabled Availability Zones for the load balancer. For Application Load + // Balancer target groups, the specified Availability Zone value is only applicable + // when cross-zone load balancing is off. Otherwise the parameter is ignored and + // treated as all . This parameter is not supported if the target type of the + // target group is instance or alb . If the target type is ip and the IP address + // is in a subnet of the VPC for the target group, the Availability Zone is + // automatically detected and this parameter is optional. If the IP address is + // outside the VPC, this parameter is required. For Application Load Balancer + // target groups with cross-zone load balancing off, if the target type is ip and + // the IP address is outside of the VPC for the target group, this should be an + // Availability Zone inside the VPC for the target group. If the target type is + // lambda , this parameter is optional and the only supported value is all . AvailabilityZone *string // The port on which the target is listening. If the target group protocol is - // GENEVE, the supported port is 6081. If the target type is alb, the targeted + // GENEVE, the supported port is 6081. If the target type is alb , the targeted // Application Load Balancer must have at least one listener whose port matches the // target group port. Not used if the target is a Lambda function. Port *int32 @@ -985,17 +887,17 @@ type TargetGroup struct { // check. HealthCheckTimeoutSeconds *int32 - // The number of consecutive health checks successes required before considering an - // unhealthy target healthy. + // The number of consecutive health checks successes required before considering + // an unhealthy target healthy. HealthyThresholdCount *int32 // The type of IP address used for this target group. The possible values are ipv4 - // and ipv6. This is an optional parameter. If not specified, the IP address type - // defaults to ipv4. + // and ipv6 . This is an optional parameter. If not specified, the IP address type + // defaults to ipv4 . IpAddressType TargetGroupIpAddressTypeEnum - // The Amazon Resource Names (ARN) of the load balancers that route traffic to this - // target group. + // The Amazon Resource Names (ARN) of the load balancers that route traffic to + // this target group. LoadBalancerArns []string // The HTTP or gRPC codes to use when checking for a successful response from a @@ -1009,8 +911,8 @@ type TargetGroup struct { // The protocol to use for routing traffic to the targets. Protocol ProtocolEnum - // [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, - // and HTTP2. + // [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC , HTTP1 + // , and HTTP2 . ProtocolVersion *string // The Amazon Resource Name (ARN) of the target group. @@ -1041,140 +943,98 @@ type TargetGroupAttribute struct { // The name of the attribute. The following attributes are supported by all load // balancers: - // - // * deregistration_delay.timeout_seconds - The amount of time, in - // seconds, for Elastic Load Balancing to wait before changing the state of a - // deregistering target from draining to unused. The range is 0-3600 seconds. The - // default value is 300 seconds. If the target is a Lambda function, this attribute - // is not supported. - // - // * stickiness.enabled - Indicates whether target stickiness is - // enabled. The value is true or false. The default is false. - // - // * stickiness.type - - // Indicates the type of stickiness. The possible values are: - // - // * lb_cookie and - // app_cookie for Application Load Balancers. - // - // * source_ip for Network Load - // Balancers. - // - // * source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load - // Balancers. - // - // The following attributes are supported by Application Load Balancers - // and Network Load Balancers: - // - // * load_balancing.cross_zone.enabled - Indicates - // whether cross zone load balancing is enabled. The value is true, false or - // use_load_balancer_configuration. The default is - // use_load_balancer_configuration. - // - // * - // target_group_health.dns_failover.minimum_healthy_targets.count - The minimum - // number of targets that must be healthy. If the number of healthy targets is - // below this value, mark the zone as unhealthy in DNS, so that traffic is routed - // only to healthy zones. The possible values are off or an integer from 1 to the - // maximum number of targets. The default is off. - // - // * - // target_group_health.dns_failover.minimum_healthy_targets.percentage - The - // minimum percentage of targets that must be healthy. If the percentage of healthy - // targets is below this value, mark the zone as unhealthy in DNS, so that traffic - // is routed only to healthy zones. The possible values are off or an integer from - // 1 to 100. The default is off. - // - // * - // target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The - // minimum number of targets that must be healthy. If the number of healthy targets - // is below this value, send traffic to all targets, including unhealthy targets. - // The possible values are 1 to the maximum number of targets. The default is 1. - // - // * - // target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - - // The minimum percentage of targets that must be healthy. If the percentage of - // healthy targets is below this value, send traffic to all targets, including - // unhealthy targets. The possible values are off or an integer from 1 to 100. The - // default is off. - // - // The following attributes are supported only if the load - // balancer is an Application Load Balancer and the target is an instance or an IP - // address: - // - // * load_balancing.algorithm.type - The load balancing algorithm - // determines how the load balancer selects targets when routing requests. The - // value is round_robin or least_outstanding_requests. The default is - // round_robin. - // - // * slow_start.duration_seconds - The time period, in seconds, - // during which a newly registered target receives an increasing share of the - // traffic to the target group. After this time period ends, the target receives - // its full share of traffic. The range is 30-900 seconds (15 minutes). The default - // is 0 seconds (disabled). - // - // * stickiness.app_cookie.cookie_name - Indicates the - // name of the application-based cookie. Names that start with the following - // prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for - // use by the load balancer. - // - // * stickiness.app_cookie.duration_seconds - The time - // period, in seconds, during which requests from a client should be routed to the - // same target. After this time period expires, the application-based cookie is - // considered stale. The range is 1 second to 1 week (604800 seconds). The default - // value is 1 day (86400 seconds). - // - // * stickiness.lb_cookie.duration_seconds - The - // time period, in seconds, during which requests from a client should be routed to - // the same target. After this time period expires, the load balancer-generated - // cookie is considered stale. The range is 1 second to 1 week (604800 seconds). - // The default value is 1 day (86400 seconds). - // - // The following attribute is - // supported only if the load balancer is an Application Load Balancer and the - // target is a Lambda function: - // - // * lambda.multi_value_headers.enabled - Indicates - // whether the request and response headers that are exchanged between the load - // balancer and the Lambda function include arrays of values or strings. The value - // is true or false. The default is false. If the value is false and the request - // contains a duplicate header field name or query parameter key, the load balancer - // uses the last value sent by the client. - // - // The following attributes are supported - // only by Network Load Balancers: - // - // * - // deregistration_delay.connection_termination.enabled - Indicates whether the load - // balancer terminates connections at the end of the deregistration timeout. The - // value is true or false. The default is false. - // - // * preserve_client_ip.enabled - - // Indicates whether client IP preservation is enabled. The value is true or false. - // The default is disabled if the target group type is IP address and the target - // group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP - // preservation cannot be disabled for UDP and TCP_UDP target groups. - // - // * - // proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is - // enabled. The value is true or false. The default is false. - // - // The following - // attributes are supported only by Gateway Load Balancers: - // - // * - // target_failover.on_deregistration - Indicates how the Gateway Load Balancer - // handles existing flows when a target is deregistered. The possible values are - // rebalance and no_rebalance. The default is no_rebalance. The two attributes - // (target_failover.on_deregistration and target_failover.on_unhealthy) can't be - // set independently. The value you set for both attributes must be the same. - // - // * - // target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles - // existing flows when a target is unhealthy. The possible values are rebalance and - // no_rebalance. The default is no_rebalance. The two attributes - // (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be - // set independently. The value you set for both attributes must be the same. + // - deregistration_delay.timeout_seconds - The amount of time, in seconds, for + // Elastic Load Balancing to wait before changing the state of a deregistering + // target from draining to unused . The range is 0-3600 seconds. The default + // value is 300 seconds. If the target is a Lambda function, this attribute is not + // supported. + // - stickiness.enabled - Indicates whether target stickiness is enabled. The + // value is true or false . The default is false . + // - stickiness.type - Indicates the type of stickiness. The possible values are: + // - lb_cookie and app_cookie for Application Load Balancers. + // - source_ip for Network Load Balancers. + // - source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers. + // The following attributes are supported by Application Load Balancers and + // Network Load Balancers: + // - load_balancing.cross_zone.enabled - Indicates whether cross zone load + // balancing is enabled. The value is true , false or + // use_load_balancer_configuration . The default is + // use_load_balancer_configuration . + // - target_group_health.dns_failover.minimum_healthy_targets.count - The minimum + // number of targets that must be healthy. If the number of healthy targets is + // below this value, mark the zone as unhealthy in DNS, so that traffic is routed + // only to healthy zones. The possible values are off or an integer from 1 to the + // maximum number of targets. The default is off . + // - target_group_health.dns_failover.minimum_healthy_targets.percentage - The + // minimum percentage of targets that must be healthy. If the percentage of healthy + // targets is below this value, mark the zone as unhealthy in DNS, so that traffic + // is routed only to healthy zones. The possible values are off or an integer + // from 1 to 100. The default is off . + // - target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - + // The minimum number of targets that must be healthy. If the number of healthy + // targets is below this value, send traffic to all targets, including unhealthy + // targets. The possible values are 1 to the maximum number of targets. The default + // is 1. + // - + // target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage + // - The minimum percentage of targets that must be healthy. If the percentage of + // healthy targets is below this value, send traffic to all targets, including + // unhealthy targets. The possible values are off or an integer from 1 to 100. + // The default is off . + // The following attributes are supported only if the load balancer is an + // Application Load Balancer and the target is an instance or an IP address: + // - load_balancing.algorithm.type - The load balancing algorithm determines how + // the load balancer selects targets when routing requests. The value is + // round_robin or least_outstanding_requests . The default is round_robin . + // - slow_start.duration_seconds - The time period, in seconds, during which a + // newly registered target receives an increasing share of the traffic to the + // target group. After this time period ends, the target receives its full share of + // traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds + // (disabled). + // - stickiness.app_cookie.cookie_name - Indicates the name of the + // application-based cookie. Names that start with the following prefixes are not + // allowed: AWSALB , AWSALBAPP , and AWSALBTG ; they're reserved for use by the + // load balancer. + // - stickiness.app_cookie.duration_seconds - The time period, in seconds, during + // which requests from a client should be routed to the same target. After this + // time period expires, the application-based cookie is considered stale. The range + // is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 + // seconds). + // - stickiness.lb_cookie.duration_seconds - The time period, in seconds, during + // which requests from a client should be routed to the same target. After this + // time period expires, the load balancer-generated cookie is considered stale. The + // range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 + // seconds). + // The following attribute is supported only if the load balancer is an + // Application Load Balancer and the target is a Lambda function: + // - lambda.multi_value_headers.enabled - Indicates whether the request and + // response headers that are exchanged between the load balancer and the Lambda + // function include arrays of values or strings. The value is true or false . The + // default is false . If the value is false and the request contains a duplicate + // header field name or query parameter key, the load balancer uses the last value + // sent by the client. + // The following attributes are supported only by Network Load Balancers: + // - deregistration_delay.connection_termination.enabled - Indicates whether the + // load balancer terminates connections at the end of the deregistration timeout. + // The value is true or false . The default is false . + // - preserve_client_ip.enabled - Indicates whether client IP preservation is + // enabled. The value is true or false . The default is disabled if the target + // group type is IP address and the target group protocol is TCP or TLS. Otherwise, + // the default is enabled. Client IP preservation cannot be disabled for UDP and + // TCP_UDP target groups. + // - proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is + // enabled. The value is true or false . The default is false . + // The following attributes are supported only by Gateway Load Balancers: + // - target_failover.on_deregistration - Indicates how the Gateway Load Balancer + // handles existing flows when a target is deregistered. The possible values are + // rebalance and no_rebalance . The default is no_rebalance . The two attributes ( + // target_failover.on_deregistration and target_failover.on_unhealthy ) can't be + // set independently. The value you set for both attributes must be the same. + // - target_failover.on_unhealthy - Indicates how the Gateway Load Balancer + // handles existing flows when a target is unhealthy. The possible values are + // rebalance and no_rebalance . The default is no_rebalance . The two attributes ( + // target_failover.on_deregistration and target_failover.on_unhealthy ) cannot be + // set independently. The value you set for both attributes must be the same. Key *string // The value of the attribute. @@ -1196,8 +1056,8 @@ type TargetGroupStickinessConfig struct { noSmithyDocumentSerde } -// Information about how traffic will be distributed between multiple target groups -// in a forward rule. +// Information about how traffic will be distributed between multiple target +// groups in a forward rule. type TargetGroupTuple struct { // The Amazon Resource Name (ARN) of the target group. @@ -1213,70 +1073,43 @@ type TargetGroupTuple struct { type TargetHealth struct { // A description of the target health that provides additional details. If the - // state is healthy, a description is not provided. + // state is healthy , a description is not provided. Description *string - // The reason code. If the target state is healthy, a reason code is not provided. - // If the target state is initial, the reason code can be one of the following + // The reason code. If the target state is healthy , a reason code is not provided. + // If the target state is initial , the reason code can be one of the following // values: - // - // * Elb.RegistrationInProgress - The target is in the process of being - // registered with the load balancer. - // - // * Elb.InitialHealthChecking - The load - // balancer is still sending the target the minimum number of health checks - // required to determine its health status. - // - // If the target state is unhealthy, the - // reason code can be one of the following values: - // - // * Target.ResponseCodeMismatch - - // The health checks did not return an expected HTTP code. Applies only to - // Application Load Balancers and Gateway Load Balancers. - // - // * Target.Timeout - The - // health check requests timed out. Applies only to Application Load Balancers and - // Gateway Load Balancers. - // - // * Target.FailedHealthChecks - The load balancer - // received an error while establishing a connection to the target or the target - // response was malformed. - // - // * Elb.InternalError - The health checks failed due to - // an internal error. Applies only to Application Load Balancers. - // - // If the target - // state is unused, the reason code can be one of the following values: - // - // * - // Target.NotRegistered - The target is not registered with the target group. - // - // * - // Target.NotInUse - The target group is not used by any load balancer or the - // target is in an Availability Zone that is not enabled for its load balancer. - // - // * - // Target.InvalidState - The target is in the stopped or terminated state. - // - // * - // Target.IpUnusable - The target IP address is reserved for use by a load - // balancer. - // - // If the target state is draining, the reason code can be the following - // value: - // - // * Target.DeregistrationInProgress - The target is in the process of - // being deregistered and the deregistration delay period has not expired. - // - // If the - // target state is unavailable, the reason code can be the following value: - // - // * - // Target.HealthCheckDisabled - Health checks are disabled for the target group. - // Applies only to Application Load Balancers. - // - // * Elb.InternalError - Target health - // is unavailable due to an internal error. Applies only to Network Load Balancers. + // - Elb.RegistrationInProgress - The target is in the process of being + // registered with the load balancer. + // - Elb.InitialHealthChecking - The load balancer is still sending the target + // the minimum number of health checks required to determine its health status. + // If the target state is unhealthy , the reason code can be one of the following + // values: + // - Target.ResponseCodeMismatch - The health checks did not return an expected + // HTTP code. Applies only to Application Load Balancers and Gateway Load + // Balancers. + // - Target.Timeout - The health check requests timed out. Applies only to + // Application Load Balancers and Gateway Load Balancers. + // - Target.FailedHealthChecks - The load balancer received an error while + // establishing a connection to the target or the target response was malformed. + // - Elb.InternalError - The health checks failed due to an internal error. + // Applies only to Application Load Balancers. + // If the target state is unused , the reason code can be one of the following + // values: + // - Target.NotRegistered - The target is not registered with the target group. + // - Target.NotInUse - The target group is not used by any load balancer or the + // target is in an Availability Zone that is not enabled for its load balancer. + // - Target.InvalidState - The target is in the stopped or terminated state. + // - Target.IpUnusable - The target IP address is reserved for use by a load + // balancer. + // If the target state is draining , the reason code can be the following value: + // - Target.DeregistrationInProgress - The target is in the process of being + // deregistered and the deregistration delay period has not expired. + // If the target state is unavailable , the reason code can be the following value: + // - Target.HealthCheckDisabled - Health checks are disabled for the target + // group. Applies only to Application Load Balancers. + // - Elb.InternalError - Target health is unavailable due to an internal error. + // Applies only to Network Load Balancers. Reason TargetHealthReasonEnum // The state of the target. diff --git a/service/elasticsearchservice/api_client.go b/service/elasticsearchservice/api_client.go index 9fcebb805a6..d54933c77c9 100644 --- a/service/elasticsearchservice/api_client.go +++ b/service/elasticsearchservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elasticsearchservice/api_op_AddTags.go b/service/elasticsearchservice/api_op_AddTags.go index 36630a28d51..54d9eca4bf9 100644 --- a/service/elasticsearchservice/api_op_AddTags.go +++ b/service/elasticsearchservice/api_op_AddTags.go @@ -13,8 +13,7 @@ import ( // Attaches tags to an existing Elasticsearch domain. Tags are a set of // case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. -// See Tagging Amazon Elasticsearch Service Domains for more information. -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging) +// See Tagging Amazon Elasticsearch Service Domains for more information. (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging) func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} @@ -30,8 +29,8 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu return out, nil } -// Container for the parameters to the AddTags operation. Specify the tags that you -// want to attach to the Elasticsearch domain. +// Container for the parameters to the AddTags operation. Specify the tags that +// you want to attach to the Elasticsearch domain. type AddTagsInput struct { // Specify the ARN for which you want to add the tags. diff --git a/service/elasticsearchservice/api_op_AssociatePackage.go b/service/elasticsearchservice/api_op_AssociatePackage.go index 23b7c17f2c8..8fe925ed76e 100644 --- a/service/elasticsearchservice/api_op_AssociatePackage.go +++ b/service/elasticsearchservice/api_op_AssociatePackage.go @@ -47,7 +47,7 @@ type AssociatePackageInput struct { // Container for response returned by AssociatePackage operation. type AssociatePackageOutput struct { - // DomainPackageDetails + // DomainPackageDetails DomainPackageDetails *types.DomainPackageDetails // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go b/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go index c18c4945236..65f7d09d3ba 100644 --- a/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go +++ b/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go @@ -43,8 +43,8 @@ type CancelElasticsearchServiceSoftwareUpdateInput struct { noSmithyDocumentSerde } -// The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the -// status of the update. +// The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains +// the status of the update. type CancelElasticsearchServiceSoftwareUpdateOutput struct { // The current status of the Elasticsearch service software update. diff --git a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go index 5199222a61f..8bdcf3e8bbf 100644 --- a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go @@ -12,8 +12,7 @@ import ( ) // Creates a new Elasticsearch domain. For more information, see Creating -// Elasticsearch Domains -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) +// Elasticsearch Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) // in the Amazon Elasticsearch Service Developer Guide. func (c *Client) CreateElasticsearchDomain(ctx context.Context, params *CreateElasticsearchDomainInput, optFns ...func(*Options)) (*CreateElasticsearchDomainOutput, error) { if params == nil { @@ -45,8 +44,7 @@ type CreateElasticsearchDomainInput struct { // Option to allow references to indices in an HTTP request body. Must be false // when configuring access to individual sub-resources. By default, the value is - // true. See Configuration Advanced Options - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) + // true . See Configuration Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) // for more information. AdvancedOptions map[string]string @@ -58,8 +56,8 @@ type CreateElasticsearchDomainInput struct { // Options to specify the Cognito user and identity pools for Kibana // authentication. For more information, see Amazon Cognito Authentication for - // Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + // Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) + // . CognitoOptions *types.CognitoOptions // Options to specify configuration that will be applied to the domain endpoint. @@ -73,15 +71,14 @@ type CreateElasticsearchDomainInput struct { ElasticsearchClusterConfig *types.ElasticsearchClusterConfig // String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" - // or "2.3". For more information, see Creating Elasticsearch Domains - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) + // or "2.3". For more information, see Creating Elasticsearch Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains) // in the Amazon Elasticsearch Service Developer Guide. ElasticsearchVersion *string // Specifies the Encryption At Rest Options. EncryptionAtRestOptions *types.EncryptionAtRestOptions - // Map of LogType and LogPublishingOption, each containing options to publish a + // Map of LogType and LogPublishingOption , each containing options to publish a // given type of Elasticsearch log. LogPublishingOptions map[string]types.LogPublishingOption @@ -96,8 +93,7 @@ type CreateElasticsearchDomainInput struct { TagList []types.Tag // Options to specify the subnets and security groups for VPC endpoint. For more - // information, see Creating a VPC - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) + // information, see Creating a VPC (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) // in VPC Endpoints for Amazon Elasticsearch Service Domains VPCOptions *types.VPCOptions diff --git a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go index c5feb7d893f..51d91bb054e 100644 --- a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go @@ -51,8 +51,8 @@ type CreateOutboundCrossClusterSearchConnectionInput struct { noSmithyDocumentSerde } -// The result of a CreateOutboundCrossClusterSearchConnection request. Contains the -// details of the newly created cross-cluster search connection. +// The result of a CreateOutboundCrossClusterSearchConnection request. Contains +// the details of the newly created cross-cluster search connection. type CreateOutboundCrossClusterSearchConnectionOutput struct { // Specifies the connection alias provided during the create connection request. diff --git a/service/elasticsearchservice/api_op_CreatePackage.go b/service/elasticsearchservice/api_op_CreatePackage.go index ad9820a9a3f..dfd5f4cf00b 100644 --- a/service/elasticsearchservice/api_op_CreatePackage.go +++ b/service/elasticsearchservice/api_op_CreatePackage.go @@ -54,7 +54,7 @@ type CreatePackageInput struct { // Container for response returned by CreatePackage operation. type CreatePackageOutput struct { - // Information about the package PackageDetails. + // Information about the package PackageDetails . PackageDetails *types.PackageDetails // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go b/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go index 5c9b869e96e..f18fae2ef51 100644 --- a/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently deletes the specified Elasticsearch domain and all of its data. Once -// a domain is deleted, it cannot be recovered. +// Permanently deletes the specified Elasticsearch domain and all of its data. +// Once a domain is deleted, it cannot be recovered. func (c *Client) DeleteElasticsearchDomain(ctx context.Context, params *DeleteElasticsearchDomainInput, optFns ...func(*Options)) (*DeleteElasticsearchDomainOutput, error) { if params == nil { params = &DeleteElasticsearchDomainInput{} diff --git a/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go b/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go index 7ce1677649b..7b08e173e08 100644 --- a/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go +++ b/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go @@ -13,8 +13,7 @@ import ( // Deletes the service-linked role that Elasticsearch Service uses to manage and // maintain VPC domains. Role deletion will fail if any existing VPC domains use // the role. You must delete any such Elasticsearch domains before deleting the -// role. See Deleting Elasticsearch Service Role -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr) +// role. See Deleting Elasticsearch Service Role (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr) // in VPC Endpoints for Amazon Elasticsearch Service Domains. func (c *Client) DeleteElasticsearchServiceRole(ctx context.Context, params *DeleteElasticsearchServiceRoleInput, optFns ...func(*Options)) (*DeleteElasticsearchServiceRoleOutput, error) { if params == nil { diff --git a/service/elasticsearchservice/api_op_DeletePackage.go b/service/elasticsearchservice/api_op_DeletePackage.go index d1f72b9f138..dc31dd65ce9 100644 --- a/service/elasticsearchservice/api_op_DeletePackage.go +++ b/service/elasticsearchservice/api_op_DeletePackage.go @@ -30,8 +30,8 @@ func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, // Container for request parameters to DeletePackage operation. type DeletePackageInput struct { - // Internal ID of the package that you want to delete. Use DescribePackages to find - // this value. + // Internal ID of the package that you want to delete. Use DescribePackages to + // find this value. // // This member is required. PackageID *string @@ -42,7 +42,7 @@ type DeletePackageInput struct { // Container for response parameters to DeletePackage operation. type DeletePackageOutput struct { - // PackageDetails + // PackageDetails PackageDetails *types.PackageDetails // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go b/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go index e28d44f2ebd..0b6b4da5e03 100644 --- a/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go +++ b/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go @@ -42,8 +42,8 @@ type DeleteVpcEndpointInput struct { // the summarized detail of the VPC Endpoint being deleted. type DeleteVpcEndpointOutput struct { - // Information about the deleted endpoint, including its current status (DELETING - // or DELETE_FAILED). + // Information about the deleted endpoint, including its current status ( DELETING + // or DELETE_FAILED ). // // This member is required. VpcEndpointSummary *types.VpcEndpointSummary diff --git a/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go b/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go index 73db450a529..aa8ec71c0ca 100644 --- a/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go +++ b/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go @@ -41,21 +41,19 @@ type DescribeDomainAutoTunesInput struct { // defaults to 100. MaxResults int32 - // NextToken is sent in case the earlier API call results contain the NextToken. It - // is used for pagination. + // NextToken is sent in case the earlier API call results contain the NextToken. + // It is used for pagination. NextToken *string noSmithyDocumentSerde } -// The result of DescribeDomainAutoTunes request. See the Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) +// The result of DescribeDomainAutoTunes request. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. type DescribeDomainAutoTunesOutput struct { - // Specifies the list of setting adjustments that Auto-Tune has made to the domain. - // See the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies the list of setting adjustments that Auto-Tune has made to the + // domain. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. AutoTunes []types.AutoTune diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go b/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go index 92c15ddda22..84f7fa34c27 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go @@ -29,8 +29,9 @@ func (c *Client) DescribeElasticsearchDomainConfig(ctx context.Context, params * return out, nil } -// Container for the parameters to the DescribeElasticsearchDomainConfig operation. -// Specifies the domain name for which you want configuration information. +// Container for the parameters to the DescribeElasticsearchDomainConfig +// operation. Specifies the domain name for which you want configuration +// information. type DescribeElasticsearchDomainConfigInput struct { // The Elasticsearch domain that you want to get information about. diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go b/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go index 873cb2c82b0..8135aad149f 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go @@ -40,8 +40,8 @@ type DescribeElasticsearchDomainsInput struct { noSmithyDocumentSerde } -// The result of a DescribeElasticsearchDomains request. Contains the status of the -// specified domains or all domains owned by the account. +// The result of a DescribeElasticsearchDomains request. Contains the status of +// the specified domains or all domains owned by the account. type DescribeElasticsearchDomainsOutput struct { // The status of the domains requested in the DescribeElasticsearchDomains request. diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go index 19c1d12f35e..6432289c28f 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. -// When modifying existing Domain, specify the DomainName to know what Limits are -// supported for modifying. +// Describe Elasticsearch Limits for a given InstanceType and +// ElasticsearchVersion. When modifying existing Domain, specify the DomainName to +// know what Limits are supported for modifying. func (c *Client) DescribeElasticsearchInstanceTypeLimits(ctx context.Context, params *DescribeElasticsearchInstanceTypeLimitsInput, optFns ...func(*Options)) (*DescribeElasticsearchInstanceTypeLimitsOutput, error) { if params == nil { params = &DescribeElasticsearchInstanceTypeLimitsInput{} @@ -58,15 +58,9 @@ type DescribeElasticsearchInstanceTypeLimitsOutput struct { // Map of Role of the Instance and Limits that are applicable. Role performed by // given Instance in Elasticsearch can be one of the following: - // - // * data: If the - // given InstanceType is used as data node - // - // * master: If the given InstanceType is - // used as master node - // - // * ultra_warm: If the given InstanceType is used as warm - // node + // - data: If the given InstanceType is used as data node + // - master: If the given InstanceType is used as master node + // - ultra_warm: If the given InstanceType is used as warm node LimitsByRole map[string]types.Limits // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go index ff79406486e..3e200d50dc7 100644 --- a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go @@ -34,27 +34,19 @@ type DescribeInboundCrossClusterSearchConnectionsInput struct { // A list of filters used to match properties for inbound cross-cluster search // connection. Available Filter names for this operation are: - // - // * - // cross-cluster-search-connection-id - // - // * source-domain-info.domain-name - // - // * - // source-domain-info.owner-id - // - // * source-domain-info.region - // - // * - // destination-domain-info.domain-name + // - cross-cluster-search-connection-id + // - source-domain-info.domain-name + // - source-domain-info.owner-id + // - source-domain-info.region + // - destination-domain-info.domain-name Filters []types.Filter // Set this value to limit the number of results returned. If not specified, // defaults to 100. MaxResults int32 - // NextToken is sent in case the earlier API call results contain the NextToken. It - // is used for pagination. + // NextToken is sent in case the earlier API call results contain the NextToken. + // It is used for pagination. NextToken *string noSmithyDocumentSerde @@ -68,8 +60,8 @@ type DescribeInboundCrossClusterSearchConnectionsOutput struct { // filter criteria. CrossClusterSearchConnections []types.InboundCrossClusterSearchConnection - // If more results are available and NextToken is present, make the next request to - // the same API with the received NextToken to paginate the remaining results. + // If more results are available and NextToken is present, make the next request + // to the same API with the received NextToken to paginate the remaining results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go index 22fc5003818..7d194a94f73 100644 --- a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go @@ -34,27 +34,19 @@ type DescribeOutboundCrossClusterSearchConnectionsInput struct { // A list of filters used to match properties for outbound cross-cluster search // connection. Available Filter names for this operation are: - // - // * - // cross-cluster-search-connection-id - // - // * destination-domain-info.domain-name - // - // * - // destination-domain-info.owner-id - // - // * destination-domain-info.region - // - // * - // source-domain-info.domain-name + // - cross-cluster-search-connection-id + // - destination-domain-info.domain-name + // - destination-domain-info.owner-id + // - destination-domain-info.region + // - source-domain-info.domain-name Filters []types.Filter // Set this value to limit the number of results returned. If not specified, // defaults to 100. MaxResults int32 - // NextToken is sent in case the earlier API call results contain the NextToken. It - // is used for pagination. + // NextToken is sent in case the earlier API call results contain the NextToken. + // It is used for pagination. NextToken *string noSmithyDocumentSerde @@ -68,8 +60,8 @@ type DescribeOutboundCrossClusterSearchConnectionsOutput struct { // filter criteria. CrossClusterSearchConnections []types.OutboundCrossClusterSearchConnection - // If more results are available and NextToken is present, make the next request to - // the same API with the received NextToken to paginate the remaining results. + // If more results are available and NextToken is present, make the next request + // to the same API with the received NextToken to paginate the remaining results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go b/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go index 5d42b6e0dd4..63fa4daf8d7 100644 --- a/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go +++ b/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go @@ -39,9 +39,9 @@ type DescribeVpcEndpointsInput struct { noSmithyDocumentSerde } -// Container for response parameters to the DescribeVpcEndpoints operation. Returns -// a list containing configuration details and status of the VPC Endpoints as well -// as a list containing error responses of the endpoints that could not be +// Container for response parameters to the DescribeVpcEndpoints operation. +// Returns a list containing configuration details and status of the VPC Endpoints +// as well as a list containing error responses of the endpoints that could not be // described type DescribeVpcEndpointsOutput struct { diff --git a/service/elasticsearchservice/api_op_DissociatePackage.go b/service/elasticsearchservice/api_op_DissociatePackage.go index 1adccc54349..07f14050d2d 100644 --- a/service/elasticsearchservice/api_op_DissociatePackage.go +++ b/service/elasticsearchservice/api_op_DissociatePackage.go @@ -47,7 +47,7 @@ type DissociatePackageInput struct { // Container for response returned by DissociatePackage operation. type DissociatePackageOutput struct { - // DomainPackageDetails + // DomainPackageDetails DomainPackageDetails *types.DomainPackageDetails // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_GetUpgradeHistory.go b/service/elasticsearchservice/api_op_GetUpgradeHistory.go index 555a4dd200b..d679a1d600f 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeHistory.go +++ b/service/elasticsearchservice/api_op_GetUpgradeHistory.go @@ -43,9 +43,9 @@ type GetUpgradeHistoryInput struct { // Set this value to limit the number of results returned. MaxResults int32 - // Paginated APIs accepts NextToken input to returns next page results and provides - // a NextToken output in the response which can be used by the client to retrieve - // more results. + // Paginated APIs accepts NextToken input to returns next page results and + // provides a NextToken output in the response which can be used by the client to + // retrieve more results. NextToken *string noSmithyDocumentSerde @@ -54,8 +54,8 @@ type GetUpgradeHistoryInput struct { // Container for response returned by GetUpgradeHistory operation. type GetUpgradeHistoryOutput struct { - // Pagination token that needs to be supplied to the next call to get the next page - // of results + // Pagination token that needs to be supplied to the next call to get the next + // page of results NextToken *string // A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade diff --git a/service/elasticsearchservice/api_op_GetUpgradeStatus.go b/service/elasticsearchservice/api_op_GetUpgradeStatus.go index e4c57570ae4..0910a89d5c0 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeStatus.go +++ b/service/elasticsearchservice/api_op_GetUpgradeStatus.go @@ -48,14 +48,10 @@ type GetUpgradeStatusOutput struct { // One of 4 statuses that a step can go through returned as part of the // GetUpgradeStatusResponse object. The status can take one of the following // values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with Issues - // - // * Failed + // - In Progress + // - Succeeded + // - Succeeded with Issues + // - Failed StepStatus types.UpgradeStatus // A string that describes the update briefly @@ -63,12 +59,9 @@ type GetUpgradeStatusOutput struct { // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does // through: - // - // * PreUpgradeCheck - // - // * Snapshot - // - // * Upgrade + // - PreUpgradeCheck + // - Snapshot + // - Upgrade UpgradeStep types.UpgradeStep // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_ListDomainNames.go b/service/elasticsearchservice/api_op_ListDomainNames.go index bcc6a08c763..a459fcf4a4b 100644 --- a/service/elasticsearchservice/api_op_ListDomainNames.go +++ b/service/elasticsearchservice/api_op_ListDomainNames.go @@ -31,8 +31,8 @@ func (c *Client) ListDomainNames(ctx context.Context, params *ListDomainNamesInp // Container for the parameters to the ListDomainNames operation. type ListDomainNamesInput struct { - // Optional parameter to filter the output by domain engine type. Acceptable values - // are 'Elasticsearch' and 'OpenSearch'. + // Optional parameter to filter the output by domain engine type. Acceptable + // values are 'Elasticsearch' and 'OpenSearch'. EngineType types.EngineType noSmithyDocumentSerde diff --git a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go index 1a218784aa3..bfb8e8aadd7 100644 --- a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go +++ b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go @@ -38,9 +38,9 @@ type ListElasticsearchVersionsInput struct { // greater than 10 else it wont be honored. MaxResults int32 - // Paginated APIs accepts NextToken input to returns next page results and provides - // a NextToken output in the response which can be used by the client to retrieve - // more results. + // Paginated APIs accepts NextToken input to returns next page results and + // provides a NextToken output in the response which can be used by the client to + // retrieve more results. NextToken *string noSmithyDocumentSerde @@ -53,9 +53,9 @@ type ListElasticsearchVersionsOutput struct { // List of supported elastic search versions. ElasticsearchVersions []string - // Paginated APIs accepts NextToken input to returns next page results and provides - // a NextToken output in the response which can be used by the client to retrieve - // more results. + // Paginated APIs accepts NextToken input to returns next page results and + // provides a NextToken output in the response which can be used by the client to + // retrieve more results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_ListPackagesForDomain.go b/service/elasticsearchservice/api_op_ListPackagesForDomain.go index fb5e2244eaa..3cd4825c0dd 100644 --- a/service/elasticsearchservice/api_op_ListPackagesForDomain.go +++ b/service/elasticsearchservice/api_op_ListPackagesForDomain.go @@ -52,8 +52,8 @@ type ListPackagesForDomainOutput struct { // List of DomainPackageDetails objects. DomainPackageDetailsList []types.DomainPackageDetails - // Pagination token that needs to be supplied to the next call to get the next page - // of results. + // Pagination token that needs to be supplied to the next call to get the next + // page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_ListTags.go b/service/elasticsearchservice/api_op_ListTags.go index 95099aa52cd..f089c0297b1 100644 --- a/service/elasticsearchservice/api_op_ListTags.go +++ b/service/elasticsearchservice/api_op_ListTags.go @@ -32,8 +32,8 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... // attached. type ListTagsInput struct { - // Specify the ARN for the Elasticsearch domain to which the tags are attached that - // you want to view. + // Specify the ARN for the Elasticsearch domain to which the tags are attached + // that you want to view. // // This member is required. ARN *string diff --git a/service/elasticsearchservice/api_op_RemoveTags.go b/service/elasticsearchservice/api_op_RemoveTags.go index 1f77e329bcb..c4de2b2893b 100644 --- a/service/elasticsearchservice/api_op_RemoveTags.go +++ b/service/elasticsearchservice/api_op_RemoveTags.go @@ -27,11 +27,11 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns } // Container for the parameters to the RemoveTags operation. Specify the ARN for -// the Elasticsearch domain from which you want to remove the specified TagKey. +// the Elasticsearch domain from which you want to remove the specified TagKey . type RemoveTagsInput struct { - // Specifies the ARN for the Elasticsearch domain from which you want to delete the - // specified tags. + // Specifies the ARN for the Elasticsearch domain from which you want to delete + // the specified tags. // // This member is required. ARN *string diff --git a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go index 4e138f391f4..63dd8294216 100644 --- a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go +++ b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go @@ -42,8 +42,7 @@ type UpdateElasticsearchDomainConfigInput struct { // Modifies the advanced option to allow references to indices in an HTTP request // body. Must be false when configuring access to individual sub-resources. By - // default, the value is true. See Configuration Advanced Options - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) + // default, the value is true . See Configuration Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) // for more information. AdvancedOptions map[string]string @@ -55,8 +54,8 @@ type UpdateElasticsearchDomainConfigInput struct { // Options to specify the Cognito user and identity pools for Kibana // authentication. For more information, see Amazon Cognito Authentication for - // Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + // Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) + // . CognitoOptions *types.CognitoOptions // Options to specify configuration that will be applied to the domain endpoint. @@ -78,20 +77,19 @@ type UpdateElasticsearchDomainConfigInput struct { // Specifies the Encryption At Rest Options. EncryptionAtRestOptions *types.EncryptionAtRestOptions - // Map of LogType and LogPublishingOption, each containing options to publish a + // Map of LogType and LogPublishingOption , each containing options to publish a // given type of Elasticsearch log. LogPublishingOptions map[string]types.LogPublishingOption // Specifies the NodeToNodeEncryptionOptions. NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions - // Option to set the time, in UTC format, for the daily automated snapshot. Default - // value is 0 hours. + // Option to set the time, in UTC format, for the daily automated snapshot. + // Default value is 0 hours. SnapshotOptions *types.SnapshotOptions // Options to specify the subnets and security groups for VPC endpoint. For more - // information, see Creating a VPC - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) + // information, see Creating a VPC (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc) // in VPC Endpoints for Amazon Elasticsearch Service Domains VPCOptions *types.VPCOptions diff --git a/service/elasticsearchservice/api_op_UpdatePackage.go b/service/elasticsearchservice/api_op_UpdatePackage.go index 42059e61cad..33cd046ce13 100644 --- a/service/elasticsearchservice/api_op_UpdatePackage.go +++ b/service/elasticsearchservice/api_op_UpdatePackage.go @@ -41,7 +41,7 @@ type UpdatePackageInput struct { PackageSource *types.PackageSource // An info message for the new version which will be shown as part of - // GetPackageVersionHistoryResponse. + // GetPackageVersionHistoryResponse . CommitMessage *string // New description of the package. @@ -53,7 +53,7 @@ type UpdatePackageInput struct { // Container for response returned by UpdatePackage operation. type UpdatePackageOutput struct { - // Information about the package PackageDetails. + // Information about the package PackageDetails . PackageDetails *types.PackageDetails // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go index 30bf2202909..1f726596e81 100644 --- a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to either upgrade your domain or perform an Upgrade eligibility check -// to a compatible Elasticsearch version. +// Allows you to either upgrade your domain or perform an Upgrade eligibility +// check to a compatible Elasticsearch version. func (c *Client) UpgradeElasticsearchDomain(ctx context.Context, params *UpgradeElasticsearchDomainInput, optFns ...func(*Options)) (*UpgradeElasticsearchDomainOutput, error) { if params == nil { params = &UpgradeElasticsearchDomainInput{} diff --git a/service/elasticsearchservice/doc.go b/service/elasticsearchservice/doc.go index 5cb8d7ef4ac..6b65150496f 100644 --- a/service/elasticsearchservice/doc.go +++ b/service/elasticsearchservice/doc.go @@ -6,13 +6,11 @@ // Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch // Configuration API to create, configure, and manage Elasticsearch domains. For // sample code that uses the Configuration API, see the Amazon Elasticsearch -// Service Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html). -// The guide also contains sample code for sending signed HTTP requests to the -// Elasticsearch APIs -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html). -// The endpoint for configuration service requests is region-specific: +// Service Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html) +// . The guide also contains sample code for sending signed HTTP requests to the +// Elasticsearch APIs (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html) +// . The endpoint for configuration service requests is region-specific: // es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current -// list of supported regions and endpoints, see Regions and Endpoints -// (http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions). +// list of supported regions and endpoints, see Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions) +// . package elasticsearchservice diff --git a/service/elasticsearchservice/types/enums.go b/service/elasticsearchservice/types/enums.go index 2da0f6f540b..2b417bf0853 100644 --- a/service/elasticsearchservice/types/enums.go +++ b/service/elasticsearchservice/types/enums.go @@ -59,9 +59,9 @@ const ( AutoTuneTypeScheduledAction AutoTuneType = "SCHEDULED_ACTION" ) -// Values returns all known values for AutoTuneType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoTuneType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneType) Values() []AutoTuneType { return []AutoTuneType{ "SCHEDULED_ACTION", diff --git a/service/elasticsearchservice/types/errors.go b/service/elasticsearchservice/types/errors.go index e44f6bb8153..2af18fb90e6 100644 --- a/service/elasticsearchservice/types/errors.go +++ b/service/elasticsearchservice/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// An error occurred because user does not have permissions to access the resource. -// Returns HTTP status code 403. +// An error occurred because user does not have permissions to access the +// resource. Returns HTTP status code 403. type AccessDeniedException struct { Message *string @@ -223,8 +223,8 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An exception for creating a resource that already exists. Gives http status code -// of 400. +// An exception for creating a resource that already exists. Gives http status +// code of 400. type ResourceAlreadyExistsException struct { Message *string diff --git a/service/elasticsearchservice/types/types.go b/service/elasticsearchservice/types/types.go index d4ba739bbc8..3ab80de21e3 100644 --- a/service/elasticsearchservice/types/types.go +++ b/service/elasticsearchservice/types/types.go @@ -12,9 +12,8 @@ import ( type AccessPoliciesStatus struct { // The access policy configured for the Elasticsearch domain. Access policies may - // be resource-based, IP-based, or IAM-based. See Configuring Access Policies - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies)for - // more information. + // be resource-based, IP-based, or IAM-based. See Configuring Access Policies (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies) + // for more information. // // This member is required. Options *string @@ -37,16 +36,12 @@ type AdditionalLimit struct { // // Attributes and their details: // - // * - // MaximumNumberOfDataNodesSupported - // This attribute will be present in Master node - // only to specify how much data nodes upto which given ESPartitionInstanceType can - // support as master node. - // * MaximumNumberOfDataNodesWithoutMasterNode - // This - // attribute will be present in Data node only to specify how much data nodes of - // given ESPartitionInstanceType upto which you don't need any master nodes to - // govern them. + // - MaximumNumberOfDataNodesSupported This attribute will be present in Master + // node only to specify how much data nodes upto which given + // ESPartitionInstanceType can support as master node. + // - MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in + // Data node only to specify how much data nodes of given ESPartitionInstanceType + // upto which you don't need any master nodes to govern them. LimitName *string // Value for given AdditionalLimit$LimitName . @@ -57,20 +52,15 @@ type AdditionalLimit struct { // Status of the advanced options for the specified Elasticsearch domain. // Currently, the following advanced options are available: +// - Option to allow references to indices in an HTTP request body. Must be false +// when configuring access to individual sub-resources. By default, the value is +// true . See Configuration Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) +// for more information. +// - Option to specify the percentage of heap space that is allocated to field +// data. By default, this setting is unbounded. // -// * Option to allow -// references to indices in an HTTP request body. Must be false when configuring -// access to individual sub-resources. By default, the value is true. See -// Configuration Advanced Options -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) -// for more information. -// -// * Option to specify the percentage of heap space that is -// allocated to field data. By default, this setting is unbounded. -// -// For more -// information, see Configuring Advanced Options -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options). +// For more information, see Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) +// . type AdvancedOptionsStatus struct { // Specifies the status of advanced options for the specified Elasticsearch domain. @@ -168,8 +158,7 @@ type AuthorizedPrincipal struct { // Specifies Auto-Tune type and Auto-Tune action details. type AutoTune struct { - // Specifies details of the Auto-Tune action. See the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. AutoTuneDetails *AutoTuneDetails @@ -179,33 +168,28 @@ type AutoTune struct { noSmithyDocumentSerde } -// Specifies details of the Auto-Tune action. See the Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) +// Specifies details of the Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. type AutoTuneDetails struct { - // Specifies details of the scheduled Auto-Tune action. See the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. ScheduledAutoTuneDetails *ScheduledAutoTuneDetails noSmithyDocumentSerde } -// Specifies Auto-Tune maitenance schedule. See the Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) +// Specifies Auto-Tune maitenance schedule. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. type AutoTuneMaintenanceSchedule struct { // Specifies cron expression for a recurring maintenance schedule. See the - // Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. CronExpressionForRecurrence *string // Specifies maintenance schedule duration: duration value and duration unit. See - // the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. Duration *Duration @@ -223,8 +207,7 @@ type AutoTuneOptions struct { // Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. DesiredState AutoTuneDesiredState - // Specifies list of maitenance schedules. See the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. MaintenanceSchedules []AutoTuneMaintenanceSchedule @@ -242,8 +225,7 @@ type AutoTuneOptionsInput struct { // Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. DesiredState AutoTuneDesiredState - // Specifies list of maitenance schedules. See the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies list of maitenance schedules. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. MaintenanceSchedules []AutoTuneMaintenanceSchedule @@ -361,7 +343,7 @@ type ChangeProgressStatusDetails struct { StartTime *time.Time // The overall status of the domain configuration change. This field can take the - // following values: PENDING, PROCESSING, COMPLETED and FAILED + // following values: PENDING , PROCESSING , COMPLETED and FAILED Status OverallChangeStatus // The total number of stages required for the configuration change. @@ -372,8 +354,8 @@ type ChangeProgressStatusDetails struct { // Options to specify the Cognito user and identity pools for Kibana // authentication. For more information, see Amazon Cognito Authentication for -// Kibana -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). +// Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) +// . type CognitoOptions struct { // Specifies the option to enable Cognito for Kibana authentication. @@ -436,7 +418,7 @@ type CompatibleVersionsMap struct { // Filter to apply in DescribePackage response. type DescribePackagesFilter struct { - // Any field from PackageDetails. + // Any field from PackageDetails . Name DescribePackagesFilterName // A list of values for the specified field. @@ -464,13 +446,9 @@ type DomainEndpointOptions struct { // of Elasticsearch domain. // // It can be one of the following values: - // - // * - // Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and - // higher. - // - // * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only - // TLSv1.2 + // - Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and + // higher. + // - Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2 TLSSecurityPolicy TLSSecurityPolicy noSmithyDocumentSerde @@ -495,7 +473,7 @@ type DomainEndpointOptionsStatus struct { type DomainInfo struct { - // Specifies the DomainName. + // Specifies the DomainName . DomainName *string // Specifies the EngineType of the domain. @@ -548,8 +526,8 @@ type DomainPackageDetails struct { PackageVersion *string - // The relative path on Amazon ES nodes, which can be used as synonym_path when the - // package is synonym file. + // The relative path on Amazon ES nodes, which can be used as synonym_path when + // the package is synonym file. ReferencePath *string noSmithyDocumentSerde @@ -562,8 +540,8 @@ type DryRunResults struct { // blue/green deployment.) DynamicUpdate (The update can be applied in-place // without a Blue/Green deployment required.) Undetermined (The domain is // undergoing an update which needs to complete before the deployment type can be - // predicted.) None (The configuration change matches the current configuration and - // will not result in any update.) + // predicted.) None (The configuration change matches the current configuration + // and will not result in any update.) DeploymentType *string // Contains an optional message associated with the DryRunResults. @@ -573,20 +551,17 @@ type DryRunResults struct { } // Specifies maintenance schedule duration: duration value and duration unit. See -// the Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) +// the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. type Duration struct { - // Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See - // the Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Specifies the unit of a maintenance schedule duration. Valid value is HOURS. + // See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. Unit TimeUnit // Integer to specify the value of a maintenance schedule duration. See the - // Developer Guide - // (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) + // Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. Value int64 @@ -594,8 +569,8 @@ type Duration struct { } // Options to enable, disable, and specify the properties of EBS storage volumes. -// For more information, see Configuring EBS-based Storage -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs). +// For more information, see Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) +// . type EBSOptions struct { // Specifies whether EBS-based storage is enabled. @@ -643,8 +618,7 @@ type ElasticsearchClusterConfig struct { DedicatedMasterCount *int32 // A boolean value to indicate whether a dedicated master node is enabled. See - // About Dedicated Master Nodes - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes) + // About Dedicated Master Nodes (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes) // for more information. DedicatedMasterEnabled *bool @@ -654,8 +628,8 @@ type ElasticsearchClusterConfig struct { // The number of instances in the specified domain cluster. InstanceCount *int32 - // The instance type for an Elasticsearch cluster. UltraWarm instance types are not - // supported for data instances. + // The instance type for an Elasticsearch cluster. UltraWarm instance types are + // not supported for data instances. InstanceType ESPartitionInstanceType // The number of warm nodes in the cluster. @@ -672,8 +646,7 @@ type ElasticsearchClusterConfig struct { ZoneAwarenessConfig *ZoneAwarenessConfig // A boolean value to indicate whether zone awareness is enabled. See About Zone - // Awareness - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness) + // Awareness (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness) // for more information. ZoneAwarenessEnabled *bool @@ -703,8 +676,7 @@ type ElasticsearchDomainConfig struct { // IAM access policy as a JSON-formatted string. AccessPolicies *AccessPoliciesStatus - // Specifies the AdvancedOptions for the domain. See Configuring Advanced Options - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) + // Specifies the AdvancedOptions for the domain. See Configuring Advanced Options (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) // for more information. AdvancedOptions *AdvancedOptionsStatus @@ -718,8 +690,8 @@ type ElasticsearchDomainConfig struct { ChangeProgressDetails *ChangeProgressDetails // The CognitoOptions for the specified domain. For more information, see Amazon - // Cognito Authentication for Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + // Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) + // . CognitoOptions *CognitoOptionsStatus // Specifies the DomainEndpointOptions for the Elasticsearch domain. @@ -746,9 +718,9 @@ type ElasticsearchDomainConfig struct { // Specifies the SnapshotOptions for the Elasticsearch domain. SnapshotOptions *SnapshotOptionsStatus - // The VPCOptions for the specified domain. For more information, see VPC Endpoints - // for Amazon Elasticsearch Service Domains - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). + // The VPCOptions for the specified domain. For more information, see VPC + // Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) + // . VPCOptions *VPCDerivedInfoStatus noSmithyDocumentSerde @@ -758,8 +730,7 @@ type ElasticsearchDomainConfig struct { type ElasticsearchDomainStatus struct { // The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for - // IAM Entities - // (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) + // IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) // in Using AWS Identity and Access Management for more information. // // This member is required. @@ -799,8 +770,8 @@ type ElasticsearchDomainStatus struct { ChangeProgressDetails *ChangeProgressDetails // The CognitoOptions for the specified domain. For more information, see Amazon - // Cognito Authentication for Kibana - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html). + // Cognito Authentication for Kibana (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html) + // . CognitoOptions *CognitoOptions // The domain creation status. True if the creation of an Elasticsearch domain is @@ -816,14 +787,13 @@ type ElasticsearchDomainStatus struct { // The current status of the Elasticsearch domain's endpoint options. DomainEndpointOptions *DomainEndpointOptions - // The EBSOptions for the specified domain. See Configuring EBS-based Storage - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) + // The EBSOptions for the specified domain. See Configuring EBS-based Storage (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) // for more information. EBSOptions *EBSOptions ElasticsearchVersion *string - // Specifies the status of the EncryptionAtRestOptions. + // Specifies the status of the EncryptionAtRestOptions . EncryptionAtRestOptions *EncryptionAtRestOptions // The Elasticsearch domain endpoint that you use to submit index and search @@ -831,14 +801,14 @@ type ElasticsearchDomainStatus struct { Endpoint *string // Map containing the Elasticsearch domain endpoints used to submit index and - // search requests. Example key, value: - // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'. + // search requests. Example key, value : + // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' . Endpoints map[string]string // Log publishing options for the given domain. LogPublishingOptions map[string]LogPublishingOption - // Specifies the status of the NodeToNodeEncryptionOptions. + // Specifies the status of the NodeToNodeEncryptionOptions . NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions // The status of the Elasticsearch domain configuration. True if Amazon @@ -857,9 +827,9 @@ type ElasticsearchDomainStatus struct { // configuration is active. UpgradeProcessing *bool - // The VPCOptions for the specified domain. For more information, see VPC Endpoints - // for Amazon Elasticsearch Service Domains - // (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). + // The VPCOptions for the specified domain. For more information, see VPC + // Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) + // . VPCOptions *VPCDerivedInfo noSmithyDocumentSerde @@ -920,10 +890,10 @@ type ErrorDetails struct { noSmithyDocumentSerde } -// A filter used to limit results when describing inbound or outbound cross-cluster -// search connections. Multiple values can be specified per filter. A cross-cluster -// search connection must match at least one of the specified values for it to be -// returned from an operation. +// A filter used to limit results when describing inbound or outbound +// cross-cluster search connections. Multiple values can be specified per filter. A +// cross-cluster search connection must match at least one of the specified values +// for it to be returned from an operation. type Filter struct { // Specifies the name of the filter. @@ -961,31 +931,21 @@ type InboundCrossClusterSearchConnectionStatus struct { Message *string // The state code for inbound connection. This can be one of the following: - // - // * - // PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain - // owner. - // - // * APPROVED: Inbound connection is pending acceptance by destination - // domain owner. - // - // * REJECTING: Inbound connection rejection is in process. - // - // * - // REJECTED: Inbound connection is rejected. - // - // * DELETING: Inbound connection - // deletion is in progress. - // - // * DELETED: Inbound connection is deleted and cannot be - // used further. + // - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination + // domain owner. + // - APPROVED: Inbound connection is pending acceptance by destination domain + // owner. + // - REJECTING: Inbound connection rejection is in process. + // - REJECTED: Inbound connection is rejected. + // - DELETING: Inbound connection deletion is in progress. + // - DELETED: Inbound connection is deleted and cannot be used further. StatusCode InboundCrossClusterSearchConnectionStatusCode noSmithyDocumentSerde } -// InstanceCountLimits represents the limits on number of instances that be created -// in Amazon Elasticsearch for given InstanceType. +// InstanceCountLimits represents the limits on number of instances that be +// created in Amazon Elasticsearch for given InstanceType. type InstanceCountLimits struct { // Maximum number of Instances that can be instantiated for given InstanceType. @@ -1001,8 +961,8 @@ type InstanceCountLimits struct { // available for given InstanceType. type InstanceLimits struct { - // InstanceCountLimits represents the limits on number of instances that be created - // in Amazon Elasticsearch for given InstanceType. + // InstanceCountLimits represents the limits on number of instances that be + // created in Amazon Elasticsearch for given InstanceType. InstanceCountLimits *InstanceCountLimits noSmithyDocumentSerde @@ -1010,20 +970,19 @@ type InstanceLimits struct { // Limits for given InstanceType and for each of it's role. // -// Limits contains -// following StorageTypes,InstanceLimits and AdditionalLimits +// Limits contains following StorageTypes, InstanceLimits and AdditionalLimits type Limits struct { - // List of additional limits that are specific to a given InstanceType and for each - // of it's InstanceRole . + // List of additional limits that are specific to a given InstanceType and for + // each of it's InstanceRole . AdditionalLimits []AdditionalLimit // InstanceLimits represents the list of instance related attributes that are // available for given InstanceType. InstanceLimits *InstanceLimits - // StorageType represents the list of storage related types and attributes that are - // available for given InstanceType. + // StorageType represents the list of storage related types and attributes that + // are available for given InstanceType. StorageTypes []StorageType noSmithyDocumentSerde @@ -1031,14 +990,10 @@ type Limits struct { // Log Publishing option that is set for given domain. // -// Attributes and their -// details: -// -// * CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which -// log needs to be published. -// -// * Enabled: Whether the log publishing for given log -// type is enabled or not +// Attributes and their details: +// - CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log +// needs to be published. +// - Enabled: Whether the log publishing for given log type is enabled or not type LogPublishingOption struct { // ARN of the Cloudwatch log group to which log needs to be published. @@ -1164,30 +1119,16 @@ type OutboundCrossClusterSearchConnectionStatus struct { Message *string // The state code for outbound connection. This can be one of the following: - // - // * - // VALIDATING: The outbound connection request is being validated. - // - // * - // VALIDATION_FAILED: Validation failed for the connection request. - // - // * - // PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet - // accepted by destination domain owner. - // - // * PROVISIONING: Outbound connection - // request is in process. - // - // * ACTIVE: Outbound connection is active and ready to - // use. - // - // * REJECTED: Outbound connection request is rejected by destination domain - // owner. - // - // * DELETING: Outbound connection deletion is in progress. - // - // * DELETED: - // Outbound connection is deleted and cannot be used further. + // - VALIDATING: The outbound connection request is being validated. + // - VALIDATION_FAILED: Validation failed for the connection request. + // - PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet + // accepted by destination domain owner. + // - PROVISIONING: Outbound connection request is in process. + // - ACTIVE: Outbound connection is active and ready to use. + // - REJECTED: Outbound connection request is rejected by destination domain + // owner. + // - DELETING: Outbound connection deletion is in progress. + // - DELETED: Outbound connection is deleted and cannot be used further. StatusCode OutboundCrossClusterSearchConnectionStatusCode noSmithyDocumentSerde @@ -1412,8 +1353,7 @@ type SAMLOptionsOutput struct { noSmithyDocumentSerde } -// Specifies details of the scheduled Auto-Tune action. See the Developer Guide -// (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) +// Specifies details of the scheduled Auto-Tune action. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) // for more information. type ScheduledAutoTuneDetails struct { @@ -1447,14 +1387,14 @@ type ServiceSoftwareOptions struct { // The current service software version that is present on the domain. CurrentVersion *string - // The description of the UpdateStatus. + // The description of the UpdateStatus . Description *string // The new service software version if one is available. NewVersion *string // True if a service software is never automatically updated. False if a service - // software is automatically updated after AutomatedUpdateDate. + // software is automatically updated after AutomatedUpdateDate . OptionalDeployment *bool // True if you are able to update you service software version. False if you are @@ -1462,7 +1402,7 @@ type ServiceSoftwareOptions struct { UpdateAvailable *bool // The status of your service software update. This field can take the following - // values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE. + // values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE . UpdateStatus DeploymentStatus noSmithyDocumentSerde @@ -1502,31 +1442,19 @@ type StorageType struct { // SubType of the given storage type. List of available sub-storage options: For // "instance" storageType we wont have any storageSubType, in case of "ebs" // storageType we will have following valid storageSubTypes - // - // * standard - // - // * gp2 - // - // * - // gp3 - // - // * io1 - // - // Refer VolumeType for more information regarding above EBS storage - // options. + // - standard + // - gp2 + // - gp3 + // - io1 + // Refer VolumeType for more information regarding above EBS storage options. StorageSubTypeName *string // List of limits that are applicable for given storage type. StorageTypeLimits []StorageTypeLimit // Type of the storage. List of available storage options: - // - // * instance - // Inbuilt - // storage available for the given Instance - // * ebs - // Elastic block storage that would - // be attached to the given Instance + // - instance Inbuilt storage available for the given Instance + // - ebs Elastic block storage that would be attached to the given Instance StorageTypeName *string noSmithyDocumentSerde @@ -1537,29 +1465,18 @@ type StorageTypeLimit struct { // Name of storage limits that are applicable for given storage type. If // StorageType is ebs, following storage options are applicable - // - // * - // MinimumVolumeSize - // Minimum amount of volume size that is applicable for given - // storage type.It can be empty if it is not applicable. - // * MaximumVolumeSize - // - // Maximum amount of volume size that is applicable for given storage type.It can - // be empty if it is not applicable. - // * MaximumIops - // Maximum amount of Iops that is - // applicable for given storage type.It can be empty if it is not applicable. - // * - // MinimumIops - // Minimum amount of Iops that is applicable for given storage type.It - // can be empty if it is not applicable. - // * MaximumThroughput - // Maximum amount of - // Throughput that is applicable for given storage type.It can be empty if it is - // not applicable. - // * MinimumThroughput - // Minimum amount of Throughput that is - // applicable for given storage type.It can be empty if it is not applicable. + // - MinimumVolumeSize Minimum amount of volume size that is applicable for given + // storage type.It can be empty if it is not applicable. + // - MaximumVolumeSize Maximum amount of volume size that is applicable for given + // storage type.It can be empty if it is not applicable. + // - MaximumIops Maximum amount of Iops that is applicable for given storage + // type.It can be empty if it is not applicable. + // - MinimumIops Minimum amount of Iops that is applicable for given storage + // type.It can be empty if it is not applicable. + // - MaximumThroughput Maximum amount of Throughput that is applicable for given + // storage type.It can be empty if it is not applicable. + // - MinimumThroughput Minimum amount of Throughput that is applicable for given + // storage type.It can be empty if it is not applicable. LimitName *string // Values for the StorageTypeLimit$LimitName . @@ -1571,13 +1488,13 @@ type StorageTypeLimit struct { // Specifies a key value pair for a resource tag. type Tag struct { - // Specifies the TagKey, the name of the tag. Tag keys must be unique for the + // Specifies the TagKey , the name of the tag. Tag keys must be unique for the // Elasticsearch domain to which they are attached. // // This member is required. Key *string - // Specifies the TagValue, the value assigned to the corresponding tag key. Tag + // Specifies the TagValue , the value assigned to the corresponding tag key. Tag // values can be null and do not have to be unique in a tag set. For example, you // can have a key value pair in a tag set of project : Trinity and cost-center : // Trinity @@ -1604,14 +1521,10 @@ type UpgradeHistory struct { // The overall status of the update. The status can take one of the following // values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with Issues - // - // * Failed + // - In Progress + // - Succeeded + // - Succeeded with Issues + // - Failed UpgradeStatus UpgradeStatus noSmithyDocumentSerde @@ -1629,33 +1542,25 @@ type UpgradeStepItem struct { // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does // through: - // - // * PreUpgradeCheck - // - // * Snapshot - // - // * Upgrade + // - PreUpgradeCheck + // - Snapshot + // - Upgrade UpgradeStep UpgradeStep // The status of a particular step during an upgrade. The status can take one of // the following values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with Issues - // - // * - // Failed + // - In Progress + // - Succeeded + // - Succeeded with Issues + // - Failed UpgradeStepStatus UpgradeStatus noSmithyDocumentSerde } // Options to specify the subnets and security groups for VPC endpoint. For more -// information, see VPC Endpoints for Amazon Elasticsearch Service Domains -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). +// information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) +// . type VPCDerivedInfo struct { // The availability zones for the Elasticsearch domain. Exists only if the domain @@ -1752,8 +1657,8 @@ type VpcEndpointSummary struct { } // Options to specify the subnets and security groups for VPC endpoint. For more -// information, see VPC Endpoints for Amazon Elasticsearch Service Domains -// (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html). +// information, see VPC Endpoints for Amazon Elasticsearch Service Domains (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) +// . type VPCOptions struct { // Specifies the security groups for VPC endpoint. diff --git a/service/elastictranscoder/api_client.go b/service/elastictranscoder/api_client.go index 79786e2d7b5..283eb4e24db 100644 --- a/service/elastictranscoder/api_client.go +++ b/service/elastictranscoder/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/elastictranscoder/api_op_CancelJob.go b/service/elastictranscoder/api_op_CancelJob.go index c7072912d8f..f5012d2f798 100644 --- a/service/elastictranscoder/api_op_CancelJob.go +++ b/service/elastictranscoder/api_op_CancelJob.go @@ -11,8 +11,8 @@ import ( ) // The CancelJob operation cancels an unfinished job. You can only cancel a job -// that has a status of Submitted. To prevent a pipeline from starting to process a -// job while you're getting the job identifier, use UpdatePipelineStatus to +// that has a status of Submitted . To prevent a pipeline from starting to process +// a job while you're getting the job identifier, use UpdatePipelineStatus to // temporarily pause the pipeline. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { @@ -33,7 +33,7 @@ func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns . type CancelJobInput struct { // The identifier of the job that you want to cancel. To get a list of the jobs - // (including their jobId) that have a status of Submitted, use the + // (including their jobId ) that have a status of Submitted , use the // ListJobsByStatus API action. // // This member is required. @@ -43,7 +43,7 @@ type CancelJobInput struct { } // The response body contains a JSON object. If the job is successfully canceled, -// the value of Success is true. +// the value of Success is true . type CancelJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elastictranscoder/api_op_CreateJob.go b/service/elastictranscoder/api_op_CreateJob.go index 04a2d141f52..3ff4dc0b8b3 100644 --- a/service/elastictranscoder/api_op_CreateJob.go +++ b/service/elastictranscoder/api_op_CreateJob.go @@ -46,8 +46,8 @@ type CreateJobInput struct { // being transcoded. Input *types.JobInput - // A section of the request body that provides information about the files that are - // being transcoded. + // A section of the request body that provides information about the files that + // are being transcoded. Inputs []types.JobInput // A section of the request body that provides information about the transcoded @@ -71,8 +71,8 @@ type CreateJobInput struct { // of master playlists in a job is 30. Playlists []types.CreateJobPlaylist - // User-defined metadata that you want to associate with an Elastic Transcoder job. - // You specify metadata in key/value pairs, and you can add up to 10 key/value + // User-defined metadata that you want to associate with an Elastic Transcoder + // job. You specify metadata in key/value pairs, and you can add up to 10 key/value // pairs per job. Elastic Transcoder does not guarantee that key/value pairs are // returned in the same order in which you specify them. UserMetadata map[string]string diff --git a/service/elastictranscoder/api_op_CreatePipeline.go b/service/elastictranscoder/api_op_CreatePipeline.go index a516d23e365..3fb8d0b0267 100644 --- a/service/elastictranscoder/api_op_CreatePipeline.go +++ b/service/elastictranscoder/api_op_CreatePipeline.go @@ -42,201 +42,146 @@ type CreatePipelineInput struct { // This member is required. Name *string - // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder - // to use to create the pipeline. + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic + // Transcoder to use to create the pipeline. // // This member is required. Role *string // The AWS Key Management Service (AWS KMS) key that you want to use with this - // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't + // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode , you don't // need to provide a key with your job because a default key, known as an AWS-KMS // key, is created for you automatically. You need to provide an AWS-KMS key only // if you want to use a non-default AWS-KMS key, or if you are using an - // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + // Encryption:Mode of aes-cbc-pkcs7 , aes-ctr , or aes-gcm . AwsKmsKeyArn *string // The optional ContentConfig object specifies information about the Amazon S3 // bucket in which you want Elastic Transcoder to save transcoded files and // playlists: which bucket to use, which users you want to have access to the // files, the type of access you want users to have, and the storage class that you - // want to assign to the files. If you specify values for ContentConfig, you must - // also specify values for ThumbnailConfig. If you specify values for ContentConfig - // and ThumbnailConfig, omit the OutputBucket object. - // - // * Bucket: The Amazon S3 - // bucket in which you want Elastic Transcoder to save transcoded files and - // playlists. - // - // * Permissions (Optional): The Permissions object specifies which - // users you want to have access to transcoded files and the type of access you - // want them to have. You can grant permissions to a maximum of 30 users and/or - // predefined Amazon S3 groups. - // - // * Grantee Type: Specify the type of value that - // appears in the Grantee object: - // - // * Canonical: The value in the Grantee object is - // either the canonical user ID for an AWS account or an origin access identity for - // an Amazon CloudFront distribution. For more information about canonical user - // IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service - // Developer Guide. For more information about using CloudFront origin access - // identities to require that users use CloudFront URLs instead of Amazon S3 URLs, - // see Using an Origin Access Identity to Restrict Access to Your Amazon S3 - // Content. A canonical user ID is not the same as an AWS account number. - // - // * Email: - // The value in the Grantee object is the registered email address of an AWS - // account. - // - // * Group: The value in the Grantee object is one of the following - // predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. - // - // * - // Grantee: The AWS user or group that you want to have access to transcoded files - // and playlists. To identify the user or group, you can specify the canonical user - // ID for an AWS account, an origin access identity for a CloudFront distribution, - // the registered email address of an AWS account, or a predefined Amazon S3 - // group - // - // * Access: The permission that you want to give to the AWS user that you - // specified in Grantee. Permissions are granted on the files that Elastic - // Transcoder adds to the bucket, including playlists and video files. Valid values - // include: - // - // * READ: The grantee can read the objects and metadata for objects that - // Elastic Transcoder adds to the Amazon S3 bucket. - // - // * READ_ACP: The grantee can - // read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 - // bucket. - // - // * WRITE_ACP: The grantee can write the ACL for the objects that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * FULL_CONTROL: The grantee has READ, - // READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds - // to the Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 storage class, Standard - // or ReducedRedundancy, that you want Elastic Transcoder to assign to the video - // files and playlists that it stores in your Amazon S3 bucket. + // want to assign to the files. If you specify values for ContentConfig , you must + // also specify values for ThumbnailConfig . If you specify values for + // ContentConfig and ThumbnailConfig , omit the OutputBucket object. + // - Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save + // transcoded files and playlists. + // - Permissions (Optional): The Permissions object specifies which users you + // want to have access to transcoded files and the type of access you want them to + // have. You can grant permissions to a maximum of 30 users and/or predefined + // Amazon S3 groups. + // - Grantee Type: Specify the type of value that appears in the Grantee object: + // - Canonical: The value in the Grantee object is either the canonical user ID + // for an AWS account or an origin access identity for an Amazon CloudFront + // distribution. For more information about canonical user IDs, see Access Control + // List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For + // more information about using CloudFront origin access identities to require that + // users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access + // Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is + // not the same as an AWS account number. + // - Email: The value in the Grantee object is the registered email address of an + // AWS account. + // - Group: The value in the Grantee object is one of the following predefined + // Amazon S3 groups: AllUsers , AuthenticatedUsers , or LogDelivery . + // - Grantee: The AWS user or group that you want to have access to transcoded + // files and playlists. To identify the user or group, you can specify the + // canonical user ID for an AWS account, an origin access identity for a CloudFront + // distribution, the registered email address of an AWS account, or a predefined + // Amazon S3 group + // - Access: The permission that you want to give to the AWS user that you + // specified in Grantee . Permissions are granted on the files that Elastic + // Transcoder adds to the bucket, including playlists and video files. Valid values + // include: + // - READ : The grantee can read the objects and metadata for objects that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ , READ_ACP , and WRITE_ACP permissions + // for the objects that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy , + // that you want Elastic Transcoder to assign to the video files and playlists that + // it stores in your Amazon S3 bucket. ContentConfig *types.PipelineOutputConfig // The Amazon Simple Notification Service (Amazon SNS) topic that you want to // notify to report job status. To receive notifications, you must also subscribe // to the new topic in the Amazon SNS console. - // - // * Progressing: The topic ARN for - // the Amazon Simple Notification Service (Amazon SNS) topic that you want to - // notify when Elastic Transcoder has started to process a job in this pipeline. - // This is the ARN that Amazon SNS returned when you created the topic. For more - // information, see Create a Topic in the Amazon Simple Notification Service - // Developer Guide. - // - // * Complete: The topic ARN for the Amazon SNS topic that you - // want to notify when Elastic Transcoder has finished processing a job in this - // pipeline. This is the ARN that Amazon SNS returned when you created the - // topic. - // - // * Warning: The topic ARN for the Amazon SNS topic that you want to - // notify when Elastic Transcoder encounters a warning condition while processing a - // job in this pipeline. This is the ARN that Amazon SNS returned when you created - // the topic. - // - // * Error: The topic ARN for the Amazon SNS topic that you want to - // notify when Elastic Transcoder encounters an error condition while processing a - // job in this pipeline. This is the ARN that Amazon SNS returned when you created - // the topic. + // - Progressing: The topic ARN for the Amazon Simple Notification Service + // (Amazon SNS) topic that you want to notify when Elastic Transcoder has started + // to process a job in this pipeline. This is the ARN that Amazon SNS returned when + // you created the topic. For more information, see Create a Topic in the Amazon + // Simple Notification Service Developer Guide. + // - Complete: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder has finished processing a job in this pipeline. This is + // the ARN that Amazon SNS returned when you created the topic. + // - Warning: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder encounters a warning condition while processing a job in + // this pipeline. This is the ARN that Amazon SNS returned when you created the + // topic. + // - Error: The topic ARN for the Amazon SNS topic that you want to notify when + // Elastic Transcoder encounters an error condition while processing a job in this + // pipeline. This is the ARN that Amazon SNS returned when you created the topic. Notifications *types.Notifications - // The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded - // files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) - // Specify this value when all of the following are true: - // - // * You want to save - // transcoded files, thumbnails (if any), and playlists (if any) together in one - // bucket. - // - // * You do not want to specify the users or groups who have access to the - // transcoded files, thumbnails, and playlists. - // - // * You do not want to specify the - // permissions that Elastic Transcoder grants to the files. When Elastic Transcoder - // saves files in OutputBucket, it grants full control over the files only to the - // AWS account that owns the role that is specified by Role. - // - // * You want to - // associate the transcoded files and thumbnails with the Amazon S3 Standard - // storage class. - // - // If you want to save transcoded files and playlists in one bucket - // and thumbnails in another bucket, specify which users can access the transcoded - // files or the permissions the users have, or change the Amazon S3 storage class, - // omit OutputBucket and specify values for ContentConfig and ThumbnailConfig - // instead. + // The Amazon S3 bucket in which you want Elastic Transcoder to save the + // transcoded files. (Use this, or use ContentConfig:Bucket plus + // ThumbnailConfig:Bucket.) Specify this value when all of the following are true: + // - You want to save transcoded files, thumbnails (if any), and playlists (if + // any) together in one bucket. + // - You do not want to specify the users or groups who have access to the + // transcoded files, thumbnails, and playlists. + // - You do not want to specify the permissions that Elastic Transcoder grants + // to the files. When Elastic Transcoder saves files in OutputBucket , it grants + // full control over the files only to the AWS account that owns the role that is + // specified by Role . + // - You want to associate the transcoded files and thumbnails with the Amazon + // S3 Standard storage class. + // If you want to save transcoded files and playlists in one bucket and thumbnails + // in another bucket, specify which users can access the transcoded files or the + // permissions the users have, or change the Amazon S3 storage class, omit + // OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. OutputBucket *string // The ThumbnailConfig object specifies several values, including the Amazon S3 // bucket in which you want Elastic Transcoder to save thumbnail files, which users // you want to have access to the files, the type of access you want users to have, // and the storage class that you want to assign to the files. If you specify - // values for ContentConfig, you must also specify values for ThumbnailConfig even - // if you don't want to create thumbnails. If you specify values for ContentConfig - // and ThumbnailConfig, omit the OutputBucket object. - // - // * Bucket: The Amazon S3 - // bucket in which you want Elastic Transcoder to save thumbnail files. - // - // * - // Permissions (Optional): The Permissions object specifies which users and/or - // predefined Amazon S3 groups you want to have access to thumbnail files, and the - // type of access you want them to have. You can grant permissions to a maximum of - // 30 users and/or predefined Amazon S3 groups. - // - // * GranteeType: Specify the type of - // value that appears in the Grantee object: - // - // * Canonical: The value in the Grantee - // object is either the canonical user ID for an AWS account or an origin access - // identity for an Amazon CloudFront distribution. A canonical user ID is not the - // same as an AWS account number. - // - // * Email: The value in the Grantee object is the - // registered email address of an AWS account. - // - // * Group: The value in the Grantee - // object is one of the following predefined Amazon S3 groups: AllUsers, - // AuthenticatedUsers, or LogDelivery. - // - // * Grantee: The AWS user or group that you - // want to have access to thumbnail files. To identify the user or group, you can - // specify the canonical user ID for an AWS account, an origin access identity for - // a CloudFront distribution, the registered email address of an AWS account, or a - // predefined Amazon S3 group. - // - // * Access: The permission that you want to give to - // the AWS user that you specified in Grantee. Permissions are granted on the - // thumbnail files that Elastic Transcoder adds to the bucket. Valid values - // include: - // - // * READ: The grantee can read the thumbnails and metadata for objects - // that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * READ_ACP: The grantee - // can read the object ACL for thumbnails that Elastic Transcoder adds to the - // Amazon S3 bucket. - // - // * WRITE_ACP: The grantee can write the ACL for the thumbnails - // that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * FULL_CONTROL: The - // grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that - // Elastic Transcoder adds to the Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 - // storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder - // to assign to the thumbnails that it stores in your Amazon S3 bucket. + // values for ContentConfig , you must also specify values for ThumbnailConfig + // even if you don't want to create thumbnails. If you specify values for + // ContentConfig and ThumbnailConfig , omit the OutputBucket object. + // - Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save + // thumbnail files. + // - Permissions (Optional): The Permissions object specifies which users and/or + // predefined Amazon S3 groups you want to have access to thumbnail files, and the + // type of access you want them to have. You can grant permissions to a maximum of + // 30 users and/or predefined Amazon S3 groups. + // - GranteeType: Specify the type of value that appears in the Grantee object: + // - Canonical: The value in the Grantee object is either the canonical user ID + // for an AWS account or an origin access identity for an Amazon CloudFront + // distribution. A canonical user ID is not the same as an AWS account number. + // - Email: The value in the Grantee object is the registered email address of an + // AWS account. + // - Group: The value in the Grantee object is one of the following predefined + // Amazon S3 groups: AllUsers , AuthenticatedUsers , or LogDelivery . + // - Grantee: The AWS user or group that you want to have access to thumbnail + // files. To identify the user or group, you can specify the canonical user ID for + // an AWS account, an origin access identity for a CloudFront distribution, the + // registered email address of an AWS account, or a predefined Amazon S3 group. + // - Access: The permission that you want to give to the AWS user that you + // specified in Grantee . Permissions are granted on the thumbnail files that + // Elastic Transcoder adds to the bucket. Valid values include: + // - READ : The grantee can read the thumbnails and metadata for objects that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ , READ_ACP , and WRITE_ACP permissions + // for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy , + // that you want Elastic Transcoder to assign to the thumbnails that it stores in + // your Amazon S3 bucket. ThumbnailConfig *types.PipelineOutputConfig noSmithyDocumentSerde @@ -246,8 +191,8 @@ type CreatePipelineInput struct { // specified in the request. type CreatePipelineOutput struct { - // A section of the response body that provides information about the pipeline that - // is created. + // A section of the response body that provides information about the pipeline + // that is created. Pipeline *types.Pipeline // Elastic Transcoder returns a warning if the resources used by your pipeline are diff --git a/service/elastictranscoder/api_op_CreatePreset.go b/service/elastictranscoder/api_op_CreatePreset.go index ff4096c56d1..ab5270b1e60 100644 --- a/service/elastictranscoder/api_op_CreatePreset.go +++ b/service/elastictranscoder/api_op_CreatePreset.go @@ -15,7 +15,7 @@ import ( // Elastic Transcoder checks the CreatePreset settings to ensure that they meet // Elastic Transcoder requirements and to determine whether they comply with H.264 // standards. If your settings are not valid for Elastic Transcoder, Elastic -// Transcoder returns an HTTP 400 response (ValidationException) and does not +// Transcoder returns an HTTP 400 response ( ValidationException ) and does not // create the preset. If the settings are valid for Elastic Transcoder but aren't // strictly compliant with the H.264 standard, Elastic Transcoder creates the // preset and returns a warning message in the response. This helps you determine @@ -42,8 +42,8 @@ func (c *Client) CreatePreset(ctx context.Context, params *CreatePresetInput, op // The CreatePresetRequest structure. type CreatePresetInput struct { - // The container type for the output file. Valid values include flac, flv, fmp4, - // gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. + // The container type for the output file. Valid values include flac , flv , fmp4 , + // gif , mp3 , mp4 , mpg , mxf , oga , ogg , ts , and webm . // // This member is required. Container *string diff --git a/service/elastictranscoder/api_op_ListJobsByPipeline.go b/service/elastictranscoder/api_op_ListJobsByPipeline.go index 923356bbb5c..de92da6cf56 100644 --- a/service/elastictranscoder/api_op_ListJobsByPipeline.go +++ b/service/elastictranscoder/api_op_ListJobsByPipeline.go @@ -40,7 +40,8 @@ type ListJobsByPipelineInput struct { PipelineId *string // To list jobs in chronological order by the date and time that they were - // submitted, enter true. To list jobs in reverse chronological order, enter false. + // submitted, enter true . To list jobs in reverse chronological order, enter false + // . Ascending *string // When Elastic Transcoder returns more than one page of results, use pageToken in @@ -58,7 +59,7 @@ type ListJobsByPipelineOutput struct { // A value that you use to access the second and subsequent pages of results, if // any. When the jobs in the specified pipeline fit on one page or when you've - // reached the last page of results, the value of NextPageToken is null. + // reached the last page of results, the value of NextPageToken is null . NextPageToken *string // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_ListJobsByStatus.go b/service/elastictranscoder/api_op_ListJobsByStatus.go index 2a04c01fc44..3005d67fddf 100644 --- a/service/elastictranscoder/api_op_ListJobsByStatus.go +++ b/service/elastictranscoder/api_op_ListJobsByStatus.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListJobsByStatus operation gets a list of jobs that have a specified status. -// The response body contains one element for each job that satisfies the search -// criteria. +// The ListJobsByStatus operation gets a list of jobs that have a specified +// status. The response body contains one element for each job that satisfies the +// search criteria. func (c *Client) ListJobsByStatus(ctx context.Context, params *ListJobsByStatusInput, optFns ...func(*Options)) (*ListJobsByStatusOutput, error) { if params == nil { params = &ListJobsByStatusInput{} @@ -33,15 +33,16 @@ func (c *Client) ListJobsByStatus(ctx context.Context, params *ListJobsByStatusI // The ListJobsByStatusRequest structure. type ListJobsByStatusInput struct { - // To get information about all of the jobs associated with the current AWS account - // that have a given status, specify the following status: Submitted, Progressing, - // Complete, Canceled, or Error. + // To get information about all of the jobs associated with the current AWS + // account that have a given status, specify the following status: Submitted , + // Progressing , Complete , Canceled , or Error . // // This member is required. Status *string // To list jobs in chronological order by the date and time that they were - // submitted, enter true. To list jobs in reverse chronological order, enter false. + // submitted, enter true . To list jobs in reverse chronological order, enter false + // . Ascending *string // When Elastic Transcoder returns more than one page of results, use pageToken in @@ -59,7 +60,7 @@ type ListJobsByStatusOutput struct { // A value that you use to access the second and subsequent pages of results, if // any. When the jobs in the specified pipeline fit on one page or when you've - // reached the last page of results, the value of NextPageToken is null. + // reached the last page of results, the value of NextPageToken is null . NextPageToken *string // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_ListPipelines.go b/service/elastictranscoder/api_op_ListPipelines.go index 86a05c8d747..9f227543943 100644 --- a/service/elastictranscoder/api_op_ListPipelines.go +++ b/service/elastictranscoder/api_op_ListPipelines.go @@ -33,8 +33,8 @@ func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, type ListPipelinesInput struct { // To list pipelines in chronological order by the date and time that they were - // created, enter true. To list pipelines in reverse chronological order, enter - // false. + // created, enter true . To list pipelines in reverse chronological order, enter + // false . Ascending *string // When Elastic Transcoder returns more than one page of results, use pageToken in @@ -49,7 +49,7 @@ type ListPipelinesOutput struct { // A value that you use to access the second and subsequent pages of results, if // any. When the pipelines fit on one page or when you've reached the last page of - // results, the value of NextPageToken is null. + // results, the value of NextPageToken is null . NextPageToken *string // An array of Pipeline objects. diff --git a/service/elastictranscoder/api_op_ListPresets.go b/service/elastictranscoder/api_op_ListPresets.go index 328c00d91ab..9fdc163aaf9 100644 --- a/service/elastictranscoder/api_op_ListPresets.go +++ b/service/elastictranscoder/api_op_ListPresets.go @@ -33,8 +33,8 @@ func (c *Client) ListPresets(ctx context.Context, params *ListPresetsInput, optF type ListPresetsInput struct { // To list presets in chronological order by the date and time that they were - // created, enter true. To list presets in reverse chronological order, enter - // false. + // created, enter true . To list presets in reverse chronological order, enter + // false . Ascending *string // When Elastic Transcoder returns more than one page of results, use pageToken in @@ -49,7 +49,7 @@ type ListPresetsOutput struct { // A value that you use to access the second and subsequent pages of results, if // any. When the presets fit on one page or when you've reached the last page of - // results, the value of NextPageToken is null. + // results, the value of NextPageToken is null . NextPageToken *string // An array of Preset objects. diff --git a/service/elastictranscoder/api_op_ReadJob.go b/service/elastictranscoder/api_op_ReadJob.go index 75b8056950e..66f68eb6f8d 100644 --- a/service/elastictranscoder/api_op_ReadJob.go +++ b/service/elastictranscoder/api_op_ReadJob.go @@ -138,9 +138,9 @@ type JobCompleteWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, JobCompleteWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, JobCompleteWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/elastictranscoder/api_op_TestRole.go b/service/elastictranscoder/api_op_TestRole.go index d89a6006c8d..20d2d305a1a 100644 --- a/service/elastictranscoder/api_op_TestRole.go +++ b/service/elastictranscoder/api_op_TestRole.go @@ -48,8 +48,8 @@ type TestRoleInput struct { // This member is required. OutputBucket *string - // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder - // to test. + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic + // Transcoder to test. // // This member is required. Role *string @@ -66,12 +66,12 @@ type TestRoleInput struct { // The TestRoleResponse structure. type TestRoleOutput struct { - // If the Success element contains false, this value is an array of one or more + // If the Success element contains false , this value is an array of one or more // error messages that were generated during the test process. Messages []string - // If the operation is successful, this value is true; otherwise, the value is - // false. + // If the operation is successful, this value is true ; otherwise, the value is + // false . Success *string // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_UpdatePipeline.go b/service/elastictranscoder/api_op_UpdatePipeline.go index 9a49104a700..967a6670a46 100644 --- a/service/elastictranscoder/api_op_UpdatePipeline.go +++ b/service/elastictranscoder/api_op_UpdatePipeline.go @@ -39,78 +39,59 @@ type UpdatePipelineInput struct { Id *string // The AWS Key Management Service (AWS KMS) key that you want to use with this - // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't + // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode , you don't // need to provide a key with your job because a default key, known as an AWS-KMS // key, is created for you automatically. You need to provide an AWS-KMS key only // if you want to use a non-default AWS-KMS key, or if you are using an - // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + // Encryption:Mode of aes-cbc-pkcs7 , aes-ctr , or aes-gcm . AwsKmsKeyArn *string // The optional ContentConfig object specifies information about the Amazon S3 // bucket in which you want Elastic Transcoder to save transcoded files and // playlists: which bucket to use, which users you want to have access to the // files, the type of access you want users to have, and the storage class that you - // want to assign to the files. If you specify values for ContentConfig, you must - // also specify values for ThumbnailConfig. If you specify values for ContentConfig - // and ThumbnailConfig, omit the OutputBucket object. - // - // * Bucket: The Amazon S3 - // bucket in which you want Elastic Transcoder to save transcoded files and - // playlists. - // - // * Permissions (Optional): The Permissions object specifies which - // users you want to have access to transcoded files and the type of access you - // want them to have. You can grant permissions to a maximum of 30 users and/or - // predefined Amazon S3 groups. - // - // * Grantee Type: Specify the type of value that - // appears in the Grantee object: - // - // * Canonical: The value in the Grantee object is - // either the canonical user ID for an AWS account or an origin access identity for - // an Amazon CloudFront distribution. For more information about canonical user - // IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service - // Developer Guide. For more information about using CloudFront origin access - // identities to require that users use CloudFront URLs instead of Amazon S3 URLs, - // see Using an Origin Access Identity to Restrict Access to Your Amazon S3 - // Content. A canonical user ID is not the same as an AWS account number. - // - // * Email: - // The value in the Grantee object is the registered email address of an AWS - // account. - // - // * Group: The value in the Grantee object is one of the following - // predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. - // - // * - // Grantee: The AWS user or group that you want to have access to transcoded files - // and playlists. To identify the user or group, you can specify the canonical user - // ID for an AWS account, an origin access identity for a CloudFront distribution, - // the registered email address of an AWS account, or a predefined Amazon S3 - // group - // - // * Access: The permission that you want to give to the AWS user that you - // specified in Grantee. Permissions are granted on the files that Elastic - // Transcoder adds to the bucket, including playlists and video files. Valid values - // include: - // - // * READ: The grantee can read the objects and metadata for objects that - // Elastic Transcoder adds to the Amazon S3 bucket. - // - // * READ_ACP: The grantee can - // read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 - // bucket. - // - // * WRITE_ACP: The grantee can write the ACL for the objects that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * FULL_CONTROL: The grantee has READ, - // READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds - // to the Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 storage class, Standard - // or ReducedRedundancy, that you want Elastic Transcoder to assign to the video - // files and playlists that it stores in your Amazon S3 bucket. + // want to assign to the files. If you specify values for ContentConfig , you must + // also specify values for ThumbnailConfig . If you specify values for + // ContentConfig and ThumbnailConfig , omit the OutputBucket object. + // - Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save + // transcoded files and playlists. + // - Permissions (Optional): The Permissions object specifies which users you + // want to have access to transcoded files and the type of access you want them to + // have. You can grant permissions to a maximum of 30 users and/or predefined + // Amazon S3 groups. + // - Grantee Type: Specify the type of value that appears in the Grantee object: + // - Canonical: The value in the Grantee object is either the canonical user ID + // for an AWS account or an origin access identity for an Amazon CloudFront + // distribution. For more information about canonical user IDs, see Access Control + // List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For + // more information about using CloudFront origin access identities to require that + // users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access + // Identity to Restrict Access to Your Amazon S3 Content. A canonical user ID is + // not the same as an AWS account number. + // - Email: The value in the Grantee object is the registered email address of an + // AWS account. + // - Group: The value in the Grantee object is one of the following predefined + // Amazon S3 groups: AllUsers , AuthenticatedUsers , or LogDelivery . + // - Grantee: The AWS user or group that you want to have access to transcoded + // files and playlists. To identify the user or group, you can specify the + // canonical user ID for an AWS account, an origin access identity for a CloudFront + // distribution, the registered email address of an AWS account, or a predefined + // Amazon S3 group + // - Access: The permission that you want to give to the AWS user that you + // specified in Grantee . Permissions are granted on the files that Elastic + // Transcoder adds to the bucket, including playlists and video files. Valid values + // include: + // - READ : The grantee can read the objects and metadata for objects that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ , READ_ACP , and WRITE_ACP permissions + // for the objects that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy , + // that you want Elastic Transcoder to assign to the video files and playlists that + // it stores in your Amazon S3 bucket. ContentConfig *types.PipelineOutputConfig // The Amazon S3 bucket in which you saved the media files that you want to @@ -121,94 +102,67 @@ type UpdatePipelineInput struct { // account, but uniqueness is not enforced. Constraints: Maximum 40 characters Name *string - // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that - // you want to notify to report job status. To receive notifications, you must also - // subscribe to the new topic in the Amazon SNS console. - // - // * Progressing: The topic - // ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want - // to notify when Elastic Transcoder has started to process jobs that are added to - // this pipeline. This is the ARN that Amazon SNS returned when you created the - // topic. - // - // * Complete: The topic ARN for the Amazon SNS topic that you want to - // notify when Elastic Transcoder has finished processing a job. This is the ARN - // that Amazon SNS returned when you created the topic. - // - // * Warning: The topic ARN - // for the Amazon SNS topic that you want to notify when Elastic Transcoder - // encounters a warning condition. This is the ARN that Amazon SNS returned when - // you created the topic. - // - // * Error: The topic ARN for the Amazon SNS topic that you - // want to notify when Elastic Transcoder encounters an error condition. This is - // the ARN that Amazon SNS returned when you created the topic. + // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic + // that you want to notify to report job status. To receive notifications, you must + // also subscribe to the new topic in the Amazon SNS console. + // - Progressing: The topic ARN for the Amazon Simple Notification Service + // (Amazon SNS) topic that you want to notify when Elastic Transcoder has started + // to process jobs that are added to this pipeline. This is the ARN that Amazon SNS + // returned when you created the topic. + // - Complete: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder has finished processing a job. This is the ARN that + // Amazon SNS returned when you created the topic. + // - Warning: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder encounters a warning condition. This is the ARN that + // Amazon SNS returned when you created the topic. + // - Error: The topic ARN for the Amazon SNS topic that you want to notify when + // Elastic Transcoder encounters an error condition. This is the ARN that Amazon + // SNS returned when you created the topic. Notifications *types.Notifications - // The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder - // to use to transcode jobs for this pipeline. + // The IAM Amazon Resource Name (ARN) for the role that you want Elastic + // Transcoder to use to transcode jobs for this pipeline. Role *string // The ThumbnailConfig object specifies several values, including the Amazon S3 // bucket in which you want Elastic Transcoder to save thumbnail files, which users // you want to have access to the files, the type of access you want users to have, // and the storage class that you want to assign to the files. If you specify - // values for ContentConfig, you must also specify values for ThumbnailConfig even - // if you don't want to create thumbnails. If you specify values for ContentConfig - // and ThumbnailConfig, omit the OutputBucket object. - // - // * Bucket: The Amazon S3 - // bucket in which you want Elastic Transcoder to save thumbnail files. - // - // * - // Permissions (Optional): The Permissions object specifies which users and/or - // predefined Amazon S3 groups you want to have access to thumbnail files, and the - // type of access you want them to have. You can grant permissions to a maximum of - // 30 users and/or predefined Amazon S3 groups. - // - // * GranteeType: Specify the type of - // value that appears in the Grantee object: - // - // * Canonical: The value in the Grantee - // object is either the canonical user ID for an AWS account or an origin access - // identity for an Amazon CloudFront distribution. A canonical user ID is not the - // same as an AWS account number. - // - // * Email: The value in the Grantee object is the - // registered email address of an AWS account. - // - // * Group: The value in the Grantee - // object is one of the following predefined Amazon S3 groups: AllUsers, - // AuthenticatedUsers, or LogDelivery. - // - // * Grantee: The AWS user or group that you - // want to have access to thumbnail files. To identify the user or group, you can - // specify the canonical user ID for an AWS account, an origin access identity for - // a CloudFront distribution, the registered email address of an AWS account, or a - // predefined Amazon S3 group. - // - // * Access: The permission that you want to give to - // the AWS user that you specified in Grantee. Permissions are granted on the - // thumbnail files that Elastic Transcoder adds to the bucket. Valid values - // include: - // - // * READ: The grantee can read the thumbnails and metadata for objects - // that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * READ_ACP: The grantee - // can read the object ACL for thumbnails that Elastic Transcoder adds to the - // Amazon S3 bucket. - // - // * WRITE_ACP: The grantee can write the ACL for the thumbnails - // that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * FULL_CONTROL: The - // grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that - // Elastic Transcoder adds to the Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 - // storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder - // to assign to the thumbnails that it stores in your Amazon S3 bucket. + // values for ContentConfig , you must also specify values for ThumbnailConfig + // even if you don't want to create thumbnails. If you specify values for + // ContentConfig and ThumbnailConfig , omit the OutputBucket object. + // - Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save + // thumbnail files. + // - Permissions (Optional): The Permissions object specifies which users and/or + // predefined Amazon S3 groups you want to have access to thumbnail files, and the + // type of access you want them to have. You can grant permissions to a maximum of + // 30 users and/or predefined Amazon S3 groups. + // - GranteeType: Specify the type of value that appears in the Grantee object: + // - Canonical: The value in the Grantee object is either the canonical user ID + // for an AWS account or an origin access identity for an Amazon CloudFront + // distribution. A canonical user ID is not the same as an AWS account number. + // - Email: The value in the Grantee object is the registered email address of an + // AWS account. + // - Group: The value in the Grantee object is one of the following predefined + // Amazon S3 groups: AllUsers , AuthenticatedUsers , or LogDelivery . + // - Grantee: The AWS user or group that you want to have access to thumbnail + // files. To identify the user or group, you can specify the canonical user ID for + // an AWS account, an origin access identity for a CloudFront distribution, the + // registered email address of an AWS account, or a predefined Amazon S3 group. + // - Access: The permission that you want to give to the AWS user that you + // specified in Grantee . Permissions are granted on the thumbnail files that + // Elastic Transcoder adds to the bucket. Valid values include: + // - READ : The grantee can read the thumbnails and metadata for objects that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ , READ_ACP , and WRITE_ACP permissions + // for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy , + // that you want Elastic Transcoder to assign to the thumbnails that it stores in + // your Amazon S3 bucket. ThumbnailConfig *types.PipelineOutputConfig noSmithyDocumentSerde diff --git a/service/elastictranscoder/api_op_UpdatePipelineNotifications.go b/service/elastictranscoder/api_op_UpdatePipelineNotifications.go index bedc082df29..5b2077953c7 100644 --- a/service/elastictranscoder/api_op_UpdatePipelineNotifications.go +++ b/service/elastictranscoder/api_op_UpdatePipelineNotifications.go @@ -39,28 +39,22 @@ type UpdatePipelineNotificationsInput struct { // This member is required. Id *string - // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that - // you want to notify to report job status. To receive notifications, you must also - // subscribe to the new topic in the Amazon SNS console. - // - // * Progressing: The topic - // ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want - // to notify when Elastic Transcoder has started to process jobs that are added to - // this pipeline. This is the ARN that Amazon SNS returned when you created the - // topic. - // - // * Complete: The topic ARN for the Amazon SNS topic that you want to - // notify when Elastic Transcoder has finished processing a job. This is the ARN - // that Amazon SNS returned when you created the topic. - // - // * Warning: The topic ARN - // for the Amazon SNS topic that you want to notify when Elastic Transcoder - // encounters a warning condition. This is the ARN that Amazon SNS returned when - // you created the topic. - // - // * Error: The topic ARN for the Amazon SNS topic that you - // want to notify when Elastic Transcoder encounters an error condition. This is - // the ARN that Amazon SNS returned when you created the topic. + // The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic + // that you want to notify to report job status. To receive notifications, you must + // also subscribe to the new topic in the Amazon SNS console. + // - Progressing: The topic ARN for the Amazon Simple Notification Service + // (Amazon SNS) topic that you want to notify when Elastic Transcoder has started + // to process jobs that are added to this pipeline. This is the ARN that Amazon SNS + // returned when you created the topic. + // - Complete: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder has finished processing a job. This is the ARN that + // Amazon SNS returned when you created the topic. + // - Warning: The topic ARN for the Amazon SNS topic that you want to notify + // when Elastic Transcoder encounters a warning condition. This is the ARN that + // Amazon SNS returned when you created the topic. + // - Error: The topic ARN for the Amazon SNS topic that you want to notify when + // Elastic Transcoder encounters an error condition. This is the ARN that Amazon + // SNS returned when you created the topic. // // This member is required. Notifications *types.Notifications diff --git a/service/elastictranscoder/api_op_UpdatePipelineStatus.go b/service/elastictranscoder/api_op_UpdatePipelineStatus.go index 75f3d8fc1a3..ac9b474590e 100644 --- a/service/elastictranscoder/api_op_UpdatePipelineStatus.go +++ b/service/elastictranscoder/api_op_UpdatePipelineStatus.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the -// pipeline stops or restarts the processing of jobs. Changing the pipeline status -// is useful if you want to cancel one or more jobs. You can't cancel jobs after -// Elastic Transcoder has started processing them; if you pause the pipeline to -// which you submitted the jobs, you have more time to get the job IDs for the jobs -// that you want to cancel, and to send a CancelJob request. +// The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that +// the pipeline stops or restarts the processing of jobs. Changing the pipeline +// status is useful if you want to cancel one or more jobs. You can't cancel jobs +// after Elastic Transcoder has started processing them; if you pause the pipeline +// to which you submitted the jobs, you have more time to get the job IDs for the +// jobs that you want to cancel, and to send a CancelJob request. func (c *Client) UpdatePipelineStatus(ctx context.Context, params *UpdatePipelineStatusInput, optFns ...func(*Options)) (*UpdatePipelineStatusOutput, error) { if params == nil { params = &UpdatePipelineStatusInput{} @@ -41,11 +41,8 @@ type UpdatePipelineStatusInput struct { Id *string // The desired status of the pipeline: - // - // * Active: The pipeline is processing - // jobs. - // - // * Paused: The pipeline is not currently processing jobs. + // - Active : The pipeline is processing jobs. + // - Paused : The pipeline is not currently processing jobs. // // This member is required. Status *string diff --git a/service/elastictranscoder/types/types.go b/service/elastictranscoder/types/types.go index 6d9deedc7ae..b9d7d04331d 100644 --- a/service/elastictranscoder/types/types.go +++ b/service/elastictranscoder/types/types.go @@ -6,15 +6,15 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// The file to be used as album art. There can be multiple artworks associated with -// an audio file, to a maximum of 20. To remove artwork or leave the artwork empty, -// you can either set Artwork to null, or set the Merge Policy to "Replace" and use -// an empty Artwork array. To pass through existing artwork unchanged, set the -// Merge Policy to "Prepend", "Append", or "Fallback", and use an empty Artwork +// The file to be used as album art. There can be multiple artworks associated +// with an audio file, to a maximum of 20. To remove artwork or leave the artwork +// empty, you can either set Artwork to null, or set the Merge Policy to "Replace" +// and use an empty Artwork array. To pass through existing artwork unchanged, set +// the Merge Policy to "Prepend", "Append", or "Fallback", and use an empty Artwork // array. type Artwork struct { - // The format of album art, if any. Valid formats are .jpg and .png. + // The format of album art, if any. Valid formats are .jpg and .png . AlbumArtFormat *string // The encryption settings, if any, that you want Elastic Transcoder to apply to @@ -23,60 +23,51 @@ type Artwork struct { // The name of the file to be used as album art. To determine which Amazon S3 // bucket contains the specified file, Elastic Transcoder checks the pipeline - // specified by PipelineId; the InputBucket object in that pipeline identifies the - // bucket. If the file name includes a prefix, for example, cooking/pie.jpg, + // specified by PipelineId ; the InputBucket object in that pipeline identifies + // the bucket. If the file name includes a prefix, for example, cooking/pie.jpg , // include the prefix in the key. If the file isn't in the specified bucket, // Elastic Transcoder returns an error. InputKey *string - // The maximum height of the output album art in pixels. If you specify auto, + // The maximum height of the output album art in pixels. If you specify auto , // Elastic Transcoder uses 600 as the default value. If you specify a numeric // value, enter an even integer between 32 and 3072, inclusive. MaxHeight *string - // The maximum width of the output album art in pixels. If you specify auto, + // The maximum width of the output album art in pixels. If you specify auto , // Elastic Transcoder uses 600 as the default value. If you specify a numeric // value, enter an even integer between 32 and 4096, inclusive. MaxWidth *string - // When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the + // When you set PaddingPolicy to Pad , Elastic Transcoder may add white bars to the // top and bottom and/or left and right sides of the output album art to make the // total size of the output art match the values that you specified for MaxWidth - // and MaxHeight. + // and MaxHeight . PaddingPolicy *string - // Specify one of the following values to control scaling of the output album - // art: - // - // * Fit: Elastic Transcoder scales the output art so it matches the value - // that you specified in either MaxWidth or MaxHeight without exceeding the other - // value. - // - // * Fill: Elastic Transcoder scales the output art so it matches the value - // that you specified in either MaxWidth or MaxHeight and matches or exceeds the - // other value. Elastic Transcoder centers the output art and then crops it in the - // dimension (if any) that exceeds the maximum value. - // - // * Stretch: Elastic - // Transcoder stretches the output art to match the values that you specified for - // MaxWidth and MaxHeight. If the relative proportions of the input art and the - // output art are different, the output art will be distorted. - // - // * Keep: Elastic - // Transcoder does not scale the output art. If either dimension of the input art - // exceeds the values that you specified for MaxWidth and MaxHeight, Elastic - // Transcoder crops the output art. - // - // * ShrinkToFit: Elastic Transcoder scales the - // output art down so that its dimensions match the values that you specified for - // at least one of MaxWidth and MaxHeight without exceeding either value. If you - // specify this option, Elastic Transcoder does not scale the art up. - // - // * - // ShrinkToFill Elastic Transcoder scales the output art down so that its - // dimensions match the values that you specified for at least one of MaxWidth and - // MaxHeight without dropping below either value. If you specify this option, - // Elastic Transcoder does not scale the art up. + // Specify one of the following values to control scaling of the output album art: + // - Fit: Elastic Transcoder scales the output art so it matches the value that + // you specified in either MaxWidth or MaxHeight without exceeding the other + // value. + // - Fill: Elastic Transcoder scales the output art so it matches the value that + // you specified in either MaxWidth or MaxHeight and matches or exceeds the other + // value. Elastic Transcoder centers the output art and then crops it in the + // dimension (if any) that exceeds the maximum value. + // - Stretch: Elastic Transcoder stretches the output art to match the values + // that you specified for MaxWidth and MaxHeight . If the relative proportions of + // the input art and the output art are different, the output art will be + // distorted. + // - Keep: Elastic Transcoder does not scale the output art. If either dimension + // of the input art exceeds the values that you specified for MaxWidth and + // MaxHeight , Elastic Transcoder crops the output art. + // - ShrinkToFit: Elastic Transcoder scales the output art down so that its + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without exceeding either value. If you specify this option, + // Elastic Transcoder does not scale the art up. + // - ShrinkToFill Elastic Transcoder scales the output art down so that its + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without dropping below either value. If you specify this option, + // Elastic Transcoder does not scale the art up. SizingPolicy *string noSmithyDocumentSerde @@ -88,42 +79,35 @@ type AudioCodecOptions struct { // You can only choose an audio bit depth when you specify flac or pcm for the // value of Audio:Codec. The bit depth of a sample is how many bits of information // are included in the audio samples. The higher the bit depth, the better the - // audio, but the larger the file. Valid values are 16 and 24. The most common bit - // depth is 24. + // audio, but the larger the file. Valid values are 16 and 24 . The most common bit + // depth is 24 . BitDepth *string // You can only choose an audio bit order when you specify pcm for the value of // Audio:Codec. The order the bits of a PCM sample are stored in. The supported - // value is LittleEndian. + // value is LittleEndian . BitOrder *string // You can only choose an audio profile when you specify AAC for the value of // Audio:Codec. Specify the AAC profile for the output file. Elastic Transcoder // supports the following profiles: - // - // * auto: If you specify auto, Elastic - // Transcoder selects the profile based on the bit rate selected for the output - // file. - // - // * AAC-LC: The most common AAC profile. Use for bit rates larger than 64 - // kbps. - // - // * HE-AAC: Not supported on some older players and devices. Use for bit - // rates between 40 and 80 kbps. - // - // * HE-AACv2: Not supported on some players and - // devices. Use for bit rates less than 48 kbps. - // - // All outputs in a Smooth playlist - // must have the same value for Profile. If you created any presets before AAC - // profiles were added, Elastic Transcoder automatically updated your presets to - // use AAC-LC. You can change the value as required. + // - auto : If you specify auto , Elastic Transcoder selects the profile based on + // the bit rate selected for the output file. + // - AAC-LC : The most common AAC profile. Use for bit rates larger than 64 kbps. + // - HE-AAC : Not supported on some older players and devices. Use for bit rates + // between 40 and 80 kbps. + // - HE-AACv2 : Not supported on some players and devices. Use for bit rates less + // than 48 kbps. + // All outputs in a Smooth playlist must have the same value for Profile . If you + // created any presets before AAC profiles were added, Elastic Transcoder + // automatically updated your presets to use AAC-LC. You can change the value as + // required. Profile *string // You can only choose whether an audio sample is signed when you specify pcm for // the value of Audio:Codec. Whether audio samples are represented with negative // and positive numbers (signed) or only positive numbers (unsigned). The supported - // value is Signed. + // value is Signed . Signed *string noSmithyDocumentSerde @@ -135,154 +119,103 @@ type AudioParameters struct { // The method of organizing audio channels and tracks. Use Audio:Channels to // specify the number of channels in your output, and Audio:AudioPackingMode to // specify the number of tracks and their relation to the channels. If you do not - // specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack. The - // following values are valid: SingleTrack, OneChannelPerTrack, and - // OneChannelPerTrackWithMosTo8Tracks When you specify SingleTrack, Elastic + // specify an Audio:AudioPackingMode , Elastic Transcoder uses SingleTrack . The + // following values are valid: SingleTrack , OneChannelPerTrack , and + // OneChannelPerTrackWithMosTo8Tracks When you specify SingleTrack , Elastic // Transcoder creates a single track for your output. The track can have up to - // eight channels. Use SingleTrack for all non-mxf containers. The outputs of + // eight channels. Use SingleTrack for all non- mxf containers. The outputs of // SingleTrack for a specific channel value and inputs are as follows: - // - // * 0 - // channels with any input: Audio omitted from the output - // - // * 1, 2, or auto - // channels with no audio input: Audio omitted from the output - // - // * 1 channel with - // any input with audio: One track with one channel, downmixed if necessary - // - // * 2 - // channels with one track with one channel: One track with two identical - // channels - // - // * 2 or auto channels with two tracks with one channel each: One track - // with two channels - // - // * 2 or auto channels with one track with two channels: One - // track with two channels - // - // * 2 channels with one track with multiple channels: - // One track with two channels - // - // * auto channels with one track with one channel: - // One track with one channel - // - // * auto channels with one track with multiple - // channels: One track with multiple channels - // - // When you specify OneChannelPerTrack, - // Elastic Transcoder creates a new track for every channel in your output. Your - // output can have up to eight single-channel tracks. The outputs of - // OneChannelPerTrack for a specific channel value and inputs are as follows: - // - // * 0 - // channels with any input: Audio omitted from the output - // - // * 1, 2, or auto - // channels with no audio input: Audio omitted from the output - // - // * 1 channel with - // any input with audio: One track with one channel, downmixed if necessary - // - // * 2 - // channels with one track with one channel: Two tracks with one identical channel - // each - // - // * 2 or auto channels with two tracks with one channel each: Two tracks - // with one channel each - // - // * 2 or auto channels with one track with two channels: - // Two tracks with one channel each - // - // * 2 channels with one track with multiple - // channels: Two tracks with one channel each - // - // * auto channels with one track with - // one channel: One track with one channel - // - // * auto channels with one track with - // multiple channels: Up to eight tracks with one channel each - // - // When you specify - // OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight - // single-channel tracks for your output. All tracks that do not contain audio data - // from an input channel are MOS, or Mit Out Sound, tracks. The outputs of - // OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are - // as follows: - // - // * 0 channels with any input: Audio omitted from the output - // - // * 1, - // 2, or auto channels with no audio input: Audio omitted from the output - // - // * 1 - // channel with any input with audio: One track with one channel, downmixed if - // necessary, plus six MOS tracks - // - // * 2 channels with one track with one channel: - // Two tracks with one identical channel each, plus six MOS tracks - // - // * 2 or auto - // channels with two tracks with one channel each: Two tracks with one channel - // each, plus six MOS tracks - // - // * 2 or auto channels with one track with two - // channels: Two tracks with one channel each, plus six MOS tracks - // - // * 2 channels - // with one track with multiple channels: Two tracks with one channel each, plus - // six MOS tracks - // - // * auto channels with one track with one channel: One track with - // one channel, plus seven MOS tracks - // - // * auto channels with one track with - // multiple channels: Up to eight tracks with one channel each, plus MOS tracks - // until there are eight tracks in all + // - 0 channels with any input: Audio omitted from the output + // - 1, 2, or auto channels with no audio input: Audio omitted from the output + // - 1 channel with any input with audio: One track with one channel, downmixed + // if necessary + // - 2 channels with one track with one channel: One track with two identical + // channels + // - 2 or auto channels with two tracks with one channel each: One track with + // two channels + // - 2 or auto channels with one track with two channels: One track with two + // channels + // - 2 channels with one track with multiple channels: One track with two + // channels + // - auto channels with one track with one channel: One track with one channel + // - auto channels with one track with multiple channels: One track with + // multiple channels + // When you specify OneChannelPerTrack , Elastic Transcoder creates a new track for + // every channel in your output. Your output can have up to eight single-channel + // tracks. The outputs of OneChannelPerTrack for a specific channel value and + // inputs are as follows: + // - 0 channels with any input: Audio omitted from the output + // - 1, 2, or auto channels with no audio input: Audio omitted from the output + // - 1 channel with any input with audio: One track with one channel, downmixed + // if necessary + // - 2 channels with one track with one channel: Two tracks with one identical + // channel each + // - 2 or auto channels with two tracks with one channel each: Two tracks with + // one channel each + // - 2 or auto channels with one track with two channels: Two tracks with one + // channel each + // - 2 channels with one track with multiple channels: Two tracks with one + // channel each + // - auto channels with one track with one channel: One track with one channel + // - auto channels with one track with multiple channels: Up to eight tracks + // with one channel each + // When you specify OneChannelPerTrackWithMosTo8Tracks , Elastic Transcoder creates + // eight single-channel tracks for your output. All tracks that do not contain + // audio data from an input channel are MOS, or Mit Out Sound, tracks. The outputs + // of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs + // are as follows: + // - 0 channels with any input: Audio omitted from the output + // - 1, 2, or auto channels with no audio input: Audio omitted from the output + // - 1 channel with any input with audio: One track with one channel, downmixed + // if necessary, plus six MOS tracks + // - 2 channels with one track with one channel: Two tracks with one identical + // channel each, plus six MOS tracks + // - 2 or auto channels with two tracks with one channel each: Two tracks with + // one channel each, plus six MOS tracks + // - 2 or auto channels with one track with two channels: Two tracks with one + // channel each, plus six MOS tracks + // - 2 channels with one track with multiple channels: Two tracks with one + // channel each, plus six MOS tracks + // - auto channels with one track with one channel: One track with one channel, + // plus seven MOS tracks + // - auto channels with one track with multiple channels: Up to eight tracks + // with one channel each, plus MOS tracks until there are eight tracks in all AudioPackingMode *string // The bit rate of the audio stream in the output file, in kilobits/second. Enter // an integer between 64 and 320, inclusive. BitRate *string - // The number of audio channels in the output file. The following values are valid: - // auto, 0, 1, 2 One channel carries the information played by a single speaker. - // For example, a stereo track with two channels sends one channel to the left - // speaker, and the other channel to the right speaker. The output channels are - // organized into tracks. If you want Elastic Transcoder to automatically detect - // the number of audio channels in the input file and use that value for the output - // file, select auto. The output of a specific channel value and inputs are as - // follows: - // - // * auto channel specified, with any input: Pass through up to eight - // input channels. - // - // * 0 channels specified, with any input: Audio omitted from the - // output. - // - // * 1 channel specified, with at least one input channel: Mono sound. - // - // * - // 2 channels specified, with any input: Two identical mono channels or stereo. For - // more information about tracks, see Audio:AudioPackingMode. - // - // For more information - // about how Elastic Transcoder organizes channels and tracks, see - // Audio:AudioPackingMode. + // The number of audio channels in the output file. The following values are + // valid: auto , 0 , 1 , 2 One channel carries the information played by a single + // speaker. For example, a stereo track with two channels sends one channel to the + // left speaker, and the other channel to the right speaker. The output channels + // are organized into tracks. If you want Elastic Transcoder to automatically + // detect the number of audio channels in the input file and use that value for the + // output file, select auto . The output of a specific channel value and inputs are + // as follows: + // - auto channel specified, with any input: Pass through up to eight input + // channels. + // - 0 channels specified, with any input: Audio omitted from the output. + // - 1 channel specified, with at least one input channel: Mono sound. + // - 2 channels specified, with any input: Two identical mono channels or stereo. + // For more information about tracks, see Audio:AudioPackingMode. + // For more information about how Elastic Transcoder organizes channels and + // tracks, see Audio:AudioPackingMode . Channels *string - // The audio codec for the output file. Valid values include aac, flac, mp2, mp3, - // pcm, and vorbis. + // The audio codec for the output file. Valid values include aac , flac , mp2 , mp3 + // , pcm , and vorbis . Codec *string - // If you specified AAC for Audio:Codec, this is the AAC compression profile to - // use. Valid values include: auto, AAC-LC, HE-AAC, HE-AACv2 If you specify auto, - // Elastic Transcoder chooses a profile based on the bit rate of the output file. + // If you specified AAC for Audio:Codec , this is the AAC compression profile to + // use. Valid values include: auto , AAC-LC , HE-AAC , HE-AACv2 If you specify auto + // , Elastic Transcoder chooses a profile based on the bit rate of the output file. CodecOptions *AudioCodecOptions // The sample rate of the audio stream in the output file, in Hertz. Valid values - // include: auto, 22050, 32000, 44100, 48000, 96000 If you specify auto, Elastic - // Transcoder automatically detects the sample rate. + // include: auto , 22050 , 32000 , 44100 , 48000 , 96000 If you specify auto , + // Elastic Transcoder automatically detects the sample rate. SampleRate *string noSmithyDocumentSerde @@ -298,52 +231,31 @@ type CaptionFormat struct { // The format you specify determines whether Elastic Transcoder generates an // embedded or sidecar caption for this output. - // - // * Valid Embedded Caption - // Formats: - // - // * for FLAC: None - // - // * For MP3: None - // - // * For MP4: mov-text - // - // * For MPEG-TS: - // None - // - // * For ogg: None - // - // * For webm: None - // - // * Valid Sidecar Caption Formats: - // Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. - // If you want ttml or smpte-tt compatible captions, specify dfxp as your output - // format. - // - // * For FMP4: dfxp - // - // * Non-FMP4 outputs: All sidecar types - // - // fmp4 captions - // have an extension of .ismt + // - Valid Embedded Caption Formats: + // - for FLAC: None + // - For MP3: None + // - For MP4: mov-text + // - For MPEG-TS: None + // - For ogg: None + // - For webm: None + // - Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div + // element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible + // captions, specify dfxp as your output format. + // - For FMP4: dfxp + // - Non-FMP4 outputs: All sidecar types fmp4 captions have an extension of .ismt Format *string - // The prefix for caption filenames, in the form description-{language}, where: - // - // * - // description is a description of the video. - // - // * {language} is a literal value that - // Elastic Transcoder replaces with the two- or three-letter code for the language - // of the caption in the output file names. - // - // If you don't include {language} in the - // file name pattern, Elastic Transcoder automatically appends "{language}" to the - // value that you specify for the description. In addition, Elastic Transcoder - // automatically appends the count to the end of the segment files. For example, - // suppose you're transcoding into srt format. When you enter - // "Sydney-{language}-sunrise", and the language of the captions is English (en), - // the name of the first caption file is be Sydney-en-sunrise00000.srt. + // The prefix for caption filenames, in the form description- {language} , where: + // - description is a description of the video. + // - {language} is a literal value that Elastic Transcoder replaces with the two- + // or three-letter code for the language of the caption in the output file names. + // If you don't include {language} in the file name pattern, Elastic Transcoder + // automatically appends " {language} " to the value that you specify for the + // description. In addition, Elastic Transcoder automatically appends the count to + // the end of the segment files. For example, suppose you're transcoding into srt + // format. When you enter "Sydney-{language}-sunrise", and the language of the + // captions is English (en), the name of the first caption file is be + // Sydney-en-sunrise00000.srt. Pattern *string noSmithyDocumentSerde @@ -356,31 +268,25 @@ type Captions struct { // blank, Elastic Transcoder returns an error. CaptionFormats []CaptionFormat - // Source files for the input sidecar captions used during the transcoding process. - // To omit all sidecar captions, leave CaptionSources blank. + // Source files for the input sidecar captions used during the transcoding + // process. To omit all sidecar captions, leave CaptionSources blank. // // Deprecated: This member has been deprecated. CaptionSources []CaptionSource // A policy that determines how Elastic Transcoder handles the existence of // multiple captions. - // - // * MergeOverride: Elastic Transcoder transcodes both embedded - // and sidecar captions into outputs. If captions for a language are embedded in - // the input file and also appear in a sidecar file, Elastic Transcoder uses the - // sidecar captions and ignores the embedded captions for that language. - // - // * - // MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions - // into outputs. If captions for a language are embedded in the input file and also - // appear in a sidecar file, Elastic Transcoder uses the embedded captions and - // ignores the sidecar captions for that language. If CaptionSources is empty, - // Elastic Transcoder omits all sidecar captions from the output files. - // - // * - // Override: Elastic Transcoder transcodes only the sidecar captions that you - // specify in CaptionSources. - // + // - MergeOverride: Elastic Transcoder transcodes both embedded and sidecar + // captions into outputs. If captions for a language are embedded in the input file + // and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions + // and ignores the embedded captions for that language. + // - MergeRetain: Elastic Transcoder transcodes both embedded and sidecar + // captions into outputs. If captions for a language are embedded in the input file + // and also appear in a sidecar file, Elastic Transcoder uses the embedded captions + // and ignores the sidecar captions for that language. If CaptionSources is + // empty, Elastic Transcoder omits all sidecar captions from the output files. + // - Override: Elastic Transcoder transcodes only the sidecar captions that you + // specify in CaptionSources . // MergePolicy cannot be null. // // Deprecated: This member has been deprecated. @@ -398,8 +304,8 @@ type CaptionSource struct { // sources. Encryption *Encryption - // The name of the sidecar caption file that you want Elastic Transcoder to include - // in the output file. + // The name of the sidecar caption file that you want Elastic Transcoder to + // include in the output file. Key *string // The label of the caption shown in the player when choosing a language. We @@ -410,14 +316,10 @@ type CaptionSource struct { // A string that specifies the language of the caption. If you specified multiple // inputs with captions, the caption language must match in order to be included in // the output. Specify this as one of: - // - // * 2-character ISO 639-1 code - // - // * 3-character - // ISO 639-2 code - // - // For more information on ISO language codes and language names, - // see the List of ISO 639-1 codes. + // - 2-character ISO 639-1 code + // - 3-character ISO 639-2 code + // For more information on ISO language codes and language names, see the List of + // ISO 639-1 codes. Language *string // For clip generation or captions that do not start at the same time as the @@ -451,41 +353,37 @@ type CreateJobOutput struct { // You can configure Elastic Transcoder to transcode captions, or subtitles, from // one format to another. All captions must be in UTF-8. Elastic Transcoder // supports two types of captions: - // - // * Embedded: Embedded captions are included in - // the same file as the audio and video. Elastic Transcoder supports only one - // embedded caption per language, to a maximum of 300 embedded captions per file. - // Valid input values include: CEA-608 (EIA-608, first non-empty channel only), - // CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs - // include: mov-text Elastic Transcoder supports a maximum of one embedded format - // per output. - // - // * Sidecar: Sidecar captions are kept in a separate metadata file - // from the audio and video data. Sidecar captions require a player that is capable - // of understanding the relationship between the video file and the sidecar file. - // Elastic Transcoder supports only one sidecar caption per language, to a maximum - // of 20 sidecar captions per file. Valid input values include: dfxp (first div - // element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt - // Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. - // - // If - // you want ttml or smpte-tt compatible captions, specify dfxp as your output + // - Embedded: Embedded captions are included in the same file as the audio and + // video. Elastic Transcoder supports only one embedded caption per language, to a + // maximum of 300 embedded captions per file. Valid input values include: + // CEA-608 (EIA-608 , first non-empty channel only), CEA-708 (EIA-708 , first + // non-empty channel only), and mov-text Valid outputs include: mov-text Elastic + // Transcoder supports a maximum of one embedded format per output. + // - Sidecar: Sidecar captions are kept in a separate metadata file from the + // audio and video data. Sidecar captions require a player that is capable of + // understanding the relationship between the video file and the sidecar file. + // Elastic Transcoder supports only one sidecar caption per language, to a maximum + // of 20 sidecar captions per file. Valid input values include: dfxp (first div + // element only), ebu-tt , scc , smpt , srt , ttml (first div element only), and + // webvtt Valid outputs include: dfxp (first div element only), scc , srt , and + // webvtt . + // If you want ttml or smpte-tt compatible captions, specify dfxp as your output // format. Elastic Transcoder does not support OCR (Optical Character Recognition), // does not accept pictures as a valid input for captions, and is not available for // audio-only transcoding. Elastic Transcoder does not preserve text formatting // (for example, italics) during the transcoding process. To remove captions or // leave the captions empty, set Captions to null. To pass through existing - // captions unchanged, set the MergePolicy to MergeRetain, and pass in a null + // captions unchanged, set the MergePolicy to MergeRetain , and pass in a null // CaptionSources array. For more information on embedded files, see the Subtitles // Wikipedia page. For more information on sidecar files, see the Extensible // Metadata Platform and Sidecar file Wikipedia pages. Captions *Captions - // You can create an output file that contains an excerpt from the input file. This - // excerpt, called a clip, can come from the beginning, middle, or end of the file. - // The Composition object contains settings for the clips that make up an output - // file. For the current release, you can only specify settings for a single clip - // per output file. The Composition object cannot be null. + // You can create an output file that contains an excerpt from the input file. + // This excerpt, called a clip, can come from the beginning, middle, or end of the + // file. The Composition object contains settings for the clips that make up an + // output file. For the current release, you can only specify settings for a single + // clip per output file. The Composition object cannot be null. // // Deprecated: This member has been deprecated. Composition []Clip @@ -507,8 +405,8 @@ type CreateJobOutput struct { PresetId *string // The number of degrees clockwise by which you want Elastic Transcoder to rotate - // the output relative to the input. Enter one of the following values: auto, 0, - // 90, 180, 270. The value auto generally works only if the file that you're + // the output relative to the input. Enter one of the following values: auto , 0 , + // 90 , 180 , 270 . The value auto generally works only if the file that you're // transcoding contains rotation metadata. Rotate *string @@ -518,9 +416,9 @@ type CreateJobOutput struct { // seconds. For HLSv3 format playlists, each media segment is stored in a separate // .ts file. For HLSv4 and Smooth playlists, all media segments for an output are // stored in a single file. Each segment is approximately the length of the - // SegmentDuration, though individual segments might be shorter or longer. The + // SegmentDuration , though individual segments might be shorter or longer. The // range of valid values is 1 to 60 seconds. If the duration of the video is not - // evenly divisible by SegmentDuration, the duration of the last segment is the + // evenly divisible by SegmentDuration , the duration of the last segment is the // remainder of total length/SegmentDuration. Elastic Transcoder creates an // output-specific playlist for each output HLS output that you specify in // OutputKeys. To add an output to the master playlist for this job, include it in @@ -531,34 +429,29 @@ type CreateJobOutput struct { // your thumbnail. ThumbnailEncryption *Encryption - // Whether you want Elastic Transcoder to create thumbnails for your videos and, if - // so, how you want Elastic Transcoder to name the files. If you don't want Elastic - // Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder - // to create thumbnails, specify the information that you want to include in the - // file name for each thumbnail. You can specify the following values in any - // sequence: - // - // * {count} (Required): If you want to create thumbnails, you must - // include {count} in the ThumbnailPattern object. Wherever you specify {count}, - // Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to - // thumbnail file names. The number indicates where a given thumbnail appears in - // the sequence of thumbnails for a transcoded file. If you specify a literal value - // and/or {resolution} but you omit {count}, Elastic Transcoder returns a - // validation error and does not create the job. - // - // * Literal values (Optional): You - // can specify literal values anywhere in the ThumbnailPattern object. For example, - // you can include them as a file name prefix or as a delimiter between - // {resolution} and {count}. - // - // * {resolution} (Optional): If you want Elastic - // Transcoder to include the resolution in the file name, include {resolution} in - // the ThumbnailPattern object. - // - // When creating thumbnails, Elastic Transcoder - // automatically saves the files in the format (.jpg or .png) that appears in the - // preset that you specified in the PresetID value of CreateJobOutput. Elastic - // Transcoder also appends the applicable file name extension. + // Whether you want Elastic Transcoder to create thumbnails for your videos and, + // if so, how you want Elastic Transcoder to name the files. If you don't want + // Elastic Transcoder to create thumbnails, specify "". If you do want Elastic + // Transcoder to create thumbnails, specify the information that you want to + // include in the file name for each thumbnail. You can specify the following + // values in any sequence: + // - {count} (Required): If you want to create thumbnails, you must include + // {count} in the ThumbnailPattern object. Wherever you specify {count} , Elastic + // Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail + // file names. The number indicates where a given thumbnail appears in the sequence + // of thumbnails for a transcoded file. If you specify a literal value and/or + // {resolution} but you omit {count} , Elastic Transcoder returns a validation + // error and does not create the job. + // - Literal values (Optional): You can specify literal values anywhere in the + // ThumbnailPattern object. For example, you can include them as a file name + // prefix or as a delimiter between {resolution} and {count} . + // - {resolution} (Optional): If you want Elastic Transcoder to include the + // resolution in the file name, include {resolution} in the ThumbnailPattern + // object. + // When creating thumbnails, Elastic Transcoder automatically saves the files in + // the format (.jpg or .png) that appears in the preset that you specified in the + // PresetID value of CreateJobOutput . Elastic Transcoder also appends the + // applicable file name extension. ThumbnailPattern *string // Information about the watermarks that you want Elastic Transcoder to add to the @@ -573,52 +466,47 @@ type CreateJobOutput struct { // Information about the master playlist. type CreateJobPlaylist struct { - // The format of the output playlist. Valid formats include HLSv3, HLSv4, and - // Smooth. + // The format of the output playlist. Valid formats include HLSv3 , HLSv4 , and + // Smooth . Format *string - // The HLS content protection settings, if any, that you want Elastic Transcoder to - // apply to the output files associated with this playlist. + // The HLS content protection settings, if any, that you want Elastic Transcoder + // to apply to the output files associated with this playlist. HlsContentProtection *HlsContentProtection // The name that you want Elastic Transcoder to assign to the master playlist, for // example, nyc-vacation.m3u8. If the name includes a / character, the section of - // the name before the last / must be identical for all Name objects. If you create - // more than one master playlist, the values of all Name objects must be unique. - // Elastic Transcoder automatically appends the relevant file extension to the file - // name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth - // playlists). If you include a file extension in Name, the file name will have two - // extensions. + // the name before the last / must be identical for all Name objects. If you + // create more than one master playlist, the values of all Name objects must be + // unique. Elastic Transcoder automatically appends the relevant file extension to + // the file name ( .m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for + // Smooth playlists). If you include a file extension in Name , the file name will + // have two extensions. Name *string // For each output in this job that you want to include in a master playlist, the // value of the Outputs:Key object. - // - // * If your output is not HLS or does not have a - // segment duration set, the name of the output file is a concatenation of - // OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key - // - // * If your output is - // HLSv3 and has a segment duration set, or is not included in a playlist, Elastic - // Transcoder creates an output playlist file with a file extension of .m3u8, and a - // series of .ts files that include a five-digit sequential counter beginning with - // 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts - // - // * If - // your output is HLSv4, has a segment duration set, and is included in an HLSv4 - // playlist, Elastic Transcoder creates an output playlist file with a file - // extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates - // an output file with an extension of _iframe.m3u8: - // OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 - // OutputKeyPrefixOutputs:Key.ts - // - // Elastic Transcoder automatically appends the - // relevant file extension to the file name. If you include a file extension in - // Output Key, the file name will have two extensions. If you include more than one - // output in a playlist, any segment duration settings, clip settings, or caption - // settings must be the same for all outputs in the playlist. For Smooth playlists, - // the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist - // ratio must be the same for all outputs. + // - If your output is not HLS or does not have a segment duration set, the name + // of the output file is a concatenation of OutputKeyPrefix and Outputs:Key : + // OutputKeyPrefix Outputs:Key + // - If your output is HLSv3 and has a segment duration set, or is not included + // in a playlist, Elastic Transcoder creates an output playlist file with a file + // extension of .m3u8 , and a series of .ts files that include a five-digit + // sequential counter beginning with 00000: OutputKeyPrefix Outputs:Key .m3u8 + // OutputKeyPrefix Outputs:Key 00000.ts + // - If your output is HLSv4 , has a segment duration set, and is included in an + // HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file + // extension of _v4.m3u8 . If the output is video, Elastic Transcoder also + // creates an output file with an extension of _iframe.m3u8 : OutputKeyPrefix + // Outputs:Key _v4.m3u8 OutputKeyPrefix Outputs:Key _iframe.m3u8 OutputKeyPrefix + // Outputs:Key .ts + // Elastic Transcoder automatically appends the relevant file extension to the + // file name. If you include a file extension in Output Key, the file name will + // have two extensions. If you include more than one output in a playlist, any + // segment duration settings, clip settings, or caption settings must be the same + // for all outputs in the playlist. For Smooth playlists, the Audio:Profile , + // Video:Profile , and Video:FrameRate to Video:KeyframesMaxDist ratio must be the + // same for all outputs. OutputKeys []string // The DRM settings, if any, that you want Elastic Transcoder to apply to the @@ -667,7 +555,7 @@ type Encryption struct { // The data encryption key that you want Elastic Transcoder to use to encrypt your // output file, or that was used to encrypt your input file. The key must be // base64-encoded and it must be one of the following bit lengths before being - // base64-encoded: 128, 192, or 256. The key must also be encrypted by using the + // base64-encoded: 128 , 192 , or 256 . The key must also be encrypted by using the // Amazon Key Management Service. Key *string @@ -678,50 +566,35 @@ type Encryption struct { // long before being base64-encoded. KeyMd5 *string - // The specific server-side encryption mode that you want Elastic Transcoder to use - // when decrypting your input files or encrypting your output files. Elastic + // The specific server-side encryption mode that you want Elastic Transcoder to + // use when decrypting your input files or encrypting your output files. Elastic // Transcoder supports the following options: - // - // * s3: Amazon S3 creates and manages - // the keys used for encrypting your files. - // - // * s3-aws-kms: Amazon S3 calls the - // Amazon Key Management Service, which creates and manages the keys that are used - // for encrypting your files. If you specify s3-aws-kms and you don't want to use - // the default key, you must add the AWS-KMS key that you want to use to your - // pipeline. - // - // * aes-cbc-pkcs7: A padded cipher-block mode of operation originally - // used for HLS files. - // - // * aes-ctr: AES Counter Mode. - // - // * aes-gcm: AES Galois Counter - // Mode, a mode of operation that is an authenticated encryption format, meaning - // that a file, key, or initialization vector that has been tampered with fails the - // decryption process. - // - // For all three AES options, you must provide the following - // settings, which must be base64-encoded: - // - // * Key - // - // * Key MD5 - // - // * Initialization - // Vector - // - // For the AES modes, your private encryption keys and your unencrypted - // data are never stored by AWS; therefore, it is important that you safely manage - // your encryption keys. If you lose them, you won't be able to unencrypt your - // data. + // - s3: Amazon S3 creates and manages the keys used for encrypting your files. + // - s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which + // creates and manages the keys that are used for encrypting your files. If you + // specify s3-aws-kms and you don't want to use the default key, you must add the + // AWS-KMS key that you want to use to your pipeline. + // - aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for + // HLS files. + // - aes-ctr: AES Counter Mode. + // - aes-gcm: AES Galois Counter Mode, a mode of operation that is an + // authenticated encryption format, meaning that a file, key, or initialization + // vector that has been tampered with fails the decryption process. + // For all three AES options, you must provide the following settings, which must + // be base64-encoded: + // - Key + // - Key MD5 + // - Initialization Vector + // For the AES modes, your private encryption keys and your unencrypted data are + // never stored by AWS; therefore, it is important that you safely manage your + // encryption keys. If you lose them, you won't be able to unencrypt your data. Mode *string noSmithyDocumentSerde } -// The HLS content protection settings, if any, that you want Elastic Transcoder to -// apply to your output files. +// The HLS content protection settings, if any, that you want Elastic Transcoder +// to apply to your output files. type HlsContentProtection struct { // If Elastic Transcoder is generating your key for you, you must leave this field @@ -734,7 +607,7 @@ type HlsContentProtection struct { // If you want Elastic Transcoder to generate a key for you, leave this field // blank. If you choose to supply your own key, you must encrypt the key by using // AWS KMS. The key must be base64-encoded, and it must be one of the following bit - // lengths before being base64-encoded: 128, 192, or 256. + // lengths before being base64-encoded: 128 , 192 , or 256 . Key *string // If Elastic Transcoder is generating your key for you, you must leave this field @@ -745,9 +618,9 @@ type HlsContentProtection struct { KeyMd5 *string // Specify whether you want Elastic Transcoder to write your HLS license key to an - // Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must - // be left blank and Elastic Transcoder writes your data key into the same bucket - // as the associated playlist. + // Amazon S3 bucket. If you choose WithVariantPlaylists , LicenseAcquisitionUrl + // must be left blank and Elastic Transcoder writes your data key into the same + // bucket as the associated playlist. KeyStoragePolicy *string // The location of the license key required to decrypt your HLS playlist. The URL @@ -755,9 +628,9 @@ type HlsContentProtection struct { // EXT-X-KEY metadata tag in the playlist file. LicenseAcquisitionUrl *string - // The content protection method for your output. The only valid value is: aes-128. - // This value is written into the method attribute of the EXT-X-KEY metadata tag in - // the output playlist. + // The content protection method for your output. The only valid value is: aes-128 + // . This value is written into the method attribute of the EXT-X-KEY metadata tag + // in the output playlist. Method *string noSmithyDocumentSerde @@ -766,29 +639,23 @@ type HlsContentProtection struct { // The captions to be created, if any. type InputCaptions struct { - // Source files for the input sidecar captions used during the transcoding process. - // To omit all sidecar captions, leave CaptionSources blank. + // Source files for the input sidecar captions used during the transcoding + // process. To omit all sidecar captions, leave CaptionSources blank. CaptionSources []CaptionSource // A policy that determines how Elastic Transcoder handles the existence of // multiple captions. - // - // * MergeOverride: Elastic Transcoder transcodes both embedded - // and sidecar captions into outputs. If captions for a language are embedded in - // the input file and also appear in a sidecar file, Elastic Transcoder uses the - // sidecar captions and ignores the embedded captions for that language. - // - // * - // MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions - // into outputs. If captions for a language are embedded in the input file and also - // appear in a sidecar file, Elastic Transcoder uses the embedded captions and - // ignores the sidecar captions for that language. If CaptionSources is empty, - // Elastic Transcoder omits all sidecar captions from the output files. - // - // * - // Override: Elastic Transcoder transcodes only the sidecar captions that you - // specify in CaptionSources. - // + // - MergeOverride: Elastic Transcoder transcodes both embedded and sidecar + // captions into outputs. If captions for a language are embedded in the input file + // and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions + // and ignores the embedded captions for that language. + // - MergeRetain: Elastic Transcoder transcodes both embedded and sidecar + // captions into outputs. If captions for a language are embedded in the input file + // and also appear in a sidecar file, Elastic Transcoder uses the embedded captions + // and ignores the sidecar captions for that language. If CaptionSources is + // empty, Elastic Transcoder omits all sidecar captions from the output files. + // - Override: Elastic Transcoder transcodes only the sidecar captions that you + // specify in CaptionSources . // MergePolicy cannot be null. MergePolicy *string @@ -826,15 +693,15 @@ type Job struct { // The value, if any, that you want Elastic Transcoder to prepend to the names of // all files that this job creates, including output files, thumbnails, and // playlists. We recommend that you add a / or some other delimiter to the end of - // the OutputKeyPrefix. + // the OutputKeyPrefix . OutputKeyPrefix *string - // Information about the output files. We recommend that you use the Outputs syntax - // for all jobs, even when you want Elastic Transcoder to transcode a file into - // only one format. Do not use both the Outputs and Output syntaxes in the same - // request. You can create a maximum of 30 outputs per job. If you specify more - // than one output for a job, Elastic Transcoder creates the files for each output - // in the order in which you specify them in the job. + // Information about the output files. We recommend that you use the Outputs + // syntax for all jobs, even when you want Elastic Transcoder to transcode a file + // into only one format. Do not use both the Outputs and Output syntaxes in the + // same request. You can create a maximum of 30 outputs per job. If you specify + // more than one output for a job, Elastic Transcoder creates the files for each + // output in the order in which you specify them in the job. Outputs []JobOutput // The Id of the pipeline that you want Elastic Transcoder to use for transcoding. @@ -850,26 +717,21 @@ type Job struct { // job is 30. Playlists []Playlist - // The status of the job: Submitted, Progressing, Complete, Canceled, or Error. + // The status of the job: Submitted , Progressing , Complete , Canceled , or Error . Status *string // Details about the timing of a job. Timing *Timing - // User-defined metadata that you want to associate with an Elastic Transcoder job. - // You specify metadata in key/value pairs, and you can add up to 10 key/value + // User-defined metadata that you want to associate with an Elastic Transcoder + // job. You specify metadata in key/value pairs, and you can add up to 10 key/value // pairs per job. Elastic Transcoder does not guarantee that key/value pairs are // returned in the same order in which you specify them. Metadata keys and values // must use characters from the following list: - // - // * 0-9 - // - // * A-Z and a-z - // - // * Space - // - // * - // The following symbols: _.:/=+-%@ + // - 0-9 + // - A-Z and a-z + // - Space + // - The following symbols: _.:/=+-%@ UserMetadata map[string]string noSmithyDocumentSerde @@ -878,25 +740,19 @@ type Job struct { // The .jpg or .png file associated with an audio file. type JobAlbumArt struct { - // The file to be used as album art. There can be multiple artworks associated with - // an audio file, to a maximum of 20. Valid formats are .jpg and .png + // The file to be used as album art. There can be multiple artworks associated + // with an audio file, to a maximum of 20. Valid formats are .jpg and .png Artwork []Artwork // A policy that determines how Elastic Transcoder handles the existence of // multiple album artwork files. - // - // * Replace: The specified album art replaces any - // existing album art. - // - // * Prepend: The specified album art is placed in front of - // any existing album art. - // - // * Append: The specified album art is placed after any - // existing album art. - // - // * Fallback: If the original input file contains artwork, - // Elastic Transcoder uses that artwork for the output. If the original input does - // not contain artwork, Elastic Transcoder uses the specified album art file. + // - Replace: The specified album art replaces any existing album art. + // - Prepend: The specified album art is placed in front of any existing album + // art. + // - Append: The specified album art is placed after any existing album art. + // - Fallback: If the original input file contains artwork, Elastic Transcoder + // uses that artwork for the output. If the original input does not contain + // artwork, Elastic Transcoder uses the specified album art file. MergePolicy *string noSmithyDocumentSerde @@ -906,17 +762,17 @@ type JobAlbumArt struct { type JobInput struct { // The aspect ratio of the input file. If you want Elastic Transcoder to - // automatically detect the aspect ratio of the input file, specify auto. If you + // automatically detect the aspect ratio of the input file, specify auto . If you // want to specify the aspect ratio for the output file, enter one of the following - // values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto, Elastic + // values: 1:1 , 4:3 , 3:2 , 16:9 If you specify a value other than auto , Elastic // Transcoder disables automatic detection of the aspect ratio. AspectRatio *string // The container type for the input file. If you want Elastic Transcoder to - // automatically detect the container type of the input file, specify auto. If you + // automatically detect the container type of the input file, specify auto . If you // want to specify the container type for the input file, enter one of the - // following values: 3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, - // mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm + // following values: 3gp , aac , asf , avi , divx , flv , m4a , mkv , mov , mp3 , + // mp4 , mpeg , mpeg-ps , mpeg-ts , mxf , ogg , vob , wav , webm Container *string // The detected properties of the input file. @@ -928,62 +784,59 @@ type JobInput struct { Encryption *Encryption // The frame rate of the input file. If you want Elastic Transcoder to - // automatically detect the frame rate of the input file, specify auto. If you want - // to specify the frame rate for the input file, enter one of the following values: - // 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other than auto, - // Elastic Transcoder disables automatic detection of the frame rate. + // automatically detect the frame rate of the input file, specify auto . If you + // want to specify the frame rate for the input file, enter one of the following + // values: 10 , 15 , 23.97 , 24 , 25 , 29.97 , 30 , 60 If you specify a value + // other than auto , Elastic Transcoder disables automatic detection of the frame + // rate. FrameRate *string // You can configure Elastic Transcoder to transcode captions, or subtitles, from // one format to another. All captions must be in UTF-8. Elastic Transcoder // supports two types of captions: - // - // * Embedded: Embedded captions are included in - // the same file as the audio and video. Elastic Transcoder supports only one - // embedded caption per language, to a maximum of 300 embedded captions per file. - // Valid input values include: CEA-608 (EIA-608, first non-empty channel only), - // CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs - // include: mov-text Elastic Transcoder supports a maximum of one embedded format - // per output. - // - // * Sidecar: Sidecar captions are kept in a separate metadata file - // from the audio and video data. Sidecar captions require a player that is capable - // of understanding the relationship between the video file and the sidecar file. - // Elastic Transcoder supports only one sidecar caption per language, to a maximum - // of 20 sidecar captions per file. Valid input values include: dfxp (first div - // element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt - // Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. - // - // If - // you want ttml or smpte-tt compatible captions, specify dfxp as your output + // - Embedded: Embedded captions are included in the same file as the audio and + // video. Elastic Transcoder supports only one embedded caption per language, to a + // maximum of 300 embedded captions per file. Valid input values include: + // CEA-608 (EIA-608 , first non-empty channel only), CEA-708 (EIA-708 , first + // non-empty channel only), and mov-text Valid outputs include: mov-text Elastic + // Transcoder supports a maximum of one embedded format per output. + // - Sidecar: Sidecar captions are kept in a separate metadata file from the + // audio and video data. Sidecar captions require a player that is capable of + // understanding the relationship between the video file and the sidecar file. + // Elastic Transcoder supports only one sidecar caption per language, to a maximum + // of 20 sidecar captions per file. Valid input values include: dfxp (first div + // element only), ebu-tt , scc , smpt , srt , ttml (first div element only), and + // webvtt Valid outputs include: dfxp (first div element only), scc , srt , and + // webvtt . + // If you want ttml or smpte-tt compatible captions, specify dfxp as your output // format. Elastic Transcoder does not support OCR (Optical Character Recognition), // does not accept pictures as a valid input for captions, and is not available for // audio-only transcoding. Elastic Transcoder does not preserve text formatting // (for example, italics) during the transcoding process. To remove captions or // leave the captions empty, set Captions to null. To pass through existing - // captions unchanged, set the MergePolicy to MergeRetain, and pass in a null + // captions unchanged, set the MergePolicy to MergeRetain , and pass in a null // CaptionSources array. For more information on embedded files, see the Subtitles // Wikipedia page. For more information on sidecar files, see the Extensible // Metadata Platform and Sidecar file Wikipedia pages. InputCaptions *InputCaptions // Whether the input file is interlaced. If you want Elastic Transcoder to - // automatically detect whether the input file is interlaced, specify auto. If you + // automatically detect whether the input file is interlaced, specify auto . If you // want to specify whether the input file is interlaced, enter one of the following - // values: true, false If you specify a value other than auto, Elastic Transcoder + // values: true , false If you specify a value other than auto , Elastic Transcoder // disables automatic detection of interlacing. Interlaced *string // The name of the file to transcode. Elsewhere in the body of the JSON block is - // the the ID of the pipeline to use for processing the job. The InputBucket object - // in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file - // from. If the file name includes a prefix, such as cooking/lasagna.mpg, include - // the prefix in the key. If the file isn't in the specified bucket, Elastic - // Transcoder returns an error. + // the the ID of the pipeline to use for processing the job. The InputBucket + // object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get + // the file from. If the file name includes a prefix, such as cooking/lasagna.mpg , + // include the prefix in the key. If the file isn't in the specified bucket, + // Elastic Transcoder returns an error. Key *string - // This value must be auto, which causes Elastic Transcoder to automatically detect - // the resolution of the input file. + // This value must be auto , which causes Elastic Transcoder to automatically + // detect the resolution of the input file. Resolution *string // Settings for clipping an input. Each input can have different clip settings. @@ -1001,50 +854,46 @@ type JobOutput struct { // The album art to be associated with the output file, if any. AlbumArt *JobAlbumArt - // If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode - // the output file, the AppliedColorSpaceConversion parameter shows the conversion - // used. If no ColorSpaceConversionMode was defined in the preset, this parameter - // is not be included in the job response. + // If Elastic Transcoder used a preset with a ColorSpaceConversionMode to + // transcode the output file, the AppliedColorSpaceConversion parameter shows the + // conversion used. If no ColorSpaceConversionMode was defined in the preset, this + // parameter is not be included in the job response. AppliedColorSpaceConversion *string // You can configure Elastic Transcoder to transcode captions, or subtitles, from // one format to another. All captions must be in UTF-8. Elastic Transcoder // supports two types of captions: - // - // * Embedded: Embedded captions are included in - // the same file as the audio and video. Elastic Transcoder supports only one - // embedded caption per language, to a maximum of 300 embedded captions per file. - // Valid input values include: CEA-608 (EIA-608, first non-empty channel only), - // CEA-708 (EIA-708, first non-empty channel only), and mov-text Valid outputs - // include: mov-text Elastic Transcoder supports a maximum of one embedded format - // per output. - // - // * Sidecar: Sidecar captions are kept in a separate metadata file - // from the audio and video data. Sidecar captions require a player that is capable - // of understanding the relationship between the video file and the sidecar file. - // Elastic Transcoder supports only one sidecar caption per language, to a maximum - // of 20 sidecar captions per file. Valid input values include: dfxp (first div - // element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt - // Valid outputs include: dfxp (first div element only), scc, srt, and webvtt. - // - // If - // you want ttml or smpte-tt compatible captions, specify dfxp as your output + // - Embedded: Embedded captions are included in the same file as the audio and + // video. Elastic Transcoder supports only one embedded caption per language, to a + // maximum of 300 embedded captions per file. Valid input values include: + // CEA-608 (EIA-608 , first non-empty channel only), CEA-708 (EIA-708 , first + // non-empty channel only), and mov-text Valid outputs include: mov-text Elastic + // Transcoder supports a maximum of one embedded format per output. + // - Sidecar: Sidecar captions are kept in a separate metadata file from the + // audio and video data. Sidecar captions require a player that is capable of + // understanding the relationship between the video file and the sidecar file. + // Elastic Transcoder supports only one sidecar caption per language, to a maximum + // of 20 sidecar captions per file. Valid input values include: dfxp (first div + // element only), ebu-tt , scc , smpt , srt , ttml (first div element only), and + // webvtt Valid outputs include: dfxp (first div element only), scc , srt , and + // webvtt . + // If you want ttml or smpte-tt compatible captions, specify dfxp as your output // format. Elastic Transcoder does not support OCR (Optical Character Recognition), // does not accept pictures as a valid input for captions, and is not available for // audio-only transcoding. Elastic Transcoder does not preserve text formatting // (for example, italics) during the transcoding process. To remove captions or // leave the captions empty, set Captions to null. To pass through existing - // captions unchanged, set the MergePolicy to MergeRetain, and pass in a null + // captions unchanged, set the MergePolicy to MergeRetain , and pass in a null // CaptionSources array. For more information on embedded files, see the Subtitles // Wikipedia page. For more information on sidecar files, see the Extensible // Metadata Platform and Sidecar file Wikipedia pages. Captions *Captions - // You can create an output file that contains an excerpt from the input file. This - // excerpt, called a clip, can come from the beginning, middle, or end of the file. - // The Composition object contains settings for the clips that make up an output - // file. For the current release, you can only specify settings for a single clip - // per output file. The Composition object cannot be null. + // You can create an output file that contains an excerpt from the input file. + // This excerpt, called a clip, can come from the beginning, middle, or end of the + // file. The Composition object contains settings for the clips that make up an + // output file. For the current release, you can only specify settings for a single + // clip per output file. The Composition object cannot be null. // // Deprecated: This member has been deprecated. Composition []Clip @@ -1079,17 +928,17 @@ type JobOutput struct { // is specified by the pipeline ID. Key *string - // The value of the Id object for the preset that you want to use for this job. The - // preset determines the audio, video, and thumbnail settings that Elastic + // The value of the Id object for the preset that you want to use for this job. + // The preset determines the audio, video, and thumbnail settings that Elastic // Transcoder uses for transcoding. To use a preset that you created, specify the // preset ID that Elastic Transcoder returned in the response when you created the // preset. You can also use the Elastic Transcoder system presets, which you can - // get with ListPresets. + // get with ListPresets . PresetId *string // The number of degrees clockwise by which you want Elastic Transcoder to rotate - // the output relative to the input. Enter one of the following values: auto, 0, - // 90, 180, 270 The value auto generally works only if the file that you're + // the output relative to the input. Enter one of the following values: auto , 0 , + // 90 , 180 , 270 The value auto generally works only if the file that you're // transcoding contains rotation metadata. Rotate *string @@ -1097,77 +946,66 @@ type JobOutput struct { // PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts // (MPEG-TS), SegmentDuration is the target maximum duration of each segment in // seconds. For HLSv3 format playlists, each media segment is stored in a separate - // .ts file. For HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an - // output are stored in a single file. Each segment is approximately the length of - // the SegmentDuration, though individual segments might be shorter or longer. The - // range of valid values is 1 to 60 seconds. If the duration of the video is not - // evenly divisible by SegmentDuration, the duration of the last segment is the - // remainder of total length/SegmentDuration. Elastic Transcoder creates an + // .ts file. For HLSv4 , MPEG-DASH , and Smooth playlists, all media segments for + // an output are stored in a single file. Each segment is approximately the length + // of the SegmentDuration , though individual segments might be shorter or longer. + // The range of valid values is 1 to 60 seconds. If the duration of the video is + // not evenly divisible by SegmentDuration , the duration of the last segment is + // the remainder of total length/SegmentDuration. Elastic Transcoder creates an // output-specific playlist for each output HLS output that you specify in // OutputKeys. To add an output to the master playlist for this job, include it in // the OutputKeys of the associated playlist. SegmentDuration *string - // The status of one output in a job. If you specified only one output for the job, - // Outputs:Status is always the same as Job:Status. If you specified more than one - // output: - // - // * Job:Status and Outputs:Status for all of the outputs is Submitted - // until Elastic Transcoder starts to process the first output. - // - // * When Elastic - // Transcoder starts to process the first output, Outputs:Status for that output - // and Job:Status both change to Progressing. For each output, the value of - // Outputs:Status remains Submitted until Elastic Transcoder starts to process the - // output. - // - // * Job:Status remains Progressing until all of the outputs reach a - // terminal status, either Complete or Error. - // - // * When all of the outputs reach a - // terminal status, Job:Status changes to Complete only if Outputs:Status for all - // of the outputs is Complete. If Outputs:Status for one or more outputs is Error, - // the terminal status for Job:Status is also Error. - // - // The value of Status is one of - // the following: Submitted, Progressing, Complete, Canceled, or Error. + // The status of one output in a job. If you specified only one output for the + // job, Outputs:Status is always the same as Job:Status . If you specified more + // than one output: + // - Job:Status and Outputs:Status for all of the outputs is Submitted until + // Elastic Transcoder starts to process the first output. + // - When Elastic Transcoder starts to process the first output, Outputs:Status + // for that output and Job:Status both change to Progressing. For each output, + // the value of Outputs:Status remains Submitted until Elastic Transcoder starts + // to process the output. + // - Job:Status remains Progressing until all of the outputs reach a terminal + // status, either Complete or Error. + // - When all of the outputs reach a terminal status, Job:Status changes to + // Complete only if Outputs:Status for all of the outputs is Complete . If + // Outputs:Status for one or more outputs is Error , the terminal status for + // Job:Status is also Error . + // The value of Status is one of the following: Submitted , Progressing , Complete + // , Canceled , or Error . Status *string - // Information that further explains Status. + // Information that further explains Status . StatusDetail *string // The encryption settings, if any, that you want Elastic Transcoder to apply to // your thumbnail. ThumbnailEncryption *Encryption - // Whether you want Elastic Transcoder to create thumbnails for your videos and, if - // so, how you want Elastic Transcoder to name the files. If you don't want Elastic - // Transcoder to create thumbnails, specify "". If you do want Elastic Transcoder - // to create thumbnails, specify the information that you want to include in the - // file name for each thumbnail. You can specify the following values in any - // sequence: - // - // * {count} (Required): If you want to create thumbnails, you must - // include {count} in the ThumbnailPattern object. Wherever you specify {count}, - // Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to - // thumbnail file names. The number indicates where a given thumbnail appears in - // the sequence of thumbnails for a transcoded file. If you specify a literal value - // and/or {resolution} but you omit {count}, Elastic Transcoder returns a - // validation error and does not create the job. - // - // * Literal values (Optional): You - // can specify literal values anywhere in the ThumbnailPattern object. For example, - // you can include them as a file name prefix or as a delimiter between - // {resolution} and {count}. - // - // * {resolution} (Optional): If you want Elastic - // Transcoder to include the resolution in the file name, include {resolution} in - // the ThumbnailPattern object. - // - // When creating thumbnails, Elastic Transcoder - // automatically saves the files in the format (.jpg or .png) that appears in the - // preset that you specified in the PresetID value of CreateJobOutput. Elastic - // Transcoder also appends the applicable file name extension. + // Whether you want Elastic Transcoder to create thumbnails for your videos and, + // if so, how you want Elastic Transcoder to name the files. If you don't want + // Elastic Transcoder to create thumbnails, specify "". If you do want Elastic + // Transcoder to create thumbnails, specify the information that you want to + // include in the file name for each thumbnail. You can specify the following + // values in any sequence: + // - {count} (Required): If you want to create thumbnails, you must include + // {count} in the ThumbnailPattern object. Wherever you specify {count} , Elastic + // Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail + // file names. The number indicates where a given thumbnail appears in the sequence + // of thumbnails for a transcoded file. If you specify a literal value and/or + // {resolution} but you omit {count} , Elastic Transcoder returns a validation + // error and does not create the job. + // - Literal values (Optional): You can specify literal values anywhere in the + // ThumbnailPattern object. For example, you can include them as a file name + // prefix or as a delimiter between {resolution} and {count} . + // - {resolution} (Optional): If you want Elastic Transcoder to include the + // resolution in the file name, include {resolution} in the ThumbnailPattern + // object. + // When creating thumbnails, Elastic Transcoder automatically saves the files in + // the format (.jpg or .png) that appears in the preset that you specified in the + // PresetID value of CreateJobOutput . Elastic Transcoder also appends the + // applicable file name extension. ThumbnailPattern *string // Information about the watermarks that you want Elastic Transcoder to add to the @@ -1198,7 +1036,7 @@ type JobWatermark struct { // The name of the .png or .jpg file that you want to use for the watermark. To // determine which Amazon S3 bucket contains the specified file, Elastic Transcoder - // checks the pipeline specified by Pipeline; the Input Bucket object in that + // checks the pipeline specified by Pipeline ; the Input Bucket object in that // pipeline identifies the bucket. If the file name includes a prefix, for example, // logos/128x64.png, include the prefix in the key. If the file isn't in the // specified bucket, Elastic Transcoder returns an error. @@ -1213,9 +1051,9 @@ type JobWatermark struct { noSmithyDocumentSerde } -// The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in -// order to report job status. To receive notifications, you must also subscribe to -// the new topic in the Amazon SNS console. +// The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify +// in order to report job status. To receive notifications, you must also subscribe +// to the new topic in the Amazon SNS console. type Notifications struct { // The Amazon SNS topic that you want to notify when Elastic Transcoder has @@ -1242,20 +1080,14 @@ type Permission struct { // The permission that you want to give to the AWS user that is listed in Grantee. // Valid values include: - // - // * READ: The grantee can read the thumbnails and metadata - // for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * - // READ_ACP: The grantee can read the object ACL for thumbnails that Elastic - // Transcoder adds to the Amazon S3 bucket. - // - // * WRITE_ACP: The grantee can write the - // ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * - // FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the - // thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // - READ : The grantee can read the thumbnails and metadata for thumbnails that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ, READ_ACP, and WRITE_ACP permissions for + // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. Access []string // The AWS user or group that you want to have access to transcoded files and @@ -1265,17 +1097,12 @@ type Permission struct { Grantee *string // The type of value that appears in the Grantee object: - // - // * Canonical: Either the - // canonical user ID for an AWS account or an origin access identity for an Amazon - // CloudFront distribution. A canonical user ID is not the same as an AWS account - // number. - // - // * Email: The registered email address of an AWS account. - // - // * Group: One - // of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or - // LogDelivery. + // - Canonical : Either the canonical user ID for an AWS account or an origin + // access identity for an Amazon CloudFront distribution. A canonical user ID is + // not the same as an AWS account number. + // - Email : The registered email address of an AWS account. + // - Group : One of the following predefined Amazon S3 groups: AllUsers , + // AuthenticatedUsers , or LogDelivery . GranteeType *string noSmithyDocumentSerde @@ -1288,62 +1115,42 @@ type Pipeline struct { Arn *string // The AWS Key Management Service (AWS KMS) key that you want to use with this - // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't + // pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode , you don't // need to provide a key with your job because a default key, known as an AWS-KMS // key, is created for you automatically. You need to provide an AWS-KMS key only // if you want to use a non-default AWS-KMS key, or if you are using an - // Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. + // Encryption:Mode of aes-cbc-pkcs7 , aes-ctr , or aes-gcm . AwsKmsKeyArn *string // Information about the Amazon S3 bucket in which you want Elastic Transcoder to // save transcoded files and playlists. Either you specify both ContentConfig and - // ThumbnailConfig, or you specify OutputBucket. - // - // * Bucket: The Amazon S3 bucket in - // which you want Elastic Transcoder to save transcoded files and playlists. - // - // * - // Permissions: A list of the users and/or predefined Amazon S3 groups you want to - // have access to transcoded files and playlists, and the type of access that you - // want them to have. - // - // * GranteeType: The type of value that appears in the Grantee - // object: - // - // * Canonical: Either the canonical user ID for an AWS account or an - // origin access identity for an Amazon CloudFront distribution. - // - // * Email: The - // registered email address of an AWS account. - // - // * Group: One of the following - // predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery. - // - // * - // Grantee: The AWS user or group that you want to have access to transcoded files - // and playlists. - // - // * Access: The permission that you want to give to the AWS user - // that is listed in Grantee. Valid values include: - // - // * READ: The grantee can read - // the objects and metadata for objects that Elastic Transcoder adds to the Amazon - // S3 bucket. - // - // * READ_ACP: The grantee can read the object ACL for objects that - // Elastic Transcoder adds to the Amazon S3 bucket. - // - // * WRITE_ACP: The grantee can - // write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 - // bucket. - // - // * FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP - // permissions for the objects that Elastic Transcoder adds to the Amazon S3 - // bucket. - // - // * StorageClass: The Amazon S3 storage class, Standard or - // ReducedRedundancy, that you want Elastic Transcoder to assign to the video files - // and playlists that it stores in your Amazon S3 bucket. + // ThumbnailConfig , or you specify OutputBucket . + // - Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save + // transcoded files and playlists. + // - Permissions: A list of the users and/or predefined Amazon S3 groups you + // want to have access to transcoded files and playlists, and the type of access + // that you want them to have. + // - GranteeType: The type of value that appears in the Grantee object: + // - Canonical : Either the canonical user ID for an AWS account or an origin + // access identity for an Amazon CloudFront distribution. + // - Email : The registered email address of an AWS account. + // - Group : One of the following predefined Amazon S3 groups: AllUsers , + // AuthenticatedUsers , or LogDelivery . + // - Grantee : The AWS user or group that you want to have access to transcoded + // files and playlists. + // - Access : The permission that you want to give to the AWS user that is listed + // in Grantee . Valid values include: + // - READ : The grantee can read the objects and metadata for objects that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the objects that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ , READ_ACP , and WRITE_ACP permissions + // for the objects that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, + // that you want Elastic Transcoder to assign to the video files and playlists that + // it stores in your Amazon S3 bucket. ContentConfig *PipelineOutputConfig // The identifier for the pipeline. You use this value to identify the pipeline in @@ -1362,26 +1169,20 @@ type Pipeline struct { // The Amazon Simple Notification Service (Amazon SNS) topic that you want to // notify to report job status. To receive notifications, you must also subscribe // to the new topic in the Amazon SNS console. - // - // * Progressing (optional): The - // Amazon Simple Notification Service (Amazon SNS) topic that you want to notify - // when Elastic Transcoder has started to process the job. - // - // * Complete (optional): - // The Amazon SNS topic that you want to notify when Elastic Transcoder has - // finished processing the job. - // - // * Warning (optional): The Amazon SNS topic that - // you want to notify when Elastic Transcoder encounters a warning condition. - // - // * - // Error (optional): The Amazon SNS topic that you want to notify when Elastic - // Transcoder encounters an error condition. + // - Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) + // topic that you want to notify when Elastic Transcoder has started to process the + // job. + // - Complete (optional): The Amazon SNS topic that you want to notify when + // Elastic Transcoder has finished processing the job. + // - Warning (optional): The Amazon SNS topic that you want to notify when + // Elastic Transcoder encounters a warning condition. + // - Error (optional): The Amazon SNS topic that you want to notify when Elastic + // Transcoder encounters an error condition. Notifications *Notifications // The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded // files, thumbnails, and playlists. Either you specify this value, or you specify - // both ContentConfig and ThumbnailConfig. + // both ContentConfig and ThumbnailConfig . OutputBucket *string // The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to @@ -1389,62 +1190,40 @@ type Pipeline struct { Role *string // The current status of the pipeline: - // - // * Active: The pipeline is processing - // jobs. - // - // * Paused: The pipeline is not currently processing jobs. + // - Active : The pipeline is processing jobs. + // - Paused : The pipeline is not currently processing jobs. Status *string // Information about the Amazon S3 bucket in which you want Elastic Transcoder to - // save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, - // or you specify OutputBucket. - // - // * Bucket: The Amazon S3 bucket in which you want - // Elastic Transcoder to save thumbnail files. - // - // * Permissions: A list of the users - // and/or predefined Amazon S3 groups you want to have access to thumbnail files, - // and the type of access that you want them to have. - // - // * GranteeType: The type of - // value that appears in the Grantee object: - // - // * Canonical: Either the canonical - // user ID for an AWS account or an origin access identity for an Amazon CloudFront - // distribution. A canonical user ID is not the same as an AWS account number. - // - // * - // Email: The registered email address of an AWS account. - // - // * Group: One of the - // following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or - // LogDelivery. - // - // * Grantee: The AWS user or group that you want to have access to - // thumbnail files. - // - // * Access: The permission that you want to give to the AWS user - // that is listed in Grantee. Valid values include: - // - // * READ: The grantee can read - // the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the - // Amazon S3 bucket. - // - // * READ_ACP: The grantee can read the object ACL for - // thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. - // - // * WRITE_ACP: - // The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to - // the Amazon S3 bucket. - // - // * FULL_CONTROL: The grantee has READ, READ_ACP, and - // WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the - // Amazon S3 bucket. - // - // * StorageClass: The Amazon S3 storage class, Standard or - // ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails - // that it stores in your Amazon S3 bucket. + // save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig + // , or you specify OutputBucket . + // - Bucket : The Amazon S3 bucket in which you want Elastic Transcoder to save + // thumbnail files. + // - Permissions : A list of the users and/or predefined Amazon S3 groups you + // want to have access to thumbnail files, and the type of access that you want + // them to have. + // - GranteeType: The type of value that appears in the Grantee object: + // - Canonical : Either the canonical user ID for an AWS account or an origin + // access identity for an Amazon CloudFront distribution. A canonical user ID is + // not the same as an AWS account number. + // - Email : The registered email address of an AWS account. + // - Group : One of the following predefined Amazon S3 groups: AllUsers , + // AuthenticatedUsers , or LogDelivery . + // - Grantee : The AWS user or group that you want to have access to thumbnail + // files. + // - Access: The permission that you want to give to the AWS user that is listed + // in Grantee. Valid values include: + // - READ : The grantee can read the thumbnails and metadata for thumbnails that + // Elastic Transcoder adds to the Amazon S3 bucket. + // - READ_ACP : The grantee can read the object ACL for thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - WRITE_ACP : The grantee can write the ACL for the thumbnails that Elastic + // Transcoder adds to the Amazon S3 bucket. + // - FULL_CONTROL : The grantee has READ, READ_ACP, and WRITE_ACP permissions for + // the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. + // - StorageClass : The Amazon S3 storage class, Standard or ReducedRedundancy , + // that you want Elastic Transcoder to assign to the thumbnails that it stores in + // your Amazon S3 bucket. ThumbnailConfig *PipelineOutputConfig noSmithyDocumentSerde @@ -1453,43 +1232,35 @@ type Pipeline struct { // The PipelineOutputConfig structure. type PipelineOutputConfig struct { - // The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded - // files. Specify this value when all of the following are true: - // - // * You want to - // save transcoded files, thumbnails (if any), and playlists (if any) together in - // one bucket. - // - // * You do not want to specify the users or groups who have access to - // the transcoded files, thumbnails, and playlists. - // - // * You do not want to specify - // the permissions that Elastic Transcoder grants to the files. - // - // * You want to - // associate the transcoded files and thumbnails with the Amazon S3 Standard - // storage class. - // - // If you want to save transcoded files and playlists in one bucket - // and thumbnails in another bucket, specify which users can access the transcoded - // files or the permissions the users have, or change the Amazon S3 storage class, - // omit OutputBucket and specify values for ContentConfig and ThumbnailConfig - // instead. + // The Amazon S3 bucket in which you want Elastic Transcoder to save the + // transcoded files. Specify this value when all of the following are true: + // - You want to save transcoded files, thumbnails (if any), and playlists (if + // any) together in one bucket. + // - You do not want to specify the users or groups who have access to the + // transcoded files, thumbnails, and playlists. + // - You do not want to specify the permissions that Elastic Transcoder grants + // to the files. + // - You want to associate the transcoded files and thumbnails with the Amazon + // S3 Standard storage class. + // If you want to save transcoded files and playlists in one bucket and thumbnails + // in another bucket, specify which users can access the transcoded files or the + // permissions the users have, or change the Amazon S3 storage class, omit + // OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. Bucket *string // Optional. The Permissions object specifies which users and/or predefined Amazon // S3 groups you want to have access to transcoded files and playlists, and the // type of access you want them to have. You can grant permissions to a maximum of - // 30 users and/or predefined Amazon S3 groups. If you include Permissions, Elastic - // Transcoder grants only the permissions that you specify. It does not grant full - // permissions to the owner of the role specified by Role. If you want that user to - // have full control, you must explicitly grant full control to the user. If you - // omit Permissions, Elastic Transcoder grants full control over the transcoded - // files and playlists to the owner of the role specified by Role, and grants no - // other permissions to any other user or group. + // 30 users and/or predefined Amazon S3 groups. If you include Permissions , + // Elastic Transcoder grants only the permissions that you specify. It does not + // grant full permissions to the owner of the role specified by Role . If you want + // that user to have full control, you must explicitly grant full control to the + // user. If you omit Permissions , Elastic Transcoder grants full control over the + // transcoded files and playlists to the owner of the role specified by Role , and + // grants no other permissions to any other user or group. Permissions []Permission - // The Amazon S3 storage class, Standard or ReducedRedundancy, that you want + // The Amazon S3 storage class, Standard or ReducedRedundancy , that you want // Elastic Transcoder to assign to the video files and playlists that it stores in // your Amazon S3 bucket. StorageClass *string @@ -1498,60 +1269,55 @@ type PipelineOutputConfig struct { } // Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for -// which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists -// contains information about the master playlists that you want Elastic Transcoder -// to create. We recommend that you create only one master playlist per output -// format. The maximum number of master playlists in a job is 30. +// which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), +// Playlists contains information about the master playlists that you want Elastic +// Transcoder to create. We recommend that you create only one master playlist per +// output format. The maximum number of master playlists in a job is 30. type Playlist struct { - // The format of the output playlist. Valid formats include HLSv3, HLSv4, and - // Smooth. + // The format of the output playlist. Valid formats include HLSv3 , HLSv4 , and + // Smooth . Format *string - // The HLS content protection settings, if any, that you want Elastic Transcoder to - // apply to the output files associated with this playlist. + // The HLS content protection settings, if any, that you want Elastic Transcoder + // to apply to the output files associated with this playlist. HlsContentProtection *HlsContentProtection // The name that you want Elastic Transcoder to assign to the master playlist, for // example, nyc-vacation.m3u8. If the name includes a / character, the section of - // the name before the last / must be identical for all Name objects. If you create - // more than one master playlist, the values of all Name objects must be unique. - // Elastic Transcoder automatically appends the relevant file extension to the file - // name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth - // playlists). If you include a file extension in Name, the file name will have two - // extensions. + // the name before the last / must be identical for all Name objects. If you + // create more than one master playlist, the values of all Name objects must be + // unique. Elastic Transcoder automatically appends the relevant file extension to + // the file name ( .m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for + // Smooth playlists). If you include a file extension in Name , the file name will + // have two extensions. Name *string // For each output in this job that you want to include in a master playlist, the // value of the Outputs:Key object. - // - // * If your output is not HLS or does not have a - // segment duration set, the name of the output file is a concatenation of - // OutputKeyPrefix and Outputs:Key: OutputKeyPrefixOutputs:Key - // - // * If your output is - // HLSv3 and has a segment duration set, or is not included in a playlist, Elastic - // Transcoder creates an output playlist file with a file extension of .m3u8, and a - // series of .ts files that include a five-digit sequential counter beginning with - // 00000: OutputKeyPrefixOutputs:Key.m3u8 OutputKeyPrefixOutputs:Key00000.ts - // - // * If - // your output is HLSv4, has a segment duration set, and is included in an HLSv4 - // playlist, Elastic Transcoder creates an output playlist file with a file - // extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates - // an output file with an extension of _iframe.m3u8: - // OutputKeyPrefixOutputs:Key_v4.m3u8 OutputKeyPrefixOutputs:Key_iframe.m3u8 - // OutputKeyPrefixOutputs:Key.ts - // - // Elastic Transcoder automatically appends the - // relevant file extension to the file name. If you include a file extension in - // Output Key, the file name will have two extensions. - // - // If you include more than - // one output in a playlist, any segment duration settings, clip settings, or - // caption settings must be the same for all outputs in the playlist. For Smooth - // playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to - // Video:KeyframesMaxDist ratio must be the same for all outputs. + // - If your output is not HLS or does not have a segment duration set, the name + // of the output file is a concatenation of OutputKeyPrefix and Outputs:Key : + // OutputKeyPrefix Outputs:Key + // - If your output is HLSv3 and has a segment duration set, or is not included + // in a playlist, Elastic Transcoder creates an output playlist file with a file + // extension of .m3u8 , and a series of .ts files that include a five-digit + // sequential counter beginning with 00000: OutputKeyPrefix Outputs:Key .m3u8 + // OutputKeyPrefix Outputs:Key 00000.ts + // - If your output is HLSv4 , has a segment duration set, and is included in an + // HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file + // extension of _v4.m3u8 . If the output is video, Elastic Transcoder also + // creates an output file with an extension of _iframe.m3u8 : OutputKeyPrefix + // Outputs:Key _v4.m3u8 OutputKeyPrefix Outputs:Key _iframe.m3u8 OutputKeyPrefix + // Outputs:Key .ts + // Elastic Transcoder automatically appends the relevant file extension to the + // file name. If you include a file extension in Output Key, the file name will + // have two extensions. + // + // If you include more than one output in a playlist, any segment duration + // settings, clip settings, or caption settings must be the same for all outputs in + // the playlist. For Smooth playlists, the Audio:Profile , Video:Profile , and + // Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all + // outputs. OutputKeys []string // The DRM settings, if any, that you want Elastic Transcoder to apply to the @@ -1567,14 +1333,14 @@ type Playlist struct { noSmithyDocumentSerde } -// The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to -// the output files associated with this playlist. PlayReady DRM encrypts your -// media files using aes-ctr encryption. If you use DRM for an HLSv3 playlist, your -// outputs must have a master playlist. +// The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply +// to the output files associated with this playlist. PlayReady DRM encrypts your +// media files using aes-ctr encryption. If you use DRM for an HLSv3 playlist, +// your outputs must have a master playlist. type PlayReadyDrm struct { - // The type of DRM, if any, that you want Elastic Transcoder to apply to the output - // files associated with this playlist. + // The type of DRM, if any, that you want Elastic Transcoder to apply to the + // output files associated with this playlist. Format *string // The series of random bits created by a random bit generator, unique for every @@ -1586,7 +1352,7 @@ type PlayReadyDrm struct { // The DRM key for your file, provided by your DRM license provider. The key must // be base64-encoded, and it must be one of the following bit lengths before being - // base64-encoded: 128, 192, or 256. The key must also be encrypted by using AWS + // base64-encoded: 128 , 192 , or 256 . The key must also be encrypted by using AWS // KMS. Key *string @@ -1603,9 +1369,9 @@ type PlayReadyDrm struct { // before being base64-encoded. KeyMd5 *string - // The location of the license key required to play DRM content. The URL must be an - // absolute path, and is referenced by the PlayReady header. The PlayReady header - // is referenced in the protection header of the client manifest for Smooth + // The location of the license key required to play DRM content. The URL must be + // an absolute path, and is referenced by the PlayReady header. The PlayReady + // header is referenced in the protection header of the client manifest for Smooth // Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for // HLS playlist outputs. An example URL looks like this: // https://www.example.com/exampleKey/ @@ -1628,15 +1394,15 @@ type Preset struct { // values. Audio *AudioParameters - // The container type for the output file. Valid values include flac, flv, fmp4, - // gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm. + // The container type for the output file. Valid values include flac , flv , fmp4 , + // gif , mp3 , mp4 , mpg , mxf , oga , ogg , ts , and webm . Container *string // A description of the preset. Description *string - // Identifier for the new preset. You use this value to get settings for the preset - // or to delete it. + // Identifier for the new preset. You use this value to get settings for the + // preset or to delete it. Id *string // The name of the preset. @@ -1646,8 +1412,8 @@ type Preset struct { // preset values, if any. Thumbnails *Thumbnails - // Whether the preset is a default preset provided by Elastic Transcoder (System) - // or a preset that you have defined (Custom). + // Whether the preset is a default preset provided by Elastic Transcoder ( System ) + // or a preset that you have defined ( Custom ). Type *string // A section of the response body that provides information about the video preset @@ -1670,39 +1436,30 @@ type Preset struct { // watermarks that have different dimensions. type PresetWatermark struct { - // The horizontal position of the watermark unless you specify a non-zero value for - // HorizontalOffset: - // - // * Left: The left edge of the watermark is aligned with the - // left border of the video. - // - // * Right: The right edge of the watermark is aligned - // with the right border of the video. - // - // * Center: The watermark is centered between - // the left and right borders. + // The horizontal position of the watermark unless you specify a non-zero value + // for HorizontalOffset : + // - Left: The left edge of the watermark is aligned with the left border of the + // video. + // - Right: The right edge of the watermark is aligned with the right border of + // the video. + // - Center: The watermark is centered between the left and right borders. HorizontalAlign *string // The amount by which you want the horizontal position of the watermark to be // offset from the position specified by HorizontalAlign: - // - // * number of pixels (px): - // The minimum value is 0 pixels, and the maximum value is the value of - // MaxWidth. - // - // * integer percentage (%): The range of valid values is 0 to 100. - // - // For - // example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, - // the left side of the watermark appears 5 pixels from the left border of the - // output video. HorizontalOffset is only valid when the value of HorizontalAlign - // is Left or Right. If you specify an offset that causes the watermark to extend - // beyond the left or right border and Elastic Transcoder has not added black bars, - // the watermark is cropped. If Elastic Transcoder has added black bars, the - // watermark extends into the black bars. If the watermark extends beyond the black - // bars, it is cropped. Use the value of Target to specify whether you want to - // include the black bars that are added by Elastic Transcoder, if any, in the - // offset calculation. + // - number of pixels (px): The minimum value is 0 pixels, and the maximum value + // is the value of MaxWidth. + // - integer percentage (%): The range of valid values is 0 to 100. + // For example, if you specify Left for HorizontalAlign and 5px for + // HorizontalOffset , the left side of the watermark appears 5 pixels from the left + // border of the output video. HorizontalOffset is only valid when the value of + // HorizontalAlign is Left or Right . If you specify an offset that causes the + // watermark to extend beyond the left or right border and Elastic Transcoder has + // not added black bars, the watermark is cropped. If Elastic Transcoder has added + // black bars, the watermark extends into the black bars. If the watermark extends + // beyond the black bars, it is cropped. Use the value of Target to specify + // whether you want to include the black bars that are added by Elastic Transcoder, + // if any, in the offset calculation. HorizontalOffset *string // A unique identifier for the settings for one watermark. The value of Id can be @@ -1710,31 +1467,23 @@ type PresetWatermark struct { Id *string // The maximum height of the watermark in one of the following formats: - // - // * number - // of pixels (px): The minimum value is 16 pixels, and the maximum value is the - // value of MaxHeight. - // - // * integer percentage (%): The range of valid values is 0 to - // 100. Use the value of Target to specify whether you want Elastic Transcoder to - // include the black bars that are added by Elastic Transcoder, if any, in the - // calculation. - // - // If you specify the value in pixels, it must be less than or equal - // to the value of MaxHeight. + // - number of pixels (px): The minimum value is 16 pixels, and the maximum + // value is the value of MaxHeight . + // - integer percentage (%): The range of valid values is 0 to 100. Use the + // value of Target to specify whether you want Elastic Transcoder to include the + // black bars that are added by Elastic Transcoder, if any, in the calculation. + // If you specify the value in pixels, it must be less than or equal to the value + // of MaxHeight . MaxHeight *string // The maximum width of the watermark in one of the following formats: - // - // * number of - // pixels (px): The minimum value is 16 pixels, and the maximum value is the value - // of MaxWidth. - // - // * integer percentage (%): The range of valid values is 0 to 100. - // Use the value of Target to specify whether you want Elastic Transcoder to - // include the black bars that are added by Elastic Transcoder, if any, in the - // calculation. If you specify the value in pixels, it must be less than or equal - // to the value of MaxWidth. + // - number of pixels (px): The minimum value is 16 pixels, and the maximum + // value is the value of MaxWidth . + // - integer percentage (%): The range of valid values is 0 to 100. Use the + // value of Target to specify whether you want Elastic Transcoder to include the + // black bars that are added by Elastic Transcoder, if any, in the calculation. If + // you specify the value in pixels, it must be less than or equal to the value of + // MaxWidth . MaxWidth *string // A percentage that indicates how much you want a watermark to obscure the video @@ -1742,76 +1491,60 @@ type PresetWatermark struct { // invisible) to 100 (the watermark completely obscures the video in the specified // location). The datatype of Opacity is float. Elastic Transcoder supports // transparent .png graphics. If you use a transparent .png, the transparent - // portion of the video appears as if you had specified a value of 0 for Opacity. + // portion of the video appears as if you had specified a value of 0 for Opacity . // The .jpg file format doesn't support transparency. Opacity *string // A value that controls scaling of the watermark: - // - // * Fit: Elastic Transcoder - // scales the watermark so it matches the value that you specified in either - // MaxWidth or MaxHeight without exceeding the other value. - // - // * Stretch: Elastic - // Transcoder stretches the watermark to match the values that you specified for - // MaxWidth and MaxHeight. If the relative proportions of the watermark and the - // values of MaxWidth and MaxHeight are different, the watermark will be - // distorted. - // - // * ShrinkToFit: Elastic Transcoder scales the watermark down so that - // its dimensions match the values that you specified for at least one of MaxWidth - // and MaxHeight without exceeding either value. If you specify this option, - // Elastic Transcoder does not scale the watermark up. + // - Fit: Elastic Transcoder scales the watermark so it matches the value that + // you specified in either MaxWidth or MaxHeight without exceeding the other + // value. + // - Stretch: Elastic Transcoder stretches the watermark to match the values + // that you specified for MaxWidth and MaxHeight . If the relative proportions of + // the watermark and the values of MaxWidth and MaxHeight are different, the + // watermark will be distorted. + // - ShrinkToFit: Elastic Transcoder scales the watermark down so that its + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without exceeding either value. If you specify this option, + // Elastic Transcoder does not scale the watermark up. SizingPolicy *string // A value that determines how Elastic Transcoder interprets values that you - // specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight: - // - // * - // Content: HorizontalOffset and VerticalOffset values are calculated based on the - // borders of the video excluding black bars added by Elastic Transcoder, if any. - // In addition, MaxWidth and MaxHeight, if specified as a percentage, are - // calculated based on the borders of the video excluding black bars added by - // Elastic Transcoder, if any. - // - // * Frame: HorizontalOffset and VerticalOffset values - // are calculated based on the borders of the video including black bars added by - // Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as - // a percentage, are calculated based on the borders of the video including black - // bars added by Elastic Transcoder, if any. + // specified for HorizontalOffset , VerticalOffset , MaxWidth , and MaxHeight : + // - Content: HorizontalOffset and VerticalOffset values are calculated based on + // the borders of the video excluding black bars added by Elastic Transcoder, if + // any. In addition, MaxWidth and MaxHeight , if specified as a percentage, are + // calculated based on the borders of the video excluding black bars added by + // Elastic Transcoder, if any. + // - Frame: HorizontalOffset and VerticalOffset values are calculated based on + // the borders of the video including black bars added by Elastic Transcoder, if + // any. In addition, MaxWidth and MaxHeight , if specified as a percentage, are + // calculated based on the borders of the video including black bars added by + // Elastic Transcoder, if any. Target *string // The vertical position of the watermark unless you specify a non-zero value for - // VerticalOffset: - // - // * Top: The top edge of the watermark is aligned with the top - // border of the video. - // - // * Bottom: The bottom edge of the watermark is aligned with - // the bottom border of the video. - // - // * Center: The watermark is centered between the - // top and bottom borders. + // VerticalOffset : + // - Top: The top edge of the watermark is aligned with the top border of the + // video. + // - Bottom: The bottom edge of the watermark is aligned with the bottom border + // of the video. + // - Center: The watermark is centered between the top and bottom borders. VerticalAlign *string // VerticalOffset The amount by which you want the vertical position of the // watermark to be offset from the position specified by VerticalAlign: - // - // * number - // of pixels (px): The minimum value is 0 pixels, and the maximum value is the - // value of MaxHeight. - // - // * integer percentage (%): The range of valid values is 0 to - // 100. - // - // For example, if you specify Top for VerticalAlign and 5px for - // VerticalOffset, the top of the watermark appears 5 pixels from the top border of - // the output video. VerticalOffset is only valid when the value of VerticalAlign - // is Top or Bottom. If you specify an offset that causes the watermark to extend - // beyond the top or bottom border and Elastic Transcoder has not added black bars, - // the watermark is cropped. If Elastic Transcoder has added black bars, the - // watermark extends into the black bars. If the watermark extends beyond the black - // bars, it is cropped. Use the value of Target to specify whether you want Elastic + // - number of pixels (px): The minimum value is 0 pixels, and the maximum value + // is the value of MaxHeight . + // - integer percentage (%): The range of valid values is 0 to 100. + // For example, if you specify Top for VerticalAlign and 5px for VerticalOffset , + // the top of the watermark appears 5 pixels from the top border of the output + // video. VerticalOffset is only valid when the value of VerticalAlign is Top or + // Bottom. If you specify an offset that causes the watermark to extend beyond the + // top or bottom border and Elastic Transcoder has not added black bars, the + // watermark is cropped. If Elastic Transcoder has added black bars, the watermark + // extends into the black bars. If the watermark extends beyond the black bars, it + // is cropped. Use the value of Target to specify whether you want Elastic // Transcoder to include the black bars that are added by Elastic Transcoder, if // any, in the offset calculation. VerticalOffset *string @@ -1823,14 +1556,14 @@ type PresetWatermark struct { type Thumbnails struct { // To better control resolution and aspect ratio of thumbnails, we recommend that - // you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead - // of Resolution and AspectRatio. The two groups of settings are mutually + // you use the values MaxWidth , MaxHeight , SizingPolicy , and PaddingPolicy + // instead of Resolution and AspectRatio . The two groups of settings are mutually // exclusive. Do not use them together. The aspect ratio of thumbnails. Valid - // values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto, Elastic + // values include: auto , 1:1 , 4:3 , 3:2 , 16:9 If you specify auto , Elastic // Transcoder tries to preserve the aspect ratio of the video in the output file. AspectRatio *string - // The format of thumbnails, if any. Valid values are jpg and png. You specify + // The format of thumbnails, if any. Valid values are jpg and png . You specify // whether you want Elastic Transcoder to create thumbnails when you create a job. Format *string @@ -1847,54 +1580,44 @@ type Thumbnails struct { // value, enter an even integer between 32 and 4096. MaxWidth *string - // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the + // When you set PaddingPolicy to Pad , Elastic Transcoder may add black bars to the // top and bottom and/or left and right sides of thumbnails to make the total size - // of the thumbnails match the values that you specified for thumbnail MaxWidth and - // MaxHeight settings. + // of the thumbnails match the values that you specified for thumbnail MaxWidth + // and MaxHeight settings. PaddingPolicy *string // To better control resolution and aspect ratio of thumbnails, we recommend that - // you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead - // of Resolution and AspectRatio. The two groups of settings are mutually + // you use the values MaxWidth , MaxHeight , SizingPolicy , and PaddingPolicy + // instead of Resolution and AspectRatio . The two groups of settings are mutually // exclusive. Do not use them together. The width and height of thumbnail files in - // pixels. Specify a value in the format width x height where both values are + // pixels. Specify a value in the format width x height where both values are // even integers. The values cannot exceed the width and height that you specified // in the Video:Resolution object. Resolution *string // Specify one of the following values to control scaling of thumbnails: - // - // * Fit: - // Elastic Transcoder scales thumbnails so they match the value that you specified - // in thumbnail MaxWidth or MaxHeight settings without exceeding the other - // value. - // - // * Fill: Elastic Transcoder scales thumbnails so they match the value - // that you specified in thumbnail MaxWidth or MaxHeight settings and matches or - // exceeds the other value. Elastic Transcoder centers the image in thumbnails and - // then crops in the dimension (if any) that exceeds the maximum value. - // - // * Stretch: - // Elastic Transcoder stretches thumbnails to match the values that you specified - // for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of - // the input video and thumbnails are different, the thumbnails will be - // distorted. - // - // * Keep: Elastic Transcoder does not scale thumbnails. If either - // dimension of the input video exceeds the values that you specified for thumbnail - // MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails. - // - // * - // ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions - // match the values that you specified for at least one of thumbnail MaxWidth and - // MaxHeight without exceeding either value. If you specify this option, Elastic - // Transcoder does not scale thumbnails up. - // - // * ShrinkToFill: Elastic Transcoder - // scales thumbnails down so that their dimensions match the values that you - // specified for at least one of MaxWidth and MaxHeight without dropping below - // either value. If you specify this option, Elastic Transcoder does not scale - // thumbnails up. + // - Fit : Elastic Transcoder scales thumbnails so they match the value that you + // specified in thumbnail MaxWidth or MaxHeight settings without exceeding the + // other value. + // - Fill : Elastic Transcoder scales thumbnails so they match the value that you + // specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds + // the other value. Elastic Transcoder centers the image in thumbnails and then + // crops in the dimension (if any) that exceeds the maximum value. + // - Stretch : Elastic Transcoder stretches thumbnails to match the values that + // you specified for thumbnail MaxWidth and MaxHeight settings. If the relative + // proportions of the input video and thumbnails are different, the thumbnails will + // be distorted. + // - Keep : Elastic Transcoder does not scale thumbnails. If either dimension of + // the input video exceeds the values that you specified for thumbnail MaxWidth + // and MaxHeight settings, Elastic Transcoder crops the thumbnails. + // - ShrinkToFit : Elastic Transcoder scales thumbnails down so that their + // dimensions match the values that you specified for at least one of thumbnail + // MaxWidth and MaxHeight without exceeding either value. If you specify this + // option, Elastic Transcoder does not scale thumbnails up. + // - ShrinkToFill : Elastic Transcoder scales thumbnails down so that their + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without dropping below either value. If you specify this option, + // Elastic Transcoder does not scale thumbnails up. SizingPolicy *string noSmithyDocumentSerde @@ -1939,11 +1662,11 @@ type Timing struct { type VideoParameters struct { // To better control resolution and aspect ratio of output videos, we recommend - // that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and - // DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of + // that you use the values MaxWidth , MaxHeight , SizingPolicy , PaddingPolicy , + // and DisplayAspectRatio instead of Resolution and AspectRatio . The two groups of // settings are mutually exclusive. Do not use them together. The display aspect - // ratio of the video in the output file. Valid values include: auto, 1:1, 4:3, - // 3:2, 16:9 If you specify auto, Elastic Transcoder tries to preserve the aspect + // ratio of the video in the output file. Valid values include: auto , 1:1 , 4:3 , + // 3:2 , 16:9 If you specify auto , Elastic Transcoder tries to preserve the aspect // ratio of the input file. If you specify an aspect ratio for the output file that // differs from aspect ratio of the input file, Elastic Transcoder adds // pillarboxing (black bars on the sides) or letterboxing (black bars on the top @@ -1951,357 +1674,250 @@ type VideoParameters struct { AspectRatio *string // The bit rate of the video stream in the output file, in kilobits/second. Valid - // values depend on the values of Level and Profile. If you specify auto, Elastic + // values depend on the values of Level and Profile . If you specify auto , Elastic // Transcoder uses the detected bit rate of the input source. If you specify a - // value other than auto, we recommend that you specify a value less than or equal + // value other than auto , we recommend that you specify a value less than or equal // to the maximum H.264-compliant value listed for your level and profile: Level - // Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum // video bit rate in kilobits/second (high Profile) - // - // * 1 - 64 : 80 - // - // * 1b - 128 : - // 160 - // - // * 1.1 - 192 : 240 - // - // * 1.2 - 384 : 480 - // - // * 1.3 - 768 : 960 - // - // * 2 - 2000 : - // 2500 - // - // * 3 - 10000 : 12500 - // - // * 3.1 - 14000 : 17500 - // - // * 3.2 - 20000 : 25000 - // - // * 4 - - // 20000 : 25000 - // - // * 4.1 - 50000 : 62500 + // - 1 - 64 : 80 + // - 1b - 128 : 160 + // - 1.1 - 192 : 240 + // - 1.2 - 384 : 480 + // - 1.3 - 768 : 960 + // - 2 - 2000 : 2500 + // - 3 - 10000 : 12500 + // - 3.1 - 14000 : 17500 + // - 3.2 - 20000 : 25000 + // - 4 - 20000 : 25000 + // - 4.1 - 50000 : 62500 BitRate *string - // The video codec for the output file. Valid values include gif, H.264, mpeg2, - // vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, - // gif when the container type is gif, and mpeg2 when the container type is mpg. + // The video codec for the output file. Valid values include gif , H.264 , mpeg2 , + // vp8 , and vp9 . You can only specify vp8 and vp9 when the container type is webm + // , gif when the container type is gif , and mpeg2 when the container type is mpg . Codec *string // Profile (H.264/VP8/VP9 Only) The H.264 profile that you want to use for the // output file. Elastic Transcoder supports the following profiles: - // - // * baseline: - // The profile most commonly used for videoconferencing and for mobile - // applications. - // - // * main: The profile used for standard-definition digital TV - // broadcasts. - // - // * high: The profile used for high-definition digital TV broadcasts - // and for Blu-ray discs. - // - // Level (H.264 Only) The H.264 level that you want to use - // for the output file. Elastic Transcoder supports the following levels: 1, 1b, - // 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1 MaxReferenceFrames (H.264 Only) - // Applicable only when the value of Video:Codec is H.264. The maximum number of - // previously decoded frames to use as a reference for decoding future frames. - // Valid values are integers 0 through 16, but we recommend that you not use a - // value greater than the following: Min(Floor(Maximum decoded picture buffer in - // macroblocks * 256 / (Width in pixels * Height in pixels)), 16) where Width in - // pixels and Height in pixels represent either MaxWidth and MaxHeight, or - // Resolution. Maximum decoded picture buffer in macroblocks depends on the value - // of the Level object. See the list below. (A macroblock is a block of pixels - // measuring 16x16.) - // - // * 1 - 396 - // - // * 1b - 396 - // - // * 1.1 - 900 - // - // * 1.2 - 2376 - // - // * 1.3 - - // 2376 - // - // * 2 - 2376 - // - // * 2.1 - 4752 - // - // * 2.2 - 8100 - // - // * 3 - 8100 - // - // * 3.1 - 18000 - // - // * 3.2 - - // 20480 - // - // * 4 - 32768 - // - // * 4.1 - 32768 - // - // MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 - // only) The maximum number of bits per second in a video buffer; the size of the - // buffer is specified by BufferSize. Specify a value between 16 and 62,500. You - // can reduce the bandwidth required to stream a video by reducing the maximum bit - // rate, but this also reduces the quality of the video. BufferSize (Optional, - // H.264/MPEG2/VP8/VP9 only) The maximum number of bits in any x seconds of the - // output video. This window is commonly 10 seconds, the standard segment duration - // when you're using FMP4 or MPEG-TS for the container type of the output video. - // Specify an integer greater than 0. If you specify MaxBitRate and omit - // BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of - // MaxBitRate. InterlacedMode (Optional, H.264/MPEG2 Only) The interlace mode for - // the output video. Interlaced video is used to double the perceived frame rate - // for a video by interlacing two fields (one field on every other line, the other - // field on the other lines) so that the human eye registers multiple pictures per - // frame. Interlacing reduces the bandwidth required for transmitting a video, but - // can result in blurred images and flickering. Valid values include Progressive - // (no interlacing, top to bottom), TopFirst (top field first), BottomFirst (bottom - // field first), and Auto. If InterlaceMode is not specified, Elastic Transcoder - // uses Progressive for the output. If Auto is specified, Elastic Transcoder - // interlaces the output. ColorSpaceConversionMode (Optional, H.264/MPEG2 Only) The - // color space conversion Elastic Transcoder applies to the output video. Color - // spaces are the algorithms used by the computer to store information about how to - // render color. Bt.601 is the standard for standard definition video, while Bt.709 - // is the standard for high definition video. Valid values include None, - // Bt709toBt601, Bt601toBt709, and Auto. If you chose Auto for - // ColorSpaceConversionMode and your output is interlaced, your frame rate is one - // of 23.97, 24, 25, 29.97, 50, or 60, your SegmentDuration is null, and you are - // using one of the resolution changes from the list below, Elastic Transcoder - // applies the following color space conversions: - // - // * Standard to HD, 720x480 to - // 1920x1080 - Elastic Transcoder applies Bt601ToBt709 - // - // * Standard to HD, 720x576 - // to 1920x1080 - Elastic Transcoder applies Bt601ToBt709 - // - // * HD to Standard, - // 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601 - // - // * HD to - // Standard, 1920x1080 to 720x576 - Elastic Transcoder applies - // Bt709ToBt601 - // - // Elastic Transcoder may change the behavior of the - // ColorspaceConversionModeAuto mode in the future. All outputs in a playlist must - // use the same ColorSpaceConversionMode. If you do not specify a - // ColorSpaceConversionMode, Elastic Transcoder does not change the color space of - // a file. If you are unsure what ColorSpaceConversionMode was applied to your - // output file, you can check the AppliedColorSpaceConversion parameter included in - // your job response. If your job does not have an AppliedColorSpaceConversion in - // its response, no ColorSpaceConversionMode was applied. ChromaSubsampling The - // sampling pattern for the chroma (color) channels of the output video. Valid - // values include yuv420p and yuv422p. yuv420p samples the chroma information of - // every other horizontal and every other vertical line, yuv422p samples the color - // information of every horizontal line and every other vertical line. LoopCount - // (Gif Only) The number of times you want the output gif to loop. Valid values - // include Infinite and integers between 0 and 100, inclusive. + // - baseline : The profile most commonly used for videoconferencing and for + // mobile applications. + // - main : The profile used for standard-definition digital TV broadcasts. + // - high : The profile used for high-definition digital TV broadcasts and for + // Blu-ray discs. + // Level (H.264 Only) The H.264 level that you want to use for the output file. + // Elastic Transcoder supports the following levels: 1 , 1b , 1.1 , 1.2 , 1.3 , 2 , + // 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 MaxReferenceFrames (H.264 Only) Applicable + // only when the value of Video:Codec is H.264. The maximum number of previously + // decoded frames to use as a reference for decoding future frames. Valid values + // are integers 0 through 16, but we recommend that you not use a value greater + // than the following: Min(Floor(Maximum decoded picture buffer in macroblocks * + // 256 / (Width in pixels * Height in pixels)), 16) where Width in pixels and + // Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum + // decoded picture buffer in macroblocks depends on the value of the Level object. + // See the list below. (A macroblock is a block of pixels measuring 16x16.) + // - 1 - 396 + // - 1b - 396 + // - 1.1 - 900 + // - 1.2 - 2376 + // - 1.3 - 2376 + // - 2 - 2376 + // - 2.1 - 4752 + // - 2.2 - 8100 + // - 3 - 8100 + // - 3.1 - 18000 + // - 3.2 - 20480 + // - 4 - 32768 + // - 4.1 - 32768 + // MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only) The maximum number of bits per + // second in a video buffer; the size of the buffer is specified by BufferSize . + // Specify a value between 16 and 62,500. You can reduce the bandwidth required to + // stream a video by reducing the maximum bit rate, but this also reduces the + // quality of the video. BufferSize (Optional, H.264/MPEG2/VP8/VP9 only) The + // maximum number of bits in any x seconds of the output video. This window is + // commonly 10 seconds, the standard segment duration when you're using FMP4 or + // MPEG-TS for the container type of the output video. Specify an integer greater + // than 0. If you specify MaxBitRate and omit BufferSize , Elastic Transcoder sets + // BufferSize to 10 times the value of MaxBitRate . InterlacedMode (Optional, + // H.264/MPEG2 Only) The interlace mode for the output video. Interlaced video is + // used to double the perceived frame rate for a video by interlacing two fields + // (one field on every other line, the other field on the other lines) so that the + // human eye registers multiple pictures per frame. Interlacing reduces the + // bandwidth required for transmitting a video, but can result in blurred images + // and flickering. Valid values include Progressive (no interlacing, top to + // bottom), TopFirst (top field first), BottomFirst (bottom field first), and Auto + // . If InterlaceMode is not specified, Elastic Transcoder uses Progressive for + // the output. If Auto is specified, Elastic Transcoder interlaces the output. + // ColorSpaceConversionMode (Optional, H.264/MPEG2 Only) The color space conversion + // Elastic Transcoder applies to the output video. Color spaces are the algorithms + // used by the computer to store information about how to render color. Bt.601 is + // the standard for standard definition video, while Bt.709 is the standard for + // high definition video. Valid values include None , Bt709toBt601 , Bt601toBt709 , + // and Auto . If you chose Auto for ColorSpaceConversionMode and your output is + // interlaced, your frame rate is one of 23.97 , 24 , 25 , 29.97 , 50 , or 60 , + // your SegmentDuration is null, and you are using one of the resolution changes + // from the list below, Elastic Transcoder applies the following color space + // conversions: + // - Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies + // Bt601ToBt709 + // - Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies + // Bt601ToBt709 + // - HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies + // Bt709ToBt601 + // - HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies + // Bt709ToBt601 + // Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto + // mode in the future. All outputs in a playlist must use the same + // ColorSpaceConversionMode . If you do not specify a ColorSpaceConversionMode , + // Elastic Transcoder does not change the color space of a file. If you are unsure + // what ColorSpaceConversionMode was applied to your output file, you can check + // the AppliedColorSpaceConversion parameter included in your job response. If + // your job does not have an AppliedColorSpaceConversion in its response, no + // ColorSpaceConversionMode was applied. ChromaSubsampling The sampling pattern for + // the chroma (color) channels of the output video. Valid values include yuv420p + // and yuv422p . yuv420p samples the chroma information of every other horizontal + // and every other vertical line, yuv422p samples the color information of every + // horizontal line and every other vertical line. LoopCount (Gif Only) The number + // of times you want the output gif to loop. Valid values include Infinite and + // integers between 0 and 100 , inclusive. CodecOptions map[string]string // The value that Elastic Transcoder adds to the metadata in the output file. DisplayAspectRatio *string - // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. - // Whether to use a fixed value for FixedGOP. Valid values are true and false: - // - // * - // true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance - // between key frames (the number of frames in a group of pictures, or GOP). - // - // * - // false: The distance between key frames can vary. - // - // FixedGOP must be set to true - // for fmp4 containers. + // Applicable only when the value of Video:Codec is one of H.264 , MPEG2 , or VP8 . + // Whether to use a fixed value for FixedGOP . Valid values are true and false : + // - true : Elastic Transcoder uses the value of KeyframesMaxDist for the + // distance between key frames (the number of frames in a group of pictures, or + // GOP). + // - false : The distance between key frames can vary. + // FixedGOP must be set to true for fmp4 containers. FixedGOP *string // The frames per second for the video stream in the output file. Valid values - // include: auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic - // Transcoder uses the detected frame rate of the input source. If you specify a - // frame rate, we recommend that you perform the following calculation: Frame rate - // = maximum recommended decoding speed in luma samples/second / (width in pixels * - // height in pixels) where: - // - // * width in pixels and height in pixels represent the - // Resolution of the output video. - // - // * maximum recommended decoding speed in Luma - // samples/second is less than or equal to the maximum value listed in the - // following table, based on the value that you specified for Level. - // - // The maximum - // recommended decoding speed in Luma samples/second for each level is described in - // the following list (Level - Decoding speed): - // - // * 1 - 380160 - // - // * 1b - 380160 - // - // * 1.1 - // - 76800 - // - // * 1.2 - 1536000 - // - // * 1.3 - 3041280 - // - // * 2 - 3041280 - // - // * 2.1 - 5068800 - // - // * 2.2 - // - 5184000 - // - // * 3 - 10368000 - // - // * 3.1 - 27648000 - // - // * 3.2 - 55296000 - // - // * 4 - 62914560 - // - // * - // 4.1 - 62914560 + // include: auto , 10 , 15 , 23.97 , 24 , 25 , 29.97 , 30 , 60 If you specify auto + // , Elastic Transcoder uses the detected frame rate of the input source. If you + // specify a frame rate, we recommend that you perform the following calculation: + // Frame rate = maximum recommended decoding speed in luma samples/second / (width + // in pixels * height in pixels) where: + // - width in pixels and height in pixels represent the Resolution of the output + // video. + // - maximum recommended decoding speed in Luma samples/second is less than or + // equal to the maximum value listed in the following table, based on the value + // that you specified for Level. + // The maximum recommended decoding speed in Luma samples/second for each level is + // described in the following list (Level - Decoding speed): + // - 1 - 380160 + // - 1b - 380160 + // - 1.1 - 76800 + // - 1.2 - 1536000 + // - 1.3 - 3041280 + // - 2 - 3041280 + // - 2.1 - 5068800 + // - 2.2 - 5184000 + // - 3 - 10368000 + // - 3.1 - 27648000 + // - 3.2 - 55296000 + // - 4 - 62914560 + // - 4.1 - 62914560 FrameRate *string - // Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8. + // Applicable only when the value of Video:Codec is one of H.264 , MPEG2 , or VP8 . // The maximum number of frames between key frames. Key frames are fully encoded // frames; the frames between key frames are encoded based, in part, on the content // of the key frames. The value is an integer formatted as a string; valid values // are between 1 (every frame is a key frame) and 100000, inclusive. A higher value // results in higher compression but may also discernibly decrease video quality. // For Smooth outputs, the FrameRate must have a constant ratio to the - // KeyframesMaxDist. This allows Smooth playlists to switch between different + // KeyframesMaxDist . This allows Smooth playlists to switch between different // quality levels while the file is being played. For example, an input file can - // have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs - // to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, - // and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can be - // achieved by setting FrameRate to auto and having the same values for - // MaxFrameRate and KeyframesMaxDist. + // have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then + // needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and + // 10, and KeyframesMaxDist of 90, 75, and 30, respectively. Alternately, this can + // be achieved by setting FrameRate to auto and having the same values for + // MaxFrameRate and KeyframesMaxDist . KeyframesMaxDist *string - // If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the - // input video for the frame rate of the output video. Specify the maximum frame - // rate that you want Elastic Transcoder to use when the frame rate of the input - // video is greater than the desired maximum frame rate of the output video. Valid - // values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60. + // If you specify auto for FrameRate , Elastic Transcoder uses the frame rate of + // the input video for the frame rate of the output video. Specify the maximum + // frame rate that you want Elastic Transcoder to use when the frame rate of the + // input video is greater than the desired maximum frame rate of the output video. + // Valid values include: 10 , 15 , 23.97 , 24 , 25 , 29.97 , 30 , 60 . MaxFrameRate *string - // The maximum height of the output video in pixels. If you specify auto, Elastic + // The maximum height of the output video in pixels. If you specify auto , Elastic // Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric // value, enter an even integer between 96 and 3072. MaxHeight *string - // The maximum width of the output video in pixels. If you specify auto, Elastic + // The maximum width of the output video in pixels. If you specify auto , Elastic // Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric // value, enter an even integer between 128 and 4096. MaxWidth *string - // When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the + // When you set PaddingPolicy to Pad , Elastic Transcoder may add black bars to the // top and bottom and/or left and right sides of the output video to make the total // size of the output video match the values that you specified for MaxWidth and - // MaxHeight. + // MaxHeight . PaddingPolicy *string // To better control resolution and aspect ratio of output videos, we recommend - // that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and - // DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of + // that you use the values MaxWidth , MaxHeight , SizingPolicy , PaddingPolicy , + // and DisplayAspectRatio instead of Resolution and AspectRatio . The two groups of // settings are mutually exclusive. Do not use them together. The width and height // of the video in the output file, in pixels. Valid values are auto and width x // height: - // - // * auto: Elastic Transcoder attempts to preserve the width and height of - // the input file, subject to the following rules. - // - // * width x height : The width - // and height of the output video in pixels. - // - // Note the following about specifying - // the width and height: - // - // * The width must be an even integer between 128 and 4096, - // inclusive. - // - // * The height must be an even integer between 96 and 3072, - // inclusive. - // - // * If you specify a resolution that is less than the resolution of - // the input file, Elastic Transcoder rescales the output file to the lower - // resolution. - // - // * If you specify a resolution that is greater than the resolution - // of the input file, Elastic Transcoder rescales the output to the higher - // resolution. - // - // * We recommend that you specify a resolution for which the product - // of width and height is less than or equal to the applicable value in the - // following list (List - Max width x height value): - // - // * 1 - 25344 - // - // * 1b - 25344 - // - // * - // 1.1 - 101376 - // - // * 1.2 - 101376 - // - // * 1.3 - 101376 - // - // * 2 - 101376 - // - // * 2.1 - 202752 - // - // * - // 2.2 - 404720 - // - // * 3 - 404720 - // - // * 3.1 - 921600 - // - // * 3.2 - 1310720 - // - // * 4 - 2097152 - // - // * - // 4.1 - 2097152 + // - auto : Elastic Transcoder attempts to preserve the width and height of the + // input file, subject to the following rules. + // - width x height : The width and height of the output video in pixels. + // Note the following about specifying the width and height: + // - The width must be an even integer between 128 and 4096, inclusive. + // - The height must be an even integer between 96 and 3072, inclusive. + // - If you specify a resolution that is less than the resolution of the input + // file, Elastic Transcoder rescales the output file to the lower resolution. + // - If you specify a resolution that is greater than the resolution of the + // input file, Elastic Transcoder rescales the output to the higher resolution. + // - We recommend that you specify a resolution for which the product of width + // and height is less than or equal to the applicable value in the following list + // (List - Max width x height value): + // - 1 - 25344 + // - 1b - 25344 + // - 1.1 - 101376 + // - 1.2 - 101376 + // - 1.3 - 101376 + // - 2 - 101376 + // - 2.1 - 202752 + // - 2.2 - 404720 + // - 3 - 404720 + // - 3.1 - 921600 + // - 3.2 - 1310720 + // - 4 - 2097152 + // - 4.1 - 2097152 Resolution *string // Specify one of the following values to control scaling of the output video: - // - // * - // Fit: Elastic Transcoder scales the output video so it matches the value that you - // specified in either MaxWidth or MaxHeight without exceeding the other value. - // - // * - // Fill: Elastic Transcoder scales the output video so it matches the value that - // you specified in either MaxWidth or MaxHeight and matches or exceeds the other - // value. Elastic Transcoder centers the output video and then crops it in the - // dimension (if any) that exceeds the maximum value. - // - // * Stretch: Elastic - // Transcoder stretches the output video to match the values that you specified for - // MaxWidth and MaxHeight. If the relative proportions of the input video and the - // output video are different, the output video will be distorted. - // - // * Keep: Elastic - // Transcoder does not scale the output video. If either dimension of the input - // video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic - // Transcoder crops the output video. - // - // * ShrinkToFit: Elastic Transcoder scales the - // output video down so that its dimensions match the values that you specified for - // at least one of MaxWidth and MaxHeight without exceeding either value. If you - // specify this option, Elastic Transcoder does not scale the video up. - // - // * - // ShrinkToFill: Elastic Transcoder scales the output video down so that its - // dimensions match the values that you specified for at least one of MaxWidth and - // MaxHeight without dropping below either value. If you specify this option, - // Elastic Transcoder does not scale the video up. + // - Fit : Elastic Transcoder scales the output video so it matches the value + // that you specified in either MaxWidth or MaxHeight without exceeding the other + // value. + // - Fill : Elastic Transcoder scales the output video so it matches the value + // that you specified in either MaxWidth or MaxHeight and matches or exceeds the + // other value. Elastic Transcoder centers the output video and then crops it in + // the dimension (if any) that exceeds the maximum value. + // - Stretch : Elastic Transcoder stretches the output video to match the values + // that you specified for MaxWidth and MaxHeight . If the relative proportions of + // the input video and the output video are different, the output video will be + // distorted. + // - Keep : Elastic Transcoder does not scale the output video. If either + // dimension of the input video exceeds the values that you specified for + // MaxWidth and MaxHeight , Elastic Transcoder crops the output video. + // - ShrinkToFit : Elastic Transcoder scales the output video down so that its + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without exceeding either value. If you specify this option, + // Elastic Transcoder does not scale the video up. + // - ShrinkToFill : Elastic Transcoder scales the output video down so that its + // dimensions match the values that you specified for at least one of MaxWidth + // and MaxHeight without dropping below either value. If you specify this option, + // Elastic Transcoder does not scale the video up. SizingPolicy *string // Settings for the size, location, and opacity of graphics that you want Elastic diff --git a/service/emr/api_client.go b/service/emr/api_client.go index 278055209fd..d645a63512c 100644 --- a/service/emr/api_client.go +++ b/service/emr/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/emr/api_op_AddInstanceFleet.go b/service/emr/api_op_AddInstanceFleet.go index 3cf65b3b955..d00cab16598 100644 --- a/service/emr/api_op_AddInstanceFleet.go +++ b/service/emr/api_op_AddInstanceFleet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds an instance fleet to a running cluster. The instance fleet configuration is -// available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x. +// Adds an instance fleet to a running cluster. The instance fleet configuration +// is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x. func (c *Client) AddInstanceFleet(ctx context.Context, params *AddInstanceFleetInput, optFns ...func(*Options)) (*AddInstanceFleetOutput, error) { if params == nil { params = &AddInstanceFleetInput{} diff --git a/service/emr/api_op_AddJobFlowSteps.go b/service/emr/api_op_AddJobFlowSteps.go index ec192aab517..5b55a320465 100644 --- a/service/emr/api_op_AddJobFlowSteps.go +++ b/service/emr/api_op_AddJobFlowSteps.go @@ -46,7 +46,7 @@ func (c *Client) AddJobFlowSteps(ctx context.Context, params *AddJobFlowStepsInp type AddJobFlowStepsInput struct { // A string that uniquely identifies the job flow. This identifier is returned by - // RunJobFlow and can also be obtained from ListClusters. + // RunJobFlow and can also be obtained from ListClusters . // // This member is required. JobFlowId *string @@ -59,7 +59,7 @@ type AddJobFlowStepsInput struct { // The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. // The runtime role can be a cross-account IAM role. The runtime role ARN is a // combination of account ID, role name, and role type using the following format: - // arn:partition:service:region:account:resource. For example, + // arn:partition:service:region:account:resource . For example, // arn:aws:iam::1234567890:role/ReadOnly is a correctly formatted runtime role ARN. ExecutionRoleArn *string diff --git a/service/emr/api_op_AddTags.go b/service/emr/api_op_AddTags.go index 831b9496e7c..a21045ebdaf 100644 --- a/service/emr/api_op_AddTags.go +++ b/service/emr/api_op_AddTags.go @@ -14,8 +14,8 @@ import ( // Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. // Tags make it easier to associate resources in various ways, such as grouping // clusters to track your Amazon EMR resource allocation costs. For more -// information, see Tag Clusters -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). +// information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html) +// . func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} diff --git a/service/emr/api_op_CancelSteps.go b/service/emr/api_op_CancelSteps.go index 41005b602f4..1ad48f2779f 100644 --- a/service/emr/api_op_CancelSteps.go +++ b/service/emr/api_op_CancelSteps.go @@ -49,7 +49,7 @@ type CancelStepsInput struct { StepIds []string // The option to choose to cancel RUNNING steps. By default, the value is - // SEND_INTERRUPT. + // SEND_INTERRUPT . StepCancellationOption types.StepCancellationOption noSmithyDocumentSerde @@ -58,7 +58,7 @@ type CancelStepsInput struct { // The output for the CancelSteps operation. type CancelStepsOutput struct { - // A list of CancelStepsInfo, which shows the status of specified cancel requests + // A list of CancelStepsInfo , which shows the status of specified cancel requests // for each StepID specified. CancelStepsInfoList []types.CancelStepsInfo diff --git a/service/emr/api_op_CreateSecurityConfiguration.go b/service/emr/api_op_CreateSecurityConfiguration.go index 60d668f5a21..856b4c2fda0 100644 --- a/service/emr/api_op_CreateSecurityConfiguration.go +++ b/service/emr/api_op_CreateSecurityConfiguration.go @@ -36,8 +36,7 @@ type CreateSecurityConfigurationInput struct { Name *string // The security configuration details in JSON format. For JSON parameters and - // examples, see Use Security Configurations to Set Up Cluster Security - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html) + // examples, see Use Security Configurations to Set Up Cluster Security (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html) // in the Amazon EMR Management Guide. // // This member is required. diff --git a/service/emr/api_op_CreateStudio.go b/service/emr/api_op_CreateStudio.go index fc75ac6f89d..fca2186486b 100644 --- a/service/emr/api_op_CreateStudio.go +++ b/service/emr/api_op_CreateStudio.go @@ -41,9 +41,9 @@ type CreateStudioInput struct { // This member is required. DefaultS3Location *string - // The ID of the Amazon EMR Studio Engine security group. The Engine security group - // allows inbound network traffic from the Workspace security group, and it must be - // in the same VPC specified by VpcId. + // The ID of the Amazon EMR Studio Engine security group. The Engine security + // group allows inbound network traffic from the Workspace security group, and it + // must be in the same VPC specified by VpcId . // // This member is required. EngineSecurityGroupId *string @@ -53,14 +53,15 @@ type CreateStudioInput struct { // This member is required. Name *string - // The IAM role that the Amazon EMR Studio assumes. The service role provides a way - // for Amazon EMR Studio to interoperate with other Amazon Web Services services. + // The IAM role that the Amazon EMR Studio assumes. The service role provides a + // way for Amazon EMR Studio to interoperate with other Amazon Web Services + // services. // // This member is required. ServiceRole *string // A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have - // a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. + // a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId . // Studio users can create a Workspace in any of the specified subnets. // // This member is required. @@ -72,9 +73,9 @@ type CreateStudioInput struct { // This member is required. VpcId *string - // The ID of the Amazon EMR Studio Workspace security group. The Workspace security - // group allows outbound network traffic to resources in the Engine security group, - // and it must be in the same VPC specified by VpcId. + // The ID of the Amazon EMR Studio Workspace security group. The Workspace + // security group allows outbound network traffic to resources in the Engine + // security group, and it must be in the same VPC specified by VpcId . // // This member is required. WorkspaceSecurityGroupId *string @@ -89,7 +90,7 @@ type CreateStudioInput struct { IdpAuthUrl *string // The name that your identity provider (IdP) uses for its RelayState parameter. - // For example, RelayState or TargetSource. Specify this value when you use IAM + // For example, RelayState or TargetSource . Specify this value when you use IAM // authentication and want to let federated users log in to a Studio using the // Studio URL. The RelayState parameter differs by IdP. IdpRelayStateParameterName *string @@ -100,9 +101,9 @@ type CreateStudioInput struct { Tags []types.Tag // The IAM user role that users and groups assume when logged in to an Amazon EMR - // Studio. Only specify a UserRole when you use IAM Identity Center authentication. - // The permissions attached to the UserRole can be scoped down for each user or - // group using session policies. + // Studio. Only specify a UserRole when you use IAM Identity Center + // authentication. The permissions attached to the UserRole can be scoped down for + // each user or group using session policies. UserRole *string noSmithyDocumentSerde diff --git a/service/emr/api_op_CreateStudioSessionMapping.go b/service/emr/api_op_CreateStudioSessionMapping.go index 23d8caab8fd..4fedae29feb 100644 --- a/service/emr/api_op_CreateStudioSessionMapping.go +++ b/service/emr/api_op_CreateStudioSessionMapping.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies -// a session policy to refine Studio permissions for that user or group. Use -// CreateStudioSessionMapping to assign users to a Studio when you use IAM Identity -// Center authentication. For instructions on how to assign users to a Studio when -// you use IAM authentication, see Assign a user or group to your EMR Studio -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-manage-users.html#emr-studio-assign-users-groups). +// Maps a user or group to the Amazon EMR Studio specified by StudioId , and +// applies a session policy to refine Studio permissions for that user or group. +// Use CreateStudioSessionMapping to assign users to a Studio when you use IAM +// Identity Center authentication. For instructions on how to assign users to a +// Studio when you use IAM authentication, see Assign a user or group to your EMR +// Studio (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-manage-users.html#emr-studio-assign-users-groups) +// . func (c *Client) CreateStudioSessionMapping(ctx context.Context, params *CreateStudioSessionMappingInput, optFns ...func(*Options)) (*CreateStudioSessionMappingOutput, error) { if params == nil { params = &CreateStudioSessionMappingInput{} @@ -43,8 +44,8 @@ type CreateStudioSessionMappingInput struct { // The Amazon Resource Name (ARN) for the session policy that will be applied to // the user or group. You should specify the ARN for the session policy that you // want to apply, not the ARN of your user role. For more information, see Create - // an EMR Studio User Role with Session Policies - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html). + // an EMR Studio User Role with Session Policies (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html) + // . // // This member is required. SessionPolicyArn *string @@ -54,19 +55,15 @@ type CreateStudioSessionMappingInput struct { // This member is required. StudioId *string - // The globally unique identifier (GUID) of the user or group from the IAM Identity - // Center Identity Store. For more information, see UserId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) - // and GroupId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) + // The globally unique identifier (GUID) of the user or group from the IAM + // Identity Center Identity Store. For more information, see UserId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) + // and GroupId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified, but not both. IdentityId *string - // The name of the user or group. For more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // The name of the user or group. For more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified, but not both. IdentityName *string diff --git a/service/emr/api_op_DeleteStudioSessionMapping.go b/service/emr/api_op_DeleteStudioSessionMapping.go index ee02efa2325..4269e0a6453 100644 --- a/service/emr/api_op_DeleteStudioSessionMapping.go +++ b/service/emr/api_op_DeleteStudioSessionMapping.go @@ -29,8 +29,8 @@ func (c *Client) DeleteStudioSessionMapping(ctx context.Context, params *DeleteS type DeleteStudioSessionMappingInput struct { - // Specifies whether the identity to delete from the Amazon EMR Studio is a user or - // a group. + // Specifies whether the identity to delete from the Amazon EMR Studio is a user + // or a group. // // This member is required. IdentityType types.IdentityType @@ -41,19 +41,15 @@ type DeleteStudioSessionMappingInput struct { StudioId *string // The globally unique identifier (GUID) of the user or group to remove from the - // Amazon EMR Studio. For more information, see UserId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) - // and GroupId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) + // Amazon EMR Studio. For more information, see UserId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) + // and GroupId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityId *string // The name of the user name or group to remove from the Amazon EMR Studio. For - // more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityName *string diff --git a/service/emr/api_op_DescribeCluster.go b/service/emr/api_op_DescribeCluster.go index 0dfec043367..856b2238c7d 100644 --- a/service/emr/api_op_DescribeCluster.go +++ b/service/emr/api_op_DescribeCluster.go @@ -140,9 +140,9 @@ type ClusterRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterRunningWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterRunningWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -368,9 +368,9 @@ type ClusterTerminatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterTerminatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterTerminatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -418,10 +418,10 @@ func (w *ClusterTerminatedWaiter) Wait(ctx context.Context, params *DescribeClus return err } -// WaitForOutput calls the waiter function for ClusterTerminated waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for ClusterTerminated waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *ClusterTerminatedWaiter) WaitForOutput(ctx context.Context, params *DescribeClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterTerminatedWaiterOptions)) (*DescribeClusterOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/emr/api_op_DescribeJobFlows.go b/service/emr/api_op_DescribeJobFlows.go index 77ef46e6313..41ae500fa25 100644 --- a/service/emr/api_op_DescribeJobFlows.go +++ b/service/emr/api_op_DescribeJobFlows.go @@ -12,21 +12,17 @@ import ( "time" ) -// This API is no longer supported and will eventually be removed. We recommend you -// use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and +// This API is no longer supported and will eventually be removed. We recommend +// you use ListClusters , DescribeCluster , ListSteps , ListInstanceGroups and // ListBootstrapActions instead. DescribeJobFlows returns a list of job flows that // match all of the supplied parameters. The parameters can include a list of job // flow IDs, job flow states, and restrictions on job flow creation date and time. // Regardless of supplied parameters, only job flows created within the last two // months are returned. If no parameters are supplied, then job flows matching // either of the following criteria are returned: -// -// * Job flows created and -// completed in the last two weeks -// -// * Job flows created within the last two months -// that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, -// STARTING +// - Job flows created and completed in the last two weeks +// - Job flows created within the last two months that are in one of the +// following states: RUNNING , WAITING , SHUTTING_DOWN , STARTING // // Amazon EMR can return a maximum of 512 job flow descriptions. // diff --git a/service/emr/api_op_DescribeReleaseLabel.go b/service/emr/api_op_DescribeReleaseLabel.go index 143b861035e..edf91a33a33 100644 --- a/service/emr/api_op_DescribeReleaseLabel.go +++ b/service/emr/api_op_DescribeReleaseLabel.go @@ -51,10 +51,10 @@ type DescribeReleaseLabelOutput struct { Applications []types.SimplifiedApplication // The list of available Amazon Linux release versions for an Amazon EMR release. - // Contains a Label field that is formatted as shown in Amazon Linux 2 Release - // Notes (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-al2.html). For - // example, 2.0.20220218.1 - // (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html). + // Contains a Label field that is formatted as shown in Amazon Linux 2 Release + // Notes (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-al2.html) . For + // example, 2.0.20220218.1 (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html) + // . AvailableOSReleases []types.OSRelease // The pagination token. Reserved for future use. Currently set to null. diff --git a/service/emr/api_op_DescribeStep.go b/service/emr/api_op_DescribeStep.go index f625fbf81ad..c380e221b96 100644 --- a/service/emr/api_op_DescribeStep.go +++ b/service/emr/api_op_DescribeStep.go @@ -143,9 +143,9 @@ type StepCompleteWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StepCompleteWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StepCompleteWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/emr/api_op_GetAutoTerminationPolicy.go b/service/emr/api_op_GetAutoTerminationPolicy.go index 7b5abade8a9..87426e5c32d 100644 --- a/service/emr/api_op_GetAutoTerminationPolicy.go +++ b/service/emr/api_op_GetAutoTerminationPolicy.go @@ -29,8 +29,8 @@ func (c *Client) GetAutoTerminationPolicy(ctx context.Context, params *GetAutoTe type GetAutoTerminationPolicyInput struct { - // Specifies the ID of the Amazon EMR cluster for which the auto-termination policy - // will be fetched. + // Specifies the ID of the Amazon EMR cluster for which the auto-termination + // policy will be fetched. // // This member is required. ClusterId *string diff --git a/service/emr/api_op_GetBlockPublicAccessConfiguration.go b/service/emr/api_op_GetBlockPublicAccessConfiguration.go index ad68f9691b7..a7fea4b02e2 100644 --- a/service/emr/api_op_GetBlockPublicAccessConfiguration.go +++ b/service/emr/api_op_GetBlockPublicAccessConfiguration.go @@ -12,9 +12,8 @@ import ( ) // Returns the Amazon EMR block public access configuration for your Amazon Web -// Services account in the current Region. For more information see Configure Block -// Public Access for Amazon EMR -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) +// Services account in the current Region. For more information see Configure +// Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) // in the Amazon EMR Management Guide. func (c *Client) GetBlockPublicAccessConfiguration(ctx context.Context, params *GetBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*GetBlockPublicAccessConfigurationOutput, error) { if params == nil { @@ -37,13 +36,13 @@ type GetBlockPublicAccessConfigurationInput struct { type GetBlockPublicAccessConfigurationOutput struct { - // A configuration for Amazon EMR block public access. The configuration applies to - // all clusters created in your account for the current Region. The configuration - // specifies whether block public access is enabled. If block public access is - // enabled, security groups associated with the cluster cannot have rules that - // allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is + // A configuration for Amazon EMR block public access. The configuration applies + // to all clusters created in your account for the current Region. The + // configuration specifies whether block public access is enabled. If block public + // access is enabled, security groups associated with the cluster cannot have rules + // that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is // specified as an exception using PermittedPublicSecurityGroupRuleRanges in the - // BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and + // BlockPublicAccessConfiguration . By default, Port 22 (SSH) is an exception, and // public access is allowed on this port. You can change this by updating the block // public access configuration to remove the exception. For accounts that created // clusters in a Region before November 25, 2019, block public access is disabled diff --git a/service/emr/api_op_GetClusterSessionCredentials.go b/service/emr/api_op_GetClusterSessionCredentials.go index 66b3e5dcfb7..1baea61d142 100644 --- a/service/emr/api_op_GetClusterSessionCredentials.go +++ b/service/emr/api_op_GetClusterSessionCredentials.go @@ -41,7 +41,7 @@ type GetClusterSessionCredentialsInput struct { // The Amazon Resource Name (ARN) of the runtime role for interactive workload // submission on the cluster. The runtime role can be a cross-account IAM role. The // runtime role ARN is a combination of account ID, role name, and role type using - // the following format: arn:partition:service:region:account:resource. + // the following format: arn:partition:service:region:account:resource . // // This member is required. ExecutionRoleArn *string diff --git a/service/emr/api_op_GetStudioSessionMapping.go b/service/emr/api_op_GetStudioSessionMapping.go index d1ff41227ee..15e61bc6232 100644 --- a/service/emr/api_op_GetStudioSessionMapping.go +++ b/service/emr/api_op_GetStudioSessionMapping.go @@ -41,18 +41,14 @@ type GetStudioSessionMappingInput struct { StudioId *string // The globally unique identifier (GUID) of the user or group. For more - // information, see UserId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) - // and GroupId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) + // information, see UserId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) + // and GroupId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityId *string - // The name of the user or group to fetch. For more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // The name of the user or group to fetch. For more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityName *string diff --git a/service/emr/api_op_ListClusters.go b/service/emr/api_op_ListClusters.go index d32612fda93..eabbb3368a4 100644 --- a/service/emr/api_op_ListClusters.go +++ b/service/emr/api_op_ListClusters.go @@ -13,9 +13,9 @@ import ( "time" ) -// Provides the status of all clusters visible to this Amazon Web Services account. -// Allows you to filter the list of clusters based on certain criteria; for -// example, filtering by cluster creation date and time or by status. This call +// Provides the status of all clusters visible to this Amazon Web Services +// account. Allows you to filter the list of clusters based on certain criteria; +// for example, filtering by cluster creation date and time or by status. This call // returns a maximum of 50 clusters in unsorted order per call, but returns a // marker to track the paging of the cluster list across multiple ListClusters // calls. diff --git a/service/emr/api_op_ListInstanceFleets.go b/service/emr/api_op_ListInstanceFleets.go index f20cadf08ac..dbb480238f9 100644 --- a/service/emr/api_op_ListInstanceFleets.go +++ b/service/emr/api_op_ListInstanceFleets.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all available details about the instance fleets in a cluster. The instance -// fleet configuration is available only in Amazon EMR versions 4.8.0 and later, -// excluding 5.0.x versions. +// Lists all available details about the instance fleets in a cluster. The +// instance fleet configuration is available only in Amazon EMR versions 4.8.0 and +// later, excluding 5.0.x versions. func (c *Client) ListInstanceFleets(ctx context.Context, params *ListInstanceFleetsInput, optFns ...func(*Options)) (*ListInstanceFleetsOutput, error) { if params == nil { params = &ListInstanceFleetsInput{} diff --git a/service/emr/api_op_ListNotebookExecutions.go b/service/emr/api_op_ListNotebookExecutions.go index 34388d4bff3..7b988a0a289 100644 --- a/service/emr/api_op_ListNotebookExecutions.go +++ b/service/emr/api_op_ListNotebookExecutions.go @@ -46,41 +46,25 @@ type ListNotebookExecutionsInput struct { Marker *string // The status filter for listing notebook executions. - // - // * START_PENDING indicates - // that the cluster has received the execution request but execution has not - // begun. - // - // * STARTING indicates that the execution is starting on the cluster. - // - // * - // RUNNING indicates that the execution is being processed by the cluster. - // - // * - // FINISHING indicates that execution processing is in the final stages. - // - // * - // FINISHED indicates that the execution has completed without error. - // - // * FAILING - // indicates that the execution is failing and will not finish successfully. - // - // * - // FAILED indicates that the execution failed. - // - // * STOP_PENDING indicates that the - // cluster has received a StopNotebookExecution request and the stop is pending. - // - // * - // STOPPING indicates that the cluster is in the process of stopping the execution - // as a result of a StopNotebookExecution request. - // - // * STOPPED indicates that the - // execution stopped because of a StopNotebookExecution request. + // - START_PENDING indicates that the cluster has received the execution request + // but execution has not begun. + // - STARTING indicates that the execution is starting on the cluster. + // - RUNNING indicates that the execution is being processed by the cluster. + // - FINISHING indicates that execution processing is in the final stages. + // - FINISHED indicates that the execution has completed without error. + // - FAILING indicates that the execution is failing and will not finish + // successfully. + // - FAILED indicates that the execution failed. + // - STOP_PENDING indicates that the cluster has received a StopNotebookExecution + // request and the stop is pending. + // - STOPPING indicates that the cluster is in the process of stopping the + // execution as a result of a StopNotebookExecution request. + // - STOPPED indicates that the execution stopped because of a + // StopNotebookExecution request. Status types.NotebookExecutionStatus - // The end of time range filter for listing notebook executions. The default is the - // current timestamp. + // The end of time range filter for listing notebook executions. The default is + // the current timestamp. To *time.Time noSmithyDocumentSerde @@ -88,8 +72,8 @@ type ListNotebookExecutionsInput struct { type ListNotebookExecutionsOutput struct { - // A pagination token that a subsequent ListNotebookExecutions can use to determine - // the next set of results to retrieve. + // A pagination token that a subsequent ListNotebookExecutions can use to + // determine the next set of results to retrieve. Marker *string // A list of notebook executions. diff --git a/service/emr/api_op_ListReleaseLabels.go b/service/emr/api_op_ListReleaseLabels.go index cdcbd3f2589..ba509f229f1 100644 --- a/service/emr/api_op_ListReleaseLabels.go +++ b/service/emr/api_op_ListReleaseLabels.go @@ -35,16 +35,16 @@ type ListReleaseLabelsInput struct { // of release labels to return. Filters *types.ReleaseLabelFilter - // Defines the maximum number of release labels to return in a single response. The - // default is 100. + // Defines the maximum number of release labels to return in a single response. + // The default is 100 . MaxResults *int32 // Specifies the next page of results. If NextToken is not specified, which is // usually the case for the first request of ListReleaseLabels, the first page of // results are determined by other filtering parameters or by the latest version. - // The ListReleaseLabels request fails if the identity (Amazon Web Services account - // ID) and all filtering parameters are different from the original request, or if - // the NextToken is expired or tampered with. + // The ListReleaseLabels request fails if the identity (Amazon Web Services + // account ID) and all filtering parameters are different from the original + // request, or if the NextToken is expired or tampered with. NextToken *string noSmithyDocumentSerde @@ -135,8 +135,8 @@ var _ ListReleaseLabelsAPIClient = (*Client)(nil) // ListReleaseLabelsPaginatorOptions is the paginator options for ListReleaseLabels type ListReleaseLabelsPaginatorOptions struct { - // Defines the maximum number of release labels to return in a single response. The - // default is 100. + // Defines the maximum number of release labels to return in a single response. + // The default is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/emr/api_op_ListSteps.go b/service/emr/api_op_ListSteps.go index e3bbcb9c31e..55cc0445e51 100644 --- a/service/emr/api_op_ListSteps.go +++ b/service/emr/api_op_ListSteps.go @@ -13,9 +13,9 @@ import ( ) // Provides a list of steps for the cluster in reverse order unless you specify -// stepIds with the request or filter by StepStates. You can specify a maximum of -// 10 stepIDs. The CLI automatically paginates results to return a list greater -// than 50 steps. To return more than 50 steps using the CLI, specify a Marker, +// stepIds with the request or filter by StepStates . You can specify a maximum of +// 10 stepIDs . The CLI automatically paginates results to return a list greater +// than 50 steps. To return more than 50 steps using the CLI, specify a Marker , // which is a pagination token that indicates the next set of steps to retrieve. func (c *Client) ListSteps(ctx context.Context, params *ListStepsInput, optFns ...func(*Options)) (*ListStepsOutput, error) { if params == nil { diff --git a/service/emr/api_op_ListStudioSessionMappings.go b/service/emr/api_op_ListStudioSessionMappings.go index 02088a229ee..df28008ebc3 100644 --- a/service/emr/api_op_ListStudioSessionMappings.go +++ b/service/emr/api_op_ListStudioSessionMappings.go @@ -13,7 +13,7 @@ import ( ) // Returns a list of all user or group session mappings for the Amazon EMR Studio -// specified by StudioId. +// specified by StudioId . func (c *Client) ListStudioSessionMappings(ctx context.Context, params *ListStudioSessionMappingsInput, optFns ...func(*Options)) (*ListStudioSessionMappingsOutput, error) { if params == nil { params = &ListStudioSessionMappingsInput{} diff --git a/service/emr/api_op_ListStudios.go b/service/emr/api_op_ListStudios.go index 7d596c78578..3987648b9e0 100644 --- a/service/emr/api_op_ListStudios.go +++ b/service/emr/api_op_ListStudios.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of all Amazon EMR Studios associated with the Amazon Web Services -// account. The list includes details such as ID, Studio Access URL, and creation -// time for each Studio. +// Returns a list of all Amazon EMR Studios associated with the Amazon Web +// Services account. The list includes details such as ID, Studio Access URL, and +// creation time for each Studio. func (c *Client) ListStudios(ctx context.Context, params *ListStudiosInput, optFns ...func(*Options)) (*ListStudiosOutput, error) { if params == nil { params = &ListStudiosInput{} diff --git a/service/emr/api_op_ModifyCluster.go b/service/emr/api_op_ModifyCluster.go index 3f5d6d5da7f..98a53094141 100644 --- a/service/emr/api_op_ModifyCluster.go +++ b/service/emr/api_op_ModifyCluster.go @@ -34,10 +34,10 @@ type ModifyClusterInput struct { // This member is required. ClusterId *string - // The number of steps that can be executed concurrently. You can specify a minimum - // of 1 step and a maximum of 256 steps. We recommend that you do not change this - // parameter while steps are running or the ActionOnFailure setting may not behave - // as expected. For more information see Step$ActionOnFailure. + // The number of steps that can be executed concurrently. You can specify a + // minimum of 1 step and a maximum of 256 steps. We recommend that you do not + // change this parameter while steps are running or the ActionOnFailure setting + // may not behave as expected. For more information see Step$ActionOnFailure . StepConcurrencyLevel *int32 noSmithyDocumentSerde diff --git a/service/emr/api_op_PutAutoScalingPolicy.go b/service/emr/api_op_PutAutoScalingPolicy.go index 037dbb46685..9820274f999 100644 --- a/service/emr/api_op_PutAutoScalingPolicy.go +++ b/service/emr/api_op_PutAutoScalingPolicy.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates an automatic scaling policy for a core instance group or task -// instance group in an Amazon EMR cluster. The automatic scaling policy defines -// how an instance group dynamically adds and terminates EC2 instances in response -// to the value of a CloudWatch metric. +// Creates or updates an automatic scaling policy for a core instance group or +// task instance group in an Amazon EMR cluster. The automatic scaling policy +// defines how an instance group dynamically adds and terminates EC2 instances in +// response to the value of a CloudWatch metric. func (c *Client) PutAutoScalingPolicy(ctx context.Context, params *PutAutoScalingPolicyInput, optFns ...func(*Options)) (*PutAutoScalingPolicyOutput, error) { if params == nil { params = &PutAutoScalingPolicyInput{} @@ -37,8 +37,8 @@ type PutAutoScalingPolicyInput struct { // This member is required. AutoScalingPolicy *types.AutoScalingPolicy - // Specifies the ID of a cluster. The instance group to which the automatic scaling - // policy is applied is within this cluster. + // Specifies the ID of a cluster. The instance group to which the automatic + // scaling policy is applied is within this cluster. // // This member is required. ClusterId *string @@ -60,8 +60,8 @@ type PutAutoScalingPolicyOutput struct { // The Amazon Resource Name (ARN) of the cluster. ClusterArn *string - // Specifies the ID of a cluster. The instance group to which the automatic scaling - // policy is applied is within this cluster. + // Specifies the ID of a cluster. The instance group to which the automatic + // scaling policy is applied is within this cluster. ClusterId *string // Specifies the ID of the instance group to which the scaling policy is applied. diff --git a/service/emr/api_op_PutAutoTerminationPolicy.go b/service/emr/api_op_PutAutoTerminationPolicy.go index 1951a07ca91..f187930e4bd 100644 --- a/service/emr/api_op_PutAutoTerminationPolicy.go +++ b/service/emr/api_op_PutAutoTerminationPolicy.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. -// For more information, see Using an auto-termination policy -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-auto-termination-policy.html). -// Creates or updates an auto-termination policy for an Amazon EMR cluster. An +// Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and +// later. For more information, see Using an auto-termination policy (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-auto-termination-policy.html) +// . Creates or updates an auto-termination policy for an Amazon EMR cluster. An // auto-termination policy defines the amount of idle time in seconds after which a // cluster automatically terminates. For alternative cluster termination options, -// see Control cluster termination -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html). +// see Control cluster termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html) +// . func (c *Client) PutAutoTerminationPolicy(ctx context.Context, params *PutAutoTerminationPolicyInput, optFns ...func(*Options)) (*PutAutoTerminationPolicyOutput, error) { if params == nil { params = &PutAutoTerminationPolicyInput{} diff --git a/service/emr/api_op_PutBlockPublicAccessConfiguration.go b/service/emr/api_op_PutBlockPublicAccessConfiguration.go index ea93c15941d..bc34537eba1 100644 --- a/service/emr/api_op_PutBlockPublicAccessConfiguration.go +++ b/service/emr/api_op_PutBlockPublicAccessConfiguration.go @@ -13,8 +13,7 @@ import ( // Creates or updates an Amazon EMR block public access configuration for your // Amazon Web Services account in the current Region. For more information see -// Configure Block Public Access for Amazon EMR -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) +// Configure Block Public Access for Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html) // in the Amazon EMR Management Guide. func (c *Client) PutBlockPublicAccessConfiguration(ctx context.Context, params *PutBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*PutBlockPublicAccessConfigurationOutput, error) { if params == nil { @@ -33,13 +32,13 @@ func (c *Client) PutBlockPublicAccessConfiguration(ctx context.Context, params * type PutBlockPublicAccessConfigurationInput struct { - // A configuration for Amazon EMR block public access. The configuration applies to - // all clusters created in your account for the current Region. The configuration - // specifies whether block public access is enabled. If block public access is - // enabled, security groups associated with the cluster cannot have rules that - // allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is + // A configuration for Amazon EMR block public access. The configuration applies + // to all clusters created in your account for the current Region. The + // configuration specifies whether block public access is enabled. If block public + // access is enabled, security groups associated with the cluster cannot have rules + // that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is // specified as an exception using PermittedPublicSecurityGroupRuleRanges in the - // BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and + // BlockPublicAccessConfiguration . By default, Port 22 (SSH) is an exception, and // public access is allowed on this port. You can change this by updating // BlockPublicSecurityGroupRules to remove the exception. For accounts that created // clusters in a Region before November 25, 2019, block public access is disabled diff --git a/service/emr/api_op_RemoveAutoScalingPolicy.go b/service/emr/api_op_RemoveAutoScalingPolicy.go index e0e0ccae4f3..3da3b09cad7 100644 --- a/service/emr/api_op_RemoveAutoScalingPolicy.go +++ b/service/emr/api_op_RemoveAutoScalingPolicy.go @@ -29,8 +29,8 @@ func (c *Client) RemoveAutoScalingPolicy(ctx context.Context, params *RemoveAuto type RemoveAutoScalingPolicyInput struct { - // Specifies the ID of a cluster. The instance group to which the automatic scaling - // policy is applied is within this cluster. + // Specifies the ID of a cluster. The instance group to which the automatic + // scaling policy is applied is within this cluster. // // This member is required. ClusterId *string diff --git a/service/emr/api_op_RemoveTags.go b/service/emr/api_op_RemoveTags.go index a62a54bf062..2358d322bdb 100644 --- a/service/emr/api_op_RemoveTags.go +++ b/service/emr/api_op_RemoveTags.go @@ -13,9 +13,8 @@ import ( // Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR // Studio. Tags make it easier to associate resources in various ways, such as // grouping clusters to track your Amazon EMR resource allocation costs. For more -// information, see Tag Clusters -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). The -// following example removes the stack tag with value Prod from a cluster: +// information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html) +// . The following example removes the stack tag with value Prod from a cluster: func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error) { if params == nil { params = &RemoveTagsInput{} @@ -34,8 +33,8 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns // This input identifies an Amazon EMR resource and a list of tags to remove. type RemoveTagsInput struct { - // The Amazon EMR resource identifier from which tags will be removed. For example, - // a cluster identifier or an Amazon EMR Studio ID. + // The Amazon EMR resource identifier from which tags will be removed. For + // example, a cluster identifier or an Amazon EMR Studio ID. // // This member is required. ResourceId *string diff --git a/service/emr/api_op_RunJobFlow.go b/service/emr/api_op_RunJobFlow.go index 1fbfd73d802..e99b81ae50a 100644 --- a/service/emr/api_op_RunJobFlow.go +++ b/service/emr/api_op_RunJobFlow.go @@ -11,25 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// RunJobFlow creates and starts running a new cluster (job flow). The cluster runs -// the steps specified. After the steps complete, the cluster stops and the HDFS -// partition is lost. To prevent loss of data, configure the last step of the job -// flow to store results in Amazon S3. If the -// JobFlowInstancesConfigKeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the -// cluster transitions to the WAITING state rather than shutting down after the -// steps have completed. For additional protection, you can set the -// JobFlowInstancesConfigTerminationProtected parameter to TRUE to lock the cluster -// and prevent it from being terminated by API call, user intervention, or in the -// event of a job flow error. A maximum of 256 steps are allowed in each job flow. -// If your cluster is long-running (such as a Hive data warehouse) or complex, you -// may require more than 256 steps to process your data. You can bypass the -// 256-step limitation in various ways, including using the SSH shell to connect to -// the master node and submitting queries directly to the software running on the -// master node, such as Hive and Hadoop. For long-running clusters, we recommend -// that you periodically store your results. The instance fleets configuration is -// available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. -// The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups -// parameters, but not both. +// RunJobFlow creates and starts running a new cluster (job flow). The cluster +// runs the steps specified. After the steps complete, the cluster stops and the +// HDFS partition is lost. To prevent loss of data, configure the last step of the +// job flow to store results in Amazon S3. If the JobFlowInstancesConfig +// KeepJobFlowAliveWhenNoSteps parameter is set to TRUE , the cluster transitions +// to the WAITING state rather than shutting down after the steps have completed. +// For additional protection, you can set the JobFlowInstancesConfig +// TerminationProtected parameter to TRUE to lock the cluster and prevent it from +// being terminated by API call, user intervention, or in the event of a job flow +// error. A maximum of 256 steps are allowed in each job flow. If your cluster is +// long-running (such as a Hive data warehouse) or complex, you may require more +// than 256 steps to process your data. You can bypass the 256-step limitation in +// various ways, including using the SSH shell to connect to the master node and +// submitting queries directly to the software running on the master node, such as +// Hive and Hadoop. For long-running clusters, we recommend that you periodically +// store your results. The instance fleets configuration is available only in +// Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow +// request can contain InstanceFleets parameters or InstanceGroups parameters, but +// not both. func (c *Client) RunJobFlow(ctx context.Context, params *RunJobFlowInput, optFns ...func(*Options)) (*RunJobFlowOutput, error) { if params == nil { params = &RunJobFlowInput{} @@ -61,28 +61,28 @@ type RunJobFlowInput struct { // A JSON string for selecting additional features. AdditionalInfo *string - // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 - // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases + // 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID . AmiVersion *string // Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of // applications for Amazon EMR to install and configure when launching the cluster. // For a list of applications available for each Amazon EMR release version, see - // the Amazon EMRRelease Guide - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). + // the Amazon EMRRelease Guide (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/) + // . Applications []types.Application // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the + // EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the // automatic scaling feature requires to launch and terminate EC2 instances in an // instance group. AutoScalingRole *string - // An auto-termination policy for an Amazon EMR cluster. An auto-termination policy - // defines the amount of idle time in seconds after which a cluster automatically - // terminates. For alternative cluster termination options, see Control cluster - // termination - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html). + // An auto-termination policy for an Amazon EMR cluster. An auto-termination + // policy defines the amount of idle time in seconds after which a cluster + // automatically terminates. For alternative cluster termination options, see + // Control cluster termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html) + // . AutoTerminationPolicy *types.AutoTerminationPolicy // A list of bootstrap actions to run before Hadoop starts on the cluster nodes. @@ -95,16 +95,14 @@ type RunJobFlowInput struct { // Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon // EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches // cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see - // Using a Custom AMI - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html) in - // the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI - // for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use - // AmiVersion instead. For information about creating a custom AMI, see Creating an - // Amazon EBS-Backed Linux AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) + // Using a Custom AMI (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html) + // in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux + // AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use + // AmiVersion instead. For information about creating a custom AMI, see Creating + // an Amazon EBS-Backed Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) // in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For - // information about finding an AMI ID, see Finding a Linux AMI - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html). + // information about finding an AMI ID, see Finding a Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) + // . CustomAmiId *string // The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is @@ -113,15 +111,14 @@ type RunJobFlowInput struct { // Also called instance profile and EC2 role. An IAM role for an EMR cluster. The // EC2 instances of the cluster assume this role. The default role is - // EMR_EC2_DefaultRole. In order to use the default role, you must have already + // EMR_EC2_DefaultRole . In order to use the default role, you must have already // created it using the CLI or console. JobFlowRole *string // Attributes for Kerberos configuration when Kerberos authentication is enabled // using a security configuration. For more information see Use Kerberos - // Authentication - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in - // the Amazon EMR Management Guide. + // Authentication (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) + // in the Amazon EMR Management Guide. KerberosAttributes *types.KerberosAttributes // The KMS key used for encrypting log files. If a value is not provided, the logs @@ -141,32 +138,18 @@ type RunJobFlowInput struct { // the job flow that accepts a user argument list. EMR accepts and forwards the // argument list to the corresponding installation script as bootstrap action // arguments. For more information, see "Launch a Job Flow on the MapR Distribution - // for Hadoop" in the Amazon EMR Developer Guide - // (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Supported - // values are: - // - // * "mapr-m3" - launch the cluster using MapR M3 Edition. - // - // * - // "mapr-m5" - launch the cluster using MapR M5 Edition. - // - // * "mapr" with the user - // arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow - // using MapR M3 or M5 Edition respectively. - // - // * "mapr-m7" - launch the cluster - // using MapR M7 Edition. - // - // * "hunk" - launch the cluster with the Hunk Big Data - // Analytics Platform. - // - // * "hue"- launch the cluster with Hue installed. - // - // * "spark" - // - launch the cluster with Apache Spark installed. - // - // * "ganglia" - launch the - // cluster with the Ganglia Monitoring System installed. + // for Hadoop" in the Amazon EMR Developer Guide (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf) + // . Supported values are: + // - "mapr-m3" - launch the cluster using MapR M3 Edition. + // - "mapr-m5" - launch the cluster using MapR M5 Edition. + // - "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" + // - launch the job flow using MapR M3 or M5 Edition respectively. + // - "mapr-m7" - launch the cluster using MapR M7 Edition. + // - "hunk" - launch the cluster with the Hunk Big Data Analytics Platform. + // - "hue"- launch the cluster with Hue installed. + // - "spark" - launch the cluster with Apache Spark installed. + // - "ganglia" - launch the cluster with the Ganglia Monitoring System + // installed. NewSupportedProducts []types.SupportedProductConfig // Specifies a particular Amazon Linux release for all nodes in a cluster launch @@ -179,17 +162,16 @@ type RunJobFlowInput struct { // The Amazon EMR release label, which determines the version of open-source // application packages installed on the cluster. Release labels are in the form - // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For - // more information about Amazon EMR release versions and included application - // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label - // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use - // AmiVersion. + // emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . + // For more information about Amazon EMR release versions and included application + // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/) + // . The release label applies only to Amazon EMR releases version 4.0 and later. + // Earlier versions use AmiVersion . ReleaseLabel *string // Applies only when CustomAmiID is used. Specifies which updates from the Amazon // Linux AMI package repositories to apply automatically when the instance boots - // using the AMI. If omitted, the default is SECURITY, which indicates that only + // using the AMI. If omitted, the default is SECURITY , which indicates that only // security updates are applied. If NONE is specified, no updates are applied, and // all updates must be applied manually. RepoUpgradeOnBoot types.RepoUpgradeOnBoot @@ -218,7 +200,7 @@ type RunJobFlowInput struct { ServiceRole *string // Specifies the number of steps that can be executed concurrently. The default - // value is 1. The maximum value is 256. + // value is 1 . The maximum value is 256 . StepConcurrencyLevel *int32 // A list of steps to run. @@ -226,33 +208,27 @@ type RunJobFlowInput struct { // For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use // Applications. A list of strings that indicates third-party software to use. For - // more information, see the Amazon EMR Developer Guide - // (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf). Currently - // supported values are: - // - // * "mapr-m3" - launch the job flow using MapR M3 - // Edition. - // - // * "mapr-m5" - launch the job flow using MapR M5 Edition. + // more information, see the Amazon EMR Developer Guide (https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf) + // . Currently supported values are: + // - "mapr-m3" - launch the job flow using MapR M3 Edition. + // - "mapr-m5" - launch the job flow using MapR M5 Edition. SupportedProducts []string // A list of tags to associate with a cluster and propagate to Amazon EC2 // instances. Tags []types.Tag - // The VisibleToAllUsers parameter is no longer supported. By default, the value is - // set to true. Setting it to false now has no effect. Set this value to true so - // that IAM principals in the Amazon Web Services account associated with the + // The VisibleToAllUsers parameter is no longer supported. By default, the value + // is set to true . Setting it to false now has no effect. Set this value to true + // so that IAM principals in the Amazon Web Services account associated with the // cluster can perform EMR actions on the cluster that their IAM policies allow. // This value defaults to true for clusters created using the EMR API or the CLI - // create-cluster - // (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) - // command. When set to false, only the IAM principal that created the cluster and + // create-cluster (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) + // command. When set to false , only the IAM principal that created the cluster and // the Amazon Web Services account root user can perform EMR actions for the // cluster, regardless of the IAM permissions policies attached to other IAM // principals. For more information, see Understanding the EMR Cluster - // VisibleToAllUsers Setting - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users) + // VisibleToAllUsers Setting (https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users) // in the Amazon EMRManagement Guide. VisibleToAllUsers bool diff --git a/service/emr/api_op_SetTerminationProtection.go b/service/emr/api_op_SetTerminationProtection.go index 5612743bf07..a32b68bc081 100644 --- a/service/emr/api_op_SetTerminationProtection.go +++ b/service/emr/api_op_SetTerminationProtection.go @@ -15,14 +15,13 @@ import ( // of a job-flow error. The cluster still terminates upon successful completion of // the job flow. Calling SetTerminationProtection on a cluster is similar to // calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a -// cluster. SetTerminationProtection is used to prevent accidental termination of a -// cluster and to ensure that in the event of an error, the instances persist so +// cluster. SetTerminationProtection is used to prevent accidental termination of +// a cluster and to ensure that in the event of an error, the instances persist so // that you can recover any data stored in their ephemeral instance storage. To // terminate a cluster that has been locked by setting SetTerminationProtection to -// true, you must first unlock the job flow by a subsequent call to -// SetTerminationProtection in which you set the value to false. For more -// information, seeManaging Cluster Termination -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) +// true , you must first unlock the job flow by a subsequent call to +// SetTerminationProtection in which you set the value to false . For more +// information, see Managing Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) // in the Amazon EMR Management Guide. func (c *Client) SetTerminationProtection(ctx context.Context, params *SetTerminationProtectionInput, optFns ...func(*Options)) (*SetTerminationProtectionOutput, error) { if params == nil { diff --git a/service/emr/api_op_SetVisibleToAllUsers.go b/service/emr/api_op_SetVisibleToAllUsers.go index 54bd4f47da8..88fc93cf281 100644 --- a/service/emr/api_op_SetVisibleToAllUsers.go +++ b/service/emr/api_op_SetVisibleToAllUsers.go @@ -12,17 +12,15 @@ import ( // The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be // visible to all users in your account. To restrict cluster access using an IAM -// policy, see Identity and Access Management for EMR -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-iam.html). -// Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM +// policy, see Identity and Access Management for EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-iam.html) +// . Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true , IAM // principals in the Amazon Web Services account can perform EMR cluster actions -// that their IAM policies allow. When false, only the IAM principal that created +// that their IAM policies allow. When false , only the IAM principal that created // the cluster and the Amazon Web Services account root user can perform EMR // actions on the cluster, regardless of IAM permissions policies attached to other // IAM principals. This action works on running clusters. When you create a // cluster, use the RunJobFlowInput$VisibleToAllUsers parameter. For more -// information, see Understanding the EMR Cluster VisibleToAllUsers Setting -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users) +// information, see Understanding the EMR Cluster VisibleToAllUsers Setting (https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users) // in the Amazon EMRManagement Guide. func (c *Client) SetVisibleToAllUsers(ctx context.Context, params *SetVisibleToAllUsersInput, optFns ...func(*Options)) (*SetVisibleToAllUsersOutput, error) { if params == nil { @@ -49,8 +47,8 @@ type SetVisibleToAllUsersInput struct { // A value of true indicates that an IAM principal in the Amazon Web Services // account can perform EMR actions on the cluster that the IAM policies attached to - // the principal allow. A value of false indicates that only the IAM principal that - // created the cluster and the Amazon Web Services root user can perform EMR + // the principal allow. A value of false indicates that only the IAM principal + // that created the cluster and the Amazon Web Services root user can perform EMR // actions on the cluster. // // This member is required. diff --git a/service/emr/api_op_StartNotebookExecution.go b/service/emr/api_op_StartNotebookExecution.go index 2431f827a41..40eefc5e42e 100644 --- a/service/emr/api_op_StartNotebookExecution.go +++ b/service/emr/api_op_StartNotebookExecution.go @@ -43,9 +43,10 @@ type StartNotebookExecutionInput struct { // path specified for the EMR Notebook. For example, if you specify a path of // s3://MyBucket/MyNotebooks when you create an EMR Notebook for a notebook with an // ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you - // specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the + // specify a RelativePath of my_notebook_executions/notebook_execution.ipynb , the // location of the file for the notebook execution is - // s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb. + // s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb + // . // // This member is required. RelativePath *string @@ -59,8 +60,8 @@ type StartNotebookExecutionInput struct { // An optional name for the notebook execution. NotebookExecutionName *string - // The unique identifier of the Amazon EC2 security group to associate with the EMR - // Notebook for this notebook execution. + // The unique identifier of the Amazon EC2 security group to associate with the + // EMR Notebook for this notebook execution. NotebookInstanceSecurityGroupId *string // Input parameters in JSON format passed to the EMR Notebook at runtime for diff --git a/service/emr/api_op_TerminateJobFlows.go b/service/emr/api_op_TerminateJobFlows.go index 38ebdaa5bb2..4d76bd6035e 100644 --- a/service/emr/api_op_TerminateJobFlows.go +++ b/service/emr/api_op_TerminateJobFlows.go @@ -14,10 +14,10 @@ import ( // shut down, any step not yet completed is canceled and the EC2 instances on which // the cluster is running are stopped. Any log files not already saved are uploaded // to Amazon S3 if a LogUri was specified when the cluster was created. The maximum -// number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. -// Depending on the configuration of the cluster, it may take up to 1-5 minutes for -// the cluster to completely terminate and release allocated resources, such as -// Amazon EC2 instances. +// number of clusters allowed is 10. The call to TerminateJobFlows is +// asynchronous. Depending on the configuration of the cluster, it may take up to +// 1-5 minutes for the cluster to completely terminate and release allocated +// resources, such as Amazon EC2 instances. func (c *Client) TerminateJobFlows(ctx context.Context, params *TerminateJobFlowsInput, optFns ...func(*Options)) (*TerminateJobFlowsOutput, error) { if params == nil { params = &TerminateJobFlowsInput{} diff --git a/service/emr/api_op_UpdateStudioSessionMapping.go b/service/emr/api_op_UpdateStudioSessionMapping.go index 6330e7ec3f2..d017ddb2430 100644 --- a/service/emr/api_op_UpdateStudioSessionMapping.go +++ b/service/emr/api_op_UpdateStudioSessionMapping.go @@ -47,18 +47,14 @@ type UpdateStudioSessionMappingInput struct { StudioId *string // The globally unique identifier (GUID) of the user or group. For more - // information, see UserId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) - // and GroupId - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) + // information, see UserId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId) + // and GroupId (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityId *string - // The name of the user or group to update. For more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // The name of the user or group to update. For more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. IdentityName *string diff --git a/service/emr/types/enums.go b/service/emr/types/enums.go index 601c9042740..c96e5ddbf16 100644 --- a/service/emr/types/enums.go +++ b/service/emr/types/enums.go @@ -97,9 +97,9 @@ const ( AutoScalingPolicyStateChangeReasonCodeCleanupFailure AutoScalingPolicyStateChangeReasonCode = "CLEANUP_FAILURE" ) -// Values returns all known values for AutoScalingPolicyStateChangeReasonCode. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for AutoScalingPolicyStateChangeReasonCode. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (AutoScalingPolicyStateChangeReasonCode) Values() []AutoScalingPolicyStateChangeReasonCode { return []AutoScalingPolicyStateChangeReasonCode{ @@ -117,9 +117,9 @@ const ( CancelStepsRequestStatusFailed CancelStepsRequestStatus = "FAILED" ) -// Values returns all known values for CancelStepsRequestStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CancelStepsRequestStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CancelStepsRequestStatus) Values() []CancelStepsRequestStatus { return []CancelStepsRequestStatus{ "SUBMITTED", @@ -140,9 +140,9 @@ const ( ClusterStateTerminatedWithErrors ClusterState = "TERMINATED_WITH_ERRORS" ) -// Values returns all known values for ClusterState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClusterState) Values() []ClusterState { return []ClusterState{ "STARTING", @@ -169,9 +169,10 @@ const ( ClusterStateChangeReasonCodeAllStepsCompleted ClusterStateChangeReasonCode = "ALL_STEPS_COMPLETED" ) -// Values returns all known values for ClusterStateChangeReasonCode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterStateChangeReasonCode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ClusterStateChangeReasonCode) Values() []ClusterStateChangeReasonCode { return []ClusterStateChangeReasonCode{ "INTERNAL_ERROR", @@ -216,8 +217,8 @@ const ( ComputeLimitsUnitTypeVcpu ComputeLimitsUnitType = "VCPU" ) -// Values returns all known values for ComputeLimitsUnitType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ComputeLimitsUnitType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ComputeLimitsUnitType) Values() []ComputeLimitsUnitType { return []ComputeLimitsUnitType{ @@ -251,9 +252,9 @@ const ( IdentityTypeGroup IdentityType = "GROUP" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "USER", @@ -512,8 +513,8 @@ const ( JobFlowExecutionStateFailed JobFlowExecutionState = "FAILED" ) -// Values returns all known values for JobFlowExecutionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for JobFlowExecutionState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (JobFlowExecutionState) Values() []JobFlowExecutionState { return []JobFlowExecutionState{ @@ -623,9 +624,9 @@ const ( OnDemandProvisioningAllocationStrategyLowestPrice OnDemandProvisioningAllocationStrategy = "lowest-price" ) -// Values returns all known values for OnDemandProvisioningAllocationStrategy. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for OnDemandProvisioningAllocationStrategy. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (OnDemandProvisioningAllocationStrategy) Values() []OnDemandProvisioningAllocationStrategy { return []OnDemandProvisioningAllocationStrategy{ @@ -756,9 +757,9 @@ const ( StatisticMaximum Statistic = "MAXIMUM" ) -// Values returns all known values for Statistic. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Statistic. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Statistic) Values() []Statistic { return []Statistic{ "SAMPLE_COUNT", @@ -828,9 +829,9 @@ const ( StepStateInterrupted StepState = "INTERRUPTED" ) -// Values returns all known values for StepState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for StepState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (StepState) Values() []StepState { return []StepState{ "PENDING", diff --git a/service/emr/types/types.go b/service/emr/types/types.go index 3b94c399d4f..a4882c50bcd 100644 --- a/service/emr/types/types.go +++ b/service/emr/types/types.go @@ -10,9 +10,8 @@ import ( // With Amazon EMR release version 4.0 and later, the only accepted parameter is // the application name. To pass arguments to applications, you use configuration // classifications specified using configuration JSON objects. For more -// information, see Configuring Applications -// (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html). -// With earlier Amazon EMR releases, the application is any Amazon or third-party +// information, see Configuring Applications (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html) +// . With earlier Amazon EMR releases, the application is any Amazon or third-party // software that you can add to the cluster. This structure contains a list of // strings that indicates the software to use with the cluster and accepts a user // argument list. Amazon EMR accepts and forwards the argument list to the @@ -38,7 +37,7 @@ type Application struct { // An automatic scaling policy for a core instance group or task instance group in // an Amazon EMR cluster. An automatic scaling policy defines how an instance group // dynamically adds and terminates EC2 instances in response to the value of a -// CloudWatch metric. See PutAutoScalingPolicy. +// CloudWatch metric. See PutAutoScalingPolicy . type AutoScalingPolicy struct { // The upper and lower EC2 instance limits for an automatic scaling policy. @@ -59,7 +58,7 @@ type AutoScalingPolicy struct { // An automatic scaling policy for a core instance group or task instance group in // an Amazon EMR cluster. The automatic scaling policy defines how an instance // group dynamically adds and terminates EC2 instances in response to the value of -// a CloudWatch metric. See PutAutoScalingPolicy. +// a CloudWatch metric. See PutAutoScalingPolicy . type AutoScalingPolicyDescription struct { // The upper and lower EC2 instance limits for an automatic scaling policy. @@ -79,7 +78,7 @@ type AutoScalingPolicyDescription struct { // The reason for an AutoScalingPolicyStatus change. type AutoScalingPolicyStateChangeReason struct { - // The code indicating the reason for the change in status.USER_REQUEST indicates + // The code indicating the reason for the change in status. USER_REQUEST indicates // that the scaling policy status was changed by a user. PROVISION_FAILURE // indicates that the status change was because the policy failed to provision. // CLEANUP_FAILURE indicates an error. @@ -104,11 +103,11 @@ type AutoScalingPolicyStatus struct { noSmithyDocumentSerde } -// An auto-termination policy for an Amazon EMR cluster. An auto-termination policy -// defines the amount of idle time in seconds after which a cluster automatically -// terminates. For alternative cluster termination options, see Control cluster -// termination -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html). +// An auto-termination policy for an Amazon EMR cluster. An auto-termination +// policy defines the amount of idle time in seconds after which a cluster +// automatically terminates. For alternative cluster termination options, see +// Control cluster termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html) +// . type AutoTerminationPolicy struct { // Specifies the amount of idle time in seconds after which the cluster @@ -120,15 +119,15 @@ type AutoTerminationPolicy struct { } // A configuration for Amazon EMR block public access. When -// BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster +// BlockPublicSecurityGroupRules is set to true , Amazon EMR prevents cluster // creation if one of the cluster's security groups has a rule that allows inbound // traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an -// exception using PermittedPublicSecurityGroupRuleRanges. +// exception using PermittedPublicSecurityGroupRuleRanges . type BlockPublicAccessConfiguration struct { - // Indicates whether Amazon EMR block public access is enabled (true) or disabled - // (false). By default, the value is false for accounts that have created EMR - // clusters before July 2019. For accounts created after this, the default is true. + // Indicates whether Amazon EMR block public access is enabled ( true ) or disabled + // ( false ). By default, the value is false for accounts that have created EMR + // clusters before July 2019. For accounts created after this, the default is true . // // This member is required. BlockPublicSecurityGroupRules bool @@ -141,11 +140,11 @@ type BlockPublicAccessConfiguration struct { // Specifies ports and port ranges that are permitted to have security group rules // that allow inbound traffic from all public sources. For example, if Port 23 - // (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR + // (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges , Amazon EMR // allows cluster creation if a security group associated with the cluster has a // rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port // ::/0 as the source. By default, Port 22, which is used for SSH access to the - // cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges. + // cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges . PermittedPublicSecurityGroupRuleRanges []PortRange // A set of properties specified within a configuration classification. @@ -221,7 +220,7 @@ type CancelStepsInfo struct { type CloudWatchAlarmDefinition struct { // Determines how the metric specified by MetricName is compared to the value - // specified by Threshold. + // specified by Threshold . // // This member is required. ComparisonOperator ComparisonOperator @@ -234,7 +233,7 @@ type CloudWatchAlarmDefinition struct { // The period, in seconds, over which the statistic is applied. EMR CloudWatch // metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch - // metric is specified, specify 300. + // metric is specified, specify 300 . // // This member is required. Period *int32 @@ -249,14 +248,14 @@ type CloudWatchAlarmDefinition struct { // The number of periods, in five-minute increments, during which the alarm // condition must exist before the alarm triggers automatic scaling activity. The - // default value is 1. + // default value is 1 . EvaluationPeriods *int32 - // The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce. + // The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce . Namespace *string // The statistic to apply to the metric associated with the alarm. The default is - // AVERAGE. + // AVERAGE . Statistic Statistic // The unit of measure associated with the CloudWatch metric being watched. The @@ -274,7 +273,7 @@ type Cluster struct { Applications []Application // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the + // EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the // automatic scaling feature requires to launch and terminate EC2 instances in an // instance group. AutoScalingRole *string @@ -313,13 +312,12 @@ type Cluster struct { // Attributes for Kerberos configuration when Kerberos authentication is enabled // using a security configuration. For more information see Use Kerberos - // Authentication - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in - // the Amazon EMR Management Guide. + // Authentication (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) + // in the Amazon EMR Management Guide. KerberosAttributes *KerberosAttributes - // The KMS key used for encrypting log files. This attribute is only available with - // EMR version 5.30.0 and later, excluding EMR 6.0.0. + // The KMS key used for encrypting log files. This attribute is only available + // with EMR version 5.30.0 and later, excluding EMR 6.0.0. LogEncryptionKmsKeyId *string // The path to the Amazon S3 location where logs for this cluster are stored. @@ -332,17 +330,17 @@ type Cluster struct { // The name of the cluster. Name *string - // An approximation of the cost of the cluster, represented in m1.small/hours. This - // value is incremented one time for every hour an m1.small instance runs. Larger - // instances are weighted more, so an EC2 instance that is roughly four times more - // expensive would result in the normalized instance hours being incremented by - // four. This result is only an approximation and does not reflect the actual - // billing rate. + // An approximation of the cost of the cluster, represented in m1.small/hours. + // This value is incremented one time for every hour an m1.small instance runs. + // Larger instances are weighted more, so an EC2 instance that is roughly four + // times more expensive would result in the normalized instance hours being + // incremented by four. This result is only an approximation and does not reflect + // the actual billing rate. NormalizedInstanceHours *int32 - // The Amazon Linux release specified in a cluster launch RunJobFlow request. If no - // Amazon Linux release was specified, the default Amazon Linux release is shown in - // the response. + // The Amazon Linux release specified in a cluster launch RunJobFlow request. If + // no Amazon Linux release was specified, the default Amazon Linux release is shown + // in the response. OSReleaseLabel *string // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. @@ -353,12 +351,11 @@ type Cluster struct { // The Amazon EMR release label, which determines the version of open-source // application packages installed on the cluster. Release labels are in the form - // emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For - // more information about Amazon EMR release versions and included application - // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ - // (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/). The release label - // applies only to Amazon EMR releases version 4.0 and later. Earlier versions use - // AmiVersion. + // emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . + // For more information about Amazon EMR release versions and included application + // versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/) + // . The release label applies only to Amazon EMR releases version 4.0 and later. + // Earlier versions use AmiVersion . ReleaseLabel *string // Applies only when CustomAmiID is used. Specifies the type of updates that are @@ -409,14 +406,13 @@ type Cluster struct { TerminationProtected bool // Indicates whether the cluster is visible to IAM principals in the Amazon Web - // Services account associated with the cluster. When true, IAM principals in the + // Services account associated with the cluster. When true , IAM principals in the // Amazon Web Services account can perform EMR cluster actions on the cluster that - // their IAM policies allow. When false, only the IAM principal that created the + // their IAM policies allow. When false , only the IAM principal that created the // cluster and the Amazon Web Services account root user can perform EMR actions, // regardless of IAM permissions policies attached to other IAM principals. The // default value is true if a value is not provided when creating a cluster using - // the EMR API RunJobFlow command, the CLI create-cluster - // (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) + // the EMR API RunJobFlow command, the CLI create-cluster (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) // command, or the Amazon Web Services Management Console. VisibleToAllUsers bool @@ -438,8 +434,9 @@ type ClusterStateChangeReason struct { // The detailed status of the cluster. type ClusterStatus struct { - // A list of tuples that provide information about the errors that caused a cluster - // termination. This structure may have up to 10 different ErrorDetail tuples. + // A list of tuples that provide information about the errors that caused a + // cluster termination. This structure may have up to 10 different ErrorDetail + // tuples. ErrorDetails []ErrorDetail // The current state of the cluster. @@ -467,12 +464,12 @@ type ClusterSummary struct { // The name of the cluster. Name *string - // An approximation of the cost of the cluster, represented in m1.small/hours. This - // value is incremented one time for every hour an m1.small instance runs. Larger - // instances are weighted more, so an EC2 instance that is roughly four times more - // expensive would result in the normalized instance hours being incremented by - // four. This result is only an approximation and does not reflect the actual - // billing rate. + // An approximation of the cost of the cluster, represented in m1.small/hours. + // This value is incremented one time for every hour an m1.small instance runs. + // Larger instances are weighted more, so an EC2 instance that is roughly four + // times more expensive would result in the normalized instance hours being + // incremented by four. This result is only an approximation and does not reflect + // the actual billing rate. NormalizedInstanceHours *int32 // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. @@ -565,8 +562,8 @@ type ComputeLimits struct { // classification, properties, and optional nested configurations. A classification // refers to an application-specific configuration file. Properties are the // settings you want to change in that file. For more information, see Configuring -// Applications -// (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html). +// Applications (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html) +// . type Configuration struct { // The classification within a configuration. @@ -673,9 +670,9 @@ type Ec2InstanceAttributes struct { // master node as a user named "hadoop". Ec2KeyName *string - // Set this parameter to the identifier of the Amazon VPC subnet where you want the - // cluster to launch. If you do not specify this value, and your account supports - // EC2-Classic, the cluster launches in EC2-Classic. + // Set this parameter to the identifier of the Amazon VPC subnet where you want + // the cluster to launch. If you do not specify this value, and your account + // supports EC2-Classic, the cluster launches in EC2-Classic. Ec2SubnetId *string // The identifier of the Amazon EC2 security group for the master node. @@ -684,15 +681,15 @@ type Ec2InstanceAttributes struct { // The identifier of the Amazon EC2 security group for the core and task nodes. EmrManagedSlaveSecurityGroup *string - // The IAM role that was specified when the cluster was launched. The EC2 instances - // of the cluster assume this role. + // The IAM role that was specified when the cluster was launched. The EC2 + // instances of the cluster assume this role. IamInstanceProfile *string - // Applies to clusters configured with the instance fleets option. Specifies one or - // more Availability Zones in which to launch EC2 cluster instances when the + // Applies to clusters configured with the instance fleets option. Specifies one + // or more Availability Zones in which to launch EC2 cluster instances when the // EC2-Classic network configuration is supported. Amazon EMR chooses the // Availability Zone with the best fit from among the list of - // RequestedEc2AvailabilityZones, and then launches all cluster instances within + // RequestedEc2AvailabilityZones , and then launches all cluster instances within // that Availability Zone. If you do not specify this value, Amazon EMR chooses the // Availability Zone for you. RequestedEc2SubnetIDs and // RequestedEc2AvailabilityZones cannot be specified together. @@ -701,7 +698,7 @@ type Ec2InstanceAttributes struct { // Applies to clusters configured with the instance fleets option. Specifies the // unique identifier of one or more Amazon EC2 subnets in which to launch EC2 // cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses - // the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, + // the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds , // and then launches all cluster instances within that Subnet. If this value is not // specified, and the account and Region support EC2-Classic networks, the cluster // launches instances in the EC2-Classic network and uses @@ -725,8 +722,8 @@ type ErrorDetail struct { // The name or code that's associated with the error. ErrorCode *string - // A list of key value pairs that provide contextual information to explain why the - // error may have occured. + // A list of key value pairs that provide contextual information to explain why + // the error may have occured. ErrorData []map[string]string // A message describing the error that occured. @@ -747,8 +744,7 @@ type ExecutionEngineConfig struct { // An optional unique ID of an EC2 security group to associate with the master // instance of the EMR cluster for this notebook execution. For more information - // see Specifying EC2 Security Groups for EMR Notebooks - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) + // see Specifying EC2 Security Groups for EMR Notebooks (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) // in the EMR Management Guide. MasterInstanceSecurityGroupId *string @@ -793,8 +789,8 @@ type HadoopJarStepConfig struct { // executed. Args []string - // The name of the main class in the specified Java file. If not specified, the JAR - // file should specify a Main-Class in its manifest file. + // The name of the main class in the specified Java file. If not specified, the + // JAR file should specify a Main-Class in its manifest file. MainClass *string // A list of Java properties that are set when the step runs. You can use these @@ -816,8 +812,8 @@ type HadoopStepConfig struct { // The path to the JAR file that runs during the step. Jar *string - // The name of the main class in the specified Java file. If not specified, the JAR - // file should specify a main class in its manifest file. + // The name of the main class in the specified Java file. If not specified, the + // JAR file should specify a main class in its manifest file. MainClass *string // The list of Java properties that are set when the step runs. You can use these @@ -845,10 +841,10 @@ type Instance struct { // The identifier of the instance group to which this instance belongs. InstanceGroupId *string - // The EC2 instance type, for example m3.xlarge. + // The EC2 instance type, for example m3.xlarge . InstanceType *string - // The instance purchasing option. Valid values are ON_DEMAND or SPOT. + // The instance purchasing option. Valid values are ON_DEMAND or SPOT . Market MarketType // The private DNS name of the instance. @@ -895,13 +891,13 @@ type InstanceFleet struct { Name *string // The number of On-Demand units that have been provisioned for the instance fleet - // to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than - // or greater than TargetOnDemandCapacity. + // to fulfill TargetOnDemandCapacity . This provisioned capacity might be less than + // or greater than TargetOnDemandCapacity . ProvisionedOnDemandCapacity *int32 // The number of Spot units that have been provisioned for this instance fleet to - // fulfill TargetSpotCapacity. This provisioned capacity might be less than or - // greater than TargetSpotCapacity. + // fulfill TargetSpotCapacity . This provisioned capacity might be less than or + // greater than TargetSpotCapacity . ProvisionedSpotCapacity *int32 // The resize specification for the instance fleet. @@ -913,8 +909,8 @@ type InstanceFleet struct { // The target capacity of On-Demand units for the instance fleet, which determines // how many On-Demand Instances to provision. When the instance fleet launches, // Amazon EMR tries to provision On-Demand Instances as specified by - // InstanceTypeConfig. Each instance configuration has a specified - // WeightedCapacity. When an On-Demand Instance is provisioned, the + // InstanceTypeConfig . Each instance configuration has a specified + // WeightedCapacity . When an On-Demand Instance is provisioned, the // WeightedCapacity units count toward the target capacity. Amazon EMR provisions // instances until the target capacity is totally fulfilled, even if this results // in an overage. For example, if there are 2 units remaining to fulfill capacity, @@ -923,7 +919,7 @@ type InstanceFleet struct { // units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the // Spot capacity units that have been provisioned for the instance fleet. If not // specified or set to 0, only Spot Instances are provisioned for the instance - // fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and + // fleet using TargetSpotCapacity . At least one of TargetSpotCapacity and // TargetOnDemandCapacity should be greater than 0. For a master instance fleet, // only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and // its value must be 1. @@ -931,12 +927,12 @@ type InstanceFleet struct { // The target capacity of Spot units for the instance fleet, which determines how // many Spot Instances to provision. When the instance fleet launches, Amazon EMR - // tries to provision Spot Instances as specified by InstanceTypeConfig. Each - // instance configuration has a specified WeightedCapacity. When a Spot instance is - // provisioned, the WeightedCapacity units count toward the target capacity. Amazon - // EMR provisions instances until the target capacity is totally fulfilled, even if - // this results in an overage. For example, if there are 2 units remaining to - // fulfill capacity, and Amazon EMR can only provision an instance with a + // tries to provision Spot Instances as specified by InstanceTypeConfig . Each + // instance configuration has a specified WeightedCapacity . When a Spot instance + // is provisioned, the WeightedCapacity units count toward the target capacity. + // Amazon EMR provisions instances until the target capacity is totally fulfilled, + // even if this results in an overage. For example, if there are 2 units remaining + // to fulfill capacity, and Amazon EMR can only provision an instance with a // WeightedCapacity of 5 units, the instance is provisioned, and the target // capacity is exceeded by 3 units. You can use // InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that @@ -977,28 +973,28 @@ type InstanceFleetConfig struct { // The target capacity of On-Demand units for the instance fleet, which determines // how many On-Demand Instances to provision. When the instance fleet launches, // Amazon EMR tries to provision On-Demand Instances as specified by - // InstanceTypeConfig. Each instance configuration has a specified - // WeightedCapacity. When an On-Demand Instance is provisioned, the + // InstanceTypeConfig . Each instance configuration has a specified + // WeightedCapacity . When an On-Demand Instance is provisioned, the // WeightedCapacity units count toward the target capacity. Amazon EMR provisions // instances until the target capacity is totally fulfilled, even if this results // in an overage. For example, if there are 2 units remaining to fulfill capacity, // and Amazon EMR can only provision an instance with a WeightedCapacity of 5 // units, the instance is provisioned, and the target capacity is exceeded by 3 // units. If not specified or set to 0, only Spot Instances are provisioned for the - // instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and - // TargetOnDemandCapacity should be greater than 0. For a master instance fleet, - // only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and - // its value must be 1. + // instance fleet using TargetSpotCapacity . At least one of TargetSpotCapacity + // and TargetOnDemandCapacity should be greater than 0. For a master instance + // fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be + // specified, and its value must be 1. TargetOnDemandCapacity *int32 // The target capacity of Spot units for the instance fleet, which determines how // many Spot Instances to provision. When the instance fleet launches, Amazon EMR - // tries to provision Spot Instances as specified by InstanceTypeConfig. Each - // instance configuration has a specified WeightedCapacity. When a Spot Instance is - // provisioned, the WeightedCapacity units count toward the target capacity. Amazon - // EMR provisions instances until the target capacity is totally fulfilled, even if - // this results in an overage. For example, if there are 2 units remaining to - // fulfill capacity, and Amazon EMR can only provision an instance with a + // tries to provision Spot Instances as specified by InstanceTypeConfig . Each + // instance configuration has a specified WeightedCapacity . When a Spot Instance + // is provisioned, the WeightedCapacity units count toward the target capacity. + // Amazon EMR provisions instances until the target capacity is totally fulfilled, + // even if this results in an overage. For example, if there are 2 units remaining + // to fulfill capacity, and Amazon EMR can only provision an instance with a // WeightedCapacity of 5 units, the instance is provisioned, and the target // capacity is exceeded by 3 units. If not specified or set to 0, only On-Demand // Instances are provisioned for the instance fleet. At least one of @@ -1024,11 +1020,11 @@ type InstanceFleetModifyConfig struct { ResizeSpecifications *InstanceFleetResizingSpecifications // The target capacity of On-Demand units for the instance fleet. For more - // information see InstanceFleetConfig$TargetOnDemandCapacity. + // information see InstanceFleetConfig$TargetOnDemandCapacity . TargetOnDemandCapacity *int32 // The target capacity of Spot units for the instance fleet. For more information, - // see InstanceFleetConfig$TargetSpotCapacity. + // see InstanceFleetConfig$TargetSpotCapacity . TargetSpotCapacity *int32 noSmithyDocumentSerde @@ -1069,8 +1065,8 @@ type InstanceFleetResizingSpecifications struct { noSmithyDocumentSerde } -// Provides status change reason details for the instance fleet. The instance fleet -// configuration is available only in Amazon EMR versions 4.8.0 and later, +// Provides status change reason details for the instance fleet. The instance +// fleet configuration is available only in Amazon EMR versions 4.8.0 and later, // excluding 5.0.x versions. type InstanceFleetStateChangeReason struct { @@ -1088,30 +1084,19 @@ type InstanceFleetStateChangeReason struct { type InstanceFleetStatus struct { // A code representing the instance fleet status. - // - // * PROVISIONING—The instance - // fleet is provisioning EC2 resources and is not yet ready to run jobs. - // - // * - // BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the - // bootstrap actions specified for the instances are underway. - // - // * RUNNING—EC2 - // instances and other resources are running. They are either executing jobs or - // waiting to execute jobs. - // - // * RESIZING—A resize operation is underway. EC2 - // instances are either being added or removed. - // - // * SUSPENDED—A resize operation - // could not complete. Existing EC2 instances are running, but instances can't be - // added or removed. - // - // * TERMINATING—The instance fleet is terminating EC2 - // instances. - // - // * TERMINATED—The instance fleet is no longer active, and all EC2 - // instances have been terminated. + // - PROVISIONING —The instance fleet is provisioning EC2 resources and is not + // yet ready to run jobs. + // - BOOTSTRAPPING —EC2 instances and other resources have been provisioned and + // the bootstrap actions specified for the instances are underway. + // - RUNNING —EC2 instances and other resources are running. They are either + // executing jobs or waiting to execute jobs. + // - RESIZING —A resize operation is underway. EC2 instances are either being + // added or removed. + // - SUSPENDED —A resize operation could not complete. Existing EC2 instances are + // running, but instances can't be added or removed. + // - TERMINATING —The instance fleet is terminating EC2 instances. + // - TERMINATED —The instance fleet is no longer active, and all EC2 instances + // have been terminated. State InstanceFleetState // Provides status change reason details for the instance fleet. @@ -1152,9 +1137,10 @@ type InstanceGroup struct { // a CloudWatch metric. See PutAutoScalingPolicy. AutoScalingPolicy *AutoScalingPolicyDescription - // If specified, indicates that the instance group uses Spot Instances. This is the - // maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice - // to set the amount equal to the On-Demand price, or specify an amount in USD. + // If specified, indicates that the instance group uses Spot Instances. This is + // the maximum price you are willing to pay for Spot Instances. Specify + // OnDemandPrice to set the amount equal to the On-Demand price, or specify an + // amount in USD. BidPrice *string // Amazon EMR releases 4.x or later. The list of configurations supplied for an @@ -1172,8 +1158,8 @@ type InstanceGroup struct { // The EBS block devices that are mapped to this instance group. EbsBlockDevices []EbsBlockDevice - // If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an - // optimized configuration stack and provides additional, dedicated capacity for + // If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses + // an optimized configuration stack and provides additional, dedicated capacity for // Amazon EBS I/O. EbsOptimized *bool @@ -1237,16 +1223,17 @@ type InstanceGroupConfig struct { // An automatic scaling policy for a core instance group or task instance group in // an Amazon EMR cluster. The automatic scaling policy defines how an instance // group dynamically adds and terminates EC2 instances in response to the value of - // a CloudWatch metric. See PutAutoScalingPolicy. + // a CloudWatch metric. See PutAutoScalingPolicy . AutoScalingPolicy *AutoScalingPolicy - // If specified, indicates that the instance group uses Spot Instances. This is the - // maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice - // to set the amount equal to the On-Demand price, or specify an amount in USD. + // If specified, indicates that the instance group uses Spot Instances. This is + // the maximum price you are willing to pay for Spot Instances. Specify + // OnDemandPrice to set the amount equal to the On-Demand price, or specify an + // amount in USD. BidPrice *string - // Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR - // cluster instance group. You can specify a separate configuration for each + // Amazon EMR releases 4.x or later. The list of configurations supplied for an + // EMR cluster instance group. You can specify a separate configuration for each // instance group (master, core, and task). Configurations []Configuration @@ -1299,15 +1286,16 @@ type InstanceGroupDetail struct { // This member is required. Market MarketType - // State of instance group. The following values are no longer supported: STARTING, - // TERMINATED, and FAILED. + // State of instance group. The following values are no longer supported: + // STARTING, TERMINATED, and FAILED. // // This member is required. State InstanceGroupState - // If specified, indicates that the instance group uses Spot Instances. This is the - // maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice - // to set the amount equal to the On-Demand price, or specify an amount in USD. + // If specified, indicates that the instance group uses Spot Instances. This is + // the maximum price you are willing to pay for Spot Instances. Specify + // OnDemandPrice to set the amount equal to the On-Demand price, or specify an + // amount in USD. BidPrice *string // The custom AMI ID to use for the provisioned instance group. @@ -1467,85 +1455,85 @@ type InstanceTimeline struct { // On-Demand and Spot target capacities. When you use an allocation strategy, you // can include a maximum of 30 instance type configurations for a fleet. For more // information about how to use an allocation strategy, see Configure Instance -// Fleets -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html). -// Without an allocation strategy, you may specify a maximum of five instance type -// configurations for a fleet. The instance fleet configuration is available only -// in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. +// Fleets (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html) +// . Without an allocation strategy, you may specify a maximum of five instance +// type configurations for a fleet. The instance fleet configuration is available +// only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. type InstanceTypeConfig struct { - // An EC2 instance type, such as m3.xlarge. + // An EC2 instance type, such as m3.xlarge . // // This member is required. InstanceType *string - // The bid price for each EC2 Spot Instance type as defined by InstanceType. - // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is - // provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. + // The bid price for each EC2 Spot Instance type as defined by InstanceType . + // Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice + // is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPrice *string - // The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as - // defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). - // If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, + // The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance + // as defined by InstanceType . Expressed as a number (for example, 20 specifies + // 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, // BidPriceAsPercentageOfOnDemandPrice defaults to 100%. BidPriceAsPercentageOfOnDemandPrice *float64 - // A configuration classification that applies when provisioning cluster instances, - // which can include configurations for applications and software that run on the - // cluster. + // A configuration classification that applies when provisioning cluster + // instances, which can include configurations for applications and software that + // run on the cluster. Configurations []Configuration // The custom AMI ID to use for the instance type. CustomAmiId *string // The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each - // instance as defined by InstanceType. + // instance as defined by InstanceType . EbsConfiguration *EbsConfiguration // The number of units that a provisioned instance of this type provides toward - // fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 - // for a master instance fleet, and must be 1 or greater for core and task instance - // fleets. Defaults to 1 if not specified. + // fulfilling the target capacities defined in InstanceFleetConfig . This value is + // 1 for a master instance fleet, and must be 1 or greater for core and task + // instance fleets. Defaults to 1 if not specified. WeightedCapacity *int32 noSmithyDocumentSerde } -// The configuration specification for each instance type in an instance fleet. The -// instance fleet configuration is available only in Amazon EMR versions 4.8.0 and -// later, excluding 5.0.x versions. +// The configuration specification for each instance type in an instance fleet. +// The instance fleet configuration is available only in Amazon EMR versions 4.8.0 +// and later, excluding 5.0.x versions. type InstanceTypeSpecification struct { - // The bid price for each EC2 Spot Instance type as defined by InstanceType. + // The bid price for each EC2 Spot Instance type as defined by InstanceType . // Expressed in USD. BidPrice *string - // The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as - // defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). + // The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance + // as defined by InstanceType . Expressed as a number (for example, 20 specifies + // 20%). BidPriceAsPercentageOfOnDemandPrice *float64 - // A configuration classification that applies when provisioning cluster instances, - // which can include configurations for applications and software bundled with - // Amazon EMR. + // A configuration classification that applies when provisioning cluster + // instances, which can include configurations for applications and software + // bundled with Amazon EMR. Configurations []Configuration // The custom AMI ID to use for the instance type. CustomAmiId *string // The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each - // instance as defined by InstanceType. + // instance as defined by InstanceType . EbsBlockDevices []EbsBlockDevice // Evaluates to TRUE when the specified InstanceType is EBS-optimized. EbsOptimized *bool - // The EC2 instance type, for example m3.xlarge. + // The EC2 instance type, for example m3.xlarge . InstanceType *string // The number of units that a provisioned instance of this type provides toward - // fulfilling the target capacities defined in InstanceFleetConfig. Capacity values - // represent performance characteristics such as vCPUs, memory, or I/O. If not - // specified, the default value is 1. + // fulfilling the target capacities defined in InstanceFleetConfig . Capacity + // values represent performance characteristics such as vCPUs, memory, or I/O. If + // not specified, the default value is 1. WeightedCapacity *int32 noSmithyDocumentSerde @@ -1574,12 +1562,12 @@ type JobFlowDetail struct { // This member is required. Name *string - // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 - // and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID. + // Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases + // 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID . AmiVersion *string // An IAM role for automatic scaling policies. The default role is - // EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic + // EMR_AutoScaling_DefaultRole . The IAM role provides a way for the automatic // scaling feature to get the required permissions it needs to launch and terminate // EC2 instances in an instance group. AutoScalingRole *string @@ -1591,8 +1579,8 @@ type JobFlowDetail struct { // instances of the job flow assume this role. JobFlowRole *string - // The KMS key used for encrypting log files. This attribute is only available with - // EMR version 5.30.0 and later, excluding EMR 6.0.0. + // The KMS key used for encrypting log files. This attribute is only available + // with EMR version 5.30.0 and later, excluding EMR 6.0.0. LogEncryptionKmsKeyId *string // The location in Amazon S3 where log files for the job are stored. @@ -1626,14 +1614,13 @@ type JobFlowDetail struct { SupportedProducts []string // Indicates whether the cluster is visible to IAM principals in the Amazon Web - // Services account associated with the cluster. When true, IAM principals in the + // Services account associated with the cluster. When true , IAM principals in the // Amazon Web Services account can perform EMR cluster actions that their IAM - // policies allow. When false, only the IAM principal that created the cluster and + // policies allow. When false , only the IAM principal that created the cluster and // the Amazon Web Services account root user can perform EMR actions, regardless of // IAM permissions policies attached to other IAM principals. The default value is // true if a value is not provided when creating a cluster using the EMR API - // RunJobFlow command, the CLI create-cluster - // (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) + // RunJobFlow command, the CLI create-cluster (https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html) // command, or the Amazon Web Services Management Console. VisibleToAllUsers bool @@ -1669,8 +1656,8 @@ type JobFlowExecutionStatusDetail struct { noSmithyDocumentSerde } -// A description of the Amazon EC2 instance on which the cluster (job flow) runs. A -// valid JobFlowInstancesConfig must contain either InstanceGroups or +// A description of the Amazon EC2 instance on which the cluster (job flow) runs. +// A valid JobFlowInstancesConfig must contain either InstanceGroups or // InstanceFleets. They cannot be used together. You may also have // MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be // present), but we don't recommend this configuration. @@ -1686,32 +1673,32 @@ type JobFlowInstancesConfig struct { // using SSH as the user called "hadoop." Ec2KeyName *string - // Applies to clusters that use the uniform instance group configuration. To launch - // the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to - // the identifier of the Amazon VPC subnet where you want the cluster to launch. If - // you do not specify this value and your account supports EC2-Classic, the cluster - // launches in EC2-Classic. + // Applies to clusters that use the uniform instance group configuration. To + // launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this + // parameter to the identifier of the Amazon VPC subnet where you want the cluster + // to launch. If you do not specify this value and your account supports + // EC2-Classic, the cluster launches in EC2-Classic. Ec2SubnetId *string - // Applies to clusters that use the instance fleet configuration. When multiple EC2 - // subnet IDs are specified, Amazon EMR evaluates them and launches instances in - // the optimal subnet. The instance fleet configuration is available only in Amazon - // EMR versions 4.8.0 and later, excluding 5.0.x versions. + // Applies to clusters that use the instance fleet configuration. When multiple + // EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances + // in the optimal subnet. The instance fleet configuration is available only in + // Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Ec2SubnetIds []string // The identifier of the Amazon EC2 security group for the master node. If you - // specify EmrManagedMasterSecurityGroup, you must also specify - // EmrManagedSlaveSecurityGroup. + // specify EmrManagedMasterSecurityGroup , you must also specify + // EmrManagedSlaveSecurityGroup . EmrManagedMasterSecurityGroup *string // The identifier of the Amazon EC2 security group for the core and task nodes. If - // you specify EmrManagedSlaveSecurityGroup, you must also specify - // EmrManagedMasterSecurityGroup. + // you specify EmrManagedSlaveSecurityGroup , you must also specify + // EmrManagedMasterSecurityGroup . EmrManagedSlaveSecurityGroup *string - // Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version - // for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no - // longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or + // Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop + // version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" + // (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or // "2.4.0". If you do not set this value, the default of 0.18 is used, unless the // AmiVersion parameter is set in the RunJobFlow call, in which case the default // version of Hadoop for that AMI version is used. @@ -1729,9 +1716,8 @@ type JobFlowInstancesConfig struct { InstanceGroups []InstanceGroupConfig // Specifies whether the cluster should remain available after completing all - // steps. Defaults to true. For more information about configuring cluster - // termination, see Control Cluster Termination - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html) + // steps. Defaults to true . For more information about configuring cluster + // termination, see Control Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html) // in the EMR Management Guide. KeepJobFlowAliveWhenNoSteps bool @@ -1802,8 +1788,8 @@ type JobFlowInstancesDetail struct { // the private DNS name. On a public subnet, this is the public DNS name. MasterPublicDnsName *string - // An approximation of the cost of the cluster, represented in m1.small/hours. This - // value is increased one time for every hour that an m1.small instance runs. + // An approximation of the cost of the cluster, represented in m1.small/hours. + // This value is increased one time for every hour that an m1.small instance runs. // Larger instances are weighted more heavily, so an Amazon EC2 instance that is // roughly four times more expensive would result in the normalized instance hours // being increased incrementally four times. This result is only an approximation @@ -1823,9 +1809,8 @@ type JobFlowInstancesDetail struct { // Attributes for Kerberos configuration when Kerberos authentication is enabled // using a security configuration. For more information see Use Kerberos -// Authentication -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) in -// the Amazon EMR Management Guide. +// Authentication (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html) +// in the Amazon EMR Management Guide. type KerberosAttributes struct { // The password used within the cluster for the kadmin service on the @@ -1836,12 +1821,12 @@ type KerberosAttributes struct { KdcAdminPassword *string // The name of the Kerberos realm to which all nodes in a cluster belong. For - // example, EC2.INTERNAL. + // example, EC2.INTERNAL . // // This member is required. Realm *string - // The Active Directory password for ADDomainJoinUser. + // The Active Directory password for ADDomainJoinUser . ADDomainJoinPassword *string // Required only when establishing a cross-realm trust with an Active Directory @@ -1886,8 +1871,8 @@ type ManagedScalingPolicy struct { // A CloudWatch dimension, which is specified using a Key (known as a Name in // CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is // JobFlowID and Value is a variable representing the cluster ID, which is -// ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes -// available. +// ${emr.clusterId} . This enables the rule to bootstrap when the cluster ID +// becomes available. type MetricDimension struct { // The dimension name. @@ -1926,10 +1911,9 @@ type NotebookExecution struct { // A name for the notebook execution. NotebookExecutionName *string - // The unique identifier of the EC2 security group associated with the EMR Notebook - // instance. For more information see Specifying EC2 Security Groups for EMR - // Notebooks - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) + // The unique identifier of the EC2 security group associated with the EMR + // Notebook instance. For more information see Specifying EC2 Security Groups for + // EMR Notebooks (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) // in the EMR Management Guide. NotebookInstanceSecurityGroupId *string @@ -1944,37 +1928,21 @@ type NotebookExecution struct { StartTime *time.Time // The status of the notebook execution. - // - // * START_PENDING indicates that the - // cluster has received the execution request but execution has not begun. - // - // * - // STARTING indicates that the execution is starting on the cluster. - // - // * RUNNING - // indicates that the execution is being processed by the cluster. - // - // * FINISHING - // indicates that execution processing is in the final stages. - // - // * FINISHED - // indicates that the execution has completed without error. - // - // * FAILING indicates - // that the execution is failing and will not finish successfully. - // - // * FAILED - // indicates that the execution failed. - // - // * STOP_PENDING indicates that the cluster - // has received a StopNotebookExecution request and the stop is pending. - // - // * - // STOPPING indicates that the cluster is in the process of stopping the execution - // as a result of a StopNotebookExecution request. - // - // * STOPPED indicates that the - // execution stopped because of a StopNotebookExecution request. + // - START_PENDING indicates that the cluster has received the execution request + // but execution has not begun. + // - STARTING indicates that the execution is starting on the cluster. + // - RUNNING indicates that the execution is being processed by the cluster. + // - FINISHING indicates that execution processing is in the final stages. + // - FINISHED indicates that the execution has completed without error. + // - FAILING indicates that the execution is failing and will not finish + // successfully. + // - FAILED indicates that the execution failed. + // - STOP_PENDING indicates that the cluster has received a StopNotebookExecution + // request and the stop is pending. + // - STOPPING indicates that the cluster is in the process of stopping the + // execution as a result of a StopNotebookExecution request. + // - STOPPED indicates that the execution stopped because of a + // StopNotebookExecution request. Status NotebookExecutionStatus // A list of tags associated with a notebook execution. Tags are user-defined @@ -2005,37 +1973,21 @@ type NotebookExecutionSummary struct { StartTime *time.Time // The status of the notebook execution. - // - // * START_PENDING indicates that the - // cluster has received the execution request but execution has not begun. - // - // * - // STARTING indicates that the execution is starting on the cluster. - // - // * RUNNING - // indicates that the execution is being processed by the cluster. - // - // * FINISHING - // indicates that execution processing is in the final stages. - // - // * FINISHED - // indicates that the execution has completed without error. - // - // * FAILING indicates - // that the execution is failing and will not finish successfully. - // - // * FAILED - // indicates that the execution failed. - // - // * STOP_PENDING indicates that the cluster - // has received a StopNotebookExecution request and the stop is pending. - // - // * - // STOPPING indicates that the cluster is in the process of stopping the execution - // as a result of a StopNotebookExecution request. - // - // * STOPPED indicates that the - // execution stopped because of a StopNotebookExecution request. + // - START_PENDING indicates that the cluster has received the execution request + // but execution has not begun. + // - STARTING indicates that the execution is starting on the cluster. + // - RUNNING indicates that the execution is being processed by the cluster. + // - FINISHING indicates that execution processing is in the final stages. + // - FINISHED indicates that the execution has completed without error. + // - FAILING indicates that the execution is failing and will not finish + // successfully. + // - FAILED indicates that the execution failed. + // - STOP_PENDING indicates that the cluster has received a StopNotebookExecution + // request and the stop is pending. + // - STOPPING indicates that the cluster is in the process of stopping the + // execution as a result of a StopNotebookExecution request. + // - STOPPED indicates that the execution stopped because of a + // StopNotebookExecution request. Status NotebookExecutionStatus noSmithyDocumentSerde @@ -2047,27 +1999,25 @@ type OnDemandCapacityReservationOptions struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences // include: - // - // * open - The instance can run in any open Capacity Reservation that - // has matching attributes (instance type, platform, Availability Zone). - // - // * none - - // The instance avoids running in a Capacity Reservation even if one is available. - // The instance runs as an On-Demand Instance. + // - open - The instance can run in any open Capacity Reservation that has + // matching attributes (instance type, platform, Availability Zone). + // - none - The instance avoids running in a Capacity Reservation even if one is + // available. The instance runs as an On-Demand Instance. CapacityReservationPreference OnDemandCapacityReservationPreference // The ARN of the Capacity Reservation resource group in which to run the instance. CapacityReservationResourceGroupArn *string // Indicates whether to use unused Capacity Reservations for fulfilling On-Demand - // capacity. If you specify use-capacity-reservations-first, the fleet uses unused + // capacity. If you specify use-capacity-reservations-first , the fleet uses unused // Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand // capacity. If multiple instance pools have unused Capacity Reservations, the - // On-Demand allocation strategy (lowest-price) is applied. If the number of unused - // Capacity Reservations is less than the On-Demand target capacity, the remaining - // On-Demand target capacity is launched according to the On-Demand allocation - // strategy (lowest-price). If you do not specify a value, the fleet fulfills the - // On-Demand capacity according to the chosen On-Demand allocation strategy. + // On-Demand allocation strategy ( lowest-price ) is applied. If the number of + // unused Capacity Reservations is less than the On-Demand target capacity, the + // remaining On-Demand target capacity is launched according to the On-Demand + // allocation strategy ( lowest-price ). If you do not specify a value, the fleet + // fulfills the On-Demand capacity according to the chosen On-Demand allocation + // strategy. UsageStrategy OnDemandCapacityReservationUsageStrategy noSmithyDocumentSerde @@ -2080,9 +2030,9 @@ type OnDemandCapacityReservationOptions struct { // 5.12.1 and later. type OnDemandProvisioningSpecification struct { - // Specifies the strategy to use in launching On-Demand instance fleets. Currently, - // the only option is lowest-price (the default), which launches the lowest price - // first. + // Specifies the strategy to use in launching On-Demand instance fleets. + // Currently, the only option is lowest-price (the default), which launches the + // lowest price first. // // This member is required. AllocationStrategy OnDemandProvisioningAllocationStrategy @@ -2116,9 +2066,8 @@ type OnDemandResizingSpecification struct { type OSRelease struct { // The Amazon Linux release specified for a cluster in the RunJobFlow request. The - // format is as shown in Amazon Linux 2 Release Notes - // (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html). For - // example, 2.0.20220218.1. + // format is as shown in Amazon Linux 2 Release Notes (https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html) + // . For example, 2.0.20220218.1. Label *string noSmithyDocumentSerde @@ -2131,14 +2080,14 @@ type OSRelease struct { type PlacementGroupConfig struct { // Role of the instance in the cluster. Starting with Amazon EMR version 5.23.0, - // the only supported instance role is MASTER. + // the only supported instance role is MASTER . // // This member is required. InstanceRole InstanceRoleType - // EC2 Placement Group strategy associated with instance role. Starting with Amazon - // EMR version 5.23.0, the only supported placement strategy is SPREAD for the - // MASTER instance role. + // EC2 Placement Group strategy associated with instance role. Starting with + // Amazon EMR version 5.23.0, the only supported placement strategy is SPREAD for + // the MASTER instance role. PlacementStrategy PlacementGroupStrategy noSmithyDocumentSerde @@ -2164,7 +2113,7 @@ type PlacementType struct { // A list of port ranges that are permitted to allow inbound traffic from all // public IP addresses. To specify a single port, use the same value for MinRange -// and MaxRange. +// and MaxRange . type PortRange struct { // The smallest port number in a specified range of port numbers. @@ -2181,10 +2130,10 @@ type PortRange struct { // The release label filters by application or version prefix. type ReleaseLabelFilter struct { - // Optional release label application filter. For example, spark@2.1.0. + // Optional release label application filter. For example, spark@2.1.0 . Application *string - // Optional release label version prefix filter. For example, emr-5. + // Optional release label version prefix filter. For example, emr-5 . Prefix *string noSmithyDocumentSerde @@ -2200,8 +2149,8 @@ type ScalingAction struct { // This member is required. SimpleScalingPolicyConfiguration *SimpleScalingPolicyConfiguration - // Not available for instance groups. Instance groups use the market type specified - // for the group. + // Not available for instance groups. Instance groups use the market type + // specified for the group. Market MarketType noSmithyDocumentSerde @@ -2306,10 +2255,8 @@ type SessionMappingDetail struct { // The globally unique identifier (GUID) of the user or group. IdentityId *string - // The name of the user or group. For more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // The name of the user or group. For more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Identity Store API Reference. IdentityName *string @@ -2320,8 +2267,8 @@ type SessionMappingDetail struct { // The time the session mapping was last modified. LastModifiedTime *time.Time - // The Amazon Resource Name (ARN) of the session policy associated with the user or - // group. + // The Amazon Resource Name (ARN) of the session policy associated with the user + // or group. SessionPolicyArn *string // The ID of the Amazon EMR Studio. @@ -2330,21 +2277,19 @@ type SessionMappingDetail struct { noSmithyDocumentSerde } -// Details for an Amazon EMR Studio session mapping. The details do not include the -// time the session mapping was last modified. +// Details for an Amazon EMR Studio session mapping. The details do not include +// the time the session mapping was last modified. type SessionMappingSummary struct { // The time the session mapping was created. CreationTime *time.Time - // The globally unique identifier (GUID) of the user or group from the IAM Identity - // Center Identity Store. + // The globally unique identifier (GUID) of the user or group from the IAM + // Identity Center Identity Store. IdentityId *string - // The name of the user or group. For more information, see UserName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) - // and DisplayName - // (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) + // The name of the user or group. For more information, see UserName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) + // and DisplayName (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) // in the IAM Identity Center Identity Store API Reference. IdentityName *string @@ -2352,8 +2297,8 @@ type SessionMappingSummary struct { // group. IdentityType IdentityType - // The Amazon Resource Name (ARN) of the session policy associated with the user or - // group. + // The Amazon Resource Name (ARN) of the session policy associated with the user + // or group. SessionPolicyArn *string // The ID of the Amazon EMR Studio. @@ -2383,12 +2328,12 @@ type ShrinkPolicy struct { type SimpleScalingPolicyConfiguration struct { // The amount by which to scale in or scale out, based on the specified - // AdjustmentType. A positive value adds to the instance group's EC2 instance count - // while a negative number removes instances. If AdjustmentType is set to - // EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType - // is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as - // an integer. For example, -20 indicates a decrease in 20% increments of cluster - // capacity. + // AdjustmentType . A positive value adds to the instance group's EC2 instance + // count while a negative number removes instances. If AdjustmentType is set to + // EXACT_CAPACITY , the number should only be a positive integer. If AdjustmentType + // is set to PERCENT_CHANGE_IN_CAPACITY , the value should express the percentage + // as an integer. For example, -20 indicates a decrease in 20% increments of + // cluster capacity. // // This member is required. ScalingAdjustment *int32 @@ -2397,12 +2342,12 @@ type SimpleScalingPolicyConfiguration struct { // number) or terminated (if ScalingAdjustment is a negative number) each time the // scaling activity is triggered. CHANGE_IN_CAPACITY is the default. // CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or - // decrements by ScalingAdjustment, which should be expressed as an integer. + // decrements by ScalingAdjustment , which should be expressed as an integer. // PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements - // by the percentage specified by ScalingAdjustment, which should be expressed as + // by the percentage specified by ScalingAdjustment , which should be expressed as // an integer. For example, 20 indicates an increase in 20% increments of cluster // capacity. EXACT_CAPACITY indicates the scaling activity results in an instance - // group with the number of EC2 instances specified by ScalingAdjustment, which + // group with the number of EC2 instances specified by ScalingAdjustment , which // should be expressed as a positive integer. AdjustmentType AdjustmentType @@ -2416,10 +2361,10 @@ type SimpleScalingPolicyConfiguration struct { // The returned release label application names or versions. type SimplifiedApplication struct { - // The returned release label application name. For example, hadoop. + // The returned release label application name. For example, hadoop . Name *string - // The returned release label application version. For example, 3.2.1. + // The returned release label application version. For example, 3.2.1 . Version *string noSmithyDocumentSerde @@ -2439,8 +2384,8 @@ type SpotProvisioningSpecification struct { // The action to take when TargetSpotCapacity has not been fulfilled when the // TimeoutDurationMinutes has expired; that is, when all Spot Instances could not // be provisioned within the Spot provisioning timeout. Valid values are - // TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if - // no Spot Instances are available, On-Demand Instances should be provisioned to + // TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND . SWITCH_TO_ON_DEMAND specifies that + // if no Spot Instances are available, On-Demand Instances should be provisioned to // fulfill any remaining Spot capacity. // // This member is required. @@ -2498,17 +2443,17 @@ type SpotResizingSpecification struct { type Step struct { // The action to take when the cluster step fails. Possible values are - // TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided - // for backward compatibility. We recommend using TERMINATE_CLUSTER instead. If a - // cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to - // submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. - // The step is not submitted and the action fails with a message that the - // ActionOnFailure setting is not valid. If you change a cluster's - // StepConcurrencyLevel to be greater than 1 while a step is running, the - // ActionOnFailure parameter may not behave as you expect. In this case, for a step - // that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the - // running step are not canceled; for a step that fails with this parameter set to - // TERMINATE_CLUSTER, the cluster does not terminate. + // TERMINATE_CLUSTER , CANCEL_AND_WAIT , and CONTINUE . TERMINATE_JOB_FLOW is + // provided for backward compatibility. We recommend using TERMINATE_CLUSTER + // instead. If a cluster's StepConcurrencyLevel is greater than 1 , do not use + // AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or + // TERMINATE_CLUSTER . The step is not submitted and the action fails with a + // message that the ActionOnFailure setting is not valid. If you change a + // cluster's StepConcurrencyLevel to be greater than 1 while a step is running, + // the ActionOnFailure parameter may not behave as you expect. In this case, for a + // step that fails with this parameter set to CANCEL_AND_WAIT , pending steps and + // the running step are not canceled; for a step that fails with this parameter set + // to TERMINATE_CLUSTER , the cluster does not terminate. ActionOnFailure ActionOnFailure // The Hadoop job configuration of the cluster step. @@ -2517,7 +2462,7 @@ type Step struct { // The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. // The runtime role can be a cross-account IAM role. The runtime role ARN is a // combination of account ID, role name, and role type using the following format: - // arn:partition:service:region:account:resource. For example, + // arn:partition:service:region:account:resource . For example, // arn:aws:iam::1234567890:role/ReadOnly is a correctly formatted runtime role ARN. ExecutionRoleArn *string @@ -2547,29 +2492,21 @@ type StepConfig struct { Name *string // The action to take when the step fails. Use one of the following values: - // - // * - // TERMINATE_CLUSTER - Shuts down the cluster. - // - // * CANCEL_AND_WAIT - Cancels any - // pending steps and returns the cluster to the WAITING state. - // - // * CONTINUE - - // Continues to the next step in the queue. - // - // * TERMINATE_JOB_FLOW - Shuts down the - // cluster. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend - // using TERMINATE_CLUSTER instead. - // - // If a cluster's StepConcurrencyLevel is greater - // than 1, do not use AddJobFlowSteps to submit a step with this parameter set to - // CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action - // fails with a message that the ActionOnFailure setting is not valid. If you - // change a cluster's StepConcurrencyLevel to be greater than 1 while a step is - // running, the ActionOnFailure parameter may not behave as you expect. In this - // case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending - // steps and the running step are not canceled; for a step that fails with this - // parameter set to TERMINATE_CLUSTER, the cluster does not terminate. + // - TERMINATE_CLUSTER - Shuts down the cluster. + // - CANCEL_AND_WAIT - Cancels any pending steps and returns the cluster to the + // WAITING state. + // - CONTINUE - Continues to the next step in the queue. + // - TERMINATE_JOB_FLOW - Shuts down the cluster. TERMINATE_JOB_FLOW is provided + // for backward compatibility. We recommend using TERMINATE_CLUSTER instead. + // If a cluster's StepConcurrencyLevel is greater than 1 , do not use + // AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or + // TERMINATE_CLUSTER . The step is not submitted and the action fails with a + // message that the ActionOnFailure setting is not valid. If you change a + // cluster's StepConcurrencyLevel to be greater than 1 while a step is running, + // the ActionOnFailure parameter may not behave as you expect. In this case, for a + // step that fails with this parameter set to CANCEL_AND_WAIT , pending steps and + // the running step are not canceled; for a step that fails with this parameter set + // to TERMINATE_CLUSTER , the cluster does not terminate. ActionOnFailure ActionOnFailure noSmithyDocumentSerde @@ -2783,9 +2720,9 @@ type StudioSummary struct { noSmithyDocumentSerde } -// The list of supported product configurations that allow user-supplied arguments. -// EMR accepts these arguments and forwards them to the corresponding installation -// script as bootstrap action arguments. +// The list of supported product configurations that allow user-supplied +// arguments. EMR accepts these arguments and forwards them to the corresponding +// installation script as bootstrap action arguments. type SupportedProductConfig struct { // The list of user-supplied arguments. @@ -2797,21 +2734,21 @@ type SupportedProductConfig struct { noSmithyDocumentSerde } -// A key-value pair containing user-defined metadata that you can associate with an -// Amazon EMR resource. Tags make it easier to associate clusters in various ways, -// such as grouping clusters to track your Amazon EMR resource allocation costs. -// For more information, see Tag Clusters -// (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). +// A key-value pair containing user-defined metadata that you can associate with +// an Amazon EMR resource. Tags make it easier to associate clusters in various +// ways, such as grouping clusters to track your Amazon EMR resource allocation +// costs. For more information, see Tag Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html) +// . type Tag struct { // A user-defined key, which is the minimum required information for a valid tag. - // For more information, see Tag - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). + // For more information, see Tag (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html) + // . Key *string // A user-defined value, which is optional in a tag. For more information, see Tag - // Clusters - // (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). + // Clusters (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html) + // . Value *string noSmithyDocumentSerde @@ -2851,8 +2788,8 @@ type VolumeSpecification struct { // The number of I/O operations per second (IOPS) that the volume supports. Iops *int32 - // The throughput, in mebibyte per second (MiB/s). This optional parameter can be a - // number from 125 - 1000 and is valid only for gp3 volumes. + // The throughput, in mebibyte per second (MiB/s). This optional parameter can be + // a number from 125 - 1000 and is valid only for gp3 volumes. Throughput *int32 noSmithyDocumentSerde diff --git a/service/emrcontainers/api_client.go b/service/emrcontainers/api_client.go index 9e4f8f42fbf..613e777238e 100644 --- a/service/emrcontainers/api_client.go +++ b/service/emrcontainers/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/emrcontainers/api_op_CreateJobTemplate.go b/service/emrcontainers/api_op_CreateJobTemplate.go index 0ecf54b1988..8d5b36ce7d1 100644 --- a/service/emrcontainers/api_op_CreateJobTemplate.go +++ b/service/emrcontainers/api_op_CreateJobTemplate.go @@ -13,8 +13,8 @@ import ( "time" ) -// Creates a job template. Job template stores values of StartJobRun API request in -// a template and can be used to start a job run. Job template allows two use +// Creates a job template. Job template stores values of StartJobRun API request +// in a template and can be used to start a job run. Job template allows two use // cases: avoid repeating recurring StartJobRun API request values, enforcing // certain values in StartJobRun API request. func (c *Client) CreateJobTemplate(ctx context.Context, params *CreateJobTemplateInput, optFns ...func(*Options)) (*CreateJobTemplateOutput, error) { diff --git a/service/emrcontainers/api_op_CreateManagedEndpoint.go b/service/emrcontainers/api_op_CreateManagedEndpoint.go index 569af0ed9f6..eec10cb1d81 100644 --- a/service/emrcontainers/api_op_CreateManagedEndpoint.go +++ b/service/emrcontainers/api_op_CreateManagedEndpoint.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon -// EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with -// your virtual cluster. +// Creates a managed endpoint. A managed endpoint is a gateway that connects +// Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate +// with your virtual cluster. func (c *Client) CreateManagedEndpoint(ctx context.Context, params *CreateManagedEndpointInput, optFns ...func(*Options)) (*CreateManagedEndpointOutput, error) { if params == nil { params = &CreateManagedEndpointInput{} @@ -65,8 +65,8 @@ type CreateManagedEndpointInput struct { // The certificate ARN provided by users for the managed endpoint. This field is // under deprecation and will be removed in future releases. // - // Deprecated: Customer provided certificate-arn is deprecated and would be removed - // in future. + // Deprecated: Customer provided certificate-arn is deprecated and would be + // removed in future. CertificateArn *string // The configuration settings that will be used to override existing diff --git a/service/emrcontainers/api_op_DeleteJobTemplate.go b/service/emrcontainers/api_op_DeleteJobTemplate.go index 62318735897..4169cbf258b 100644 --- a/service/emrcontainers/api_op_DeleteJobTemplate.go +++ b/service/emrcontainers/api_op_DeleteJobTemplate.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a job template. Job template stores values of StartJobRun API request in -// a template and can be used to start a job run. Job template allows two use +// Deletes a job template. Job template stores values of StartJobRun API request +// in a template and can be used to start a job run. Job template allows two use // cases: avoid repeating recurring StartJobRun API request values, enforcing // certain values in StartJobRun API request. func (c *Client) DeleteJobTemplate(ctx context.Context, params *DeleteJobTemplateInput, optFns ...func(*Options)) (*DeleteJobTemplateOutput, error) { diff --git a/service/emrcontainers/api_op_DeleteManagedEndpoint.go b/service/emrcontainers/api_op_DeleteManagedEndpoint.go index aa2fc702c95..e8230a9afc8 100644 --- a/service/emrcontainers/api_op_DeleteManagedEndpoint.go +++ b/service/emrcontainers/api_op_DeleteManagedEndpoint.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon -// EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with -// your virtual cluster. +// Deletes a managed endpoint. A managed endpoint is a gateway that connects +// Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate +// with your virtual cluster. func (c *Client) DeleteManagedEndpoint(ctx context.Context, params *DeleteManagedEndpointInput, optFns ...func(*Options)) (*DeleteManagedEndpointOutput, error) { if params == nil { params = &DeleteManagedEndpointInput{} diff --git a/service/emrcontainers/api_op_DescribeJobRun.go b/service/emrcontainers/api_op_DescribeJobRun.go index d73ff1ea9ed..45cc1fd2e4e 100644 --- a/service/emrcontainers/api_op_DescribeJobRun.go +++ b/service/emrcontainers/api_op_DescribeJobRun.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays detailed information about a job run. A job run is a unit of work, such -// as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR -// on EKS. +// Displays detailed information about a job run. A job run is a unit of work, +// such as a Spark jar, PySpark script, or SparkSQL query, that you submit to +// Amazon EMR on EKS. func (c *Client) DescribeJobRun(ctx context.Context, params *DescribeJobRunInput, optFns ...func(*Options)) (*DescribeJobRunOutput, error) { if params == nil { params = &DescribeJobRunInput{} diff --git a/service/emrcontainers/api_op_DescribeVirtualCluster.go b/service/emrcontainers/api_op_DescribeVirtualCluster.go index d6cc82ba7b1..7ca4945e1ae 100644 --- a/service/emrcontainers/api_op_DescribeVirtualCluster.go +++ b/service/emrcontainers/api_op_DescribeVirtualCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays detailed information about a specified virtual cluster. Virtual cluster -// is a managed entity on Amazon EMR on EKS. You can create, describe, list and -// delete virtual clusters. They do not consume any additional resource in your +// Displays detailed information about a specified virtual cluster. Virtual +// cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list +// and delete virtual clusters. They do not consume any additional resource in your // system. A single virtual cluster maps to a single Kubernetes namespace. Given // this relationship, you can model virtual clusters the same way you model // Kubernetes namespaces to meet your requirements. diff --git a/service/emrcontainers/api_op_ListVirtualClusters.go b/service/emrcontainers/api_op_ListVirtualClusters.go index 0fc20923f2a..9e91bc2409f 100644 --- a/service/emrcontainers/api_op_ListVirtualClusters.go +++ b/service/emrcontainers/api_op_ListVirtualClusters.go @@ -135,8 +135,8 @@ func (c *Client) addOperationListVirtualClustersMiddlewares(stack *middleware.St return nil } -// ListVirtualClustersAPIClient is a client that implements the ListVirtualClusters -// operation. +// ListVirtualClustersAPIClient is a client that implements the +// ListVirtualClusters operation. type ListVirtualClustersAPIClient interface { ListVirtualClusters(context.Context, *ListVirtualClustersInput, ...func(*Options)) (*ListVirtualClustersOutput, error) } diff --git a/service/emrcontainers/doc.go b/service/emrcontainers/doc.go index 66ca32a1fa4..be34119c0f3 100644 --- a/service/emrcontainers/doc.go +++ b/service/emrcontainers/doc.go @@ -3,28 +3,22 @@ // Package emrcontainers provides the API client, operations, and parameter types // for Amazon EMR Containers. // -// Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to -// run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon -// EKS). With this deployment option, you can focus on running analytics workloads -// while Amazon EMR on EKS builds, configures, and manages containers for +// Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you +// to run open-source big data frameworks on Amazon Elastic Kubernetes Service +// (Amazon EKS). With this deployment option, you can focus on running analytics +// workloads while Amazon EMR on EKS builds, configures, and manages containers for // open-source applications. For more information about Amazon EMR on EKS concepts -// and tasks, see What is shared id="EMR-EKS"/> -// (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html). -// Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers -// prefix is used in the following scenarios: -// -// * It is the prefix in the CLI -// commands for Amazon EMR on EKS. For example, aws emr-containers -// start-job-run. -// -// * It is the prefix before IAM policy actions for Amazon EMR on -// EKS. For example, "Action": [ "emr-containers:StartJobRun"]. For more -// information, see Policy actions for Amazon EMR on EKS -// (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions). -// -// * -// It is the prefix used in Amazon EMR on EKS service endpoints. For example, -// emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on -// EKSService Endpoints -// (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints). +// and tasks, see What is shared id="EMR-EKS"/> (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html) +// . Amazon EMR containers is the API name for Amazon EMR on EKS. The +// emr-containers prefix is used in the following scenarios: +// - It is the prefix in the CLI commands for Amazon EMR on EKS. For example, +// aws emr-containers start-job-run . +// - It is the prefix before IAM policy actions for Amazon EMR on EKS. For +// example, "Action": [ "emr-containers:StartJobRun"] . For more information, see +// Policy actions for Amazon EMR on EKS (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions) +// . +// - It is the prefix used in Amazon EMR on EKS service endpoints. For example, +// emr-containers.us-east-2.amazonaws.com . For more information, see Amazon EMR +// on EKSService Endpoints (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints) +// . package emrcontainers diff --git a/service/emrcontainers/types/enums.go b/service/emrcontainers/types/enums.go index f510a0cd78e..4ac38dd9ab7 100644 --- a/service/emrcontainers/types/enums.go +++ b/service/emrcontainers/types/enums.go @@ -9,8 +9,8 @@ const ( ContainerProviderTypeEks ContainerProviderType = "EKS" ) -// Values returns all known values for ContainerProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ContainerProviderType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ContainerProviderType) Values() []ContainerProviderType { return []ContainerProviderType{ diff --git a/service/emrcontainers/types/types.go b/service/emrcontainers/types/types.go index 219f63a0048..cbafae13a79 100644 --- a/service/emrcontainers/types/types.go +++ b/service/emrcontainers/types/types.go @@ -121,19 +121,19 @@ type Endpoint struct { // The ARN of the endpoint. Arn *string - // The certificate ARN of the endpoint. This field is under deprecation and will be - // removed in future. + // The certificate ARN of the endpoint. This field is under deprecation and will + // be removed in future. // - // Deprecated: Customer provided certificate-arn is deprecated and would be removed - // in future. + // Deprecated: Customer provided certificate-arn is deprecated and would be + // removed in future. CertificateArn *string // The certificate generated by emr control plane on customer behalf to secure the // managed endpoint. CertificateAuthority *Certificate - // The configuration settings that are used to override existing configurations for - // endpoints. + // The configuration settings that are used to override existing configurations + // for endpoints. ConfigurationOverrides *ConfigurationOverrides // The date and time when the endpoint was created. diff --git a/service/emrserverless/api_client.go b/service/emrserverless/api_client.go index 5f93d9fe2c9..8db4d66f703 100644 --- a/service/emrserverless/api_client.go +++ b/service/emrserverless/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/emrserverless/api_op_CreateApplication.go b/service/emrserverless/api_op_CreateApplication.go index bcb6989c923..eeaa75ec93e 100644 --- a/service/emrserverless/api_op_CreateApplication.go +++ b/service/emrserverless/api_op_CreateApplication.go @@ -57,7 +57,7 @@ type CreateApplicationInput struct { AutoStopConfiguration *types.AutoStopConfig // The image configuration for all worker types. You can either set this parameter - // or imageConfiguration for each worker type in workerTypeSpecifications. + // or imageConfiguration for each worker type in workerTypeSpecifications . ImageConfiguration *types.ImageConfigurationInput // The capacity to initialize when the application is created. @@ -78,7 +78,7 @@ type CreateApplicationInput struct { // The tags assigned to the application. Tags map[string]string - // The key-value pairs that specify worker type to WorkerTypeSpecificationInput. + // The key-value pairs that specify worker type to WorkerTypeSpecificationInput . // This parameter must contain all valid worker types for a Spark or Hive // application. Valid worker types include Driver and Executor for Spark // applications and HiveDriver and TezTask for Hive applications. You can either diff --git a/service/emrserverless/api_op_UpdateApplication.go b/service/emrserverless/api_op_UpdateApplication.go index 64655eabbd4..1da7b7bcb14 100644 --- a/service/emrserverless/api_op_UpdateApplication.go +++ b/service/emrserverless/api_op_UpdateApplication.go @@ -52,9 +52,9 @@ type UpdateApplicationInput struct { // amount of time being idle. AutoStopConfiguration *types.AutoStopConfig - // The image configuration to be used for all worker types. You can either set this - // parameter or imageConfiguration for each worker type in - // WorkerTypeSpecificationInput. + // The image configuration to be used for all worker types. You can either set + // this parameter or imageConfiguration for each worker type in + // WorkerTypeSpecificationInput . ImageConfiguration *types.ImageConfigurationInput // The capacity to initialize when the application is updated. @@ -69,7 +69,7 @@ type UpdateApplicationInput struct { // The network configuration for customer VPC connectivity. NetworkConfiguration *types.NetworkConfiguration - // The key-value pairs that specify worker type to WorkerTypeSpecificationInput. + // The key-value pairs that specify worker type to WorkerTypeSpecificationInput . // This parameter must contain all valid worker types for a Spark or Hive // application. Valid worker types include Driver and Executor for Spark // applications and HiveDriver and TezTask for Hive applications. You can either diff --git a/service/emrserverless/doc.go b/service/emrserverless/doc.go index 67cc205635f..ab78b48d69b 100644 --- a/service/emrserverless/doc.go +++ b/service/emrserverless/doc.go @@ -8,19 +8,14 @@ // applications using the latest open source frameworks such as Apache Spark and // Apache Hive. With EMR Serverless, you don’t have to configure, optimize, secure, // or operate clusters to run applications with these frameworks. The API reference -// to Amazon EMR Serverless is emr-serverless. The emr-serverless prefix is used in -// the following scenarios: -// -// * It is the prefix in the CLI commands for Amazon EMR -// Serverless. For example, aws emr-serverless start-job-run. -// -// * It is the prefix -// before IAM policy actions for Amazon EMR Serverless. For example, "Action": -// ["emr-serverless:StartJobRun"]. For more information, see Policy actions for -// Amazon EMR Serverless -// (https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions). -// -// * -// It is the prefix used in Amazon EMR Serverless service endpoints. For example, -// emr-serverless.us-east-2.amazonaws.com. +// to Amazon EMR Serverless is emr-serverless . The emr-serverless prefix is used +// in the following scenarios: +// - It is the prefix in the CLI commands for Amazon EMR Serverless. For +// example, aws emr-serverless start-job-run . +// - It is the prefix before IAM policy actions for Amazon EMR Serverless. For +// example, "Action": ["emr-serverless:StartJobRun"] . For more information, see +// Policy actions for Amazon EMR Serverless (https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions) +// . +// - It is the prefix used in Amazon EMR Serverless service endpoints. For +// example, emr-serverless.us-east-2.amazonaws.com . package emrserverless diff --git a/service/emrserverless/types/enums.go b/service/emrserverless/types/enums.go index 45be89513e3..d518bab27fc 100644 --- a/service/emrserverless/types/enums.go +++ b/service/emrserverless/types/enums.go @@ -38,9 +38,9 @@ const ( ArchitectureX8664 Architecture = "X86_64" ) -// Values returns all known values for Architecture. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Architecture. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Architecture) Values() []Architecture { return []Architecture{ "ARM64", diff --git a/service/emrserverless/types/types.go b/service/emrserverless/types/types.go index a02edee7350..4f352d1a9c2 100644 --- a/service/emrserverless/types/types.go +++ b/service/emrserverless/types/types.go @@ -349,7 +349,7 @@ type JobRun struct { Tags map[string]string // The job run total execution duration in seconds. This field is only available - // for job runs in a COMPLETED, FAILED, or CANCELLED state. + // for job runs in a COMPLETED , FAILED , or CANCELLED state. TotalExecutionDurationSeconds *int32 // The aggregate vCPU, memory, and storage resources used from the time job start diff --git a/service/eventbridge/api_client.go b/service/eventbridge/api_client.go index a48190c4066..4e979e7e973 100644 --- a/service/eventbridge/api_client.go +++ b/service/eventbridge/api_client.go @@ -120,7 +120,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/eventbridge/api_op_ActivateEventSource.go b/service/eventbridge/api_op_ActivateEventSource.go index 98ea0e75265..2f04f634019 100644 --- a/service/eventbridge/api_op_ActivateEventSource.go +++ b/service/eventbridge/api_op_ActivateEventSource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Activates a partner event source that has been deactivated. Once activated, your -// matching event bus will start receiving events from the event source. +// Activates a partner event source that has been deactivated. Once activated, +// your matching event bus will start receiving events from the event source. func (c *Client) ActivateEventSource(ctx context.Context, params *ActivateEventSourceInput, optFns ...func(*Options)) (*ActivateEventSourceOutput, error) { if params == nil { params = &ActivateEventSourceInput{} diff --git a/service/eventbridge/api_op_CreateApiDestination.go b/service/eventbridge/api_op_CreateApiDestination.go index 5c5ffc81900..058c62bdd0f 100644 --- a/service/eventbridge/api_op_CreateApiDestination.go +++ b/service/eventbridge/api_op_CreateApiDestination.go @@ -12,8 +12,8 @@ import ( "time" ) -// Creates an API destination, which is an HTTP invocation endpoint configured as a -// target for events. +// Creates an API destination, which is an HTTP invocation endpoint configured as +// a target for events. func (c *Client) CreateApiDestination(ctx context.Context, params *CreateApiDestinationInput, optFns ...func(*Options)) (*CreateApiDestinationOutput, error) { if params == nil { params = &CreateApiDestinationInput{} diff --git a/service/eventbridge/api_op_CreateArchive.go b/service/eventbridge/api_op_CreateArchive.go index f16c77db8db..ae972d9a153 100644 --- a/service/eventbridge/api_op_CreateArchive.go +++ b/service/eventbridge/api_op_CreateArchive.go @@ -50,8 +50,8 @@ type CreateArchiveInput struct { // An event pattern to use to filter events sent to the archive. EventPattern *string - // The number of days to retain events for. Default value is 0. If set to 0, events - // are retained indefinitely + // The number of days to retain events for. Default value is 0. If set to 0, + // events are retained indefinitely RetentionDays *int32 noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_CreateEndpoint.go b/service/eventbridge/api_op_CreateEndpoint.go index de12f3f399e..75cea906fd4 100644 --- a/service/eventbridge/api_op_CreateEndpoint.go +++ b/service/eventbridge/api_op_CreateEndpoint.go @@ -42,7 +42,7 @@ type CreateEndpointInput struct { EventBuses []types.EndpointEventBus // The name of the global endpoint. For example, - // "Name":"us-east-2-custom_bus_A-endpoint". + // "Name":"us-east-2-custom_bus_A-endpoint" . // // This member is required. Name *string @@ -56,8 +56,8 @@ type CreateEndpointInput struct { Description *string // Enable or disable event replication. The default state is ENABLED which means - // you must supply a RoleArn. If you don't have a RoleArn or you don't want event - // replication enabled, set the state to DISABLED. + // you must supply a RoleArn . If you don't have a RoleArn or you don't want event + // replication enabled, set the state to DISABLED . ReplicationConfig *types.ReplicationConfig // The ARN of the role used for replication. diff --git a/service/eventbridge/api_op_CreateEventBus.go b/service/eventbridge/api_op_CreateEventBus.go index 97d0785f9a0..7e2040f151f 100644 --- a/service/eventbridge/api_op_CreateEventBus.go +++ b/service/eventbridge/api_op_CreateEventBus.go @@ -41,8 +41,8 @@ type CreateEventBusInput struct { // This member is required. Name *string - // If you are creating a partner event bus, this specifies the partner event source - // that the new event bus will be matched with. + // If you are creating a partner event bus, this specifies the partner event + // source that the new event bus will be matched with. EventSourceName *string // Tags to associate with the event bus. diff --git a/service/eventbridge/api_op_CreatePartnerEventSource.go b/service/eventbridge/api_op_CreatePartnerEventSource.go index fe151418071..4d0a645f655 100644 --- a/service/eventbridge/api_op_CreatePartnerEventSource.go +++ b/service/eventbridge/api_op_CreatePartnerEventSource.go @@ -20,7 +20,7 @@ import ( // partner event bus that matches the partner event source can use that event bus // to receive events from the partner, and then process them using Amazon Web // Services Events rules and targets. Partner event source names follow this -// format: partner_name/event_namespace/event_name partner_name is determined +// format: partner_name/event_namespace/event_name partner_name is determined // during partner registration and identifies the partner to Amazon Web Services // customers. event_namespace is determined by the partner and is a way for the // partner to categorize their events. event_name is determined by the partner, and @@ -52,7 +52,7 @@ type CreatePartnerEventSourceInput struct { Account *string // The name of the partner event source. This name must be unique and must be in - // the format partner_name/event_namespace/event_name . The Amazon Web Services + // the format partner_name/event_namespace/event_name . The Amazon Web Services // account that wants to use this partner event source must create a partner event // bus with a name that matches the name of the partner event source. // diff --git a/service/eventbridge/api_op_DeactivateEventSource.go b/service/eventbridge/api_op_DeactivateEventSource.go index 894389ea9a5..2874d46b671 100644 --- a/service/eventbridge/api_op_DeactivateEventSource.go +++ b/service/eventbridge/api_op_DeactivateEventSource.go @@ -14,8 +14,8 @@ import ( // specified partner event source. The matching event bus is not deleted. When you // deactivate a partner event source, the source goes into PENDING state. If it // remains in PENDING state for more than two weeks, it is deleted. To activate a -// deactivated partner event source, use ActivateEventSource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html). +// deactivated partner event source, use ActivateEventSource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html) +// . func (c *Client) DeactivateEventSource(ctx context.Context, params *DeactivateEventSourceInput, optFns ...func(*Options)) (*DeactivateEventSourceOutput, error) { if params == nil { params = &DeactivateEventSourceInput{} diff --git a/service/eventbridge/api_op_DeleteEndpoint.go b/service/eventbridge/api_op_DeleteEndpoint.go index 1b13b5c3a38..9b14be9e508 100644 --- a/service/eventbridge/api_op_DeleteEndpoint.go +++ b/service/eventbridge/api_op_DeleteEndpoint.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an existing global endpoint. For more information about global endpoints, -// see Making applications Regional-fault tolerant with global endpoints and event -// replication -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) +// Delete an existing global endpoint. For more information about global +// endpoints, see Making applications Regional-fault tolerant with global +// endpoints and event replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) // in the Amazon EventBridge User Guide. func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { @@ -33,7 +32,7 @@ func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput type DeleteEndpointInput struct { // The name of the endpoint you want to delete. For example, - // "Name":"us-east-2-custom_bus_A-endpoint".. + // "Name":"us-east-2-custom_bus_A-endpoint" .. // // This member is required. Name *string diff --git a/service/eventbridge/api_op_DeleteRule.go b/service/eventbridge/api_op_DeleteRule.go index af8382da9c5..f0208673fd1 100644 --- a/service/eventbridge/api_op_DeleteRule.go +++ b/service/eventbridge/api_op_DeleteRule.go @@ -11,9 +11,8 @@ import ( ) // Deletes the specified rule. Before you can delete the rule, you must remove all -// targets, using RemoveTargets -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html). -// When you delete a rule, incoming events might continue to match to the deleted +// targets, using RemoveTargets (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html) +// . When you delete a rule, incoming events might continue to match to the deleted // rule. Allow a short period of time for changes to take effect. If you call // delete rule multiple times for the same rule, all calls will succeed. When you // call delete rule for a non-existent custom eventbus, ResourceNotFoundException @@ -44,15 +43,15 @@ type DeleteRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // If this is a managed rule, created by an Amazon Web Services service on your // behalf, you must specify Force as True to delete the rule. This parameter is // ignored for rules that are not managed rules. You can check whether a rule is a - // managed rule by using DescribeRule or ListRules and checking the ManagedBy field - // of the response. + // managed rule by using DescribeRule or ListRules and checking the ManagedBy + // field of the response. Force bool noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_DescribeEndpoint.go b/service/eventbridge/api_op_DescribeEndpoint.go index 4cfe0571eba..dcb4ac1f8a6 100644 --- a/service/eventbridge/api_op_DescribeEndpoint.go +++ b/service/eventbridge/api_op_DescribeEndpoint.go @@ -14,8 +14,7 @@ import ( // Get the information about an existing global endpoint. For more information // about global endpoints, see Making applications Regional-fault tolerant with -// global endpoints and event replication -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) +// global endpoints and event replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) // in the Amazon EventBridge User Guide.. func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error) { if params == nil { @@ -35,13 +34,13 @@ func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointI type DescribeEndpointInput struct { // The name of the endpoint you want to get information about. For example, - // "Name":"us-east-2-custom_bus_A-endpoint". + // "Name":"us-east-2-custom_bus_A-endpoint" . // // This member is required. Name *string // The primary Region of the endpoint you want to get information about. For - // example "HomeRegion": "us-east-1". + // example "HomeRegion": "us-east-1" . HomeRegion *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_DescribeEventBus.go b/service/eventbridge/api_op_DescribeEventBus.go index 7a0898d01ee..78e786153f0 100644 --- a/service/eventbridge/api_op_DescribeEventBus.go +++ b/service/eventbridge/api_op_DescribeEventBus.go @@ -15,10 +15,9 @@ import ( // default event bus, and the associated policy. For custom event buses and partner // event buses, it displays the name, ARN, policy, state, and creation time. To // enable your account to receive events from other accounts on its default event -// bus, use PutPermission -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html). -// For more information about partner event buses, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). +// bus, use PutPermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) +// . For more information about partner event buses, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . func (c *Client) DescribeEventBus(ctx context.Context, params *DescribeEventBusInput, optFns ...func(*Options)) (*DescribeEventBusOutput, error) { if params == nil { params = &DescribeEventBusInput{} @@ -49,7 +48,7 @@ type DescribeEventBusOutput struct { // current account. Arn *string - // The name of the event bus. Currently, this is always default. + // The name of the event bus. Currently, this is always default . Name *string // The policy that enables the external account to send events to your account. diff --git a/service/eventbridge/api_op_DescribePartnerEventSource.go b/service/eventbridge/api_op_DescribePartnerEventSource.go index 691d700ea85..8c27de48697 100644 --- a/service/eventbridge/api_op_DescribePartnerEventSource.go +++ b/service/eventbridge/api_op_DescribePartnerEventSource.go @@ -12,8 +12,7 @@ import ( // An SaaS partner can use this operation to list details about a partner event // source that they have created. Amazon Web Services customers do not use this -// operation. Instead, Amazon Web Services customers can use DescribeEventSource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) +// operation. Instead, Amazon Web Services customers can use DescribeEventSource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) // to see details about a partner event source that is shared with them. func (c *Client) DescribePartnerEventSource(ctx context.Context, params *DescribePartnerEventSourceInput, optFns ...func(*Options)) (*DescribePartnerEventSourceOutput, error) { if params == nil { diff --git a/service/eventbridge/api_op_DescribeReplay.go b/service/eventbridge/api_op_DescribeReplay.go index 18e15faad74..7db94da2545 100644 --- a/service/eventbridge/api_op_DescribeReplay.go +++ b/service/eventbridge/api_op_DescribeReplay.go @@ -14,8 +14,8 @@ import ( // Retrieves details about a replay. Use DescribeReplay to determine the progress // of a running replay. A replay processes events to replay based on the time in -// the event, and replays them using 1 minute intervals. If you use StartReplay and -// specify an EventStartTime and an EventEndTime that covers a 20 minute time +// the event, and replays them using 1 minute intervals. If you use StartReplay +// and specify an EventStartTime and an EventEndTime that covers a 20 minute time // range, the events are replayed from the first minute of that 20 minute range // first. Then the events from the second minute are replayed. You can use // DescribeReplay to determine the progress of a replay. The value returned for diff --git a/service/eventbridge/api_op_DescribeRule.go b/service/eventbridge/api_op_DescribeRule.go index 4e48537edfc..02ed0fba167 100644 --- a/service/eventbridge/api_op_DescribeRule.go +++ b/service/eventbridge/api_op_DescribeRule.go @@ -12,8 +12,8 @@ import ( ) // Describes the specified rule. DescribeRule does not list the targets of a rule. -// To see the targets associated with a rule, use ListTargetsByRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html). +// To see the targets associated with a rule, use ListTargetsByRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html) +// . func (c *Client) DescribeRule(ctx context.Context, params *DescribeRuleInput, optFns ...func(*Options)) (*DescribeRuleOutput, error) { if params == nil { params = &DescribeRuleInput{} @@ -36,8 +36,8 @@ type DescribeRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde @@ -61,8 +61,7 @@ type DescribeRuleOutput struct { // The name of the event bus associated with the rule. EventBusName *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string diff --git a/service/eventbridge/api_op_DisableRule.go b/service/eventbridge/api_op_DisableRule.go index ff9104164e3..3e545bd06a6 100644 --- a/service/eventbridge/api_op_DisableRule.go +++ b/service/eventbridge/api_op_DisableRule.go @@ -36,8 +36,8 @@ type DisableRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_EnableRule.go b/service/eventbridge/api_op_EnableRule.go index ef35e98950e..d5bbf34c051 100644 --- a/service/eventbridge/api_op_EnableRule.go +++ b/service/eventbridge/api_op_EnableRule.go @@ -35,8 +35,8 @@ type EnableRuleInput struct { // This member is required. Name *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_ListApiDestinations.go b/service/eventbridge/api_op_ListApiDestinations.go index 7c4c88029c4..08ffdb32f8e 100644 --- a/service/eventbridge/api_op_ListApiDestinations.go +++ b/service/eventbridge/api_op_ListApiDestinations.go @@ -35,8 +35,8 @@ type ListApiDestinationsInput struct { // The maximum number of API destinations to include in the response. Limit *int32 - // A name prefix to filter results returned. Only API destinations with a name that - // starts with the prefix are returned. + // A name prefix to filter results returned. Only API destinations with a name + // that starts with the prefix are returned. NamePrefix *string // The token returned by a previous call to retrieve the next set of results. diff --git a/service/eventbridge/api_op_ListEndpoints.go b/service/eventbridge/api_op_ListEndpoints.go index f75315d0423..dbb3d3c53a4 100644 --- a/service/eventbridge/api_op_ListEndpoints.go +++ b/service/eventbridge/api_op_ListEndpoints.go @@ -13,8 +13,7 @@ import ( // List the global endpoints associated with this account. For more information // about global endpoints, see Making applications Regional-fault tolerant with -// global endpoints and event replication -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) +// global endpoints and event replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) // in the Amazon EventBridge User Guide.. func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error) { if params == nil { @@ -34,15 +33,15 @@ func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, type ListEndpointsInput struct { // The primary Region of the endpoints associated with this account. For example - // "HomeRegion": "us-east-1". + // "HomeRegion": "us-east-1" . HomeRegion *string // The maximum number of results returned by the call. MaxResults *int32 - // A value that will return a subset of the endpoints associated with this account. - // For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the - // name. + // A value that will return a subset of the endpoints associated with this + // account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" + // in the name. NamePrefix *string // If nextToken is returned, there are more results available. The value of diff --git a/service/eventbridge/api_op_ListEventSources.go b/service/eventbridge/api_op_ListEventSources.go index 9d383ce79de..b22c2f08311 100644 --- a/service/eventbridge/api_op_ListEventSources.go +++ b/service/eventbridge/api_op_ListEventSources.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You can use this to see all the partner event sources that have been shared with -// your Amazon Web Services account. For more information about partner event -// sources, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). +// You can use this to see all the partner event sources that have been shared +// with your Amazon Web Services account. For more information about partner event +// sources, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . func (c *Client) ListEventSources(ctx context.Context, params *ListEventSourcesInput, optFns ...func(*Options)) (*ListEventSourcesOutput, error) { if params == nil { params = &ListEventSourcesInput{} diff --git a/service/eventbridge/api_op_ListPartnerEventSources.go b/service/eventbridge/api_op_ListPartnerEventSources.go index c67e855901a..de98c72f099 100644 --- a/service/eventbridge/api_op_ListPartnerEventSources.go +++ b/service/eventbridge/api_op_ListPartnerEventSources.go @@ -31,8 +31,8 @@ func (c *Client) ListPartnerEventSources(ctx context.Context, params *ListPartne type ListPartnerEventSourcesInput struct { - // If you specify this, the results are limited to only those partner event sources - // that start with the string you specify. + // If you specify this, the results are limited to only those partner event + // sources that start with the string you specify. // // This member is required. NamePrefix *string diff --git a/service/eventbridge/api_op_ListRuleNamesByTarget.go b/service/eventbridge/api_op_ListRuleNamesByTarget.go index 148d6611e5b..aeab48b441e 100644 --- a/service/eventbridge/api_op_ListRuleNamesByTarget.go +++ b/service/eventbridge/api_op_ListRuleNamesByTarget.go @@ -49,8 +49,8 @@ type ListRuleNamesByTargetInput struct { type ListRuleNamesByTargetOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The names of the rules that can invoke the given target. diff --git a/service/eventbridge/api_op_ListRules.go b/service/eventbridge/api_op_ListRules.go index 9b8a214f864..7f4fb029bd0 100644 --- a/service/eventbridge/api_op_ListRules.go +++ b/service/eventbridge/api_op_ListRules.go @@ -14,8 +14,8 @@ import ( // Lists your Amazon EventBridge rules. You can either list all the rules or you // can provide a prefix to match to the rule names. ListRules does not list the // targets of a rule. To see the targets associated with a rule, use -// ListTargetsByRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html). +// ListTargetsByRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html) +// . func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} @@ -51,8 +51,8 @@ type ListRulesInput struct { type ListRulesOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The rules that match the specified criteria. diff --git a/service/eventbridge/api_op_ListTagsForResource.go b/service/eventbridge/api_op_ListTagsForResource.go index fd88027b1bd..5f02ca9ff7a 100644 --- a/service/eventbridge/api_op_ListTagsForResource.go +++ b/service/eventbridge/api_op_ListTagsForResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays the tags associated with an EventBridge resource. In EventBridge, rules -// and event buses can be tagged. +// Displays the tags associated with an EventBridge resource. In EventBridge, +// rules and event buses can be tagged. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/eventbridge/api_op_ListTargetsByRule.go b/service/eventbridge/api_op_ListTargetsByRule.go index b6169cbe80b..1711e7e7a82 100644 --- a/service/eventbridge/api_op_ListTargetsByRule.go +++ b/service/eventbridge/api_op_ListTargetsByRule.go @@ -34,8 +34,8 @@ type ListTargetsByRuleInput struct { // This member is required. Rule *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // The maximum number of results to return. @@ -49,8 +49,8 @@ type ListTargetsByRuleInput struct { type ListTargetsByRuleOutput struct { - // Indicates whether there are additional results to retrieve. If there are no more - // results, the value is null. + // Indicates whether there are additional results to retrieve. If there are no + // more results, the value is null. NextToken *string // The targets assigned to the rule. diff --git a/service/eventbridge/api_op_PutEvents.go b/service/eventbridge/api_op_PutEvents.go index 9cc75d1f1bb..004b63f7c33 100644 --- a/service/eventbridge/api_op_PutEvents.go +++ b/service/eventbridge/api_op_PutEvents.go @@ -40,7 +40,7 @@ type PutEventsInput struct { // The URL subdomain of the endpoint. For example, if the URL for Endpoint is // https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is - // abcde.veo. When using Java, you must include auth-crt on the class path. + // abcde.veo . When using Java, you must include auth-crt on the class path. EndpointId *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_PutPartnerEvents.go b/service/eventbridge/api_op_PutPartnerEvents.go index d04fa51606a..b00866b1a0b 100644 --- a/service/eventbridge/api_op_PutPartnerEvents.go +++ b/service/eventbridge/api_op_PutPartnerEvents.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is used by SaaS partners to write events to a customer's partner event bus. -// Amazon Web Services customers do not use this operation. +// This is used by SaaS partners to write events to a customer's partner event +// bus. Amazon Web Services customers do not use this operation. func (c *Client) PutPartnerEvents(ctx context.Context, params *PutPartnerEventsInput, optFns ...func(*Options)) (*PutPartnerEventsOutput, error) { if params == nil { params = &PutPartnerEventsInput{} diff --git a/service/eventbridge/api_op_PutPermission.go b/service/eventbridge/api_op_PutPermission.go index ed12ea43a2c..e80411f3789 100644 --- a/service/eventbridge/api_op_PutPermission.go +++ b/service/eventbridge/api_op_PutPermission.go @@ -20,13 +20,12 @@ import ( // Services accounts to put events to your event bus, run PutPermission once for // each of these accounts. Or, if all the accounts are members of the same Amazon // Web Services organization, you can run PutPermission once specifying Principal -// as "*" and specifying the Amazon Web Services organization ID in Condition, to +// as "*" and specifying the Amazon Web Services organization ID in Condition , to // grant permissions to all accounts in that organization. If you grant permissions // using an organization, then accounts in that organization must specify a RoleArn // with proper permissions when they use PutTarget to add your account's event bus // as a target. For more information, see Sending and Receiving Events Between -// Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. The permission policy on the event bus // cannot exceed 10 KB in size. func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { @@ -52,12 +51,11 @@ type PutPermissionInput struct { // This parameter enables you to limit the permission to accounts that fulfill a // certain condition, such as being a member of a certain Amazon Web Services // organization. For more information about Amazon Web Services Organizations, see - // What Is Amazon Web Services Organizations - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) + // What Is Amazon Web Services Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) // in the Amazon Web Services Organizations User Guide. If you specify Condition // with an Amazon Web Services organization ID, and specify "*" as the value for - // Principal, you grant permission to all the accounts in the named organization. - // The Condition is a JSON string which must contain Type, Key, and Value fields. + // Principal , you grant permission to all the accounts in the named organization. + // The Condition is a JSON string which must contain Type , Key , and Value fields. Condition *types.Condition // The name of the event bus associated with the rule. If you omit this, the @@ -65,14 +63,14 @@ type PutPermissionInput struct { EventBusName *string // A JSON string that describes the permission policy statement. You can include a - // Policy parameter in the request instead of using the StatementId, Action, - // Principal, or Condition parameters. + // Policy parameter in the request instead of using the StatementId , Action , + // Principal , or Condition parameters. Policy *string // The 12-digit Amazon Web Services account ID that you are permitting to put // events to your default event bus. Specify "*" to permit any account to put // events to your default event bus. If you specify "*" without specifying - // Condition, avoid creating rules that may match undesirable events. To create + // Condition , avoid creating rules that may match undesirable events. To create // more secure rules, make sure that the event pattern for each rule contains an // account field with a specific account ID from which to receive events. Rules // with an account field do not match any events sent from other accounts. @@ -80,9 +78,8 @@ type PutPermissionInput struct { // An identifier string for the external account that you are granting permissions // to. If you later want to revoke the permission for this external account, - // specify this StatementId when you run RemovePermission - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html). - // Each StatementId must be unique. + // specify this StatementId when you run RemovePermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) + // . Each StatementId must be unique. StatementId *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_PutRule.go b/service/eventbridge/api_op_PutRule.go index 296b1342c69..d7d08a018ba 100644 --- a/service/eventbridge/api_op_PutRule.go +++ b/service/eventbridge/api_op_PutRule.go @@ -11,37 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates the specified rule. Rules are enabled by default, or based on -// value of the state. You can disable a rule using DisableRule -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html). -// A single rule watches for events from a single event bus. Events generated by +// Creates or updates the specified rule. Rules are enabled by default, or based +// on value of the state. You can disable a rule using DisableRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) +// . A single rule watches for events from a single event bus. Events generated by // Amazon Web Services services go to your account's default event bus. Events // generated by SaaS partner services or applications go to the matching partner // event bus. If you have custom applications or services, you can specify whether // their events go to your default event bus or a custom event bus that you have -// created. For more information, see CreateEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html). -// If you are updating an existing rule, the rule is replaced with what you specify -// in this PutRule command. If you omit arguments in PutRule, the old values for -// those arguments are not kept. Instead, they are replaced with null values. When -// you create or update a rule, incoming events might not immediately start -// matching to new or updated rules. Allow a short period of time for changes to -// take effect. A rule must contain at least an EventPattern or ScheduleExpression. -// Rules with EventPatterns are triggered when a matching event is observed. Rules -// with ScheduleExpressions self-trigger based on the given schedule. A rule can -// have both an EventPattern and a ScheduleExpression, in which case the rule -// triggers on matching events as well as on a schedule. When you initially create -// a rule, you can optionally assign one or more tags to the rule. Tags can help -// you organize and categorize your resources. You can also use them to scope user -// permissions, by granting a user permission to access or change only rules with -// certain tag values. To use the PutRule operation and assign tags, you must have -// both the events:PutRule and events:TagResource permissions. If you are updating -// an existing rule, any tags you specify in the PutRule operation are ignored. To -// update the tags of an existing rule, use TagResource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) -// and UntagResource -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html). -// Most services in Amazon Web Services treat : or / as the same character in +// created. For more information, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) +// . If you are updating an existing rule, the rule is replaced with what you +// specify in this PutRule command. If you omit arguments in PutRule , the old +// values for those arguments are not kept. Instead, they are replaced with null +// values. When you create or update a rule, incoming events might not immediately +// start matching to new or updated rules. Allow a short period of time for changes +// to take effect. A rule must contain at least an EventPattern or +// ScheduleExpression. Rules with EventPatterns are triggered when a matching event +// is observed. Rules with ScheduleExpressions self-trigger based on the given +// schedule. A rule can have both an EventPattern and a ScheduleExpression, in +// which case the rule triggers on matching events as well as on a schedule. When +// you initially create a rule, you can optionally assign one or more tags to the +// rule. Tags can help you organize and categorize your resources. You can also use +// them to scope user permissions, by granting a user permission to access or +// change only rules with certain tag values. To use the PutRule operation and +// assign tags, you must have both the events:PutRule and events:TagResource +// permissions. If you are updating an existing rule, any tags you specify in the +// PutRule operation are ignored. To update the tags of an existing rule, use +// TagResource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) +// and UntagResource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html) +// . Most services in Amazon Web Services treat : or / as the same character in // Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event // patterns and rules. Be sure to use the correct ARN characters when creating // event patterns so that they match the ARN syntax in the event you want to match. @@ -55,8 +52,8 @@ import ( // after any change. An infinite loop can quickly cause higher than expected // charges. We recommend that you use budgeting, which alerts you when charges // exceed your specified limit. For more information, see Managing Your Costs with -// Budgets -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html). +// Budgets (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) +// . func (c *Client) PutRule(ctx context.Context, params *PutRuleInput, optFns ...func(*Options)) (*PutRuleOutput, error) { if params == nil { params = &PutRuleInput{} @@ -86,8 +83,7 @@ type PutRuleInput struct { // the default event bus is used. EventBusName *string - // The event pattern. For more information, see Amazon EventBridge event patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) + // The event pattern. For more information, see Amazon EventBridge event patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string diff --git a/service/eventbridge/api_op_PutTargets.go b/service/eventbridge/api_op_PutTargets.go index 052662e3658..607f9e9bdde 100644 --- a/service/eventbridge/api_op_PutTargets.go +++ b/service/eventbridge/api_op_PutTargets.go @@ -11,150 +11,95 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified targets to the specified rule, or updates the targets if they -// are already associated with the rule. Targets are the resources that are invoked -// when a rule is triggered. Each rule can have up to five (5) targets associated -// with it at one time. You can configure the following as targets for Events: -// -// * -// API destination -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) -// -// * -// API Gateway -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) -// -// * -// Batch job queue -// -// * CloudWatch group -// -// * CodeBuild project -// -// * CodePipeline -// -// * EC2 -// CreateSnapshot API call -// -// * EC2 Image Builder -// -// * EC2 RebootInstances API call -// -// * -// EC2 StopInstances API call -// -// * EC2 TerminateInstances API call -// -// * ECS task -// -// * -// Event bus in a different account or Region -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) -// -// * -// Event bus in the same account and Region -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) -// -// * -// Firehose delivery stream -// -// * Glue workflow -// -// * Incident Manager response plan -// (https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) -// -// * -// Inspector assessment template -// -// * Kinesis stream -// -// * Lambda function -// -// * Redshift -// cluster -// -// * Redshift Serverless workgroup -// -// * SageMaker Pipeline -// -// * SNS topic -// -// * -// SQS queue -// -// * Step Functions state machine -// -// * Systems Manager Automation -// -// * -// Systems Manager OpsItem -// -// * Systems Manager Run Command -// -// Creating rules with -// built-in targets is supported only in the Amazon Web Services Management -// Console. The built-in targets are EC2 CreateSnapshot API call, EC2 -// RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances -// API call. For some target types, PutTargets provides target-specific parameters. -// If the target is a Kinesis data stream, you can optionally specify which shard -// the event goes to by using the KinesisParameters argument. To invoke a command -// on multiple EC2 instances with one rule, you can use the RunCommandParameters -// field. To be able to make API calls against the resources that you own, Amazon -// EventBridge needs the appropriate permissions. For Lambda and Amazon SNS -// resources, EventBridge relies on resource-based policies. For EC2 instances, -// Kinesis Data Streams, Step Functions state machines and API Gateway APIs, -// EventBridge relies on IAM roles that you specify in the RoleARN argument in -// PutTargets. For more information, see Authentication and Access Control -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) +// Adds the specified targets to the specified rule, or updates the targets if +// they are already associated with the rule. Targets are the resources that are +// invoked when a rule is triggered. Each rule can have up to five (5) targets +// associated with it at one time. You can configure the following as targets for +// Events: +// - API destination (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) +// - API Gateway (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) +// - Batch job queue +// - CloudWatch group +// - CodeBuild project +// - CodePipeline +// - EC2 CreateSnapshot API call +// - EC2 Image Builder +// - EC2 RebootInstances API call +// - EC2 StopInstances API call +// - EC2 TerminateInstances API call +// - ECS task +// - Event bus in a different account or Region (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) +// - Event bus in the same account and Region (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) +// - Firehose delivery stream +// - Glue workflow +// - Incident Manager response plan (https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) +// - Inspector assessment template +// - Kinesis stream +// - Lambda function +// - Redshift cluster +// - Redshift Serverless workgroup +// - SageMaker Pipeline +// - SNS topic +// - SQS queue +// - Step Functions state machine +// - Systems Manager Automation +// - Systems Manager OpsItem +// - Systems Manager Run Command +// +// Creating rules with built-in targets is supported only in the Amazon Web +// Services Management Console. The built-in targets are EC2 CreateSnapshot API +// call , EC2 RebootInstances API call , EC2 StopInstances API call , and EC2 +// TerminateInstances API call . For some target types, PutTargets provides +// target-specific parameters. If the target is a Kinesis data stream, you can +// optionally specify which shard the event goes to by using the KinesisParameters +// argument. To invoke a command on multiple EC2 instances with one rule, you can +// use the RunCommandParameters field. To be able to make API calls against the +// resources that you own, Amazon EventBridge needs the appropriate permissions. +// For Lambda and Amazon SNS resources, EventBridge relies on resource-based +// policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines +// and API Gateway APIs, EventBridge relies on IAM roles that you specify in the +// RoleARN argument in PutTargets . For more information, see Authentication and +// Access Control (https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) // in the Amazon EventBridge User Guide. If another Amazon Web Services account is -// in the same region and has granted you permission (using PutPermission), you can -// send events to that account. Set that account's event bus as a target of the +// in the same region and has granted you permission (using PutPermission ), you +// can send events to that account. Set that account's event bus as a target of the // rules in your account. To send the matched events to the other account, specify -// that account's event bus as the Arn value when you run PutTargets. If your +// that account's event bus as the Arn value when you run PutTargets . If your // account sends events to another account, your account is charged for each sent // event. Each event sent to another account is charged as a custom event. The // account receiving the event is not charged. For more information, see Amazon -// EventBridge Pricing (http://aws.amazon.com/eventbridge/pricing/). Input, -// InputPath, and InputTransformer are not available with PutTarget if the target +// EventBridge Pricing (http://aws.amazon.com/eventbridge/pricing/) . Input , +// InputPath , and InputTransformer are not available with PutTarget if the target // is an event bus of a different Amazon Web Services account. If you are setting // the event bus of another account as the target, and that account granted // permission to your account through an organization instead of directly by the // account ID, then you must specify a RoleArn with proper permissions in the -// Target structure. For more information, see Sending and Receiving Events Between -// Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Target structure. For more information, see Sending and Receiving Events +// Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. For more information about enabling -// cross-account events, see PutPermission -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html). -// Input, InputPath, and InputTransformer are mutually exclusive and optional +// cross-account events, see PutPermission (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) +// . Input, InputPath, and InputTransformer are mutually exclusive and optional // parameters of a target. When a rule is triggered due to a matched event: -// -// * If -// none of the following arguments are specified for a target, then the entire -// event is passed to the target in JSON format (unless the target is Amazon EC2 -// Run Command or Amazon ECS task, in which case nothing from the event is passed -// to the target). -// -// * If Input is specified in the form of valid JSON, then the -// matched event is overridden with this constant. -// -// * If InputPath is specified in -// the form of JSONPath (for example, $.detail), then only the part of the event -// specified in the path is passed to the target (for example, only the detail part -// of the event is passed). -// -// * If InputTransformer is specified, then one or more -// specified JSONPaths are extracted from the event and used as values in a -// template that you specify as the input to the target. -// -// When you specify -// InputPath or InputTransformer, you must use JSON dot notation, not bracket -// notation. When you add targets to a rule and the associated rule triggers soon -// after, new or updated targets might not be immediately invoked. Allow a short -// period of time for changes to take effect. This action can partially fail if too -// many requests are made at the same time. If that happens, FailedEntryCount is -// non-zero in the response and each entry in FailedEntries provides the ID of the -// failed target and the error code. +// - If none of the following arguments are specified for a target, then the +// entire event is passed to the target in JSON format (unless the target is Amazon +// EC2 Run Command or Amazon ECS task, in which case nothing from the event is +// passed to the target). +// - If Input is specified in the form of valid JSON, then the matched event is +// overridden with this constant. +// - If InputPath is specified in the form of JSONPath (for example, $.detail ), +// then only the part of the event specified in the path is passed to the target +// (for example, only the detail part of the event is passed). +// - If InputTransformer is specified, then one or more specified JSONPaths are +// extracted from the event and used as values in a template that you specify as +// the input to the target. +// +// When you specify InputPath or InputTransformer , you must use JSON dot notation, +// not bracket notation. When you add targets to a rule and the associated rule +// triggers soon after, new or updated targets might not be immediately invoked. +// Allow a short period of time for changes to take effect. This action can +// partially fail if too many requests are made at the same time. If that happens, +// FailedEntryCount is non-zero in the response and each entry in FailedEntries +// provides the ID of the failed target and the error code. func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns ...func(*Options)) (*PutTargetsOutput, error) { if params == nil { params = &PutTargetsInput{} @@ -182,8 +127,8 @@ type PutTargetsInput struct { // This member is required. Targets []types.Target - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_RemovePermission.go b/service/eventbridge/api_op_RemovePermission.go index 8146b73015b..cb32af32ef1 100644 --- a/service/eventbridge/api_op_RemovePermission.go +++ b/service/eventbridge/api_op_RemovePermission.go @@ -13,9 +13,9 @@ import ( // Revokes the permission of another Amazon Web Services account to be able to put // events to the specified event bus. Specify the account to revoke by the // StatementId value that you associated with the account when you granted it -// permission with PutPermission. You can find the StatementId by using -// DescribeEventBus -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html). +// permission with PutPermission . You can find the StatementId by using +// DescribeEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html) +// . func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} diff --git a/service/eventbridge/api_op_RemoveTargets.go b/service/eventbridge/api_op_RemoveTargets.go index 63ca19b61ad..bf5b282d542 100644 --- a/service/eventbridge/api_op_RemoveTargets.go +++ b/service/eventbridge/api_op_RemoveTargets.go @@ -47,15 +47,15 @@ type RemoveTargetsInput struct { // This member is required. Rule *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // If this is a managed rule, created by an Amazon Web Services service on your // behalf, you must specify Force as True to remove targets. This parameter is // ignored for rules that are not managed rules. You can check whether a rule is a - // managed rule by using DescribeRule or ListRules and checking the ManagedBy field - // of the response. + // managed rule by using DescribeRule or ListRules and checking the ManagedBy + // field of the response. Force bool noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_StartReplay.go b/service/eventbridge/api_op_StartReplay.go index ec145966860..23070fd4643 100644 --- a/service/eventbridge/api_op_StartReplay.go +++ b/service/eventbridge/api_op_StartReplay.go @@ -15,11 +15,11 @@ import ( // Starts the specified replay. Events are not necessarily replayed in the exact // same order that they were added to the archive. A replay processes events to // replay based on the time in the event, and replays them using 1 minute -// intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 -// minute time range, the events are replayed from the first minute of that 20 +// intervals. If you specify an EventStartTime and an EventEndTime that covers a +// 20 minute time range, the events are replayed from the first minute of that 20 // minute range first. Then the events from the second minute are replayed. You can -// use DescribeReplay to determine the progress of a replay. The value returned for -// EventLastReplayedTime indicates the time within the specified time range +// use DescribeReplay to determine the progress of a replay. The value returned +// for EventLastReplayedTime indicates the time within the specified time range // associated with the last event replayed. func (c *Client) StartReplay(ctx context.Context, params *StartReplayInput, optFns ...func(*Options)) (*StartReplayOutput, error) { if params == nil { diff --git a/service/eventbridge/api_op_TestEventPattern.go b/service/eventbridge/api_op_TestEventPattern.go index 0c436992ec7..877a2c45165 100644 --- a/service/eventbridge/api_op_TestEventPattern.go +++ b/service/eventbridge/api_op_TestEventPattern.go @@ -33,30 +33,20 @@ func (c *Client) TestEventPattern(ctx context.Context, params *TestEventPatternI type TestEventPatternInput struct { // The event, in JSON format, to test against the event pattern. The JSON must - // follow the format specified in Amazon Web Services Events - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html), and - // the following fields are mandatory: - // - // * id - // - // * account - // - // * source - // - // * time - // - // * - // region - // - // * resources - // - // * detail-type + // follow the format specified in Amazon Web Services Events (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html) + // , and the following fields are mandatory: + // - id + // - account + // - source + // - time + // - region + // - resources + // - detail-type // // This member is required. Event *string - // The event pattern. For more information, see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. // // This member is required. diff --git a/service/eventbridge/api_op_UpdateEndpoint.go b/service/eventbridge/api_op_UpdateEndpoint.go index c53c81eb8f9..0845e4db202 100644 --- a/service/eventbridge/api_op_UpdateEndpoint.go +++ b/service/eventbridge/api_op_UpdateEndpoint.go @@ -13,8 +13,7 @@ import ( // Update an existing endpoint. For more information about global endpoints, see // Making applications Regional-fault tolerant with global endpoints and event -// replication -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) +// replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) // in the Amazon EventBridge User Guide.. func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error) { if params == nil { diff --git a/service/eventbridge/doc.go b/service/eventbridge/doc.go index f72fbd92c6a..ad6f02dd9f8 100644 --- a/service/eventbridge/doc.go +++ b/service/eventbridge/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package eventbridge provides the API client, operations, and parameter types for -// Amazon EventBridge. +// Package eventbridge provides the API client, operations, and parameter types +// for Amazon EventBridge. // // Amazon EventBridge helps you to respond to state changes in your Amazon Web // Services resources. When your resources change state, they automatically send @@ -9,18 +9,14 @@ // the stream and route them to targets to take action. You can also use rules to // take action on a predetermined schedule. For example, you can configure rules // to: +// - Automatically invoke an Lambda function to update DNS entries when an event +// notifies you that Amazon EC2 instance enters the running state. +// - Direct specific API records from CloudTrail to an Amazon Kinesis data +// stream for detailed analysis of potential security or availability risks. +// - Periodically invoke a built-in target to create a snapshot of an Amazon EBS +// volume. // -// * Automatically invoke an Lambda function to update DNS entries when an -// event notifies you that Amazon EC2 instance enters the running state. -// -// * Direct -// specific API records from CloudTrail to an Amazon Kinesis data stream for -// detailed analysis of potential security or availability risks. -// -// * Periodically -// invoke a built-in target to create a snapshot of an Amazon EBS volume. -// -// For more -// information about the features of Amazon EventBridge, see the Amazon EventBridge -// User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide). +// For more information about the features of Amazon EventBridge, see the Amazon +// EventBridge User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide) +// . package eventbridge diff --git a/service/eventbridge/types/enums.go b/service/eventbridge/types/enums.go index 2bcedbc58f6..ca5724c5d3a 100644 --- a/service/eventbridge/types/enums.go +++ b/service/eventbridge/types/enums.go @@ -15,9 +15,9 @@ const ( ApiDestinationHttpMethodDelete ApiDestinationHttpMethod = "DELETE" ) -// Values returns all known values for ApiDestinationHttpMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ApiDestinationHttpMethod. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiDestinationHttpMethod) Values() []ApiDestinationHttpMethod { return []ApiDestinationHttpMethod{ "POST", @@ -60,9 +60,9 @@ const ( ArchiveStateUpdateFailed ArchiveState = "UPDATE_FAILED" ) -// Values returns all known values for ArchiveState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ArchiveState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ArchiveState) Values() []ArchiveState { return []ArchiveState{ "ENABLED", @@ -255,8 +255,8 @@ const ( PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" ) -// Values returns all known values for PlacementStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PlacementStrategyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategyType) Values() []PlacementStrategyType { return []PlacementStrategyType{ @@ -334,9 +334,9 @@ const ( RuleStateDisabled RuleState = "DISABLED" ) -// Values returns all known values for RuleState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RuleState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RuleState) Values() []RuleState { return []RuleState{ "ENABLED", diff --git a/service/eventbridge/types/errors.go b/service/eventbridge/types/errors.go index fb8b0a0a165..ff43bf3cc57 100644 --- a/service/eventbridge/types/errors.go +++ b/service/eventbridge/types/errors.go @@ -167,10 +167,10 @@ func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy. // This rule was created by an Amazon Web Services service on behalf of your // account. It is managed by that service. If you see this error in response to -// DeleteRule or RemoveTargets, you can use the Force parameter in those calls to +// DeleteRule or RemoveTargets , you can use the Force parameter in those calls to // delete the rule or remove targets from the rule. You cannot modify these managed -// rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or -// UntagResource. +// rules by using DisableRule , EnableRule , PutTargets , PutRule , TagResource , +// or UntagResource . type ManagedRuleException struct { Message *string diff --git a/service/eventbridge/types/types.go b/service/eventbridge/types/types.go index 7a4adeb4b6b..2961f41a615 100644 --- a/service/eventbridge/types/types.go +++ b/service/eventbridge/types/types.go @@ -76,15 +76,15 @@ type Archive struct { // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. + // Specifies the subnets associated with the task. These subnets must all be in + // the same VPC. You can specify as many as 16 subnets. // // This member is required. Subnets []string // Specifies whether the task's elastic network interface receives a public IP - // address. You can specify ENABLED only when LaunchType in EcsParameters is set to - // FARGATE. + // address. You can specify ENABLED only when LaunchType in EcsParameters is set + // to FARGATE . AssignPublicIp AssignPublicIp // Specifies the security groups associated with the task. These security groups @@ -138,9 +138,9 @@ type BatchParameters struct { noSmithyDocumentSerde } -// The retry strategy to use for failed jobs, if the target is an Batch job. If you -// specify a retry strategy here, it overrides the retry strategy defined in the -// job definition. +// The retry strategy to use for failed jobs, if the target is an Batch job. If +// you specify a retry strategy here, it overrides the retry strategy defined in +// the job definition. type BatchRetryStrategy struct { // The number of times to attempt to retry, if the job fails. Valid values are @@ -151,8 +151,7 @@ type BatchRetryStrategy struct { } // The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) // in the Amazon ECS API Reference. type CapacityProviderStrategyItem struct { @@ -167,9 +166,9 @@ type CapacityProviderStrategyItem struct { // used. Base int32 - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. The weight value is - // taken into consideration after the base value, if defined, is satisfied. + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight value + // is taken into consideration after the base value, if defined, is satisfied. Weight int32 noSmithyDocumentSerde @@ -178,20 +177,20 @@ type CapacityProviderStrategyItem struct { // A JSON string which you can use to limit the event bus permissions you are // granting to only accounts that fulfill the condition. Currently, the only // supported condition is membership in a certain Amazon Web Services organization. -// The string must contain Type, Key, and Value fields. The Value field specifies -// the ID of the Amazon Web Services organization. Following is an example value -// for Condition: '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": -// "o-1234567890"}' +// The string must contain Type , Key , and Value fields. The Value field +// specifies the ID of the Amazon Web Services organization. Following is an +// example value for Condition : '{"Type" : "StringEquals", "Key": +// "aws:PrincipalOrgID", "Value": "o-1234567890"}' type Condition struct { // Specifies the key for the condition. Currently the only supported key is - // aws:PrincipalOrgID. + // aws:PrincipalOrgID . // // This member is required. Key *string // Specifies the type of condition. Currently the only supported value is - // StringEquals. + // StringEquals . // // This member is required. Type *string @@ -236,8 +235,8 @@ type Connection struct { noSmithyDocumentSerde } -// Contains the authorization parameters for the connection if API Key is specified -// as the authorization type. +// Contains the authorization parameters for the connection if API Key is +// specified as the authorization type. type ConnectionApiKeyAuthResponseParameters struct { // The name of the header to use for the APIKeyValue used for authorization. @@ -339,8 +338,9 @@ type ConnectionOAuthResponseParameters struct { // The URL to the HTTP endpoint that authorized the request. AuthorizationEndpoint *string - // A ConnectionOAuthClientResponseParameters object that contains details about the - // client parameters returned when OAuth is specified as the authorization type. + // A ConnectionOAuthClientResponseParameters object that contains details about + // the client parameters returned when OAuth is specified as the authorization + // type. ClientParameters *ConnectionOAuthClientResponseParameters // The method used to connect to the HTTP endpoint. @@ -398,8 +398,8 @@ type CreateConnectionAuthRequestParameters struct { // A ConnectionHttpParameters object that contains the API key authorization // parameters to use for the connection. Note that if you include additional - // parameters for the target of a rule via HttpParameters, including query strings, - // the parameters added for the connection take precedence. + // parameters for the target of a rule via HttpParameters , including query + // strings, the parameters added for the connection take precedence. InvocationHttpParameters *ConnectionHttpParameters // A CreateConnectionOAuthRequestParameters object that contains the OAuth @@ -488,20 +488,19 @@ type EcsParameters struct { TaskDefinitionArn *string // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be omitted. - // If no capacityProviderStrategy or launchType is specified, the + // capacityProviderStrategy is specified, the launchType parameter must be + // omitted. If no capacityProviderStrategy or launchType is specified, the // defaultCapacityProviderStrategy for the cluster is used. CapacityProviderStrategy []CapacityProviderStrategyItem // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool - // Whether or not to enable the execute command functionality for the containers in - // this task. If true, this enables execute command functionality on all containers - // in the task. + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. EnableExecuteCommand bool // Specifies an ECS task group for the task. The maximum length is 255 characters. @@ -510,8 +509,7 @@ type EcsParameters struct { // Specifies the launch type on which your task is running. The launch type that // you specify here must match one of the launch type (compatibilities) of the // target task. The FARGATE value is supported only in the Regions where Fargate - // with Amazon ECS is supported. For more information, see Fargate on Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // with Amazon ECS is supported. For more information, see Fargate on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType @@ -523,27 +521,26 @@ type EcsParameters struct { // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration - // An array of placement constraint objects to use for the task. You can specify up - // to 10 constraints per task (including constraints in the task definition and + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition and // those specified at runtime). PlacementConstraints []PlacementConstraint - // The placement strategy objects to use for the task. You can specify a maximum of - // five strategy rules per task. + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. PlacementStrategy []PlacementStrategy - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. This structure is used only if LaunchType - // is FARGATE. For more information about valid platform versions, see Fargate - // Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Specifies the platform version for the task. Specify only the numeric portion + // of the platform version, such as 1.1.0 . This structure is used only if + // LaunchType is FARGATE . For more information about valid platform versions, see + // Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags are not propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource API action. + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use the TagResource API action. PropagateTags PropagateTags // The reference ID to use for the task. @@ -551,21 +548,20 @@ type EcsParameters struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you - // define. To learn more, see RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) // in the Amazon ECS API Reference. Tags []Tag - // The number of tasks to create based on TaskDefinition. The default is 1. + // The number of tasks to create based on TaskDefinition . The default is 1. TaskCount *int32 noSmithyDocumentSerde } // A global endpoint used to improve your application's availability by making it -// regional-fault tolerant. For more information about global endpoints, see Making -// applications Regional-fault tolerant with global endpoints and event replication -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) +// regional-fault tolerant. For more information about global endpoints, see +// Making applications Regional-fault tolerant with global endpoints and event +// replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) // in the Amazon EventBridge User Guide. type Endpoint struct { @@ -580,7 +576,7 @@ type Endpoint struct { // The URL subdomain of the endpoint. For example, if the URL for Endpoint is // https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is - // abcde.veo. + // abcde.veo . EndpointId *string // The URL of the endpoint. @@ -595,9 +591,10 @@ type Endpoint struct { // The name of the endpoint. Name *string - // Whether event replication was enabled or disabled for this endpoint. The default - // state is ENABLED which means you must supply a RoleArn. If you don't have a - // RoleArn or you don't want event replication enabled, set the state to DISABLED. + // Whether event replication was enabled or disabled for this endpoint. The + // default state is ENABLED which means you must supply a RoleArn . If you don't + // have a RoleArn or you don't want event replication enabled, set the state to + // DISABLED . ReplicationConfig *ReplicationConfig // The ARN of the role used by event replication for the endpoint. @@ -626,8 +623,8 @@ type EndpointEventBus struct { noSmithyDocumentSerde } -// An event bus receives events from a source, uses rules to evaluate them, applies -// any configured input transformation, and routes them to the appropriate +// An event bus receives events from a source, uses rules to evaluate them, +// applies any configured input transformation, and routes them to the appropriate // target(s). Your account's default event bus receives events from Amazon Web // Services services. A custom event bus can receive events from your custom // applications and services. A partner event bus receives events from an event @@ -679,8 +676,8 @@ type EventSource struct { noSmithyDocumentSerde } -// The failover configuration for an endpoint. This includes what triggers failover -// and what happens when it's triggered. +// The failover configuration for an endpoint. This includes what triggers +// failover and what happens when it's triggered. type FailoverConfig struct { // The main Region of the endpoint. @@ -703,8 +700,8 @@ type FailoverConfig struct { // Connection taking precedence. type HttpParameters struct { - // The headers that need to be sent as part of request invoking the API Gateway API - // or EventBridge ApiDestination. + // The headers that need to be sent as part of request invoking the API Gateway + // API or EventBridge ApiDestination. HeaderParameters map[string]string // The path parameter values to be used to populate API Gateway API or EventBridge @@ -718,49 +715,39 @@ type HttpParameters struct { noSmithyDocumentSerde } -// Contains the parameters needed for you to provide custom input to a target based -// on one or more pieces of data extracted from the event. +// Contains the parameters needed for you to provide custom input to a target +// based on one or more pieces of data extracted from the event. type InputTransformer struct { // Input template where you specify placeholders that will be filled with the // values of the keys from InputPathsMap to customize the data sent to the target. // Enclose each InputPathsMaps value in brackets: If InputTemplate is a // JSON object (surrounded by curly braces), the following restrictions apply: - // - // * - // The placeholder cannot be used as an object key. - // - // The following example shows - // the syntax for using InputPathsMap and InputTemplate. "InputTransformer": - // - // { + // - The placeholder cannot be used as an object key. + // The following example shows the syntax for using InputPathsMap and InputTemplate + // . "InputTransformer": + // { // // "InputPathsMap": {"instance": "$.detail.instance","status": - // "$.detail.status"}, + // "$.detail.status"}, // // "InputTemplate": " is in state " - // - // } To have the - // InputTemplate include quote marks within a JSON string, escape each quote marks - // with a slash, as in the following example: "InputTransformer": + // } To have the InputTemplate include quote marks within a JSON string, escape + // each quote marks with a slash, as in the following example: "InputTransformer": // { // - // - // "InputPathsMap": {"instance": "$.detail.instance","status": - // "$.detail.status"}, + // "InputPathsMap": {"instance": "$.detail.instance","status": + // "$.detail.status"}, // // "InputTemplate": " is in state \"\"" - // - // } The - // InputTemplate can also be valid JSON with varibles in quotes or out, as in the - // following example: "InputTransformer": + // } The InputTemplate can also be valid JSON with varibles in quotes or out, as + // in the following example: "InputTransformer": // { // - // "InputPathsMap": {"instance": - // "$.detail.instance","status": "$.detail.status"}, + // "InputPathsMap": {"instance": "$.detail.instance","status": + // "$.detail.status"}, // - // "InputTemplate": - // '{"myInstance": ,"myStatus": " is in state \"\""}' + // "InputTemplate": '{"myInstance": ,"myStatus": " is in state \"\""}' // // } // @@ -778,15 +765,14 @@ type InputTransformer struct { noSmithyDocumentSerde } -// This object enables you to specify a JSON path to extract from the event and use -// as the partition key for the Amazon Kinesis data stream, so that you can control -// the shard to which the event goes. If you do not include this parameter, the -// default is to use the eventId as the partition key. +// This object enables you to specify a JSON path to extract from the event and +// use as the partition key for the Amazon Kinesis data stream, so that you can +// control the shard to which the event goes. If you do not include this parameter, +// the default is to use the eventId as the partition key. type KinesisParameters struct { // The JSON path to be extracted from the event and used as the partition key. For - // more information, see Amazon Kinesis Streams Key Concepts - // (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) + // more information, see Amazon Kinesis Streams Key Concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) // in the Amazon Kinesis Streams Developer Guide. // // This member is required. @@ -844,15 +830,13 @@ type PartnerEventSourceAccount struct { } // An object representing a constraint on task placement. To learn more, see Task -// Placement Constraints -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. You cannot - // specify an expression if the constraint type is distinctInstance. To learn more, - // see Cluster Query Language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // specify an expression if the constraint type is distinctInstance . To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string @@ -865,8 +849,7 @@ type PlacementConstraint struct { } // The task placement strategy for a task or service. To learn more, see Task -// Placement Strategies -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) // in the Amazon Elastic Container Service Service Developer Guide. type PlacementStrategy struct { @@ -918,7 +901,7 @@ type PutEventsRequestEntry struct { // the default event bus is used. If you're using a global endpoint with a custom // bus, you must enter the name, not the ARN, of the event bus in either the // primary or secondary Region here and the corresponding event bus in the other - // Region will be determined based on the endpoint referenced by the EndpointId. + // Region will be determined based on the endpoint referenced by the EndpointId . EventBusName *string // Amazon Web Services resources, identified by Amazon Resource Name (ARN), which @@ -928,17 +911,14 @@ type PutEventsRequestEntry struct { // The source of the event. Source *string - // The time stamp of the event, per RFC3339 - // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the - // time stamp of the PutEvents - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) + // The time stamp of the event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt) + // . If no time stamp is provided, the time stamp of the PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) // call is used. Time *time.Time // An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains // the trace-id associated with the event. To learn more about X-Ray trace headers, - // see Tracing header - // (https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) + // see Tracing header (https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) // in the X-Ray Developer Guide. TraceHeader *string @@ -946,8 +926,8 @@ type PutEventsRequestEntry struct { } // Represents an event that failed to be submitted. For information about the -// errors that are common to all actions, see Common Errors -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html). +// errors that are common to all actions, see Common Errors (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html) +// . type PutEventsResultEntry struct { // The error code that indicates why the event submission failed. @@ -969,8 +949,8 @@ type PutPartnerEventsRequestEntry struct { // contain fields and nested subobjects. Detail *string - // A free-form string, with a maximum of 128 characters, used to decide what fields - // to expect in the event detail. + // A free-form string, with a maximum of 128 characters, used to decide what + // fields to expect in the event detail. DetailType *string // Amazon Web Services resources, identified by Amazon Resource Name (ARN), which @@ -1005,7 +985,7 @@ type PutPartnerEventsResultEntry struct { type PutTargetsResultEntry struct { // The error code that indicates why the target addition failed. If the value is - // ConcurrentModificationException, too many requests were made at the same time. + // ConcurrentModificationException , too many requests were made at the same time. ErrorCode *string // The error message that explains why the target addition failed. @@ -1038,12 +1018,12 @@ type RedshiftDataParameters struct { // Serverless workgroup. DbUser *string - // The name or ARN of the secret that enables access to the database. Required when - // authenticating using Amazon Web Services Secrets Manager. + // The name or ARN of the secret that enables access to the database. Required + // when authenticating using Amazon Web Services Secrets Manager. SecretManagerArn *string - // The name of the SQL statement. You can name the SQL statement when you create it - // to identify the query. + // The name of the SQL statement. You can name the SQL statement when you create + // it to identify the query. StatementName *string // Indicates whether to send an event back to EventBridge after the SQL statement @@ -1057,7 +1037,7 @@ type RedshiftDataParameters struct { type RemoveTargetsResultEntry struct { // The error code that indicates why the target removal failed. If the value is - // ConcurrentModificationException, too many requests were made at the same time. + // ConcurrentModificationException , too many requests were made at the same time. ErrorCode *string // The error message that explains why the target removal failed. @@ -1083,8 +1063,8 @@ type Replay struct { EventSourceArn *string // A time stamp for the time to start replaying events. This is determined by the - // time in the event as described in Time - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time). + // time in the event as described in Time (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time) + // . EventStartTime *time.Time // A time stamp for the time that the replay completed. @@ -1146,8 +1126,8 @@ type RetryPolicy struct { // The routing configuration of the endpoint. type RoutingConfig struct { - // The failover configuration for an endpoint. This includes what triggers failover - // and what happens when it's triggered. + // The failover configuration for an endpoint. This includes what triggers + // failover and what happens when it's triggered. // // This member is required. FailoverConfig *FailoverConfig @@ -1164,13 +1144,12 @@ type Rule struct { // The description of the rule. Description *string - // The name or ARN of the event bus associated with the rule. If you omit this, the - // default event bus is used. + // The name or ARN of the event bus associated with the rule. If you omit this, + // the default event bus is used. EventBusName *string // The event pattern of the rule. For more information, see Events and Event - // Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. EventPattern *string @@ -1189,10 +1168,10 @@ type Rule struct { // Target structure, instead of here in this parameter. RoleArn *string - // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". - // For more information, see Creating an Amazon EventBridge rule that runs on a - // schedule - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html). + // The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 + // minutes)". For more information, see Creating an Amazon EventBridge rule that + // runs on a schedule (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) + // . ScheduleExpression *string // The state of the rule. @@ -1205,8 +1184,8 @@ type Rule struct { // specify which EC2 instances are to be sent the command. type RunCommandParameters struct { - // Currently, we support including only one RunCommandTarget block, which specifies - // either an array of InstanceIds or a tag. + // Currently, we support including only one RunCommandTarget block, which + // specifies either an array of InstanceIds or a tag. // // This member is required. RunCommandTargets []RunCommandTarget @@ -1219,12 +1198,12 @@ type RunCommandParameters struct { // this key may specify multiple values. type RunCommandTarget struct { - // Can be either tag: tag-key or InstanceIds. + // Can be either tag: tag-key or InstanceIds . // // This member is required. Key *string - // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, + // If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds , // Values is a list of Amazon EC2 instance IDs. // // This member is required. @@ -1250,8 +1229,8 @@ type SageMakerPipelineParameter struct { noSmithyDocumentSerde } -// These are custom parameters to use when the target is a SageMaker Model Building -// Pipeline that starts based on EventBridge events. +// These are custom parameters to use when the target is a SageMaker Model +// Building Pipeline that starts based on EventBridge events. type SageMakerPipelineParameters struct { // List of Parameter names and values for SageMaker Model Building Pipeline @@ -1301,15 +1280,14 @@ type Tag struct { noSmithyDocumentSerde } -// Targets are the resources to be invoked when a rule is triggered. For a complete -// list of services and resources that can be set as a target, see PutTargets -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html). -// If you are setting the event bus of another account as the target, and that +// Targets are the resources to be invoked when a rule is triggered. For a +// complete list of services and resources that can be set as a target, see +// PutTargets (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) +// . If you are setting the event bus of another account as the target, and that // account granted permission to your account through an organization instead of // directly by the account ID, then you must specify a RoleArn with proper // permissions in the Target structure. For more information, see Sending and -// Receiving Events Between Amazon Web Services Accounts -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) +// Receiving Events Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) // in the Amazon EventBridge User Guide. type Target struct { @@ -1324,10 +1302,9 @@ type Target struct { // This member is required. Id *string - // If the event target is an Batch job, this contains the job definition, job name, - // and other parameters. For more information, see Jobs - // (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the Batch User - // Guide. + // If the event target is an Batch job, this contains the job definition, job + // name, and other parameters. For more information, see Jobs (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) + // in the Batch User Guide. BatchParameters *BatchParameters // The DeadLetterConfig that defines the target queue to send dead-letter queue @@ -1336,13 +1313,12 @@ type Target struct { // Contains the Amazon ECS task definition and task count to be used, if the event // target is an Amazon ECS task. For more information about Amazon ECS tasks, see - // Task Definitions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) + // Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. EcsParameters *EcsParameters - // Contains the HTTP parameters to use when the target is a API Gateway endpoint or - // EventBridge ApiDestination. If you specify an API Gateway API or EventBridge + // Contains the HTTP parameters to use when the target is a API Gateway endpoint + // or EventBridge ApiDestination. If you specify an API Gateway API or EventBridge // ApiDestination as a target, you can use this parameter to specify headers, path // parameters, and query string keys/values as part of your target invoking // request. If you're using ApiDestinations, the corresponding Connection can also @@ -1352,14 +1328,14 @@ type Target struct { // Valid JSON text passed to the target. In this case, nothing from the event // itself is passed to the target. For more information, see The JavaScript Object - // Notation (JSON) Data Interchange Format - // (http://www.rfc-editor.org/rfc/rfc7159.txt). + // Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt) + // . Input *string // The value of the JSONPath that is used for extracting part of the matched event // when passing it to the target. You may use JSON dot notation or bracket - // notation. For more information about JSON paths, see JSONPath - // (http://goessner.net/articles/JsonPath/). + // notation. For more information about JSON paths, see JSONPath (http://goessner.net/articles/JsonPath/) + // . InputPath *string // Settings to enable you to provide custom input to a target based on certain @@ -1427,8 +1403,8 @@ type UpdateConnectionAuthRequestParameters struct { // authorization parameters for Basic authorization. BasicAuthParameters *UpdateConnectionBasicAuthRequestParameters - // A ConnectionHttpParameters object that contains the additional parameters to use - // for the connection. + // A ConnectionHttpParameters object that contains the additional parameters to + // use for the connection. InvocationHttpParameters *ConnectionHttpParameters // A UpdateConnectionOAuthRequestParameters object that contains the authorization diff --git a/service/evidently/api_client.go b/service/evidently/api_client.go index 536ebdd3a3f..1a01ae52ee2 100644 --- a/service/evidently/api_client.go +++ b/service/evidently/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/evidently/api_op_BatchEvaluateFeature.go b/service/evidently/api_op_BatchEvaluateFeature.go index f5d9cf11883..80724a11778 100644 --- a/service/evidently/api_op_BatchEvaluateFeature.go +++ b/service/evidently/api_op_BatchEvaluateFeature.go @@ -13,8 +13,8 @@ import ( ) // This operation assigns feature variation to user sessions. For each user -// session, you pass in an entityID that represents the user. Evidently then checks -// the evaluation rules and assigns the variation. The first rules that are +// session, you pass in an entityID that represents the user. Evidently then +// checks the evaluation rules and assigns the variation. The first rules that are // evaluated are the override rules. If the user's entityID matches an override // rule, the user is served the variation specified by that rule. Next, if there is // a launch of the feature, the user might be assigned to a variation in the @@ -61,8 +61,8 @@ type BatchEvaluateFeatureInput struct { type BatchEvaluateFeatureOutput struct { - // An array of structures, where each structure displays the results of one feature - // evaluation assignment to one user session. + // An array of structures, where each structure displays the results of one + // feature evaluation assignment to one user session. Results []types.EvaluationResult // Metadata pertaining to the operation's result. diff --git a/service/evidently/api_op_CreateExperiment.go b/service/evidently/api_op_CreateExperiment.go index 8b0afa02ddf..93cdcee8066 100644 --- a/service/evidently/api_op_CreateExperiment.go +++ b/service/evidently/api_op_CreateExperiment.go @@ -20,8 +20,8 @@ import ( // experiment consider only certain audience types in the experiment, such as using // only user sessions from a certain location or who use a certain internet // browser. Don't use this operation to update an existing experiment. Instead, use -// UpdateExperiment -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html). +// UpdateExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html) +// . func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error) { if params == nil { params = &CreateExperimentInput{} @@ -55,8 +55,8 @@ type CreateExperimentInput struct { // This member is required. Project *string - // An array of structures that describe the configuration of each feature variation - // used in the experiment. + // An array of structures that describe the configuration of each feature + // variation used in the experiment. // // This member is required. Treatments []types.TreatmentConfig @@ -70,11 +70,11 @@ type CreateExperimentInput struct { // allocated to each variation. OnlineAbConfig *types.OnlineAbConfig - // When Evidently assigns a particular user session to an experiment, it must use a - // randomization ID to determine which variation the user session is served. This - // randomization ID is a combination of the entity ID and randomizationSalt. If you - // omit randomizationSalt, Evidently uses the experiment name as the - // randomizationSalt. + // When Evidently assigns a particular user session to an experiment, it must use + // a randomization ID to determine which variation the user session is served. This + // randomization ID is a combination of the entity ID and randomizationSalt . If + // you omit randomizationSalt , Evidently uses the experiment name as the + // randomizationSalt . RandomizationSalt *string // The portion of the available audience that you want to allocate to this @@ -95,8 +95,8 @@ type CreateExperimentInput struct { // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with an experiment. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/evidently/api_op_CreateFeature.go b/service/evidently/api_op_CreateFeature.go index 64ace1eecfe..af8b1521c0a 100644 --- a/service/evidently/api_op_CreateFeature.go +++ b/service/evidently/api_op_CreateFeature.go @@ -14,11 +14,10 @@ import ( // Creates an Evidently feature that you want to launch or test. You can define up // to five variations of a feature, and use these variations in your launches and // experiments. A feature must be created in a project. For information about -// creating a project, see CreateProject -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). -// Don't use this operation to update an existing feature. Instead, use -// UpdateFeature -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html). +// creating a project, see CreateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html) +// . Don't use this operation to update an existing feature. Instead, use +// UpdateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html) +// . func (c *Client) CreateFeature(ctx context.Context, params *CreateFeatureInput, optFns ...func(*Options)) (*CreateFeatureOutput, error) { if params == nil { params = &CreateFeatureInput{} @@ -46,17 +45,17 @@ type CreateFeatureInput struct { // This member is required. Project *string - // An array of structures that contain the configuration of the feature's different - // variations. + // An array of structures that contain the configuration of the feature's + // different variations. // // This member is required. Variations []types.VariationConfig - // The name of the variation to use as the default variation. The default variation - // is served to users who are not allocated to any ongoing launches or experiments - // of this feature. This variation must also be listed in the variations structure. - // If you omit defaultVariation, the first variation listed in the variations - // structure is used as the default variation. + // The name of the variation to use as the default variation. The default + // variation is served to users who are not allocated to any ongoing launches or + // experiments of this feature. This variation must also be listed in the + // variations structure. If you omit defaultVariation , the first variation listed + // in the variations structure is used as the default variation. DefaultVariation *string // An optional description of the feature. @@ -81,8 +80,8 @@ type CreateFeatureInput struct { // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with a feature. For more information, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/evidently/api_op_CreateLaunch.go b/service/evidently/api_op_CreateLaunch.go index 27dc3d5974c..11ed68cde13 100644 --- a/service/evidently/api_op_CreateLaunch.go +++ b/service/evidently/api_op_CreateLaunch.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a launch of a given feature. Before you create a launch, you must create -// the feature to use for the launch. You can use a launch to safely validate new -// features by serving them to a specified percentage of your users while you roll -// out the feature. You can monitor the performance of the new feature to help you -// decide when to ramp up traffic to more users. This helps you reduce risk and -// identify unintended consequences before you fully launch the feature. Don't use -// this operation to update an existing launch. Instead, use UpdateLaunch -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html). +// Creates a launch of a given feature. Before you create a launch, you must +// create the feature to use for the launch. You can use a launch to safely +// validate new features by serving them to a specified percentage of your users +// while you roll out the feature. You can monitor the performance of the new +// feature to help you decide when to ramp up traffic to more users. This helps you +// reduce risk and identify unintended consequences before you fully launch the +// feature. Don't use this operation to update an existing launch. Instead, use +// UpdateLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html) +// . func (c *Client) CreateLaunch(ctx context.Context, params *CreateLaunchInput, optFns ...func(*Options)) (*CreateLaunchOutput, error) { if params == nil { params = &CreateLaunchInput{} @@ -61,8 +62,9 @@ type CreateLaunchInput struct { // When Evidently assigns a particular user session to a launch, it must use a // randomization ID to determine which variation the user session is served. This - // randomization ID is a combination of the entity ID and randomizationSalt. If you - // omit randomizationSalt, Evidently uses the launch name as the randomizationSalt. + // randomization ID is a combination of the entity ID and randomizationSalt . If + // you omit randomizationSalt , Evidently uses the launch name as the + // randomizationSalt . RandomizationSalt *string // An array of structures that define the traffic allocation percentages among the @@ -75,8 +77,8 @@ type CreateLaunchInput struct { // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with a launch. For more information, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/evidently/api_op_CreateProject.go b/service/evidently/api_op_CreateProject.go index 81425d7097f..fe6f7d41845 100644 --- a/service/evidently/api_op_CreateProject.go +++ b/service/evidently/api_op_CreateProject.go @@ -13,8 +13,8 @@ import ( // Creates a project, which is the logical object in Evidently that can contain // features, launches, and experiments. Use projects to group similar features -// together. To update an existing project, use UpdateProject -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html). +// together. To update an existing project, use UpdateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html) +// . func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error) { if params == nil { params = &CreateProjectInput{} @@ -39,12 +39,10 @@ type CreateProjectInput struct { // Use this parameter if the project will use client-side evaluation powered by // AppConfig. Client-side evaluation allows your application to assign variations - // to user sessions locally instead of by calling the EvaluateFeature - // (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) + // to user sessions locally instead of by calling the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) // operation. This mitigates the latency and availability risks that come with an - // API call. For more information, see Client-side evaluation - powered by - // AppConfig. - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) + // API call. For more information, see Client-side evaluation - powered by + // AppConfig. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) // This parameter is a structure that contains information about the AppConfig // application and environment that will be used as for client-side evaluation. To // create a project that uses client-side evaluation, you must have the @@ -66,8 +64,8 @@ type CreateProjectInput struct { // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with a project. For more information, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/evidently/api_op_CreateSegment.go b/service/evidently/api_op_CreateSegment.go index 140abaf244f..7a87a622e23 100644 --- a/service/evidently/api_op_CreateSegment.go +++ b/service/evidently/api_op_CreateSegment.go @@ -18,11 +18,9 @@ import ( // segment in an experiment limits that experiment to evaluate only the users who // match the segment criteria. Using one or more segments in a launch allows you to // define different traffic splits for the different audience segments. For more -// information about segment pattern syntax, see Segment rule pattern syntax -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html). -// The pattern that you define for a segment is matched against the value of -// evaluationContext, which is passed into Evidently in the EvaluateFeature -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) +// information about segment pattern syntax, see Segment rule pattern syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html) +// . The pattern that you define for a segment is matched against the value of +// evaluationContext , which is passed into Evidently in the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) // operation, when Evidently assigns a feature variation to a user. func (c *Client) CreateSegment(ctx context.Context, params *CreateSegmentInput, optFns ...func(*Options)) (*CreateSegmentOutput, error) { if params == nil { @@ -47,8 +45,8 @@ type CreateSegmentInput struct { Name *string // The pattern to use for the segment. For more information about pattern syntax, - // see Segment rule pattern syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html). + // see Segment rule pattern syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html) + // . // // This value conforms to the media type: application/json // @@ -64,8 +62,8 @@ type CreateSegmentInput struct { // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with a segment. For more information, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/evidently/api_op_DeleteExperiment.go b/service/evidently/api_op_DeleteExperiment.go index d9f035b9867..94d7fc402c9 100644 --- a/service/evidently/api_op_DeleteExperiment.go +++ b/service/evidently/api_op_DeleteExperiment.go @@ -11,8 +11,8 @@ import ( ) // Deletes an Evidently experiment. The feature used for the experiment is not -// deleted. To stop an experiment without deleting it, use StopExperiment -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html). +// deleted. To stop an experiment without deleting it, use StopExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html) +// . func (c *Client) DeleteExperiment(ctx context.Context, params *DeleteExperimentInput, optFns ...func(*Options)) (*DeleteExperimentOutput, error) { if params == nil { params = &DeleteExperimentInput{} diff --git a/service/evidently/api_op_DeleteLaunch.go b/service/evidently/api_op_DeleteLaunch.go index 49af7cd849f..b5707bbb88e 100644 --- a/service/evidently/api_op_DeleteLaunch.go +++ b/service/evidently/api_op_DeleteLaunch.go @@ -11,8 +11,8 @@ import ( ) // Deletes an Evidently launch. The feature used for the launch is not deleted. To -// stop a launch without deleting it, use StopLaunch -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopLaunch.html). +// stop a launch without deleting it, use StopLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopLaunch.html) +// . func (c *Client) DeleteLaunch(ctx context.Context, params *DeleteLaunchInput, optFns ...func(*Options)) (*DeleteLaunchOutput, error) { if params == nil { params = &DeleteLaunchInput{} diff --git a/service/evidently/api_op_DeleteProject.go b/service/evidently/api_op_DeleteProject.go index 60b3c6b287f..607a1f8d051 100644 --- a/service/evidently/api_op_DeleteProject.go +++ b/service/evidently/api_op_DeleteProject.go @@ -12,8 +12,8 @@ import ( // Deletes an Evidently project. Before you can delete a project, you must delete // all the features that the project contains. To delete a feature, use -// DeleteFeature -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_DeleteFeature.html). +// DeleteFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_DeleteFeature.html) +// . func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/evidently/api_op_EvaluateFeature.go b/service/evidently/api_op_EvaluateFeature.go index 7c94192f423..3a6a56a335a 100644 --- a/service/evidently/api_op_EvaluateFeature.go +++ b/service/evidently/api_op_EvaluateFeature.go @@ -20,12 +20,10 @@ import ( // this feature that uses segment overrides, and if the user session's // evaluationContext matches a segment rule defined in a segment override, the // configuration in the segment overrides is used. For more information about -// segments, see CreateSegment -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html) -// and Use segments to focus your audience -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html). -// If there is a launch with no segment overrides, the user might be assigned to a -// variation in the launch. The chance of this depends on the percentage of users +// segments, see CreateSegment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html) +// and Use segments to focus your audience (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) +// . If there is a launch with no segment overrides, the user might be assigned to +// a variation in the launch. The chance of this depends on the percentage of users // that are allocated to that launch. If the user is enrolled in the launch, the // variation they are served depends on the allocation of the various feature // variations used for the launch. If the user is not assigned to a launch, and @@ -73,10 +71,9 @@ type EvaluateFeatureInput struct { // A JSON object of attributes that you can optionally pass in as part of the // evaluation event sent to Evidently from the user session. Evidently can use this // value to match user sessions with defined audience segments. For more - // information, see Use segments to focus your audience - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html). - // If you include this parameter, the value must be a JSON object. A JSON array is - // not supported. + // information, see Use segments to focus your audience (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) + // . If you include this parameter, the value must be a JSON object. A JSON array + // is not supported. // // This value conforms to the media type: application/json EvaluationContext *string @@ -86,17 +83,17 @@ type EvaluateFeatureInput struct { type EvaluateFeatureOutput struct { - // If this user was assigned to a launch or experiment, this field lists the launch - // or experiment name. + // If this user was assigned to a launch or experiment, this field lists the + // launch or experiment name. // // This value conforms to the media type: application/json Details *string - // Specifies the reason that the user session was assigned this variation. Possible - // values include DEFAULT, meaning the user was served the default variation; - // LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; - // EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or - // ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule. + // Specifies the reason that the user session was assigned this variation. + // Possible values include DEFAULT , meaning the user was served the default + // variation; LAUNCH_RULE_MATCH , if the user session was enrolled in a launch; + // EXPERIMENT_RULE_MATCH , if the user session was enrolled in an experiment; or + // ENTITY_OVERRIDES_MATCH , if the user's entityId matches an override rule. Reason *string // The value assigned to this variation to differentiate it from the other diff --git a/service/evidently/api_op_GetExperiment.go b/service/evidently/api_op_GetExperiment.go index 859e69d4c83..71d543c1b39 100644 --- a/service/evidently/api_op_GetExperiment.go +++ b/service/evidently/api_op_GetExperiment.go @@ -12,8 +12,8 @@ import ( ) // Returns the details about one experiment. You must already know the experiment -// name. To retrieve a list of experiments in your account, use ListExperiments -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListExperiments.html). +// name. To retrieve a list of experiments in your account, use ListExperiments (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListExperiments.html) +// . func (c *Client) GetExperiment(ctx context.Context, params *GetExperimentInput, optFns ...func(*Options)) (*GetExperimentOutput, error) { if params == nil { params = &GetExperimentInput{} diff --git a/service/evidently/api_op_GetExperimentResults.go b/service/evidently/api_op_GetExperimentResults.go index 59212c1315b..70f7a1c2570 100644 --- a/service/evidently/api_op_GetExperimentResults.go +++ b/service/evidently/api_op_GetExperimentResults.go @@ -48,8 +48,8 @@ type GetExperimentResultsInput struct { // This member is required. MetricNames []string - // The name or ARN of the project that contains the experiment that you want to see - // the results of. + // The name or ARN of the project that contains the experiment that you want to + // see the results of. // // This member is required. Project *string @@ -60,11 +60,11 @@ type GetExperimentResultsInput struct { TreatmentNames []string // The statistic used to calculate experiment results. Currently the only valid - // value is mean, which uses the mean of the collected values as the statistic. + // value is mean , which uses the mean of the collected values as the statistic. BaseStat types.ExperimentBaseStat - // The date and time that the experiment ended, if it is completed. This must be no - // longer than 30 days after the experiment start time. + // The date and time that the experiment ended, if it is completed. This must be + // no longer than 30 days after the experiment start time. EndTime *time.Time // In seconds, the amount of time to aggregate results together. @@ -75,27 +75,21 @@ type GetExperimentResultsInput struct { ReportNames []types.ExperimentReportName // The statistics that you want to see in the returned results. - // - // * PValue specifies - // to use p-values for the results. A p-value is used in hypothesis testing to - // measure how often you are willing to make a mistake in rejecting the null - // hypothesis. A general practice is to reject the null hypothesis and declare that - // the results are statistically significant when the p-value is less than 0.05. - // - // * - // ConfidenceInterval specifies a confidence interval for the results. The - // confidence interval represents the range of values for the chosen metric that is - // likely to contain the true difference between the baseStat of a variation and - // the baseline. Evidently returns the 95% confidence interval. - // - // * TreatmentEffect - // is the difference in the statistic specified by the baseStat parameter between - // each variation and the default variation. - // - // * BaseStat returns the statistical - // values collected for the metric for each variation. The statistic uses the same - // statistic specified in the baseStat parameter. Therefore, if baseStat is mean, - // this returns the mean of the values collected for each variation. + // - PValue specifies to use p-values for the results. A p-value is used in + // hypothesis testing to measure how often you are willing to make a mistake in + // rejecting the null hypothesis. A general practice is to reject the null + // hypothesis and declare that the results are statistically significant when the + // p-value is less than 0.05. + // - ConfidenceInterval specifies a confidence interval for the results. The + // confidence interval represents the range of values for the chosen metric that is + // likely to contain the true difference between the baseStat of a variation and + // the baseline. Evidently returns the 95% confidence interval. + // - TreatmentEffect is the difference in the statistic specified by the baseStat + // parameter between each variation and the default variation. + // - BaseStat returns the statistical values collected for the metric for each + // variation. The statistic uses the same statistic specified in the baseStat + // parameter. Therefore, if baseStat is mean , this returns the mean of the + // values collected for each variation. ResultStats []types.ExperimentResultRequestType // The date and time that the experiment started. @@ -107,7 +101,7 @@ type GetExperimentResultsInput struct { type GetExperimentResultsOutput struct { // If the experiment doesn't yet have enough events to provide valid results, this - // field is returned with the message Not enough events to generate results. If + // field is returned with the message Not enough events to generate results . If // there are enough events to provide valid results, this field is not returned. Details *string diff --git a/service/evidently/api_op_GetFeature.go b/service/evidently/api_op_GetFeature.go index 789f7b8e188..d1b7ebda05f 100644 --- a/service/evidently/api_op_GetFeature.go +++ b/service/evidently/api_op_GetFeature.go @@ -12,8 +12,8 @@ import ( ) // Returns the details about one feature. You must already know the feature name. -// To retrieve a list of features in your account, use ListFeatures -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListFeatures.html). +// To retrieve a list of features in your account, use ListFeatures (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListFeatures.html) +// . func (c *Client) GetFeature(ctx context.Context, params *GetFeatureInput, optFns ...func(*Options)) (*GetFeatureOutput, error) { if params == nil { params = &GetFeatureInput{} diff --git a/service/evidently/api_op_GetLaunch.go b/service/evidently/api_op_GetLaunch.go index fb2cc12317a..27d5b4ccabb 100644 --- a/service/evidently/api_op_GetLaunch.go +++ b/service/evidently/api_op_GetLaunch.go @@ -12,8 +12,8 @@ import ( ) // Returns the details about one launch. You must already know the launch name. To -// retrieve a list of launches in your account, use ListLaunches -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListLaunches.html). +// retrieve a list of launches in your account, use ListLaunches (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListLaunches.html) +// . func (c *Client) GetLaunch(ctx context.Context, params *GetLaunchInput, optFns ...func(*Options)) (*GetLaunchOutput, error) { if params == nil { params = &GetLaunchInput{} diff --git a/service/evidently/api_op_GetProject.go b/service/evidently/api_op_GetProject.go index be71630957e..a760d6d30b2 100644 --- a/service/evidently/api_op_GetProject.go +++ b/service/evidently/api_op_GetProject.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the details about one launch. You must already know the project name. To -// retrieve a list of projects in your account, use ListProjects -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListProjects.html). +// Returns the details about one launch. You must already know the project name. +// To retrieve a list of projects in your account, use ListProjects (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListProjects.html) +// . func (c *Client) GetProject(ctx context.Context, params *GetProjectInput, optFns ...func(*Options)) (*GetProjectOutput, error) { if params == nil { params = &GetProjectInput{} diff --git a/service/evidently/api_op_GetSegment.go b/service/evidently/api_op_GetSegment.go index 136d1fba050..fcaf9a18731 100644 --- a/service/evidently/api_op_GetSegment.go +++ b/service/evidently/api_op_GetSegment.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the specified segment. Specify the segment you want to -// view by specifying its ARN. +// Returns information about the specified segment. Specify the segment you want +// to view by specifying its ARN. func (c *Client) GetSegment(ctx context.Context, params *GetSegmentInput, optFns ...func(*Options)) (*GetSegmentOutput, error) { if params == nil { params = &GetSegmentInput{} diff --git a/service/evidently/api_op_ListExperiments.go b/service/evidently/api_op_ListExperiments.go index d7ef6d8ecfe..5eea4387d08 100644 --- a/service/evidently/api_op_ListExperiments.go +++ b/service/evidently/api_op_ListExperiments.go @@ -52,8 +52,8 @@ type ListExperimentsInput struct { type ListExperimentsOutput struct { - // An array of structures that contain the configuration details of the experiments - // in the specified project. + // An array of structures that contain the configuration details of the + // experiments in the specified project. Experiments []types.Experiment // The token to use in a subsequent ListExperiments operation to return the next diff --git a/service/evidently/api_op_ListFeatures.go b/service/evidently/api_op_ListFeatures.go index cbe05500896..f4e082f8a5a 100644 --- a/service/evidently/api_op_ListFeatures.go +++ b/service/evidently/api_op_ListFeatures.go @@ -47,8 +47,8 @@ type ListFeaturesInput struct { type ListFeaturesOutput struct { - // An array of structures that contain the configuration details of the features in - // the specified project. + // An array of structures that contain the configuration details of the features + // in the specified project. Features []types.FeatureSummary // The token to use in a subsequent ListFeatures operation to return the next set diff --git a/service/evidently/api_op_ListLaunches.go b/service/evidently/api_op_ListLaunches.go index 4b902717b33..1f3a7bb7814 100644 --- a/service/evidently/api_op_ListLaunches.go +++ b/service/evidently/api_op_ListLaunches.go @@ -51,8 +51,8 @@ type ListLaunchesInput struct { type ListLaunchesOutput struct { - // An array of structures that contain the configuration details of the launches in - // the specified project. + // An array of structures that contain the configuration details of the launches + // in the specified project. Launches []types.Launch // The token to use in a subsequent ListLaunches operation to return the next set diff --git a/service/evidently/api_op_ListProjects.go b/service/evidently/api_op_ListProjects.go index 0a6fec8d3f9..cbc95d6f794 100644 --- a/service/evidently/api_op_ListProjects.go +++ b/service/evidently/api_op_ListProjects.go @@ -47,8 +47,8 @@ type ListProjectsOutput struct { // of results. NextToken *string - // An array of structures that contain the configuration details of the projects in - // the Region. + // An array of structures that contain the configuration details of the projects + // in the Region. Projects []types.ProjectSummary // Metadata pertaining to the operation's result. diff --git a/service/evidently/api_op_StartExperiment.go b/service/evidently/api_op_StartExperiment.go index 2363213c16f..7c18201846b 100644 --- a/service/evidently/api_op_StartExperiment.go +++ b/service/evidently/api_op_StartExperiment.go @@ -11,8 +11,8 @@ import ( "time" ) -// Starts an existing experiment. To create an experiment, use CreateExperiment -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateExperiment.html). +// Starts an existing experiment. To create an experiment, use CreateExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateExperiment.html) +// . func (c *Client) StartExperiment(ctx context.Context, params *StartExperimentInput, optFns ...func(*Options)) (*StartExperimentOutput, error) { if params == nil { params = &StartExperimentInput{} @@ -30,8 +30,8 @@ func (c *Client) StartExperiment(ctx context.Context, params *StartExperimentInp type StartExperimentInput struct { - // The date and time to end the experiment. This must be no more than 30 days after - // the experiment starts. + // The date and time to end the experiment. This must be no more than 30 days + // after the experiment starts. // // This member is required. AnalysisCompleteTime *time.Time diff --git a/service/evidently/api_op_StartLaunch.go b/service/evidently/api_op_StartLaunch.go index 25702d73312..b52e3fc5b91 100644 --- a/service/evidently/api_op_StartLaunch.go +++ b/service/evidently/api_op_StartLaunch.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an existing launch. To create a launch, use CreateLaunch -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateLaunch.html). +// Starts an existing launch. To create a launch, use CreateLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateLaunch.html) +// . func (c *Client) StartLaunch(ctx context.Context, params *StartLaunchInput, optFns ...func(*Options)) (*StartLaunchOutput, error) { if params == nil { params = &StartLaunchInput{} diff --git a/service/evidently/api_op_TagResource.go b/service/evidently/api_op_TagResource.go index 7ccc6fa5236..ecfda2c78e7 100644 --- a/service/evidently/api_op_TagResource.go +++ b/service/evidently/api_op_TagResource.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently -// resource. Projects, features, launches, and experiments can be tagged. Tags can -// help you organize and categorize your resources. You can also use them to scope -// user permissions by granting a user permission to access or change only +// Assigns one or more tags (key-value pairs) to the specified CloudWatch +// Evidently resource. Projects, features, launches, and experiments can be tagged. +// Tags can help you organize and categorize your resources. You can also use them +// to scope user permissions by granting a user permission to access or change only // resources with certain tag values. Tags don't have any semantic meaning to // Amazon Web Services and are interpreted strictly as strings of characters. You // can use the TagResource action with a resource that already has tags. If you @@ -21,8 +21,8 @@ import ( // associated with the alarm. If you specify a tag key that is already associated // with the resource, the new tag value that you specify replaces the previous // value for that tag. You can associate as many as 50 tags with a resource. For -// more information, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). +// more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/evidently/api_op_TestSegmentPattern.go b/service/evidently/api_op_TestSegmentPattern.go index 0cda240e1a3..ca3eea92047 100644 --- a/service/evidently/api_op_TestSegmentPattern.go +++ b/service/evidently/api_op_TestSegmentPattern.go @@ -11,8 +11,8 @@ import ( ) // Use this operation to test a rules pattern that you plan to use to create an -// audience segment. For more information about segments, see CreateSegment -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html). +// audience segment. For more information about segments, see CreateSegment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html) +// . func (c *Client) TestSegmentPattern(ctx context.Context, params *TestSegmentPatternInput, optFns ...func(*Options)) (*TestSegmentPatternOutput, error) { if params == nil { params = &TestSegmentPatternInput{} diff --git a/service/evidently/api_op_UpdateExperiment.go b/service/evidently/api_op_UpdateExperiment.go index 0890a8dfbcb..5a81028f49a 100644 --- a/service/evidently/api_op_UpdateExperiment.go +++ b/service/evidently/api_op_UpdateExperiment.go @@ -12,8 +12,8 @@ import ( ) // Updates an Evidently experiment. Don't use this operation to update an -// experiment's tag. Instead, use TagResource -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html). +// experiment's tag. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateExperiment(ctx context.Context, params *UpdateExperimentInput, optFns ...func(*Options)) (*UpdateExperimentOutput, error) { if params == nil { params = &UpdateExperimentInput{} @@ -55,15 +55,15 @@ type UpdateExperimentInput struct { // allocated to each variation. OnlineAbConfig *types.OnlineAbConfig - // When Evidently assigns a particular user session to an experiment, it must use a - // randomization ID to determine which variation the user session is served. This - // randomization ID is a combination of the entity ID and randomizationSalt. If you - // omit randomizationSalt, Evidently uses the experiment name as the - // randomizationSalt. + // When Evidently assigns a particular user session to an experiment, it must use + // a randomization ID to determine which variation the user session is served. This + // randomization ID is a combination of the entity ID and randomizationSalt . If + // you omit randomizationSalt , Evidently uses the experiment name as the + // randomizationSalt . RandomizationSalt *string - // Removes a segment from being used in an experiment. You can't use this parameter - // if the experiment is currently running. + // Removes a segment from being used in an experiment. You can't use this + // parameter if the experiment is currently running. RemoveSegment bool // The portion of the available audience that you want to allocate to this diff --git a/service/evidently/api_op_UpdateFeature.go b/service/evidently/api_op_UpdateFeature.go index 5bad65bfe0a..45afd8f9762 100644 --- a/service/evidently/api_op_UpdateFeature.go +++ b/service/evidently/api_op_UpdateFeature.go @@ -12,8 +12,8 @@ import ( ) // Updates an existing feature. You can't use this operation to update the tags of -// an existing feature. Instead, use TagResource -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html). +// an existing feature. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateFeature(ctx context.Context, params *UpdateFeatureInput, optFns ...func(*Options)) (*UpdateFeatureOutput, error) { if params == nil { params = &UpdateFeatureInput{} @@ -48,9 +48,9 @@ type UpdateFeatureInput struct { // new variation. AddOrUpdateVariations []types.VariationConfig - // The name of the variation to use as the default variation. The default variation - // is served to users who are not allocated to any ongoing launches or experiments - // of this feature. + // The name of the variation to use as the default variation. The default + // variation is served to users who are not allocated to any ongoing launches or + // experiments of this feature. DefaultVariation *string // An optional description of the feature. diff --git a/service/evidently/api_op_UpdateLaunch.go b/service/evidently/api_op_UpdateLaunch.go index 635c86c1096..e3ac27c6c8e 100644 --- a/service/evidently/api_op_UpdateLaunch.go +++ b/service/evidently/api_op_UpdateLaunch.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a launch of a given feature. Don't use this operation to update the tags -// of an existing launch. Instead, use TagResource -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html). +// Updates a launch of a given feature. Don't use this operation to update the +// tags of an existing launch. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateLaunch(ctx context.Context, params *UpdateLaunchInput, optFns ...func(*Options)) (*UpdateLaunchOutput, error) { if params == nil { params = &UpdateLaunchInput{} @@ -54,8 +54,9 @@ type UpdateLaunchInput struct { // When Evidently assigns a particular user session to a launch, it must use a // randomization ID to determine which variation the user session is served. This - // randomization ID is a combination of the entity ID and randomizationSalt. If you - // omit randomizationSalt, Evidently uses the launch name as the randomizationSalt. + // randomization ID is a combination of the entity ID and randomizationSalt . If + // you omit randomizationSalt , Evidently uses the launch name as the + // randomizationSalt . RandomizationSalt *string // An array of structures that define the traffic allocation percentages among the diff --git a/service/evidently/api_op_UpdateProject.go b/service/evidently/api_op_UpdateProject.go index b89ebf6bf9e..5b1ca51ef4c 100644 --- a/service/evidently/api_op_UpdateProject.go +++ b/service/evidently/api_op_UpdateProject.go @@ -12,14 +12,12 @@ import ( ) // Updates the description of an existing project. To create a new project, use -// CreateProject -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). -// Don't use this operation to update the data storage options of a project. -// Instead, use UpdateProjectDataDelivery -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProjectDataDelivery.html). -// Don't use this operation to update the tags of a project. Instead, use -// TagResource -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html). +// CreateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html) +// . Don't use this operation to update the data storage options of a project. +// Instead, use UpdateProjectDataDelivery (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProjectDataDelivery.html) +// . Don't use this operation to update the tags of a project. Instead, use +// TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error) { if params == nil { params = &UpdateProjectInput{} @@ -44,8 +42,7 @@ type UpdateProjectInput struct { // Use this parameter if the project will use client-side evaluation powered by // AppConfig. Client-side evaluation allows your application to assign variations - // to user sessions locally instead of by calling the EvaluateFeature - // (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) + // to user sessions locally instead of by calling the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) // operation. This mitigates the latency and availability risks that come with an // API call. allows you to This parameter is a structure that contains information // about the AppConfig application that will be used for client-side evaluation. diff --git a/service/evidently/types/enums.go b/service/evidently/types/enums.go index 622b3aad749..b377910c4f9 100644 --- a/service/evidently/types/enums.go +++ b/service/evidently/types/enums.go @@ -28,9 +28,9 @@ const ( EventTypeCustom EventType = "aws.evidently.custom" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "aws.evidently.evaluation", @@ -103,9 +103,10 @@ const ( ExperimentResultResponseTypePValue ExperimentResultResponseType = "PValue" ) -// Values returns all known values for ExperimentResultResponseType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExperimentResultResponseType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ExperimentResultResponseType) Values() []ExperimentResultResponseType { return []ExperimentResultResponseType{ "Mean", @@ -221,9 +222,9 @@ const ( LaunchStatusCancelled LaunchStatus = "CANCELLED" ) -// Values returns all known values for LaunchStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LaunchStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LaunchStatus) Values() []LaunchStatus { return []LaunchStatus{ "CREATED", @@ -294,9 +295,10 @@ const ( SegmentReferenceResourceTypeLaunch SegmentReferenceResourceType = "LAUNCH" ) -// Values returns all known values for SegmentReferenceResourceType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SegmentReferenceResourceType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (SegmentReferenceResourceType) Values() []SegmentReferenceResourceType { return []SegmentReferenceResourceType{ "EXPERIMENT", diff --git a/service/evidently/types/types.go b/service/evidently/types/types.go index b3aa74fd91a..a83b6b50754 100644 --- a/service/evidently/types/types.go +++ b/service/evidently/types/types.go @@ -64,8 +64,8 @@ type EvaluationResult struct { // This member is required. Feature *string - // If this user was assigned to a launch or experiment, this field lists the launch - // or experiment name. + // If this user was assigned to a launch or experiment, this field lists the + // launch or experiment name. // // This value conforms to the media type: application/json Details *string @@ -73,10 +73,10 @@ type EvaluationResult struct { // The name or ARN of the project that contains the feature being evaluated. Project *string - // Specifies the reason that the user session was assigned this variation. Possible - // values include DEFAULT, meaning the user was served the default variation; - // LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; or - // EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment. + // Specifies the reason that the user session was assigned this variation. + // Possible values include DEFAULT , meaning the user was served the default + // variation; LAUNCH_RULE_MATCH , if the user session was enrolled in a launch; or + // EXPERIMENT_RULE_MATCH , if the user session was enrolled in an experiment. Reason *string // The value assigned to this variation to differentiate it from the other @@ -162,7 +162,7 @@ type Experiment struct { Status ExperimentStatus // The type of this experiment. Currently, this value must be - // aws.experiment.onlineab. + // aws.experiment.onlineab . // // This member is required. Type ExperimentType @@ -190,7 +190,7 @@ type Experiment struct { // This value is used when Evidently assigns a particular user session to the // experiment. It helps create a randomization ID to determine which variation the // user session is served. This randomization ID is a combination of the entity ID - // and randomizationSalt. + // and randomizationSalt . RandomizationSalt *string // In thousandths of a percent, the amount of the available audience that is @@ -207,15 +207,15 @@ type Experiment struct { // The audience segment being used for the experiment, if a segment is being used. Segment *string - // If the experiment was stopped, this is the string that was entered by the person - // who stopped the experiment, to explain why it was stopped. + // If the experiment was stopped, this is the string that was entered by the + // person who stopped the experiment, to explain why it was stopped. StatusReason *string // The list of tag keys and values associated with this experiment. Tags map[string]string - // An array of structures that describe the configuration of each feature variation - // used in the experiment. + // An array of structures that describe the configuration of each feature + // variation used in the experiment. Treatments []Treatment noSmithyDocumentSerde @@ -253,8 +253,8 @@ type ExperimentReport struct { noSmithyDocumentSerde } -// A structure that contains experiment results for one metric that is monitored in -// the experiment. +// A structure that contains experiment results for one metric that is monitored +// in the experiment. type ExperimentResultsData struct { // The name of the metric. @@ -295,9 +295,9 @@ type Feature struct { // This member is required. CreatedTime *time.Time - // If this value is ALL_RULES, the traffic allocation specified by any ongoing - // launches or experiments is being used. If this is DEFAULT_VARIATION, the default - // variation is being served to all users. + // If this value is ALL_RULES , the traffic allocation specified by any ongoing + // launches or experiments is being used. If this is DEFAULT_VARIATION , the + // default variation is being served to all users. // // This member is required. EvaluationStrategy FeatureEvaluationStrategy @@ -318,14 +318,13 @@ type Feature struct { Status FeatureStatus // Defines the type of value used to define the different feature variations. For - // more information, see Variation types - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-variationtypes.html) + // more information, see Variation types (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-variationtypes.html) // // This member is required. ValueType VariationValueType - // An array of structures that contain the configuration of the feature's different - // variations. + // An array of structures that contain the configuration of the feature's + // different variations. // // This member is required. Variations []Variation @@ -333,7 +332,7 @@ type Feature struct { // The name of the variation that is used as the default variation. The default // variation is served to users who are not allocated to any ongoing launches or // experiments of this feature. This variation must also be listed in the - // variations structure. If you omit defaultVariation, the first variation listed + // variations structure. If you omit defaultVariation , the first variation listed // in the variations structure is used as the default variation. DefaultVariation *string @@ -344,8 +343,7 @@ type Feature struct { // specific variation of a feature. Each key specifies a user using their user ID, // account ID, or some other identifier. The value specifies the name of the // variation that the user is to be served. For the override to be successful, the - // value of the key must match the entityId used in the EvaluateFeature - // (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) + // value of the key must match the entityId used in the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) // operation. EntityOverrides map[string]string @@ -374,9 +372,9 @@ type FeatureSummary struct { // This member is required. CreatedTime *time.Time - // If this value is ALL_RULES, the traffic allocation specified by any ongoing - // launches or experiments is being used. If this is DEFAULT_VARIATION, the default - // variation is being served to all users. + // If this value is ALL_RULES , the traffic allocation specified by any ongoing + // launches or experiments is being used. If this is DEFAULT_VARIATION , the + // default variation is being served to all users. // // This member is required. EvaluationStrategy FeatureEvaluationStrategy @@ -453,8 +451,8 @@ type Launch struct { // launch. Execution *LaunchExecution - // An array of structures that define the feature variations that are being used in - // the launch. + // An array of structures that define the feature variations that are being used + // in the launch. Groups []LaunchGroup // An array of structures that define the metrics that are being used to monitor @@ -467,15 +465,15 @@ type Launch struct { // This value is used when Evidently assigns a particular user session to the // launch, to help create a randomization ID to determine which variation the user // session is served. This randomization ID is a combination of the entity ID and - // randomizationSalt. + // randomizationSalt . RandomizationSalt *string // An array of structures that define the traffic allocation percentages among the // feature variations during each step of the launch. ScheduledSplitsDefinition *ScheduledSplitsLaunchDefinition - // If the launch was stopped, this is the string that was entered by the person who - // stopped the launch, to explain why it was stopped. + // If the launch was stopped, this is the string that was entered by the person + // who stopped the launch, to explain why it was stopped. StatusReason *string // The list of tag keys and values associated with this launch. @@ -551,8 +549,8 @@ type MetricDefinition struct { // The EventBridge event pattern that defines how the metric is recorded. For more // information about EventBridge event patterns, see Amazon EventBridge event - // patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html). + // patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) + // . // // This value conforms to the media type: application/json EventPattern *string @@ -574,7 +572,7 @@ type MetricDefinition struct { type MetricDefinitionConfig struct { // The entity, such as a user or session, that does an action that causes a metric - // value to be recorded. An example is userDetails.userID. + // value to be recorded. An example is userDetails.userID . // // This member is required. EntityIdKey *string @@ -591,8 +589,8 @@ type MetricDefinitionConfig struct { // The EventBridge event pattern that defines how the metric is recorded. For more // information about EventBridge event patterns, see Amazon EventBridge event - // patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html). + // patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) + // . // // This value conforms to the media type: application/json EventPattern *string @@ -735,8 +733,8 @@ type Project struct { // The number of ongoing launches currently in the project. ActiveLaunchCount *int64 - // This structure defines the configuration of how your application integrates with - // AppConfig to run client-side evaluation. + // This structure defines the configuration of how your application integrates + // with AppConfig to run client-side evaluation. AppConfigResource *ProjectAppConfigResource // A structure that contains information about where Evidently is to store @@ -754,8 +752,8 @@ type Project struct { // The number of features currently in the project. FeatureCount *int64 - // The number of launches currently in the project. This includes all launches that - // have been created and not deleted, whether they are ongoing or not. + // The number of launches currently in the project. This includes all launches + // that have been created and not deleted, whether they are ongoing or not. LaunchCount *int64 // The list of tag keys and values associated with this project. @@ -778,9 +776,9 @@ type ProjectAppConfigResource struct { // This member is required. ConfigurationProfileId *string - // The ID of the AppConfig environment to use for client-side evaluation. This must - // be an environment that is within the application that you specify for - // applicationId. + // The ID of the AppConfig environment to use for client-side evaluation. This + // must be an environment that is within the application that you specify for + // applicationId . // // This member is required. EnvironmentId *string @@ -790,8 +788,7 @@ type ProjectAppConfigResource struct { // Use this parameter to configure client-side evaluation for your project. // Client-side evaluation allows your application to assign variations to user -// sessions locally instead of by calling the EvaluateFeature -// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) +// sessions locally instead of by calling the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) // operation to assign the variations. This mitigates the latency and availability // risks that come with an API call. ProjectAppConfigResource is a structure that // defines the configuration of how your application integrates with AppConfig to @@ -801,9 +798,9 @@ type ProjectAppConfigResourceConfig struct { // The ID of the AppConfig application to use for client-side evaluation. ApplicationId *string - // The ID of the AppConfig environment to use for client-side evaluation. This must - // be an environment that is within the application that you specify for - // applicationId. + // The ID of the AppConfig environment to use for client-side evaluation. This + // must be an environment that is within the application that you specify for + // applicationId . EnvironmentId *string noSmithyDocumentSerde @@ -918,8 +915,8 @@ type RefResource struct { // This member is required. Name *string - // Specifies whether the resource that this structure contains information about is - // an experiment or a launch. + // Specifies whether the resource that this structure contains information about + // is an experiment or a launch. // // This member is required. Type *string @@ -1087,10 +1084,10 @@ type Segment struct { // This member is required. Name *string - // The pattern that defines the attributes to use to evalute whether a user session - // will be in the segment. For more information about the pattern syntax, see - // Segment rule pattern syntax - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html). + // The pattern that defines the attributes to use to evalute whether a user + // session will be in the segment. For more information about the pattern syntax, + // see Segment rule pattern syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) + // . // // This value conforms to the media type: application/json // @@ -1118,8 +1115,8 @@ type Segment struct { // the traffic split for that segment to be used in a launch. type SegmentOverride struct { - // A number indicating the order to use to evaluate segment overrides, if there are - // more than one. Segment overrides with lower numbers are evaluated first. + // A number indicating the order to use to evaluate segment overrides, if there + // are more than one. Segment overrides with lower numbers are evaluated first. // // This member is required. EvaluationOrder *int64 @@ -1153,8 +1150,8 @@ type Treatment struct { // The description of the treatment. Description *string - // The feature variation used for this treatment. This is a key-value pair. The key - // is the feature name, and the value is the variation name. + // The feature variation used for this treatment. This is a key-value pair. The + // key is the feature name, and the value is the variation name. FeatureVariations map[string]string noSmithyDocumentSerde @@ -1202,7 +1199,7 @@ type ValidationExceptionField struct { } // The value assigned to a feature variation. This structure must contain exactly -// one field. It can be boolValue, doubleValue, longValue, or stringValue. +// one field. It can be boolValue , doubleValue , longValue , or stringValue . // // The following types satisfy this interface: // @@ -1214,8 +1211,8 @@ type VariableValue interface { isVariableValue() } -// If this feature uses the Boolean variation type, this field contains the Boolean -// value of this variation. +// If this feature uses the Boolean variation type, this field contains the +// Boolean value of this variation. type VariableValueMemberBoolValue struct { Value bool @@ -1234,8 +1231,8 @@ type VariableValueMemberDoubleValue struct { func (*VariableValueMemberDoubleValue) isVariableValue() {} -// If this feature uses the long variation type, this field contains the long value -// of this variation. +// If this feature uses the long variation type, this field contains the long +// value of this variation. type VariableValueMemberLongValue struct { Value int64 diff --git a/service/finspace/api_client.go b/service/finspace/api_client.go index 5108c3d07c9..32604ac9d7f 100644 --- a/service/finspace/api_client.go +++ b/service/finspace/api_client.go @@ -117,7 +117,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/finspace/api_op_CreateEnvironment.go b/service/finspace/api_op_CreateEnvironment.go index 634597ac61f..c0581cddac2 100644 --- a/service/finspace/api_op_CreateEnvironment.go +++ b/service/finspace/api_op_CreateEnvironment.go @@ -36,26 +36,20 @@ type CreateEnvironmentInput struct { // The list of Amazon Resource Names (ARN) of the data bundles to install. // Currently supported data bundle ARNs: - // - // * - // arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample - // Capital Markets datasets, categories and controlled vocabularies. - // - // * - // arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and - // quotes data in addition to sample Capital Markets data. + // - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains + // sample Capital Markets datasets, categories and controlled vocabularies. + // - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and + // quotes data in addition to sample Capital Markets data. DataBundles []string // The description of the FinSpace environment to be created. Description *string // Authentication mode for the environment. - // - // * FEDERATED - Users access FinSpace - // through Single Sign On (SSO) via your Identity provider. - // - // * LOCAL - Users access - // FinSpace via email and password managed within the FinSpace environment. + // - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your + // Identity provider. + // - LOCAL - Users access FinSpace via email and password managed within the + // FinSpace environment. FederationMode types.FederationMode // Configuration information when authentication mode is FEDERATED. diff --git a/service/finspace/api_op_UpdateEnvironment.go b/service/finspace/api_op_UpdateEnvironment.go index 1cadc6dfefc..f22b229a4fe 100644 --- a/service/finspace/api_op_UpdateEnvironment.go +++ b/service/finspace/api_op_UpdateEnvironment.go @@ -38,12 +38,10 @@ type UpdateEnvironmentInput struct { Description *string // Authentication mode for the environment. - // - // * FEDERATED - Users access FinSpace - // through Single Sign On (SSO) via your Identity provider. - // - // * LOCAL - Users access - // FinSpace via email and password managed within the FinSpace environment. + // - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your + // Identity provider. + // - LOCAL - Users access FinSpace via email and password managed within the + // FinSpace environment. FederationMode types.FederationMode // Configuration information when authentication mode is FEDERATED. diff --git a/service/finspace/types/types.go b/service/finspace/types/types.go index 868006e816f..666e18c97aa 100644 --- a/service/finspace/types/types.go +++ b/service/finspace/types/types.go @@ -59,8 +59,8 @@ type FederationParameters struct { // SAML attribute name and value. The name must always be Email and the value // should be set to the attribute definition in which user email is set. For // example, name would be Email and value - // http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check - // your SAML 2.0 compliant identity provider (IdP) documentation for details. + // http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress . Please + // check your SAML 2.0 compliant identity provider (IdP) documentation for details. AttributeMap map[string]string // Name of the identity provider (IdP). diff --git a/service/finspacedata/api_client.go b/service/finspacedata/api_client.go index b9ad1f9dcb0..128cdef0e0a 100644 --- a/service/finspacedata/api_client.go +++ b/service/finspacedata/api_client.go @@ -124,7 +124,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/finspacedata/api_op_CreateChangeset.go b/service/finspacedata/api_op_CreateChangeset.go index 0a2fd9de1fd..b3390f7b803 100644 --- a/service/finspacedata/api_op_CreateChangeset.go +++ b/service/finspacedata/api_op_CreateChangeset.go @@ -32,16 +32,12 @@ func (c *Client) CreateChangeset(ctx context.Context, params *CreateChangesetInp type CreateChangesetInput struct { // The option to indicate how a Changeset will be applied to a Dataset. - // - // * REPLACE - // – Changeset will be considered as a replacement to all prior loaded - // Changesets. - // - // * APPEND – Changeset will be considered as an addition to the end - // of all prior loaded Changesets. - // - // * MODIFY – Changeset is considered as a - // replacement to a specific prior ingested Changeset. + // - REPLACE – Changeset will be considered as a replacement to all prior loaded + // Changesets. + // - APPEND – Changeset will be considered as an addition to the end of all prior + // loaded Changesets. + // - MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. // // This member is required. ChangeType types.ChangeType @@ -53,43 +49,33 @@ type CreateChangesetInput struct { DatasetId *string // Options that define the structure of the source file(s) including the format - // type (formatType), header row (withHeader), data separation character - // (separator) and the type of compression (compression). formatType is a required - // attribute and can have the following values: - // - // * PARQUET – Parquet source file - // format. - // - // * CSV – CSV source file format. - // - // * JSON – JSON source file format. - // - // * - // XML – XML source file format. - // - // Here is an example of how you could specify the - // formatParams: "formatParams": { "formatType": "CSV", "withHeader": "true", - // "separator": ",", "compression":"None" } Note that if you only provide - // formatType as CSV, the rest of the attributes will automatically default to CSV - // values as following: { "withHeader": "true", "separator": "," } For more - // information about supported file formats, see Supported Data Types and File - // Formats - // (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) + // type ( formatType ), header row ( withHeader ), data separation character ( + // separator ) and the type of compression ( compression ). formatType is a + // required attribute and can have the following values: + // - PARQUET – Parquet source file format. + // - CSV – CSV source file format. + // - JSON – JSON source file format. + // - XML – XML source file format. + // Here is an example of how you could specify the formatParams : "formatParams": + // { "formatType": "CSV", "withHeader": "true", "separator": ",", + // "compression":"None" } Note that if you only provide formatType as CSV , the + // rest of the attributes will automatically default to CSV values as following: { + // "withHeader": "true", "separator": "," } For more information about supported + // file formats, see Supported Data Types and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) // in the FinSpace User Guide. // // This member is required. FormatParams map[string]string - // Options that define the location of the data being ingested (s3SourcePath) and - // the source of the changeset (sourceType). Both s3SourcePath and sourceType are - // required attributes. Here is an example of how you could specify the - // sourceParams: "sourceParams": { "s3SourcePath": + // Options that define the location of the data being ingested ( s3SourcePath ) and + // the source of the changeset ( sourceType ). Both s3SourcePath and sourceType + // are required attributes. Here is an example of how you could specify the + // sourceParams : "sourceParams": { "s3SourcePath": // "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", - // "sourceType": "S3" } The S3 path that you specify must allow the FinSpace role + // "sourceType": "S3" } The S3 path that you specify must allow the FinSpace role // access. To do that, you first need to configure the IAM policy on S3 bucket. For // more information, see Loading data from an Amazon S3 Bucket using the FinSpace - // API - // (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets) + // API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets) // section. // // This member is required. diff --git a/service/finspacedata/api_op_CreateDataView.go b/service/finspacedata/api_op_CreateDataView.go index cf33bdff198..92be4383d86 100644 --- a/service/finspacedata/api_op_CreateDataView.go +++ b/service/finspacedata/api_op_CreateDataView.go @@ -41,8 +41,8 @@ type CreateDataViewInput struct { // This member is required. DestinationTypeParams *types.DataViewDestinationTypeParams - // Beginning time to use for the Dataview. The value is determined as epoch time in - // milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM + // Beginning time to use for the Dataview. The value is determined as epoch time + // in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM // UTC is specified as 1635768000000. AsOfTimestamp *int64 diff --git a/service/finspacedata/api_op_CreateDataset.go b/service/finspacedata/api_op_CreateDataset.go index 8d62ad6faec..f5c5c07a763 100644 --- a/service/finspacedata/api_op_CreateDataset.go +++ b/service/finspacedata/api_op_CreateDataset.go @@ -37,12 +37,8 @@ type CreateDatasetInput struct { DatasetTitle *string // The format in which Dataset data is structured. - // - // * TABULAR – Data is structured - // in a tabular format. - // - // * NON_TABULAR – Data is structured in a non-tabular - // format. + // - TABULAR – Data is structured in a tabular format. + // - NON_TABULAR – Data is structured in a non-tabular format. // // This member is required. Kind types.DatasetKind diff --git a/service/finspacedata/api_op_CreatePermissionGroup.go b/service/finspacedata/api_op_CreatePermissionGroup.go index 2f9169f34db..8b2065acbfe 100644 --- a/service/finspacedata/api_op_CreatePermissionGroup.go +++ b/service/finspacedata/api_op_CreatePermissionGroup.go @@ -36,29 +36,17 @@ type CreatePermissionGroupInput struct { // permission ManageUsersAndGroups allows users to grant themselves or others // access to any functionality in their FinSpace environment's application. It // should only be granted to trusted users. - // - // * CreateDataset – Group members can - // create new datasets. - // - // * ManageClusters – Group members can manage Apache Spark - // clusters from FinSpace notebooks. - // - // * ManageUsersAndGroups – Group members can - // manage users and permission groups. This is a privileged permission that allows - // users to grant themselves or others access to any functionality in the - // application. It should only be granted to trusted users. - // - // * ManageAttributeSets - // – Group members can manage attribute sets. - // - // * ViewAuditData – Group members can - // view audit data. - // - // * AccessNotebooks – Group members will have access to FinSpace - // notebooks. - // - // * GetTemporaryCredentials – Group members can get temporary API - // credentials. + // - CreateDataset – Group members can create new datasets. + // - ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. + // - ManageUsersAndGroups – Group members can manage users and permission groups. + // This is a privileged permission that allows users to grant themselves or others + // access to any functionality in the application. It should only be granted to + // trusted users. + // - ManageAttributeSets – Group members can manage attribute sets. + // - ViewAuditData – Group members can view audit data. + // - AccessNotebooks – Group members will have access to FinSpace notebooks. + // - GetTemporaryCredentials – Group members can get temporary API credentials. // // This member is required. ApplicationPermissions []types.ApplicationPermission diff --git a/service/finspacedata/api_op_CreateUser.go b/service/finspacedata/api_op_CreateUser.go index d6b3653d77d..4ba33ede601 100644 --- a/service/finspacedata/api_op_CreateUser.go +++ b/service/finspacedata/api_op_CreateUser.go @@ -39,13 +39,10 @@ type CreateUserInput struct { // The option to indicate the type of user. Use one of the following options to // specify this parameter: - // - // * SUPER_USER – A user with permission to all the - // functionality and data in FinSpace. - // - // * APP_USER – A user with specific - // permissions in FinSpace. The users are assigned permissions by adding them to a - // permission group. + // - SUPER_USER – A user with permission to all the functionality and data in + // FinSpace. + // - APP_USER – A user with specific permissions in FinSpace. The users are + // assigned permissions by adding them to a permission group. // // This member is required. Type types.UserType @@ -53,12 +50,8 @@ type CreateUserInput struct { // The option to indicate whether the user can use the // GetProgrammaticAccessCredentials API to obtain credentials that can then be used // to access other FinSpace Data API operations. - // - // * ENABLED – The user has - // permissions to use the APIs. - // - // * DISABLED – The user does not have permissions to - // use any APIs. + // - ENABLED – The user has permissions to use the APIs. + // - DISABLED – The user does not have permissions to use any APIs. ApiAccess types.ApiAccess // The ARN identifier of an AWS user or role that is allowed to call the diff --git a/service/finspacedata/api_op_GetChangeset.go b/service/finspacedata/api_op_GetChangeset.go index 63557bc60be..0b7c9a07a55 100644 --- a/service/finspacedata/api_op_GetChangeset.go +++ b/service/finspacedata/api_op_GetChangeset.go @@ -57,16 +57,12 @@ type GetChangesetOutput struct { ActiveUntilTimestamp *int64 // Type that indicates how a Changeset is applied to a Dataset. - // - // * REPLACE – - // Changeset is considered as a replacement to all prior loaded Changesets. - // - // * - // APPEND – Changeset is considered as an addition to the end of all prior loaded - // Changesets. - // - // * MODIFY – Changeset is considered as a replacement to a specific - // prior ingested Changeset. + // - REPLACE – Changeset is considered as a replacement to all prior loaded + // Changesets. + // - APPEND – Changeset is considered as an addition to the end of all prior + // loaded Changesets. + // - MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. ChangeType types.ChangeType // The ARN identifier of the Changeset. diff --git a/service/finspacedata/api_op_GetDataView.go b/service/finspacedata/api_op_GetDataView.go index 7761ab083e6..284527cfe4b 100644 --- a/service/finspacedata/api_op_GetDataView.go +++ b/service/finspacedata/api_op_GetDataView.go @@ -27,8 +27,8 @@ func (c *Client) GetDataView(ctx context.Context, params *GetDataViewInput, optF return out, nil } -// Request for retrieving a data view detail. Grouped / accessible within a dataset -// by its dataset id. +// Request for retrieving a data view detail. Grouped / accessible within a +// dataset by its dataset id. type GetDataViewInput struct { // The unique identifier for the Dataview. @@ -88,27 +88,15 @@ type GetDataViewOutput struct { SortColumns []string // The status of a Dataview creation. - // - // * RUNNING – Dataview creation is running. - // - // * - // STARTING – Dataview creation is starting. - // - // * FAILED – Dataview creation has - // failed. - // - // * CANCELLED – Dataview creation has been cancelled. - // - // * TIMEOUT – - // Dataview creation has timed out. - // - // * SUCCESS – Dataview creation has - // succeeded. - // - // * PENDING – Dataview creation is pending. - // - // * FAILED_CLEANUP_FAILED – - // Dataview creation failed and resource cleanup failed. + // - RUNNING – Dataview creation is running. + // - STARTING – Dataview creation is starting. + // - FAILED – Dataview creation has failed. + // - CANCELLED – Dataview creation has been cancelled. + // - TIMEOUT – Dataview creation has timed out. + // - SUCCESS – Dataview creation has succeeded. + // - PENDING – Dataview creation is pending. + // - FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup + // failed. Status types.DataViewStatus // Metadata pertaining to the operation's result. diff --git a/service/finspacedata/api_op_GetDataset.go b/service/finspacedata/api_op_GetDataset.go index cc206ef9bf5..9b0db509623 100644 --- a/service/finspacedata/api_op_GetDataset.go +++ b/service/finspacedata/api_op_GetDataset.go @@ -62,12 +62,8 @@ type GetDatasetOutput struct { DatasetTitle *string // The format in which Dataset data is structured. - // - // * TABULAR – Data is structured - // in a tabular format. - // - // * NON_TABULAR – Data is structured in a non-tabular - // format. + // - TABULAR – Data is structured in a tabular format. + // - NON_TABULAR – Data is structured in a non-tabular format. Kind types.DatasetKind // The last time that the Dataset was modified. The value is determined as epoch @@ -79,16 +75,10 @@ type GetDatasetOutput struct { SchemaDefinition *types.SchemaUnion // Status of the Dataset creation. - // - // * PENDING – Dataset is pending creation. - // - // * - // FAILED – Dataset creation has failed. - // - // * SUCCESS – Dataset creation has - // succeeded. - // - // * RUNNING – Dataset creation is running. + // - PENDING – Dataset is pending creation. + // - FAILED – Dataset creation has failed. + // - SUCCESS – Dataset creation has succeeded. + // - RUNNING – Dataset creation is running. Status types.DatasetStatus // Metadata pertaining to the operation's result. diff --git a/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go b/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go index 5da2f4d1402..7e48761f273 100644 --- a/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go +++ b/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go @@ -13,12 +13,9 @@ import ( // Returns the credentials to access the external Dataview from an S3 location. To // call this API: -// -// * You must retrieve the programmatic credentials. -// -// * You must be -// a member of a FinSpace user group, where the dataset that you want to access has -// Read Dataset Data permissions. +// - You must retrieve the programmatic credentials. +// - You must be a member of a FinSpace user group, where the dataset that you +// want to access has Read Dataset Data permissions. func (c *Client) GetExternalDataViewAccessDetails(ctx context.Context, params *GetExternalDataViewAccessDetailsInput, optFns ...func(*Options)) (*GetExternalDataViewAccessDetailsOutput, error) { if params == nil { params = &GetExternalDataViewAccessDetailsInput{} diff --git a/service/finspacedata/api_op_GetUser.go b/service/finspacedata/api_op_GetUser.go index 5161187b0b9..de9e214c59f 100644 --- a/service/finspacedata/api_op_GetUser.go +++ b/service/finspacedata/api_op_GetUser.go @@ -42,11 +42,8 @@ type GetUserOutput struct { // Indicates whether the user can use the GetProgrammaticAccessCredentials API to // obtain credentials that can then be used to access other FinSpace Data API // operations. - // - // * ENABLED – The user has permissions to use the APIs. - // - // * DISABLED – - // The user does not have permissions to use any APIs. + // - ENABLED – The user has permissions to use the APIs. + // - DISABLED – The user does not have permissions to use any APIs. ApiAccess types.ApiAccess // The ARN identifier of an AWS user or role that is allowed to call the @@ -68,40 +65,33 @@ type GetUserOutput struct { // as epoch time in milliseconds. LastDisabledTime int64 - // Describes the last time the user account was enabled. The value is determined as - // epoch time in milliseconds. + // Describes the last time the user account was enabled. The value is determined + // as epoch time in milliseconds. LastEnabledTime int64 // Describes the last time that the user logged into their account. The value is // determined as epoch time in milliseconds. LastLoginTime int64 - // Describes the last time the user account was updated. The value is determined as - // epoch time in milliseconds. + // Describes the last time the user account was updated. The value is determined + // as epoch time in milliseconds. LastModifiedTime int64 // The last name of the user. LastName *string // The current status of the user account. - // - // * CREATING – The user account creation - // is in progress. - // - // * ENABLED – The user account is created and is currently - // active. - // - // * DISABLED – The user account is currently inactive. + // - CREATING – The user account creation is in progress. + // - ENABLED – The user account is created and is currently active. + // - DISABLED – The user account is currently inactive. Status types.UserStatus // Indicates the type of user. + // - SUPER_USER – A user with permission to all the functionality and data in + // FinSpace. // - // * SUPER_USER – A user with permission to all the - // functionality and data in FinSpace. - // - // * APP_USER – A user with specific - // permissions in FinSpace. The users are assigned permissions by adding them to a - // permission group. + // - APP_USER – A user with specific permissions in FinSpace. The users are + // assigned permissions by adding them to a permission group. Type types.UserType // The unique identifier for the user account that is retrieved. diff --git a/service/finspacedata/api_op_GetWorkingLocation.go b/service/finspacedata/api_op_GetWorkingLocation.go index 3ac4aa9348b..90cf69ca470 100644 --- a/service/finspacedata/api_op_GetWorkingLocation.go +++ b/service/finspacedata/api_op_GetWorkingLocation.go @@ -31,14 +31,10 @@ func (c *Client) GetWorkingLocation(ctx context.Context, params *GetWorkingLocat type GetWorkingLocationInput struct { // Specify the type of the working location. - // - // * SAGEMAKER – Use the Amazon S3 - // location as a temporary location to store data content when working with - // FinSpace Notebooks that run on SageMaker studio. - // - // * INGESTION – Use the Amazon - // S3 location as a staging location to copy your data content and then use the - // location with the Changeset creation operation. + // - SAGEMAKER – Use the Amazon S3 location as a temporary location to store data + // content when working with FinSpace Notebooks that run on SageMaker studio. + // - INGESTION – Use the Amazon S3 location as a staging location to copy your + // data content and then use the location with the Changeset creation operation. LocationType types.LocationType noSmithyDocumentSerde diff --git a/service/finspacedata/api_op_UpdateChangeset.go b/service/finspacedata/api_op_UpdateChangeset.go index 557cc935bf9..80a044f9a49 100644 --- a/service/finspacedata/api_op_UpdateChangeset.go +++ b/service/finspacedata/api_op_UpdateChangeset.go @@ -42,43 +42,34 @@ type UpdateChangesetInput struct { DatasetId *string // Options that define the structure of the source file(s) including the format - // type (formatType), header row (withHeader), data separation character - // (separator) and the type of compression (compression). formatType is a required - // attribute and can have the following values: - // - // * PARQUET – Parquet source file - // format. - // - // * CSV – CSV source file format. - // - // * JSON – JSON source file format. - // - // * - // XML – XML source file format. - // - // Here is an example of how you could specify the - // formatParams: "formatParams": { "formatType": "CSV", "withHeader": "true", - // "separator": ",", "compression":"None" } Note that if you only provide - // formatType as CSV, the rest of the attributes will automatically default to CSV - // values as following: { "withHeader": "true", "separator": "," } For more - // information about supported file formats, see Supported Data Types and File - // Formats - // (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) + // type ( formatType ), header row ( withHeader ), data separation character ( + // separator ) and the type of compression ( compression ). formatType is a + // required attribute and can have the following values: + // - PARQUET – Parquet source file format. + // - CSV – CSV source file format. + // - JSON – JSON source file format. + // - XML – XML source file format. + // Here is an example of how you could specify the formatParams : "formatParams": + // { "formatType": "CSV", "withHeader": "true", "separator": ",", + // "compression":"None" } Note that if you only provide formatType as CSV , the + // rest of the attributes will automatically default to CSV values as following: { + // "withHeader": "true", "separator": "," } For more information about supported + // file formats, see Supported Data Types and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) // in the FinSpace User Guide. // // This member is required. FormatParams map[string]string - // Options that define the location of the data being ingested (s3SourcePath) and - // the source of the changeset (sourceType). Both s3SourcePath and sourceType are - // required attributes. Here is an example of how you could specify the - // sourceParams: "sourceParams": { "s3SourcePath": + // Options that define the location of the data being ingested ( s3SourcePath ) and + // the source of the changeset ( sourceType ). Both s3SourcePath and sourceType + // are required attributes. Here is an example of how you could specify the + // sourceParams : "sourceParams": { "s3SourcePath": // "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", - // "sourceType": "S3" } The S3 path that you specify must allow the FinSpace role + // "sourceType": "S3" } The S3 path that you specify must allow the FinSpace role // access. To do that, you first need to configure the IAM policy on S3 bucket. For // more information, see Loading data from an Amazon S3 Bucket using the FinSpace - // API - // (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)section. + // API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets) + // section. // // This member is required. SourceParams map[string]string diff --git a/service/finspacedata/api_op_UpdateDataset.go b/service/finspacedata/api_op_UpdateDataset.go index d5b136bc2e2..43413bf953c 100644 --- a/service/finspacedata/api_op_UpdateDataset.go +++ b/service/finspacedata/api_op_UpdateDataset.go @@ -42,12 +42,8 @@ type UpdateDatasetInput struct { DatasetTitle *string // The format in which the Dataset data is structured. - // - // * TABULAR – Data is - // structured in a tabular format. - // - // * NON_TABULAR – Data is structured in a - // non-tabular format. + // - TABULAR – Data is structured in a tabular format. + // - NON_TABULAR – Data is structured in a non-tabular format. // // This member is required. Kind types.DatasetKind diff --git a/service/finspacedata/api_op_UpdatePermissionGroup.go b/service/finspacedata/api_op_UpdatePermissionGroup.go index f6cb5fe7a8f..98ffe2f9f67 100644 --- a/service/finspacedata/api_op_UpdatePermissionGroup.go +++ b/service/finspacedata/api_op_UpdatePermissionGroup.go @@ -13,7 +13,7 @@ import ( ) // Modifies the details of a permission group. You cannot modify a -// permissionGroupID. +// permissionGroupID . func (c *Client) UpdatePermissionGroup(ctx context.Context, params *UpdatePermissionGroupInput, optFns ...func(*Options)) (*UpdatePermissionGroupOutput, error) { if params == nil { params = &UpdatePermissionGroupInput{} @@ -41,29 +41,17 @@ type UpdatePermissionGroupInput struct { // permission ManageUsersAndGroups allows users to grant themselves or others // access to any functionality in their FinSpace environment's application. It // should only be granted to trusted users. - // - // * CreateDataset – Group members can - // create new datasets. - // - // * ManageClusters – Group members can manage Apache Spark - // clusters from FinSpace notebooks. - // - // * ManageUsersAndGroups – Group members can - // manage users and permission groups. This is a privileged permission that allows - // users to grant themselves or others access to any functionality in the - // application. It should only be granted to trusted users. - // - // * ManageAttributeSets - // – Group members can manage attribute sets. - // - // * ViewAuditData – Group members can - // view audit data. - // - // * AccessNotebooks – Group members will have access to FinSpace - // notebooks. - // - // * GetTemporaryCredentials – Group members can get temporary API - // credentials. + // - CreateDataset – Group members can create new datasets. + // - ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. + // - ManageUsersAndGroups – Group members can manage users and permission groups. + // This is a privileged permission that allows users to grant themselves or others + // access to any functionality in the application. It should only be granted to + // trusted users. + // - ManageAttributeSets – Group members can manage attribute sets. + // - ViewAuditData – Group members can view audit data. + // - AccessNotebooks – Group members will have access to FinSpace notebooks. + // - GetTemporaryCredentials – Group members can get temporary API credentials. ApplicationPermissions []types.ApplicationPermission // A token that ensures idempotency. This token expires in 10 minutes. diff --git a/service/finspacedata/api_op_UpdateUser.go b/service/finspacedata/api_op_UpdateUser.go index f5a98a37363..2d9ff042c74 100644 --- a/service/finspacedata/api_op_UpdateUser.go +++ b/service/finspacedata/api_op_UpdateUser.go @@ -39,12 +39,8 @@ type UpdateUserInput struct { // The option to indicate whether the user can use the // GetProgrammaticAccessCredentials API to obtain credentials that can then be used // to access other FinSpace Data API operations. - // - // * ENABLED – The user has - // permissions to use the APIs. - // - // * DISABLED – The user does not have permissions to - // use any APIs. + // - ENABLED – The user has permissions to use the APIs. + // - DISABLED – The user does not have permissions to use any APIs. ApiAccess types.ApiAccess // The ARN identifier of an AWS user or role that is allowed to call the @@ -62,13 +58,10 @@ type UpdateUserInput struct { LastName *string // The option to indicate the type of user. - // - // * SUPER_USER– A user with permission - // to all the functionality and data in FinSpace. - // - // * APP_USER – A user with - // specific permissions in FinSpace. The users are assigned permissions by adding - // them to a permission group. + // - SUPER_USER – A user with permission to all the functionality and data in + // FinSpace. + // - APP_USER – A user with specific permissions in FinSpace. The users are + // assigned permissions by adding them to a permission group. Type types.UserType noSmithyDocumentSerde diff --git a/service/finspacedata/types/enums.go b/service/finspacedata/types/enums.go index 3374fe637c3..ff0d3e8021a 100644 --- a/service/finspacedata/types/enums.go +++ b/service/finspacedata/types/enums.go @@ -10,9 +10,9 @@ const ( ApiAccessDisabled ApiAccess = "DISABLED" ) -// Values returns all known values for ApiAccess. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ApiAccess. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ApiAccess) Values() []ApiAccess { return []ApiAccess{ "ENABLED", @@ -33,8 +33,8 @@ const ( ApplicationPermissionGetTemporaryCredentials ApplicationPermission = "GetTemporaryCredentials" ) -// Values returns all known values for ApplicationPermission. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ApplicationPermission. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ApplicationPermission) Values() []ApplicationPermission { return []ApplicationPermission{ @@ -256,9 +256,9 @@ const ( LocationTypeSagemaker LocationType = "SAGEMAKER" ) -// Values returns all known values for LocationType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LocationType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LocationType) Values() []LocationType { return []LocationType{ "INGESTION", diff --git a/service/finspacedata/types/types.go b/service/finspacedata/types/types.go index 2e7a15e1425..2b647baaebb 100644 --- a/service/finspacedata/types/types.go +++ b/service/finspacedata/types/types.go @@ -28,29 +28,16 @@ type AwsCredentials struct { type ChangesetErrorInfo struct { // The category of the error. - // - // * VALIDATION – The inputs to this request are - // invalid. - // - // * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please - // contact AWS support to increase quotas. - // - // * ACCESS_DENIED – Missing required - // permission to perform this request. - // - // * RESOURCE_NOT_FOUND – One or more inputs - // to this request were not found. - // - // * THROTTLING – The system temporarily lacks - // sufficient resources to process the request. - // - // * INTERNAL_SERVICE_EXCEPTION – An - // internal service error has occurred. - // - // * CANCELLED – Cancelled. - // - // * - // USER_RECOVERABLE – A user recoverable error has occurred. + // - VALIDATION – The inputs to this request are invalid. + // - SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact + // AWS support to increase quotas. + // - ACCESS_DENIED – Missing required permission to perform this request. + // - RESOURCE_NOT_FOUND – One or more inputs to this request were not found. + // - THROTTLING – The system temporarily lacks sufficient resources to process + // the request. + // - INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred. + // - CANCELLED – Cancelled. + // - USER_RECOVERABLE – A user recoverable error has occurred. ErrorCategory ErrorCategory // The text of the error message. @@ -73,16 +60,12 @@ type ChangesetSummary struct { ActiveUntilTimestamp *int64 // Type that indicates how a Changeset is applied to a Dataset. - // - // * REPLACE – - // Changeset is considered as a replacement to all prior loaded Changesets. - // - // * - // APPEND – Changeset is considered as an addition to the end of all prior loaded - // Changesets. - // - // * MODIFY – Changeset is considered as a replacement to a specific - // prior ingested Changeset. + // - REPLACE – Changeset is considered as a replacement to all prior loaded + // Changesets. + // - APPEND – Changeset is considered as an addition to the end of all prior + // loaded Changesets. + // - MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. ChangeType ChangeType // The ARN identifier of the Changeset. @@ -110,19 +93,11 @@ type ChangesetSummary struct { SourceParams map[string]string // Status of the Changeset ingestion. - // - // * PENDING – Changeset is pending - // creation. - // - // * FAILED – Changeset creation has failed. - // - // * SUCCESS – Changeset - // creation has succeeded. - // - // * RUNNING – Changeset creation is running. - // - // * - // STOP_REQUESTED – User requested Changeset creation to stop. + // - PENDING – Changeset is pending creation. + // - FAILED – Changeset creation has failed. + // - SUCCESS – Changeset creation has succeeded. + // - RUNNING – Changeset creation is running. + // - STOP_REQUESTED – User requested Changeset creation to stop. Status IngestionStatus // The unique identifier of the updated Changeset. @@ -144,12 +119,11 @@ type ColumnDefinition struct { ColumnName *string // Data type of a column. - // - // * STRING – A String data type. CHAR – A char data type. - // INTEGER – An integer data type. TINYINT – A tinyint data type. SMALLINT – A - // smallint data type. BIGINT – A bigint data type. FLOAT – A float data type. - // DOUBLE – A double data type. DATE – A date data type. DATETIME – A datetime data - // type. BOOLEAN – A boolean data type. BINARY – A binary data type. + // - STRING – A String data type. CHAR – A char data type. INTEGER – An integer + // data type. TINYINT – A tinyint data type. SMALLINT – A smallint data type. + // BIGINT – A bigint data type. FLOAT – A float data type. DOUBLE – A double data + // type. DATE – A date data type. DATETIME – A datetime data type. BOOLEAN – A + // boolean data type. BINARY – A binary data type. DataType ColumnDataType noSmithyDocumentSerde @@ -194,12 +168,8 @@ type Dataset struct { DatasetTitle *string // The format in which Dataset data is structured. - // - // * TABULAR – Data is structured - // in a tabular format. - // - // * NON_TABULAR – Data is structured in a non-tabular - // format. + // - TABULAR – Data is structured in a tabular format. + // - NON_TABULAR – Data is structured in a non-tabular format. Kind DatasetKind // The last time that the Dataset was modified. The value is determined as epoch @@ -235,27 +205,20 @@ type DatasetOwnerInfo struct { type DataViewDestinationTypeParams struct { // Destination type for a Dataview. - // - // * GLUE_TABLE – Glue table destination type. - // - // * - // S3 – S3 destination type. + // - GLUE_TABLE – Glue table destination type. + // - S3 – S3 destination type. // // This member is required. DestinationType *string // Dataview export file format. - // - // * PARQUET – Parquet export file format. - // - // * - // DELIMITED_TEXT – Delimited text export file format. + // - PARQUET – Parquet export file format. + // - DELIMITED_TEXT – Delimited text export file format. S3DestinationExportFileFormat ExportFileFormat // Format Options for S3 Destination type. Here is an example of how you could // specify the s3DestinationExportFileFormatOptions - // { "header": "true", - // "delimiter": ",", "compression": "gzip" } + // { "header": "true", "delimiter": ",", "compression": "gzip" } S3DestinationExportFileFormatOptions map[string]string noSmithyDocumentSerde @@ -265,29 +228,16 @@ type DataViewDestinationTypeParams struct { type DataViewErrorInfo struct { // The category of the error. - // - // * VALIDATION – The inputs to this request are - // invalid. - // - // * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please - // contact AWS support to increase quotas. - // - // * ACCESS_DENIED – Missing required - // permission to perform this request. - // - // * RESOURCE_NOT_FOUND – One or more inputs - // to this request were not found. - // - // * THROTTLING – The system temporarily lacks - // sufficient resources to process the request. - // - // * INTERNAL_SERVICE_EXCEPTION – An - // internal service error has occurred. - // - // * CANCELLED – Cancelled. - // - // * - // USER_RECOVERABLE – A user recoverable error has occurred. + // - VALIDATION – The inputs to this request are invalid. + // - SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact + // AWS support to increase quotas. + // - ACCESS_DENIED – Missing required permission to perform this request. + // - RESOURCE_NOT_FOUND – One or more inputs to this request were not found. + // - THROTTLING – The system temporarily lacks sufficient resources to process + // the request. + // - INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred. + // - CANCELLED – Cancelled. + // - USER_RECOVERABLE – A user recoverable error has occurred. ErrorCategory ErrorCategory // The text of the error message. @@ -339,27 +289,15 @@ type DataViewSummary struct { SortColumns []string // The status of a Dataview creation. - // - // * RUNNING – Dataview creation is running. - // - // * - // STARTING – Dataview creation is starting. - // - // * FAILED – Dataview creation has - // failed. - // - // * CANCELLED – Dataview creation has been cancelled. - // - // * TIMEOUT – - // Dataview creation has timed out. - // - // * SUCCESS – Dataview creation has - // succeeded. - // - // * PENDING – Dataview creation is pending. - // - // * FAILED_CLEANUP_FAILED – - // Dataview creation failed and resource cleanup failed. + // - RUNNING – Dataview creation is running. + // - STARTING – Dataview creation is starting. + // - FAILED – Dataview creation has failed. + // - CANCELLED – Dataview creation has been cancelled. + // - TIMEOUT – Dataview creation has timed out. + // - SUCCESS – Dataview creation has succeeded. + // - PENDING – Dataview creation is pending. + // - FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup + // failed. Status DataViewStatus noSmithyDocumentSerde @@ -368,34 +306,22 @@ type DataViewSummary struct { // The structure for a permission group. type PermissionGroup struct { - // Indicates the permissions that are granted to a specific group for accessing the - // FinSpace application. When assigning application permissions, be aware that the - // permission ManageUsersAndGroups allows users to grant themselves or others + // Indicates the permissions that are granted to a specific group for accessing + // the FinSpace application. When assigning application permissions, be aware that + // the permission ManageUsersAndGroups allows users to grant themselves or others // access to any functionality in their FinSpace environment's application. It // should only be granted to trusted users. - // - // * CreateDataset – Group members can - // create new datasets. - // - // * ManageClusters – Group members can manage Apache Spark - // clusters from FinSpace notebooks. - // - // * ManageUsersAndGroups – Group members can - // manage users and permission groups. This is a privileged permission that allows - // users to grant themselves or others access to any functionality in the - // application. It should only be granted to trusted users. - // - // * ManageAttributeSets - // – Group members can manage attribute sets. - // - // * ViewAuditData – Group members can - // view audit data. - // - // * AccessNotebooks – Group members will have access to FinSpace - // notebooks. - // - // * GetTemporaryCredentials – Group members can get temporary API - // credentials. + // - CreateDataset – Group members can create new datasets. + // - ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. + // - ManageUsersAndGroups – Group members can manage users and permission groups. + // This is a privileged permission that allows users to grant themselves or others + // access to any functionality in the application. It should only be granted to + // trusted users. + // - ManageAttributeSets – Group members can manage attribute sets. + // - ViewAuditData – Group members can view audit data. + // - AccessNotebooks – Group members will have access to FinSpace notebooks. + // - GetTemporaryCredentials – Group members can get temporary API credentials. ApplicationPermissions []ApplicationPermission // The timestamp at which the group was created in FinSpace. The value is @@ -410,16 +336,12 @@ type PermissionGroup struct { LastModifiedTime int64 // Indicates the status of the user account within a permission group. - // - // * - // ADDITION_IN_PROGRESS – The user account is currently being added to the - // permission group. - // - // * ADDITION_SUCCESS – The user account is successfully added - // to the permission group. - // - // * REMOVAL_IN_PROGRESS – The user is currently being - // removed from the permission group. + // - ADDITION_IN_PROGRESS – The user account is currently being added to the + // permission group. + // - ADDITION_SUCCESS – The user account is successfully added to the permission + // group. + // - REMOVAL_IN_PROGRESS – The user is currently being removed from the + // permission group. MembershipStatus PermissionGroupMembershipStatus // The name of the permission group. @@ -435,16 +357,12 @@ type PermissionGroup struct { type PermissionGroupByUser struct { // Indicates the status of the user account within a permission group. - // - // * - // ADDITION_IN_PROGRESS – The user account is currently being added to the - // permission group. - // - // * ADDITION_SUCCESS – The user account is successfully added - // to the permission group. - // - // * REMOVAL_IN_PROGRESS – The user is currently being - // removed from the permission group. + // - ADDITION_IN_PROGRESS – The user account is currently being added to the + // permission group. + // - ADDITION_SUCCESS – The user account is successfully added to the permission + // group. + // - REMOVAL_IN_PROGRESS – The user is currently being removed from the + // permission group. MembershipStatus PermissionGroupMembershipStatus // The name of the permission group. @@ -457,7 +375,7 @@ type PermissionGroupByUser struct { } // Permission group parameters for Dataset permissions. Here is an example of how -// you could specify the PermissionGroupParams: { "permissionGroupId": +// you could specify the PermissionGroupParams : { "permissionGroupId": // "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ {"permission": // "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": // "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] } @@ -466,7 +384,7 @@ type PermissionGroupParams struct { // List of resource permissions. DatasetPermissions []ResourcePermission - // The unique identifier for the PermissionGroup. + // The unique identifier for the PermissionGroup . PermissionGroupId *string noSmithyDocumentSerde @@ -477,23 +395,15 @@ type PermissionGroupParams struct { // create a dataset if your user group has application permission for Create // Datasets. The following is a list of valid dataset permissions that you can // apply: +// - ViewDatasetDetails +// - ReadDatasetDetails +// - AddDatasetData +// - CreateDataView +// - EditDatasetMetadata +// - DeleteDataset // -// * ViewDatasetDetails -// -// * ReadDatasetDetails -// -// * AddDatasetData -// -// * -// CreateDataView -// -// * EditDatasetMetadata -// -// * DeleteDataset -// -// For more information on -// the dataset permissions, see Supported Dataset Permissions -// (https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions) +// For more information on the dataset permissions, see Supported Dataset +// Permissions (https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions) // in the FinSpace User Guide. type ResourcePermission struct { @@ -546,11 +456,8 @@ type User struct { // Indicates whether the user can use the GetProgrammaticAccessCredentials API to // obtain credentials that can then be used to access other FinSpace Data API // operations. - // - // * ENABLED – The user has permissions to use the APIs. - // - // * DISABLED – - // The user does not have permissions to use any APIs. + // - ENABLED – The user has permissions to use the APIs. + // - DISABLED – The user does not have permissions to use any APIs. ApiAccess ApiAccess // The ARN identifier of an AWS user or role that is allowed to call the @@ -573,40 +480,32 @@ type User struct { // as epoch time in milliseconds. LastDisabledTime int64 - // Describes the last time the user account was enabled. The value is determined as - // epoch time in milliseconds. + // Describes the last time the user account was enabled. The value is determined + // as epoch time in milliseconds. LastEnabledTime int64 // Describes the last time that the user logged into their account. The value is // determined as epoch time in milliseconds. LastLoginTime int64 - // Describes the last time the user account was updated. The value is determined as - // epoch time in milliseconds. + // Describes the last time the user account was updated. The value is determined + // as epoch time in milliseconds. LastModifiedTime int64 // The last name of the user. LastName *string // The current status of the user account. - // - // * CREATING – The user account creation - // is in progress. - // - // * ENABLED – The user account is created and is currently - // active. - // - // * DISABLED – The user account is currently inactive. + // - CREATING – The user account creation is in progress. + // - ENABLED – The user account is created and is currently active. + // - DISABLED – The user account is currently inactive. Status UserStatus // Indicates the type of user. - // - // * SUPER_USER – A user with permission to all the - // functionality and data in FinSpace. - // - // * APP_USER – A user with specific - // permissions in FinSpace. The users are assigned permissions by adding them to a - // permission group. + // - SUPER_USER – A user with permission to all the functionality and data in + // FinSpace. + // - APP_USER – A user with specific permissions in FinSpace. The users are + // assigned permissions by adding them to a permission group. Type UserType // The unique identifier for the user. @@ -619,12 +518,8 @@ type User struct { type UserByPermissionGroup struct { // Indicates whether the user can access FinSpace API operations. - // - // * ENABLED – The - // user has permissions to use the API operations. - // - // * DISABLED – The user does not - // have permissions to use any API operations. + // - ENABLED – The user has permissions to use the API operations. + // - DISABLED – The user does not have permissions to use any API operations. ApiAccess ApiAccess // The IAM ARN identifier that is attached to FinSpace API calls. @@ -641,37 +536,25 @@ type UserByPermissionGroup struct { LastName *string // Indicates the status of the user account within a permission group. - // - // * - // ADDITION_IN_PROGRESS – The user account is currently being added to the - // permission group. - // - // * ADDITION_SUCCESS – The user account is successfully added - // to the permission group. - // - // * REMOVAL_IN_PROGRESS – The user is currently being - // removed from the permission group. + // - ADDITION_IN_PROGRESS – The user account is currently being added to the + // permission group. + // - ADDITION_SUCCESS – The user account is successfully added to the permission + // group. + // - REMOVAL_IN_PROGRESS – The user is currently being removed from the + // permission group. MembershipStatus PermissionGroupMembershipStatus // The current status of the user account. - // - // * CREATING – The user account creation - // is in progress. - // - // * ENABLED – The user account is created and is currently - // active. - // - // * DISABLED – The user account is currently inactive. + // - CREATING – The user account creation is in progress. + // - ENABLED – The user account is created and is currently active. + // - DISABLED – The user account is currently inactive. Status UserStatus // Indicates the type of user. - // - // * SUPER_USER – A user with permission to all the - // functionality and data in FinSpace. - // - // * APP_USER – A user with specific - // permissions in FinSpace. The users are assigned permissions by adding them to a - // permission group. + // - SUPER_USER – A user with permission to all the functionality and data in + // FinSpace. + // - APP_USER – A user with specific permissions in FinSpace. The users are + // assigned permissions by adding them to a permission group. Type UserType // The unique identifier for the user. diff --git a/service/firehose/api_client.go b/service/firehose/api_client.go index d60477d4ba1..173398372a2 100644 --- a/service/firehose/api_client.go +++ b/service/firehose/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/firehose/api_op_CreateDeliveryStream.go b/service/firehose/api_op_CreateDeliveryStream.go index 80fd0189f2f..f22420c3de0 100644 --- a/service/firehose/api_op_CreateDeliveryStream.go +++ b/service/firehose/api_op_CreateDeliveryStream.go @@ -14,61 +14,56 @@ import ( // Creates a Kinesis Data Firehose delivery stream. By default, you can create up // to 50 delivery streams per Amazon Web Services Region. This is an asynchronous // operation that immediately returns. The initial status of the delivery stream is -// CREATING. After the delivery stream is created, its status is ACTIVE and it now -// accepts data. If the delivery stream creation fails, the status transitions to -// CREATING_FAILED. Attempts to send data to a delivery stream that is not in the -// ACTIVE state cause an exception. To check the state of a delivery stream, use -// DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, -// this status doesn't change, and you can't invoke CreateDeliveryStream again on -// it. However, you can invoke the DeleteDeliveryStream operation to delete it. A -// Kinesis Data Firehose delivery stream can be configured to receive records -// directly from providers using PutRecord or PutRecordBatch, or it can be -// configured to use an existing Kinesis stream as its source. To specify a Kinesis -// data stream as input, set the DeliveryStreamType parameter to -// KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) -// and role ARN in the KinesisStreamSourceConfiguration parameter. To create a -// delivery stream with server-side encryption (SSE) enabled, include +// CREATING . After the delivery stream is created, its status is ACTIVE and it +// now accepts data. If the delivery stream creation fails, the status transitions +// to CREATING_FAILED . Attempts to send data to a delivery stream that is not in +// the ACTIVE state cause an exception. To check the state of a delivery stream, +// use DescribeDeliveryStream . If the status of a delivery stream is +// CREATING_FAILED , this status doesn't change, and you can't invoke +// CreateDeliveryStream again on it. However, you can invoke the +// DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery +// stream can be configured to receive records directly from providers using +// PutRecord or PutRecordBatch , or it can be configured to use an existing Kinesis +// stream as its source. To specify a Kinesis data stream as input, set the +// DeliveryStreamType parameter to KinesisStreamAsSource , and provide the Kinesis +// stream Amazon Resource Name (ARN) and role ARN in the +// KinesisStreamSourceConfiguration parameter. To create a delivery stream with +// server-side encryption (SSE) enabled, include // DeliveryStreamEncryptionConfigurationInput in your request. This is optional. -// You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing -// delivery stream that doesn't have SSE enabled. A delivery stream is configured -// with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You -// must specify only one of the following destination configuration parameters: -// ExtendedS3DestinationConfiguration, S3DestinationConfiguration, -// ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or -// SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you -// can also provide the following optional values: BufferingHints, -// EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints -// value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 -// minutes, whichever condition is satisfied first. BufferingHints is a hint, so -// there are some cases where the service cannot adhere to these conditions -// strictly. For example, record boundaries might be such that the size is a little -// over or under the configured buffering size. By default, no encryption is -// performed. We strongly recommend that you enable encryption to ensure secure -// data storage in Amazon S3. A few notes about Amazon Redshift as a +// You can also invoke StartDeliveryStreamEncryption to turn on SSE for an +// existing delivery stream that doesn't have SSE enabled. A delivery stream is +// configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or +// Splunk. You must specify only one of the following destination configuration +// parameters: ExtendedS3DestinationConfiguration , S3DestinationConfiguration , +// ElasticsearchDestinationConfiguration , RedshiftDestinationConfiguration , or +// SplunkDestinationConfiguration . When you specify S3DestinationConfiguration , +// you can also provide the following optional values: BufferingHints, +// EncryptionConfiguration , and CompressionFormat . By default, if no +// BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB +// or for 5 minutes, whichever condition is satisfied first. BufferingHints is a +// hint, so there are some cases where the service cannot adhere to these +// conditions strictly. For example, record boundaries might be such that the size +// is a little over or under the configured buffering size. By default, no +// encryption is performed. We strongly recommend that you enable encryption to +// ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a // destination: +// - An Amazon Redshift destination requires an S3 bucket as intermediate +// location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses +// COPY syntax to load data into an Amazon Redshift table. This is specified in +// the RedshiftDestinationConfiguration.S3Configuration parameter. +// - The compression formats SNAPPY or ZIP cannot be specified in +// RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift +// COPY operation that reads from the S3 bucket doesn't support these compression +// formats. +// - We strongly recommend that you use the user name and password you provide +// exclusively with Kinesis Data Firehose, and that the permissions for the account +// are restricted for Amazon Redshift INSERT permissions. // -// * An Amazon Redshift destination requires an S3 bucket as -// intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 -// and then uses COPY syntax to load data into an Amazon Redshift table. This is -// specified in the RedshiftDestinationConfiguration.S3Configuration parameter. -// -// * -// The compression formats SNAPPY or ZIP cannot be specified in -// RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift -// COPY operation that reads from the S3 bucket doesn't support these compression -// formats. -// -// * We strongly recommend that you use the user name and password you -// provide exclusively with Kinesis Data Firehose, and that the permissions for the -// account are restricted for Amazon Redshift INSERT permissions. -// -// Kinesis Data -// Firehose assumes the IAM role that is configured as part of the destination. The -// role should allow the Kinesis Data Firehose principal to assume the role, and -// the role should have permissions that allow the service to deliver the data. For -// more information, see Grant Kinesis Data Firehose Access to an Amazon S3 -// Destination -// (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) +// Kinesis Data Firehose assumes the IAM role that is configured as part of the +// destination. The role should allow the Kinesis Data Firehose principal to assume +// the role, and the role should have permissions that allow the service to deliver +// the data. For more information, see Grant Kinesis Data Firehose Access to an +// Amazon S3 Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) // in the Amazon Kinesis Data Firehose Developer Guide. func (c *Client) CreateDeliveryStream(ctx context.Context, params *CreateDeliveryStreamInput, optFns ...func(*Options)) (*CreateDeliveryStreamOutput, error) { if params == nil { @@ -108,13 +103,9 @@ type CreateDeliveryStreamInput struct { DeliveryStreamEncryptionConfigurationInput *types.DeliveryStreamEncryptionConfigurationInput // The delivery stream type. This parameter can be one of the following values: - // - // * - // DirectPut: Provider applications access the delivery stream directly. - // - // * - // KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a - // source. + // - DirectPut : Provider applications access the delivery stream directly. + // - KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a + // source. DeliveryStreamType types.DeliveryStreamType // The destination in Amazon ES. You can specify only one destination. @@ -147,8 +138,7 @@ type CreateDeliveryStreamInput struct { // you can define and assign to Amazon Web Services resources. Tags are metadata. // For example, you can add friendly names and descriptions or other types of // information that can help you distinguish the delivery stream. For more - // information about tags, see Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) + // information about tags, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide. You can // specify up to 50 tags when creating a delivery stream. Tags []types.Tag diff --git a/service/firehose/api_op_DeleteDeliveryStream.go b/service/firehose/api_op_DeleteDeliveryStream.go index d3aae0f377c..8b7b1665c40 100644 --- a/service/firehose/api_op_DeleteDeliveryStream.go +++ b/service/firehose/api_op_DeleteDeliveryStream.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a delivery stream and its data. To check the state of a delivery stream, -// use DescribeDeliveryStream. You can delete a delivery stream only if it is in -// one of the following states: ACTIVE, DELETING, CREATING_FAILED, or -// DELETING_FAILED. You can't delete a delivery stream that is in the CREATING +// Deletes a delivery stream and its data. To check the state of a delivery +// stream, use DescribeDeliveryStream . You can delete a delivery stream only if it +// is in one of the following states: ACTIVE , DELETING , CREATING_FAILED , or +// DELETING_FAILED . You can't delete a delivery stream that is in the CREATING // state. While the deletion request is in process, the delivery stream is in the // DELETING state. While the delivery stream is in the DELETING state, the service // might continue to accept records, but it doesn't make any guarantees with @@ -45,8 +45,7 @@ type DeleteDeliveryStreamInput struct { // Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might // be unable to retire the grant due to a customer error, such as when the CMK or // the grant are in an invalid state. If you force deletion, you can then use the - // RevokeGrant - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) + // RevokeGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) // operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to // retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data // Firehose keeps retrying the delete operation. The default value is false. diff --git a/service/firehose/api_op_DescribeDeliveryStream.go b/service/firehose/api_op_DescribeDeliveryStream.go index fc131c5348b..2a885465b05 100644 --- a/service/firehose/api_op_DescribeDeliveryStream.go +++ b/service/firehose/api_op_DescribeDeliveryStream.go @@ -14,9 +14,9 @@ import ( // Describes the specified delivery stream and its status. For example, after your // delivery stream is created, call DescribeDeliveryStream to see whether the // delivery stream is ACTIVE and therefore ready for data to be sent to it. If the -// status of a delivery stream is CREATING_FAILED, this status doesn't change, and +// status of a delivery stream is CREATING_FAILED , this status doesn't change, and // you can't invoke CreateDeliveryStream again on it. However, you can invoke the -// DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, +// DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED , // you can force deletion by invoking DeleteDeliveryStream again but with // DeleteDeliveryStreamInput$AllowForceDelete set to true. func (c *Client) DescribeDeliveryStream(ctx context.Context, params *DescribeDeliveryStreamInput, optFns ...func(*Options)) (*DescribeDeliveryStreamOutput, error) { diff --git a/service/firehose/api_op_ListDeliveryStreams.go b/service/firehose/api_op_ListDeliveryStreams.go index 103721b7ec1..414dbb9c049 100644 --- a/service/firehose/api_op_ListDeliveryStreams.go +++ b/service/firehose/api_op_ListDeliveryStreams.go @@ -13,7 +13,7 @@ import ( // Lists your delivery streams in alphabetical order of their names. The number of // delivery streams might be too large to return using a single call to -// ListDeliveryStreams. You can limit the number of delivery streams returned, +// ListDeliveryStreams . You can limit the number of delivery streams returned, // using the Limit parameter. To determine whether there are more delivery streams // to list, check the value of HasMoreDeliveryStreams in the output. If there are // more delivery streams to list, you can request them by calling this operation @@ -37,21 +37,16 @@ func (c *Client) ListDeliveryStreams(ctx context.Context, params *ListDeliverySt type ListDeliveryStreamsInput struct { // The delivery stream type. This can be one of the following values: - // - // * DirectPut: - // Provider applications access the delivery stream directly. - // - // * - // KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a - // source. - // - // This parameter is optional. If this parameter is omitted, delivery - // streams of all types are returned. + // - DirectPut : Provider applications access the delivery stream directly. + // - KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a + // source. + // This parameter is optional. If this parameter is omitted, delivery streams of + // all types are returned. DeliveryStreamType types.DeliveryStreamType // The list of delivery streams returned by this call to ListDeliveryStreams will // start with the delivery stream whose name comes alphabetically immediately after - // the name you specify in ExclusiveStartDeliveryStreamName. + // the name you specify in ExclusiveStartDeliveryStreamName . ExclusiveStartDeliveryStreamName *string // The maximum number of delivery streams to list. The default value is 10. diff --git a/service/firehose/api_op_ListTagsForDeliveryStream.go b/service/firehose/api_op_ListTagsForDeliveryStream.go index bac19310c9b..cfe43e9cafc 100644 --- a/service/firehose/api_op_ListTagsForDeliveryStream.go +++ b/service/firehose/api_op_ListTagsForDeliveryStream.go @@ -37,7 +37,7 @@ type ListTagsForDeliveryStreamInput struct { // The key to use as the starting point for the list of tags. If you set this // parameter, ListTagsForDeliveryStream gets all tags that occur after - // ExclusiveStartTagKey. + // ExclusiveStartTagKey . ExclusiveStartTagKey *string // The number of tags to return. If this number is less than the total number of @@ -58,8 +58,8 @@ type ListTagsForDeliveryStreamOutput struct { // This member is required. HasMoreTags *bool - // A list of tags associated with DeliveryStreamName, starting with the first tag - // after ExclusiveStartTagKey and up to the specified Limit. + // A list of tags associated with DeliveryStreamName , starting with the first tag + // after ExclusiveStartTagKey and up to the specified Limit . // // This member is required. Tags []types.Tag diff --git a/service/firehose/api_op_PutRecord.go b/service/firehose/api_op_PutRecord.go index 07a019fde3f..7a1124f02b0 100644 --- a/service/firehose/api_op_PutRecord.go +++ b/service/firehose/api_op_PutRecord.go @@ -13,32 +13,32 @@ import ( // Writes a single data record into an Amazon Kinesis Data Firehose delivery // stream. To write multiple data records into a delivery stream, use -// PutRecordBatch. Applications using these operations are referred to as +// PutRecordBatch . Applications using these operations are referred to as // producers. By default, each delivery stream can take in up to 2,000 transactions // per second, 5,000 records per second, or 5 MB per second. If you use PutRecord -// and PutRecordBatch, the limits are an aggregate across these two operations for +// and PutRecordBatch , the limits are an aggregate across these two operations for // each delivery stream. For more information about limits and how to request an -// increase, see Amazon Kinesis Data Firehose Limits -// (https://docs.aws.amazon.com/firehose/latest/dev/limits.html). You must specify -// the name of the delivery stream and the data record when using PutRecord. The -// data record consists of a data blob that can be up to 1,000 KiB in size, and any -// kind of data. For example, it can be a segment from a log file, geographic -// location data, website clickstream data, and so on. Kinesis Data Firehose -// buffers records before delivering them to the destination. To disambiguate the -// data blobs at the destination, a common solution is to use delimiters in the -// data, such as a newline (\n) or some other character unique within the data. -// This allows the consumer application to parse individual data items when reading -// the data from the destination. The PutRecord operation returns a RecordId, which -// is a unique string assigned to each record. Producer applications can use this -// ID for purposes such as auditability and investigation. If the PutRecord -// operation throws a ServiceUnavailableException, back off and retry. If the -// exception persists, it is possible that the throughput limits have been exceeded -// for the delivery stream. Data records sent to Kinesis Data Firehose are stored -// for 24 hours from the time they are added to a delivery stream as it tries to -// send the records to the destination. If the destination is unreachable for more -// than 24 hours, the data is no longer available. Don't concatenate two or more -// base64 strings to form the data fields of your records. Instead, concatenate the -// raw data, then perform base64 encoding. +// increase, see Amazon Kinesis Data Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html) +// . You must specify the name of the delivery stream and the data record when +// using PutRecord . The data record consists of a data blob that can be up to +// 1,000 KiB in size, and any kind of data. For example, it can be a segment from a +// log file, geographic location data, website clickstream data, and so on. Kinesis +// Data Firehose buffers records before delivering them to the destination. To +// disambiguate the data blobs at the destination, a common solution is to use +// delimiters in the data, such as a newline ( \n ) or some other character unique +// within the data. This allows the consumer application to parse individual data +// items when reading the data from the destination. The PutRecord operation +// returns a RecordId , which is a unique string assigned to each record. Producer +// applications can use this ID for purposes such as auditability and +// investigation. If the PutRecord operation throws a ServiceUnavailableException , +// back off and retry. If the exception persists, it is possible that the +// throughput limits have been exceeded for the delivery stream. Data records sent +// to Kinesis Data Firehose are stored for 24 hours from the time they are added to +// a delivery stream as it tries to send the records to the destination. If the +// destination is unreachable for more than 24 hours, the data is no longer +// available. Don't concatenate two or more base64 strings to form the data fields +// of your records. Instead, concatenate the raw data, then perform base64 +// encoding. func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns ...func(*Options)) (*PutRecordOutput, error) { if params == nil { params = &PutRecordInput{} diff --git a/service/firehose/api_op_PutRecordBatch.go b/service/firehose/api_op_PutRecordBatch.go index de7746e77f4..31881156ced 100644 --- a/service/firehose/api_op_PutRecordBatch.go +++ b/service/firehose/api_op_PutRecordBatch.go @@ -13,50 +13,49 @@ import ( // Writes multiple data records into a delivery stream in a single call, which can // achieve higher throughput per producer than when writing single records. To -// write single data records into a delivery stream, use PutRecord. Applications +// write single data records into a delivery stream, use PutRecord . Applications // using these operations are referred to as producers. For information about -// service quota, see Amazon Kinesis Data Firehose Quota -// (https://docs.aws.amazon.com/firehose/latest/dev/limits.html). Each -// PutRecordBatch request supports up to 500 records. Each record in the request -// can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for -// the entire request. These limits cannot be changed. You must specify the name of -// the delivery stream and the data record when using PutRecord. The data record -// consists of a data blob that can be up to 1,000 KB in size, and any kind of -// data. For example, it could be a segment from a log file, geographic location +// service quota, see Amazon Kinesis Data Firehose Quota (https://docs.aws.amazon.com/firehose/latest/dev/limits.html) +// . Each PutRecordBatch request supports up to 500 records. Each record in the +// request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 +// MB for the entire request. These limits cannot be changed. You must specify the +// name of the delivery stream and the data record when using PutRecord . The data +// record consists of a data blob that can be up to 1,000 KB in size, and any kind +// of data. For example, it could be a segment from a log file, geographic location // data, website clickstream data, and so on. Kinesis Data Firehose buffers records // before delivering them to the destination. To disambiguate the data blobs at the // destination, a common solution is to use delimiters in the data, such as a -// newline (\n) or some other character unique within the data. This allows the +// newline ( \n ) or some other character unique within the data. This allows the // consumer application to parse individual data items when reading the data from -// the destination. The PutRecordBatch response includes a count of failed records, -// FailedPutCount, and an array of responses, RequestResponses. Even if the -// PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, -// indicating that there are records for which the operation didn't succeed. Each -// entry in the RequestResponses array provides additional information about the -// processed record. It directly correlates with a record in the request array -// using the same ordering, from the top to the bottom. The response array always -// includes the same number of records as the request array. RequestResponses -// includes both successfully and unsuccessfully processed records. Kinesis Data -// Firehose tries to process all records in each PutRecordBatch request. A single -// record failure does not stop the processing of subsequent records. A -// successfully processed record includes a RecordId value, which is unique for the -// record. An unsuccessfully processed record includes ErrorCode and ErrorMessage -// values. ErrorCode reflects the type of error, and is one of the following -// values: ServiceUnavailableException or InternalFailure. ErrorMessage provides -// more detailed information about the error. If there is an internal server error -// or a timeout, the write might have completed or it might have failed. If -// FailedPutCount is greater than 0, retry the request, resending only those -// records that might have failed processing. This minimizes the possible duplicate -// records and also reduces the total bytes sent (and corresponding charges). We -// recommend that you handle any duplicates at the destination. If PutRecordBatch -// throws ServiceUnavailableException, back off and retry. If the exception -// persists, it is possible that the throughput limits have been exceeded for the -// delivery stream. Data records sent to Kinesis Data Firehose are stored for 24 -// hours from the time they are added to a delivery stream as it attempts to send -// the records to the destination. If the destination is unreachable for more than -// 24 hours, the data is no longer available. Don't concatenate two or more base64 -// strings to form the data fields of your records. Instead, concatenate the raw -// data, then perform base64 encoding. +// the destination. The PutRecordBatch response includes a count of failed +// records, FailedPutCount , and an array of responses, RequestResponses . Even if +// the PutRecordBatch call succeeds, the value of FailedPutCount may be greater +// than 0, indicating that there are records for which the operation didn't +// succeed. Each entry in the RequestResponses array provides additional +// information about the processed record. It directly correlates with a record in +// the request array using the same ordering, from the top to the bottom. The +// response array always includes the same number of records as the request array. +// RequestResponses includes both successfully and unsuccessfully processed +// records. Kinesis Data Firehose tries to process all records in each +// PutRecordBatch request. A single record failure does not stop the processing of +// subsequent records. A successfully processed record includes a RecordId value, +// which is unique for the record. An unsuccessfully processed record includes +// ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is +// one of the following values: ServiceUnavailableException or InternalFailure . +// ErrorMessage provides more detailed information about the error. If there is an +// internal server error or a timeout, the write might have completed or it might +// have failed. If FailedPutCount is greater than 0, retry the request, resending +// only those records that might have failed processing. This minimizes the +// possible duplicate records and also reduces the total bytes sent (and +// corresponding charges). We recommend that you handle any duplicates at the +// destination. If PutRecordBatch throws ServiceUnavailableException , back off and +// retry. If the exception persists, it is possible that the throughput limits have +// been exceeded for the delivery stream. Data records sent to Kinesis Data +// Firehose are stored for 24 hours from the time they are added to a delivery +// stream as it attempts to send the records to the destination. If the destination +// is unreachable for more than 24 hours, the data is no longer available. Don't +// concatenate two or more base64 strings to form the data fields of your records. +// Instead, concatenate the raw data, then perform base64 encoding. func (c *Client) PutRecordBatch(ctx context.Context, params *PutRecordBatchInput, optFns ...func(*Options)) (*PutRecordBatchOutput, error) { if params == nil { params = &PutRecordBatchInput{} @@ -90,8 +89,8 @@ type PutRecordBatchInput struct { type PutRecordBatchOutput struct { // The number of records that might have failed processing. This number might be - // greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to - // determine whether there are records that you need to resend. + // greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount + // to determine whether there are records that you need to resend. // // This member is required. FailedPutCount *int32 diff --git a/service/firehose/api_op_StartDeliveryStreamEncryption.go b/service/firehose/api_op_StartDeliveryStreamEncryption.go index 94067e19071..bfe63fe042c 100644 --- a/service/firehose/api_op_StartDeliveryStreamEncryption.go +++ b/service/firehose/api_op_StartDeliveryStreamEncryption.go @@ -13,36 +13,36 @@ import ( // Enables server-side encryption (SSE) for the delivery stream. This operation is // asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose -// first sets the encryption status of the stream to ENABLING, and then to ENABLED. -// The encryption status of a delivery stream is the Status property in -// DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption -// status changes to ENABLING_FAILED. You can continue to read and write data to -// your delivery stream while the encryption status is ENABLING, but the data is +// first sets the encryption status of the stream to ENABLING , and then to ENABLED +// . The encryption status of a delivery stream is the Status property in +// DeliveryStreamEncryptionConfiguration . If the operation fails, the encryption +// status changes to ENABLING_FAILED . You can continue to read and write data to +// your delivery stream while the encryption status is ENABLING , but the data is // not encrypted. It can take up to 5 seconds after the encryption status changes // to ENABLED before all records written to the delivery stream are encrypted. To // find out whether a record or a batch of records was encrypted, check the -// response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, +// response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted , // respectively. To check the encryption status of a delivery stream, use -// DescribeDeliveryStream. Even if encryption is currently enabled for a delivery +// DescribeDeliveryStream . Even if encryption is currently enabled for a delivery // stream, you can still invoke this operation on it to change the ARN of the CMK // or both its type and ARN. If you invoke this method to change the CMK, and the -// old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose schedules the +// old CMK is of type CUSTOMER_MANAGED_CMK , Kinesis Data Firehose schedules the // grant it had on the old CMK for retirement. If the new CMK is of type -// CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates a grant that enables it to +// CUSTOMER_MANAGED_CMK , Kinesis Data Firehose creates a grant that enables it to // use the new CMK to encrypt and decrypt data and to manage the grant. If a // delivery stream already has encryption enabled and then you invoke this // operation to change the ARN of the CMK or both its type and ARN and you get -// ENABLING_FAILED, this only means that the attempt to change the CMK failed. In +// ENABLING_FAILED , this only means that the attempt to change the CMK failed. In // this case, encryption remains enabled with the old CMK. If the encryption status -// of your delivery stream is ENABLING_FAILED, you can invoke this operation again +// of your delivery stream is ENABLING_FAILED , you can invoke this operation again // with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly // deny the permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt // operations. You can enable SSE for a delivery stream only if it's a delivery // stream that uses DirectPut as its source. The StartDeliveryStreamEncryption and // StopDeliveryStreamEncryption operations have a combined limit of 25 calls per // delivery stream per 24 hours. For example, you reach the limit if you call -// StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times -// for the same delivery stream in a 24-hour period. +// StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 +// times for the same delivery stream in a 24-hour period. func (c *Client) StartDeliveryStreamEncryption(ctx context.Context, params *StartDeliveryStreamEncryptionInput, optFns ...func(*Options)) (*StartDeliveryStreamEncryptionOutput, error) { if params == nil { params = &StartDeliveryStreamEncryptionInput{} diff --git a/service/firehose/api_op_StopDeliveryStreamEncryption.go b/service/firehose/api_op_StopDeliveryStreamEncryption.go index c1cfb9311e0..3ae0b92b5b2 100644 --- a/service/firehose/api_op_StopDeliveryStreamEncryption.go +++ b/service/firehose/api_op_StopDeliveryStreamEncryption.go @@ -10,21 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables server-side encryption (SSE) for the delivery stream. This operation is -// asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose -// first sets the encryption status of the stream to DISABLING, and then to -// DISABLED. You can continue to read and write data to your stream while its -// status is DISABLING. It can take up to 5 seconds after the encryption status +// Disables server-side encryption (SSE) for the delivery stream. This operation +// is asynchronous. It returns immediately. When you invoke it, Kinesis Data +// Firehose first sets the encryption status of the stream to DISABLING , and then +// to DISABLED . You can continue to read and write data to your stream while its +// status is DISABLING . It can take up to 5 seconds after the encryption status // changes to DISABLED before all records written to the delivery stream are no // longer subject to encryption. To find out whether a record or a batch of records // was encrypted, check the response elements PutRecordOutput$Encrypted and -// PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a -// delivery stream, use DescribeDeliveryStream. If SSE is enabled using a customer -// managed CMK and then you invoke StopDeliveryStreamEncryption, Kinesis Data -// Firehose schedules the related KMS grant for retirement and then retires it +// PutRecordBatchOutput$Encrypted , respectively. To check the encryption state of +// a delivery stream, use DescribeDeliveryStream . If SSE is enabled using a +// customer managed CMK and then you invoke StopDeliveryStreamEncryption , Kinesis +// Data Firehose schedules the related KMS grant for retirement and then retires it // after it ensures that it is finished delivering records to the destination. The -// StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a -// combined limit of 25 calls per delivery stream per 24 hours. For example, you +// StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have +// a combined limit of 25 calls per delivery stream per 24 hours. For example, you // reach the limit if you call StartDeliveryStreamEncryption 13 times and // StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour // period. diff --git a/service/firehose/api_op_TagDeliveryStream.go b/service/firehose/api_op_TagDeliveryStream.go index bc9cf1d7d85..eab34000b6e 100644 --- a/service/firehose/api_op_TagDeliveryStream.go +++ b/service/firehose/api_op_TagDeliveryStream.go @@ -16,9 +16,8 @@ import ( // specify a tag that already exists, the tag value is replaced with the value that // you specify in the request. Tags are metadata. For example, you can add friendly // names and descriptions or other types of information that can help you -// distinguish the delivery stream. For more information about tags, see Using Cost -// Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// distinguish the delivery stream. For more information about tags, see Using +// Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide. Each delivery // stream can have up to 50 tags. This operation has a limit of five transactions // per second per account. diff --git a/service/firehose/api_op_UpdateDestination.go b/service/firehose/api_op_UpdateDestination.go index cc6bcab6485..3dfcaea7b5e 100644 --- a/service/firehose/api_op_UpdateDestination.go +++ b/service/firehose/api_op_UpdateDestination.go @@ -33,7 +33,7 @@ import ( // conflicting merges. This is a required field, and the service updates the // configuration only if the existing configuration has a version ID that matches. // After the update is applied successfully, the version ID is updated, and can be -// retrieved using DescribeDeliveryStream. Use the new version ID to set +// retrieved using DescribeDeliveryStream . Use the new version ID to set // CurrentDeliveryStreamVersionId in the next call. func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinationInput, optFns ...func(*Options)) (*UpdateDestinationOutput, error) { if params == nil { @@ -52,12 +52,12 @@ func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinatio type UpdateDestinationInput struct { - // Obtain this value from the VersionId result of DeliveryStreamDescription. This + // Obtain this value from the VersionId result of DeliveryStreamDescription . This // value is required, and helps the service perform conditional operations. For // example, if there is an interleaving update and this value is null, then the - // update destination fails. After the update is successful, the VersionId value is - // updated. The service then performs a merge of the old configuration with the new - // configuration. + // update destination fails. After the update is successful, the VersionId value + // is updated. The service then performs a merge of the old configuration with the + // new configuration. // // This member is required. CurrentDeliveryStreamVersionId *string diff --git a/service/firehose/types/enums.go b/service/firehose/types/enums.go index a96bd2452d5..487440bf06c 100644 --- a/service/firehose/types/enums.go +++ b/service/firehose/types/enums.go @@ -10,9 +10,9 @@ const ( AmazonOpenSearchServerlessS3BackupModeAllDocuments AmazonOpenSearchServerlessS3BackupMode = "AllDocuments" ) -// Values returns all known values for AmazonOpenSearchServerlessS3BackupMode. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for AmazonOpenSearchServerlessS3BackupMode. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (AmazonOpenSearchServerlessS3BackupMode) Values() []AmazonOpenSearchServerlessS3BackupMode { return []AmazonOpenSearchServerlessS3BackupMode{ @@ -289,9 +289,9 @@ const ( HttpEndpointS3BackupModeAllData HttpEndpointS3BackupMode = "AllData" ) -// Values returns all known values for HttpEndpointS3BackupMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for HttpEndpointS3BackupMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpEndpointS3BackupMode) Values() []HttpEndpointS3BackupMode { return []HttpEndpointS3BackupMode{ "FailedDataOnly", @@ -489,9 +489,9 @@ const ( S3BackupModeEnabled S3BackupMode = "Enabled" ) -// Values returns all known values for S3BackupMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for S3BackupMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (S3BackupMode) Values() []S3BackupMode { return []S3BackupMode{ "Disabled", diff --git a/service/firehose/types/errors.go b/service/firehose/types/errors.go index e17c956bcb7..3f842145132 100644 --- a/service/firehose/types/errors.go +++ b/service/firehose/types/errors.go @@ -60,10 +60,10 @@ func (e *InvalidArgumentException) ErrorCode() string { } func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Kinesis Data Firehose throws this exception when an attempt to put records or to -// start or stop delivery stream encryption fails. This happens when the KMS -// service throws one of the following exception types: AccessDeniedException, -// InvalidStateException, DisabledException, or NotFoundException. +// Kinesis Data Firehose throws this exception when an attempt to put records or +// to start or stop delivery stream encryption fails. This happens when the KMS +// service throws one of the following exception types: AccessDeniedException , +// InvalidStateException , DisabledException , or NotFoundException . type InvalidKMSResourceException struct { Message *string @@ -169,11 +169,11 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The service is unavailable. Back off and retry the operation. If you continue to -// see the exception, throughput limits for the delivery stream may have been +// The service is unavailable. Back off and retry the operation. If you continue +// to see the exception, throughput limits for the delivery stream may have been // exceeded. For more information about limits and how to request an increase, see -// Amazon Kinesis Data Firehose Limits -// (https://docs.aws.amazon.com/firehose/latest/dev/limits.html). +// Amazon Kinesis Data Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html) +// . type ServiceUnavailableException struct { Message *string diff --git a/service/firehose/types/types.go b/service/firehose/types/types.go index 99238248221..97b0d7e7162 100644 --- a/service/firehose/types/types.go +++ b/service/firehose/types/types.go @@ -381,13 +381,13 @@ type BufferingHints struct { // Buffer incoming data for the specified period of time, in seconds, before // delivering it to the destination. The default value is 300. This parameter is // optional but if you specify a value for it, you must also specify a value for - // SizeInMBs, and vice versa. + // SizeInMBs , and vice versa. IntervalInSeconds *int32 - // Buffer incoming data to the specified size, in MiBs, before delivering it to the - // destination. The default value is 5. This parameter is optional but if you - // specify a value for it, you must also specify a value for IntervalInSeconds, and - // vice versa. We recommend setting this parameter to a value greater than the + // Buffer incoming data to the specified size, in MiBs, before delivering it to + // the destination. The default value is 5. This parameter is optional but if you + // specify a value for it, you must also specify a value for IntervalInSeconds , + // and vice versa. We recommend setting this parameter to a value greater than the // amount of data you typically ingest into the delivery stream in 10 seconds. For // example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB // or higher. @@ -406,8 +406,8 @@ type CloudWatchLoggingOptions struct { // logging is enabled. LogGroupName *string - // The CloudWatch log stream name for logging. This value is required if CloudWatch - // logging is enabled. + // The CloudWatch log stream name for logging. This value is required if + // CloudWatch logging is enabled. LogStreamName *string noSmithyDocumentSerde @@ -423,7 +423,7 @@ type CopyCommand struct { // Optional parameters to use with the Amazon Redshift COPY command. For more // information, see the "Optional Parameters" section of Amazon Redshift COPY - // command (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html). Some + // command (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) . Some // possible examples that would apply to Kinesis Data Firehose are as follows: // delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and // compressed using lzop. delimiter '|' - fields are delimited with "|" (this is @@ -432,8 +432,8 @@ type CopyCommand struct { // fields are fixed width in the source, with each width specified after every // column in the table. JSON 's3://mybucket/jsonpaths.txt' - data is in JSON // format, and the path specified is the format of the data. For more examples, see - // Amazon Redshift COPY command examples - // (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html). + // Amazon Redshift COPY command examples (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html) + // . CopyOptions *string // A comma-separated list of column names. @@ -447,17 +447,17 @@ type CopyCommand struct { // Firehose uses the serializer and deserializer that you specify, in addition to // the column information from the Amazon Web Services Glue table, to deserialize // your input data from JSON and then serialize it to the Parquet or ORC format. -// For more information, see Kinesis Data Firehose Record Format Conversion -// (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html). +// For more information, see Kinesis Data Firehose Record Format Conversion (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html) +// . type DataFormatConversionConfiguration struct { - // Defaults to true. Set it to false if you want to disable format conversion while - // preserving the configuration details. + // Defaults to true . Set it to false if you want to disable format conversion + // while preserving the configuration details. Enabled *bool - // Specifies the deserializer that you want Kinesis Data Firehose to use to convert - // the format of your data from JSON. This parameter is required if Enabled is set - // to true. + // Specifies the deserializer that you want Kinesis Data Firehose to use to + // convert the format of your data from JSON. This parameter is required if Enabled + // is set to true. InputFormatConfiguration *InputFormatConfiguration // Specifies the serializer that you want Kinesis Data Firehose to use to convert @@ -475,9 +475,9 @@ type DataFormatConversionConfiguration struct { // Contains information about a delivery stream. type DeliveryStreamDescription struct { - // The Amazon Resource Name (ARN) of the delivery stream. For more information, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The Amazon Resource Name (ARN) of the delivery stream. For more information, + // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. DeliveryStreamARN *string @@ -488,7 +488,7 @@ type DeliveryStreamDescription struct { DeliveryStreamName *string // The status of the delivery stream. If the status of a delivery stream is - // CREATING_FAILED, this status doesn't change, and you can't invoke + // CREATING_FAILED , this status doesn't change, and you can't invoke // CreateDeliveryStream again on it. However, you can invoke the // DeleteDeliveryStream operation to delete it. // @@ -496,13 +496,9 @@ type DeliveryStreamDescription struct { DeliveryStreamStatus DeliveryStreamStatus // The delivery stream type. This can be one of the following values: - // - // * DirectPut: - // Provider applications access the delivery stream directly. - // - // * - // KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a - // source. + // - DirectPut : Provider applications access the delivery stream directly. + // - KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a + // source. // // This member is required. DeliveryStreamType DeliveryStreamType @@ -532,14 +528,14 @@ type DeliveryStreamDescription struct { DeliveryStreamEncryptionConfiguration *DeliveryStreamEncryptionConfiguration // Provides details in case one of the following operations fails due to an error - // related to KMS: CreateDeliveryStream, DeleteDeliveryStream, - // StartDeliveryStreamEncryption, StopDeliveryStreamEncryption. + // related to KMS: CreateDeliveryStream , DeleteDeliveryStream , + // StartDeliveryStreamEncryption , StopDeliveryStreamEncryption . FailureDescription *FailureDescription // The date and time that the delivery stream was last updated. LastUpdateTimestamp *time.Time - // If the DeliveryStreamType parameter is KinesisStreamAsSource, a + // If the DeliveryStreamType parameter is KinesisStreamAsSource , a // SourceDescription object describing the source Kinesis data stream. Source *SourceDescription @@ -553,25 +549,25 @@ type DeliveryStreamDescription struct { type DeliveryStreamEncryptionConfiguration struct { // Provides details in case one of the following operations fails due to an error - // related to KMS: CreateDeliveryStream, DeleteDeliveryStream, - // StartDeliveryStreamEncryption, StopDeliveryStreamEncryption. + // related to KMS: CreateDeliveryStream , DeleteDeliveryStream , + // StartDeliveryStreamEncryption , StopDeliveryStreamEncryption . FailureDescription *FailureDescription - // If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer - // managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, - // DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN. + // If KeyType is CUSTOMER_MANAGED_CMK , this field contains the ARN of the customer + // managed CMK. If KeyType is Amazon Web Services_OWNED_CMK , + // DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN . KeyARN *string - // Indicates the type of customer master key (CMK) that is used for encryption. The - // default setting is Amazon Web Services_OWNED_CMK. For more information about - // CMKs, see Customer Master Keys (CMKs) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). + // Indicates the type of customer master key (CMK) that is used for encryption. + // The default setting is Amazon Web Services_OWNED_CMK . For more information + // about CMKs, see Customer Master Keys (CMKs) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) + // . KeyType KeyType // This is the server-side encryption (SSE) status for the delivery stream. For a // full description of the different values of this status, see - // StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status - // is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent + // StartDeliveryStreamEncryption and StopDeliveryStreamEncryption . If this status + // is ENABLING_FAILED or DISABLING_FAILED , it is the status of the most recent // attempt to enable or disable SSE, respectively. Status DeliveryStreamEncryptionStatus @@ -583,33 +579,30 @@ type DeliveryStreamEncryptionConfiguration struct { type DeliveryStreamEncryptionConfigurationInput struct { // Indicates the type of customer master key (CMK) to use for encryption. The - // default setting is Amazon Web Services_OWNED_CMK. For more information about - // CMKs, see Customer Master Keys (CMKs) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). - // When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with + // default setting is Amazon Web Services_OWNED_CMK . For more information about + // CMKs, see Customer Master Keys (CMKs) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) + // . When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with // KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon - // KMS operation CreateGrant - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) to - // create a grant that allows the Kinesis Data Firehose service to use the customer - // managed CMK to perform encryption and decryption. Kinesis Data Firehose manages - // that grant. When you invoke StartDeliveryStreamEncryption to change the CMK for - // a delivery stream that is encrypted with a customer managed CMK, Kinesis Data - // Firehose schedules the grant it had on the old CMK for retirement. You can use a - // CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a - // CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this - // limit, Kinesis Data Firehose throws a LimitExceededException. To encrypt your + // KMS operation CreateGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) + // to create a grant that allows the Kinesis Data Firehose service to use the + // customer managed CMK to perform encryption and decryption. Kinesis Data Firehose + // manages that grant. When you invoke StartDeliveryStreamEncryption to change the + // CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis + // Data Firehose schedules the grant it had on the old CMK for retirement. You can + // use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If + // a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this + // limit, Kinesis Data Firehose throws a LimitExceededException . To encrypt your // delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support // asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About - // Symmetric and Asymmetric CMKs - // (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) + // Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) // in the Amazon Web Services Key Management Service developer guide. // // This member is required. KeyType KeyType - // If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource - // Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, - // Kinesis Data Firehose uses a service-account CMK. + // If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon + // Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web + // Services_OWNED_CMK , Kinesis Data Firehose uses a service-account CMK. KeyARN *string noSmithyDocumentSerde @@ -617,10 +610,9 @@ type DeliveryStreamEncryptionConfigurationInput struct { // The deserializer you want Kinesis Data Firehose to use for converting the input // data from JSON. Kinesis Data Firehose then serializes the data to its final -// format using the Serializer. Kinesis Data Firehose supports two types of -// deserializers: the Apache Hive JSON SerDe -// (https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) -// and the OpenX JSON SerDe (https://github.com/rcongiu/Hive-JSON-Serde). +// format using the Serializer . Kinesis Data Firehose supports two types of +// deserializers: the Apache Hive JSON SerDe (https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON) +// and the OpenX JSON SerDe (https://github.com/rcongiu/Hive-JSON-Serde) . type Deserializer struct { // The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for @@ -684,8 +676,8 @@ type DynamicPartitioningConfiguration struct { // Firehose delivery stream. Enabled *bool - // The retry behavior in case Kinesis Data Firehose is unable to deliver data to an - // Amazon S3 prefix. + // The retry behavior in case Kinesis Data Firehose is unable to deliver data to + // an Amazon S3 prefix. RetryOptions *RetryOptions noSmithyDocumentSerde @@ -720,10 +712,9 @@ type ElasticsearchDestinationConfiguration struct { // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data // Firehose for calling the Amazon ES Configuration API and for indexing documents. // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 - // Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) - // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) + // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -745,18 +736,16 @@ type ElasticsearchDestinationConfiguration struct { ClusterEndpoint *string // The ARN of the Amazon ES domain. The IAM role must have permissions for - // DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the + // DescribeDomain , DescribeDomains , and DescribeDomainConfig after assuming the // role specified in RoleARN. For more information, see Amazon Resource Names - // (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // Specify either ClusterEndpoint or DomainARN. + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . Specify either ClusterEndpoint or DomainARN . DomainARN *string // The Elasticsearch index rotation period. Index rotation appends a timestamp to // the IndexName to facilitate the expiration of old data. For more information, - // see Index Rotation for the Amazon ES Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). - // The default value is OneDay. + // see Index Rotation for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) + // . The default value is OneDay . IndexRotationPeriod ElasticsearchIndexRotationPeriod // The data processing configuration. @@ -767,22 +756,21 @@ type ElasticsearchDestinationConfiguration struct { RetryOptions *ElasticsearchRetryOptions // Defines how documents should be delivered to Amazon S3. When it is set to - // FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not + // FailedDocumentsOnly , Kinesis Data Firehose writes any documents that could not // be indexed to the configured Amazon S3 destination, with // AmazonOpenSearchService-failed/ appended to the key prefix. When set to - // AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, + // AllDocuments , Kinesis Data Firehose delivers all incoming records to Amazon S3, // and also writes failed documents with AmazonOpenSearchService-failed/ appended // to the prefix. For more information, see Amazon S3 Backup for the Amazon ES - // Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup). - // Default value is FailedDocumentsOnly. You can't change this backup mode after + // Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup) + // . Default value is FailedDocumentsOnly . You can't change this backup mode after // you create the delivery stream. S3BackupMode ElasticsearchS3BackupMode // The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type // per index. If you try to specify a new type for an existing index that already // has another type, Kinesis Data Firehose returns an error during run time. For - // Elasticsearch 7.x, don't specify a TypeName. + // Elasticsearch 7.x, don't specify a TypeName . TypeName *string // The details of the VPC of the Amazon ES destination. @@ -805,11 +793,10 @@ type ElasticsearchDestinationDescription struct { // ES. ClusterEndpoint *string - // The ARN of the Amazon ES domain. For more information, see Amazon Resource Names - // (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to - // Amazon ES. + // The ARN of the Amazon ES domain. For more information, see Amazon Resource + // Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data + // to Amazon ES. DomainARN *string // The Elasticsearch index name. @@ -826,8 +813,8 @@ type ElasticsearchDestinationDescription struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . RoleARN *string // The Amazon S3 backup mode. @@ -838,7 +825,7 @@ type ElasticsearchDestinationDescription struct { // The Elasticsearch type name. This applies to Elasticsearch 6.x and lower // versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for - // TypeName. + // TypeName . TypeName *string // The details of the VPC of the Amazon ES destination. @@ -862,11 +849,10 @@ type ElasticsearchDestinationUpdate struct { ClusterEndpoint *string // The ARN of the Amazon ES domain. The IAM role must have permissions for - // DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM - // role specified in RoleARN. For more information, see Amazon Resource Names - // (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // Specify either ClusterEndpoint or DomainARN. + // DescribeDomain , DescribeDomains , and DescribeDomainConfig after assuming the + // IAM role specified in RoleARN . For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . Specify either ClusterEndpoint or DomainARN . DomainARN *string // The Elasticsearch index name. @@ -874,9 +860,8 @@ type ElasticsearchDestinationUpdate struct { // The Elasticsearch index rotation period. Index rotation appends a timestamp to // IndexName to facilitate the expiration of old data. For more information, see - // Index Rotation for the Amazon ES Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). - // Default value is OneDay. + // Index Rotation for the Amazon ES Destination (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) + // . Default value is OneDay . IndexRotationPeriod ElasticsearchIndexRotationPeriod // The data processing configuration. @@ -889,10 +874,9 @@ type ElasticsearchDestinationUpdate struct { // The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data // Firehose for calling the Amazon ES Configuration API and for indexing documents. // For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 - // Destination - // (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) - // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) + // and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . RoleARN *string // The Amazon S3 destination. @@ -904,7 +888,7 @@ type ElasticsearchDestinationUpdate struct { // upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, // Kinesis Data Firehose still delivers data to Elasticsearch with the old index // name and type name. If you want to update your delivery stream with a new index - // name, provide an empty string for TypeName. + // name, provide an empty string for TypeName . TypeName *string noSmithyDocumentSerde @@ -940,17 +924,17 @@ type EncryptionConfiguration struct { // Describes the configuration of a destination in Amazon S3. type ExtendedS3DestinationConfiguration struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. BucketARN *string // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -979,14 +963,15 @@ type ExtendedS3DestinationConfiguration struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string // The data processing configuration. @@ -995,8 +980,8 @@ type ExtendedS3DestinationConfiguration struct { // The configuration for backup in Amazon S3. S3BackupConfiguration *S3DestinationConfiguration - // The Amazon S3 backup mode. After you create a delivery stream, you can update it - // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't + // The Amazon S3 backup mode. After you create a delivery stream, you can update + // it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't // update the delivery stream to disable it. S3BackupMode S3BackupMode @@ -1006,9 +991,9 @@ type ExtendedS3DestinationConfiguration struct { // Describes a destination in Amazon S3. type ExtendedS3DestinationDescription struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. BucketARN *string @@ -1018,7 +1003,7 @@ type ExtendedS3DestinationDescription struct { // This member is required. BufferingHints *BufferingHints - // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression format. If no value is specified, the default is UNCOMPRESSED . // // This member is required. CompressionFormat CompressionFormat @@ -1031,8 +1016,8 @@ type ExtendedS3DestinationDescription struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -1051,14 +1036,15 @@ type ExtendedS3DestinationDescription struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string // The data processing configuration. @@ -1076,9 +1062,9 @@ type ExtendedS3DestinationDescription struct { // Describes an update for a destination in Amazon S3. type ExtendedS3DestinationUpdate struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . BucketARN *string // The buffering option. @@ -1087,7 +1073,7 @@ type ExtendedS3DestinationUpdate struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression format. If no value is specified, the default is UNCOMPRESSED . CompressionFormat CompressionFormat // The serializer, deserializer, and schema for converting data from the JSON @@ -1105,14 +1091,15 @@ type ExtendedS3DestinationUpdate struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string // The data processing configuration. @@ -1120,8 +1107,8 @@ type ExtendedS3DestinationUpdate struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . RoleARN *string // You can update a delivery stream to enable Amazon S3 backup if it is disabled. @@ -1135,8 +1122,8 @@ type ExtendedS3DestinationUpdate struct { } // Provides details in case one of the following operations fails due to an error -// related to KMS: CreateDeliveryStream, DeleteDeliveryStream, -// StartDeliveryStreamEncryption, StopDeliveryStreamEncryption. +// related to KMS: CreateDeliveryStream , DeleteDeliveryStream , +// StartDeliveryStreamEncryption , StopDeliveryStreamEncryption . type FailureDescription struct { // A message providing details about the error that caused the failure. @@ -1162,9 +1149,8 @@ type HiveJsonSerDe struct { // Indicates how you want Kinesis Data Firehose to parse the date and timestamps // that may be present in your input data JSON. To specify these format strings, // follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more - // information, see Class DateTimeFormat - // (https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html). - // You can also use the special value millis to parse timestamps in epoch + // information, see Class DateTimeFormat (https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html) + // . You can also use the special value millis to parse timestamps in epoch // milliseconds. If you don't specify a format, Kinesis Data Firehose uses // java.sql.Timestamp::valueOf by default. TimestampFormats []string @@ -1215,9 +1201,9 @@ type HttpEndpointCommonAttribute struct { type HttpEndpointConfiguration struct { // The URL of the HTTP endpoint selected as the destination. If you choose an HTTP - // endpoint as your destination, review and follow the instructions in the Appendix - // - HTTP Endpoint Delivery Request and Response Specifications - // (https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html). + // endpoint as your destination, review and follow the instructions in the + // Appendix - HTTP Endpoint Delivery Request and Response Specifications (https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html) + // . // // This member is required. Url *string @@ -1257,9 +1243,9 @@ type HttpEndpointDestinationConfiguration struct { // This member is required. S3Configuration *S3DestinationConfiguration - // The buffering options that can be used before data is delivered to the specified - // destination. Kinesis Data Firehose treats these options as hints, and it might - // choose to use more optimal values. The SizeInMBs and IntervalInSeconds + // The buffering options that can be used before data is delivered to the + // specified destination. Kinesis Data Firehose treats these options as hints, and + // it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds // parameters are optional. However, if you specify a value for one of them, you // must also provide a value for the other. BufferingHints *HttpEndpointBufferingHints @@ -1284,9 +1270,9 @@ type HttpEndpointDestinationConfiguration struct { RoleARN *string // Describes the S3 bucket backup options for the data that Kinesis Data Firehose - // delivers to the HTTP endpoint destination. You can back up all documents - // (AllData) or only the documents that Kinesis Data Firehose could not deliver to - // the specified HTTP endpoint destination (FailedDataOnly). + // delivers to the HTTP endpoint destination. You can back up all documents ( + // AllData ) or only the documents that Kinesis Data Firehose could not deliver to + // the specified HTTP endpoint destination ( FailedDataOnly ). S3BackupMode HttpEndpointS3BackupMode noSmithyDocumentSerde @@ -1325,9 +1311,9 @@ type HttpEndpointDestinationDescription struct { RoleARN *string // Describes the S3 bucket backup options for the data that Kinesis Firehose - // delivers to the HTTP endpoint destination. You can back up all documents - // (AllData) or only the documents that Kinesis Data Firehose could not deliver to - // the specified HTTP endpoint destination (FailedDataOnly). + // delivers to the HTTP endpoint destination. You can back up all documents ( + // AllData ) or only the documents that Kinesis Data Firehose could not deliver to + // the specified HTTP endpoint destination ( FailedDataOnly ). S3BackupMode HttpEndpointS3BackupMode // Describes a destination in Amazon S3. @@ -1369,9 +1355,9 @@ type HttpEndpointDestinationUpdate struct { RoleARN *string // Describes the S3 bucket backup options for the data that Kinesis Firehose - // delivers to the HTTP endpoint destination. You can back up all documents - // (AllData) or only the documents that Kinesis Data Firehose could not deliver to - // the specified HTTP endpoint destination (FailedDataOnly). + // delivers to the HTTP endpoint destination. You can back up all documents ( + // AllData ) or only the documents that Kinesis Data Firehose could not deliver to + // the specified HTTP endpoint destination ( FailedDataOnly ). S3BackupMode HttpEndpointS3BackupMode // Describes an update for a destination in Amazon S3. @@ -1388,9 +1374,8 @@ type HttpEndpointRequestConfiguration struct { // Kinesis Data Firehose uses the content encoding to compress the body of a // request before sending the request to the destination. For more information, see - // Content-Encoding - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) in - // MDN Web Docs, the official Mozilla documentation. + // Content-Encoding (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding) + // in MDN Web Docs, the official Mozilla documentation. ContentEncoding ContentEncoding noSmithyDocumentSerde @@ -1428,16 +1413,16 @@ type InputFormatConfiguration struct { type KinesisStreamSourceConfiguration struct { // The ARN of the source Kinesis data stream. For more information, see Amazon - // Kinesis Data Streams ARN Format - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // Kinesis Data Streams ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . // // This member is required. KinesisStreamARN *string // The ARN of the role that provides access to the source Kinesis data stream. For // more information, see Amazon Web Services Identity and Access Management (IAM) - // ARN Format - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). + // ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) + // . // // This member is required. RoleARN *string @@ -1454,14 +1439,14 @@ type KinesisStreamSourceDescription struct { DeliveryStartTimestamp *time.Time // The Amazon Resource Name (ARN) of the source Kinesis data stream. For more - // information, see Amazon Kinesis Data Streams ARN Format - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // information, see Amazon Kinesis Data Streams ARN Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . KinesisStreamARN *string // The ARN of the role used by the source Kinesis data stream. For more // information, see Amazon Web Services Identity and Access Management (IAM) ARN - // Format - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam). + // Format (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) + // . RoleARN *string noSmithyDocumentSerde @@ -1473,8 +1458,8 @@ type KMSEncryptionConfig struct { // The Amazon Resource Name (ARN) of the encryption key. Must belong to the same // Amazon Web Services Region as the destination Amazon S3 bucket. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. AWSKMSKeyARN *string @@ -1489,28 +1474,28 @@ type KMSEncryptionConfig struct { // the native Hive / HCatalog JsonSerDe. type OpenXJsonSerDe struct { - // When set to true, which is the default, Kinesis Data Firehose converts JSON keys - // to lowercase before deserializing them. + // When set to true , which is the default, Kinesis Data Firehose converts JSON + // keys to lowercase before deserializing them. CaseInsensitive *bool // Maps column names to JSON keys that aren't identical to the column names. This // is useful when the JSON contains keys that are Hive keywords. For example, - // timestamp is a Hive keyword. If you have a JSON key named timestamp, set this - // parameter to {"ts": "timestamp"} to map this key to a column named ts. + // timestamp is a Hive keyword. If you have a JSON key named timestamp , set this + // parameter to {"ts": "timestamp"} to map this key to a column named ts . ColumnToJsonKeyMappings map[string]string - // When set to true, specifies that the names of the keys include dots and that you - // want Kinesis Data Firehose to replace them with underscores. This is useful + // When set to true , specifies that the names of the keys include dots and that + // you want Kinesis Data Firehose to replace them with underscores. This is useful // because Apache Hive does not allow dots in column names. For example, if the // JSON contains a key whose name is "a.b", you can define the column name to be - // "a_b" when using this option. The default is false. + // "a_b" when using this option. The default is false . ConvertDotsInJsonKeysToUnderscores *bool noSmithyDocumentSerde } // A serializer to use for converting data to the ORC format before storing it in -// Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/). +// Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/) . type OrcSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you @@ -1520,15 +1505,15 @@ type OrcSerDe struct { BlockSizeBytes *int32 // The column names for which you want Kinesis Data Firehose to create bloom - // filters. The default is null. + // filters. The default is null . BloomFilterColumns []string - // The Bloom filter false positive probability (FPP). The lower the FPP, the bigger - // the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum - // is 1. + // The Bloom filter false positive probability (FPP). The lower the FPP, the + // bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the + // maximum is 1. BloomFilterFalsePositiveProbability *float64 - // The compression code to use over data blocks. The default is SNAPPY. + // The compression code to use over data blocks. The default is SNAPPY . Compression OrcCompression // Represents the fraction of the total number of non-null rows. To turn off @@ -1539,11 +1524,11 @@ type OrcSerDe struct { // Set this to true to indicate that you want stripes to be padded to the HDFS // block boundaries. This is useful if you intend to copy the data from Amazon S3 - // to HDFS before querying. The default is false. + // to HDFS before querying. The default is false . EnablePadding *bool - // The version of the file to write. The possible values are V0_11 and V0_12. The - // default is V0_12. + // The version of the file to write. The possible values are V0_11 and V0_12 . The + // default is V0_12 . FormatVersion OrcFormatVersion // A number between 0 and 1 that defines the tolerance for block padding as a @@ -1554,7 +1539,7 @@ type OrcSerDe struct { // available size within the block is more than 3.2 MiB, a new, smaller stripe is // inserted to fit within that space. This ensures that no stripe crosses block // boundaries and causes remote reads within a node-local task. Kinesis Data - // Firehose ignores this parameter when OrcSerDe$EnablePadding is false. + // Firehose ignores this parameter when OrcSerDe$EnablePadding is false . PaddingTolerance *float64 // The number of rows between index entries. The default is 10,000 and the minimum @@ -1581,8 +1566,8 @@ type OutputFormatConfiguration struct { } // A serializer to use for converting data to the Parquet format before storing it -// in Amazon S3. For more information, see Apache Parquet -// (https://parquet.apache.org/documentation/latest/). +// in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/documentation/latest/) +// . type ParquetSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you @@ -1592,16 +1577,16 @@ type ParquetSerDe struct { BlockSizeBytes *int32 // The compression code to use over data blocks. The possible values are - // UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for - // higher decompression speed. Use GZIP if the compression ratio is more important - // than speed. + // UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY + // for higher decompression speed. Use GZIP if the compression ratio is more + // important than speed. Compression ParquetCompression // Indicates whether to enable dictionary compression. EnableDictionaryCompression *bool - // The maximum amount of padding to apply. This is useful if you intend to copy the - // data from Amazon S3 to HDFS before querying. The default is 0. + // The maximum amount of padding to apply. This is useful if you intend to copy + // the data from Amazon S3 to HDFS before querying. The default is 0. MaxPaddingBytes *int32 // The Parquet page size. Column chunks are divided into pages. A page is @@ -1609,8 +1594,8 @@ type ParquetSerDe struct { // minimum value is 64 KiB and the default is 1 MiB. PageSizeBytes *int32 - // Indicates the version of row format to output. The possible values are V1 and - // V2. The default is V1. + // Indicates the version of row format to output. The possible values are V1 and V2 + // . The default is V1 . WriterVersion ParquetWriterVersion noSmithyDocumentSerde @@ -1645,8 +1630,8 @@ type Processor struct { // Describes the processor parameter. type ProcessorParameter struct { - // The name of the parameter. Currently the following default values are supported: - // 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The + // The name of the parameter. Currently the following default values are + // supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The // BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint // is 1MB for all destinations, except Splunk. For Splunk, the default buffering // hint is 256 KB. @@ -1712,18 +1697,18 @@ type RedshiftDestinationConfiguration struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string // The configuration for the intermediate Amazon S3 location from which Amazon // Redshift obtains data. Restrictions are described in the topic for - // CreateDeliveryStream. The compression formats SNAPPY or ZIP cannot be specified - // in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift - // COPY operation that reads from the S3 bucket doesn't support these compression - // formats. + // CreateDeliveryStream . The compression formats SNAPPY or ZIP cannot be + // specified in RedshiftDestinationConfiguration.S3Configuration because the + // Amazon Redshift COPY operation that reads from the S3 bucket doesn't support + // these compression formats. // // This member is required. S3Configuration *S3DestinationConfiguration @@ -1746,8 +1731,8 @@ type RedshiftDestinationConfiguration struct { // The configuration for backup in Amazon S3. S3BackupConfiguration *S3DestinationConfiguration - // The Amazon S3 backup mode. After you create a delivery stream, you can update it - // to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't + // The Amazon S3 backup mode. After you create a delivery stream, you can update + // it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't // update the delivery stream to disable it. S3BackupMode RedshiftS3BackupMode @@ -1769,8 +1754,8 @@ type RedshiftDestinationDescription struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -1828,8 +1813,8 @@ type RedshiftDestinationUpdate struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . RoleARN *string // You can update a delivery stream to enable Amazon S3 backup if it is disabled. @@ -1865,12 +1850,12 @@ type RedshiftRetryOptions struct { noSmithyDocumentSerde } -// The retry behavior in case Kinesis Data Firehose is unable to deliver data to an -// Amazon S3 prefix. +// The retry behavior in case Kinesis Data Firehose is unable to deliver data to +// an Amazon S3 prefix. type RetryOptions struct { - // The period of time during which Kinesis Data Firehose retries to deliver data to - // the specified Amazon S3 prefix. + // The period of time during which Kinesis Data Firehose retries to deliver data + // to the specified Amazon S3 prefix. DurationInSeconds *int32 noSmithyDocumentSerde @@ -1879,17 +1864,17 @@ type RetryOptions struct { // Describes the configuration of a destination in Amazon S3. type S3DestinationConfiguration struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. BucketARN *string // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -1901,7 +1886,7 @@ type S3DestinationConfiguration struct { // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression format. If no value is specified, the default is UNCOMPRESSED . // The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift // destinations because they are not supported by the Amazon Redshift COPY // operation that reads from the S3 bucket. @@ -1913,14 +1898,15 @@ type S3DestinationConfiguration struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string noSmithyDocumentSerde @@ -1929,9 +1915,9 @@ type S3DestinationConfiguration struct { // Describes a destination in Amazon S3. type S3DestinationDescription struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. BucketARN *string @@ -1942,7 +1928,7 @@ type S3DestinationDescription struct { // This member is required. BufferingHints *BufferingHints - // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression format. If no value is specified, the default is UNCOMPRESSED . // // This member is required. CompressionFormat CompressionFormat @@ -1955,8 +1941,8 @@ type S3DestinationDescription struct { // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . // // This member is required. RoleARN *string @@ -1966,14 +1952,15 @@ type S3DestinationDescription struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string noSmithyDocumentSerde @@ -1982,9 +1969,9 @@ type S3DestinationDescription struct { // Describes an update for a destination in Amazon S3. type S3DestinationUpdate struct { - // The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) - // and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // The ARN of the S3 bucket. For more information, see Amazon Resource Names + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . BucketARN *string // The buffering option. If no value is specified, BufferingHints object default @@ -1994,7 +1981,7 @@ type S3DestinationUpdate struct { // The CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The compression format. If no value is specified, the default is UNCOMPRESSED. + // The compression format. If no value is specified, the default is UNCOMPRESSED . // The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift // destinations because they are not supported by the Amazon Redshift COPY // operation that reads from the S3 bucket. @@ -2006,20 +1993,21 @@ type S3DestinationUpdate struct { // A prefix that Kinesis Data Firehose evaluates and adds to failed records before // writing them to S3. This prefix appears immediately following the bucket name. - // For information about how to specify this prefix, see Custom Prefixes for Amazon - // S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // For information about how to specify this prefix, see Custom Prefixes for + // Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . ErrorOutputPrefix *string // The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered // Amazon S3 files. You can also specify a custom prefix, as described in Custom - // Prefixes for Amazon S3 Objects - // (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). + // Prefixes for Amazon S3 Objects (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) + // . Prefix *string // The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more // information, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . RoleARN *string noSmithyDocumentSerde @@ -2035,9 +2023,9 @@ type SchemaConfiguration struct { CatalogId *string // Specifies the name of the Amazon Web Services Glue database that contains the - // schema for the output data. If the SchemaConfiguration request parameter is used - // as part of invoking the CreateDeliveryStream API, then the DatabaseName property - // is required and its value must be specified. + // schema for the output data. If the SchemaConfiguration request parameter is + // used as part of invoking the CreateDeliveryStream API, then the DatabaseName + // property is required and its value must be specified. DatabaseName *string // If you don't specify an Amazon Web Services Region, the default is the current @@ -2046,41 +2034,40 @@ type SchemaConfiguration struct { // The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. // This role must be in the same account you use for Kinesis Data Firehose. - // Cross-account roles aren't allowed. If the SchemaConfiguration request parameter - // is used as part of invoking the CreateDeliveryStream API, then the RoleARN - // property is required and its value must be specified. + // Cross-account roles aren't allowed. If the SchemaConfiguration request + // parameter is used as part of invoking the CreateDeliveryStream API, then the + // RoleARN property is required and its value must be specified. RoleARN *string // Specifies the Amazon Web Services Glue table that contains the column // information that constitutes your data schema. If the SchemaConfiguration - // request parameter is used as part of invoking the CreateDeliveryStream API, then - // the TableName property is required and its value must be specified. + // request parameter is used as part of invoking the CreateDeliveryStream API, + // then the TableName property is required and its value must be specified. TableName *string // Specifies the table version for the output data schema. If you don't specify - // this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most - // recent version. This means that any updates to the table are automatically + // this version ID, or if you set it to LATEST , Kinesis Data Firehose uses the + // most recent version. This means that any updates to the table are automatically // picked up. VersionId *string noSmithyDocumentSerde } -// The serializer that you want Kinesis Data Firehose to use to convert data to the -// target format before writing it to Amazon S3. Kinesis Data Firehose supports two -// types of serializers: the ORC SerDe -// (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html) -// and the Parquet SerDe -// (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html). +// The serializer that you want Kinesis Data Firehose to use to convert data to +// the target format before writing it to Amazon S3. Kinesis Data Firehose supports +// two types of serializers: the ORC SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html) +// and the Parquet SerDe (https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html) +// . type Serializer struct { // A serializer to use for converting data to the ORC format before storing it in - // Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/). + // Amazon S3. For more information, see Apache ORC (https://orc.apache.org/docs/) . OrcSerDe *OrcSerDe // A serializer to use for converting data to the Parquet format before storing it - // in Amazon S3. For more information, see Apache Parquet - // (https://parquet.apache.org/documentation/latest/). + // in Amazon S3. For more information, see Apache Parquet (https://parquet.apache.org/documentation/latest/) + // . ParquetSerDe *ParquetSerDe noSmithyDocumentSerde @@ -2124,10 +2111,10 @@ type SplunkDestinationConfiguration struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends it data. At the end of the timeout period, Kinesis - // Data Firehose either tries to send the data again or considers it an error, - // based on your retry settings. + // The amount of time that Kinesis Data Firehose waits to receive an + // acknowledgment from Splunk after it sends it data. At the end of the timeout + // period, Kinesis Data Firehose either tries to send the data again or considers + // it an error, based on your retry settings. HECAcknowledgmentTimeoutInSeconds *int32 // The data processing configuration. @@ -2138,12 +2125,12 @@ type SplunkDestinationConfiguration struct { RetryOptions *SplunkRetryOptions // Defines how documents should be delivered to Amazon S3. When set to - // FailedEventsOnly, Kinesis Data Firehose writes any data that could not be - // indexed to the configured Amazon S3 destination. When set to AllEvents, Kinesis + // FailedEventsOnly , Kinesis Data Firehose writes any data that could not be + // indexed to the configured Amazon S3 destination. When set to AllEvents , Kinesis // Data Firehose delivers all incoming records to Amazon S3, and also writes failed - // documents to Amazon S3. The default value is FailedEventsOnly. You can update - // this backup mode from FailedEventsOnly to AllEvents. You can't update it from - // AllEvents to FailedEventsOnly. + // documents to Amazon S3. The default value is FailedEventsOnly . You can update + // this backup mode from FailedEventsOnly to AllEvents . You can't update it from + // AllEvents to FailedEventsOnly . S3BackupMode SplunkS3BackupMode noSmithyDocumentSerde @@ -2155,10 +2142,10 @@ type SplunkDestinationDescription struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends it data. At the end of the timeout period, Kinesis - // Data Firehose either tries to send the data again or considers it an error, - // based on your retry settings. + // The amount of time that Kinesis Data Firehose waits to receive an + // acknowledgment from Splunk after it sends it data. At the end of the timeout + // period, Kinesis Data Firehose either tries to send the data again or considers + // it an error, based on your retry settings. HECAcknowledgmentTimeoutInSeconds *int32 // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends @@ -2179,10 +2166,10 @@ type SplunkDestinationDescription struct { RetryOptions *SplunkRetryOptions // Defines how documents should be delivered to Amazon S3. When set to - // FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be - // indexed to the configured Amazon S3 destination. When set to AllDocuments, + // FailedDocumentsOnly , Kinesis Data Firehose writes any data that could not be + // indexed to the configured Amazon S3 destination. When set to AllDocuments , // Kinesis Data Firehose delivers all incoming records to Amazon S3, and also - // writes failed documents to Amazon S3. Default value is FailedDocumentsOnly. + // writes failed documents to Amazon S3. Default value is FailedDocumentsOnly . S3BackupMode SplunkS3BackupMode // The Amazon S3 destination.> @@ -2197,10 +2184,10 @@ type SplunkDestinationUpdate struct { // The Amazon CloudWatch logging options for your delivery stream. CloudWatchLoggingOptions *CloudWatchLoggingOptions - // The amount of time that Kinesis Data Firehose waits to receive an acknowledgment - // from Splunk after it sends data. At the end of the timeout period, Kinesis Data - // Firehose either tries to send the data again or considers it an error, based on - // your retry settings. + // The amount of time that Kinesis Data Firehose waits to receive an + // acknowledgment from Splunk after it sends data. At the end of the timeout + // period, Kinesis Data Firehose either tries to send the data again or considers + // it an error, based on your retry settings. HECAcknowledgmentTimeoutInSeconds *int32 // The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends @@ -2222,12 +2209,12 @@ type SplunkDestinationUpdate struct { RetryOptions *SplunkRetryOptions // Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. - // When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that + // When set to FailedDocumentsOnly , Kinesis Data Firehose writes any data that // could not be indexed to the configured Amazon S3 destination. When set to - // AllEvents, Kinesis Data Firehose delivers all incoming records to Amazon S3, and - // also writes failed documents to Amazon S3. The default value is - // FailedEventsOnly. You can update this backup mode from FailedEventsOnly to - // AllEvents. You can't update it from AllEvents to FailedEventsOnly. + // AllEvents , Kinesis Data Firehose delivers all incoming records to Amazon S3, + // and also writes failed documents to Amazon S3. The default value is + // FailedEventsOnly . You can update this backup mode from FailedEventsOnly to + // AllEvents . You can't update it from AllEvents to FailedEventsOnly . S3BackupMode SplunkS3BackupMode // Your update to the configuration of the backup Amazon S3 location. @@ -2275,29 +2262,16 @@ type VpcConfiguration struct { // Firehose delivery role or you can specify a new role. In either case, make sure // that the role trusts the Kinesis Data Firehose service principal and that it // grants the following permissions: - // - // * ec2:DescribeVpcs - // - // * - // ec2:DescribeVpcAttribute - // - // * ec2:DescribeSubnets - // - // * ec2:DescribeSecurityGroups - // - // * - // ec2:DescribeNetworkInterfaces - // - // * ec2:CreateNetworkInterface - // - // * - // ec2:CreateNetworkInterfacePermission - // - // * ec2:DeleteNetworkInterface - // - // If you - // revoke these permissions after you create the delivery stream, Kinesis Data - // Firehose can't scale out by creating more ENIs when necessary. You might + // - ec2:DescribeVpcs + // - ec2:DescribeVpcAttribute + // - ec2:DescribeSubnets + // - ec2:DescribeSecurityGroups + // - ec2:DescribeNetworkInterfaces + // - ec2:CreateNetworkInterface + // - ec2:CreateNetworkInterfacePermission + // - ec2:DeleteNetworkInterface + // If you revoke these permissions after you create the delivery stream, Kinesis + // Data Firehose can't scale out by creating more ENIs when necessary. You might // therefore see a degradation in performance. // // This member is required. @@ -2311,17 +2285,16 @@ type VpcConfiguration struct { // security group allows HTTPS traffic from the security groups specified here. If // you use the same security group for both your delivery stream and the Amazon ES // domain, make sure the security group inbound rule allows HTTPS traffic. For more - // information about security group rules, see Security group rules - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) + // information about security group rules, see Security group rules (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) // in the Amazon VPC documentation. // // This member is required. SecurityGroupIds []string - // The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs - // in the VPC of the Amazon ES destination. Make sure that the routing tables and - // inbound and outbound rules allow traffic to flow from the subnets whose IDs are - // specified here to the subnets that have the destination Amazon ES endpoints. + // The IDs of the subnets that you want Kinesis Data Firehose to use to create + // ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + // and inbound and outbound rules allow traffic to flow from the subnets whose IDs + // are specified here to the subnets that have the destination Amazon ES endpoints. // Kinesis Data Firehose creates at least one ENI in each of the subnets that are // specified here. Do not delete or modify these ENIs. The number of ENIs that // Kinesis Data Firehose creates in the subnets specified here scales up and down @@ -2329,8 +2302,7 @@ type VpcConfiguration struct { // the number of ENIs to match throughput, ensure that you have sufficient quota. // To help you calculate the quota you need, assume that Kinesis Data Firehose can // create up to three ENIs for this delivery stream for each of the subnets - // specified here. For more information about ENI quota, see Network Interfaces - // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) + // specified here. For more information about ENI quota, see Network Interfaces (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) // in the Amazon VPC Quotas topic. // // This member is required. @@ -2342,34 +2314,21 @@ type VpcConfiguration struct { // The details of the VPC of the Amazon ES destination. type VpcConfigurationDescription struct { - // The ARN of the IAM role that the delivery stream uses to create endpoints in the - // destination VPC. You can use your existing Kinesis Data Firehose delivery role - // or you can specify a new role. In either case, make sure that the role trusts - // the Kinesis Data Firehose service principal and that it grants the following - // permissions: - // - // * ec2:DescribeVpcs - // - // * ec2:DescribeVpcAttribute - // - // * - // ec2:DescribeSubnets - // - // * ec2:DescribeSecurityGroups - // - // * - // ec2:DescribeNetworkInterfaces - // - // * ec2:CreateNetworkInterface - // - // * - // ec2:CreateNetworkInterfacePermission - // - // * ec2:DeleteNetworkInterface - // - // If you - // revoke these permissions after you create the delivery stream, Kinesis Data - // Firehose can't scale out by creating more ENIs when necessary. You might + // The ARN of the IAM role that the delivery stream uses to create endpoints in + // the destination VPC. You can use your existing Kinesis Data Firehose delivery + // role or you can specify a new role. In either case, make sure that the role + // trusts the Kinesis Data Firehose service principal and that it grants the + // following permissions: + // - ec2:DescribeVpcs + // - ec2:DescribeVpcAttribute + // - ec2:DescribeSubnets + // - ec2:DescribeSecurityGroups + // - ec2:DescribeNetworkInterfaces + // - ec2:CreateNetworkInterface + // - ec2:CreateNetworkInterfacePermission + // - ec2:DeleteNetworkInterface + // If you revoke these permissions after you create the delivery stream, Kinesis + // Data Firehose can't scale out by creating more ENIs when necessary. You might // therefore see a degradation in performance. // // This member is required. @@ -2383,26 +2342,24 @@ type VpcConfigurationDescription struct { // allows HTTPS traffic from the security groups specified here. If you use the // same security group for both your delivery stream and the Amazon ES domain, make // sure the security group inbound rule allows HTTPS traffic. For more information - // about security group rules, see Security group rules - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) + // about security group rules, see Security group rules (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules) // in the Amazon VPC documentation. // // This member is required. SecurityGroupIds []string - // The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC - // of the Amazon ES destination. Make sure that the routing tables and inbound and - // outbound rules allow traffic to flow from the subnets whose IDs are specified - // here to the subnets that have the destination Amazon ES endpoints. Kinesis Data - // Firehose creates at least one ENI in each of the subnets that are specified - // here. Do not delete or modify these ENIs. The number of ENIs that Kinesis Data - // Firehose creates in the subnets specified here scales up and down automatically - // based on throughput. To enable Kinesis Data Firehose to scale up the number of - // ENIs to match throughput, ensure that you have sufficient quota. To help you - // calculate the quota you need, assume that Kinesis Data Firehose can create up to - // three ENIs for this delivery stream for each of the subnets specified here. For - // more information about ENI quota, see Network Interfaces - // (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) + // The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + // VPC of the Amazon ES destination. Make sure that the routing tables and inbound + // and outbound rules allow traffic to flow from the subnets whose IDs are + // specified here to the subnets that have the destination Amazon ES endpoints. + // Kinesis Data Firehose creates at least one ENI in each of the subnets that are + // specified here. Do not delete or modify these ENIs. The number of ENIs that + // Kinesis Data Firehose creates in the subnets specified here scales up and down + // automatically based on throughput. To enable Kinesis Data Firehose to scale up + // the number of ENIs to match throughput, ensure that you have sufficient quota. + // To help you calculate the quota you need, assume that Kinesis Data Firehose can + // create up to three ENIs for this delivery stream for each of the subnets + // specified here. For more information about ENI quota, see Network Interfaces (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis) // in the Amazon VPC Quotas topic. // // This member is required. diff --git a/service/fis/api_client.go b/service/fis/api_client.go index 75d5759247f..bdb091541d1 100644 --- a/service/fis/api_client.go +++ b/service/fis/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/fis/api_op_CreateExperimentTemplate.go b/service/fis/api_op_CreateExperimentTemplate.go index 26f0ab50c24..db609d08bdf 100644 --- a/service/fis/api_op_CreateExperimentTemplate.go +++ b/service/fis/api_op_CreateExperimentTemplate.go @@ -14,23 +14,18 @@ import ( // Creates an experiment template. An experiment template includes the following // components: +// - Targets: A target can be a specific resource in your Amazon Web Services +// environment, or one or more resources that match criteria that you specify, for +// example, resources that have specific tags. +// - Actions: The actions to carry out on the target. You can specify multiple +// actions, the duration of each action, and when to start each action during an +// experiment. +// - Stop conditions: If a stop condition is triggered while an experiment is +// running, the experiment is automatically stopped. You can define a stop +// condition as a CloudWatch alarm. // -// * Targets: A target can be a specific resource in your Amazon Web -// Services environment, or one or more resources that match criteria that you -// specify, for example, resources that have specific tags. -// -// * Actions: The actions -// to carry out on the target. You can specify multiple actions, the duration of -// each action, and when to start each action during an experiment. -// -// * Stop -// conditions: If a stop condition is triggered while an experiment is running, the -// experiment is automatically stopped. You can define a stop condition as a -// CloudWatch alarm. -// -// For more information, see Experiment templates -// (https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) in -// the Fault Injection Simulator User Guide. +// For more information, see Experiment templates (https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) +// in the Fault Injection Simulator User Guide. func (c *Client) CreateExperimentTemplate(ctx context.Context, params *CreateExperimentTemplateInput, optFns ...func(*Options)) (*CreateExperimentTemplateOutput, error) { if params == nil { params = &CreateExperimentTemplateInput{} diff --git a/service/fis/doc.go b/service/fis/doc.go index 54001681508..b1cc67b0e7e 100644 --- a/service/fis/doc.go +++ b/service/fis/doc.go @@ -3,8 +3,8 @@ // Package fis provides the API client, operations, and parameter types for AWS // Fault Injection Simulator. // -// Fault Injection Simulator is a managed service that enables you to perform fault -// injection experiments on your Amazon Web Services workloads. For more -// information, see the Fault Injection Simulator User Guide -// (https://docs.aws.amazon.com/fis/latest/userguide/). +// Fault Injection Simulator is a managed service that enables you to perform +// fault injection experiments on your Amazon Web Services workloads. For more +// information, see the Fault Injection Simulator User Guide (https://docs.aws.amazon.com/fis/latest/userguide/) +// . package fis diff --git a/service/fis/types/types.go b/service/fis/types/types.go index 4d22c155e9e..20d1476518b 100644 --- a/service/fis/types/types.go +++ b/service/fis/types/types.go @@ -7,9 +7,8 @@ import ( "time" ) -// Describes an action. For more information, see FIS actions -// (https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html) in -// the Fault Injection Simulator User Guide. +// Describes an action. For more information, see FIS actions (https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html) +// in the Fault Injection Simulator User Guide. type Action struct { // The description for the action. @@ -132,9 +131,8 @@ type CreateExperimentTemplateStopConditionInput struct { // Specifies a target for an experiment. You must specify at least one Amazon // Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs -// and tags. For more information, see Targets -// (https://docs.aws.amazon.com/fis/latest/userguide/targets.html) in the Fault -// Injection Simulator User Guide. +// and tags. For more information, see Targets (https://docs.aws.amazon.com/fis/latest/userguide/targets.html) +// in the Fault Injection Simulator User Guide. type CreateExperimentTemplateTargetInput struct { // The resource type. The resource type must be supported for the specified action. @@ -145,17 +143,13 @@ type CreateExperimentTemplateTargetInput struct { // Scopes the identified resources to a specific count of the resources at random, // or a percentage of the resources. All identified resources are included in the // target. - // - // * ALL - Run the action on all identified targets. This is the - // default. - // - // * COUNT(n) - Run the action on the specified number of targets, chosen - // from the identified targets at random. For example, COUNT(1) selects one of the - // targets. - // - // * PERCENT(n) - Run the action on the specified percentage of targets, - // chosen from the identified targets at random. For example, PERCENT(25) selects - // 25% of the targets. + // - ALL - Run the action on all identified targets. This is the default. + // - COUNT(n) - Run the action on the specified number of targets, chosen from + // the identified targets at random. For example, COUNT(1) selects one of the + // targets. + // - PERCENT(n) - Run the action on the specified percentage of targets, chosen + // from the identified targets at random. For example, PERCENT(25) selects 25% of + // the targets. // // This member is required. SelectionMode *string @@ -567,9 +561,8 @@ type ExperimentTemplateTargetFilter struct { noSmithyDocumentSerde } -// Specifies a filter used for the target resource input in an experiment template. -// For more information, see Resource filters -// (https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) +// Specifies a filter used for the target resource input in an experiment +// template. For more information, see Resource filters (https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) // in the Fault Injection Simulator User Guide. type ExperimentTemplateTargetInputFilter struct { @@ -663,8 +656,8 @@ type UpdateExperimentTemplateLogConfigurationInput struct { noSmithyDocumentSerde } -// Specifies a stop condition for an experiment. You can define a stop condition as -// a CloudWatch alarm. +// Specifies a stop condition for an experiment. You can define a stop condition +// as a CloudWatch alarm. type UpdateExperimentTemplateStopConditionInput struct { // The source for the stop condition. Specify aws:cloudwatch:alarm if the stop diff --git a/service/fms/api_client.go b/service/fms/api_client.go index 4db3f61e2b8..db48bc1f28e 100644 --- a/service/fms/api_client.go +++ b/service/fms/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/fms/api_op_AssociateAdminAccount.go b/service/fms/api_op_AssociateAdminAccount.go index 2eb41d18828..d99d2b70d38 100644 --- a/service/fms/api_op_AssociateAdminAccount.go +++ b/service/fms/api_op_AssociateAdminAccount.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the Firewall Manager administrator account. The account must be a member of -// the organization in Organizations whose resources you want to protect. Firewall -// Manager sets the permissions that allow the account to administer your Firewall -// Manager policies. The account that you associate with Firewall Manager is called -// the Firewall Manager administrator account. +// Sets the Firewall Manager administrator account. The account must be a member +// of the organization in Organizations whose resources you want to protect. +// Firewall Manager sets the permissions that allow the account to administer your +// Firewall Manager policies. The account that you associate with Firewall Manager +// is called the Firewall Manager administrator account. func (c *Client) AssociateAdminAccount(ctx context.Context, params *AssociateAdminAccountInput, optFns ...func(*Options)) (*AssociateAdminAccountOutput, error) { if params == nil { params = &AssociateAdminAccountInput{} @@ -35,8 +35,8 @@ type AssociateAdminAccountInput struct { // The Amazon Web Services account ID to associate with Firewall Manager as the // Firewall Manager administrator account. This must be an Organizations member // account. For more information about Organizations, see Managing the Amazon Web - // Services Accounts in Your Organization - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html). + // Services Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html) + // . // // This member is required. AdminAccount *string diff --git a/service/fms/api_op_AssociateThirdPartyFirewall.go b/service/fms/api_op_AssociateThirdPartyFirewall.go index d7f135abc76..1c1d9682352 100644 --- a/service/fms/api_op_AssociateThirdPartyFirewall.go +++ b/service/fms/api_op_AssociateThirdPartyFirewall.go @@ -42,25 +42,18 @@ type AssociateThirdPartyFirewallInput struct { type AssociateThirdPartyFirewallOutput struct { - // The current status for setting a Firewall Manager policy administrator's account - // as an administrator of the third-party firewall tenant. - // - // * ONBOARDING - The - // Firewall Manager policy administrator is being designated as a tenant - // administrator. - // - // * ONBOARD_COMPLETE - The Firewall Manager policy administrator - // is designated as a tenant administrator. - // - // * OFFBOARDING - The Firewall Manager - // policy administrator is being removed as a tenant administrator. - // - // * - // OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed - // as a tenant administrator. - // - // * NOT_EXIST - The Firewall Manager policy - // administrator doesn't exist as a tenant administrator. + // The current status for setting a Firewall Manager policy administrator's + // account as an administrator of the third-party firewall tenant. + // - ONBOARDING - The Firewall Manager policy administrator is being designated + // as a tenant administrator. + // - ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated + // as a tenant administrator. + // - OFFBOARDING - The Firewall Manager policy administrator is being removed as + // a tenant administrator. + // - OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been + // removed as a tenant administrator. + // - NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a + // tenant administrator. ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus // Metadata pertaining to the operation's result. diff --git a/service/fms/api_op_BatchDisassociateResource.go b/service/fms/api_op_BatchDisassociateResource.go index 7d9f06662e9..7d834753b3b 100644 --- a/service/fms/api_op_BatchDisassociateResource.go +++ b/service/fms/api_op_BatchDisassociateResource.go @@ -29,8 +29,9 @@ func (c *Client) BatchDisassociateResource(ctx context.Context, params *BatchDis type BatchDisassociateResourceInput struct { - // The uniform resource identifiers (URI) of resources that should be disassociated - // from the resource set. The URIs must be Amazon Resource Names (ARNs). + // The uniform resource identifiers (URI) of resources that should be + // disassociated from the resource set. The URIs must be Amazon Resource Names + // (ARNs). // // This member is required. Items []string diff --git a/service/fms/api_op_DeleteAppsList.go b/service/fms/api_op_DeleteAppsList.go index 0bb2ee5d3d5..522e39b6a08 100644 --- a/service/fms/api_op_DeleteAppsList.go +++ b/service/fms/api_op_DeleteAppsList.go @@ -29,7 +29,7 @@ func (c *Client) DeleteAppsList(ctx context.Context, params *DeleteAppsListInput type DeleteAppsListInput struct { // The ID of the applications list that you want to delete. You can retrieve this - // ID from PutAppsList, ListAppsLists, and GetAppsList. + // ID from PutAppsList , ListAppsLists , and GetAppsList . // // This member is required. ListId *string diff --git a/service/fms/api_op_DeletePolicy.go b/service/fms/api_op_DeletePolicy.go index 85aedb313ce..f320731d26f 100644 --- a/service/fms/api_op_DeletePolicy.go +++ b/service/fms/api_op_DeletePolicy.go @@ -29,40 +29,28 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { // The ID of the policy that you want to delete. You can retrieve this ID from - // PutPolicy and ListPolicies. + // PutPolicy and ListPolicies . // // This member is required. PolicyId *string - // If True, the request performs cleanup according to the policy type. For WAF and + // If True , the request performs cleanup according to the policy type. For WAF and // Shield Advanced policies, the cleanup does the following: - // - // * Deletes rule groups - // created by Firewall Manager - // - // * Removes web ACLs from in-scope resources - // - // * - // Deletes web ACLs that contain no rules or rule groups - // - // For security group - // policies, the cleanup does the following for each security group in the - // policy: - // - // * Disassociates the security group from in-scope resources - // - // * Deletes - // the security group if it was created through Firewall Manager and if it's no - // longer associated with any resources through another policy - // - // After the cleanup, - // in-scope resources are no longer protected by web ACLs in this policy. - // Protection of out-of-scope resources remains unchanged. Scope is determined by - // tags that you create and accounts that you associate with the policy. When - // creating the policy, if you specify that only resources in specific accounts or - // with specific tags are in scope of the policy, those accounts and resources are - // handled by the policy. All others are out of scope. If you don't specify tags or - // accounts, all resources are in scope. + // - Deletes rule groups created by Firewall Manager + // - Removes web ACLs from in-scope resources + // - Deletes web ACLs that contain no rules or rule groups + // For security group policies, the cleanup does the following for each security + // group in the policy: + // - Disassociates the security group from in-scope resources + // - Deletes the security group if it was created through Firewall Manager and + // if it's no longer associated with any resources through another policy + // After the cleanup, in-scope resources are no longer protected by web ACLs in + // this policy. Protection of out-of-scope resources remains unchanged. Scope is + // determined by tags that you create and accounts that you associate with the + // policy. When creating the policy, if you specify that only resources in specific + // accounts or with specific tags are in scope of the policy, those accounts and + // resources are handled by the policy. All others are out of scope. If you don't + // specify tags or accounts, all resources are in scope. DeleteAllPolicyResources bool noSmithyDocumentSerde diff --git a/service/fms/api_op_DeleteProtocolsList.go b/service/fms/api_op_DeleteProtocolsList.go index f299f8cd2c1..ca45258c65c 100644 --- a/service/fms/api_op_DeleteProtocolsList.go +++ b/service/fms/api_op_DeleteProtocolsList.go @@ -29,7 +29,7 @@ func (c *Client) DeleteProtocolsList(ctx context.Context, params *DeleteProtocol type DeleteProtocolsListInput struct { // The ID of the protocols list that you want to delete. You can retrieve this ID - // from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost. + // from PutProtocolsList , ListProtocolsLists , and GetProtocolsLost . // // This member is required. ListId *string diff --git a/service/fms/api_op_DeleteResourceSet.go b/service/fms/api_op_DeleteResourceSet.go index e6e033719b2..de285be2426 100644 --- a/service/fms/api_op_DeleteResourceSet.go +++ b/service/fms/api_op_DeleteResourceSet.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified ResourceSet. +// Deletes the specified ResourceSet . func (c *Client) DeleteResourceSet(ctx context.Context, params *DeleteResourceSetInput, optFns ...func(*Options)) (*DeleteResourceSetOutput, error) { if params == nil { params = &DeleteResourceSetInput{} diff --git a/service/fms/api_op_DisassociateThirdPartyFirewall.go b/service/fms/api_op_DisassociateThirdPartyFirewall.go index e2b079788b9..983f96f16b3 100644 --- a/service/fms/api_op_DisassociateThirdPartyFirewall.go +++ b/service/fms/api_op_DisassociateThirdPartyFirewall.go @@ -12,7 +12,7 @@ import ( ) // Disassociates a Firewall Manager policy administrator from a third-party -// firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party +// firewall tenant. When you call DisassociateThirdPartyFirewall , the third-party // firewall vendor deletes all of the firewalls that are associated with the // account. func (c *Client) DisassociateThirdPartyFirewall(ctx context.Context, params *DisassociateThirdPartyFirewallInput, optFns ...func(*Options)) (*DisassociateThirdPartyFirewallOutput, error) { diff --git a/service/fms/api_op_GetComplianceDetail.go b/service/fms/api_op_GetComplianceDetail.go index de0be136fda..f1c4bdab26d 100644 --- a/service/fms/api_op_GetComplianceDetail.go +++ b/service/fms/api_op_GetComplianceDetail.go @@ -14,24 +14,18 @@ import ( // Returns detailed compliance information about the specified member account. // Details include resources that are in and out of compliance with the specified // policy. -// -// * Resources are considered noncompliant for WAF and Shield Advanced -// policies if the specified policy has not been applied to them. -// -// * Resources are -// considered noncompliant for security group policies if they are in scope of the -// policy, they violate one or more of the policy rules, and remediation is -// disabled or not possible. -// -// * Resources are considered noncompliant for Network -// Firewall policies if a firewall is missing in the VPC, if the firewall endpoint -// isn't set up in an expected Availability Zone and subnet, if a subnet created by -// the Firewall Manager doesn't have the expected route table, and for -// modifications to a firewall policy that violate the Firewall Manager policy's -// rules. -// -// * Resources are considered noncompliant for DNS Firewall policies if a -// DNS Firewall rule group is missing from the rule group associations for the VPC. +// - Resources are considered noncompliant for WAF and Shield Advanced policies +// if the specified policy has not been applied to them. +// - Resources are considered noncompliant for security group policies if they +// are in scope of the policy, they violate one or more of the policy rules, and +// remediation is disabled or not possible. +// - Resources are considered noncompliant for Network Firewall policies if a +// firewall is missing in the VPC, if the firewall endpoint isn't set up in an +// expected Availability Zone and subnet, if a subnet created by the Firewall +// Manager doesn't have the expected route table, and for modifications to a +// firewall policy that violate the Firewall Manager policy's rules. +// - Resources are considered noncompliant for DNS Firewall policies if a DNS +// Firewall rule group is missing from the rule group associations for the VPC. func (c *Client) GetComplianceDetail(ctx context.Context, params *GetComplianceDetailInput, optFns ...func(*Options)) (*GetComplianceDetailOutput, error) { if params == nil { params = &GetComplianceDetailInput{} @@ -49,14 +43,14 @@ func (c *Client) GetComplianceDetail(ctx context.Context, params *GetComplianceD type GetComplianceDetailInput struct { - // The Amazon Web Services account that owns the resources that you want to get the - // details for. + // The Amazon Web Services account that owns the resources that you want to get + // the details for. // // This member is required. MemberAccount *string // The ID of the policy that you want to get the details for. PolicyId is returned - // by PutPolicy and by ListPolicies. + // by PutPolicy and by ListPolicies . // // This member is required. PolicyId *string diff --git a/service/fms/api_op_GetProtectionStatus.go b/service/fms/api_op_GetProtectionStatus.go index 6b142239f4f..a04e4c019f8 100644 --- a/service/fms/api_op_GetProtectionStatus.go +++ b/service/fms/api_op_GetProtectionStatus.go @@ -39,13 +39,13 @@ type GetProtectionStatusInput struct { // The end of the time period to query for the attacks. This is a timestamp type. // The request syntax listing indicates a number type because the default used by - // Firewall Manager is Unix time in seconds. However, any valid timestamp format is - // allowed. + // Firewall Manager is Unix time in seconds. However, any valid timestamp format + // is allowed. EndTime *time.Time // Specifies the number of objects that you want Firewall Manager to return for // this request. If you have more objects than the number that you specify for - // MaxResults, the response includes a NextToken value that you can use to get + // MaxResults , the response includes a NextToken value that you can use to get // another batch of objects. MaxResults *int32 @@ -54,17 +54,17 @@ type GetProtectionStatusInput struct { MemberAccountId *string // If you specify a value for MaxResults and you have more objects than the number - // that you specify for MaxResults, Firewall Manager returns a NextToken value in + // that you specify for MaxResults , Firewall Manager returns a NextToken value in // the response, which you can use to retrieve another group of objects. For the // second and subsequent GetProtectionStatus requests, specify the value of // NextToken from the previous response to get information about another batch of // objects. NextToken *string - // The start of the time period to query for the attacks. This is a timestamp type. - // The request syntax listing indicates a number type because the default used by - // Firewall Manager is Unix time in seconds. However, any valid timestamp format is - // allowed. + // The start of the time period to query for the attacks. This is a timestamp + // type. The request syntax listing indicates a number type because the default + // used by Firewall Manager is Unix time in seconds. However, any valid timestamp + // format is allowed. StartTime *time.Time noSmithyDocumentSerde @@ -76,35 +76,26 @@ type GetProtectionStatusOutput struct { AdminAccountId *string // Details about the attack, including the following: - // - // * Attack type - // - // * Account - // ID - // - // * ARN of the resource attacked - // - // * Start time of the attack - // - // * End time of - // the attack (ongoing attacks will not have an end time) - // - // The details are in JSON - // format. + // - Attack type + // - Account ID + // - ARN of the resource attacked + // - Start time of the attack + // - End time of the attack (ongoing attacks will not have an end time) + // The details are in JSON format. Data *string // If you have more objects than the number that you specified for MaxResults in // the request, the response includes a NextToken value. To list more objects, - // submit another GetProtectionStatus request, and specify the NextToken value from - // the response in the NextToken value in the next request. Amazon Web Services - // SDKs provide auto-pagination that identify NextToken in a response and make - // subsequent request calls automatically on your behalf. However, this feature is - // not supported by GetProtectionStatus. You must submit subsequent requests with - // NextToken using your own processes. + // submit another GetProtectionStatus request, and specify the NextToken value + // from the response in the NextToken value in the next request. Amazon Web + // Services SDKs provide auto-pagination that identify NextToken in a response and + // make subsequent request calls automatically on your behalf. However, this + // feature is not supported by GetProtectionStatus . You must submit subsequent + // requests with NextToken using your own processes. NextToken *string // The service type that is protected by the policy. Currently, this is always - // SHIELD_ADVANCED. + // SHIELD_ADVANCED . ServiceType types.SecurityServiceType // Metadata pertaining to the operation's result. diff --git a/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go b/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go index bb0fa2d1dc0..da4e93eb3d5 100644 --- a/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go +++ b/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go @@ -42,40 +42,28 @@ type GetThirdPartyFirewallAssociationStatusOutput struct { // The status for subscribing to the third-party firewall vendor in the Amazon Web // Services Marketplace. - // - // * NO_SUBSCRIPTION - The Firewall Manager policy - // administrator isn't subscribed to the third-party firewall service in the Amazon - // Web Services Marketplace. - // - // * NOT_COMPLETE - The Firewall Manager policy - // administrator is in the process of subscribing to the third-party firewall - // service in the Amazon Web Services Marketplace, but doesn't yet have an active - // subscription. - // - // * COMPLETE - The Firewall Manager policy administrator has an - // active subscription to the third-party firewall service in the Amazon Web - // Services Marketplace. + // - NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed + // to the third-party firewall service in the Amazon Web Services Marketplace. + // - NOT_COMPLETE - The Firewall Manager policy administrator is in the process + // of subscribing to the third-party firewall service in the Amazon Web Services + // Marketplace, but doesn't yet have an active subscription. + // - COMPLETE - The Firewall Manager policy administrator has an active + // subscription to the third-party firewall service in the Amazon Web Services + // Marketplace. MarketplaceOnboardingStatus types.MarketplaceSubscriptionOnboardingStatus // The current status for setting a Firewall Manager policy administrators account // as an administrator of the third-party firewall tenant. - // - // * ONBOARDING - The - // Firewall Manager policy administrator is being designated as a tenant - // administrator. - // - // * ONBOARD_COMPLETE - The Firewall Manager policy administrator - // is designated as a tenant administrator. - // - // * OFFBOARDING - The Firewall Manager - // policy administrator is being removed as a tenant administrator. - // - // * - // OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed - // as a tenant administrator. - // - // * NOT_EXIST - The Firewall Manager policy - // administrator doesn't exist as a tenant administrator. + // - ONBOARDING - The Firewall Manager policy administrator is being designated + // as a tenant administrator. + // - ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated + // as a tenant administrator. + // - OFFBOARDING - The Firewall Manager policy administrator is being removed as + // a tenant administrator. + // - OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been + // removed as a tenant administrator. + // - NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a + // tenant administrator. ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus // Metadata pertaining to the operation's result. diff --git a/service/fms/api_op_GetViolationDetails.go b/service/fms/api_op_GetViolationDetails.go index 627ac93c444..b7e95ee0bb8 100644 --- a/service/fms/api_op_GetViolationDetails.go +++ b/service/fms/api_op_GetViolationDetails.go @@ -47,11 +47,10 @@ type GetViolationDetailsInput struct { ResourceId *string // The resource type. This is in the format shown in the Amazon Web Services - // Resource Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). - // Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, - // AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and - // AWS::EC2::Subnet. + // Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // . Supported resource types are: AWS::EC2::Instance , AWS::EC2::NetworkInterface + // , AWS::EC2::SecurityGroup , AWS::NetworkFirewall::FirewallPolicy , and + // AWS::EC2::Subnet . // // This member is required. ResourceType *string diff --git a/service/fms/api_op_ListAppsLists.go b/service/fms/api_op_ListAppsLists.go index 0ebd5bf2cbc..31e0c5a5b91 100644 --- a/service/fms/api_op_ListAppsLists.go +++ b/service/fms/api_op_ListAppsLists.go @@ -32,8 +32,8 @@ type ListAppsListsInput struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. If you don't specify this, Firewall Manager returns all + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. If you don't specify this, Firewall Manager returns all // available objects. // // This member is required. @@ -143,8 +143,8 @@ var _ ListAppsListsAPIClient = (*Client)(nil) type ListAppsListsPaginatorOptions struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. If you don't specify this, Firewall Manager returns all + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. If you don't specify this, Firewall Manager returns all // available objects. Limit int32 diff --git a/service/fms/api_op_ListComplianceStatus.go b/service/fms/api_op_ListComplianceStatus.go index bd9a43c6370..27da93fa493 100644 --- a/service/fms/api_op_ListComplianceStatus.go +++ b/service/fms/api_op_ListComplianceStatus.go @@ -38,13 +38,13 @@ type ListComplianceStatusInput struct { // Specifies the number of PolicyComplianceStatus objects that you want Firewall // Manager to return for this request. If you have more PolicyComplianceStatus - // objects than the number that you specify for MaxResults, the response includes a - // NextToken value that you can use to get another batch of PolicyComplianceStatus - // objects. + // objects than the number that you specify for MaxResults , the response includes + // a NextToken value that you can use to get another batch of + // PolicyComplianceStatus objects. MaxResults *int32 // If you specify a value for MaxResults and you have more PolicyComplianceStatus - // objects than the number that you specify for MaxResults, Firewall Manager + // objects than the number that you specify for MaxResults , Firewall Manager // returns a NextToken value in the response that allows you to list another group // of PolicyComplianceStatus objects. For the second and subsequent // ListComplianceStatus requests, specify the value of NextToken from the previous @@ -149,9 +149,9 @@ var _ ListComplianceStatusAPIClient = (*Client)(nil) type ListComplianceStatusPaginatorOptions struct { // Specifies the number of PolicyComplianceStatus objects that you want Firewall // Manager to return for this request. If you have more PolicyComplianceStatus - // objects than the number that you specify for MaxResults, the response includes a - // NextToken value that you can use to get another batch of PolicyComplianceStatus - // objects. + // objects than the number that you specify for MaxResults , the response includes + // a NextToken value that you can use to get another batch of + // PolicyComplianceStatus objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fms/api_op_ListDiscoveredResources.go b/service/fms/api_op_ListDiscoveredResources.go index 427626bd288..f797e9c4d5a 100644 --- a/service/fms/api_op_ListDiscoveredResources.go +++ b/service/fms/api_op_ListDiscoveredResources.go @@ -43,8 +43,8 @@ type ListDiscoveredResourcesInput struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of diff --git a/service/fms/api_op_ListMemberAccounts.go b/service/fms/api_op_ListMemberAccounts.go index dc5301fc5d7..58b3d93082b 100644 --- a/service/fms/api_op_ListMemberAccounts.go +++ b/service/fms/api_op_ListMemberAccounts.go @@ -12,8 +12,8 @@ import ( ) // Returns a MemberAccounts object that lists the member accounts in the -// administrator's Amazon Web Services organization. The ListMemberAccounts must be -// submitted by the account that is set as the Firewall Manager administrator. +// administrator's Amazon Web Services organization. The ListMemberAccounts must +// be submitted by the account that is set as the Firewall Manager administrator. func (c *Client) ListMemberAccounts(ctx context.Context, params *ListMemberAccountsInput, optFns ...func(*Options)) (*ListMemberAccountsOutput, error) { if params == nil { params = &ListMemberAccountsInput{} @@ -33,12 +33,12 @@ type ListMemberAccountsInput struct { // Specifies the number of member account IDs that you want Firewall Manager to // return for this request. If you have more IDs than the number that you specify - // for MaxResults, the response includes a NextToken value that you can use to get - // another batch of member account IDs. + // for MaxResults , the response includes a NextToken value that you can use to + // get another batch of member account IDs. MaxResults *int32 // If you specify a value for MaxResults and you have more account IDs than the - // number that you specify for MaxResults, Firewall Manager returns a NextToken + // number that you specify for MaxResults , Firewall Manager returns a NextToken // value in the response that allows you to list another group of IDs. For the // second and subsequent ListMemberAccountsRequest requests, specify the value of // NextToken from the previous response to get information about another batch of @@ -54,9 +54,9 @@ type ListMemberAccountsOutput struct { MemberAccounts []string // If you have more member account IDs than the number that you specified for - // MaxResults in the request, the response includes a NextToken value. To list more - // IDs, submit another ListMemberAccounts request, and specify the NextToken value - // from the response in the NextToken value in the next request. + // MaxResults in the request, the response includes a NextToken value. To list + // more IDs, submit another ListMemberAccounts request, and specify the NextToken + // value from the response in the NextToken value in the next request. NextToken *string // Metadata pertaining to the operation's result. @@ -138,8 +138,8 @@ var _ ListMemberAccountsAPIClient = (*Client)(nil) type ListMemberAccountsPaginatorOptions struct { // Specifies the number of member account IDs that you want Firewall Manager to // return for this request. If you have more IDs than the number that you specify - // for MaxResults, the response includes a NextToken value that you can use to get - // another batch of member account IDs. + // for MaxResults , the response includes a NextToken value that you can use to + // get another batch of member account IDs. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fms/api_op_ListPolicies.go b/service/fms/api_op_ListPolicies.go index 285cd16a505..86a17efa205 100644 --- a/service/fms/api_op_ListPolicies.go +++ b/service/fms/api_op_ListPolicies.go @@ -32,12 +32,12 @@ type ListPoliciesInput struct { // Specifies the number of PolicySummary objects that you want Firewall Manager to // return for this request. If you have more PolicySummary objects than the number - // that you specify for MaxResults, the response includes a NextToken value that + // that you specify for MaxResults , the response includes a NextToken value that // you can use to get another batch of PolicySummary objects. MaxResults *int32 // If you specify a value for MaxResults and you have more PolicySummary objects - // than the number that you specify for MaxResults, Firewall Manager returns a + // than the number that you specify for MaxResults , Firewall Manager returns a // NextToken value in the response that allows you to list another group of // PolicySummary objects. For the second and subsequent ListPolicies requests, // specify the value of NextToken from the previous response to get information @@ -50,9 +50,10 @@ type ListPoliciesInput struct { type ListPoliciesOutput struct { // If you have more PolicySummary objects than the number that you specified for - // MaxResults in the request, the response includes a NextToken value. To list more - // PolicySummary objects, submit another ListPolicies request, and specify the - // NextToken value from the response in the NextToken value in the next request. + // MaxResults in the request, the response includes a NextToken value. To list + // more PolicySummary objects, submit another ListPolicies request, and specify + // the NextToken value from the response in the NextToken value in the next + // request. NextToken *string // An array of PolicySummary objects. @@ -135,7 +136,7 @@ var _ ListPoliciesAPIClient = (*Client)(nil) type ListPoliciesPaginatorOptions struct { // Specifies the number of PolicySummary objects that you want Firewall Manager to // return for this request. If you have more PolicySummary objects than the number - // that you specify for MaxResults, the response includes a NextToken value that + // that you specify for MaxResults , the response includes a NextToken value that // you can use to get another batch of PolicySummary objects. Limit int32 diff --git a/service/fms/api_op_ListProtocolsLists.go b/service/fms/api_op_ListProtocolsLists.go index 26f74ce99cb..34136adf2ec 100644 --- a/service/fms/api_op_ListProtocolsLists.go +++ b/service/fms/api_op_ListProtocolsLists.go @@ -32,8 +32,8 @@ type ListProtocolsListsInput struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. If you don't specify this, Firewall Manager returns all + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. If you don't specify this, Firewall Manager returns all // available objects. // // This member is required. @@ -145,8 +145,8 @@ var _ ListProtocolsListsAPIClient = (*Client)(nil) type ListProtocolsListsPaginatorOptions struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. If you don't specify this, Firewall Manager returns all + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. If you don't specify this, Firewall Manager returns all // available objects. Limit int32 diff --git a/service/fms/api_op_ListResourceSetResources.go b/service/fms/api_op_ListResourceSetResources.go index f4adbc023a1..36f682991ca 100644 --- a/service/fms/api_op_ListResourceSetResources.go +++ b/service/fms/api_op_ListResourceSetResources.go @@ -37,8 +37,8 @@ type ListResourceSetResourcesInput struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of diff --git a/service/fms/api_op_ListResourceSets.go b/service/fms/api_op_ListResourceSets.go index b658ca9cc47..723a91bf757 100644 --- a/service/fms/api_op_ListResourceSets.go +++ b/service/fms/api_op_ListResourceSets.go @@ -31,8 +31,8 @@ type ListResourceSetsInput struct { // The maximum number of objects that you want Firewall Manager to return for this // request. If more objects are available, in the response, Firewall Manager - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of diff --git a/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go b/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go index e8f7e5a9053..4284c909a54 100644 --- a/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go +++ b/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of all of the third-party firewall policies that are associated -// with the third-party firewall administrator's account. +// Retrieves a list of all of the third-party firewall policies that are +// associated with the third-party firewall administrator's account. func (c *Client) ListThirdPartyFirewallFirewallPolicies(ctx context.Context, params *ListThirdPartyFirewallFirewallPoliciesInput, optFns ...func(*Options)) (*ListThirdPartyFirewallFirewallPoliciesOutput, error) { if params == nil { params = &ListThirdPartyFirewallFirewallPoliciesInput{} @@ -46,11 +46,11 @@ type ListThirdPartyFirewallFirewallPoliciesInput struct { // This member is required. ThirdPartyFirewall types.ThirdPartyFirewall - // If the previous response included a NextToken element, the specified third-party - // firewall vendor is associated with more third-party firewall policies. To get - // more third-party firewall policies, submit another + // If the previous response included a NextToken element, the specified + // third-party firewall vendor is associated with more third-party firewall + // policies. To get more third-party firewall policies, submit another // ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of - // NextToken, specify the value of NextToken from the previous response. If the + // NextToken , specify the value of NextToken from the previous response. If the // previous response didn't include a NextToken element, there are no more // third-party firewall policies to get. NextToken *string diff --git a/service/fms/api_op_PutNotificationChannel.go b/service/fms/api_op_PutNotificationChannel.go index 5dd21256250..c202d316cbb 100644 --- a/service/fms/api_op_PutNotificationChannel.go +++ b/service/fms/api_op_PutNotificationChannel.go @@ -14,8 +14,7 @@ import ( // Firewall Manager uses to record SNS logs. To perform this action outside of the // console, you must configure the SNS topic to allow the Firewall Manager role // AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall -// Manager required permissions for API actions -// (https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html) +// Manager required permissions for API actions (https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html) // in the Firewall Manager Developer Guide. func (c *Client) PutNotificationChannel(ctx context.Context, params *PutNotificationChannelInput, optFns ...func(*Options)) (*PutNotificationChannelOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type PutNotificationChannelInput struct { // This member is required. SnsRoleName *string - // The Amazon Resource Name (ARN) of the SNS topic that collects notifications from - // Firewall Manager. + // The Amazon Resource Name (ARN) of the SNS topic that collects notifications + // from Firewall Manager. // // This member is required. SnsTopicArn *string diff --git a/service/fms/api_op_PutPolicy.go b/service/fms/api_op_PutPolicy.go index ff11d481900..72c0e616a4c 100644 --- a/service/fms/api_op_PutPolicy.go +++ b/service/fms/api_op_PutPolicy.go @@ -13,34 +13,24 @@ import ( // Creates an Firewall Manager policy. Firewall Manager provides the following // types of policies: +// - An WAF policy (type WAFV2), which defines rule groups to run first in the +// corresponding WAF web ACL and rule groups to run last in the web ACL. +// - An WAF Classic policy (type WAF), which defines a rule group. +// - A Shield Advanced policy, which applies Shield Advanced protection to +// specified accounts and resources. +// - A security group policy, which manages VPC security groups across your +// Amazon Web Services organization. +// - An Network Firewall policy, which provides firewall rules to filter network +// traffic in specified Amazon VPCs. +// - A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules +// to filter DNS queries for specified VPCs. // -// * An WAF policy (type WAFV2), which defines rule groups to -// run first in the corresponding WAF web ACL and rule groups to run last in the -// web ACL. -// -// * An WAF Classic policy (type WAF), which defines a rule group. -// -// * A -// Shield Advanced policy, which applies Shield Advanced protection to specified -// accounts and resources. -// -// * A security group policy, which manages VPC security -// groups across your Amazon Web Services organization. -// -// * An Network Firewall -// policy, which provides firewall rules to filter network traffic in specified -// Amazon VPCs. -// -// * A DNS Firewall policy, which provides Route 53 Resolver DNS -// Firewall rules to filter DNS queries for specified VPCs. -// -// Each policy is -// specific to one of the types. If you want to enforce more than one policy type -// across accounts, create multiple policies. You can create multiple policies for -// each type. You must be subscribed to Shield Advanced to create a Shield Advanced -// policy. For more information about subscribing to Shield Advanced, see -// CreateSubscription -// (https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html). +// Each policy is specific to one of the types. If you want to enforce more than +// one policy type across accounts, create multiple policies. You can create +// multiple policies for each type. You must be subscribed to Shield Advanced to +// create a Shield Advanced policy. For more information about subscribing to +// Shield Advanced, see CreateSubscription (https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html) +// . func (c *Client) PutPolicy(ctx context.Context, params *PutPolicyInput, optFns ...func(*Options)) (*PutPolicyOutput, error) { if params == nil { params = &PutPolicyInput{} diff --git a/service/fms/api_op_PutResourceSet.go b/service/fms/api_op_PutResourceSet.go index dbd52f80506..c9569985c16 100644 --- a/service/fms/api_op_PutResourceSet.go +++ b/service/fms/api_op_PutResourceSet.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the resource set. An Firewall Manager resource set defines the resources -// to import into an Firewall Manager policy from another Amazon Web Services -// service. +// Creates the resource set. An Firewall Manager resource set defines the +// resources to import into an Firewall Manager policy from another Amazon Web +// Services service. func (c *Client) PutResourceSet(ctx context.Context, params *PutResourceSetInput, optFns ...func(*Options)) (*PutResourceSetOutput, error) { if params == nil { params = &PutResourceSetInput{} diff --git a/service/fms/doc.go b/service/fms/doc.go index 2dfa89f4018..ac1c24d950d 100644 --- a/service/fms/doc.go +++ b/service/fms/doc.go @@ -6,9 +6,8 @@ // This is the Firewall Manager API Reference. This guide is for developers who // need detailed information about the Firewall Manager API actions, data types, // and errors. For detailed information about Firewall Manager features, see the -// Firewall Manager Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html). Some -// API actions require explicit resource permissions. For information, see the -// developer guide topic Firewall Manager required permissions for API actions -// (https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html). +// Firewall Manager Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html) +// . Some API actions require explicit resource permissions. For information, see +// the developer guide topic Firewall Manager required permissions for API actions (https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html) +// . package fms diff --git a/service/fms/types/enums.go b/service/fms/types/enums.go index 698f2b9067d..21cf50de158 100644 --- a/service/fms/types/enums.go +++ b/service/fms/types/enums.go @@ -194,8 +194,8 @@ const ( RemediationActionTypeModify RemediationActionType = "MODIFY" ) -// Values returns all known values for RemediationActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RemediationActionType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RemediationActionType) Values() []RemediationActionType { return []RemediationActionType{ @@ -212,9 +212,9 @@ const ( RuleOrderDefaultActionOrder RuleOrder = "DEFAULT_ACTION_ORDER" ) -// Values returns all known values for RuleOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RuleOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RuleOrder) Values() []RuleOrder { return []RuleOrder{ "STRICT_ORDER", diff --git a/service/fms/types/errors.go b/service/fms/types/errors.go index b1bb674409f..2a77253df26 100644 --- a/service/fms/types/errors.go +++ b/service/fms/types/errors.go @@ -61,11 +61,11 @@ func (e *InvalidInputException) ErrorCode() string { func (e *InvalidInputException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed because there was nothing to do or the operation wasn't -// possible. For example, you might have submitted an AssociateAdminAccount request -// for an account ID that was already set as the Firewall Manager administrator. Or -// you might have tried to access a Region that's disabled by default, and that you -// need to enable for the Firewall Manager administrator account and for -// Organizations before you can access it. +// possible. For example, you might have submitted an AssociateAdminAccount +// request for an account ID that was already set as the Firewall Manager +// administrator. Or you might have tried to access a Region that's disabled by +// default, and that you need to enable for the Firewall Manager administrator +// account and for Organizations before you can access it. type InvalidOperationException struct { Message *string @@ -119,9 +119,8 @@ func (e *InvalidTypeException) ErrorFault() smithy.ErrorFault { return smithy.Fa // The operation exceeds a resource limit, for example, the maximum number of // policy objects that you can create for an Amazon Web Services account. For more -// information, see Firewall Manager Limits -// (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the -// WAF Developer Guide. +// information, see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) +// in the WAF Developer Guide. type LimitExceededException struct { Message *string diff --git a/service/fms/types/types.go b/service/fms/types/types.go index 307bfd18bb0..58d2fcaef8c 100644 --- a/service/fms/types/types.go +++ b/service/fms/types/types.go @@ -27,14 +27,14 @@ type App struct { // This member is required. AppName *string - // The application's port number, for example 80. + // The application's port number, for example 80 . // // This member is required. Port *int64 - // The IP protocol name or number. The name can be one of tcp, udp, or icmp. For - // information on possible numbers, see Protocol Numbers - // (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). + // The IP protocol name or number. The name can be one of tcp , udp , or icmp . For + // information on possible numbers, see Protocol Numbers (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) + // . // // This member is required. Protocol *string @@ -108,8 +108,8 @@ type AwsEc2InstanceViolation struct { // Violation detail for network interfaces associated with an EC2 instance. type AwsEc2NetworkInterfaceViolation struct { - // List of security groups that violate the rules specified in the primary security - // group of the Firewall Manager policy. + // List of security groups that violate the rules specified in the primary + // security group of the Firewall Manager policy. ViolatingSecurityGroups []string // The resource ID of the network interface. @@ -118,15 +118,15 @@ type AwsEc2NetworkInterfaceViolation struct { noSmithyDocumentSerde } -// Violation detail for the rule violation in a security group when compared to the -// primary security group of the Firewall Manager policy. +// Violation detail for the rule violation in a security group when compared to +// the primary security group of the Firewall Manager policy. type AwsVPCSecurityGroupViolation struct { // List of rules specified in the security group of the Firewall Manager policy // that partially match the ViolationTarget rule. PartialMatches []PartialMatch - // Remediation options for the rule specified in the ViolationTarget. + // Remediation options for the rule specified in the ViolationTarget . PossibleSecurityGroupRemediationActions []SecurityGroupRemediationAction // The security group rule that is being evaluated. @@ -148,10 +148,9 @@ type ComplianceViolator struct { ResourceId *string // The resource type. This is in the format shown in the Amazon Web Services - // Resource Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). - // For example: AWS::ElasticLoadBalancingV2::LoadBalancer, - // AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy. + // Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // . For example: AWS::ElasticLoadBalancingV2::LoadBalancer , + // AWS::CloudFront::Distribution , or AWS::NetworkFirewall::FirewallPolicy . ResourceType *string // The reason that the resource is not protected by the policy. @@ -160,8 +159,8 @@ type ComplianceViolator struct { noSmithyDocumentSerde } -// A resource in the organization that's available to be associated with a Firewall -// Manager resource set. +// A resource in the organization that's available to be associated with a +// Firewall Manager resource set. type DiscoveredResource struct { // The Amazon Web Services account ID associated with the discovered resource. @@ -179,8 +178,8 @@ type DiscoveredResource struct { noSmithyDocumentSerde } -// A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is -// already associated with the VPC and can't be associated again. +// A DNS Firewall rule group that Firewall Manager tried to associate with a VPC +// is already associated with the VPC and can't be associated again. type DnsDuplicateRuleGroupViolation struct { // Information about the VPC ID. @@ -221,9 +220,9 @@ type DnsRuleGroupPriorityConflictViolation struct { // The priority setting of the two conflicting rule groups. ConflictingPriority int32 - // The priorities of rule groups that are already associated with the VPC. To retry - // your operation, choose priority settings that aren't in this list for the rule - // groups in your new DNS Firewall policy. + // The priorities of rule groups that are already associated with the VPC. To + // retry your operation, choose priority settings that aren't in this list for the + // rule groups in your new DNS Firewall policy. UnavailablePriorities []int32 // Information about the VPC ID. @@ -236,8 +235,8 @@ type DnsRuleGroupPriorityConflictViolation struct { noSmithyDocumentSerde } -// The action of associating an EC2 resource, such as a subnet or internet gateway, -// with a route table. +// The action of associating an EC2 resource, such as a subnet or internet +// gateway, with a route table. type EC2AssociateRouteTableAction struct { // The ID of the EC2 route table that is associated with the remediation action. @@ -269,8 +268,8 @@ type EC2CopyRouteTableAction struct { // This member is required. RouteTableId *ActionTarget - // The VPC ID of the copied EC2 route table that is associated with the remediation - // action. + // The VPC ID of the copied EC2 route table that is associated with the + // remediation action. // // This member is required. VpcId *ActionTarget @@ -414,9 +413,9 @@ type EvaluationResult struct { // policy. EvaluationLimitExceeded bool - // The number of resources that are noncompliant with the specified policy. For WAF - // and Shield Advanced policies, a resource is considered noncompliant if it is not - // associated with the policy. For security group policies, a resource is + // The number of resources that are noncompliant with the specified policy. For + // WAF and Shield Advanced policies, a resource is considered noncompliant if it is + // not associated with the policy. For security group policies, a resource is // considered noncompliant if it doesn't comply with the rules of the policy and // remediation is disabled or not possible. ViolatorCount int64 @@ -502,7 +501,7 @@ type FirewallSubnetMissingVPCEndpointViolation struct { } // Contains information about the actions that you can take to remediate scope -// violations caused by your policy's FirewallCreationConfig. +// violations caused by your policy's FirewallCreationConfig . // FirewallCreationConfig is an optional configuration that you can use to choose // which Availability Zones Firewall Manager creates Network Firewall endpoints in. type FMSPolicyUpdateFirewallCreationConfigAction struct { @@ -511,8 +510,7 @@ type FMSPolicyUpdateFirewallCreationConfigAction struct { Description *string // A FirewallCreationConfig that you can copy into your current policy's - // SecurityServiceData - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_SecurityServicePolicyData.html) + // SecurityServiceData (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_SecurityServicePolicyData.html) // in order to remedy scope violations. FirewallCreationConfig *string @@ -590,9 +588,9 @@ type NetworkFirewallInternetTrafficNotInspectedViolation struct { noSmithyDocumentSerde } -// Violation detail for the improperly configured subnet route. It's possible there -// is a missing route table route, or a configuration that causes traffic to cross -// an Availability Zone boundary. +// Violation detail for the improperly configured subnet route. It's possible +// there is a missing route table route, or a configuration that causes traffic to +// cross an Availability Zone boundary. type NetworkFirewallInvalidRouteConfigurationViolation struct { // The actual firewall endpoint. @@ -668,8 +666,8 @@ type NetworkFirewallMissingExpectedRTViolation struct { // The Availability Zone of a violating subnet. AvailabilityZone *string - // The resource ID of the current route table that's associated with the subnet, if - // one is available. + // The resource ID of the current route table that's associated with the subnet, + // if one is available. CurrentRouteTable *string // The resource ID of the route table that should be associated with the subnet. @@ -724,15 +722,13 @@ type NetworkFirewallMissingSubnetViolation struct { // Configures the firewall policy deployment model of Network Firewall. For // information about Network Firewall deployment models, see Network Firewall -// example architectures with routing -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/architectures.html) +// example architectures with routing (https://docs.aws.amazon.com/network-firewall/latest/developerguide/architectures.html) // in the Network Firewall Developer Guide. type NetworkFirewallPolicy struct { // Defines the deployment model to use for the firewall policy. To use a - // distributed model, set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to NULL. + // distributed model, set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to NULL . FirewallDeploymentModel FirewallDeploymentModel noSmithyDocumentSerde @@ -744,15 +740,10 @@ type NetworkFirewallPolicyDescription struct { // The default actions to take on a packet that doesn't match any stateful rules. // The stateful default action is optional, and is only valid when using the strict // rule order. Valid values of the stateful default action: - // - // * aws:drop_strict - // - // * - // aws:drop_established - // - // * aws:alert_strict - // - // * aws:alert_established + // - aws:drop_strict + // - aws:drop_established + // - aws:alert_strict + // - aws:alert_established StatefulDefaultActions []string // Additional options governing how Network Firewall handles stateful rules. The @@ -781,9 +772,9 @@ type NetworkFirewallPolicyDescription struct { noSmithyDocumentSerde } -// Violation detail for Network Firewall for a firewall policy that has a different -// NetworkFirewallPolicyDescription than is required by the Firewall Manager -// policy. +// Violation detail for Network Firewall for a firewall policy that has a +// different NetworkFirewallPolicyDescription than is required by the Firewall +// Manager policy. type NetworkFirewallPolicyModifiedViolation struct { // The policy that's currently in use in the individual account. @@ -803,7 +794,7 @@ type NetworkFirewallPolicyModifiedViolation struct { // group within a policy. type NetworkFirewallStatefulRuleGroupOverride struct { - // The action that changes the rule group from DROP to ALERT. This only applies to + // The action that changes the rule group from DROP to ALERT . This only applies to // managed rule groups. Action NetworkFirewallOverrideAction @@ -850,8 +841,8 @@ type NetworkFirewallUnexpectedGatewayRoutesViolation struct { noSmithyDocumentSerde } -// The reference rule that partially matches the ViolationTarget rule and violation -// reason. +// The reference rule that partially matches the ViolationTarget rule and +// violation reason. type PartialMatch struct { // The reference rule from the primary security group of the Firewall Manager @@ -867,9 +858,10 @@ type PartialMatch struct { // An Firewall Manager policy. type Policy struct { - // If set to True, resources with the tags that are specified in the ResourceTag - // array are not in scope of the policy. If set to False, and the ResourceTag array - // is not null, only resources with the specified tags are in scope of the policy. + // If set to True , resources with the tags that are specified in the ResourceTag + // array are not in scope of the policy. If set to False , and the ResourceTag + // array is not null, only resources with the specified tags are in scope of the + // policy. // // This member is required. ExcludeResourceTags bool @@ -885,19 +877,18 @@ type Policy struct { RemediationEnabled bool // The type of resource protected by or in scope of the policy. This is in the - // format shown in the Amazon Web Services Resource Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). - // To apply this policy to multiple resource types, specify a resource type of - // ResourceTypeList and then specify the resource types in a ResourceTypeList. For + // format shown in the Amazon Web Services Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // . To apply this policy to multiple resource types, specify a resource type of + // ResourceTypeList and then specify the resource types in a ResourceTypeList . For // WAF and Shield Advanced, resource types include - // AWS::ElasticLoadBalancingV2::LoadBalancer, - // AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and - // AWS::CloudFront::Distribution. For a security group common policy, valid values - // are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group - // content audit policy, valid values are AWS::EC2::SecurityGroup, - // AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage - // audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall - // policy or DNS Firewall policy, the value is AWS::EC2::VPC. + // AWS::ElasticLoadBalancingV2::LoadBalancer , + // AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , and + // AWS::CloudFront::Distribution . For a security group common policy, valid values + // are AWS::EC2::NetworkInterface and AWS::EC2::Instance . For a security group + // content audit policy, valid values are AWS::EC2::SecurityGroup , + // AWS::EC2::NetworkInterface , and AWS::EC2::Instance . For a security group usage + // audit policy, the value is AWS::EC2::SecurityGroup . For an Network Firewall + // policy or DNS Firewall policy, the value is AWS::EC2::VPC . // // This member is required. ResourceType *string @@ -921,48 +912,38 @@ type Policy struct { // units (OUs) to exclude from the policy. Specifying an OU is the equivalent of // specifying all accounts in the OU and in any of its child OUs, including any // child OUs and accounts that are added at a later time. You can specify - // inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall - // Manager applies the policy to all accounts specified by the IncludeMap, and does - // not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, - // then Firewall Manager applies the policy to all accounts except for those - // specified by the ExcludeMap. You can specify account IDs, OUs, or a + // inclusions or exclusions, but not both. If you specify an IncludeMap , Firewall + // Manager applies the policy to all accounts specified by the IncludeMap , and + // does not evaluate any ExcludeMap specifications. If you do not specify an + // IncludeMap , then Firewall Manager applies the policy to all accounts except for + // those specified by the ExcludeMap . You can specify account IDs, OUs, or a // combination: - // - // * Specify account IDs by setting the key to ACCOUNT. For example, - // the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. - // - // * - // Specify OUs by setting the key to ORG_UNIT. For example, the following is a - // valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. - // - // * Specify accounts and OUs - // together in a single map, separated with a comma. For example, the following is - // a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, - // “ouid112”]}. + // - Specify account IDs by setting the key to ACCOUNT . For example, the + // following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]} . + // - Specify OUs by setting the key to ORG_UNIT . For example, the following is a + // valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]} . + // - Specify accounts and OUs together in a single map, separated with a comma. + // For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, + // “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]} . ExcludeMap map[string][]string // Specifies the Amazon Web Services account IDs and Organizations organizational // units (OUs) to include in the policy. Specifying an OU is the equivalent of // specifying all accounts in the OU and in any of its child OUs, including any // child OUs and accounts that are added at a later time. You can specify - // inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall - // Manager applies the policy to all accounts specified by the IncludeMap, and does - // not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, - // then Firewall Manager applies the policy to all accounts except for those - // specified by the ExcludeMap. You can specify account IDs, OUs, or a + // inclusions or exclusions, but not both. If you specify an IncludeMap , Firewall + // Manager applies the policy to all accounts specified by the IncludeMap , and + // does not evaluate any ExcludeMap specifications. If you do not specify an + // IncludeMap , then Firewall Manager applies the policy to all accounts except for + // those specified by the ExcludeMap . You can specify account IDs, OUs, or a // combination: - // - // * Specify account IDs by setting the key to ACCOUNT. For example, - // the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}. - // - // * - // Specify OUs by setting the key to ORG_UNIT. For example, the following is a - // valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}. - // - // * Specify accounts and OUs - // together in a single map, separated with a comma. For example, the following is - // a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, - // “ouid112”]}. + // - Specify account IDs by setting the key to ACCOUNT . For example, the + // following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]} . + // - Specify OUs by setting the key to ORG_UNIT . For example, the following is a + // valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]} . + // - Specify accounts and OUs together in a single map, separated with a comma. + // For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, + // “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]} . IncludeMap map[string][]string // The definition of the Network Firewall firewall policy. @@ -984,15 +965,15 @@ type Policy struct { ResourceTags []ResourceTag // An array of ResourceType objects. Use this only to specify multiple resource - // types. To specify a single resource type, use ResourceType. + // types. To specify a single resource type, use ResourceType . ResourceTypeList []string noSmithyDocumentSerde } -// Describes the noncompliant resources in a member account for a specific Firewall -// Manager policy. A maximum of 100 entries are displayed. If more than 100 -// resources are noncompliant, EvaluationLimitExceeded is set to True. +// Describes the noncompliant resources in a member account for a specific +// Firewall Manager policy. A maximum of 100 entries are displayed. If more than +// 100 resources are noncompliant, EvaluationLimitExceeded is set to True . type PolicyComplianceDetail struct { // Indicates if over 100 resources are noncompliant with the Firewall Manager @@ -1016,17 +997,17 @@ type PolicyComplianceDetail struct { // The Amazon Web Services account that created the Firewall Manager policy. PolicyOwner *string - // An array of resources that aren't protected by the WAF or Shield Advanced policy - // or that aren't in compliance with the security group policy. + // An array of resources that aren't protected by the WAF or Shield Advanced + // policy or that aren't in compliance with the security group policy. Violators []ComplianceViolator noSmithyDocumentSerde } -// Indicates whether the account is compliant with the specified policy. An account -// is considered noncompliant if it includes resources that are not protected by -// the policy, for WAF and Shield Advanced policies, or that are noncompliant with -// the policy, for security group policies. +// Indicates whether the account is compliant with the specified policy. An +// account is considered noncompliant if it includes resources that are not +// protected by the policy, for WAF and Shield Advanced policies, or that are +// noncompliant with the policy, for security group policies. type PolicyComplianceStatus struct { // An array of EvaluationResult objects. @@ -1093,15 +1074,15 @@ type PolicySummary struct { RemediationEnabled bool // The type of resource protected by or in scope of the policy. This is in the - // format shown in the Amazon Web Services Resource Types Reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html). - // For WAF and Shield Advanced, examples include - // AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For - // a security group common policy, valid values are AWS::EC2::NetworkInterface and - // AWS::EC2::Instance. For a security group content audit policy, valid values are - // AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For - // a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For - // an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC. + // format shown in the Amazon Web Services Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // . For WAF and Shield Advanced, examples include + // AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution . + // For a security group common policy, valid values are AWS::EC2::NetworkInterface + // and AWS::EC2::Instance . For a security group content audit policy, valid values + // are AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and + // AWS::EC2::Instance . For a security group usage audit policy, the value is + // AWS::EC2::SecurityGroup . For an Network Firewall policy or DNS Firewall policy, + // the value is AWS::EC2::VPC . ResourceType *string // The service that the policy is using to protect the resources. This specifies @@ -1290,8 +1271,8 @@ type ResourceSet struct { // change to the resource set, provide the token in your update request. Firewall // Manager uses the token to ensure that the resource set hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the resource set again to get a - // current copy of it with a new token. Reapply your changes as needed, then try + // InvalidTokenException . If this happens, retrieve the resource set again to get + // a current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -1326,8 +1307,8 @@ type ResourceSetSummary struct { // an optional value. Firewall Manager combines the tags with "AND" so that, if you // add more than one tag to a policy scope, a resource must have all the specified // tags to be included or excluded. For more information, see Working with Tag -// Editor -// (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html). +// Editor (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html) +// . type ResourceTag struct { // The resource tag key. @@ -1353,9 +1334,9 @@ type ResourceViolation struct { // Violation detail for security groups. AwsVPCSecurityGroupViolation *AwsVPCSecurityGroupViolation - // Violation detail for a DNS Firewall policy that indicates that a rule group that - // Firewall Manager tried to associate with a VPC is already associated with the - // VPC and can't be associated again. + // Violation detail for a DNS Firewall policy that indicates that a rule group + // that Firewall Manager tried to associate with a VPC is already associated with + // the VPC and can't be associated again. DnsDuplicateRuleGroupViolation *DnsDuplicateRuleGroupViolation // Violation detail for a DNS Firewall policy that indicates that the VPC reached @@ -1363,9 +1344,9 @@ type ResourceViolation struct { // associate another rule group with the VPC and failed. DnsRuleGroupLimitExceededViolation *DnsRuleGroupLimitExceededViolation - // Violation detail for a DNS Firewall policy that indicates that a rule group that - // Firewall Manager tried to associate with a VPC has the same priority as a rule - // group that's already associated. + // Violation detail for a DNS Firewall policy that indicates that a rule group + // that Firewall Manager tried to associate with a VPC has the same priority as a + // rule group that's already associated. DnsRuleGroupPriorityConflictViolation *DnsRuleGroupPriorityConflictViolation // Contains details about the firewall subnet that violates the policy scope. @@ -1393,8 +1374,8 @@ type ResourceViolation struct { // Expected routes are missing from Network Firewall. NetworkFirewallMissingExpectedRoutesViolation *NetworkFirewallMissingExpectedRoutesViolation - // Violation detail for an Network Firewall policy that indicates that a subnet has - // no Firewall Manager managed firewall in its VPC. + // Violation detail for an Network Firewall policy that indicates that a subnet + // has no Firewall Manager managed firewall in its VPC. NetworkFirewallMissingFirewallViolation *NetworkFirewallMissingFirewallViolation // Violation detail for an Network Firewall policy that indicates that an @@ -1495,7 +1476,7 @@ type RouteHasOutOfScopeEndpointViolation struct { noSmithyDocumentSerde } -// Remediation option for the rule specified in the ViolationTarget. +// Remediation option for the rule specified in the ViolationTarget . type SecurityGroupRemediationAction struct { // Brief description of the action that will be performed. @@ -1530,11 +1511,11 @@ type SecurityGroupRuleDescription struct { // The ID of the prefix list for the security group rule. PrefixListId *string - // The IP protocol name (tcp, udp, icmp, icmpv6) or number. + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number. Protocol *string - // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. - // A value of -1 indicates all ICMP/ICMPv6 codes. + // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 + // code. A value of -1 indicates all ICMP/ICMPv6 codes. ToPort *int64 noSmithyDocumentSerde @@ -1555,161 +1536,136 @@ type SecurityServicePolicyData struct { // Details about the service that are specific to the service type, in JSON // format. - // - // * Example: - // DNS_FIREWALL"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}" - // Valid values for preProcessRuleGroups are between 1 and 99. Valid values for - // postProcessRuleGroups are between 9901 and 10000. - // - // * Example: NETWORK_FIREWALL - - // Centralized deployment model - // "{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}" - // To use the centralized deployment model, you must set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to CENTRALIZED. - // - // * Example: NETWORK_FIREWALL - Distributed deployment model with - // automatic Availability Zone configuration - // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}" - // With automatic Availbility Zone configuration, Firewall Manager chooses which - // Availability Zones to create the endpoints in. To use the distributed deployment - // model, you must set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to NULL. - // - // * Example: NETWORK_FIREWALL - Distributed deployment model with - // automatic Availability Zone configuration and route management - // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": - // \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}" - // To use the distributed deployment model, you must set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to NULL. - // - // * Example: NETWORK_FIREWALL - Distributed deployment model with custom - // Availability Zone configuration - // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", - // \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ - // \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ - // \"10.0.0.0/28\"]}]} - // },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}" - // With custom Availability Zone configuration, you define which specific - // Availability Zones to create endpoints in by configuring firewallCreationConfig. - // To configure the Availability Zones in firewallCreationConfig, specify either - // the availabilityZoneName or availabilityZoneId parameter, not both parameters. - // To use the distributed deployment model, you must set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to NULL. - // - // * Example: NETWORK_FIREWALL - Distributed deployment model with custom - // Availability Zone configuration and route management - // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}" - // To use the distributed deployment model, you must set PolicyOption - // (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) - // to NULL. - // - // * Example: THIRD_PARTY_FIREWALL"{ "type":"THIRD_PARTY_FIREWALL", - // "thirdPartyFirewall":"PALO_ALTO_NETWORKS_CLOUD_NGFW", - // "thirdPartyFirewallConfig":{ "thirdPartyFirewallPolicyList":["global-1"] }, - // "firewallDeploymentModel":{ "distributedFirewallDeploymentModel":{ - // "distributedFirewallOrchestrationConfig":{ "firewallCreationConfig":{ - // "endpointLocation":{ "availabilityZoneConfigList":[ { - // "availabilityZoneName":"${AvailabilityZone}" } ] } }, "allowedIPV4CidrList":[ ] - // } } } }" - // - // * Example: - // SECURITY_GROUPS_COMMON"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, - // \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" - // sg-000e55995d61a06bd\"}]}" - // - // * Example: SECURITY_GROUPS_COMMON - Security group - // tag distribution - // ""{\"type\":\"SECURITY_GROUPS_COMMON\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":false,\"enableTagDistribution\":true}"" - // Firewall Manager automatically distributes tags from the primary group to the - // security groups created by this policy. To use security group tag distribution, - // you must also set revertManualSecurityGroupChanges to true, otherwise Firewall - // Manager won't be able to create the policy. When you enable - // revertManualSecurityGroupChanges, Firewall Manager identifies and reports when - // the security groups created by this policy become non-compliant. Firewall - // Manager won't distrubute system tags added by Amazon Web Services services into - // the replica security groups. System tags begin with the aws: prefix. - // - // * Example: - // Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as - // to those in VPCs that the account owns - // "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, - // \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" - // sg-000e55995d61a06bd\"}]}" - // - // * Example: - // SECURITY_GROUPS_CONTENT_AUDIT"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" - // The security group action for content audit can be ALLOW or DENY. For ALLOW, all - // in-scope security group rules must be within the allowed range of the policy's - // security group rules. For DENY, all in-scope security group rules must not - // contain a value or a range that matches a rule value or range in the policy - // security group. - // - // * Example: - // SECURITY_GROUPS_USAGE_AUDIT"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}" - // - // * - // Specification for SHIELD_ADVANCED for Amazon CloudFront distributions - // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": - // {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", - // \"automaticResponseAction\":\"BLOCK|COUNT\"}, - // \"overrideCustomerWebaclClassic\":true|false}" For example: - // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": - // {\"automaticResponseStatus\":\"ENABLED\", - // \"automaticResponseAction\":\"COUNT\"}}" The default value for - // automaticResponseStatus is IGNORED. The value for automaticResponseAction is - // only required when automaticResponseStatus is set to ENABLED. The default value - // for overrideCustomerWebaclClassic is false. For other resource types that you - // can protect with a Shield Advanced policy, this ManagedServiceData configuration - // is an empty string. - // - // * Example: - // WAFV2"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" - // In the loggingConfiguration, you can specify one logDestinationConfigs, you can - // optionally provide up to 20 redactedFields, and the RedactedFieldType must be - // one of URI, QUERY_STRING, HEADER, or METHOD. - // - // * Example: WAFV2 - Firewall - // Manager support for WAF managed rule group versioning - // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" - // To use a specific version of a WAF managed rule group in your Firewall Manager - // policy, you must set versionEnabled to true, and set version to the version - // you'd like to use. If you don't set versionEnabled to true, or if you omit - // versionEnabled, then Firewall Manager uses the default version of the WAF - // managed rule group. - // - // * Example: WAF Classic"{\"type\": \"WAF\", \"ruleGroups\": - // [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : - // {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}" + // - Example: DNS_FIREWALL + // "{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}" + // Valid values for preProcessRuleGroups are between 1 and 99. Valid values for + // postProcessRuleGroups are between 9901 and 10000. + // - Example: NETWORK_FIREWALL - Centralized deployment model + // "{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}" + // To use the centralized deployment model, you must set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to CENTRALIZED . + // - Example: NETWORK_FIREWALL - Distributed deployment model with automatic + // Availability Zone configuration + // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}" + // With automatic Availbility Zone configuration, Firewall Manager chooses which + // Availability Zones to create the endpoints in. To use the distributed deployment + // model, you must set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to NULL . + // - Example: NETWORK_FIREWALL - Distributed deployment model with automatic + // Availability Zone configuration and route management + // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": + // \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}" + // To use the distributed deployment model, you must set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to NULL . + // - Example: NETWORK_FIREWALL - Distributed deployment model with custom + // Availability Zone configuration + // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", + // \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ + // \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ + // \"10.0.0.0/28\"]}]} + // },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}" + // With custom Availability Zone configuration, you define which specific + // Availability Zones to create endpoints in by configuring + // firewallCreationConfig . To configure the Availability Zones in + // firewallCreationConfig , specify either the availabilityZoneName or + // availabilityZoneId parameter, not both parameters. To use the distributed + // deployment model, you must set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to NULL . + // - Example: NETWORK_FIREWALL - Distributed deployment model with custom + // Availability Zone configuration and route management + // "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}" + // To use the distributed deployment model, you must set PolicyOption (https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) + // to NULL . + // - Example: THIRD_PARTY_FIREWALL "{ "type":"THIRD_PARTY_FIREWALL", + // "thirdPartyFirewall":"PALO_ALTO_NETWORKS_CLOUD_NGFW", + // "thirdPartyFirewallConfig":{ "thirdPartyFirewallPolicyList":["global-1"] }, + // "firewallDeploymentModel":{ "distributedFirewallDeploymentModel":{ + // "distributedFirewallOrchestrationConfig":{ "firewallCreationConfig":{ + // "endpointLocation":{ "availabilityZoneConfigList":[ { + // "availabilityZoneName":"${AvailabilityZone}" } ] } }, "allowedIPV4CidrList":[ ] + // } } } }" + // - Example: SECURITY_GROUPS_COMMON + // "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, + // \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" + // sg-000e55995d61a06bd\"}]}" + // - Example: SECURITY_GROUPS_COMMON - Security group tag distribution + // ""{\"type\":\"SECURITY_GROUPS_COMMON\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":false,\"enableTagDistribution\":true}"" + // Firewall Manager automatically distributes tags from the primary group to the + // security groups created by this policy. To use security group tag distribution, + // you must also set revertManualSecurityGroupChanges to true , otherwise + // Firewall Manager won't be able to create the policy. When you enable + // revertManualSecurityGroupChanges , Firewall Manager identifies and reports + // when the security groups created by this policy become non-compliant. Firewall + // Manager won't distrubute system tags added by Amazon Web Services services into + // the replica security groups. System tags begin with the aws: prefix. + // - Example: Shared VPCs. Apply the preceding policy to resources in shared + // VPCs as well as to those in VPCs that the account owns + // "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, + // \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" + // sg-000e55995d61a06bd\"}]}" + // - Example: SECURITY_GROUPS_CONTENT_AUDIT + // "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}" + // The security group action for content audit can be ALLOW or DENY . For ALLOW , + // all in-scope security group rules must be within the allowed range of the + // policy's security group rules. For DENY , all in-scope security group rules + // must not contain a value or a range that matches a rule value or range in the + // policy security group. + // - Example: SECURITY_GROUPS_USAGE_AUDIT + // "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}" + // - Specification for SHIELD_ADVANCED for Amazon CloudFront distributions + // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": + // {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", + // \"automaticResponseAction\":\"BLOCK|COUNT\"}, + // \"overrideCustomerWebaclClassic\":true|false}" For example: + // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": + // {\"automaticResponseStatus\":\"ENABLED\", + // \"automaticResponseAction\":\"COUNT\"}}" The default value for + // automaticResponseStatus is IGNORED . The value for automaticResponseAction is + // only required when automaticResponseStatus is set to ENABLED . The default + // value for overrideCustomerWebaclClassic is false . For other resource types + // that you can protect with a Shield Advanced policy, this ManagedServiceData + // configuration is an empty string. + // - Example: WAFV2 + // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" + // In the loggingConfiguration , you can specify one logDestinationConfigs , you + // can optionally provide up to 20 redactedFields , and the RedactedFieldType + // must be one of URI , QUERY_STRING , HEADER , or METHOD . + // - Example: WAFV2 - Firewall Manager support for WAF managed rule group + // versioning + // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}" + // To use a specific version of a WAF managed rule group in your Firewall Manager + // policy, you must set versionEnabled to true , and set version to the version + // you'd like to use. If you don't set versionEnabled to true , or if you omit + // versionEnabled , then Firewall Manager uses the default version of the WAF + // managed rule group. + // - Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": + // [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : + // {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}" ManagedServiceData *string - // Contains the Network Firewall firewall policy options to configure a centralized - // deployment model. + // Contains the Network Firewall firewall policy options to configure a + // centralized deployment model. PolicyOption *PolicyOption noSmithyDocumentSerde } -// Configuration settings for the handling of the stateful rule groups in a Network -// Firewall firewall policy. +// Configuration settings for the handling of the stateful rule groups in a +// Network Firewall firewall policy. type StatefulEngineOptions struct { // Indicates how to manage the order of stateful rule evaluation for the policy. // DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the // rule engine as Suricata compatible strings, and Suricata evaluates them based on - // certain settings. For more information, see Evaluation order for stateful rules - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) + // certain settings. For more information, see Evaluation order for stateful rules (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) // in the Network Firewall Developer Guide. RuleOrder RuleOrder noSmithyDocumentSerde } -// Network Firewall stateful rule group, used in a -// NetworkFirewallPolicyDescription. +// Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription +// . type StatefulRuleGroup struct { // The action that allows the policy owner to override the behavior of the rule @@ -1737,7 +1693,7 @@ type StatefulRuleGroup struct { } // Network Firewall stateless rule group, used in a -// NetworkFirewallPolicyDescription. +// NetworkFirewallPolicyDescription . type StatelessRuleGroup struct { // The priority of the rule group. Network Firewall evaluates the stateless rule @@ -1753,15 +1709,16 @@ type StatelessRuleGroup struct { noSmithyDocumentSerde } -// A collection of key:value pairs associated with an Amazon Web Services resource. -// The key:value pair can be anything you define. Typically, the tag key represents -// a category (such as "environment") and the tag value represents a specific value -// within that category (such as "test," "development," or "production"). You can -// add up to 50 tags to each Amazon Web Services resource. +// A collection of key:value pairs associated with an Amazon Web Services +// resource. The key:value pair can be anything you define. Typically, the tag key +// represents a category (such as "environment") and the tag value represents a +// specific value within that category (such as "test," "development," or +// "production"). You can add up to 50 tags to each Amazon Web Services resource. type Tag struct { - // Part of the key:value pair that defines a tag. You can use a tag key to describe - // a category of information, such as "customer." Tag keys are case-sensitive. + // Part of the key:value pair that defines a tag. You can use a tag key to + // describe a category of information, such as "customer." Tag keys are + // case-sensitive. // // This member is required. Key *string @@ -1795,8 +1752,8 @@ type ThirdPartyFirewallMissingExpectedRouteTableViolation struct { // The Availability Zone of the firewall subnet that's causing the violation. AvailabilityZone *string - // The resource ID of the current route table that's associated with the subnet, if - // one is available. + // The resource ID of the current route table that's associated with the subnet, + // if one is available. CurrentRouteTable *string // The resource ID of the route table that should be associated with the subnet. @@ -1831,8 +1788,8 @@ type ThirdPartyFirewallMissingFirewallViolation struct { noSmithyDocumentSerde } -// The violation details for a third-party firewall for an Availability Zone that's -// missing the Firewall Manager managed subnet. +// The violation details for a third-party firewall for an Availability Zone +// that's missing the Firewall Manager managed subnet. type ThirdPartyFirewallMissingSubnetViolation struct { // The Availability Zone of a subnet that's causing the violation. diff --git a/service/forecast/api_client.go b/service/forecast/api_client.go index 13067ab2d22..7778bd83c0c 100644 --- a/service/forecast/api_client.go +++ b/service/forecast/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/forecast/api_op_CreateAutoPredictor.go b/service/forecast/api_op_CreateAutoPredictor.go index a73d0902dc8..b0ea52ffb48 100644 --- a/service/forecast/api_op_CreateAutoPredictor.go +++ b/service/forecast/api_op_CreateAutoPredictor.go @@ -13,35 +13,24 @@ import ( // Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with // AutoPredictor, which involves applying the optimal combination of algorithms to -// each time series in your datasets. You can use CreateAutoPredictor to create new -// predictors or upgrade/retrain existing predictors. Creating new predictors The -// following parameters are required when creating a new predictor: +// each time series in your datasets. You can use CreateAutoPredictor to create +// new predictors or upgrade/retrain existing predictors. Creating new predictors +// The following parameters are required when creating a new predictor: +// - PredictorName - A unique name for the predictor. +// - DatasetGroupArn - The ARN of the dataset group used to train the predictor. +// - ForecastFrequency - The granularity of your forecasts (hourly, daily, +// weekly, etc). +// - ForecastHorizon - The number of time-steps that the model predicts. The +// forecast horizon is also called the prediction length. // -// * -// PredictorName - A unique name for the predictor. +// When creating a new predictor, do not specify a value for ReferencePredictorArn +// . Upgrading and retraining predictors The following parameters are required when +// retraining or upgrading a predictor: +// - PredictorName - A unique name for the predictor. +// - ReferencePredictorArn - The ARN of the predictor to retrain or upgrade. // -// * DatasetGroupArn - The ARN of -// the dataset group used to train the predictor. -// -// * ForecastFrequency - The -// granularity of your forecasts (hourly, daily, weekly, etc). -// -// * ForecastHorizon - -// The number of time-steps that the model predicts. The forecast horizon is also -// called the prediction length. -// -// When creating a new predictor, do not specify a -// value for ReferencePredictorArn. Upgrading and retraining predictors The -// following parameters are required when retraining or upgrading a predictor: -// -// * -// PredictorName - A unique name for the predictor. -// -// * ReferencePredictorArn - The -// ARN of the predictor to retrain or upgrade. -// -// When upgrading or retraining a -// predictor, only specify values for the ReferencePredictorArn and PredictorName. +// When upgrading or retraining a predictor, only specify values for the +// ReferencePredictorArn and PredictorName . func (c *Client) CreateAutoPredictor(ctx context.Context, params *CreateAutoPredictorInput, optFns ...func(*Options)) (*CreateAutoPredictorOutput, error) { if params == nil { params = &CreateAutoPredictorInput{} @@ -88,25 +77,17 @@ type CreateAutoPredictorInput struct { // That means, for example, you cannot specify a frequency of 60 minutes, because // that is equivalent to 1 hour. The valid values for each frequency are the // following: - // - // * Minute - 1-59 - // - // * Hour - 1-23 - // - // * Day - 1-6 - // - // * Week - 1-4 - // - // * Month - - // 1-11 - // - // * Year - 1 - // - // Thus, if you want every other week forecasts, specify "2W". - // Or, if you want quarterly forecasts, you specify "3M". The frequency must be - // greater than or equal to the TARGET_TIME_SERIES dataset frequency. When a - // RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the - // RELATED_TIME_SERIES dataset frequency. + // - Minute - 1-59 + // - Hour - 1-23 + // - Day - 1-6 + // - Week - 1-4 + // - Month - 1-11 + // - Year - 1 + // Thus, if you want every other week forecasts, specify "2W". Or, if you want + // quarterly forecasts, you specify "3M". The frequency must be greater than or + // equal to the TARGET_TIME_SERIES dataset frequency. When a RELATED_TIME_SERIES + // dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES + // dataset frequency. ForecastFrequency *string // The number of time-steps that the model predicts. The forecast horizon is also @@ -121,62 +102,52 @@ type CreateAutoPredictorInput struct { // The forecast types used to train a predictor. You can specify up to five // forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments - // of 0.01 or higher. You can also specify the mean forecast with mean. + // of 0.01 or higher. You can also specify the mean forecast with mean . ForecastTypes []string // The configuration details for predictor monitoring. Provide a name for the // monitor resource to enable predictor monitoring. Predictor monitoring allows you // to see how your predictor's performance changes over time. For more information, - // see Predictor Monitoring - // (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). + // see Predictor Monitoring (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html) + // . MonitorConfig *types.MonitorConfig // The accuracy metric used to optimize the predictor. OptimizationMetric types.OptimizationMetric - // The ARN of the predictor to retrain or upgrade. This parameter is only used when - // retraining or upgrading a predictor. When creating a new predictor, do not + // The ARN of the predictor to retrain or upgrade. This parameter is only used + // when retraining or upgrading a predictor. When creating a new predictor, do not // specify a value for this parameter. When upgrading or retraining a predictor, - // only specify values for the ReferencePredictorArn and PredictorName. The value + // only specify values for the ReferencePredictorArn and PredictorName . The value // for PredictorName must be a unique predictor name. ReferencePredictorArn *string // Optional metadata to help you categorize and organize your predictors. Each tag // consists of a key and an optional value, both of which you define. Tag keys and // values are case sensitive. The following restrictions apply to tags: - // - // * For each - // resource, each tag key must be unique and each tag key must have one value. - // - // * - // Maximum number of tags per resource: 50. - // - // * Maximum key length: 128 Unicode - // characters in UTF-8. - // - // * Maximum value length: 256 Unicode characters in - // UTF-8. - // - // * Accepted characters: all letters and numbers, spaces representable in - // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services - // and resources, the character restrictions of those services also apply. - // - // * Key - // prefixes cannot include any upper or lowercase combination of aws: or AWS:. - // Values can have this prefix. If a tag value has aws as its prefix but the key - // does not, Forecast considers it to be a user tag and will count against the - // limit of 50 tags. Tags with only the key prefix of aws do not count against your - // tags per resource limit. You cannot edit or delete tag keys with this prefix. + // - For each resource, each tag key must be unique and each tag key must have + // one value. + // - Maximum number of tags per resource: 50. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services + // and resources, the character restrictions of those services also apply. + // - Key prefixes cannot include any upper or lowercase combination of aws: or + // AWS: . Values can have this prefix. If a tag value has aws as its prefix but + // the key does not, Forecast considers it to be a user tag and will count against + // the limit of 50 tags. Tags with only the key prefix of aws do not count + // against your tags per resource limit. You cannot edit or delete tag keys with + // this prefix. Tags []types.Tag // The time boundary Forecast uses to align and aggregate any data that doesn't // align with your forecast frequency. Provide the unit of time and the time // boundary as a key value pair. For more information on specifying a time - // boundary, see Specifying a Time Boundary - // (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). - // If you don't provide a time boundary, Forecast uses a set of Default Time - // Boundaries - // (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). + // boundary, see Specifying a Time Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary) + // . If you don't provide a time boundary, Forecast uses a set of Default Time + // Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries) + // . TimeAlignmentBoundary *types.TimeAlignmentBoundary noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateDataset.go b/service/forecast/api_op_CreateDataset.go index 0d98c7712ac..f659d363788 100644 --- a/service/forecast/api_op_CreateDataset.go +++ b/service/forecast/api_op_CreateDataset.go @@ -14,31 +14,24 @@ import ( // Creates an Amazon Forecast dataset. The information about the dataset that you // provide helps Forecast understand how to consume the data for model training. // This includes the following: +// - DataFrequency - How frequently your historical time-series data is +// collected. +// - Domain and DatasetType - Each dataset has an associated dataset domain and a +// type within the domain. Amazon Forecast provides a list of predefined domains +// and types within each domain. For each unique dataset domain and type within the +// domain, Amazon Forecast requires your data to include a minimum set of +// predefined fields. +// - Schema - A schema specifies the fields in the dataset, including the field +// name and data type. // -// * DataFrequency - How frequently your historical -// time-series data is collected. -// -// * Domain and DatasetType - Each dataset has an -// associated dataset domain and a type within the domain. Amazon Forecast provides -// a list of predefined domains and types within each domain. For each unique -// dataset domain and type within the domain, Amazon Forecast requires your data to -// include a minimum set of predefined fields. -// -// * Schema - A schema specifies the -// fields in the dataset, including the field name and data type. -// -// After creating a -// dataset, you import your training data into it and add the dataset to a dataset -// group. You use the dataset group to create a predictor. For more information, -// see Importing datasets -// (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). -// To get a list of all your datasets, use the ListDatasets -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) +// After creating a dataset, you import your training data into it and add the +// dataset to a dataset group. You use the dataset group to create a predictor. For +// more information, see Importing datasets (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) +// . To get a list of all your datasets, use the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) // operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub -// repository (https://github.com/aws-samples/amazon-forecast-samples). The Status +// repository (https://github.com/aws-samples/amazon-forecast-samples) . The Status // of a dataset must be ACTIVE before you can import training data. Use the -// DescribeDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) +// DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) // operation to get the status. func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { @@ -62,31 +55,30 @@ type CreateDatasetInput struct { // This member is required. DatasetName *string - // The dataset type. Valid values depend on the chosen Domain. + // The dataset type. Valid values depend on the chosen Domain . // // This member is required. DatasetType types.DatasetType // The domain associated with the dataset. When you add a dataset to a dataset // group, this value and the value specified for the Domain parameter of the - // CreateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) + // CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) // operation must match. The Domain and DatasetType that you choose determine the // fields that must be present in the training data that you import to the dataset. // For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the - // DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to - // be present in your data. For more information, see Importing datasets - // (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). + // DatasetType , Amazon Forecast requires item_id , timestamp , and demand fields + // to be present in your data. For more information, see Importing datasets (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) + // . // // This member is required. Domain types.Domain - // The schema for the dataset. The schema attributes and their order must match the - // fields in your data. The dataset Domain and DatasetType that you choose + // The schema for the dataset. The schema attributes and their order must match + // the fields in your data. The dataset Domain and DatasetType that you choose // determine the minimum required fields in your training data. For information // about the required fields for a specific dataset domain and type, see Dataset - // Domains and Dataset Types - // (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html). + // Domains and Dataset Types (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html) + // . // // This member is required. Schema *types.Schema @@ -98,59 +90,39 @@ type CreateDatasetInput struct { // specify a value that would overlap with the next larger frequency. That means, // for example, you cannot specify a frequency of 60 minutes, because that is // equivalent to 1 hour. The valid values for each frequency are the following: - // - // * - // Minute - 1-59 - // - // * Hour - 1-23 - // - // * Day - 1-6 - // - // * Week - 1-4 - // - // * Month - 1-11 - // - // * Year - // - 1 - // + // - Minute - 1-59 + // - Hour - 1-23 + // - Day - 1-6 + // - Week - 1-4 + // - Month - 1-11 + // - Year - 1 // Thus, if you want every other week forecasts, specify "2W". Or, if you want // quarterly forecasts, you specify "3M". DataFrequency *string - // An Key Management Service (KMS) key and the Identity and Access Management (IAM) - // role that Amazon Forecast can assume to access the key. + // An Key Management Service (KMS) key and the Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. EncryptionConfig *types.EncryptionConfig // The optional metadata that you apply to the dataset to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which // you define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50. - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8. - // - // * Maximum value length - 256 Unicode characters in - // UTF-8. - // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable in - // UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for keys as it is reserved for Amazon Web Services use. You - // cannot edit or delete tag keys with this prefix. Values can have this prefix. If - // a tag value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags with only - // the key prefix of aws do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateDatasetGroup.go b/service/forecast/api_op_CreateDatasetGroup.go index b6edb07a5cb..a24f4ee6cb3 100644 --- a/service/forecast/api_op_CreateDatasetGroup.go +++ b/service/forecast/api_op_CreateDatasetGroup.go @@ -13,18 +13,14 @@ import ( // Creates a dataset group, which holds a collection of related datasets. You can // add datasets to the dataset group when you create the dataset group, or later by -// using the UpdateDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) +// using the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) // operation. After creating a dataset group and adding datasets, you use the // dataset group when you create a predictor. For more information, see Dataset -// groups -// (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). -// To get a list of all your datasets groups, use the ListDatasetGroups -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) +// groups (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) +// . To get a list of all your datasets groups, use the ListDatasetGroups (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) // operation. The Status of a dataset group must be ACTIVE before you can use the // dataset group to create a predictor. To get the status, use the -// DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) // operation. func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGroupInput, optFns ...func(*Options)) (*CreateDatasetGroupOutput, error) { if params == nil { @@ -50,14 +46,13 @@ type CreateDatasetGroupInput struct { // The domain associated with the dataset group. When you add a dataset to a // dataset group, this value and the value specified for the Domain parameter of - // the CreateDataset - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) + // the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) // operation must match. The Domain and DatasetType that you choose determine the // fields that must be present in training data that you import to a dataset. For // example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the - // DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields - // are present in your data. For more information, see Dataset groups - // (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html). + // DatasetType , Amazon Forecast requires that item_id , timestamp , and demand + // fields are present in your data. For more information, see Dataset groups (https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) + // . // // This member is required. Domain types.Domain @@ -66,36 +61,25 @@ type CreateDatasetGroupInput struct { // include in the dataset group. DatasetArns []string - // The optional metadata that you apply to the dataset group to help you categorize - // and organize them. Each tag consists of a key and an optional value, both of - // which you define. The following basic restrictions apply to tags: - // - // * Maximum - // number of tags per resource - 50. - // - // * For each resource, each tag key must be - // unique, and each tag key can have only one value. - // - // * Maximum key length - 128 - // Unicode characters in UTF-8. - // - // * Maximum value length - 256 Unicode characters in - // UTF-8. - // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable in - // UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for keys as it is reserved for Amazon Web Services use. You - // cannot edit or delete tag keys with this prefix. Values can have this prefix. If - // a tag value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags with only - // the key prefix of aws do not count against your tags per resource limit. + // The optional metadata that you apply to the dataset group to help you + // categorize and organize them. Each tag consists of a key and an optional value, + // both of which you define. The following basic restrictions apply to tags: + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateDatasetImportJob.go b/service/forecast/api_op_CreateDatasetImportJob.go index e7a6dbad62c..42907443e26 100644 --- a/service/forecast/api_op_CreateDatasetImportJob.go +++ b/service/forecast/api_op_CreateDatasetImportJob.go @@ -14,14 +14,12 @@ import ( // Imports your training data to an Amazon Forecast dataset. You provide the // location of your training data in an Amazon Simple Storage Service (Amazon S3) // bucket and the Amazon Resource Name (ARN) of the dataset that you want to import -// the data to. You must specify a DataSource -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) object that -// includes an Identity and Access Management (IAM) role that Amazon Forecast can -// assume to access the data, as Amazon Forecast makes a copy of your data and -// processes it in an internal Amazon Web Services system. For more information, -// see Set up permissions -// (https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html). -// The training data must be in CSV or Parquet format. The delimiter must be a +// the data to. You must specify a DataSource (https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html) +// object that includes an Identity and Access Management (IAM) role that Amazon +// Forecast can assume to access the data, as Amazon Forecast makes a copy of your +// data and processes it in an internal Amazon Web Services system. For more +// information, see Set up permissions (https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html) +// . The training data must be in CSV or Parquet format. The delimiter must be a // comma (,). You can specify the path to a specific file, the S3 bucket, or to a // folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all // files up to the limit of 10,000 files. Because dataset imports are not @@ -30,8 +28,7 @@ import ( // dataset import contains all of the data you want to model off of, and not just // the new data collected since the previous import. To get a list of all your // dataset import jobs, filtered by specified criteria, use the -// ListDatasetImportJobs -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) +// ListDatasetImportJobs (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) // operation. func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error) { if params == nil { @@ -56,8 +53,7 @@ type CreateDatasetImportJobInput struct { // DataSource must include an Key Management Service (KMS) key and the IAM role // must allow Amazon Forecast permission to access the key. The KMS key and IAM // role must match those specified in the EncryptionConfig parameter of the - // CreateDataset - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) + // CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) // operation. // // This member is required. @@ -70,7 +66,7 @@ type CreateDatasetImportJobInput struct { DatasetArn *string // The name for the dataset import job. We recommend including the current - // timestamp in the name, for example, 20190721DatasetImport. This can help you + // timestamp in the name, for example, 20190721DatasetImport . This can help you // avoid getting a ResourceAlreadyExistsException exception. // // This member is required. @@ -81,12 +77,10 @@ type CreateDatasetImportJobInput struct { // The format of the geolocation attribute. The geolocation attribute can be // formatted in one of two ways: - // - // * LAT_LONG - the latitude and longitude in - // decimal format (Example: 47.61_-122.33). - // - // * CC_POSTALCODE (US Only) - the - // country code (US), followed by the 5-digit ZIP code (Example: US_98121). + // - LAT_LONG - the latitude and longitude in decimal format (Example: + // 47.61_-122.33). + // - CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP + // code (Example: US_98121). GeolocationFormat *string // Specifies whether the dataset import job is a FULL or INCREMENTAL import. A FULL @@ -97,55 +91,38 @@ type CreateDatasetImportJobInput struct { // The optional metadata that you apply to the dataset import job to help you // categorize and organize them. Each tag consists of a key and an optional value, // both of which you define. The following basic restrictions apply to tags: - // - // * - // Maximum number of tags per resource - 50. - // - // * For each resource, each tag key - // must be unique, and each tag key can have only one value. - // - // * Maximum key length - // - 128 Unicode characters in UTF-8. - // - // * Maximum value length - 256 Unicode - // characters in UTF-8. - // - // * If your tagging schema is used across multiple services - // and resources, remember that other services may have restrictions on allowed - // characters. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag - // keys and values are case sensitive. - // - // * Do not use aws:, AWS:, or any upper or - // lowercase combination of such as a prefix for keys as it is reserved for Amazon - // Web Services use. You cannot edit or delete tag keys with this prefix. Values - // can have this prefix. If a tag value has aws as its prefix but the key does not, - // then Forecast considers it to be a user tag and will count against the limit of - // 50 tags. Tags with only the key prefix of aws do not count against your tags per - // resource limit. + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag // A single time zone for every item in your dataset. This option is ideal for // datasets with all timestamps within a single time zone, or if all timestamps are - // normalized to a single time zone. Refer to the Joda-Time API - // (http://joda-time.sourceforge.net/timezones.html) for a complete list of valid - // time zone names. + // normalized to a single time zone. Refer to the Joda-Time API (http://joda-time.sourceforge.net/timezones.html) + // for a complete list of valid time zone names. TimeZone *string // The format of timestamps in the dataset. The format that you specify depends on // the DataFrequency specified when the dataset was created. The following formats // are supported - // - // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and - // D - // - // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, - // and 1min; and optionally, for: Y, M, W, and D - // - // If the format isn't specified, - // Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss". + // - "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D + // - "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, + // and 1min; and optionally, for: Y, M, W, and D + // If the format isn't specified, Amazon Forecast expects the format to be + // "yyyy-MM-dd HH:mm:ss". TimestampFormat *string // Automatically derive time zone information from the geolocation attribute. This diff --git a/service/forecast/api_op_CreateExplainability.go b/service/forecast/api_op_CreateExplainability.go index ea6a8be9024..867277c8d19 100644 --- a/service/forecast/api_op_CreateExplainability.go +++ b/service/forecast/api_op_CreateExplainability.go @@ -12,7 +12,7 @@ import ( ) // Explainability is only available for Forecasts and Predictors generated from an -// AutoPredictor (CreateAutoPredictor) Creates an Amazon Forecast Explainability. +// AutoPredictor ( CreateAutoPredictor ) Creates an Amazon Forecast Explainability. // Explainability helps you better understand how the attributes in your datasets // impact forecast. Amazon Forecast uses a metric called Impact scores to quantify // the relative impact of each attribute and determine whether they increase or @@ -24,67 +24,37 @@ import ( // ARN. To receive Impact scores for specific time series and time points, provide // a Forecast ARN. CreateExplainability with a Predictor ARN You can only have one // Explainability resource per predictor. If you already enabled ExplainPredictor -// in CreateAutoPredictor, that predictor already has an Explainability resource. +// in CreateAutoPredictor , that predictor already has an Explainability resource. // The following parameters are required when providing a Predictor ARN: -// -// * -// ExplainabilityName - A unique name for the Explainability. -// -// * ResourceArn - The -// Arn of the predictor. -// -// * TimePointGranularity - Must be set to “ALL”. -// -// * -// TimeSeriesGranularity - Must be set to “ALL”. -// -// Do not specify a value for the -// following parameters: -// -// * DataSource - Only valid when TimeSeriesGranularity is -// “SPECIFIC”. -// -// * Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”. -// -// * -// StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”. -// -// * -// EndDateTime - Only valid when TimePointGranularity is -// “SPECIFIC”. -// -// CreateExplainability with a Forecast ARN You can specify a maximum -// of 50 time series and 500 time points. The following parameters are required -// when providing a Predictor ARN: -// -// * ExplainabilityName - A unique name for the -// Explainability. -// -// * ResourceArn - The Arn of the forecast. -// -// * -// TimePointGranularity - Either “ALL” or “SPECIFIC”. -// -// * TimeSeriesGranularity - -// Either “ALL” or “SPECIFIC”. -// -// If you set TimeSeriesGranularity to “SPECIFIC”, you -// must also provide the following: -// -// * DataSource - The S3 location of the CSV file -// specifying your time series. -// -// * Schema - The Schema defines the attributes and -// attribute types listed in the Data Source. -// -// If you set TimePointGranularity to -// “SPECIFIC”, you must also provide the following: -// -// * StartDateTime - The first -// timestamp in the range of time points. -// -// * EndDateTime - The last timestamp in -// the range of time points. +// - ExplainabilityName - A unique name for the Explainability. +// - ResourceArn - The Arn of the predictor. +// - TimePointGranularity - Must be set to “ALL”. +// - TimeSeriesGranularity - Must be set to “ALL”. +// +// Do not specify a value for the following parameters: +// - DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”. +// - Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”. +// - StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”. +// - EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”. +// +// CreateExplainability with a Forecast ARN You can specify a maximum of 50 time +// series and 500 time points. The following parameters are required when providing +// a Predictor ARN: +// - ExplainabilityName - A unique name for the Explainability. +// - ResourceArn - The Arn of the forecast. +// - TimePointGranularity - Either “ALL” or “SPECIFIC”. +// - TimeSeriesGranularity - Either “ALL” or “SPECIFIC”. +// +// If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the +// following: +// - DataSource - The S3 location of the CSV file specifying your time series. +// - Schema - The Schema defines the attributes and attribute types listed in the +// Data Source. +// +// If you set TimePointGranularity to “SPECIFIC”, you must also provide the +// following: +// - StartDateTime - The first timestamp in the range of time points. +// - EndDateTime - The last timestamp in the range of time points. func (c *Client) CreateExplainability(ctx context.Context, params *CreateExplainabilityInput, optFns ...func(*Options)) (*CreateExplainabilityOutput, error) { if params == nil { params = &CreateExplainabilityInput{} @@ -128,7 +98,7 @@ type CreateExplainabilityInput struct { // Services console. EnableVisualization *bool - // If TimePointGranularity is set to SPECIFIC, define the last time point for the + // If TimePointGranularity is set to SPECIFIC , define the last time point for the // Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss // (example: 2015-01-01T20:00:00) EndDateTime *string @@ -136,7 +106,7 @@ type CreateExplainabilityInput struct { // Defines the fields of a dataset. Schema *types.Schema - // If TimePointGranularity is set to SPECIFIC, define the first point for the + // If TimePointGranularity is set to SPECIFIC , define the first point for the // Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss // (example: 2015-01-01T20:00:00) StartDateTime *string @@ -144,29 +114,20 @@ type CreateExplainabilityInput struct { // Optional metadata to help you categorize and organize your resources. Each tag // consists of a key and an optional value, both of which you define. Tag keys and // values are case sensitive. The following restrictions apply to tags: - // - // * For each - // resource, each tag key must be unique and each tag key must have one value. - // - // * - // Maximum number of tags per resource: 50. - // - // * Maximum key length: 128 Unicode - // characters in UTF-8. - // - // * Maximum value length: 256 Unicode characters in - // UTF-8. - // - // * Accepted characters: all letters and numbers, spaces representable in - // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services - // and resources, the character restrictions of those services also apply. - // - // * Key - // prefixes cannot include any upper or lowercase combination of aws: or AWS:. - // Values can have this prefix. If a tag value has aws as its prefix but the key - // does not, Forecast considers it to be a user tag and will count against the - // limit of 50 tags. Tags with only the key prefix of aws do not count against your - // tags per resource limit. You cannot edit or delete tag keys with this prefix. + // - For each resource, each tag key must be unique and each tag key must have + // one value. + // - Maximum number of tags per resource: 50. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services + // and resources, the character restrictions of those services also apply. + // - Key prefixes cannot include any upper or lowercase combination of aws: or + // AWS: . Values can have this prefix. If a tag value has aws as its prefix but + // the key does not, Forecast considers it to be a user tag and will count against + // the limit of 50 tags. Tags with only the key prefix of aws do not count + // against your tags per resource limit. You cannot edit or delete tag keys with + // this prefix. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateExplainabilityExport.go b/service/forecast/api_op_CreateExplainabilityExport.go index e496a96a0bf..8f6c5e63afc 100644 --- a/service/forecast/api_op_CreateExplainabilityExport.go +++ b/service/forecast/api_op_CreateExplainabilityExport.go @@ -16,7 +16,7 @@ import ( // (Amazon S3) bucket. You must specify a DataDestination object that includes an // Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon // Forecast can assume to access the Amazon S3 bucket. For more information, see -// aws-forecast-iam-roles. The Status of the export job must be ACTIVE before you +// aws-forecast-iam-roles . The Status of the export job must be ACTIVE before you // can access the export in your Amazon S3 bucket. To get the status, use the // DescribeExplainabilityExport operation. func (c *Client) CreateExplainabilityExport(ctx context.Context, params *CreateExplainabilityExportInput, optFns ...func(*Options)) (*CreateExplainabilityExportOutput, error) { @@ -59,29 +59,20 @@ type CreateExplainabilityExportInput struct { // Optional metadata to help you categorize and organize your resources. Each tag // consists of a key and an optional value, both of which you define. Tag keys and // values are case sensitive. The following restrictions apply to tags: - // - // * For each - // resource, each tag key must be unique and each tag key must have one value. - // - // * - // Maximum number of tags per resource: 50. - // - // * Maximum key length: 128 Unicode - // characters in UTF-8. - // - // * Maximum value length: 256 Unicode characters in - // UTF-8. - // - // * Accepted characters: all letters and numbers, spaces representable in - // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services - // and resources, the character restrictions of those services also apply. - // - // * Key - // prefixes cannot include any upper or lowercase combination of aws: or AWS:. - // Values can have this prefix. If a tag value has aws as its prefix but the key - // does not, Forecast considers it to be a user tag and will count against the - // limit of 50 tags. Tags with only the key prefix of aws do not count against your - // tags per resource limit. You cannot edit or delete tag keys with this prefix. + // - For each resource, each tag key must be unique and each tag key must have + // one value. + // - Maximum number of tags per resource: 50. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services + // and resources, the character restrictions of those services also apply. + // - Key prefixes cannot include any upper or lowercase combination of aws: or + // AWS: . Values can have this prefix. If a tag value has aws as its prefix but + // the key does not, Forecast considers it to be a user tag and will count against + // the limit of 50 tags. Tags with only the key prefix of aws do not count + // against your tags per resource limit. You cannot edit or delete tag keys with + // this prefix. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateForecast.go b/service/forecast/api_op_CreateForecast.go index 52293129166..4c7edc6a55b 100644 --- a/service/forecast/api_op_CreateForecast.go +++ b/service/forecast/api_op_CreateForecast.go @@ -11,24 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used -// to train the predictor. This is known as inference. To retrieve the forecast for -// a single item at low latency, use the operation. To export the complete forecast -// into your Amazon Simple Storage Service (Amazon S3) bucket, use the -// CreateForecastExportJob operation. The range of the forecast is determined by -// the ForecastHorizon value, which you specify in the CreatePredictor request. -// When you query a forecast, you can request a specific date range within the -// forecast. To get a list of all your forecasts, use the ListForecasts operation. -// The forecasts generated by Amazon Forecast are in the same time zone as the -// dataset that was used to create the predictor. For more information, see -// howitworks-forecast. The Status of the forecast must be ACTIVE before you can -// query or export the forecast. Use the DescribeForecast operation to get the -// status. By default, a forecast includes predictions for every item (item_id) in -// the dataset group that was used to train the predictor. However, you can use the -// TimeSeriesSelector object to generate a forecast on a subset of time series. -// Forecast creation is skipped for any time series that you specify that are not -// in the input dataset. The forecast export file will not contain these time -// series or their forecasted values. +// Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was +// used to train the predictor. This is known as inference. To retrieve the +// forecast for a single item at low latency, use the operation. To export the +// complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, +// use the CreateForecastExportJob operation. The range of the forecast is +// determined by the ForecastHorizon value, which you specify in the +// CreatePredictor request. When you query a forecast, you can request a specific +// date range within the forecast. To get a list of all your forecasts, use the +// ListForecasts operation. The forecasts generated by Amazon Forecast are in the +// same time zone as the dataset that was used to create the predictor. For more +// information, see howitworks-forecast . The Status of the forecast must be ACTIVE +// before you can query or export the forecast. Use the DescribeForecast operation +// to get the status. By default, a forecast includes predictions for every item ( +// item_id ) in the dataset group that was used to train the predictor. However, +// you can use the TimeSeriesSelector object to generate a forecast on a subset of +// time series. Forecast creation is skipped for any time series that you specify +// that are not in the input dataset. The forecast export file will not contain +// these time series or their forecasted values. func (c *Client) CreateForecast(ctx context.Context, params *CreateForecastInput, optFns ...func(*Options)) (*CreateForecastOutput, error) { if params == nil { params = &CreateForecastInput{} @@ -58,54 +58,40 @@ type CreateForecastInput struct { // The quantiles at which probabilistic forecasts are generated. You can currently // specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 - // (increments of .01 only) and mean. The mean forecast is different from the + // (increments of .01 only) and mean . The mean forecast is different from the // median (0.50) when the distribution is not symmetric (for example, Beta and // Negative Binomial). The default quantiles are the quantiles you specified during // predictor creation. If you didn't specify quantiles, the default values are - // ["0.1", "0.5", "0.9"]. + // ["0.1", "0.5", "0.9"] . ForecastTypes []string // The optional metadata that you apply to the forecast to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which // you define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50. - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8. - // - // * Maximum value length - 256 Unicode characters in - // UTF-8. - // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable in - // UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for keys as it is reserved for Amazon Web Services use. You - // cannot edit or delete tag keys with this prefix. Values can have this prefix. If - // a tag value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags with only - // the key prefix of aws do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag // Defines the set of time series that are used to create the forecasts in a // TimeSeriesIdentifiers object. The TimeSeriesIdentifiers object needs the // following information: - // - // * DataSource - // - // * Format - // - // * Schema + // - DataSource + // - Format + // - Schema TimeSeriesSelector *types.TimeSeriesSelector noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateForecastExportJob.go b/service/forecast/api_op_CreateForecastExportJob.go index 7e0c1927154..3838630ad13 100644 --- a/service/forecast/api_op_CreateForecastExportJob.go +++ b/service/forecast/api_op_CreateForecastExportJob.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a forecast created by the CreateForecast operation to your Amazon Simple -// Storage Service (Amazon S3) bucket. The forecast file name will match the +// Exports a forecast created by the CreateForecast operation to your Amazon +// Simple Storage Service (Amazon S3) bucket. The forecast file name will match the // following conventions: __ where the component is in Java SimpleDateFormat // (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes // an Identity and Access Management (IAM) role that Amazon Forecast can assume to -// access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. -// For more information, see howitworks-forecast. To get a list of all your +// access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles . +// For more information, see howitworks-forecast . To get a list of all your // forecast export jobs, use the ListForecastExportJobs operation. The Status of // the forecast export job must be ACTIVE before you can access the forecast in // your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob @@ -64,34 +64,22 @@ type CreateForecastExportJobInput struct { // The optional metadata that you apply to the forecast export job to help you // categorize and organize them. Each tag consists of a key and an optional value, // both of which you define. The following basic restrictions apply to tags: - // - // * - // Maximum number of tags per resource - 50. - // - // * For each resource, each tag key - // must be unique, and each tag key can have only one value. - // - // * Maximum key length - // - 128 Unicode characters in UTF-8. - // - // * Maximum value length - 256 Unicode - // characters in UTF-8. - // - // * If your tagging schema is used across multiple services - // and resources, remember that other services may have restrictions on allowed - // characters. Generally allowed characters are: letters, numbers, and spaces - // representable in UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag - // keys and values are case sensitive. - // - // * Do not use aws:, AWS:, or any upper or - // lowercase combination of such as a prefix for keys as it is reserved for Amazon - // Web Services use. You cannot edit or delete tag keys with this prefix. Values - // can have this prefix. If a tag value has aws as its prefix but the key does not, - // then Forecast considers it to be a user tag and will count against the limit of - // 50 tags. Tags with only the key prefix of aws do not count against your tags per - // resource limit. + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateMonitor.go b/service/forecast/api_op_CreateMonitor.go index ea6b1b221ce..723421672e4 100644 --- a/service/forecast/api_op_CreateMonitor.go +++ b/service/forecast/api_op_CreateMonitor.go @@ -13,8 +13,8 @@ import ( // Creates a predictor monitor resource for an existing auto predictor. Predictor // monitoring allows you to see how your predictor's performance changes over time. -// For more information, see Predictor Monitoring -// (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html). +// For more information, see Predictor Monitoring (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html) +// . func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error) { if params == nil { params = &CreateMonitorInput{} @@ -42,8 +42,7 @@ type CreateMonitorInput struct { // This member is required. ResourceArn *string - // A list of tags - // (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) // to apply to the monitor resource. Tags []types.Tag diff --git a/service/forecast/api_op_CreatePredictor.go b/service/forecast/api_op_CreatePredictor.go index a320af9aeae..50be98c873f 100644 --- a/service/forecast/api_op_CreatePredictor.go +++ b/service/forecast/api_op_CreatePredictor.go @@ -13,7 +13,7 @@ import ( // This operation creates a legacy predictor that does not include all the // predictor functionalities provided by Amazon Forecast. To create a predictor -// that is compatible with all aspects of Forecast, use CreateAutoPredictor. +// that is compatible with all aspects of Forecast, use CreateAutoPredictor . // Creates an Amazon Forecast predictor. In the request, provide a dataset group // and either specify an algorithm or let Amazon Forecast choose an algorithm for // you using AutoML. If you specify an algorithm, you also can override @@ -23,33 +23,28 @@ import ( // see the evaluation metrics, use the GetAccuracyMetrics operation. You can // specify a featurization configuration to fill and aggregate the data fields in // the TARGET_TIME_SERIES dataset to improve model training. For more information, -// see FeaturizationConfig. For RELATED_TIME_SERIES datasets, CreatePredictor +// see FeaturizationConfig . For RELATED_TIME_SERIES datasets, CreatePredictor // verifies that the DataFrequency specified when the dataset was created matches -// the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. +// the ForecastFrequency . TARGET_TIME_SERIES datasets don't have this restriction. // Amazon Forecast also verifies the delimiter and timestamp format. For more -// information, see howitworks-datasets-groups. By default, predictors are trained +// information, see howitworks-datasets-groups . By default, predictors are trained // and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can // choose custom forecast types to train and evaluate your predictor by setting the -// ForecastTypes. AutoML If you want Amazon Forecast to evaluate each algorithm and -// choose the one that minimizes the objective function, set PerformAutoML to true. -// The objective function is defined as the mean of the weighted losses over the -// forecast types. By default, these are the p10, p50, and p90 quantile losses. For -// more information, see EvaluationResult. When AutoML is enabled, the following -// properties are disallowed: +// ForecastTypes . AutoML If you want Amazon Forecast to evaluate each algorithm +// and choose the one that minimizes the objective function , set PerformAutoML to +// true . The objective function is defined as the mean of the weighted losses +// over the forecast types. By default, these are the p10, p50, and p90 quantile +// losses. For more information, see EvaluationResult . When AutoML is enabled, the +// following properties are disallowed: +// - AlgorithmArn +// - HPOConfig +// - PerformHPO +// - TrainingParameters // -// * AlgorithmArn -// -// * HPOConfig -// -// * PerformHPO -// -// * -// TrainingParameters -// -// To get a list of all of your predictors, use the -// ListPredictors operation. Before you can use the predictor to create a forecast, -// the Status of the predictor must be ACTIVE, signifying that training has -// completed. To get the status, use the DescribePredictor operation. +// To get a list of all of your predictors, use the ListPredictors operation. +// Before you can use the predictor to create a forecast, the Status of the +// predictor must be ACTIVE , signifying that training has completed. To get the +// status, use the DescribePredictor operation. func (c *Client) CreatePredictor(ctx context.Context, params *CreatePredictorInput, optFns ...func(*Options)) (*CreatePredictorOutput, error) { if params == nil { params = &CreatePredictorInput{} @@ -74,10 +69,10 @@ type CreatePredictorInput struct { // Specifies the number of time-steps that the model is trained to predict. The // forecast horizon is also called the prediction length. For example, if you - // configure a dataset for daily data collection (using the DataFrequency parameter - // of the CreateDataset operation) and set the forecast horizon to 10, the model - // returns predictions for 10 days. The maximum forecast horizon is the lesser of - // 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. + // configure a dataset for daily data collection (using the DataFrequency + // parameter of the CreateDataset operation) and set the forecast horizon to 10, + // the model returns predictions for 10 days. The maximum forecast horizon is the + // lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. // // This member is required. ForecastHorizon *int32 @@ -94,34 +89,25 @@ type CreatePredictorInput struct { PredictorName *string // The Amazon Resource Name (ARN) of the algorithm to use for model training. - // Required if PerformAutoML is not set to true. Supported algorithms: - // - // * - // arn:aws:forecast:::algorithm/ARIMA - // - // * arn:aws:forecast:::algorithm/CNN-QR - // - // * - // arn:aws:forecast:::algorithm/Deep_AR_Plus - // - // * arn:aws:forecast:::algorithm/ETS - // - // * - // arn:aws:forecast:::algorithm/NPTS - // - // * arn:aws:forecast:::algorithm/Prophet + // Required if PerformAutoML is not set to true . Supported algorithms: + // - arn:aws:forecast:::algorithm/ARIMA + // - arn:aws:forecast:::algorithm/CNN-QR + // - arn:aws:forecast:::algorithm/Deep_AR_Plus + // - arn:aws:forecast:::algorithm/ETS + // - arn:aws:forecast:::algorithm/NPTS + // - arn:aws:forecast:::algorithm/Prophet AlgorithmArn *string - // The LatencyOptimized AutoML override strategy is only available in private beta. - // Contact Amazon Web Services Support or your account manager to learn more about - // access privileges. Used to overide the default AutoML strategy, which is to - // optimize predictor accuracy. To apply an AutoML strategy that minimizes training - // time, use LatencyOptimized. This parameter is only valid for predictors trained - // using AutoML. + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact Amazon Web Services Support or your account manager to learn more + // about access privileges. Used to overide the default AutoML strategy, which is + // to optimize predictor accuracy. To apply an AutoML strategy that minimizes + // training time, use LatencyOptimized . This parameter is only valid for + // predictors trained using AutoML. AutoMLOverrideStrategy types.AutoMLOverrideStrategy - // An Key Management Service (KMS) key and the Identity and Access Management (IAM) - // role that Amazon Forecast can assume to access the key. + // An Key Management Service (KMS) key and the Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. EncryptionConfig *types.EncryptionConfig // Used to override the default evaluation parameters of the specified algorithm. @@ -132,14 +118,14 @@ type CreatePredictorInput struct { // Specifies the forecast types used to train a predictor. You can specify up to // five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by - // increments of 0.01 or higher. You can also specify the mean forecast with mean. - // The default value is ["0.10", "0.50", "0.9"]. + // increments of 0.01 or higher. You can also specify the mean forecast with mean . + // The default value is ["0.10", "0.50", "0.9"] . ForecastTypes []string // Provides hyperparameter override values for the algorithm. If you don't provide // this parameter, Amazon Forecast uses default values. The individual algorithms // specify which hyperparameters support hyperparameter optimization (HPO). For - // more information, see aws-forecast-choosing-recipes. If you included the + // more information, see aws-forecast-choosing-recipes . If you included the // HPOConfig object, you must set PerformHPO to true. HPOConfig *types.HyperParameterTuningJobConfig @@ -148,7 +134,7 @@ type CreatePredictorInput struct { // Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates // the algorithms it provides and chooses the best algorithm and configuration for - // your training dataset. The default value is false. In this case, you are + // your training dataset. The default value is false . In this case, you are // required to specify an algorithm. Set PerformAutoML to true to have Amazon // Forecast perform AutoML. This is a good option if you aren't sure which // algorithm is suitable for your training data. In this case, PerformHPO must be @@ -157,7 +143,7 @@ type CreatePredictorInput struct { // Whether to perform hyperparameter optimization (HPO). HPO finds optimal // hyperparameter values for your training data. The process of performing HPO is - // known as running a hyperparameter tuning job. The default value is false. In + // known as running a hyperparameter tuning job. The default value is false . In // this case, Amazon Forecast uses default hyperparameter values from the chosen // algorithm. To override the default values, set PerformHPO to true and, // optionally, supply the HyperParameterTuningJobConfig object. The tuning job @@ -165,47 +151,34 @@ type CreatePredictorInput struct { // the valid range for each tunable hyperparameter. In this case, you are required // to specify an algorithm and PerformAutoML must be false. The following // algorithms support HPO: - // - // * DeepAR+ - // - // * CNN-QR + // - DeepAR+ + // - CNN-QR PerformHPO *bool - // The optional metadata that you apply to the predictor to help you categorize and - // organize them. Each tag consists of a key and an optional value, both of which - // you define. The following basic restrictions apply to tags: - // - // * Maximum number of - // tags per resource - 50. - // - // * For each resource, each tag key must be unique, and - // each tag key can have only one value. - // - // * Maximum key length - 128 Unicode - // characters in UTF-8. - // - // * Maximum value length - 256 Unicode characters in - // UTF-8. - // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable in - // UTF-8, and the following characters: + - = . _ : / @. - // - // * Tag keys and values are - // case sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination - // of such as a prefix for keys as it is reserved for Amazon Web Services use. You - // cannot edit or delete tag keys with this prefix. Values can have this prefix. If - // a tag value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags with only - // the key prefix of aws do not count against your tags per resource limit. + // The optional metadata that you apply to the predictor to help you categorize + // and organize them. Each tag consists of a key and an optional value, both of + // which you define. The following basic restrictions apply to tags: + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. Tags []types.Tag - // The hyperparameters to override for model training. The hyperparameters that you - // can override are listed in the individual algorithms. For the list of supported - // algorithms, see aws-forecast-choosing-recipes. + // The hyperparameters to override for model training. The hyperparameters that + // you can override are listed in the individual algorithms. For the list of + // supported algorithms, see aws-forecast-choosing-recipes . TrainingParameters map[string]string noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreatePredictorBacktestExportJob.go b/service/forecast/api_op_CreatePredictorBacktestExportJob.go index 26e5e3db594..f815a73a2ba 100644 --- a/service/forecast/api_op_CreatePredictorBacktestExportJob.go +++ b/service/forecast/api_op_CreatePredictorBacktestExportJob.go @@ -12,15 +12,15 @@ import ( ) // Exports backtest forecasts and accuracy metrics generated by the -// CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or -// Parquet files are exported to your specified S3 bucket. The export file names -// will match the following conventions: __.csv The component is in Java SimpleDate -// format (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that -// includes an Amazon S3 bucket and an Identity and Access Management (IAM) role -// that Amazon Forecast can assume to access the Amazon S3 bucket. For more -// information, see aws-forecast-iam-roles. The Status of the export job must be -// ACTIVE before you can access the export in your Amazon S3 bucket. To get the -// status, use the DescribePredictorBacktestExportJob operation. +// CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV +// or Parquet files are exported to your specified S3 bucket. The export file names +// will match the following conventions: __.csv The component is in Java +// SimpleDate format (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination +// object that includes an Amazon S3 bucket and an Identity and Access Management +// (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For +// more information, see aws-forecast-iam-roles . The Status of the export job +// must be ACTIVE before you can access the export in your Amazon S3 bucket. To +// get the status, use the DescribePredictorBacktestExportJob operation. func (c *Client) CreatePredictorBacktestExportJob(ctx context.Context, params *CreatePredictorBacktestExportJobInput, optFns ...func(*Options)) (*CreatePredictorBacktestExportJobOutput, error) { if params == nil { params = &CreatePredictorBacktestExportJobInput{} @@ -61,29 +61,20 @@ type CreatePredictorBacktestExportJobInput struct { // Optional metadata to help you categorize and organize your backtests. Each tag // consists of a key and an optional value, both of which you define. Tag keys and // values are case sensitive. The following restrictions apply to tags: - // - // * For each - // resource, each tag key must be unique and each tag key must have one value. - // - // * - // Maximum number of tags per resource: 50. - // - // * Maximum key length: 128 Unicode - // characters in UTF-8. - // - // * Maximum value length: 256 Unicode characters in - // UTF-8. - // - // * Accepted characters: all letters and numbers, spaces representable in - // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services - // and resources, the character restrictions of those services also apply. - // - // * Key - // prefixes cannot include any upper or lowercase combination of aws: or AWS:. - // Values can have this prefix. If a tag value has aws as its prefix but the key - // does not, Forecast considers it to be a user tag and will count against the - // limit of 50 tags. Tags with only the key prefix of aws do not count against your - // tags per resource limit. You cannot edit or delete tag keys with this prefix. + // - For each resource, each tag key must be unique and each tag key must have + // one value. + // - Maximum number of tags per resource: 50. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other services + // and resources, the character restrictions of those services also apply. + // - Key prefixes cannot include any upper or lowercase combination of aws: or + // AWS: . Values can have this prefix. If a tag value has aws as its prefix but + // the key does not, Forecast considers it to be a user tag and will count against + // the limit of 50 tags. Tags with only the key prefix of aws do not count + // against your tags per resource limit. You cannot edit or delete tag keys with + // this prefix. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateWhatIfAnalysis.go b/service/forecast/api_op_CreateWhatIfAnalysis.go index 5ca8b4d2b36..d13e1c75b1b 100644 --- a/service/forecast/api_op_CreateWhatIfAnalysis.go +++ b/service/forecast/api_op_CreateWhatIfAnalysis.go @@ -57,8 +57,7 @@ type CreateWhatIfAnalysisInput struct { // This member is required. WhatIfAnalysisName *string - // A list of tags - // (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) // to apply to the what if forecast. Tags []types.Tag @@ -66,12 +65,9 @@ type CreateWhatIfAnalysisInput struct { // TimeSeriesIdentifiers object. What-if analyses are performed only for the time // series in this object. The TimeSeriesIdentifiers object needs the following // information: - // - // * DataSource - // - // * Format - // - // * Schema + // - DataSource + // - Format + // - Schema TimeSeriesSelector *types.TimeSeriesSelector noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreateWhatIfForecast.go b/service/forecast/api_op_CreateWhatIfForecast.go index 7838adaf014..b6c4dac55ef 100644 --- a/service/forecast/api_op_CreateWhatIfForecast.go +++ b/service/forecast/api_op_CreateWhatIfForecast.go @@ -42,8 +42,7 @@ type CreateWhatIfForecastInput struct { // This member is required. WhatIfForecastName *string - // A list of tags - // (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) // to apply to the what if forecast. Tags []types.Tag diff --git a/service/forecast/api_op_CreateWhatIfForecastExport.go b/service/forecast/api_op_CreateWhatIfForecastExport.go index 7a529930d45..704bfdb2da6 100644 --- a/service/forecast/api_op_CreateWhatIfForecastExport.go +++ b/service/forecast/api_op_CreateWhatIfForecastExport.go @@ -16,12 +16,12 @@ import ( // following conventions: ≈__ The component is in Java SimpleDateFormat // (yyyy-MM-ddTHH-mm-ssZ). You must specify a DataDestination object that includes // an Identity and Access Management (IAM) role that Amazon Forecast can assume to -// access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. -// For more information, see howitworks-forecast. To get a list of all your what-if -// forecast export jobs, use the ListWhatIfForecastExports operation. The Status of -// the forecast export job must be ACTIVE before you can access the forecast in -// your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport -// operation. +// access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles . +// For more information, see howitworks-forecast . To get a list of all your +// what-if forecast export jobs, use the ListWhatIfForecastExports operation. The +// Status of the forecast export job must be ACTIVE before you can access the +// forecast in your Amazon S3 bucket. To get the status, use the +// DescribeWhatIfForecastExport operation. func (c *Client) CreateWhatIfForecastExport(ctx context.Context, params *CreateWhatIfForecastExportInput, optFns ...func(*Options)) (*CreateWhatIfForecastExportOutput, error) { if params == nil { params = &CreateWhatIfForecastExportInput{} @@ -61,8 +61,7 @@ type CreateWhatIfForecastExportInput struct { // The format of the exported data, CSV or PARQUET. Format *string - // A list of tags - // (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) // to apply to the what if forecast. Tags []types.Tag diff --git a/service/forecast/api_op_DeleteDataset.go b/service/forecast/api_op_DeleteDataset.go index 816338ec1a1..34bccb1a22a 100644 --- a/service/forecast/api_op_DeleteDataset.go +++ b/service/forecast/api_op_DeleteDataset.go @@ -10,15 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Amazon Forecast dataset that was created using the CreateDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) +// Deletes an Amazon Forecast dataset that was created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) // operation. You can only delete datasets that have a status of ACTIVE or -// CREATE_FAILED. To get the status use the DescribeDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) +// CREATE_FAILED . To get the status use the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) // operation. Forecast does not automatically update any dataset groups that // contain the deleted dataset. In order to update the dataset group, use the -// UpdateDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) +// UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) // operation, omitting the deleted dataset's ARN. func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { diff --git a/service/forecast/api_op_DeleteDatasetGroup.go b/service/forecast/api_op_DeleteDatasetGroup.go index 4189c963d7b..70bd3afb55c 100644 --- a/service/forecast/api_op_DeleteDatasetGroup.go +++ b/service/forecast/api_op_DeleteDatasetGroup.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a dataset group created using the CreateDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) -// operation. You can only delete dataset groups that have a status of ACTIVE, -// CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// Deletes a dataset group created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) +// operation. You can only delete dataset groups that have a status of ACTIVE , +// CREATE_FAILED , or UPDATE_FAILED . To get the status, use the +// DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) // operation. This operation deletes only the dataset group, not the datasets in // the group. func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error) { diff --git a/service/forecast/api_op_DeleteDatasetImportJob.go b/service/forecast/api_op_DeleteDatasetImportJob.go index 6cbc83f5cff..6089702d52c 100644 --- a/service/forecast/api_op_DeleteDatasetImportJob.go +++ b/service/forecast/api_op_DeleteDatasetImportJob.go @@ -10,11 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a dataset import job created using the CreateDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) +// Deletes a dataset import job created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) // operation. You can delete only dataset import jobs that have a status of ACTIVE -// or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) +// or CREATE_FAILED . To get the status, use the DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) // operation. func (c *Client) DeleteDatasetImportJob(ctx context.Context, params *DeleteDatasetImportJobInput, optFns ...func(*Options)) (*DeleteDatasetImportJobOutput, error) { if params == nil { diff --git a/service/forecast/api_op_DeleteExplainability.go b/service/forecast/api_op_DeleteExplainability.go index a4a4f607ecd..3a42090b31a 100644 --- a/service/forecast/api_op_DeleteExplainability.go +++ b/service/forecast/api_op_DeleteExplainability.go @@ -11,7 +11,7 @@ import ( ) // Deletes an Explainability resource. You can delete only predictor that have a -// status of ACTIVE or CREATE_FAILED. To get the status, use the +// status of ACTIVE or CREATE_FAILED . To get the status, use the // DescribeExplainability operation. func (c *Client) DeleteExplainability(ctx context.Context, params *DeleteExplainabilityInput, optFns ...func(*Options)) (*DeleteExplainabilityOutput, error) { if params == nil { diff --git a/service/forecast/api_op_DeleteForecast.go b/service/forecast/api_op_DeleteForecast.go index a6be60a39f3..97b00224dae 100644 --- a/service/forecast/api_op_DeleteForecast.go +++ b/service/forecast/api_op_DeleteForecast.go @@ -11,9 +11,9 @@ import ( ) // Deletes a forecast created using the CreateForecast operation. You can delete -// only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, -// use the DescribeForecast operation. You can't delete a forecast while it is -// being exported. After a forecast is deleted, you can no longer query the +// only forecasts that have a status of ACTIVE or CREATE_FAILED . To get the +// status, use the DescribeForecast operation. You can't delete a forecast while +// it is being exported. After a forecast is deleted, you can no longer query the // forecast. func (c *Client) DeleteForecast(ctx context.Context, params *DeleteForecastInput, optFns ...func(*Options)) (*DeleteForecastOutput, error) { if params == nil { diff --git a/service/forecast/api_op_DeleteForecastExportJob.go b/service/forecast/api_op_DeleteForecastExportJob.go index 032459b8c95..10404128afc 100644 --- a/service/forecast/api_op_DeleteForecastExportJob.go +++ b/service/forecast/api_op_DeleteForecastExportJob.go @@ -12,7 +12,7 @@ import ( // Deletes a forecast export job created using the CreateForecastExportJob // operation. You can delete only export jobs that have a status of ACTIVE or -// CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation. +// CREATE_FAILED . To get the status, use the DescribeForecastExportJob operation. func (c *Client) DeleteForecastExportJob(ctx context.Context, params *DeleteForecastExportJobInput, optFns ...func(*Options)) (*DeleteForecastExportJobOutput, error) { if params == nil { params = &DeleteForecastExportJobInput{} diff --git a/service/forecast/api_op_DeleteMonitor.go b/service/forecast/api_op_DeleteMonitor.go index c8500085a40..e27253fb78b 100644 --- a/service/forecast/api_op_DeleteMonitor.go +++ b/service/forecast/api_op_DeleteMonitor.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a monitor resource. You can only delete a monitor resource with a status -// of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED. +// Deletes a monitor resource. You can only delete a monitor resource with a +// status of ACTIVE , ACTIVE_STOPPED , CREATE_FAILED , or CREATE_STOPPED . func (c *Client) DeleteMonitor(ctx context.Context, params *DeleteMonitorInput, optFns ...func(*Options)) (*DeleteMonitorOutput, error) { if params == nil { params = &DeleteMonitorInput{} diff --git a/service/forecast/api_op_DeletePredictor.go b/service/forecast/api_op_DeletePredictor.go index 7021a72438d..fd362772d6d 100644 --- a/service/forecast/api_op_DeletePredictor.go +++ b/service/forecast/api_op_DeletePredictor.go @@ -12,7 +12,7 @@ import ( // Deletes a predictor created using the DescribePredictor or CreatePredictor // operations. You can delete only predictor that have a status of ACTIVE or -// CREATE_FAILED. To get the status, use the DescribePredictor operation. +// CREATE_FAILED . To get the status, use the DescribePredictor operation. func (c *Client) DeletePredictor(ctx context.Context, params *DeletePredictorInput, optFns ...func(*Options)) (*DeletePredictorOutput, error) { if params == nil { params = &DeletePredictorInput{} diff --git a/service/forecast/api_op_DeleteResourceTree.go b/service/forecast/api_op_DeleteResourceTree.go index 971a7466084..ba544976c42 100644 --- a/service/forecast/api_op_DeleteResourceTree.go +++ b/service/forecast/api_op_DeleteResourceTree.go @@ -16,20 +16,14 @@ import ( // the forecast is the child resource and the predictor is the parent resource. // Amazon Forecast resources possess the following parent-child resource // hierarchies: +// - Dataset: dataset import jobs +// - Dataset Group: predictors, predictor backtest export jobs, forecasts, +// forecast export jobs +// - Predictor: predictor backtest export jobs, forecasts, forecast export jobs +// - Forecast: forecast export jobs // -// * Dataset: dataset import jobs -// -// * Dataset Group: predictors, -// predictor backtest export jobs, forecasts, forecast export jobs -// -// * Predictor: -// predictor backtest export jobs, forecasts, forecast export jobs -// -// * Forecast: -// forecast export jobs -// -// DeleteResourceTree will only delete Amazon Forecast -// resources, and will not delete datasets or exported files stored in Amazon S3. +// DeleteResourceTree will only delete Amazon Forecast resources, and will not +// delete datasets or exported files stored in Amazon S3. func (c *Client) DeleteResourceTree(ctx context.Context, params *DeleteResourceTreeInput, optFns ...func(*Options)) (*DeleteResourceTreeOutput, error) { if params == nil { params = &DeleteResourceTreeInput{} diff --git a/service/forecast/api_op_DeleteWhatIfAnalysis.go b/service/forecast/api_op_DeleteWhatIfAnalysis.go index cd884c9ab45..20ba3064cff 100644 --- a/service/forecast/api_op_DeleteWhatIfAnalysis.go +++ b/service/forecast/api_op_DeleteWhatIfAnalysis.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You -// can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. -// To get the status, use the DescribeWhatIfAnalysis operation. You can't delete a -// what-if analysis while any of its forecasts are being exported. +// Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. +// You can delete only what-if analyses that have a status of ACTIVE or +// CREATE_FAILED . To get the status, use the DescribeWhatIfAnalysis operation. +// You can't delete a what-if analysis while any of its forecasts are being +// exported. func (c *Client) DeleteWhatIfAnalysis(ctx context.Context, params *DeleteWhatIfAnalysisInput, optFns ...func(*Options)) (*DeleteWhatIfAnalysisOutput, error) { if params == nil { params = &DeleteWhatIfAnalysisInput{} diff --git a/service/forecast/api_op_DeleteWhatIfForecast.go b/service/forecast/api_op_DeleteWhatIfForecast.go index aeae02e780f..496bf50122d 100644 --- a/service/forecast/api_op_DeleteWhatIfForecast.go +++ b/service/forecast/api_op_DeleteWhatIfForecast.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a what-if forecast created using the CreateWhatIfForecast operation. You -// can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. -// To get the status, use the DescribeWhatIfForecast operation. You can't delete a -// what-if forecast while it is being exported. After a what-if forecast is -// deleted, you can no longer query the what-if analysis. +// Deletes a what-if forecast created using the CreateWhatIfForecast operation. +// You can delete only what-if forecasts that have a status of ACTIVE or +// CREATE_FAILED . To get the status, use the DescribeWhatIfForecast operation. +// You can't delete a what-if forecast while it is being exported. After a what-if +// forecast is deleted, you can no longer query the what-if analysis. func (c *Client) DeleteWhatIfForecast(ctx context.Context, params *DeleteWhatIfForecastInput, optFns ...func(*Options)) (*DeleteWhatIfForecastOutput, error) { if params == nil { params = &DeleteWhatIfForecastInput{} diff --git a/service/forecast/api_op_DeleteWhatIfForecastExport.go b/service/forecast/api_op_DeleteWhatIfForecastExport.go index 0bbb607861f..db04ba6466b 100644 --- a/service/forecast/api_op_DeleteWhatIfForecastExport.go +++ b/service/forecast/api_op_DeleteWhatIfForecastExport.go @@ -12,8 +12,8 @@ import ( // Deletes a what-if forecast export created using the CreateWhatIfForecastExport // operation. You can delete only what-if forecast exports that have a status of -// ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport -// operation. +// ACTIVE or CREATE_FAILED . To get the status, use the +// DescribeWhatIfForecastExport operation. func (c *Client) DeleteWhatIfForecastExport(ctx context.Context, params *DeleteWhatIfForecastExportInput, optFns ...func(*Options)) (*DeleteWhatIfForecastExportOutput, error) { if params == nil { params = &DeleteWhatIfForecastExportInput{} diff --git a/service/forecast/api_op_DescribeAutoPredictor.go b/service/forecast/api_op_DescribeAutoPredictor.go index 8f7bbb5f7fc..08e218a77fc 100644 --- a/service/forecast/api_op_DescribeAutoPredictor.go +++ b/service/forecast/api_op_DescribeAutoPredictor.go @@ -46,8 +46,8 @@ type DescribeAutoPredictorOutput struct { // The data configuration for your dataset group and any additional datasets. DataConfig *types.DataConfig - // An array of the ARNs of the dataset import jobs used to import training data for - // the predictor. + // An array of the ARNs of the dataset import jobs used to import training data + // for the predictor. DatasetImportJobArns []string // An Key Management Service (KMS) key and an Identity and Access Management (IAM) @@ -82,19 +82,11 @@ type DescribeAutoPredictorOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // In the event of an error, a message detailing the cause of the error. @@ -117,16 +109,10 @@ type DescribeAutoPredictorOutput struct { ReferencePredictorSummary *types.ReferencePredictorSummary // The status of the predictor. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string // The time boundary Forecast uses when aggregating data. diff --git a/service/forecast/api_op_DescribeDataset.go b/service/forecast/api_op_DescribeDataset.go index 7fb11f14c52..c8ff88afb42 100644 --- a/service/forecast/api_op_DescribeDataset.go +++ b/service/forecast/api_op_DescribeDataset.go @@ -12,17 +12,12 @@ import ( "time" ) -// Describes an Amazon Forecast dataset created using the CreateDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) +// Describes an Amazon Forecast dataset created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) // operation. In addition to listing the parameters specified in the CreateDataset // request, this operation includes the following dataset properties: -// -// * -// CreationTime -// -// * LastModificationTime -// -// * Status +// - CreationTime +// - LastModificationTime +// - Status func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} @@ -75,12 +70,11 @@ type DescribeDatasetOutput struct { // (IAM) role that Amazon Forecast can assume to access the key. EncryptionConfig *types.EncryptionConfig - // When you create a dataset, LastModificationTime is the same as CreationTime. - // While data is being imported to the dataset, LastModificationTime is the current - // time of the DescribeDataset call. After a CreateDatasetImportJob - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) - // operation has finished, LastModificationTime is when the import job completed or - // failed. + // When you create a dataset, LastModificationTime is the same as CreationTime . + // While data is being imported to the dataset, LastModificationTime is the + // current time of the DescribeDataset call. After a CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // operation has finished, LastModificationTime is when the import job completed + // or failed. LastModificationTime *time.Time // An array of SchemaAttribute objects that specify the dataset fields. Each @@ -88,24 +82,15 @@ type DescribeDatasetOutput struct { Schema *types.Schema // The status of the dataset. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, - // DELETE_FAILED - // - // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED - // - // The UPDATE - // states apply while data is imported to the dataset from a call to the - // CreateDatasetImportJob - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - UPDATE_PENDING , UPDATE_IN_PROGRESS , UPDATE_FAILED + // The UPDATE states apply while data is imported to the dataset from a call to + // the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) // operation and reflect the status of the dataset import job. For example, when - // the import job status is CREATE_IN_PROGRESS, the status of the dataset is - // UPDATE_IN_PROGRESS. The Status of the dataset must be ACTIVE before you can + // the import job status is CREATE_IN_PROGRESS , the status of the dataset is + // UPDATE_IN_PROGRESS . The Status of the dataset must be ACTIVE before you can // import training data. Status *string diff --git a/service/forecast/api_op_DescribeDatasetGroup.go b/service/forecast/api_op_DescribeDatasetGroup.go index 9642726170b..8d0f99f4ecb 100644 --- a/service/forecast/api_op_DescribeDatasetGroup.go +++ b/service/forecast/api_op_DescribeDatasetGroup.go @@ -12,20 +12,13 @@ import ( "time" ) -// Describes a dataset group created using the CreateDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) +// Describes a dataset group created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) // operation. In addition to listing the parameters provided in the // CreateDatasetGroup request, this operation includes the following properties: -// -// * -// DatasetArns - The datasets belonging to the group. -// -// * CreationTime -// -// * -// LastModificationTime -// -// * Status +// - DatasetArns - The datasets belonging to the group. +// - CreationTime +// - LastModificationTime +// - Status func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error) { if params == nil { params = &DescribeDatasetGroupInput{} @@ -70,29 +63,19 @@ type DescribeDatasetGroupOutput struct { Domain types.Domain // When the dataset group was created or last updated from a call to the - // UpdateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. While the dataset group is being updated, LastModificationTime is the - // current time of the DescribeDatasetGroup call. + // UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // operation. While the dataset group is being updated, LastModificationTime is + // the current time of the DescribeDatasetGroup call. LastModificationTime *time.Time // The status of the dataset group. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, - // DELETE_FAILED - // - // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED - // - // The UPDATE - // states apply when you call the UpdateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. The Status of the dataset group must be ACTIVE before you can use the - // dataset group to create a predictor. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - UPDATE_PENDING , UPDATE_IN_PROGRESS , UPDATE_FAILED + // The UPDATE states apply when you call the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // operation. The Status of the dataset group must be ACTIVE before you can use + // the dataset group to create a predictor. Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeDatasetImportJob.go b/service/forecast/api_op_DescribeDatasetImportJob.go index ff172c520c1..ab486f70d27 100644 --- a/service/forecast/api_op_DescribeDatasetImportJob.go +++ b/service/forecast/api_op_DescribeDatasetImportJob.go @@ -12,25 +12,16 @@ import ( "time" ) -// Describes a dataset import job created using the CreateDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) +// Describes a dataset import job created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) // operation. In addition to listing the parameters provided in the // CreateDatasetImportJob request, this operation includes the following // properties: -// -// * CreationTime -// -// * LastModificationTime -// -// * DataSize -// -// * -// FieldStatistics -// -// * Status -// -// * Message - If an error occurred, information about -// the error. +// - CreationTime +// - LastModificationTime +// - DataSize +// - FieldStatistics +// - Status +// - Message - If an error occurred, information about the error. func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error) { if params == nil { params = &DescribeDatasetImportJobInput{} @@ -88,8 +79,8 @@ type DescribeDatasetImportJobOutput struct { // The format of the imported data, CSV or PARQUET. Format *string - // The format of the geolocation attribute. Valid Values:"LAT_LONG" and - // "CC_POSTALCODE". + // The format of the geolocation attribute. Valid Values: "LAT_LONG" and + // "CC_POSTALCODE" . GeolocationFormat *string // The import mode of the dataset import job, FULL or INCREMENTAL. @@ -97,35 +88,21 @@ type DescribeDatasetImportJobOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the dataset import job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, - // DELETE_IN_PROGRESS, DELETE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED Status *string // The single time zone applied to every item in the dataset @@ -134,12 +111,9 @@ type DescribeDatasetImportJobOutput struct { // The format of timestamps in the dataset. The format that you specify depends on // the DataFrequency specified when the dataset was created. The following formats // are supported - // - // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and - // D - // - // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, - // and 1min; and optionally, for: Y, M, W, and D + // - "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D + // - "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, + // and 1min; and optionally, for: Y, M, W, and D TimestampFormat *string // Whether TimeZone is automatically derived from the geolocation attribute. diff --git a/service/forecast/api_op_DescribeExplainability.go b/service/forecast/api_op_DescribeExplainability.go index e8ec873e810..952b461e171 100644 --- a/service/forecast/api_op_DescribeExplainability.go +++ b/service/forecast/api_op_DescribeExplainability.go @@ -52,7 +52,7 @@ type DescribeExplainabilityOutput struct { // Whether the visualization was enabled for the Explainability resource. EnableVisualization *bool - // If TimePointGranularity is set to SPECIFIC, the last time point in the + // If TimePointGranularity is set to SPECIFIC , the last time point in the // Explainability. EndDateTime *string @@ -72,19 +72,11 @@ type DescribeExplainabilityOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, a message about the error. @@ -97,21 +89,15 @@ type DescribeExplainabilityOutput struct { // Defines the fields of a dataset. Schema *types.Schema - // If TimePointGranularity is set to SPECIFIC, the first time point in the + // If TimePointGranularity is set to SPECIFIC , the first time point in the // Explainability. StartDateTime *string // The status of the Explainability resource. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeExplainabilityExport.go b/service/forecast/api_op_DescribeExplainabilityExport.go index f05efccaa27..770e3b98a46 100644 --- a/service/forecast/api_op_DescribeExplainabilityExport.go +++ b/service/forecast/api_op_DescribeExplainabilityExport.go @@ -63,35 +63,21 @@ type DescribeExplainabilityExportOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // Information about any errors that occurred during the export. Message *string // The status of the Explainability export. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeForecast.go b/service/forecast/api_op_DescribeForecast.go index 7298b806ba1..31aeefd8500 100644 --- a/service/forecast/api_op_DescribeForecast.go +++ b/service/forecast/api_op_DescribeForecast.go @@ -15,18 +15,11 @@ import ( // Describes a forecast created using the CreateForecast operation. In addition to // listing the properties provided in the CreateForecast request, this operation // lists the following properties: -// -// * DatasetGroupArn - The dataset group that -// provided the training data. -// -// * CreationTime -// -// * LastModificationTime -// -// * Status -// -// * -// Message - If an error occurred, information about the error. +// - DatasetGroupArn - The dataset group that provided the training data. +// - CreationTime +// - LastModificationTime +// - Status +// - Message - If an error occurred, information about the error. func (c *Client) DescribeForecast(ctx context.Context, params *DescribeForecastInput, optFns ...func(*Options)) (*DescribeForecastOutput, error) { if params == nil { params = &DescribeForecastInput{} @@ -74,19 +67,11 @@ type DescribeForecastOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. @@ -96,19 +81,12 @@ type DescribeForecastOutput struct { PredictorArn *string // The status of the forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the forecast - // must be ACTIVE before you can query or export the forecast. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the forecast must be ACTIVE before you can query or export the + // forecast. Status *string // The time series to include in the forecast. diff --git a/service/forecast/api_op_DescribeForecastExportJob.go b/service/forecast/api_op_DescribeForecastExportJob.go index de19217d3b8..a683f37d4ef 100644 --- a/service/forecast/api_op_DescribeForecastExportJob.go +++ b/service/forecast/api_op_DescribeForecastExportJob.go @@ -14,17 +14,11 @@ import ( // Describes a forecast export job created using the CreateForecastExportJob // operation. In addition to listing the properties provided by the user in the -// CreateForecastExportJob request, this operation lists the following -// properties: -// -// * CreationTime -// -// * LastModificationTime -// -// * Status -// -// * Message - If an -// error occurred, information about the error. +// CreateForecastExportJob request, this operation lists the following properties: +// - CreationTime +// - LastModificationTime +// - Status +// - Message - If an error occurred, information about the error. func (c *Client) DescribeForecastExportJob(ctx context.Context, params *DescribeForecastExportJobInput, optFns ...func(*Options)) (*DescribeForecastExportJobOutput, error) { if params == nil { params = &DescribeForecastExportJobInput{} @@ -73,39 +67,23 @@ type DescribeForecastExportJobOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the forecast export job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status - // of the forecast export job must be ACTIVE before you can access the forecast in - // your S3 bucket. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the forecast export job must be ACTIVE before you can access the + // forecast in your S3 bucket. Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeMonitor.go b/service/forecast/api_op_DescribeMonitor.go index c7c30276191..e4bbba1cac2 100644 --- a/service/forecast/api_op_DescribeMonitor.go +++ b/service/forecast/api_op_DescribeMonitor.go @@ -14,22 +14,13 @@ import ( // Describes a monitor resource. In addition to listing the properties provided in // the CreateMonitor request, this operation lists the following properties: -// -// * -// Baseline -// -// * CreationTime -// -// * LastEvaluationTime -// -// * LastEvaluationState -// -// * -// LastModificationTime -// -// * Message -// -// * Status +// - Baseline +// - CreationTime +// - LastEvaluationTime +// - LastEvaluationState +// - LastModificationTime +// - Message +// - Status func (c *Client) DescribeMonitor(ctx context.Context, params *DescribeMonitorInput, optFns ...func(*Options)) (*DescribeMonitorOutput, error) { if params == nil { params = &DescribeMonitorInput{} diff --git a/service/forecast/api_op_DescribePredictor.go b/service/forecast/api_op_DescribePredictor.go index c82f19bd33d..065df4ffffa 100644 --- a/service/forecast/api_op_DescribePredictor.go +++ b/service/forecast/api_op_DescribePredictor.go @@ -12,26 +12,18 @@ import ( "time" ) -// This operation is only valid for legacy predictors created with CreatePredictor. -// If you are not using a legacy predictor, use DescribeAutoPredictor. Describes a -// predictor created using the CreatePredictor operation. In addition to listing -// the properties provided in the CreatePredictor request, this operation lists the -// following properties: -// -// * DatasetImportJobArns - The dataset import jobs used to -// import training data. -// -// * AutoMLAlgorithmArns - If AutoML is performed, the -// algorithms that were evaluated. -// -// * CreationTime -// -// * LastModificationTime -// -// * -// Status -// -// * Message - If an error occurred, information about the error. +// This operation is only valid for legacy predictors created with +// CreatePredictor. If you are not using a legacy predictor, use +// DescribeAutoPredictor . Describes a predictor created using the CreatePredictor +// operation. In addition to listing the properties provided in the CreatePredictor +// request, this operation lists the following properties: +// - DatasetImportJobArns - The dataset import jobs used to import training data. +// - AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were +// evaluated. +// - CreationTime +// - LastModificationTime +// - Status +// - Message - If an error occurred, information about the error. func (c *Client) DescribePredictor(ctx context.Context, params *DescribePredictorInput, optFns ...func(*Options)) (*DescribePredictorOutput, error) { if params == nil { params = &DescribePredictorInput{} @@ -65,22 +57,22 @@ type DescribePredictorOutput struct { // When PerformAutoML is specified, the ARN of the chosen algorithm. AutoMLAlgorithmArns []string - // The LatencyOptimized AutoML override strategy is only available in private beta. - // Contact Amazon Web Services Support or your account manager to learn more about - // access privileges. The AutoML strategy used to train the predictor. Unless - // LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy. - // This parameter is only valid for predictors trained using AutoML. + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact Amazon Web Services Support or your account manager to learn more + // about access privileges. The AutoML strategy used to train the predictor. Unless + // LatencyOptimized is specified, the AutoML strategy optimizes predictor + // accuracy. This parameter is only valid for predictors trained using AutoML. AutoMLOverrideStrategy types.AutoMLOverrideStrategy // When the model training task was created. CreationTime *time.Time - // An array of the ARNs of the dataset import jobs used to import training data for - // the predictor. + // An array of the ARNs of the dataset import jobs used to import training data + // for the predictor. DatasetImportJobArns []string - // An Key Management Service (KMS) key and the Identity and Access Management (IAM) - // role that Amazon Forecast can assume to access the key. + // An Key Management Service (KMS) key and the Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. EncryptionConfig *types.EncryptionConfig // The estimated time remaining in minutes for the predictor training job to @@ -111,24 +103,16 @@ type DescribePredictorOutput struct { // predictor. InputDataConfig *types.InputDataConfig - // Whether the predictor was created with CreateAutoPredictor. + // Whether the predictor was created with CreateAutoPredictor . IsAutoPredictor *bool // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. @@ -146,34 +130,27 @@ type DescribePredictorOutput struct { // The ARN of the predictor. PredictorArn *string - // Details on the the status and results of the backtests performed to evaluate the - // accuracy of the predictor. You specify the number of backtests to perform when - // you call the operation. + // Details on the the status and results of the backtests performed to evaluate + // the accuracy of the predictor. You specify the number of backtests to perform + // when you call the operation. PredictorExecutionDetails *types.PredictorExecutionDetails // The name of the predictor. PredictorName *string // The status of the predictor. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, - // DELETE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // The Status of the predictor - // must be ACTIVE before you can use the predictor to create a forecast. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // The Status of the predictor must be ACTIVE before you can use the predictor to + // create a forecast. Status *string // The default training parameters or overrides selected during model training. // When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values // for the chosen hyperparameters are returned. For more information, see - // aws-forecast-choosing-recipes. + // aws-forecast-choosing-recipes . TrainingParameters map[string]string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribePredictorBacktestExportJob.go b/service/forecast/api_op_DescribePredictorBacktestExportJob.go index 7b02c1e9562..10d9af4bdba 100644 --- a/service/forecast/api_op_DescribePredictorBacktestExportJob.go +++ b/service/forecast/api_op_DescribePredictorBacktestExportJob.go @@ -14,17 +14,12 @@ import ( // Describes a predictor backtest export job created using the // CreatePredictorBacktestExportJob operation. In addition to listing the -// properties provided by the user in the CreatePredictorBacktestExportJob request, -// this operation lists the following properties: -// -// * CreationTime -// -// * -// LastModificationTime -// -// * Status -// -// * Message (if an error occurred) +// properties provided by the user in the CreatePredictorBacktestExportJob +// request, this operation lists the following properties: +// - CreationTime +// - LastModificationTime +// - Status +// - Message (if an error occurred) func (c *Client) DescribePredictorBacktestExportJob(ctx context.Context, params *DescribePredictorBacktestExportJobInput, optFns ...func(*Options)) (*DescribePredictorBacktestExportJobOutput, error) { if params == nil { params = &DescribePredictorBacktestExportJobInput{} @@ -65,19 +60,11 @@ type DescribePredictorBacktestExportJobOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // Information about any errors that may have occurred during the backtest export. @@ -93,16 +80,10 @@ type DescribePredictorBacktestExportJobOutput struct { PredictorBacktestExportJobName *string // The status of the predictor backtest export job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeWhatIfAnalysis.go b/service/forecast/api_op_DescribeWhatIfAnalysis.go index 93126c5d16e..a5459165e27 100644 --- a/service/forecast/api_op_DescribeWhatIfAnalysis.go +++ b/service/forecast/api_op_DescribeWhatIfAnalysis.go @@ -12,19 +12,13 @@ import ( "time" ) -// Describes the what-if analysis created using the CreateWhatIfAnalysis operation. -// In addition to listing the properties provided in the CreateWhatIfAnalysis -// request, this operation lists the following properties: -// -// * CreationTime -// -// * -// LastModificationTime -// -// * Message - If an error occurred, information about the -// error. -// -// * Status +// Describes the what-if analysis created using the CreateWhatIfAnalysis +// operation. In addition to listing the properties provided in the +// CreateWhatIfAnalysis request, this operation lists the following properties: +// - CreationTime +// - LastModificationTime +// - Message - If an error occurred, information about the error. +// - Status func (c *Client) DescribeWhatIfAnalysis(ctx context.Context, params *DescribeWhatIfAnalysisInput, optFns ...func(*Options)) (*DescribeWhatIfAnalysisOutput, error) { if params == nil { params = &DescribeWhatIfAnalysisInput{} @@ -64,49 +58,31 @@ type DescribeWhatIfAnalysisOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if analysis. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the what-if - // analysis must be ACTIVE before you can access the analysis. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. Status *string // Defines the set of time series that are used to create the forecasts in a // TimeSeriesIdentifiers object. The TimeSeriesIdentifiers object needs the // following information: - // - // * DataSource - // - // * Format - // - // * Schema + // - DataSource + // - Format + // - Schema TimeSeriesSelector *types.TimeSeriesSelector // The Amazon Resource Name (ARN) of the what-if analysis. diff --git a/service/forecast/api_op_DescribeWhatIfForecast.go b/service/forecast/api_op_DescribeWhatIfForecast.go index 04e2fdc84c0..32950b248c3 100644 --- a/service/forecast/api_op_DescribeWhatIfForecast.go +++ b/service/forecast/api_op_DescribeWhatIfForecast.go @@ -12,19 +12,13 @@ import ( "time" ) -// Describes the what-if forecast created using the CreateWhatIfForecast operation. -// In addition to listing the properties provided in the CreateWhatIfForecast -// request, this operation lists the following properties: -// -// * CreationTime -// -// * -// LastModificationTime -// -// * Message - If an error occurred, information about the -// error. -// -// * Status +// Describes the what-if forecast created using the CreateWhatIfForecast +// operation. In addition to listing the properties provided in the +// CreateWhatIfForecast request, this operation lists the following properties: +// - CreationTime +// - LastModificationTime +// - Message - If an error occurred, information about the error. +// - Status func (c *Client) DescribeWhatIfForecast(ctx context.Context, params *DescribeWhatIfForecastInput, optFns ...func(*Options)) (*DescribeWhatIfForecastOutput, error) { if params == nil { params = &DescribeWhatIfForecastInput{} @@ -59,49 +53,35 @@ type DescribeWhatIfForecastOutput struct { // The approximate time remaining to complete the what-if forecast, in minutes. EstimatedTimeRemainingInMinutes *int64 - // The quantiles at which probabilistic forecasts are generated. You can specify up - // to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If - // you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"]. + // The quantiles at which probabilistic forecasts are generated. You can specify + // up to five quantiles per what-if forecast in the CreateWhatIfForecast + // operation. If you didn't specify quantiles, the default values are ["0.1", + // "0.5", "0.9"] . ForecastTypes []string // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the what-if - // forecast must be ACTIVE before you can access the forecast. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if forecast must be ACTIVE before you can access the + // forecast. Status *string - // An array of S3Config, Schema, and Format elements that describe the replacement - // time series. + // An array of S3Config , Schema , and Format elements that describe the + // replacement time series. TimeSeriesReplacementsDataSource *types.TimeSeriesReplacementsDataSource // An array of Action and TimeSeriesConditions elements that describe what diff --git a/service/forecast/api_op_DescribeWhatIfForecastExport.go b/service/forecast/api_op_DescribeWhatIfForecastExport.go index cb0abfc9cfe..87efeb19a18 100644 --- a/service/forecast/api_op_DescribeWhatIfForecastExport.go +++ b/service/forecast/api_op_DescribeWhatIfForecastExport.go @@ -16,15 +16,10 @@ import ( // CreateWhatIfForecastExport operation. In addition to listing the properties // provided in the CreateWhatIfForecastExport request, this operation lists the // following properties: -// -// * CreationTime -// -// * LastModificationTime -// -// * Message - If an -// error occurred, information about the error. -// -// * Status +// - CreationTime +// - LastModificationTime +// - Message - If an error occurred, information about the error. +// - Status func (c *Client) DescribeWhatIfForecastExport(ctx context.Context, params *DescribeWhatIfForecastExportInput, optFns ...func(*Options)) (*DescribeWhatIfForecastExportOutput, error) { if params == nil { params = &DescribeWhatIfForecastExportInput{} @@ -70,38 +65,23 @@ type DescribeWhatIfForecastExportOutput struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the what-if - // forecast export must be ACTIVE before you can access the forecast export. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if forecast export must be ACTIVE before you can access + // the forecast export. Status *string // An array of Amazon Resource Names (ARNs) that represent all of the what-if diff --git a/service/forecast/api_op_GetAccuracyMetrics.go b/service/forecast/api_op_GetAccuracyMetrics.go index ee803d5c5c1..de21e1ee6fd 100644 --- a/service/forecast/api_op_GetAccuracyMetrics.go +++ b/service/forecast/api_op_GetAccuracyMetrics.go @@ -14,18 +14,18 @@ import ( // Provides metrics on the accuracy of the models that were trained by the // CreatePredictor operation. Use metrics to see how well the model performed and // to decide whether to use the predictor to generate a forecast. For more -// information, see Predictor Metrics -// (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html). This operation -// generates metrics for each backtest window that was evaluated. The number of -// backtest windows (NumberOfBacktestWindows) is specified using the -// EvaluationParameters object, which is optionally included in the CreatePredictor -// request. If NumberOfBacktestWindows isn't specified, the number defaults to one. -// The parameters of the filling method determine which items contribute to the -// metrics. If you want all items to contribute, specify zero. If you want only -// those items that have complete data in the range being evaluated to contribute, -// specify nan. For more information, see FeaturizationMethod. Before you can get -// accuracy metrics, the Status of the predictor must be ACTIVE, signifying that -// training has completed. To get the status, use the DescribePredictor operation. +// information, see Predictor Metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) +// . This operation generates metrics for each backtest window that was evaluated. +// The number of backtest windows ( NumberOfBacktestWindows ) is specified using +// the EvaluationParameters object, which is optionally included in the +// CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number +// defaults to one. The parameters of the filling method determine which items +// contribute to the metrics. If you want all items to contribute, specify zero . +// If you want only those items that have complete data in the range being +// evaluated to contribute, specify nan . For more information, see +// FeaturizationMethod . Before you can get accuracy metrics, the Status of the +// predictor must be ACTIVE , signifying that training has completed. To get the +// status, use the DescribePredictor operation. func (c *Client) GetAccuracyMetrics(ctx context.Context, params *GetAccuracyMetricsInput, optFns ...func(*Options)) (*GetAccuracyMetricsOutput, error) { if params == nil { params = &GetAccuracyMetricsInput{} @@ -53,14 +53,14 @@ type GetAccuracyMetricsInput struct { type GetAccuracyMetricsOutput struct { - // The LatencyOptimized AutoML override strategy is only available in private beta. - // Contact Amazon Web Services Support or your account manager to learn more about - // access privileges. The AutoML strategy used to train the predictor. Unless - // LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy. - // This parameter is only valid for predictors trained using AutoML. + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact Amazon Web Services Support or your account manager to learn more + // about access privileges. The AutoML strategy used to train the predictor. Unless + // LatencyOptimized is specified, the AutoML strategy optimizes predictor + // accuracy. This parameter is only valid for predictors trained using AutoML. AutoMLOverrideStrategy types.AutoMLOverrideStrategy - // Whether the predictor was created with CreateAutoPredictor. + // Whether the predictor was created with CreateAutoPredictor . IsAutoPredictor *bool // The accuracy metric used to optimize the predictor. diff --git a/service/forecast/api_op_ListDatasetGroups.go b/service/forecast/api_op_ListDatasetGroups.go index 208b3b2aeb9..8525bb400d4 100644 --- a/service/forecast/api_op_ListDatasetGroups.go +++ b/service/forecast/api_op_ListDatasetGroups.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of dataset groups created using the CreateDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) +// Returns a list of dataset groups created using the CreateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html) // operation. For each dataset group, this operation returns a summary of its // properties, including its Amazon Resource Name (ARN). You can retrieve the // complete set of properties by using the dataset group ARN with the -// DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) // operation. func (c *Client) ListDatasetGroups(ctx context.Context, params *ListDatasetGroupsInput, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error) { if params == nil { @@ -41,7 +39,7 @@ type ListDatasetGroupsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListDatasetImportJobs.go b/service/forecast/api_op_ListDatasetImportJobs.go index d3d4627e3d6..e5dc834920d 100644 --- a/service/forecast/api_op_ListDatasetImportJobs.go +++ b/service/forecast/api_op_ListDatasetImportJobs.go @@ -12,14 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of dataset import jobs created using the CreateDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) +// Returns a list of dataset import jobs created using the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) // operation. For each import job, this operation returns a summary of its // properties, including its Amazon Resource Name (ARN). You can retrieve the -// complete set of properties by using the ARN with the DescribeDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) -// operation. You can filter the list by providing an array of Filter -// (https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html) objects. +// complete set of properties by using the ARN with the DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) +// operation. You can filter the list by providing an array of Filter (https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html) +// objects. func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error) { if params == nil { params = &ListDatasetImportJobsInput{} @@ -38,31 +36,26 @@ func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetI type ListDatasetImportJobsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the datasets that match the statement from the list, // respectively. The match statement consists of a key and a value. Filter // properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the datasets that match the statement, specify IS. To exclude - // matching datasets, specify IS_NOT. - // - // * Key - The name of the parameter to filter - // on. Valid values are DatasetArn and Status. - // - // * Value - The value to match. - // - // For - // example, to list all dataset import jobs whose status is ACTIVE, you specify the - // following filter: "Filters": [ { "Condition": "IS", "Key": "Status", "Value": - // "ACTIVE" } ] + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the datasets that match the statement, specify IS . To exclude + // matching datasets, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are DatasetArn + // and Status . + // - Value - The value to match. + // For example, to list all dataset import jobs whose status is ACTIVE, you + // specify the following filter: "Filters": [ { "Condition": "IS", "Key": + // "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListDatasets.go b/service/forecast/api_op_ListDatasets.go index c218040f23d..07bb7b328c0 100644 --- a/service/forecast/api_op_ListDatasets.go +++ b/service/forecast/api_op_ListDatasets.go @@ -12,12 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of datasets created using the CreateDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) +// Returns a list of datasets created using the CreateDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) // operation. For each dataset, a summary of its properties, including its Amazon // Resource Name (ARN), is returned. To retrieve the complete set of properties, -// use the ARN with the DescribeDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) +// use the ARN with the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) // operation. func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error) { if params == nil { @@ -40,7 +38,7 @@ type ListDatasetsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListExplainabilities.go b/service/forecast/api_op_ListExplainabilities.go index 8dfd3135d15..103dc476695 100644 --- a/service/forecast/api_op_ListExplainabilities.go +++ b/service/forecast/api_op_ListExplainabilities.go @@ -34,19 +34,14 @@ func (c *Client) ListExplainabilities(ctx context.Context, params *ListExplainab type ListExplainabilitiesInput struct { - // An array of filters. For each filter, provide a condition and a match statement. - // The condition is either IS or IS_NOT, which specifies whether to include or - // exclude the resources that match the statement from the list. The match - // statement consists of a key and a value. Filter properties - // - // * Condition - The - // condition to apply. Valid values are IS and IS_NOT. - // - // * Key - The name of the - // parameter to filter on. Valid values are ResourceArn and Status. - // - // * Value - The - // value to match. + // An array of filters. For each filter, provide a condition and a match + // statement. The condition is either IS or IS_NOT , which specifies whether to + // include or exclude the resources that match the statement from the list. The + // match statement consists of a key and a value. Filter properties + // - Condition - The condition to apply. Valid values are IS and IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are ResourceArn + // and Status . + // - Value - The value to match. Filters []types.Filter // The number of items returned in the response. diff --git a/service/forecast/api_op_ListExplainabilityExports.go b/service/forecast/api_op_ListExplainabilityExports.go index d452f89ae10..23a5e41be9d 100644 --- a/service/forecast/api_op_ListExplainabilityExports.go +++ b/service/forecast/api_op_ListExplainabilityExports.go @@ -14,9 +14,9 @@ import ( // Returns a list of Explainability exports created using the // CreateExplainabilityExport operation. This operation returns a summary for each -// Explainability export. You can filter the list using an array of Filter objects. -// To retrieve the complete set of properties for a particular Explainability -// export, use the ARN with the DescribeExplainability operation. +// Explainability export. You can filter the list using an array of Filter +// objects. To retrieve the complete set of properties for a particular +// Explainability export, use the ARN with the DescribeExplainability operation. func (c *Client) ListExplainabilityExports(ctx context.Context, params *ListExplainabilityExportsInput, optFns ...func(*Options)) (*ListExplainabilityExportsOutput, error) { if params == nil { params = &ListExplainabilityExportsInput{} @@ -34,19 +34,14 @@ func (c *Client) ListExplainabilityExports(ctx context.Context, params *ListExpl type ListExplainabilityExportsInput struct { - // An array of filters. For each filter, provide a condition and a match statement. - // The condition is either IS or IS_NOT, which specifies whether to include or - // exclude resources that match the statement from the list. The match statement - // consists of a key and a value. Filter properties - // - // * Condition - The condition to - // apply. Valid values are IS and IS_NOT. - // - // * Key - The name of the parameter to - // filter on. Valid values are ResourceArn and Status. - // - // * Value - The value to - // match. + // An array of filters. For each filter, provide a condition and a match + // statement. The condition is either IS or IS_NOT , which specifies whether to + // include or exclude resources that match the statement from the list. The match + // statement consists of a key and a value. Filter properties + // - Condition - The condition to apply. Valid values are IS and IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are ResourceArn + // and Status . + // - Value - The value to match. Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListForecastExportJobs.go b/service/forecast/api_op_ListForecastExportJobs.go index 4f51ef41fca..d16bd356ead 100644 --- a/service/forecast/api_op_ListForecastExportJobs.go +++ b/service/forecast/api_op_ListForecastExportJobs.go @@ -15,8 +15,8 @@ import ( // Returns a list of forecast export jobs created using the CreateForecastExportJob // operation. For each forecast export job, this operation returns a summary of its // properties, including its Amazon Resource Name (ARN). To retrieve the complete -// set of properties, use the ARN with the DescribeForecastExportJob operation. You -// can filter the list using an array of Filter objects. +// set of properties, use the ARN with the DescribeForecastExportJob operation. +// You can filter the list using an array of Filter objects. func (c *Client) ListForecastExportJobs(ctx context.Context, params *ListForecastExportJobsInput, optFns ...func(*Options)) (*ListForecastExportJobsOutput, error) { if params == nil { params = &ListForecastExportJobsInput{} @@ -35,24 +35,19 @@ func (c *Client) ListForecastExportJobs(ctx context.Context, params *ListForecas type ListForecastExportJobsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the forecast export jobs that match the statement from the // list, respectively. The match statement consists of a key and a value. Filter // properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the forecast export jobs that match the statement, specify - // IS. To exclude matching forecast export jobs, specify IS_NOT. - // - // * Key - The name - // of the parameter to filter on. Valid values are ForecastArn and Status. - // - // * Value - // - The value to match. - // - // For example, to list all jobs that export a forecast - // named electricityforecast, specify the following filter: "Filters": [ { - // "Condition": "IS", "Key": "ForecastArn", "Value": + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the forecast export jobs that match the statement, specify IS . To + // exclude matching forecast export jobs, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are ForecastArn + // and Status . + // - Value - The value to match. + // For example, to list all jobs that export a forecast named electricityforecast, + // specify the following filter: "Filters": [ { "Condition": "IS", "Key": + // "ForecastArn", "Value": // "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ] Filters []types.Filter @@ -60,7 +55,7 @@ type ListForecastExportJobsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListForecasts.go b/service/forecast/api_op_ListForecasts.go index caec3e599e3..a1c28f2c9bf 100644 --- a/service/forecast/api_op_ListForecasts.go +++ b/service/forecast/api_op_ListForecasts.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of forecasts created using the CreateForecast operation. For each -// forecast, this operation returns a summary of its properties, including its +// Returns a list of forecasts created using the CreateForecast operation. For +// each forecast, this operation returns a summary of its properties, including its // Amazon Resource Name (ARN). To retrieve the complete set of properties, specify // the ARN with the DescribeForecast operation. You can filter the list using an // array of Filter objects. @@ -35,31 +35,26 @@ func (c *Client) ListForecasts(ctx context.Context, params *ListForecastsInput, type ListForecastsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the forecasts that match the statement from the list, // respectively. The match statement consists of a key and a value. Filter // properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the forecasts that match the statement, specify IS. To - // exclude matching forecasts, specify IS_NOT. - // - // * Key - The name of the parameter - // to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status. - // - // * - // Value - The value to match. - // - // For example, to list all forecasts whose status is - // not ACTIVE, you would specify: "Filters": [ { "Condition": "IS_NOT", "Key": - // "Status", "Value": "ACTIVE" } ] + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the forecasts that match the statement, specify IS . To exclude + // matching forecasts, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are + // DatasetGroupArn , PredictorArn , and Status . + // - Value - The value to match. + // For example, to list all forecasts whose status is not ACTIVE, you would + // specify: "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": + // "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListMonitorEvaluations.go b/service/forecast/api_op_ListMonitorEvaluations.go index 790ea9b0491..3fa2cf2364b 100644 --- a/service/forecast/api_op_ListMonitorEvaluations.go +++ b/service/forecast/api_op_ListMonitorEvaluations.go @@ -14,9 +14,9 @@ import ( // Returns a list of the monitoring evaluation results and predictor events // collected by the monitor resource during different windows of time. For -// information about monitoring see predictor-monitoring. For more information -// about retrieving monitoring results see Viewing Monitoring Results -// (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). +// information about monitoring see predictor-monitoring . For more information +// about retrieving monitoring results see Viewing Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html) +// . func (c *Client) ListMonitorEvaluations(ctx context.Context, params *ListMonitorEvaluationsInput, optFns ...func(*Options)) (*ListMonitorEvaluationsOutput, error) { if params == nil { params = &ListMonitorEvaluationsInput{} @@ -39,30 +39,24 @@ type ListMonitorEvaluationsInput struct { // This member is required. MonitorArn *string - // An array of filters. For each filter, provide a condition and a match statement. - // The condition is either IS or IS_NOT, which specifies whether to include or - // exclude the resources that match the statement from the list. The match - // statement consists of a key and a value. Filter properties - // - // * Condition - The - // condition to apply. Valid values are IS and IS_NOT. - // - // * Key - The name of the - // parameter to filter on. The only valid value is EvaluationState. - // - // * Value - The - // value to match. Valid values are only SUCCESS or FAILURE. - // - // For example, to list - // only successful monitor evaluations, you would specify: "Filters": [ { - // "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ] + // An array of filters. For each filter, provide a condition and a match + // statement. The condition is either IS or IS_NOT , which specifies whether to + // include or exclude the resources that match the statement from the list. The + // match statement consists of a key and a value. Filter properties + // - Condition - The condition to apply. Valid values are IS and IS_NOT . + // - Key - The name of the parameter to filter on. The only valid value is + // EvaluationState . + // - Value - The value to match. Valid values are only SUCCESS or FAILURE . + // For example, to list only successful monitor evaluations, you would specify: + // "Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } + // ] Filters []types.Filter // The maximum number of monitoring results to return. MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string @@ -78,11 +72,10 @@ type ListMonitorEvaluationsOutput struct { // The monitoring results and predictor events collected by the monitor resource // during different windows of time. For information about monitoring see Viewing - // Monitoring Results - // (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). - // For more information about retrieving monitoring results see Viewing Monitoring - // Results - // (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). + // Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html) + // . For more information about retrieving monitoring results see Viewing + // Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html) + // . PredictorMonitorEvaluations []types.PredictorMonitorEvaluation // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_ListMonitors.go b/service/forecast/api_op_ListMonitors.go index 30f067082d3..6b648418f5f 100644 --- a/service/forecast/api_op_ListMonitors.go +++ b/service/forecast/api_op_ListMonitors.go @@ -34,30 +34,23 @@ func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, op type ListMonitorsInput struct { - // An array of filters. For each filter, provide a condition and a match statement. - // The condition is either IS or IS_NOT, which specifies whether to include or - // exclude the resources that match the statement from the list. The match - // statement consists of a key and a value. Filter properties - // - // * Condition - The - // condition to apply. Valid values are IS and IS_NOT. - // - // * Key - The name of the - // parameter to filter on. The only valid value is Status. - // - // * Value - The value to - // match. - // - // For example, to list all monitors who's status is ACTIVE, you would - // specify: "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } - // ] + // An array of filters. For each filter, provide a condition and a match + // statement. The condition is either IS or IS_NOT , which specifies whether to + // include or exclude the resources that match the statement from the list. The + // match statement consists of a key and a value. Filter properties + // - Condition - The condition to apply. Valid values are IS and IS_NOT . + // - Key - The name of the parameter to filter on. The only valid value is Status + // . + // - Value - The value to match. + // For example, to list all monitors who's status is ACTIVE, you would specify: + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The maximum number of monitors to include in the response. MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListPredictorBacktestExportJobs.go b/service/forecast/api_op_ListPredictorBacktestExportJobs.go index f266e6f97c7..b3ccf738a60 100644 --- a/service/forecast/api_op_ListPredictorBacktestExportJobs.go +++ b/service/forecast/api_op_ListPredictorBacktestExportJobs.go @@ -34,21 +34,17 @@ func (c *Client) ListPredictorBacktestExportJobs(ctx context.Context, params *Li type ListPredictorBacktestExportJobsInput struct { - // An array of filters. For each filter, provide a condition and a match statement. - // The condition is either IS or IS_NOT, which specifies whether to include or - // exclude the predictor backtest export jobs that match the statement from the - // list. The match statement consists of a key and a value. Filter properties - // - // * - // Condition - The condition to apply. Valid values are IS and IS_NOT. To include - // the predictor backtest export jobs that match the statement, specify IS. To - // exclude matching predictor backtest export jobs, specify IS_NOT. - // - // * Key - The - // name of the parameter to filter on. Valid values are PredictorArn and Status. - // - // * - // Value - The value to match. + // An array of filters. For each filter, provide a condition and a match + // statement. The condition is either IS or IS_NOT , which specifies whether to + // include or exclude the predictor backtest export jobs that match the statement + // from the list. The match statement consists of a key and a value. Filter + // properties + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the predictor backtest export jobs that match the statement, specify + // IS . To exclude matching predictor backtest export jobs, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are PredictorArn + // and Status . + // - Value - The value to match. Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListPredictors.go b/service/forecast/api_op_ListPredictors.go index 25e1da2fda5..b94d41a8711 100644 --- a/service/forecast/api_op_ListPredictors.go +++ b/service/forecast/api_op_ListPredictors.go @@ -36,31 +36,25 @@ func (c *Client) ListPredictors(ctx context.Context, params *ListPredictorsInput type ListPredictorsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the predictors that match the statement from the list, // respectively. The match statement consists of a key and a value. Filter // properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the predictors that match the statement, specify IS. To - // exclude matching predictors, specify IS_NOT. - // - // * Key - The name of the parameter - // to filter on. Valid values are DatasetGroupArn and Status. - // - // * Value - The value - // to match. - // - // For example, to list all predictors whose status is ACTIVE, you would - // specify: "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } - // ] + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the predictors that match the statement, specify IS . To exclude + // matching predictors, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are + // DatasetGroupArn and Status . + // - Value - The value to match. + // For example, to list all predictors whose status is ACTIVE, you would specify: + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListWhatIfAnalyses.go b/service/forecast/api_op_ListWhatIfAnalyses.go index 32141490a16..636734aec6a 100644 --- a/service/forecast/api_op_ListWhatIfAnalyses.go +++ b/service/forecast/api_op_ListWhatIfAnalyses.go @@ -35,24 +35,19 @@ func (c *Client) ListWhatIfAnalyses(ctx context.Context, params *ListWhatIfAnaly type ListWhatIfAnalysesInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the what-if analysis jobs that match the statement from the // list, respectively. The match statement consists of a key and a value. Filter // properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the what-if analysis jobs that match the statement, specify - // IS. To exclude matching what-if analysis jobs, specify IS_NOT. - // - // * Key - The name - // of the parameter to filter on. Valid values are WhatIfAnalysisArn and Status. - // - // * - // Value - The value to match. - // - // For example, to list all jobs that export a - // forecast named electricityWhatIf, specify the following filter: "Filters": [ { - // "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the what-if analysis jobs that match the statement, specify IS . To + // exclude matching what-if analysis jobs, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are + // WhatIfAnalysisArn and Status . + // - Value - The value to match. + // For example, to list all jobs that export a forecast named electricityWhatIf, + // specify the following filter: "Filters": [ { "Condition": "IS", "Key": + // "WhatIfAnalysisArn", "Value": // "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ] Filters []types.Filter @@ -60,7 +55,7 @@ type ListWhatIfAnalysesInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListWhatIfForecastExports.go b/service/forecast/api_op_ListWhatIfForecastExports.go index ce6761e22c9..3578282a518 100644 --- a/service/forecast/api_op_ListWhatIfForecastExports.go +++ b/service/forecast/api_op_ListWhatIfForecastExports.go @@ -35,24 +35,19 @@ func (c *Client) ListWhatIfForecastExports(ctx context.Context, params *ListWhat type ListWhatIfForecastExportsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the what-if forecast export jobs that match the statement // from the list, respectively. The match statement consists of a key and a value. // Filter properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the forecast export jobs that match the statement, specify - // IS. To exclude matching forecast export jobs, specify IS_NOT. - // - // * Key - The name - // of the parameter to filter on. Valid values are WhatIfForecastExportArn and - // Status. - // - // * Value - The value to match. - // - // For example, to list all jobs that - // export a forecast named electricityWIFExport, specify the following filter: - // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the forecast export jobs that match the statement, specify IS . To + // exclude matching forecast export jobs, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are + // WhatIfForecastExportArn and Status . + // - Value - The value to match. + // For example, to list all jobs that export a forecast named + // electricityWIFExport, specify the following filter: "Filters": [ { "Condition": + // "IS", "Key": "WhatIfForecastExportArn", "Value": // "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ] Filters []types.Filter @@ -60,7 +55,7 @@ type ListWhatIfForecastExportsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecast/api_op_ListWhatIfForecasts.go b/service/forecast/api_op_ListWhatIfForecasts.go index fb17c6fb62a..64c38f9e37d 100644 --- a/service/forecast/api_op_ListWhatIfForecasts.go +++ b/service/forecast/api_op_ListWhatIfForecasts.go @@ -35,24 +35,19 @@ func (c *Client) ListWhatIfForecasts(ctx context.Context, params *ListWhatIfFore type ListWhatIfForecastsInput struct { // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether to + // statement. The condition is either IS or IS_NOT , which specifies whether to // include or exclude the what-if forecast export jobs that match the statement // from the list, respectively. The match statement consists of a key and a value. // Filter properties - // - // * Condition - The condition to apply. Valid values are IS and - // IS_NOT. To include the forecast export jobs that match the statement, specify - // IS. To exclude matching forecast export jobs, specify IS_NOT. - // - // * Key - The name - // of the parameter to filter on. Valid values are WhatIfForecastArn and Status. - // - // * - // Value - The value to match. - // - // For example, to list all jobs that export a - // forecast named electricityWhatIfForecast, specify the following filter: - // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": + // - Condition - The condition to apply. Valid values are IS and IS_NOT . To + // include the forecast export jobs that match the statement, specify IS . To + // exclude matching forecast export jobs, specify IS_NOT . + // - Key - The name of the parameter to filter on. Valid values are + // WhatIfForecastArn and Status . + // - Value - The value to match. + // For example, to list all jobs that export a forecast named + // electricityWhatIfForecast, specify the following filter: "Filters": [ { + // "Condition": "IS", "Key": "WhatIfForecastArn", "Value": // "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" } ] Filters []types.Filter @@ -60,7 +55,7 @@ type ListWhatIfForecastsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string @@ -70,7 +65,7 @@ type ListWhatIfForecastsInput struct { type ListWhatIfForecastsOutput struct { // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string @@ -146,8 +141,8 @@ func (c *Client) addOperationListWhatIfForecastsMiddlewares(stack *middleware.St return nil } -// ListWhatIfForecastsAPIClient is a client that implements the ListWhatIfForecasts -// operation. +// ListWhatIfForecastsAPIClient is a client that implements the +// ListWhatIfForecasts operation. type ListWhatIfForecastsAPIClient interface { ListWhatIfForecasts(context.Context, *ListWhatIfForecastsInput, ...func(*Options)) (*ListWhatIfForecastsOutput, error) } diff --git a/service/forecast/api_op_StopResource.go b/service/forecast/api_op_StopResource.go index 72273dd3418..0116983a149 100644 --- a/service/forecast/api_op_StopResource.go +++ b/service/forecast/api_op_StopResource.go @@ -11,25 +11,16 @@ import ( ) // Stops a resource. The resource undergoes the following states: CREATE_STOPPING -// and CREATE_STOPPED. You cannot resume a resource once it has been stopped. This +// and CREATE_STOPPED . You cannot resume a resource once it has been stopped. This // operation can be applied to the following resources (and their corresponding // child resources): -// -// * Dataset Import Job -// -// * Predictor Job -// -// * Forecast Job -// -// * -// Forecast Export Job -// -// * Predictor Backtest Export Job -// -// * Explainability Job -// -// * -// Explainability Export Job +// - Dataset Import Job +// - Predictor Job +// - Forecast Job +// - Forecast Export Job +// - Predictor Backtest Export Job +// - Explainability Job +// - Explainability Export Job func (c *Client) StopResource(ctx context.Context, params *StopResourceInput, optFns ...func(*Options)) (*StopResourceOutput, error) { if params == nil { params = &StopResourceInput{} @@ -48,9 +39,9 @@ func (c *Client) StopResource(ctx context.Context, params *StopResourceInput, op type StopResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource to stop. The - // supported ARNs are DatasetImportJobArn, PredictorArn, - // PredictorBacktestExportJobArn, ForecastArn, ForecastExportJobArn, - // ExplainabilityArn, and ExplainabilityExportArn. + // supported ARNs are DatasetImportJobArn , PredictorArn , + // PredictorBacktestExportJobArn , ForecastArn , ForecastExportJobArn , + // ExplainabilityArn , and ExplainabilityExportArn . // // This member is required. ResourceArn *string diff --git a/service/forecast/api_op_TagResource.go b/service/forecast/api_op_TagResource.go index 1c78f129863..58a4d6830be 100644 --- a/service/forecast/api_op_TagResource.go +++ b/service/forecast/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified tags to a resource with the specified resourceArn. If +// Associates the specified tags to a resource with the specified resourceArn . If // existing tags on a resource are not specified in the request parameters, they // are not changed. When a resource is deleted, the tags associated with that // resource are also deleted. @@ -40,33 +40,22 @@ type TagResourceInput struct { // The tags to add to the resource. A tag is an array of key-value pairs. The // following basic restrictions apply to tags: - // - // * Maximum number of tags per - // resource - 50. - // - // * For each resource, each tag key must be unique, and each tag - // key can have only one value. - // - // * Maximum key length - 128 Unicode characters in - // UTF-8. - // - // * Maximum value length - 256 Unicode characters in UTF-8. - // - // * If your - // tagging schema is used across multiple services and resources, remember that - // other services may have restrictions on allowed characters. Generally allowed - // characters are: letters, numbers, and spaces representable in UTF-8, and the - // following characters: + - = . _ : / @. - // - // * Tag keys and values are case - // sensitive. - // - // * Do not use aws:, AWS:, or any upper or lowercase combination of - // such as a prefix for keys as it is reserved for Amazon Web Services use. You - // cannot edit or delete tag keys with this prefix. Values can have this prefix. If - // a tag value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags with only - // the key prefix of aws do not count against your tags per resource limit. + // - Maximum number of tags per resource - 50. + // - For each resource, each tag key must be unique, and each tag key can have + // only one value. + // - Maximum key length - 128 Unicode characters in UTF-8. + // - Maximum value length - 256 Unicode characters in UTF-8. + // - If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable in + // UTF-8, and the following characters: + - = . _ : / @. + // - Tag keys and values are case sensitive. + // - Do not use aws: , AWS: , or any upper or lowercase combination of such as a + // prefix for keys as it is reserved for Amazon Web Services use. You cannot edit + // or delete tag keys with this prefix. Values can have this prefix. If a tag value + // has aws as its prefix but the key does not, then Forecast considers it to be a + // user tag and will count against the limit of 50 tags. Tags with only the key + // prefix of aws do not count against your tags per resource limit. // // This member is required. Tags []types.Tag diff --git a/service/forecast/api_op_UpdateDatasetGroup.go b/service/forecast/api_op_UpdateDatasetGroup.go index 5244084e012..05e19410ff8 100644 --- a/service/forecast/api_op_UpdateDatasetGroup.go +++ b/service/forecast/api_op_UpdateDatasetGroup.go @@ -12,8 +12,7 @@ import ( // Replaces the datasets in a dataset group with the specified datasets. The Status // of the dataset group must be ACTIVE before you can use the dataset group to -// create a predictor. Use the DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// create a predictor. Use the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) // operation to get the status. func (c *Client) UpdateDatasetGroup(ctx context.Context, params *UpdateDatasetGroupInput, optFns ...func(*Options)) (*UpdateDatasetGroupOutput, error) { if params == nil { diff --git a/service/forecast/types/enums.go b/service/forecast/types/enums.go index 527e53fa462..2e9053b3ff0 100644 --- a/service/forecast/types/enums.go +++ b/service/forecast/types/enums.go @@ -54,9 +54,9 @@ const ( ConditionGreaterThan Condition = "GREATER_THAN" ) -// Values returns all known values for Condition. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Condition. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Condition) Values() []Condition { return []Condition{ "EQUALS", @@ -99,9 +99,9 @@ const ( DayOfWeekSunday DayOfWeek = "SUNDAY" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "MONDAY", @@ -184,8 +184,8 @@ const ( FilterConditionStringIsNot FilterConditionString = "IS_NOT" ) -// Values returns all known values for FilterConditionString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FilterConditionString. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FilterConditionString) Values() []FilterConditionString { return []FilterConditionString{ @@ -230,8 +230,8 @@ const ( MonthDecember Month = "DECEMBER" ) -// Values returns all known values for Month. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Month. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Month) Values() []Month { return []Month{ @@ -260,9 +260,9 @@ const ( OperationDivide Operation = "DIVIDE" ) -// Values returns all known values for Operation. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operation. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operation) Values() []Operation { return []Operation{ "ADD", @@ -326,8 +326,8 @@ const ( StateDeleted State = "Deleted" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ @@ -362,8 +362,8 @@ const ( TimeSeriesGranularitySpecific TimeSeriesGranularity = "SPECIFIC" ) -// Values returns all known values for TimeSeriesGranularity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TimeSeriesGranularity. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TimeSeriesGranularity) Values() []TimeSeriesGranularity { return []TimeSeriesGranularity{ diff --git a/service/forecast/types/errors.go b/service/forecast/types/errors.go index 40b30672e45..a53b1f7508b 100644 --- a/service/forecast/types/errors.go +++ b/service/forecast/types/errors.go @@ -138,8 +138,8 @@ func (e *ResourceInUseException) ErrorCode() string { } func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and -// try again. +// We can't find a resource with that Amazon Resource Name (ARN). Check the ARN +// and try again. type ResourceNotFoundException struct { Message *string diff --git a/service/forecast/types/types.go b/service/forecast/types/types.go index c3efe412556..7da48eeec89 100644 --- a/service/forecast/types/types.go +++ b/service/forecast/types/types.go @@ -10,7 +10,7 @@ import ( // Defines the modifications that you are making to an attribute for a what-if // forecast. For example, you can use this operation to create a what-if forecast // that investigates a 10% off sale on all shoes. To do this, you specify -// "AttributeName": "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair +// "AttributeName": "shoes" , "Operation": "MULTIPLY" , and "Value": "0.90" . Pair // this operation with the TimeSeriesCondition operation within the // CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a // subset of attribute items that are modified. @@ -22,22 +22,15 @@ type Action struct { AttributeName *string // The operation that is applied to the provided attribute. Operations include: - // - // * - // ADD - adds Value to all rows of AttributeName. - // - // * SUBTRACT - subtracts Value - // from all rows of AttributeName. - // - // * MULTIPLY - multiplies all rows of - // AttributeName by Value. - // - // * DIVIDE - divides all rows of AttributeName by Value. + // - ADD - adds Value to all rows of AttributeName . + // - SUBTRACT - subtracts Value from all rows of AttributeName . + // - MULTIPLY - multiplies all rows of AttributeName by Value . + // - DIVIDE - divides all rows of AttributeName by Value . // // This member is required. Operation Operation - // The value that is applied for the chosen Operation. + // The value that is applied for the chosen Operation . // // This member is required. Value *float64 @@ -51,171 +44,88 @@ type Action struct { // historical and projected weather information into your model. The Weather Index // supplements your datasets with over two years of historical weather data and up // to 14 days of projected weather data. For more information, see Amazon Forecast -// Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html). +// Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html) . // Holidays Holidays is a built-in dataset that incorporates national holiday // information into your model. It provides native support for the holiday -// calendars of 66 countries. To view the holiday calendars, refer to the Jollyday -// (http://jollyday.sourceforge.net/data.html) library. For more information, see -// Holidays Featurization -// (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html). +// calendars of 66 countries. To view the holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html) +// library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html) +// . type AdditionalDataset struct { - // The name of the additional dataset. Valid names: "holiday" and "weather". + // The name of the additional dataset. Valid names: "holiday" and "weather" . // // This member is required. Name *string // Weather Index To enable the Weather Index, do not specify a value for - // Configuration. Holidays Holidays To enable Holidays, set CountryCode to one of + // Configuration . Holidays Holidays To enable Holidays, set CountryCode to one of // the following two-letter country codes: - // - // * "AL" - ALBANIA - // - // * "AR" - ARGENTINA - // - // * - // "AT" - AUSTRIA - // - // * "AU" - AUSTRALIA - // - // * "BA" - BOSNIA HERZEGOVINA - // - // * "BE" - - // BELGIUM - // - // * "BG" - BULGARIA - // - // * "BO" - BOLIVIA - // - // * "BR" - BRAZIL - // - // * "BY" - - // BELARUS - // - // * "CA" - CANADA - // - // * "CL" - CHILE - // - // * "CO" - COLOMBIA - // - // * "CR" - COSTA - // RICA - // - // * "HR" - CROATIA - // - // * "CZ" - CZECH REPUBLIC - // - // * "DK" - DENMARK - // - // * "EC" - - // ECUADOR - // - // * "EE" - ESTONIA - // - // * "ET" - ETHIOPIA - // - // * "FI" - FINLAND - // - // * "FR" - - // FRANCE - // - // * "DE" - GERMANY - // - // * "GR" - GREECE - // - // * "HU" - HUNGARY - // - // * "IS" - ICELAND - // - // * - // "IN" - INDIA - // - // * "IE" - IRELAND - // - // * "IT" - ITALY - // - // * "JP" - JAPAN - // - // * "KZ" - - // KAZAKHSTAN - // - // * "KR" - KOREA - // - // * "LV" - LATVIA - // - // * "LI" - LIECHTENSTEIN - // - // * "LT" - - // LITHUANIA - // - // * "LU" - LUXEMBOURG - // - // * "MK" - MACEDONIA - // - // * "MT" - MALTA - // - // * "MX" - - // MEXICO - // - // * "MD" - MOLDOVA - // - // * "ME" - MONTENEGRO - // - // * "NL" - NETHERLANDS - // - // * "NZ" - - // NEW ZEALAND - // - // * "NI" - NICARAGUA - // - // * "NG" - NIGERIA - // - // * "NO" - NORWAY - // - // * "PA" - - // PANAMA - // - // * "PY" - PARAGUAY - // - // * "PE" - PERU - // - // * "PL" - POLAND - // - // * "PT" - PORTUGAL - // - // * - // "RO" - ROMANIA - // - // * "RU" - RUSSIA - // - // * "RS" - SERBIA - // - // * "SK" - SLOVAKIA - // - // * "SI" - - // SLOVENIA - // - // * "ZA" - SOUTH AFRICA - // - // * "ES" - SPAIN - // - // * "SE" - SWEDEN - // - // * "CH" - - // SWITZERLAND - // - // * "UA" - UKRAINE - // - // * "AE" - UNITED ARAB EMIRATES - // - // * "US" - UNITED - // STATES - // - // * "UK" - UNITED KINGDOM - // - // * "UY" - URUGUAY - // - // * "VE" - VENEZUELA + // - "AL" - ALBANIA + // - "AR" - ARGENTINA + // - "AT" - AUSTRIA + // - "AU" - AUSTRALIA + // - "BA" - BOSNIA HERZEGOVINA + // - "BE" - BELGIUM + // - "BG" - BULGARIA + // - "BO" - BOLIVIA + // - "BR" - BRAZIL + // - "BY" - BELARUS + // - "CA" - CANADA + // - "CL" - CHILE + // - "CO" - COLOMBIA + // - "CR" - COSTA RICA + // - "HR" - CROATIA + // - "CZ" - CZECH REPUBLIC + // - "DK" - DENMARK + // - "EC" - ECUADOR + // - "EE" - ESTONIA + // - "ET" - ETHIOPIA + // - "FI" - FINLAND + // - "FR" - FRANCE + // - "DE" - GERMANY + // - "GR" - GREECE + // - "HU" - HUNGARY + // - "IS" - ICELAND + // - "IN" - INDIA + // - "IE" - IRELAND + // - "IT" - ITALY + // - "JP" - JAPAN + // - "KZ" - KAZAKHSTAN + // - "KR" - KOREA + // - "LV" - LATVIA + // - "LI" - LIECHTENSTEIN + // - "LT" - LITHUANIA + // - "LU" - LUXEMBOURG + // - "MK" - MACEDONIA + // - "MT" - MALTA + // - "MX" - MEXICO + // - "MD" - MOLDOVA + // - "ME" - MONTENEGRO + // - "NL" - NETHERLANDS + // - "NZ" - NEW ZEALAND + // - "NI" - NICARAGUA + // - "NG" - NIGERIA + // - "NO" - NORWAY + // - "PA" - PANAMA + // - "PY" - PARAGUAY + // - "PE" - PERU + // - "PL" - POLAND + // - "PT" - PORTUGAL + // - "RO" - ROMANIA + // - "RU" - RUSSIA + // - "RS" - SERBIA + // - "SK" - SLOVAKIA + // - "SI" - SLOVENIA + // - "ZA" - SOUTH AFRICA + // - "ES" - SPAIN + // - "SE" - SWEDEN + // - "CH" - SWITZERLAND + // - "UA" - UKRAINE + // - "AE" - UNITED ARAB EMIRATES + // - "US" - UNITED STATES + // - "UK" - UNITED KINGDOM + // - "UY" - URUGUAY + // - "VE" - VENEZUELA Configuration map[string][]string noSmithyDocumentSerde @@ -224,56 +134,39 @@ type AdditionalDataset struct { // Provides information about the method used to transform attributes. The // // following is an example using the RETAIL domain: { -// "AttributeName": -// -// "demand", -// -// "Transformations": {"aggregation": "sum", "middlefill": "zero", +// "AttributeName": "demand", // -// "backfill": "zero"} +// "Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": +// "zero"} // -// } +// } type AttributeConfig struct { // The name of the attribute as specified in the schema. Amazon Forecast supports // the target field of the target time series and the related time series datasets. - // For example, for the RETAIL domain, the target is demand. + // For example, for the RETAIL domain, the target is demand . // // This member is required. AttributeName *string - // The method parameters (key-value pairs), which are a map of override parameters. - // Specify these parameters to override the default values. Related Time Series - // attributes do not accept aggregation parameters. The following list shows the - // parameters and their valid values for the "filling" featurization method for a - // Target Time Series dataset. Default values are bolded. - // - // * aggregation: sum, avg, - // first, min, max - // - // * frontfill: none - // - // * middlefill: zero, nan (not a number), - // value, median, mean, min, max - // - // * backfill: zero, nan, value, median, mean, min, - // max - // - // The following list shows the parameters and their valid values for a - // Related Time Series featurization method (there are no defaults): - // - // * middlefill: - // zero, value, median, mean, min, max - // - // * backfill: zero, value, median, mean, min, - // max - // - // * futurefill: zero, value, median, mean, min, max - // - // To set a filling method - // to a specific value, set the fill parameter to value and define the value in a - // corresponding _value parameter. For example, to set backfilling to a value of 2, - // include the following: "backfill": "value" and "backfill_value":"2". + // The method parameters (key-value pairs), which are a map of override + // parameters. Specify these parameters to override the default values. Related + // Time Series attributes do not accept aggregation parameters. The following list + // shows the parameters and their valid values for the "filling" featurization + // method for a Target Time Series dataset. Default values are bolded. + // - aggregation : sum, avg , first , min , max + // - frontfill : none + // - middlefill : zero, nan (not a number), value , median , mean , min , max + // - backfill : zero, nan , value , median , mean , min , max + // The following list shows the parameters and their valid values for a Related + // Time Series featurization method (there are no defaults): + // - middlefill : zero , value , median , mean , min , max + // - backfill : zero , value , median , mean , min , max + // - futurefill : zero , value , median , mean , min , max + // To set a filling method to a specific value, set the fill parameter to value + // and define the value in a corresponding _value parameter. For example, to set + // backfilling to a value of 2, include the following: "backfill": "value" and + // "backfill_value":"2" . // // This member is required. Transformations map[string]string @@ -285,10 +178,9 @@ type AttributeConfig struct { // when you interpret monitoring results for an auto predictor. type Baseline struct { - // The initial accuracy metrics - // (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) for the predictor - // you are monitoring. Use these metrics as a baseline for comparison purposes as - // you use your predictor and the metrics change. + // The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) + // for the predictor you are monitoring. Use these metrics as a baseline for + // comparison purposes as you use your predictor and the metrics change. PredictorBaseline *PredictorBaseline noSmithyDocumentSerde @@ -353,9 +245,8 @@ type ContinuousParameterRange struct { // hyperparameter range by using a reverse logarithmic scale. Reverse logarithmic // scaling works only for ranges that are entirely within the range 0 <= x < 1.0. // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: + // Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type) + // . One of the following values: ScalingType ScalingType noSmithyDocumentSerde @@ -392,11 +283,9 @@ type DataDestination struct { noSmithyDocumentSerde } -// Provides a summary of the dataset group properties used in the ListDatasetGroups -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) -// operation. To get the complete set of properties, call the DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) -// operation, and provide the DatasetGroupArn. +// Provides a summary of the dataset group properties used in the ListDatasetGroups (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) +// operation. To get the complete set of properties, call the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// operation, and provide the DatasetGroupArn . type DatasetGroupSummary struct { // When the dataset group was created. @@ -409,22 +298,19 @@ type DatasetGroupSummary struct { DatasetGroupName *string // When the dataset group was created or last updated from a call to the - // UpdateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. While the dataset group is being updated, LastModificationTime is the - // current time of the ListDatasetGroups call. + // UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // operation. While the dataset group is being updated, LastModificationTime is + // the current time of the ListDatasetGroups call. LastModificationTime *time.Time noSmithyDocumentSerde } // Provides a summary of the dataset import job properties used in the -// ListDatasetImportJobs -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) +// ListDatasetImportJobs (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) // operation. To get the complete set of properties, call the -// DescribeDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) -// operation, and provide the DatasetImportJobArn. +// DescribeDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) +// operation, and provide the DatasetImportJobArn . type DatasetImportJobSummary struct { // When the dataset import job was created. @@ -447,45 +333,29 @@ type DatasetImportJobSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the dataset import job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, - // DELETE_IN_PROGRESS, DELETE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED Status *string noSmithyDocumentSerde } -// Provides a summary of the dataset properties used in the ListDatasets -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) -// operation. To get the complete set of properties, call the DescribeDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) -// operation, and provide the DatasetArn. +// Provides a summary of the dataset properties used in the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) +// operation. To get the complete set of properties, call the DescribeDataset (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) +// operation, and provide the DatasetArn . type DatasetSummary struct { // When the dataset was created. @@ -503,12 +373,11 @@ type DatasetSummary struct { // The domain associated with the dataset. Domain Domain - // When you create a dataset, LastModificationTime is the same as CreationTime. - // While data is being imported to the dataset, LastModificationTime is the current - // time of the ListDatasets call. After a CreateDatasetImportJob - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) - // operation has finished, LastModificationTime is when the import job completed or - // failed. + // When you create a dataset, LastModificationTime is the same as CreationTime . + // While data is being imported to the dataset, LastModificationTime is the + // current time of the ListDatasets call. After a CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // operation has finished, LastModificationTime is when the import job completed + // or failed. LastModificationTime *time.Time noSmithyDocumentSerde @@ -548,8 +417,8 @@ type EncryptionConfig struct { noSmithyDocumentSerde } -// Provides detailed error metrics to evaluate the performance of a predictor. This -// object is part of the Metrics object. +// Provides detailed error metrics to evaluate the performance of a predictor. +// This object is part of the Metrics object. type ErrorMetric struct { // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. @@ -576,13 +445,13 @@ type ErrorMetric struct { // request. type EvaluationParameters struct { - // The point from the end of the dataset where you want to split the data for model - // training and testing (evaluation). Specify the value as the number of data + // The point from the end of the dataset where you want to split the data for + // model training and testing (evaluation). Specify the value as the number of data // points. The default is the value of the forecast horizon. BackTestWindowOffset // can be used to mimic a past virtual forecast start date. This value must be // greater than or equal to the forecast horizon and less than half of the - // TARGET_TIME_SERIES dataset length. ForecastHorizon <= BackTestWindowOffset < 1/2 - // * TARGET_TIME_SERIES dataset length + // TARGET_TIME_SERIES dataset length. ForecastHorizon <= BackTestWindowOffset < + // 1/2 * TARGET_TIME_SERIES dataset length BackTestWindowOffset *int32 // The number of times to split the input data. The default is 1. Valid values are @@ -608,26 +477,26 @@ type EvaluationResult struct { } // The ExplainabilityConfig data type defines the number of time series and time -// points included in CreateExplainability. If you provide a predictor ARN for -// ResourceArn, you must set both TimePointGranularity and TimeSeriesGranularity to -// “ALL”. When creating Predictor Explainability, Amazon Forecast considers all -// time series and time points. If you provide a forecast ARN for ResourceArn, you +// points included in CreateExplainability . If you provide a predictor ARN for +// ResourceArn , you must set both TimePointGranularity and TimeSeriesGranularity +// to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all +// time series and time points. If you provide a forecast ARN for ResourceArn , you // can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or // “Specific”. type ExplainabilityConfig struct { // To create an Explainability for all time points in your forecast horizon, use - // ALL. To create an Explainability for specific time points in your forecast - // horizon, use SPECIFIC. Specify time points with the StartDateTime and + // ALL . To create an Explainability for specific time points in your forecast + // horizon, use SPECIFIC . Specify time points with the StartDateTime and // EndDateTime parameters within the CreateExplainability operation. // // This member is required. TimePointGranularity TimePointGranularity - // To create an Explainability for all time series in your datasets, use ALL. To - // create an Explainability for specific time series in your datasets, use - // SPECIFIC. Specify time series by uploading a CSV or Parquet file to an Amazon S3 - // bucket and set the location within the DataDestination data type. + // To create an Explainability for all time series in your datasets, use ALL . To + // create an Explainability for specific time series in your datasets, use SPECIFIC + // . Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket + // and set the location within the DataDestination data type. // // This member is required. TimeSeriesGranularity TimeSeriesGranularity @@ -638,7 +507,7 @@ type ExplainabilityConfig struct { // Provides a summary of the Explainability export properties used in the // ListExplainabilityExports operation. To get a complete set of properties, call // the DescribeExplainabilityExport operation, and provide the -// ExplainabilityExportArn. +// ExplainabilityExportArn . type ExplainabilityExportSummary struct { // When the Explainability was created. @@ -657,19 +526,11 @@ type ExplainabilityExportSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // Information about any errors that may have occurred during the Explainability @@ -677,16 +538,10 @@ type ExplainabilityExportSummary struct { Message *string // The status of the Explainability export. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde @@ -699,16 +554,10 @@ type ExplainabilityInfo struct { ExplainabilityArn *string // The status of the Explainability. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde @@ -716,7 +565,7 @@ type ExplainabilityInfo struct { // Provides a summary of the Explainability properties used in the // ListExplainabilities operation. To get a complete set of properties, call the -// DescribeExplainability operation, and provide the listed ExplainabilityArn. +// DescribeExplainability operation, and provide the listed ExplainabilityArn . type ExplainabilitySummary struct { // When the Explainability was created. @@ -734,19 +583,11 @@ type ExplainabilitySummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // Information about any errors that may have occurred during the Explainability @@ -758,44 +599,38 @@ type ExplainabilitySummary struct { ResourceArn *string // The status of the Explainability. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde } // This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AttributeConfig. Provides featurization -// (transformation) information for a dataset field. This object is part of the +// predictor with CreateAutoPredictor , see AttributeConfig . Provides +// featurization (transformation) information for a dataset field. This object is // -// FeaturizationConfig object. For example: { +// part of the FeaturizationConfig object. For example: { // "AttributeName": "demand", // -// FeaturizationPipeline [ { +// FeaturizationPipeline [ { // -// "FeaturizationMethodName": "filling", +// "FeaturizationMethodName": "filling", // -// "FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"} +// "FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"} // -// } ] +// } ] // -// } +// } type Featurization struct { - // The name of the schema attribute that specifies the data field to be featurized. - // Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the - // RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is - // demand, and for the CUSTOM domain, the target is target_value. For more - // information, see howitworks-missing-values. + // The name of the schema attribute that specifies the data field to be + // featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES + // and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the + // target is demand , and for the CUSTOM domain, the target is target_value . For + // more information, see howitworks-missing-values . // // This member is required. AttributeName *string @@ -808,7 +643,7 @@ type Featurization struct { } // This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AttributeConfig. In a CreatePredictor +// predictor with CreateAutoPredictor , see AttributeConfig . In a CreatePredictor // operation, the specified algorithm trains a model using the specified dataset // group. You can optionally tell the operation to modify data fields prior to // training a model. These modifications are referred to as featurization. You @@ -828,25 +663,17 @@ type FeaturizationConfig struct { // That means, for example, you cannot specify a frequency of 60 minutes, because // that is equivalent to 1 hour. The valid values for each frequency are the // following: - // - // * Minute - 1-59 - // - // * Hour - 1-23 - // - // * Day - 1-6 - // - // * Week - 1-4 - // - // * Month - - // 1-11 - // - // * Year - 1 - // - // Thus, if you want every other week forecasts, specify "2W". - // Or, if you want quarterly forecasts, you specify "3M". The frequency must be - // greater than or equal to the TARGET_TIME_SERIES dataset frequency. When a - // RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the - // TARGET_TIME_SERIES dataset frequency. + // - Minute - 1-59 + // - Hour - 1-23 + // - Day - 1-6 + // - Week - 1-4 + // - Month - 1-11 + // - Year - 1 + // Thus, if you want every other week forecasts, specify "2W". Or, if you want + // quarterly forecasts, you specify "3M". The frequency must be greater than or + // equal to the TARGET_TIME_SERIES dataset frequency. When a RELATED_TIME_SERIES + // dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES + // dataset frequency. // // This member is required. ForecastFrequency *string @@ -861,8 +688,8 @@ type FeaturizationConfig struct { // want the sales forecast for each item by store, you would specify store_id as // the dimension. All forecast dimensions specified in the TARGET_TIME_SERIES // dataset don't need to be specified in the CreatePredictor request. All forecast - // dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the - // CreatePredictor request. + // dimensions specified in the RELATED_TIME_SERIES dataset must be specified in + // the CreatePredictor request. ForecastDimensions []string noSmithyDocumentSerde @@ -875,10 +702,10 @@ type FeaturizationConfig struct { // object. { // "FeaturizationMethodName": "filling", // -// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", -// "backfill": "zero"} +// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", +// "backfill": "zero"} // -// } +// } type FeaturizationMethod struct { // The name of the method. The "filling" method is the only supported method. @@ -886,52 +713,37 @@ type FeaturizationMethod struct { // This member is required. FeaturizationMethodName FeaturizationMethodName - // The method parameters (key-value pairs), which are a map of override parameters. - // Specify these parameters to override the default values. Related Time Series - // attributes do not accept aggregation parameters. The following list shows the - // parameters and their valid values for the "filling" featurization method for a - // Target Time Series dataset. Bold signifies the default value. - // - // * aggregation: - // sum, avg, first, min, max - // - // * frontfill: none - // - // * middlefill: zero, nan (not a - // number), value, median, mean, min, max - // - // * backfill: zero, nan, value, median, - // mean, min, max - // - // The following list shows the parameters and their valid values - // for a Related Time Series featurization method (there are no defaults): - // - // * - // middlefill: zero, value, median, mean, min, max - // - // * backfill: zero, value, - // median, mean, min, max - // - // * futurefill: zero, value, median, mean, min, max - // - // To - // set a filling method to a specific value, set the fill parameter to value and - // define the value in a corresponding _value parameter. For example, to set + // The method parameters (key-value pairs), which are a map of override + // parameters. Specify these parameters to override the default values. Related + // Time Series attributes do not accept aggregation parameters. The following list + // shows the parameters and their valid values for the "filling" featurization + // method for a Target Time Series dataset. Bold signifies the default value. + // - aggregation : sum, avg , first , min , max + // - frontfill : none + // - middlefill : zero, nan (not a number), value , median , mean , min , max + // - backfill : zero, nan , value , median , mean , min , max + // The following list shows the parameters and their valid values for a Related + // Time Series featurization method (there are no defaults): + // - middlefill : zero , value , median , mean , min , max + // - backfill : zero , value , median , mean , min , max + // - futurefill : zero , value , median , mean , min , max + // To set a filling method to a specific value, set the fill parameter to value + // and define the value in a corresponding _value parameter. For example, to set // backfilling to a value of 2, include the following: "backfill": "value" and - // "backfill_value":"2". + // "backfill_value":"2" . FeaturizationMethodParameters map[string]string noSmithyDocumentSerde } // Describes a filter for choosing a subset of objects. Each filter consists of a -// condition and a match statement. The condition is either IS or IS_NOT, which +// condition and a match statement. The condition is either IS or IS_NOT , which // specifies whether to include or exclude the objects that match the statement, // respectively. The match statement consists of a key and a value. type Filter struct { - // The condition to apply. To include the objects that match the statement, specify - // IS. To exclude matching objects, specify IS_NOT. + // The condition to apply. To include the objects that match the statement, + // specify IS . To exclude matching objects, specify IS_NOT . // // This member is required. Condition FilterConditionString @@ -952,7 +764,7 @@ type Filter struct { // Provides a summary of the forecast export job properties used in the // ListForecastExportJobs operation. To get the complete set of properties, call // the DescribeForecastExportJob operation, and provide the listed -// ForecastExportJobArn. +// ForecastExportJobArn . type ForecastExportJobSummary struct { // When the forecast export job was created. @@ -970,39 +782,23 @@ type ForecastExportJobSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the forecast export job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status - // of the forecast export job must be ACTIVE before you can access the forecast in - // your S3 bucket. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the forecast export job must be ACTIVE before you can access the + // forecast in your S3 bucket. Status *string noSmithyDocumentSerde @@ -1031,19 +827,11 @@ type ForecastSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. @@ -1053,19 +841,12 @@ type ForecastSummary struct { PredictorArn *string // The status of the forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the forecast - // must be ACTIVE before you can query or export the forecast. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the forecast must be ACTIVE before you can query or export the + // forecast. Status *string noSmithyDocumentSerde @@ -1090,7 +871,7 @@ type HyperParameterTuningJobConfig struct { } // This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see DataConfig. The data used to train a +// predictor with CreateAutoPredictor , see DataConfig . The data used to train a // predictor. The data includes a dataset group and any supplementary features. You // specify this object in the CreatePredictor request. type InputDataConfig struct { @@ -1132,12 +913,11 @@ type IntegerParameterRange struct { // hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning // searches the values in the hyperparameter range by using a logarithmic scale. // Logarithmic scaling works only for ranges that have values greater than 0. - // ReverseLogarithmic Not supported for IntegerParameterRange. Reverse logarithmic + // ReverseLogarithmic Not supported for IntegerParameterRange . Reverse logarithmic // scaling works only for ranges that are entirely within the range 0 <= x < 1.0. // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: + // Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type) + // . One of the following values: ScalingType ScalingType noSmithyDocumentSerde @@ -1146,8 +926,7 @@ type IntegerParameterRange struct { // An individual metric Forecast calculated when monitoring predictor usage. You // can compare the value for this metric to the metric's value in the Baseline to // see how your predictor's performance is changing. For more information about -// metrics generated by Forecast see Evaluating Predictor Accuracy -// (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) +// metrics generated by Forecast see Evaluating Predictor Accuracy (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) type MetricResult struct { // The name of the metric. @@ -1199,8 +978,8 @@ type MonitorConfig struct { // The source of the data the monitor used during the evaluation. type MonitorDataSource struct { - // The Amazon Resource Name (ARN) of the dataset import job used to import the data - // that initiated the monitor evaluation. + // The Amazon Resource Name (ARN) of the dataset import job used to import the + // data that initiated the monitor evaluation. DatasetImportJobArn *string // The Amazon Resource Name (ARN) of the forecast the monitor used during the @@ -1220,26 +999,19 @@ type MonitorInfo struct { MonitorArn *string // The status of the monitor. States include: - // - // * ACTIVE - // - // * ACTIVE_STOPPING, - // ACTIVE_STOPPED - // - // * UPDATE_IN_PROGRESS - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, - // CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - ACTIVE_STOPPING , ACTIVE_STOPPED + // - UPDATE_IN_PROGRESS + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde } -// Provides a summary of the monitor properties used in the ListMonitors operation. -// To get a complete set of properties, call the DescribeMonitor operation, and -// provide the listed MonitorArn. +// Provides a summary of the monitor properties used in the ListMonitors +// operation. To get a complete set of properties, call the DescribeMonitor +// operation, and provide the listed MonitorArn . type MonitorSummary struct { // When the monitor resource was created. @@ -1247,16 +1019,10 @@ type MonitorSummary struct { // The last time the monitor resource was modified. The timestamp depends on the // status of the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - - // The current timestamp. - // - // * STOPPED - When the resource stopped. - // - // * ACTIVE or - // CREATE_FAILED - When the monitor creation finished or failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - STOPPED - When the resource stopped. + // - ACTIVE or CREATE_FAILED - When the monitor creation finished or failed. LastModificationTime *time.Time // The Amazon Resource Name (ARN) of the monitor resource. @@ -1269,18 +1035,11 @@ type MonitorSummary struct { ResourceArn *string // The status of the monitor. States include: - // - // * ACTIVE - // - // * ACTIVE_STOPPING, - // ACTIVE_STOPPED - // - // * UPDATE_IN_PROGRESS - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, - // CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - ACTIVE_STOPPING , ACTIVE_STOPPED + // - UPDATE_IN_PROGRESS + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde @@ -1307,7 +1066,7 @@ type ParameterRanges struct { // Provides a summary of the predictor backtest export job properties used in the // ListPredictorBacktestExportJobs operation. To get a complete set of properties, // call the DescribePredictorBacktestExportJob operation, and provide the listed -// PredictorBacktestExportJobArn. +// PredictorBacktestExportJobArn . type PredictorBacktestExportJobSummary struct { // When the predictor backtest export job was created. @@ -1320,19 +1079,11 @@ type PredictorBacktestExportJobSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // Information about any errors that may have occurred during the backtest export. @@ -1345,16 +1096,10 @@ type PredictorBacktestExportJobSummary struct { PredictorBacktestExportJobName *string // The status of the predictor backtest export job. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED Status *string noSmithyDocumentSerde @@ -1364,10 +1109,9 @@ type PredictorBacktestExportJobSummary struct { // when you interpret monitoring results for an auto predictor. type PredictorBaseline struct { - // The initial accuracy metrics - // (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) for the predictor. - // Use these metrics as a baseline for comparison purposes as you use your - // predictor and the metrics change. + // The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) + // for the predictor. Use these metrics as a baseline for comparison purposes as + // you use your predictor and the metrics change. BaselineMetrics []BaselineMetric noSmithyDocumentSerde @@ -1379,7 +1123,7 @@ type PredictorEvent struct { // The timestamp for when the event occurred. Datetime *time.Time - // The type of event. For example, Retrain. A retraining event denotes the + // The type of event. For example, Retrain . A retraining event denotes the // timepoint when a predictor was retrained. Any monitor results from before the // Datetime are from the previous predictor. Any new metrics are for the newly // retrained predictor. @@ -1419,7 +1163,7 @@ type PredictorExecutionDetails struct { // Describes the results of a monitor evaluation. type PredictorMonitorEvaluation struct { - // The status of the monitor evaluation. The state can be SUCCESS or FAILURE. + // The status of the monitor evaluation. The state can be SUCCESS or FAILURE . EvaluationState *string // The timestamp that indicates when the monitor evaluation was started. @@ -1462,7 +1206,7 @@ type PredictorMonitorEvaluation struct { // Provides a summary of the predictor properties that are used in the // ListPredictors operation. To get the complete set of properties, call the -// DescribePredictor operation, and provide the listed PredictorArn. +// DescribePredictor operation, and provide the listed PredictorArn . type PredictorSummary struct { // When the model training task was created. @@ -1477,19 +1221,11 @@ type PredictorSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. @@ -1506,19 +1242,12 @@ type PredictorSummary struct { ReferencePredictorSummary *ReferencePredictorSummary // The status of the predictor. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, - // DELETE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // The Status of the predictor - // must be ACTIVE before you can use the predictor to create a forecast. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // The Status of the predictor must be ACTIVE before you can use the predictor to + // create a forecast. Status *string noSmithyDocumentSerde @@ -1531,7 +1260,7 @@ type ReferencePredictorSummary struct { // The ARN of the reference predictor. Arn *string - // Whether the reference predictor is Active or Deleted. + // Whether the reference predictor is Active or Deleted . State State noSmithyDocumentSerde @@ -1544,8 +1273,8 @@ type ReferencePredictorSummary struct { // CreateDatasetImportJob request, and part of the DataDestination object. type S3Config struct { - // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an - // Amazon S3 bucket. + // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in + // an Amazon S3 bucket. // // This member is required. Path *string @@ -1575,9 +1304,8 @@ type Schema struct { } // An attribute of a schema, which defines a dataset field. A schema attribute is -// required for every field in a dataset. The Schema -// (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) object contains -// an array of SchemaAttribute objects. +// required for every field in a dataset. The Schema (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) +// object contains an array of SchemaAttribute objects. type SchemaAttribute struct { // The name of the dataset field. @@ -1592,8 +1320,7 @@ type SchemaAttribute struct { } // Provides statistics for each data field imported into to an Amazon Forecast -// dataset with the CreateDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) +// dataset with the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) // operation. type Statistics struct { @@ -1601,15 +1328,15 @@ type Statistics struct { Avg *float64 // The number of values in the field. If the response value is -1, refer to - // CountLong. + // CountLong . Count *int32 // The number of distinct values in the field. If the response value is -1, refer - // to CountDistinctLong. + // to CountDistinctLong . CountDistinct *int32 - // The number of distinct values in the field. CountDistinctLong is used instead of - // CountDistinct if the value is greater than 2,147,483,647. + // The number of distinct values in the field. CountDistinctLong is used instead + // of CountDistinct if the value is greater than 2,147,483,647. CountDistinctLong *int64 // The number of values in the field. CountLong is used instead of Count if the @@ -1617,7 +1344,7 @@ type Statistics struct { CountLong *int64 // The number of NAN (not a number) values in the field. If the response value is - // -1, refer to CountNanLong. + // -1, refer to CountNanLong . CountNan *int32 // The number of NAN (not a number) values in the field. CountNanLong is used @@ -1625,7 +1352,7 @@ type Statistics struct { CountNanLong *int64 // The number of null values in the field. If the response value is -1, refer to - // CountNullLong. + // CountNullLong . CountNull *int32 // The number of null values in the field. CountNullLong is used instead of @@ -1645,24 +1372,23 @@ type Statistics struct { } // This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AdditionalDataset. Describes a +// predictor with CreateAutoPredictor , see AdditionalDataset . Describes a // supplementary feature of a dataset group. This object is part of the // InputDataConfig object. Forecast supports the Weather Index and Holidays // built-in featurizations. Weather Index The Amazon Forecast Weather Index is a // built-in featurization that incorporates historical and projected weather // information into your model. The Weather Index supplements your datasets with // over two years of historical weather data and up to 14 days of projected weather -// data. For more information, see Amazon Forecast Weather Index -// (https://docs.aws.amazon.com/forecast/latest/dg/weather.html). Holidays Holidays -// is a built-in featurization that incorporates a feature-engineered dataset of -// national holiday information into your model. It provides native support for the -// holiday calendars of 66 countries. To view the holiday calendars, refer to the -// Jollyday (http://jollyday.sourceforge.net/data.html) library. For more -// information, see Holidays Featurization -// (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html). +// data. For more information, see Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html) +// . Holidays Holidays is a built-in featurization that incorporates a +// feature-engineered dataset of national holiday information into your model. It +// provides native support for the holiday calendars of 66 countries. To view the +// holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html) +// library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html) +// . type SupplementaryFeature struct { - // The name of the feature. Valid values: "holiday" and "weather". + // The name of the feature. Valid values: "holiday" and "weather" . // // This member is required. Name *string @@ -1670,154 +1396,72 @@ type SupplementaryFeature struct { // Weather Index To enable the Weather Index, set the value to "true" Holidays To // enable Holidays, specify a country with one of the following two-letter country // codes: - // - // * "AL" - ALBANIA - // - // * "AR" - ARGENTINA - // - // * "AT" - AUSTRIA - // - // * "AU" - - // AUSTRALIA - // - // * "BA" - BOSNIA HERZEGOVINA - // - // * "BE" - BELGIUM - // - // * "BG" - BULGARIA - // - // * - // "BO" - BOLIVIA - // - // * "BR" - BRAZIL - // - // * "BY" - BELARUS - // - // * "CA" - CANADA - // - // * "CL" - - // CHILE - // - // * "CO" - COLOMBIA - // - // * "CR" - COSTA RICA - // - // * "HR" - CROATIA - // - // * "CZ" - CZECH - // REPUBLIC - // - // * "DK" - DENMARK - // - // * "EC" - ECUADOR - // - // * "EE" - ESTONIA - // - // * "ET" - - // ETHIOPIA - // - // * "FI" - FINLAND - // - // * "FR" - FRANCE - // - // * "DE" - GERMANY - // - // * "GR" - - // GREECE - // - // * "HU" - HUNGARY - // - // * "IS" - ICELAND - // - // * "IN" - INDIA - // - // * "IE" - IRELAND - // - // * - // "IT" - ITALY - // - // * "JP" - JAPAN - // - // * "KZ" - KAZAKHSTAN - // - // * "KR" - KOREA - // - // * "LV" - - // LATVIA - // - // * "LI" - LIECHTENSTEIN - // - // * "LT" - LITHUANIA - // - // * "LU" - LUXEMBOURG - // - // * "MK" - // - MACEDONIA - // - // * "MT" - MALTA - // - // * "MX" - MEXICO - // - // * "MD" - MOLDOVA - // - // * "ME" - - // MONTENEGRO - // - // * "NL" - NETHERLANDS - // - // * "NZ" - NEW ZEALAND - // - // * "NI" - NICARAGUA - // - // * - // "NG" - NIGERIA - // - // * "NO" - NORWAY - // - // * "PA" - PANAMA - // - // * "PY" - PARAGUAY - // - // * "PE" - - // PERU - // - // * "PL" - POLAND - // - // * "PT" - PORTUGAL - // - // * "RO" - ROMANIA - // - // * "RU" - RUSSIA - // - // * - // "RS" - SERBIA - // - // * "SK" - SLOVAKIA - // - // * "SI" - SLOVENIA - // - // * "ZA" - SOUTH AFRICA - // - // * - // "ES" - SPAIN - // - // * "SE" - SWEDEN - // - // * "CH" - SWITZERLAND - // - // * "UA" - UKRAINE - // - // * "AE" - - // UNITED ARAB EMIRATES - // - // * "US" - UNITED STATES - // - // * "UK" - UNITED KINGDOM - // - // * "UY" - - // URUGUAY - // - // * "VE" - VENEZUELA + // - "AL" - ALBANIA + // - "AR" - ARGENTINA + // - "AT" - AUSTRIA + // - "AU" - AUSTRALIA + // - "BA" - BOSNIA HERZEGOVINA + // - "BE" - BELGIUM + // - "BG" - BULGARIA + // - "BO" - BOLIVIA + // - "BR" - BRAZIL + // - "BY" - BELARUS + // - "CA" - CANADA + // - "CL" - CHILE + // - "CO" - COLOMBIA + // - "CR" - COSTA RICA + // - "HR" - CROATIA + // - "CZ" - CZECH REPUBLIC + // - "DK" - DENMARK + // - "EC" - ECUADOR + // - "EE" - ESTONIA + // - "ET" - ETHIOPIA + // - "FI" - FINLAND + // - "FR" - FRANCE + // - "DE" - GERMANY + // - "GR" - GREECE + // - "HU" - HUNGARY + // - "IS" - ICELAND + // - "IN" - INDIA + // - "IE" - IRELAND + // - "IT" - ITALY + // - "JP" - JAPAN + // - "KZ" - KAZAKHSTAN + // - "KR" - KOREA + // - "LV" - LATVIA + // - "LI" - LIECHTENSTEIN + // - "LT" - LITHUANIA + // - "LU" - LUXEMBOURG + // - "MK" - MACEDONIA + // - "MT" - MALTA + // - "MX" - MEXICO + // - "MD" - MOLDOVA + // - "ME" - MONTENEGRO + // - "NL" - NETHERLANDS + // - "NZ" - NEW ZEALAND + // - "NI" - NICARAGUA + // - "NG" - NIGERIA + // - "NO" - NORWAY + // - "PA" - PANAMA + // - "PY" - PARAGUAY + // - "PE" - PERU + // - "PL" - POLAND + // - "PT" - PORTUGAL + // - "RO" - ROMANIA + // - "RU" - RUSSIA + // - "RS" - SERBIA + // - "SK" - SLOVAKIA + // - "SI" - SLOVENIA + // - "ZA" - SOUTH AFRICA + // - "ES" - SPAIN + // - "SE" - SWEDEN + // - "CH" - SWITZERLAND + // - "UA" - UKRAINE + // - "AE" - UNITED ARAB EMIRATES + // - "US" - UNITED STATES + // - "UK" - UNITED KINGDOM + // - "UY" - URUGUAY + // - "VE" - VENEZUELA // // This member is required. Value *string @@ -1828,33 +1472,22 @@ type SupplementaryFeature struct { // The optional metadata that you apply to a resource to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which // you define. The following basic restrictions apply to tags: -// -// * Maximum number of -// tags per resource - 50. -// -// * For each resource, each tag key must be unique, and -// each tag key can have only one value. -// -// * Maximum key length - 128 Unicode -// characters in UTF-8. -// -// * Maximum value length - 256 Unicode characters in -// UTF-8. -// -// * If your tagging schema is used across multiple services and resources, -// remember that other services may have restrictions on allowed characters. -// Generally allowed characters are: letters, numbers, and spaces representable in -// UTF-8, and the following characters: + - = . _ : / @. -// -// * Tag keys and values are -// case sensitive. -// -// * Do not use aws:, AWS:, or any upper or lowercase combination -// of such as a prefix for keys as it is reserved for Amazon Web Services use. You -// cannot edit or delete tag keys with this prefix. Values can have this prefix. If -// a tag value has aws as its prefix but the key does not, then Forecast considers -// it to be a user tag and will count against the limit of 50 tags. Tags with only -// the key prefix of aws do not count against your tags per resource limit. +// - Maximum number of tags per resource - 50. +// - For each resource, each tag key must be unique, and each tag key can have +// only one value. +// - Maximum key length - 128 Unicode characters in UTF-8. +// - Maximum value length - 256 Unicode characters in UTF-8. +// - If your tagging schema is used across multiple services and resources, +// remember that other services may have restrictions on allowed characters. +// Generally allowed characters are: letters, numbers, and spaces representable in +// UTF-8, and the following characters: + - = . _ : / @. +// - Tag keys and values are case sensitive. +// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a +// prefix for keys as it is reserved for Amazon Web Services use. You cannot edit +// or delete tag keys with this prefix. Values can have this prefix. If a tag value +// has aws as its prefix but the key does not, then Forecast considers it to be a +// user tag and will count against the limit of 50 tags. Tags with only the key +// prefix of aws do not count against your tags per resource limit. type Tag struct { // One part of a key-value pair that makes up a tag. A key is a general label that @@ -1880,13 +1513,9 @@ type TestWindowSummary struct { Message *string // The status of the test. Possible status values are: - // - // * ACTIVE - // - // * - // CREATE_IN_PROGRESS - // - // * CREATE_FAILED + // - ACTIVE + // - CREATE_IN_PROGRESS + // - CREATE_FAILED Status *string // The time at which the test ended. @@ -1900,21 +1529,20 @@ type TestWindowSummary struct { // The time boundary Forecast uses to align and aggregate your data to match your // forecast frequency. Provide the unit of time and the time boundary as a key -// value pair. If you don't provide a time boundary, Forecast uses a set of Default -// Time Boundaries -// (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). -// For more information about aggregation, see Data Aggregation for Different -// Forecast Frequencies -// (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). For more -// information setting a custom time boundary, see Specifying a Time Boundary -// (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). +// value pair. If you don't provide a time boundary, Forecast uses a set of +// Default Time Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries) +// . For more information about aggregation, see Data Aggregation for Different +// Forecast Frequencies (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html) +// . For more information setting a custom time boundary, see Specifying a Time +// Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary) +// . type TimeAlignmentBoundary struct { // The day of the month to use for time alignment during aggregation. DayOfMonth *int32 - // The day of week to use for time alignment during aggregation. The day must be in - // uppercase. + // The day of week to use for time alignment during aggregation. The day must be + // in uppercase. DayOfWeek DayOfWeek // The hour of day to use for time alignment during aggregation. @@ -1929,8 +1557,8 @@ type TimeAlignmentBoundary struct { // Creates a subset of items within an attribute that are modified. For example, // you can use this operation to create a subset of items that cost $5 or less. To -// do this, you specify "AttributeName": "price", "AttributeValue": "5", and -// "Condition": "LESS_THAN". Pair this operation with the Action operation within +// do this, you specify "AttributeName": "price" , "AttributeValue": "5" , and +// "Condition": "LESS_THAN" . Pair this operation with the Action operation within // the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define // how the attribute is modified. type TimeSeriesCondition struct { @@ -1940,13 +1568,13 @@ type TimeSeriesCondition struct { // This member is required. AttributeName *string - // The value that is applied for the chosen Condition. + // The value that is applied for the chosen Condition . // // This member is required. AttributeValue *string - // The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and - // GREATER_THAN. + // The condition to apply. Valid values are EQUALS , NOT_EQUALS , LESS_THAN and + // GREATER_THAN . // // This member is required. Condition Condition @@ -2006,12 +1634,9 @@ type TimeSeriesReplacementsDataSource struct { // Defines the set of time series that are used to create the forecasts in a // TimeSeriesIdentifiers object. The TimeSeriesIdentifiers object needs the // following information: -// -// * DataSource -// -// * Format -// -// * Schema +// - DataSource +// - Format +// - Schema type TimeSeriesSelector struct { // Details about the import file that contains the time series for which you want @@ -2071,38 +1696,23 @@ type WhatIfAnalysisSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if analysis. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the what-if - // analysis must be ACTIVE before you can access the analysis. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. Status *string // The Amazon Resource Name (ARN) of the what-if analysis. @@ -2129,38 +1739,23 @@ type WhatIfForecastExportSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if forecast export. States include: - // - // * ACTIVE - // - // * - // CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, - // CREATE_STOPPED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status - // of the what-if analysis must be ACTIVE before you can access the analysis. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. Status *string // An array of Amazon Resource Names (ARNs) that define the what-if forecasts @@ -2187,38 +1782,23 @@ type WhatIfForecastSummary struct { // The last time the resource was modified. The timestamp depends on the status of // the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The - // current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - // - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or - // failed. + // - CREATE_PENDING - The CreationTime . + // - CREATE_IN_PROGRESS - The current timestamp. + // - CREATE_STOPPING - The current timestamp. + // - CREATE_STOPPED - When the job stopped. + // - ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time // If an error occurred, an informational message about the error. Message *string // The status of the what-if forecast. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, - // CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // * - // DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // The Status of the what-if - // analysis must be ACTIVE before you can access the analysis. + // - ACTIVE + // - CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED + // - CREATE_STOPPING , CREATE_STOPPED + // - DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. Status *string // The Amazon Resource Name (ARN) of the what-if analysis that contains this @@ -2236,16 +1816,13 @@ type WhatIfForecastSummary struct { // The metrics for a time range within the evaluation portion of a dataset. This // object is part of the EvaluationResult object. The TestWindowStart and -// TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of -// the EvaluationParameters object. +// TestWindowEnd parameters are determined by the BackTestWindowOffset parameter +// of the EvaluationParameters object. type WindowSummary struct { // The type of evaluation. - // - // * SUMMARY - The average metrics across all windows. - // - // * - // COMPUTED - The metrics for the specified window. + // - SUMMARY - The average metrics across all windows. + // - COMPUTED - The metrics for the specified window. EvaluationType EvaluationType // The number of data points within the window. diff --git a/service/forecastquery/api_client.go b/service/forecastquery/api_client.go index ca00cfbdcb4..6c1906eaf12 100644 --- a/service/forecastquery/api_client.go +++ b/service/forecastquery/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "forecastquery" const ServiceAPIVersion = "2018-06-26" -// Client provides the API client to make operations call for Amazon Forecast Query -// Service. +// Client provides the API client to make operations call for Amazon Forecast +// Query Service. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/forecastquery/api_op_QueryForecast.go b/service/forecastquery/api_op_QueryForecast.go index 097297c488e..86229ebd5e5 100644 --- a/service/forecastquery/api_op_QueryForecast.go +++ b/service/forecastquery/api_op_QueryForecast.go @@ -17,8 +17,7 @@ import ( // the forecast dimensions specified as part of the FeaturizationConfig object. By // default, QueryForecast returns the complete date range for the filtered // forecast. You can request a specific date range. To get the full forecast, use -// the CreateForecastExportJob -// (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) +// the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) // operation. The forecasts generated by Amazon Forecast are in the same timezone // as the dataset that was used to create the predictor. func (c *Client) QueryForecast(ctx context.Context, params *QueryForecastInput, optFns ...func(*Options)) (*QueryForecastOutput, error) { @@ -41,8 +40,7 @@ type QueryForecastInput struct { // The filtering criteria to apply when retrieving the forecast. For example, to // get the forecast for client_21 in the electricity usage dataset, specify the // following: {"item_id" : "client_21"} To get the full forecast, use the - // CreateForecastExportJob - // (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) + // CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html) // operation. // // This member is required. @@ -58,7 +56,7 @@ type QueryForecastInput struct { EndDate *string // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecastquery/api_op_QueryWhatIfForecast.go b/service/forecastquery/api_op_QueryWhatIfForecast.go index 6289549c42e..9f84c665c54 100644 --- a/service/forecastquery/api_op_QueryWhatIfForecast.go +++ b/service/forecastquery/api_op_QueryWhatIfForecast.go @@ -32,8 +32,7 @@ type QueryWhatIfForecastInput struct { // The filtering criteria to apply when retrieving the forecast. For example, to // get the forecast for client_21 in the electricity usage dataset, specify the // following: {"item_id" : "client_21"} To get the full what-if forecast, use the - // CreateForecastExportJob - // (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) + // CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) // operation. // // This member is required. @@ -49,7 +48,7 @@ type QueryWhatIfForecastInput struct { EndDate *string // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/forecastquery/types/types.go b/service/forecastquery/types/types.go index f8e657655c9..56ba0ce9302 100644 --- a/service/forecastquery/types/types.go +++ b/service/forecastquery/types/types.go @@ -24,16 +24,11 @@ type Forecast struct { // The forecast. The string of the string-to-array map is one of the following // values: - // - // * p10 - // - // * p50 - // - // * p90 - // - // The default setting is ["0.1", "0.5", "0.9"]. Use - // the optional ForecastTypes parameter of the CreateForecast - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) + // - p10 + // - p50 + // - p90 + // The default setting is ["0.1", "0.5", "0.9"] . Use the optional ForecastTypes + // parameter of the CreateForecast (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) // operation to change the values. The values will vary depending on how this is // set, with a minimum of 1 and a maximum of 5. Predictions map[string][]DataPoint diff --git a/service/frauddetector/api_client.go b/service/frauddetector/api_client.go index bfee2059ee4..b7939dd958e 100644 --- a/service/frauddetector/api_client.go +++ b/service/frauddetector/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/frauddetector/api_op_CancelBatchImportJob.go b/service/frauddetector/api_op_CancelBatchImportJob.go index 5230b83e64f..4417a1a2f7b 100644 --- a/service/frauddetector/api_op_CancelBatchImportJob.go +++ b/service/frauddetector/api_op_CancelBatchImportJob.go @@ -29,7 +29,7 @@ func (c *Client) CancelBatchImportJob(ctx context.Context, params *CancelBatchIm type CancelBatchImportJobInput struct { // The ID of an in-progress batch import job to cancel. Amazon Fraud Detector will - // throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED + // throw an error if the batch import job is in FAILED , CANCELED , or COMPLETED // state. // // This member is required. diff --git a/service/frauddetector/api_op_CreateBatchImportJob.go b/service/frauddetector/api_op_CreateBatchImportJob.go index 2f865499351..e4168dd5fec 100644 --- a/service/frauddetector/api_op_CreateBatchImportJob.go +++ b/service/frauddetector/api_op_CreateBatchImportJob.go @@ -37,8 +37,7 @@ type CreateBatchImportJobInput struct { // The ARN of the IAM role created for Amazon S3 bucket that holds your data file. // The IAM role must have read permissions to your input S3 bucket and write // permissions to your output S3 bucket. For more information about bucket - // permissions, see User policy examples - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html) + // permissions, see User policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html) // in the Amazon S3 User Guide. // // This member is required. diff --git a/service/frauddetector/api_op_CreateBatchPredictionJob.go b/service/frauddetector/api_op_CreateBatchPredictionJob.go index 17a9184fb9b..1d706ca9c64 100644 --- a/service/frauddetector/api_op_CreateBatchPredictionJob.go +++ b/service/frauddetector/api_op_CreateBatchPredictionJob.go @@ -39,10 +39,9 @@ type CreateBatchPredictionJobInput struct { // This member is required. EventTypeName *string - // The ARN of the IAM role to use for this job request. The IAM Role must have read - // permissions to your input S3 bucket and write permissions to your output S3 - // bucket. For more information about bucket permissions, see User policy examples - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html) + // The ARN of the IAM role to use for this job request. The IAM Role must have + // read permissions to your input S3 bucket and write permissions to your output S3 + // bucket. For more information about bucket permissions, see User policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html) // in the Amazon S3 User Guide. // // This member is required. diff --git a/service/frauddetector/api_op_CreateDetectorVersion.go b/service/frauddetector/api_op_CreateDetectorVersion.go index b8af3ce4bfb..30859aaf73e 100644 --- a/service/frauddetector/api_op_CreateDetectorVersion.go +++ b/service/frauddetector/api_op_CreateDetectorVersion.go @@ -50,11 +50,11 @@ type CreateDetectorVersionInput struct { // The rule execution mode for the rules included in the detector version. You can // define and edit the rule mode at the detector version level, when it is in draft - // status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules + // status. If you specify FIRST_MATCHED , Amazon Fraud Detector evaluates rules // sequentially, first to last, stopping at the first matched rule. Amazon Fraud // dectector then provides the outcomes for that single rule. If you specifiy - // ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes - // for all matched rules. The default behavior is FIRST_MATCHED. + // ALL_MATCHED , Amazon Fraud Detector evaluates all rules and returns the outcomes + // for all matched rules. The default behavior is FIRST_MATCHED . RuleExecutionMode types.RuleExecutionMode // A collection of key and value pairs. diff --git a/service/frauddetector/api_op_CreateList.go b/service/frauddetector/api_op_CreateList.go index fa1031fbdfc..859bdfa9add 100644 --- a/service/frauddetector/api_op_CreateList.go +++ b/service/frauddetector/api_op_CreateList.go @@ -13,8 +13,8 @@ import ( // Creates a list. List is a set of input data for a variable in your event // dataset. You use the input data in a rule that's associated with your detector. -// For more information, see Lists -// (https://docs.aws.amazon.com/frauddetector/latest/ug/lists.html). +// For more information, see Lists (https://docs.aws.amazon.com/frauddetector/latest/ug/lists.html) +// . func (c *Client) CreateList(ctx context.Context, params *CreateListInput, optFns ...func(*Options)) (*CreateListOutput, error) { if params == nil { params = &CreateListInput{} @@ -41,16 +41,16 @@ type CreateListInput struct { Description *string // The names of the elements, if providing. You can also create an empty list and - // add elements later using the UpdateList - // (https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html) API. + // add elements later using the UpdateList (https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html) + // API. Elements []string // A collection of the key and value pairs. Tags []types.Tag - // The variable type of the list. You can only assign the variable type with String - // data type. For more information, see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). + // The variable type of the list. You can only assign the variable type with + // String data type. For more information, see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) + // . VariableType *string noSmithyDocumentSerde diff --git a/service/frauddetector/api_op_CreateModelVersion.go b/service/frauddetector/api_op_CreateModelVersion.go index 019aec978d6..45de1071809 100644 --- a/service/frauddetector/api_op_CreateModelVersion.go +++ b/service/frauddetector/api_op_CreateModelVersion.go @@ -49,12 +49,12 @@ type CreateModelVersionInput struct { // This member is required. TrainingDataSource types.TrainingDataSourceEnum - // Details of the external events data used for model version training. Required if - // trainingDataSource is EXTERNAL_EVENTS. + // Details of the external events data used for model version training. Required + // if trainingDataSource is EXTERNAL_EVENTS . ExternalEventsDetail *types.ExternalEventsDetail - // Details of the ingested events data used for model version training. Required if - // trainingDataSource is INGESTED_EVENTS. + // Details of the ingested events data used for model version training. Required + // if trainingDataSource is INGESTED_EVENTS . IngestedEventsDetail *types.IngestedEventsDetail // A collection of key and value pairs. diff --git a/service/frauddetector/api_op_CreateVariable.go b/service/frauddetector/api_op_CreateVariable.go index 4f9d4f9d5a3..7a0b76268e8 100644 --- a/service/frauddetector/api_op_CreateVariable.go +++ b/service/frauddetector/api_op_CreateVariable.go @@ -55,9 +55,8 @@ type CreateVariableInput struct { // A collection of key and value pairs. Tags []types.Tag - // The variable type. For more information see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). - // Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | + // The variable type. For more information see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) + // . Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | // BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | // BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | // FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | diff --git a/service/frauddetector/api_op_DeleteOutcome.go b/service/frauddetector/api_op_DeleteOutcome.go index c78892b6c24..8ae217803d1 100644 --- a/service/frauddetector/api_op_DeleteOutcome.go +++ b/service/frauddetector/api_op_DeleteOutcome.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an outcome. You cannot delete an outcome that is used in a rule version. -// When you delete an outcome, Amazon Fraud Detector permanently deletes that -// outcome and the data is no longer stored in Amazon Fraud Detector. +// Deletes an outcome. You cannot delete an outcome that is used in a rule +// version. When you delete an outcome, Amazon Fraud Detector permanently deletes +// that outcome and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteOutcome(ctx context.Context, params *DeleteOutcomeInput, optFns ...func(*Options)) (*DeleteOutcomeOutput, error) { if params == nil { params = &DeleteOutcomeInput{} diff --git a/service/frauddetector/api_op_DescribeModelVersions.go b/service/frauddetector/api_op_DescribeModelVersions.go index 34348a6395c..4010f8bd015 100644 --- a/service/frauddetector/api_op_DescribeModelVersions.go +++ b/service/frauddetector/api_op_DescribeModelVersions.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets all of the model versions for the specified model type or for the specified -// model type and model ID. You can also get details for a single, specified model -// version. +// Gets all of the model versions for the specified model type or for the +// specified model type and model ID. You can also get details for a single, +// specified model version. func (c *Client) DescribeModelVersions(ctx context.Context, params *DescribeModelVersionsInput, optFns ...func(*Options)) (*DescribeModelVersionsOutput, error) { if params == nil { params = &DescribeModelVersionsInput{} diff --git a/service/frauddetector/api_op_GetBatchImportJobs.go b/service/frauddetector/api_op_GetBatchImportJobs.go index b23d2fe000c..f3bb0ac90cb 100644 --- a/service/frauddetector/api_op_GetBatchImportJobs.go +++ b/service/frauddetector/api_op_GetBatchImportJobs.go @@ -13,11 +13,11 @@ import ( ) // Gets all batch import jobs or a specific job of the specified ID. This is a -// paginated API. If you provide a null maxResults, this action retrieves a maximum -// of 50 records per page. If you provide a maxResults, the value must be between 1 -// and 50. To get the next page results, provide the pagination token from the -// GetBatchImportJobsResponse as part of your request. A null pagination token -// fetches the records from the beginning. +// paginated API. If you provide a null maxResults , this action retrieves a +// maximum of 50 records per page. If you provide a maxResults , the value must be +// between 1 and 50. To get the next page results, provide the pagination token +// from the GetBatchImportJobsResponse as part of your request. A null pagination +// token fetches the records from the beginning. func (c *Client) GetBatchImportJobs(ctx context.Context, params *GetBatchImportJobsInput, optFns ...func(*Options)) (*GetBatchImportJobsOutput, error) { if params == nil { params = &GetBatchImportJobsInput{} diff --git a/service/frauddetector/api_op_GetDetectorVersion.go b/service/frauddetector/api_op_GetDetectorVersion.go index 9052ef12767..be01c10666e 100644 --- a/service/frauddetector/api_op_GetDetectorVersion.go +++ b/service/frauddetector/api_op_GetDetectorVersion.go @@ -71,9 +71,9 @@ type GetDetectorVersionOutput struct { // The execution mode of the rule in the dectector FIRST_MATCHED indicates that // Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at // the first matched rule. Amazon Fraud dectector then provides the outcomes for - // that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all - // rules and returns the outcomes for all matched rules. You can define and edit - // the rule mode at the detector version level, when it is in draft status. + // that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates + // all rules and returns the outcomes for all matched rules. You can define and + // edit the rule mode at the detector version level, when it is in draft status. RuleExecutionMode types.RuleExecutionMode // The rules included in the detector version. diff --git a/service/frauddetector/api_op_GetDetectors.go b/service/frauddetector/api_op_GetDetectors.go index c92965aee60..6194fa56b94 100644 --- a/service/frauddetector/api_op_GetDetectors.go +++ b/service/frauddetector/api_op_GetDetectors.go @@ -13,11 +13,11 @@ import ( ) // Gets all detectors or a single detector if a detectorId is specified. This is a -// paginated API. If you provide a null maxResults, this action retrieves a maximum -// of 10 records per page. If you provide a maxResults, the value must be between 5 -// and 10. To get the next page results, provide the pagination token from the -// GetDetectorsResponse as part of your request. A null pagination token fetches -// the records from the beginning. +// paginated API. If you provide a null maxResults , this action retrieves a +// maximum of 10 records per page. If you provide a maxResults , the value must be +// between 5 and 10. To get the next page results, provide the pagination token +// from the GetDetectorsResponse as part of your request. A null pagination token +// fetches the records from the beginning. func (c *Client) GetDetectors(ctx context.Context, params *GetDetectorsInput, optFns ...func(*Options)) (*GetDetectorsOutput, error) { if params == nil { params = &GetDetectorsInput{} diff --git a/service/frauddetector/api_op_GetEntityTypes.go b/service/frauddetector/api_op_GetEntityTypes.go index c2cb79f4025..8a0e3c9df0d 100644 --- a/service/frauddetector/api_op_GetEntityTypes.go +++ b/service/frauddetector/api_op_GetEntityTypes.go @@ -13,11 +13,11 @@ import ( ) // Gets all entity types or a specific entity type if a name is specified. This is -// a paginated API. If you provide a null maxResults, this action retrieves a -// maximum of 10 records per page. If you provide a maxResults, the value must be +// a paginated API. If you provide a null maxResults , this action retrieves a +// maximum of 10 records per page. If you provide a maxResults , the value must be // between 5 and 10. To get the next page results, provide the pagination token -// from the GetEntityTypesResponse as part of your request. A null pagination token -// fetches the records from the beginning. +// from the GetEntityTypesResponse as part of your request. A null pagination +// token fetches the records from the beginning. func (c *Client) GetEntityTypes(ctx context.Context, params *GetEntityTypesInput, optFns ...func(*Options)) (*GetEntityTypesOutput, error) { if params == nil { params = &GetEntityTypesInput{} diff --git a/service/frauddetector/api_op_GetEventPrediction.go b/service/frauddetector/api_op_GetEventPrediction.go index e6db24ef9dd..77036273171 100644 --- a/service/frauddetector/api_op_GetEventPrediction.go +++ b/service/frauddetector/api_op_GetEventPrediction.go @@ -12,7 +12,7 @@ import ( ) // Evaluates an event against a detector version. If a version ID is not provided, -// the detector’s (ACTIVE) version is used. +// the detector’s ( ACTIVE ) version is used. func (c *Client) GetEventPrediction(ctx context.Context, params *GetEventPredictionInput, optFns ...func(*Options)) (*GetEventPredictionOutput, error) { if params == nil { params = &GetEventPredictionInput{} diff --git a/service/frauddetector/api_op_GetEventPredictionMetadata.go b/service/frauddetector/api_op_GetEventPredictionMetadata.go index a6e65129903..4de190b099c 100644 --- a/service/frauddetector/api_op_GetEventPredictionMetadata.go +++ b/service/frauddetector/api_op_GetEventPredictionMetadata.go @@ -51,10 +51,9 @@ type GetEventPredictionMetadataInput struct { // This member is required. EventTypeName *string - // The timestamp that defines when the prediction was generated. The timestamp must - // be specified using ISO 8601 standard in UTC. We recommend calling - // ListEventPredictions - // (https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html) + // The timestamp that defines when the prediction was generated. The timestamp + // must be specified using ISO 8601 standard in UTC. We recommend calling + // ListEventPredictions (https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html) // first, and using the predictionTimestamp value in the response to provide an // accurate prediction timestamp value. // @@ -109,8 +108,8 @@ type GetEventPredictionMetadataOutput struct { // The execution mode of the rule used for evaluating variable values. RuleExecutionMode types.RuleExecutionMode - // List of rules associated with the detector version that were used for evaluating - // variable values. + // List of rules associated with the detector version that were used for + // evaluating variable values. Rules []types.EvaluatedRule // Metadata pertaining to the operation's result. diff --git a/service/frauddetector/api_op_GetEventTypes.go b/service/frauddetector/api_op_GetEventTypes.go index 2e78f5e9bb5..c18a882539a 100644 --- a/service/frauddetector/api_op_GetEventTypes.go +++ b/service/frauddetector/api_op_GetEventTypes.go @@ -13,11 +13,11 @@ import ( ) // Gets all event types or a specific event type if name is provided. This is a -// paginated API. If you provide a null maxResults, this action retrieves a maximum -// of 10 records per page. If you provide a maxResults, the value must be between 5 -// and 10. To get the next page results, provide the pagination token from the -// GetEventTypesResponse as part of your request. A null pagination token fetches -// the records from the beginning. +// paginated API. If you provide a null maxResults , this action retrieves a +// maximum of 10 records per page. If you provide a maxResults , the value must be +// between 5 and 10. To get the next page results, provide the pagination token +// from the GetEventTypesResponse as part of your request. A null pagination token +// fetches the records from the beginning. func (c *Client) GetEventTypes(ctx context.Context, params *GetEventTypesInput, optFns ...func(*Options)) (*GetEventTypesOutput, error) { if params == nil { params = &GetEventTypesInput{} diff --git a/service/frauddetector/api_op_GetExternalModels.go b/service/frauddetector/api_op_GetExternalModels.go index 398eec2139a..601d47a2c95 100644 --- a/service/frauddetector/api_op_GetExternalModels.go +++ b/service/frauddetector/api_op_GetExternalModels.go @@ -12,12 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the details for one or more Amazon SageMaker models that have been imported -// into the service. This is a paginated API. If you provide a null maxResults, -// this actions retrieves a maximum of 10 records per page. If you provide a -// maxResults, the value must be between 5 and 10. To get the next page results, -// provide the pagination token from the GetExternalModelsResult as part of your -// request. A null pagination token fetches the records from the beginning. +// Gets the details for one or more Amazon SageMaker models that have been +// imported into the service. This is a paginated API. If you provide a null +// maxResults , this actions retrieves a maximum of 10 records per page. If you +// provide a maxResults , the value must be between 5 and 10. To get the next page +// results, provide the pagination token from the GetExternalModelsResult as part +// of your request. A null pagination token fetches the records from the beginning. func (c *Client) GetExternalModels(ctx context.Context, params *GetExternalModelsInput, optFns ...func(*Options)) (*GetExternalModelsOutput, error) { if params == nil { params = &GetExternalModelsInput{} diff --git a/service/frauddetector/api_op_GetLabels.go b/service/frauddetector/api_op_GetLabels.go index 8c505c01a45..ce484b7e50e 100644 --- a/service/frauddetector/api_op_GetLabels.go +++ b/service/frauddetector/api_op_GetLabels.go @@ -13,8 +13,8 @@ import ( ) // Gets all labels or a specific label if name is provided. This is a paginated -// API. If you provide a null maxResults, this action retrieves a maximum of 50 -// records per page. If you provide a maxResults, the value must be between 10 and +// API. If you provide a null maxResults , this action retrieves a maximum of 50 +// records per page. If you provide a maxResults , the value must be between 10 and // 50. To get the next page results, provide the pagination token from the // GetGetLabelsResponse as part of your request. A null pagination token fetches // the records from the beginning. diff --git a/service/frauddetector/api_op_GetModelVersion.go b/service/frauddetector/api_op_GetModelVersion.go index 7af99482004..7fec2eb8ff8 100644 --- a/service/frauddetector/api_op_GetModelVersion.go +++ b/service/frauddetector/api_op_GetModelVersion.go @@ -57,7 +57,7 @@ type GetModelVersionOutput struct { ExternalEventsDetail *types.ExternalEventsDetail // The details of the ingested events data used for training the model version. - // This will be populated if the trainingDataSource is INGESTED_EVENTS. + // This will be populated if the trainingDataSource is INGESTED_EVENTS . IngestedEventsDetail *types.IngestedEventsDetail // The model ID. @@ -70,26 +70,15 @@ type GetModelVersionOutput struct { ModelVersionNumber *string // The model version status. Possible values are: - // - // * TRAINING_IN_PROGRESS - // - // * - // TRAINING_COMPLETE - // - // * ACTIVATE_REQUESTED - // - // * ACTIVATE_IN_PROGRESS - // - // * ACTIVE - // - // * - // INACTIVATE_REQUESTED - // - // * INACTIVATE_IN_PROGRESS - // - // * INACTIVE - // - // * ERROR + // - TRAINING_IN_PROGRESS + // - TRAINING_COMPLETE + // - ACTIVATE_REQUESTED + // - ACTIVATE_IN_PROGRESS + // - ACTIVE + // - INACTIVATE_REQUESTED + // - INACTIVATE_IN_PROGRESS + // - INACTIVE + // - ERROR Status *string // The training data schema. diff --git a/service/frauddetector/api_op_GetModels.go b/service/frauddetector/api_op_GetModels.go index 601a7ffb872..a9cfd5cc83e 100644 --- a/service/frauddetector/api_op_GetModels.go +++ b/service/frauddetector/api_op_GetModels.go @@ -16,8 +16,8 @@ import ( // no model type and no model id provided. Gets all models for the Amazon Web // Services account and model type, if the model type is specified but model id is // not provided. Gets a specific model if (model type, model id) tuple is -// specified. This is a paginated API. If you provide a null maxResults, this -// action retrieves a maximum of 10 records per page. If you provide a maxResults, +// specified. This is a paginated API. If you provide a null maxResults , this +// action retrieves a maximum of 10 records per page. If you provide a maxResults , // the value must be between 1 and 10. To get the next page results, provide the // pagination token from the response as part of your request. A null pagination // token fetches the records from the beginning. diff --git a/service/frauddetector/api_op_GetOutcomes.go b/service/frauddetector/api_op_GetOutcomes.go index 86c49f00543..f0eaed18af9 100644 --- a/service/frauddetector/api_op_GetOutcomes.go +++ b/service/frauddetector/api_op_GetOutcomes.go @@ -13,10 +13,10 @@ import ( ) // Gets one or more outcomes. This is a paginated API. If you provide a null -// maxResults, this actions retrieves a maximum of 100 records per page. If you -// provide a maxResults, the value must be between 50 and 100. To get the next page -// results, provide the pagination token from the GetOutcomesResult as part of your -// request. A null pagination token fetches the records from the beginning. +// maxResults , this actions retrieves a maximum of 100 records per page. If you +// provide a maxResults , the value must be between 50 and 100. To get the next +// page results, provide the pagination token from the GetOutcomesResult as part +// of your request. A null pagination token fetches the records from the beginning. func (c *Client) GetOutcomes(ctx context.Context, params *GetOutcomesInput, optFns ...func(*Options)) (*GetOutcomesOutput, error) { if params == nil { params = &GetOutcomesInput{} diff --git a/service/frauddetector/api_op_GetVariables.go b/service/frauddetector/api_op_GetVariables.go index 0057b35fc70..f8c222be7fd 100644 --- a/service/frauddetector/api_op_GetVariables.go +++ b/service/frauddetector/api_op_GetVariables.go @@ -14,9 +14,9 @@ import ( // Gets all of the variables or the specific variable. This is a paginated API. // Providing null maxSizePerPage results in retrieving maximum of 100 records per -// page. If you provide maxSizePerPage the value must be between 50 and 100. To get -// the next page result, a provide a pagination token from GetVariablesResult as -// part of your request. Null pagination token fetches the records from the +// page. If you provide maxSizePerPage the value must be between 50 and 100. To +// get the next page result, a provide a pagination token from GetVariablesResult +// as part of your request. Null pagination token fetches the records from the // beginning. func (c *Client) GetVariables(ctx context.Context, params *GetVariablesInput, optFns ...func(*Options)) (*GetVariablesOutput, error) { if params == nil { diff --git a/service/frauddetector/api_op_ListEventPredictions.go b/service/frauddetector/api_op_ListEventPredictions.go index 5789f8a856a..c9c73ec5f5e 100644 --- a/service/frauddetector/api_op_ListEventPredictions.go +++ b/service/frauddetector/api_op_ListEventPredictions.go @@ -16,11 +16,11 @@ import ( // detector version ID, event ID, event type, or by specifying a time period. If // filter is not specified, the most recent prediction is returned. For example, // the following filter lists all past predictions for xyz event type - { -// "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a -// null maxResults, this action will retrieve a maximum of 10 records per page. If -// you provide a maxResults, the value must be between 50 and 100. To get the next -// page results, provide the nextToken from the response as part of your request. A -// null nextToken fetches the records from the beginning. +// "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a +// null maxResults , this action will retrieve a maximum of 10 records per page. If +// you provide a maxResults , the value must be between 50 and 100. To get the next +// page results, provide the nextToken from the response as part of your request. +// A null nextToken fetches the records from the beginning. func (c *Client) ListEventPredictions(ctx context.Context, params *ListEventPredictionsInput, optFns ...func(*Options)) (*ListEventPredictionsOutput, error) { if params == nil { params = &ListEventPredictionsInput{} diff --git a/service/frauddetector/api_op_ListTagsForResource.go b/service/frauddetector/api_op_ListTagsForResource.go index c5c4a214c79..e00bac1214d 100644 --- a/service/frauddetector/api_op_ListTagsForResource.go +++ b/service/frauddetector/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all tags associated with the resource. This is a paginated API. To get the -// next page results, provide the pagination token from the response as part of +// Lists all tags associated with the resource. This is a paginated API. To get +// the next page results, provide the pagination token from the response as part of // your request. A null pagination token fetches the records from the beginning. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -123,8 +123,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/frauddetector/api_op_SendEvent.go b/service/frauddetector/api_op_SendEvent.go index 1b76e43bf92..5d7f951278c 100644 --- a/service/frauddetector/api_op_SendEvent.go +++ b/service/frauddetector/api_op_SendEvent.go @@ -12,8 +12,8 @@ import ( ) // Stores events in Amazon Fraud Detector without generating fraud predictions for -// those events. For example, you can use SendEvent to upload a historical dataset, -// which you can then later use to train a model. +// those events. For example, you can use SendEvent to upload a historical +// dataset, which you can then later use to train a model. func (c *Client) SendEvent(ctx context.Context, params *SendEventInput, optFns ...func(*Options)) (*SendEventOutput, error) { if params == nil { params = &SendEventInput{} @@ -59,10 +59,10 @@ type SendEventInput struct { // This member is required. EventVariables map[string]string - // The label to associate with the event. Required if specifying labelTimestamp. + // The label to associate with the event. Required if specifying labelTimestamp . AssignedLabel *string - // The timestamp associated with the label. Required if specifying assignedLabel. + // The timestamp associated with the label. Required if specifying assignedLabel . LabelTimestamp *string noSmithyDocumentSerde diff --git a/service/frauddetector/api_op_UpdateDetectorVersion.go b/service/frauddetector/api_op_UpdateDetectorVersion.go index 7322c10a67a..62b5fadaeab 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersion.go +++ b/service/frauddetector/api_op_UpdateDetectorVersion.go @@ -57,13 +57,13 @@ type UpdateDetectorVersionInput struct { // The model versions to include in the detector version. ModelVersions []types.ModelVersion - // The rule execution mode to add to the detector. If you specify FIRST_MATCHED, + // The rule execution mode to add to the detector. If you specify FIRST_MATCHED , // Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at // the first matched rule. Amazon Fraud dectector then provides the outcomes for - // that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates + // that single rule. If you specifiy ALL_MATCHED , Amazon Fraud Detector evaluates // all rules and returns the outcomes for all matched rules. You can define and // edit the rule mode at the detector version level, when it is in draft status. - // The default behavior is FIRST_MATCHED. + // The default behavior is FIRST_MATCHED . RuleExecutionMode types.RuleExecutionMode noSmithyDocumentSerde diff --git a/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go b/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go index d21070d0823..025fa0ab907 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go +++ b/service/frauddetector/api_op_UpdateDetectorVersionMetadata.go @@ -11,7 +11,7 @@ import ( ) // Updates the detector version's description. You can update the metadata for any -// detector version (DRAFT, ACTIVE, or INACTIVE). +// detector version ( DRAFT, ACTIVE, or INACTIVE ). func (c *Client) UpdateDetectorVersionMetadata(ctx context.Context, params *UpdateDetectorVersionMetadataInput, optFns ...func(*Options)) (*UpdateDetectorVersionMetadataOutput, error) { if params == nil { params = &UpdateDetectorVersionMetadataInput{} diff --git a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go index 5ff5cd44b3c..f4d7425bf2e 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go +++ b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go @@ -12,8 +12,8 @@ import ( ) // Updates the detector version’s status. You can perform the following promotions -// or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to -// INACTIVE, and INACTIVE to ACTIVE. +// or demotions using UpdateDetectorVersionStatus : DRAFT to ACTIVE , ACTIVE to +// INACTIVE , and INACTIVE to ACTIVE . func (c *Client) UpdateDetectorVersionStatus(ctx context.Context, params *UpdateDetectorVersionStatusInput, optFns ...func(*Options)) (*UpdateDetectorVersionStatusOutput, error) { if params == nil { params = &UpdateDetectorVersionStatusInput{} diff --git a/service/frauddetector/api_op_UpdateList.go b/service/frauddetector/api_op_UpdateList.go index 20fc66a698d..7a86b672926 100644 --- a/service/frauddetector/api_op_UpdateList.go +++ b/service/frauddetector/api_op_UpdateList.go @@ -44,14 +44,9 @@ type UpdateListInput struct { Elements []string // The update mode (type). - // - // * Use APPEND if you are adding elements to the list. - // - // * - // Use REPLACE if you replacing existing elements in the list. - // - // * Use REMOVE if you - // are removing elements from the list. + // - Use APPEND if you are adding elements to the list. + // - Use REPLACE if you replacing existing elements in the list. + // - Use REMOVE if you are removing elements from the list. UpdateMode types.ListUpdateMode // The variable type you want to assign to the list. You cannot update a variable diff --git a/service/frauddetector/api_op_UpdateModelVersion.go b/service/frauddetector/api_op_UpdateModelVersion.go index 7b841419fd6..d31dbc5f662 100644 --- a/service/frauddetector/api_op_UpdateModelVersion.go +++ b/service/frauddetector/api_op_UpdateModelVersion.go @@ -49,11 +49,11 @@ type UpdateModelVersionInput struct { ModelType types.ModelTypeEnum // The details of the external events data used for training the model version. - // Required if trainingDataSource is EXTERNAL_EVENTS. + // Required if trainingDataSource is EXTERNAL_EVENTS . ExternalEventsDetail *types.ExternalEventsDetail // The details of the ingested event used for training the model version. Required - // if your trainingDataSource is INGESTED_EVENTS. + // if your trainingDataSource is INGESTED_EVENTS . IngestedEventsDetail *types.IngestedEventsDetail // A collection of key and value pairs. diff --git a/service/frauddetector/api_op_UpdateModelVersionStatus.go b/service/frauddetector/api_op_UpdateModelVersionStatus.go index 7b12c70a977..fa2d30cc258 100644 --- a/service/frauddetector/api_op_UpdateModelVersionStatus.go +++ b/service/frauddetector/api_op_UpdateModelVersionStatus.go @@ -13,13 +13,9 @@ import ( // Updates the status of a model version. You can perform the following status // updates: -// -// * Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED. -// -// * -// Change the TRAINING_COMPLETE status to ACTIVE. -// -// * Change ACTIVE to INACTIVE. +// - Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED . +// - Change the TRAINING_COMPLETE status to ACTIVE . +// - Change ACTIVE to INACTIVE . func (c *Client) UpdateModelVersionStatus(ctx context.Context, params *UpdateModelVersionStatusInput, optFns ...func(*Options)) (*UpdateModelVersionStatusOutput, error) { if params == nil { params = &UpdateModelVersionStatusInput{} diff --git a/service/frauddetector/api_op_UpdateVariable.go b/service/frauddetector/api_op_UpdateVariable.go index a091874bf82..d789b4a3699 100644 --- a/service/frauddetector/api_op_UpdateVariable.go +++ b/service/frauddetector/api_op_UpdateVariable.go @@ -39,8 +39,8 @@ type UpdateVariableInput struct { // The new description. Description *string - // The variable type. For more information see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). + // The variable type. For more information see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) + // . VariableType *string noSmithyDocumentSerde diff --git a/service/frauddetector/doc.go b/service/frauddetector/doc.go index 0b713116cb1..c8ee38b2e34 100644 --- a/service/frauddetector/doc.go +++ b/service/frauddetector/doc.go @@ -6,17 +6,16 @@ // This is the Amazon Fraud Detector API Reference. This guide is for developers // who need detailed information about Amazon Fraud Detector API actions, data // types, and errors. For more information about Amazon Fraud Detector features, -// see the Amazon Fraud Detector User Guide -// (https://docs.aws.amazon.com/frauddetector/latest/ug/). We provide the Query API -// as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java -// and Python programming languages. The Amazon Fraud Detector Query API provides -// HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action. -// AWS SDK provides libraries, sample code, tutorials, and other resources for -// software developers who prefer to build applications using language-specific -// APIs instead of submitting a request over HTTP or HTTPS. These libraries provide -// basic functions that automatically take care of tasks such as cryptographically -// signing your requests, retrying requests, and handling error responses, so that -// it is easier for you to get started. For more information about the AWS SDKs, -// see Tools to build on AWS -// (https://docs.aws.amazon.com/https:/aws.amazon.com/tools/). +// see the Amazon Fraud Detector User Guide (https://docs.aws.amazon.com/frauddetector/latest/ug/) +// . We provide the Query API as well as AWS software development kits (SDK) for +// Amazon Fraud Detector in Java and Python programming languages. The Amazon Fraud +// Detector Query API provides HTTPS requests that use the HTTP verb GET or POST +// and a Query parameter Action . AWS SDK provides libraries, sample code, +// tutorials, and other resources for software developers who prefer to build +// applications using language-specific APIs instead of submitting a request over +// HTTP or HTTPS. These libraries provide basic functions that automatically take +// care of tasks such as cryptographically signing your requests, retrying +// requests, and handling error responses, so that it is easier for you to get +// started. For more information about the AWS SDKs, see Tools to build on AWS (https://docs.aws.amazon.com/https:/aws.amazon.com/tools/) +// . package frauddetector diff --git a/service/frauddetector/types/enums.go b/service/frauddetector/types/enums.go index 02515576c3a..25aaea979b7 100644 --- a/service/frauddetector/types/enums.go +++ b/service/frauddetector/types/enums.go @@ -79,8 +79,8 @@ const ( DetectorVersionStatusInactive DetectorVersionStatus = "INACTIVE" ) -// Values returns all known values for DetectorVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DetectorVersionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DetectorVersionStatus) Values() []DetectorVersionStatus { return []DetectorVersionStatus{ @@ -188,8 +188,8 @@ const ( ModelOutputDataFormatJsonlines ModelOutputDataFormat = "APPLICATION_JSONLINES" ) -// Values returns all known values for ModelOutputDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ModelOutputDataFormat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ModelOutputDataFormat) Values() []ModelOutputDataFormat { return []ModelOutputDataFormat{ @@ -300,9 +300,9 @@ const ( UnlabeledEventsTreatmentAuto UnlabeledEventsTreatment = "AUTO" ) -// Values returns all known values for UnlabeledEventsTreatment. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UnlabeledEventsTreatment. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (UnlabeledEventsTreatment) Values() []UnlabeledEventsTreatment { return []UnlabeledEventsTreatment{ "IGNORE", diff --git a/service/frauddetector/types/errors.go b/service/frauddetector/types/errors.go index 666517e87bb..410fb7a1946 100644 --- a/service/frauddetector/types/errors.go +++ b/service/frauddetector/types/errors.go @@ -8,7 +8,7 @@ import ( ) // An exception indicating Amazon Fraud Detector does not have the needed -// permissions. This can occur if you submit a request, such as PutExternalModel, +// permissions. This can occur if you submit a request, such as PutExternalModel , // that specifies a role that is not in your account. type AccessDeniedException struct { Message *string diff --git a/service/frauddetector/types/types.go b/service/frauddetector/types/types.go index ace3f58f796..8ba00d81678 100644 --- a/service/frauddetector/types/types.go +++ b/service/frauddetector/types/types.go @@ -11,7 +11,7 @@ import ( // variables (aggregated variables) based on historical events. For example, your // ATI model might calculate the number of times an user has logged in using the // same IP address. In this case, event variables used to derive the aggregated -// variables are IP address and user. +// variables are IP address and user . type AggregatedLogOddsMetric struct { // The relative importance of the variables in the list to the other event @@ -33,7 +33,7 @@ type AggregatedLogOddsMetric struct { // continuously calculate a set of variables (aggregated variables) based on // historical events. For example, the model might calculate the number of times an // user has logged in using the same IP address. In this case, event variables used -// to derive the aggregated variables are IP address and user. +// to derive the aggregated variables are IP address and user . type AggregatedVariablesImpactExplanation struct { // The names of all the event variables that were used to derive the aggregated @@ -42,12 +42,8 @@ type AggregatedVariablesImpactExplanation struct { // The raw, uninterpreted value represented as log-odds of the fraud. These values // are usually between -10 to +10, but range from -infinity to +infinity. - // - // * A - // positive value indicates that the variables drove the risk score up. - // - // * A - // negative value indicates that the variables drove the risk score down. + // - A positive value indicates that the variables drove the risk score up. + // - A negative value indicates that the variables drove the risk score down. LogOddsImpact *float32 // The relative impact of the aggregated variables in terms of magnitude on the @@ -62,7 +58,7 @@ type AggregatedVariablesImpactExplanation struct { // provide to continuously calculate a set of variables (aggregated variables) // based on historical events. For example, your ATI model might calculate the // number of times an user has logged in using the same IP address. In this case, -// event variables used to derive the aggregated variables are IP address and user. +// event variables used to derive the aggregated variables are IP address and user . type AggregatedVariablesImportanceMetrics struct { // List of variables' metrics. @@ -113,9 +109,9 @@ type ATIMetricDataPoint struct { // at-least one labeled account takeover event is present in the ingested dataset. Atodr *float32 - // The challenge rate. This indicates the percentage of login events that the model - // recommends to challenge such as one-time password, multi-factor authentication, - // and investigations. + // The challenge rate. This indicates the percentage of login events that the + // model recommends to challenge such as one-time password, multi-factor + // authentication, and investigations. Cr *float32 // The model's threshold that specifies an acceptable fraud capture rate. For @@ -337,7 +333,7 @@ type DetectorVersionSummary struct { // The entity details. type Entity struct { - // The entity ID. If you do not know the entityId, you can pass unknown, which is + // The entity ID. If you do not know the entityId , you can pass unknown , which is // areserved string literal. // // This member is required. @@ -506,9 +502,9 @@ type EventType struct { // The event type entity types. EntityTypes []string - // If Enabled, Amazon Fraud Detector stores event data when you generate a + // If Enabled , Amazon Fraud Detector stores event data when you generate a // prediction and uses that data to update calculated variables in near real-time. - // Amazon Fraud Detector uses this data, known as INGESTED_EVENTS, to train your + // Amazon Fraud Detector uses this data, known as INGESTED_EVENTS , to train your // model and improve fraud predictions. EventIngestion EventIngestion @@ -748,34 +744,25 @@ type Label struct { type LabelSchema struct { // The label mapper maps the Amazon Fraud Detector supported model classification - // labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if - // "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper - // could be: {"FRAUD" => ["0"], "LEGIT" => ["1"]} or {"FRAUD" => ["false"], "LEGIT" - // => ["true"]} or {"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. - // The value part of the mapper is a list, because you may have multiple label - // variants from your event type for a single Amazon Fraud Detector label. + // labels ( FRAUD , LEGIT ) to the appropriate event type labels. For example, if " + // FRAUD " and " LEGIT " are Amazon Fraud Detector supported labels, this mapper + // could be: {"FRAUD" => ["0"] , "LEGIT" => ["1"]} or {"FRAUD" => ["false"] , + // "LEGIT" => ["true"]} or {"FRAUD" => ["fraud", "abuse"] , "LEGIT" => ["legit", + // "safe"]} . The value part of the mapper is a list, because you may have multiple + // label variants from your event type for a single Amazon Fraud Detector label. LabelMapper map[string][]string // The action to take for unlabeled events. - // - // * Use IGNORE if you want the unlabeled - // events to be ignored. This is recommended when the majority of the events in the - // dataset are labeled. - // - // * Use FRAUD if you want to categorize all unlabeled events - // as “Fraud”. This is recommended when most of the events in your dataset are - // fraudulent. - // - // * Use LEGIT f you want to categorize all unlabeled events as - // “Legit”. This is recommended when most of the events in your dataset are - // legitimate. - // - // * Use AUTO if you want Amazon Fraud Detector to decide how to use - // the unlabeled data. This is recommended when there is significant unlabeled - // events in the dataset. - // - // By default, Amazon Fraud Detector ignores the unlabeled - // data. + // - Use IGNORE if you want the unlabeled events to be ignored. This is + // recommended when the majority of the events in the dataset are labeled. + // - Use FRAUD if you want to categorize all unlabeled events as “Fraud”. This is + // recommended when most of the events in your dataset are fraudulent. + // - Use LEGIT f you want to categorize all unlabeled events as “Legit”. This is + // recommended when most of the events in your dataset are legitimate. + // - Use AUTO if you want Amazon Fraud Detector to decide how to use the + // unlabeled data. This is recommended when there is significant unlabeled events + // in the dataset. + // By default, Amazon Fraud Detector ignores the unlabeled data. UnlabeledEventsTreatment UnlabeledEventsTreatment noSmithyDocumentSerde @@ -785,8 +772,8 @@ type LabelSchema struct { type LogOddsMetric struct { // The relative importance of the variable. For more information, see Model - // variable importance - // (https://docs.aws.amazon.com/frauddetector/latest/ug/model-variable-importance.html). + // variable importance (https://docs.aws.amazon.com/frauddetector/latest/ug/model-variable-importance.html) + // . // // This member is required. VariableImportance *float32 @@ -820,8 +807,8 @@ type MetricDataPoint struct { // fraud. Threshold *float32 - // The true positive rate. This is the percentage of total fraud the model detects. - // Also known as capture rate. + // The true positive rate. This is the percentage of total fraud the model + // detects. Also known as capture rate. Tpr *float32 noSmithyDocumentSerde @@ -904,8 +891,8 @@ type ModelOutputConfiguration struct { // This member is required. Format ModelOutputDataFormat - // A map of CSV index values in the SageMaker response to the Amazon Fraud Detector - // variables. + // A map of CSV index values in the SageMaker response to the Amazon Fraud + // Detector variables. CsvIndexToVariableMap map[string]string // A map of JSON keys in response from SageMaker to the Amazon Fraud Detector @@ -961,11 +948,11 @@ type ModelVersionDetail struct { CreatedTime *string // The external events data details. This will be populated if the - // trainingDataSource for the model version is specified as EXTERNAL_EVENTS. + // trainingDataSource for the model version is specified as EXTERNAL_EVENTS . ExternalEventsDetail *ExternalEventsDetail // The ingested events data details. This will be populated if the - // trainingDataSource for the model version is specified as INGESTED_EVENTS. + // trainingDataSource for the model version is specified as INGESTED_EVENTS . IngestedEventsDetail *IngestedEventsDetail // The timestamp when the model was last updated. @@ -1030,8 +1017,8 @@ type OFIMetricDataPoint struct { // fraud. Threshold *float32 - // The true positive rate. This is the percentage of total fraud the model detects. - // Also known as capture rate. + // The true positive rate. This is the percentage of total fraud the model + // detects. Also known as capture rate. Tpr *float32 noSmithyDocumentSerde @@ -1093,7 +1080,7 @@ type PredictionExplanations struct { // provide to continuously calculate a set of variables (aggregated variables) // based on historical events. For example, your ATI model might calculate the // number of times an user has logged in using the same IP address. In this case, - // event variables used to derive the aggregated variables are IP address and user. + // event variables used to derive the aggregated variables are IP address and user . AggregatedVariablesImpactExplanations []AggregatedVariablesImpactExplanation // The details of the event variable's impact on the prediction score. @@ -1219,8 +1206,8 @@ type TFIMetricDataPoint struct { // fraud. Threshold *float32 - // The true positive rate. This is the percentage of total fraud the model detects. - // Also known as capture rate. + // The true positive rate. This is the percentage of total fraud the model + // detects. Also known as capture rate. Tpr *float32 noSmithyDocumentSerde @@ -1318,7 +1305,7 @@ type TrainingResultV2 struct { // continuously calculate a set of variables (aggregated variables) based on // historical events. For example, your ATI model might calculate the number of // times an user has logged in using the same IP address. In this case, event - // variables used to derive the aggregated variables are IP address and user. + // variables used to derive the aggregated variables are IP address and user . AggregatedVariablesImportanceMetrics *AggregatedVariablesImportanceMetrics // The model training data validation metrics. @@ -1363,8 +1350,8 @@ type Variable struct { // The data source of the variable. DataSource DataSource - // The data type of the variable. For more information see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). + // The data type of the variable. For more information see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) + // . DataType DataType // The default value of the variable. @@ -1410,9 +1397,8 @@ type VariableEntry struct { // The name of the variable. Name *string - // The type of the variable. For more information see Variable types - // (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types). - // Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | + // The type of the variable. For more information see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) + // . Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | // BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | // BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | // FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | @@ -1432,12 +1418,8 @@ type VariableImpactExplanation struct { // The raw, uninterpreted value represented as log-odds of the fraud. These values // are usually between -10 to +10, but range from - infinity to + infinity. - // - // * A - // positive value indicates that the variable drove the risk score up. - // - // * A - // negative value indicates that the variable drove the risk score down. + // - A positive value indicates that the variable drove the risk score up. + // - A negative value indicates that the variable drove the risk score down. LogOddsImpact *float32 // The event variable's relative impact in terms of magnitude on the prediction diff --git a/service/fsx/api_client.go b/service/fsx/api_client.go index e60a64e774e..0a5bbef85db 100644 --- a/service/fsx/api_client.go +++ b/service/fsx/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/fsx/api_op_AssociateFileSystemAliases.go b/service/fsx/api_op_AssociateFileSystemAliases.go index 8f456471ffb..4567f8ad11b 100644 --- a/service/fsx/api_op_AssociateFileSystemAliases.go +++ b/service/fsx/api_op_AssociateFileSystemAliases.go @@ -17,11 +17,9 @@ import ( // have a maximum of 50 DNS aliases associated with it at any one time. If you try // to associate a DNS alias that is already associated with the file system, FSx // takes no action on that alias in the request. For more information, see Working -// with DNS Aliases -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) -// and Walkthrough 5: Using DNS aliases to access your file system -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html), -// including additional steps you must take to be able to access your file system +// with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) +// and Walkthrough 5: Using DNS aliases to access your file system (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html) +// , including additional steps you must take to be able to access your file system // using a DNS alias. The system response shows the DNS aliases that Amazon FSx is // attempting to associate with the file system. Use the API operation to monitor // the status of the aliases Amazon FSx is associating with the file system. @@ -46,22 +44,14 @@ type AssociateFileSystemAliasesInput struct { // An array of one or more DNS alias names to associate with the file system. The // alias name has to comply with the following formatting requirements: - // - // * - // Formatted as a fully-qualified domain name (FQDN), hostname.domain , for - // example, accounting.corp.example.com. - // - // * Can contain alphanumeric characters and - // the hyphen (-). - // - // * Cannot start or end with a hyphen. - // - // * Can start with a - // numeric. - // - // For DNS alias names, Amazon FSx stores alphabetic characters as - // lowercase letters (a-z), regardless of how you specify them: as uppercase - // letters, lowercase letters, or the corresponding letters in escape codes. + // - Formatted as a fully-qualified domain name (FQDN), hostname.domain , for + // example, accounting.corp.example.com . + // - Can contain alphanumeric characters and the hyphen (-). + // - Cannot start or end with a hyphen. + // - Can start with a numeric. + // For DNS alias names, Amazon FSx stores alphabetic characters as lowercase + // letters (a-z), regardless of how you specify them: as uppercase letters, + // lowercase letters, or the corresponding letters in escape codes. // // This member is required. Aliases []string @@ -83,8 +73,8 @@ type AssociateFileSystemAliasesInput struct { // The system generated response showing the DNS aliases that Amazon FSx is // attempting to associate with the file system. Use the API operation to monitor // the status of the aliases Amazon FSx is associating with the file system. It can -// take up to 2.5 minutes for the alias status to change from CREATING to -// AVAILABLE. +// take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE +// . type AssociateFileSystemAliasesOutput struct { // An array of the DNS aliases that Amazon FSx is associating with the file system. diff --git a/service/fsx/api_op_CancelDataRepositoryTask.go b/service/fsx/api_op_CancelDataRepositoryTask.go index aeab909684e..1389283f195 100644 --- a/service/fsx/api_op_CancelDataRepositoryTask.go +++ b/service/fsx/api_op_CancelDataRepositoryTask.go @@ -14,15 +14,10 @@ import ( // Cancels an existing Amazon FSx for Lustre data repository task if that task is // in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx // does the following. -// -// * Any files that FSx has already exported are not -// reverted. -// -// * FSx continues to export any files that are "in-flight" when the -// cancel operation is received. -// -// * FSx does not export any files that have not yet -// been exported. +// - Any files that FSx has already exported are not reverted. +// - FSx continues to export any files that are "in-flight" when the cancel +// operation is received. +// - FSx does not export any files that have not yet been exported. func (c *Client) CancelDataRepositoryTask(ctx context.Context, params *CancelDataRepositoryTaskInput, optFns ...func(*Options)) (*CancelDataRepositoryTaskOutput, error) { if params == nil { params = &CancelDataRepositoryTaskInput{} @@ -52,25 +47,14 @@ type CancelDataRepositoryTaskInput struct { type CancelDataRepositoryTaskOutput struct { // The lifecycle status of the data repository task, as follows: - // - // * PENDING - - // Amazon FSx has not started the task. - // - // * EXECUTING - Amazon FSx is processing the - // task. - // - // * FAILED - Amazon FSx was not able to complete the task. For example, - // there may be files the task failed to process. The - // DataRepositoryTaskFailureDetails property provides more information about task - // failures. - // - // * SUCCEEDED - FSx completed the task successfully. - // - // * CANCELED - - // Amazon FSx canceled the task and it did not complete. - // - // * CANCELING - FSx is in - // process of canceling the task. + // - PENDING - Amazon FSx has not started the task. + // - EXECUTING - Amazon FSx is processing the task. + // - FAILED - Amazon FSx was not able to complete the task. For example, there + // may be files the task failed to process. The DataRepositoryTaskFailureDetails + // property provides more information about task failures. + // - SUCCEEDED - FSx completed the task successfully. + // - CANCELED - Amazon FSx canceled the task and it did not complete. + // - CANCELING - FSx is in process of canceling the task. Lifecycle types.DataRepositoryTaskLifecycle // The ID of the task being canceled. diff --git a/service/fsx/api_op_CopyBackup.go b/service/fsx/api_op_CopyBackup.go index ef86848c6b7..23903d767e6 100644 --- a/service/fsx/api_op_CopyBackup.go +++ b/service/fsx/api_op_CopyBackup.go @@ -12,30 +12,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies an existing backup within the same Amazon Web Services account to another -// Amazon Web Services Region (cross-Region copy) or within the same Amazon Web -// Services Region (in-Region copy). You can have up to five backup copy requests -// in progress to a single destination Region per account. You can use cross-Region -// backup copies for cross-Region disaster recovery. You can periodically take -// backups and copy them to another Region so that in the event of a disaster in -// the primary Region, you can restore from backup and recover availability quickly -// in the other Region. You can make cross-Region copies only within your Amazon -// Web Services partition. A partition is a grouping of Regions. Amazon Web -// Services currently has three partitions: aws (Standard Regions), aws-cn (China -// Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions). You can -// also use backup copies to clone your file dataset to another Region or within -// the same Region. You can use the SourceRegion parameter to specify the Amazon -// Web Services Region from which the backup will be copied. For example, if you -// make the call from the us-west-1 Region and want to copy a backup from the -// us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a -// cross-Region copy. If you don't specify a Region, the backup copy is created in -// the same Region where the request is sent from (in-Region copy). For more -// information about creating backup copies, see Copying backups -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups) -// in the Amazon FSx for Windows User Guide, Copying backups -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups) -// in the Amazon FSx for Lustre User Guide, and Copying backups -// (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups) +// Copies an existing backup within the same Amazon Web Services account to +// another Amazon Web Services Region (cross-Region copy) or within the same Amazon +// Web Services Region (in-Region copy). You can have up to five backup copy +// requests in progress to a single destination Region per account. You can use +// cross-Region backup copies for cross-Region disaster recovery. You can +// periodically take backups and copy them to another Region so that in the event +// of a disaster in the primary Region, you can restore from backup and recover +// availability quickly in the other Region. You can make cross-Region copies only +// within your Amazon Web Services partition. A partition is a grouping of Regions. +// Amazon Web Services currently has three partitions: aws (Standard Regions), +// aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] +// Regions). You can also use backup copies to clone your file dataset to another +// Region or within the same Region. You can use the SourceRegion parameter to +// specify the Amazon Web Services Region from which the backup will be copied. For +// example, if you make the call from the us-west-1 Region and want to copy a +// backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion +// parameter to make a cross-Region copy. If you don't specify a Region, the backup +// copy is created in the same Region where the request is sent from (in-Region +// copy). For more information about creating backup copies, see Copying backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups) +// in the Amazon FSx for Windows User Guide, Copying backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups) +// in the Amazon FSx for Lustre User Guide, and Copying backups (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups) // in the Amazon FSx for OpenZFS User Guide. func (c *Client) CopyBackup(ctx context.Context, params *CopyBackupInput, optFns ...func(*Options)) (*CopyBackupOutput, error) { if params == nil { @@ -65,7 +62,7 @@ type CopyBackupInput struct { ClientRequestToken *string // A Boolean flag indicating whether tags from the source backup should be copied - // to the backup copy. This value defaults to false. If you set CopyTags to true + // to the backup copy. This value defaults to false . If you set CopyTags to true // and the source backup has existing tags, you can use the Tags parameter to // create new tags, provided that the sum of the source backup tags and the new // tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts @@ -75,30 +72,22 @@ type CopyBackupInput struct { // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on Amazon FSx file systems, as follows: - // - // * Amazon FSx for Lustre - // PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 - // types are encrypted using the Amazon FSx service KMS key for your account. - // - // * - // Amazon FSx for NetApp ONTAP - // - // * Amazon FSx for OpenZFS - // - // * Amazon FSx for Windows - // File Server - // - // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for - // your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. + // SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS + // key for your account. + // - Amazon FSx for NetApp ONTAP + // - Amazon FSx for OpenZFS + // - Amazon FSx for Windows File Server + // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account + // is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The source Amazon Web Services Region of the backup. Specifies the Amazon Web // Services Region from which the backup is being copied. The source and // destination Regions must be in the same Amazon Web Services partition. If you - // don't specify a Region, SourceRegion defaults to the Region where the request is - // sent from (in-Region copy). + // don't specify a Region, SourceRegion defaults to the Region where the request + // is sent from (in-Region copy). SourceRegion *string // A list of Tag values, with a maximum of 50 elements. diff --git a/service/fsx/api_op_CreateBackup.go b/service/fsx/api_op_CreateBackup.go index bef2f4dd98f..045f1452ee8 100644 --- a/service/fsx/api_op_CreateBackup.go +++ b/service/fsx/api_op_CreateBackup.go @@ -18,53 +18,37 @@ import ( // can restore a file system or volume from a backup if an issue arises with the // original file system or volume. For Amazon FSx for Lustre file systems, you can // create a backup only for file systems that have the following configuration: +// - A Persistent deployment type +// - Are not linked to a data repository // -// * -// A Persistent deployment type +// For more information about backups, see the following: +// - For Amazon FSx for Lustre, see Working with FSx for Lustre backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) +// . +// - For Amazon FSx for Windows, see Working with FSx for Windows backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html) +// . +// - For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP +// backups (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html) +// . +// - For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html) +// . // -// * Are not linked to a data repository +// If a backup with the specified client request token exists and the parameters +// match, this operation returns the description of the existing backup. If a +// backup with the specified client request token exists and the parameters don't +// match, this operation returns IncompatibleParameterError . If a backup with the +// specified client request token doesn't exist, CreateBackup does the following: +// - Creates a new Amazon FSx backup with an assigned ID, and an initial +// lifecycle state of CREATING . +// - Returns the description of the backup. // -// For more -// information about backups, see the following: -// -// * For Amazon FSx for Lustre, see -// Working with FSx for Lustre backups -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). -// -// * -// For Amazon FSx for Windows, see Working with FSx for Windows backups -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html). -// -// * For -// Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups -// (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html). -// -// * For -// Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups -// (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html). -// -// If a -// backup with the specified client request token exists and the parameters match, -// this operation returns the description of the existing backup. If a backup with -// the specified client request token exists and the parameters don't match, this -// operation returns IncompatibleParameterError. If a backup with the specified -// client request token doesn't exist, CreateBackup does the following: -// -// * Creates -// a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of -// CREATING. -// -// * Returns the description of the backup. -// -// By using the idempotent -// operation, you can retry a CreateBackup operation without the risk of creating -// an extra backup. This approach can be useful when an initial call fails in a way -// that makes it unclear whether a backup was created. If you use the same client -// request token and the initial call created a backup, the operation returns a -// successful result because all the parameters are the same. The CreateBackup -// operation returns while the backup's lifecycle state is still CREATING. You can -// check the backup creation status by calling the DescribeBackups -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html) +// By using the idempotent operation, you can retry a CreateBackup operation +// without the risk of creating an extra backup. This approach can be useful when +// an initial call fails in a way that makes it unclear whether a backup was +// created. If you use the same client request token and the initial call created a +// backup, the operation returns a successful result because all the parameters are +// the same. The CreateBackup operation returns while the backup's lifecycle state +// is still CREATING . You can check the backup creation status by calling the +// DescribeBackups (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html) // operation, which returns the backup state along with other information. func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) { if params == nil { @@ -94,7 +78,7 @@ type CreateBackupInput struct { // (Optional) The tags to apply to the backup at backup creation. The key value of // the Name tag appears in the console as the backup name. If you have set - // CopyTagsToBackups to true, and you specify one or more tags using the + // CopyTagsToBackups to true , and you specify one or more tags using the // CreateBackup operation, no existing file system tags are copied from the file // system to the backup. Tags []types.Tag diff --git a/service/fsx/api_op_CreateDataRepositoryAssociation.go b/service/fsx/api_op_CreateDataRepositoryAssociation.go index 8f2d1dba9fc..3445eedc82f 100644 --- a/service/fsx/api_op_CreateDataRepositoryAssociation.go +++ b/service/fsx/api_op_CreateDataRepositoryAssociation.go @@ -21,10 +21,10 @@ import ( // bucket or prefix associated with it. You can configure a data repository // association for automatic import only, for automatic export only, or for both. // To learn more about linking a data repository to your file system, see Linking -// your file system to an S3 bucket -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). -// CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. -// To create a DRA on Amazon File Cache, use the CreateFileCache operation. +// your file system to an S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html) +// . CreateDataRepositoryAssociation isn't supported on Amazon File Cache +// resources. To create a DRA on Amazon File Cache, use the CreateFileCache +// operation. func (c *Client) CreateDataRepositoryAssociation(ctx context.Context, params *CreateDataRepositoryAssociationInput, optFns ...func(*Options)) (*CreateDataRepositoryAssociationOutput, error) { if params == nil { params = &CreateDataRepositoryAssociationInput{} @@ -44,7 +44,7 @@ type CreateDataRepositoryAssociationInput struct { // The path to the Amazon S3 data repository that will be linked to the file // system. The path can be an S3 bucket or prefix in the format - // s3://myBucket/myPrefix/. This path specifies where in the S3 data repository + // s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository // files will be imported from or exported to. // // This member is required. @@ -57,7 +57,7 @@ type CreateDataRepositoryAssociationInput struct { // Set to true to run an import data repository task to import metadata from the // data repository to the file system after the data repository association is - // created. Default is false. + // created. Default is false . BatchImportMetaDataOnCreate *bool // (Optional) An idempotency token for resource creation, in a string of up to 63 @@ -65,18 +65,18 @@ type CreateDataRepositoryAssociationInput struct { // the Command Line Interface (CLI) or an Amazon Web Services SDK. ClientRequestToken *string - // A path on the file system that points to a high-level directory (such as /ns1/) - // or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with - // DataRepositoryPath. The leading forward slash in the name is required. Two data + // A path on the file system that points to a high-level directory (such as /ns1/ ) + // or subdirectory (such as /ns1/subdir/ ) that will be mapped 1-1 with + // DataRepositoryPath . The leading forward slash in the name is required. Two data // repository associations cannot have overlapping file system paths. For example, - // if a data repository is associated with file system path /ns1/, then you cannot - // link another data repository with file system path /ns1/ns2. This path specifies - // where in your file system files will be exported from or imported to. This file - // system directory can be linked to only one Amazon S3 bucket, and no other S3 - // bucket can be linked to the directory. If you specify only a forward slash (/) - // as the file system path, you can link only one data repository to the file - // system. You can only specify "/" as the file system path for the first data - // repository associated with a file system. + // if a data repository is associated with file system path /ns1/ , then you cannot + // link another data repository with file system path /ns1/ns2 . This path + // specifies where in your file system files will be exported from or imported to. + // This file system directory can be linked to only one Amazon S3 bucket, and no + // other S3 bucket can be linked to the directory. If you specify only a forward + // slash ( / ) as the file system path, you can link only one data repository to + // the file system. You can only specify "/" as the file system path for the first + // data repository associated with a file system. FileSystemPath *string // For files imported from a data repository, this value determines the stripe diff --git a/service/fsx/api_op_CreateDataRepositoryTask.go b/service/fsx/api_op_CreateDataRepositoryTask.go index 1b64220cf5a..d623588bda9 100644 --- a/service/fsx/api_op_CreateDataRepositoryTask.go +++ b/service/fsx/api_op_CreateDataRepositoryTask.go @@ -19,11 +19,10 @@ import ( // symbolic links (symlinks) from your FSx file system to a linked data repository. // A CreateDataRepositoryTask operation will fail if a data repository is not // linked to the FSx file system. To learn more about data repository tasks, see -// Data Repository Tasks -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html). -// To learn more about linking a data repository to your file system, see Linking -// your file system to an S3 bucket -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html). +// Data Repository Tasks (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html) +// . To learn more about linking a data repository to your file system, see +// Linking your file system to an S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html) +// . func (c *Client) CreateDataRepositoryTask(ctx context.Context, params *CreateDataRepositoryTaskInput, optFns ...func(*Options)) (*CreateDataRepositoryTaskOutput, error) { if params == nil { params = &CreateDataRepositoryTaskInput{} @@ -49,8 +48,8 @@ type CreateDataRepositoryTaskInput struct { // Defines whether or not Amazon FSx provides a CompletionReport once the task has // completed. A CompletionReport provides a detailed report on the files that // Amazon FSx processed that meet the criteria specified by the Scope parameter. - // For more information, see Working with Task Completion Reports - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html). + // For more information, see Working with Task Completion Reports (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html) + // . // // This member is required. Report *types.CompletionReport @@ -71,19 +70,16 @@ type CreateDataRepositoryTaskInput struct { // A list of paths for the data repository task to use when the task is processed. // If a path that you provide isn't valid, the task fails. - // - // * For export tasks, the - // list contains paths on the Amazon FSx file system from which the files are - // exported to the Amazon S3 bucket. The default path is the file system root - // directory. The paths you provide need to be relative to the mount point of the - // file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or - // file on the file system you want to export, then the path to provide is - // path1. - // - // * For import tasks, the list contains paths in the Amazon S3 bucket from - // which POSIX metadata changes are imported to the Amazon FSx file system. The - // path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where - // myPrefix is optional). + // - For export tasks, the list contains paths on the Amazon FSx file system + // from which the files are exported to the Amazon S3 bucket. The default path is + // the file system root directory. The paths you provide need to be relative to the + // mount point of the file system. If the mount point is /mnt/fsx and + // /mnt/fsx/path1 is a directory or file on the file system you want to export, + // then the path to provide is path1 . + // - For import tasks, the list contains paths in the Amazon S3 bucket from + // which POSIX metadata changes are imported to the Amazon FSx file system. The + // path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where + // myPrefix is optional). Paths []string // A list of Tag values, with a maximum of 50 elements. diff --git a/service/fsx/api_op_CreateFileCache.go b/service/fsx/api_op_CreateFileCache.go index c2864947ac3..eedcb7d3512 100644 --- a/service/fsx/api_op_CreateFileCache.go +++ b/service/fsx/api_op_CreateFileCache.go @@ -17,20 +17,16 @@ import ( // idempotent creation. If a cache with the specified client request token exists // and the parameters match, CreateFileCache returns the description of the // existing cache. If a cache with the specified client request token exists and -// the parameters don't match, this call returns IncompatibleParameterError. If a +// the parameters don't match, this call returns IncompatibleParameterError . If a // file cache with the specified client request token doesn't exist, // CreateFileCache does the following: +// - Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an +// initial lifecycle state of CREATING . +// - Returns the description of the cache in JSON format. // -// * Creates a new, empty Amazon File Cache -// resourcewith an assigned ID, and an initial lifecycle state of CREATING. -// -// * -// Returns the description of the cache in JSON format. -// -// The CreateFileCache call -// returns while the cache's lifecycle state is still CREATING. You can check the -// cache creation status by calling the DescribeFileCaches -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) +// The CreateFileCache call returns while the cache's lifecycle state is still +// CREATING . You can check the cache creation status by calling the +// DescribeFileCaches (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) // operation, which returns the cache state along with other information. func (c *Client) CreateFileCache(ctx context.Context, params *CreateFileCacheInput, optFns ...func(*Options)) (*CreateFileCacheOutput, error) { if params == nil { @@ -49,18 +45,18 @@ func (c *Client) CreateFileCache(ctx context.Context, params *CreateFileCacheInp type CreateFileCacheInput struct { - // The type of cache that you're creating, which must be LUSTRE. + // The type of cache that you're creating, which must be LUSTRE . // // This member is required. FileCacheType types.FileCacheType - // Sets the Lustre version for the cache that you're creating, which must be 2.12. + // Sets the Lustre version for the cache that you're creating, which must be 2.12 . // // This member is required. FileCacheTypeVersion *string - // The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, - // 2400 GiB, and increments of 2400 GiB. + // The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 + // GiB, 2400 GiB, and increments of 2400 GiB. // // This member is required. StorageCapacity *int32 @@ -74,12 +70,12 @@ type CreateFileCacheInput struct { // An idempotency token for resource creation, in a string of up to 63 ASCII // characters. This token is automatically filled on your behalf when you use the // Command Line Interface (CLI) or an Amazon Web Services SDK. By using the - // idempotent operation, you can retry a CreateFileCache operation without the risk - // of creating an extra cache. This approach can be useful when an initial call - // fails in a way that makes it unclear whether a cache was created. Examples are - // if a transport level timeout occurred, or your connection was reset. If you use - // the same client request token and the initial call created a cache, the client - // receives success as long as the parameters are the same. + // idempotent operation, you can retry a CreateFileCache operation without the + // risk of creating an extra cache. This approach can be useful when an initial + // call fails in a way that makes it unclear whether a cache was created. Examples + // are if a transport level timeout occurred, or your connection was reset. If you + // use the same client request token and the initial call created a cache, the + // client receives success as long as the parameters are the same. ClientRequestToken *string // A boolean flag indicating whether tags for the cache should be copied to data @@ -89,25 +85,20 @@ type CreateFileCacheInput struct { // A list of up to 8 configurations for data repository associations (DRAs) to be // created during the cache creation. The DRAs link the cache to either an Amazon // S3 data repository or a Network File System (NFS) data repository that supports - // the NFSv3 protocol. The DRA configurations must meet the following - // requirements: - // - // * All configurations on the list must be of the same data - // repository type, either all S3 or all NFS. A cache can't link to different data - // repository types at the same time. - // - // * An NFS DRA must link to an NFS file system - // that supports the NFSv3 protocol. + // the NFSv3 protocol. The DRA configurations must meet the following requirements: // - // DRA automatic import and automatic export is - // not supported. + // - All configurations on the list must be of the same data repository type, + // either all S3 or all NFS. A cache can't link to different data repository types + // at the same time. + // - An NFS DRA must link to an NFS file system that supports the NFSv3 + // protocol. + // DRA automatic import and automatic export is not supported. DataRepositoryAssociations []types.FileCacheDataRepositoryAssociation // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon - // FSx-managed KMS key for your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // FSx-managed KMS key for your account is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The configuration for the Amazon File Cache resource being created. diff --git a/service/fsx/api_op_CreateFileSystem.go b/service/fsx/api_op_CreateFileSystem.go index ec9b031ebe7..4172ccd98db 100644 --- a/service/fsx/api_op_CreateFileSystem.go +++ b/service/fsx/api_op_CreateFileSystem.go @@ -14,44 +14,33 @@ import ( // Creates a new, empty Amazon FSx file system. You can create the following // supported Amazon FSx file systems using the CreateFileSystem API operation: +// - Amazon FSx for Lustre +// - Amazon FSx for NetApp ONTAP +// - Amazon FSx for OpenZFS +// - Amazon FSx for Windows File Server // -// * -// Amazon FSx for Lustre +// This operation requires a client request token in the request that Amazon FSx +// uses to ensure idempotent creation. This means that calling the operation +// multiple times with the same client request token has no effect. By using the +// idempotent operation, you can retry a CreateFileSystem operation without the +// risk of creating an extra file system. This approach can be useful when an +// initial call fails in a way that makes it unclear whether a file system was +// created. Examples are if a transport level timeout occurred, or your connection +// was reset. If you use the same client request token and the initial call created +// a file system, the client receives success as long as the parameters are the +// same. If a file system with the specified client request token exists and the +// parameters match, CreateFileSystem returns the description of the existing file +// system. If a file system with the specified client request token exists and the +// parameters don't match, this call returns IncompatibleParameterError . If a file +// system with the specified client request token doesn't exist, CreateFileSystem +// does the following: +// - Creates a new, empty Amazon FSx file system with an assigned ID, and an +// initial lifecycle state of CREATING . +// - Returns the description of the file system in JSON format. // -// * Amazon FSx for NetApp ONTAP -// -// * Amazon FSx for -// OpenZFS -// -// * Amazon FSx for Windows File Server -// -// This operation requires a client -// request token in the request that Amazon FSx uses to ensure idempotent creation. -// This means that calling the operation multiple times with the same client -// request token has no effect. By using the idempotent operation, you can retry a -// CreateFileSystem operation without the risk of creating an extra file system. -// This approach can be useful when an initial call fails in a way that makes it -// unclear whether a file system was created. Examples are if a transport level -// timeout occurred, or your connection was reset. If you use the same client -// request token and the initial call created a file system, the client receives -// success as long as the parameters are the same. If a file system with the -// specified client request token exists and the parameters match, CreateFileSystem -// returns the description of the existing file system. If a file system with the -// specified client request token exists and the parameters don't match, this call -// returns IncompatibleParameterError. If a file system with the specified client -// request token doesn't exist, CreateFileSystem does the following: -// -// * Creates a -// new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle -// state of CREATING. -// -// * Returns the description of the file system in JSON -// format. -// -// The CreateFileSystem call returns while the file system's lifecycle -// state is still CREATING. You can check the file-system creation status by -// calling the DescribeFileSystems -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) +// The CreateFileSystem call returns while the file system's lifecycle state is +// still CREATING . You can check the file-system creation status by calling the +// DescribeFileSystems (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) // operation, which returns the file system state along with other information. func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemInput, optFns ...func(*Options)) (*CreateFileSystemOutput, error) { if params == nil { @@ -71,8 +60,8 @@ func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemI // The request object used to create a new Amazon FSx file system. type CreateFileSystemInput struct { - // The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, - // ONTAP, and OPENZFS. + // The type of Amazon FSx file system to create. Valid values are WINDOWS , LUSTRE + // , ONTAP , and OPENZFS . // // This member is required. FileSystemType types.FileSystemType @@ -80,31 +69,23 @@ type CreateFileSystemInput struct { // Sets the storage capacity of the file system that you're creating, in gibibytes // (GiB). FSx for Lustre file systems - The amount of storage capacity that you can // configure depends on the value that you set for StorageType and the Lustre - // DeploymentType, as follows: - // - // * For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 - // deployment types using SSD storage type, the valid values are 1200 GiB, 2400 - // GiB, and increments of 2400 GiB. - // - // * For PERSISTENT_1 HDD file systems, valid - // values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of - // 1800 GiB for 40 MB/s/TiB file systems. - // - // * For SCRATCH_1 deployment type, valid - // values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. - // - // FSx for ONTAP file - // systems - The amount of storage capacity that you can configure is from 1024 GiB - // up to 196,608 GiB (192 TiB). FSx for OpenZFS file systems - The amount of - // storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 - // TiB). FSx for Windows File Server file systems - The amount of storage capacity - // that you can configure depends on the value that you set for StorageType as - // follows: - // - // * For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - // - // * For - // HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). + // DeploymentType , as follows: + // - For SCRATCH_2 , PERSISTENT_2 and PERSISTENT_1 deployment types using SSD + // storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 + // GiB. + // - For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB + // for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file + // systems. + // - For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and + // increments of 3600 GiB. + // FSx for ONTAP file systems - The amount of storage capacity that you can + // configure is from 1024 GiB up to 196,608 GiB (192 TiB). FSx for OpenZFS file + // systems - The amount of storage capacity that you can configure is from 64 GiB + // up to 524,288 GiB (512 TiB). FSx for Windows File Server file systems - The + // amount of storage capacity that you can configure depends on the value that you + // set for StorageType as follows: + // - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). + // - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). // // This member is required. StorageCapacity *int32 @@ -115,11 +96,9 @@ type CreateFileSystemInput struct { // specify one of these subnets as the preferred subnet using the // WindowsConfiguration > PreferredSubnetID or OntapConfiguration > // PreferredSubnetID properties. For more information about Multi-AZ file system - // configuration, see Availability and durability: Single-AZ and Multi-AZ file - // systems - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) - // in the Amazon FSx for Windows User Guide and Availability and durability - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) + // configuration, see Availability and durability: Single-AZ and Multi-AZ file + // systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) + // in the Amazon FSx for Windows User Guide and Availability and durability (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) // in the Amazon FSx for ONTAP User Guide. For Windows SINGLE_AZ_1 and SINGLE_AZ_2 // and all Lustre deployment types, provide exactly one subnet ID. The file server // is launched in that subnet's Availability Zone. @@ -132,59 +111,40 @@ type CreateFileSystemInput struct { // Command Line Interface (CLI) or an Amazon Web Services SDK. ClientRequestToken *string - // (Optional) For FSx for Lustre file systems, sets the Lustre version for the file - // system that you're creating. Valid values are 2.10 and 2.12: - // - // * 2.10 is - // supported by the Scratch and Persistent_1 Lustre deployment types. - // - // * 2.12 is - // supported by all Lustre deployment types. 2.12 is required when setting FSx for - // Lustre DeploymentType to PERSISTENT_2. - // - // Default value = 2.10, except when - // DeploymentType is set to PERSISTENT_2, then the default is 2.12. If you set - // FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the - // CreateFileSystem operation fails. + // (Optional) For FSx for Lustre file systems, sets the Lustre version for the + // file system that you're creating. Valid values are 2.10 and 2.12 : + // - 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types. + // - 2.12 is supported by all Lustre deployment types. 2.12 is required when + // setting FSx for Lustre DeploymentType to PERSISTENT_2 . + // Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then + // the default is 2.12 . If you set FileSystemTypeVersion to 2.10 for a + // PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails. FileSystemTypeVersion *string // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on Amazon FSx file systems, as follows: - // - // * Amazon FSx for Lustre - // PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 - // types are encrypted using the Amazon FSx service KMS key for your account. - // - // * - // Amazon FSx for NetApp ONTAP - // - // * Amazon FSx for OpenZFS - // - // * Amazon FSx for Windows - // File Server - // - // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for - // your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. + // SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS + // key for your account. + // - Amazon FSx for NetApp ONTAP + // - Amazon FSx for OpenZFS + // - Amazon FSx for Windows File Server + // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account + // is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The Lustre configuration for the file system being created. The following // parameters are not supported for file systems with a data repository association // created with . - // - // * AutoImportPolicy - // - // * ExportPath - // - // * ImportedChunkSize - // - // * - // ImportPath + // - AutoImportPolicy + // - ExportPath + // - ImportedChunkSize + // - ImportPath LustreConfiguration *types.CreateFileSystemLustreConfiguration - // The ONTAP configuration properties of the FSx for ONTAP file system that you are - // creating. + // The ONTAP configuration properties of the FSx for ONTAP file system that you + // are creating. OntapConfiguration *types.CreateFileSystemOntapConfiguration // The OpenZFS configuration for the file system that's being created. @@ -195,21 +155,15 @@ type CreateFileSystemInput struct { // describe the file system. SecurityGroupIds []string - // Sets the storage type for the file system that you're creating. Valid values are - // SSD and HDD. - // - // * Set to SSD to use solid state drive storage. SSD is supported on - // all Windows, Lustre, ONTAP, and OpenZFS deployment types. - // - // * Set to HDD to use - // hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows - // file system deployment types, and on PERSISTENT_1 Lustre file system deployment - // types. - // - // Default value is SSD. For more information, see Storage type options - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) - // in the FSx for Windows File Server User Guide and Multiple storage options - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) + // Sets the storage type for the file system that you're creating. Valid values + // are SSD and HDD . + // - Set to SSD to use solid state drive storage. SSD is supported on all + // Windows, Lustre, ONTAP, and OpenZFS deployment types. + // - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 + // and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 + // Lustre file system deployment types. + // Default value is SSD . For more information, see Storage type options (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) + // in the FSx for Windows File Server User Guide and Multiple storage options (https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) // in the FSx for Lustre User Guide. StorageType types.StorageType diff --git a/service/fsx/api_op_CreateFileSystemFromBackup.go b/service/fsx/api_op_CreateFileSystemFromBackup.go index f1840328062..95b8913ed15 100644 --- a/service/fsx/api_op_CreateFileSystemFromBackup.go +++ b/service/fsx/api_op_CreateFileSystemFromBackup.go @@ -17,29 +17,24 @@ import ( // system with the specified client request token exists and the parameters match, // this operation returns the description of the file system. If a file system with // the specified client request token exists but the parameters don't match, this -// call returns IncompatibleParameterError. If a file system with the specified +// call returns IncompatibleParameterError . If a file system with the specified // client request token doesn't exist, this operation does the following: +// - Creates a new Amazon FSx file system from backup with an assigned ID, and +// an initial lifecycle state of CREATING . +// - Returns the description of the file system. // -// * -// Creates a new Amazon FSx file system from backup with an assigned ID, and an -// initial lifecycle state of CREATING. -// -// * Returns the description of the file -// system. -// -// Parameters like the Active Directory, default share name, automatic -// backup, and backup settings default to the parameters of the file system that -// was backed up, unless overridden. You can explicitly supply other settings. By -// using the idempotent operation, you can retry a CreateFileSystemFromBackup call -// without the risk of creating an extra file system. This approach can be useful -// when an initial call fails in a way that makes it unclear whether a file system -// was created. Examples are if a transport level timeout occurred, or your -// connection was reset. If you use the same client request token and the initial -// call created a file system, the client receives a success message as long as the -// parameters are the same. The CreateFileSystemFromBackup call returns while the -// file system's lifecycle state is still CREATING. You can check the file-system -// creation status by calling the DescribeFileSystems -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) +// Parameters like the Active Directory, default share name, automatic backup, and +// backup settings default to the parameters of the file system that was backed up, +// unless overridden. You can explicitly supply other settings. By using the +// idempotent operation, you can retry a CreateFileSystemFromBackup call without +// the risk of creating an extra file system. This approach can be useful when an +// initial call fails in a way that makes it unclear whether a file system was +// created. Examples are if a transport level timeout occurred, or your connection +// was reset. If you use the same client request token and the initial call created +// a file system, the client receives a success message as long as the parameters +// are the same. The CreateFileSystemFromBackup call returns while the file +// system's lifecycle state is still CREATING . You can check the file-system +// creation status by calling the DescribeFileSystems (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) // operation, which returns the file system state along with other information. func (c *Client) CreateFileSystemFromBackup(ctx context.Context, params *CreateFileSystemFromBackupInput, optFns ...func(*Options)) (*CreateFileSystemFromBackupOutput, error) { if params == nil { @@ -82,7 +77,7 @@ type CreateFileSystemFromBackupInput struct { ClientRequestToken *string // Sets the version for the Amazon FSx for Lustre file system that you're creating - // from a backup. Valid values are 2.10 and 2.12. You don't need to specify + // from a backup. Valid values are 2.10 and 2.12 . You don't need to specify // FileSystemTypeVersion because it will be applied using the backup's // FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion // when creating from backup, the value must match the backup's @@ -91,37 +86,24 @@ type CreateFileSystemFromBackupInput struct { // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on Amazon FSx file systems, as follows: - // - // * Amazon FSx for Lustre - // PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 - // types are encrypted using the Amazon FSx service KMS key for your account. - // - // * - // Amazon FSx for NetApp ONTAP - // - // * Amazon FSx for OpenZFS - // - // * Amazon FSx for Windows - // File Server - // - // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for - // your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. + // SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS + // key for your account. + // - Amazon FSx for NetApp ONTAP + // - Amazon FSx for OpenZFS + // - Amazon FSx for Windows File Server + // If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account + // is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The Lustre configuration for the file system being created. The following // parameters are not supported for file systems with a data repository association // created with . - // - // * AutoImportPolicy - // - // * ExportPath - // - // * ImportedChunkSize - // - // * - // ImportPath + // - AutoImportPolicy + // - ExportPath + // - ImportedChunkSize + // - ImportPath LustreConfiguration *types.CreateFileSystemLustreConfiguration // The OpenZFS configuration for the file system that's being created. @@ -133,36 +115,31 @@ type CreateFileSystemFromBackupInput struct { // requests. SecurityGroupIds []string - // Sets the storage capacity of the OpenZFS file system that you're creating from a - // backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 - // TiB). However, the value that you specify must be equal to or greater than the - // backup's storage capacity value. If you don't use the StorageCapacity parameter, - // the default is the backup's StorageCapacity value. If used to create a file - // system other than OpenZFS, you must provide a value that matches the backup's - // StorageCapacity value. If you provide any other value, Amazon FSx responds with - // a 400 Bad Request. + // Sets the storage capacity of the OpenZFS file system that you're creating from + // a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB + // (512 TiB). However, the value that you specify must be equal to or greater than + // the backup's storage capacity value. If you don't use the StorageCapacity + // parameter, the default is the backup's StorageCapacity value. If used to create + // a file system other than OpenZFS, you must provide a value that matches the + // backup's StorageCapacity value. If you provide any other value, Amazon FSx + // responds with a 400 Bad Request. StorageCapacity *int32 // Sets the storage type for the Windows or OpenZFS file system that you're - // creating from a backup. Valid values are SSD and HDD. - // - // * Set to SSD to use solid - // state drive storage. SSD is supported on all Windows and OpenZFS deployment - // types. - // - // * Set to HDD to use hard disk drive storage. HDD is supported on - // SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment - // types. - // - // The default value is SSD. HDD and SSD storage types have different - // minimum storage capacity requirements. A restored file system's storage capacity - // is tied to the file system that was backed up. You can create a file system that - // uses HDD storage from a backup of a file system that used SSD storage if the - // original SSD file system had a storage capacity of at least 2000 GiB. + // creating from a backup. Valid values are SSD and HDD . + // - Set to SSD to use solid state drive storage. SSD is supported on all Windows + // and OpenZFS deployment types. + // - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 + // and MULTI_AZ_1 FSx for Windows File Server file system deployment types. + // The default value is SSD . HDD and SSD storage types have different minimum + // storage capacity requirements. A restored file system's storage capacity is tied + // to the file system that was backed up. You can create a file system that uses + // HDD storage from a backup of a file system that used SSD storage if the original + // SSD file system had a storage capacity of at least 2000 GiB. StorageType types.StorageType - // The tags to be applied to the file system at file system creation. The key value - // of the Name tag appears in the console as the file system name. + // The tags to be applied to the file system at file system creation. The key + // value of the Name tag appears in the console as the file system name. Tags []types.Tag // The configuration for this Microsoft Windows file system. diff --git a/service/fsx/api_op_CreateSnapshot.go b/service/fsx/api_op_CreateSnapshot.go index 314aa5febd0..6a92b37f203 100644 --- a/service/fsx/api_op_CreateSnapshot.go +++ b/service/fsx/api_op_CreateSnapshot.go @@ -12,30 +12,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, -// you can easily undo file changes and compare file versions by restoring the -// volume to a previous version. If a snapshot with the specified client request -// token exists, and the parameters match, this operation returns the description -// of the existing snapshot. If a snapshot with the specified client request token -// exists, and the parameters don't match, this operation returns -// IncompatibleParameterError. If a snapshot with the specified client request -// token doesn't exist, CreateSnapshot does the following: +// Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With +// snapshots, you can easily undo file changes and compare file versions by +// restoring the volume to a previous version. If a snapshot with the specified +// client request token exists, and the parameters match, this operation returns +// the description of the existing snapshot. If a snapshot with the specified +// client request token exists, and the parameters don't match, this operation +// returns IncompatibleParameterError . If a snapshot with the specified client +// request token doesn't exist, CreateSnapshot does the following: +// - Creates a new OpenZFS snapshot with an assigned ID, and an initial +// lifecycle state of CREATING . +// - Returns the description of the snapshot. // -// * Creates a new OpenZFS -// snapshot with an assigned ID, and an initial lifecycle state of CREATING. -// -// * -// Returns the description of the snapshot. -// -// By using the idempotent operation, you -// can retry a CreateSnapshot operation without the risk of creating an extra -// snapshot. This approach can be useful when an initial call fails in a way that -// makes it unclear whether a snapshot was created. If you use the same client -// request token and the initial call created a snapshot, the operation returns a -// successful result because all the parameters are the same. The CreateSnapshot -// operation returns while the snapshot's lifecycle state is still CREATING. You -// can check the snapshot creation status by calling the DescribeSnapshots -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html) +// By using the idempotent operation, you can retry a CreateSnapshot operation +// without the risk of creating an extra snapshot. This approach can be useful when +// an initial call fails in a way that makes it unclear whether a snapshot was +// created. If you use the same client request token and the initial call created a +// snapshot, the operation returns a successful result because all the parameters +// are the same. The CreateSnapshot operation returns while the snapshot's +// lifecycle state is still CREATING . You can check the snapshot creation status +// by calling the DescribeSnapshots (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html) // operation, which returns the snapshot state along with other information. func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { diff --git a/service/fsx/api_op_CreateStorageVirtualMachine.go b/service/fsx/api_op_CreateStorageVirtualMachine.go index 08d21376993..454799fa49a 100644 --- a/service/fsx/api_op_CreateStorageVirtualMachine.go +++ b/service/fsx/api_op_CreateStorageVirtualMachine.go @@ -53,18 +53,14 @@ type CreateStorageVirtualMachineInput struct { // The security style of the root volume of the SVM. Specify one of the following // values: - // - // * UNIX if the file system is managed by a UNIX administrator, the - // majority of users are NFS clients, and an application accessing the data uses a - // UNIX user as the service account. - // - // * NTFS if the file system is managed by a - // Windows administrator, the majority of users are SMB clients, and an application - // accessing the data uses a Windows user as the service account. - // - // * MIXED if the - // file system is managed by both UNIX and Windows administrators and users consist - // of both NFS and SMB clients. + // - UNIX if the file system is managed by a UNIX administrator, the majority of + // users are NFS clients, and an application accessing the data uses a UNIX user as + // the service account. + // - NTFS if the file system is managed by a Windows administrator, the majority + // of users are SMB clients, and an application accessing the data uses a Windows + // user as the service account. + // - MIXED if the file system is managed by both UNIX and Windows administrators + // and users consist of both NFS and SMB clients. RootVolumeSecurityStyle types.StorageVirtualMachineRootVolumeSecurityStyle // The password to use when managing the SVM using the NetApp ONTAP CLI or REST @@ -80,8 +76,8 @@ type CreateStorageVirtualMachineInput struct { type CreateStorageVirtualMachineOutput struct { - // Returned after a successful CreateStorageVirtualMachine operation; describes the - // SVM just created. + // Returned after a successful CreateStorageVirtualMachine operation; describes + // the SVM just created. StorageVirtualMachine *types.StorageVirtualMachine // Metadata pertaining to the operation's result. diff --git a/service/fsx/api_op_CreateVolumeFromBackup.go b/service/fsx/api_op_CreateVolumeFromBackup.go index 8dbd486caaa..380789e449d 100644 --- a/service/fsx/api_op_CreateVolumeFromBackup.go +++ b/service/fsx/api_op_CreateVolumeFromBackup.go @@ -57,8 +57,8 @@ type CreateVolumeFromBackupInput struct { type CreateVolumeFromBackupOutput struct { - // Returned after a successful CreateVolumeFromBackup API operation, describing the - // volume just created. + // Returned after a successful CreateVolumeFromBackup API operation, describing + // the volume just created. Volume *types.Volume // Metadata pertaining to the operation's result. diff --git a/service/fsx/api_op_DeleteBackup.go b/service/fsx/api_op_DeleteBackup.go index 69ebf3721c0..37971e36431 100644 --- a/service/fsx/api_op_DeleteBackup.go +++ b/service/fsx/api_op_DeleteBackup.go @@ -13,9 +13,9 @@ import ( ) // Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and -// its data is gone. The DeleteBackup call returns instantly. The backup won't show -// up in later DescribeBackups calls. The data in a deleted backup is also deleted -// and can't be recovered by any means. +// its data is gone. The DeleteBackup call returns instantly. The backup won't +// show up in later DescribeBackups calls. The data in a deleted backup is also +// deleted and can't be recovered by any means. func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error) { if params == nil { params = &DeleteBackupInput{} @@ -53,8 +53,8 @@ type DeleteBackupOutput struct { // The ID of the backup that was deleted. BackupId *string - // The lifecycle status of the backup. If the DeleteBackup operation is successful, - // the status is DELETED. + // The lifecycle status of the backup. If the DeleteBackup operation is + // successful, the status is DELETED . Lifecycle types.BackupLifecycle // Metadata pertaining to the operation's result. diff --git a/service/fsx/api_op_DeleteDataRepositoryAssociation.go b/service/fsx/api_op_DeleteDataRepositoryAssociation.go index 081a3403e66..c8419d19147 100644 --- a/service/fsx/api_op_DeleteDataRepositoryAssociation.go +++ b/service/fsx/api_op_DeleteDataRepositoryAssociation.go @@ -58,7 +58,7 @@ type DeleteDataRepositoryAssociationOutput struct { AssociationId *string // Indicates whether data in the file system that corresponds to the data - // repository association is being deleted. Default is false. + // repository association is being deleted. Default is false . DeleteDataInFileSystem *bool // Describes the lifecycle state of the data repository association being deleted. diff --git a/service/fsx/api_op_DeleteFileCache.go b/service/fsx/api_op_DeleteFileCache.go index f9cced17f25..a3cf9d19ca0 100644 --- a/service/fsx/api_op_DeleteFileCache.go +++ b/service/fsx/api_op_DeleteFileCache.go @@ -15,8 +15,7 @@ import ( // Deletes an Amazon File Cache resource. After deletion, the cache no longer // exists, and its data is gone. The DeleteFileCache operation returns while the // cache has the DELETING status. You can check the cache deletion status by -// calling the DescribeFileCaches -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) +// calling the DescribeFileCaches (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) // operation, which returns a list of caches in your account. If you pass the cache // ID for a deleted cache, the DescribeFileCaches operation returns a // FileCacheNotFound error. The data in a deleted cache is also deleted and can't @@ -57,7 +56,7 @@ type DeleteFileCacheOutput struct { FileCacheId *string // The cache lifecycle for the deletion request. If the DeleteFileCache operation - // is successful, this status is DELETING. + // is successful, this status is DELETING . Lifecycle types.FileCacheLifecycle // Metadata pertaining to the operation's result. diff --git a/service/fsx/api_op_DeleteFileSystem.go b/service/fsx/api_op_DeleteFileSystem.go index 7d7bef951aa..ce8969b12f0 100644 --- a/service/fsx/api_op_DeleteFileSystem.go +++ b/service/fsx/api_op_DeleteFileSystem.go @@ -12,23 +12,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a file system. After deletion, the file system no longer exists, and its -// data is gone. Any existing automatic backups and snapshots are also deleted. To -// delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes -// and storage virtual machines (SVMs) on the file system. Then provide a +// Deletes a file system. After deletion, the file system no longer exists, and +// its data is gone. Any existing automatic backups and snapshots are also deleted. +// To delete an Amazon FSx for NetApp ONTAP file system, first delete all the +// volumes and storage virtual machines (SVMs) on the file system. Then provide a // FileSystemId value to the DeleFileSystem operation. By default, when you delete // an Amazon FSx for Windows File Server file system, a final backup is created // upon deletion. This final backup isn't subject to the file system's retention // policy, and must be manually deleted. The DeleteFileSystem operation returns // while the file system has the DELETING status. You can check the file system -// deletion status by calling the DescribeFileSystems -// (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) +// deletion status by calling the DescribeFileSystems (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) // operation, which returns a list of file systems in your account. If you pass the // file system ID for a deleted file system, the DescribeFileSystems operation -// returns a FileSystemNotFound error. If a data repository task is in a PENDING or -// EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an -// HTTP status code 400 (Bad Request). The data in a deleted file system is also -// deleted and can't be recovered by any means. +// returns a FileSystemNotFound error. If a data repository task is in a PENDING +// or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail +// with an HTTP status code 400 (Bad Request). The data in a deleted file system is +// also deleted and can't be recovered by any means. func (c *Client) DeleteFileSystem(ctx context.Context, params *DeleteFileSystemInput, optFns ...func(*Options)) (*DeleteFileSystemOutput, error) { if params == nil { params = &DeleteFileSystemInput{} @@ -57,8 +56,8 @@ type DeleteFileSystemInput struct { // Command Line Interface (CLI) or an Amazon Web Services SDK. ClientRequestToken *string - // The configuration object for the Amazon FSx for Lustre file system being deleted - // in the DeleteFileSystem operation. + // The configuration object for the Amazon FSx for Lustre file system being + // deleted in the DeleteFileSystem operation. LustreConfiguration *types.DeleteFileSystemLustreConfiguration // The configuration object for the OpenZFS file system used in the @@ -79,7 +78,7 @@ type DeleteFileSystemOutput struct { FileSystemId *string // The file system lifecycle for the deletion request. If the DeleteFileSystem - // operation is successful, this status is DELETING. + // operation is successful, this status is DELETING . Lifecycle types.FileSystemLifecycle // The response object for the Amazon FSx for Lustre file system being deleted in diff --git a/service/fsx/api_op_DeleteSnapshot.go b/service/fsx/api_op_DeleteSnapshot.go index a211567ca30..32f51d2915f 100644 --- a/service/fsx/api_op_DeleteSnapshot.go +++ b/service/fsx/api_op_DeleteSnapshot.go @@ -50,7 +50,7 @@ type DeleteSnapshotInput struct { type DeleteSnapshotOutput struct { // The lifecycle status of the snapshot. If the DeleteSnapshot operation is - // successful, this status is DELETING. + // successful, this status is DELETING . Lifecycle types.SnapshotLifecycle // The ID of the deleted snapshot. diff --git a/service/fsx/api_op_DeleteStorageVirtualMachine.go b/service/fsx/api_op_DeleteStorageVirtualMachine.go index a0bb5f4676c..c6ba66c9275 100644 --- a/service/fsx/api_op_DeleteStorageVirtualMachine.go +++ b/service/fsx/api_op_DeleteStorageVirtualMachine.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to -// deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the -// operation will fail. +// Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior +// to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise +// the operation will fail. func (c *Client) DeleteStorageVirtualMachine(ctx context.Context, params *DeleteStorageVirtualMachineInput, optFns ...func(*Options)) (*DeleteStorageVirtualMachineOutput, error) { if params == nil { params = &DeleteStorageVirtualMachineInput{} diff --git a/service/fsx/api_op_DeleteVolume.go b/service/fsx/api_op_DeleteVolume.go index 05d5ce34096..a1fd4cd9555 100644 --- a/service/fsx/api_op_DeleteVolume.go +++ b/service/fsx/api_op_DeleteVolume.go @@ -55,7 +55,7 @@ type DeleteVolumeInput struct { type DeleteVolumeOutput struct { // The lifecycle state of the volume being deleted. If the DeleteVolume operation - // is successful, this value is DELETING. + // is successful, this value is DELETING . Lifecycle types.VolumeLifecycle // Returned after a DeleteVolume request, showing the status of the delete request. diff --git a/service/fsx/api_op_DescribeBackups.go b/service/fsx/api_op_DescribeBackups.go index 9bf2d15a832..76b7edbc5b6 100644 --- a/service/fsx/api_op_DescribeBackups.go +++ b/service/fsx/api_op_DescribeBackups.go @@ -12,27 +12,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the description of a specific Amazon FSx backup, if a BackupIds value is -// provided for that backup. Otherwise, it returns all backups owned by your Amazon -// Web Services account in the Amazon Web Services Region of the endpoint that -// you're calling. When retrieving all backups, you can optionally specify the +// Returns the description of a specific Amazon FSx backup, if a BackupIds value +// is provided for that backup. Otherwise, it returns all backups owned by your +// Amazon Web Services account in the Amazon Web Services Region of the endpoint +// that you're calling. When retrieving all backups, you can optionally specify the // MaxResults parameter to limit the number of backups in a response. If more // backups remain, Amazon FSx returns a NextToken value in the response. In this -// case, send a later request with the NextToken request parameter set to the value -// of the NextToken value from the last response. This operation is used in an -// iterative process to retrieve a list of your backups. DescribeBackups is called -// first without a NextToken value. Then the operation continues to be called with -// the NextToken parameter set to the value of the last NextToken value until a -// response has no NextToken value. When using this operation, keep the following -// in mind: -// -// * The operation might return fewer than the MaxResults value of backup -// descriptions while still including a NextToken value. -// -// * The order of the -// backups returned in the response of one DescribeBackups call and the order of -// the backups returned across the responses of a multi-call iteration is -// unspecified. +// case, send a later request with the NextToken request parameter set to the +// value of the NextToken value from the last response. This operation is used in +// an iterative process to retrieve a list of your backups. DescribeBackups is +// called first without a NextToken value. Then the operation continues to be +// called with the NextToken parameter set to the value of the last NextToken +// value until a response has no NextToken value. When using this operation, keep +// the following in mind: +// - The operation might return fewer than the MaxResults value of backup +// descriptions while still including a NextToken value. +// - The order of the backups returned in the response of one DescribeBackups +// call and the order of the backups returned across the responses of a multi-call +// iteration is unspecified. func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error) { if params == nil { params = &DescribeBackupsInput{} @@ -51,12 +48,12 @@ func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInp // The request object for the DescribeBackups operation. type DescribeBackupsInput struct { - // The IDs of the backups that you want to retrieve. This parameter value overrides - // any filters. If any IDs aren't found, a BackupNotFound error occurs. + // The IDs of the backups that you want to retrieve. This parameter value + // overrides any filters. If any IDs aren't found, a BackupNotFound error occurs. BackupIds []string - // The filters structure. The supported names are file-system-id, backup-type, - // file-system-type, and volume-id. + // The filters structure. The supported names are file-system-id , backup-type , + // file-system-type , and volume-id . Filters []types.Filter // Maximum number of backups to return in the response. This parameter value must @@ -80,8 +77,8 @@ type DescribeBackupsOutput struct { Backups []types.Backup // A NextToken value is present if there are more backups than returned in the - // response. You can use the NextToken value in the subsequent request to fetch the - // backups. + // response. You can use the NextToken value in the subsequent request to fetch + // the backups. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/fsx/api_op_DescribeDataRepositoryAssociations.go b/service/fsx/api_op_DescribeDataRepositoryAssociations.go index 0c5f077e923..71ff19be17f 100644 --- a/service/fsx/api_op_DescribeDataRepositoryAssociations.go +++ b/service/fsx/api_op_DescribeDataRepositoryAssociations.go @@ -16,12 +16,12 @@ import ( // data repository associations, if one or more AssociationIds values are provided // in the request, or if filters are used in the request. Data repository // associations are supported on Amazon File Cache resources and all Amazon FSx for -// Lustre file systems excluding Scratch_1 deployment types. You can use filters to -// narrow the response to include just data repository associations for specific +// Lustre file systems excluding Scratch_1 deployment types. You can use filters +// to narrow the response to include just data repository associations for specific // file systems (use the file-system-id filter with the ID of the file system) or // caches (use the file-cache-id filter with the ID of the cache), or data // repository associations for a specific repository type (use the -// data-repository-type filter with a value of S3 or NFS). If you don't use +// data-repository-type filter with a value of S3 or NFS ). If you don't use // filters, the response returns all data repository associations owned by your // Amazon Web Services account in the Amazon Web Services Region of the endpoint // that you're calling. When retrieving all data repository associations, you can @@ -54,8 +54,8 @@ type DescribeDataRepositoryAssociationsInput struct { // A list of Filter elements. Filters []types.Filter - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -153,8 +153,8 @@ var _ DescribeDataRepositoryAssociationsAPIClient = (*Client)(nil) // DescribeDataRepositoryAssociationsPaginatorOptions is the paginator options for // DescribeDataRepositoryAssociations type DescribeDataRepositoryAssociationsPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DescribeDataRepositoryTasks.go b/service/fsx/api_op_DescribeDataRepositoryTasks.go index d023efeb10b..c117830ac78 100644 --- a/service/fsx/api_op_DescribeDataRepositoryTasks.go +++ b/service/fsx/api_op_DescribeDataRepositoryTasks.go @@ -45,8 +45,8 @@ type DescribeDataRepositoryTasksInput struct { // lifecycle state. Filters []types.DataRepositoryTaskFilter - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -147,8 +147,8 @@ var _ DescribeDataRepositoryTasksAPIClient = (*Client)(nil) // DescribeDataRepositoryTasksPaginatorOptions is the paginator options for // DescribeDataRepositoryTasks type DescribeDataRepositoryTasksPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DescribeFileCaches.go b/service/fsx/api_op_DescribeFileCaches.go index 134f8ca9d99..15fc03687f6 100644 --- a/service/fsx/api_op_DescribeFileCaches.go +++ b/service/fsx/api_op_DescribeFileCaches.go @@ -22,17 +22,15 @@ import ( // send a later request with the NextToken request parameter set to the value of // NextToken from the last response. This operation is used in an iterative process // to retrieve a list of your cache descriptions. DescribeFileCaches is called -// first without a NextTokenvalue. Then the operation continues to be called with +// first without a NextToken value. Then the operation continues to be called with // the NextToken parameter set to the value of the last NextToken value until a -// response has no NextToken. When using this operation, keep the following in +// response has no NextToken . When using this operation, keep the following in // mind: -// -// * The implementation might return fewer than MaxResults cache -// descriptions while still including a NextToken value. -// -// * The order of caches -// returned in the response of one DescribeFileCaches call and the order of caches -// returned across the responses of a multicall iteration is unspecified. +// - The implementation might return fewer than MaxResults cache descriptions +// while still including a NextToken value. +// - The order of caches returned in the response of one DescribeFileCaches call +// and the order of caches returned across the responses of a multicall iteration +// is unspecified. func (c *Client) DescribeFileCaches(ctx context.Context, params *DescribeFileCachesInput, optFns ...func(*Options)) (*DescribeFileCachesOutput, error) { if params == nil { params = &DescribeFileCachesInput{} @@ -53,8 +51,8 @@ type DescribeFileCachesInput struct { // IDs of the caches whose descriptions you want to retrieve (String). FileCacheIds []string - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -152,8 +150,8 @@ var _ DescribeFileCachesAPIClient = (*Client)(nil) // DescribeFileCachesPaginatorOptions is the paginator options for // DescribeFileCaches type DescribeFileCachesPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DescribeFileSystemAliases.go b/service/fsx/api_op_DescribeFileSystemAliases.go index 618c8d3e78f..e0c1fc65c8f 100644 --- a/service/fsx/api_op_DescribeFileSystemAliases.go +++ b/service/fsx/api_op_DescribeFileSystemAliases.go @@ -61,8 +61,8 @@ type DescribeFileSystemAliasesInput struct { // The response object for DescribeFileSystemAliases operation. type DescribeFileSystemAliasesOutput struct { - // An array of one or more DNS aliases currently associated with the specified file - // system. + // An array of one or more DNS aliases currently associated with the specified + // file system. Aliases []types.Alias // Present if there are more DNS aliases than returned in the response (String). diff --git a/service/fsx/api_op_DescribeFileSystems.go b/service/fsx/api_op_DescribeFileSystems.go index 3af38e6877b..dd3397ed274 100644 --- a/service/fsx/api_op_DescribeFileSystems.go +++ b/service/fsx/api_op_DescribeFileSystems.go @@ -18,22 +18,19 @@ import ( // Services Region of the endpoint that you're calling. When retrieving all file // system descriptions, you can optionally specify the MaxResults parameter to // limit the number of descriptions in a response. If more file system descriptions -// remain, Amazon FSx returns a NextToken value in the response. In this case, send -// a later request with the NextToken request parameter set to the value of +// remain, Amazon FSx returns a NextToken value in the response. In this case, +// send a later request with the NextToken request parameter set to the value of // NextToken from the last response. This operation is used in an iterative process // to retrieve a list of your file system descriptions. DescribeFileSystems is -// called first without a NextTokenvalue. Then the operation continues to be called -// with the NextToken parameter set to the value of the last NextToken value until -// a response has no NextToken. When using this operation, keep the following in -// mind: -// -// * The implementation might return fewer than MaxResults file system -// descriptions while still including a NextToken value. -// -// * The order of file -// systems returned in the response of one DescribeFileSystems call and the order -// of file systems returned across the responses of a multicall iteration is -// unspecified. +// called first without a NextToken value. Then the operation continues to be +// called with the NextToken parameter set to the value of the last NextToken +// value until a response has no NextToken . When using this operation, keep the +// following in mind: +// - The implementation might return fewer than MaxResults file system +// descriptions while still including a NextToken value. +// - The order of file systems returned in the response of one +// DescribeFileSystems call and the order of file systems returned across the +// responses of a multicall iteration is unspecified. func (c *Client) DescribeFileSystems(ctx context.Context, params *DescribeFileSystemsInput, optFns ...func(*Options)) (*DescribeFileSystemsOutput, error) { if params == nil { params = &DescribeFileSystemsInput{} @@ -145,8 +142,8 @@ func (c *Client) addOperationDescribeFileSystemsMiddlewares(stack *middleware.St return nil } -// DescribeFileSystemsAPIClient is a client that implements the DescribeFileSystems -// operation. +// DescribeFileSystemsAPIClient is a client that implements the +// DescribeFileSystems operation. type DescribeFileSystemsAPIClient interface { DescribeFileSystems(context.Context, *DescribeFileSystemsInput, ...func(*Options)) (*DescribeFileSystemsOutput, error) } diff --git a/service/fsx/api_op_DescribeSnapshots.go b/service/fsx/api_op_DescribeSnapshots.go index defc14088b0..f5c93f58e75 100644 --- a/service/fsx/api_op_DescribeSnapshots.go +++ b/service/fsx/api_op_DescribeSnapshots.go @@ -22,17 +22,14 @@ import ( // parameter set to the value of NextToken from the last response. Use this // operation in an iterative process to retrieve a list of your snapshots. // DescribeSnapshots is called first without a NextToken value. Then the operation -// continues to be called with the NextToken parameter set to the value of the last -// NextToken value until a response has no NextToken value. When using this +// continues to be called with the NextToken parameter set to the value of the +// last NextToken value until a response has no NextToken value. When using this // operation, keep the following in mind: -// -// * The operation might return fewer than -// the MaxResults value of snapshot descriptions while still including a NextToken -// value. -// -// * The order of snapshots returned in the response of one -// DescribeSnapshots call and the order of backups returned across the responses of -// a multi-call iteration is unspecified. +// - The operation might return fewer than the MaxResults value of snapshot +// descriptions while still including a NextToken value. +// - The order of snapshots returned in the response of one DescribeSnapshots +// call and the order of backups returned across the responses of a multi-call +// iteration is unspecified. func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} @@ -50,11 +47,11 @@ func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshot type DescribeSnapshotsInput struct { - // The filters structure. The supported names are file-system-id or volume-id. + // The filters structure. The supported names are file-system-id or volume-id . Filters []types.SnapshotFilter - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -155,8 +152,8 @@ var _ DescribeSnapshotsAPIClient = (*Client)(nil) // DescribeSnapshotsPaginatorOptions is the paginator options for DescribeSnapshots type DescribeSnapshotsPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DescribeStorageVirtualMachines.go b/service/fsx/api_op_DescribeStorageVirtualMachines.go index 6d84f476278..7b9982ceae4 100644 --- a/service/fsx/api_op_DescribeStorageVirtualMachines.go +++ b/service/fsx/api_op_DescribeStorageVirtualMachines.go @@ -34,8 +34,8 @@ type DescribeStorageVirtualMachinesInput struct { // Enter a filter name:value pair to view a select set of SVMs. Filters []types.StorageVirtualMachineFilter - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -56,8 +56,8 @@ type DescribeStorageVirtualMachinesOutput struct { // request, where the previous NextToken value left off. NextToken *string - // Returned after a successful DescribeStorageVirtualMachines operation, describing - // each SVM. + // Returned after a successful DescribeStorageVirtualMachines operation, + // describing each SVM. StorageVirtualMachines []types.StorageVirtualMachine // Metadata pertaining to the operation's result. @@ -137,8 +137,8 @@ var _ DescribeStorageVirtualMachinesAPIClient = (*Client)(nil) // DescribeStorageVirtualMachinesPaginatorOptions is the paginator options for // DescribeStorageVirtualMachines type DescribeStorageVirtualMachinesPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DescribeVolumes.go b/service/fsx/api_op_DescribeVolumes.go index f1d9888e450..03dcf7ac1ef 100644 --- a/service/fsx/api_op_DescribeVolumes.go +++ b/service/fsx/api_op_DescribeVolumes.go @@ -34,8 +34,8 @@ type DescribeVolumesInput struct { // Enter a filter Name and Values pair to view a select set of volumes. Filters []types.VolumeFilter - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. MaxResults *int32 // (Optional) Opaque pagination token returned from a previous operation (String). @@ -135,8 +135,8 @@ var _ DescribeVolumesAPIClient = (*Client)(nil) // DescribeVolumesPaginatorOptions is the paginator options for DescribeVolumes type DescribeVolumesPaginatorOptions struct { - // The maximum number of resources to return in the response. This value must be an - // integer greater than zero. + // The maximum number of resources to return in the response. This value must be + // an integer greater than zero. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fsx/api_op_DisassociateFileSystemAliases.go b/service/fsx/api_op_DisassociateFileSystemAliases.go index 7c0197fe6ba..ceefc7f9979 100644 --- a/service/fsx/api_op_DisassociateFileSystemAliases.go +++ b/service/fsx/api_op_DisassociateFileSystemAliases.go @@ -16,9 +16,8 @@ import ( // (DNS) aliases from an Amazon FSx for Windows File Server file system. If you // attempt to disassociate a DNS alias that is not associated with the file system, // Amazon FSx responds with a 400 Bad Request. For more information, see Working -// with DNS Aliases -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html). -// The system generated response showing the DNS aliases that Amazon FSx is +// with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) +// . The system generated response showing the DNS aliases that Amazon FSx is // attempting to disassociate from the file system. Use the API operation to // monitor the status of the aliases Amazon FSx is disassociating with the file // system. @@ -37,8 +36,8 @@ func (c *Client) DisassociateFileSystemAliases(ctx context.Context, params *Disa return out, nil } -// The request object of DNS aliases to disassociate from an Amazon FSx for Windows -// File Server file system. +// The request object of DNS aliases to disassociate from an Amazon FSx for +// Windows File Server file system. type DisassociateFileSystemAliasesInput struct { // An array of one or more DNS alias names to disassociate, or remove, from the diff --git a/service/fsx/api_op_ListTagsForResource.go b/service/fsx/api_op_ListTagsForResource.go index cb049b19c7f..da3bbb6f5c9 100644 --- a/service/fsx/api_op_ListTagsForResource.go +++ b/service/fsx/api_op_ListTagsForResource.go @@ -18,17 +18,15 @@ import ( // response. In this case, send a later request with the NextToken request // parameter set to the value of NextToken from the last response. This action is // used in an iterative process to retrieve a list of your tags. -// ListTagsForResource is called first without a NextTokenvalue. Then the action -// continues to be called with the NextToken parameter set to the value of the last -// NextToken value until a response has no NextToken. When using this action, keep -// the following in mind: -// -// * The implementation might return fewer than MaxResults -// file system descriptions while still including a NextToken value. -// -// * The order -// of tags returned in the response of one ListTagsForResource call and the order -// of tags returned across the responses of a multi-call iteration is unspecified. +// ListTagsForResource is called first without a NextToken value. Then the action +// continues to be called with the NextToken parameter set to the value of the +// last NextToken value until a response has no NextToken . When using this action, +// keep the following in mind: +// - The implementation might return fewer than MaxResults file system +// descriptions while still including a NextToken value. +// - The order of tags returned in the response of one ListTagsForResource call +// and the order of tags returned across the responses of a multi-call iteration is +// unspecified. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -52,8 +50,8 @@ type ListTagsForResourceInput struct { // This member is required. ResourceARN *string - // Maximum number of tags to return in the response (integer). This parameter value - // must be greater than 0. The number of items that Amazon FSx returns is the + // Maximum number of tags to return in the response (integer). This parameter + // value must be greater than 0. The number of items that Amazon FSx returns is the // minimum of the MaxResults parameter specified in the request and the service's // internal maximum number of items per page. MaxResults *int32 @@ -145,8 +143,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -156,8 +154,8 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) // ListTagsForResourcePaginatorOptions is the paginator options for // ListTagsForResource type ListTagsForResourcePaginatorOptions struct { - // Maximum number of tags to return in the response (integer). This parameter value - // must be greater than 0. The number of items that Amazon FSx returns is the + // Maximum number of tags to return in the response (integer). This parameter + // value must be greater than 0. The number of items that Amazon FSx returns is the // minimum of the MaxResults parameter specified in the request and the service's // internal maximum number of items per page. Limit int32 diff --git a/service/fsx/api_op_RestoreVolumeFromSnapshot.go b/service/fsx/api_op_RestoreVolumeFromSnapshot.go index e5f5694ac22..adc49fac9c8 100644 --- a/service/fsx/api_op_RestoreVolumeFromSnapshot.go +++ b/service/fsx/api_op_RestoreVolumeFromSnapshot.go @@ -48,16 +48,12 @@ type RestoreVolumeFromSnapshotInput struct { ClientRequestToken *string // The settings used when restoring the specified volume from snapshot. - // - // * - // DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and - // the specified snapshot. If there are intermediate snapshots and this option - // isn't used, RestoreVolumeFromSnapshot fails. - // - // * DELETE_CLONED_VOLUMES - Deletes - // any dependent clone volumes created from intermediate snapshots. If there are - // any dependent clone volumes and this option isn't used, - // RestoreVolumeFromSnapshot fails. + // - DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state + // and the specified snapshot. If there are intermediate snapshots and this option + // isn't used, RestoreVolumeFromSnapshot fails. + // - DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from + // intermediate snapshots. If there are any dependent clone volumes and this option + // isn't used, RestoreVolumeFromSnapshot fails. Options []types.RestoreOpenZFSVolumeOption noSmithyDocumentSerde diff --git a/service/fsx/api_op_UpdateFileSystem.go b/service/fsx/api_op_UpdateFileSystem.go index 760088e1aeb..39d1f25bcdd 100644 --- a/service/fsx/api_op_UpdateFileSystem.go +++ b/service/fsx/api_op_UpdateFileSystem.go @@ -15,89 +15,43 @@ import ( // Use this operation to update the configuration of an existing Amazon FSx file // system. You can update multiple properties in a single request. For FSx for // Windows File Server file systems, you can update the following properties: -// -// * -// AuditLogConfiguration -// -// * AutomaticBackupRetentionDays -// -// * -// DailyAutomaticBackupStartTime -// -// * SelfManagedActiveDirectoryConfiguration -// -// * -// StorageCapacity -// -// * ThroughputCapacity -// -// * WeeklyMaintenanceStartTime -// -// For FSx for -// Lustre file systems, you can update the following properties: -// -// * -// AutoImportPolicy -// -// * AutomaticBackupRetentionDays -// -// * -// DailyAutomaticBackupStartTime -// -// * DataCompressionType -// -// * -// LustreRootSquashConfiguration -// -// * StorageCapacity -// -// * -// WeeklyMaintenanceStartTime -// -// For FSx for ONTAP file systems, you can update the -// following properties: -// -// * AddRouteTableIds -// -// * AutomaticBackupRetentionDays -// -// * -// DailyAutomaticBackupStartTime -// -// * DiskIopsConfiguration -// -// * FsxAdminPassword -// -// * -// RemoveRouteTableIds -// -// * StorageCapacity -// -// * ThroughputCapacity -// -// * -// WeeklyMaintenanceStartTime -// -// For FSx for OpenZFS file systems, you can update the -// following properties: -// -// * AutomaticBackupRetentionDays -// -// * CopyTagsToBackups -// -// * -// CopyTagsToVolumes -// -// * DailyAutomaticBackupStartTime -// -// * DiskIopsConfiguration -// -// * -// StorageCapacity -// -// * ThroughputCapacity -// -// * WeeklyMaintenanceStartTime +// - AuditLogConfiguration +// - AutomaticBackupRetentionDays +// - DailyAutomaticBackupStartTime +// - SelfManagedActiveDirectoryConfiguration +// - StorageCapacity +// - ThroughputCapacity +// - WeeklyMaintenanceStartTime +// +// For FSx for Lustre file systems, you can update the following properties: +// - AutoImportPolicy +// - AutomaticBackupRetentionDays +// - DailyAutomaticBackupStartTime +// - DataCompressionType +// - LustreRootSquashConfiguration +// - StorageCapacity +// - WeeklyMaintenanceStartTime +// +// For FSx for ONTAP file systems, you can update the following properties: +// - AddRouteTableIds +// - AutomaticBackupRetentionDays +// - DailyAutomaticBackupStartTime +// - DiskIopsConfiguration +// - FsxAdminPassword +// - RemoveRouteTableIds +// - StorageCapacity +// - ThroughputCapacity +// - WeeklyMaintenanceStartTime +// +// For FSx for OpenZFS file systems, you can update the following properties: +// - AutomaticBackupRetentionDays +// - CopyTagsToBackups +// - CopyTagsToVolumes +// - DailyAutomaticBackupStartTime +// - DiskIopsConfiguration +// - StorageCapacity +// - ThroughputCapacity +// - WeeklyMaintenanceStartTime func (c *Client) UpdateFileSystem(ctx context.Context, params *UpdateFileSystemInput, optFns ...func(*Options)) (*UpdateFileSystemOutput, error) { if params == nil { params = &UpdateFileSystemInput{} @@ -141,39 +95,29 @@ type UpdateFileSystemInput struct { // the storage capacity target value, in GiB, to increase the storage capacity for // the file system that you're updating. You can't make a storage capacity increase // request if there is an existing storage capacity increase request in progress. - // For Lustre file systems, the storage capacity target value can be the - // following: - // - // * For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment - // types, valid values are in multiples of 2400 GiB. The value must be greater than - // the current storage capacity. - // - // * For PERSISTENT HDD file systems, valid values - // are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and - // multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values - // must be greater than the current storage capacity. - // - // * For SCRATCH_1 file - // systems, you can't increase the storage capacity. + // For Lustre file systems, the storage capacity target value can be the following: // - // For more information, see - // Managing storage and throughput capacity - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) + // - For SCRATCH_2 , PERSISTENT_1 , and PERSISTENT_2 SSD deployment types, valid + // values are in multiples of 2400 GiB. The value must be greater than the current + // storage capacity. + // - For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for + // 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps + // throughput per TiB file systems. The values must be greater than the current + // storage capacity. + // - For SCRATCH_1 file systems, you can't increase the storage capacity. + // For more information, see Managing storage and throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) // in the FSx for Lustre User Guide. For FSx for OpenZFS file systems, the storage // capacity target value must be at least 10 percent greater than the current - // storage capacity value. For more information, see Managing storage capacity - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html) + // storage capacity value. For more information, see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html) // in the FSx for OpenZFS User Guide. For Windows file systems, the storage // capacity target value must be at least 10 percent greater than the current // storage capacity value. To increase storage capacity, the file system must have // at least 16 MBps of throughput capacity. For more information, see Managing - // storage capacity - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) + // storage capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) // in the Amazon FSx for Windows File Server User Guide. For ONTAP file systems, // the storage capacity target value must be at least 10 percent greater than the // current storage capacity value. For more information, see Managing storage - // capacity and provisioned IOPS - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html) + // capacity and provisioned IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html) // in the Amazon FSx for NetApp ONTAP User Guide. StorageCapacity *int32 diff --git a/service/fsx/api_op_UpdateSnapshot.go b/service/fsx/api_op_UpdateSnapshot.go index 30e7d33a09c..56ae426bf97 100644 --- a/service/fsx/api_op_UpdateSnapshot.go +++ b/service/fsx/api_op_UpdateSnapshot.go @@ -36,7 +36,7 @@ type UpdateSnapshotInput struct { Name *string // The ID of the snapshot that you want to update, in the format - // fsvolsnap-0123456789abcdef0. + // fsvolsnap-0123456789abcdef0 . // // This member is required. SnapshotId *string diff --git a/service/fsx/api_op_UpdateStorageVirtualMachine.go b/service/fsx/api_op_UpdateStorageVirtualMachine.go index a22d122ce83..3f3a5233ff0 100644 --- a/service/fsx/api_op_UpdateStorageVirtualMachine.go +++ b/service/fsx/api_op_UpdateStorageVirtualMachine.go @@ -30,7 +30,7 @@ func (c *Client) UpdateStorageVirtualMachine(ctx context.Context, params *Update type UpdateStorageVirtualMachineInput struct { - // The ID of the SVM that you want to update, in the format svm-0123456789abcdef0. + // The ID of the SVM that you want to update, in the format svm-0123456789abcdef0 . // // This member is required. StorageVirtualMachineId *string diff --git a/service/fsx/api_op_UpdateVolume.go b/service/fsx/api_op_UpdateVolume.go index 52ce5429db0..125ef9b69df 100644 --- a/service/fsx/api_op_UpdateVolume.go +++ b/service/fsx/api_op_UpdateVolume.go @@ -32,7 +32,7 @@ func (c *Client) UpdateVolume(ctx context.Context, params *UpdateVolumeInput, op type UpdateVolumeInput struct { // The ID of the volume that you want to update, in the format - // fsvol-0123456789abcdef0. + // fsvol-0123456789abcdef0 . // // This member is required. VolumeId *string @@ -42,8 +42,8 @@ type UpdateVolumeInput struct { // the Command Line Interface (CLI) or an Amazon Web Services SDK. ClientRequestToken *string - // The name of the OpenZFS volume. OpenZFS root volumes are automatically named - // FSX. Child volume names must be unique among their parent volume's children. The + // The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX + // . Child volume names must be unique among their parent volume's children. The // name of the volume is part of the mount string for the OpenZFS volume. Name *string diff --git a/service/fsx/types/enums.go b/service/fsx/types/enums.go index 4e51df2f0f8..b90d267c2b8 100644 --- a/service/fsx/types/enums.go +++ b/service/fsx/types/enums.go @@ -12,9 +12,9 @@ const ( ActiveDirectoryErrorTypeInvalidDomainStage ActiveDirectoryErrorType = "INVALID_DOMAIN_STAGE" ) -// Values returns all known values for ActiveDirectoryErrorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActiveDirectoryErrorType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ActiveDirectoryErrorType) Values() []ActiveDirectoryErrorType { return []ActiveDirectoryErrorType{ "DOMAIN_NOT_FOUND", @@ -38,9 +38,9 @@ const ( AdministrativeActionTypeVolumeRestore AdministrativeActionType = "VOLUME_RESTORE" ) -// Values returns all known values for AdministrativeActionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AdministrativeActionType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AdministrativeActionType) Values() []AdministrativeActionType { return []AdministrativeActionType{ "FILE_SYSTEM_UPDATE", @@ -202,9 +202,10 @@ const ( DataRepositoryTaskFilterNameFileCacheId DataRepositoryTaskFilterName = "file-cache-id" ) -// Values returns all known values for DataRepositoryTaskFilterName. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DataRepositoryTaskFilterName. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DataRepositoryTaskFilterName) Values() []DataRepositoryTaskFilterName { return []DataRepositoryTaskFilterName{ "file-system-id", @@ -340,9 +341,9 @@ const ( EventTypeDeleted EventType = "DELETED" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "NEW", @@ -514,8 +515,8 @@ const ( FlexCacheEndpointTypeCache FlexCacheEndpointType = "CACHE" ) -// Values returns all known values for FlexCacheEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FlexCacheEndpointType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FlexCacheEndpointType) Values() []FlexCacheEndpointType { return []FlexCacheEndpointType{ @@ -687,8 +688,8 @@ const ( OpenZFSDeploymentTypeSingleAz2 OpenZFSDeploymentType = "SINGLE_AZ_2" ) -// Values returns all known values for OpenZFSDeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OpenZFSDeploymentType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OpenZFSDeploymentType) Values() []OpenZFSDeploymentType { return []OpenZFSDeploymentType{ @@ -722,9 +723,9 @@ const ( ReportFormatReportCsv20191124 ReportFormat = "REPORT_CSV_20191124" ) -// Values returns all known values for ReportFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReportFormat) Values() []ReportFormat { return []ReportFormat{ "REPORT_CSV_20191124", @@ -755,9 +756,9 @@ const ( ResourceTypeVolume ResourceType = "VOLUME" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "FILE_SYSTEM", @@ -819,9 +820,9 @@ const ( ServiceLimitFileCacheCount ServiceLimit = "FILE_CACHE_COUNT" ) -// Values returns all known values for ServiceLimit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServiceLimit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServiceLimit) Values() []ServiceLimit { return []ServiceLimit{ "FILE_SYSTEM_COUNT", @@ -994,9 +995,10 @@ const ( StorageVirtualMachineSubtypeSyncSource StorageVirtualMachineSubtype = "SYNC_SOURCE" ) -// Values returns all known values for StorageVirtualMachineSubtype. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageVirtualMachineSubtype. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (StorageVirtualMachineSubtype) Values() []StorageVirtualMachineSubtype { return []StorageVirtualMachineSubtype{ "DEFAULT", @@ -1123,8 +1125,8 @@ const ( WindowsDeploymentTypeSingleAz2 WindowsDeploymentType = "SINGLE_AZ_2" ) -// Values returns all known values for WindowsDeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for WindowsDeploymentType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (WindowsDeploymentType) Values() []WindowsDeploymentType { return []WindowsDeploymentType{ diff --git a/service/fsx/types/errors.go b/service/fsx/types/errors.go index e422713f278..2c08b08e184 100644 --- a/service/fsx/types/errors.go +++ b/service/fsx/types/errors.go @@ -224,8 +224,8 @@ func (e *DataRepositoryTaskEnded) ErrorCode() string { } func (e *DataRepositoryTaskEnded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An existing data repository task is currently executing on the file system. Wait -// until the existing task has completed, then create the new task. +// An existing data repository task is currently executing on the file system. +// Wait until the existing task has completed, then create the new task. type DataRepositoryTaskExecuting struct { Message *string @@ -704,8 +704,8 @@ func (e *MissingVolumeConfiguration) ErrorCode() string { } func (e *MissingVolumeConfiguration) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource specified for the tagging operation is not a resource type owned by -// Amazon FSx. Use the API of the relevant service to perform the operation. +// The resource specified for the tagging operation is not a resource type owned +// by Amazon FSx. Use the API of the relevant service to perform the operation. type NotServiceResourceError struct { Message *string @@ -844,8 +844,8 @@ func (e *SnapshotNotFound) ErrorCode() string { } func (e *SnapshotNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the lifecycle status of the source backup isn't -// AVAILABLE. +// The request was rejected because the lifecycle status of the source backup +// isn't AVAILABLE . type SourceBackupUnavailable struct { Message *string diff --git a/service/fsx/types/types.go b/service/fsx/types/types.go index 7c151c19b82..05e725dbf02 100644 --- a/service/fsx/types/types.go +++ b/service/fsx/types/types.go @@ -11,8 +11,8 @@ import ( // Server file system. type ActiveDirectoryBackupAttributes struct { - // The ID of the Amazon Web Services Managed Microsoft Active Directory instance to - // which the file system is joined. + // The ID of the Amazon Web Services Managed Microsoft Active Directory instance + // to which the file system is joined. ActiveDirectoryId *string // The fully qualified domain name of the self-managed Active Directory directory. @@ -21,9 +21,8 @@ type ActiveDirectoryBackupAttributes struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string noSmithyDocumentSerde @@ -34,63 +33,44 @@ type ActiveDirectoryBackupAttributes struct { type AdministrativeAction struct { // Describes the type of administrative action, as follows: - // - // * FILE_SYSTEM_UPDATE - - // A file system update administrative action initiated from the Amazon FSx - // console, API (UpdateFileSystem), or CLI (update-file-system). - // - // * - // STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file - // system's storage capacity has been completed successfully, a - // STORAGE_OPTIMIZATION task starts. - // - // * For Windows and ONTAP, storage optimization - // is the process of migrating the file system data to newer larger disks. - // - // * For - // Lustre, storage optimization consists of rebalancing the data across the - // existing and newly added file servers. - // - // You can track the storage-optimization - // progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been - // completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to - // COMPLETED. For more information, see Managing storage capacity - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) - // in the Amazon FSx for Windows File Server User Guide, Managing storage and - // throughput capacity - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) - // in the Amazon FSx for Lustre User Guide, and Managing storage capacity and - // provisioned IOPS - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html) - // in the Amazon FSx for NetApp ONTAP User Guide. - // - // * FILE_SYSTEM_ALIAS_ASSOCIATION - // - A file system update to associate a new Domain Name System (DNS) alias with - // the file system. For more information, see AssociateFileSystemAliases - // (https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html). - // - // * - // FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS - // alias from the file system. For more information, see - // DisassociateFileSystemAliases - // (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html). - // - // * - // VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or Amazon FSx - // for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or - // CLI (update-volume). - // - // * VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is - // returned to the state saved by the specified snapshot, initiated from an API - // (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot). - // - // * - // SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume - // initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI - // (update-snapshot). - // - // * RELEASE_NFS_V3_LOCKS - Tracks the release of Network File - // System (NFS) V3 locks on an Amazon FSx for OpenZFS file system. + // - FILE_SYSTEM_UPDATE - A file system update administrative action initiated + // from the Amazon FSx console, API ( UpdateFileSystem ), or CLI ( + // update-file-system ). + // - STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file + // system's storage capacity has been completed successfully, a + // STORAGE_OPTIMIZATION task starts. + // - For Windows and ONTAP, storage optimization is the process of migrating the + // file system data to newer larger disks. + // - For Lustre, storage optimization consists of rebalancing the data across + // the existing and newly added file servers. You can track the + // storage-optimization progress using the ProgressPercent property. When + // STORAGE_OPTIMIZATION has been completed successfully, the parent + // FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, + // see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) + // in the Amazon FSx for Windows File Server User Guide, Managing storage and + // throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) + // in the Amazon FSx for Lustre User Guide, and Managing storage capacity and + // provisioned IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html) + // in the Amazon FSx for NetApp ONTAP User Guide. + // - FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new + // Domain Name System (DNS) alias with the file system. For more information, see + // AssociateFileSystemAliases (https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html) + // . + // - FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a + // DNS alias from the file system. For more information, see + // DisassociateFileSystemAliases (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html) + // . + // - VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or Amazon + // FSx for OpenZFS volume initiated from the Amazon FSx console, API ( + // UpdateVolume ), or CLI ( update-volume ). + // - VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state + // saved by the specified snapshot, initiated from an API ( + // RestoreVolumeFromSnapshot ) or CLI ( restore-volume-from-snapshot ). + // - SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume + // initiated from the Amazon FSx console, API ( UpdateSnapshot ), or CLI ( + // update-snapshot ). + // - RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 + // locks on an Amazon FSx for OpenZFS file system. AdministrativeActionType AdministrativeActionType // Provides information about a failed administrative action. @@ -104,23 +84,14 @@ type AdministrativeAction struct { RequestTime *time.Time // Describes the status of the administrative action, as follows: - // - // * FAILED - - // Amazon FSx failed to process the administrative action successfully. - // - // * - // IN_PROGRESS - Amazon FSx is processing the administrative action. - // - // * PENDING - - // Amazon FSx is waiting to process the administrative action. - // - // * COMPLETED - - // Amazon FSx has finished processing the administrative task. - // - // * - // UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has - // updated the file system with the new storage capacity, and is now performing the - // storage-optimization process. + // - FAILED - Amazon FSx failed to process the administrative action + // successfully. + // - IN_PROGRESS - Amazon FSx is processing the administrative action. + // - PENDING - Amazon FSx is waiting to process the administrative action. + // - COMPLETED - Amazon FSx has finished processing the administrative task. + // - UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has + // updated the file system with the new storage capacity, and is now performing the + // storage-optimization process. Status Status // Describes the target value for the administration action, provided in the @@ -149,48 +120,33 @@ type AdministrativeActionFailureDetails struct { // A DNS alias that is associated with the file system. You can use a DNS alias to // access a file system using user-defined DNS names, in addition to the default // DNS name that Amazon FSx assigns to the file system. For more information, see -// DNS aliases -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) +// DNS aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) // in the FSx for Windows File Server User Guide. type Alias struct { // Describes the state of the DNS alias. - // - // * AVAILABLE - The DNS alias is associated - // with an Amazon FSx file system. - // - // * CREATING - Amazon FSx is creating the DNS - // alias and associating it with the file system. - // - // * CREATE_FAILED - Amazon FSx was - // unable to associate the DNS alias with the file system. - // - // * DELETING - Amazon FSx - // is disassociating the DNS alias from the file system and deleting it. - // - // * - // DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the - // file system. + // - AVAILABLE - The DNS alias is associated with an Amazon FSx file system. + // - CREATING - Amazon FSx is creating the DNS alias and associating it with the + // file system. + // - CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the + // file system. + // - DELETING - Amazon FSx is disassociating the DNS alias from the file system + // and deleting it. + // - DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from + // the file system. Lifecycle AliasLifecycle // The name of the DNS alias. The alias name has to meet the following // requirements: - // - // * Formatted as a fully-qualified domain name (FQDN), - // hostname.domain, for example, accounting.example.com. - // - // * Can contain - // alphanumeric characters, the underscore (_), and the hyphen (-). - // - // * Cannot start - // or end with a hyphen. - // - // * Can start with a numeric. - // - // For DNS names, Amazon FSx - // stores alphabetic characters as lowercase letters (a-z), regardless of how you - // specify them: as uppercase letters, lowercase letters, or the corresponding - // letters in escape codes. + // - Formatted as a fully-qualified domain name (FQDN), hostname.domain , for + // example, accounting.example.com . + // - Can contain alphanumeric characters, the underscore (_), and the hyphen + // (-). + // - Cannot start or end with a hyphen. + // - Can start with a numeric. + // For DNS names, Amazon FSx stores alphabetic characters as lowercase letters + // (a-z), regardless of how you specify them: as uppercase letters, lowercase + // letters, or the corresponding letters in escape codes. Name *string noSmithyDocumentSerde @@ -206,20 +162,13 @@ type Alias struct { type AutoExportPolicy struct { // The AutoExportPolicy can have the following event values: - // - // * NEW - New files and - // directories are automatically exported to the data repository as they are added - // to the file system. - // - // * CHANGED - Changes to files and directories on the file - // system are automatically exported to the data repository. - // - // * DELETED - Files and - // directories are automatically deleted on the data repository when they are - // deleted on the file system. - // - // You can define any combination of event types for - // your AutoExportPolicy. + // - NEW - New files and directories are automatically exported to the data + // repository as they are added to the file system. + // - CHANGED - Changes to files and directories on the file system are + // automatically exported to the data repository. + // - DELETED - Files and directories are automatically deleted on the data + // repository when they are deleted on the file system. + // You can define any combination of event types for your AutoExportPolicy . Events []EventType noSmithyDocumentSerde @@ -228,27 +177,20 @@ type AutoExportPolicy struct { // Describes the data repository association's automatic import policy. The // AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory // listings up to date by importing changes to your Amazon FSx for Lustre file -// system as you modify objects in a linked S3 bucket. The AutoImportPolicy is only -// supported on Amazon FSx for Lustre file systems with a data repository +// system as you modify objects in a linked S3 bucket. The AutoImportPolicy is +// only supported on Amazon FSx for Lustre file systems with a data repository // association. type AutoImportPolicy struct { // The AutoImportPolicy can have the following event values: - // - // * NEW - Amazon FSx - // automatically imports metadata of files added to the linked S3 bucket that do - // not currently exist in the FSx file system. - // - // * CHANGED - Amazon FSx - // automatically updates file metadata and invalidates existing file content on the - // file system as files change in the data repository. - // - // * DELETED - Amazon FSx - // automatically deletes files on the file system as corresponding files are - // deleted in the data repository. - // - // You can define any combination of event types - // for your AutoImportPolicy. + // - NEW - Amazon FSx automatically imports metadata of files added to the linked + // S3 bucket that do not currently exist in the FSx file system. + // - CHANGED - Amazon FSx automatically updates file metadata and invalidates + // existing file content on the file system as files change in the data repository. + // + // - DELETED - Amazon FSx automatically deletes files on the file system as + // corresponding files are deleted in the data repository. + // You can define any combination of event types for your AutoImportPolicy . Events []EventType noSmithyDocumentSerde @@ -276,26 +218,15 @@ type Backup struct { FileSystem *FileSystem // The lifecycle status of the backup. - // - // * AVAILABLE - The backup is fully - // available. - // - // * PENDING - For user-initiated backups on Lustre file systems only; - // Amazon FSx hasn't started creating the backup. - // - // * CREATING - Amazon FSx is - // creating the backup. - // - // * TRANSFERRING - For user-initiated backups on Lustre file - // systems only; Amazon FSx is transferring the backup to Amazon S3. - // - // * COPYING - - // Amazon FSx is copying the backup. - // - // * DELETED - Amazon FSx deleted the backup and - // it's no longer available. - // - // * FAILED - Amazon FSx couldn't finish the backup. + // - AVAILABLE - The backup is fully available. + // - PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx + // hasn't started creating the backup. + // - CREATING - Amazon FSx is creating the backup. + // - TRANSFERRING - For user-initiated backups on Lustre file systems only; + // Amazon FSx is transferring the backup to Amazon S3. + // - COPYING - Amazon FSx is copying the backup. + // - DELETED - Amazon FSx deleted the backup and it's no longer available. + // - FAILED - Amazon FSx couldn't finish the backup. // // This member is required. Lifecycle BackupLifecycle @@ -312,8 +243,8 @@ type Backup struct { // Details explaining any failures that occurred when creating a backup. FailureDetails *BackupFailureDetails - // The ID of the Key Management Service (KMS) key used to encrypt the backup of the - // Amazon FSx file system's data at rest. + // The ID of the Key Management Service (KMS) key used to encrypt the backup of + // the Amazon FSx file system's data at rest. KmsKeyId *string // An Amazon Web Services account ID. This ID is a 12-digit number that you use to @@ -362,20 +293,20 @@ type BackupFailureDetails struct { type CompletionReport struct { // Set Enabled to True to generate a CompletionReport when the task completes. If - // set to true, then you need to provide a report Scope, Path, and Format. Set + // set to true , then you need to provide a report Scope , Path , and Format . Set // Enabled to False if you do not want a CompletionReport generated when the task // completes. // // This member is required. Enabled *bool - // Required if Enabled is set to true. Specifies the format of the - // CompletionReport. REPORT_CSV_20191124 is the only format currently supported. - // When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in - // CSV format, and is delivered to {path}/task-{id}/failures.csv. + // Required if Enabled is set to true . Specifies the format of the + // CompletionReport . REPORT_CSV_20191124 is the only format currently supported. + // When Format is set to REPORT_CSV_20191124 , the CompletionReport is provided in + // CSV format, and is delivered to {path}/task-{id}/failures.csv . Format ReportFormat - // Required if Enabled is set to true. Specifies the location of the report on the + // Required if Enabled is set to true . Specifies the location of the report on the // file system's linked S3 data repository. An absolute path that defines where the // completion report will be stored in the destination location. The Path you // provide must be located within the file system’s ExportPath. An example Path @@ -384,9 +315,9 @@ type CompletionReport struct { // ErrorCode. Path *string - // Required if Enabled is set to true. Specifies the scope of the CompletionReport; - // FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to - // FAILED_FILES_ONLY, the CompletionReport only contains information about files + // Required if Enabled is set to true . Specifies the scope of the CompletionReport + // ; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to + // FAILED_FILES_ONLY , the CompletionReport only contains information about files // that the data repository task failed to process. Scope ReportScope @@ -396,7 +327,7 @@ type CompletionReport struct { // The Amazon File Cache configuration for the cache that you are creating. type CreateFileCacheLustreConfiguration struct { - // Specifies the cache deployment type, which must be CACHE_1. + // Specifies the cache deployment type, which must be CACHE_1 . // // This member is required. DeploymentType FileCacheLustreDeploymentType @@ -407,17 +338,16 @@ type CreateFileCacheLustreConfiguration struct { MetadataConfiguration *FileCacheLustreMetadataConfiguration // Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of - // cache storage capacity, in MB/s/TiB. The only supported value is 1000. + // cache storage capacity, in MB/s/TiB. The only supported value is 1000 . // // This member is required. PerUnitStorageThroughput *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -426,52 +356,38 @@ type CreateFileCacheLustreConfiguration struct { // The Lustre configuration for the file system being created. The following // parameters are not supported for file systems with a data repository association // created with . -// -// * AutoImportPolicy -// -// * ExportPath -// -// * ImportedChunkSize -// -// * -// ImportPath +// - AutoImportPolicy +// - ExportPath +// - ImportedChunkSize +// - ImportPath type CreateFileSystemLustreConfiguration struct { // (Optional) When you create your file system, your existing S3 objects appear as // file and directory listings. Use this parameter to choose how Amazon FSx keeps // your file and directory listings up to date as you add or modify objects in your // linked S3 bucket. AutoImportPolicy can have the following values: - // - // * NONE - - // (Default) AutoImport is off. Amazon FSx only updates file and directory listings - // from the linked S3 bucket when the file system is created. FSx does not update - // file and directory listings for any new or changed objects after choosing this - // option. - // - // * NEW - AutoImport is on. Amazon FSx automatically imports directory - // listings of any new objects added to the linked S3 bucket that do not currently - // exist in the FSx file system. - // - // * NEW_CHANGED - AutoImport is on. Amazon FSx - // automatically imports file and directory listings of any new objects added to - // the S3 bucket and any existing objects that are changed in the S3 bucket after - // you choose this option. - // - // * NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx - // automatically imports file and directory listings of any new objects added to - // the S3 bucket, any existing objects that are changed in the S3 bucket, and any - // objects that were deleted in the S3 bucket. - // - // For more information, see - // Automatically import updates from your S3 bucket - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3). - // This parameter is not supported for file systems with a data repository + // - NONE - (Default) AutoImport is off. Amazon FSx only updates file and + // directory listings from the linked S3 bucket when the file system is created. + // FSx does not update file and directory listings for any new or changed objects + // after choosing this option. + // - NEW - AutoImport is on. Amazon FSx automatically imports directory listings + // of any new objects added to the linked S3 bucket that do not currently exist in + // the FSx file system. + // - NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and + // directory listings of any new objects added to the S3 bucket and any existing + // objects that are changed in the S3 bucket after you choose this option. + // - NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports + // file and directory listings of any new objects added to the S3 bucket, any + // existing objects that are changed in the S3 bucket, and any objects that were + // deleted in the S3 bucket. + // For more information, see Automatically import updates from your S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3) + // . This parameter is not supported for file systems with a data repository // association. AutoImportPolicy AutoImportPolicyType // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 // (Optional) Not available for use with file systems that are linked to a data @@ -482,35 +398,29 @@ type CreateFileSystemLustreConfiguration struct { // CopyTagsToBackups is set to true and you specify one or more backup tags, only // the specified tags are copied to backups. If you specify one or more tags when // creating a user-initiated backup, no tags are copied from the file system, - // regardless of this value. (Default = false) For more information, see Working - // with backups - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in - // the Amazon FSx for Lustre User Guide. + // regardless of this value. (Default = false ) For more information, see Working + // with backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) + // in the Amazon FSx for Lustre User Guide. CopyTagsToBackups *bool - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string // Sets the data compression configuration for the file system. DataCompressionType // can have the following values: - // - // * NONE - (Default) Data compression is turned - // off when the file system is created. - // - // * LZ4 - Data compression is turned on with - // the LZ4 algorithm. - // - // For more information, see Lustre data compression - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html) in - // the Amazon FSx for Lustre User Guide. + // - NONE - (Default) Data compression is turned off when the file system is + // created. + // - LZ4 - Data compression is turned on with the LZ4 algorithm. + // For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html) + // in the Amazon FSx for Lustre User Guide. DataCompressionType DataCompressionType // (Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need // temporary storage and shorter-term processing of data. The SCRATCH_2 deployment // type provides in-transit encryption of data and higher burst throughput capacity - // than SCRATCH_1. Choose PERSISTENT_1 for longer-term storage and for + // than SCRATCH_1 . Choose PERSISTENT_1 for longer-term storage and for // throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 // supports encryption of data in transit, and is available in all Amazon Web // Services Regions in which FSx for Lustre is available. Choose PERSISTENT_2 for @@ -519,24 +429,22 @@ type CreateFileSystemLustreConfiguration struct { // PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a // limited number of Amazon Web Services Regions. For more information, and an // up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is - // available, see File system deployment options for FSx for Lustre - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) - // in the Amazon FSx for Lustre User Guide. If you choose PERSISTENT_2, and you set - // FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails. Encryption - // of data in transit is automatically turned on when you access SCRATCH_2, - // PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances that - // support automatic encryption in the Amazon Web Services Regions where they are - // available. For more information about encryption in transit for FSx for Lustre - // file systems, see Encrypting data in transit - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) - // in the Amazon FSx for Lustre User Guide. (Default = SCRATCH_1) + // available, see File system deployment options for FSx for Lustre (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) + // in the Amazon FSx for Lustre User Guide. If you choose PERSISTENT_2 , and you + // set FileSystemTypeVersion to 2.10 , the CreateFileSystem operation fails. + // Encryption of data in transit is automatically turned on when you access + // SCRATCH_2 , PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 + // instances that support automatic encryption in the Amazon Web Services Regions + // where they are available. For more information about encryption in transit for + // FSx for Lustre file systems, see Encrypting data in transit (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) + // in the Amazon FSx for Lustre User Guide. (Default = SCRATCH_1 ) DeploymentType LustreDeploymentType // The type of drive cache used by PERSISTENT_1 file systems that are provisioned // with HDD storage devices. This parameter is required when storage type is HDD. // Set this property to READ to improve the performance for frequently accessed // files by caching up to 20% of the total storage capacity of the file system. - // This parameter is required when StorageType is set to HDD. + // This parameter is required when StorageType is set to HDD . DriveCacheType DriveCacheType // (Optional) Specifies the path in the Amazon S3 bucket where the root of your @@ -544,25 +452,26 @@ type CreateFileSystemLustreConfiguration struct { // as specified in ImportPath. You can provide an optional prefix to which new and // changed data is to be exported from your Amazon FSx for Lustre file system. If // an ExportPath value is not provided, Amazon FSx sets a default export path, - // s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC - // format, for example s3://import-bucket/FSxLustre20181105T222312Z. The Amazon S3 - // export bucket must be the same as the import bucket specified by ImportPath. If - // you specify only a bucket name, such as s3://import-bucket, you get a 1:1 + // s3://import-bucket/FSxLustre[creation-timestamp] . The timestamp is in UTC + // format, for example s3://import-bucket/FSxLustre20181105T222312Z . The Amazon S3 + // export bucket must be the same as the import bucket specified by ImportPath . If + // you specify only a bucket name, such as s3://import-bucket , you get a 1:1 // mapping of file system objects to S3 bucket objects. This mapping means that the // input data in S3 is overwritten on export. If you provide a custom prefix in the - // export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx + // export path, such as s3://import-bucket/[custom-optional-prefix] , Amazon FSx // exports the contents of your file system to that export prefix in the Amazon S3 // bucket. This parameter is not supported for file systems with a data repository // association. ExportPath *string - // (Optional) The path to the Amazon S3 bucket (including the optional prefix) that - // you're using as the data repository for your Amazon FSx for Lustre file system. - // The root of your FSx for Lustre file system will be mapped to the root of the - // Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. - // If you specify a prefix after the Amazon S3 bucket name, only object keys with - // that prefix are loaded into the file system. This parameter is not supported for - // file systems with a data repository association. + // (Optional) The path to the Amazon S3 bucket (including the optional prefix) + // that you're using as the data repository for your Amazon FSx for Lustre file + // system. The root of your FSx for Lustre file system will be mapped to the root + // of the Amazon S3 bucket you select. An example is + // s3://import-bucket/optional-prefix . If you specify a prefix after the Amazon S3 + // bucket name, only object keys with that prefix are loaded into the file system. + // This parameter is not supported for file systems with a data repository + // association. ImportPath *string // (Optional) For files imported from a data repository, this value determines the @@ -586,19 +495,14 @@ type CreateFileSystemLustreConfiguration struct { // (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of // PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for // the amount of throughput that you provision. Valid values: - // - // * For PERSISTENT_1 - // SSD storage: 50, 100, 200 MB/s/TiB. - // - // * For PERSISTENT_1 HDD storage: 12, 40 - // MB/s/TiB. - // - // * For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB. + // - For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB. + // - For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB. + // - For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB. PerUnitStorageThroughput *int32 - // The Lustre root squash configuration used when creating an Amazon FSx for Lustre - // file system. When enabled, root squash restricts root-level access from clients - // that try to access your file system as a root user. + // The Lustre root squash configuration used when creating an Amazon FSx for + // Lustre file system. When enabled, root squash restricts root-level access from + // clients that try to access your file system as a root user. RootSquashConfiguration *LustreRootSquashConfiguration // (Optional) The preferred start time to perform weekly maintenance, formatted @@ -609,23 +513,19 @@ type CreateFileSystemLustreConfiguration struct { noSmithyDocumentSerde } -// The ONTAP configuration properties of the FSx for ONTAP file system that you are -// creating. +// The ONTAP configuration properties of the FSx for ONTAP file system that you +// are creating. type CreateFileSystemOntapConfiguration struct { // Specifies the FSx for ONTAP file system deployment type to use in creating the // file system. + // - MULTI_AZ_1 - (Default) A high availability file system configured for + // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. // - // * MULTI_AZ_1 - (Default) A high availability file system - // configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) - // unavailability. - // - // * SINGLE_AZ_1 - A file system configured for Single-AZ - // redundancy. - // - // For information about the use cases for Multi-AZ and Single-AZ - // deployments, refer to Choosing a file system deployment type - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html). + // - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. + // For information about the use cases for Multi-AZ and Single-AZ deployments, + // refer to Choosing a file system deployment type (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html) + // . // // This member is required. DeploymentType OntapDeploymentType @@ -638,10 +538,10 @@ type CreateFileSystemOntapConfiguration struct { // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string @@ -662,7 +562,7 @@ type CreateFileSystemOntapConfiguration struct { // administer your file system using the NetApp ONTAP CLI and REST API. FsxAdminPassword *string - // Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in + // Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in // which you want the preferred file server to be located. PreferredSubnetId *string @@ -672,40 +572,32 @@ type CreateFileSystemOntapConfiguration struct { // default, Amazon FSx selects your VPC's default route table. RouteTableIds []string - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde } -// The Amazon FSx for OpenZFS configuration properties for the file system that you -// are creating. +// The Amazon FSx for OpenZFS configuration properties for the file system that +// you are creating. type CreateFileSystemOpenZFSConfiguration struct { // Specifies the file system deployment type. Single AZ deployment types are // configured for redundancy within a single Availability Zone in an Amazon Web // Services Region . Valid values are the following: - // - // * SINGLE_AZ_1- (Default) - // Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 - // is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is - // available, except US West (Oregon). - // - // * SINGLE_AZ_2- Creates file systems with - // throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. - // Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US - // West (Oregon), and Europe (Ireland) Amazon Web Services Regions. - // - // For more - // information, see: Deployment type availability - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) - // and File system performance - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance) + // - SINGLE_AZ_1 - (Default) Creates file systems with throughput capacities of + // 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions + // where Amazon FSx for OpenZFS is available, except US West (Oregon). + // - SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - + // 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US + // East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) + // Amazon Web Services Regions. + // For more information, see: Deployment type availability (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) + // and File system performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance) // in the Amazon FSx for OpenZFS User Guide. // // This member is required. @@ -714,42 +606,38 @@ type CreateFileSystemOpenZFSConfiguration struct { // Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in // megabytes per second (MB/s). Valid values depend on the DeploymentType you // choose, as follows: - // - // * For SINGLE_AZ_1, valid values are 64, 128, 256, 512, - // 1024, 2048, 3072, or 4096 MB/s. - // - // * For SINGLE_AZ_2, valid values are 160, 320, - // 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s. - // - // You pay for additional - // throughput capacity that you provision. + // - For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or + // 4096 MB/s. + // - For SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, + // 7680, or 10240 MB/s. + // You pay for additional throughput capacity that you provision. // // This member is required. ThroughputCapacity *int32 // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags for the file system should be copied to - // backups. This value defaults to false. If it's set to true, all tags for the + // backups. This value defaults to false . If it's set to true , all tags for the // file system are copied to all automatic and user-initiated backups where the - // user doesn't specify tags. If this value is true, and you specify one or more + // user doesn't specify tags. If this value is true , and you specify one or more // tags, only the specified tags are copied to backups. If you specify one or more // tags when creating a user-initiated backup, no tags are copied from the file // system, regardless of this value. CopyTagsToBackups *bool // A Boolean value indicating whether tags for the file system should be copied to - // volumes. This value defaults to false. If it's set to true, all tags for the + // volumes. This value defaults to false . If it's set to true , all tags for the // file system are copied to volumes where the user doesn't specify tags. If this - // value is true, and you specify one or more tags, only the specified tags are + // value is true , and you specify one or more tags, only the specified tags are // copied to volumes. If you specify one or more tags when creating the volume, no // tags are copied from the file system, regardless of this value. CopyTagsToVolumes *bool - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string @@ -761,16 +649,15 @@ type CreateFileSystemOpenZFSConfiguration struct { // and how the amount was provisioned (by the customer or by the system). DiskIopsConfiguration *DiskIopsConfiguration - // The configuration Amazon FSx uses when creating the root value of the Amazon FSx - // for OpenZFS file system. All volumes are children of the root volume. + // The configuration Amazon FSx uses when creating the root value of the Amazon + // FSx for OpenZFS file system. All volumes are children of the root volume. RootVolumeConfiguration *OpenZFSCreateRootVolumeConfiguration - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -780,8 +667,9 @@ type CreateFileSystemOpenZFSConfiguration struct { // CreateFileSystem and CreateFileSystemFromBackup operations. type CreateFileSystemWindowsConfiguration struct { - // Sets the throughput capacity of an Amazon FSx file system, measured in megabytes - // per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). + // Sets the throughput capacity of an Amazon FSx file system, measured in + // megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and + // 2^11 (2048). // // This member is required. ThroughputCapacity *int32 @@ -797,28 +685,19 @@ type CreateFileSystemWindowsConfiguration struct { // create the file system using the AssociateFileSystemAliases operation. You can // remove DNS aliases from the file system after it is created using the // DisassociateFileSystemAliases operation. You only need to specify the alias name - // in the request payload. For more information, see Working with DNS Aliases - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) - // and Walkthrough 5: Using DNS aliases to access your file system - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html), - // including additional steps you must take to be able to access your file system + // in the request payload. For more information, see Working with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) + // and Walkthrough 5: Using DNS aliases to access your file system (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html) + // , including additional steps you must take to be able to access your file system // using a DNS alias. An alias name has to meet the following requirements: - // - // * - // Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, - // accounting.example.com. - // - // * Can contain alphanumeric characters, the underscore - // (_), and the hyphen (-). - // - // * Cannot start or end with a hyphen. - // - // * Can start with - // a numeric. - // - // For DNS alias names, Amazon FSx stores alphabetic characters as - // lowercase letters (a-z), regardless of how you specify them: as uppercase - // letters, lowercase letters, or the corresponding letters in escape codes. + // - Formatted as a fully-qualified domain name (FQDN), hostname.domain , for + // example, accounting.example.com . + // - Can contain alphanumeric characters, the underscore (_), and the hyphen + // (-). + // - Cannot start or end with a hyphen. + // - Can start with a numeric. + // For DNS alias names, Amazon FSx stores alphabetic characters as lowercase + // letters (a-z), regardless of how you specify them: as uppercase letters, + // lowercase letters, or the corresponding letters in escape codes. Aliases []string // The configuration that Amazon FSx for Windows File Server uses to audit and log @@ -826,9 +705,9 @@ type CreateFileSystemWindowsConfiguration struct { // File Server file system. AuditLogConfiguration *WindowsAuditLogCreateConfiguration - // The number of days to retain automatic backups. The default is to retain backups - // for 7 days. Setting this value to 0 disables the creation of automatic backups. - // The maximum retention period for backups is 90 days. + // The number of days to retain automatic backups. The default is to retain + // backups for 7 days. Setting this value to 0 disables the creation of automatic + // backups. The maximum retention period for backups is 90 days. AutomaticBackupRetentionDays *int32 // A boolean flag indicating whether tags for the file system should be copied to @@ -845,27 +724,21 @@ type CreateFileSystemWindowsConfiguration struct { DailyAutomaticBackupStartTime *string // Specifies the file system deployment type, valid values are the following: - // - // * - // MULTI_AZ_1 - Deploys a high availability file system that is configured for - // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. - // You can only deploy a Multi-AZ file system in Amazon Web Services Regions that - // have a minimum of three Availability Zones. Also supports HDD storage type - // - // * - // SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for - // single AZ redundancy. - // - // * SINGLE_AZ_2 - The latest generation Single AZ file - // system. Specifies a file system that is configured for single AZ redundancy and - // supports HDD storage type. - // - // For more information, see Availability and - // Durability: Single-AZ and Multi-AZ File Systems - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). + // - MULTI_AZ_1 - Deploys a high availability file system that is configured for + // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. + // You can only deploy a Multi-AZ file system in Amazon Web Services Regions that + // have a minimum of three Availability Zones. Also supports HDD storage type + // - SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured + // for single AZ redundancy. + // - SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file + // system that is configured for single AZ redundancy and supports HDD storage + // type. + // For more information, see Availability and Durability: Single-AZ and Multi-AZ + // File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) + // . DeploymentType WindowsDeploymentType - // Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in + // Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in // which you want the preferred file server to be located. For in-Amazon Web // Services applications, we recommend that you launch your clients in the same // Availability Zone (AZ) as your preferred file server to reduce cross-AZ data @@ -875,16 +748,15 @@ type CreateFileSystemWindowsConfiguration struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more - // information, see Using Amazon FSx with your self-managed Microsoft Active - // Directory - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or - // Managing SVMs - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html). + // information, see Using Amazon FSx with your self-managed Microsoft Active + // Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) + // or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) + // . SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone, where d is the weekday number, from 1 through 7, beginning with - // Monday and ending with Sunday. + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in + // the UTC time zone, where d is the weekday number, from 1 through 7, beginning + // with Monday and ending with Sunday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -916,64 +788,45 @@ type CreateOntapVolumeConfiguration struct { // Specifies the location in the SVM's namespace where the volume is mounted. This // parameter is required. The JunctionPath must have a leading forward slash, such - // as /vol3. + // as /vol3 . JunctionPath *string - // Specifies the type of volume you are creating. Valid values are the - // following: - // - // * RW specifies a read/write volume. RW is the default. - // - // * DP - // specifies a data-protection volume. A DP volume is read-only and can be used as - // the destination of a NetApp SnapMirror relationship. - // - // For more information, see - // Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) in - // the Amazon FSx for NetApp ONTAP User Guide. + // Specifies the type of volume you are creating. Valid values are the following: + // - RW specifies a read/write volume. RW is the default. + // - DP specifies a data-protection volume. A DP volume is read-only and can be + // used as the destination of a NetApp SnapMirror relationship. + // For more information, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) + // in the Amazon FSx for NetApp ONTAP User Guide. OntapVolumeType InputOntapVolumeType - // Specifies the security style for the volume. If a volume's security style is not - // specified, it is automatically set to the root volume's security style. The + // Specifies the security style for the volume. If a volume's security style is + // not specified, it is automatically set to the root volume's security style. The // security style determines the type of permissions that FSx for ONTAP uses to - // control data access. For more information, see Volume security style - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) + // control data access. For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) // in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following // values: - // - // * UNIX if the file system is managed by a UNIX administrator, the - // majority of users are NFS clients, and an application accessing the data uses a - // UNIX user as the service account. - // - // * NTFS if the file system is managed by a - // Windows administrator, the majority of users are SMB clients, and an application - // accessing the data uses a Windows user as the service account. - // - // * MIXED if the - // file system is managed by both UNIX and Windows administrators and users consist - // of both NFS and SMB clients. + // - UNIX if the file system is managed by a UNIX administrator, the majority of + // users are NFS clients, and an application accessing the data uses a UNIX user as + // the service account. + // - NTFS if the file system is managed by a Windows administrator, the majority + // of users are SMB clients, and an application accessing the data uses a Windows + // user as the service account. + // - MIXED if the file system is managed by both UNIX and Windows administrators + // and users consist of both NFS and SMB clients. SecurityStyle SecurityStyle // Specifies the snapshot policy for the volume. There are three built-in snapshot // policies: - // - // * default: This is the default policy. A maximum of six hourly - // snapshots taken five minutes past the hour. A maximum of two daily snapshots - // taken Monday through Saturday at 10 minutes after midnight. A maximum of two - // weekly snapshots taken every Sunday at 15 minutes after midnight. - // - // * - // default-1weekly: This policy is the same as the default policy except that it - // only retains one snapshot from the weekly schedule. - // - // * none: This policy does - // not take any snapshots. This policy can be assigned to volumes to prevent - // automatic snapshots from being taken. - // - // You can also provide the name of a custom - // policy that you created with the ONTAP CLI or REST API. For more information, - // see Snapshot policies - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) + // - default : This is the default policy. A maximum of six hourly snapshots + // taken five minutes past the hour. A maximum of two daily snapshots taken Monday + // through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots + // taken every Sunday at 15 minutes after midnight. + // - default-1weekly : This policy is the same as the default policy except that + // it only retains one snapshot from the weekly schedule. + // - none : This policy does not take any snapshots. This policy can be assigned + // to volumes to prevent automatic snapshots from being taken. + // You can also provide the name of a custom policy that you created with the + // ONTAP CLI or REST API. For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) // in the Amazon FSx for NetApp ONTAP User Guide. SnapshotPolicy *string @@ -986,20 +839,17 @@ type CreateOntapVolumeConfiguration struct { // for ONTAP's intelligent tiering automatically transitions a volume's data // between the file system's primary storage and capacity pool storage based on // your access patterns. Valid tiering policies are the following: + // - SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool + // storage tier. // - // * SNAPSHOT_ONLY - // - (Default value) moves cold snapshots to the capacity pool storage tier. + // - AUTO - moves cold user data and snapshots to the capacity pool storage tier + // based on your access patterns. // - // * - // AUTO - moves cold user data and snapshots to the capacity pool storage tier - // based on your access patterns. + // - ALL - moves all user data blocks in both the active file system and Snapshot + // copies to the storage pool tier. // - // * ALL - moves all user data blocks in both the - // active file system and Snapshot copies to the storage pool tier. - // - // * NONE - keeps - // a volume's data in the primary storage tier, preventing it from being moved to - // the capacity pool tier. + // - NONE - keeps a volume's data in the primary storage tier, preventing it from + // being moved to the capacity pool tier. TieringPolicy *TieringPolicy noSmithyDocumentSerde @@ -1010,15 +860,11 @@ type CreateOntapVolumeConfiguration struct { type CreateOpenZFSOriginSnapshotConfiguration struct { // The strategy used when copying data from the snapshot to the new volume. - // - // * - // CLONE - The new volume references the data in the origin snapshot. Cloning a - // snapshot is faster than copying data from the snapshot to a new volume and - // doesn't consume disk throughput. However, the origin snapshot can't be deleted - // if there is a volume using its copied data. - // - // * FULL_COPY - Copies all data from - // the snapshot to the new volume. + // - CLONE - The new volume references the data in the origin snapshot. Cloning a + // snapshot is faster than copying data from the snapshot to a new volume and + // doesn't consume disk throughput. However, the origin snapshot can't be deleted + // if there is a volume using its copied data. + // - FULL_COPY - Copies all data from the snapshot to the new volume. // // This member is required. CopyStrategy OpenZFSCopyStrategy @@ -1026,9 +872,8 @@ type CreateOpenZFSOriginSnapshotConfiguration struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. SnapshotARN *string @@ -1047,40 +892,32 @@ type CreateOpenZFSVolumeConfiguration struct { ParentVolumeId *string // A Boolean value indicating whether tags for the volume should be copied to - // snapshots. This value defaults to false. If it's set to true, all tags for the + // snapshots. This value defaults to false . If it's set to true , all tags for the // volume are copied to snapshots where the user doesn't specify tags. If this - // value is true, and you specify one or more tags, only the specified tags are + // value is true , and you specify one or more tags, only the specified tags are // copied to snapshots. If you specify one or more tags when creating the snapshot, // no tags are copied from the volume, regardless of this value. CopyTagsToSnapshots *bool // Specifies the method used to compress the data on the volume. The compression // type is NONE by default. - // - // * NONE - Doesn't compress the data on the volume. NONE - // is the default. - // - // * ZSTD - Compresses the data in the volume using the Zstandard - // (ZSTD) compression algorithm. ZSTD compression provides a higher level of data - // compression and higher read throughput performance than LZ4 compression. - // - // * LZ4 - // - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 - // compression provides a lower level of compression and higher write throughput - // performance than ZSTD compression. - // - // For more information about volume - // compression types and the performance of your Amazon FSx for OpenZFS file - // system, see Tips for maximizing performance - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // - NONE - Doesn't compress the data on the volume. NONE is the default. + // - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) + // compression algorithm. ZSTD compression provides a higher level of data + // compression and higher read throughput performance than LZ4 compression. + // - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // LZ4 compression provides a lower level of compression and higher write + // throughput performance than ZSTD compression. + // For more information about volume compression types and the performance of your + // Amazon FSx for OpenZFS file system, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) // File system and volume settings in the Amazon FSx for OpenZFS User Guide. DataCompressionType OpenZFSDataCompressionType // The configuration object for mounting a Network File System (NFS) file system. NfsExports []OpenZFSNfsExport - // The configuration object that specifies the snapshot to use as the origin of the - // data for the volume. + // The configuration object that specifies the snapshot to use as the origin of + // the data for the volume. OriginSnapshot *CreateOpenZFSOriginSnapshotConfiguration // A Boolean value indicating whether the volume is read-only. @@ -1092,19 +929,17 @@ type CreateOpenZFSVolumeConfiguration struct { // use cases. Generally, workloads that write in fixed small or large record sizes // may benefit from setting a custom record size, like database workloads (small // record size) or media streaming workloads (large record size). For additional - // guidance on when to set a custom record size, see ZFS Record size - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance) + // guidance on when to set a custom record size, see ZFS Record size (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance) // in the Amazon FSx for OpenZFS User Guide. RecordSizeKiB *int32 - // Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify - // a quota that is larger than the storage on the parent volume. A volume quota - // limits the amount of storage that the volume can consume to the configured + // Sets the maximum storage size in gibibytes (GiB) for the volume. You can + // specify a quota that is larger than the storage on the parent volume. A volume + // quota limits the amount of storage that the volume can consume to the configured // amount, but does not guarantee the space will be available on the parent volume. - // To guarantee quota space, you must also set StorageCapacityReservationGiB. To - // not specify a storage capacity quota, set this to -1. For more information, see - // Volume properties - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) + // To guarantee quota space, you must also set StorageCapacityReservationGiB . To + // not specify a storage capacity quota, set this to -1 . For more information, see + // Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) // in the Amazon FSx for OpenZFS User Guide. StorageCapacityQuotaGiB *int32 @@ -1112,9 +947,8 @@ type CreateOpenZFSVolumeConfiguration struct { // volume. Setting StorageCapacityReservationGiB guarantees that the specified // amount of storage space on the parent volume will always be available for the // volume. You can't reserve more storage than the parent volume has. To not - // specify a storage capacity reservation, set this to 0 or -1. For more - // information, see Volume properties - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) + // specify a storage capacity reservation, set this to 0 or -1 . For more + // information, see Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) // in the Amazon FSx for OpenZFS User Guide. StorageCapacityReservationGiB *int32 @@ -1124,9 +958,9 @@ type CreateOpenZFSVolumeConfiguration struct { noSmithyDocumentSerde } -// The configuration that Amazon FSx uses to join the ONTAP storage virtual machine -// (SVM) to your self-managed (including on-premises) Microsoft Active Directory -// (AD) directory. +// The configuration that Amazon FSx uses to join the ONTAP storage virtual +// machine (SVM) to your self-managed (including on-premises) Microsoft Active +// Directory (AD) directory. type CreateSvmActiveDirectoryConfiguration struct { // The NetBIOS name of the Active Directory computer object that will be created @@ -1138,11 +972,10 @@ type CreateSvmActiveDirectoryConfiguration struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more - // information, see Using Amazon FSx with your self-managed Microsoft Active - // Directory - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or - // Managing SVMs - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html). + // information, see Using Amazon FSx with your self-managed Microsoft Active + // Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) + // or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) + // . SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration noSmithyDocumentSerde @@ -1152,18 +985,12 @@ type CreateSvmActiveDirectoryConfiguration struct { // Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an // Amazon S3 bucket or an NFS file system. The data repository association // configuration object is returned in the response of the following operations: +// - CreateDataRepositoryAssociation +// - UpdateDataRepositoryAssociation +// - DescribeDataRepositoryAssociations // -// * -// CreateDataRepositoryAssociation -// -// * UpdateDataRepositoryAssociation -// -// * -// DescribeDataRepositoryAssociations -// -// Data repository associations are supported -// on Amazon File Cache resources and all Amazon FSx for Lustre file systems -// excluding Scratch_1 deployment types. +// Data repository associations are supported on Amazon File Cache resources and +// all Amazon FSx for Lustre file systems excluding Scratch_1 deployment types. type DataRepositoryAssociation struct { // The system-generated, unique ID of the data repository association. @@ -1171,61 +998,54 @@ type DataRepositoryAssociation struct { // A boolean flag indicating whether an import data repository task to import // metadata should run after the data repository association is created. The task - // runs if this flag is set to true. BatchImportMetaDataOnCreate is not supported + // runs if this flag is set to true . BatchImportMetaDataOnCreate is not supported // for data repositories linked to an Amazon File Cache resource. BatchImportMetaDataOnCreate *bool - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time // The path to the data repository that will be linked to the cache or file // system. - // - // * For Amazon File Cache, the path can be an NFS data repository that - // will be linked to the cache. The path can be in one of two formats: - // - // * If you - // are not using the DataRepositorySubdirectories parameter, the path is to an NFS - // Export directory (or one of its subdirectories) in the format - // nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to - // a single data repository association. - // - // * If you are using the - // DataRepositorySubdirectories parameter, the path is the domain name of the NFS - // file system in the format nfs://filer-domain-name, which indicates the root of - // the subdirectories specified with the DataRepositorySubdirectories parameter. - // - // * - // For Amazon File Cache, the path can be an S3 bucket or prefix in the format - // s3://myBucket/myPrefix/. - // - // * For Amazon FSx for Lustre, the path can be an S3 - // bucket or prefix in the format s3://myBucket/myPrefix/. + // - For Amazon File Cache, the path can be an NFS data repository that will be + // linked to the cache. The path can be in one of two formats: + // - If you are not using the DataRepositorySubdirectories parameter, the path is + // to an NFS Export directory (or one of its subdirectories) in the format + // nsf://nfs-domain-name/exportpath . You can therefore link a single NFS Export + // to a single data repository association. + // - If you are using the DataRepositorySubdirectories parameter, the path is the + // domain name of the NFS file system in the format nfs://filer-domain-name , + // which indicates the root of the subdirectories specified with the + // DataRepositorySubdirectories parameter. + // - For Amazon File Cache, the path can be an S3 bucket or prefix in the format + // s3://myBucket/myPrefix/ . + // - For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the + // format s3://myBucket/myPrefix/ . DataRepositoryPath *string // For Amazon File Cache, a list of NFS Exports that will be linked with an NFS // data repository association. All the subdirectories must be on a single NFS file - // system. The Export paths are in the format /exportpath1. To use this parameter, - // you must configure DataRepositoryPath as the domain name of the NFS file system. - // The NFS file system domain name in effect is the root of the subdirectories. - // Note that DataRepositorySubdirectories is not supported for S3 data - // repositories. + // system. The Export paths are in the format /exportpath1 . To use this parameter, + // you must configure DataRepositoryPath as the domain name of the NFS file + // system. The NFS file system domain name in effect is the root of the + // subdirectories. Note that DataRepositorySubdirectories is not supported for S3 + // data repositories. DataRepositorySubdirectories []string // Provides detailed information about the data repository if its Lifecycle is set - // to MISCONFIGURED or FAILED. + // to MISCONFIGURED or FAILED . FailureDetails *DataRepositoryFailureDetails // The globally unique ID of the Amazon File Cache resource. FileCacheId *string // A path on the Amazon File Cache that points to a high-level directory (such as - // /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with - // DataRepositoryPath. The leading forward slash in the path is required. Two data + // /ns1/ ) or subdirectory (such as /ns1/subdir/ ) that will be mapped 1-1 with + // DataRepositoryPath . The leading forward slash in the path is required. Two data // repository associations cannot have overlapping cache paths. For example, if a - // data repository is associated with cache path /ns1/, then you cannot link - // another data repository with cache path /ns1/ns2. This path specifies the + // data repository is associated with cache path /ns1/ , then you cannot link + // another data repository with cache path /ns1/ns2 . This path specifies the // directory in your cache where files will be exported from. This cache directory // can be linked to only one data repository (S3 or NFS) and no other data // repository can be linked to the directory. The cache path can only be set to @@ -1238,15 +1058,15 @@ type DataRepositoryAssociation struct { FileSystemId *string // A path on the Amazon FSx for Lustre file system that points to a high-level - // directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be - // mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is + // directory (such as /ns1/ ) or subdirectory (such as /ns1/subdir/ ) that will be + // mapped 1-1 with DataRepositoryPath . The leading forward slash in the name is // required. Two data repository associations cannot have overlapping file system // paths. For example, if a data repository is associated with file system path - // /ns1/, then you cannot link another data repository with file system path - // /ns1/ns2. This path specifies where in your file system files will be exported + // /ns1/ , then you cannot link another data repository with file system path + // /ns1/ns2 . This path specifies where in your file system files will be exported // from or imported to. This file system directory can be linked to only one Amazon // S3 bucket, and no other S3 bucket can be linked to the directory. If you specify - // only a forward slash (/) as the file system path, you can link only one data + // only a forward slash ( / ) as the file system path, you can link only one data // repository to the file system. You can only specify "/" as the file system path // for the first data repository associated with a file system. FileSystemPath *string @@ -1259,29 +1079,20 @@ type DataRepositoryAssociation struct { // GiB). Amazon S3 objects have a maximum size of 5 TB. ImportedFileChunkSize *int32 - // Describes the state of a data repository association. The lifecycle can have the - // following values: - // - // * CREATING - The data repository association between the file - // system or cache and the data repository is being created. The data repository is - // unavailable. - // - // * AVAILABLE - The data repository association is available for - // use. - // - // * MISCONFIGURED - The data repository association is misconfigured. Until - // the configuration is corrected, automatic import and automatic export will not - // work (only for Amazon FSx for Lustre). - // - // * UPDATING - The data repository - // association is undergoing a customer initiated update that might affect its - // availability. - // - // * DELETING - The data repository association is undergoing a - // customer initiated deletion. - // - // * FAILED - The data repository association is in a - // terminal state that cannot be recovered. + // Describes the state of a data repository association. The lifecycle can have + // the following values: + // - CREATING - The data repository association between the file system or cache + // and the data repository is being created. The data repository is unavailable. + // - AVAILABLE - The data repository association is available for use. + // - MISCONFIGURED - The data repository association is misconfigured. Until the + // configuration is corrected, automatic import and automatic export will not work + // (only for Amazon FSx for Lustre). + // - UPDATING - The data repository association is undergoing a customer + // initiated update that might affect its availability. + // - DELETING - The data repository association is undergoing a customer + // initiated deletion. + // - FAILED - The data repository association is in a terminal state that cannot + // be recovered. Lifecycle DataRepositoryLifecycle // The configuration for an NFS data repository linked to an Amazon File Cache @@ -1291,9 +1102,8 @@ type DataRepositoryAssociation struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The configuration for an Amazon S3 data repository linked to an Amazon FSx for @@ -1306,50 +1116,45 @@ type DataRepositoryAssociation struct { noSmithyDocumentSerde } -// The data repository configuration object for Lustre file systems returned in the -// response of the CreateFileSystem operation. This data type is not supported on -// file systems with a data repository association. For file systems with a data +// The data repository configuration object for Lustre file systems returned in +// the response of the CreateFileSystem operation. This data type is not supported +// on file systems with a data repository association. For file systems with a data // repository association, see . type DataRepositoryConfiguration struct { - // Describes the file system's linked S3 data repository's AutoImportPolicy. The + // Describes the file system's linked S3 data repository's AutoImportPolicy . The // AutoImportPolicy configures how Amazon FSx keeps your file and directory // listings up to date as you add or modify objects in your linked S3 bucket. // AutoImportPolicy can have the following values: - // - // * NONE - (Default) AutoImport - // is off. Amazon FSx only updates file and directory listings from the linked S3 - // bucket when the file system is created. FSx does not update file and directory - // listings for any new or changed objects after choosing this option. - // - // * NEW - - // AutoImport is on. Amazon FSx automatically imports directory listings of any new - // objects added to the linked S3 bucket that do not currently exist in the FSx - // file system. - // - // * NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports - // file and directory listings of any new objects added to the S3 bucket and any - // existing objects that are changed in the S3 bucket after you choose this - // option. - // - // * NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically - // imports file and directory listings of any new objects added to the S3 bucket, - // any existing objects that are changed in the S3 bucket, and any objects that - // were deleted in the S3 bucket. + // - NONE - (Default) AutoImport is off. Amazon FSx only updates file and + // directory listings from the linked S3 bucket when the file system is created. + // FSx does not update file and directory listings for any new or changed objects + // after choosing this option. + // - NEW - AutoImport is on. Amazon FSx automatically imports directory listings + // of any new objects added to the linked S3 bucket that do not currently exist in + // the FSx file system. + // - NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and + // directory listings of any new objects added to the S3 bucket and any existing + // objects that are changed in the S3 bucket after you choose this option. + // - NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports + // file and directory listings of any new objects added to the S3 bucket, any + // existing objects that are changed in the S3 bucket, and any objects that were + // deleted in the S3 bucket. AutoImportPolicy AutoImportPolicyType - // The export path to the Amazon S3 bucket (and prefix) that you are using to store - // new and changed Lustre file system files in S3. + // The export path to the Amazon S3 bucket (and prefix) that you are using to + // store new and changed Lustre file system files in S3. ExportPath *string // Provides detailed information about the data repository if its Lifecycle is set - // to MISCONFIGURED or FAILED. + // to MISCONFIGURED or FAILED . FailureDetails *DataRepositoryFailureDetails // The import path to the Amazon S3 bucket (and optional prefix) that you're using // as the data repository for your FSx for Lustre file system, for example - // s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 - // bucket name, only object keys with that prefix are loaded into the file system. + // s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon + // S3 bucket name, only object keys with that prefix are loaded into the file + // system. ImportPath *string // For files imported from a data repository, this value determines the stripe @@ -1361,34 +1166,26 @@ type DataRepositoryConfiguration struct { ImportedFileChunkSize *int32 // Describes the state of the file system's S3 durable data repository, if it is - // configured with an S3 repository. The lifecycle can have the following - // values: - // - // * CREATING - The data repository configuration between the FSx file - // system and the linked S3 data repository is being created. The data repository - // is unavailable. - // - // * AVAILABLE - The data repository is available for use. - // - // * - // MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 - // bucket until the data repository configuration is corrected. For more - // information, see Troubleshooting a Misconfigured linked S3 bucket - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository). - // - // * - // UPDATING - The data repository is undergoing a customer initiated update and - // availability may be impacted. - // - // * FAILED - The data repository is in a terminal - // state that cannot be recovered. + // configured with an S3 repository. The lifecycle can have the following values: + // - CREATING - The data repository configuration between the FSx file system and + // the linked S3 data repository is being created. The data repository is + // unavailable. + // - AVAILABLE - The data repository is available for use. + // - MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 + // bucket until the data repository configuration is corrected. For more + // information, see Troubleshooting a Misconfigured linked S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository) + // . + // - UPDATING - The data repository is undergoing a customer initiated update and + // availability may be impacted. + // - FAILED - The data repository is in a terminal state that cannot be + // recovered. Lifecycle DataRepositoryLifecycle noSmithyDocumentSerde } // Provides detailed information about the data repository if its Lifecycle is set -// to MISCONFIGURED or FAILED. +// to MISCONFIGURED or FAILED . type DataRepositoryFailureDetails struct { // A detailed error message. @@ -1403,38 +1200,26 @@ type DataRepositoryFailureDetails struct { // automatically release files from the cache. type DataRepositoryTask struct { - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. // // This member is required. CreationTime *time.Time // The lifecycle status of the data repository task, as follows: - // - // * PENDING - The - // task has not started. - // - // * EXECUTING - The task is in process. - // - // * FAILED - The - // task was not able to be completed. For example, there may be files the task - // failed to process. The DataRepositoryTaskFailureDetails property provides more - // information about task failures. - // - // * SUCCEEDED - The task has completed - // successfully. - // - // * CANCELED - The task was canceled and it did not complete. - // - // * - // CANCELING - The task is in process of being canceled. - // - // You cannot delete an FSx - // for Lustre file system if there are data repository tasks for the file system in - // the PENDING or EXECUTING states. Please retry when the data repository task is - // finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the - // DescribeDataRepositoryTask action to monitor the task status. Contact the FSx - // team if you need to delete your file system immediately. + // - PENDING - The task has not started. + // - EXECUTING - The task is in process. + // - FAILED - The task was not able to be completed. For example, there may be + // files the task failed to process. The DataRepositoryTaskFailureDetails + // property provides more information about task failures. + // - SUCCEEDED - The task has completed successfully. + // - CANCELED - The task was canceled and it did not complete. + // - CANCELING - The task is in process of being canceled. + // You cannot delete an FSx for Lustre file system if there are data repository + // tasks for the file system in the PENDING or EXECUTING states. Please retry when + // the data repository task is finished (with a status of CANCELED , SUCCEEDED , or + // FAILED ). You can use the DescribeDataRepositoryTask action to monitor the task + // status. Contact the FSx team if you need to delete your file system immediately. // // This member is required. Lifecycle DataRepositoryTaskLifecycle @@ -1445,19 +1230,13 @@ type DataRepositoryTask struct { TaskId *string // The type of data repository task. - // - // * EXPORT_TO_REPOSITORY tasks export from your - // Amazon FSx for Lustre file system to a linked data repository. - // - // * - // IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 - // bucket to your Amazon FSx for Lustre file system. - // - // * AUTO_RELEASE_DATA tasks - // automatically release files from an Amazon File Cache resource. - // - // * - // RELEASE_DATA_FROM_FILESYSTEM tasks are not supported. + // - EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file + // system to a linked data repository. + // - IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked + // S3 bucket to your Amazon FSx for Lustre file system. + // - AUTO_RELEASE_DATA tasks automatically release files from an Amazon File + // Cache resource. + // - RELEASE_DATA_FROM_FILESYSTEM tasks are not supported. // // This member is required. Type DataRepositoryTaskType @@ -1471,7 +1250,7 @@ type DataRepositoryTask struct { EndTime *time.Time // Failure message describing why the task failed, it is populated only when - // Lifecycle is set to FAILED. + // Lifecycle is set to FAILED . FailureDetails *DataRepositoryTaskFailureDetails // The system-generated, unique ID of the cache. @@ -1480,10 +1259,10 @@ type DataRepositoryTask struct { // The globally unique ID of the file system. FileSystemId *string - // An array of paths that specify the data for the data repository task to process. - // For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to - // export to the linked data repository. (Default) If Paths is not specified, - // Amazon FSx uses the file system root directory. + // An array of paths that specify the data for the data repository task to + // process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which + // data to export to the linked data repository. (Default) If Paths is not + // specified, Amazon FSx uses the file system root directory. Paths []string // Provides a report detailing the data repository task results of the files @@ -1496,9 +1275,8 @@ type DataRepositoryTask struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The time the system began processing the task. @@ -1515,7 +1293,7 @@ type DataRepositoryTask struct { } // Provides information about why a data repository task failed. Only populated -// when the task Lifecycle is set to FAILED. +// when the task Lifecycle is set to FAILED . type DataRepositoryTaskFailureDetails struct { // A detailed error message. @@ -1524,33 +1302,31 @@ type DataRepositoryTaskFailureDetails struct { noSmithyDocumentSerde } -// (Optional) An array of filter objects you can use to filter the response of data -// repository tasks you will see in the the response. You can filter the tasks +// (Optional) An array of filter objects you can use to filter the response of +// data repository tasks you will see in the the response. You can filter the tasks // returned in the response by one or more file system IDs, task lifecycles, and by -// task type. A filter object consists of a filter Name, and one or more Values for -// the filter. +// task type. A filter object consists of a filter Name , and one or more Values +// for the filter. type DataRepositoryTaskFilter struct { // Name of the task property to use in filtering the tasks returned in the // response. - // - // * Use file-system-id to retrieve data repository tasks for specific - // file systems. - // - // * Use task-lifecycle to retrieve data repository tasks with one - // or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, - // PENDING, and SUCCEEDED. + // - Use file-system-id to retrieve data repository tasks for specific file + // systems. + // - Use task-lifecycle to retrieve data repository tasks with one or more + // specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and + // SUCCEEDED. Name DataRepositoryTaskFilterName - // Use Values to include the specific file system IDs and task lifecycle states for - // the filters you are using. + // Use Values to include the specific file system IDs and task lifecycle states + // for the filters you are using. Values []string noSmithyDocumentSerde } -// Provides the task status showing a running total of the total number of files to -// be processed, the number successfully processed, and the number of files the +// Provides the task status showing a running total of the total number of files +// to be processed, the number successfully processed, and the number of files the // task failed to process. type DataRepositoryTaskStatus struct { @@ -1567,19 +1343,20 @@ type DataRepositoryTaskStatus struct { // A running total of the number of files that the task has successfully processed. SucceededCount *int64 - // The total number of files that the task will process. While a task is executing, - // the sum of SucceededCount plus FailedCount may not equal TotalCount. When the - // task is complete, TotalCount equals the sum of SucceededCount plus FailedCount. + // The total number of files that the task will process. While a task is + // executing, the sum of SucceededCount plus FailedCount may not equal TotalCount . + // When the task is complete, TotalCount equals the sum of SucceededCount plus + // FailedCount . TotalCount *int64 noSmithyDocumentSerde } -// The configuration object for the Amazon FSx for Lustre file system being deleted -// in the DeleteFileSystem operation. +// The configuration object for the Amazon FSx for Lustre file system being +// deleted in the DeleteFileSystem operation. type DeleteFileSystemLustreConfiguration struct { - // Use if SkipFinalBackup is set to false, and you want to apply an array of tags + // Use if SkipFinalBackup is set to false , and you want to apply an array of tags // to the final backup. If you have set the file system property CopyTagsToBackups // to true, and you specify one or more FinalBackupTags when deleting a file // system, Amazon FSx will not copy any existing file system tags to the backup. @@ -1587,9 +1364,9 @@ type DeleteFileSystemLustreConfiguration struct { // Set SkipFinalBackup to false if you want to take a final backup of the file // system you are deleting. By default, Amazon FSx will not take a final backup on - // your behalf when the DeleteFileSystem operation is invoked. (Default = true) The - // fsx:CreateBackup permission is required if you set SkipFinalBackup to false in - // order to delete the file system and take a final backup. + // your behalf when the DeleteFileSystem operation is invoked. (Default = true) + // The fsx:CreateBackup permission is required if you set SkipFinalBackup to false + // in order to delete the file system and take a final backup. SkipFinalBackup *bool noSmithyDocumentSerde @@ -1616,14 +1393,14 @@ type DeleteFileSystemOpenZFSConfiguration struct { FinalBackupTags []Tag // To delete a file system if there are child volumes present below the root - // volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system + // volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS . If your file system // has child volumes and you don't use this option, the delete request will fail. Options []DeleteFileSystemOpenZFSOption // By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the // DeleteFileSystem operation is invoked. Doing this helps protect you from data // loss, and we highly recommend taking the final backup. If you want to skip - // taking a final backup, set this value to true. + // taking a final backup, set this value to true . SkipFinalBackup *bool noSmithyDocumentSerde @@ -1701,7 +1478,7 @@ type DeleteVolumeOntapResponse struct { type DeleteVolumeOpenZFSConfiguration struct { // To delete the volume's child volumes, snapshots, and clones, use the string - // DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. + // DELETE_CHILD_VOLUMES_AND_SNAPSHOTS . Options []DeleteOpenZFSVolumeOption noSmithyDocumentSerde @@ -1718,7 +1495,7 @@ type DiskIopsConfiguration struct { Iops *int64 // Specifies whether the number of IOPS for the file system is using the system - // default (AUTOMATIC) or was provisioned by the customer (USER_PROVISIONED). + // default ( AUTOMATIC ) or was provisioned by the customer ( USER_PROVISIONED ). Mode DiskIopsConfigurationMode noSmithyDocumentSerde @@ -1728,8 +1505,8 @@ type DiskIopsConfiguration struct { // object from the DescribeFileCaches operation. type FileCache struct { - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time // The Domain Name System (DNS) name for the cache. @@ -1745,36 +1522,27 @@ type FileCache struct { // The system-generated, unique ID of the cache. FileCacheId *string - // The type of cache, which must be LUSTRE. + // The type of cache, which must be LUSTRE . FileCacheType FileCacheType - // The Lustre version of the cache, which must be 2.12. + // The Lustre version of the cache, which must be 2.12 . FileCacheTypeVersion *string // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon - // FSx-managed KMS key for your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // FSx-managed KMS key for your account is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The lifecycle status of the cache. The following are the possible values and // what they mean: - // - // * AVAILABLE - The cache is in a healthy state, and is reachable - // and available for use. - // - // * CREATING - The new cache is being created. - // - // * DELETING - // - An existing cache is being deleted. - // - // * UPDATING - The cache is undergoing a - // customer-initiated update. - // - // * FAILED - An existing cache has experienced an - // unrecoverable failure. When creating a new cache, the cache was unable to be - // created. + // - AVAILABLE - The cache is in a healthy state, and is reachable and available + // for use. + // - CREATING - The new cache is being created. + // - DELETING - An existing cache is being deleted. + // - UPDATING - The cache is undergoing a customer-initiated update. + // - FAILED - An existing cache has experienced an unrecoverable failure. When + // creating a new cache, the cache was unable to be created. Lifecycle FileCacheLifecycle // The configuration for the Amazon File Cache resource. @@ -1790,9 +1558,8 @@ type FileCache struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The storage capacity of the cache in gibibytes (GiB). @@ -1803,9 +1570,8 @@ type FileCache struct { SubnetIds []string // The ID of your virtual private cloud (VPC). For more information, see VPC and - // subnets - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in the - // Amazon VPC User Guide. + // subnets (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) + // in the Amazon VPC User Guide. VpcId *string noSmithyDocumentSerde @@ -1819,8 +1585,8 @@ type FileCacheCreating struct { // repository associations. CopyTagsToDataRepositoryAssociations *bool - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time // The Domain Name System (DNS) name for the cache. @@ -1836,36 +1602,27 @@ type FileCacheCreating struct { // The system-generated, unique ID of the cache. FileCacheId *string - // The type of cache, which must be LUSTRE. + // The type of cache, which must be LUSTRE . FileCacheType FileCacheType - // The Lustre version of the cache, which must be 2.12. + // The Lustre version of the cache, which must be 2.12 . FileCacheTypeVersion *string // Specifies the ID of the Key Management Service (KMS) key to use for encrypting // data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon - // FSx-managed KMS key for your account is used. For more information, see Encrypt - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the - // Key Management Service API Reference. + // FSx-managed KMS key for your account is used. For more information, see Encrypt (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) + // in the Key Management Service API Reference. KmsKeyId *string // The lifecycle status of the cache. The following are the possible values and // what they mean: - // - // * AVAILABLE - The cache is in a healthy state, and is reachable - // and available for use. - // - // * CREATING - The new cache is being created. - // - // * DELETING - // - An existing cache is being deleted. - // - // * UPDATING - The cache is undergoing a - // customer-initiated update. - // - // * FAILED - An existing cache has experienced an - // unrecoverable failure. When creating a new cache, the cache was unable to be - // created. + // - AVAILABLE - The cache is in a healthy state, and is reachable and available + // for use. + // - CREATING - The new cache is being created. + // - DELETING - An existing cache is being deleted. + // - UPDATING - The cache is undergoing a customer-initiated update. + // - FAILED - An existing cache has experienced an unrecoverable failure. When + // creating a new cache, the cache was unable to be created. Lifecycle FileCacheLifecycle // The configuration for the Amazon File Cache resource. @@ -1881,9 +1638,8 @@ type FileCacheCreating struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The storage capacity of the cache in gibibytes (GiB). @@ -1897,9 +1653,8 @@ type FileCacheCreating struct { Tags []Tag // The ID of your virtual private cloud (VPC). For more information, see VPC and - // subnets - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in the - // Amazon VPC User Guide. + // subnets (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) + // in the Amazon VPC User Guide. VpcId *string noSmithyDocumentSerde @@ -1914,33 +1669,28 @@ type FileCacheDataRepositoryAssociation struct { // The path to the S3 or NFS data repository that links to the cache. You must // provide one of the following paths: - // - // * The path can be an NFS data repository - // that links to the cache. The path can be in one of two formats: - // - // * If you are - // not using the DataRepositorySubdirectories parameter, the path is to an NFS - // Export directory (or one of its subdirectories) in the format - // nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to - // a single data repository association. - // - // * If you are using the - // DataRepositorySubdirectories parameter, the path is the domain name of the NFS - // file system in the format nfs://filer-domain-name, which indicates the root of - // the subdirectories specified with the DataRepositorySubdirectories parameter. - // - // * - // The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. + // - The path can be an NFS data repository that links to the cache. The path + // can be in one of two formats: + // - If you are not using the DataRepositorySubdirectories parameter, the path is + // to an NFS Export directory (or one of its subdirectories) in the format + // nsf://nfs-domain-name/exportpath . You can therefore link a single NFS Export + // to a single data repository association. + // - If you are using the DataRepositorySubdirectories parameter, the path is the + // domain name of the NFS file system in the format nfs://filer-domain-name , + // which indicates the root of the subdirectories specified with the + // DataRepositorySubdirectories parameter. + // - The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ + // . // // This member is required. DataRepositoryPath *string - // A path on the cache that points to a high-level directory (such as /ns1/) or - // subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with - // DataRepositoryPath. The leading forward slash in the name is required. Two data + // A path on the cache that points to a high-level directory (such as /ns1/ ) or + // subdirectory (such as /ns1/subdir/ ) that will be mapped 1-1 with + // DataRepositoryPath . The leading forward slash in the name is required. Two data // repository associations cannot have overlapping cache paths. For example, if a - // data repository is associated with cache path /ns1/, then you cannot link - // another data repository with cache path /ns1/ns2. This path specifies where in + // data repository is associated with cache path /ns1/ , then you cannot link + // another data repository with cache path /ns1/ns2 . This path specifies where in // your cache files will be exported from. This cache directory can be linked to // only one data repository, and no data repository other can be linked to the // directory. The cache path can only be set to root (/) on an NFS DRA when @@ -1951,11 +1701,12 @@ type FileCacheDataRepositoryAssociation struct { // This member is required. FileCachePath *string - // A list of NFS Exports that will be linked with this data repository association. - // The Export paths are in the format /exportpath1. To use this parameter, you must - // configure DataRepositoryPath as the domain name of the NFS file system. The NFS - // file system domain name in effect is the root of the subdirectories. Note that - // DataRepositorySubdirectories is not supported for S3 data repositories. + // A list of NFS Exports that will be linked with this data repository + // association. The Export paths are in the format /exportpath1 . To use this + // parameter, you must configure DataRepositoryPath as the domain name of the NFS + // file system. The NFS file system domain name in effect is the root of the + // subdirectories. Note that DataRepositorySubdirectories is not supported for S3 + // data repositories. DataRepositorySubdirectories []string // The configuration for a data repository association that links an Amazon File @@ -1977,7 +1728,7 @@ type FileCacheFailureDetails struct { // The configuration for the Amazon File Cache resource. type FileCacheLustreConfiguration struct { - // The deployment type of the Amazon File Cache resource, which must be CACHE_1. + // The deployment type of the Amazon File Cache resource, which must be CACHE_1 . DeploymentType FileCacheLustreDeploymentType // The configuration for Lustre logging used to write the enabled logging events @@ -1992,18 +1743,17 @@ type FileCacheLustreConfiguration struct { // the cache's description. MountName *string - // Per unit storage throughput represents the megabytes per second of read or write - // throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is - // equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only - // supported value is 1000. + // Per unit storage throughput represents the megabytes per second of read or + // write throughput per 1 tebibyte of storage provisioned. Cache throughput + // capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput + // (MB/s/TiB). The only supported value is 1000 . PerUnitStorageThroughput *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2028,7 +1778,7 @@ type FileCacheLustreMetadataConfiguration struct { type FileCacheNFSConfiguration struct { // The version of the NFS (Network File System) protocol of the NFS data - // repository. The only supported value is NFS3, which indicates that the data + // repository. The only supported value is NFS3 , which indicates that the data // repository must support the NFSv3 protocol. // // This member is required. @@ -2064,55 +1814,38 @@ type FileSystem struct { // The system-generated, unique 17-digit ID of the file system. FileSystemId *string - // The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or - // OPENZFS. + // The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or + // OPENZFS . FileSystemType FileSystemType - // The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or - // 2.12. + // The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or 2.12 + // . FileSystemTypeVersion *string // The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file // system data. Used as follows with Amazon FSx file system types: - // - // * Amazon FSx - // for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and - // SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your - // account. - // - // * Amazon FSx for NetApp ONTAP - // - // * Amazon FSx for OpenZFS - // - // * Amazon FSx - // for Windows File Server + // - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. + // SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS + // key for your account. + // - Amazon FSx for NetApp ONTAP + // - Amazon FSx for OpenZFS + // - Amazon FSx for Windows File Server KmsKeyId *string // The lifecycle status of the file system. The following are the possible values // and what they mean: - // - // * AVAILABLE - The file system is in a healthy state, and is - // reachable and available for use. - // - // * CREATING - Amazon FSx is creating the new - // file system. - // - // * DELETING - Amazon FSx is deleting an existing file system. - // - // * - // FAILED - An existing file system has experienced an unrecoverable failure. When - // creating a new file system, Amazon FSx was unable to create the file system. - // - // * - // MISCONFIGURED - The file system is in a failed but recoverable state. - // - // * - // MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file - // system is currently unavailable due to a change in your Active Directory - // configuration. - // - // * UPDATING - The file system is undergoing a customer-initiated - // update. + // - AVAILABLE - The file system is in a healthy state, and is reachable and + // available for use. + // - CREATING - Amazon FSx is creating the new file system. + // - DELETING - Amazon FSx is deleting an existing file system. + // - FAILED - An existing file system has experienced an unrecoverable failure. + // When creating a new file system, Amazon FSx was unable to create the file + // system. + // - MISCONFIGURED - The file system is in a failed but recoverable state. + // - MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The + // file system is currently unavailable due to a change in your Active Directory + // configuration. + // - UPDATING - The file system is undergoing a customer-initiated update. Lifecycle FileSystemLifecycle // The configuration for the Amazon FSx for Lustre file system. @@ -2121,11 +1854,10 @@ type FileSystem struct { // The IDs of the elastic network interfaces from which a specific file system is // accessible. The elastic network interface is automatically created in the same // virtual private cloud (VPC) that the Amazon FSx file system was created in. For - // more information, see Elastic Network Interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the - // Amazon EC2 User Guide. For an Amazon FSx for Windows File Server file system, - // you can have one network interface ID. For an Amazon FSx for Lustre file system, - // you can have more than one. + // more information, see Elastic Network Interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) + // in the Amazon EC2 User Guide. For an Amazon FSx for Windows File Server file + // system, you can have one network interface ID. For an Amazon FSx for Lustre file + // system, you can have more than one. NetworkInterfaceIds []string // The configuration for this Amazon FSx for NetApp ONTAP file system. @@ -2134,9 +1866,9 @@ type FileSystem struct { // The configuration for this Amazon FSx for OpenZFS file system. OpenZFSConfiguration *OpenZFSFileSystemConfiguration - // The Amazon Web Services account that created the file system. If the file system - // was created by a user in IAM Identity Center, the Amazon Web Services account to - // which the IAM user belongs is the owner. + // The Amazon Web Services account that created the file system. If the file + // system was created by a user in IAM Identity Center, the Amazon Web Services + // account to which the IAM user belongs is the owner. OwnerId *string // The Amazon Resource Name (ARN) of the file system resource. @@ -2145,8 +1877,8 @@ type FileSystem struct { // The storage capacity of the file system in gibibytes (GiB). StorageCapacity *int32 - // The type of storage the file system is using. If set to SSD, the file system - // uses solid state drive storage. If set to HDD, the file system uses hard disk + // The type of storage the file system is using. If set to SSD , the file system + // uses solid state drive storage. If set to HDD , the file system uses hard disk // drive storage. StorageType StorageType @@ -2158,13 +1890,12 @@ type FileSystem struct { // FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID // of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows // and ONTAP file systems, the file system endpoint is available in the - // PreferredSubnetID. + // PreferredSubnetID . SubnetIds []string // The tags to associate with the file system. For more information, see Tagging - // your Amazon EC2 resources - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the - // Amazon EC2 User Guide. + // your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) + // in the Amazon EC2 User Guide. Tags []Tag // The ID of the primary virtual private cloud (VPC) for the file system. @@ -2244,39 +1975,34 @@ type LustreFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 - // A boolean flag indicating whether tags on the file system are copied to backups. - // If it's set to true, all tags on the file system are copied to all automatic - // backups and any user-initiated backups where the user doesn't specify any tags. - // If this value is true, and you specify one or more tags, only the specified tags - // are copied to backups. If you specify one or more tags when creating a - // user-initiated backup, no tags are copied from the file system, regardless of - // this value. (Default = false) + // A boolean flag indicating whether tags on the file system are copied to + // backups. If it's set to true, all tags on the file system are copied to all + // automatic backups and any user-initiated backups where the user doesn't specify + // any tags. If this value is true, and you specify one or more tags, only the + // specified tags are copied to backups. If you specify one or more tags when + // creating a user-initiated backup, no tags are copied from the file system, + // regardless of this value. (Default = false) CopyTagsToBackups *bool - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string // The data compression configuration for the file system. DataCompressionType can // have the following values: - // - // * NONE - Data compression is turned off for the file - // system. - // - // * LZ4 - Data compression is turned on with the LZ4 algorithm. - // - // For more - // information, see Lustre data compression - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html). + // - NONE - Data compression is turned off for the file system. + // - LZ4 - Data compression is turned on with the LZ4 algorithm. + // For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html) + // . DataCompressionType DataCompressionType - // The data repository configuration object for Lustre file systems returned in the - // response of the CreateFileSystem operation. This data type is not supported on - // file systems with a data repository association. For file systems with a data + // The data repository configuration object for Lustre file systems returned in + // the response of the CreateFileSystem operation. This data type is not supported + // on file systems with a data repository association. For file systems with a data // repository association, see . DataRepositoryConfiguration *DataRepositoryConfiguration @@ -2285,14 +2011,13 @@ type LustreFileSystemConfiguration struct { // and SCRATCH_2 deployment types are best suited for when you need temporary // storage and shorter-term processing of data. The SCRATCH_2 deployment type // provides in-transit encryption of data and higher burst throughput capacity than - // SCRATCH_1. The PERSISTENT_1 and PERSISTENT_2 deployment type is used for + // SCRATCH_1 . The PERSISTENT_1 and PERSISTENT_2 deployment type is used for // longer-term storage and workloads and encryption of data in transit. // PERSISTENT_2 is built on Lustre v2.12 and offers higher PerUnitStorageThroughput // (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement - // (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for - // Lustre deployment options - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html). - // The default is SCRATCH_1. + // (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for + // Lustre deployment options (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html) + // . The default is SCRATCH_1 . DeploymentType LustreDeploymentType // The type of drive cache used by PERSISTENT_1 file systems that are provisioned @@ -2308,24 +2033,19 @@ type LustreFileSystemConfiguration struct { LogConfiguration *LustreLogConfiguration // You use the MountName value when mounting the file system. For the SCRATCH_1 - // deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and - // PERSISTENT_2 deployment types, this value is a string that is unique within an - // Amazon Web Services Region. + // deployment type, this value is always " fsx ". For SCRATCH_2 , PERSISTENT_1 , + // and PERSISTENT_2 deployment types, this value is a string that is unique within + // an Amazon Web Services Region. MountName *string - // Per unit storage throughput represents the megabytes per second of read or write - // throughput per 1 tebibyte of storage provisioned. File system throughput + // Per unit storage throughput represents the megabytes per second of read or + // write throughput per 1 tebibyte of storage provisioned. File system throughput // capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput // (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 // deployment types. Valid values: - // - // * For PERSISTENT_1 SSD storage: 50, 100, - // 200. - // - // * For PERSISTENT_1 HDD storage: 12, 40. - // - // * For PERSISTENT_2 SSD storage: - // 125, 250, 500, 1000. + // - For PERSISTENT_1 SSD storage: 50, 100, 200. + // - For PERSISTENT_1 HDD storage: 12, 40. + // - For PERSISTENT_2 SSD storage: 125, 250, 500, 1000. PerUnitStorageThroughput *int32 // The Lustre root squash configuration for an Amazon FSx for Lustre file system. @@ -2333,9 +2053,9 @@ type LustreFileSystemConfiguration struct { // access your file system as a root user. RootSquashConfiguration *LustreRootSquashConfiguration - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with - // Monday and ending with Sunday. + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in + // the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning + // with Monday and ending with Sunday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2347,20 +2067,12 @@ type LustreFileSystemConfiguration struct { type LustreLogConfiguration struct { // The data repository events that are logged by Amazon FSx. - // - // * WARN_ONLY - only - // warning events are logged. - // - // * ERROR_ONLY - only error events are logged. - // - // * - // WARN_ERROR - both warning events and error events are logged. - // - // * DISABLED - - // logging of data repository events is turned off. - // - // Note that Amazon File Cache - // uses a default setting of WARN_ERROR, which can't be changed. + // - WARN_ONLY - only warning events are logged. + // - ERROR_ONLY - only error events are logged. + // - WARN_ERROR - both warning events and error events are logged. + // - DISABLED - logging of data repository events is turned off. + // Note that Amazon File Cache uses a default setting of WARN_ERROR , which can't + // be changed. // // This member is required. Level LustreAccessAuditLogLevel @@ -2382,17 +2094,10 @@ type LustreLogConfiguration struct { type LustreLogCreateConfiguration struct { // Sets which data repository events are logged by Amazon FSx. - // - // * WARN_ONLY - only - // warning events are logged. - // - // * ERROR_ONLY - only error events are logged. - // - // * - // WARN_ERROR - both warning events and error events are logged. - // - // * DISABLED - - // logging of data repository events is turned off. + // - WARN_ONLY - only warning events are logged. + // - ERROR_ONLY - only error events are logged. + // - WARN_ERROR - both warning events and error events are logged. + // - DISABLED - logging of data repository events is turned off. // // This member is required. Level LustreAccessAuditLogLevel @@ -2400,66 +2105,52 @@ type LustreLogCreateConfiguration struct { // The Amazon Resource Name (ARN) that specifies the destination of the logs. The // destination can be any Amazon CloudWatch Logs log group ARN, with the following // requirements: - // - // * The destination ARN that you provide must be in the same Amazon - // Web Services partition, Amazon Web Services Region, and Amazon Web Services - // account as your Amazon FSx file system. - // - // * The name of the Amazon CloudWatch - // Logs log group must begin with the /aws/fsx prefix. - // - // * If you do not provide a - // destination, Amazon FSx will create and use a log stream in the CloudWatch Logs - // /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for - // Amazon File Cache). - // - // * If Destination is provided and the resource does not - // exist, the request will fail with a BadRequest error. - // - // * If Level is set to - // DISABLED, you cannot specify a destination in Destination. + // - The destination ARN that you provide must be in the same Amazon Web + // Services partition, Amazon Web Services Region, and Amazon Web Services account + // as your Amazon FSx file system. + // - The name of the Amazon CloudWatch Logs log group must begin with the + // /aws/fsx prefix. + // - If you do not provide a destination, Amazon FSx will create and use a log + // stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for + // Lustre) or /aws/fsx/filecache (for Amazon File Cache). + // - If Destination is provided and the resource does not exist, the request will + // fail with a BadRequest error. + // - If Level is set to DISABLED , you cannot specify a destination in + // Destination . Destination *string noSmithyDocumentSerde } -// The configuration for Lustre root squash used to restrict root-level access from -// clients that try to access your FSx for Lustre file system as root. Use the +// The configuration for Lustre root squash used to restrict root-level access +// from clients that try to access your FSx for Lustre file system as root. Use the // RootSquash parameter to enable root squash. To learn more about Lustre root -// squash, see Lustre root squash -// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html). You can -// also use the NoSquashNids parameter to provide an array of clients who are not -// affected by the root squash setting. These clients will access the file system -// as root, with unrestricted privileges. +// squash, see Lustre root squash (https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html) +// . You can also use the NoSquashNids parameter to provide an array of clients +// who are not affected by the root squash setting. These clients will access the +// file system as root, with unrestricted privileges. type LustreRootSquashConfiguration struct { // When root squash is enabled, you can optionally specify an array of NIDs of // clients for which root squash does not apply. A client NID is a Lustre Network // Identifier used to uniquely identify a client. You can specify the NID as either // a single address or a range of addresses: - // - // * A single address is described in - // standard Lustre NID format by specifying the client’s IP address followed by the - // Lustre network ID (for example, 10.0.1.6@tcp). - // - // * An address range is described - // using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp). + // - A single address is described in standard Lustre NID format by specifying + // the client’s IP address followed by the Lustre network ID (for example, + // 10.0.1.6@tcp ). + // - An address range is described using a dash to separate the range (for + // example, 10.0.[2-10].[1-255]@tcp ). NoSquashNids []string // You enable root squash by setting a user ID (UID) and group ID (GID) for the - // file system in the format UID:GID (for example, 365534:65534). The UID and GID - // values can range from 0 to 4294967294: - // - // * A non-zero value for UID and GID - // enables root squash. The UID and GID values can be different, but each must be a - // non-zero value. - // - // * A value of 0 (zero) for UID and GID indicates root, and - // therefore disables root squash. - // - // When root squash is enabled, the user ID and - // group ID of a root user accessing the file system are re-mapped to the UID and - // GID you provide. + // file system in the format UID:GID (for example, 365534:65534 ). The UID and GID + // values can range from 0 to 4294967294 : + // - A non-zero value for UID and GID enables root squash. The UID and GID + // values can be different, but each must be a non-zero value. + // - A value of 0 (zero) for UID and GID indicates root, and therefore disables + // root squash. + // When root squash is enabled, the user ID and group ID of a root user accessing + // the file system are re-mapped to the UID and GID you provide. RootSquash *string noSmithyDocumentSerde @@ -2470,7 +2161,7 @@ type LustreRootSquashConfiguration struct { type NFSDataRepositoryConfiguration struct { // The version of the NFS (Network File System) protocol of the NFS data - // repository. Currently, the only supported value is NFS3, which indicates that + // repository. Currently, the only supported value is NFS3 , which indicates that // the data repository must support the NFSv3 protocol. // // This member is required. @@ -2493,27 +2184,23 @@ type OntapFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string // Specifies the FSx for ONTAP file system deployment type in use in the file // system. + // - MULTI_AZ_1 - (Default) A high availability file system configured for + // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. // - // * MULTI_AZ_1 - (Default) A high availability file system configured for - // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) - // unavailability. - // - // * SINGLE_AZ_1 - A file system configured for Single-AZ - // redundancy. - // - // For information about the use cases for Multi-AZ and Single-AZ - // deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html). + // - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. + // For information about the use cases for Multi-AZ and Single-AZ deployments, + // refer to Choosing Multi-AZ or Single-AZ file system deployment (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) + // . DeploymentType OntapDeploymentType // The SSD IOPS configuration for the ONTAP file system, specifying the number of @@ -2534,10 +2221,9 @@ type OntapFileSystemConfiguration struct { // SnapMirror. Endpoints *FileSystemEndpoints - // The ID for a subnet. A subnet is a range of IP addresses in your virtual private - // cloud (VPC). For more information, see VPC and subnets - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in the - // Amazon VPC User Guide. + // The ID for a subnet. A subnet is a range of IP addresses in your virtual + // private cloud (VPC). For more information, see VPC and subnets (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) + // in the Amazon VPC User Guide. PreferredSubnetId *string // (Multi-AZ only) The VPC route tables in which your file system's endpoints are @@ -2548,12 +2234,11 @@ type OntapFileSystemConfiguration struct { // (MBps). ThroughputCapacity *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2573,41 +2258,32 @@ type OntapVolumeConfiguration struct { // Specifies the FlexCache endpoint type of the volume. Valid values are the // following: - // - // * NONE specifies that the volume doesn't have a FlexCache - // configuration. NONE is the default. - // - // * ORIGIN specifies that the volume is the - // origin volume for a FlexCache volume. - // - // * CACHE specifies that the volume is a - // FlexCache volume. + // - NONE specifies that the volume doesn't have a FlexCache configuration. NONE + // is the default. + // - ORIGIN specifies that the volume is the origin volume for a FlexCache + // volume. + // - CACHE specifies that the volume is a FlexCache volume. FlexCacheEndpointType FlexCacheEndpointType - // Specifies the directory that network-attached storage (NAS) clients use to mount - // the volume, along with the storage virtual machine (SVM) Domain Name System - // (DNS) name or IP address. You can create a JunctionPath directly below a parent - // volume junction or on a directory within a volume. A JunctionPath for a volume - // named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even - // /dir1/dir2/vol3. + // Specifies the directory that network-attached storage (NAS) clients use to + // mount the volume, along with the storage virtual machine (SVM) Domain Name + // System (DNS) name or IP address. You can create a JunctionPath directly below a + // parent volume junction or on a directory within a volume. A JunctionPath for a + // volume named vol3 might be /vol1/vol2/vol3 , or /vol1/dir2/vol3 , or even + // /dir1/dir2/vol3 . JunctionPath *string // Specifies the type of volume. Valid values are the following: - // - // * RW specifies a - // read/write volume. RW is the default. - // - // * DP specifies a data-protection volume. - // You can protect data by replicating it to data-protection mirror copies. If a - // disaster occurs, you can use these data-protection mirror copies to recover - // data. - // - // * LS specifies a load-sharing mirror volume. A load-sharing mirror - // reduces the network traffic to a FlexVol volume by providing additional - // read-only access to clients. + // - RW specifies a read/write volume. RW is the default. + // - DP specifies a data-protection volume. You can protect data by replicating + // it to data-protection mirror copies. If a disaster occurs, you can use these + // data-protection mirror copies to recover data. + // - LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the + // network traffic to a FlexVol volume by providing additional read-only access to + // clients. OntapVolumeType OntapVolumeType - // The security style for the volume, which can be UNIX, NTFS, or MIXED. + // The security style for the volume, which can be UNIX , NTFS , or MIXED . SecurityStyle SecurityStyle // The configured size of the volume, in megabytes (MBs). @@ -2615,24 +2291,16 @@ type OntapVolumeConfiguration struct { // Specifies the snapshot policy for the volume. There are three built-in snapshot // policies: - // - // * default: This is the default policy. A maximum of six hourly - // snapshots taken five minutes past the hour. A maximum of two daily snapshots - // taken Monday through Saturday at 10 minutes after midnight. A maximum of two - // weekly snapshots taken every Sunday at 15 minutes after midnight. - // - // * - // default-1weekly: This policy is the same as the default policy except that it - // only retains one snapshot from the weekly schedule. - // - // * none: This policy does - // not take any snapshots. This policy can be assigned to volumes to prevent - // automatic snapshots from being taken. - // - // You can also provide the name of a custom - // policy that you created with the ONTAP CLI or REST API. For more information, - // see Snapshot policies - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) + // - default : This is the default policy. A maximum of six hourly snapshots + // taken five minutes past the hour. A maximum of two daily snapshots taken Monday + // through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots + // taken every Sunday at 15 minutes after midnight. + // - default-1weekly : This policy is the same as the default policy except that + // it only retains one snapshot from the weekly schedule. + // - none : This policy does not take any snapshots. This policy can be assigned + // to volumes to prevent automatic snapshots from being taken. + // You can also provide the name of a custom policy that you created with the + // ONTAP CLI or REST API. For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) // in the Amazon FSx for NetApp ONTAP User Guide. SnapshotPolicy *string @@ -2642,11 +2310,11 @@ type OntapVolumeConfiguration struct { // The ID of the volume's storage virtual machine. StorageVirtualMachineId *string - // A Boolean flag indicating whether this volume is the root volume for its storage - // virtual machine (SVM). Only one volume on an SVM can be the root volume. This - // value defaults to false. If this value is true, then this is the SVM root + // A Boolean flag indicating whether this volume is the root volume for its + // storage virtual machine (SVM). Only one volume on an SVM can be the root volume. + // This value defaults to false . If this value is true , then this is the SVM root // volume. This flag is useful when you're deleting an SVM, because you must first - // delete all non-root volumes. This flag, when set to false, helps you identify + // delete all non-root volumes. This flag, when set to false , helps you identify // which volumes to delete before you can delete the SVM. StorageVirtualMachineRoot *bool @@ -2663,25 +2331,23 @@ type OntapVolumeConfiguration struct { // mounting the file system. type OpenZFSClientConfiguration struct { - // A value that specifies who can mount the file system. You can provide a wildcard - // character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By - // default, Amazon FSx uses the wildcard character when specifying the client. + // A value that specifies who can mount the file system. You can provide a + // wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( + // 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when + // specifying the client. // // This member is required. Clients *string - // The options to use when mounting the file system. For a list of options that you - // can use with Network File System (NFS), see the exports(5) - Linux man page - // (https://linux.die.net/man/5/exports). When choosing your options, consider the - // following: - // - // * crossmnt is used by default. If you don't specify crossmnt when - // changing the client configuration, you won't be able to see or access snapshots - // in your file system's snapshot directory. - // - // * sync is used by default. If you - // instead specify async, the system acknowledges writes before writing to disk. If - // the system crashes before the writes are finished, you lose the unwritten data. + // The options to use when mounting the file system. For a list of options that + // you can use with Network File System (NFS), see the exports(5) - Linux man page (https://linux.die.net/man/5/exports) + // . When choosing your options, consider the following: + // - crossmnt is used by default. If you don't specify crossmnt when changing the + // client configuration, you won't be able to see or access snapshots in your file + // system's snapshot directory. + // - sync is used by default. If you instead specify async , the system + // acknowledges writes before writing to disk. If the system crashes before the + // writes are finished, you lose the unwritten data. // // This member is required. Options []string @@ -2693,35 +2359,31 @@ type OpenZFSClientConfiguration struct { type OpenZFSCreateRootVolumeConfiguration struct { // A Boolean value indicating whether tags for the volume should be copied to - // snapshots of the volume. This value defaults to false. If it's set to true, all - // tags for the volume are copied to snapshots where the user doesn't specify tags. - // If this value is true and you specify one or more tags, only the specified tags - // are copied to snapshots. If you specify one or more tags when creating the - // snapshot, no tags are copied from the volume, regardless of this value. + // snapshots of the volume. This value defaults to false . If it's set to true , + // all tags for the volume are copied to snapshots where the user doesn't specify + // tags. If this value is true and you specify one or more tags, only the + // specified tags are copied to snapshots. If you specify one or more tags when + // creating the snapshot, no tags are copied from the volume, regardless of this + // value. CopyTagsToSnapshots *bool // Specifies the method used to compress the data on the volume. The compression // type is NONE by default. - // - // * NONE - Doesn't compress the data on the volume. NONE - // is the default. - // - // * ZSTD - Compresses the data in the volume using the Zstandard - // (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better - // compression ratio to minimize on-disk storage utilization. - // - // * LZ4 - Compresses - // the data in the volume using the LZ4 compression algorithm. Compared to - // Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput - // speeds. + // - NONE - Doesn't compress the data on the volume. NONE is the default. + // - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write + // throughput speeds. DataCompressionType OpenZFSDataCompressionType // The configuration object for mounting a file system. NfsExports []OpenZFSNfsExport // A Boolean value indicating whether the volume is read-only. Setting this value - // to true can be useful after you have completed changes to a volume and no longer - // want changes to occur. + // to true can be useful after you have completed changes to a volume and no + // longer want changes to occur. ReadOnly *bool // Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid @@ -2729,8 +2391,7 @@ type OpenZFSCreateRootVolumeConfiguration struct { // Most workloads should use the default record size. Database workflows can // benefit from a smaller record size, while streaming workflows can benefit from a // larger record size. For additional guidance on setting a custom record size, see - // Tips for maximizing performance - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) // in the Amazon FSx for OpenZFS User Guide. RecordSizeKiB *int32 @@ -2745,11 +2406,11 @@ type OpenZFSFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags on the file system should be copied to - // backups. If it's set to true, all tags on the file system are copied to all + // backups. If it's set to true , all tags on the file system are copied to all // automatic backups and any user-initiated backups where the user doesn't specify // any tags. If this value is true and you specify one or more tags, only the // specified tags are copied to backups. If you specify one or more tags when @@ -2758,20 +2419,20 @@ type OpenZFSFileSystemConfiguration struct { CopyTagsToBackups *bool // A Boolean value indicating whether tags for the volume should be copied to - // snapshots. This value defaults to false. If it's set to true, all tags for the + // snapshots. This value defaults to false . If it's set to true , all tags for the // volume are copied to snapshots where the user doesn't specify tags. If this // value is true and you specify one or more tags, only the specified tags are // copied to snapshots. If you specify one or more tags when creating the snapshot, // no tags are copied from the volume, regardless of this value. CopyTagsToVolumes *bool - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string // Specifies the file-system deployment type. Amazon FSx for OpenZFS supports - // SINGLE_AZ_1 and SINGLE_AZ_2. + // SINGLE_AZ_1 and SINGLE_AZ_2 . DeploymentType OpenZFSDeploymentType // The SSD IOPS (input/output operations per second) configuration for an Amazon @@ -2788,12 +2449,11 @@ type OpenZFSFileSystemConfiguration struct { // (MBps). ThroughputCapacity *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2803,8 +2463,8 @@ type OpenZFSFileSystemConfiguration struct { // OpenZFS file system. type OpenZFSNfsExport struct { - // A list of configuration objects that contain the client and options for mounting - // the OpenZFS file system. + // A list of configuration objects that contain the client and options for + // mounting the OpenZFS file system. // // This member is required. ClientConfigurations []OpenZFSClientConfiguration @@ -2817,23 +2477,18 @@ type OpenZFSNfsExport struct { type OpenZFSOriginSnapshotConfiguration struct { // The strategy used when copying data from the snapshot to the new volume. - // - // * - // CLONE - The new volume references the data in the origin snapshot. Cloning a - // snapshot is faster than copying the data from a snapshot to a new volume and - // doesn't consume disk throughput. However, the origin snapshot can't be deleted - // if there is a volume using its copied data. - // - // * FULL_COPY - Copies all data from - // the snapshot to the new volume. + // - CLONE - The new volume references the data in the origin snapshot. Cloning a + // snapshot is faster than copying the data from a snapshot to a new volume and + // doesn't consume disk throughput. However, the origin snapshot can't be deleted + // if there is a volume using its copied data. + // - FULL_COPY - Copies all data from the snapshot to the new volume. CopyStrategy OpenZFSCopyStrategy // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. SnapshotARN *string noSmithyDocumentSerde @@ -2864,7 +2519,7 @@ type OpenZFSUserOrGroupQuota struct { type OpenZFSVolumeConfiguration struct { // A Boolean value indicating whether tags for the volume should be copied to - // snapshots. This value defaults to false. If it's set to true, all tags for the + // snapshots. This value defaults to false . If it's set to true , all tags for the // volume are copied to snapshots where the user doesn't specify tags. If this // value is true and you specify one or more tags, only the specified tags are // copied to snapshots. If you specify one or more tags when creating the snapshot, @@ -2873,18 +2528,13 @@ type OpenZFSVolumeConfiguration struct { // Specifies the method used to compress the data on the volume. The compression // type is NONE by default. - // - // * NONE - Doesn't compress the data on the volume. NONE - // is the default. - // - // * ZSTD - Compresses the data in the volume using the Zstandard - // (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better - // compression ratio to minimize on-disk storage utilization. - // - // * LZ4 - Compresses - // the data in the volume using the LZ4 compression algorithm. Compared to - // Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput - // speeds. + // - NONE - Doesn't compress the data on the volume. NONE is the default. + // - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write + // throughput speeds. DataCompressionType OpenZFSDataCompressionType // A Boolean value indicating whether dependent clone volumes created from @@ -2899,8 +2549,8 @@ type OpenZFSVolumeConfiguration struct { // The configuration object for mounting a Network File System (NFS) file system. NfsExports []OpenZFSNfsExport - // The configuration object that specifies the snapshot to use as the origin of the - // data for the volume. + // The configuration object that specifies the snapshot to use as the origin of + // the data for the volume. OriginSnapshot *OpenZFSOriginSnapshotConfiguration // The ID of the parent volume. @@ -2909,10 +2559,10 @@ type OpenZFSVolumeConfiguration struct { // A Boolean value indicating whether the volume is read-only. ReadOnly *bool - // The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, - // 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads - // should use the default record size. For guidance on when to set a custom record - // size, see the Amazon FSx for OpenZFS User Guide. + // The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, + // 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most + // workloads should use the default record size. For guidance on when to set a + // custom record size, see the Amazon FSx for OpenZFS User Guide. RecordSizeKiB *int32 // Specifies the ID of the snapshot to which the volume was restored. @@ -2931,7 +2581,7 @@ type OpenZFSVolumeConfiguration struct { UserAndGroupQuotas []OpenZFSUserOrGroupQuota // The path to the volume from the root volume. For example, - // fsx/parentVolume/volume1. + // fsx/parentVolume/volume1 . VolumePath *string noSmithyDocumentSerde @@ -2990,11 +2640,10 @@ type SelfManagedActiveDirectoryAttributes struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more -// information, see Using Amazon FSx with your self-managed Microsoft Active -// Directory -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or -// Managing SVMs -// (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html). +// information, see Using Amazon FSx with your self-managed Microsoft Active +// Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) +// or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) +// . type SelfManagedActiveDirectoryConfiguration struct { // A list of up to three IP addresses of DNS servers or domain controllers in the @@ -3004,7 +2653,7 @@ type SelfManagedActiveDirectoryConfiguration struct { DnsIps []string // The fully qualified domain name of the self-managed AD directory, such as - // corp.example.com. + // corp.example.com . // // This member is required. DomainName *string @@ -3015,27 +2664,27 @@ type SelfManagedActiveDirectoryConfiguration struct { // This member is required. Password *string - // The user name for the service account on your self-managed AD domain that Amazon - // FSx will use to join to your AD domain. This account must have the permission to - // join computers to the domain in the organizational unit provided in - // OrganizationalUnitDistinguishedName, or in the default location of your AD + // The user name for the service account on your self-managed AD domain that + // Amazon FSx will use to join to your AD domain. This account must have the + // permission to join computers to the domain in the organizational unit provided + // in OrganizationalUnitDistinguishedName , or in the default location of your AD // domain. // // This member is required. UserName *string - // (Optional) The name of the domain group whose members are granted administrative - // privileges for the file system. Administrative privileges include taking - // ownership of files and folders, setting audit controls (audit ACLs) on files and - // folders, and administering the file system remotely by using the FSx Remote - // PowerShell. The group that you specify must already exist in your domain. If you - // don't provide one, your AD domain's Domain Admins group is used. + // (Optional) The name of the domain group whose members are granted + // administrative privileges for the file system. Administrative privileges include + // taking ownership of files and folders, setting audit controls (audit ACLs) on + // files and folders, and administering the file system remotely by using the FSx + // Remote PowerShell. The group that you specify must already exist in your domain. + // If you don't provide one, your AD domain's Domain Admins group is used. FileSystemAdministratorsGroup *string // (Optional) The fully qualified distinguished name of the organizational unit // within your self-managed AD directory. Amazon FSx only accepts OU as the direct - // parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To - // learn more, see RFC 2253 (https://tools.ietf.org/html/rfc2253). If none is + // parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com . + // To learn more, see RFC 2253 (https://tools.ietf.org/html/rfc2253) . If none is // provided, the FSx file system is created in the default location of your // self-managed AD directory. Only Organizational Unit (OU) objects can be the // direct parent of the file system that you're creating. @@ -3056,10 +2705,10 @@ type SelfManagedActiveDirectoryConfigurationUpdates struct { // FSx will use to join to your AD domain. Password *string - // The user name for the service account on your self-managed AD domain that Amazon - // FSx will use to join to your AD domain. This account must have the permission to - // join computers to the domain in the organizational unit provided in - // OrganizationalUnitDistinguishedName. + // The user name for the service account on your self-managed AD domain that + // Amazon FSx will use to join to your AD domain. This account must have the + // permission to join computers to the domain in the organizational unit provided + // in OrganizationalUnitDistinguishedName . UserName *string noSmithyDocumentSerde @@ -3073,22 +2722,15 @@ type Snapshot struct { // FSx system. AdministrativeActions []AdministrativeAction - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time // The lifecycle status of the snapshot. - // - // * PENDING - Amazon FSx hasn't started - // creating the snapshot. - // - // * CREATING - Amazon FSx is creating the snapshot. - // - // * - // DELETING - Amazon FSx is deleting the snapshot. - // - // * AVAILABLE - The snapshot is - // fully available. + // - PENDING - Amazon FSx hasn't started creating the snapshot. + // - CREATING - Amazon FSx is creating the snapshot. + // - DELETING - Amazon FSx is deleting the snapshot. + // - AVAILABLE - The snapshot is fully available. Lifecycle SnapshotLifecycle // Describes why a resource lifecycle state changed. @@ -3100,9 +2742,8 @@ type Snapshot struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The ID of the snapshot. @@ -3122,7 +2763,7 @@ type Snapshot struct { type SnapshotFilter struct { // The name of the filter to use. You can filter by the file-system-id or by - // volume-id. + // volume-id . Name SnapshotFilterName // The file-system-id or volume-id that you are filtering for. @@ -3139,35 +2780,25 @@ type StorageVirtualMachine struct { // joined, if applicable. ActiveDirectoryConfiguration *SvmActiveDirectoryConfiguration - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time - // The endpoints that are used to access data or to manage the SVM using the NetApp - // ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, - // Nfs, and Smb endpoints. + // The endpoints that are used to access data or to manage the SVM using the + // NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi , + // Management , Nfs , and Smb endpoints. Endpoints *SvmEndpoints // The globally unique ID of the file system, assigned by Amazon FSx. FileSystemId *string // Describes the SVM's lifecycle status. - // - // * CREATED - The SVM is fully available - // for use. - // - // * CREATING - Amazon FSx is creating the new SVM. - // - // * DELETING - Amazon - // FSx is deleting an existing SVM. - // - // * FAILED - Amazon FSx was unable to create the - // SVM. - // - // * MISCONFIGURED - The SVM is in a failed but recoverable state. - // - // * PENDING - // - Amazon FSx has not started creating the SVM. + // - CREATED - The SVM is fully available for use. + // - CREATING - Amazon FSx is creating the new SVM. + // - DELETING - Amazon FSx is deleting an existing SVM. + // - FAILED - Amazon FSx was unable to create the SVM. + // - MISCONFIGURED - The SVM is in a failed but recoverable state. + // - PENDING - Amazon FSx has not started creating the SVM. Lifecycle StorageVirtualMachineLifecycle // Describes why the SVM lifecycle state changed. @@ -3179,9 +2810,8 @@ type StorageVirtualMachine struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // The security style of the root volume of the SVM. @@ -3236,8 +2866,8 @@ type SvmActiveDirectoryConfiguration struct { // An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints // that are used to access data or to manage the SVM using the NetApp ONTAP CLI, -// REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb -// endpoints. +// REST API, or NetApp CloudManager. They are the Iscsi , Management , Nfs , and +// Smb endpoints. type SvmEndpoint struct { // The Domain Name Service (DNS) name for the file system. You can mount your file @@ -3275,16 +2905,16 @@ type SvmEndpoints struct { // Specifies a key-value pair for a resource tag. type Tag struct { - // A value that specifies the TagKey, the name of the tag. Tag keys must be unique + // A value that specifies the TagKey , the name of the tag. Tag keys must be unique // for the resource to which they are attached. // // This member is required. Key *string - // A value that specifies the TagValue, the value assigned to the corresponding tag - // key. Tag values can be null and don't have to be unique in a tag set. For - // example, you can have a key-value pair in a tag set of finances : April and also - // of payroll : April. + // A value that specifies the TagValue , the value assigned to the corresponding + // tag key. Tag values can be null and don't have to be unique in a tag set. For + // example, you can have a key-value pair in a tag set of finances : April and + // also of payroll : April . // // This member is required. Value *string @@ -3297,42 +2927,34 @@ type Tag struct { // between the file system's primary storage and capacity pool storage based on // your access patterns. Valid tiering policies are the following: // -// * SNAPSHOT_ONLY -// - (Default value) moves cold snapshots to the capacity pool storage tier. +// - SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool +// storage tier. // -// * -// AUTO - moves cold user data and snapshots to the capacity pool storage tier -// based on your access patterns. +// - AUTO - moves cold user data and snapshots to the capacity pool storage tier +// based on your access patterns. // -// * ALL - moves all user data blocks in both the -// active file system and Snapshot copies to the storage pool tier. +// - ALL - moves all user data blocks in both the active file system and Snapshot +// copies to the storage pool tier. // -// * NONE - keeps -// a volume's data in the primary storage tier, preventing it from being moved to -// the capacity pool tier. +// - NONE - keeps a volume's data in the primary storage tier, preventing it from +// being moved to the capacity pool tier. type TieringPolicy struct { // Specifies the number of days that user data in a volume must remain inactive // before it is considered "cold" and moved to the capacity pool. Used with the - // AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. - // Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY. + // AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and + // 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY . CoolingPeriod *int32 // Specifies the tiering policy used to transition data. Default value is - // SNAPSHOT_ONLY. - // - // * SNAPSHOT_ONLY - moves cold snapshots to the capacity pool - // storage tier. - // - // * AUTO - moves cold user data and snapshots to the capacity pool - // storage tier based on your access patterns. - // - // * ALL - moves all user data blocks - // in both the active file system and Snapshot copies to the storage pool tier. - // - // * - // NONE - keeps a volume's data in the primary storage tier, preventing it from - // being moved to the capacity pool tier. + // SNAPSHOT_ONLY . + // - SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier. + // - AUTO - moves cold user data and snapshots to the capacity pool storage tier + // based on your access patterns. + // - ALL - moves all user data blocks in both the active file system and Snapshot + // copies to the storage pool tier. + // - NONE - keeps a volume's data in the primary storage tier, preventing it from + // being moved to the capacity pool tier. Name TieringPolicyName noSmithyDocumentSerde @@ -3341,12 +2963,11 @@ type TieringPolicy struct { // The configuration update for an Amazon File Cache resource. type UpdateFileCacheLustreConfiguration struct { - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3360,53 +2981,41 @@ type UpdateFileSystemLustreConfiguration struct { // file and directory listings. Use this property to choose how Amazon FSx keeps // your file and directory listing up to date as you add or modify objects in your // linked S3 bucket. AutoImportPolicy can have the following values: - // - // * NONE - - // (Default) AutoImport is off. Amazon FSx only updates file and directory listings - // from the linked S3 bucket when the file system is created. FSx does not update - // the file and directory listing for any new or changed objects after choosing - // this option. - // - // * NEW - AutoImport is on. Amazon FSx automatically imports - // directory listings of any new objects added to the linked S3 bucket that do not - // currently exist in the FSx file system. - // - // * NEW_CHANGED - AutoImport is on. - // Amazon FSx automatically imports file and directory listings of any new objects - // added to the S3 bucket and any existing objects that are changed in the S3 - // bucket after you choose this option. - // - // * NEW_CHANGED_DELETED - AutoImport is on. - // Amazon FSx automatically imports file and directory listings of any new objects - // added to the S3 bucket, any existing objects that are changed in the S3 bucket, - // and any objects that were deleted in the S3 bucket. - // - // This parameter is not - // supported for file systems with a data repository association. + // - NONE - (Default) AutoImport is off. Amazon FSx only updates file and + // directory listings from the linked S3 bucket when the file system is created. + // FSx does not update the file and directory listing for any new or changed + // objects after choosing this option. + // - NEW - AutoImport is on. Amazon FSx automatically imports directory listings + // of any new objects added to the linked S3 bucket that do not currently exist in + // the FSx file system. + // - NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and + // directory listings of any new objects added to the S3 bucket and any existing + // objects that are changed in the S3 bucket after you choose this option. + // - NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports + // file and directory listings of any new objects added to the S3 bucket, any + // existing objects that are changed in the S3 bucket, and any objects that were + // deleted in the S3 bucket. + // This parameter is not supported for file systems with a data repository + // association. AutoImportPolicy AutoImportPolicyType // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string // Sets the data compression configuration for the file system. DataCompressionType // can have the following values: - // - // * NONE - Data compression is turned off for the - // file system. - // - // * LZ4 - Data compression is turned on with the LZ4 algorithm. - // - // If - // you don't use DataCompressionType, the file system retains its current data - // compression configuration. For more information, see Lustre data compression - // (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html). + // - NONE - Data compression is turned off for the file system. + // - LZ4 - Data compression is turned on with the LZ4 algorithm. + // If you don't use DataCompressionType , the file system retains its current data + // compression configuration. For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html) + // . DataCompressionType DataCompressionType // The Lustre logging configuration used when updating an Amazon FSx for Lustre @@ -3414,9 +3023,9 @@ type UpdateFileSystemLustreConfiguration struct { // data repositories associated with your file system to Amazon CloudWatch Logs. LogConfiguration *LustreLogCreateConfiguration - // The Lustre root squash configuration used when updating an Amazon FSx for Lustre - // file system. When enabled, root squash restricts root-level access from clients - // that try to access your file system as a root user. + // The Lustre root squash configuration used when updating an Amazon FSx for + // Lustre file system. When enabled, root squash restricts root-level access from + // clients that try to access your file system as a root user. RootSquashConfiguration *LustreRootSquashConfiguration // (Optional) The preferred start time to perform weekly maintenance, formatted @@ -3430,16 +3039,16 @@ type UpdateFileSystemLustreConfiguration struct { // The configuration updates for an Amazon FSx for NetApp ONTAP file system. type UpdateFileSystemOntapConfiguration struct { - // (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to - // associate (add) with your Amazon FSx for NetApp ONTAP file system. + // (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables + // to associate (add) with your Amazon FSx for NetApp ONTAP file system. AddRouteTableIds []string // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string @@ -3447,7 +3056,7 @@ type UpdateFileSystemOntapConfiguration struct { // The SSD IOPS (input/output operations per second) configuration for an Amazon // FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage // capacity, but you can provision additional IOPS per GB of storage. The - // configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in + // configuration consists of an IOPS mode ( AUTOMATIC or USER_PROVISIONED ), and in // the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. DiskIopsConfiguration *DiskIopsConfiguration @@ -3465,12 +3074,11 @@ type UpdateFileSystemOntapConfiguration struct { // 4096 MBps. ThroughputCapacity *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3481,11 +3089,11 @@ type UpdateFileSystemOpenZFSConfiguration struct { // The number of days to retain automatic backups. Setting this property to 0 // disables automatic backups. You can retain automatic backups for a maximum of 90 - // days. The default is 0. + // days. The default is 0 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags for the file system should be copied to - // backups. This value defaults to false. If it's set to true, all tags for the + // backups. This value defaults to false . If it's set to true , all tags for the // file system are copied to all automatic and user-initiated backups where the // user doesn't specify tags. If this value is true and you specify one or more // tags, only the specified tags are copied to backups. If you specify one or more @@ -3494,14 +3102,14 @@ type UpdateFileSystemOpenZFSConfiguration struct { CopyTagsToBackups *bool // A Boolean value indicating whether tags for the volume should be copied to - // snapshots. This value defaults to false. If it's set to true, all tags for the + // snapshots. This value defaults to false . If it's set to true , all tags for the // volume are copied to snapshots where the user doesn't specify tags. If this // value is true and you specify one or more tags, only the specified tags are // copied to snapshots. If you specify one or more tags when creating the snapshot, // no tags are copied from the volume, regardless of this value. CopyTagsToVolumes *bool - // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the + // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the // day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 // specifies 5 AM daily. DailyAutomaticBackupStartTime *string @@ -3516,20 +3124,17 @@ type UpdateFileSystemOpenZFSConfiguration struct { // The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes // per second
 (MB/s). Valid values depend on the DeploymentType you choose, as // follows: - // - // * For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, - // 3072, or 4096 MB/s. - // - // * For SINGLE_AZ_2, valid values are 160, 320, 640, 1280, - // 2560, 3840, 5120, 7680, or 10240 MB/s. + // - For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or + // 4096 MB/s. + // - For SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, + // 7680, or 10240 MB/s. ThroughputCapacity *int32 - // A recurring weekly time, in the format D:HH:MM. D is the day of the week, for + // A recurring weekly time, in the format D:HH:MM . D is the day of the week, for // which 1 represents Monday and 7 represents Sunday. For further details, see the - // ISO-8601 spec as described on Wikipedia - // (https://en.wikipedia.org/wiki/ISO_week_date). HH is the zero-padded hour of the - // day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 - // specifies maintenance at 5 AM Monday. + // ISO-8601 spec as described on Wikipedia (https://en.wikipedia.org/wiki/ISO_week_date) + // . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded + // minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3548,8 +3153,8 @@ type UpdateFileSystemWindowsConfiguration struct { // The number of days to retain automatic daily backups. Setting this to zero (0) // disables automatic daily backups. You can retain automatic daily backups for a // maximum of 90 days. For more information, see Working with Automatic Daily - // Backups - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups). + // Backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups) + // . AutomaticBackupRetentionDays *int32 // The preferred time to start the daily automatic backup, in the UTC time zone, @@ -3562,17 +3167,17 @@ type UpdateFileSystemWindowsConfiguration struct { // update request in progress. SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates - // Sets the target value for a file system's throughput capacity, in MB/s, that you - // are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, - // 1024, 2048. You cannot make a throughput capacity update request if there is an - // existing throughput capacity update request in progress. For more information, - // see Managing Throughput Capacity - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html). + // Sets the target value for a file system's throughput capacity, in MB/s, that + // you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, + // 512, 1024, 2048. You cannot make a throughput capacity update request if there + // is an existing throughput capacity update request in progress. For more + // information, see Managing Throughput Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html) + // . ThroughputCapacity *int32 - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday - // and 7 = Sunday. + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in + // the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = + // Monday and 7 = Sunday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3592,10 +3197,10 @@ type UpdateOntapVolumeConfiguration struct { CopyTagsToBackups *bool // Specifies the location in the SVM's namespace where the volume is mounted. The - // JunctionPath must have a leading forward slash, such as /vol3. + // JunctionPath must have a leading forward slash, such as /vol3 . JunctionPath *string - // The security style for the volume, which can be UNIX. NTFS, or MIXED. + // The security style for the volume, which can be UNIX . NTFS , or MIXED . SecurityStyle SecurityStyle // Specifies the size of the volume in megabytes. @@ -3603,28 +3208,20 @@ type UpdateOntapVolumeConfiguration struct { // Specifies the snapshot policy for the volume. There are three built-in snapshot // policies: - // - // * default: This is the default policy. A maximum of six hourly - // snapshots taken five minutes past the hour. A maximum of two daily snapshots - // taken Monday through Saturday at 10 minutes after midnight. A maximum of two - // weekly snapshots taken every Sunday at 15 minutes after midnight. - // - // * - // default-1weekly: This policy is the same as the default policy except that it - // only retains one snapshot from the weekly schedule. - // - // * none: This policy does - // not take any snapshots. This policy can be assigned to volumes to prevent - // automatic snapshots from being taken. - // - // You can also provide the name of a custom - // policy that you created with the ONTAP CLI or REST API. For more information, - // see Snapshot policies - // (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) + // - default : This is the default policy. A maximum of six hourly snapshots + // taken five minutes past the hour. A maximum of two daily snapshots taken Monday + // through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots + // taken every Sunday at 15 minutes after midnight. + // - default-1weekly : This policy is the same as the default policy except that + // it only retains one snapshot from the weekly schedule. + // - none : This policy does not take any snapshots. This policy can be assigned + // to volumes to prevent automatic snapshots from being taken. + // You can also provide the name of a custom policy that you created with the + // ONTAP CLI or REST API. For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) // in the Amazon FSx for NetApp ONTAP User Guide. SnapshotPolicy *string - // Default is false. Set to true to enable the deduplication, compression, and + // Default is false . Set to true to enable the deduplication, compression, and // compaction storage efficiency features on the volume. StorageEfficiencyEnabled *bool @@ -3634,24 +3231,19 @@ type UpdateOntapVolumeConfiguration struct { noSmithyDocumentSerde } -// Used to specify changes to the OpenZFS configuration for the volume that you are -// updating. +// Used to specify changes to the OpenZFS configuration for the volume that you +// are updating. type UpdateOpenZFSVolumeConfiguration struct { // Specifies the method used to compress the data on the volume. The compression // type is NONE by default. - // - // * NONE - Doesn't compress the data on the volume. NONE - // is the default. - // - // * ZSTD - Compresses the data in the volume using the Zstandard - // (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better - // compression ratio to minimize on-disk storage utilization. - // - // * LZ4 - Compresses - // the data in the volume using the LZ4 compression algorithm. Compared to - // Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput - // speeds. + // - NONE - Doesn't compress the data on the volume. NONE is the default. + // - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write + // throughput speeds. DataCompressionType OpenZFSDataCompressionType // The configuration object for mounting a Network File System (NFS) file system. @@ -3660,13 +3252,12 @@ type UpdateOpenZFSVolumeConfiguration struct { // A Boolean value indicating whether the volume is read-only. ReadOnly *bool - // Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values - // are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most - // workloads should use the default record size. Database workflows can benefit - // from a smaller record size, while streaming workflows can benefit from a larger - // record size. For additional guidance on when to set a custom record size, see - // Tips for maximizing performance - // (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid + // values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. + // Most workloads should use the default record size. Database workflows can + // benefit from a smaller record size, while streaming workflows can benefit from a + // larger record size. For additional guidance on when to set a custom record size, + // see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) // in the Amazon FSx for OpenZFS User Guide. RecordSizeKiB *int32 @@ -3687,8 +3278,9 @@ type UpdateOpenZFSVolumeConfiguration struct { noSmithyDocumentSerde } -// Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an -// AD. Please note, account credentials are not returned in the response payload. +// Updates the Microsoft Active Directory (AD) configuration of an SVM joined to +// an AD. Please note, account credentials are not returned in the response +// payload. type UpdateSvmActiveDirectoryConfiguration struct { // The configuration that Amazon FSx uses to join the Windows File Server instance @@ -3706,33 +3298,21 @@ type Volume struct { // have initiated using the UpdateVolume action. AdministrativeActions []AdministrativeAction - // The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), - // also known as Unix time. + // The time that the resource was created, in seconds (since + // 1970-01-01T00:00:00Z), also known as Unix time. CreationTime *time.Time // The globally unique ID of the file system, assigned by Amazon FSx. FileSystemId *string // The lifecycle status of the volume. - // - // * AVAILABLE - The volume is fully available - // for use. - // - // * CREATED - The volume has been created. - // - // * CREATING - Amazon FSx is - // creating the new volume. - // - // * DELETING - Amazon FSx is deleting an existing - // volume. - // - // * FAILED - Amazon FSx was unable to create the volume. - // - // * MISCONFIGURED - // - The volume is in a failed but recoverable state. - // - // * PENDING - Amazon FSx - // hasn't started creating the volume. + // - AVAILABLE - The volume is fully available for use. + // - CREATED - The volume has been created. + // - CREATING - Amazon FSx is creating the new volume. + // - DELETING - Amazon FSx is deleting an existing volume. + // - FAILED - Amazon FSx was unable to create the volume. + // - MISCONFIGURED - The volume is in a failed but recoverable state. + // - PENDING - Amazon FSx hasn't started creating the volume. Lifecycle VolumeLifecycle // The reason why the volume lifecycle status changed. @@ -3750,9 +3330,8 @@ type Volume struct { // The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify // Amazon Web Services resources. We require an ARN when you need to specify a // resource unambiguously across all of Amazon Web Services. For more information, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARN *string // A list of Tag values, with a maximum of 50 elements. @@ -3784,42 +3363,27 @@ type VolumeFilter struct { // The configuration that Amazon FSx for Windows File Server uses to audit and log // user accesses of files, folders, and file shares on the Amazon FSx for Windows -// File Server file system. For more information, see File access auditing -// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/file-access-auditing.html). +// File Server file system. For more information, see File access auditing (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/file-access-auditing.html) +// . type WindowsAuditLogConfiguration struct { // Sets which attempt type is logged by Amazon FSx for file and folder accesses. - // - // * - // SUCCESS_ONLY - only successful attempts to access files or folders are - // logged. - // - // * FAILURE_ONLY - only failed attempts to access files or folders are - // logged. - // - // * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to - // access files or folders are logged. - // - // * DISABLED - access auditing of files and - // folders is turned off. + // - SUCCESS_ONLY - only successful attempts to access files or folders are + // logged. + // - FAILURE_ONLY - only failed attempts to access files or folders are logged. + // - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access + // files or folders are logged. + // - DISABLED - access auditing of files and folders is turned off. // // This member is required. FileAccessAuditLogLevel WindowsAccessAuditLogLevel // Sets which attempt type is logged by Amazon FSx for file share accesses. - // - // * - // SUCCESS_ONLY - only successful attempts to access file shares are logged. - // - // * - // FAILURE_ONLY - only failed attempts to access file shares are logged. - // - // * - // SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access - // file shares are logged. - // - // * DISABLED - access auditing of file shares is turned - // off. + // - SUCCESS_ONLY - only successful attempts to access file shares are logged. + // - FAILURE_ONLY - only failed attempts to access file shares are logged. + // - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access + // file shares are logged. + // - DISABLED - access auditing of file shares is turned off. // // This member is required. FileShareAccessAuditLogLevel WindowsAccessAuditLogLevel @@ -3837,71 +3401,47 @@ type WindowsAuditLogConfiguration struct { noSmithyDocumentSerde } -// The Windows file access auditing configuration used when creating or updating an -// Amazon FSx for Windows File Server file system. +// The Windows file access auditing configuration used when creating or updating +// an Amazon FSx for Windows File Server file system. type WindowsAuditLogCreateConfiguration struct { // Sets which attempt type is logged by Amazon FSx for file and folder accesses. - // - // * - // SUCCESS_ONLY - only successful attempts to access files or folders are - // logged. - // - // * FAILURE_ONLY - only failed attempts to access files or folders are - // logged. - // - // * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to - // access files or folders are logged. - // - // * DISABLED - access auditing of files and - // folders is turned off. + // - SUCCESS_ONLY - only successful attempts to access files or folders are + // logged. + // - FAILURE_ONLY - only failed attempts to access files or folders are logged. + // - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access + // files or folders are logged. + // - DISABLED - access auditing of files and folders is turned off. // // This member is required. FileAccessAuditLogLevel WindowsAccessAuditLogLevel // Sets which attempt type is logged by Amazon FSx for file share accesses. - // - // * - // SUCCESS_ONLY - only successful attempts to access file shares are logged. - // - // * - // FAILURE_ONLY - only failed attempts to access file shares are logged. - // - // * - // SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access - // file shares are logged. - // - // * DISABLED - access auditing of file shares is turned - // off. + // - SUCCESS_ONLY - only successful attempts to access file shares are logged. + // - FAILURE_ONLY - only failed attempts to access file shares are logged. + // - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access + // file shares are logged. + // - DISABLED - access auditing of file shares is turned off. // // This member is required. FileShareAccessAuditLogLevel WindowsAccessAuditLogLevel - // The Amazon Resource Name (ARN) that specifies the destination of the audit logs. - // The destination can be any Amazon CloudWatch Logs log group ARN or Amazon + // The Amazon Resource Name (ARN) that specifies the destination of the audit + // logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon // Kinesis Data Firehose delivery stream ARN, with the following requirements: - // - // * - // The destination ARN that you provide (either CloudWatch Logs log group or - // Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services - // partition, Amazon Web Services Region, and Amazon Web Services account as your - // Amazon FSx file system. - // - // * The name of the Amazon CloudWatch Logs log group must - // begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse - // delivery stream must begin with the aws-fsx prefix. - // - // * If you do not provide a - // destination in AuditLogDestination, Amazon FSx will create and use a log stream - // in the CloudWatch Logs /aws/fsx/windows log group. - // - // * If AuditLogDestination is - // provided and the resource does not exist, the request will fail with a - // BadRequest error. - // - // * If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel - // are both set to DISABLED, you cannot specify a destination in - // AuditLogDestination. + // - The destination ARN that you provide (either CloudWatch Logs log group or + // Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services + // partition, Amazon Web Services Region, and Amazon Web Services account as your + // Amazon FSx file system. + // - The name of the Amazon CloudWatch Logs log group must begin with the + // /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream + // must begin with the aws-fsx prefix. + // - If you do not provide a destination in AuditLogDestination , Amazon FSx will + // create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group. + // - If AuditLogDestination is provided and the resource does not exist, the + // request will fail with a BadRequest error. + // - If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to + // DISABLED , you cannot specify a destination in AuditLogDestination . AuditLogDestination *string noSmithyDocumentSerde @@ -3921,8 +3461,8 @@ type WindowsFileSystemConfiguration struct { // create the file system using the AssociateFileSystemAliases operation. You can // remove DNS aliases from the file system after it is created using the // DisassociateFileSystemAliases operation. You only need to specify the alias name - // in the request payload. For more information, see DNS aliases - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html). + // in the request payload. For more information, see DNS aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) + // . Aliases []Alias // The configuration that Amazon FSx for Windows File Server uses to audit and log @@ -3947,22 +3487,16 @@ type WindowsFileSystemConfiguration struct { DailyAutomaticBackupStartTime *string // Specifies the file system deployment type, valid values are the following: - // - // * - // MULTI_AZ_1 - Specifies a high availability file system that is configured for - // Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, - // and supports SSD and HDD storage. - // - // * SINGLE_AZ_1 - (Default) Specifies a file - // system that is configured for single AZ redundancy, only supports SSD - // storage. - // - // * SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a - // file system that is configured for single AZ redundancy and supports SSD and HDD - // storage. - // - // For more information, see Single-AZ and Multi-AZ File Systems - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). + // - MULTI_AZ_1 - Specifies a high availability file system that is configured + // for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) + // unavailability, and supports SSD and HDD storage. + // - SINGLE_AZ_1 - (Default) Specifies a file system that is configured for + // single AZ redundancy, only supports SSD storage. + // - SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file + // system that is configured for single AZ redundancy and supports SSD and HDD + // storage. + // For more information, see Single-AZ and Multi-AZ File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) + // . DeploymentType WindowsDeploymentType // The list of maintenance operations in progress for this file system. @@ -3975,18 +3509,18 @@ type WindowsFileSystemConfiguration struct { // address is temporarily unavailable when the file system is undergoing // maintenance. For Linux and Windows SMB clients that are joined to an Active // Directory, use the file system's DNSName instead. For more information on - // mapping and mounting file shares, see Accessing File Shares - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html). + // mapping and mounting file shares, see Accessing File Shares (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html) + // . PreferredFileServerIp *string // For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the // preferred file server is located. Must be one of the two subnet IDs specified in // SubnetIds property. Amazon FSx serves traffic from this subnet except in the // event of a failover to the secondary file server. For SINGLE_AZ_1 and - // SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For + // SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For // more information, see Availability and durability: Single-AZ and Multi-AZ file - // systems - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources). + // systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources) + // . PreferredSubnetId *string // For MULTI_AZ_1 deployment types, use this endpoint when performing @@ -4004,9 +3538,9 @@ type WindowsFileSystemConfiguration struct { // The throughput of the Amazon FSx file system, measured in megabytes per second. ThroughputCapacity *int32 - // The preferred start time to perform weekly maintenance, formatted d:HH:MM in the - // UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday - // and ending with Sunday. + // The preferred start time to perform weekly maintenance, formatted d:HH:MM in + // the UTC time zone. d is the weekday number, from 1 through 7, beginning with + // Monday and ending with Sunday. WeeklyMaintenanceStartTime *string noSmithyDocumentSerde diff --git a/service/gamelift/api_client.go b/service/gamelift/api_client.go index 13b93d2eeb8..2d910ece14c 100644 --- a/service/gamelift/api_client.go +++ b/service/gamelift/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/gamelift/api_op_AcceptMatch.go b/service/gamelift/api_op_AcceptMatch.go index b7bf11daaa2..181a6127a2f 100644 --- a/service/gamelift/api_op_AcceptMatch.go +++ b/service/gamelift/api_op_AcceptMatch.go @@ -16,23 +16,21 @@ import ( // built with that configuration cannot be completed unless all players accept the // proposed match within a specified time limit. When FlexMatch builds a match, all // the matchmaking tickets involved in the proposed match are placed into status -// REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all +// REQUIRES_ACCEPTANCE . This is a trigger for your game to get acceptance from all // players in the ticket. Acceptances are only valid for tickets when they are in // this status; all other acceptances result in an error. To register acceptance, // specify the ticket ID, a response, and one or more players. Once all players -// have registered acceptance, the matchmaking tickets advance to status PLACING, +// have registered acceptance, the matchmaking tickets advance to status PLACING , // where a new game session is created for the match. If any player rejects the // match, or if acceptances are not received before a specified timeout, the // proposed match is dropped. The matchmaking tickets are then handled in one of // two ways: For tickets where one or more players rejected the match or failed to -// respond, the ticket status is set to CANCELLED, and processing is terminated. +// respond, the ticket status is set to CANCELLED , and processing is terminated. // For tickets where players have accepted or not yet responded, the ticket status // is returned to SEARCHING to find a new match. A new matchmaking request for -// these players can be submitted as needed. Learn more Add FlexMatch to a game -// client -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) -// FlexMatch events -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) +// these players can be submitted as needed. Learn more Add FlexMatch to a game +// client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) +// FlexMatch events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) // (reference) func (c *Client) AcceptMatch(ctx context.Context, params *AcceptMatchInput, optFns ...func(*Options)) (*AcceptMatchOutput, error) { if params == nil { @@ -63,7 +61,7 @@ type AcceptMatchInput struct { PlayerIds []string // A unique identifier for a matchmaking ticket. The ticket must be in status - // REQUIRES_ACCEPTANCE; otherwise this request will fail. + // REQUIRES_ACCEPTANCE ; otherwise this request will fail. // // This member is required. TicketId *string diff --git a/service/gamelift/api_op_ClaimGameServer.go b/service/gamelift/api_op_ClaimGameServer.go index e5e735d97ea..4cf5efc976d 100644 --- a/service/gamelift/api_op_ClaimGameServer.go +++ b/service/gamelift/api_op_ClaimGameServer.go @@ -23,26 +23,20 @@ import ( // game data to pass to the game server at the start of a game session, such as a // game map or player information. When a game server is successfully claimed, // connection information is returned. A claimed game server's utilization status -// remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. -// This time period gives the game server time to update its status to UTILIZED -// after players join. If the game server's status is not updated within 60 -// seconds, the game server reverts to unclaimed status and is available to be +// remains AVAILABLE while the claim status is set to CLAIMED for up to 60 +// seconds. This time period gives the game server time to update its status to +// UTILIZED after players join. If the game server's status is not updated within +// 60 seconds, the game server reverts to unclaimed status and is available to be // claimed by another request. The claim time period is a fixed value and is not // configurable. If you try to claim a specific game server, this request will fail // in the following cases: +// - If the game server utilization status is UTILIZED . +// - If the game server claim status is CLAIMED . // -// * If the game server utilization status is UTILIZED. -// -// * -// If the game server claim status is CLAIMED. -// -// When claiming a specific game -// server, this request will succeed even if the game server is running on an -// instance in DRAINING status. To avoid this, first check the instance status by -// calling DescribeGameServerInstances -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html) -// . Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// When claiming a specific game server, this request will succeed even if the +// game server is running on an instance in DRAINING status. To avoid this, first +// check the instance status by calling DescribeGameServerInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html) +// . Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) ClaimGameServer(ctx context.Context, params *ClaimGameServerInput, optFns ...func(*Options)) (*ClaimGameServerOutput, error) { if params == nil { params = &ClaimGameServerInput{} @@ -67,9 +61,9 @@ type ClaimGameServerInput struct { // This member is required. GameServerGroupName *string - // A set of custom game server properties, formatted as a single string value. This - // data is passed to a game client or service when it requests information on game - // servers. + // A set of custom game server properties, formatted as a single string value. + // This data is passed to a game client or service when it requests information on + // game servers. GameServerData *string // A custom string that uniquely identifies the game server to claim. If this diff --git a/service/gamelift/api_op_CreateAlias.go b/service/gamelift/api_op_CreateAlias.go index 628f8fafc78..9e9b9bccb70 100644 --- a/service/gamelift/api_op_CreateAlias.go +++ b/service/gamelift/api_op_CreateAlias.go @@ -23,8 +23,7 @@ import ( // and optional description. Each simple alias can point to only one fleet, but a // fleet can have multiple aliases. If successful, a new alias record is returned, // including an alias ID and an ARN. You can reassign an alias to another fleet by -// calling UpdateAlias. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// calling UpdateAlias . Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { params = &CreateAliasInput{} @@ -42,8 +41,8 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. + // A descriptive label that is associated with an alias. Alias names do not need + // to be unique. // // This member is required. Name *string @@ -57,12 +56,11 @@ type CreateAliasInput struct { // A human-readable description of the alias. Description *string - // A list of labels to assign to the new alias resource. Tags are developer-defined - // key-value pairs. Tagging Amazon Web Services resources are useful for resource - // management, access management and cost allocation. For more information, see - // Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // A list of labels to assign to the new alias resource. Tags are + // developer-defined key-value pairs. Tagging Amazon Web Services resources are + // useful for resource management, access management and cost allocation. For more + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateBuild.go b/service/gamelift/api_op_CreateBuild.go index 645dc8c4ddd..dabf38604e6 100644 --- a/service/gamelift/api_op_CreateBuild.go +++ b/service/gamelift/api_op_CreateBuild.go @@ -14,38 +14,29 @@ import ( // Creates a new Amazon GameLift build resource for your game server binary files. // Combine game server binaries into a zip file for use with Amazon GameLift. When // setting up a new game build for GameLift, we recommend using the CLI command -// upload-build -// (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) . -// This helper command combines two tasks: (1) it uploads your build files from a +// upload-build (https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) +// . This helper command combines two tasks: (1) it uploads your build files from a // file directory to a GameLift Amazon S3 location, and (2) it creates a new build // resource. You can use the operation in the following scenarios: +// - To create a new game build with build files that are in an Amazon S3 +// location under an Amazon Web Services account that you control. To use this +// option, you give Amazon GameLift access to the Amazon S3 bucket. With +// permissions in place, specify a build name, operating system, and the Amazon S3 +// storage location of your game build. +// - To directly upload your build files to a GameLift Amazon S3 location. To +// use this option, specify a build name and operating system. This operation +// creates a new build resource and also returns an Amazon S3 location with +// temporary access credentials. Use the credentials to manually upload your build +// files to the specified Amazon S3 location. For more information, see +// Uploading Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) +// in the Amazon S3 Developer Guide. After you upload build files to the GameLift +// Amazon S3 location, you can't update them. // -// * To create a -// new game build with build files that are in an Amazon S3 location under an -// Amazon Web Services account that you control. To use this option, you give -// Amazon GameLift access to the Amazon S3 bucket. With permissions in place, -// specify a build name, operating system, and the Amazon S3 storage location of -// your game build. -// -// * To directly upload your build files to a GameLift Amazon S3 -// location. To use this option, specify a build name and operating system. This -// operation creates a new build resource and also returns an Amazon S3 location -// with temporary access credentials. Use the credentials to manually upload your -// build files to the specified Amazon S3 location. For more information, see -// Uploading Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html) in the -// Amazon S3 Developer Guide. After you upload build files to the GameLift Amazon -// S3 location, you can't update them. -// -// If successful, this operation creates a new -// build resource with a unique build ID and places it in INITIALIZED status. A -// build must be in READY status before you can create fleets with it. Learn more -// Uploading Your Game -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) -// Create a Build with Files in Amazon S3 -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// If successful, this operation creates a new build resource with a unique build +// ID and places it in INITIALIZED status. A build must be in READY status before +// you can create fleets with it. Learn more Uploading Your Game (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) +// Create a Build with Files in Amazon S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateBuild(ctx context.Context, params *CreateBuildInput, optFns ...func(*Options)) (*CreateBuildOutput, error) { if params == nil { params = &CreateBuildInput{} @@ -76,8 +67,8 @@ type CreateBuildInput struct { OperatingSystem types.OperatingSystem // A server SDK version you used when integrating your game server build with - // GameLift. For more information see Integrate games with custom game servers - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html). + // GameLift. For more information see Integrate games with custom game servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html) + // . ServerSdkVersion *string // Information indicating where your game build files are stored. Use this @@ -90,18 +81,14 @@ type CreateBuildInput struct { // of 0. StorageLocation *types.S3Location - // A list of labels to assign to the new build resource. Tags are developer defined - // key-value pairs. Tagging Amazon Web Services resources are useful for resource - // management, access management and cost allocation. For more information, see - // Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. Once the resource is created, you can use - // TagResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html), - // UntagResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html), - // and ListTagsForResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html) + // A list of labels to assign to the new build resource. Tags are developer + // defined key-value pairs. Tagging Amazon Web Services resources are useful for + // resource management, access management and cost allocation. For more + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Once the resource is created, you + // can use TagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html) + // , UntagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html) + // , and ListTagsForResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html) // to add, remove, and view tags. The maximum tag limit may be lower than stated. // See the Amazon Web Services General Reference for actual tagging limits. Tags []types.Tag @@ -124,8 +111,8 @@ type CreateBuildOutput struct { // This element is returned only when the operation is called without a storage // location. It contains credentials to use when you are uploading a build file to // an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited - // life span. To refresh these credentials, call RequestUploadCredentials - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html). + // life span. To refresh these credentials, call RequestUploadCredentials (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html) + // . UploadCredentials *types.AwsCredentials // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_CreateFleet.go b/service/gamelift/api_op_CreateFleet.go index 90681b3a5fa..04aa6f2b443 100644 --- a/service/gamelift/api_op_CreateFleet.go +++ b/service/gamelift/api_op_CreateFleet.go @@ -34,14 +34,10 @@ import ( // practice, we recommend opening ports for remote access only when you need them // and closing them when you're finished. If successful, this operation creates a // new Fleet resource and places it in NEW status, which prompts GameLift to -// initiate the fleet creation workflow -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html). -// Learn more Setting up fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)Debug -// fleet creation issues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation)Multi-location -// fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// initiate the fleet creation workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html) +// . Learn more Setting up fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Debug fleet creation issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation) +// Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error) { if params == nil { params = &CreateFleetInput{} @@ -75,7 +71,7 @@ type CreateFleetInput struct { // Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses // the certificates to encrypt traffic between game clients and the game servers - // running on GameLift. By default, the CertificateConfiguration is DISABLED. You + // running on GameLift. By default, the CertificateConfiguration is DISABLED . You // can't change this property after you create the fleet. Certificate Manager (ACM) // certificates expire after 13 months. Certificate expiration can cause fleets to // fail, preventing players from connecting to instances in the fleet. We recommend @@ -83,9 +79,8 @@ type CreateFleetInput struct { // transition. ACM isn't available in all Amazon Web Services regions. A fleet // creation request with certificate generation enabled in an unsupported Region, // fails with a 4xx error. For more information about the supported Regions, see - // Supported Regions - // (https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the - // Certificate Manager User Guide. + // Supported Regions (https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) + // in the Certificate Manager User Guide. CertificateConfiguration *types.CertificateConfiguration // The type of compute resource used to host your game servers. You can use your @@ -105,16 +100,14 @@ type CreateFleetInput struct { // The GameLift-supported Amazon EC2 instance type to use for all fleet instances. // Instance type determines the computing resources that will be used to host your // game servers, including CPU, memory, storage, and networking capacity. See - // Amazon Elastic Compute Cloud Instance Types - // (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon - // EC2 instance types. + // Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/) + // for detailed descriptions of Amazon EC2 instance types. EC2InstanceType types.EC2InstanceType - // Indicates whether to use On-Demand or Spot instances for this fleet. By default, - // this property is set to ON_DEMAND. Learn more about when to use On-Demand - // versus Spot Instances - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot). - // This property cannot be changed after the fleet is created. + // Indicates whether to use On-Demand or Spot instances for this fleet. By + // default, this property is set to ON_DEMAND . Learn more about when to use + // On-Demand versus Spot Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) + // . This property cannot be changed after the fleet is created. FleetType types.FleetType // A unique identifier for an IAM role that manages access to your Amazon Web @@ -123,44 +116,39 @@ type CreateFleetInput struct { // processes, and daemons (background processes). Create a role or look up a role's // ARN by using the IAM dashboard (https://console.aws.amazon.com/iam/) in the // Amazon Web Services Management Console. Learn more about using on-box - // credentials for your game servers at Access external resources from a game - // server - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). - // This property cannot be changed after the fleet is created. + // credentials for your game servers at Access external resources from a game + // server (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) + // . This property cannot be changed after the fleet is created. InstanceRoleArn *string // A set of remote locations to deploy additional instances to and manage as part // of the fleet. This parameter can only be used when creating fleets in Amazon Web // Services Regions that support multiple locations. You can add any // GameLift-supported Amazon Web Services Region as a remote location, in the form - // of an Amazon Web Services Region code such as us-west-2. To create a fleet with + // of an Amazon Web Services Region code such as us-west-2 . To create a fleet with // instances in the home Region only, omit this parameter. Locations []types.LocationConfiguration // This parameter is no longer used. To specify where GameLift should store log // files once a server process shuts down, use the GameLift server API - // ProcessReady() and specify one or more directory paths in logParameters. For - // more information, see Initialize the server process - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize) + // ProcessReady() and specify one or more directory paths in logParameters . For + // more information, see Initialize the server process (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize) // in the GameLift Developer Guide. LogPaths []string - // The name of an Amazon Web Services CloudWatch metric group to add this fleet to. - // A metric group is used to aggregate the metrics for multiple fleets. You can + // The name of an Amazon Web Services CloudWatch metric group to add this fleet + // to. A metric group is used to aggregate the metrics for multiple fleets. You can // specify an existing metric group name or set a new name to create a new metric // group. A fleet can be included in only one metric group at a time. MetricGroups []string // The status of termination protection for active game sessions on the fleet. By - // default, this property is set to NoProtection. You can also set game session - // protection for an individual game session by calling UpdateGameSession. - // - // * - // NoProtection - Game sessions can be terminated during active gameplay as a - // result of a scale-down event. - // - // * FullProtection - Game sessions in ACTIVE status - // cannot be terminated during a scale-down event. + // default, this property is set to NoProtection . You can also set game session + // protection for an individual game session by calling UpdateGameSession . + // - NoProtection - Game sessions can be terminated during active gameplay as a + // result of a scale-down event. + // - FullProtection - Game sessions in ACTIVE status cannot be terminated during + // a scale-down event. NewGameSessionProtectionPolicy types.ProtectionPolicy // Used when peering your GameLift fleet with a VPC, the unique identifier for the @@ -172,20 +160,20 @@ type CreateFleetInput struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . PeerVpcId *string // A policy that limits the number of game sessions that an individual player can // create on instances in this fleet within a specified span of time. ResourceCreationLimitPolicy *types.ResourceCreationLimitPolicy - // Instructions for how to launch and maintain server processes on instances in the - // fleet. The runtime configuration defines one or more server process + // Instructions for how to launch and maintain server processes on instances in + // the fleet. The runtime configuration defines one or more server process // configurations, each identifying a build executable or Realtime script file and // the number of processes of that type to run concurrently. The // RuntimeConfiguration parameter is required unless the fleet is being configured - // using the older parameters ServerLaunchPath and ServerLaunchParameters, which + // using the older parameters ServerLaunchPath and ServerLaunchParameters , which // are still supported for backward compatibility. RuntimeConfiguration *types.RuntimeConfiguration @@ -205,12 +193,11 @@ type CreateFleetInput struct { // continue to be valid. ServerLaunchPath *string - // A list of labels to assign to the new fleet resource. Tags are developer-defined - // key-value pairs. Tagging Amazon Web Services resources are useful for resource - // management, access management and cost allocation. For more information, see - // Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // A list of labels to assign to the new fleet resource. Tags are + // developer-defined key-value pairs. Tagging Amazon Web Services resources are + // useful for resource management, access management and cost allocation. For more + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag noSmithyDocumentSerde @@ -223,7 +210,7 @@ type CreateFleetOutput struct { FleetAttributes *types.FleetAttributes // The fleet's locations and life-cycle status of each location. For new fleets, - // the status of all locations is set to NEW. During fleet creation, GameLift + // the status of all locations is set to NEW . During fleet creation, GameLift // updates each location status as instances are deployed there and prepared for // game hosting. This list includes an entry for the fleet's home Region. For // fleets with no remote locations, only one entry, representing the home Region, diff --git a/service/gamelift/api_op_CreateFleetLocations.go b/service/gamelift/api_op_CreateFleetLocations.go index 12a908424e3..a66717c27b8 100644 --- a/service/gamelift/api_op_CreateFleetLocations.go +++ b/service/gamelift/api_op_CreateFleetLocations.go @@ -19,14 +19,11 @@ import ( // feature and were created after the feature was released in March 2021. To add // fleet locations, specify the fleet to be updated and provide a list of one or // more locations. If successful, this operation returns the list of added -// locations with their status set to NEW. GameLift initiates the process of +// locations with their status set to NEW . GameLift initiates the process of // starting an instance in each added location. You can track the status of each -// new location by monitoring location creation events using DescribeFleetEvents -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html). -// Learn more Setting up fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)Multi-location -// fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// new location by monitoring location creation events using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) +// . Learn more Setting up fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Multi-location fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) CreateFleetLocations(ctx context.Context, params *CreateFleetLocationsInput, optFns ...func(*Options)) (*CreateFleetLocationsOutput, error) { if params == nil { params = &CreateFleetLocationsInput{} @@ -52,7 +49,7 @@ type CreateFleetLocationsInput struct { // A list of locations to deploy additional instances to and manage as part of the // fleet. You can add any GameLift-supported Amazon Web Services Region as a remote - // location, in the form of an Amazon Web Services Region code such as us-west-2. + // location, in the form of an Amazon Web Services Region code such as us-west-2 . // // This member is required. Locations []types.LocationConfiguration @@ -62,18 +59,17 @@ type CreateFleetLocationsInput struct { type CreateFleetLocationsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that was updated with new locations. FleetId *string // The remote locations that are being added to the fleet, and the life-cycle - // status of each location. For new locations, the status is set to NEW. During + // status of each location. For new locations, the status is set to NEW . During // location creation, GameLift updates each location's status as instances are // deployed there and prepared for game hosting. This list does not include the // fleet home Region or any remote locations that were already added to the fleet. diff --git a/service/gamelift/api_op_CreateGameServerGroup.go b/service/gamelift/api_op_CreateGameServerGroup.go index 5304f18efef..5f9758b81bd 100644 --- a/service/gamelift/api_op_CreateGameServerGroup.go +++ b/service/gamelift/api_op_CreateGameServerGroup.go @@ -19,35 +19,27 @@ import ( // can view the status of your game server groups in the GameLift console. Game // server group metrics and events are emitted to Amazon CloudWatch. Before // creating a new game server group, you must have the following: +// - An Amazon Elastic Compute Cloud launch template that specifies how to +// launch Amazon Elastic Compute Cloud instances with your game server build. For +// more information, see Launching an Instance from a Launch Template (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) +// in the Amazon Elastic Compute Cloud User Guide. +// - An IAM role that extends limited access to your Amazon Web Services account +// to allow GameLift FleetIQ to create and interact with the Auto Scaling group. +// For more information, see Create IAM roles for cross-service interaction (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) +// in the GameLift FleetIQ Developer Guide. // -// * An Amazon -// Elastic Compute Cloud launch template that specifies how to launch Amazon -// Elastic Compute Cloud instances with your game server build. For more -// information, see Launching an Instance from a Launch Template -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) -// in the Amazon Elastic Compute Cloud User Guide. -// -// * An IAM role that extends -// limited access to your Amazon Web Services account to allow GameLift FleetIQ to -// create and interact with the Auto Scaling group. For more information, see -// Create IAM roles for cross-service interaction -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) -// in the GameLift FleetIQ Developer Guide. -// -// To create a new game server group, -// specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch -// template, and provide a list of instance types that can be used in the group. -// You must also set initial maximum and minimum limits on the group's instance -// count. You can optionally set an Auto Scaling policy with target tracking based -// on a GameLift FleetIQ metric. Once the game server group and corresponding Auto -// Scaling group are created, you have full access to change the Auto Scaling -// group's configuration as needed. Several properties that are set when creating a -// game server group, including maximum/minimum size and auto-scaling policy -// settings, must be updated directly in the Auto Scaling group. Keep in mind that -// some Auto Scaling group properties are periodically updated by GameLift FleetIQ -// as part of its balancing activities to optimize for availability and cost. Learn -// more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// To create a new game server group, specify a unique group name, IAM role and +// Amazon Elastic Compute Cloud launch template, and provide a list of instance +// types that can be used in the group. You must also set initial maximum and +// minimum limits on the group's instance count. You can optionally set an Auto +// Scaling policy with target tracking based on a GameLift FleetIQ metric. Once the +// game server group and corresponding Auto Scaling group are created, you have +// full access to change the Auto Scaling group's configuration as needed. Several +// properties that are set when creating a game server group, including +// maximum/minimum size and auto-scaling policy settings, must be updated directly +// in the Auto Scaling group. Keep in mind that some Auto Scaling group properties +// are periodically updated by GameLift FleetIQ as part of its balancing activities +// to optimize for availability and cost. Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) CreateGameServerGroup(ctx context.Context, params *CreateGameServerGroupInput, optFns ...func(*Options)) (*CreateGameServerGroupOutput, error) { if params == nil { params = &CreateGameServerGroupInput{} @@ -76,13 +68,11 @@ type CreateGameServerGroupInput struct { // The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The // instance definitions must specify at least two different instance types that are // supported by GameLift FleetIQ. For more information on instance types, see EC2 - // Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon Elastic Compute Cloud User Guide. You can optionally specify capacity - // weighting for each instance type. If no weight value is specified for an - // instance type, it is set to the default value "1". For more information about - // capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) + // Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon Elastic Compute Cloud User Guide. You can optionally specify + // capacity weighting for each instance type. If no weight value is specified for + // an instance type, it is set to the default value "1". For more information about + // capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) // in the Amazon EC2 Auto Scaling User Guide. // // This member is required. @@ -92,8 +82,7 @@ type CreateGameServerGroupInput struct { // server code to be deployed to all instances in the game server group. You can // specify the template using either the template name or ID. For help with // creating a launch template, see Creating a Launch Template for an Auto Scaling - // Group - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) + // Group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) // in the Amazon Elastic Compute Cloud Auto Scaling User Guide. After the Auto // Scaling group is created, update this value directly in the Auto Scaling group // using the Amazon Web Services console or APIs. If you specify network interfaces @@ -122,9 +111,9 @@ type CreateGameServerGroupInput struct { // This member is required. MinSize *int32 - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto + // Scaling groups. // // This member is required. RoleArn *string @@ -139,24 +128,19 @@ type CreateGameServerGroupInput struct { // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand // Instances in the game server group. Method options include the following: - // - // * - // SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot - // Instances are unavailable or not viable for game hosting, the game server group - // provides no hosting capacity until Spot Instances can again be used. Until then, - // no new instances are started, and the existing nonviable Spot Instances are - // terminated (after current gameplay ends) and are not replaced. - // - // * SPOT_PREFERRED - // - (default value) Spot Instances are used whenever available in the game server - // group. If Spot Instances are unavailable, the game server group continues to - // provide hosting capacity by falling back to On-Demand Instances. Existing - // nonviable Spot Instances are terminated (after current gameplay ends) and are - // replaced with new On-Demand Instances. - // - // * ON_DEMAND_ONLY - Only On-Demand - // Instances are used in the game server group. No Spot Instances are used, even - // when available, while this balancing strategy is in force. + // - SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot + // Instances are unavailable or not viable for game hosting, the game server group + // provides no hosting capacity until Spot Instances can again be used. Until then, + // no new instances are started, and the existing nonviable Spot Instances are + // terminated (after current gameplay ends) and are not replaced. + // - SPOT_PREFERRED - (default value) Spot Instances are used whenever available + // in the game server group. If Spot Instances are unavailable, the game server + // group continues to provide hosting capacity by falling back to On-Demand + // Instances. Existing nonviable Spot Instances are terminated (after current + // gameplay ends) and are replaced with new On-Demand Instances. + // - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. + // No Spot Instances are used, even when available, while this balancing strategy + // is in force. BalancingStrategy types.BalancingStrategy // A flag that indicates whether instances in the game server group are protected @@ -172,9 +156,8 @@ type CreateGameServerGroupInput struct { // A list of labels to assign to the new game server group resource. Tags are // developer-defined key-value pairs. Tagging Amazon Web Services resources is // useful for resource management, access management, and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag // A list of virtual private cloud (VPC) subnets to use with instances in the game @@ -193,7 +176,7 @@ type CreateGameServerGroupOutput struct { // The newly created game server group object, including the new ARN value for the // GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto // Scaling group ARN is initially null, since the group has not yet been created. - // This value is added once the game server group status reaches ACTIVE. + // This value is added once the game server group status reaches ACTIVE . GameServerGroup *types.GameServerGroup // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_CreateGameSession.go b/service/gamelift/api_op_CreateGameSession.go index 5a71b220dcc..b341c4f464c 100644 --- a/service/gamelift/api_op_CreateGameSession.go +++ b/service/gamelift/api_op_CreateGameSession.go @@ -15,38 +15,30 @@ import ( // This operation prompts an available server process to start a game session and // retrieves connection information for the new game session. As an alternative, // consider using the GameLift game session placement feature with -// StartGameSessionPlacement -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) +// StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) // , which uses FleetIQ algorithms and queues to optimize the placement process. // When creating a game session, you specify exactly where you want to place it and // provide a set of game session configuration settings. The fleet must be in // ACTIVE status before a game session can be created in it. This operation can be // used in the following ways: +// - To create a game session on an instance in a fleet's home Region, provide a +// fleet or alias ID along with your game session configuration. +// - To create a game session on an instance in a fleet's remote location, +// provide a fleet or alias ID and a location name, along with your game session +// configuration. // -// * To create a game session on an instance in a -// fleet's home Region, provide a fleet or alias ID along with your game session -// configuration. -// -// * To create a game session on an instance in a fleet's remote -// location, provide a fleet or alias ID and a location name, along with your game -// session configuration. -// -// If successful, a workflow is initiated to start a new -// game session. A GameSession object is returned containing the game session -// configuration and status. When the status is ACTIVE, game session connection -// information is provided and player sessions can be created for the game session. -// By default, newly created game sessions are open to new players. You can -// restrict new player access by using UpdateGameSession -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) +// If successful, a workflow is initiated to start a new game session. A +// GameSession object is returned containing the game session configuration and +// status. When the status is ACTIVE , game session connection information is +// provided and player sessions can be created for the game session. By default, +// newly created game sessions are open to new players. You can restrict new player +// access by using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) // to change the game session's player session creation policy. Game session logs // are retained for all active game sessions for 14 days. To access the logs, call -// GetGameSessionLogUrl -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) +// GetGameSessionLogUrl (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) // to download the log files. Available in Amazon GameLift Local. Learn more Start -// a game session -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateGameSession(ctx context.Context, params *CreateGameSessionInput, optFns ...func(*Options)) (*CreateGameSessionOutput, error) { if params == nil { params = &CreateGameSessionInput{} @@ -90,14 +82,14 @@ type CreateGameSessionInput struct { // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameProperties []types.GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process with a request to start a new game - // session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameSessionData *string // This parameter is deprecated. Use IdempotencyToken instead. Custom string that @@ -110,18 +102,18 @@ type CreateGameSessionInput struct { // are processed only once. Subsequent requests with the same string return the // original GameSession object, with an updated status. Maximum token length is 48 // characters. If provided, this string is included in the new game session's ID. A - // game session ARN has the following format: arn:aws:gamelift:::gamesession//. + // game session ARN has the following format: arn:aws:gamelift:::gamesession// . // Idempotency tokens remain in use for 30 days after a game session has ended; // game session objects are retained for this time period and then deleted. IdempotencyToken *string - // A fleet's remote location to place the new game session in. If this parameter is - // not set, the new game session is placed in the fleet's home Region. Specify a - // remote location with an Amazon Web Services Region code such as us-west-2. + // A fleet's remote location to place the new game session in. If this parameter + // is not set, the new game session is placed in the fleet's home Region. Specify a + // remote location with an Amazon Web Services Region code such as us-west-2 . Location *string - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. + // A descriptive label that is associated with a game session. Session names do + // not need to be unique. Name *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateGameSessionQueue.go b/service/gamelift/api_op_CreateGameSessionQueue.go index 5409df0689f..f6fc2ccaf46 100644 --- a/service/gamelift/api_op_CreateGameSessionQueue.go +++ b/service/gamelift/api_op_CreateGameSessionQueue.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a placement queue that processes requests for new game sessions. A queue -// uses FleetIQ algorithms to determine the best placement locations and find an -// available game server there, then prompts the game server process to start a new -// game session. A game session queue is configured with a set of destinations +// Creates a placement queue that processes requests for new game sessions. A +// queue uses FleetIQ algorithms to determine the best placement locations and find +// an available game server there, then prompts the game server process to start a +// new game session. A game session queue is configured with a set of destinations // (GameLift fleets or aliases), which determine the locations where the queue can // place new game sessions. These destinations can span multiple fleet types (Spot // and On-Demand), instance types, and Amazon Web Services Regions. If the queue @@ -32,24 +32,15 @@ import ( // placement activity. Notifications using SNS or CloudWatch events is the // preferred way to track placement activity. If successful, a new GameSessionQueue // object is returned with an assigned queue ARN. New game session requests, which -// are submitted to queue with StartGameSessionPlacement -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) -// or StartMatchmaking -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html), -// reference a queue's name or ARN. Learn more Design a game session queue -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html) -// Create a game session queue -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html) -// Related actions CreateGameSessionQueue -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) -// | DescribeGameSessionQueues -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) -// | UpdateGameSessionQueue -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) -// | DeleteGameSessionQueue -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) -// | All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// are submitted to queue with StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) +// or StartMatchmaking (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html) +// , reference a queue's name or ARN. Learn more Design a game session queue (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html) +// Create a game session queue (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html) +// Related actions CreateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) +// | DescribeGameSessionQueues (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) +// | UpdateGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) +// | DeleteGameSessionQueue (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) +// | All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateGameSessionQueue(ctx context.Context, params *CreateGameSessionQueueInput, optFns ...func(*Options)) (*CreateGameSessionQueueOutput, error) { if params == nil { params = &CreateGameSessionQueueInput{} @@ -67,8 +58,8 @@ func (c *Client) CreateGameSessionQueue(ctx context.Context, params *CreateGameS type CreateGameSessionQueueInput struct { - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. + // A descriptive label that is associated with game session queue. Queue names + // must be unique within each Region. // // This member is required. Name *string @@ -84,13 +75,13 @@ type CreateGameSessionQueueInput struct { // A list of locations where a queue is allowed to place new game sessions. // Locations are specified in the form of Amazon Web Services Region codes, such as - // us-west-2. If this parameter is not set, game sessions can be placed in any + // us-west-2 . If this parameter is not set, game sessions can be placed in any // queue location. FilterConfiguration *types.FilterConfiguration - // An SNS topic ARN that is set up to receive game session placement notifications. - // See Setting up notifications for game session placement - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html). + // An SNS topic ARN that is set up to receive game session placement + // notifications. See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) + // . NotificationTarget *string // A set of policies that act as a sliding cap on player latency. FleetIQ works to @@ -110,9 +101,8 @@ type CreateGameSessionQueueInput struct { // A list of labels to assign to the new game session queue resource. Tags are // developer-defined key-value pairs. Tagging Amazon Web Services resources are // useful for resource management, access management and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag // The maximum time, in seconds, that a new game session placement request remains diff --git a/service/gamelift/api_op_CreateLocation.go b/service/gamelift/api_op_CreateLocation.go index 5bb1cb34da8..06bd6b94545 100644 --- a/service/gamelift/api_op_CreateLocation.go +++ b/service/gamelift/api_op_CreateLocation.go @@ -37,9 +37,8 @@ type CreateLocationInput struct { // A list of labels to assign to the new matchmaking configuration resource. Tags // are developer-defined key-value pairs. Tagging Amazon Web Services resources are // useful for resource management, access management and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Rareference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Rareference. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateMatchmakingConfiguration.go b/service/gamelift/api_op_CreateMatchmakingConfiguration.go index 5872f8e367c..a594cd10c3a 100644 --- a/service/gamelift/api_op_CreateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_CreateMatchmakingConfiguration.go @@ -11,25 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Defines a new matchmaking configuration for use with FlexMatch. Whether your are -// using FlexMatch with GameLift hosting or as a standalone matchmaking service, -// the matchmaking configuration sets out rules for matching players and forming -// teams. If you're also using GameLift hosting, it defines how to start game -// sessions for each match. Your matchmaking system can use multiple configurations -// to handle different game scenarios. All matchmaking requests identify the -// matchmaking configuration to use and provide player attributes consistent with -// that configuration. To create a matchmaking configuration, you must provide the -// following: configuration name and FlexMatch mode (with or without GameLift -// hosting); a rule set that specifies how to evaluate players and find acceptable -// matches; whether player acceptance is required; and the maximum time allowed for -// a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need -// to identify the game session queue to use when starting a game session for the -// match. In addition, you must set up an Amazon Simple Notification Service topic -// to receive matchmaking notifications. Provide the topic ARN in the matchmaking -// configuration. Learn more Design a FlexMatch matchmaker -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) -// Set up FlexMatch event notification -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) +// Defines a new matchmaking configuration for use with FlexMatch. Whether your +// are using FlexMatch with GameLift hosting or as a standalone matchmaking +// service, the matchmaking configuration sets out rules for matching players and +// forming teams. If you're also using GameLift hosting, it defines how to start +// game sessions for each match. Your matchmaking system can use multiple +// configurations to handle different game scenarios. All matchmaking requests +// identify the matchmaking configuration to use and provide player attributes +// consistent with that configuration. To create a matchmaking configuration, you +// must provide the following: configuration name and FlexMatch mode (with or +// without GameLift hosting); a rule set that specifies how to evaluate players and +// find acceptable matches; whether player acceptance is required; and the maximum +// time allowed for a matchmaking attempt. When using FlexMatch with GameLift +// hosting, you also need to identify the game session queue to use when starting a +// game session for the match. In addition, you must set up an Amazon Simple +// Notification Service topic to receive matchmaking notifications. Provide the +// topic ARN in the matchmaking configuration. Learn more Design a FlexMatch +// matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) +// Set up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) func (c *Client) CreateMatchmakingConfiguration(ctx context.Context, params *CreateMatchmakingConfigurationInput, optFns ...func(*Options)) (*CreateMatchmakingConfigurationOutput, error) { if params == nil { params = &CreateMatchmakingConfigurationInput{} @@ -48,7 +47,7 @@ func (c *Client) CreateMatchmakingConfiguration(ctx context.Context, params *Cre type CreateMatchmakingConfigurationInput struct { // A flag that determines whether a match that was created with this configuration - // must be accepted by the matched players. To require acceptance, set to TRUE. + // must be accepted by the matched players. To require acceptance, set to TRUE . // With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE // to indicate when a completed potential match is waiting for player acceptance. // @@ -68,9 +67,9 @@ type CreateMatchmakingConfigurationInput struct { // This member is required. RequestTimeoutSeconds *int32 - // A unique identifier for the matchmaking rule set to use with this configuration. - // You can use either the rule set name or ARN value. A matchmaking configuration - // can only use rule sets that are defined in the same Region. + // A unique identifier for the matchmaking rule set to use with this + // configuration. You can use either the rule set name or ARN value. A matchmaking + // configuration can only use rule sets that are defined in the same Region. // // This member is required. RuleSetName *string @@ -83,17 +82,16 @@ type CreateMatchmakingConfigurationInput struct { // example, if the configuration's rule set specifies a match for a single // 12-person team, and the additional player count is set to 2, only 10 players are // selected for the match. This parameter is not used if FlexMatchMode is set to - // STANDALONE. + // STANDALONE . AdditionalPlayerCount *int32 - // The method used to backfill game sessions that are created with this matchmaking - // configuration. Specify MANUAL when your game manages backfill requests manually - // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift - // create a backfill request whenever a game session has one or more open slots. - // Learn more about manual and automatic backfill in Backfill Existing Games with - // FlexMatch - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). - // Automatic backfill is not available when FlexMatchMode is set to STANDALONE. + // The method used to backfill game sessions that are created with this + // matchmaking configuration. Specify MANUAL when your game manages backfill + // requests manually or does not use the match backfill feature. Specify AUTOMATIC + // to have GameLift create a backfill request whenever a game session has one or + // more open slots. Learn more about manual and automatic backfill in Backfill + // Existing Games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) + // . Automatic backfill is not available when FlexMatchMode is set to STANDALONE . BackfillMode types.BackfillMode // Information to be added to all events related to this matchmaking configuration. @@ -104,57 +102,48 @@ type CreateMatchmakingConfigurationInput struct { // Indicates whether this matchmaking configuration is being used with GameLift // hosting or as a standalone matchmaking solution. - // - // * STANDALONE - FlexMatch forms - // matches and returns match information, including players and team assignments, - // in a MatchmakingSucceeded - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) - // event. - // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift - // queue to start a game session for the match. + // - STANDALONE - FlexMatch forms matches and returns match information, + // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) + // event. + // - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue + // to start a game session for the match. FlexMatchMode types.FlexMatchMode // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession object that is created for a - // successful match. This parameter is not used if FlexMatchMode is set to - // STANDALONE. + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the new GameSession object that is created for + // a successful match. This parameter is not used if FlexMatchMode is set to + // STANDALONE . GameProperties []types.GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process with a request to start a new game - // session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession object that is created for a - // successful match. This parameter is not used if FlexMatchMode is set to - // STANDALONE. + // session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the new GameSession object that is created for + // a successful match. This parameter is not used if FlexMatchMode is set to + // STANDALONE . GameSessionData *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift game session queue resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::gamesessionqueue/ . Queues can be located in any Region. // Queues are used to start new GameLift-hosted game sessions for matches that are // created with this matchmaking configuration. If FlexMatchMode is set to - // STANDALONE, do not set this parameter. + // STANDALONE , do not set this parameter. GameSessionQueueArns []string // An SNS topic ARN that is set up to receive matchmaking notifications. See - // Setting up notifications for matchmaking - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) + // Setting up notifications for matchmaking (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) // for more information. NotificationTarget *string // A list of labels to assign to the new matchmaking configuration resource. Tags // are developer-defined key-value pairs. Tagging Amazon Web Services resources are // useful for resource management, access management and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateMatchmakingRuleSet.go b/service/gamelift/api_op_CreateMatchmakingRuleSet.go index 19bb05a1771..59c155fdd14 100644 --- a/service/gamelift/api_op_CreateMatchmakingRuleSet.go +++ b/service/gamelift/api_op_CreateMatchmakingRuleSet.go @@ -18,20 +18,11 @@ import ( // and the rule set body in JSON format. Rule sets must be defined in the same // Region as the matchmaking configuration they are used with. Since matchmaking // rule sets cannot be edited, it is a good idea to check the rule set syntax using -// ValidateMatchmakingRuleSet -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html) +// ValidateMatchmakingRuleSet (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html) // before creating a new rule set. Learn more -// -// * Build a rule set -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) -// -// * -// Design a matchmaker -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) -// -// * -// Matchmaking with FlexMatch -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) +// - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) +// - Design a matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) +// - Matchmaking with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html) func (c *Client) CreateMatchmakingRuleSet(ctx context.Context, params *CreateMatchmakingRuleSetInput, optFns ...func(*Options)) (*CreateMatchmakingRuleSetOutput, error) { if params == nil { params = &CreateMatchmakingRuleSetInput{} @@ -65,9 +56,8 @@ type CreateMatchmakingRuleSetInput struct { // A list of labels to assign to the new matchmaking rule set resource. Tags are // developer-defined key-value pairs. Tagging Amazon Web Services resources are // useful for resource management, access management and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreatePlayerSession.go b/service/gamelift/api_op_CreatePlayerSession.go index 9415dbf82e3..03ac50720ba 100644 --- a/service/gamelift/api_op_CreatePlayerSession.go +++ b/service/gamelift/api_op_CreatePlayerSession.go @@ -11,20 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reserves an open player slot in a game session for a player. New player sessions -// can be created in any game session with an open slot that is in ACTIVE status -// and has a player creation policy of ACCEPT_ALL. You can add a group of players -// to a game session with CreatePlayerSessions -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html) +// Reserves an open player slot in a game session for a player. New player +// sessions can be created in any game session with an open slot that is in ACTIVE +// status and has a player creation policy of ACCEPT_ALL . You can add a group of +// players to a game session with CreatePlayerSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html) // . To create a player session, specify a game session ID, player ID, and // optionally a set of player data. If successful, a slot is reserved in the game -// session for the player and a new PlayerSessions object is returned with a player -// session ID. The player references the player session ID when sending a +// session for the player and a new PlayerSessions object is returned with a +// player session ID. The player references the player session ID when sending a // connection request to the game session, and the game server can use it to // validate the player reservation with the GameLift service. Player sessions // cannot be updated. The maximum number of players per game session is 200. It is -// not adjustable. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// not adjustable. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreatePlayerSession(ctx context.Context, params *CreatePlayerSessionInput, optFns ...func(*Options)) (*CreatePlayerSessionOutput, error) { if params == nil { params = &CreatePlayerSessionInput{} diff --git a/service/gamelift/api_op_CreatePlayerSessions.go b/service/gamelift/api_op_CreatePlayerSessions.go index fd0a87bb6a9..33bc44e92a7 100644 --- a/service/gamelift/api_op_CreatePlayerSessions.go +++ b/service/gamelift/api_op_CreatePlayerSessions.go @@ -13,9 +13,8 @@ import ( // Reserves open slots in a game session for a group of players. New player // sessions can be created in any game session with an open slot that is in ACTIVE -// status and has a player creation policy of ACCEPT_ALL. To add a single player to -// a game session, use CreatePlayerSession -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html) +// status and has a player creation policy of ACCEPT_ALL . To add a single player +// to a game session, use CreatePlayerSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html) // To create player sessions, specify a game session ID and a list of player IDs. // Optionally, provide a set of player data for each player ID. If successful, a // slot is reserved in the game session for each player, and new PlayerSession @@ -23,8 +22,7 @@ import ( // player session ID when sending a connection request to the game session, and the // game server can use it to validate the player reservation with the GameLift // service. Player sessions cannot be updated. The maximum number of players per -// game session is 200. It is not adjustable. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// game session is 200. It is not adjustable. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreatePlayerSessions(ctx context.Context, params *CreatePlayerSessionsInput, optFns ...func(*Options)) (*CreatePlayerSessionsOutput, error) { if params == nil { params = &CreatePlayerSessionsInput{} diff --git a/service/gamelift/api_op_CreateScript.go b/service/gamelift/api_op_CreateScript.go index 67c8240ecbf..8dd62b141a2 100644 --- a/service/gamelift/api_op_CreateScript.go +++ b/service/gamelift/api_op_CreateScript.go @@ -18,27 +18,20 @@ import ( // session. To create a new script record, specify a script name and provide the // script file(s). The script files and all dependencies must be zipped into a // single file. You can pull the zip file from either of these locations: +// - A locally available directory. Use the ZipFile parameter for this option. +// - An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web +// Services account. Use the StorageLocation parameter for this option. You'll need +// to have an Identity Access Management (IAM) role that allows the Amazon GameLift +// service to access your S3 bucket. // -// * A -// locally available directory. Use the ZipFile parameter for this option. -// -// * An -// Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services -// account. Use the StorageLocation parameter for this option. You'll need to have -// an Identity Access Management (IAM) role that allows the Amazon GameLift service -// to access your S3 bucket. -// -// If the call is successful, a new script record is -// created with a unique script ID. If the script file is provided as a local file, -// the file is uploaded to an Amazon GameLift-owned S3 bucket and the script -// record's storage location reflects this location. If the script file is provided -// as an S3 bucket, Amazon GameLift accesses the file at this storage location as -// needed for deployment. Learn more Amazon GameLift Realtime Servers -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html)Set -// Up a Role for Amazon GameLift Access -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// If the call is successful, a new script record is created with a unique script +// ID. If the script file is provided as a local file, the file is uploaded to an +// Amazon GameLift-owned S3 bucket and the script record's storage location +// reflects this location. If the script file is provided as an S3 bucket, Amazon +// GameLift accesses the file at this storage location as needed for deployment. +// Learn more Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) +// Set Up a Role for Amazon GameLift Access (https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateScript(ctx context.Context, params *CreateScriptInput, optFns ...func(*Options)) (*CreateScriptOutput, error) { if params == nil { params = &CreateScriptInput{} @@ -57,8 +50,7 @@ func (c *Client) CreateScript(ctx context.Context, params *CreateScriptInput, op type CreateScriptInput struct { // A descriptive label that is associated with a script. Script names do not need - // to be unique. You can use UpdateScript - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) + // to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) // to change this value later. Name *string @@ -75,22 +67,17 @@ type CreateScriptInput struct { // A list of labels to assign to the new script resource. Tags are // developer-defined key-value pairs. Tagging Amazon Web Services resources are // useful for resource management, access management and cost allocation. For more - // information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. Once the resource is created, you can use - // TagResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html), - // UntagResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html), - // and ListTagsForResource - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html) + // information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Once the resource is created, you + // can use TagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html) + // , UntagResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html) + // , and ListTagsForResource (https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html) // to add, remove, and view tags. The maximum tag limit may be lower than stated. // See the Amazon Web Services General Reference for actual tagging limits. Tags []types.Tag // Version information associated with a build or script. Version strings do not - // need to be unique. You can use UpdateScript - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) + // need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) // to change this value later. Version *string @@ -99,7 +86,7 @@ type CreateScriptInput struct { // When using the Amazon Web Services CLI tool to create a script, this parameter // is set to the zip file name. It must be prepended with the string "fileb://" to // indicate that the file data is a binary object. For example: --zip-file - // fileb://myRealtimeScript.zip. + // fileb://myRealtimeScript.zip . ZipFile []byte noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go index 286efea20eb..3d881d06892 100644 --- a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go +++ b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go @@ -11,16 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests authorization to create or delete a peer connection between the VPC for -// your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web -// Services account. VPC peering enables the game servers on your fleet to +// Requests authorization to create or delete a peer connection between the VPC +// for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon +// Web Services account. VPC peering enables the game servers on your fleet to // communicate directly with other Amazon Web Services resources. After you've -// received authorization, use CreateVpcPeeringConnection -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html) +// received authorization, use CreateVpcPeeringConnection (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html) // to establish the peering connection. For more information, see VPC Peering with -// Amazon GameLift Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). -// You can peer with VPCs that are owned by any Amazon Web Services account you +// Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) +// . You can peer with VPCs that are owned by any Amazon Web Services account you // have access to, including the account that you use to manage your Amazon // GameLift fleets. You cannot peer with VPCs that are in different Regions. To // request authorization to create a connection, call this operation from the @@ -36,8 +34,7 @@ import ( // delete the peering connection for, and (2) ID of the Amazon Web Services account // that you use to manage Amazon GameLift. The authorization remains valid for 24 // hours unless it is canceled. You must create or delete the peering connection -// while the authorization is valid. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// while the authorization is valid. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateVpcPeeringAuthorization(ctx context.Context, params *CreateVpcPeeringAuthorizationInput, optFns ...func(*Options)) (*CreateVpcPeeringAuthorizationOutput, error) { if params == nil { params = &CreateVpcPeeringAuthorizationInput{} @@ -66,8 +63,8 @@ type CreateVpcPeeringAuthorizationInput struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . // // This member is required. PeerVpcId *string diff --git a/service/gamelift/api_op_CreateVpcPeeringConnection.go b/service/gamelift/api_op_CreateVpcPeeringConnection.go index d914855052e..df9bc07f079 100644 --- a/service/gamelift/api_op_CreateVpcPeeringConnection.go +++ b/service/gamelift/api_op_CreateVpcPeeringConnection.go @@ -10,18 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Establishes a VPC peering connection between a virtual private cloud (VPC) in an -// Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC +// Establishes a VPC peering connection between a virtual private cloud (VPC) in +// an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC // peering enables the game servers on your fleet to communicate directly with // other Amazon Web Services resources. You can peer with VPCs in any Amazon Web // Services account that you have access to, including the account that you use to // manage your Amazon GameLift fleets. You cannot peer with VPCs that are in // different Regions. For more information, see VPC Peering with Amazon GameLift -// Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). -// Before calling this operation to establish the peering connection, you first -// need to use CreateVpcPeeringAuthorization -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) +// Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) +// . Before calling this operation to establish the peering connection, you first +// need to use CreateVpcPeeringAuthorization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) // and identify the VPC you want to peer with. Once the authorization for the // specified VPC is issued, you have 24 hours to establish the connection. These // two operations handle all tasks necessary to peer the two VPCs, including @@ -32,12 +30,9 @@ import ( // with the VPC that you want to peer with; and (3) The ID of the VPC you want to // peer with. This operation is asynchronous. If successful, a connection request // is created. You can use continuous polling to track the request's status using -// DescribeVpcPeeringConnections -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html) -// , or by monitoring fleet events for success or failure using DescribeFleetEvents -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) -// . Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// DescribeVpcPeeringConnections (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html) +// , or by monitoring fleet events for success or failure using DescribeFleetEvents (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) +// . Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) CreateVpcPeeringConnection(ctx context.Context, params *CreateVpcPeeringConnectionInput, optFns ...func(*Options)) (*CreateVpcPeeringConnectionOutput, error) { if params == nil { params = &CreateVpcPeeringConnectionInput{} @@ -55,8 +50,8 @@ func (c *Client) CreateVpcPeeringConnection(ctx context.Context, params *CreateV type CreateVpcPeeringConnectionInput struct { - // A unique identifier for the fleet. You can use either the fleet ID or ARN value. - // This tells Amazon GameLift which GameLift VPC to peer with. + // A unique identifier for the fleet. You can use either the fleet ID or ARN + // value. This tells Amazon GameLift which GameLift VPC to peer with. // // This member is required. FleetId *string @@ -72,8 +67,8 @@ type CreateVpcPeeringConnectionInput struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . // // This member is required. PeerVpcId *string diff --git a/service/gamelift/api_op_DeleteAlias.go b/service/gamelift/api_op_DeleteAlias.go index ff2230f163d..5b8334a79a5 100644 --- a/service/gamelift/api_op_DeleteAlias.go +++ b/service/gamelift/api_op_DeleteAlias.go @@ -12,9 +12,8 @@ import ( // Deletes an alias. This operation removes all record of the alias. Game clients // attempting to access a server process using the deleted alias receive an error. -// To delete an alias, specify the alias ID to be deleted. Related actions All APIs -// by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To delete an alias, specify the alias ID to be deleted. Related actions All +// APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error) { if params == nil { params = &DeleteAliasInput{} @@ -32,8 +31,8 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { - // A unique identifier of the alias that you want to delete. You can use either the - // alias ID or ARN value. + // A unique identifier of the alias that you want to delete. You can use either + // the alias ID or ARN value. // // This member is required. AliasId *string diff --git a/service/gamelift/api_op_DeleteBuild.go b/service/gamelift/api_op_DeleteBuild.go index b045604d9b8..469c128b477 100644 --- a/service/gamelift/api_op_DeleteBuild.go +++ b/service/gamelift/api_op_DeleteBuild.go @@ -13,11 +13,9 @@ import ( // Deletes a build. This operation permanently deletes the build resource and any // uploaded build files. Deleting a build does not affect the status of any active // fleets using the build, but you can no longer create new fleets with the deleted -// build. To delete a build, specify the build ID. Learn more Upload a Custom -// Server Build -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// build. To delete a build, specify the build ID. Learn more Upload a Custom +// Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DeleteBuild(ctx context.Context, params *DeleteBuildInput, optFns ...func(*Options)) (*DeleteBuildOutput, error) { if params == nil { params = &DeleteBuildInput{} diff --git a/service/gamelift/api_op_DeleteFleet.go b/service/gamelift/api_op_DeleteFleet.go index a3e5fce50dd..d9b22201687 100644 --- a/service/gamelift/api_op_DeleteFleet.go +++ b/service/gamelift/api_op_DeleteFleet.go @@ -14,14 +14,12 @@ import ( // instances, including those in remote locations, are shut down. You don't need to // call DeleteFleetLocations separately. If the fleet being deleted has a VPC // peering connection, you first need to get a valid authorization (good for 24 -// hours) by calling CreateVpcPeeringAuthorization -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html). -// You do not need to explicitly delete the VPC peering connection. To delete a +// hours) by calling CreateVpcPeeringAuthorization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) +// . You do not need to explicitly delete the VPC peering connection. To delete a // fleet, specify the fleet ID to be terminated. During the deletion process the -// fleet status is changed to DELETING. When completed, the status switches to +// fleet status is changed to DELETING . When completed, the status switches to // TERMINATED and the fleet event FLEET_DELETED is sent. Learn more Setting up -// GameLift Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error) { if params == nil { params = &DeleteFleetInput{} @@ -39,8 +37,8 @@ func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optF type DeleteFleetInput struct { - // A unique identifier for the fleet to be deleted. You can use either the fleet ID - // or ARN value. + // A unique identifier for the fleet to be deleted. You can use either the fleet + // ID or ARN value. // // This member is required. FleetId *string diff --git a/service/gamelift/api_op_DeleteFleetLocations.go b/service/gamelift/api_op_DeleteFleetLocations.go index 22071d130da..17aa158f67a 100644 --- a/service/gamelift/api_op_DeleteFleetLocations.go +++ b/service/gamelift/api_op_DeleteFleetLocations.go @@ -15,10 +15,9 @@ import ( // game server process and all instances that are still active in the location are // shut down. To delete fleet locations, identify the fleet ID and provide a list // of the locations to be deleted. If successful, GameLift sets the location status -// to DELETING, and begins to shut down existing server processes and terminate +// to DELETING , and begins to shut down existing server processes and terminate // instances in each location being deleted. When completed, the location status -// changes to TERMINATED. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// changes to TERMINATED . Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DeleteFleetLocations(ctx context.Context, params *DeleteFleetLocationsInput, optFns ...func(*Options)) (*DeleteFleetLocationsOutput, error) { if params == nil { params = &DeleteFleetLocationsInput{} @@ -43,7 +42,7 @@ type DeleteFleetLocationsInput struct { FleetId *string // The list of fleet locations to delete. Specify locations in the form of an - // Amazon Web Services Region code, such as us-west-2. + // Amazon Web Services Region code, such as us-west-2 . // // This member is required. Locations []string @@ -53,11 +52,10 @@ type DeleteFleetLocationsInput struct { type DeleteFleetLocationsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that location attributes are being deleted @@ -65,7 +63,7 @@ type DeleteFleetLocationsOutput struct { FleetId *string // The remote locations that are being deleted, with each location status set to - // DELETING. + // DELETING . LocationStates []types.LocationState // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_DeleteGameServerGroup.go b/service/gamelift/api_op_DeleteGameServerGroup.go index 457566f7263..a9d2b23d7fc 100644 --- a/service/gamelift/api_op_DeleteGameServerGroup.go +++ b/service/gamelift/api_op_DeleteGameServerGroup.go @@ -16,26 +16,20 @@ import ( // group record. You have several options for how these resources are impacted when // deleting the game server group. Depending on the type of delete operation // selected, this operation might affect these resources: +// - The game server group +// - The corresponding Auto Scaling group +// - All game servers that are currently running in the group // -// * The game server -// group -// -// * The corresponding Auto Scaling group -// -// * All game servers that are -// currently running in the group -// -// To delete a game server group, identify the game -// server group to delete and specify the type of delete operation to initiate. -// Game server groups can only be deleted if they are in ACTIVE or ERROR status. If -// the delete request is successful, a series of operations are kicked off. The -// game server group status is changed to DELETE_SCHEDULED, which prevents new game -// servers from being registered and stops automatic scaling activity. Once all -// game servers in the game server group are deregistered, GameLift FleetIQ can -// begin deleting resources. If any of the delete operations fail, the game server -// group is placed in ERROR status. GameLift FleetIQ emits delete events to Amazon -// CloudWatch. Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// To delete a game server group, identify the game server group to delete and +// specify the type of delete operation to initiate. Game server groups can only be +// deleted if they are in ACTIVE or ERROR status. If the delete request is +// successful, a series of operations are kicked off. The game server group status +// is changed to DELETE_SCHEDULED , which prevents new game servers from being +// registered and stops automatic scaling activity. Once all game servers in the +// game server group are deregistered, GameLift FleetIQ can begin deleting +// resources. If any of the delete operations fail, the game server group is placed +// in ERROR status. GameLift FleetIQ emits delete events to Amazon CloudWatch. +// Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) DeleteGameServerGroup(ctx context.Context, params *DeleteGameServerGroupInput, optFns ...func(*Options)) (*DeleteGameServerGroupOutput, error) { if params == nil { params = &DeleteGameServerGroupInput{} @@ -59,18 +53,13 @@ type DeleteGameServerGroupInput struct { GameServerGroupName *string // The type of delete to perform. Options include the following: - // - // * SAFE_DELETE – - // (default) Terminates the game server group and Amazon EC2 Auto Scaling group - // only when it has no game servers that are in UTILIZED status. - // - // * FORCE_DELETE – - // Terminates the game server group, including all active game servers regardless - // of their utilization status, and the Amazon EC2 Auto Scaling group. - // - // * RETAIN – - // Does a safe delete of the game server group but retains the Amazon EC2 Auto - // Scaling group as is. + // - SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto + // Scaling group only when it has no game servers that are in UTILIZED status. + // - FORCE_DELETE – Terminates the game server group, including all active game + // servers regardless of their utilization status, and the Amazon EC2 Auto Scaling + // group. + // - RETAIN – Does a safe delete of the game server group but retains the Amazon + // EC2 Auto Scaling group as is. DeleteOption types.GameServerGroupDeleteOption noSmithyDocumentSerde @@ -79,7 +68,7 @@ type DeleteGameServerGroupInput struct { type DeleteGameServerGroupOutput struct { // An object that describes the deleted game server group resource, with status - // updated to DELETE_SCHEDULED. + // updated to DELETE_SCHEDULED . GameServerGroup *types.GameServerGroup // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_DeleteGameSessionQueue.go b/service/gamelift/api_op_DeleteGameSessionQueue.go index 42d0751b747..75b6d0ffa53 100644 --- a/service/gamelift/api_op_DeleteGameSessionQueue.go +++ b/service/gamelift/api_op_DeleteGameSessionQueue.go @@ -11,8 +11,7 @@ import ( ) // Deletes a game session queue. Once a queue is successfully deleted, unfulfilled -// StartGameSessionPlacement -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) +// StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) // requests that reference the queue will fail. To delete a queue, specify the // queue name. func (c *Client) DeleteGameSessionQueue(ctx context.Context, params *DeleteGameSessionQueueInput, optFns ...func(*Options)) (*DeleteGameSessionQueueOutput, error) { @@ -32,8 +31,8 @@ func (c *Client) DeleteGameSessionQueue(ctx context.Context, params *DeleteGameS type DeleteGameSessionQueueInput struct { - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. You can use either the queue ID or ARN value. + // A descriptive label that is associated with game session queue. Queue names + // must be unique within each Region. You can use either the queue ID or ARN value. // // This member is required. Name *string diff --git a/service/gamelift/api_op_DeleteLocation.go b/service/gamelift/api_op_DeleteLocation.go index 44880957aaf..dcba9043bb6 100644 --- a/service/gamelift/api_op_DeleteLocation.go +++ b/service/gamelift/api_op_DeleteLocation.go @@ -12,8 +12,8 @@ import ( // Deletes a custom location. Before deleting a custom location, review any fleets // currently using the custom location and deregister the location if it is in use. -// For more information see, DeregisterCompute -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html). +// For more information see, DeregisterCompute (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html) +// . func (c *Client) DeleteLocation(ctx context.Context, params *DeleteLocationInput, optFns ...func(*Options)) (*DeleteLocationOutput, error) { if params == nil { params = &DeleteLocationInput{} diff --git a/service/gamelift/api_op_DeleteMatchmakingRuleSet.go b/service/gamelift/api_op_DeleteMatchmakingRuleSet.go index 7fc5c37a640..ae8f8237b3c 100644 --- a/service/gamelift/api_op_DeleteMatchmakingRuleSet.go +++ b/service/gamelift/api_op_DeleteMatchmakingRuleSet.go @@ -13,9 +13,7 @@ import ( // Deletes an existing matchmaking rule set. To delete the rule set, provide the // rule set name. Rule sets cannot be deleted if they are currently being used by a // matchmaking configuration. Learn more -// -// * Build a rule set -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) +// - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) func (c *Client) DeleteMatchmakingRuleSet(ctx context.Context, params *DeleteMatchmakingRuleSetInput, optFns ...func(*Options)) (*DeleteMatchmakingRuleSetOutput, error) { if params == nil { params = &DeleteMatchmakingRuleSetInput{} diff --git a/service/gamelift/api_op_DeleteScalingPolicy.go b/service/gamelift/api_op_DeleteScalingPolicy.go index 9079c4f0e62..d1d58d4960e 100644 --- a/service/gamelift/api_op_DeleteScalingPolicy.go +++ b/service/gamelift/api_op_DeleteScalingPolicy.go @@ -13,9 +13,8 @@ import ( // Deletes a fleet scaling policy. Once deleted, the policy is no longer in force // and GameLift removes all record of it. To delete a scaling policy, specify both // the scaling policy name and the fleet ID it is associated with. To temporarily -// suspend scaling policies, use StopFleetActions -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). -// This operation suspends all policies for the fleet. +// suspend scaling policies, use StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html) +// . This operation suspends all policies for the fleet. func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingPolicyInput, optFns ...func(*Options)) (*DeleteScalingPolicyOutput, error) { if params == nil { params = &DeleteScalingPolicyInput{} @@ -33,8 +32,8 @@ func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingP type DeleteScalingPolicyInput struct { - // A unique identifier for the fleet to be deleted. You can use either the fleet ID - // or ARN value. + // A unique identifier for the fleet to be deleted. You can use either the fleet + // ID or ARN value. // // This member is required. FleetId *string diff --git a/service/gamelift/api_op_DeleteScript.go b/service/gamelift/api_op_DeleteScript.go index ebf9b8ae5ca..76cb34bafef 100644 --- a/service/gamelift/api_op_DeleteScript.go +++ b/service/gamelift/api_op_DeleteScript.go @@ -10,16 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Realtime script. This operation permanently deletes the script record. -// If script files were uploaded, they are also deleted (files stored in an S3 -// bucket are not deleted). To delete a script, specify the script ID. Before +// Deletes a Realtime script. This operation permanently deletes the script +// record. If script files were uploaded, they are also deleted (files stored in an +// S3 bucket are not deleted). To delete a script, specify the script ID. Before // deleting a script, be sure to terminate all fleets that are deployed with the // script being deleted. Fleet instances periodically check for script updates, and // if the script record no longer exists, the instance will go into an error state -// and be unable to host game sessions. Learn more Amazon GameLift Realtime Servers -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// and be unable to host game sessions. Learn more Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DeleteScript(ctx context.Context, params *DeleteScriptInput, optFns ...func(*Options)) (*DeleteScriptOutput, error) { if params == nil { params = &DeleteScriptInput{} diff --git a/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go b/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go index 474f322c44e..c3f42aa5e07 100644 --- a/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go +++ b/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go @@ -11,10 +11,8 @@ import ( ) // Cancels a pending VPC peering authorization for the specified VPC. If you need -// to delete an existing VPC peering connection, use DeleteVpcPeeringConnection -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html). -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// to delete an existing VPC peering connection, use DeleteVpcPeeringConnection (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html) +// . Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DeleteVpcPeeringAuthorization(ctx context.Context, params *DeleteVpcPeeringAuthorizationInput, optFns ...func(*Options)) (*DeleteVpcPeeringAuthorizationOutput, error) { if params == nil { params = &DeleteVpcPeeringAuthorizationInput{} @@ -43,8 +41,8 @@ type DeleteVpcPeeringAuthorizationInput struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . // // This member is required. PeerVpcId *string diff --git a/service/gamelift/api_op_DeleteVpcPeeringConnection.go b/service/gamelift/api_op_DeleteVpcPeeringConnection.go index 1e4df04e572..80c4fdcc0ca 100644 --- a/service/gamelift/api_op_DeleteVpcPeeringConnection.go +++ b/service/gamelift/api_op_DeleteVpcPeeringConnection.go @@ -15,8 +15,7 @@ import ( // Once a valid authorization exists, call this operation from the Amazon Web // Services account that is used to manage the Amazon GameLift fleets. Identify the // connection to delete by the connection ID and fleet ID. If successful, the -// connection is removed. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// connection is removed. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DeleteVpcPeeringConnection(ctx context.Context, params *DeleteVpcPeeringConnectionInput, optFns ...func(*Options)) (*DeleteVpcPeeringConnectionOutput, error) { if params == nil { params = &DeleteVpcPeeringConnectionInput{} diff --git a/service/gamelift/api_op_DeregisterGameServer.go b/service/gamelift/api_op_DeregisterGameServer.go index 496052cea3d..2c42ce4bf88 100644 --- a/service/gamelift/api_op_DeregisterGameServer.go +++ b/service/gamelift/api_op_DeregisterGameServer.go @@ -16,8 +16,7 @@ import ( // returned in a list of active game servers. To deregister a game server, specify // the game server group and game server ID. If successful, this operation emits a // CloudWatch event with termination timestamp and reason. Learn more GameLift -// FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) DeregisterGameServer(ctx context.Context, params *DeregisterGameServerInput, optFns ...func(*Options)) (*DeregisterGameServerOutput, error) { if params == nil { params = &DeregisterGameServerInput{} diff --git a/service/gamelift/api_op_DescribeAlias.go b/service/gamelift/api_op_DescribeAlias.go index 563cc3384f4..2447a6798f8 100644 --- a/service/gamelift/api_op_DescribeAlias.go +++ b/service/gamelift/api_op_DescribeAlias.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves properties for an alias. This operation returns all alias metadata and -// settings. To get an alias's target fleet ID only, use ResolveAlias. To get alias -// properties, specify the alias ID. If successful, the requested alias record is -// returned. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Retrieves properties for an alias. This operation returns all alias metadata +// and settings. To get an alias's target fleet ID only, use ResolveAlias . To get +// alias properties, specify the alias ID. If successful, the requested alias +// record is returned. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeAlias(ctx context.Context, params *DescribeAliasInput, optFns ...func(*Options)) (*DescribeAliasOutput, error) { if params == nil { params = &DescribeAliasInput{} @@ -33,8 +32,8 @@ func (c *Client) DescribeAlias(ctx context.Context, params *DescribeAliasInput, type DescribeAliasInput struct { - // The unique identifier for the fleet alias that you want to retrieve. You can use - // either the alias ID or ARN value. + // The unique identifier for the fleet alias that you want to retrieve. You can + // use either the alias ID or ARN value. // // This member is required. AliasId *string diff --git a/service/gamelift/api_op_DescribeBuild.go b/service/gamelift/api_op_DescribeBuild.go index f138b936462..0aee12c420e 100644 --- a/service/gamelift/api_op_DescribeBuild.go +++ b/service/gamelift/api_op_DescribeBuild.go @@ -13,10 +13,8 @@ import ( // Retrieves properties for a custom game build. To request a build resource, // specify a build ID. If successful, an object containing the build properties is -// returned. Learn more Upload a Custom Server Build -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// returned. Learn more Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeBuild(ctx context.Context, params *DescribeBuildInput, optFns ...func(*Options)) (*DescribeBuildOutput, error) { if params == nil { params = &DescribeBuildInput{} @@ -34,8 +32,8 @@ func (c *Client) DescribeBuild(ctx context.Context, params *DescribeBuildInput, type DescribeBuildInput struct { - // A unique identifier for the build to retrieve properties for. You can use either - // the build ID or ARN value. + // A unique identifier for the build to retrieve properties for. You can use + // either the build ID or ARN value. // // This member is required. BuildId *string diff --git a/service/gamelift/api_op_DescribeEC2InstanceLimits.go b/service/gamelift/api_op_DescribeEC2InstanceLimits.go index de5ebce5f90..af28057822e 100644 --- a/service/gamelift/api_op_DescribeEC2InstanceLimits.go +++ b/service/gamelift/api_op_DescribeEC2InstanceLimits.go @@ -11,55 +11,43 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the instance limits and current utilization for an Amazon Web Services -// Region or location. Instance limits control the number of instances, per -// instance type, per location, that your Amazon Web Services account can use. -// Learn more at Amazon EC2 Instance Types -// (http://aws.amazon.com/ec2/instance-types/). The information returned includes -// the maximum number of instances allowed and your account's current usage across -// all fleets. This information can affect your ability to scale your GameLift -// fleets. You can request a limit increase for your account by using the Service -// limits page in the GameLift console. Instance limits differ based on whether the -// instances are deployed in a fleet's home Region or in a remote location. For -// remote locations, limits also differ based on the combination of home Region and -// remote location. All requests must specify an Amazon Web Services Region (either -// explicitly or as your default settings). To get the limit for a remote location, -// you must also specify the location. For example, the following requests all -// return different results: +// Retrieves the instance limits and current utilization for an Amazon Web +// Services Region or location. Instance limits control the number of instances, +// per instance type, per location, that your Amazon Web Services account can use. +// Learn more at Amazon EC2 Instance Types (http://aws.amazon.com/ec2/instance-types/) +// . The information returned includes the maximum number of instances allowed and +// your account's current usage across all fleets. This information can affect your +// ability to scale your GameLift fleets. You can request a limit increase for your +// account by using the Service limits page in the GameLift console. Instance +// limits differ based on whether the instances are deployed in a fleet's home +// Region or in a remote location. For remote locations, limits also differ based +// on the combination of home Region and remote location. All requests must specify +// an Amazon Web Services Region (either explicitly or as your default settings). +// To get the limit for a remote location, you must also specify the location. For +// example, the following requests all return different results: +// - Request specifies the Region ap-northeast-1 with no location. The result is +// limits and usage data on all instance types that are deployed in us-east-2 , +// by all of the fleets that reside in ap-northeast-1 . +// - Request specifies the Region us-east-1 with location ca-central-1 . The +// result is limits and usage data on all instance types that are deployed in +// ca-central-1 , by all of the fleets that reside in us-east-2 . These limits do +// not affect fleets in any other Regions that deploy instances to ca-central-1 . +// - Request specifies the Region eu-west-1 with location ca-central-1 . The +// result is limits and usage data on all instance types that are deployed in +// ca-central-1 , by all of the fleets that reside in eu-west-1 . // -// * Request specifies the Region ap-northeast-1 with no -// location. The result is limits and usage data on all instance types that are -// deployed in us-east-2, by all of the fleets that reside in ap-northeast-1. +// This operation can be used in the following ways: +// - To get limit and usage data for all instance types that are deployed in an +// Amazon Web Services Region by fleets that reside in the same Region: Specify the +// Region only. Optionally, specify a single instance type to retrieve information +// for. +// - To get limit and usage data for all instance types that are deployed to a +// remote location by fleets that reside in different Amazon Web Services Region: +// Provide both the Amazon Web Services Region and the remote location. Optionally, +// specify a single instance type to retrieve information for. // -// * -// Request specifies the Region us-east-1 with location ca-central-1. The result is -// limits and usage data on all instance types that are deployed in ca-central-1, -// by all of the fleets that reside in us-east-2. These limits do not affect fleets -// in any other Regions that deploy instances to ca-central-1. -// -// * Request specifies -// the Region eu-west-1 with location ca-central-1. The result is limits and usage -// data on all instance types that are deployed in ca-central-1, by all of the -// fleets that reside in eu-west-1. -// -// This operation can be used in the following -// ways: -// -// * To get limit and usage data for all instance types that are deployed in -// an Amazon Web Services Region by fleets that reside in the same Region: Specify -// the Region only. Optionally, specify a single instance type to retrieve -// information for. -// -// * To get limit and usage data for all instance types that are -// deployed to a remote location by fleets that reside in different Amazon Web -// Services Region: Provide both the Amazon Web Services Region and the remote -// location. Optionally, specify a single instance type to retrieve information -// for. -// -// If successful, an EC2InstanceLimits object is returned with limits and -// usage data for each requested instance type. Learn more Setting up GameLift -// fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// If successful, an EC2InstanceLimits object is returned with limits and usage +// data for each requested instance type. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DescribeEC2InstanceLimits(ctx context.Context, params *DescribeEC2InstanceLimitsInput, optFns ...func(*Options)) (*DescribeEC2InstanceLimitsOutput, error) { if params == nil { params = &DescribeEC2InstanceLimitsInput{} @@ -84,7 +72,7 @@ type DescribeEC2InstanceLimitsInput struct { EC2InstanceType types.EC2InstanceType // The name of a remote location to request instance limits for, in the form of an - // Amazon Web Services Region code such as us-west-2. + // Amazon Web Services Region code such as us-west-2 . Location *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeFleetAttributes.go b/service/gamelift/api_op_DescribeFleetAttributes.go index 97b81c334e6..f7a5ff69b2f 100644 --- a/service/gamelift/api_op_DescribeFleetAttributes.go +++ b/service/gamelift/api_op_DescribeFleetAttributes.go @@ -15,21 +15,17 @@ import ( // Retrieves core fleet-wide properties, including the computing hardware and // deployment configuration for all instances in the fleet. This operation can be // used in the following ways: +// - To get attributes for one or more specific fleets, provide a list of fleet +// IDs or fleet ARNs. +// - To get attributes for all fleets, do not provide a fleet identifier. // -// * To get attributes for one or more specific -// fleets, provide a list of fleet IDs or fleet ARNs. -// -// * To get attributes for all -// fleets, do not provide a fleet identifier. -// -// When requesting attributes for -// multiple fleets, use the pagination parameters to retrieve results as a set of -// sequential pages. If successful, a FleetAttributes object is returned for each -// fleet requested, unless the fleet identifier is not found. Some API operations -// limit the number of fleet IDs that allowed in one request. If a request exceeds -// this limit, the request fails and the error message contains the maximum allowed -// number. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// When requesting attributes for multiple fleets, use the pagination parameters +// to retrieve results as a set of sequential pages. If successful, a +// FleetAttributes object is returned for each fleet requested, unless the fleet +// identifier is not found. Some API operations limit the number of fleet IDs that +// allowed in one request. If a request exceeds this limit, the request fails and +// the error message contains the maximum allowed number. Learn more Setting up +// GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DescribeFleetAttributes(ctx context.Context, params *DescribeFleetAttributesInput, optFns ...func(*Options)) (*DescribeFleetAttributesOutput, error) { if params == nil { params = &DescribeFleetAttributesInput{} @@ -57,10 +53,10 @@ type DescribeFleetAttributesInput struct { // request specifies one or a list of fleet IDs. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. This parameter is ignored - // when the request specifies one or a list of fleet IDs. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. This parameter is + // ignored when the request specifies one or a list of fleet IDs. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeFleetCapacity.go b/service/gamelift/api_op_DescribeFleetCapacity.go index 57768e6c2b4..76627889983 100644 --- a/service/gamelift/api_op_DescribeFleetCapacity.go +++ b/service/gamelift/api_op_DescribeFleetCapacity.go @@ -17,25 +17,19 @@ import ( // settings that can control how capacity scaling. For fleets with remote // locations, this operation retrieves data for the fleet's home Region only. This // operation can be used in the following ways: +// - To get capacity data for one or more specific fleets, provide a list of +// fleet IDs or fleet ARNs. +// - To get capacity data for all fleets, do not provide a fleet identifier. // -// * To get capacity data for one or -// more specific fleets, provide a list of fleet IDs or fleet ARNs. -// -// * To get -// capacity data for all fleets, do not provide a fleet identifier. -// -// When -// requesting multiple fleets, use the pagination parameters to retrieve results as -// a set of sequential pages. If successful, a FleetCapacity object is returned for -// each requested fleet ID. Each FleetCapacity object includes a Location property, -// which is set to the fleet's home Region. When a list of fleet IDs is provided, -// attribute objects are returned only for fleets that currently exist. Some API -// operations may limit the number of fleet IDs that are allowed in one request. If -// a request exceeds this limit, the request fails and the error message includes -// the maximum allowed. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)GameLift -// metrics for fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) +// When requesting multiple fleets, use the pagination parameters to retrieve +// results as a set of sequential pages. If successful, a FleetCapacity object is +// returned for each requested fleet ID. Each FleetCapacity object includes a +// Location property, which is set to the fleet's home Region. When a list of fleet +// IDs is provided, attribute objects are returned only for fleets that currently +// exist. Some API operations may limit the number of fleet IDs that are allowed in +// one request. If a request exceeds this limit, the request fails and the error +// message includes the maximum allowed. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) func (c *Client) DescribeFleetCapacity(ctx context.Context, params *DescribeFleetCapacityInput, optFns ...func(*Options)) (*DescribeFleetCapacityOutput, error) { if params == nil { params = &DescribeFleetCapacityInput{} @@ -63,10 +57,10 @@ type DescribeFleetCapacityInput struct { // request specifies one or a list of fleet IDs. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. This parameter is ignored - // when the request specifies one or a list of fleet IDs. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. This parameter is + // ignored when the request specifies one or a list of fleet IDs. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeFleetEvents.go b/service/gamelift/api_op_DescribeFleetEvents.go index 2d99b11465d..2cb05a3156f 100644 --- a/service/gamelift/api_op_DescribeFleetEvents.go +++ b/service/gamelift/api_op_DescribeFleetEvents.go @@ -19,8 +19,7 @@ import ( // changes to status and capacity in remote locations. You can specify a time range // to limit the result set. Use the pagination parameters to retrieve results as a // set of sequential pages. If successful, a collection of event log entries -// matching the request are returned. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// matching the request are returned. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DescribeFleetEvents(ctx context.Context, params *DescribeFleetEventsInput, optFns ...func(*Options)) (*DescribeFleetEventsOutput, error) { if params == nil { params = &DescribeFleetEventsInput{} @@ -54,9 +53,9 @@ type DescribeFleetEventsInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // The earliest date to retrieve event logs for. If no start time is specified, @@ -147,8 +146,8 @@ func (c *Client) addOperationDescribeFleetEventsMiddlewares(stack *middleware.St return nil } -// DescribeFleetEventsAPIClient is a client that implements the DescribeFleetEvents -// operation. +// DescribeFleetEventsAPIClient is a client that implements the +// DescribeFleetEvents operation. type DescribeFleetEventsAPIClient interface { DescribeFleetEvents(context.Context, *DescribeFleetEventsInput, ...func(*Options)) (*DescribeFleetEventsOutput, error) } diff --git a/service/gamelift/api_op_DescribeFleetLocationAttributes.go b/service/gamelift/api_op_DescribeFleetLocationAttributes.go index 184a10865a9..07a2f1bfb62 100644 --- a/service/gamelift/api_op_DescribeFleetLocationAttributes.go +++ b/service/gamelift/api_op_DescribeFleetLocationAttributes.go @@ -12,25 +12,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information on a fleet's remote locations, including life-cycle status -// and any suspended fleet activity. This operation can be used in the following -// ways: +// Retrieves information on a fleet's remote locations, including life-cycle +// status and any suspended fleet activity. This operation can be used in the +// following ways: +// - To get data for specific locations, provide a fleet identifier and a list +// of locations. Location data is returned in the order that it is requested. +// - To get data for all locations, provide a fleet identifier only. Location +// data is returned in no particular order. // -// * To get data for specific locations, provide a fleet identifier and a -// list of locations. Location data is returned in the order that it is -// requested. -// -// * To get data for all locations, provide a fleet identifier only. -// Location data is returned in no particular order. -// -// When requesting attributes -// for multiple locations, use the pagination parameters to retrieve results as a -// set of sequential pages. If successful, a LocationAttributes object is returned -// for each requested location. If the fleet does not have a requested location, no -// information is returned. This operation does not return the home Region. To get -// information on a fleet's home Region, call DescribeFleetAttributes. Learn more -// Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// When requesting attributes for multiple locations, use the pagination +// parameters to retrieve results as a set of sequential pages. If successful, a +// LocationAttributes object is returned for each requested location. If the fleet +// does not have a requested location, no information is returned. This operation +// does not return the home Region. To get information on a fleet's home Region, +// call DescribeFleetAttributes . Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DescribeFleetLocationAttributes(ctx context.Context, params *DescribeFleetLocationAttributesInput, optFns ...func(*Options)) (*DescribeFleetLocationAttributesOutput, error) { if params == nil { params = &DescribeFleetLocationAttributesInput{} @@ -59,12 +54,12 @@ type DescribeFleetLocationAttributesInput struct { Limit *int32 // A list of fleet locations to retrieve information for. Specify locations in the - // form of an Amazon Web Services Region code, such as us-west-2. + // form of an Amazon Web Services Region code, such as us-west-2 . Locations []string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde @@ -72,11 +67,10 @@ type DescribeFleetLocationAttributesInput struct { type DescribeFleetLocationAttributesOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that location attributes were requested for. diff --git a/service/gamelift/api_op_DescribeFleetLocationCapacity.go b/service/gamelift/api_op_DescribeFleetLocationCapacity.go index 8bda7862dd1..c889ee45bdb 100644 --- a/service/gamelift/api_op_DescribeFleetLocationCapacity.go +++ b/service/gamelift/api_op_DescribeFleetLocationCapacity.go @@ -11,17 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the resource capacity settings for a fleet location. The data returned -// includes the current capacity (number of EC2 instances) and some scaling -// settings for the requested fleet location. Use this operation to retrieve -// capacity information for a fleet's remote location or home Region (you can also -// retrieve home Region capacity by calling DescribeFleetCapacity). To retrieve -// capacity data, identify a fleet and location. If successful, a FleetCapacity -// object is returned for the requested fleet location. Learn more Setting up -// GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)GameLift -// metrics for fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) +// Retrieves the resource capacity settings for a fleet location. The data +// returned includes the current capacity (number of EC2 instances) and some +// scaling settings for the requested fleet location. Use this operation to +// retrieve capacity information for a fleet's remote location or home Region (you +// can also retrieve home Region capacity by calling DescribeFleetCapacity ). To +// retrieve capacity data, identify a fleet and location. If successful, a +// FleetCapacity object is returned for the requested fleet location. Learn more +// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) func (c *Client) DescribeFleetLocationCapacity(ctx context.Context, params *DescribeFleetLocationCapacityInput, optFns ...func(*Options)) (*DescribeFleetLocationCapacityOutput, error) { if params == nil { params = &DescribeFleetLocationCapacityInput{} @@ -46,7 +44,7 @@ type DescribeFleetLocationCapacityInput struct { FleetId *string // The fleet location to retrieve capacity information for. Specify a location in - // the form of an Amazon Web Services Region code, such as us-west-2. + // the form of an Amazon Web Services Region code, such as us-west-2 . // // This member is required. Location *string @@ -56,8 +54,8 @@ type DescribeFleetLocationCapacityInput struct { type DescribeFleetLocationCapacityOutput struct { - // Resource capacity information for the requested fleet location. Capacity objects - // are returned only for fleets and locations that currently exist. + // Resource capacity information for the requested fleet location. Capacity + // objects are returned only for fleets and locations that currently exist. FleetCapacity *types.FleetCapacity // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_DescribeFleetLocationUtilization.go b/service/gamelift/api_op_DescribeFleetLocationUtilization.go index 78f07390bea..42f010c987d 100644 --- a/service/gamelift/api_op_DescribeFleetLocationUtilization.go +++ b/service/gamelift/api_op_DescribeFleetLocationUtilization.go @@ -15,12 +15,10 @@ import ( // snapshot of current game hosting activity at the requested location. Use this // operation to retrieve utilization information for a fleet's remote location or // home Region (you can also retrieve home Region utilization by calling -// DescribeFleetUtilization). To retrieve utilization data, identify a fleet and -// location. If successful, a FleetUtilization object is returned for the requested -// fleet location. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)GameLift -// metrics for fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) +// DescribeFleetUtilization ). To retrieve utilization data, identify a fleet and +// location. If successful, a FleetUtilization object is returned for the +// requested fleet location. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// GameLift metrics for fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) func (c *Client) DescribeFleetLocationUtilization(ctx context.Context, params *DescribeFleetLocationUtilizationInput, optFns ...func(*Options)) (*DescribeFleetLocationUtilizationOutput, error) { if params == nil { params = &DescribeFleetLocationUtilizationInput{} @@ -45,7 +43,7 @@ type DescribeFleetLocationUtilizationInput struct { FleetId *string // The fleet location to retrieve utilization information for. Specify a location - // in the form of an Amazon Web Services Region code, such as us-west-2. + // in the form of an Amazon Web Services Region code, such as us-west-2 . // // This member is required. Location *string diff --git a/service/gamelift/api_op_DescribeFleetPortSettings.go b/service/gamelift/api_op_DescribeFleetPortSettings.go index c4082847cf8..77cdb6eff84 100644 --- a/service/gamelift/api_op_DescribeFleetPortSettings.go +++ b/service/gamelift/api_op_DescribeFleetPortSettings.go @@ -16,20 +16,16 @@ import ( // use to access server processes in the fleet. Game sessions that are running on // instances in the fleet must use connections that fall in this range. This // operation can be used in the following ways: +// - To retrieve the inbound connection permissions for a fleet, identify the +// fleet's unique identifier. +// - To check the status of recent updates to a fleet remote location, specify +// the fleet ID and a location. Port setting updates can take time to propagate +// across all locations. // -// * To retrieve the inbound -// connection permissions for a fleet, identify the fleet's unique identifier. -// -// * -// To check the status of recent updates to a fleet remote location, specify the -// fleet ID and a location. Port setting updates can take time to propagate across -// all locations. -// -// If successful, a set of IpPermission objects is returned for the -// requested fleet ID. When a location is specified, a pending status is included. -// If the requested fleet has been deleted, the result set is empty. Learn more -// Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// If successful, a set of IpPermission objects is returned for the requested +// fleet ID. When a location is specified, a pending status is included. If the +// requested fleet has been deleted, the result set is empty. Learn more Setting +// up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) DescribeFleetPortSettings(ctx context.Context, params *DescribeFleetPortSettingsInput, optFns ...func(*Options)) (*DescribeFleetPortSettingsOutput, error) { if params == nil { params = &DescribeFleetPortSettingsInput{} @@ -54,7 +50,7 @@ type DescribeFleetPortSettingsInput struct { FleetId *string // A remote location to check for status of port setting updates. Use the Amazon - // Web Services Region code format, such as us-west-2. + // Web Services Region code format, such as us-west-2 . Location *string noSmithyDocumentSerde @@ -62,11 +58,10 @@ type DescribeFleetPortSettingsInput struct { type DescribeFleetPortSettingsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that was requested. @@ -76,7 +71,7 @@ type DescribeFleetPortSettingsOutput struct { InboundPermissions []types.IpPermission // The requested fleet location, expressed as an Amazon Web Services Region code, - // such as us-west-2. + // such as us-west-2 . Location *string // The current status of updates to the fleet's port settings in the requested diff --git a/service/gamelift/api_op_DescribeFleetUtilization.go b/service/gamelift/api_op_DescribeFleetUtilization.go index 70509df8641..9c7356e8a01 100644 --- a/service/gamelift/api_op_DescribeFleetUtilization.go +++ b/service/gamelift/api_op_DescribeFleetUtilization.go @@ -15,30 +15,22 @@ import ( // Retrieves utilization statistics for one or more fleets. Utilization data // provides a snapshot of how the fleet's hosting resources are currently being // used. For fleets with remote locations, this operation retrieves data for the -// fleet's home Region only. See DescribeFleetLocationUtilization -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html) +// fleet's home Region only. See DescribeFleetLocationUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html) // to get utilization statistics for a fleet's remote locations. This operation can // be used in the following ways: +// - To get utilization data for one or more specific fleets, provide a list of +// fleet IDs or fleet ARNs. +// - To get utilization data for all fleets, do not provide a fleet identifier. // -// * To get utilization data for one or more -// specific fleets, provide a list of fleet IDs or fleet ARNs. -// -// * To get -// utilization data for all fleets, do not provide a fleet identifier. -// -// When -// requesting multiple fleets, use the pagination parameters to retrieve results as -// a set of sequential pages. If successful, a FleetUtilization -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html) +// When requesting multiple fleets, use the pagination parameters to retrieve +// results as a set of sequential pages. If successful, a FleetUtilization (https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html) // object is returned for each requested fleet ID, unless the fleet identifier is // not found. Each fleet utilization object includes a Location property, which is // set to the fleet's home Region. Some API operations may limit the number of // fleet IDs allowed in one request. If a request exceeds this limit, the request // fails and the error message includes the maximum allowed. Learn more Setting up -// GameLift Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)GameLift -// Metrics for Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) +// GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// GameLift Metrics for Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet) func (c *Client) DescribeFleetUtilization(ctx context.Context, params *DescribeFleetUtilizationInput, optFns ...func(*Options)) (*DescribeFleetUtilizationOutput, error) { if params == nil { params = &DescribeFleetUtilizationInput{} @@ -66,10 +58,10 @@ type DescribeFleetUtilizationInput struct { // request specifies one or a list of fleet IDs. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. This parameter is ignored - // when the request specifies one or a list of fleet IDs. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. This parameter is + // ignored when the request specifies one or a list of fleet IDs. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeGameServer.go b/service/gamelift/api_op_DescribeGameServer.go index 478da30048a..569043de852 100644 --- a/service/gamelift/api_op_DescribeGameServer.go +++ b/service/gamelift/api_op_DescribeGameServer.go @@ -16,8 +16,7 @@ import ( // game server status, health check info, and the instance that the game server is // running on. To retrieve game server information, specify the game server ID. If // successful, the requested game server object is returned. Learn more GameLift -// FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) DescribeGameServer(ctx context.Context, params *DescribeGameServerInput, optFns ...func(*Options)) (*DescribeGameServerOutput, error) { if params == nil { params = &DescribeGameServerInput{} diff --git a/service/gamelift/api_op_DescribeGameServerGroup.go b/service/gamelift/api_op_DescribeGameServerGroup.go index 4712ca42b25..1500baab353 100644 --- a/service/gamelift/api_op_DescribeGameServerGroup.go +++ b/service/gamelift/api_op_DescribeGameServerGroup.go @@ -18,8 +18,7 @@ import ( // policies, and maximum/minimum group size, access the Auto Scaling group // directly. To get attributes for a game server group, provide a group name or ARN // value. If successful, a GameServerGroup object is returned. Learn more GameLift -// FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) DescribeGameServerGroup(ctx context.Context, params *DescribeGameServerGroupInput, optFns ...func(*Options)) (*DescribeGameServerGroupOutput, error) { if params == nil { params = &DescribeGameServerGroupInput{} diff --git a/service/gamelift/api_op_DescribeGameServerInstances.go b/service/gamelift/api_op_DescribeGameServerInstances.go index e2a1660d7a2..4f10d7570d4 100644 --- a/service/gamelift/api_op_DescribeGameServerInstances.go +++ b/service/gamelift/api_op_DescribeGameServerInstances.go @@ -24,8 +24,7 @@ import ( // called with every game server claim request; this practice can cause you to // exceed your API limit, which results in errors. Instead, as a best practice, // cache the results and refresh your cache no more than once every 10 seconds. -// Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) DescribeGameServerInstances(ctx context.Context, params *DescribeGameServerInstancesInput, optFns ...func(*Options)) (*DescribeGameServerInstancesOutput, error) { if params == nil { params = &DescribeGameServerInstancesInput{} @@ -49,7 +48,7 @@ type DescribeGameServerInstancesInput struct { GameServerGroupName *string // The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 - // instance IDs use a 17-character format, for example: i-1234567890abcdef0. To + // instance IDs use a 17-character format, for example: i-1234567890abcdef0 . To // retrieve all instances in the game server group, leave this parameter empty. InstanceIds []string @@ -57,9 +56,9 @@ type DescribeGameServerInstancesInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeGameSessionDetails.go b/service/gamelift/api_op_DescribeGameSessionDetails.go index 94115937b09..0e9c2c29725 100644 --- a/service/gamelift/api_op_DescribeGameSessionDetails.go +++ b/service/gamelift/api_op_DescribeGameSessionDetails.go @@ -16,29 +16,22 @@ import ( // protection policy in force, a set of one or more game sessions in a specific // fleet location. You can optionally filter the results by current game session // status. This operation can be used in the following ways: +// - To retrieve details for all game sessions that are currently running on all +// locations in a fleet, provide a fleet or alias ID, with an optional status +// filter. This approach returns details from the fleet's home Region and all +// remote locations. +// - To retrieve details for all game sessions that are currently running on a +// specific fleet location, provide a fleet or alias ID and a location name, with +// optional status filter. The location can be the fleet's home Region or any +// remote location. +// - To retrieve details for a specific game session, provide the game session +// ID. This approach looks for the game session ID in all fleets that reside in the +// Amazon Web Services Region defined in the request. // -// * To retrieve details -// for all game sessions that are currently running on all locations in a fleet, -// provide a fleet or alias ID, with an optional status filter. This approach -// returns details from the fleet's home Region and all remote locations. -// -// * To -// retrieve details for all game sessions that are currently running on a specific -// fleet location, provide a fleet or alias ID and a location name, with optional -// status filter. The location can be the fleet's home Region or any remote -// location. -// -// * To retrieve details for a specific game session, provide the game -// session ID. This approach looks for the game session ID in all fleets that -// reside in the Amazon Web Services Region defined in the request. -// -// Use the -// pagination parameters to retrieve results as a set of sequential pages. If -// successful, a GameSessionDetail object is returned for each game session that -// matches the request. Learn more Find a game session -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Use the pagination parameters to retrieve results as a set of sequential pages. +// If successful, a GameSessionDetail object is returned for each game session +// that matches the request. Learn more Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeGameSessionDetails(ctx context.Context, params *DescribeGameSessionDetailsInput, optFns ...func(*Options)) (*DescribeGameSessionDetailsOutput, error) { if params == nil { params = &DescribeGameSessionDetailsInput{} @@ -56,8 +49,8 @@ func (c *Client) DescribeGameSessionDetails(ctx context.Context, params *Describ type DescribeGameSessionDetailsInput struct { - // A unique identifier for the alias associated with the fleet to retrieve all game - // sessions for. You can use either the alias ID or ARN value. + // A unique identifier for the alias associated with the fleet to retrieve all + // game sessions for. You can use either the alias ID or ARN value. AliasId *string // A unique identifier for the fleet to retrieve all game sessions active on the @@ -71,18 +64,19 @@ type DescribeGameSessionDetailsInput struct { // get results as a set of sequential pages. Limit *int32 - // A fleet location to get game session details for. You can specify a fleet's home - // Region or a remote location. Use the Amazon Web Services Region code format, - // such as us-west-2. + // A fleet location to get game session details for. You can specify a fleet's + // home Region or a remote location. Use the Amazon Web Services Region code + // format, such as us-west-2 . Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string - // Game session status to filter results on. Possible game session statuses include - // ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory). + // Game session status to filter results on. Possible game session statuses + // include ACTIVE , TERMINATED , ACTIVATING and TERMINATING (the last two are + // transitory). StatusFilter *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeGameSessionQueues.go b/service/gamelift/api_op_DescribeGameSessionQueues.go index 566ad89e831..f0c9985eb9e 100644 --- a/service/gamelift/api_op_DescribeGameSessionQueues.go +++ b/service/gamelift/api_op_DescribeGameSessionQueues.go @@ -15,8 +15,7 @@ import ( // Retrieves the properties for one or more game session queues. When requesting // multiple queues, use the pagination parameters to retrieve results as a set of // sequential pages. When specifying a list of queues, objects are returned only -// for queues that currently exist in the Region. Learn more View Your Queues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html) +// for queues that currently exist in the Region. Learn more View Your Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html) func (c *Client) DescribeGameSessionQueues(ctx context.Context, params *DescribeGameSessionQueuesInput, optFns ...func(*Options)) (*DescribeGameSessionQueuesOutput, error) { if params == nil { params = &DescribeGameSessionQueuesInput{} @@ -42,9 +41,9 @@ type DescribeGameSessionQueuesInput struct { // ID or ARN value. To request settings for all queues, leave this parameter empty. Names []string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeGameSessions.go b/service/gamelift/api_op_DescribeGameSessions.go index 7f2948f0bef..fc721c9a1f7 100644 --- a/service/gamelift/api_op_DescribeGameSessions.go +++ b/service/gamelift/api_op_DescribeGameSessions.go @@ -15,34 +15,28 @@ import ( // Retrieves a set of one or more game sessions in a specific fleet location. You // can optionally filter the results by current game session status. This operation // can be used in the following ways: +// - To retrieve all game sessions that are currently running on all locations +// in a fleet, provide a fleet or alias ID, with an optional status filter. This +// approach returns all game sessions in the fleet's home Region and all remote +// locations. +// - To retrieve all game sessions that are currently running on a specific +// fleet location, provide a fleet or alias ID and a location name, with optional +// status filter. The location can be the fleet's home Region or any remote +// location. +// - To retrieve a specific game session, provide the game session ID. This +// approach looks for the game session ID in all fleets that reside in the Amazon +// Web Services Region defined in the request. // -// * To retrieve all game sessions that are -// currently running on all locations in a fleet, provide a fleet or alias ID, with -// an optional status filter. This approach returns all game sessions in the -// fleet's home Region and all remote locations. -// -// * To retrieve all game sessions -// that are currently running on a specific fleet location, provide a fleet or -// alias ID and a location name, with optional status filter. The location can be -// the fleet's home Region or any remote location. -// -// * To retrieve a specific game -// session, provide the game session ID. This approach looks for the game session -// ID in all fleets that reside in the Amazon Web Services Region defined in the -// request. -// -// Use the pagination parameters to retrieve results as a set of -// sequential pages. If successful, a GameSession object is returned for each game -// session that matches the request. This operation is not designed to be -// continually called to track game session status. This practice can cause you to -// exceed your API limit, which results in errors. Instead, you must configure an -// Amazon Simple Notification Service (SNS) topic to receive notifications from -// FlexMatch or queues. Continuously polling with DescribeGameSessions should only -// be used for games in development with low game session usage. Available in -// Amazon GameLift Local. Learn more Find a game session -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Use the pagination parameters to retrieve results as a set of sequential pages. +// If successful, a GameSession object is returned for each game session that +// matches the request. This operation is not designed to be continually called to +// track game session status. This practice can cause you to exceed your API limit, +// which results in errors. Instead, you must configure an Amazon Simple +// Notification Service (SNS) topic to receive notifications from FlexMatch or +// queues. Continuously polling with DescribeGameSessions should only be used for +// games in development with low game session usage. Available in Amazon GameLift +// Local. Learn more Find a game session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeGameSessions(ctx context.Context, params *DescribeGameSessionsInput, optFns ...func(*Options)) (*DescribeGameSessionsOutput, error) { if params == nil { params = &DescribeGameSessionsInput{} @@ -75,18 +69,18 @@ type DescribeGameSessionsInput struct { // get results as a set of sequential pages. Limit *int32 - // A fleet location to get game sessions for. You can specify a fleet's home Region - // or a remote location. Use the Amazon Web Services Region code format, such as - // us-west-2. + // A fleet location to get game sessions for. You can specify a fleet's home + // Region or a remote location. Use the Amazon Web Services Region code format, + // such as us-west-2 . Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // Game session status to filter results on. You can filter on the following - // states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are + // states: ACTIVE , TERMINATED , ACTIVATING , and TERMINATING . The last two are // transitory and used for only very brief periods of time. StatusFilter *string diff --git a/service/gamelift/api_op_DescribeInstances.go b/service/gamelift/api_op_DescribeInstances.go index f118abd7136..480c24186ed 100644 --- a/service/gamelift/api_op_DescribeInstances.go +++ b/service/gamelift/api_op_DescribeInstances.go @@ -13,28 +13,20 @@ import ( ) // Retrieves information about a fleet's instances, including instance IDs, -// connection data, and status. This operation can be used in the following -// ways: +// connection data, and status. This operation can be used in the following ways: +// - To get information on all instances that are deployed to a fleet's home +// Region, provide the fleet ID. +// - To get information on all instances that are deployed to a fleet's remote +// location, provide the fleet ID and location name. +// - To get information on a specific instance in a fleet, provide the fleet ID +// and instance ID. // -// * To get information on all instances that are deployed to a fleet's home -// Region, provide the fleet ID. -// -// * To get information on all instances that are -// deployed to a fleet's remote location, provide the fleet ID and location -// name. -// -// * To get information on a specific instance in a fleet, provide the fleet -// ID and instance ID. -// -// Use the pagination parameters to retrieve results as a set -// of sequential pages. If successful, an Instance object is returned for each -// requested instance. Instances are not returned in any particular order. Learn -// more Remotely Access Fleet Instances -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)Debug -// Fleet Issues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Use the pagination parameters to retrieve results as a set of sequential pages. +// If successful, an Instance object is returned for each requested instance. +// Instances are not returned in any particular order. Learn more Remotely Access +// Fleet Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html) +// Debug Fleet Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstancesInput, optFns ...func(*Options)) (*DescribeInstancesOutput, error) { if params == nil { params = &DescribeInstancesInput{} @@ -58,8 +50,8 @@ type DescribeInstancesInput struct { // This member is required. FleetId *string - // A unique identifier for an instance to retrieve. Specify an instance ID or leave - // blank to retrieve all instances in the fleet. + // A unique identifier for an instance to retrieve. Specify an instance ID or + // leave blank to retrieve all instances in the fleet. InstanceId *string // The maximum number of results to return. Use this parameter with NextToken to @@ -67,12 +59,12 @@ type DescribeInstancesInput struct { Limit *int32 // The name of a location to retrieve instance information for, in the form of an - // Amazon Web Services Region code such as us-west-2. + // Amazon Web Services Region code such as us-west-2 . Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeMatchmaking.go b/service/gamelift/api_op_DescribeMatchmaking.go index a477e5986d2..ac65507829a 100644 --- a/service/gamelift/api_op_DescribeMatchmaking.go +++ b/service/gamelift/api_op_DescribeMatchmaking.go @@ -11,19 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket -// information, including--after a successful match is made--connection information -// for the resulting new game session. To request matchmaking tickets, provide a -// list of up to 10 ticket IDs. If the request is successful, a ticket object is -// returned for each requested ID that currently exists. This operation is not -// designed to be continually called to track matchmaking ticket status. This -// practice can cause you to exceed your API limit, which results in errors. +// Retrieves one or more matchmaking tickets. Use this operation to retrieve +// ticket information, including--after a successful match is made--connection +// information for the resulting new game session. To request matchmaking tickets, +// provide a list of up to 10 ticket IDs. If the request is successful, a ticket +// object is returned for each requested ID that currently exists. This operation +// is not designed to be continually called to track matchmaking ticket status. +// This practice can cause you to exceed your API limit, which results in errors. // Instead, as a best practice, set up an Amazon Simple Notification Service to // receive notifications, and provide the topic ARN in the matchmaking -// configuration. Learn more Add FlexMatch to a game client -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) -// Set Up FlexMatch event notification -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) +// configuration. Learn more Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) +// Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) func (c *Client) DescribeMatchmaking(ctx context.Context, params *DescribeMatchmakingInput, optFns ...func(*Options)) (*DescribeMatchmakingOutput, error) { if params == nil { params = &DescribeMatchmakingInput{} diff --git a/service/gamelift/api_op_DescribeMatchmakingConfigurations.go b/service/gamelift/api_op_DescribeMatchmakingConfigurations.go index 297f3b21fb1..473fc6cb191 100644 --- a/service/gamelift/api_op_DescribeMatchmakingConfigurations.go +++ b/service/gamelift/api_op_DescribeMatchmakingConfigurations.go @@ -19,8 +19,7 @@ import ( // pagination parameters to retrieve results as a set of sequential pages. If // successful, a configuration is returned for each requested name. When specifying // a list of names, only configurations that currently exist are returned. Learn -// more Setting up FlexMatch matchmakers -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html) +// more Setting up FlexMatch matchmakers (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html) func (c *Client) DescribeMatchmakingConfigurations(ctx context.Context, params *DescribeMatchmakingConfigurationsInput, optFns ...func(*Options)) (*DescribeMatchmakingConfigurationsOutput, error) { if params == nil { params = &DescribeMatchmakingConfigurationsInput{} @@ -47,9 +46,9 @@ type DescribeMatchmakingConfigurationsInput struct { // configurations, leave this parameter empty. Names []string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // A unique identifier for the matchmaking rule set. You can use either the rule diff --git a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go index 4d14c20f5b4..4d71db924a5 100644 --- a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go +++ b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go @@ -17,9 +17,7 @@ import ( // names. When requesting multiple items, use the pagination parameters to retrieve // results as a set of sequential pages. If successful, a rule set is returned for // each requested name. Learn more -// -// * Build a rule set -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) +// - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) func (c *Client) DescribeMatchmakingRuleSets(ctx context.Context, params *DescribeMatchmakingRuleSetsInput, optFns ...func(*Options)) (*DescribeMatchmakingRuleSetsOutput, error) { if params == nil { params = &DescribeMatchmakingRuleSetsInput{} @@ -41,14 +39,14 @@ type DescribeMatchmakingRuleSetsInput struct { // get results as a set of sequential pages. Limit *int32 - // A list of one or more matchmaking rule set names to retrieve details for. (Note: - // The rule set name is different from the optional "name" field in the rule set - // body.) You can use either the rule set name or ARN value. + // A list of one or more matchmaking rule set names to retrieve details for. + // (Note: The rule set name is different from the optional "name" field in the rule + // set body.) You can use either the rule set name or ARN value. Names []string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribePlayerSessions.go b/service/gamelift/api_op_DescribePlayerSessions.go index e74bdc0620a..90d67a1703d 100644 --- a/service/gamelift/api_op_DescribePlayerSessions.go +++ b/service/gamelift/api_op_DescribePlayerSessions.go @@ -12,24 +12,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves properties for one or more player sessions. This action can be used in -// the following ways: +// Retrieves properties for one or more player sessions. This action can be used +// in the following ways: +// - To retrieve a specific player session, provide the player session ID only. +// - To retrieve all player sessions in a game session, provide the game session +// ID only. +// - To retrieve all player sessions for a specific player, provide a player ID +// only. // -// * To retrieve a specific player session, provide the player -// session ID only. -// -// * To retrieve all player sessions in a game session, provide -// the game session ID only. -// -// * To retrieve all player sessions for a specific -// player, provide a player ID only. -// -// To request player sessions, specify either a -// player session ID, game session ID, or player ID. You can filter this request by -// player session status. Use the pagination parameters to retrieve results as a -// set of sequential pages. If successful, a PlayerSession object is returned for -// each session that matches the request. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To request player sessions, specify either a player session ID, game session +// ID, or player ID. You can filter this request by player session status. Use the +// pagination parameters to retrieve results as a set of sequential pages. If +// successful, a PlayerSession object is returned for each session that matches +// the request. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribePlayerSessions(ctx context.Context, params *DescribePlayerSessionsInput, optFns ...func(*Options)) (*DescribePlayerSessionsOutput, error) { if params == nil { params = &DescribePlayerSessionsInput{} @@ -55,10 +50,10 @@ type DescribePlayerSessionsInput struct { // this parameter is ignored. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. If a player session ID is - // specified, this parameter is ignored. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. If a player session ID + // is specified, this parameter is ignored. NextToken *string // A unique identifier for a player to retrieve player sessions for. @@ -71,19 +66,13 @@ type DescribePlayerSessionsInput struct { // PlayerId is provided in a DescribePlayerSessions request, then the // PlayerSessionStatusFilter has no effect on the response. Possible player session // statuses include the following: - // - // * RESERVED -- The player session request has - // been received, but the player has not yet connected to the server process and/or - // been validated. - // - // * ACTIVE -- The player has been validated by the server process - // and is currently connected. - // - // * COMPLETED -- The player connection has been - // dropped. - // - // * TIMEDOUT -- A player session request was received, but the player - // did not connect and/or was not validated within the timeout limit (60 seconds). + // - RESERVED -- The player session request has been received, but the player + // has not yet connected to the server process and/or been validated. + // - ACTIVE -- The player has been validated by the server process and is + // currently connected. + // - COMPLETED -- The player connection has been dropped. + // - TIMEDOUT -- A player session request was received, but the player did not + // connect and/or was not validated within the timeout limit (60 seconds). PlayerSessionStatusFilter *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeRuntimeConfiguration.go b/service/gamelift/api_op_DescribeRuntimeConfiguration.go index e8fd7bb6871..01b61c6c7e1 100644 --- a/service/gamelift/api_op_DescribeRuntimeConfiguration.go +++ b/service/gamelift/api_op_DescribeRuntimeConfiguration.go @@ -16,10 +16,8 @@ import ( // fleet. To get the runtime configuration that is currently in forces for a fleet, // provide the fleet ID. If successful, a RuntimeConfiguration object is returned // for the requested fleet. If the requested fleet has been deleted, the result set -// is empty. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)Running -// multiple processes on a fleet -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) +// is empty. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Running multiple processes on a fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) func (c *Client) DescribeRuntimeConfiguration(ctx context.Context, params *DescribeRuntimeConfigurationInput, optFns ...func(*Options)) (*DescribeRuntimeConfigurationOutput, error) { if params == nil { params = &DescribeRuntimeConfigurationInput{} diff --git a/service/gamelift/api_op_DescribeScalingPolicies.go b/service/gamelift/api_op_DescribeScalingPolicies.go index 57db9f626e3..d1d33e8e658 100644 --- a/service/gamelift/api_op_DescribeScalingPolicies.go +++ b/service/gamelift/api_op_DescribeScalingPolicies.go @@ -50,33 +50,23 @@ type DescribeScalingPoliciesInput struct { // scaling policies of every location in the fleet. Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // Scaling policy status to filter results on. A scaling policy is only in force // when in an ACTIVE status. - // - // * ACTIVE -- The scaling policy is currently in - // force. - // - // * UPDATEREQUESTED -- A request to update the scaling policy has been - // received. - // - // * UPDATING -- A change is being made to the scaling policy. - // - // * - // DELETEREQUESTED -- A request to delete the scaling policy has been received. - // - // * - // DELETING -- The scaling policy is being deleted. - // - // * DELETED -- The scaling - // policy has been deleted. - // - // * ERROR -- An error occurred in creating the policy. - // It should be removed and recreated. + // - ACTIVE -- The scaling policy is currently in force. + // - UPDATEREQUESTED -- A request to update the scaling policy has been + // received. + // - UPDATING -- A change is being made to the scaling policy. + // - DELETEREQUESTED -- A request to delete the scaling policy has been + // received. + // - DELETING -- The scaling policy is being deleted. + // - DELETED -- The scaling policy has been deleted. + // - ERROR -- An error occurred in creating the policy. It should be removed and + // recreated. StatusFilter types.ScalingStatusType noSmithyDocumentSerde diff --git a/service/gamelift/api_op_DescribeScript.go b/service/gamelift/api_op_DescribeScript.go index a91e5bea4fe..5574f774395 100644 --- a/service/gamelift/api_op_DescribeScript.go +++ b/service/gamelift/api_op_DescribeScript.go @@ -13,10 +13,8 @@ import ( // Retrieves properties for a Realtime script. To request a script record, specify // the script ID. If successful, an object containing the script properties is -// returned. Learn more Amazon GameLift Realtime Servers -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// returned. Learn more Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeScript(ctx context.Context, params *DescribeScriptInput, optFns ...func(*Options)) (*DescribeScriptOutput, error) { if params == nil { params = &DescribeScriptInput{} diff --git a/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go b/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go index 99c3df1936b..172251853b7 100644 --- a/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go +++ b/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go @@ -14,8 +14,7 @@ import ( // Retrieves valid VPC peering authorizations that are pending for the Amazon Web // Services account. This operation returns all VPC peering authorizations and // requests for peering. This includes those initiated and received by this -// account. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// account. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeVpcPeeringAuthorizations(ctx context.Context, params *DescribeVpcPeeringAuthorizationsInput, optFns ...func(*Options)) (*DescribeVpcPeeringAuthorizationsOutput, error) { if params == nil { params = &DescribeVpcPeeringAuthorizationsInput{} diff --git a/service/gamelift/api_op_DescribeVpcPeeringConnections.go b/service/gamelift/api_op_DescribeVpcPeeringConnections.go index 5e2882206d9..6965b69c265 100644 --- a/service/gamelift/api_op_DescribeVpcPeeringConnections.go +++ b/service/gamelift/api_op_DescribeVpcPeeringConnections.go @@ -18,8 +18,7 @@ import ( // the parameter empty to retrieve all connection records. If successful, the // retrieved information includes both active and pending connections. Active // connections identify the IpV4 CIDR block that the VPC uses to connect. Related -// actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) DescribeVpcPeeringConnections(ctx context.Context, params *DescribeVpcPeeringConnectionsInput, optFns ...func(*Options)) (*DescribeVpcPeeringConnectionsOutput, error) { if params == nil { params = &DescribeVpcPeeringConnectionsInput{} diff --git a/service/gamelift/api_op_GetComputeAccess.go b/service/gamelift/api_op_GetComputeAccess.go index 9fcfd5e8f56..926a8295aed 100644 --- a/service/gamelift/api_op_GetComputeAccess.go +++ b/service/gamelift/api_op_GetComputeAccess.go @@ -22,10 +22,8 @@ import ( // secret can be handled as part of the GetInstanceAccess request, as shown in one // of the examples for this operation. To request access to a specific instance, // specify the IDs of both the instance and the fleet it belongs to. Learn more -// Remotely Access Fleet Instances -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)Debug -// Fleet Issues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) +// Remotely Access Fleet Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html) +// Debug Fleet Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) func (c *Client) GetComputeAccess(ctx context.Context, params *GetComputeAccessInput, optFns ...func(*Options)) (*GetComputeAccessOutput, error) { if params == nil { params = &GetComputeAccessInput{} @@ -58,11 +56,10 @@ type GetComputeAccessInput struct { type GetComputeAccessOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift compute resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift compute resource and uniquely identifies it. + // ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . ComputeArn *string // The name of the compute resource you requested credentials for. @@ -71,11 +68,10 @@ type GetComputeAccessOutput struct { // The access credentials for the compute resource. Credentials *types.AwsCredentials - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // The fleet ID of compute resource. diff --git a/service/gamelift/api_op_GetComputeAuthToken.go b/service/gamelift/api_op_GetComputeAuthToken.go index 88b17bc7bba..00830fe40ef 100644 --- a/service/gamelift/api_op_GetComputeAuthToken.go +++ b/service/gamelift/api_op_GetComputeAuthToken.go @@ -51,26 +51,24 @@ type GetComputeAuthTokenOutput struct { // GameLift. AuthToken *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift compute resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift compute resource and uniquely identifies it. + // ARNs are unique across all Regions. Format is // arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 ComputeArn *string // The name of the compute resource you are requesting the authorization token for. ComputeName *string - // The amount of time until the authorization token is no longer valid. To continue - // using the compute resource for game server hosting, renew the authorization - // token by using this operation again. + // The amount of time until the authorization token is no longer valid. To + // continue using the compute resource for game server hosting, renew the + // authorization token by using this operation again. ExpirationTimestamp *time.Time - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that the compute is registered to. diff --git a/service/gamelift/api_op_GetGameSessionLogUrl.go b/service/gamelift/api_op_GetGameSessionLogUrl.go index 05fbc1c4240..63b9162d223 100644 --- a/service/gamelift/api_op_GetGameSessionLogUrl.go +++ b/service/gamelift/api_op_GetGameSessionLogUrl.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the location of stored game session logs for a specified game session. -// When a game session is terminated, GameLift automatically stores the logs in -// Amazon S3 and retains them for 14 days. Use this URL to download the logs. See -// the Amazon Web Services Service Limits -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift) +// Retrieves the location of stored game session logs for a specified game +// session. When a game session is terminated, GameLift automatically stores the +// logs in Amazon S3 and retains them for 14 days. Use this URL to download the +// logs. See the Amazon Web Services Service Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift) // page for maximum log file sizes. Log files that exceed this limit are not saved. -// All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) GetGameSessionLogUrl(ctx context.Context, params *GetGameSessionLogUrlInput, optFns ...func(*Options)) (*GetGameSessionLogUrlOutput, error) { if params == nil { params = &GetGameSessionLogUrlInput{} @@ -45,10 +43,10 @@ type GetGameSessionLogUrlInput struct { type GetGameSessionLogUrlOutput struct { - // Location of the requested game session logs, available for download. This URL is - // valid for 15 minutes, after which S3 will reject any download request using this - // URL. You can request a new URL any time within the 14-day period that the logs - // are retained. + // Location of the requested game session logs, available for download. This URL + // is valid for 15 minutes, after which S3 will reject any download request using + // this URL. You can request a new URL any time within the 14-day period that the + // logs are retained. PreSignedUrl *string // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_GetInstanceAccess.go b/service/gamelift/api_op_GetInstanceAccess.go index 922470837ea..9c14f25efb6 100644 --- a/service/gamelift/api_op_GetInstanceAccess.go +++ b/service/gamelift/api_op_GetInstanceAccess.go @@ -22,14 +22,10 @@ import ( // secret can be handled as part of the GetInstanceAccess request, as shown in one // of the examples for this operation. To request access to a specific instance, // specify the IDs of both the instance and the fleet it belongs to. You can -// retrieve a fleet's instance IDs by calling DescribeInstances -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html). -// Learn more Remotely Access Fleet Instances -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)Debug -// Fleet Issues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// retrieve a fleet's instance IDs by calling DescribeInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html) +// . Learn more Remotely Access Fleet Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html) +// Debug Fleet Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) GetInstanceAccess(ctx context.Context, params *GetInstanceAccessInput, optFns ...func(*Options)) (*GetInstanceAccessOutput, error) { if params == nil { params = &GetInstanceAccessInput{} @@ -47,10 +43,10 @@ func (c *Client) GetInstanceAccess(ctx context.Context, params *GetInstanceAcces type GetInstanceAccessInput struct { - // A unique identifier for the fleet that contains the instance you want access to. - // You can use either the fleet ID or ARN value. The fleet can be in any of the - // following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status - // may be accessible for a short time before they are deleted. + // A unique identifier for the fleet that contains the instance you want access + // to. You can use either the fleet ID or ARN value. The fleet can be in any of the + // following statuses: ACTIVATING , ACTIVE , or ERROR . Fleets with an ERROR + // status may be accessible for a short time before they are deleted. // // This member is required. FleetId *string @@ -66,8 +62,8 @@ type GetInstanceAccessInput struct { type GetInstanceAccessOutput struct { - // The connection information for a fleet instance, including IP address and access - // credentials. + // The connection information for a fleet instance, including IP address and + // access credentials. InstanceAccess *types.InstanceAccess // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_ListAliases.go b/service/gamelift/api_op_ListAliases.go index 6750cd2d682..8a0c3f8512c 100644 --- a/service/gamelift/api_op_ListAliases.go +++ b/service/gamelift/api_op_ListAliases.go @@ -15,8 +15,7 @@ import ( // Retrieves all aliases for this Amazon Web Services account. You can filter the // result set by alias name and/or routing strategy type. Use the pagination // parameters to retrieve results in sequential pages. Returned aliases are not -// listed in any particular order. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// listed in any particular order. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -38,28 +37,24 @@ type ListAliasesInput struct { // get results as a set of sequential pages. Limit *int32 - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. + // A descriptive label that is associated with an alias. Alias names do not need + // to be unique. Name *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // The routing type to filter results on. Use this parameter to retrieve only // aliases with a certain routing type. To retrieve all aliases, leave this // parameter empty. Possible routing types include the following: - // - // * SIMPLE -- The - // alias resolves to one specific fleet. Use this type when routing to active - // fleets. - // - // * TERMINAL -- The alias does not resolve to a fleet but instead can be - // used to display a message to the user. A terminal alias throws a - // TerminalRoutingStrategyException with the RoutingStrategy - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html) - // message embedded. + // - SIMPLE -- The alias resolves to one specific fleet. Use this type when + // routing to active fleets. + // - TERMINAL -- The alias does not resolve to a fleet but instead can be used + // to display a message to the user. A terminal alias throws a + // TerminalRoutingStrategyException with the RoutingStrategy (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html) + // message embedded. RoutingStrategyType types.RoutingStrategyType noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListBuilds.go b/service/gamelift/api_op_ListBuilds.go index 4f2406476b0..bcd19c3c53a 100644 --- a/service/gamelift/api_op_ListBuilds.go +++ b/service/gamelift/api_op_ListBuilds.go @@ -12,14 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves build resources for all builds associated with the Amazon Web Services -// account in use. You can limit results to builds that are in a specific status by -// using the Status parameter. Use the pagination parameters to retrieve results in -// a set of sequential pages. Build resources are not listed in any particular -// order. Learn more Upload a Custom Server Build -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Retrieves build resources for all builds associated with the Amazon Web +// Services account in use. You can limit results to builds that are in a specific +// status by using the Status parameter. Use the pagination parameters to retrieve +// results in a set of sequential pages. Build resources are not listed in any +// particular order. Learn more Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) ListBuilds(ctx context.Context, params *ListBuildsInput, optFns ...func(*Options)) (*ListBuildsOutput, error) { if params == nil { params = &ListBuildsInput{} @@ -41,24 +39,20 @@ type ListBuildsInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // Build status to filter results by. To retrieve all builds, leave this parameter // empty. Possible build statuses include the following: - // - // * INITIALIZED -- A new - // build has been defined, but no files have been uploaded. You cannot create - // fleets for builds that are in this status. When a build is successfully created, - // the build status is set to this value. - // - // * READY -- The game build has been - // successfully uploaded. You can now create new fleets for this build. - // - // * FAILED - // -- The game build upload failed. You cannot create new fleets for this build. + // - INITIALIZED -- A new build has been defined, but no files have been + // uploaded. You cannot create fleets for builds that are in this status. When a + // build is successfully created, the build status is set to this value. + // - READY -- The game build has been successfully uploaded. You can now create + // new fleets for this build. + // - FAILED -- The game build upload failed. You cannot create new fleets for + // this build. Status types.BuildStatus noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListCompute.go b/service/gamelift/api_op_ListCompute.go index 886eda52181..16a65110d8a 100644 --- a/service/gamelift/api_op_ListCompute.go +++ b/service/gamelift/api_op_ListCompute.go @@ -43,9 +43,9 @@ type ListComputeInput struct { // The name of the custom location that the compute resources are assigned to. Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListFleets.go b/service/gamelift/api_op_ListFleets.go index a4eccd0a374..40c9401c932 100644 --- a/service/gamelift/api_op_ListFleets.go +++ b/service/gamelift/api_op_ListFleets.go @@ -14,29 +14,23 @@ import ( // Retrieves a collection of fleet resources in an Amazon Web Services Region. You // can call this operation to get fleets in a previously selected default Region // (see -// https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html -// (https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html)or -// specify a Region in your request. You can filter the result set to find only +// https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html (https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html) +// or specify a Region in your request. You can filter the result set to find only // those fleets that are deployed with a specific build or script. For fleets that // have multiple locations, this operation retrieves fleets based on their home // Region only. This operation can be used in the following ways: +// - To get a list of all fleets in a Region, don't provide a build or script +// identifier. +// - To get a list of all fleets where a specific custom game build is deployed, +// provide the build ID. +// - To get a list of all Realtime Servers fleets with a specific configuration +// script, provide the script ID. // -// * To get a list -// of all fleets in a Region, don't provide a build or script identifier. -// -// * To get -// a list of all fleets where a specific custom game build is deployed, provide the -// build ID. -// -// * To get a list of all Realtime Servers fleets with a specific -// configuration script, provide the script ID. -// -// Use the pagination parameters to -// retrieve results as a set of sequential pages. If successful, a list of fleet -// IDs that match the request parameters is returned. A NextToken value is also -// returned if there are more result pages to retrieve. Fleet resources are not -// listed in a particular order. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Use the pagination parameters to retrieve results as a set of sequential pages. +// If successful, a list of fleet IDs that match the request parameters is +// returned. A NextToken value is also returned if there are more result pages to +// retrieve. Fleet resources are not listed in a particular order. Learn more +// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error) { if params == nil { params = &ListFleetsInput{} @@ -63,9 +57,9 @@ type ListFleetsInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // A unique identifier for the Realtime script to request fleets for. Use this diff --git a/service/gamelift/api_op_ListGameServers.go b/service/gamelift/api_op_ListGameServers.go index 8490d411f4a..c5526416b77 100644 --- a/service/gamelift/api_op_ListGameServers.go +++ b/service/gamelift/api_op_ListGameServers.go @@ -16,8 +16,7 @@ import ( // groups. Retrieves information on all game servers that are currently active in a // specified game server group. You can opt to sort the list by game server age. // Use the pagination parameters to retrieve results in a set of sequential -// segments. Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// segments. Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) ListGameServers(ctx context.Context, params *ListGameServersInput, optFns ...func(*Options)) (*ListGameServersOutput, error) { if params == nil { params = &ListGameServersInput{} @@ -35,8 +34,8 @@ func (c *Client) ListGameServers(ctx context.Context, params *ListGameServersInp type ListGameServersInput struct { - // An identifier for the game server group to retrieve a list of game servers from. - // Use either the name or ARN value. + // An identifier for the game server group to retrieve a list of game servers + // from. Use either the name or ARN value. // // This member is required. GameServerGroupName *string @@ -45,9 +44,9 @@ type ListGameServersInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // Indicates how to sort the returned data based on game server registration diff --git a/service/gamelift/api_op_ListLocations.go b/service/gamelift/api_op_ListLocations.go index 264b5a025fc..5fe80b083df 100644 --- a/service/gamelift/api_op_ListLocations.go +++ b/service/gamelift/api_op_ListLocations.go @@ -37,9 +37,9 @@ type ListLocationsInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListScripts.go b/service/gamelift/api_op_ListScripts.go index fd3c5dcc73d..9ab45331e29 100644 --- a/service/gamelift/api_op_ListScripts.go +++ b/service/gamelift/api_op_ListScripts.go @@ -13,10 +13,8 @@ import ( ) // Retrieves script records for all Realtime scripts that are associated with the -// Amazon Web Services account in use. Learn more Amazon GameLift Realtime Servers -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Amazon Web Services account in use. Learn more Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) ListScripts(ctx context.Context, params *ListScriptsInput, optFns ...func(*Options)) (*ListScriptsOutput, error) { if params == nil { params = &ListScriptsInput{} @@ -38,9 +36,9 @@ type ListScriptsInput struct { // get results as a set of sequential pages. Limit *int32 - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListTagsForResource.go b/service/gamelift/api_op_ListTagsForResource.go index b7b507e2460..72cc294f1fc 100644 --- a/service/gamelift/api_op_ListTagsForResource.go +++ b/service/gamelift/api_op_ListTagsForResource.go @@ -15,30 +15,19 @@ import ( // used to organize Amazon Web Services resources for a range of purposes. This // operation handles the permissions necessary to manage tags for the following // GameLift resource types: +// - Build +// - Script +// - Fleet +// - Alias +// - GameSessionQueue +// - MatchmakingConfiguration +// - MatchmakingRuleSet // -// * Build -// -// * Script -// -// * Fleet -// -// * Alias -// -// * -// GameSessionQueue -// -// * MatchmakingConfiguration -// -// * MatchmakingRuleSet -// -// To list tags -// for a resource, specify the unique ARN value for the resource. Learn more -// Tagging Amazon Web Services Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference Amazon Web Services Tagging Strategies -// (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To list tags for a resource, specify the unique ARN value for the resource. +// Learn more Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference Amazon Web Services Tagging +// Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -56,12 +45,11 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to and uniquely identifies the GameLift resource that you want to - // retrieve tags for. GameLift resource ARNs are included in the data object for - // the resource, which can be retrieved by calling a List or Describe operation for - // the resource type. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to and uniquely identifies the GameLift resource that you + // want to retrieve tags for. GameLift resource ARNs are included in the data + // object for the resource, which can be retrieved by calling a List or Describe + // operation for the resource type. // // This member is required. ResourceARN *string diff --git a/service/gamelift/api_op_PutScalingPolicy.go b/service/gamelift/api_op_PutScalingPolicy.go index 3b1df2521c7..50fb186e683 100644 --- a/service/gamelift/api_op_PutScalingPolicy.go +++ b/service/gamelift/api_op_PutScalingPolicy.go @@ -23,9 +23,8 @@ import ( // policy, one or multiple rule-based scaling policies, or both. We recommend // caution, however, because multiple auto-scaling policies can have unintended // consequences. Learn more about how to work with auto-scaling in Set Up Fleet -// Automatic Scaling -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html). -// Target-based policy A target-based policy tracks a single metric: +// Automatic Scaling (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html) +// . Target-based policy A target-based policy tracks a single metric: // PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting // capacity is ready to host game sessions but is not currently in use. This is the // fleet's buffer; it measures the additional player demand that the fleet could @@ -51,11 +50,11 @@ import ( // a policy may make the following statement: "If the percentage of idle instances // is greater than 20% for more than 15 minutes, then reduce the fleet capacity by // 10%." A policy's rule statement has the following structure: If [MetricName] is -// [ComparisonOperator][Threshold] for [EvaluationPeriods] minutes, then -// [ScalingAdjustmentType] to/by [ScalingAdjustment]. To implement the example, the -// rule statement would look like this: If [PercentIdleInstances] is -// [GreaterThanThreshold][20] for [15] minutes, then [PercentChangeInCapacity] -// to/by [10]. To create or update a scaling policy, specify a unique combination +// [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then +// [ScalingAdjustmentType] to/by [ScalingAdjustment] . To implement the example, +// the rule statement would look like this: If [PercentIdleInstances] is +// [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] +// to/by [10] . To create or update a scaling policy, specify a unique combination // of name and fleet ID, and set the policy type to "RuleBased". Specify the // parameter values for a policy rule statement. On a successful request, the // policy name is returned. Scaling policies are automatically in force as soon as @@ -88,48 +87,30 @@ type PutScalingPolicyInput struct { // Name of the Amazon GameLift-defined metric that is used to trigger a scaling // adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon - // GameLift with Amazon CloudWatch - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html). - // - // * - // ActivatingGameSessions -- Game sessions in the process of being created. - // - // * - // ActiveGameSessions -- Game sessions that are currently running. - // - // * - // ActiveInstances -- Fleet instances that are currently running at least one game - // session. - // - // * AvailableGameSessions -- Additional game sessions that fleet could - // host simultaneously, given current capacity. - // - // * AvailablePlayerSessions -- Empty - // player slots in currently active game sessions. This includes game sessions that - // are not currently accepting players. Reserved player slots are not included. - // - // * - // CurrentPlayerSessions -- Player slots in active game sessions that are being - // used by a player or are reserved for a player. - // - // * IdleInstances -- Active - // instances that are currently hosting zero game sessions. - // - // * - // PercentAvailableGameSessions -- Unused percentage of the total number of game - // sessions that a fleet could host simultaneously, given current capacity. Use - // this metric for a target-based scaling policy. - // - // * PercentIdleInstances -- - // Percentage of the total number of active instances that are hosting zero game - // sessions. - // - // * QueueDepth -- Pending game session placement requests, in any - // queue, where the current fleet is the top-priority destination. - // - // * WaitTime -- - // Current wait time for pending game session placement requests, in any queue, - // where the current fleet is the top-priority destination. + // GameLift with Amazon CloudWatch (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html) + // . + // - ActivatingGameSessions -- Game sessions in the process of being created. + // - ActiveGameSessions -- Game sessions that are currently running. + // - ActiveInstances -- Fleet instances that are currently running at least one + // game session. + // - AvailableGameSessions -- Additional game sessions that fleet could host + // simultaneously, given current capacity. + // - AvailablePlayerSessions -- Empty player slots in currently active game + // sessions. This includes game sessions that are not currently accepting players. + // Reserved player slots are not included. + // - CurrentPlayerSessions -- Player slots in active game sessions that are + // being used by a player or are reserved for a player. + // - IdleInstances -- Active instances that are currently hosting zero game + // sessions. + // - PercentAvailableGameSessions -- Unused percentage of the total number of + // game sessions that a fleet could host simultaneously, given current capacity. + // Use this metric for a target-based scaling policy. + // - PercentIdleInstances -- Percentage of the total number of active instances + // that are hosting zero game sessions. + // - QueueDepth -- Pending game session placement requests, in any queue, where + // the current fleet is the top-priority destination. + // - WaitTime -- Current wait time for pending game session placement requests, + // in any queue, where the current fleet is the top-priority destination. // // This member is required. MetricName types.MetricName @@ -145,8 +126,8 @@ type PutScalingPolicyInput struct { // value. ComparisonOperator types.ComparisonOperatorType - // Length of time (in minutes) the metric must be at or beyond the threshold before - // a scaling event is triggered. + // Length of time (in minutes) the metric must be at or beyond the threshold + // before a scaling event is triggered. EvaluationPeriods *int32 // The type of scaling policy to create. For a target-based policy, set the @@ -160,19 +141,14 @@ type PutScalingPolicyInput struct { ScalingAdjustment int32 // The type of adjustment to make to a fleet's instance count: - // - // * ChangeInCapacity - // -- add (or subtract) the scaling adjustment value from the current instance - // count. Positive values scale up while negative values scale down. - // - // * - // ExactCapacity -- set the instance count to the scaling adjustment value. - // - // * - // PercentChangeInCapacity -- increase or reduce the current instance count by the - // scaling adjustment, read as a percentage. Positive values scale up while - // negative values scale down; for example, a value of "-10" scales the fleet down - // by 10%. + // - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the + // current instance count. Positive values scale up while negative values scale + // down. + // - ExactCapacity -- set the instance count to the scaling adjustment value. + // - PercentChangeInCapacity -- increase or reduce the current instance count by + // the scaling adjustment, read as a percentage. Positive values scale up while + // negative values scale down; for example, a value of "-10" scales the fleet down + // by 10%. ScalingAdjustmentType types.ScalingAdjustmentType // An object that contains settings for a target-based scaling policy. diff --git a/service/gamelift/api_op_RegisterCompute.go b/service/gamelift/api_op_RegisterCompute.go index 699d85b1a27..1546a13121f 100644 --- a/service/gamelift/api_op_RegisterCompute.go +++ b/service/gamelift/api_op_RegisterCompute.go @@ -15,14 +15,8 @@ import ( // register a compute to your fleet, you can monitor and manage your compute using // GameLift. The operation returns the compute resource containing SDK endpoint you // can use to connect your game server to GameLift. Learn more -// -// * Create an -// Anywhere fleet -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html) -// -// * -// Test your integration -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html) +// - Create an Anywhere fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html) +// - Test your integration (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html) func (c *Client) RegisterCompute(ctx context.Context, params *RegisterComputeInput, optFns ...func(*Options)) (*RegisterComputeOutput, error) { if params == nil { params = &RegisterComputeInput{} @@ -46,8 +40,8 @@ type RegisterComputeInput struct { // This member is required. ComputeName *string - // A unique identifier for the fleet to register the compute to. You can use either - // the fleet ID or ARN value. + // A unique identifier for the fleet to register the compute to. You can use + // either the fleet ID or ARN value. // // This member is required. FleetId *string diff --git a/service/gamelift/api_op_RegisterGameServer.go b/service/gamelift/api_op_RegisterGameServer.go index 6f53e64d064..89cb597f312 100644 --- a/service/gamelift/api_op_RegisterGameServer.go +++ b/service/gamelift/api_op_RegisterGameServer.go @@ -20,11 +20,10 @@ import ( // game session. To register a game server, identify the game server group and // instance where the game server is running, and provide a unique identifier for // the game server. You can also include connection and game server data. Once a -// game server is successfully registered, it is put in status AVAILABLE. A request -// to register a game server may fail if the instance it is running on is in the -// process of shutting down as part of instance balancing or scale-down activity. -// Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// game server is successfully registered, it is put in status AVAILABLE . A +// request to register a game server may fail if the instance it is running on is +// in the process of shutting down as part of instance balancing or scale-down +// activity. Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) RegisterGameServer(ctx context.Context, params *RegisterGameServerInput, optFns ...func(*Options)) (*RegisterGameServerOutput, error) { if params == nil { params = &RegisterGameServerInput{} @@ -54,9 +53,9 @@ type RegisterGameServerInput struct { // This member is required. GameServerId *string - // The unique identifier for the instance where the game server is running. This ID - // is available in the instance metadata. EC2 instance IDs use a 17-character - // format, for example: i-1234567890abcdef0. + // The unique identifier for the instance where the game server is running. This + // ID is available in the instance metadata. EC2 instance IDs use a 17-character + // format, for example: i-1234567890abcdef0 . // // This member is required. InstanceId *string @@ -66,9 +65,9 @@ type RegisterGameServerInput struct { // information. ConnectionInfo *string - // A set of custom game server properties, formatted as a single string value. This - // data is passed to a game client or service when it requests information on game - // servers. + // A set of custom game server properties, formatted as a single string value. + // This data is passed to a game client or service when it requests information on + // game servers. GameServerData *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_RequestUploadCredentials.go b/service/gamelift/api_op_RequestUploadCredentials.go index 78c2c5092d3..1bcced2def3 100644 --- a/service/gamelift/api_op_RequestUploadCredentials.go +++ b/service/gamelift/api_op_RequestUploadCredentials.go @@ -13,15 +13,12 @@ import ( // Retrieves a fresh set of credentials for use when uploading a new set of game // build files to Amazon GameLift's Amazon S3. This is done as part of the build -// creation process; see GameSession -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html). -// To request new credentials, specify the build ID as returned with an initial +// creation process; see GameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html) +// . To request new credentials, specify the build ID as returned with an initial // CreateBuild request. If successful, a new set of credentials are returned, along -// with the S3 storage location associated with the build ID. Learn more Create a -// Build with Files in S3 -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// with the S3 storage location associated with the build ID. Learn more Create a +// Build with Files in S3 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) RequestUploadCredentials(ctx context.Context, params *RequestUploadCredentialsInput, optFns ...func(*Options)) (*RequestUploadCredentialsOutput, error) { if params == nil { params = &RequestUploadCredentialsInput{} @@ -39,8 +36,8 @@ func (c *Client) RequestUploadCredentials(ctx context.Context, params *RequestUp type RequestUploadCredentialsInput struct { - // A unique identifier for the build to get credentials for. You can use either the - // build ID or ARN value. + // A unique identifier for the build to get credentials for. You can use either + // the build ID or ARN value. // // This member is required. BuildId *string diff --git a/service/gamelift/api_op_ResolveAlias.go b/service/gamelift/api_op_ResolveAlias.go index 2e6fa9f7244..aae014c1ab3 100644 --- a/service/gamelift/api_op_ResolveAlias.go +++ b/service/gamelift/api_op_ResolveAlias.go @@ -11,8 +11,7 @@ import ( ) // Retrieves the fleet ID that an alias is currently pointing to. Related actions -// All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) ResolveAlias(ctx context.Context, params *ResolveAliasInput, optFns ...func(*Options)) (*ResolveAliasOutput, error) { if params == nil { params = &ResolveAliasInput{} @@ -30,8 +29,8 @@ func (c *Client) ResolveAlias(ctx context.Context, params *ResolveAliasInput, op type ResolveAliasInput struct { - // The unique identifier of the alias that you want to retrieve a fleet ID for. You - // can use either the alias ID or ARN value. + // The unique identifier of the alias that you want to retrieve a fleet ID for. + // You can use either the alias ID or ARN value. // // This member is required. AliasId *string @@ -41,9 +40,8 @@ type ResolveAliasInput struct { type ResolveAliasOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift fleet resource that this alias points to. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift fleet resource that this alias points to. FleetArn *string // The fleet identifier that the alias is pointing to. diff --git a/service/gamelift/api_op_ResumeGameServerGroup.go b/service/gamelift/api_op_ResumeGameServerGroup.go index 0b0442eb76a..d69f2d8d95c 100644 --- a/service/gamelift/api_op_ResumeGameServerGroup.go +++ b/service/gamelift/api_op_ResumeGameServerGroup.go @@ -20,9 +20,8 @@ import ( // and status reason for more information on why group activity is suspended. To // resume activity, specify a game server group ARN and the type of activity to be // resumed. If successful, a GameServerGroup object is returned showing that the -// resumed activity is no longer listed in SuspendedActions. Learn more GameLift -// FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// resumed activity is no longer listed in SuspendedActions . Learn more GameLift +// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) ResumeGameServerGroup(ctx context.Context, params *ResumeGameServerGroupInput, optFns ...func(*Options)) (*ResumeGameServerGroupOutput, error) { if params == nil { params = &ResumeGameServerGroupInput{} diff --git a/service/gamelift/api_op_SearchGameSessions.go b/service/gamelift/api_op_SearchGameSessions.go index df2f7f5fb10..cef86b576b5 100644 --- a/service/gamelift/api_op_SearchGameSessions.go +++ b/service/gamelift/api_op_SearchGameSessions.go @@ -12,73 +12,56 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves all active game sessions that match a set of search criteria and sorts -// them into a specified order. This operation is not designed to be continually -// called to track game session status. This practice can cause you to exceed your -// API limit, which results in errors. Instead, you must configure configure an -// Amazon Simple Notification Service (SNS) topic to receive notifications from -// FlexMatch or queues. Continuously polling game session status with -// DescribeGameSessions should only be used for games in development with low game -// session usage. When searching for game sessions, you specify exactly where you -// want to search and provide a search filter expression, a sort expression, or +// Retrieves all active game sessions that match a set of search criteria and +// sorts them into a specified order. This operation is not designed to be +// continually called to track game session status. This practice can cause you to +// exceed your API limit, which results in errors. Instead, you must configure +// configure an Amazon Simple Notification Service (SNS) topic to receive +// notifications from FlexMatch or queues. Continuously polling game session status +// with DescribeGameSessions should only be used for games in development with low +// game session usage. When searching for game sessions, you specify exactly where +// you want to search and provide a search filter expression, a sort expression, or // both. A search request can search only one fleet, but it can search all of a // fleet's locations. This operation can be used in the following ways: +// - To search all game sessions that are currently running on all locations in +// a fleet, provide a fleet or alias ID. This approach returns game sessions in the +// fleet's home Region and all remote locations that fit the search criteria. +// - To search all game sessions that are currently running on a specific fleet +// location, provide a fleet or alias ID and a location name. For location, you can +// specify a fleet's home Region or any remote location. // -// * To -// search all game sessions that are currently running on all locations in a fleet, -// provide a fleet or alias ID. This approach returns game sessions in the fleet's -// home Region and all remote locations that fit the search criteria. -// -// * To search -// all game sessions that are currently running on a specific fleet location, -// provide a fleet or alias ID and a location name. For location, you can specify a -// fleet's home Region or any remote location. -// -// Use the pagination parameters to -// retrieve results as a set of sequential pages. If successful, a GameSession -// object is returned for each game session that matches the request. Search finds -// game sessions that are in ACTIVE status only. To retrieve information on game -// sessions in other statuses, use DescribeGameSessions -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) +// Use the pagination parameters to retrieve results as a set of sequential pages. +// If successful, a GameSession object is returned for each game session that +// matches the request. Search finds game sessions that are in ACTIVE status only. +// To retrieve information on game sessions in other statuses, use +// DescribeGameSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) // . You can search or sort by the following game session attributes: +// - gameSessionId -- A unique identifier for the game session. You can use +// either a GameSessionId or GameSessionArn value. +// - gameSessionName -- Name assigned to a game session. Game session names do +// not need to be unique to a game session. +// - gameSessionProperties -- Custom data defined in a game session's +// GameProperty parameter. GameProperty values are stored as key:value pairs; the +// filter expression must indicate the key and a string to search the data values +// for. For example, to search for game sessions with custom data containing the +// key:value pair "gameMode:brawl", specify the following: +// gameSessionProperties.gameMode = "brawl" . All custom data values are searched +// as strings. +// - maximumSessions -- Maximum number of player sessions allowed for a game +// session. +// - creationTimeMillis -- Value indicating when a game session was created. It +// is expressed in Unix time as milliseconds. +// - playerSessionCount -- Number of players currently connected to a game +// session. This value changes rapidly as players join the session or drop out. +// - hasAvailablePlayerSessions -- Boolean value indicating whether a game +// session has reached its maximum number of players. It is highly recommended that +// all search requests include this filter attribute to optimize search performance +// and return only sessions that players can join. // -// * -// gameSessionId -- A unique identifier for the game session. You can use either a -// GameSessionId or GameSessionArn value. -// -// * gameSessionName -- Name assigned to a -// game session. Game session names do not need to be unique to a game session. -// -// * -// gameSessionProperties -- Custom data defined in a game session's GameProperty -// parameter. GameProperty values are stored as key:value pairs; the filter -// expression must indicate the key and a string to search the data values for. For -// example, to search for game sessions with custom data containing the key:value -// pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = -// "brawl". All custom data values are searched as strings. -// -// * maximumSessions -- -// Maximum number of player sessions allowed for a game session. -// -// * -// creationTimeMillis -- Value indicating when a game session was created. It is -// expressed in Unix time as milliseconds. -// -// * playerSessionCount -- Number of -// players currently connected to a game session. This value changes rapidly as -// players join the session or drop out. -// -// * hasAvailablePlayerSessions -- Boolean -// value indicating whether a game session has reached its maximum number of -// players. It is highly recommended that all search requests include this filter -// attribute to optimize search performance and return only sessions that players -// can join. -// -// Returned values for playerSessionCount and hasAvailablePlayerSessions -// change quickly as players join sessions and others drop out. Results should be +// Returned values for playerSessionCount and hasAvailablePlayerSessions change +// quickly as players join sessions and others drop out. Results should be // considered a snapshot in time. Be sure to refresh search results often, and -// handle sessions that fill up before a player can join. All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// handle sessions that fill up before a player can join. All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) SearchGameSessions(ctx context.Context, params *SearchGameSessionsInput, optFns ...func(*Options)) (*SearchGameSessionsOutput, error) { if params == nil { params = &SearchGameSessionsInput{} @@ -96,51 +79,37 @@ func (c *Client) SearchGameSessions(ctx context.Context, params *SearchGameSessi type SearchGameSessionsInput struct { - // A unique identifier for the alias associated with the fleet to search for active - // game sessions. You can use either the alias ID or ARN value. Each request must - // reference either a fleet ID or alias ID, but not both. + // A unique identifier for the alias associated with the fleet to search for + // active game sessions. You can use either the alias ID or ARN value. Each request + // must reference either a fleet ID or alias ID, but not both. AliasId *string // String containing the search criteria for the session search. If no filter // expression is included, the request returns results for all game sessions in the - // fleet that are in ACTIVE status. A filter expression can contain one or multiple - // conditions. Each condition consists of the following: - // - // * Operand -- Name of a - // game session attribute. Valid values are gameSessionName, gameSessionId, - // gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, - // hasAvailablePlayerSessions. - // - // * Comparator -- Valid comparators are: =, <>, <, >, - // <=, >=. - // - // * Value -- Value to be searched for. Values may be numbers, boolean - // values (true/false) or strings depending on the operand. String values are case - // sensitive and must be enclosed in single quotes. Special characters must be - // escaped. Boolean and string values can only be used with the comparators = and - // <>. For example, the following filter expression searches on gameSessionName: - // "FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'". - // - // To chain - // multiple conditions in a single expression, use the logical keywords AND, OR, - // and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y). - // Session search evaluates conditions from left to right using the following - // precedence rules: - // - // * =, <>, <, >, <=, >= - // - // * Parentheses - // - // * NOT - // - // * AND - // - // * OR - // - // For - // example, this filter expression retrieves game sessions hosting at least ten - // players that have an open player slot: "maximumSessions>=10 AND - // hasAvailablePlayerSessions=true". + // fleet that are in ACTIVE status. A filter expression can contain one or + // multiple conditions. Each condition consists of the following: + // - Operand -- Name of a game session attribute. Valid values are + // gameSessionName , gameSessionId , gameSessionProperties , maximumSessions , + // creationTimeMillis , playerSessionCount , hasAvailablePlayerSessions . + // - Comparator -- Valid comparators are: = , <> , < , > , <= , >= . + // - Value -- Value to be searched for. Values may be numbers, boolean values + // (true/false) or strings depending on the operand. String values are case + // sensitive and must be enclosed in single quotes. Special characters must be + // escaped. Boolean and string values can only be used with the comparators = and + // <> . For example, the following filter expression searches on gameSessionName + // : " FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'" . + // To chain multiple conditions in a single expression, use the logical keywords + // AND , OR , and NOT and parentheses as needed. For example: x AND y AND NOT z , + // NOT (x OR y) . Session search evaluates conditions from left to right using the + // following precedence rules: + // - = , <> , < , > , <= , >= + // - Parentheses + // - NOT + // - AND + // - OR + // For example, this filter expression retrieves game sessions hosting at least + // ten players that have an open player slot: "maximumSessions>=10 AND + // hasAvailablePlayerSessions=true" . FilterExpression *string // A unique identifier for the fleet to search for active game sessions. You can @@ -155,29 +124,24 @@ type SearchGameSessionsInput struct { // A fleet location to search for game sessions. You can specify a fleet's home // Region or a remote location. Use the Amazon Web Services Region code format, - // such as us-west-2. + // such as us-west-2 . Location *string - // A token that indicates the start of the next sequential page of results. Use the - // token that is returned with a previous call to this operation. To start at the - // beginning of the result set, do not specify a value. + // A token that indicates the start of the next sequential page of results. Use + // the token that is returned with a previous call to this operation. To start at + // the beginning of the result set, do not specify a value. NextToken *string // Instructions on how to sort the search results. If no sort expression is // included, the request returns results in random order. A sort expression // consists of the following elements: - // - // * Operand -- Name of a game session - // attribute. Valid values are gameSessionName, gameSessionId, - // gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, - // hasAvailablePlayerSessions. - // - // * Order -- Valid sort orders are ASC (ascending) - // and DESC (descending). - // - // For example, this sort expression returns the oldest - // active sessions first: "SortExpression": "creationTimeMillis ASC". Results with - // a null value for the sort operand are returned at the end of the list. + // - Operand -- Name of a game session attribute. Valid values are + // gameSessionName , gameSessionId , gameSessionProperties , maximumSessions , + // creationTimeMillis , playerSessionCount , hasAvailablePlayerSessions . + // - Order -- Valid sort orders are ASC (ascending) and DESC (descending). + // For example, this sort expression returns the oldest active sessions first: + // "SortExpression": "creationTimeMillis ASC" . Results with a null value for the + // sort operand are returned at the end of the list. SortExpression *string noSmithyDocumentSerde @@ -185,8 +149,8 @@ type SearchGameSessionsInput struct { type SearchGameSessionsOutput struct { - // A collection of objects containing game session properties for each session that - // matches the request. + // A collection of objects containing game session properties for each session + // that matches the request. GameSessions []types.GameSession // A token that indicates where to resume retrieving results on the next call to diff --git a/service/gamelift/api_op_StartFleetActions.go b/service/gamelift/api_op_StartFleetActions.go index 9aef1857e5f..f602e28f2d7 100644 --- a/service/gamelift/api_op_StartFleetActions.go +++ b/service/gamelift/api_op_StartFleetActions.go @@ -12,25 +12,18 @@ import ( ) // Resumes certain types of activity on fleet instances that were suspended with -// StopFleetActions -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html). -// For multi-location fleets, fleet actions are managed separately for each +// StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html) +// . For multi-location fleets, fleet actions are managed separately for each // location. Currently, this operation is used to restart a fleet's auto-scaling // activity. This operation can be used in the following ways: +// - To restart actions on instances in the fleet's home Region, provide a fleet +// ID and the type of actions to resume. +// - To restart actions on instances in one of the fleet's remote locations, +// provide a fleet ID, a location name, and the type of actions to resume. // -// * To restart -// actions on instances in the fleet's home Region, provide a fleet ID and the type -// of actions to resume. -// -// * To restart actions on instances in one of the fleet's -// remote locations, provide a fleet ID, a location name, and the type of actions -// to resume. -// -// If successful, GameLift once again initiates scaling events as -// triggered by the fleet's scaling policies. If actions on the fleet location were -// never stopped, this operation will have no effect. Learn more Setting up -// GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// If successful, GameLift once again initiates scaling events as triggered by the +// fleet's scaling policies. If actions on the fleet location were never stopped, +// this operation will have no effect. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) StartFleetActions(ctx context.Context, params *StartFleetActionsInput, optFns ...func(*Options)) (*StartFleetActionsOutput, error) { if params == nil { params = &StartFleetActionsInput{} @@ -60,7 +53,7 @@ type StartFleetActionsInput struct { FleetId *string // The fleet location to restart fleet actions for. Specify a location in the form - // of an Amazon Web Services Region code, such as us-west-2. + // of an Amazon Web Services Region code, such as us-west-2 . Location *string noSmithyDocumentSerde @@ -68,11 +61,10 @@ type StartFleetActionsInput struct { type StartFleetActionsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet to restart actions on. diff --git a/service/gamelift/api_op_StartGameSessionPlacement.go b/service/gamelift/api_op_StartGameSessionPlacement.go index 2d14212450c..e5ad735d4be 100644 --- a/service/gamelift/api_op_StartGameSessionPlacement.go +++ b/service/gamelift/api_op_StartGameSessionPlacement.go @@ -27,26 +27,18 @@ import ( // data is provided for multiple players, Amazon GameLift calculates each Region's // average lag for all players and reorders to get the best game play across all // players. To place a new game session request, specify the following: +// - The queue name and a set of game session properties and settings +// - A unique ID (such as a UUID) for the placement. You use this ID to track +// the status of the placement request +// - (Optional) A set of player data and a unique player ID for each player that +// you are joining to the new game session (player data is optional, but if you +// include it, you must also provide a unique ID for each player) +// - Latency data for all players (if you want to optimize game play for the +// players) // -// * The -// queue name and a set of game session properties and settings -// -// * A unique ID -// (such as a UUID) for the placement. You use this ID to track the status of the -// placement request -// -// * (Optional) A set of player data and a unique player ID for -// each player that you are joining to the new game session (player data is -// optional, but if you include it, you must also provide a unique ID for each -// player) -// -// * Latency data for all players (if you want to optimize game play for -// the players) -// -// If successful, a new game session placement is created. To track -// the status of a placement request, call DescribeGameSessionPlacement -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html) -// and check the request's status. If the status is FULFILLED, a new game session +// If successful, a new game session placement is created. To track the status of +// a placement request, call DescribeGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html) +// and check the request's status. If the status is FULFILLED , a new game session // has been created and a game session ARN and Region are referenced. If the // placement request times out, you can resubmit the request or retry it with a // different queue. @@ -91,24 +83,24 @@ type StartGameSessionPlacementInput struct { // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameProperties []types.GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process in the GameSession object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // request to start a new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameSessionData *string - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. + // A descriptive label that is associated with a game session. Session names do + // not need to be unique. GameSessionName *string - // A set of values, expressed in milliseconds, that indicates the amount of latency - // that a player experiences when connected to Amazon Web Services Regions. This - // information is used to try to place the new game session where it can offer the - // best possible gameplay experience for the players. + // A set of values, expressed in milliseconds, that indicates the amount of + // latency that a player experiences when connected to Amazon Web Services Regions. + // This information is used to try to place the new game session where it can offer + // the best possible gameplay experience for the players. PlayerLatencies []types.PlayerLatency noSmithyDocumentSerde diff --git a/service/gamelift/api_op_StartMatchBackfill.go b/service/gamelift/api_op_StartMatchBackfill.go index 498f7d30d32..3a1945a5e74 100644 --- a/service/gamelift/api_op_StartMatchBackfill.go +++ b/service/gamelift/api_op_StartMatchBackfill.go @@ -21,12 +21,12 @@ import ( // client service by calling this operation with a GameSessions ID. You also have // the option of making backfill requests directly from your game server. In // response to a request, FlexMatch creates player sessions for the new players, -// updates the GameSession resource, and sends updated matchmaking data to the game -// server. You can request a backfill match at any point after a game session is -// started. Each game session can have only one active backfill request at a time; -// a subsequent request automatically replaces the earlier request. When using -// FlexMatch as a standalone component, request a backfill match by calling this -// operation without a game session identifier. As with newly formed matches, +// updates the GameSession resource, and sends updated matchmaking data to the +// game server. You can request a backfill match at any point after a game session +// is started. Each game session can have only one active backfill request at a +// time; a subsequent request automatically replaces the earlier request. When +// using FlexMatch as a standalone component, request a backfill match by calling +// this operation without a game session identifier. As with newly formed matches, // matchmaking results are returned in a matchmaking event so that your game can // update the game session that is being backfilled. To request a backfill match, // specify a unique ticket ID, the original matchmaking configuration, and @@ -35,12 +35,9 @@ import ( // is created and returned with status set to QUEUED. Track the status of backfill // tickets using the same method for tracking tickets for new matches. Only game // sessions created by FlexMatch are supported for match backfill. Learn more -// Backfill existing games with FlexMatch -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) -// Matchmaking events -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) -// (reference) How GameLift FlexMatch works -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// Backfill existing games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) +// Matchmaking events (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html) +// (reference) How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) func (c *Client) StartMatchBackfill(ctx context.Context, params *StartMatchBackfillInput, optFns ...func(*Options)) (*StartMatchBackfillOutput, error) { if params == nil { params = &StartMatchBackfillInput{} @@ -70,19 +67,15 @@ type StartMatchBackfillInput struct { // session. This information is used by the matchmaker to find new players and add // them to the existing game. You can include up to 199 Players in a // StartMatchBackfill request. - // - // * PlayerID, PlayerAttributes, Team -- This - // information is maintained in the GameSession object, MatchmakerData property, - // for all players who are currently assigned to the game session. The matchmaker - // data is in JSON syntax, formatted as a string. For more details, see Match Data - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data). - // The backfill request must specify the team membership for every player. Do not - // specify team if you are not using backfill. - // - // * LatencyInMs -- If the matchmaker - // uses player latency, include a latency value, in milliseconds, for the Region - // that the game session is currently in. Do not include latency values for any - // other Region. + // - PlayerID, PlayerAttributes, Team -- This information is maintained in the + // GameSession object, MatchmakerData property, for all players who are currently + // assigned to the game session. The matchmaker data is in JSON syntax, formatted + // as a string. For more details, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data) + // . The backfill request must specify the team membership for every player. Do not + // specify team if you are not using backfill. + // - LatencyInMs -- If the matchmaker uses player latency, include a latency + // value, in milliseconds, for the Region that the game session is currently in. Do + // not include latency values for any other Region. // // This member is required. Players []types.Player @@ -91,9 +84,9 @@ type StartMatchBackfillInput struct { // FlexMatch as a standalone matchmaking solution, this parameter is not needed. GameSessionArn *string - // A unique identifier for a matchmaking ticket. If no ticket ID is specified here, - // Amazon GameLift will generate one in the form of a UUID. Use this identifier to - // track the match backfill ticket status and retrieve match results. + // A unique identifier for a matchmaking ticket. If no ticket ID is specified + // here, Amazon GameLift will generate one in the form of a UUID. Use this + // identifier to track the match backfill ticket status and retrieve match results. TicketId *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_StartMatchmaking.go b/service/gamelift/api_op_StartMatchmaking.go index 729a73e106c..efc055976a9 100644 --- a/service/gamelift/api_op_StartMatchmaking.go +++ b/service/gamelift/api_op_StartMatchmaking.go @@ -22,16 +22,13 @@ import ( // specify a matchmaking configuration, and include the players to be matched. You // must also include any player attributes that are required by the matchmaking // configuration's rule set. If successful, a matchmaking ticket is returned with -// status set to QUEUED. Track matchmaking events to respond as needed and acquire +// status set to QUEUED . Track matchmaking events to respond as needed and acquire // game session connection information for successfully completed matches. Ticket // status updates are tracked using event notification through Amazon Simple // Notification Service, which is defined in the matchmaking configuration. Learn -// more Add FlexMatch to a game client -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) -// Set Up FlexMatch event notification -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) -// How GameLift FlexMatch works -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// more Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) +// Set Up FlexMatch event notification (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) +// How GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) func (c *Client) StartMatchmaking(ctx context.Context, params *StartMatchmakingInput, optFns ...func(*Options)) (*StartMatchmakingOutput, error) { if params == nil { params = &StartMatchmakingInput{} @@ -56,8 +53,8 @@ type StartMatchmakingInput struct { // This member is required. ConfigurationName *string - // Information on each player to be matched. This information must include a player - // ID, and may contain player attributes and latency data to be used in the + // Information on each player to be matched. This information must include a + // player ID, and may contain player attributes and latency data to be used in the // matchmaking process. After a successful match, Player objects contain the name // of the team the player is assigned to. You can include up to 10 Players in a // StartMatchmaking request. @@ -65,9 +62,9 @@ type StartMatchmakingInput struct { // This member is required. Players []types.Player - // A unique identifier for a matchmaking ticket. If no ticket ID is specified here, - // Amazon GameLift will generate one in the form of a UUID. Use this identifier to - // track the matchmaking ticket status and retrieve match results. + // A unique identifier for a matchmaking ticket. If no ticket ID is specified + // here, Amazon GameLift will generate one in the form of a UUID. Use this + // identifier to track the matchmaking ticket status and retrieve match results. TicketId *string noSmithyDocumentSerde @@ -75,9 +72,9 @@ type StartMatchmakingInput struct { type StartMatchmakingOutput struct { - // Ticket representing the matchmaking request. This object include the information - // included in the request, ticket status, and match results as generated during - // the matchmaking process. + // Ticket representing the matchmaking request. This object include the + // information included in the request, ticket status, and match results as + // generated during the matchmaking process. MatchmakingTicket *types.MatchmakingTicket // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_StopFleetActions.go b/service/gamelift/api_op_StopFleetActions.go index 7e054a5de73..4e746196f4d 100644 --- a/service/gamelift/api_op_StopFleetActions.go +++ b/service/gamelift/api_op_StopFleetActions.go @@ -17,21 +17,15 @@ import ( // has several potential purposes. It allows you to temporarily stop auto-scaling // activity but retain your scaling policies for use in the future. For // multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out -// of it for certain locations. This operation can be used in the following -// ways: +// of it for certain locations. This operation can be used in the following ways: +// - To stop actions on instances in the fleet's home Region, provide a fleet ID +// and the type of actions to suspend. +// - To stop actions on instances in one of the fleet's remote locations, +// provide a fleet ID, a location name, and the type of actions to suspend. // -// * To stop actions on instances in the fleet's home Region, provide a -// fleet ID and the type of actions to suspend. -// -// * To stop actions on instances in -// one of the fleet's remote locations, provide a fleet ID, a location name, and -// the type of actions to suspend. -// -// If successful, GameLift no longer initiates -// scaling events except in response to manual changes using UpdateFleetCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html). -// Learn more Setting up GameLift Fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// If successful, GameLift no longer initiates scaling events except in response +// to manual changes using UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) +// . Learn more Setting up GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) StopFleetActions(ctx context.Context, params *StopFleetActionsInput, optFns ...func(*Options)) (*StopFleetActionsOutput, error) { if params == nil { params = &StopFleetActionsInput{} @@ -61,7 +55,7 @@ type StopFleetActionsInput struct { FleetId *string // The fleet location to stop fleet actions for. Specify a location in the form of - // an Amazon Web Services Region code, such as us-west-2. + // an Amazon Web Services Region code, such as us-west-2 . Location *string noSmithyDocumentSerde @@ -69,11 +63,10 @@ type StopFleetActionsInput struct { type StopFleetActionsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet to stop actions on. diff --git a/service/gamelift/api_op_StopGameSessionPlacement.go b/service/gamelift/api_op_StopGameSessionPlacement.go index 1e55078bc73..d6ee796cbac 100644 --- a/service/gamelift/api_op_StopGameSessionPlacement.go +++ b/service/gamelift/api_op_StopGameSessionPlacement.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a game session placement that is in PENDING status. To stop a placement, -// provide the placement ID values. If successful, the placement is moved to -// CANCELLED status. +// Cancels a game session placement that is in PENDING status. To stop a +// placement, provide the placement ID values. If successful, the placement is +// moved to CANCELLED status. func (c *Client) StopGameSessionPlacement(ctx context.Context, params *StopGameSessionPlacementInput, optFns ...func(*Options)) (*StopGameSessionPlacementOutput, error) { if params == nil { params = &StopGameSessionPlacementInput{} @@ -41,8 +41,8 @@ type StopGameSessionPlacementInput struct { type StopGameSessionPlacementOutput struct { - // Object that describes the canceled game session placement, with CANCELLED status - // and an end time stamp. + // Object that describes the canceled game session placement, with CANCELLED + // status and an end time stamp. GameSessionPlacement *types.GameSessionPlacement // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_StopMatchmaking.go b/service/gamelift/api_op_StopMatchmaking.go index 3d752ecb24d..dec7f6af44b 100644 --- a/service/gamelift/api_op_StopMatchmaking.go +++ b/service/gamelift/api_op_StopMatchmaking.go @@ -13,14 +13,13 @@ import ( // Cancels a matchmaking ticket or match backfill ticket that is currently being // processed. To stop the matchmaking operation, specify the ticket ID. If // successful, work on the ticket is stopped, and the ticket status is changed to -// CANCELLED. This call is also used to turn off automatic backfill for an +// CANCELLED . This call is also used to turn off automatic backfill for an // individual game session. This is for game sessions that are created with a // matchmaking configuration that has automatic backfill enabled. The ticket ID is // included in the MatchmakerData of an updated game session object, which is // provided to the game server. If the operation is successful, the service sends // back an empty JSON struct with the HTTP 200 response (not an empty HTTP body). -// Learn more Add FlexMatch to a game client -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) +// Learn more Add FlexMatch to a game client (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html) func (c *Client) StopMatchmaking(ctx context.Context, params *StopMatchmakingInput, optFns ...func(*Options)) (*StopMatchmakingOutput, error) { if params == nil { params = &StopMatchmakingInput{} diff --git a/service/gamelift/api_op_SuspendGameServerGroup.go b/service/gamelift/api_op_SuspendGameServerGroup.go index 3cf73116378..d061a56a6c2 100644 --- a/service/gamelift/api_op_SuspendGameServerGroup.go +++ b/service/gamelift/api_op_SuspendGameServerGroup.go @@ -14,23 +14,20 @@ import ( // This operation is used with the GameLift FleetIQ solution and game server // groups. Temporarily stops activity on a game server group without terminating // instances or the game server group. You can restart activity by calling -// ResumeGameServerGroup. You can suspend the following activity: +// ResumeGameServerGroup . You can suspend the following activity: +// - Instance type replacement - This activity evaluates the current game +// hosting viability of all Spot instance types that are defined for the game +// server group. It updates the Auto Scaling group to remove nonviable Spot +// Instance types, which have a higher chance of game server interruptions. It then +// balances capacity across the remaining viable Spot Instance types. When this +// activity is suspended, the Auto Scaling group continues with its current +// balance, regardless of viability. Instance protection, utilization metrics, and +// capacity scaling activities continue to be active. // -// * Instance type -// replacement - This activity evaluates the current game hosting viability of all -// Spot instance types that are defined for the game server group. It updates the -// Auto Scaling group to remove nonviable Spot Instance types, which have a higher -// chance of game server interruptions. It then balances capacity across the -// remaining viable Spot Instance types. When this activity is suspended, the Auto -// Scaling group continues with its current balance, regardless of viability. -// Instance protection, utilization metrics, and capacity scaling activities -// continue to be active. -// -// To suspend activity, specify a game server group ARN and -// the type of activity to be suspended. If successful, a GameServerGroup object is -// returned showing that the activity is listed in SuspendedActions. Learn more -// GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// To suspend activity, specify a game server group ARN and the type of activity +// to be suspended. If successful, a GameServerGroup object is returned showing +// that the activity is listed in SuspendedActions . Learn more GameLift FleetIQ +// Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) SuspendGameServerGroup(ctx context.Context, params *SuspendGameServerGroupInput, optFns ...func(*Options)) (*SuspendGameServerGroupOutput, error) { if params == nil { params = &SuspendGameServerGroupInput{} diff --git a/service/gamelift/api_op_TagResource.go b/service/gamelift/api_op_TagResource.go index 08fb75beef8..d04c70d6853 100644 --- a/service/gamelift/api_op_TagResource.go +++ b/service/gamelift/api_op_TagResource.go @@ -15,34 +15,22 @@ import ( // an additional management tool set. You can use tags to organize resources, // create IAM permissions policies to manage access to groups of resources, // customize Amazon Web Services cost breakdowns, etc. This operation handles the -// permissions necessary to manage tags for the following GameLift resource -// types: +// permissions necessary to manage tags for the following GameLift resource types: +// - Build +// - Script +// - Fleet +// - Alias +// - GameSessionQueue +// - MatchmakingConfiguration +// - MatchmakingRuleSet // -// * Build -// -// * Script -// -// * Fleet -// -// * Alias -// -// * GameSessionQueue -// -// * -// MatchmakingConfiguration -// -// * MatchmakingRuleSet -// -// To add a tag to a resource, -// specify the unique ARN value for the resource and provide a tag list containing -// one or more tags. The operation succeeds even if the list includes tags that are -// already assigned to the specified resource. Learn more Tagging Amazon Web -// Services Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference Amazon Web Services Tagging Strategies -// (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To add a tag to a resource, specify the unique ARN value for the resource and +// provide a tag list containing one or more tags. The operation succeeds even if +// the list includes tags that are already assigned to the specified resource. +// Learn more Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference Amazon Web Services Tagging +// Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -60,21 +48,19 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to and uniquely identifies the GameLift resource that you want to - // assign tags to. GameLift resource ARNs are included in the data object for the - // resource, which can be retrieved by calling a List or Describe operation for the - // resource type. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to and uniquely identifies the GameLift resource that you + // want to assign tags to. GameLift resource ARNs are included in the data object + // for the resource, which can be retrieved by calling a List or Describe operation + // for the resource type. // // This member is required. ResourceARN *string // A list of one or more tags to assign to the specified GameLift resource. Tags // are developer-defined and structured as key-value pairs. The maximum tag limit - // may be lower than stated. See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for actual - // tagging limits. + // may be lower than stated. See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for actual tagging limits. // // This member is required. Tags []types.Tag diff --git a/service/gamelift/api_op_UntagResource.go b/service/gamelift/api_op_UntagResource.go index 7fcb9ab3615..6de4a41fa78 100644 --- a/service/gamelift/api_op_UntagResource.go +++ b/service/gamelift/api_op_UntagResource.go @@ -10,36 +10,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a tag that is assigned to a GameLift resource. Resource tags are used to -// organize Amazon Web Services resources for a range of purposes. This operation -// handles the permissions necessary to manage tags for the following GameLift -// resource types: +// Removes a tag that is assigned to a GameLift resource. Resource tags are used +// to organize Amazon Web Services resources for a range of purposes. This +// operation handles the permissions necessary to manage tags for the following +// GameLift resource types: +// - Build +// - Script +// - Fleet +// - Alias +// - GameSessionQueue +// - MatchmakingConfiguration +// - MatchmakingRuleSet // -// * Build -// -// * Script -// -// * Fleet -// -// * Alias -// -// * GameSessionQueue -// -// * -// MatchmakingConfiguration -// -// * MatchmakingRuleSet -// -// To remove a tag from a resource, -// specify the unique ARN value for the resource and provide a string list -// containing one or more tags to be removed. This operation succeeds even if the -// list includes tags that are not currently assigned to the specified resource. -// Learn more Tagging Amazon Web Services Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference Amazon Web Services Tagging Strategies -// (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// To remove a tag from a resource, specify the unique ARN value for the resource +// and provide a string list containing one or more tags to be removed. This +// operation succeeds even if the list includes tags that are not currently +// assigned to the specified resource. Learn more Tagging Amazon Web Services +// Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in +// the Amazon Web Services General Reference Amazon Web Services Tagging Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -57,12 +46,11 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to and uniquely identifies the GameLift resource that you want to - // remove tags from. GameLift resource ARNs are included in the data object for the - // resource, which can be retrieved by calling a List or Describe operation for the - // resource type. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to and uniquely identifies the GameLift resource that you + // want to remove tags from. GameLift resource ARNs are included in the data object + // for the resource, which can be retrieved by calling a List or Describe operation + // for the resource type. // // This member is required. ResourceARN *string diff --git a/service/gamelift/api_op_UpdateAlias.go b/service/gamelift/api_op_UpdateAlias.go index 76a111ec84d..988245352f0 100644 --- a/service/gamelift/api_op_UpdateAlias.go +++ b/service/gamelift/api_op_UpdateAlias.go @@ -14,8 +14,7 @@ import ( // Updates properties for an alias. To update properties, specify the alias ID to // be updated and provide the information to be changed. To reassign an alias to // another fleet, provide an updated routing strategy. If successful, the updated -// alias record is returned. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// alias record is returned. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optFns ...func(*Options)) (*UpdateAliasOutput, error) { if params == nil { params = &UpdateAliasInput{} @@ -42,8 +41,8 @@ type UpdateAliasInput struct { // A human-readable description of the alias. Description *string - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. + // A descriptive label that is associated with an alias. Alias names do not need + // to be unique. Name *string // The routing configuration, including routing type and fleet target, for the diff --git a/service/gamelift/api_op_UpdateBuild.go b/service/gamelift/api_op_UpdateBuild.go index 79c2cbec057..f3e8dc3fbc3 100644 --- a/service/gamelift/api_op_UpdateBuild.go +++ b/service/gamelift/api_op_UpdateBuild.go @@ -14,10 +14,8 @@ import ( // Updates metadata in a build resource, including the build name and version. To // update the metadata, specify the build ID to update and provide the new values. // If successful, a build object containing the updated metadata is returned. Learn -// more Upload a Custom Server Build -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html)All -// APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// more Upload a Custom Server Build (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html) +// All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) UpdateBuild(ctx context.Context, params *UpdateBuildInput, optFns ...func(*Options)) (*UpdateBuildOutput, error) { if params == nil { params = &UpdateBuildInput{} diff --git a/service/gamelift/api_op_UpdateFleetAttributes.go b/service/gamelift/api_op_UpdateFleetAttributes.go index 1655fa8184a..1ddf5190247 100644 --- a/service/gamelift/api_op_UpdateFleetAttributes.go +++ b/service/gamelift/api_op_UpdateFleetAttributes.go @@ -14,8 +14,7 @@ import ( // Updates a fleet's mutable attributes, including game session protection and // resource creation limits. To update fleet attributes, specify the fleet ID and // the property values that you want to change. If successful, an updated -// FleetAttributes object is returned. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// FleetAttributes object is returned. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) UpdateFleetAttributes(ctx context.Context, params *UpdateFleetAttributesInput, optFns ...func(*Options)) (*UpdateFleetAttributesOutput, error) { if params == nil { params = &UpdateFleetAttributesInput{} @@ -55,17 +54,14 @@ type UpdateFleetAttributesInput struct { // be unique. Name *string - // The game session protection policy to apply to all new instances created in this - // fleet. Instances that already exist are not affected. You can set protection for - // individual instances using UpdateGameSession - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) + // The game session protection policy to apply to all new instances created in + // this fleet. Instances that already exist are not affected. You can set + // protection for individual instances using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) // . - // - // * NoProtection -- The game session can be terminated during a scale-down - // event. - // - // * FullProtection -- If the game session is in an ACTIVE status, it - // cannot be terminated during a scale-down event. + // - NoProtection -- The game session can be terminated during a scale-down + // event. + // - FullProtection -- If the game session is in an ACTIVE status, it cannot be + // terminated during a scale-down event. NewGameSessionProtectionPolicy types.ProtectionPolicy // Policy settings that limit the number of game sessions an individual player can @@ -77,11 +73,10 @@ type UpdateFleetAttributesInput struct { type UpdateFleetAttributesOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that was updated. diff --git a/service/gamelift/api_op_UpdateFleetCapacity.go b/service/gamelift/api_op_UpdateFleetCapacity.go index bc2501c08ba..f836de68f83 100644 --- a/service/gamelift/api_op_UpdateFleetCapacity.go +++ b/service/gamelift/api_op_UpdateFleetCapacity.go @@ -15,42 +15,31 @@ import ( // capacity determines the number of game sessions and players that can be hosted // based on the fleet configuration. Use this operation to set the following fleet // capacity properties: -// -// * Minimum/maximum size: Set hard limits on fleet capacity. -// GameLift cannot set the fleet's capacity to a value outside of this range, -// whether the capacity is changed manually or through automatic scaling. -// -// * -// Desired capacity: Manually set the number of Amazon EC2 instances to be -// maintained in a fleet location. Before changing a fleet's desired capacity, you -// may want to call DescribeEC2InstanceLimits -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html) -// to get the maximum capacity of the fleet's Amazon EC2 instance type. -// Alternatively, consider using automatic scaling to adjust capacity based on -// player demand. +// - Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot +// set the fleet's capacity to a value outside of this range, whether the capacity +// is changed manually or through automatic scaling. +// - Desired capacity: Manually set the number of Amazon EC2 instances to be +// maintained in a fleet location. Before changing a fleet's desired capacity, you +// may want to call DescribeEC2InstanceLimits (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html) +// to get the maximum capacity of the fleet's Amazon EC2 instance type. +// Alternatively, consider using automatic scaling to adjust capacity based on +// player demand. // // This operation can be used in the following ways: +// - To update capacity for a fleet's home Region, or if the fleet has no remote +// locations, omit the Location parameter. The fleet must be in ACTIVE status. +// - To update capacity for a fleet's remote location, include the Location +// parameter set to the location to be updated. The location must be in ACTIVE +// status. // -// * To update -// capacity for a fleet's home Region, or if the fleet has no remote locations, -// omit the Location parameter. The fleet must be in ACTIVE status. -// -// * To update -// capacity for a fleet's remote location, include the Location parameter set to -// the location to be updated. The location must be in ACTIVE status. -// -// If -// successful, capacity settings are updated immediately. In response a change in -// desired capacity, GameLift initiates steps to start new instances or terminate -// existing instances in the requested fleet location. This continues until the -// location's active instance count matches the new desired instance count. You can -// track a fleet's current capacity by calling DescribeFleetCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) -// or DescribeFleetLocationCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html). -// If the requested desired instance count is higher than the instance type's -// limit, the LimitExceeded exception occurs. Learn more Scaling fleet capacity -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html) +// If successful, capacity settings are updated immediately. In response a change +// in desired capacity, GameLift initiates steps to start new instances or +// terminate existing instances in the requested fleet location. This continues +// until the location's active instance count matches the new desired instance +// count. You can track a fleet's current capacity by calling DescribeFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) +// or DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) +// . If the requested desired instance count is higher than the instance type's +// limit, the LimitExceeded exception occurs. Learn more Scaling fleet capacity (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html) func (c *Client) UpdateFleetCapacity(ctx context.Context, params *UpdateFleetCapacityInput, optFns ...func(*Options)) (*UpdateFleetCapacityOutput, error) { if params == nil { params = &UpdateFleetCapacityInput{} @@ -78,8 +67,8 @@ type UpdateFleetCapacityInput struct { // location. This value must fall between the minimum and maximum size limits. DesiredInstances *int32 - // The name of a remote location to update fleet capacity settings for, in the form - // of an Amazon Web Services Region code such as us-west-2. + // The name of a remote location to update fleet capacity settings for, in the + // form of an Amazon Web Services Region code such as us-west-2 . Location *string // The maximum number of instances that are allowed in the specified fleet @@ -95,18 +84,17 @@ type UpdateFleetCapacityInput struct { type UpdateFleetCapacityOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that was updated. FleetId *string // The remote location being updated, expressed as an Amazon Web Services Region - // code, such as us-west-2. + // code, such as us-west-2 . Location *string // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_UpdateFleetPortSettings.go b/service/gamelift/api_op_UpdateFleetPortSettings.go index 67ab7b1cec7..eb2e240a1e7 100644 --- a/service/gamelift/api_op_UpdateFleetPortSettings.go +++ b/service/gamelift/api_op_UpdateFleetPortSettings.go @@ -14,14 +14,13 @@ import ( // Updates permissions that allow inbound traffic to connect to game sessions that // are being hosted on instances in the fleet. To update settings, specify the // fleet ID to be updated and specify the changes to be made. List the permissions -// you want to add in InboundPermissionAuthorizations, and permissions you want to -// remove in InboundPermissionRevocations. Permissions to be removed must match +// you want to add in InboundPermissionAuthorizations , and permissions you want to +// remove in InboundPermissionRevocations . Permissions to be removed must match // existing fleet permissions. If successful, the fleet ID for the updated fleet is // returned. For fleets with remote locations, port setting updates can take time // to propagate across all locations. You can check the status of updates in each // location by calling DescribeFleetPortSettings with a location name. Learn more -// Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) UpdateFleetPortSettings(ctx context.Context, params *UpdateFleetPortSettingsInput, optFns ...func(*Options)) (*UpdateFleetPortSettingsOutput, error) { if params == nil { params = &UpdateFleetPortSettingsInput{} @@ -56,11 +55,10 @@ type UpdateFleetPortSettingsInput struct { type UpdateFleetPortSettingsOutput struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that was updated. diff --git a/service/gamelift/api_op_UpdateGameServer.go b/service/gamelift/api_op_UpdateGameServer.go index 85e030dabf5..92ffa3cf38d 100644 --- a/service/gamelift/api_op_UpdateGameServer.go +++ b/service/gamelift/api_op_UpdateGameServer.go @@ -17,26 +17,20 @@ import ( // server process that is running on an instance in a game server group. Use this // operation to update the following types of game server information. You can make // all three types of updates in the same request: -// -// * To update the game server's -// utilization status, identify the game server and game server group and specify -// the current utilization status. Use this status to identify when game servers -// are currently hosting games and when they are available to be claimed. -// -// * To -// report health status, identify the game server and game server group and set -// health check to HEALTHY. If a game server does not report health status for a -// certain length of time, the game server is no longer considered healthy. As a -// result, it will be eventually deregistered from the game server group to avoid -// affecting utilization metrics. The best practice is to report health every 60 -// seconds. -// -// * To change game server metadata, provide updated game server -// data. +// - To update the game server's utilization status, identify the game server +// and game server group and specify the current utilization status. Use this +// status to identify when game servers are currently hosting games and when they +// are available to be claimed. +// - To report health status, identify the game server and game server group and +// set health check to HEALTHY . If a game server does not report health status +// for a certain length of time, the game server is no longer considered healthy. +// As a result, it will be eventually deregistered from the game server group to +// avoid affecting utilization metrics. The best practice is to report health every +// 60 seconds. +// - To change game server metadata, provide updated game server data. // // Once a game server is successfully updated, the relevant statuses and -// timestamps are updated. Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// timestamps are updated. Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) UpdateGameServer(ctx context.Context, params *UpdateGameServerInput, optFns ...func(*Options)) (*UpdateGameServerOutput, error) { if params == nil { params = &UpdateGameServerInput{} @@ -64,9 +58,9 @@ type UpdateGameServerInput struct { // This member is required. GameServerId *string - // A set of custom game server properties, formatted as a single string value. This - // data is passed to a game client or service when it requests information on game - // servers. + // A set of custom game server properties, formatted as a single string value. + // This data is passed to a game client or service when it requests information on + // game servers. GameServerData *string // Indicates health status of the game server. A request that includes this diff --git a/service/gamelift/api_op_UpdateGameServerGroup.go b/service/gamelift/api_op_UpdateGameServerGroup.go index 45ecebc17b9..22936e8a8d4 100644 --- a/service/gamelift/api_op_UpdateGameServerGroup.go +++ b/service/gamelift/api_op_UpdateGameServerGroup.go @@ -19,8 +19,7 @@ import ( // specify the game server group ID and provide the updated values. Before applying // the updates, the new values are validated to ensure that GameLift FleetIQ can // continue to perform instance balancing activity. If successful, a -// GameServerGroup object is returned. Learn more GameLift FleetIQ Guide -// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// GameServerGroup object is returned. Learn more GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) func (c *Client) UpdateGameServerGroup(ctx context.Context, params *UpdateGameServerGroupInput, optFns ...func(*Options)) (*UpdateGameServerGroupOutput, error) { if params == nil { params = &UpdateGameServerGroupInput{} @@ -45,24 +44,19 @@ type UpdateGameServerGroupInput struct { // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand // Instances in the game server group. Method options include the following: - // - // * - // SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot - // Instances are unavailable or not viable for game hosting, the game server group - // provides no hosting capacity until Spot Instances can again be used. Until then, - // no new instances are started, and the existing nonviable Spot Instances are - // terminated (after current gameplay ends) and are not replaced. - // - // * SPOT_PREFERRED - // - (default value) Spot Instances are used whenever available in the game server - // group. If Spot Instances are unavailable, the game server group continues to - // provide hosting capacity by falling back to On-Demand Instances. Existing - // nonviable Spot Instances are terminated (after current gameplay ends) and are - // replaced with new On-Demand Instances. - // - // * ON_DEMAND_ONLY - Only On-Demand - // Instances are used in the game server group. No Spot Instances are used, even - // when available, while this balancing strategy is in force. + // - SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot + // Instances are unavailable or not viable for game hosting, the game server group + // provides no hosting capacity until Spot Instances can again be used. Until then, + // no new instances are started, and the existing nonviable Spot Instances are + // terminated (after current gameplay ends) and are not replaced. + // - SPOT_PREFERRED - (default value) Spot Instances are used whenever available + // in the game server group. If Spot Instances are unavailable, the game server + // group continues to provide hosting capacity by falling back to On-Demand + // Instances. Existing nonviable Spot Instances are terminated (after current + // gameplay ends) and are replaced with new On-Demand Instances. + // - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. + // No Spot Instances are used, even when available, while this balancing strategy + // is in force. BalancingStrategy types.BalancingStrategy // A flag that indicates whether instances in the game server group are protected @@ -79,19 +73,17 @@ type UpdateGameServerGroupInput struct { // The instance definitions must specify at least two different instance types that // are supported by GameLift FleetIQ. This updated list replaces the entire current // list of instance definitions for the game server group. For more information on - // instance types, see EC2 Instance Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. You can optionally specify capacity weighting for each - // instance type. If no weight value is specified for an instance type, it is set - // to the default value "1". For more information about capacity weighting, see - // Instance Weighting for Amazon EC2 Auto Scaling - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) + // instance types, see EC2 Instance Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. You can optionally specify capacity weighting for + // each instance type. If no weight value is specified for an instance type, it is + // set to the default value "1". For more information about capacity weighting, see + // Instance Weighting for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) // in the Amazon EC2 Auto Scaling User Guide. InstanceDefinitions []types.InstanceDefinition - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto + // Scaling groups. RoleArn *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_UpdateGameSession.go b/service/gamelift/api_op_UpdateGameSession.go index 86a595cab82..8e26a830eca 100644 --- a/service/gamelift/api_op_UpdateGameSession.go +++ b/service/gamelift/api_op_UpdateGameSession.go @@ -13,8 +13,7 @@ import ( // Updates the mutable properties of a game session. To update a game session, // specify the game session ID and the values you want to change. If successful, -// the updated GameSession object is returned. All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// the updated GameSession object is returned. All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) UpdateGameSession(ctx context.Context, params *UpdateGameSessionInput, optFns ...func(*Options)) (*UpdateGameSessionOutput, error) { if params == nil { params = &UpdateGameSessionInput{} @@ -41,21 +40,18 @@ type UpdateGameSessionInput struct { // session. MaximumPlayerSessionCount *int32 - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. + // A descriptive label that is associated with a game session. Session names do + // not need to be unique. Name *string // A policy that determines whether the game session is accepting new players. PlayerSessionCreationPolicy types.PlayerSessionCreationPolicy // Game session protection policy to apply to this game session only. - // - // * - // NoProtection -- The game session can be terminated during a scale-down event. - // - // * - // FullProtection -- If the game session is in an ACTIVE status, it cannot be - // terminated during a scale-down event. + // - NoProtection -- The game session can be terminated during a scale-down + // event. + // - FullProtection -- If the game session is in an ACTIVE status, it cannot be + // terminated during a scale-down event. ProtectionPolicy types.ProtectionPolicy noSmithyDocumentSerde diff --git a/service/gamelift/api_op_UpdateGameSessionQueue.go b/service/gamelift/api_op_UpdateGameSessionQueue.go index 9a37ce2af66..00d50353e8d 100644 --- a/service/gamelift/api_op_UpdateGameSessionQueue.go +++ b/service/gamelift/api_op_UpdateGameSessionQueue.go @@ -14,8 +14,7 @@ import ( // Updates the configuration of a game session queue, which determines how the // queue processes new game session requests. To update settings, specify the queue // name to be updated and provide the new settings. When updating destinations, -// provide a complete list of destinations. Learn more Using Multi-Region Queues -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) +// provide a complete list of destinations. Learn more Using Multi-Region Queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) func (c *Client) UpdateGameSessionQueue(ctx context.Context, params *UpdateGameSessionQueueInput, optFns ...func(*Options)) (*UpdateGameSessionQueueOutput, error) { if params == nil { params = &UpdateGameSessionQueueInput{} @@ -33,8 +32,8 @@ func (c *Client) UpdateGameSessionQueue(ctx context.Context, params *UpdateGameS type UpdateGameSessionQueueInput struct { - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. You can use either the queue ID or ARN value. + // A descriptive label that is associated with game session queue. Queue names + // must be unique within each Region. You can use either the queue ID or ARN value. // // This member is required. Name *string @@ -51,14 +50,14 @@ type UpdateGameSessionQueueInput struct { // A list of locations where a queue is allowed to place new game sessions. // Locations are specified in the form of Amazon Web Services Region codes, such as - // us-west-2. If this parameter is not set, game sessions can be placed in any + // us-west-2 . If this parameter is not set, game sessions can be placed in any // queue location. To remove an existing filter configuration, pass in an empty // set. FilterConfiguration *types.FilterConfiguration - // An SNS topic ARN that is set up to receive game session placement notifications. - // See Setting up notifications for game session placement - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html). + // An SNS topic ARN that is set up to receive game session placement + // notifications. See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) + // . NotificationTarget *string // A set of policies that act as a sliding cap on player latency. FleetIQ works to diff --git a/service/gamelift/api_op_UpdateMatchmakingConfiguration.go b/service/gamelift/api_op_UpdateMatchmakingConfiguration.go index 660760f889f..4ee8c8b8033 100644 --- a/service/gamelift/api_op_UpdateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_UpdateMatchmakingConfiguration.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates settings for a FlexMatch matchmaking configuration. These changes affect -// all matches and game sessions that are created after the update. To update -// settings, specify the configuration name to be updated and provide the new -// settings. Learn more Design a FlexMatch matchmaker -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) +// Updates settings for a FlexMatch matchmaking configuration. These changes +// affect all matches and game sessions that are created after the update. To +// update settings, specify the configuration name to be updated and provide the +// new settings. Learn more Design a FlexMatch matchmaker (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html) func (c *Client) UpdateMatchmakingConfiguration(ctx context.Context, params *UpdateMatchmakingConfigurationInput, optFns ...func(*Options)) (*UpdateMatchmakingConfigurationOutput, error) { if params == nil { params = &UpdateMatchmakingConfigurationInput{} @@ -53,17 +52,16 @@ type UpdateMatchmakingConfigurationInput struct { // example, if the configuration's rule set specifies a match for a single // 12-person team, and the additional player count is set to 2, only 10 players are // selected for the match. This parameter is not used if FlexMatchMode is set to - // STANDALONE. + // STANDALONE . AdditionalPlayerCount *int32 // The method that is used to backfill game sessions created with this matchmaking // configuration. Specify MANUAL when your game manages backfill requests manually // or does not use the match backfill feature. Specify AUTOMATIC to have GameLift // create a match backfill request whenever a game session has one or more open - // slots. Learn more about manual and automatic backfill in Backfill Existing Games - // with FlexMatch - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). - // Automatic backfill is not available when FlexMatchMode is set to STANDALONE. + // slots. Learn more about manual and automatic backfill in Backfill Existing + // Games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) + // . Automatic backfill is not available when FlexMatchMode is set to STANDALONE . BackfillMode types.BackfillMode // Information to add to all events related to the matchmaking configuration. @@ -74,47 +72,40 @@ type UpdateMatchmakingConfigurationInput struct { // Indicates whether this matchmaking configuration is being used with GameLift // hosting or as a standalone matchmaking solution. - // - // * STANDALONE - FlexMatch forms - // matches and returns match information, including players and team assignments, - // in a MatchmakingSucceeded - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) - // event. - // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift - // queue to start a game session for the match. + // - STANDALONE - FlexMatch forms matches and returns match information, + // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) + // event. + // - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue + // to start a game session for the match. FlexMatchMode types.FlexMatchMode // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession object that is created for a - // successful match. This parameter is not used if FlexMatchMode is set to - // STANDALONE. + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the new GameSession object that is created for + // a successful match. This parameter is not used if FlexMatchMode is set to + // STANDALONE . GameProperties []types.GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process with a request to start a new game - // session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the game session that is created for a successful - // match. This parameter is not used if FlexMatchMode is set to STANDALONE. + // session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the game session that is created for a + // successful match. This parameter is not used if FlexMatchMode is set to + // STANDALONE . GameSessionData *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift game session queue resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::gamesessionqueue/ . Queues can be located in any Region. // Queues are used to start new GameLift-hosted game sessions for matches that are // created with this matchmaking configuration. If FlexMatchMode is set to - // STANDALONE, do not set this parameter. + // STANDALONE , do not set this parameter. GameSessionQueueArns []string // An SNS topic ARN that is set up to receive matchmaking notifications. See - // Setting up notifications for matchmaking - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) + // Setting up notifications for matchmaking (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html) // for more information. NotificationTarget *string @@ -123,9 +114,9 @@ type UpdateMatchmakingConfigurationInput struct { // resubmitted as needed. RequestTimeoutSeconds *int32 - // A unique identifier for the matchmaking rule set to use with this configuration. - // You can use either the rule set name or ARN value. A matchmaking configuration - // can only use rule sets that are defined in the same Region. + // A unique identifier for the matchmaking rule set to use with this + // configuration. You can use either the rule set name or ARN value. A matchmaking + // configuration can only use rule sets that are defined in the same Region. RuleSetName *string noSmithyDocumentSerde diff --git a/service/gamelift/api_op_UpdateRuntimeConfiguration.go b/service/gamelift/api_op_UpdateRuntimeConfiguration.go index e8bb2034146..c93f9cf9fa8 100644 --- a/service/gamelift/api_op_UpdateRuntimeConfiguration.go +++ b/service/gamelift/api_op_UpdateRuntimeConfiguration.go @@ -21,8 +21,7 @@ import ( // retrieves updated runtime configurations. Instances immediately begin complying // with the new configuration by launching new server processes or not replacing // existing processes when they shut down. Updating a fleet's runtime configuration -// never affects existing server processes. Learn more Setting up GameLift fleets -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// never affects existing server processes. Learn more Setting up GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) func (c *Client) UpdateRuntimeConfiguration(ctx context.Context, params *UpdateRuntimeConfigurationInput, optFns ...func(*Options)) (*UpdateRuntimeConfigurationOutput, error) { if params == nil { params = &UpdateRuntimeConfigurationInput{} @@ -60,8 +59,8 @@ type UpdateRuntimeConfigurationInput struct { type UpdateRuntimeConfigurationOutput struct { - // The runtime configuration currently in use by all instances in the fleet. If the - // update was successful, all property changes are shown. + // The runtime configuration currently in use by all instances in the fleet. If + // the update was successful, all property changes are shown. RuntimeConfiguration *types.RuntimeConfiguration // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_UpdateScript.go b/service/gamelift/api_op_UpdateScript.go index 8a32d7bd340..bfc17f199b6 100644 --- a/service/gamelift/api_op_UpdateScript.go +++ b/service/gamelift/api_op_UpdateScript.go @@ -11,18 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates Realtime script metadata and content. To update script metadata, specify -// the script ID and provide updated name and/or version values. To update script -// content, provide an updated zip file by pointing to either a local file or an -// Amazon S3 bucket location. You can use either method regardless of how the +// Updates Realtime script metadata and content. To update script metadata, +// specify the script ID and provide updated name and/or version values. To update +// script content, provide an updated zip file by pointing to either a local file +// or an Amazon S3 bucket location. You can use either method regardless of how the // original script was uploaded. Use the Version parameter to track updates to the // script. If the call is successful, the updated metadata is stored in the script // record and a revised script is uploaded to the Amazon GameLift service. Once the // script is updated and acquired by a fleet instance, the new version is used for -// all new game sessions. Learn more Amazon GameLift Realtime Servers -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// all new game sessions. Learn more Amazon GameLift Realtime Servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) func (c *Client) UpdateScript(ctx context.Context, params *UpdateScriptInput, optFns ...func(*Options)) (*UpdateScriptOutput, error) { if params == nil { params = &UpdateScriptInput{} @@ -69,7 +67,7 @@ type UpdateScriptInput struct { // When using the Amazon Web Services CLI tool to create a script, this parameter // is set to the zip file name. It must be prepended with the string "fileb://" to // indicate that the file data is a binary object. For example: --zip-file - // fileb://myRealtimeScript.zip. + // fileb://myRealtimeScript.zip . ZipFile []byte noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ValidateMatchmakingRuleSet.go b/service/gamelift/api_op_ValidateMatchmakingRuleSet.go index eb597e0a85d..d8f70678d1b 100644 --- a/service/gamelift/api_op_ValidateMatchmakingRuleSet.go +++ b/service/gamelift/api_op_ValidateMatchmakingRuleSet.go @@ -14,9 +14,7 @@ import ( // that the rule set is using syntactically correct JSON and that it conforms to // allowed property expressions. To validate syntax, provide a rule set JSON // string. Learn more -// -// * Build a rule set -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) +// - Build a rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) func (c *Client) ValidateMatchmakingRuleSet(ctx context.Context, params *ValidateMatchmakingRuleSetInput, optFns ...func(*Options)) (*ValidateMatchmakingRuleSetOutput, error) { if params == nil { params = &ValidateMatchmakingRuleSetInput{} diff --git a/service/gamelift/doc.go b/service/gamelift/doc.go index 67808ffe9c9..3deb1f00500 100644 --- a/service/gamelift/doc.go +++ b/service/gamelift/doc.go @@ -9,45 +9,33 @@ // helps you deliver high-performance, high-reliability, low-cost game servers // while dynamically scaling your resource usage to meet player demand. About // GameLift solutions Get more information on these GameLift solutions in the -// GameLift Developer Guide -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/). -// -// * GameLift -// managed hosting -- GameLift offers a fully managed service to set up and -// maintain computing machines for hosting, manage game session and player session -// life cycle, and handle security, storage, and performance tracking. You can use -// automatic scaling tools to balance player demand and hosting costs, configure -// your game session management to minimize player latency, and add FlexMatch for -// matchmaking. -// -// * Managed hosting with Realtime Servers -- With GameLift Realtime -// Servers, you can quickly configure and set up ready-to-go game servers for your -// game. Realtime Servers provides a game server framework with core GameLift -// infrastructure already built in. Then use the full range of GameLift managed -// hosting features, including FlexMatch, for your game. -// -// * GameLift FleetIQ -- Use -// GameLift FleetIQ as a standalone service while hosting your games using EC2 -// instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for -// game hosting, including boosting the viability of low-cost Spot Instances -// gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch -// standalone services. -// -// * GameLift FlexMatch -- Add matchmaking to your game -// hosting solution. FlexMatch is a customizable matchmaking service for -// multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or -// incorporate FlexMatch as a standalone service into your own hosting -// solution. -// -// About this API Reference This reference guide describes the low-level -// service API for Amazon GameLift. With each topic in this guide, you can find -// links to language-specific SDK guides and the Amazon Web Services CLI reference. -// Useful links: -// -// * GameLift API operations listed by tasks -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html) -// -// * -// GameLift tools and resources -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html) +// GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/) +// . +// - GameLift managed hosting -- GameLift offers a fully managed service to set +// up and maintain computing machines for hosting, manage game session and player +// session life cycle, and handle security, storage, and performance tracking. You +// can use automatic scaling tools to balance player demand and hosting costs, +// configure your game session management to minimize player latency, and add +// FlexMatch for matchmaking. +// - Managed hosting with Realtime Servers -- With GameLift Realtime Servers, +// you can quickly configure and set up ready-to-go game servers for your game. +// Realtime Servers provides a game server framework with core GameLift +// infrastructure already built in. Then use the full range of GameLift managed +// hosting features, including FlexMatch, for your game. +// - GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while +// hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ +// provides optimizations for game hosting, including boosting the viability of +// low-cost Spot Instances gaming. For a complete solution, pair the GameLift +// FleetIQ and FlexMatch standalone services. +// - GameLift FlexMatch -- Add matchmaking to your game hosting solution. +// FlexMatch is a customizable matchmaking service for multiplayer games. Use +// FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch +// as a standalone service into your own hosting solution. +// +// About this API Reference This reference guide describes the low-level service +// API for Amazon GameLift. With each topic in this guide, you can find links to +// language-specific SDK guides and the Amazon Web Services CLI reference. Useful +// links: +// - GameLift API operations listed by tasks (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html) +// - GameLift tools and resources (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html) package gamelift diff --git a/service/gamelift/types/enums.go b/service/gamelift/types/enums.go index f54fe0e6afe..bef6211c470 100644 --- a/service/gamelift/types/enums.go +++ b/service/gamelift/types/enums.go @@ -28,9 +28,9 @@ const ( BackfillModeManual BackfillMode = "MANUAL" ) -// Values returns all known values for BackfillMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BackfillMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BackfillMode) Values() []BackfillMode { return []BackfillMode{ "AUTOMATIC", @@ -438,9 +438,9 @@ const ( EventCodeInstanceRecycled EventCode = "INSTANCE_RECYCLED" ) -// Values returns all known values for EventCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventCode) Values() []EventCode { return []EventCode{ "GENERIC_EVENT", @@ -538,9 +538,9 @@ const ( FleetTypeSpot FleetType = "SPOT" ) -// Values returns all known values for FleetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FleetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FleetType) Values() []FleetType { return []FleetType{ "ON_DEMAND", @@ -573,8 +573,8 @@ const ( GameServerClaimStatusClaimed GameServerClaimStatus = "CLAIMED" ) -// Values returns all known values for GameServerClaimStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GameServerClaimStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GameServerClaimStatus) Values() []GameServerClaimStatus { return []GameServerClaimStatus{ @@ -589,8 +589,8 @@ const ( GameServerGroupActionReplaceInstanceTypes GameServerGroupAction = "REPLACE_INSTANCE_TYPES" ) -// Values returns all known values for GameServerGroupAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GameServerGroupAction. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GameServerGroupAction) Values() []GameServerGroupAction { return []GameServerGroupAction{ @@ -821,8 +821,8 @@ const ( GameServerGroupStatusError GameServerGroupStatus = "ERROR" ) -// Values returns all known values for GameServerGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GameServerGroupStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GameServerGroupStatus) Values() []GameServerGroupStatus { return []GameServerGroupStatus{ @@ -843,8 +843,8 @@ const ( GameServerHealthCheckHealthy GameServerHealthCheck = "HEALTHY" ) -// Values returns all known values for GameServerHealthCheck. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GameServerHealthCheck. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GameServerHealthCheck) Values() []GameServerHealthCheck { return []GameServerHealthCheck{ @@ -861,9 +861,9 @@ const ( GameServerInstanceStatusSpotTerminating GameServerInstanceStatus = "SPOT_TERMINATING" ) -// Values returns all known values for GameServerInstanceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for GameServerInstanceStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (GameServerInstanceStatus) Values() []GameServerInstanceStatus { return []GameServerInstanceStatus{ "ACTIVE", @@ -1201,9 +1201,9 @@ const ( PriorityTypeLocation PriorityType = "LOCATION" ) -// Values returns all known values for PriorityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PriorityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PriorityType) Values() []PriorityType { return []PriorityType{ "LATENCY", @@ -1258,8 +1258,8 @@ const ( ScalingAdjustmentTypePercentChangeInCapacity ScalingAdjustmentType = "PercentChangeInCapacity" ) -// Values returns all known values for ScalingAdjustmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ScalingAdjustmentType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ScalingAdjustmentType) Values() []ScalingAdjustmentType { return []ScalingAdjustmentType{ @@ -1305,9 +1305,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/gamelift/types/types.go b/service/gamelift/types/types.go index 96ab7579de6..36693b8ae42 100644 --- a/service/gamelift/types/types.go +++ b/service/gamelift/types/types.go @@ -7,15 +7,13 @@ import ( "time" ) -// Properties that describe an alias resource. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Properties that describe an alias resource. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Alias struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift alias resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a // GameLift alias ARN, the resource ID matches the alias ID value. AliasArn *string @@ -23,18 +21,18 @@ type Alias struct { AliasId *string // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A human-readable description of an alias. Description *string // The time that this data object was last modified. Format is a number expressed - // in Unix time as milliseconds (for example "1469498468.057"). + // in Unix time as milliseconds (for example "1469498468.057" ). LastUpdatedTime *time.Time - // A descriptive label that is associated with an alias. Alias names do not need to - // be unique. + // A descriptive label that is associated with an alias. Alias names do not need + // to be unique. Name *string // The routing configuration, including routing type and fleet target, for the @@ -48,9 +46,9 @@ type Alias struct { type AnywhereConfiguration struct { // The cost to run your fleet per hour. GameLift uses the provided cost of your - // fleet to balance usage in queues. For more information about queues, see Setting - // up queues - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html). + // fleet to balance usage in queues. For more information about queues, see + // Setting up queues (https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) + // . // // This member is required. Cost *string @@ -58,10 +56,10 @@ type AnywhereConfiguration struct { noSmithyDocumentSerde } -// Values for use in player attribute key-value pairs. This object lets you specify -// an attribute value using any of the valid data types: string, number, string -// array, or data map. Each AttributeValue object can use only one of the available -// properties. +// Values for use in player attribute key-value pairs. This object lets you +// specify an attribute value using any of the valid data types: string, number, +// string array, or data map. Each AttributeValue object can use only one of the +// available properties. type AttributeValue struct { // For number values, expressed as double. @@ -84,8 +82,8 @@ type AttributeValue struct { // Temporary access credentials used for uploading game build files to Amazon // GameLift. They are valid for a limited time. If they expire before you upload -// your game build, get a new set by calling RequestUploadCredentials -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html). +// your game build, get a new set by calling RequestUploadCredentials (https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html) +// . type AwsCredentials struct { // Temporary key allowing access to the Amazon GameLift S3 account. @@ -101,15 +99,13 @@ type AwsCredentials struct { noSmithyDocumentSerde } -// Properties describing a custom game build. All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Properties describing a custom game build. All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Build struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) assigned - // to a GameLift build resource and uniquely identifies it. ARNs are unique across - // all Regions. Format is - // arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) assigned to a GameLift build resource and uniquely identifies it. ARNs are + // unique across all Regions. Format is + // arn:aws:gamelift:::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a // GameLift build ARN, the resource ID matches the BuildId value. BuildArn *string @@ -117,14 +113,13 @@ type Build struct { BuildId *string // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A descriptive label associated with a build. Build names do not need to be - // unique. It can be set using CreateBuild - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html) - // or UpdateBuild - // (https://docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild). + // unique. It can be set using CreateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html) + // or UpdateBuild (https://docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild) + // . Name *string // Operating system that the game server binaries are built to run on. This value @@ -140,18 +135,13 @@ type Build struct { SizeOnDisk *int64 // Current status of the build. Possible build statuses include the following: - // - // * - // INITIALIZED -- A new build has been defined, but no files have been uploaded. - // You cannot create fleets for builds that are in this status. When a build is - // successfully created, the build status is set to this value. - // - // * READY -- The - // game build has been successfully uploaded. You can now create new fleets for - // this build. - // - // * FAILED -- The game build upload failed. You cannot create new - // fleets for this build. + // - INITIALIZED -- A new build has been defined, but no files have been + // uploaded. You cannot create fleets for builds that are in this status. When a + // build is successfully created, the build status is set to this value. + // - READY -- The game build has been successfully uploaded. You can now create + // new fleets for this build. + // - FAILED -- The game build upload failed. You cannot create new fleets for + // this build. Status BuildStatus // Version information associated with a build or script. Version strings do not @@ -163,18 +153,14 @@ type Build struct { // Determines whether a TLS/SSL certificate is generated for a fleet. This feature // must be enabled when creating the fleet. All instances in a fleet share the same -// certificate. The certificate can be retrieved by calling the GameLift Server SDK -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) -// operation GetInstanceCertificate. +// certificate. The certificate can be retrieved by calling the GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) +// operation GetInstanceCertificate . type CertificateConfiguration struct { // Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values // include: - // - // * GENERATED - Generate a TLS/SSL certificate for this fleet. - // - // * - // DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet. + // - GENERATED - Generate a TLS/SSL certificate for this fleet. + // - DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet. // // This member is required. CertificateType CertificateType @@ -194,12 +180,12 @@ type Compute struct { // your fleet. ComputeName *string - // Current status of the compute. A compute must have an ACTIVE status to host game - // sessions. + // Current status of the compute. A compute must have an ACTIVE status to host + // game sessions. ComputeStatus ComputeStatus // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // The DNS name of the compute resource. GameLift requires the DNS name or IP @@ -299,7 +285,7 @@ type EC2InstanceLimit struct { // location. InstanceLimit *int32 - // An Amazon Web Services Region code, such as us-west-2. + // An Amazon Web Services Region code, such as us-west-2 . Location *string noSmithyDocumentSerde @@ -311,184 +297,125 @@ type EC2InstanceLimit struct { type Event struct { // The type of event being logged. Fleet state transition events: - // - // * FLEET_CREATED - // -- A fleet resource was successfully created with a status of NEW. Event - // messaging includes the fleet ID. - // - // * FLEET_STATE_DOWNLOADING -- Fleet status - // changed from NEW to DOWNLOADING. The compressed build has started downloading to - // a fleet instance for installation. - // - // * FLEET_STATE_VALIDATING -- Fleet status - // changed from DOWNLOADING to VALIDATING. GameLift has successfully downloaded the - // build and is now validating the build files. - // - // * FLEET_STATE_BUILDING -- Fleet - // status changed from VALIDATING to BUILDING. GameLift has successfully verified - // the build files and is now running the installation scripts. - // - // * - // FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING. - // GameLift is trying to launch an instance and test the connectivity between the - // build and the GameLift Service via the Server SDK. - // - // * FLEET_STATE_ACTIVE -- The - // fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host - // game sessions. - // - // * FLEET_STATE_ERROR -- The Fleet's status changed to ERROR. - // Describe the fleet event message for more details. - // - // Fleet creation events - // (ordered by fleet creation activity): - // - // * FLEET_BINARY_DOWNLOAD_FAILED -- The - // build failed to download to the fleet instance. - // - // * - // FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully - // downloaded to an instance, and the build files are now being extracted from the - // uploaded build and saved to an instance. Failure at this stage prevents a fleet - // from moving to ACTIVE status. Logs for this stage display a list of the files - // that are extracted and saved on the instance. Access the logs by using the URL - // in PreSignedLogUrl. - // - // * FLEET_CREATION_RUNNING_INSTALLER -- The game server build - // files were successfully extracted, and the GameLift is now running the build's - // install script (if one is included). Failure in this stage prevents a fleet from - // moving to ACTIVE status. Logs for this stage list the installation steps and - // whether or not the install completed successfully. Access the logs by using the - // URL in PreSignedLogUrl. - // - // * FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build - // process was successful, and the GameLift is now verifying that the game server - // launch paths, which are specified in the fleet's runtime configuration, exist. - // If any listed launch path exists, GameLift tries to launch a game server process - // and waits for the process to report ready. Failures in this stage prevent a - // fleet from moving to ACTIVE status. Logs for this stage list the launch paths in - // the runtime configuration and indicate whether each is found. Access the logs by - // using the URL in PreSignedLogUrl. - // - // * FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- - // Validation of the runtime configuration failed because the executable specified - // in a launch path does not exist on the instance. - // - // * - // FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime - // configuration failed because the executable specified in a launch path failed to - // run on the fleet instance. - // - // * FLEET_VALIDATION_TIMED_OUT -- Validation of the - // fleet at the end of creation timed out. Try fleet creation again. - // - // * - // FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the - // steps in the fleet activation process. This event code indicates that the game - // build was successfully downloaded to a fleet instance, built, and validated, but - // was not able to start a server process. For more information, see Debug Fleet - // Creation Issues - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation). - // - // * - // FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain - // any instances based on the input fleet attributes. Try again at a different time - // or choose a different combination of fleet attributes such as fleet type, - // instance type, etc. - // - // * FLEET_INITIALIZATION_FAILED -- A generic exception - // occurred during fleet creation. Describe the fleet event message for more - // details. - // + // - FLEET_CREATED -- A fleet resource was successfully created with a status of + // NEW . Event messaging includes the fleet ID. + // - FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING . + // The compressed build has started downloading to a fleet instance for + // installation. + // - FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to + // VALIDATING . GameLift has successfully downloaded the build and is now + // validating the build files. + // - FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING . + // GameLift has successfully verified the build files and is now running the + // installation scripts. + // - FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING . + // GameLift is trying to launch an instance and test the connectivity between the + // build and the GameLift Service via the Server SDK. + // - FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE . + // The fleet is now ready to host game sessions. + // - FLEET_STATE_ERROR -- The Fleet's status changed to ERROR . Describe the + // fleet event message for more details. + // Fleet creation events (ordered by fleet creation activity): + // - FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet + // instance. + // - FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully + // downloaded to an instance, and the build files are now being extracted from the + // uploaded build and saved to an instance. Failure at this stage prevents a fleet + // from moving to ACTIVE status. Logs for this stage display a list of the files + // that are extracted and saved on the instance. Access the logs by using the URL + // in PreSignedLogUrl. + // - FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were + // successfully extracted, and the GameLift is now running the build's install + // script (if one is included). Failure in this stage prevents a fleet from moving + // to ACTIVE status. Logs for this stage list the installation steps and whether or + // not the install completed successfully. Access the logs by using the URL in + // PreSignedLogUrl. + // - FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was + // successful, and the GameLift is now verifying that the game server launch paths, + // which are specified in the fleet's runtime configuration, exist. If any listed + // launch path exists, GameLift tries to launch a game server process and waits for + // the process to report ready. Failures in this stage prevent a fleet from moving + // to ACTIVE status. Logs for this stage list the launch paths in the runtime + // configuration and indicate whether each is found. Access the logs by using the + // URL in PreSignedLogUrl. + // - FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime + // configuration failed because the executable specified in a launch path does not + // exist on the instance. + // - FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime + // configuration failed because the executable specified in a launch path failed to + // run on the fleet instance. + // - FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of + // creation timed out. Try fleet creation again. + // - FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of + // the steps in the fleet activation process. This event code indicates that the + // game build was successfully downloaded to a fleet instance, built, and + // validated, but was not able to start a server process. For more information, see + // Debug Fleet Creation Issues (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation) + // . + // - FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to + // obtain any instances based on the input fleet attributes. Try again at a + // different time or choose a different combination of fleet attributes such as + // fleet type, instance type, etc. + // - FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet + // creation. Describe the fleet event message for more details. // VPC peering events: - // - // * FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering - // connection has been established between the VPC for an GameLift fleet and a VPC - // in your Amazon Web Services account. - // - // * FLEET_VPC_PEERING_FAILED -- A requested - // VPC peering connection has failed. Event details and status information provide - // additional detail. A common reason for peering failure is that the two VPCs have - // overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR - // block for the VPC in your Amazon Web Services account. For more information on - // VPC peering failures, see - // https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html - // (https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html) - // - // * - // FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully - // deleted. - // + // - FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been + // established between the VPC for an GameLift fleet and a VPC in your Amazon Web + // Services account. + // - FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. + // Event details and status information provide additional detail. A common reason + // for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 + // addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web + // Services account. For more information on VPC peering failures, see + // https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html (https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html) + // - FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully + // deleted. // Spot instance events: - // - // * INSTANCE_INTERRUPTED -- A spot instance was - // interrupted by EC2 with a two-minute notification. - // + // - INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a + // two-minute notification. // Server process events: - // - // * - // SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be - // found based on the Fleet runtime configuration. Check that the launch path is - // correct based on the operating system of the Fleet. - // - // * - // SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call - // InitSDK() within the time expected. Check your game session log to see why - // InitSDK() was not called in time. - // - // * SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The - // server process did not call ProcessReady() within the time expected after - // calling InitSDK(). Check your game session log to see why ProcessReady() was not - // called in time. - // - // * SERVER_PROCESS_CRASHED -- The server process exited without - // calling ProcessEnding(). Check your game session log to see why ProcessEnding() - // was not called. - // - // * SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did - // not report a valid health check for too long and was therefore terminated by - // GameLift. Check your game session log to see if the thread became stuck - // processing a synchronous task for too long. - // - // * SERVER_PROCESS_FORCE_TERMINATED - // -- The server process did not exit cleanly after OnProcessTerminate() was sent - // within the time expected. Check your game session log to see why termination - // took longer than expected. - // - // * SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server - // process did not exit cleanly within the time expected after calling - // ProcessEnding(). Check your game session log to see why termination took longer - // than expected. - // + // - SERVER_PROCESS_INVALID_PATH -- The game server executable or script could + // not be found based on the Fleet runtime configuration. Check that the launch + // path is correct based on the operating system of the Fleet. + // - SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not + // call InitSDK() within the time expected. Check your game session log to see why + // InitSDK() was not called in time. + // - SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call + // ProcessReady() within the time expected after calling InitSDK(). Check your game + // session log to see why ProcessReady() was not called in time. + // - SERVER_PROCESS_CRASHED -- The server process exited without calling + // ProcessEnding(). Check your game session log to see why ProcessEnding() was not + // called. + // - SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a + // valid health check for too long and was therefore terminated by GameLift. Check + // your game session log to see if the thread became stuck processing a synchronous + // task for too long. + // - SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly + // after OnProcessTerminate() was sent within the time expected. Check your game + // session log to see why termination took longer than expected. + // - SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit + // cleanly within the time expected after calling ProcessEnding(). Check your game + // session log to see why termination took longer than expected. // Game session events: - // - // * GAME_SESSION_ACTIVATION_TIMEOUT -- - // GameSession failed to activate within the expected time. Check your game session - // log to see why ActivateGameSession() took longer to complete than - // expected. - // + // - GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within + // the expected time. Check your game session log to see why ActivateGameSession() + // took longer to complete than expected. // Other fleet events: - // - // * FLEET_SCALING_EVENT -- A change was made to - // the fleet's capacity settings (desired instances, minimum/maximum scaling - // limits). Event messaging includes the new capacity settings. - // - // * - // FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the - // fleet's game session protection policy setting. Event messaging includes both - // the old and new policy setting. - // - // * FLEET_DELETED -- A request to delete a fleet - // was initiated. - // - // * GENERIC_EVENT -- An unspecified event has occurred. + // - FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings + // (desired instances, minimum/maximum scaling limits). Event messaging includes + // the new capacity settings. + // - FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to + // the fleet's game session protection policy setting. Event messaging includes + // both the old and new policy setting. + // - FLEET_DELETED -- A request to delete a fleet was initiated. + // - GENERIC_EVENT -- An unspecified event has occurred. EventCode EventCode // A unique identifier for a fleet event. EventId *string // Time stamp indicating when this event occurred. Format is a number expressed in - // Unix time as milliseconds (for example "1469498468.057"). + // Unix time as milliseconds (for example "1469498468.057" ). EventTime *time.Time // Additional information related to the event. @@ -512,7 +439,7 @@ type Event struct { type FilterConfiguration struct { // A list of locations to allow game session placement in, in the form of Amazon - // Web Services Region codes such as us-west-2. + // Web Services Region codes such as us-west-2 . AllowedLocations []string noSmithyDocumentSerde @@ -524,21 +451,19 @@ type FleetAttributes struct { // GameLift Anywhere configuration options for your Anywhere fleets. AnywhereConfiguration *AnywhereConfiguration - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift build resource that is deployed on instances in this fleet. In - // a GameLift build ARN, the resource ID matches the BuildId value. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift build resource that is deployed on instances in + // this fleet. In a GameLift build ARN, the resource ID matches the BuildId value. BuildArn *string - // A unique identifier for the build resource that is deployed on instances in this - // fleet. + // A unique identifier for the build resource that is deployed on instances in + // this fleet. BuildId *string // Determines whether a TLS/SSL certificate is generated for a fleet. This feature // must be enabled when creating the fleet. All instances in a fleet share the same - // certificate. The certificate can be retrieved by calling the GameLift Server SDK - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) - // operation GetInstanceCertificate. + // certificate. The certificate can be retrieved by calling the GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) + // operation GetInstanceCertificate . CertificateConfiguration *CertificateConfiguration // The type of compute resource used to host your game servers. You can use your @@ -547,28 +472,26 @@ type FleetAttributes struct { ComputeType ComputeType // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A human-readable description of the fleet. Description *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a // GameLift fleet ARN, the resource ID matches the FleetId value. FleetArn *string // A unique identifier for the fleet. FleetId *string - // Indicates whether to use On-Demand or Spot instances for this fleet. By default, - // this property is set to ON_DEMAND. Learn more about when to use On-Demand - // versus Spot Instances - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot). - // This property cannot be changed after the fleet is created. + // Indicates whether to use On-Demand or Spot instances for this fleet. By + // default, this property is set to ON_DEMAND . Learn more about when to use + // On-Demand versus Spot Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) + // . This property cannot be changed after the fleet is created. FleetType FleetType // A unique identifier for an IAM role that manages access to your Amazon Web @@ -577,21 +500,21 @@ type FleetAttributes struct { // processes, and daemons (background processes). Create a role or look up a role's // ARN by using the IAM dashboard (https://console.aws.amazon.com/iam/) in the // Amazon Web Services Management Console. Learn more about using on-box - // credentials for your game servers at Access external resources from a game - // server - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html). + // credentials for your game servers at Access external resources from a game + // server (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) + // . InstanceRoleArn *string // The Amazon EC2 instance type that determines the computing resources of each // instance in the fleet. Instance type defines the CPU, memory, storage, and - // networking capacity. See Amazon Elastic Compute Cloud Instance Types - // (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. + // networking capacity. See Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/) + // for detailed descriptions. InstanceType EC2InstanceType // This parameter is no longer used. Game session log paths are now defined using - // the GameLift server API ProcessReady()logParameters. See more information in the - // Server API Reference - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process). + // the GameLift server API ProcessReady() logParameters . See more information in + // the Server API Reference (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process) + // . LogPaths []string // Name of a metric group that metrics for this fleet are added to. In Amazon @@ -603,14 +526,12 @@ type FleetAttributes struct { // be unique. Name *string - // The type of game session protection to set on all new instances that are started - // in the fleet. - // - // * NoProtection -- The game session can be terminated during a - // scale-down event. - // - // * FullProtection -- If the game session is in an ACTIVE - // status, it cannot be terminated during a scale-down event. + // The type of game session protection to set on all new instances that are + // started in the fleet. + // - NoProtection -- The game session can be terminated during a scale-down + // event. + // - FullProtection -- If the game session is in an ACTIVE status, it cannot be + // terminated during a scale-down event. NewGameSessionProtectionPolicy ProtectionPolicy // The operating system of the fleet's computing resources. A fleet's operating @@ -622,60 +543,48 @@ type FleetAttributes struct { // create within a specified span of time. With this policy, you can control // players' ability to consume available resources. The policy is evaluated when a // player tries to create a new game session. On receiving a CreateGameSession - // request, GameLift checks that the player (identified by CreatorId) has created + // request, GameLift checks that the player (identified by CreatorId ) has created // fewer than game session limit in the specified time period. ResourceCreationLimitPolicy *ResourceCreationLimitPolicy - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift script resource that is deployed on instances in this fleet. - // In a GameLift script ARN, the resource ID matches the ScriptId value. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift script resource that is deployed on instances in + // this fleet. In a GameLift script ARN, the resource ID matches the ScriptId + // value. ScriptArn *string // A unique identifier for the Realtime script resource that is deployed on // instances in this fleet. ScriptId *string - // This parameter is no longer used. Server launch parameters are now defined using - // the fleet's runtime configuration . Requests that use this parameter instead - // continue to be valid. + // This parameter is no longer used. Server launch parameters are now defined + // using the fleet's runtime configuration . Requests that use this parameter + // instead continue to be valid. ServerLaunchParameters *string // This parameter is no longer used. Server launch paths are now defined using the - // fleet's RuntimeConfiguration - // (https://docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html) + // fleet's RuntimeConfiguration (https://docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html) // . Requests that use this parameter instead continue to be valid. ServerLaunchPath *string // Current status of the fleet. Possible fleet statuses include the following: - // - // * - // NEW -- A new fleet has been defined and desired instances is set to 1. - // - // * - // DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new - // fleet, creating new instances with the game build or Realtime script and - // starting server processes. - // - // * ACTIVE -- Hosts can now accept game sessions. - // - // * - // ERROR -- An error occurred when downloading, validating, building, or activating - // the fleet. - // - // * DELETING -- Hosts are responding to a delete fleet request. - // - // * - // TERMINATED -- The fleet no longer exists. + // - NEW -- A new fleet has been defined and desired instances is set to 1. + // - DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the + // new fleet, creating new instances with the game build or Realtime script and + // starting server processes. + // - ACTIVE -- Hosts can now accept game sessions. + // - ERROR -- An error occurred when downloading, validating, building, or + // activating the fleet. + // - DELETING -- Hosts are responding to a delete fleet request. + // - TERMINATED -- The fleet no longer exists. Status FleetStatus - // A list of fleet activity that has been suspended using StopFleetActions - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html) + // A list of fleet activity that has been suspended using StopFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html) // . This includes fleet auto-scaling. StoppedActions []FleetAction - // A time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // A time stamp indicating when this data object was terminated. Format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). TerminationTime *time.Time noSmithyDocumentSerde @@ -683,19 +592,15 @@ type FleetAttributes struct { // Current resource capacity settings in a specified fleet or location. The // location value might refer to a fleet's remote location or its home Region. -// Related actions DescribeFleetCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) -// | DescribeFleetLocationCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) -// | UpdateFleetCapacity -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) +// Related actions DescribeFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) +// | DescribeFleetLocationCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) +// | UpdateFleetCapacity (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) type FleetCapacity struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet associated with the location. @@ -713,7 +618,7 @@ type FleetCapacity struct { InstanceType EC2InstanceType // The fleet location for the instance count information, expressed as an Amazon - // Web Services Region code, such as us-west-2. + // Web Services Region code, such as us-west-2 . Location *string noSmithyDocumentSerde @@ -736,18 +641,17 @@ type FleetUtilization struct { // instances in the fleet location. CurrentPlayerSessionCount *int32 - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet associated with the location. FleetId *string - // The fleet location for the fleet utilization information, expressed as an Amazon - // Web Services Region code, such as us-west-2. + // The fleet location for the fleet utilization information, expressed as an + // Amazon Web Services Region code, such as us-west-2 . Location *string // The maximum number of players allowed across all game sessions that are @@ -762,8 +666,8 @@ type FleetUtilization struct { // used when setting up the new game session. For example, a game property might // specify a game mode, level, or map. Game properties are passed to the game // server process when initiating a new game session. For more information, see the -// GameLift Developer Guide -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create). +// GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create) +// . type GameProperty struct { // The game property identifier. @@ -782,8 +686,8 @@ type GameProperty struct { // This data type is used with the GameLift FleetIQ and game server groups. // Properties describing a game server that is running on an instance in a game // server group. A game server is created by a successful call to -// RegisterGameServer and deleted by calling DeregisterGameServer. A game server is -// claimed to host a game session by calling ClaimGameServer. +// RegisterGameServer and deleted by calling DeregisterGameServer . A game server +// is claimed to host a game session by calling ClaimGameServer . type GameServer struct { // Indicates when an available game server has been reserved for gameplay but has @@ -798,9 +702,9 @@ type GameServer struct { // the game server. ConnectionInfo *string - // A set of custom game server properties, formatted as a single string value. This - // data is passed to a game client or service when it requests information on game - // servers. + // A set of custom game server properties, formatted as a single string value. + // This data is passed to a game client or service when it requests information on + // game servers. GameServerData *string // The ARN identifier for the game server group where the game server is located. @@ -814,36 +718,32 @@ type GameServer struct { // Services account. GameServerId *string - // The unique identifier for the instance where the game server is running. This ID - // is available in the instance metadata. EC2 instance IDs use a 17-character - // format, for example: i-1234567890abcdef0. + // The unique identifier for the instance where the game server is running. This + // ID is available in the instance metadata. EC2 instance IDs use a 17-character + // format, for example: i-1234567890abcdef0 . InstanceId *string // Timestamp that indicates the last time the game server was claimed. The format - // is a number expressed in Unix time as milliseconds (for example - // "1469498468.057"). This value is used to calculate when a claimed game server's - // status should revert to null. + // is a number expressed in Unix time as milliseconds (for example "1469498468.057" + // ). This value is used to calculate when a claimed game server's status should + // revert to null. LastClaimTime *time.Time // Timestamp that indicates the last time the game server was updated with health // status. The format is a number expressed in Unix time as milliseconds (for - // example "1469498468.057"). After game server registration, this property is only - // changed when a game server update specifies a health check value. + // example "1469498468.057" ). After game server registration, this property is + // only changed when a game server update specifies a health check value. LastHealthCheckTime *time.Time - // Timestamp that indicates when the game server registered. The format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // Timestamp that indicates when the game server registered. The format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). RegistrationTime *time.Time // Indicates whether the game server is currently available for new games or is // busy. Possible statuses include: - // - // * AVAILABLE - The game server is available to - // be claimed. A game server that has been claimed remains in this status until it - // reports game hosting activity. - // - // * UTILIZED - The game server is currently - // hosting a game session with players. + // - AVAILABLE - The game server is available to be claimed. A game server that + // has been claimed remains in this status until it reports game hosting activity. + // - UTILIZED - The game server is currently hosting a game session with players. UtilizationStatus GameServerUtilizationStatus noSmithyDocumentSerde @@ -853,9 +753,9 @@ type GameServer struct { // Properties that describe a game server group resource. A game server group // manages certain properties related to a corresponding Amazon EC2 Auto Scaling // group. A game server group is created by a successful call to -// CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server +// CreateGameServerGroup and deleted by calling DeleteGameServerGroup . Game server // group activity can be temporarily suspended and resumed by calling -// SuspendGameServerGroup and ResumeGameServerGroup, respectively. +// SuspendGameServerGroup and ResumeGameServerGroup , respectively. type GameServerGroup struct { // A generated unique ID for the Amazon EC2 Auto Scaling group that is associated @@ -864,35 +764,30 @@ type GameServerGroup struct { // Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand // Instances in the game server group. Method options include the following: - // - // * - // SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot - // Instances are unavailable or not viable for game hosting, the game server group - // provides no hosting capacity until Spot Instances can again be used. Until then, - // no new instances are started, and the existing nonviable Spot Instances are - // terminated (after current gameplay ends) and are not replaced. - // - // * SPOT_PREFERRED - // - (default value) Spot Instances are used whenever available in the game server - // group. If Spot Instances are unavailable, the game server group continues to - // provide hosting capacity by falling back to On-Demand Instances. Existing - // nonviable Spot Instances are terminated (after current gameplay ends) and are - // replaced with new On-Demand Instances. - // - // * ON_DEMAND_ONLY - Only On-Demand - // Instances are used in the game server group. No Spot Instances are used, even - // when available, while this balancing strategy is in force. + // - SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot + // Instances are unavailable or not viable for game hosting, the game server group + // provides no hosting capacity until Spot Instances can again be used. Until then, + // no new instances are started, and the existing nonviable Spot Instances are + // terminated (after current gameplay ends) and are not replaced. + // - SPOT_PREFERRED - (default value) Spot Instances are used whenever available + // in the game server group. If Spot Instances are unavailable, the game server + // group continues to provide hosting capacity by falling back to On-Demand + // Instances. Existing nonviable Spot Instances are terminated (after current + // gameplay ends) and are replaced with new On-Demand Instances. + // - ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. + // No Spot Instances are used, even when available, while this balancing strategy + // is in force. BalancingStrategy BalancingStrategy // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A generated unique ID for the game server group. GameServerGroupArn *string - // A developer-defined identifier for the game server group. The name is unique for - // each Region in each Amazon Web Services account. + // A developer-defined identifier for the game server group. The name is unique + // for each Region in each Amazon Web Services account. GameServerGroupName *string // A flag that indicates whether instances in the game server group are protected @@ -912,45 +807,32 @@ type GameServerGroup struct { // A timestamp that indicates when this game server group was last updated. LastUpdatedTime *time.Time - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto + // Scaling groups. RoleArn *string // The current status of the game server group. Possible statuses include: - // - // * NEW - - // GameLift FleetIQ has validated the CreateGameServerGroup() request. - // - // * - // ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes - // creating an Auto Scaling group in your Amazon Web Services account. - // - // * ACTIVE - - // The game server group has been successfully created. - // - // * DELETE_SCHEDULED - A - // request to delete the game server group has been received. - // - // * DELETING - - // GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is - // processing it. GameLift FleetIQ must first complete and release hosts before it - // deletes the Auto Scaling group and the game server group. - // - // * DELETED - The game - // server group has been successfully deleted. - // - // * ERROR - The asynchronous - // processes of activating or deleting a game server group has failed, resulting in - // an error state. + // - NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request. + // - ACTIVATING - GameLift FleetIQ is setting up a game server group, which + // includes creating an Auto Scaling group in your Amazon Web Services account. + // - ACTIVE - The game server group has been successfully created. + // - DELETE_SCHEDULED - A request to delete the game server group has been + // received. + // - DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() + // request and is processing it. GameLift FleetIQ must first complete and release + // hosts before it deletes the Auto Scaling group and the game server group. + // - DELETED - The game server group has been successfully deleted. + // - ERROR - The asynchronous processes of activating or deleting a game server + // group has failed, resulting in an error state. Status GameServerGroupStatus // Additional information about the current game server group status. This // information might provide additional insight on groups that are in ERROR status. StatusReason *string - // A list of activities that are currently suspended for this game server group. If - // this property is empty, all activities are occurring. + // A list of activities that are currently suspended for this game server group. + // If this property is empty, all activities are occurring. SuspendedActions []GameServerGroupAction noSmithyDocumentSerde @@ -966,16 +848,16 @@ type GameServerGroupAutoScalingPolicy struct { // Settings for a target-based scaling policy applied to Auto Scaling group. These // settings are used to create a target-based policy that tracks the GameLift - // FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the - // metric. As player usage changes, the policy triggers to adjust the game server - // group capacity so that the metric returns to the target value. + // FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for + // the metric. As player usage changes, the policy triggers to adjust the game + // server group capacity so that the metric returns to the target value. // // This member is required. TargetTrackingConfiguration *TargetTrackingConfiguration - // Length of time, in seconds, it takes for a new instance to start new game server - // processes and register with GameLift FleetIQ. Specifying a warm-up time can be - // useful, particularly with game servers that take a long time to start up, + // Length of time, in seconds, it takes for a new instance to start new game + // server processes and register with GameLift FleetIQ. Specifying a warm-up time + // can be useful, particularly with game servers that take a long time to start up, // because it avoids prematurely starting new instances. EstimatedInstanceWarmup *int32 @@ -985,9 +867,9 @@ type GameServerGroupAutoScalingPolicy struct { // This data type is used with the GameLift FleetIQ and game server groups. // Additional properties, including status, that describe an EC2 instance in a game // server group. Instance configurations are set with game server group properties -// (see DescribeGameServerGroup and with the EC2 launch template that was used when -// creating the game server group. Retrieve game server instances for a game server -// group by calling DescribeGameServerInstances. +// (see DescribeGameServerGroup and with the EC2 launch template that was used +// when creating the game server group. Retrieve game server instances for a game +// server group by calling DescribeGameServerInstances . type GameServerInstance struct { // A generated unique identifier for the game server group that includes the game @@ -999,9 +881,9 @@ type GameServerInstance struct { // account. GameServerGroupName *string - // The unique identifier for the instance where the game server is running. This ID - // is available in the instance metadata. EC2 instance IDs use a 17-character - // format, for example: i-1234567890abcdef0. + // The unique identifier for the instance where the game server is running. This + // ID is available in the instance metadata. EC2 instance IDs use a 17-character + // format, for example: i-1234567890abcdef0 . InstanceId *string // Current status of the game server instance @@ -1011,15 +893,14 @@ type GameServerInstance struct { } // Properties describing a game session. A game session in ACTIVE status can host -// players. When a game session ends, its status is set to TERMINATED. Once the +// players. When a game session ends, its status is set to TERMINATED . Once the // session ends, the game session object is retained for 30 days. This means you // can reuse idempotency token values after this time. Game session logs are -// retained for 14 days. All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// retained for 14 days. All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type GameSession struct { // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A unique identifier for a player. This ID is used to enforce a resource @@ -1032,22 +913,16 @@ type GameSession struct { // The DNS identifier assigned to the instance that is running the game session. // Values have the following format: - // - // * TLS-enabled fleets: - // ..amazongamelift.com. - // - // * Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. - // (See Amazon EC2 Instance IP Addressing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).) - // - // When - // connecting to a game session that is running on a TLS-enabled fleet, you must - // use the DNS name, not the IP address. + // - TLS-enabled fleets: ..amazongamelift.com . + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See Amazon EC2 + // Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) + // .) + // When connecting to a game session that is running on a TLS-enabled fleet, you + // must use the DNS name, not the IP address. DnsName *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift fleet that this game session is running on. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift fleet that this game session is running on. FleetArn *string // A unique identifier for the fleet that the game session is running on. @@ -1055,47 +930,46 @@ type GameSession struct { // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameProperties []GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process with a request to start a new game - // session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameSessionData *string // A unique identifier for the game session. A game session ARN has the following - // format: arn:aws:gamelift:::gamesession//. + // format: arn:aws:gamelift:::gamesession// . GameSessionId *string - // The IP address of the game session. To connect to a GameLift game server, an app - // needs both the IP address and port number. + // The IP address of the game session. To connect to a GameLift game server, an + // app needs both the IP address and port number. IpAddress *string // The fleet location where the game session is running. This value might specify // the fleet's home Region or a remote location. Location is expressed as an Amazon - // Web Services Region code such as us-west-2. + // Web Services Region code such as us-west-2 . Location *string // Information about the matchmaking process that was used to create the game // session. It is in JSON syntax, formatted as a string. In addition the // matchmaking configuration used, it contains data on all players assigned to the // match, including player attributes and team assignments. For more details on - // matchmaker data, see Match Data - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data). - // Matchmaker data is useful when requesting match backfills, and is updated + // matchmaker data, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data) + // . Matchmaker data is useful when requesting match backfills, and is updated // whenever new players are added during a successful backfill (see - // StartMatchBackfill - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html)). + // StartMatchBackfill (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html) + // ). MatchmakerData *string // The maximum number of players that can be connected simultaneously to the game // session. MaximumPlayerSessionCount *int32 - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. + // A descriptive label that is associated with a game session. Session names do + // not need to be unique. Name *string // Indicates whether or not the game session is accepting new players. @@ -1105,17 +979,17 @@ type GameSession struct { // app needs both the IP address and port number. Port *int32 - // Current status of the game session. A game session must have an ACTIVE status to - // have player sessions. + // Current status of the game session. A game session must have an ACTIVE status + // to have player sessions. Status GameSessionStatus - // Provides additional information about game session status. INTERRUPTED indicates - // that the game session was hosted on a spot instance that was reclaimed, causing - // the active game session to be terminated. + // Provides additional information about game session status. INTERRUPTED + // indicates that the game session was hosted on a spot instance that was + // reclaimed, causing the active game session to be terminated. StatusReason GameSessionStatusReason - // A time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // A time stamp indicating when this data object was terminated. Format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). TerminationTime *time.Time noSmithyDocumentSerde @@ -1130,24 +1004,19 @@ type GameSessionConnectionInfo struct { // The DNS identifier assigned to the instance that is running the game session. // Values have the following format: - // - // * TLS-enabled fleets: - // ..amazongamelift.com. - // - // * Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. - // (See Amazon EC2 Instance IP Addressing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).) - // - // When - // connecting to a game session that is running on a TLS-enabled fleet, you must - // use the DNS name, not the IP address. + // - TLS-enabled fleets: ..amazongamelift.com . + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See Amazon EC2 + // Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) + // .) + // When connecting to a game session that is running on a TLS-enabled fleet, you + // must use the DNS name, not the IP address. DnsName *string // A unique identifier for the game session. Use the game session ID. GameSessionArn *string - // The IP address of the game session. To connect to a GameLift game server, an app - // needs both the IP address and port number. + // The IP address of the game session. To connect to a GameLift game server, an + // app needs both the IP address and port number. IpAddress *string // A collection of player session IDs, one for each player ID that was included in @@ -1168,13 +1037,10 @@ type GameSessionDetail struct { GameSession *GameSession // Current status of protection for the game session. - // - // * NoProtection -- The game - // session can be terminated during a scale-down event. - // - // * FullProtection -- If the - // game session is in an ACTIVE status, it cannot be terminated during a scale-down - // event. + // - NoProtection -- The game session can be terminated during a scale-down + // event. + // - FullProtection -- If the game session is in an ACTIVE status, it cannot be + // terminated during a scale-down event. ProtectionPolicy ProtectionPolicy noSmithyDocumentSerde @@ -1186,17 +1052,12 @@ type GameSessionPlacement struct { // The DNS identifier assigned to the instance that is running the game session. // Values have the following format: - // - // * TLS-enabled fleets: - // ..amazongamelift.com. - // - // * Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. - // (See Amazon EC2 Instance IP Addressing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).) - // - // When - // connecting to a game session that is running on a TLS-enabled fleet, you must - // use the DNS name, not the IP address. + // - TLS-enabled fleets: ..amazongamelift.com . + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See Amazon EC2 + // Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) + // .) + // When connecting to a game session that is running on a TLS-enabled fleet, you + // must use the DNS name, not the IP address. DnsName *string // Time stamp indicating when this request was completed, canceled, or timed out. @@ -1204,50 +1065,50 @@ type GameSessionPlacement struct { // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameProperties []GameProperty - // Identifier for the game session created by this placement request. This value is - // set once the new game session is placed (placement status is FULFILLED). This - // identifier is unique across all Regions. You can use this value as a + // Identifier for the game session created by this placement request. This value + // is set once the new game session is placed (placement status is FULFILLED ). + // This identifier is unique across all Regions. You can use this value as a // GameSessionId value as needed. GameSessionArn *string // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process in the GameSession object with a - // request to start a new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). + // request to start a new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). GameSessionData *string // A unique identifier for the game session. This value is set once the new game - // session is placed (placement status is FULFILLED). + // session is placed (placement status is FULFILLED ). GameSessionId *string - // A descriptive label that is associated with a game session. Session names do not - // need to be unique. + // A descriptive label that is associated with a game session. Session names do + // not need to be unique. GameSessionName *string - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. + // A descriptive label that is associated with game session queue. Queue names + // must be unique within each Region. GameSessionQueueName *string // Name of the Region where the game session created by this placement request is // running. This value is set once the new game session is placed (placement status - // is FULFILLED). + // is FULFILLED ). GameSessionRegion *string - // The IP address of the game session. To connect to a GameLift game server, an app - // needs both the IP address and port number. This value is set once the new game - // session is placed (placement status is FULFILLED). + // The IP address of the game session. To connect to a GameLift game server, an + // app needs both the IP address and port number. This value is set once the new + // game session is placed (placement status is FULFILLED ). IpAddress *string // Information on the matchmaking process for this game. Data is in JSON syntax, // formatted as a string. It identifies the matchmaking configuration used to // create the match, and contains data on all players assigned to the match, // including player attributes and team assignments. For more details on matchmaker - // data, see Match Data - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data). + // data, see Match Data (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data) + // . MatchmakerData *string // The maximum number of players that can be connected simultaneously to the game @@ -1256,7 +1117,7 @@ type GameSessionPlacement struct { // A collection of information on player sessions created in response to the game // session placement request. These player sessions are created only once a new - // game session is successfully placed (placement status is FULFILLED). This + // game session is successfully placed (placement status is FULFILLED ). This // information includes the player ID (as provided in the placement request) and // the corresponding player session ID. PlacedPlayerSessions []PlacedPlayerSession @@ -1264,47 +1125,39 @@ type GameSessionPlacement struct { // A unique identifier for a game session placement. PlacementId *string - // A set of values, expressed in milliseconds, that indicates the amount of latency - // that a player experiences when connected to Amazon Web Services Regions. + // A set of values, expressed in milliseconds, that indicates the amount of + // latency that a player experiences when connected to Amazon Web Services Regions. PlayerLatencies []PlayerLatency // The port number for the game session. To connect to a GameLift game server, an // app needs both the IP address and port number. This value is set once the new - // game session is placed (placement status is FULFILLED). + // game session is placed (placement status is FULFILLED ). Port *int32 // Time stamp indicating when this request was placed in the queue. Format is a - // number expressed in Unix time as milliseconds (for example "1469498468.057"). + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). StartTime *time.Time // Current status of the game session placement request. - // - // * PENDING -- The - // placement request is currently in the queue waiting to be processed. - // - // * - // FULFILLED -- A new game session and player sessions (if requested) have been - // successfully created. Values for GameSessionArn and GameSessionRegion are - // available. - // - // * CANCELLED -- The placement request was canceled. - // - // * TIMED_OUT -- A - // new game session was not successfully created before the time limit expired. You - // can resubmit the placement request as needed. - // - // * FAILED -- GameLift is not able - // to complete the process of placing the game session. Common reasons are the game - // session terminated before the placement process was completed, or an unexpected - // internal error. + // - PENDING -- The placement request is currently in the queue waiting to be + // processed. + // - FULFILLED -- A new game session and player sessions (if requested) have + // been successfully created. Values for GameSessionArn and GameSessionRegion are + // available. + // - CANCELLED -- The placement request was canceled. + // - TIMED_OUT -- A new game session was not successfully created before the + // time limit expired. You can resubmit the placement request as needed. + // - FAILED -- GameLift is not able to complete the process of placing the game + // session. Common reasons are the game session terminated before the placement + // process was completed, or an unexpected internal error. Status GameSessionPlacementState noSmithyDocumentSerde } -// Configuration for a game session placement mechanism that processes requests for -// new game sessions. A queue can be used on its own or as part of a matchmaking -// solution. +// Configuration for a game session placement mechanism that processes requests +// for new game sessions. A queue can be used on its own or as part of a +// matchmaking solution. type GameSessionQueue struct { // Information that is added to all events that are related to this game session @@ -1318,25 +1171,24 @@ type GameSessionQueue struct { // A list of locations where a queue is allowed to place new game sessions. // Locations are specified in the form of Amazon Web Services Region codes, such as - // us-west-2. If this parameter is not set, game sessions can be placed in any + // us-west-2 . If this parameter is not set, game sessions can be placed in any // queue location. FilterConfiguration *FilterConfiguration - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift game session queue resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::gamesessionqueue/. In a GameLift game session queue ARN, the + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::gamesessionqueue/ . In a GameLift game session queue ARN, the // resource ID matches the Name value. GameSessionQueueArn *string - // A descriptive label that is associated with game session queue. Queue names must - // be unique within each Region. + // A descriptive label that is associated with game session queue. Queue names + // must be unique within each Region. Name *string - // An SNS topic ARN that is set up to receive game session placement notifications. - // See Setting up notifications for game session placement - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html). + // An SNS topic ARN that is set up to receive game session placement + // notifications. See Setting up notifications for game session placement (https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html) + // . NotificationTarget *string // A set of policies that act as a sliding cap on player latency. FleetIQ works to @@ -1361,8 +1213,8 @@ type GameSessionQueue struct { noSmithyDocumentSerde } -// A fleet or alias designated in a game session queue. Queues fulfill requests for -// new game sessions by placing a new game session on any of the queue's +// A fleet or alias designated in a game session queue. Queues fulfill requests +// for new game sessions by placing a new game session on any of the queue's // destinations. type GameSessionQueueDestination struct { @@ -1374,35 +1226,29 @@ type GameSessionQueueDestination struct { noSmithyDocumentSerde } -// Represents an EC2 instance of virtual computing resources that hosts one or more -// game servers. In GameLift, a fleet can contain zero or more instances. Related -// actions +// Represents an EC2 instance of virtual computing resources that hosts one or +// more game servers. In GameLift, a fleet can contain zero or more instances. +// Related actions type Instance struct { // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // The DNS identifier assigned to the instance that is running the game session. // Values have the following format: - // - // * TLS-enabled fleets: - // ..amazongamelift.com. - // - // * Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. - // (See Amazon EC2 Instance IP Addressing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).) - // - // When - // connecting to a game session that is running on a TLS-enabled fleet, you must - // use the DNS name, not the IP address. + // - TLS-enabled fleets: ..amazongamelift.com . + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See Amazon EC2 + // Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) + // .) + // When connecting to a game session that is running on a TLS-enabled fleet, you + // must use the DNS name, not the IP address. DnsName *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that the instance is in. @@ -1415,27 +1261,22 @@ type Instance struct { IpAddress *string // The fleet location of the instance, expressed as an Amazon Web Services Region - // code, such as us-west-2. + // code, such as us-west-2 . Location *string // Operating system that is running on this instance. OperatingSystem OperatingSystem // Current status of the instance. Possible statuses include the following: - // - // * - // PENDING -- The instance is in the process of being created and launching server - // processes as defined in the fleet's run-time configuration. - // - // * ACTIVE -- The - // instance has been successfully created and at least one server process has - // successfully launched and reported back to GameLift that it is ready to host a - // game session. The instance is now considered ready to host game sessions. - // - // * - // TERMINATING -- The instance is in the process of shutting down. This may happen - // to reduce capacity during a scaling down event or to recycle resources in the - // event of a problem. + // - PENDING -- The instance is in the process of being created and launching + // server processes as defined in the fleet's run-time configuration. + // - ACTIVE -- The instance has been successfully created and at least one + // server process has successfully launched and reported back to GameLift that it + // is ready to host a game session. The instance is now considered ready to host + // game sessions. + // - TERMINATING -- The instance is in the process of shutting down. This may + // happen to reduce capacity during a scaling down event or to recycle resources in + // the event of a problem. Status InstanceStatus // Amazon EC2 instance type that defines the computing resources of this instance. @@ -1491,12 +1332,11 @@ type InstanceDefinition struct { // This member is required. InstanceType GameServerGroupInstanceType - // Instance weighting that indicates how much this instance type contributes to the - // total capacity of a game server group. Instance weights are used by GameLift + // Instance weighting that indicates how much this instance type contributes to + // the total capacity of a game server group. Instance weights are used by GameLift // FleetIQ to calculate the instance type's cost per unit hour and better identify // the most cost-effective options. For detailed information on weighting instance - // capacity, see Instance Weighting - // (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) + // capacity, see Instance Weighting (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) // in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is // "1". WeightedCapacity *string @@ -1519,8 +1359,8 @@ type IpPermission struct { FromPort *int32 // A range of allowed IP addresses. This value must be expressed in CIDR notation. - // Example: "000.000.000.000/[subnet mask]" or optionally the shortened version - // "0.0.0.0/[subnet mask]". + // Example: " 000.000.000.000/[subnet mask] " or optionally the shortened version " + // 0.0.0.0/[subnet mask] ". // // This member is required. IpRange *string @@ -1531,8 +1371,8 @@ type IpPermission struct { Protocol IpProtocol // An ending value for a range of allowed port numbers. Port numbers are - // end-inclusive. This value must be higher than FromPort. For fleets using Windows - // and Linux builds, only ports 1026-60000 are valid. + // end-inclusive. This value must be higher than FromPort . For fleets using + // Windows and Linux builds, only ports 1026-60000 are valid. // // This member is required. ToPort *int32 @@ -1578,11 +1418,11 @@ type LocationAttributes struct { noSmithyDocumentSerde } -// A remote location where a multi-location fleet can deploy EC2 instances for game -// hosting. +// A remote location where a multi-location fleet can deploy EC2 instances for +// game hosting. type LocationConfiguration struct { - // An Amazon Web Services Region code, such as us-west-2. + // An Amazon Web Services Region code, such as us-west-2 . // // This member is required. Location *string @@ -1593,11 +1433,10 @@ type LocationConfiguration struct { // Properties of a location type LocationModel struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift location resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift location resource and uniquely identifies it. + // ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . LocationArn *string // The location's name. @@ -1606,37 +1445,27 @@ type LocationModel struct { noSmithyDocumentSerde } -// A fleet location and its life-cycle state. A location state object might be used -// to describe a fleet's remote location or home Region. Life-cycle state tracks -// the progress of launching the first instance in a new location and preparing it -// for game hosting, and then removing all instances and deleting the location from -// the fleet. -// -// * NEW -- A new fleet location has been defined and desired instances -// is set to 1. -// -// * DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is -// setting up the new fleet location, creating new instances with the game build or -// Realtime script and starting server processes. -// -// * ACTIVE -- Hosts can now accept -// game sessions. -// -// * ERROR -- An error occurred when downloading, validating, -// building, or activating the fleet location. -// -// * DELETING -- Hosts are responding -// to a delete fleet location request. -// -// * TERMINATED -- The fleet location no -// longer exists. -// -// * NOT_FOUND -- The fleet location was not found. This could be -// because the custom location was removed or not created. +// A fleet location and its life-cycle state. A location state object might be +// used to describe a fleet's remote location or home Region. Life-cycle state +// tracks the progress of launching the first instance in a new location and +// preparing it for game hosting, and then removing all instances and deleting the +// location from the fleet. +// - NEW -- A new fleet location has been defined and desired instances is set +// to 1. +// - DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the +// new fleet location, creating new instances with the game build or Realtime +// script and starting server processes. +// - ACTIVE -- Hosts can now accept game sessions. +// - ERROR -- An error occurred when downloading, validating, building, or +// activating the fleet location. +// - DELETING -- Hosts are responding to a delete fleet location request. +// - TERMINATED -- The fleet location no longer exists. +// - NOT_FOUND -- The fleet location was not found. This could be because the +// custom location was removed or not created. type LocationState struct { // The fleet location, expressed as an Amazon Web Services Region code such as - // us-west-2. + // us-west-2 . Location *string // The life-cycle status of a fleet location. @@ -1681,28 +1510,26 @@ type MatchmakingConfiguration struct { // example, if the configuration's rule set specifies a match for a single // 12-person team, and the additional player count is set to 2, only 10 players are // selected for the match. This parameter is not used when FlexMatchMode is set to - // STANDALONE. + // STANDALONE . AdditionalPlayerCount *int32 // The method used to backfill game sessions created with this matchmaking // configuration. MANUAL indicates that the game makes backfill requests or does // not use the match backfill feature. AUTOMATIC indicates that GameLift creates // backfill requests whenever a game session has one or more open slots. Learn more - // about manual and automatic backfill in Backfill existing games with FlexMatch - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html). - // Automatic backfill is not available when FlexMatchMode is set to STANDALONE. + // about manual and automatic backfill in Backfill existing games with FlexMatch (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html) + // . Automatic backfill is not available when FlexMatchMode is set to STANDALONE . BackfillMode BackfillMode - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift matchmaking configuration resource and uniquely + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift matchmaking configuration resource and uniquely // identifies it. ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::matchmakingconfiguration/. In a GameLift configuration ARN, + // arn:aws:gamelift:::matchmakingconfiguration/ . In a GameLift configuration ARN, // the resource ID matches the Name value. ConfigurationArn *string // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // Information to attach to all events related to the matchmaking configuration. @@ -1713,43 +1540,36 @@ type MatchmakingConfiguration struct { // Indicates whether this matchmaking configuration is being used with GameLift // hosting or as a standalone matchmaking solution. - // - // * STANDALONE - FlexMatch forms - // matches and returns match information, including players and team assignments, - // in a MatchmakingSucceeded - // (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) - // event. - // - // * WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift - // queue to start a game session for the match. + // - STANDALONE - FlexMatch forms matches and returns match information, + // including players and team assignments, in a MatchmakingSucceeded (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) + // event. + // - WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue + // to start a game session for the match. FlexMatchMode FlexMatchMode // A set of custom properties for a game session, formatted as key:value pairs. // These properties are passed to a game server process with a request to start a - // new game session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession object that is created for a - // successful match. This parameter is not used when FlexMatchMode is set to - // STANDALONE. + // new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the new GameSession object that is created for + // a successful match. This parameter is not used when FlexMatchMode is set to + // STANDALONE . GameProperties []GameProperty // A set of custom game session properties, formatted as a single string value. // This data is passed to a game server process with a request to start a new game - // session (see Start a Game Session - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). - // This information is added to the new GameSession object that is created for a - // successful match. This parameter is not used when FlexMatchMode is set to - // STANDALONE. + // session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) + // ). This information is added to the new GameSession object that is created for + // a successful match. This parameter is not used when FlexMatchMode is set to + // STANDALONE . GameSessionData *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift game session queue resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::gamesessionqueue/. Queues can be located in any Region. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift game session queue resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::gamesessionqueue/ . Queues can be located in any Region. // Queues are used to start new GameLift-hosted game sessions for matches that are // created with this matchmaking configuration. This property is not set when - // FlexMatchMode is set to STANDALONE. + // FlexMatchMode is set to STANDALONE . GameSessionQueueArns []string // A unique identifier for the matchmaking configuration. This name is used to @@ -1764,14 +1584,14 @@ type MatchmakingConfiguration struct { // resubmitted as needed. RequestTimeoutSeconds *int32 - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift matchmaking rule set resource that this configuration uses. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift matchmaking rule set resource that this + // configuration uses. RuleSetArn *string - // A unique identifier for the matchmaking rule set to use with this configuration. - // A matchmaking configuration can only use rule sets that are defined in the same - // Region. + // A unique identifier for the matchmaking rule set to use with this + // configuration. A matchmaking configuration can only use rule sets that are + // defined in the same Region. RuleSetName *string noSmithyDocumentSerde @@ -1781,35 +1601,28 @@ type MatchmakingConfiguration struct { // player matches. Each rule set describes a type of group to be created and // defines the parameters for acceptable player matches. A rule set may define the // following elements for a match. For detailed information and examples showing -// how to construct a rule set, see Build a FlexMatch rule set -// (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html). -// -// * -// Teams -- Required. A rule set must define one or multiple teams for the match -// and set minimum and maximum team sizes. For example, a rule set might describe a -// 4x4 match that requires all eight slots to be filled. -// -// * Player attributes -- -// Optional. These attributes specify a set of player characteristics to evaluate -// when looking for a match. Matchmaking requests that use a rule set with player -// attributes must provide the corresponding attribute values. For example, an -// attribute might specify a player's skill or level. -// -// * Rules -- Optional. Rules -// define how to evaluate potential players for a match based on player attributes. -// A rule might specify minimum requirements for individual players, teams, or -// entire matches. For example, a rule might require each player to meet a certain -// skill level, each team to have at least one player in a certain role, or the -// match to have a minimum average skill level. or may describe an entire -// group--such as all teams must be evenly matched or have at least one player in a -// certain role. -// -// * Expansions -- Optional. Expansions allow you to relax the rules -// after a period of time when no acceptable matches are found. This feature lets -// you balance getting players into games in a reasonable amount of time instead of -// making them wait indefinitely for the best possible match. For example, you -// might use an expansion to increase the maximum skill variance between players -// after 30 seconds. +// how to construct a rule set, see Build a FlexMatch rule set (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html) +// . +// - Teams -- Required. A rule set must define one or multiple teams for the +// match and set minimum and maximum team sizes. For example, a rule set might +// describe a 4x4 match that requires all eight slots to be filled. +// - Player attributes -- Optional. These attributes specify a set of player +// characteristics to evaluate when looking for a match. Matchmaking requests that +// use a rule set with player attributes must provide the corresponding attribute +// values. For example, an attribute might specify a player's skill or level. +// - Rules -- Optional. Rules define how to evaluate potential players for a +// match based on player attributes. A rule might specify minimum requirements for +// individual players, teams, or entire matches. For example, a rule might require +// each player to meet a certain skill level, each team to have at least one player +// in a certain role, or the match to have a minimum average skill level. or may +// describe an entire group--such as all teams must be evenly matched or have at +// least one player in a certain role. +// - Expansions -- Optional. Expansions allow you to relax the rules after a +// period of time when no acceptable matches are found. This feature lets you +// balance getting players into games in a reasonable amount of time instead of +// making them wait indefinitely for the best possible match. For example, you +// might use an expansion to increase the maximum skill variance between players +// after 30 seconds. type MatchmakingRuleSet struct { // A collection of matchmaking rules, formatted as a JSON string. Comments are not @@ -1819,15 +1632,14 @@ type MatchmakingRuleSet struct { RuleSetBody *string // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift matchmaking rule set resource and uniquely identifies it. - // ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::matchmakingruleset/. In a GameLift rule set ARN, the resource - // ID matches the RuleSetName value. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift matchmaking rule set resource and uniquely + // identifies it. ARNs are unique across all Regions. Format is + // arn:aws:gamelift:::matchmakingruleset/ . In a GameLift rule set ARN, the + // resource ID matches the RuleSetName value. RuleSetArn *string // A unique identifier for the matchmaking rule set @@ -1841,20 +1653,19 @@ type MatchmakingRuleSet struct { // matchmaking request. type MatchmakingTicket struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift matchmaking configuration resource that is used with this - // ticket. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift matchmaking configuration resource that is used + // with this ticket. ConfigurationArn *string - // Name of the matchmaking configuration that is used with this ticket. Matchmaking - // configurations determine how players are grouped into a match and how a new game - // session is created for the match. + // Name of the matchmaking configuration that is used with this ticket. + // Matchmaking configurations determine how players are grouped into a match and + // how a new game session is created for the match. ConfigurationName *string // Time stamp indicating when the matchmaking request stopped being processed due // to successful completion, timeout, or cancellation. Format is a number expressed - // in Unix time as milliseconds (for example "1469498468.057"). + // in Unix time as milliseconds (for example "1469498468.057" ). EndTime *time.Time // Average amount of time (in seconds) that players are currently waiting for a @@ -1863,55 +1674,40 @@ type MatchmakingTicket struct { // Connection information for a new game session. Once a match is made, the // FlexMatch engine creates a new game session for it. This information is added to - // the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking - // (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html) + // the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html) // . GameSessionConnectionInfo *GameSessionConnectionInfo - // A set of Player objects, each representing a player to find matches for. Players - // are identified by a unique player ID and may include latency data for use during - // matchmaking. If the ticket is in status COMPLETED, the Player objects include - // the team the players were assigned to in the resulting match. + // A set of Player objects, each representing a player to find matches for. + // Players are identified by a unique player ID and may include latency data for + // use during matchmaking. If the ticket is in status COMPLETED , the Player + // objects include the team the players were assigned to in the resulting match. Players []Player // Time stamp indicating when this matchmaking request was received. Format is a - // number expressed in Unix time as milliseconds (for example "1469498468.057"). + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). StartTime *time.Time // Current status of the matchmaking request. - // - // * QUEUED -- The matchmaking request - // has been received and is currently waiting to be processed. - // - // * SEARCHING -- The - // matchmaking request is currently being processed. - // - // * REQUIRES_ACCEPTANCE -- A - // match has been proposed and the players must accept the match. This status is - // used only with requests that use a matchmaking configuration with a player - // acceptance requirement. - // - // * PLACING -- The FlexMatch engine has matched players - // and is in the process of placing a new game session for the match. - // - // * COMPLETED - // -- Players have been matched and a game session is ready to host the players. A - // ticket in this state contains the necessary connection information for - // players. - // - // * FAILED -- The matchmaking request was not completed. - // - // * CANCELLED -- - // The matchmaking request was canceled. This may be the result of a - // StopMatchmaking operation or a proposed match that one or more players failed to - // accept. - // - // * TIMED_OUT -- The matchmaking request was not successful within the - // duration specified in the matchmaking configuration. - // - // Matchmaking requests that - // fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be - // resubmitted as new requests with new ticket IDs. + // - QUEUED -- The matchmaking request has been received and is currently + // waiting to be processed. + // - SEARCHING -- The matchmaking request is currently being processed. + // - REQUIRES_ACCEPTANCE -- A match has been proposed and the players must + // accept the match. This status is used only with requests that use a matchmaking + // configuration with a player acceptance requirement. + // - PLACING -- The FlexMatch engine has matched players and is in the process + // of placing a new game session for the match. + // - COMPLETED -- Players have been matched and a game session is ready to host + // the players. A ticket in this state contains the necessary connection + // information for players. + // - FAILED -- The matchmaking request was not completed. + // - CANCELLED -- The matchmaking request was canceled. This may be the result + // of a StopMatchmaking operation or a proposed match that one or more players + // failed to accept. + // - TIMED_OUT -- The matchmaking request was not successful within the duration + // specified in the matchmaking configuration. + // Matchmaking requests that fail to successfully complete (statuses FAILED, + // CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs. Status MatchmakingConfigurationStatus // Additional information about the current status. @@ -1930,8 +1726,7 @@ type MatchmakingTicket struct { // Information about a player session. This object contains only the player ID and // player session ID. To retrieve full details on a player session, call -// DescribePlayerSessions -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html) +// DescribePlayerSessions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html) // with the player session ID. type PlacedPlayerSession struct { @@ -1949,19 +1744,19 @@ type PlacedPlayerSession struct { // is added after a match has been successfully completed. type Player struct { - // A set of values, expressed in milliseconds, that indicates the amount of latency - // that a player experiences when connected to @aws; Regions. If this property is - // present, FlexMatch considers placing the match only in Regions for which latency - // is reported. If a matchmaker has a rule that evaluates player latency, players - // must report latency in order to be matched. If no latency is reported in this - // scenario, FlexMatch assumes that no Regions are available to the player and the - // ticket is not matchable. + // A set of values, expressed in milliseconds, that indicates the amount of + // latency that a player experiences when connected to @aws; Regions. If this + // property is present, FlexMatch considers placing the match only in Regions for + // which latency is reported. If a matchmaker has a rule that evaluates player + // latency, players must report latency in order to be matched. If no latency is + // reported in this scenario, FlexMatch assumes that no Regions are available to + // the player and the ticket is not matchable. LatencyInMs map[string]int32 // A collection of key:value pairs containing player information for use in // matchmaking. Player attribute keys must match the playerAttributes used in a // matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, - // "gameMode": {"S": "deathmatch"}}. You can provide up to 10 PlayerAttributes. + // "gameMode": {"S": "deathmatch"}} . You can provide up to 10 PlayerAttributes . PlayerAttributes map[string]AttributeValue // A unique identifier for a player @@ -2017,36 +1812,30 @@ type PlayerLatencyPolicy struct { // Represents a player session. Player sessions are created either for a specific // game session, or as part of a game session placement or matchmaking request. A // player session can represents a reserved player slot in a game session (when -// status is RESERVED) or actual player activity in a game session (when status is -// ACTIVE). A player session object, including player data, is automatically passed -// to a game session when the player connects to the game session and is validated. -// After the game session ends, player sessions information is retained for 30 days -// and then removed. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// status is RESERVED ) or actual player activity in a game session (when status is +// ACTIVE ). A player session object, including player data, is automatically +// passed to a game session when the player connects to the game session and is +// validated. After the game session ends, player sessions information is retained +// for 30 days and then removed. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type PlayerSession struct { // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // The DNS identifier assigned to the instance that is running the game session. // Values have the following format: - // - // * TLS-enabled fleets: - // ..amazongamelift.com. - // - // * Non-TLS-enabled fleets: ec2-.compute.amazonaws.com. - // (See Amazon EC2 Instance IP Addressing - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses).) - // - // When - // connecting to a game session that is running on a TLS-enabled fleet, you must - // use the DNS name, not the IP address. + // - TLS-enabled fleets: ..amazongamelift.com . + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See Amazon EC2 + // Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) + // .) + // When connecting to a game session that is running on a TLS-enabled fleet, you + // must use the DNS name, not the IP address. DnsName *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift fleet that the player's game session is running on. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift fleet that the player's game session is running + // on. FleetArn *string // A unique identifier for the fleet that the player's game session is running on. @@ -2056,8 +1845,8 @@ type PlayerSession struct { // to. GameSessionId *string - // The IP address of the game session. To connect to a GameLift game server, an app - // needs both the IP address and port number. + // The IP address of the game session. To connect to a GameLift game server, an + // app needs both the IP address and port number. IpAddress *string // Developer-defined information related to a player. GameLift does not use this @@ -2076,23 +1865,17 @@ type PlayerSession struct { // Current status of the player session. Possible player session statuses include // the following: - // - // * RESERVED -- The player session request has been received, but - // the player has not yet connected to the server process and/or been validated. - // - // * - // ACTIVE -- The player has been validated by the server process and is currently - // connected. - // - // * COMPLETED -- The player connection has been dropped. - // - // * TIMEDOUT - // -- A player session request was received, but the player did not connect and/or - // was not validated within the timeout limit (60 seconds). + // - RESERVED -- The player session request has been received, but the player + // has not yet connected to the server process and/or been validated. + // - ACTIVE -- The player has been validated by the server process and is + // currently connected. + // - COMPLETED -- The player connection has been dropped. + // - TIMEDOUT -- A player session request was received, but the player did not + // connect and/or was not validated within the timeout limit (60 seconds). Status PlayerSessionStatus - // A time stamp indicating when this data object was terminated. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // A time stamp indicating when this data object was terminated. Format is a + // number expressed in Unix time as milliseconds (for example "1469498468.057" ). TerminationTime *time.Time noSmithyDocumentSerde @@ -2101,48 +1884,38 @@ type PlayerSession struct { // Custom prioritization settings for use by a game session queue when placing new // game sessions with available game servers. When defined, this configuration // replaces the default FleetIQ prioritization process, which is as follows: +// - If player latency data is included in a game session request, destinations +// and locations are prioritized first based on lowest average latency (1), then on +// lowest hosting cost (2), then on destination list order (3), and finally on +// location (alphabetical) (4). This approach ensures that the queue's top priority +// is to place game sessions where average player latency is lowest, and--if +// latency is the same--where the hosting cost is less, etc. +// - If player latency data is not included, destinations and locations are +// prioritized first on destination list order (1), and then on location +// (alphabetical) (2). This approach ensures that the queue's top priority is to +// place game sessions on the first destination fleet listed. If that fleet has +// multiple locations, the game session is placed on the first location (when +// listed alphabetically). // -// * If -// player latency data is included in a game session request, destinations and -// locations are prioritized first based on lowest average latency (1), then on -// lowest hosting cost (2), then on destination list order (3), and finally on -// location (alphabetical) (4). This approach ensures that the queue's top priority -// is to place game sessions where average player latency is lowest, and--if -// latency is the same--where the hosting cost is less, etc. -// -// * If player latency -// data is not included, destinations and locations are prioritized first on -// destination list order (1), and then on location (alphabetical) (2). This -// approach ensures that the queue's top priority is to place game sessions on the -// first destination fleet listed. If that fleet has multiple locations, the game -// session is placed on the first location (when listed alphabetically). -// -// Changing -// the priority order will affect how game sessions are placed. +// Changing the priority order will affect how game sessions are placed. type PriorityConfiguration struct { // The prioritization order to use for fleet locations, when the PriorityOrder - // property includes LOCATION. Locations are identified by Amazon Web Services - // Region codes such as us-west-2. Each location can only be listed once. + // property includes LOCATION . Locations are identified by Amazon Web Services + // Region codes such as us-west-2 . Each location can only be listed once. LocationOrder []string // The recommended sequence to use when prioritizing where to place new game // sessions. Each type can only be listed once. - // - // * LATENCY -- FleetIQ prioritizes - // locations where the average player latency (provided in each game session - // request) is lowest. - // - // * COST -- FleetIQ prioritizes destinations with the lowest - // current hosting costs. Cost is evaluated based on the location, instance type, - // and fleet type (Spot or On-Demand) for each destination in the queue. - // - // * - // DESTINATION -- FleetIQ prioritizes based on the order that destinations are - // listed in the queue configuration. - // - // * LOCATION -- FleetIQ prioritizes based on - // the provided order of locations, as defined in LocationOrder. + // - LATENCY -- FleetIQ prioritizes locations where the average player latency + // (provided in each game session request) is lowest. + // - COST -- FleetIQ prioritizes destinations with the lowest current hosting + // costs. Cost is evaluated based on the location, instance type, and fleet type + // (Spot or On-Demand) for each destination in the queue. + // - DESTINATION -- FleetIQ prioritizes based on the order that destinations are + // listed in the queue configuration. + // - LOCATION -- FleetIQ prioritizes based on the provided order of locations, as + // defined in LocationOrder . PriorityOrder []PriorityType noSmithyDocumentSerde @@ -2152,7 +1925,7 @@ type PriorityConfiguration struct { // create within a specified span of time. With this policy, you can control // players' ability to consume available resources. The policy is evaluated when a // player tries to create a new game session. On receiving a CreateGameSession -// request, GameLift checks that the player (identified by CreatorId) has created +// request, GameLift checks that the player (identified by CreatorId ) has created // fewer than game session limit in the specified time period. type ResourceCreationLimitPolicy struct { @@ -2160,7 +1933,7 @@ type ResourceCreationLimitPolicy struct { // create within a specified span of time. With this policy, you can control // players' ability to consume available resources. The policy is evaluated when a // player tries to create a new game session. On receiving a CreateGameSession - // request, GameLift checks that the player (identified by CreatorId) has created + // request, GameLift checks that the player (identified by CreatorId ) has created // fewer than game session limit in the specified time period. NewGameSessionsPerCreator *int32 @@ -2170,8 +1943,7 @@ type ResourceCreationLimitPolicy struct { noSmithyDocumentSerde } -// The routing configuration for a fleet alias. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// The routing configuration for a fleet alias. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type RoutingStrategy struct { // A unique identifier for the fleet that the alias points to. This value is the @@ -2183,34 +1955,32 @@ type RoutingStrategy struct { // The type of routing strategy for the alias. Possible routing types include the // following: - // - // * SIMPLE - The alias resolves to one specific fleet. Use this type - // when routing to active fleets. - // - // * TERMINAL - The alias does not resolve to a - // fleet but instead can be used to display a message to the user. A terminal alias - // throws a TerminalRoutingStrategyException with the message embedded. + // - SIMPLE - The alias resolves to one specific fleet. Use this type when + // routing to active fleets. + // - TERMINAL - The alias does not resolve to a fleet but instead can be used to + // display a message to the user. A terminal alias throws a + // TerminalRoutingStrategyException with the message embedded. Type RoutingStrategyType noSmithyDocumentSerde } -// A collection of server process configurations that describe the set of processes -// to run on each instance in a fleet. Server processes run either an executable in -// a custom game build or a Realtime Servers script. GameLift launches the -// configured processes, manages their life cycle, and replaces them as needed. -// Each instance checks regularly for an updated runtime configuration. A GameLift -// instance is limited to 50 processes running concurrently. To calculate the total -// number of processes in a runtime configuration, add the values of the -// ConcurrentExecutions parameter for each server process. Learn more about -// Running Multiple Processes on a Fleet -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html). +// A collection of server process configurations that describe the set of +// processes to run on each instance in a fleet. Server processes run either an +// executable in a custom game build or a Realtime Servers script. GameLift +// launches the configured processes, manages their life cycle, and replaces them +// as needed. Each instance checks regularly for an updated runtime configuration. +// A GameLift instance is limited to 50 processes running concurrently. To +// calculate the total number of processes in a runtime configuration, add the +// values of the ConcurrentExecutions parameter for each server process. Learn +// more about Running Multiple Processes on a Fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html) +// . type RuntimeConfiguration struct { - // The maximum amount of time (in seconds) allowed to launch a new game session and - // have it report ready to host players. During this time, the game session is in - // status ACTIVATING. If the game session does not become active before the - // timeout, it is ended and the game session status is changed to TERMINATED. + // The maximum amount of time (in seconds) allowed to launch a new game session + // and have it report ready to host players. During this time, the game session is + // in status ACTIVATING . If the game session does not become active before the + // timeout, it is ended and the game session status is changed to TERMINATED . GameSessionActivationTimeoutSeconds *int32 // The number of game sessions in status ACTIVATING to allow on an instance. This @@ -2242,9 +2012,8 @@ type S3Location struct { // not set, the latest version of the file is retrieved. ObjectVersion *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM - // role that allows Amazon GameLift to access the S3 bucket. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) for an IAM role that allows Amazon GameLift to access the S3 bucket. RoleArn *string noSmithyDocumentSerde @@ -2257,15 +2026,14 @@ type ScalingPolicy struct { // Comparison operator to use when measuring a metric against the threshold value. ComparisonOperator ComparisonOperatorType - // Length of time (in minutes) the metric must be at or beyond the threshold before - // a scaling event is triggered. + // Length of time (in minutes) the metric must be at or beyond the threshold + // before a scaling event is triggered. EvaluationPeriods *int32 - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift fleet resource and uniquely identifies it. ARNs are - // unique across all Regions. Format is - // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs + // are unique across all Regions. Format is + // arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . FleetArn *string // A unique identifier for the fleet that is associated with this scaling policy. @@ -2276,48 +2044,30 @@ type ScalingPolicy struct { // Name of the Amazon GameLift-defined metric that is used to trigger a scaling // adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon - // GameLift with Amazon CloudWatch - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html). - // - // * - // ActivatingGameSessions -- Game sessions in the process of being created. - // - // * - // ActiveGameSessions -- Game sessions that are currently running. - // - // * - // ActiveInstances -- Fleet instances that are currently running at least one game - // session. - // - // * AvailableGameSessions -- Additional game sessions that fleet could - // host simultaneously, given current capacity. - // - // * AvailablePlayerSessions -- Empty - // player slots in currently active game sessions. This includes game sessions that - // are not currently accepting players. Reserved player slots are not included. - // - // * - // CurrentPlayerSessions -- Player slots in active game sessions that are being - // used by a player or are reserved for a player. - // - // * IdleInstances -- Active - // instances that are currently hosting zero game sessions. - // - // * - // PercentAvailableGameSessions -- Unused percentage of the total number of game - // sessions that a fleet could host simultaneously, given current capacity. Use - // this metric for a target-based scaling policy. - // - // * PercentIdleInstances -- - // Percentage of the total number of active instances that are hosting zero game - // sessions. - // - // * QueueDepth -- Pending game session placement requests, in any - // queue, where the current fleet is the top-priority destination. - // - // * WaitTime -- - // Current wait time for pending game session placement requests, in any queue, - // where the current fleet is the top-priority destination. + // GameLift with Amazon CloudWatch (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html) + // . + // - ActivatingGameSessions -- Game sessions in the process of being created. + // - ActiveGameSessions -- Game sessions that are currently running. + // - ActiveInstances -- Fleet instances that are currently running at least one + // game session. + // - AvailableGameSessions -- Additional game sessions that fleet could host + // simultaneously, given current capacity. + // - AvailablePlayerSessions -- Empty player slots in currently active game + // sessions. This includes game sessions that are not currently accepting players. + // Reserved player slots are not included. + // - CurrentPlayerSessions -- Player slots in active game sessions that are + // being used by a player or are reserved for a player. + // - IdleInstances -- Active instances that are currently hosting zero game + // sessions. + // - PercentAvailableGameSessions -- Unused percentage of the total number of + // game sessions that a fleet could host simultaneously, given current capacity. + // Use this metric for a target-based scaling policy. + // - PercentIdleInstances -- Percentage of the total number of active instances + // that are hosting zero game sessions. + // - QueueDepth -- Pending game session placement requests, in any queue, where + // the current fleet is the top-priority destination. + // - WaitTime -- Current wait time for pending game session placement requests, + // in any queue, where the current fleet is the top-priority destination. MetricName MetricName // A descriptive label that is associated with a fleet's scaling policy. Policy @@ -2335,44 +2085,29 @@ type ScalingPolicy struct { ScalingAdjustment int32 // The type of adjustment to make to a fleet's instance count. - // - // * ChangeInCapacity - // -- add (or subtract) the scaling adjustment value from the current instance - // count. Positive values scale up while negative values scale down. - // - // * - // ExactCapacity -- set the instance count to the scaling adjustment value. - // - // * - // PercentChangeInCapacity -- increase or reduce the current instance count by the - // scaling adjustment, read as a percentage. Positive values scale up while - // negative values scale down. + // - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the + // current instance count. Positive values scale up while negative values scale + // down. + // - ExactCapacity -- set the instance count to the scaling adjustment value. + // - PercentChangeInCapacity -- increase or reduce the current instance count by + // the scaling adjustment, read as a percentage. Positive values scale up while + // negative values scale down. ScalingAdjustmentType ScalingAdjustmentType // Current status of the scaling policy. The scaling policy can be in force only // when in an ACTIVE status. Scaling policies can be suspended for individual // fleets. If the policy is suspended for a fleet, the policy status does not // change. - // - // * ACTIVE -- The scaling policy can be used for auto-scaling a fleet. - // - // * - // UPDATE_REQUESTED -- A request to update the scaling policy has been received. - // - // * - // UPDATING -- A change is being made to the scaling policy. - // - // * DELETE_REQUESTED -- - // A request to delete the scaling policy has been received. - // - // * DELETING -- The - // scaling policy is being deleted. - // - // * DELETED -- The scaling policy has been - // deleted. - // - // * ERROR -- An error occurred in creating the policy. It should be - // removed and recreated. + // - ACTIVE -- The scaling policy can be used for auto-scaling a fleet. + // - UPDATE_REQUESTED -- A request to update the scaling policy has been + // received. + // - UPDATING -- A change is being made to the scaling policy. + // - DELETE_REQUESTED -- A request to delete the scaling policy has been + // received. + // - DELETING -- The scaling policy is being deleted. + // - DELETED -- The scaling policy has been deleted. + // - ERROR -- An error occurred in creating the policy. It should be removed and + // recreated. Status ScalingStatusType // An object that contains settings for a target-based scaling policy. @@ -2389,23 +2124,21 @@ type ScalingPolicy struct { noSmithyDocumentSerde } -// Properties describing a Realtime script. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Properties describing a Realtime script. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Script struct { // A time stamp indicating when this data object was created. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time // A descriptive label that is associated with a script. Script names do not need // to be unique. Name *string - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is - // assigned to a GameLift script resource and uniquely identifies it. ARNs are - // unique across all Regions. In a GameLift script ARN, the resource ID matches the - // ScriptId value. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) that is assigned to a GameLift script resource and uniquely identifies it. + // ARNs are unique across all Regions. In a GameLift script ARN, the resource ID + // matches the ScriptId value. ScriptArn *string // A unique identifier for the Realtime script @@ -2438,8 +2171,8 @@ type Script struct { // runtime configuration. type ServerProcess struct { - // The number of server processes using this configuration that run concurrently on - // each instance. + // The number of server processes using this configuration that run concurrently + // on each instance. // // This member is required. ConcurrentExecutions *int32 @@ -2447,12 +2180,10 @@ type ServerProcess struct { // The location of a game build executable or the Realtime script file that // contains the Init() function. Game builds and Realtime scripts are installed on // instances at the root: - // - // * Windows (custom game builds only): C:\game. Example: - // "C:\game\MyGame\server.exe" - // - // * Linux: /local/game. Examples: - // "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" + // - Windows (custom game builds only): C:\game . Example: " + // C:\game\MyGame\server.exe " + // - Linux: /local/game . Examples: " /local/game/MyGame/server.exe " or " + // /local/game/MyRealtimeScript.js " // // This member is required. LaunchPath *string @@ -2465,12 +2196,10 @@ type ServerProcess struct { } // A label that can be assigned to a GameLift resource. Learn more Tagging Amazon -// Web Services Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference Amazon Web Services Tagging Strategies -// (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference Amazon Web Services Tagging +// Strategies (http://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type Tag struct { // The key for a developer-defined key:value pair for tagging an Amazon Web @@ -2509,8 +2238,7 @@ type TargetConfiguration struct { // This data type is used with the GameLift FleetIQ and game server groups. // Settings for a target-based scaling policy as part of a -// GameServerGroupAutoScalingPolicy -// (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html) +// GameServerGroupAutoScalingPolicy (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html) // . These settings are used to create a target-based policy that tracks the // GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target // value for the metric. As player usage changes, the policy triggers to adjust the @@ -2529,17 +2257,16 @@ type TargetTrackingConfiguration struct { // Amazon GameLift fleet and another VPC on an account you have access to. This // authorization must exist and be valid for the peering connection to be // established. Authorizations are valid for 24 hours after they are issued. -// Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type VpcPeeringAuthorization struct { // Time stamp indicating when this authorization was issued. Format is a number - // expressed in Unix time as milliseconds (for example "1469498468.057"). + // expressed in Unix time as milliseconds (for example "1469498468.057" ). CreationTime *time.Time - // Time stamp indicating when this authorization expires (24 hours after issuance). - // Format is a number expressed in Unix time as milliseconds (for example - // "1469498468.057"). + // Time stamp indicating when this authorization expires (24 hours after + // issuance). Format is a number expressed in Unix time as milliseconds (for + // example "1469498468.057" ). ExpirationTime *time.Time // A unique identifier for the Amazon Web Services account that you use to manage @@ -2554,32 +2281,30 @@ type VpcPeeringAuthorization struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . PeerVpcId *string noSmithyDocumentSerde } -// Represents a peering connection between a VPC on one of your Amazon Web Services -// accounts and the VPC for your Amazon GameLift fleets. This record may be for an -// active peering connection or a pending connection that has not yet been -// established. Related actions All APIs by task -// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// Represents a peering connection between a VPC on one of your Amazon Web +// Services accounts and the VPC for your Amazon GameLift fleets. This record may +// be for an active peering connection or a pending connection that has not yet +// been established. Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) type VpcPeeringConnection struct { - // The Amazon Resource Name (ARN - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) associated - // with the GameLift fleet resource for this connection. + // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) + // ) associated with the GameLift fleet resource for this connection. FleetArn *string // A unique identifier for the fleet. This ID determines the ID of the Amazon // GameLift VPC for your fleet. FleetId *string - // A unique identifier for the VPC that contains the Amazon GameLift fleet for this - // connection. This VPC is managed by Amazon GameLift and does not appear in your - // Amazon Web Services account. + // A unique identifier for the VPC that contains the Amazon GameLift fleet for + // this connection. This VPC is managed by Amazon GameLift and does not appear in + // your Amazon Web Services account. GameLiftVpcId *string // CIDR block of IPv4 addresses assigned to the VPC peering connection for the @@ -2591,12 +2316,12 @@ type VpcPeeringConnection struct { // fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, // use the VPC Dashboard (https://console.aws.amazon.com/vpc/) in the Amazon Web // Services Management Console. Learn more about VPC peering in VPC Peering with - // GameLift Fleets - // (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html). + // GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) + // . PeerVpcId *string - // The status information about the connection. Status indicates if a connection is - // pending, successful, or failed. + // The status information about the connection. Status indicates if a connection + // is pending, successful, or failed. Status *VpcPeeringConnectionStatus // A unique identifier that is automatically assigned to the connection record. @@ -2608,9 +2333,8 @@ type VpcPeeringConnection struct { } // Represents status information for a VPC peering connection. Status codes and -// messages are provided from EC2 (see VpcPeeringConnectionStateReason -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpcPeeringConnectionStateReason.html)). -// Connection status information is also communicated as a fleet event. +// messages are provided from EC2 (see VpcPeeringConnectionStateReason (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpcPeeringConnectionStateReason.html) +// ). Connection status information is also communicated as a fleet event. type VpcPeeringConnectionStatus struct { // Code indicating the status of a VPC peering connection. diff --git a/service/gamesparks/api_client.go b/service/gamesparks/api_client.go index 761b8999eaa..3140957f8e4 100644 --- a/service/gamesparks/api_client.go +++ b/service/gamesparks/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/gamesparks/api_op_CreateGame.go b/service/gamesparks/api_op_CreateGame.go index bc4320679a0..0984d8bd2e9 100644 --- a/service/gamesparks/api_op_CreateGame.go +++ b/service/gamesparks/api_op_CreateGame.go @@ -13,7 +13,7 @@ import ( // Creates a new game with an empty configuration. After creating your game, you // can update the configuration using UpdateGameConfiguration or -// ImportGameConfiguration. +// ImportGameConfiguration . func (c *Client) CreateGame(ctx context.Context, params *CreateGameInput, optFns ...func(*Options)) (*CreateGameOutput, error) { if params == nil { params = &CreateGameInput{} diff --git a/service/gamesparks/api_op_StartGeneratedCodeJob.go b/service/gamesparks/api_op_StartGeneratedCodeJob.go index 177c80d721a..620ab884ea7 100644 --- a/service/gamesparks/api_op_StartGeneratedCodeJob.go +++ b/service/gamesparks/api_op_StartGeneratedCodeJob.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an asynchronous process that generates client code for system-defined and -// custom messages. The resulting code is collected as a .zip file and uploaded to -// a pre-signed Amazon S3 URL. +// Starts an asynchronous process that generates client code for system-defined +// and custom messages. The resulting code is collected as a .zip file and uploaded +// to a pre-signed Amazon S3 URL. func (c *Client) StartGeneratedCodeJob(ctx context.Context, params *StartGeneratedCodeJobInput, optFns ...func(*Options)) (*StartGeneratedCodeJobOutput, error) { if params == nil { params = &StartGeneratedCodeJobInput{} diff --git a/service/gamesparks/api_op_StartStageDeployment.go b/service/gamesparks/api_op_StartStageDeployment.go index 7417c765269..caf68671f57 100644 --- a/service/gamesparks/api_op_StartStageDeployment.go +++ b/service/gamesparks/api_op_StartStageDeployment.go @@ -12,8 +12,8 @@ import ( ) // Deploys a snapshot to the stage and creates a new game runtime. After you call -// this operation, you can check the deployment status by using GetStageDeployment. -// If there are any players connected to the previous game runtime, then both +// this operation, you can check the deployment status by using GetStageDeployment +// . If there are any players connected to the previous game runtime, then both // runtimes persist. Existing connections to the previous runtime are maintained. // When players disconnect and reconnect, they connect to the new runtime. After // there are no connections to the previous game runtime, it is deleted. diff --git a/service/gamesparks/document/document.go b/service/gamesparks/document/document.go index b7e03bc4c12..4bb3758cdeb 100644 --- a/service/gamesparks/document/document.go +++ b/service/gamesparks/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/gamesparks/internal/document/document.go b/service/gamesparks/internal/document/document.go index e407ab0bece..53260bb4c13 100644 --- a/service/gamesparks/internal/document/document.go +++ b/service/gamesparks/internal/document/document.go @@ -15,8 +15,8 @@ type smithyDocument interface { isSmithyDocument() } -// github.com/aws/aws-sdk-go-v2/service/gamesparks/internal/document.Interface is a -// JSON-like data model type that is protocol agnostic and is usedto send +// github.com/aws/aws-sdk-go-v2/service/gamesparks/internal/document.Interface is +// a JSON-like data model type that is protocol agnostic and is usedto send // open-content to a service. type Interface interface { smithyDocument diff --git a/service/gamesparks/types/enums.go b/service/gamesparks/types/enums.go index 573d8550f22..67726fcd269 100644 --- a/service/gamesparks/types/enums.go +++ b/service/gamesparks/types/enums.go @@ -50,9 +50,9 @@ const ( GameStateDeleting GameState = "DELETING" ) -// Values returns all known values for GameState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for GameState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (GameState) Values() []GameState { return []GameState{ "ACTIVE", @@ -70,8 +70,8 @@ const ( GeneratedCodeJobStatePending GeneratedCodeJobState = "PENDING" ) -// Values returns all known values for GeneratedCodeJobState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GeneratedCodeJobState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GeneratedCodeJobState) Values() []GeneratedCodeJobState { return []GeneratedCodeJobState{ @@ -91,9 +91,9 @@ const ( OperationReplace Operation = "REPLACE" ) -// Values returns all known values for Operation. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operation. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operation) Values() []Operation { return []Operation{ "ADD", diff --git a/service/gamesparks/types/types.go b/service/gamesparks/types/types.go index 825924fc52e..51762e6bede 100644 --- a/service/gamesparks/types/types.go +++ b/service/gamesparks/types/types.go @@ -159,9 +159,9 @@ type Generator struct { // The target version of the GameSparks Game SDK. GameSdkVersion *string - // The programming language for the generated code. Not all languages are supported - // for each platform. For cases where multiple languages are supported, this - // parameter specifies the language to be used. If this value is omitted, the + // The programming language for the generated code. Not all languages are + // supported for each platform. For cases where multiple languages are supported, + // this parameter specifies the language to be used. If this value is omitted, the // default language for the target platform will be used. Language *string @@ -325,8 +325,8 @@ type StageDetails struct { // The description of the stage. Description *string - // The game key associated with the stage. The game key is a unique identifier that - // the game client uses to connect to the GameSparks backend. + // The game key associated with the stage. The game key is a unique identifier + // that the game client uses to connect to the GameSparks backend. GameKey *string // The timestamp of when the stage was last updated. @@ -357,8 +357,8 @@ type StageSummary struct { // The description of the stage. Description *string - // The game key associated with the stage. The game key is a unique identifier that - // the game client uses to connect to the GameSparks backend. + // The game key associated with the stage. The game key is a unique identifier + // that the game client uses to connect to the GameSparks backend. GameKey *string // The name of the stage. diff --git a/service/glacier/api_client.go b/service/glacier/api_client.go index ab825a1287a..d76c286a2e5 100644 --- a/service/glacier/api_client.go +++ b/service/glacier/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/glacier/api_op_AbortMultipartUpload.go b/service/glacier/api_op_AbortMultipartUpload.go index fc857cdae01..1d96478a18b 100644 --- a/service/glacier/api_op_AbortMultipartUpload.go +++ b/service/glacier/api_op_AbortMultipartUpload.go @@ -16,18 +16,15 @@ import ( // multipart upload or complete the multipart upload. Aborting a completed upload // fails. However, aborting an already-aborted upload will succeed, for a short // time. For more information about uploading a part and completing a multipart -// upload, see UploadMultipartPart and CompleteMultipartUpload. This operation is +// upload, see UploadMultipartPart and CompleteMultipartUpload . This operation is // idempotent. An AWS account has full permission to perform all operations // (actions). However, AWS Identity and Access Management (IAM) users don't have // any permissions by default. You must grant them explicit permission to perform // specific actions. For more information, see Access Control Using AWS Identity -// and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Working with Archives in -// Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) -// and Abort Multipart Upload -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html) +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Working with Archives +// in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// and Abort Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html) // in the Amazon Glacier Developer Guide. func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipartUploadInput, optFns ...func(*Options)) (*AbortMultipartUploadOutput, error) { if params == nil { @@ -45,15 +42,14 @@ func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipar } // Provides options to abort a multipart upload identified by the upload ID. For -// information about the underlying REST API, see Abort Multipart Upload -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html). -// For conceptual information, see Working with Archives in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html). +// information about the underlying REST API, see Abort Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html) +// . For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// . type AbortMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_AbortVaultLock.go b/service/glacier/api_op_AbortVaultLock.go index bca417e6e66..40ac52fe259 100644 --- a/service/glacier/api_op_AbortVaultLock.go +++ b/service/glacier/api_op_AbortVaultLock.go @@ -15,15 +15,13 @@ import ( // Locked state. If the vault lock is in the Locked state when this operation is // requested, the operation returns an AccessDeniedException error. Aborting the // vault locking process removes the vault lock policy from the specified vault. A -// vault lock is put into the InProgress state by calling InitiateVaultLock. A -// vault lock is put into the Locked state by calling CompleteVaultLock. You can -// get the state of a vault lock by calling GetVaultLock. For more information -// about the vault locking process, see Amazon Glacier Vault Lock -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html). For more -// information about vault lock policies, see Amazon Glacier Access Control with -// Vault Lock Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html). -// This operation is idempotent. You can successfully invoke this operation +// vault lock is put into the InProgress state by calling InitiateVaultLock . A +// vault lock is put into the Locked state by calling CompleteVaultLock . You can +// get the state of a vault lock by calling GetVaultLock . For more information +// about the vault locking process, see Amazon Glacier Vault Lock (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html) +// . For more information about vault lock policies, see Amazon Glacier Access +// Control with Vault Lock Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html) +// . This operation is idempotent. You can successfully invoke this operation // multiple times, if the vault lock is in the InProgress state or if there is no // policy associated with the vault. func (c *Client) AbortVaultLock(ctx context.Context, params *AbortVaultLockInput, optFns ...func(*Options)) (*AbortVaultLockOutput, error) { @@ -41,14 +39,14 @@ func (c *Client) AbortVaultLock(ctx context.Context, params *AbortVaultLockInput return out, nil } -// The input values for AbortVaultLock. +// The input values for AbortVaultLock . type AbortVaultLockInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. diff --git a/service/glacier/api_op_AddTagsToVault.go b/service/glacier/api_op_AddTagsToVault.go index 3d6cef2343f..759d9c11fef 100644 --- a/service/glacier/api_op_AddTagsToVault.go +++ b/service/glacier/api_op_AddTagsToVault.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation adds the specified tags to a vault. Each tag is composed of a key -// and a value. Each vault can have up to 10 tags. If your request would cause the -// tag limit for the vault to be exceeded, the operation throws the +// This operation adds the specified tags to a vault. Each tag is composed of a +// key and a value. Each vault can have up to 10 tags. If your request would cause +// the tag limit for the vault to be exceeded, the operation throws the // LimitExceededException error. If a tag already exists on the vault under a // specified key, the existing key value will be overwritten. For more information -// about tags, see Tagging Amazon S3 Glacier Resources -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html). +// about tags, see Tagging Amazon S3 Glacier Resources (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html) +// . func (c *Client) AddTagsToVault(ctx context.Context, params *AddTagsToVaultInput, optFns ...func(*Options)) (*AddTagsToVaultOutput, error) { if params == nil { params = &AddTagsToVaultInput{} @@ -33,12 +33,12 @@ func (c *Client) AddTagsToVault(ctx context.Context, params *AddTagsToVaultInput return out, nil } -// The input values for AddTagsToVault. +// The input values for AddTagsToVault . type AddTagsToVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_CompleteMultipartUpload.go b/service/glacier/api_op_CompleteMultipartUpload.go index c4d986c9470..2cc563591c7 100644 --- a/service/glacier/api_op_CompleteMultipartUpload.go +++ b/service/glacier/api_op_CompleteMultipartUpload.go @@ -18,17 +18,16 @@ import ( // URI path, you can then access the archive. After you upload an archive, you // should save the archive ID returned to retrieve the archive at a later point. // You can also get the vault inventory to obtain a list of archive IDs in a vault. -// For more information, see InitiateJob. In the request, you must include the +// For more information, see InitiateJob . In the request, you must include the // computed SHA256 tree hash of the entire archive you have uploaded. For -// information about computing a SHA256 tree hash, see Computing Checksums -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html). -// On the server side, Glacier also constructs the SHA256 tree hash of the +// information about computing a SHA256 tree hash, see Computing Checksums (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html) +// . On the server side, Glacier also constructs the SHA256 tree hash of the // assembled archive. If the values match, Glacier saves the archive to the vault; -// otherwise, it returns an error, and the operation fails. The ListParts operation -// returns a list of parts uploaded for a specific multipart upload. It includes -// checksum information for each uploaded part that can be used to debug a bad -// checksum issue. Additionally, Glacier also checks for any missing content ranges -// when assembling the archive, if missing content ranges are found, Glacier +// otherwise, it returns an error, and the operation fails. The ListParts +// operation returns a list of parts uploaded for a specific multipart upload. It +// includes checksum information for each uploaded part that can be used to debug a +// bad checksum issue. Additionally, Glacier also checks for any missing content +// ranges when assembling the archive, if missing content ranges are found, Glacier // returns an error and the operation fails. Complete Multipart Upload is an // idempotent operation. After your first successful complete multipart upload, if // you call the operation again within a short period, the operation will succeed @@ -41,14 +40,11 @@ import ( // idempotent complete is possible. An AWS account has full permission to perform // all operations (actions). However, AWS Identity and Access Management (IAM) // users don't have any permissions by default. You must grant them explicit -// permission to perform specific actions. For more information, see Access Control -// Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Uploading Large Archives -// in Parts (Multipart Upload) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) -// and Complete Multipart Upload -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html) +// permission to perform specific actions. For more information, see Access +// Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Uploading Large +// Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) +// and Complete Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html) // in the Amazon Glacier Developer Guide. func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error) { if params == nil { @@ -73,8 +69,8 @@ func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMu type CompleteMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -91,8 +87,8 @@ type CompleteMultipartUploadInput struct { // This member is required. VaultName *string - // The total size, in bytes, of the entire archive. This value should be the sum of - // all the sizes of the individual parts that you uploaded. + // The total size, in bytes, of the entire archive. This value should be the sum + // of all the sizes of the individual parts that you uploaded. ArchiveSize *string // The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree @@ -105,10 +101,9 @@ type CompleteMultipartUploadInput struct { } // Contains the Amazon S3 Glacier response to your request. For information about -// the underlying REST API, see Upload Archive -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). -// For conceptual information, see Working with Archives in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html). +// the underlying REST API, see Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) +// . For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// . type CompleteMultipartUploadOutput struct { // The ID of the archive. This value is also included as part of the location. diff --git a/service/glacier/api_op_CompleteVaultLock.go b/service/glacier/api_op_CompleteVaultLock.go index c08235ddf9d..d2e1ea2472f 100644 --- a/service/glacier/api_op_CompleteVaultLock.go +++ b/service/glacier/api_op_CompleteVaultLock.go @@ -14,16 +14,16 @@ import ( // This operation completes the vault locking process by transitioning the vault // lock from the InProgress state to the Locked state, which causes the vault lock // policy to become unchangeable. A vault lock is put into the InProgress state by -// calling InitiateVaultLock. You can obtain the state of the vault lock by calling -// GetVaultLock. For more information about the vault locking process, Amazon -// Glacier Vault Lock -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html). This -// operation is idempotent. This request is always successful if the vault lock is -// in the Locked state and the provided lock ID matches the lock ID originally used -// to lock the vault. If an invalid lock ID is passed in the request when the vault -// lock is in the Locked state, the operation returns an AccessDeniedException -// error. If an invalid lock ID is passed in the request when the vault lock is in -// the InProgress state, the operation throws an InvalidParameter error. +// calling InitiateVaultLock . You can obtain the state of the vault lock by +// calling GetVaultLock . For more information about the vault locking process, +// Amazon Glacier Vault Lock (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html) +// . This operation is idempotent. This request is always successful if the vault +// lock is in the Locked state and the provided lock ID matches the lock ID +// originally used to lock the vault. If an invalid lock ID is passed in the +// request when the vault lock is in the Locked state, the operation returns an +// AccessDeniedException error. If an invalid lock ID is passed in the request when +// the vault lock is in the InProgress state, the operation throws an +// InvalidParameter error. func (c *Client) CompleteVaultLock(ctx context.Context, params *CompleteVaultLockInput, optFns ...func(*Options)) (*CompleteVaultLockOutput, error) { if params == nil { params = &CompleteVaultLockInput{} @@ -39,14 +39,14 @@ func (c *Client) CompleteVaultLock(ctx context.Context, params *CompleteVaultLoc return out, nil } -// The input values for CompleteVaultLock. +// The input values for CompleteVaultLock . type CompleteVaultLockInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. diff --git a/service/glacier/api_op_CreateVault.go b/service/glacier/api_op_CreateVault.go index b9aa66e467f..40fb16324cb 100644 --- a/service/glacier/api_op_CreateVault.go +++ b/service/glacier/api_op_CreateVault.go @@ -15,26 +15,19 @@ import ( // vault must be unique within a region for an AWS account. You can create up to // 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 // Glacier. You must use the following guidelines when naming a vault. +// - Names can be between 1 and 255 characters long. +// - Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and +// '.' (period). // -// * Names can -// be between 1 and 255 characters long. -// -// * Allowed characters are a-z, A-Z, 0-9, -// '_' (underscore), '-' (hyphen), and '.' (period). -// -// This operation is idempotent. -// An AWS account has full permission to perform all operations (actions). However, -// AWS Identity and Access Management (IAM) users don't have any permissions by -// default. You must grant them explicit permission to perform specific actions. -// For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Creating a Vault in -// Amazon Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html) and -// Create Vault -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html) in the -// Amazon Glacier Developer Guide. +// This operation is idempotent. An AWS account has full permission to perform all +// operations (actions). However, AWS Identity and Access Management (IAM) users +// don't have any permissions by default. You must grant them explicit permission +// to perform specific actions. For more information, see Access Control Using AWS +// Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Creating a Vault in +// Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html) +// and Create Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html) +// in the Amazon Glacier Developer Guide. func (c *Client) CreateVault(ctx context.Context, params *CreateVaultInput, optFns ...func(*Options)) (*CreateVaultOutput, error) { if params == nil { params = &CreateVaultInput{} @@ -53,12 +46,12 @@ func (c *Client) CreateVault(ctx context.Context, params *CreateVaultInput, optF // Provides options to create a vault. type CreateVaultInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon S3 Glacier uses the AWS account ID associated with the credentials used - // to sign the request. If you specify your account ID, do not include any hyphens - // ('-') in the ID. + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon S3 Glacier uses the AWS account ID associated with the credentials + // used to sign the request. If you specify your account ID, do not include any + // hyphens ('-') in the ID. // // This member is required. AccountId *string diff --git a/service/glacier/api_op_DeleteArchive.go b/service/glacier/api_op_DeleteArchive.go index 21d158a250f..6908ab4d4bb 100644 --- a/service/glacier/api_op_DeleteArchive.go +++ b/service/glacier/api_op_DeleteArchive.go @@ -13,30 +13,24 @@ import ( // This operation deletes an archive from a vault. Subsequent requests to initiate // a retrieval of this archive will fail. Archive retrievals that are in progress -// for this archive ID may or may not succeed according to the following -// scenarios: +// for this archive ID may or may not succeed according to the following scenarios: // -// * If the archive retrieval job is actively preparing the data for -// download when Amazon S3 Glacier receives the delete archive request, the -// archival retrieval operation might fail. +// - If the archive retrieval job is actively preparing the data for download +// when Amazon S3 Glacier receives the delete archive request, the archival +// retrieval operation might fail. +// - If the archive retrieval job has successfully prepared the archive for +// download when Amazon S3 Glacier receives the delete archive request, you will be +// able to download the output. // -// * If the archive retrieval job has -// successfully prepared the archive for download when Amazon S3 Glacier receives -// the delete archive request, you will be able to download the output. -// -// This -// operation is idempotent. Attempting to delete an already-deleted archive does -// not result in an error. An AWS account has full permission to perform all +// This operation is idempotent. Attempting to delete an already-deleted archive +// does not result in an error. An AWS account has full permission to perform all // operations (actions). However, AWS Identity and Access Management (IAM) users // don't have any permissions by default. You must grant them explicit permission // to perform specific actions. For more information, see Access Control Using AWS -// Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Deleting an Archive in -// Amazon Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html) -// and Delete Archive -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html) +// Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Deleting an Archive +// in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html) +// and Delete Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html) // in the Amazon Glacier Developer Guide. func (c *Client) DeleteArchive(ctx context.Context, params *DeleteArchiveInput, optFns ...func(*Options)) (*DeleteArchiveOutput, error) { if params == nil { @@ -57,8 +51,8 @@ func (c *Client) DeleteArchive(ctx context.Context, params *DeleteArchiveInput, type DeleteArchiveInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_DeleteVault.go b/service/glacier/api_op_DeleteVault.go index 9823698ef7f..8b34302b0a1 100644 --- a/service/glacier/api_op_DeleteVault.go +++ b/service/glacier/api_op_DeleteVault.go @@ -16,23 +16,18 @@ import ( // no writes to the vault since the last inventory. If either of these conditions // is not satisfied, the vault deletion fails (that is, the vault is not removed) // and Amazon S3 Glacier returns an error. You can use DescribeVault to return the -// number of archives in a vault, and you can use Initiate a Job (POST jobs) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html) +// number of archives in a vault, and you can use Initiate a Job (POST jobs) (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html) // to initiate a new inventory retrieval for a vault. The inventory contains the -// archive IDs you use to delete archives using Delete Archive (DELETE archive) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html). -// This operation is idempotent. An AWS account has full permission to perform all -// operations (actions). However, AWS Identity and Access Management (IAM) users -// don't have any permissions by default. You must grant them explicit permission -// to perform specific actions. For more information, see Access Control Using AWS -// Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Deleting a Vault in -// Amazon Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html) and -// Delete Vault -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html) in -// the Amazon S3 Glacier Developer Guide. +// archive IDs you use to delete archives using Delete Archive (DELETE archive) (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html) +// . This operation is idempotent. An AWS account has full permission to perform +// all operations (actions). However, AWS Identity and Access Management (IAM) +// users don't have any permissions by default. You must grant them explicit +// permission to perform specific actions. For more information, see Access +// Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Deleting a Vault in +// Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html) +// and Delete Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html) +// in the Amazon S3 Glacier Developer Guide. func (c *Client) DeleteVault(ctx context.Context, params *DeleteVaultInput, optFns ...func(*Options)) (*DeleteVaultOutput, error) { if params == nil { params = &DeleteVaultInput{} @@ -52,8 +47,8 @@ func (c *Client) DeleteVault(ctx context.Context, params *DeleteVaultInput, optF type DeleteVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_DeleteVaultAccessPolicy.go b/service/glacier/api_op_DeleteVaultAccessPolicy.go index 4c8674e2beb..8917725cbb2 100644 --- a/service/glacier/api_op_DeleteVaultAccessPolicy.go +++ b/service/glacier/api_op_DeleteVaultAccessPolicy.go @@ -17,8 +17,8 @@ import ( // see the effect of the policy for a short time after you send the delete request. // This operation is idempotent. You can invoke delete multiple times, even if // there is no policy associated with the vault. For more information about vault -// access policies, see Amazon Glacier Access Control with Vault Access Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html). +// access policies, see Amazon Glacier Access Control with Vault Access Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) +// . func (c *Client) DeleteVaultAccessPolicy(ctx context.Context, params *DeleteVaultAccessPolicyInput, optFns ...func(*Options)) (*DeleteVaultAccessPolicyOutput, error) { if params == nil { params = &DeleteVaultAccessPolicyInput{} @@ -38,8 +38,8 @@ func (c *Client) DeleteVaultAccessPolicy(ctx context.Context, params *DeleteVaul type DeleteVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_DeleteVaultNotifications.go b/service/glacier/api_op_DeleteVaultNotifications.go index 8d7439eaa96..7a7f3bac4bf 100644 --- a/service/glacier/api_op_DeleteVaultNotifications.go +++ b/service/glacier/api_op_DeleteVaultNotifications.go @@ -19,13 +19,10 @@ import ( // Identity and Access Management (IAM) users don't have any permissions by // default. You must grant them explicit permission to perform specific actions. // For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Configuring Vault -// Notifications in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) -// and Delete Vault Notification Configuration -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html) +// Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Configuring Vault +// Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) +// and Delete Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html) // in the Amazon S3 Glacier Developer Guide. func (c *Client) DeleteVaultNotifications(ctx context.Context, params *DeleteVaultNotificationsInput, optFns ...func(*Options)) (*DeleteVaultNotificationsOutput, error) { if params == nil { @@ -47,8 +44,8 @@ func (c *Client) DeleteVaultNotifications(ctx context.Context, params *DeleteVau type DeleteVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_DescribeJob.go b/service/glacier/api_op_DescribeJob.go index 4e14f5a71e5..02345e25549 100644 --- a/service/glacier/api_op_DescribeJob.go +++ b/service/glacier/api_op_DescribeJob.go @@ -16,7 +16,7 @@ import ( // including the job initiation date, the user who initiated the job, the job // status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier // (Glacier) completes the job. For more information about initiating a job, see -// InitiateJob. This operation enables you to check the status of your job. +// InitiateJob . This operation enables you to check the status of your job. // However, it is strongly recommended that you set up an Amazon SNS topic and // specify it in your initiate job request so that Glacier can notify the topic // after it completes the job. A job ID will not expire for at least 24 hours after @@ -24,11 +24,9 @@ import ( // operations (actions). However, AWS Identity and Access Management (IAM) users // don't have any permissions by default. You must grant them explicit permission // to perform specific actions. For more information, see Access Control Using AWS -// Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For more information about using this operation, see the documentation for the -// underlying REST API Describe Job -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html) +// Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For more information about using this operation, see the documentation for the +// underlying REST API Describe Job (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html) // in the Amazon Glacier Developer Guide. func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error) { if params == nil { @@ -49,8 +47,8 @@ func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optF type DescribeJobInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -73,8 +71,8 @@ type DescribeJobInput struct { // Contains the description of an Amazon S3 Glacier job. type DescribeJobOutput struct { - // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or - // Select. + // The job type. This value is either ArchiveRetrieval , InventoryRetrieval , or + // Select . Action types.ActionCode // The archive ID requested for a select job or archive retrieval. Otherwise, this @@ -99,15 +97,15 @@ type DescribeJobOutput struct { CompletionDate *string // The UTC date when the job was created. This value is a string representation of - // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". + // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z" . CreationDate *string // Parameters used for range inventory retrieval. InventoryRetrievalParameters *types.InventoryRetrievalJobDescription - // For an inventory retrieval job, this value is the size in bytes of the inventory - // requested for download. For an archive retrieval or select job, this value is - // null. + // For an inventory retrieval job, this value is the size in bytes of the + // inventory requested for download. For an archive retrieval or select job, this + // value is null. InventorySizeInBytes *int64 // The job description provided when initiating the job. @@ -135,17 +133,13 @@ type DescribeJobOutput struct { // tree-hash aligned range, then this field returns a value. If the whole archive // is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This // field is null for the following: + // - Archive retrieval jobs that specify a range that is not tree-hash aligned // - // * Archive retrieval jobs that specify a range - // that is not tree-hash aligned - // - // * Archival jobs that specify a range that is - // equal to the whole archive, when the job status is InProgress - // - // * Inventory - // jobs + // - Archival jobs that specify a range that is equal to the whole archive, when + // the job status is InProgress // - // * Select jobs + // - Inventory jobs + // - Select jobs SHA256TreeHash *string // An Amazon SNS topic that receives notification. @@ -154,15 +148,15 @@ type DescribeJobOutput struct { // Contains the parameters used for a select. SelectParameters *types.SelectParameters - // The status code can be InProgress, Succeeded, or Failed, and indicates the + // The status code can be InProgress , Succeeded , or Failed , and indicates the // status of the job. StatusCode types.StatusCode // A friendly message that describes the job status. StatusMessage *string - // The tier to use for a select or an archive retrieval. Valid values are - // Expedited, Standard, or Bulk. Standard is the default. + // The tier to use for a select or an archive retrieval. Valid values are Expedited + // , Standard , or Bulk . Standard is the default. Tier *string // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was diff --git a/service/glacier/api_op_DescribeVault.go b/service/glacier/api_op_DescribeVault.go index c1a655a61ab..ccf5c432180 100644 --- a/service/glacier/api_op_DescribeVault.go +++ b/service/glacier/api_op_DescribeVault.go @@ -23,22 +23,18 @@ import ( // archives and their total size are as of the last inventory generation. This // means that if you add or remove an archive from a vault, and then immediately // use Describe Vault, the change in contents will not be immediately reflected. If -// you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon +// you want to retrieve the latest inventory of the vault, use InitiateJob . Amazon // S3 Glacier generates vault inventories approximately daily. For more -// information, see Downloading a Vault Inventory in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html). An -// AWS account has full permission to perform all operations (actions). However, -// AWS Identity and Access Management (IAM) users don't have any permissions by -// default. You must grant them explicit permission to perform specific actions. -// For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Retrieving Vault -// Metadata in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) -// and Describe Vault -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html) in the -// Amazon Glacier Developer Guide. +// information, see Downloading a Vault Inventory in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html) +// . An AWS account has full permission to perform all operations (actions). +// However, AWS Identity and Access Management (IAM) users don't have any +// permissions by default. You must grant them explicit permission to perform +// specific actions. For more information, see Access Control Using AWS Identity +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Retrieving Vault +// Metadata in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) +// and Describe Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html) +// in the Amazon Glacier Developer Guide. func (c *Client) DescribeVault(ctx context.Context, params *DescribeVaultInput, optFns ...func(*Options)) (*DescribeVaultOutput, error) { if params == nil { params = &DescribeVaultInput{} @@ -58,8 +54,8 @@ func (c *Client) DescribeVault(ctx context.Context, params *DescribeVaultInput, type DescribeVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -77,14 +73,14 @@ type DescribeVaultInput struct { // Contains the Amazon S3 Glacier response to your request. type DescribeVaultOutput struct { - // The Universal Coordinated Time (UTC) date when the vault was created. This value - // should be a string in the ISO 8601 date format, for example - // 2012-03-20T17:03:43.221Z. + // The Universal Coordinated Time (UTC) date when the vault was created. This + // value should be a string in the ISO 8601 date format, for example + // 2012-03-20T17:03:43.221Z . CreationDate *string // The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the // last vault inventory. This value should be a string in the ISO 8601 date format, - // for example 2012-03-20T17:03:43.221Z. + // for example 2012-03-20T17:03:43.221Z . LastInventoryDate *string // The number of archives in the vault as of the last inventory date. This field @@ -201,9 +197,9 @@ type VaultExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VaultExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VaultExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -354,9 +350,9 @@ type VaultNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VaultNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VaultNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/glacier/api_op_GetDataRetrievalPolicy.go b/service/glacier/api_op_GetDataRetrievalPolicy.go index f50f2a2409c..c8ec28a9b06 100644 --- a/service/glacier/api_op_GetDataRetrievalPolicy.go +++ b/service/glacier/api_op_GetDataRetrievalPolicy.go @@ -14,8 +14,8 @@ import ( // This operation returns the current data retrieval policy for the account and // region specified in the GET request. For more information about data retrieval -// policies, see Amazon Glacier Data Retrieval Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html). +// policies, see Amazon Glacier Data Retrieval Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html) +// . func (c *Client) GetDataRetrievalPolicy(ctx context.Context, params *GetDataRetrievalPolicyInput, optFns ...func(*Options)) (*GetDataRetrievalPolicyOutput, error) { if params == nil { params = &GetDataRetrievalPolicyInput{} @@ -34,11 +34,11 @@ func (c *Client) GetDataRetrievalPolicy(ctx context.Context, params *GetDataRetr // Input for GetDataRetrievalPolicy. type GetDataRetrievalPolicyInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. diff --git a/service/glacier/api_op_GetJobOutput.go b/service/glacier/api_op_GetJobOutput.go index 8351419445f..54002f23c4b 100644 --- a/service/glacier/api_op_GetJobOutput.go +++ b/service/glacier/api_op_GetJobOutput.go @@ -12,7 +12,7 @@ import ( "io" ) -// This operation downloads the output of the job you initiated using InitiateJob. +// This operation downloads the output of the job you initiated using InitiateJob . // Depending on the job type you specified when you initiated the job, the output // will be either the content of an archive or a vault inventory. You can download // all the job output or download a portion of the output by specifying a byte @@ -26,7 +26,7 @@ import ( // response. For archive retrieval jobs, you should also verify that the size is // what you expected. If you download a portion of the output, the expected size is // based on the range of bytes you specified. For example, if you specify a range -// of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If +// of bytes=0-1048575 , you should verify your download size is 1,048,576 bytes. If // you download an entire archive, the expected size is the size of the archive // when you uploaded it to Amazon S3 Glacier The expected size is also returned in // the headers from the Get Job Output response. In the case of an archive @@ -40,15 +40,11 @@ import ( // However, AWS Identity and Access Management (IAM) users don't have any // permissions by default. You must grant them explicit permission to perform // specific actions. For more information, see Access Control Using AWS Identity -// and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and the underlying REST API, see Downloading a Vault -// Inventory -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html), -// Downloading an Archive -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html), -// and Get Job Output -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html) +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and the underlying REST API, see Downloading a +// Vault Inventory (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html) +// , Downloading an Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html) +// , and Get Job Output (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html) func (c *Client) GetJobOutput(ctx context.Context, params *GetJobOutputInput, optFns ...func(*Options)) (*GetJobOutputOutput, error) { if params == nil { params = &GetJobOutputInput{} @@ -68,8 +64,8 @@ func (c *Client) GetJobOutput(ctx context.Context, params *GetJobOutputInput, op type GetJobOutputInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -87,34 +83,28 @@ type GetJobOutputInput struct { VaultName *string // The range of bytes to retrieve from the output. For example, if you want to - // download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By + // download the first 1,048,576 bytes, specify the range as bytes=0-1048575 . By // default, this operation downloads the entire output. If the job output is large, // then you can use a range to retrieve a portion of the output. This allows you to // download the entire output in smaller chunks of bytes. For example, suppose you // have 1 GB of job output you want to download and you decide to download 128 MB // chunks of data at a time, which is a total of eight Get Job Output requests. You // use the following process to download the job output: - // - // * Download a 128 MB chunk - // of output by specifying the appropriate byte range. Verify that all 128 MB of - // data was received. - // - // * Along with the data, the response includes a SHA256 tree - // hash of the payload. You compute the checksum of the payload on the client and - // compare it with the checksum you received in the response to ensure you received - // all the expected data. - // - // * Repeat steps 1 and 2 for all the eight 128 MB chunks - // of output data, each time specifying the appropriate byte range. - // - // * After - // downloading all the parts of the job output, you have a list of eight checksum - // values. Compute the tree hash of these values to find the checksum of the entire - // output. Using the DescribeJob API, obtain job information of the job that - // provided you the output. The response includes the checksum of the entire - // archive stored in Amazon S3 Glacier. You compare this value with the checksum - // you computed to ensure you have downloaded the entire archive content with no - // errors. + // - Download a 128 MB chunk of output by specifying the appropriate byte range. + // Verify that all 128 MB of data was received. + // - Along with the data, the response includes a SHA256 tree hash of the + // payload. You compute the checksum of the payload on the client and compare it + // with the checksum you received in the response to ensure you received all the + // expected data. + // - Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each + // time specifying the appropriate byte range. + // - After downloading all the parts of the job output, you have a list of eight + // checksum values. Compute the tree hash of these values to find the checksum of + // the entire output. Using the DescribeJob API, obtain job information of the + // job that provided you the output. The response includes the checksum of the + // entire archive stored in Amazon S3 Glacier. You compare this value with the + // checksum you computed to ensure you have downloaded the entire archive content + // with no errors. Range *string noSmithyDocumentSerde @@ -123,8 +113,8 @@ type GetJobOutputInput struct { // Contains the Amazon S3 Glacier response to your request. type GetJobOutputOutput struct { - // Indicates the range units accepted. For more information, see RFC2616 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + // Indicates the range units accepted. For more information, see RFC2616 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) + // . AcceptRanges *string // The description of an archive. @@ -136,20 +126,15 @@ type GetJobOutputOutput struct { // The checksum of the data in the response. This header is returned only when // retrieving the output for an archive retrieval job. Furthermore, this header // appears only under the following conditions: - // - // * You get the entire range of the - // archive. - // - // * You request a range to return of the archive that starts and ends on - // a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a - // range to return that starts at 1 MB and ends at 2 MB, then the - // x-amz-sha256-tree-hash is returned as a response header. - // - // * You request a range - // of the archive to return that starts on a multiple of 1 MB and goes to the end - // of the archive. For example, if you have a 3.1 MB archive and you specify a - // range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the - // x-amz-sha256-tree-hash is returned as a response header. + // - You get the entire range of the archive. + // - You request a range to return of the archive that starts and ends on a + // multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a + // range to return that starts at 1 MB and ends at 2 MB, then the + // x-amz-sha256-tree-hash is returned as a response header. + // - You request a range of the archive to return that starts on a multiple of 1 + // MB and goes to the end of the archive. For example, if you have a 3.1 MB archive + // and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the + // archive), then the x-amz-sha256-tree-hash is returned as a response header. Checksum *string // The range of bytes returned by Amazon S3 Glacier. If only partial output is diff --git a/service/glacier/api_op_GetVaultAccessPolicy.go b/service/glacier/api_op_GetVaultAccessPolicy.go index 75c35cc5cdb..b7240cdd929 100644 --- a/service/glacier/api_op_GetVaultAccessPolicy.go +++ b/service/glacier/api_op_GetVaultAccessPolicy.go @@ -14,12 +14,11 @@ import ( // This operation retrieves the access-policy subresource set on the vault; for // more information on setting this subresource, see Set Vault Access Policy (PUT -// access-policy) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html). -// If there is no access policy set on the vault, the operation returns a 404 Not -// found error. For more information about vault access policies, see Amazon -// Glacier Access Control with Vault Access Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html). +// access-policy) (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html) +// . If there is no access policy set on the vault, the operation returns a 404 +// Not found error. For more information about vault access policies, see Amazon +// Glacier Access Control with Vault Access Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) +// . func (c *Client) GetVaultAccessPolicy(ctx context.Context, params *GetVaultAccessPolicyInput, optFns ...func(*Options)) (*GetVaultAccessPolicyOutput, error) { if params == nil { params = &GetVaultAccessPolicyInput{} @@ -39,8 +38,8 @@ func (c *Client) GetVaultAccessPolicy(ctx context.Context, params *GetVaultAcces type GetVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_GetVaultLock.go b/service/glacier/api_op_GetVaultLock.go index c881404a1bd..29b03b511b8 100644 --- a/service/glacier/api_op_GetVaultLock.go +++ b/service/glacier/api_op_GetVaultLock.go @@ -13,29 +13,20 @@ import ( // This operation retrieves the following attributes from the lock-policy // subresource set on the specified vault: +// - The vault lock policy set on the vault. +// - The state of the vault lock, which is either InProgess or Locked . +// - When the lock ID expires. The lock ID is used to complete the vault locking +// process. +// - When the vault lock was initiated and put into the InProgress state. // -// * The vault lock policy set on the -// vault. -// -// * The state of the vault lock, which is either InProgess or Locked. -// -// * -// When the lock ID expires. The lock ID is used to complete the vault locking -// process. -// -// * When the vault lock was initiated and put into the InProgress -// state. -// -// A vault lock is put into the InProgress state by calling -// InitiateVaultLock. A vault lock is put into the Locked state by calling -// CompleteVaultLock. You can abort the vault locking process by calling -// AbortVaultLock. For more information about the vault locking process, Amazon -// Glacier Vault Lock -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html). If there -// is no vault lock policy set on the vault, the operation returns a 404 Not found -// error. For more information about vault lock policies, Amazon Glacier Access -// Control with Vault Lock Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html). +// A vault lock is put into the InProgress state by calling InitiateVaultLock . A +// vault lock is put into the Locked state by calling CompleteVaultLock . You can +// abort the vault locking process by calling AbortVaultLock . For more information +// about the vault locking process, Amazon Glacier Vault Lock (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html) +// . If there is no vault lock policy set on the vault, the operation returns a +// 404 Not found error. For more information about vault lock policies, Amazon +// Glacier Access Control with Vault Lock Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html) +// . func (c *Client) GetVaultLock(ctx context.Context, params *GetVaultLockInput, optFns ...func(*Options)) (*GetVaultLockOutput, error) { if params == nil { params = &GetVaultLockInput{} @@ -51,12 +42,12 @@ func (c *Client) GetVaultLock(ctx context.Context, params *GetVaultLockInput, op return out, nil } -// The input values for GetVaultLock. +// The input values for GetVaultLock . type GetVaultLockInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -84,7 +75,7 @@ type GetVaultLockOutput struct { // The vault lock policy as a JSON string, which uses "\" as an escape character. Policy *string - // The state of the vault lock. InProgress or Locked. + // The state of the vault lock. InProgress or Locked . State *string // Metadata pertaining to the operation's result. diff --git a/service/glacier/api_op_GetVaultNotifications.go b/service/glacier/api_op_GetVaultNotifications.go index 9f0afea0157..86a18bad078 100644 --- a/service/glacier/api_op_GetVaultNotifications.go +++ b/service/glacier/api_op_GetVaultNotifications.go @@ -14,21 +14,18 @@ import ( // This operation retrieves the notification-configuration subresource of the // specified vault. For information about setting a notification configuration on a -// vault, see SetVaultNotifications. If a notification configuration for a vault is -// not set, the operation returns a 404 Not Found error. For more information about -// vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html). -// An AWS account has full permission to perform all operations (actions). However, -// AWS Identity and Access Management (IAM) users don't have any permissions by -// default. You must grant them explicit permission to perform specific actions. -// For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Configuring Vault -// Notifications in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) -// and Get Vault Notification Configuration -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html) +// vault, see SetVaultNotifications . If a notification configuration for a vault +// is not set, the operation returns a 404 Not Found error. For more information +// about vault notifications, see Configuring Vault Notifications in Amazon S3 +// Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) +// . An AWS account has full permission to perform all operations (actions). +// However, AWS Identity and Access Management (IAM) users don't have any +// permissions by default. You must grant them explicit permission to perform +// specific actions. For more information, see Access Control Using AWS Identity +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Configuring Vault +// Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) +// and Get Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html) // in the Amazon Glacier Developer Guide. func (c *Client) GetVaultNotifications(ctx context.Context, params *GetVaultNotificationsInput, optFns ...func(*Options)) (*GetVaultNotificationsOutput, error) { if params == nil { @@ -50,8 +47,8 @@ func (c *Client) GetVaultNotifications(ctx context.Context, params *GetVaultNoti type GetVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_InitiateJob.go b/service/glacier/api_op_InitiateJob.go index 8ae16dcd328..c87d6062d19 100644 --- a/service/glacier/api_op_InitiateJob.go +++ b/service/glacier/api_op_InitiateJob.go @@ -14,8 +14,8 @@ import ( // This operation initiates a job of the specified type, which can be a select, an // archival retrieval, or a vault retrieval. For more information about using this -// operation, see the documentation for the underlying REST API Initiate a Job -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html). +// operation, see the documentation for the underlying REST API Initiate a Job (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html) +// . func (c *Client) InitiateJob(ctx context.Context, params *InitiateJobInput, optFns ...func(*Options)) (*InitiateJobOutput, error) { if params == nil { params = &InitiateJobInput{} @@ -35,8 +35,8 @@ func (c *Client) InitiateJob(ctx context.Context, params *InitiateJobInput, optF type InitiateJobInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_InitiateMultipartUpload.go b/service/glacier/api_op_InitiateMultipartUpload.go index d3434570856..22e2ebc92d7 100644 --- a/service/glacier/api_op_InitiateMultipartUpload.go +++ b/service/glacier/api_op_InitiateMultipartUpload.go @@ -14,16 +14,16 @@ import ( // This operation initiates a multipart upload. Amazon S3 Glacier creates a // multipart upload resource and returns its ID in the response. The multipart // upload ID is used in subsequent requests to upload parts of an archive (see -// UploadMultipartPart). When you initiate a multipart upload, you specify the part -// size in number of bytes. The part size must be a megabyte (1024 KB) multiplied -// by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), -// 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the -// maximum is 4 GB. Every part you upload to this resource (see -// UploadMultipartPart), except the last one, must have the same size. The last one -// can be the same size or smaller. For example, suppose you want to upload a 16.2 -// MB file. If you initiate the multipart upload with a part size of 4 MB, you will -// upload four parts of 4 MB each and one part of 0.2 MB. You don't need to know -// the size of the archive when you start a multipart upload because Amazon S3 +// UploadMultipartPart ). When you initiate a multipart upload, you specify the +// part size in number of bytes. The part size must be a megabyte (1024 KB) +// multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 +// (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and +// the maximum is 4 GB. Every part you upload to this resource (see +// UploadMultipartPart ), except the last one, must have the same size. The last +// one can be the same size or smaller. For example, suppose you want to upload a +// 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you +// will upload four parts of 4 MB each and one part of 0.2 MB. You don't need to +// know the size of the archive when you start a multipart upload because Amazon S3 // Glacier does not require you to specify the overall archive size. After you // complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart // upload resource referenced by the ID. Glacier also removes the multipart upload @@ -31,14 +31,11 @@ import ( // activity for a period of 24 hours. An AWS account has full permission to perform // all operations (actions). However, AWS Identity and Access Management (IAM) // users don't have any permissions by default. You must grant them explicit -// permission to perform specific actions. For more information, see Access Control -// Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Uploading Large Archives -// in Parts (Multipart Upload) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) -// and Initiate Multipart Upload -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html) +// permission to perform specific actions. For more information, see Access +// Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Uploading Large +// Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) +// and Initiate Multipart Upload (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html) // in the Amazon Glacier Developer Guide. func (c *Client) InitiateMultipartUpload(ctx context.Context, params *InitiateMultipartUploadInput, optFns ...func(*Options)) (*InitiateMultipartUploadOutput, error) { if params == nil { @@ -60,8 +57,8 @@ func (c *Client) InitiateMultipartUpload(ctx context.Context, params *InitiateMu type InitiateMultipartUploadInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -73,8 +70,8 @@ type InitiateMultipartUploadInput struct { // This member is required. VaultName *string - // The archive description that you are uploading in parts. The part size must be a - // megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), + // The archive description that you are uploading in parts. The part size must be + // a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), // 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable // part size is 1 MB, and the maximum is 4 GB (4096 MB). ArchiveDescription *string diff --git a/service/glacier/api_op_InitiateVaultLock.go b/service/glacier/api_op_InitiateVaultLock.go index 77f72f78246..3fd772e4afd 100644 --- a/service/glacier/api_op_InitiateVaultLock.go +++ b/service/glacier/api_op_InitiateVaultLock.go @@ -13,33 +13,25 @@ import ( ) // This operation initiates the vault locking process by doing the following: +// - Installing a vault lock policy on the specified vault. +// - Setting the lock state of vault lock to InProgress . +// - Returning a lock ID, which is used to complete the vault locking process. // -// * -// Installing a vault lock policy on the specified vault. -// -// * Setting the lock state -// of vault lock to InProgress. -// -// * Returning a lock ID, which is used to complete -// the vault locking process. -// -// You can set one vault lock policy for each vault and -// this policy can be up to 20 KB in size. For more information about vault lock -// policies, see Amazon Glacier Access Control with Vault Lock Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html). -// You must complete the vault locking process within 24 hours after the vault lock -// enters the InProgress state. After the 24 hour window ends, the lock ID expires, -// the vault automatically exits the InProgress state, and the vault lock policy is -// removed from the vault. You call CompleteVaultLock to complete the vault locking -// process by setting the state of the vault lock to Locked. After a vault lock is -// in the Locked state, you cannot initiate a new vault lock for the vault. You can -// abort the vault locking process by calling AbortVaultLock. You can get the state -// of the vault lock by calling GetVaultLock. For more information about the vault -// locking process, Amazon Glacier Vault Lock -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html). If this -// operation is called when the vault lock is in the InProgress state, the -// operation returns an AccessDeniedException error. When the vault lock is in the -// InProgress state you must call AbortVaultLock before you can initiate a new +// You can set one vault lock policy for each vault and this policy can be up to +// 20 KB in size. For more information about vault lock policies, see Amazon +// Glacier Access Control with Vault Lock Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html) +// . You must complete the vault locking process within 24 hours after the vault +// lock enters the InProgress state. After the 24 hour window ends, the lock ID +// expires, the vault automatically exits the InProgress state, and the vault lock +// policy is removed from the vault. You call CompleteVaultLock to complete the +// vault locking process by setting the state of the vault lock to Locked . After a +// vault lock is in the Locked state, you cannot initiate a new vault lock for the +// vault. You can abort the vault locking process by calling AbortVaultLock . You +// can get the state of the vault lock by calling GetVaultLock . For more +// information about the vault locking process, Amazon Glacier Vault Lock (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html) +// . If this operation is called when the vault lock is in the InProgress state, +// the operation returns an AccessDeniedException error. When the vault lock is in +// the InProgress state you must call AbortVaultLock before you can initiate a new // vault lock policy. func (c *Client) InitiateVaultLock(ctx context.Context, params *InitiateVaultLockInput, optFns ...func(*Options)) (*InitiateVaultLockOutput, error) { if params == nil { @@ -56,14 +48,14 @@ func (c *Client) InitiateVaultLock(ctx context.Context, params *InitiateVaultLoc return out, nil } -// The input values for InitiateVaultLock. +// The input values for InitiateVaultLock . type InitiateVaultLockInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. diff --git a/service/glacier/api_op_ListJobs.go b/service/glacier/api_op_ListJobs.go index a4683a8b866..8c4c341d237 100644 --- a/service/glacier/api_op_ListJobs.go +++ b/service/glacier/api_op_ListJobs.go @@ -25,22 +25,22 @@ import ( // but encounter a network error. In this scenario, you can retry and download the // archive while the job exists. The List Jobs operation supports pagination. You // should always check the response Marker field. If there are no more jobs to -// list, the Marker field is set to null. If there are more jobs to list, the +// list, the Marker field is set to null . If there are more jobs to list, the // Marker field is set to a non-null value, which you can use to continue the // pagination of the list. To return a list of jobs that begins at a specific job, // set the marker request parameter to the Marker value for that job that you // obtained from a previous List Jobs request. You can set a maximum limit for the -// number of jobs returned in the response by specifying the limit parameter in the -// request. The default limit is 50. The number of jobs returned might be fewer +// number of jobs returned in the response by specifying the limit parameter in +// the request. The default limit is 50. The number of jobs returned might be fewer // than the limit, but the number of returned jobs never exceeds the limit. // Additionally, you can filter the jobs list returned by specifying the optional // statuscode parameter or completed parameter, or both. Using the statuscode -// parameter, you can specify to return only jobs that match either the InProgress, -// Succeeded, or Failed status. Using the completed parameter, you can specify to -// return only jobs that were completed (true) or jobs that were not completed -// (false). For more information about using this operation, see the documentation -// for the underlying REST API List Jobs -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html). +// parameter, you can specify to return only jobs that match either the InProgress +// , Succeeded , or Failed status. Using the completed parameter, you can specify +// to return only jobs that were completed ( true ) or jobs that were not completed +// ( false ). For more information about using this operation, see the +// documentation for the underlying REST API List Jobs (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html) +// . func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { params = &ListJobsInput{} @@ -60,8 +60,8 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... type ListJobsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -73,7 +73,7 @@ type ListJobsInput struct { // This member is required. VaultName *string - // The state of the jobs to return. You can specify true or false. + // The state of the jobs to return. You can specify true or false . Completed *string // The maximum number of jobs to be returned. The default limit is 50. The number @@ -88,7 +88,7 @@ type ListJobsInput struct { Marker *string // The type of job status to return. You can specify the following values: - // InProgress, Succeeded, or Failed. + // InProgress , Succeeded , or Failed . Statuscode *string noSmithyDocumentSerde @@ -100,9 +100,9 @@ type ListJobsOutput struct { // A list of job objects. Each job object contains metadata describing the job. JobList []types.GlacierJobDescription - // An opaque string used for pagination that specifies the job at which the listing - // of jobs should begin. You get the marker value from a previous List Jobs - // response. You only need to include the marker if you are continuing the + // An opaque string used for pagination that specifies the job at which the + // listing of jobs should begin. You get the marker value from a previous List + // Jobs response. You only need to include the marker if you are continuing the // pagination of the results started in a previous List Jobs request. Marker *string diff --git a/service/glacier/api_op_ListMultipartUploads.go b/service/glacier/api_op_ListMultipartUploads.go index 6aa34e969c3..30efa6aeb10 100644 --- a/service/glacier/api_op_ListMultipartUploads.go +++ b/service/glacier/api_op_ListMultipartUploads.go @@ -20,25 +20,22 @@ import ( // List Multipart Uploads operation supports pagination. By default, this operation // returns up to 50 multipart uploads in the response. You should always check the // response for a marker at which to continue the list; if there are no more items -// the marker is null. To return a list of multipart uploads that begins at a -// specific upload, set the marker request parameter to the value you obtained from -// a previous List Multipart Upload request. You can also limit the number of +// the marker is null . To return a list of multipart uploads that begins at a +// specific upload, set the marker request parameter to the value you obtained +// from a previous List Multipart Upload request. You can also limit the number of // uploads returned in the response by specifying the limit parameter in the -// request. Note the difference between this operation and listing parts -// (ListParts). The List Multipart Uploads operation lists all multipart uploads -// for a vault and does not require a multipart upload ID. The List Parts operation -// requires a multipart upload ID since parts are associated with a single upload. -// An AWS account has full permission to perform all operations (actions). However, -// AWS Identity and Access Management (IAM) users don't have any permissions by +// request. Note the difference between this operation and listing parts ( ListParts +// ). The List Multipart Uploads operation lists all multipart uploads for a vault +// and does not require a multipart upload ID. The List Parts operation requires a +// multipart upload ID since parts are associated with a single upload. An AWS +// account has full permission to perform all operations (actions). However, AWS +// Identity and Access Management (IAM) users don't have any permissions by // default. You must grant them explicit permission to perform specific actions. // For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and the underlying REST API, see Working with -// Archives in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) -// and List Multipart Uploads -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html) +// Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and the underlying REST API, see Working with +// Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// and List Multipart Uploads (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html) // in the Amazon Glacier Developer Guide. func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error) { if params == nil { @@ -60,8 +57,8 @@ func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipart type ListMultipartUploadsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -91,7 +88,7 @@ type ListMultipartUploadsOutput struct { // An opaque string that represents where to continue pagination of the results. // You use the marker in a new List Multipart Uploads request to obtain more - // uploads in the list. If there are no more uploads, this value is null. + // uploads in the list. If there are no more uploads, this value is null . Marker *string // A list of in-progress multipart uploads. diff --git a/service/glacier/api_op_ListParts.go b/service/glacier/api_op_ListParts.go index 01f44c516ad..5cf7fcaf506 100644 --- a/service/glacier/api_op_ListParts.go +++ b/service/glacier/api_op_ListParts.go @@ -16,25 +16,22 @@ import ( // This operation lists the parts of an archive that have been uploaded in a // specific multipart upload. You can make this request at any time during an // in-progress multipart upload before you complete the upload (see -// CompleteMultipartUpload. List Parts returns an error for completed uploads. The +// CompleteMultipartUpload . List Parts returns an error for completed uploads. The // list returned in the List Parts response is sorted by part range. The List Parts // operation supports pagination. By default, this operation returns up to 50 // uploaded parts in the response. You should always check the response for a // marker at which to continue the list; if there are no more items the marker is -// null. To return a list of parts that begins at a specific part, set the marker +// null . To return a list of parts that begins at a specific part, set the marker // request parameter to the value you obtained from a previous List Parts request. // You can also limit the number of parts returned in the response by specifying // the limit parameter in the request. An AWS account has full permission to // perform all operations (actions). However, AWS Identity and Access Management // (IAM) users don't have any permissions by default. You must grant them explicit -// permission to perform specific actions. For more information, see Access Control -// Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and the underlying REST API, see Working with -// Archives in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) -// and List Parts -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html) +// permission to perform specific actions. For more information, see Access +// Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and the underlying REST API, see Working with +// Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// and List Parts (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html) // in the Amazon Glacier Developer Guide. func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error) { if params == nil { @@ -56,8 +53,8 @@ func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns . type ListPartsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -79,8 +76,8 @@ type ListPartsInput struct { // returned parts never exceeds the limit. Limit *int32 - // An opaque string used for pagination. This value specifies the part at which the - // listing of parts should begin. Get the marker value from the response of a + // An opaque string used for pagination. This value specifies the part at which + // the listing of parts should begin. Get the marker value from the response of a // previous List Parts response. You need only include the marker if you are // continuing the pagination of results started in a previous List Parts request. Marker *string @@ -100,7 +97,7 @@ type ListPartsOutput struct { // An opaque string that represents where to continue pagination of the results. // You use the marker in a new List Parts request to obtain more jobs in the list. - // If there are no more parts, this value is null. + // If there are no more parts, this value is null . Marker *string // The ID of the upload to which the parts are associated. diff --git a/service/glacier/api_op_ListProvisionedCapacity.go b/service/glacier/api_op_ListProvisionedCapacity.go index 2ae73812bf8..9697e743e22 100644 --- a/service/glacier/api_op_ListProvisionedCapacity.go +++ b/service/glacier/api_op_ListProvisionedCapacity.go @@ -31,8 +31,8 @@ func (c *Client) ListProvisionedCapacity(ctx context.Context, params *ListProvis type ListProvisionedCapacityInput struct { - // The AWS account ID of the account that owns the vault. You can either specify an - // AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 + // The AWS account ID of the account that owns the vault. You can either specify + // an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 // Glacier uses the AWS account ID associated with the credentials used to sign the // request. If you use an account ID, don't include any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_ListTagsForVault.go b/service/glacier/api_op_ListTagsForVault.go index 4907c4b01ad..d8105365db4 100644 --- a/service/glacier/api_op_ListTagsForVault.go +++ b/service/glacier/api_op_ListTagsForVault.go @@ -13,8 +13,8 @@ import ( // This operation lists all the tags attached to a vault. The operation returns an // empty map if there are no tags. For more information about tags, see Tagging -// Amazon S3 Glacier Resources -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html). +// Amazon S3 Glacier Resources (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html) +// . func (c *Client) ListTagsForVault(ctx context.Context, params *ListTagsForVaultInput, optFns ...func(*Options)) (*ListTagsForVaultOutput, error) { if params == nil { params = &ListTagsForVaultInput{} @@ -30,12 +30,12 @@ func (c *Client) ListTagsForVault(ctx context.Context, params *ListTagsForVaultI return out, nil } -// The input value for ListTagsForVaultInput. +// The input value for ListTagsForVaultInput . type ListTagsForVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_ListVaults.go b/service/glacier/api_op_ListVaults.go index d4cf3a7ac24..3736eebc4b9 100644 --- a/service/glacier/api_op_ListVaults.go +++ b/service/glacier/api_op_ListVaults.go @@ -17,22 +17,19 @@ import ( // returned in the response is ASCII-sorted by vault name. By default, this // operation returns up to 10 items. If there are more vaults to list, the response // marker field contains the vault Amazon Resource Name (ARN) at which to continue -// the list with a new List Vaults request; otherwise, the marker field is null. To -// return a list of vaults that begins at a specific vault, set the marker request -// parameter to the vault ARN you obtained from a previous List Vaults request. You -// can also limit the number of vaults returned in the response by specifying the -// limit parameter in the request. An AWS account has full permission to perform -// all operations (actions). However, AWS Identity and Access Management (IAM) -// users don't have any permissions by default. You must grant them explicit -// permission to perform specific actions. For more information, see Access Control -// Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Retrieving Vault -// Metadata in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) -// and List Vaults -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html) in -// the Amazon Glacier Developer Guide. +// the list with a new List Vaults request; otherwise, the marker field is null . +// To return a list of vaults that begins at a specific vault, set the marker +// request parameter to the vault ARN you obtained from a previous List Vaults +// request. You can also limit the number of vaults returned in the response by +// specifying the limit parameter in the request. An AWS account has full +// permission to perform all operations (actions). However, AWS Identity and Access +// Management (IAM) users don't have any permissions by default. You must grant +// them explicit permission to perform specific actions. For more information, see +// Access Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Retrieving Vault +// Metadata in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html) +// and List Vaults (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html) +// in the Amazon Glacier Developer Guide. func (c *Client) ListVaults(ctx context.Context, params *ListVaultsInput, optFns ...func(*Options)) (*ListVaultsOutput, error) { if params == nil { params = &ListVaultsInput{} @@ -48,27 +45,27 @@ func (c *Client) ListVaults(ctx context.Context, params *ListVaultsInput, optFns return out, nil } -// Provides options to retrieve the vault list owned by the calling user's account. -// The list provides metadata information for each vault. +// Provides options to retrieve the vault list owned by the calling user's +// account. The list provides metadata information for each vault. type ListVaultsInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. AccountId *string - // The maximum number of vaults to be returned. The default limit is 10. The number - // of vaults returned might be fewer than the specified limit, but the number of - // returned vaults never exceeds the limit. + // The maximum number of vaults to be returned. The default limit is 10. The + // number of vaults returned might be fewer than the specified limit, but the + // number of returned vaults never exceeds the limit. Limit *int32 - // A string used for pagination. The marker specifies the vault ARN after which the - // listing of vaults should begin. + // A string used for pagination. The marker specifies the vault ARN after which + // the listing of vaults should begin. Marker *string noSmithyDocumentSerde @@ -77,8 +74,8 @@ type ListVaultsInput struct { // Contains the Amazon S3 Glacier response to your request. type ListVaultsOutput struct { - // The vault ARN at which to continue pagination of the results. You use the marker - // in another List Vaults request to obtain more vaults in the list. + // The vault ARN at which to continue pagination of the results. You use the + // marker in another List Vaults request to obtain more vaults in the list. Marker *string // List of vaults. @@ -171,9 +168,9 @@ var _ ListVaultsAPIClient = (*Client)(nil) // ListVaultsPaginatorOptions is the paginator options for ListVaults type ListVaultsPaginatorOptions struct { - // The maximum number of vaults to be returned. The default limit is 10. The number - // of vaults returned might be fewer than the specified limit, but the number of - // returned vaults never exceeds the limit. + // The maximum number of vaults to be returned. The default limit is 10. The + // number of vaults returned might be fewer than the specified limit, but the + // number of returned vaults never exceeds the limit. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/glacier/api_op_PurchaseProvisionedCapacity.go b/service/glacier/api_op_PurchaseProvisionedCapacity.go index c1334d7f028..3fecc35d322 100644 --- a/service/glacier/api_op_PurchaseProvisionedCapacity.go +++ b/service/glacier/api_op_PurchaseProvisionedCapacity.go @@ -29,8 +29,8 @@ func (c *Client) PurchaseProvisionedCapacity(ctx context.Context, params *Purcha type PurchaseProvisionedCapacityInput struct { - // The AWS account ID of the account that owns the vault. You can either specify an - // AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 + // The AWS account ID of the account that owns the vault. You can either specify + // an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 // Glacier uses the AWS account ID associated with the credentials used to sign the // request. If you use an account ID, don't include any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_RemoveTagsFromVault.go b/service/glacier/api_op_RemoveTagsFromVault.go index abb5e1580a3..9fe8ccd2fb5 100644 --- a/service/glacier/api_op_RemoveTagsFromVault.go +++ b/service/glacier/api_op_RemoveTagsFromVault.go @@ -12,10 +12,9 @@ import ( ) // This operation removes one or more tags from the set of tags attached to a -// vault. For more information about tags, see Tagging Amazon S3 Glacier Resources -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html). This -// operation is idempotent. The operation will be successful, even if there are no -// tags attached to the vault. +// vault. For more information about tags, see Tagging Amazon S3 Glacier Resources (https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html) +// . This operation is idempotent. The operation will be successful, even if there +// are no tags attached to the vault. func (c *Client) RemoveTagsFromVault(ctx context.Context, params *RemoveTagsFromVaultInput, optFns ...func(*Options)) (*RemoveTagsFromVaultOutput, error) { if params == nil { params = &RemoveTagsFromVaultInput{} @@ -31,12 +30,12 @@ func (c *Client) RemoveTagsFromVault(ctx context.Context, params *RemoveTagsFrom return out, nil } -// The input value for RemoveTagsFromVaultInput. +// The input value for RemoveTagsFromVaultInput . type RemoveTagsFromVaultInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_SetDataRetrievalPolicy.go b/service/glacier/api_op_SetDataRetrievalPolicy.go index f533498f827..e2d1ae8e479 100644 --- a/service/glacier/api_op_SetDataRetrievalPolicy.go +++ b/service/glacier/api_op_SetDataRetrievalPolicy.go @@ -17,8 +17,8 @@ import ( // account. The policy is enacted within a few minutes of a successful PUT // operation. The set policy operation does not affect retrieval jobs that were in // progress before the policy was enacted. For more information about data -// retrieval policies, see Amazon Glacier Data Retrieval Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html). +// retrieval policies, see Amazon Glacier Data Retrieval Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html) +// . func (c *Client) SetDataRetrievalPolicy(ctx context.Context, params *SetDataRetrievalPolicyInput, optFns ...func(*Options)) (*SetDataRetrievalPolicyOutput, error) { if params == nil { params = &SetDataRetrievalPolicyInput{} @@ -37,11 +37,11 @@ func (c *Client) SetDataRetrievalPolicy(ctx context.Context, params *SetDataRetr // SetDataRetrievalPolicy input. type SetDataRetrievalPolicyInput struct { - // The AccountId value is the AWS account ID. This value must match the AWS account - // ID associated with the credentials used to sign the request. You can either - // specify an AWS account ID or optionally a single '-' (hyphen), in which case - // Amazon Glacier uses the AWS account ID associated with the credentials used to - // sign the request. If you specify your account ID, do not include any hyphens + // The AccountId value is the AWS account ID. This value must match the AWS + // account ID associated with the credentials used to sign the request. You can + // either specify an AWS account ID or optionally a single ' - ' (hyphen), in which + // case Amazon Glacier uses the AWS account ID associated with the credentials used + // to sign the request. If you specify your account ID, do not include any hyphens // ('-') in the ID. // // This member is required. diff --git a/service/glacier/api_op_SetVaultAccessPolicy.go b/service/glacier/api_op_SetVaultAccessPolicy.go index 5378b8b1ecc..3fe25595fec 100644 --- a/service/glacier/api_op_SetVaultAccessPolicy.go +++ b/service/glacier/api_op_SetVaultAccessPolicy.go @@ -17,8 +17,8 @@ import ( // access-policy subresource of the vault. An access policy is specific to a vault // and is also called a vault subresource. You can set one access policy per vault // and the policy can be up to 20 KB in size. For more information about vault -// access policies, see Amazon Glacier Access Control with Vault Access Policies -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html). +// access policies, see Amazon Glacier Access Control with Vault Access Policies (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) +// . func (c *Client) SetVaultAccessPolicy(ctx context.Context, params *SetVaultAccessPolicyInput, optFns ...func(*Options)) (*SetVaultAccessPolicyOutput, error) { if params == nil { params = &SetVaultAccessPolicyInput{} @@ -38,8 +38,8 @@ func (c *Client) SetVaultAccessPolicy(ctx context.Context, params *SetVaultAcces type SetVaultAccessPolicyInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_SetVaultNotifications.go b/service/glacier/api_op_SetVaultNotifications.go index accb7744505..e5c417c6344 100644 --- a/service/glacier/api_op_SetVaultNotifications.go +++ b/service/glacier/api_op_SetVaultNotifications.go @@ -19,31 +19,24 @@ import ( // provides an Amazon SNS topic and specific events for which you want Amazon S3 // Glacier to send notifications to the topic. Amazon SNS topics must grant // permission to the vault to be allowed to publish notifications to the topic. You -// can configure a vault to publish a notification for the following vault -// events: +// can configure a vault to publish a notification for the following vault events: +// - ArchiveRetrievalCompleted This event occurs when a job that was initiated +// for an archive retrieval is completed ( InitiateJob ). The status of the +// completed job can be "Succeeded" or "Failed". The notification sent to the SNS +// topic is the same output as returned from DescribeJob . +// - InventoryRetrievalCompleted This event occurs when a job that was initiated +// for an inventory retrieval is completed ( InitiateJob ). The status of the +// completed job can be "Succeeded" or "Failed". The notification sent to the SNS +// topic is the same output as returned from DescribeJob . // -// * ArchiveRetrievalCompleted This event occurs when a job that was -// initiated for an archive retrieval is completed (InitiateJob). The status of the -// completed job can be "Succeeded" or "Failed". The notification sent to the SNS -// topic is the same output as returned from DescribeJob. -// -// * -// InventoryRetrievalCompleted This event occurs when a job that was initiated for -// an inventory retrieval is completed (InitiateJob). The status of the completed -// job can be "Succeeded" or "Failed". The notification sent to the SNS topic is -// the same output as returned from DescribeJob. -// -// An AWS account has full -// permission to perform all operations (actions). However, AWS Identity and Access -// Management (IAM) users don't have any permissions by default. You must grant -// them explicit permission to perform specific actions. For more information, see -// Access Control Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Configuring Vault -// Notifications in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) -// and Set Vault Notification Configuration -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html) +// An AWS account has full permission to perform all operations (actions). +// However, AWS Identity and Access Management (IAM) users don't have any +// permissions by default. You must grant them explicit permission to perform +// specific actions. For more information, see Access Control Using AWS Identity +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Configuring Vault +// Notifications in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html) +// and Set Vault Notification Configuration (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html) // in the Amazon Glacier Developer Guide. func (c *Client) SetVaultNotifications(ctx context.Context, params *SetVaultNotificationsInput, optFns ...func(*Options)) (*SetVaultNotificationsOutput, error) { if params == nil { @@ -65,8 +58,8 @@ func (c *Client) SetVaultNotifications(ctx context.Context, params *SetVaultNoti type SetVaultNotificationsInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/api_op_UploadArchive.go b/service/glacier/api_op_UploadArchive.go index eef1df4393c..7bb449f1b20 100644 --- a/service/glacier/api_op_UploadArchive.go +++ b/service/glacier/api_op_UploadArchive.go @@ -22,13 +22,12 @@ import ( // optional archive description field to specify how the archive is referred to in // an external index of archives, such as you might create in Amazon DynamoDB. You // can also get the vault inventory to obtain a list of archive IDs in a vault. For -// more information, see InitiateJob. You must provide a SHA256 tree hash of the +// more information, see InitiateJob . You must provide a SHA256 tree hash of the // data you are uploading. For information about computing a SHA256 tree hash, see -// Computing Checksums -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html). -// You can optionally specify an archive description of up to 1,024 printable ASCII -// characters. You can get the archive description when you either retrieve the -// archive or get the vault inventory. For more information, see InitiateJob. +// Computing Checksums (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html) +// . You can optionally specify an archive description of up to 1,024 printable +// ASCII characters. You can get the archive description when you either retrieve +// the archive or get the vault inventory. For more information, see InitiateJob . // Amazon Glacier does not interpret the description in any way. An archive // description does not need to be unique. You cannot use the description to // retrieve or sort the archive list. Archives are immutable. After you upload an @@ -36,14 +35,11 @@ import ( // permission to perform all operations (actions). However, AWS Identity and Access // Management (IAM) users don't have any permissions by default. You must grant // them explicit permission to perform specific actions. For more information, see -// Access Control Using AWS Identity and Access Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Uploading an Archive in -// Amazon Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html) -// and Upload Archive -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) in -// the Amazon Glacier Developer Guide. +// Access Control Using AWS Identity and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Uploading an Archive +// in Amazon Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html) +// and Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) +// in the Amazon Glacier Developer Guide. func (c *Client) UploadArchive(ctx context.Context, params *UploadArchiveInput, optFns ...func(*Options)) (*UploadArchiveOutput, error) { if params == nil { params = &UploadArchiveInput{} @@ -63,8 +59,8 @@ func (c *Client) UploadArchive(ctx context.Context, params *UploadArchiveInput, type UploadArchiveInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // @@ -89,10 +85,9 @@ type UploadArchiveInput struct { } // Contains the Amazon S3 Glacier response to your request. For information about -// the underlying REST API, see Upload Archive -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html). -// For conceptual information, see Working with Archives in Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html). +// the underlying REST API, see Upload Archive (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html) +// . For conceptual information, see Working with Archives in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html) +// . type UploadArchiveOutput struct { // The ID of the archive. This value is also included as part of the location. diff --git a/service/glacier/api_op_UploadMultipartPart.go b/service/glacier/api_op_UploadMultipartPart.go index 29f850fafae..fe6bb1c2a0b 100644 --- a/service/glacier/api_op_UploadMultipartPart.go +++ b/service/glacier/api_op_UploadMultipartPart.go @@ -12,50 +12,41 @@ import ( "io" ) -// This operation uploads a part of an archive. You can upload archive parts in any -// order. You can also upload them in parallel. You can upload up to 10,000 parts -// for a multipart upload. Amazon Glacier rejects your upload part request if any -// of the following conditions is true: +// This operation uploads a part of an archive. You can upload archive parts in +// any order. You can also upload them in parallel. You can upload up to 10,000 +// parts for a multipart upload. Amazon Glacier rejects your upload part request if +// any of the following conditions is true: +// - SHA256 tree hash does not matchTo ensure that part data is not corrupted in +// transmission, you compute a SHA256 tree hash of the part and include it in your +// request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 +// tree hash. If these hash values don't match, the operation fails. For +// information about computing a SHA256 tree hash, see Computing Checksums (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html) +// . +// - Part size does not matchThe size of each part except the last must match +// the size specified in the corresponding InitiateMultipartUpload request. The +// size of the last part must be the same size as, or smaller than, the specified +// size. If you upload a part whose size is smaller than the part size you +// specified in your initiate multipart upload request and that part is not the +// last part, then the upload part request will succeed. However, the subsequent +// Complete Multipart Upload request will fail. +// - Range does not alignThe byte range value in the request does not align with +// the part size specified in the corresponding initiate request. For example, if +// you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - +// 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if +// you set a range value of 2 MB to 6 MB, the range does not align with the part +// size and the upload will fail. // -// * SHA256 tree hash does not matchTo ensure -// that part data is not corrupted in transmission, you compute a SHA256 tree hash -// of the part and include it in your request. Upon receiving the part data, Amazon -// S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, -// the operation fails. For information about computing a SHA256 tree hash, see -// Computing Checksums -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html). -// -// * -// Part size does not matchThe size of each part except the last must match the -// size specified in the corresponding InitiateMultipartUpload request. The size of -// the last part must be the same size as, or smaller than, the specified size. If -// you upload a part whose size is smaller than the part size you specified in your -// initiate multipart upload request and that part is not the last part, then the -// upload part request will succeed. However, the subsequent Complete Multipart -// Upload request will fail. -// -// * Range does not alignThe byte range value in the -// request does not align with the part size specified in the corresponding -// initiate request. For example, if you specify a part size of 4194304 bytes (4 -// MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) -// are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the -// range does not align with the part size and the upload will fail. -// -// This -// operation is idempotent. If you upload the same part multiple times, the data -// included in the most recent request overwrites the previously uploaded data. An -// AWS account has full permission to perform all operations (actions). However, -// AWS Identity and Access Management (IAM) users don't have any permissions by -// default. You must grant them explicit permission to perform specific actions. -// For more information, see Access Control Using AWS Identity and Access -// Management (IAM) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html). -// For conceptual information and underlying REST API, see Uploading Large Archives -// in Parts (Multipart Upload) -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) -// and Upload Part -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html) in -// the Amazon Glacier Developer Guide. +// This operation is idempotent. If you upload the same part multiple times, the +// data included in the most recent request overwrites the previously uploaded +// data. An AWS account has full permission to perform all operations (actions). +// However, AWS Identity and Access Management (IAM) users don't have any +// permissions by default. You must grant them explicit permission to perform +// specific actions. For more information, see Access Control Using AWS Identity +// and Access Management (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html) +// . For conceptual information and underlying REST API, see Uploading Large +// Archives in Parts (Multipart Upload) (https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html) +// and Upload Part (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html) +// in the Amazon Glacier Developer Guide. func (c *Client) UploadMultipartPart(ctx context.Context, params *UploadMultipartPartInput, optFns ...func(*Options)) (*UploadMultipartPartOutput, error) { if params == nil { params = &UploadMultipartPartInput{} @@ -75,8 +66,8 @@ func (c *Client) UploadMultipartPart(ctx context.Context, params *UploadMultipar type UploadMultipartPartInput struct { // The AccountId value is the AWS account ID of the account that owns the vault. - // You can either specify an AWS account ID or optionally a single '-' (hyphen), in - // which case Amazon S3 Glacier uses the AWS account ID associated with the + // You can either specify an AWS account ID or optionally a single ' - ' (hyphen), + // in which case Amazon S3 Glacier uses the AWS account ID associated with the // credentials used to sign the request. If you use an account ID, do not include // any hyphens ('-') in the ID. // diff --git a/service/glacier/doc.go b/service/glacier/doc.go index 58f814eb2a6..3bf1797d16b 100644 --- a/service/glacier/doc.go +++ b/service/glacier/doc.go @@ -3,8 +3,8 @@ // Package glacier provides the API client, operations, and parameter types for // Amazon Glacier. // -// Amazon S3 Glacier (Glacier) is a storage solution for "cold data." Glacier is an -// extremely low-cost storage service that provides secure, durable, and +// Amazon S3 Glacier (Glacier) is a storage solution for "cold data." Glacier is +// an extremely low-cost storage service that provides secure, durable, and // easy-to-use storage for data backup and archival. With Glacier, customers can // store their data cost effectively for months, years, or decades. Glacier also // enables customers to offload the administrative burdens of operating and scaling @@ -13,21 +13,17 @@ // hardware migrations. Glacier is a great storage choice when low storage cost is // paramount and your data is rarely retrieved. If your application requires fast // or frequent access to your data, consider using Amazon S3. For more information, -// see Amazon Simple Storage Service (Amazon S3) (http://aws.amazon.com/s3/). You +// see Amazon Simple Storage Service (Amazon S3) (http://aws.amazon.com/s3/) . You // can store any kind of data in any format. There is no maximum limit on the total // amount of data you can store in Glacier. If you are a first-time user of // Glacier, we recommend that you begin by reading the following sections in the // Amazon S3 Glacier Developer Guide: -// -// * What is Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html) - This -// section of the Developer Guide describes the underlying data model, the -// operations it supports, and the AWS SDKs that you can use to interact with the -// service. -// -// * Getting Started with Amazon S3 Glacier -// (https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html) -// - The Getting Started section walks you through the process of creating a vault, -// uploading archives, creating jobs to download archives, retrieving the job -// output, and deleting archives. +// - What is Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html) +// - This section of the Developer Guide describes the underlying data model, the +// operations it supports, and the AWS SDKs that you can use to interact with the +// service. +// - Getting Started with Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html) +// - The Getting Started section walks you through the process of creating a vault, +// uploading archives, creating jobs to download archives, retrieving the job +// output, and deleting archives. package glacier diff --git a/service/glacier/types/enums.go b/service/glacier/types/enums.go index e93a88cd4f5..10b6a75a2ca 100644 --- a/service/glacier/types/enums.go +++ b/service/glacier/types/enums.go @@ -35,9 +35,9 @@ const ( CannedACLBucketOwnerFullControl CannedACL = "bucket-owner-full-control" ) -// Values returns all known values for CannedACL. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for CannedACL. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (CannedACL) Values() []CannedACL { return []CannedACL{ "private", @@ -175,9 +175,9 @@ const ( StorageClassStandardInfrequentAccess StorageClass = "STANDARD_IA" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "STANDARD", diff --git a/service/glacier/types/types.go b/service/glacier/types/types.go index 9ce8143dec0..eb2088fce17 100644 --- a/service/glacier/types/types.go +++ b/service/glacier/types/types.go @@ -16,7 +16,7 @@ type CSVInput struct { // A value used to separate individual fields from each other within a record. FieldDelimiter *string - // Describes the first line of input. Valid values are None, Ignore, and Use. + // Describes the first line of input. Valid values are None , Ignore , and Use . FileHeaderInfo FileHeaderInfo // A value used as an escape character where the field delimiter is part of the @@ -72,7 +72,7 @@ type DataRetrievalPolicy struct { type DataRetrievalRule struct { // The maximum number of bytes that can be retrieved in an hour. This field is - // required only if the value of the Strategy field is BytesPerHour. Your PUT + // required only if the value of the Strategy field is BytesPerHour . Your PUT // operation will be rejected if the Strategy field is not set to BytesPerHour and // you set this field. BytesPerHour *int64 @@ -87,14 +87,14 @@ type DataRetrievalRule struct { // Contains the Amazon S3 Glacier response to your request. type DescribeVaultOutput struct { - // The Universal Coordinated Time (UTC) date when the vault was created. This value - // should be a string in the ISO 8601 date format, for example - // 2012-03-20T17:03:43.221Z. + // The Universal Coordinated Time (UTC) date when the vault was created. This + // value should be a string in the ISO 8601 date format, for example + // 2012-03-20T17:03:43.221Z . CreationDate *string // The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the // last vault inventory. This value should be a string in the ISO 8601 date format, - // for example 2012-03-20T17:03:43.221Z. + // for example 2012-03-20T17:03:43.221Z . LastInventoryDate *string // The number of archives in the vault as of the last inventory date. This field @@ -120,17 +120,17 @@ type DescribeVaultOutput struct { // Amazon S3. type Encryption struct { - // The server-side encryption algorithm used when storing job results in Amazon S3, - // for example AES256 or aws:kms. + // The server-side encryption algorithm used when storing job results in Amazon + // S3, for example AES256 or aws:kms . EncryptionType EncryptionType - // Optional. If the encryption type is aws:kms, you can use this value to specify + // Optional. If the encryption type is aws:kms , you can use this value to specify // the encryption context for the job results. KMSContext *string - // The AWS KMS key ID to use for object encryption. All GET and PUT requests for an - // object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) - // or Signature Version 4. + // The AWS KMS key ID to use for object encryption. All GET and PUT requests for + // an object protected by AWS KMS fail if not made by using Secure Sockets Layer + // (SSL) or Signature Version 4. KMSKeyId *string noSmithyDocumentSerde @@ -139,8 +139,8 @@ type Encryption struct { // Contains the description of an Amazon S3 Glacier job. type GlacierJobDescription struct { - // The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or - // Select. + // The job type. This value is either ArchiveRetrieval , InventoryRetrieval , or + // Select . Action ActionCode // The archive ID requested for a select job or archive retrieval. Otherwise, this @@ -165,15 +165,15 @@ type GlacierJobDescription struct { CompletionDate *string // The UTC date when the job was created. This value is a string representation of - // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z". + // ISO 8601 date format, for example "2012-03-20T17:03:43.221Z" . CreationDate *string // Parameters used for range inventory retrieval. InventoryRetrievalParameters *InventoryRetrievalJobDescription - // For an inventory retrieval job, this value is the size in bytes of the inventory - // requested for download. For an archive retrieval or select job, this value is - // null. + // For an inventory retrieval job, this value is the size in bytes of the + // inventory requested for download. For an archive retrieval or select job, this + // value is null. InventorySizeInBytes *int64 // The job description provided when initiating the job. @@ -201,17 +201,13 @@ type GlacierJobDescription struct { // tree-hash aligned range, then this field returns a value. If the whole archive // is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This // field is null for the following: + // - Archive retrieval jobs that specify a range that is not tree-hash aligned // - // * Archive retrieval jobs that specify a range - // that is not tree-hash aligned - // - // * Archival jobs that specify a range that is - // equal to the whole archive, when the job status is InProgress + // - Archival jobs that specify a range that is equal to the whole archive, when + // the job status is InProgress // - // * Inventory - // jobs - // - // * Select jobs + // - Inventory jobs + // - Select jobs SHA256TreeHash *string // An Amazon SNS topic that receives notification. @@ -220,15 +216,15 @@ type GlacierJobDescription struct { // Contains the parameters used for a select. SelectParameters *SelectParameters - // The status code can be InProgress, Succeeded, or Failed, and indicates the + // The status code can be InProgress , Succeeded , or Failed , and indicates the // status of the job. StatusCode StatusCode // A friendly message that describes the job status. StatusMessage *string - // The tier to use for a select or an archive retrieval. Valid values are - // Expedited, Standard, or Bulk. Standard is the default. + // The tier to use for a select or an archive retrieval. Valid values are Expedited + // , Standard , or Bulk . Standard is the default. Tier *string // The Amazon Resource Name (ARN) of the vault from which an archive retrieval was @@ -287,12 +283,12 @@ type InventoryRetrievalJobDescription struct { // The end of the date range in UTC for vault inventory retrieval that includes // archives created before this date. This value should be a string in the ISO 8601 - // date format, for example 2013-03-20T17:03:43Z. + // date format, for example 2013-03-20T17:03:43Z . EndDate *string // The output format for the vault inventory list, which is set by the InitiateJob // request when initiating a job to retrieve a vault inventory. Valid values are - // CSV and JSON. + // CSV and JSON . Format *string // The maximum number of inventory items returned per vault inventory retrieval @@ -303,14 +299,14 @@ type InventoryRetrievalJobDescription struct { // An opaque string that represents where to continue pagination of the vault // inventory retrieval results. You use the marker in a new InitiateJob request to // obtain additional inventory items. If there are no more inventory items, this - // value is null. For more information, see Range Inventory Retrieval - // (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering). + // value is null . For more information, see Range Inventory Retrieval (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering) + // . Marker *string // The start of the date range in Universal Coordinated Time (UTC) for vault // inventory retrieval that includes archives created on or after this date. This // value should be a string in the ISO 8601 date format, for example - // 2013-03-20T17:03:43Z. + // 2013-03-20T17:03:43Z . StartDate *string noSmithyDocumentSerde @@ -321,7 +317,7 @@ type InventoryRetrievalJobInput struct { // The end of the date range in UTC for vault inventory retrieval that includes // archives created before this date. This value should be a string in the ISO 8601 - // date format, for example 2013-03-20T17:03:43Z. + // date format, for example 2013-03-20T17:03:43Z . EndDate *string // Specifies the maximum number of inventory items returned per vault inventory @@ -331,12 +327,12 @@ type InventoryRetrievalJobInput struct { // An opaque string that represents where to continue pagination of the vault // inventory retrieval results. You use the marker in a new InitiateJob request to // obtain additional inventory items. If there are no more inventory items, this - // value is null. + // value is null . Marker *string // The start of the date range in UTC for vault inventory retrieval that includes // archives created on or after this date. This value should be a string in the ISO - // 8601 date format, for example 2013-03-20T17:03:43Z. + // 8601 date format, for example 2013-03-20T17:03:43Z . StartDate *string noSmithyDocumentSerde @@ -346,19 +342,19 @@ type InventoryRetrievalJobInput struct { type JobParameters struct { // The ID of the archive that you want to retrieve. This field is required only if - // Type is set to select or archive-retrievalcode>. An error occurs if you specify + // Type is set to select or archive-retrieval code>. An error occurs if you specify // this request parameter for an inventory retrieval job request. ArchiveId *string - // The optional description for the job. The description must be less than or equal - // to 1,024 bytes. The allowable characters are 7-bit ASCII without control + // The optional description for the job. The description must be less than or + // equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control // codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. Description *string - // When initiating a job to retrieve a vault inventory, you can optionally add this - // parameter to your request to specify the output format. If you are initiating an - // inventory job and do not specify a Format field, JSON is the default format. - // Valid values are "CSV" and "JSON". + // When initiating a job to retrieve a vault inventory, you can optionally add + // this parameter to your request to specify the output format. If you are + // initiating an inventory job and do not specify a Format field, JSON is the + // default format. Valid values are "CSV" and "JSON". Format *string // Input parameters used for range inventory retrieval. @@ -386,7 +382,7 @@ type JobParameters struct { SelectParameters *SelectParameters // The tier to use for a select or an archive retrieval job. Valid values are - // Expedited, Standard, or Bulk. Standard is the default. + // Expedited , Standard , or Bulk . Standard is the default. Tier *string // The job type. You can initiate a job to perform a select query on an archive, @@ -422,7 +418,7 @@ type PartListElement struct { RangeInBytes *string // The SHA256 tree hash value that Amazon S3 Glacier calculated for the part. This - // field is never null. + // field is never null . SHA256TreeHash *string noSmithyDocumentSerde @@ -483,7 +479,7 @@ type SelectParameters struct { // The expression that is used to select the object. Expression *string - // The type of the provided expression, for example SQL. + // The type of the provided expression, for example SQL . ExpressionType ExpressionType // Describes the serialization format of the object. diff --git a/service/globalaccelerator/api_client.go b/service/globalaccelerator/api_client.go index 283df6dad56..86af1262d91 100644 --- a/service/globalaccelerator/api_client.go +++ b/service/globalaccelerator/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go b/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go index 82b27844954..0bb9730ac4a 100644 --- a/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go +++ b/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate a virtual private cloud (VPC) subnet endpoint with your custom routing -// accelerator. The listener port range must be large enough to support the number -// of IP addresses that can be specified in your subnet. The number of ports +// Associate a virtual private cloud (VPC) subnet endpoint with your custom +// routing accelerator. The listener port range must be large enough to support the +// number of IP addresses that can be specified in your subnet. The number of ports // required is: subnet size times the number of ports per destination EC2 // instances. For example, a subnet defined as /24 requires a listener port range // of at least 255 ports. Note: You must have enough remaining listener ports @@ -21,8 +21,7 @@ import ( // LimitExceededException. By default, all destinations in a subnet in a custom // routing accelerator cannot receive traffic. To enable all destinations to // receive traffic, or to specify individual port mappings that can receive -// traffic, see the AllowCustomRoutingTraffic -// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html) +// traffic, see the AllowCustomRoutingTraffic (https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html) // operation. func (c *Client) AddCustomRoutingEndpoints(ctx context.Context, params *AddCustomRoutingEndpointsInput, optFns ...func(*Options)) (*AddCustomRoutingEndpointsOutput, error) { if params == nil { diff --git a/service/globalaccelerator/api_op_AddEndpoints.go b/service/globalaccelerator/api_op_AddEndpoints.go index 9ed5c653219..78a990a9730 100644 --- a/service/globalaccelerator/api_op_AddEndpoints.go +++ b/service/globalaccelerator/api_op_AddEndpoints.go @@ -13,19 +13,14 @@ import ( // Add endpoints to an endpoint group. The AddEndpoints API operation is the // recommended option for adding endpoints. The alternative options are to add -// endpoints when you create an endpoint group (with the CreateEndpointGroup -// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html) -// API) or when you update an endpoint group (with the UpdateEndpointGroup -// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html) +// endpoints when you create an endpoint group (with the CreateEndpointGroup (https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html) +// API) or when you update an endpoint group (with the UpdateEndpointGroup (https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html) // API). There are two advantages to using AddEndpoints to add endpoints: -// -// * It's -// faster, because Global Accelerator only has to resolve the new endpoints that -// you're adding. -// -// * It's more convenient, because you don't need to specify all of -// the current endpoints that are already in the endpoint group in addition to the -// new endpoints that you want to add. +// - It's faster, because Global Accelerator only has to resolve the new +// endpoints that you're adding. +// - It's more convenient, because you don't need to specify all of the current +// endpoints that are already in the endpoint group in addition to the new +// endpoints that you want to add. func (c *Client) AddEndpoints(ctx context.Context, params *AddEndpointsInput, optFns ...func(*Options)) (*AddEndpointsOutput, error) { if params == nil { params = &AddEndpointsInput{} diff --git a/service/globalaccelerator/api_op_AdvertiseByoipCidr.go b/service/globalaccelerator/api_op_AdvertiseByoipCidr.go index cd7e006604d..bbce4a2f5bf 100644 --- a/service/globalaccelerator/api_op_AdvertiseByoipCidr.go +++ b/service/globalaccelerator/api_op_AdvertiseByoipCidr.go @@ -15,11 +15,9 @@ import ( // Web Services resources through bring your own IP addresses (BYOIP). It can take // a few minutes before traffic to the specified addresses starts routing to Amazon // Web Services because of propagation delays. To stop advertising the BYOIP -// address range, use WithdrawByoipCidr -// (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html). -// For more information, see Bring your own IP addresses (BYOIP) -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in -// the Global Accelerator Developer Guide. +// address range, use WithdrawByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html) +// . For more information, see Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) +// in the Global Accelerator Developer Guide. func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipCidrInput, optFns ...func(*Options)) (*AdvertiseByoipCidrOutput, error) { if params == nil { params = &AdvertiseByoipCidrInput{} diff --git a/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go b/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go index 274d9f19279..873af03463a 100644 --- a/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go +++ b/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go @@ -57,11 +57,11 @@ type AllowCustomRoutingTrafficInput struct { // the endpoint group. The default value is FALSE. AllowAllTrafficToEndpoint *bool - // A list of specific Amazon EC2 instance IP addresses (destination addresses) in a - // subnet that you want to allow to receive traffic. The IP addresses must be a + // A list of specific Amazon EC2 instance IP addresses (destination addresses) in + // a subnet that you want to allow to receive traffic. The IP addresses must be a // subset of the IP addresses that you specified for the endpoint group. - // DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not - // specified. + // DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is + // not specified. DestinationAddresses []string // A list of specific Amazon EC2 instance ports (destination ports) that you want diff --git a/service/globalaccelerator/api_op_CreateAccelerator.go b/service/globalaccelerator/api_op_CreateAccelerator.go index dc0fe17c6c0..e4102946e68 100644 --- a/service/globalaccelerator/api_op_CreateAccelerator.go +++ b/service/globalaccelerator/api_op_CreateAccelerator.go @@ -71,14 +71,12 @@ type CreateAcceleratorInput struct { // two addresses, separated by a space. Do not include the /32 suffix. Note that // you can't update IP addresses for an existing accelerator. To change them, you // must create a new accelerator with the new addresses. For more information, see - // Bring your own IP addresses (BYOIP) - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in - // the Global Accelerator Developer Guide. + // Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) + // in the Global Accelerator Developer Guide. IpAddresses []string // Create tags for an accelerator. For more information, see Tagging in Global - // Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) + // Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the Global Accelerator Developer Guide. Tags []types.Tag diff --git a/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go b/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go index 9f505ccb1b0..7a0583ef2d6 100644 --- a/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go +++ b/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go @@ -18,8 +18,7 @@ import ( // that, by default, all destination EC2 instances in a VPC subnet endpoint cannot // receive traffic. To enable all destinations to receive traffic, or to specify // individual port mappings that can receive traffic, see the -// AllowCustomRoutingTraffic -// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html) +// AllowCustomRoutingTraffic (https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html) // operation. Global Accelerator is a global service that supports endpoints in // multiple Amazon Web Services Regions but you must specify the US West (Oregon) // Region to create, update, or otherwise work with accelerators. That is, for @@ -76,14 +75,12 @@ type CreateCustomRoutingAcceleratorInput struct { // two addresses, separated by a space. Do not include the /32 suffix. Note that // you can't update IP addresses for an existing accelerator. To change them, you // must create a new accelerator with the new addresses. For more information, see - // Bring your own IP addresses (BYOIP) - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in - // the Global Accelerator Developer Guide. + // Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) + // in the Global Accelerator Developer Guide. IpAddresses []string // Create tags for an accelerator. For more information, see Tagging in Global - // Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) + // Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the Global Accelerator Developer Guide. Tags []types.Tag diff --git a/service/globalaccelerator/api_op_CreateCustomRoutingListener.go b/service/globalaccelerator/api_op_CreateCustomRoutingListener.go index 485badff43b..6d3f8f0da00 100644 --- a/service/globalaccelerator/api_op_CreateCustomRoutingListener.go +++ b/service/globalaccelerator/api_op_CreateCustomRoutingListener.go @@ -45,8 +45,8 @@ type CreateCustomRoutingListenerInput struct { // The port range to support for connections from clients to your accelerator. // Separately, you set port ranges for endpoints. For more information, see About - // endpoints for custom routing accelerators - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html). + // endpoints for custom routing accelerators (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) + // . // // This member is required. PortRanges []types.PortRange diff --git a/service/globalaccelerator/api_op_CreateEndpointGroup.go b/service/globalaccelerator/api_op_CreateEndpointGroup.go index 4a09bc7f276..f22d823f835 100644 --- a/service/globalaccelerator/api_op_CreateEndpointGroup.go +++ b/service/globalaccelerator/api_op_CreateEndpointGroup.go @@ -52,8 +52,8 @@ type CreateEndpointGroupInput struct { // The list of endpoint objects. EndpointConfigurations []types.EndpointConfiguration - // The time—10 seconds or 30 seconds—between each health check for an endpoint. The - // default value is 30. + // The time—10 seconds or 30 seconds—between each health check for an endpoint. + // The default value is 30. HealthCheckIntervalSeconds *int32 // If the protocol is HTTP/S, then this specifies the path that is the destination @@ -74,8 +74,7 @@ type CreateEndpointGroupInput struct { // part of this endpoint group. For example, you can create a port override in // which the listener receives user traffic on ports 80 and 443, but your // accelerator routes that traffic to ports 1080 and 1443, respectively, on the - // endpoints. For more information, see Overriding listener ports - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) + // endpoints. For more information, see Overriding listener ports (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) // in the Global Accelerator Developer Guide. PortOverrides []types.PortOverride diff --git a/service/globalaccelerator/api_op_CreateListener.go b/service/globalaccelerator/api_op_CreateListener.go index 87d66d96283..ed0c3ebc973 100644 --- a/service/globalaccelerator/api_op_CreateListener.go +++ b/service/globalaccelerator/api_op_CreateListener.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a listener to process inbound connections from clients to an accelerator. -// Connections arrive to assigned static IP addresses on a port, port range, or -// list of port ranges that you specify. +// Create a listener to process inbound connections from clients to an +// accelerator. Connections arrive to assigned static IP addresses on a port, port +// range, or list of port ranges that you specify. func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error) { if params == nil { params = &CreateListenerInput{} @@ -59,16 +59,16 @@ type CreateListenerInput struct { // client request. Client affinity gives you control over whether to always route // each client to the same specific endpoint. Global Accelerator uses a // consistent-flow hashing algorithm to choose the optimal endpoint for a - // connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" - // (5-tuple) properties—source IP address, source port, destination IP address, - // destination port, and protocol—to select the hash value, and then chooses the - // best endpoint. However, with this setting, if someone uses different ports to - // connect to Global Accelerator, their connections might not be always routed to - // the same endpoint because the hash value changes. If you want a given client to - // always be routed to the same endpoint, set client affinity to SOURCE_IP instead. - // When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" - // (2-tuple) properties— source (client) IP address and destination IP address—to - // select the hash value. The default value is NONE. + // connection. If client affinity is NONE , Global Accelerator uses the + // "five-tuple" (5-tuple) properties—source IP address, source port, destination IP + // address, destination port, and protocol—to select the hash value, and then + // chooses the best endpoint. However, with this setting, if someone uses different + // ports to connect to Global Accelerator, their connections might not be always + // routed to the same endpoint because the hash value changes. If you want a given + // client to always be routed to the same endpoint, set client affinity to + // SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses + // the "two-tuple" (2-tuple) properties— source (client) IP address and destination + // IP address—to select the hash value. The default value is NONE . ClientAffinity types.ClientAffinity noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_DeleteAccelerator.go b/service/globalaccelerator/api_op_DeleteAccelerator.go index cd2179a982c..efd29479350 100644 --- a/service/globalaccelerator/api_op_DeleteAccelerator.go +++ b/service/globalaccelerator/api_op_DeleteAccelerator.go @@ -10,21 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an accelerator. Before you can delete an accelerator, you must disable it -// and remove all dependent resources (listeners and endpoint groups). To disable -// the accelerator, update the accelerator to set Enabled to false. When you create -// an accelerator, by default, Global Accelerator provides you with a set of two -// static IP addresses. Alternatively, you can bring your own IP address ranges to -// Global Accelerator and assign IP addresses from those ranges. The IP addresses -// are assigned to your accelerator for as long as it exists, even if you disable -// the accelerator and it no longer accepts or routes traffic. However, when you -// delete an accelerator, you lose the static IP addresses that are assigned to the -// accelerator, so you can no longer route traffic by using them. As a best -// practice, ensure that you have permissions in place to avoid inadvertently -// deleting accelerators. You can use IAM policies with Global Accelerator to limit -// the users who have permissions to delete an accelerator. For more information, -// see Identity and access management -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) +// Delete an accelerator. Before you can delete an accelerator, you must disable +// it and remove all dependent resources (listeners and endpoint groups). To +// disable the accelerator, update the accelerator to set Enabled to false. When +// you create an accelerator, by default, Global Accelerator provides you with a +// set of two static IP addresses. Alternatively, you can bring your own IP address +// ranges to Global Accelerator and assign IP addresses from those ranges. The IP +// addresses are assigned to your accelerator for as long as it exists, even if you +// disable the accelerator and it no longer accepts or routes traffic. However, +// when you delete an accelerator, you lose the static IP addresses that are +// assigned to the accelerator, so you can no longer route traffic by using them. +// As a best practice, ensure that you have permissions in place to avoid +// inadvertently deleting accelerators. You can use IAM policies with Global +// Accelerator to limit the users who have permissions to delete an accelerator. +// For more information, see Identity and access management (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) // in the Global Accelerator Developer Guide. func (c *Client) DeleteAccelerator(ctx context.Context, params *DeleteAcceleratorInput, optFns ...func(*Options)) (*DeleteAcceleratorOutput, error) { if params == nil { diff --git a/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go b/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go index 3729a5121d8..aea421debbd 100644 --- a/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go +++ b/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go @@ -22,8 +22,7 @@ import ( // practice, ensure that you have permissions in place to avoid inadvertently // deleting accelerators. You can use IAM policies with Global Accelerator to limit // the users who have permissions to delete an accelerator. For more information, -// see Identity and access management -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) +// see Identity and access management (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) // in the Global Accelerator Developer Guide. func (c *Client) DeleteCustomRoutingAccelerator(ctx context.Context, params *DeleteCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*DeleteCustomRoutingAcceleratorOutput, error) { if params == nil { diff --git a/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go b/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go index 328c694220a..f91f7cf10ab 100644 --- a/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go +++ b/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go @@ -57,9 +57,9 @@ type DenyCustomRoutingTrafficInput struct { // the endpoint group. The default value is FALSE. DenyAllTrafficToEndpoint *bool - // A list of specific Amazon EC2 instance IP addresses (destination addresses) in a - // subnet that you want to prevent from receiving traffic. The IP addresses must be - // a subset of the IP addresses allowed for the VPC subnet associated with the + // A list of specific Amazon EC2 instance IP addresses (destination addresses) in + // a subnet that you want to prevent from receiving traffic. The IP addresses must + // be a subset of the IP addresses allowed for the VPC subnet associated with the // endpoint group. DestinationAddresses []string diff --git a/service/globalaccelerator/api_op_DeprovisionByoipCidr.go b/service/globalaccelerator/api_op_DeprovisionByoipCidr.go index 98b46fc9e9e..ae3dd86d44e 100644 --- a/service/globalaccelerator/api_op_DeprovisionByoipCidr.go +++ b/service/globalaccelerator/api_op_DeprovisionByoipCidr.go @@ -14,13 +14,11 @@ import ( // Releases the specified address range that you provisioned to use with your // Amazon Web Services resources through bring your own IP addresses (BYOIP) and // deletes the corresponding address pool. Before you can release an address range, -// you must stop advertising it by using WithdrawByoipCidr -// (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html) +// you must stop advertising it by using WithdrawByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html) // and you must not have any accelerators that are using static IP addresses // allocated from its address range. For more information, see Bring your own IP -// addresses (BYOIP) -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in -// the Global Accelerator Developer Guide. +// addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) +// in the Global Accelerator Developer Guide. func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionByoipCidrInput, optFns ...func(*Options)) (*DeprovisionByoipCidrOutput, error) { if params == nil { params = &DeprovisionByoipCidrInput{} @@ -38,8 +36,8 @@ func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionBy type DeprovisionByoipCidrInput struct { - // The address range, in CIDR notation. The prefix must be the same prefix that you - // specified when you provisioned the address range. + // The address range, in CIDR notation. The prefix must be the same prefix that + // you specified when you provisioned the address range. // // This member is required. Cidr *string diff --git a/service/globalaccelerator/api_op_DescribeCustomRoutingAcceleratorAttributes.go b/service/globalaccelerator/api_op_DescribeCustomRoutingAcceleratorAttributes.go index b5c139c64f2..ee4c94137c2 100644 --- a/service/globalaccelerator/api_op_DescribeCustomRoutingAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_DescribeCustomRoutingAcceleratorAttributes.go @@ -29,8 +29,8 @@ func (c *Client) DescribeCustomRoutingAcceleratorAttributes(ctx context.Context, type DescribeCustomRoutingAcceleratorAttributesInput struct { - // The Amazon Resource Name (ARN) of the custom routing accelerator to describe the - // attributes for. + // The Amazon Resource Name (ARN) of the custom routing accelerator to describe + // the attributes for. // // This member is required. AcceleratorArn *string diff --git a/service/globalaccelerator/api_op_ListAccelerators.go b/service/globalaccelerator/api_op_ListAccelerators.go index b9b1820f8bb..4e3e0945d65 100644 --- a/service/globalaccelerator/api_op_ListAccelerators.go +++ b/service/globalaccelerator/api_op_ListAccelerators.go @@ -30,8 +30,8 @@ func (c *Client) ListAccelerators(ctx context.Context, params *ListAcceleratorsI type ListAcceleratorsInput struct { - // The number of Global Accelerator objects that you want to return with this call. - // The default value is 10. + // The number of Global Accelerator objects that you want to return with this + // call. The default value is 10. MaxResults *int32 // The token for the next set of results. You receive this token from a previous @@ -126,8 +126,8 @@ var _ ListAcceleratorsAPIClient = (*Client)(nil) // ListAcceleratorsPaginatorOptions is the paginator options for ListAccelerators type ListAcceleratorsPaginatorOptions struct { - // The number of Global Accelerator objects that you want to return with this call. - // The default value is 10. + // The number of Global Accelerator objects that you want to return with this + // call. The default value is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/globalaccelerator/api_op_ListByoipCidrs.go b/service/globalaccelerator/api_op_ListByoipCidrs.go index 4202897a757..22b3c12609b 100644 --- a/service/globalaccelerator/api_op_ListByoipCidrs.go +++ b/service/globalaccelerator/api_op_ListByoipCidrs.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the IP address ranges that were specified in calls to ProvisionByoipCidr -// (https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html), -// including the current state and a history of state changes. +// Lists the IP address ranges that were specified in calls to ProvisionByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html) +// , including the current state and a history of state changes. func (c *Client) ListByoipCidrs(ctx context.Context, params *ListByoipCidrsInput, optFns ...func(*Options)) (*ListByoipCidrsOutput, error) { if params == nil { params = &ListByoipCidrsInput{} diff --git a/service/globalaccelerator/api_op_ListCustomRoutingEndpointGroups.go b/service/globalaccelerator/api_op_ListCustomRoutingEndpointGroups.go index 663bd79bf9a..858d331db85 100644 --- a/service/globalaccelerator/api_op_ListCustomRoutingEndpointGroups.go +++ b/service/globalaccelerator/api_op_ListCustomRoutingEndpointGroups.go @@ -36,8 +36,8 @@ type ListCustomRoutingEndpointGroupsInput struct { // This member is required. ListenerArn *string - // The number of endpoint group objects that you want to return with this call. The - // default value is 10. + // The number of endpoint group objects that you want to return with this call. + // The default value is 10. MaxResults *int32 // The token for the next set of results. You receive this token from a previous @@ -137,8 +137,8 @@ var _ ListCustomRoutingEndpointGroupsAPIClient = (*Client)(nil) // ListCustomRoutingEndpointGroupsPaginatorOptions is the paginator options for // ListCustomRoutingEndpointGroups type ListCustomRoutingEndpointGroupsPaginatorOptions struct { - // The number of endpoint group objects that you want to return with this call. The - // default value is 10. + // The number of endpoint group objects that you want to return with this call. + // The default value is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/globalaccelerator/api_op_ListCustomRoutingPortMappingsByDestination.go b/service/globalaccelerator/api_op_ListCustomRoutingPortMappingsByDestination.go index 77579f72212..7cf8f486e9e 100644 --- a/service/globalaccelerator/api_op_ListCustomRoutingPortMappingsByDestination.go +++ b/service/globalaccelerator/api_op_ListCustomRoutingPortMappingsByDestination.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the port mappings for a specific EC2 instance (destination) in a VPC subnet -// endpoint. The response is the mappings for one destination IP address. This is -// useful when your subnet endpoint has mappings that span multiple custom routing -// accelerators in your account, or for scenarios where you only want to list the -// port mappings for a specific destination instance. +// List the port mappings for a specific EC2 instance (destination) in a VPC +// subnet endpoint. The response is the mappings for one destination IP address. +// This is useful when your subnet endpoint has mappings that span multiple custom +// routing accelerators in your account, or for scenarios where you only want to +// list the port mappings for a specific destination instance. func (c *Client) ListCustomRoutingPortMappingsByDestination(ctx context.Context, params *ListCustomRoutingPortMappingsByDestinationInput, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsByDestinationOutput, error) { if params == nil { params = &ListCustomRoutingPortMappingsByDestinationInput{} diff --git a/service/globalaccelerator/api_op_ListEndpointGroups.go b/service/globalaccelerator/api_op_ListEndpointGroups.go index 37a41793d0b..7e5950ddfd6 100644 --- a/service/globalaccelerator/api_op_ListEndpointGroups.go +++ b/service/globalaccelerator/api_op_ListEndpointGroups.go @@ -35,8 +35,8 @@ type ListEndpointGroupsInput struct { // This member is required. ListenerArn *string - // The number of endpoint group objects that you want to return with this call. The - // default value is 10. + // The number of endpoint group objects that you want to return with this call. + // The default value is 10. MaxResults *int32 // The token for the next set of results. You receive this token from a previous @@ -135,8 +135,8 @@ var _ ListEndpointGroupsAPIClient = (*Client)(nil) // ListEndpointGroupsPaginatorOptions is the paginator options for // ListEndpointGroups type ListEndpointGroupsPaginatorOptions struct { - // The number of endpoint group objects that you want to return with this call. The - // default value is 10. + // The number of endpoint group objects that you want to return with this call. + // The default value is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/globalaccelerator/api_op_ListTagsForResource.go b/service/globalaccelerator/api_op_ListTagsForResource.go index 44666f76a8d..70a46433ef4 100644 --- a/service/globalaccelerator/api_op_ListTagsForResource.go +++ b/service/globalaccelerator/api_op_ListTagsForResource.go @@ -12,8 +12,7 @@ import ( ) // List all tags for an accelerator. For more information, see Tagging in Global -// Accelerator -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) +// Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the Global Accelerator Developer Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/globalaccelerator/api_op_ProvisionByoipCidr.go b/service/globalaccelerator/api_op_ProvisionByoipCidr.go index d49c3a37a29..da02354fdea 100644 --- a/service/globalaccelerator/api_op_ProvisionByoipCidr.go +++ b/service/globalaccelerator/api_op_ProvisionByoipCidr.go @@ -14,11 +14,9 @@ import ( // Provisions an IP address range to use with your Amazon Web Services resources // through bring your own IP addresses (BYOIP) and creates a corresponding address // pool. After the address range is provisioned, it is ready to be advertised using -// AdvertiseByoipCidr -// (https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html). -// For more information, see Bring your own IP addresses (BYOIP) -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in -// the Global Accelerator Developer Guide. +// AdvertiseByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html) +// . For more information, see Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) +// in the Global Accelerator Developer Guide. func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipCidrInput, optFns ...func(*Options)) (*ProvisionByoipCidrOutput, error) { if params == nil { params = &ProvisionByoipCidrInput{} diff --git a/service/globalaccelerator/api_op_RemoveCustomRoutingEndpoints.go b/service/globalaccelerator/api_op_RemoveCustomRoutingEndpoints.go index 566fa9fac60..4812d2ae99e 100644 --- a/service/globalaccelerator/api_op_RemoveCustomRoutingEndpoints.go +++ b/service/globalaccelerator/api_op_RemoveCustomRoutingEndpoints.go @@ -33,8 +33,8 @@ type RemoveCustomRoutingEndpointsInput struct { // This member is required. EndpointGroupArn *string - // The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the - // virtual private cloud (VPC) subnet IDs. + // The IDs for the endpoints. For custom routing accelerators, endpoint IDs are + // the virtual private cloud (VPC) subnet IDs. // // This member is required. EndpointIds []string diff --git a/service/globalaccelerator/api_op_RemoveEndpoints.go b/service/globalaccelerator/api_op_RemoveEndpoints.go index 6490a5244f2..0ec6eff4402 100644 --- a/service/globalaccelerator/api_op_RemoveEndpoints.go +++ b/service/globalaccelerator/api_op_RemoveEndpoints.go @@ -13,20 +13,16 @@ import ( // Remove endpoints from an endpoint group. The RemoveEndpoints API operation is // the recommended option for removing endpoints. The alternative is to remove -// endpoints by updating an endpoint group by using the UpdateEndpointGroup -// (https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html) +// endpoints by updating an endpoint group by using the UpdateEndpointGroup (https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html) // API operation. There are two advantages to using AddEndpoints to remove // endpoints instead: -// -// * It's more convenient, because you only need to specify the -// endpoints that you want to remove. With the UpdateEndpointGroup API operation, -// you must specify all of the endpoints in the endpoint group except the ones that -// you want to remove from the group. -// -// * It's faster, because Global Accelerator -// doesn't need to resolve any endpoints. With the UpdateEndpointGroup API -// operation, Global Accelerator must resolve all of the endpoints that remain in -// the group. +// - It's more convenient, because you only need to specify the endpoints that +// you want to remove. With the UpdateEndpointGroup API operation, you must +// specify all of the endpoints in the endpoint group except the ones that you want +// to remove from the group. +// - It's faster, because Global Accelerator doesn't need to resolve any +// endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must +// resolve all of the endpoints that remain in the group. func (c *Client) RemoveEndpoints(ctx context.Context, params *RemoveEndpointsInput, optFns ...func(*Options)) (*RemoveEndpointsOutput, error) { if params == nil { params = &RemoveEndpointsInput{} diff --git a/service/globalaccelerator/api_op_TagResource.go b/service/globalaccelerator/api_op_TagResource.go index 4a82eeca903..1d47eb4027c 100644 --- a/service/globalaccelerator/api_op_TagResource.go +++ b/service/globalaccelerator/api_op_TagResource.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add tags to an accelerator resource. For more information, see Tagging in Global -// Accelerator -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) +// Add tags to an accelerator resource. For more information, see Tagging in +// Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the Global Accelerator Developer Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/globalaccelerator/api_op_UntagResource.go b/service/globalaccelerator/api_op_UntagResource.go index a62712c1b56..0531522f131 100644 --- a/service/globalaccelerator/api_op_UntagResource.go +++ b/service/globalaccelerator/api_op_UntagResource.go @@ -13,8 +13,7 @@ import ( // Remove tags from a Global Accelerator resource. When you specify a tag key, the // action removes both that key and its associated value. The operation succeeds // even if you attempt to remove tags from an accelerator that was already removed. -// For more information, see Tagging in Global Accelerator -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) +// For more information, see Tagging in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the Global Accelerator Developer Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { @@ -33,8 +32,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags - // from. An ARN uniquely identifies a resource. + // The Amazon Resource Name (ARN) of the Global Accelerator resource to remove + // tags from. An ARN uniquely identifies a resource. // // This member is required. ResourceArn *string diff --git a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go index d11b005465a..0d70d5a372f 100644 --- a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go @@ -36,18 +36,17 @@ type UpdateAcceleratorAttributesInput struct { // Update whether flow logs are enabled. The default value is false. If the value // is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more - // information, see Flow Logs - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) + // information, see Flow Logs (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the Global Accelerator Developer Guide. FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // FlowLogsEnabled is true . The bucket must exist and have a bucket policy that // grants Global Accelerator permission to write to the bucket. FlowLogsS3Bucket *string // Update the prefix for the location in the Amazon S3 bucket for the flow logs. - // Attribute is required if FlowLogsEnabled is true. If you specify slash (/) for + // Attribute is required if FlowLogsEnabled is true . If you specify slash (/) for // the S3 bucket prefix, the log file bucket folder structure will include a double // slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id FlowLogsS3Prefix *string diff --git a/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go b/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go index 659383287b6..0c317c1c098 100644 --- a/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go @@ -37,21 +37,21 @@ type UpdateCustomRoutingAcceleratorAttributesInput struct { // Update whether flow logs are enabled. The default value is false. If the value // is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more - // information, see Flow logs - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) + // information, see Flow logs (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the Global Accelerator Developer Guide. FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // FlowLogsEnabled is true . The bucket must exist and have a bucket policy that // grants Global Accelerator permission to write to the bucket. FlowLogsS3Bucket *string // Update the prefix for the location in the Amazon S3 bucket for the flow logs. - // Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, - // the flow logs are stored in the root of the bucket. If you specify slash (/) for - // the S3 bucket prefix, the log file bucket folder structure will include a double - // slash (//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id + // Attribute is required if FlowLogsEnabled is true . If you don’t specify a + // prefix, the flow logs are stored in the root of the bucket. If you specify slash + // (/) for the S3 bucket prefix, the log file bucket folder structure will include + // a double slash (//), like the following: + // DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id FlowLogsS3Prefix *string noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go b/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go index 1b45cb6a159..cd95f66bac6 100644 --- a/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go +++ b/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go @@ -37,8 +37,8 @@ type UpdateCustomRoutingListenerInput struct { // The updated port range to support for connections from clients to your // accelerator. If you remove ports that are currently being used by a subnet // endpoint, the call fails. Separately, you set port ranges for endpoints. For - // more information, see About endpoints for custom routing accelerators - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html). + // more information, see About endpoints for custom routing accelerators (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) + // . // // This member is required. PortRanges []types.PortRange diff --git a/service/globalaccelerator/api_op_UpdateEndpointGroup.go b/service/globalaccelerator/api_op_UpdateEndpointGroup.go index 51c2fa8af35..71ab768ca28 100644 --- a/service/globalaccelerator/api_op_UpdateEndpointGroup.go +++ b/service/globalaccelerator/api_op_UpdateEndpointGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update an endpoint group. A resource must be valid and active when you add it as -// an endpoint. +// Update an endpoint group. A resource must be valid and active when you add it +// as an endpoint. func (c *Client) UpdateEndpointGroup(ctx context.Context, params *UpdateEndpointGroupInput, optFns ...func(*Options)) (*UpdateEndpointGroupOutput, error) { if params == nil { params = &UpdateEndpointGroupInput{} @@ -39,8 +39,8 @@ type UpdateEndpointGroupInput struct { // it as an endpoint. EndpointConfigurations []types.EndpointConfiguration - // The time—10 seconds or 30 seconds—between each health check for an endpoint. The - // default value is 30. + // The time—10 seconds or 30 seconds—between each health check for an endpoint. + // The default value is 30. HealthCheckIntervalSeconds *int32 // If the protocol is HTTP/S, then this specifies the path that is the destination @@ -61,8 +61,7 @@ type UpdateEndpointGroupInput struct { // part of this endpoint group. For example, you can create a port override in // which the listener receives user traffic on ports 80 and 443, but your // accelerator routes that traffic to ports 1080 and 1443, respectively, on the - // endpoints. For more information, see Overriding listener ports - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) + // endpoints. For more information, see Overriding listener ports (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) // in the Global Accelerator Developer Guide. PortOverrides []types.PortOverride diff --git a/service/globalaccelerator/api_op_UpdateListener.go b/service/globalaccelerator/api_op_UpdateListener.go index cd2b49e7b28..dec621c5605 100644 --- a/service/globalaccelerator/api_op_UpdateListener.go +++ b/service/globalaccelerator/api_op_UpdateListener.go @@ -39,16 +39,16 @@ type UpdateListenerInput struct { // client request. Client affinity gives you control over whether to always route // each client to the same specific endpoint. Global Accelerator uses a // consistent-flow hashing algorithm to choose the optimal endpoint for a - // connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" - // (5-tuple) properties—source IP address, source port, destination IP address, - // destination port, and protocol—to select the hash value, and then chooses the - // best endpoint. However, with this setting, if someone uses different ports to - // connect to Global Accelerator, their connections might not be always routed to - // the same endpoint because the hash value changes. If you want a given client to - // always be routed to the same endpoint, set client affinity to SOURCE_IP instead. - // When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" - // (2-tuple) properties— source (client) IP address and destination IP address—to - // select the hash value. The default value is NONE. + // connection. If client affinity is NONE , Global Accelerator uses the + // "five-tuple" (5-tuple) properties—source IP address, source port, destination IP + // address, destination port, and protocol—to select the hash value, and then + // chooses the best endpoint. However, with this setting, if someone uses different + // ports to connect to Global Accelerator, their connections might not be always + // routed to the same endpoint because the hash value changes. If you want a given + // client to always be routed to the same endpoint, set client affinity to + // SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses + // the "two-tuple" (2-tuple) properties— source (client) IP address and destination + // IP address—to select the hash value. The default value is NONE . ClientAffinity types.ClientAffinity // The updated list of port ranges for the connections from clients to the diff --git a/service/globalaccelerator/api_op_WithdrawByoipCidr.go b/service/globalaccelerator/api_op_WithdrawByoipCidr.go index 0fee16671c2..4ca8da14954 100644 --- a/service/globalaccelerator/api_op_WithdrawByoipCidr.go +++ b/service/globalaccelerator/api_op_WithdrawByoipCidr.go @@ -16,9 +16,8 @@ import ( // different address ranges each time. It can take a few minutes before traffic to // the specified addresses stops routing to Amazon Web Services because of // propagation delays. For more information, see Bring your own IP addresses -// (BYOIP) -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in -// the Global Accelerator Developer Guide. +// (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) +// in the Global Accelerator Developer Guide. func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCidrInput, optFns ...func(*Options)) (*WithdrawByoipCidrOutput, error) { if params == nil { params = &WithdrawByoipCidrInput{} diff --git a/service/globalaccelerator/doc.go b/service/globalaccelerator/doc.go index 713a352463f..c67cfda4718 100644 --- a/service/globalaccelerator/doc.go +++ b/service/globalaccelerator/doc.go @@ -6,57 +6,50 @@ // Global Accelerator This is the Global Accelerator API Reference. This guide is // for developers who need detailed information about Global Accelerator API // actions, data types, and errors. For more information about Global Accelerator -// features, see the Global Accelerator Developer Guide -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html). -// Global Accelerator is a service in which you create accelerators to improve the -// performance of your applications for local and global users. Depending on the -// type of accelerator you choose, you can gain additional benefits. +// features, see the Global Accelerator Developer Guide (https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html) +// . Global Accelerator is a service in which you create accelerators to improve +// the performance of your applications for local and global users. Depending on +// the type of accelerator you choose, you can gain additional benefits. +// - By using a standard accelerator, you can improve availability of your +// internet applications that are used by a global audience. With a standard +// accelerator, Global Accelerator directs traffic to optimal endpoints over the +// Amazon Web Services global network. +// - For other scenarios, you might choose a custom routing accelerator. With a +// custom routing accelerator, you can use application logic to directly map one or +// more users to a specific endpoint among many endpoints. // -// * By using a -// standard accelerator, you can improve availability of your internet applications -// that are used by a global audience. With a standard accelerator, Global -// Accelerator directs traffic to optimal endpoints over the Amazon Web Services -// global network. -// -// * For other scenarios, you might choose a custom routing -// accelerator. With a custom routing accelerator, you can use application logic to -// directly map one or more users to a specific endpoint among many -// endpoints. -// -// Global Accelerator is a global service that supports endpoints in -// multiple Amazon Web Services Regions but you must specify the US West (Oregon) -// Region to create, update, or otherwise work with accelerators. That is, for -// example, specify --region us-west-2 on AWS CLI commands. By default, Global -// Accelerator provides you with static IP addresses that you associate with your -// accelerator. The static IP addresses are anycast from the Amazon Web Services -// edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. -// For dual-stack, Global Accelerator provides a total of four addresses: two -// static IPv4 addresses and two static IPv6 addresses. With a standard accelerator -// for IPv4, instead of using the addresses that Global Accelerator provides, you -// can configure these entry points to be IPv4 addresses from your own IP address -// ranges that you bring toGlobal Accelerator (BYOIP). For a standard accelerator, -// they distribute incoming application traffic across multiple endpoint resources -// in multiple Amazon Web Services Regions , which increases the availability of -// your applications. Endpoints for standard accelerators can be Network Load -// Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP -// addresses that are located in one Amazon Web Services Region or multiple Amazon -// Web Services Regions. For custom routing accelerators, you map traffic that -// arrives to the static IP addresses to specific Amazon EC2 servers in endpoints -// that are virtual private cloud (VPC) subnets. The static IP addresses remain -// assigned to your accelerator for as long as it exists, even if you disable the -// accelerator and it no longer accepts or routes traffic. However, when you delete -// an accelerator, you lose the static IP addresses that are assigned to it, so you -// can no longer route traffic by using them. You can use IAM policies like -// tag-based permissions with Global Accelerator to limit the users who have -// permissions to delete an accelerator. For more information, see Tag-based -// policies -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html). -// For standard accelerators, Global Accelerator uses the Amazon Web Services +// Global Accelerator is a global service that supports endpoints in multiple +// Amazon Web Services Regions but you must specify the US West (Oregon) Region to +// create, update, or otherwise work with accelerators. That is, for example, +// specify --region us-west-2 on AWS CLI commands. By default, Global Accelerator +// provides you with static IP addresses that you associate with your accelerator. +// The static IP addresses are anycast from the Amazon Web Services edge network. +// For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, +// Global Accelerator provides a total of four addresses: two static IPv4 addresses +// and two static IPv6 addresses. With a standard accelerator for IPv4, instead of +// using the addresses that Global Accelerator provides, you can configure these +// entry points to be IPv4 addresses from your own IP address ranges that you bring +// toGlobal Accelerator (BYOIP). For a standard accelerator, they distribute +// incoming application traffic across multiple endpoint resources in multiple +// Amazon Web Services Regions , which increases the availability of your +// applications. Endpoints for standard accelerators can be Network Load Balancers, +// Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that +// are located in one Amazon Web Services Region or multiple Amazon Web Services +// Regions. For custom routing accelerators, you map traffic that arrives to the +// static IP addresses to specific Amazon EC2 servers in endpoints that are virtual +// private cloud (VPC) subnets. The static IP addresses remain assigned to your +// accelerator for as long as it exists, even if you disable the accelerator and it +// no longer accepts or routes traffic. However, when you delete an accelerator, +// you lose the static IP addresses that are assigned to it, so you can no longer +// route traffic by using them. You can use IAM policies like tag-based permissions +// with Global Accelerator to limit the users who have permissions to delete an +// accelerator. For more information, see Tag-based policies (https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html) +// . For standard accelerators, Global Accelerator uses the Amazon Web Services // global network to route traffic to the optimal regional endpoint based on // health, client location, and policies that you configure. The service reacts // instantly to changes in health or configuration to ensure that internet traffic // from clients is always directed to healthy endpoints. For more information about -// understanding and using Global Accelerator, see the Global Accelerator Developer -// Guide -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html). +// understanding and using Global Accelerator, see the Global Accelerator +// Developer Guide (https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html) +// . package globalaccelerator diff --git a/service/globalaccelerator/types/enums.go b/service/globalaccelerator/types/enums.go index 00849b3e591..c064716d986 100644 --- a/service/globalaccelerator/types/enums.go +++ b/service/globalaccelerator/types/enums.go @@ -120,8 +120,8 @@ const ( CustomRoutingProtocolUdp CustomRoutingProtocol = "UDP" ) -// Values returns all known values for CustomRoutingProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CustomRoutingProtocol. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CustomRoutingProtocol) Values() []CustomRoutingProtocol { return []CustomRoutingProtocol{ diff --git a/service/globalaccelerator/types/errors.go b/service/globalaccelerator/types/errors.go index 5a88aa37a8e..ce58dc1d2c5 100644 --- a/service/globalaccelerator/types/errors.go +++ b/service/globalaccelerator/types/errors.go @@ -299,8 +299,8 @@ func (e *EndpointNotFoundException) ErrorCode() string { } func (e *EndpointNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The CIDR that you specified is not valid for this action. For example, the state -// of the CIDR might be incorrect for this action. +// The CIDR that you specified is not valid for this action. For example, the +// state of the CIDR might be incorrect for this action. type IncorrectCidrStateException struct { Message *string diff --git a/service/globalaccelerator/types/types.go b/service/globalaccelerator/types/types.go index 0e49fb404bd..66c7856c721 100644 --- a/service/globalaccelerator/types/types.go +++ b/service/globalaccelerator/types/types.go @@ -18,30 +18,27 @@ type Accelerator struct { // The date and time that the accelerator was created. CreatedTime *time.Time - // The Domain Name System (DNS) name that Global Accelerator creates that points to - // an accelerator's static IPv4 addresses. The naming convention for the DNS name - // for an accelerator is the following: A lowercase letter a, followed by a 16-bit - // random hex string, followed by .awsglobalaccelerator.com. For example: + // The Domain Name System (DNS) name that Global Accelerator creates that points + // to an accelerator's static IPv4 addresses. The naming convention for the DNS + // name for an accelerator is the following: A lowercase letter a, followed by a + // 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: // a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack - // accelerator, you also have a second DNS name, DualStackDnsName, that points to + // accelerator, you also have a second DNS name, DualStackDnsName , that points to // both the A record and the AAAA record for all four static addresses for the // accelerator: two IPv4 addresses and two IPv6 addresses. For more information - // about the default DNS name, see Support for DNS addressing in Global - // Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html) + // about the default DNS name, see Support for DNS addressing in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html) // in the Global Accelerator Developer Guide. DnsName *string - // The Domain Name System (DNS) name that Global Accelerator creates that points to - // a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two - // IPv6 addresses. The naming convention for the dual-stack DNS name is the + // The Domain Name System (DNS) name that Global Accelerator creates that points + // to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and + // two IPv6 addresses. The naming convention for the dual-stack DNS name is the // following: A lowercase letter a, followed by a 16-bit random hex string, // followed by .dualstack.awsglobalaccelerator.com. For example: // a1234567890abcdef.dualstack.awsglobalaccelerator.com. Note: Global Accelerator - // also assigns a default DNS name, DnsName, to your accelerator that points just - // to the static IPv4 addresses. For more information, see Support for DNS - // addressing in Global Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing) + // also assigns a default DNS name, DnsName , to your accelerator that points just + // to the static IPv4 addresses. For more information, see Support for DNS + // addressing in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing) // in the Global Accelerator Developer Guide. DualStackDnsName *string @@ -77,21 +74,20 @@ type Accelerator struct { type AcceleratorAttributes struct { // Indicates whether flow logs are enabled. The default value is false. If the - // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more - // information, see Flow logs - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) + // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For + // more information, see Flow logs (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the Global Accelerator Developer Guide. FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // FlowLogsEnabled is true . The bucket must exist and have a bucket policy that // grants Global Accelerator permission to write to the bucket. FlowLogsS3Bucket *string - // The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute - // is required if FlowLogsEnabled is true. If you specify slash (/) for the S3 - // bucket prefix, the log file bucket folder structure will include a double slash - // (//), like the following: s3-bucket_name//AWSLogs/aws_account_id + // The prefix for the location in the Amazon S3 bucket for the flow logs. + // Attribute is required if FlowLogsEnabled is true . If you specify slash (/) for + // the S3 bucket prefix, the log file bucket folder structure will include a double + // slash (//), like the following: s3-bucket_name//AWSLogs/aws_account_id FlowLogsS3Prefix *string noSmithyDocumentSerde @@ -119,53 +115,35 @@ type AcceleratorEvent struct { // Information about an IP address range that is provisioned for use with your // Amazon Web Services resources through bring your own IP address (BYOIP). The // following describes each BYOIP State that your IP address range can be in. -// -// * -// PENDING_PROVISIONING — You’ve submitted a request to provision an IP address -// range but it is not yet provisioned with Global Accelerator. -// -// * READY — The -// address range is provisioned with Global Accelerator and can be advertised. -// -// * -// PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to -// advertise an address range but it is not yet being advertised. -// -// * ADVERTISING — -// The address range is being advertised by Global Accelerator. -// -// * -// PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range -// from being advertised but it is still being advertised by Global Accelerator. -// -// * -// PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address -// range from Global Accelerator but it is still provisioned. -// -// * DEPROVISIONED — -// The address range is deprovisioned from Global Accelerator. -// -// * FAILED_PROVISION -// — The request to provision the address range from Global Accelerator was not -// successful. Please make sure that you provide all of the correct information, -// and try again. If the request fails a second time, contact Amazon Web Services -// support. -// -// * FAILED_ADVERTISING — The request for Global Accelerator to advertise -// the address range was not successful. Please make sure that you provide all of -// the correct information, and try again. If the request fails a second time, -// contact Amazon Web Services support. -// -// * FAILED_WITHDRAW — The request to -// withdraw the address range from advertising by Global Accelerator was not -// successful. Please make sure that you provide all of the correct information, -// and try again. If the request fails a second time, contact Amazon Web Services -// support. -// -// * FAILED_DEPROVISION — The request to deprovision the address range -// from Global Accelerator was not successful. Please make sure that you provide -// all of the correct information, and try again. If the request fails a second -// time, contact Amazon Web Services support. +// - PENDING_PROVISIONING — You’ve submitted a request to provision an IP +// address range but it is not yet provisioned with Global Accelerator. +// - READY — The address range is provisioned with Global Accelerator and can be +// advertised. +// - PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to +// advertise an address range but it is not yet being advertised. +// - ADVERTISING — The address range is being advertised by Global Accelerator. +// - PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address +// range from being advertised but it is still being advertised by Global +// Accelerator. +// - PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an +// address range from Global Accelerator but it is still provisioned. +// - DEPROVISIONED — The address range is deprovisioned from Global Accelerator. +// - FAILED_PROVISION — The request to provision the address range from Global +// Accelerator was not successful. Please make sure that you provide all of the +// correct information, and try again. If the request fails a second time, contact +// Amazon Web Services support. +// - FAILED_ADVERTISING — The request for Global Accelerator to advertise the +// address range was not successful. Please make sure that you provide all of the +// correct information, and try again. If the request fails a second time, contact +// Amazon Web Services support. +// - FAILED_WITHDRAW — The request to withdraw the address range from +// advertising by Global Accelerator was not successful. Please make sure that you +// provide all of the correct information, and try again. If the request fails a +// second time, contact Amazon Web Services support. +// - FAILED_DEPROVISION — The request to deprovision the address range from +// Global Accelerator was not successful. Please make sure that you provide all of +// the correct information, and try again. If the request fails a second time, +// contact Amazon Web Services support. type ByoipCidr struct { // The address range, in CIDR notation. @@ -200,9 +178,8 @@ type ByoipCidrEvent struct { // Provides authorization for Amazon to bring a specific IP address range to a // specific Amazon Web Services account using bring your own IP addresses (BYOIP). -// For more information, see Bring your own IP addresses (BYOIP) -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in -// the Global Accelerator Developer Guide. +// For more information, see Bring your own IP addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) +// in the Global Accelerator Developer Guide. type CidrAuthorizationContext struct { // The plain-text authorization message for the prefix and account. @@ -227,17 +204,15 @@ type CustomRoutingAccelerator struct { // The date and time that the accelerator was created. CreatedTime *time.Time - // The Domain Name System (DNS) name that Global Accelerator creates that points to - // an accelerator's static IPv4 addresses. The naming convention for the DNS name - // is the following: A lowercase letter a, followed by a 16-bit random hex string, - // followed by .awsglobalaccelerator.com. For example: + // The Domain Name System (DNS) name that Global Accelerator creates that points + // to an accelerator's static IPv4 addresses. The naming convention for the DNS + // name is the following: A lowercase letter a, followed by a 16-bit random hex + // string, followed by .awsglobalaccelerator.com. For example: // a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack - // accelerator, you also have a second DNS name, DualStackDnsName, that points to + // accelerator, you also have a second DNS name, DualStackDnsName , that points to // both the A record and the AAAA record for all four static addresses for the // accelerator: two IPv4 addresses and two IPv6 addresses. For more information - // about the default DNS name, see Support for DNS addressing in Global - // Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html) + // about the default DNS name, see Support for DNS addressing in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html) // in the Global Accelerator Developer Guide. DnsName *string @@ -270,22 +245,22 @@ type CustomRoutingAccelerator struct { type CustomRoutingAcceleratorAttributes struct { // Indicates whether flow logs are enabled. The default value is false. If the - // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more - // information, see Flow logs - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) + // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For + // more information, see Flow logs (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html) // in the Global Accelerator Developer Guide. FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if - // FlowLogsEnabled is true. The bucket must exist and have a bucket policy that + // FlowLogsEnabled is true . The bucket must exist and have a bucket policy that // grants Global Accelerator permission to write to the bucket. FlowLogsS3Bucket *string - // The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute - // is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow - // logs are stored in the root of the bucket. If you specify slash (/) for the S3 - // bucket prefix, the log file bucket folder structure will include a double slash - // (//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id + // The prefix for the location in the Amazon S3 bucket for the flow logs. + // Attribute is required if FlowLogsEnabled is true . If you don’t specify a + // prefix, the flow logs are stored in the root of the bucket. If you specify slash + // (/) for the S3 bucket prefix, the log file bucket folder structure will include + // a double slash (//), like the following: + // DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id FlowLogsS3Prefix *string noSmithyDocumentSerde @@ -370,8 +345,8 @@ type CustomRoutingEndpointGroup struct { // traffic on. DestinationDescriptions []CustomRoutingDestinationDescription - // For a custom routing accelerator, describes the endpoints (virtual private cloud - // subnets) in an endpoint group to accept client traffic on. + // For a custom routing accelerator, describes the endpoints (virtual private + // cloud subnets) in an endpoint group to accept client traffic on. EndpointDescriptions []CustomRoutingEndpointDescription // The Amazon Resource Name (ARN) of the endpoint group. @@ -391,8 +366,8 @@ type CustomRoutingListener struct { // The port range to support for connections from clients to your accelerator. // Separately, you set port ranges for endpoints. For more information, see About - // endpoints for custom routing accelerators - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html). + // endpoints for custom routing accelerators (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html) + // . PortRanges []PortRange noSmithyDocumentSerde @@ -409,8 +384,8 @@ type DestinationPortMapping struct { // socket address. AcceleratorSocketAddresses []SocketAddress - // The endpoint IP address/port combination for traffic received on the accelerator - // socket address. + // The endpoint IP address/port combination for traffic received on the + // accelerator socket address. DestinationSocketAddress *SocketAddress // Indicates whether or not a port mapping destination can receive traffic. The @@ -438,15 +413,14 @@ type DestinationPortMapping struct { // it as an endpoint. type EndpointConfiguration struct { - // Indicates whether client IP address preservation is enabled for an endpoint. The - // value is true or false. The default value is true for new accelerators. If the - // value is set to true, the client's IP address is preserved in the + // Indicates whether client IP address preservation is enabled for an endpoint. + // The value is true or false. The default value is true for new accelerators. If + // the value is set to true, the client's IP address is preserved in the // X-Forwarded-For request header as traffic travels to applications on the // endpoint fronted by the accelerator. Client IP address preservation is // supported, in specific Amazon Web Services Regions, for endpoints that are // Application Load Balancers and Amazon EC2 instances. For more information, see - // Preserve client IP addresses in Global Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) + // Preserve client IP addresses in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) // in the Global Accelerator Developer Guide. ClientIPPreservationEnabled *bool @@ -463,8 +437,7 @@ type EndpointConfiguration struct { // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 - // is routed to the last endpoint. For more information, see Endpoint weights - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) + // is routed to the last endpoint. For more information, see Endpoint weights (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) // in the Global Accelerator Developer Guide. Weight *int32 @@ -475,15 +448,14 @@ type EndpointConfiguration struct { // endpoints, such as load balancers. type EndpointDescription struct { - // Indicates whether client IP address preservation is enabled for an endpoint. The - // value is true or false. The default value is true for new accelerators. If the - // value is set to true, the client's IP address is preserved in the + // Indicates whether client IP address preservation is enabled for an endpoint. + // The value is true or false. The default value is true for new accelerators. If + // the value is set to true, the client's IP address is preserved in the // X-Forwarded-For request header as traffic travels to applications on the // endpoint fronted by the accelerator. Client IP address preservation is // supported, in specific Amazon Web Services Regions, for endpoints that are // Application Load Balancers and Amazon EC2 instances. For more information, see - // Preserve client IP addresses in Global Accelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) + // Preserve client IP addresses in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html) // in the Global Accelerator Developer Guide. ClientIPPreservationEnabled *bool @@ -505,8 +477,7 @@ type EndpointDescription struct { // specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 // (sum=20). The result is that 4/20 of your traffic, on average, is routed to the // first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 - // is routed to the last endpoint. For more information, see Endpoint weights - // (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) + // is routed to the last endpoint. For more information, see Endpoint weights (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html) // in the Global Accelerator Developer Guide. Weight *int32 @@ -535,10 +506,10 @@ type EndpointGroup struct { // default is slash (/). HealthCheckPath *string - // The port that Global Accelerator uses to perform health checks on endpoints that - // are part of this endpoint group. The default port is the port for the listener - // that this endpoint group is associated with. If the listener port is a list, - // Global Accelerator uses the first specified port in the list of ports. + // The port that Global Accelerator uses to perform health checks on endpoints + // that are part of this endpoint group. The default port is the port for the + // listener that this endpoint group is associated with. If the listener port is a + // list, Global Accelerator uses the first specified port in the list of ports. HealthCheckPort *int32 // The protocol that Global Accelerator uses to perform health checks on endpoints @@ -579,9 +550,9 @@ type EndpointIdentifier struct { // This member is required. EndpointId *string - // Indicates whether client IP address preservation is enabled for an endpoint. The - // value is true or false. If the value is set to true, the client's IP address is - // preserved in the X-Forwarded-For request header as traffic travels to + // Indicates whether client IP address preservation is enabled for an endpoint. + // The value is true or false. If the value is set to true, the client's IP address + // is preserved in the X-Forwarded-For request header as traffic travels to // applications on the endpoint fronted by the accelerator. ClientIPPreservationEnabled *bool @@ -614,16 +585,16 @@ type Listener struct { // client request. Client affinity gives you control over whether to always route // each client to the same specific endpoint. Global Accelerator uses a // consistent-flow hashing algorithm to choose the optimal endpoint for a - // connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" - // (5-tuple) properties—source IP address, source port, destination IP address, - // destination port, and protocol—to select the hash value, and then chooses the - // best endpoint. However, with this setting, if someone uses different ports to - // connect to Global Accelerator, their connections might not be always routed to - // the same endpoint because the hash value changes. If you want a given client to - // always be routed to the same endpoint, set client affinity to SOURCE_IP instead. - // When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" - // (2-tuple) properties— source (client) IP address and destination IP address—to - // select the hash value. The default value is NONE. + // connection. If client affinity is NONE , Global Accelerator uses the + // "five-tuple" (5-tuple) properties—source IP address, source port, destination IP + // address, destination port, and protocol—to select the hash value, and then + // chooses the best endpoint. However, with this setting, if someone uses different + // ports to connect to Global Accelerator, their connections might not be always + // routed to the same endpoint because the hash value changes. If you want a given + // client to always be routed to the same endpoint, set client affinity to + // SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses + // the "two-tuple" (2-tuple) properties— source (client) IP address and destination + // IP address—to select the hash value. The default value is NONE . ClientAffinity ClientAffinity // The Amazon Resource Name (ARN) of the listener. @@ -673,8 +644,7 @@ type PortMapping struct { // part of an endpoint group. For example, you can create a port override in which // the listener receives user traffic on ports 80 and 443, but your accelerator // routes that traffic to ports 1080 and 1443, respectively, on the endpoints. For -// more information, see Overriding listener ports -// (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) +// more information, see Overriding listener ports (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html) // in the Global Accelerator Developer Guide. type PortOverride struct { diff --git a/service/glue/api_client.go b/service/glue/api_client.go index a8d7509ff1e..a3c7d2ade54 100644 --- a/service/glue/api_client.go +++ b/service/glue/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/glue/api_op_BatchDeleteConnection.go b/service/glue/api_op_BatchDeleteConnection.go index 60ce4ecbc4e..d78a937c480 100644 --- a/service/glue/api_op_BatchDeleteConnection.go +++ b/service/glue/api_op_BatchDeleteConnection.go @@ -34,8 +34,8 @@ type BatchDeleteConnectionInput struct { // This member is required. ConnectionNameList []string - // The ID of the Data Catalog in which the connections reside. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which the connections reside. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_BatchDeletePartition.go b/service/glue/api_op_BatchDeletePartition.go index c93d878bf9a..8b5ac0dfa98 100644 --- a/service/glue/api_op_BatchDeletePartition.go +++ b/service/glue/api_op_BatchDeletePartition.go @@ -44,8 +44,8 @@ type BatchDeletePartitionInput struct { // This member is required. TableName *string - // The ID of the Data Catalog where the partition to be deleted resides. If none is - // provided, the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog where the partition to be deleted resides. If none + // is provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_BatchDeleteTable.go b/service/glue/api_op_BatchDeleteTable.go index 4292c22579c..a11d2af7cfd 100644 --- a/service/glue/api_op_BatchDeleteTable.go +++ b/service/glue/api_op_BatchDeleteTable.go @@ -15,8 +15,8 @@ import ( // have access to the table versions and partitions that belong to the deleted // table. Glue deletes these "orphaned" resources asynchronously in a timely // manner, at the discretion of the service. To ensure the immediate deletion of -// all related resources, before calling BatchDeleteTable, use DeleteTableVersion -// or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to +// all related resources, before calling BatchDeleteTable , use DeleteTableVersion +// or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to // delete any resources that belong to the table. func (c *Client) BatchDeleteTable(ctx context.Context, params *BatchDeleteTableInput, optFns ...func(*Options)) (*BatchDeleteTableOutput, error) { if params == nil { diff --git a/service/glue/api_op_BatchGetDevEndpoints.go b/service/glue/api_op_BatchGetDevEndpoints.go index 4da9d0e63e1..db6c4f70c5e 100644 --- a/service/glue/api_op_BatchGetDevEndpoints.go +++ b/service/glue/api_op_BatchGetDevEndpoints.go @@ -12,9 +12,10 @@ import ( ) // Returns a list of resource metadata for a given list of development endpoint -// names. After calling the ListDevEndpoints operation, you can call this operation -// to access the data to which you have been granted permissions. This operation -// supports all IAM permissions, including permission conditions that uses tags. +// names. After calling the ListDevEndpoints operation, you can call this +// operation to access the data to which you have been granted permissions. This +// operation supports all IAM permissions, including permission conditions that +// uses tags. func (c *Client) BatchGetDevEndpoints(ctx context.Context, params *BatchGetDevEndpointsInput, optFns ...func(*Options)) (*BatchGetDevEndpointsOutput, error) { if params == nil { params = &BatchGetDevEndpointsInput{} diff --git a/service/glue/api_op_BatchGetJobs.go b/service/glue/api_op_BatchGetJobs.go index dffa5ddc4df..2edc1a1eae9 100644 --- a/service/glue/api_op_BatchGetJobs.go +++ b/service/glue/api_op_BatchGetJobs.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of resource metadata for a given list of job names. After calling -// the ListJobs operation, you can call this operation to access the data to which -// you have been granted permissions. This operation supports all IAM permissions, -// including permission conditions that uses tags. +// Returns a list of resource metadata for a given list of job names. After +// calling the ListJobs operation, you can call this operation to access the data +// to which you have been granted permissions. This operation supports all IAM +// permissions, including permission conditions that uses tags. func (c *Client) BatchGetJobs(ctx context.Context, params *BatchGetJobsInput, optFns ...func(*Options)) (*BatchGetJobsOutput, error) { if params == nil { params = &BatchGetJobsInput{} diff --git a/service/glue/api_op_BatchStopJobRun.go b/service/glue/api_op_BatchStopJobRun.go index 58542374418..d554a47ba36 100644 --- a/service/glue/api_op_BatchStopJobRun.go +++ b/service/glue/api_op_BatchStopJobRun.go @@ -44,7 +44,7 @@ type BatchStopJobRunInput struct { type BatchStopJobRunOutput struct { - // A list of the errors that were encountered in trying to stop JobRuns, including + // A list of the errors that were encountered in trying to stop JobRuns , including // the JobRunId for which each error was encountered and details about the error. Errors []types.BatchStopJobRunError diff --git a/service/glue/api_op_BatchUpdatePartition.go b/service/glue/api_op_BatchUpdatePartition.go index 018b6e970b2..fa1fee5c031 100644 --- a/service/glue/api_op_BatchUpdatePartition.go +++ b/service/glue/api_op_BatchUpdatePartition.go @@ -53,8 +53,8 @@ type BatchUpdatePartitionInput struct { type BatchUpdatePartitionOutput struct { - // The errors encountered when trying to update the requested partitions. A list of - // BatchUpdatePartitionFailureEntry objects. + // The errors encountered when trying to update the requested partitions. A list + // of BatchUpdatePartitionFailureEntry objects. Errors []types.BatchUpdatePartitionFailureEntry // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_CancelMLTaskRun.go b/service/glue/api_op_CancelMLTaskRun.go index 8e6700c284d..be3d8c2da40 100644 --- a/service/glue/api_op_CancelMLTaskRun.go +++ b/service/glue/api_op_CancelMLTaskRun.go @@ -14,7 +14,7 @@ import ( // Cancels (stops) a task run. Machine learning task runs are asynchronous tasks // that Glue runs on your behalf as part of various machine learning workflows. You // can cancel a machine learning task run at any time by calling CancelMLTaskRun -// with a task run's parent transform's TransformID and the task run's TaskRunId. +// with a task run's parent transform's TransformID and the task run's TaskRunId . func (c *Client) CancelMLTaskRun(ctx context.Context, params *CancelMLTaskRunInput, optFns ...func(*Options)) (*CancelMLTaskRunOutput, error) { if params == nil { params = &CancelMLTaskRunInput{} diff --git a/service/glue/api_op_CheckSchemaVersionValidity.go b/service/glue/api_op_CheckSchemaVersionValidity.go index 18c3b457f06..36857bcf8d9 100644 --- a/service/glue/api_op_CheckSchemaVersionValidity.go +++ b/service/glue/api_op_CheckSchemaVersionValidity.go @@ -31,8 +31,8 @@ func (c *Client) CheckSchemaVersionValidity(ctx context.Context, params *CheckSc type CheckSchemaVersionValidityInput struct { - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. // // This member is required. DataFormat types.DataFormat diff --git a/service/glue/api_op_CreateClassifier.go b/service/glue/api_op_CreateClassifier.go index 4c8a1213678..e7082865506 100644 --- a/service/glue/api_op_CreateClassifier.go +++ b/service/glue/api_op_CreateClassifier.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a classifier in the user's account. This can be a GrokClassifier, an -// XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of -// the request is present. +// Creates a classifier in the user's account. This can be a GrokClassifier , an +// XMLClassifier , a JsonClassifier , or a CsvClassifier , depending on which field +// of the request is present. func (c *Client) CreateClassifier(ctx context.Context, params *CreateClassifierInput, optFns ...func(*Options)) (*CreateClassifierOutput, error) { if params == nil { params = &CreateClassifierInput{} diff --git a/service/glue/api_op_CreateCrawler.go b/service/glue/api_op_CreateCrawler.go index 897468ea2b0..f0c0c146708 100644 --- a/service/glue/api_op_CreateCrawler.go +++ b/service/glue/api_op_CreateCrawler.go @@ -54,15 +54,15 @@ type CreateCrawlerInput struct { // Crawler configuration information. This versioned JSON string allows users to // specify aspects of a crawler's behavior. For more information, see Setting - // crawler configuration options - // (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // crawler configuration options (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html) + // . Configuration *string // The name of the SecurityConfiguration structure to be used by this crawler. CrawlerSecurityConfiguration *string // The Glue database where results are written, such as: - // arn:aws:daylight:us-east-1::database/sometable/*. + // arn:aws:daylight:us-east-1::database/sometable/* . DatabaseName *string // A description of the new crawler. @@ -79,10 +79,9 @@ type CreateCrawlerInput struct { RecrawlPolicy *types.RecrawlPolicy // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . Schedule *string // The policy for the crawler's update and deletion behavior. diff --git a/service/glue/api_op_CreateDataQualityRuleset.go b/service/glue/api_op_CreateDataQualityRuleset.go index d63e6bf63a2..4735551f1dc 100644 --- a/service/glue/api_op_CreateDataQualityRuleset.go +++ b/service/glue/api_op_CreateDataQualityRuleset.go @@ -36,8 +36,8 @@ type CreateDataQualityRulesetInput struct { // This member is required. Name *string - // A Data Quality Definition Language (DQDL) ruleset. For more information, see the - // Glue developer guide. + // A Data Quality Definition Language (DQDL) ruleset. For more information, see + // the Glue developer guide. // // This member is required. Ruleset *string diff --git a/service/glue/api_op_CreateDatabase.go b/service/glue/api_op_CreateDatabase.go index 9a00a86e234..00dbc81c7e0 100644 --- a/service/glue/api_op_CreateDatabase.go +++ b/service/glue/api_op_CreateDatabase.go @@ -34,8 +34,8 @@ type CreateDatabaseInput struct { // This member is required. DatabaseInput *types.DatabaseInput - // The ID of the Data Catalog in which to create the database. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which to create the database. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string // The tags you assign to the database. diff --git a/service/glue/api_op_CreateDevEndpoint.go b/service/glue/api_op_CreateDevEndpoint.go index d0b22f7d0f1..aec71c06ed0 100644 --- a/service/glue/api_op_CreateDevEndpoint.go +++ b/service/glue/api_op_CreateDevEndpoint.go @@ -30,69 +30,68 @@ func (c *Client) CreateDevEndpoint(ctx context.Context, params *CreateDevEndpoin type CreateDevEndpointInput struct { - // The name to be assigned to the new DevEndpoint. + // The name to be assigned to the new DevEndpoint . // // This member is required. EndpointName *string - // The IAM role for the DevEndpoint. + // The IAM role for the DevEndpoint . // // This member is required. RoleArn *string - // A map of arguments used to configure the DevEndpoint. + // A map of arguments used to configure the DevEndpoint . Arguments map[string]string - // The path to one or more Java .jar files in an S3 bucket that should be loaded in - // your DevEndpoint. + // The path to one or more Java .jar files in an S3 bucket that should be loaded + // in your DevEndpoint . ExtraJarsS3Path *string // The paths to one or more Python libraries in an Amazon S3 bucket that should be - // loaded in your DevEndpoint. Multiple values must be complete paths separated by - // a comma. You can only use pure Python libraries with a DevEndpoint. Libraries - // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) Python - // data analysis library, are not yet supported. + // loaded in your DevEndpoint . Multiple values must be complete paths separated by + // a comma. You can only use pure Python libraries with a DevEndpoint . Libraries + // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) + // Python data analysis library, are not yet supported. ExtraPythonLibsS3Path *string // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for running your // ETL scripts on development endpoints. For more information about the available - // Glue versions and corresponding Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. Development endpoints that are created without specifying a Glue version - // default to Glue 0.9. You can specify a version of Python support for development - // endpoints by using the Arguments parameter in the CreateDevEndpoint or - // UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to - // Python 2. + // Glue versions and corresponding Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. Development endpoints that are created without + // specifying a Glue version default to Glue 0.9. You can specify a version of + // Python support for development endpoints by using the Arguments parameter in + // the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, + // the version defaults to Python 2. GlueVersion *string - // The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint. + // The number of Glue Data Processing Units (DPUs) to allocate to this DevEndpoint . NumberOfNodes int32 // The number of workers of a defined workerType that are allocated to the // development endpoint. The maximum number of workers you can define are 299 for - // G.1X, and 149 for G.2X. + // G.1X , and 149 for G.2X . NumberOfWorkers *int32 - // The public key to be used by this DevEndpoint for authentication. This attribute - // is provided for backward compatibility because the recommended attribute to use - // is public keys. + // The public key to be used by this DevEndpoint for authentication. This + // attribute is provided for backward compatibility because the recommended + // attribute to use is public keys. PublicKey *string // A list of public keys to be used by the development endpoints for // authentication. The use of this attribute is preferred over a single public key // because the public keys allow you to have a different private key per client. If // you previously created an endpoint with a public key, you must remove that key - // to be able to set a list of public keys. Call the UpdateDevEndpoint API with the - // public key content in the deletePublicKeys attribute, and the list of new keys - // in the addPublicKeys attribute. + // to be able to set a list of public keys. Call the UpdateDevEndpoint API with + // the public key content in the deletePublicKeys attribute, and the list of new + // keys in the addPublicKeys attribute. PublicKeys []string - // The name of the SecurityConfiguration structure to be used with this - // DevEndpoint. + // The name of the SecurityConfiguration structure to be used with this DevEndpoint + // . SecurityConfiguration *string - // Security group IDs for the security groups to be used by the new DevEndpoint. + // Security group IDs for the security groups to be used by the new DevEndpoint . SecurityGroupIds []string // The subnet ID for the new DevEndpoint to use. @@ -106,21 +105,15 @@ type CreateDevEndpointInput struct { // The type of predefined worker that is allocated to the development endpoint. // Accepts a value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, - // each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors - // per worker. - // - // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 - // GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this - // worker type for memory-intensive jobs. - // - // * For the G.2X worker type, each worker - // maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor - // per worker. We recommend this worker type for memory-intensive jobs. - // - // Known - // issue: when a development endpoint is created with the G.2XWorkerType + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // Known issue: when a development endpoint is created with the G.2X WorkerType // configuration, the Spark drivers for the development endpoint will run on 4 // vCPU, 16 GB of memory, and a 64 GB disk. WorkerType types.WorkerType @@ -130,15 +123,11 @@ type CreateDevEndpointInput struct { type CreateDevEndpointOutput struct { - // The map of arguments used to configure this DevEndpoint. Valid arguments are: - // - // * - // "--enable-glue-datacatalog": "" - // - // You can specify a version of Python support for - // development endpoints by using the Arguments parameter in the CreateDevEndpoint - // or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to - // Python 2. + // The map of arguments used to configure this DevEndpoint . Valid arguments are: + // - "--enable-glue-datacatalog": "" + // You can specify a version of Python support for development endpoints by using + // the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If + // no arguments are provided, the version defaults to Python 2. Arguments map[string]string // The Amazon Web Services Availability Zone where this DevEndpoint is located. @@ -147,26 +136,25 @@ type CreateDevEndpointOutput struct { // The point in time at which this DevEndpoint was created. CreatedTimestamp *time.Time - // The name assigned to the new DevEndpoint. + // The name assigned to the new DevEndpoint . EndpointName *string // Path to one or more Java .jar files in an S3 bucket that will be loaded in your - // DevEndpoint. + // DevEndpoint . ExtraJarsS3Path *string - // The paths to one or more Python libraries in an S3 bucket that will be loaded in - // your DevEndpoint. + // The paths to one or more Python libraries in an S3 bucket that will be loaded + // in your DevEndpoint . ExtraPythonLibsS3Path *string - // The reason for a current failure in this DevEndpoint. + // The reason for a current failure in this DevEndpoint . FailureReason *string // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for running your // ETL scripts on development endpoints. For more information about the available - // Glue versions and corresponding Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. + // Glue versions and corresponding Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. GlueVersion *string // The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint. @@ -176,30 +164,30 @@ type CreateDevEndpointOutput struct { // development endpoint. NumberOfWorkers *int32 - // The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint. + // The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint . RoleArn *string - // The name of the SecurityConfiguration structure being used with this - // DevEndpoint. + // The name of the SecurityConfiguration structure being used with this DevEndpoint + // . SecurityConfiguration *string - // The security groups assigned to the new DevEndpoint. + // The security groups assigned to the new DevEndpoint . SecurityGroupIds []string - // The current status of the new DevEndpoint. + // The current status of the new DevEndpoint . Status *string - // The subnet ID assigned to the new DevEndpoint. + // The subnet ID assigned to the new DevEndpoint . SubnetId *string - // The ID of the virtual private cloud (VPC) used by this DevEndpoint. + // The ID of the virtual private cloud (VPC) used by this DevEndpoint . VpcId *string - // The type of predefined worker that is allocated to the development endpoint. May - // be a value of Standard, G.1X, or G.2X. + // The type of predefined worker that is allocated to the development endpoint. + // May be a value of Standard, G.1X, or G.2X. WorkerType types.WorkerType - // The address of the YARN endpoint used by this DevEndpoint. + // The address of the YARN endpoint used by this DevEndpoint . YarnEndpointAddress *string // The Apache Zeppelin port for the remote Apache Spark interpreter. diff --git a/service/glue/api_op_CreateJob.go b/service/glue/api_op_CreateJob.go index 63bb6b7e9c9..c1a9ca68837 100644 --- a/service/glue/api_op_CreateJob.go +++ b/service/glue/api_op_CreateJob.go @@ -48,7 +48,7 @@ type CreateJobInput struct { // processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 // DPUs; the default is 10. A DPU is a relative measure of processing power that // consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/). + // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/) . // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -60,17 +60,15 @@ type CreateJobInput struct { // The connections used for this job. Connections *types.ConnectionsList - // The default arguments for this job. You can specify arguments here that your own - // job-execution script consumes, as well as arguments that Glue itself consumes. - // Job arguments may be logged. Do not pass plaintext secrets as arguments. - // Retrieve secrets from a Glue Connection, Secrets Manager or other secret - // management mechanism if you intend to keep them within the Job. For information - // about how to specify and consume your own Job arguments, see the Calling Glue - // APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // The default arguments for this job. You can specify arguments here that your + // own job-execution script consumes, as well as arguments that Glue itself + // consumes. Job arguments may be logged. Do not pass plaintext secrets as + // arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other + // secret management mechanism if you intend to keep them within the Job. For + // information about how to specify and consume your own Job arguments, see the + // Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. DefaultArguments map[string]string @@ -82,8 +80,8 @@ type CreateJobInput struct { // fast job startup and dedicated resources. The flexible execution class is // appropriate for time-insensitive jobs whose start and completion times may vary. // Only jobs with Glue version 3.0 and above and command type glueetl will be - // allowed to set ExecutionClass to FLEX. The flexible execution class is available - // for Spark jobs. + // allowed to set ExecutionClass to FLEX . The flexible execution class is + // available for Spark jobs. ExecutionClass types.ExecutionClass // An ExecutionProperty specifying the maximum number of concurrent runs allowed @@ -93,35 +91,30 @@ type CreateJobInput struct { // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for jobs of type // Spark. For more information about the available Glue versions and corresponding - // Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. Jobs that are created without specifying a Glue version default to Glue - // 0.9. + // Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. Jobs that are created without specifying a Glue version + // default to Glue 0.9. GlueVersion *string // This field is reserved for future use. LogUri *string - // For Glue version 1.0 or earlier jobs, using the standard worker type, the number - // of Glue data processing units (DPUs) that can be allocated when this job runs. A - // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). Do not set Max Capacity if using - // WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity - // depends on whether you are running a Python shell job or an Apache Spark ETL - // job: - // - // * When you specify a Python shell job (JobCommand.Name="pythonshell"), you - // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. - // - // * When you - // specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark - // streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate a minimum - // of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU - // allocation. - // - // For Glue version 2.0 jobs, you cannot instead specify a Maximum - // capacity. Instead, you should specify a Worker type and the Number of workers. + // For Glue version 1.0 or earlier jobs, using the standard worker type, the + // number of Glue data processing units (DPUs) that can be allocated when this job + // runs. A DPU is a relative measure of processing power that consists of 4 vCPUs + // of compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . Do not set Max Capacity + // if using WorkerType and NumberOfWorkers . The value that can be allocated for + // MaxCapacity depends on whether you are running a Python shell job or an Apache + // Spark ETL job: + // - When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you + // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. + // - When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl") or + // Apache Spark streaming ETL job ( JobCommand.Name ="gluestreaming"), you can + // allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have + // a fractional DPU allocation. + // For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . + // Instead, you should specify a Worker type and the Number of workers . MaxCapacity *float64 // The maximum number of times to retry this job if it fails. @@ -145,9 +138,8 @@ type CreateJobInput struct { SourceControlDetails *types.SourceControlDetails // The tags to use with this job. You may use tags to limit access to the job. For - // more information about tags in Glue, see Amazon Web Services Tags in Glue - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer - // guide. + // more information about tags in Glue, see Amazon Web Services Tags in Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) + // in the developer guide. Tags map[string]string // The job timeout in minutes. This is the maximum time that a job run can consume @@ -155,26 +147,20 @@ type CreateJobInput struct { // 2,880 minutes (48 hours). Timeout *int32 - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 - // GB disk), and provides 1 executor per worker. We recommend this worker type for - // memory-intensive jobs. - // - // * For the G.2X worker type, each worker maps to 2 DPU (8 - // vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We - // recommend this worker type for memory-intensive jobs. - // - // * For the G.025X worker - // type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and - // provides 1 executor per worker. We recommend this worker type for low volume - // streaming jobs. This worker type is only available for Glue version 3.0 - // streaming jobs. + // The type of predefined worker that is allocated when a job runs. Accepts a + // value of Standard, G.1X, G.2X, or G.025X. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType types.WorkerType noSmithyDocumentSerde diff --git a/service/glue/api_op_CreateMLTransform.go b/service/glue/api_op_CreateMLTransform.go index 0871c1c01bb..17d94eecddf 100644 --- a/service/glue/api_op_CreateMLTransform.go +++ b/service/glue/api_op_CreateMLTransform.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Glue machine learning transform. This operation creates the transform -// and all the necessary parameters to train it. Call this operation as the first -// step in the process of using a machine learning transform (such as the +// Creates an Glue machine learning transform. This operation creates the +// transform and all the necessary parameters to train it. Call this operation as +// the first step in the process of using a machine learning transform (such as the // FindMatches transform) for deduplicating data. You can provide an optional -// Description, in addition to the parameters that you want to use for your +// Description , in addition to the parameters that you want to use for your // algorithm. You must also specify certain parameters for the tasks that Glue runs // on your behalf as part of learning from your data and creating a high-quality -// machine learning transform. These parameters include Role, and optionally, -// AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html). +// machine learning transform. These parameters include Role , and optionally, +// AllocatedCapacity , Timeout , and MaxRetries . For more information, see Jobs (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html) +// . func (c *Client) CreateMLTransform(ctx context.Context, params *CreateMLTransformInput, optFns ...func(*Options)) (*CreateMLTransformOutput, error) { if params == nil { params = &CreateMLTransformInput{} @@ -57,16 +57,12 @@ type CreateMLTransformInput struct { // The name or Amazon Resource Name (ARN) of the IAM role with the required // permissions. The required permissions include both Glue service role permissions // to Glue resources, and Amazon S3 permissions required by the transform. - // - // * This - // role needs Glue service role permissions to allow access to resources in Glue. - // See Attach a Policy to IAM Users That Access Glue - // (https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html). - // - // * - // This role needs permission to your Amazon Simple Storage Service (Amazon S3) - // sources, targets, temporary directory, scripts, and any libraries used by the - // task run for this transform. + // - This role needs Glue service role permissions to allow access to resources + // in Glue. See Attach a Policy to IAM Users That Access Glue (https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html) + // . + // - This role needs permission to your Amazon Simple Storage Service (Amazon + // S3) sources, targets, temporary directory, scripts, and any libraries used by + // the task run for this transform. // // This member is required. Role *string @@ -77,35 +73,26 @@ type CreateMLTransformInput struct { // This value determines which version of Glue this machine learning transform is // compatible with. Glue 1.0 is recommended for most customers. If the value is not - // set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue - // Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // set, the Glue compatibility defaults to Glue 0.9. For more information, see + // Glue Versions (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) // in the developer guide. GlueVersion *string // The number of Glue data processing units (DPUs) that are allocated to task runs // for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). MaxCapacity is a mutually exclusive - // option with NumberOfWorkers and WorkerType. - // - // * If either NumberOfWorkers or - // WorkerType is set, then MaxCapacity cannot be set. - // - // * If MaxCapacity is set then - // neither NumberOfWorkers or WorkerType can be set. - // - // * If WorkerType is set, then - // NumberOfWorkers is required (and vice versa). - // - // * MaxCapacity and NumberOfWorkers - // must both be at least 1. - // - // When the WorkerType field is set to a value other than - // Standard, the MaxCapacity field is set automatically and becomes read-only. When - // the WorkerType field is set to a value other than Standard, the MaxCapacity - // field is set automatically and becomes read-only. + // compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . MaxCapacity is a mutually + // exclusive option with NumberOfWorkers and WorkerType . + // - If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be + // set. + // - If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. + // - If WorkerType is set, then NumberOfWorkers is required (and vice versa). + // - MaxCapacity and NumberOfWorkers must both be at least 1. + // When the WorkerType field is set to a value other than Standard , the + // MaxCapacity field is set automatically and becomes read-only. When the + // WorkerType field is set to a value other than Standard , the MaxCapacity field + // is set automatically and becomes read-only. MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -118,9 +105,8 @@ type CreateMLTransformInput struct { // The tags to use with this machine learning transform. You may use tags to limit // access to the machine learning transform. For more information about tags in - // Glue, see Amazon Web Services Tags in Glue - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer - // guide. + // Glue, see Amazon Web Services Tags in Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) + // in the developer guide. Tags map[string]string // The timeout of the task run for this transform in minutes. This is the maximum @@ -135,31 +121,18 @@ type CreateMLTransformInput struct { // The type of predefined worker that is allocated when this task runs. Accepts a // value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a - // 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker type, each worker - // provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per - // worker. - // - // MaxCapacity is a mutually exclusive option with NumberOfWorkers and - // WorkerType. - // - // * If either NumberOfWorkers or WorkerType is set, then MaxCapacity - // cannot be set. - // - // * If MaxCapacity is set then neither NumberOfWorkers or - // WorkerType can be set. - // - // * If WorkerType is set, then NumberOfWorkers is required - // (and vice versa). - // - // * MaxCapacity and NumberOfWorkers must both be at least 1. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. + // MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType . + // - If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be + // set. + // - If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. + // - If WorkerType is set, then NumberOfWorkers is required (and vice versa). + // - MaxCapacity and NumberOfWorkers must both be at least 1. WorkerType types.WorkerType noSmithyDocumentSerde diff --git a/service/glue/api_op_CreateRegistry.go b/service/glue/api_op_CreateRegistry.go index 4b620169537..726578dcfa4 100644 --- a/service/glue/api_op_CreateRegistry.go +++ b/service/glue/api_op_CreateRegistry.go @@ -34,8 +34,8 @@ type CreateRegistryInput struct { // This member is required. RegistryName *string - // A description of the registry. If description is not provided, there will not be - // any default value for this. + // A description of the registry. If description is not provided, there will not + // be any default value for this. Description *string // Amazon Web Services tags that contain a key value pair and may be searched by diff --git a/service/glue/api_op_CreateSchema.go b/service/glue/api_op_CreateSchema.go index 80b870723d3..efaaa72eb24 100644 --- a/service/glue/api_op_CreateSchema.go +++ b/service/glue/api_op_CreateSchema.go @@ -18,7 +18,7 @@ import ( // from being added after the first schema version. For all other compatibility // modes, validation of compatibility settings will be applied only from the second // version onwards when the RegisterSchemaVersion API is used. When this API is -// called without a RegistryId, this will create an entry for a "default-registry" +// called without a RegistryId , this will create an entry for a "default-registry" // in the registry database tables, if it is not already present. func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error) { if params == nil { @@ -37,8 +37,8 @@ func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, op type CreateSchemaInput struct { - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. // // This member is required. DataFormat types.DataFormat @@ -50,49 +50,38 @@ type CreateSchemaInput struct { SchemaName *string // The compatibility mode of the schema. The possible values are: - // - // * NONE: No - // compatibility mode applies. You can use this choice in development scenarios or - // if you do not know the compatibility mode that you want to apply to schemas. Any - // new version added will be accepted without undergoing a compatibility check. - // - // * - // DISABLED: This compatibility choice prevents versioning for a particular schema. - // You can use this choice to prevent future versioning of a schema. - // - // * BACKWARD: - // This compatibility choice is recommended as it allows data receivers to read - // both the current and one previous schema version. This means that for instance, - // a new schema version cannot drop data fields or change the type of these fields, - // so they can't be read by readers using the previous version. - // - // * BACKWARD_ALL: - // This compatibility choice allows data receivers to read both the current and all - // previous schema versions. You can use this choice when you need to delete fields - // or add optional fields, and check compatibility against all previous schema - // versions. - // - // * FORWARD: This compatibility choice allows data receivers to read - // both the current and one next schema version, but not necessarily later - // versions. You can use this choice when you need to add fields or delete optional - // fields, but only check compatibility against the last schema version. - // - // * - // FORWARD_ALL: This compatibility choice allows data receivers to read written by - // producers of any new registered schema. You can use this choice when you need to - // add fields or delete optional fields, and check compatibility against all - // previous schema versions. - // - // * FULL: This compatibility choice allows data - // receivers to read data written by producers using the previous or next version - // of the schema, but not necessarily earlier or later versions. You can use this - // choice when you need to add or remove optional fields, but only check - // compatibility against the last schema version. - // - // * FULL_ALL: This compatibility - // choice allows data receivers to read data written by producers using all - // previous schema versions. You can use this choice when you need to add or remove - // optional fields, and check compatibility against all previous schema versions. + // - NONE: No compatibility mode applies. You can use this choice in development + // scenarios or if you do not know the compatibility mode that you want to apply to + // schemas. Any new version added will be accepted without undergoing a + // compatibility check. + // - DISABLED: This compatibility choice prevents versioning for a particular + // schema. You can use this choice to prevent future versioning of a schema. + // - BACKWARD: This compatibility choice is recommended as it allows data + // receivers to read both the current and one previous schema version. This means + // that for instance, a new schema version cannot drop data fields or change the + // type of these fields, so they can't be read by readers using the previous + // version. + // - BACKWARD_ALL: This compatibility choice allows data receivers to read both + // the current and all previous schema versions. You can use this choice when you + // need to delete fields or add optional fields, and check compatibility against + // all previous schema versions. + // - FORWARD: This compatibility choice allows data receivers to read both the + // current and one next schema version, but not necessarily later versions. You can + // use this choice when you need to add fields or delete optional fields, but only + // check compatibility against the last schema version. + // - FORWARD_ALL: This compatibility choice allows data receivers to read + // written by producers of any new registered schema. You can use this choice when + // you need to add fields or delete optional fields, and check compatibility + // against all previous schema versions. + // - FULL: This compatibility choice allows data receivers to read data written + // by producers using the previous or next version of the schema, but not + // necessarily earlier or later versions. You can use this choice when you need to + // add or remove optional fields, but only check compatibility against the last + // schema version. + // - FULL_ALL: This compatibility choice allows data receivers to read data + // written by producers using all previous schema versions. You can use this choice + // when you need to add or remove optional fields, and check compatibility against + // all previous schema versions. Compatibility types.Compatibility // An optional description of the schema. If description is not provided, there @@ -101,10 +90,10 @@ type CreateSchemaInput struct { // This is a wrapper shape to contain the registry identity fields. If this is not // provided, the default registry will be used. The ARN format for the same will - // be: arn:aws:glue:us-east-2::registry/default-registry:random-5-letter-id. + // be: arn:aws:glue:us-east-2::registry/default-registry:random-5-letter-id . RegistryId *types.RegistryId - // The schema definition using the DataFormat setting for SchemaName. + // The schema definition using the DataFormat setting for SchemaName . SchemaDefinition *string // Amazon Web Services tags that contain a key value pair and may be searched by @@ -120,8 +109,8 @@ type CreateSchemaOutput struct { // The schema compatibility mode. Compatibility types.Compatibility - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. DataFormat types.DataFormat // A description of the schema if specified when created. diff --git a/service/glue/api_op_CreateSecurityConfiguration.go b/service/glue/api_op_CreateSecurityConfiguration.go index adf64145d3b..d3e6cf386fa 100644 --- a/service/glue/api_op_CreateSecurityConfiguration.go +++ b/service/glue/api_op_CreateSecurityConfiguration.go @@ -16,8 +16,8 @@ import ( // security properties that can be used by Glue. You can use a security // configuration to encrypt data at rest. For information about using security // configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and -// Development Endpoints -// (https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html). +// Development Endpoints (https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html) +// . func (c *Client) CreateSecurityConfiguration(ctx context.Context, params *CreateSecurityConfigurationInput, optFns ...func(*Options)) (*CreateSecurityConfigurationOutput, error) { if params == nil { params = &CreateSecurityConfigurationInput{} diff --git a/service/glue/api_op_CreateSession.go b/service/glue/api_op_CreateSession.go index 672f81abcf3..8adf84a3aaa 100644 --- a/service/glue/api_op_CreateSession.go +++ b/service/glue/api_op_CreateSession.go @@ -79,31 +79,25 @@ type CreateSessionInput struct { // The map of key value pairs (tags) belonging to the session. Tags map[string]string - // The number of minutes before session times out. Default for Spark ETL jobs is 48 - // hours (2880 minutes), the maximum session lifetime for this job type. Consult + // The number of minutes before session times out. Default for Spark ETL jobs is + // 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult // the documentation for other job types. Timeout *int32 // The type of predefined worker that is allocated to use for the session. Accepts // a value of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, - // each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors - // per worker. - // - // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 - // GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this - // worker type for memory-intensive jobs. - // - // * For the G.2X worker type, each worker - // maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor - // per worker. We recommend this worker type for memory-intensive jobs. - // - // * For the - // G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB - // disk), and provides 1 executor per worker. We recommend this worker type for low - // volume streaming jobs. This worker type is only available for Glue version 3.0 - // streaming jobs. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType types.WorkerType noSmithyDocumentSerde diff --git a/service/glue/api_op_CreateTable.go b/service/glue/api_op_CreateTable.go index 8ac8bd19b4c..b11799b99de 100644 --- a/service/glue/api_op_CreateTable.go +++ b/service/glue/api_op_CreateTable.go @@ -40,7 +40,7 @@ type CreateTableInput struct { // This member is required. TableInput *types.TableInput - // The ID of the Data Catalog in which to create the Table. If none is supplied, + // The ID of the Data Catalog in which to create the Table . If none is supplied, // the Amazon Web Services account ID is used by default. CatalogId *string diff --git a/service/glue/api_op_CreateTrigger.go b/service/glue/api_op_CreateTrigger.go index 1237b410139..9fa0dea1095 100644 --- a/service/glue/api_op_CreateTrigger.go +++ b/service/glue/api_op_CreateTrigger.go @@ -52,14 +52,13 @@ type CreateTriggerInput struct { EventBatchingCondition *types.EventBatchingCondition // A predicate to specify when the new trigger should fire. This field is required - // when the trigger type is CONDITIONAL. + // when the trigger type is CONDITIONAL . Predicate *types.Predicate // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). This field is required when the trigger type is SCHEDULED. + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . This field is required when the trigger type is SCHEDULED. Schedule *string // Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is diff --git a/service/glue/api_op_CreateUserDefinedFunction.go b/service/glue/api_op_CreateUserDefinedFunction.go index 79c4db87038..fa9905535de 100644 --- a/service/glue/api_op_CreateUserDefinedFunction.go +++ b/service/glue/api_op_CreateUserDefinedFunction.go @@ -39,8 +39,8 @@ type CreateUserDefinedFunctionInput struct { // This member is required. FunctionInput *types.UserDefinedFunctionInput - // The ID of the Data Catalog in which to create the function. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which to create the function. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_DeleteColumnStatisticsForPartition.go b/service/glue/api_op_DeleteColumnStatisticsForPartition.go index 5528d8fa4bb..1161f94f61e 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForPartition.go +++ b/service/glue/api_op_DeleteColumnStatisticsForPartition.go @@ -11,7 +11,7 @@ import ( ) // Delete the partition column statistics of a column. The Identity and Access -// Management (IAM) permission required for this operation is DeletePartition. +// Management (IAM) permission required for this operation is DeletePartition . func (c *Client) DeleteColumnStatisticsForPartition(ctx context.Context, params *DeleteColumnStatisticsForPartitionInput, optFns ...func(*Options)) (*DeleteColumnStatisticsForPartitionOutput, error) { if params == nil { params = &DeleteColumnStatisticsForPartitionInput{} diff --git a/service/glue/api_op_DeleteColumnStatisticsForTable.go b/service/glue/api_op_DeleteColumnStatisticsForTable.go index 0220b76e24f..4caad839ba8 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForTable.go +++ b/service/glue/api_op_DeleteColumnStatisticsForTable.go @@ -11,7 +11,7 @@ import ( ) // Retrieves table statistics of columns. The Identity and Access Management (IAM) -// permission required for this operation is DeleteTable. +// permission required for this operation is DeleteTable . func (c *Client) DeleteColumnStatisticsForTable(ctx context.Context, params *DeleteColumnStatisticsForTableInput, optFns ...func(*Options)) (*DeleteColumnStatisticsForTableOutput, error) { if params == nil { params = &DeleteColumnStatisticsForTableInput{} diff --git a/service/glue/api_op_DeleteConnection.go b/service/glue/api_op_DeleteConnection.go index 40f229c18b6..0b38c6e77bf 100644 --- a/service/glue/api_op_DeleteConnection.go +++ b/service/glue/api_op_DeleteConnection.go @@ -33,8 +33,8 @@ type DeleteConnectionInput struct { // This member is required. ConnectionName *string - // The ID of the Data Catalog in which the connection resides. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which the connection resides. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_DeleteCrawler.go b/service/glue/api_op_DeleteCrawler.go index 9c0463f06fe..9dd46f097c5 100644 --- a/service/glue/api_op_DeleteCrawler.go +++ b/service/glue/api_op_DeleteCrawler.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a specified crawler from the Glue Data Catalog, unless the crawler state -// is RUNNING. +// Removes a specified crawler from the Glue Data Catalog, unless the crawler +// state is RUNNING . func (c *Client) DeleteCrawler(ctx context.Context, params *DeleteCrawlerInput, optFns ...func(*Options)) (*DeleteCrawlerOutput, error) { if params == nil { params = &DeleteCrawlerInput{} diff --git a/service/glue/api_op_DeleteDatabase.go b/service/glue/api_op_DeleteDatabase.go index 93615ef2c37..ce9d4227092 100644 --- a/service/glue/api_op_DeleteDatabase.go +++ b/service/glue/api_op_DeleteDatabase.go @@ -15,10 +15,10 @@ import ( // partitions that might belong to the tables) and the user-defined functions in // the deleted database. Glue deletes these "orphaned" resources asynchronously in // a timely manner, at the discretion of the service. To ensure the immediate -// deletion of all related resources, before calling DeleteDatabase, use -// DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or -// BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or -// BatchDeleteTable, to delete any resources that belong to the database. +// deletion of all related resources, before calling DeleteDatabase , use +// DeleteTableVersion or BatchDeleteTableVersion , DeletePartition or +// BatchDeletePartition , DeleteUserDefinedFunction , and DeleteTable or +// BatchDeleteTable , to delete any resources that belong to the database. func (c *Client) DeleteDatabase(ctx context.Context, params *DeleteDatabaseInput, optFns ...func(*Options)) (*DeleteDatabaseOutput, error) { if params == nil { params = &DeleteDatabaseInput{} diff --git a/service/glue/api_op_DeleteDevEndpoint.go b/service/glue/api_op_DeleteDevEndpoint.go index 68eac854663..a20a0a64d1b 100644 --- a/service/glue/api_op_DeleteDevEndpoint.go +++ b/service/glue/api_op_DeleteDevEndpoint.go @@ -28,7 +28,7 @@ func (c *Client) DeleteDevEndpoint(ctx context.Context, params *DeleteDevEndpoin type DeleteDevEndpointInput struct { - // The name of the DevEndpoint. + // The name of the DevEndpoint . // // This member is required. EndpointName *string diff --git a/service/glue/api_op_DeleteMLTransform.go b/service/glue/api_op_DeleteMLTransform.go index 2afc3104974..25decf368d5 100644 --- a/service/glue/api_op_DeleteMLTransform.go +++ b/service/glue/api_op_DeleteMLTransform.go @@ -14,7 +14,7 @@ import ( // special type of transform that use machine learning to learn the details of the // transformation to be performed by learning from examples provided by humans. // These transformations are then saved by Glue. If you no longer need a transform, -// you can delete it by calling DeleteMLTransforms. However, any Glue jobs that +// you can delete it by calling DeleteMLTransforms . However, any Glue jobs that // still reference the deleted transform will no longer succeed. func (c *Client) DeleteMLTransform(ctx context.Context, params *DeleteMLTransformInput, optFns ...func(*Options)) (*DeleteMLTransformOutput, error) { if params == nil { diff --git a/service/glue/api_op_DeletePartition.go b/service/glue/api_op_DeletePartition.go index 817550fa0a4..452ad02d6a6 100644 --- a/service/glue/api_op_DeletePartition.go +++ b/service/glue/api_op_DeletePartition.go @@ -43,8 +43,8 @@ type DeletePartitionInput struct { // This member is required. TableName *string - // The ID of the Data Catalog where the partition to be deleted resides. If none is - // provided, the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog where the partition to be deleted resides. If none + // is provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_DeleteRegistry.go b/service/glue/api_op_DeleteRegistry.go index 3e6ebc0a777..e666183009a 100644 --- a/service/glue/api_op_DeleteRegistry.go +++ b/service/glue/api_op_DeleteRegistry.go @@ -14,7 +14,7 @@ import ( // Delete the entire registry including schema and all of its versions. To get the // status of the delete operation, you can call the GetRegistry API after the // asynchronous call. Deleting a registry will deactivate all online operations for -// the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and +// the registry such as the UpdateRegistry , CreateSchema , UpdateSchema , and // RegisterSchemaVersion APIs. func (c *Client) DeleteRegistry(ctx context.Context, params *DeleteRegistryInput, optFns ...func(*Options)) (*DeleteRegistryOutput, error) { if params == nil { diff --git a/service/glue/api_op_DeleteSchema.go b/service/glue/api_op_DeleteSchema.go index e5cf752e586..d8e74452f29 100644 --- a/service/glue/api_op_DeleteSchema.go +++ b/service/glue/api_op_DeleteSchema.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the entire schema set, including the schema set and all of its versions. -// To get the status of the delete operation, you can call GetSchema API after the -// asynchronous call. Deleting a registry will deactivate all online operations for -// the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs. +// Deletes the entire schema set, including the schema set and all of its +// versions. To get the status of the delete operation, you can call GetSchema API +// after the asynchronous call. Deleting a registry will deactivate all online +// operations for the schema, such as the GetSchemaByDefinition , and +// RegisterSchemaVersion APIs. func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error) { if params == nil { params = &DeleteSchemaInput{} @@ -32,8 +33,8 @@ func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, op type DeleteSchemaInput struct { - // This is a wrapper structure that may contain the schema name and Amazon Resource - // Name (ARN). + // This is a wrapper structure that may contain the schema name and Amazon + // Resource Name (ARN). // // This member is required. SchemaId *types.SchemaId diff --git a/service/glue/api_op_DeleteSchemaVersions.go b/service/glue/api_op_DeleteSchemaVersions.go index f63b91b7980..8a7da773cc1 100644 --- a/service/glue/api_op_DeleteSchemaVersions.go +++ b/service/glue/api_op_DeleteSchemaVersions.go @@ -17,10 +17,10 @@ import ( // GetSchemaVersions API after this call will list the status of the deleted // versions. When the range of version numbers contain check pointed version, the // API will return a 409 conflict and will not proceed with the deletion. You have -// to remove the checkpoint first using the DeleteSchemaCheckpoint API before using -// this API. You cannot use the DeleteSchemaVersions API to delete the first schema -// version in the schema set. The first schema version can only be deleted by the -// DeleteSchema API. This operation will also delete the attached +// to remove the checkpoint first using the DeleteSchemaCheckpoint API before +// using this API. You cannot use the DeleteSchemaVersions API to delete the first +// schema version in the schema set. The first schema version can only be deleted +// by the DeleteSchema API. This operation will also delete the attached // SchemaVersionMetadata under the schema versions. Hard deletes will be enforced // on the database. If the compatibility mode forbids deleting of a version that is // necessary, such as BACKWARDS_FULL, an error is returned. @@ -41,18 +41,15 @@ func (c *Client) DeleteSchemaVersions(ctx context.Context, params *DeleteSchemaV type DeleteSchemaVersionsInput struct { - // This is a wrapper structure that may contain the schema name and Amazon Resource - // Name (ARN). + // This is a wrapper structure that may contain the schema name and Amazon + // Resource Name (ARN). // // This member is required. SchemaId *types.SchemaId // A version range may be supplied which may be of the format: - // - // * a single version - // number, 5 - // - // * a range, 5-8 : deletes versions 5, 6, 7, 8 + // - a single version number, 5 + // - a range, 5-8 : deletes versions 5, 6, 7, 8 // // This member is required. Versions *string diff --git a/service/glue/api_op_DeleteTable.go b/service/glue/api_op_DeleteTable.go index 42358ef7b79..b4452474095 100644 --- a/service/glue/api_op_DeleteTable.go +++ b/service/glue/api_op_DeleteTable.go @@ -14,9 +14,9 @@ import ( // operation, you no longer have access to the table versions and partitions that // belong to the deleted table. Glue deletes these "orphaned" resources // asynchronously in a timely manner, at the discretion of the service. To ensure -// the immediate deletion of all related resources, before calling DeleteTable, use -// DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or -// BatchDeletePartition, to delete any resources that belong to the table. +// the immediate deletion of all related resources, before calling DeleteTable , +// use DeleteTableVersion or BatchDeleteTableVersion , and DeletePartition or +// BatchDeletePartition , to delete any resources that belong to the table. func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) { if params == nil { params = &DeleteTableInput{} diff --git a/service/glue/api_op_GetColumnStatisticsForPartition.go b/service/glue/api_op_GetColumnStatisticsForPartition.go index fd73f22fbe3..8afaf598174 100644 --- a/service/glue/api_op_GetColumnStatisticsForPartition.go +++ b/service/glue/api_op_GetColumnStatisticsForPartition.go @@ -12,7 +12,7 @@ import ( ) // Retrieves partition statistics of columns. The Identity and Access Management -// (IAM) permission required for this operation is GetPartition. +// (IAM) permission required for this operation is GetPartition . func (c *Client) GetColumnStatisticsForPartition(ctx context.Context, params *GetColumnStatisticsForPartitionInput, optFns ...func(*Options)) (*GetColumnStatisticsForPartitionOutput, error) { if params == nil { params = &GetColumnStatisticsForPartitionInput{} diff --git a/service/glue/api_op_GetColumnStatisticsForTable.go b/service/glue/api_op_GetColumnStatisticsForTable.go index cd7891f0324..9ae6dedcb84 100644 --- a/service/glue/api_op_GetColumnStatisticsForTable.go +++ b/service/glue/api_op_GetColumnStatisticsForTable.go @@ -12,7 +12,7 @@ import ( ) // Retrieves table statistics of columns. The Identity and Access Management (IAM) -// permission required for this operation is GetTable. +// permission required for this operation is GetTable . func (c *Client) GetColumnStatisticsForTable(ctx context.Context, params *GetColumnStatisticsForTableInput, optFns ...func(*Options)) (*GetColumnStatisticsForTableOutput, error) { if params == nil { params = &GetColumnStatisticsForTableInput{} diff --git a/service/glue/api_op_GetConnection.go b/service/glue/api_op_GetConnection.go index 2b6e000f5c4..dd469c2a3a4 100644 --- a/service/glue/api_op_GetConnection.go +++ b/service/glue/api_op_GetConnection.go @@ -34,8 +34,8 @@ type GetConnectionInput struct { // This member is required. Name *string - // The ID of the Data Catalog in which the connection resides. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which the connection resides. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string // Allows you to retrieve the connection metadata without returning the password. diff --git a/service/glue/api_op_GetConnections.go b/service/glue/api_op_GetConnections.go index 8926d88632f..af6093c61e9 100644 --- a/service/glue/api_op_GetConnections.go +++ b/service/glue/api_op_GetConnections.go @@ -30,8 +30,8 @@ func (c *Client) GetConnections(ctx context.Context, params *GetConnectionsInput type GetConnectionsInput struct { - // The ID of the Data Catalog in which the connections reside. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which the connections reside. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string // A filter that controls which connections are returned. diff --git a/service/glue/api_op_GetDataQualityRuleRecommendationRun.go b/service/glue/api_op_GetDataQualityRuleRecommendationRun.go index 3f271c6d3d6..51d369fadba 100644 --- a/service/glue/api_op_GetDataQualityRuleRecommendationRun.go +++ b/service/glue/api_op_GetDataQualityRuleRecommendationRun.go @@ -62,8 +62,8 @@ type GetDataQualityRuleRecommendationRunOutput struct { // The number of G.1X workers to be used in the run. The default is 5. NumberOfWorkers *int32 - // When a start rule recommendation run completes, it creates a recommended ruleset - // (a set of rules). This member has those rules in Data Quality Definition + // When a start rule recommendation run completes, it creates a recommended + // ruleset (a set of rules). This member has those rules in Data Quality Definition // Language (DQDL) format. RecommendedRuleset *string @@ -80,8 +80,8 @@ type GetDataQualityRuleRecommendationRunOutput struct { Status types.TaskStatusType // The timeout for a run in minutes. This is the maximum time that a run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). + // consume resources before it is terminated and enters TIMEOUT status. The + // default is 2,880 minutes (48 hours). Timeout *int32 // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_GetDataQualityRuleset.go b/service/glue/api_op_GetDataQualityRuleset.go index 7287780db8e..9511f35ca69 100644 --- a/service/glue/api_op_GetDataQualityRuleset.go +++ b/service/glue/api_op_GetDataQualityRuleset.go @@ -56,8 +56,8 @@ type GetDataQualityRulesetOutput struct { // to link the two together. RecommendationRunId *string - // A Data Quality Definition Language (DQDL) ruleset. For more information, see the - // Glue developer guide. + // A Data Quality Definition Language (DQDL) ruleset. For more information, see + // the Glue developer guide. Ruleset *string // The name and database name of the target table. diff --git a/service/glue/api_op_GetDataQualityRulesetEvaluationRun.go b/service/glue/api_op_GetDataQualityRulesetEvaluationRun.go index 8b959655b33..66ba8ff3ae9 100644 --- a/service/glue/api_op_GetDataQualityRulesetEvaluationRun.go +++ b/service/glue/api_op_GetDataQualityRulesetEvaluationRun.go @@ -81,8 +81,8 @@ type GetDataQualityRulesetEvaluationRunOutput struct { Status types.TaskStatusType // The timeout for a run in minutes. This is the maximum time that a run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). + // consume resources before it is terminated and enters TIMEOUT status. The + // default is 2,880 minutes (48 hours). Timeout *int32 // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_GetDatabase.go b/service/glue/api_op_GetDatabase.go index cc96eecccaa..3480baa4209 100644 --- a/service/glue/api_op_GetDatabase.go +++ b/service/glue/api_op_GetDatabase.go @@ -29,8 +29,8 @@ func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optF type GetDatabaseInput struct { - // The name of the database to retrieve. For Hive compatibility, this should be all - // lowercase. + // The name of the database to retrieve. For Hive compatibility, this should be + // all lowercase. // // This member is required. Name *string diff --git a/service/glue/api_op_GetDatabases.go b/service/glue/api_op_GetDatabases.go index 62b90dd76d3..70182c0ecfc 100644 --- a/service/glue/api_op_GetDatabases.go +++ b/service/glue/api_op_GetDatabases.go @@ -30,7 +30,7 @@ func (c *Client) GetDatabases(ctx context.Context, params *GetDatabasesInput, op type GetDatabasesInput struct { - // The ID of the Data Catalog from which to retrieve Databases. If none is + // The ID of the Data Catalog from which to retrieve Databases . If none is // provided, the Amazon Web Services account ID is used by default. CatalogId *string @@ -41,17 +41,12 @@ type GetDatabasesInput struct { NextToken *string // Allows you to specify that you want to list the databases shared with your - // account. The allowable values are FEDERATED, FOREIGN or ALL. - // - // * If set to - // FEDERATED, will list the federated databases (referencing an external entity) - // shared with your account. - // - // * If set to FOREIGN, will list the databases shared - // with your account. - // - // * If set to ALL, will list the databases shared with your - // account, as well as the databases in yor local account. + // account. The allowable values are FEDERATED , FOREIGN or ALL . + // - If set to FEDERATED , will list the federated databases (referencing an + // external entity) shared with your account. + // - If set to FOREIGN , will list the databases shared with your account. + // - If set to ALL , will list the databases shared with your account, as well as + // the databases in yor local account. ResourceShareType types.ResourceShareType noSmithyDocumentSerde @@ -64,8 +59,8 @@ type GetDatabasesOutput struct { // This member is required. DatabaseList []types.Database - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_GetJobBookmark.go b/service/glue/api_op_GetJobBookmark.go index 12aa634271f..68001af7f4f 100644 --- a/service/glue/api_op_GetJobBookmark.go +++ b/service/glue/api_op_GetJobBookmark.go @@ -11,19 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information on a job bookmark entry. For more information about enabling -// and using job bookmarks, see: -// -// * Tracking processed data using job bookmarks -// (https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html) -// -// * Job -// parameters used by Glue -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) -// -// * -// Job structure -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) +// Returns information on a job bookmark entry. For more information about +// enabling and using job bookmarks, see: +// - Tracking processed data using job bookmarks (https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html) +// - Job parameters used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) +// - Job structure (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) func (c *Client) GetJobBookmark(ctx context.Context, params *GetJobBookmarkInput, optFns ...func(*Options)) (*GetJobBookmarkOutput, error) { if params == nil { params = &GetJobBookmarkInput{} diff --git a/service/glue/api_op_GetMLTaskRun.go b/service/glue/api_op_GetMLTaskRun.go index 31e47f83607..0f734a9767c 100644 --- a/service/glue/api_op_GetMLTaskRun.go +++ b/service/glue/api_op_GetMLTaskRun.go @@ -16,7 +16,7 @@ import ( // learning task runs are asynchronous tasks that Glue runs on your behalf as part // of various machine learning workflows. You can check the stats of any task run // by calling GetMLTaskRun with the TaskRunID and its parent transform's -// TransformID. +// TransformID . func (c *Client) GetMLTaskRun(ctx context.Context, params *GetMLTaskRunInput, optFns ...func(*Options)) (*GetMLTaskRunOutput, error) { if params == nil { params = &GetMLTaskRunInput{} diff --git a/service/glue/api_op_GetMLTaskRuns.go b/service/glue/api_op_GetMLTaskRuns.go index 5a16773781e..fa7963ec71f 100644 --- a/service/glue/api_op_GetMLTaskRuns.go +++ b/service/glue/api_op_GetMLTaskRuns.go @@ -12,12 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of runs for a machine learning transform. Machine learning task runs -// are asynchronous tasks that Glue runs on your behalf as part of various machine -// learning workflows. You can get a sortable, filterable list of machine learning -// task runs by calling GetMLTaskRuns with their parent transform's TransformID and -// other optional parameters as documented in this section. This operation returns -// a list of historic runs and must be paginated. +// Gets a list of runs for a machine learning transform. Machine learning task +// runs are asynchronous tasks that Glue runs on your behalf as part of various +// machine learning workflows. You can get a sortable, filterable list of machine +// learning task runs by calling GetMLTaskRuns with their parent transform's +// TransformID and other optional parameters as documented in this section. This +// operation returns a list of historic runs and must be paginated. func (c *Client) GetMLTaskRuns(ctx context.Context, params *GetMLTaskRunsInput, optFns ...func(*Options)) (*GetMLTaskRunsOutput, error) { if params == nil { params = &GetMLTaskRunsInput{} diff --git a/service/glue/api_op_GetMLTransform.go b/service/glue/api_op_GetMLTransform.go index 8cc563f622b..669fc782b54 100644 --- a/service/glue/api_op_GetMLTransform.go +++ b/service/glue/api_op_GetMLTransform.go @@ -16,7 +16,7 @@ import ( // metadata. Machine learning transforms are a special type of transform that use // machine learning to learn the details of the transformation to be performed by // learning from examples provided by humans. These transformations are then saved -// by Glue. You can retrieve their metadata by calling GetMLTransform. +// by Glue. You can retrieve their metadata by calling GetMLTransform . func (c *Client) GetMLTransform(ctx context.Context, params *GetMLTransformInput, optFns ...func(*Options)) (*GetMLTransformOutput, error) { if params == nil { params = &GetMLTransformInput{} @@ -34,8 +34,8 @@ func (c *Client) GetMLTransform(ctx context.Context, params *GetMLTransformInput type GetMLTransformInput struct { - // The unique identifier of the transform, generated at the time that the transform - // was created. + // The unique identifier of the transform, generated at the time that the + // transform was created. // // This member is required. TransformId *string @@ -56,9 +56,8 @@ type GetMLTransformOutput struct { // This value determines which version of Glue this machine learning transform is // compatible with. Glue 1.0 is recommended for most customers. If the value is not - // set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue - // Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // set, the Glue compatibility defaults to Glue 0.9. For more information, see + // Glue Versions (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) // in the developer guide. GlueVersion *string @@ -74,10 +73,10 @@ type GetMLTransformOutput struct { // The number of Glue data processing units (DPUs) that are allocated to task runs // for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). When the WorkerType field is set to - // a value other than Standard, the MaxCapacity field is set automatically and - // becomes read-only. + // compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . When the WorkerType field + // is set to a value other than Standard , the MaxCapacity field is set + // automatically and becomes read-only. MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -116,22 +115,18 @@ type GetMLTransformOutput struct { // using KMS. TransformEncryption *types.TransformEncryption - // The unique identifier of the transform, generated at the time that the transform - // was created. + // The unique identifier of the transform, generated at the time that the + // transform was created. TransformId *string // The type of predefined worker that is allocated when this task runs. Accepts a // value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a - // 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker type, each worker - // provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. WorkerType types.WorkerType // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_GetMLTransforms.go b/service/glue/api_op_GetMLTransforms.go index 045c455d9a6..f45601a29a1 100644 --- a/service/glue/api_op_GetMLTransforms.go +++ b/service/glue/api_op_GetMLTransforms.go @@ -16,7 +16,7 @@ import ( // Machine learning transforms are a special type of transform that use machine // learning to learn the details of the transformation to be performed by learning // from examples provided by humans. These transformations are then saved by Glue, -// and you can retrieve their metadata by calling GetMLTransforms. +// and you can retrieve their metadata by calling GetMLTransforms . func (c *Client) GetMLTransforms(ctx context.Context, params *GetMLTransformsInput, optFns ...func(*Options)) (*GetMLTransformsOutput, error) { if params == nil { params = &GetMLTransformsInput{} diff --git a/service/glue/api_op_GetPartitionIndexes.go b/service/glue/api_op_GetPartitionIndexes.go index 3c5dd7a43ee..b1dacd274bb 100644 --- a/service/glue/api_op_GetPartitionIndexes.go +++ b/service/glue/api_op_GetPartitionIndexes.go @@ -128,8 +128,8 @@ func (c *Client) addOperationGetPartitionIndexesMiddlewares(stack *middleware.St return nil } -// GetPartitionIndexesAPIClient is a client that implements the GetPartitionIndexes -// operation. +// GetPartitionIndexesAPIClient is a client that implements the +// GetPartitionIndexes operation. type GetPartitionIndexesAPIClient interface { GetPartitionIndexes(context.Context, *GetPartitionIndexesInput, ...func(*Options)) (*GetPartitionIndexesOutput, error) } diff --git a/service/glue/api_op_GetPartitions.go b/service/glue/api_op_GetPartitions.go index c424f02c8d6..9c8ef4f4473 100644 --- a/service/glue/api_op_GetPartitions.go +++ b/service/glue/api_op_GetPartitions.go @@ -70,31 +70,19 @@ type GetPartitionsInput struct { // right operand; if yes, then the condition becomes true. Example: (a <= b) is // true. AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Logical operators. Supported // Partition Key Types: The following are the supported partition keys. - // - // * - // string - // - // * date - // - // * timestamp - // - // * int - // - // * bigint - // - // * long - // - // * tinyint - // - // * smallint - // - // * - // decimal - // - // If an type is encountered that is not valid, an exception is thrown. - // The following list shows the valid operators on each type. When you define a - // crawler, the partitionKey type is created as a STRING, to be compatible with the - // catalog partitions. Sample API Call: + // - string + // - date + // - timestamp + // - int + // - bigint + // - long + // - tinyint + // - smallint + // - decimal + // If an type is encountered that is not valid, an exception is thrown. The + // following list shows the valid operators on each type. When you define a + // crawler, the partitionKey type is created as a STRING , to be compatible with + // the catalog partitions. Sample API Call: Expression *string // The maximum number of partitions to return in a single response. @@ -106,7 +94,7 @@ type GetPartitionsInput struct { // The time as of when to read the partition contents. If not set, the most recent // transaction commit time will be used. Cannot be specified along with - // TransactionId. + // TransactionId . QueryAsOfTime *time.Time // The segment of the table's partitions to scan in this request. diff --git a/service/glue/api_op_GetPlan.go b/service/glue/api_op_GetPlan.go index ab04c66dfb1..70cb8265c81 100644 --- a/service/glue/api_op_GetPlan.go +++ b/service/glue/api_op_GetPlan.go @@ -41,11 +41,10 @@ type GetPlanInput struct { // A map to hold additional optional key-value parameters. Currently, these // key-value pairs are supported: - // - // * inferSchema — Specifies whether to set - // inferSchema to true or false for the default script generated by an Glue job. - // For example, to set inferSchema to true, pass the following key value pair: - // --additional-plan-options-map '{"inferSchema":"true"}' + // - inferSchema — Specifies whether to set inferSchema to true or false for the + // default script generated by an Glue job. For example, to set inferSchema to + // true, pass the following key value pair: --additional-plan-options-map + // '{"inferSchema":"true"}' AdditionalPlanOptionsMap map[string]string // The programming language of the code to perform the mapping. diff --git a/service/glue/api_op_GetResourcePolicies.go b/service/glue/api_op_GetResourcePolicies.go index 315f4921de6..85990307227 100644 --- a/service/glue/api_op_GetResourcePolicies.go +++ b/service/glue/api_op_GetResourcePolicies.go @@ -119,8 +119,8 @@ func (c *Client) addOperationGetResourcePoliciesMiddlewares(stack *middleware.St return nil } -// GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies -// operation. +// GetResourcePoliciesAPIClient is a client that implements the +// GetResourcePolicies operation. type GetResourcePoliciesAPIClient interface { GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error) } diff --git a/service/glue/api_op_GetResourcePolicy.go b/service/glue/api_op_GetResourcePolicy.go index 0bd0d8dc1e7..71b0890840d 100644 --- a/service/glue/api_op_GetResourcePolicy.go +++ b/service/glue/api_op_GetResourcePolicy.go @@ -31,9 +31,9 @@ type GetResourcePolicyInput struct { // The ARN of the Glue resource for which to retrieve the resource policy. If not // supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies - // to view all existing resource policies. For more information see Specifying Glue - // Resource ARNs - // (https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html). + // to view all existing resource policies. For more information see Specifying + // Glue Resource ARNs (https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html) + // . ResourceArn *string noSmithyDocumentSerde diff --git a/service/glue/api_op_GetSchema.go b/service/glue/api_op_GetSchema.go index 0a130bcff1a..f932197a33b 100644 --- a/service/glue/api_op_GetSchema.go +++ b/service/glue/api_op_GetSchema.go @@ -31,13 +31,10 @@ type GetSchemaInput struct { // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // Either SchemaArn or SchemaName and RegistryName has to be provided. - // - // * - // SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and - // RegistryName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either + // SchemaArn or SchemaName and RegistryName has to be provided. + // - SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName + // and RegistryName has to be provided. // // This member is required. SchemaId *types.SchemaId @@ -53,8 +50,8 @@ type GetSchemaOutput struct { // The date and time the schema was created. CreatedTime *string - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. DataFormat types.DataFormat // A description of schema if specified when created diff --git a/service/glue/api_op_GetSchemaByDefinition.go b/service/glue/api_op_GetSchemaByDefinition.go index bc311f60c70..d98fcf7a499 100644 --- a/service/glue/api_op_GetSchemaByDefinition.go +++ b/service/glue/api_op_GetSchemaByDefinition.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a schema by the SchemaDefinition. The schema definition is sent to the -// Schema Registry, canonicalized, and hashed. If the hash is matched within the -// scope of the SchemaName or ARN (or the default registry, if none is supplied), -// that schema’s metadata is returned. Otherwise, a 404 or NotFound error is -// returned. Schema versions in Deleted statuses will not be included in the -// results. +// Retrieves a schema by the SchemaDefinition . The schema definition is sent to +// the Schema Registry, canonicalized, and hashed. If the hash is matched within +// the scope of the SchemaName or ARN (or the default registry, if none is +// supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound +// error is returned. Schema versions in Deleted statuses will not be included in +// the results. func (c *Client) GetSchemaByDefinition(ctx context.Context, params *GetSchemaByDefinitionInput, optFns ...func(*Options)) (*GetSchemaByDefinitionOutput, error) { if params == nil { params = &GetSchemaByDefinitionInput{} @@ -41,12 +41,10 @@ type GetSchemaByDefinitionInput struct { // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // One of SchemaArn or SchemaName has to be provided. - // - // * SchemaId$SchemaName: The - // name of the schema. One of SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of + // SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName + // has to be provided. // // This member is required. SchemaId *types.SchemaId @@ -59,8 +57,8 @@ type GetSchemaByDefinitionOutput struct { // The date and time the schema was created. CreatedTime *string - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. DataFormat types.DataFormat // The Amazon Resource Name (ARN) of the schema. diff --git a/service/glue/api_op_GetSchemaVersion.go b/service/glue/api_op_GetSchemaVersion.go index 28b8f0d4dce..5f52d820285 100644 --- a/service/glue/api_op_GetSchemaVersion.go +++ b/service/glue/api_op_GetSchemaVersion.go @@ -33,13 +33,10 @@ type GetSchemaVersionInput struct { // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // Either SchemaArn or SchemaName and RegistryName has to be provided. - // - // * - // SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and - // RegistryName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either + // SchemaArn or SchemaName and RegistryName has to be provided. + // - SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName + // and RegistryName has to be provided. SchemaId *types.SchemaId // The SchemaVersionId of the schema version. This field is required for fetching @@ -57,8 +54,8 @@ type GetSchemaVersionOutput struct { // The date and time the schema version was created. CreatedTime *string - // The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are - // supported. + // The data format of the schema definition. Currently AVRO , JSON and PROTOBUF + // are supported. DataFormat types.DataFormat // The Amazon Resource Name (ARN) of the schema. diff --git a/service/glue/api_op_GetSchemaVersionsDiff.go b/service/glue/api_op_GetSchemaVersionsDiff.go index 62f17b43ae2..cc7d98aa052 100644 --- a/service/glue/api_op_GetSchemaVersionsDiff.go +++ b/service/glue/api_op_GetSchemaVersionsDiff.go @@ -37,19 +37,17 @@ type GetSchemaVersionsDiffInput struct { // This member is required. FirstSchemaVersionNumber *types.SchemaVersionNumber - // Refers to SYNTAX_DIFF, which is the currently supported diff type. + // Refers to SYNTAX_DIFF , which is the currently supported diff type. // // This member is required. SchemaDiffType types.SchemaDiffType // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // One of SchemaArn or SchemaName has to be provided. - // - // * SchemaId$SchemaName: The - // name of the schema. One of SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of + // SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName + // has to be provided. // // This member is required. SchemaId *types.SchemaId diff --git a/service/glue/api_op_GetTable.go b/service/glue/api_op_GetTable.go index ce892358719..a28654d7a9b 100644 --- a/service/glue/api_op_GetTable.go +++ b/service/glue/api_op_GetTable.go @@ -48,7 +48,7 @@ type GetTableInput struct { // The time as of when to read the table contents. If not set, the most recent // transaction commit time will be used. Cannot be specified along with - // TransactionId. + // TransactionId . QueryAsOfTime *time.Time // The transaction ID at which to read the table contents. diff --git a/service/glue/api_op_GetTables.go b/service/glue/api_op_GetTables.go index e8d4fb4e126..7fc777ed7fd 100644 --- a/service/glue/api_op_GetTables.go +++ b/service/glue/api_op_GetTables.go @@ -13,7 +13,7 @@ import ( "time" ) -// Retrieves the definitions of some or all of the tables in a given Database. +// Retrieves the definitions of some or all of the tables in a given Database . func (c *Client) GetTables(ctx context.Context, params *GetTablesInput, optFns ...func(*Options)) (*GetTablesOutput, error) { if params == nil { params = &GetTablesInput{} @@ -53,7 +53,7 @@ type GetTablesInput struct { // The time as of when to read the table contents. If not set, the most recent // transaction commit time will be used. Cannot be specified along with - // TransactionId. + // TransactionId . QueryAsOfTime *time.Time // The transaction ID at which to read the table contents. diff --git a/service/glue/api_op_GetUnfilteredPartitionMetadata.go b/service/glue/api_op_GetUnfilteredPartitionMetadata.go index 5ed82853f4b..859493dafba 100644 --- a/service/glue/api_op_GetUnfilteredPartitionMetadata.go +++ b/service/glue/api_op_GetUnfilteredPartitionMetadata.go @@ -13,7 +13,7 @@ import ( // Retrieves partition metadata from the Data Catalog that contains unfiltered // metadata. For IAM authorization, the public IAM action associated with this API -// is glue:GetPartition. +// is glue:GetPartition . func (c *Client) GetUnfilteredPartitionMetadata(ctx context.Context, params *GetUnfilteredPartitionMetadataInput, optFns ...func(*Options)) (*GetUnfilteredPartitionMetadataOutput, error) { if params == nil { params = &GetUnfilteredPartitionMetadataInput{} @@ -67,8 +67,8 @@ type GetUnfilteredPartitionMetadataOutput struct { // A list of column names that the user has been granted access to. AuthorizedColumns []string - // A Boolean value that indicates whether the partition location is registered with - // Lake Formation. + // A Boolean value that indicates whether the partition location is registered + // with Lake Formation. IsRegisteredWithLakeFormation bool // A Partition object containing the partition metadata. diff --git a/service/glue/api_op_GetUnfilteredPartitionsMetadata.go b/service/glue/api_op_GetUnfilteredPartitionsMetadata.go index 7a41c712435..8e7788ce290 100644 --- a/service/glue/api_op_GetUnfilteredPartitionsMetadata.go +++ b/service/glue/api_op_GetUnfilteredPartitionsMetadata.go @@ -14,7 +14,7 @@ import ( // Retrieves partition metadata from the Data Catalog that contains unfiltered // metadata. For IAM authorization, the public IAM action associated with this API -// is glue:GetPartitions. +// is glue:GetPartitions . func (c *Client) GetUnfilteredPartitionsMetadata(ctx context.Context, params *GetUnfilteredPartitionsMetadataInput, optFns ...func(*Options)) (*GetUnfilteredPartitionsMetadataOutput, error) { if params == nil { params = &GetUnfilteredPartitionsMetadataInput{} @@ -75,27 +75,15 @@ type GetUnfilteredPartitionsMetadataInput struct { // right operand; if yes, then the condition becomes true. Example: (a <= b) is // true. AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Logical operators. Supported // Partition Key Types: The following are the supported partition keys. - // - // * - // string - // - // * date - // - // * timestamp - // - // * int - // - // * bigint - // - // * long - // - // * tinyint - // - // * smallint - // - // * - // decimal - // + // - string + // - date + // - timestamp + // - int + // - bigint + // - long + // - tinyint + // - smallint + // - decimal // If an type is encountered that is not valid, an exception is thrown. Expression *string diff --git a/service/glue/api_op_GetUnfilteredTableMetadata.go b/service/glue/api_op_GetUnfilteredTableMetadata.go index 8b054967671..fbeb18485da 100644 --- a/service/glue/api_op_GetUnfilteredTableMetadata.go +++ b/service/glue/api_op_GetUnfilteredTableMetadata.go @@ -13,7 +13,7 @@ import ( // Retrieves table metadata from the Data Catalog that contains unfiltered // metadata. For IAM authorization, the public IAM action associated with this API -// is glue:GetTable. +// is glue:GetTable . func (c *Client) GetUnfilteredTableMetadata(ctx context.Context, params *GetUnfilteredTableMetadataInput, optFns ...func(*Options)) (*GetUnfilteredTableMetadataOutput, error) { if params == nil { params = &GetUnfilteredTableMetadataInput{} @@ -65,8 +65,8 @@ type GetUnfilteredTableMetadataOutput struct { // A list of column row filters. CellFilters []types.ColumnRowFilter - // A Boolean value that indicates whether the partition location is registered with - // Lake Formation. + // A Boolean value that indicates whether the partition location is registered + // with Lake Formation. IsRegisteredWithLakeFormation bool // A Table object containing the table metadata. diff --git a/service/glue/api_op_ListCrawls.go b/service/glue/api_op_ListCrawls.go index f9c3ccbab98..5378f3f9b08 100644 --- a/service/glue/api_op_ListCrawls.go +++ b/service/glue/api_op_ListCrawls.go @@ -11,21 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns all the crawls of a specified crawler. Returns only the crawls that have -// occurred since the launch date of the crawler history feature, and only retains -// up to 12 months of crawls. Older crawls will not be returned. You may use this -// API to: -// -// * Retrive all the crawls of a specified crawler. -// -// * Retrieve all the -// crawls of a specified crawler within a limited count. -// -// * Retrieve all the crawls -// of a specified crawler in a specific time range. -// -// * Retrieve all the crawls of a -// specified crawler with a particular state, crawl ID, or DPU hour value. +// Returns all the crawls of a specified crawler. Returns only the crawls that +// have occurred since the launch date of the crawler history feature, and only +// retains up to 12 months of crawls. Older crawls will not be returned. You may +// use this API to: +// - Retrive all the crawls of a specified crawler. +// - Retrieve all the crawls of a specified crawler within a limited count. +// - Retrieve all the crawls of a specified crawler in a specific time range. +// - Retrieve all the crawls of a specified crawler with a particular state, +// crawl ID, or DPU hour value. func (c *Client) ListCrawls(ctx context.Context, params *ListCrawlsInput, optFns ...func(*Options)) (*ListCrawlsOutput, error) { if params == nil { params = &ListCrawlsInput{} @@ -67,8 +61,8 @@ type ListCrawlsOutput struct { // criteria. Crawls []types.CrawlerHistory - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_ListDevEndpoints.go b/service/glue/api_op_ListDevEndpoints.go index 30955f698d6..18c2fa191a9 100644 --- a/service/glue/api_op_ListDevEndpoints.go +++ b/service/glue/api_op_ListDevEndpoints.go @@ -48,7 +48,7 @@ type ListDevEndpointsInput struct { type ListDevEndpointsOutput struct { - // The names of all the DevEndpoints in the account, or the DevEndpoints with the + // The names of all the DevEndpoint s in the account, or the DevEndpoint s with the // specified tags. DevEndpointNames []string diff --git a/service/glue/api_op_ListJobs.go b/service/glue/api_op_ListJobs.go index 3070a885519..25869b5e5c6 100644 --- a/service/glue/api_op_ListJobs.go +++ b/service/glue/api_op_ListJobs.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the names of all job resources in this Amazon Web Services account, or -// the resources with the specified tag. This operation allows you to see which +// Retrieves the names of all job resources in this Amazon Web Services account, +// or the resources with the specified tag. This operation allows you to see which // resources are available in your account, and their names. This operation takes // the optional Tags field, which you can use as a filter on the response so that // tagged resources can be retrieved as a group. If you choose to use tags diff --git a/service/glue/api_op_ListRegistries.go b/service/glue/api_op_ListRegistries.go index d7ed44d67bb..c0637477255 100644 --- a/service/glue/api_op_ListRegistries.go +++ b/service/glue/api_op_ListRegistries.go @@ -44,8 +44,8 @@ type ListRegistriesInput struct { type ListRegistriesOutput struct { - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // An array of RegistryDetailedListItem objects containing minimal details of each diff --git a/service/glue/api_op_ListSchemaVersions.go b/service/glue/api_op_ListSchemaVersions.go index f75326340e2..af9b26cde06 100644 --- a/service/glue/api_op_ListSchemaVersions.go +++ b/service/glue/api_op_ListSchemaVersions.go @@ -35,13 +35,10 @@ type ListSchemaVersionsInput struct { // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // Either SchemaArn or SchemaName and RegistryName has to be provided. - // - // * - // SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and - // RegistryName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either + // SchemaArn or SchemaName and RegistryName has to be provided. + // - SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName + // and RegistryName has to be provided. // // This member is required. SchemaId *types.SchemaId @@ -58,8 +55,8 @@ type ListSchemaVersionsInput struct { type ListSchemaVersionsOutput struct { - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // An array of SchemaVersionList objects containing details of each schema version. diff --git a/service/glue/api_op_ListSchemas.go b/service/glue/api_op_ListSchemas.go index 69e56b9bd1f..d574b99d49c 100644 --- a/service/glue/api_op_ListSchemas.go +++ b/service/glue/api_op_ListSchemas.go @@ -49,8 +49,8 @@ type ListSchemasInput struct { type ListSchemasOutput struct { - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // An array of SchemaListItem objects containing details of each schema. diff --git a/service/glue/api_op_PutDataCatalogEncryptionSettings.go b/service/glue/api_op_PutDataCatalogEncryptionSettings.go index fb42cdd9faa..e4f2d2d97c5 100644 --- a/service/glue/api_op_PutDataCatalogEncryptionSettings.go +++ b/service/glue/api_op_PutDataCatalogEncryptionSettings.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the security configuration for a specified catalog. After the configuration -// has been set, the specified encryption is applied to every catalog write -// thereafter. +// Sets the security configuration for a specified catalog. After the +// configuration has been set, the specified encryption is applied to every catalog +// write thereafter. func (c *Client) PutDataCatalogEncryptionSettings(ctx context.Context, params *PutDataCatalogEncryptionSettingsInput, optFns ...func(*Options)) (*PutDataCatalogEncryptionSettingsOutput, error) { if params == nil { params = &PutDataCatalogEncryptionSettingsInput{} diff --git a/service/glue/api_op_PutResourcePolicy.go b/service/glue/api_op_PutResourcePolicy.go index b0ef3233c55..c28ee134252 100644 --- a/service/glue/api_op_PutResourcePolicy.go +++ b/service/glue/api_op_PutResourcePolicy.go @@ -34,18 +34,13 @@ type PutResourcePolicyInput struct { // This member is required. PolicyInJson *string - // If 'TRUE', indicates that you are using both methods to grant cross-account + // If 'TRUE' , indicates that you are using both methods to grant cross-account // access to Data Catalog resources: - // - // * By directly updating the resource policy - // with PutResourePolicy - // - // * By using the Grant permissions command on the Amazon - // Web Services Management Console. - // - // Must be set to 'TRUE' if you have already used - // the Management Console to grant cross-account access, otherwise the call fails. - // Default is 'FALSE'. + // - By directly updating the resource policy with PutResourePolicy + // - By using the Grant permissions command on the Amazon Web Services + // Management Console. + // Must be set to 'TRUE' if you have already used the Management Console to grant + // cross-account access, otherwise the call fails. Default is 'FALSE'. EnableHybrid types.EnableHybridValues // A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used @@ -53,9 +48,9 @@ type PutResourcePolicyInput struct { // does not depend on the existence of a policy. PolicyExistsCondition types.ExistCondition - // The hash value returned when the previous policy was set using - // PutResourcePolicy. Its purpose is to prevent concurrent modifications of a - // policy. Do not use this parameter if no previous policy has been set. + // The hash value returned when the previous policy was set using PutResourcePolicy + // . Its purpose is to prevent concurrent modifications of a policy. Do not use + // this parameter if no previous policy has been set. PolicyHashCondition *string // Do not use. For internal use only. diff --git a/service/glue/api_op_PutSchemaVersionMetadata.go b/service/glue/api_op_PutSchemaVersionMetadata.go index 73e89a44c8b..50a89eaacee 100644 --- a/service/glue/api_op_PutSchemaVersionMetadata.go +++ b/service/glue/api_op_PutSchemaVersionMetadata.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Puts the metadata key value pair for a specified schema version ID. A maximum of -// 10 key value pairs will be allowed per schema version. They can be added over +// Puts the metadata key value pair for a specified schema version ID. A maximum +// of 10 key value pairs will be allowed per schema version. They can be added over // one or more calls. func (c *Client) PutSchemaVersionMetadata(ctx context.Context, params *PutSchemaVersionMetadataInput, optFns ...func(*Options)) (*PutSchemaVersionMetadataOutput, error) { if params == nil { diff --git a/service/glue/api_op_QuerySchemaVersionMetadata.go b/service/glue/api_op_QuerySchemaVersionMetadata.go index fbb9c81f105..2a6f2d1cefb 100644 --- a/service/glue/api_op_QuerySchemaVersionMetadata.go +++ b/service/glue/api_op_QuerySchemaVersionMetadata.go @@ -58,8 +58,8 @@ type QuerySchemaVersionMetadataOutput struct { // A map of a metadata key and associated values. MetadataInfoMap map[string]types.MetadataInfo - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // The unique version ID of the schema version. diff --git a/service/glue/api_op_RegisterSchemaVersion.go b/service/glue/api_op_RegisterSchemaVersion.go index 94b24205b65..e5f80e9868d 100644 --- a/service/glue/api_op_RegisterSchemaVersion.go +++ b/service/glue/api_op_RegisterSchemaVersion.go @@ -38,20 +38,17 @@ func (c *Client) RegisterSchemaVersion(ctx context.Context, params *RegisterSche type RegisterSchemaVersionInput struct { - // The schema definition using the DataFormat setting for the SchemaName. + // The schema definition using the DataFormat setting for the SchemaName . // // This member is required. SchemaDefinition *string // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // Either SchemaArn or SchemaName and RegistryName has to be provided. - // - // * - // SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and - // RegistryName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either + // SchemaArn or SchemaName and RegistryName has to be provided. + // - SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName + // and RegistryName has to be provided. // // This member is required. SchemaId *types.SchemaId diff --git a/service/glue/api_op_ResetJobBookmark.go b/service/glue/api_op_ResetJobBookmark.go index d1b233fc654..3607ac87e09 100644 --- a/service/glue/api_op_ResetJobBookmark.go +++ b/service/glue/api_op_ResetJobBookmark.go @@ -13,17 +13,9 @@ import ( // Resets a bookmark entry. For more information about enabling and using job // bookmarks, see: -// -// * Tracking processed data using job bookmarks -// (https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html) -// -// * Job -// parameters used by Glue -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) -// -// * -// Job structure -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) +// - Tracking processed data using job bookmarks (https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html) +// - Job parameters used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) +// - Job structure (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) func (c *Client) ResetJobBookmark(ctx context.Context, params *ResetJobBookmarkInput, optFns ...func(*Options)) (*ResetJobBookmarkOutput, error) { if params == nil { params = &ResetJobBookmarkInput{} diff --git a/service/glue/api_op_SearchTables.go b/service/glue/api_op_SearchTables.go index d092d334cce..91765b27473 100644 --- a/service/glue/api_op_SearchTables.go +++ b/service/glue/api_op_SearchTables.go @@ -12,15 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches a set of tables based on properties in the table metadata as well as on -// the parent database. You can search against text or filter conditions. You can -// only get tables that you have access to based on the security policies defined -// in Lake Formation. You need at least a read-only access to the table for it to -// be returned. If you do not have access to all the columns in the table, these -// columns will not be searched against when returning the list of tables back to -// you. If you have access to the columns but not the data in the columns, those -// columns and the associated metadata for those columns will be included in the -// search. +// Searches a set of tables based on properties in the table metadata as well as +// on the parent database. You can search against text or filter conditions. You +// can only get tables that you have access to based on the security policies +// defined in Lake Formation. You need at least a read-only access to the table for +// it to be returned. If you do not have access to all the columns in the table, +// these columns will not be searched against when returning the list of tables +// back to you. If you have access to the columns but not the data in the columns, +// those columns and the associated metadata for those columns will be included in +// the search. func (c *Client) SearchTables(ctx context.Context, params *SearchTablesInput, optFns ...func(*Options)) (*SearchTablesOutput, error) { if params == nil { params = &SearchTablesInput{} @@ -44,11 +44,11 @@ type SearchTablesInput struct { // A list of key-value pairs, and a comparator used to filter the search results. // Returns all entities matching the predicate. The Comparator member of the // PropertyPredicate struct is used only for time fields, and can be omitted for - // other field types. Also, when comparing string values, such as when Key=Name, a + // other field types. Also, when comparing string values, such as when Key=Name , a // fuzzy match algorithm is used. The Key field (for example, the value of the Name // field) is split on certain punctuation characters, for example, -, :, #, etc. // into tokens. Then each token is exact-match compared with the Value member of - // PropertyPredicate. For example, if Key=Name and Value=link, tables named + // PropertyPredicate . For example, if Key=Name and Value=link , tables named // customer-link and xx-link-yy are returned, but xxlinkyy is not returned. Filters []types.PropertyPredicate @@ -59,13 +59,10 @@ type SearchTablesInput struct { NextToken *string // Allows you to specify that you want to search the tables shared with your - // account. The allowable values are FOREIGN or ALL. - // - // * If set to FOREIGN, will - // search the tables shared with your account. - // - // * If set to ALL, will search the - // tables shared with your account, as well as the tables in yor local account. + // account. The allowable values are FOREIGN or ALL . + // - If set to FOREIGN , will search the tables shared with your account. + // - If set to ALL , will search the tables shared with your account, as well as + // the tables in yor local account. ResourceShareType types.ResourceShareType // A string used for a text search. Specifying a value in quotes filters based on diff --git a/service/glue/api_op_StartCrawler.go b/service/glue/api_op_StartCrawler.go index 059f28943f8..17653f718df 100644 --- a/service/glue/api_op_StartCrawler.go +++ b/service/glue/api_op_StartCrawler.go @@ -11,8 +11,8 @@ import ( ) // Starts a crawl using the specified crawler, regardless of what is scheduled. If -// the crawler is already running, returns a CrawlerRunningException -// (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException). +// the crawler is already running, returns a CrawlerRunningException (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException) +// . func (c *Client) StartCrawler(ctx context.Context, params *StartCrawlerInput, optFns ...func(*Options)) (*StartCrawlerOutput, error) { if params == nil { params = &StartCrawlerInput{} diff --git a/service/glue/api_op_StartCrawlerSchedule.go b/service/glue/api_op_StartCrawlerSchedule.go index 52a23a7c8a0..4982699b07c 100644 --- a/service/glue/api_op_StartCrawlerSchedule.go +++ b/service/glue/api_op_StartCrawlerSchedule.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the schedule state of the specified crawler to SCHEDULED, unless the -// crawler is already running or the schedule state is already SCHEDULED. +// Changes the schedule state of the specified crawler to SCHEDULED , unless the +// crawler is already running or the schedule state is already SCHEDULED . func (c *Client) StartCrawlerSchedule(ctx context.Context, params *StartCrawlerScheduleInput, optFns ...func(*Options)) (*StartCrawlerScheduleOutput, error) { if params == nil { params = &StartCrawlerScheduleInput{} diff --git a/service/glue/api_op_StartDataQualityRuleRecommendationRun.go b/service/glue/api_op_StartDataQualityRuleRecommendationRun.go index 56eac46c487..717a1bb4ede 100644 --- a/service/glue/api_op_StartDataQualityRuleRecommendationRun.go +++ b/service/glue/api_op_StartDataQualityRuleRecommendationRun.go @@ -53,8 +53,8 @@ type StartDataQualityRuleRecommendationRunInput struct { NumberOfWorkers *int32 // The timeout for a run in minutes. This is the maximum time that a run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). + // consume resources before it is terminated and enters TIMEOUT status. The + // default is 2,880 minutes (48 hours). Timeout *int32 noSmithyDocumentSerde diff --git a/service/glue/api_op_StartDataQualityRulesetEvaluationRun.go b/service/glue/api_op_StartDataQualityRulesetEvaluationRun.go index 9b9121901f7..ee14c04bed7 100644 --- a/service/glue/api_op_StartDataQualityRulesetEvaluationRun.go +++ b/service/glue/api_op_StartDataQualityRulesetEvaluationRun.go @@ -58,8 +58,8 @@ type StartDataQualityRulesetEvaluationRunInput struct { NumberOfWorkers *int32 // The timeout for a run in minutes. This is the maximum time that a run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). + // consume resources before it is terminated and enters TIMEOUT status. The + // default is 2,880 minutes (48 hours). Timeout *int32 noSmithyDocumentSerde diff --git a/service/glue/api_op_StartExportLabelsTaskRun.go b/service/glue/api_op_StartExportLabelsTaskRun.go index 3addf173c08..a68a53261ff 100644 --- a/service/glue/api_op_StartExportLabelsTaskRun.go +++ b/service/glue/api_op_StartExportLabelsTaskRun.go @@ -17,7 +17,7 @@ import ( // when you want to remove or change labels that were previously submitted as // truth. This API operation accepts the TransformId whose labels you want to // export and an Amazon Simple Storage Service (Amazon S3) path to export the -// labels to. The operation returns a TaskRunId. You can check on the status of +// labels to. The operation returns a TaskRunId . You can check on the status of // your task run by calling the GetMLTaskRun API. func (c *Client) StartExportLabelsTaskRun(ctx context.Context, params *StartExportLabelsTaskRunInput, optFns ...func(*Options)) (*StartExportLabelsTaskRunOutput, error) { if params == nil { diff --git a/service/glue/api_op_StartImportLabelsTaskRun.go b/service/glue/api_op_StartImportLabelsTaskRun.go index 84c3f827793..1c4e079996b 100644 --- a/service/glue/api_op_StartImportLabelsTaskRun.go +++ b/service/glue/api_op_StartImportLabelsTaskRun.go @@ -10,18 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables you to provide additional labels (examples of truth) to be used to teach -// the machine learning transform and improve its quality. This API operation is -// generally used as part of the active learning workflow that starts with the +// Enables you to provide additional labels (examples of truth) to be used to +// teach the machine learning transform and improve its quality. This API operation +// is generally used as part of the active learning workflow that starts with the // StartMLLabelingSetGenerationTaskRun call and that ultimately results in // improving the quality of your machine learning transform. After the // StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have // generated a series of questions for humans to answer. (Answering these questions // is often called 'labeling' in the machine learning workflows). In the case of -// the FindMatches transform, these questions are of the form, “What is the correct -// way to group these rows together into groups composed entirely of matching -// records?” After the labeling process is finished, users upload their -// answers/labels with a call to StartImportLabelsTaskRun. After +// the FindMatches transform, these questions are of the form, “What is the +// correct way to group these rows together into groups composed entirely of +// matching records?” After the labeling process is finished, users upload their +// answers/labels with a call to StartImportLabelsTaskRun . After // StartImportLabelsTaskRun finishes, all future runs of the machine learning // transform use the new and improved labels and perform a higher-quality // transformation. By default, StartMLLabelingSetGenerationTaskRun continually diff --git a/service/glue/api_op_StartJobRun.go b/service/glue/api_op_StartJobRun.go index c4e7887d957..f4779feda4b 100644 --- a/service/glue/api_op_StartJobRun.go +++ b/service/glue/api_op_StartJobRun.go @@ -38,7 +38,7 @@ type StartJobRunInput struct { // processing units (DPUs) to allocate to this JobRun. You can allocate a minimum // of 2 DPUs; the default is 10. A DPU is a relative measure of processing power // that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/). + // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/) . // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -50,11 +50,9 @@ type StartJobRunInput struct { // arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other // secret management mechanism if you intend to keep them within the Job. For // information about how to specify and consume your own Job arguments, see the - // Calling Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. Arguments map[string]string @@ -63,8 +61,8 @@ type StartJobRunInput struct { // fast job startup and dedicated resources. The flexible execution class is // appropriate for time-insensitive jobs whose start and completion times may vary. // Only jobs with Glue version 3.0 and above and command type glueetl will be - // allowed to set ExecutionClass to FLEX. The flexible execution class is available - // for Spark jobs. + // allowed to set ExecutionClass to FLEX . The flexible execution class is + // available for Spark jobs. ExecutionClass types.ExecutionClass // The ID of a previous JobRun to retry. @@ -73,18 +71,15 @@ type StartJobRunInput struct { // The number of Glue data processing units (DPUs) that can be allocated when this // job runs. A DPU is a relative measure of processing power that consists of 4 // vCPUs of compute capacity and 16 GB of memory. For more information, see the - // Glue pricing page (https://aws.amazon.com/glue/pricing/). Do not set Max - // Capacity if using WorkerType and NumberOfWorkers. The value that can be - // allocated for MaxCapacity depends on whether you are running a Python shell job, - // or an Apache Spark ETL job: - // - // * When you specify a Python shell job - // (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The - // default is 0.0625 DPU. - // - // * When you specify an Apache Spark ETL job - // (JobCommand.Name="glueetl"), you can allocate a minimum of 2 DPUs. The default - // is 10 DPUs. This job type cannot have a fractional DPU allocation. + // Glue pricing page (https://aws.amazon.com/glue/pricing/) . Do not set Max + // Capacity if using WorkerType and NumberOfWorkers . The value that can be + // allocated for MaxCapacity depends on whether you are running a Python shell + // job, or an Apache Spark ETL job: + // - When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you + // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. + // - When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you + // can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot + // have a fractional DPU allocation. MaxCapacity *float64 // Specifies configuration properties of a job run notification. @@ -103,24 +98,18 @@ type StartJobRunInput struct { // timeout. The default for non-streaming jobs is 2,880 minutes (48 hours). Timeout *int32 - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a - // 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker type, each worker - // provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. - // - // * - // For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of - // memory, 64 GB disk), and provides 1 executor per worker. We recommend this - // worker type for low volume streaming jobs. This worker type is only available - // for Glue version 3.0 streaming jobs. + // The type of predefined worker that is allocated when a job runs. Accepts a + // value of Standard, G.1X, G.2X, or G.025X. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType types.WorkerType noSmithyDocumentSerde diff --git a/service/glue/api_op_StartMLEvaluationTaskRun.go b/service/glue/api_op_StartMLEvaluationTaskRun.go index b37f446bb5c..6a0c6101a57 100644 --- a/service/glue/api_op_StartMLEvaluationTaskRun.go +++ b/service/glue/api_op_StartMLEvaluationTaskRun.go @@ -14,7 +14,7 @@ import ( // sets as examples of truth, Glue machine learning uses some of those examples to // learn from them. The rest of the labels are used as a test to estimate quality. // Returns a unique identifier for the run. You can call GetMLTaskRun to get more -// information about the stats of the EvaluationTaskRun. +// information about the stats of the EvaluationTaskRun . func (c *Client) StartMLEvaluationTaskRun(ctx context.Context, params *StartMLEvaluationTaskRunInput, optFns ...func(*Options)) (*StartMLEvaluationTaskRunOutput, error) { if params == nil { params = &StartMLEvaluationTaskRunInput{} diff --git a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go index effa0449bca..6b5df60be1e 100644 --- a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go +++ b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go @@ -17,9 +17,9 @@ import ( // FindMatches transform, these questions are of the form, “What is the correct way // to group these rows together into groups composed entirely of matching records?” // After the labeling process is finished, you can upload your labels with a call -// to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future -// runs of the machine learning transform will use the new and improved labels and -// perform a higher-quality transformation. +// to StartImportLabelsTaskRun . After StartImportLabelsTaskRun finishes, all +// future runs of the machine learning transform will use the new and improved +// labels and perform a higher-quality transformation. func (c *Client) StartMLLabelingSetGenerationTaskRun(ctx context.Context, params *StartMLLabelingSetGenerationTaskRunInput, optFns ...func(*Options)) (*StartMLLabelingSetGenerationTaskRunOutput, error) { if params == nil { params = &StartMLLabelingSetGenerationTaskRunInput{} diff --git a/service/glue/api_op_StartTrigger.go b/service/glue/api_op_StartTrigger.go index 896332be461..16187e263fd 100644 --- a/service/glue/api_op_StartTrigger.go +++ b/service/glue/api_op_StartTrigger.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an existing trigger. See Triggering Jobs -// (https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) for information -// about how different types of trigger are started. +// Starts an existing trigger. See Triggering Jobs (https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) +// for information about how different types of trigger are started. func (c *Client) StartTrigger(ctx context.Context, params *StartTriggerInput, optFns ...func(*Options)) (*StartTriggerOutput, error) { if params == nil { params = &StartTriggerInput{} diff --git a/service/glue/api_op_StopCrawlerSchedule.go b/service/glue/api_op_StopCrawlerSchedule.go index c7c291e02ee..48bd4501f1a 100644 --- a/service/glue/api_op_StopCrawlerSchedule.go +++ b/service/glue/api_op_StopCrawlerSchedule.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not +// Sets the schedule state of the specified crawler to NOT_SCHEDULED , but does not // stop the crawler if it is already running. func (c *Client) StopCrawlerSchedule(ctx context.Context, params *StopCrawlerScheduleInput, optFns ...func(*Options)) (*StopCrawlerScheduleOutput, error) { if params == nil { diff --git a/service/glue/api_op_TagResource.go b/service/glue/api_op_TagResource.go index 4f87afdb752..de7ccc991ba 100644 --- a/service/glue/api_op_TagResource.go +++ b/service/glue/api_op_TagResource.go @@ -12,8 +12,8 @@ import ( // Adds tags to a resource. A tag is a label you can assign to an Amazon Web // Services resource. In Glue, you can tag only certain resources. For information -// about what resources you can tag, see Amazon Web Services Tags in Glue -// (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html). +// about what resources you can tag, see Amazon Web Services Tags in Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -32,8 +32,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The ARN of the Glue resource to which to add the tags. For more information - // about Glue resource ARNs, see the Glue ARN string pattern - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id). + // about Glue resource ARNs, see the Glue ARN string pattern (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id) + // . // // This member is required. ResourceArn *string diff --git a/service/glue/api_op_UpdateClassifier.go b/service/glue/api_op_UpdateClassifier.go index 4bfa6425c07..6068823bd7a 100644 --- a/service/glue/api_op_UpdateClassifier.go +++ b/service/glue/api_op_UpdateClassifier.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a -// JsonClassifier, or a CsvClassifier, depending on which field is present). +// Modifies an existing classifier (a GrokClassifier , an XMLClassifier , a +// JsonClassifier , or a CsvClassifier , depending on which field is present). func (c *Client) UpdateClassifier(ctx context.Context, params *UpdateClassifierInput, optFns ...func(*Options)) (*UpdateClassifierOutput, error) { if params == nil { params = &UpdateClassifierInput{} diff --git a/service/glue/api_op_UpdateColumnStatisticsForPartition.go b/service/glue/api_op_UpdateColumnStatisticsForPartition.go index 85048a90834..84434a89923 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForPartition.go +++ b/service/glue/api_op_UpdateColumnStatisticsForPartition.go @@ -12,7 +12,7 @@ import ( ) // Creates or updates partition statistics of columns. The Identity and Access -// Management (IAM) permission required for this operation is UpdatePartition. +// Management (IAM) permission required for this operation is UpdatePartition . func (c *Client) UpdateColumnStatisticsForPartition(ctx context.Context, params *UpdateColumnStatisticsForPartitionInput, optFns ...func(*Options)) (*UpdateColumnStatisticsForPartitionOutput, error) { if params == nil { params = &UpdateColumnStatisticsForPartitionInput{} diff --git a/service/glue/api_op_UpdateColumnStatisticsForTable.go b/service/glue/api_op_UpdateColumnStatisticsForTable.go index 28054cab13b..6a328ea108f 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForTable.go +++ b/service/glue/api_op_UpdateColumnStatisticsForTable.go @@ -12,7 +12,7 @@ import ( ) // Creates or updates table statistics of columns. The Identity and Access -// Management (IAM) permission required for this operation is UpdateTable. +// Management (IAM) permission required for this operation is UpdateTable . func (c *Client) UpdateColumnStatisticsForTable(ctx context.Context, params *UpdateColumnStatisticsForTableInput, optFns ...func(*Options)) (*UpdateColumnStatisticsForTableOutput, error) { if params == nil { params = &UpdateColumnStatisticsForTableInput{} diff --git a/service/glue/api_op_UpdateConnection.go b/service/glue/api_op_UpdateConnection.go index 234bea93694..d06e45a84eb 100644 --- a/service/glue/api_op_UpdateConnection.go +++ b/service/glue/api_op_UpdateConnection.go @@ -39,8 +39,8 @@ type UpdateConnectionInput struct { // This member is required. Name *string - // The ID of the Data Catalog in which the connection resides. If none is provided, - // the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog in which the connection resides. If none is + // provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_UpdateCrawler.go b/service/glue/api_op_UpdateCrawler.go index a4d2d4a73bd..2f76968d824 100644 --- a/service/glue/api_op_UpdateCrawler.go +++ b/service/glue/api_op_UpdateCrawler.go @@ -42,15 +42,15 @@ type UpdateCrawlerInput struct { // Crawler configuration information. This versioned JSON string allows users to // specify aspects of a crawler's behavior. For more information, see Setting - // crawler configuration options - // (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // crawler configuration options (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html) + // . Configuration *string // The name of the SecurityConfiguration structure to be used by this crawler. CrawlerSecurityConfiguration *string // The Glue database where results are stored, such as: - // arn:aws:daylight:us-east-1::database/sometable/*. + // arn:aws:daylight:us-east-1::database/sometable/* . DatabaseName *string // A description of the new crawler. @@ -71,10 +71,9 @@ type UpdateCrawlerInput struct { Role *string // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . Schedule *string // The policy for the crawler's update and deletion behavior. diff --git a/service/glue/api_op_UpdateCrawlerSchedule.go b/service/glue/api_op_UpdateCrawlerSchedule.go index d8010503e1c..9d64c4b3feb 100644 --- a/service/glue/api_op_UpdateCrawlerSchedule.go +++ b/service/glue/api_op_UpdateCrawlerSchedule.go @@ -34,10 +34,9 @@ type UpdateCrawlerScheduleInput struct { CrawlerName *string // The updated cron expression used to specify the schedule (see Time-Based - // Schedules for Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Schedules for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . Schedule *string noSmithyDocumentSerde diff --git a/service/glue/api_op_UpdateDataQualityRuleset.go b/service/glue/api_op_UpdateDataQualityRuleset.go index 6e4db220327..f9113cc4a8c 100644 --- a/service/glue/api_op_UpdateDataQualityRuleset.go +++ b/service/glue/api_op_UpdateDataQualityRuleset.go @@ -36,8 +36,8 @@ type UpdateDataQualityRulesetInput struct { // A description of the ruleset. Description *string - // A Data Quality Definition Language (DQDL) ruleset. For more information, see the - // Glue developer guide. + // A Data Quality Definition Language (DQDL) ruleset. For more information, see + // the Glue developer guide. Ruleset *string noSmithyDocumentSerde @@ -51,8 +51,8 @@ type UpdateDataQualityRulesetOutput struct { // The name of the data quality ruleset. Name *string - // A Data Quality Definition Language (DQDL) ruleset. For more information, see the - // Glue developer guide. + // A Data Quality Definition Language (DQDL) ruleset. For more information, see + // the Glue developer guide. Ruleset *string // Metadata pertaining to the operation's result. diff --git a/service/glue/api_op_UpdateDatabase.go b/service/glue/api_op_UpdateDatabase.go index 912456b3924..f94d37f17bf 100644 --- a/service/glue/api_op_UpdateDatabase.go +++ b/service/glue/api_op_UpdateDatabase.go @@ -29,8 +29,8 @@ func (c *Client) UpdateDatabase(ctx context.Context, params *UpdateDatabaseInput type UpdateDatabaseInput struct { - // A DatabaseInput object specifying the new definition of the metadata database in - // the catalog. + // A DatabaseInput object specifying the new definition of the metadata database + // in the catalog. // // This member is required. DatabaseInput *types.DatabaseInput diff --git a/service/glue/api_op_UpdateDevEndpoint.go b/service/glue/api_op_UpdateDevEndpoint.go index 8fe9b97d6d6..7010b0d9654 100644 --- a/service/glue/api_op_UpdateDevEndpoint.go +++ b/service/glue/api_op_UpdateDevEndpoint.go @@ -35,27 +35,24 @@ type UpdateDevEndpointInput struct { EndpointName *string // The map of arguments to add the map of arguments used to configure the - // DevEndpoint. Valid arguments are: - // - // * "--enable-glue-datacatalog": "" - // - // You can - // specify a version of Python support for development endpoints by using the - // Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no - // arguments are provided, the version defaults to Python 2. + // DevEndpoint . Valid arguments are: + // - "--enable-glue-datacatalog": "" + // You can specify a version of Python support for development endpoints by using + // the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If + // no arguments are provided, the version defaults to Python 2. AddArguments map[string]string // The list of public keys for the DevEndpoint to use. AddPublicKeys []string - // Custom Python or Java libraries to be loaded in the DevEndpoint. + // Custom Python or Java libraries to be loaded in the DevEndpoint . CustomLibraries *types.DevEndpointCustomLibraries // The list of argument keys to be deleted from the map of arguments used to - // configure the DevEndpoint. + // configure the DevEndpoint . DeleteArguments []string - // The list of public keys to be deleted from the DevEndpoint. + // The list of public keys to be deleted from the DevEndpoint . DeletePublicKeys []string // The public key for the DevEndpoint to use. diff --git a/service/glue/api_op_UpdateMLTransform.go b/service/glue/api_op_UpdateMLTransform.go index 64c9fe81604..d172f039c92 100644 --- a/service/glue/api_op_UpdateMLTransform.go +++ b/service/glue/api_op_UpdateMLTransform.go @@ -43,19 +43,18 @@ type UpdateMLTransformInput struct { // This value determines which version of Glue this machine learning transform is // compatible with. Glue 1.0 is recommended for most customers. If the value is not - // set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue - // Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // set, the Glue compatibility defaults to Glue 0.9. For more information, see + // Glue Versions (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) // in the developer guide. GlueVersion *string // The number of Glue data processing units (DPUs) that are allocated to task runs // for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). When the WorkerType field is set to - // a value other than Standard, the MaxCapacity field is set automatically and - // becomes read-only. + // compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . When the WorkerType field + // is set to a value other than Standard , the MaxCapacity field is set + // automatically and becomes read-only. MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -69,8 +68,8 @@ type UpdateMLTransformInput struct { // runs. NumberOfWorkers *int32 - // The configuration parameters that are specific to the transform type (algorithm) - // used. Conditionally dependent on the transform type. + // The configuration parameters that are specific to the transform type + // (algorithm) used. Conditionally dependent on the transform type. Parameters *types.TransformParameters // The name or Amazon Resource Name (ARN) of the IAM role with the required @@ -84,16 +83,12 @@ type UpdateMLTransformInput struct { // The type of predefined worker that is allocated when this task runs. Accepts a // value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a - // 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker type, each worker - // provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. WorkerType types.WorkerType noSmithyDocumentSerde diff --git a/service/glue/api_op_UpdatePartition.go b/service/glue/api_op_UpdatePartition.go index 5a473627ce0..6867123b0b9 100644 --- a/service/glue/api_op_UpdatePartition.go +++ b/service/glue/api_op_UpdatePartition.go @@ -51,8 +51,8 @@ type UpdatePartitionInput struct { // This member is required. TableName *string - // The ID of the Data Catalog where the partition to be updated resides. If none is - // provided, the Amazon Web Services account ID is used by default. + // The ID of the Data Catalog where the partition to be updated resides. If none + // is provided, the Amazon Web Services account ID is used by default. CatalogId *string noSmithyDocumentSerde diff --git a/service/glue/api_op_UpdateSchema.go b/service/glue/api_op_UpdateSchema.go index 2a8cd64d6bd..066506fe1a4 100644 --- a/service/glue/api_op_UpdateSchema.go +++ b/service/glue/api_op_UpdateSchema.go @@ -39,12 +39,10 @@ type UpdateSchemaInput struct { // This is a wrapper structure to contain schema identity fields. The structure // contains: - // - // * SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. - // One of SchemaArn or SchemaName has to be provided. - // - // * SchemaId$SchemaName: The - // name of the schema. One of SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of + // SchemaArn or SchemaName has to be provided. + // - SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName + // has to be provided. // // This member is required. SchemaId *types.SchemaId diff --git a/service/glue/api_op_UpdateTable.go b/service/glue/api_op_UpdateTable.go index 4088969410f..b8d088d45df 100644 --- a/service/glue/api_op_UpdateTable.go +++ b/service/glue/api_op_UpdateTable.go @@ -45,8 +45,8 @@ type UpdateTableInput struct { CatalogId *string // By default, UpdateTable always creates an archived version of the table before - // updating it. However, if skipArchive is set to true, UpdateTable does not create - // the archived version. + // updating it. However, if skipArchive is set to true, UpdateTable does not + // create the archived version. SkipArchive *bool // The transaction ID at which to update the table contents. diff --git a/service/glue/types/enums.go b/service/glue/types/enums.go index 9bae8d2f84b..b470f13f229 100644 --- a/service/glue/types/enums.go +++ b/service/glue/types/enums.go @@ -122,8 +122,8 @@ const ( CatalogEncryptionModeSsekms CatalogEncryptionMode = "SSE-KMS" ) -// Values returns all known values for CatalogEncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CatalogEncryptionMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CatalogEncryptionMode) Values() []CatalogEncryptionMode { return []CatalogEncryptionMode{ @@ -140,9 +140,9 @@ const ( CloudWatchEncryptionModeSsekms CloudWatchEncryptionMode = "SSE-KMS" ) -// Values returns all known values for CloudWatchEncryptionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CloudWatchEncryptionMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchEncryptionMode) Values() []CloudWatchEncryptionMode { return []CloudWatchEncryptionMode{ "DISABLED", @@ -286,8 +286,8 @@ const ( ConnectionPropertyKeyConnectorClassName ConnectionPropertyKey = "CONNECTOR_CLASS_NAME" ) -// Values returns all known values for ConnectionPropertyKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ConnectionPropertyKey. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ConnectionPropertyKey) Values() []ConnectionPropertyKey { return []ConnectionPropertyKey{ @@ -401,9 +401,9 @@ const ( CrawlerStateStopping CrawlerState = "STOPPING" ) -// Values returns all known values for CrawlerState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CrawlerState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CrawlerState) Values() []CrawlerState { return []CrawlerState{ "READY", @@ -544,9 +544,9 @@ const ( DQStopJobOnFailureTimingAfterDataLoad DQStopJobOnFailureTiming = "AfterDataLoad" ) -// Values returns all known values for DQStopJobOnFailureTiming. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DQStopJobOnFailureTiming. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DQStopJobOnFailureTiming) Values() []DQStopJobOnFailureTiming { return []DQStopJobOnFailureTiming{ "Immediate", @@ -663,9 +663,9 @@ const ( FieldNameDpuHour FieldName = "DPU_HOUR" ) -// Values returns all known values for FieldName. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FieldName. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FieldName) Values() []FieldName { return []FieldName{ "CRAWL_ID", @@ -684,8 +684,8 @@ const ( FilterLogicalOperatorOr FilterLogicalOperator = "OR" ) -// Values returns all known values for FilterLogicalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FilterLogicalOperator. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FilterLogicalOperator) Values() []FilterLogicalOperator { return []FilterLogicalOperator{ @@ -891,9 +891,9 @@ const ( JDBCDataTypeVarchar JDBCDataType = "VARCHAR" ) -// Values returns all known values for JDBCDataType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for JDBCDataType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (JDBCDataType) Values() []JDBCDataType { return []JDBCDataType{ "ARRAY", @@ -1156,9 +1156,9 @@ const ( ParamTypeNull ParamType = "null" ) -// Values returns all known values for ParamType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ParamType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ParamType) Values() []ParamType { return []ParamType{ "str", @@ -1319,9 +1319,9 @@ const ( QuoteCharDisabled QuoteChar = "disabled" ) -// Values returns all known values for QuoteChar. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for QuoteChar. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (QuoteChar) Values() []QuoteChar { return []QuoteChar{ "quote", @@ -1398,9 +1398,9 @@ const ( ResourceTypeArchive ResourceType = "ARCHIVE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "JAR", @@ -1474,9 +1474,9 @@ const ( SchemaStatusDeleting SchemaStatus = "DELETING" ) -// Values returns all known values for SchemaStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SchemaStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SchemaStatus) Values() []SchemaStatus { return []SchemaStatus{ "AVAILABLE", @@ -1518,9 +1518,9 @@ const ( SeparatorTab Separator = "tab" ) -// Values returns all known values for Separator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Separator. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Separator) Values() []Separator { return []Separator{ "comma", @@ -1619,8 +1619,8 @@ const ( SourceControlProviderAwsCodeCommit SourceControlProvider = "AWS_CODE_COMMIT" ) -// Values returns all known values for SourceControlProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SourceControlProvider. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SourceControlProvider) Values() []SourceControlProvider { return []SourceControlProvider{ @@ -1688,9 +1688,9 @@ const ( TargetFormatDelta TargetFormat = "delta" ) -// Values returns all known values for TargetFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetFormat) Values() []TargetFormat { return []TargetFormat{ "json", @@ -1712,8 +1712,8 @@ const ( TaskRunSortColumnTypeStarted TaskRunSortColumnType = "STARTED" ) -// Values returns all known values for TaskRunSortColumnType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TaskRunSortColumnType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TaskRunSortColumnType) Values() []TaskRunSortColumnType { return []TaskRunSortColumnType{ @@ -1849,9 +1849,9 @@ const ( TriggerStateUpdating TriggerState = "UPDATING" ) -// Values returns all known values for TriggerState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TriggerState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TriggerState) Values() []TriggerState { return []TriggerState{ "CREATING", @@ -1895,9 +1895,9 @@ const ( UnionTypeDistinct UnionType = "DISTINCT" ) -// Values returns all known values for UnionType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for UnionType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (UnionType) Values() []UnionType { return []UnionType{ "ALL", @@ -1931,8 +1931,8 @@ const ( UpdateCatalogBehaviorLog UpdateCatalogBehavior = "LOG" ) -// Values returns all known values for UpdateCatalogBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for UpdateCatalogBehavior. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (UpdateCatalogBehavior) Values() []UpdateCatalogBehavior { return []UpdateCatalogBehavior{ diff --git a/service/glue/types/types.go b/service/glue/types/types.go index 808c5ea1d31..d2b76393473 100644 --- a/service/glue/types/types.go +++ b/service/glue/types/types.go @@ -14,11 +14,9 @@ type Action struct { // the default arguments set in the job definition itself. You can specify // arguments here that your own job-execution script consumes, as well as arguments // that Glue itself consumes. For information about how to specify and consume your - // own Job arguments, see the Calling Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // own Job arguments, see the Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. Arguments map[string]string @@ -35,9 +33,9 @@ type Action struct { SecurityConfiguration *string // The JobRun timeout in minutes. This is the maximum time that a job run can - // consume resources before it is terminated and enters TIMEOUT status. The default - // is 2,880 minutes (48 hours). This overrides the timeout value set in the parent - // job. + // consume resources before it is terminated and enters TIMEOUT status. The + // default is 2,880 minutes (48 hours). This overrides the timeout value set in the + // parent job. Timeout *int32 noSmithyDocumentSerde @@ -122,8 +120,8 @@ type AthenaConnectorSource struct { // This member is required. ConnectionName *string - // The type of connection, such as marketplace.athena or custom.athena, designating - // a connection to an Amazon Athena data store. + // The type of connection, such as marketplace.athena or custom.athena, + // designating a connection to an Amazon Athena data store. // // This member is required. ConnectionType *string @@ -140,7 +138,7 @@ type AthenaConnectorSource struct { Name *string // The name of the Cloudwatch log group to read from. For example, - // /aws-glue/jobs/output. + // /aws-glue/jobs/output . // // This member is required. SchemaName *string @@ -174,26 +172,17 @@ type AuditContext struct { // failed and provide a limited number of partitions in the response, so that you // can fix the partitions at fault and try registering the index again. The most // common set of errors that can occur are categorized as follows: -// -// * -// EncryptedPartitionError: The partitions are encrypted. -// -// * -// InvalidPartitionTypeDataError: The partition value doesn't match the data type -// for that partition column. -// -// * MissingPartitionValueError: The partitions are -// encrypted. -// -// * UnsupportedPartitionCharacterError: Characters inside the -// partition value are not supported. For example: U+0000 , U+0001, U+0002. -// -// * -// InternalError: Any error which does not belong to other error codes. +// - EncryptedPartitionError: The partitions are encrypted. +// - InvalidPartitionTypeDataError: The partition value doesn't match the data +// type for that partition column. +// - MissingPartitionValueError: The partitions are encrypted. +// - UnsupportedPartitionCharacterError: Characters inside the partition value +// are not supported. For example: U+0000 , U+0001, U+0002. +// - InternalError: Any error which does not belong to other error codes. type BackfillError struct { - // The error code for an error that occurred when registering partition indexes for - // an existing table. + // The error code for an error that occurred when registering partition indexes + // for an existing table. Code BackfillErrorCode // A list of a limited number of partitions in the response. @@ -245,7 +234,7 @@ type BatchStopJobRunError struct { noSmithyDocumentSerde } -// Records a successful request to stop a specified JobRun. +// Records a successful request to stop a specified JobRun . type BatchStopJobRunSuccessfulSubmission struct { // The name of the job definition used in the job run that was stopped. @@ -341,17 +330,10 @@ type Blueprint struct { ParameterSpec *string // The status of the blueprint registration. - // - // * Creating — The blueprint - // registration is in progress. - // - // * Active — The blueprint has been successfully - // registered. - // - // * Updating — An update to the blueprint registration is in - // progress. - // - // * Failed — The blueprint registration failed. + // - Creating — The blueprint registration is in progress. + // - Active — The blueprint has been successfully registered. + // - Updating — An update to the blueprint registration is in progress. + // - Failed — The blueprint registration failed. Status BlueprintStatus noSmithyDocumentSerde @@ -383,7 +365,7 @@ type BlueprintRun struct { // The blueprint parameters as a string. You will have to provide a value for each // key that is required from the parameter spec that is defined in the - // Blueprint$ParameterSpec. + // Blueprint$ParameterSpec . Parameters *string // The role ARN. This role will be assumed by the Glue service and will be used to @@ -402,17 +384,10 @@ type BlueprintRun struct { StartedOn *time.Time // The state of the blueprint run. Possible values are: - // - // * Running — The blueprint - // run is in progress. - // - // * Succeeded — The blueprint run completed successfully. - // - // * - // Failed — The blueprint run failed and rollback is complete. - // - // * Rolling Back — - // The blueprint run failed and rollback is in progress. + // - Running — The blueprint run is in progress. + // - Succeeded — The blueprint run completed successfully. + // - Failed — The blueprint run failed and rollback is complete. + // - Rolling Back — The blueprint run failed and rollback is in progress. State BlueprintRunState // The name of a workflow that is created as a result of a successful blueprint @@ -647,10 +622,10 @@ type CatalogTarget struct { ConnectionName *string // A valid Amazon dead-letter SQS ARN. For example, - // arn:aws:sqs:region:account:deadLetterQueue. + // arn:aws:sqs:region:account:deadLetterQueue . DlqEventQueueArn *string - // A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs. + // A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs . EventQueueArn *string noSmithyDocumentSerde @@ -658,8 +633,8 @@ type CatalogTarget struct { // Classifiers are triggered during a crawl task. A classifier checks whether a // given file is in a format it can handle. If it is, the classifier creates a -// schema in the form of a StructType object that matches that data format. You can -// use the standard classifiers that Glue provides, or you can write your own +// schema in the form of a StructType object that matches that data format. You +// can use the standard classifiers that Glue provides, or you can write your own // classifiers to best categorize your data sources and specify the appropriate // schemas to use for them. A classifier can be a grok classifier, an XML // classifier, a JSON classifier, or a custom CSV classifier, as specified in one @@ -669,7 +644,7 @@ type Classifier struct { // A classifier for comma-separated values (CSV). CsvClassifier *CsvClassifier - // A classifier that uses grok. + // A classifier that uses grok . GrokClassifier *GrokClassifier // A classifier for JSON content. @@ -746,9 +721,9 @@ type CodeGenConfigurationNode struct { // Specifies a transform that chooses the data property keys that you want to drop. DropFields *DropFields - // Specifies a transform that removes columns from the dataset if all values in the - // column are 'null'. By default, Glue Studio will recognize null objects, but some - // values such as empty strings, strings that are "null", -1 integers or other + // Specifies a transform that removes columns from the dataset if all values in + // the column are 'null'. By default, Glue Studio will recognize null objects, but + // some values such as empty strings, strings that are "null", -1 integers or other // placeholders such as zeros, are not automatically recognized as nulls. DropNullFields *DropNullFields @@ -886,7 +861,7 @@ type CodeGenConfigurationNode struct { SelectFields *SelectFields // Specifies a transform that chooses one DynamicFrame from a collection of - // DynamicFrames. The output is the selected DynamicFrame + // DynamicFrames . The output is the selected DynamicFrame SelectFromCollection *SelectFromCollection // Specifies a connector to an Apache Spark data source. @@ -896,15 +871,15 @@ type CodeGenConfigurationNode struct { SparkConnectorTarget *SparkConnectorTarget // Specifies a transform where you enter a SQL query using Spark SQL syntax to - // transform the data. The output is a single DynamicFrame. + // transform the data. The output is a single DynamicFrame . SparkSQL *SparkSQL // Specifies a transform that writes samples of the data to an Amazon S3 bucket. Spigot *Spigot - // Specifies a transform that splits data property keys into two DynamicFrames. The - // output is a collection of DynamicFrames: one with selected data property keys, - // and one with the remaining data property keys. + // Specifies a transform that splits data property keys into two DynamicFrames . + // The output is a collection of DynamicFrames : one with selected data property + // keys, and one with the remaining data property keys. SplitFields *SplitFields // Specifies a transform that combines the rows from two or more datasets into a @@ -976,10 +951,10 @@ type CodeGenNodeArg struct { noSmithyDocumentSerde } -// A column in a Table. +// A column in a Table . type Column struct { - // The name of the Column. + // The name of the Column . // // This member is required. Name *string @@ -990,7 +965,7 @@ type Column struct { // These key-value pairs define properties associated with the column. Parameters map[string]string - // The data type of the Column. + // The data type of the Column . Type *string noSmithyDocumentSerde @@ -1008,9 +983,10 @@ type ColumnError struct { noSmithyDocumentSerde } -// A structure containing the column name and column importance score for a column. -// Column importance helps you understand how columns contribute to your model, by -// identifying which columns in your records are more important than others. +// A structure containing the column name and column importance score for a +// column. Column importance helps you understand how columns contribute to your +// model, by identifying which columns in your records are more important than +// others. type ColumnImportance struct { // The name of a column. @@ -1124,16 +1100,16 @@ type Condition struct { LogicalOperator LogicalOperator // The condition state. Currently, the only job states that a trigger can listen - // for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a - // trigger can listen for are SUCCEEDED, FAILED, and CANCELLED. + // for are SUCCEEDED , STOPPED , FAILED , and TIMEOUT . The only crawler states + // that a trigger can listen for are SUCCEEDED , FAILED , and CANCELLED . State JobRunState noSmithyDocumentSerde } // The confusion matrix shows you what your transform is predicting accurately and -// what types of errors it is making. For more information, see Confusion matrix -// (https://en.wikipedia.org/wiki/Confusion_matrix) in Wikipedia. +// what types of errors it is making. For more information, see Confusion matrix (https://en.wikipedia.org/wiki/Confusion_matrix) +// in Wikipedia. type ConfusionMatrix struct { // The number of matches in the data that the transform didn't find, in the @@ -1159,157 +1135,96 @@ type ConfusionMatrix struct { type Connection struct { // These key-value pairs define parameters for the connection: - // - // * HOST - The host - // URI: either the fully qualified domain name (FQDN) or the IPv4 address of the - // database host. - // - // * PORT - The port number, between 1024 and 65535, of the port on - // which the database host is listening for database connections. - // - // * USER_NAME - - // The name under which to log in to the database. The value string for USER_NAME - // is "USERNAME". - // - // * PASSWORD - A password, if one is used, for the user name. - // - // * - // ENCRYPTED_PASSWORD - When you enable connection password protection by setting - // ConnectionPasswordEncryption in the Data Catalog encryption settings, this field - // stores the encrypted password. - // - // * JDBC_DRIVER_JAR_URI - The Amazon Simple - // Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver - // to use. - // - // * JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use. - // - // * - // JDBC_ENGINE - The name of the JDBC engine to use. - // - // * JDBC_ENGINE_VERSION - The - // version of the JDBC engine to use. - // - // * CONFIG_FILES - (Reserved for future - // use.) - // - // * INSTANCE_ID - The instance ID to use. - // - // * JDBC_CONNECTION_URL - The URL - // for connecting to a JDBC data source. - // - // * JDBC_ENFORCE_SSL - A Boolean string - // (true, false) specifying whether Secure Sockets Layer (SSL) with hostname - // matching is enforced for the JDBC connection on the client. The default is - // false. - // - // * CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's - // root certificate. Glue uses this root certificate to validate the customer’s - // certificate when connecting to the customer database. Glue only handles X.509 - // certificates. The certificate provided must be DER-encoded and supplied in - // Base64 encoding PEM format. - // - // * SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, - // this is false. Glue validates the Signature algorithm and Subject Public Key - // Algorithm for the customer certificate. The only permitted algorithms for the - // Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the - // Subject Public Key Algorithm, the key length must be at least 2048. You can set - // the value of this property to true to skip Glue’s validation of the customer - // certificate. - // - // * CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which - // is used for domain match or distinguished name match to prevent a - // man-in-the-middle attack. In Oracle database, this is used as the - // SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the - // hostNameInCertificate. - // - // * CONNECTION_URL - The URL for connecting to a general - // (non-JDBC) data source. - // - // * SECRET_ID - The secret ID used for the secret manager - // of credentials. - // - // * CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM - // connection. - // - // * CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM - // connection. - // - // * CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE - // or CUSTOM connection. - // - // * KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of - // host and port pairs that are the addresses of the Apache Kafka brokers in a - // Kafka cluster to which a Kafka client will connect to and bootstrap itself. - // - // * - // KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka - // connection. Default value is "true". - // - // * KAFKA_CUSTOM_CERT - The Amazon S3 URL - // for the private CA cert file (.pem format). The default is an empty string. - // - // * - // KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA - // cert file or not. Glue validates for three algorithms: SHA256withRSA, - // SHA384withRSA and SHA512withRSA. Default value is "false". - // - // * - // KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for - // Kafka client side authentication (Optional). - // - // * KAFKA_CLIENT_KEYSTORE_PASSWORD - - // The password to access the provided keystore (Optional). - // - // * - // KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is - // the password to access the client key to be used with the Kafka server side key - // (Optional). - // - // * ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version - // of the Kafka client keystore password (if the user has the Glue encrypt - // passwords setting selected). - // - // * ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The - // encrypted version of the Kafka client key password (if the user has the Glue - // encrypt passwords setting selected). - // - // * KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", - // "GSSAPI", or "AWS_MSK_IAM". These are the supported SASL Mechanisms - // (https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml). - // - // * - // KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the - // "SCRAM-SHA-512" mechanism. - // - // * KAFKA_SASL_SCRAM_PASSWORD - A plaintext password - // used to authenticate with the "SCRAM-SHA-512" mechanism. - // - // * - // ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL - // SCRAM password (if the user has the Glue encrypt passwords setting selected). - // - // * - // KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab - // stores long-term keys for one or more principals. For more information, see MIT - // Kerberos Documentation: Keytab - // (https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html). - // - // * - // KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A - // krb5.conf stores Kerberos configuration information, such as the location of the - // KDC server. For more information, see MIT Kerberos Documentation: krb5.conf - // (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html). - // - // * - // KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with - // sasl.kerberos.service.name in your Kafka Configuration - // (https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name). - // - // * - // KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. - // For more information, see Kafka Documentation: Configuring Kafka Brokers - // (https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig). + // - HOST - The host URI: either the fully qualified domain name (FQDN) or the + // IPv4 address of the database host. + // - PORT - The port number, between 1024 and 65535, of the port on which the + // database host is listening for database connections. + // - USER_NAME - The name under which to log in to the database. The value string + // for USER_NAME is " USERNAME ". + // - PASSWORD - A password, if one is used, for the user name. + // - ENCRYPTED_PASSWORD - When you enable connection password protection by + // setting ConnectionPasswordEncryption in the Data Catalog encryption settings, + // this field stores the encrypted password. + // - JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of + // the JAR file that contains the JDBC driver to use. + // - JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use. + // - JDBC_ENGINE - The name of the JDBC engine to use. + // - JDBC_ENGINE_VERSION - The version of the JDBC engine to use. + // - CONFIG_FILES - (Reserved for future use.) + // - INSTANCE_ID - The instance ID to use. + // - JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source. + // - JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure + // Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection + // on the client. The default is false. + // - CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root + // certificate. Glue uses this root certificate to validate the customer’s + // certificate when connecting to the customer database. Glue only handles X.509 + // certificates. The certificate provided must be DER-encoded and supplied in + // Base64 encoding PEM format. + // - SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false . Glue + // validates the Signature algorithm and Subject Public Key Algorithm for the + // customer certificate. The only permitted algorithms for the Signature algorithm + // are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key + // Algorithm, the key length must be at least 2048. You can set the value of this + // property to true to skip Glue’s validation of the customer certificate. + // - CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for + // domain match or distinguished name match to prevent a man-in-the-middle attack. + // In Oracle database, this is used as the SSL_SERVER_CERT_DN ; in Microsoft SQL + // Server, this is used as the hostNameInCertificate . + // - CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source. + // - SECRET_ID - The secret ID used for the secret manager of credentials. + // - CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection. + // - CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection. + // - CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM + // connection. + // - KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that + // are the addresses of the Apache Kafka brokers in a Kafka cluster to which a + // Kafka client will connect to and bootstrap itself. + // - KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka + // connection. Default value is "true". + // - KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem + // format). The default is an empty string. + // - KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA + // cert file or not. Glue validates for three algorithms: SHA256withRSA, + // SHA384withRSA and SHA512withRSA. Default value is "false". + // - KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file + // for Kafka client side authentication (Optional). + // - KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided + // keystore (Optional). + // - KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this + // is the password to access the client key to be used with the Kafka server side + // key (Optional). + // - ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the + // Kafka client keystore password (if the user has the Glue encrypt passwords + // setting selected). + // - ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka + // client key password (if the user has the Glue encrypt passwords setting + // selected). + // - KAFKA_SASL_MECHANISM - "SCRAM-SHA-512" , "GSSAPI" , or "AWS_MSK_IAM" . These + // are the supported SASL Mechanisms (https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) + // . + // - KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with + // the "SCRAM-SHA-512" mechanism. + // - KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with + // the "SCRAM-SHA-512" mechanism. + // - ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka + // SASL SCRAM password (if the user has the Glue encrypt passwords setting + // selected). + // - KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A + // keytab stores long-term keys for one or more principals. For more information, + // see MIT Kerberos Documentation: Keytab (https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html) + // . + // - KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. + // A krb5.conf stores Kerberos configuration information, such as the location of + // the KDC server. For more information, see MIT Kerberos Documentation: + // krb5.conf (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html) + // . + // - KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with + // sasl.kerberos.service.name in your Kafka Configuration (https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name) + // . + // - KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by + // Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers (https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig) + // . ConnectionProperties map[string]string // The type of the connection. Currently, SFTP is not supported. @@ -1334,7 +1249,7 @@ type Connection struct { Name *string // A map of physical connection requirements, such as virtual private cloud (VPC) - // and SecurityGroup, that are needed to make this connection successfully. + // and SecurityGroup , that are needed to make this connection successfully. PhysicalConnectionRequirements *PhysicalConnectionRequirements noSmithyDocumentSerde @@ -1349,86 +1264,55 @@ type ConnectionInput struct { ConnectionProperties map[string]string // The type of the connection. Currently, these types are supported: - // - // * JDBC - - // Designates a connection to a database through Java Database Connectivity (JDBC). - // JDBC Connections use the following ConnectionParameters. - // - // * Required: All of - // (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL. - // - // * Required: All of (USERNAME, - // PASSWORD) or SECRET_ID. - // - // * Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, - // CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are - // used to configure SSL with JDBC. - // - // * KAFKA - Designates a connection to an Apache - // Kafka streaming platform. KAFKA Connections use the following - // ConnectionParameters. - // - // * Required: KAFKA_BOOTSTRAP_SERVERS. - // - // * Optional: - // KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These - // parameters are used to configure SSL with KAFKA. - // - // * Optional: - // KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, - // KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, - // ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS - // client configuration with SSL in KAFKA. - // - // * Optional: KAFKA_SASL_MECHANISM. Can - // be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM. - // - // * Optional: - // KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, - // ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure - // SASL/SCRAM-SHA-512 authentication with KAFKA. - // - // * Optional: - // KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, - // KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are - // used to configure SASL/GSSAPI authentication with KAFKA. - // - // * MONGODB - Designates - // a connection to a MongoDB document database. MONGODB Connections use the - // following ConnectionParameters. - // - // * Required: CONNECTION_URL. - // - // * Required: All of - // (USERNAME, PASSWORD) or SECRET_ID. - // - // * NETWORK - Designates a network connection - // to a data source within an Amazon Virtual Private Cloud environment (Amazon - // VPC). NETWORK Connections do not require ConnectionParameters. Instead, provide - // a PhysicalConnectionRequirements. - // - // * MARKETPLACE - Uses configuration settings - // contained in a connector purchased from Amazon Web Services Marketplace to read - // from and write to data stores that are not natively supported by Glue. - // MARKETPLACE Connections use the following ConnectionParameters. - // - // * Required: - // CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL. - // - // * Required - // for JDBCCONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID. - // - // * - // CUSTOM - Uses configuration settings contained in a custom connector to read - // from and write to data stores that are not natively supported by Glue. - // - // SFTP is - // not supported. For more information about how optional ConnectionProperties are - // used to configure features in Glue, consult Glue connection properties - // (https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html). For more - // information about how optional ConnectionProperties are used to configure - // features in Glue Studio, consult Using connectors and connections - // (https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html). + // - JDBC - Designates a connection to a database through Java Database + // Connectivity (JDBC). JDBC Connections use the following ConnectionParameters. + // - Required: All of ( HOST , PORT , JDBC_ENGINE ) or JDBC_CONNECTION_URL . + // - Required: All of ( USERNAME , PASSWORD ) or SECRET_ID . + // - Optional: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , + // SKIP_CUSTOM_JDBC_CERT_VALIDATION . These parameters are used to configure SSL + // with JDBC. + // - KAFKA - Designates a connection to an Apache Kafka streaming platform. KAFKA + // Connections use the following ConnectionParameters. + // - Required: KAFKA_BOOTSTRAP_SERVERS . + // - Optional: KAFKA_SSL_ENABLED , KAFKA_CUSTOM_CERT , + // KAFKA_SKIP_CUSTOM_CERT_VALIDATION . These parameters are used to configure SSL + // with KAFKA . + // - Optional: KAFKA_CLIENT_KEYSTORE , KAFKA_CLIENT_KEYSTORE_PASSWORD , + // KAFKA_CLIENT_KEY_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD , + // ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD . These parameters are used to configure + // TLS client configuration with SSL in KAFKA . + // - Optional: KAFKA_SASL_MECHANISM . Can be specified as SCRAM-SHA-512 , GSSAPI + // , or AWS_MSK_IAM . + // - Optional: KAFKA_SASL_SCRAM_USERNAME , KAFKA_SASL_SCRAM_PASSWORD , + // ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD . These parameters are used to configure + // SASL/SCRAM-SHA-512 authentication with KAFKA . + // - Optional: KAFKA_SASL_GSSAPI_KEYTAB , KAFKA_SASL_GSSAPI_KRB5_CONF , + // KAFKA_SASL_GSSAPI_SERVICE , KAFKA_SASL_GSSAPI_PRINCIPAL . These parameters are + // used to configure SASL/GSSAPI authentication with KAFKA . + // - MONGODB - Designates a connection to a MongoDB document database. MONGODB + // Connections use the following ConnectionParameters. + // - Required: CONNECTION_URL . + // - Required: All of ( USERNAME , PASSWORD ) or SECRET_ID . + // - NETWORK - Designates a network connection to a data source within an Amazon + // Virtual Private Cloud environment (Amazon VPC). NETWORK Connections do not + // require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. + // + // - MARKETPLACE - Uses configuration settings contained in a connector purchased + // from Amazon Web Services Marketplace to read from and write to data stores that + // are not natively supported by Glue. MARKETPLACE Connections use the following + // ConnectionParameters. + // - Required: CONNECTOR_TYPE , CONNECTOR_URL , CONNECTOR_CLASS_NAME , + // CONNECTION_URL . + // - Required for JDBC CONNECTOR_TYPE connections: All of ( USERNAME , PASSWORD ) + // or SECRET_ID . + // - CUSTOM - Uses configuration settings contained in a custom connector to read + // from and write to data stores that are not natively supported by Glue. + // SFTP is not supported. For more information about how optional + // ConnectionProperties are used to configure features in Glue, consult Glue + // connection properties (https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html) + // . For more information about how optional ConnectionProperties are used to + // configure features in Glue Studio, consult Using connectors and connections (https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html) + // . // // This member is required. ConnectionType ConnectionType @@ -1446,7 +1330,7 @@ type ConnectionInput struct { MatchCriteria []string // A map of physical connection requirements, such as virtual private cloud (VPC) - // and SecurityGroup, that are needed to successfully make this connection. + // and SecurityGroup , that are needed to successfully make this connection. PhysicalConnectionRequirements *PhysicalConnectionRequirements noSmithyDocumentSerde @@ -1465,7 +1349,7 @@ type ConnectionInput struct { type ConnectionPasswordEncryption struct { // When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords - // remain encrypted in the responses of GetConnection and GetConnections. This + // remain encrypted in the responses of GetConnection and GetConnections . This // encryption takes effect independently from catalog encryption. // // This member is required. @@ -1473,10 +1357,10 @@ type ConnectionPasswordEncryption struct { // An KMS key that is used to encrypt the connection password. If connection // password protection is enabled, the caller of CreateConnection and - // UpdateConnection needs at least kms:Encrypt permission on the specified KMS key, - // to encrypt passwords before storing them in the Data Catalog. You can set the - // decrypt permission to enable or restrict access on the password key according to - // your security requirements. + // UpdateConnection needs at least kms:Encrypt permission on the specified KMS + // key, to encrypt passwords before storing them in the Data Catalog. You can set + // the decrypt permission to enable or restrict access on the password key + // according to your security requirements. AwsKmsKeyId *string noSmithyDocumentSerde @@ -1526,8 +1410,8 @@ type Crawler struct { // Crawler configuration information. This versioned JSON string allows users to // specify aspects of a crawler's behavior. For more information, see Setting - // crawler configuration options - // (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // crawler configuration options (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html) + // . Configuration *string // If the crawler is running, contains the total time elapsed since the last crawl @@ -1699,37 +1583,23 @@ type CrawlsFilter struct { // A key used to filter the crawler runs for a specified crawler. Valid values for // each of the field names are: - // - // * CRAWL_ID: A string representing the UUID - // identifier for a crawl. - // - // * STATE: A string representing the state of the - // crawl. - // - // * START_TIME and END_TIME: The epoch timestamp in milliseconds. - // - // * - // DPU_HOUR: The number of data processing unit (DPU) hours used for the crawl. + // - CRAWL_ID : A string representing the UUID identifier for a crawl. + // - STATE : A string representing the state of the crawl. + // - START_TIME and END_TIME : The epoch timestamp in milliseconds. + // - DPU_HOUR : The number of data processing unit (DPU) hours used for the + // crawl. FieldName FieldName // The value provided for comparison on the crawl field. FieldValue *string // A defined comparator that operates on the value. The available operators are: - // - // * - // GT: Greater than. - // - // * GE: Greater than or equal to. - // - // * LT: Less than. - // - // * LE: Less - // than or equal to. - // - // * EQ: Equal to. - // - // * NE: Not equal to. + // - GT : Greater than. + // - GE : Greater than or equal to. + // - LT : Less than. + // - LE : Less than or equal to. + // - EQ : Equal to. + // - NE : Not equal to. FilterOperator FilterOperator noSmithyDocumentSerde @@ -1765,8 +1635,8 @@ type CreateCsvClassifierRequest struct { // A list of strings representing column names. Header []string - // A custom symbol to denote what combines content into a single column value. Must - // be different from the column delimiter. + // A custom symbol to denote what combines content into a single column value. + // Must be different from the column delimiter. QuoteSymbol *string noSmithyDocumentSerde @@ -1802,8 +1672,8 @@ type CreateJsonClassifierRequest struct { // A JsonPath string defining the JSON data for the classifier to classify. Glue // supports a subset of JsonPath, as described in Writing JsonPath Custom - // Classifiers - // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json). + // Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json) + // . // // This member is required. JsonPath *string @@ -1829,10 +1699,10 @@ type CreateXMLClassifierRequest struct { // This member is required. Name *string - // The XML tag designating the element that contains each record in an XML document - // being parsed. This can't identify a self-closing element (closed by />). An - // empty row element that contains only attributes can be parsed as long as it ends - // with a closing tag (for example, is okay, but is not). + // The XML tag designating the element that contains each record in an XML + // document being parsed. This can't identify a self-closing element (closed by /> + // ). An empty row element that contains only attributes can be parsed as long as + // it ends with a closing tag (for example, is okay, but is not). RowTag *string noSmithyDocumentSerde @@ -1866,7 +1736,7 @@ type CsvClassifier struct { Delimiter *string // Specifies not to trim values before identifying the type of column values. The - // default value is true. + // default value is true . DisableValueTrimming *bool // A list of strings representing column names. @@ -1939,8 +1809,8 @@ type CustomEntityType struct { noSmithyDocumentSerde } -// The Database object represents a logical grouping of tables that might reside in -// a Hive metastore or an RDBMS. +// The Database object represents a logical grouping of tables that might reside +// in a Hive metastore or an RDBMS. type Database struct { // The name of the database. For Hive compatibility, this is folded to lowercase @@ -2127,8 +1997,8 @@ type DataQualityResultDescription struct { // Criteria used to return data quality results. type DataQualityResultFilterCriteria struct { - // Filter results by the specified data source. For example, retrieving all results - // for an Glue table. + // Filter results by the specified data source. For example, retrieving all + // results for an Glue table. DataSource *DataSource // Filter results by the specified job name. @@ -2261,7 +2131,7 @@ type DataQualityRulesetFilterCriteria struct { noSmithyDocumentSerde } -// Describes a data quality ruleset returned by GetDataQualityRuleset. +// Describes a data quality ruleset returned by GetDataQualityRuleset . type DataQualityRulesetListDetails struct { // The date and time the data quality ruleset was created. @@ -2415,15 +2285,11 @@ type DeltaTarget struct { // and load (ETL) scripts. type DevEndpoint struct { - // A map of arguments used to configure the DevEndpoint. Valid arguments are: - // - // * - // "--enable-glue-datacatalog": "" - // - // You can specify a version of Python support for - // development endpoints by using the Arguments parameter in the CreateDevEndpoint - // or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to - // Python 2. + // A map of arguments used to configure the DevEndpoint . Valid arguments are: + // - "--enable-glue-datacatalog": "" + // You can specify a version of Python support for development endpoints by using + // the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If + // no arguments are provided, the version defaults to Python 2. Arguments map[string]string // The Amazon Web Services Availability Zone where this DevEndpoint is located. @@ -2432,33 +2298,33 @@ type DevEndpoint struct { // The point in time at which this DevEndpoint was created. CreatedTimestamp *time.Time - // The name of the DevEndpoint. + // The name of the DevEndpoint . EndpointName *string - // The path to one or more Java .jar files in an S3 bucket that should be loaded in - // your DevEndpoint. You can only use pure Java/Scala libraries with a DevEndpoint. + // The path to one or more Java .jar files in an S3 bucket that should be loaded + // in your DevEndpoint . You can only use pure Java/Scala libraries with a + // DevEndpoint . ExtraJarsS3Path *string // The paths to one or more Python libraries in an Amazon S3 bucket that should be - // loaded in your DevEndpoint. Multiple values must be complete paths separated by - // a comma. You can only use pure Python libraries with a DevEndpoint. Libraries - // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) Python - // data analysis library, are not currently supported. + // loaded in your DevEndpoint . Multiple values must be complete paths separated by + // a comma. You can only use pure Python libraries with a DevEndpoint . Libraries + // that rely on C extensions, such as the pandas (http://pandas.pydata.org/) + // Python data analysis library, are not currently supported. ExtraPythonLibsS3Path *string - // The reason for a current failure in this DevEndpoint. + // The reason for a current failure in this DevEndpoint . FailureReason *string // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for running your // ETL scripts on development endpoints. For more information about the available - // Glue versions and corresponding Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. Development endpoints that are created without specifying a Glue version - // default to Glue 0.9. You can specify a version of Python support for development - // endpoints by using the Arguments parameter in the CreateDevEndpoint or - // UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to - // Python 2. + // Glue versions and corresponding Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. Development endpoints that are created without + // specifying a Glue version default to Glue 0.9. You can specify a version of + // Python support for development endpoints by using the Arguments parameter in + // the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, + // the version defaults to Python 2. GlueVersion *string // The point in time at which this DevEndpoint was last modified. @@ -2467,12 +2333,12 @@ type DevEndpoint struct { // The status of the last update. LastUpdateStatus *string - // The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint. + // The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint . NumberOfNodes int32 // The number of workers of a defined workerType that are allocated to the // development endpoint. The maximum number of workers you can define are 299 for - // G.1X, and 149 for G.2X. + // G.1X , and 149 for G.2X . NumberOfWorkers *int32 // A private IP address to access the DevEndpoint within a VPC if the DevEndpoint @@ -2480,13 +2346,13 @@ type DevEndpoint struct { // the DevEndpoint within your VPC. PrivateAddress *string - // The public IP address used by this DevEndpoint. The PublicAddress field is - // present only when you create a non-virtual private cloud (VPC) DevEndpoint. + // The public IP address used by this DevEndpoint . The PublicAddress field is + // present only when you create a non-virtual private cloud (VPC) DevEndpoint . PublicAddress *string - // The public key to be used by this DevEndpoint for authentication. This attribute - // is provided for backward compatibility because the recommended attribute to use - // is public keys. + // The public key to be used by this DevEndpoint for authentication. This + // attribute is provided for backward compatibility because the recommended + // attribute to use is public keys. PublicKey *string // A list of public keys to be used by the DevEndpoints for authentication. Using @@ -2498,47 +2364,41 @@ type DevEndpoint struct { // addPublicKeys attribute. PublicKeys []string - // The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint. + // The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint . RoleArn *string - // The name of the SecurityConfiguration structure to be used with this - // DevEndpoint. + // The name of the SecurityConfiguration structure to be used with this DevEndpoint + // . SecurityConfiguration *string - // A list of security group identifiers used in this DevEndpoint. + // A list of security group identifiers used in this DevEndpoint . SecurityGroupIds []string - // The current status of this DevEndpoint. + // The current status of this DevEndpoint . Status *string - // The subnet ID for this DevEndpoint. + // The subnet ID for this DevEndpoint . SubnetId *string - // The ID of the virtual private cloud (VPC) used by this DevEndpoint. + // The ID of the virtual private cloud (VPC) used by this DevEndpoint . VpcId *string // The type of predefined worker that is allocated to the development endpoint. // Accepts a value of Standard, G.1X, or G.2X. - // - // * For the Standard worker type, - // each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors - // per worker. - // - // * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 - // GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this - // worker type for memory-intensive jobs. - // - // * For the G.2X worker type, each worker - // maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor - // per worker. We recommend this worker type for memory-intensive jobs. - // - // Known - // issue: when a development endpoint is created with the G.2XWorkerType + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // Known issue: when a development endpoint is created with the G.2X WorkerType // configuration, the Spark drivers for the development endpoint will run on 4 // vCPU, 16 GB of memory, and a 64 GB disk. WorkerType WorkerType - // The YARN endpoint address used by this DevEndpoint. + // The YARN endpoint address used by this DevEndpoint . YarnEndpointAddress *string // The Apache Zeppelin port for the remote Apache Spark interpreter. @@ -2550,14 +2410,15 @@ type DevEndpoint struct { // Custom libraries to be loaded into a development endpoint. type DevEndpointCustomLibraries struct { - // The path to one or more Java .jar files in an S3 bucket that should be loaded in - // your DevEndpoint. You can only use pure Java/Scala libraries with a DevEndpoint. + // The path to one or more Java .jar files in an S3 bucket that should be loaded + // in your DevEndpoint . You can only use pure Java/Scala libraries with a + // DevEndpoint . ExtraJarsS3Path *string // The paths to one or more Python libraries in an Amazon Simple Storage Service - // (Amazon S3) bucket that should be loaded in your DevEndpoint. Multiple values + // (Amazon S3) bucket that should be loaded in your DevEndpoint . Multiple values // must be complete paths separated by a comma. You can only use pure Python - // libraries with a DevEndpoint. Libraries that rely on C extensions, such as the + // libraries with a DevEndpoint . Libraries that rely on C extensions, such as the // pandas (http://pandas.pydata.org/) Python data analysis library, are not // currently supported. ExtraPythonLibsS3Path *string @@ -2708,8 +2569,8 @@ type DQResultsPublishingOptions struct { // fails. type DQStopJobOnFailureOptions struct { - // When to stop job if your data quality evaluation fails. Options are Immediate or - // AfterDataLoad. + // When to stop job if your data quality evaluation fails. Options are Immediate + // or AfterDataLoad. StopJobOnFailureTiming DQStopJobOnFailureTiming noSmithyDocumentSerde @@ -2755,9 +2616,9 @@ type DropFields struct { noSmithyDocumentSerde } -// Specifies a transform that removes columns from the dataset if all values in the -// column are 'null'. By default, Glue Studio will recognize null objects, but some -// values such as empty strings, strings that are "null", -1 integers or other +// Specifies a transform that removes columns from the dataset if all values in +// the column are 'null'. By default, Glue Studio will recognize null objects, but +// some values such as empty strings, strings that are "null", -1 integers or other // placeholders such as zeros, are not automatically recognized as nulls. type DropNullFields struct { @@ -2771,8 +2632,8 @@ type DropNullFields struct { // This member is required. Name *string - // A structure that represents whether certain values are recognized as null values - // for removal. + // A structure that represents whether certain values are recognized as null + // values for removal. NullCheckBoxList *NullCheckBoxList // A structure that specifies a list of NullValueField structures that represent a @@ -2853,15 +2714,15 @@ type DynamoDBTarget struct { // Scanning all the records can take a long time when the table is not a high // throughput table. A value of true means to scan all records, while a value of // false means to sample the records. If no value is specified, the value defaults - // to true. + // to true . ScanAll *bool - // The percentage of the configured read capacity units to use by the Glue crawler. - // Read capacity units is a term defined by DynamoDB, and is a numeric value that - // acts as rate limiter for the number of reads that can be performed on that table - // per second. The valid values are null or a value between 0.1 to 1.5. A null - // value is used when user does not provide a value, and defaults to 0.5 of the - // configured Read Capacity Unit (for provisioned tables), or 0.25 of the max + // The percentage of the configured read capacity units to use by the Glue + // crawler. Read capacity units is a term defined by DynamoDB, and is a numeric + // value that acts as rate limiter for the number of reads that can be performed on + // that table per second. The valid values are null or a value between 0.1 to 1.5. + // A null value is used when user does not provide a value, and defaults to 0.5 of + // the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max // configured Read Capacity Unit (for tables using on-demand mode). ScanRate *float64 @@ -3119,7 +2980,7 @@ type FilterExpression struct { noSmithyDocumentSerde } -// Represents a single entry in the list of values for a FilterExpression. +// Represents a single entry in the list of values for a FilterExpression . type FilterValue struct { // The type of filter value. @@ -3144,8 +3005,8 @@ type FindMatchesMetrics struct { // The area under the precision/recall curve (AUPRC) is a single number measuring // the overall quality of the transform, that is independent of the choice made for // precision vs. recall. Higher values indicate that you have a more attractive - // precision vs. recall tradeoff. For more information, see Precision and recall - // (https://en.wikipedia.org/wiki/Precision_and_recall) in Wikipedia. + // precision vs. recall tradeoff. For more information, see Precision and recall (https://en.wikipedia.org/wiki/Precision_and_recall) + // in Wikipedia. AreaUnderPRCurve *float64 // A list of ColumnImportance structures containing column importance metrics, @@ -3153,13 +3014,13 @@ type FindMatchesMetrics struct { ColumnImportances []ColumnImportance // The confusion matrix shows you what your transform is predicting accurately and - // what types of errors it is making. For more information, see Confusion matrix - // (https://en.wikipedia.org/wiki/Confusion_matrix) in Wikipedia. + // what types of errors it is making. For more information, see Confusion matrix (https://en.wikipedia.org/wiki/Confusion_matrix) + // in Wikipedia. ConfusionMatrix *ConfusionMatrix // The maximum F1 metric indicates the transform's accuracy between 0 and 1, where - // 1 is the best accuracy. For more information, see F1 score - // (https://en.wikipedia.org/wiki/F1_score) in Wikipedia. + // 1 is the best accuracy. For more information, see F1 score (https://en.wikipedia.org/wiki/F1_score) + // in Wikipedia. F1 *float64 // The precision metric indicates when often your transform is correct when it @@ -3195,9 +3056,9 @@ type FindMatchesParameters struct { AccuracyCostTradeoff *float64 // The value to switch on or off to force the output to match the provided labels - // from users. If the value is True, the find matches transform forces the output + // from users. If the value is True , the find matches transform forces the output // to match the provided labels. The results override the normal conflation - // results. If the value is False, the find matches transform does not ensure all + // results. If the value is False , the find matches transform does not ensure all // the labels provided are respected, and the results rely on the trained model. // Note that setting this value to true may increase the conflation execution time. EnforceProvidedLabels *bool @@ -3289,8 +3150,8 @@ type GlueStudioSchemaColumn struct { noSmithyDocumentSerde } -// The database and table in the Glue Data Catalog that is used for input or output -// data. +// The database and table in the Glue Data Catalog that is used for input or +// output data. type GlueTable struct { // A database name in the Glue Data Catalog. @@ -3304,13 +3165,10 @@ type GlueTable struct { TableName *string // Additional options for the table. Currently there are two keys supported: - // - // * - // pushDownPredicate: to filter on partitions without having to list and read all - // the files in your dataset. - // - // * catalogPartitionPredicate: to use server-side - // partition pruning using partition indexes in the Glue Data Catalog. + // - pushDownPredicate : to filter on partitions without having to list and read + // all the files in your dataset. + // - catalogPartitionPredicate : to use server-side partition pruning using + // partition indexes in the Glue Data Catalog. AdditionalOptions map[string]string // A unique identifier for the Glue Data Catalog. @@ -3392,8 +3250,8 @@ type GrokClassifier struct { Classification *string // The grok pattern applied to a data store by this classifier. For more - // information, see built-in patterns in Writing Custom Classifiers - // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). + // information, see built-in patterns in Writing Custom Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html) + // . // // This member is required. GrokPattern *string @@ -3407,8 +3265,8 @@ type GrokClassifier struct { CreationTime *time.Time // Optional custom grok patterns defined by this classifier. For more information, - // see custom patterns in Writing Custom Classifiers - // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). + // see custom patterns in Writing Custom Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html) + // . CustomPatterns *string // The time that this classifier was last updated. @@ -3447,7 +3305,7 @@ type JDBCConnectorOptions struct { // Extra condition clause to filter data from source. For example: // BillingCity='Mountain View' When using a query instead of a table name, you - // should validate that the query works with the specified filterPredicate. + // should validate that the query works with the specified filterPredicate . FilterPredicate *string // The name of the job bookmark keys on which to sort. @@ -3461,11 +3319,11 @@ type JDBCConnectorOptions struct { // The number of partitions. This value, along with lowerBound (inclusive) and // upperBound (exclusive), form partition strides for generated WHERE clause - // expressions that are used to split the partitionColumn. + // expressions that are used to split the partitionColumn . NumPartitions *int64 // The name of an integer column that is used for partitioning. This option works - // only when it's included with lowerBound, upperBound, and numPartitions. This + // only when it's included with lowerBound , upperBound , and numPartitions . This // option works the same way as in the Spark SQL JDBC reader. PartitionColumn *string @@ -3510,7 +3368,7 @@ type JDBCConnectorSource struct { OutputSchemas []GlueSchema // The table or SQL query to get the data from. You can specify either - // ConnectionTable or query, but not both. + // ConnectionTable or query , but not both. Query *string noSmithyDocumentSerde @@ -3573,8 +3431,8 @@ type JdbcTarget struct { EnableAdditionalMetadata []JdbcMetadataEntry // A list of glob patterns used to exclude from the crawl. For more information, - // see Catalog Tables with a Crawler - // (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). + // see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) + // . Exclusions []string // The path of the JDBC target. @@ -3590,7 +3448,7 @@ type Job struct { // processing units (DPUs) allocated to runs of this job. You can allocate a // minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing // power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/). + // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/) . // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -3611,11 +3469,9 @@ type Job struct { // The default arguments for this job, specified as name-value pairs. You can // specify arguments here that your own job-execution script consumes, as well as // arguments that Glue itself consumes. For information about how to specify and - // consume your own Job arguments, see the Calling Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // consume your own Job arguments, see the Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. DefaultArguments map[string]string @@ -3627,8 +3483,8 @@ type Job struct { // fast job startup and dedicated resources. The flexible execution class is // appropriate for time-insensitive jobs whose start and completion times may vary. // Only jobs with Glue version 3.0 and above and command type glueetl will be - // allowed to set ExecutionClass to FLEX. The flexible execution class is available - // for Spark jobs. + // allowed to set ExecutionClass to FLEX . The flexible execution class is + // available for Spark jobs. ExecutionClass ExecutionClass // An ExecutionProperty specifying the maximum number of concurrent runs allowed @@ -3638,10 +3494,9 @@ type Job struct { // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for jobs of type // Spark. For more information about the available Glue versions and corresponding - // Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. Jobs that are created without specifying a Glue version default to Glue - // 0.9. + // Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. Jobs that are created without specifying a Glue version + // default to Glue 0.9. GlueVersion *string // The last point in time when this job definition was modified. @@ -3650,27 +3505,22 @@ type Job struct { // This field is reserved for future use. LogUri *string - // For Glue version 1.0 or earlier jobs, using the standard worker type, the number - // of Glue data processing units (DPUs) that can be allocated when this job runs. A - // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). Do not set Max Capacity if using - // WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity - // depends on whether you are running a Python shell job, an Apache Spark ETL job, - // or an Apache Spark streaming ETL job: - // - // * When you specify a Python shell job - // (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The - // default is 0.0625 DPU. - // - // * When you specify an Apache Spark ETL job - // (JobCommand.Name="glueetl") or Apache Spark streaming ETL job - // (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The - // default is 10 DPUs. This job type cannot have a fractional DPU allocation. - // - // For - // Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, - // you should specify a Worker type and the Number of workers. + // For Glue version 1.0 or earlier jobs, using the standard worker type, the + // number of Glue data processing units (DPUs) that can be allocated when this job + // runs. A DPU is a relative measure of processing power that consists of 4 vCPUs + // of compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . Do not set Max Capacity + // if using WorkerType and NumberOfWorkers . The value that can be allocated for + // MaxCapacity depends on whether you are running a Python shell job, an Apache + // Spark ETL job, or an Apache Spark streaming ETL job: + // - When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you + // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. + // - When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl") or + // Apache Spark streaming ETL job ( JobCommand.Name ="gluestreaming"), you can + // allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a + // fractional DPU allocation. + // For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . + // Instead, you should specify a Worker type and the Number of workers . MaxCapacity *float64 // The maximum number of times to retry this job after a JobRun fails. @@ -3704,26 +3554,20 @@ type Job struct { // 2,880 minutes (48 hours). Timeout *int32 - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 - // GB disk), and provides 1 executor per worker. We recommend this worker type for - // memory-intensive jobs. - // - // * For the G.2X worker type, each worker maps to 2 DPU (8 - // vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We - // recommend this worker type for memory-intensive jobs. - // - // * For the G.025X worker - // type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and - // provides 1 executor per worker. We recommend this worker type for low volume - // streaming jobs. This worker type is only available for Glue version 3.0 - // streaming jobs. + // The type of predefined worker that is allocated when a job runs. Accepts a + // value of Standard, G.1X, G.2X, or G.025X. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType WorkerType noSmithyDocumentSerde @@ -3771,13 +3615,13 @@ type JobBookmarksEncryption struct { // Specifies code that runs when a job is run. type JobCommand struct { - // The name of the job command. For an Apache Spark ETL job, this must be glueetl. - // For a Python shell job, it must be pythonshell. For an Apache Spark streaming - // ETL job, this must be gluestreaming. + // The name of the job command. For an Apache Spark ETL job, this must be glueetl . + // For a Python shell job, it must be pythonshell . For an Apache Spark streaming + // ETL job, this must be gluestreaming . Name *string - // The Python version being used to run a Python shell job. Allowed values are 2 or - // 3. + // The Python version being used to run a Python shell job. Allowed values are 2 + // or 3. PythonVersion *string // Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that @@ -3803,7 +3647,7 @@ type JobRun struct { // processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be // allocated; the default is 10. A DPU is a relative measure of processing power // that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/). + // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/) . // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -3812,11 +3656,9 @@ type JobRun struct { // default arguments set in the job definition itself. You can specify arguments // here that your own job-execution script consumes, as well as arguments that Glue // itself consumes. For information about how to specify and consume your own job - // arguments, see the Calling Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // arguments, see the Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. Arguments map[string]string @@ -3828,11 +3670,11 @@ type JobRun struct { // This field populates only for Auto Scaling job runs, and represents the total // time each executor ran during the lifecycle of a job run in seconds, multiplied - // by a DPU factor (1 for G.1X, 2 for G.2X, or 0.25 for G.025X workers). This value - // may be different than the executionEngineRuntime * MaxCapacity as in the case of - // Auto Scaling jobs, as the number of executors running at a given time may be - // less than the MaxCapacity. Therefore, it is possible that the value of - // DPUSeconds is less than executionEngineRuntime * MaxCapacity. + // by a DPU factor (1 for G.1X , 2 for G.2X , or 0.25 for G.025X workers). This + // value may be different than the executionEngineRuntime * MaxCapacity as in the + // case of Auto Scaling jobs, as the number of executors running at a given time + // may be less than the MaxCapacity . Therefore, it is possible that the value of + // DPUSeconds is less than executionEngineRuntime * MaxCapacity . DPUSeconds *float64 // An error message associated with this job run. @@ -3843,8 +3685,8 @@ type JobRun struct { // fast job startup and dedicated resources. The flexible execution class is // appropriate for time-insensitive jobs whose start and completion times may vary. // Only jobs with Glue version 3.0 and above and command type glueetl will be - // allowed to set ExecutionClass to FLEX. The flexible execution class is available - // for Spark jobs. + // allowed to set ExecutionClass to FLEX . The flexible execution class is + // available for Spark jobs. ExecutionClass ExecutionClass // The amount of time (in seconds) that the job run consumed resources. @@ -3853,10 +3695,9 @@ type JobRun struct { // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for jobs of type // Spark. For more information about the available Glue versions and corresponding - // Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. Jobs that are created without specifying a Glue version default to Glue - // 0.9. + // Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. Jobs that are created without specifying a Glue version + // default to Glue 0.9. GlueVersion *string // The ID of this job run. @@ -3866,36 +3707,33 @@ type JobRun struct { JobName *string // The current state of the job run. For more information about the statuses of - // jobs that have terminated abnormally, see Glue Job Run Statuses - // (https://docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html). + // jobs that have terminated abnormally, see Glue Job Run Statuses (https://docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html) + // . JobRunState JobRunState // The last time that this job run was modified. LastModifiedOn *time.Time // The name of the log group for secure logging that can be server-side encrypted - // in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case - // the default encryption is NONE. If you add a role name and SecurityConfiguration - // name (in other words, - // /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security + // in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/ , in which case + // the default encryption is NONE . If you add a role name and + // SecurityConfiguration name (in other words, + // /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/ ), then that security // configuration is used to encrypt the log group. LogGroupName *string // The number of Glue data processing units (DPUs) that can be allocated when this // job runs. A DPU is a relative measure of processing power that consists of 4 // vCPUs of compute capacity and 16 GB of memory. For more information, see the - // Glue pricing page (https://aws.amazon.com/glue/pricing/). Do not set Max - // Capacity if using WorkerType and NumberOfWorkers. The value that can be + // Glue pricing page (https://aws.amazon.com/glue/pricing/) . Do not set Max + // Capacity if using WorkerType and NumberOfWorkers . The value that can be // allocated for MaxCapacity depends on whether you are running a Python shell job // or an Apache Spark ETL job: - // - // * When you specify a Python shell job - // (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The - // default is 0.0625 DPU. - // - // * When you specify an Apache Spark ETL job - // (JobCommand.Name="glueetl"), you can allocate a minimum of 2 DPUs. The default - // is 10 DPUs. This job type cannot have a fractional DPU allocation. + // - When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you + // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. + // - When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you + // can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot + // have a fractional DPU allocation. MaxCapacity *float64 // Specifies configuration properties of a job run notification. @@ -3927,24 +3765,18 @@ type JobRun struct { // The name of the trigger that started this job run. TriggerName *string - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a - // 64GB disk, and 1 executor per worker. - // - // * For the G.2X worker type, each worker - // provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. - // - // * - // For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of - // memory, 64 GB disk), and provides 1 executor per worker. We recommend this - // worker type for low volume streaming jobs. This worker type is only available - // for Glue version 3.0 streaming jobs. + // The type of predefined worker that is allocated when a job runs. Accepts a + // value of Standard, G.1X, G.2X, or G.025X. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType WorkerType noSmithyDocumentSerde @@ -3958,7 +3790,7 @@ type JobUpdate struct { // processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 // DPUs; the default is 10. A DPU is a relative measure of processing power that // consists of 4 vCPUs of compute capacity and 16 GB of memory. For more - // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/). + // information, see the Glue pricing page (https://aws.amazon.com/glue/pricing/) . // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -3973,14 +3805,12 @@ type JobUpdate struct { // The connections used for this job. Connections *ConnectionsList - // The default arguments for this job. You can specify arguments here that your own - // job-execution script consumes, as well as arguments that Glue itself consumes. - // For information about how to specify and consume your own Job arguments, see the - // Calling Glue APIs in Python - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) + // The default arguments for this job. You can specify arguments here that your + // own job-execution script consumes, as well as arguments that Glue itself + // consumes. For information about how to specify and consume your own Job + // arguments, see the Calling Glue APIs in Python (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) // topic in the developer guide. For information about the key-value pairs that - // Glue consumes to set up your job, see the Special Parameters Used by Glue - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) + // Glue consumes to set up your job, see the Special Parameters Used by Glue (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) // topic in the developer guide. DefaultArguments map[string]string @@ -3992,8 +3822,8 @@ type JobUpdate struct { // fast job startup and dedicated resources. The flexible execution class is // appropriate for time-insensitive jobs whose start and completion times may vary. // Only jobs with Glue version 3.0 and above and command type glueetl will be - // allowed to set ExecutionClass to FLEX. The flexible execution class is available - // for Spark jobs. + // allowed to set ExecutionClass to FLEX . The flexible execution class is + // available for Spark jobs. ExecutionClass ExecutionClass // An ExecutionProperty specifying the maximum number of concurrent runs allowed @@ -4003,34 +3833,29 @@ type JobUpdate struct { // Glue version determines the versions of Apache Spark and Python that Glue // supports. The Python version indicates the version supported for jobs of type // Spark. For more information about the available Glue versions and corresponding - // Spark and Python versions, see Glue version - // (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer - // guide. + // Spark and Python versions, see Glue version (https://docs.aws.amazon.com/glue/latest/dg/add-job.html) + // in the developer guide. GlueVersion *string // This field is reserved for future use. LogUri *string - // For Glue version 1.0 or earlier jobs, using the standard worker type, the number - // of Glue data processing units (DPUs) that can be allocated when this job runs. A - // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (https://aws.amazon.com/glue/pricing/). Do not set Max Capacity if using - // WorkerType and NumberOfWorkers. The value that can be allocated for MaxCapacity - // depends on whether you are running a Python shell job or an Apache Spark ETL - // job: - // - // * When you specify a Python shell job (JobCommand.Name="pythonshell"), you - // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. - // - // * When you - // specify an Apache Spark ETL job (JobCommand.Name="glueetl") or Apache Spark - // streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate a minimum - // of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU - // allocation. - // - // For Glue version 2.0 jobs, you cannot instead specify a Maximum - // capacity. Instead, you should specify a Worker type and the Number of workers. + // For Glue version 1.0 or earlier jobs, using the standard worker type, the + // number of Glue data processing units (DPUs) that can be allocated when this job + // runs. A DPU is a relative measure of processing power that consists of 4 vCPUs + // of compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (https://aws.amazon.com/glue/pricing/) . Do not set Max Capacity + // if using WorkerType and NumberOfWorkers . The value that can be allocated for + // MaxCapacity depends on whether you are running a Python shell job or an Apache + // Spark ETL job: + // - When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you + // can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. + // - When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl") or + // Apache Spark streaming ETL job ( JobCommand.Name ="gluestreaming"), you can + // allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have + // a fractional DPU allocation. + // For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity . + // Instead, you should specify a Worker type and the Number of workers . MaxCapacity *float64 // The maximum number of times to retry this job if it fails. @@ -4062,26 +3887,20 @@ type JobUpdate struct { // 2,880 minutes (48 hours). Timeout *int32 - // The type of predefined worker that is allocated when a job runs. Accepts a value - // of Standard, G.1X, G.2X, or G.025X. - // - // * For the Standard worker type, each worker - // provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - // - // * - // For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 - // GB disk), and provides 1 executor per worker. We recommend this worker type for - // memory-intensive jobs. - // - // * For the G.2X worker type, each worker maps to 2 DPU (8 - // vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We - // recommend this worker type for memory-intensive jobs. - // - // * For the G.025X worker - // type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and - // provides 1 executor per worker. We recommend this worker type for low volume - // streaming jobs. This worker type is only available for Glue version 3.0 - // streaming jobs. + // The type of predefined worker that is allocated when a job runs. Accepts a + // value of Standard, G.1X, G.2X, or G.025X. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of + // memory, 128 GB disk), and provides 1 executor per worker. We recommend this + // worker type for memory-intensive jobs. + // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of + // memory, 64 GB disk), and provides 1 executor per worker. We recommend this + // worker type for low volume streaming jobs. This worker type is only available + // for Glue version 3.0 streaming jobs. WorkerType WorkerType noSmithyDocumentSerde @@ -4136,8 +3955,8 @@ type JsonClassifier struct { // A JsonPath string defining the JSON data for the classifier to classify. Glue // supports a subset of JsonPath, as described in Writing JsonPath Custom - // Classifiers - // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json). + // Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json) + // . // // This member is required. JsonPath *string @@ -4169,12 +3988,13 @@ type KafkaStreamingSourceOptions struct { AddRecordTimestamp *string // The specific TopicPartitions to consume. You must specify at least one of - // "topicName", "assign" or "subscribePattern". + // "topicName" , "assign" or "subscribePattern" . Assign *string // A list of bootstrap server URLs, for example, as - // b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be - // specified in the API call or defined in the table metadata in the Data Catalog. + // b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094 . This option must + // be specified in the API call or defined in the table metadata in the Data + // Catalog. BootstrapServers *string // An optional classification. @@ -4194,13 +4014,14 @@ type KafkaStreamingSourceOptions struct { EmitConsumerLagMetrics *string // The end point when a batch query is ended. Possible values are either "latest" - // or a JSON string that specifies an ending offset for each TopicPartition. + // or a JSON string that specifies an ending offset for each TopicPartition . EndingOffsets *string - // Whether to include the Kafka headers. When the option is set to "true", the data - // output will contain an additional column named "glue_streaming_kafka_headers" - // with type Array[Struct(key: String, value: String)]. The default value is - // "false". This option is available in Glue version 3.0 or later only. + // Whether to include the Kafka headers. When the option is set to "true", the + // data output will contain an additional column named + // "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: + // String)] . The default value is "false". This option is available in Glue + // version 3.0 or later only. IncludeHeaders *bool // The rate limit on the maximum number of offsets that are processed per trigger @@ -4215,31 +4036,31 @@ type KafkaStreamingSourceOptions struct { MinPartitions *int32 // The number of times to retry before failing to fetch Kafka offsets. The default - // value is 3. + // value is 3 . NumRetries *int32 // The timeout in milliseconds to poll data from Kafka in Spark job executors. The - // default value is 512. + // default value is 512 . PollTimeoutMs *int64 // The time in milliseconds to wait before retrying to fetch Kafka offsets. The - // default value is 10. + // default value is 10 . RetryIntervalMs *int64 // The protocol used to communicate with brokers. The possible values are "SSL" or - // "PLAINTEXT". + // "PLAINTEXT" . SecurityProtocol *string // The starting position in the Kafka topic to read data from. The possible values - // are "earliest" or "latest". The default value is "latest". + // are "earliest" or "latest" . The default value is "latest" . StartingOffsets *string // A Java regex string that identifies the topic list to subscribe to. You must - // specify at least one of "topicName", "assign" or "subscribePattern". + // specify at least one of "topicName" , "assign" or "subscribePattern" . SubscribePattern *string // The topic name as specified in Apache Kafka. You must specify at least one of - // "topicName", "assign" or "subscribePattern". + // "topicName" , "assign" or "subscribePattern" . TopicName *string noSmithyDocumentSerde @@ -4265,7 +4086,7 @@ type KeySchemaElement struct { type KinesisStreamingSourceOptions struct { // Adds a time delay between two consecutive getRecords operations. The default - // value is "False". This option is only configurable for Glue version 2.0 and + // value is "False" . This option is only configurable for Glue version 2.0 and // above. AddIdleTimeBetweenReads *bool @@ -4276,7 +4097,7 @@ type KinesisStreamingSourceOptions struct { AddRecordTimestamp *string // Avoids creating an empty microbatch job by checking for unread data in the - // Kinesis data stream before the batch is started. The default value is "False". + // Kinesis data stream before the batch is started. The default value is "False" . AvoidEmptyBatches *bool // An optional classification. @@ -4286,7 +4107,7 @@ type KinesisStreamingSourceOptions struct { Delimiter *string // The minimum time interval between two ListShards API calls for your script to - // consider resharding. The default value is 1s. + // consider resharding. The default value is 1s . DescribeShardInterval *int64 // When this option is set to 'true', for each batch, it will emit the metrics for @@ -4300,50 +4121,50 @@ type KinesisStreamingSourceOptions struct { EndpointUrl *string // The minimum time delay between two consecutive getRecords operations, specified - // in ms. The default value is 1000. This option is only configurable for Glue + // in ms. The default value is 1000 . This option is only configurable for Glue // version 2.0 and above. IdleTimeBetweenReadsInMs *int64 - // The maximum number of records to fetch per shard in the Kinesis data stream. The - // default value is 100000. + // The maximum number of records to fetch per shard in the Kinesis data stream. + // The default value is 100000 . MaxFetchRecordsPerShard *int64 // The maximum time spent in the job executor to fetch a record from the Kinesis - // data stream per shard, specified in milliseconds (ms). The default value is - // 1000. + // data stream per shard, specified in milliseconds (ms). The default value is 1000 + // . MaxFetchTimeInMs *int64 // The maximum number of records to fetch from the Kinesis data stream in each - // getRecords operation. The default value is 10000. + // getRecords operation. The default value is 10000 . MaxRecordPerRead *int64 // The maximum cool-off time period (specified in ms) between two retries of a - // Kinesis Data Streams API call. The default value is 10000. + // Kinesis Data Streams API call. The default value is 10000 . MaxRetryIntervalMs *int64 - // The maximum number of retries for Kinesis Data Streams API requests. The default - // value is 3. + // The maximum number of retries for Kinesis Data Streams API requests. The + // default value is 3 . NumRetries *int32 // The cool-off time period (specified in ms) before retrying the Kinesis Data - // Streams API call. The default value is 1000. + // Streams API call. The default value is 1000 . RetryIntervalMs *int64 // The Amazon Resource Name (ARN) of the role to assume using AWS Security Token // Service (AWS STS). This role must have permissions for describe or read record // operations for the Kinesis data stream. You must use this parameter when // accessing a data stream in a different account. Used in conjunction with - // "awsSTSSessionName". + // "awsSTSSessionName" . RoleArn *string - // An identifier for the session assuming the role using AWS STS. You must use this - // parameter when accessing a data stream in a different account. Used in - // conjunction with "awsSTSRoleARN". + // An identifier for the session assuming the role using AWS STS. You must use + // this parameter when accessing a data stream in a different account. Used in + // conjunction with "awsSTSRoleARN" . RoleSessionName *string - // The starting position in the Kinesis data stream to read data from. The possible - // values are "latest", "trim_horizon", or "earliest". The default value is - // "latest". + // The starting position in the Kinesis data stream to read data from. The + // possible values are "latest" , "trim_horizon" , or "earliest" . The default + // value is "latest" . StartingPosition StartingPosition // The Amazon Resource Name (ARN) of the Kinesis data stream. @@ -4432,12 +4253,8 @@ type LastCrawlInfo struct { type LineageConfiguration struct { // Specifies whether data lineage is enabled for the crawler. Valid values are: - // - // * - // ENABLE: enables data lineage for the crawler - // - // * DISABLE: disables data lineage - // for the crawler + // - ENABLE: enables data lineage for the crawler + // - DISABLE: disables data lineage for the crawler CrawlerLineageSettings CrawlerLineageSettings noSmithyDocumentSerde @@ -4485,7 +4302,7 @@ type Mapping struct { // Only applicable to nested data structures. If you want to change the parent // structure, but also one of its children, you can fill out this data strucutre. - // It is also Mapping, but its FromPath will be the parent's FromPath plus the + // It is also Mapping , but its FromPath will be the parent's FromPath plus the // FromPath from this structure. For the children part, suppose you have the // structure: { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": // "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": @@ -4505,7 +4322,7 @@ type Mapping struct { FromType *string // After the apply mapping, what the name of the column should be. Can be the same - // as FromPath. + // as FromPath . ToKey *string // The data type that the data is to be modified to. @@ -4559,7 +4376,7 @@ type Merge struct { // This member is required. PrimaryKeys [][]string - // The source DynamicFrame that will be merged with a staging DynamicFrame. + // The source DynamicFrame that will be merged with a staging DynamicFrame . // // This member is required. Source *string @@ -4657,9 +4474,8 @@ type MLTransform struct { // This value determines which version of Glue this machine learning transform is // compatible with. Glue 1.0 is recommended for most customers. If the value is not - // set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue - // Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // set, the Glue compatibility defaults to Glue 0.9. For more information, see + // Glue Versions (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) // in the developer guide. GlueVersion *string @@ -4678,32 +4494,24 @@ type MLTransform struct { // The number of Glue data processing units (DPUs) that are allocated to task runs // for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A // DPU is a relative measure of processing power that consists of 4 vCPUs of - // compute capacity and 16 GB of memory. For more information, see the Glue pricing - // page (http://aws.amazon.com/glue/pricing/). MaxCapacity is a mutually exclusive - // option with NumberOfWorkers and WorkerType. - // - // * If either NumberOfWorkers or - // WorkerType is set, then MaxCapacity cannot be set. - // - // * If MaxCapacity is set then - // neither NumberOfWorkers or WorkerType can be set. - // - // * If WorkerType is set, then - // NumberOfWorkers is required (and vice versa). - // - // * MaxCapacity and NumberOfWorkers - // must both be at least 1. - // - // When the WorkerType field is set to a value other than - // Standard, the MaxCapacity field is set automatically and becomes read-only. + // compute capacity and 16 GB of memory. For more information, see the Glue + // pricing page (http://aws.amazon.com/glue/pricing/) . MaxCapacity is a mutually + // exclusive option with NumberOfWorkers and WorkerType . + // - If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be + // set. + // - If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. + // - If WorkerType is set, then NumberOfWorkers is required (and vice versa). + // - MaxCapacity and NumberOfWorkers must both be at least 1. + // When the WorkerType field is set to a value other than Standard , the + // MaxCapacity field is set automatically and becomes read-only. MaxCapacity *float64 // The maximum number of times to retry after an MLTaskRun of the machine learning // transform fails. MaxRetries *int32 - // A user-defined name for the machine learning transform. Names are not guaranteed - // unique and can be changed at any time. + // A user-defined name for the machine learning transform. Names are not + // guaranteed unique and can be changed at any time. Name *string // The number of workers of a defined workerType that are allocated when a task of @@ -4720,16 +4528,12 @@ type MLTransform struct { // The name or Amazon Resource Name (ARN) of the IAM role with the required // permissions. The required permissions include both Glue service role permissions // to Glue resources, and Amazon S3 permissions required by the transform. - // - // * This - // role needs Glue service role permissions to allow access to resources in Glue. - // See Attach a Policy to IAM Users That Access Glue - // (https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html). - // - // * - // This role needs permission to your Amazon Simple Storage Service (Amazon S3) - // sources, targets, temporary directory, scripts, and any libraries used by the - // task run for this transform. + // - This role needs Glue service role permissions to allow access to resources + // in Glue. See Attach a Policy to IAM Users That Access Glue (https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html) + // . + // - This role needs permission to your Amazon Simple Storage Service (Amazon + // S3) sources, targets, temporary directory, scripts, and any libraries used by + // the task run for this transform. Role *string // A map of key-value pairs representing the columns and data types that this @@ -4753,32 +4557,18 @@ type MLTransform struct { // The type of predefined worker that is allocated when a task of this transform // runs. Accepts a value of Standard, G.1X, or G.2X. - // - // * For the Standard worker - // type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 - // executors per worker. - // - // * For the G.1X worker type, each worker provides 4 vCPU, - // 16 GB of memory and a 64GB disk, and 1 executor per worker. - // - // * For the G.2X - // worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and - // 1 executor per worker. - // - // MaxCapacity is a mutually exclusive option with - // NumberOfWorkers and WorkerType. - // - // * If either NumberOfWorkers or WorkerType is - // set, then MaxCapacity cannot be set. - // - // * If MaxCapacity is set then neither - // NumberOfWorkers or WorkerType can be set. - // - // * If WorkerType is set, then - // NumberOfWorkers is required (and vice versa). - // - // * MaxCapacity and NumberOfWorkers - // must both be at least 1. + // - For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory + // and a 50GB disk, and 2 executors per worker. + // - For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a + // 64GB disk, and 1 executor per worker. + // - For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a + // 128GB disk, and 1 executor per worker. + // MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType . + // - If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be + // set. + // - If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set. + // - If WorkerType is set, then NumberOfWorkers is required (and vice versa). + // - MaxCapacity and NumberOfWorkers must both be at least 1. WorkerType WorkerType noSmithyDocumentSerde @@ -4789,12 +4579,9 @@ type MLTransform struct { type MLUserDataEncryption struct { // The encryption mode applied to user data. Valid values are: - // - // * DISABLED: - // encryption is disabled - // - // * SSEKMS: use of server-side encryption with Key - // Management Service (SSE-KMS) for user data stored in Amazon S3. + // - DISABLED: encryption is disabled + // - SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) + // for user data stored in Amazon S3. // // This member is required. MlUserDataEncryptionMode MLUserDataEncryptionModeString @@ -4808,8 +4595,8 @@ type MLUserDataEncryption struct { // Specifies an Amazon DocumentDB or MongoDB data store to crawl. type MongoDBTarget struct { - // The name of the connection to use to connect to the Amazon DocumentDB or MongoDB - // target. + // The name of the connection to use to connect to the Amazon DocumentDB or + // MongoDB target. ConnectionName *string // The path of the Amazon DocumentDB or MongoDB target (database/collection). @@ -4819,7 +4606,7 @@ type MongoDBTarget struct { // Scanning all the records can take a long time when the table is not a high // throughput table. A value of true means to scan all records, while a value of // false means to sample the records. If no value is specified, the value defaults - // to true. + // to true . ScanAll *bool noSmithyDocumentSerde @@ -4995,8 +4782,8 @@ type Order struct { // This member is required. Column *string - // Indicates that the column is sorted in ascending order (== 1), or in descending - // order (==0). + // Indicates that the column is sorted in ascending order ( == 1 ), or in + // descending order ( ==0 ). // // This member is required. SortOrder int32 @@ -5004,8 +4791,8 @@ type Order struct { noSmithyDocumentSerde } -// A structure containing other metadata for a schema version belonging to the same -// metadata key. +// A structure containing other metadata for a schema version belonging to the +// same metadata key. type OtherMetadataValueListItem struct { // The time at which the entry was created. @@ -5088,18 +4875,11 @@ type PartitionIndexDescriptor struct { IndexName *string // The status of the partition index. The possible statuses are: - // - // * CREATING: The - // index is being created. When an index is in a CREATING state, the index or its - // table cannot be deleted. - // - // * ACTIVE: The index creation succeeds. - // - // * FAILED: The - // index creation fails. - // - // * DELETING: The index is deleted from the list of - // indexes. + // - CREATING: The index is being created. When an index is in a CREATING state, + // the index or its table cannot be deleted. + // - ACTIVE: The index creation succeeds. + // - FAILED: The index creation fails. + // - DELETING: The index is deleted from the list of indexes. // // This member is required. IndexStatus PartitionIndexStatus @@ -5132,9 +4912,9 @@ type PartitionInput struct { // Provides information about the physical location where the partition is stored. StorageDescriptor *StorageDescriptor - // The values of the partition. Although this parameter is not required by the SDK, - // you must specify this parameter for a valid input. The values for the keys for - // the new partition must be passed as an array of String objects that must be + // The values of the partition. Although this parameter is not required by the + // SDK, you must specify this parameter for a valid input. The values for the keys + // for the new partition must be passed as an array of String objects that must be // ordered in the same order as the partition keys appearing in the Amazon S3 // prefix. Otherwise Glue will add the values to the wrong keys. Values []string @@ -5262,8 +5042,8 @@ type PostgreSQLCatalogTarget struct { noSmithyDocumentSerde } -// A job run that was used in the predicate of a conditional trigger that triggered -// this job run. +// A job run that was used in the predicate of a conditional trigger that +// triggered this job run. type Predecessor struct { // The name of the job definition used by the predecessor job run. @@ -5318,9 +5098,8 @@ type PropertyPredicate struct { // When crawling an Amazon S3 data source after the first crawl is complete, // specifies whether to crawl the entire dataset again or to crawl only folders // that were added since the last crawler run. For more information, see -// Incremental Crawls in Glue -// (https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) in the -// developer guide. +// Incremental Crawls in Glue (https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) +// in the developer guide. type RecrawlPolicy struct { // Specifies whether to crawl the entire dataset again or to crawl only folders @@ -5626,7 +5405,7 @@ type S3CsvSource struct { // This member is required. Paths []string - // Specifies the character to use for quoting. The default is a double quote: '"'. + // Specifies the character to use for quoting. The default is a double quote: '"' . // Set this to -1 to turn off quoting entirely. // // This member is required. @@ -5642,13 +5421,13 @@ type S3CsvSource struct { AdditionalOptions *S3DirectSourceAdditionalOptions // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). CompressionType CompressionType - // Specifies a character to use for escaping. This option is used only when reading - // CSV files. The default value is none. If enabled, the character which + // Specifies a character to use for escaping. This option is used only when + // reading CSV files. The default value is none . If enabled, the character which // immediately follows is used as-is, except for a small set of well-known escapes - // (\n, \r, \t, and \0). + // ( \n , \r , \t , and \0 ). Escaper *string // A string containing a JSON list of Unix-style glob patterns to exclude. For @@ -5658,7 +5437,7 @@ type S3CsvSource struct { // Grouping files is turned on by default when the input contains more than 50,000 // files. To turn on grouping with fewer than 50,000 files, set this parameter to // "inPartition". To disable grouping when there are more than 50,000 files, set - // this parameter to "none". + // this parameter to "none" . GroupFiles *string // The target group size in bytes. The default is computed based on the input data @@ -5681,12 +5460,12 @@ type S3CsvSource struct { // A Boolean value that specifies whether a single record can span multiple lines. // This can occur when a field contains a quoted new-line character. You must set // this option to True if any record spans multiple lines. The default value is - // False, which allows for more aggressive file-splitting during parsing. + // False , which allows for more aggressive file-splitting during parsing. Multiline *bool - // A Boolean value that specifies whether to use the advanced SIMD CSV reader along - // with Apache Arrow based columnar memory formats. Only available in Glue version - // 3.0. + // A Boolean value that specifies whether to use the advanced SIMD CSV reader + // along with Apache Arrow based columnar memory formats. Only available in Glue + // version 3.0. OptimizePerformance bool // Specifies the data schema for the S3 CSV source. @@ -5697,15 +5476,15 @@ type S3CsvSource struct { Recurse *bool // A Boolean value that specifies whether to skip the first data line. The default - // value is False. + // value is False . SkipFirst *bool // A Boolean value that specifies whether to treat the first line as a header. The - // default value is False. + // default value is False . WithHeader *bool // A Boolean value that specifies whether to write the header to output. The - // default value is True. + // default value is True . WriteHeader *bool noSmithyDocumentSerde @@ -5751,7 +5530,7 @@ type S3DeltaCatalogTarget struct { type S3DeltaDirectTarget struct { // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). // // This member is required. Compression DeltaTargetCompressionType @@ -5856,7 +5635,7 @@ type S3DirectTarget struct { Path *string // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). Compression *string // Specifies native partitioning using a sequence of keys. @@ -5901,7 +5680,7 @@ type S3GlueParquetTarget struct { Path *string // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). Compression ParquetCompressionType // Specifies native partitioning using a sequence of keys. @@ -5959,7 +5738,7 @@ type S3HudiDirectTarget struct { AdditionalOptions map[string]string // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). // // This member is required. Compression HudiTargetCompressionType @@ -6035,7 +5814,7 @@ type S3JsonSource struct { AdditionalOptions *S3DirectSourceAdditionalOptions // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). CompressionType CompressionType // A string containing a JSON list of Unix-style glob patterns to exclude. For @@ -6045,7 +5824,7 @@ type S3JsonSource struct { // Grouping files is turned on by default when the input contains more than 50,000 // files. To turn on grouping with fewer than 50,000 files, set this parameter to // "inPartition". To disable grouping when there are more than 50,000 files, set - // this parameter to "none". + // this parameter to "none" . GroupFiles *string // The target group size in bytes. The default is computed based on the input data @@ -6071,7 +5850,7 @@ type S3JsonSource struct { // A Boolean value that specifies whether a single record can span multiple lines. // This can occur when a field contains a quoted new-line character. You must set // this option to True if any record spans multiple lines. The default value is - // False, which allows for more aggressive file-splitting during parsing. + // False , which allows for more aggressive file-splitting during parsing. Multiline *bool // Specifies the data schema for the S3 JSON source. @@ -6101,7 +5880,7 @@ type S3ParquetSource struct { AdditionalOptions *S3DirectSourceAdditionalOptions // Specifies how the data is compressed. This is generally not necessary if the - // data has a standard file extension. Possible values are "gzip" and "bzip"). + // data has a standard file extension. Possible values are "gzip" and "bzip" ). CompressionType ParquetCompressionType // A string containing a JSON list of Unix-style glob patterns to exclude. For @@ -6111,7 +5890,7 @@ type S3ParquetSource struct { // Grouping files is turned on by default when the input contains more than 50,000 // files. To turn on grouping with fewer than 50,000 files, set this parameter to // "inPartition". To disable grouping when there are more than 50,000 files, set - // this parameter to "none". + // this parameter to "none" . GroupFiles *string // The target group size in bytes. The default is computed based on the input data @@ -6162,15 +5941,15 @@ type S3Target struct { ConnectionName *string // A valid Amazon dead-letter SQS ARN. For example, - // arn:aws:sqs:region:account:deadLetterQueue. + // arn:aws:sqs:region:account:deadLetterQueue . DlqEventQueueArn *string - // A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs. + // A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs . EventQueueArn *string // A list of glob patterns used to exclude from the crawl. For more information, - // see Catalog Tables with a Crawler - // (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). + // see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) + // . Exclusions []string // The path to the Amazon S3 target. @@ -6188,10 +5967,9 @@ type S3Target struct { type Schedule struct { // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . ScheduleExpression *string // The state of the schedule. @@ -6212,9 +5990,9 @@ type SchemaChangePolicy struct { noSmithyDocumentSerde } -// A key-value pair representing a column and data type that this transform can run -// against. The Schema parameter of the MLTransform may contain up to 100 of these -// structures. +// A key-value pair representing a column and data type that this transform can +// run against. The Schema parameter of the MLTransform may contain up to 100 of +// these structures. type SchemaColumn struct { // The type of data in the column. @@ -6232,8 +6010,8 @@ type SchemaId struct { // The name of the schema registry that contains the schema. RegistryName *string - // The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has - // to be provided. + // The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName + // has to be provided. SchemaArn *string // The name of the schema. One of SchemaArn or SchemaName has to be provided. @@ -6386,7 +6164,7 @@ type SelectFields struct { } // Specifies a transform that chooses one DynamicFrame from a collection of -// DynamicFrames. The output is the selected DynamicFrame +// DynamicFrames . The output is the selected DynamicFrame type SelectFromCollection struct { // The index for the DynamicFrame to be selected. @@ -6407,8 +6185,8 @@ type SelectFromCollection struct { noSmithyDocumentSerde } -// Information about a serialization/deserialization program (SerDe) that serves as -// an extractor and loader. +// Information about a serialization/deserialization program (SerDe) that serves +// as an extractor and loader. type SerDeInfo struct { // Name of the SerDe. @@ -6418,7 +6196,7 @@ type SerDeInfo struct { Parameters map[string]string // Usually the class that implements the SerDe. An example is - // org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe. + // org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe . SerializationLibrary *string noSmithyDocumentSerde @@ -6479,15 +6257,15 @@ type SessionCommand struct { // Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'. Name *string - // Specifies the Python version. The Python version indicates the version supported - // for jobs of type Spark. + // Specifies the Python version. The Python version indicates the version + // supported for jobs of type Spark. PythonVersion *string noSmithyDocumentSerde } -// Specifies skewed values in a table. Skewed values are those that occur with very -// high frequency. +// Specifies skewed values in a table. Skewed values are those that occur with +// very high frequency. type SkewedInfo struct { // A list of names of columns that contain skewed values. @@ -6554,8 +6332,8 @@ type SparkConnectorSource struct { // This member is required. ConnectionName *string - // The type of connection, such as marketplace.spark or custom.spark, designating a - // connection to an Apache Spark data store. + // The type of connection, such as marketplace.spark or custom.spark, designating + // a connection to an Apache Spark data store. // // This member is required. ConnectionType *string @@ -6588,8 +6366,8 @@ type SparkConnectorTarget struct { // This member is required. ConnectionName *string - // The type of connection, such as marketplace.spark or custom.spark, designating a - // connection to an Apache Spark data store. + // The type of connection, such as marketplace.spark or custom.spark, designating + // a connection to an Apache Spark data store. // // This member is required. ConnectionType *string @@ -6619,7 +6397,7 @@ type SparkConnectorTarget struct { } // Specifies a transform where you enter a SQL query using Spark SQL syntax to -// transform the data. The output is a single DynamicFrame. +// transform the data. The output is a single DynamicFrame . type SparkSQL struct { // The data inputs identified by their node names. You can associate a table name @@ -6636,8 +6414,8 @@ type SparkSQL struct { // A list of aliases. An alias allows you to specify what name to use in the SQL // for a given input. For example, you have a datasource named "MyDataSource". If - // you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can - // do: select * from SqlName and that gets data from MyDataSource. + // you specify From as MyDataSource, and Alias as SqlName, then in your SQL you + // can do: select * from SqlName and that gets data from MyDataSource. // // This member is required. SqlAliases []SqlAlias @@ -6672,9 +6450,9 @@ type Spigot struct { // This member is required. Path *string - // The probability (a decimal value with a maximum value of 1) of picking any given - // record. A value of 1 indicates that each row read from the dataset should be - // included in the sample output. + // The probability (a decimal value with a maximum value of 1) of picking any + // given record. A value of 1 indicates that each row read from the dataset should + // be included in the sample output. Prob *float64 // Specifies a number of records to write starting from the beginning of the @@ -6684,9 +6462,9 @@ type Spigot struct { noSmithyDocumentSerde } -// Specifies a transform that splits data property keys into two DynamicFrames. The -// output is a collection of DynamicFrames: one with selected data property keys, -// and one with the remaining data property keys. +// Specifies a transform that splits data property keys into two DynamicFrames . +// The output is a collection of DynamicFrames : one with selected data property +// keys, and one with the remaining data property keys. type SplitFields struct { // The data inputs identified by their node names. @@ -6707,7 +6485,7 @@ type SplitFields struct { noSmithyDocumentSerde } -// Represents a single entry in the list of values for SqlAliases. +// Represents a single entry in the list of values for SqlAliases . type SqlAlias struct { // A temporary name given to a table, or a column in a table. @@ -6803,8 +6581,8 @@ type StorageDescriptor struct { // A list of locations that point to the path where a Delta table is located. AdditionalLocations []string - // A list of reducer grouping columns, clustering columns, and bucketing columns in - // the table. + // A list of reducer grouping columns, clustering columns, and bucketing columns + // in the table. BucketColumns []string // A list of the Columns in the table. @@ -6813,7 +6591,7 @@ type StorageDescriptor struct { // True if the data in the table is compressed, or False if not. Compressed bool - // The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a + // The input format: SequenceFileInputFormat (binary), or TextInputFormat , or a // custom format. InputFormat *string @@ -6826,7 +6604,7 @@ type StorageDescriptor struct { NumberOfBuckets int32 // The output format: SequenceFileOutputFormat (binary), or - // IgnoreKeyTextOutputFormat, or a custom format. + // IgnoreKeyTextOutputFormat , or a custom format. OutputFormat *string // The user-supplied properties in key-value form. @@ -6936,7 +6714,7 @@ type Table struct { // A list of columns by which the table is partitioned. Only primitive types are // supported as partition keys. When you create a table used by Amazon Athena, and - // you do not specify any partitionKeys, you must at least set the value of + // you do not specify any partitionKeys , you must at least set the value of // partitionKeys to an empty list. For example: "PartitionKeys": [] PartitionKeys []Column @@ -6951,7 +6729,7 @@ type Table struct { // Other services, such as Athena, may create tables with additional table types. // Glue related table types: EXTERNAL_TABLE Hive compatible attribute - indicates a // non-Hive managed table. GOVERNED Used by Lake Formation. The Glue Data Catalog - // understands GOVERNED. + // understands GOVERNED . TableType *string // A TableIdentifier structure that describes a target table for resource linking. @@ -6968,8 +6746,8 @@ type Table struct { ViewExpandedText *string // Included for Apache Hive compatibility. Not used in the normal course of Glue - // operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded - // in base64. + // operations. If the table is a VIRTUAL_VIEW , certain Athena configuration + // encoded in base64. ViewOriginalText *string noSmithyDocumentSerde @@ -7029,7 +6807,7 @@ type TableInput struct { // A list of columns by which the table is partitioned. Only primitive types are // supported as partition keys. When you create a table used by Amazon Athena, and - // you do not specify any partitionKeys, you must at least set the value of + // you do not specify any partitionKeys , you must at least set the value of // partitionKeys to an empty list. For example: "PartitionKeys": [] PartitionKeys []Column @@ -7044,7 +6822,7 @@ type TableInput struct { // Other services, such as Athena, may create tables with additional table types. // Glue related table types: EXTERNAL_TABLE Hive compatible attribute - indicates a // non-Hive managed table. GOVERNED Used by Lake Formation. The Glue Data Catalog - // understands GOVERNED. + // understands GOVERNED . TableType *string // A TableIdentifier structure that describes a target table for resource linking. @@ -7055,8 +6833,8 @@ type TableInput struct { ViewExpandedText *string // Included for Apache Hive compatibility. Not used in the normal course of Glue - // operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded - // in base64. + // operations. If the table is a VIRTUAL_VIEW , certain Athena configuration + // encoded in base64. ViewOriginalText *string noSmithyDocumentSerde @@ -7167,8 +6945,8 @@ type TaskRunProperties struct { noSmithyDocumentSerde } -// The sorting criteria that are used to sort the list of task runs for the machine -// learning transform. +// The sorting criteria that are used to sort the list of task runs for the +// machine learning transform. type TaskRunSortCriteria struct { // The column to be used to sort the list of task runs for the machine learning @@ -7247,9 +7025,8 @@ type TransformFilterCriteria struct { // This value determines which version of Glue this machine learning transform is // compatible with. Glue 1.0 is recommended for most customers. If the value is not - // set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue - // Versions - // (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) + // set, the Glue compatibility defaults to Glue 0.9. For more information, see + // Glue Versions (https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) // in the developer guide. GlueVersion *string @@ -7285,8 +7062,8 @@ type TransformFilterCriteria struct { type TransformParameters struct { // The type of machine learning transform. For information about the types of - // machine learning transforms, see Creating Machine Learning Transforms - // (https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html). + // machine learning transforms, see Creating Machine Learning Transforms (https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html) + // . // // This member is required. TransformType TransformType @@ -7338,10 +7115,9 @@ type Trigger struct { Predicate *Predicate // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . Schedule *string // The current state of the trigger. @@ -7386,10 +7162,9 @@ type TriggerUpdate struct { Predicate *Predicate // A cron expression used to specify the schedule (see Time-Based Schedules for - // Jobs and Crawlers - // (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, you would specify: cron(15 - // 12 * * ? *). + // Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) + // . For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *) . Schedule *string noSmithyDocumentSerde @@ -7473,10 +7248,10 @@ type UpdateCsvClassifierRequest struct { noSmithyDocumentSerde } -// Specifies a grok classifier to update when passed to UpdateClassifier. +// Specifies a grok classifier to update when passed to UpdateClassifier . type UpdateGrokClassifierRequest struct { - // The name of the GrokClassifier. + // The name of the GrokClassifier . // // This member is required. Name *string @@ -7504,8 +7279,8 @@ type UpdateJsonClassifierRequest struct { // A JsonPath string defining the JSON data for the classifier to classify. Glue // supports a subset of JsonPath, as described in Writing JsonPath Custom - // Classifiers - // (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json). + // Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json) + // . JsonPath *string noSmithyDocumentSerde @@ -7522,10 +7297,10 @@ type UpdateXMLClassifierRequest struct { // An identifier of the data format that the classifier matches. Classification *string - // The XML tag designating the element that contains each record in an XML document - // being parsed. This cannot identify a self-closing element (closed by />). An - // empty row element that contains only attributes can be parsed as long as it ends - // with a closing tag (for example, is okay, but is not). + // The XML tag designating the element that contains each record in an XML + // document being parsed. This cannot identify a self-closing element (closed by /> + // ). An empty row element that contains only attributes can be parsed as long as + // it ends with a closing tag (for example, is okay, but is not). RowTag *string noSmithyDocumentSerde @@ -7546,7 +7321,7 @@ type UpsertRedshiftTargetOptions struct { noSmithyDocumentSerde } -// Represents the equivalent of a Hive user-defined function (UDF) definition. +// Represents the equivalent of a Hive user-defined function ( UDF ) definition. type UserDefinedFunction struct { // The ID of the Data Catalog in which the function resides. @@ -7597,8 +7372,8 @@ type UserDefinedFunctionInput struct { noSmithyDocumentSerde } -// A workflow is a collection of multiple dependent Glue jobs and crawlers that are -// run to complete a complex ETL task. A workflow manages the execution and +// A workflow is a collection of multiple dependent Glue jobs and crawlers that +// are run to complete a complex ETL task. A workflow manages the execution and // monitoring of all its jobs and crawlers. type Workflow struct { @@ -7609,9 +7384,9 @@ type Workflow struct { // The date and time when the workflow was created. CreatedOn *time.Time - // A collection of properties to be used as part of each execution of the workflow. - // The run properties are made available to each job in the workflow. A job can - // modify the properties for the next jobs in the flow. + // A collection of properties to be used as part of each execution of the + // workflow. The run properties are made available to each job in the workflow. A + // job can modify the properties for the next jobs in the flow. DefaultRunProperties map[string]string // A description of the workflow. @@ -7663,7 +7438,7 @@ type WorkflowRun struct { // This error message describes any error that may have occurred in starting the // workflow run. Currently the only error message is "Concurrent runs exceeded for - // workflow: foo." + // workflow: foo ." ErrorMessage *string // The graph representing all the Glue components that belong to the workflow as @@ -7746,10 +7521,10 @@ type XMLClassifier struct { // The time that this classifier was last updated. LastUpdated *time.Time - // The XML tag designating the element that contains each record in an XML document - // being parsed. This can't identify a self-closing element (closed by />). An - // empty row element that contains only attributes can be parsed as long as it ends - // with a closing tag (for example, is okay, but is not). + // The XML tag designating the element that contains each record in an XML + // document being parsed. This can't identify a self-closing element (closed by /> + // ). An empty row element that contains only attributes can be parsed as long as + // it ends with a closing tag (for example, is okay, but is not). RowTag *string // The version of this classifier. diff --git a/service/grafana/api_client.go b/service/grafana/api_client.go index 9749eb01457..6f8f0b45672 100644 --- a/service/grafana/api_client.go +++ b/service/grafana/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/grafana/api_op_AssociateLicense.go b/service/grafana/api_op_AssociateLicense.go index 8117317094a..2cc3e8cf145 100644 --- a/service/grafana/api_op_AssociateLicense.go +++ b/service/grafana/api_op_AssociateLicense.go @@ -12,9 +12,9 @@ import ( ) // Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana -// Enterprise incurs additional fees. For more information, see Upgrade a workspace -// to Grafana Enterprise -// (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html). +// Enterprise incurs additional fees. For more information, see Upgrade a +// workspace to Grafana Enterprise (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html) +// . func (c *Client) AssociateLicense(ctx context.Context, params *AssociateLicenseInput, optFns ...func(*Options)) (*AssociateLicenseOutput, error) { if params == nil { params = &AssociateLicenseInput{} diff --git a/service/grafana/api_op_CreateWorkspace.go b/service/grafana/api_op_CreateWorkspace.go index 9ac1a9f25e9..df50aca8a9c 100644 --- a/service/grafana/api_op_CreateWorkspace.go +++ b/service/grafana/api_op_CreateWorkspace.go @@ -15,8 +15,8 @@ import ( // Creates a workspace. In a workspace, you can create Grafana dashboards and // visualizations to analyze your metrics, logs, and traces. You don't have to // build, package, or deploy any hardware to run the Grafana server. Don't use -// CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace -// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html). +// CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html) +// . func (c *Client) CreateWorkspace(ctx context.Context, params *CreateWorkspaceInput, optFns ...func(*Options)) (*CreateWorkspaceOutput, error) { if params == nil { params = &CreateWorkspaceInput{} @@ -34,10 +34,10 @@ func (c *Client) CreateWorkspace(ctx context.Context, params *CreateWorkspaceInp type CreateWorkspaceInput struct { - // Specifies whether the workspace can access Amazon Web Services resources in this - // Amazon Web Services account only, or whether it can also access Amazon Web + // Specifies whether the workspace can access Amazon Web Services resources in + // this Amazon Web Services account only, or whether it can also access Amazon Web // Services resources in other accounts in the same organization. If you specify - // ORGANIZATION, you must specify which organizational units the workspace can + // ORGANIZATION , you must specify which organizational units the workspace can // access in the workspaceOrganizationalUnits parameter. // // This member is required. @@ -46,25 +46,25 @@ type CreateWorkspaceInput struct { // Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor // to Single Sign-On), or both to authenticate users for using the Grafana console // within a workspace. For more information, see User authentication in Amazon - // Managed Grafana - // (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html). + // Managed Grafana (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) + // . // // This member is required. AuthenticationProviders []types.AuthenticationProviderTypes - // When creating a workspace through the Amazon Web Services API, CLI or Amazon Web - // Services CloudFormation, you must manage IAM roles and provision the permissions - // that the workspace needs to use Amazon Web Services data sources and + // When creating a workspace through the Amazon Web Services API, CLI or Amazon + // Web Services CloudFormation, you must manage IAM roles and provision the + // permissions that the workspace needs to use Amazon Web Services data sources and // notification channels. You must also specify a workspaceRoleArn for a role that // you will manage for the workspace to use when accessing those datasources and // notification channels. The ability for Amazon Managed Grafana to create and // update IAM roles on behalf of the user is supported only in the Amazon Managed - // Grafana console, where this value may be set to SERVICE_MANAGED. Use only the + // Grafana console, where this value may be set to SERVICE_MANAGED . Use only the // CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or // Amazon Web Services CloudFormation. For more information, see Amazon Managed // Grafana permissions and policies for Amazon Web Services data sources and - // notification channels - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html). + // notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) + // . // // This member is required. PermissionType types.PermissionType @@ -73,10 +73,10 @@ type CreateWorkspaceInput struct { // the request. ClientToken *string - // The configuration string for the workspace that you create. For more information - // about the format and configuration options available, see Working in your - // Grafana workspace - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html). + // The configuration string for the workspace that you create. For more + // information about the format and configuration options available, see Working + // in your Grafana workspace (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html) + // . // // This value conforms to the media type: application/json Configuration *string @@ -94,15 +94,15 @@ type CreateWorkspaceInput struct { // an organization. OrganizationRoleName *string - // The name of the CloudFormation stack set to use to generate IAM roles to be used - // for this workspace. + // The name of the CloudFormation stack set to use to generate IAM roles to be + // used for this workspace. StackSetName *string // The list of tags associated with the workspace. Tags map[string]string - // The configuration settings for an Amazon VPC that contains data sources for your - // Grafana workspace to connect to. + // The configuration settings for an Amazon VPC that contains data sources for + // your Grafana workspace to connect to. VpcConfiguration *types.VpcConfiguration // This parameter is for internal use only, and should not be used. diff --git a/service/grafana/api_op_CreateWorkspaceApiKey.go b/service/grafana/api_op_CreateWorkspaceApiKey.go index a5fe9abcbca..ac3c10a1f13 100644 --- a/service/grafana/api_op_CreateWorkspaceApiKey.go +++ b/service/grafana/api_op_CreateWorkspaceApiKey.go @@ -12,8 +12,7 @@ import ( // Creates a Grafana API key for the workspace. This key can be used to // authenticate requests sent to the workspace's HTTP API. See -// https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html -// (https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html) +// https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html (https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html) // for available APIs and example requests. func (c *Client) CreateWorkspaceApiKey(ctx context.Context, params *CreateWorkspaceApiKeyInput, optFns ...func(*Options)) (*CreateWorkspaceApiKeyOutput, error) { if params == nil { @@ -37,13 +36,13 @@ type CreateWorkspaceApiKeyInput struct { // This member is required. KeyName *string - // Specifies the permission level of the key. Valid values: VIEWER|EDITOR|ADMIN + // Specifies the permission level of the key. Valid values: VIEWER | EDITOR | ADMIN // // This member is required. KeyRole *string - // Specifies the time in seconds until the key expires. Keys can be valid for up to - // 30 days. + // Specifies the time in seconds until the key expires. Keys can be valid for up + // to 30 days. // // This member is required. SecondsToLive *int32 @@ -58,8 +57,8 @@ type CreateWorkspaceApiKeyInput struct { type CreateWorkspaceApiKeyOutput struct { - // The key token. Use this value as a bearer token to authenticate HTTP requests to - // the workspace. + // The key token. Use this value as a bearer token to authenticate HTTP requests + // to the workspace. // // This member is required. Key *string diff --git a/service/grafana/api_op_DescribeWorkspaceAuthentication.go b/service/grafana/api_op_DescribeWorkspaceAuthentication.go index 499ef2f0b43..194d8c8ea7a 100644 --- a/service/grafana/api_op_DescribeWorkspaceAuthentication.go +++ b/service/grafana/api_op_DescribeWorkspaceAuthentication.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays information about the authentication methods used in one Amazon Managed -// Grafana workspace. +// Displays information about the authentication methods used in one Amazon +// Managed Grafana workspace. func (c *Client) DescribeWorkspaceAuthentication(ctx context.Context, params *DescribeWorkspaceAuthenticationInput, optFns ...func(*Options)) (*DescribeWorkspaceAuthenticationOutput, error) { if params == nil { params = &DescribeWorkspaceAuthenticationInput{} diff --git a/service/grafana/api_op_DescribeWorkspaceConfiguration.go b/service/grafana/api_op_DescribeWorkspaceConfiguration.go index 79244bf0639..ed53f3ba9ca 100644 --- a/service/grafana/api_op_DescribeWorkspaceConfiguration.go +++ b/service/grafana/api_op_DescribeWorkspaceConfiguration.go @@ -39,9 +39,9 @@ type DescribeWorkspaceConfigurationInput struct { type DescribeWorkspaceConfigurationOutput struct { // The configuration string for the workspace that you requested. For more - // information about the format and configuration options available, see Working in - // your Grafana workspace - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html). + // information about the format and configuration options available, see Working + // in your Grafana workspace (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html) + // . // // This value conforms to the media type: application/json // diff --git a/service/grafana/api_op_ListPermissions.go b/service/grafana/api_op_ListPermissions.go index 420cb254636..26c402a154b 100644 --- a/service/grafana/api_op_ListPermissions.go +++ b/service/grafana/api_op_ListPermissions.go @@ -13,10 +13,10 @@ import ( ) // Lists the users and groups who have the Grafana Admin and Editor roles in this -// workspace. If you use this operation without specifying userId or groupId, the +// workspace. If you use this operation without specifying userId or groupId , the // operation returns the roles of all users and groups. If you specify a userId or -// a groupId, only the roles for that user or group are returned. If you do this, -// you can specify only one userId or one groupId. +// a groupId , only the roles for that user or group are returned. If you do this, +// you can specify only one userId or one groupId . func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) { if params == nil { params = &ListPermissionsInput{} @@ -52,9 +52,9 @@ type ListPermissionsInput struct { // (Optional) Limits the results to only the user that matches this ID. UserId *string - // (Optional) If you specify SSO_USER, then only the permissions of IAM Identity - // Center users are returned. If you specify SSO_GROUP, only the permissions of IAM - // Identity Center groups are returned. + // (Optional) If you specify SSO_USER , then only the permissions of IAM Identity + // Center users are returned. If you specify SSO_GROUP , only the permissions of + // IAM Identity Center groups are returned. UserType types.UserType noSmithyDocumentSerde diff --git a/service/grafana/api_op_ListTagsForResource.go b/service/grafana/api_op_ListTagsForResource.go index d2da1c18f40..e12ce67fef3 100644 --- a/service/grafana/api_op_ListTagsForResource.go +++ b/service/grafana/api_op_ListTagsForResource.go @@ -11,7 +11,7 @@ import ( ) // The ListTagsForResource operation returns the tags that are associated with the -// Amazon Managed Service for Grafana resource specified by the resourceArn. +// Amazon Managed Service for Grafana resource specified by the resourceArn . // Currently, the only resource that can be tagged is a workspace. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/grafana/api_op_ListWorkspaces.go b/service/grafana/api_op_ListWorkspaces.go index 56c001d243d..5cc55852546 100644 --- a/service/grafana/api_op_ListWorkspaces.go +++ b/service/grafana/api_op_ListWorkspaces.go @@ -14,8 +14,8 @@ import ( // Returns a list of Amazon Managed Grafana workspaces in the account, with some // information about each workspace. For more complete information about one -// workspace, use DescribeWorkspace -// (https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html). +// workspace, use DescribeWorkspace (https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html) +// . func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesInput, optFns ...func(*Options)) (*ListWorkspacesOutput, error) { if params == nil { params = &ListWorkspacesInput{} @@ -36,8 +36,8 @@ type ListWorkspacesInput struct { // The maximum number of workspaces to include in the results. MaxResults *int32 - // The token for the next set of workspaces to return. (You receive this token from - // a previous ListWorkspaces operation.) + // The token for the next set of workspaces to return. (You receive this token + // from a previous ListWorkspaces operation.) NextToken *string noSmithyDocumentSerde @@ -45,8 +45,8 @@ type ListWorkspacesInput struct { type ListWorkspacesOutput struct { - // An array of structures that contain some information about the workspaces in the - // account. + // An array of structures that contain some information about the workspaces in + // the account. // // This member is required. Workspaces []types.WorkspaceSummary diff --git a/service/grafana/api_op_UpdateWorkspace.go b/service/grafana/api_op_UpdateWorkspace.go index de751e7881c..6d32de91716 100644 --- a/service/grafana/api_op_UpdateWorkspace.go +++ b/service/grafana/api_op_UpdateWorkspace.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an existing Amazon Managed Grafana workspace. If you use this operation -// and omit any optional parameters, the existing values of those parameters are -// not changed. To modify the user authentication methods that the workspace uses, -// such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication -// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html). -// To modify which users in the workspace have the Admin and Editor Grafana roles, -// use UpdatePermissions -// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html). +// Modifies an existing Amazon Managed Grafana workspace. If you use this +// operation and omit any optional parameters, the existing values of those +// parameters are not changed. To modify the user authentication methods that the +// workspace uses, such as SAML or IAM Identity Center, use +// UpdateWorkspaceAuthentication (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html) +// . To modify which users in the workspace have the Admin and Editor Grafana +// roles, use UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) +// . func (c *Client) UpdateWorkspace(ctx context.Context, params *UpdateWorkspaceInput, optFns ...func(*Options)) (*UpdateWorkspaceOutput, error) { if params == nil { params = &UpdateWorkspaceInput{} @@ -41,10 +41,10 @@ type UpdateWorkspaceInput struct { // This member is required. WorkspaceId *string - // Specifies whether the workspace can access Amazon Web Services resources in this - // Amazon Web Services account only, or whether it can also access Amazon Web + // Specifies whether the workspace can access Amazon Web Services resources in + // this Amazon Web Services account only, or whether it can also access Amazon Web // Services resources in other accounts in the same organization. If you specify - // ORGANIZATION, you must specify which organizational units the workspace can + // ORGANIZATION , you must specify which organizational units the workspace can // access in the workspaceOrganizationalUnits parameter. AccountAccessType types.AccountAccessType @@ -58,32 +58,31 @@ type UpdateWorkspaceInput struct { // The name of an IAM role that already exists to use to access resources through // Organizations. This can only be used with a workspace that has the - // permissionType set to CUSTOMER_MANAGED. + // permissionType set to CUSTOMER_MANAGED . OrganizationRoleName *string // Use this parameter if you want to change a workspace from SERVICE_MANAGED to - // CUSTOMER_MANAGED. This allows you to manage the permissions that the workspace + // CUSTOMER_MANAGED . This allows you to manage the permissions that the workspace // uses to access datasources and notification channels. If the workspace is in a // member Amazon Web Services account of an organization, and that account is not a // delegated administrator account, and you want the workspace to access data // sources in other Amazon Web Services accounts in the organization, you must - // choose CUSTOMER_MANAGED. If you specify this as CUSTOMER_MANAGED, you must also - // specify a workspaceRoleArn that the workspace will use for accessing Amazon Web - // Services resources. For more information on the role and permissions needed, see - // Amazon Managed Grafana permissions and policies for Amazon Web Services data - // sources and notification channels - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) - // Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do - // not include this parameter if you want to leave the workspace as - // SERVICE_MANAGED. You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED - // using the Amazon Managed Grafana console. For more information, see Managing - // permissions for data sources and notification channels - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html). + // choose CUSTOMER_MANAGED . If you specify this as CUSTOMER_MANAGED , you must + // also specify a workspaceRoleArn that the workspace will use for accessing + // Amazon Web Services resources. For more information on the role and permissions + // needed, see Amazon Managed Grafana permissions and policies for Amazon Web + // Services data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) + // Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED . Do + // not include this parameter if you want to leave the workspace as SERVICE_MANAGED + // . You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the + // Amazon Managed Grafana console. For more information, see Managing permissions + // for data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html) + // . PermissionType types.PermissionType // Whether to remove the network access configuration from the workspace. Setting // this to true and providing a networkAccessControl to set will return an error. - // If you remove this configuration by setting this to true, then all IP addresses + // If you remove this configuration by setting this to true , then all IP addresses // and VPC endpoints will be allowed. Standard Grafana authentication and // authorization will still be required. RemoveNetworkAccessConfiguration *bool @@ -92,12 +91,12 @@ type UpdateWorkspaceInput struct { // and providing a vpcConfiguration to set will return an error. RemoveVpcConfiguration *bool - // The name of the CloudFormation stack set to use to generate IAM roles to be used - // for this workspace. + // The name of the CloudFormation stack set to use to generate IAM roles to be + // used for this workspace. StackSetName *string - // The configuration settings for an Amazon VPC that contains data sources for your - // Grafana workspace to connect to. + // The configuration settings for an Amazon VPC that contains data sources for + // your Grafana workspace to connect to. VpcConfiguration *types.VpcConfiguration // This parameter is for internal use only, and should not be used. @@ -123,7 +122,7 @@ type UpdateWorkspaceInput struct { // Specifies an IAM role that grants permissions to Amazon Web Services resources // that the workspace accesses, such as data sources and notification channels. If - // this workspace has permissionTypeCUSTOMER_MANAGED, then this role is required. + // this workspace has permissionType CUSTOMER_MANAGED , then this role is required. WorkspaceRoleArn *string noSmithyDocumentSerde diff --git a/service/grafana/api_op_UpdateWorkspaceAuthentication.go b/service/grafana/api_op_UpdateWorkspaceAuthentication.go index 3379c34ae1d..6e6ef045972 100644 --- a/service/grafana/api_op_UpdateWorkspaceAuthentication.go +++ b/service/grafana/api_op_UpdateWorkspaceAuthentication.go @@ -36,8 +36,8 @@ type UpdateWorkspaceAuthenticationInput struct { // Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor // to Single Sign-On), or both to authenticate users for using the Grafana console // within a workspace. For more information, see User authentication in Amazon - // Managed Grafana - // (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html). + // Managed Grafana (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) + // . // // This member is required. AuthenticationProviders []types.AuthenticationProviderTypes diff --git a/service/grafana/api_op_UpdateWorkspaceConfiguration.go b/service/grafana/api_op_UpdateWorkspaceConfiguration.go index 371c691a9e7..43fcca92578 100644 --- a/service/grafana/api_op_UpdateWorkspaceConfiguration.go +++ b/service/grafana/api_op_UpdateWorkspaceConfiguration.go @@ -30,8 +30,8 @@ type UpdateWorkspaceConfigurationInput struct { // The new configuration string for the workspace. For more information about the // format and configuration options available, see Working in your Grafana - // workspace - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html). + // workspace (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html) + // . // // This value conforms to the media type: application/json // diff --git a/service/grafana/types/enums.go b/service/grafana/types/enums.go index eba960072ab..e66746d5c96 100644 --- a/service/grafana/types/enums.go +++ b/service/grafana/types/enums.go @@ -196,9 +196,9 @@ const ( UpdateActionRevoke UpdateAction = "REVOKE" ) -// Values returns all known values for UpdateAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpdateAction) Values() []UpdateAction { return []UpdateAction{ "ADD", diff --git a/service/grafana/types/types.go b/service/grafana/types/types.go index f57865c1d5e..badb4fe2b98 100644 --- a/service/grafana/types/types.go +++ b/service/grafana/types/types.go @@ -7,8 +7,8 @@ import ( "time" ) -// A structure that defines which attributes in the IdP assertion are to be used to -// define information about the users authenticated by the IdP to use the +// A structure that defines which attributes in the IdP assertion are to be used +// to define information about the users authenticated by the IdP to use the // workspace. type AssertionAttributes struct { @@ -38,13 +38,13 @@ type AssertionAttributes struct { noSmithyDocumentSerde } -// A structure containing information about the user authentication methods used by -// the workspace. +// A structure containing information about the user authentication methods used +// by the workspace. type AuthenticationDescription struct { - // Specifies whether this workspace uses IAM Identity Center, SAML, or both methods - // to authenticate users to use the Grafana console in the Amazon Managed Grafana - // workspace. + // Specifies whether this workspace uses IAM Identity Center, SAML, or both + // methods to authenticate users to use the Grafana console in the Amazon Managed + // Grafana workspace. // // This member is required. Providers []AuthenticationProviderTypes @@ -61,9 +61,9 @@ type AuthenticationDescription struct { noSmithyDocumentSerde } -// A structure that describes whether the workspace uses SAML, IAM Identity Center, -// or both methods for user authentication, and whether that authentication is -// fully configured. +// A structure that describes whether the workspace uses SAML, IAM Identity +// Center, or both methods for user authentication, and whether that authentication +// is fully configured. type AuthenticationSummary struct { // Specifies whether the workspace uses SAML, IAM Identity Center, or both methods @@ -135,9 +135,8 @@ type NetworkAccessConfiguration struct { // the list is not included in the configuration then no IP addresses will be // allowed to access the workspace. You create a prefix list using the Amazon VPC // console. Prefix list IDs have the format pl-1a2b3c4d . For more information - // about prefix lists, see Group CIDR blocks using managed prefix lists - // (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)in - // the Amazon Virtual Private Cloud User Guide. + // about prefix lists, see Group CIDR blocks using managed prefix lists (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) + // in the Amazon Virtual Private Cloud User Guide. // // This member is required. PrefixListIds []string @@ -147,10 +146,9 @@ type NetworkAccessConfiguration struct { // If a NetworkAccessConfiguration is specified then only VPC endpoints specified // here will be allowed to access the workspace. VPC endpoint IDs have the format // vpce-1a2b3c4d . For more information about creating an interface VPC endpoint, - // see Interface VPC endpoints - // (https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) in the - // Amazon Managed Grafana User Guide. The only VPC endpoints that can be specified - // here are interface VPC endpoints for Grafana workspaces (using the + // see Interface VPC endpoints (https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) + // in the Amazon Managed Grafana User Guide. The only VPC endpoints that can be + // specified here are interface VPC endpoints for Grafana workspaces (using the // com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints // will be ignored. // @@ -160,11 +158,11 @@ type NetworkAccessConfiguration struct { noSmithyDocumentSerde } -// A structure containing the identity of one user or group and the Admin, Editor, -// or Viewer role that they have. +// A structure containing the identity of one user or group and the Admin , Editor +// , or Viewer role that they have. type PermissionEntry struct { - // Specifies whether the user or group has the Admin, Editor, or Viewer role. + // Specifies whether the user or group has the Admin , Editor , or Viewer role. // // This member is required. Role Role @@ -239,8 +237,7 @@ type SamlConfiguration struct { } // A structure containing information about one error encountered while performing -// an UpdatePermissions -// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) +// an UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) // operation. type UpdateError struct { @@ -263,8 +260,7 @@ type UpdateError struct { } // Contains the instructions for one Grafana role permission update in a -// UpdatePermissions -// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) +// UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) // operation. type UpdateInstruction struct { @@ -273,7 +269,7 @@ type UpdateInstruction struct { // This member is required. Action UpdateAction - // The role to add or revoke for the user or the group specified in users. + // The role to add or revoke for the user or the group specified in users . // // This member is required. Role Role @@ -320,9 +316,9 @@ type ValidationExceptionField struct { noSmithyDocumentSerde } -// The configuration settings for an Amazon VPC that contains data sources for your -// Grafana workspace to connect to. Provided securityGroupIds and subnetIds must be -// part of the same VPC. +// The configuration settings for an Amazon VPC that contains data sources for +// your Grafana workspace to connect to. Provided securityGroupIds and subnetIds +// must be part of the same VPC. type VpcConfiguration struct { // The list of Amazon EC2 security group IDs attached to the Amazon VPC for your @@ -344,8 +340,8 @@ type VpcConfiguration struct { // your account. type WorkspaceDescription struct { - // A structure that describes whether the workspace uses SAML, IAM Identity Center, - // or both methods for user authentication. + // A structure that describes whether the workspace uses SAML, IAM Identity + // Center, or both methods for user authentication. // // This member is required. Authentication *AuthenticationSummary @@ -355,11 +351,11 @@ type WorkspaceDescription struct { // This member is required. Created *time.Time - // Specifies the Amazon Web Services data sources that have been configured to have - // IAM roles and permissions created to allow Amazon Managed Grafana to read data - // from these sources. This list is only used when the workspace was created + // Specifies the Amazon Web Services data sources that have been configured to + // have IAM roles and permissions created to allow Amazon Managed Grafana to read + // data from these sources. This list is only used when the workspace was created // through the Amazon Web Services console, and the permissionType is - // SERVICE_MANAGED. + // SERVICE_MANAGED . // // This member is required. DataSources []DataSourceType @@ -389,10 +385,10 @@ type WorkspaceDescription struct { // This member is required. Status WorkspaceStatus - // Specifies whether the workspace can access Amazon Web Services resources in this - // Amazon Web Services account only, or whether it can also access Amazon Web + // Specifies whether the workspace can access Amazon Web Services resources in + // this Amazon Web Services account only, or whether it can also access Amazon Web // Services resources in other accounts in the same organization. If this is - // ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which + // ORGANIZATION , the workspaceOrganizationalUnits parameter specifies which // organizational units the workspace can access. AccountAccessType AccountAccessType @@ -407,12 +403,12 @@ type WorkspaceDescription struct { // this value specifies when that free trial ends. FreeTrialExpiration *time.Time - // If this workspace has a full Grafana Enterprise license, this specifies when the - // license ends and will need to be renewed. + // If this workspace has a full Grafana Enterprise license, this specifies when + // the license ends and will need to be renewed. LicenseExpiration *time.Time - // Specifies whether this workspace has a full Grafana Enterprise license or a free - // trial license. + // Specifies whether this workspace has a full Grafana Enterprise license or a + // free trial license. LicenseType LicenseType // The name of the workspace. @@ -434,22 +430,20 @@ type WorkspaceDescription struct { // organization. OrganizationalUnits []string - // If this is SERVICE_MANAGED, and the workplace was created through the Amazon + // If this is SERVICE_MANAGED , and the workplace was created through the Amazon // Managed Grafana console, then Amazon Managed Grafana automatically creates the // IAM roles and provisions the permissions that the workspace needs to use Amazon - // Web Services data sources and notification channels. If this is - // CUSTOMER_MANAGED, you must manage those roles and permissions yourself. If you - // are working with a workspace in a member account of an organization and that - // account is not a delegated administrator account, and you want the workspace to - // access data sources in other Amazon Web Services accounts in the organization, - // this parameter must be set to CUSTOMER_MANAGED. For more information about + // Web Services data sources and notification channels. If this is CUSTOMER_MANAGED + // , you must manage those roles and permissions yourself. If you are working with + // a workspace in a member account of an organization and that account is not a + // delegated administrator account, and you want the workspace to access data + // sources in other Amazon Web Services accounts in the organization, this + // parameter must be set to CUSTOMER_MANAGED . For more information about // converting between customer and service managed, see Managing permissions for - // data sources and notification channels - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html). - // For more information about the roles and permissions that must be managed for - // customer managed workspaces, see Amazon Managed Grafana permissions and policies - // for Amazon Web Services data sources and notification channels - // (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) + // data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html) + // . For more information about the roles and permissions that must be managed for + // customer managed workspaces, see Amazon Managed Grafana permissions and + // policies for Amazon Web Services data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) PermissionType PermissionType // The name of the CloudFormation stack set that is used to generate IAM roles to diff --git a/service/greengrass/api_client.go b/service/greengrass/api_client.go index 76eeed19c2f..5c0d1776838 100644 --- a/service/greengrass/api_client.go +++ b/service/greengrass/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/greengrass/api_op_AssociateRoleToGroup.go b/service/greengrass/api_op_AssociateRoleToGroup.go index dbf3ff4fe11..8c212cef609 100644 --- a/service/greengrass/api_op_AssociateRoleToGroup.go +++ b/service/greengrass/api_op_AssociateRoleToGroup.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a role with a group. Your Greengrass core will use the role to access -// AWS cloud services. The role's permissions should allow Greengrass core Lambda -// functions to perform actions against the cloud. +// Associates a role with a group. Your Greengrass core will use the role to +// access AWS cloud services. The role's permissions should allow Greengrass core +// Lambda functions to perform actions against the cloud. func (c *Client) AssociateRoleToGroup(ctx context.Context, params *AssociateRoleToGroupInput, optFns ...func(*Options)) (*AssociateRoleToGroupOutput, error) { if params == nil { params = &AssociateRoleToGroupInput{} @@ -46,8 +46,8 @@ type AssociateRoleToGroupInput struct { type AssociateRoleToGroupOutput struct { - // The time, in milliseconds since the epoch, when the role ARN was associated with - // the group. + // The time, in milliseconds since the epoch, when the role ARN was associated + // with the group. AssociatedAt *string // Metadata pertaining to the operation's result. diff --git a/service/greengrass/api_op_CreateCoreDefinitionVersion.go b/service/greengrass/api_op_CreateCoreDefinitionVersion.go index f99774761d0..9f4e939b328 100644 --- a/service/greengrass/api_op_CreateCoreDefinitionVersion.go +++ b/service/greengrass/api_op_CreateCoreDefinitionVersion.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a version of a core definition that has already been defined. Greengrass -// groups must each contain exactly one Greengrass core. +// Creates a version of a core definition that has already been defined. +// Greengrass groups must each contain exactly one Greengrass core. func (c *Client) CreateCoreDefinitionVersion(ctx context.Context, params *CreateCoreDefinitionVersionInput, optFns ...func(*Options)) (*CreateCoreDefinitionVersionOutput, error) { if params == nil { params = &CreateCoreDefinitionVersionInput{} diff --git a/service/greengrass/api_op_CreateResourceDefinition.go b/service/greengrass/api_op_CreateResourceDefinition.go index d7ff2ae856f..462d1627618 100644 --- a/service/greengrass/api_op_CreateResourceDefinition.go +++ b/service/greengrass/api_op_CreateResourceDefinition.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a resource definition which contains a list of resources to be used in a -// group. You can create an initial version of the definition by providing a list +// Creates a resource definition which contains a list of resources to be used in +// a group. You can create an initial version of the definition by providing a list // of resources now, or use ”CreateResourceDefinitionVersion” later. func (c *Client) CreateResourceDefinition(ctx context.Context, params *CreateResourceDefinitionInput, optFns ...func(*Options)) (*CreateResourceDefinitionOutput, error) { if params == nil { diff --git a/service/greengrass/api_op_CreateSoftwareUpdateJob.go b/service/greengrass/api_op_CreateSoftwareUpdateJob.go index eec9d0b3506..e011c55f411 100644 --- a/service/greengrass/api_op_CreateSoftwareUpdateJob.go +++ b/service/greengrass/api_op_CreateSoftwareUpdateJob.go @@ -32,8 +32,8 @@ func (c *Client) CreateSoftwareUpdateJob(ctx context.Context, params *CreateSoft type CreateSoftwareUpdateJobInput struct { - // The IAM Role that Greengrass will use to create pre-signed URLs pointing towards - // the update artifact. + // The IAM Role that Greengrass will use to create pre-signed URLs pointing + // towards the update artifact. // // This member is required. S3UrlSignerRole *string diff --git a/service/greengrass/api_op_GetConnectorDefinitionVersion.go b/service/greengrass/api_op_GetConnectorDefinitionVersion.go index a927bf39c5a..5e7aec18244 100644 --- a/service/greengrass/api_op_GetConnectorDefinitionVersion.go +++ b/service/greengrass/api_op_GetConnectorDefinitionVersion.go @@ -59,8 +59,8 @@ type GetConnectorDefinitionVersionOutput struct { // The ARN of the connector definition version. Arn *string - // The time, in milliseconds since the epoch, when the connector definition version - // was created. + // The time, in milliseconds since the epoch, when the connector definition + // version was created. CreationTimestamp *string // Information about the connector definition version. diff --git a/service/greengrass/api_op_GetFunctionDefinition.go b/service/greengrass/api_op_GetFunctionDefinition.go index 019f845de2f..b0f59efa8f6 100644 --- a/service/greengrass/api_op_GetFunctionDefinition.go +++ b/service/greengrass/api_op_GetFunctionDefinition.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a Lambda function definition, including its creation -// time and latest version. +// Retrieves information about a Lambda function definition, including its +// creation time and latest version. func (c *Client) GetFunctionDefinition(ctx context.Context, params *GetFunctionDefinitionInput, optFns ...func(*Options)) (*GetFunctionDefinitionOutput, error) { if params == nil { params = &GetFunctionDefinitionInput{} diff --git a/service/greengrass/api_op_StartBulkDeployment.go b/service/greengrass/api_op_StartBulkDeployment.go index a6ed7a17472..add991f6db6 100644 --- a/service/greengrass/api_op_StartBulkDeployment.go +++ b/service/greengrass/api_op_StartBulkDeployment.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deploys multiple groups in one operation. This action starts the bulk deployment -// of a specified set of group versions. Each group version deployment will be -// triggered with an adaptive rate that has a fixed upper limit. We recommend that -// you include an ”X-Amzn-Client-Token” token in every ”StartBulkDeployment” -// request. These requests are idempotent with respect to the token and the request -// parameters. +// Deploys multiple groups in one operation. This action starts the bulk +// deployment of a specified set of group versions. Each group version deployment +// will be triggered with an adaptive rate that has a fixed upper limit. We +// recommend that you include an ”X-Amzn-Client-Token” token in every +// ”StartBulkDeployment” request. These requests are idempotent with respect to +// the token and the request parameters. func (c *Client) StartBulkDeployment(ctx context.Context, params *StartBulkDeploymentInput, optFns ...func(*Options)) (*StartBulkDeploymentOutput, error) { if params == nil { params = &StartBulkDeploymentInput{} diff --git a/service/greengrass/types/enums.go b/service/greengrass/types/enums.go index caa396ba85a..f13eb8b09e6 100644 --- a/service/greengrass/types/enums.go +++ b/service/greengrass/types/enums.go @@ -76,9 +76,9 @@ const ( EncodingTypeJson EncodingType = "json" ) -// Values returns all known values for EncodingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EncodingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EncodingType) Values() []EncodingType { return []EncodingType{ "binary", @@ -94,8 +94,8 @@ const ( FunctionIsolationModeNoContainer FunctionIsolationMode = "NoContainer" ) -// Values returns all known values for FunctionIsolationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FunctionIsolationMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FunctionIsolationMode) Values() []FunctionIsolationMode { return []FunctionIsolationMode{ @@ -208,9 +208,9 @@ const ( TelemetryOff Telemetry = "Off" ) -// Values returns all known values for Telemetry. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Telemetry. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Telemetry) Values() []Telemetry { return []Telemetry{ "On", @@ -280,9 +280,10 @@ const ( UpdateTargetsOperatingSystemOpenwrt UpdateTargetsOperatingSystem = "openwrt" ) -// Values returns all known values for UpdateTargetsOperatingSystem. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateTargetsOperatingSystem. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (UpdateTargetsOperatingSystem) Values() []UpdateTargetsOperatingSystem { return []UpdateTargetsOperatingSystem{ "ubuntu", diff --git a/service/greengrass/types/types.go b/service/greengrass/types/types.go index 14a87076951..5a1fa9470a5 100644 --- a/service/greengrass/types/types.go +++ b/service/greengrass/types/types.go @@ -93,9 +93,9 @@ type ConnectivityInfo struct { noSmithyDocumentSerde } -// Information about a connector. Connectors run on the Greengrass core and contain -// built-in integration with local infrastructure, device protocols, AWS, and other -// cloud services. +// Information about a connector. Connectors run on the Greengrass core and +// contain built-in integration with local infrastructure, device protocols, AWS, +// and other cloud services. type Connector struct { // The ARN of the connector. @@ -135,8 +135,8 @@ type Core struct { // This member is required. CertificateArn *string - // A descriptive or arbitrary ID for the core. This value must be unique within the - // core definition version. Max length is 128 characters with pattern + // A descriptive or arbitrary ID for the core. This value must be unique within + // the core definition version. Max length is 128 characters with pattern // ''[a-zA-Z0-9:_-]+''. // // This member is required. @@ -263,9 +263,9 @@ type ErrorDetail struct { // Information about a Lambda function. type Function struct { - // A descriptive or arbitrary ID for the function. This value must be unique within - // the function definition version. Max length is 128 characters with pattern - // ''[a-zA-Z0-9:_-]+''. + // A descriptive or arbitrary ID for the function. This value must be unique + // within the function definition version. Max length is 128 characters with + // pattern ''[a-zA-Z0-9:_-]+''. // // This member is required. Id *string @@ -282,8 +282,8 @@ type Function struct { // The configuration of the Lambda function. type FunctionConfiguration struct { - // The expected encoding type of the input payload for the function. The default is - // ''json''. + // The expected encoding type of the input payload for the function. The default + // is ''json''. EncodingType EncodingType // The environment configuration of the function. @@ -521,8 +521,8 @@ type LocalVolumeResourceData struct { // The absolute local path of the resource inside the Lambda environment. DestinationPath *string - // Allows you to configure additional group privileges for the Lambda process. This - // field is optional. + // Allows you to configure additional group privileges for the Lambda process. + // This field is optional. GroupOwnerSetting *GroupOwnerSetting // The local absolute path of the volume resource on the host. The source path for @@ -601,8 +601,8 @@ type Resource struct { // A policy used by the function to access a resource. type ResourceAccessPolicy struct { - // The ID of the resource. (This ID is assigned to the resource when you create the - // resource definiton.) + // The ID of the resource. (This ID is assigned to the resource when you create + // the resource definiton.) // // This member is required. ResourceId *string @@ -684,8 +684,8 @@ type S3MachineLearningModelResourceData struct { // The owner setting for downloaded machine learning resources. OwnerSetting *ResourceDownloadOwnerSetting - // The URI of the source model in an S3 bucket. The model package must be in tar.gz - // or .zip format. + // The URI of the source model in an S3 bucket. The model package must be in + // tar.gz or .zip format. S3Uri *string noSmithyDocumentSerde diff --git a/service/greengrassv2/api_client.go b/service/greengrassv2/api_client.go index b5a4b294045..3cd15b93c49 100644 --- a/service/greengrassv2/api_client.go +++ b/service/greengrassv2/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go b/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go index 48e1dff63bb..2d1a28b37af 100644 --- a/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go +++ b/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go @@ -14,12 +14,10 @@ import ( // Services account in this Amazon Web Services Region. IoT Greengrass uses this // role to verify the identity of client devices and manage core device // connectivity information. The role must include the -// AWSGreengrassResourceAccessRolePolicy -// (https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy) +// AWSGreengrassResourceAccessRolePolicy (https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy) // managed policy or a custom policy that defines equivalent permissions for the // IoT Greengrass features that you use. For more information, see Greengrass -// service role -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) +// service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) // in the IoT Greengrass Version 2 Developer Guide. func (c *Client) AssociateServiceRoleToAccount(ctx context.Context, params *AssociateServiceRoleToAccountInput, optFns ...func(*Options)) (*AssociateServiceRoleToAccountOutput, error) { if params == nil { diff --git a/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go b/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go index 34e33ab2753..3957f91ce24 100644 --- a/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go +++ b/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go @@ -15,14 +15,12 @@ import ( // to specify which client devices can discover a core device through cloud // discovery. With cloud discovery, client devices connect to IoT Greengrass to // retrieve associated core devices' connectivity information and certificates. For -// more information, see Configure cloud discovery -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html) +// more information, see Configure cloud discovery (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html) // in the IoT Greengrass V2 Developer Guide. Client devices are local IoT devices // that connect to and communicate with an IoT Greengrass core device over MQTT. // You can connect client devices to a core device to sync MQTT messages and data // to Amazon Web Services IoT Core and interact with client devices in Greengrass -// components. For more information, see Interact with local IoT devices -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) +// components. For more information, see Interact with local IoT devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) // in the IoT Greengrass V2 Developer Guide. func (c *Client) BatchAssociateClientDeviceWithCoreDevice(ctx context.Context, params *BatchAssociateClientDeviceWithCoreDeviceInput, optFns ...func(*Options)) (*BatchAssociateClientDeviceWithCoreDeviceOutput, error) { if params == nil { @@ -54,8 +52,8 @@ type BatchAssociateClientDeviceWithCoreDeviceInput struct { type BatchAssociateClientDeviceWithCoreDeviceOutput struct { - // The list of any errors for the entries in the request. Each error entry contains - // the name of the IoT thing that failed to associate. + // The list of any errors for the entries in the request. Each error entry + // contains the name of the IoT thing that failed to associate. ErrorEntries []types.AssociateClientDeviceWithCoreDeviceErrorEntry // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_BatchDisassociateClientDeviceFromCoreDevice.go b/service/greengrassv2/api_op_BatchDisassociateClientDeviceFromCoreDevice.go index df996ccbcf1..9d45bd14d48 100644 --- a/service/greengrassv2/api_op_BatchDisassociateClientDeviceFromCoreDevice.go +++ b/service/greengrassv2/api_op_BatchDisassociateClientDeviceFromCoreDevice.go @@ -45,8 +45,8 @@ type BatchDisassociateClientDeviceFromCoreDeviceInput struct { type BatchDisassociateClientDeviceFromCoreDeviceOutput struct { - // The list of any errors for the entries in the request. Each error entry contains - // the name of the IoT thing that failed to disassociate. + // The list of any errors for the entries in the request. Each error entry + // contains the name of the IoT thing that failed to disassociate. ErrorEntries []types.DisassociateClientDeviceFromCoreDeviceErrorEntry // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_CreateComponentVersion.go b/service/greengrassv2/api_op_CreateComponentVersion.go index 1d4f9040d29..938074a3b06 100644 --- a/service/greengrassv2/api_op_CreateComponentVersion.go +++ b/service/greengrassv2/api_op_CreateComponentVersion.go @@ -18,46 +18,28 @@ import ( // this operation to upload your component to IoT Greengrass. Then, you can deploy // the component to other core devices. You can use this operation to do the // following: -// -// * Create components from recipes Create a component from a recipe, -// which is a file that defines the component's metadata, parameters, dependencies, -// lifecycle, artifacts, and platform capability. For more information, see IoT -// Greengrass component recipe reference -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) -// in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, -// specify inlineRecipe when you call this operation. -// -// * Create components from -// Lambda functions Create a component from an Lambda function that runs on IoT -// Greengrass. This creates a recipe and artifacts from the Lambda function's -// deployment package. You can use this operation to migrate Lambda functions from -// IoT Greengrass V1 to IoT Greengrass V2. This function only accepts Lambda -// functions that use the following runtimes: -// -// * Python 2.7 – python2.7 -// -// * Python -// 3.7 – python3.7 -// -// * Python 3.8 – python3.8 -// -// * Python 3.9 – python3.9 -// -// * Java 8 – -// java8 -// -// * Java 11 – java11 -// -// * Node.js 10 – nodejs10.x -// -// * Node.js 12 – -// nodejs12.x -// -// * Node.js 14 – nodejs14.x -// -// To create a component from a Lambda -// function, specify lambdaFunction when you call this operation. IoT Greengrass -// currently supports Lambda functions on only Linux core devices. +// - Create components from recipes Create a component from a recipe, which is a +// file that defines the component's metadata, parameters, dependencies, lifecycle, +// artifacts, and platform capability. For more information, see IoT Greengrass +// component recipe reference (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) +// in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, +// specify inlineRecipe when you call this operation. +// - Create components from Lambda functions Create a component from an Lambda +// function that runs on IoT Greengrass. This creates a recipe and artifacts from +// the Lambda function's deployment package. You can use this operation to migrate +// Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function only +// accepts Lambda functions that use the following runtimes: +// - Python 2.7 – python2.7 +// - Python 3.7 – python3.7 +// - Python 3.8 – python3.8 +// - Python 3.9 – python3.9 +// - Java 8 – java8 +// - Java 11 – java11 +// - Node.js 10 – nodejs10.x +// - Node.js 12 – nodejs12.x +// - Node.js 14 – nodejs14.x To create a component from a Lambda function, +// specify lambdaFunction when you call this operation. IoT Greengrass currently +// supports Lambda functions on only Linux core devices. func (c *Client) CreateComponentVersion(ctx context.Context, params *CreateComponentVersionInput, optFns ...func(*Options)) (*CreateComponentVersionOutput, error) { if params == nil { params = &CreateComponentVersionInput{} @@ -86,17 +68,16 @@ type CreateComponentVersionInput struct { // The recipe to use to create the component. The recipe defines the component's // metadata, parameters, dependencies, lifecycle, artifacts, and platform - // compatibility. You must specify either inlineRecipe or lambdaFunction. + // compatibility. You must specify either inlineRecipe or lambdaFunction . InlineRecipe []byte // The parameters to create a component from a Lambda function. You must specify - // either inlineRecipe or lambdaFunction. + // either inlineRecipe or lambdaFunction . LambdaFunction *types.LambdaFunctionRecipeSource // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string noSmithyDocumentSerde @@ -125,9 +106,8 @@ type CreateComponentVersionOutput struct { // This member is required. Status *types.CloudComponentStatus - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_CreateDeployment.go b/service/greengrassv2/api_op_CreateDeployment.go index 391dd343d8b..0124d0ce940 100644 --- a/service/greengrassv2/api_op_CreateDeployment.go +++ b/service/greengrassv2/api_op_CreateDeployment.go @@ -21,8 +21,7 @@ import ( // devices. Every deployment has a revision number that indicates how many // deployment revisions you define for a target. Use this operation to create a new // revision of an existing deployment. For more information, see the Create -// deployments -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) +// deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) // in the IoT Greengrass V2 Developer Guide. func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { @@ -41,9 +40,8 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI type CreateDeploymentInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the target IoT thing or thing group. When creating a subdeployment, the + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the target IoT thing or thing group. When creating a subdeployment, the // targetARN can only be a thing group. // // This member is required. @@ -75,15 +73,13 @@ type CreateDeploymentInput struct { // configuration. IotJobConfiguration *types.DeploymentIoTJobConfiguration - // The parent deployment's target ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // The parent deployment's target ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // within a subdeployment. ParentTargetArn *string // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string noSmithyDocumentSerde @@ -94,9 +90,8 @@ type CreateDeploymentOutput struct { // The ID of the deployment. DeploymentId *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IoT job that applies the deployment to target devices. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IoT job that applies the deployment to target devices. IotJobArn *string // The ID of the IoT job that applies the deployment to target devices. diff --git a/service/greengrassv2/api_op_DeleteComponent.go b/service/greengrassv2/api_op_DeleteComponent.go index 510773c8ae6..93e6237665c 100644 --- a/service/greengrassv2/api_op_DeleteComponent.go +++ b/service/greengrassv2/api_op_DeleteComponent.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a version of a component from IoT Greengrass. This operation deletes the -// component's recipe and artifacts. As a result, deployments that refer to this -// component version will fail. If you have deployments that use this component -// version, you can remove the component from the deployment or update the -// deployment to use a valid version. +// Deletes a version of a component from IoT Greengrass. This operation deletes +// the component's recipe and artifacts. As a result, deployments that refer to +// this component version will fail. If you have deployments that use this +// component version, you can remove the component from the deployment or update +// the deployment to use a valid version. func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInput, optFns ...func(*Options)) (*DeleteComponentOutput, error) { if params == nil { params = &DeleteComponentInput{} @@ -32,9 +32,8 @@ func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInp type DeleteComponentInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. // // This member is required. Arn *string diff --git a/service/greengrassv2/api_op_DeleteCoreDevice.go b/service/greengrassv2/api_op_DeleteCoreDevice.go index ca1d90b36e8..c3cd03db14d 100644 --- a/service/greengrassv2/api_op_DeleteCoreDevice.go +++ b/service/greengrassv2/api_op_DeleteCoreDevice.go @@ -13,9 +13,8 @@ import ( // Deletes a Greengrass core device, which is an IoT thing. This operation removes // the core device from the list of core devices. This operation doesn't delete the // IoT thing. For more information about how to delete the IoT thing, see -// DeleteThing -// (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) in -// the IoT API Reference. +// DeleteThing (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) +// in the IoT API Reference. func (c *Client) DeleteCoreDevice(ctx context.Context, params *DeleteCoreDeviceInput, optFns ...func(*Options)) (*DeleteCoreDeviceOutput, error) { if params == nil { params = &DeleteCoreDeviceInput{} diff --git a/service/greengrassv2/api_op_DeleteDeployment.go b/service/greengrassv2/api_op_DeleteDeployment.go index 1db50275d13..891c4d6f8a3 100644 --- a/service/greengrassv2/api_op_DeleteDeployment.go +++ b/service/greengrassv2/api_op_DeleteDeployment.go @@ -11,9 +11,8 @@ import ( ) // Deletes a deployment. To delete an active deployment, you must first cancel it. -// For more information, see CancelDeployment -// (https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html). -// Deleting a deployment doesn't affect core devices that run that deployment, +// For more information, see CancelDeployment (https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html) +// . Deleting a deployment doesn't affect core devices that run that deployment, // because core devices store the deployment's configuration on the device. // Additionally, core devices can roll back to a previous deployment that has been // deleted. diff --git a/service/greengrassv2/api_op_DescribeComponent.go b/service/greengrassv2/api_op_DescribeComponent.go index 32e51d33d41..167301484fe 100644 --- a/service/greengrassv2/api_op_DescribeComponent.go +++ b/service/greengrassv2/api_op_DescribeComponent.go @@ -30,9 +30,8 @@ func (c *Client) DescribeComponent(ctx context.Context, params *DescribeComponen type DescribeComponentInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. // // This member is required. Arn *string @@ -42,9 +41,8 @@ type DescribeComponentInput struct { type DescribeComponentOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // The name of the component. @@ -70,9 +68,8 @@ type DescribeComponentOutput struct { Status *types.CloudComponentStatus // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go b/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go index a0dad5c0e70..c6e687355a8 100644 --- a/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go +++ b/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go @@ -13,8 +13,7 @@ import ( // Disassociates the Greengrass service role from IoT Greengrass for your Amazon // Web Services account in this Amazon Web Services Region. Without a service role, // IoT Greengrass can't verify the identity of client devices or manage core device -// connectivity information. For more information, see Greengrass service role -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) +// connectivity information. For more information, see Greengrass service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) // in the IoT Greengrass Version 2 Developer Guide. func (c *Client) DisassociateServiceRoleFromAccount(ctx context.Context, params *DisassociateServiceRoleFromAccountInput, optFns ...func(*Options)) (*DisassociateServiceRoleFromAccountOutput, error) { if params == nil { diff --git a/service/greengrassv2/api_op_GetComponent.go b/service/greengrassv2/api_op_GetComponent.go index 8ae73e0d72c..65e043d8d5d 100644 --- a/service/greengrassv2/api_op_GetComponent.go +++ b/service/greengrassv2/api_op_GetComponent.go @@ -29,9 +29,8 @@ func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, op type GetComponentInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. // // This member is required. Arn *string @@ -55,9 +54,8 @@ type GetComponentOutput struct { RecipeOutputFormat types.RecipeOutputFormat // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_GetComponentVersionArtifact.go b/service/greengrassv2/api_op_GetComponentVersionArtifact.go index 6f74eed6971..cdad90906d4 100644 --- a/service/greengrassv2/api_op_GetComponentVersionArtifact.go +++ b/service/greengrassv2/api_op_GetComponentVersionArtifact.go @@ -30,20 +30,18 @@ func (c *Client) GetComponentVersionArtifact(ctx context.Context, params *GetCom type GetComponentVersionArtifactInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. Specify the ARN of a public or a Lambda component + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Specify the ARN of a public or a Lambda component // version. // // This member is required. Arn *string - // The name of the artifact. You can use the GetComponent - // (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html) + // The name of the artifact. You can use the GetComponent (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html) // operation to download the component recipe, which includes the URI of the // artifact. The artifact name is the section of the URI after the scheme. For - // example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is - // SomeArtifact.zip. + // example, in the artifact URI greengrass:SomeArtifact.zip , the artifact name is + // SomeArtifact.zip . // // This member is required. ArtifactName *string diff --git a/service/greengrassv2/api_op_GetConnectivityInfo.go b/service/greengrassv2/api_op_GetConnectivityInfo.go index b25ecdb7895..eb501d3a453 100644 --- a/service/greengrassv2/api_op_GetConnectivityInfo.go +++ b/service/greengrassv2/api_op_GetConnectivityInfo.go @@ -14,12 +14,10 @@ import ( // Retrieves connectivity information for a Greengrass core device. Connectivity // information includes endpoints and ports where client devices can connect to an // MQTT broker on the core device. When a client device calls the IoT Greengrass -// discovery API -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html), -// IoT Greengrass returns connectivity information for all of the core devices +// discovery API (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html) +// , IoT Greengrass returns connectivity information for all of the core devices // where the client device can connect. For more information, see Connect client -// devices to core devices -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) +// devices to core devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) // in the IoT Greengrass Version 2 Developer Guide. func (c *Client) GetConnectivityInfo(ctx context.Context, params *GetConnectivityInfoInput, optFns ...func(*Options)) (*GetConnectivityInfoOutput, error) { if params == nil { diff --git a/service/greengrassv2/api_op_GetCoreDevice.go b/service/greengrassv2/api_op_GetCoreDevice.go index 9e315887553..45f253c5fc8 100644 --- a/service/greengrassv2/api_op_GetCoreDevice.go +++ b/service/greengrassv2/api_op_GetCoreDevice.go @@ -19,22 +19,14 @@ import ( // device might not reflect its current status. The status timestamp indicates when // the device status was last updated. Core devices send status updates at the // following times: -// -// * When the IoT Greengrass Core software starts -// -// * When the -// core device receives a deployment from the Amazon Web Services Cloud -// -// * When the -// status of any component on the core device becomes BROKEN -// -// * At a regular -// interval that you can configure -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss), -// which defaults to 24 hours -// -// * For IoT Greengrass Core v2.7.0, the core device -// sends status updates upon local deployment and cloud deployment +// - When the IoT Greengrass Core software starts +// - When the core device receives a deployment from the Amazon Web Services +// Cloud +// - When the status of any component on the core device becomes BROKEN +// - At a regular interval that you can configure (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss) +// , which defaults to 24 hours +// - For IoT Greengrass Core v2.7.0, the core device sends status updates upon +// local deployment and cloud deployment func (c *Client) GetCoreDevice(ctx context.Context, params *GetCoreDeviceInput, optFns ...func(*Options)) (*GetCoreDeviceOutput, error) { if params == nil { params = &GetCoreDeviceInput{} @@ -71,8 +63,7 @@ type GetCoreDeviceOutput struct { // The version of the IoT Greengrass Core software that the core device runs. This // version is equivalent to the version of the Greengrass nucleus component that // runs on the core device. For more information, see the Greengrass nucleus - // component - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) + // component (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) // in the IoT Greengrass V2 Developer Guide. CoreVersion *string @@ -84,19 +75,15 @@ type GetCoreDeviceOutput struct { Platform *string // The status of the core device. The core device status can be: - // - // * HEALTHY – The - // IoT Greengrass Core software and all components run on the core device without - // issue. - // - // * UNHEALTHY – The IoT Greengrass Core software or a component is in a - // failed state on the core device. + // - HEALTHY – The IoT Greengrass Core software and all components run on the + // core device without issue. + // - UNHEALTHY – The IoT Greengrass Core software or a component is in a failed + // state on the core device. Status types.CoreDeviceStatus // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_GetDeployment.go b/service/greengrassv2/api_op_GetDeployment.go index 5329bc93787..24922a94d02 100644 --- a/service/greengrassv2/api_op_GetDeployment.go +++ b/service/greengrassv2/api_op_GetDeployment.go @@ -12,8 +12,8 @@ import ( "time" ) -// Gets a deployment. Deployments define the components that run on Greengrass core -// devices. +// Gets a deployment. Deployments define the components that run on Greengrass +// core devices. func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error) { if params == nil { params = &GetDeploymentInput{} @@ -62,9 +62,8 @@ type GetDeploymentOutput struct { // The status of the deployment. DeploymentStatus types.DeploymentStatus - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IoT job that applies the deployment to target devices. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IoT job that applies the deployment to target devices. IotJobArn *string // The job configuration for the deployment configuration. The job configuration @@ -78,8 +77,7 @@ type GetDeploymentOutput struct { // Whether or not the deployment is the latest revision for its target. IsLatestForTarget bool - // The parent deployment's target ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // The parent deployment's target ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // within a subdeployment. ParentTargetArn *string @@ -87,14 +85,12 @@ type GetDeploymentOutput struct { RevisionId *string // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the target IoT thing or thing group. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the target IoT thing or thing group. TargetArn *string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_GetServiceRoleForAccount.go b/service/greengrassv2/api_op_GetServiceRoleForAccount.go index 2509bb5564a..e81655397b0 100644 --- a/service/greengrassv2/api_op_GetServiceRoleForAccount.go +++ b/service/greengrassv2/api_op_GetServiceRoleForAccount.go @@ -13,8 +13,7 @@ import ( // Gets the service role associated with IoT Greengrass for your Amazon Web // Services account in this Amazon Web Services Region. IoT Greengrass uses this // role to verify the identity of client devices and manage core device -// connectivity information. For more information, see Greengrass service role -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) +// connectivity information. For more information, see Greengrass service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) // in the IoT Greengrass Version 2 Developer Guide. func (c *Client) GetServiceRoleForAccount(ctx context.Context, params *GetServiceRoleForAccountInput, optFns ...func(*Options)) (*GetServiceRoleForAccountOutput, error) { if params == nil { diff --git a/service/greengrassv2/api_op_ListComponentVersions.go b/service/greengrassv2/api_op_ListComponentVersions.go index 219fde0a3e1..4beeb10af10 100644 --- a/service/greengrassv2/api_op_ListComponentVersions.go +++ b/service/greengrassv2/api_op_ListComponentVersions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of all versions for a component. Greater versions are -// listed first. +// Retrieves a paginated list of all versions for a component. Greater versions +// are listed first. func (c *Client) ListComponentVersions(ctx context.Context, params *ListComponentVersionsInput, optFns ...func(*Options)) (*ListComponentVersionsOutput, error) { if params == nil { params = &ListComponentVersionsInput{} @@ -31,9 +31,8 @@ func (c *Client) ListComponentVersions(ctx context.Context, params *ListComponen type ListComponentVersionsInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component. // // This member is required. Arn *string diff --git a/service/greengrassv2/api_op_ListComponents.go b/service/greengrassv2/api_op_ListComponents.go index 37abda60b98..7471bea496e 100644 --- a/service/greengrassv2/api_op_ListComponents.go +++ b/service/greengrassv2/api_op_ListComponents.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of component summaries. This list includes components -// that you have permission to view. +// Retrieves a paginated list of component summaries. This list includes +// components that you have permission to view. func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error) { if params == nil { params = &ListComponentsInput{} diff --git a/service/greengrassv2/api_op_ListCoreDevices.go b/service/greengrassv2/api_op_ListCoreDevices.go index 9743a2f6acd..7a6b9a651d8 100644 --- a/service/greengrassv2/api_op_ListCoreDevices.go +++ b/service/greengrassv2/api_op_ListCoreDevices.go @@ -19,22 +19,14 @@ import ( // device might not reflect its current status. The status timestamp indicates when // the device status was last updated. Core devices send status updates at the // following times: -// -// * When the IoT Greengrass Core software starts -// -// * When the -// core device receives a deployment from the Amazon Web Services Cloud -// -// * When the -// status of any component on the core device becomes BROKEN -// -// * At a regular -// interval that you can configure -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss), -// which defaults to 24 hours -// -// * For IoT Greengrass Core v2.7.0, the core device -// sends status updates upon local deployment and cloud deployment +// - When the IoT Greengrass Core software starts +// - When the core device receives a deployment from the Amazon Web Services +// Cloud +// - When the status of any component on the core device becomes BROKEN +// - At a regular interval that you can configure (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss) +// , which defaults to 24 hours +// - For IoT Greengrass Core v2.7.0, the core device sends status updates upon +// local deployment and cloud deployment func (c *Client) ListCoreDevices(ctx context.Context, params *ListCoreDevicesInput, optFns ...func(*Options)) (*ListCoreDevicesOutput, error) { if params == nil { params = &ListCoreDevicesInput{} @@ -61,20 +53,17 @@ type ListCoreDevicesInput struct { // The core device status by which to filter. If you specify this parameter, the // list includes only core devices that have this status. Choose one of the // following options: - // - // * HEALTHY – The IoT Greengrass Core software and all - // components run on the core device without issue. - // - // * UNHEALTHY – The IoT - // Greengrass Core software or a component is in a failed state on the core device. + // - HEALTHY – The IoT Greengrass Core software and all components run on the + // core device without issue. + // - UNHEALTHY – The IoT Greengrass Core software or a component is in a failed + // state on the core device. Status types.CoreDeviceStatus - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IoT thing group by which to filter. If you specify this parameter, the list - // includes only core devices that have successfully deployed a deployment that - // targets the thing group. When you remove a core device from a thing group, the - // list continues to include that core device. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IoT thing group by which to filter. If you specify this parameter, the + // list includes only core devices that have successfully deployed a deployment + // that targets the thing group. When you remove a core device from a thing group, + // the list continues to include that core device. ThingGroupArn *string noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListDeployments.go b/service/greengrassv2/api_op_ListDeployments.go index 3f58940d619..ee850231b6d 100644 --- a/service/greengrassv2/api_op_ListDeployments.go +++ b/service/greengrassv2/api_op_ListDeployments.go @@ -31,13 +31,8 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp type ListDeploymentsInput struct { // The filter for the list of deployments. Choose one of the following options: - // - // * - // ALL – The list includes all deployments. - // - // * LATEST_ONLY – The list includes only - // the latest revision of each deployment. - // + // - ALL – The list includes all deployments. + // - LATEST_ONLY – The list includes only the latest revision of each deployment. // Default: LATEST_ONLY HistoryFilter types.DeploymentHistoryFilter @@ -47,14 +42,12 @@ type ListDeploymentsInput struct { // The token to be used for the next set of paginated results. NextToken *string - // The parent deployment's target ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // The parent deployment's target ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // within a subdeployment. ParentTargetArn *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the target IoT thing or thing group. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the target IoT thing or thing group. TargetArn *string noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListInstalledComponents.go b/service/greengrassv2/api_op_ListInstalledComponents.go index f0cad859708..121dcb2eaf6 100644 --- a/service/greengrassv2/api_op_ListInstalledComponents.go +++ b/service/greengrassv2/api_op_ListInstalledComponents.go @@ -12,32 +12,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of the components that a Greengrass core device runs. -// By default, this list doesn't include components that are deployed as +// Retrieves a paginated list of the components that a Greengrass core device +// runs. By default, this list doesn't include components that are deployed as // dependencies of other components. To include dependencies in the response, set -// the topologyFilter parameter to ALL. IoT Greengrass relies on individual devices -// to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass -// Core software isn't running on the device, or if device isn't connected to the -// Amazon Web Services Cloud, then the reported status of that device might not -// reflect its current status. The status timestamp indicates when the device -// status was last updated. Core devices send status updates at the following -// times: -// -// * When the IoT Greengrass Core software starts -// -// * When the core device -// receives a deployment from the Amazon Web Services Cloud -// -// * When the status of -// any component on the core device becomes BROKEN -// -// * At a regular interval that -// you can configure -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss), -// which defaults to 24 hours -// -// * For IoT Greengrass Core v2.7.0, the core device -// sends status updates upon local deployment and cloud deployment +// the topologyFilter parameter to ALL . IoT Greengrass relies on individual +// devices to send status updates to the Amazon Web Services Cloud. If the IoT +// Greengrass Core software isn't running on the device, or if device isn't +// connected to the Amazon Web Services Cloud, then the reported status of that +// device might not reflect its current status. The status timestamp indicates when +// the device status was last updated. Core devices send status updates at the +// following times: +// - When the IoT Greengrass Core software starts +// - When the core device receives a deployment from the Amazon Web Services +// Cloud +// - When the status of any component on the core device becomes BROKEN +// - At a regular interval that you can configure (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss) +// , which defaults to 24 hours +// - For IoT Greengrass Core v2.7.0, the core device sends status updates upon +// local deployment and cloud deployment func (c *Client) ListInstalledComponents(ctx context.Context, params *ListInstalledComponentsInput, optFns ...func(*Options)) (*ListInstalledComponentsOutput, error) { if params == nil { params = &ListInstalledComponentsInput{} @@ -67,17 +59,11 @@ type ListInstalledComponentsInput struct { NextToken *string // The filter for the list of components. Choose from the following options: - // - // * ALL - // – The list includes all components installed on the core device. - // - // * ROOT – The - // list includes only root components, which are components that you specify in a - // deployment. When you choose this option, the list doesn't include components - // that the core device installs as dependencies of other components. - // - // Default: - // ROOT + // - ALL – The list includes all components installed on the core device. + // - ROOT – The list includes only root components, which are components that you + // specify in a deployment. When you choose this option, the list doesn't include + // components that the core device installs as dependencies of other components. + // Default: ROOT TopologyFilter types.InstalledComponentTopologyFilter noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListTagsForResource.go b/service/greengrassv2/api_op_ListTagsForResource.go index ca5b1e98403..1e3fb585467 100644 --- a/service/greengrassv2/api_op_ListTagsForResource.go +++ b/service/greengrassv2/api_op_ListTagsForResource.go @@ -28,9 +28,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource. // // This member is required. ResourceArn *string @@ -41,9 +40,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_ResolveComponentCandidates.go b/service/greengrassv2/api_op_ResolveComponentCandidates.go index 078a3dc0b35..7f6e2ef9625 100644 --- a/service/greengrassv2/api_op_ResolveComponentCandidates.go +++ b/service/greengrassv2/api_op_ResolveComponentCandidates.go @@ -24,7 +24,7 @@ import ( // specifies to use the version from the Amazon Web Services Cloud. To use this // operation, you must use the data plane API endpoint and authenticate with an IoT // device certificate. For more information, see IoT Greengrass endpoints and -// quotas (https://docs.aws.amazon.com/general/latest/gr/greengrass.html). +// quotas (https://docs.aws.amazon.com/general/latest/gr/greengrass.html) . func (c *Client) ResolveComponentCandidates(ctx context.Context, params *ResolveComponentCandidatesInput, optFns ...func(*Options)) (*ResolveComponentCandidatesOutput, error) { if params == nil { params = &ResolveComponentCandidatesInput{} @@ -53,9 +53,9 @@ type ResolveComponentCandidatesInput struct { type ResolveComponentCandidatesOutput struct { - // A list of components that meet the requirements that you specify in the request. - // This list includes each component's recipe that you can use to install the - // component. + // A list of components that meet the requirements that you specify in the + // request. This list includes each component's recipe that you can use to install + // the component. ResolvedComponentVersions []types.ResolvedComponentVersion // Metadata pertaining to the operation's result. diff --git a/service/greengrassv2/api_op_TagResource.go b/service/greengrassv2/api_op_TagResource.go index 005dc2a7ee8..03ca02229de 100644 --- a/service/greengrassv2/api_op_TagResource.go +++ b/service/greengrassv2/api_op_TagResource.go @@ -29,17 +29,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource to tag. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource to tag. // // This member is required. ResourceArn *string // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tag your resources - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in - // the IoT Greengrass V2 Developer Guide. + // information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) + // in the IoT Greengrass V2 Developer Guide. // // This member is required. Tags map[string]string diff --git a/service/greengrassv2/api_op_UntagResource.go b/service/greengrassv2/api_op_UntagResource.go index 6d0299dbf61..e38483cb5f1 100644 --- a/service/greengrassv2/api_op_UntagResource.go +++ b/service/greengrassv2/api_op_UntagResource.go @@ -28,9 +28,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource to untag. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource to untag. // // This member is required. ResourceArn *string diff --git a/service/greengrassv2/api_op_UpdateConnectivityInfo.go b/service/greengrassv2/api_op_UpdateConnectivityInfo.go index 14abb06c670..d3ef356cdbb 100644 --- a/service/greengrassv2/api_op_UpdateConnectivityInfo.go +++ b/service/greengrassv2/api_op_UpdateConnectivityInfo.go @@ -14,12 +14,10 @@ import ( // Updates connectivity information for a Greengrass core device. Connectivity // information includes endpoints and ports where client devices can connect to an // MQTT broker on the core device. When a client device calls the IoT Greengrass -// discovery API -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html), -// IoT Greengrass returns connectivity information for all of the core devices +// discovery API (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html) +// , IoT Greengrass returns connectivity information for all of the core devices // where the client device can connect. For more information, see Connect client -// devices to core devices -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) +// devices to core devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) // in the IoT Greengrass Version 2 Developer Guide. func (c *Client) UpdateConnectivityInfo(ctx context.Context, params *UpdateConnectivityInfoInput, optFns ...func(*Options)) (*UpdateConnectivityInfoOutput, error) { if params == nil { diff --git a/service/greengrassv2/doc.go b/service/greengrassv2/doc.go index 4095d4fe7c1..d6910f2fedb 100644 --- a/service/greengrassv2/doc.go +++ b/service/greengrassv2/doc.go @@ -14,7 +14,6 @@ // major version of the IoT Greengrass Core software, new APIs, and a new console. // Use this API reference to learn how to use the IoT Greengrass V2 API operations // to manage components, manage deployments, and core devices. For more -// information, see What is IoT Greengrass? -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html) +// information, see What is IoT Greengrass? (https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html) // in the IoT Greengrass V2 Developer Guide. package greengrassv2 diff --git a/service/greengrassv2/types/enums.go b/service/greengrassv2/types/enums.go index cfae09409ca..0d84c444c98 100644 --- a/service/greengrassv2/types/enums.go +++ b/service/greengrassv2/types/enums.go @@ -52,9 +52,9 @@ const ( ComponentVisibilityScopePublic ComponentVisibilityScope = "PUBLIC" ) -// Values returns all known values for ComponentVisibilityScope. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ComponentVisibilityScope. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentVisibilityScope) Values() []ComponentVisibilityScope { return []ComponentVisibilityScope{ "PRIVATE", @@ -287,8 +287,8 @@ const ( LambdaEventSourceTypeIotCore LambdaEventSourceType = "IOT_CORE" ) -// Values returns all known values for LambdaEventSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LambdaEventSourceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LambdaEventSourceType) Values() []LambdaEventSourceType { return []LambdaEventSourceType{ diff --git a/service/greengrassv2/types/errors.go b/service/greengrassv2/types/errors.go index 65a0667ae2f..c117a004b09 100644 --- a/service/greengrassv2/types/errors.go +++ b/service/greengrassv2/types/errors.go @@ -180,9 +180,9 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Your request exceeded a request rate quota. For example, you might have exceeded -// the amount of times that you can retrieve device or deployment status per -// second. +// Your request exceeded a request rate quota. For example, you might have +// exceeded the amount of times that you can retrieve device or deployment status +// per second. type ThrottlingException struct { Message *string diff --git a/service/greengrassv2/types/types.go b/service/greengrassv2/types/types.go index ce9ea77afc9..661db64070c 100644 --- a/service/greengrassv2/types/types.go +++ b/service/greengrassv2/types/types.go @@ -8,8 +8,7 @@ import ( ) // Contains a request to associate a client device with a core device. The -// BatchAssociateClientDeviceWithCoreDevice -// (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) +// BatchAssociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) // operation consumes a list of these requests. type AssociateClientDeviceWithCoreDeviceEntry struct { @@ -21,9 +20,8 @@ type AssociateClientDeviceWithCoreDeviceEntry struct { noSmithyDocumentSerde } -// Contains an error that occurs from a request to associate a client device with a -// core device. The BatchAssociateClientDeviceWithCoreDevice -// (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) +// Contains an error that occurs from a request to associate a client device with +// a core device. The BatchAssociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) // operation returns a list of these errors. type AssociateClientDeviceWithCoreDeviceErrorEntry struct { @@ -58,10 +56,10 @@ type CloudComponentStatus struct { // The state of the component version. ComponentState CloudComponentState - // A dictionary of errors that communicate why the component version is in an error - // state. For example, if IoT Greengrass can't access an artifact for the component - // version, then errors contains the artifact's URI as a key, and the error message - // as the value for that key. + // A dictionary of errors that communicate why the component version is in an + // error state. For example, if IoT Greengrass can't access an artifact for the + // component version, then errors contains the artifact's URI as a key, and the + // error message as the value for that key. Errors map[string]string // A message that communicates details, such as errors, about the status of the @@ -71,18 +69,13 @@ type CloudComponentStatus struct { // The vendor guidance state for the component version. This state indicates // whether the component version has any issues that you should consider before you // deploy it. The vendor guidance state can be: - // - // * ACTIVE – This component version - // is available and recommended for use. - // - // * DISCONTINUED – This component version - // has been discontinued by its publisher. You can deploy this component version, - // but we recommend that you use a different version of this component. - // - // * DELETED - // – This component version has been deleted by its publisher, so you can't deploy - // it. If you have any existing deployments that specify this component version, - // those deployments will fail. + // - ACTIVE – This component version is available and recommended for use. + // - DISCONTINUED – This component version has been discontinued by its + // publisher. You can deploy this component version, but we recommend that you use + // a different version of this component. + // - DELETED – This component version has been deleted by its publisher, so you + // can't deploy it. If you have any existing deployments that specify this + // component version, those deployments will fail. VendorGuidance VendorGuidance // A message that communicates details about the vendor guidance state of the @@ -96,9 +89,8 @@ type CloudComponentStatus struct { // Contains information about a component. type Component struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // The name of the component. @@ -122,8 +114,8 @@ type ComponentCandidate struct { // The version requirements for the component's dependencies. Greengrass core // devices get the version requirements from component recipes. IoT Greengrass V2 - // uses semantic version constraints. For more information, see Semantic Versioning - // (https://semver.org/). + // uses semantic version constraints. For more information, see Semantic Versioning (https://semver.org/) + // . VersionRequirements map[string]string noSmithyDocumentSerde @@ -131,8 +123,7 @@ type ComponentCandidate struct { // Contains information about a deployment's update to a component's configuration // on Greengrass core devices. For more information, see Update component -// configurations -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) +// configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) // in the IoT Greengrass V2 Developer Guide. type ComponentConfigurationUpdate struct { @@ -142,17 +133,15 @@ type ComponentConfigurationUpdate struct { // device, the core device merges this configuration with the component's default // configuration. This means that the core device keeps it's existing configuration // for keys and values that you don't specify in this object. For more information, - // see Merge configuration updates - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) + // see Merge configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) // in the IoT Greengrass V2 Developer Guide. Merge *string // The list of configuration nodes to reset to default values on target devices. // Use JSON pointers to specify each node to reset. JSON pointers start with a - // forward slash (/) and use forward slashes to separate the key for each level in - // the object. For more information, see the JSON pointer specification - // (https://tools.ietf.org/html/rfc6901) and Reset configuration updates - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) + // forward slash ( / ) and use forward slashes to separate the key for each level + // in the object. For more information, see the JSON pointer specification (https://tools.ietf.org/html/rfc6901) + // and Reset configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) // in the IoT Greengrass V2 Developer Guide. Reset []string @@ -164,19 +153,14 @@ type ComponentConfigurationUpdate struct { type ComponentDependencyRequirement struct { // The type of this dependency. Choose from the following options: - // - // * SOFT – The - // component doesn't restart if the dependency changes state. - // - // * HARD – The - // component restarts if the dependency changes state. - // + // - SOFT – The component doesn't restart if the dependency changes state. + // - HARD – The component restarts if the dependency changes state. // Default: HARD DependencyType ComponentDependencyType // The component version requirement for the component dependency. IoT Greengrass // V2 uses semantic version constraints. For more information, see Semantic - // Versioning (https://semver.org/). + // Versioning (https://semver.org/) . VersionRequirement *string noSmithyDocumentSerde @@ -193,17 +177,15 @@ type ComponentDeploymentSpecification struct { // default configuration for the component. A merge updates the core device's // component configuration with the keys and values that you specify. The IoT // Greengrass Core software applies reset updates before it applies merge updates. - // For more information, see Update component configurations - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) + // For more information, see Update component configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) // in the IoT Greengrass V2 Developer Guide. ConfigurationUpdate *ComponentConfigurationUpdate // The system user and group that the IoT Greengrass Core software uses to run // component processes on the core device. If you omit this parameter, the IoT // Greengrass Core software uses the system user and group that you configure for - // the core device. For more information, see Configure the user and group that run - // components - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) + // the core device. For more information, see Configure the user and group that + // run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) // in the IoT Greengrass V2 Developer Guide. RunWith *ComponentRunWith @@ -213,9 +195,8 @@ type ComponentDeploymentSpecification struct { // Contains information about the latest version of a component. type ComponentLatestVersion struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // The version of the component. @@ -242,35 +223,33 @@ type ComponentPlatform struct { // A dictionary of attributes for the platform. The IoT Greengrass Core software // defines the os and architecture by default. You can specify additional platform // attributes for a core device when you deploy the Greengrass nucleus component. - // For more information, see the Greengrass nucleus component - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) + // For more information, see the Greengrass nucleus component (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) // in the IoT Greengrass V2 Developer Guide. Attributes map[string]string - // The friendly name of the platform. This name helps you identify the platform. If - // you omit this parameter, IoT Greengrass creates a friendly name from the os and - // architecture of the platform. + // The friendly name of the platform. This name helps you identify the platform. + // If you omit this parameter, IoT Greengrass creates a friendly name from the os + // and architecture of the platform. Name *string noSmithyDocumentSerde } -// Contains information system user and group that the IoT Greengrass Core software -// uses to run component processes on the core device. For more information, see -// Configure the user and group that run components -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) +// Contains information system user and group that the IoT Greengrass Core +// software uses to run component processes on the core device. For more +// information, see Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) // in the IoT Greengrass V2 Developer Guide. type ComponentRunWith struct { // The POSIX system user and, optionally, group to use to run this component on // Linux core devices. The user, and group if specified, must exist on each Linux - // core device. Specify the user and group separated by a colon (:) in the - // following format: user:group. The group is optional. If you don't specify a + // core device. Specify the user and group separated by a colon ( : ) in the + // following format: user:group . The group is optional. If you don't specify a // group, the IoT Greengrass Core software uses the primary user for the group. If // you omit this parameter, the IoT Greengrass Core software uses the default // system user and group that you configure on the Greengrass nucleus component. - // For more information, see Configure the user and group that run components - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user). + // For more information, see Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) + // . PosixUser *string // The system resource limits to apply to this component's process on the core @@ -278,8 +257,8 @@ type ComponentRunWith struct { // devices. If you omit this parameter, the IoT Greengrass Core software uses the // default system resource limits that you configure on the Greengrass nucleus // component. For more information, see Configure system resource limits for - // components - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits). + // components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits) + // . SystemResourceLimits *SystemResourceLimits // The Windows user to use to run this component on Windows core devices. The user @@ -287,8 +266,8 @@ type ComponentRunWith struct { // LocalSystem account's Credentials Manager instance. If you omit this parameter, // the IoT Greengrass Core software uses the default Windows user that you // configure on the Greengrass nucleus component. For more information, see - // Configure the user and group that run components - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user). + // Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) + // . WindowsUser *string noSmithyDocumentSerde @@ -297,9 +276,8 @@ type ComponentRunWith struct { // Contains information about a component version in a list. type ComponentVersionListItem struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // The name of the component. @@ -311,12 +289,12 @@ type ComponentVersionListItem struct { noSmithyDocumentSerde } -// Contains information about an endpoint and port where client devices can connect -// to an MQTT broker on a Greengrass core device. +// Contains information about an endpoint and port where client devices can +// connect to an MQTT broker on a Greengrass core device. type ConnectivityInfo struct { - // The IP address or DNS address where client devices can connect to an MQTT broker - // on the Greengrass core device. + // The IP address or DNS address where client devices can connect to an MQTT + // broker on the Greengrass core device. HostAddress *string // An ID for the connectivity information. @@ -346,13 +324,10 @@ type CoreDevice struct { LastStatusUpdateTimestamp *time.Time // The status of the core device. Core devices can have the following statuses: - // - // * - // HEALTHY – The IoT Greengrass Core software and all components run on the core - // device without issue. - // - // * UNHEALTHY – The IoT Greengrass Core software or a - // component is in a failed state on the core device. + // - HEALTHY – The IoT Greengrass Core software and all components run on the + // core device without issue. + // - UNHEALTHY – The IoT Greengrass Core software or a component is in a failed + // state on the core device. Status CoreDeviceStatus noSmithyDocumentSerde @@ -376,17 +351,15 @@ type Deployment struct { // Whether or not the deployment is the latest revision for its target. IsLatestForTarget bool - // The parent deployment's target ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // The parent deployment's target ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // within a subdeployment. ParentTargetArn *string // The revision number of the deployment. RevisionId *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the target IoT thing or thing group. When creating a subdeployment, the + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the target IoT thing or thing group. When creating a subdeployment, the // targetARN can only be a thing group. TargetArn *string @@ -404,28 +377,20 @@ type DeploymentComponentUpdatePolicy struct { // Whether or not to notify components and wait for components to become safe to // update. Choose from the following options: - // - // * NOTIFY_COMPONENTS – The deployment - // notifies each component before it stops and updates that component. Components - // can use the SubscribeToComponentUpdates - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) - // IPC operation to receive these notifications. Then, components can respond with - // the DeferComponentUpdate - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) - // IPC operation. For more information, see Create deployments - // (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) - // in the IoT Greengrass V2 Developer Guide. - // - // * SKIP_NOTIFY_COMPONENTS – The - // deployment doesn't notify components or wait for them to be safe to - // update. - // + // - NOTIFY_COMPONENTS – The deployment notifies each component before it stops + // and updates that component. Components can use the SubscribeToComponentUpdates (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) + // IPC operation to receive these notifications. Then, components can respond with + // the DeferComponentUpdate (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) + // IPC operation. For more information, see Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) + // in the IoT Greengrass V2 Developer Guide. + // - SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait + // for them to be safe to update. // Default: NOTIFY_COMPONENTS Action DeploymentComponentUpdatePolicyAction - // The amount of time in seconds that each component on a device has to report that - // it's safe to update. If the component waits for longer than this timeout, then - // the deployment proceeds on the device. Default: 60 + // The amount of time in seconds that each component on a device has to report + // that it's safe to update. If the component waits for longer than this timeout, + // then the deployment proceeds on the device. Default: 60 TimeoutInSeconds *int32 noSmithyDocumentSerde @@ -433,14 +398,11 @@ type DeploymentComponentUpdatePolicy struct { // Contains information about how long a component on a core device can validate // its configuration updates before it times out. Components can use the -// SubscribeToValidateConfigurationUpdates -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) +// SubscribeToValidateConfigurationUpdates (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) // IPC operation to receive notifications when a deployment specifies a // configuration update. Then, components can respond with the -// SendConfigurationValidityReport -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) -// IPC operation. For more information, see Create deployments -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) +// SendConfigurationValidityReport (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) +// IPC operation. For more information, see Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) // in the IoT Greengrass V2 Developer Guide. type DeploymentConfigurationValidationPolicy struct { @@ -490,8 +452,7 @@ type DeploymentPolicies struct { } // Contains a request to disassociate a client device from a core device. The -// BatchDisassociateClientDeviceWithCoreDevice -// (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) +// BatchDisassociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) // operation consumes a list of these requests. type DisassociateClientDeviceFromCoreDeviceEntry struct { @@ -504,8 +465,7 @@ type DisassociateClientDeviceFromCoreDeviceEntry struct { } // Contains an error that occurs from a request to disassociate a client device -// from a core device. The BatchDisassociateClientDeviceWithCoreDevice -// (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) +// from a core device. The BatchDisassociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) // operation returns a list of these errors. type DisassociateClientDeviceFromCoreDeviceErrorEntry struct { @@ -526,30 +486,16 @@ type DisassociateClientDeviceFromCoreDeviceErrorEntry struct { type EffectiveDeployment struct { // The status of the deployment job on the Greengrass core device. - // - // * IN_PROGRESS – - // The deployment job is running. - // - // * QUEUED – The deployment job is in the job - // queue and waiting to run. - // - // * FAILED – The deployment failed. For more - // information, see the statusDetails field. - // - // * COMPLETED – The deployment to an - // IoT thing was completed successfully. - // - // * TIMED_OUT – The deployment didn't - // complete in the allotted time. - // - // * CANCELED – The deployment was canceled by the - // user. - // - // * REJECTED – The deployment was rejected. For more information, see the - // statusDetails field. - // - // * SUCCEEDED – The deployment to an IoT thing group was - // completed successfully. + // - IN_PROGRESS – The deployment job is running. + // - QUEUED – The deployment job is in the job queue and waiting to run. + // - FAILED – The deployment failed. For more information, see the statusDetails + // field. + // - COMPLETED – The deployment to an IoT thing was completed successfully. + // - TIMED_OUT – The deployment didn't complete in the allotted time. + // - CANCELED – The deployment was canceled by the user. + // - REJECTED – The deployment was rejected. For more information, see the + // statusDetails field. + // - SUCCEEDED – The deployment to an IoT thing group was completed successfully. // // This member is required. CoreDeviceExecutionStatus EffectiveDeploymentExecutionStatus @@ -575,9 +521,8 @@ type EffectiveDeployment struct { // This member is required. ModifiedTimestamp *time.Time - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the target IoT thing or thing group. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the target IoT thing or thing group. // // This member is required. TargetArn *string @@ -585,9 +530,8 @@ type EffectiveDeployment struct { // The description of the deployment job. Description *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IoT job that applies the deployment to target devices. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IoT job that applies the deployment to target devices. IotJobArn *string // The ID of the IoT job that applies the deployment to target devices. @@ -638,14 +582,14 @@ type InstalledComponent struct { // The most recent deployment source that brought the component to the Greengrass // core device. For a thing group deployment or thing deployment, the source will - // be the The ID of the deployment. and for local deployments it will be LOCAL. Any - // deployment will attempt to reinstall currently broken components on the device, - // which will update the last installation source. + // be the The ID of the deployment. and for local deployments it will be LOCAL . + // Any deployment will attempt to reinstall currently broken components on the + // device, which will update the last installation source. LastInstallationSource *string - // The last time the Greengrass core device sent a message containing a component's - // state to the Amazon Web Services Cloud. A component does not need to see a state - // change for this field to update. + // The last time the Greengrass core device sent a message containing a + // component's state to the Amazon Web Services Cloud. A component does not need to + // see a state change for this field to update. LastReportedTimestamp *time.Time // The status of how current the data is. This response is based off of component @@ -657,8 +601,8 @@ type InstalledComponent struct { // The lifecycle state of the component. LifecycleState InstalledComponentLifecycleState - // A detailed response about the lifecycle state of the component that explains the - // reason why a component has an error or is broken. + // A detailed response about the lifecycle state of the component that explains + // the reason why a component has an error or is broken. LifecycleStateDetails *string // The status codes that indicate the reason for failure whenever the @@ -683,14 +627,12 @@ type IoTJobAbortConfig struct { noSmithyDocumentSerde } -// Contains criteria that define when and how to cancel a job. The deployment stops -// if the following conditions are true: -// -// * The number of things that receive the -// deployment exceeds the minNumberOfExecutedThings. -// -// * The percentage of failures -// with type failureType exceeds the thresholdPercentage. +// Contains criteria that define when and how to cancel a job. The deployment +// stops if the following conditions are true: +// - The number of things that receive the deployment exceeds the +// minNumberOfExecutedThings . +// - The percentage of failures with type failureType exceeds the +// thresholdPercentage . type IoTJobAbortCriteria struct { // The action to perform when the criteria are met. @@ -711,7 +653,7 @@ type IoTJobAbortCriteria struct { // The minimum percentage of failureType failures that occur before the job can // cancel. This parameter supports up to two digits after the decimal (for example, - // you can specify 10.9 or 10.99, but not 10.999). + // you can specify 10.9 or 10.99 , but not 10.999 ). // // This member is required. ThresholdPercentage float64 @@ -746,8 +688,8 @@ type IoTJobExponentialRolloutRate struct { BaseRatePerMinute int32 // The exponential factor to increase the rollout rate for the job. This parameter - // supports up to one digit after the decimal (for example, you can specify 1.5, - // but not 1.55). + // supports up to one digit after the decimal (for example, you can specify 1.5 , + // but not 1.55 ). // // This member is required. IncrementFactor float64 @@ -761,7 +703,7 @@ type IoTJobExponentialRolloutRate struct { } // Contains information about criteria to meet before a job increases its rollout -// rate. Specify either numberOfNotifiedThings or numberOfSucceededThings. +// rate. Specify either numberOfNotifiedThings or numberOfSucceededThings . type IoTJobRateIncreaseCriteria struct { // The number of devices to receive the job notification before the rollout rate @@ -778,11 +720,11 @@ type IoTJobRateIncreaseCriteria struct { // Contains information about the timeout configuration for a job. type IoTJobTimeoutConfig struct { - // The amount of time, in minutes, that devices have to complete the job. The timer - // starts when the job status is set to IN_PROGRESS. If the job status doesn't - // change to a terminal state before the time expires, then the job status is set - // to TIMED_OUT. The timeout interval must be between 1 minute and 7 days (10080 - // minutes). + // The amount of time, in minutes, that devices have to complete the job. The + // timer starts when the job status is set to IN_PROGRESS . If the job status + // doesn't change to a terminal state before the time expires, then the job status + // is set to TIMED_OUT . The timeout interval must be between 1 minute and 7 days + // (10080 minutes). InProgressTimeoutInMinutes *int64 noSmithyDocumentSerde @@ -798,8 +740,8 @@ type LambdaContainerParams struct { // The memory size of the container, expressed in kilobytes. Default: 16384 (16 MB) MemorySizeInKB *int32 - // Whether or not the container can read information from the device's /sys folder. - // Default: false + // Whether or not the container can read information from the device's /sys + // folder. Default: false MountROSysfs *bool // The list of volumes that the container can access. @@ -821,8 +763,8 @@ type LambdaDeviceMount struct { // Default: false AddGroupOwner *bool - // The permission to access the device: read/only (ro) or read/write (rw). Default: - // ro + // The permission to access the device: read/only ( ro ) or read/write ( rw ). + // Default: ro Permission LambdaFilesystemPermission noSmithyDocumentSerde @@ -839,14 +781,11 @@ type LambdaEventSource struct { Topic *string // The type of event source. Choose from the following options: - // - // * PUB_SUB – - // Subscribe to local publish/subscribe messages. This event source type doesn't - // support MQTT wildcards (+ and #) in the event source topic. - // - // * IOT_CORE – - // Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type - // supports MQTT wildcards (+ and #) in the event source topic. + // - PUB_SUB – Subscribe to local publish/subscribe messages. This event source + // type doesn't support MQTT wildcards ( + and # ) in the event source topic. + // - IOT_CORE – Subscribe to Amazon Web Services IoT Core MQTT messages. This + // event source type supports MQTT wildcards ( + and # ) in the event source + // topic. // // This member is required. Type LambdaEventSourceType @@ -876,30 +815,26 @@ type LambdaExecutionParameters struct { // The parameters for the Linux process that contains the Lambda function. LinuxProcessParams *LambdaLinuxProcessParams - // The maximum amount of time in seconds that a non-pinned Lambda function can idle - // before the IoT Greengrass Core software stops its process. + // The maximum amount of time in seconds that a non-pinned Lambda function can + // idle before the IoT Greengrass Core software stops its process. MaxIdleTimeInSeconds *int32 - // The maximum number of instances that a non-pinned Lambda function can run at the - // same time. + // The maximum number of instances that a non-pinned Lambda function can run at + // the same time. MaxInstancesCount *int32 - // The maximum size of the message queue for the Lambda function component. The IoT - // Greengrass core stores messages in a FIFO (first-in-first-out) queue until it - // can run the Lambda function to consume each message. + // The maximum size of the message queue for the Lambda function component. The + // IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until + // it can run the Lambda function to consume each message. MaxQueueSize *int32 // Whether or not the Lambda function is pinned, or long-lived. - // - // * A pinned Lambda - // function starts when IoT Greengrass starts and keeps running in its own - // container. - // - // * A non-pinned Lambda function starts only when it receives a work - // item and exists after it idles for maxIdleTimeInSeconds. If the function has - // multiple work items, the IoT Greengrass Core software creates multiple instances - // of the function. - // + // - A pinned Lambda function starts when IoT Greengrass starts and keeps + // running in its own container. + // - A non-pinned Lambda function starts only when it receives a work item and + // exists after it idles for maxIdleTimeInSeconds . If the function has multiple + // work items, the IoT Greengrass Core software creates multiple instances of the + // function. // Default: true Pinned *bool @@ -917,10 +852,9 @@ type LambdaExecutionParameters struct { // Contains information about an Lambda function to import to create a component. type LambdaFunctionRecipeSource struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the Lambda function. The ARN must include the version of the function to import. - // You can't use version aliases like $LATEST. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the Lambda function. The ARN must include the version of the function to + // import. You can't use version aliases like $LATEST . // // This member is required. LambdaArn *string @@ -939,8 +873,8 @@ type LambdaFunctionRecipeSource struct { ComponentPlatforms []ComponentPlatform // The version of the component. Defaults to the version of the Lambda function as - // a semantic version. For example, if your function version is 3, the component - // version becomes 3.0.0. + // a semantic version. For example, if your function version is 3 , the component + // version becomes 3.0.0 . ComponentVersion *string noSmithyDocumentSerde @@ -980,8 +914,8 @@ type LambdaVolumeMount struct { // Default: false AddGroupOwner *bool - // The permission to access the volume: read/only (ro) or read/write (rw). Default: - // ro + // The permission to access the volume: read/only ( ro ) or read/write ( rw ). + // Default: ro Permission LambdaFilesystemPermission noSmithyDocumentSerde @@ -991,9 +925,8 @@ type LambdaVolumeMount struct { // Greengrass core device. type ResolvedComponentVersion struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the component version. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the component version. Arn *string // The name of the component. @@ -1013,27 +946,22 @@ type ResolvedComponentVersion struct { // The vendor guidance state for the component version. This state indicates // whether the component version has any issues that you should consider before you // deploy it. The vendor guidance state can be: - // - // * ACTIVE – This component version - // is available and recommended for use. - // - // * DISCONTINUED – This component version - // has been discontinued by its publisher. You can deploy this component version, - // but we recommend that you use a different version of this component. - // - // * DELETED - // – This component version has been deleted by its publisher, so you can't deploy - // it. If you have any existing deployments that specify this component version, - // those deployments will fail. + // - ACTIVE – This component version is available and recommended for use. + // - DISCONTINUED – This component version has been discontinued by its + // publisher. You can deploy this component version, but we recommend that you use + // a different version of this component. + // - DELETED – This component version has been deleted by its publisher, so you + // can't deploy it. If you have any existing deployments that specify this + // component version, those deployments will fail. VendorGuidance VendorGuidance noSmithyDocumentSerde } // Contains information about system resource limits that the IoT Greengrass Core -// software applies to a component's processes. For more information, see Configure -// system resource limits for components -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits). +// software applies to a component's processes. For more information, see +// Configure system resource limits for components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits) +// . type SystemResourceLimits struct { // The maximum amount of CPU time that a component's processes can use on the core diff --git a/service/groundstation/api_client.go b/service/groundstation/api_client.go index b7eb50a997c..e4ef4d8d752 100644 --- a/service/groundstation/api_client.go +++ b/service/groundstation/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/groundstation/api_op_CreateConfig.go b/service/groundstation/api_op_CreateConfig.go index f50a3ed177b..e77f358b218 100644 --- a/service/groundstation/api_op_CreateConfig.go +++ b/service/groundstation/api_op_CreateConfig.go @@ -30,17 +30,17 @@ func (c *Client) CreateConfig(ctx context.Context, params *CreateConfigInput, op type CreateConfigInput struct { - // Parameters of a Config. + // Parameters of a Config . // // This member is required. ConfigData types.ConfigTypeData - // Name of a Config. + // Name of a Config . // // This member is required. Name *string - // Tags assigned to a Config. + // Tags assigned to a Config . Tags map[string]string noSmithyDocumentSerde @@ -48,13 +48,13 @@ type CreateConfigInput struct { type CreateConfigOutput struct { - // ARN of a Config. + // ARN of a Config . ConfigArn *string - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType types.ConfigCapabilityType // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_CreateDataflowEndpointGroup.go b/service/groundstation/api_op_CreateDataflowEndpointGroup.go index 469fbdbcefc..bce8df01a6e 100644 --- a/service/groundstation/api_op_CreateDataflowEndpointGroup.go +++ b/service/groundstation/api_op_CreateDataflowEndpointGroup.go @@ -44,8 +44,8 @@ type CreateDataflowEndpointGroupInput struct { ContactPostPassDurationSeconds *int32 // Amount of time, in seconds, prior to contact start for the contact to remain in - // a PREPASS state. A CloudWatch event is emitted when the contact enters and exits - // the PREPASS state. + // a PREPASS state. A CloudWatch event is emitted when the contact enters and + // exits the PREPASS state. ContactPrePassDurationSeconds *int32 // Tags of a dataflow endpoint group. diff --git a/service/groundstation/api_op_CreateEphemeris.go b/service/groundstation/api_op_CreateEphemeris.go index cf50d9b3315..79a2d852fe6 100644 --- a/service/groundstation/api_op_CreateEphemeris.go +++ b/service/groundstation/api_op_CreateEphemeris.go @@ -12,7 +12,7 @@ import ( "time" ) -// Creates an Ephemeris with the specified EphemerisData. +// Creates an Ephemeris with the specified EphemerisData . func (c *Client) CreateEphemeris(ctx context.Context, params *CreateEphemerisInput, optFns ...func(*Options)) (*CreateEphemerisOutput, error) { if params == nil { params = &CreateEphemerisInput{} @@ -30,8 +30,8 @@ func (c *Client) CreateEphemeris(ctx context.Context, params *CreateEphemerisInp type CreateEphemerisInput struct { - // A name string associated with the ephemeris. Used as a human-readable identifier - // for the ephemeris. + // A name string associated with the ephemeris. Used as a human-readable + // identifier for the ephemeris. // // This member is required. Name *string @@ -41,15 +41,15 @@ type CreateEphemerisInput struct { // This member is required. SatelliteId *string - // Whether to set the ephemeris status to ENABLED after validation. Setting this to - // false will set the ephemeris status to DISABLED after validation. + // Whether to set the ephemeris status to ENABLED after validation. Setting this + // to false will set the ephemeris status to DISABLED after validation. Enabled *bool // Ephemeris data. Ephemeris types.EphemerisData // An overall expiration time for the ephemeris in UTC, after which it will become - // EXPIRED. + // EXPIRED . ExpirationTime *time.Time // The ARN of a KMS key used to encrypt the ephemeris in Ground Station. diff --git a/service/groundstation/api_op_CreateMissionProfile.go b/service/groundstation/api_op_CreateMissionProfile.go index 217f1914f63..1889c042e6a 100644 --- a/service/groundstation/api_op_CreateMissionProfile.go +++ b/service/groundstation/api_op_CreateMissionProfile.go @@ -31,7 +31,7 @@ func (c *Client) CreateMissionProfile(ctx context.Context, params *CreateMission type CreateMissionProfileInput struct { // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a - // to Config. + // to Config . // // This member is required. DataflowEdges [][]string @@ -48,7 +48,7 @@ type CreateMissionProfileInput struct { // This member is required. Name *string - // ARN of a tracking Config. + // ARN of a tracking Config . // // This member is required. TrackingConfigArn *string diff --git a/service/groundstation/api_op_DeleteConfig.go b/service/groundstation/api_op_DeleteConfig.go index a51c412fd8b..8395a7aab7f 100644 --- a/service/groundstation/api_op_DeleteConfig.go +++ b/service/groundstation/api_op_DeleteConfig.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Config. +// Deletes a Config . func (c *Client) DeleteConfig(ctx context.Context, params *DeleteConfigInput, optFns ...func(*Options)) (*DeleteConfigOutput, error) { if params == nil { params = &DeleteConfigInput{} @@ -29,12 +29,12 @@ func (c *Client) DeleteConfig(ctx context.Context, params *DeleteConfigInput, op type DeleteConfigInput struct { - // UUID of a Config. + // UUID of a Config . // // This member is required. ConfigId *string - // Type of a Config. + // Type of a Config . // // This member is required. ConfigType types.ConfigCapabilityType @@ -44,13 +44,13 @@ type DeleteConfigInput struct { type DeleteConfigOutput struct { - // ARN of a Config. + // ARN of a Config . ConfigArn *string - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType types.ConfigCapabilityType // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_DescribeContact.go b/service/groundstation/api_op_DescribeContact.go index db95def1c73..ba9473551d5 100644 --- a/service/groundstation/api_op_DescribeContact.go +++ b/service/groundstation/api_op_DescribeContact.go @@ -178,9 +178,9 @@ type ContactScheduledWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ContactScheduledWaiter will use default max delay of 900 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ContactScheduledWaiter will use default max delay of 900 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/groundstation/api_op_DescribeEphemeris.go b/service/groundstation/api_op_DescribeEphemeris.go index 95d5e16fb36..50bb8fe0207 100644 --- a/service/groundstation/api_op_DescribeEphemeris.go +++ b/service/groundstation/api_op_DescribeEphemeris.go @@ -53,8 +53,8 @@ type DescribeEphemerisOutput struct { // INVALID status. InvalidReason types.EphemerisInvalidReason - // A name string associated with the ephemeris. Used as a human-readable identifier - // for the ephemeris. + // A name string associated with the ephemeris. Used as a human-readable + // identifier for the ephemeris. Name *string // Customer-provided priority score to establish the order in which overlapping diff --git a/service/groundstation/api_op_GetConfig.go b/service/groundstation/api_op_GetConfig.go index ad9d9fe57a9..1cb2ffebce9 100644 --- a/service/groundstation/api_op_GetConfig.go +++ b/service/groundstation/api_op_GetConfig.go @@ -29,12 +29,12 @@ func (c *Client) GetConfig(ctx context.Context, params *GetConfigInput, optFns . type GetConfigInput struct { - // UUID of a Config. + // UUID of a Config . // // This member is required. ConfigId *string - // Type of a Config. + // Type of a Config . // // This member is required. ConfigType types.ConfigCapabilityType @@ -49,25 +49,25 @@ type GetConfigOutput struct { // This member is required. ConfigArn *string - // Data elements in a Config. + // Data elements in a Config . // // This member is required. ConfigData types.ConfigTypeData - // UUID of a Config. + // UUID of a Config . // // This member is required. ConfigId *string - // Name of a Config. + // Name of a Config . // // This member is required. Name *string - // Type of a Config. + // Type of a Config . ConfigType types.ConfigCapabilityType - // Tags assigned to a Config. + // Tags assigned to a Config . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_GetDataflowEndpointGroup.go b/service/groundstation/api_op_GetDataflowEndpointGroup.go index edd70b8a052..08afa70caa9 100644 --- a/service/groundstation/api_op_GetDataflowEndpointGroup.go +++ b/service/groundstation/api_op_GetDataflowEndpointGroup.go @@ -45,8 +45,8 @@ type GetDataflowEndpointGroupOutput struct { ContactPostPassDurationSeconds *int32 // Amount of time, in seconds, prior to contact start for the contact to remain in - // a PREPASS state. A CloudWatch event is emitted when the contact enters and exits - // the PREPASS state. + // a PREPASS state. A CloudWatch event is emitted when the contact enters and + // exits the PREPASS state. ContactPrePassDurationSeconds *int32 // ARN of a dataflow endpoint group. diff --git a/service/groundstation/api_op_GetMinuteUsage.go b/service/groundstation/api_op_GetMinuteUsage.go index 721d05bc4c6..16f4e61b5c5 100644 --- a/service/groundstation/api_op_GetMinuteUsage.go +++ b/service/groundstation/api_op_GetMinuteUsage.go @@ -47,8 +47,8 @@ type GetMinuteUsageOutput struct { // being requested. EstimatedMinutesRemaining *int32 - // Returns whether or not an account has signed up for the reserved minutes pricing - // plan, specific to the month being requested. + // Returns whether or not an account has signed up for the reserved minutes + // pricing plan, specific to the month being requested. IsReservedMinutesCustomer *bool // Total number of reserved minutes allocated, specific to the month being diff --git a/service/groundstation/api_op_GetMissionProfile.go b/service/groundstation/api_op_GetMissionProfile.go index dd1e2baafc3..7d62fc9224c 100644 --- a/service/groundstation/api_op_GetMissionProfile.go +++ b/service/groundstation/api_op_GetMissionProfile.go @@ -48,7 +48,7 @@ type GetMissionProfileOutput struct { ContactPrePassDurationSeconds *int32 // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a - // to Config. + // to Config . DataflowEdges [][]string // Smallest amount of time in seconds that you’d like to see for an available @@ -77,7 +77,7 @@ type GetMissionProfileOutput struct { // Tags assigned to a mission profile. Tags map[string]string - // ARN of a tracking Config. + // ARN of a tracking Config . TrackingConfigArn *string // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_ListContacts.go b/service/groundstation/api_op_ListContacts.go index fdf5ba87f4d..88d8f5263e2 100644 --- a/service/groundstation/api_op_ListContacts.go +++ b/service/groundstation/api_op_ListContacts.go @@ -14,7 +14,7 @@ import ( ) // Returns a list of contacts. If statusList contains AVAILABLE, the request must -// include groundStation, missionprofileArn, and satelliteArn. +// include groundStation , missionprofileArn , and satelliteArn . func (c *Client) ListContacts(ctx context.Context, params *ListContactsInput, optFns ...func(*Options)) (*ListContactsOutput, error) { if params == nil { params = &ListContactsInput{} @@ -71,8 +71,8 @@ type ListContactsOutput struct { // List of contacts. ContactList []types.ContactData - // Next token returned in the response of a previous ListContacts call. Used to get - // the next page of results. + // Next token returned in the response of a previous ListContacts call. Used to + // get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_ListEphemerides.go b/service/groundstation/api_op_ListEphemerides.go index e096156d074..bfeb77e4cd4 100644 --- a/service/groundstation/api_op_ListEphemerides.go +++ b/service/groundstation/api_op_ListEphemerides.go @@ -32,7 +32,7 @@ func (c *Client) ListEphemerides(ctx context.Context, params *ListEphemeridesInp type ListEphemeridesInput struct { // The end time to list in UTC. The operation will return an ephemeris if its - // expiration time is within the time range defined by the startTime and endTime. + // expiration time is within the time range defined by the startTime and endTime . // // This member is required. EndTime *time.Time @@ -43,7 +43,7 @@ type ListEphemeridesInput struct { SatelliteId *string // The start time to list in UTC. The operation will return an ephemeris if its - // expiration time is within the time range defined by the startTime and endTime. + // expiration time is within the time range defined by the startTime and endTime . // // This member is required. StartTime *time.Time diff --git a/service/groundstation/api_op_ListMissionProfiles.go b/service/groundstation/api_op_ListMissionProfiles.go index 014bd1f76a1..618a6b85d2c 100644 --- a/service/groundstation/api_op_ListMissionProfiles.go +++ b/service/groundstation/api_op_ListMissionProfiles.go @@ -45,8 +45,8 @@ type ListMissionProfilesOutput struct { // List of mission profiles. MissionProfileList []types.MissionProfileListItem - // Next token returned in the response of a previous ListMissionProfiles call. Used - // to get the next page of results. + // Next token returned in the response of a previous ListMissionProfiles call. + // Used to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. @@ -115,8 +115,8 @@ func (c *Client) addOperationListMissionProfilesMiddlewares(stack *middleware.St return nil } -// ListMissionProfilesAPIClient is a client that implements the ListMissionProfiles -// operation. +// ListMissionProfilesAPIClient is a client that implements the +// ListMissionProfiles operation. type ListMissionProfilesAPIClient interface { ListMissionProfiles(context.Context, *ListMissionProfilesInput, ...func(*Options)) (*ListMissionProfilesOutput, error) } diff --git a/service/groundstation/api_op_UpdateConfig.go b/service/groundstation/api_op_UpdateConfig.go index 6643e18972a..31884338ba4 100644 --- a/service/groundstation/api_op_UpdateConfig.go +++ b/service/groundstation/api_op_UpdateConfig.go @@ -13,7 +13,7 @@ import ( // Updates the Config used when scheduling contacts. Updating a Config will not // update the execution parameters for existing future contacts scheduled with this -// Config. +// Config . func (c *Client) UpdateConfig(ctx context.Context, params *UpdateConfigInput, optFns ...func(*Options)) (*UpdateConfigOutput, error) { if params == nil { params = &UpdateConfigInput{} @@ -31,22 +31,22 @@ func (c *Client) UpdateConfig(ctx context.Context, params *UpdateConfigInput, op type UpdateConfigInput struct { - // Parameters of a Config. + // Parameters of a Config . // // This member is required. ConfigData types.ConfigTypeData - // UUID of a Config. + // UUID of a Config . // // This member is required. ConfigId *string - // Type of a Config. + // Type of a Config . // // This member is required. ConfigType types.ConfigCapabilityType - // Name of a Config. + // Name of a Config . // // This member is required. Name *string @@ -56,13 +56,13 @@ type UpdateConfigInput struct { type UpdateConfigOutput struct { - // ARN of a Config. + // ARN of a Config . ConfigArn *string - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType types.ConfigCapabilityType // Metadata pertaining to the operation's result. diff --git a/service/groundstation/api_op_UpdateEphemeris.go b/service/groundstation/api_op_UpdateEphemeris.go index 5a0deb24f77..1cfd8e1706a 100644 --- a/service/groundstation/api_op_UpdateEphemeris.go +++ b/service/groundstation/api_op_UpdateEphemeris.go @@ -39,8 +39,8 @@ type UpdateEphemerisInput struct { // This member is required. EphemerisId *string - // A name string associated with the ephemeris. Used as a human-readable identifier - // for the ephemeris. + // A name string associated with the ephemeris. Used as a human-readable + // identifier for the ephemeris. Name *string // Customer-provided priority score to establish the order in which overlapping diff --git a/service/groundstation/api_op_UpdateMissionProfile.go b/service/groundstation/api_op_UpdateMissionProfile.go index e90d988881c..e8221e78c5e 100644 --- a/service/groundstation/api_op_UpdateMissionProfile.go +++ b/service/groundstation/api_op_UpdateMissionProfile.go @@ -44,7 +44,7 @@ type UpdateMissionProfileInput struct { ContactPrePassDurationSeconds *int32 // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a - // to Config. + // to Config . DataflowEdges [][]string // Smallest amount of time in seconds that you’d like to see for an available @@ -61,7 +61,7 @@ type UpdateMissionProfileInput struct { // Role to use for encrypting streams with KMS key. StreamsKmsRole *string - // ARN of a tracking Config. + // ARN of a tracking Config . TrackingConfigArn *string noSmithyDocumentSerde diff --git a/service/groundstation/types/enums.go b/service/groundstation/types/enums.go index 2fbf247567a..974ab841628 100644 --- a/service/groundstation/types/enums.go +++ b/service/groundstation/types/enums.go @@ -50,9 +50,9 @@ const ( AuditResultsUnhealthy AuditResults = "UNHEALTHY" ) -// Values returns all known values for AuditResults. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AuditResults. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AuditResults) Values() []AuditResults { return []AuditResults{ "HEALTHY", @@ -195,9 +195,9 @@ const ( EirpUnitsDbw EirpUnits = "dBW" ) -// Values returns all known values for EirpUnits. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EirpUnits. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EirpUnits) Values() []EirpUnits { return []EirpUnits{ "dBW", @@ -330,9 +330,9 @@ const ( PolarizationRightHand Polarization = "RIGHT_HAND" ) -// Values returns all known values for Polarization. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Polarization. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Polarization) Values() []Polarization { return []Polarization{ "LEFT_HAND", diff --git a/service/groundstation/types/types.go b/service/groundstation/types/types.go index 58c9d80cd12..4accceb4194 100644 --- a/service/groundstation/types/types.go +++ b/service/groundstation/types/types.go @@ -65,7 +65,7 @@ type AntennaDemodDecodeDetails struct { // downlink during a contact. type AntennaDownlinkConfig struct { - // Object that describes a spectral Config. + // Object that describes a spectral Config . // // This member is required. SpectrumConfig *SpectrumConfig @@ -73,21 +73,21 @@ type AntennaDownlinkConfig struct { noSmithyDocumentSerde } -// Information about how AWS Ground Station should configure an antenna for downlink -// demod decode during a contact. +// Information about how AWS Ground Station should configure an antenna for +// downlink demod decode during a contact. type AntennaDownlinkDemodDecodeConfig struct { - // Information about the decode Config. + // Information about the decode Config . // // This member is required. DecodeConfig *DecodeConfig - // Information about the demodulation Config. + // Information about the demodulation Config . // // This member is required. DemodulationConfig *DemodulationConfig - // Information about the spectral Config. + // Information about the spectral Config . // // This member is required. SpectrumConfig *SpectrumConfig @@ -98,7 +98,7 @@ type AntennaDownlinkDemodDecodeConfig struct { // Information about the uplink Config of an antenna. type AntennaUplinkConfig struct { - // Information about the uplink spectral Config. + // Information about the uplink spectral Config . // // This member is required. SpectrumConfig *UplinkSpectrumConfig @@ -234,22 +234,22 @@ func (*ConfigDetailsMemberS3RecordingDetails) isConfigDetails() {} // An item in a list of Config objects. type ConfigListItem struct { - // ARN of a Config. + // ARN of a Config . ConfigArn *string - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType ConfigCapabilityType - // Name of a Config. + // Name of a Config . Name *string noSmithyDocumentSerde } -// Object containing the parameters of a Config. See the subtype definitions for +// Object containing the parameters of a Config . See the subtype definitions for // what each type of Config contains. // // The following types satisfy this interface: @@ -275,8 +275,8 @@ type ConfigTypeDataMemberAntennaDownlinkConfig struct { func (*ConfigTypeDataMemberAntennaDownlinkConfig) isConfigTypeData() {} -// Information about how AWS Ground Station should configure an antenna for downlink -// demod decode during a contact. +// Information about how AWS Ground Station should configure an antenna for +// downlink demod decode during a contact. type ConfigTypeDataMemberAntennaDownlinkDemodDecodeConfig struct { Value AntennaDownlinkDemodDecodeConfig @@ -295,7 +295,7 @@ type ConfigTypeDataMemberAntennaUplinkConfig struct { func (*ConfigTypeDataMemberAntennaUplinkConfig) isConfigTypeData() {} -// Information about the dataflow endpoint Config. +// Information about the dataflow endpoint Config . type ConfigTypeDataMemberDataflowEndpointConfig struct { Value DataflowEndpointConfig @@ -304,7 +304,7 @@ type ConfigTypeDataMemberDataflowEndpointConfig struct { func (*ConfigTypeDataMemberDataflowEndpointConfig) isConfigTypeData() {} -// Information about an S3 recording Config. +// Information about an S3 recording Config . type ConfigTypeDataMemberS3RecordingConfig struct { Value S3RecordingConfig @@ -313,8 +313,8 @@ type ConfigTypeDataMemberS3RecordingConfig struct { func (*ConfigTypeDataMemberS3RecordingConfig) isConfigTypeData() {} -// Object that determines whether tracking should be used during a contact executed -// with this Config in the mission profile. +// Object that determines whether tracking should be used during a contact +// executed with this Config in the mission profile. type ConfigTypeDataMemberTrackingConfig struct { Value TrackingConfig @@ -323,9 +323,9 @@ type ConfigTypeDataMemberTrackingConfig struct { func (*ConfigTypeDataMemberTrackingConfig) isConfigTypeData() {} -// Information about an uplink echo Config. Parameters from the -// AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are -// used when this UplinkEchoConfig is used in a contact. +// Information about an uplink echo Config . Parameters from the +// AntennaUplinkConfig , corresponding to the specified AntennaUplinkConfigArn , +// are used when this UplinkEchoConfig is used in a contact. type ConfigTypeDataMemberUplinkEchoConfig struct { Value UplinkEchoConfig @@ -428,7 +428,7 @@ type DataflowEndpoint struct { noSmithyDocumentSerde } -// Information about the dataflow endpoint Config. +// Information about the dataflow endpoint Config . type DataflowEndpointConfig struct { // Name of a dataflow endpoint. @@ -454,10 +454,10 @@ type DataflowEndpointListItem struct { noSmithyDocumentSerde } -// Information about the decode Config. +// Information about the decode Config . type DecodeConfig struct { - // Unvalidated JSON of a decode Config. + // Unvalidated JSON of a decode Config . // // This member is required. UnvalidatedJSON *string @@ -465,10 +465,10 @@ type DecodeConfig struct { noSmithyDocumentSerde } -// Information about the demodulation Config. +// Information about the demodulation Config . type DemodulationConfig struct { - // Unvalidated JSON of a demodulation Config. + // Unvalidated JSON of a demodulation Config . // // This member is required. UnvalidatedJSON *string @@ -479,14 +479,14 @@ type DemodulationConfig struct { // Dataflow details for the destination side. type Destination struct { - // Additional details for a Config, if type is dataflow endpoint or antenna demod + // Additional details for a Config , if type is dataflow endpoint or antenna demod // decode. ConfigDetails ConfigDetails - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType ConfigCapabilityType // Region of a dataflow destination. @@ -557,8 +557,8 @@ type EndpointDetails struct { // A dataflow endpoint. Endpoint *DataflowEndpoint - // Endpoint security details including a list of subnets, a list of security groups - // and a role to connect streams to instances. + // Endpoint security details including a list of subnets, a list of security + // groups and a role to connect streams to instances. SecurityDetails *SecurityDetails noSmithyDocumentSerde @@ -616,8 +616,8 @@ type EphemerisItem struct { // The AWS Ground Station ephemeris ID. EphemerisId *string - // A name string associated with the ephemeris. Used as a human-readable identifier - // for the ephemeris. + // A name string associated with the ephemeris. Used as a human-readable + // identifier for the ephemeris. Name *string // Customer-provided priority score to establish the order in which overlapping @@ -650,9 +650,9 @@ type EphemerisMetaData struct { // populated for customer-provided ephemerides. Epoch *time.Time - // A name string associated with the ephemeris. Used as a human-readable identifier - // for the ephemeris. A name is only returned for customer-provider ephemerides - // that have a name associated. + // A name string associated with the ephemeris. Used as a human-readable + // identifier for the ephemeris. A name is only returned for customer-provider + // ephemerides that have a name associated. Name *string noSmithyDocumentSerde @@ -711,15 +711,10 @@ type FrequencyBandwidth struct { // Frequency bandwidth value. AWS Ground Station currently has the following // bandwidth limitations: - // - // * For AntennaDownlinkDemodDecodeconfig, valid values are - // between 125 kHz to 650 MHz. - // - // * For AntennaDownlinkconfig, valid values are - // between 10 kHz to 54 MHz. - // - // * For AntennaUplinkConfig, valid values are between - // 10 kHz to 54 MHz. + // - For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to + // 650 MHz. + // - For AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz. + // - For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz. // // This member is required. Value *float64 @@ -862,7 +857,7 @@ type S3Object struct { noSmithyDocumentSerde } -// Information about an S3 recording Config. +// Information about an S3 recording Config . type S3RecordingConfig struct { // ARN of the bucket to record to. @@ -955,14 +950,14 @@ type SocketAddress struct { // Dataflow details for the source side. type Source struct { - // Additional details for a Config, if type is dataflow-endpoint or + // Additional details for a Config , if type is dataflow-endpoint or // antenna-downlink-demod-decode ConfigDetails ConfigDetails - // UUID of a Config. + // UUID of a Config . ConfigId *string - // Type of a Config. + // Type of a Config . ConfigType ConfigCapabilityType // Region of a dataflow source. @@ -971,31 +966,26 @@ type Source struct { noSmithyDocumentSerde } -// Object that describes a spectral Config. +// Object that describes a spectral Config . type SpectrumConfig struct { - // Bandwidth of a spectral Config. AWS Ground Station currently has the following + // Bandwidth of a spectral Config . AWS Ground Station currently has the following // bandwidth limitations: - // - // * For AntennaDownlinkDemodDecodeconfig, valid values are - // between 125 kHz to 650 MHz. - // - // * For AntennaDownlinkconfig valid values are - // between 10 kHz to 54 MHz. - // - // * For AntennaUplinkConfig, valid values are between - // 10 kHz to 54 MHz. + // - For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to + // 650 MHz. + // - For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz. + // - For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz. // // This member is required. Bandwidth *FrequencyBandwidth - // Center frequency of a spectral Config. Valid values are between 2200 to 2300 MHz - // and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink. + // Center frequency of a spectral Config . Valid values are between 2200 to 2300 + // MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink. // // This member is required. CenterFrequency *Frequency - // Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" + // Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" // polarization requires two separate configs. Polarization Polarization @@ -1052,8 +1042,8 @@ type TLEEphemeris struct { noSmithyDocumentSerde } -// Object that determines whether tracking should be used during a contact executed -// with this Config in the mission profile. +// Object that determines whether tracking should be used during a contact +// executed with this Config in the mission profile. type TrackingConfig struct { // Current setting for autotrack. @@ -1064,12 +1054,12 @@ type TrackingConfig struct { noSmithyDocumentSerde } -// Information about an uplink echo Config. Parameters from the -// AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are -// used when this UplinkEchoConfig is used in a contact. +// Information about an uplink echo Config . Parameters from the +// AntennaUplinkConfig , corresponding to the specified AntennaUplinkConfigArn , +// are used when this UplinkEchoConfig is used in a contact. type UplinkEchoConfig struct { - // ARN of an uplink Config. + // ARN of an uplink Config . // // This member is required. AntennaUplinkConfigArn *string @@ -1082,16 +1072,16 @@ type UplinkEchoConfig struct { noSmithyDocumentSerde } -// Information about the uplink spectral Config. +// Information about the uplink spectral Config . type UplinkSpectrumConfig struct { - // Center frequency of an uplink spectral Config. Valid values are between 2025 to + // Center frequency of an uplink spectral Config . Valid values are between 2025 to // 2120 MHz. // // This member is required. CenterFrequency *Frequency - // Polarization of an uplink spectral Config. Capturing both "RIGHT_HAND" and + // Polarization of an uplink spectral Config . Capturing both "RIGHT_HAND" and // "LEFT_HAND" polarization requires two separate configs. Polarization Polarization diff --git a/service/guardduty/api_client.go b/service/guardduty/api_client.go index 7b63390cde4..f1316878d16 100644 --- a/service/guardduty/api_client.go +++ b/service/guardduty/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/guardduty/api_op_CreateDetector.go b/service/guardduty/api_op_CreateDetector.go index 353e8baece8..93d7ba50516 100644 --- a/service/guardduty/api_op_CreateDetector.go +++ b/service/guardduty/api_op_CreateDetector.go @@ -18,8 +18,8 @@ import ( // detector per account per Region. All data sources are enabled in a new detector // by default. There might be regional differences because some data sources might // not be available in all the Amazon Web Services Regions where GuardDuty is -// presently supported. For more information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// presently supported. For more information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) CreateDetector(ctx context.Context, params *CreateDetectorInput, optFns ...func(*Options)) (*CreateDetectorOutput, error) { if params == nil { params = &CreateDetectorInput{} @@ -48,8 +48,8 @@ type CreateDetectorInput struct { // Describes which data sources will be enabled for the detector. There might be // regional differences because some data sources might not be available in all the // Amazon Web Services Regions where GuardDuty is presently supported. For more - // information, see Regions and endpoints - // (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). + // information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) + // . // // Deprecated: This parameter is deprecated, use Features instead DataSources *types.DataSourceConfigurations diff --git a/service/guardduty/api_op_CreateFilter.go b/service/guardduty/api_op_CreateFilter.go index b34daeeaefd..9cff58ad96f 100644 --- a/service/guardduty/api_op_CreateFilter.go +++ b/service/guardduty/api_op_CreateFilter.go @@ -14,8 +14,8 @@ import ( // Creates a filter using the specified finding criteria. The maximum number of // saved filters per Amazon Web Services account per Region is 100. For more -// information, see Quotas for GuardDuty -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_limits.html). +// information, see Quotas for GuardDuty (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_limits.html) +// . func (c *Client) CreateFilter(ctx context.Context, params *CreateFilterInput, optFns ...func(*Options)) (*CreateFilterOutput, error) { if params == nil { params = &CreateFilterInput{} @@ -41,161 +41,63 @@ type CreateFilterInput struct { // Represents the criteria to be used in the filter for querying findings. You can // only use the following attributes to query findings: - // - // * accountId - // - // * region - // - // * - // id - // - // * resource.accessKeyDetails.accessKeyId - // - // * - // resource.accessKeyDetails.principalId - // - // * resource.accessKeyDetails.userName - // - // * - // resource.accessKeyDetails.userType - // - // * - // resource.instanceDetails.iamInstanceProfile.id - // - // * - // resource.instanceDetails.imageId - // - // * resource.instanceDetails.instanceId - // - // * - // resource.instanceDetails.outpostArn - // - // * - // resource.instanceDetails.networkInterfaces.ipv6Addresses - // - // * - // resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress - // - // * - // resource.instanceDetails.networkInterfaces.publicDnsName - // - // * - // resource.instanceDetails.networkInterfaces.publicIp - // - // * - // resource.instanceDetails.networkInterfaces.securityGroups.groupId - // - // * - // resource.instanceDetails.networkInterfaces.securityGroups.groupName - // - // * - // resource.instanceDetails.networkInterfaces.subnetId - // - // * - // resource.instanceDetails.networkInterfaces.vpcId - // - // * - // resource.instanceDetails.tags.key - // - // * resource.instanceDetails.tags.value - // - // * - // resource.resourceType - // - // * service.action.actionType - // - // * - // service.action.awsApiCallAction.api - // - // * - // service.action.awsApiCallAction.callerType - // - // * - // service.action.awsApiCallAction.errorCode - // - // * - // service.action.awsApiCallAction.userAgent - // - // * - // service.action.awsApiCallAction.remoteIpDetails.city.cityName - // - // * - // service.action.awsApiCallAction.remoteIpDetails.country.countryName - // - // * - // service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 - // - // * - // service.action.awsApiCallAction.remoteIpDetails.organization.asn - // - // * - // service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg - // - // * - // service.action.awsApiCallAction.serviceName - // - // * - // service.action.dnsRequestAction.domain - // - // * - // service.action.networkConnectionAction.blocked - // - // * - // service.action.networkConnectionAction.connectionDirection - // - // * - // service.action.networkConnectionAction.localPortDetails.port - // - // * - // service.action.networkConnectionAction.protocol - // - // * - // service.action.networkConnectionAction.localIpDetails.ipAddressV4 - // - // * - // service.action.networkConnectionAction.remoteIpDetails.city.cityName - // - // * - // service.action.networkConnectionAction.remoteIpDetails.country.countryName - // - // * - // service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 - // - // * - // service.action.networkConnectionAction.remoteIpDetails.organization.asn - // - // * - // service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg - // - // * - // service.action.networkConnectionAction.remotePortDetails.port - // - // * - // service.additionalInfo.threatListName - // - // * - // resource.s3BucketDetails.publicAccess.effectivePermissions - // - // * - // resource.s3BucketDetails.name - // - // * resource.s3BucketDetails.tags.key - // - // * - // resource.s3BucketDetails.tags.value - // - // * resource.s3BucketDetails.type - // - // * - // service.resourceRole - // - // * severity - // - // * type - // - // * updatedAt Type: ISO 8601 string - // format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether - // the value contains milliseconds. + // - accountId + // - region + // - id + // - resource.accessKeyDetails.accessKeyId + // - resource.accessKeyDetails.principalId + // - resource.accessKeyDetails.userName + // - resource.accessKeyDetails.userType + // - resource.instanceDetails.iamInstanceProfile.id + // - resource.instanceDetails.imageId + // - resource.instanceDetails.instanceId + // - resource.instanceDetails.outpostArn + // - resource.instanceDetails.networkInterfaces.ipv6Addresses + // - + // resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress + // - resource.instanceDetails.networkInterfaces.publicDnsName + // - resource.instanceDetails.networkInterfaces.publicIp + // - resource.instanceDetails.networkInterfaces.securityGroups.groupId + // - resource.instanceDetails.networkInterfaces.securityGroups.groupName + // - resource.instanceDetails.networkInterfaces.subnetId + // - resource.instanceDetails.networkInterfaces.vpcId + // - resource.instanceDetails.tags.key + // - resource.instanceDetails.tags.value + // - resource.resourceType + // - service.action.actionType + // - service.action.awsApiCallAction.api + // - service.action.awsApiCallAction.callerType + // - service.action.awsApiCallAction.errorCode + // - service.action.awsApiCallAction.userAgent + // - service.action.awsApiCallAction.remoteIpDetails.city.cityName + // - service.action.awsApiCallAction.remoteIpDetails.country.countryName + // - service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 + // - service.action.awsApiCallAction.remoteIpDetails.organization.asn + // - service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg + // - service.action.awsApiCallAction.serviceName + // - service.action.dnsRequestAction.domain + // - service.action.networkConnectionAction.blocked + // - service.action.networkConnectionAction.connectionDirection + // - service.action.networkConnectionAction.localPortDetails.port + // - service.action.networkConnectionAction.protocol + // - service.action.networkConnectionAction.localIpDetails.ipAddressV4 + // - service.action.networkConnectionAction.remoteIpDetails.city.cityName + // - service.action.networkConnectionAction.remoteIpDetails.country.countryName + // - service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 + // - service.action.networkConnectionAction.remoteIpDetails.organization.asn + // - service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg + // - service.action.networkConnectionAction.remotePortDetails.port + // - service.additionalInfo.threatListName + // - resource.s3BucketDetails.publicAccess.effectivePermissions + // - resource.s3BucketDetails.name + // - resource.s3BucketDetails.tags.key + // - resource.s3BucketDetails.tags.value + // - resource.s3BucketDetails.type + // - service.resourceRole + // - severity + // - type + // - updatedAt Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or + // YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds. // // This member is required. FindingCriteria *types.FindingCriteria @@ -214,10 +116,10 @@ type CreateFilterInput struct { // The idempotency token for the create request. ClientToken *string - // The description of the filter. Valid characters include alphanumeric characters, - // and special characters such as hyphen, period, colon, underscore, parentheses ({ - // }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form - // feed, return, and whitespace. + // The description of the filter. Valid characters include alphanumeric + // characters, and special characters such as hyphen, period, colon, underscore, + // parentheses ( { } , [ ] , and ( ) ), forward slash, horizontal tab, vertical + // tab, newline, form feed, return, and whitespace. Description *string // Specifies the position of the filter in the list of current filters. Also diff --git a/service/guardduty/api_op_CreateMembers.go b/service/guardduty/api_op_CreateMembers.go index 9ef87abbbd1..17dfd33a8d2 100644 --- a/service/guardduty/api_op_CreateMembers.go +++ b/service/guardduty/api_op_CreateMembers.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates member accounts of the current Amazon Web Services account by specifying -// a list of Amazon Web Services account IDs. This step is a prerequisite for -// managing the associated member accounts either by invitation or through an -// organization. When using Create Members as an organizations delegated -// administrator this action will enable GuardDuty in the added member accounts, -// with the exception of the organization delegated administrator account, which -// must enable GuardDuty prior to being added as a member. If you are adding -// accounts by invitation, use this action after GuardDuty has bee enabled in -// potential member accounts and before using InviteMembers -// (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html). +// Creates member accounts of the current Amazon Web Services account by +// specifying a list of Amazon Web Services account IDs. This step is a +// prerequisite for managing the associated member accounts either by invitation or +// through an organization. When using Create Members as an organizations +// delegated administrator this action will enable GuardDuty in the added member +// accounts, with the exception of the organization delegated administrator +// account, which must enable GuardDuty prior to being added as a member. If you +// are adding accounts by invitation, use this action after GuardDuty has bee +// enabled in potential member accounts and before using InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) +// . func (c *Client) CreateMembers(ctx context.Context, params *CreateMembersInput, optFns ...func(*Options)) (*CreateMembersOutput, error) { if params == nil { params = &CreateMembersInput{} diff --git a/service/guardduty/api_op_CreateSampleFindings.go b/service/guardduty/api_op_CreateSampleFindings.go index 3d844d394bd..8557289be89 100644 --- a/service/guardduty/api_op_CreateSampleFindings.go +++ b/service/guardduty/api_op_CreateSampleFindings.go @@ -11,7 +11,7 @@ import ( ) // Generates sample findings of types specified by the list of finding types. If -// 'NULL' is specified for findingTypes, the API generates sample findings of all +// 'NULL' is specified for findingTypes , the API generates sample findings of all // supported finding types. func (c *Client) CreateSampleFindings(ctx context.Context, params *CreateSampleFindingsInput, optFns ...func(*Options)) (*CreateSampleFindingsOutput, error) { if params == nil { diff --git a/service/guardduty/api_op_CreateThreatIntelSet.go b/service/guardduty/api_op_CreateThreatIntelSet.go index 48a622fdcef..63050531dd7 100644 --- a/service/guardduty/api_op_CreateThreatIntelSet.go +++ b/service/guardduty/api_op_CreateThreatIntelSet.go @@ -38,8 +38,8 @@ type CreateThreatIntelSetInput struct { // This member is required. Activate bool - // The unique ID of the detector of the GuardDuty account that you want to create a - // threatIntelSet for. + // The unique ID of the detector of the GuardDuty account that you want to create + // a threatIntelSet for. // // This member is required. DetectorId *string @@ -54,8 +54,9 @@ type CreateThreatIntelSetInput struct { // This member is required. Location *string - // A user-friendly ThreatIntelSet name displayed in all findings that are generated - // by activity that involves IP addresses included in this ThreatIntelSet. + // A user-friendly ThreatIntelSet name displayed in all findings that are + // generated by activity that involves IP addresses included in this + // ThreatIntelSet. // // This member is required. Name *string diff --git a/service/guardduty/api_op_DeleteIPSet.go b/service/guardduty/api_op_DeleteIPSet.go index dc0add32da3..b889b9c147c 100644 --- a/service/guardduty/api_op_DeleteIPSet.go +++ b/service/guardduty/api_op_DeleteIPSet.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists +// Deletes the IPSet specified by the ipSetId . IPSets are called trusted IP lists // in the console user interface. func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { diff --git a/service/guardduty/api_op_DeleteMembers.go b/service/guardduty/api_op_DeleteMembers.go index 6e1a47e0c30..0f8961876c0 100644 --- a/service/guardduty/api_op_DeleteMembers.go +++ b/service/guardduty/api_op_DeleteMembers.go @@ -13,7 +13,7 @@ import ( // Deletes GuardDuty member accounts (to the current GuardDuty administrator // account) specified by the account IDs. With autoEnableOrganizationMembers -// configuration for your organization set to ALL, you'll receive an error if you +// configuration for your organization set to ALL , you'll receive an error if you // attempt to disable GuardDuty for a member account in your organization. func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, optFns ...func(*Options)) (*DeleteMembersOutput, error) { if params == nil { @@ -37,8 +37,8 @@ type DeleteMembersInput struct { // This member is required. AccountIds []string - // The unique ID of the detector of the GuardDuty account whose members you want to - // delete. + // The unique ID of the detector of the GuardDuty account whose members you want + // to delete. // // This member is required. DetectorId *string diff --git a/service/guardduty/api_op_DeletePublishingDestination.go b/service/guardduty/api_op_DeletePublishingDestination.go index 20e1874e888..265c2b5e315 100644 --- a/service/guardduty/api_op_DeletePublishingDestination.go +++ b/service/guardduty/api_op_DeletePublishingDestination.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the publishing definition with the specified destinationId. +// Deletes the publishing definition with the specified destinationId . func (c *Client) DeletePublishingDestination(ctx context.Context, params *DeletePublishingDestinationInput, optFns ...func(*Options)) (*DeletePublishingDestinationOutput, error) { if params == nil { params = &DeletePublishingDestinationInput{} diff --git a/service/guardduty/api_op_DescribeMalwareScans.go b/service/guardduty/api_op_DescribeMalwareScans.go index 25a0e5c4849..55390f7d8da 100644 --- a/service/guardduty/api_op_DescribeMalwareScans.go +++ b/service/guardduty/api_op_DescribeMalwareScans.go @@ -16,8 +16,8 @@ import ( // for their own accounts. An administrator can view the malware scans for all the // member accounts. There might be regional differences because some data sources // might not be available in all the Amazon Web Services Regions where GuardDuty is -// presently supported. For more information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// presently supported. For more information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) DescribeMalwareScans(ctx context.Context, params *DescribeMalwareScansInput, optFns ...func(*Options)) (*DescribeMalwareScansOutput, error) { if params == nil { params = &DescribeMalwareScansInput{} @@ -43,8 +43,8 @@ type DescribeMalwareScansInput struct { // Represents the criteria to be used in the filter for describing scan entries. FilterCriteria *types.FilterCriteria - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. MaxResults int32 // You can use this parameter when paginating results. Set the value of this @@ -53,9 +53,8 @@ type DescribeMalwareScansInput struct { // previous response to continue listing data. NextToken *string - // Represents the criteria used for sorting scan entries. The attributeName - // (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName) - // is required and it must be scanStartTime. + // Represents the criteria used for sorting scan entries. The attributeName (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName) + // is required and it must be scanStartTime . SortCriteria *types.SortCriteria noSmithyDocumentSerde @@ -152,8 +151,8 @@ var _ DescribeMalwareScansAPIClient = (*Client)(nil) // DescribeMalwareScansPaginatorOptions is the paginator options for // DescribeMalwareScans type DescribeMalwareScansPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_DescribeOrganizationConfiguration.go b/service/guardduty/api_op_DescribeOrganizationConfiguration.go index ae1daa619b9..8fb5a26117c 100644 --- a/service/guardduty/api_op_DescribeOrganizationConfiguration.go +++ b/service/guardduty/api_op_DescribeOrganizationConfiguration.go @@ -15,8 +15,8 @@ import ( // Returns information about the account selected as the delegated administrator // for GuardDuty. There might be regional differences because some data sources // might not be available in all the Amazon Web Services Regions where GuardDuty is -// presently supported. For more information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// presently supported. For more information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error) { if params == nil { params = &DescribeOrganizationConfigurationInput{} @@ -34,14 +34,14 @@ func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params * type DescribeOrganizationConfigurationInput struct { - // The ID of the detector to retrieve information about the delegated administrator - // from. + // The ID of the detector to retrieve information about the delegated + // administrator from. // // This member is required. DetectorId *string - // You can use this parameter to indicate the maximum number of items that you want - // in the response. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. MaxResults int32 // You can use this parameter when paginating results. Set the value of this @@ -68,21 +68,17 @@ type DescribeOrganizationConfigurationOutput struct { // Deprecated: This field is deprecated, use AutoEnableOrganizationMembers instead AutoEnable bool - // Indicates the auto-enablement configuration of GuardDuty for the member accounts - // in the organization. - // - // * NEW: Indicates that when a new account joins the - // organization, they will have GuardDuty enabled automatically. - // - // * ALL: Indicates - // that all accounts in the Amazon Web Services Organization have GuardDuty enabled - // automatically. This includes NEW accounts that join the organization and - // accounts that may have been suspended or removed from the organization in - // GuardDuty. - // - // * NONE: Indicates that GuardDuty will not be automatically enabled - // for any accounts in the organization. GuardDuty must be managed for each account - // individually by the administrator. + // Indicates the auto-enablement configuration of GuardDuty for the member + // accounts in the organization. + // - NEW : Indicates that when a new account joins the organization, they will + // have GuardDuty enabled automatically. + // - ALL : Indicates that all accounts in the Amazon Web Services Organization + // have GuardDuty enabled automatically. This includes NEW accounts that join the + // organization and accounts that may have been suspended or removed from the + // organization in GuardDuty. + // - NONE : Indicates that GuardDuty will not be automatically enabled for any + // accounts in the organization. GuardDuty must be managed for each account + // individually by the administrator. AutoEnableOrganizationMembers types.AutoEnableMembers // Describes which data sources are enabled automatically for member accounts. @@ -177,8 +173,8 @@ var _ DescribeOrganizationConfigurationAPIClient = (*Client)(nil) // DescribeOrganizationConfigurationPaginatorOptions is the paginator options for // DescribeOrganizationConfiguration type DescribeOrganizationConfigurationPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_DescribePublishingDestination.go b/service/guardduty/api_op_DescribePublishingDestination.go index 5b706c7236e..b6b66032760 100644 --- a/service/guardduty/api_op_DescribePublishingDestination.go +++ b/service/guardduty/api_op_DescribePublishingDestination.go @@ -12,7 +12,7 @@ import ( ) // Returns information about the publishing destination specified by the provided -// destinationId. +// destinationId . func (c *Client) DescribePublishingDestination(ctx context.Context, params *DescribePublishingDestinationInput, optFns ...func(*Options)) (*DescribePublishingDestinationOutput, error) { if params == nil { params = &DescribePublishingDestinationInput{} @@ -51,8 +51,8 @@ type DescribePublishingDestinationOutput struct { // This member is required. DestinationId *string - // A DestinationProperties object that includes the DestinationArn and KmsKeyArn of - // the publishing destination. + // A DestinationProperties object that includes the DestinationArn and KmsKeyArn + // of the publishing destination. // // This member is required. DestinationProperties *types.DestinationProperties diff --git a/service/guardduty/api_op_DisableOrganizationAdminAccount.go b/service/guardduty/api_op_DisableOrganizationAdminAccount.go index b9827604e6a..f7e3d3c6d65 100644 --- a/service/guardduty/api_op_DisableOrganizationAdminAccount.go +++ b/service/guardduty/api_op_DisableOrganizationAdminAccount.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables an Amazon Web Services account within the Organization as the GuardDuty -// delegated administrator. +// Disables an Amazon Web Services account within the Organization as the +// GuardDuty delegated administrator. func (c *Client) DisableOrganizationAdminAccount(ctx context.Context, params *DisableOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableOrganizationAdminAccountOutput, error) { if params == nil { params = &DisableOrganizationAdminAccountInput{} diff --git a/service/guardduty/api_op_DisassociateFromAdministratorAccount.go b/service/guardduty/api_op_DisassociateFromAdministratorAccount.go index 2b53545fffa..92684493d6d 100644 --- a/service/guardduty/api_op_DisassociateFromAdministratorAccount.go +++ b/service/guardduty/api_op_DisassociateFromAdministratorAccount.go @@ -12,7 +12,7 @@ import ( // Disassociates the current GuardDuty member account from its administrator // account. With autoEnableOrganizationMembers configuration for your organization -// set to ALL, you'll receive an error if you attempt to disable GuardDuty in a +// set to ALL , you'll receive an error if you attempt to disable GuardDuty in a // member account. func (c *Client) DisassociateFromAdministratorAccount(ctx context.Context, params *DisassociateFromAdministratorAccountInput, optFns ...func(*Options)) (*DisassociateFromAdministratorAccountOutput, error) { if params == nil { diff --git a/service/guardduty/api_op_DisassociateMembers.go b/service/guardduty/api_op_DisassociateMembers.go index 3582f8d5f72..4065a732a81 100644 --- a/service/guardduty/api_op_DisassociateMembers.go +++ b/service/guardduty/api_op_DisassociateMembers.go @@ -13,7 +13,7 @@ import ( // Disassociates GuardDuty member accounts (to the current administrator account) // specified by the account IDs. With autoEnableOrganizationMembers configuration -// for your organization set to ALL, you'll receive an error if you attempt to +// for your organization set to ALL , you'll receive an error if you attempt to // disassociate a member account before removing them from your Amazon Web Services // organization. func (c *Client) DisassociateMembers(ctx context.Context, params *DisassociateMembersInput, optFns ...func(*Options)) (*DisassociateMembersOutput, error) { @@ -39,8 +39,8 @@ type DisassociateMembersInput struct { // This member is required. AccountIds []string - // The unique ID of the detector of the GuardDuty account whose members you want to - // disassociate from the administrator account. + // The unique ID of the detector of the GuardDuty account whose members you want + // to disassociate from the administrator account. // // This member is required. DetectorId *string diff --git a/service/guardduty/api_op_EnableOrganizationAdminAccount.go b/service/guardduty/api_op_EnableOrganizationAdminAccount.go index 44d310d03df..9be09044c9c 100644 --- a/service/guardduty/api_op_EnableOrganizationAdminAccount.go +++ b/service/guardduty/api_op_EnableOrganizationAdminAccount.go @@ -29,8 +29,8 @@ func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *Ena type EnableOrganizationAdminAccountInput struct { - // The Amazon Web Services Account ID for the organization account to be enabled as - // a GuardDuty delegated administrator. + // The Amazon Web Services Account ID for the organization account to be enabled + // as a GuardDuty delegated administrator. // // This member is required. AdminAccountId *string diff --git a/service/guardduty/api_op_GetAdministratorAccount.go b/service/guardduty/api_op_GetAdministratorAccount.go index 1553130e0d1..d39229fb028 100644 --- a/service/guardduty/api_op_GetAdministratorAccount.go +++ b/service/guardduty/api_op_GetAdministratorAccount.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides the details for the GuardDuty administrator account associated with the -// current GuardDuty member account. +// Provides the details for the GuardDuty administrator account associated with +// the current GuardDuty member account. func (c *Client) GetAdministratorAccount(ctx context.Context, params *GetAdministratorAccountInput, optFns ...func(*Options)) (*GetAdministratorAccountOutput, error) { if params == nil { params = &GetAdministratorAccountInput{} diff --git a/service/guardduty/api_op_GetCoverageStatistics.go b/service/guardduty/api_op_GetCoverageStatistics.go index ac23c71081e..237261c8296 100644 --- a/service/guardduty/api_op_GetCoverageStatistics.go +++ b/service/guardduty/api_op_GetCoverageStatistics.go @@ -50,7 +50,7 @@ type GetCoverageStatisticsInput struct { type GetCoverageStatisticsOutput struct { - // Represents the count aggregated by the statusCode and resourceType. + // Represents the count aggregated by the statusCode and resourceType . CoverageStatistics *types.CoverageStatistics // Metadata pertaining to the operation's result. diff --git a/service/guardduty/api_op_GetDetector.go b/service/guardduty/api_op_GetDetector.go index 9960cba94db..8071f25afe6 100644 --- a/service/guardduty/api_op_GetDetector.go +++ b/service/guardduty/api_op_GetDetector.go @@ -14,8 +14,8 @@ import ( // Retrieves an Amazon GuardDuty detector specified by the detectorId. There might // be regional differences because some data sources might not be available in all // the Amazon Web Services Regions where GuardDuty is presently supported. For more -// information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) GetDetector(ctx context.Context, params *GetDetectorInput, optFns ...func(*Options)) (*GetDetectorOutput, error) { if params == nil { params = &GetDetectorInput{} diff --git a/service/guardduty/api_op_GetIPSet.go b/service/guardduty/api_op_GetIPSet.go index 6142e35fb8a..c3516b87290 100644 --- a/service/guardduty/api_op_GetIPSet.go +++ b/service/guardduty/api_op_GetIPSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the IPSet specified by the ipSetId. +// Retrieves the IPSet specified by the ipSetId . func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} diff --git a/service/guardduty/api_op_GetMalwareScanSettings.go b/service/guardduty/api_op_GetMalwareScanSettings.go index 3fc11edd3b9..d878a39a138 100644 --- a/service/guardduty/api_op_GetMalwareScanSettings.go +++ b/service/guardduty/api_op_GetMalwareScanSettings.go @@ -14,8 +14,8 @@ import ( // Returns the details of the malware scan settings. There might be regional // differences because some data sources might not be available in all the Amazon // Web Services Regions where GuardDuty is presently supported. For more -// information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) GetMalwareScanSettings(ctx context.Context, params *GetMalwareScanSettingsInput, optFns ...func(*Options)) (*GetMalwareScanSettingsOutput, error) { if params == nil { params = &GetMalwareScanSettingsInput{} diff --git a/service/guardduty/api_op_GetMasterAccount.go b/service/guardduty/api_op_GetMasterAccount.go index 205ae3e5af6..c5232208dbf 100644 --- a/service/guardduty/api_op_GetMasterAccount.go +++ b/service/guardduty/api_op_GetMasterAccount.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides the details for the GuardDuty administrator account associated with the -// current GuardDuty member account. +// Provides the details for the GuardDuty administrator account associated with +// the current GuardDuty member account. // // Deprecated: This operation is deprecated, use GetAdministratorAccount instead func (c *Client) GetMasterAccount(ctx context.Context, params *GetMasterAccountInput, optFns ...func(*Options)) (*GetMasterAccountOutput, error) { diff --git a/service/guardduty/api_op_GetMemberDetectors.go b/service/guardduty/api_op_GetMemberDetectors.go index 3d5f3aaa97a..5ba4ee21a73 100644 --- a/service/guardduty/api_op_GetMemberDetectors.go +++ b/service/guardduty/api_op_GetMemberDetectors.go @@ -14,8 +14,8 @@ import ( // Describes which data sources are enabled for the member account's detector. // There might be regional differences because some data sources might not be // available in all the Amazon Web Services Regions where GuardDuty is presently -// supported. For more information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// supported. For more information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) GetMemberDetectors(ctx context.Context, params *GetMemberDetectorsInput, optFns ...func(*Options)) (*GetMemberDetectorsOutput, error) { if params == nil { params = &GetMemberDetectorsInput{} diff --git a/service/guardduty/api_op_GetMembers.go b/service/guardduty/api_op_GetMembers.go index 144af3bb1c0..fbe78360653 100644 --- a/service/guardduty/api_op_GetMembers.go +++ b/service/guardduty/api_op_GetMembers.go @@ -36,8 +36,8 @@ type GetMembersInput struct { // This member is required. AccountIds []string - // The unique ID of the detector of the GuardDuty account whose members you want to - // retrieve. + // The unique ID of the detector of the GuardDuty account whose members you want + // to retrieve. // // This member is required. DetectorId *string diff --git a/service/guardduty/api_op_GetThreatIntelSet.go b/service/guardduty/api_op_GetThreatIntelSet.go index 46bd0f3744d..721857604d1 100644 --- a/service/guardduty/api_op_GetThreatIntelSet.go +++ b/service/guardduty/api_op_GetThreatIntelSet.go @@ -54,8 +54,9 @@ type GetThreatIntelSetOutput struct { // This member is required. Location *string - // A user-friendly ThreatIntelSet name displayed in all findings that are generated - // by activity that involves IP addresses included in this ThreatIntelSet. + // A user-friendly ThreatIntelSet name displayed in all findings that are + // generated by activity that involves IP addresses included in this + // ThreatIntelSet. // // This member is required. Name *string diff --git a/service/guardduty/api_op_GetUsageStatistics.go b/service/guardduty/api_op_GetUsageStatistics.go index 22ae3151290..239f64c2892 100644 --- a/service/guardduty/api_op_GetUsageStatistics.go +++ b/service/guardduty/api_op_GetUsageStatistics.go @@ -17,8 +17,8 @@ import ( // include only the usage so far under 30 days. This may differ from the cost // metrics in the console, which project usage over 30 days to provide a monthly // cost estimate. For more information, see Understanding How Usage Costs are -// Calculated -// (https://docs.aws.amazon.com/guardduty/latest/ug/monitoring_costs.html#usage-calculations). +// Calculated (https://docs.aws.amazon.com/guardduty/latest/ug/monitoring_costs.html#usage-calculations) +// . func (c *Client) GetUsageStatistics(ctx context.Context, params *GetUsageStatisticsInput, optFns ...func(*Options)) (*GetUsageStatisticsOutput, error) { if params == nil { params = &GetUsageStatisticsInput{} @@ -55,14 +55,14 @@ type GetUsageStatisticsInput struct { // The maximum number of results to return in the response. MaxResults int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string - // The currency unit you would like to view your usage statistics in. Current valid - // values are USD. + // The currency unit you would like to view your usage statistics in. Current + // valid values are USD. Unit *string noSmithyDocumentSerde diff --git a/service/guardduty/api_op_InviteMembers.go b/service/guardduty/api_op_InviteMembers.go index 2fc6ba171d3..468ec900323 100644 --- a/service/guardduty/api_op_InviteMembers.go +++ b/service/guardduty/api_op_InviteMembers.go @@ -44,8 +44,8 @@ type InviteMembersInput struct { // This member is required. DetectorId *string - // A Boolean value that specifies whether you want to disable email notification to - // the accounts that you are inviting to GuardDuty as members. + // A Boolean value that specifies whether you want to disable email notification + // to the accounts that you are inviting to GuardDuty as members. DisableEmailNotification bool // The invitation message that you want to send to the accounts that you're diff --git a/service/guardduty/api_op_ListCoverage.go b/service/guardduty/api_op_ListCoverage.go index 3a99f7d8649..a7d051e26cc 100644 --- a/service/guardduty/api_op_ListCoverage.go +++ b/service/guardduty/api_op_ListCoverage.go @@ -44,8 +44,8 @@ type ListCoverageInput struct { // The maximum number of results to return in the response. MaxResults int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/guardduty/api_op_ListDetectors.go b/service/guardduty/api_op_ListDetectors.go index 858a446c1d7..f364e82e168 100644 --- a/service/guardduty/api_op_ListDetectors.go +++ b/service/guardduty/api_op_ListDetectors.go @@ -29,8 +29,8 @@ func (c *Client) ListDetectors(ctx context.Context, params *ListDetectorsInput, type ListDetectorsInput struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. MaxResults int32 // You can use this parameter when paginating results. Set the value of this @@ -128,8 +128,8 @@ var _ ListDetectorsAPIClient = (*Client)(nil) // ListDetectorsPaginatorOptions is the paginator options for ListDetectors type ListDetectorsPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_ListFilters.go b/service/guardduty/api_op_ListFilters.go index 0965bdf2b18..549f8d283e8 100644 --- a/service/guardduty/api_op_ListFilters.go +++ b/service/guardduty/api_op_ListFilters.go @@ -34,8 +34,8 @@ type ListFiltersInput struct { // This member is required. DetectorId *string - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. MaxResults int32 // You can use this parameter when paginating results. Set the value of this @@ -136,8 +136,8 @@ var _ ListFiltersAPIClient = (*Client)(nil) // ListFiltersPaginatorOptions is the paginator options for ListFilters type ListFiltersPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_ListFindings.go b/service/guardduty/api_op_ListFindings.go index c2e67fdb3fc..e560d9e58ba 100644 --- a/service/guardduty/api_op_ListFindings.go +++ b/service/guardduty/api_op_ListFindings.go @@ -37,141 +37,57 @@ type ListFindingsInput struct { DetectorId *string // Represents the criteria used for querying findings. Valid values include: - // - // * - // JSON field name - // - // * accountId - // - // * region - // - // * confidence - // - // * id - // - // * - // resource.accessKeyDetails.accessKeyId - // - // * - // resource.accessKeyDetails.principalId - // - // * resource.accessKeyDetails.userName - // - // * - // resource.accessKeyDetails.userType - // - // * - // resource.instanceDetails.iamInstanceProfile.id - // - // * - // resource.instanceDetails.imageId - // - // * resource.instanceDetails.instanceId - // - // * - // resource.instanceDetails.networkInterfaces.ipv6Addresses - // - // * - // resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress - // - // * - // resource.instanceDetails.networkInterfaces.publicDnsName - // - // * - // resource.instanceDetails.networkInterfaces.publicIp - // - // * - // resource.instanceDetails.networkInterfaces.securityGroups.groupId - // - // * - // resource.instanceDetails.networkInterfaces.securityGroups.groupName - // - // * - // resource.instanceDetails.networkInterfaces.subnetId - // - // * - // resource.instanceDetails.networkInterfaces.vpcId - // - // * - // resource.instanceDetails.tags.key - // - // * resource.instanceDetails.tags.value - // - // * - // resource.resourceType - // - // * service.action.actionType - // - // * - // service.action.awsApiCallAction.api - // - // * - // service.action.awsApiCallAction.callerType - // - // * - // service.action.awsApiCallAction.remoteIpDetails.city.cityName - // - // * - // service.action.awsApiCallAction.remoteIpDetails.country.countryName - // - // * - // service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 - // - // * - // service.action.awsApiCallAction.remoteIpDetails.organization.asn - // - // * - // service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg - // - // * - // service.action.awsApiCallAction.serviceName - // - // * - // service.action.dnsRequestAction.domain - // - // * - // service.action.networkConnectionAction.blocked - // - // * - // service.action.networkConnectionAction.connectionDirection - // - // * - // service.action.networkConnectionAction.localPortDetails.port - // - // * - // service.action.networkConnectionAction.protocol - // - // * - // service.action.networkConnectionAction.remoteIpDetails.country.countryName - // - // * - // service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 - // - // * - // service.action.networkConnectionAction.remoteIpDetails.organization.asn - // - // * - // service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg - // - // * - // service.action.networkConnectionAction.remotePortDetails.port - // - // * - // service.additionalInfo.threatListName - // - // * service.archived When this attribute is - // set to 'true', only archived findings are listed. When it's set to 'false', only - // unarchived findings are listed. When this attribute is not set, all existing - // findings are listed. - // - // * service.resourceRole - // - // * severity - // - // * type - // - // * updatedAt - // Type: Timestamp in Unix Epoch millisecond format: 1486685375000 + // - JSON field name + // - accountId + // - region + // - confidence + // - id + // - resource.accessKeyDetails.accessKeyId + // - resource.accessKeyDetails.principalId + // - resource.accessKeyDetails.userName + // - resource.accessKeyDetails.userType + // - resource.instanceDetails.iamInstanceProfile.id + // - resource.instanceDetails.imageId + // - resource.instanceDetails.instanceId + // - resource.instanceDetails.networkInterfaces.ipv6Addresses + // - + // resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress + // - resource.instanceDetails.networkInterfaces.publicDnsName + // - resource.instanceDetails.networkInterfaces.publicIp + // - resource.instanceDetails.networkInterfaces.securityGroups.groupId + // - resource.instanceDetails.networkInterfaces.securityGroups.groupName + // - resource.instanceDetails.networkInterfaces.subnetId + // - resource.instanceDetails.networkInterfaces.vpcId + // - resource.instanceDetails.tags.key + // - resource.instanceDetails.tags.value + // - resource.resourceType + // - service.action.actionType + // - service.action.awsApiCallAction.api + // - service.action.awsApiCallAction.callerType + // - service.action.awsApiCallAction.remoteIpDetails.city.cityName + // - service.action.awsApiCallAction.remoteIpDetails.country.countryName + // - service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 + // - service.action.awsApiCallAction.remoteIpDetails.organization.asn + // - service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg + // - service.action.awsApiCallAction.serviceName + // - service.action.dnsRequestAction.domain + // - service.action.networkConnectionAction.blocked + // - service.action.networkConnectionAction.connectionDirection + // - service.action.networkConnectionAction.localPortDetails.port + // - service.action.networkConnectionAction.protocol + // - service.action.networkConnectionAction.remoteIpDetails.country.countryName + // - service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 + // - service.action.networkConnectionAction.remoteIpDetails.organization.asn + // - service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg + // - service.action.networkConnectionAction.remotePortDetails.port + // - service.additionalInfo.threatListName + // - service.archived When this attribute is set to 'true', only archived + // findings are listed. When it's set to 'false', only unarchived findings are + // listed. When this attribute is not set, all existing findings are listed. + // - service.resourceRole + // - severity + // - type + // - updatedAt Type: Timestamp in Unix Epoch millisecond format: 1486685375000 FindingCriteria *types.FindingCriteria // You can use this parameter to indicate the maximum number of items you want in diff --git a/service/guardduty/api_op_ListInvitations.go b/service/guardduty/api_op_ListInvitations.go index 552a7dce644..3331ee615d8 100644 --- a/service/guardduty/api_op_ListInvitations.go +++ b/service/guardduty/api_op_ListInvitations.go @@ -31,8 +31,8 @@ func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInp type ListInvitationsInput struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. MaxResults int32 // You can use this parameter when paginating results. Set the value of this @@ -129,8 +129,8 @@ var _ ListInvitationsAPIClient = (*Client)(nil) // ListInvitationsPaginatorOptions is the paginator options for ListInvitations type ListInvitationsPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_ListMembers.go b/service/guardduty/api_op_ListMembers.go index e0cff55458a..685aa901850 100644 --- a/service/guardduty/api_op_ListMembers.go +++ b/service/guardduty/api_op_ListMembers.go @@ -49,8 +49,8 @@ type ListMembersInput struct { // Specifies whether to only return associated members or to return all members // (including members who haven't been invited yet or have been disassociated). // Member accounts must have been previously associated with the GuardDuty - // administrator account using Create Members - // (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html). + // administrator account using Create Members (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) + // . OnlyAssociated *string noSmithyDocumentSerde diff --git a/service/guardduty/api_op_ListOrganizationAdminAccounts.go b/service/guardduty/api_op_ListOrganizationAdminAccounts.go index a0c427176b7..4a05a3a2e4e 100644 --- a/service/guardduty/api_op_ListOrganizationAdminAccounts.go +++ b/service/guardduty/api_op_ListOrganizationAdminAccounts.go @@ -33,8 +33,8 @@ type ListOrganizationAdminAccountsInput struct { // The maximum number of results to return in the response. MaxResults int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/guardduty/api_op_ListPublishingDestinations.go b/service/guardduty/api_op_ListPublishingDestinations.go index 46160762aad..3b59bf35cfc 100644 --- a/service/guardduty/api_op_ListPublishingDestinations.go +++ b/service/guardduty/api_op_ListPublishingDestinations.go @@ -13,7 +13,7 @@ import ( ) // Returns a list of publishing destinations associated with the specified -// detectorId. +// detectorId . func (c *Client) ListPublishingDestinations(ctx context.Context, params *ListPublishingDestinationsInput, optFns ...func(*Options)) (*ListPublishingDestinationsOutput, error) { if params == nil { params = &ListPublishingDestinationsInput{} @@ -39,8 +39,8 @@ type ListPublishingDestinationsInput struct { // The maximum number of results to return in the response. MaxResults int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -56,8 +56,8 @@ type ListPublishingDestinationsOutput struct { // This member is required. Destinations []types.Destination - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/guardduty/api_op_ListTagsForResource.go b/service/guardduty/api_op_ListTagsForResource.go index 646fdaa44bb..677e2254747 100644 --- a/service/guardduty/api_op_ListTagsForResource.go +++ b/service/guardduty/api_op_ListTagsForResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists tags for a resource. Tagging is currently supported for detectors, finding -// filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. -// When invoked, this operation returns all assigned tags for a given resource. +// Lists tags for a resource. Tagging is currently supported for detectors, +// finding filters, IP sets, and threat intel sets, with a limit of 50 tags per +// resource. When invoked, this operation returns all assigned tags for a given +// resource. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/guardduty/api_op_ListThreatIntelSets.go b/service/guardduty/api_op_ListThreatIntelSets.go index 2ec87764af4..c1eadd91de7 100644 --- a/service/guardduty/api_op_ListThreatIntelSets.go +++ b/service/guardduty/api_op_ListThreatIntelSets.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. -// If you use this operation from a member account, the ThreatIntelSets associated -// with the administrator account are returned. +// Lists the ThreatIntelSets of the GuardDuty service specified by the detector +// ID. If you use this operation from a member account, the ThreatIntelSets +// associated with the administrator account are returned. func (c *Client) ListThreatIntelSets(ctx context.Context, params *ListThreatIntelSetsInput, optFns ...func(*Options)) (*ListThreatIntelSetsOutput, error) { if params == nil { params = &ListThreatIntelSetsInput{} @@ -36,12 +36,12 @@ type ListThreatIntelSetsInput struct { // This member is required. DetectorId *string - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. MaxResults int32 - // You can use this parameter to paginate results in the response. Set the value of - // this parameter to null on your first call to the list action. For subsequent + // You can use this parameter to paginate results in the response. Set the value + // of this parameter to null on your first call to the list action. For subsequent // calls to the action, fill nextToken in the request with the value of NextToken // from the previous response to continue listing data. NextToken *string @@ -129,8 +129,8 @@ func (c *Client) addOperationListThreatIntelSetsMiddlewares(stack *middleware.St return nil } -// ListThreatIntelSetsAPIClient is a client that implements the ListThreatIntelSets -// operation. +// ListThreatIntelSetsAPIClient is a client that implements the +// ListThreatIntelSets operation. type ListThreatIntelSetsAPIClient interface { ListThreatIntelSets(context.Context, *ListThreatIntelSetsInput, ...func(*Options)) (*ListThreatIntelSetsOutput, error) } @@ -140,8 +140,8 @@ var _ ListThreatIntelSetsAPIClient = (*Client)(nil) // ListThreatIntelSetsPaginatorOptions is the paginator options for // ListThreatIntelSets type ListThreatIntelSetsPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 50. The maximum value is 50. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 50. The maximum value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/guardduty/api_op_StartMonitoringMembers.go b/service/guardduty/api_op_StartMonitoringMembers.go index 1b6f485d0e3..62177355266 100644 --- a/service/guardduty/api_op_StartMonitoringMembers.go +++ b/service/guardduty/api_op_StartMonitoringMembers.go @@ -13,8 +13,7 @@ import ( // Turns on GuardDuty monitoring of the specified member accounts. Use this // operation to restart monitoring of accounts that you stopped monitoring with the -// StopMonitoringMembers -// (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_StopMonitoringMembers.html) +// StopMonitoringMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_StopMonitoringMembers.html) // operation. func (c *Client) StartMonitoringMembers(ctx context.Context, params *StartMonitoringMembersInput, optFns ...func(*Options)) (*StartMonitoringMembersOutput, error) { if params == nil { diff --git a/service/guardduty/api_op_StopMonitoringMembers.go b/service/guardduty/api_op_StopMonitoringMembers.go index fed482031d9..b44ac49b5da 100644 --- a/service/guardduty/api_op_StopMonitoringMembers.go +++ b/service/guardduty/api_op_StopMonitoringMembers.go @@ -13,7 +13,7 @@ import ( // Stops GuardDuty monitoring for the specified member accounts. Use the // StartMonitoringMembers operation to restart monitoring for those accounts. With -// autoEnableOrganizationMembers configuration for your organization set to ALL, +// autoEnableOrganizationMembers configuration for your organization set to ALL , // you'll receive an error if you attempt to stop monitoring the member accounts in // your organization. func (c *Client) StopMonitoringMembers(ctx context.Context, params *StopMonitoringMembersInput, optFns ...func(*Options)) (*StopMonitoringMembersOutput, error) { diff --git a/service/guardduty/api_op_UnarchiveFindings.go b/service/guardduty/api_op_UnarchiveFindings.go index b26e26b1745..fdfee1e147b 100644 --- a/service/guardduty/api_op_UnarchiveFindings.go +++ b/service/guardduty/api_op_UnarchiveFindings.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Unarchives GuardDuty findings specified by the findingIds. +// Unarchives GuardDuty findings specified by the findingIds . func (c *Client) UnarchiveFindings(ctx context.Context, params *UnarchiveFindingsInput, optFns ...func(*Options)) (*UnarchiveFindingsOutput, error) { if params == nil { params = &UnarchiveFindingsInput{} diff --git a/service/guardduty/api_op_UpdateDetector.go b/service/guardduty/api_op_UpdateDetector.go index 4b4988ab23c..03c8461b851 100644 --- a/service/guardduty/api_op_UpdateDetector.go +++ b/service/guardduty/api_op_UpdateDetector.go @@ -14,8 +14,8 @@ import ( // Updates the Amazon GuardDuty detector specified by the detectorId. There might // be regional differences because some data sources might not be available in all // the Amazon Web Services Regions where GuardDuty is presently supported. For more -// information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) UpdateDetector(ctx context.Context, params *UpdateDetectorInput, optFns ...func(*Options)) (*UpdateDetectorOutput, error) { if params == nil { params = &UpdateDetectorInput{} @@ -41,8 +41,8 @@ type UpdateDetectorInput struct { // Describes which data sources will be updated. There might be regional // differences because some data sources might not be available in all the Amazon // Web Services Regions where GuardDuty is presently supported. For more - // information, see Regions and endpoints - // (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). + // information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) + // . // // Deprecated: This parameter is deprecated, use Features instead DataSources *types.DataSourceConfigurations diff --git a/service/guardduty/api_op_UpdateFilter.go b/service/guardduty/api_op_UpdateFilter.go index ffc5fd4d993..8480b1045df 100644 --- a/service/guardduty/api_op_UpdateFilter.go +++ b/service/guardduty/api_op_UpdateFilter.go @@ -44,10 +44,10 @@ type UpdateFilterInput struct { // filter. Action types.FilterAction - // The description of the filter. Valid characters include alphanumeric characters, - // and special characters such as hyphen, period, colon, underscore, parentheses ({ - // }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form - // feed, return, and whitespace. + // The description of the filter. Valid characters include alphanumeric + // characters, and special characters such as hyphen, period, colon, underscore, + // parentheses ( { } , [ ] , and ( ) ), forward slash, horizontal tab, vertical + // tab, newline, form feed, return, and whitespace. Description *string // Represents the criteria to be used in the filter for querying findings. diff --git a/service/guardduty/api_op_UpdateMalwareScanSettings.go b/service/guardduty/api_op_UpdateMalwareScanSettings.go index 61878065eaf..c6dbd91a729 100644 --- a/service/guardduty/api_op_UpdateMalwareScanSettings.go +++ b/service/guardduty/api_op_UpdateMalwareScanSettings.go @@ -14,8 +14,8 @@ import ( // Updates the malware scan settings. There might be regional differences because // some data sources might not be available in all the Amazon Web Services Regions // where GuardDuty is presently supported. For more information, see Regions and -// endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) UpdateMalwareScanSettings(ctx context.Context, params *UpdateMalwareScanSettingsInput, optFns ...func(*Options)) (*UpdateMalwareScanSettingsOutput, error) { if params == nil { params = &UpdateMalwareScanSettingsInput{} diff --git a/service/guardduty/api_op_UpdateMemberDetectors.go b/service/guardduty/api_op_UpdateMemberDetectors.go index 5ebc65981d4..991e847a7d8 100644 --- a/service/guardduty/api_op_UpdateMemberDetectors.go +++ b/service/guardduty/api_op_UpdateMemberDetectors.go @@ -14,8 +14,8 @@ import ( // Contains information on member accounts to be updated. There might be regional // differences because some data sources might not be available in all the Amazon // Web Services Regions where GuardDuty is presently supported. For more -// information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) UpdateMemberDetectors(ctx context.Context, params *UpdateMemberDetectorsInput, optFns ...func(*Options)) (*UpdateMemberDetectorsOutput, error) { if params == nil { params = &UpdateMemberDetectorsInput{} diff --git a/service/guardduty/api_op_UpdateOrganizationConfiguration.go b/service/guardduty/api_op_UpdateOrganizationConfiguration.go index f1495ef8996..4a25e1588fe 100644 --- a/service/guardduty/api_op_UpdateOrganizationConfiguration.go +++ b/service/guardduty/api_op_UpdateOrganizationConfiguration.go @@ -12,11 +12,11 @@ import ( ) // Configures the delegated administrator account with the provided values. You -// must provide the value for either autoEnableOrganizationMembers or autoEnable. +// must provide the value for either autoEnableOrganizationMembers or autoEnable . // There might be regional differences because some data sources might not be // available in all the Amazon Web Services Regions where GuardDuty is presently -// supported. For more information, see Regions and endpoints -// (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html). +// supported. For more information, see Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) +// . func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error) { if params == nil { params = &UpdateOrganizationConfigurationInput{} @@ -46,21 +46,17 @@ type UpdateOrganizationConfigurationInput struct { // Deprecated: This field is deprecated, use AutoEnableOrganizationMembers instead AutoEnable bool - // Indicates the auto-enablement configuration of GuardDuty for the member accounts - // in the organization. - // - // * NEW: Indicates that when a new account joins the - // organization, they will have GuardDuty enabled automatically. - // - // * ALL: Indicates - // that all accounts in the Amazon Web Services Organization have GuardDuty enabled - // automatically. This includes NEW accounts that join the organization and - // accounts that may have been suspended or removed from the organization in - // GuardDuty. - // - // * NONE: Indicates that GuardDuty will not be automatically enabled - // for any accounts in the organization. GuardDuty must be managed for each account - // individually by the administrator. + // Indicates the auto-enablement configuration of GuardDuty for the member + // accounts in the organization. + // - NEW : Indicates that when a new account joins the organization, they will + // have GuardDuty enabled automatically. + // - ALL : Indicates that all accounts in the Amazon Web Services Organization + // have GuardDuty enabled automatically. This includes NEW accounts that join the + // organization and accounts that may have been suspended or removed from the + // organization in GuardDuty. + // - NONE : Indicates that GuardDuty will not be automatically enabled for any + // accounts in the organization. GuardDuty must be managed for each account + // individually by the administrator. AutoEnableOrganizationMembers types.AutoEnableMembers // Describes which data sources will be updated. diff --git a/service/guardduty/api_op_UpdatePublishingDestination.go b/service/guardduty/api_op_UpdatePublishingDestination.go index cd3cef3c2fd..4712e276ce2 100644 --- a/service/guardduty/api_op_UpdatePublishingDestination.go +++ b/service/guardduty/api_op_UpdatePublishingDestination.go @@ -12,7 +12,7 @@ import ( ) // Updates information about the publishing destination specified by the -// destinationId. +// destinationId . func (c *Client) UpdatePublishingDestination(ctx context.Context, params *UpdatePublishingDestinationInput, optFns ...func(*Options)) (*UpdatePublishingDestinationOutput, error) { if params == nil { params = &UpdatePublishingDestinationInput{} @@ -40,8 +40,8 @@ type UpdatePublishingDestinationInput struct { // This member is required. DetectorId *string - // A DestinationProperties object that includes the DestinationArn and KmsKeyArn of - // the publishing destination. + // A DestinationProperties object that includes the DestinationArn and KmsKeyArn + // of the publishing destination. DestinationProperties *types.DestinationProperties noSmithyDocumentSerde diff --git a/service/guardduty/types/enums.go b/service/guardduty/types/enums.go index 3ba7e44fd28..41daef57786 100644 --- a/service/guardduty/types/enums.go +++ b/service/guardduty/types/enums.go @@ -138,9 +138,9 @@ const ( CriterionKeyScanStatus CriterionKey = "SCAN_STATUS" ) -// Values returns all known values for CriterionKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CriterionKey. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CriterionKey) Values() []CriterionKey { return []CriterionKey{ "EC2_INSTANCE_ARN", @@ -250,8 +250,8 @@ const ( DetectorFeatureResultEksRuntimeMonitoring DetectorFeatureResult = "EKS_RUNTIME_MONITORING" ) -// Values returns all known values for DetectorFeatureResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DetectorFeatureResult. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DetectorFeatureResult) Values() []DetectorFeatureResult { return []DetectorFeatureResult{ @@ -363,9 +363,9 @@ const ( FilterActionArchive FilterAction = "ARCHIVE" ) -// Values returns all known values for FilterAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FilterAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FilterAction) Values() []FilterAction { return []FilterAction{ "NOOP", @@ -542,8 +542,8 @@ const ( OrgFeatureAdditionalConfigurationEksAddonManagement OrgFeatureAdditionalConfiguration = "EKS_ADDON_MANAGEMENT" ) -// Values returns all known values for OrgFeatureAdditionalConfiguration. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for OrgFeatureAdditionalConfiguration. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (OrgFeatureAdditionalConfiguration) Values() []OrgFeatureAdditionalConfiguration { @@ -599,9 +599,9 @@ const ( ResourceTypeEks ResourceType = "EKS" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "EKS", @@ -731,9 +731,9 @@ const ( UsageFeatureEksRuntimeMonitoring UsageFeature = "EKS_RUNTIME_MONITORING" ) -// Values returns all known values for UsageFeature. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UsageFeature. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UsageFeature) Values() []UsageFeature { return []UsageFeature{ "FLOW_LOGS", diff --git a/service/guardduty/types/types.go b/service/guardduty/types/types.go index 68b15a995a8..dd87cc29cd9 100644 --- a/service/guardduty/types/types.go +++ b/service/guardduty/types/types.go @@ -189,21 +189,20 @@ type AwsApiCallAction struct { } // Contains information on how the bucker owner's S3 Block Public Access settings -// are being applied to the S3 bucket. See S3 Block Public Access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// are being applied to the S3 bucket. See S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) // for more information. type BlockPublicAccess struct { - // Indicates if S3 Block Public Access is set to BlockPublicAcls. + // Indicates if S3 Block Public Access is set to BlockPublicAcls . BlockPublicAcls bool - // Indicates if S3 Block Public Access is set to BlockPublicPolicy. + // Indicates if S3 Block Public Access is set to BlockPublicPolicy . BlockPublicPolicy bool - // Indicates if S3 Block Public Access is set to IgnorePublicAcls. + // Indicates if S3 Block Public Access is set to IgnorePublicAcls . IgnorePublicAcls bool - // Indicates if S3 Block Public Access is set to RestrictPublicBuckets. + // Indicates if S3 Block Public Access is set to RestrictPublicBuckets . RestrictPublicBuckets bool noSmithyDocumentSerde @@ -263,8 +262,8 @@ type CloudTrailConfigurationResult struct { // Contains information about the condition. type Condition struct { - // Represents the equal condition to be applied to a single field when querying for - // findings. + // Represents the equal condition to be applied to a single field when querying + // for findings. // // Deprecated: This member has been deprecated. Eq []string @@ -313,8 +312,8 @@ type Condition struct { // Deprecated: This member has been deprecated. Lte int32 - // Represents the not equal condition to be applied to a single field when querying - // for findings. + // Represents the not equal condition to be applied to a single field when + // querying for findings. // // Deprecated: This member has been deprecated. Neq []string @@ -390,8 +389,8 @@ type CoverageEksClusterDetails struct { // operation. type CoverageFilterCondition struct { - // Represents an equal condition that is applied to a single field while retrieving - // the coverage details. + // Represents an equal condition that is applied to a single field while + // retrieving the coverage details. Equals []string // Represents a not equal condition that is applied to a single field while @@ -575,17 +574,16 @@ type DataSourcesFreeTrial struct { noSmithyDocumentSerde } -// Contains information on the server side encryption method used in the S3 bucket. -// See S3 Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) for -// more information. +// Contains information on the server side encryption method used in the S3 +// bucket. See S3 Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// for more information. type DefaultServerSideEncryption struct { // The type of encryption used for objects within the S3 bucket. EncryptionType *string // The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the - // bucket EncryptionType is aws:kms. + // bucket EncryptionType is aws:kms . KmsMasterKeyArn *string noSmithyDocumentSerde @@ -600,8 +598,8 @@ type Destination struct { // This member is required. DestinationId *string - // The type of resource used for the publishing destination. Currently, only Amazon - // S3 buckets are supported. + // The type of resource used for the publishing destination. Currently, only + // Amazon S3 buckets are supported. // // This member is required. DestinationType DestinationType @@ -650,8 +648,8 @@ type DetectorAdditionalConfigurationResult struct { // Status of the additional configuration. Status FeatureStatus - // The timestamp at which the additional configuration was last updated. This is in - // UTC format. + // The timestamp at which the additional configuration was last updated. This is + // in UTC format. UpdatedAt *time.Time noSmithyDocumentSerde @@ -710,8 +708,8 @@ type DnsRequestAction struct { // The domain information for the API request. Domain *string - // The network connection protocol observed in the activity that prompted GuardDuty - // to generate the finding. + // The network connection protocol observed in the activity that prompted + // GuardDuty to generate the finding. Protocol *string noSmithyDocumentSerde @@ -1160,8 +1158,8 @@ type KubernetesApiCallAction struct { // The Kubernetes API request URI. RequestUri *string - // The IP of the Kubernetes API caller and the IPs of any proxies or load balancers - // between the caller and the API endpoint. + // The IP of the Kubernetes API caller and the IPs of any proxies or load + // balancers between the caller and the API endpoint. SourceIps []string // The resulting HTTP response code of the Kubernetes API call action. @@ -1371,8 +1369,8 @@ type MalwareProtectionConfiguration struct { noSmithyDocumentSerde } -// An object that contains information on the status of all Malware Protection data -// sources. +// An object that contains information on the status of all Malware Protection +// data sources. type MalwareProtectionConfigurationResult struct { // Describes the configuration of Malware Protection for EC2 instances with @@ -1520,8 +1518,8 @@ type MemberFeaturesConfiguration struct { // Contains information about the features for the member account. type MemberFeaturesConfigurationResult struct { - // Indicates the additional configuration of the feature that is configured for the - // member account. + // Indicates the additional configuration of the feature that is configured for + // the member account. AdditionalConfiguration []MemberAdditionalConfigurationResult // Indicates the name of the feature that is enabled for the detector. @@ -1638,10 +1636,10 @@ type OrganizationAdditionalConfiguration struct { // organization. type OrganizationAdditionalConfigurationResult struct { - // Describes how The status of the additional configuration that are configured for - // the member accounts within the organization. If you set AutoEnable to NEW, a - // feature will be configured for only the new accounts when they join the - // organization. If you set AutoEnable to NONE, no feature will be configured for + // Describes how The status of the additional configuration that are configured + // for the member accounts within the organization. If you set AutoEnable to NEW , + // a feature will be configured for only the new accounts when they join the + // organization. If you set AutoEnable to NONE , no feature will be configured for // the accounts when they join the organization. AutoEnable OrgFeatureStatus @@ -1734,10 +1732,10 @@ type OrganizationFeatureConfigurationResult struct { AdditionalConfiguration []OrganizationAdditionalConfigurationResult // Describes how The status of the feature that are configured for the member - // accounts within the organization. If you set AutoEnable to NEW, a feature will + // accounts within the organization. If you set AutoEnable to NEW , a feature will // be configured for only the new accounts when they join the organization. If you - // set AutoEnable to NONE, no feature will be configured for the accounts when they - // join the organization. + // set AutoEnable to NONE , no feature will be configured for the accounts when + // they join the organization. AutoEnable OrgFeatureStatus // The name of the feature that is configured for the member accounts within the @@ -1763,8 +1761,8 @@ type OrganizationKubernetesAuditLogsConfiguration struct { // organization. type OrganizationKubernetesAuditLogsConfigurationResult struct { - // Whether Kubernetes audit logs data source should be auto-enabled for new members - // joining the organization. + // Whether Kubernetes audit logs data source should be auto-enabled for new + // members joining the organization. // // This member is required. AutoEnable bool @@ -1775,8 +1773,8 @@ type OrganizationKubernetesAuditLogsConfigurationResult struct { // Organization-wide Kubernetes data sources configurations. type OrganizationKubernetesConfiguration struct { - // Whether Kubernetes audit logs data source should be auto-enabled for new members - // joining the organization. + // Whether Kubernetes audit logs data source should be auto-enabled for new + // members joining the organization. // // This member is required. AuditLogs *OrganizationKubernetesAuditLogsConfiguration @@ -1806,8 +1804,8 @@ type OrganizationMalwareProtectionConfiguration struct { noSmithyDocumentSerde } -// An object that contains information on the status of all Malware Protection data -// source for an organization. +// An object that contains information on the status of all Malware Protection +// data source for an organization. type OrganizationMalwareProtectionConfigurationResult struct { // Describes the configuration for scanning EC2 instances with findings for an @@ -1853,8 +1851,8 @@ type OrganizationScanEc2InstanceWithFindings struct { noSmithyDocumentSerde } -// An object that contains information on the status of scanning EC2 instances with -// findings for an organization. +// An object that contains information on the status of scanning EC2 instances +// with findings for an organization. type OrganizationScanEc2InstanceWithFindingsResult struct { // Describes the configuration for scanning EBS volumes for an organization. @@ -1867,8 +1865,7 @@ type OrganizationScanEc2InstanceWithFindingsResult struct { type Owner struct { // The canonical user ID of the bucket owner. For information about locating your - // canonical user ID see Finding Your Account Canonical User ID. - // (https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId) + // canonical user ID see Finding Your Account Canonical User ID. (https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId) Id *string noSmithyDocumentSerde @@ -2005,8 +2002,8 @@ type RdsDbInstanceDetails struct { // involved in the finding. DbClusterIdentifier *string - // The Amazon Resource Name (ARN) that identifies the database instance involved in - // the finding. + // The Amazon Resource Name (ARN) that identifies the database instance involved + // in the finding. DbInstanceArn *string // The identifier associated to the database instance that was involved in the @@ -2354,8 +2351,8 @@ type Scan struct { // Contains information about the condition. type ScanCondition struct { - // Represents an mapEqual condition to be applied to a single field when triggering - // for malware scan. + // Represents an mapEqual condition to be applied to a single field when + // triggering for malware scan. // // This member is required. MapEquals []ScanConditionPair @@ -2454,8 +2451,8 @@ type ScannedItemCount struct { // malware scan. type ScanResourceCriteria struct { - // Represents condition that when matched will prevent a malware scan for a certain - // resource. + // Represents condition that when matched will prevent a malware scan for a + // certain resource. Exclude map[string]ScanCondition // Represents condition that when matched will allow a malware scan for a certain @@ -2539,8 +2536,8 @@ type Service struct { // this finding. EventFirstSeen *string - // The last-seen timestamp of the activity that prompted GuardDuty to generate this - // finding. + // The last-seen timestamp of the activity that prompted GuardDuty to generate + // this finding. EventLastSeen *string // An evidence object associated with the service. @@ -2581,7 +2578,7 @@ type ServiceAdditionalInfo struct { // Contains information about the criteria used for sorting findings. type SortCriteria struct { - // Represents the finding attribute, such as accountId, that sorts the findings. + // Represents the finding attribute, such as accountId , that sorts the findings. AttributeName *string // The order by which the sorted findings are to be displayed. @@ -2608,8 +2605,8 @@ type ThreatDetectedByName struct { // Total number of infected files identified. ItemCount int32 - // Flag to determine if the finding contains every single infected file-path and/or - // every threat. + // Flag to determine if the finding contains every single infected file-path + // and/or every threat. Shortened bool // List of identified threats with details, organized by threat name. @@ -2687,8 +2684,8 @@ type UnprocessedAccount struct { // Specifies the names of the data sources that couldn't be enabled. type UnprocessedDataSourcesResult struct { - // An object that contains information on the status of all Malware Protection data - // sources. + // An object that contains information on the status of all Malware Protection + // data sources. MalwareProtection *MalwareProtectionConfigurationResult noSmithyDocumentSerde diff --git a/service/health/api_client.go b/service/health/api_client.go index fdf72357de0..e05ddb426b0 100644 --- a/service/health/api_client.go +++ b/service/health/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/health/api_op_DescribeAffectedAccountsForOrganization.go b/service/health/api_op_DescribeAffectedAccountsForOrganization.go index 410ee73d943..6d7b05d4bd4 100644 --- a/service/health/api_op_DescribeAffectedAccountsForOrganization.go +++ b/service/health/api_op_DescribeAffectedAccountsForOrganization.go @@ -14,11 +14,9 @@ import ( // Returns a list of accounts in the organization from Organizations that are // affected by the provided event. For more information about the different types -// of Health events, see Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html). Before -// you can call this operation, you must first enable Health to work with -// Organizations. To do this, call the EnableHealthServiceAccessForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) +// of Health events, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// . Before you can call this operation, you must first enable Health to work with +// Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // operation from your organization's management account. This API operation uses // pagination. Specify the nextToken parameter in the next request to return more // results. @@ -68,19 +66,15 @@ type DescribeAffectedAccountsForOrganizationOutput struct { // This parameter specifies if the Health event is a public Amazon Web Services // service event or an account-specific event. - // - // * If the eventScopeCode value is - // PUBLIC, then the affectedAccounts value is always empty. - // - // * If the - // eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists - // the affected Amazon Web Services accounts in your organization. For example, if - // an event affects a service such as Amazon Elastic Compute Cloud and you have - // Amazon Web Services accounts that use that service, those account IDs appear in - // the response. - // - // * If the eventScopeCode value is NONE, then the eventArn that you - // specified in the request is invalid or doesn't exist. + // - If the eventScopeCode value is PUBLIC , then the affectedAccounts value is + // always empty. + // - If the eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts + // value lists the affected Amazon Web Services accounts in your organization. For + // example, if an event affects a service such as Amazon Elastic Compute Cloud and + // you have Amazon Web Services accounts that use that service, those account IDs + // appear in the response. + // - If the eventScopeCode value is NONE , then the eventArn that you specified + // in the request is invalid or doesn't exist. EventScopeCode types.EventScopeCode // If the results of a search are large, only a portion of the results are @@ -159,16 +153,16 @@ func (c *Client) addOperationDescribeAffectedAccountsForOrganizationMiddlewares( return nil } -// DescribeAffectedAccountsForOrganizationAPIClient is a client that implements the -// DescribeAffectedAccountsForOrganization operation. +// DescribeAffectedAccountsForOrganizationAPIClient is a client that implements +// the DescribeAffectedAccountsForOrganization operation. type DescribeAffectedAccountsForOrganizationAPIClient interface { DescribeAffectedAccountsForOrganization(context.Context, *DescribeAffectedAccountsForOrganizationInput, ...func(*Options)) (*DescribeAffectedAccountsForOrganizationOutput, error) } var _ DescribeAffectedAccountsForOrganizationAPIClient = (*Client)(nil) -// DescribeAffectedAccountsForOrganizationPaginatorOptions is the paginator options -// for DescribeAffectedAccountsForOrganization +// DescribeAffectedAccountsForOrganizationPaginatorOptions is the paginator +// options for DescribeAffectedAccountsForOrganization type DescribeAffectedAccountsForOrganizationPaginatorOptions struct { // The maximum number of items to return in one batch, between 10 and 100, // inclusive. diff --git a/service/health/api_op_DescribeAffectedEntities.go b/service/health/api_op_DescribeAffectedEntities.go index e09872c4aac..704aaecd0b1 100644 --- a/service/health/api_op_DescribeAffectedEntities.go +++ b/service/health/api_op_DescribeAffectedEntities.go @@ -18,16 +18,12 @@ import ( // depending on the Amazon Web Services service. Events that have impact beyond // that of the affected entities, or where the extent of impact is unknown, include // at least one entity indicating this. At least one event ARN is required. -// -// * This -// API operation uses pagination. Specify the nextToken parameter in the next -// request to return more results. -// -// * This operation supports resource-level -// permissions. You can use this operation to allow or deny access to specific -// Health events. For more information, see Resource- and action-based conditions -// (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) -// in the Health User Guide. +// - This API operation uses pagination. Specify the nextToken parameter in the +// next request to return more results. +// - This operation supports resource-level permissions. You can use this +// operation to allow or deny access to specific Health events. For more +// information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) +// in the Health User Guide. func (c *Client) DescribeAffectedEntities(ctx context.Context, params *DescribeAffectedEntitiesInput, optFns ...func(*Options)) (*DescribeAffectedEntitiesOutput, error) { if params == nil { params = &DescribeAffectedEntitiesInput{} diff --git a/service/health/api_op_DescribeAffectedEntitiesForOrganization.go b/service/health/api_op_DescribeAffectedEntitiesForOrganization.go index 8bb659f75df..1d399dd7c5e 100644 --- a/service/health/api_op_DescribeAffectedEntitiesForOrganization.go +++ b/service/health/api_op_DescribeAffectedEntitiesForOrganization.go @@ -12,26 +12,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of entities that have been affected by one or more events for one -// or more accounts in your organization in Organizations, based on the filter +// Returns a list of entities that have been affected by one or more events for +// one or more accounts in your organization in Organizations, based on the filter // criteria. Entities can refer to individual customer resources, groups of // customer resources, or any other construct, depending on the Amazon Web Services // service. At least one event Amazon Resource Name (ARN) and account ID are // required. Before you can call this operation, you must first enable Health to // work with Organizations. To do this, call the -// EnableHealthServiceAccessForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) +// EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // operation from your organization's management account. -// -// * This API operation -// uses pagination. Specify the nextToken parameter in the next request to return -// more results. -// -// * This operation doesn't support resource-level permissions. You -// can't use this operation to allow or deny access to specific Health events. For -// more information, see Resource- and action-based conditions -// (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) -// in the Health User Guide. +// - This API operation uses pagination. Specify the nextToken parameter in the +// next request to return more results. +// - This operation doesn't support resource-level permissions. You can't use +// this operation to allow or deny access to specific Health events. For more +// information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) +// in the Health User Guide. func (c *Client) DescribeAffectedEntitiesForOrganization(ctx context.Context, params *DescribeAffectedEntitiesForOrganizationInput, optFns ...func(*Options)) (*DescribeAffectedEntitiesForOrganizationOutput, error) { if params == nil { params = &DescribeAffectedEntitiesForOrganizationInput{} @@ -49,7 +44,7 @@ func (c *Client) DescribeAffectedEntitiesForOrganization(ctx context.Context, pa type DescribeAffectedEntitiesForOrganizationInput struct { - // A JSON set of elements including the awsAccountId and the eventArn. + // A JSON set of elements including the awsAccountId and the eventArn . // // This member is required. OrganizationEntityFilters []types.EventAccountFilter @@ -74,12 +69,12 @@ type DescribeAffectedEntitiesForOrganizationInput struct { type DescribeAffectedEntitiesForOrganizationOutput struct { - // A JSON set of elements including the awsAccountId and its entityArn, entityValue - // and its entityArn, lastUpdatedTime, and statusCode. + // A JSON set of elements including the awsAccountId and its entityArn , + // entityValue and its entityArn , lastUpdatedTime , and statusCode . Entities []types.AffectedEntity - // A JSON set of elements of the failed response, including the awsAccountId, - // errorMessage, errorName, and eventArn. + // A JSON set of elements of the failed response, including the awsAccountId , + // errorMessage , errorName , and eventArn . FailedSet []types.OrganizationAffectedEntitiesErrorItem // If the results of a search are large, only a portion of the results are @@ -158,16 +153,16 @@ func (c *Client) addOperationDescribeAffectedEntitiesForOrganizationMiddlewares( return nil } -// DescribeAffectedEntitiesForOrganizationAPIClient is a client that implements the -// DescribeAffectedEntitiesForOrganization operation. +// DescribeAffectedEntitiesForOrganizationAPIClient is a client that implements +// the DescribeAffectedEntitiesForOrganization operation. type DescribeAffectedEntitiesForOrganizationAPIClient interface { DescribeAffectedEntitiesForOrganization(context.Context, *DescribeAffectedEntitiesForOrganizationInput, ...func(*Options)) (*DescribeAffectedEntitiesForOrganizationOutput, error) } var _ DescribeAffectedEntitiesForOrganizationAPIClient = (*Client)(nil) -// DescribeAffectedEntitiesForOrganizationPaginatorOptions is the paginator options -// for DescribeAffectedEntitiesForOrganization +// DescribeAffectedEntitiesForOrganizationPaginatorOptions is the paginator +// options for DescribeAffectedEntitiesForOrganization type DescribeAffectedEntitiesForOrganizationPaginatorOptions struct { // The maximum number of items to return in one batch, between 10 and 100, // inclusive. diff --git a/service/health/api_op_DescribeEventAggregates.go b/service/health/api_op_DescribeEventAggregates.go index 7fa8ebec826..3a5bbeaae8d 100644 --- a/service/health/api_op_DescribeEventAggregates.go +++ b/service/health/api_op_DescribeEventAggregates.go @@ -33,7 +33,7 @@ func (c *Client) DescribeEventAggregates(ctx context.Context, params *DescribeEv type DescribeEventAggregatesInput struct { - // The only currently supported value is eventTypeCategory. + // The only currently supported value is eventTypeCategory . // // This member is required. AggregateField types.EventAggregateField diff --git a/service/health/api_op_DescribeEventDetails.go b/service/health/api_op_DescribeEventDetails.go index 3586c4c2897..a613bce42bd 100644 --- a/service/health/api_op_DescribeEventDetails.go +++ b/service/health/api_op_DescribeEventDetails.go @@ -13,17 +13,14 @@ import ( // Returns detailed information about one or more specified events. Information // includes standard event data (Amazon Web Services Region, service, and so on, as -// returned by DescribeEvents -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html)), -// a detailed event description, and possible additional metadata that depends upon -// the nature of the event. Affected entities are not included. To retrieve the -// entities, use the DescribeAffectedEntities -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) +// returned by DescribeEvents (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html) +// ), a detailed event description, and possible additional metadata that depends +// upon the nature of the event. Affected entities are not included. To retrieve +// the entities, use the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) // operation. If a specified event can't be retrieved, an error message is returned // for that event. This operation supports resource-level permissions. You can use // this operation to allow or deny access to specific Health events. For more -// information, see Resource- and action-based conditions -// (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) +// information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) // in the Health User Guide. func (c *Client) DescribeEventDetails(ctx context.Context, params *DescribeEventDetailsInput, optFns ...func(*Options)) (*DescribeEventDetailsOutput, error) { if params == nil { diff --git a/service/health/api_op_DescribeEventDetailsForOrganization.go b/service/health/api_op_DescribeEventDetailsForOrganization.go index 81e0fcf20b6..831427b24cd 100644 --- a/service/health/api_op_DescribeEventDetailsForOrganization.go +++ b/service/health/api_op_DescribeEventDetailsForOrganization.go @@ -17,34 +17,27 @@ import ( // event description, and (depending on the event) possible metadata. This // operation doesn't return affected entities, such as the resources related to the // event. To return affected entities, use the -// DescribeAffectedEntitiesForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) +// DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) // operation. Before you can call this operation, you must first enable Health to // work with Organizations. To do this, call the -// EnableHealthServiceAccessForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) +// EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // operation from your organization's management account. When you call the // DescribeEventDetailsForOrganization operation, specify the // organizationEventDetailFilters object in the request. Depending on the Health // event type, note the following differences: +// - To return event details for a public event, you must specify a null value +// for the awsAccountId parameter. If you specify an account ID for a public +// event, Health returns an error message because public events aren't specific to +// an account. +// - To return event details for an event that is specific to an account in your +// organization, you must specify the awsAccountId parameter in the request. If +// you don't specify an account ID, Health returns an error message because the +// event is specific to an account in your organization. // -// * To return event details for a -// public event, you must specify a null value for the awsAccountId parameter. If -// you specify an account ID for a public event, Health returns an error message -// because public events aren't specific to an account. -// -// * To return event details -// for an event that is specific to an account in your organization, you must -// specify the awsAccountId parameter in the request. If you don't specify an -// account ID, Health returns an error message because the event is specific to an -// account in your organization. -// -// For more information, see Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html). This -// operation doesn't support resource-level permissions. You can't use this +// For more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// . This operation doesn't support resource-level permissions. You can't use this // operation to allow or deny access to specific Health events. For more -// information, see Resource- and action-based conditions -// (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) +// information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) // in the Health User Guide. func (c *Client) DescribeEventDetailsForOrganization(ctx context.Context, params *DescribeEventDetailsForOrganizationInput, optFns ...func(*Options)) (*DescribeEventDetailsForOrganizationOutput, error) { if params == nil { @@ -63,7 +56,7 @@ func (c *Client) DescribeEventDetailsForOrganization(ctx context.Context, params type DescribeEventDetailsForOrganizationInput struct { - // A set of JSON elements that includes the awsAccountId and the eventArn. + // A set of JSON elements that includes the awsAccountId and the eventArn . // // This member is required. OrganizationEventDetailFilters []types.EventAccountFilter diff --git a/service/health/api_op_DescribeEventTypes.go b/service/health/api_op_DescribeEventTypes.go index 1ed2f41e3cd..000c657222f 100644 --- a/service/health/api_op_DescribeEventTypes.go +++ b/service/health/api_op_DescribeEventTypes.go @@ -15,8 +15,7 @@ import ( // Returns the event types that meet the specified filter criteria. You can use // this API operation to find information about the Health event, such as the // category, Amazon Web Services service, and event code. The metadata for each -// event appears in the EventType -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html) +// event appears in the EventType (https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html) // object. If you don't specify a filter criteria, the API operation returns all // event types, in no particular order. This API operation uses pagination. Specify // the nextToken parameter in the next request to return more results. @@ -61,9 +60,9 @@ type DescribeEventTypesInput struct { type DescribeEventTypesOutput struct { // A list of event types that match the filter criteria. Event types have a - // category (issue, accountNotification, or scheduledChange), a service (for - // example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format - // AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). + // category ( issue , accountNotification , or scheduledChange ), a service (for + // example, EC2 , RDS , DATAPIPELINE , BILLING ), and a code (in the format + // AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT ). EventTypes []types.EventType // If the results of a search are large, only a portion of the results are diff --git a/service/health/api_op_DescribeEvents.go b/service/health/api_op_DescribeEvents.go index 916bb4f40e4..41cae300f75 100644 --- a/service/health/api_op_DescribeEvents.go +++ b/service/health/api_op_DescribeEvents.go @@ -12,29 +12,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about events that meet the specified filter criteria. Events -// are returned in a summary form and do not include the detailed description, any -// additional metadata that depends on the event type, or any affected resources. -// To retrieve that information, use the DescribeEventDetails -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) -// and DescribeAffectedEntities -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) +// Returns information about events that meet the specified filter criteria. +// Events are returned in a summary form and do not include the detailed +// description, any additional metadata that depends on the event type, or any +// affected resources. To retrieve that information, use the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) +// and DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) // operations. If no filter criteria are specified, all events are returned. -// Results are sorted by lastModifiedTime, starting with the most recent event. -// -// * -// When you call the DescribeEvents operation and specify an entity for the -// entityValues parameter, Health might return public events that aren't specific -// to that resource. For example, if you call DescribeEvents and specify an ID for -// an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return -// events that aren't specific to that resource or service. To get events that are -// specific to a service, use the services parameter in the filter object. For more -// information, see Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html). -// -// * This -// API operation uses pagination. Specify the nextToken parameter in the next -// request to return more results. +// Results are sorted by lastModifiedTime , starting with the most recent event. +// - When you call the DescribeEvents operation and specify an entity for the +// entityValues parameter, Health might return public events that aren't specific +// to that resource. For example, if you call DescribeEvents and specify an ID +// for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return +// events that aren't specific to that resource or service. To get events that are +// specific to a service, use the services parameter in the filter object. For +// more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// . +// - This API operation uses pagination. Specify the nextToken parameter in the +// next request to return more results. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} diff --git a/service/health/api_op_DescribeEventsForOrganization.go b/service/health/api_op_DescribeEventsForOrganization.go index 1dddf52361e..1a37190e401 100644 --- a/service/health/api_op_DescribeEventsForOrganization.go +++ b/service/health/api_op_DescribeEventsForOrganization.go @@ -13,32 +13,21 @@ import ( ) // Returns information about events across your organization in Organizations. You -// can use thefilters parameter to specify the events that you want to return. +// can use the filters parameter to specify the events that you want to return. // Events are returned in a summary form and don't include the affected accounts, // detailed description, any additional metadata that depends on the event type, or // any affected resources. To retrieve that information, use the following // operations: +// - DescribeAffectedAccountsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html) +// - DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) +// - DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) // -// * DescribeAffectedAccountsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html) -// -// * -// DescribeEventDetailsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) -// -// * -// DescribeAffectedEntitiesForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) -// -// If -// you don't specify a filter, the DescribeEventsForOrganizations returns all -// events across your organization. Results are sorted by lastModifiedTime, +// If you don't specify a filter , the DescribeEventsForOrganizations returns all +// events across your organization. Results are sorted by lastModifiedTime , // starting with the most recent event. For more information about the different -// types of Health events, see Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html). Before -// you can call this operation, you must first enable Health to work with -// Organizations. To do this, call the EnableHealthServiceAccessForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) +// types of Health events, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// . Before you can call this operation, you must first enable Health to work with +// Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // operation from your organization's management account. This API operation uses // pagination. Specify the nextToken parameter in the next request to return more // results. diff --git a/service/health/api_op_DescribeHealthServiceStatusForOrganization.go b/service/health/api_op_DescribeHealthServiceStatusForOrganization.go index 1f922ff5243..9551659b14b 100644 --- a/service/health/api_op_DescribeHealthServiceStatusForOrganization.go +++ b/service/health/api_op_DescribeHealthServiceStatusForOrganization.go @@ -36,8 +36,8 @@ type DescribeHealthServiceStatusForOrganizationInput struct { type DescribeHealthServiceStatusForOrganizationOutput struct { // Information about the status of enabling or disabling the Health organizational - // view feature in your organization. Valid values are ENABLED | DISABLED | - // PENDING. + // view feature in your organization. Valid values are ENABLED | DISABLED | PENDING + // . HealthServiceAccessStatusForOrganization *string // Metadata pertaining to the operation's result. diff --git a/service/health/api_op_DisableHealthServiceAccessForOrganization.go b/service/health/api_op_DisableHealthServiceAccessForOrganization.go index a3b6935401a..a8f6cdbb445 100644 --- a/service/health/api_op_DisableHealthServiceAccessForOrganization.go +++ b/service/health/api_op_DisableHealthServiceAccessForOrganization.go @@ -13,16 +13,13 @@ import ( // Disables Health from working with Organizations. To call this operation, you // must sign in as an Identity and Access Management (IAM) user, assume an IAM // role, or sign in as the root user (not recommended) in the organization's -// management account. For more information, see Aggregating Health events -// (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the -// Health User Guide. This operation doesn't remove the service-linked role from -// the management account in your organization. You must use the IAM console, API, -// or Command Line Interface (CLI) to remove the service-linked role. For more -// information, see Deleting a Service-Linked Role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role) +// management account. For more information, see Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) +// in the Health User Guide. This operation doesn't remove the service-linked role +// from the management account in your organization. You must use the IAM console, +// API, or Command Line Interface (CLI) to remove the service-linked role. For more +// information, see Deleting a Service-Linked Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role) // in the IAM User Guide. You can also disable the organizational feature by using -// the Organizations DisableAWSServiceAccess -// (https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html) +// the Organizations DisableAWSServiceAccess (https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html) // API operation. After you call this operation, Health stops aggregating events // for all other Amazon Web Services accounts in your organization. If you call the // Health API operations for organizational view, Health returns an error. Health diff --git a/service/health/api_op_EnableHealthServiceAccessForOrganization.go b/service/health/api_op_EnableHealthServiceAccessForOrganization.go index ce62f0f1359..82f42e1ab3a 100644 --- a/service/health/api_op_EnableHealthServiceAccessForOrganization.go +++ b/service/health/api_op_EnableHealthServiceAccessForOrganization.go @@ -15,25 +15,20 @@ import ( // organization in a centralized location. This operation also creates a // service-linked role for the management account in the organization. To call this // operation, you must meet the following requirements: +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan +// from Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) to +// use the Health API. If you call the Health API from an Amazon Web Services +// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support +// plan, you receive a SubscriptionRequiredException error. +// - You must have permission to call this operation from the organization's +// management account. For example IAM policies, see Health identity-based +// policy examples (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html) +// . // -// * You must have a -// Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web -// Services Support (http://aws.amazon.com/premiumsupport/) to use the Health API. -// If you call the Health API from an Amazon Web Services account that doesn't have -// a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a -// SubscriptionRequiredException error. -// -// * You must have permission to call this -// operation from the organization's management account. For example IAM policies, -// see Health identity-based policy examples -// (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html). -// -// If -// you don't have the required support plan, you can instead use the Health console -// to enable the organizational view feature. For more information, see Aggregating -// Health events -// (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the -// Health User Guide. +// If you don't have the required support plan, you can instead use the Health +// console to enable the organizational view feature. For more information, see +// Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) +// in the Health User Guide. func (c *Client) EnableHealthServiceAccessForOrganization(ctx context.Context, params *EnableHealthServiceAccessForOrganizationInput, optFns ...func(*Options)) (*EnableHealthServiceAccessForOrganizationOutput, error) { if params == nil { params = &EnableHealthServiceAccessForOrganizationInput{} diff --git a/service/health/doc.go b/service/health/doc.go index 93378080a15..f0ac5d93076 100644 --- a/service/health/doc.go +++ b/service/health/doc.go @@ -4,48 +4,38 @@ // Health APIs and Notifications. // // Health The Health API provides programmatic access to the Health information -// that appears in the Personal Health Dashboard -// (https://phd.aws.amazon.com/phd/home#/). You can use the API operations to get -// information about events that might affect your Amazon Web Services services and -// resources. +// that appears in the Personal Health Dashboard (https://phd.aws.amazon.com/phd/home#/) +// . You can use the API operations to get information about events that might +// affect your Amazon Web Services services and resources. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan +// from Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) to +// use the Health API. If you call the Health API from an Amazon Web Services +// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support +// plan, you receive a SubscriptionRequiredException error. +// - You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to +// call the Health API operations. Health supports a multi-Region application +// architecture and has two regional endpoints in an active-passive configuration. +// You can use the high availability endpoint example to determine which Amazon Web +// Services Region is active, so that you can get the latest information from the +// API. For more information, see Accessing the Health API (https://docs.aws.amazon.com/health/latest/ug/health-api.html) +// in the Health User Guide. // -// * You must have a Business, Enterprise On-Ramp, or Enterprise -// Support plan from Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/) to use the Health API. If you call the -// Health API from an Amazon Web Services account that doesn't have a Business, -// Enterprise On-Ramp, or Enterprise Support plan, you receive a -// SubscriptionRequiredException error. -// -// * You can use the Health endpoint -// health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health -// supports a multi-Region application architecture and has two regional endpoints -// in an active-passive configuration. You can use the high availability endpoint -// example to determine which Amazon Web Services Region is active, so that you can -// get the latest information from the API. For more information, see Accessing the -// Health API (https://docs.aws.amazon.com/health/latest/ug/health-api.html) in the -// Health User Guide. -// -// For authentication of requests, Health uses the Signature -// Version 4 Signing Process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If -// your Amazon Web Services account is part of Organizations, you can use the +// For authentication of requests, Health uses the Signature Version 4 Signing +// Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . If your Amazon Web Services account is part of Organizations, you can use the // Health organizational view feature. This feature provides a centralized view of // Health events across all accounts in your organization. You can aggregate Health // events in real time to identify accounts in your organization that are affected // by an operational event or get notified of security vulnerabilities. Use the // organizational view API operations to enable this feature and return event -// information. For more information, see Aggregating Health events -// (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the -// Health User Guide. When you use the Health API operations to return Health -// events, see the following recommendations: -// -// * Use the eventScopeCode -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode) -// parameter to specify whether to return Health events that are public or -// account-specific. -// -// * Use pagination to view all events from the response. For -// example, if you call the DescribeEventsForOrganization operation to get all -// events in your organization, you might receive several page results. Specify the -// nextToken in the next request to return more results. +// information. For more information, see Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) +// in the Health User Guide. When you use the Health API operations to return +// Health events, see the following recommendations: +// - Use the eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode) +// parameter to specify whether to return Health events that are public or +// account-specific. +// - Use pagination to view all events from the response. For example, if you +// call the DescribeEventsForOrganization operation to get all events in your +// organization, you might receive several page results. Specify the nextToken in +// the next request to return more results. package health diff --git a/service/health/types/errors.go b/service/health/types/errors.go index 6b5c65f0aba..a9e9bfd23ac 100644 --- a/service/health/types/errors.go +++ b/service/health/types/errors.go @@ -7,11 +7,9 @@ import ( smithy "github.com/aws/smithy-go" ) -// EnableHealthServiceAccessForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) +// EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // is already in progress. Wait for the action to complete before trying again. To -// get the current status, use the DescribeHealthServiceStatusForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html) +// get the current status, use the DescribeHealthServiceStatusForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html) // operation. type ConcurrentModificationException struct { Message *string @@ -38,7 +36,7 @@ func (e *ConcurrentModificationException) ErrorCode() string { } func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified pagination token (nextToken) is not valid. +// The specified pagination token ( nextToken ) is not valid. type InvalidPaginationToken struct { Message *string diff --git a/service/health/types/types.go b/service/health/types/types.go index 171c4c7c36c..c0b177c808c 100644 --- a/service/health/types/types.go +++ b/service/health/types/types.go @@ -35,7 +35,7 @@ type AffectedEntity struct { LastUpdatedTime *time.Time // The most recent status of the entity affected by the event. The possible values - // are IMPAIRED, UNIMPAIRED, and UNKNOWN. + // are IMPAIRED , UNIMPAIRED , and UNKNOWN . StatusCode EntityStatusCode // A map of entity tags attached to the affected entity. Currently, the tags @@ -45,15 +45,13 @@ type AffectedEntity struct { noSmithyDocumentSerde } -// A range of dates and times that is used by the EventFilter -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) -// and EntityFilter -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) -// objects. If from is set and to is set: match items where the timestamp -// (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If -// from is set and to is not set: match items where the timestamp value is equal to -// or after from. If from is not set and to is set: match items where the timestamp -// value is equal to or before to. +// A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) +// and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) +// objects. If from is set and to is set: match items where the timestamp ( +// startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If +// from is set and to is not set: match items where the timestamp value is equal +// to or after from . If from is not set and to is set: match items where the +// timestamp value is equal to or before to . type DateTimeRange struct { // The starting date and time of a time range. @@ -66,8 +64,7 @@ type DateTimeRange struct { } // The number of entities that are affected by one or more events. Returned by the -// DescribeEntityAggregates -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html) +// DescribeEntityAggregates (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html) // operation. type EntityAggregate struct { @@ -83,8 +80,7 @@ type EntityAggregate struct { noSmithyDocumentSerde } -// The values to use to filter results from the DescribeAffectedEntities -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) +// The values to use to filter results from the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) // operation. type EntityFilter struct { @@ -104,7 +100,7 @@ type EntityFilter struct { // A list of the most recent dates and times that the entity was updated. LastUpdatedTimes []DateTimeRange - // A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN). + // A list of entity status codes ( IMPAIRED , UNIMPAIRED , or UNKNOWN ). StatusCodes []EntityStatusCode // A map of entity tags attached to the affected entity. Currently, the tags @@ -116,22 +112,18 @@ type EntityFilter struct { // Summary information about an Health event. Health events can be public or // account-specific: +// - Public events might be service events that are not specific to an Amazon +// Web Services account. For example, if there is an issue with an Amazon Web +// Services Region, Health provides information about the event, even if you don't +// use services or resources in that Region. +// - Account-specific events are specific to either your Amazon Web Services +// account or an account in your organization. For example, if there's an issue +// with Amazon Elastic Compute Cloud in a Region that you use, Health provides +// information about the event and the affected resources in the account. // -// * Public events might be service events that are not specific -// to an Amazon Web Services account. For example, if there is an issue with an -// Amazon Web Services Region, Health provides information about the event, even if -// you don't use services or resources in that Region. -// -// * Account-specific events -// are specific to either your Amazon Web Services account or an account in your -// organization. For example, if there's an issue with Amazon Elastic Compute Cloud -// in a Region that you use, Health provides information about the event and the -// affected resources in the account. -// -// You can determine if an event is public or -// account-specific by using the eventScopeCode parameter. For more information, -// see eventScopeCode -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode). +// You can determine if an event is public or account-specific by using the +// eventScopeCode parameter. For more information, see eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode) +// . type Event struct { // The unique identifier for the event. The event ARN has the @@ -148,28 +140,24 @@ type Event struct { // This parameter specifies if the Health event is a public Amazon Web Services // service event or an account-specific event. - // - // * If the eventScopeCode value is - // PUBLIC, then the affectedAccounts value is always empty. - // - // * If the - // eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists - // the affected Amazon Web Services accounts in your organization. For example, if - // an event affects a service such as Amazon Elastic Compute Cloud and you have - // Amazon Web Services accounts that use that service, those account IDs appear in - // the response. - // - // * If the eventScopeCode value is NONE, then the eventArn that you - // specified in the request is invalid or doesn't exist. + // - If the eventScopeCode value is PUBLIC , then the affectedAccounts value is + // always empty. + // - If the eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts + // value lists the affected Amazon Web Services accounts in your organization. For + // example, if an event affects a service such as Amazon Elastic Compute Cloud and + // you have Amazon Web Services accounts that use that service, those account IDs + // appear in the response. + // - If the eventScopeCode value is NONE , then the eventArn that you specified + // in the request is invalid or doesn't exist. EventScopeCode EventScopeCode - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. EventTypeCategory EventTypeCategory // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION - // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT . EventTypeCode *string // The most recent date and time that the event was updated. @@ -178,24 +166,22 @@ type Event struct { // The Amazon Web Services Region name of the event. Region *string - // The Amazon Web Services service that is affected by the event. For example, EC2, - // RDS. + // The Amazon Web Services service that is affected by the event. For example, EC2 + // , RDS . Service *string // The date and time that the event began. StartTime *time.Time - // The most recent status of the event. Possible values are open, closed, and - // upcoming. + // The most recent status of the event. Possible values are open , closed , and + // upcoming . StatusCode EventStatusCode noSmithyDocumentSerde } -// The values used to filter results from the DescribeEventDetailsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) -// and DescribeAffectedEntitiesForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) +// The values used to filter results from the DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) +// and DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) // operations. type EventAccountFilter struct { @@ -214,8 +200,7 @@ type EventAccountFilter struct { noSmithyDocumentSerde } -// The number of events of each issue type. Returned by the DescribeEventAggregates -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) +// The number of events of each issue type. Returned by the DescribeEventAggregates (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) // operation. type EventAggregate struct { @@ -229,8 +214,7 @@ type EventAggregate struct { } // The detailed description of the event. Included in the information returned by -// the DescribeEventDetails -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) +// the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) // operation. type EventDescription struct { @@ -240,13 +224,10 @@ type EventDescription struct { noSmithyDocumentSerde } -// Detailed information about an event. A combination of an Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) object, -// an EventDescription -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) +// Detailed information about an event. A combination of an Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// object, an EventDescription (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) // object, and additional metadata about the event. Returned by the -// DescribeEventDetails -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) +// DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) // operation. type EventDetails struct { @@ -262,8 +243,7 @@ type EventDetails struct { noSmithyDocumentSerde } -// Error information returned when a DescribeEventDetails -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) +// Error information returned when a DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) // operation can't find a specified event. type EventDetailsErrorItem struct { @@ -282,10 +262,8 @@ type EventDetailsErrorItem struct { noSmithyDocumentSerde } -// The values to use to filter results from the DescribeEvents -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html) -// and DescribeEventAggregates -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) +// The values to use to filter results from the DescribeEvents (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html) +// and DescribeEventAggregates (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) // operations. type EventFilter struct { @@ -298,8 +276,8 @@ type EventFilter struct { // A list of entity ARNs (unique identifiers). EntityArns []string - // A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS - // volumes (vol-426ab23e). + // A list of entity identifiers, such as EC2 instance IDs ( i-34ab692e ) or EBS + // volumes ( vol-426ab23e ). EntityValues []string // A list of event ARNs (unique identifiers). For example: @@ -310,8 +288,8 @@ type EventFilter struct { // A list of event status codes. EventStatusCodes []EventStatusCode - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. EventTypeCategories []EventTypeCategory @@ -325,8 +303,8 @@ type EventFilter struct { // A list of Amazon Web Services Regions. Regions []string - // The Amazon Web Services services associated with the event. For example, EC2, - // RDS. + // The Amazon Web Services services associated with the event. For example, EC2 , + // RDS . Services []string // A list of dates and times that the event began. @@ -343,55 +321,51 @@ type EventFilter struct { // EventType shows the category, service, and the event type code of the event. For // example, an issue might be the category, EC2 the service, and // AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code. You can use the -// DescribeEventTypes -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) +// DescribeEventTypes (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) // API operation to return this information about an event. You can also use the // Amazon CloudWatch Events console to create a rule so that you can get notified // or take action when Health delivers a specific event to your Amazon Web Services // account. For more information, see Monitor for Health events with Amazon -// CloudWatch Events -// (https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html) in -// the Health User Guide. +// CloudWatch Events (https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html) +// in the Health User Guide. type EventType struct { - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. Category EventTypeCategory // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION - // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + // ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT . Code *string - // The Amazon Web Services service that is affected by the event. For example, EC2, - // RDS. + // The Amazon Web Services service that is affected by the event. For example, EC2 + // , RDS . Service *string noSmithyDocumentSerde } -// The values to use to filter results from the DescribeEventTypes -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) +// The values to use to filter results from the DescribeEventTypes (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) // operation. type EventTypeFilter struct { - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. EventTypeCategories []EventTypeCategory // A list of event type codes. EventTypeCodes []string - // The Amazon Web Services services associated with the event. For example, EC2, - // RDS. + // The Amazon Web Services services associated with the event. For example, EC2 , + // RDS . Services []string noSmithyDocumentSerde } -// Error information returned when a DescribeAffectedEntitiesForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) +// Error information returned when a DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) // operation can't find or process a specific entity. type OrganizationAffectedEntitiesErrorItem struct { @@ -399,8 +373,8 @@ type OrganizationAffectedEntitiesErrorItem struct { // entities. AwsAccountId *string - // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. - // For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION + // . For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT . ErrorMessage *string // The name of the error. @@ -416,8 +390,7 @@ type OrganizationAffectedEntitiesErrorItem struct { } // Summary information about an event, returned by the -// DescribeEventsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) +// DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) // operation. type OrganizationEvent struct { @@ -432,28 +405,24 @@ type OrganizationEvent struct { // This parameter specifies if the Health event is a public Amazon Web Services // service event or an account-specific event. - // - // * If the eventScopeCode value is - // PUBLIC, then the affectedAccounts value is always empty. - // - // * If the - // eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists - // the affected Amazon Web Services accounts in your organization. For example, if - // an event affects a service such as Amazon Elastic Compute Cloud and you have - // Amazon Web Services accounts that use that service, those account IDs appear in - // the response. - // - // * If the eventScopeCode value is NONE, then the eventArn that you - // specified in the request is invalid or doesn't exist. + // - If the eventScopeCode value is PUBLIC , then the affectedAccounts value is + // always empty. + // - If the eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts + // value lists the affected Amazon Web Services accounts in your organization. For + // example, if an event affects a service such as Amazon Elastic Compute Cloud and + // you have Amazon Web Services accounts that use that service, those account IDs + // appear in the response. + // - If the eventScopeCode value is NONE , then the eventArn that you specified + // in the request is invalid or doesn't exist. EventScopeCode EventScopeCode - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. EventTypeCategory EventTypeCategory - // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. - // For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. + // The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION + // . For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT . EventTypeCode *string // The most recent date and time that the event was updated. @@ -469,20 +438,17 @@ type OrganizationEvent struct { // The date and time that the event began. StartTime *time.Time - // The most recent status of the event. Possible values are open, closed, and - // upcoming. + // The most recent status of the event. Possible values are open , closed , and + // upcoming . StatusCode EventStatusCode noSmithyDocumentSerde } -// Detailed information about an event. A combination of an Event -// (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) object, -// an EventDescription -// (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) +// Detailed information about an event. A combination of an Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) +// object, an EventDescription (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) // object, and additional metadata about the event. Returned by the -// DescribeEventDetailsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) +// DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) // operation. type OrganizationEventDetails struct { @@ -492,27 +458,21 @@ type OrganizationEventDetails struct { // Summary information about an Health event. Health events can be public or // account-specific: - // - // * Public events might be service events that are not specific - // to an Amazon Web Services account. For example, if there is an issue with an - // Amazon Web Services Region, Health provides information about the event, even if - // you don't use services or resources in that Region. - // - // * Account-specific events - // are specific to either your Amazon Web Services account or an account in your - // organization. For example, if there's an issue with Amazon Elastic Compute Cloud - // in a Region that you use, Health provides information about the event and the - // affected resources in the account. - // - // You can determine if an event is public or - // account-specific by using the eventScopeCode parameter. For more information, - // see eventScopeCode - // (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode). + // - Public events might be service events that are not specific to an Amazon + // Web Services account. For example, if there is an issue with an Amazon Web + // Services Region, Health provides information about the event, even if you don't + // use services or resources in that Region. + // - Account-specific events are specific to either your Amazon Web Services + // account or an account in your organization. For example, if there's an issue + // with Amazon Elastic Compute Cloud in a Region that you use, Health provides + // information about the event and the affected resources in the account. + // You can determine if an event is public or account-specific by using the + // eventScopeCode parameter. For more information, see eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode) + // . Event *Event // The detailed description of the event. Included in the information returned by - // the DescribeEventDetails - // (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) + // the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) // operation. EventDescription *EventDescription @@ -522,32 +482,26 @@ type OrganizationEventDetails struct { noSmithyDocumentSerde } -// Error information returned when a DescribeEventDetailsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) +// Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) // operation can't find a specified event. type OrganizationEventDetailsErrorItem struct { - // Error information returned when a DescribeEventDetailsForOrganization - // (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) + // Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) // operation can't find a specified event. AwsAccountId *string // A message that describes the error. If you call the // DescribeEventDetailsForOrganization operation and receive one of the following // errors, follow the recommendations in the message: - // - // * We couldn't find a public - // event that matches your request. To find an event that is account specific, you - // must enter an Amazon Web Services account ID in the request. - // - // * We couldn't find - // an account specific event for the specified Amazon Web Services account. To find - // an event that is public, you must enter a null value for the Amazon Web Services - // account ID in the request. - // - // * Your Amazon Web Services account doesn't include - // the Amazon Web Services Support plan required to use the Health API. You must - // have either a Business, Enterprise On-Ramp, or Enterprise Support plan. + // - We couldn't find a public event that matches your request. To find an event + // that is account specific, you must enter an Amazon Web Services account ID in + // the request. + // - We couldn't find an account specific event for the specified Amazon Web + // Services account. To find an event that is public, you must enter a null value + // for the Amazon Web Services account ID in the request. + // - Your Amazon Web Services account doesn't include the Amazon Web Services + // Support plan required to use the Health API. You must have either a Business, + // Enterprise On-Ramp, or Enterprise Support plan. ErrorMessage *string // The name of the error. @@ -562,8 +516,7 @@ type OrganizationEventDetailsErrorItem struct { noSmithyDocumentSerde } -// The values to filter results from the DescribeEventsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) +// The values to filter results from the DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) // operation. type OrganizationEventFilter struct { @@ -571,15 +524,13 @@ type OrganizationEventFilter struct { // affected entities. AwsAccountIds []string - // A range of dates and times that is used by the EventFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) - // and EntityFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) - // objects. If from is set and to is set: match items where the timestamp - // (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If - // from is set and to is not set: match items where the timestamp value is equal to - // or after from. If from is not set and to is set: match items where the timestamp - // value is equal to or before to. + // A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) + // and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) + // objects. If from is set and to is set: match items where the timestamp ( + // startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If + // from is set and to is not set: match items where the timestamp value is equal + // to or after from . If from is not set and to is set: match items where the + // timestamp value is equal to or before to . EndTime *DateTimeRange // A list of entity ARNs (unique identifiers). @@ -592,8 +543,8 @@ type OrganizationEventFilter struct { // A list of event status codes. EventStatusCodes []EventStatusCode - // A list of event type category codes. Possible values are issue, - // accountNotification, or scheduledChange. Currently, the investigation value + // A list of event type category codes. Possible values are issue , + // accountNotification , or scheduledChange . Currently, the investigation value // isn't supported at this time. EventTypeCategories []EventTypeCategory @@ -601,33 +552,29 @@ type OrganizationEventFilter struct { // "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". EventTypeCodes []string - // A range of dates and times that is used by the EventFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) - // and EntityFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) - // objects. If from is set and to is set: match items where the timestamp - // (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If - // from is set and to is not set: match items where the timestamp value is equal to - // or after from. If from is not set and to is set: match items where the timestamp - // value is equal to or before to. + // A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) + // and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) + // objects. If from is set and to is set: match items where the timestamp ( + // startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If + // from is set and to is not set: match items where the timestamp value is equal + // to or after from . If from is not set and to is set: match items where the + // timestamp value is equal to or before to . LastUpdatedTime *DateTimeRange // A list of Amazon Web Services Regions. Regions []string - // The Amazon Web Services services associated with the event. For example, EC2, - // RDS. + // The Amazon Web Services services associated with the event. For example, EC2 , + // RDS . Services []string - // A range of dates and times that is used by the EventFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) - // and EntityFilter - // (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) - // objects. If from is set and to is set: match items where the timestamp - // (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If - // from is set and to is not set: match items where the timestamp value is equal to - // or after from. If from is not set and to is set: match items where the timestamp - // value is equal to or before to. + // A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) + // and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) + // objects. If from is set and to is set: match items where the timestamp ( + // startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If + // from is set and to is not set: match items where the timestamp value is equal + // to or after from . If from is not set and to is set: match items where the + // timestamp value is equal to or before to . StartTime *DateTimeRange noSmithyDocumentSerde diff --git a/service/healthlake/api_client.go b/service/healthlake/api_client.go index cd038b2d4ee..a2b712b6368 100644 --- a/service/healthlake/api_client.go +++ b/service/healthlake/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/healthlake/api_op_DescribeFHIRExportJob.go b/service/healthlake/api_op_DescribeFHIRExportJob.go index b5b425da238..f623245cfcd 100644 --- a/service/healthlake/api_op_DescribeFHIRExportJob.go +++ b/service/healthlake/api_op_DescribeFHIRExportJob.go @@ -30,8 +30,8 @@ func (c *Client) DescribeFHIRExportJob(ctx context.Context, params *DescribeFHIR type DescribeFHIRExportJobInput struct { - // The AWS generated ID for the Data Store from which files are being exported from - // for an export job. + // The AWS generated ID for the Data Store from which files are being exported + // from for an export job. // // This member is required. DatastoreId *string diff --git a/service/healthlake/api_op_ListFHIRExportJobs.go b/service/healthlake/api_op_ListFHIRExportJobs.go index bc6d74b69c7..defa2ffa1b6 100644 --- a/service/healthlake/api_op_ListFHIRExportJobs.go +++ b/service/healthlake/api_op_ListFHIRExportJobs.go @@ -45,8 +45,8 @@ type ListFHIRExportJobsInput struct { // status. JobStatus types.JobStatus - // This parameter limits the number of results returned for a ListFHIRExportJobs to - // a maximum quantity specified by the user. + // This parameter limits the number of results returned for a ListFHIRExportJobs + // to a maximum quantity specified by the user. MaxResults *int32 // A pagination token used to identify the next page of results to return for a @@ -156,8 +156,8 @@ var _ ListFHIRExportJobsAPIClient = (*Client)(nil) // ListFHIRExportJobsPaginatorOptions is the paginator options for // ListFHIRExportJobs type ListFHIRExportJobsPaginatorOptions struct { - // This parameter limits the number of results returned for a ListFHIRExportJobs to - // a maximum quantity specified by the user. + // This parameter limits the number of results returned for a ListFHIRExportJobs + // to a maximum quantity specified by the user. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/healthlake/api_op_ListFHIRImportJobs.go b/service/healthlake/api_op_ListFHIRImportJobs.go index 7a1149046bf..0d93c6941eb 100644 --- a/service/healthlake/api_op_ListFHIRImportJobs.go +++ b/service/healthlake/api_op_ListFHIRImportJobs.go @@ -45,8 +45,8 @@ type ListFHIRImportJobsInput struct { // status. JobStatus types.JobStatus - // This parameter limits the number of results returned for a ListFHIRImportJobs to - // a maximum quantity specified by the user. + // This parameter limits the number of results returned for a ListFHIRImportJobs + // to a maximum quantity specified by the user. MaxResults *int32 // A pagination token used to identify the next page of results to return for a @@ -156,8 +156,8 @@ var _ ListFHIRImportJobsAPIClient = (*Client)(nil) // ListFHIRImportJobsPaginatorOptions is the paginator options for // ListFHIRImportJobs type ListFHIRImportJobsPaginatorOptions struct { - // This parameter limits the number of results returned for a ListFHIRImportJobs to - // a maximum quantity specified by the user. + // This parameter limits the number of results returned for a ListFHIRImportJobs + // to a maximum quantity specified by the user. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/healthlake/types/enums.go b/service/healthlake/types/enums.go index b548c4e5ef2..858aded1ff5 100644 --- a/service/healthlake/types/enums.go +++ b/service/healthlake/types/enums.go @@ -69,9 +69,9 @@ const ( JobStatusFailed JobStatus = "FAILED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", diff --git a/service/healthlake/types/errors.go b/service/healthlake/types/errors.go index 54b3f74ade3..a063d408bc4 100644 --- a/service/healthlake/types/errors.go +++ b/service/healthlake/types/errors.go @@ -33,8 +33,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Data Store is in a transition state and the user requested action can not be -// performed. +// The Data Store is in a transition state and the user requested action can not +// be performed. type ConflictException struct { Message *string diff --git a/service/healthlake/types/types.go b/service/healthlake/types/types.go index 961ab5b8cd8..fe3668c9e88 100644 --- a/service/healthlake/types/types.go +++ b/service/healthlake/types/types.go @@ -36,8 +36,8 @@ type DatastoreProperties struct { // This member is required. DatastoreArn *string - // The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint - // with Data Store ID in the endpoint URL. + // The AWS endpoint for the Data Store. Each Data Store will have it's own + // endpoint with Data Store ID in the endpoint URL. // // This member is required. DatastoreEndpoint *string @@ -75,8 +75,8 @@ type DatastoreProperties struct { noSmithyDocumentSerde } -// The properties of a FHIR export job, including the ID, ARN, name, and the status -// of the job. +// The properties of a FHIR export job, including the ID, ARN, name, and the +// status of the job. type ExportJobProperties struct { // The AWS generated ID for the Data Store from which files are being exported for @@ -151,8 +151,8 @@ type ImportJobProperties struct { // This member is required. SubmitTime *time.Time - // The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input - // data. + // The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your + // input data. DataAccessRoleArn *string // The time that the Import job was completed. @@ -179,8 +179,8 @@ type InputDataConfig interface { isInputDataConfig() } -// The S3Uri is the user specified S3 location of the FHIR data to be imported into -// Amazon HealthLake. +// The S3Uri is the user specified S3 location of the FHIR data to be imported +// into Amazon HealthLake. type InputDataConfigMemberS3Uri struct { Value string @@ -244,8 +244,8 @@ type S3Configuration struct { // This member is required. KmsKeyId *string - // The S3Uri is the user specified S3 location of the FHIR data to be imported into - // Amazon HealthLake. + // The S3Uri is the user specified S3 location of the FHIR data to be imported + // into Amazon HealthLake. // // This member is required. S3Uri *string diff --git a/service/honeycode/api_client.go b/service/honeycode/api_client.go index 63a405ff13d..1ffa9a2dda9 100644 --- a/service/honeycode/api_client.go +++ b/service/honeycode/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/honeycode/api_op_BatchCreateTableRows.go b/service/honeycode/api_op_BatchCreateTableRows.go index 80eb0b906cc..89d17ac310e 100644 --- a/service/honeycode/api_op_BatchCreateTableRows.go +++ b/service/honeycode/api_op_BatchCreateTableRows.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The BatchCreateTableRows API allows you to create one or more rows at the end of -// a table in a workbook. The API allows you to specify the values to set in some -// or all of the columns in the new rows. If a column is not explicitly set in a -// specific row, then the column level formula specified in the table will be +// The BatchCreateTableRows API allows you to create one or more rows at the end +// of a table in a workbook. The API allows you to specify the values to set in +// some or all of the columns in the new rows. If a column is not explicitly set in +// a specific row, then the column level formula specified in the table will be // applied to the new row. If there is no column level formula but the last row of // the table has a formula, then that formula will be copied down to the new row. // If there is no column level formula and no formula in the last row of the table, @@ -36,12 +36,12 @@ func (c *Client) BatchCreateTableRows(ctx context.Context, params *BatchCreateTa type BatchCreateTableRowsInput struct { - // The list of rows to create at the end of the table. Each item in this list needs - // to have a batch item id to uniquely identify the element in the request and the - // cells to create for that row. You need to specify at least one item in this - // list. Note that if one of the column ids in any of the rows in the request does - // not exist in the table, then the request fails and no updates are made to the - // table. + // The list of rows to create at the end of the table. Each item in this list + // needs to have a batch item id to uniquely identify the element in the request + // and the cells to create for that row. You need to specify at least one item in + // this list. Note that if one of the column ids in any of the rows in the request + // does not exist in the table, then the request fails and no updates are made to + // the table. // // This member is required. RowsToCreate []types.CreateRowData @@ -58,13 +58,13 @@ type BatchCreateTableRowsInput struct { // This member is required. WorkbookId *string - // The request token for performing the batch create operation. Request tokens help - // to identify duplicate requests. If a call times out or fails due to a transient - // error like a failed network connection, you can retry the call with the same - // request token. The service ensures that if the first call using that request - // token is successfully performed, the second call will not perform the operation - // again. Note that request tokens are valid only for a few minutes. You cannot use - // request tokens to dedupe requests spanning hours or days. + // The request token for performing the batch create operation. Request tokens + // help to identify duplicate requests. If a call times out or fails due to a + // transient error like a failed network connection, you can retry the call with + // the same request token. The service ensures that if the first call using that + // request token is successfully performed, the second call will not perform the + // operation again. Note that request tokens are valid only for a few minutes. You + // cannot use request tokens to dedupe requests spanning hours or days. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/honeycode/api_op_BatchUpdateTableRows.go b/service/honeycode/api_op_BatchUpdateTableRows.go index 4b6025b7f70..923f7416047 100644 --- a/service/honeycode/api_op_BatchUpdateTableRows.go +++ b/service/honeycode/api_op_BatchUpdateTableRows.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The BatchUpdateTableRows API allows you to update one or more rows in a table in -// a workbook. You can specify the values to set in some or all of the columns in -// the table for the specified rows. If a column is not explicitly specified in a -// particular row, then that column will not be updated for that row. To clear out -// the data in a specific cell, you need to set the value as an empty string (""). +// The BatchUpdateTableRows API allows you to update one or more rows in a table +// in a workbook. You can specify the values to set in some or all of the columns +// in the table for the specified rows. If a column is not explicitly specified in +// a particular row, then that column will not be updated for that row. To clear +// out the data in a specific cell, you need to set the value as an empty string +// (""). func (c *Client) BatchUpdateTableRows(ctx context.Context, params *BatchUpdateTableRowsInput, optFns ...func(*Options)) (*BatchUpdateTableRowsOutput, error) { if params == nil { params = &BatchUpdateTableRowsInput{} @@ -33,12 +34,12 @@ func (c *Client) BatchUpdateTableRows(ctx context.Context, params *BatchUpdateTa type BatchUpdateTableRowsInput struct { - // The list of rows to update in the table. Each item in this list needs to contain - // the row id to update along with the map of column id to cell values for each - // column in that row that needs to be updated. You need to specify at least one - // row in this list, and for each row, you need to specify at least one column to - // update. Note that if one of the row or column ids in the request does not exist - // in the table, then the request fails and no updates are made to the table. + // The list of rows to update in the table. Each item in this list needs to + // contain the row id to update along with the map of column id to cell values for + // each column in that row that needs to be updated. You need to specify at least + // one row in this list, and for each row, you need to specify at least one column + // to update. Note that if one of the row or column ids in the request does not + // exist in the table, then the request fails and no updates are made to the table. // // This member is required. RowsToUpdate []types.UpdateRowData diff --git a/service/honeycode/api_op_BatchUpsertTableRows.go b/service/honeycode/api_op_BatchUpsertTableRows.go index 6fd0c52457e..ff6b0c96d6c 100644 --- a/service/honeycode/api_op_BatchUpsertTableRows.go +++ b/service/honeycode/api_op_BatchUpsertTableRows.go @@ -56,8 +56,8 @@ type BatchUpsertTableRowsInput struct { // This member is required. TableId *string - // The ID of the workbook where the rows are being upserted. If a workbook with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook where the rows are being upserted. If a workbook with + // the specified id could not be found, this API throws ResourceNotFoundException. // // This member is required. WorkbookId *string diff --git a/service/honeycode/api_op_DescribeTableDataImportJob.go b/service/honeycode/api_op_DescribeTableDataImportJob.go index b60283cbcc7..9f6274d49ce 100644 --- a/service/honeycode/api_op_DescribeTableDataImportJob.go +++ b/service/honeycode/api_op_DescribeTableDataImportJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DescribeTableDataImportJob API allows you to retrieve the status and details -// of a table data import job. +// The DescribeTableDataImportJob API allows you to retrieve the status and +// details of a table data import job. func (c *Client) DescribeTableDataImportJob(ctx context.Context, params *DescribeTableDataImportJobInput, optFns ...func(*Options)) (*DescribeTableDataImportJobOutput, error) { if params == nil { params = &DescribeTableDataImportJobInput{} @@ -30,8 +30,8 @@ func (c *Client) DescribeTableDataImportJob(ctx context.Context, params *Describ type DescribeTableDataImportJobInput struct { - // The ID of the job that was returned by the StartTableDataImportJob request. If a - // job with the specified id could not be found, this API throws + // The ID of the job that was returned by the StartTableDataImportJob request. If + // a job with the specified id could not be found, this API throws // ResourceNotFoundException. // // This member is required. diff --git a/service/honeycode/api_op_GetScreenData.go b/service/honeycode/api_op_GetScreenData.go index 0f80c1235d9..b75ac50dc14 100644 --- a/service/honeycode/api_op_GetScreenData.go +++ b/service/honeycode/api_op_GetScreenData.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetScreenData API allows retrieval of data from a screen in a Honeycode app. -// The API allows setting local variables in the screen to filter, sort or +// The GetScreenData API allows retrieval of data from a screen in a Honeycode +// app. The API allows setting local variables in the screen to filter, sort or // otherwise affect what will be displayed on the screen. func (c *Client) GetScreenData(ctx context.Context, params *GetScreenDataInput, optFns ...func(*Options)) (*GetScreenDataOutput, error) { if params == nil { @@ -51,17 +51,17 @@ type GetScreenDataInput struct { // specify this parameter, the default page size is 100. MaxResults *int32 - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw + // This parameter is optional. If a nextToken is not specified, the API returns + // the first page of data. Pagination tokens expire after 1 hour. If you use a + // token that was returned more than an hour back, the API will throw // ValidationException. NextToken *string - // Variables are optional and are needed only if the screen requires them to render - // correctly. Variables are specified as a map where the key is the name of the - // variable as defined on the screen. The value is an object which currently has - // only one property, rawValue, which holds the value of the variable to be passed - // to the screen. + // Variables are optional and are needed only if the screen requires them to + // render correctly. Variables are specified as a map where the key is the name of + // the variable as defined on the screen. The value is an object which currently + // has only one property, rawValue, which holds the value of the variable to be + // passed to the screen. Variables map[string]types.VariableValue noSmithyDocumentSerde @@ -74,9 +74,9 @@ type GetScreenDataOutput struct { // This member is required. Results map[string]types.ResultSet - // Indicates the cursor of the workbook at which the data returned by this workbook - // is read. Workbook cursor keeps increasing with every update and the increments - // are not sequential. + // Indicates the cursor of the workbook at which the data returned by this + // workbook is read. Workbook cursor keeps increasing with every update and the + // increments are not sequential. // // This member is required. WorkbookCursor int64 diff --git a/service/honeycode/api_op_ListTableColumns.go b/service/honeycode/api_op_ListTableColumns.go index d176ad16bc0..ffc31bd7bd0 100644 --- a/service/honeycode/api_op_ListTableColumns.go +++ b/service/honeycode/api_op_ListTableColumns.go @@ -44,9 +44,9 @@ type ListTableColumnsInput struct { // This member is required. WorkbookId *string - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw + // This parameter is optional. If a nextToken is not specified, the API returns + // the first page of data. Pagination tokens expire after 1 hour. If you use a + // token that was returned more than an hour back, the API will throw // ValidationException. NextToken *string diff --git a/service/honeycode/api_op_ListTableRows.go b/service/honeycode/api_op_ListTableRows.go index 4146b5d15dd..fc9ca0e2a2c 100644 --- a/service/honeycode/api_op_ListTableRows.go +++ b/service/honeycode/api_op_ListTableRows.go @@ -47,9 +47,9 @@ type ListTableRowsInput struct { // The maximum number of rows to return in each page of the results. MaxResults *int32 - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw + // This parameter is optional. If a nextToken is not specified, the API returns + // the first page of data. Pagination tokens expire after 1 hour. If you use a + // token that was returned more than an hour back, the API will throw // ValidationException. NextToken *string diff --git a/service/honeycode/api_op_ListTables.go b/service/honeycode/api_op_ListTables.go index 8538e0e78bc..797a4be6d61 100644 --- a/service/honeycode/api_op_ListTables.go +++ b/service/honeycode/api_op_ListTables.go @@ -40,9 +40,9 @@ type ListTablesInput struct { // The maximum number of tables to return in each page of the results. MaxResults *int32 - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw + // This parameter is optional. If a nextToken is not specified, the API returns + // the first page of data. Pagination tokens expire after 1 hour. If you use a + // token that was returned more than an hour back, the API will throw // ValidationException. NextToken *string diff --git a/service/honeycode/api_op_QueryTableRows.go b/service/honeycode/api_op_QueryTableRows.go index b1966c98df7..8d1b4be578a 100644 --- a/service/honeycode/api_op_QueryTableRows.go +++ b/service/honeycode/api_op_QueryTableRows.go @@ -52,9 +52,9 @@ type QueryTableRowsInput struct { // The maximum number of rows to return in each page of the results. MaxResults *int32 - // This parameter is optional. If a nextToken is not specified, the API returns the - // first page of data. Pagination tokens expire after 1 hour. If you use a token - // that was returned more than an hour back, the API will throw + // This parameter is optional. If a nextToken is not specified, the API returns + // the first page of data. Pagination tokens expire after 1 hour. If you use a + // token that was returned more than an hour back, the API will throw // ValidationException. NextToken *string diff --git a/service/honeycode/api_op_StartTableDataImportJob.go b/service/honeycode/api_op_StartTableDataImportJob.go index 7ff8f544b11..758c9bb48fc 100644 --- a/service/honeycode/api_op_StartTableDataImportJob.go +++ b/service/honeycode/api_op_StartTableDataImportJob.go @@ -67,8 +67,8 @@ type StartTableDataImportJobInput struct { // This member is required. ImportOptions *types.ImportOptions - // The ID of the workbook where the rows are being imported. If a workbook with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook where the rows are being imported. If a workbook with + // the specified id could not be found, this API throws ResourceNotFoundException. // // This member is required. WorkbookId *string diff --git a/service/honeycode/types/enums.go b/service/honeycode/types/enums.go index 97cdb17a649..c386b05d7dc 100644 --- a/service/honeycode/types/enums.go +++ b/service/honeycode/types/enums.go @@ -22,9 +22,9 @@ const ( ErrorCodeSystemLimitError ErrorCode = "SYSTEM_LIMIT_ERROR" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "ACCESS_DENIED", @@ -134,9 +134,9 @@ const ( TableDataImportJobStatusFailed TableDataImportJobStatus = "FAILED" ) -// Values returns all known values for TableDataImportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TableDataImportJobStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TableDataImportJobStatus) Values() []TableDataImportJobStatus { return []TableDataImportJobStatus{ "SUBMITTED", @@ -154,9 +154,9 @@ const ( UpsertActionAppended UpsertAction = "APPENDED" ) -// Values returns all known values for UpsertAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpsertAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpsertAction) Values() []UpsertAction { return []UpsertAction{ "UPDATED", diff --git a/service/honeycode/types/errors.go b/service/honeycode/types/errors.go index 5b83dd3b2c5..28da2e72a3c 100644 --- a/service/honeycode/types/errors.go +++ b/service/honeycode/types/errors.go @@ -141,8 +141,8 @@ func (e *RequestTimeoutException) ErrorCode() string { } func (e *RequestTimeoutException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// A Workbook, Table, App, Screen or Screen Automation was not found with the given -// ID. +// A Workbook, Table, App, Screen or Screen Automation was not found with the +// given ID. type ResourceNotFoundException struct { Message *string diff --git a/service/honeycode/types/types.go b/service/honeycode/types/types.go index 93065c7962f..792735bd1df 100644 --- a/service/honeycode/types/types.go +++ b/service/honeycode/types/types.go @@ -14,13 +14,13 @@ type Cell struct { // specified in the workbook or the format is set to AUTO. Format Format - // The formatted value of the cell. This is the value that you see displayed in the - // cell in the UI. Note that the formatted value of a cell is always represented as - // a string irrespective of the data that is stored in the cell. For example, if a - // cell contains a date, the formatted value of the cell is the string - // representation of the formatted date being shown in the cell in the UI. See - // details in the rawValue field below for how cells of different formats will have - // different raw and formatted values. + // The formatted value of the cell. This is the value that you see displayed in + // the cell in the UI. Note that the formatted value of a cell is always + // represented as a string irrespective of the data that is stored in the cell. For + // example, if a cell contains a date, the formatted value of the cell is the + // string representation of the formatted date being shown in the cell in the UI. + // See details in the rawValue field below for how cells of different formats will + // have different raw and formatted values. FormattedValue *string // A list of formatted values of the cell. This field is only returned when the @@ -29,8 +29,8 @@ type Cell struct { // if this field is returned. FormattedValues []string - // The formula contained in the cell. This field is empty if a cell does not have a - // formula. + // The formula contained in the cell. This field is empty if a cell does not have + // a formula. Formula *string // The raw value of the data contained in the cell. The raw value depends on the @@ -47,19 +47,19 @@ type Cell struct { // representing the data being displayed. For example, the number 1.325 with two // decimal places in the format will have it's raw value as "1.325" and formatted // value as "1.33". A currency value for $10 will have the raw value as "10" and - // formatted value as "$10.00". A value representing 20% with two decimal places in - // the format will have its raw value as "0.2" and the formatted value as "20.00%". - // An accounting value of -$25 will have "-25" as the raw value and "$ (25.00)" as - // the formatted value. Cells with format TEXT will have the raw text as the raw - // value. For example, a cell with text "John Smith" will have "John Smith" as both - // the raw value and the formatted value. Cells with format CONTACT will have the - // name of the contact as a formatted value and the email address of the contact as - // the raw value. For example, a contact for John Smith will have "John Smith" as - // the formatted value and "john.smith@example.com" as the raw value. Cells with - // format ROWLINK (aka picklist) will have the first column of the linked row as - // the formatted value and the row id of the linked row as the raw value. For - // example, a cell containing a picklist to a table that displays task status might - // have "Completed" as the formatted value and + // formatted value as "$10.00". A value representing 20% with two decimal places + // in the format will have its raw value as "0.2" and the formatted value as + // "20.00%". An accounting value of -$25 will have "-25" as the raw value and "$ + // (25.00)" as the formatted value. Cells with format TEXT will have the raw text + // as the raw value. For example, a cell with text "John Smith" will have "John + // Smith" as both the raw value and the formatted value. Cells with format CONTACT + // will have the name of the contact as a formatted value and the email address of + // the contact as the raw value. For example, a contact for John Smith will have + // "John Smith" as the formatted value and "john.smith@example.com" as the raw + // value. Cells with format ROWLINK (aka picklist) will have the first column of + // the linked row as the formatted value and the row id of the linked row as the + // raw value. For example, a cell containing a picklist to a table that displays + // task status might have "Completed" as the formatted value and // "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" // as the raw value. Cells with format ROWSET (aka multi-select or multi-record // picklist) will by default have the first column of each of the linked rows as @@ -87,8 +87,8 @@ type Cell struct { // request will be thrown if both fact and facts field are present. type CellInput struct { - // Fact represents the data that is entered into a cell. This data can be free text - // or a formula. Formulas need to start with the equals (=) sign. + // Fact represents the data that is entered into a cell. This data can be free + // text or a formula. Formulas need to start with the equals (=) sign. Fact *string // A list representing the values that are entered into a ROWSET cell. Facts list @@ -143,8 +143,8 @@ type DataItem struct { // The formatted value of the data. e.g. John Smith. FormattedValue *string - // The overrideFormat is optional and is specified only if a particular row of data - // has a different format for the data than the default format defined on the + // The overrideFormat is optional and is specified only if a particular row of + // data has a different format for the data than the default format defined on the // screen or the table. OverrideFormat Format @@ -210,12 +210,12 @@ type FailedBatchItem struct { // under which the filter function needs to evaluate. type Filter struct { - // A formula representing a filter function that returns zero or more matching rows - // from a table. Valid formulas in this field return a list of rows from a table. - // The most common ways of writing a formula to return a list of rows are to use - // the FindRow() or Filter() functions. Any other formula that returns zero or more - // rows is also acceptable. For example, you can use a formula that points to a - // cell that contains a filter function. + // A formula representing a filter function that returns zero or more matching + // rows from a table. Valid formulas in this field return a list of rows from a + // table. The most common ways of writing a formula to return a list of rows are to + // use the FindRow() or Filter() functions. Any other formula that returns zero or + // more rows is also acceptable. For example, you can use a formula that points to + // a cell that contains a filter function. // // This member is required. Formula *string @@ -290,8 +290,8 @@ type ResultRow struct { noSmithyDocumentSerde } -// ResultSet contains the results of the request for a single block or list defined -// on the screen. +// ResultSet contains the results of the request for a single block or list +// defined on the screen. type ResultSet struct { // List of headers for all the data cells in the block. The header identifies the @@ -432,9 +432,9 @@ type UpsertRowData struct { // This member is required. BatchItemId *string - // A map representing the cells to update for the matching rows or an appended row. - // The key is the column id of the cell and the value is the CellInput object that - // represents the data to set in that cell. + // A map representing the cells to update for the matching rows or an appended + // row. The key is the column id of the cell and the value is the CellInput object + // that represents the data to set in that cell. // // This member is required. CellsToUpdate map[string]CellInput @@ -457,9 +457,9 @@ type UpsertRowData struct { // An object that represents the result of a single upsert row request. type UpsertRowsResult struct { - // The list of row ids that were changed as part of an upsert row operation. If the - // upsert resulted in an update, this list could potentially contain multiple rows - // that matched the filter and hence got updated. If the upsert resulted in an + // The list of row ids that were changed as part of an upsert row operation. If + // the upsert resulted in an update, this list could potentially contain multiple + // rows that matched the filter and hence got updated. If the upsert resulted in an // append, this list would only have the single row that was appended. // // This member is required. diff --git a/service/iam/api_client.go b/service/iam/api_client.go index 50c03d8c135..584b4c8c432 100644 --- a/service/iam/api_client.go +++ b/service/iam/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go b/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go index 334123a8188..257bd245a68 100644 --- a/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go +++ b/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go @@ -31,8 +31,8 @@ func (c *Client) AddClientIDToOpenIDConnectProvider(ctx context.Context, params type AddClientIDToOpenIDConnectProviderInput struct { - // The client ID (also known as audience) to add to the IAM OpenID Connect provider - // resource. + // The client ID (also known as audience) to add to the IAM OpenID Connect + // provider resource. // // This member is required. ClientID *string diff --git a/service/iam/api_op_AddRoleToInstanceProfile.go b/service/iam/api_op_AddRoleToInstanceProfile.go index 2272c8480f5..162807a7a46 100644 --- a/service/iam/api_op_AddRoleToInstanceProfile.go +++ b/service/iam/api_op_AddRoleToInstanceProfile.go @@ -14,18 +14,14 @@ import ( // profile can contain only one role, and this quota cannot be increased. You can // remove the existing role and then add a different role to an instance profile. // You must then wait for the change to appear across all of Amazon Web Services -// because of eventual consistency -// (https://en.wikipedia.org/wiki/Eventual_consistency). To force the change, you -// must disassociate the instance profile -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html) -// and then associate the instance profile -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html), -// or you can stop your instance and then restart it. The caller of this operation -// must be granted the PassRole permission on the IAM role by a permissions policy. -// For more information about roles, see Working with roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). For -// more information about instance profiles, see About instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html). +// because of eventual consistency (https://en.wikipedia.org/wiki/Eventual_consistency) +// . To force the change, you must disassociate the instance profile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html) +// and then associate the instance profile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html) +// , or you can stop your instance and then restart it. The caller of this +// operation must be granted the PassRole permission on the IAM role by a +// permissions policy. For more information about roles, see Working with roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) +// . For more information about instance profiles, see About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// . func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleToInstanceProfileInput, optFns ...func(*Options)) (*AddRoleToInstanceProfileOutput, error) { if params == nil { params = &AddRoleToInstanceProfileInput{} @@ -44,17 +40,17 @@ func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleTo type AddRoleToInstanceProfileInput struct { // The name of the instance profile to update. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // // This member is required. InstanceProfileName *string - // The name of the role to add. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the role to add. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string diff --git a/service/iam/api_op_AddUserToGroup.go b/service/iam/api_op_AddUserToGroup.go index f6376654b86..a6b7f81f69f 100644 --- a/service/iam/api_op_AddUserToGroup.go +++ b/service/iam/api_op_AddUserToGroup.go @@ -29,17 +29,17 @@ func (c *Client) AddUserToGroup(ctx context.Context, params *AddUserToGroupInput type AddUserToGroupInput struct { // The name of the group to update. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // // This member is required. GroupName *string - // The name of the user to add. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the user to add. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_AttachGroupPolicy.go b/service/iam/api_op_AttachGroupPolicy.go index 8f83115d2e5..f706a7b7474 100644 --- a/service/iam/api_op_AttachGroupPolicy.go +++ b/service/iam/api_op_AttachGroupPolicy.go @@ -12,12 +12,10 @@ import ( // Attaches the specified managed policy to the specified IAM group. You use this // operation to attach a managed policy to a group. To embed an inline policy in a -// group, use PutGroupPolicy. As a best practice, you can validate your IAM -// policies. To learn more, see Validating IAM policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) -// in the IAM User Guide. For more information about policies, see Managed policies -// and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// group, use PutGroupPolicy . As a best practice, you can validate your IAM +// policies. To learn more, see Validating IAM policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) +// in the IAM User Guide. For more information about policies, see Managed +// policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolicyInput, optFns ...func(*Options)) (*AttachGroupPolicyOutput, error) { if params == nil { @@ -37,17 +35,16 @@ func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolic type AttachGroupPolicyInput struct { // The name (friendly name, not ARN) of the group to attach the policy to. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. GroupName *string // The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_AttachRolePolicy.go b/service/iam/api_op_AttachRolePolicy.go index cf2d1a8d7a1..7d2b4610875 100644 --- a/service/iam/api_op_AttachRolePolicy.go +++ b/service/iam/api_op_AttachRolePolicy.go @@ -10,18 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches the specified managed policy to the specified IAM role. When you attach -// a managed policy to a role, the managed policy becomes part of the role's +// Attaches the specified managed policy to the specified IAM role. When you +// attach a managed policy to a role, the managed policy becomes part of the role's // permission (access) policy. You cannot use a managed policy as the role's trust // policy. The role's trust policy is created at the same time as the role, using -// CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. +// CreateRole . You can update a role's trust policy using UpdateAssumeRolePolicy . // Use this operation to attach a managed policy to a role. To embed an inline -// policy in a role, use PutRolePolicy. For more information about policies, see -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policy in a role, use PutRolePolicy . For more information about policies, see +// Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. As a best practice, you can validate your IAM policies. -// To learn more, see Validating IAM policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) +// To learn more, see Validating IAM policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) // in the IAM User Guide. func (c *Client) AttachRolePolicy(ctx context.Context, params *AttachRolePolicyInput, optFns ...func(*Options)) (*AttachRolePolicyOutput, error) { if params == nil { @@ -41,16 +39,15 @@ func (c *Client) AttachRolePolicy(ctx context.Context, params *AttachRolePolicyI type AttachRolePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the role to attach the policy to. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_AttachUserPolicy.go b/service/iam/api_op_AttachUserPolicy.go index 7fc6341afe0..1818ff6b7a5 100644 --- a/service/iam/api_op_AttachUserPolicy.go +++ b/service/iam/api_op_AttachUserPolicy.go @@ -12,12 +12,10 @@ import ( // Attaches the specified managed policy to the specified user. You use this // operation to attach a managed policy to a user. To embed an inline policy in a -// user, use PutUserPolicy. As a best practice, you can validate your IAM policies. -// To learn more, see Validating IAM policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) -// in the IAM User Guide. For more information about policies, see Managed policies -// and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// user, use PutUserPolicy . As a best practice, you can validate your IAM +// policies. To learn more, see Validating IAM policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) +// in the IAM User Guide. For more information about policies, see Managed +// policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyInput, optFns ...func(*Options)) (*AttachUserPolicyOutput, error) { if params == nil { @@ -37,16 +35,15 @@ func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyI type AttachUserPolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM user to attach the policy to. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_ChangePassword.go b/service/iam/api_op_ChangePassword.go index b6df84cfa60..09f9f626cd4 100644 --- a/service/iam/api_op_ChangePassword.go +++ b/service/iam/api_op_ChangePassword.go @@ -16,9 +16,8 @@ import ( // Amazon Web Services account root user password is not affected by this // operation. Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, // or the Users page in the IAM console to change the password for any IAM user. -// For more information about modifying passwords, see Managing passwords -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in -// the IAM User Guide. +// For more information about modifying passwords, see Managing passwords (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) +// in the IAM User Guide. func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error) { if params == nil { params = &ChangePasswordInput{} @@ -37,15 +36,15 @@ func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput type ChangePasswordInput struct { // The new password. The new password must conform to the Amazon Web Services - // account's password policy, if one exists. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of characters. That string can include almost any printable ASCII - // character from the space (\u0020) through the end of the ASCII character range - // (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and - // carriage return (\u000D) characters. Any of these characters are valid in a - // password. However, many tools, such as the Amazon Web Services Management - // Console, might restrict the ability to type certain characters because they have - // special meaning within that tool. + // account's password policy, if one exists. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of characters. That string + // can include almost any printable ASCII character from the space ( \u0020 ) + // through the end of the ASCII character range ( \u00FF ). You can also include + // the tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) + // characters. Any of these characters are valid in a password. However, many + // tools, such as the Amazon Web Services Management Console, might restrict the + // ability to type certain characters because they have special meaning within that + // tool. // // This member is required. NewPassword *string diff --git a/service/iam/api_op_CreateAccessKey.go b/service/iam/api_op_CreateAccessKey.go index 6e991c58ac7..3904e2e8c13 100644 --- a/service/iam/api_op_CreateAccessKey.go +++ b/service/iam/api_op_CreateAccessKey.go @@ -11,20 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon Web Services secret access key and corresponding Amazon Web -// Services access key ID for the specified user. The default status for new keys -// is Active. If you do not specify a user name, IAM determines the user name +// Creates a new Amazon Web Services secret access key and corresponding Amazon +// Web Services access key ID for the specified user. The default status for new +// keys is Active . If you do not specify a user name, IAM determines the user name // implicitly based on the Amazon Web Services access key ID signing the request. // This operation works for access keys under the Amazon Web Services account. // Consequently, you can use this operation to manage Amazon Web Services account // root user credentials. This is true even if the Amazon Web Services account has // no associated users. For information about quotas on the number of keys you can -// create, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. To ensure the security of your Amazon Web Services account, -// the secret access key is accessible only during key and user creation. You must -// save the key (for example, in a text file) if you want to be able to access it -// again. If a secret key is lost, you can delete the access keys for the +// create, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. To ensure the security of your Amazon Web Services +// account, the secret access key is accessible only during key and user creation. +// You must save the key (for example, in a text file) if you want to be able to +// access it again. If a secret key is lost, you can delete the access keys for the // associated user and then create new keys. func (c *Client) CreateAccessKey(ctx context.Context, params *CreateAccessKeyInput, optFns ...func(*Options)) (*CreateAccessKeyOutput, error) { if params == nil { @@ -44,7 +43,7 @@ func (c *Client) CreateAccessKey(ctx context.Context, params *CreateAccessKeyInp type CreateAccessKeyInput struct { // The name of the IAM user that the new key will belong to. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_CreateAccountAlias.go b/service/iam/api_op_CreateAccountAlias.go index 633e35e1a5c..cd45f5216c2 100644 --- a/service/iam/api_op_CreateAccountAlias.go +++ b/service/iam/api_op_CreateAccountAlias.go @@ -12,9 +12,8 @@ import ( // Creates an alias for your Amazon Web Services account. For information about // using an Amazon Web Services account alias, see Using an alias for your Amazon -// Web Services account ID -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) in the IAM -// User Guide. +// Web Services account ID (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) +// in the IAM User Guide. func (c *Client) CreateAccountAlias(ctx context.Context, params *CreateAccountAliasInput, optFns ...func(*Options)) (*CreateAccountAliasOutput, error) { if params == nil { params = &CreateAccountAliasInput{} @@ -32,10 +31,9 @@ func (c *Client) CreateAccountAlias(ctx context.Context, params *CreateAccountAl type CreateAccountAliasInput struct { - // The account alias to create. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // lowercase letters, digits, and dashes. You cannot start or finish with a dash, - // nor can you have two dashes in a row. + // The account alias to create. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of lowercase letters, digits, and dashes. + // You cannot start or finish with a dash, nor can you have two dashes in a row. // // This member is required. AccountAlias *string diff --git a/service/iam/api_op_CreateGroup.go b/service/iam/api_op_CreateGroup.go index aaca9265bf4..9ec84ef96a1 100644 --- a/service/iam/api_op_CreateGroup.go +++ b/service/iam/api_op_CreateGroup.go @@ -12,9 +12,8 @@ import ( ) // Creates a new group. For information about the number of groups you can create, -// see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. +// see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -40,15 +39,13 @@ type CreateGroupInput struct { // This member is required. GroupName *string - // The path to the group. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // The path to the group. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. Path *string noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateInstanceProfile.go b/service/iam/api_op_CreateInstanceProfile.go index 6bd6e49539b..b1d085cb381 100644 --- a/service/iam/api_op_CreateInstanceProfile.go +++ b/service/iam/api_op_CreateInstanceProfile.go @@ -12,14 +12,11 @@ import ( ) // Creates a new instance profile. For information about instance profiles, see -// Using roles for applications on Amazon EC2 -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) -// in the IAM User Guide, and Instance profiles -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile) +// Using roles for applications on Amazon EC2 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) +// in the IAM User Guide, and Instance profiles (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile) // in the Amazon EC2 User Guide. For information about the number of instance -// profiles you can create, see IAM object quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. +// profiles you can create, see IAM object quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstanceProfileInput, optFns ...func(*Options)) (*CreateInstanceProfileOutput, error) { if params == nil { params = &CreateInstanceProfileInput{} @@ -38,7 +35,7 @@ func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstan type CreateInstanceProfileInput struct { // The name of the instance profile to create. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -46,23 +43,21 @@ type CreateInstanceProfileInput struct { InstanceProfileName *string // The path to the instance profile. For more information about paths, see IAM - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. Path *string // A list of tags that you want to attach to the newly created IAM instance // profile. Each tag consists of a key name and an associated value. For more - // information about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateLoginProfile.go b/service/iam/api_op_CreateLoginProfile.go index d4593087a78..354392dc5f0 100644 --- a/service/iam/api_op_CreateLoginProfile.go +++ b/service/iam/api_op_CreateLoginProfile.go @@ -17,9 +17,8 @@ import ( // the IAM console to create a password for any IAM user. Use ChangePassword to // update your own existing password in the My Security Credentials page in the // Amazon Web Services Management Console. For more information about managing -// passwords, see Managing passwords -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in -// the IAM User Guide. +// passwords, see Managing passwords (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) +// in the IAM User Guide. func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProfileInput, optFns ...func(*Options)) (*CreateLoginProfileOutput, error) { if params == nil { params = &CreateLoginProfileInput{} @@ -37,24 +36,24 @@ func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProf type CreateLoginProfileInput struct { - // The new password for the user. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of characters. That string can include almost any printable ASCII - // character from the space (\u0020) through the end of the ASCII character range - // (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and - // carriage return (\u000D) characters. Any of these characters are valid in a - // password. However, many tools, such as the Amazon Web Services Management - // Console, might restrict the ability to type certain characters because they have - // special meaning within that tool. + // The new password for the user. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of characters. That string + // can include almost any printable ASCII character from the space ( \u0020 ) + // through the end of the ASCII character range ( \u00FF ). You can also include + // the tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) + // characters. Any of these characters are valid in a password. However, many + // tools, such as the Amazon Web Services Management Console, might restrict the + // ability to type certain characters because they have special meaning within that + // tool. // // This member is required. Password *string // The name of the IAM user to create a password for. The user must already exist. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_CreateOpenIDConnectProvider.go b/service/iam/api_op_CreateOpenIDConnectProvider.go index 3ca16afc640..90f3880583c 100644 --- a/service/iam/api_op_CreateOpenIDConnectProvider.go +++ b/service/iam/api_op_CreateOpenIDConnectProvider.go @@ -12,7 +12,7 @@ import ( ) // Creates an IAM entity to describe an identity provider (IdP) that supports -// OpenID Connect (OIDC) (http://openid.net/connect/). The OIDC provider that you +// OpenID Connect (OIDC) (http://openid.net/connect/) . The OIDC provider that you // create with this operation can be used as a principal in a role's trust policy. // Such a policy establishes a trust relationship between Amazon Web Services and // the OIDC provider. If you are using an OIDC identity provider from Google, @@ -20,34 +20,25 @@ import ( // provider. These OIDC identity providers are already built-in to Amazon Web // Services and are available for your use. Instead, you can move directly to // creating new roles using your identity provider. To learn more, see Creating a -// role for web identity or OpenID connect federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html) +// role for web identity or OpenID connect federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html) // in the IAM User Guide. When you create the IAM OIDC provider, you specify the // following: +// - The URL of the OIDC identity provider (IdP) to trust +// - A list of client IDs (also known as audiences) that identify the +// application or applications allowed to authenticate using the OIDC provider +// - A list of tags that are attached to the specified IAM OIDC provider +// - A list of thumbprints of one or more server certificates that the IdP uses // -// * The URL of the OIDC identity provider (IdP) to trust -// -// * A list of -// client IDs (also known as audiences) that identify the application or -// applications allowed to authenticate using the OIDC provider -// -// * A list of tags -// that are attached to the specified IAM OIDC provider -// -// * A list of thumbprints of -// one or more server certificates that the IdP uses -// -// You get all of this -// information from the OIDC IdP you want to use to access Amazon Web Services. -// Amazon Web Services secures communication with some OIDC identity providers -// (IdPs) through our library of trusted certificate authorities (CAs) instead of -// using a certificate thumbprint to verify your IdP server certificate. These OIDC -// IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a -// JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains -// in your configuration, but is no longer used for validation. The trust for the -// OIDC provider is derived from the IAM provider that this operation creates. -// Therefore, it is best to limit access to the CreateOpenIDConnectProvider -// operation to highly privileged users. +// You get all of this information from the OIDC IdP you want to use to access +// Amazon Web Services. Amazon Web Services secures communication with some OIDC +// identity providers (IdPs) through our library of trusted certificate authorities +// (CAs) instead of using a certificate thumbprint to verify your IdP server +// certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon +// S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your +// legacy thumbprint remains in your configuration, but is no longer used for +// validation. The trust for the OIDC provider is derived from the IAM provider +// that this operation creates. Therefore, it is best to limit access to the +// CreateOpenIDConnectProvider operation to highly privileged users. func (c *Client) CreateOpenIDConnectProvider(ctx context.Context, params *CreateOpenIDConnectProviderInput, optFns ...func(*Options)) (*CreateOpenIDConnectProviderOutput, error) { if params == nil { params = &CreateOpenIDConnectProviderInput{} @@ -77,9 +68,8 @@ type CreateOpenIDConnectProviderInput struct { // keys at https://keys.server.example.com/openid-connect. In that case, the // thumbprint string would be the hex-encoded SHA-1 hash value of the certificate // used by https://keys.server.example.com. For more information about obtaining - // the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect - // provider - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html) + // the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID + // Connect provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html) // in the IAM user Guide. // // This member is required. @@ -89,7 +79,7 @@ type CreateOpenIDConnectProviderInput struct { // correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the // OIDC standard, path components are allowed but query parameters are not. // Typically the URL consists of only a hostname, like https://server.example.org - // or https://example.com. The URL should not contain a port number. You cannot + // or https://example.com . The URL should not contain a port number. You cannot // register the same provider multiple times in a single Amazon Web Services // account. If you try to submit a URL that has already been used for an OpenID // Connect provider in the Amazon Web Services account, you will get an error. @@ -97,8 +87,8 @@ type CreateOpenIDConnectProviderInput struct { // This member is required. Url *string - // Provides a list of client IDs, also known as audiences. When a mobile or web app - // registers with an OpenID Connect provider, they establish a value that + // Provides a list of client IDs, also known as audiences. When a mobile or web + // app registers with an OpenID Connect provider, they establish a value that // identifies the application. This is the value that's sent as the client_id // parameter on OAuth requests. You can register multiple client IDs with the same // provider. For example, you might have multiple applications that use the same @@ -110,10 +100,10 @@ type CreateOpenIDConnectProviderInput struct { // A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) // provider. Each tag consists of a key name and an associated value. For more - // information about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde @@ -123,13 +113,13 @@ type CreateOpenIDConnectProviderInput struct { type CreateOpenIDConnectProviderOutput struct { // The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is - // created. For more information, see OpenIDConnectProviderListEntry. + // created. For more information, see OpenIDConnectProviderListEntry . OpenIDConnectProviderArn *string - // A list of tags that are attached to the new IAM OIDC provider. The returned list - // of tags is sorted by tag key. For more information about tagging, see Tagging - // IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in - // the IAM User Guide. + // A list of tags that are attached to the new IAM OIDC provider. The returned + // list of tags is sorted by tag key. For more information about tagging, see + // Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_CreatePolicy.go b/service/iam/api_op_CreatePolicy.go index 7aa59de9872..a3fd0150383 100644 --- a/service/iam/api_op_CreatePolicy.go +++ b/service/iam/api_op_CreatePolicy.go @@ -14,14 +14,11 @@ import ( // Creates a new managed policy for your Amazon Web Services account. This // operation creates a policy version with a version identifier of v1 and sets v1 // as the policy's default version. For more information about policy versions, see -// Versioning for managed policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) +// Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. As a best practice, you can validate your IAM policies. -// To learn more, see Validating IAM policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) +// To learn more, see Validating IAM policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) // in the IAM User Guide. For more information about managed policies in general, -// see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { @@ -40,37 +37,32 @@ func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, op type CreatePolicyInput struct { - // The JSON policy document that you want to use as the content for the new policy. - // You must provide policies in JSON format in IAM. However, for CloudFormation - // templates formatted in YAML, you can provide the policy in JSON or YAML format. - // CloudFormation always converts a YAML policy to JSON format before submitting it - // to IAM. The maximum length of the policy document that you can pass in this - // operation, including whitespace, is listed below. To view the maximum character - // counts of a managed policy with no whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // To learn more about JSON policy grammar, see Grammar of the IAM JSON policy - // language - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) + // The JSON policy document that you want to use as the content for the new + // policy. You must provide policies in JSON format in IAM. However, for + // CloudFormation templates formatted in YAML, you can provide the policy in JSON + // or YAML format. CloudFormation always converts a YAML policy to JSON format + // before submitting it to IAM. The maximum length of the policy document that you + // can pass in this operation, including whitespace, is listed below. To view the + // maximum character counts of a managed policy with no whitespaces, see IAM and + // STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . To learn more about JSON policy grammar, see Grammar of the IAM JSON policy + // language (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) // in the IAM User Guide. The regex pattern (http://wikipedia.org/wiki/regex) used // to validate this parameter is a string of characters consisting of the // following: - // - // * Any printable ASCII character ranging from the space character - // (\u0020) through the end of the ASCII character range - // - // * The printable - // characters in the Basic Latin and Latin-1 Supplement character set (through - // \u00FF) - // - // * The special characters tab (\u0009), line feed (\u000A), and carriage - // return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string - // The friendly name of the policy. IAM user, group, role, and policy names must be - // unique within the account. Names are not distinguished by case. For example, you - // cannot create resources named both "MyResource" and "myresource". + // The friendly name of the policy. IAM user, group, role, and policy names must + // be unique within the account. Names are not distinguished by case. For example, + // you cannot create resources named both "MyResource" and "myresource". // // This member is required. PolicyName *string @@ -81,24 +73,22 @@ type CreatePolicyInput struct { // assigned, it cannot be changed. Description *string - // The path for the policy. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. You cannot use an asterisk (*) in the - // path name. + // The path for the policy. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. + // You cannot use an asterisk (*) in the path name. Path *string // A list of tags that you want to attach to the new IAM customer managed policy. // Each tag consists of a key name and an associated value. For more information - // about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreatePolicyVersion.go b/service/iam/api_op_CreatePolicyVersion.go index 13980761f5b..84544fc6296 100644 --- a/service/iam/api_op_CreatePolicyVersion.go +++ b/service/iam/api_op_CreatePolicyVersion.go @@ -18,8 +18,7 @@ import ( // set the new version as the policy's default version. The default version is the // version that is in effect for the IAM users, groups, and roles to which the // policy is attached. For more information about managed policy versions, see -// Versioning for managed policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) +// Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error) { if params == nil { @@ -39,9 +38,8 @@ func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVe type CreatePolicyVersionInput struct { // The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new - // version. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // version. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string @@ -53,30 +51,24 @@ type CreatePolicyVersionInput struct { // before submitting it to IAM. The maximum length of the policy document that you // can pass in this operation, including whitespace, is listed below. To view the // maximum character counts of a managed policy with no whitespaces, see IAM and - // STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string - // Specifies whether to set this version as the policy's default version. When this - // parameter is true, the new policy version becomes the operative version. That - // is, it becomes the version that is in effect for the IAM users, groups, and + // Specifies whether to set this version as the policy's default version. When + // this parameter is true , the new policy version becomes the operative version. + // That is, it becomes the version that is in effect for the IAM users, groups, and // roles that the policy is attached to. For more information about managed policy - // versions, see Versioning for managed policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // versions, see Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. SetAsDefault bool diff --git a/service/iam/api_op_CreateRole.go b/service/iam/api_op_CreateRole.go index ecaedee0ce7..3ef5da743fe 100644 --- a/service/iam/api_op_CreateRole.go +++ b/service/iam/api_op_CreateRole.go @@ -12,12 +12,10 @@ import ( ) // Creates a new role for your Amazon Web Services account. For more information -// about roles, see IAM roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). For -// information about quotas for role names and the number of roles you can create, -// see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. +// about roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) +// . For information about quotas for role names and the number of roles you can +// create, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns ...func(*Options)) (*CreateRoleOutput, error) { if params == nil { params = &CreateRoleInput{} @@ -39,22 +37,16 @@ type CreateRoleInput struct { // assume the role. In IAM, you must provide a JSON policy that has been converted // to a string. However, for CloudFormation templates formatted in YAML, you can // provide the policy in JSON or YAML format. CloudFormation always converts a YAML - // policy to JSON format before submitting it to IAM. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) - // - // Upon success, the response includes the - // same trust policy in JSON format. + // policy to JSON format before submitting it to IAM. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) + // Upon success, the response includes the same trust policy in JSON format. // // This member is required. AssumeRolePolicyDocument *string @@ -62,8 +54,8 @@ type CreateRoleInput struct { // The name of the role to create. IAM user, group, role, and policy names must be // unique within the account. Names are not distinguished by case. For example, you // cannot create resources named both "MyResource" and "myresource". This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -72,30 +64,28 @@ type CreateRoleInput struct { // A description of the role. Description *string - // The maximum session duration (in seconds) that you want to set for the specified - // role. If you do not specify a value for this setting, the default value of one - // hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone - // who assumes the role from the CLI or API can use the DurationSeconds API - // parameter or the duration-seconds CLI parameter to request a longer session. The - // MaxSessionDuration setting determines the maximum duration that can be requested - // using the DurationSeconds parameter. If users don't specify a value for the - // DurationSeconds parameter, their security credentials are valid for one hour by - // default. This applies when you use the AssumeRole* API operations or the - // assume-role* CLI operations but does not apply when you use those operations to - // create a console URL. For more information, see Using IAM roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM - // User Guide. + // The maximum session duration (in seconds) that you want to set for the + // specified role. If you do not specify a value for this setting, the default + // value of one hour is applied. This setting can have a value from 1 hour to 12 + // hours. Anyone who assumes the role from the CLI or API can use the + // DurationSeconds API parameter or the duration-seconds CLI parameter to request + // a longer session. The MaxSessionDuration setting determines the maximum + // duration that can be requested using the DurationSeconds parameter. If users + // don't specify a value for the DurationSeconds parameter, their security + // credentials are valid for one hour by default. This applies when you use the + // AssumeRole* API operations or the assume-role* CLI operations but does not + // apply when you use those operations to create a console URL. For more + // information, see Using IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) + // in the IAM User Guide. MaxSessionDuration *int32 - // The path to the role. For more information about paths, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // The path to the role. For more information about paths, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. Path *string // The ARN of the managed policy that is used to set the permissions boundary for @@ -103,19 +93,18 @@ type CreateRoleInput struct { // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see Permissions - // boundaries for IAM entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. For more information about policy types, see Policy types - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) + // boundaries for IAM entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. For more information about policy types, see Policy + // types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) // in the IAM User Guide. PermissionsBoundary *string // A list of tags that you want to attach to the new role. Each tag consists of a // key name and an associated value. For more information about tagging, see - // Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateSAMLProvider.go b/service/iam/api_op_CreateSAMLProvider.go index 823b64cc35e..6c222b16bc7 100644 --- a/service/iam/api_op_CreateSAMLProvider.go +++ b/service/iam/api_op_CreateSAMLProvider.go @@ -22,13 +22,10 @@ import ( // expiration information, and keys that can be used to validate the SAML // authentication response (assertions) that the IdP sends. You must generate the // metadata document using the identity management software that is used as your -// organization's IdP. This operation requires Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). For -// more information, see Enabling SAML 2.0 federated users to access the Amazon Web -// Services Management Console -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html) -// and About SAML 2.0-based federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) +// organization's IdP. This operation requires Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . For more information, see Enabling SAML 2.0 federated users to access the +// Amazon Web Services Management Console (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html) +// and About SAML 2.0-based federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) // in the IAM User Guide. func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProviderInput, optFns ...func(*Options)) (*CreateSAMLProviderOutput, error) { if params == nil { @@ -48,7 +45,7 @@ func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProvi type CreateSAMLProviderInput struct { // The name of the provider to create. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // @@ -60,8 +57,7 @@ type CreateSAMLProviderInput struct { // can be used to validate the SAML authentication response (assertions) that are // received from the IdP. You must generate the metadata document using the // identity management software that is used as your organization's IdP. For more - // information, see About SAML 2.0-based federation - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) + // information, see About SAML 2.0-based federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) // in the IAM User Guide // // This member is required. @@ -69,10 +65,10 @@ type CreateSAMLProviderInput struct { // A list of tags that you want to attach to the new IAM SAML provider. Each tag // consists of a key name and an associated value. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde @@ -84,10 +80,10 @@ type CreateSAMLProviderOutput struct { // The Amazon Resource Name (ARN) of the new SAML provider resource in IAM. SAMLProviderArn *string - // A list of tags that are attached to the new IAM SAML provider. The returned list - // of tags is sorted by tag key. For more information about tagging, see Tagging - // IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in - // the IAM User Guide. + // A list of tags that are attached to the new IAM SAML provider. The returned + // list of tags is sorted by tag key. For more information about tagging, see + // Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_CreateServiceLinkedRole.go b/service/iam/api_op_CreateServiceLinkedRole.go index 060e2dad5e3..56153cf0b79 100644 --- a/service/iam/api_op_CreateServiceLinkedRole.go +++ b/service/iam/api_op_CreateServiceLinkedRole.go @@ -17,8 +17,7 @@ import ( // deleted role, which could put your Amazon Web Services resources into an unknown // state. Allowing the service to control the role helps improve service stability // and proper cleanup when a service and its role are no longer needed. For more -// information, see Using service-linked roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) +// information, see Using service-linked roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) // in the IAM User Guide. To attach a policy to this service-linked role, you must // make the request using the Amazon Web Services service that depends on this // role. @@ -41,10 +40,9 @@ type CreateServiceLinkedRoleInput struct { // The service principal for the Amazon Web Services service to which this role is // attached. You use a string similar to a URL but without the http:// in front. - // For example: elasticbeanstalk.amazonaws.com. Service principals are unique and + // For example: elasticbeanstalk.amazonaws.com . Service principals are unique and // case-sensitive. To find the exact service principal for your service-linked - // role, see Amazon Web Services services that work with IAM - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) + // role, see Amazon Web Services services that work with IAM (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) // in the IAM User Guide. Look for the services that have Yes in the Service-Linked // Role column. Choose the Yes link to view the service-linked role documentation // for that service. @@ -52,13 +50,13 @@ type CreateServiceLinkedRoleInput struct { // This member is required. AWSServiceName *string - // A string that you provide, which is combined with the service-provided prefix to - // form the complete role name. If you make multiple requests for the same service, - // then you must supply a different CustomSuffix for each request. Otherwise the - // request fails with a duplicate role name error. For example, you could add -1 or - // -debug to the suffix. Some services do not support the CustomSuffix parameter. - // If you provide an optional suffix and the operation fails, try the operation - // again without the suffix. + // A string that you provide, which is combined with the service-provided prefix + // to form the complete role name. If you make multiple requests for the same + // service, then you must supply a different CustomSuffix for each request. + // Otherwise the request fails with a duplicate role name error. For example, you + // could add -1 or -debug to the suffix. Some services do not support the + // CustomSuffix parameter. If you provide an optional suffix and the operation + // fails, try the operation again without the suffix. CustomSuffix *string // The description of the role. diff --git a/service/iam/api_op_CreateServiceSpecificCredential.go b/service/iam/api_op_CreateServiceSpecificCredential.go index 826b193d90b..9de6d72961f 100644 --- a/service/iam/api_op_CreateServiceSpecificCredential.go +++ b/service/iam/api_op_CreateServiceSpecificCredential.go @@ -17,10 +17,9 @@ import ( // maximum of two sets of service-specific credentials for each supported service // per user. You can create service-specific credentials for CodeCommit and Amazon // Keyspaces (for Apache Cassandra). You can reset the password to a new -// service-generated value by calling ResetServiceSpecificCredential. For more +// service-generated value by calling ResetServiceSpecificCredential . For more // information about service-specific credentials, see Using IAM with CodeCommit: -// Git credentials, SSH keys, and Amazon Web Services access keys -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html) +// Git credentials, SSH keys, and Amazon Web Services access keys (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html) // in the IAM User Guide. func (c *Client) CreateServiceSpecificCredential(ctx context.Context, params *CreateServiceSpecificCredentialInput, optFns ...func(*Options)) (*CreateServiceSpecificCredentialOutput, error) { if params == nil { @@ -49,8 +48,8 @@ type CreateServiceSpecificCredentialInput struct { // The name of the IAM user that is to be associated with the credentials. The new // service-specific credentials have the same permissions as the associated user // except that they can be used only to access the specified service. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -64,7 +63,7 @@ type CreateServiceSpecificCredentialOutput struct { // A structure that contains information about the newly created service-specific // credential. This is the only time that the password for this credential set is // available. It cannot be recovered later. Instead, you must reset the password - // with ResetServiceSpecificCredential. + // with ResetServiceSpecificCredential . ServiceSpecificCredential *types.ServiceSpecificCredential // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_CreateUser.go b/service/iam/api_op_CreateUser.go index 69cd683b85c..1bee08803ab 100644 --- a/service/iam/api_op_CreateUser.go +++ b/service/iam/api_op_CreateUser.go @@ -12,9 +12,8 @@ import ( ) // Creates a new IAM user for your Amazon Web Services account. For information -// about quotas for the number of IAM users you can create, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. +// about quotas for the number of IAM users you can create, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} @@ -40,15 +39,13 @@ type CreateUserInput struct { UserName *string // The path for the user name. For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. Path *string // The ARN of the managed policy that is used to set the permissions boundary for @@ -56,19 +53,18 @@ type CreateUserInput struct { // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see Permissions - // boundaries for IAM entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. For more information about policy types, see Policy types - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) + // boundaries for IAM entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. For more information about policy types, see Policy + // types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) // in the IAM User Guide. PermissionsBoundary *string // A list of tags that you want to attach to the new user. Each tag consists of a // key name and an associated value. For more information about tagging, see - // Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateVirtualMFADevice.go b/service/iam/api_op_CreateVirtualMFADevice.go index 688940e9150..591d1d121a6 100644 --- a/service/iam/api_op_CreateVirtualMFADevice.go +++ b/service/iam/api_op_CreateVirtualMFADevice.go @@ -12,18 +12,16 @@ import ( ) // Creates a new virtual MFA device for the Amazon Web Services account. After -// creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM -// user. For more information about creating and working with virtual MFA devices, -// see Using a virtual MFA device -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) in the -// IAM User Guide. For information about the maximum number of MFA devices you can -// create, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. The seed information contained in the QR code and the Base32 -// string should be treated like any other secret access information. In other -// words, protect the seed information as you would your Amazon Web Services access -// keys or your passwords. After you provision your virtual device, you should -// ensure that the information is destroyed following secure procedures. +// creating the virtual MFA, use EnableMFADevice to attach the MFA device to an +// IAM user. For more information about creating and working with virtual MFA +// devices, see Using a virtual MFA device (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) +// in the IAM User Guide. For information about the maximum number of MFA devices +// you can create, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. The seed information contained in the QR code and the +// Base32 string should be treated like any other secret access information. In +// other words, protect the seed information as you would your Amazon Web Services +// access keys or your passwords. After you provision your virtual device, you +// should ensure that the information is destroyed following secure procedures. func (c *Client) CreateVirtualMFADevice(ctx context.Context, params *CreateVirtualMFADeviceInput, optFns ...func(*Options)) (*CreateVirtualMFADeviceOutput, error) { if params == nil { params = &CreateVirtualMFADeviceInput{} @@ -42,32 +40,30 @@ func (c *Client) CreateVirtualMFADevice(ctx context.Context, params *CreateVirtu type CreateVirtualMFADeviceInput struct { // The name of the virtual MFA device, which must be unique. Use with path to - // uniquely identify a virtual MFA device. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // uniquely identify a virtual MFA device. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- // // This member is required. VirtualMFADeviceName *string // The path for the virtual MFA device. For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. Path *string // A list of tags that you want to attach to the new IAM virtual MFA device. Each // tag consists of a key name and an associated value. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_DeactivateMFADevice.go b/service/iam/api_op_DeactivateMFADevice.go index d640bde8447..86f2d8cd2dd 100644 --- a/service/iam/api_op_DeactivateMFADevice.go +++ b/service/iam/api_op_DeactivateMFADevice.go @@ -13,9 +13,8 @@ import ( // Deactivates the specified MFA device and removes it from association with the // user name for which it was originally enabled. For more information about // creating and working with virtual MFA devices, see Enabling a virtual -// multi-factor authentication (MFA) device -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) in the -// IAM User Guide. +// multi-factor authentication (MFA) device (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) +// in the IAM User Guide. func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFADeviceInput, optFns ...func(*Options)) (*DeactivateMFADeviceOutput, error) { if params == nil { params = &DeactivateMFADeviceInput{} @@ -35,7 +34,7 @@ type DeactivateMFADeviceInput struct { // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: =,.@:/- // @@ -43,8 +42,8 @@ type DeactivateMFADeviceInput struct { SerialNumber *string // The name of the user whose MFA device you want to deactivate. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_DeleteAccessKey.go b/service/iam/api_op_DeleteAccessKey.go index 01ed1c03cef..204fd0e3807 100644 --- a/service/iam/api_op_DeleteAccessKey.go +++ b/service/iam/api_op_DeleteAccessKey.go @@ -34,16 +34,16 @@ func (c *Client) DeleteAccessKey(ctx context.Context, params *DeleteAccessKeyInp type DeleteAccessKeyInput struct { // The access key ID for the access key ID and secret access key you want to - // delete. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters that can consist of - // any upper or lowercased letter or digit. + // delete. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters that can consist of any upper or lowercased letter or + // digit. // // This member is required. AccessKeyId *string // The name of the user whose access key pair you want to delete. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_DeleteAccountAlias.go b/service/iam/api_op_DeleteAccountAlias.go index 6c86a2eaf92..ae41634ec35 100644 --- a/service/iam/api_op_DeleteAccountAlias.go +++ b/service/iam/api_op_DeleteAccountAlias.go @@ -12,9 +12,8 @@ import ( // Deletes the specified Amazon Web Services account alias. For information about // using an Amazon Web Services account alias, see Using an alias for your Amazon -// Web Services account ID -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) in the IAM -// User Guide. +// Web Services account ID (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) +// in the IAM User Guide. func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAliasInput, optFns ...func(*Options)) (*DeleteAccountAliasOutput, error) { if params == nil { params = &DeleteAccountAliasInput{} @@ -33,7 +32,7 @@ func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAl type DeleteAccountAliasInput struct { // The name of the account alias to delete. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of lowercase letters, digits, and dashes. You cannot start or finish // with a dash, nor can you have two dashes in a row. // diff --git a/service/iam/api_op_DeleteGroup.go b/service/iam/api_op_DeleteGroup.go index 544ca0c26de..591a166bca5 100644 --- a/service/iam/api_op_DeleteGroup.go +++ b/service/iam/api_op_DeleteGroup.go @@ -30,7 +30,7 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { // The name of the IAM group to delete. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_DeleteGroupPolicy.go b/service/iam/api_op_DeleteGroupPolicy.go index ad8a44f6ed7..1e24009be8a 100644 --- a/service/iam/api_op_DeleteGroupPolicy.go +++ b/service/iam/api_op_DeleteGroupPolicy.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified inline policy that is embedded in the specified IAM group. -// A group can also have managed policies attached to it. To detach a managed -// policy from a group, use DetachGroupPolicy. For more information about policies, -// refer to Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// Deletes the specified inline policy that is embedded in the specified IAM +// group. A group can also have managed policies attached to it. To detach a +// managed policy from a group, use DetachGroupPolicy . For more information about +// policies, refer to Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolicyInput, optFns ...func(*Options)) (*DeleteGroupPolicyOutput, error) { if params == nil { @@ -34,16 +33,16 @@ func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolic type DeleteGroupPolicyInput struct { // The name (friendly name, not ARN) identifying the group that the policy is - // embedded in. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // embedded in. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. GroupName *string // The name identifying the policy document to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_DeleteInstanceProfile.go b/service/iam/api_op_DeleteInstanceProfile.go index ebd64d64d25..f6a3229268a 100644 --- a/service/iam/api_op_DeleteInstanceProfile.go +++ b/service/iam/api_op_DeleteInstanceProfile.go @@ -14,9 +14,9 @@ import ( // associated role. Make sure that you do not have any Amazon EC2 instances running // with the instance profile you are about to delete. Deleting a role or instance // profile that is associated with a running instance will break any applications -// running on the instance. For more information about instance profiles, see About -// instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html). +// running on the instance. For more information about instance profiles, see +// About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// . func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, optFns ...func(*Options)) (*DeleteInstanceProfileOutput, error) { if params == nil { params = &DeleteInstanceProfileInput{} @@ -35,7 +35,7 @@ func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstan type DeleteInstanceProfileInput struct { // The name of the instance profile to delete. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_DeleteLoginProfile.go b/service/iam/api_op_DeleteLoginProfile.go index 32f77feade1..6c1a5339f32 100644 --- a/service/iam/api_op_DeleteLoginProfile.go +++ b/service/iam/api_op_DeleteLoginProfile.go @@ -11,16 +11,15 @@ import ( ) // Deletes the password for the specified IAM user, For more information, see -// Managing passwords for IAM users -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html). -// You can use the CLI, the Amazon Web Services API, or the Users page in the IAM +// Managing passwords for IAM users (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html) +// . You can use the CLI, the Amazon Web Services API, or the Users page in the IAM // console to delete a password for any IAM user. You can use ChangePassword to // update, but not delete, your own password in the My Security Credentials page in // the Amazon Web Services Management Console. Deleting a user's password does not // prevent a user from accessing Amazon Web Services through the command line // interface or the API. To prevent all user access, you must also either make any // access keys inactive or delete them. For more information about making keys -// inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. +// inactive or deleting them, see UpdateAccessKey and DeleteAccessKey . func (c *Client) DeleteLoginProfile(ctx context.Context, params *DeleteLoginProfileInput, optFns ...func(*Options)) (*DeleteLoginProfileOutput, error) { if params == nil { params = &DeleteLoginProfileInput{} @@ -39,7 +38,7 @@ func (c *Client) DeleteLoginProfile(ctx context.Context, params *DeleteLoginProf type DeleteLoginProfileInput struct { // The name of the user whose password you want to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_DeletePolicy.go b/service/iam/api_op_DeletePolicy.go index 322f3e6258c..38a2d01a84e 100644 --- a/service/iam/api_op_DeletePolicy.go +++ b/service/iam/api_op_DeletePolicy.go @@ -14,25 +14,18 @@ import ( // you must first detach the policy from all users, groups, and roles that it is // attached to. In addition, you must delete all the policy's versions. The // following steps describe the process for deleting a managed policy: +// - Detach the policy from all users, groups, and roles that the policy is +// attached to, using DetachUserPolicy , DetachGroupPolicy , or DetachRolePolicy +// . To list all the users, groups, and roles that a policy is attached to, use +// ListEntitiesForPolicy . +// - Delete all versions of the policy using DeletePolicyVersion . To list the +// policy's versions, use ListPolicyVersions . You cannot use DeletePolicyVersion +// to delete the version that is marked as the default version. You delete the +// policy's default version in the next step of the process. +// - Delete the policy (this automatically deletes the policy's default version) +// using this operation. // -// * Detach -// the policy from all users, groups, and roles that the policy is attached to, -// using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the -// users, groups, and roles that a policy is attached to, use -// ListEntitiesForPolicy. -// -// * Delete all versions of the policy using -// DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You -// cannot use DeletePolicyVersion to delete the version that is marked as the -// default version. You delete the policy's default version in the next step of the -// process. -// -// * Delete the policy (this automatically deletes the policy's default -// version) using this operation. -// -// For information about managed policies, see -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// For information about managed policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { @@ -52,9 +45,8 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to delete. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_DeletePolicyVersion.go b/service/iam/api_op_DeletePolicyVersion.go index ee1baef3a78..c01645a2d07 100644 --- a/service/iam/api_op_DeletePolicyVersion.go +++ b/service/iam/api_op_DeletePolicyVersion.go @@ -12,10 +12,10 @@ import ( // Deletes the specified version from the specified managed policy. You cannot // delete the default version from a policy using this operation. To delete the -// default version from a policy, use DeletePolicy. To find out which version of a -// policy is marked as the default version, use ListPolicyVersions. For information -// about versions for managed policies, see Versioning for managed policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) +// default version from a policy, use DeletePolicy . To find out which version of a +// policy is marked as the default version, use ListPolicyVersions . For +// information about versions for managed policies, see Versioning for managed +// policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error) { if params == nil { @@ -34,20 +34,18 @@ func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVe type DeletePolicyVersionInput struct { - // The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a - // version. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // The Amazon Resource Name (ARN) of the IAM policy from which you want to delete + // a version. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string - // The policy version to delete. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters that consists of the - // lowercase letter 'v' followed by one or two digits, and optionally followed by a - // period '.' and a string of letters and digits. For more information about - // managed policy versions, see Versioning for managed policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // The policy version to delete. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters that consists of the lowercase letter 'v' followed by + // one or two digits, and optionally followed by a period '.' and a string of + // letters and digits. For more information about managed policy versions, see + // Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. // // This member is required. diff --git a/service/iam/api_op_DeleteRole.go b/service/iam/api_op_DeleteRole.go index 6282db633d7..88826395c57 100644 --- a/service/iam/api_op_DeleteRole.go +++ b/service/iam/api_op_DeleteRole.go @@ -13,26 +13,17 @@ import ( // Deletes the specified role. Unlike the Amazon Web Services Management Console, // when you delete a role programmatically, you must delete the items attached to // the role manually, or the deletion fails. For more information, see Deleting an -// IAM role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli). -// Before attempting to delete a role, remove the following attached items: +// IAM role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli) +// . Before attempting to delete a role, remove the following attached items: +// - Inline policies ( DeleteRolePolicy ) +// - Attached managed policies ( DetachRolePolicy ) +// - Instance profile ( RemoveRoleFromInstanceProfile ) +// - Optional – Delete instance profile after detaching from role for resource +// clean up ( DeleteInstanceProfile ) // -// * -// Inline policies (DeleteRolePolicy) -// -// * Attached managed policies -// (DetachRolePolicy) -// -// * Instance profile (RemoveRoleFromInstanceProfile) -// -// * -// Optional – Delete instance profile after detaching from role for resource clean -// up (DeleteInstanceProfile) -// -// Make sure that you do not have any Amazon EC2 -// instances running with the role you are about to delete. Deleting a role or -// instance profile that is associated with a running instance will break any -// applications running on the instance. +// Make sure that you do not have any Amazon EC2 instances running with the role +// you are about to delete. Deleting a role or instance profile that is associated +// with a running instance will break any applications running on the instance. func (c *Client) DeleteRole(ctx context.Context, params *DeleteRoleInput, optFns ...func(*Options)) (*DeleteRoleOutput, error) { if params == nil { params = &DeleteRoleInput{} @@ -50,10 +41,10 @@ func (c *Client) DeleteRole(ctx context.Context, params *DeleteRoleInput, optFns type DeleteRoleInput struct { - // The name of the role to delete. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the role to delete. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string diff --git a/service/iam/api_op_DeleteRolePolicy.go b/service/iam/api_op_DeleteRolePolicy.go index 4e2a1c80075..4f6cecc8a2a 100644 --- a/service/iam/api_op_DeleteRolePolicy.go +++ b/service/iam/api_op_DeleteRolePolicy.go @@ -12,9 +12,8 @@ import ( // Deletes the specified inline policy that is embedded in the specified IAM role. // A role can also have managed policies attached to it. To detach a managed policy -// from a role, use DetachRolePolicy. For more information about policies, refer to -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// from a role, use DetachRolePolicy . For more information about policies, refer +// to Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DeleteRolePolicy(ctx context.Context, params *DeleteRolePolicyInput, optFns ...func(*Options)) (*DeleteRolePolicyOutput, error) { if params == nil { @@ -34,18 +33,18 @@ func (c *Client) DeleteRolePolicy(ctx context.Context, params *DeleteRolePolicyI type DeleteRolePolicyInput struct { // The name of the inline policy to delete from the specified IAM role. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. PolicyName *string // The name (friendly name, not ARN) identifying the role that the policy is - // embedded in. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // embedded in. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string diff --git a/service/iam/api_op_DeleteSAMLProvider.go b/service/iam/api_op_DeleteSAMLProvider.go index b2f9623258c..6a6343a78ed 100644 --- a/service/iam/api_op_DeleteSAMLProvider.go +++ b/service/iam/api_op_DeleteSAMLProvider.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a SAML provider resource in IAM. Deleting the provider resource from IAM -// does not update any roles that reference the SAML provider resource's ARN as a -// principal in their trust policies. Any attempt to assume a role that references -// a non-existent provider resource ARN fails. This operation requires Signature -// Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// Deletes a SAML provider resource in IAM. Deleting the provider resource from +// IAM does not update any roles that reference the SAML provider resource's ARN as +// a principal in their trust policies. Any attempt to assume a role that +// references a non-existent provider resource ARN fails. This operation requires +// Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) DeleteSAMLProvider(ctx context.Context, params *DeleteSAMLProviderInput, optFns ...func(*Options)) (*DeleteSAMLProviderOutput, error) { if params == nil { params = &DeleteSAMLProviderInput{} diff --git a/service/iam/api_op_DeleteSSHPublicKey.go b/service/iam/api_op_DeleteSSHPublicKey.go index eeb7de80786..ba284051045 100644 --- a/service/iam/api_op_DeleteSSHPublicKey.go +++ b/service/iam/api_op_DeleteSSHPublicKey.go @@ -13,8 +13,7 @@ import ( // Deletes the specified SSH public key. The SSH public key deleted by this // operation is used only for authenticating the associated IAM user to an // CodeCommit repository. For more information about using SSH keys to authenticate -// to an CodeCommit repository, see Set up CodeCommit for SSH connections -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) +// to an CodeCommit repository, see Set up CodeCommit for SSH connections (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) // in the CodeCommit User Guide. func (c *Client) DeleteSSHPublicKey(ctx context.Context, params *DeleteSSHPublicKeyInput, optFns ...func(*Options)) (*DeleteSSHPublicKeyOutput, error) { if params == nil { @@ -33,16 +32,16 @@ func (c *Client) DeleteSSHPublicKey(ctx context.Context, params *DeleteSSHPublic type DeleteSSHPublicKeyInput struct { - // The unique identifier for the SSH public key. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can - // consist of any upper or lowercased letter or digit. + // The unique identifier for the SSH public key. This parameter allows (through + // its regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // that can consist of any upper or lowercased letter or digit. // // This member is required. SSHPublicKeyId *string // The name of the IAM user associated with the SSH public key. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_DeleteServerCertificate.go b/service/iam/api_op_DeleteServerCertificate.go index 41436522302..567b266db1a 100644 --- a/service/iam/api_op_DeleteServerCertificate.go +++ b/service/iam/api_op_DeleteServerCertificate.go @@ -11,8 +11,7 @@ import ( ) // Deletes the specified server certificate. For more information about working -// with server certificates, see Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// with server certificates, see Working with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. This topic also includes a list of Amazon Web Services // services that can use the server certificates that you manage with IAM. If you // are using a server certificate with Elastic Load Balancing, deleting the @@ -21,8 +20,7 @@ import ( // use the certificates. This could cause Elastic Load Balancing to stop accepting // traffic. We recommend that you remove the reference to the certificate from // Elastic Load Balancing before using this command to delete the certificate. For -// more information, see DeleteLoadBalancerListeners -// (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html) +// more information, see DeleteLoadBalancerListeners (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html) // in the Elastic Load Balancing API Reference. func (c *Client) DeleteServerCertificate(ctx context.Context, params *DeleteServerCertificateInput, optFns ...func(*Options)) (*DeleteServerCertificateOutput, error) { if params == nil { @@ -42,7 +40,7 @@ func (c *Client) DeleteServerCertificate(ctx context.Context, params *DeleteServ type DeleteServerCertificateInput struct { // The name of the server certificate you want to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_DeleteServiceLinkedRole.go b/service/iam/api_op_DeleteServiceLinkedRole.go index 4257052e877..076dda155cc 100644 --- a/service/iam/api_op_DeleteServiceLinkedRole.go +++ b/service/iam/api_op_DeleteServiceLinkedRole.go @@ -10,24 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Submits a service-linked role deletion request and returns a DeletionTaskId, +// Submits a service-linked role deletion request and returns a DeletionTaskId , // which you can use to check the status of the deletion. Before you call this // operation, confirm that the role has no active sessions and that any resources // used by the role in the linked service are deleted. If you call this operation // more than once for the same service-linked role and an earlier deletion task is -// not complete, then the DeletionTaskId of the earlier request is returned. If you -// submit a deletion request for a service-linked role whose linked service is +// not complete, then the DeletionTaskId of the earlier request is returned. If +// you submit a deletion request for a service-linked role whose linked service is // still accessing a resource, then the deletion task fails. If it fails, the // GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, // usually including the resources that must be deleted. To delete the // service-linked role, you must first remove those resources from the linked // service and then submit the deletion request again. Resources are specific to // the service that is linked to the role. For more information about removing -// resources from a service, see the Amazon Web Services documentation -// (http://docs.aws.amazon.com/) for your service. For more information about -// service-linked roles, see Roles terms and concepts: Amazon Web Services -// service-linked role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role) +// resources from a service, see the Amazon Web Services documentation (http://docs.aws.amazon.com/) +// for your service. For more information about service-linked roles, see Roles +// terms and concepts: Amazon Web Services service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role) // in the IAM User Guide. func (c *Client) DeleteServiceLinkedRole(ctx context.Context, params *DeleteServiceLinkedRoleInput, optFns ...func(*Options)) (*DeleteServiceLinkedRoleOutput, error) { if params == nil { @@ -57,7 +55,7 @@ type DeleteServiceLinkedRoleInput struct { type DeleteServiceLinkedRoleOutput struct { // The deletion task identifier that you can use to check the status of the - // deletion. This identifier is returned in the format task/aws-service-role///. + // deletion. This identifier is returned in the format task/aws-service-role/// . // // This member is required. DeletionTaskId *string diff --git a/service/iam/api_op_DeleteServiceSpecificCredential.go b/service/iam/api_op_DeleteServiceSpecificCredential.go index 2786e9596b3..3ac64fda7c3 100644 --- a/service/iam/api_op_DeleteServiceSpecificCredential.go +++ b/service/iam/api_op_DeleteServiceSpecificCredential.go @@ -28,10 +28,10 @@ func (c *Client) DeleteServiceSpecificCredential(ctx context.Context, params *De type DeleteServiceSpecificCredentialInput struct { - // The unique identifier of the service-specific credential. You can get this value - // by calling ListServiceSpecificCredentials. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can - // consist of any upper or lowercased letter or digit. + // The unique identifier of the service-specific credential. You can get this + // value by calling ListServiceSpecificCredentials . This parameter allows (through + // its regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // that can consist of any upper or lowercased letter or digit. // // This member is required. ServiceSpecificCredentialId *string @@ -39,7 +39,7 @@ type DeleteServiceSpecificCredentialInput struct { // The name of the IAM user associated with the service-specific credential. If // this value is not specified, then the operation assumes the user whose // credentials are used to call the operation. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_DeleteSigningCertificate.go b/service/iam/api_op_DeleteSigningCertificate.go index 765ae8ae9d8..ad8f27f11d3 100644 --- a/service/iam/api_op_DeleteSigningCertificate.go +++ b/service/iam/api_op_DeleteSigningCertificate.go @@ -34,14 +34,14 @@ func (c *Client) DeleteSigningCertificate(ctx context.Context, params *DeleteSig type DeleteSigningCertificateInput struct { // The ID of the signing certificate to delete. The format of this parameter, as - // described by its regex (http://wikipedia.org/wiki/regex) pattern, is a string of - // characters that can be upper- or lower-cased letters or digits. + // described by its regex (http://wikipedia.org/wiki/regex) pattern, is a string + // of characters that can be upper- or lower-cased letters or digits. // // This member is required. CertificateId *string // The name of the user the signing certificate belongs to. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_DeleteUser.go b/service/iam/api_op_DeleteUser.go index 47b3277f7fc..ce597dcdef4 100644 --- a/service/iam/api_op_DeleteUser.go +++ b/service/iam/api_op_DeleteUser.go @@ -13,33 +13,18 @@ import ( // Deletes the specified IAM user. Unlike the Amazon Web Services Management // Console, when you delete a user programmatically, you must delete the items // attached to the user manually, or the deletion fails. For more information, see -// Deleting an IAM user -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli). -// Before attempting to delete a user, remove the following items: -// -// * Password -// (DeleteLoginProfile) -// -// * Access keys (DeleteAccessKey) -// -// * Signing certificate -// (DeleteSigningCertificate) -// -// * SSH public key (DeleteSSHPublicKey) -// -// * Git -// credentials (DeleteServiceSpecificCredential) -// -// * Multi-factor authentication -// (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice) -// -// * Inline policies -// (DeleteUserPolicy) -// -// * Attached managed policies (DetachUserPolicy) -// -// * Group -// memberships (RemoveUserFromGroup) +// Deleting an IAM user (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting_cli) +// . Before attempting to delete a user, remove the following items: +// - Password ( DeleteLoginProfile ) +// - Access keys ( DeleteAccessKey ) +// - Signing certificate ( DeleteSigningCertificate ) +// - SSH public key ( DeleteSSHPublicKey ) +// - Git credentials ( DeleteServiceSpecificCredential ) +// - Multi-factor authentication (MFA) device ( DeactivateMFADevice , +// DeleteVirtualMFADevice ) +// - Inline policies ( DeleteUserPolicy ) +// - Attached managed policies ( DetachUserPolicy ) +// - Group memberships ( RemoveUserFromGroup ) func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} @@ -57,10 +42,10 @@ func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns type DeleteUserInput struct { - // The name of the user to delete. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the user to delete. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteUserPolicy.go b/service/iam/api_op_DeleteUserPolicy.go index d83daed99b1..b9fc92bc99f 100644 --- a/service/iam/api_op_DeleteUserPolicy.go +++ b/service/iam/api_op_DeleteUserPolicy.go @@ -12,9 +12,8 @@ import ( // Deletes the specified inline policy that is embedded in the specified IAM user. // A user can also have managed policies attached to it. To detach a managed policy -// from a user, use DetachUserPolicy. For more information about policies, refer to -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// from a user, use DetachUserPolicy . For more information about policies, refer +// to Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyInput, optFns ...func(*Options)) (*DeleteUserPolicyOutput, error) { if params == nil { @@ -34,7 +33,7 @@ func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyI type DeleteUserPolicyInput struct { // The name identifying the policy document to delete. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -42,10 +41,10 @@ type DeleteUserPolicyInput struct { PolicyName *string // The name (friendly name, not ARN) identifying the user that the policy is - // embedded in. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // embedded in. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteVirtualMFADevice.go b/service/iam/api_op_DeleteVirtualMFADevice.go index 1dc3a28e945..6d8055dc7e2 100644 --- a/service/iam/api_op_DeleteVirtualMFADevice.go +++ b/service/iam/api_op_DeleteVirtualMFADevice.go @@ -12,7 +12,7 @@ import ( // Deletes a virtual MFA device. You must deactivate a user's virtual MFA device // before you can delete it. For information about deactivating MFA devices, see -// DeactivateMFADevice. +// DeactivateMFADevice . func (c *Client) DeleteVirtualMFADevice(ctx context.Context, params *DeleteVirtualMFADeviceInput, optFns ...func(*Options)) (*DeleteVirtualMFADeviceOutput, error) { if params == nil { params = &DeleteVirtualMFADeviceInput{} @@ -32,7 +32,7 @@ type DeleteVirtualMFADeviceInput struct { // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the same as the ARN. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: =,.@:/- // diff --git a/service/iam/api_op_DetachGroupPolicy.go b/service/iam/api_op_DetachGroupPolicy.go index ce2327f5c7d..dc2127721f3 100644 --- a/service/iam/api_op_DetachGroupPolicy.go +++ b/service/iam/api_op_DetachGroupPolicy.go @@ -12,9 +12,8 @@ import ( // Removes the specified managed policy from the specified IAM group. A group can // also have inline policies embedded with it. To delete an inline policy, use -// DeleteGroupPolicy. For information about policies, see Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// DeleteGroupPolicy . For information about policies, see Managed policies and +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolicyInput, optFns ...func(*Options)) (*DetachGroupPolicyOutput, error) { if params == nil { @@ -34,18 +33,17 @@ func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolic type DetachGroupPolicyInput struct { // The name (friendly name, not ARN) of the IAM group to detach the policy from. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. GroupName *string // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_DetachRolePolicy.go b/service/iam/api_op_DetachRolePolicy.go index 9dc884906c9..9ac157db0f7 100644 --- a/service/iam/api_op_DetachRolePolicy.go +++ b/service/iam/api_op_DetachRolePolicy.go @@ -12,9 +12,8 @@ import ( // Removes the specified managed policy from the specified role. A role can also // have inline policies embedded with it. To delete an inline policy, use -// DeleteRolePolicy. For information about policies, see Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// DeleteRolePolicy . For information about policies, see Managed policies and +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyInput, optFns ...func(*Options)) (*DetachRolePolicyOutput, error) { if params == nil { @@ -34,18 +33,17 @@ func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyI type DetachRolePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM role to detach the policy from. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string diff --git a/service/iam/api_op_DetachUserPolicy.go b/service/iam/api_op_DetachUserPolicy.go index 1ba5fec4ba5..d636b528488 100644 --- a/service/iam/api_op_DetachUserPolicy.go +++ b/service/iam/api_op_DetachUserPolicy.go @@ -12,9 +12,8 @@ import ( // Removes the specified managed policy from the specified user. A user can also // have inline policies embedded with it. To delete an inline policy, use -// DeleteUserPolicy. For information about policies, see Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// DeleteUserPolicy . For information about policies, see Managed policies and +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) DetachUserPolicy(ctx context.Context, params *DetachUserPolicyInput, optFns ...func(*Options)) (*DetachUserPolicyOutput, error) { if params == nil { @@ -34,18 +33,17 @@ func (c *Client) DetachUserPolicy(ctx context.Context, params *DetachUserPolicyI type DetachUserPolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to detach. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM user to detach the policy from. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_EnableMFADevice.go b/service/iam/api_op_EnableMFADevice.go index 82be891cd77..5775f583c19 100644 --- a/service/iam/api_op_EnableMFADevice.go +++ b/service/iam/api_op_EnableMFADevice.go @@ -30,14 +30,14 @@ func (c *Client) EnableMFADevice(ctx context.Context, params *EnableMFADeviceInp type EnableMFADeviceInput struct { - // An authentication code emitted by the device. The format for this parameter is a - // string of six digits. Submit your request immediately after generating the + // An authentication code emitted by the device. The format for this parameter is + // a string of six digits. Submit your request immediately after generating the // authentication codes. If you generate the codes and then wait too long to submit // the request, the MFA device successfully associates with the user but the MFA // device becomes out of sync. This happens because time-based one-time passwords // (TOTP) expire after a short period of time. If this happens, you can resync the - // device - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html). + // device (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html) + // . // // This member is required. AuthenticationCode1 *string @@ -48,15 +48,15 @@ type EnableMFADeviceInput struct { // long to submit the request, the MFA device successfully associates with the user // but the MFA device becomes out of sync. This happens because time-based one-time // passwords (TOTP) expire after a short period of time. If this happens, you can - // resync the device - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html). + // resync the device (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html) + // . // // This member is required. AuthenticationCode2 *string // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: =,.@:/- // @@ -64,8 +64,8 @@ type EnableMFADeviceInput struct { SerialNumber *string // The name of the IAM user for whom you want to enable the MFA device. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_GenerateCredentialReport.go b/service/iam/api_op_GenerateCredentialReport.go index d62f104f3cb..7c1814c1917 100644 --- a/service/iam/api_op_GenerateCredentialReport.go +++ b/service/iam/api_op_GenerateCredentialReport.go @@ -12,9 +12,8 @@ import ( ) // Generates a credential report for the Amazon Web Services account. For more -// information about the credential report, see Getting credential reports -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) in -// the IAM User Guide. +// information about the credential report, see Getting credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) +// in the IAM User Guide. func (c *Client) GenerateCredentialReport(ctx context.Context, params *GenerateCredentialReportInput, optFns ...func(*Options)) (*GenerateCredentialReportOutput, error) { if params == nil { params = &GenerateCredentialReportInput{} diff --git a/service/iam/api_op_GenerateOrganizationsAccessReport.go b/service/iam/api_op_GenerateOrganizationsAccessReport.go index 376ee3e1ed3..1bf664b5640 100644 --- a/service/iam/api_op_GenerateOrganizationsAccessReport.go +++ b/service/iam/api_op_GenerateOrganizationsAccessReport.go @@ -17,8 +17,7 @@ import ( // your long-term IAM user or root user credentials, or temporary credentials from // assuming an IAM role. SCPs must be enabled for your organization root. You must // have the required IAM and Organizations permissions. For more information, see -// Refining permissions using service last accessed data -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// Refining permissions using service last accessed data (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. You can generate a service last accessed data report for // entities by specifying only the entity's path. This data includes a list of // services that are allowed by any service control policies (SCPs) that apply to @@ -29,8 +28,7 @@ import ( // that the policy allows to account principals in the entity or the entity's // children. For important information about the data, reporting period, // permissions required, troubleshooting, and supported Regions see Reducing -// permissions using service last accessed data -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// permissions using service last accessed data (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. The data includes all attempts to access Amazon Web // Services, not just the successful ones. This includes all attempts that were // made using the Amazon Web Services Management Console, the Amazon Web Services @@ -39,86 +37,71 @@ import ( // compromised, because the request might have been denied. Refer to your // CloudTrail logs as the authoritative source for information about all API calls // and whether they were successful or denied access. For more information, see -// Logging IAM events with CloudTrail -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) -// in the IAM User Guide. This operation returns a JobId. Use this parameter in the -// GetOrganizationsAccessReport operation to check the status of the report +// Logging IAM events with CloudTrail (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) +// in the IAM User Guide. This operation returns a JobId . Use this parameter in +// the GetOrganizationsAccessReport operation to check the status of the report // generation. To check the status of this request, use the JobId parameter in the // GetOrganizationsAccessReport operation and test the JobStatus response // parameter. When the job is complete, you can retrieve the report. To generate a // service last accessed data report for entities, specify an entity path without // specifying the optional Organizations policy ID. The type of entity that you // specify determines the data returned in the report. +// - Root – When you specify the organizations root as the entity, the resulting +// report lists all of the services allowed by SCPs that are attached to your root. +// For each service, the report includes data for all accounts in your organization +// except the management account, because the management account is not limited by +// SCPs. +// - OU – When you specify an organizational unit (OU) as the entity, the +// resulting report lists all of the services allowed by SCPs that are attached to +// the OU and its parents. For each service, the report includes data for all +// accounts in the OU or its children. This data excludes the management account, +// because the management account is not limited by SCPs. +// - management account – When you specify the management account, the resulting +// report lists all Amazon Web Services services, because the management account is +// not limited by SCPs. For each service, the report includes data for only the +// management account. +// - Account – When you specify another account as the entity, the resulting +// report lists all of the services allowed by SCPs that are attached to the +// account and its parents. For each service, the report includes data for only the +// specified account. // -// * Root – When you specify -// the organizations root as the entity, the resulting report lists all of the -// services allowed by SCPs that are attached to your root. For each service, the -// report includes data for all accounts in your organization except the management -// account, because the management account is not limited by SCPs. -// -// * OU – When you -// specify an organizational unit (OU) as the entity, the resulting report lists -// all of the services allowed by SCPs that are attached to the OU and its parents. -// For each service, the report includes data for all accounts in the OU or its -// children. This data excludes the management account, because the management -// account is not limited by SCPs. -// -// * management account – When you specify the -// management account, the resulting report lists all Amazon Web Services services, -// because the management account is not limited by SCPs. For each service, the -// report includes data for only the management account. -// -// * Account – When you -// specify another account as the entity, the resulting report lists all of the -// services allowed by SCPs that are attached to the account and its parents. For -// each service, the report includes data for only the specified account. -// -// To -// generate a service last accessed data report for policies, specify an entity +// To generate a service last accessed data report for policies, specify an entity // path and the optional Organizations policy ID. The type of entity that you // specify determines the data returned for each service. +// - Root – When you specify the root entity and a policy ID, the resulting +// report lists all of the services that are allowed by the specified SCP. For each +// service, the report includes data for all accounts in your organization to which +// the SCP applies. This data excludes the management account, because the +// management account is not limited by SCPs. If the SCP is not attached to any +// entities in the organization, then the report will return a list of services +// with no data. +// - OU – When you specify an OU entity and a policy ID, the resulting report +// lists all of the services that are allowed by the specified SCP. For each +// service, the report includes data for all accounts in the OU or its children to +// which the SCP applies. This means that other accounts outside the OU that are +// affected by the SCP might not be included in the data. This data excludes the +// management account, because the management account is not limited by SCPs. If +// the SCP is not attached to the OU or one of its children, the report will return +// a list of services with no data. +// - management account – When you specify the management account, the resulting +// report lists all Amazon Web Services services, because the management account is +// not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is +// ignored. For each service, the report includes data for only the management +// account. +// - Account – When you specify another account entity and a policy ID, the +// resulting report lists all of the services that are allowed by the specified +// SCP. For each service, the report includes data for only the specified account. +// This means that other accounts in the organization that are affected by the SCP +// might not be included in the data. If the SCP is not attached to the account, +// the report will return a list of services with no data. // -// * Root – When you -// specify the root entity and a policy ID, the resulting report lists all of the -// services that are allowed by the specified SCP. For each service, the report -// includes data for all accounts in your organization to which the SCP applies. -// This data excludes the management account, because the management account is not -// limited by SCPs. If the SCP is not attached to any entities in the organization, -// then the report will return a list of services with no data. -// -// * OU – When you -// specify an OU entity and a policy ID, the resulting report lists all of the -// services that are allowed by the specified SCP. For each service, the report -// includes data for all accounts in the OU or its children to which the SCP -// applies. This means that other accounts outside the OU that are affected by the -// SCP might not be included in the data. This data excludes the management -// account, because the management account is not limited by SCPs. If the SCP is -// not attached to the OU or one of its children, the report will return a list of -// services with no data. -// -// * management account – When you specify the management -// account, the resulting report lists all Amazon Web Services services, because -// the management account is not limited by SCPs. If you specify a policy ID in the -// CLI or API, the policy is ignored. For each service, the report includes data -// for only the management account. -// -// * Account – When you specify another account -// entity and a policy ID, the resulting report lists all of the services that are -// allowed by the specified SCP. For each service, the report includes data for -// only the specified account. This means that other accounts in the organization -// that are affected by the SCP might not be included in the data. If the SCP is -// not attached to the account, the report will return a list of services with no -// data. -// -// Service last accessed data does not use other policy types when -// determining whether a principal could access a service. These other policy types -// include identity-based policies, resource-based policies, access control lists, -// IAM permissions boundaries, and STS assume role policies. It only applies SCP -// logic. For more about the evaluation of policy types, see Evaluating policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) +// Service last accessed data does not use other policy types when determining +// whether a principal could access a service. These other policy types include +// identity-based policies, resource-based policies, access control lists, IAM +// permissions boundaries, and STS assume role policies. It only applies SCP logic. +// For more about the evaluation of policy types, see Evaluating policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) // in the IAM User Guide. For more information about service last accessed data, -// see Reducing policy scope by viewing user activity -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// see Reducing policy scope by viewing user activity (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. func (c *Client) GenerateOrganizationsAccessReport(ctx context.Context, params *GenerateOrganizationsAccessReportInput, optFns ...func(*Options)) (*GenerateOrganizationsAccessReportOutput, error) { if params == nil { @@ -139,18 +122,18 @@ type GenerateOrganizationsAccessReportInput struct { // The path of the Organizations entity (root, OU, or account). You can build an // entity path using the known structure of your organization. For example, assume - // that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. + // that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde . // The organization root ID is r-f6g7h8i9j0example and your organization ID is - // o-a1b2c3d4e5. Your entity path is - // o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012. + // o-a1b2c3d4e5 . Your entity path is + // o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012 . // // This member is required. EntityPath *string - // The identifier of the Organizations service control policy (SCP). This parameter - // is optional. This ID is used to generate information about when an account - // principal that is limited by the SCP attempted to access an Amazon Web Services - // service. + // The identifier of the Organizations service control policy (SCP). This + // parameter is optional. This ID is used to generate information about when an + // account principal that is limited by the SCP attempted to access an Amazon Web + // Services service. OrganizationsPolicyId *string noSmithyDocumentSerde diff --git a/service/iam/api_op_GenerateServiceLastAccessedDetails.go b/service/iam/api_op_GenerateServiceLastAccessedDetails.go index df1c3ee2723..8d52f99ab90 100644 --- a/service/iam/api_op_GenerateServiceLastAccessedDetails.go +++ b/service/iam/api_op_GenerateServiceLastAccessedDetails.go @@ -16,9 +16,8 @@ import ( // Services services. Recent activity usually appears within four hours. IAM // reports activity for at least the last 400 days, or less if your Region began // supporting this feature within the last year. For more information, see Regions -// where data is tracked -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period). -// The service last accessed data includes all attempts to access an Amazon Web +// where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) +// . The service last accessed data includes all attempts to access an Amazon Web // Services API, not just the successful ones. This includes all attempts that were // made using the Amazon Web Services Management Console, the Amazon Web Services // API through any of the SDKs, or any of the command line tools. An unexpected @@ -26,39 +25,32 @@ import ( // compromised, because the request might have been denied. Refer to your // CloudTrail logs as the authoritative source for information about all API calls // and whether they were successful or denied access. For more information, see -// Logging IAM events with CloudTrail -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) +// Logging IAM events with CloudTrail (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) // in the IAM User Guide. The GenerateServiceLastAccessedDetails operation returns -// a JobId. Use this parameter in the following operations to retrieve the +// a JobId . Use this parameter in the following operations to retrieve the // following details from your report: +// - GetServiceLastAccessedDetails – Use this operation for users, groups, roles, +// or policies to list every Amazon Web Services service that the resource could +// access using permissions policies. For each service, the response includes +// information about the most recent access attempt. The JobId returned by +// GenerateServiceLastAccessedDetail must be used by the same role within a +// session, or by the same user when used to call GetServiceLastAccessedDetail . +// - GetServiceLastAccessedDetailsWithEntities – Use this operation for groups +// and policies to list information about the associated entities (users or roles) +// that attempted to access a specific Amazon Web Services service. // -// * GetServiceLastAccessedDetails – Use this -// operation for users, groups, roles, or policies to list every Amazon Web -// Services service that the resource could access using permissions policies. For -// each service, the response includes information about the most recent access -// attempt. The JobId returned by GenerateServiceLastAccessedDetail must be used by -// the same role within a session, or by the same user when used to call -// GetServiceLastAccessedDetail. -// -// * GetServiceLastAccessedDetailsWithEntities – Use -// this operation for groups and policies to list information about the associated -// entities (users or roles) that attempted to access a specific Amazon Web -// Services service. -// -// To check the status of the GenerateServiceLastAccessedDetails -// request, use the JobId parameter in the same operations and test the JobStatus -// response parameter. For additional information about the permissions policies -// that allow an identity (user, group, or role) to access specific services, use -// the ListPoliciesGrantingServiceAccess operation. Service last accessed data does -// not use other policy types when determining whether a resource could access a +// To check the status of the GenerateServiceLastAccessedDetails request, use the +// JobId parameter in the same operations and test the JobStatus response +// parameter. For additional information about the permissions policies that allow +// an identity (user, group, or role) to access specific services, use the +// ListPoliciesGrantingServiceAccess operation. Service last accessed data does not +// use other policy types when determining whether a resource could access a // service. These other policy types include resource-based policies, access // control lists, Organizations policies, IAM permissions boundaries, and STS // assume role policies. It only applies permissions policy logic. For more about -// the evaluation of policy types, see Evaluating policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) +// the evaluation of policy types, see Evaluating policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) // in the IAM User Guide. For more information about service and action last -// accessed data, see Reducing permissions using service last accessed data -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// accessed data, see Reducing permissions using service last accessed data (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. func (c *Client) GenerateServiceLastAccessedDetails(ctx context.Context, params *GenerateServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GenerateServiceLastAccessedDetailsOutput, error) { if params == nil { @@ -100,7 +92,7 @@ type GenerateServiceLastAccessedDetailsOutput struct { // The JobId that you can use in the GetServiceLastAccessedDetails or // GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by // GenerateServiceLastAccessedDetail must be used by the same role within a - // session, or by the same user when used to call GetServiceLastAccessedDetail. + // session, or by the same user when used to call GetServiceLastAccessedDetail . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_GetAccessKeyLastUsed.go b/service/iam/api_op_GetAccessKeyLastUsed.go index f8d6552e255..bfbda283525 100644 --- a/service/iam/api_op_GetAccessKeyLastUsed.go +++ b/service/iam/api_op_GetAccessKeyLastUsed.go @@ -33,7 +33,7 @@ func (c *Client) GetAccessKeyLastUsed(ctx context.Context, params *GetAccessKeyL type GetAccessKeyLastUsedInput struct { // The identifier of an access key. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters that can + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters that can // consist of any upper or lowercased letter or digit. // // This member is required. diff --git a/service/iam/api_op_GetAccountAuthorizationDetails.go b/service/iam/api_op_GetAccountAuthorizationDetails.go index 94134b39baa..4dd5a487ee9 100644 --- a/service/iam/api_op_GetAccountAuthorizationDetails.go +++ b/service/iam/api_op_GetAccountAuthorizationDetails.go @@ -16,13 +16,13 @@ import ( // Amazon Web Services account, including their relationships to one another. Use // this operation to obtain a snapshot of the configuration of IAM permissions // (users, groups, roles, and policies) in your account. Policies returned by this -// operation are URL-encoded compliant with RFC 3986 -// (https://tools.ietf.org/html/rfc3986). You can use a URL decoding method to -// convert the policy back to plain JSON text. For example, if you use Java, you -// can use the decode method of the java.net.URLDecoder utility class in the Java -// SDK. Other languages and SDKs provide similar functionality. You can optionally -// filter the results using the Filter parameter. You can paginate the results -// using the MaxItems and Marker parameters. +// operation are URL-encoded compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) +// . You can use a URL decoding method to convert the policy back to plain JSON +// text. For example, if you use Java, you can use the decode method of the +// java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs +// provide similar functionality. You can optionally filter the results using the +// Filter parameter. You can paginate the results using the MaxItems and Marker +// parameters. func (c *Client) GetAccountAuthorizationDetails(ctx context.Context, params *GetAccountAuthorizationDetailsInput, optFns ...func(*Options)) (*GetAccountAuthorizationDetailsOutput, error) { if params == nil { params = &GetAccountAuthorizationDetailsInput{} @@ -55,10 +55,10 @@ type GetAccountAuthorizationDetailsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -75,11 +75,11 @@ type GetAccountAuthorizationDetailsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -171,10 +171,10 @@ var _ GetAccountAuthorizationDetailsAPIClient = (*Client)(nil) type GetAccountAuthorizationDetailsPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_GetAccountPasswordPolicy.go b/service/iam/api_op_GetAccountPasswordPolicy.go index 0e1bb1d4527..25c92825df1 100644 --- a/service/iam/api_op_GetAccountPasswordPolicy.go +++ b/service/iam/api_op_GetAccountPasswordPolicy.go @@ -14,8 +14,8 @@ import ( // Retrieves the password policy for the Amazon Web Services account. This tells // you the complexity requirements and mandatory rotation periods for the IAM user // passwords in your account. For more information about using a password policy, -// see Managing an IAM password policy -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html). +// see Managing an IAM password policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html) +// . func (c *Client) GetAccountPasswordPolicy(ctx context.Context, params *GetAccountPasswordPolicyInput, optFns ...func(*Options)) (*GetAccountPasswordPolicyOutput, error) { if params == nil { params = &GetAccountPasswordPolicyInput{} diff --git a/service/iam/api_op_GetAccountSummary.go b/service/iam/api_op_GetAccountSummary.go index e3858cc3f56..270d19f8ae0 100644 --- a/service/iam/api_op_GetAccountSummary.go +++ b/service/iam/api_op_GetAccountSummary.go @@ -11,9 +11,8 @@ import ( ) // Retrieves information about IAM entity usage and IAM quotas in the Amazon Web -// Services account. For information about IAM quotas, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. +// Services account. For information about IAM quotas, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. func (c *Client) GetAccountSummary(ctx context.Context, params *GetAccountSummaryInput, optFns ...func(*Options)) (*GetAccountSummaryOutput, error) { if params == nil { params = &GetAccountSummaryInput{} diff --git a/service/iam/api_op_GetContextKeysForCustomPolicy.go b/service/iam/api_op_GetContextKeysForCustomPolicy.go index 8d27ab0d956..b7818badcdf 100644 --- a/service/iam/api_op_GetContextKeysForCustomPolicy.go +++ b/service/iam/api_op_GetContextKeysForCustomPolicy.go @@ -13,13 +13,13 @@ import ( // Gets a list of all of the context keys referenced in the input policies. The // policies are supplied as a list of one or more strings. To get the context keys // from policies associated with an IAM user, group, or role, use -// GetContextKeysForPrincipalPolicy. Context keys are variables maintained by +// GetContextKeysForPrincipalPolicy . Context keys are variables maintained by // Amazon Web Services and its services that provide details about the context of // an API query request. Context keys can be evaluated by testing against a value -// specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what -// key names and values you must supply when you call SimulateCustomPolicy. Note -// that all parameters are shown in unencoded form here for clarity but must be URL -// encoded to be included as a part of a real HTML request. +// specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand +// what key names and values you must supply when you call SimulateCustomPolicy . +// Note that all parameters are shown in unencoded form here for clarity but must +// be URL encoded to be included as a part of a real HTML request. func (c *Client) GetContextKeysForCustomPolicy(ctx context.Context, params *GetContextKeysForCustomPolicyInput, optFns ...func(*Options)) (*GetContextKeysForCustomPolicyOutput, error) { if params == nil { params = &GetContextKeysForCustomPolicyInput{} @@ -39,19 +39,15 @@ type GetContextKeysForCustomPolicyInput struct { // A list of policies for which you want the list of context keys referenced in // those policies. Each document is specified as a string containing the complete, - // valid JSON text of an IAM policy. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) + // valid JSON text of an IAM policy. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyInputList []string diff --git a/service/iam/api_op_GetContextKeysForPrincipalPolicy.go b/service/iam/api_op_GetContextKeysForPrincipalPolicy.go index d883335acb5..263689fdf8d 100644 --- a/service/iam/api_op_GetContextKeysForPrincipalPolicy.go +++ b/service/iam/api_op_GetContextKeysForPrincipalPolicy.go @@ -23,7 +23,7 @@ import ( // Amazon Web Services and its services that provide details about the context of // an API query request. Context keys can be evaluated by testing against a value // in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key -// names and values you must supply when you call SimulatePrincipalPolicy. +// names and values you must supply when you call SimulatePrincipalPolicy . func (c *Client) GetContextKeysForPrincipalPolicy(ctx context.Context, params *GetContextKeysForPrincipalPolicyInput, optFns ...func(*Options)) (*GetContextKeysForPrincipalPolicyOutput, error) { if params == nil { params = &GetContextKeysForPrincipalPolicyInput{} @@ -48,9 +48,8 @@ type GetContextKeysForPrincipalPolicyInput struct { // includes only those context keys that are found in policies attached to that // entity. Note that all parameters are shown in unencoded form here for clarity, // but must be URL encoded to be included as a part of a real HTML request. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicySourceArn *string @@ -59,16 +58,12 @@ type GetContextKeysForPrincipalPolicyInput struct { // keys that are referenced. The regex pattern (http://wikipedia.org/wiki/regex) // used to validate this parameter is a string of characters consisting of the // following: - // - // * Any printable ASCII character ranging from the space character - // (\u0020) through the end of the ASCII character range - // - // * The printable - // characters in the Basic Latin and Latin-1 Supplement character set (through - // \u00FF) - // - // * The special characters tab (\u0009), line feed (\u000A), and carriage - // return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) PolicyInputList []string noSmithyDocumentSerde diff --git a/service/iam/api_op_GetCredentialReport.go b/service/iam/api_op_GetCredentialReport.go index b8b66d7fa2a..b03979b871a 100644 --- a/service/iam/api_op_GetCredentialReport.go +++ b/service/iam/api_op_GetCredentialReport.go @@ -13,9 +13,8 @@ import ( ) // Retrieves a credential report for the Amazon Web Services account. For more -// information about the credential report, see Getting credential reports -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) in -// the IAM User Guide. +// information about the credential report, see Getting credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) +// in the IAM User Guide. func (c *Client) GetCredentialReport(ctx context.Context, params *GetCredentialReportInput, optFns ...func(*Options)) (*GetCredentialReportOutput, error) { if params == nil { params = &GetCredentialReportInput{} @@ -42,7 +41,7 @@ type GetCredentialReportOutput struct { Content []byte // The date and time when the credential report was created, in ISO 8601 date-time - // format (http://www.iso.org/iso/iso8601). + // format (http://www.iso.org/iso/iso8601) . GeneratedTime *time.Time // The format (MIME type) of the credential report. diff --git a/service/iam/api_op_GetGroup.go b/service/iam/api_op_GetGroup.go index 6db5553fd47..67a0a3b462c 100644 --- a/service/iam/api_op_GetGroup.go +++ b/service/iam/api_op_GetGroup.go @@ -31,10 +31,10 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { - // The name of the group. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the group. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. GroupName *string @@ -47,10 +47,10 @@ type GetGroupInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -74,11 +74,11 @@ type GetGroupOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -162,10 +162,10 @@ var _ GetGroupAPIClient = (*Client)(nil) type GetGroupPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_GetGroupPolicy.go b/service/iam/api_op_GetGroupPolicy.go index 9683633b6c1..ab219f1f7a3 100644 --- a/service/iam/api_op_GetGroupPolicy.go +++ b/service/iam/api_op_GetGroupPolicy.go @@ -10,18 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified inline policy document that is embedded in the specified -// IAM group. Policies returned by this operation are URL-encoded compliant with -// RFC 3986 (https://tools.ietf.org/html/rfc3986). You can use a URL decoding -// method to convert the policy back to plain JSON text. For example, if you use -// Java, you can use the decode method of the java.net.URLDecoder utility class in -// the Java SDK. Other languages and SDKs provide similar functionality. An IAM -// group can also have managed policies attached to it. To retrieve a managed -// policy document that is attached to a group, use GetPolicy to determine the -// policy's default version, then use GetPolicyVersion to retrieve the policy -// document. For more information about policies, see Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// Retrieves the specified inline policy document that is embedded in the +// specified IAM group. Policies returned by this operation are URL-encoded +// compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) . You can use a +// URL decoding method to convert the policy back to plain JSON text. For example, +// if you use Java, you can use the decode method of the java.net.URLDecoder +// utility class in the Java SDK. Other languages and SDKs provide similar +// functionality. An IAM group can also have managed policies attached to it. To +// retrieve a managed policy document that is attached to a group, use GetPolicy +// to determine the policy's default version, then use GetPolicyVersion to +// retrieve the policy document. For more information about policies, see Managed +// policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput, optFns ...func(*Options)) (*GetGroupPolicyOutput, error) { if params == nil { @@ -41,17 +40,17 @@ func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput type GetGroupPolicyInput struct { // The name of the group the policy is associated with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. GroupName *string - // The name of the policy document to get. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document to get. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- // // This member is required. PolicyName *string @@ -67,8 +66,8 @@ type GetGroupPolicyOutput struct { // This member is required. GroupName *string - // The policy document. IAM stores policies in JSON format. However, resources that - // were created using CloudFormation templates can be formatted in YAML. + // The policy document. IAM stores policies in JSON format. However, resources + // that were created using CloudFormation templates can be formatted in YAML. // CloudFormation always converts a YAML policy to JSON format before submitting it // to IAM. // diff --git a/service/iam/api_op_GetInstanceProfile.go b/service/iam/api_op_GetInstanceProfile.go index d0cfd113f04..60ff96ee032 100644 --- a/service/iam/api_op_GetInstanceProfile.go +++ b/service/iam/api_op_GetInstanceProfile.go @@ -18,9 +18,8 @@ import ( // Retrieves information about the specified instance profile, including the // instance profile's path, GUID, ARN, and role. For more information about -// instance profiles, see About instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) in -// the IAM User Guide. +// instance profiles, see About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// in the IAM User Guide. func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProfileInput, optFns ...func(*Options)) (*GetInstanceProfileOutput, error) { if params == nil { params = &GetInstanceProfileInput{} @@ -38,9 +37,9 @@ func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProf type GetInstanceProfileInput struct { - // The name of the instance profile to get information about. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // The name of the instance profile to get information about. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -148,9 +147,10 @@ type InstanceProfileExistsWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceProfileExistsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceProfileExistsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/iam/api_op_GetLoginProfile.go b/service/iam/api_op_GetLoginProfile.go index 2186c9ec4d0..f5a54a1b58c 100644 --- a/service/iam/api_op_GetLoginProfile.go +++ b/service/iam/api_op_GetLoginProfile.go @@ -14,7 +14,7 @@ import ( // Retrieves the user name for the specified IAM user. A login profile is created // when you create a password for the user to access the Amazon Web Services // Management Console. If the user does not exist or does not have a password, the -// operation returns a 404 (NoSuchEntity) error. If you create an IAM user with +// operation returns a 404 ( NoSuchEntity ) error. If you create an IAM user with // access to the console, the CreateDate reflects the date you created the initial // password for the user. If you create an IAM user with programmatic access, and // then later add a password for the user to access the Amazon Web Services @@ -39,8 +39,8 @@ func (c *Client) GetLoginProfile(ctx context.Context, params *GetLoginProfileInp type GetLoginProfileInput struct { // The name of the user whose login profile you want to retrieve. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_GetOpenIDConnectProvider.go b/service/iam/api_op_GetOpenIDConnectProvider.go index fd0b79dc28a..e0c14e79569 100644 --- a/service/iam/api_op_GetOpenIDConnectProvider.go +++ b/service/iam/api_op_GetOpenIDConnectProvider.go @@ -34,9 +34,8 @@ type GetOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to // get information for. You can get a list of OIDC provider resource ARNs by using // the ListOpenIDConnectProviders operation. For more information about ARNs, see - // Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. OpenIDConnectProviderArn *string @@ -49,7 +48,7 @@ type GetOpenIDConnectProviderOutput struct { // A list of client IDs (also known as audiences) that are associated with the // specified IAM OIDC provider resource object. For more information, see - // CreateOpenIDConnectProvider. + // CreateOpenIDConnectProvider . ClientIDList []string // The date and time when the IAM OIDC provider resource object was created in the @@ -58,18 +57,17 @@ type GetOpenIDConnectProviderOutput struct { // A list of tags that are attached to the specified IAM OIDC provider. The // returned list of tags is sorted by tag key. For more information about tagging, - // see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []types.Tag // A list of certificate thumbprints that are associated with the specified IAM // OIDC provider resource object. For more information, see - // CreateOpenIDConnectProvider. + // CreateOpenIDConnectProvider . ThumbprintList []string // The URL that the IAM OIDC provider resource object is associated with. For more - // information, see CreateOpenIDConnectProvider. + // information, see CreateOpenIDConnectProvider . Url *string // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_GetOrganizationsAccessReport.go b/service/iam/api_op_GetOrganizationsAccessReport.go index 3a200ca3a5a..25be6e78809 100644 --- a/service/iam/api_op_GetOrganizationsAccessReport.go +++ b/service/iam/api_op_GetOrganizationsAccessReport.go @@ -13,15 +13,14 @@ import ( ) // Retrieves the service last accessed data report for Organizations that was -// previously generated using the GenerateOrganizationsAccessReport operation. This -// operation retrieves the status of your report job and the report contents. +// previously generated using the GenerateOrganizationsAccessReport operation. +// This operation retrieves the status of your report job and the report contents. // Depending on the parameters that you passed when you generated the report, the // data returned could include different information. For details, see -// GenerateOrganizationsAccessReport. To call this operation, you must be signed in -// to the management account in your organization. SCPs must be enabled for your +// GenerateOrganizationsAccessReport . To call this operation, you must be signed +// in to the management account in your organization. SCPs must be enabled for your // organization root. You must have permissions to perform this operation. For more -// information, see Refining permissions using service last accessed data -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// information, see Refining permissions using service last accessed data (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. For each service that principals in an account (root // user, IAM users, or IAM roles) could access using SCPs, the operation returns // details about the most recent access attempt. If there was no attempt, the @@ -59,10 +58,10 @@ type GetOrganizationsAccessReportInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -76,8 +75,8 @@ type GetOrganizationsAccessReportInput struct { type GetOrganizationsAccessReportOutput struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the report job was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the report job was created. // // This member is required. JobCreationDate *time.Time @@ -92,8 +91,8 @@ type GetOrganizationsAccessReportOutput struct { AccessDetails []types.AccessDetail // Contains information about the reason that the operation failed. This data type - // is used as a response element in the GetOrganizationsAccessReport, - // GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities + // is used as a response element in the GetOrganizationsAccessReport , + // GetServiceLastAccessedDetails , and GetServiceLastAccessedDetailsWithEntities // operations. ErrorDetails *types.ErrorDetails @@ -101,17 +100,16 @@ type GetOrganizationsAccessReportOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the generated report job was completed or - // failed. This field is null if the job is still in progress, as indicated by a - // job status value of IN_PROGRESS. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the generated report job was completed or failed. This field is null if + // the job is still in progress, as indicated by a job status value of IN_PROGRESS . JobCompletionDate *time.Time - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_GetPolicy.go b/service/iam/api_op_GetPolicy.go index f181ca895f9..3ce8ba77a2a 100644 --- a/service/iam/api_op_GetPolicy.go +++ b/service/iam/api_op_GetPolicy.go @@ -17,17 +17,16 @@ import ( "time" ) -// Retrieves information about the specified managed policy, including the policy's -// default version and the total number of IAM users, groups, and roles to which -// the policy is attached. To retrieve the list of the specific users, groups, and -// roles that the policy is attached to, use ListEntitiesForPolicy. This operation -// returns metadata about the policy. To retrieve the actual policy document for a -// specific version of the policy, use GetPolicyVersion. This operation retrieves -// information about managed policies. To retrieve information about an inline -// policy that is embedded with an IAM user, group, or role, use GetUserPolicy, -// GetGroupPolicy, or GetRolePolicy. For more information about policies, see -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// Retrieves information about the specified managed policy, including the +// policy's default version and the total number of IAM users, groups, and roles to +// which the policy is attached. To retrieve the list of the specific users, +// groups, and roles that the policy is attached to, use ListEntitiesForPolicy . +// This operation returns metadata about the policy. To retrieve the actual policy +// document for a specific version of the policy, use GetPolicyVersion . This +// operation retrieves information about managed policies. To retrieve information +// about an inline policy that is embedded with an IAM user, group, or role, use +// GetUserPolicy , GetGroupPolicy , or GetRolePolicy . For more information about +// policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { @@ -47,9 +46,8 @@ func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns . type GetPolicyInput struct { // The Amazon Resource Name (ARN) of the managed policy that you want information - // about. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // about. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string @@ -152,9 +150,9 @@ type PolicyExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, PolicyExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, PolicyExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/iam/api_op_GetPolicyVersion.go b/service/iam/api_op_GetPolicyVersion.go index 6cf3a1b2a53..52f9bb042a1 100644 --- a/service/iam/api_op_GetPolicyVersion.go +++ b/service/iam/api_op_GetPolicyVersion.go @@ -13,20 +13,18 @@ import ( // Retrieves information about the specified version of the specified managed // policy, including the policy document. Policies returned by this operation are -// URL-encoded compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986). You +// URL-encoded compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) . You // can use a URL decoding method to convert the policy back to plain JSON text. For // example, if you use Java, you can use the decode method of the // java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs // provide similar functionality. To list the available versions for a policy, use -// ListPolicyVersions. This operation retrieves information about managed policies. -// To retrieve information about an inline policy that is embedded in a user, -// group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy. For more -// information about the types of policies, see Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// ListPolicyVersions . This operation retrieves information about managed +// policies. To retrieve information about an inline policy that is embedded in a +// user, group, or role, use GetUserPolicy , GetGroupPolicy , or GetRolePolicy . +// For more information about the types of policies, see Managed policies and +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. For more information about managed policy versions, see -// Versioning for managed policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) +// Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error) { if params == nil { @@ -46,15 +44,14 @@ func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionI type GetPolicyVersionInput struct { // The Amazon Resource Name (ARN) of the managed policy that you want information - // about. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // about. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // Identifies the policy version to retrieve. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters that // consists of the lowercase letter 'v' followed by one or two digits, and // optionally followed by a period '.' and a string of letters and digits. // diff --git a/service/iam/api_op_GetRole.go b/service/iam/api_op_GetRole.go index 533cce2b243..cf998644937 100644 --- a/service/iam/api_op_GetRole.go +++ b/service/iam/api_op_GetRole.go @@ -17,15 +17,14 @@ import ( "time" ) -// Retrieves information about the specified role, including the role's path, GUID, -// ARN, and the role's trust policy that grants permission to assume the role. For -// more information about roles, see Working with roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). -// Policies returned by this operation are URL-encoded compliant with RFC 3986 -// (https://tools.ietf.org/html/rfc3986). You can use a URL decoding method to -// convert the policy back to plain JSON text. For example, if you use Java, you -// can use the decode method of the java.net.URLDecoder utility class in the Java -// SDK. Other languages and SDKs provide similar functionality. +// Retrieves information about the specified role, including the role's path, +// GUID, ARN, and the role's trust policy that grants permission to assume the +// role. For more information about roles, see Working with roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) +// . Policies returned by this operation are URL-encoded compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) +// . You can use a URL decoding method to convert the policy back to plain JSON +// text. For example, if you use Java, you can use the decode method of the +// java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs +// provide similar functionality. func (c *Client) GetRole(ctx context.Context, params *GetRoleInput, optFns ...func(*Options)) (*GetRoleOutput, error) { if params == nil { params = &GetRoleInput{} @@ -44,7 +43,7 @@ func (c *Client) GetRole(ctx context.Context, params *GetRoleInput, optFns ...fu type GetRoleInput struct { // The name of the IAM role to get information about. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -151,9 +150,9 @@ type RoleExistsWaiterOptions struct { // must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RoleExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RoleExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/iam/api_op_GetRolePolicy.go b/service/iam/api_op_GetRolePolicy.go index 6e3d4bb91e8..58da316c10f 100644 --- a/service/iam/api_op_GetRolePolicy.go +++ b/service/iam/api_op_GetRolePolicy.go @@ -12,19 +12,18 @@ import ( // Retrieves the specified inline policy document that is embedded with the // specified IAM role. Policies returned by this operation are URL-encoded -// compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986). You can use a URL -// decoding method to convert the policy back to plain JSON text. For example, if -// you use Java, you can use the decode method of the java.net.URLDecoder utility -// class in the Java SDK. Other languages and SDKs provide similar functionality. -// An IAM role can also have managed policies attached to it. To retrieve a managed -// policy document that is attached to a role, use GetPolicy to determine the -// policy's default version, then use GetPolicyVersion to retrieve the policy -// document. For more information about policies, see Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) . You can use a +// URL decoding method to convert the policy back to plain JSON text. For example, +// if you use Java, you can use the decode method of the java.net.URLDecoder +// utility class in the Java SDK. Other languages and SDKs provide similar +// functionality. An IAM role can also have managed policies attached to it. To +// retrieve a managed policy document that is attached to a role, use GetPolicy to +// determine the policy's default version, then use GetPolicyVersion to retrieve +// the policy document. For more information about policies, see Managed policies +// and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. For more information about roles, see Using roles to -// delegate permissions and federate identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). +// delegate permissions and federate identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) +// . func (c *Client) GetRolePolicy(ctx context.Context, params *GetRolePolicyInput, optFns ...func(*Options)) (*GetRolePolicyOutput, error) { if params == nil { params = &GetRolePolicyInput{} @@ -42,16 +41,16 @@ func (c *Client) GetRolePolicy(ctx context.Context, params *GetRolePolicyInput, type GetRolePolicyInput struct { - // The name of the policy document to get. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document to get. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- // // This member is required. PolicyName *string // The name of the role associated with the policy. This parameter allows (through - // its regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // its regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -64,8 +63,8 @@ type GetRolePolicyInput struct { // Contains the response to a successful GetRolePolicy request. type GetRolePolicyOutput struct { - // The policy document. IAM stores policies in JSON format. However, resources that - // were created using CloudFormation templates can be formatted in YAML. + // The policy document. IAM stores policies in JSON format. However, resources + // that were created using CloudFormation templates can be formatted in YAML. // CloudFormation always converts a YAML policy to JSON format before submitting it // to IAM. // diff --git a/service/iam/api_op_GetSAMLProvider.go b/service/iam/api_op_GetSAMLProvider.go index 8c5be45a7eb..4f76de93ae7 100644 --- a/service/iam/api_op_GetSAMLProvider.go +++ b/service/iam/api_op_GetSAMLProvider.go @@ -14,8 +14,8 @@ import ( // Returns the SAML provider metadocument that was uploaded when the IAM SAML // provider resource object was created or updated. This operation requires -// Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) GetSAMLProvider(ctx context.Context, params *GetSAMLProviderInput, optFns ...func(*Options)) (*GetSAMLProviderOutput, error) { if params == nil { params = &GetSAMLProviderInput{} @@ -35,9 +35,8 @@ type GetSAMLProviderInput struct { // The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to // get information about. For more information about ARNs, see Amazon Resource - // Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. SAMLProviderArn *string @@ -56,9 +55,8 @@ type GetSAMLProviderOutput struct { // A list of tags that are attached to the specified IAM SAML provider. The // returned list of tags is sorted by tag key. For more information about tagging, - // see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []types.Tag // The expiration date and time for the SAML provider. diff --git a/service/iam/api_op_GetSSHPublicKey.go b/service/iam/api_op_GetSSHPublicKey.go index bbd03cec3c7..86c77289842 100644 --- a/service/iam/api_op_GetSSHPublicKey.go +++ b/service/iam/api_op_GetSSHPublicKey.go @@ -15,8 +15,7 @@ import ( // SSH public key retrieved by this operation is used only for authenticating the // associated IAM user to an CodeCommit repository. For more information about // using SSH keys to authenticate to an CodeCommit repository, see Set up -// CodeCommit for SSH connections -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) +// CodeCommit for SSH connections (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) // in the CodeCommit User Guide. func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInput, optFns ...func(*Options)) (*GetSSHPublicKeyOutput, error) { if params == nil { @@ -35,23 +34,23 @@ func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInp type GetSSHPublicKeyInput struct { - // Specifies the public key encoding format to use in the response. To retrieve the - // public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, - // use PEM. + // Specifies the public key encoding format to use in the response. To retrieve + // the public key in ssh-rsa format, use SSH . To retrieve the public key in PEM + // format, use PEM . // // This member is required. Encoding types.EncodingType - // The unique identifier for the SSH public key. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can - // consist of any upper or lowercased letter or digit. + // The unique identifier for the SSH public key. This parameter allows (through + // its regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // that can consist of any upper or lowercased letter or digit. // // This member is required. SSHPublicKeyId *string // The name of the IAM user associated with the SSH public key. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_GetServerCertificate.go b/service/iam/api_op_GetServerCertificate.go index 5b40e926b57..9511a6e315d 100644 --- a/service/iam/api_op_GetServerCertificate.go +++ b/service/iam/api_op_GetServerCertificate.go @@ -12,9 +12,8 @@ import ( ) // Retrieves information about the specified server certificate stored in IAM. For -// more information about working with server certificates, see Working with server -// certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// more information about working with server certificates, see Working with +// server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. This topic includes a list of Amazon Web Services // services that can use the server certificates that you manage with IAM. func (c *Client) GetServerCertificate(ctx context.Context, params *GetServerCertificateInput, optFns ...func(*Options)) (*GetServerCertificateOutput, error) { @@ -35,8 +34,8 @@ func (c *Client) GetServerCertificate(ctx context.Context, params *GetServerCert type GetServerCertificateInput struct { // The name of the server certificate you want to retrieve information about. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_GetServiceLastAccessedDetails.go b/service/iam/api_op_GetServiceLastAccessedDetails.go index 86de092eccf..308eda793fa 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetails.go +++ b/service/iam/api_op_GetServiceLastAccessedDetails.go @@ -13,17 +13,16 @@ import ( ) // Retrieves a service last accessed report that was created using the -// GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in -// GetServiceLastAccessedDetails to retrieve the status of your report job. When -// the report is complete, you can retrieve the generated report. The report +// GenerateServiceLastAccessedDetails operation. You can use the JobId parameter +// in GetServiceLastAccessedDetails to retrieve the status of your report job. +// When the report is complete, you can retrieve the generated report. The report // includes a list of Amazon Web Services services that the resource (user, group, // role, or managed policy) can access. Service last accessed data does not use // other policy types when determining whether a resource could access a service. // These other policy types include resource-based policies, access control lists, // Organizations policies, IAM permissions boundaries, and STS assume role // policies. It only applies permissions policy logic. For more about the -// evaluation of policy types, see Evaluating policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) +// evaluation of policy types, see Evaluating policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) // in the IAM User Guide. For each service that the resource could access using // permissions policies, the operation returns details about the most recent access // attempt. If there was no attempt, the service is listed without details about @@ -33,28 +32,19 @@ import ( // includes the number of entities that have attempted to access the service and // the date and time of the last attempt. It also returns the ARN of the following // entity, depending on the resource ARN that you used to generate the report: +// - User – Returns the user ARN that you used to generate the report +// - Group – Returns the ARN of the group member (user) that last attempted to +// access the service +// - Role – Returns the role ARN that you used to generate the report +// - Policy – Returns the ARN of the user or role that last used the policy to +// attempt to access the service // -// * -// User – Returns the user ARN that you used to generate the report -// -// * Group – -// Returns the ARN of the group member (user) that last attempted to access the -// service -// -// * Role – Returns the role ARN that you used to generate the report -// -// * -// Policy – Returns the ARN of the user or role that last used the policy to -// attempt to access the service -// -// By default, the list is sorted by service -// namespace. If you specified ACTION_LEVEL granularity when you generated the -// report, this operation returns service and action last accessed data. This -// includes the most recent access attempt for each tracked action within a -// service. Otherwise, this operation returns only service data. For more -// information about service and action last accessed data, see Reducing -// permissions using service last accessed data -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) +// By default, the list is sorted by service namespace. If you specified +// ACTION_LEVEL granularity when you generated the report, this operation returns +// service and action last accessed data. This includes the most recent access +// attempt for each tracked action within a service. Otherwise, this operation +// returns only service data. For more information about service and action last +// accessed data, see Reducing permissions using service last accessed data (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html) // in the IAM User Guide. func (c *Client) GetServiceLastAccessedDetails(ctx context.Context, params *GetServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GetServiceLastAccessedDetailsOutput, error) { if params == nil { @@ -76,7 +66,7 @@ type GetServiceLastAccessedDetailsInput struct { // The ID of the request generated by the GenerateServiceLastAccessedDetails // operation. The JobId returned by GenerateServiceLastAccessedDetail must be used // by the same role within a session, or by the same user when used to call - // GetServiceLastAccessedDetail. + // GetServiceLastAccessedDetail . // // This member is required. JobId *string @@ -89,10 +79,10 @@ type GetServiceLastAccessedDetailsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -101,16 +91,15 @@ type GetServiceLastAccessedDetailsInput struct { type GetServiceLastAccessedDetailsOutput struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the generated report job was completed or - // failed. This field is null if the job is still in progress, as indicated by a - // job status value of IN_PROGRESS. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the generated report job was completed or failed. This field is null if + // the job is still in progress, as indicated by a job status value of IN_PROGRESS . // // This member is required. JobCompletionDate *time.Time - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the report job was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the report job was created. // // This member is required. JobCreationDate *time.Time @@ -120,8 +109,8 @@ type GetServiceLastAccessedDetailsOutput struct { // This member is required. JobStatus types.JobStatusType - // A ServiceLastAccessed object that contains details about the most recent attempt - // to access the service. + // A ServiceLastAccessed object that contains details about the most recent + // attempt to access the service. // // This member is required. ServicesLastAccessed []types.ServiceLastAccessed @@ -133,8 +122,8 @@ type GetServiceLastAccessedDetailsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool // The type of job. Service jobs return information about when each service was @@ -142,7 +131,7 @@ type GetServiceLastAccessedDetailsOutput struct { // within the service were last accessed. JobType types.AccessAdvisorUsageGranularityType - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go index 93edc13bc58..81ed7bd5ab1 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go +++ b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go @@ -13,24 +13,22 @@ import ( ) // After you generate a group or policy report using the -// GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in -// GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status -// of your report job and a list of entities that could have used group or policy -// permissions to access the specified service. +// GenerateServiceLastAccessedDetails operation, you can use the JobId parameter +// in GetServiceLastAccessedDetailsWithEntities . This operation retrieves the +// status of your report job and a list of entities that could have used group or +// policy permissions to access the specified service. +// - Group – For a group report, this operation returns a list of users in the +// group that could have used the group’s policies in an attempt to access the +// service. +// - Policy – For a policy report, this operation returns a list of entities +// (users or roles) that could have used the policy in an attempt to access the +// service. // -// * Group – For a group report, this -// operation returns a list of users in the group that could have used the group’s -// policies in an attempt to access the service. -// -// * Policy – For a policy report, -// this operation returns a list of entities (users or roles) that could have used -// the policy in an attempt to access the service. -// -// You can also use this operation -// for user or role reports to retrieve details about those entities. If the -// operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns -// the reason that it failed. By default, the list of associated entities is sorted -// by date, with the most recent access listed first. +// You can also use this operation for user or role reports to retrieve details +// about those entities. If the operation fails, the +// GetServiceLastAccessedDetailsWithEntities operation returns the reason that it +// failed. By default, the list of associated entities is sorted by date, with the +// most recent access listed first. func (c *Client) GetServiceLastAccessedDetailsWithEntities(ctx context.Context, params *GetServiceLastAccessedDetailsWithEntitiesInput, optFns ...func(*Options)) (*GetServiceLastAccessedDetailsWithEntitiesOutput, error) { if params == nil { params = &GetServiceLastAccessedDetailsWithEntitiesInput{} @@ -57,13 +55,11 @@ type GetServiceLastAccessedDetailsWithEntitiesInput struct { // The service namespace for an Amazon Web Services service. Provide the service // namespace to learn when the IAM entity last attempted to access the specified // service. To learn the service namespace for a service, see Actions, resources, - // and condition keys for Amazon Web Services services - // (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) + // and condition keys for Amazon Web Services services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) // in the IAM User Guide. Choose the name of the service to view details for that // service. In the first paragraph, find the service prefix. For example, (service - // prefix: a4b). For more information about service namespaces, see Amazon Web - // Services service namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // prefix: a4b) . For more information about service namespaces, see Amazon Web + // Services service namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // This member is required. @@ -77,10 +73,10 @@ type GetServiceLastAccessedDetailsWithEntitiesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -89,23 +85,22 @@ type GetServiceLastAccessedDetailsWithEntitiesInput struct { type GetServiceLastAccessedDetailsWithEntitiesOutput struct { - // An EntityDetailsList object that contains details about when an IAM entity (user - // or role) used group or policy permissions in an attempt to access the specified - // Amazon Web Services service. + // An EntityDetailsList object that contains details about when an IAM entity + // (user or role) used group or policy permissions in an attempt to access the + // specified Amazon Web Services service. // // This member is required. EntityDetailsList []types.EntityDetails - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the generated report job was completed or - // failed. This field is null if the job is still in progress, as indicated by a - // job status value of IN_PROGRESS. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the generated report job was completed or failed. This field is null if + // the job is still in progress, as indicated by a job status value of IN_PROGRESS . // // This member is required. JobCompletionDate *time.Time - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the report job was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the report job was created. // // This member is required. JobCreationDate *time.Time @@ -122,11 +117,11 @@ type GetServiceLastAccessedDetailsWithEntitiesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go index 7efbc8bfc4d..8d1bf0de73f 100644 --- a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go +++ b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go @@ -34,7 +34,7 @@ func (c *Client) GetServiceLinkedRoleDeletionStatus(ctx context.Context, params type GetServiceLinkedRoleDeletionStatusInput struct { // The deletion task identifier. This identifier is returned by the - // DeleteServiceLinkedRole operation in the format task/aws-service-role///. + // DeleteServiceLinkedRole operation in the format task/aws-service-role/// . // // This member is required. DeletionTaskId *string diff --git a/service/iam/api_op_GetUser.go b/service/iam/api_op_GetUser.go index 02f93e5288a..11882c13fe8 100644 --- a/service/iam/api_op_GetUser.go +++ b/service/iam/api_op_GetUser.go @@ -38,10 +38,10 @@ func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...fu type GetUserInput struct { - // The name of the user to get information about. This parameter is optional. If it - // is not included, it defaults to the user making the request. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // The name of the user to get information about. This parameter is optional. If + // it is not included, it defaults to the user making the request. This parameter + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string @@ -53,13 +53,11 @@ type GetUserOutput struct { // A structure containing details about the IAM user. Due to a service issue, // password last used data does not include password use from May 3, 2018 22:50 PDT - // to May 23, 2018 14:08 PDT. This affects last sign-in - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html) + // to May 23, 2018 14:08 PDT. This affects last sign-in (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html) // dates shown in the IAM console and password last used dates in the IAM - // credential report - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html), - // and returned by this operation. If users signed in during the affected time, the - // password last used date that is returned is the date the user last signed in + // credential report (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) + // , and returned by this operation. If users signed in during the affected time, + // the password last used date that is returned is the date the user last signed in // before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the // returned password last used date is accurate. You can use password last used // information to identify unused credentials for deletion. For example, you might @@ -158,9 +156,9 @@ type UserExistsWaiterOptions struct { // must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, UserExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, UserExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/iam/api_op_GetUserPolicy.go b/service/iam/api_op_GetUserPolicy.go index e86993657d5..81a72a8a1b4 100644 --- a/service/iam/api_op_GetUserPolicy.go +++ b/service/iam/api_op_GetUserPolicy.go @@ -10,17 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified inline policy document that is embedded in the specified -// IAM user. Policies returned by this operation are URL-encoded compliant with RFC -// 3986 (https://tools.ietf.org/html/rfc3986). You can use a URL decoding method to -// convert the policy back to plain JSON text. For example, if you use Java, you -// can use the decode method of the java.net.URLDecoder utility class in the Java -// SDK. Other languages and SDKs provide similar functionality. An IAM user can -// also have managed policies attached to it. To retrieve a managed policy document -// that is attached to a user, use GetPolicy to determine the policy's default -// version. Then use GetPolicyVersion to retrieve the policy document. For more -// information about policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// Retrieves the specified inline policy document that is embedded in the +// specified IAM user. Policies returned by this operation are URL-encoded +// compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) . You can use a +// URL decoding method to convert the policy back to plain JSON text. For example, +// if you use Java, you can use the decode method of the java.net.URLDecoder +// utility class in the Java SDK. Other languages and SDKs provide similar +// functionality. An IAM user can also have managed policies attached to it. To +// retrieve a managed policy document that is attached to a user, use GetPolicy to +// determine the policy's default version. Then use GetPolicyVersion to retrieve +// the policy document. For more information about policies, see Managed policies +// and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) GetUserPolicy(ctx context.Context, params *GetUserPolicyInput, optFns ...func(*Options)) (*GetUserPolicyOutput, error) { if params == nil { @@ -39,16 +39,16 @@ func (c *Client) GetUserPolicy(ctx context.Context, params *GetUserPolicyInput, type GetUserPolicyInput struct { - // The name of the policy document to get. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document to get. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- // // This member is required. PolicyName *string // The name of the user who the policy is associated with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -61,8 +61,8 @@ type GetUserPolicyInput struct { // Contains the response to a successful GetUserPolicy request. type GetUserPolicyOutput struct { - // The policy document. IAM stores policies in JSON format. However, resources that - // were created using CloudFormation templates can be formatted in YAML. + // The policy document. IAM stores policies in JSON format. However, resources + // that were created using CloudFormation templates can be formatted in YAML. // CloudFormation always converts a YAML policy to JSON format before submitting it // to IAM. // diff --git a/service/iam/api_op_ListAccessKeys.go b/service/iam/api_op_ListAccessKeys.go index 98431279564..73cb59c6766 100644 --- a/service/iam/api_op_ListAccessKeys.go +++ b/service/iam/api_op_ListAccessKeys.go @@ -49,17 +49,17 @@ type ListAccessKeysInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // The name of the user. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the user. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- UserName *string noSmithyDocumentSerde @@ -77,11 +77,11 @@ type ListAccessKeysOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -163,10 +163,10 @@ var _ ListAccessKeysAPIClient = (*Client)(nil) type ListAccessKeysPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListAccountAliases.go b/service/iam/api_op_ListAccountAliases.go index 9d5a90b7db3..4e26e3bfd72 100644 --- a/service/iam/api_op_ListAccountAliases.go +++ b/service/iam/api_op_ListAccountAliases.go @@ -13,9 +13,8 @@ import ( // Lists the account alias associated with the Amazon Web Services account (Note: // you can have only one). For information about using an Amazon Web Services -// account alias, see Using an alias for your Amazon Web Services account ID -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) in the IAM -// User Guide. +// account alias, see Using an alias for your Amazon Web Services account ID (https://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html) +// in the IAM User Guide. func (c *Client) ListAccountAliases(ctx context.Context, params *ListAccountAliasesInput, optFns ...func(*Options)) (*ListAccountAliasesOutput, error) { if params == nil { params = &ListAccountAliasesInput{} @@ -41,10 +40,10 @@ type ListAccountAliasesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -54,8 +53,8 @@ type ListAccountAliasesInput struct { // Contains the response to a successful ListAccountAliases request. type ListAccountAliasesOutput struct { - // A list of aliases associated with the account. Amazon Web Services supports only - // one alias per account. + // A list of aliases associated with the account. Amazon Web Services supports + // only one alias per account. // // This member is required. AccountAliases []string @@ -64,11 +63,11 @@ type ListAccountAliasesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -151,10 +150,10 @@ var _ ListAccountAliasesAPIClient = (*Client)(nil) type ListAccountAliasesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListAttachedGroupPolicies.go b/service/iam/api_op_ListAttachedGroupPolicies.go index b717c5d73e0..7e014873f52 100644 --- a/service/iam/api_op_ListAttachedGroupPolicies.go +++ b/service/iam/api_op_ListAttachedGroupPolicies.go @@ -14,9 +14,8 @@ import ( // Lists all managed policies that are attached to the specified IAM group. An IAM // group can also have inline policies embedded with it. To list the inline -// policies for a group, use ListGroupPolicies. For information about policies, see -// Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policies for a group, use ListGroupPolicies . For information about policies, +// see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. You can use the PathPrefix parameter to limit the list of // policies to only those matching the specified path prefix. If there are no @@ -40,10 +39,10 @@ func (c *Client) ListAttachedGroupPolicies(ctx context.Context, params *ListAtta type ListAttachedGroupPoliciesInput struct { // The name (friendly name, not ARN) of the group to list attached policies for. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. GroupName *string @@ -56,20 +55,20 @@ type ListAttachedGroupPoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of either a forward slash (/) by itself or a string + // that must begin and end with forward slashes. In addition, it can contain any + // ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -85,11 +84,11 @@ type ListAttachedGroupPoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -175,10 +174,10 @@ var _ ListAttachedGroupPoliciesAPIClient = (*Client)(nil) type ListAttachedGroupPoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListAttachedRolePolicies.go b/service/iam/api_op_ListAttachedRolePolicies.go index 23d9a576a84..fe03a9e0372 100644 --- a/service/iam/api_op_ListAttachedRolePolicies.go +++ b/service/iam/api_op_ListAttachedRolePolicies.go @@ -14,9 +14,8 @@ import ( // Lists all managed policies that are attached to the specified IAM role. An IAM // role can also have inline policies embedded with it. To list the inline policies -// for a role, use ListRolePolicies. For information about policies, see Managed -// policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// for a role, use ListRolePolicies . For information about policies, see Managed +// policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. You can use the PathPrefix parameter to limit the list of // policies to only those matching the specified path prefix. If there are no @@ -40,10 +39,10 @@ func (c *Client) ListAttachedRolePolicies(ctx context.Context, params *ListAttac type ListAttachedRolePoliciesInput struct { // The name (friendly name, not ARN) of the role to list attached policies for. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string @@ -56,20 +55,20 @@ type ListAttachedRolePoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of either a forward slash (/) by itself or a string + // that must begin and end with forward slashes. In addition, it can contain any + // ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -85,11 +84,11 @@ type ListAttachedRolePoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -175,10 +174,10 @@ var _ ListAttachedRolePoliciesAPIClient = (*Client)(nil) type ListAttachedRolePoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListAttachedUserPolicies.go b/service/iam/api_op_ListAttachedUserPolicies.go index 255bf51a0aa..b1779e060a5 100644 --- a/service/iam/api_op_ListAttachedUserPolicies.go +++ b/service/iam/api_op_ListAttachedUserPolicies.go @@ -14,9 +14,8 @@ import ( // Lists all managed policies that are attached to the specified IAM user. An IAM // user can also have inline policies embedded with it. To list the inline policies -// for a user, use ListUserPolicies. For information about policies, see Managed -// policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// for a user, use ListUserPolicies . For information about policies, see Managed +// policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. You can use the PathPrefix parameter to limit the list of // policies to only those matching the specified path prefix. If there are no @@ -40,10 +39,10 @@ func (c *Client) ListAttachedUserPolicies(ctx context.Context, params *ListAttac type ListAttachedUserPoliciesInput struct { // The name (friendly name, not ARN) of the user to list attached policies for. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string @@ -56,20 +55,20 @@ type ListAttachedUserPoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of either a forward slash (/) by itself or a string + // that must begin and end with forward slashes. In addition, it can contain any + // ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -85,11 +84,11 @@ type ListAttachedUserPoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -175,10 +174,10 @@ var _ ListAttachedUserPoliciesAPIClient = (*Client)(nil) type ListAttachedUserPoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListEntitiesForPolicy.go b/service/iam/api_op_ListEntitiesForPolicy.go index a00126c4fb3..fad6fadef91 100644 --- a/service/iam/api_op_ListEntitiesForPolicy.go +++ b/service/iam/api_op_ListEntitiesForPolicy.go @@ -16,8 +16,8 @@ import ( // attached to. You can use the optional EntityFilter parameter to limit the // results to a particular type of entity (users, groups, or roles). For example, // to list only the roles that are attached to the specified policy, set -// EntityFilter to Role. You can paginate the results using the MaxItems and Marker -// parameters. +// EntityFilter to Role . You can paginate the results using the MaxItems and +// Marker parameters. func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntitiesForPolicyInput, optFns ...func(*Options)) (*ListEntitiesForPolicyOutput, error) { if params == nil { params = &ListEntitiesForPolicyInput{} @@ -36,15 +36,14 @@ func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntities type ListEntitiesForPolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy for which you want the - // versions. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // versions. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The entity type to use for filtering the results. For example, when EntityFilter - // is Role, only the roles that are attached to the specified policy are returned. + // is Role , only the roles that are attached to the specified policy are returned. // This parameter is optional. If it is not included, all attached entities (users, // groups, and roles) are returned. The argument for this parameter must be one of // the valid values listed below. @@ -58,26 +57,26 @@ type ListEntitiesForPolicyInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all entities. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of either a forward slash (/) by itself or a string + // that must begin and end with forward slashes. In addition, it can contain any + // ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string // The policy usage method to use for filtering the results. To list only - // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only + // permissions policies, set PolicyUsageFilter to PermissionsPolicy . To list only // the policies used to set permissions boundaries, set the value to - // PermissionsBoundary. This parameter is optional. If it is not included, all + // PermissionsBoundary . This parameter is optional. If it is not included, all // policies are returned. PolicyUsageFilter types.PolicyUsageType @@ -91,11 +90,11 @@ type ListEntitiesForPolicyOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -190,10 +189,10 @@ var _ ListEntitiesForPolicyAPIClient = (*Client)(nil) type ListEntitiesForPolicyPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListGroupPolicies.go b/service/iam/api_op_ListGroupPolicies.go index fb27271aa7c..bed1d28b9fe 100644 --- a/service/iam/api_op_ListGroupPolicies.go +++ b/service/iam/api_op_ListGroupPolicies.go @@ -13,9 +13,8 @@ import ( // Lists the names of the inline policies that are embedded in the specified IAM // group. An IAM group can also have managed policies attached to it. To list the -// managed policies that are attached to a group, use ListAttachedGroupPolicies. -// For more information about policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// managed policies that are attached to a group, use ListAttachedGroupPolicies . +// For more information about policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. If there are no inline policies embedded with the specified // group, the operation returns an empty list. @@ -37,7 +36,7 @@ func (c *Client) ListGroupPolicies(ctx context.Context, params *ListGroupPolicie type ListGroupPoliciesInput struct { // The name of the group to list policies for. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -52,10 +51,10 @@ type ListGroupPoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -65,10 +64,10 @@ type ListGroupPoliciesInput struct { // Contains the response to a successful ListGroupPolicies request. type ListGroupPoliciesOutput struct { - // A list of policy names. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // A list of policy names. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. PolicyNames []string @@ -77,11 +76,11 @@ type ListGroupPoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -166,10 +165,10 @@ var _ ListGroupPoliciesAPIClient = (*Client)(nil) type ListGroupPoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListGroups.go b/service/iam/api_op_ListGroups.go index b56355fc403..de6a3e36b18 100644 --- a/service/iam/api_op_ListGroups.go +++ b/service/iam/api_op_ListGroups.go @@ -39,22 +39,22 @@ type ListGroupsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. For example, the prefix // /division_abc/subdivision_xyz/ gets all groups whose path starts with - // /division_abc/subdivision_xyz/. This parameter is optional. If it is not + // /division_abc/subdivision_xyz/ . This parameter is optional. If it is not // included, it defaults to a slash (/), listing all groups. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of either a forward slash (/) by itself or a string that // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // character from the ! ( \u0021 ) through the DEL character ( \u007F ), including + // most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -72,11 +72,11 @@ type ListGroupsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -157,10 +157,10 @@ var _ ListGroupsAPIClient = (*Client)(nil) type ListGroupsPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListGroupsForUser.go b/service/iam/api_op_ListGroupsForUser.go index 72593f40f0e..1d17d7adcc7 100644 --- a/service/iam/api_op_ListGroupsForUser.go +++ b/service/iam/api_op_ListGroupsForUser.go @@ -32,7 +32,7 @@ func (c *Client) ListGroupsForUser(ctx context.Context, params *ListGroupsForUse type ListGroupsForUserInput struct { // The name of the user to list groups for. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -47,10 +47,10 @@ type ListGroupsForUserInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -69,11 +69,11 @@ type ListGroupsForUserOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -158,10 +158,10 @@ var _ ListGroupsForUserAPIClient = (*Client)(nil) type ListGroupsForUserPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListInstanceProfileTags.go b/service/iam/api_op_ListInstanceProfileTags.go index 0fc99dd2b6b..96fc5062395 100644 --- a/service/iam/api_op_ListInstanceProfileTags.go +++ b/service/iam/api_op_ListInstanceProfileTags.go @@ -13,9 +13,8 @@ import ( // Lists the tags that are attached to the specified IAM instance profile. The // returned list of tags is sorted by tag key. For more information about tagging, -// see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) ListInstanceProfileTags(ctx context.Context, params *ListInstanceProfileTagsInput, optFns ...func(*Options)) (*ListInstanceProfileTagsOutput, error) { if params == nil { params = &ListInstanceProfileTagsInput{} @@ -34,8 +33,8 @@ func (c *Client) ListInstanceProfileTags(ctx context.Context, params *ListInstan type ListInstanceProfileTagsInput struct { // The name of the IAM instance profile whose tags you want to see. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -49,10 +48,10 @@ type ListInstanceProfileTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -72,11 +71,11 @@ type ListInstanceProfileTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListInstanceProfiles.go b/service/iam/api_op_ListInstanceProfiles.go index 39faaf0f43e..93c87933638 100644 --- a/service/iam/api_op_ListInstanceProfiles.go +++ b/service/iam/api_op_ListInstanceProfiles.go @@ -14,13 +14,12 @@ import ( // Lists the instance profiles that have the specified path prefix. If there are // none, the operation returns an empty list. For more information about instance -// profiles, see About instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html). -// IAM resource-listing operations return a subset of the available attributes for -// the resource. For example, this operation does not return tags, even though they -// are an attribute of the returned object. To view all of the information for an -// instance profile, see GetInstanceProfile. You can paginate the results using the -// MaxItems and Marker parameters. +// profiles, see About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// . IAM resource-listing operations return a subset of the available attributes +// for the resource. For example, this operation does not return tags, even though +// they are an attribute of the returned object. To view all of the information for +// an instance profile, see GetInstanceProfile . You can paginate the results using +// the MaxItems and Marker parameters. func (c *Client) ListInstanceProfiles(ctx context.Context, params *ListInstanceProfilesInput, optFns ...func(*Options)) (*ListInstanceProfilesOutput, error) { if params == nil { params = &ListInstanceProfilesInput{} @@ -46,21 +45,21 @@ type ListInstanceProfilesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. For example, the prefix // /application_abc/component_xyz/ gets all instance profiles whose path starts - // with /application_abc/component_xyz/. This parameter is optional. If it is not + // with /application_abc/component_xyz/ . This parameter is optional. If it is not // included, it defaults to a slash (/), listing all instance profiles. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of either a forward slash (/) by itself or a + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of either a forward slash (/) by itself or a // string that must begin and end with forward slashes. In addition, it can contain - // any ASCII character from the ! (\u0021) through the DEL character (\u007F), + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string @@ -79,11 +78,11 @@ type ListInstanceProfilesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -166,10 +165,10 @@ var _ ListInstanceProfilesAPIClient = (*Client)(nil) type ListInstanceProfilesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListInstanceProfilesForRole.go b/service/iam/api_op_ListInstanceProfilesForRole.go index 0ec25a13203..37ecffba2be 100644 --- a/service/iam/api_op_ListInstanceProfilesForRole.go +++ b/service/iam/api_op_ListInstanceProfilesForRole.go @@ -14,9 +14,8 @@ import ( // Lists the instance profiles that have the specified associated IAM role. If // there are none, the operation returns an empty list. For more information about -// instance profiles, go to About instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html). -// You can paginate the results using the MaxItems and Marker parameters. +// instance profiles, go to About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// . You can paginate the results using the MaxItems and Marker parameters. func (c *Client) ListInstanceProfilesForRole(ctx context.Context, params *ListInstanceProfilesForRoleInput, optFns ...func(*Options)) (*ListInstanceProfilesForRoleOutput, error) { if params == nil { params = &ListInstanceProfilesForRoleInput{} @@ -35,7 +34,7 @@ func (c *Client) ListInstanceProfilesForRole(ctx context.Context, params *ListIn type ListInstanceProfilesForRoleInput struct { // The name of the role to list instance profiles for. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -50,10 +49,10 @@ type ListInstanceProfilesForRoleInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -72,11 +71,11 @@ type ListInstanceProfilesForRoleOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -162,10 +161,10 @@ var _ ListInstanceProfilesForRoleAPIClient = (*Client)(nil) type ListInstanceProfilesForRolePaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListMFADeviceTags.go b/service/iam/api_op_ListMFADeviceTags.go index 77bf28a4e99..bad0cb58217 100644 --- a/service/iam/api_op_ListMFADeviceTags.go +++ b/service/iam/api_op_ListMFADeviceTags.go @@ -13,9 +13,8 @@ import ( // Lists the tags that are attached to the specified IAM virtual multi-factor // authentication (MFA) device. The returned list of tags is sorted by tag key. For -// more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) ListMFADeviceTags(ctx context.Context, params *ListMFADeviceTagsInput, optFns ...func(*Options)) (*ListMFADeviceTagsOutput, error) { if params == nil { params = &ListMFADeviceTagsInput{} @@ -33,10 +32,10 @@ func (c *Client) ListMFADeviceTags(ctx context.Context, params *ListMFADeviceTag type ListMFADeviceTagsInput struct { - // The unique identifier for the IAM virtual MFA device whose tags you want to see. - // For virtual MFA devices, the serial number is the same as the ARN. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // The unique identifier for the IAM virtual MFA device whose tags you want to + // see. For virtual MFA devices, the serial number is the same as the ARN. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -50,10 +49,10 @@ type ListMFADeviceTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -62,9 +61,9 @@ type ListMFADeviceTagsInput struct { type ListMFADeviceTagsOutput struct { - // The list of tags that are currently attached to the virtual MFA device. Each tag - // consists of a key name and an associated value. If no tags are attached to the - // specified resource, the response contains an empty list. + // The list of tags that are currently attached to the virtual MFA device. Each + // tag consists of a key name and an associated value. If no tags are attached to + // the specified resource, the response contains an empty list. // // This member is required. Tags []types.Tag @@ -73,11 +72,11 @@ type ListMFADeviceTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListMFADevices.go b/service/iam/api_op_ListMFADevices.go index ee995dafc6d..16744219f07 100644 --- a/service/iam/api_op_ListMFADevices.go +++ b/service/iam/api_op_ListMFADevices.go @@ -43,15 +43,15 @@ type ListMFADevicesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The name of the user whose MFA devices you want to list. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string @@ -71,11 +71,11 @@ type ListMFADevicesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -157,10 +157,10 @@ var _ ListMFADevicesAPIClient = (*Client)(nil) type ListMFADevicesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListOpenIDConnectProviderTags.go b/service/iam/api_op_ListOpenIDConnectProviderTags.go index b4bd41cc4ed..54ceeb7c189 100644 --- a/service/iam/api_op_ListOpenIDConnectProviderTags.go +++ b/service/iam/api_op_ListOpenIDConnectProviderTags.go @@ -13,11 +13,9 @@ import ( // Lists the tags that are attached to the specified OpenID Connect // (OIDC)-compatible identity provider. The returned list of tags is sorted by tag -// key. For more information, see About web identity federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html). -// For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// key. For more information, see About web identity federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) +// . For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) ListOpenIDConnectProviderTags(ctx context.Context, params *ListOpenIDConnectProviderTagsInput, optFns ...func(*Options)) (*ListOpenIDConnectProviderTagsOutput, error) { if params == nil { params = &ListOpenIDConnectProviderTagsInput{} @@ -36,10 +34,10 @@ func (c *Client) ListOpenIDConnectProviderTags(ctx context.Context, params *List type ListOpenIDConnectProviderTagsInput struct { // The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to - // see. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // see. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. OpenIDConnectProviderArn *string @@ -52,10 +50,10 @@ type ListOpenIDConnectProviderTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -76,11 +74,11 @@ type ListOpenIDConnectProviderTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListOpenIDConnectProviders.go b/service/iam/api_op_ListOpenIDConnectProviders.go index 64c9f28cc0c..6620cf434e1 100644 --- a/service/iam/api_op_ListOpenIDConnectProviders.go +++ b/service/iam/api_op_ListOpenIDConnectProviders.go @@ -16,7 +16,7 @@ import ( // return a subset of the available attributes for the resource. For example, this // operation does not return tags, even though they are an attribute of the // returned object. To view all of the information for an OIDC provider, see -// GetOpenIDConnectProvider. +// GetOpenIDConnectProvider . func (c *Client) ListOpenIDConnectProviders(ctx context.Context, params *ListOpenIDConnectProvidersInput, optFns ...func(*Options)) (*ListOpenIDConnectProvidersOutput, error) { if params == nil { params = &ListOpenIDConnectProvidersInput{} diff --git a/service/iam/api_op_ListPolicies.go b/service/iam/api_op_ListPolicies.go index 39851cea90b..7bd86f97a7b 100644 --- a/service/iam/api_op_ListPolicies.go +++ b/service/iam/api_op_ListPolicies.go @@ -15,17 +15,16 @@ import ( // Lists all the managed policies that are available in your Amazon Web Services // account, including your own customer-defined managed policies and all Amazon Web // Services managed policies. You can filter the list of policies that is returned -// using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, -// to list only the customer managed policies in your Amazon Web Services account, -// set Scope to Local. To list only Amazon Web Services managed policies, set Scope -// to AWS. You can paginate the results using the MaxItems and Marker parameters. -// For more information about managed policies, see Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// using the optional OnlyAttached , Scope , and PathPrefix parameters. For +// example, to list only the customer managed policies in your Amazon Web Services +// account, set Scope to Local . To list only Amazon Web Services managed policies, +// set Scope to AWS . You can paginate the results using the MaxItems and Marker +// parameters. For more information about managed policies, see Managed policies +// and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. IAM resource-listing operations return a subset of the // available attributes for the resource. For example, this operation does not // return tags, even though they are an attribute of the returned object. To view -// all of the information for a customer manged policy, see GetPolicy. +// all of the information for a customer manged policy, see GetPolicy . func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error) { if params == nil { params = &ListPoliciesInput{} @@ -51,39 +50,39 @@ type ListPoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 - // A flag to filter the results to only the attached policies. When OnlyAttached is - // true, the returned list contains only the policies that are attached to an IAM - // user, group, or role. When OnlyAttached is false, or when the parameter is not - // included, all policies are returned. + // A flag to filter the results to only the attached policies. When OnlyAttached + // is true , the returned list contains only the policies that are attached to an + // IAM user, group, or role. When OnlyAttached is false , or when the parameter is + // not included, all policies are returned. OnlyAttached bool // The path prefix for filtering the results. This parameter is optional. If it is // not included, it defaults to a slash (/), listing all policies. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of either a forward slash (/) by itself or a string + // that must begin and end with forward slashes. In addition, it can contain any + // ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string // The policy usage method to use for filtering the results. To list only - // permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only + // permissions policies, set PolicyUsageFilter to PermissionsPolicy . To list only // the policies used to set permissions boundaries, set the value to - // PermissionsBoundary. This parameter is optional. If it is not included, all + // PermissionsBoundary . This parameter is optional. If it is not included, all // policies are returned. PolicyUsageFilter types.PolicyUsageType // The scope to use for filtering the results. To list only Amazon Web Services - // managed policies, set Scope to AWS. To list only the customer managed policies - // in your Amazon Web Services account, set Scope to Local. This parameter is - // optional. If it is not included, or if it is set to All, all policies are + // managed policies, set Scope to AWS . To list only the customer managed policies + // in your Amazon Web Services account, set Scope to Local . This parameter is + // optional. If it is not included, or if it is set to All , all policies are // returned. Scope types.PolicyScopeType @@ -97,11 +96,11 @@ type ListPoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -185,10 +184,10 @@ var _ ListPoliciesAPIClient = (*Client)(nil) type ListPoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListPoliciesGrantingServiceAccess.go b/service/iam/api_op_ListPoliciesGrantingServiceAccess.go index 3d5a70c1f0a..26c1247af57 100644 --- a/service/iam/api_op_ListPoliciesGrantingServiceAccess.go +++ b/service/iam/api_op_ListPoliciesGrantingServiceAccess.go @@ -17,29 +17,22 @@ import ( // policy types include resource-based policies, access control lists, // Organizations policies, IAM permissions boundaries, and STS assume role // policies. It only applies permissions policy logic. For more about the -// evaluation of policy types, see Evaluating policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) +// evaluation of policy types, see Evaluating policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) // in the IAM User Guide. The list of policies returned by the operation depends on // the ARN of the identity that you provide. +// - User – The list of policies includes the managed and inline policies that +// are attached to the user directly. The list also includes any additional managed +// and inline policies that are attached to the group to which the user belongs. +// - Group – The list of policies includes only the managed and inline policies +// that are attached to the group directly. Policies that are attached to the +// group’s user are not included. +// - Role – The list of policies includes only the managed and inline policies +// that are attached to the role. // -// * User – The list of policies -// includes the managed and inline policies that are attached to the user directly. -// The list also includes any additional managed and inline policies that are -// attached to the group to which the user belongs. -// -// * Group – The list of policies -// includes only the managed and inline policies that are attached to the group -// directly. Policies that are attached to the group’s user are not included. -// -// * -// Role – The list of policies includes only the managed and inline policies that -// are attached to the role. -// -// For each managed policy, this operation returns the -// ARN and policy name. For each inline policy, it returns the policy name and the -// entity to which it is attached. Inline policies do not have an ARN. For more -// information about these policy types, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) +// For each managed policy, this operation returns the ARN and policy name. For +// each inline policy, it returns the policy name and the entity to which it is +// attached. Inline policies do not have an ARN. For more information about these +// policy types, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) // in the IAM User Guide. Policies that are attached to users and roles as // permissions boundaries are not returned. To view which managed policy is // currently used to set the permissions boundary for a user or role, use the @@ -69,13 +62,11 @@ type ListPoliciesGrantingServiceAccessInput struct { // The service namespace for the Amazon Web Services services whose policies you // want to list. To learn the service namespace for a service, see Actions, - // resources, and condition keys for Amazon Web Services services - // (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) + // resources, and condition keys for Amazon Web Services services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) // in the IAM User Guide. Choose the name of the service to view details for that // service. In the first paragraph, find the service prefix. For example, (service - // prefix: a4b). For more information about service namespaces, see Amazon Web - // Services service namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // prefix: a4b) . For more information about service namespaces, see Amazon Web + // Services service namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // This member is required. @@ -104,7 +95,7 @@ type ListPoliciesGrantingServiceAccessOutput struct { // IsTruncated after every call to ensure that you receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListPolicyTags.go b/service/iam/api_op_ListPolicyTags.go index 45ac3e33047..aa5e13fe01d 100644 --- a/service/iam/api_op_ListPolicyTags.go +++ b/service/iam/api_op_ListPolicyTags.go @@ -13,9 +13,8 @@ import ( // Lists the tags that are attached to the specified IAM customer managed policy. // The returned list of tags is sorted by tag key. For more information about -// tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) ListPolicyTags(ctx context.Context, params *ListPolicyTagsInput, optFns ...func(*Options)) (*ListPolicyTagsOutput, error) { if params == nil { params = &ListPolicyTagsInput{} @@ -34,8 +33,8 @@ func (c *Client) ListPolicyTags(ctx context.Context, params *ListPolicyTagsInput type ListPolicyTagsInput struct { // The ARN of the IAM customer managed policy whose tags you want to see. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -49,10 +48,10 @@ type ListPolicyTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -61,9 +60,9 @@ type ListPolicyTagsInput struct { type ListPolicyTagsOutput struct { - // The list of tags that are currently attached to the IAM customer managed policy. - // Each tag consists of a key name and an associated value. If no tags are attached - // to the specified resource, the response contains an empty list. + // The list of tags that are currently attached to the IAM customer managed + // policy. Each tag consists of a key name and an associated value. If no tags are + // attached to the specified resource, the response contains an empty list. // // This member is required. Tags []types.Tag @@ -72,11 +71,11 @@ type ListPolicyTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListPolicyVersions.go b/service/iam/api_op_ListPolicyVersions.go index d28deb0d1b4..3b93694ad0f 100644 --- a/service/iam/api_op_ListPolicyVersions.go +++ b/service/iam/api_op_ListPolicyVersions.go @@ -14,8 +14,7 @@ import ( // Lists information about the versions of the specified managed policy, including // the version that is currently set as the policy's default version. For more -// information about managed policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// information about managed policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error) { if params == nil { @@ -35,9 +34,8 @@ func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersi type ListPolicyVersionsInput struct { // The Amazon Resource Name (ARN) of the IAM policy for which you want the - // versions. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // versions. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string @@ -50,10 +48,10 @@ type ListPolicyVersionsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -67,17 +65,16 @@ type ListPolicyVersionsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // A list of policy versions. For more information about managed policy versions, - // see Versioning for managed policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // see Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. Versions []types.PolicyVersion @@ -163,10 +160,10 @@ var _ ListPolicyVersionsAPIClient = (*Client)(nil) type ListPolicyVersionsPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListRolePolicies.go b/service/iam/api_op_ListRolePolicies.go index 29f5aaffae0..0e7513ec52b 100644 --- a/service/iam/api_op_ListRolePolicies.go +++ b/service/iam/api_op_ListRolePolicies.go @@ -13,9 +13,8 @@ import ( // Lists the names of the inline policies that are embedded in the specified IAM // role. An IAM role can also have managed policies attached to it. To list the -// managed policies that are attached to a role, use ListAttachedRolePolicies. For -// more information about policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// managed policies that are attached to a role, use ListAttachedRolePolicies . For +// more information about policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. If there are no inline policies embedded with the specified // role, the operation returns an empty list. @@ -37,7 +36,7 @@ func (c *Client) ListRolePolicies(ctx context.Context, params *ListRolePoliciesI type ListRolePoliciesInput struct { // The name of the role to list policies for. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -52,10 +51,10 @@ type ListRolePoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -74,11 +73,11 @@ type ListRolePoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -163,10 +162,10 @@ var _ ListRolePoliciesAPIClient = (*Client)(nil) type ListRolePoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListRoleTags.go b/service/iam/api_op_ListRoleTags.go index c9b9283007b..867a24d32a2 100644 --- a/service/iam/api_op_ListRoleTags.go +++ b/service/iam/api_op_ListRoleTags.go @@ -33,7 +33,7 @@ func (c *Client) ListRoleTags(ctx context.Context, params *ListRoleTagsInput, op type ListRoleTagsInput struct { // The name of the IAM role for which you want to see the list of tags. This - // parameter accepts (through its regex pattern (http://wikipedia.org/wiki/regex)) + // parameter accepts (through its regex pattern (http://wikipedia.org/wiki/regex) ) // a string of characters that consist of upper and lowercase alphanumeric // characters with no spaces. You can also include any of the following characters: // _+=,.@- @@ -49,10 +49,10 @@ type ListRoleTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -61,8 +61,8 @@ type ListRoleTagsInput struct { type ListRoleTagsOutput struct { - // The list of tags that are currently attached to the role. Each tag consists of a - // key name and an associated value. If no tags are attached to the specified + // The list of tags that are currently attached to the role. Each tag consists of + // a key name and an associated value. If no tags are attached to the specified // resource, the response contains an empty list. // // This member is required. @@ -72,11 +72,11 @@ type ListRoleTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListRoles.go b/service/iam/api_op_ListRoles.go index 49b0518a030..d7b58531d9d 100644 --- a/service/iam/api_op_ListRoles.go +++ b/service/iam/api_op_ListRoles.go @@ -14,12 +14,11 @@ import ( // Lists the IAM roles that have the specified path prefix. If there are none, the // operation returns an empty list. For more information about roles, see Working -// with roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). IAM -// resource-listing operations return a subset of the available attributes for the -// resource. For example, this operation does not return tags, even though they are -// an attribute of the returned object. To view all of the information for a role, -// see GetRole. You can paginate the results using the MaxItems and Marker +// with roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) +// . IAM resource-listing operations return a subset of the available attributes +// for the resource. For example, this operation does not return tags, even though +// they are an attribute of the returned object. To view all of the information for +// a role, see GetRole . You can paginate the results using the MaxItems and Marker // parameters. func (c *Client) ListRoles(ctx context.Context, params *ListRolesInput, optFns ...func(*Options)) (*ListRolesOutput, error) { if params == nil { @@ -46,22 +45,22 @@ type ListRolesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. For example, the prefix // /application_abc/component_xyz/ gets all roles whose path starts with - // /application_abc/component_xyz/. This parameter is optional. If it is not + // /application_abc/component_xyz/ . This parameter is optional. If it is not // included, it defaults to a slash (/), listing all roles. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of either a forward slash (/) by itself or a string that // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // character from the ! ( \u0021 ) through the DEL character ( \u007F ), including + // most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -79,11 +78,11 @@ type ListRolesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -164,10 +163,10 @@ var _ ListRolesAPIClient = (*Client)(nil) type ListRolesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListSAMLProviderTags.go b/service/iam/api_op_ListSAMLProviderTags.go index b9999285974..c46d282ff40 100644 --- a/service/iam/api_op_ListSAMLProviderTags.go +++ b/service/iam/api_op_ListSAMLProviderTags.go @@ -13,11 +13,9 @@ import ( // Lists the tags that are attached to the specified Security Assertion Markup // Language (SAML) identity provider. The returned list of tags is sorted by tag -// key. For more information, see About SAML 2.0-based federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html). -// For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// key. For more information, see About SAML 2.0-based federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) +// . For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) ListSAMLProviderTags(ctx context.Context, params *ListSAMLProviderTagsInput, optFns ...func(*Options)) (*ListSAMLProviderTagsOutput, error) { if params == nil { params = &ListSAMLProviderTagsInput{} @@ -35,11 +33,11 @@ func (c *Client) ListSAMLProviderTags(ctx context.Context, params *ListSAMLProvi type ListSAMLProviderTagsInput struct { - // The ARN of the Security Assertion Markup Language (SAML) identity provider whose - // tags you want to see. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The ARN of the Security Assertion Markup Language (SAML) identity provider + // whose tags you want to see. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. SAMLProviderArn *string @@ -52,10 +50,10 @@ type ListSAMLProviderTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -76,11 +74,11 @@ type ListSAMLProviderTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListSAMLProviders.go b/service/iam/api_op_ListSAMLProviders.go index 6790fd16776..9b4ed7b6b56 100644 --- a/service/iam/api_op_ListSAMLProviders.go +++ b/service/iam/api_op_ListSAMLProviders.go @@ -15,8 +15,8 @@ import ( // resource-listing operations return a subset of the available attributes for the // resource. For example, this operation does not return tags, even though they are // an attribute of the returned object. To view all of the information for a SAML -// provider, see GetSAMLProvider. This operation requires Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// provider, see GetSAMLProvider . This operation requires Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) ListSAMLProviders(ctx context.Context, params *ListSAMLProvidersInput, optFns ...func(*Options)) (*ListSAMLProvidersOutput, error) { if params == nil { params = &ListSAMLProvidersInput{} diff --git a/service/iam/api_op_ListSSHPublicKeys.go b/service/iam/api_op_ListSSHPublicKeys.go index 74286ee2fca..d982f4524e2 100644 --- a/service/iam/api_op_ListSSHPublicKeys.go +++ b/service/iam/api_op_ListSSHPublicKeys.go @@ -16,8 +16,7 @@ import ( // user. If none exists, the operation returns an empty list. The SSH public keys // returned by this operation are used only for authenticating the IAM user to an // CodeCommit repository. For more information about using SSH keys to authenticate -// to an CodeCommit repository, see Set up CodeCommit for SSH connections -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) +// to an CodeCommit repository, see Set up CodeCommit for SSH connections (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) // in the CodeCommit User Guide. Although each user is limited to a small number of // keys, you can still paginate the results using the MaxItems and Marker // parameters. @@ -46,19 +45,19 @@ type ListSSHPublicKeysInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The name of the IAM user to list SSH public keys for. If none is specified, the // UserName field is determined implicitly based on the Amazon Web Services access - // key used to sign the request. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // key used to sign the request. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- UserName *string noSmithyDocumentSerde @@ -71,11 +70,11 @@ type ListSSHPublicKeysOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -160,10 +159,10 @@ var _ ListSSHPublicKeysAPIClient = (*Client)(nil) type ListSSHPublicKeysPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListServerCertificateTags.go b/service/iam/api_op_ListServerCertificateTags.go index 2db52975d8a..bfb83549fd0 100644 --- a/service/iam/api_op_ListServerCertificateTags.go +++ b/service/iam/api_op_ListServerCertificateTags.go @@ -13,13 +13,11 @@ import ( // Lists the tags that are attached to the specified IAM server certificate. The // returned list of tags is sorted by tag key. For more information about tagging, -// see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. For certificates in a Region supported by Certificate Manager (ACM), we -// recommend that you don't use IAM server certificates. Instead, use ACM to -// provision, manage, and deploy your server certificates. For more information -// about IAM server certificates, Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. For certificates in a Region supported by Certificate +// Manager (ACM), we recommend that you don't use IAM server certificates. Instead, +// use ACM to provision, manage, and deploy your server certificates. For more +// information about IAM server certificates, Working with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. func (c *Client) ListServerCertificateTags(ctx context.Context, params *ListServerCertificateTagsInput, optFns ...func(*Options)) (*ListServerCertificateTagsOutput, error) { if params == nil { @@ -39,8 +37,8 @@ func (c *Client) ListServerCertificateTags(ctx context.Context, params *ListServ type ListServerCertificateTagsInput struct { // The name of the IAM server certificate whose tags you want to see. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. @@ -54,10 +52,10 @@ type ListServerCertificateTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -66,9 +64,9 @@ type ListServerCertificateTagsInput struct { type ListServerCertificateTagsOutput struct { - // The list of tags that are currently attached to the IAM server certificate. Each - // tag consists of a key name and an associated value. If no tags are attached to - // the specified resource, the response contains an empty list. + // The list of tags that are currently attached to the IAM server certificate. + // Each tag consists of a key name and an associated value. If no tags are attached + // to the specified resource, the response contains an empty list. // // This member is required. Tags []types.Tag @@ -77,11 +75,11 @@ type ListServerCertificateTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string diff --git a/service/iam/api_op_ListServerCertificates.go b/service/iam/api_op_ListServerCertificates.go index ef0648cbef3..f976c617b53 100644 --- a/service/iam/api_op_ListServerCertificates.go +++ b/service/iam/api_op_ListServerCertificates.go @@ -12,17 +12,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the server certificates stored in IAM that have the specified path prefix. -// If none exist, the operation returns an empty list. You can paginate the results -// using the MaxItems and Marker parameters. For more information about working -// with server certificates, see Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// Lists the server certificates stored in IAM that have the specified path +// prefix. If none exist, the operation returns an empty list. You can paginate the +// results using the MaxItems and Marker parameters. For more information about +// working with server certificates, see Working with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. This topic also includes a list of Amazon Web Services // services that can use the server certificates that you manage with IAM. IAM // resource-listing operations return a subset of the available attributes for the // resource. For example, this operation does not return tags, even though they are // an attribute of the returned object. To view all of the information for a -// servercertificate, see GetServerCertificate. +// servercertificate, see GetServerCertificate . func (c *Client) ListServerCertificates(ctx context.Context, params *ListServerCertificatesInput, optFns ...func(*Options)) (*ListServerCertificatesOutput, error) { if params == nil { params = &ListServerCertificatesInput{} @@ -48,22 +47,22 @@ type ListServerCertificatesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. For example: /company/servercerts // would get all server certificates for which the path starts with - // /company/servercerts. This parameter is optional. If it is not included, it + // /company/servercerts . This parameter is optional. If it is not included, it // defaults to a slash (/), listing all server certificates. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of either a forward slash (/) by itself or a string that // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // character from the ! ( \u0021 ) through the DEL character ( \u007F ), including + // most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -81,11 +80,11 @@ type ListServerCertificatesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -168,10 +167,10 @@ var _ ListServerCertificatesAPIClient = (*Client)(nil) type ListServerCertificatesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListServiceSpecificCredentials.go b/service/iam/api_op_ListServiceSpecificCredentials.go index 949899a9059..192e7e9a39f 100644 --- a/service/iam/api_op_ListServiceSpecificCredentials.go +++ b/service/iam/api_op_ListServiceSpecificCredentials.go @@ -16,9 +16,8 @@ import ( // service-specific credentials returned by this operation are used only for // authenticating the IAM user to a specific service. For more information about // using service-specific credentials to authenticate to an Amazon Web Services -// service, see Set up service-specific credentials -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html) in -// the CodeCommit User Guide. +// service, see Set up service-specific credentials (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html) +// in the CodeCommit User Guide. func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *ListServiceSpecificCredentialsInput, optFns ...func(*Options)) (*ListServiceSpecificCredentialsOutput, error) { if params == nil { params = &ListServiceSpecificCredentialsInput{} @@ -36,15 +35,15 @@ func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *Lis type ListServiceSpecificCredentialsInput struct { - // Filters the returned results to only those for the specified Amazon Web Services - // service. If not specified, then Amazon Web Services returns service-specific - // credentials for all services. + // Filters the returned results to only those for the specified Amazon Web + // Services service. If not specified, then Amazon Web Services returns + // service-specific credentials for all services. ServiceName *string // The name of the user whose service-specific credentials you want information // about. If this value is not specified, then the operation assumes the user whose // credentials are used to call the operation. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_ListSigningCertificates.go b/service/iam/api_op_ListSigningCertificates.go index 30beadcc1d4..6c945ce7cee 100644 --- a/service/iam/api_op_ListSigningCertificates.go +++ b/service/iam/api_op_ListSigningCertificates.go @@ -12,16 +12,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the signing certificates associated with the specified -// IAM user. If none exists, the operation returns an empty list. Although each -// user is limited to a small number of signing certificates, you can still -// paginate the results using the MaxItems and Marker parameters. If the UserName -// field is not specified, the user name is determined implicitly based on the -// Amazon Web Services access key ID used to sign the request for this operation. -// This operation works for access keys under the Amazon Web Services account. -// Consequently, you can use this operation to manage Amazon Web Services account -// root user credentials even if the Amazon Web Services account has no associated -// users. +// Returns information about the signing certificates associated with the +// specified IAM user. If none exists, the operation returns an empty list. +// Although each user is limited to a small number of signing certificates, you can +// still paginate the results using the MaxItems and Marker parameters. If the +// UserName field is not specified, the user name is determined implicitly based on +// the Amazon Web Services access key ID used to sign the request for this +// operation. This operation works for access keys under the Amazon Web Services +// account. Consequently, you can use this operation to manage Amazon Web Services +// account root user credentials even if the Amazon Web Services account has no +// associated users. func (c *Client) ListSigningCertificates(ctx context.Context, params *ListSigningCertificatesInput, optFns ...func(*Options)) (*ListSigningCertificatesOutput, error) { if params == nil { params = &ListSigningCertificatesInput{} @@ -47,16 +47,16 @@ type ListSigningCertificatesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The name of the IAM user whose signing certificates you want to examine. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- UserName *string @@ -75,11 +75,11 @@ type ListSigningCertificatesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -162,10 +162,10 @@ var _ ListSigningCertificatesAPIClient = (*Client)(nil) type ListSigningCertificatesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListUserPolicies.go b/service/iam/api_op_ListUserPolicies.go index 2486961ef72..9682334a36e 100644 --- a/service/iam/api_op_ListUserPolicies.go +++ b/service/iam/api_op_ListUserPolicies.go @@ -13,9 +13,8 @@ import ( // Lists the names of the inline policies embedded in the specified IAM user. An // IAM user can also have managed policies attached to it. To list the managed -// policies that are attached to a user, use ListAttachedUserPolicies. For more -// information about policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policies that are attached to a user, use ListAttachedUserPolicies . For more +// information about policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. You can paginate the results using the MaxItems and // Marker parameters. If there are no inline policies embedded with the specified // user, the operation returns an empty list. @@ -37,7 +36,7 @@ func (c *Client) ListUserPolicies(ctx context.Context, params *ListUserPoliciesI type ListUserPoliciesInput struct { // The name of the user to list policies for. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // @@ -52,10 +51,10 @@ type ListUserPoliciesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -74,11 +73,11 @@ type ListUserPoliciesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -163,10 +162,10 @@ var _ ListUserPoliciesAPIClient = (*Client)(nil) type ListUserPoliciesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListUserTags.go b/service/iam/api_op_ListUserTags.go index 8acedc6778f..e80ed977cf0 100644 --- a/service/iam/api_op_ListUserTags.go +++ b/service/iam/api_op_ListUserTags.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags that are attached to the specified IAM user. The returned list of -// tags is sorted by tag key. For more information about tagging, see Tagging IAM -// resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the -// IAM User Guide. +// Lists the tags that are attached to the specified IAM user. The returned list +// of tags is sorted by tag key. For more information about tagging, see Tagging +// IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in +// the IAM User Guide. func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, optFns ...func(*Options)) (*ListUserTagsOutput, error) { if params == nil { params = &ListUserTagsInput{} @@ -34,7 +34,7 @@ func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, op type ListUserTagsInput struct { // The name of the IAM user whose tags you want to see. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -49,10 +49,10 @@ type ListUserTagsInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -61,8 +61,8 @@ type ListUserTagsInput struct { type ListUserTagsOutput struct { - // The list of tags that are currently attached to the user. Each tag consists of a - // key name and an associated value. If no tags are attached to the specified + // The list of tags that are currently attached to the user. Each tag consists of + // a key name and an associated value. If no tags are attached to the specified // resource, the response contains an empty list. // // This member is required. @@ -72,11 +72,11 @@ type ListUserTagsOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -160,10 +160,10 @@ var _ ListUserTagsAPIClient = (*Client)(nil) type ListUserTagsPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListUsers.go b/service/iam/api_op_ListUsers.go index 71bed45876f..d67e5a49537 100644 --- a/service/iam/api_op_ListUsers.go +++ b/service/iam/api_op_ListUsers.go @@ -17,7 +17,7 @@ import ( // If there are none, the operation returns an empty list. IAM resource-listing // operations return a subset of the available attributes for the resource. For // example, this operation does not return tags, even though they are an attribute -// of the returned object. To view all of the information for a user, see GetUser. +// of the returned object. To view all of the information for a user, see GetUser . // You can paginate the results using the MaxItems and Marker parameters. func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error) { if params == nil { @@ -44,22 +44,22 @@ type ListUsersInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 // The path prefix for filtering the results. For example: - // /division_abc/subdivision_xyz/, which would get all user names whose path starts - // with /division_abc/subdivision_xyz/. This parameter is optional. If it is not - // included, it defaults to a slash (/), listing all user names. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of either a forward slash (/) by itself or a string that - // must begin and end with forward slashes. In addition, it can contain any ASCII - // character from the ! (\u0021) through the DEL character (\u007F), including most - // punctuation characters, digits, and upper and lowercased letters. + // /division_abc/subdivision_xyz/ , which would get all user names whose path + // starts with /division_abc/subdivision_xyz/ . This parameter is optional. If it + // is not included, it defaults to a slash (/), listing all user names. This + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. PathPrefix *string noSmithyDocumentSerde @@ -77,11 +77,11 @@ type ListUsersOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -162,10 +162,10 @@ var _ ListUsersAPIClient = (*Client)(nil) type ListUsersPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_ListVirtualMFADevices.go b/service/iam/api_op_ListVirtualMFADevices.go index bc9321a3911..e7087865fdf 100644 --- a/service/iam/api_op_ListVirtualMFADevices.go +++ b/service/iam/api_op_ListVirtualMFADevices.go @@ -14,11 +14,11 @@ import ( // Lists the virtual MFA devices defined in the Amazon Web Services account by // assignment status. If you do not specify an assignment status, the operation -// returns a list of all virtual MFA devices. Assignment status can be Assigned, -// Unassigned, or Any. IAM resource-listing operations return a subset of the +// returns a list of all virtual MFA devices. Assignment status can be Assigned , +// Unassigned , or Any . IAM resource-listing operations return a subset of the // available attributes for the resource. For example, this operation does not // return tags, even though they are an attribute of the returned object. To view -// tag information for a virtual MFA device, see ListMFADeviceTags. You can +// tag information for a virtual MFA device, see ListMFADeviceTags . You can // paginate the results using the MaxItems and Marker parameters. func (c *Client) ListVirtualMFADevices(ctx context.Context, params *ListVirtualMFADevicesInput, optFns ...func(*Options)) (*ListVirtualMFADevicesOutput, error) { if params == nil { @@ -37,8 +37,8 @@ func (c *Client) ListVirtualMFADevices(ctx context.Context, params *ListVirtualM type ListVirtualMFADevicesInput struct { - // The status (Unassigned or Assigned) of the devices to list. If you do not - // specify an AssignmentStatus, the operation defaults to Any, which lists both + // The status ( Unassigned or Assigned ) of the devices to list. If you do not + // specify an AssignmentStatus , the operation defaults to Any , which lists both // assigned and unassigned virtual MFA devices., AssignmentStatus types.AssignmentStatusType @@ -50,10 +50,10 @@ type ListVirtualMFADevicesInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -73,11 +73,11 @@ type ListVirtualMFADevicesOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -160,10 +160,10 @@ var _ ListVirtualMFADevicesAPIClient = (*Client)(nil) type ListVirtualMFADevicesPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_PutGroupPolicy.go b/service/iam/api_op_PutGroupPolicy.go index 77818b732c9..34b6056f965 100644 --- a/service/iam/api_op_PutGroupPolicy.go +++ b/service/iam/api_op_PutGroupPolicy.go @@ -12,18 +12,15 @@ import ( // Adds or updates an inline policy document that is embedded in the specified IAM // group. A user can also have managed policies attached to it. To attach a managed -// policy to a group, use AttachGroupPolicy. To create a new managed policy, use -// CreatePolicy. For information about policies, see Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policy to a group, use AttachGroupPolicy . To create a new managed policy, use +// CreatePolicy . For information about policies, see Managed policies and inline +// policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. For information about the maximum number of inline -// policies that you can embed in a group, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. Because policy documents can be large, you should use POST -// rather than GET when calling PutGroupPolicy. For general information about using -// the Query API with IAM, see Making query requests -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) in the -// IAM User Guide. +// policies that you can embed in a group, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. Because policy documents can be large, you should use +// POST rather than GET when calling PutGroupPolicy . For general information about +// using the Query API with IAM, see Making query requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) +// in the IAM User Guide. func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput, optFns ...func(*Options)) (*PutGroupPolicyOutput, error) { if params == nil { params = &PutGroupPolicyInput{} @@ -42,7 +39,7 @@ func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput type PutGroupPolicyInput struct { // The name of the group to associate the policy with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@-. // @@ -52,25 +49,21 @@ type PutGroupPolicyInput struct { // The policy document. You must provide policies in JSON format in IAM. However, // for CloudFormation templates formatted in YAML, you can provide the policy in // JSON or YAML format. CloudFormation always converts a YAML policy to JSON format - // before submitting it to = IAM. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) + // before submitting it to = IAM. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_PutRolePermissionsBoundary.go b/service/iam/api_op_PutRolePermissionsBoundary.go index e099376dde5..4798daf64a8 100644 --- a/service/iam/api_op_PutRolePermissionsBoundary.go +++ b/service/iam/api_op_PutRolePermissionsBoundary.go @@ -18,8 +18,7 @@ import ( // the boundary for a service-linked role. Policies used as permissions boundaries // do not provide permissions. You must also attach a permissions policy to the // role. To learn how the effective permissions for a role are evaluated, see IAM -// JSON policy evaluation logic -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) +// JSON policy evaluation logic (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) // in the IAM User Guide. func (c *Client) PutRolePermissionsBoundary(ctx context.Context, params *PutRolePermissionsBoundaryInput, optFns ...func(*Options)) (*PutRolePermissionsBoundaryOutput, error) { if params == nil { @@ -43,10 +42,9 @@ type PutRolePermissionsBoundaryInput struct { // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see Permissions - // boundaries for IAM entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. For more information about policy types, see Policy types - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) + // boundaries for IAM entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. For more information about policy types, see Policy + // types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) // in the IAM User Guide. // // This member is required. diff --git a/service/iam/api_op_PutRolePolicy.go b/service/iam/api_op_PutRolePolicy.go index 1231f2befc9..e909017b39b 100644 --- a/service/iam/api_op_PutRolePolicy.go +++ b/service/iam/api_op_PutRolePolicy.go @@ -13,22 +13,19 @@ import ( // Adds or updates an inline policy document that is embedded in the specified IAM // role. When you embed an inline policy in a role, the inline policy is used as // part of the role's access (permissions) policy. The role's trust policy is -// created at the same time as the role, using CreateRole. You can update a role's -// trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, -// see Using roles to delegate permissions and federate identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role -// can also have a managed policy attached to it. To attach a managed policy to a -// role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. -// For information about policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// created at the same time as the role, using CreateRole . You can update a role's +// trust policy using UpdateAssumeRolePolicy . For more information about IAM +// roles, see Using roles to delegate permissions and federate identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) +// . A role can also have a managed policy attached to it. To attach a managed +// policy to a role, use AttachRolePolicy . To create a new managed policy, use +// CreatePolicy . For information about policies, see Managed policies and inline +// policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. For information about the maximum number of inline -// policies that you can embed with a role, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. Because policy documents can be large, you should use POST -// rather than GET when calling PutRolePolicy. For general information about using -// the Query API with IAM, see Making query requests -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) in the -// IAM User Guide. +// policies that you can embed with a role, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. Because policy documents can be large, you should use +// POST rather than GET when calling PutRolePolicy . For general information about +// using the Query API with IAM, see Making query requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) +// in the IAM User Guide. func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, optFns ...func(*Options)) (*PutRolePolicyOutput, error) { if params == nil { params = &PutRolePolicyInput{} @@ -52,22 +49,18 @@ type PutRolePolicyInput struct { // before submitting it to IAM. The regex pattern (http://wikipedia.org/wiki/regex) // used to validate this parameter is a string of characters consisting of the // following: - // - // * Any printable ASCII character ranging from the space character - // (\u0020) through the end of the ASCII character range - // - // * The printable - // characters in the Basic Latin and Latin-1 Supplement character set (through - // \u00FF) - // - // * The special characters tab (\u0009), line feed (\u000A), and carriage - // return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // @@ -75,7 +68,7 @@ type PutRolePolicyInput struct { PolicyName *string // The name of the role to associate the policy with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_PutUserPermissionsBoundary.go b/service/iam/api_op_PutUserPermissionsBoundary.go index e5503b934bb..b5e4083b18b 100644 --- a/service/iam/api_op_PutUserPermissionsBoundary.go +++ b/service/iam/api_op_PutUserPermissionsBoundary.go @@ -17,8 +17,7 @@ import ( // advanced feature that can affect the permissions for the user. Policies that are // used as permissions boundaries do not provide permissions. You must also attach // a permissions policy to the user. To learn how the effective permissions for a -// user are evaluated, see IAM JSON policy evaluation logic -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) +// user are evaluated, see IAM JSON policy evaluation logic (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) // in the IAM User Guide. func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUserPermissionsBoundaryInput, optFns ...func(*Options)) (*PutUserPermissionsBoundaryOutput, error) { if params == nil { @@ -42,10 +41,9 @@ type PutUserPermissionsBoundaryInput struct { // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see Permissions - // boundaries for IAM entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) - // in the IAM User Guide. For more information about policy types, see Policy types - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) + // boundaries for IAM entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // in the IAM User Guide. For more information about policy types, see Policy + // types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) // in the IAM User Guide. // // This member is required. diff --git a/service/iam/api_op_PutUserPolicy.go b/service/iam/api_op_PutUserPolicy.go index 267e4a43bad..0f3babe8d7d 100644 --- a/service/iam/api_op_PutUserPolicy.go +++ b/service/iam/api_op_PutUserPolicy.go @@ -12,18 +12,15 @@ import ( // Adds or updates an inline policy document that is embedded in the specified IAM // user. An IAM user can also have a managed policy attached to it. To attach a -// managed policy to a user, use AttachUserPolicy. To create a new managed policy, -// use CreatePolicy. For information about policies, see Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// managed policy to a user, use AttachUserPolicy . To create a new managed policy, +// use CreatePolicy . For information about policies, see Managed policies and +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. For information about the maximum number of inline -// policies that you can embed in a user, see IAM and STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. Because policy documents can be large, you should use POST -// rather than GET when calling PutUserPolicy. For general information about using -// the Query API with IAM, see Making query requests -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) in the -// IAM User Guide. +// policies that you can embed in a user, see IAM and STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. Because policy documents can be large, you should use +// POST rather than GET when calling PutUserPolicy . For general information about +// using the Query API with IAM, see Making query requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) +// in the IAM User Guide. func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, optFns ...func(*Options)) (*PutUserPolicyOutput, error) { if params == nil { params = &PutUserPolicyInput{} @@ -47,22 +44,18 @@ type PutUserPolicyInput struct { // before submitting it to IAM. The regex pattern (http://wikipedia.org/wiki/regex) // used to validate this parameter is a string of characters consisting of the // following: - // - // * Any printable ASCII character ranging from the space character - // (\u0020) through the end of the ASCII character range - // - // * The printable - // characters in the Basic Latin and Latin-1 Supplement character set (through - // \u00FF) - // - // * The special characters tab (\u0009), line feed (\u000A), and carriage - // return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string // The name of the policy document. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // @@ -70,7 +63,7 @@ type PutUserPolicyInput struct { PolicyName *string // The name of the user to associate the policy with. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go b/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go index 0aa55f1c888..b9d1eab4ebb 100644 --- a/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go +++ b/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified client ID (also known as audience) from the list of client -// IDs registered for the specified IAM OpenID Connect (OIDC) provider resource -// object. This operation is idempotent; it does not fail or return an error if you -// try to remove a client ID that does not exist. +// Removes the specified client ID (also known as audience) from the list of +// client IDs registered for the specified IAM OpenID Connect (OIDC) provider +// resource object. This operation is idempotent; it does not fail or return an +// error if you try to remove a client ID that does not exist. func (c *Client) RemoveClientIDFromOpenIDConnectProvider(ctx context.Context, params *RemoveClientIDFromOpenIDConnectProviderInput, optFns ...func(*Options)) (*RemoveClientIDFromOpenIDConnectProviderOutput, error) { if params == nil { params = &RemoveClientIDFromOpenIDConnectProviderInput{} @@ -32,8 +32,8 @@ func (c *Client) RemoveClientIDFromOpenIDConnectProvider(ctx context.Context, pa type RemoveClientIDFromOpenIDConnectProviderInput struct { // The client ID (also known as audience) to remove from the IAM OIDC provider - // resource. For more information about client IDs, see - // CreateOpenIDConnectProvider. + // resource. For more information about client IDs, see CreateOpenIDConnectProvider + // . // // This member is required. ClientID *string @@ -41,9 +41,8 @@ type RemoveClientIDFromOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the // client ID from. You can get a list of OIDC provider ARNs by using the // ListOpenIDConnectProviders operation. For more information about ARNs, see - // Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_RemoveRoleFromInstanceProfile.go b/service/iam/api_op_RemoveRoleFromInstanceProfile.go index 59d2497f494..58796d4ad1f 100644 --- a/service/iam/api_op_RemoveRoleFromInstanceProfile.go +++ b/service/iam/api_op_RemoveRoleFromInstanceProfile.go @@ -15,9 +15,9 @@ import ( // about to remove from the instance profile. Removing a role from an instance // profile that is associated with a running instance might break any applications // running on the instance. For more information about IAM roles, see Working with -// roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html). -// For more information about instance profiles, see About instance profiles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html). +// roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) . +// For more information about instance profiles, see About instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html) +// . func (c *Client) RemoveRoleFromInstanceProfile(ctx context.Context, params *RemoveRoleFromInstanceProfileInput, optFns ...func(*Options)) (*RemoveRoleFromInstanceProfileOutput, error) { if params == nil { params = &RemoveRoleFromInstanceProfileInput{} @@ -36,17 +36,17 @@ func (c *Client) RemoveRoleFromInstanceProfile(ctx context.Context, params *Remo type RemoveRoleFromInstanceProfileInput struct { // The name of the instance profile to update. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // // This member is required. InstanceProfileName *string - // The name of the role to remove. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the role to remove. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. RoleName *string diff --git a/service/iam/api_op_RemoveUserFromGroup.go b/service/iam/api_op_RemoveUserFromGroup.go index 3cbae8fafd3..1cbc32e0ed5 100644 --- a/service/iam/api_op_RemoveUserFromGroup.go +++ b/service/iam/api_op_RemoveUserFromGroup.go @@ -29,17 +29,17 @@ func (c *Client) RemoveUserFromGroup(ctx context.Context, params *RemoveUserFrom type RemoveUserFromGroupInput struct { // The name of the group to update. This parameter allows (through its regex - // pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of + // pattern (http://wikipedia.org/wiki/regex) ) a string of characters consisting of // upper and lowercase alphanumeric characters with no spaces. You can also include // any of the following characters: _+=,.@- // // This member is required. GroupName *string - // The name of the user to remove. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the user to remove. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string diff --git a/service/iam/api_op_ResetServiceSpecificCredential.go b/service/iam/api_op_ResetServiceSpecificCredential.go index 8eda8e75c7b..5c6787d6015 100644 --- a/service/iam/api_op_ResetServiceSpecificCredential.go +++ b/service/iam/api_op_ResetServiceSpecificCredential.go @@ -33,7 +33,7 @@ func (c *Client) ResetServiceSpecificCredential(ctx context.Context, params *Res type ResetServiceSpecificCredentialInput struct { // The unique identifier of the service-specific credential. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters that can consist of any upper or lowercased letter or digit. // // This member is required. @@ -42,7 +42,7 @@ type ResetServiceSpecificCredentialInput struct { // The name of the IAM user associated with the service-specific credential. If // this value is not specified, then the operation assumes the user whose // credentials are used to call the operation. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_ResyncMFADevice.go b/service/iam/api_op_ResyncMFADevice.go index 49e34236e21..839daddccd8 100644 --- a/service/iam/api_op_ResyncMFADevice.go +++ b/service/iam/api_op_ResyncMFADevice.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Synchronizes the specified MFA device with its IAM resource object on the Amazon -// Web Services servers. For more information about creating and working with -// virtual MFA devices, see Using a virtual MFA device -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) in the -// IAM User Guide. +// Synchronizes the specified MFA device with its IAM resource object on the +// Amazon Web Services servers. For more information about creating and working +// with virtual MFA devices, see Using a virtual MFA device (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) +// in the IAM User Guide. func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInput, optFns ...func(*Options)) (*ResyncMFADeviceOutput, error) { if params == nil { params = &ResyncMFADeviceInput{} @@ -32,8 +31,8 @@ func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInp type ResyncMFADeviceInput struct { - // An authentication code emitted by the device. The format for this parameter is a - // sequence of six digits. + // An authentication code emitted by the device. The format for this parameter is + // a sequence of six digits. // // This member is required. AuthenticationCode1 *string @@ -45,7 +44,7 @@ type ResyncMFADeviceInput struct { AuthenticationCode2 *string // Serial number that uniquely identifies the MFA device. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -53,8 +52,8 @@ type ResyncMFADeviceInput struct { SerialNumber *string // The name of the user whose MFA device you want to resynchronize. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_SetDefaultPolicyVersion.go b/service/iam/api_op_SetDefaultPolicyVersion.go index cbeb62685cd..d5e78d05740 100644 --- a/service/iam/api_op_SetDefaultPolicyVersion.go +++ b/service/iam/api_op_SetDefaultPolicyVersion.go @@ -13,9 +13,8 @@ import ( // Sets the specified version of the specified policy as the policy's default // (operative) version. This operation affects all users, groups, and roles that // the policy is attached to. To list the users, groups, and roles that the policy -// is attached to, use ListEntitiesForPolicy. For information about managed -// policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// is attached to, use ListEntitiesForPolicy . For information about managed +// policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error) { if params == nil { @@ -35,16 +34,14 @@ func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefault type SetDefaultPolicyVersionInput struct { // The Amazon Resource Name (ARN) of the IAM policy whose default version you want - // to set. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // to set. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicyArn *string // The version of the policy to set as the default (operative) version. For more - // information about managed policy versions, see Versioning for managed policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // information about managed policy versions, see Versioning for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. // // This member is required. diff --git a/service/iam/api_op_SetSecurityTokenServicePreferences.go b/service/iam/api_op_SetSecurityTokenServicePreferences.go index 9c742f78960..2d049dfe881 100644 --- a/service/iam/api_op_SetSecurityTokenServicePreferences.go +++ b/service/iam/api_op_SetSecurityTokenServicePreferences.go @@ -14,20 +14,19 @@ import ( // Sets the specified version of the global endpoint token as the token version // used for the Amazon Web Services account. By default, Security Token Service // (STS) is available as a global service, and all STS requests go to a single -// endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using +// endpoint at https://sts.amazonaws.com . Amazon Web Services recommends using // Regional STS endpoints to reduce latency, build in redundancy, and increase // session token availability. For information about Regional endpoints for STS, -// see Security Token Service endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/sts.html) in the Amazon Web -// Services General Reference. If you make an STS call to the global endpoint, the -// resulting session tokens might be valid in some Regions but not others. It -// depends on the version that is set in this operation. Version 1 tokens are valid -// only in Amazon Web Services Regions that are available by default. These tokens -// do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). -// Version 2 tokens are valid in all Regions. However, version 2 tokens are longer -// and might affect systems where you temporarily store tokens. For information, -// see Activating and deactivating STS in an Amazon Web Services Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// see Security Token Service endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sts.html) +// in the Amazon Web Services General Reference. If you make an STS call to the +// global endpoint, the resulting session tokens might be valid in some Regions but +// not others. It depends on the version that is set in this operation. Version 1 +// tokens are valid only in Amazon Web Services Regions that are available by +// default. These tokens do not work in manually enabled Regions, such as Asia +// Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version +// 2 tokens are longer and might affect systems where you temporarily store tokens. +// For information, see Activating and deactivating STS in an Amazon Web Services +// Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the IAM User Guide. To view the current session token version, see the // GlobalEndpointTokenVersion entry in the response of the GetAccountSummary // operation. @@ -53,8 +52,7 @@ type SetSecurityTokenServicePreferencesInput struct { // work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 // tokens are valid in all Regions. However, version 2 tokens are longer and might // affect systems where you temporarily store tokens. For information, see - // Activating and deactivating STS in an Amazon Web Services Region - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) + // Activating and deactivating STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the IAM User Guide. // // This member is required. diff --git a/service/iam/api_op_SimulateCustomPolicy.go b/service/iam/api_op_SimulateCustomPolicy.go index 57e71f8815c..86543883441 100644 --- a/service/iam/api_op_SimulateCustomPolicy.go +++ b/service/iam/api_op_SimulateCustomPolicy.go @@ -23,7 +23,7 @@ import ( // by Amazon Web Services and its services and which provide details about the // context of an API query request. You can use the Condition element of an IAM // policy to evaluate context keys. To get the list of context keys that the -// policies require for correct simulation, use GetContextKeysForCustomPolicy. If +// policies require for correct simulation, use GetContextKeysForCustomPolicy . If // the output is long, you can use MaxItems and Marker parameters to paginate the // results. The IAM policy simulator evaluates statements in the identity-based // policy and the inputs that you provide during simulation. The policy simulator @@ -31,9 +31,8 @@ import ( // that you check your policies against your live Amazon Web Services environment // after testing using the policy simulator to confirm that you have the desired // results. For more information about using the policy simulator, see Testing IAM -// policies with the IAM policy simulator -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html)in -// the IAM User Guide. +// policies with the IAM policy simulator (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) +// in the IAM User Guide. func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCustomPolicyInput, optFns ...func(*Options)) (*SimulateCustomPolicyOutput, error) { if params == nil { params = &SimulateCustomPolicyInput{} @@ -53,7 +52,7 @@ type SimulateCustomPolicyInput struct { // A list of names of API operations to evaluate in the simulation. Each operation // is evaluated against each resource. Each operation must include the service - // identifier, such as iam:CreateUser. This operation does not support using + // identifier, such as iam:CreateUser . This operation does not support using // wildcards (*) in an action name. // // This member is required. @@ -64,28 +63,21 @@ type SimulateCustomPolicyInput struct { // Do not include any resource-based policies in this parameter. Any resource-based // policy must be submitted with the ResourcePolicy parameter. The policies cannot // be "scope-down" policies, such as you could include in a call to - // GetFederationToken - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html) - // or one of the AssumeRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html) API - // operations. In other words, do not use policies designed to restrict what a user - // can do while using the temporary credentials. The maximum length of the policy - // document that you can pass in this operation, including whitespace, is listed - // below. To view the maximum character counts of a managed policy with no - // whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // GetFederationToken (https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html) + // or one of the AssumeRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html) + // API operations. In other words, do not use policies designed to restrict what a + // user can do while using the temporary credentials. The maximum length of the + // policy document that you can pass in this operation, including whitespace, is + // listed below. To view the maximum character counts of a managed policy with no + // whitespaces, see IAM and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyInputList []string @@ -110,10 +102,10 @@ type SimulateCustomPolicyInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -121,43 +113,36 @@ type SimulateCustomPolicyInput struct { // the maximum permissions that an IAM entity can have. You can input only one // permissions boundary when you pass a policy to this operation. For more // information about permissions boundaries, see Permissions boundaries for IAM - // entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. The policy input is specified as a string that contains // the complete, valid JSON text of a permissions boundary policy. The maximum // length of the policy document that you can pass in this operation, including // whitespace, is listed below. To view the maximum character counts of a managed - // policy with no whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // policy with no whitespaces, see IAM and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) PermissionsBoundaryPolicyInputList []string - // A list of ARNs of Amazon Web Services resources to include in the simulation. If - // this parameter is not provided, then the value defaults to * (all resources). - // Each API in the ActionNames parameter is evaluated for each resource in this - // list. The simulation determines the access result (allowed or denied) of each - // combination and reports it in the response. You can simulate resources that - // don't exist in your account. The simulation does not automatically retrieve - // policies for the specified resources. If you want to include a resource policy - // in the simulation, then you must include the policy as a string in the - // ResourcePolicy parameter. If you include a ResourcePolicy, then it must be - // applicable to all of the resources included in the simulation or you receive an - // invalid input error. For more information about ARNs, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. Simulation of resource-based policies - // isn't supported for IAM roles. + // A list of ARNs of Amazon Web Services resources to include in the simulation. + // If this parameter is not provided, then the value defaults to * (all + // resources). Each API in the ActionNames parameter is evaluated for each + // resource in this list. The simulation determines the access result (allowed or + // denied) of each combination and reports it in the response. You can simulate + // resources that don't exist in your account. The simulation does not + // automatically retrieve policies for the specified resources. If you want to + // include a resource policy in the simulation, then you must include the policy as + // a string in the ResourcePolicy parameter. If you include a ResourcePolicy , then + // it must be applicable to all of the resources included in the simulation or you + // receive an invalid input error. For more information about ARNs, see Amazon + // Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Simulation of resource-based + // policies isn't supported for IAM roles. ResourceArns []string // Specifies the type of simulation to run. Different API operations that support @@ -172,21 +157,14 @@ type SimulateCustomPolicyInput struct { // specify that volume as a resource. If the EC2 scenario includes VPC, then you // must supply the network interface resource. If it includes an IP subnet, then // you must specify the subnet resource. For more information on the EC2 scenario - // options, see Supported platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // options, see Supported platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) // in the Amazon EC2 User Guide. - // - // * EC2-VPC-InstanceStore instance, image, security - // group, network interface - // - // * EC2-VPC-InstanceStore-Subnet instance, image, - // security group, network interface, subnet - // - // * EC2-VPC-EBS instance, image, - // security group, network interface, volume - // - // * EC2-VPC-EBS-Subnet instance, image, - // security group, network interface, subnet, volume + // - EC2-VPC-InstanceStore instance, image, security group, network interface + // - EC2-VPC-InstanceStore-Subnet instance, image, security group, network + // interface, subnet + // - EC2-VPC-EBS instance, image, security group, network interface, volume + // - EC2-VPC-EBS-Subnet instance, image, security group, network interface, + // subnet, volume ResourceHandlingOption *string // An ARN representing the Amazon Web Services account ID that specifies the owner @@ -195,12 +173,12 @@ type SimulateCustomPolicyInput struct { // specified, it is also used as the account owner of any ResourcePolicy included // in the simulation. If the ResourceOwner parameter is not specified, then the // owner of the resources and the resource policy defaults to the account of the - // identity provided in CallerArn. This parameter is required only if you specify a - // resource-based policy and account that owns the resource is different from the - // account that owns the simulated calling user CallerArn. The ARN for an account - // uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to + // identity provided in CallerArn . This parameter is required only if you specify + // a resource-based policy and account that owns the resource is different from the + // account that owns the simulated calling user CallerArn . The ARN for an account + // uses the following syntax: arn:aws:iam::AWS-account-ID:root . For example, to // represent the account with the 112233445566 ID, use the following ARN: - // arn:aws:iam::112233445566-ID:root. + // arn:aws:iam::112233445566-ID:root . ResourceOwner *string // A resource-based policy to include in the simulation provided as a string. Each @@ -208,23 +186,16 @@ type SimulateCustomPolicyInput struct { // include only one resource-based policy in a simulation. The maximum length of // the policy document that you can pass in this operation, including whitespace, // is listed below. To view the maximum character counts of a managed policy with - // no whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // no whitespaces, see IAM and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) - // - // Simulation of - // resource-based policies isn't supported for IAM roles. + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) + // Simulation of resource-based policies isn't supported for IAM roles. ResourcePolicy *string noSmithyDocumentSerde @@ -241,11 +212,11 @@ type SimulateCustomPolicyOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -331,10 +302,10 @@ var _ SimulateCustomPolicyAPIClient = (*Client)(nil) type SimulateCustomPolicyPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_SimulatePrincipalPolicy.go b/service/iam/api_op_SimulatePrincipalPolicy.go index 75a011c89e5..5c111955ced 100644 --- a/service/iam/api_op_SimulatePrincipalPolicy.go +++ b/service/iam/api_op_SimulatePrincipalPolicy.go @@ -31,17 +31,16 @@ import ( // that provide details about the context of an API query request. You can use the // Condition element of an IAM policy to evaluate context keys. To get the list of // context keys that the policies require for correct simulation, use -// GetContextKeysForPrincipalPolicy. If the output is long, you can use the -// MaxItems and Marker parameters to paginate the results. The IAM policy simulator -// evaluates statements in the identity-based policy and the inputs that you -// provide during simulation. The policy simulator results can differ from your +// GetContextKeysForPrincipalPolicy . If the output is long, you can use the +// MaxItems and Marker parameters to paginate the results. The IAM policy +// simulator evaluates statements in the identity-based policy and the inputs that +// you provide during simulation. The policy simulator results can differ from your // live Amazon Web Services environment. We recommend that you check your policies // against your live Amazon Web Services environment after testing using the policy // simulator to confirm that you have the desired results. For more information // about using the policy simulator, see Testing IAM policies with the IAM policy -// simulator -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html)in -// the IAM User Guide. +// simulator (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) +// in the IAM User Guide. func (c *Client) SimulatePrincipalPolicy(ctx context.Context, params *SimulatePrincipalPolicyInput, optFns ...func(*Options)) (*SimulatePrincipalPolicyOutput, error) { if params == nil { params = &SimulatePrincipalPolicyInput{} @@ -61,42 +60,39 @@ type SimulatePrincipalPolicyInput struct { // A list of names of API operations to evaluate in the simulation. Each operation // is evaluated for each resource. Each operation must include the service - // identifier, such as iam:CreateUser. + // identifier, such as iam:CreateUser . // // This member is required. ActionNames []string - // The Amazon Resource Name (ARN) of a user, group, or role whose policies you want - // to include in the simulation. If you specify a user, group, or role, the + // The Amazon Resource Name (ARN) of a user, group, or role whose policies you + // want to include in the simulation. If you specify a user, group, or role, the // simulation includes all policies that are associated with that entity. If you // specify a user, the simulation also includes all policies that are attached to // any groups the user belongs to. The maximum length of the policy document that // you can pass in this operation, including whitespace, is listed below. To view // the maximum character counts of a managed policy with no whitespaces, see IAM - // and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. PolicySourceArn *string // The ARN of the IAM user that you want to specify as the simulated caller of the - // API operations. If you do not specify a CallerArn, it defaults to the ARN of the - // user that you specify in PolicySourceArn, if you specified a user. If you + // API operations. If you do not specify a CallerArn , it defaults to the ARN of + // the user that you specify in PolicySourceArn , if you specified a user. If you // include both a PolicySourceArn (for example, - // arn:aws:iam::123456789012:user/David) and a CallerArn (for example, - // arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the - // API operations as Bob, as if Bob had David's policies. You can specify only the - // ARN of an IAM user. You cannot specify the ARN of an assumed role, federated + // arn:aws:iam::123456789012:user/David ) and a CallerArn (for example, + // arn:aws:iam::123456789012:user/Bob ), the result is that you simulate calling + // the API operations as Bob, as if Bob had David's policies. You can specify only + // the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated // user, or a service principal. CallerArn is required if you include a // ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is // required so that the resource-based policy's Principal element has a value to // use in evaluating the policy. For more information about ARNs, see Amazon - // Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. CallerArn *string // A list of context keys and corresponding values for the simulation to use. @@ -112,10 +108,10 @@ type SimulatePrincipalPolicyInput struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. MaxItems *int32 @@ -126,58 +122,46 @@ type SimulatePrincipalPolicyInput struct { // permissions boundary is attached to an entity and you pass in a different // permissions boundary policy using this parameter, then the new permissions // boundary policy is used for the simulation. For more information about - // permissions boundaries, see Permissions boundaries for IAM entities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // permissions boundaries, see Permissions boundaries for IAM entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. The policy input is specified as a string containing the // complete, valid JSON text of a permissions boundary policy. The maximum length // of the policy document that you can pass in this operation, including // whitespace, is listed below. To view the maximum character counts of a managed - // policy with no whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // policy with no whitespaces, see IAM and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) PermissionsBoundaryPolicyInputList []string // An optional list of additional policy documents to include in the simulation. // Each document is specified as a string containing the complete, valid JSON text // of an IAM policy. The regex pattern (http://wikipedia.org/wiki/regex) used to - // validate this parameter is a string of characters consisting of the - // following: - // - // * Any printable ASCII character ranging from the space character - // (\u0020) through the end of the ASCII character range - // - // * The printable - // characters in the Basic Latin and Latin-1 Supplement character set (through - // \u00FF) - // - // * The special characters tab (\u0009), line feed (\u000A), and carriage - // return (\u000D) + // validate this parameter is a string of characters consisting of the following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) PolicyInputList []string - // A list of ARNs of Amazon Web Services resources to include in the simulation. If - // this parameter is not provided, then the value defaults to * (all resources). - // Each API in the ActionNames parameter is evaluated for each resource in this - // list. The simulation determines the access result (allowed or denied) of each - // combination and reports it in the response. You can simulate resources that - // don't exist in your account. The simulation does not automatically retrieve - // policies for the specified resources. If you want to include a resource policy - // in the simulation, then you must include the policy as a string in the - // ResourcePolicy parameter. For more information about ARNs, see Amazon Resource - // Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. Simulation of resource-based policies - // isn't supported for IAM roles. + // A list of ARNs of Amazon Web Services resources to include in the simulation. + // If this parameter is not provided, then the value defaults to * (all + // resources). Each API in the ActionNames parameter is evaluated for each + // resource in this list. The simulation determines the access result (allowed or + // denied) of each combination and reports it in the response. You can simulate + // resources that don't exist in your account. The simulation does not + // automatically retrieve policies for the specified resources. If you want to + // include a resource policy in the simulation, then you must include the policy as + // a string in the ResourcePolicy parameter. For more information about ARNs, see + // Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Simulation of resource-based + // policies isn't supported for IAM roles. ResourceArns []string // Specifies the type of simulation to run. Different API operations that support @@ -192,21 +176,14 @@ type SimulatePrincipalPolicyInput struct { // specify that volume as a resource. If the EC2 scenario includes VPC, then you // must supply the network interface resource. If it includes an IP subnet, then // you must specify the subnet resource. For more information on the EC2 scenario - // options, see Supported platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // options, see Supported platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) // in the Amazon EC2 User Guide. - // - // * EC2-VPC-InstanceStore instance, image, security - // group, network interface - // - // * EC2-VPC-InstanceStore-Subnet instance, image, - // security group, network interface, subnet - // - // * EC2-VPC-EBS instance, image, - // security group, network interface, volume - // - // * EC2-VPC-EBS-Subnet instance, image, - // security group, network interface, subnet, volume + // - EC2-VPC-InstanceStore instance, image, security group, network interface + // - EC2-VPC-InstanceStore-Subnet instance, image, security group, network + // interface, subnet + // - EC2-VPC-EBS instance, image, security group, network interface, volume + // - EC2-VPC-EBS-Subnet instance, image, security group, network interface, + // subnet, volume ResourceHandlingOption *string // An Amazon Web Services account ID that specifies the owner of any simulated @@ -215,9 +192,9 @@ type SimulatePrincipalPolicyInput struct { // is also used as the account owner of any ResourcePolicy included in the // simulation. If the ResourceOwner parameter is not specified, then the owner of // the resources and the resource policy defaults to the account of the identity - // provided in CallerArn. This parameter is required only if you specify a + // provided in CallerArn . This parameter is required only if you specify a // resource-based policy and account that owns the resource is different from the - // account that owns the simulated calling user CallerArn. + // account that owns the simulated calling user CallerArn . ResourceOwner *string // A resource-based policy to include in the simulation provided as a string. Each @@ -225,23 +202,16 @@ type SimulatePrincipalPolicyInput struct { // include only one resource-based policy in a simulation. The maximum length of // the policy document that you can pass in this operation, including whitespace, // is listed below. To view the maximum character counts of a managed policy with - // no whitespaces, see IAM and STS character quotas - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - // The regex pattern (http://wikipedia.org/wiki/regex) used to validate this + // no whitespaces, see IAM and STS character quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length) + // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this // parameter is a string of characters consisting of the following: - // - // * Any - // printable ASCII character ranging from the space character (\u0020) through the - // end of the ASCII character range - // - // * The printable characters in the Basic Latin - // and Latin-1 Supplement character set (through \u00FF) - // - // * The special characters - // tab (\u0009), line feed (\u000A), and carriage return (\u000D) - // - // Simulation of - // resource-based policies isn't supported for IAM roles. + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) + // Simulation of resource-based policies isn't supported for IAM roles. ResourcePolicy *string noSmithyDocumentSerde @@ -258,11 +228,11 @@ type SimulatePrincipalPolicyOutput struct { // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We - // recommend that you check IsTruncated after every call to ensure that you receive - // all your results. + // recommend that you check IsTruncated after every call to ensure that you + // receive all your results. IsTruncated bool - // When IsTruncated is true, this element is present and contains the value to use + // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string @@ -348,10 +318,10 @@ var _ SimulatePrincipalPolicyAPIClient = (*Client)(nil) type SimulatePrincipalPolicyPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you - // specify, the IsTruncated response element is true. If you do not include this + // specify, the IsTruncated response element is true . If you do not include this // parameter, the number of items defaults to 100. Note that IAM might return fewer // results, even when there are more results available. In that case, the - // IsTruncated response element returns true, and Marker contains a value to + // IsTruncated response element returns true , and Marker contains a value to // include in the subsequent call that tells the service where to continue from. Limit int32 diff --git a/service/iam/api_op_TagInstanceProfile.go b/service/iam/api_op_TagInstanceProfile.go index 36e0bc3bc79..b414f95441f 100644 --- a/service/iam/api_op_TagInstanceProfile.go +++ b/service/iam/api_op_TagInstanceProfile.go @@ -16,28 +16,25 @@ import ( // consists of a key name and an associated value. By assigning tags to your // resources, you can do the following: // -// * Administrative grouping and discovery - -// Attach tags to resources to aid in organization and search. For example, you -// could search for all resources with the key name Project and the value -// MyImportantProject. Or search for all resources with the key name Cost Center -// and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - Include tags in IAM user-based and -// resource-based policies. You can use tags to restrict access to only an IAM -// instance profile that has a specified tag attached. For examples of policies -// that show how to use tags to control access, see Control access using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only an IAM instance profile +// that has a specified tag attached. For examples of policies that show how to use +// tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * If any one of the tags is invalid or if you exceed the allowed -// maximum number of tags, then the entire request fails and the resource is not -// created. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagInstanceProfile(ctx context.Context, params *TagInstanceProfileInput, optFns ...func(*Options)) (*TagInstanceProfileOutput, error) { if params == nil { params = &TagInstanceProfileInput{} @@ -56,8 +53,8 @@ func (c *Client) TagInstanceProfile(ctx context.Context, params *TagInstanceProf type TagInstanceProfileInput struct { // The name of the IAM instance profile to which you want to add tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_TagMFADevice.go b/service/iam/api_op_TagMFADevice.go index 7f34aec6044..84f354a829e 100644 --- a/service/iam/api_op_TagMFADevice.go +++ b/service/iam/api_op_TagMFADevice.go @@ -16,29 +16,25 @@ import ( // overwritten with the new value. A tag consists of a key name and an associated // value. By assigning tags to your resources, you can do the following: // -// * -// Administrative grouping and discovery - Attach tags to resources to aid in -// organization and search. For example, you could search for all resources with -// the key name Project and the value MyImportantProject. Or search for all -// resources with the key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - -// Include tags in IAM user-based and resource-based policies. You can use tags to -// restrict access to only an IAM virtual MFA device that has a specified tag -// attached. For examples of policies that show how to use tags to control access, -// see Control access using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only an IAM virtual MFA device +// that has a specified tag attached. For examples of policies that show how to use +// tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * If any one of the tags is invalid or if you exceed the allowed -// maximum number of tags, then the entire request fails and the resource is not -// created. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagMFADevice(ctx context.Context, params *TagMFADeviceInput, optFns ...func(*Options)) (*TagMFADeviceOutput, error) { if params == nil { params = &TagMFADeviceInput{} @@ -58,15 +54,15 @@ type TagMFADeviceInput struct { // The unique identifier for the IAM virtual MFA device to which you want to add // tags. For virtual MFA devices, the serial number is the same as the ARN. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. SerialNumber *string - // The list of tags that you want to attach to the IAM virtual MFA device. Each tag - // consists of a key name and an associated value. + // The list of tags that you want to attach to the IAM virtual MFA device. Each + // tag consists of a key name and an associated value. // // This member is required. Tags []types.Tag diff --git a/service/iam/api_op_TagOpenIDConnectProvider.go b/service/iam/api_op_TagOpenIDConnectProvider.go index 29332d37d4c..354735c7f0c 100644 --- a/service/iam/api_op_TagOpenIDConnectProvider.go +++ b/service/iam/api_op_TagOpenIDConnectProvider.go @@ -12,35 +12,30 @@ import ( ) // Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. -// For more information about these providers, see About web identity federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html). -// If a tag with the same key name already exists, then that tag is overwritten +// For more information about these providers, see About web identity federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) +// . If a tag with the same key name already exists, then that tag is overwritten // with the new value. A tag consists of a key name and an associated value. By // assigning tags to your resources, you can do the following: // -// * Administrative -// grouping and discovery - Attach tags to resources to aid in organization and -// search. For example, you could search for all resources with the key name -// Project and the value MyImportantProject. Or search for all resources with the -// key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - Include tags in -// IAM identity-based and resource-based policies. You can use tags to restrict -// access to only an OIDC provider that has a specified tag attached. For examples -// of policies that show how to use tags to control access, see Control access -// using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM identity-based and resource-based +// policies. You can use tags to restrict access to only an OIDC provider that has +// a specified tag attached. For examples of policies that show how to use tags to +// control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * If any one of the tags is invalid or if you exceed the allowed -// maximum number of tags, then the entire request fails and the resource is not -// created. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagOpenIDConnectProvider(ctx context.Context, params *TagOpenIDConnectProviderInput, optFns ...func(*Options)) (*TagOpenIDConnectProviderOutput, error) { if params == nil { params = &TagOpenIDConnectProviderInput{} @@ -58,10 +53,11 @@ func (c *Client) TagOpenIDConnectProvider(ctx context.Context, params *TagOpenID type TagOpenIDConnectProviderInput struct { - // The ARN of the OIDC identity provider in IAM to which you want to add tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters - // with no spaces. You can also include any of the following characters: _+=,.@- + // The ARN of the OIDC identity provider in IAM to which you want to add tags. + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_TagPolicy.go b/service/iam/api_op_TagPolicy.go index c212daf0146..35022247060 100644 --- a/service/iam/api_op_TagPolicy.go +++ b/service/iam/api_op_TagPolicy.go @@ -16,28 +16,25 @@ import ( // consists of a key name and an associated value. By assigning tags to your // resources, you can do the following: // -// * Administrative grouping and discovery - -// Attach tags to resources to aid in organization and search. For example, you -// could search for all resources with the key name Project and the value -// MyImportantProject. Or search for all resources with the key name Cost Center -// and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - Include tags in IAM user-based and -// resource-based policies. You can use tags to restrict access to only an IAM -// customer managed policy that has a specified tag attached. For examples of -// policies that show how to use tags to control access, see Control access using -// IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in -// the IAM User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only an IAM customer managed +// policy that has a specified tag attached. For examples of policies that show how +// to use tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * If any one of the tags is invalid or if you exceed the -// allowed maximum number of tags, then the entire request fails and the resource -// is not created. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagPolicy(ctx context.Context, params *TagPolicyInput, optFns ...func(*Options)) (*TagPolicyOutput, error) { if params == nil { params = &TagPolicyInput{} @@ -56,8 +53,8 @@ func (c *Client) TagPolicy(ctx context.Context, params *TagPolicyInput, optFns . type TagPolicyInput struct { // The ARN of the IAM customer managed policy to which you want to add tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_TagRole.go b/service/iam/api_op_TagRole.go index bf94058d142..adbb6f9fd58 100644 --- a/service/iam/api_op_TagRole.go +++ b/service/iam/api_op_TagRole.go @@ -14,41 +14,34 @@ import ( // Adds one or more tags to an IAM role. The role can be a regular role or a // service-linked role. If a tag with the same key name already exists, then that // tag is overwritten with the new value. A tag consists of a key name and an -// associated value. By assigning tags to your resources, you can do the -// following: +// associated value. By assigning tags to your resources, you can do the following: // -// * Administrative grouping and discovery - Attach tags to resources -// to aid in organization and search. For example, you could search for all -// resources with the key name Project and the value MyImportantProject. Or search -// for all resources with the key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access -// control - Include tags in IAM user-based and resource-based policies. You can -// use tags to restrict access to only an IAM role that has a specified tag -// attached. You can also restrict access to only those resources that have a -// certain tag attached. For examples of policies that show how to use tags to -// control access, see Control access using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only an IAM role that has a +// specified tag attached. You can also restrict access to only those resources +// that have a certain tag attached. For examples of policies that show how to use +// tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * Cost allocation - Use tags to help track which individuals and -// teams are using which Amazon Web Services resources. +// - Cost allocation - Use tags to help track which individuals and teams are +// using which Amazon Web Services resources. // -// * If any one of the tags -// is invalid or if you exceed the allowed maximum number of tags, then the entire -// request fails and the resource is not created. For more information about -// tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. // -// For more -// information about tagging, see Tagging IAM identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// For more information about tagging, see Tagging IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...func(*Options)) (*TagRoleOutput, error) { if params == nil { params = &TagRoleInput{} @@ -67,15 +60,15 @@ func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...fu type TagRoleInput struct { // The name of the IAM role to which you want to add tags. This parameter accepts - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters that consist of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. RoleName *string - // The list of tags that you want to attach to the IAM role. Each tag consists of a - // key name and an associated value. + // The list of tags that you want to attach to the IAM role. Each tag consists of + // a key name and an associated value. // // This member is required. Tags []types.Tag diff --git a/service/iam/api_op_TagSAMLProvider.go b/service/iam/api_op_TagSAMLProvider.go index 8bf77dd9663..f6745d7571e 100644 --- a/service/iam/api_op_TagSAMLProvider.go +++ b/service/iam/api_op_TagSAMLProvider.go @@ -13,35 +13,30 @@ import ( // Adds one or more tags to a Security Assertion Markup Language (SAML) identity // provider. For more information about these providers, see About SAML 2.0-based -// federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html). -// If a tag with the same key name already exists, then that tag is overwritten +// federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) +// . If a tag with the same key name already exists, then that tag is overwritten // with the new value. A tag consists of a key name and an associated value. By // assigning tags to your resources, you can do the following: // -// * Administrative -// grouping and discovery - Attach tags to resources to aid in organization and -// search. For example, you could search for all resources with the key name -// Project and the value MyImportantProject. Or search for all resources with the -// key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - Include tags in -// IAM user-based and resource-based policies. You can use tags to restrict access -// to only a SAML identity provider that has a specified tag attached. For examples -// of policies that show how to use tags to control access, see Control access -// using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only a SAML identity provider +// that has a specified tag attached. For examples of policies that show how to use +// tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * If any one of the tags is invalid or if you exceed the allowed -// maximum number of tags, then the entire request fails and the resource is not -// created. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagSAMLProvider(ctx context.Context, params *TagSAMLProviderInput, optFns ...func(*Options)) (*TagSAMLProviderOutput, error) { if params == nil { params = &TagSAMLProviderInput{} @@ -59,10 +54,11 @@ func (c *Client) TagSAMLProvider(ctx context.Context, params *TagSAMLProviderInp type TagSAMLProviderInput struct { - // The ARN of the SAML identity provider in IAM to which you want to add tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters - // with no spaces. You can also include any of the following characters: _+=,.@- + // The ARN of the SAML identity provider in IAM to which you want to add tags. + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_TagServerCertificate.go b/service/iam/api_op_TagServerCertificate.go index c12e2a0f970..749d2facdc4 100644 --- a/service/iam/api_op_TagServerCertificate.go +++ b/service/iam/api_op_TagServerCertificate.go @@ -16,37 +16,32 @@ import ( // certificates in a Region supported by Certificate Manager (ACM), we recommend // that you don't use IAM server certificates. Instead, use ACM to provision, // manage, and deploy your server certificates. For more information about IAM -// server certificates, Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// server certificates, Working with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. A tag consists of a key name and an associated value. By // assigning tags to your resources, you can do the following: // -// * Administrative -// grouping and discovery - Attach tags to resources to aid in organization and -// search. For example, you could search for all resources with the key name -// Project and the value MyImportantProject. Or search for all resources with the -// key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * Access control - Include tags in -// IAM user-based and resource-based policies. You can use tags to restrict access -// to only a server certificate that has a specified tag attached. For examples of -// policies that show how to use tags to control access, see Control access using -// IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in -// the IAM User Guide. +// - Access control - Include tags in IAM user-based and resource-based +// policies. You can use tags to restrict access to only a server certificate that +// has a specified tag attached. For examples of policies that show how to use tags +// to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * Cost allocation - Use tags to help track which -// individuals and teams are using which Amazon Web Services resources. +// - Cost allocation - Use tags to help track which individuals and teams are +// using which Amazon Web Services resources. // -// * If any -// one of the tags is invalid or if you exceed the allowed maximum number of tags, -// then the entire request fails and the resource is not created. For more -// information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. func (c *Client) TagServerCertificate(ctx context.Context, params *TagServerCertificateInput, optFns ...func(*Options)) (*TagServerCertificateOutput, error) { if params == nil { params = &TagServerCertificateInput{} @@ -65,15 +60,15 @@ func (c *Client) TagServerCertificate(ctx context.Context, params *TagServerCert type TagServerCertificateInput struct { // The name of the IAM server certificate to which you want to add tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. ServerCertificateName *string - // The list of tags that you want to attach to the IAM server certificate. Each tag - // consists of a key name and an associated value. + // The list of tags that you want to attach to the IAM server certificate. Each + // tag consists of a key name and an associated value. // // This member is required. Tags []types.Tag diff --git a/service/iam/api_op_TagUser.go b/service/iam/api_op_TagUser.go index 6eca711066d..fcc375e937c 100644 --- a/service/iam/api_op_TagUser.go +++ b/service/iam/api_op_TagUser.go @@ -16,38 +16,32 @@ import ( // name and an associated value. By assigning tags to your resources, you can do // the following: // -// * Administrative grouping and discovery - Attach tags to -// resources to aid in organization and search. For example, you could search for -// all resources with the key name Project and the value MyImportantProject. Or -// search for all resources with the key name Cost Center and the value 41200. +// - Administrative grouping and discovery - Attach tags to resources to aid in +// organization and search. For example, you could search for all resources with +// the key name Project and the value MyImportantProject. Or search for all +// resources with the key name Cost Center and the value 41200. // -// * -// Access control - Include tags in IAM identity-based and resource-based policies. -// You can use tags to restrict access to only an IAM requesting user that has a -// specified tag attached. You can also restrict access to only those resources -// that have a certain tag attached. For examples of policies that show how to use -// tags to control access, see Control access using IAM tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) in the IAM -// User Guide. +// - Access control - Include tags in IAM identity-based and resource-based +// policies. You can use tags to restrict access to only an IAM requesting user +// that has a specified tag attached. You can also restrict access to only those +// resources that have a certain tag attached. For examples of policies that show +// how to use tags to control access, see Control access using IAM tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// in the IAM User Guide. // -// * Cost allocation - Use tags to help track which individuals and -// teams are using which Amazon Web Services resources. +// - Cost allocation - Use tags to help track which individuals and teams are +// using which Amazon Web Services resources. // -// * If any one of the tags -// is invalid or if you exceed the allowed maximum number of tags, then the entire -// request fails and the resource is not created. For more information about -// tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// - If any one of the tags is invalid or if you exceed the allowed maximum +// number of tags, then the entire request fails and the resource is not created. +// For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. // -// * Amazon Web Services always interprets the tag Value as a single -// string. If you need to store an array, you can store comma-separated values in -// the string. However, you must interpret the value in your code. +// - Amazon Web Services always interprets the tag Value as a single string. If +// you need to store an array, you can store comma-separated values in the string. +// However, you must interpret the value in your code. // -// For more -// information about tagging, see Tagging IAM identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// For more information about tagging, see Tagging IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) TagUser(ctx context.Context, params *TagUserInput, optFns ...func(*Options)) (*TagUserOutput, error) { if params == nil { params = &TagUserInput{} @@ -65,14 +59,14 @@ func (c *Client) TagUser(ctx context.Context, params *TagUserInput, optFns ...fu type TagUserInput struct { - // The list of tags that you want to attach to the IAM user. Each tag consists of a - // key name and an associated value. + // The list of tags that you want to attach to the IAM user. Each tag consists of + // a key name and an associated value. // // This member is required. Tags []types.Tag // The name of the IAM user to which you want to add tags. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_UntagInstanceProfile.go b/service/iam/api_op_UntagInstanceProfile.go index 56fec937ef9..ab71a8a8eeb 100644 --- a/service/iam/api_op_UntagInstanceProfile.go +++ b/service/iam/api_op_UntagInstanceProfile.go @@ -11,9 +11,8 @@ import ( ) // Removes the specified tags from the IAM instance profile. For more information -// about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagInstanceProfile(ctx context.Context, params *UntagInstanceProfileInput, optFns ...func(*Options)) (*UntagInstanceProfileOutput, error) { if params == nil { params = &UntagInstanceProfileInput{} @@ -32,8 +31,8 @@ func (c *Client) UntagInstanceProfile(ctx context.Context, params *UntagInstance type UntagInstanceProfileInput struct { // The name of the IAM instance profile from which you want to remove tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UntagMFADevice.go b/service/iam/api_op_UntagMFADevice.go index 19c64219dfc..3403b28231c 100644 --- a/service/iam/api_op_UntagMFADevice.go +++ b/service/iam/api_op_UntagMFADevice.go @@ -11,9 +11,8 @@ import ( ) // Removes the specified tags from the IAM virtual multi-factor authentication -// (MFA) device. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// (MFA) device. For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagMFADevice(ctx context.Context, params *UntagMFADeviceInput, optFns ...func(*Options)) (*UntagMFADeviceOutput, error) { if params == nil { params = &UntagMFADeviceInput{} @@ -33,10 +32,10 @@ type UntagMFADeviceInput struct { // The unique identifier for the IAM virtual MFA device from which you want to // remove tags. For virtual MFA devices, the serial number is the same as the ARN. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. SerialNumber *string diff --git a/service/iam/api_op_UntagOpenIDConnectProvider.go b/service/iam/api_op_UntagOpenIDConnectProvider.go index c079545fb5c..03790bc3a78 100644 --- a/service/iam/api_op_UntagOpenIDConnectProvider.go +++ b/service/iam/api_op_UntagOpenIDConnectProvider.go @@ -12,11 +12,9 @@ import ( // Removes the specified tags from the specified OpenID Connect (OIDC)-compatible // identity provider in IAM. For more information about OIDC providers, see About -// web identity federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html). -// For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// web identity federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) +// . For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagOpenIDConnectProvider(ctx context.Context, params *UntagOpenIDConnectProviderInput, optFns ...func(*Options)) (*UntagOpenIDConnectProviderOutput, error) { if params == nil { params = &UntagOpenIDConnectProviderInput{} @@ -35,8 +33,8 @@ func (c *Client) UntagOpenIDConnectProvider(ctx context.Context, params *UntagOp type UntagOpenIDConnectProviderInput struct { // The ARN of the OIDC provider in IAM from which you want to remove tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UntagPolicy.go b/service/iam/api_op_UntagPolicy.go index 829c61adfe3..47dea09bbe8 100644 --- a/service/iam/api_op_UntagPolicy.go +++ b/service/iam/api_op_UntagPolicy.go @@ -11,9 +11,8 @@ import ( ) // Removes the specified tags from the customer managed policy. For more -// information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagPolicy(ctx context.Context, params *UntagPolicyInput, optFns ...func(*Options)) (*UntagPolicyOutput, error) { if params == nil { params = &UntagPolicyInput{} @@ -32,10 +31,10 @@ func (c *Client) UntagPolicy(ctx context.Context, params *UntagPolicyInput, optF type UntagPolicyInput struct { // The ARN of the IAM customer managed policy from which you want to remove tags. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_UntagRole.go b/service/iam/api_op_UntagRole.go index 746f65606ea..6a59307d1aa 100644 --- a/service/iam/api_op_UntagRole.go +++ b/service/iam/api_op_UntagRole.go @@ -11,9 +11,8 @@ import ( ) // Removes the specified tags from the role. For more information about tagging, -// see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagRole(ctx context.Context, params *UntagRoleInput, optFns ...func(*Options)) (*UntagRoleOutput, error) { if params == nil { params = &UntagRoleInput{} @@ -32,7 +31,7 @@ func (c *Client) UntagRole(ctx context.Context, params *UntagRoleInput, optFns . type UntagRoleInput struct { // The name of the IAM role from which you want to remove tags. This parameter - // accepts (through its regex pattern (http://wikipedia.org/wiki/regex)) a string + // accepts (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string // of characters that consist of upper and lowercase alphanumeric characters with // no spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_UntagSAMLProvider.go b/service/iam/api_op_UntagSAMLProvider.go index b02c1341dd4..6527e2bffd0 100644 --- a/service/iam/api_op_UntagSAMLProvider.go +++ b/service/iam/api_op_UntagSAMLProvider.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified tags from the specified Security Assertion Markup Language -// (SAML) identity provider in IAM. For more information about these providers, see -// About web identity federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html). -// For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// Removes the specified tags from the specified Security Assertion Markup +// Language (SAML) identity provider in IAM. For more information about these +// providers, see About web identity federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html) +// . For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagSAMLProvider(ctx context.Context, params *UntagSAMLProviderInput, optFns ...func(*Options)) (*UntagSAMLProviderOutput, error) { if params == nil { params = &UntagSAMLProviderInput{} @@ -34,11 +32,11 @@ func (c *Client) UntagSAMLProvider(ctx context.Context, params *UntagSAMLProvide type UntagSAMLProviderInput struct { - // The ARN of the SAML identity provider in IAM from which you want to remove tags. - // This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The ARN of the SAML identity provider in IAM from which you want to remove + // tags. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_UntagServerCertificate.go b/service/iam/api_op_UntagServerCertificate.go index 2d66c5faa17..ad002a4c501 100644 --- a/service/iam/api_op_UntagServerCertificate.go +++ b/service/iam/api_op_UntagServerCertificate.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified tags from the IAM server certificate. For more information -// about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. For certificates in a Region supported by Certificate Manager (ACM), we -// recommend that you don't use IAM server certificates. Instead, use ACM to -// provision, manage, and deploy your server certificates. For more information -// about IAM server certificates, Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// Removes the specified tags from the IAM server certificate. For more +// information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. For certificates in a Region supported by Certificate +// Manager (ACM), we recommend that you don't use IAM server certificates. Instead, +// use ACM to provision, manage, and deploy your server certificates. For more +// information about IAM server certificates, Working with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. func (c *Client) UntagServerCertificate(ctx context.Context, params *UntagServerCertificateInput, optFns ...func(*Options)) (*UntagServerCertificateOutput, error) { if params == nil { @@ -37,8 +35,8 @@ func (c *Client) UntagServerCertificate(ctx context.Context, params *UntagServer type UntagServerCertificateInput struct { // The name of the IAM server certificate from which you want to remove tags. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of upper and lowercase alphanumeric characters + // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) + // a string of characters consisting of upper and lowercase alphanumeric characters // with no spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UntagUser.go b/service/iam/api_op_UntagUser.go index d9f13b1704a..69a79768a64 100644 --- a/service/iam/api_op_UntagUser.go +++ b/service/iam/api_op_UntagUser.go @@ -11,9 +11,8 @@ import ( ) // Removes the specified tags from the user. For more information about tagging, -// see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. func (c *Client) UntagUser(ctx context.Context, params *UntagUserInput, optFns ...func(*Options)) (*UntagUserOutput, error) { if params == nil { params = &UntagUserInput{} @@ -38,8 +37,8 @@ type UntagUserInput struct { TagKeys []string // The name of the IAM user from which you want to remove tags. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UpdateAccessKey.go b/service/iam/api_op_UpdateAccessKey.go index c71a9d6ef02..8d6573ef8ac 100644 --- a/service/iam/api_op_UpdateAccessKey.go +++ b/service/iam/api_op_UpdateAccessKey.go @@ -13,16 +13,15 @@ import ( // Changes the status of the specified access key from Active to Inactive, or vice // versa. This operation can be used to disable a user's key as part of a key -// rotation workflow. If the UserName is not specified, the user name is determined -// implicitly based on the Amazon Web Services access key ID used to sign the -// request. If a temporary access key is used, then UserName is required. If a -// long-term key is assigned to the user, then UserName is not required. This +// rotation workflow. If the UserName is not specified, the user name is +// determined implicitly based on the Amazon Web Services access key ID used to +// sign the request. If a temporary access key is used, then UserName is required. +// If a long-term key is assigned to the user, then UserName is not required. This // operation works for access keys under the Amazon Web Services account. // Consequently, you can use this operation to manage Amazon Web Services account // root user credentials even if the Amazon Web Services account has no associated -// users. For information about rotating keys, see Managing keys and certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html) in -// the IAM User Guide. +// users. For information about rotating keys, see Managing keys and certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html) +// in the IAM User Guide. func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInput, optFns ...func(*Options)) (*UpdateAccessKeyOutput, error) { if params == nil { params = &UpdateAccessKeyInput{} @@ -41,8 +40,8 @@ func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInp type UpdateAccessKeyInput struct { // The access key ID of the secret access key you want to update. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters that can consist of any upper or lowercased letter or digit. + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters that can consist of any upper or lowercased letter or digit. // // This member is required. AccessKeyId *string @@ -55,7 +54,7 @@ type UpdateAccessKeyInput struct { Status types.StatusType // The name of the user whose key you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_UpdateAccountPasswordPolicy.go b/service/iam/api_op_UpdateAccountPasswordPolicy.go index a8b3d3993bc..2bfb5ca2068 100644 --- a/service/iam/api_op_UpdateAccountPasswordPolicy.go +++ b/service/iam/api_op_UpdateAccountPasswordPolicy.go @@ -17,8 +17,7 @@ import ( // Also note that some parameters do not allow the default parameter to be // explicitly set. Instead, to invoke the default value, do not include that // parameter when you invoke the operation. For more information about using a -// password policy, see Managing an IAM password policy -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html) +// password policy, see Managing an IAM password policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html) // in the IAM User Guide. func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *UpdateAccountPasswordPolicyInput, optFns ...func(*Options)) (*UpdateAccountPasswordPolicyOutput, error) { if params == nil { @@ -39,10 +38,9 @@ type UpdateAccountPasswordPolicyInput struct { // Allows all IAM users in your account to use the Amazon Web Services Management // Console to change their own passwords. For more information, see Permitting IAM - // users to change their own passwords - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html) + // users to change their own passwords (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html) // in the IAM User Guide. If you do not specify a value for this parameter, then - // the operation uses the default value of false. The result is that IAM users in + // the operation uses the default value of false . The result is that IAM users in // the account do not automatically have permissions to change their own password. AllowUsersToChangePassword bool @@ -50,7 +48,7 @@ type UpdateAccountPasswordPolicyInput struct { // Management Console from setting a new console password after their password has // expired. The IAM user cannot access the console until an administrator resets // the password. If you do not specify a value for this parameter, then the - // operation uses the default value of false. The result is that IAM users can + // operation uses the default value of false . The result is that IAM users can // change their passwords after they expire and continue to sign in as the user. In // the Amazon Web Services Management Console, the custom password policy option // Allow users to change their own password gives IAM users permissions to @@ -62,43 +60,43 @@ type UpdateAccountPasswordPolicyInput struct { HardExpiry *bool // The number of days that an IAM user password is valid. If you do not specify a - // value for this parameter, then the operation uses the default value of 0. The + // value for this parameter, then the operation uses the default value of 0 . The // result is that IAM user passwords never expire. MaxPasswordAge *int32 // The minimum number of characters allowed in an IAM user password. If you do not // specify a value for this parameter, then the operation uses the default value of - // 6. + // 6 . MinimumPasswordLength *int32 // Specifies the number of previous passwords that IAM users are prevented from // reusing. If you do not specify a value for this parameter, then the operation - // uses the default value of 0. The result is that IAM users are not prevented from - // reusing previous passwords. + // uses the default value of 0 . The result is that IAM users are not prevented + // from reusing previous passwords. PasswordReusePrevention *int32 // Specifies whether IAM user passwords must contain at least one lowercase // character from the ISO basic Latin alphabet (a to z). If you do not specify a - // value for this parameter, then the operation uses the default value of false. + // value for this parameter, then the operation uses the default value of false . // The result is that passwords do not require at least one lowercase character. RequireLowercaseCharacters bool - // Specifies whether IAM user passwords must contain at least one numeric character - // (0 to 9). If you do not specify a value for this parameter, then the operation - // uses the default value of false. The result is that passwords do not require at - // least one numeric character. + // Specifies whether IAM user passwords must contain at least one numeric + // character (0 to 9). If you do not specify a value for this parameter, then the + // operation uses the default value of false . The result is that passwords do not + // require at least one numeric character. RequireNumbers bool // Specifies whether IAM user passwords must contain at least one of the following // non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' If you do // not specify a value for this parameter, then the operation uses the default - // value of false. The result is that passwords do not require at least one symbol + // value of false . The result is that passwords do not require at least one symbol // character. RequireSymbols bool // Specifies whether IAM user passwords must contain at least one uppercase // character from the ISO basic Latin alphabet (A to Z). If you do not specify a - // value for this parameter, then the operation uses the default value of false. + // value for this parameter, then the operation uses the default value of false . // The result is that passwords do not require at least one uppercase character. RequireUppercaseCharacters bool diff --git a/service/iam/api_op_UpdateAssumeRolePolicy.go b/service/iam/api_op_UpdateAssumeRolePolicy.go index 5cea308cd82..02e347bc4b0 100644 --- a/service/iam/api_op_UpdateAssumeRolePolicy.go +++ b/service/iam/api_op_UpdateAssumeRolePolicy.go @@ -12,8 +12,8 @@ import ( // Updates the policy that grants an IAM entity permission to assume a role. This // is typically referred to as the "role trust policy". For more information about -// roles, see Using roles to delegate permissions and federate identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). +// roles, see Using roles to delegate permissions and federate identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) +// . func (c *Client) UpdateAssumeRolePolicy(ctx context.Context, params *UpdateAssumeRolePolicyInput, optFns ...func(*Options)) (*UpdateAssumeRolePolicyOutput, error) { if params == nil { params = &UpdateAssumeRolePolicyInput{} @@ -31,28 +31,24 @@ func (c *Client) UpdateAssumeRolePolicy(ctx context.Context, params *UpdateAssum type UpdateAssumeRolePolicyInput struct { - // The policy that grants an entity permission to assume the role. You must provide - // policies in JSON format in IAM. However, for CloudFormation templates formatted - // in YAML, you can provide the policy in JSON or YAML format. CloudFormation - // always converts a YAML policy to JSON format before submitting it to IAM. The - // regex pattern (http://wikipedia.org/wiki/regex) used to validate this parameter - // is a string of characters consisting of the following: - // - // * Any printable ASCII - // character ranging from the space character (\u0020) through the end of the ASCII - // character range - // - // * The printable characters in the Basic Latin and Latin-1 - // Supplement character set (through \u00FF) - // - // * The special characters tab - // (\u0009), line feed (\u000A), and carriage return (\u000D) + // The policy that grants an entity permission to assume the role. You must + // provide policies in JSON format in IAM. However, for CloudFormation templates + // formatted in YAML, you can provide the policy in JSON or YAML format. + // CloudFormation always converts a YAML policy to JSON format before submitting it + // to IAM. The regex pattern (http://wikipedia.org/wiki/regex) used to validate + // this parameter is a string of characters consisting of the following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PolicyDocument *string // The name of the role to update with the new policy. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // diff --git a/service/iam/api_op_UpdateGroup.go b/service/iam/api_op_UpdateGroup.go index a9f0ffc9766..d13e0b4bb4d 100644 --- a/service/iam/api_op_UpdateGroup.go +++ b/service/iam/api_op_UpdateGroup.go @@ -12,15 +12,14 @@ import ( // Updates the name and/or the path of the specified IAM group. You should // understand the implications of changing a group's path or name. For more -// information, see Renaming users and groups -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html) +// information, see Renaming users and groups (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html) // in the IAM User Guide. The person making the request (the principal), must have // permission to change the role group with the old name and the new name. For -// example, to change the group named Managers to MGRs, the principal must have a +// example, to change the group named Managers to MGRs , the principal must have a // policy that allows them to update both groups. If the principal has permission -// to update the Managers group, but not the MGRs group, then the update fails. For -// more information about permissions, see Access management -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html). +// to update the Managers group, but not the MGRs group, then the update fails. +// For more information about permissions, see Access management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) +// . func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) { if params == nil { params = &UpdateGroupInput{} @@ -39,10 +38,10 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { // Name of the IAM group to update. If you're changing the name of the group, this - // is the original name. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // is the original name. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. GroupName *string @@ -53,11 +52,11 @@ type UpdateGroupInput struct { // "MyResource" and "myresource". NewGroupName *string - // New path for the IAM group. Only include this if changing the group's path. This - // parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a - // string of characters consisting of either a forward slash (/) by itself or a + // New path for the IAM group. Only include this if changing the group's path. + // This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a // string that must begin and end with forward slashes. In addition, it can contain - // any ASCII character from the ! (\u0021) through the DEL character (\u007F), + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), // including most punctuation characters, digits, and upper and lowercased letters. NewPath *string diff --git a/service/iam/api_op_UpdateLoginProfile.go b/service/iam/api_op_UpdateLoginProfile.go index f84d0c6730e..6737608e3c4 100644 --- a/service/iam/api_op_UpdateLoginProfile.go +++ b/service/iam/api_op_UpdateLoginProfile.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the password for the specified IAM user. You can use the CLI, the Amazon -// Web Services API, or the Users page in the IAM console to change the password -// for any IAM user. Use ChangePassword to change your own password in the My -// Security Credentials page in the Amazon Web Services Management Console. For -// more information about modifying passwords, see Managing passwords -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in -// the IAM User Guide. +// Changes the password for the specified IAM user. You can use the CLI, the +// Amazon Web Services API, or the Users page in the IAM console to change the +// password for any IAM user. Use ChangePassword to change your own password in +// the My Security Credentials page in the Amazon Web Services Management Console. +// For more information about modifying passwords, see Managing passwords (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) +// in the IAM User Guide. func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProfileInput, optFns ...func(*Options)) (*UpdateLoginProfileOutput, error) { if params == nil { params = &UpdateLoginProfileInput{} @@ -35,31 +34,25 @@ func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProf type UpdateLoginProfileInput struct { // The name of the user whose password you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. UserName *string - // The new password for the specified IAM user. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) - // - // However, the format can be further - // restricted by the account administrator by setting a password policy on the - // Amazon Web Services account. For more information, see - // UpdateAccountPasswordPolicy. + // The new password for the specified IAM user. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) + // However, the format can be further restricted by the account administrator by + // setting a password policy on the Amazon Web Services account. For more + // information, see UpdateAccountPasswordPolicy . Password *string // Allows this new password to be used only once by requiring the specified IAM diff --git a/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go b/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go index 1309b26e60a..29ed13923ac 100644 --- a/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go +++ b/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go @@ -25,8 +25,8 @@ import ( // In these cases, your legacy thumbprint remains in your configuration, but is no // longer used for validation. Trust for the OIDC provider is derived from the // provider certificate and is validated by the thumbprint. Therefore, it is best -// to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly -// privileged users. +// to limit access to the UpdateOpenIDConnectProviderThumbprint operation to +// highly privileged users. func (c *Client) UpdateOpenIDConnectProviderThumbprint(ctx context.Context, params *UpdateOpenIDConnectProviderThumbprintInput, optFns ...func(*Options)) (*UpdateOpenIDConnectProviderThumbprintOutput, error) { if params == nil { params = &UpdateOpenIDConnectProviderThumbprintInput{} @@ -47,15 +47,14 @@ type UpdateOpenIDConnectProviderThumbprintInput struct { // The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for // which you want to update the thumbprint. You can get a list of OIDC provider // ARNs by using the ListOpenIDConnectProviders operation. For more information - // about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. OpenIDConnectProviderArn *string // A list of certificate thumbprints that are associated with the specified IAM - // OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. + // OpenID Connect provider. For more information, see CreateOpenIDConnectProvider . // // This member is required. ThumbprintList []string diff --git a/service/iam/api_op_UpdateRole.go b/service/iam/api_op_UpdateRole.go index 5d29ea6d4d3..106f81731e3 100644 --- a/service/iam/api_op_UpdateRole.go +++ b/service/iam/api_op_UpdateRole.go @@ -36,19 +36,19 @@ type UpdateRoleInput struct { // The new description that you want to apply to the specified role. Description *string - // The maximum session duration (in seconds) that you want to set for the specified - // role. If you do not specify a value for this setting, the default value of one - // hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone - // who assumes the role from the CLI or API can use the DurationSeconds API - // parameter or the duration-seconds CLI parameter to request a longer session. The - // MaxSessionDuration setting determines the maximum duration that can be requested - // using the DurationSeconds parameter. If users don't specify a value for the - // DurationSeconds parameter, their security credentials are valid for one hour by - // default. This applies when you use the AssumeRole* API operations or the - // assume-role* CLI operations but does not apply when you use those operations to - // create a console URL. For more information, see Using IAM roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM - // User Guide. + // The maximum session duration (in seconds) that you want to set for the + // specified role. If you do not specify a value for this setting, the default + // value of one hour is applied. This setting can have a value from 1 hour to 12 + // hours. Anyone who assumes the role from the CLI or API can use the + // DurationSeconds API parameter or the duration-seconds CLI parameter to request + // a longer session. The MaxSessionDuration setting determines the maximum + // duration that can be requested using the DurationSeconds parameter. If users + // don't specify a value for the DurationSeconds parameter, their security + // credentials are valid for one hour by default. This applies when you use the + // AssumeRole* API operations or the assume-role* CLI operations but does not + // apply when you use those operations to create a console URL. For more + // information, see Using IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) + // in the IAM User Guide. MaxSessionDuration *int32 noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateSAMLProvider.go b/service/iam/api_op_UpdateSAMLProvider.go index 557cf50c391..1930167679f 100644 --- a/service/iam/api_op_UpdateSAMLProvider.go +++ b/service/iam/api_op_UpdateSAMLProvider.go @@ -11,8 +11,8 @@ import ( ) // Updates the metadata document for an existing SAML provider resource object. -// This operation requires Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// This operation requires Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . func (c *Client) UpdateSAMLProvider(ctx context.Context, params *UpdateSAMLProviderInput, optFns ...func(*Options)) (*UpdateSAMLProviderOutput, error) { if params == nil { params = &UpdateSAMLProviderInput{} @@ -40,9 +40,8 @@ type UpdateSAMLProviderInput struct { SAMLMetadataDocument *string // The Amazon Resource Name (ARN) of the SAML provider to update. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_UpdateSSHPublicKey.go b/service/iam/api_op_UpdateSSHPublicKey.go index 66d2b5afdfd..79e33db1999 100644 --- a/service/iam/api_op_UpdateSSHPublicKey.go +++ b/service/iam/api_op_UpdateSSHPublicKey.go @@ -17,8 +17,7 @@ import ( // flow. The SSH public key affected by this operation is used only for // authenticating the associated IAM user to an CodeCommit repository. For more // information about using SSH keys to authenticate to an CodeCommit repository, -// see Set up CodeCommit for SSH connections -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) +// see Set up CodeCommit for SSH connections (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) // in the CodeCommit User Guide. func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublicKeyInput, optFns ...func(*Options)) (*UpdateSSHPublicKeyOutput, error) { if params == nil { @@ -37,9 +36,9 @@ func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublic type UpdateSSHPublicKeyInput struct { - // The unique identifier for the SSH public key. This parameter allows (through its - // regex pattern (http://wikipedia.org/wiki/regex)) a string of characters that can - // consist of any upper or lowercased letter or digit. + // The unique identifier for the SSH public key. This parameter allows (through + // its regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // that can consist of any upper or lowercased letter or digit. // // This member is required. SSHPublicKeyId *string @@ -52,8 +51,8 @@ type UpdateSSHPublicKeyInput struct { Status types.StatusType // The name of the IAM user associated with the SSH public key. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UpdateServerCertificate.go b/service/iam/api_op_UpdateServerCertificate.go index b6ff22be3c5..65e6633acd9 100644 --- a/service/iam/api_op_UpdateServerCertificate.go +++ b/service/iam/api_op_UpdateServerCertificate.go @@ -12,22 +12,19 @@ import ( // Updates the name and/or the path of the specified server certificate stored in // IAM. For more information about working with server certificates, see Working -// with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// with server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. This topic also includes a list of Amazon Web Services // services that can use the server certificates that you manage with IAM. You // should understand the implications of changing a server certificate's path or -// name. For more information, see Renaming a server certificate -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts) +// name. For more information, see Renaming a server certificate (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts) // in the IAM User Guide. The person making the request (the principal), must have // permission to change the server certificate with the old name and the new name. -// For example, to change the certificate named ProductionCert to ProdCert, the +// For example, to change the certificate named ProductionCert to ProdCert , the // principal must have a policy that allows them to update both certificates. If // the principal has permission to update the ProductionCert group, but not the // ProdCert certificate, then the update fails. For more information about -// permissions, see Access management -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the IAM User -// Guide. +// permissions, see Access management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) +// in the IAM User Guide. func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServerCertificateInput, optFns ...func(*Options)) (*UpdateServerCertificateOutput, error) { if params == nil { params = &UpdateServerCertificateInput{} @@ -46,28 +43,27 @@ func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServ type UpdateServerCertificateInput struct { // The name of the server certificate that you want to update. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. ServerCertificateName *string // The new path for the server certificate. Include this only if you are updating - // the server certificate's path. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // the server certificate's path. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. NewPath *string // The new name for the server certificate. Include this only if you are updating // the server certificate's name. The name of the certificate cannot contain any - // spaces. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // spaces. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- NewServerCertificateName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateServiceSpecificCredential.go b/service/iam/api_op_UpdateServiceSpecificCredential.go index ef4739cb929..6b7b8eb7dcd 100644 --- a/service/iam/api_op_UpdateServiceSpecificCredential.go +++ b/service/iam/api_op_UpdateServiceSpecificCredential.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the status of a service-specific credential to Active or Inactive. +// Sets the status of a service-specific credential to Active or Inactive . // Service-specific credentials that are inactive cannot be used for authentication // to the service. This operation can be used to disable a user's service-specific // credential as part of a credential rotation work flow. @@ -33,7 +33,7 @@ func (c *Client) UpdateServiceSpecificCredential(ctx context.Context, params *Up type UpdateServiceSpecificCredentialInput struct { // The unique identifier of the service-specific credential. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters that can consist of any upper or lowercased letter or digit. // // This member is required. @@ -44,12 +44,12 @@ type UpdateServiceSpecificCredentialInput struct { // This member is required. Status types.StatusType - // The name of the IAM user associated with the service-specific credential. If you - // do not specify this value, then the operation assumes the user whose credentials - // are used to call the operation. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // The name of the IAM user associated with the service-specific credential. If + // you do not specify this value, then the operation assumes the user whose + // credentials are used to call the operation. This parameter allows (through its + // regex pattern (http://wikipedia.org/wiki/regex) ) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateSigningCertificate.go b/service/iam/api_op_UpdateSigningCertificate.go index 1098478dc92..8c199cb50d1 100644 --- a/service/iam/api_op_UpdateSigningCertificate.go +++ b/service/iam/api_op_UpdateSigningCertificate.go @@ -37,7 +37,7 @@ func (c *Client) UpdateSigningCertificate(ctx context.Context, params *UpdateSig type UpdateSigningCertificateInput struct { // The ID of the signing certificate you want to update. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters that can consist of any upper or lowercased letter or digit. // // This member is required. @@ -51,8 +51,8 @@ type UpdateSigningCertificateInput struct { Status types.StatusType // The name of the IAM user the signing certificate belongs to. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/api_op_UpdateUser.go b/service/iam/api_op_UpdateUser.go index 7dac176a186..cc010900613 100644 --- a/service/iam/api_op_UpdateUser.go +++ b/service/iam/api_op_UpdateUser.go @@ -12,16 +12,14 @@ import ( // Updates the name and/or the path of the specified IAM user. You should // understand the implications of changing an IAM user's path or name. For more -// information, see Renaming an IAM user -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming) -// and Renaming an IAM group -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html) +// information, see Renaming an IAM user (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming) +// and Renaming an IAM group (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html) // in the IAM User Guide. To change a user name, the requester must have // appropriate permissions on both the source object and the target object. For // example, to change Bob to Robert, the entity making the request must have // permission on Bob and Robert, or must have permission on all (*). For more -// information about permissions, see Permissions and policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html). +// information about permissions, see Permissions and policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html) +// . func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error) { if params == nil { params = &UpdateUserInput{} @@ -39,28 +37,27 @@ func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns type UpdateUserInput struct { - // Name of the user to update. If you're changing the name of the user, this is the - // original user name. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of upper - // and lowercase alphanumeric characters with no spaces. You can also include any - // of the following characters: _+=,.@- + // Name of the user to update. If you're changing the name of the user, this is + // the original user name. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of upper and lowercase alphanumeric + // characters with no spaces. You can also include any of the following characters: + // _+=,.@- // // This member is required. UserName *string // New path for the IAM user. Include this parameter only if you're changing the - // user's path. This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. + // user's path. This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. NewPath *string - // New name for the user. Include this parameter only if you're changing the user's - // name. IAM user, group, role, and policy names must be unique within the account. - // Names are not distinguished by case. For example, you cannot create resources - // named both "MyResource" and "myresource". + // New name for the user. Include this parameter only if you're changing the + // user's name. IAM user, group, role, and policy names must be unique within the + // account. Names are not distinguished by case. For example, you cannot create + // resources named both "MyResource" and "myresource". NewUserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UploadSSHPublicKey.go b/service/iam/api_op_UploadSSHPublicKey.go index e20bda8a869..37b40cba63d 100644 --- a/service/iam/api_op_UploadSSHPublicKey.go +++ b/service/iam/api_op_UploadSSHPublicKey.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads an SSH public key and associates it with the specified IAM user. The SSH -// public key uploaded by this operation can be used only for authenticating the -// associated IAM user to an CodeCommit repository. For more information about +// Uploads an SSH public key and associates it with the specified IAM user. The +// SSH public key uploaded by this operation can be used only for authenticating +// the associated IAM user to an CodeCommit repository. For more information about // using SSH keys to authenticate to an CodeCommit repository, see Set up -// CodeCommit for SSH connections -// (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) +// CodeCommit for SSH connections (https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html) // in the CodeCommit User Guide. func (c *Client) UploadSSHPublicKey(ctx context.Context, params *UploadSSHPublicKeyInput, optFns ...func(*Options)) (*UploadSSHPublicKeyOutput, error) { if params == nil { @@ -40,23 +39,19 @@ type UploadSSHPublicKeyInput struct { // can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long. The // regex pattern (http://wikipedia.org/wiki/regex) used to validate this parameter // is a string of characters consisting of the following: - // - // * Any printable ASCII - // character ranging from the space character (\u0020) through the end of the ASCII - // character range - // - // * The printable characters in the Basic Latin and Latin-1 - // Supplement character set (through \u00FF) - // - // * The special characters tab - // (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. SSHPublicKeyBody *string // The name of the IAM user to associate the SSH public key with. This parameter - // allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of - // characters consisting of upper and lowercase alphanumeric characters with no + // allows (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string + // of characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // // This member is required. diff --git a/service/iam/api_op_UploadServerCertificate.go b/service/iam/api_op_UploadServerCertificate.go index 38fdddc3079..00aa4bc5f68 100644 --- a/service/iam/api_op_UploadServerCertificate.go +++ b/service/iam/api_op_UploadServerCertificate.go @@ -18,24 +18,21 @@ import ( // provision, manage, and deploy your server certificates. With ACM you can request // a certificate, deploy it to Amazon Web Services resources, and let ACM handle // certificate renewals for you. Certificates provided by ACM are free. For more -// information about using ACM, see the Certificate Manager User Guide -// (https://docs.aws.amazon.com/acm/latest/userguide/). For more information about -// working with server certificates, see Working with server certificates -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// information about using ACM, see the Certificate Manager User Guide (https://docs.aws.amazon.com/acm/latest/userguide/) +// . For more information about working with server certificates, see Working with +// server certificates (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. This topic includes a list of Amazon Web Services // services that can use the server certificates that you manage with IAM. For // information about the number of server certificates you can upload, see IAM and -// STS quotas -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in -// the IAM User Guide. Because the body of the public key certificate, private key, -// and the certificate chain can be large, you should use POST rather than GET when -// calling UploadServerCertificate. For information about setting up signatures and -// authorization through the API, see Signing Amazon Web Services API requests -// (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) in -// the Amazon Web Services General Reference. For general information about using -// the Query API with IAM, see Calling the API by making HTTP query requests -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html) in the IAM -// User Guide. +// STS quotas (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) +// in the IAM User Guide. Because the body of the public key certificate, private +// key, and the certificate chain can be large, you should use POST rather than GET +// when calling UploadServerCertificate . For information about setting up +// signatures and authorization through the API, see Signing Amazon Web Services +// API requests (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) +// in the Amazon Web Services General Reference. For general information about +// using the Query API with IAM, see Calling the API by making HTTP query requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html) +// in the IAM User Guide. func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServerCertificateInput, optFns ...func(*Options)) (*UploadServerCertificateOutput, error) { if params == nil { params = &UploadServerCertificateInput{} @@ -56,40 +53,32 @@ type UploadServerCertificateInput struct { // The contents of the public key certificate in PEM-encoded format. The regex // pattern (http://wikipedia.org/wiki/regex) used to validate this parameter is a // string of characters consisting of the following: - // - // * Any printable ASCII - // character ranging from the space character (\u0020) through the end of the ASCII - // character range - // - // * The printable characters in the Basic Latin and Latin-1 - // Supplement character set (through \u00FF) - // - // * The special characters tab - // (\u0009), line feed (\u000A), and carriage return (\u000D) + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. CertificateBody *string - // The contents of the private key in PEM-encoded format. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) + // The contents of the private key in PEM-encoded format. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. PrivateKey *string // The name for the server certificate. Do not include the path in this value. The // name of the certificate cannot contain any spaces. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- // @@ -97,42 +86,37 @@ type UploadServerCertificateInput struct { ServerCertificateName *string // The contents of the certificate chain. This is typically a concatenation of the - // PEM-encoded public key certificates of the chain. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) + // PEM-encoded public key certificates of the chain. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) CertificateChain *string // The path for the server certificate. For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. This parameter is optional. If it is not included, it defaults - // to a slash (/). This parameter allows (through its regex pattern - // (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a - // forward slash (/) by itself or a string that must begin and end with forward - // slashes. In addition, it can contain any ASCII character from the ! (\u0021) - // through the DEL character (\u007F), including most punctuation characters, - // digits, and upper and lowercased letters. If you are uploading a server - // certificate specifically for use with Amazon CloudFront distributions, you must - // specify a path using the path parameter. The path must begin with /cloudfront - // and must include a trailing slash (for example, /cloudfront/test/). + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. This parameter is optional. If it is not included, it + // defaults to a slash (/). This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex) + // ) a string of characters consisting of either a forward slash (/) by itself or a + // string that must begin and end with forward slashes. In addition, it can contain + // any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), + // including most punctuation characters, digits, and upper and lowercased letters. + // If you are uploading a server certificate specifically for use with Amazon + // CloudFront distributions, you must specify a path using the path parameter. The + // path must begin with /cloudfront and must include a trailing slash (for + // example, /cloudfront/test/ ). Path *string // A list of tags that you want to attach to the new IAM server certificate // resource. Each tag consists of a key name and an associated value. For more - // information about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. If any one of the tags is invalid or if you exceed the allowed maximum - // number of tags, then the entire request fails and the resource is not created. + // information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. If any one of the tags is invalid or if you exceed the + // allowed maximum number of tags, then the entire request fails and the resource + // is not created. Tags []types.Tag noSmithyDocumentSerde @@ -145,11 +129,10 @@ type UploadServerCertificateOutput struct { // body, certificate chain, and private key. ServerCertificateMetadata *types.ServerCertificateMetadata - // A list of tags that are attached to the new IAM server certificate. The returned - // list of tags is sorted by tag key. For more information about tagging, see - // Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // A list of tags that are attached to the new IAM server certificate. The + // returned list of tags is sorted by tag key. For more information about tagging, + // see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_UploadSigningCertificate.go b/service/iam/api_op_UploadSigningCertificate.go index 98daec8a3a3..1941abe7469 100644 --- a/service/iam/api_op_UploadSigningCertificate.go +++ b/service/iam/api_op_UploadSigningCertificate.go @@ -14,24 +14,21 @@ import ( // Uploads an X.509 signing certificate and associates it with the specified IAM // user. Some Amazon Web Services services require you to use certificates to // validate requests that are signed with a corresponding private key. When you -// upload the certificate, its default status is Active. For information about when -// you would use an X.509 signing certificate, see Managing server certificates in -// IAM -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) +// upload the certificate, its default status is Active . For information about +// when you would use an X.509 signing certificate, see Managing server +// certificates in IAM (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html) // in the IAM User Guide. If the UserName is not specified, the IAM user name is // determined implicitly based on the Amazon Web Services access key ID used to // sign the request. This operation works for access keys under the Amazon Web // Services account. Consequently, you can use this operation to manage Amazon Web // Services account root user credentials even if the Amazon Web Services account // has no associated users. Because the body of an X.509 certificate can be large, -// you should use POST rather than GET when calling UploadSigningCertificate. For +// you should use POST rather than GET when calling UploadSigningCertificate . For // information about setting up signatures and authorization through the API, see -// Signing Amazon Web Services API requests -// (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) in -// the Amazon Web Services General Reference. For general information about using -// the Query API with IAM, see Making query requests -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) in the -// IAM User Guide. +// Signing Amazon Web Services API requests (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) +// in the Amazon Web Services General Reference. For general information about +// using the Query API with IAM, see Making query requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html) +// in the IAM User Guide. func (c *Client) UploadSigningCertificate(ctx context.Context, params *UploadSigningCertificateInput, optFns ...func(*Options)) (*UploadSigningCertificateOutput, error) { if params == nil { params = &UploadSigningCertificateInput{} @@ -49,25 +46,21 @@ func (c *Client) UploadSigningCertificate(ctx context.Context, params *UploadSig type UploadSigningCertificateInput struct { - // The contents of the signing certificate. The regex pattern - // (http://wikipedia.org/wiki/regex) used to validate this parameter is a string of - // characters consisting of the following: - // - // * Any printable ASCII character ranging - // from the space character (\u0020) through the end of the ASCII character - // range - // - // * The printable characters in the Basic Latin and Latin-1 Supplement - // character set (through \u00FF) - // - // * The special characters tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) + // The contents of the signing certificate. The regex pattern (http://wikipedia.org/wiki/regex) + // used to validate this parameter is a string of characters consisting of the + // following: + // - Any printable ASCII character ranging from the space character ( \u0020 ) + // through the end of the ASCII character range + // - The printable characters in the Basic Latin and Latin-1 Supplement + // character set (through \u00FF ) + // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage + // return ( \u000D ) // // This member is required. CertificateBody *string // The name of the user the signing certificate is for. This parameter allows - // (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of + // (through its regex pattern (http://wikipedia.org/wiki/regex) ) a string of // characters consisting of upper and lowercase alphanumeric characters with no // spaces. You can also include any of the following characters: _+=,.@- UserName *string diff --git a/service/iam/doc.go b/service/iam/doc.go index 7c4f6e6b4fe..c849c3b7d97 100644 --- a/service/iam/doc.go +++ b/service/iam/doc.go @@ -7,7 +7,8 @@ // service for securely controlling access to Amazon Web Services services. With // IAM, you can centrally manage users, security credentials such as access keys, // and permissions that control which Amazon Web Services resources users and -// applications can access. For more information about IAM, see Identity and Access -// Management (IAM) (http://aws.amazon.com/iam/) and the Identity and Access -// Management User Guide (https://docs.aws.amazon.com/IAM/latest/UserGuide/). +// applications can access. For more information about IAM, see Identity and +// Access Management (IAM) (http://aws.amazon.com/iam/) and the Identity and +// Access Management User Guide (https://docs.aws.amazon.com/IAM/latest/UserGuide/) +// . package iam diff --git a/service/iam/types/enums.go b/service/iam/types/enums.go index 613738022c9..0100b4f3d85 100644 --- a/service/iam/types/enums.go +++ b/service/iam/types/enums.go @@ -10,8 +10,8 @@ const ( AccessAdvisorUsageGranularityTypeActionLevel AccessAdvisorUsageGranularityType = "ACTION_LEVEL" ) -// Values returns all known values for AccessAdvisorUsageGranularityType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AccessAdvisorUsageGranularityType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AccessAdvisorUsageGranularityType) Values() []AccessAdvisorUsageGranularityType { @@ -109,9 +109,9 @@ const ( EncodingTypePem EncodingType = "PEM" ) -// Values returns all known values for EncodingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EncodingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EncodingType) Values() []EncodingType { return []EncodingType{ "SSH", @@ -188,8 +188,8 @@ const ( PermissionsBoundaryAttachmentTypePolicy PermissionsBoundaryAttachmentType = "PermissionsBoundaryPolicy" ) -// Values returns all known values for PermissionsBoundaryAttachmentType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for PermissionsBoundaryAttachmentType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (PermissionsBoundaryAttachmentType) Values() []PermissionsBoundaryAttachmentType { @@ -207,9 +207,10 @@ const ( PolicyEvaluationDecisionTypeImplicitDeny PolicyEvaluationDecisionType = "implicitDeny" ) -// Values returns all known values for PolicyEvaluationDecisionType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PolicyEvaluationDecisionType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (PolicyEvaluationDecisionType) Values() []PolicyEvaluationDecisionType { return []PolicyEvaluationDecisionType{ "allowed", @@ -227,8 +228,8 @@ const ( PolicyOwnerEntityTypeGroup PolicyOwnerEntityType = "GROUP" ) -// Values returns all known values for PolicyOwnerEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PolicyOwnerEntityType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PolicyOwnerEntityType) Values() []PolicyOwnerEntityType { return []PolicyOwnerEntityType{ diff --git a/service/iam/types/errors.go b/service/iam/types/errors.go index 32419c098ef..cf3ad6a2196 100644 --- a/service/iam/types/errors.go +++ b/service/iam/types/errors.go @@ -35,10 +35,9 @@ func (e *ConcurrentModificationException) ErrorCode() string { func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was rejected because the most recent credential report has expired. -// To generate a new credential report, use GenerateCredentialReport. For more -// information about credential report expiration, see Getting credential reports -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) in -// the IAM User Guide. +// To generate a new credential report, use GenerateCredentialReport . For more +// information about credential report expiration, see Getting credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) +// in the IAM User Guide. type CredentialReportExpiredException struct { Message *string @@ -65,7 +64,7 @@ func (e *CredentialReportExpiredException) ErrorCode() string { func (e *CredentialReportExpiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was rejected because the credential report does not exist. To -// generate a credential report, use GenerateCredentialReport. +// generate a credential report, use GenerateCredentialReport . type CredentialReportNotPresentException struct { Message *string @@ -258,8 +257,8 @@ func (e *EntityTemporarilyUnmodifiableException) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// The request was rejected because the authentication code was not recognized. The -// error message describes the specific error. +// The request was rejected because the authentication code was not recognized. +// The error message describes the specific error. type InvalidAuthenticationCodeException struct { Message *string @@ -584,8 +583,8 @@ func (e *PolicyEvaluationException) ErrorCode() string { } func (e *PolicyEvaluationException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request failed because Amazon Web Services service role policies can only be -// attached to the service-linked role for that service. +// The request failed because Amazon Web Services service role policies can only +// be attached to the service-linked role for that service. type PolicyNotAttachableException struct { Message *string diff --git a/service/iam/types/types.go b/service/iam/types/types.go index b22b4e2879e..9a14e1e198e 100644 --- a/service/iam/types/types.go +++ b/service/iam/types/types.go @@ -19,15 +19,13 @@ type AccessDetail struct { // This member is required. ServiceName *string - // The namespace of the service in which access was attempted. To learn the service - // namespace of a service, see Actions, resources, and condition keys for Amazon - // Web Services services - // (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) + // The namespace of the service in which access was attempted. To learn the + // service namespace of a service, see Actions, resources, and condition keys for + // Amazon Web Services services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) // in the Service Authorization Reference. Choose the name of the service to view // details for that service. In the first paragraph, find the service prefix. For - // example, (service prefix: a4b). For more information about service namespaces, - // see Amazon Web Services service namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // example, (service prefix: a4b) . For more information about service namespaces, + // see Amazon Web Services service namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // This member is required. @@ -37,22 +35,22 @@ type AccessDetail struct { // from which an authenticated principal last attempted to access the service. // Amazon Web Services does not report unauthenticated requests. This field is null // if no principals (IAM users, IAM roles, or root user) in the reported - // Organizations entity attempted to access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // Organizations entity attempted to access the service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . EntityPath *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when an authenticated principal most recently - // attempted to access the service. Amazon Web Services does not report - // unauthenticated requests. This field is null if no principals in the reported - // Organizations entity attempted to access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when an authenticated principal most recently attempted to access the service. + // Amazon Web Services does not report unauthenticated requests. This field is null + // if no principals in the reported Organizations entity attempted to access the + // service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAuthenticatedTime *time.Time - // The Region where the last service access attempt occurred. This field is null if - // no principals in the reported Organizations entity attempted to access the - // service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The Region where the last service access attempt occurred. This field is null + // if no principals in the reported Organizations entity attempted to access the + // service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . Region *string // The number of accounts with authenticated principals (root user, IAM users, and @@ -63,11 +61,11 @@ type AccessDetail struct { } // Contains information about an Amazon Web Services access key. This data type is -// used as a response element in the CreateAccessKey and ListAccessKeys operations. -// The SecretAccessKey value is returned only in response to CreateAccessKey. You -// can get a secret access key only when you first create an access key; you cannot -// recover the secret access key later. If you lose a secret access key, you must -// create a new access key. +// used as a response element in the CreateAccessKey and ListAccessKeys +// operations. The SecretAccessKey value is returned only in response to +// CreateAccessKey . You can get a secret access key only when you first create an +// access key; you cannot recover the secret access key later. If you lose a secret +// access key, you must create a new access key. type AccessKey struct { // The ID for this access key. @@ -102,33 +100,23 @@ type AccessKey struct { // is used as a response element in the GetAccessKeyLastUsed operation. type AccessKeyLastUsed struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the access key was most recently used. - // This field is null in the following situations: - // - // * The user does not have an - // access key. - // - // * An access key exists but has not been used since IAM began - // tracking this information. - // - // * There is no sign-in data associated with the user. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the access key was most recently used. This field is null in the + // following situations: + // - The user does not have an access key. + // - An access key exists but has not been used since IAM began tracking this + // information. + // - There is no sign-in data associated with the user. // // This member is required. LastUsedDate *time.Time - // The Amazon Web Services Region where this access key was most recently used. The - // value for this field is "N/A" in the following situations: - // - // * The user does not - // have an access key. - // - // * An access key exists but has not been used since IAM - // began tracking this information. - // - // * There is no sign-in data associated with the - // user. - // + // The Amazon Web Services Region where this access key was most recently used. + // The value for this field is "N/A" in the following situations: + // - The user does not have an access key. + // - An access key exists but has not been used since IAM began tracking this + // information. + // - There is no sign-in data associated with the user. // For more information about Amazon Web Services Regions, see Regions and // endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) in the // Amazon Web Services General Reference. @@ -138,15 +126,10 @@ type AccessKeyLastUsed struct { // The name of the Amazon Web Services service with which this access key was most // recently used. The value of this field is "N/A" in the following situations: - // - // * - // The user does not have an access key. - // - // * An access key exists but has not been - // used since IAM started tracking this information. - // - // * There is no sign-in data - // associated with the user. + // - The user does not have an access key. + // - An access key exists but has not been used since IAM started tracking this + // information. + // - There is no sign-in data associated with the user. // // This member is required. ServiceName *string @@ -154,8 +137,8 @@ type AccessKeyLastUsed struct { noSmithyDocumentSerde } -// Contains information about an Amazon Web Services access key, without its secret -// key. This data type is used as a response element in the ListAccessKeys +// Contains information about an Amazon Web Services access key, without its +// secret key. This data type is used as a response element in the ListAccessKeys // operation. type AccessKeyMetadata struct { @@ -178,8 +161,7 @@ type AccessKeyMetadata struct { // Contains information about an attached permissions boundary. An attached // permissions boundary is a managed policy that has been attached to a user or // role to set the permissions boundary. For more information about permissions -// boundaries, see Permissions boundaries for IAM identities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) +// boundaries, see Permissions boundaries for IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. type AttachedPermissionsBoundary struct { @@ -188,7 +170,7 @@ type AttachedPermissionsBoundary struct { // The permissions boundary usage type that indicates what type of IAM resource is // used as the permissions boundary for an entity. This data type can only have a - // value of Policy. + // value of Policy . PermissionsBoundaryType PermissionsBoundaryAttachmentType noSmithyDocumentSerde @@ -196,19 +178,17 @@ type AttachedPermissionsBoundary struct { // Contains information about an attached policy. An attached policy is a managed // policy that has been attached to a user, group, or role. This data type is used -// as a response element in the ListAttachedGroupPolicies, -// ListAttachedRolePolicies, ListAttachedUserPolicies, and +// as a response element in the ListAttachedGroupPolicies , +// ListAttachedRolePolicies , ListAttachedUserPolicies , and // GetAccountAuthorizationDetails operations. For more information about managed -// policies, refer to Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policies, refer to Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type AttachedPolicy struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. PolicyArn *string // The friendly name of the attached policy. @@ -221,11 +201,11 @@ type AttachedPolicy struct { // key and specifies the value (or values, if the context key supports multiple // values) to use in the simulation. This information is used when evaluating the // Condition elements of the input policies. This data type is used as an input -// parameter to SimulateCustomPolicy and SimulatePrincipalPolicy. +// parameter to SimulateCustomPolicy and SimulatePrincipalPolicy . type ContextEntry struct { // The full name of a condition context key, including the service prefix. For - // example, aws:SourceIp or s3:VersionId. + // example, aws:SourceIp or s3:VersionId . ContextKeyName *string // The data type of the value (or values) specified in the ContextKeyValues @@ -269,26 +249,24 @@ type EntityDetails struct { // This member is required. EntityInfo *EntityInfo - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the authenticated entity last attempted - // to access Amazon Web Services. Amazon Web Services does not report - // unauthenticated requests. This field is null if no IAM entities attempted to - // access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the authenticated entity last attempted to access Amazon Web Services. + // Amazon Web Services does not report unauthenticated requests. This field is null + // if no IAM entities attempted to access the service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAuthenticated *time.Time noSmithyDocumentSerde } -// Contains details about the specified entity (user or role). This data type is an -// element of the EntityDetails object. +// Contains details about the specified entity (user or role). This data type is +// an element of the EntityDetails object. type EntityInfo struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. Arn *string @@ -308,18 +286,17 @@ type EntityInfo struct { // This member is required. Type PolicyOwnerEntityType - // The path to the entity (user or role). For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the entity (user or role). For more information about paths, see + // IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string noSmithyDocumentSerde } // Contains information about the reason that the operation failed. This data type -// is used as a response element in the GetOrganizationsAccessReport, -// GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities +// is used as a response element in the GetOrganizationsAccessReport , +// GetServiceLastAccessedDetails , and GetServiceLastAccessedDetailsWithEntities // operations. type ErrorDetails struct { @@ -337,7 +314,7 @@ type ErrorDetails struct { } // Contains the results of a simulation. This data type is used by the return -// parameter of SimulateCustomPolicy and SimulatePrincipalPolicy. +// parameter of SimulateCustomPolicy and SimulatePrincipalPolicy . type EvaluationResult struct { // The name of the API operation tested on the indicated resource. @@ -356,15 +333,14 @@ type EvaluationResult struct { // decision. If the simulation evaluates policies within the same account and // includes a resource ARN, then the parameter is present but the response is // empty. If the simulation evaluates policies within the same account and - // specifies all resources (*), then the parameter is not returned. When you make a - // cross-account request, Amazon Web Services evaluates the request in the trusting - // account and the trusted account. The request is allowed only if both evaluations - // return true. For more information about how policies are evaluated, see - // Evaluating policies within a single account - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics). - // If an Organizations SCP included in the evaluation denies access, the simulation - // ends. In this case, policy evaluation does not proceed any further and this - // parameter is not returned. + // specifies all resources ( * ), then the parameter is not returned. When you make + // a cross-account request, Amazon Web Services evaluates the request in the + // trusting account and the trusted account. The request is allowed only if both + // evaluations return true . For more information about how policies are evaluated, + // see Evaluating policies within a single account (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics) + // . If an Organizations SCP included in the evaluation denies access, the + // simulation ends. In this case, policy evaluation does not proceed any further + // and this parameter is not returned. EvalDecisionDetails map[string]PolicyEvaluationDecisionType // The ARN of the resource that the indicated API operation was tested on. @@ -377,13 +353,13 @@ type EvaluationResult struct { // included in the result. MatchedStatements []Statement - // A list of context keys that are required by the included input policies but that - // were not provided by one of the input parameters. This list is used when the - // resource in a simulation is "*", either explicitly, or when the ResourceArns + // A list of context keys that are required by the included input policies but + // that were not provided by one of the input parameters. This list is used when + // the resource in a simulation is "*", either explicitly, or when the ResourceArns // parameter blank. If you include a list of resources, then any missing context // values are instead included under the ResourceSpecificResults section. To // discover the context keys used by a set of policies, you can call - // GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. + // GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy . MissingContextValues []string // A structure that details how Organizations and its service control policies @@ -404,33 +380,27 @@ type EvaluationResult struct { // Contains information about an IAM group entity. This data type is used as a // response element in the following operations: -// -// * CreateGroup -// -// * GetGroup -// -// * -// ListGroups +// - CreateGroup +// - GetGroup +// - ListGroups type Group struct { // The Amazon Resource Name (ARN) specifying the group. For more information about - // ARNs and how to use them in policies, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // ARNs and how to use them in policies, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the group was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the group was created. // // This member is required. CreateDate *time.Time // The stable and unique string identifying the group. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. GroupId *string @@ -440,9 +410,8 @@ type Group struct { // This member is required. GroupName *string - // The path to the group. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the group. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Path *string @@ -456,23 +425,21 @@ type Group struct { type GroupDetail struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // A list of the managed policies attached to the group. AttachedManagedPolicies []AttachedPolicy - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the group was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the group was created. CreateDate *time.Time // The stable and unique string identifying the group. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. GroupId *string // The friendly name that identifies the group. @@ -481,9 +448,8 @@ type GroupDetail struct { // A list of the inline policies embedded in the group. GroupPolicyList []PolicyDetail - // The path to the group. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the group. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string noSmithyDocumentSerde @@ -491,21 +457,15 @@ type GroupDetail struct { // Contains information about an instance profile. This data type is used as a // response element in the following operations: -// -// * CreateInstanceProfile -// -// * -// GetInstanceProfile -// -// * ListInstanceProfiles -// -// * ListInstanceProfilesForRole +// - CreateInstanceProfile +// - GetInstanceProfile +// - ListInstanceProfiles +// - ListInstanceProfilesForRole type InstanceProfile struct { // The Amazon Resource Name (ARN) specifying the instance profile. For more - // information about ARNs and how to use them in policies, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // information about ARNs and how to use them in policies, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string @@ -516,9 +476,8 @@ type InstanceProfile struct { CreateDate *time.Time // The stable and unique string identifying the instance profile. For more - // information about IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // information about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. InstanceProfileId *string @@ -529,9 +488,8 @@ type InstanceProfile struct { InstanceProfileName *string // The path to the instance profile. For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Path *string @@ -542,9 +500,8 @@ type InstanceProfile struct { Roles []Role // A list of tags that are attached to the instance profile. For more information - // about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag noSmithyDocumentSerde @@ -559,14 +516,12 @@ type ListPoliciesGrantingServiceAccessEntry struct { Policies []PolicyGrantingServiceAccess // The namespace of the service that was accessed. To learn the service namespace - // of a service, see Actions, resources, and condition keys for Amazon Web Services - // services - // (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) + // of a service, see Actions, resources, and condition keys for Amazon Web + // Services services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) // in the Service Authorization Reference. Choose the name of the service to view // details for that service. In the first paragraph, find the service prefix. For - // example, (service prefix: a4b). For more information about service namespaces, - // see Amazon Web Services service namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // example, (service prefix: a4b) . For more information about service namespaces, + // see Amazon Web Services service namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string @@ -599,30 +554,27 @@ type LoginProfile struct { // versions, and the number of principal entities (users, groups, and roles) that // the policy is attached to. This data type is used as a response element in the // GetAccountAuthorizationDetails operation. For more information about managed -// policies, see Managed policies and inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policies, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type ManagedPolicyDetail struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The number of principal entities (users, groups, and roles) that the policy is // attached to. AttachmentCount *int32 - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the policy was created. CreateDate *time.Time // The identifier for the version of the policy that is set as the default // (operative) version. For more information about policy versions, see Versioning - // for managed policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) + // for managed policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) // in the IAM User Guide. DefaultVersionId *string @@ -632,22 +584,19 @@ type ManagedPolicyDetail struct { // Specifies whether the policy can be attached to an IAM user, group, or role. IsAttachable bool - // The path to the policy. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the policy. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string // The number of entities (users and roles) for which the policy is used as the // permissions boundary. For more information about permissions boundaries, see - // Permissions boundaries for IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // Permissions boundaries for IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundaryUsageCount *int32 // The stable and unique string identifying the policy. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. PolicyId *string // The friendly name (not ARN) identifying the policy. @@ -656,11 +605,11 @@ type ManagedPolicyDetail struct { // A list containing information about the versions of the policy. PolicyVersionList []PolicyVersion - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy was last updated. When a - // policy has only one version, this field contains the date and time when the - // policy was created. When a policy has more than one version, this field contains - // the date and time when the most recent policy version was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the policy was last updated. When a policy has only one version, this + // field contains the date and time when the policy was created. When a policy has + // more than one version, this field contains the date and time when the most + // recent policy version was created. UpdateDate *time.Time noSmithyDocumentSerde @@ -693,10 +642,9 @@ type MFADevice struct { type OpenIDConnectProviderListEntry struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string noSmithyDocumentSerde @@ -750,8 +698,8 @@ type PasswordPolicy struct { // character (a to z). RequireLowercaseCharacters bool - // Specifies whether IAM user passwords must contain at least one numeric character - // (0 to 9). + // Specifies whether IAM user passwords must contain at least one numeric + // character (0 to 9). RequireNumbers bool // Specifies whether IAM user passwords must contain at least one of the following @@ -769,40 +717,38 @@ type PasswordPolicy struct { // policy simulation when the boundary is applied to an IAM entity. type PermissionsBoundaryDecisionDetail struct { - // Specifies whether an action is allowed by a permissions boundary that is applied - // to an IAM entity (user or role). A value of true means that the permissions - // boundary does not deny the action. This means that the policy includes an Allow - // statement that matches the request. In this case, if an identity-based policy - // also allows the action, the request is allowed. A value of false means that - // either the requested action is not allowed (implicitly denied) or that the - // action is explicitly denied by the permissions boundary. In both of these cases, - // the action is not allowed, regardless of the identity-based policy. + // Specifies whether an action is allowed by a permissions boundary that is + // applied to an IAM entity (user or role). A value of true means that the + // permissions boundary does not deny the action. This means that the policy + // includes an Allow statement that matches the request. In this case, if an + // identity-based policy also allows the action, the request is allowed. A value of + // false means that either the requested action is not allowed (implicitly denied) + // or that the action is explicitly denied by the permissions boundary. In both of + // these cases, the action is not allowed, regardless of the identity-based policy. AllowedByPermissionsBoundary bool noSmithyDocumentSerde } // Contains information about a managed policy. This data type is used as a -// response element in the CreatePolicy, GetPolicy, and ListPolicies operations. +// response element in the CreatePolicy , GetPolicy , and ListPolicies operations. // For more information about managed policies, refer to Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type Policy struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The number of entities (users, groups, and roles) that the policy is attached // to. AttachmentCount *int32 - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the policy was created. CreateDate *time.Time // The identifier for the version of the policy that is set as the default version. @@ -816,38 +762,34 @@ type Policy struct { // Specifies whether the policy can be attached to an IAM user, group, or role. IsAttachable bool - // The path to the policy. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the policy. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string - // The number of entities (users and roles) for which the policy is used to set the - // permissions boundary. For more information about permissions boundaries, see - // Permissions boundaries for IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // The number of entities (users and roles) for which the policy is used to set + // the permissions boundary. For more information about permissions boundaries, see + // Permissions boundaries for IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundaryUsageCount *int32 // The stable and unique string identifying the policy. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. PolicyId *string // The friendly name (not ARN) identifying the policy. PolicyName *string // A list of tags that are attached to the instance profile. For more information - // about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy was last updated. When a - // policy has only one version, this field contains the date and time when the - // policy was created. When a policy has more than one version, this field contains - // the date and time when the most recent policy version was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the policy was last updated. When a policy has only one version, this + // field contains the date and time when the policy was created. When a policy has + // more than one version, this field contains the date and time when the most + // recent policy version was created. UpdateDate *time.Time noSmithyDocumentSerde @@ -878,8 +820,7 @@ type PolicyGrantingServiceAccess struct { PolicyName *string // The policy type. For more information about these policy types, see Managed - // policies and inline policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) + // policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) // in the IAM User Guide. // // This member is required. @@ -887,24 +828,21 @@ type PolicyGrantingServiceAccess struct { // The name of the entity (user or role) to which the inline policy is attached. // This field is null for managed policies. For more information about these policy - // types, see Managed policies and inline policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) + // types, see Managed policies and inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) // in the IAM User Guide. EntityName *string // The type of entity (user or role) that used the policy to access the service to // which the inline policy is attached. This field is null for managed policies. // For more information about these policy types, see Managed policies and inline - // policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) + // policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html) // in the IAM User Guide. EntityType PolicyOwnerEntityType // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. PolicyArn *string noSmithyDocumentSerde @@ -913,15 +851,13 @@ type PolicyGrantingServiceAccess struct { // Contains information about a group that a managed policy is attached to. This // data type is used as a response element in the ListEntitiesForPolicy operation. // For more information about managed policies, refer to Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type PolicyGroup struct { // The stable and unique string identifying the group. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. GroupId *string // The name (friendly name, not ARN) identifying the group. @@ -933,15 +869,13 @@ type PolicyGroup struct { // Contains information about a role that a managed policy is attached to. This // data type is used as a response element in the ListEntitiesForPolicy operation. // For more information about managed policies, refer to Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type PolicyRole struct { // The stable and unique string identifying the role. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. RoleId *string // The name (friendly name, not ARN) identifying the role. @@ -953,15 +887,13 @@ type PolicyRole struct { // Contains information about a user that a managed policy is attached to. This // data type is used as a response element in the ListEntitiesForPolicy operation. // For more information about managed policies, refer to Managed policies and -// inline policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// inline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type PolicyUser struct { // The stable and unique string identifying the user. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. UserId *string // The name (friendly name, not ARN) identifying the user. @@ -970,35 +902,35 @@ type PolicyUser struct { noSmithyDocumentSerde } -// Contains information about a version of a managed policy. This data type is used -// as a response element in the CreatePolicyVersion, GetPolicyVersion, -// ListPolicyVersions, and GetAccountAuthorizationDetails operations. For more +// Contains information about a version of a managed policy. This data type is +// used as a response element in the CreatePolicyVersion , GetPolicyVersion , +// ListPolicyVersions , and GetAccountAuthorizationDetails operations. For more // information about managed policies, refer to Managed policies and inline -// policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) +// policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) // in the IAM User Guide. type PolicyVersion struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the policy version was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the policy version was created. CreateDate *time.Time // The policy document. The policy document is returned in the response to the // GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not // returned in the response to the CreatePolicyVersion or ListPolicyVersions // operations. The policy document returned in this structure is URL-encoded - // compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986). You can use a URL - // decoding method to convert the policy back to plain JSON text. For example, if - // you use Java, you can use the decode method of the java.net.URLDecoder utility - // class in the Java SDK. Other languages and SDKs provide similar functionality. + // compliant with RFC 3986 (https://tools.ietf.org/html/rfc3986) . You can use a + // URL decoding method to convert the policy back to plain JSON text. For example, + // if you use Java, you can use the decode method of the java.net.URLDecoder + // utility class in the Java SDK. Other languages and SDKs provide similar + // functionality. Document *string // Specifies whether the policy version is set as the policy's default version. IsDefaultVersion bool // The identifier for the policy version. Policy version identifiers always begin - // with v (always lowercase). When a policy is created, the first policy version is - // v1. + // with v (always lowercase). When a policy is created, the first policy version + // is v1 . VersionId *string noSmithyDocumentSerde @@ -1017,12 +949,13 @@ type Position struct { noSmithyDocumentSerde } -// Contains the result of the simulation of a single API operation call on a single -// resource. This data type is used by a member of the EvaluationResult data type. +// Contains the result of the simulation of a single API operation call on a +// single resource. This data type is used by a member of the EvaluationResult +// data type. type ResourceSpecificResult struct { // The result of the simulation of the simulated API operation on the resource - // specified in EvalResourceName. + // specified in EvalResourceName . // // This member is required. EvalResourceDecision PolicyEvaluationDecisionType @@ -1045,14 +978,14 @@ type ResourceSpecificResult struct { // entry included in the result. MatchedStatements []Statement - // A list of context keys that are required by the included input policies but that - // were not provided by one of the input parameters. This list is used when a list - // of ARNs is included in the ResourceArns parameter instead of "*". If you do not - // specify individual resources, by setting ResourceArns to "*" or by not including - // the ResourceArns parameter, then any missing context values are instead included - // under the EvaluationResults section. To discover the context keys used by a set - // of policies, you can call GetContextKeysForCustomPolicy or - // GetContextKeysForPrincipalPolicy. + // A list of context keys that are required by the included input policies but + // that were not provided by one of the input parameters. This list is used when a + // list of ARNs is included in the ResourceArns parameter instead of "*". If you + // do not specify individual resources, by setting ResourceArns to "*" or by not + // including the ResourceArns parameter, then any missing context values are + // instead included under the EvaluationResults section. To discover the context + // keys used by a set of policies, you can call GetContextKeysForCustomPolicy or + // GetContextKeysForPrincipalPolicy . MissingContextValues []string // Contains information about the effect that a permissions boundary has on a @@ -1062,35 +995,32 @@ type ResourceSpecificResult struct { noSmithyDocumentSerde } -// Contains information about an IAM role. This structure is returned as a response -// element in several API operations that interact with roles. +// Contains information about an IAM role. This structure is returned as a +// response element in several API operations that interact with roles. type Role struct { // The Amazon Resource Name (ARN) specifying the role. For more information about - // ARNs and how to use them in policies, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide guide. + // ARNs and how to use them in policies, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide guide. // // This member is required. Arn *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the role was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the role was created. // // This member is required. CreateDate *time.Time - // The path to the role. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the role. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Path *string // The stable and unique string identifying the role. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. RoleId *string @@ -1113,8 +1043,7 @@ type Role struct { // The ARN of the policy used to set the permissions boundary for the role. For // more information about permissions boundaries, see Permissions boundaries for - // IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary @@ -1123,15 +1052,13 @@ type Role struct { // Activity is only reported for the trailing 400 days. This period can be shorter // if your Region began supporting these features within the last year. The role // might have been used more than 400 days ago. For more information, see Regions - // where data is tracked - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) + // where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) // in the IAM user Guide. RoleLastUsed *RoleLastUsed // A list of tags that are attached to the role. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag noSmithyDocumentSerde @@ -1143,10 +1070,9 @@ type Role struct { type RoleDetail struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The trust policy that grants permission to assume the role. @@ -1156,29 +1082,26 @@ type RoleDetail struct { // access (permissions) policies. AttachedManagedPolicies []AttachedPolicy - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the role was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the role was created. CreateDate *time.Time // A list of instance profiles that contain this role. InstanceProfileList []InstanceProfile - // The path to the role. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the role. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string // The ARN of the policy used to set the permissions boundary for the role. For // more information about permissions boundaries, see Permissions boundaries for - // IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary // The stable and unique string identifying the role. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. RoleId *string // Contains information about the last time that an IAM role was used. This @@ -1186,8 +1109,7 @@ type RoleDetail struct { // Activity is only reported for the trailing 400 days. This period can be shorter // if your Region began supporting these features within the last year. The role // might have been used more than 400 days ago. For more information, see Regions - // where data is tracked - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) + // where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) // in the IAM User Guide. RoleLastUsed *RoleLastUsed @@ -1199,9 +1121,8 @@ type RoleDetail struct { RolePolicyList []PolicyDetail // A list of tags that are attached to the role. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag noSmithyDocumentSerde @@ -1212,8 +1133,7 @@ type RoleDetail struct { // Activity is only reported for the trailing 400 days. This period can be shorter // if your Region began supporting these features within the last year. The role // might have been used more than 400 days ago. For more information, see Regions -// where data is tracked -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) +// where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) // in the IAM user Guide. This data type is returned as a response element in the // GetRole and GetAccountAuthorizationDetails operations. type RoleLastUsed struct { @@ -1221,8 +1141,7 @@ type RoleLastUsed struct { // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) // that the role was last used. This field is null if the role has not been used // within the IAM tracking period. For more information about the tracking period, - // see Regions where data is tracked - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) + // see Regions where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) // in the IAM User Guide. LastUsedDate *time.Time @@ -1232,9 +1151,9 @@ type RoleLastUsed struct { noSmithyDocumentSerde } -// An object that contains details about how a service-linked role is used, if that -// information is returned by the service. This data type is used as a response -// element in the GetServiceLinkedRoleDeletionStatus operation. +// An object that contains details about how a service-linked role is used, if +// that information is returned by the service. This data type is used as a +// response element in the GetServiceLinkedRoleDeletionStatus operation. type RoleUsageType struct { // The name of the Region where the service-linked role is being used. @@ -1279,10 +1198,9 @@ type ServerCertificate struct { // The contents of the public key certificate chain. CertificateChain *string - // A list of tags that are attached to the server certificate. For more information - // about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // A list of tags that are attached to the server certificate. For more + // information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag noSmithyDocumentSerde @@ -1294,25 +1212,22 @@ type ServerCertificate struct { type ServerCertificateMetadata struct { // The Amazon Resource Name (ARN) specifying the server certificate. For more - // information about ARNs and how to use them in policies, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // information about ARNs and how to use them in policies, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string // The path to the server certificate. For more information about paths, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Path *string // The stable and unique string identifying the server certificate. For more - // information about IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // information about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. ServerCertificateId *string @@ -1341,56 +1256,52 @@ type ServiceLastAccessed struct { // This member is required. ServiceName *string - // The namespace of the service in which access was attempted. To learn the service - // namespace of a service, see Actions, resources, and condition keys for Amazon - // Web Services services - // (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) + // The namespace of the service in which access was attempted. To learn the + // service namespace of a service, see Actions, resources, and condition keys for + // Amazon Web Services services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) // in the Service Authorization Reference. Choose the name of the service to view // details for that service. In the first paragraph, find the service prefix. For - // example, (service prefix: a4b). For more information about service namespaces, - // see Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // example, (service prefix: a4b) . For more information about service namespaces, + // see Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. // // This member is required. ServiceNamespace *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently - // attempted to access the service. Amazon Web Services does not report - // unauthenticated requests. This field is null if no IAM entities attempted to - // access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when an authenticated entity most recently attempted to access the service. + // Amazon Web Services does not report unauthenticated requests. This field is null + // if no IAM entities attempted to access the service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAuthenticated *time.Time - // The ARN of the authenticated entity (user or role) that last attempted to access - // the service. Amazon Web Services does not report unauthenticated requests. This - // field is null if no IAM entities attempted to access the service within the - // tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The ARN of the authenticated entity (user or role) that last attempted to + // access the service. Amazon Web Services does not report unauthenticated + // requests. This field is null if no IAM entities attempted to access the service + // within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAuthenticatedEntity *string // The Region from which the authenticated entity (user or role) last attempted to // access the service. Amazon Web Services does not report unauthenticated // requests. This field is null if no IAM entities attempted to access the service - // within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAuthenticatedRegion *string // The total number of authenticated principals (root user, IAM users, or IAM // roles) that have attempted to access the service. This field is null if no - // principals attempted to access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // principals attempted to access the service within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . TotalAuthenticatedEntities *int32 // An object that contains details about the most recent attempt to access a // tracked action within the service. This field is null if there no tracked // actions or if the principal did not use the tracked actions within the tracking - // period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). - // This field is also null if the report was generated at the service level and not - // the action level. For more information, see the Granularity field in - // GenerateServiceLastAccessedDetails. + // period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . This field is also null if the report was generated at the service level and + // not the action level. For more information, see the Granularity field in + // GenerateServiceLastAccessedDetails . TrackedActionsLastAccessed []TrackedActionLastAccessed noSmithyDocumentSerde @@ -1399,9 +1310,8 @@ type ServiceLastAccessed struct { // Contains the details of a service-specific credential. type ServiceSpecificCredential struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the service-specific credential were - // created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the service-specific credential were created. // // This member is required. CreateDate *time.Time @@ -1423,8 +1333,8 @@ type ServiceSpecificCredential struct { // The generated user name for the service-specific credential. This value is // generated by combining the IAM user's name combined with the ID number of the - // Amazon Web Services account, as in jane-at-123456789012, for example. This value - // cannot be configured by the user. + // Amazon Web Services account, as in jane-at-123456789012 , for example. This + // value cannot be configured by the user. // // This member is required. ServiceUserName *string @@ -1446,9 +1356,8 @@ type ServiceSpecificCredential struct { // Contains additional details about a service-specific credential. type ServiceSpecificCredentialMetadata struct { - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the service-specific credential were - // created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the service-specific credential were created. // // This member is required. CreateDate *time.Time @@ -1534,8 +1443,8 @@ type SSHPublicKey struct { SSHPublicKeyId *string // The status of the SSH public key. Active means that the key can be used for - // authentication with an CodeCommit repository. Inactive means that the key cannot - // be used. + // authentication with an CodeCommit repository. Inactive means that the key + // cannot be used. // // This member is required. Status StatusType @@ -1545,8 +1454,8 @@ type SSHPublicKey struct { // This member is required. UserName *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the SSH public key was uploaded. UploadDate *time.Time noSmithyDocumentSerde @@ -1563,14 +1472,14 @@ type SSHPublicKeyMetadata struct { SSHPublicKeyId *string // The status of the SSH public key. Active means that the key can be used for - // authentication with an CodeCommit repository. Inactive means that the key cannot - // be used. + // authentication with an CodeCommit repository. Inactive means that the key + // cannot be used. // // This member is required. Status StatusType - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the SSH public key was uploaded. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the SSH public key was uploaded. // // This member is required. UploadDate *time.Time @@ -1583,9 +1492,9 @@ type SSHPublicKeyMetadata struct { noSmithyDocumentSerde } -// Contains a reference to a Statement element in a policy document that determines -// the result of the simulation. This data type is used by the MatchedStatements -// member of the EvaluationResult type. +// Contains a reference to a Statement element in a policy document that +// determines the result of the simulation. This data type is used by the +// MatchedStatements member of the EvaluationResult type. type Statement struct { // The row and column of the end of a Statement in an IAM policy. @@ -1604,9 +1513,8 @@ type Statement struct { } // A structure that represents user-provided metadata that can be associated with -// an IAM resource. For more information about tagging, see Tagging IAM resources -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User -// Guide. +// an IAM resource. For more information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) +// in the IAM User Guide. type Tag struct { // The key name that can be used to look up or retrieve the associated value. For @@ -1616,13 +1524,13 @@ type Tag struct { Key *string // The value associated with this tag. For example, tags with a key name of - // Department could have values such as Human Resources, Accounting, and Support. - // Tags with a key name of Cost Center might have values that consist of the number - // associated with the different cost centers in your company. Typically, many - // resources have tags with the same key name but with different values. Amazon Web - // Services always interprets the tag Value as a single string. If you need to - // store an array, you can store comma-separated values in the string. However, you - // must interpret the value in your code. + // Department could have values such as Human Resources , Accounting , and Support + // . Tags with a key name of Cost Center might have values that consist of the + // number associated with the different cost centers in your company. Typically, + // many resources have tags with the same key name but with different values. + // Amazon Web Services always interprets the tag Value as a single string. If you + // need to store an array, you can store comma-separated values in the string. + // However, you must interpret the value in your code. // // This member is required. Value *string @@ -1640,25 +1548,24 @@ type TrackedActionLastAccessed struct { ActionName *string // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. LastAccessedEntity *string // The Region from which the authenticated entity (user or role) last attempted to // access the tracked action. Amazon Web Services does not report unauthenticated // requests. This field is null if no IAM entities attempted to access the service - // within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // within the tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAccessedRegion *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when an authenticated entity most recently - // attempted to access the tracked service. Amazon Web Services does not report - // unauthenticated requests. This field is null if no IAM entities attempted to - // access the service within the tracking period - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period). + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when an authenticated entity most recently attempted to access the tracked + // service. Amazon Web Services does not report unauthenticated requests. This + // field is null if no IAM entities attempted to access the service within the + // tracking period (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period) + // . LastAccessedTime *time.Time noSmithyDocumentSerde @@ -1666,41 +1573,34 @@ type TrackedActionLastAccessed struct { // Contains information about an IAM user entity. This data type is used as a // response element in the following operations: -// -// * CreateUser -// -// * GetUser -// -// * -// ListUsers +// - CreateUser +// - GetUser +// - ListUsers type User struct { // The Amazon Resource Name (ARN) that identifies the user. For more information - // about ARNs and how to use ARNs in policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // about ARNs and how to use ARNs in policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the user was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the user was created. // // This member is required. CreateDate *time.Time - // The path to the user. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. The ARN of the policy used to set the permissions boundary for - // the user. + // The path to the user. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. The ARN of the policy used to set the permissions + // boundary for the user. // // This member is required. Path *string // The stable and unique string identifying the user. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. // // This member is required. UserId *string @@ -1710,38 +1610,31 @@ type User struct { // This member is required. UserName *string - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the user's password was last used to sign - // in to an Amazon Web Services website. For a list of Amazon Web Services websites - // that capture a user's last sign-in time, see the Credential reports - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) topic - // in the IAM User Guide. If a password is used more than once in a five-minute - // span, only the first use is returned in this field. If the field is null (no - // value), then it indicates that they never signed in with a password. This can be - // because: - // - // * The user never had a password. - // - // * A password exists but has not been - // used since IAM started tracking this information on October 20, 2014. - // - // A null - // value does not mean that the user never had a password. Also, if the user does - // not currently have a password but had one in the past, then this field contains - // the date and time the most recent password was used. This value is returned only - // in the GetUser and ListUsers operations. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the user's password was last used to sign in to an Amazon Web Services + // website. For a list of Amazon Web Services websites that capture a user's last + // sign-in time, see the Credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html) + // topic in the IAM User Guide. If a password is used more than once in a + // five-minute span, only the first use is returned in this field. If the field is + // null (no value), then it indicates that they never signed in with a password. + // This can be because: + // - The user never had a password. + // - A password exists but has not been used since IAM started tracking this + // information on October 20, 2014. + // A null value does not mean that the user never had a password. Also, if the + // user does not currently have a password but had one in the past, then this field + // contains the date and time the most recent password was used. This value is + // returned only in the GetUser and ListUsers operations. PasswordLastUsed *time.Time // For more information about permissions boundaries, see Permissions boundaries - // for IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // for IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary // A list of tags that are associated with the user. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag noSmithyDocumentSerde @@ -1753,44 +1646,39 @@ type User struct { type UserDetail struct { // The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web - // Services resources. For more information about ARNs, go to Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services resources. For more information about ARNs, go to Amazon Resource + // Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // A list of the managed policies attached to the user. AttachedManagedPolicies []AttachedPolicy - // The date and time, in ISO 8601 date-time format - // (http://www.iso.org/iso/iso8601), when the user was created. + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601) + // , when the user was created. CreateDate *time.Time // A list of IAM groups that the user is in. GroupList []string - // The path to the user. For more information about paths, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // The path to the user. For more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. Path *string // The ARN of the policy used to set the permissions boundary for the user. For // more information about permissions boundaries, see Permissions boundaries for - // IAM identities - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) + // IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. PermissionsBoundary *AttachedPermissionsBoundary // A list of tags that are associated with the user. For more information about - // tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag // The stable and unique string identifying the user. For more information about - // IDs, see IAM identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the - // IAM User Guide. + // IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // in the IAM User Guide. UserId *string // The friendly name identifying the user. @@ -1805,14 +1693,13 @@ type UserDetail struct { // Contains information about a virtual MFA device. type VirtualMFADevice struct { - // The serial number associated with VirtualMFADevice. + // The serial number associated with VirtualMFADevice . // // This member is required. SerialNumber *string - // The base32 seed defined as specified in RFC3548 - // (https://tools.ietf.org/html/rfc3548.txt). The Base32StringSeed is - // base64-encoded. + // The base32 seed defined as specified in RFC3548 (https://tools.ietf.org/html/rfc3548.txt) + // . The Base32StringSeed is base64-encoded. Base32StringSeed []byte // The date and time on which the virtual MFA device was enabled. @@ -1825,10 +1712,9 @@ type VirtualMFADevice struct { // seed in base32 format. The Base32String value is base64-encoded. QRCodePNG []byte - // A list of tags that are attached to the virtual MFA device. For more information - // about tagging, see Tagging IAM resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the IAM User - // Guide. + // A list of tags that are attached to the virtual MFA device. For more + // information about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) + // in the IAM User Guide. Tags []Tag // The IAM user associated with this virtual MFA device. diff --git a/service/identitystore/api_client.go b/service/identitystore/api_client.go index 05e88424040..33f1a63a868 100644 --- a/service/identitystore/api_client.go +++ b/service/identitystore/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/identitystore/api_op_CreateGroup.go b/service/identitystore/api_op_CreateGroup.go index 57e4b5b8ce6..54795a2cb3c 100644 --- a/service/identitystore/api_op_CreateGroup.go +++ b/service/identitystore/api_op_CreateGroup.go @@ -36,9 +36,9 @@ type CreateGroupInput struct { // A string containing the description of the group. Description *string - // A string containing the name of the group. This value is commonly displayed when - // the group is referenced. "Administrator" and "AWSAdministrators" are reserved - // names and can't be used for users or groups. + // A string containing the name of the group. This value is commonly displayed + // when the group is referenced. "Administrator" and "AWSAdministrators" are + // reserved names and can't be used for users or groups. DisplayName *string noSmithyDocumentSerde diff --git a/service/identitystore/api_op_CreateGroupMembership.go b/service/identitystore/api_op_CreateGroupMembership.go index f431d55b7f4..ebb9c71bde7 100644 --- a/service/identitystore/api_op_CreateGroupMembership.go +++ b/service/identitystore/api_op_CreateGroupMembership.go @@ -12,7 +12,7 @@ import ( ) // Creates a relationship between a member and a group. The following identifiers -// must be specified: GroupId, IdentityStoreId, and MemberId. +// must be specified: GroupId , IdentityStoreId , and MemberId . func (c *Client) CreateGroupMembership(ctx context.Context, params *CreateGroupMembershipInput, optFns ...func(*Options)) (*CreateGroupMembershipOutput, error) { if params == nil { params = &CreateGroupMembershipInput{} diff --git a/service/identitystore/api_op_CreateUser.go b/service/identitystore/api_op_CreateUser.go index 35365e55bcf..1850216a001 100644 --- a/service/identitystore/api_op_CreateUser.go +++ b/service/identitystore/api_op_CreateUser.go @@ -66,8 +66,8 @@ type CreateUserInput struct { // A string containing the time zone of the user. Timezone *string - // A string containing the title of the user. Possible values are left unspecified. - // The value can vary based on your specific use case. + // A string containing the title of the user. Possible values are left + // unspecified. The value can vary based on your specific use case. Title *string // A unique string used to identify the user. The length limit is 128 characters. diff --git a/service/identitystore/api_op_DeleteGroup.go b/service/identitystore/api_op_DeleteGroup.go index 7f3fab8c349..5e7b9459954 100644 --- a/service/identitystore/api_op_DeleteGroup.go +++ b/service/identitystore/api_op_DeleteGroup.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a group within an identity store given GroupId. +// Delete a group within an identity store given GroupId . func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { params = &DeleteGroupInput{} diff --git a/service/identitystore/api_op_DeleteGroupMembership.go b/service/identitystore/api_op_DeleteGroupMembership.go index a7007e0a49d..850215acefc 100644 --- a/service/identitystore/api_op_DeleteGroupMembership.go +++ b/service/identitystore/api_op_DeleteGroupMembership.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a membership within a group given MembershipId. +// Delete a membership within a group given MembershipId . func (c *Client) DeleteGroupMembership(ctx context.Context, params *DeleteGroupMembershipInput, optFns ...func(*Options)) (*DeleteGroupMembershipOutput, error) { if params == nil { params = &DeleteGroupMembershipInput{} diff --git a/service/identitystore/api_op_DeleteUser.go b/service/identitystore/api_op_DeleteUser.go index 49285049c2e..b2e9443bcce 100644 --- a/service/identitystore/api_op_DeleteUser.go +++ b/service/identitystore/api_op_DeleteUser.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a user within an identity store given UserId. +// Deletes a user within an identity store given UserId . func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/identitystore/api_op_DescribeGroup.go b/service/identitystore/api_op_DescribeGroup.go index c4571805f21..f8427b18295 100644 --- a/service/identitystore/api_op_DescribeGroup.go +++ b/service/identitystore/api_op_DescribeGroup.go @@ -34,7 +34,7 @@ type DescribeGroupInput struct { // This member is required. GroupId *string - // The globally unique identifier for the identity store, such as d-1234567890. In + // The globally unique identifier for the identity store, such as d-1234567890 . In // this example, d- is a fixed prefix, and 1234567890 is a randomly generated // string that contains numbers and lower case letters. This value is generated at // the time that a new identity store is created. @@ -60,11 +60,11 @@ type DescribeGroupOutput struct { // A string containing a description of the group. Description *string - // The group’s display name value. The length limit is 1,024 characters. This value - // can consist of letters, accented characters, symbols, numbers, punctuation, tab, - // new line, carriage return, space, and nonbreaking space in this attribute. This - // value is specified at the time that the group is created and stored as an - // attribute of the group object in the identity store. + // The group’s display name value. The length limit is 1,024 characters. This + // value can consist of letters, accented characters, symbols, numbers, + // punctuation, tab, new line, carriage return, space, and nonbreaking space in + // this attribute. This value is specified at the time that the group is created + // and stored as an attribute of the group object in the identity store. DisplayName *string // A list of ExternalId objects that contains the identifiers issued to this diff --git a/service/identitystore/api_op_DescribeUser.go b/service/identitystore/api_op_DescribeUser.go index a60035f9747..ede55833516 100644 --- a/service/identitystore/api_op_DescribeUser.go +++ b/service/identitystore/api_op_DescribeUser.go @@ -29,7 +29,7 @@ func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, op type DescribeUserInput struct { - // The globally unique identifier for the identity store, such as d-1234567890. In + // The globally unique identifier for the identity store, such as d-1234567890 . In // this example, d- is a fixed prefix, and 1234567890 is a randomly generated // string that contains numbers and lower case letters. This value is generated at // the time that a new identity store is created. diff --git a/service/identitystore/api_op_GetGroupId.go b/service/identitystore/api_op_GetGroupId.go index c63b39766aa..d170b8a02f0 100644 --- a/service/identitystore/api_op_GetGroupId.go +++ b/service/identitystore/api_op_GetGroupId.go @@ -29,10 +29,10 @@ func (c *Client) GetGroupId(ctx context.Context, params *GetGroupIdInput, optFns type GetGroupIdInput struct { - // A unique identifier for a user or group that is not the primary identifier. This - // value can be an identifier from an external identity provider (IdP) that is + // A unique identifier for a user or group that is not the primary identifier. + // This value can be an identifier from an external identity provider (IdP) that is // associated with the user, the group, or a unique attribute. For the unique - // attribute, the only valid path is displayName. + // attribute, the only valid path is displayName . // // This member is required. AlternateIdentifier types.AlternateIdentifier diff --git a/service/identitystore/api_op_GetUserId.go b/service/identitystore/api_op_GetUserId.go index cae9080260c..100a49d06d8 100644 --- a/service/identitystore/api_op_GetUserId.go +++ b/service/identitystore/api_op_GetUserId.go @@ -29,10 +29,10 @@ func (c *Client) GetUserId(ctx context.Context, params *GetUserIdInput, optFns . type GetUserIdInput struct { - // A unique identifier for a user or group that is not the primary identifier. This - // value can be an identifier from an external identity provider (IdP) that is + // A unique identifier for a user or group that is not the primary identifier. + // This value can be an identifier from an external identity provider (IdP) that is // associated with the user, the group, or a unique attribute. For the unique - // attribute, the only valid paths are userName and emails.value. + // attribute, the only valid paths are userName and emails.value . // // This member is required. AlternateIdentifier types.AlternateIdentifier diff --git a/service/identitystore/api_op_ListGroupMemberships.go b/service/identitystore/api_op_ListGroupMemberships.go index 17238ecc0e0..b8fdb2c9ebd 100644 --- a/service/identitystore/api_op_ListGroupMemberships.go +++ b/service/identitystore/api_op_ListGroupMemberships.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For the specified group in the specified identity store, returns the list of all -// GroupMembership objects and returns results in paginated form. +// For the specified group in the specified identity store, returns the list of +// all GroupMembership objects and returns results in paginated form. func (c *Client) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error) { if params == nil { params = &ListGroupMembershipsInput{} @@ -41,15 +41,15 @@ type ListGroupMembershipsInput struct { // This member is required. IdentityStoreId *string - // The maximum number of results to be returned per request. This parameter is used - // in all List requests to specify how many results to return in one page. + // The maximum number of results to be returned per request. This parameter is + // used in all List requests to specify how many results to return in one page. MaxResults *int32 - // The pagination token used for the ListUsers, ListGroups and ListGroupMemberships - // API operations. This value is generated by the identity store service. It is - // returned in the API response if the total results are more than the size of one - // page. This token is also returned when it is used in the API request to search - // for the next page. + // The pagination token used for the ListUsers , ListGroups and + // ListGroupMemberships API operations. This value is generated by the identity + // store service. It is returned in the API response if the total results are more + // than the size of one page. This token is also returned when it is used in the + // API request to search for the next page. NextToken *string noSmithyDocumentSerde @@ -62,7 +62,7 @@ type ListGroupMembershipsOutput struct { // This member is required. GroupMemberships []types.GroupMembership - // The pagination token used for the ListUsers, ListGroups, and + // The pagination token used for the ListUsers , ListGroups , and // ListGroupMemberships API operations. This value is generated by the identity // store service. It is returned in the API response if the total results are more // than the size of one page. This token is also returned when it is used in the @@ -149,8 +149,8 @@ var _ ListGroupMembershipsAPIClient = (*Client)(nil) // ListGroupMembershipsPaginatorOptions is the paginator options for // ListGroupMemberships type ListGroupMembershipsPaginatorOptions struct { - // The maximum number of results to be returned per request. This parameter is used - // in all List requests to specify how many results to return in one page. + // The maximum number of results to be returned per request. This parameter is + // used in all List requests to specify how many results to return in one page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/identitystore/api_op_ListGroupMembershipsForMember.go b/service/identitystore/api_op_ListGroupMembershipsForMember.go index b446a060e2a..1ed367f3a81 100644 --- a/service/identitystore/api_op_ListGroupMembershipsForMember.go +++ b/service/identitystore/api_op_ListGroupMembershipsForMember.go @@ -43,12 +43,12 @@ type ListGroupMembershipsForMemberInput struct { // This member is required. MemberId types.MemberId - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. MaxResults *int32 - // The pagination token used for the ListUsers, ListGroups, and + // The pagination token used for the ListUsers , ListGroups , and // ListGroupMemberships API operations. This value is generated by the identity // store service. It is returned in the API response if the total results are more // than the size of one page. This token is also returned when it is used in the @@ -65,7 +65,7 @@ type ListGroupMembershipsForMemberOutput struct { // This member is required. GroupMemberships []types.GroupMembership - // The pagination token used for the ListUsers, ListGroups, and + // The pagination token used for the ListUsers , ListGroups , and // ListGroupMemberships API operations. This value is generated by the identity // store service. It is returned in the API response if the total results are more // than the size of one page. This token is also returned when it is used in the @@ -152,9 +152,9 @@ var _ ListGroupMembershipsForMemberAPIClient = (*Client)(nil) // ListGroupMembershipsForMemberPaginatorOptions is the paginator options for // ListGroupMembershipsForMember type ListGroupMembershipsForMemberPaginatorOptions struct { - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/identitystore/api_op_ListGroups.go b/service/identitystore/api_op_ListGroups.go index e645d19ca95..2580e603bc6 100644 --- a/service/identitystore/api_op_ListGroups.go +++ b/service/identitystore/api_op_ListGroups.go @@ -13,8 +13,8 @@ import ( ) // Lists all groups in the identity store. Returns a paginated list of complete -// Group objects. Filtering for a Group by the DisplayName attribute is deprecated. -// Instead, use the GetGroupId API action. +// Group objects. Filtering for a Group by the DisplayName attribute is +// deprecated. Instead, use the GetGroupId API action. func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} @@ -32,7 +32,7 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { - // The globally unique identifier for the identity store, such as d-1234567890. In + // The globally unique identifier for the identity store, such as d-1234567890 . In // this example, d- is a fixed prefix, and 1234567890 is a randomly generated // string that contains numbers and lower case letters. This value is generated at // the time that a new identity store is created. @@ -47,9 +47,9 @@ type ListGroupsInput struct { // GetGroupId API instead. Filters []types.Filter - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. MaxResults *int32 // The pagination token used for the ListUsers and ListGroups API operations. This @@ -152,9 +152,9 @@ var _ ListGroupsAPIClient = (*Client)(nil) // ListGroupsPaginatorOptions is the paginator options for ListGroups type ListGroupsPaginatorOptions struct { - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/identitystore/api_op_ListUsers.go b/service/identitystore/api_op_ListUsers.go index f6c241984a0..6ceb891c53a 100644 --- a/service/identitystore/api_op_ListUsers.go +++ b/service/identitystore/api_op_ListUsers.go @@ -32,7 +32,7 @@ func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns . type ListUsersInput struct { - // The globally unique identifier for the identity store, such as d-1234567890. In + // The globally unique identifier for the identity store, such as d-1234567890 . In // this example, d- is a fixed prefix, and 1234567890 is a randomly generated // string that contains numbers and lower case letters. This value is generated at // the time that a new identity store is created. @@ -47,9 +47,9 @@ type ListUsersInput struct { // GetGroupId API instead. Filters []types.Filter - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. MaxResults *int32 // The pagination token used for the ListUsers and ListGroups API operations. This @@ -152,9 +152,9 @@ var _ ListUsersAPIClient = (*Client)(nil) // ListUsersPaginatorOptions is the paginator options for ListUsers type ListUsersPaginatorOptions struct { - // The maximum number of results to be returned per request. This parameter is used - // in the ListUsers and ListGroups requests to specify how many results to return - // in one page. The length limit is 50 characters. + // The maximum number of results to be returned per request. This parameter is + // used in the ListUsers and ListGroups requests to specify how many results to + // return in one page. The length limit is 50 characters. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/identitystore/doc.go b/service/identitystore/doc.go index ec9f48f29cf..7ce113d1e03 100644 --- a/service/identitystore/doc.go +++ b/service/identitystore/doc.go @@ -5,12 +5,10 @@ // // The Identity Store service used by AWS IAM Identity Center (successor to AWS // Single Sign-On) provides a single place to retrieve all of your identities -// (users and groups). For more information, see the IAM Identity Center User Guide -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html). -// Although AWS Single Sign-On was renamed, the sso and identitystore API +// (users and groups). For more information, see the IAM Identity Center User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) +// . Although AWS Single Sign-On was renamed, the sso and identitystore API // namespaces will continue to retain their original name for backward -// compatibility purposes. For more information, see IAM Identity Center rename -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed). -// This reference guide describes the identity store operations that you can call +// compatibility purposes. For more information, see IAM Identity Center rename (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed) +// . This reference guide describes the identity store operations that you can call // programatically and includes detailed information about data types and errors. package identitystore diff --git a/service/identitystore/document/document.go b/service/identitystore/document/document.go index 464986d0088..d8c645517f8 100644 --- a/service/identitystore/document/document.go +++ b/service/identitystore/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/identitystore/types/enums.go b/service/identitystore/types/enums.go index 6bf7e223a1b..4d05b274ed5 100644 --- a/service/identitystore/types/enums.go +++ b/service/identitystore/types/enums.go @@ -30,9 +30,9 @@ const ( ResourceTypeGroupMembership ResourceType = "GROUP_MEMBERSHIP" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "GROUP", diff --git a/service/identitystore/types/errors.go b/service/identitystore/types/errors.go index e7c4b32fc61..1feac67f9c8 100644 --- a/service/identitystore/types/errors.go +++ b/service/identitystore/types/errors.go @@ -36,13 +36,9 @@ func (e *AccessDeniedException) ErrorCode() string { func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // This request cannot be completed for one of the following reasons: -// -// * Performing -// the requested operation would violate an existing uniqueness claim in the -// identity store. Resolve the conflict before retrying this request. -// -// * The -// requested resource was being concurrently modified by another request. +// - Performing the requested operation would violate an existing uniqueness +// claim in the identity store. Resolve the conflict before retrying this request. +// - The requested resource was being concurrently modified by another request. type ConflictException struct { Message *string diff --git a/service/identitystore/types/types.go b/service/identitystore/types/types.go index 405037e47b0..97dc0290712 100644 --- a/service/identitystore/types/types.go +++ b/service/identitystore/types/types.go @@ -38,8 +38,8 @@ type Address struct { noSmithyDocumentSerde } -// A unique identifier for a user or group that is not the primary identifier. This -// value can be an identifier from an external identity provider (IdP) that is +// A unique identifier for a user or group that is not the primary identifier. +// This value can be an identifier from an external identity provider (IdP) that is // associated with the user, the group, or a unique attribute. // // The following types satisfy this interface: @@ -117,8 +117,8 @@ type ExternalId struct { noSmithyDocumentSerde } -// A query filter used by ListUsers and ListGroups. This filter object provides the -// attribute name and attribute value to search users or groups. +// A query filter used by ListUsers and ListGroups . This filter object provides +// the attribute name and attribute value to search users or groups. type Filter struct { // The attribute path that is used to specify which attribute name to search. @@ -154,8 +154,8 @@ type Group struct { // A string containing a description of the specified group. Description *string - // The display name value for the group. The length limit is 1,024 characters. This - // value can consist of letters, accented characters, symbols, numbers, + // The display name value for the group. The length limit is 1,024 characters. + // This value can consist of letters, accented characters, symbols, numbers, // punctuation, tab, new line, carriage return, space, and nonbreaking space in // this attribute. This value is specified at the time the group is created and // stored as an attribute of the group object in the identity store. @@ -334,8 +334,8 @@ type User struct { // A string containing the time zone of the user. Timezone *string - // A string containing the title of the user. Possible values are left unspecified. - // The value can vary based on your specific use case. + // A string containing the title of the user. Possible values are left + // unspecified. The value can vary based on your specific use case. Title *string // A unique string used to identify the user. The length limit is 128 characters. diff --git a/service/imagebuilder/api_client.go b/service/imagebuilder/api_client.go index 391f2286493..97f5f9b3a40 100644 --- a/service/imagebuilder/api_client.go +++ b/service/imagebuilder/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/imagebuilder/api_op_CancelImageCreation.go b/service/imagebuilder/api_op_CancelImageCreation.go index 2698042a984..4fe10ce013d 100644 --- a/service/imagebuilder/api_op_CancelImageCreation.go +++ b/service/imagebuilder/api_op_CancelImageCreation.go @@ -31,8 +31,7 @@ func (c *Client) CancelImageCreation(ctx context.Context, params *CancelImageCre type CancelImageCreationInput struct { // Unique, case-sensitive identifier you provide to ensure idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. // // This member is required. diff --git a/service/imagebuilder/api_op_CreateComponent.go b/service/imagebuilder/api_op_CreateComponent.go index dbf5230c07f..4adc931c5c1 100644 --- a/service/imagebuilder/api_op_CreateComponent.go +++ b/service/imagebuilder/api_op_CreateComponent.go @@ -15,12 +15,9 @@ import ( // Creates a new component that can be used to build, validate, test, and assess // your image. The component is based on a YAML document that you specify using // exactly one of the following methods: -// -// * Inline, using the data property in the -// request body. -// -// * A URL that points to a YAML document file stored in Amazon S3, -// using the uri property in the request body. +// - Inline, using the data property in the request body. +// - A URL that points to a YAML document file stored in Amazon S3, using the uri +// property in the request body. func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error) { if params == nil { params = &CreateComponentInput{} @@ -53,11 +50,11 @@ type CreateComponentInput struct { // This member is required. Platform types.Platform - // The semantic version of the component. This version follows the semantic version - // syntax. The semantic version has four nodes: ../. You can assign values for the - // first three, and can filter on all of them. Assignment: For the first three - // nodes you can assign any positive integer value, including zero, with an upper - // limit of 2^30-1, or 1073741823 for each node. Image Builder automatically + // The semantic version of the component. This version follows the semantic + // version syntax. The semantic version has four nodes: ../. You can assign values + // for the first three, and can filter on all of them. Assignment: For the first + // three nodes you can assign any positive integer value, including zero, with an + // upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically // assigns the build number to the fourth node. Patterns: You can use any numeric // pattern that adheres to the assignment requirements for the nodes that you can // assign. For example, you might choose a software version pattern, such as 1.0.0, @@ -90,8 +87,8 @@ type CreateComponentInput struct { // The tags that apply to the component. Tags map[string]string - // The uri of a YAML component document file. This must be an S3 URL - // (s3://bucket/key), and the requester must have permission to access the S3 + // The uri of a YAML component document file. This must be an S3 URL ( + // s3://bucket/key ), and the requester must have permission to access the S3 // bucket it points to. If you use Amazon S3, you can specify component content up // to your service quota. Alternatively, you can specify the YAML document inline, // using the component data property. You cannot specify both properties. diff --git a/service/imagebuilder/api_op_CreateContainerRecipe.go b/service/imagebuilder/api_op_CreateContainerRecipe.go index fb9cc8a3c7b..af2045b5f44 100644 --- a/service/imagebuilder/api_op_CreateContainerRecipe.go +++ b/service/imagebuilder/api_op_CreateContainerRecipe.go @@ -36,9 +36,9 @@ type CreateContainerRecipeInput struct { // This member is required. ClientToken *string - // Components for build and test that are included in the container recipe. Recipes - // require a minimum of one build component, and can have a maximum of 20 build and - // test components in any combination. + // Components for build and test that are included in the container recipe. + // Recipes require a minimum of one build component, and can have a maximum of 20 + // build and test components in any combination. // // This member is required. Components []types.ComponentConfiguration diff --git a/service/imagebuilder/api_op_CreateDistributionConfiguration.go b/service/imagebuilder/api_op_CreateDistributionConfiguration.go index e74f32a9811..f52e4fd5813 100644 --- a/service/imagebuilder/api_op_CreateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_CreateDistributionConfiguration.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new distribution configuration. Distribution configurations define and -// configure the outputs of your pipeline. +// Creates a new distribution configuration. Distribution configurations define +// and configure the outputs of your pipeline. func (c *Client) CreateDistributionConfiguration(ctx context.Context, params *CreateDistributionConfigurationInput, optFns ...func(*Options)) (*CreateDistributionConfigurationOutput, error) { if params == nil { params = &CreateDistributionConfigurationInput{} diff --git a/service/imagebuilder/api_op_CreateImagePipeline.go b/service/imagebuilder/api_op_CreateImagePipeline.go index ac689c87a92..75fe95bd8cc 100644 --- a/service/imagebuilder/api_op_CreateImagePipeline.go +++ b/service/imagebuilder/api_op_CreateImagePipeline.go @@ -47,8 +47,8 @@ type CreateImagePipelineInput struct { // This member is required. Name *string - // The Amazon Resource Name (ARN) of the container recipe that is used to configure - // images created by this container pipeline. + // The Amazon Resource Name (ARN) of the container recipe that is used to + // configure images created by this container pipeline. ContainerRecipeArn *string // The description of the image pipeline. diff --git a/service/imagebuilder/api_op_CreateImageRecipe.go b/service/imagebuilder/api_op_CreateImageRecipe.go index 26c8c3eea6a..9ac073baa9a 100644 --- a/service/imagebuilder/api_op_CreateImageRecipe.go +++ b/service/imagebuilder/api_op_CreateImageRecipe.go @@ -48,8 +48,8 @@ type CreateImageRecipeInput struct { // The base image of the image recipe. The value of the string can be the ARN of // the base image or an AMI ID. The format for the ARN follows this example: - // arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. - // You can provide the specific version that you want to use, or you can use a + // arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x + // . You can provide the specific version that you want to use, or you can use a // wildcard in all of the fields. If you enter an AMI ID for the string value, you // must have access to the AMI, and the AMI must be in the same Region in which you // are using Image Builder. diff --git a/service/imagebuilder/api_op_DeleteImage.go b/service/imagebuilder/api_op_DeleteImage.go index 557436598de..93d02513613 100644 --- a/service/imagebuilder/api_op_DeleteImage.go +++ b/service/imagebuilder/api_op_DeleteImage.go @@ -14,21 +14,12 @@ import ( // ECR container images that are created during the image build process. You must // clean those up separately, using the appropriate Amazon EC2 or Amazon ECR // console actions, or API or CLI commands. -// -// * To deregister an EC2 Linux AMI, see -// Deregister your Linux AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html) in the -// Amazon EC2 User Guide . -// -// * To deregister an EC2 Windows AMI, see Deregister your -// Windows AMI -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html) in -// the Amazon EC2 Windows Guide . -// -// * To delete a container image from Amazon ECR, -// see Deleting an image -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html) in -// the Amazon ECR User Guide. +// - To deregister an EC2 Linux AMI, see Deregister your Linux AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html) +// in the Amazon EC2 User Guide . +// - To deregister an EC2 Windows AMI, see Deregister your Windows AMI (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html) +// in the Amazon EC2 Windows Guide . +// - To delete a container image from Amazon ECR, see Deleting an image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html) +// in the Amazon ECR User Guide. func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error) { if params == nil { params = &DeleteImageInput{} diff --git a/service/imagebuilder/api_op_GetComponent.go b/service/imagebuilder/api_op_GetComponent.go index 8fd08c2dc49..654f3fa775d 100644 --- a/service/imagebuilder/api_op_GetComponent.go +++ b/service/imagebuilder/api_op_GetComponent.go @@ -30,7 +30,7 @@ func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, op type GetComponentInput struct { // The Amazon Resource Name (ARN) of the component that you want to get. Regex - // requires the suffix /\d+$. + // requires the suffix /\d+$ . // // This member is required. ComponentBuildVersionArn *string diff --git a/service/imagebuilder/api_op_GetInfrastructureConfiguration.go b/service/imagebuilder/api_op_GetInfrastructureConfiguration.go index faf91c8d7c8..bdfab000071 100644 --- a/service/imagebuilder/api_op_GetInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_GetInfrastructureConfiguration.go @@ -30,8 +30,8 @@ func (c *Client) GetInfrastructureConfiguration(ctx context.Context, params *Get // GetInfrastructureConfiguration request object. type GetInfrastructureConfigurationInput struct { - // The Amazon Resource Name (ARN) of the infrastructure configuration that you want - // to retrieve. + // The Amazon Resource Name (ARN) of the infrastructure configuration that you + // want to retrieve. // // This member is required. InfrastructureConfigurationArn *string diff --git a/service/imagebuilder/api_op_GetWorkflowExecution.go b/service/imagebuilder/api_op_GetWorkflowExecution.go index 456c91986ef..7ca2e46a258 100644 --- a/service/imagebuilder/api_op_GetWorkflowExecution.go +++ b/service/imagebuilder/api_op_GetWorkflowExecution.go @@ -61,8 +61,8 @@ type GetWorkflowExecutionOutput struct { // The current runtime status for the specified runtime instance of the workflow. Status types.WorkflowExecutionStatus - // The total number of steps in the specified runtime instance of the workflow that - // ran. This number should equal the sum of the step counts for steps that + // The total number of steps in the specified runtime instance of the workflow + // that ran. This number should equal the sum of the step counts for steps that // succeeded, were skipped, and failed. TotalStepCount int32 diff --git a/service/imagebuilder/api_op_ImportComponent.go b/service/imagebuilder/api_op_ImportComponent.go index 2df9a66cde5..a0224b4cb0a 100644 --- a/service/imagebuilder/api_op_ImportComponent.go +++ b/service/imagebuilder/api_op_ImportComponent.go @@ -50,12 +50,12 @@ type ImportComponentInput struct { // This member is required. Platform types.Platform - // The semantic version of the component. This version follows the semantic version - // syntax. The semantic version has four nodes: ../. You can assign values for the - // first three, and can filter on all of them. Filtering: With semantic versioning, - // you have the flexibility to use wildcards (x) to specify the most recent - // versions or nodes when selecting the base image or components for your recipe. - // When you use a wildcard in any node, all nodes to the right of the first + // The semantic version of the component. This version follows the semantic + // version syntax. The semantic version has four nodes: ../. You can assign values + // for the first three, and can filter on all of them. Filtering: With semantic + // versioning, you have the flexibility to use wildcards (x) to specify the most + // recent versions or nodes when selecting the base image or components for your + // recipe. When you use a wildcard in any node, all nodes to the right of the first // wildcard must also be wildcards. // // This member is required. diff --git a/service/imagebuilder/api_op_ImportVmImage.go b/service/imagebuilder/api_op_ImportVmImage.go index 7ca929db8f6..c3e7e02ec53 100644 --- a/service/imagebuilder/api_op_ImportVmImage.go +++ b/service/imagebuilder/api_op_ImportVmImage.go @@ -15,13 +15,11 @@ import ( // When you export your virtual machine (VM) from its virtualization environment, // that process creates a set of one or more disk container files that act as // snapshots of your VM’s environment, settings, and data. The Amazon EC2 API -// ImportImage -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html) +// ImportImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html) // action uses those files to import your VM and create an AMI. To import using the -// CLI command, see import-image -// (https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html) You can -// reference the task ID from the VM import to pull in the AMI that the import -// created as the base image for your Image Builder recipe. +// CLI command, see import-image (https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html) +// You can reference the task ID from the VM import to pull in the AMI that the +// import created as the base image for your Image Builder recipe. func (c *Client) ImportVmImage(ctx context.Context, params *ImportVmImageInput, optFns ...func(*Options)) (*ImportVmImageOutput, error) { if params == nil { params = &ImportVmImageInput{} @@ -40,8 +38,7 @@ func (c *Client) ImportVmImage(ctx context.Context, params *ImportVmImageInput, type ImportVmImageInput struct { // Unique, case-sensitive identifier you provide to ensure idempotency of the - // request. For more information, see Ensuring idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // request. For more information, see Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. // // This member is required. diff --git a/service/imagebuilder/api_op_ListComponentBuildVersions.go b/service/imagebuilder/api_op_ListComponentBuildVersions.go index 5ea2d908358..2d0d258cbf1 100644 --- a/service/imagebuilder/api_op_ListComponentBuildVersions.go +++ b/service/imagebuilder/api_op_ListComponentBuildVersions.go @@ -12,13 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of component build versions for the specified semantic version. -// The semantic version has four nodes: ../. You can assign values for the first -// three, and can filter on all of them. Filtering: With semantic versioning, you -// have the flexibility to use wildcards (x) to specify the most recent versions or -// nodes when selecting the base image or components for your recipe. When you use -// a wildcard in any node, all nodes to the right of the first wildcard must also -// be wildcards. +// Returns the list of component build versions for the specified semantic +// version. The semantic version has four nodes: ../. You can assign values for the +// first three, and can filter on all of them. Filtering: With semantic versioning, +// you have the flexibility to use wildcards (x) to specify the most recent +// versions or nodes when selecting the base image or components for your recipe. +// When you use a wildcard in any node, all nodes to the right of the first +// wildcard must also be wildcards. func (c *Client) ListComponentBuildVersions(ctx context.Context, params *ListComponentBuildVersionsInput, optFns ...func(*Options)) (*ListComponentBuildVersionsOutput, error) { if params == nil { params = &ListComponentBuildVersionsInput{} diff --git a/service/imagebuilder/api_op_ListComponents.go b/service/imagebuilder/api_op_ListComponents.go index 412c8ccc6dc..24c379953d2 100644 --- a/service/imagebuilder/api_op_ListComponents.go +++ b/service/imagebuilder/api_op_ListComponents.go @@ -41,19 +41,12 @@ type ListComponentsInput struct { ByName bool // Use the following filters to streamline results: - // - // * description - // - // * name - // - // * - // platform - // - // * supportedOsVersion - // - // * type - // - // * version + // - description + // - name + // - platform + // - supportedOsVersion + // - type + // - version Filters []types.Filter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListContainerRecipes.go b/service/imagebuilder/api_op_ListContainerRecipes.go index 33bc6fb6223..ae24e45b924 100644 --- a/service/imagebuilder/api_op_ListContainerRecipes.go +++ b/service/imagebuilder/api_op_ListContainerRecipes.go @@ -31,15 +31,10 @@ func (c *Client) ListContainerRecipes(ctx context.Context, params *ListContainer type ListContainerRecipesInput struct { // Use the following filters to streamline results: - // - // * containerType - // - // * name - // - // * - // parentImage - // - // * platform + // - containerType + // - name + // - parentImage + // - platform Filters []types.Filter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListImageBuildVersions.go b/service/imagebuilder/api_op_ListImageBuildVersions.go index 445d9620a92..06b36c79409 100644 --- a/service/imagebuilder/api_op_ListImageBuildVersions.go +++ b/service/imagebuilder/api_op_ListImageBuildVersions.go @@ -37,17 +37,11 @@ type ListImageBuildVersionsInput struct { ImageVersionArn *string // Use the following filters to streamline results: - // - // * name - // - // * osVersion - // - // * - // platform - // - // * type - // - // * version + // - name + // - osVersion + // - platform + // - type + // - version Filters []types.Filter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListImagePackages.go b/service/imagebuilder/api_op_ListImagePackages.go index f79c6be6f62..099b73f9440 100644 --- a/service/imagebuilder/api_op_ListImagePackages.go +++ b/service/imagebuilder/api_op_ListImagePackages.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the Packages that are associated with an Image Build Version, as determined -// by Amazon Web Services Systems Manager Inventory at build time. +// List the Packages that are associated with an Image Build Version, as +// determined by Amazon Web Services Systems Manager Inventory at build time. func (c *Client) ListImagePackages(ctx context.Context, params *ListImagePackagesInput, optFns ...func(*Options)) (*ListImagePackagesOutput, error) { if params == nil { params = &ListImagePackagesInput{} diff --git a/service/imagebuilder/api_op_ListImagePipelineImages.go b/service/imagebuilder/api_op_ListImagePipelineImages.go index 272f0df79da..5db0ac1ab8b 100644 --- a/service/imagebuilder/api_op_ListImagePipelineImages.go +++ b/service/imagebuilder/api_op_ListImagePipelineImages.go @@ -37,10 +37,8 @@ type ListImagePipelineImagesInput struct { ImagePipelineArn *string // Use the following filters to streamline results: - // - // * name - // - // * version + // - name + // - version Filters []types.Filter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListImagePipelines.go b/service/imagebuilder/api_op_ListImagePipelines.go index 828ede0f49b..99de8afeea8 100644 --- a/service/imagebuilder/api_op_ListImagePipelines.go +++ b/service/imagebuilder/api_op_ListImagePipelines.go @@ -31,20 +31,12 @@ func (c *Client) ListImagePipelines(ctx context.Context, params *ListImagePipeli type ListImagePipelinesInput struct { // Use the following filters to streamline results: - // - // * description - // - // * - // distributionConfigurationArn - // - // * imageRecipeArn - // - // * - // infrastructureConfigurationArn - // - // * name - // - // * status + // - description + // - distributionConfigurationArn + // - imageRecipeArn + // - infrastructureConfigurationArn + // - name + // - status Filters []types.Filter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListImageRecipes.go b/service/imagebuilder/api_op_ListImageRecipes.go index 1ae9efacb2c..2f2930dfd38 100644 --- a/service/imagebuilder/api_op_ListImageRecipes.go +++ b/service/imagebuilder/api_op_ListImageRecipes.go @@ -31,13 +31,9 @@ func (c *Client) ListImageRecipes(ctx context.Context, params *ListImageRecipesI type ListImageRecipesInput struct { // Use the following filters to streamline results: - // - // * name - // - // * parentImage - // - // * - // platform + // - name + // - parentImage + // - platform Filters []types.Filter // The maximum items to return in a request. @@ -47,10 +43,10 @@ type ListImageRecipesInput struct { // previously truncated response. NextToken *string - // The owner defines which image recipes you want to list. By default, this request - // will only show image recipes owned by your account. You can use this field to - // specify if you want to view image recipes owned by yourself, by Amazon, or those - // image recipes that have been shared with you by other customers. + // The owner defines which image recipes you want to list. By default, this + // request will only show image recipes owned by your account. You can use this + // field to specify if you want to view image recipes owned by yourself, by Amazon, + // or those image recipes that have been shared with you by other customers. Owner types.Ownership noSmithyDocumentSerde diff --git a/service/imagebuilder/api_op_ListImageScanFindingAggregations.go b/service/imagebuilder/api_op_ListImageScanFindingAggregations.go index 9fb3eec7732..6dcf99a4cad 100644 --- a/service/imagebuilder/api_op_ListImageScanFindingAggregations.go +++ b/service/imagebuilder/api_op_ListImageScanFindingAggregations.go @@ -18,15 +18,10 @@ import ( // might specify your pipeline with the imagePipelineArn filter. If you don't // specify a filter, Image Builder returns an aggregation for your account. To // streamline results, you can use the following filters in your request: -// -// * -// accountId -// -// * imageBuildVersionArn -// -// * imagePipelineArn -// -// * vulnerabilityId +// - accountId +// - imageBuildVersionArn +// - imagePipelineArn +// - vulnerabilityId func (c *Client) ListImageScanFindingAggregations(ctx context.Context, params *ListImageScanFindingAggregationsInput, optFns ...func(*Options)) (*ListImageScanFindingAggregationsOutput, error) { if params == nil { params = &ListImageScanFindingAggregationsInput{} @@ -60,21 +55,14 @@ type ListImageScanFindingAggregationsOutput struct { // The aggregation type specifies what type of key is used to group the image scan // findings. Image Builder returns results based on the request filter. If you - // didn't specify a filter in the request, the type defaults to accountId. + // didn't specify a filter in the request, the type defaults to accountId . // Aggregation types - // - // * accountId - // - // * imageBuildVersionArn - // - // * imagePipelineArn - // - // * - // vulnerabilityId - // - // Each aggregation includes counts by severity level for medium - // severity and higher level findings, plus a total for all of the findings for - // each key value. + // - accountId + // - imageBuildVersionArn + // - imagePipelineArn + // - vulnerabilityId + // Each aggregation includes counts by severity level for medium severity and + // higher level findings, plus a total for all of the findings for each key value. AggregationType *string // The next token used for paginated responses. When this field isn't empty, there diff --git a/service/imagebuilder/api_op_ListImageScanFindings.go b/service/imagebuilder/api_op_ListImageScanFindings.go index 045f7b26588..d28204c1d95 100644 --- a/service/imagebuilder/api_op_ListImageScanFindings.go +++ b/service/imagebuilder/api_op_ListImageScanFindings.go @@ -32,18 +32,11 @@ type ListImageScanFindingsInput struct { // An array of name value pairs that you can use to filter your results. You can // use the following filters to streamline results: - // - // * imageBuildVersionArn - // - // * - // imagePipelineArn - // - // * vulnerabilityId - // - // * severity - // - // If you don't request a filter, - // then all findings in your account are listed. + // - imageBuildVersionArn + // - imagePipelineArn + // - vulnerabilityId + // - severity + // If you don't request a filter, then all findings in your account are listed. Filters []types.ImageScanFindingsFilter // The maximum items to return in a request. diff --git a/service/imagebuilder/api_op_ListImages.go b/service/imagebuilder/api_op_ListImages.go index 7db2ed58524..fca78d343fa 100644 --- a/service/imagebuilder/api_op_ListImages.go +++ b/service/imagebuilder/api_op_ListImages.go @@ -35,17 +35,11 @@ type ListImagesInput struct { ByName bool // Use the following filters to streamline results: - // - // * name - // - // * osVersion - // - // * - // platform - // - // * type - // - // * version + // - name + // - osVersion + // - platform + // - type + // - version Filters []types.Filter // Includes deprecated images in the response list. diff --git a/service/imagebuilder/api_op_PutComponentPolicy.go b/service/imagebuilder/api_op_PutComponentPolicy.go index 1502143ce26..fa803776406 100644 --- a/service/imagebuilder/api_op_PutComponentPolicy.go +++ b/service/imagebuilder/api_op_PutComponentPolicy.go @@ -11,11 +11,9 @@ import ( ) // Applies a policy to a component. We recommend that you call the RAM API -// CreateResourceShare -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) -// to share resources. If you call the Image Builder API PutComponentPolicy, you -// must also call the RAM API PromoteResourceShareCreatedFromPolicy -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) +// CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) +// to share resources. If you call the Image Builder API PutComponentPolicy , you +// must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) // in order for the resource to be visible to all principals with whom the resource // is shared. func (c *Client) PutComponentPolicy(ctx context.Context, params *PutComponentPolicyInput, optFns ...func(*Options)) (*PutComponentPolicyOutput, error) { diff --git a/service/imagebuilder/api_op_PutContainerRecipePolicy.go b/service/imagebuilder/api_op_PutContainerRecipePolicy.go index a5021ba55d7..ebb34d1d12d 100644 --- a/service/imagebuilder/api_op_PutContainerRecipePolicy.go +++ b/service/imagebuilder/api_op_PutContainerRecipePolicy.go @@ -13,7 +13,7 @@ import ( // Applies a policy to a container image. We recommend that you call the RAM API // CreateResourceShare // (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) -// to share resources. If you call the Image Builder API PutContainerImagePolicy, +// to share resources. If you call the Image Builder API PutContainerImagePolicy , // you must also call the RAM API PromoteResourceShareCreatedFromPolicy // (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) // in order for the resource to be visible to all principals with whom the resource diff --git a/service/imagebuilder/api_op_PutImagePolicy.go b/service/imagebuilder/api_op_PutImagePolicy.go index 48c5e8f419d..8f5c5635c78 100644 --- a/service/imagebuilder/api_op_PutImagePolicy.go +++ b/service/imagebuilder/api_op_PutImagePolicy.go @@ -11,11 +11,9 @@ import ( ) // Applies a policy to an image. We recommend that you call the RAM API -// CreateResourceShare -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) -// to share resources. If you call the Image Builder API PutImagePolicy, you must -// also call the RAM API PromoteResourceShareCreatedFromPolicy -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) +// CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) +// to share resources. If you call the Image Builder API PutImagePolicy , you must +// also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) // in order for the resource to be visible to all principals with whom the resource // is shared. func (c *Client) PutImagePolicy(ctx context.Context, params *PutImagePolicyInput, optFns ...func(*Options)) (*PutImagePolicyOutput, error) { diff --git a/service/imagebuilder/api_op_PutImageRecipePolicy.go b/service/imagebuilder/api_op_PutImageRecipePolicy.go index d845666e616..915c0279fad 100644 --- a/service/imagebuilder/api_op_PutImageRecipePolicy.go +++ b/service/imagebuilder/api_op_PutImageRecipePolicy.go @@ -11,11 +11,9 @@ import ( ) // Applies a policy to an image recipe. We recommend that you call the RAM API -// CreateResourceShare -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) -// to share resources. If you call the Image Builder API PutImageRecipePolicy, you -// must also call the RAM API PromoteResourceShareCreatedFromPolicy -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) +// CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) +// to share resources. If you call the Image Builder API PutImageRecipePolicy , you +// must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) // in order for the resource to be visible to all principals with whom the resource // is shared. func (c *Client) PutImageRecipePolicy(ctx context.Context, params *PutImageRecipePolicyInput, optFns ...func(*Options)) (*PutImageRecipePolicyOutput, error) { diff --git a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go index f88349727ba..29f04891f49 100644 --- a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a new distribution configuration. Distribution configurations define and -// configure the outputs of your pipeline. +// Updates a new distribution configuration. Distribution configurations define +// and configure the outputs of your pipeline. func (c *Client) UpdateDistributionConfiguration(ctx context.Context, params *UpdateDistributionConfigurationInput, optFns ...func(*Options)) (*UpdateDistributionConfigurationOutput, error) { if params == nil { params = &UpdateDistributionConfigurationInput{} diff --git a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go index 0fde2b4d5dd..a46eab27c8b 100644 --- a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go @@ -36,8 +36,8 @@ type UpdateInfrastructureConfigurationInput struct { // This member is required. ClientToken *string - // The Amazon Resource Name (ARN) of the infrastructure configuration that you want - // to update. + // The Amazon Resource Name (ARN) of the infrastructure configuration that you + // want to update. // // This member is required. InfrastructureConfigurationArn *string @@ -54,16 +54,10 @@ type UpdateInfrastructureConfigurationInput struct { // The instance metadata options that you can set for the HTTP requests that // pipeline builds use to launch EC2 build and test instances. For more information // about instance metadata options, see one of the following links: - // - // * Configure - // the instance metadata options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) - // in the Amazon EC2 User Guide for Linux instances. - // - // * Configure the instance - // metadata options - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) - // in the Amazon EC2 Windows Guide for Windows instances. + // - Configure the instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) + // in the Amazon EC2 User Guide for Linux instances. + // - Configure the instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) + // in the Amazon EC2 Windows Guide for Windows instances. InstanceMetadataOptions *types.InstanceMetadataOptions // The instance types of the infrastructure configuration. You can specify one or diff --git a/service/imagebuilder/types/enums.go b/service/imagebuilder/types/enums.go index 5879d7c4479..c14ac0b8767 100644 --- a/service/imagebuilder/types/enums.go +++ b/service/imagebuilder/types/enums.go @@ -11,9 +11,9 @@ const ( BuildTypeImport BuildType = "IMPORT" ) -// Values returns all known values for BuildType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BuildType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BuildType) Values() []BuildType { return []BuildType{ "USER_INITIATED", @@ -246,9 +246,9 @@ const ( ImageTypeDocker ImageType = "DOCKER" ) -// Values returns all known values for ImageType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ImageType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ImageType) Values() []ImageType { return []ImageType{ "AMI", @@ -266,9 +266,9 @@ const ( OwnershipThirdparty Ownership = "ThirdParty" ) -// Values returns all known values for Ownership. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Ownership. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Ownership) Values() []Ownership { return []Ownership{ "Self", @@ -417,9 +417,9 @@ const ( WorkflowTypeDistribution WorkflowType = "DISTRIBUTION" ) -// Values returns all known values for WorkflowType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WorkflowType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WorkflowType) Values() []WorkflowType { return []WorkflowType{ "BUILD", diff --git a/service/imagebuilder/types/errors.go b/service/imagebuilder/types/errors.go index e51dc09b02b..8d8aa32f2f2 100644 --- a/service/imagebuilder/types/errors.go +++ b/service/imagebuilder/types/errors.go @@ -409,8 +409,8 @@ func (e *ServiceException) ErrorCode() string { func (e *ServiceException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // You have exceeded the number of permitted resources or operations for this -// service. For service quotas, see EC2 Image Builder endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder). +// service. For service quotas, see EC2 Image Builder endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder) +// . type ServiceQuotaExceededException struct { Message *string diff --git a/service/imagebuilder/types/types.go b/service/imagebuilder/types/types.go index 6ef0bcc61c9..c9ab76ff4bd 100644 --- a/service/imagebuilder/types/types.go +++ b/service/imagebuilder/types/types.go @@ -37,14 +37,14 @@ type AdditionalInstanceConfiguration struct { // Contains settings for the Systems Manager agent on your build instance. SystemsManagerAgent *SystemsManagerAgent - // Use this property to provide commands or a command script to run when you launch - // your build instance. The userDataOverride property replaces any commands that - // Image Builder might have added to ensure that Systems Manager is installed on - // your Linux build instance. If you override the user data, make sure that you add - // commands to install Systems Manager, if it is not pre-installed on your base + // Use this property to provide commands or a command script to run when you + // launch your build instance. The userDataOverride property replaces any commands + // that Image Builder might have added to ensure that Systems Manager is installed + // on your Linux build instance. If you override the user data, make sure that you + // add commands to install Systems Manager, if it is not pre-installed on your base // image. The user data is always base 64 encoded. For example, the following - // commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$: - // #!/bin/bash mkdir -p /var/bb/ touch /var + // commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$ + // : #!/bin/bash mkdir -p /var/bb/ touch /var UserDataOverride *string noSmithyDocumentSerde @@ -176,8 +176,8 @@ type ComponentConfiguration struct { // This member is required. ComponentArn *string - // A group of parameter settings that Image Builder uses to configure the component - // for a specific recipe. + // A group of parameter settings that Image Builder uses to configure the + // component for a specific recipe. Parameters []ComponentParameter noSmithyDocumentSerde @@ -289,23 +289,19 @@ type ComponentSummary struct { noSmithyDocumentSerde } -// The defining characteristics of a specific version of an Amazon Web Services TOE -// component. +// The defining characteristics of a specific version of an Amazon Web Services +// TOE component. type ComponentVersion struct { - // The Amazon Resource Name (ARN) of the component. Semantic versioning is included - // in each object's Amazon Resource Name (ARN), at the level that applies to that - // object as follows: - // - // * Versionless ARNs and Name ARNs do not include specific - // values in any of the nodes. The nodes are either left off entirely, or they are - // specified as wildcards, for example: x.x.x. - // - // * Version ARNs have only the first - // three nodes: .. - // - // * Build version ARNs have all four nodes, and point to a - // specific build for a specific version of an object. + // The Amazon Resource Name (ARN) of the component. Semantic versioning is + // included in each object's Amazon Resource Name (ARN), at the level that applies + // to that object as follows: + // - Versionless ARNs and Name ARNs do not include specific values in any of the + // nodes. The nodes are either left off entirely, or they are specified as + // wildcards, for example: x.x.x. + // - Version ARNs have only the first three nodes: .. + // - Build version ARNs have all four nodes, and point to a specific build for a + // specific version of an object. Arn *string // The date that the component was created. @@ -332,8 +328,8 @@ type ComponentVersion struct { // image or only to test it. Type ComponentType - // The semantic version of the component. The semantic version has four nodes: ../. - // You can assign values for the first three, and can filter on all of them. + // The semantic version of the component. The semantic version has four nodes: + // ../. You can assign values for the first three, and can filter on all of them. // Assignment: For the first three nodes you can assign any positive integer value, // including zero, with an upper limit of 2^30-1, or 1073741823 for each node. // Image Builder automatically assigns the build number to the fourth node. @@ -386,16 +382,12 @@ type ContainerRecipe struct { // The Amazon Resource Name (ARN) of the container recipe. Semantic versioning is // included in each object's Amazon Resource Name (ARN), at the level that applies // to that object as follows: - // - // * Versionless ARNs and Name ARNs do not include - // specific values in any of the nodes. The nodes are either left off entirely, or - // they are specified as wildcards, for example: x.x.x. - // - // * Version ARNs have only - // the first three nodes: .. - // - // * Build version ARNs have all four nodes, and point - // to a specific build for a specific version of an object. + // - Versionless ARNs and Name ARNs do not include specific values in any of the + // nodes. The nodes are either left off entirely, or they are specified as + // wildcards, for example: x.x.x. + // - Version ARNs have only the first three nodes: .. + // - Build version ARNs have all four nodes, and point to a specific build for a + // specific version of an object. Arn *string // Build and test components that are included in the container recipe. Recipes @@ -425,8 +417,8 @@ type ContainerRecipe struct { // testing container images. InstanceConfiguration *InstanceConfiguration - // Identifies which KMS key is used to encrypt the container image for distribution - // to the target Region. + // Identifies which KMS key is used to encrypt the container image for + // distribution to the target Region. KmsKeyId *string // The name of the container recipe. @@ -502,8 +494,7 @@ type ContainerRecipeSummary struct { // vulnerable resources. The score uses the Common Vulnerability Scoring System // (CVSS) format. This format is a modification of the base CVSS score that the // National Vulnerability Database (NVD) provides. For more information about -// severity levels, see Severity levels for Amazon Inspector findings -// (https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html) +// severity levels, see Severity levels for Amazon Inspector findings (https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html) // in the Amazon Inspector User Guide. type CvssScore struct { @@ -579,8 +570,8 @@ type Distribution struct { // The Windows faster-launching configurations to use for AMI distribution. FastLaunchConfigurations []FastLaunchConfiguration - // A group of launchTemplateConfiguration settings that apply to image distribution - // for specified accounts. + // A group of launchTemplateConfiguration settings that apply to image + // distribution for specified accounts. LaunchTemplateConfigurations []LaunchTemplateConfiguration // The License Manager Configuration to associate with the AMI in the specified @@ -707,8 +698,8 @@ type EcrConfiguration struct { type FastLaunchConfiguration struct { // A Boolean that represents the current state of faster launching for the Windows - // AMI. Set to true to start using Windows faster launching, or false to stop using - // it. + // AMI. Set to true to start using Windows faster launching, or false to stop + // using it. // // This member is required. Enabled bool @@ -734,7 +725,7 @@ type FastLaunchConfiguration struct { // Identifies the launch template that the associated Windows AMI uses for // launching an instance when faster launching is enabled. You can specify either -// the launchTemplateName or the launchTemplateId, but not both. +// the launchTemplateName or the launchTemplateId , but not both. type FastLaunchLaunchTemplateSpecification struct { // The ID of the launch template to use for faster launching for a Windows AMI. @@ -750,8 +741,8 @@ type FastLaunchLaunchTemplateSpecification struct { noSmithyDocumentSerde } -// Configuration settings for creating and managing pre-provisioned snapshots for a -// fast-launch enabled Windows AMI. +// Configuration settings for creating and managing pre-provisioned snapshots for +// a fast-launch enabled Windows AMI. type FastLaunchSnapshotConfiguration struct { // The number of pre-provisioned snapshots to keep on hand for a fast-launch @@ -776,36 +767,28 @@ type Filter struct { } // An Image Builder image. You must specify exactly one recipe for the image – -// either a container recipe (containerRecipe), which creates a container image, or -// an image recipe (imageRecipe), which creates an AMI. +// either a container recipe ( containerRecipe ), which creates a container image, +// or an image recipe ( imageRecipe ), which creates an AMI. type Image struct { // The Amazon Resource Name (ARN) of the image. Semantic versioning is included in // each object's Amazon Resource Name (ARN), at the level that applies to that // object as follows: - // - // * Versionless ARNs and Name ARNs do not include specific - // values in any of the nodes. The nodes are either left off entirely, or they are - // specified as wildcards, for example: x.x.x. - // - // * Version ARNs have only the first - // three nodes: .. - // - // * Build version ARNs have all four nodes, and point to a - // specific build for a specific version of an object. + // - Versionless ARNs and Name ARNs do not include specific values in any of the + // nodes. The nodes are either left off entirely, or they are specified as + // wildcards, for example: x.x.x. + // - Version ARNs have only the first three nodes: .. + // - Build version ARNs have all four nodes, and point to a specific build for a + // specific version of an object. Arn *string // Indicates the type of build that created this image. The build can be initiated // in the following ways: - // - // * USER_INITIATED – A manual pipeline build request. - // - // * - // SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder - // pipeline, or from EventBridge. - // - // * IMPORT – A VM import created the image to use - // as the base image for the recipe. + // - USER_INITIATED – A manual pipeline build request. + // - SCHEDULED – A pipeline build initiated by a cron expression in the Image + // Builder pipeline, or from EventBridge. + // - IMPORT – A VM import created the image to use as the base image for the + // recipe. BuildType BuildType // For container images, this is the container recipe that Image Builder used to @@ -818,8 +801,8 @@ type Image struct { // The distribution configuration that Image Builder used to create this image. DistributionConfiguration *DistributionConfiguration - // Indicates whether Image Builder collects additional information about the image, - // such as the operating system (OS) version and package list. + // Indicates whether Image Builder collects additional information about the + // image, such as the operating system (OS) version and package list. EnhancedImageMetadataEnabled *bool // For images that distribute an AMI, this is the image recipe that Image Builder @@ -869,8 +852,8 @@ type Image struct { // Specifies whether this image produces an AMI or a container image. Type ImageType - // The semantic version of the image. The semantic version has four nodes: ../. You - // can assign values for the first three, and can filter on all of them. + // The semantic version of the image. The semantic version has four nodes: ../. + // You can assign values for the first three, and can filter on all of them. // Assignment: For the first three nodes you can assign any positive integer value, // including zero, with an upper limit of 2^30-1, or 1073741823 for each node. // Image Builder automatically assigns the build number to the fourth node. @@ -936,8 +919,8 @@ type ImagePipeline struct { // The description of the image pipeline. Description *string - // The Amazon Resource Name (ARN) of the distribution configuration associated with - // this image pipeline. + // The Amazon Resource Name (ARN) of the distribution configuration associated + // with this image pipeline. DistributionConfigurationArn *string // Collects additional information about the image being created, including the @@ -1088,8 +1071,8 @@ type ImageScanFinding struct { // identified in the finding through a version update. FixAvailable *string - // The Amazon Resource Name (ARN) of the image build version that's associated with - // the finding. + // The Amazon Resource Name (ARN) of the image build version that's associated + // with the finding. ImageBuildVersionArn *string // The Amazon Resource Name (ARN) of the image pipeline that's associated with the @@ -1204,15 +1187,11 @@ type ImageSummary struct { // Indicates the type of build that created this image. The build can be initiated // in the following ways: - // - // * USER_INITIATED – A manual pipeline build request. - // - // * - // SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder - // pipeline, or from EventBridge. - // - // * IMPORT – A VM import created the image to use - // as the base image for the recipe. + // - USER_INITIATED – A manual pipeline build request. + // - SCHEDULED – A pipeline build initiated by a cron expression in the Image + // Builder pipeline, or from EventBridge. + // - IMPORT – A VM import created the image to use as the base image for the + // recipe. BuildType BuildType // The date on which Image Builder created this image. @@ -1274,29 +1253,21 @@ type ImageVersion struct { // The Amazon Resource Name (ARN) of a specific version of an Image Builder image. // Semantic versioning is included in each object's Amazon Resource Name (ARN), at // the level that applies to that object as follows: - // - // * Versionless ARNs and Name - // ARNs do not include specific values in any of the nodes. The nodes are either - // left off entirely, or they are specified as wildcards, for example: x.x.x. - // - // * - // Version ARNs have only the first three nodes: .. - // - // * Build version ARNs have all - // four nodes, and point to a specific build for a specific version of an object. + // - Versionless ARNs and Name ARNs do not include specific values in any of the + // nodes. The nodes are either left off entirely, or they are specified as + // wildcards, for example: x.x.x. + // - Version ARNs have only the first three nodes: .. + // - Build version ARNs have all four nodes, and point to a specific build for a + // specific version of an object. Arn *string // Indicates the type of build that created this image. The build can be initiated // in the following ways: - // - // * USER_INITIATED – A manual pipeline build request. - // - // * - // SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder - // pipeline, or from EventBridge. - // - // * IMPORT – A VM import created the image to use - // as the base image for the recipe. + // - USER_INITIATED – A manual pipeline build request. + // - SCHEDULED – A pipeline build initiated by a cron expression in the Image + // Builder pipeline, or from EventBridge. + // - IMPORT – A VM import created the image to use as the base image for the + // recipe. BuildType BuildType // The date on which this specific version of the Image Builder image was created. @@ -1461,8 +1432,8 @@ type InstanceBlockDeviceMapping struct { noSmithyDocumentSerde } -// Defines a custom base AMI and block device mapping configurations of an instance -// used for building and testing container images. +// Defines a custom base AMI and block device mapping configurations of an +// instance used for building and testing container images. type InstanceConfiguration struct { // Defines the block devices to attach for building an instance from this Image @@ -1479,31 +1450,25 @@ type InstanceConfiguration struct { // The instance metadata options that apply to the HTTP requests that pipeline // builds use to launch EC2 build and test instances. For more information about -// instance metadata options, see Configure the instance metadata options -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) +// instance metadata options, see Configure the instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) // in the Amazon EC2 User Guide for Linux instances, or Configure the instance -// metadata options -// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) +// metadata options (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html) // in the Amazon EC2 Windows Guide for Windows instances. type InstanceMetadataOptions struct { - // Limit the number of hops that an instance metadata request can traverse to reach - // its destination. The default is one hop. However, if HTTP tokens are required, - // container image builds need a minimum of two hops. + // Limit the number of hops that an instance metadata request can traverse to + // reach its destination. The default is one hop. However, if HTTP tokens are + // required, container image builds need a minimum of two hops. HttpPutResponseHopLimit *int32 // Indicates whether a signed token header is required for instance metadata // retrieval requests. The values affect the response as follows: - // - // * required – - // When you retrieve the IAM role credentials, version 2.0 credentials are returned - // in all cases. - // - // * optional – You can include a signed token header in your - // request to retrieve instance metadata, or you can leave it out. If you include - // it, version 2.0 credentials are returned for the IAM role. Otherwise, version - // 1.0 credentials are returned. - // + // - required – When you retrieve the IAM role credentials, version 2.0 + // credentials are returned in all cases. + // - optional – You can include a signed token header in your request to + // retrieve instance metadata, or you can leave it out. If you include it, version + // 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 + // credentials are returned. // The default setting is optional. HttpTokens *string @@ -1511,24 +1476,22 @@ type InstanceMetadataOptions struct { } // Describes the configuration for a launch permission. The launch permission -// modification request is sent to the Amazon EC2 ModifyImageAttribute -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) +// modification request is sent to the Amazon EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) // API on behalf of the user for each Region they have selected to distribute the -// AMI. To make an AMI public, set the launch permission authorized accounts to -// all. See the examples for making an AMI public at Amazon EC2 -// ModifyImageAttribute -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html). +// AMI. To make an AMI public, set the launch permission authorized accounts to all +// . See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html) +// . type LaunchPermissionConfiguration struct { // The ARN for an Amazon Web Services Organization that you want to share your AMI - // with. For more information, see What is Organizations? - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html). + // with. For more information, see What is Organizations? (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) + // . OrganizationArns []string // The ARN for an Organizations organizational unit (OU) that you want to share // your AMI with. For more information about key concepts for Organizations, see - // Organizations terminology and concepts - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html). + // Organizations terminology and concepts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html) + // . OrganizationalUnitArns []string // The name of the group. @@ -1588,8 +1551,8 @@ type PackageVulnerabilityDetails struct { // This member is required. VulnerabilityId *string - // CVSS scores for one or more vulnerabilities that Amazon Inspector identified for - // a package. + // CVSS scores for one or more vulnerabilities that Amazon Inspector identified + // for a package. Cvss []CvssScore // Links to web pages that contain details about the vulnerabilities that Amazon @@ -1649,23 +1612,18 @@ type RemediationRecommendation struct { // format for your VM. type S3ExportConfiguration struct { - // Export the updated image to one of the following supported disk image - // formats: - // - // * Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft - // Hyper-V virtualization products. - // - // * Stream-optimized ESX Virtual Machine Disk - // (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6. - // - // * - // Raw – Raw format. + // Export the updated image to one of the following supported disk image formats: + // - Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V + // virtualization products. + // - Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware + // ESX and VMware vSphere versions 4, 5, and 6. + // - Raw – Raw format. // // This member is required. DiskImageFormat DiskImageFormat - // The name of the role that grants VM Import/Export permission to export images to - // your S3 bucket. + // The name of the role that grants VM Import/Export permission to export images + // to your S3 bucket. // // This member is required. RoleName *string @@ -1700,34 +1658,32 @@ type Schedule struct { // The condition configures when the pipeline should trigger a new image build. // When the pipelineExecutionStartCondition is set to - // EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version + // EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version // filters on the base image or components in your image recipe, EC2 Image Builder // will build a new image only when there are new versions of the image or // components in your recipe that match the semantic version filter. When it is set - // to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON + // to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON // expression matches the current time. For semantic version syntax, see - // CreateComponent - // (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) + // CreateComponent (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) // in the EC2 Image Builder API Reference. PipelineExecutionStartCondition PipelineExecutionStartCondition // The cron expression determines how often EC2 Image Builder evaluates your - // pipelineExecutionStartCondition. For information on how to format a cron - // expression in Image Builder, see Use cron expressions in EC2 Image Builder - // (https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html). + // pipelineExecutionStartCondition . For information on how to format a cron + // expression in Image Builder, see Use cron expressions in EC2 Image Builder (https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html) + // . ScheduleExpression *string // The timezone that applies to the scheduling expression. For example, "Etc/UTC", - // "America/Los_Angeles" in the IANA timezone format - // (https://www.joda.org/joda-time/timezones.html). If not specified this defaults - // to UTC. + // "America/Los_Angeles" in the IANA timezone format (https://www.joda.org/joda-time/timezones.html) + // . If not specified this defaults to UTC. Timezone *string noSmithyDocumentSerde } -// Includes counts by severity level for medium severity and higher level findings, -// plus a total for all of the findings for the specified filter. +// Includes counts by severity level for medium severity and higher level +// findings, plus a total for all of the findings for the specified filter. type SeverityCounts struct { // The total number of findings across all severity levels for the specified @@ -1761,8 +1717,8 @@ type SystemsManagerAgent struct { // The container repository where the output container image is stored. type TargetContainerRepository struct { - // The name of the container repository where the output container image is stored. - // This name is prefixed by the repository location. + // The name of the container repository where the output container image is + // stored. This name is prefixed by the repository location. // // This member is required. RepositoryName *string @@ -1841,8 +1797,8 @@ type WorkflowExecutionMetadata struct { // The current runtime status for this workflow. Status WorkflowExecutionStatus - // The total number of steps in the workflow. This should equal the sum of the step - // counts for steps that succeeded, were skipped, and failed. + // The total number of steps in the workflow. This should equal the sum of the + // step counts for steps that succeeded, were skipped, and failed. TotalStepCount int32 // A runtime count for the number of steps in the workflow that failed. @@ -1854,8 +1810,8 @@ type WorkflowExecutionMetadata struct { // A runtime count for the number of steps in the workflow that ran successfully. TotalStepsSucceeded int32 - // Indicates what type of workflow that Image Builder ran for this runtime instance - // of the workflow. + // Indicates what type of workflow that Image Builder ran for this runtime + // instance of the workflow. Type WorkflowType // The Amazon Resource Name (ARN) of the workflow resource build version that ran. diff --git a/service/inspector/api_client.go b/service/inspector/api_client.go index 5eaf6b60696..b1c2bb8324d 100644 --- a/service/inspector/api_client.go +++ b/service/inspector/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/inspector/api_op_CreateAssessmentTarget.go b/service/inspector/api_op_CreateAssessmentTarget.go index f85a2ee5091..e4831b65105 100644 --- a/service/inspector/api_op_CreateAssessmentTarget.go +++ b/service/inspector/api_op_CreateAssessmentTarget.go @@ -11,16 +11,15 @@ import ( ) // Creates a new assessment target using the ARN of the resource group that is -// generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 +// generated by CreateResourceGroup . If resourceGroupArn is not specified, all EC2 // instances in the current AWS account and region are included in the assessment -// target. If the service-linked role -// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) +// target. If the service-linked role (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) // isn’t already registered, this action also creates and registers a // service-linked role to grant Amazon Inspector access to AWS Services needed to // perform security assessments. You can create up to 50 assessment targets per AWS // account. You can run up to 500 concurrent agents per AWS account. For more -// information, see Amazon Inspector Assessment Targets -// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html). +// information, see Amazon Inspector Assessment Targets (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html) +// . func (c *Client) CreateAssessmentTarget(ctx context.Context, params *CreateAssessmentTargetInput, optFns ...func(*Options)) (*CreateAssessmentTargetOutput, error) { if params == nil { params = &CreateAssessmentTargetInput{} diff --git a/service/inspector/api_op_CreateAssessmentTemplate.go b/service/inspector/api_op_CreateAssessmentTemplate.go index e5ac9bdce64..588d08c6307 100644 --- a/service/inspector/api_op_CreateAssessmentTemplate.go +++ b/service/inspector/api_op_CreateAssessmentTemplate.go @@ -12,8 +12,7 @@ import ( ) // Creates an assessment template for the assessment target that is specified by -// the ARN of the assessment target. If the service-linked role -// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) +// the ARN of the assessment target. If the service-linked role (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html) // isn’t already registered, this action also creates and registers a // service-linked role to grant Amazon Inspector access to AWS Services needed to // perform security assessments. @@ -59,10 +58,10 @@ type CreateAssessmentTemplateInput struct { // This member is required. RulesPackageArns []string - // The user-defined attributes that are assigned to every finding that is generated - // by the assessment run that uses this assessment template. An attribute is a key - // and value pair (an Attribute object). Within an assessment template, each key - // must be unique. + // The user-defined attributes that are assigned to every finding that is + // generated by the assessment run that uses this assessment template. An attribute + // is a key and value pair (an Attribute object). Within an assessment template, + // each key must be unique. UserAttributesForFindings []types.Attribute noSmithyDocumentSerde diff --git a/service/inspector/api_op_CreateExclusionsPreview.go b/service/inspector/api_op_CreateExclusionsPreview.go index 4a7b9715050..6b56ea66526 100644 --- a/service/inspector/api_op_CreateExclusionsPreview.go +++ b/service/inspector/api_op_CreateExclusionsPreview.go @@ -41,8 +41,8 @@ type CreateExclusionsPreviewInput struct { type CreateExclusionsPreviewOutput struct { - // Specifies the unique identifier of the requested exclusions preview. You can use - // the unique identifier to retrieve the exclusions preview when running the + // Specifies the unique identifier of the requested exclusions preview. You can + // use the unique identifier to retrieve the exclusions preview when running the // GetExclusionsPreview API. // // This member is required. diff --git a/service/inspector/api_op_CreateResourceGroup.go b/service/inspector/api_op_CreateResourceGroup.go index b553be12eaf..cc5bfb18bad 100644 --- a/service/inspector/api_op_CreateResourceGroup.go +++ b/service/inspector/api_op_CreateResourceGroup.go @@ -14,7 +14,7 @@ import ( // Creates a resource group using the specified set of tags (key and value pairs) // that are used to select the EC2 instances to be included in an Amazon Inspector // assessment target. The created resource group is then used to create an Amazon -// Inspector assessment target. For more information, see CreateAssessmentTarget. +// Inspector assessment target. For more information, see CreateAssessmentTarget . func (c *Client) CreateResourceGroup(ctx context.Context, params *CreateResourceGroupInput, optFns ...func(*Options)) (*CreateResourceGroupOutput, error) { if params == nil { params = &CreateResourceGroupInput{} diff --git a/service/inspector/api_op_GetAssessmentReport.go b/service/inspector/api_op_GetAssessmentReport.go index 92482378215..471726c14e9 100644 --- a/service/inspector/api_op_GetAssessmentReport.go +++ b/service/inspector/api_op_GetAssessmentReport.go @@ -42,10 +42,10 @@ type GetAssessmentReportInput struct { // This member is required. ReportFileFormat types.ReportFileFormat - // Specifies the type of the assessment report that you want to generate. There are - // two types of assessment reports: a finding report and a full report. For more - // information, see Assessment Reports - // (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html). + // Specifies the type of the assessment report that you want to generate. There + // are two types of assessment reports: a finding report and a full report. For + // more information, see Assessment Reports (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html) + // . // // This member is required. ReportType types.ReportType diff --git a/service/inspector/api_op_ListAssessmentRunAgents.go b/service/inspector/api_op_ListAssessmentRunAgents.go index 0d2ca5cbb71..748926bb229 100644 --- a/service/inspector/api_op_ListAssessmentRunAgents.go +++ b/service/inspector/api_op_ListAssessmentRunAgents.go @@ -42,8 +42,8 @@ type ListAssessmentRunAgentsInput struct { // attribute, any of the values can match. Filter *types.AgentFilter - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 10. The maximum value is 500. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 10. The maximum value is 500. MaxResults *int32 // You can use this parameter when paginating results. Set the value of this @@ -62,10 +62,10 @@ type ListAssessmentRunAgentsOutput struct { // This member is required. AssessmentRunAgents []types.AssessmentRunAgent - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. @@ -148,8 +148,8 @@ var _ ListAssessmentRunAgentsAPIClient = (*Client)(nil) // ListAssessmentRunAgentsPaginatorOptions is the paginator options for // ListAssessmentRunAgents type ListAssessmentRunAgentsPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 10. The maximum value is 500. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 10. The maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/inspector/api_op_ListAssessmentRuns.go b/service/inspector/api_op_ListAssessmentRuns.go index 0c6fbf8a63e..e922643c00c 100644 --- a/service/inspector/api_op_ListAssessmentRuns.go +++ b/service/inspector/api_op_ListAssessmentRuns.go @@ -31,8 +31,8 @@ func (c *Client) ListAssessmentRuns(ctx context.Context, params *ListAssessmentR type ListAssessmentRunsInput struct { - // The ARNs that specify the assessment templates whose assessment runs you want to - // list. + // The ARNs that specify the assessment templates whose assessment runs you want + // to list. AssessmentTemplateArns []string // You can use this parameter to specify a subset of data to be included in the @@ -41,8 +41,8 @@ type ListAssessmentRunsInput struct { // attribute, any of the values can match. Filter *types.AssessmentRunFilter - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 10. The maximum value is 500. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 10. The maximum value is 500. MaxResults *int32 // You can use this parameter when paginating results. Set the value of this @@ -62,10 +62,10 @@ type ListAssessmentRunsOutput struct { // This member is required. AssessmentRunArns []string - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. @@ -145,8 +145,8 @@ var _ ListAssessmentRunsAPIClient = (*Client)(nil) // ListAssessmentRunsPaginatorOptions is the paginator options for // ListAssessmentRuns type ListAssessmentRunsPaginatorOptions struct { - // You can use this parameter to indicate the maximum number of items that you want - // in the response. The default value is 10. The maximum value is 500. + // You can use this parameter to indicate the maximum number of items that you + // want in the response. The default value is 10. The maximum value is 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/inspector/api_op_ListAssessmentTargets.go b/service/inspector/api_op_ListAssessmentTargets.go index 13131a58e2a..03b16db54d1 100644 --- a/service/inspector/api_op_ListAssessmentTargets.go +++ b/service/inspector/api_op_ListAssessmentTargets.go @@ -13,8 +13,8 @@ import ( ) // Lists the ARNs of the assessment targets within this AWS account. For more -// information about assessment targets, see Amazon Inspector Assessment Targets -// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html). +// information about assessment targets, see Amazon Inspector Assessment Targets (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html) +// . func (c *Client) ListAssessmentTargets(ctx context.Context, params *ListAssessmentTargetsInput, optFns ...func(*Options)) (*ListAssessmentTargetsOutput, error) { if params == nil { params = &ListAssessmentTargetsInput{} @@ -59,10 +59,10 @@ type ListAssessmentTargetsOutput struct { // This member is required. AssessmentTargetArns []string - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_ListAssessmentTemplates.go b/service/inspector/api_op_ListAssessmentTemplates.go index 466356dcbd3..89f108147bf 100644 --- a/service/inspector/api_op_ListAssessmentTemplates.go +++ b/service/inspector/api_op_ListAssessmentTemplates.go @@ -61,10 +61,10 @@ type ListAssessmentTemplatesOutput struct { // This member is required. AssessmentTemplateArns []string - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_ListEventSubscriptions.go b/service/inspector/api_op_ListEventSubscriptions.go index 193bf2e53ab..5f8c373cb14 100644 --- a/service/inspector/api_op_ListEventSubscriptions.go +++ b/service/inspector/api_op_ListEventSubscriptions.go @@ -14,7 +14,7 @@ import ( // Lists all the event subscriptions for the assessment template that is specified // by the ARN of the assessment template. For more information, see -// SubscribeToEvent and UnsubscribeFromEvent. +// SubscribeToEvent and UnsubscribeFromEvent . func (c *Client) ListEventSubscriptions(ctx context.Context, params *ListEventSubscriptionsInput, optFns ...func(*Options)) (*ListEventSubscriptionsOutput, error) { if params == nil { params = &ListEventSubscriptionsInput{} @@ -42,8 +42,8 @@ type ListEventSubscriptionsInput struct { // NextToken from the previous response to continue listing data. NextToken *string - // The ARN of the assessment template for which you want to list the existing event - // subscriptions. + // The ARN of the assessment template for which you want to list the existing + // event subscriptions. ResourceArn *string noSmithyDocumentSerde @@ -56,10 +56,10 @@ type ListEventSubscriptionsOutput struct { // This member is required. Subscriptions []types.Subscription - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_ListFindings.go b/service/inspector/api_op_ListFindings.go index 9dd36bd7d0f..81ef4398ada 100644 --- a/service/inspector/api_op_ListFindings.go +++ b/service/inspector/api_op_ListFindings.go @@ -61,10 +61,10 @@ type ListFindingsOutput struct { // This member is required. FindingArns []string - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_ListRulesPackages.go b/service/inspector/api_op_ListRulesPackages.go index 33c451cdc6b..402b1196255 100644 --- a/service/inspector/api_op_ListRulesPackages.go +++ b/service/inspector/api_op_ListRulesPackages.go @@ -49,10 +49,10 @@ type ListRulesPackagesOutput struct { // This member is required. RulesPackageArns []string - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_PreviewAgents.go b/service/inspector/api_op_PreviewAgents.go index 6069ce5742e..875b4eaec13 100644 --- a/service/inspector/api_op_PreviewAgents.go +++ b/service/inspector/api_op_PreviewAgents.go @@ -56,10 +56,10 @@ type PreviewAgentsOutput struct { // This member is required. AgentPreviews []types.AgentPreview - // When a response is generated, if there is more data to be listed, this parameter - // is present in the response and contains the value to use for the nextToken - // parameter in a subsequent pagination request. If there is no more data to be - // listed, this parameter is set to null. + // When a response is generated, if there is more data to be listed, this + // parameter is present in the response and contains the value to use for the + // nextToken parameter in a subsequent pagination request. If there is no more data + // to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/inspector/api_op_StartAssessmentRun.go b/service/inspector/api_op_StartAssessmentRun.go index 131a55d21c5..2065a571372 100644 --- a/service/inspector/api_op_StartAssessmentRun.go +++ b/service/inspector/api_op_StartAssessmentRun.go @@ -35,8 +35,8 @@ type StartAssessmentRunInput struct { // This member is required. AssessmentTemplateArn *string - // You can specify the name for the assessment run. The name must be unique for the - // assessment template whose ARN is used to start the assessment run. + // You can specify the name for the assessment run. The name must be unique for + // the assessment template whose ARN is used to start the assessment run. AssessmentRunName *string noSmithyDocumentSerde diff --git a/service/inspector/doc.go b/service/inspector/doc.go index c6372b7c7e4..6f30b22125c 100644 --- a/service/inspector/doc.go +++ b/service/inspector/doc.go @@ -5,6 +5,6 @@ // // Amazon Inspector Amazon Inspector enables you to analyze the behavior of your // AWS resources and to identify potential security issues. For more information, -// see Amazon Inspector User Guide -// (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html). +// see Amazon Inspector User Guide (https://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html) +// . package inspector diff --git a/service/inspector/types/enums.go b/service/inspector/types/enums.go index 3e2951ded53..3cceab70b2e 100644 --- a/service/inspector/types/enums.go +++ b/service/inspector/types/enums.go @@ -16,8 +16,8 @@ const ( AccessDeniedErrorCodeAccessDeniedToIamRole AccessDeniedErrorCode = "ACCESS_DENIED_TO_IAM_ROLE" ) -// Values returns all known values for AccessDeniedErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AccessDeniedErrorCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AccessDeniedErrorCode) Values() []AccessDeniedErrorCode { return []AccessDeniedErrorCode{ @@ -88,9 +88,9 @@ const ( AssessmentRunNotificationSnsStatusCodeInternalError AssessmentRunNotificationSnsStatusCode = "INTERNAL_ERROR" ) -// Values returns all known values for AssessmentRunNotificationSnsStatusCode. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for AssessmentRunNotificationSnsStatusCode. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (AssessmentRunNotificationSnsStatusCode) Values() []AssessmentRunNotificationSnsStatusCode { return []AssessmentRunNotificationSnsStatusCode{ @@ -148,9 +148,9 @@ const ( AssetTypeEc2Instance AssetType = "ec2-instance" ) -// Values returns all known values for AssetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AssetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AssetType) Values() []AssetType { return []AssetType{ "ec2-instance", @@ -286,8 +286,8 @@ const ( InvalidInputErrorCodeInvalidNumberOfSeverities InvalidInputErrorCode = "INVALID_NUMBER_OF_SEVERITIES" ) -// Values returns all known values for InvalidInputErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InvalidInputErrorCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InvalidInputErrorCode) Values() []InvalidInputErrorCode { return []InvalidInputErrorCode{ @@ -402,8 +402,8 @@ const ( NoSuchEntityErrorCodeIamRoleDoesNotExist NoSuchEntityErrorCode = "IAM_ROLE_DOES_NOT_EXIST" ) -// Values returns all known values for NoSuchEntityErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NoSuchEntityErrorCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NoSuchEntityErrorCode) Values() []NoSuchEntityErrorCode { return []NoSuchEntityErrorCode{ @@ -463,9 +463,9 @@ const ( ReportStatusCompleted ReportStatus = "COMPLETED" ) -// Values returns all known values for ReportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReportStatus) Values() []ReportStatus { return []ReportStatus{ "WORK_IN_PROGRESS", @@ -500,9 +500,9 @@ const ( ScopeTypeRulesPackageArn ScopeType = "RULES_PACKAGE_ARN" ) -// Values returns all known values for ScopeType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ScopeType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ScopeType) Values() []ScopeType { return []ScopeType{ "INSTANCE_ID", diff --git a/service/inspector/types/errors.go b/service/inspector/types/errors.go index 5ef39cef43d..2d6166f2f9f 100644 --- a/service/inspector/types/errors.go +++ b/service/inspector/types/errors.go @@ -36,8 +36,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You started an assessment run, but one of the instances is already participating -// in another assessment run. +// You started an assessment run, but one of the instances is already +// participating in another assessment run. type AgentsAlreadyRunningAssessmentException struct { Message *string @@ -128,8 +128,8 @@ func (e *InternalException) ErrorCode() string { } func (e *InternalException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// Amazon Inspector cannot assume the cross-account role that it needs to list your -// EC2 instances during the assessment run. +// Amazon Inspector cannot assume the cross-account role that it needs to list +// your EC2 instances during the assessment run. type InvalidCrossAccountRoleException struct { Message *string diff --git a/service/inspector/types/types.go b/service/inspector/types/types.go index 6d2e3de78cf..6e0f6846ee2 100644 --- a/service/inspector/types/types.go +++ b/service/inspector/types/types.go @@ -7,13 +7,13 @@ import ( "time" ) -// Used in the exception error that is thrown if you start an assessment run for an -// assessment target that includes an EC2 instance that is already participating in -// another started assessment run. +// Used in the exception error that is thrown if you start an assessment run for +// an assessment target that includes an EC2 instance that is already participating +// in another started assessment run. type AgentAlreadyRunningAssessment struct { - // ID of the agent that is running on an EC2 instance that is already participating - // in another started assessment run. + // ID of the agent that is running on an EC2 instance that is already + // participating in another started assessment run. // // This member is required. AgentId *string @@ -101,8 +101,8 @@ type AssessmentRun struct { // This member is required. CreatedAt *time.Time - // A Boolean value (true or false) that specifies whether the process of collecting - // data from the agents is completed. + // A Boolean value (true or false) that specifies whether the process of + // collecting data from the agents is completed. // // This member is required. DataCollected *bool @@ -311,8 +311,8 @@ type AssessmentTarget struct { // This member is required. UpdatedAt *time.Time - // The ARN that specifies the resource group that is associated with the assessment - // target. + // The ARN that specifies the resource group that is associated with the + // assessment target. ResourceGroupArn *string noSmithyDocumentSerde @@ -338,8 +338,8 @@ type AssessmentTemplate struct { // This member is required. Arn *string - // The number of existing assessment runs associated with this assessment template. - // This value can be zero or a positive integer. + // The number of existing assessment runs associated with this assessment + // template. This value can be zero or a positive integer. // // This member is required. AssessmentRunCount *int32 @@ -376,8 +376,8 @@ type AssessmentTemplate struct { // This member is required. UserAttributesForFindings []Attribute - // The Amazon Resource Name (ARN) of the most recent assessment run associated with - // this assessment template. This value exists only when the value of + // The Amazon Resource Name (ARN) of the most recent assessment run associated + // with this assessment template. This value exists only when the value of // assessmentRunCount is greaterpa than zero. LastAssessmentRunArn *string @@ -397,8 +397,8 @@ type AssessmentTemplateFilter struct { // the assessmentTemplateName property of the AssessmentTemplate data type. NamePattern *string - // For a record to match a filter, the values that are specified for this data type - // property must be contained in the list of values of the rulesPackageArns + // For a record to match a filter, the values that are specified for this data + // type property must be contained in the list of values of the rulesPackageArns // property of the AssessmentTemplate data type. RulesPackageArns []string @@ -440,8 +440,8 @@ type AssetAttributes struct { noSmithyDocumentSerde } -// This data type is used as a request parameter in the AddAttributesToFindings and -// CreateAssessmentTemplate actions. +// This data type is used as a request parameter in the AddAttributesToFindings +// and CreateAssessmentTemplate actions. type Attribute struct { // The attribute key. @@ -752,9 +752,9 @@ type PrivateIp struct { noSmithyDocumentSerde } -// Contains information about a resource group. The resource group defines a set of -// tags that, when queried, identify the AWS resources that make up the assessment -// target. This data type is used as the response element in the +// Contains information about a resource group. The resource group defines a set +// of tags that, when queried, identify the AWS resources that make up the +// assessment target. This data type is used as the response element in the // DescribeResourceGroups action. type ResourceGroup struct { @@ -768,8 +768,8 @@ type ResourceGroup struct { // This member is required. CreatedAt *time.Time - // The tags (key and value pairs) of the resource group. This data type property is - // used in the CreateResourceGroup action. + // The tags (key and value pairs) of the resource group. This data type property + // is used in the CreateResourceGroup action. // // This member is required. Tags []ResourceGroupTag @@ -833,8 +833,9 @@ type Scope struct { noSmithyDocumentSerde } -// Contains information about a security group associated with a network interface. -// This data type is used as one of the elements of the NetworkInterface data type. +// Contains information about a security group associated with a network +// interface. This data type is used as one of the elements of the NetworkInterface +// data type. type SecurityGroup struct { // The ID of the security group. diff --git a/service/inspector2/api_client.go b/service/inspector2/api_client.go index 134999b5395..2a6ee75b3f5 100644 --- a/service/inspector2/api_client.go +++ b/service/inspector2/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/inspector2/api_op_BatchGetFreeTrialInfo.go b/service/inspector2/api_op_BatchGetFreeTrialInfo.go index 98ae8a0162f..902b329d318 100644 --- a/service/inspector2/api_op_BatchGetFreeTrialInfo.go +++ b/service/inspector2/api_op_BatchGetFreeTrialInfo.go @@ -39,8 +39,8 @@ type BatchGetFreeTrialInfoInput struct { type BatchGetFreeTrialInfoOutput struct { - // An array of objects that provide Amazon Inspector free trial details for each of - // the requested accounts. + // An array of objects that provide Amazon Inspector free trial details for each + // of the requested accounts. // // This member is required. Accounts []types.FreeTrialAccountInfo diff --git a/service/inspector2/api_op_DescribeOrganizationConfiguration.go b/service/inspector2/api_op_DescribeOrganizationConfiguration.go index 13c2557acef..afe61821652 100644 --- a/service/inspector2/api_op_DescribeOrganizationConfiguration.go +++ b/service/inspector2/api_op_DescribeOrganizationConfiguration.go @@ -37,8 +37,8 @@ type DescribeOrganizationConfigurationOutput struct { // The scan types are automatically enabled for new members of your organization. AutoEnable *types.AutoEnable - // Represents whether your organization has reached the maximum Amazon Web Services - // account limit for Amazon Inspector. + // Represents whether your organization has reached the maximum Amazon Web + // Services account limit for Amazon Inspector. MaxAccountLimitReached *bool // Metadata pertaining to the operation's result. diff --git a/service/inspector2/api_op_GetMember.go b/service/inspector2/api_op_GetMember.go index 09e11acdacf..8e7217cdf86 100644 --- a/service/inspector2/api_op_GetMember.go +++ b/service/inspector2/api_op_GetMember.go @@ -29,8 +29,8 @@ func (c *Client) GetMember(ctx context.Context, params *GetMemberInput, optFns . type GetMemberInput struct { - // The Amazon Web Services account ID of the member account to retrieve information - // on. + // The Amazon Web Services account ID of the member account to retrieve + // information on. // // This member is required. AccountId *string diff --git a/service/inspector2/api_op_ListAccountPermissions.go b/service/inspector2/api_op_ListAccountPermissions.go index 5eb41c0f830..3ba33990b41 100644 --- a/service/inspector2/api_op_ListAccountPermissions.go +++ b/service/inspector2/api_op_ListAccountPermissions.go @@ -33,8 +33,8 @@ type ListAccountPermissionsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -53,8 +53,8 @@ type ListAccountPermissionsOutput struct { // This member is required. Permissions []types.Permission - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListCoverage.go b/service/inspector2/api_op_ListCoverage.go index a59d698ad3c..0b7e3d7e815 100644 --- a/service/inspector2/api_op_ListCoverage.go +++ b/service/inspector2/api_op_ListCoverage.go @@ -30,15 +30,15 @@ func (c *Client) ListCoverage(ctx context.Context, params *ListCoverageInput, op type ListCoverageInput struct { - // An object that contains details on the filters to apply to the coverage data for - // your environment. + // An object that contains details on the filters to apply to the coverage data + // for your environment. FilterCriteria *types.CoverageFilterCriteria // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -51,8 +51,8 @@ type ListCoverageOutput struct { // An object that contains details on the covered resources in your environment. CoveredResources []types.CoveredResource - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListCoverageStatistics.go b/service/inspector2/api_op_ListCoverageStatistics.go index b0cf3d877f7..3a5dba50b24 100644 --- a/service/inspector2/api_op_ListCoverageStatistics.go +++ b/service/inspector2/api_op_ListCoverageStatistics.go @@ -30,15 +30,15 @@ func (c *Client) ListCoverageStatistics(ctx context.Context, params *ListCoverag type ListCoverageStatisticsInput struct { - // An object that contains details on the filters to apply to the coverage data for - // your environment. + // An object that contains details on the filters to apply to the coverage data + // for your environment. FilterCriteria *types.CoverageFilterCriteria // The value to group the results by. GroupBy types.GroupKey - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -56,8 +56,8 @@ type ListCoverageStatisticsOutput struct { // An array with the number for each group. CountsByGroup []types.Counts - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListDelegatedAdminAccounts.go b/service/inspector2/api_op_ListDelegatedAdminAccounts.go index cfc31608355..02fd0e54bed 100644 --- a/service/inspector2/api_op_ListDelegatedAdminAccounts.go +++ b/service/inspector2/api_op_ListDelegatedAdminAccounts.go @@ -34,8 +34,8 @@ type ListDelegatedAdminAccountsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -48,8 +48,8 @@ type ListDelegatedAdminAccountsOutput struct { // Details of the Amazon Inspector delegated administrator of your organization. DelegatedAdminAccounts []types.DelegatedAdminAccount - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListFilters.go b/service/inspector2/api_op_ListFilters.go index da4d3a59793..acae12e2343 100644 --- a/service/inspector2/api_op_ListFilters.go +++ b/service/inspector2/api_op_ListFilters.go @@ -39,8 +39,8 @@ type ListFiltersInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -55,8 +55,8 @@ type ListFiltersOutput struct { // This member is required. Filters []types.Filter - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListFindingAggregations.go b/service/inspector2/api_op_ListFindingAggregations.go index cfe1f4a82a7..fed900e45be 100644 --- a/service/inspector2/api_op_ListFindingAggregations.go +++ b/service/inspector2/api_op_ListFindingAggregations.go @@ -45,8 +45,8 @@ type ListFindingAggregationsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -61,8 +61,8 @@ type ListFindingAggregationsOutput struct { // This member is required. AggregationType types.AggregationType - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListFindings.go b/service/inspector2/api_op_ListFindings.go index b6744090a9d..5808c5dd352 100644 --- a/service/inspector2/api_op_ListFindings.go +++ b/service/inspector2/api_op_ListFindings.go @@ -36,8 +36,8 @@ type ListFindingsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string @@ -53,8 +53,8 @@ type ListFindingsOutput struct { // Contains details on the findings in your environment. Findings []types.Finding - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/api_op_ListMembers.go b/service/inspector2/api_op_ListMembers.go index e89acb27240..b45bf58e569 100644 --- a/service/inspector2/api_op_ListMembers.go +++ b/service/inspector2/api_op_ListMembers.go @@ -34,14 +34,14 @@ type ListMembersInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string // Specifies whether to list only currently associated members if True or to list - // all members within the organization if False. + // all members within the organization if False . OnlyAssociated *bool noSmithyDocumentSerde diff --git a/service/inspector2/api_op_ListUsageTotals.go b/service/inspector2/api_op_ListUsageTotals.go index f8c74a1d3b8..2f95cdf276b 100644 --- a/service/inspector2/api_op_ListUsageTotals.go +++ b/service/inspector2/api_op_ListUsageTotals.go @@ -36,8 +36,8 @@ type ListUsageTotalsInput struct { // The maximum number of results to return in the response. MaxResults *int32 - // A token to use for paginating results that are returned in the response. Set the - // value of this parameter to null for the first request to a list action. For + // A token to use for paginating results that are returned in the response. Set + // the value of this parameter to null for the first request to a list action. For // subsequent calls, use the NextToken value returned from the previous request to // continue listing results after the first page. NextToken *string diff --git a/service/inspector2/types/enums.go b/service/inspector2/types/enums.go index 4f7ca96d357..2149e3a8a24 100644 --- a/service/inspector2/types/enums.go +++ b/service/inspector2/types/enums.go @@ -106,9 +106,9 @@ const ( AmiSortByAffectedInstances AmiSortBy = "AFFECTED_INSTANCES" ) -// Values returns all known values for AmiSortBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AmiSortBy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AmiSortBy) Values() []AmiSortBy { return []AmiSortBy{ "CRITICAL", @@ -126,9 +126,9 @@ const ( ArchitectureArm64 Architecture = "ARM64" ) -// Values returns all known values for Architecture. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Architecture. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Architecture) Values() []Architecture { return []Architecture{ "X86_64", @@ -145,8 +145,8 @@ const ( AwsEcrContainerSortByAll AwsEcrContainerSortBy = "ALL" ) -// Values returns all known values for AwsEcrContainerSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AwsEcrContainerSortBy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AwsEcrContainerSortBy) Values() []AwsEcrContainerSortBy { return []AwsEcrContainerSortBy{ @@ -163,8 +163,8 @@ const ( CoverageMapComparisonEquals CoverageMapComparison = "EQUALS" ) -// Values returns all known values for CoverageMapComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CoverageMapComparison. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CoverageMapComparison) Values() []CoverageMapComparison { return []CoverageMapComparison{ @@ -202,9 +202,9 @@ const ( CoverageStringComparisonNotEquals CoverageStringComparison = "NOT_EQUALS" ) -// Values returns all known values for CoverageStringComparison. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CoverageStringComparison. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CoverageStringComparison) Values() []CoverageStringComparison { return []CoverageStringComparison{ "EQUALS", @@ -368,9 +368,9 @@ const ( ErrorCodeAccountIsIsolated ErrorCode = "ACCOUNT_IS_ISOLATED" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "ALREADY_ENABLED", @@ -438,9 +438,9 @@ const ( FilterActionSuppress FilterAction = "SUPPRESS" ) -// Values returns all known values for FilterAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FilterAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FilterAction) Values() []FilterAction { return []FilterAction{ "NONE", @@ -515,9 +515,9 @@ const ( FixAvailablePartial FixAvailable = "PARTIAL" ) -// Values returns all known values for FixAvailable. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FixAvailable. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FixAvailable) Values() []FixAvailable { return []FixAvailable{ "YES", @@ -710,9 +710,9 @@ const ( OperationDisableRepository Operation = "DISABLE_REPOSITORY" ) -// Values returns all known values for Operation. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Operation. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Operation) Values() []Operation { return []Operation{ "ENABLE_SCANNING", @@ -852,9 +852,9 @@ const ( ReportFormatJson ReportFormat = "JSON" ) -// Values returns all known values for ReportFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReportFormat) Values() []ReportFormat { return []ReportFormat{ "CSV", @@ -940,9 +940,9 @@ const ( ResourceTypeAwsLambdaFunction ResourceType = "AWS_LAMBDA_FUNCTION" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "AWS_EC2_INSTANCE", @@ -1146,9 +1146,9 @@ const ( SortFieldVendorSeverity SortField = "VENDOR_SEVERITY" ) -// Values returns all known values for SortField. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortField. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortField) Values() []SortField { return []SortField{ "AWS_ACCOUNT_ID", @@ -1178,9 +1178,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", @@ -1264,9 +1264,9 @@ const ( UsageTypeLambdaFunctionHours UsageType = "LAMBDA_FUNCTION_HOURS" ) -// Values returns all known values for UsageType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for UsageType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (UsageType) Values() []UsageType { return []UsageType{ "EC2_INSTANCE_HOURS", diff --git a/service/inspector2/types/types.go b/service/inspector2/types/types.go index 2d09e424c11..35e9db6ada6 100644 --- a/service/inspector2/types/types.go +++ b/service/inspector2/types/types.go @@ -7,8 +7,8 @@ import ( "time" ) -// An Amazon Web Services account within your environment that Amazon Inspector has -// been enabled for. +// An Amazon Web Services account within your environment that Amazon Inspector +// has been enabled for. type Account struct { // The ID of the Amazon Web Services account. @@ -102,8 +102,8 @@ type AggregationRequest interface { isAggregationRequest() } -// An object that contains details about an aggregation request based on Amazon Web -// Services account IDs. +// An object that contains details about an aggregation request based on Amazon +// Web Services account IDs. type AggregationRequestMemberAccountAggregation struct { Value AccountAggregation @@ -122,8 +122,8 @@ type AggregationRequestMemberAmiAggregation struct { func (*AggregationRequestMemberAmiAggregation) isAggregationRequest() {} -// An object that contains details about an aggregation request based on Amazon ECR -// container images. +// An object that contains details about an aggregation request based on Amazon +// ECR container images. type AggregationRequestMemberAwsEcrContainerAggregation struct { Value AwsEcrContainerAggregation @@ -132,8 +132,8 @@ type AggregationRequestMemberAwsEcrContainerAggregation struct { func (*AggregationRequestMemberAwsEcrContainerAggregation) isAggregationRequest() {} -// An object that contains details about an aggregation request based on Amazon EC2 -// instances. +// An object that contains details about an aggregation request based on Amazon +// EC2 instances. type AggregationRequestMemberEc2InstanceAggregation struct { Value Ec2InstanceAggregation @@ -190,8 +190,8 @@ type AggregationRequestMemberPackageAggregation struct { func (*AggregationRequestMemberPackageAggregation) isAggregationRequest() {} -// An object that contains details about an aggregation request based on Amazon ECR -// repositories. +// An object that contains details about an aggregation request based on Amazon +// ECR repositories. type AggregationRequestMemberRepositoryAggregation struct { Value RepositoryAggregation @@ -279,8 +279,8 @@ type AggregationResponseMemberFindingTypeAggregation struct { func (*AggregationResponseMemberFindingTypeAggregation) isAggregationResponse() {} -// An object that contains details about an aggregation response based on container -// image layers. +// An object that contains details about an aggregation response based on +// container image layers. type AggregationResponseMemberImageLayerAggregation struct { Value ImageLayerAggregationResponse @@ -307,8 +307,8 @@ type AggregationResponseMemberLambdaLayerAggregation struct { func (*AggregationResponseMemberLambdaLayerAggregation) isAggregationResponse() {} -// An object that contains details about an aggregation response based on operating -// system package type. +// An object that contains details about an aggregation response based on +// operating system package type. type AggregationResponseMemberPackageAggregation struct { Value PackageAggregationResponse @@ -376,20 +376,20 @@ type AmiAggregationResponse struct { // Amazon Inspector organization. type AutoEnable struct { - // Represents whether Amazon EC2 scans are automatically enabled for new members of - // your Amazon Inspector organization. + // Represents whether Amazon EC2 scans are automatically enabled for new members + // of your Amazon Inspector organization. // // This member is required. Ec2 *bool - // Represents whether Amazon ECR scans are automatically enabled for new members of - // your Amazon Inspector organization. + // Represents whether Amazon ECR scans are automatically enabled for new members + // of your Amazon Inspector organization. // // This member is required. Ecr *bool - // Represents whether AWS Lambda scans are automatically enabled for new members of - // your Amazon Inspector organization. + // Represents whether AWS Lambda scans are automatically enabled for new members + // of your Amazon Inspector organization. Lambda *bool noSmithyDocumentSerde @@ -553,20 +553,18 @@ type AwsLambdaFunctionDetails struct { // The instruction set architecture that the AWS Lambda function supports. // Architecture is a string array with one of the valid values. The default - // architecture value is x86_64. + // architecture value is x86_64 . Architectures []Architecture - // The date and time that a user last updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html) + // The date and time that a user last updated the configuration, in ISO 8601 format (https://www.iso.org/iso-8601-date-and-time-format.html) LastModifiedAt *time.Time - // The AWS Lambda function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). A - // Lambda function can have up to five layers. + // The AWS Lambda function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . A Lambda function can have up to five layers. Layers []string - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType PackageType // The AWS Lambda function's networking configuration. @@ -587,7 +585,7 @@ type Counts struct { noSmithyDocumentSerde } -// A structure that identifies filter criteria for GetCoverageStatistics. +// A structure that identifies filter criteria for GetCoverageStatistics . type CoverageFilterCriteria struct { // An array of Amazon Web Services account IDs to return coverage statistics for. @@ -615,7 +613,7 @@ type CoverageFilterCriteria struct { ResourceId []CoverageStringFilter // An array of Amazon Web Services resource types to return coverage statistics - // for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY. + // for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY . ResourceType []CoverageStringFilter // The scan status code to filter on. @@ -843,7 +841,7 @@ type Ec2InstanceAggregation struct { // The operating system types to aggregate findings for. Valid values must be // uppercase and underscore separated, examples are ORACLE_LINUX_7 and - // ALPINE_LINUX_3_8. + // ALPINE_LINUX_3_8 . OperatingSystems []StringFilter // The value to sort results by. @@ -1109,7 +1107,7 @@ type FilterCriteria struct { FirstObservedAt []DateFilter // Details on whether a fix is available through a version update. This value can - // be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the + // be YES , NO , or PARTIAL . A PARTIAL fix means that some, but not all, of the // packages identified in the finding have fixes available through updated // versions. FixAvailable []StringFilter @@ -1121,13 +1119,11 @@ type FilterCriteria struct { LambdaFunctionExecutionRoleArn []StringFilter // Filters the list of AWS Lambda functions by the date and time that a user last - // updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html) + // updated the configuration, in ISO 8601 format (https://www.iso.org/iso-8601-date-and-time-format.html) LambdaFunctionLastModifiedAt []DateFilter - // Filters the list of AWS Lambda functions by the function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). A - // Lambda function can have up to five layers. + // Filters the list of AWS Lambda functions by the function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . A Lambda function can have up to five layers. LambdaFunctionLayers []StringFilter // Filters the list of AWS Lambda functions by the name of the function. @@ -1244,7 +1240,7 @@ type Finding struct { ExploitabilityDetails *ExploitabilityDetails // Details on whether a fix is available through a version update. This value can - // be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the + // be YES , NO , or PARTIAL . A PARTIAL fix means that some, but not all, of the // packages identified in the finding have fixes available through updated // versions. FixAvailable FixAvailable @@ -1316,8 +1312,8 @@ type FreeTrialAccountInfo struct { noSmithyDocumentSerde } -// An object that contains information about the Amazon Inspector free trial for an -// account. +// An object that contains information about the Amazon Inspector free trial for +// an account. type FreeTrialInfo struct { // The date and time that the Amazon Inspector free trail ends for a given account. @@ -1500,8 +1496,8 @@ type LambdaFunctionMetadata struct { noSmithyDocumentSerde } -// The details that define a findings aggregation based on an AWS Lambda function's -// layers. +// The details that define a findings aggregation based on an AWS Lambda +// function's layers. type LambdaLayerAggregation struct { // The names of the AWS Lambda functions associated with the layers. @@ -1552,14 +1548,14 @@ type LambdaLayerAggregationResponse struct { noSmithyDocumentSerde } -// The VPC security groups and subnets that are attached to an AWS Lambda function. -// For more information, see VPC Settings -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). +// The VPC security groups and subnets that are attached to an AWS Lambda +// function. For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) +// . type LambdaVpcConfig struct { - // The VPC security groups and subnets that are attached to an AWS Lambda function. - // For more information, see VPC Settings - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + // The VPC security groups and subnets that are attached to an AWS Lambda + // function. For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) + // . SecurityGroupIds []string // A list of VPC subnet IDs. @@ -1890,8 +1886,8 @@ type ResourceDetails struct { // finding. AwsEc2Instance *AwsEc2InstanceDetails - // An object that contains details about the Amazon ECR container image involved in - // the finding. + // An object that contains details about the Amazon ECR container image involved + // in the finding. AwsEcrContainerImage *AwsEcrContainerImageDetails // A summary of the information about an AWS Lambda function affected by a finding. @@ -1910,8 +1906,8 @@ type ResourceScanMetadata struct { // image. EcrImage *EcrContainerImageMetadata - // An object that contains details about the repository an Amazon ECR image resides - // in. + // An object that contains details about the repository an Amazon ECR image + // resides in. EcrRepository *EcrRepositoryMetadata // An object that contains metadata details for an AWS Lambda function. diff --git a/service/internetmonitor/api_client.go b/service/internetmonitor/api_client.go index 36a428cf170..7d1fa0447ce 100644 --- a/service/internetmonitor/api_client.go +++ b/service/internetmonitor/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/internetmonitor/api_op_CreateMonitor.go b/service/internetmonitor/api_op_CreateMonitor.go index 47401353b8d..983836c0cc6 100644 --- a/service/internetmonitor/api_op_CreateMonitor.go +++ b/service/internetmonitor/api_op_CreateMonitor.go @@ -18,15 +18,13 @@ import ( // directories. Internet Monitor then publishes internet measurements from Amazon // Web Services that are specific to the city-networks, that is, the locations and // ASNs (typically internet service providers or ISPs), where clients access your -// application. For more information, see Using Amazon CloudWatch Internet Monitor -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) +// application. For more information, see Using Amazon CloudWatch Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) // in the Amazon CloudWatch User Guide. When you create a monitor, you set a // maximum limit for the number of city-networks where client traffic is monitored. // The city-network maximum that you choose is the limit, but you only pay for the // number of city-networks that are actually monitored. You can change the maximum // at any time by updating your monitor. For more information, see Choosing a -// city-network maximum value -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) +// city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) // in the Amazon CloudWatch User Guide. func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error) { if params == nil { @@ -49,8 +47,7 @@ type CreateMonitorInput struct { // city-network is the location (city) where clients access your application // resources from and the network or ASN, such as an internet service provider // (ISP), that clients access the resources through. This limit helps control - // billing costs. To learn more, see Choosing a city-network maximum value - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) + // billing costs. To learn more, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. // // This member is required. @@ -61,9 +58,9 @@ type CreateMonitorInput struct { // This member is required. MonitorName *string - // A unique, case-sensitive string of up to 64 ASCII characters that you specify to - // make an idempotent API request. Don't reuse the same client token for other API - // requests. + // A unique, case-sensitive string of up to 64 ASCII characters that you specify + // to make an idempotent API request. Don't reuse the same client token for other + // API requests. ClientToken *string // Publish internet measurements for Internet Monitor to another location, such as diff --git a/service/internetmonitor/api_op_GetMonitor.go b/service/internetmonitor/api_op_GetMonitor.go index 8c69ccc68af..453b9a2ec46 100644 --- a/service/internetmonitor/api_op_GetMonitor.go +++ b/service/internetmonitor/api_op_GetMonitor.go @@ -52,8 +52,7 @@ type GetMonitorOutput struct { // city-network is the location (city) where clients access your application // resources from and the network or ASN, such as an internet service provider // (ISP), that clients access the resources through. This limit helps control - // billing costs. To learn more, see Choosing a city-network maximum value - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) + // billing costs. To learn more, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. // // This member is required. diff --git a/service/internetmonitor/api_op_ListMonitors.go b/service/internetmonitor/api_op_ListMonitors.go index db83d80fca3..bada4b5a3bc 100644 --- a/service/internetmonitor/api_op_ListMonitors.go +++ b/service/internetmonitor/api_op_ListMonitors.go @@ -34,10 +34,10 @@ type ListMonitorsInput struct { // The number of monitor objects that you want to return with this call. MaxResults int32 - // The status of a monitor. This includes the status of the data processing for the - // monitor and the status of the monitor itself. For information about the statuses - // for a monitor, see Monitor - // (https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html). + // The status of a monitor. This includes the status of the data processing for + // the monitor and the status of the monitor itself. For information about the + // statuses for a monitor, see Monitor (https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html) + // . MonitorStatus *string // The token for the next set of results. You receive this token from a previous diff --git a/service/internetmonitor/api_op_UpdateMonitor.go b/service/internetmonitor/api_op_UpdateMonitor.go index ef1d169689b..7cbc29c42c8 100644 --- a/service/internetmonitor/api_op_UpdateMonitor.go +++ b/service/internetmonitor/api_op_UpdateMonitor.go @@ -17,8 +17,7 @@ import ( // remove resources, or to change the status of the monitor. Note that you can't // change the name of a monitor. The city-network maximum that you choose is the // limit, but you only pay for the number of city-networks that are actually -// monitored. For more information, see Choosing a city-network maximum value -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) +// monitored. For more information, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) // in the Amazon CloudWatch User Guide. func (c *Client) UpdateMonitor(ctx context.Context, params *UpdateMonitorInput, optFns ...func(*Options)) (*UpdateMonitorOutput, error) { if params == nil { @@ -42,9 +41,9 @@ type UpdateMonitorInput struct { // This member is required. MonitorName *string - // A unique, case-sensitive string of up to 64 ASCII characters that you specify to - // make an idempotent API request. You should not reuse the same client token for - // other API requests. + // A unique, case-sensitive string of up to 64 ASCII characters that you specify + // to make an idempotent API request. You should not reuse the same client token + // for other API requests. ClientToken *string // Publish internet measurements for Internet Monitor to another location, such as @@ -71,8 +70,8 @@ type UpdateMonitorInput struct { ResourcesToRemove []string // The status for a monitor. The accepted values for Status with the UpdateMonitor - // API call are the following: ACTIVE and INACTIVE. The following values are not - // accepted: PENDING, and ERROR. + // API call are the following: ACTIVE and INACTIVE . The following values are not + // accepted: PENDING , and ERROR . Status types.MonitorConfigState noSmithyDocumentSerde diff --git a/service/internetmonitor/doc.go b/service/internetmonitor/doc.go index 937a9cd3f2d..022ff8732a9 100644 --- a/service/internetmonitor/doc.go +++ b/service/internetmonitor/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package internetmonitor provides the API client, operations, and parameter types -// for Amazon CloudWatch Internet Monitor. +// Package internetmonitor provides the API client, operations, and parameter +// types for Amazon CloudWatch Internet Monitor. // // Amazon CloudWatch Internet Monitor provides visibility into how internet issues // impact the performance and availability between your applications hosted on @@ -25,7 +25,6 @@ // to know where your application's internet traffic is. Internet Monitor then // provides internet measurements from Amazon Web Services that are specific to the // locations and networks that communicate with your application. For more -// information, see Using Amazon CloudWatch Internet Monitor -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) +// information, see Using Amazon CloudWatch Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) // in the Amazon CloudWatch User Guide. package internetmonitor diff --git a/service/internetmonitor/types/enums.go b/service/internetmonitor/types/enums.go index c2463600032..705dd46b1c6 100644 --- a/service/internetmonitor/types/enums.go +++ b/service/internetmonitor/types/enums.go @@ -10,8 +10,8 @@ const ( HealthEventImpactTypePerformance HealthEventImpactType = "PERFORMANCE" ) -// Values returns all known values for HealthEventImpactType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HealthEventImpactType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HealthEventImpactType) Values() []HealthEventImpactType { return []HealthEventImpactType{ diff --git a/service/internetmonitor/types/types.go b/service/internetmonitor/types/types.go index 8003283a903..2e379035c42 100644 --- a/service/internetmonitor/types/types.go +++ b/service/internetmonitor/types/types.go @@ -20,8 +20,7 @@ import ( // availability drop. For example, an availability score of 99% for an end user and // service location pair is equivalent to 1% of the traffic experiencing an // availability drop for that pair. For more information, see How Internet Monitor -// calculates performance and availability scores -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) +// calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User // Guide. type AvailabilityMeasurement struct { @@ -34,24 +33,21 @@ type AvailabilityMeasurement struct { // Monitor chapter in the CloudWatch User Guide includes detailed information about // how Internet Monitor calculates health scores, including performance and // availability scores, and when it creates and resolves health events. For more - // information, see How Amazon Web Services calculates performance and availability - // scores - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) + // information, see How Amazon Web Services calculates performance and + // availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. ExperienceScore *float64 // The percentage of impact caused by a health event for client location traffic // globally. For information about how Internet Monitor calculates impact, see - // Inside Internet Monitor - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html) + // Inside Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html) // in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User // Guide. PercentOfClientLocationImpacted *float64 // The percentage of impact caused by a health event for total traffic globally. // For information about how Internet Monitor calculates impact, see Inside - // Internet Monitor - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html) + // Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html) // in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User // Guide. PercentOfTotalTrafficImpacted *float64 @@ -146,8 +142,8 @@ type ImpactedLocation struct { // The name of the city where the health event is located. City *string - // The country code where the health event is located. The ISO 3166-2 codes for the - // country is provided, when available. + // The country code where the health event is located. The ISO 3166-2 codes for + // the country is provided, when available. CountryCode *string // The calculated health at a specific location. @@ -159,11 +155,11 @@ type ImpactedLocation struct { // The longitude where the health event is located. Longitude *float64 - // The metro area where the health event is located. Metro indicates a metropolitan - // region in the United States, such as the region around New York City. In non-US - // countries, this is a second-level subdivision. For example, in the United - // Kingdom, it could be a county, a London borough, a unitary authority, council - // area, and so on. + // The metro area where the health event is located. Metro indicates a + // metropolitan region in the United States, such as the region around New York + // City. In non-US countries, this is a second-level subdivision. For example, in + // the United Kingdom, it could be a county, a London borough, a unitary authority, + // council area, and so on. Metro *string // The service location where the health event is located. @@ -175,8 +171,8 @@ type ImpactedLocation struct { // (Northern Ireland). Subdivision *string - // The subdivision code where the health event is located. The ISO 3166-2 codes for - // country subdivisions is provided, when available. + // The subdivision code where the health event is located. The ISO 3166-2 codes + // for country subdivisions is provided, when available. SubdivisionCode *string noSmithyDocumentSerde @@ -197,8 +193,7 @@ type InternetHealth struct { // that is not seeing an availability drop. For example, an availability score of // 99% for an end user and service location pair is equivalent to 1% of the traffic // experiencing an availability drop for that pair. For more information, see How - // Internet Monitor calculates performance and availability scores - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) + // Internet Monitor calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. Availability *AvailabilityMeasurement @@ -206,8 +201,7 @@ type InternetHealth struct { // that is not seeing a performance drop. For example, a performance score of 99% // for an end user and service location pair is equivalent to 1% of the traffic // experiencing a performance drop for that pair. For more information, see How - // Internet Monitor calculates performance and availability scores - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) + // Internet Monitor calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. Performance *PerformanceMeasurement @@ -222,15 +216,15 @@ type InternetMeasurementsLogDelivery struct { // The configuration information for publishing Internet Monitor internet // measurements to Amazon S3. The configuration includes the bucket name and // (optionally) prefix for the S3 bucket to store the measurements, and the - // delivery status. The delivery status is ENABLED or DISABLED, depending on + // delivery status. The delivery status is ENABLED or DISABLED , depending on // whether you choose to deliver internet measurements to S3 logs. S3Config *S3Config noSmithyDocumentSerde } -// The description of and information about a monitor in Amazon CloudWatch Internet -// Monitor. +// The description of and information about a monitor in Amazon CloudWatch +// Internet Monitor. type Monitor struct { // The Amazon Resource Name (ARN) of the monitor. @@ -307,22 +301,20 @@ type NetworkImpairment struct { // drop. For example, a performance score of 99% for an end user and service // location pair is equivalent to 1% of the traffic experiencing a performance drop // for that pair. For more information, see How Internet Monitor calculates -// performance and availability scores -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) +// performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. type PerformanceMeasurement struct { - // Experience scores, or health scores, are calculated for different geographic and - // network provider combinations (that is, different granularities) and also + // Experience scores, or health scores, are calculated for different geographic + // and network provider combinations (that is, different granularities) and also // totaled into global scores. If you view performance or availability scores // without filtering for any specific geography or service provider, Amazon // CloudWatch Internet Monitor provides global health scores. The Amazon CloudWatch // Internet Monitor chapter in the CloudWatch User Guide includes detailed // information about how Internet Monitor calculates health scores, including // performance and availability scores, and when it creates and resolves health - // events. For more information, see How Amazon Web Services calculates performance - // and availability scores - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) + // events. For more information, see How Amazon Web Services calculates + // performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. ExperienceScore *float64 @@ -330,8 +322,7 @@ type PerformanceMeasurement struct { // For performance, this is the percentage of how much latency increased during the // event compared to typical performance for traffic, from this client location to // an Amazon Web Services location, using a specific client network. For more - // information, see When Amazon Web Services creates and resolves health events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) + // information, see When Amazon Web Services creates and resolves health events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. PercentOfClientLocationImpacted *float64 @@ -339,24 +330,22 @@ type PerformanceMeasurement struct { // globally. For performance, this is the percentage of how much latency increased // during the event compared to typical performance for your application traffic // globally. For more information, see When Amazon Web Services creates and - // resolves health events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) + // resolves health events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. PercentOfTotalTrafficImpacted *float64 // This is the percentage of how much round-trip time increased during the event // compared to typical round-trip time for your application for traffic. For more - // information, see When Amazon Web Services creates and resolves health events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) + // information, see When Amazon Web Services creates and resolves health events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop) // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. RoundTripTime *RoundTripTime noSmithyDocumentSerde } -// Round-trip time (RTT) is how long it takes for a request from the user to return -// a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at -// different percentiles: p50, p90, and p95. +// Round-trip time (RTT) is how long it takes for a request from the user to +// return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT +// at different percentiles: p50, p90, and p95. type RoundTripTime struct { // RTT at the 50th percentile (p50). @@ -374,7 +363,7 @@ type RoundTripTime struct { // The configuration for publishing Amazon CloudWatch Internet Monitor internet // measurements to Amazon S3. The configuration includes the bucket name and // (optionally) prefix for the S3 bucket to store the measurements, and the -// delivery status. The delivery status is ENABLED or DISABLED, depending on +// delivery status. The delivery status is ENABLED or DISABLED , depending on // whether you choose to deliver internet measurements to S3 logs. type S3Config struct { diff --git a/service/iot/api_client.go b/service/iot/api_client.go index 4e03c83d50a..2d2c36af328 100644 --- a/service/iot/api_client.go +++ b/service/iot/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iot/api_op_AcceptCertificateTransfer.go b/service/iot/api_op_AcceptCertificateTransfer.go index e0b2e8d1926..9549853b9a5 100644 --- a/service/iot/api_op_AcceptCertificateTransfer.go +++ b/service/iot/api_op_AcceptCertificateTransfer.go @@ -13,8 +13,7 @@ import ( // Accepts a pending certificate transfer. The default state of the certificate is // INACTIVE. To check for pending certificate transfers, call ListCertificates to // enumerate your certificates. Requires permission to access the -// AcceptCertificateTransfer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// AcceptCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AcceptCertificateTransfer(ctx context.Context, params *AcceptCertificateTransferInput, optFns ...func(*Options)) (*AcceptCertificateTransferOutput, error) { if params == nil { diff --git a/service/iot/api_op_AddThingToBillingGroup.go b/service/iot/api_op_AddThingToBillingGroup.go index 3ebd45b26d5..b2e67e40ff5 100644 --- a/service/iot/api_op_AddThingToBillingGroup.go +++ b/service/iot/api_op_AddThingToBillingGroup.go @@ -11,8 +11,7 @@ import ( ) // Adds a thing to a billing group. Requires permission to access the -// AddThingToBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// AddThingToBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AddThingToBillingGroup(ctx context.Context, params *AddThingToBillingGroupInput, optFns ...func(*Options)) (*AddThingToBillingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_AddThingToThingGroup.go b/service/iot/api_op_AddThingToThingGroup.go index da1d9fe5d43..c2983b2d3d9 100644 --- a/service/iot/api_op_AddThingToThingGroup.go +++ b/service/iot/api_op_AddThingToThingGroup.go @@ -11,8 +11,7 @@ import ( ) // Adds a thing to a thing group. Requires permission to access the -// AddThingToThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// AddThingToThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AddThingToThingGroup(ctx context.Context, params *AddThingToThingGroupInput, optFns ...func(*Options)) (*AddThingToThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_AssociateTargetsWithJob.go b/service/iot/api_op_AssociateTargetsWithJob.go index 338c2fb5fbf..da229c8a398 100644 --- a/service/iot/api_op_AssociateTargetsWithJob.go +++ b/service/iot/api_op_AssociateTargetsWithJob.go @@ -11,19 +11,12 @@ import ( ) // Associates a group with a continuous job. The following criteria must be met: +// - The job must have been created with the targetSelection field set to +// "CONTINUOUS". +// - The job status must currently be "IN_PROGRESS". +// - The total number of targets associated with a job must not exceed 100. // -// * -// The job must have been created with the targetSelection field set to -// "CONTINUOUS". -// -// * The job status must currently be "IN_PROGRESS". -// -// * The total -// number of targets associated with a job must not exceed 100. -// -// Requires -// permission to access the AssociateTargetsWithJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the AssociateTargetsWithJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AssociateTargetsWithJob(ctx context.Context, params *AssociateTargetsWithJobInput, optFns ...func(*Options)) (*AssociateTargetsWithJobOutput, error) { if params == nil { diff --git a/service/iot/api_op_AttachPolicy.go b/service/iot/api_op_AttachPolicy.go index a5816e47e1c..2255f9e3947 100644 --- a/service/iot/api_op_AttachPolicy.go +++ b/service/iot/api_op_AttachPolicy.go @@ -11,8 +11,7 @@ import ( ) // Attaches the specified policy to the specified principal (certificate or other -// credential). Requires permission to access the AttachPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// credential). Requires permission to access the AttachPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error) { if params == nil { @@ -36,9 +35,8 @@ type AttachPolicyInput struct { // This member is required. PolicyName *string - // The identity - // (https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html) to - // which the policy is attached. For example, a thing group or a certificate. + // The identity (https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html) + // to which the policy is attached. For example, a thing group or a certificate. // // This member is required. Target *string diff --git a/service/iot/api_op_AttachPrincipalPolicy.go b/service/iot/api_op_AttachPrincipalPolicy.go index 5c778febce8..a206465719f 100644 --- a/service/iot/api_op_AttachPrincipalPolicy.go +++ b/service/iot/api_op_AttachPrincipalPolicy.go @@ -12,9 +12,8 @@ import ( // Attaches the specified policy to the specified principal (certificate or other // credential). Note: This action is deprecated and works as expected for backward -// compatibility, but we won't add enhancements. Use AttachPolicy instead. Requires -// permission to access the AttachPrincipalPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// compatibility, but we won't add enhancements. Use AttachPolicy instead. +// Requires permission to access the AttachPrincipalPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. // // Deprecated: This operation has been deprecated. diff --git a/service/iot/api_op_AttachSecurityProfile.go b/service/iot/api_op_AttachSecurityProfile.go index 740de6a65ad..d6505fde718 100644 --- a/service/iot/api_op_AttachSecurityProfile.go +++ b/service/iot/api_op_AttachSecurityProfile.go @@ -12,8 +12,7 @@ import ( // Associates a Device Defender security profile with a thing group or this // account. Each thing group or account can have up to five security profiles -// associated with it. Requires permission to access the AttachSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// associated with it. Requires permission to access the AttachSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AttachSecurityProfile(ctx context.Context, params *AttachSecurityProfileInput, optFns ...func(*Options)) (*AttachSecurityProfileOutput, error) { if params == nil { diff --git a/service/iot/api_op_AttachThingPrincipal.go b/service/iot/api_op_AttachThingPrincipal.go index 70a20437fb2..0ec8231446f 100644 --- a/service/iot/api_op_AttachThingPrincipal.go +++ b/service/iot/api_op_AttachThingPrincipal.go @@ -12,8 +12,7 @@ import ( // Attaches the specified principal to the specified thing. A principal can be // X.509 certificates, Amazon Cognito identities or federated identities. Requires -// permission to access the AttachThingPrincipal -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the AttachThingPrincipal (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) AttachThingPrincipal(ctx context.Context, params *AttachThingPrincipalInput, optFns ...func(*Options)) (*AttachThingPrincipalOutput, error) { if params == nil { diff --git a/service/iot/api_op_CancelAuditMitigationActionsTask.go b/service/iot/api_op_CancelAuditMitigationActionsTask.go index 3fb22581298..97d85cece49 100644 --- a/service/iot/api_op_CancelAuditMitigationActionsTask.go +++ b/service/iot/api_op_CancelAuditMitigationActionsTask.go @@ -12,8 +12,7 @@ import ( // Cancels a mitigation action task that is in progress. If the task is not in // progress, an InvalidRequestException occurs. Requires permission to access the -// CancelAuditMitigationActionsTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CancelAuditMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelAuditMitigationActionsTask(ctx context.Context, params *CancelAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelAuditMitigationActionsTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_CancelAuditTask.go b/service/iot/api_op_CancelAuditTask.go index 9ffbd178023..b206ca66cff 100644 --- a/service/iot/api_op_CancelAuditTask.go +++ b/service/iot/api_op_CancelAuditTask.go @@ -12,8 +12,7 @@ import ( // Cancels an audit that is in progress. The audit can be either scheduled or on // demand. If the audit isn't in progress, an "InvalidRequestException" occurs. -// Requires permission to access the CancelAuditTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the CancelAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelAuditTask(ctx context.Context, params *CancelAuditTaskInput, optFns ...func(*Options)) (*CancelAuditTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_CancelCertificateTransfer.go b/service/iot/api_op_CancelCertificateTransfer.go index 57f3f5f18dd..f0fa6268e2f 100644 --- a/service/iot/api_op_CancelCertificateTransfer.go +++ b/service/iot/api_op_CancelCertificateTransfer.go @@ -10,15 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a pending transfer for the specified certificate. Note Only the transfer -// source account can use this operation to cancel a transfer. (Transfer +// Cancels a pending transfer for the specified certificate. Note Only the +// transfer source account can use this operation to cancel a transfer. (Transfer // destinations can use RejectCertificateTransfer instead.) After transfer, IoT // returns the certificate to the source account in the INACTIVE state. After the // destination account has accepted the transfer, the transfer cannot be cancelled. // After a certificate transfer is cancelled, the status of the certificate changes // from PENDING_TRANSFER to INACTIVE. Requires permission to access the -// CancelCertificateTransfer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CancelCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelCertificateTransfer(ctx context.Context, params *CancelCertificateTransferInput, optFns ...func(*Options)) (*CancelCertificateTransferOutput, error) { if params == nil { diff --git a/service/iot/api_op_CancelDetectMitigationActionsTask.go b/service/iot/api_op_CancelDetectMitigationActionsTask.go index ac7805aa25a..086ea3221ce 100644 --- a/service/iot/api_op_CancelDetectMitigationActionsTask.go +++ b/service/iot/api_op_CancelDetectMitigationActionsTask.go @@ -11,8 +11,7 @@ import ( ) // Cancels a Device Defender ML Detect mitigation action. Requires permission to -// access the CancelDetectMitigationActionsTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the CancelDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelDetectMitigationActionsTask(ctx context.Context, params *CancelDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelDetectMitigationActionsTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_CancelJob.go b/service/iot/api_op_CancelJob.go index b6d7df48a71..f3cb7e7f6eb 100644 --- a/service/iot/api_op_CancelJob.go +++ b/service/iot/api_op_CancelJob.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a job. Requires permission to access the CancelJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Cancels a job. Requires permission to access the CancelJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type CancelJobInput struct { // (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are // canceled, otherwise only job executions with status "QUEUED" are canceled. The - // default is false. Canceling a job which is "IN_PROGRESS", will cause a device + // default is false . Canceling a job which is "IN_PROGRESS", will cause a device // which is executing the job to be unable to update the job execution status. Use // caution and ensure that each device executing a job which is canceled is able to // recover to a valid state. diff --git a/service/iot/api_op_CancelJobExecution.go b/service/iot/api_op_CancelJobExecution.go index f5f5004f4e3..f724f131b49 100644 --- a/service/iot/api_op_CancelJobExecution.go +++ b/service/iot/api_op_CancelJobExecution.go @@ -11,8 +11,7 @@ import ( ) // Cancels the execution of a job for a given thing. Requires permission to access -// the CancelJobExecution -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the CancelJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CancelJobExecution(ctx context.Context, params *CancelJobExecutionInput, optFns ...func(*Options)) (*CancelJobExecutionOutput, error) { if params == nil { @@ -53,8 +52,8 @@ type CancelJobExecutionInput struct { // (Optional) If true the job execution will be canceled if it has status // IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it // has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, - // and you do not set force to true, then an InvalidStateTransitionException will - // be thrown. The default is false. Canceling a job execution which is + // and you do not set force to true , then an InvalidStateTransitionException will + // be thrown. The default is false . Canceling a job execution which is // "IN_PROGRESS", will cause the device to be unable to update the job execution // status. Use caution and ensure that the device is able to recover to a valid // state. diff --git a/service/iot/api_op_ClearDefaultAuthorizer.go b/service/iot/api_op_ClearDefaultAuthorizer.go index 6ae6a567882..22221425c11 100644 --- a/service/iot/api_op_ClearDefaultAuthorizer.go +++ b/service/iot/api_op_ClearDefaultAuthorizer.go @@ -11,8 +11,7 @@ import ( ) // Clears the default authorizer. Requires permission to access the -// ClearDefaultAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ClearDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ClearDefaultAuthorizer(ctx context.Context, params *ClearDefaultAuthorizerInput, optFns ...func(*Options)) (*ClearDefaultAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_ConfirmTopicRuleDestination.go b/service/iot/api_op_ConfirmTopicRuleDestination.go index c6d7324d1ec..d927c23c67a 100644 --- a/service/iot/api_op_ConfirmTopicRuleDestination.go +++ b/service/iot/api_op_ConfirmTopicRuleDestination.go @@ -14,8 +14,7 @@ import ( // destination, IoT sends a confirmation message to the endpoint or base address // you specify. The message includes a token which you pass back when calling // ConfirmTopicRuleDestination to confirm that you own or have access to the -// endpoint. Requires permission to access the ConfirmTopicRuleDestination -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// endpoint. Requires permission to access the ConfirmTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ConfirmTopicRuleDestination(ctx context.Context, params *ConfirmTopicRuleDestinationInput, optFns ...func(*Options)) (*ConfirmTopicRuleDestinationOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateAuditSuppression.go b/service/iot/api_op_CreateAuditSuppression.go index 348ef3c3753..e4f6990926a 100644 --- a/service/iot/api_op_CreateAuditSuppression.go +++ b/service/iot/api_op_CreateAuditSuppression.go @@ -14,8 +14,7 @@ import ( ) // Creates a Device Defender audit suppression. Requires permission to access the -// CreateAuditSuppression -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateAuditSuppression (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateAuditSuppression(ctx context.Context, params *CreateAuditSuppressionInput, optFns ...func(*Options)) (*CreateAuditSuppressionOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateAuthorizer.go b/service/iot/api_op_CreateAuthorizer.go index d6832d0fb11..3b6a8e2f3c6 100644 --- a/service/iot/api_op_CreateAuthorizer.go +++ b/service/iot/api_op_CreateAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an authorizer. Requires permission to access the CreateAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates an authorizer. Requires permission to access the CreateAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error) { if params == nil { @@ -41,11 +40,11 @@ type CreateAuthorizerInput struct { // This member is required. AuthorizerName *string - // When true, the result from the authorizer’s Lambda function is cached for + // When true , the result from the authorizer’s Lambda function is cached for // clients that use persistent HTTP connections. The results are cached for the - // time specified by the Lambda function in refreshAfterInSeconds. This value does + // time specified by the Lambda function in refreshAfterInSeconds . This value does // not affect authorization of clients that use MQTT connections. The default value - // is false. + // is false . EnableCachingForHttp *bool // Specifies whether IoT validates the token signature in an authorization request. diff --git a/service/iot/api_op_CreateBillingGroup.go b/service/iot/api_op_CreateBillingGroup.go index 0b0fcd6829d..8f934fe3d58 100644 --- a/service/iot/api_op_CreateBillingGroup.go +++ b/service/iot/api_op_CreateBillingGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a billing group. Requires permission to access the CreateBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a billing group. Requires permission to access the CreateBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGroupInput, optFns ...func(*Options)) (*CreateBillingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateCertificateFromCsr.go b/service/iot/api_op_CreateCertificateFromCsr.go index 652c665b163..9d77f1e1af0 100644 --- a/service/iot/api_op_CreateCertificateFromCsr.go +++ b/service/iot/api_op_CreateCertificateFromCsr.go @@ -11,35 +11,33 @@ import ( ) // Creates an X.509 certificate using the specified certificate signing request. -// Requires permission to access the CreateCertificateFromCsr -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the CreateCertificateFromCsr (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. The CSR must include a public key that is either an RSA key with a // length of at least 2048 bits or an ECC key from NIST P-25 or NIST P-384 curves. -// For supported certificates, consult Certificate signing algorithms supported by -// IoT -// (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms). -// Reusing the same certificate signing request (CSR) results in a distinct +// For supported certificates, consult Certificate signing algorithms supported by +// IoT (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms) +// . Reusing the same certificate signing request (CSR) results in a distinct // certificate. You can create multiple certificates in a batch by creating a // directory, copying multiple .csr files into that directory, and then specifying // that directory on the command line. The following commands show how to create a // batch of certificates given a batch of CSRs. In the following commands, we // assume that a set of CSRs are located inside of the directory my-csr-directory: -// On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot -// create-certificate-from-csr --certificate-signing-request +// On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws +// iot create-certificate-from-csr --certificate-signing-request // file://my-csr-directory/{} This command lists all of the CSRs in // my-csr-directory and pipes each CSR file name to the aws iot // create-certificate-from-csr Amazon Web Services CLI command to create a // certificate for the corresponding CSR. You can also run the aws iot // create-certificate-from-csr part of the command in parallel to speed up the -// certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot -// create-certificate-from-csr --certificate-signing-request -// file://my-csr-directory/{} On Windows PowerShell, the command to create +// certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws +// iot create-certificate-from-csr --certificate-signing-request +// file://my-csr-directory/{} On Windows PowerShell, the command to create // certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | // %{aws iot create-certificate-from-csr --certificate-signing-request -// file://my-csr-directory/$_} On a Windows command prompt, the command to create -// certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory -// /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request -// file://@path" +// file://my-csr-directory/$_} On a Windows command prompt, the command to create +// certificates for all CSRs in my-csr-directory is: > forfiles /p +// my-csr-directory /c "cmd /c aws iot create-certificate-from-csr +// --certificate-signing-request file://@path" func (c *Client) CreateCertificateFromCsr(ctx context.Context, params *CreateCertificateFromCsrInput, optFns ...func(*Options)) (*CreateCertificateFromCsrOutput, error) { if params == nil { params = &CreateCertificateFromCsrInput{} diff --git a/service/iot/api_op_CreateCustomMetric.go b/service/iot/api_op_CreateCustomMetric.go index f09a0d03dde..978084c9a28 100644 --- a/service/iot/api_op_CreateCustomMetric.go +++ b/service/iot/api_op_CreateCustomMetric.go @@ -13,8 +13,7 @@ import ( ) // Use this API to define a Custom Metric published by your devices to Device -// Defender. Requires permission to access the CreateCustomMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Defender. Requires permission to access the CreateCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateCustomMetric(ctx context.Context, params *CreateCustomMetricInput, optFns ...func(*Options)) (*CreateCustomMetricOutput, error) { if params == nil { @@ -33,17 +32,17 @@ func (c *Client) CreateCustomMetric(ctx context.Context, params *CreateCustomMet type CreateCustomMetricInput struct { - // Each custom metric must have a unique client request token. If you try to create - // a new custom metric that already exists with a different token, an exception - // occurs. If you omit this value, Amazon Web Services SDKs will automatically - // generate a unique client request. + // Each custom metric must have a unique client request token. If you try to + // create a new custom metric that already exists with a different token, an + // exception occurs. If you omit this value, Amazon Web Services SDKs will + // automatically generate a unique client request. // // This member is required. ClientRequestToken *string // The name of the custom metric. This will be used in the metric report submitted - // from the device/thing. The name can't begin with aws:. You can't change the name - // after you define it. + // from the device/thing. The name can't begin with aws: . You can't change the + // name after you define it. // // This member is required. MetricName *string diff --git a/service/iot/api_op_CreateDimension.go b/service/iot/api_op_CreateDimension.go index bf5d5604cda..b58944816e2 100644 --- a/service/iot/api_op_CreateDimension.go +++ b/service/iot/api_op_CreateDimension.go @@ -16,8 +16,7 @@ import ( // security profile for IoT Device Defender. For example, using a TOPIC_FILTER // dimension, you can narrow down the scope of the metric only to MQTT topics whose // name match the pattern specified in the dimension. Requires permission to access -// the CreateDimension -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the CreateDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateDimension(ctx context.Context, params *CreateDimensionInput, optFns ...func(*Options)) (*CreateDimensionOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateDomainConfiguration.go b/service/iot/api_op_CreateDomainConfiguration.go index cbe67acf529..00775462037 100644 --- a/service/iot/api_op_CreateDomainConfiguration.go +++ b/service/iot/api_op_CreateDomainConfiguration.go @@ -12,8 +12,7 @@ import ( ) // Creates a domain configuration. Requires permission to access the -// CreateDomainConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateDomainConfiguration(ctx context.Context, params *CreateDomainConfigurationInput, optFns ...func(*Options)) (*CreateDomainConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateDynamicThingGroup.go b/service/iot/api_op_CreateDynamicThingGroup.go index bc2cb870a01..143f0140813 100644 --- a/service/iot/api_op_CreateDynamicThingGroup.go +++ b/service/iot/api_op_CreateDynamicThingGroup.go @@ -12,8 +12,7 @@ import ( ) // Creates a dynamic thing group. Requires permission to access the -// CreateDynamicThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateDynamicThingGroup(ctx context.Context, params *CreateDynamicThingGroupInput, optFns ...func(*Options)) (*CreateDynamicThingGroupOutput, error) { if params == nil { @@ -32,9 +31,8 @@ func (c *Client) CreateDynamicThingGroup(ctx context.Context, params *CreateDyna type CreateDynamicThingGroupInput struct { - // The dynamic thing group search query string. See Query Syntax - // (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html) for - // information about query string syntax. + // The dynamic thing group search query string. See Query Syntax (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html) + // for information about query string syntax. // // This member is required. QueryString *string @@ -44,12 +42,13 @@ type CreateDynamicThingGroupInput struct { // This member is required. ThingGroupName *string - // The dynamic thing group index name. Currently one index is supported: - // AWS_Things. + // The dynamic thing group index name. Currently one index is supported: AWS_Things + // . IndexName *string - // The dynamic thing group query version. Currently one query version is supported: - // "2017-09-30". If not specified, the query version defaults to this value. + // The dynamic thing group query version. Currently one query version is + // supported: "2017-09-30". If not specified, the query version defaults to this + // value. QueryVersion *string // Metadata which can be used to manage the dynamic thing group. diff --git a/service/iot/api_op_CreateFleetMetric.go b/service/iot/api_op_CreateFleetMetric.go index 8588055d9dd..b4a9ae7e8db 100644 --- a/service/iot/api_op_CreateFleetMetric.go +++ b/service/iot/api_op_CreateFleetMetric.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a fleet metric. Requires permission to access the CreateFleetMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a fleet metric. Requires permission to access the CreateFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateFleetMetric(ctx context.Context, params *CreateFleetMetricInput, optFns ...func(*Options)) (*CreateFleetMetricOutput, error) { if params == nil { @@ -70,9 +69,8 @@ type CreateFleetMetricInput struct { Tags []types.Tag // Used to support unit transformation such as milliseconds to seconds. The unit - // must be supported by CW metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html). - // Default to null. + // must be supported by CW metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // . Default to null. Unit types.FleetMetricUnit noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateJob.go b/service/iot/api_op_CreateJob.go index a88fcd618a1..febf7f7c661 100644 --- a/service/iot/api_op_CreateJob.go +++ b/service/iot/api_op_CreateJob.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a job. Requires permission to access the CreateJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a job. Requires permission to access the CreateJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { @@ -49,7 +48,7 @@ type CreateJobInput struct { // A short text description of the job. Description *string - // The job document. Required if you don't specify a value for documentSource. + // The job document. Required if you don't specify a value for documentSource . Document *string // Parameters of an Amazon Web Services managed template that you can specify to @@ -59,7 +58,7 @@ type CreateJobInput struct { DocumentParameters map[string]string // An S3 link to the job document. Required if you don't specify a value for - // document. If the job document resides in an S3 bucket, you must use a + // document . If the job document resides in an S3 bucket, you must use a // placeholder link when specifying the document. The placeholder link is of the // following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} // where bucket is your bucket name and key is the object in the bucket to which @@ -92,20 +91,21 @@ type CreateJobInput struct { // Metadata which can be used to manage the job. Tags []types.Tag - // Specifies whether the job will continue to run (CONTINUOUS), or will be complete - // after all those things specified as targets have completed the job (SNAPSHOT). - // If continuous, the job may also be run on a thing when a change is detected in a - // target. For example, a job will run on a thing when the thing is added to a - // target group, even after the job was completed by all things originally in the - // group. We recommend that you use continuous jobs instead of snapshot jobs for - // dynamic thing group targets. By using continuous jobs, devices that join the - // group receive the job execution even after the job has been created. + // Specifies whether the job will continue to run (CONTINUOUS), or will be + // complete after all those things specified as targets have completed the job + // (SNAPSHOT). If continuous, the job may also be run on a thing when a change is + // detected in a target. For example, a job will run on a thing when the thing is + // added to a target group, even after the job was completed by all things + // originally in the group. We recommend that you use continuous jobs instead of + // snapshot jobs for dynamic thing group targets. By using continuous jobs, devices + // that join the group receive the job execution even after the job has been + // created. TargetSelection types.TargetSelection - // Specifies the amount of time each device has to finish its execution of the job. - // The timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the time - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. The timer is started when the job execution status is set to IN_PROGRESS . + // If the job execution status is not set to another terminal state before the time + // expires, it will be automatically set to TIMED_OUT . TimeoutConfig *types.TimeoutConfig noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateJobTemplate.go b/service/iot/api_op_CreateJobTemplate.go index 296fce56dc7..cee4aeeb764 100644 --- a/service/iot/api_op_CreateJobTemplate.go +++ b/service/iot/api_op_CreateJobTemplate.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a job template. Requires permission to access the CreateJobTemplate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a job template. Requires permission to access the CreateJobTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateJobTemplate(ctx context.Context, params *CreateJobTemplateInput, optFns ...func(*Options)) (*CreateJobTemplateOutput, error) { if params == nil { @@ -45,11 +44,11 @@ type CreateJobTemplateInput struct { // The criteria that determine when and how a job abort takes place. AbortConfig *types.AbortConfig - // The job document. Required if you don't specify a value for documentSource. + // The job document. Required if you don't specify a value for documentSource . Document *string // An S3 link to the job document to use in the template. Required if you don't - // specify a value for document. If the job document resides in an S3 bucket, you + // specify a value for document . If the job document resides in an S3 bucket, you // must use a placeholder link when specifying the document. The placeholder link // is of the following form: // ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is @@ -75,10 +74,10 @@ type CreateJobTemplateInput struct { // Metadata that can be used to manage the job template. Tags []types.Tag - // Specifies the amount of time each device has to finish its execution of the job. - // A timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the timer - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. A timer is started when the job execution status is set to IN_PROGRESS . If + // the job execution status is not set to another terminal state before the timer + // expires, it will be automatically set to TIMED_OUT . TimeoutConfig *types.TimeoutConfig noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateKeysAndCertificate.go b/service/iot/api_op_CreateKeysAndCertificate.go index 98f06b8bbb4..c3e4a284b67 100644 --- a/service/iot/api_op_CreateKeysAndCertificate.go +++ b/service/iot/api_op_CreateKeysAndCertificate.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued -// public key. You can also call CreateKeysAndCertificate over MQTT from a device, -// for more information, see Provisioning MQTT API -// (https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api). -// Note This is the only time IoT issues the private key for this certificate, so +// Creates a 2048-bit RSA key pair and issues an X.509 certificate using the +// issued public key. You can also call CreateKeysAndCertificate over MQTT from a +// device, for more information, see Provisioning MQTT API (https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api) +// . Note This is the only time IoT issues the private key for this certificate, so // it is important to keep it in a secure location. Requires permission to access -// the CreateKeysAndCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the CreateKeysAndCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateKeysAndCertificate(ctx context.Context, params *CreateKeysAndCertificateInput, optFns ...func(*Options)) (*CreateKeysAndCertificateOutput, error) { if params == nil { @@ -36,8 +34,7 @@ func (c *Client) CreateKeysAndCertificate(ctx context.Context, params *CreateKey } // The input for the CreateKeysAndCertificate operation. Requires permission to -// access the CreateKeysAndCertificateRequest -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the CreateKeysAndCertificateRequest (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. type CreateKeysAndCertificateInput struct { @@ -53,8 +50,8 @@ type CreateKeysAndCertificateOutput struct { // The ARN of the certificate. CertificateArn *string - // The ID of the certificate. IoT issues a default subject name for the certificate - // (for example, IoT Certificate). + // The ID of the certificate. IoT issues a default subject name for the + // certificate (for example, IoT Certificate). CertificateId *string // The certificate data, in PEM format. diff --git a/service/iot/api_op_CreateMitigationAction.go b/service/iot/api_op_CreateMitigationAction.go index f8f05e27662..520dd5d46f4 100644 --- a/service/iot/api_op_CreateMitigationAction.go +++ b/service/iot/api_op_CreateMitigationAction.go @@ -13,11 +13,9 @@ import ( // Defines an action that can be applied to audit findings by using // StartAuditMitigationActionsTask. Only certain types of mitigation actions can be -// applied to specific check names. For more information, see Mitigation actions -// (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html). -// Each mitigation action can apply only one type of change. Requires permission to -// access the CreateMitigationAction -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// applied to specific check names. For more information, see Mitigation actions (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html) +// . Each mitigation action can apply only one type of change. Requires permission +// to access the CreateMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateMitigationAction(ctx context.Context, params *CreateMitigationActionInput, optFns ...func(*Options)) (*CreateMitigationActionOutput, error) { if params == nil { @@ -36,8 +34,8 @@ func (c *Client) CreateMitigationAction(ctx context.Context, params *CreateMitig type CreateMitigationActionInput struct { - // A friendly name for the action. Choose a friendly name that accurately describes - // the action (for example, EnableLoggingAction). + // A friendly name for the action. Choose a friendly name that accurately + // describes the action (for example, EnableLoggingAction ). // // This member is required. ActionName *string diff --git a/service/iot/api_op_CreateOTAUpdate.go b/service/iot/api_op_CreateOTAUpdate.go index 7092c40c415..20754e9cda2 100644 --- a/service/iot/api_op_CreateOTAUpdate.go +++ b/service/iot/api_op_CreateOTAUpdate.go @@ -12,8 +12,7 @@ import ( ) // Creates an IoT OTA update on a target group of things or groups. Requires -// permission to access the CreateOTAUpdate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the CreateOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateOTAUpdate(ctx context.Context, params *CreateOTAUpdateInput, optFns ...func(*Options)) (*CreateOTAUpdateOutput, error) { if params == nil { @@ -66,10 +65,10 @@ type CreateOTAUpdateInput struct { // Configuration information for pre-signed URLs. AwsJobPresignedUrlConfig *types.AwsJobPresignedUrlConfig - // Specifies the amount of time each device has to finish its execution of the job. - // A timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the timer - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. A timer is started when the job execution status is set to IN_PROGRESS . If + // the job execution status is not set to another terminal state before the timer + // expires, it will be automatically set to TIMED_OUT . AwsJobTimeoutConfig *types.AwsJobTimeoutConfig // The description of the OTA update. diff --git a/service/iot/api_op_CreatePolicy.go b/service/iot/api_op_CreatePolicy.go index cb4de81cd2d..aed189c110b 100644 --- a/service/iot/api_op_CreatePolicy.go +++ b/service/iot/api_op_CreatePolicy.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an IoT policy. The created policy is the default version for the policy. -// This operation creates a policy version with a version identifier of 1 and sets -// 1 as the policy's default version. Requires permission to access the -// CreatePolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates an IoT policy. The created policy is the default version for the +// policy. This operation creates a policy version with a version identifier of 1 +// and sets 1 as the policy's default version. Requires permission to access the +// CreatePolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreatePolicyVersion.go b/service/iot/api_op_CreatePolicyVersion.go index 69f22fedeb0..a20b291f295 100644 --- a/service/iot/api_op_CreatePolicyVersion.go +++ b/service/iot/api_op_CreatePolicyVersion.go @@ -16,8 +16,7 @@ import ( // version before you create a new one. Optionally, you can set the new version as // the policy's default version. The default version is the operative version (that // is, the version that is in effect for the certificates to which the policy is -// attached). Requires permission to access the CreatePolicyVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// attached). Requires permission to access the CreatePolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error) { if params == nil { @@ -37,8 +36,8 @@ func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVe // The input for the CreatePolicyVersion operation. type CreatePolicyVersionInput struct { - // The JSON document that describes the policy. Minimum length of 1. Maximum length - // of 2048, excluding whitespace. + // The JSON document that describes the policy. Minimum length of 1. Maximum + // length of 2048, excluding whitespace. // // This member is required. PolicyDocument *string diff --git a/service/iot/api_op_CreateProvisioningClaim.go b/service/iot/api_op_CreateProvisioningClaim.go index e6339f42688..fdb3d293470 100644 --- a/service/iot/api_op_CreateProvisioningClaim.go +++ b/service/iot/api_op_CreateProvisioningClaim.go @@ -13,8 +13,7 @@ import ( ) // Creates a provisioning claim. Requires permission to access the -// CreateProvisioningClaim -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateProvisioningClaim (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateProvisioningClaim(ctx context.Context, params *CreateProvisioningClaimInput, optFns ...func(*Options)) (*CreateProvisioningClaimOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateProvisioningTemplate.go b/service/iot/api_op_CreateProvisioningTemplate.go index 051f75ee2f1..a7cc1e3927b 100644 --- a/service/iot/api_op_CreateProvisioningTemplate.go +++ b/service/iot/api_op_CreateProvisioningTemplate.go @@ -12,8 +12,7 @@ import ( ) // Creates a provisioning template. Requires permission to access the -// CreateProvisioningTemplate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateProvisioningTemplate(ctx context.Context, params *CreateProvisioningTemplateInput, optFns ...func(*Options)) (*CreateProvisioningTemplateOutput, error) { if params == nil { @@ -55,9 +54,9 @@ type CreateProvisioningTemplateInput struct { Enabled bool // Creates a pre-provisioning hook template. Only supports template of type - // FLEET_PROVISIONING. For more information about provisioning template types, see - // type - // (https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type). + // FLEET_PROVISIONING . For more information about provisioning template types, see + // type (https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type) + // . PreProvisioningHook *types.ProvisioningHook // Metadata which can be used to manage the provisioning template. For URI Request @@ -68,9 +67,9 @@ type CreateProvisioningTemplateInput struct { // The type you define in a provisioning template. You can create a template with // only one type. You can't change the template type after its creation. The - // default value is FLEET_PROVISIONING. For more information about provisioning - // template, see: Provisioning template - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html). + // default value is FLEET_PROVISIONING . For more information about provisioning + // template, see: Provisioning template (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) + // . Type types.TemplateType noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateProvisioningTemplateVersion.go b/service/iot/api_op_CreateProvisioningTemplateVersion.go index a24902c66e7..d6674dfd17f 100644 --- a/service/iot/api_op_CreateProvisioningTemplateVersion.go +++ b/service/iot/api_op_CreateProvisioningTemplateVersion.go @@ -11,8 +11,7 @@ import ( ) // Creates a new version of a provisioning template. Requires permission to access -// the CreateProvisioningTemplateVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the CreateProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateProvisioningTemplateVersion(ctx context.Context, params *CreateProvisioningTemplateVersionInput, optFns ...func(*Options)) (*CreateProvisioningTemplateVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateRoleAlias.go b/service/iot/api_op_CreateRoleAlias.go index bd3faececd8..30c57faed37 100644 --- a/service/iot/api_op_CreateRoleAlias.go +++ b/service/iot/api_op_CreateRoleAlias.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a role alias. Requires permission to access the CreateRoleAlias -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a role alias. Requires permission to access the CreateRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateRoleAlias(ctx context.Context, params *CreateRoleAliasInput, optFns ...func(*Options)) (*CreateRoleAliasOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateScheduledAudit.go b/service/iot/api_op_CreateScheduledAudit.go index 1fb12df7131..fc2a7c24891 100644 --- a/service/iot/api_op_CreateScheduledAudit.go +++ b/service/iot/api_op_CreateScheduledAudit.go @@ -12,8 +12,7 @@ import ( ) // Creates a scheduled audit that is run at a specified time interval. Requires -// permission to access the CreateScheduledAudit -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the CreateScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateScheduledAudit(ctx context.Context, params *CreateScheduledAuditInput, optFns ...func(*Options)) (*CreateScheduledAuditOutput, error) { if params == nil { @@ -32,8 +31,8 @@ func (c *Client) CreateScheduledAudit(ctx context.Context, params *CreateSchedul type CreateScheduledAuditInput struct { - // How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or - // MONTHLY. The start time of each audit is determined by the system. + // How often the scheduled audit takes place, either DAILY , WEEKLY , BIWEEKLY or + // MONTHLY . The start time of each audit is determined by the system. // // This member is required. Frequency types.AuditFrequency @@ -53,13 +52,13 @@ type CreateScheduledAuditInput struct { // The day of the month on which the scheduled audit takes place. This can be "1" // through "31" or "LAST". This field is required if the "frequency" parameter is - // set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that + // set to MONTHLY . If days 29 to 31 are specified, and the month doesn't have that // many days, the audit takes place on the LAST day of the month. DayOfMonth *string - // The day of the week on which the scheduled audit takes place, either SUN, MON, - // TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is - // set to WEEKLY or BIWEEKLY. + // The day of the week on which the scheduled audit takes place, either SUN , MON , + // TUE , WED , THU , FRI , or SAT . This field is required if the frequency + // parameter is set to WEEKLY or BIWEEKLY . DayOfWeek types.DayOfWeek // Metadata that can be used to manage the scheduled audit. diff --git a/service/iot/api_op_CreateSecurityProfile.go b/service/iot/api_op_CreateSecurityProfile.go index 2e04a570f0c..7210d327965 100644 --- a/service/iot/api_op_CreateSecurityProfile.go +++ b/service/iot/api_op_CreateSecurityProfile.go @@ -12,8 +12,7 @@ import ( ) // Creates a Device Defender security profile. Requires permission to access the -// CreateSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecurityProfileInput, optFns ...func(*Options)) (*CreateSecurityProfileOutput, error) { if params == nil { @@ -39,7 +38,7 @@ type CreateSecurityProfileInput struct { // Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead. A // list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any + // for any metric used in the profile's behaviors , but it is also retained for any // metric specified here. Can be used with custom metrics; cannot be used with // dimensions. // @@ -47,7 +46,7 @@ type CreateSecurityProfileInput struct { AdditionalMetricsToRetain []string // A list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any + // for any metric used in the profile's behaviors , but it is also retained for any // metric specified here. Can be used with custom metrics; cannot be used with // dimensions. AdditionalMetricsToRetainV2 []types.MetricToRetain diff --git a/service/iot/api_op_CreateStream.go b/service/iot/api_op_CreateStream.go index 59f871898fe..8602fed5195 100644 --- a/service/iot/api_op_CreateStream.go +++ b/service/iot/api_op_CreateStream.go @@ -14,8 +14,7 @@ import ( // Creates a stream for delivering one or more large files in chunks over MQTT. A // stream transports data bytes in chunks or blocks packaged as MQTT messages from // a source like S3. You can have one or more files associated with a stream. -// Requires permission to access the CreateStream -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the CreateStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateThing.go b/service/iot/api_op_CreateThing.go index 50e907c9e30..241c2b67121 100644 --- a/service/iot/api_op_CreateThing.go +++ b/service/iot/api_op_CreateThing.go @@ -15,11 +15,9 @@ import ( // using the same thing name and configuration, the call will succeed. If this call // is made with the same thing name but different configuration a // ResourceAlreadyExistsException is thrown. This is a control plane operation. See -// Authorization -// (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) +// Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) // for information about authorizing control plane actions. Requires permission to -// access the CreateThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the CreateThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateThing(ctx context.Context, params *CreateThingInput, optFns ...func(*Options)) (*CreateThingOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateThingGroup.go b/service/iot/api_op_CreateThingGroup.go index 4a6da9531d1..97c3ed84832 100644 --- a/service/iot/api_op_CreateThingGroup.go +++ b/service/iot/api_op_CreateThingGroup.go @@ -11,11 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a thing group. This is a control plane operation. See Authorization -// (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) +// Create a thing group. This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) // for information about authorizing control plane actions. Requires permission to -// access the CreateThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the CreateThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateThingGroup(ctx context.Context, params *CreateThingGroupInput, optFns ...func(*Options)) (*CreateThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateThingType.go b/service/iot/api_op_CreateThingType.go index fd684135740..d014f99b96d 100644 --- a/service/iot/api_op_CreateThingType.go +++ b/service/iot/api_op_CreateThingType.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new thing type. Requires permission to access the CreateThingType -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a new thing type. Requires permission to access the CreateThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateThingType(ctx context.Context, params *CreateThingTypeInput, optFns ...func(*Options)) (*CreateThingTypeOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateTopicRule.go b/service/iot/api_op_CreateTopicRule.go index 3b530718cae..d1fe164d2b0 100644 --- a/service/iot/api_op_CreateTopicRule.go +++ b/service/iot/api_op_CreateTopicRule.go @@ -13,8 +13,7 @@ import ( // Creates a rule. Creating rules is an administrator-level action. Any user who // has permission to create rules will be able to access data processed by the -// rule. Requires permission to access the CreateTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// rule. Requires permission to access the CreateTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateTopicRule(ctx context.Context, params *CreateTopicRuleInput, optFns ...func(*Options)) (*CreateTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_CreateTopicRuleDestination.go b/service/iot/api_op_CreateTopicRuleDestination.go index 168382a4f0a..164ea71c8ed 100644 --- a/service/iot/api_op_CreateTopicRuleDestination.go +++ b/service/iot/api_op_CreateTopicRuleDestination.go @@ -12,8 +12,7 @@ import ( ) // Creates a topic rule destination. The destination must be confirmed prior to -// use. Requires permission to access the CreateTopicRuleDestination -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// use. Requires permission to access the CreateTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateTopicRuleDestination(ctx context.Context, params *CreateTopicRuleDestinationInput, optFns ...func(*Options)) (*CreateTopicRuleDestinationOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteAccountAuditConfiguration.go b/service/iot/api_op_DeleteAccountAuditConfiguration.go index 5163bfec71c..afa609cc67a 100644 --- a/service/iot/api_op_DeleteAccountAuditConfiguration.go +++ b/service/iot/api_op_DeleteAccountAuditConfiguration.go @@ -12,8 +12,7 @@ import ( // Restores the default settings for Device Defender audits for this account. Any // configuration data you entered is deleted and all audit checks are reset to -// disabled. Requires permission to access the DeleteAccountAuditConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// disabled. Requires permission to access the DeleteAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteAccountAuditConfiguration(ctx context.Context, params *DeleteAccountAuditConfigurationInput, optFns ...func(*Options)) (*DeleteAccountAuditConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteAuditSuppression.go b/service/iot/api_op_DeleteAuditSuppression.go index 31e508f26e4..91a20fc602d 100644 --- a/service/iot/api_op_DeleteAuditSuppression.go +++ b/service/iot/api_op_DeleteAuditSuppression.go @@ -12,8 +12,7 @@ import ( ) // Deletes a Device Defender audit suppression. Requires permission to access the -// DeleteAuditSuppression -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteAuditSuppression (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteAuditSuppression(ctx context.Context, params *DeleteAuditSuppressionInput, optFns ...func(*Options)) (*DeleteAuditSuppressionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteAuthorizer.go b/service/iot/api_op_DeleteAuthorizer.go index caa7b0c00cd..74a634333d7 100644 --- a/service/iot/api_op_DeleteAuthorizer.go +++ b/service/iot/api_op_DeleteAuthorizer.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an authorizer. Requires permission to access the DeleteAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes an authorizer. Requires permission to access the DeleteAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteBillingGroup.go b/service/iot/api_op_DeleteBillingGroup.go index 25cfa2ebc70..f144ecc6dc0 100644 --- a/service/iot/api_op_DeleteBillingGroup.go +++ b/service/iot/api_op_DeleteBillingGroup.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the billing group. Requires permission to access the DeleteBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes the billing group. Requires permission to access the DeleteBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteBillingGroup(ctx context.Context, params *DeleteBillingGroupInput, optFns ...func(*Options)) (*DeleteBillingGroupOutput, error) { if params == nil { @@ -37,7 +36,7 @@ type DeleteBillingGroupInput struct { // The expected version of the billing group. If the version of the billing group // does not match the expected version specified in the request, the - // DeleteBillingGroup request is rejected with a VersionConflictException. + // DeleteBillingGroup request is rejected with a VersionConflictException . ExpectedVersion *int64 noSmithyDocumentSerde diff --git a/service/iot/api_op_DeleteCACertificate.go b/service/iot/api_op_DeleteCACertificate.go index 76a5259ff58..2c20442430d 100644 --- a/service/iot/api_op_DeleteCACertificate.go +++ b/service/iot/api_op_DeleteCACertificate.go @@ -11,8 +11,7 @@ import ( ) // Deletes a registered CA certificate. Requires permission to access the -// DeleteCACertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteCACertificate(ctx context.Context, params *DeleteCACertificateInput, optFns ...func(*Options)) (*DeleteCACertificateOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteCertificate.go b/service/iot/api_op_DeleteCertificate.go index 5f1c384ab67..eec29463124 100644 --- a/service/iot/api_op_DeleteCertificate.go +++ b/service/iot/api_op_DeleteCertificate.go @@ -14,8 +14,7 @@ import ( // policy or IoT thing attached to it or if its status is set to ACTIVE. To delete // a certificate, first use the DetachPolicy action to detach all policies. Next, // use the UpdateCertificate action to set the certificate to the INACTIVE status. -// Requires permission to access the DeleteCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the DeleteCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error) { if params == nil { @@ -41,8 +40,8 @@ type DeleteCertificateInput struct { // This member is required. CertificateId *string - // Forces the deletion of a certificate if it is inactive and is not attached to an - // IoT thing. + // Forces the deletion of a certificate if it is inactive and is not attached to + // an IoT thing. ForceDelete bool noSmithyDocumentSerde diff --git a/service/iot/api_op_DeleteCustomMetric.go b/service/iot/api_op_DeleteCustomMetric.go index a4a1bac1dac..c8b77718046 100644 --- a/service/iot/api_op_DeleteCustomMetric.go +++ b/service/iot/api_op_DeleteCustomMetric.go @@ -11,12 +11,10 @@ import ( ) // Deletes a Device Defender detect custom metric. Requires permission to access -// the DeleteCustomMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the DeleteCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. Before you can delete a custom metric, you must first remove the custom // metric from all security profiles it's a part of. The security profile -// associated with the custom metric can be found using the ListSecurityProfiles -// (https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html) +// associated with the custom metric can be found using the ListSecurityProfiles (https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html) // API with metricName set to your custom metric name. func (c *Client) DeleteCustomMetric(ctx context.Context, params *DeleteCustomMetricInput, optFns ...func(*Options)) (*DeleteCustomMetricOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteDimension.go b/service/iot/api_op_DeleteDimension.go index bcd9a59c9fa..9c8eb9e563c 100644 --- a/service/iot/api_op_DeleteDimension.go +++ b/service/iot/api_op_DeleteDimension.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified dimension from your Amazon Web Services accounts. Requires -// permission to access the DeleteDimension -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Removes the specified dimension from your Amazon Web Services accounts. +// Requires permission to access the DeleteDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteDimension(ctx context.Context, params *DeleteDimensionInput, optFns ...func(*Options)) (*DeleteDimensionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteDomainConfiguration.go b/service/iot/api_op_DeleteDomainConfiguration.go index 818a62d5ead..9266cff8b6b 100644 --- a/service/iot/api_op_DeleteDomainConfiguration.go +++ b/service/iot/api_op_DeleteDomainConfiguration.go @@ -11,8 +11,7 @@ import ( ) // Deletes the specified domain configuration. Requires permission to access the -// DeleteDomainConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteDomainConfiguration(ctx context.Context, params *DeleteDomainConfigurationInput, optFns ...func(*Options)) (*DeleteDomainConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteDynamicThingGroup.go b/service/iot/api_op_DeleteDynamicThingGroup.go index 0a680584613..f090b1777a1 100644 --- a/service/iot/api_op_DeleteDynamicThingGroup.go +++ b/service/iot/api_op_DeleteDynamicThingGroup.go @@ -11,8 +11,7 @@ import ( ) // Deletes a dynamic thing group. Requires permission to access the -// DeleteDynamicThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteDynamicThingGroup(ctx context.Context, params *DeleteDynamicThingGroupInput, optFns ...func(*Options)) (*DeleteDynamicThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteFleetMetric.go b/service/iot/api_op_DeleteFleetMetric.go index 74437a907c1..52a0deca9a6 100644 --- a/service/iot/api_op_DeleteFleetMetric.go +++ b/service/iot/api_op_DeleteFleetMetric.go @@ -12,8 +12,7 @@ import ( // Deletes the specified fleet metric. Returns successfully with no error if the // deletion is successful or you specify a fleet metric that doesn't exist. -// Requires permission to access the DeleteFleetMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the DeleteFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteFleetMetric(ctx context.Context, params *DeleteFleetMetricInput, optFns ...func(*Options)) (*DeleteFleetMetricOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteJob.go b/service/iot/api_op_DeleteJob.go index 1d916c94883..95cd5b8e337 100644 --- a/service/iot/api_op_DeleteJob.go +++ b/service/iot/api_op_DeleteJob.go @@ -16,8 +16,7 @@ import ( // "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is // already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have // status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will -// occur. Requires permission to access the DeleteJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// occur. Requires permission to access the DeleteJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns ...func(*Options)) (*DeleteJobOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteJobExecution.go b/service/iot/api_op_DeleteJobExecution.go index c390403c708..5ed970bb9dc 100644 --- a/service/iot/api_op_DeleteJobExecution.go +++ b/service/iot/api_op_DeleteJobExecution.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a job execution. Requires permission to access the DeleteJobExecution -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes a job execution. Requires permission to access the DeleteJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteJobExecution(ctx context.Context, params *DeleteJobExecutionInput, optFns ...func(*Options)) (*DeleteJobExecutionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteMitigationAction.go b/service/iot/api_op_DeleteMitigationAction.go index 05d13e4c60c..5b28d775d40 100644 --- a/service/iot/api_op_DeleteMitigationAction.go +++ b/service/iot/api_op_DeleteMitigationAction.go @@ -11,8 +11,7 @@ import ( ) // Deletes a defined mitigation action from your Amazon Web Services accounts. -// Requires permission to access the DeleteMitigationAction -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the DeleteMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteMitigationAction(ctx context.Context, params *DeleteMitigationActionInput, optFns ...func(*Options)) (*DeleteMitigationActionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteOTAUpdate.go b/service/iot/api_op_DeleteOTAUpdate.go index 598e0be4086..b5509d475fb 100644 --- a/service/iot/api_op_DeleteOTAUpdate.go +++ b/service/iot/api_op_DeleteOTAUpdate.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an OTA update. Requires permission to access the DeleteOTAUpdate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Delete an OTA update. Requires permission to access the DeleteOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteOTAUpdate(ctx context.Context, params *DeleteOTAUpdateInput, optFns ...func(*Options)) (*DeleteOTAUpdateOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeletePolicy.go b/service/iot/api_op_DeletePolicy.go index cc7fa00f025..d594a4b76b5 100644 --- a/service/iot/api_op_DeletePolicy.go +++ b/service/iot/api_op_DeletePolicy.go @@ -18,8 +18,7 @@ import ( // DeletePolicy, its default version is deleted with it. Because of the distributed // nature of Amazon Web Services, it can take up to five minutes after a policy is // detached before it's ready to be deleted. Requires permission to access the -// DeletePolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeletePolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeletePolicyVersion.go b/service/iot/api_op_DeletePolicyVersion.go index 948cc5dc120..b90dce8db9e 100644 --- a/service/iot/api_op_DeletePolicyVersion.go +++ b/service/iot/api_op_DeletePolicyVersion.go @@ -12,10 +12,9 @@ import ( // Deletes the specified version of the specified policy. You cannot delete the // default version of a policy using this action. To delete the default version of -// a policy, use DeletePolicy. To find out which version of a policy is marked as +// a policy, use DeletePolicy . To find out which version of a policy is marked as // the default version, use ListPolicyVersions. Requires permission to access the -// DeletePolicyVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeletePolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteProvisioningTemplate.go b/service/iot/api_op_DeleteProvisioningTemplate.go index 7ae3d4a5506..a06fca4d67d 100644 --- a/service/iot/api_op_DeleteProvisioningTemplate.go +++ b/service/iot/api_op_DeleteProvisioningTemplate.go @@ -11,8 +11,7 @@ import ( ) // Deletes a provisioning template. Requires permission to access the -// DeleteProvisioningTemplate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteProvisioningTemplate(ctx context.Context, params *DeleteProvisioningTemplateInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteProvisioningTemplateVersion.go b/service/iot/api_op_DeleteProvisioningTemplateVersion.go index 22b71d600b6..3cb4590cbbe 100644 --- a/service/iot/api_op_DeleteProvisioningTemplateVersion.go +++ b/service/iot/api_op_DeleteProvisioningTemplateVersion.go @@ -11,8 +11,7 @@ import ( ) // Deletes a provisioning template version. Requires permission to access the -// DeleteProvisioningTemplateVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteProvisioningTemplateVersion(ctx context.Context, params *DeleteProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteRegistrationCode.go b/service/iot/api_op_DeleteRegistrationCode.go index f19ed92bd70..43a76bc41ad 100644 --- a/service/iot/api_op_DeleteRegistrationCode.go +++ b/service/iot/api_op_DeleteRegistrationCode.go @@ -11,8 +11,7 @@ import ( ) // Deletes a CA certificate registration code. Requires permission to access the -// DeleteRegistrationCode -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteRegistrationCode (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteRegistrationCode(ctx context.Context, params *DeleteRegistrationCodeInput, optFns ...func(*Options)) (*DeleteRegistrationCodeOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteRoleAlias.go b/service/iot/api_op_DeleteRoleAlias.go index 57a6a67c23d..98d844fd307 100644 --- a/service/iot/api_op_DeleteRoleAlias.go +++ b/service/iot/api_op_DeleteRoleAlias.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a role alias Requires permission to access the DeleteRoleAlias -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes a role alias Requires permission to access the DeleteRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteRoleAlias(ctx context.Context, params *DeleteRoleAliasInput, optFns ...func(*Options)) (*DeleteRoleAliasOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteScheduledAudit.go b/service/iot/api_op_DeleteScheduledAudit.go index 029c57ca403..ab95e679209 100644 --- a/service/iot/api_op_DeleteScheduledAudit.go +++ b/service/iot/api_op_DeleteScheduledAudit.go @@ -11,8 +11,7 @@ import ( ) // Deletes a scheduled audit. Requires permission to access the -// DeleteScheduledAudit -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteScheduledAudit(ctx context.Context, params *DeleteScheduledAuditInput, optFns ...func(*Options)) (*DeleteScheduledAuditOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteSecurityProfile.go b/service/iot/api_op_DeleteSecurityProfile.go index 7cb89a11eff..9a7b9d3d418 100644 --- a/service/iot/api_op_DeleteSecurityProfile.go +++ b/service/iot/api_op_DeleteSecurityProfile.go @@ -11,8 +11,7 @@ import ( ) // Deletes a Device Defender security profile. Requires permission to access the -// DeleteSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecurityProfileInput, optFns ...func(*Options)) (*DeleteSecurityProfileOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteStream.go b/service/iot/api_op_DeleteStream.go index 026201f8e0c..2ff5bd056b0 100644 --- a/service/iot/api_op_DeleteStream.go +++ b/service/iot/api_op_DeleteStream.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a stream. Requires permission to access the DeleteStream -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes a stream. Requires permission to access the DeleteStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteThing.go b/service/iot/api_op_DeleteThing.go index 8f78ed31808..2ebcd6c13f7 100644 --- a/service/iot/api_op_DeleteThing.go +++ b/service/iot/api_op_DeleteThing.go @@ -12,8 +12,7 @@ import ( // Deletes the specified thing. Returns successfully with no error if the deletion // is successful or you specify a thing that doesn't exist. Requires permission to -// access the DeleteThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the DeleteThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteThing(ctx context.Context, params *DeleteThingInput, optFns ...func(*Options)) (*DeleteThingOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type DeleteThingInput struct { // The expected version of the thing record in the registry. If the version of the // record in the registry does not match the expected version specified in the - // request, the DeleteThing request is rejected with a VersionConflictException. + // request, the DeleteThing request is rejected with a VersionConflictException . ExpectedVersion *int64 noSmithyDocumentSerde diff --git a/service/iot/api_op_DeleteThingGroup.go b/service/iot/api_op_DeleteThingGroup.go index 58a395bc58d..2a328304a30 100644 --- a/service/iot/api_op_DeleteThingGroup.go +++ b/service/iot/api_op_DeleteThingGroup.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a thing group. Requires permission to access the DeleteThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes a thing group. Requires permission to access the DeleteThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteThingGroup(ctx context.Context, params *DeleteThingGroupInput, optFns ...func(*Options)) (*DeleteThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteThingType.go b/service/iot/api_op_DeleteThingType.go index ddccb5f90da..28c0601368f 100644 --- a/service/iot/api_op_DeleteThingType.go +++ b/service/iot/api_op_DeleteThingType.go @@ -12,11 +12,10 @@ import ( // Deletes the specified thing type. You cannot delete a thing type if it has // things associated with it. To delete a thing type, first mark it as deprecated -// by calling DeprecateThingType, then remove any associated things by calling +// by calling DeprecateThingType , then remove any associated things by calling // UpdateThing to change the thing type on any associated thing, and finally use // DeleteThingType to delete the thing type. Requires permission to access the -// DeleteThingType -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteThingType(ctx context.Context, params *DeleteThingTypeInput, optFns ...func(*Options)) (*DeleteThingTypeOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteTopicRule.go b/service/iot/api_op_DeleteTopicRule.go index 05e0f0a6d0f..f61379c878d 100644 --- a/service/iot/api_op_DeleteTopicRule.go +++ b/service/iot/api_op_DeleteTopicRule.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the rule. Requires permission to access the DeleteTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes the rule. Requires permission to access the DeleteTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteTopicRule(ctx context.Context, params *DeleteTopicRuleInput, optFns ...func(*Options)) (*DeleteTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteTopicRuleDestination.go b/service/iot/api_op_DeleteTopicRuleDestination.go index 7e35ea26a88..ff77a97312b 100644 --- a/service/iot/api_op_DeleteTopicRuleDestination.go +++ b/service/iot/api_op_DeleteTopicRuleDestination.go @@ -11,8 +11,7 @@ import ( ) // Deletes a topic rule destination. Requires permission to access the -// DeleteTopicRuleDestination -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteTopicRuleDestination(ctx context.Context, params *DeleteTopicRuleDestinationInput, optFns ...func(*Options)) (*DeleteTopicRuleDestinationOutput, error) { if params == nil { diff --git a/service/iot/api_op_DeleteV2LoggingLevel.go b/service/iot/api_op_DeleteV2LoggingLevel.go index 002b65f530a..654efb927bf 100644 --- a/service/iot/api_op_DeleteV2LoggingLevel.go +++ b/service/iot/api_op_DeleteV2LoggingLevel.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteV2LoggingLevel(ctx context.Context, params *DeleteV2LoggingLevelInput, optFns ...func(*Options)) (*DeleteV2LoggingLevelOutput, error) { if params == nil { @@ -36,7 +35,7 @@ type DeleteV2LoggingLevelInput struct { // This member is required. TargetName *string - // The type of resource for which you are configuring logging. Must be THING_Group. + // The type of resource for which you are configuring logging. Must be THING_Group . // // This member is required. TargetType types.LogTargetType diff --git a/service/iot/api_op_DeprecateThingType.go b/service/iot/api_op_DeprecateThingType.go index 5216244e98a..50871141983 100644 --- a/service/iot/api_op_DeprecateThingType.go +++ b/service/iot/api_op_DeprecateThingType.go @@ -11,8 +11,7 @@ import ( ) // Deprecates a thing type. You can not associate new things with deprecated thing -// type. Requires permission to access the DeprecateThingType -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// type. Requires permission to access the DeprecateThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeprecateThingType(ctx context.Context, params *DeprecateThingTypeInput, optFns ...func(*Options)) (*DeprecateThingTypeOutput, error) { if params == nil { @@ -37,8 +36,8 @@ type DeprecateThingTypeInput struct { // This member is required. ThingTypeName *string - // Whether to undeprecate a deprecated thing type. If true, the thing type will not - // be deprecated anymore and you can associate it with things. + // Whether to undeprecate a deprecated thing type. If true, the thing type will + // not be deprecated anymore and you can associate it with things. UndoDeprecate bool noSmithyDocumentSerde diff --git a/service/iot/api_op_DescribeAccountAuditConfiguration.go b/service/iot/api_op_DescribeAccountAuditConfiguration.go index 042b5f25b98..6d49f2038aa 100644 --- a/service/iot/api_op_DescribeAccountAuditConfiguration.go +++ b/service/iot/api_op_DescribeAccountAuditConfiguration.go @@ -14,8 +14,7 @@ import ( // Gets information about the Device Defender audit settings for this account. // Settings include how audit notifications are sent and which audit checks are // enabled or disabled. Requires permission to access the -// DescribeAccountAuditConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeAccountAuditConfiguration(ctx context.Context, params *DescribeAccountAuditConfigurationInput, optFns ...func(*Options)) (*DescribeAccountAuditConfigurationOutput, error) { if params == nil { @@ -47,7 +46,7 @@ type DescribeAccountAuditConfigurationOutput struct { // The ARN of the role that grants permission to IoT to access information about // your devices, policies, certificates, and other items as required when - // performing an audit. On the first call to UpdateAccountAuditConfiguration, this + // performing an audit. On the first call to UpdateAccountAuditConfiguration , this // parameter is required. RoleArn *string diff --git a/service/iot/api_op_DescribeAuditFinding.go b/service/iot/api_op_DescribeAuditFinding.go index 8f459b9f30f..39bda518fff 100644 --- a/service/iot/api_op_DescribeAuditFinding.go +++ b/service/iot/api_op_DescribeAuditFinding.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a single audit finding. Properties include the reason for -// noncompliance, the severity of the issue, and the start time when the audit that -// returned the finding. Requires permission to access the DescribeAuditFinding -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets information about a single audit finding. Properties include the reason +// for noncompliance, the severity of the issue, and the start time when the audit +// that returned the finding. Requires permission to access the +// DescribeAuditFinding (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeAuditFinding(ctx context.Context, params *DescribeAuditFindingInput, optFns ...func(*Options)) (*DescribeAuditFindingOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeAuditMitigationActionsTask.go b/service/iot/api_op_DescribeAuditMitigationActionsTask.go index 492acd61fa4..6f4772c1897 100644 --- a/service/iot/api_op_DescribeAuditMitigationActionsTask.go +++ b/service/iot/api_op_DescribeAuditMitigationActionsTask.go @@ -12,10 +12,10 @@ import ( "time" ) -// Gets information about an audit mitigation task that is used to apply mitigation -// actions to a set of audit findings. Properties include the actions being -// applied, the audit checks to which they're being applied, the task status, and -// aggregated task statistics. +// Gets information about an audit mitigation task that is used to apply +// mitigation actions to a set of audit findings. Properties include the actions +// being applied, the audit checks to which they're being applied, the task status, +// and aggregated task statistics. func (c *Client) DescribeAuditMitigationActionsTask(ctx context.Context, params *DescribeAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*DescribeAuditMitigationActionsTaskOutput, error) { if params == nil { params = &DescribeAuditMitigationActionsTaskInput{} @@ -57,8 +57,8 @@ type DescribeAuditMitigationActionsTaskOutput struct { // The date and time when the task was started. StartTime *time.Time - // Identifies the findings to which the mitigation actions are applied. This can be - // by audit checks, by audit task, or a set of findings. + // Identifies the findings to which the mitigation actions are applied. This can + // be by audit checks, by audit task, or a set of findings. Target *types.AuditMitigationActionsTaskTarget // Aggregate counts of the results when the mitigation tasks were applied to the diff --git a/service/iot/api_op_DescribeAuditTask.go b/service/iot/api_op_DescribeAuditTask.go index 6daf855b986..687fc9236a8 100644 --- a/service/iot/api_op_DescribeAuditTask.go +++ b/service/iot/api_op_DescribeAuditTask.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a Device Defender audit. Requires permission to access -// the DescribeAuditTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the DescribeAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeAuditTask(ctx context.Context, params *DescribeAuditTaskInput, optFns ...func(*Options)) (*DescribeAuditTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeAuthorizer.go b/service/iot/api_op_DescribeAuthorizer.go index 7ad1f2fc1b4..96bb98ad9a4 100644 --- a/service/iot/api_op_DescribeAuthorizer.go +++ b/service/iot/api_op_DescribeAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an authorizer. Requires permission to access the DescribeAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Describes an authorizer. Requires permission to access the DescribeAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeAuthorizer(ctx context.Context, params *DescribeAuthorizerInput, optFns ...func(*Options)) (*DescribeAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeBillingGroup.go b/service/iot/api_op_DescribeBillingGroup.go index 9ada129ca78..65020338f71 100644 --- a/service/iot/api_op_DescribeBillingGroup.go +++ b/service/iot/api_op_DescribeBillingGroup.go @@ -12,8 +12,7 @@ import ( ) // Returns information about a billing group. Requires permission to access the -// DescribeBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeBillingGroup(ctx context.Context, params *DescribeBillingGroupInput, optFns ...func(*Options)) (*DescribeBillingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeCACertificate.go b/service/iot/api_op_DescribeCACertificate.go index b253fda8710..f0c532ca68e 100644 --- a/service/iot/api_op_DescribeCACertificate.go +++ b/service/iot/api_op_DescribeCACertificate.go @@ -12,8 +12,7 @@ import ( ) // Describes a registered CA certificate. Requires permission to access the -// DescribeCACertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeCACertificate(ctx context.Context, params *DescribeCACertificateInput, optFns ...func(*Options)) (*DescribeCACertificateOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeCertificate.go b/service/iot/api_op_DescribeCertificate.go index 4151e710e51..1ba1c307473 100644 --- a/service/iot/api_op_DescribeCertificate.go +++ b/service/iot/api_op_DescribeCertificate.go @@ -12,8 +12,7 @@ import ( ) // Gets information about the specified certificate. Requires permission to access -// the DescribeCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the DescribeCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeCustomMetric.go b/service/iot/api_op_DescribeCustomMetric.go index 586de49285b..b45058ff98c 100644 --- a/service/iot/api_op_DescribeCustomMetric.go +++ b/service/iot/api_op_DescribeCustomMetric.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a Device Defender detect custom metric. Requires -// permission to access the DescribeCustomMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the DescribeCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeCustomMetric(ctx context.Context, params *DescribeCustomMetricInput, optFns ...func(*Options)) (*DescribeCustomMetricOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeDefaultAuthorizer.go b/service/iot/api_op_DescribeDefaultAuthorizer.go index f5e17aab404..8bc54e4604d 100644 --- a/service/iot/api_op_DescribeDefaultAuthorizer.go +++ b/service/iot/api_op_DescribeDefaultAuthorizer.go @@ -12,8 +12,7 @@ import ( ) // Describes the default authorizer. Requires permission to access the -// DescribeDefaultAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeDefaultAuthorizer(ctx context.Context, params *DescribeDefaultAuthorizerInput, optFns ...func(*Options)) (*DescribeDefaultAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeDetectMitigationActionsTask.go b/service/iot/api_op_DescribeDetectMitigationActionsTask.go index c6fe2caf6ec..bf8ab8c50f2 100644 --- a/service/iot/api_op_DescribeDetectMitigationActionsTask.go +++ b/service/iot/api_op_DescribeDetectMitigationActionsTask.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a Device Defender ML Detect mitigation action. Requires -// permission to access the DescribeDetectMitigationActionsTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the DescribeDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeDetectMitigationActionsTask(ctx context.Context, params *DescribeDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*DescribeDetectMitigationActionsTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeDimension.go b/service/iot/api_op_DescribeDimension.go index 52d0cd4c106..d2b5574078c 100644 --- a/service/iot/api_op_DescribeDimension.go +++ b/service/iot/api_op_DescribeDimension.go @@ -13,8 +13,7 @@ import ( ) // Provides details about a dimension that is defined in your Amazon Web Services -// accounts. Requires permission to access the DescribeDimension -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// accounts. Requires permission to access the DescribeDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeDimension(ctx context.Context, params *DescribeDimensionInput, optFns ...func(*Options)) (*DescribeDimensionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeDomainConfiguration.go b/service/iot/api_op_DescribeDomainConfiguration.go index 7cead659418..622517ad439 100644 --- a/service/iot/api_op_DescribeDomainConfiguration.go +++ b/service/iot/api_op_DescribeDomainConfiguration.go @@ -13,8 +13,7 @@ import ( ) // Gets summary information about a domain configuration. Requires permission to -// access the DescribeDomainConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the DescribeDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeDomainConfiguration(ctx context.Context, params *DescribeDomainConfigurationInput, optFns ...func(*Options)) (*DescribeDomainConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeEndpoint.go b/service/iot/api_op_DescribeEndpoint.go index e424f408f37..bce73cf8bf4 100644 --- a/service/iot/api_op_DescribeEndpoint.go +++ b/service/iot/api_op_DescribeEndpoint.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a unique endpoint specific to the Amazon Web Services account making the -// call. Requires permission to access the DescribeEndpoint -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Returns a unique endpoint specific to the Amazon Web Services account making +// the call. Requires permission to access the DescribeEndpoint (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error) { if params == nil { @@ -33,21 +32,15 @@ func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointI type DescribeEndpointInput struct { // The endpoint type. Valid endpoint types include: + // - iot:Data - Returns a VeriSign signed data endpoint. // - // * iot:Data - Returns a - // VeriSign signed data endpoint. + // - iot:Data-ATS - Returns an ATS signed data endpoint. // - // * iot:Data-ATS - Returns an ATS signed data - // endpoint. + // - iot:CredentialProvider - Returns an IoT credentials provider API endpoint. // - // * iot:CredentialProvider - Returns an IoT credentials provider API - // endpoint. - // - // * iot:Jobs - Returns an IoT device management Jobs API endpoint. - // - // We - // strongly recommend that customers use the newer iot:Data-ATS endpoint type to - // avoid issues related to the widespread distrust of Symantec certificate + // - iot:Jobs - Returns an IoT device management Jobs API endpoint. + // We strongly recommend that customers use the newer iot:Data-ATS endpoint type + // to avoid issues related to the widespread distrust of Symantec certificate // authorities. EndpointType *string diff --git a/service/iot/api_op_DescribeEventConfigurations.go b/service/iot/api_op_DescribeEventConfigurations.go index 7fca8a4ba39..7094a587d25 100644 --- a/service/iot/api_op_DescribeEventConfigurations.go +++ b/service/iot/api_op_DescribeEventConfigurations.go @@ -13,8 +13,7 @@ import ( ) // Describes event configurations. Requires permission to access the -// DescribeEventConfigurations -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeEventConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeEventConfigurations(ctx context.Context, params *DescribeEventConfigurationsInput, optFns ...func(*Options)) (*DescribeEventConfigurationsOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeFleetMetric.go b/service/iot/api_op_DescribeFleetMetric.go index 1374e938bfb..e57b44c19b3 100644 --- a/service/iot/api_op_DescribeFleetMetric.go +++ b/service/iot/api_op_DescribeFleetMetric.go @@ -12,9 +12,8 @@ import ( "time" ) -// Gets information about the specified fleet metric. Requires permission to access -// the DescribeFleetMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets information about the specified fleet metric. Requires permission to +// access the DescribeFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeFleetMetric(ctx context.Context, params *DescribeFleetMetricInput, optFns ...func(*Options)) (*DescribeFleetMetricOutput, error) { if params == nil { @@ -78,8 +77,8 @@ type DescribeFleetMetricOutput struct { QueryVersion *string // Used to support unit transformation such as milliseconds to seconds. The unit - // must be supported by CW metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html). + // must be supported by CW metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // . Unit types.FleetMetricUnit // The version of the fleet metric. diff --git a/service/iot/api_op_DescribeIndex.go b/service/iot/api_op_DescribeIndex.go index 18d7c4eb446..c5c9f0d92e1 100644 --- a/service/iot/api_op_DescribeIndex.go +++ b/service/iot/api_op_DescribeIndex.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a search index. Requires permission to access the DescribeIndex -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Describes a search index. Requires permission to access the DescribeIndex (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeIndex(ctx context.Context, params *DescribeIndexInput, optFns ...func(*Options)) (*DescribeIndexOutput, error) { if params == nil { @@ -49,24 +48,16 @@ type DescribeIndexOutput struct { // Contains a value that specifies the type of indexing performed. Valid values // are: - // - // * REGISTRY – Your thing index contains only registry data. - // - // * - // REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow - // data. - // - // * REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry - // data and thing connectivity status data. - // - // * - // REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry - // data, shadow data, and thing connectivity status data. - // - // * MULTI_INDEXING_MODE - - // Your thing index contains multiple data sources. For more information, see - // GetIndexingConfiguration - // (https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html). + // - REGISTRY – Your thing index contains only registry data. + // - REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow + // data. + // - REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data + // and thing connectivity status data. + // - REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains + // registry data, shadow data, and thing connectivity status data. + // - MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For + // more information, see GetIndexingConfiguration (https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html) + // . Schema *string // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeJob.go b/service/iot/api_op_DescribeJob.go index 55a7414bcd3..f311f18fb2e 100644 --- a/service/iot/api_op_DescribeJob.go +++ b/service/iot/api_op_DescribeJob.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a job. Requires permission to access the DescribeJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Describes a job. Requires permission to access the DescribeJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeJobExecution.go b/service/iot/api_op_DescribeJobExecution.go index 20a0084b0f5..fce7157c097 100644 --- a/service/iot/api_op_DescribeJobExecution.go +++ b/service/iot/api_op_DescribeJobExecution.go @@ -12,8 +12,7 @@ import ( ) // Describes a job execution. Requires permission to access the -// DescribeJobExecution -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeJobExecution (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeJobExecution(ctx context.Context, params *DescribeJobExecutionInput, optFns ...func(*Options)) (*DescribeJobExecutionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeJobTemplate.go b/service/iot/api_op_DescribeJobTemplate.go index 12737ec7698..8d2c2eb457a 100644 --- a/service/iot/api_op_DescribeJobTemplate.go +++ b/service/iot/api_op_DescribeJobTemplate.go @@ -75,10 +75,10 @@ type DescribeJobTemplateOutput struct { // Configuration for pre-signed S3 URLs. PresignedUrlConfig *types.PresignedUrlConfig - // Specifies the amount of time each device has to finish its execution of the job. - // A timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the timer - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. A timer is started when the job execution status is set to IN_PROGRESS . If + // the job execution status is not set to another terminal state before the timer + // expires, it will be automatically set to TIMED_OUT . TimeoutConfig *types.TimeoutConfig // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeManagedJobTemplate.go b/service/iot/api_op_DescribeManagedJobTemplate.go index 06c699f593f..28e59986e50 100644 --- a/service/iot/api_op_DescribeManagedJobTemplate.go +++ b/service/iot/api_op_DescribeManagedJobTemplate.go @@ -50,9 +50,9 @@ type DescribeManagedJobTemplateOutput struct { Document *string // A map of key-value pairs that you can use as guidance to specify the inputs for - // creating a job from a managed template. documentParameters can only be used when - // creating jobs from Amazon Web Services managed templates. This parameter can't - // be used with custom job templates or to create jobs from them. + // creating a job from a managed template. documentParameters can only be used + // when creating jobs from Amazon Web Services managed templates. This parameter + // can't be used with custom job templates or to create jobs from them. DocumentParameters []types.DocumentParameter // A list of environments that are supported with the managed job template. @@ -61,7 +61,7 @@ type DescribeManagedJobTemplateOutput struct { // The unique Amazon Resource Name (ARN) of the managed template. TemplateArn *string - // The unique name of a managed template, such as AWS-Reboot. + // The unique name of a managed template, such as AWS-Reboot . TemplateName *string // The version for a managed template. diff --git a/service/iot/api_op_DescribeMitigationAction.go b/service/iot/api_op_DescribeMitigationAction.go index 71beb68e739..770170e3864 100644 --- a/service/iot/api_op_DescribeMitigationAction.go +++ b/service/iot/api_op_DescribeMitigationAction.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a mitigation action. Requires permission to access the -// DescribeMitigationAction -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeMitigationAction(ctx context.Context, params *DescribeMitigationActionInput, optFns ...func(*Options)) (*DescribeMitigationActionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeProvisioningTemplate.go b/service/iot/api_op_DescribeProvisioningTemplate.go index e0eff2ff955..55dae41bc6b 100644 --- a/service/iot/api_op_DescribeProvisioningTemplate.go +++ b/service/iot/api_op_DescribeProvisioningTemplate.go @@ -12,9 +12,8 @@ import ( "time" ) -// Returns information about a provisioning template. Requires permission to access -// the DescribeProvisioningTemplate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Returns information about a provisioning template. Requires permission to +// access the DescribeProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeProvisioningTemplate(ctx context.Context, params *DescribeProvisioningTemplateInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateOutput, error) { if params == nil { @@ -76,9 +75,9 @@ type DescribeProvisioningTemplateOutput struct { // The type you define in a provisioning template. You can create a template with // only one type. You can't change the template type after its creation. The - // default value is FLEET_PROVISIONING. For more information about provisioning - // template, see: Provisioning template - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html). + // default value is FLEET_PROVISIONING . For more information about provisioning + // template, see: Provisioning template (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) + // . Type types.TemplateType // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeProvisioningTemplateVersion.go b/service/iot/api_op_DescribeProvisioningTemplateVersion.go index ff5fd809579..cf1887b51c3 100644 --- a/service/iot/api_op_DescribeProvisioningTemplateVersion.go +++ b/service/iot/api_op_DescribeProvisioningTemplateVersion.go @@ -12,8 +12,7 @@ import ( ) // Returns information about a provisioning template version. Requires permission -// to access the DescribeProvisioningTemplateVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the DescribeProvisioningTemplateVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeProvisioningTemplateVersion(ctx context.Context, params *DescribeProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeRoleAlias.go b/service/iot/api_op_DescribeRoleAlias.go index 73fa4ea67b0..e625dd060da 100644 --- a/service/iot/api_op_DescribeRoleAlias.go +++ b/service/iot/api_op_DescribeRoleAlias.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a role alias. Requires permission to access the DescribeRoleAlias -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Describes a role alias. Requires permission to access the DescribeRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeRoleAlias(ctx context.Context, params *DescribeRoleAliasInput, optFns ...func(*Options)) (*DescribeRoleAliasOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeScheduledAudit.go b/service/iot/api_op_DescribeScheduledAudit.go index 690370f39b6..4e8f418646d 100644 --- a/service/iot/api_op_DescribeScheduledAudit.go +++ b/service/iot/api_op_DescribeScheduledAudit.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a scheduled audit. Requires permission to access the -// DescribeScheduledAudit -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeScheduledAudit(ctx context.Context, params *DescribeScheduledAuditInput, optFns ...func(*Options)) (*DescribeScheduledAuditOutput, error) { if params == nil { @@ -43,16 +42,16 @@ type DescribeScheduledAuditInput struct { type DescribeScheduledAuditOutput struct { // The day of the month on which the scheduled audit takes place. This is will be 1 - // through 31 or LAST. If days 29-31 are specified, and the month does not have + // through 31 or LAST . If days 29 - 31 are specified, and the month does not have // that many days, the audit takes place on the LAST day of the month. DayOfMonth *string - // The day of the week on which the scheduled audit takes place, either one of SUN, - // MON, TUE, WED, THU, FRI, or SAT. + // The day of the week on which the scheduled audit takes place, either one of SUN + // , MON , TUE , WED , THU , FRI , or SAT . DayOfWeek types.DayOfWeek - // How often the scheduled audit takes place, either one of DAILY, WEEKLY, - // BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system. + // How often the scheduled audit takes place, either one of DAILY , WEEKLY , + // BIWEEKLY , or MONTHLY . The start time of each audit is determined by the system. Frequency types.AuditFrequency // The ARN of the scheduled audit. diff --git a/service/iot/api_op_DescribeSecurityProfile.go b/service/iot/api_op_DescribeSecurityProfile.go index 9c507817d6b..5d10cd9b1fc 100644 --- a/service/iot/api_op_DescribeSecurityProfile.go +++ b/service/iot/api_op_DescribeSecurityProfile.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a Device Defender security profile. Requires permission -// to access the DescribeSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the DescribeSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSecurityProfileInput, optFns ...func(*Options)) (*DescribeSecurityProfileOutput, error) { if params == nil { @@ -45,7 +44,7 @@ type DescribeSecurityProfileOutput struct { // Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead. // A list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any + // for any metric used in the profile's behaviors , but it is also retained for any // metric specified here. // // Deprecated: Use additionalMetricsToRetainV2. @@ -71,8 +70,8 @@ type DescribeSecurityProfileOutput struct { // The ARN of the security profile. SecurityProfileArn *string - // A description of the security profile (associated with the security profile when - // it was created or updated). + // A description of the security profile (associated with the security profile + // when it was created or updated). SecurityProfileDescription *string // The name of the security profile. diff --git a/service/iot/api_op_DescribeStream.go b/service/iot/api_op_DescribeStream.go index a6ed23fc819..67bfd93fd2c 100644 --- a/service/iot/api_op_DescribeStream.go +++ b/service/iot/api_op_DescribeStream.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a stream. Requires permission to access the -// DescribeStream -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeThing.go b/service/iot/api_op_DescribeThing.go index 088282e0294..3be4e37961e 100644 --- a/service/iot/api_op_DescribeThing.go +++ b/service/iot/api_op_DescribeThing.go @@ -11,8 +11,7 @@ import ( ) // Gets information about the specified thing. Requires permission to access the -// DescribeThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeThing(ctx context.Context, params *DescribeThingInput, optFns ...func(*Options)) (*DescribeThingOutput, error) { if params == nil { @@ -49,8 +48,8 @@ type DescribeThingOutput struct { // The name of the billing group the thing belongs to. BillingGroupName *string - // The default MQTT client ID. For a typical device, the thing name is also used as - // the default MQTT client ID. Although we don’t require a mapping between a + // The default MQTT client ID. For a typical device, the thing name is also used + // as the default MQTT client ID. Although we don’t require a mapping between a // thing's registry name and its use of MQTT client IDs, certificates, or shadow // state, we recommend that you choose a thing name and use it as the MQTT client // ID for the registry and the Device Shadow service. This lets you better organize diff --git a/service/iot/api_op_DescribeThingGroup.go b/service/iot/api_op_DescribeThingGroup.go index f3fd66e70b0..19a1faaf641 100644 --- a/service/iot/api_op_DescribeThingGroup.go +++ b/service/iot/api_op_DescribeThingGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe a thing group. Requires permission to access the DescribeThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Describe a thing group. Requires permission to access the DescribeThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeThingGroup(ctx context.Context, params *DescribeThingGroupInput, optFns ...func(*Options)) (*DescribeThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeThingRegistrationTask.go b/service/iot/api_op_DescribeThingRegistrationTask.go index 69775229053..e97d46addac 100644 --- a/service/iot/api_op_DescribeThingRegistrationTask.go +++ b/service/iot/api_op_DescribeThingRegistrationTask.go @@ -13,8 +13,7 @@ import ( ) // Describes a bulk thing provisioning task. Requires permission to access the -// DescribeThingRegistrationTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DescribeThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeThingRegistrationTask(ctx context.Context, params *DescribeThingRegistrationTaskInput, optFns ...func(*Options)) (*DescribeThingRegistrationTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_DescribeThingType.go b/service/iot/api_op_DescribeThingType.go index 907ce4f8b36..a1c96f430df 100644 --- a/service/iot/api_op_DescribeThingType.go +++ b/service/iot/api_op_DescribeThingType.go @@ -12,8 +12,7 @@ import ( ) // Gets information about the specified thing type. Requires permission to access -// the DescribeThingType -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the DescribeThingType (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeThingType(ctx context.Context, params *DescribeThingTypeInput, optFns ...func(*Options)) (*DescribeThingTypeOutput, error) { if params == nil { diff --git a/service/iot/api_op_DetachPolicy.go b/service/iot/api_op_DetachPolicy.go index aefdce71d66..7b6f7d60ce8 100644 --- a/service/iot/api_op_DetachPolicy.go +++ b/service/iot/api_op_DetachPolicy.go @@ -13,8 +13,7 @@ import ( // Detaches a policy from the specified target. Because of the distributed nature // of Amazon Web Services, it can take up to five minutes after a policy is // detached before it's ready to be deleted. Requires permission to access the -// DetachPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DetachPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error) { if params == nil { diff --git a/service/iot/api_op_DetachPrincipalPolicy.go b/service/iot/api_op_DetachPrincipalPolicy.go index d58508daee4..0d16f701190 100644 --- a/service/iot/api_op_DetachPrincipalPolicy.go +++ b/service/iot/api_op_DetachPrincipalPolicy.go @@ -13,8 +13,7 @@ import ( // Removes the specified policy from the specified certificate. Note: This action // is deprecated and works as expected for backward compatibility, but we won't add // enhancements. Use DetachPolicy instead. Requires permission to access the -// DetachPrincipalPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DetachPrincipalPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. // // Deprecated: This operation has been deprecated. diff --git a/service/iot/api_op_DetachSecurityProfile.go b/service/iot/api_op_DetachSecurityProfile.go index be51523b0ca..ef2d5762ce9 100644 --- a/service/iot/api_op_DetachSecurityProfile.go +++ b/service/iot/api_op_DetachSecurityProfile.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a Device Defender security profile from a thing group or from this -// account. Requires permission to access the DetachSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Disassociates a Device Defender security profile from a thing group or from +// this account. Requires permission to access the DetachSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DetachSecurityProfile(ctx context.Context, params *DetachSecurityProfileInput, optFns ...func(*Options)) (*DetachSecurityProfileOutput, error) { if params == nil { diff --git a/service/iot/api_op_DetachThingPrincipal.go b/service/iot/api_op_DetachThingPrincipal.go index c7e441f8979..135bc897138 100644 --- a/service/iot/api_op_DetachThingPrincipal.go +++ b/service/iot/api_op_DetachThingPrincipal.go @@ -14,8 +14,7 @@ import ( // X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or // federated identities. This call is asynchronous. It might take several seconds // for the detachment to propagate. Requires permission to access the -// DetachThingPrincipal -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DetachThingPrincipal (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DetachThingPrincipal(ctx context.Context, params *DetachThingPrincipalInput, optFns ...func(*Options)) (*DetachThingPrincipalOutput, error) { if params == nil { @@ -35,8 +34,8 @@ func (c *Client) DetachThingPrincipal(ctx context.Context, params *DetachThingPr // The input for the DetachThingPrincipal operation. type DetachThingPrincipalInput struct { - // If the principal is a certificate, this value must be ARN of the certificate. If - // the principal is an Amazon Cognito identity, this value must be the ID of the + // If the principal is a certificate, this value must be ARN of the certificate. + // If the principal is an Amazon Cognito identity, this value must be the ID of the // Amazon Cognito identity. // // This member is required. diff --git a/service/iot/api_op_DisableTopicRule.go b/service/iot/api_op_DisableTopicRule.go index 0e5bac597c7..da142fbb867 100644 --- a/service/iot/api_op_DisableTopicRule.go +++ b/service/iot/api_op_DisableTopicRule.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables the rule. Requires permission to access the DisableTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Disables the rule. Requires permission to access the DisableTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DisableTopicRule(ctx context.Context, params *DisableTopicRuleInput, optFns ...func(*Options)) (*DisableTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_EnableTopicRule.go b/service/iot/api_op_EnableTopicRule.go index ac628ae3965..ba8ba4059a7 100644 --- a/service/iot/api_op_EnableTopicRule.go +++ b/service/iot/api_op_EnableTopicRule.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the rule. Requires permission to access the EnableTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Enables the rule. Requires permission to access the EnableTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) EnableTopicRule(ctx context.Context, params *EnableTopicRuleInput, optFns ...func(*Options)) (*EnableTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetBehaviorModelTrainingSummaries.go b/service/iot/api_op_GetBehaviorModelTrainingSummaries.go index 8131db824ad..8cbfd47c427 100644 --- a/service/iot/api_op_GetBehaviorModelTrainingSummaries.go +++ b/service/iot/api_op_GetBehaviorModelTrainingSummaries.go @@ -13,8 +13,7 @@ import ( ) // Returns a Device Defender's ML Detect Security Profile training model's status. -// Requires permission to access the GetBehaviorModelTrainingSummaries -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the GetBehaviorModelTrainingSummaries (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetBehaviorModelTrainingSummaries(ctx context.Context, params *GetBehaviorModelTrainingSummariesInput, optFns ...func(*Options)) (*GetBehaviorModelTrainingSummariesOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetBucketsAggregation.go b/service/iot/api_op_GetBucketsAggregation.go index 8869b6dc228..8a01489cda5 100644 --- a/service/iot/api_op_GetBucketsAggregation.go +++ b/service/iot/api_op_GetBucketsAggregation.go @@ -12,8 +12,7 @@ import ( ) // Aggregates on indexed data with search queries pertaining to particular fields. -// Requires permission to access the GetBucketsAggregation -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the GetBucketsAggregation (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetBucketsAggregation(ctx context.Context, params *GetBucketsAggregationInput, optFns ...func(*Options)) (*GetBucketsAggregationOutput, error) { if params == nil { @@ -60,8 +59,8 @@ type GetBucketsAggregationInput struct { type GetBucketsAggregationOutput struct { // The main part of the response with a list of buckets. Each bucket contains a - // keyValue and a count. keyValue: The aggregation field value counted for the - // particular bucket. count: The number of documents that have that value. + // keyValue and a count . keyValue : The aggregation field value counted for the + // particular bucket. count : The number of documents that have that value. Buckets []types.Bucket // The total number of things that fit the query string criteria. diff --git a/service/iot/api_op_GetCardinality.go b/service/iot/api_op_GetCardinality.go index 6f888e66a0b..58ec834c07e 100644 --- a/service/iot/api_op_GetCardinality.go +++ b/service/iot/api_op_GetCardinality.go @@ -11,8 +11,7 @@ import ( ) // Returns the approximate count of unique values that match the query. Requires -// permission to access the GetCardinality -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the GetCardinality (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetCardinality(ctx context.Context, params *GetCardinalityInput, optFns ...func(*Options)) (*GetCardinalityOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetEffectivePolicies.go b/service/iot/api_op_GetEffectivePolicies.go index 75e02c93af9..8794e268b7f 100644 --- a/service/iot/api_op_GetEffectivePolicies.go +++ b/service/iot/api_op_GetEffectivePolicies.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of the policies that have an effect on the authorization behavior of -// the specified device when it connects to the IoT device gateway. Requires -// permission to access the GetEffectivePolicies -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets a list of the policies that have an effect on the authorization behavior +// of the specified device when it connects to the IoT device gateway. Requires +// permission to access the GetEffectivePolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetEffectivePolicies(ctx context.Context, params *GetEffectivePoliciesInput, optFns ...func(*Options)) (*GetEffectivePoliciesOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetIndexingConfiguration.go b/service/iot/api_op_GetIndexingConfiguration.go index d6796f0b102..d57aaedd0fa 100644 --- a/service/iot/api_op_GetIndexingConfiguration.go +++ b/service/iot/api_op_GetIndexingConfiguration.go @@ -12,8 +12,7 @@ import ( ) // Gets the indexing configuration. Requires permission to access the -// GetIndexingConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetIndexingConfiguration(ctx context.Context, params *GetIndexingConfigurationInput, optFns ...func(*Options)) (*GetIndexingConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetJobDocument.go b/service/iot/api_op_GetJobDocument.go index 4a67177c92e..8b458e8b8bb 100644 --- a/service/iot/api_op_GetJobDocument.go +++ b/service/iot/api_op_GetJobDocument.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a job document. Requires permission to access the GetJobDocument -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets a job document. Requires permission to access the GetJobDocument (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetJobDocument(ctx context.Context, params *GetJobDocumentInput, optFns ...func(*Options)) (*GetJobDocumentOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetLoggingOptions.go b/service/iot/api_op_GetLoggingOptions.go index 228ddfa5cdd..4cb4a590737 100644 --- a/service/iot/api_op_GetLoggingOptions.go +++ b/service/iot/api_op_GetLoggingOptions.go @@ -12,8 +12,7 @@ import ( ) // Gets the logging options. NOTE: use of this command is not recommended. Use -// GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetLoggingOptions(ctx context.Context, params *GetLoggingOptionsInput, optFns ...func(*Options)) (*GetLoggingOptionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetOTAUpdate.go b/service/iot/api_op_GetOTAUpdate.go index 3587aea5d89..70cda01d3d3 100644 --- a/service/iot/api_op_GetOTAUpdate.go +++ b/service/iot/api_op_GetOTAUpdate.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets an OTA update. Requires permission to access the GetOTAUpdate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets an OTA update. Requires permission to access the GetOTAUpdate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetOTAUpdate(ctx context.Context, params *GetOTAUpdateInput, optFns ...func(*Options)) (*GetOTAUpdateOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetPercentiles.go b/service/iot/api_op_GetPercentiles.go index 684b93c8d23..1292a8fcb18 100644 --- a/service/iot/api_op_GetPercentiles.go +++ b/service/iot/api_op_GetPercentiles.go @@ -11,17 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Groups the aggregated values that match the query into percentile groupings. The -// default percentile groupings are: 1,5,25,50,75,95,99, although you can specify -// your own when you call GetPercentiles. This function returns a value for each -// percentile group specified (or the default percentile groupings). The percentile -// group "1" contains the aggregated field value that occurs in approximately one -// percent of the values that match the query. The percentile group "5" contains -// the aggregated field value that occurs in approximately five percent of the -// values that match the query, and so on. The result is an approximation, the more -// values that match the query, the more accurate the percentile values. Requires -// permission to access the GetPercentiles -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Groups the aggregated values that match the query into percentile groupings. +// The default percentile groupings are: 1,5,25,50,75,95,99, although you can +// specify your own when you call GetPercentiles . This function returns a value +// for each percentile group specified (or the default percentile groupings). The +// percentile group "1" contains the aggregated field value that occurs in +// approximately one percent of the values that match the query. The percentile +// group "5" contains the aggregated field value that occurs in approximately five +// percent of the values that match the query, and so on. The result is an +// approximation, the more values that match the query, the more accurate the +// percentile values. Requires permission to access the GetPercentiles (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetPercentiles(ctx context.Context, params *GetPercentilesInput, optFns ...func(*Options)) (*GetPercentilesOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetPolicy.go b/service/iot/api_op_GetPolicy.go index 88725262777..524f0584629 100644 --- a/service/iot/api_op_GetPolicy.go +++ b/service/iot/api_op_GetPolicy.go @@ -12,8 +12,7 @@ import ( ) // Gets information about the specified policy with the policy document of the -// default version. Requires permission to access the GetPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// default version. Requires permission to access the GetPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetPolicyVersion.go b/service/iot/api_op_GetPolicyVersion.go index 35e90152dcd..7e8b62a51c0 100644 --- a/service/iot/api_op_GetPolicyVersion.go +++ b/service/iot/api_op_GetPolicyVersion.go @@ -12,8 +12,7 @@ import ( ) // Gets information about the specified policy version. Requires permission to -// access the GetPolicyVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the GetPolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetRegistrationCode.go b/service/iot/api_op_GetRegistrationCode.go index 70a5b0e7c04..0ac4af81d98 100644 --- a/service/iot/api_op_GetRegistrationCode.go +++ b/service/iot/api_op_GetRegistrationCode.go @@ -11,8 +11,7 @@ import ( ) // Gets a registration code used to register a CA certificate with IoT. Requires -// permission to access the GetRegistrationCode -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the GetRegistrationCode (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetRegistrationCode(ctx context.Context, params *GetRegistrationCodeInput, optFns ...func(*Options)) (*GetRegistrationCodeOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetStatistics.go b/service/iot/api_op_GetStatistics.go index 35fe334ff0e..2d43f70ac45 100644 --- a/service/iot/api_op_GetStatistics.go +++ b/service/iot/api_op_GetStatistics.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the count, average, sum, minimum, maximum, sum of squares, variance, and -// standard deviation for the specified aggregated field. If the aggregation field -// is of type String, only the count statistic is returned. Requires permission to -// access the GetStatistics -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Returns the count, average, sum, minimum, maximum, sum of squares, variance, +// and standard deviation for the specified aggregated field. If the aggregation +// field is of type String , only the count statistic is returned. Requires +// permission to access the GetStatistics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetStatistics(ctx context.Context, params *GetStatisticsInput, optFns ...func(*Options)) (*GetStatisticsOutput, error) { if params == nil { @@ -43,7 +42,7 @@ type GetStatisticsInput struct { // The aggregation field name. AggregationField *string - // The name of the index to search. The default value is AWS_Things. + // The name of the index to search. The default value is AWS_Things . IndexName *string // The version of the query used to search. diff --git a/service/iot/api_op_GetTopicRule.go b/service/iot/api_op_GetTopicRule.go index 15a76d2919a..6a773c5b3f4 100644 --- a/service/iot/api_op_GetTopicRule.go +++ b/service/iot/api_op_GetTopicRule.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the rule. Requires permission to access the GetTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Gets information about the rule. Requires permission to access the GetTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetTopicRule(ctx context.Context, params *GetTopicRuleInput, optFns ...func(*Options)) (*GetTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetTopicRuleDestination.go b/service/iot/api_op_GetTopicRuleDestination.go index 05a6e7e3124..0c896ef91cd 100644 --- a/service/iot/api_op_GetTopicRuleDestination.go +++ b/service/iot/api_op_GetTopicRuleDestination.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a topic rule destination. Requires permission to access -// the GetTopicRuleDestination -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the GetTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetTopicRuleDestination(ctx context.Context, params *GetTopicRuleDestinationInput, optFns ...func(*Options)) (*GetTopicRuleDestinationOutput, error) { if params == nil { diff --git a/service/iot/api_op_GetV2LoggingOptions.go b/service/iot/api_op_GetV2LoggingOptions.go index b65ed70c042..1a0e8f6d7cd 100644 --- a/service/iot/api_op_GetV2LoggingOptions.go +++ b/service/iot/api_op_GetV2LoggingOptions.go @@ -12,8 +12,7 @@ import ( ) // Gets the fine grained logging options. Requires permission to access the -// GetV2LoggingOptions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// GetV2LoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetV2LoggingOptions(ctx context.Context, params *GetV2LoggingOptionsInput, optFns ...func(*Options)) (*GetV2LoggingOptionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListActiveViolations.go b/service/iot/api_op_ListActiveViolations.go index 765d6bc7001..be372526988 100644 --- a/service/iot/api_op_ListActiveViolations.go +++ b/service/iot/api_op_ListActiveViolations.go @@ -13,8 +13,7 @@ import ( ) // Lists the active violations for a given Device Defender security profile. -// Requires permission to access the ListActiveViolations -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListActiveViolations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListActiveViolations(ctx context.Context, params *ListActiveViolationsInput, optFns ...func(*Options)) (*ListActiveViolationsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListAttachedPolicies.go b/service/iot/api_op_ListAttachedPolicies.go index 8b36b490a1b..b44d9053c93 100644 --- a/service/iot/api_op_ListAttachedPolicies.go +++ b/service/iot/api_op_ListAttachedPolicies.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the policies attached to the specified thing group. Requires permission to -// access the ListAttachedPolicies -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists the policies attached to the specified thing group. Requires permission +// to access the ListAttachedPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAttachedPolicies(ctx context.Context, params *ListAttachedPoliciesInput, optFns ...func(*Options)) (*ListAttachedPoliciesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListAuditFindings.go b/service/iot/api_op_ListAuditFindings.go index 23a267aa6aa..6bebbda561d 100644 --- a/service/iot/api_op_ListAuditFindings.go +++ b/service/iot/api_op_ListAuditFindings.go @@ -15,8 +15,7 @@ import ( // Lists the findings (results) of a Device Defender audit or of the audits // performed during a specified time period. (Findings are retained for 90 days.) -// Requires permission to access the ListAuditFindings -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListAuditFindings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuditFindings(ctx context.Context, params *ListAuditFindingsInput, optFns ...func(*Options)) (*ListAuditFindingsOutput, error) { if params == nil { @@ -42,9 +41,9 @@ type ListAuditFindingsInput struct { // specify either the startTime and endTime or the taskId, but not both. EndTime *time.Time - // Boolean flag indicating whether only the suppressed findings or the unsuppressed - // findings should be listed. If this parameter isn't provided, the response will - // list both suppressed and unsuppressed findings. + // Boolean flag indicating whether only the suppressed findings or the + // unsuppressed findings should be listed. If this parameter isn't provided, the + // response will list both suppressed and unsuppressed findings. ListSuppressedFindings bool // The maximum number of results to return at one time. The default is 25. diff --git a/service/iot/api_op_ListAuditMitigationActionsExecutions.go b/service/iot/api_op_ListAuditMitigationActionsExecutions.go index 3fcd5397e6f..cf0a2f6b437 100644 --- a/service/iot/api_op_ListAuditMitigationActionsExecutions.go +++ b/service/iot/api_op_ListAuditMitigationActionsExecutions.go @@ -13,8 +13,7 @@ import ( ) // Gets the status of audit mitigation action tasks that were executed. Requires -// permission to access the ListAuditMitigationActionsExecutions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListAuditMitigationActionsExecutions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuditMitigationActionsExecutions(ctx context.Context, params *ListAuditMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListAuditMitigationActionsExecutionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListAuditMitigationActionsTasks.go b/service/iot/api_op_ListAuditMitigationActionsTasks.go index 25b11907a74..e2c58895fa6 100644 --- a/service/iot/api_op_ListAuditMitigationActionsTasks.go +++ b/service/iot/api_op_ListAuditMitigationActionsTasks.go @@ -14,8 +14,7 @@ import ( ) // Gets a list of audit mitigation action tasks that match the specified filters. -// Requires permission to access the ListAuditMitigationActionsTasks -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListAuditMitigationActionsTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuditMitigationActionsTasks(ctx context.Context, params *ListAuditMitigationActionsTasksInput, optFns ...func(*Options)) (*ListAuditMitigationActionsTasksOutput, error) { if params == nil { @@ -34,8 +33,8 @@ func (c *Client) ListAuditMitigationActionsTasks(ctx context.Context, params *Li type ListAuditMitigationActionsTasksInput struct { - // Specify this filter to limit results to tasks that were completed or canceled on - // or before a specific date and time. + // Specify this filter to limit results to tasks that were completed or canceled + // on or before a specific date and time. // // This member is required. EndTime *time.Time @@ -46,8 +45,8 @@ type ListAuditMitigationActionsTasksInput struct { // This member is required. StartTime *time.Time - // Specify this filter to limit results to tasks that were applied to results for a - // specific audit. + // Specify this filter to limit results to tasks that were applied to results for + // a specific audit. AuditTaskId *string // Specify this filter to limit results to tasks that were applied to a specific diff --git a/service/iot/api_op_ListAuditSuppressions.go b/service/iot/api_op_ListAuditSuppressions.go index 649298741b8..00046176b9f 100644 --- a/service/iot/api_op_ListAuditSuppressions.go +++ b/service/iot/api_op_ListAuditSuppressions.go @@ -13,8 +13,7 @@ import ( ) // Lists your Device Defender audit listings. Requires permission to access the -// ListAuditSuppressions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListAuditSuppressions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuditSuppressions(ctx context.Context, params *ListAuditSuppressionsInput, optFns ...func(*Options)) (*ListAuditSuppressionsOutput, error) { if params == nil { @@ -33,8 +32,8 @@ func (c *Client) ListAuditSuppressions(ctx context.Context, params *ListAuditSup type ListAuditSuppressionsInput struct { - // Determines whether suppressions are listed in ascending order by expiration date - // or not. If parameter isn't provided, ascendingOrder=true. + // Determines whether suppressions are listed in ascending order by expiration + // date or not. If parameter isn't provided, ascendingOrder=true . AscendingOrder bool // An audit check name. Checks must be enabled for your account. (Use diff --git a/service/iot/api_op_ListAuditTasks.go b/service/iot/api_op_ListAuditTasks.go index fd5f5032d0a..ee1adfb55bf 100644 --- a/service/iot/api_op_ListAuditTasks.go +++ b/service/iot/api_op_ListAuditTasks.go @@ -14,8 +14,7 @@ import ( ) // Lists the Device Defender audits that have been performed during a given time -// period. Requires permission to access the ListAuditTasks -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// period. Requires permission to access the ListAuditTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuditTasks(ctx context.Context, params *ListAuditTasksInput, optFns ...func(*Options)) (*ListAuditTasksOutput, error) { if params == nil { @@ -52,8 +51,8 @@ type ListAuditTasksInput struct { // The token for the next set of results. NextToken *string - // A filter to limit the output to audits with the specified completion status: can - // be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". + // A filter to limit the output to audits with the specified completion status: + // can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED". TaskStatus types.AuditTaskStatus // A filter to limit the output to the specified type of audit: can be one of diff --git a/service/iot/api_op_ListAuthorizers.go b/service/iot/api_op_ListAuthorizers.go index b3c43e0bf4a..f19478d4333 100644 --- a/service/iot/api_op_ListAuthorizers.go +++ b/service/iot/api_op_ListAuthorizers.go @@ -13,8 +13,7 @@ import ( ) // Lists the authorizers registered in your account. Requires permission to access -// the ListAuthorizers -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the ListAuthorizers (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListAuthorizers(ctx context.Context, params *ListAuthorizersInput, optFns ...func(*Options)) (*ListAuthorizersOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListBillingGroups.go b/service/iot/api_op_ListBillingGroups.go index 9740187ea4b..492f622b541 100644 --- a/service/iot/api_op_ListBillingGroups.go +++ b/service/iot/api_op_ListBillingGroups.go @@ -13,8 +13,7 @@ import ( ) // Lists the billing groups you have created. Requires permission to access the -// ListBillingGroups -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListBillingGroups (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListBillingGroups(ctx context.Context, params *ListBillingGroupsInput, optFns ...func(*Options)) (*ListBillingGroupsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListCACertificates.go b/service/iot/api_op_ListCACertificates.go index 7e9dde399bb..5b67ac3cd83 100644 --- a/service/iot/api_op_ListCACertificates.go +++ b/service/iot/api_op_ListCACertificates.go @@ -15,8 +15,7 @@ import ( // Lists the CA certificates registered for your Amazon Web Services account. The // results are paginated with a default page size of 25. You can use the returned // marker to retrieve additional results. Requires permission to access the -// ListCACertificates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListCACertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListCACertificates(ctx context.Context, params *ListCACertificatesInput, optFns ...func(*Options)) (*ListCACertificatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListCertificates.go b/service/iot/api_op_ListCertificates.go index 884d6b61495..a3e79ed0473 100644 --- a/service/iot/api_op_ListCertificates.go +++ b/service/iot/api_op_ListCertificates.go @@ -15,8 +15,7 @@ import ( // Lists the certificates registered in your Amazon Web Services account. The // results are paginated with a default page size of 25. You can use the returned // marker to retrieve additional results. Requires permission to access the -// ListCertificates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListCertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListCertificatesByCA.go b/service/iot/api_op_ListCertificatesByCA.go index da8b1d1b217..26fc25281ef 100644 --- a/service/iot/api_op_ListCertificatesByCA.go +++ b/service/iot/api_op_ListCertificatesByCA.go @@ -13,8 +13,7 @@ import ( ) // List the device certificates signed by the specified CA certificate. Requires -// permission to access the ListCertificatesByCA -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListCertificatesByCA (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListCertificatesByCA(ctx context.Context, params *ListCertificatesByCAInput, optFns ...func(*Options)) (*ListCertificatesByCAOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListCustomMetrics.go b/service/iot/api_op_ListCustomMetrics.go index 58a97f1a210..6f17f1ebf44 100644 --- a/service/iot/api_op_ListCustomMetrics.go +++ b/service/iot/api_op_ListCustomMetrics.go @@ -12,8 +12,7 @@ import ( ) // Lists your Device Defender detect custom metrics. Requires permission to access -// the ListCustomMetrics -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the ListCustomMetrics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListCustomMetrics(ctx context.Context, params *ListCustomMetricsInput, optFns ...func(*Options)) (*ListCustomMetricsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListDetectMitigationActionsExecutions.go b/service/iot/api_op_ListDetectMitigationActionsExecutions.go index 84e7455d791..41ae9173b83 100644 --- a/service/iot/api_op_ListDetectMitigationActionsExecutions.go +++ b/service/iot/api_op_ListDetectMitigationActionsExecutions.go @@ -14,8 +14,7 @@ import ( ) // Lists mitigation actions executions for a Device Defender ML Detect Security -// Profile. Requires permission to access the ListDetectMitigationActionsExecutions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Profile. Requires permission to access the ListDetectMitigationActionsExecutions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListDetectMitigationActionsExecutions(ctx context.Context, params *ListDetectMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListDetectMitigationActionsExecutionsOutput, error) { if params == nil { @@ -34,8 +33,8 @@ func (c *Client) ListDetectMitigationActionsExecutions(ctx context.Context, para type ListDetectMitigationActionsExecutionsInput struct { - // The end of the time period for which ML Detect mitigation actions executions are - // returned. + // The end of the time period for which ML Detect mitigation actions executions + // are returned. EndTime *time.Time // The maximum number of results to return at one time. The default is 25. diff --git a/service/iot/api_op_ListDetectMitigationActionsTasks.go b/service/iot/api_op_ListDetectMitigationActionsTasks.go index e5ceebef18b..67abade01b3 100644 --- a/service/iot/api_op_ListDetectMitigationActionsTasks.go +++ b/service/iot/api_op_ListDetectMitigationActionsTasks.go @@ -14,8 +14,7 @@ import ( ) // List of Device Defender ML Detect mitigation actions tasks. Requires permission -// to access the ListDetectMitigationActionsTasks -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the ListDetectMitigationActionsTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListDetectMitigationActionsTasks(ctx context.Context, params *ListDetectMitigationActionsTasksInput, optFns ...func(*Options)) (*ListDetectMitigationActionsTasksOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListDimensions.go b/service/iot/api_op_ListDimensions.go index 28cff5374af..a4c5399e842 100644 --- a/service/iot/api_op_ListDimensions.go +++ b/service/iot/api_op_ListDimensions.go @@ -12,8 +12,7 @@ import ( ) // List the set of dimensions that are defined for your Amazon Web Services -// accounts. Requires permission to access the ListDimensions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// accounts. Requires permission to access the ListDimensions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListDimensions(ctx context.Context, params *ListDimensionsInput, optFns ...func(*Options)) (*ListDimensionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListDomainConfigurations.go b/service/iot/api_op_ListDomainConfigurations.go index b18b37e9644..bb48f34a7f0 100644 --- a/service/iot/api_op_ListDomainConfigurations.go +++ b/service/iot/api_op_ListDomainConfigurations.go @@ -14,8 +14,7 @@ import ( // Gets a list of domain configurations for the user. This list is sorted // alphabetically by domain configuration name. Requires permission to access the -// ListDomainConfigurations -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListDomainConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListDomainConfigurations(ctx context.Context, params *ListDomainConfigurationsInput, optFns ...func(*Options)) (*ListDomainConfigurationsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListFleetMetrics.go b/service/iot/api_op_ListFleetMetrics.go index 43baf09e06c..6f1aaa39644 100644 --- a/service/iot/api_op_ListFleetMetrics.go +++ b/service/iot/api_op_ListFleetMetrics.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all your fleet metrics. Requires permission to access the ListFleetMetrics -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists all your fleet metrics. Requires permission to access the ListFleetMetrics (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListFleetMetrics(ctx context.Context, params *ListFleetMetricsInput, optFns ...func(*Options)) (*ListFleetMetricsOutput, error) { if params == nil { @@ -47,8 +46,8 @@ type ListFleetMetricsOutput struct { // The list of fleet metrics objects. FleetMetrics []types.FleetMetricNameAndArn - // The token for the next set of results. Will not be returned if the operation has - // returned all results. + // The token for the next set of results. Will not be returned if the operation + // has returned all results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_ListIndices.go b/service/iot/api_op_ListIndices.go index d5744f2eaa2..e218b3fada8 100644 --- a/service/iot/api_op_ListIndices.go +++ b/service/iot/api_op_ListIndices.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the search indices. Requires permission to access the ListIndices -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists the search indices. Requires permission to access the ListIndices (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optFns ...func(*Options)) (*ListIndicesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListJobExecutionsForJob.go b/service/iot/api_op_ListJobExecutionsForJob.go index 99862337fe2..b455d375f59 100644 --- a/service/iot/api_op_ListJobExecutionsForJob.go +++ b/service/iot/api_op_ListJobExecutionsForJob.go @@ -13,8 +13,7 @@ import ( ) // Lists the job executions for a job. Requires permission to access the -// ListJobExecutionsForJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListJobExecutionsForJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListJobExecutionsForJob(ctx context.Context, params *ListJobExecutionsForJobInput, optFns ...func(*Options)) (*ListJobExecutionsForJobOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListJobExecutionsForThing.go b/service/iot/api_op_ListJobExecutionsForThing.go index d7ce1cb96a4..19df7b48fa4 100644 --- a/service/iot/api_op_ListJobExecutionsForThing.go +++ b/service/iot/api_op_ListJobExecutionsForThing.go @@ -13,8 +13,7 @@ import ( ) // Lists the job executions for the specified thing. Requires permission to access -// the ListJobExecutionsForThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the ListJobExecutionsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListJobExecutionsForThing(ctx context.Context, params *ListJobExecutionsForThingInput, optFns ...func(*Options)) (*ListJobExecutionsForThingOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListJobTemplates.go b/service/iot/api_op_ListJobTemplates.go index 7c60a452115..9956c474de9 100644 --- a/service/iot/api_op_ListJobTemplates.go +++ b/service/iot/api_op_ListJobTemplates.go @@ -13,8 +13,7 @@ import ( ) // Returns a list of job templates. Requires permission to access the -// ListJobTemplates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListJobTemplates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListJobTemplates(ctx context.Context, params *ListJobTemplatesInput, optFns ...func(*Options)) (*ListJobTemplatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListJobs.go b/service/iot/api_op_ListJobs.go index 7bf9209639c..6b11849e0a1 100644 --- a/service/iot/api_op_ListJobs.go +++ b/service/iot/api_op_ListJobs.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists jobs. Requires permission to access the ListJobs -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists jobs. Requires permission to access the ListJobs (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { @@ -48,14 +47,15 @@ type ListJobsInput struct { // An optional filter that lets you search for jobs that have the specified status. Status types.JobStatus - // Specifies whether the job will continue to run (CONTINUOUS), or will be complete - // after all those things specified as targets have completed the job (SNAPSHOT). - // If continuous, the job may also be run on a thing when a change is detected in a - // target. For example, a job will run on a thing when the thing is added to a - // target group, even after the job was completed by all things originally in the - // group. We recommend that you use continuous jobs instead of snapshot jobs for - // dynamic thing group targets. By using continuous jobs, devices that join the - // group receive the job execution even after the job has been created. + // Specifies whether the job will continue to run (CONTINUOUS), or will be + // complete after all those things specified as targets have completed the job + // (SNAPSHOT). If continuous, the job may also be run on a thing when a change is + // detected in a target. For example, a job will run on a thing when the thing is + // added to a target group, even after the job was completed by all things + // originally in the group. We recommend that you use continuous jobs instead of + // snapshot jobs for dynamic thing group targets. By using continuous jobs, devices + // that join the group receive the job execution even after the job has been + // created. TargetSelection types.TargetSelection // A filter that limits the returned jobs to those for the specified group. diff --git a/service/iot/api_op_ListMetricValues.go b/service/iot/api_op_ListMetricValues.go index f3ff6fd967b..3233876c900 100644 --- a/service/iot/api_op_ListMetricValues.go +++ b/service/iot/api_op_ListMetricValues.go @@ -13,9 +13,9 @@ import ( "time" ) -// Lists the values reported for an IoT Device Defender metric (device-side metric, -// cloud-side metric, or custom metric) by the given thing during the specified -// time period. +// Lists the values reported for an IoT Device Defender metric (device-side +// metric, cloud-side metric, or custom metric) by the given thing during the +// specified time period. func (c *Client) ListMetricValues(ctx context.Context, params *ListMetricValuesInput, optFns ...func(*Options)) (*ListMetricValuesOutput, error) { if params == nil { params = &ListMetricValuesInput{} diff --git a/service/iot/api_op_ListMitigationActions.go b/service/iot/api_op_ListMitigationActions.go index 92a5b917ac0..d264b1890f8 100644 --- a/service/iot/api_op_ListMitigationActions.go +++ b/service/iot/api_op_ListMitigationActions.go @@ -13,8 +13,7 @@ import ( ) // Gets a list of all mitigation actions that match the specified filter criteria. -// Requires permission to access the ListMitigationActions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListMitigationActions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListMitigationActions(ctx context.Context, params *ListMitigationActionsInput, optFns ...func(*Options)) (*ListMitigationActionsOutput, error) { if params == nil { @@ -33,8 +32,8 @@ func (c *Client) ListMitigationActions(ctx context.Context, params *ListMitigati type ListMitigationActionsInput struct { - // Specify a value to limit the result to mitigation actions with a specific action - // type. + // Specify a value to limit the result to mitigation actions with a specific + // action type. ActionType types.MitigationActionType // The maximum number of results to return at one time. The default is 25. diff --git a/service/iot/api_op_ListOTAUpdates.go b/service/iot/api_op_ListOTAUpdates.go index 5a0816a5890..0140b8ebadc 100644 --- a/service/iot/api_op_ListOTAUpdates.go +++ b/service/iot/api_op_ListOTAUpdates.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists OTA updates. Requires permission to access the ListOTAUpdates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists OTA updates. Requires permission to access the ListOTAUpdates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListOTAUpdates(ctx context.Context, params *ListOTAUpdatesInput, optFns ...func(*Options)) (*ListOTAUpdatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListOutgoingCertificates.go b/service/iot/api_op_ListOutgoingCertificates.go index a829568c4a4..cdb2f53dd88 100644 --- a/service/iot/api_op_ListOutgoingCertificates.go +++ b/service/iot/api_op_ListOutgoingCertificates.go @@ -13,8 +13,7 @@ import ( ) // Lists certificates that are being transferred but not yet accepted. Requires -// permission to access the ListOutgoingCertificates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListOutgoingCertificates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListOutgoingCertificates(ctx context.Context, params *ListOutgoingCertificatesInput, optFns ...func(*Options)) (*ListOutgoingCertificatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListPolicies.go b/service/iot/api_op_ListPolicies.go index 892cd339cf3..9378007d5d8 100644 --- a/service/iot/api_op_ListPolicies.go +++ b/service/iot/api_op_ListPolicies.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists your policies. Requires permission to access the ListPolicies -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists your policies. Requires permission to access the ListPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListPolicyPrincipals.go b/service/iot/api_op_ListPolicyPrincipals.go index dd95f430bdb..d255afda885 100644 --- a/service/iot/api_op_ListPolicyPrincipals.go +++ b/service/iot/api_op_ListPolicyPrincipals.go @@ -14,8 +14,7 @@ import ( // Lists the principals associated with the specified policy. Note: This action is // deprecated and works as expected for backward compatibility, but we won't add // enhancements. Use ListTargetsForPolicy instead. Requires permission to access -// the ListPolicyPrincipals -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the ListPolicyPrincipals (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. // // Deprecated: This operation has been deprecated. diff --git a/service/iot/api_op_ListPolicyVersions.go b/service/iot/api_op_ListPolicyVersions.go index 6401d3dde68..dd94a7cbd5b 100644 --- a/service/iot/api_op_ListPolicyVersions.go +++ b/service/iot/api_op_ListPolicyVersions.go @@ -12,8 +12,7 @@ import ( ) // Lists the versions of the specified policy and identifies the default version. -// Requires permission to access the ListPolicyVersions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListPolicyVersions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListPrincipalPolicies.go b/service/iot/api_op_ListPrincipalPolicies.go index e59f4af44c3..35fddd389f2 100644 --- a/service/iot/api_op_ListPrincipalPolicies.go +++ b/service/iot/api_op_ListPrincipalPolicies.go @@ -13,12 +13,10 @@ import ( ) // Lists the policies attached to the specified principal. If you use an Cognito -// identity, the ID must be in AmazonCognito Identity format -// (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax). -// Note: This action is deprecated and works as expected for backward +// identity, the ID must be in AmazonCognito Identity format (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax) +// . Note: This action is deprecated and works as expected for backward // compatibility, but we won't add enhancements. Use ListAttachedPolicies instead. -// Requires permission to access the ListPrincipalPolicies -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListPrincipalPolicies (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. // // Deprecated: This operation has been deprecated. diff --git a/service/iot/api_op_ListPrincipalThings.go b/service/iot/api_op_ListPrincipalThings.go index c5544550353..acb6889b9c7 100644 --- a/service/iot/api_op_ListPrincipalThings.go +++ b/service/iot/api_op_ListPrincipalThings.go @@ -13,8 +13,7 @@ import ( // Lists the things associated with the specified principal. A principal can be // X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or -// federated identities. Requires permission to access the ListPrincipalThings -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// federated identities. Requires permission to access the ListPrincipalThings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListPrincipalThings(ctx context.Context, params *ListPrincipalThingsInput, optFns ...func(*Options)) (*ListPrincipalThingsOutput, error) { if params == nil { @@ -128,8 +127,8 @@ func (c *Client) addOperationListPrincipalThingsMiddlewares(stack *middleware.St return nil } -// ListPrincipalThingsAPIClient is a client that implements the ListPrincipalThings -// operation. +// ListPrincipalThingsAPIClient is a client that implements the +// ListPrincipalThings operation. type ListPrincipalThingsAPIClient interface { ListPrincipalThings(context.Context, *ListPrincipalThingsInput, ...func(*Options)) (*ListPrincipalThingsOutput, error) } diff --git a/service/iot/api_op_ListProvisioningTemplateVersions.go b/service/iot/api_op_ListProvisioningTemplateVersions.go index c95cdc51c01..d36a0580887 100644 --- a/service/iot/api_op_ListProvisioningTemplateVersions.go +++ b/service/iot/api_op_ListProvisioningTemplateVersions.go @@ -13,8 +13,7 @@ import ( ) // A list of provisioning template versions. Requires permission to access the -// ListProvisioningTemplateVersions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListProvisioningTemplateVersions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListProvisioningTemplateVersions(ctx context.Context, params *ListProvisioningTemplateVersionsInput, optFns ...func(*Options)) (*ListProvisioningTemplateVersionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListProvisioningTemplates.go b/service/iot/api_op_ListProvisioningTemplates.go index ef625f8fc90..3a620beb918 100644 --- a/service/iot/api_op_ListProvisioningTemplates.go +++ b/service/iot/api_op_ListProvisioningTemplates.go @@ -13,8 +13,7 @@ import ( ) // Lists the provisioning templates in your Amazon Web Services account. Requires -// permission to access the ListProvisioningTemplates -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListProvisioningTemplates (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListProvisioningTemplates(ctx context.Context, params *ListProvisioningTemplatesInput, optFns ...func(*Options)) (*ListProvisioningTemplatesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListRelatedResourcesForAuditFinding.go b/service/iot/api_op_ListRelatedResourcesForAuditFinding.go index df05f506123..b7e7588d65c 100644 --- a/service/iot/api_op_ListRelatedResourcesForAuditFinding.go +++ b/service/iot/api_op_ListRelatedResourcesForAuditFinding.go @@ -13,33 +13,19 @@ import ( // The related resources of an Audit finding. The following resources can be // returned from calling this API: +// - DEVICE_CERTIFICATE +// - CA_CERTIFICATE +// - IOT_POLICY +// - COGNITO_IDENTITY_POOL +// - CLIENT_ID +// - ACCOUNT_SETTINGS +// - ROLE_ALIAS +// - IAM_ROLE +// - ISSUER_CERTIFICATE // -// * DEVICE_CERTIFICATE -// -// * CA_CERTIFICATE -// -// * -// IOT_POLICY -// -// * COGNITO_IDENTITY_POOL -// -// * CLIENT_ID -// -// * ACCOUNT_SETTINGS -// -// * -// ROLE_ALIAS -// -// * IAM_ROLE -// -// * ISSUER_CERTIFICATE -// -// This API is similar to -// DescribeAuditFinding's RelatedResources -// (https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html) +// This API is similar to DescribeAuditFinding's RelatedResources (https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html) // but provides pagination and is not limited to 10 resources. When calling -// DescribeAuditFinding -// (https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html) +// DescribeAuditFinding (https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html) // for the intermediate CA revoked for active device certificates check, // RelatedResources will not be populated. You must use this API, // ListRelatedResourcesForAuditFinding, to list the certificates. diff --git a/service/iot/api_op_ListRoleAliases.go b/service/iot/api_op_ListRoleAliases.go index 1681fbe2e98..f64544c43ef 100644 --- a/service/iot/api_op_ListRoleAliases.go +++ b/service/iot/api_op_ListRoleAliases.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the role aliases registered in your account. Requires permission to access -// the ListRoleAliases -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists the role aliases registered in your account. Requires permission to +// access the ListRoleAliases (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListRoleAliases(ctx context.Context, params *ListRoleAliasesInput, optFns ...func(*Options)) (*ListRoleAliasesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListScheduledAudits.go b/service/iot/api_op_ListScheduledAudits.go index 2530829ead3..44db7d2f83e 100644 --- a/service/iot/api_op_ListScheduledAudits.go +++ b/service/iot/api_op_ListScheduledAudits.go @@ -13,8 +13,7 @@ import ( ) // Lists all of your scheduled audits. Requires permission to access the -// ListScheduledAudits -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListScheduledAudits (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListScheduledAudits(ctx context.Context, params *ListScheduledAuditsInput, optFns ...func(*Options)) (*ListScheduledAuditsOutput, error) { if params == nil { @@ -117,8 +116,8 @@ func (c *Client) addOperationListScheduledAuditsMiddlewares(stack *middleware.St return nil } -// ListScheduledAuditsAPIClient is a client that implements the ListScheduledAudits -// operation. +// ListScheduledAuditsAPIClient is a client that implements the +// ListScheduledAudits operation. type ListScheduledAuditsAPIClient interface { ListScheduledAudits(context.Context, *ListScheduledAuditsInput, ...func(*Options)) (*ListScheduledAuditsOutput, error) } diff --git a/service/iot/api_op_ListSecurityProfiles.go b/service/iot/api_op_ListSecurityProfiles.go index 359c1b37812..f18b175dd5d 100644 --- a/service/iot/api_op_ListSecurityProfiles.go +++ b/service/iot/api_op_ListSecurityProfiles.go @@ -14,8 +14,7 @@ import ( // Lists the Device Defender security profiles you've created. You can filter // security profiles by dimension or custom metric. Requires permission to access -// the ListSecurityProfiles -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the ListSecurityProfiles (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. dimensionName and metricName cannot be used in the same request. func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type ListSecurityProfilesInput struct { // The maximum number of results to return at one time. MaxResults *int32 - // The name of the custom metric. Cannot be used with dimensionName. + // The name of the custom metric. Cannot be used with dimensionName . MetricName *string // The token for the next set of results. diff --git a/service/iot/api_op_ListSecurityProfilesForTarget.go b/service/iot/api_op_ListSecurityProfilesForTarget.go index fd0c58d5f61..98bc47cc268 100644 --- a/service/iot/api_op_ListSecurityProfilesForTarget.go +++ b/service/iot/api_op_ListSecurityProfilesForTarget.go @@ -13,8 +13,7 @@ import ( ) // Lists the Device Defender security profiles attached to a target (thing group). -// Requires permission to access the ListSecurityProfilesForTarget -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListSecurityProfilesForTarget (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListSecurityProfilesForTarget(ctx context.Context, params *ListSecurityProfilesForTargetInput, optFns ...func(*Options)) (*ListSecurityProfilesForTargetOutput, error) { if params == nil { @@ -33,8 +32,8 @@ func (c *Client) ListSecurityProfilesForTarget(ctx context.Context, params *List type ListSecurityProfilesForTargetInput struct { - // The ARN of the target (thing group) whose attached security profiles you want to - // get. + // The ARN of the target (thing group) whose attached security profiles you want + // to get. // // This member is required. SecurityProfileTargetArn *string diff --git a/service/iot/api_op_ListStreams.go b/service/iot/api_op_ListStreams.go index f3c81536755..ea966f6680c 100644 --- a/service/iot/api_op_ListStreams.go +++ b/service/iot/api_op_ListStreams.go @@ -13,8 +13,7 @@ import ( ) // Lists all of the streams in your Amazon Web Services account. Requires -// permission to access the ListStreams -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListStreams (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListTagsForResource.go b/service/iot/api_op_ListTagsForResource.go index c67f4b0fdc1..1da9d5ff79a 100644 --- a/service/iot/api_op_ListTagsForResource.go +++ b/service/iot/api_op_ListTagsForResource.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags (metadata) you have assigned to the resource. Requires permission -// to access the ListTagsForResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists the tags (metadata) you have assigned to the resource. Requires +// permission to access the ListTagsForResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -123,8 +122,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/iot/api_op_ListTargetsForPolicy.go b/service/iot/api_op_ListTargetsForPolicy.go index 8ddbcdc9de1..e233420e433 100644 --- a/service/iot/api_op_ListTargetsForPolicy.go +++ b/service/iot/api_op_ListTargetsForPolicy.go @@ -12,8 +12,7 @@ import ( ) // List targets for the specified policy. Requires permission to access the -// ListTargetsForPolicy -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListTargetsForPolicy (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsForPolicyInput, optFns ...func(*Options)) (*ListTargetsForPolicyOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListTargetsForSecurityProfile.go b/service/iot/api_op_ListTargetsForSecurityProfile.go index 35aa096910c..6f8d82835a0 100644 --- a/service/iot/api_op_ListTargetsForSecurityProfile.go +++ b/service/iot/api_op_ListTargetsForSecurityProfile.go @@ -14,8 +14,7 @@ import ( // Lists the targets (thing groups) associated with a given Device Defender // security profile. Requires permission to access the -// ListTargetsForSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListTargetsForSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTargetsForSecurityProfile(ctx context.Context, params *ListTargetsForSecurityProfileInput, optFns ...func(*Options)) (*ListTargetsForSecurityProfileOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThingGroups.go b/service/iot/api_op_ListThingGroups.go index 7dda2251a01..e1beceea4db 100644 --- a/service/iot/api_op_ListThingGroups.go +++ b/service/iot/api_op_ListThingGroups.go @@ -13,8 +13,7 @@ import ( ) // List the thing groups in your account. Requires permission to access the -// ListThingGroups -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListThingGroups (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingGroups(ctx context.Context, params *ListThingGroupsInput, optFns ...func(*Options)) (*ListThingGroupsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThingGroupsForThing.go b/service/iot/api_op_ListThingGroupsForThing.go index 8e75668c680..f1be307d4e7 100644 --- a/service/iot/api_op_ListThingGroupsForThing.go +++ b/service/iot/api_op_ListThingGroupsForThing.go @@ -13,8 +13,7 @@ import ( ) // List the thing groups to which the specified thing belongs. Requires permission -// to access the ListThingGroupsForThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the ListThingGroupsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingGroupsForThing(ctx context.Context, params *ListThingGroupsForThingInput, optFns ...func(*Options)) (*ListThingGroupsForThingOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThingPrincipals.go b/service/iot/api_op_ListThingPrincipals.go index b65ea584bea..91018de813e 100644 --- a/service/iot/api_op_ListThingPrincipals.go +++ b/service/iot/api_op_ListThingPrincipals.go @@ -13,8 +13,7 @@ import ( // Lists the principals associated with the specified thing. A principal can be // X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or -// federated identities. Requires permission to access the ListThingPrincipals -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// federated identities. Requires permission to access the ListThingPrincipals (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingPrincipals(ctx context.Context, params *ListThingPrincipalsInput, optFns ...func(*Options)) (*ListThingPrincipalsOutput, error) { if params == nil { @@ -128,8 +127,8 @@ func (c *Client) addOperationListThingPrincipalsMiddlewares(stack *middleware.St return nil } -// ListThingPrincipalsAPIClient is a client that implements the ListThingPrincipals -// operation. +// ListThingPrincipalsAPIClient is a client that implements the +// ListThingPrincipals operation. type ListThingPrincipalsAPIClient interface { ListThingPrincipals(context.Context, *ListThingPrincipalsInput, ...func(*Options)) (*ListThingPrincipalsOutput, error) } diff --git a/service/iot/api_op_ListThingRegistrationTasks.go b/service/iot/api_op_ListThingRegistrationTasks.go index 6e7d9b17caa..56e875ccf9b 100644 --- a/service/iot/api_op_ListThingRegistrationTasks.go +++ b/service/iot/api_op_ListThingRegistrationTasks.go @@ -13,8 +13,7 @@ import ( ) // List bulk thing provisioning tasks. Requires permission to access the -// ListThingRegistrationTasks -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListThingRegistrationTasks (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingRegistrationTasks(ctx context.Context, params *ListThingRegistrationTasksInput, optFns ...func(*Options)) (*ListThingRegistrationTasksOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThingTypes.go b/service/iot/api_op_ListThingTypes.go index c2f5be22c0f..674bf05949c 100644 --- a/service/iot/api_op_ListThingTypes.go +++ b/service/iot/api_op_ListThingTypes.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the existing thing types. Requires permission to access the ListThingTypes -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists the existing thing types. Requires permission to access the ListThingTypes (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingTypes(ctx context.Context, params *ListThingTypesInput, optFns ...func(*Options)) (*ListThingTypesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThings.go b/service/iot/api_op_ListThings.go index 0ad8bbecfde..65560da39cb 100644 --- a/service/iot/api_op_ListThings.go +++ b/service/iot/api_op_ListThings.go @@ -12,14 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists your things. Use the attributeName and attributeValue parameters to filter -// your things. For example, calling ListThings with attributeName=Color and -// attributeValue=Red retrieves all things in the registry that contain an -// attribute Color with the value Red. For more information, see List Things -// (https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things) +// Lists your things. Use the attributeName and attributeValue parameters to +// filter your things. For example, calling ListThings with attributeName=Color +// and attributeValue=Red retrieves all things in the registry that contain an +// attribute Color with the value Red. For more information, see List Things (https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things) // from the Amazon Web Services IoT Core Developer Guide. Requires permission to -// access the ListThings -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the ListThings (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. You will not be charged for calling this API if an Access denied error // is returned. You will also not be charged if no attributes or pagination token // was provided in request and no pagination token and no results were returned. @@ -57,8 +55,8 @@ type ListThingsInput struct { // The name of the thing type used to search for things. ThingTypeName *string - // When true, the action returns the thing resources with attribute values that - // start with the attributeValue provided. When false, or not present, the action + // When true , the action returns the thing resources with attribute values that + // start with the attributeValue provided. When false , or not present, the action // returns only the thing resources with attribute values that match the entire // attributeValue provided. UsePrefixAttributeValue bool diff --git a/service/iot/api_op_ListThingsInBillingGroup.go b/service/iot/api_op_ListThingsInBillingGroup.go index 6cb1d3da6d8..559376264cf 100644 --- a/service/iot/api_op_ListThingsInBillingGroup.go +++ b/service/iot/api_op_ListThingsInBillingGroup.go @@ -12,8 +12,7 @@ import ( ) // Lists the things you have added to the given billing group. Requires permission -// to access the ListThingsInBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the ListThingsInBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingsInBillingGroup(ctx context.Context, params *ListThingsInBillingGroupInput, optFns ...func(*Options)) (*ListThingsInBillingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListThingsInThingGroup.go b/service/iot/api_op_ListThingsInThingGroup.go index 1524e36b10c..b6e0714e24c 100644 --- a/service/iot/api_op_ListThingsInThingGroup.go +++ b/service/iot/api_op_ListThingsInThingGroup.go @@ -12,8 +12,7 @@ import ( ) // Lists the things in the specified group. Requires permission to access the -// ListThingsInThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListThingsInThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListThingsInThingGroup(ctx context.Context, params *ListThingsInThingGroupInput, optFns ...func(*Options)) (*ListThingsInThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListTopicRuleDestinations.go b/service/iot/api_op_ListTopicRuleDestinations.go index ff52d80ad9f..a90d4db664e 100644 --- a/service/iot/api_op_ListTopicRuleDestinations.go +++ b/service/iot/api_op_ListTopicRuleDestinations.go @@ -13,8 +13,7 @@ import ( ) // Lists all the topic rule destinations in your Amazon Web Services account. -// Requires permission to access the ListTopicRuleDestinations -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the ListTopicRuleDestinations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTopicRuleDestinations(ctx context.Context, params *ListTopicRuleDestinationsInput, optFns ...func(*Options)) (*ListTopicRuleDestinationsOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListTopicRules.go b/service/iot/api_op_ListTopicRules.go index 62f552f4677..5790c5e0c46 100644 --- a/service/iot/api_op_ListTopicRules.go +++ b/service/iot/api_op_ListTopicRules.go @@ -13,8 +13,7 @@ import ( ) // Lists the rules for the specific topic. Requires permission to access the -// ListTopicRules -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListTopicRules (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTopicRules(ctx context.Context, params *ListTopicRulesInput, optFns ...func(*Options)) (*ListTopicRulesOutput, error) { if params == nil { diff --git a/service/iot/api_op_ListV2LoggingLevels.go b/service/iot/api_op_ListV2LoggingLevels.go index 3d298a344a8..5a6e919e8f9 100644 --- a/service/iot/api_op_ListV2LoggingLevels.go +++ b/service/iot/api_op_ListV2LoggingLevels.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists logging levels. Requires permission to access the ListV2LoggingLevels -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Lists logging levels. Requires permission to access the ListV2LoggingLevels (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListV2LoggingLevels(ctx context.Context, params *ListV2LoggingLevelsInput, optFns ...func(*Options)) (*ListV2LoggingLevelsOutput, error) { if params == nil { @@ -39,7 +38,7 @@ type ListV2LoggingLevelsInput struct { // response; otherwise null to receive the first set of results. NextToken *string - // The type of resource for which you are configuring logging. Must be THING_Group. + // The type of resource for which you are configuring logging. Must be THING_Group . TargetType types.LogTargetType noSmithyDocumentSerde @@ -120,8 +119,8 @@ func (c *Client) addOperationListV2LoggingLevelsMiddlewares(stack *middleware.St return nil } -// ListV2LoggingLevelsAPIClient is a client that implements the ListV2LoggingLevels -// operation. +// ListV2LoggingLevelsAPIClient is a client that implements the +// ListV2LoggingLevels operation. type ListV2LoggingLevelsAPIClient interface { ListV2LoggingLevels(context.Context, *ListV2LoggingLevelsInput, ...func(*Options)) (*ListV2LoggingLevelsOutput, error) } diff --git a/service/iot/api_op_ListViolationEvents.go b/service/iot/api_op_ListViolationEvents.go index 035b8b3864d..e28cbbb904e 100644 --- a/service/iot/api_op_ListViolationEvents.go +++ b/service/iot/api_op_ListViolationEvents.go @@ -16,8 +16,7 @@ import ( // Lists the Device Defender security profile violations discovered during the // given time period. You can use filters to limit the results to those alerts // issued for a particular security profile, behavior, or thing (device). Requires -// permission to access the ListViolationEvents -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListViolationEvents (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListViolationEvents(ctx context.Context, params *ListViolationEventsInput, optFns ...func(*Options)) (*ListViolationEventsOutput, error) { if params == nil { @@ -151,8 +150,8 @@ func (c *Client) addOperationListViolationEventsMiddlewares(stack *middleware.St return nil } -// ListViolationEventsAPIClient is a client that implements the ListViolationEvents -// operation. +// ListViolationEventsAPIClient is a client that implements the +// ListViolationEvents operation. type ListViolationEventsAPIClient interface { ListViolationEvents(context.Context, *ListViolationEventsInput, ...func(*Options)) (*ListViolationEventsOutput, error) } diff --git a/service/iot/api_op_PutVerificationStateOnViolation.go b/service/iot/api_op_PutVerificationStateOnViolation.go index afb01e3e216..b7487ac786c 100644 --- a/service/iot/api_op_PutVerificationStateOnViolation.go +++ b/service/iot/api_op_PutVerificationStateOnViolation.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Set a verification state and provide a description of that verification state on -// a violation (detect alarm). +// Set a verification state and provide a description of that verification state +// on a violation (detect alarm). func (c *Client) PutVerificationStateOnViolation(ctx context.Context, params *PutVerificationStateOnViolationInput, optFns ...func(*Options)) (*PutVerificationStateOnViolationOutput, error) { if params == nil { params = &PutVerificationStateOnViolationInput{} diff --git a/service/iot/api_op_RegisterCACertificate.go b/service/iot/api_op_RegisterCACertificate.go index a7633e2ddf3..9c250c0036d 100644 --- a/service/iot/api_op_RegisterCACertificate.go +++ b/service/iot/api_op_RegisterCACertificate.go @@ -15,8 +15,7 @@ import ( // to the number of CA certificates you can register in your Amazon Web Services // account. You can register up to 10 CA certificates with the same CA subject // field per Amazon Web Services account. Requires permission to access the -// RegisterCACertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// RegisterCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) RegisterCACertificate(ctx context.Context, params *RegisterCACertificateInput, optFns ...func(*Options)) (*RegisterCACertificateOutput, error) { if params == nil { @@ -47,13 +46,13 @@ type RegisterCACertificateInput struct { // Describes the certificate mode in which the Certificate Authority (CA) will be // registered. If the verificationCertificate field is not provided, set - // certificateMode to be SNI_ONLY. If the verificationCertificate field is - // provided, set certificateMode to be DEFAULT. When certificateMode is not - // provided, it defaults to DEFAULT. All the device certificates that are + // certificateMode to be SNI_ONLY . If the verificationCertificate field is + // provided, set certificateMode to be DEFAULT . When certificateMode is not + // provided, it defaults to DEFAULT . All the device certificates that are // registered using this CA will be registered in the same certificate mode as the // CA. For more information about certificate mode for device certificates, see - // certificate mode - // (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode). + // certificate mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) + // . CertificateMode types.CertificateMode // Information about the registration configuration. @@ -69,7 +68,7 @@ type RegisterCACertificateInput struct { // file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag - // The private key verification certificate. If certificateMode is SNI_ONLY, the + // The private key verification certificate. If certificateMode is SNI_ONLY , the // verificationCertificate field must be empty. If certificateMode is DEFAULT or // not provided, the verificationCertificate field must not be empty. VerificationCertificate *string diff --git a/service/iot/api_op_RegisterCertificate.go b/service/iot/api_op_RegisterCertificate.go index 96eeea2fdf1..bc9593ca815 100644 --- a/service/iot/api_op_RegisterCertificate.go +++ b/service/iot/api_op_RegisterCertificate.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a device certificate with IoT in the same certificate mode -// (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) +// Registers a device certificate with IoT in the same certificate mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) // as the signing CA. If you have more than one CA certificate that has the same // subject field, you must specify the CA certificate that was used to sign the // device certificate being registered. Requires permission to access the -// RegisterCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// RegisterCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertificateInput, optFns ...func(*Options)) (*RegisterCertificateOutput, error) { if params == nil { @@ -52,7 +50,7 @@ type RegisterCertificateInput struct { SetAsActive *bool // The status of the register certificate request. Valid values that you can use - // include ACTIVE, INACTIVE, and REVOKED. + // include ACTIVE , INACTIVE , and REVOKED . Status types.CertificateStatus noSmithyDocumentSerde diff --git a/service/iot/api_op_RegisterCertificateWithoutCA.go b/service/iot/api_op_RegisterCertificateWithoutCA.go index f388a585019..0162c1e4a49 100644 --- a/service/iot/api_op_RegisterCertificateWithoutCA.go +++ b/service/iot/api_op_RegisterCertificateWithoutCA.go @@ -12,8 +12,8 @@ import ( ) // Register a certificate that does not have a certificate authority (CA). For -// supported certificates, consult Certificate signing algorithms supported by IoT -// (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms). +// supported certificates, consult Certificate signing algorithms supported by IoT (https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms) +// . func (c *Client) RegisterCertificateWithoutCA(ctx context.Context, params *RegisterCertificateWithoutCAInput, optFns ...func(*Options)) (*RegisterCertificateWithoutCAOutput, error) { if params == nil { params = &RegisterCertificateWithoutCAInput{} diff --git a/service/iot/api_op_RegisterThing.go b/service/iot/api_op_RegisterThing.go index be6a95a1afa..5b91310a650 100644 --- a/service/iot/api_op_RegisterThing.go +++ b/service/iot/api_op_RegisterThing.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provisions a thing in the device registry. RegisterThing calls other IoT control -// plane APIs. These calls might exceed your account level IoT Throttling Limits -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot) -// and cause throttle errors. Please contact Amazon Web Services Customer Support -// (https://console.aws.amazon.com/support/home) to raise your throttling limits if -// necessary. Requires permission to access the RegisterThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Provisions a thing in the device registry. RegisterThing calls other IoT +// control plane APIs. These calls might exceed your account level IoT Throttling +// Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot) +// and cause throttle errors. Please contact Amazon Web Services Customer Support (https://console.aws.amazon.com/support/home) +// to raise your throttling limits if necessary. Requires permission to access the +// RegisterThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) RegisterThing(ctx context.Context, params *RegisterThingInput, optFns ...func(*Options)) (*RegisterThingOutput, error) { if params == nil { @@ -36,15 +35,13 @@ func (c *Client) RegisterThing(ctx context.Context, params *RegisterThingInput, type RegisterThingInput struct { // The provisioning template. See Provisioning Devices That Have Device - // Certificates - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html) + // Certificates (https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html) // for more information. // // This member is required. TemplateBody *string - // The parameters for provisioning a thing. See Provisioning Templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) + // The parameters for provisioning a thing. See Provisioning Templates (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) // for more information. Parameters map[string]string diff --git a/service/iot/api_op_RejectCertificateTransfer.go b/service/iot/api_op_RejectCertificateTransfer.go index 4b500fb6696..75cb7ab079c 100644 --- a/service/iot/api_op_RejectCertificateTransfer.go +++ b/service/iot/api_op_RejectCertificateTransfer.go @@ -12,11 +12,11 @@ import ( // Rejects a pending certificate transfer. After IoT rejects a certificate // transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To -// check for pending certificate transfers, call ListCertificates to enumerate your -// certificates. This operation can only be called by the transfer destination. -// After it is called, the certificate will be returned to the source's account in -// the INACTIVE state. Requires permission to access the RejectCertificateTransfer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// check for pending certificate transfers, call ListCertificates to enumerate +// your certificates. This operation can only be called by the transfer +// destination. After it is called, the certificate will be returned to the +// source's account in the INACTIVE state. Requires permission to access the +// RejectCertificateTransfer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) RejectCertificateTransfer(ctx context.Context, params *RejectCertificateTransferInput, optFns ...func(*Options)) (*RejectCertificateTransferOutput, error) { if params == nil { diff --git a/service/iot/api_op_RemoveThingFromBillingGroup.go b/service/iot/api_op_RemoveThingFromBillingGroup.go index fb998f587d0..60bff9ead28 100644 --- a/service/iot/api_op_RemoveThingFromBillingGroup.go +++ b/service/iot/api_op_RemoveThingFromBillingGroup.go @@ -11,8 +11,7 @@ import ( ) // Removes the given thing from the billing group. Requires permission to access -// the RemoveThingFromBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the RemoveThingFromBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. This call is asynchronous. It might take several seconds for the // detachment to propagate. func (c *Client) RemoveThingFromBillingGroup(ctx context.Context, params *RemoveThingFromBillingGroupInput, optFns ...func(*Options)) (*RemoveThingFromBillingGroupOutput, error) { diff --git a/service/iot/api_op_RemoveThingFromThingGroup.go b/service/iot/api_op_RemoveThingFromThingGroup.go index d8cf40edb15..c1f53d4dfbe 100644 --- a/service/iot/api_op_RemoveThingFromThingGroup.go +++ b/service/iot/api_op_RemoveThingFromThingGroup.go @@ -13,8 +13,7 @@ import ( // Remove the specified thing from the specified group. You must specify either a // thingGroupArn or a thingGroupName to identify the thing group and either a // thingArn or a thingName to identify the thing to remove from the thing group. -// Requires permission to access the RemoveThingFromThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the RemoveThingFromThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) RemoveThingFromThingGroup(ctx context.Context, params *RemoveThingFromThingGroupInput, optFns ...func(*Options)) (*RemoveThingFromThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_ReplaceTopicRule.go b/service/iot/api_op_ReplaceTopicRule.go index 2e3c97fdea9..2cdcc26ba70 100644 --- a/service/iot/api_op_ReplaceTopicRule.go +++ b/service/iot/api_op_ReplaceTopicRule.go @@ -14,8 +14,7 @@ import ( // Replaces the rule. You must specify all parameters for the new rule. Creating // rules is an administrator-level action. Any user who has permission to create // rules will be able to access data processed by the rule. Requires permission to -// access the ReplaceTopicRule -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the ReplaceTopicRule (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ReplaceTopicRule(ctx context.Context, params *ReplaceTopicRuleInput, optFns ...func(*Options)) (*ReplaceTopicRuleOutput, error) { if params == nil { diff --git a/service/iot/api_op_SearchIndex.go b/service/iot/api_op_SearchIndex.go index 1494b0ac280..0227cd4650c 100644 --- a/service/iot/api_op_SearchIndex.go +++ b/service/iot/api_op_SearchIndex.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The query search index. Requires permission to access the SearchIndex -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// The query search index. Requires permission to access the SearchIndex (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SearchIndex(ctx context.Context, params *SearchIndexInput, optFns ...func(*Options)) (*SearchIndexOutput, error) { if params == nil { @@ -31,9 +30,9 @@ func (c *Client) SearchIndex(ctx context.Context, params *SearchIndexInput, optF type SearchIndexInput struct { - // The search query string. For more information about the search query syntax, see - // Query syntax - // (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html). + // The search query string. For more information about the search query syntax, + // see Query syntax (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html) + // . // // This member is required. QueryString *string diff --git a/service/iot/api_op_SetDefaultAuthorizer.go b/service/iot/api_op_SetDefaultAuthorizer.go index 6410bfaf360..b23e46bc8ac 100644 --- a/service/iot/api_op_SetDefaultAuthorizer.go +++ b/service/iot/api_op_SetDefaultAuthorizer.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the default authorizer. This will be used if a websocket connection is made -// without specifying an authorizer. Requires permission to access the -// SetDefaultAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Sets the default authorizer. This will be used if a websocket connection is +// made without specifying an authorizer. Requires permission to access the +// SetDefaultAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SetDefaultAuthorizer(ctx context.Context, params *SetDefaultAuthorizerInput, optFns ...func(*Options)) (*SetDefaultAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_SetDefaultPolicyVersion.go b/service/iot/api_op_SetDefaultPolicyVersion.go index 95e3d5fee1a..dc5f57cf1c5 100644 --- a/service/iot/api_op_SetDefaultPolicyVersion.go +++ b/service/iot/api_op_SetDefaultPolicyVersion.go @@ -14,8 +14,7 @@ import ( // (operative) version. This action affects all certificates to which the policy is // attached. To list the principals the policy is attached to, use the // ListPrincipalPolicies action. Requires permission to access the -// SetDefaultPolicyVersion -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// SetDefaultPolicyVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error) { if params == nil { diff --git a/service/iot/api_op_SetLoggingOptions.go b/service/iot/api_op_SetLoggingOptions.go index c94d41353c8..2d650aadfeb 100644 --- a/service/iot/api_op_SetLoggingOptions.go +++ b/service/iot/api_op_SetLoggingOptions.go @@ -12,8 +12,7 @@ import ( ) // Sets the logging options. NOTE: use of this command is not recommended. Use -// SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SetLoggingOptions(ctx context.Context, params *SetLoggingOptionsInput, optFns ...func(*Options)) (*SetLoggingOptionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_SetV2LoggingLevel.go b/service/iot/api_op_SetV2LoggingLevel.go index e7fa57382da..b7be45a7166 100644 --- a/service/iot/api_op_SetV2LoggingLevel.go +++ b/service/iot/api_op_SetV2LoggingLevel.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the logging level. Requires permission to access the SetV2LoggingLevel -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Sets the logging level. Requires permission to access the SetV2LoggingLevel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SetV2LoggingLevel(ctx context.Context, params *SetV2LoggingLevelInput, optFns ...func(*Options)) (*SetV2LoggingLevelOutput, error) { if params == nil { diff --git a/service/iot/api_op_SetV2LoggingOptions.go b/service/iot/api_op_SetV2LoggingOptions.go index c8f9532e009..8dc8decf830 100644 --- a/service/iot/api_op_SetV2LoggingOptions.go +++ b/service/iot/api_op_SetV2LoggingOptions.go @@ -12,8 +12,7 @@ import ( ) // Sets the logging options for the V2 logging service. Requires permission to -// access the SetV2LoggingOptions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the SetV2LoggingOptions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) SetV2LoggingOptions(ctx context.Context, params *SetV2LoggingOptionsInput, optFns ...func(*Options)) (*SetV2LoggingOptionsOutput, error) { if params == nil { diff --git a/service/iot/api_op_StartAuditMitigationActionsTask.go b/service/iot/api_op_StartAuditMitigationActionsTask.go index 20f4cb0784f..e8f7df08a09 100644 --- a/service/iot/api_op_StartAuditMitigationActionsTask.go +++ b/service/iot/api_op_StartAuditMitigationActionsTask.go @@ -13,8 +13,7 @@ import ( ) // Starts a task that applies a set of mitigation actions to the specified target. -// Requires permission to access the StartAuditMitigationActionsTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the StartAuditMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StartAuditMitigationActionsTask(ctx context.Context, params *StartAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*StartAuditMitigationActionsTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_StartDetectMitigationActionsTask.go b/service/iot/api_op_StartDetectMitigationActionsTask.go index 64c42493fb8..3e3b83a67b6 100644 --- a/service/iot/api_op_StartDetectMitigationActionsTask.go +++ b/service/iot/api_op_StartDetectMitigationActionsTask.go @@ -13,8 +13,7 @@ import ( ) // Starts a Device Defender ML Detect mitigation actions task. Requires permission -// to access the StartDetectMitigationActionsTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the StartDetectMitigationActionsTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StartDetectMitigationActionsTask(ctx context.Context, params *StartDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*StartDetectMitigationActionsTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_StartOnDemandAuditTask.go b/service/iot/api_op_StartOnDemandAuditTask.go index 9d0f201f947..75012404955 100644 --- a/service/iot/api_op_StartOnDemandAuditTask.go +++ b/service/iot/api_op_StartOnDemandAuditTask.go @@ -11,8 +11,7 @@ import ( ) // Starts an on-demand Device Defender audit. Requires permission to access the -// StartOnDemandAuditTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// StartOnDemandAuditTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StartOnDemandAuditTask(ctx context.Context, params *StartOnDemandAuditTaskInput, optFns ...func(*Options)) (*StartOnDemandAuditTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_StartThingRegistrationTask.go b/service/iot/api_op_StartThingRegistrationTask.go index da934bbf664..71278947913 100644 --- a/service/iot/api_op_StartThingRegistrationTask.go +++ b/service/iot/api_op_StartThingRegistrationTask.go @@ -11,8 +11,7 @@ import ( ) // Creates a bulk thing provisioning task. Requires permission to access the -// StartThingRegistrationTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// StartThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StartThingRegistrationTask(ctx context.Context, params *StartThingRegistrationTaskInput, optFns ...func(*Options)) (*StartThingRegistrationTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_StopThingRegistrationTask.go b/service/iot/api_op_StopThingRegistrationTask.go index 1334873ac28..5d2f8f6bece 100644 --- a/service/iot/api_op_StopThingRegistrationTask.go +++ b/service/iot/api_op_StopThingRegistrationTask.go @@ -11,8 +11,7 @@ import ( ) // Cancels a bulk thing provisioning task. Requires permission to access the -// StopThingRegistrationTask -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// StopThingRegistrationTask (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StopThingRegistrationTask(ctx context.Context, params *StopThingRegistrationTaskInput, optFns ...func(*Options)) (*StopThingRegistrationTaskOutput, error) { if params == nil { diff --git a/service/iot/api_op_TagResource.go b/service/iot/api_op_TagResource.go index 62206c0ffa1..f5f2e7c317d 100644 --- a/service/iot/api_op_TagResource.go +++ b/service/iot/api_op_TagResource.go @@ -12,8 +12,7 @@ import ( ) // Adds to or modifies the tags of the given resource. Tags are metadata which can -// be used to manage a resource. Requires permission to access the TagResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// be used to manage a resource. Requires permission to access the TagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/iot/api_op_TestAuthorization.go b/service/iot/api_op_TestAuthorization.go index 5bfa3e894bc..264bb39138c 100644 --- a/service/iot/api_op_TestAuthorization.go +++ b/service/iot/api_op_TestAuthorization.go @@ -14,8 +14,7 @@ import ( // Tests if a specified principal is authorized to perform an IoT action on a // specified resource. Use this to test and debug the authorization behavior of // devices that connect to the IoT device gateway. Requires permission to access -// the TestAuthorization -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the TestAuthorization (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) TestAuthorization(ctx context.Context, params *TestAuthorizationInput, optFns ...func(*Options)) (*TestAuthorizationOutput, error) { if params == nil { @@ -46,12 +45,12 @@ type TestAuthorizationInput struct { // The Cognito identity pool ID. CognitoIdentityPoolId *string - // When testing custom authorization, the policies specified here are treated as if - // they are attached to the principal being authorized. + // When testing custom authorization, the policies specified here are treated as + // if they are attached to the principal being authorized. PolicyNamesToAdd []string - // When testing custom authorization, the policies specified here are treated as if - // they are not attached to the principal being authorized. + // When testing custom authorization, the policies specified here are treated as + // if they are not attached to the principal being authorized. PolicyNamesToSkip []string // The principal. Valid principals are CertificateArn diff --git a/service/iot/api_op_TestInvokeAuthorizer.go b/service/iot/api_op_TestInvokeAuthorizer.go index 4b153ddd2de..e9a6ae4b904 100644 --- a/service/iot/api_op_TestInvokeAuthorizer.go +++ b/service/iot/api_op_TestInvokeAuthorizer.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tests a custom authorization behavior by invoking a specified custom authorizer. -// Use this to test and debug the custom authorization behavior of devices that -// connect to the IoT device gateway. Requires permission to access the -// TestInvokeAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Tests a custom authorization behavior by invoking a specified custom +// authorizer. Use this to test and debug the custom authorization behavior of +// devices that connect to the IoT device gateway. Requires permission to access +// the TestInvokeAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAuthorizerInput, optFns ...func(*Options)) (*TestInvokeAuthorizerOutput, error) { if params == nil { diff --git a/service/iot/api_op_TransferCertificate.go b/service/iot/api_op_TransferCertificate.go index 87186e5a505..05d54796721 100644 --- a/service/iot/api_op_TransferCertificate.go +++ b/service/iot/api_op_TransferCertificate.go @@ -11,8 +11,7 @@ import ( ) // Transfers the specified certificate to the specified Amazon Web Services -// account. Requires permission to access the TransferCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// account. Requires permission to access the TransferCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. You can cancel the transfer until it is acknowledged by the recipient. // No notification is sent to the transfer destination's account. It is up to the // caller to notify the transfer target. The certificate being transferred must not diff --git a/service/iot/api_op_UntagResource.go b/service/iot/api_op_UntagResource.go index 184b5b376da..9703af1f5e7 100644 --- a/service/iot/api_op_UntagResource.go +++ b/service/iot/api_op_UntagResource.go @@ -11,8 +11,7 @@ import ( ) // Removes the given tags (metadata) from the resource. Requires permission to -// access the UntagResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the UntagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateAccountAuditConfiguration.go b/service/iot/api_op_UpdateAccountAuditConfiguration.go index dd468465c32..42c6ab7e9b8 100644 --- a/service/iot/api_op_UpdateAccountAuditConfiguration.go +++ b/service/iot/api_op_UpdateAccountAuditConfiguration.go @@ -14,8 +14,7 @@ import ( // Configures or reconfigures the Device Defender audit settings for this account. // Settings include how audit notifications are sent and which audit checks are // enabled or disabled. Requires permission to access the -// UpdateAccountAuditConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateAccountAuditConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateAccountAuditConfiguration(ctx context.Context, params *UpdateAccountAuditConfigurationInput, optFns ...func(*Options)) (*UpdateAccountAuditConfigurationOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type UpdateAccountAuditConfigurationInput struct { // in relation to the check is deleted. You cannot disable a check if it's used by // any scheduled audit. You must first delete the check from the scheduled audit or // delete the scheduled audit itself. On the first call to - // UpdateAccountAuditConfiguration, this parameter is required and must specify at + // UpdateAccountAuditConfiguration , this parameter is required and must specify at // least one enabled check. AuditCheckConfigurations map[string]types.AuditCheckConfiguration diff --git a/service/iot/api_op_UpdateAuthorizer.go b/service/iot/api_op_UpdateAuthorizer.go index f27b39c3e4e..800ef1c3aad 100644 --- a/service/iot/api_op_UpdateAuthorizer.go +++ b/service/iot/api_op_UpdateAuthorizer.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an authorizer. Requires permission to access the UpdateAuthorizer -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Updates an authorizer. Requires permission to access the UpdateAuthorizer (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type UpdateAuthorizerInput struct { // The ARN of the authorizer's Lambda function. AuthorizerFunctionArn *string - // When true, the result from the authorizer’s Lambda function is cached for the - // time specified in refreshAfterInSeconds. The cached result is used while the + // When true , the result from the authorizer’s Lambda function is cached for the + // time specified in refreshAfterInSeconds . The cached result is used while the // device reuses the same HTTP connection. EnableCachingForHttp *bool diff --git a/service/iot/api_op_UpdateBillingGroup.go b/service/iot/api_op_UpdateBillingGroup.go index 8b37b8f4b6f..464b6362c48 100644 --- a/service/iot/api_op_UpdateBillingGroup.go +++ b/service/iot/api_op_UpdateBillingGroup.go @@ -12,8 +12,7 @@ import ( ) // Updates information about the billing group. Requires permission to access the -// UpdateBillingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateBillingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateBillingGroup(ctx context.Context, params *UpdateBillingGroupInput, optFns ...func(*Options)) (*UpdateBillingGroupOutput, error) { if params == nil { @@ -44,7 +43,7 @@ type UpdateBillingGroupInput struct { // The expected version of the billing group. If the version of the billing group // does not match the expected version specified in the request, the - // UpdateBillingGroup request is rejected with a VersionConflictException. + // UpdateBillingGroup request is rejected with a VersionConflictException . ExpectedVersion *int64 noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdateCACertificate.go b/service/iot/api_op_UpdateCACertificate.go index c2bf7be8070..73da3a25039 100644 --- a/service/iot/api_op_UpdateCACertificate.go +++ b/service/iot/api_op_UpdateCACertificate.go @@ -12,8 +12,7 @@ import ( ) // Updates a registered CA certificate. Requires permission to access the -// UpdateCACertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateCACertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateCACertificate(ctx context.Context, params *UpdateCACertificateInput, optFns ...func(*Options)) (*UpdateCACertificateOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateCertificate.go b/service/iot/api_op_UpdateCertificate.go index 37963ac6d95..74880e934de 100644 --- a/service/iot/api_op_UpdateCertificate.go +++ b/service/iot/api_op_UpdateCertificate.go @@ -12,8 +12,7 @@ import ( ) // Updates the status of the specified certificate. This operation is idempotent. -// Requires permission to access the UpdateCertificate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the UpdateCertificate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. Certificates must be in the ACTIVE state to authenticate devices that // use a certificate to connect to IoT. Within a few minutes of updating a // certificate from the ACTIVE state to any other state, IoT disconnects all diff --git a/service/iot/api_op_UpdateCustomMetric.go b/service/iot/api_op_UpdateCustomMetric.go index 1f43962ab56..4ca1842bd8a 100644 --- a/service/iot/api_op_UpdateCustomMetric.go +++ b/service/iot/api_op_UpdateCustomMetric.go @@ -13,8 +13,7 @@ import ( ) // Updates a Device Defender detect custom metric. Requires permission to access -// the UpdateCustomMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the UpdateCustomMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateCustomMetric(ctx context.Context, params *UpdateCustomMetricInput, optFns ...func(*Options)) (*UpdateCustomMetricOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateDimension.go b/service/iot/api_op_UpdateDimension.go index 36cf4586891..5c8d2506013 100644 --- a/service/iot/api_op_UpdateDimension.go +++ b/service/iot/api_op_UpdateDimension.go @@ -14,8 +14,7 @@ import ( // Updates the definition for a dimension. You cannot change the type of a // dimension after it is created (you can delete it and recreate it). Requires -// permission to access the UpdateDimension -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the UpdateDimension (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateDimension(ctx context.Context, params *UpdateDimensionInput, optFns ...func(*Options)) (*UpdateDimensionOutput, error) { if params == nil { @@ -55,8 +54,8 @@ type UpdateDimensionOutput struct { // The Amazon Resource Name (ARN)of the created dimension. Arn *string - // The date and time, in milliseconds since epoch, when the dimension was initially - // created. + // The date and time, in milliseconds since epoch, when the dimension was + // initially created. CreationDate *time.Time // The date and time, in milliseconds since epoch, when the dimension was most diff --git a/service/iot/api_op_UpdateDomainConfiguration.go b/service/iot/api_op_UpdateDomainConfiguration.go index 4f5182b873e..94cab5fe661 100644 --- a/service/iot/api_op_UpdateDomainConfiguration.go +++ b/service/iot/api_op_UpdateDomainConfiguration.go @@ -13,8 +13,7 @@ import ( // Updates values stored in the domain configuration. Domain configurations for // default endpoints can't be updated. Requires permission to access the -// UpdateDomainConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateDomainConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateDomainConfiguration(ctx context.Context, params *UpdateDomainConfigurationInput, optFns ...func(*Options)) (*UpdateDomainConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateDynamicThingGroup.go b/service/iot/api_op_UpdateDynamicThingGroup.go index 9e3ef9879dd..54b3f3ac71b 100644 --- a/service/iot/api_op_UpdateDynamicThingGroup.go +++ b/service/iot/api_op_UpdateDynamicThingGroup.go @@ -12,8 +12,7 @@ import ( ) // Updates a dynamic thing group. Requires permission to access the -// UpdateDynamicThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateDynamicThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateDynamicThingGroup(ctx context.Context, params *UpdateDynamicThingGroupInput, optFns ...func(*Options)) (*UpdateDynamicThingGroupOutput, error) { if params == nil { @@ -46,7 +45,7 @@ type UpdateDynamicThingGroupInput struct { ExpectedVersion *int64 // The dynamic thing group index to update. Currently one index is supported: - // AWS_Things. + // AWS_Things . IndexName *string // The dynamic thing group search query string to update. diff --git a/service/iot/api_op_UpdateEventConfigurations.go b/service/iot/api_op_UpdateEventConfigurations.go index ca05daccb74..64f5ed350ad 100644 --- a/service/iot/api_op_UpdateEventConfigurations.go +++ b/service/iot/api_op_UpdateEventConfigurations.go @@ -12,8 +12,7 @@ import ( ) // Updates the event configurations. Requires permission to access the -// UpdateEventConfigurations -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateEventConfigurations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateEventConfigurations(ctx context.Context, params *UpdateEventConfigurationsInput, optFns ...func(*Options)) (*UpdateEventConfigurationsOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateFleetMetric.go b/service/iot/api_op_UpdateFleetMetric.go index c8ea80aea8a..b8bc7469ba0 100644 --- a/service/iot/api_op_UpdateFleetMetric.go +++ b/service/iot/api_op_UpdateFleetMetric.go @@ -12,8 +12,7 @@ import ( ) // Updates the data for a fleet metric. Requires permission to access the -// UpdateFleetMetric -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateFleetMetric (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateFleetMetric(ctx context.Context, params *UpdateFleetMetricInput, optFns ...func(*Options)) (*UpdateFleetMetricOutput, error) { if params == nil { @@ -65,8 +64,8 @@ type UpdateFleetMetricInput struct { QueryVersion *string // Used to support unit transformation such as milliseconds to seconds. The unit - // must be supported by CW metric - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html). + // must be supported by CW metric (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) + // . Unit types.FleetMetricUnit noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdateIndexingConfiguration.go b/service/iot/api_op_UpdateIndexingConfiguration.go index d3d67506b7f..04e6e52685f 100644 --- a/service/iot/api_op_UpdateIndexingConfiguration.go +++ b/service/iot/api_op_UpdateIndexingConfiguration.go @@ -12,8 +12,7 @@ import ( ) // Updates the search configuration. Requires permission to access the -// UpdateIndexingConfiguration -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateIndexingConfiguration(ctx context.Context, params *UpdateIndexingConfigurationInput, optFns ...func(*Options)) (*UpdateIndexingConfigurationOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateJob.go b/service/iot/api_op_UpdateJob.go index 539ef32497b..31cb7805c1f 100644 --- a/service/iot/api_op_UpdateJob.go +++ b/service/iot/api_op_UpdateJob.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates supported fields of the specified job. Requires permission to access the -// UpdateJob -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Updates supported fields of the specified job. Requires permission to access +// the UpdateJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns ...func(*Options)) (*UpdateJobOutput, error) { if params == nil { @@ -59,10 +58,10 @@ type UpdateJobInput struct { // Configuration information for pre-signed S3 URLs. PresignedUrlConfig *types.PresignedUrlConfig - // Specifies the amount of time each device has to finish its execution of the job. - // The timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the time - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. The timer is started when the job execution status is set to IN_PROGRESS . + // If the job execution status is not set to another terminal state before the time + // expires, it will be automatically set to TIMED_OUT . TimeoutConfig *types.TimeoutConfig noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdateMitigationAction.go b/service/iot/api_op_UpdateMitigationAction.go index b341e82764f..85e8dc97f63 100644 --- a/service/iot/api_op_UpdateMitigationAction.go +++ b/service/iot/api_op_UpdateMitigationAction.go @@ -12,8 +12,7 @@ import ( ) // Updates the definition for the specified mitigation action. Requires permission -// to access the UpdateMitigationAction -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the UpdateMitigationAction (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateMitigationAction(ctx context.Context, params *UpdateMitigationActionInput, optFns ...func(*Options)) (*UpdateMitigationActionOutput, error) { if params == nil { @@ -32,9 +31,9 @@ func (c *Client) UpdateMitigationAction(ctx context.Context, params *UpdateMitig type UpdateMitigationActionInput struct { - // The friendly name for the mitigation action. You cannot change the name by using - // UpdateMitigationAction. Instead, you must delete and recreate the mitigation - // action with the new name. + // The friendly name for the mitigation action. You cannot change the name by + // using UpdateMitigationAction . Instead, you must delete and recreate the + // mitigation action with the new name. // // This member is required. ActionName *string diff --git a/service/iot/api_op_UpdateProvisioningTemplate.go b/service/iot/api_op_UpdateProvisioningTemplate.go index 71322cba519..77673682c64 100644 --- a/service/iot/api_op_UpdateProvisioningTemplate.go +++ b/service/iot/api_op_UpdateProvisioningTemplate.go @@ -12,8 +12,7 @@ import ( ) // Updates a provisioning template. Requires permission to access the -// UpdateProvisioningTemplate -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateProvisioningTemplate (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateProvisioningTemplate(ctx context.Context, params *UpdateProvisioningTemplateInput, optFns ...func(*Options)) (*UpdateProvisioningTemplateOutput, error) { if params == nil { @@ -47,9 +46,9 @@ type UpdateProvisioningTemplateInput struct { Enabled bool // Updates the pre-provisioning hook template. Only supports template of type - // FLEET_PROVISIONING. For more information about provisioning template types, see - // type - // (https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type). + // FLEET_PROVISIONING . For more information about provisioning template types, see + // type (https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type) + // . PreProvisioningHook *types.ProvisioningHook // The ARN of the role associated with the provisioning template. This IoT role diff --git a/service/iot/api_op_UpdateRoleAlias.go b/service/iot/api_op_UpdateRoleAlias.go index 197c314c8f5..a6419e81027 100644 --- a/service/iot/api_op_UpdateRoleAlias.go +++ b/service/iot/api_op_UpdateRoleAlias.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a role alias. Requires permission to access the UpdateRoleAlias -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Updates a role alias. Requires permission to access the UpdateRoleAlias (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateRoleAlias(ctx context.Context, params *UpdateRoleAliasInput, optFns ...func(*Options)) (*UpdateRoleAliasOutput, error) { if params == nil { @@ -35,9 +34,9 @@ type UpdateRoleAliasInput struct { // This member is required. RoleAlias *string - // The number of seconds the credential will be valid. This value must be less than - // or equal to the maximum session duration of the IAM role that the role alias - // references. + // The number of seconds the credential will be valid. This value must be less + // than or equal to the maximum session duration of the IAM role that the role + // alias references. CredentialDurationSeconds *int32 // The role ARN. diff --git a/service/iot/api_op_UpdateScheduledAudit.go b/service/iot/api_op_UpdateScheduledAudit.go index 54eb7e247f8..40fc7203eb4 100644 --- a/service/iot/api_op_UpdateScheduledAudit.go +++ b/service/iot/api_op_UpdateScheduledAudit.go @@ -12,8 +12,7 @@ import ( ) // Updates a scheduled audit, including which checks are performed and how often -// the audit takes place. Requires permission to access the UpdateScheduledAudit -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the audit takes place. Requires permission to access the UpdateScheduledAudit (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateScheduledAudit(ctx context.Context, params *UpdateScheduledAuditInput, optFns ...func(*Options)) (*UpdateScheduledAuditOutput, error) { if params == nil { @@ -38,18 +37,18 @@ type UpdateScheduledAuditInput struct { ScheduledAuditName *string // The day of the month on which the scheduled audit takes place. This can be 1 - // through 31 or LAST. This field is required if the frequency parameter is set to - // MONTHLY. If days 29-31 are specified, and the month does not have that many + // through 31 or LAST . This field is required if the frequency parameter is set + // to MONTHLY . If days 29-31 are specified, and the month does not have that many // days, the audit takes place on the "LAST" day of the month. DayOfMonth *string - // The day of the week on which the scheduled audit takes place. This can be one of - // SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" - // parameter is set to WEEKLY or BIWEEKLY. + // The day of the week on which the scheduled audit takes place. This can be one + // of SUN , MON , TUE , WED , THU , FRI , or SAT . This field is required if the + // "frequency" parameter is set to WEEKLY or BIWEEKLY . DayOfWeek types.DayOfWeek - // How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or - // MONTHLY. The start time of each audit is determined by the system. + // How often the scheduled audit takes place, either DAILY , WEEKLY , BIWEEKLY , or + // MONTHLY . The start time of each audit is determined by the system. Frequency types.AuditFrequency // Which checks are performed during the scheduled audit. Checks must be enabled diff --git a/service/iot/api_op_UpdateSecurityProfile.go b/service/iot/api_op_UpdateSecurityProfile.go index 40ffab5c4ce..afe7bbe43ea 100644 --- a/service/iot/api_op_UpdateSecurityProfile.go +++ b/service/iot/api_op_UpdateSecurityProfile.go @@ -13,8 +13,7 @@ import ( ) // Updates a Device Defender security profile. Requires permission to access the -// UpdateSecurityProfile -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateSecurityProfile (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecurityProfileInput, optFns ...func(*Options)) (*UpdateSecurityProfileOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type UpdateSecurityProfileInput struct { // Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead. A // list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the profile's behaviors, but it is also retained for any + // for any metric used in the profile's behaviors , but it is also retained for any // metric specified here. Can be used with custom metrics; cannot be used with // dimensions. // @@ -59,9 +58,9 @@ type UpdateSecurityProfileInput struct { // Specifies the behaviors that, when violated by a device (thing), cause an alert. Behaviors []types.Behavior - // If true, delete all additionalMetricsToRetain defined for this security profile. - // If any additionalMetricsToRetain are defined in the current invocation, an - // exception occurs. + // If true, delete all additionalMetricsToRetain defined for this security + // profile. If any additionalMetricsToRetain are defined in the current + // invocation, an exception occurs. DeleteAdditionalMetricsToRetain bool // If true, delete all alertTargets defined for this security profile. If any @@ -87,8 +86,8 @@ type UpdateSecurityProfileOutput struct { // Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead. A // list of metrics whose data is retained (stored). By default, data is retained - // for any metric used in the security profile's behaviors, but it is also retained - // for any metric specified here. + // for any metric used in the security profile's behaviors , but it is also + // retained for any metric specified here. // // Deprecated: Use additionalMetricsToRetainV2. AdditionalMetricsToRetain []string diff --git a/service/iot/api_op_UpdateStream.go b/service/iot/api_op_UpdateStream.go index 249c6483115..5f5a98f722b 100644 --- a/service/iot/api_op_UpdateStream.go +++ b/service/iot/api_op_UpdateStream.go @@ -12,8 +12,7 @@ import ( ) // Updates an existing stream. The stream version will be incremented by one. -// Requires permission to access the UpdateStream -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Requires permission to access the UpdateStream (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, optFns ...func(*Options)) (*UpdateStreamOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateThing.go b/service/iot/api_op_UpdateThing.go index ddde03dd18b..dd88512787f 100644 --- a/service/iot/api_op_UpdateThing.go +++ b/service/iot/api_op_UpdateThing.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the data for a thing. Requires permission to access the UpdateThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Updates the data for a thing. Requires permission to access the UpdateThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateThing(ctx context.Context, params *UpdateThingInput, optFns ...func(*Options)) (*UpdateThingOutput, error) { if params == nil { @@ -46,7 +45,7 @@ type UpdateThingInput struct { // The expected version of the thing record in the registry. If the version of the // record in the registry does not match the expected version specified in the - // request, the UpdateThing request is rejected with a VersionConflictException. + // request, the UpdateThing request is rejected with a VersionConflictException . ExpectedVersion *int64 // Remove a thing type association. If true, the association is removed. diff --git a/service/iot/api_op_UpdateThingGroup.go b/service/iot/api_op_UpdateThingGroup.go index 55dee0665f1..626dc2e3990 100644 --- a/service/iot/api_op_UpdateThingGroup.go +++ b/service/iot/api_op_UpdateThingGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a thing group. Requires permission to access the UpdateThingGroup -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Update a thing group. Requires permission to access the UpdateThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateThingGroup(ctx context.Context, params *UpdateThingGroupInput, optFns ...func(*Options)) (*UpdateThingGroupOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateThingGroupsForThing.go b/service/iot/api_op_UpdateThingGroupsForThing.go index 5195e165a23..f1326c7c2f0 100644 --- a/service/iot/api_op_UpdateThingGroupsForThing.go +++ b/service/iot/api_op_UpdateThingGroupsForThing.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the groups to which the thing belongs. Requires permission to access the -// UpdateThingGroupsForThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Updates the groups to which the thing belongs. Requires permission to access +// the UpdateThingGroupsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateThingGroupsForThing(ctx context.Context, params *UpdateThingGroupsForThingInput, optFns ...func(*Options)) (*UpdateThingGroupsForThingOutput, error) { if params == nil { diff --git a/service/iot/api_op_UpdateTopicRuleDestination.go b/service/iot/api_op_UpdateTopicRuleDestination.go index cf8f95421d4..56d1edabb0d 100644 --- a/service/iot/api_op_UpdateTopicRuleDestination.go +++ b/service/iot/api_op_UpdateTopicRuleDestination.go @@ -13,8 +13,7 @@ import ( // Updates a topic rule destination. You use this to change the status, endpoint // URL, or confirmation URL of the destination. Requires permission to access the -// UpdateTopicRuleDestination -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateTopicRuleDestination (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateTopicRuleDestination(ctx context.Context, params *UpdateTopicRuleDestinationInput, optFns ...func(*Options)) (*UpdateTopicRuleDestinationOutput, error) { if params == nil { @@ -40,16 +39,16 @@ type UpdateTopicRuleDestinationInput struct { // The status of the topic rule destination. Valid values are: IN_PROGRESS A topic // rule destination was created but has not been confirmed. You can set status to - // IN_PROGRESS by calling UpdateTopicRuleDestination. Calling + // IN_PROGRESS by calling UpdateTopicRuleDestination . Calling // UpdateTopicRuleDestination causes a new confirmation challenge to be sent to // your confirmation endpoint. ENABLED Confirmation was completed, and traffic to // this destination is allowed. You can set status to DISABLED by calling - // UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to + // UpdateTopicRuleDestination . DISABLED Confirmation was completed, and traffic to // this destination is not allowed. You can set status to ENABLED by calling - // UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for + // UpdateTopicRuleDestination . ERROR Confirmation could not be completed, for // example if the confirmation timed out. You can call GetTopicRuleDestination for // details about the error. You can set status to IN_PROGRESS by calling - // UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new + // UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new // confirmation challenge to be sent to your confirmation endpoint. // // This member is required. diff --git a/service/iot/api_op_ValidateSecurityProfileBehaviors.go b/service/iot/api_op_ValidateSecurityProfileBehaviors.go index ba28f12e79f..6cb43a3a51e 100644 --- a/service/iot/api_op_ValidateSecurityProfileBehaviors.go +++ b/service/iot/api_op_ValidateSecurityProfileBehaviors.go @@ -12,8 +12,7 @@ import ( ) // Validates a Device Defender security profile behaviors specification. Requires -// permission to access the ValidateSecurityProfileBehaviors -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ValidateSecurityProfileBehaviors (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ValidateSecurityProfileBehaviors(ctx context.Context, params *ValidateSecurityProfileBehaviorsInput, optFns ...func(*Options)) (*ValidateSecurityProfileBehaviorsOutput, error) { if params == nil { diff --git a/service/iot/doc.go b/service/iot/doc.go index bab9167f6d4..caebd2104d8 100644 --- a/service/iot/doc.go +++ b/service/iot/doc.go @@ -3,22 +3,19 @@ // Package iot provides the API client, operations, and parameter types for AWS // IoT. // -// IoT IoT provides secure, bi-directional communication between Internet-connected -// devices (such as sensors, actuators, embedded devices, or smart appliances) and -// the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to -// communicate with, configure rules for data processing and integration with other -// services, organize resources associated with each device (Registry), configure -// logging, and create and manage policies and credentials to authenticate devices. -// The service endpoints that expose this API are listed in Amazon Web Services IoT -// Core Endpoints and Quotas -// (https://docs.aws.amazon.com/general/latest/gr/iot-core.html). You must use the -// endpoint for the region that has the resources you want to access. The service -// name used by Amazon Web Services Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to sign -// the request is: execute-api. For more information about how IoT works, see the -// Developer Guide -// (https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html). -// For information about how to use the credentials provider for IoT, see -// Authorizing Direct Calls to Amazon Web Services Services -// (https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html). +// IoT IoT provides secure, bi-directional communication between +// Internet-connected devices (such as sensors, actuators, embedded devices, or +// smart appliances) and the Amazon Web Services cloud. You can discover your +// custom IoT-Data endpoint to communicate with, configure rules for data +// processing and integration with other services, organize resources associated +// with each device (Registry), configure logging, and create and manage policies +// and credentials to authenticate devices. The service endpoints that expose this +// API are listed in Amazon Web Services IoT Core Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/iot-core.html) +// . You must use the endpoint for the region that has the resources you want to +// access. The service name used by Amazon Web Services Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// to sign the request is: execute-api. For more information about how IoT works, +// see the Developer Guide (https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html) +// . For information about how to use the credentials provider for IoT, see +// Authorizing Direct Calls to Amazon Web Services Services (https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html) +// . package iot diff --git a/service/iot/types/enums.go b/service/iot/types/enums.go index 7bb7ef5085e..b28dc5678bc 100644 --- a/service/iot/types/enums.go +++ b/service/iot/types/enums.go @@ -203,8 +203,8 @@ const ( AuditNotificationTypeSns AuditNotificationType = "SNS" ) -// Values returns all known values for AuditNotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AuditNotificationType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AuditNotificationType) Values() []AuditNotificationType { return []AuditNotificationType{ @@ -261,9 +261,9 @@ const ( AuthDecisionImplicitDeny AuthDecision = "IMPLICIT_DENY" ) -// Values returns all known values for AuthDecision. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AuthDecision. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AuthDecision) Values() []AuthDecision { return []AuthDecision{ "ALLOWED", @@ -565,9 +565,9 @@ const ( DayOfWeekSat DayOfWeek = "SAT" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "SUN", @@ -613,8 +613,8 @@ const ( DetectMitigationActionsTaskStatusCanceled DetectMitigationActionsTaskStatus = "CANCELED" ) -// Values returns all known values for DetectMitigationActionsTaskStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DetectMitigationActionsTaskStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DetectMitigationActionsTaskStatus) Values() []DetectMitigationActionsTaskStatus { @@ -788,9 +788,9 @@ const ( EventTypeCaCertificate EventType = "CA_CERTIFICATE" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "THING", @@ -816,9 +816,9 @@ const ( FieldTypeBoolean FieldType = "Boolean" ) -// Values returns all known values for FieldType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FieldType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FieldType) Values() []FieldType { return []FieldType{ "Number", @@ -998,9 +998,9 @@ const ( JobStatusScheduled JobStatus = "SCHEDULED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "IN_PROGRESS", @@ -1230,9 +1230,9 @@ const ( ResourceTypeIssuerCertificate ResourceType = "ISSUER_CERTIFICATE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "DEVICE_CERTIFICATE", @@ -1355,9 +1355,9 @@ const ( TemplateTypeJitp TemplateType = "JITP" ) -// Values returns all known values for TemplateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TemplateType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TemplateType) Values() []TemplateType { return []TemplateType{ "FLEET_PROVISIONING", diff --git a/service/iot/types/errors.go b/service/iot/types/errors.go index d50a40174e7..67434fae3c8 100644 --- a/service/iot/types/errors.go +++ b/service/iot/types/errors.go @@ -377,8 +377,9 @@ func (e *InvalidResponseException) ErrorCode() string { } func (e *InvalidResponseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An attempt was made to change to an invalid state, for example by deleting a job -// or a job execution which is "IN_PROGRESS" without setting the force parameter. +// An attempt was made to change to an invalid state, for example by deleting a +// job or a job execution which is "IN_PROGRESS" without setting the force +// parameter. type InvalidStateTransitionException struct { Message *string @@ -645,8 +646,8 @@ func (e *SqlParseException) ErrorCode() string { } func (e *SqlParseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception occurs if you attempt to start a task with the same task-id as an -// existing task but with a different clientRequestToken. +// This exception occurs if you attempt to start a task with the same task-id as +// an existing task but with a different clientRequestToken. type TaskAlreadyExistsException struct { Message *string diff --git a/service/iot/types/types.go b/service/iot/types/types.go index 2bff85165e2..be3ebbe8d3e 100644 --- a/service/iot/types/types.go +++ b/service/iot/types/types.go @@ -37,8 +37,8 @@ type AbortCriteria struct { // This member is required. MinNumberOfExecutedThings *int32 - // The minimum percentage of job execution failures that must occur to initiate the - // job abort. Amazon Web Services IoT Core supports up to two digits after the + // The minimum percentage of job execution failures that must occur to initiate + // the job abort. Amazon Web Services IoT Core supports up to two digits after the // decimal (for example, 10.9 and 10.99, but not 10.999). // // This member is required. @@ -70,8 +70,8 @@ type Action struct { // Write data to an Amazon OpenSearch Service domain. The Elasticsearch action can // only be used by existing rule actions. To create a new rule action or to update // an existing rule action, use the OpenSearch rule action instead. For more - // information, see OpenSearchAction - // (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html). + // information, see OpenSearchAction (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html) + // . Elasticsearch *ElasticsearchAction // Write to an Amazon Kinesis Firehose stream. @@ -126,8 +126,7 @@ type Action struct { StepFunctions *StepFunctionsAction // The Timestream rule action writes attributes (measures) from an MQTT message - // into an Amazon Timestream table. For more information, see the Timestream - // (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) + // into an Amazon Timestream table. For more information, see the Timestream (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) // topic rule action documentation. Timestream *TimestreamAction @@ -170,8 +169,8 @@ type ActiveViolation struct { noSmithyDocumentSerde } -// Parameters used when defining a mitigation action that move a set of things to a -// thing group. +// Parameters used when defining a mitigation action that move a set of things to +// a thing group. type AddThingsToThingGroupParams struct { // The list of groups to which you want to add the things that triggered the @@ -258,8 +257,8 @@ type AssetPropertyValue struct { // This member is required. Value AssetPropertyVariant - // Optional. A string that describes the quality of the value. Accepts substitution - // templates. Must be GOOD, BAD, or UNCERTAIN. + // Optional. A string that describes the quality of the value. Accepts + // substitution templates. Must be GOOD , BAD , or UNCERTAIN . Quality *string noSmithyDocumentSerde @@ -277,8 +276,8 @@ type AssetPropertyVariant interface { isAssetPropertyVariant() } -// Optional. A string that contains the boolean value (true or false) of the value -// entry. Accepts substitution templates. +// Optional. A string that contains the boolean value ( true or false ) of the +// value entry. Accepts substitution templates. type AssetPropertyVariantMemberBooleanValue struct { Value string @@ -319,14 +318,14 @@ func (*AssetPropertyVariantMemberStringValue) isAssetPropertyVariant() {} // The attribute payload. type AttributePayload struct { - // A JSON string containing up to three key-value pair in JSON format. For example: - // {\"attributes\":{\"string1\":\"string2\"}} + // A JSON string containing up to three key-value pair in JSON format. For + // example: {\"attributes\":{\"string1\":\"string2\"}} Attributes map[string]string // Specifies whether the list of attributes provided in the AttributePayload is // merged with the attributes stored in the registry, instead of overwriting them. // To remove an attribute, call UpdateThing with an empty attribute value. The - // merge attribute is only valid when calling UpdateThing or UpdateThingGroup. + // merge attribute is only valid when calling UpdateThing or UpdateThingGroup . Merge bool noSmithyDocumentSerde @@ -450,7 +449,7 @@ type AuditMitigationActionExecutionMetadata struct { } // Information about an audit mitigation actions task that is returned by -// ListAuditMitigationActionsTasks. +// ListAuditMitigationActionsTasks . type AuditMitigationActionsTaskMetadata struct { // The time at which the audit mitigation actions task was started. @@ -588,8 +587,8 @@ type AuthorizerDescription struct { // The UNIX timestamp of when the authorizer was created. CreationDate *time.Time - // When true, the result from the authorizer’s Lambda function is cached for the - // time specified in refreshAfterInSeconds. The cached result is used while the + // When true , the result from the authorizer’s Lambda function is cached for the + // time specified in refreshAfterInSeconds . The cached result is used while the // device reuses the same HTTP connection. EnableCachingForHttp *bool @@ -630,8 +629,8 @@ type AuthResult struct { // The policies and statements that allowed the specified action. Allowed *Allowed - // The final authorization decision of this scenario. Multiple statements are taken - // into account when determining the authorization decision. An explicit deny + // The final authorization decision of this scenario. Multiple statements are + // taken into account when determining the authorization decision. An explicit deny // statement can override multiple allow statements. AuthDecision AuthDecision @@ -677,8 +676,8 @@ type AwsJobAbortCriteria struct { // This member is required. MinNumberOfExecutedThings *int32 - // The minimum percentage of job execution failures that must occur to initiate the - // job abort. Amazon Web Services IoT Core supports up to two digits after the + // The minimum percentage of job execution failures that must occur to initiate + // the job abort. Amazon Web Services IoT Core supports up to two digits after the // decimal (for example, 10.9 and 10.99, but not 10.999). // // This member is required. @@ -704,8 +703,9 @@ type AwsJobExecutionsRolloutConfig struct { // exponential rate increase for a job rollout. type AwsJobExponentialRolloutRate struct { - // The minimum number of things that will be notified of a pending job, per minute, - // at the start of the job rollout. This is the initial rate of the rollout. + // The minimum number of things that will be notified of a pending job, per + // minute, at the start of the job rollout. This is the initial rate of the + // rollout. // // This member is required. BaseRatePerMinute *int32 @@ -730,9 +730,9 @@ type AwsJobExponentialRolloutRate struct { // HTTP. type AwsJobPresignedUrlConfig struct { - // How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the - // default value is 1800 seconds. Pre-signed URLs are generated when a request for - // the job document is received. + // How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, + // the default value is 1800 seconds. Pre-signed URLs are generated when a request + // for the job document is received. ExpiresInSec *int64 noSmithyDocumentSerde @@ -752,16 +752,16 @@ type AwsJobRateIncreaseCriteria struct { noSmithyDocumentSerde } -// Specifies the amount of time each device has to finish its execution of the job. -// A timer is started when the job execution status is set to IN_PROGRESS. If the -// job execution status is not set to another terminal state before the timer -// expires, it will be automatically set to TIMED_OUT. +// Specifies the amount of time each device has to finish its execution of the +// job. A timer is started when the job execution status is set to IN_PROGRESS . If +// the job execution status is not set to another terminal state before the timer +// expires, it will be automatically set to TIMED_OUT . type AwsJobTimeoutConfig struct { - // Specifies the amount of time, in minutes, this device has to finish execution of - // this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to - // 10080 minutes). The in progress timer can't be updated and will apply to all job - // executions for the job. Whenever a job execution remains in the IN_PROGRESS + // Specifies the amount of time, in minutes, this device has to finish execution + // of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 + // to 10080 minutes). The in progress timer can't be updated and will apply to all + // job executions for the job. Whenever a job execution remains in the IN_PROGRESS // status for longer than this interval, the job execution will fail and switch to // the terminal TIMED_OUT status. InProgressTimeoutInMinutes *int64 @@ -778,7 +778,7 @@ type Behavior struct { Name *string // The criteria that determine if a device is behaving normally in regard to the - // metric. + // metric . Criteria *BehaviorCriteria // What is measured by the behavior. @@ -799,19 +799,13 @@ type Behavior struct { // The criteria by which the behavior is determined to be normal. type BehaviorCriteria struct { - // The operator that relates the thing measured (metric) to the criteria - // (containing a value or statisticalThreshold). Valid operators include: - // - // * - // string-list: in-set and not-in-set - // - // * number-list: in-set and not-in-set - // - // * - // ip-address-list: in-cidr-set and not-in-cidr-set - // - // * number: less-than, - // less-than-equals, greater-than, and greater-than-equals + // The operator that relates the thing measured ( metric ) to the criteria + // (containing a value or statisticalThreshold ). Valid operators include: + // - string-list : in-set and not-in-set + // - number-list : in-set and not-in-set + // - ip-address-list : in-cidr-set and not-in-cidr-set + // - number : less-than , less-than-equals , greater-than , and + // greater-than-equals ComparisonOperator ComparisonOperator // If a device is in violation of the behavior for the specified number of @@ -824,7 +818,7 @@ type BehaviorCriteria struct { ConsecutiveDatapointsToClear *int32 // Use this to specify the time duration over which the behavior is evaluated, for - // those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For + // those criteria that have a time dimension (for example, NUM_MESSAGES_SENT ). For // a statisticalThreshhold metric comparison, measurements from all devices are // accumulated over this time duration before being used to calculate percentiles, // and later, measurements from an individual device are also accumulated over this @@ -839,7 +833,7 @@ type BehaviorCriteria struct { // behavior is determined to be in compliance or in violation of the behavior. StatisticalThreshold *StatisticalThreshold - // The value to be compared with the metric. + // The value to be compared with the metric . Value *MetricValue noSmithyDocumentSerde @@ -943,8 +937,8 @@ type CACertificateDescription struct { // The mode of the CA. All the device certificates that are registered using this // CA will be registered in the same mode as the CA. For more information about - // certificate mode for device certificates, see certificate mode - // (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode). + // certificate mode for device certificates, see certificate mode (https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) + // . CertificateMode CertificateMode // The CA certificate data, in PEM format. @@ -984,13 +978,13 @@ type Certificate struct { // certificate ID.) CertificateId *string - // The mode of the certificate. DEFAULT: A certificate in DEFAULT mode is either + // The mode of the certificate. DEFAULT : A certificate in DEFAULT mode is either // generated by Amazon Web Services IoT Core or registered with an issuer // certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT // mode aren't required to send the Server Name Indication (SNI) extension when // connecting to Amazon Web Services IoT Core. However, to use features such as // custom domains and VPC endpoints, we recommend that you use the SNI extension - // when connecting to Amazon Web Services IoT Core. SNI_ONLY: A certificate in + // when connecting to Amazon Web Services IoT Core. SNI_ONLY : A certificate in // SNI_ONLY mode is registered without an issuer CA. Devices with certificates in // SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services // IoT Core. @@ -1018,18 +1012,18 @@ type CertificateDescription struct { // The ID of the certificate. CertificateId *string - // The mode of the certificate. DEFAULT: A certificate in DEFAULT mode is either + // The mode of the certificate. DEFAULT : A certificate in DEFAULT mode is either // generated by Amazon Web Services IoT Core or registered with an issuer // certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT // mode aren't required to send the Server Name Indication (SNI) extension when // connecting to Amazon Web Services IoT Core. However, to use features such as // custom domains and VPC endpoints, we recommend that you use the SNI extension - // when connecting to Amazon Web Services IoT Core. SNI_ONLY: A certificate in + // when connecting to Amazon Web Services IoT Core. SNI_ONLY : A certificate in // SNI_ONLY mode is registered without an issuer CA. Devices with certificates in // SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services // IoT Core. For more information about the value for SNI extension, see Transport - // security in IoT - // (https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html). + // security in IoT (https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html) + // . CertificateMode CertificateMode // The certificate data, in PEM format. @@ -1138,8 +1132,7 @@ type CloudwatchMetricAction struct { // This member is required. MetricNamespace *string - // The metric unit - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) + // The metric unit (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) // supported by CloudWatch. // // This member is required. @@ -1155,8 +1148,8 @@ type CloudwatchMetricAction struct { // This member is required. RoleArn *string - // An optional Unix timestamp - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp). + // An optional Unix timestamp (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) + // . MetricTimestamp *string noSmithyDocumentSerde @@ -1216,7 +1209,7 @@ type CustomCodeSigning struct { // The hash algorithm used to code sign the file. You can use a string as the // algorithm name if the target over-the-air (OTA) update devices are able to // verify the signature that was generated using the same signature algorithm. For - // example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on + // example, FreeRTOS uses SHA256 or SHA1 , so you can pass either of them based on // which was used for generating the signature. HashAlgorithm *string @@ -1226,7 +1219,7 @@ type CustomCodeSigning struct { // The signature algorithm used to code sign the file. You can use a string as the // algorithm name if the target over-the-air (OTA) update devices are able to // verify the signature that was generated using the same signature algorithm. For - // example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on + // example, FreeRTOS uses ECDSA or RSA , so you can pass either of them based on // which was used for generating the signature. SignatureAlgorithm *string @@ -1363,12 +1356,12 @@ type DetectMitigationActionsTaskTarget struct { // create jobs from them. type DocumentParameter struct { - // Description of the map field containing the patterns that need to be replaced in - // a managed template job document schema. + // Description of the map field containing the patterns that need to be replaced + // in a managed template job document schema. Description *string - // An example illustrating a pattern that need to be replaced in a managed template - // job document schema. + // An example illustrating a pattern that need to be replaced in a managed + // template job document schema. Example *string // Key of the map field containing the patterns that need to be replaced in a @@ -1391,12 +1384,9 @@ type DocumentParameter struct { // associated with an Amazon Web Services-managed domain (for example, // dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a // default endpoint. -// -// * Data -// -// * Jobs -// -// * CredentialProvider +// - Data +// - Jobs +// - CredentialProvider type DomainConfigurationSummary struct { // The ARN of the domain configuration. @@ -1411,7 +1401,7 @@ type DomainConfigurationSummary struct { noSmithyDocumentSerde } -// Describes an action to write to a DynamoDB table. The tableName, hashKeyField, +// Describes an action to write to a DynamoDB table. The tableName , hashKeyField , // and rangeKeyField values must match the values used when you created the table. // The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. // These templates provide data at runtime. The syntax is as follows: @@ -1446,8 +1436,8 @@ type DynamoDBAction struct { HashKeyType DynamoKeyType // The type of operation to be performed. This follows the substitution template, - // so it can be ${operation}, but the substitution must result in one of the - // following: INSERT, UPDATE, or DELETE. + // so it can be ${operation} , but the substitution must result in one of the + // following: INSERT , UPDATE , or DELETE . Operation *string // The action payload. This name can be customized. @@ -1501,11 +1491,11 @@ type EffectivePolicy struct { noSmithyDocumentSerde } -// Describes an action that writes data to an Amazon OpenSearch Service domain. The -// Elasticsearch action can only be used by existing rule actions. To create a new -// rule action or to update an existing rule action, use the OpenSearch rule action -// instead. For more information, see OpenSearchAction -// (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html). +// Describes an action that writes data to an Amazon OpenSearch Service domain. +// The Elasticsearch action can only be used by existing rule actions. To create a +// new rule action or to update an existing rule action, use the OpenSearch rule +// action instead. For more information, see OpenSearchAction (https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html) +// . type ElasticsearchAction struct { // The endpoint of your OpenSearch domain. @@ -1637,11 +1627,10 @@ type FirehoseAction struct { RoleArn *string // Whether to deliver the Kinesis Data Firehose stream as a batch by using - // PutRecordBatch - // (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html). - // The default value is false. When batchMode is true and the rule's SQL statement - // evaluates to an Array, each Array element forms one record in the PutRecordBatch - // (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) + // PutRecordBatch (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) + // . The default value is false . When batchMode is true and the rule's SQL + // statement evaluates to an Array, each Array element forms one record in the + // PutRecordBatch (https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) // request. The resulting array can't have more than 500 records. BatchMode *bool @@ -1681,7 +1670,7 @@ type GroupNameAndArn struct { type HttpAction struct { // The endpoint URL. If substitution templates are used in the URL, you must also - // specify a confirmationUrl. If this is a new destination, a new + // specify a confirmationUrl . If this is a new destination, a new // TopicRuleDestination is created if possible. // // This member is required. @@ -1690,12 +1679,12 @@ type HttpAction struct { // The authentication method to use when sending data to an HTTPS endpoint. Auth *HttpAuthorization - // The URL to which IoT sends a confirmation message. The value of the confirmation - // URL must be a prefix of the endpoint URL. If you do not specify a confirmation - // URL IoT uses the endpoint URL as the confirmation URL. If you use substitution - // templates in the confirmationUrl, you must create and enable topic rule - // destinations that match each possible value of the substitution template before - // traffic is allowed to your endpoint URL. + // The URL to which IoT sends a confirmation message. The value of the + // confirmation URL must be a prefix of the endpoint URL. If you do not specify a + // confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use + // substitution templates in the confirmationUrl, you must create and enable topic + // rule destinations that match each possible value of the substitution template + // before traffic is allowed to your endpoint URL. ConfirmationUrl *string // The HTTP headers to send with the message data. @@ -1724,8 +1713,8 @@ type HttpActionHeader struct { type HttpAuthorization struct { // Use Sig V4 authorization. For more information, see Signature Version 4 Signing - // Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). + // Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . Sigv4 *SigV4Authorization noSmithyDocumentSerde @@ -1746,8 +1735,8 @@ type HttpContext struct { // HTTP URL destination configuration used by the topic rule's HTTP action. type HttpUrlDestinationConfiguration struct { - // The URL IoT uses to confirm ownership of or access to the topic rule destination - // URL. + // The URL IoT uses to confirm ownership of or access to the topic rule + // destination URL. // // This member is required. ConfirmationUrl *string @@ -1774,12 +1763,13 @@ type HttpUrlDestinationSummary struct { noSmithyDocumentSerde } -// Information that implicitly denies authorization. When policy doesn't explicitly -// deny or allow an action on a resource it is considered an implicit deny. +// Information that implicitly denies authorization. When policy doesn't +// explicitly deny or allow an action on a resource it is considered an implicit +// deny. type ImplicitDeny struct { - // Policies that don't contain a matching allow or deny statement for the specified - // action on the specified resource. + // Policies that don't contain a matching allow or deny statement for the + // specified action on the specified resource. Policies []Policy noSmithyDocumentSerde @@ -1788,13 +1778,12 @@ type ImplicitDeny struct { // Provides additional filters for specific data sources. Named shadow is the only // data source that currently supports and requires a filter. To add named shadows // to your fleet indexing configuration, set namedShadowIndexingMode to be ON and -// specify your shadow names in filter. +// specify your shadow names in filter . type IndexingFilter struct { // The shadow names that you select to index. The default maximum number of shadow // names for indexing is 10. To increase the limit, see Amazon Web Services IoT - // Device Management Quotas - // (https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits) + // Device Management Quotas (https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits) // in the Amazon Web Services General Reference. NamedShadowNames []string @@ -1804,10 +1793,9 @@ type IndexingFilter struct { // Sends message data to an IoT Analytics channel. type IotAnalyticsAction struct { - // Whether to process the action as a batch. The default value is false. When + // Whether to process the action as a batch. The default value is false . When // batchMode is true and the rule SQL statement evaluates to an Array, each Array - // element is delivered as a separate message when passed by BatchPutMessage - // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) + // element is delivered as a separate message when passed by BatchPutMessage (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) // to the IoT Analytics channel. The resulting array can't have more than 100 // messages. BatchMode *bool @@ -1834,22 +1822,21 @@ type IotEventsAction struct { // This member is required. InputName *string - // The ARN of the role that grants IoT permission to send an input to an IoT Events - // detector. ("Action":"iotevents:BatchPutMessage"). + // The ARN of the role that grants IoT permission to send an input to an IoT + // Events detector. ("Action":"iotevents:BatchPutMessage"). // // This member is required. RoleArn *string - // Whether to process the event actions as a batch. The default value is false. - // When batchMode is true, you can't specify a messageId. When batchMode is true + // Whether to process the event actions as a batch. The default value is false . + // When batchMode is true , you can't specify a messageId . When batchMode is true // and the rule SQL statement evaluates to an Array, each Array element is treated - // as a separate message when it's sent to IoT Events by calling BatchPutMessage - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html). - // The resulting array can't have more than 10 messages. + // as a separate message when it's sent to IoT Events by calling BatchPutMessage (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html) + // . The resulting array can't have more than 10 messages. BatchMode *bool // The ID of the message. The default messageId is a new UUID value. When batchMode - // is true, you can't specify a messageId--a new UUID value will be assigned. + // is true , you can't specify a messageId --a new UUID value will be assigned. // Assign a value to this property to ensure that only one input (message) with a // given messageId will be processed by an IoT Events detector. MessageId *string @@ -1857,8 +1844,8 @@ type IotEventsAction struct { noSmithyDocumentSerde } -// Describes an action to send data from an MQTT message that triggered the rule to -// IoT SiteWise asset properties. +// Describes an action to send data from an MQTT message that triggered the rule +// to IoT SiteWise asset properties. type IotSiteWiseAction struct { // A list of asset property value entries. @@ -1867,8 +1854,8 @@ type IotSiteWiseAction struct { PutAssetPropertyValueEntries []PutAssetPropertyValueEntry // The ARN of the role that grants IoT permission to send an asset property value - // to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust - // policy can restrict access to specific asset hierarchy paths. + // to IoT SiteWise. ( "Action": "iotsitewise:BatchPutAssetPropertyValue" ). The + // trust policy can restrict access to specific asset hierarchy paths. // // This member is required. RoleArn *string @@ -1918,7 +1905,7 @@ type Job struct { DocumentParameters map[string]string // Will be true if the job was canceled with the optional force parameter set to - // true. + // true . ForceCanceled *bool // Indicates whether a job is concurrent. Will be true when a job is rolling out @@ -1966,28 +1953,28 @@ type Job struct { // in addition to specifying the end behavior for each job execution. SchedulingConfig *SchedulingConfig - // The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or - // COMPLETED. + // The status of the job, one of IN_PROGRESS , CANCELED , DELETION_IN_PROGRESS or + // COMPLETED . Status JobStatus - // Specifies whether the job will continue to run (CONTINUOUS), or will be complete - // after all those things specified as targets have completed the job (SNAPSHOT). - // If continuous, the job may also be run on a thing when a change is detected in a - // target. For example, a job will run on a device when the thing representing the - // device is added to a target group, even after the job was completed by all - // things originally in the group. We recommend that you use continuous jobs - // instead of snapshot jobs for dynamic thing group targets. By using continuous - // jobs, devices that join the group receive the job execution even after the job - // has been created. + // Specifies whether the job will continue to run (CONTINUOUS), or will be + // complete after all those things specified as targets have completed the job + // (SNAPSHOT). If continuous, the job may also be run on a thing when a change is + // detected in a target. For example, a job will run on a device when the thing + // representing the device is added to a target group, even after the job was + // completed by all things originally in the group. We recommend that you use + // continuous jobs instead of snapshot jobs for dynamic thing group targets. By + // using continuous jobs, devices that join the group receive the job execution + // even after the job has been created. TargetSelection TargetSelection // A list of IoT things and thing groups to which the job should be sent. Targets []string - // Specifies the amount of time each device has to finish its execution of the job. - // A timer is started when the job execution status is set to IN_PROGRESS. If the - // job execution status is not set to another terminal state before the timer - // expires, it will be automatically set to TIMED_OUT. + // Specifies the amount of time each device has to finish its execution of the + // job. A timer is started when the job execution status is set to IN_PROGRESS . If + // the job execution status is not set to another terminal state before the timer + // expires, it will be automatically set to TIMED_OUT . TimeoutConfig *TimeoutConfig noSmithyDocumentSerde @@ -1997,11 +1984,11 @@ type Job struct { // device. type JobExecution struct { - // The estimated number of seconds that remain before the job execution status will - // be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute - // and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up - // to 60 seconds later than the estimated duration. This value will not be included - // if the job execution has reached a terminal status. + // The estimated number of seconds that remain before the job execution status + // will be changed to TIMED_OUT . The timeout interval can be anywhere between 1 + // minute and 7 days (1 to 10080 minutes). The actual job execution timeout can + // occur up to 60 seconds later than the estimated duration. This value will not be + // included if the job execution has reached a terminal status. ApproximateSecondsBeforeTimedOut *int64 // A string (consisting of the digits "0" through "9") which identifies this @@ -2009,8 +1996,8 @@ type JobExecution struct { // which return or update job execution information. ExecutionNumber *int64 - // Will be true if the job execution was canceled with the optional force parameter - // set to true. + // Will be true if the job execution was canceled with the optional force + // parameter set to true . ForceCanceled *bool // The unique identifier you assigned to the job when it was created. @@ -2062,8 +2049,8 @@ type JobExecutionsRolloutConfig struct { // exponential rate for a job rollout. ExponentialRate *ExponentialRolloutRate - // The maximum number of things that will be notified of a pending job, per minute. - // This parameter allows you to create a staged rollout. + // The maximum number of things that will be notified of a pending job, per + // minute. This parameter allows you to create a staged rollout. MaximumPerMinute *int32 noSmithyDocumentSerde @@ -2155,7 +2142,7 @@ type JobProcessDetails struct { // The number of things which successfully completed the job. NumberOfSucceededThings *int32 - // The number of things whose job execution status is TIMED_OUT. + // The number of things whose job execution status is TIMED_OUT . NumberOfTimedOutThings *int32 // The target devices to which the job execution is being rolled out. This value @@ -2191,14 +2178,15 @@ type JobSummary struct { // The job summary status. Status JobStatus - // Specifies whether the job will continue to run (CONTINUOUS), or will be complete - // after all those things specified as targets have completed the job (SNAPSHOT). - // If continuous, the job may also be run on a thing when a change is detected in a - // target. For example, a job will run on a thing when the thing is added to a - // target group, even after the job was completed by all things originally in the - // group. We recommend that you use continuous jobs instead of snapshot jobs for - // dynamic thing group targets. By using continuous jobs, devices that join the - // group receive the job execution even after the job has been created. + // Specifies whether the job will continue to run (CONTINUOUS), or will be + // complete after all those things specified as targets have completed the job + // (SNAPSHOT). If continuous, the job may also be run on a thing when a change is + // detected in a target. For example, a job will run on a thing when the thing is + // added to a target group, even after the job was completed by all things + // originally in the group. We recommend that you use continuous jobs instead of + // snapshot jobs for dynamic thing group targets. By using continuous jobs, devices + // that join the group receive the job execution even after the job has been + // created. TargetSelection TargetSelection // The ID of the thing group. @@ -2234,7 +2222,7 @@ type KafkaAction struct { // This member is required. ClientProperties map[string]string - // The ARN of Kafka action's VPC TopicRuleDestination. + // The ARN of Kafka action's VPC TopicRuleDestination . // // This member is required. DestinationArn *string @@ -2344,8 +2332,8 @@ type LocationTimestamp struct { Value *string // The precision of the timestamp value that results from the expression described - // in value. Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The - // default is MILLISECONDS. + // in value . Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS . + // The default is MILLISECONDS . Unit *string noSmithyDocumentSerde @@ -2394,7 +2382,7 @@ type LogTargetConfiguration struct { // The configuration of an ML Detect Security Profile. type MachineLearningDetectionConfig struct { - // The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. + // The sensitivity of anomalous behavior evaluation. Can be Low , Medium , or High . // // This member is required. ConfidenceLevel ConfidenceLevel @@ -2461,11 +2449,12 @@ type MetricDimension struct { // This member is required. DimensionName *string - // Defines how the dimensionValues of a dimension are interpreted. For example, for - // dimension type TOPIC_FILTER, the IN operator, a message will be counted only if - // its topic matches one of the topic filters. With NOT_IN operator, a message will - // be counted only if it doesn't match any of the topic filters. The operator is - // optional: if it's not provided (is null), it will be interpreted as IN. + // Defines how the dimensionValues of a dimension are interpreted. For example, + // for dimension type TOPIC_FILTER, the IN operator, a message will be counted + // only if its topic matches one of the topic filters. With NOT_IN operator, a + // message will be counted only if it doesn't match any of the topic filters. The + // operator is optional: if it's not provided (is null ), it will be interpreted as + // IN . Operator DimensionValueOperator noSmithyDocumentSerde @@ -2485,15 +2474,15 @@ type MetricToRetain struct { noSmithyDocumentSerde } -// The value to be compared with the metric. +// The value to be compared with the metric . type MetricValue struct { - // If the comparisonOperator calls for a set of CIDRs, use this to specify that set - // to be compared with the metric. + // If the comparisonOperator calls for a set of CIDRs, use this to specify that + // set to be compared with the metric . Cidrs []string // If the comparisonOperator calls for a numeric value, use this to specify that - // numeric value to be compared with the metric. + // numeric value to be compared with the metric . Count *int64 // The numeral value of a metric. @@ -2502,8 +2491,8 @@ type MetricValue struct { // The numeral values of a metric. Numbers []float64 - // If the comparisonOperator calls for a set of ports, use this to specify that set - // to be compared with the metric. + // If the comparisonOperator calls for a set of ports, use this to specify that + // set to be compared with the metric . Ports []int32 // The string values of a metric. @@ -2515,8 +2504,8 @@ type MetricValue struct { // Describes which changes should be applied as part of a mitigation action. type MitigationAction struct { - // The set of parameters for this mitigation action. The parameters vary, depending - // on the kind of action you apply. + // The set of parameters for this mitigation action. The parameters vary, + // depending on the kind of action you apply. ActionParams *MitigationActionParams // A unique identifier for the mitigation action. @@ -2531,8 +2520,8 @@ type MitigationAction struct { noSmithyDocumentSerde } -// Information that identifies a mitigation action. This information is returned by -// ListMitigationActions. +// Information that identifies a mitigation action. This information is returned +// by ListMitigationActions. type MitigationActionIdentifier struct { // The IAM role ARN used to apply this mitigation action. @@ -2595,53 +2584,47 @@ type MqttContext struct { noSmithyDocumentSerde } -// Specifies MQTT Version 5.0 headers information. For more information, see MQTT -// (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) from Amazon -// Web Services IoT Core Developer Guide. +// Specifies MQTT Version 5.0 headers information. For more information, see MQTT (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) +// from Amazon Web Services IoT Core Developer Guide. type MqttHeaders struct { - // A UTF-8 encoded string that describes the content of the publishing message. For - // more information, see Content Type - // (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) - // from the MQTT Version 5.0 specification. Supports substitution templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). + // A UTF-8 encoded string that describes the content of the publishing message. + // For more information, see Content Type (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) + // from the MQTT Version 5.0 specification. Supports substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) + // . ContentType *string // The base64-encoded binary data used by the sender of the request message to // identify which request the response message is for when it's received. For more - // information, see Correlation Data - // (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) + // information, see Correlation Data (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) // from the MQTT Version 5.0 specification. This binary data must be - // based64-encoded. Supports substitution templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). + // based64-encoded. Supports substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) + // . CorrelationData *string // A user-defined integer value that will persist a message at the message broker // for a specified amount of time to ensure that the message will expire if it's no // longer relevant to the subscriber. The value of messageExpiry represents the // number of seconds before it expires. For more information about the limits of - // messageExpiry, see Amazon Web Services IoT Core message broker and protocol - // limits and quotas - // (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) from the - // Amazon Web Services Reference Guide. Supports substitution templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). + // messageExpiry , see Amazon Web Services IoT Core message broker and protocol + // limits and quotas (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) + // from the Amazon Web Services Reference Guide. Supports substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) + // . MessageExpiry *string // An Enum string value that indicates whether the payload is formatted as UTF-8. - // Valid values are UNSPECIFIED_BYTES and UTF8_DATA. For more information, see - // Payload Format Indicator - // (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) - // from the MQTT Version 5.0 specification. Supports substitution templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). + // Valid values are UNSPECIFIED_BYTES and UTF8_DATA . For more information, see + // Payload Format Indicator (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) + // from the MQTT Version 5.0 specification. Supports substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) + // . PayloadFormatIndicator *string - // A UTF-8 encoded string that's used as the topic name for a response message. The - // response topic is used to describe the topic which the receiver should publish - // to as part of the request-response flow. The topic must not contain wildcard - // characters. For more information, see Response Topic - // (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) - // from the MQTT Version 5.0 specification. Supports substitution templates - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). + // A UTF-8 encoded string that's used as the topic name for a response message. + // The response topic is used to describe the topic which the receiver should + // publish to as part of the request-response flow. The topic must not contain + // wildcard characters. For more information, see Response Topic (https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) + // from the MQTT Version 5.0 specification. Supports substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) + // . ResponseTopic *string // An array of key-value pairs that you define in the MQTT5 header. @@ -2876,23 +2859,22 @@ type PolicyVersionIdentifier struct { // Configuration for pre-signed S3 URLs. type PresignedUrlConfig struct { - // How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the - // default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives - // an MQTT request for the job document. + // How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, + // the default value is 3600 seconds. Pre-signed URLs are generated when Jobs + // receives an MQTT request for the job document. ExpiresInSec *int64 // The ARN of an IAM role that grants grants permission to download files from the // S3 bucket where the job data/updates are stored. The role must also grant // permission for IoT to download the files. For information about addressing the - // confused deputy problem, see cross-service confused deputy prevention - // (https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) + // confused deputy problem, see cross-service confused deputy prevention (https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) // in the Amazon Web Services IoT Core developer guide. RoleArn *string noSmithyDocumentSerde } -// Structure that contains payloadVersion and targetArn. +// Structure that contains payloadVersion and targetArn . type ProvisioningHook struct { // The ARN of the target function. Note: Only Lambda functions are currently @@ -2931,9 +2913,9 @@ type ProvisioningTemplateSummary struct { // The type you define in a provisioning template. You can create a template with // only one type. You can't change the template type after its creation. The - // default value is FLEET_PROVISIONING. For more information about provisioning - // template, see: Provisioning template - // (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html). + // default value is FLEET_PROVISIONING . For more information about provisioning + // template, see: Provisioning template (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html) + // . Type TemplateType noSmithyDocumentSerde @@ -2978,21 +2960,21 @@ type PutAssetPropertyValueEntry struct { PropertyValues []AssetPropertyValue // The ID of the IoT SiteWise asset. You must specify either a propertyAlias or - // both an aliasId and a propertyId. Accepts substitution templates. + // both an aliasId and a propertyId . Accepts substitution templates. AssetId *string - // Optional. A unique identifier for this entry that you can define to better track - // which message caused an error in case of failure. Accepts substitution + // Optional. A unique identifier for this entry that you can define to better + // track which message caused an error in case of failure. Accepts substitution // templates. Defaults to a new UUID. EntryId *string // The name of the property alias associated with your asset property. You must - // specify either a propertyAlias or both an aliasId and a propertyId. Accepts + // specify either a propertyAlias or both an aliasId and a propertyId . Accepts // substitution templates. PropertyAlias *string // The ID of the asset's property. You must specify either a propertyAlias or both - // an aliasId and a propertyId. Accepts substitution templates. + // an aliasId and a propertyId . Accepts substitution templates. PropertyId *string noSmithyDocumentSerde @@ -3059,8 +3041,8 @@ type RelatedResource struct { // permissions. type ReplaceDefaultPolicyVersionParams struct { - // The name of the template to be applied. The only supported value is - // BLANK_POLICY. + // The name of the template to be applied. The only supported value is BLANK_POLICY + // . // // This member is required. TemplateName PolicyTemplateName @@ -3081,9 +3063,8 @@ type RepublishAction struct { // This member is required. Topic *string - // MQTT Version 5.0 headers information. For more information, see MQTT - // (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) from the - // Amazon Web Services IoT Core Developer Guide. + // MQTT Version 5.0 headers information. For more information, see MQTT (https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) + // from the Amazon Web Services IoT Core Developer Guide. Headers *MqttHeaders // The Quality of Service (QoS) level to use when republishing messages. The @@ -3181,9 +3162,9 @@ type S3Action struct { // This member is required. BucketName *string - // The object key. For more information, see Actions, resources, and condition keys - // for Amazon S3 - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html). + // The object key. For more information, see Actions, resources, and condition + // keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) + // . // // This member is required. Key *string @@ -3194,8 +3175,8 @@ type S3Action struct { RoleArn *string // The Amazon S3 canned ACL that controls access to the object identified by the - // object key. For more information, see S3 canned ACLs - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). + // object key. For more information, see S3 canned ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) + // . CannedAcl CannedAccessControlList noSmithyDocumentSerde @@ -3286,16 +3267,17 @@ type ScheduledJobRollout struct { type SchedulingConfig struct { // Specifies the end behavior for all job executions after a job reaches the - // selected endTime. If endTime is not selected when creating the job, then + // selected endTime . If endTime is not selected when creating the job, then // endBehavior does not apply. EndBehavior JobEndBehavior // The time a job will stop rollout of the job document to all devices in the - // target group for a job. The endTime must take place no later than two years from - // the current time and be scheduled a minimum of thirty minutes from the current - // time. The minimum duration between startTime and endTime is thirty minutes. The - // maximum duration between startTime and endTime is two years. The date and time - // format for the endTime is YYYY-MM-DD for the date and HH:MM for the time. + // target group for a job. The endTime must take place no later than two years + // from the current time and be scheduled a minimum of thirty minutes from the + // current time. The minimum duration between startTime and endTime is thirty + // minutes. The maximum duration between startTime and endTime is two years. The + // date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for + // the time. EndTime *string // An optional configuration within the SchedulingConfig to setup a recurring @@ -3382,8 +3364,8 @@ type SigningProfileParameter struct { noSmithyDocumentSerde } -// For more information, see Signature Version 4 signing process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// For more information, see Signature Version 4 signing process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . type SigV4Authorization struct { // The ARN of the signing role. @@ -3422,9 +3404,8 @@ type SnsAction struct { // setting to determine if the payload should be parsed and relevant // platform-specific bits of the payload should be extracted. To read more about // SNS message formats, see - // https://docs.aws.amazon.com/sns/latest/dg/json-formats.html - // (https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) refer to their - // official documentation. + // https://docs.aws.amazon.com/sns/latest/dg/json-formats.html (https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) + // refer to their official documentation. MessageFormat MessageFormat noSmithyDocumentSerde @@ -3469,11 +3450,11 @@ type StartSigningJobParameter struct { type StatisticalThreshold struct { // The percentile that resolves to a threshold value by which compliance with a - // behavior is determined. Metrics are collected over the specified period - // (durationSeconds) from all reporting devices in your account and statistical + // behavior is determined. Metrics are collected over the specified period ( + // durationSeconds ) from all reporting devices in your account and statistical // ranks are calculated. Then, the measurements from a device are collected over // the same period. If the accumulated measurements from the device fall above or - // below (comparisonOperator) the value associated with the percentile specified, + // below ( comparisonOperator ) the value associated with the percentile specified, // then the device is considered to be in compliance with the behavior, otherwise a // violation occurs. Statistic *string @@ -3482,8 +3463,8 @@ type StatisticalThreshold struct { } // A map of key-value pairs for all supported statistics. For issues with missing -// or unexpected values for this API, consult Fleet indexing troubleshooting guide -// (https://docs.aws.amazon.com/iot/latest/developerguide/fleet-indexing-troubleshooting.html). +// or unexpected values for this API, consult Fleet indexing troubleshooting guide (https://docs.aws.amazon.com/iot/latest/developerguide/fleet-indexing-troubleshooting.html) +// . type Statistics struct { // The average of the aggregated field values. @@ -3737,13 +3718,12 @@ type ThingDocument struct { Connectivity *ThingConnectivity // Contains Device Defender data. For more information about Device Defender, see - // Device Defender - // (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html). + // Device Defender (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html) + // . DeviceDefender *string - // The unnamed shadow and named shadow. For more information about shadows, see IoT - // Device Shadow service. - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) + // The unnamed shadow and named shadow. For more information about shadows, see + // IoT Device Shadow service. (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) Shadow *string // Thing group names. @@ -3797,8 +3777,7 @@ type ThingGroupIndexingConfiguration struct { // Contains fields that are indexed and whose types are already known by the Fleet // Indexing service. This is an optional field. For more information, see Managed - // fields - // (https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field) + // fields (https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field) // in the Amazon Web Services IoT Core Developer Guide. ManagedFields []Field @@ -3833,19 +3812,14 @@ type ThingGroupProperties struct { } // The thing indexing configuration. For more information, see Managing Thing -// Indexing -// (https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html). +// Indexing (https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) +// . type ThingIndexingConfiguration struct { // Thing indexing mode. Valid values are: - // - // * REGISTRY – Your thing index contains - // registry data only. - // - // * REGISTRY_AND_SHADOW - Your thing index contains registry - // and shadow data. - // - // * OFF - Thing indexing is disabled. + // - REGISTRY – Your thing index contains registry data only. + // - REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data. + // - OFF - Thing indexing is disabled. // // This member is required. ThingIndexingMode ThingIndexingMode @@ -3854,23 +3828,18 @@ type ThingIndexingConfiguration struct { CustomFields []Field // Device Defender indexing mode. Valid values are: - // - // * VIOLATIONS – Your thing - // index contains Device Defender violations. To enable Device Defender indexing, - // deviceDefenderIndexingMode must not be set to OFF. - // - // * OFF - Device Defender - // indexing is disabled. - // - // For more information about Device Defender violations, - // see Device Defender Detect. - // (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) + // - VIOLATIONS – Your thing index contains Device Defender violations. To + // enable Device Defender indexing, deviceDefenderIndexingMode must not be set to + // OFF. + // - OFF - Device Defender indexing is disabled. + // For more information about Device Defender violations, see Device Defender + // Detect. (https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) DeviceDefenderIndexingMode DeviceDefenderIndexingMode // Provides additional filters for specific data sources. Named shadow is the only // data source that currently supports and requires a filter. To add named shadows // to your fleet indexing configuration, set namedShadowIndexingMode to be ON and - // specify your shadow names in filter. + // specify your shadow names in filter . Filter *IndexingFilter // Contains fields that are indexed and whose types are already known by the Fleet @@ -3878,26 +3847,16 @@ type ThingIndexingConfiguration struct { ManagedFields []Field // Named shadow indexing mode. Valid values are: - // - // * ON – Your thing index contains - // named shadow. To enable thing named shadow indexing, namedShadowIndexingMode - // must not be set to OFF. - // - // * OFF - Named shadow indexing is disabled. - // - // For more - // information about Shadows, see IoT Device Shadow service. - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) + // - ON – Your thing index contains named shadow. To enable thing named shadow + // indexing, namedShadowIndexingMode must not be set to OFF. + // - OFF - Named shadow indexing is disabled. + // For more information about Shadows, see IoT Device Shadow service. (https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) NamedShadowIndexingMode NamedShadowIndexingMode // Thing connectivity indexing mode. Valid values are: - // - // * STATUS – Your thing index - // contains connectivity status. To enable thing connectivity indexing, - // thingIndexMode must not be set to OFF. - // - // * OFF - Thing connectivity status - // indexing is disabled. + // - STATUS – Your thing index contains connectivity status. To enable thing + // connectivity indexing, thingIndexMode must not be set to OFF. + // - OFF - Thing connectivity status indexing is disabled. ThingConnectivityIndexingMode ThingConnectivityIndexingMode noSmithyDocumentSerde @@ -3931,8 +3890,8 @@ type ThingTypeMetadata struct { // The date and time when the thing type was created. CreationDate *time.Time - // Whether the thing type is deprecated. If true, no new things could be associated - // with this type. + // Whether the thing type is deprecated. If true, no new things could be + // associated with this type. Deprecated bool // The date and time when the thing type was deprecated. @@ -3954,16 +3913,16 @@ type ThingTypeProperties struct { noSmithyDocumentSerde } -// Specifies the amount of time each device has to finish its execution of the job. -// A timer is started when the job execution status is set to IN_PROGRESS. If the -// job execution status is not set to another terminal state before the timer -// expires, it will be automatically set to TIMED_OUT. +// Specifies the amount of time each device has to finish its execution of the +// job. A timer is started when the job execution status is set to IN_PROGRESS . If +// the job execution status is not set to another terminal state before the timer +// expires, it will be automatically set to TIMED_OUT . type TimeoutConfig struct { - // Specifies the amount of time, in minutes, this device has to finish execution of - // this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to - // 10080 minutes). The in progress timer can't be updated and will apply to all job - // executions for the job. Whenever a job execution remains in the IN_PROGRESS + // Specifies the amount of time, in minutes, this device has to finish execution + // of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 + // to 10080 minutes). The in progress timer can't be updated and will apply to all + // job executions for the job. Whenever a job execution remains in the IN_PROGRESS // status for longer than this interval, the job execution will fail and switch to // the terminal TIMED_OUT status. InProgressTimeoutInMinutes *int64 @@ -3972,8 +3931,7 @@ type TimeoutConfig struct { } // The Timestream rule action writes attributes (measures) from an MQTT message -// into an Amazon Timestream table. For more information, see the Timestream -// (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) +// into an Amazon Timestream table. For more information, see the Timestream (https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html) // topic rule action documentation. type TimestreamAction struct { @@ -4013,9 +3971,9 @@ type TimestreamAction struct { type TimestreamDimension struct { // The metadata dimension name. This is the name of the column in the Amazon - // Timestream database table record. Dimensions cannot be named: measure_name, - // measure_value, or time. These names are reserved. Dimension names cannot start - // with ts_ or measure_value and they cannot contain the colon (:) character. + // Timestream database table record. Dimensions cannot be named: measure_name , + // measure_value , or time . These names are reserved. Dimension names cannot start + // with ts_ or measure_value and they cannot contain the colon ( : ) character. // // This member is required. Name *string @@ -4033,8 +3991,8 @@ type TimestreamDimension struct { type TimestreamTimestamp struct { // The precision of the timestamp value that results from the expression described - // in value. Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The - // default is MILLISECONDS. + // in value . Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS . + // The default is MILLISECONDS . // // This member is required. Unit *string @@ -4104,16 +4062,16 @@ type TopicRuleDestination struct { // The status of the topic rule destination. Valid values are: IN_PROGRESS A topic // rule destination was created but has not been confirmed. You can set status to - // IN_PROGRESS by calling UpdateTopicRuleDestination. Calling + // IN_PROGRESS by calling UpdateTopicRuleDestination . Calling // UpdateTopicRuleDestination causes a new confirmation challenge to be sent to // your confirmation endpoint. ENABLED Confirmation was completed, and traffic to // this destination is allowed. You can set status to DISABLED by calling - // UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to + // UpdateTopicRuleDestination . DISABLED Confirmation was completed, and traffic to // this destination is not allowed. You can set status to ENABLED by calling - // UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for + // UpdateTopicRuleDestination . ERROR Confirmation could not be completed, for // example if the confirmation timed out. You can call GetTopicRuleDestination for // details about the error. You can set status to IN_PROGRESS by calling - // UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new + // UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new // confirmation challenge to be sent to your confirmation endpoint. Status TopicRuleDestinationStatus @@ -4156,16 +4114,16 @@ type TopicRuleDestinationSummary struct { // The status of the topic rule destination. Valid values are: IN_PROGRESS A topic // rule destination was created but has not been confirmed. You can set status to - // IN_PROGRESS by calling UpdateTopicRuleDestination. Calling + // IN_PROGRESS by calling UpdateTopicRuleDestination . Calling // UpdateTopicRuleDestination causes a new confirmation challenge to be sent to // your confirmation endpoint. ENABLED Confirmation was completed, and traffic to // this destination is allowed. You can set status to DISABLED by calling - // UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to + // UpdateTopicRuleDestination . DISABLED Confirmation was completed, and traffic to // this destination is not allowed. You can set status to ENABLED by calling - // UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for + // UpdateTopicRuleDestination . ERROR Confirmation could not be completed, for // example if the confirmation timed out. You can call GetTopicRuleDestination for // details about the error. You can set status to IN_PROGRESS by calling - // UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new + // UpdateTopicRuleDestination . Calling UpdateTopicRuleDestination causes a new // confirmation challenge to be sent to your confirmation endpoint. Status TopicRuleDestinationStatus @@ -4208,8 +4166,7 @@ type TopicRulePayload struct { Actions []Action // The SQL statement used to query the topic. For more information, see IoT SQL - // Reference - // (https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) + // Reference (https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) // in the IoT Developer Guide. // // This member is required. @@ -4256,7 +4213,7 @@ type TransferData struct { type UpdateCACertificateParams struct { // The action that you want to apply to the CA certificate. The only supported - // value is DEACTIVATE. + // value is DEACTIVATE . // // This member is required. Action CACertificateUpdateAction @@ -4269,7 +4226,7 @@ type UpdateCACertificateParams struct { type UpdateDeviceCertificateParams struct { // The action that you want to apply to the device certificate. The only supported - // value is DEACTIVATE. + // value is DEACTIVATE . // // This member is required. Action DeviceCertificateUpdateAction @@ -4278,16 +4235,16 @@ type UpdateDeviceCertificateParams struct { } // A key-value pair that you define in the header. Both the key and the value are -// either literal strings or valid substitution templates -// (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html). +// either literal strings or valid substitution templates (https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html) +// . type UserProperty struct { - // A key to be specified in UserProperty. + // A key to be specified in UserProperty . // // This member is required. Key *string - // A value to be specified in UserProperty. + // A value to be specified in UserProperty . // // This member is required. Value *string @@ -4343,7 +4300,7 @@ type ViolationEvent struct { // The details of a violation event. type ViolationEventAdditionalInfo struct { - // The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. + // The sensitivity of anomalous behavior evaluation. Can be Low , Medium , or High . ConfidenceLevel ConfidenceLevel noSmithyDocumentSerde diff --git a/service/iot1clickdevicesservice/api_client.go b/service/iot1clickdevicesservice/api_client.go index 196120ddc30..e214f1ddd1c 100644 --- a/service/iot1clickdevicesservice/api_client.go +++ b/service/iot1clickdevicesservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go b/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go index 2dc1e0c37d0..f106aa4b49f 100644 --- a/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go +++ b/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go @@ -38,8 +38,8 @@ type FinalizeDeviceClaimInput struct { // A collection of key/value pairs defining the resource tags. For example, { // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS - // Tagging Strategies - // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). + // Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go b/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go index 94f8a263507..8f6c5e95d92 100644 --- a/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go +++ b/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Given a device ID, initiates a claim request for the associated device. Claiming -// a device consists of initiating a claim, then publishing a device event, and -// finalizing the claim. For a device of type button, a device event can be -// published by simply clicking the device. +// Given a device ID, initiates a claim request for the associated device. +// Claiming a device consists of initiating a claim, then publishing a device +// event, and finalizing the claim. For a device of type button, a device event can +// be published by simply clicking the device. func (c *Client) InitiateDeviceClaim(ctx context.Context, params *InitiateDeviceClaimInput, optFns ...func(*Options)) (*InitiateDeviceClaimOutput, error) { if params == nil { params = &InitiateDeviceClaimInput{} diff --git a/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go b/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go index c8a6e8a87d4..91bd938df0e 100644 --- a/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go +++ b/service/iot1clickdevicesservice/api_op_ListDeviceEvents.go @@ -48,8 +48,8 @@ type ListDeviceEventsInput struct { // This member is required. ToTimeStamp *time.Time - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. MaxResults int32 // The token to retrieve the next set of results. diff --git a/service/iot1clickdevicesservice/api_op_ListDevices.go b/service/iot1clickdevicesservice/api_op_ListDevices.go index 3972f0ee06d..c2281dff51c 100644 --- a/service/iot1clickdevicesservice/api_op_ListDevices.go +++ b/service/iot1clickdevicesservice/api_op_ListDevices.go @@ -32,8 +32,8 @@ type ListDevicesInput struct { // The type of the device, such as "button". DeviceType *string - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. MaxResults int32 // The token to retrieve the next set of results. diff --git a/service/iot1clickdevicesservice/api_op_ListTagsForResource.go b/service/iot1clickdevicesservice/api_op_ListTagsForResource.go index 445bffcfe3d..a445a7bb7ee 100644 --- a/service/iot1clickdevicesservice/api_op_ListTagsForResource.go +++ b/service/iot1clickdevicesservice/api_op_ListTagsForResource.go @@ -40,8 +40,8 @@ type ListTagsForResourceOutput struct { // A collection of key/value pairs defining the resource tags. For example, { // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS - // Tagging Strategies - // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). + // Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) + // . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/iot1clickdevicesservice/api_op_TagResource.go b/service/iot1clickdevicesservice/api_op_TagResource.go index 0a8eb251618..8467916659c 100644 --- a/service/iot1clickdevicesservice/api_op_TagResource.go +++ b/service/iot1clickdevicesservice/api_op_TagResource.go @@ -11,8 +11,7 @@ import ( ) // Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click -// Service Limits -// (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) +// Service Limits (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) // for the maximum number of tags allowed per resource. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type TagResourceInput struct { // A collection of key/value pairs defining the resource tags. For example, { // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS - // Tagging Strategies - // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). + // Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) + // . // // This member is required. Tags map[string]string diff --git a/service/iot1clickdevicesservice/api_op_UntagResource.go b/service/iot1clickdevicesservice/api_op_UntagResource.go index 229add9a8f2..dc9d02c017e 100644 --- a/service/iot1clickdevicesservice/api_op_UntagResource.go +++ b/service/iot1clickdevicesservice/api_op_UntagResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Using tag keys, deletes the tags (key/value pairs) associated with the specified -// resource ARN. +// Using tag keys, deletes the tags (key/value pairs) associated with the +// specified resource ARN. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/iot1clickprojects/api_client.go b/service/iot1clickprojects/api_client.go index de1db93ef76..99c3ae82b9d 100644 --- a/service/iot1clickprojects/api_client.go +++ b/service/iot1clickprojects/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iot1clickprojects/api_op_CreateProject.go b/service/iot1clickprojects/api_op_CreateProject.go index f7fd89059f9..aae74e1b964 100644 --- a/service/iot1clickprojects/api_op_CreateProject.go +++ b/service/iot1clickprojects/api_op_CreateProject.go @@ -45,9 +45,9 @@ type CreateProjectInput struct { PlacementTemplate *types.PlacementTemplate // Optional tags (metadata key/value pairs) to be associated with the project. For - // example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS - // Tagging Strategies - // (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). + // example, { {"key1": "value1", "key2": "value2"} } . For more information, see + // AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/iot1clickprojects/api_op_ListPlacements.go b/service/iot1clickprojects/api_op_ListPlacements.go index 8ae021dc804..908a1c804d4 100644 --- a/service/iot1clickprojects/api_op_ListPlacements.go +++ b/service/iot1clickprojects/api_op_ListPlacements.go @@ -35,8 +35,8 @@ type ListPlacementsInput struct { // This member is required. ProjectName *string - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. MaxResults *int32 // The token to retrieve the next set of results. @@ -135,8 +135,8 @@ var _ ListPlacementsAPIClient = (*Client)(nil) // ListPlacementsPaginatorOptions is the paginator options for ListPlacements type ListPlacementsPaginatorOptions struct { - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot1clickprojects/api_op_ListProjects.go b/service/iot1clickprojects/api_op_ListProjects.go index b5f947df99c..308d4d2f394 100644 --- a/service/iot1clickprojects/api_op_ListProjects.go +++ b/service/iot1clickprojects/api_op_ListProjects.go @@ -31,8 +31,8 @@ func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, op type ListProjectsInput struct { - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. MaxResults *int32 // The token to retrieve the next set of results. @@ -127,8 +127,8 @@ var _ ListProjectsAPIClient = (*Client)(nil) // ListProjectsPaginatorOptions is the paginator options for ListProjects type ListProjectsPaginatorOptions struct { - // The maximum number of results to return per request. If not set, a default value - // of 100 is used. + // The maximum number of results to return per request. If not set, a default + // value of 100 is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot1clickprojects/api_op_TagResource.go b/service/iot1clickprojects/api_op_TagResource.go index dd2dc0ae4e6..c9a49b21a2f 100644 --- a/service/iot1clickprojects/api_op_TagResource.go +++ b/service/iot1clickprojects/api_op_TagResource.go @@ -12,8 +12,8 @@ import ( // Creates or modifies tags for a resource. Tags are key/value pairs (metadata) // that can be used to manage a resource. For more information, see AWS Tagging -// Strategies -// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). +// Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -36,8 +36,7 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits - // (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) + // The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) // for the maximum number of tags allowed per resource. // // This member is required. diff --git a/service/iot1clickprojects/api_op_UpdateProject.go b/service/iot1clickprojects/api_op_UpdateProject.go index 016eee56c79..6bbedda3030 100644 --- a/service/iot1clickprojects/api_op_UpdateProject.go +++ b/service/iot1clickprojects/api_op_UpdateProject.go @@ -14,7 +14,7 @@ import ( // Updates a project associated with your AWS account and region. With the // exception of device template names, you can pass just the values that need to be // updated because the update request will change only the values that are -// provided. To clear a value, pass the empty string (i.e., ""). +// provided. To clear a value, pass the empty string (i.e., "" ). func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error) { if params == nil { params = &UpdateProjectInput{} @@ -42,7 +42,7 @@ type UpdateProjectInput struct { // An object defining the project update. Once a project has been created, you // cannot add device template names to the project. However, for a given - // placementTemplate, you can update the associated callbackOverrides for the + // placementTemplate , you can update the associated callbackOverrides for the // device definition using this API. PlacementTemplate *types.PlacementTemplate diff --git a/service/iot1clickprojects/types/types.go b/service/iot1clickprojects/types/types.go index e3df30ec026..57f36166db5 100644 --- a/service/iot1clickprojects/types/types.go +++ b/service/iot1clickprojects/types/types.go @@ -7,15 +7,15 @@ import ( "time" ) -// An object representing a device for a placement template (see -// PlacementTemplate). +// An object representing a device for a placement template (see PlacementTemplate +// ). type DeviceTemplate struct { // An optional Lambda function to invoke instead of the default Lambda function // provided by the placement template. CallbackOverrides map[string]string - // The device type, which currently must be "button". + // The device type, which currently must be "button" . DeviceType *string noSmithyDocumentSerde @@ -87,8 +87,8 @@ type PlacementTemplate struct { // this template. DefaultAttributes map[string]string - // An object specifying the DeviceTemplate for all placements using this - // (PlacementTemplate) template. + // An object specifying the DeviceTemplate for all placements using this ( + // PlacementTemplate ) template. DeviceTemplates map[string]DeviceTemplate noSmithyDocumentSerde diff --git a/service/iotanalytics/api_client.go b/service/iotanalytics/api_client.go index fec22140f43..a315f9e00ed 100644 --- a/service/iotanalytics/api_client.go +++ b/service/iotanalytics/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotanalytics/api_op_BatchPutMessage.go b/service/iotanalytics/api_op_BatchPutMessage.go index b215ea545ff..9d318ce2747 100644 --- a/service/iotanalytics/api_op_BatchPutMessage.go +++ b/service/iotanalytics/api_op_BatchPutMessage.go @@ -37,28 +37,17 @@ type BatchPutMessageInput struct { // The list of messages to be sent. Each message has the format: { "messageId": // "string", "payload": "string"}. The field names of message payloads (data) that // you send to IoT Analytics: - // - // * Must contain only alphanumeric characters and - // undescores (_). No other special characters are allowed. - // - // * Must begin with an - // alphabetic character or single underscore (_). - // - // * Cannot contain hyphens (-). - // - // * - // In regular expression terms: - // "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". - // - // * Cannot be more than 255 - // characters. - // - // * Are case insensitive. (Fields named foo and FOO in the same - // payload are considered duplicates.) - // - // For example, {"temp_01": 29} or - // {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or - // {"__temp_01": 29} are invalid in message payloads. + // - Must contain only alphanumeric characters and undescores (_). No other + // special characters are allowed. + // - Must begin with an alphabetic character or single underscore (_). + // - Cannot contain hyphens (-). + // - In regular expression terms: + // "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". + // - Cannot be more than 255 characters. + // - Are case insensitive. (Fields named foo and FOO in the same payload are + // considered duplicates.) + // For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": + // 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads. // // This member is required. Messages []types.Message diff --git a/service/iotanalytics/api_op_CancelPipelineReprocessing.go b/service/iotanalytics/api_op_CancelPipelineReprocessing.go index ed0643cceb0..cc61187a0ab 100644 --- a/service/iotanalytics/api_op_CancelPipelineReprocessing.go +++ b/service/iotanalytics/api_op_CancelPipelineReprocessing.go @@ -33,7 +33,7 @@ type CancelPipelineReprocessingInput struct { // This member is required. PipelineName *string - // The ID of the reprocessing task (returned by StartPipelineReprocessing). + // The ID of the reprocessing task (returned by StartPipelineReprocessing ). // // This member is required. ReprocessingId *string diff --git a/service/iotanalytics/api_op_CreateChannel.go b/service/iotanalytics/api_op_CreateChannel.go index d05cc77196f..641250a02c6 100644 --- a/service/iotanalytics/api_op_CreateChannel.go +++ b/service/iotanalytics/api_op_CreateChannel.go @@ -36,7 +36,7 @@ type CreateChannelInput struct { ChannelName *string // Where channel data is stored. You can choose one of serviceManagedS3 or - // customerManagedS3 storage. If not specified, the default is serviceManagedS3. + // customerManagedS3 storage. If not specified, the default is serviceManagedS3 . // You can't change this storage option after the channel is created. ChannelStorage *types.ChannelStorage diff --git a/service/iotanalytics/api_op_CreateDataset.go b/service/iotanalytics/api_op_CreateDataset.go index 40d21481b9e..4128a2281fe 100644 --- a/service/iotanalytics/api_op_CreateDataset.go +++ b/service/iotanalytics/api_op_CreateDataset.go @@ -48,17 +48,15 @@ type CreateDatasetInput struct { ContentDeliveryRules []types.DatasetContentDeliveryRule // A list of data rules that send notifications to CloudWatch, when data arrives - // late. To specify lateDataRules, the dataset must use a DeltaTimer - // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) + // late. To specify lateDataRules , the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) // filter. LateDataRules []types.LateDataRule // Optional. How long, in days, versions of dataset contents are kept for the - // dataset. If not specified or set to null, versions of dataset contents are + // dataset. If not specified or set to null , versions of dataset contents are // retained for at most 90 days. The number of versions of dataset contents // retained is determined by the versioningConfiguration parameter. For more - // information, see Keeping Multiple Versions of IoT Analytics datasets - // (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + // information, see Keeping Multiple Versions of IoT Analytics datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) // in the IoT Analytics User Guide. RetentionPeriod *types.RetentionPeriod @@ -74,8 +72,7 @@ type CreateDatasetInput struct { // set to null, only the latest version plus the latest succeeded version (if they // are different) are kept for the time period specified by the retentionPeriod // parameter. For more information, see Keeping Multiple Versions of IoT Analytics - // datasets - // (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) // in the IoT Analytics User Guide. VersioningConfiguration *types.VersioningConfiguration diff --git a/service/iotanalytics/api_op_CreateDatasetContent.go b/service/iotanalytics/api_op_CreateDatasetContent.go index f5903187761..0ae7d6fef55 100644 --- a/service/iotanalytics/api_op_CreateDatasetContent.go +++ b/service/iotanalytics/api_op_CreateDatasetContent.go @@ -35,8 +35,7 @@ type CreateDatasetContentInput struct { DatasetName *string // The version ID of the dataset content. To specify versionId for a dataset - // content, the dataset must use a DeltaTimer - // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) + // content, the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) // filter. VersionId *string diff --git a/service/iotanalytics/api_op_CreateDatastore.go b/service/iotanalytics/api_op_CreateDatastore.go index 7e1a36568f5..5c6842f1e25 100644 --- a/service/iotanalytics/api_op_CreateDatastore.go +++ b/service/iotanalytics/api_op_CreateDatastore.go @@ -39,12 +39,12 @@ type CreateDatastoreInput struct { // Where data in a data store is stored.. You can choose serviceManagedS3 storage, // customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default - // is serviceManagedS3. You can't change the choice of Amazon S3 storage after your - // data store is created. + // is serviceManagedS3 . You can't change the choice of Amazon S3 storage after + // your data store is created. DatastoreStorage types.DatastoreStorage // Contains the configuration information of file formats. IoT Analytics data - // stores support JSON and Parquet (https://parquet.apache.org/). The default file + // stores support JSON and Parquet (https://parquet.apache.org/) . The default file // format is JSON. You can specify only one format. You can't change the file // format after you create the data store. FileFormatConfiguration *types.FileFormatConfiguration diff --git a/service/iotanalytics/api_op_CreatePipeline.go b/service/iotanalytics/api_op_CreatePipeline.go index 2f7d5b465f8..a88ee09d4aa 100644 --- a/service/iotanalytics/api_op_CreatePipeline.go +++ b/service/iotanalytics/api_op_CreatePipeline.go @@ -36,10 +36,10 @@ type CreatePipelineInput struct { // messages, such as removing, renaming or adding message attributes; filtering // messages based on attribute values; invoking your Lambda unctions on messages // for advanced processing; or performing mathematical transformations to normalize - // device data. The list can be 2-25 PipelineActivity objects and must contain both - // a channel and a datastore activity. Each entry in the list must contain only one - // activity. For example: pipelineActivities = [ { "channel": { ... } }, { - // "lambda": { ... } }, ... ] + // device data. The list can be 2-25 PipelineActivity objects and must contain + // both a channel and a datastore activity. Each entry in the list must contain + // only one activity. For example: pipelineActivities = [ { "channel": { ... } }, + // { "lambda": { ... } }, ... ] // // This member is required. PipelineActivities []types.PipelineActivity diff --git a/service/iotanalytics/api_op_DescribeChannel.go b/service/iotanalytics/api_op_DescribeChannel.go index 98ed58b1be0..26934af7db7 100644 --- a/service/iotanalytics/api_op_DescribeChannel.go +++ b/service/iotanalytics/api_op_DescribeChannel.go @@ -34,8 +34,8 @@ type DescribeChannelInput struct { // This member is required. ChannelName *string - // If true, additional statistical information about the channel is included in the - // response. This feature can't be used with a channel whose S3 storage is + // If true, additional statistical information about the channel is included in + // the response. This feature can't be used with a channel whose S3 storage is // customer-managed. IncludeStatistics bool @@ -47,8 +47,8 @@ type DescribeChannelOutput struct { // An object that contains information about the channel. Channel *types.Channel - // Statistics about the channel. Included if the includeStatistics parameter is set - // to true in the request. + // Statistics about the channel. Included if the includeStatistics parameter is + // set to true in the request. Statistics *types.ChannelStatistics // Metadata pertaining to the operation's result. diff --git a/service/iotanalytics/api_op_GetDatasetContent.go b/service/iotanalytics/api_op_GetDatasetContent.go index c9fbf8fdc9f..fe9fad82fbe 100644 --- a/service/iotanalytics/api_op_GetDatasetContent.go +++ b/service/iotanalytics/api_op_GetDatasetContent.go @@ -36,9 +36,9 @@ type GetDatasetContentInput struct { DatasetName *string // The version of the dataset whose contents are retrieved. You can also use the - // strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest - // or latest successfully completed dataset. If not specified, "$LATEST_SUCCEEDED" - // is the default. + // strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the + // latest or latest successfully completed dataset. If not specified, + // "$LATEST_SUCCEEDED" is the default. VersionId *string noSmithyDocumentSerde diff --git a/service/iotanalytics/api_op_ListDatasetContents.go b/service/iotanalytics/api_op_ListDatasetContents.go index d73292e3822..23a74a7d979 100644 --- a/service/iotanalytics/api_op_ListDatasetContents.go +++ b/service/iotanalytics/api_op_ListDatasetContents.go @@ -133,8 +133,8 @@ func (c *Client) addOperationListDatasetContentsMiddlewares(stack *middleware.St return nil } -// ListDatasetContentsAPIClient is a client that implements the ListDatasetContents -// operation. +// ListDatasetContentsAPIClient is a client that implements the +// ListDatasetContents operation. type ListDatasetContentsAPIClient interface { ListDatasetContents(context.Context, *ListDatasetContentsInput, ...func(*Options)) (*ListDatasetContentsOutput, error) } diff --git a/service/iotanalytics/api_op_RunPipelineActivity.go b/service/iotanalytics/api_op_RunPipelineActivity.go index 3496f55f2a2..ab8b1b4149e 100644 --- a/service/iotanalytics/api_op_RunPipelineActivity.go +++ b/service/iotanalytics/api_op_RunPipelineActivity.go @@ -34,11 +34,11 @@ type RunPipelineActivityInput struct { // This member is required. Payloads [][]byte - // The pipeline activity that is run. This must not be a channel activity or a data - // store activity because these activities are used in a pipeline only to load the - // original message and to store the (possibly) transformed message. If a Lambda - // activity is specified, only short-running Lambda functions (those with a timeout - // of less than 30 seconds or less) can be used. + // The pipeline activity that is run. This must not be a channel activity or a + // data store activity because these activities are used in a pipeline only to load + // the original message and to store the (possibly) transformed message. If a + // Lambda activity is specified, only short-running Lambda functions (those with a + // timeout of less than 30 seconds or less) can be used. // // This member is required. PipelineActivity *types.PipelineActivity diff --git a/service/iotanalytics/api_op_SampleChannelData.go b/service/iotanalytics/api_op_SampleChannelData.go index 6b8012fff5b..5e2dddd0f43 100644 --- a/service/iotanalytics/api_op_SampleChannelData.go +++ b/service/iotanalytics/api_op_SampleChannelData.go @@ -50,8 +50,8 @@ type SampleChannelDataInput struct { type SampleChannelDataOutput struct { - // The list of message samples. Each sample message is returned as a base64-encoded - // string. + // The list of message samples. Each sample message is returned as a + // base64-encoded string. Payloads [][]byte // Metadata pertaining to the operation's result. diff --git a/service/iotanalytics/api_op_StartPipelineReprocessing.go b/service/iotanalytics/api_op_StartPipelineReprocessing.go index b7a48cb444c..f0da09af265 100644 --- a/service/iotanalytics/api_op_StartPipelineReprocessing.go +++ b/service/iotanalytics/api_op_StartPipelineReprocessing.go @@ -37,11 +37,12 @@ type StartPipelineReprocessingInput struct { // Specifies one or more sets of channel messages that you want to reprocess. If // you use the channelMessages object, you must not specify a value for startTime - // and endTime. + // and endTime . ChannelMessages *types.ChannelMessages - // The end time (exclusive) of raw message data that is reprocessed. If you specify - // a value for the endTime parameter, you must not use the channelMessages object. + // The end time (exclusive) of raw message data that is reprocessed. If you + // specify a value for the endTime parameter, you must not use the channelMessages + // object. EndTime *time.Time // The start time (inclusive) of raw message data that is reprocessed. If you diff --git a/service/iotanalytics/api_op_UpdateChannel.go b/service/iotanalytics/api_op_UpdateChannel.go index 093e576cc06..b485b6e03d3 100644 --- a/service/iotanalytics/api_op_UpdateChannel.go +++ b/service/iotanalytics/api_op_UpdateChannel.go @@ -35,7 +35,7 @@ type UpdateChannelInput struct { ChannelName *string // Where channel data is stored. You can choose one of serviceManagedS3 or - // customerManagedS3 storage. If not specified, the default is serviceManagedS3. + // customerManagedS3 storage. If not specified, the default is serviceManagedS3 . // You can't change this storage option after the channel is created. ChannelStorage *types.ChannelStorage diff --git a/service/iotanalytics/api_op_UpdateDataset.go b/service/iotanalytics/api_op_UpdateDataset.go index ccc2edce176..6eab1cc6e19 100644 --- a/service/iotanalytics/api_op_UpdateDataset.go +++ b/service/iotanalytics/api_op_UpdateDataset.go @@ -44,8 +44,7 @@ type UpdateDatasetInput struct { ContentDeliveryRules []types.DatasetContentDeliveryRule // A list of data rules that send notifications to CloudWatch, when data arrives - // late. To specify lateDataRules, the dataset must use a DeltaTimer - // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) + // late. To specify lateDataRules , the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) // filter. LateDataRules []types.LateDataRule @@ -60,8 +59,7 @@ type UpdateDatasetInput struct { // set to null, only the latest version plus the latest succeeded version (if they // are different) are kept for the time period specified by the retentionPeriod // parameter. For more information, see Keeping Multiple Versions of IoT Analytics - // datasets - // (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) // in the IoT Analytics User Guide. VersioningConfiguration *types.VersioningConfiguration diff --git a/service/iotanalytics/api_op_UpdateDatastore.go b/service/iotanalytics/api_op_UpdateDatastore.go index de89476db9c..92febd644e1 100644 --- a/service/iotanalytics/api_op_UpdateDatastore.go +++ b/service/iotanalytics/api_op_UpdateDatastore.go @@ -36,18 +36,19 @@ type UpdateDatastoreInput struct { // Where data in a data store is stored.. You can choose serviceManagedS3 storage, // customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default - // is serviceManagedS3. You can't change the choice of Amazon S3 storage after your - // data store is created. + // is serviceManagedS3 . You can't change the choice of Amazon S3 storage after + // your data store is created. DatastoreStorage types.DatastoreStorage // Contains the configuration information of file formats. IoT Analytics data - // stores support JSON and Parquet (https://parquet.apache.org/). The default file + // stores support JSON and Parquet (https://parquet.apache.org/) . The default file // format is JSON. You can specify only one format. You can't change the file // format after you create the data store. FileFormatConfiguration *types.FileFormatConfiguration - // How long, in days, message data is kept for the data store. The retention period - // can't be updated if the data store's Amazon S3 storage is customer-managed. + // How long, in days, message data is kept for the data store. The retention + // period can't be updated if the data store's Amazon S3 storage is + // customer-managed. RetentionPeriod *types.RetentionPeriod noSmithyDocumentSerde diff --git a/service/iotanalytics/api_op_UpdatePipeline.go b/service/iotanalytics/api_op_UpdatePipeline.go index adda867c1bd..368733a3931 100644 --- a/service/iotanalytics/api_op_UpdatePipeline.go +++ b/service/iotanalytics/api_op_UpdatePipeline.go @@ -35,10 +35,10 @@ type UpdatePipelineInput struct { // messages, such as removing, renaming or adding message attributes; filtering // messages based on attribute values; invoking your Lambda functions on messages // for advanced processing; or performing mathematical transformations to normalize - // device data. The list can be 2-25 PipelineActivity objects and must contain both - // a channel and a datastore activity. Each entry in the list must contain only one - // activity. For example: pipelineActivities = [ { "channel": { ... } }, { - // "lambda": { ... } }, ... ] + // device data. The list can be 2-25 PipelineActivity objects and must contain + // both a channel and a datastore activity. Each entry in the list must contain + // only one activity. For example: pipelineActivities = [ { "channel": { ... } }, + // { "lambda": { ... } }, ... ] // // This member is required. PipelineActivities []types.PipelineActivity diff --git a/service/iotanalytics/types/enums.go b/service/iotanalytics/types/enums.go index 3c764490c40..63696ce3ff4 100644 --- a/service/iotanalytics/types/enums.go +++ b/service/iotanalytics/types/enums.go @@ -143,9 +143,9 @@ const ( LoggingLevelError LoggingLevel = "ERROR" ) -// Values returns all known values for LoggingLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LoggingLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LoggingLevel) Values() []LoggingLevel { return []LoggingLevel{ "ERROR", diff --git a/service/iotanalytics/types/types.go b/service/iotanalytics/types/types.go index 5181722df4e..15ba949a023 100644 --- a/service/iotanalytics/types/types.go +++ b/service/iotanalytics/types/types.go @@ -13,7 +13,7 @@ type AddAttributesActivity struct { // A list of 1-50 AttributeNameMapping objects that map an existing attribute to a // new attribute. The existing attributes remain in the message, so if you want to - // remove the originals, use RemoveAttributeActivity. + // remove the originals, use RemoveAttributeActivity . // // This member is required. Attributes map[string]string @@ -74,7 +74,7 @@ type Channel struct { Status ChannelStatus // Where channel data is stored. You can choose one of serviceManagedS3 or - // customerManagedS3 storage. If not specified, the default is serviceManagedS3. + // customerManagedS3 storage. If not specified, the default is serviceManagedS3 . // You can't change this storage option after the channel is created. Storage *ChannelStorage @@ -121,8 +121,8 @@ type ChannelStatistics struct { noSmithyDocumentSerde } -// Where channel data is stored. You may choose one of serviceManagedS3, -// customerManagedS3 storage. If not specified, the default is serviceManagedS3. +// Where channel data is stored. You may choose one of serviceManagedS3 , +// customerManagedS3 storage. If not specified, the default is serviceManagedS3 . // This can't be changed after creation of the channel. type ChannelStorage struct { @@ -186,9 +186,8 @@ type Column struct { Name *string // The type of data. For more information about the supported data types, see - // Common data types - // (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html) in the - // Glue Developer Guide. + // Common data types (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html) + // in the Glue Developer Guide. // // This member is required. Type *string @@ -200,7 +199,7 @@ type Column struct { type ContainerDatasetAction struct { // The ARN of the role that gives permission to the system to access required - // resources to run the containerAction. This includes, at minimum, permission to + // resources to run the containerAction . This includes, at minimum, permission to // retrieve the dataset contents that are the input to the containerized // application. // @@ -214,15 +213,15 @@ type ContainerDatasetAction struct { // This member is required. Image *string - // Configuration of the resource that executes the containerAction. + // Configuration of the resource that executes the containerAction . // // This member is required. ResourceConfiguration *ResourceConfiguration // The values of variables used in the context of the execution of the // containerized application (basically, parameters passed to the application). - // Each variable must have a name and a value given by one of stringValue, - // datasetContentVersionValue, or outputFileUriValue. + // Each variable must have a name and a value given by one of stringValue , + // datasetContentVersionValue , or outputFileUriValue . Variables []Variable noSmithyDocumentSerde @@ -336,8 +335,7 @@ type Dataset struct { LastUpdateTime *time.Time // A list of data rules that send notifications to CloudWatch, when data arrives - // late. To specify lateDataRules, the dataset must use a DeltaTimer - // (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) + // late. To specify lateDataRules , the dataset must use a DeltaTimer (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) // filter. LateDataRules []LateDataRule @@ -357,9 +355,8 @@ type Dataset struct { // Optional. How many versions of dataset contents are kept. If not specified or // set to null, only the latest version plus the latest succeeded version (if they // are different) are kept for the time period specified by the retentionPeriod - // parameter. For more information, see Keeping Multiple Versions of IoT Analytics - // datasets - // (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) + // parameter. For more information, see Keeping Multiple Versions of IoT Analytics + // datasets (https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) // in the IoT Analytics User Guide. VersioningConfiguration *VersioningConfiguration @@ -536,7 +533,7 @@ type Datastore struct { DatastorePartitions *DatastorePartitions // Contains the configuration information of file formats. IoT Analytics data - // stores support JSON and Parquet (https://parquet.apache.org/). The default file + // stores support JSON and Parquet (https://parquet.apache.org/) . The default file // format is JSON. You can specify only one format. You can't change the file // format after you create the data store. FileFormatConfiguration *FileFormatConfiguration @@ -558,15 +555,15 @@ type Datastore struct { // customerManagedS3 storage is selected, this parameter is ignored. RetentionPeriod *RetentionPeriod - // The status of a data store: CREATING The data store is being created. ACTIVE The - // data store has been created and can be used. DELETING The data store is being - // deleted. + // The status of a data store: CREATING The data store is being created. ACTIVE + // The data store has been created and can be used. DELETING The data store is + // being deleted. Status DatastoreStatus // Where data in a data store is stored.. You can choose serviceManagedS3 storage, // customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default - // is serviceManagedS3. You can't change the choice of Amazon S3 storage after your - // data store is created. + // is serviceManagedS3 . You can't change the choice of Amazon S3 storage after + // your data store is created. Storage DatastoreStorage noSmithyDocumentSerde @@ -612,10 +609,10 @@ type DatastoreIotSiteWiseMultiLayerStorageSummary struct { } // A single dimension to partition a data store. The dimension must be an -// AttributePartition or a TimestampPartition. +// AttributePartition or a TimestampPartition . type DatastorePartition struct { - // A partition dimension defined by an attributeName. + // A partition dimension defined by an attributeName . AttributePartition *Partition // A partition dimension defined by a timestamp attribute. @@ -644,8 +641,8 @@ type DatastoreStatistics struct { // Where data in a data store is stored.. You can choose serviceManagedS3 storage, // customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default -// is serviceManagedS3. You can't change the choice of Amazon S3 storage after your -// data store is created. +// is serviceManagedS3 . You can't change the choice of Amazon S3 storage after +// your data store is created. // // The following types satisfy this interface: // @@ -764,22 +761,19 @@ type DeltaTime struct { } // A structure that contains the configuration information of a delta time session -// window. DeltaTime -// (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) -// specifies a time interval. You can use DeltaTime to create dataset contents with -// data that has arrived in the data store since the last execution. For an example -// of DeltaTime, see Creating a SQL dataset with a delta window (CLI) -// (https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6) +// window. DeltaTime (https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) +// specifies a time interval. You can use DeltaTime to create dataset contents +// with data that has arrived in the data store since the last execution. For an +// example of DeltaTime , see Creating a SQL dataset with a delta window (CLI) (https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6) // in the IoT Analytics User Guide. type DeltaTimeSessionWindowConfiguration struct { - // A time interval. You can use timeoutInMinutes so that IoT Analytics can batch up - // late data notifications that have been generated since the last execution. IoT - // Analytics sends one batch of notifications to Amazon CloudWatch Events at one - // time. For more information about how to write a timestamp expression, see Date - // and Time Functions and Operators - // (https://prestodb.io/docs/0.172/functions/datetime.html), in the Presto 0.172 - // Documentation. + // A time interval. You can use timeoutInMinutes so that IoT Analytics can batch + // up late data notifications that have been generated since the last execution. + // IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at + // one time. For more information about how to write a timestamp expression, see + // Date and Time Functions and Operators (https://prestodb.io/docs/0.172/functions/datetime.html) + // , in the Presto 0.172 Documentation. // // This member is required. TimeoutInMinutes *int32 @@ -859,7 +853,7 @@ type EstimatedResourceSize struct { } // Contains the configuration information of file formats. IoT Analytics data -// stores support JSON and Parquet (https://parquet.apache.org/). The default file +// stores support JSON and Parquet (https://parquet.apache.org/) . The default file // format is JSON. You can specify only one format. You can't change the file // format after you create the data store. type FileFormatConfiguration struct { @@ -1076,8 +1070,8 @@ type Message struct { // This member is required. MessageId *string - // The payload of the message. This can be a JSON string or a base64-encoded string - // representing binary data, in which case you must decode it by means of a + // The payload of the message. This can be a JSON string or a base64-encoded + // string representing binary data, in which case you must decode it by means of a // pipeline activity. // // This member is required. @@ -1234,7 +1228,7 @@ type ReprocessingSummary struct { // The time the pipeline reprocessing was created. CreationTime *time.Time - // The reprocessingId returned by StartPipelineReprocessing. + // The reprocessingId returned by StartPipelineReprocessing . Id *string // The status of the pipeline reprocessing. @@ -1243,10 +1237,10 @@ type ReprocessingSummary struct { noSmithyDocumentSerde } -// The configuration of the resource used to execute the containerAction. +// The configuration of the resource used to execute the containerAction . type ResourceConfiguration struct { - // The type of the compute resource used to execute the containerAction. Possible + // The type of the compute resource used to execute the containerAction . Possible // values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB). // // This member is required. @@ -1286,22 +1280,17 @@ type S3DestinationConfiguration struct { // The key of the dataset contents object in an S3 bucket. Each object has a key // that is a unique identifier. Each object has exactly one key. You can create a // unique key with the following options: - // - // * Use !{iotanalytics:scheduleTime} to - // insert the time of a scheduled SQL query run. - // - // * Use !{iotanalytics:versionId} - // to insert a unique hash that identifies a dataset content. - // - // * Use - // !{iotanalytics:creationTime} to insert the creation time of a dataset - // content. - // + // - Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query + // run. + // - Use !{iotanalytics:versionId} to insert a unique hash that identifies a + // dataset content. + // - Use !{iotanalytics:creationTime} to insert the creation time of a dataset + // content. // The following example creates a unique key for a CSV file: // dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv If // you don't use !{iotanalytics:versionId} to specify the key, you might get // duplicate keys. For example, you might have two dataset contents with the same - // scheduleTime but different versionIds. This means that one dataset content + // scheduleTime but different versionId s. This means that one dataset content // overwrites the other. // // This member is required. @@ -1323,9 +1312,8 @@ type S3DestinationConfiguration struct { // The schedule for when to trigger an update. type Schedule struct { - // The expression that defines when to trigger an update. For more information, see - // Schedule Expressions for Rules - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) + // The expression that defines when to trigger an update. For more information, + // see Schedule Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) // in the Amazon CloudWatch Events User Guide. Expression *string @@ -1443,8 +1431,8 @@ type TriggeringDataset struct { } // An instance of a variable to be passed to the containerAction execution. Each -// variable must have a name and a value given by one of stringValue, -// datasetContentVersionValue, or outputFileUriValue. +// variable must have a name and a value given by one of stringValue , +// datasetContentVersionValue , or outputFileUriValue . type Variable struct { // The name of the variable. @@ -1472,7 +1460,7 @@ type Variable struct { type VersioningConfiguration struct { // How many versions of dataset contents are kept. The unlimited parameter must be - // false. + // false . MaxVersions *int32 // If true, unlimited versions of dataset contents are kept. diff --git a/service/iotdataplane/api_client.go b/service/iotdataplane/api_client.go index ee465c1f420..378038feeaf 100644 --- a/service/iotdataplane/api_client.go +++ b/service/iotdataplane/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotdataplane/api_op_DeleteThingShadow.go b/service/iotdataplane/api_op_DeleteThingShadow.go index 5084b3d3762..6b46a5bdf94 100644 --- a/service/iotdataplane/api_op_DeleteThingShadow.go +++ b/service/iotdataplane/api_op_DeleteThingShadow.go @@ -11,10 +11,8 @@ import ( ) // Deletes the shadow for the specified thing. Requires permission to access the -// DeleteThingShadow -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. For more information, see DeleteThingShadow -// (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html) +// DeleteThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// action. For more information, see DeleteThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html) // in the IoT Developer Guide. func (c *Client) DeleteThingShadow(ctx context.Context, params *DeleteThingShadowInput, optFns ...func(*Options)) (*DeleteThingShadowOutput, error) { if params == nil { diff --git a/service/iotdataplane/api_op_GetRetainedMessage.go b/service/iotdataplane/api_op_GetRetainedMessage.go index af6c52ab0fa..be18b602cb1 100644 --- a/service/iotdataplane/api_op_GetRetainedMessage.go +++ b/service/iotdataplane/api_op_GetRetainedMessage.go @@ -13,10 +13,9 @@ import ( // Gets the details of a single retained message for the specified topic. This // action returns the message payload of the retained message, which can incur // messaging costs. To list only the topic names of the retained messages, call -// ListRetainedMessages. Requires permission to access the GetRetainedMessage -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) +// ListRetainedMessages . Requires permission to access the GetRetainedMessage (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) // action. For more information about messaging costs, see Amazon Web Services IoT -// Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging). +// Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging) . func (c *Client) GetRetainedMessage(ctx context.Context, params *GetRetainedMessageInput, optFns ...func(*Options)) (*GetRetainedMessageOutput, error) { if params == nil { params = &GetRetainedMessageInput{} diff --git a/service/iotdataplane/api_op_GetThingShadow.go b/service/iotdataplane/api_op_GetThingShadow.go index 82274029ee8..dcb18afd40b 100644 --- a/service/iotdataplane/api_op_GetThingShadow.go +++ b/service/iotdataplane/api_op_GetThingShadow.go @@ -11,10 +11,8 @@ import ( ) // Gets the shadow for the specified thing. Requires permission to access the -// GetThingShadow -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. For more information, see GetThingShadow -// (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html) +// GetThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// action. For more information, see GetThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html) // in the IoT Developer Guide. func (c *Client) GetThingShadow(ctx context.Context, params *GetThingShadowInput, optFns ...func(*Options)) (*GetThingShadowOutput, error) { if params == nil { diff --git a/service/iotdataplane/api_op_ListNamedShadowsForThing.go b/service/iotdataplane/api_op_ListNamedShadowsForThing.go index 88944db0fe0..de4f118d71c 100644 --- a/service/iotdataplane/api_op_ListNamedShadowsForThing.go +++ b/service/iotdataplane/api_op_ListNamedShadowsForThing.go @@ -11,8 +11,7 @@ import ( ) // Lists the shadows for the specified thing. Requires permission to access the -// ListNamedShadowsForThing -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// ListNamedShadowsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListNamedShadowsForThing(ctx context.Context, params *ListNamedShadowsForThingInput, optFns ...func(*Options)) (*ListNamedShadowsForThingOutput, error) { if params == nil { diff --git a/service/iotdataplane/api_op_ListRetainedMessages.go b/service/iotdataplane/api_op_ListRetainedMessages.go index 21ac91cffc4..ddc1df68f3a 100644 --- a/service/iotdataplane/api_op_ListRetainedMessages.go +++ b/service/iotdataplane/api_op_ListRetainedMessages.go @@ -16,13 +16,11 @@ import ( // This action returns only the topic names of the retained messages. It doesn't // return any message payloads. Although this action doesn't return a message // payload, it can still incur messaging costs. To get the message payload of a -// retained message, call GetRetainedMessage -// (https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html) +// retained message, call GetRetainedMessage (https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html) // with the topic name of the retained message. Requires permission to access the -// ListRetainedMessages -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) +// ListRetainedMessages (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) // action. For more information about messaging costs, see Amazon Web Services IoT -// Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging). +// Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging) . func (c *Client) ListRetainedMessages(ctx context.Context, params *ListRetainedMessagesInput, optFns ...func(*Options)) (*ListRetainedMessagesOutput, error) { if params == nil { params = &ListRetainedMessagesInput{} @@ -56,8 +54,8 @@ type ListRetainedMessagesOutput struct { // results. NextToken *string - // A summary list the account's retained messages. The information returned doesn't - // include the message payloads of the retained messages. + // A summary list the account's retained messages. The information returned + // doesn't include the message payloads of the retained messages. RetainedTopics []types.RetainedMessageSummary // Metadata pertaining to the operation's result. diff --git a/service/iotdataplane/api_op_Publish.go b/service/iotdataplane/api_op_Publish.go index 2193f54109c..7299f8ff24d 100644 --- a/service/iotdataplane/api_op_Publish.go +++ b/service/iotdataplane/api_op_Publish.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Publishes an MQTT message. Requires permission to access the Publish -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. For more information about MQTT messages, see MQTT Protocol -// (http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) in the IoT -// Developer Guide. For more information about messaging costs, see Amazon Web -// Services IoT Core pricing - Messaging -// (http://aws.amazon.com/iot-core/pricing/#Messaging). +// Publishes an MQTT message. Requires permission to access the Publish (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// action. For more information about MQTT messages, see MQTT Protocol (http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) +// in the IoT Developer Guide. For more information about messaging costs, see +// Amazon Web Services IoT Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging) +// . func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*PublishOutput, error) { if params == nil { params = &PublishInput{} @@ -51,9 +49,8 @@ type PublishInput struct { // A user-defined integer value that represents the message expiry interval in // seconds. If absent, the message doesn't expire. For more information about the - // limits of messageExpiry, see Amazon Web Services IoT Core message broker and - // protocol limits and quotas - // (https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits) + // limits of messageExpiry , see Amazon Web Services IoT Core message broker and + // protocol limits and quotas (https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits) // from the Amazon Web Services Reference Guide. MessageExpiry int64 @@ -69,10 +66,10 @@ type PublishInput struct { // The Quality of Service (QoS) level. The default QoS level is 0. Qos int32 - // A UTF-8 encoded string that's used as the topic name for a response message. The - // response topic is used to describe the topic which the receiver should publish - // to as part of the request-response flow. The topic must not contain wildcard - // characters. + // A UTF-8 encoded string that's used as the topic name for a response message. + // The response topic is used to describe the topic which the receiver should + // publish to as part of the request-response flow. The topic must not contain + // wildcard characters. ResponseTopic *string // A Boolean value that determines whether to set the RETAIN flag when the message @@ -82,10 +79,10 @@ type PublishInput struct { // A JSON string that contains an array of JSON objects. If you don’t use Amazon // Web Services SDK or CLI, you must encode the JSON string to base64 format before - // adding it to the HTTP header. userProperties is an HTTP header value in the API. - // The following example userProperties parameter is a JSON string which represents - // two User Properties. Note that it needs to be base64-encoded: [{"deviceName": - // "alpha"}, {"deviceCnt": "45"}] + // adding it to the HTTP header. userProperties is an HTTP header value in the + // API. The following example userProperties parameter is a JSON string which + // represents two User Properties. Note that it needs to be base64-encoded: + // [{"deviceName": "alpha"}, {"deviceCnt": "45"}] // // This value conforms to the media type: application/json UserProperties *string diff --git a/service/iotdataplane/api_op_UpdateThingShadow.go b/service/iotdataplane/api_op_UpdateThingShadow.go index 8231f12a2d9..1b9885c9124 100644 --- a/service/iotdataplane/api_op_UpdateThingShadow.go +++ b/service/iotdataplane/api_op_UpdateThingShadow.go @@ -11,10 +11,8 @@ import ( ) // Updates the shadow for the specified thing. Requires permission to access the -// UpdateThingShadow -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. For more information, see UpdateThingShadow -// (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html) +// UpdateThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// action. For more information, see UpdateThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html) // in the IoT Developer Guide. func (c *Client) UpdateThingShadow(ctx context.Context, params *UpdateThingShadowInput, optFns ...func(*Options)) (*UpdateThingShadowOutput, error) { if params == nil { diff --git a/service/iotdataplane/doc.go b/service/iotdataplane/doc.go index 5131e4cad09..fd43f2e6a4f 100644 --- a/service/iotdataplane/doc.go +++ b/service/iotdataplane/doc.go @@ -11,7 +11,6 @@ // things and their state in the Amazon Web Services cloud. Find the endpoint // address for actions in IoT data by running this CLI command: aws iot // describe-endpoint --endpoint-type iot:Data-ATS The service name used by Amazon -// Web ServicesSignature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to sign -// requests is: iotdevicegateway. +// Web ServicesSignature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// to sign requests is: iotdevicegateway. package iotdataplane diff --git a/service/iotdeviceadvisor/api_client.go b/service/iotdeviceadvisor/api_client.go index cb552a8d4ff..df32813e2e5 100644 --- a/service/iotdeviceadvisor/api_client.go +++ b/service/iotdeviceadvisor/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go b/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go index 0c35bfc3a64..d21896b2bae 100644 --- a/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go @@ -13,8 +13,7 @@ import ( ) // Creates a Device Advisor test suite. Requires permission to access the -// CreateSuiteDefinition -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CreateSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CreateSuiteDefinition(ctx context.Context, params *CreateSuiteDefinitionInput, optFns ...func(*Options)) (*CreateSuiteDefinitionOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go b/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go index 246bf208582..e9243d174e6 100644 --- a/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go @@ -11,8 +11,7 @@ import ( ) // Deletes a Device Advisor test suite. Requires permission to access the -// DeleteSuiteDefinition -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// DeleteSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DeleteSuiteDefinition(ctx context.Context, params *DeleteSuiteDefinitionInput, optFns ...func(*Options)) (*DeleteSuiteDefinitionOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go b/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go index 003ae32b38c..44360a66d64 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a Device Advisor test suite. Requires permission to -// access the GetSuiteDefinition -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the GetSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetSuiteDefinition(ctx context.Context, params *GetSuiteDefinitionInput, optFns ...func(*Options)) (*GetSuiteDefinitionOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_GetSuiteRun.go b/service/iotdeviceadvisor/api_op_GetSuiteRun.go index c8fe135bdd3..d0bc4f4ede8 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteRun.go @@ -13,8 +13,7 @@ import ( ) // Gets information about a Device Advisor test suite run. Requires permission to -// access the GetSuiteRun -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the GetSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetSuiteRun(ctx context.Context, params *GetSuiteRunInput, optFns ...func(*Options)) (*GetSuiteRunOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go b/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go index 856e2ad4bbb..b444a16e711 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go @@ -11,8 +11,7 @@ import ( ) // Gets a report download link for a successful Device Advisor qualifying test -// suite run. Requires permission to access the GetSuiteRunReport -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// suite run. Requires permission to access the GetSuiteRunReport (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) GetSuiteRunReport(ctx context.Context, params *GetSuiteRunReportInput, optFns ...func(*Options)) (*GetSuiteRunReportOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go b/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go index 7df7e9ebacd..f74860fe4d8 100644 --- a/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go +++ b/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go @@ -13,8 +13,7 @@ import ( ) // Lists the Device Advisor test suites you have created. Requires permission to -// access the ListSuiteDefinitions -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// access the ListSuiteDefinitions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListSuiteDefinitions(ctx context.Context, params *ListSuiteDefinitionsInput, optFns ...func(*Options)) (*ListSuiteDefinitionsOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_ListSuiteRuns.go b/service/iotdeviceadvisor/api_op_ListSuiteRuns.go index 8abb47178a2..9be028e0f3e 100644 --- a/service/iotdeviceadvisor/api_op_ListSuiteRuns.go +++ b/service/iotdeviceadvisor/api_op_ListSuiteRuns.go @@ -14,8 +14,7 @@ import ( // Lists runs of the specified Device Advisor test suite. You can list all runs of // the test suite, or the runs of a specific version of the test suite. Requires -// permission to access the ListSuiteRuns -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the ListSuiteRuns (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListSuiteRuns(ctx context.Context, params *ListSuiteRunsInput, optFns ...func(*Options)) (*ListSuiteRunsOutput, error) { if params == nil { @@ -44,7 +43,7 @@ type ListSuiteRunsInput struct { // ID. SuiteDefinitionId *string - // Must be passed along with suiteDefinitionId. Lists the test suite runs of the + // Must be passed along with suiteDefinitionId . Lists the test suite runs of the // specified test suite based on suite definition version. SuiteDefinitionVersion *string diff --git a/service/iotdeviceadvisor/api_op_ListTagsForResource.go b/service/iotdeviceadvisor/api_op_ListTagsForResource.go index 932e8bc37d5..3df2fff3c27 100644 --- a/service/iotdeviceadvisor/api_op_ListTagsForResource.go +++ b/service/iotdeviceadvisor/api_op_ListTagsForResource.go @@ -11,8 +11,7 @@ import ( ) // Lists the tags attached to an IoT Device Advisor resource. Requires permission -// to access the ListTagsForResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// to access the ListTagsForResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -31,8 +30,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition - // ARN or SuiteRun ARN. + // The resource ARN of the IoT Device Advisor resource. This can be + // SuiteDefinition ARN or SuiteRun ARN. // // This member is required. ResourceArn *string diff --git a/service/iotdeviceadvisor/api_op_StartSuiteRun.go b/service/iotdeviceadvisor/api_op_StartSuiteRun.go index c96d8a5249e..b3bb91d4b9d 100644 --- a/service/iotdeviceadvisor/api_op_StartSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_StartSuiteRun.go @@ -13,8 +13,7 @@ import ( ) // Starts a Device Advisor test suite run. Requires permission to access the -// StartSuiteRun -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// StartSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StartSuiteRun(ctx context.Context, params *StartSuiteRunInput, optFns ...func(*Options)) (*StartSuiteRunOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_StopSuiteRun.go b/service/iotdeviceadvisor/api_op_StopSuiteRun.go index 9723ac8c945..b69c9d166fc 100644 --- a/service/iotdeviceadvisor/api_op_StopSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_StopSuiteRun.go @@ -11,8 +11,7 @@ import ( ) // Stops a Device Advisor test suite run that is currently running. Requires -// permission to access the StopSuiteRun -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the StopSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) StopSuiteRun(ctx context.Context, params *StopSuiteRunInput, optFns ...func(*Options)) (*StopSuiteRunOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_TagResource.go b/service/iotdeviceadvisor/api_op_TagResource.go index ff92087e965..ba311203d32 100644 --- a/service/iotdeviceadvisor/api_op_TagResource.go +++ b/service/iotdeviceadvisor/api_op_TagResource.go @@ -11,8 +11,7 @@ import ( ) // Adds to and modifies existing tags of an IoT Device Advisor resource. Requires -// permission to access the TagResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the TagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_UntagResource.go b/service/iotdeviceadvisor/api_op_UntagResource.go index c0bac19b745..e1f0a7b5193 100644 --- a/service/iotdeviceadvisor/api_op_UntagResource.go +++ b/service/iotdeviceadvisor/api_op_UntagResource.go @@ -11,8 +11,7 @@ import ( ) // Removes tags from an IoT Device Advisor resource. Requires permission to access -// the UntagResource -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// the UntagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go b/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go index 84136975a88..a07dbfbe517 100644 --- a/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go @@ -13,8 +13,7 @@ import ( ) // Updates a Device Advisor test suite. Requires permission to access the -// UpdateSuiteDefinition -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// UpdateSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) UpdateSuiteDefinition(ctx context.Context, params *UpdateSuiteDefinitionInput, optFns ...func(*Options)) (*UpdateSuiteDefinitionOutput, error) { if params == nil { diff --git a/service/iotdeviceadvisor/doc.go b/service/iotdeviceadvisor/doc.go index c24f2e441ff..81535f2a1ba 100644 --- a/service/iotdeviceadvisor/doc.go +++ b/service/iotdeviceadvisor/doc.go @@ -3,10 +3,10 @@ // Package iotdeviceadvisor provides the API client, operations, and parameter // types for AWS IoT Core Device Advisor. // -// Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test -// capability for validating IoT devices during device software development. Device -// Advisor provides pre-built tests that you can use to validate IoT devices for -// reliable and secure connectivity with Amazon Web Services IoT Core before +// Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed +// test capability for validating IoT devices during device software development. +// Device Advisor provides pre-built tests that you can use to validate IoT devices +// for reliable and secure connectivity with Amazon Web Services IoT Core before // deploying devices to production. By using Device Advisor, you can confirm that // your devices can connect to Amazon Web Services IoT Core, follow security best // practices and, if applicable, receive software updates from IoT Device diff --git a/service/iotdeviceadvisor/types/types.go b/service/iotdeviceadvisor/types/types.go index e29556f2936..f0992001de2 100644 --- a/service/iotdeviceadvisor/types/types.go +++ b/service/iotdeviceadvisor/types/types.go @@ -113,8 +113,7 @@ type SuiteRunConfiguration struct { } // Information about the suite run. Requires permission to access the -// SuiteRunInformation -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// SuiteRunInformation (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. type SuiteRunInformation struct { @@ -167,28 +166,16 @@ type TestCaseRun struct { StartTime *time.Time // Provides the test case run status. Status is one of the following: - // - // * PASS: Test - // passed. - // - // * FAIL: Test failed. - // - // * PENDING: Test has not started running but is - // scheduled. - // - // * RUNNING: Test is running. - // - // * STOPPING: Test is performing cleanup - // steps. You will see this status only if you stop a suite run. - // - // * STOPPED Test is - // stopped. You will see this status only if you stop a suite run. - // - // * - // PASS_WITH_WARNINGS: Test passed with warnings. - // - // * ERORR: Test faced an error - // when running due to an internal issue. + // - PASS : Test passed. + // - FAIL : Test failed. + // - PENDING : Test has not started running but is scheduled. + // - RUNNING : Test is running. + // - STOPPING : Test is performing cleanup steps. You will see this status only + // if you stop a suite run. + // - STOPPED Test is stopped. You will see this status only if you stop a suite + // run. + // - PASS_WITH_WARNINGS : Test passed with warnings. + // - ERORR : Test faced an error when running due to an internal issue. Status Status // Provides the test case run definition ID. @@ -216,28 +203,16 @@ type TestCaseScenario struct { Failure *string // Provides the test case scenario status. Status is one of the following: - // - // * PASS: - // Test passed. - // - // * FAIL: Test failed. - // - // * PENDING: Test has not started running but - // is scheduled. - // - // * RUNNING: Test is running. - // - // * STOPPING: Test is performing - // cleanup steps. You will see this status only if you stop a suite run. - // - // * STOPPED - // Test is stopped. You will see this status only if you stop a suite run. - // - // * - // PASS_WITH_WARNINGS: Test passed with warnings. - // - // * ERORR: Test faced an error - // when running due to an internal issue. + // - PASS : Test passed. + // - FAIL : Test failed. + // - PENDING : Test has not started running but is scheduled. + // - RUNNING : Test is running. + // - STOPPING : Test is performing cleanup steps. You will see this status only + // if you stop a suite run. + // - STOPPED Test is stopped. You will see this status only if you stop a suite + // run. + // - PASS_WITH_WARNINGS : Test passed with warnings. + // - ERORR : Test faced an error when running due to an internal issue. Status TestCaseScenarioStatus // @@ -247,11 +222,8 @@ type TestCaseScenario struct { TestCaseScenarioId *string // Provides test case scenario type. Type is one of the following: - // - // * Advanced - // - // * - // Basic + // - Advanced + // - Basic TestCaseScenarioType TestCaseScenarioType noSmithyDocumentSerde diff --git a/service/iotevents/api_client.go b/service/iotevents/api_client.go index 718dc1825e5..c3adcd63ba6 100644 --- a/service/iotevents/api_client.go +++ b/service/iotevents/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotevents/api_op_CreateAlarmModel.go b/service/iotevents/api_op_CreateAlarmModel.go index 0685bc59cb0..fad8f36991f 100644 --- a/service/iotevents/api_op_CreateAlarmModel.go +++ b/service/iotevents/api_op_CreateAlarmModel.go @@ -12,10 +12,9 @@ import ( "time" ) -// Creates an alarm model to monitor an AWS IoT Events input attribute. You can use -// the alarm to get notified when the value is outside a specified range. For more -// information, see Create an alarm model -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) +// Creates an alarm model to monitor an AWS IoT Events input attribute. You can +// use the alarm to get notified when the value is outside a specified range. For +// more information, see Create an alarm model (https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) // in the AWS IoT Events Developer Guide. func (c *Client) CreateAlarmModel(ctx context.Context, params *CreateAlarmModelInput, optFns ...func(*Options)) (*CreateAlarmModelOutput, error) { if params == nil { @@ -46,9 +45,8 @@ type CreateAlarmModelInput struct { AlarmRule *types.AlarmRule // The ARN of the IAM role that allows the alarm to perform actions and access AWS - // resources. For more information, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. // // This member is required. RoleArn *string @@ -66,8 +64,7 @@ type CreateAlarmModelInput struct { AlarmNotification *types.AlarmNotification // An input attribute used as a key to create an alarm. AWS IoT Events routes - // inputs - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) + // inputs (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) // associated with this key to the alarm. Key *string @@ -76,8 +73,7 @@ type CreateAlarmModelInput struct { // A list of key-value pairs that contain metadata for the alarm model. The tags // help you manage the alarm model. For more information, see Tagging your AWS IoT - // Events resources - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) + // Events resources (https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) // in the AWS IoT Events Developer Guide. You can create up to 50 tags for one // alarm model. Tags []types.Tag @@ -88,9 +84,8 @@ type CreateAlarmModelInput struct { type CreateAlarmModelOutput struct { // The ARN of the alarm model. For more information, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. AlarmModelArn *string // The version of the alarm model. @@ -103,20 +98,13 @@ type CreateAlarmModelOutput struct { LastUpdateTime *time.Time // The status of the alarm model. The status can be one of the following values: - // - // * - // ACTIVE - The alarm model is active and it's ready to evaluate data. - // - // * - // ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm - // model can take up to a few minutes. - // - // * INACTIVE - The alarm model is inactive, - // so it isn't ready to evaluate data. Check your alarm model information and - // update the alarm model. - // - // * FAILED - You couldn't create or update the alarm - // model. Check your alarm model information and try again. + // - ACTIVE - The alarm model is active and it's ready to evaluate data. + // - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an + // alarm model can take up to a few minutes. + // - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. + // Check your alarm model information and update the alarm model. + // - FAILED - You couldn't create or update the alarm model. Check your alarm + // model information and try again. Status types.AlarmModelVersionStatus // Metadata pertaining to the operation's result. diff --git a/service/iotevents/api_op_CreateDetectorModel.go b/service/iotevents/api_op_CreateDetectorModel.go index fa853918019..a2447bf32cb 100644 --- a/service/iotevents/api_op_CreateDetectorModel.go +++ b/service/iotevents/api_op_CreateDetectorModel.go @@ -52,11 +52,11 @@ type CreateDetectorModelInput struct { // executed. EvaluationMethod types.EvaluationMethod - // The input attribute key used to identify a device or system to create a detector - // (an instance of the detector model) and then to route each input received to the - // appropriate detector (instance). This parameter uses a JSON-path expression in - // the message payload of each input to specify the attribute-value pair that is - // used to identify the device associated with the input. + // The input attribute key used to identify a device or system to create a + // detector (an instance of the detector model) and then to route each input + // received to the appropriate detector (instance). This parameter uses a JSON-path + // expression in the message payload of each input to specify the attribute-value + // pair that is used to identify the device associated with the input. Key *string // Metadata that can be used to manage the detector model. diff --git a/service/iotevents/api_op_DescribeAlarmModel.go b/service/iotevents/api_op_DescribeAlarmModel.go index 0dc7bb239a2..0ac7d03c70c 100644 --- a/service/iotevents/api_op_DescribeAlarmModel.go +++ b/service/iotevents/api_op_DescribeAlarmModel.go @@ -12,8 +12,8 @@ import ( "time" ) -// Retrieves information about an alarm model. If you don't specify a value for the -// alarmModelVersion parameter, the latest version is returned. +// Retrieves information about an alarm model. If you don't specify a value for +// the alarmModelVersion parameter, the latest version is returned. func (c *Client) DescribeAlarmModel(ctx context.Context, params *DescribeAlarmModelInput, optFns ...func(*Options)) (*DescribeAlarmModelOutput, error) { if params == nil { params = &DescribeAlarmModelInput{} @@ -51,9 +51,8 @@ type DescribeAlarmModelOutput struct { AlarmEventActions *types.AlarmEventActions // The ARN of the alarm model. For more information, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. AlarmModelArn *string // The description of the alarm model. @@ -75,8 +74,7 @@ type DescribeAlarmModelOutput struct { CreationTime *time.Time // An input attribute used as a key to create an alarm. AWS IoT Events routes - // inputs - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) + // inputs (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) // associated with this key to the alarm. Key *string @@ -84,29 +82,21 @@ type DescribeAlarmModelOutput struct { LastUpdateTime *time.Time // The ARN of the IAM role that allows the alarm to perform actions and access AWS - // resources. For more information, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. RoleArn *string // A non-negative integer that reflects the severity level of the alarm. Severity *int32 // The status of the alarm model. The status can be one of the following values: - // - // * - // ACTIVE - The alarm model is active and it's ready to evaluate data. - // - // * - // ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm - // model can take up to a few minutes. - // - // * INACTIVE - The alarm model is inactive, - // so it isn't ready to evaluate data. Check your alarm model information and - // update the alarm model. - // - // * FAILED - You couldn't create or update the alarm - // model. Check your alarm model information and try again. + // - ACTIVE - The alarm model is active and it's ready to evaluate data. + // - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an + // alarm model can take up to a few minutes. + // - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. + // Check your alarm model information and update the alarm model. + // - FAILED - You couldn't create or update the alarm model. Check your alarm + // model information and try again. Status types.AlarmModelVersionStatus // Contains information about the status of the alarm model. diff --git a/service/iotevents/api_op_DescribeDetectorModelAnalysis.go b/service/iotevents/api_op_DescribeDetectorModelAnalysis.go index f7f080d629c..f519933fb47 100644 --- a/service/iotevents/api_op_DescribeDetectorModelAnalysis.go +++ b/service/iotevents/api_op_DescribeDetectorModelAnalysis.go @@ -43,15 +43,11 @@ type DescribeDetectorModelAnalysisOutput struct { // The status of the analysis activity. The status can be one of the following // values: - // - // * RUNNING - AWS IoT Events is analyzing your detector model. This - // process can take several minutes to complete. - // - // * COMPLETE - AWS IoT Events - // finished analyzing your detector model. - // - // * FAILED - AWS IoT Events couldn't - // analyze your detector model. Try again later. + // - RUNNING - AWS IoT Events is analyzing your detector model. This process can + // take several minutes to complete. + // - COMPLETE - AWS IoT Events finished analyzing your detector model. + // - FAILED - AWS IoT Events couldn't analyze your detector model. Try again + // later. Status types.AnalysisStatus // Metadata pertaining to the operation's result. diff --git a/service/iotevents/api_op_ListAlarmModels.go b/service/iotevents/api_op_ListAlarmModels.go index f9322e827e4..fed2c6fc8f4 100644 --- a/service/iotevents/api_op_ListAlarmModels.go +++ b/service/iotevents/api_op_ListAlarmModels.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the alarm models that you created. The operation returns only the metadata -// associated with each alarm model. +// Lists the alarm models that you created. The operation returns only the +// metadata associated with each alarm model. func (c *Client) ListAlarmModels(ctx context.Context, params *ListAlarmModelsInput, optFns ...func(*Options)) (*ListAlarmModelsOutput, error) { if params == nil { params = &ListAlarmModelsInput{} diff --git a/service/iotevents/api_op_StartDetectorModelAnalysis.go b/service/iotevents/api_op_StartDetectorModelAnalysis.go index 4b96d1328ce..7c82d67f760 100644 --- a/service/iotevents/api_op_StartDetectorModelAnalysis.go +++ b/service/iotevents/api_op_StartDetectorModelAnalysis.go @@ -12,8 +12,7 @@ import ( ) // Performs an analysis of your detector model. For more information, see -// Troubleshooting a detector model -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) +// Troubleshooting a detector model (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) // in the AWS IoT Events Developer Guide. func (c *Client) StartDetectorModelAnalysis(ctx context.Context, params *StartDetectorModelAnalysisInput, optFns ...func(*Options)) (*StartDetectorModelAnalysisOutput, error) { if params == nil { diff --git a/service/iotevents/api_op_UpdateAlarmModel.go b/service/iotevents/api_op_UpdateAlarmModel.go index 3734fdcba10..e78e58c8c90 100644 --- a/service/iotevents/api_op_UpdateAlarmModel.go +++ b/service/iotevents/api_op_UpdateAlarmModel.go @@ -42,9 +42,8 @@ type UpdateAlarmModelInput struct { AlarmRule *types.AlarmRule // The ARN of the IAM role that allows the alarm to perform actions and access AWS - // resources. For more information, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. // // This member is required. RoleArn *string @@ -70,9 +69,8 @@ type UpdateAlarmModelInput struct { type UpdateAlarmModelOutput struct { // The ARN of the alarm model. For more information, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. AlarmModelArn *string // The version of the alarm model. @@ -85,20 +83,13 @@ type UpdateAlarmModelOutput struct { LastUpdateTime *time.Time // The status of the alarm model. The status can be one of the following values: - // - // * - // ACTIVE - The alarm model is active and it's ready to evaluate data. - // - // * - // ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm - // model can take up to a few minutes. - // - // * INACTIVE - The alarm model is inactive, - // so it isn't ready to evaluate data. Check your alarm model information and - // update the alarm model. - // - // * FAILED - You couldn't create or update the alarm - // model. Check your alarm model information and try again. + // - ACTIVE - The alarm model is active and it's ready to evaluate data. + // - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an + // alarm model can take up to a few minutes. + // - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. + // Check your alarm model information and update the alarm model. + // - FAILED - You couldn't create or update the alarm model. Check your alarm + // model information and try again. Status types.AlarmModelVersionStatus // Metadata pertaining to the operation's result. diff --git a/service/iotevents/types/enums.go b/service/iotevents/types/enums.go index e650e8b6a01..8768dcca95c 100644 --- a/service/iotevents/types/enums.go +++ b/service/iotevents/types/enums.go @@ -167,9 +167,9 @@ const ( LoggingLevelDebug LoggingLevel = "DEBUG" ) -// Values returns all known values for LoggingLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LoggingLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LoggingLevel) Values() []LoggingLevel { return []LoggingLevel{ "ERROR", diff --git a/service/iotevents/types/types.go b/service/iotevents/types/types.go index c21831ee86e..5297324f097 100644 --- a/service/iotevents/types/types.go +++ b/service/iotevents/types/types.go @@ -10,11 +10,11 @@ import ( // Specifies whether to get notified for alarm state changes. type AcknowledgeFlow struct { - // The value must be TRUE or FALSE. If TRUE, you receive a notification when the + // The value must be TRUE or FALSE . If TRUE , you receive a notification when the // alarm state changes. You must choose to acknowledge the notification before the - // alarm state can return to NORMAL. If FALSE, you won't receive notifications. The - // alarm automatically changes to the NORMAL state when the input property value - // returns to the specified range. + // alarm state can return to NORMAL . If FALSE , you won't receive notifications. + // The alarm automatically changes to the NORMAL state when the input property + // value returns to the specified range. // // This member is required. Enabled *bool @@ -31,35 +31,31 @@ type Action struct { // Writes to the DynamoDB table that you created. The default action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event that triggered the action. You can customize the - // payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). - // One column of the DynamoDB table receives all attribute-value pairs in the - // payload that you specify. For more information, see Actions - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) + // payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) + // . One column of the DynamoDB table receives all attribute-value pairs in the + // payload that you specify. For more information, see Actions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) // in AWS IoT Events Developer Guide. DynamoDB *DynamoDBAction // Writes to the DynamoDB table that you created. The default action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event that triggered the action. You can customize the - // payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A - // separate column of the DynamoDB table receives one attribute-value pair in the - // payload that you specify. For more information, see Actions - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) + // payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) + // . A separate column of the DynamoDB table receives one attribute-value pair in + // the payload that you specify. For more information, see Actions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) // in AWS IoT Events Developer Guide. DynamoDBv2 *DynamoDBv2Action - // Sends information about the detector model instance and the event that triggered - // the action to an Amazon Kinesis Data Firehose delivery stream. + // Sends information about the detector model instance and the event that + // triggered the action to an Amazon Kinesis Data Firehose delivery stream. Firehose *FirehoseAction // Sends AWS IoT Events input, which passes information about the detector model // instance and the event that triggered the action. IotEvents *IotEventsAction - // Sends information about the detector model instance and the event that triggered - // the action to an asset property in AWS IoT SiteWise . + // Sends information about the detector model instance and the event that + // triggered the action to an asset property in AWS IoT SiteWise . IotSiteWise *IotSiteWiseAction // Publishes an MQTT message with the given topic to the AWS IoT message broker. @@ -81,8 +77,8 @@ type Action struct { // Sends an Amazon SNS message. Sns *SNSTopicPublishAction - // Sends information about the detector model instance and the event that triggered - // the action to an Amazon SQS queue. + // Sends information about the detector model instance and the event that + // triggered the action to an Amazon SQS queue. Sqs *SqsAction noSmithyDocumentSerde @@ -94,115 +90,92 @@ type AlarmAction struct { // Defines an action to write to the Amazon DynamoDB table that you created. The // standard action payload contains all the information about the detector model - // instance and the event that triggered the action. You can customize the payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). - // One column of the DynamoDB table receives all attribute-value pairs in the + // instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) + // . One column of the DynamoDB table receives all attribute-value pairs in the // payload that you specify. You must use expressions for all parameters in - // DynamoDBAction. The expressions accept literals, operators, functions, + // DynamoDBAction . The expressions accept literals, operators, functions, // references, and substitution templates. Examples - // - // * For literal values, the - // expressions must contain single quotes. For example, the value for the - // hashKeyType parameter can be 'STRING'. - // - // * For references, you must specify - // either variables or input values. For example, the value for the hashKeyField - // parameter can be $input.GreenhouseInput.name. - // - // * For a substitution template, - // you must use ${}, and the template must be in single quotes. A substitution - // template can also contain a combination of literals, operators, functions, - // references, and substitution templates. In the following example, the value for - // the hashKeyValue parameter uses a substitution template. - // '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' - // - // * For a - // string concatenation, you must use +. A string concatenation can also contain a - // combination of literals, operators, functions, references, and substitution - // templates. In the following example, the value for the tableName parameter uses - // a string concatenation. 'GreenhouseTemperatureTable ' + - // $input.GreenhouseInput.date - // - // For more information, see Expressions - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) + // - For literal values, the expressions must contain single quotes. For + // example, the value for the hashKeyType parameter can be 'STRING' . + // - For references, you must specify either variables or input values. For + // example, the value for the hashKeyField parameter can be + // $input.GreenhouseInput.name . + // - For a substitution template, you must use ${} , and the template must be in + // single quotes. A substitution template can also contain a combination of + // literals, operators, functions, references, and substitution templates. In the + // following example, the value for the hashKeyValue parameter uses a + // substitution template. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} + // in Fahrenheit' + // - For a string concatenation, you must use + . A string concatenation can also + // contain a combination of literals, operators, functions, references, and + // substitution templates. In the following example, the value for the tableName + // parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + + // $input.GreenhouseInput.date + // For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. If the defined payload type is a string, // DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The // DynamoDB console displays the data as Base64-encoded text. The value for the - // payloadField parameter is _raw. + // payloadField parameter is _raw . DynamoDB *DynamoDBAction // Defines an action to write to the Amazon DynamoDB table that you created. The // default action payload contains all the information about the detector model - // instance and the event that triggered the action. You can customize the payload - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A - // separate column of the DynamoDB table receives one attribute-value pair in the - // payload that you specify. You must use expressions for all parameters in - // DynamoDBv2Action. The expressions accept literals, operators, functions, + // instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) + // . A separate column of the DynamoDB table receives one attribute-value pair in + // the payload that you specify. You must use expressions for all parameters in + // DynamoDBv2Action . The expressions accept literals, operators, functions, // references, and substitution templates. Examples - // - // * For literal values, the - // expressions must contain single quotes. For example, the value for the tableName - // parameter can be 'GreenhouseTemperatureTable'. - // - // * For references, you must - // specify either variables or input values. For example, the value for the - // tableName parameter can be $variable.ddbtableName. - // - // * For a substitution - // template, you must use ${}, and the template must be in single quotes. A - // substitution template can also contain a combination of literals, operators, - // functions, references, and substitution templates. In the following example, the - // value for the contentExpression parameter in Payload uses a substitution - // template. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", - // \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' - // - // * For - // a string concatenation, you must use +. A string concatenation can also contain - // a combination of literals, operators, functions, references, and substitution - // templates. In the following example, the value for the tableName parameter uses - // a string concatenation. 'GreenhouseTemperatureTable ' + - // $input.GreenhouseInput.date - // - // For more information, see Expressions - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) + // - For literal values, the expressions must contain single quotes. For + // example, the value for the tableName parameter can be + // 'GreenhouseTemperatureTable' . + // - For references, you must specify either variables or input values. For + // example, the value for the tableName parameter can be $variable.ddbtableName . + // - For a substitution template, you must use ${} , and the template must be in + // single quotes. A substitution template can also contain a combination of + // literals, operators, functions, references, and substitution templates. In the + // following example, the value for the contentExpression parameter in Payload + // uses a substitution template. '{\"sensorID\": + // \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": + // \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' + // - For a string concatenation, you must use + . A string concatenation can also + // contain a combination of literals, operators, functions, references, and + // substitution templates. In the following example, the value for the tableName + // parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + + // $input.GreenhouseInput.date + // For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. The value for the type parameter in - // Payload must be JSON. + // Payload must be JSON . DynamoDBv2 *DynamoDBv2Action - // Sends information about the detector model instance and the event that triggered - // the action to an Amazon Kinesis Data Firehose delivery stream. + // Sends information about the detector model instance and the event that + // triggered the action to an Amazon Kinesis Data Firehose delivery stream. Firehose *FirehoseAction // Sends an AWS IoT Events input, passing in information about the detector model // instance and the event that triggered the action. IotEvents *IotEventsAction - // Sends information about the detector model instance and the event that triggered - // the action to a specified asset property in AWS IoT SiteWise. You must use - // expressions for all parameters in IotSiteWiseAction. The expressions accept + // Sends information about the detector model instance and the event that + // triggered the action to a specified asset property in AWS IoT SiteWise. You must + // use expressions for all parameters in IotSiteWiseAction . The expressions accept // literals, operators, functions, references, and substitutions templates. // Examples - // - // * For literal values, the expressions must contain single quotes. For - // example, the value for the propertyAlias parameter can be - // '/company/windfarm/3/turbine/7/temperature'. - // - // * For references, you must specify - // either variables or input values. For example, the value for the assetId - // parameter can be $input.TurbineInput.assetId1. - // - // * For a substitution template, - // you must use ${}, and the template must be in single quotes. A substitution - // template can also contain a combination of literals, operators, functions, - // references, and substitution templates. In the following example, the value for - // the propertyAlias parameter uses a substitution template. - // 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ - // ${$input.TemperatureInput.sensorData.turbineID}/temperature' - // - // You must specify - // either propertyAlias or both assetId and propertyId to identify the target asset - // property in AWS IoT SiteWise. For more information, see Expressions - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) + // - For literal values, the expressions must contain single quotes. For + // example, the value for the propertyAlias parameter can be + // '/company/windfarm/3/turbine/7/temperature' . + // - For references, you must specify either variables or input values. For + // example, the value for the assetId parameter can be + // $input.TurbineInput.assetId1 . + // - For a substitution template, you must use ${} , and the template must be in + // single quotes. A substitution template can also contain a combination of + // literals, operators, functions, references, and substitution templates. In the + // following example, the value for the propertyAlias parameter uses a + // substitution template. + // 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ + // ${$input.TemperatureInput.sensorData.turbineID}/temperature' + // You must specify either propertyAlias or both assetId and propertyId to + // identify the target asset property in AWS IoT SiteWise. For more information, + // see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. IotSiteWise *IotSiteWiseAction @@ -217,8 +190,8 @@ type AlarmAction struct { // Information required to publish the Amazon SNS message. Sns *SNSTopicPublishAction - // Sends information about the detector model instance and the event that triggered - // the action to an Amazon SQS queue. + // Sends information about the detector model instance and the event that + // triggered the action to an Amazon SQS queue. Sqs *SqsAction noSmithyDocumentSerde @@ -266,9 +239,8 @@ type AlarmModelSummary struct { type AlarmModelVersionSummary struct { // The ARN of the alarm model. For more information, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. AlarmModelArn *string // The name of the alarm model. @@ -284,26 +256,18 @@ type AlarmModelVersionSummary struct { LastUpdateTime *time.Time // The ARN of the IAM role that allows the alarm to perform actions and access AWS - // resources. For more information, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. RoleArn *string // The status of the alarm model. The status can be one of the following values: - // - // * - // ACTIVE - The alarm model is active and it's ready to evaluate data. - // - // * - // ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm - // model can take up to a few minutes. - // - // * INACTIVE - The alarm model is inactive, - // so it isn't ready to evaluate data. Check your alarm model information and - // update the alarm model. - // - // * FAILED - You couldn't create or update the alarm - // model. Check your alarm model information and try again. + // - ACTIVE - The alarm model is active and it's ready to evaluate data. + // - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an + // alarm model can take up to a few minutes. + // - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. + // Check your alarm model information and update the alarm model. + // - FAILED - You couldn't create or update the alarm model. Check your alarm + // model information and try again. Status AlarmModelVersionStatus // Contains information about the status of the alarm model version. @@ -335,22 +299,16 @@ type AlarmRule struct { // Contains the result of the analysis. type AnalysisResult struct { - // The severity level of the analysis result. Based on the severity level, analysis - // results fall into three general categories: - // - // * INFO - An information result - // tells you about a significant field in your detector model. This type of result - // usually doesn't require immediate action. - // - // * WARNING - A warning result draws - // special attention to fields that might cause issues for your detector model. We - // recommend that you review warnings and take necessary actions before you use - // your detector model in production environments. Otherwise, the detector model - // might not work as expected. - // - // * ERROR - An error result notifies you about a - // problem found in your detector model. You must fix all errors before you can - // publish your detector model. + // The severity level of the analysis result. Based on the severity level, + // analysis results fall into three general categories: + // - INFO - An information result tells you about a significant field in your + // detector model. This type of result usually doesn't require immediate action. + // - WARNING - A warning result draws special attention to fields that might + // cause issues for your detector model. We recommend that you review warnings and + // take necessary actions before you use your detector model in production + // environments. Otherwise, the detector model might not work as expected. + // - ERROR - An error result notifies you about a problem found in your detector + // model. You must fix all errors before you can publish your detector model. Level AnalysisResultLevel // Contains one or more locations that you can use to locate the fields in your @@ -360,43 +318,29 @@ type AnalysisResult struct { // Contains additional information about the analysis result. Message *string - // The type of the analysis result. Analyses fall into the following types based on - // the validators used to generate the analysis result: - // - // * supported-actions - You - // must specify AWS IoT Events supported actions that work with other AWS services - // in a supported AWS Region. - // - // * service-limits - Resources or API operations can't - // exceed service quotas (also known as limits). Update your detector model or - // request a quota increase. - // - // * structure - The detector model must follow a - // structure that AWS IoT Events supports. - // - // * expression-syntax - Your expression - // must follow the required syntax. - // - // * data-type - Data types referenced in the - // detector model must be compatible. - // - // * referenced-data - You must define the data - // referenced in your detector model before you can use the data. - // - // * - // referenced-resource - Resources that the detector model uses must be - // available. - // - // For more information, see Running detector model analyses - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) + // The type of the analysis result. Analyses fall into the following types based + // on the validators used to generate the analysis result: + // - supported-actions - You must specify AWS IoT Events supported actions that + // work with other AWS services in a supported AWS Region. + // - service-limits - Resources or API operations can't exceed service quotas + // (also known as limits). Update your detector model or request a quota increase. + // - structure - The detector model must follow a structure that AWS IoT Events + // supports. + // - expression-syntax - Your expression must follow the required syntax. + // - data-type - Data types referenced in the detector model must be compatible. + // - referenced-data - You must define the data referenced in your detector model + // before you can use the data. + // - referenced-resource - Resources that the detector model uses must be + // available. + // For more information, see Running detector model analyses (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) // in the AWS IoT Events Developer Guide. Type *string noSmithyDocumentSerde } -// Contains information that you can use to locate the field in your detector model -// that the analysis result references. +// Contains information that you can use to locate the field in your detector +// model that the analysis result references. type AnalysisResultLocation struct { // A JsonPath (https://github.com/json-path/JsonPath) expression that identifies @@ -407,30 +351,22 @@ type AnalysisResultLocation struct { } // A structure that contains timestamp information. For more information, see -// TimeInNanos -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) +// TimeInNanos (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) // in the AWS IoT SiteWise API Reference. You must use expressions for all -// parameters in AssetPropertyTimestamp. The expressions accept literals, +// parameters in AssetPropertyTimestamp . The expressions accept literals, // operators, functions, references, and substitution templates. Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the timeInSeconds parameter can be '1586400675' . +// - For references, you must specify either variables or input values. For +// example, the value for the offsetInNanos parameter can be $variable.time . +// - For a substitution template, you must use ${} , and the template must be in +// single quotes. A substitution template can also contain a combination of +// literals, operators, functions, references, and substitution templates. In the +// following example, the value for the timeInSeconds parameter uses a +// substitution template. '${$input.TemperatureInput.sensorData.timestamp / +// 1000}' // -// * For -// literal values, the expressions must contain single quotes. For example, the -// value for the timeInSeconds parameter can be '1586400675'. -// -// * For references, -// you must specify either variables or input values. For example, the value for -// the offsetInNanos parameter can be $variable.time. -// -// * For a substitution -// template, you must use ${}, and the template must be in single quotes. A -// substitution template can also contain a combination of literals, operators, -// functions, references, and substitution templates. In the following example, the -// value for the timeInSeconds parameter uses a substitution template. -// '${$input.TemperatureInput.sensorData.timestamp / 1000}' -// -// For more information, -// see Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. type AssetPropertyTimestamp struct { @@ -440,7 +376,7 @@ type AssetPropertyTimestamp struct { // This member is required. TimeInSeconds *string - // The nanosecond offset converted from timeInSeconds. The valid range is between + // The nanosecond offset converted from timeInSeconds . The valid range is between // 0-999999999. OffsetInNanos *string @@ -448,28 +384,22 @@ type AssetPropertyTimestamp struct { } // A structure that contains value information. For more information, see -// AssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) +// AssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) // in the AWS IoT SiteWise API Reference. You must use expressions for all -// parameters in AssetPropertyValue. The expressions accept literals, operators, +// parameters in AssetPropertyValue . The expressions accept literals, operators, // functions, references, and substitution templates. Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the quality parameter can be 'GOOD' . +// - For references, you must specify either variables or input values. For +// example, the value for the quality parameter can be +// $input.TemperatureInput.sensorData.quality . // -// * For literal -// values, the expressions must contain single quotes. For example, the value for -// the quality parameter can be 'GOOD'. -// -// * For references, you must specify either -// variables or input values. For example, the value for the quality parameter can -// be $input.TemperatureInput.sensorData.quality. -// -// For more information, see -// Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. type AssetPropertyValue struct { - // The quality of the asset property value. The value must be 'GOOD', 'BAD', or - // 'UNCERTAIN'. + // The quality of the asset property value. The value must be 'GOOD' , 'BAD' , or + // 'UNCERTAIN' . Quality *string // The timestamp associated with the asset property value. The default is the @@ -483,38 +413,28 @@ type AssetPropertyValue struct { } // A structure that contains an asset property value. For more information, see -// Variant -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) +// Variant (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) // in the AWS IoT SiteWise API Reference. You must use expressions for all -// parameters in AssetPropertyVariant. The expressions accept literals, operators, +// parameters in AssetPropertyVariant . The expressions accept literals, operators, // functions, references, and substitution templates. Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the integerValue parameter can be '100' . +// - For references, you must specify either variables or parameters. For +// example, the value for the booleanValue parameter can be $variable.offline . +// - For a substitution template, you must use ${} , and the template must be in +// single quotes. A substitution template can also contain a combination of +// literals, operators, functions, references, and substitution templates. In the +// following example, the value for the doubleValue parameter uses a substitution +// template. '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}' // -// * For literal -// values, the expressions must contain single quotes. For example, the value for -// the integerValue parameter can be '100'. -// -// * For references, you must specify -// either variables or parameters. For example, the value for the booleanValue -// parameter can be $variable.offline. -// -// * For a substitution template, you must use -// ${}, and the template must be in single quotes. A substitution template can also -// contain a combination of literals, operators, functions, references, and -// substitution templates. In the following example, the value for the doubleValue -// parameter uses a substitution template. -// '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}' -// -// For more -// information, see Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. You must specify one of the following -// value types, depending on the dataType of the specified asset property. For more -// information, see AssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) +// value types, depending on the dataType of the specified asset property. For +// more information, see AssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) // in the AWS IoT SiteWise API Reference. type AssetPropertyVariant struct { - // The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You + // The asset property value is a Boolean value that must be 'TRUE' or 'FALSE' . You // must use an expression, and the evaluated result should be a Boolean value. BooleanValue *string @@ -535,17 +455,17 @@ type AssetPropertyVariant struct { // The attributes from the JSON payload that are made available by the input. // Inputs are derived from messages sent to the AWS IoT Events system using -// BatchPutMessage. Each such message contains a JSON payload. Those attributes +// BatchPutMessage . Each such message contains a JSON payload. Those attributes // (and their paired values) specified here are available for use in the condition // expressions used by detectors. type Attribute struct { // An expression that specifies an attribute-value pair in a JSON structure. Use // this to specify an attribute from the JSON payload that is made available by the - // input. Inputs are derived from messages sent to AWS IoT Events - // (BatchPutMessage). Each such message contains a JSON payload. The attribute (and - // its paired value) specified here are available for use in the condition - // expressions used by detectors. Syntax: .... + // input. Inputs are derived from messages sent to AWS IoT Events ( BatchPutMessage + // ). Each such message contains a JSON payload. The attribute (and its paired + // value) specified here are available for use in the condition expressions used + // by detectors. Syntax: .... // // This member is required. JsonPath *string @@ -701,45 +621,37 @@ type DetectorModelVersionSummary struct { // Defines an action to write to the Amazon DynamoDB table that you created. The // standard action payload contains all the information about the detector model -// instance and the event that triggered the action. You can customize the payload -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). -// One column of the DynamoDB table receives all attribute-value pairs in the +// instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) +// . One column of the DynamoDB table receives all attribute-value pairs in the // payload that you specify. You must use expressions for all parameters in -// DynamoDBAction. The expressions accept literals, operators, functions, +// DynamoDBAction . The expressions accept literals, operators, functions, // references, and substitution templates. Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the hashKeyType parameter can be 'STRING' . +// - For references, you must specify either variables or input values. For +// example, the value for the hashKeyField parameter can be +// $input.GreenhouseInput.name . +// - For a substitution template, you must use ${} , and the template must be in +// single quotes. A substitution template can also contain a combination of +// literals, operators, functions, references, and substitution templates. In the +// following example, the value for the hashKeyValue parameter uses a +// substitution template. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} +// in Fahrenheit' +// - For a string concatenation, you must use + . A string concatenation can also +// contain a combination of literals, operators, functions, references, and +// substitution templates. In the following example, the value for the tableName +// parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + +// $input.GreenhouseInput.date // -// * For literal values, the -// expressions must contain single quotes. For example, the value for the -// hashKeyType parameter can be 'STRING'. -// -// * For references, you must specify -// either variables or input values. For example, the value for the hashKeyField -// parameter can be $input.GreenhouseInput.name. -// -// * For a substitution template, -// you must use ${}, and the template must be in single quotes. A substitution -// template can also contain a combination of literals, operators, functions, -// references, and substitution templates. In the following example, the value for -// the hashKeyValue parameter uses a substitution template. -// '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' -// -// * For a -// string concatenation, you must use +. A string concatenation can also contain a -// combination of literals, operators, functions, references, and substitution -// templates. In the following example, the value for the tableName parameter uses -// a string concatenation. 'GreenhouseTemperatureTable ' + -// $input.GreenhouseInput.date -// -// For more information, see Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. If the defined payload type is a string, // DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The // DynamoDB console displays the data as Base64-encoded text. The value for the -// payloadField parameter is _raw. +// payloadField parameter is _raw . type DynamoDBAction struct { - // The name of the hash key (also called the partition key). The hashKeyField value - // must match the partition key of the target DynamoDB table. + // The name of the hash key (also called the partition key). The hashKeyField + // value must match the partition key of the target DynamoDB table. // // This member is required. HashKeyField *string @@ -749,53 +661,42 @@ type DynamoDBAction struct { // This member is required. HashKeyValue *string - // The name of the DynamoDB table. The tableName value must match the table name of - // the target DynamoDB table. + // The name of the DynamoDB table. The tableName value must match the table name + // of the target DynamoDB table. // // This member is required. TableName *string // The data type for the hash key (also called the partition key). You can specify // the following values: - // - // * 'STRING' - The hash key is a string. - // - // * 'NUMBER' - The - // hash key is a number. - // - // If you don't specify hashKeyType, the default value is - // 'STRING'. + // - 'STRING' - The hash key is a string. + // - 'NUMBER' - The hash key is a number. + // If you don't specify hashKeyType , the default value is 'STRING' . HashKeyType *string // The type of operation to perform. You can specify the following values: - // - // * - // 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the - // specified hash key as a partition key. If you specified a range key, the item - // uses the range key as a sort key. - // - // * 'UPDATE' - Update an existing item of the - // DynamoDB table with new data. This item's partition key must match the specified - // hash key. If you specified a range key, the range key must match the item's sort - // key. - // - // * 'DELETE' - Delete an existing item of the DynamoDB table. This item's - // partition key must match the specified hash key. If you specified a range key, - // the range key must match the item's sort key. - // - // If you don't specify this - // parameter, AWS IoT Events triggers the 'INSERT' operation. + // - 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses + // the specified hash key as a partition key. If you specified a range key, the + // item uses the range key as a sort key. + // - 'UPDATE' - Update an existing item of the DynamoDB table with new data. This + // item's partition key must match the specified hash key. If you specified a range + // key, the range key must match the item's sort key. + // - 'DELETE' - Delete an existing item of the DynamoDB table. This item's + // partition key must match the specified hash key. If you specified a range key, + // the range key must match the item's sort key. + // If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' + // operation. Operation *string // Information needed to configure the payload. By default, AWS IoT Events // generates a standard payload in JSON for any action. This action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event triggered the action. To configure the action - // payload, you can use contentExpression. + // payload, you can use contentExpression . Payload *Payload // The name of the DynamoDB column that receives the action payload. If you don't - // specify this parameter, the name of the DynamoDB column is payload. + // specify this parameter, the name of the DynamoDB column is payload . PayloadField *string // The name of the range key (also called the sort key). The rangeKeyField value @@ -804,14 +705,9 @@ type DynamoDBAction struct { // The data type for the range key (also called the sort key), You can specify the // following values: - // - // * 'STRING' - The range key is a string. - // - // * 'NUMBER' - The - // range key is number. - // - // If you don't specify rangeKeyField, the default value is - // 'STRING'. + // - 'STRING' - The range key is a string. + // - 'NUMBER' - The range key is number. + // If you don't specify rangeKeyField , the default value is 'STRING' . RangeKeyType *string // The value of the range key (also called the sort key). @@ -822,40 +718,32 @@ type DynamoDBAction struct { // Defines an action to write to the Amazon DynamoDB table that you created. The // default action payload contains all the information about the detector model -// instance and the event that triggered the action. You can customize the payload -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A -// separate column of the DynamoDB table receives one attribute-value pair in the -// payload that you specify. You must use expressions for all parameters in -// DynamoDBv2Action. The expressions accept literals, operators, functions, +// instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) +// . A separate column of the DynamoDB table receives one attribute-value pair in +// the payload that you specify. You must use expressions for all parameters in +// DynamoDBv2Action . The expressions accept literals, operators, functions, // references, and substitution templates. Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the tableName parameter can be +// 'GreenhouseTemperatureTable' . +// - For references, you must specify either variables or input values. For +// example, the value for the tableName parameter can be $variable.ddbtableName . +// - For a substitution template, you must use ${} , and the template must be in +// single quotes. A substitution template can also contain a combination of +// literals, operators, functions, references, and substitution templates. In the +// following example, the value for the contentExpression parameter in Payload +// uses a substitution template. '{\"sensorID\": +// \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": +// \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' +// - For a string concatenation, you must use + . A string concatenation can also +// contain a combination of literals, operators, functions, references, and +// substitution templates. In the following example, the value for the tableName +// parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + +// $input.GreenhouseInput.date // -// * For literal values, the -// expressions must contain single quotes. For example, the value for the tableName -// parameter can be 'GreenhouseTemperatureTable'. -// -// * For references, you must -// specify either variables or input values. For example, the value for the -// tableName parameter can be $variable.ddbtableName. -// -// * For a substitution -// template, you must use ${}, and the template must be in single quotes. A -// substitution template can also contain a combination of literals, operators, -// functions, references, and substitution templates. In the following example, the -// value for the contentExpression parameter in Payload uses a substitution -// template. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", -// \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' -// -// * For -// a string concatenation, you must use +. A string concatenation can also contain -// a combination of literals, operators, functions, references, and substitution -// templates. In the following example, the value for the tableName parameter uses -// a string concatenation. 'GreenhouseTemperatureTable ' + -// $input.GreenhouseInput.date -// -// For more information, see Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. The value for the type parameter in -// Payload must be JSON. +// Payload must be JSON . type DynamoDBv2Action struct { // The name of the DynamoDB table. @@ -867,7 +755,7 @@ type DynamoDBv2Action struct { // generates a standard payload in JSON for any action. This action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event triggered the action. To configure the action - // payload, you can use contentExpression. + // payload, you can use contentExpression . Payload *Payload noSmithyDocumentSerde @@ -878,15 +766,15 @@ type EmailConfiguration struct { // The email address that sends emails. If you use the AWS IoT Events managed AWS // Lambda function to manage your emails, you must verify the email address that - // sends emails in Amazon SES - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). + // sends emails in Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) + // . // // This member is required. From *string // Contains the information of one or more recipients who receive the emails. You - // must add the users that receive emails to your AWS SSO store - // (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html). + // must add the users that receive emails to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html) + // . // // This member is required. Recipients *EmailRecipients @@ -910,8 +798,8 @@ type EmailContent struct { } // Contains the information of one or more recipients who receive the emails. You -// must add the users that receive emails to your AWS SSO store -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html). +// must add the users that receive emails to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html) +// . type EmailRecipients struct { // Specifies one or more recipients who receive the email. @@ -939,8 +827,8 @@ type Event struct { noSmithyDocumentSerde } -// Sends information about the detector model instance and the event that triggered -// the action to an Amazon Kinesis Data Firehose delivery stream. +// Sends information about the detector model instance and the event that +// triggered the action to an Amazon Kinesis Data Firehose delivery stream. type FirehoseAction struct { // The name of the Kinesis Data Firehose delivery stream where the data is written. @@ -964,8 +852,8 @@ type FirehoseAction struct { // were created based on this alarm model. type InitializationConfiguration struct { - // The value must be TRUE or FALSE. If FALSE, all alarm instances created based on - // the alarm model are activated. The default value is TRUE. + // The value must be TRUE or FALSE . If FALSE , all alarm instances created based + // on the alarm model are activated. The default value is TRUE . // // This member is required. DisabledOnInitialization *bool @@ -1024,9 +912,9 @@ type InputDefinition struct { // The attributes from the JSON payload that are made available by the input. // Inputs are derived from messages sent to the AWS IoT Events system using - // BatchPutMessage. Each such message contains a JSON payload, and those attributes - // (and their paired values) specified here are available for use in the condition - // expressions used by detectors that monitor this input. + // BatchPutMessage . Each such message contains a JSON payload, and those + // attributes (and their paired values) specified here are available for use in the + // condition expressions used by detectors that monitor this input. // // This member is required. Attributes []Attribute @@ -1097,40 +985,36 @@ type IotEventsInputIdentifier struct { noSmithyDocumentSerde } -// Sends information about the detector model instance and the event that triggered -// the action to a specified asset property in AWS IoT SiteWise. You must use -// expressions for all parameters in IotSiteWiseAction. The expressions accept +// Sends information about the detector model instance and the event that +// triggered the action to a specified asset property in AWS IoT SiteWise. You must +// use expressions for all parameters in IotSiteWiseAction . The expressions accept // literals, operators, functions, references, and substitutions templates. // Examples +// - For literal values, the expressions must contain single quotes. For +// example, the value for the propertyAlias parameter can be +// '/company/windfarm/3/turbine/7/temperature' . +// - For references, you must specify either variables or input values. For +// example, the value for the assetId parameter can be +// $input.TurbineInput.assetId1 . +// - For a substitution template, you must use ${} , and the template must be in +// single quotes. A substitution template can also contain a combination of +// literals, operators, functions, references, and substitution templates. In the +// following example, the value for the propertyAlias parameter uses a +// substitution template. +// 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ +// ${$input.TemperatureInput.sensorData.turbineID}/temperature' // -// * For literal values, the expressions must contain single quotes. For -// example, the value for the propertyAlias parameter can be -// '/company/windfarm/3/turbine/7/temperature'. -// -// * For references, you must specify -// either variables or input values. For example, the value for the assetId -// parameter can be $input.TurbineInput.assetId1. -// -// * For a substitution template, -// you must use ${}, and the template must be in single quotes. A substitution -// template can also contain a combination of literals, operators, functions, -// references, and substitution templates. In the following example, the value for -// the propertyAlias parameter uses a substitution template. -// 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ -// ${$input.TemperatureInput.sensorData.turbineID}/temperature' -// -// You must specify -// either propertyAlias or both assetId and propertyId to identify the target asset -// property in AWS IoT SiteWise. For more information, see Expressions -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) +// You must specify either propertyAlias or both assetId and propertyId to +// identify the target asset property in AWS IoT SiteWise. For more information, +// see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) // in the AWS IoT Events Developer Guide. type IotSiteWiseAction struct { // The ID of the asset that has the specified property. AssetId *string - // A unique identifier for this entry. You can use the entry ID to track which data - // entry causes an error in case of failure. The default is a new unique + // A unique identifier for this entry. You can use the entry ID to track which + // data entry causes an error in case of failure. The default is a new unique // identifier. EntryId *string @@ -1140,8 +1024,8 @@ type IotSiteWiseAction struct { // The ID of the asset property. PropertyId *string - // The value to send to the asset property. This value contains timestamp, quality, - // and value (TQV) information. + // The value to send to the asset property. This value contains timestamp, + // quality, and value (TQV) information. PropertyValue *AssetPropertyValue noSmithyDocumentSerde @@ -1177,7 +1061,7 @@ type IotSiteWiseInputIdentifier struct { type IotTopicPublishAction struct { // The MQTT topic of the message. You can use a string expression that includes - // variables ($variable.) and input values ($input..) as the topic string. + // variables ( $variable. ) and input values ( $input.. ) as the topic string. // // This member is required. MqttTopic *string @@ -1235,8 +1119,8 @@ type LoggingOptions struct { type NotificationAction struct { // Specifies an AWS Lambda function to manage alarm notifications. You can create - // one or use the AWS Lambda function provided by AWS IoT Events - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html). + // one or use the AWS Lambda function provided by AWS IoT Events (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) + // . // // This member is required. Action *NotificationTargetActions @@ -1251,8 +1135,8 @@ type NotificationAction struct { } // Specifies an AWS Lambda function to manage alarm notifications. You can create -// one or use the AWS Lambda function provided by AWS IoT Events -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html). +// one or use the AWS Lambda function provided by AWS IoT Events (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) +// . type NotificationTargetActions struct { // Calls a Lambda function, passing in information about the detector model @@ -1266,18 +1150,18 @@ type NotificationTargetActions struct { type OnEnterLifecycle struct { // Specifies the actions that are performed when the state is entered and the - // condition is TRUE. + // condition is TRUE . Events []Event noSmithyDocumentSerde } // When exiting this state, perform these actions if the specified condition is -// TRUE. +// TRUE . type OnExitLifecycle struct { // Specifies the actions that are performed when the state is exited and the - // condition is TRUE. + // condition is TRUE . Events []Event noSmithyDocumentSerde @@ -1300,18 +1184,18 @@ type OnInputLifecycle struct { // generates a standard payload in JSON for any action. This action payload // contains all attribute-value pairs that have the information about the detector // model instance and the event triggered the action. To configure the action -// payload, you can use contentExpression. +// payload, you can use contentExpression . type Payload struct { - // The content of the payload. You can use a string expression that includes quoted - // strings (''), variables ($variable.), input values ($input..), string - // concatenations, and quoted strings that contain ${} as the content. The + // The content of the payload. You can use a string expression that includes + // quoted strings ( '' ), variables ( $variable. ), input values ( $input.. ), + // string concatenations, and quoted strings that contain ${} as the content. The // recommended maximum size of a content expression is 1 KB. // // This member is required. ContentExpression *string - // The value of the payload type can be either STRING or JSON. + // The value of the payload type can be either STRING or JSON . // // This member is required. Type PayloadType @@ -1345,9 +1229,8 @@ type ResetTimerAction struct { type RoutedResource struct { // The ARN of the routed resource. For more information, see Amazon Resource Names - // (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference. + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference. Arn *string // The name of the routed resource. @@ -1365,7 +1248,7 @@ type SetTimerAction struct { TimerName *string // The duration of the timer, in seconds. You can use a string expression that - // includes numbers, variables ($variable.), and input values ($input..) as the + // includes numbers, variables ( $variable. ), and input values ( $input.. ) as the // duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, // the minimum duration is 60 seconds. The evaluated result of the duration is // rounded down to the nearest whole number. @@ -1425,9 +1308,9 @@ type SimpleRule struct { // Contains the configuration information of SMS notifications. type SMSConfiguration struct { - // Specifies one or more recipients who receive the message. You must add the users - // that receive SMS messages to your AWS SSO store - // (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html). + // Specifies one or more recipients who receive the message. You must add the + // users that receive SMS messages to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html) + // . // // This member is required. Recipients []RecipientDetail @@ -1456,8 +1339,8 @@ type SNSTopicPublishAction struct { noSmithyDocumentSerde } -// Sends information about the detector model instance and the event that triggered -// the action to an Amazon SQS queue. +// Sends information about the detector model instance and the event that +// triggered the action to an Amazon SQS queue. type SqsAction struct { // The URL of the SQS queue where the data is written. @@ -1469,16 +1352,16 @@ type SqsAction struct { // queue. Payload *Payload - // Set this to TRUE if you want the data to be base-64 encoded before it is written - // to the queue. Otherwise, set this to FALSE. + // Set this to TRUE if you want the data to be base-64 encoded before it is + // written to the queue. Otherwise, set this to FALSE. UseBase64 *bool noSmithyDocumentSerde } // Contains information about your identity source in AWS Single Sign-On. For more -// information, see the AWS Single Sign-On User Guide -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html). +// information, see the AWS Single Sign-On User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) +// . type SSOIdentity struct { // The ID of the AWS SSO identity store. @@ -1504,11 +1387,11 @@ type State struct { OnEnter *OnEnterLifecycle // When exiting this state, perform these actions if the specified condition is - // TRUE. + // TRUE . OnExit *OnExitLifecycle // When an input is received and the condition is TRUE, perform the specified - // actions. + // actions . OnInput *OnInputLifecycle noSmithyDocumentSerde @@ -1534,8 +1417,8 @@ type Tag struct { // evaluates to TRUE. type TransitionEvent struct { - // Required. A Boolean expression that when TRUE causes the actions to be performed - // and the nextState to be entered. + // Required. A Boolean expression that when TRUE causes the actions to be + // performed and the nextState to be entered. // // This member is required. Condition *string diff --git a/service/ioteventsdata/api_client.go b/service/ioteventsdata/api_client.go index 71327cd73a0..48faa15e9e7 100644 --- a/service/ioteventsdata/api_client.go +++ b/service/ioteventsdata/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ioteventsdata/api_op_BatchDeleteDetector.go b/service/ioteventsdata/api_op_BatchDeleteDetector.go index 42c5b104eff..dbf4d485361 100644 --- a/service/ioteventsdata/api_op_BatchDeleteDetector.go +++ b/service/ioteventsdata/api_op_BatchDeleteDetector.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more detectors that were created. When a detector is deleted, its -// state will be cleared and the detector will be removed from the list of +// Deletes one or more detectors that were created. When a detector is deleted, +// its state will be cleared and the detector will be removed from the list of // detectors. The deleted detector will no longer appear if referenced in the -// ListDetectors -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html) +// ListDetectors (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html) // API call. func (c *Client) BatchDeleteDetector(ctx context.Context, params *BatchDeleteDetectorInput, optFns ...func(*Options)) (*BatchDeleteDetectorOutput, error) { if params == nil { @@ -44,9 +43,9 @@ type BatchDeleteDetectorInput struct { type BatchDeleteDetectorOutput struct { - // A list of errors associated with the request, or an empty array ([]) if there - // are no errors. Each error entry contains a messageId that helps you identify the - // entry that failed. + // A list of errors associated with the request, or an empty array ( [] ) if there + // are no errors. Each error entry contains a messageId that helps you identify + // the entry that failed. BatchDeleteDetectorErrorEntries []types.BatchDeleteDetectorErrorEntry // Metadata pertaining to the operation's result. diff --git a/service/ioteventsdata/api_op_BatchPutMessage.go b/service/ioteventsdata/api_op_BatchPutMessage.go index 6c72251666c..add06ff18fc 100644 --- a/service/ioteventsdata/api_op_BatchPutMessage.go +++ b/service/ioteventsdata/api_op_BatchPutMessage.go @@ -12,7 +12,7 @@ import ( ) // Sends a set of messages to the IoT Events system. Each message payload is -// transformed into the input you specify ("inputName") and ingested into any +// transformed into the input you specify ( "inputName" ) and ingested into any // detectors that monitor that input. If multiple messages are sent, the order in // which the messages are processed isn't guaranteed. To guarantee ordering, you // must send messages one at a time and wait for a successful response. diff --git a/service/ioteventsdata/api_op_BatchResetAlarm.go b/service/ioteventsdata/api_op_BatchResetAlarm.go index ce12d7105af..4bf0fc4551c 100644 --- a/service/ioteventsdata/api_op_BatchResetAlarm.go +++ b/service/ioteventsdata/api_op_BatchResetAlarm.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Resets one or more alarms. The alarms return to the NORMAL state after you reset -// them. +// Resets one or more alarms. The alarms return to the NORMAL state after you +// reset them. func (c *Client) BatchResetAlarm(ctx context.Context, params *BatchResetAlarmInput, optFns ...func(*Options)) (*BatchResetAlarmOutput, error) { if params == nil { params = &BatchResetAlarmInput{} diff --git a/service/ioteventsdata/api_op_BatchUpdateDetector.go b/service/ioteventsdata/api_op_BatchUpdateDetector.go index 6c7b4541b1b..459999b5731 100644 --- a/service/ioteventsdata/api_op_BatchUpdateDetector.go +++ b/service/ioteventsdata/api_op_BatchUpdateDetector.go @@ -40,8 +40,8 @@ type BatchUpdateDetectorInput struct { type BatchUpdateDetectorOutput struct { - // A list of those detector updates that resulted in errors. (If an error is listed - // here, the specific update did not occur.) + // A list of those detector updates that resulted in errors. (If an error is + // listed here, the specific update did not occur.) BatchUpdateDetectorErrorEntries []types.BatchUpdateDetectorErrorEntry // Metadata pertaining to the operation's result. diff --git a/service/ioteventsdata/api_op_DescribeAlarm.go b/service/ioteventsdata/api_op_DescribeAlarm.go index 77b97a924c0..65979430e8e 100644 --- a/service/ioteventsdata/api_op_DescribeAlarm.go +++ b/service/ioteventsdata/api_op_DescribeAlarm.go @@ -35,8 +35,8 @@ type DescribeAlarmInput struct { AlarmModelName *string // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string noSmithyDocumentSerde diff --git a/service/ioteventsdata/doc.go b/service/ioteventsdata/doc.go index 4593b0f68f2..ab0886b069c 100644 --- a/service/ioteventsdata/doc.go +++ b/service/ioteventsdata/doc.go @@ -6,7 +6,6 @@ // IoT Events monitors your equipment or device fleets for failures or changes in // operation, and triggers actions when such events occur. You can use IoT Events // Data API commands to send inputs to detectors, list detectors, and view or -// update a detector's status. For more information, see What is IoT Events? -// (https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html) +// update a detector's status. For more information, see What is IoT Events? (https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html) // in the IoT Events Developer Guide. package ioteventsdata diff --git a/service/ioteventsdata/types/enums.go b/service/ioteventsdata/types/enums.go index a3cf6ca28a7..5f36340cea4 100644 --- a/service/ioteventsdata/types/enums.go +++ b/service/ioteventsdata/types/enums.go @@ -89,9 +89,9 @@ const ( ErrorCodeThrottlingException ErrorCode = "ThrottlingException" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "ResourceNotFoundException", @@ -109,9 +109,9 @@ const ( EventTypeStateChange EventType = "STATE_CHANGE" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "STATE_CHANGE", diff --git a/service/ioteventsdata/types/types.go b/service/ioteventsdata/types/types.go index 823b033b3a3..3b314741700 100644 --- a/service/ioteventsdata/types/types.go +++ b/service/ioteventsdata/types/types.go @@ -30,8 +30,8 @@ type AcknowledgeAlarmActionRequest struct { RequestId *string // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The note that you can leave when you acknowledge the alarm. @@ -56,8 +56,8 @@ type Alarm struct { CreationTime *time.Time // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The time the alarm was last updated, in the Unix epoch format. @@ -78,31 +78,21 @@ type AlarmState struct { // Information needed to evaluate data. RuleEvaluation *RuleEvaluation - // The name of the alarm state. The state name can be one of the following - // values: - // - // * DISABLED - When the alarm is in the DISABLED state, it isn't ready to - // evaluate data. To enable the alarm, you must change the alarm to the NORMAL - // state. - // - // * NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate - // data. - // - // * ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. - // - // * - // ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was - // invoked and you acknowledged the alarm. - // - // * SNOOZE_DISABLED - When the alarm is - // in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of - // time. After the snooze time, the alarm automatically changes to the NORMAL - // state. - // - // * LATCHED - When the alarm is in the LATCHED state, the alarm was - // invoked. However, the data that the alarm is currently evaluating is within the - // specified range. To change the alarm to the NORMAL state, you must acknowledge - // the alarm. + // The name of the alarm state. The state name can be one of the following values: + // - DISABLED - When the alarm is in the DISABLED state, it isn't ready to + // evaluate data. To enable the alarm, you must change the alarm to the NORMAL + // state. + // - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. + // - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. + // - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was + // invoked and you acknowledged the alarm. + // - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm + // is disabled for a specified period of time. After the snooze time, the alarm + // automatically changes to the NORMAL state. + // - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. + // However, the data that the alarm is currently evaluating is within the specified + // range. To change the alarm to the NORMAL state, you must acknowledge the + // alarm. StateName AlarmStateName // Contains information about alarm state changes. @@ -124,64 +114,39 @@ type AlarmSummary struct { CreationTime *time.Time // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The time the alarm was last updated, in the Unix epoch format. LastUpdateTime *time.Time - // The name of the alarm state. The state name can be one of the following - // values: - // - // * DISABLED - When the alarm is in the DISABLED state, it isn't ready to - // evaluate data. To enable the alarm, you must change the alarm to the NORMAL - // state. - // - // * NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate - // data. - // - // * ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. - // - // * - // ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was - // invoked and you acknowledged the alarm. - // - // * SNOOZE_DISABLED - When the alarm is - // in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of - // time. After the snooze time, the alarm automatically changes to the NORMAL - // state. - // - // * LATCHED - When the alarm is in the LATCHED state, the alarm was - // invoked. However, the data that the alarm is currently evaluating is within the - // specified range. To change the alarm to the NORMAL state, you must acknowledge - // the alarm. + // The name of the alarm state. The state name can be one of the following values: + // - DISABLED - When the alarm is in the DISABLED state, it isn't ready to + // evaluate data. To enable the alarm, you must change the alarm to the NORMAL + // state. + // - NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. + // - ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. + // - ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was + // invoked and you acknowledged the alarm. + // - SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm + // is disabled for a specified period of time. After the snooze time, the alarm + // automatically changes to the NORMAL state. + // - LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. + // However, the data that the alarm is currently evaluating is within the specified + // range. To change the alarm to the NORMAL state, you must acknowledge the + // alarm. StateName AlarmStateName noSmithyDocumentSerde } // Contains error messages associated with one of the following requests: -// -// * -// BatchAcknowledgeAlarm -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html) -// -// * -// BatchDisableAlarm -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html) -// -// * -// BatchEnableAlarm -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html) -// -// * -// BatchResetAlarm -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html) -// -// * -// BatchSnoozeAlarm -// (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html) +// - BatchAcknowledgeAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html) +// - BatchDisableAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html) +// - BatchEnableAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html) +// - BatchResetAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html) +// - BatchSnoozeAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html) type BatchAlarmActionErrorEntry struct { // The error code. @@ -206,9 +171,8 @@ type BatchDeleteDetectorErrorEntry struct { ErrorMessage *string // The ID of the message that caused the error. (See the value of the "messageId" - // in the detectors - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors) - // object of the DeleteDetectorRequest.) + // in the detectors (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors) + // object of the DeleteDetectorRequest .) MessageId *string noSmithyDocumentSerde @@ -223,8 +187,8 @@ type BatchPutMessageErrorEntry struct { // A message that describes the error. ErrorMessage *string - // The ID of the message that caused the error. (See the value corresponding to the - // "messageId" key in the "message" object.) + // The ID of the message that caused the error. (See the value corresponding to + // the "messageId" key in the "message" object.) MessageId *string noSmithyDocumentSerde @@ -253,25 +217,14 @@ type CustomerAction struct { AcknowledgeActionConfiguration *AcknowledgeActionConfiguration // The name of the action. The action name can be one of the following values: - // - // * - // SNOOZE - When you snooze the alarm, the alarm state changes to - // SNOOZE_DISABLED. - // - // * ENABLE - When you enable the alarm, the alarm state changes - // to NORMAL. - // - // * DISABLE - When you disable the alarm, the alarm state changes to - // DISABLED. - // - // * ACKNOWLEDGE - When you acknowledge the alarm, the alarm state - // changes to ACKNOWLEDGED. - // - // * RESET - When you reset the alarm, the alarm state - // changes to NORMAL. - // - // For more information, see the AlarmState - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html) + // - SNOOZE - When you snooze the alarm, the alarm state changes to + // SNOOZE_DISABLED . + // - ENABLE - When you enable the alarm, the alarm state changes to NORMAL . + // - DISABLE - When you disable the alarm, the alarm state changes to DISABLED . + // - ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to + // ACKNOWLEDGED . + // - RESET - When you reset the alarm, the alarm state changes to NORMAL . + // For more information, see the AlarmState (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html) // API. ActionName CustomerActionName @@ -298,14 +251,13 @@ type DeleteDetectorRequest struct { // This member is required. DetectorModelName *string - // The ID to assign to the DeleteDetectorRequest. Each "messageId" must be unique + // The ID to assign to the DeleteDetectorRequest . Each "messageId" must be unique // within each batch sent. // // This member is required. MessageId *string - // The value of the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key) + // The value of the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key) // used to identify the detector. KeyValue *string @@ -324,8 +276,8 @@ type Detector struct { // The version of the detector model that created this detector (instance). DetectorModelVersion *string - // The value of the key (identifying the device or system) that caused the creation - // of this detector (instance). + // The value of the key (identifying the device or system) that caused the + // creation of this detector (instance). KeyValue *string // The time the detector (instance) was last updated. @@ -402,8 +354,8 @@ type DetectorSummary struct { // The version of the detector model that created this detector (instance). DetectorModelVersion *string - // The value of the key (identifying the device or system) that caused the creation - // of this detector (instance). + // The value of the key (identifying the device or system) that caused the + // creation of this detector (instance). KeyValue *string // The time the detector (instance) was last updated. @@ -438,8 +390,8 @@ type DisableAlarmActionRequest struct { RequestId *string // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The note that you can leave when you disable the alarm. @@ -471,8 +423,8 @@ type EnableAlarmActionRequest struct { RequestId *string // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The note that you can leave when you enable the alarm. @@ -530,8 +482,8 @@ type ResetAlarmActionRequest struct { RequestId *string // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The note that you can leave when you reset the alarm. @@ -597,8 +549,8 @@ type SnoozeAlarmActionRequest struct { SnoozeDuration *int32 // The value of the key used as a filter to select only the alarms associated with - // the key - // (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key). + // the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key) + // . KeyValue *string // The note that you can leave when you snooze the alarm. @@ -610,7 +562,7 @@ type SnoozeAlarmActionRequest struct { // Contains the configuration information of alarm state changes. type StateChangeConfiguration struct { - // The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and + // The trigger type. If the value is SNOOZE_TIMEOUT , the snooze duration ends and // the alarm automatically changes to the NORMAL state. TriggerType TriggerType @@ -620,7 +572,7 @@ type StateChangeConfiguration struct { // Contains information about alarm state changes. type SystemEvent struct { - // The event type. If the value is STATE_CHANGE, the event contains information + // The event type. If the value is STATE_CHANGE , the event contains information // about alarm state changes. EventType EventType @@ -679,7 +631,7 @@ type UpdateDetectorRequest struct { // This member is required. DetectorModelName *string - // The ID to assign to the detector update "message". Each "messageId" must be + // The ID to assign to the detector update "message" . Each "messageId" must be // unique within each batch sent. // // This member is required. diff --git a/service/iotfleethub/api_client.go b/service/iotfleethub/api_client.go index 124cdb05666..af046e0be15 100644 --- a/service/iotfleethub/api_client.go +++ b/service/iotfleethub/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotfleethub/api_op_CreateApplication.go b/service/iotfleethub/api_op_CreateApplication.go index 4d6eee45676..e9fb821bbbf 100644 --- a/service/iotfleethub/api_op_CreateApplication.go +++ b/service/iotfleethub/api_op_CreateApplication.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for -// AWS IoT Device Management is in public preview and is subject to change. +// Creates a Fleet Hub for AWS IoT Device Management web application. Fleet Hub +// for AWS IoT Device Management is in public preview and is subject to change. func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} diff --git a/service/iotfleethub/api_op_DeleteApplication.go b/service/iotfleethub/api_op_DeleteApplication.go index d08417ead5b..1d222cdf3b0 100644 --- a/service/iotfleethub/api_op_DeleteApplication.go +++ b/service/iotfleethub/api_op_DeleteApplication.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for -// AWS IoT Device Management is in public preview and is subject to change. +// Deletes a Fleet Hub for AWS IoT Device Management web application. Fleet Hub +// for AWS IoT Device Management is in public preview and is subject to change. func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error) { if params == nil { params = &DeleteApplicationInput{} diff --git a/service/iotfleethub/doc.go b/service/iotfleethub/doc.go index f5884bd1b4d..8a4dfab8bef 100644 --- a/service/iotfleethub/doc.go +++ b/service/iotfleethub/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package iotfleethub provides the API client, operations, and parameter types for -// AWS IoT Fleet Hub. +// Package iotfleethub provides the API client, operations, and parameter types +// for AWS IoT Fleet Hub. // // With Fleet Hub for AWS IoT Device Management you can build stand-alone web // applications for monitoring the health of your device fleets. Fleet Hub for AWS diff --git a/service/iotfleetwise/api_client.go b/service/iotfleetwise/api_client.go index 2ecd43e8326..02243ea97fa 100644 --- a/service/iotfleetwise/api_client.go +++ b/service/iotfleetwise/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotfleetwise/api_op_BatchCreateVehicle.go b/service/iotfleetwise/api_op_BatchCreateVehicle.go index 393c09af382..f665e6c9e4e 100644 --- a/service/iotfleetwise/api_op_BatchCreateVehicle.go +++ b/service/iotfleetwise/api_op_BatchCreateVehicle.go @@ -13,8 +13,7 @@ import ( // Creates a group, or batch, of vehicles. You must specify a decoder manifest and // a vehicle model (model manifest) for each vehicle. For more information, see -// Create multiple vehicles (AWS CLI) -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html) +// Create multiple vehicles (AWS CLI) (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html) // in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) BatchCreateVehicle(ctx context.Context, params *BatchCreateVehicleInput, optFns ...func(*Options)) (*BatchCreateVehicleOutput, error) { if params == nil { diff --git a/service/iotfleetwise/api_op_BatchUpdateVehicle.go b/service/iotfleetwise/api_op_BatchUpdateVehicle.go index 6f0da5ea806..fcf3b2b3352 100644 --- a/service/iotfleetwise/api_op_BatchUpdateVehicle.go +++ b/service/iotfleetwise/api_op_BatchUpdateVehicle.go @@ -13,8 +13,7 @@ import ( // Updates a group, or batch, of vehicles. You must specify a decoder manifest and // a vehicle model (model manifest) for each vehicle. For more information, see -// Update multiple vehicles (AWS CLI) -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html) +// Update multiple vehicles (AWS CLI) (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html) // in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) BatchUpdateVehicle(ctx context.Context, params *BatchUpdateVehicleInput, optFns ...func(*Options)) (*BatchUpdateVehicleOutput, error) { if params == nil { diff --git a/service/iotfleetwise/api_op_CreateCampaign.go b/service/iotfleetwise/api_op_CreateCampaign.go index fb69d806944..b019586a069 100644 --- a/service/iotfleetwise/api_op_CreateCampaign.go +++ b/service/iotfleetwise/api_op_CreateCampaign.go @@ -17,8 +17,7 @@ import ( // to collect and transfer data to the cloud. You create campaigns in the cloud. // After you or your team approve campaigns, Amazon Web Services IoT FleetWise // automatically deploys them to vehicles. For more information, see Collect and -// transfer data with campaigns -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html) +// transfer data with campaigns (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html) // in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error) { if params == nil { @@ -60,15 +59,15 @@ type CreateCampaignInput struct { TargetArn *string // (Optional) Whether to compress signals before transmitting data to Amazon Web - // Services IoT FleetWise. If you don't want to compress the signals, use OFF. If + // Services IoT FleetWise. If you don't want to compress the signals, use OFF . If // it's not specified, SNAPPY is used. Default: SNAPPY Compression types.Compression - // (Optional) A list of vehicle attributes to associate with a campaign. Enrich the - // data with specified vehicle attributes. For example, add make and model to the - // campaign, and Amazon Web Services IoT FleetWise will associate the data with + // (Optional) A list of vehicle attributes to associate with a campaign. Enrich + // the data with specified vehicle attributes. For example, add make and model to + // the campaign, and Amazon Web Services IoT FleetWise will associate the data with // those attributes as dimensions in Amazon Timestream. You can then query the data - // against make and model. Default: An empty array + // against make and model . Default: An empty array DataExtraDimensions []string // An optional description of the campaign to help identify its purpose. @@ -76,7 +75,7 @@ type CreateCampaignInput struct { // (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web // Services IoT FleetWise. If you want to send diagnostic trouble codes, use - // SEND_ACTIVE_DTCS. If it's not specified, OFF is used. Default: OFF + // SEND_ACTIVE_DTCS . If it's not specified, OFF is used. Default: OFF DiagnosticsMode types.DiagnosticsMode // (Optional) The time the campaign expires, in seconds since epoch (January 1, @@ -100,7 +99,7 @@ type CreateCampaignInput struct { // (Optional) Whether to store collected data after a vehicle lost a connection // with the cloud. After a connection is re-established, the data is automatically // forwarded to Amazon Web Services IoT FleetWise. If you want to store collected - // data when a vehicle loses connection with the cloud, use TO_DISK. If it's not + // data when a vehicle loses connection with the cloud, use TO_DISK . If it's not // specified, OFF is used. Default: OFF SpoolingMode types.SpoolingMode diff --git a/service/iotfleetwise/api_op_CreateDecoderManifest.go b/service/iotfleetwise/api_op_CreateDecoderManifest.go index 2670fadc63c..10a4e2e9b51 100644 --- a/service/iotfleetwise/api_op_CreateDecoderManifest.go +++ b/service/iotfleetwise/api_op_CreateDecoderManifest.go @@ -13,17 +13,10 @@ import ( // Creates the decoder manifest associated with a model manifest. To create a // decoder manifest, the following must be true: -// -// * Every signal decoder has a -// unique name. -// -// * Each signal decoder is associated with a network interface. -// -// * -// Each network interface has a unique ID. -// -// * The signal decoders are specified in -// the model manifest. +// - Every signal decoder has a unique name. +// - Each signal decoder is associated with a network interface. +// - Each network interface has a unique ID. +// - The signal decoders are specified in the model manifest. func (c *Client) CreateDecoderManifest(ctx context.Context, params *CreateDecoderManifestInput, optFns ...func(*Options)) (*CreateDecoderManifestOutput, error) { if params == nil { params = &CreateDecoderManifestInput{} diff --git a/service/iotfleetwise/api_op_CreateFleet.go b/service/iotfleetwise/api_op_CreateFleet.go index 20b7b26a03b..05207ea96e8 100644 --- a/service/iotfleetwise/api_op_CreateFleet.go +++ b/service/iotfleetwise/api_op_CreateFleet.go @@ -13,9 +13,8 @@ import ( // Creates a fleet that represents a group of vehicles. You must create both a // signal catalog and vehicles before you can create a fleet. For more information, -// see Fleets -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html) in -// the Amazon Web Services IoT FleetWise Developer Guide. +// see Fleets (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html) +// in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error) { if params == nil { params = &CreateFleetInput{} diff --git a/service/iotfleetwise/api_op_CreateModelManifest.go b/service/iotfleetwise/api_op_CreateModelManifest.go index 6efe7800234..e5016bddf2e 100644 --- a/service/iotfleetwise/api_op_CreateModelManifest.go +++ b/service/iotfleetwise/api_op_CreateModelManifest.go @@ -12,8 +12,7 @@ import ( ) // Creates a vehicle model (model manifest) that specifies signals (attributes, -// branches, sensors, and actuators). For more information, see Vehicle models -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html) +// branches, sensors, and actuators). For more information, see Vehicle models (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html) // in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) CreateModelManifest(ctx context.Context, params *CreateModelManifestInput, optFns ...func(*Options)) (*CreateModelManifestOutput, error) { if params == nil { diff --git a/service/iotfleetwise/api_op_CreateVehicle.go b/service/iotfleetwise/api_op_CreateVehicle.go index 87c8c20c7df..78c34745759 100644 --- a/service/iotfleetwise/api_op_CreateVehicle.go +++ b/service/iotfleetwise/api_op_CreateVehicle.go @@ -16,8 +16,7 @@ import ( // inherited from the vehicle model. If you have an existing Amazon Web Services // IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and // collect data from your thing. For more information, see Create a vehicle (AWS -// CLI) -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html) +// CLI) (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html) // in the Amazon Web Services IoT FleetWise Developer Guide. func (c *Client) CreateVehicle(ctx context.Context, params *CreateVehicleInput, optFns ...func(*Options)) (*CreateVehicleOutput, error) { if params == nil { @@ -51,8 +50,9 @@ type CreateVehicleInput struct { // This member is required. VehicleName *string - // An option to create a new Amazon Web Services IoT thing when creating a vehicle, - // or to validate an existing Amazon Web Services IoT thing as a vehicle. Default: + // An option to create a new Amazon Web Services IoT thing when creating a + // vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle. + // Default: AssociationBehavior types.VehicleAssociationBehavior // Static information about a vehicle in a key-value pair. For example: diff --git a/service/iotfleetwise/api_op_DeleteFleet.go b/service/iotfleetwise/api_op_DeleteFleet.go index 3819d026ef8..fd26fc74c82 100644 --- a/service/iotfleetwise/api_op_DeleteFleet.go +++ b/service/iotfleetwise/api_op_DeleteFleet.go @@ -11,8 +11,7 @@ import ( ) // Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated -// from the fleet. For more information, see Delete a fleet (AWS CLI) -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html) +// from the fleet. For more information, see Delete a fleet (AWS CLI) (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html) // in the Amazon Web Services IoT FleetWise Developer Guide. If the fleet is // successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 // response with an empty body. diff --git a/service/iotfleetwise/api_op_DisassociateVehicleFleet.go b/service/iotfleetwise/api_op_DisassociateVehicleFleet.go index 44a63f45fcd..92c00e3cabd 100644 --- a/service/iotfleetwise/api_op_DisassociateVehicleFleet.go +++ b/service/iotfleetwise/api_op_DisassociateVehicleFleet.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from -// a fleet doesn't delete the vehicle. If the vehicle is successfully dissociated -// from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response -// with an empty body. +// Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle +// from a fleet doesn't delete the vehicle. If the vehicle is successfully +// dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP +// 200 response with an empty body. func (c *Client) DisassociateVehicleFleet(ctx context.Context, params *DisassociateVehicleFleetInput, optFns ...func(*Options)) (*DisassociateVehicleFleetOutput, error) { if params == nil { params = &DisassociateVehicleFleetInput{} diff --git a/service/iotfleetwise/api_op_GetCampaign.go b/service/iotfleetwise/api_op_GetCampaign.go index a93ccf3a455..d11be53b24b 100644 --- a/service/iotfleetwise/api_op_GetCampaign.go +++ b/service/iotfleetwise/api_op_GetCampaign.go @@ -61,8 +61,8 @@ type GetCampaignOutput struct { // The description of the campaign. Description *string - // Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT - // FleetWise. + // Option for a vehicle to send diagnostic trouble codes to Amazon Web Services + // IoT FleetWise. DiagnosticsMode types.DiagnosticsMode // The time the campaign expires, in seconds since epoch (January 1, 1970 at @@ -75,8 +75,8 @@ type GetCampaignOutput struct { // The name of the campaign. Name *string - // How long (in seconds) to collect raw data after a triggering event initiates the - // collection. + // How long (in seconds) to collect raw data after a triggering event initiates + // the collection. PostTriggerCollectionDuration *int64 // A number indicating the priority of one campaign over another campaign for a @@ -98,8 +98,8 @@ type GetCampaignOutput struct { // The time, in milliseconds, to deliver a campaign after it was approved. StartTime *time.Time - // The state of the campaign. The status can be one of: CREATING, - // WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED. + // The state of the campaign. The status can be one of: CREATING , + // WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED . Status types.CampaignStatus // The ARN of the vehicle or the fleet targeted by the campaign. diff --git a/service/iotfleetwise/api_op_GetDecoderManifest.go b/service/iotfleetwise/api_op_GetDecoderManifest.go index c1b96d27d6b..7f47775b3af 100644 --- a/service/iotfleetwise/api_op_GetDecoderManifest.go +++ b/service/iotfleetwise/api_op_GetDecoderManifest.go @@ -69,9 +69,9 @@ type GetDecoderManifestOutput struct { // manifest. ModelManifestArn *string - // The state of the decoder manifest. If the status is ACTIVE, the decoder manifest - // can't be edited. If the status is marked DRAFT, you can edit the decoder - // manifest. + // The state of the decoder manifest. If the status is ACTIVE , the decoder + // manifest can't be edited. If the status is marked DRAFT , you can edit the + // decoder manifest. Status types.ManifestStatus // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetModelManifest.go b/service/iotfleetwise/api_op_GetModelManifest.go index dbe4140ce81..0d3ad3d4f03 100644 --- a/service/iotfleetwise/api_op_GetModelManifest.go +++ b/service/iotfleetwise/api_op_GetModelManifest.go @@ -67,8 +67,8 @@ type GetModelManifestOutput struct { // The ARN of the signal catalog associated with the vehicle model. SignalCatalogArn *string - // The state of the vehicle model. If the status is ACTIVE, the vehicle model can't - // be edited. You can edit the vehicle model if the status is marked DRAFT. + // The state of the vehicle model. If the status is ACTIVE , the vehicle model + // can't be edited. You can edit the vehicle model if the status is marked DRAFT . Status types.ManifestStatus // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetRegisterAccountStatus.go b/service/iotfleetwise/api_op_GetRegisterAccountStatus.go index 497a4001c1a..30bca6abfb8 100644 --- a/service/iotfleetwise/api_op_GetRegisterAccountStatus.go +++ b/service/iotfleetwise/api_op_GetRegisterAccountStatus.go @@ -16,9 +16,8 @@ import ( // account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT // FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For // more information, including step-by-step procedures, see Setting up Amazon Web -// Services IoT FleetWise -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html). -// This API operation doesn't require input parameters. +// Services IoT FleetWise (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html) +// . This API operation doesn't require input parameters. func (c *Client) GetRegisterAccountStatus(ctx context.Context, params *GetRegisterAccountStatusInput, optFns ...func(*Options)) (*GetRegisterAccountStatusOutput, error) { if params == nil { params = &GetRegisterAccountStatusInput{} @@ -40,18 +39,14 @@ type GetRegisterAccountStatusInput struct { type GetRegisterAccountStatusOutput struct { - // The status of registering your account and resources. The status can be one - // of: + // The status of registering your account and resources. The status can be one of: + // - REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully + // registered. + // - REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the + // registration request. This process takes approximately five minutes to complete. // - // * REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully - // registered. - // - // * REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is - // processing the registration request. This process takes approximately five - // minutes to complete. - // - // * REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise - // can't register the AWS resource. Try again later. + // - REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the + // AWS resource. Try again later. // // This member is required. AccountStatus types.RegistrationStatus diff --git a/service/iotfleetwise/api_op_GetVehicle.go b/service/iotfleetwise/api_op_GetVehicle.go index cb336455688..85847c12e05 100644 --- a/service/iotfleetwise/api_op_GetVehicle.go +++ b/service/iotfleetwise/api_op_GetVehicle.go @@ -53,8 +53,8 @@ type GetVehicleOutput struct { // The ARN of a decoder manifest associated with the vehicle. DecoderManifestArn *string - // The time the vehicle was last updated in seconds since epoch (January 1, 1970 at - // midnight UTC time). + // The time the vehicle was last updated in seconds since epoch (January 1, 1970 + // at midnight UTC time). LastModificationTime *time.Time // The ARN of a vehicle model (model manifest) associated with the vehicle. diff --git a/service/iotfleetwise/api_op_ListCampaigns.go b/service/iotfleetwise/api_op_ListCampaigns.go index f0c5a56045d..b4e685ca501 100644 --- a/service/iotfleetwise/api_op_ListCampaigns.go +++ b/service/iotfleetwise/api_op_ListCampaigns.go @@ -42,8 +42,8 @@ type ListCampaignsInput struct { NextToken *string // Optional parameter to filter the results by the status of each created campaign - // in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, - // RUNNING, or SUSPENDED. + // in your account. The status can be one of: CREATING , WAITING_FOR_APPROVAL , + // RUNNING , or SUSPENDED . Status *string noSmithyDocumentSerde diff --git a/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go b/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go index 1b0926a70c0..d4398e5e4b9 100644 --- a/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go +++ b/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the network interfaces specified in a decoder manifest. This API operation -// uses pagination. Specify the nextToken parameter in the request to return more -// results. +// Lists the network interfaces specified in a decoder manifest. This API +// operation uses pagination. Specify the nextToken parameter in the request to +// return more results. func (c *Client) ListDecoderManifestNetworkInterfaces(ctx context.Context, params *ListDecoderManifestNetworkInterfacesInput, optFns ...func(*Options)) (*ListDecoderManifestNetworkInterfacesOutput, error) { if params == nil { params = &ListDecoderManifestNetworkInterfacesInput{} diff --git a/service/iotfleetwise/api_op_ListFleetsForVehicle.go b/service/iotfleetwise/api_op_ListFleetsForVehicle.go index c2c03b81eb5..1e6d763cf94 100644 --- a/service/iotfleetwise/api_op_ListFleetsForVehicle.go +++ b/service/iotfleetwise/api_op_ListFleetsForVehicle.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of IDs for all fleets that the vehicle is associated with. This -// API operation uses pagination. Specify the nextToken parameter in the request to -// return more results. +// Retrieves a list of IDs for all fleets that the vehicle is associated with. +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListFleetsForVehicle(ctx context.Context, params *ListFleetsForVehicleInput, optFns ...func(*Options)) (*ListFleetsForVehicleOutput, error) { if params == nil { params = &ListFleetsForVehicleInput{} diff --git a/service/iotfleetwise/api_op_ListSignalCatalogs.go b/service/iotfleetwise/api_op_ListSignalCatalogs.go index 65f1f391bc4..3cd0ffcc5b6 100644 --- a/service/iotfleetwise/api_op_ListSignalCatalogs.go +++ b/service/iotfleetwise/api_op_ListSignalCatalogs.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the created signal catalogs in an Amazon Web Services account. You can -// use to list information about each signal (node) specified in a signal catalog. -// This API operation uses pagination. Specify the nextToken parameter in the -// request to return more results. +// Lists all the created signal catalogs in an Amazon Web Services account. You +// can use to list information about each signal (node) specified in a signal +// catalog. This API operation uses pagination. Specify the nextToken parameter in +// the request to return more results. func (c *Client) ListSignalCatalogs(ctx context.Context, params *ListSignalCatalogsInput, optFns ...func(*Options)) (*ListSignalCatalogsOutput, error) { if params == nil { params = &ListSignalCatalogsInput{} diff --git a/service/iotfleetwise/api_op_ListVehiclesInFleet.go b/service/iotfleetwise/api_op_ListVehiclesInFleet.go index b0819870697..3eba8cb7bce 100644 --- a/service/iotfleetwise/api_op_ListVehiclesInFleet.go +++ b/service/iotfleetwise/api_op_ListVehiclesInFleet.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListVehiclesInFleetMiddlewares(stack *middleware.St return nil } -// ListVehiclesInFleetAPIClient is a client that implements the ListVehiclesInFleet -// operation. +// ListVehiclesInFleetAPIClient is a client that implements the +// ListVehiclesInFleet operation. type ListVehiclesInFleetAPIClient interface { ListVehiclesInFleet(context.Context, *ListVehiclesInFleetInput, ...func(*Options)) (*ListVehiclesInFleetOutput, error) } diff --git a/service/iotfleetwise/api_op_RegisterAccount.go b/service/iotfleetwise/api_op_RegisterAccount.go index 51a44e59e6b..f783e739fb4 100644 --- a/service/iotfleetwise/api_op_RegisterAccount.go +++ b/service/iotfleetwise/api_op_RegisterAccount.go @@ -12,21 +12,17 @@ import ( "time" ) -// Registers your Amazon Web Services account, IAM, and Amazon Timestream resources -// so Amazon Web Services IoT FleetWise can transfer your vehicle data to the -// Amazon Web Services Cloud. For more information, including step-by-step -// procedures, see Setting up Amazon Web Services IoT FleetWise -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html). -// An Amazon Web Services account is not the same thing as a "user account". An -// Amazon Web Services user -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users) +// Registers your Amazon Web Services account, IAM, and Amazon Timestream +// resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to +// the Amazon Web Services Cloud. For more information, including step-by-step +// procedures, see Setting up Amazon Web Services IoT FleetWise (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html) +// . An Amazon Web Services account is not the same thing as a "user account". An +// Amazon Web Services user (https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users) // is an identity that you create using Identity and Access Management (IAM) and -// takes the form of either an IAM user -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) or an IAM role, -// both with credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). A single -// Amazon Web Services account can, and typically does, contain many users and -// roles. +// takes the form of either an IAM user (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) +// or an IAM role, both with credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) +// . A single Amazon Web Services account can, and typically does, contain many +// users and roles. func (c *Client) RegisterAccount(ctx context.Context, params *RegisterAccountInput, optFns ...func(*Options)) (*RegisterAccountOutput, error) { if params == nil { params = &RegisterAccountInput{} diff --git a/service/iotfleetwise/api_op_UpdateCampaign.go b/service/iotfleetwise/api_op_UpdateCampaign.go index 2801b16bcc3..ac907133847 100644 --- a/service/iotfleetwise/api_op_UpdateCampaign.go +++ b/service/iotfleetwise/api_op_UpdateCampaign.go @@ -30,17 +30,10 @@ func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput type UpdateCampaignInput struct { // Specifies how to update a campaign. The action can be one of the following: - // - // * - // APPROVE - To approve delivering a data collection scheme to vehicles. - // - // * SUSPEND - // - To suspend collecting signal data. - // - // * RESUME - To resume collecting signal - // data. - // - // * UPDATE - To update a campaign. + // - APPROVE - To approve delivering a data collection scheme to vehicles. + // - SUSPEND - To suspend collecting signal data. + // - RESUME - To resume collecting signal data. + // - UPDATE - To update a campaign. // // This member is required. Action types.UpdateCampaignAction @@ -68,20 +61,15 @@ type UpdateCampaignOutput struct { Name *string // The state of a campaign. The status can be one of: - // - // * CREATING - Amazon Web - // Services IoT FleetWise is processing your request to create the campaign. - // - // * - // WAITING_FOR_APPROVAL - After a campaign is created, it enters the - // WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy - // the campaign to the target vehicle or fleet, use the API operation to approve - // the campaign. - // - // * RUNNING - The campaign is active. - // - // * SUSPENDED - The campaign - // is suspended. To resume the campaign, use the API operation. + // - CREATING - Amazon Web Services IoT FleetWise is processing your request to + // create the campaign. + // - WAITING_FOR_APPROVAL - After a campaign is created, it enters the + // WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to + // deploy the campaign to the target vehicle or fleet, use the API operation to + // approve the campaign. + // - RUNNING - The campaign is active. + // - SUSPENDED - The campaign is suspended. To resume the campaign, use the API + // operation. Status types.CampaignStatus // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_UpdateDecoderManifest.go b/service/iotfleetwise/api_op_UpdateDecoderManifest.go index bbc1b275d1a..3e3b72b7218 100644 --- a/service/iotfleetwise/api_op_UpdateDecoderManifest.go +++ b/service/iotfleetwise/api_op_UpdateDecoderManifest.go @@ -12,7 +12,7 @@ import ( ) // Updates a decoder manifest. A decoder manifest can only be updated when the -// status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles. +// status is DRAFT . Only ACTIVE decoder manifests can be associated with vehicles. func (c *Client) UpdateDecoderManifest(ctx context.Context, params *UpdateDecoderManifestInput, optFns ...func(*Options)) (*UpdateDecoderManifestOutput, error) { if params == nil { params = &UpdateDecoderManifestInput{} @@ -60,8 +60,9 @@ type UpdateDecoderManifestInput struct { // manifest. SignalDecodersToUpdate []types.SignalDecoder - // The state of the decoder manifest. If the status is ACTIVE, the decoder manifest - // can't be edited. If the status is DRAFT, you can edit the decoder manifest. + // The state of the decoder manifest. If the status is ACTIVE , the decoder + // manifest can't be edited. If the status is DRAFT , you can edit the decoder + // manifest. Status types.ManifestStatus noSmithyDocumentSerde diff --git a/service/iotfleetwise/api_op_UpdateModelManifest.go b/service/iotfleetwise/api_op_UpdateModelManifest.go index 118068fd1e5..46440257f39 100644 --- a/service/iotfleetwise/api_op_UpdateModelManifest.go +++ b/service/iotfleetwise/api_op_UpdateModelManifest.go @@ -46,8 +46,8 @@ type UpdateModelManifestInput struct { // signals, to remove from the vehicle model. NodesToRemove []string - // The state of the vehicle model. If the status is ACTIVE, the vehicle model can't - // be edited. If the status is DRAFT, you can edit the vehicle model. + // The state of the vehicle model. If the status is ACTIVE , the vehicle model + // can't be edited. If the status is DRAFT , you can edit the vehicle model. Status types.ManifestStatus noSmithyDocumentSerde diff --git a/service/iotfleetwise/api_op_UpdateVehicle.go b/service/iotfleetwise/api_op_UpdateVehicle.go index fe8cbc5c272..f32f6d5e3db 100644 --- a/service/iotfleetwise/api_op_UpdateVehicle.go +++ b/service/iotfleetwise/api_op_UpdateVehicle.go @@ -35,7 +35,7 @@ type UpdateVehicleInput struct { VehicleName *string // The method the specified attributes will update the existing attributes on the - // vehicle. UseOverwite to replace the vehicle attributes with the specified + // vehicle. Use Overwite to replace the vehicle attributes with the specified // attributes. Or use Merge to combine all attributes. This is required if // attributes are present in the input. AttributeUpdateMode types.UpdateMode diff --git a/service/iotfleetwise/doc.go b/service/iotfleetwise/doc.go index f789a8e8db6..16b41c6be15 100644 --- a/service/iotfleetwise/doc.go +++ b/service/iotfleetwise/doc.go @@ -3,12 +3,11 @@ // Package iotfleetwise provides the API client, operations, and parameter types // for AWS IoT FleetWise. // -// Amazon Web Services IoT FleetWise is a fully managed service that you can use to -// collect, model, and transfer vehicle data to the Amazon Web Services cloud at +// Amazon Web Services IoT FleetWise is a fully managed service that you can use +// to collect, model, and transfer vehicle data to the Amazon Web Services cloud at // scale. With Amazon Web Services IoT FleetWise, you can standardize all of your // vehicle data models, independent of the in-vehicle communication architecture, // and define data collection rules to transfer only high-value data to the cloud. -// For more information, see What is Amazon Web Services IoT FleetWise? -// (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/) in the Amazon -// Web Services IoT FleetWise Developer Guide. +// For more information, see What is Amazon Web Services IoT FleetWise? (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/) +// in the Amazon Web Services IoT FleetWise Developer Guide. package iotfleetwise diff --git a/service/iotfleetwise/types/enums.go b/service/iotfleetwise/types/enums.go index 1722802171e..ba483360018 100644 --- a/service/iotfleetwise/types/enums.go +++ b/service/iotfleetwise/types/enums.go @@ -174,9 +174,9 @@ const ( NodeDataTypeUnknown NodeDataType = "UNKNOWN" ) -// Values returns all known values for NodeDataType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for NodeDataType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (NodeDataType) Values() []NodeDataType { return []NodeDataType{ "INT8", @@ -287,9 +287,9 @@ const ( SpoolingModeToDisk SpoolingMode = "TO_DISK" ) -// Values returns all known values for SpoolingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SpoolingMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SpoolingMode) Values() []SpoolingMode { return []SpoolingMode{ "OFF", @@ -406,9 +406,9 @@ const ( VehicleStateDeleting VehicleState = "DELETING" ) -// Values returns all known values for VehicleState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for VehicleState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (VehicleState) Values() []VehicleState { return []VehicleState{ "CREATED", diff --git a/service/iotfleetwise/types/errors.go b/service/iotfleetwise/types/errors.go index 5e12a031143..3229ec4727c 100644 --- a/service/iotfleetwise/types/errors.go +++ b/service/iotfleetwise/types/errors.go @@ -123,8 +123,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The specified node type doesn't match the expected node type for a node. You can -// specify the node type as branch, sensor, actuator, or attribute. +// The specified node type doesn't match the expected node type for a node. You +// can specify the node type as branch, sensor, actuator, or attribute. type InvalidNodeException struct { Message *string diff --git a/service/iotfleetwise/types/types.go b/service/iotfleetwise/types/types.go index 4411b093ee7..938877ff244 100644 --- a/service/iotfleetwise/types/types.go +++ b/service/iotfleetwise/types/types.go @@ -19,7 +19,7 @@ type Actuator struct { DataType NodeDataType // The fully qualified name of the actuator. For example, the fully qualified name - // of an actuator might be Vehicle.Front.Left.Door.Lock. + // of an actuator might be Vehicle.Front.Left.Door.Lock . // // This member is required. FullyQualifiedName *string @@ -56,8 +56,8 @@ type Attribute struct { // This member is required. DataType NodeDataType - // The fully qualified name of the attribute. For example, the fully qualified name - // of an attribute might be Vehicle.Body.Engine.Type. + // The fully qualified name of the attribute. For example, the fully qualified + // name of an attribute might be Vehicle.Body.Engine.Type . // // This member is required. FullyQualifiedName *string @@ -91,8 +91,8 @@ type Attribute struct { // A group of signals that are defined in a hierarchical structure. type Branch struct { - // The fully qualified name of the branch. For example, the fully qualified name of - // a branch might be Vehicle.Body.Engine. + // The fully qualified name of the branch. For example, the fully qualified name + // of a branch might be Vehicle.Body.Engine . // // This member is required. FullyQualifiedName *string @@ -130,20 +130,15 @@ type CampaignSummary struct { SignalCatalogArn *string // The state of a campaign. The status can be one of the following: - // - // * CREATING - - // Amazon Web Services IoT FleetWise is processing your request to create the - // campaign. - // - // * WAITING_FOR_APPROVAL - After a campaign is created, it enters the - // WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy - // the campaign to the target vehicle or fleet, use the API operation to approve - // the campaign. - // - // * RUNNING - The campaign is active. - // - // * SUSPENDED - The campaign - // is suspended. To resume the campaign, use the API operation. + // - CREATING - Amazon Web Services IoT FleetWise is processing your request to + // create the campaign. + // - WAITING_FOR_APPROVAL - After a campaign is created, it enters the + // WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to + // deploy the campaign to the target vehicle or fleet, use the API operation to + // approve the campaign. + // - RUNNING - The campaign is active. + // - SUSPENDED - The campaign is suspended. To resume the campaign, use the API + // operation. Status CampaignStatus // The ARN of a vehicle or fleet to which the campaign is deployed. @@ -155,8 +150,8 @@ type CampaignSummary struct { // Configurations used to create a decoder manifest. type CanDbcDefinition struct { - // A list of DBC files. You can upload only one DBC file for each network interface - // and specify up to five (inclusive) files in the list. + // A list of DBC files. You can upload only one DBC file for each network + // interface and specify up to five (inclusive) files in the list. // // This member is required. CanDbcFiles [][]byte @@ -189,8 +184,8 @@ type CanInterface struct { noSmithyDocumentSerde } -// Information about a single controller area network (CAN) signal and the messages -// it receives and transmits. +// Information about a single controller area network (CAN) signal and the +// messages it receives and transmits. type CanSignal struct { // A multiplier used to decode the CAN message. @@ -283,7 +278,7 @@ func (*CollectionSchemeMemberTimeBasedCollectionScheme) isCollectionScheme() {} type ConditionBasedCollectionScheme struct { // The logical expression used to recognize what data to collect. For example, - // $variable.Vehicle.OutsideAirTemperature >= 105.0. + // $variable.Vehicle.OutsideAirTemperature >= 105.0 . // // This member is required. Expression *string @@ -296,8 +291,8 @@ type ConditionBasedCollectionScheme struct { // slower rate. MinimumTriggerIntervalMs *int64 - // Whether to collect data for all triggering events (ALWAYS). Specify - // (RISING_EDGE), or specify only when the condition first evaluates to false. For + // Whether to collect data for all triggering events ( ALWAYS ). Specify ( + // RISING_EDGE ), or specify only when the condition first evaluates to false. For // example, triggering on "AirbagDeployed"; Users aren't interested on triggering // when the airbag is already exploded; they only care about the change from not // deployed => deployed. @@ -324,8 +319,8 @@ type CreateVehicleError struct { // Information about the vehicle to create. type CreateVehicleRequestItem struct { - // The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle - // to create. + // The Amazon Resource Name (ARN) of a decoder manifest associated with the + // vehicle to create. // // This member is required. DecoderManifestArn *string @@ -340,8 +335,8 @@ type CreateVehicleRequestItem struct { // This member is required. VehicleName *string - // An option to create a new Amazon Web Services IoT thing when creating a vehicle, - // or to validate an existing thing as a vehicle. + // An option to create a new Amazon Web Services IoT thing when creating a + // vehicle, or to validate an existing thing as a vehicle. AssociationBehavior VehicleAssociationBehavior // Static information about a vehicle in a key-value pair. For example: "engine @@ -399,9 +394,9 @@ type DecoderManifestSummary struct { // The name of the decoder manifest. Name *string - // The state of the decoder manifest. If the status is ACTIVE, the decoder manifest - // can't be edited. If the status is marked DRAFT, you can edit the decoder - // manifest. + // The state of the decoder manifest. If the status is ACTIVE , the decoder + // manifest can't be edited. If the status is marked DRAFT , you can edit the + // decoder manifest. Status ManifestStatus noSmithyDocumentSerde @@ -468,7 +463,7 @@ func (*FormattedVssMemberVssJson) isFormattedVss() {} type IamRegistrationResponse struct { // The status of registering your IAM resource. The status can be one of - // REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE. + // REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE . // // This member is required. RegistrationStatus RegistrationStatus @@ -485,14 +480,13 @@ type IamRegistrationResponse struct { } // The IAM resource that enables Amazon Web Services IoT FleetWise edge agent -// software to send data to Amazon Timestream. For more information, see IAM roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the Identity -// and Access Management User Guide. +// software to send data to Amazon Timestream. For more information, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) +// in the Identity and Access Management User Guide. type IamResources struct { // The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web // Services IoT FleetWise to send data to Amazon Timestream. For example, - // arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN. + // arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN . // // This member is required. RoleArn *string @@ -564,8 +558,8 @@ type ModelManifestSummary struct { // The ARN of the signal catalog associated with the vehicle model. SignalCatalogArn *string - // The state of the vehicle model. If the status is ACTIVE, the vehicle model can't - // be edited. If the status is DRAFT, you can edit the vehicle model. + // The state of the vehicle model. If the status is ACTIVE , the vehicle model + // can't be edited. If the status is DRAFT , you can edit the vehicle model. Status ManifestStatus noSmithyDocumentSerde @@ -590,10 +584,10 @@ type NetworkFileDefinitionMemberCanDbc struct { func (*NetworkFileDefinitionMemberCanDbc) isNetworkFileDefinition() {} -// Represents a node and its specifications in an in-vehicle communication network. -// All signal decoders must be associated with a network node. To return this -// information about all the network interfaces specified in a decoder manifest, -// use the API operation. +// Represents a node and its specifications in an in-vehicle communication +// network. All signal decoders must be associated with a network node. To return +// this information about all the network interfaces specified in a decoder +// manifest, use the API operation. type NetworkInterface struct { // The ID of the network interface. @@ -603,8 +597,8 @@ type NetworkInterface struct { // The network protocol for the vehicle. For example, CAN_SIGNAL specifies a // protocol that defines how data is communicated between electronic control units - // (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is - // communicated between ECUs. + // (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data + // is communicated between ECUs. // // This member is required. Type NetworkInterfaceType @@ -613,8 +607,8 @@ type NetworkInterface struct { // (CAN) protocol. CanInterface *CanInterface - // Information about a network interface specified by the On-board diagnostic (OBD) - // II protocol. + // Information about a network interface specified by the On-board diagnostic + // (OBD) II protocol. ObdInterface *ObdInterface noSmithyDocumentSerde @@ -785,8 +779,8 @@ type Sensor struct { // This member is required. DataType NodeDataType - // The fully qualified name of the sensor. For example, the fully qualified name of - // a sensor might be Vehicle.Body.Engine.Battery. + // The fully qualified name of the sensor. For example, the fully qualified name + // of a sensor might be Vehicle.Body.Engine.Battery . // // This member is required. FullyQualifiedName *string @@ -809,8 +803,8 @@ type Sensor struct { noSmithyDocumentSerde } -// Information about a collection of standardized signals, which can be attributes, -// branches, sensors, or actuators. +// Information about a collection of standardized signals, which can be +// attributes, branches, sensors, or actuators. type SignalCatalogSummary struct { // The Amazon Resource Name (ARN) of the signal catalog. @@ -846,8 +840,8 @@ type SignalDecoder struct { // The network protocol for the vehicle. For example, CAN_SIGNAL specifies a // protocol that defines how data is communicated between electronic control units - // (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is - // communicated between ECUs. + // (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data + // is communicated between ECUs. // // This member is required. Type SignalDecoderType @@ -903,8 +897,8 @@ type Tag struct { type TimeBasedCollectionScheme struct { // The time period (in milliseconds) to decide how often to collect data. For - // example, if the time period is 60000, the Edge Agent software collects data once - // every minute. + // example, if the time period is 60000 , the Edge Agent software collects data + // once every minute. // // This member is required. PeriodMs *int64 @@ -916,7 +910,7 @@ type TimeBasedCollectionScheme struct { type TimestreamRegistrationResponse struct { // The status of registering your Amazon Timestream resources. The status can be - // one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE. + // one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE . // // This member is required. RegistrationStatus RegistrationStatus @@ -984,7 +978,7 @@ type UpdateVehicleRequestItem struct { VehicleName *string // The method the specified attributes will update the existing attributes on the - // vehicle. UseOverwite to replace the vehicle attributes with the specified + // vehicle. Use Overwite to replace the vehicle attributes with the specified // attributes. Or use Merge to combine all attributes. This is required if // attributes are present in the input. AttributeUpdateMode UpdateMode @@ -1040,21 +1034,13 @@ type VehicleStatus struct { CampaignName *string // The state of a vehicle, which can be one of the following: - // - // * CREATED - Amazon - // Web Services IoT FleetWise sucessfully created the vehicle. - // - // * READY - The - // vehicle is ready to receive a campaign deployment. - // - // * HEALTHY - A campaign - // deployment was delivered to the vehicle. - // - // * SUSPENDED - A campaign associated - // with the vehicle was suspended and data collection was paused. - // - // * DELETING - - // Amazon Web Services IoT FleetWise is removing a campaign from the vehicle. + // - CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle. + // - READY - The vehicle is ready to receive a campaign deployment. + // - HEALTHY - A campaign deployment was delivered to the vehicle. + // - SUSPENDED - A campaign associated with the vehicle was suspended and data + // collection was paused. + // - DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the + // vehicle. Status VehicleState // The unique ID of the vehicle. @@ -1083,8 +1069,8 @@ type VehicleSummary struct { // This member is required. DecoderManifestArn *string - // The time the vehicle was last updated in seconds since epoch (January 1, 1970 at - // midnight UTC time). + // The time the vehicle was last updated in seconds since epoch (January 1, 1970 + // at midnight UTC time). // // This member is required. LastModificationTime *time.Time diff --git a/service/iotjobsdataplane/api_client.go b/service/iotjobsdataplane/api_client.go index 264208e1d7a..a05786ec828 100644 --- a/service/iotjobsdataplane/api_client.go +++ b/service/iotjobsdataplane/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go b/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go index a6ee3c3acdc..cb6eee6005c 100644 --- a/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go +++ b/service/iotjobsdataplane/api_op_StartNextPendingJobExecution.go @@ -39,14 +39,14 @@ type StartNextPendingJobExecutionInput struct { // If not specified, the statusDetails are unchanged. StatusDetails map[string]string - // Specifies the amount of time this device has to finish execution of this job. If - // the job execution status is not set to a terminal state before this timer - // expires, or before the timer is reset (by calling UpdateJobExecution, setting + // Specifies the amount of time this device has to finish execution of this job. + // If the job execution status is not set to a terminal state before this timer + // expires, or before the timer is reset (by calling UpdateJobExecution , setting // the status to IN_PROGRESS and specifying a new timeout value in field - // stepTimeoutInMinutes) the job execution status will be automatically set to - // TIMED_OUT. Note that setting this timeout has no effect on that job execution - // timeout which may have been specified when the job was created (CreateJob using - // field timeoutConfig). + // stepTimeoutInMinutes ) the job execution status will be automatically set to + // TIMED_OUT . Note that setting this timeout has no effect on that job execution + // timeout which may have been specified when the job was created ( CreateJob + // using field timeoutConfig ). StepTimeoutInMinutes *int64 noSmithyDocumentSerde diff --git a/service/iotjobsdataplane/api_op_UpdateJobExecution.go b/service/iotjobsdataplane/api_op_UpdateJobExecution.go index 3426d3f5635..82f98bf9946 100644 --- a/service/iotjobsdataplane/api_op_UpdateJobExecution.go +++ b/service/iotjobsdataplane/api_op_UpdateJobExecution.go @@ -70,14 +70,14 @@ type UpdateJobExecutionInput struct { // execution. If not specified, the statusDetails are unchanged. StatusDetails map[string]string - // Specifies the amount of time this device has to finish execution of this job. If - // the job execution status is not set to a terminal state before this timer - // expires, or before the timer is reset (by again calling UpdateJobExecution, + // Specifies the amount of time this device has to finish execution of this job. + // If the job execution status is not set to a terminal state before this timer + // expires, or before the timer is reset (by again calling UpdateJobExecution , // setting the status to IN_PROGRESS and specifying a new timeout value in this - // field) the job execution status will be automatically set to TIMED_OUT. Note + // field) the job execution status will be automatically set to TIMED_OUT . Note // that setting or resetting this timeout has no effect on that job execution - // timeout which may have been specified when the job was created (CreateJob using - // field timeoutConfig). + // timeout which may have been specified when the job was created ( CreateJob + // using field timeoutConfig ). StepTimeoutInMinutes *int64 noSmithyDocumentSerde diff --git a/service/iotjobsdataplane/types/types.go b/service/iotjobsdataplane/types/types.go index 73195dc6b71..14edb2a2dca 100644 --- a/service/iotjobsdataplane/types/types.go +++ b/service/iotjobsdataplane/types/types.go @@ -9,8 +9,8 @@ import ( // Contains data about a job execution. type JobExecution struct { - // The estimated number of seconds that remain before the job execution status will - // be changed to TIMED_OUT. + // The estimated number of seconds that remain before the job execution status + // will be changed to TIMED_OUT . ApproximateSecondsBeforeTimedOut *int64 // A number that identifies a particular job execution on a particular device. It diff --git a/service/iotroborunner/api_client.go b/service/iotroborunner/api_client.go index 49799331814..46c9aa9fe54 100644 --- a/service/iotroborunner/api_client.go +++ b/service/iotroborunner/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotroborunner/api_op_CreateSite.go b/service/iotroborunner/api_op_CreateSite.go index 828ff826d25..55567003e90 100644 --- a/service/iotroborunner/api_op_CreateSite.go +++ b/service/iotroborunner/api_op_CreateSite.go @@ -30,8 +30,8 @@ func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns type CreateSiteInput struct { - // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., - // US. + // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. + // e.g., US. // // This member is required. CountryCode *string diff --git a/service/iotroborunner/api_op_GetSite.go b/service/iotroborunner/api_op_GetSite.go index 6ffa4527814..34572b084be 100644 --- a/service/iotroborunner/api_op_GetSite.go +++ b/service/iotroborunner/api_op_GetSite.go @@ -44,8 +44,8 @@ type GetSiteOutput struct { // This member is required. Arn *string - // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., - // US. + // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. + // e.g., US. // // This member is required. CountryCode *string diff --git a/service/iotroborunner/api_op_UpdateSite.go b/service/iotroborunner/api_op_UpdateSite.go index 38f60e1fc4f..dd635d35c7a 100644 --- a/service/iotroborunner/api_op_UpdateSite.go +++ b/service/iotroborunner/api_op_UpdateSite.go @@ -34,8 +34,8 @@ type UpdateSiteInput struct { // This member is required. Id *string - // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., - // US. + // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. + // e.g., US. CountryCode *string // A high-level description of the site. @@ -69,8 +69,8 @@ type UpdateSiteOutput struct { // This member is required. UpdatedAt *time.Time - // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., - // US. + // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. + // e.g., US. CountryCode *string // A high-level description of the site. diff --git a/service/iotroborunner/types/types.go b/service/iotroborunner/types/types.go index 658c4b81748..17b5a53cc96 100644 --- a/service/iotroborunner/types/types.go +++ b/service/iotroborunner/types/types.go @@ -114,8 +114,8 @@ type Site struct { // This member is required. Arn *string - // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., - // US. + // A valid ISO 3166-1 alpha-2 code for the country in which the site resides. + // e.g., US. // // This member is required. CountryCode *string diff --git a/service/iotsecuretunneling/api_client.go b/service/iotsecuretunneling/api_client.go index 3f3ecf1cc67..3c8df972f63 100644 --- a/service/iotsecuretunneling/api_client.go +++ b/service/iotsecuretunneling/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotsecuretunneling/api_op_CloseTunnel.go b/service/iotsecuretunneling/api_op_CloseTunnel.go index 99f53f7dadb..39b4d3aecc5 100644 --- a/service/iotsecuretunneling/api_op_CloseTunnel.go +++ b/service/iotsecuretunneling/api_op_CloseTunnel.go @@ -13,8 +13,7 @@ import ( // Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request // is received, we close the WebSocket connections between the client and proxy // server so no data can be transmitted. Requires permission to access the -// CloseTunnel -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// CloseTunnel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) CloseTunnel(ctx context.Context, params *CloseTunnelInput, optFns ...func(*Options)) (*CloseTunnelOutput, error) { if params == nil { diff --git a/service/iotsecuretunneling/api_op_DescribeTunnel.go b/service/iotsecuretunneling/api_op_DescribeTunnel.go index b98aef7af27..701f326cf14 100644 --- a/service/iotsecuretunneling/api_op_DescribeTunnel.go +++ b/service/iotsecuretunneling/api_op_DescribeTunnel.go @@ -12,8 +12,7 @@ import ( ) // Gets information about a tunnel identified by the unique tunnel id. Requires -// permission to access the DescribeTunnel -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// permission to access the DescribeTunnel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) DescribeTunnel(ctx context.Context, params *DescribeTunnelInput, optFns ...func(*Options)) (*DescribeTunnelOutput, error) { if params == nil { diff --git a/service/iotsecuretunneling/api_op_ListTunnels.go b/service/iotsecuretunneling/api_op_ListTunnels.go index 048fa8e7775..aaab506be89 100644 --- a/service/iotsecuretunneling/api_op_ListTunnels.go +++ b/service/iotsecuretunneling/api_op_ListTunnels.go @@ -14,8 +14,7 @@ import ( // List all tunnels for an Amazon Web Services account. Tunnels are listed by // creation time in descending order, newer tunnels will be listed before older -// tunnels. Requires permission to access the ListTunnels -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// tunnels. Requires permission to access the ListTunnels (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) ListTunnels(ctx context.Context, params *ListTunnelsInput, optFns ...func(*Options)) (*ListTunnelsOutput, error) { if params == nil { diff --git a/service/iotsecuretunneling/api_op_OpenTunnel.go b/service/iotsecuretunneling/api_op_OpenTunnel.go index bd993264a54..1e5b3068ccb 100644 --- a/service/iotsecuretunneling/api_op_OpenTunnel.go +++ b/service/iotsecuretunneling/api_op_OpenTunnel.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new tunnel, and returns two client access tokens for clients to use to -// connect to the IoT Secure Tunneling proxy server. Requires permission to access -// the OpenTunnel -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Creates a new tunnel, and returns two client access tokens for clients to use +// to connect to the IoT Secure Tunneling proxy server. Requires permission to +// access the OpenTunnel (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. func (c *Client) OpenTunnel(ctx context.Context, params *OpenTunnelInput, optFns ...func(*Options)) (*OpenTunnelOutput, error) { if params == nil { diff --git a/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go b/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go index 82c44003148..3b1d9cee6d3 100644 --- a/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go +++ b/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Revokes the current client access token (CAT) and returns new CAT for clients to -// use when reconnecting to secure tunneling to access the same tunnel. Requires -// permission to access the RotateTunnelAccessToken -// (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) +// Revokes the current client access token (CAT) and returns new CAT for clients +// to use when reconnecting to secure tunneling to access the same tunnel. Requires +// permission to access the RotateTunnelAccessToken (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. Rotating the CAT doesn't extend the tunnel duration. For example, say // the tunnel duration is 12 hours and the tunnel has already been open for 4 // hours. When you rotate the access tokens, the new tokens that are generated can diff --git a/service/iotsecuretunneling/doc.go b/service/iotsecuretunneling/doc.go index 712de8d6c9d..a17cc7cc4ac 100644 --- a/service/iotsecuretunneling/doc.go +++ b/service/iotsecuretunneling/doc.go @@ -5,6 +5,6 @@ // // IoT Secure Tunneling IoT Secure Tunneling creates remote connections to devices // deployed in the field. For more information about how IoT Secure Tunneling -// works, see IoT Secure Tunneling -// (https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html). +// works, see IoT Secure Tunneling (https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html) +// . package iotsecuretunneling diff --git a/service/iotsecuretunneling/types/enums.go b/service/iotsecuretunneling/types/enums.go index ac966d2fc93..02eba13c72d 100644 --- a/service/iotsecuretunneling/types/enums.go +++ b/service/iotsecuretunneling/types/enums.go @@ -48,9 +48,9 @@ const ( TunnelStatusClosed TunnelStatus = "CLOSED" ) -// Values returns all known values for TunnelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TunnelStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TunnelStatus) Values() []TunnelStatus { return []TunnelStatus{ "OPEN", diff --git a/service/iotsecuretunneling/types/types.go b/service/iotsecuretunneling/types/types.go index 4f5632fef2c..51a86f03a59 100644 --- a/service/iotsecuretunneling/types/types.go +++ b/service/iotsecuretunneling/types/types.go @@ -13,8 +13,8 @@ type ConnectionState struct { // The last time the connection status was updated. LastUpdatedAt *time.Time - // The connection status of the tunnel. Valid values are CONNECTED and - // DISCONNECTED. + // The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED + // . Status ConnectionStatus noSmithyDocumentSerde diff --git a/service/iotsitewise/api_client.go b/service/iotsitewise/api_client.go index 8588855176b..dd76e733d6a 100644 --- a/service/iotsitewise/api_client.go +++ b/service/iotsitewise/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotsitewise/api_op_AssociateAssets.go b/service/iotsitewise/api_op_AssociateAssets.go index 214c1ac2638..e5aebce36ec 100644 --- a/service/iotsitewise/api_op_AssociateAssets.go +++ b/service/iotsitewise/api_op_AssociateAssets.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a child asset with the given parent asset through a hierarchy defined -// in the parent asset's model. For more information, see Associating assets -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) +// Associates a child asset with the given parent asset through a hierarchy +// defined in the parent asset's model. For more information, see Associating +// assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) // in the IoT SiteWise User Guide. func (c *Client) AssociateAssets(ctx context.Context, params *AssociateAssetsInput, optFns ...func(*Options)) (*AssociateAssetsOutput, error) { if params == nil { @@ -44,8 +44,7 @@ type AssociateAssetsInput struct { // The ID of a hierarchy in the parent asset's model. Hierarchies allow different // groupings of assets to be formed that all come from the same asset model. For - // more information, see Asset hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. // // This member is required. diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go b/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go index 1953520777e..c352d48cf85 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go @@ -13,8 +13,7 @@ import ( ) // Gets aggregated values (for example, average, minimum, and maximum) for one or -// more asset properties. For more information, see Querying aggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) +// more asset properties. For more information, see Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) // in the IoT SiteWise User Guide. func (c *Client) BatchGetAssetPropertyAggregates(ctx context.Context, params *BatchGetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*BatchGetAssetPropertyAggregatesOutput, error) { if params == nil { @@ -39,14 +38,11 @@ type BatchGetAssetPropertyAggregatesInput struct { // This member is required. Entries []types.BatchGetAssetPropertyAggregatesEntry - // The maximum number of results to return for each paginated request. A result set - // is returned in the two cases, whichever occurs first. - // - // * The size of the result - // set is less than 1 MB. - // - // * The number of data points in the result set is less - // than the value of maxResults. The maximum value of maxResults is 4000. + // The maximum number of results to return for each paginated request. A result + // set is returned in the two cases, whichever occurs first. + // - The size of the result set is less than 1 MB. + // - The number of data points in the result set is less than the value of + // maxResults . The maximum value of maxResults is 4000. MaxResults *int32 // The token to be used for the next set of paginated results. @@ -191,14 +187,11 @@ var _ BatchGetAssetPropertyAggregatesAPIClient = (*Client)(nil) // BatchGetAssetPropertyAggregatesPaginatorOptions is the paginator options for // BatchGetAssetPropertyAggregates type BatchGetAssetPropertyAggregatesPaginatorOptions struct { - // The maximum number of results to return for each paginated request. A result set - // is returned in the two cases, whichever occurs first. - // - // * The size of the result - // set is less than 1 MB. - // - // * The number of data points in the result set is less - // than the value of maxResults. The maximum value of maxResults is 4000. + // The maximum number of results to return for each paginated request. A result + // set is returned in the two cases, whichever occurs first. + // - The size of the result set is less than 1 MB. + // - The number of data points in the result set is less than the value of + // maxResults . The maximum value of maxResults is 4000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go b/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go index 8d7f3558564..3ed294b0706 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go @@ -13,8 +13,7 @@ import ( ) // Gets the current value for one or more asset properties. For more information, -// see Querying current values -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) +// see Querying current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) // in the IoT SiteWise User Guide. func (c *Client) BatchGetAssetPropertyValue(ctx context.Context, params *BatchGetAssetPropertyValueInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueOutput, error) { if params == nil { diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go b/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go index ca9a4001b6e..c2b1ea6d77b 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go @@ -13,8 +13,7 @@ import ( ) // Gets the historical values for one or more asset properties. For more -// information, see Querying historical values -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) +// information, see Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) // in the IoT SiteWise User Guide. func (c *Client) BatchGetAssetPropertyValueHistory(ctx context.Context, params *BatchGetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueHistoryOutput, error) { if params == nil { @@ -39,14 +38,11 @@ type BatchGetAssetPropertyValueHistoryInput struct { // This member is required. Entries []types.BatchGetAssetPropertyValueHistoryEntry - // The maximum number of results to return for each paginated request. A result set - // is returned in the two cases, whichever occurs first. - // - // * The size of the result - // set is less than 1 MB. - // - // * The number of data points in the result set is less - // than the value of maxResults. The maximum value of maxResults is 4000. + // The maximum number of results to return for each paginated request. A result + // set is returned in the two cases, whichever occurs first. + // - The size of the result set is less than 1 MB. + // - The number of data points in the result set is less than the value of + // maxResults . The maximum value of maxResults is 4000. MaxResults *int32 // The token to be used for the next set of paginated results. @@ -191,14 +187,11 @@ var _ BatchGetAssetPropertyValueHistoryAPIClient = (*Client)(nil) // BatchGetAssetPropertyValueHistoryPaginatorOptions is the paginator options for // BatchGetAssetPropertyValueHistory type BatchGetAssetPropertyValueHistoryPaginatorOptions struct { - // The maximum number of results to return for each paginated request. A result set - // is returned in the two cases, whichever occurs first. - // - // * The size of the result - // set is less than 1 MB. - // - // * The number of data points in the result set is less - // than the value of maxResults. The maximum value of maxResults is 4000. + // The maximum number of results to return for each paginated request. A result + // set is returned in the two cases, whichever occurs first. + // - The size of the result set is less than 1 MB. + // - The number of data points in the result set is less than the value of + // maxResults . The maximum value of maxResults is 4000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go b/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go index 3b1a7dd3fd0..0f2ee8ad0f4 100644 --- a/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go +++ b/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go @@ -14,30 +14,24 @@ import ( // Sends a list of asset property values to IoT SiteWise. Each value is a // timestamp-quality-value (TQV) data point. For more information, see Ingesting -// data using the API -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) in -// the IoT SiteWise User Guide. To identify an asset property, you must specify one -// of the following: +// data using the API (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) +// in the IoT SiteWise User Guide. To identify an asset property, you must specify +// one of the following: +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . // -// * The assetId and propertyId of an asset property. -// -// * A -// propertyAlias, which is a data stream alias (for example, -// /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, -// see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). -// -// With -// respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp -// of no more than 7 days in the past and no more than 10 minutes in the future. -// IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 -// minutes] and returns a TimestampOutOfRangeException error. For each asset -// property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the -// newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, -// V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise +// With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a +// timestamp of no more than 7 days in the past and no more than 10 minutes in the +// future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 +// days, +10 minutes] and returns a TimestampOutOfRangeException error. For each +// asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless +// the newer TQV has a different quality. For example, if you store a TQV {T1, +// GOOD, V1} , then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise // authorizes access to each BatchPutAssetPropertyValue entry individually. For -// more information, see BatchPutAssetPropertyValue authorization -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) +// more information, see BatchPutAssetPropertyValue authorization (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) // in the IoT SiteWise User Guide. func (c *Client) BatchPutAssetPropertyValue(ctx context.Context, params *BatchPutAssetPropertyValueInput, optFns ...func(*Options)) (*BatchPutAssetPropertyValueOutput, error) { if params == nil { diff --git a/service/iotsitewise/api_op_CreateAccessPolicy.go b/service/iotsitewise/api_op_CreateAccessPolicy.go index b19ff3f9095..e50b9658012 100644 --- a/service/iotsitewise/api_op_CreateAccessPolicy.go +++ b/service/iotsitewise/api_op_CreateAccessPolicy.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an access policy that grants the specified identity (IAM Identity Center -// user, IAM Identity Center group, or IAM user) access to the specified IoT +// Creates an access policy that grants the specified identity (IAM Identity +// Center user, IAM Identity Center group, or IAM user) access to the specified IoT // SiteWise Monitor portal or project resource. func (c *Client) CreateAccessPolicy(ctx context.Context, params *CreateAccessPolicyInput, optFns ...func(*Options)) (*CreateAccessPolicyOutput, error) { if params == nil { @@ -44,8 +44,8 @@ type CreateAccessPolicyInput struct { // This member is required. AccessPolicyPermission types.Permission - // The IoT SiteWise Monitor resource for this access policy. Choose either a portal - // or a project. + // The IoT SiteWise Monitor resource for this access policy. Choose either a + // portal or a project. // // This member is required. AccessPolicyResource *types.Resource @@ -56,8 +56,7 @@ type CreateAccessPolicyInput struct { ClientToken *string // A list of key-value pairs that contain metadata for the access policy. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -66,9 +65,8 @@ type CreateAccessPolicyInput struct { type CreateAccessPolicyOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the access policy, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the access policy, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} // // This member is required. diff --git a/service/iotsitewise/api_op_CreateAsset.go b/service/iotsitewise/api_op_CreateAsset.go index 720560b09eb..8bbea6f25af 100644 --- a/service/iotsitewise/api_op_CreateAsset.go +++ b/service/iotsitewise/api_op_CreateAsset.go @@ -13,8 +13,7 @@ import ( ) // Creates an asset from an existing asset model. For more information, see -// Creating assets -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) +// Creating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) // in the IoT SiteWise User Guide. func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error) { if params == nil { @@ -52,8 +51,7 @@ type CreateAssetInput struct { ClientToken *string // A list of key-value pairs that contain metadata for the asset. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -62,9 +60,8 @@ type CreateAssetInput struct { type CreateAssetOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. @@ -76,7 +73,7 @@ type CreateAssetOutput struct { // This member is required. AssetId *string - // The status of the asset, which contains a state (CREATING after successfully + // The status of the asset, which contains a state ( CREATING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_CreateAssetModel.go b/service/iotsitewise/api_op_CreateAssetModel.go index d093098c2dc..bdaa3f0170a 100644 --- a/service/iotsitewise/api_op_CreateAssetModel.go +++ b/service/iotsitewise/api_op_CreateAssetModel.go @@ -16,8 +16,7 @@ import ( // create assets from asset models. With asset models, you can easily create assets // of the same type that have standardized definitions. Each asset created from a // model inherits the asset model's property and hierarchy definitions. For more -// information, see Defining asset models -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) +// information, see Defining asset models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) // in the IoT SiteWise User Guide. func (c *Client) CreateAssetModel(ctx context.Context, params *CreateAssetModelInput, optFns ...func(*Options)) (*CreateAssetModelOutput, error) { if params == nil { @@ -52,21 +51,17 @@ type CreateAssetModelInput struct { // The hierarchy definitions of the asset model. Each hierarchy specifies an asset // model whose assets can be children of any other assets created from this asset - // model. For more information, see Asset hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // model. For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset - // model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. AssetModelHierarchies []types.AssetModelHierarchyDefinition // The property definitions of the asset model. For more information, see Asset - // properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) + // properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) // in the IoT SiteWise User Guide. You can specify up to 200 properties per asset - // model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. AssetModelProperties []types.AssetModelPropertyDefinition // A unique case-sensitive identifier that you can provide to ensure the @@ -75,8 +70,7 @@ type CreateAssetModelInput struct { ClientToken *string // A list of key-value pairs that contain metadata for the asset model. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -85,9 +79,8 @@ type CreateAssetModelInput struct { type CreateAssetModelOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset model, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset model, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} // // This member is required. @@ -99,7 +92,7 @@ type CreateAssetModelOutput struct { // This member is required. AssetModelId *string - // The status of the asset model, which contains a state (CREATING after + // The status of the asset model, which contains a state ( CREATING after // successfully calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_CreateBulkImportJob.go b/service/iotsitewise/api_op_CreateBulkImportJob.go index 354a99c82be..a7486940d0f 100644 --- a/service/iotsitewise/api_op_CreateBulkImportJob.go +++ b/service/iotsitewise/api_op_CreateBulkImportJob.go @@ -13,12 +13,11 @@ import ( ) // Defines a job to ingest data to IoT SiteWise from Amazon S3. For more -// information, see Create a bulk import job (CLI) -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html) +// information, see Create a bulk import job (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html) // in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to // export data to Amazon S3 before you create a bulk import job. For more -// information about how to configure storage settings, see PutStorageConfiguration -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html). +// information about how to configure storage settings, see PutStorageConfiguration (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html) +// . func (c *Client) CreateBulkImportJob(ctx context.Context, params *CreateBulkImportJobInput, optFns ...func(*Options)) (*CreateBulkImportJobOutput, error) { if params == nil { params = &CreateBulkImportJobInput{} @@ -47,8 +46,8 @@ type CreateBulkImportJobInput struct { // This member is required. Files []types.File - // Contains the configuration information of a job, such as the file format used to - // save data in Amazon S3. + // Contains the configuration information of a job, such as the file format used + // to save data in Amazon S3. // // This member is required. JobConfiguration *types.JobConfiguration @@ -58,9 +57,8 @@ type CreateBulkImportJobInput struct { // This member is required. JobName *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IAM role that allows IoT SiteWise to read Amazon S3 data. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IAM role that allows IoT SiteWise to read Amazon S3 data. // // This member is required. JobRoleArn *string @@ -81,27 +79,18 @@ type CreateBulkImportJobOutput struct { JobName *string // The status of the bulk import job can be one of following values. - // - // * PENDING – - // IoT SiteWise is waiting for the current bulk import job to finish. - // - // * CANCELLED - // – The bulk import job has been canceled. - // - // * RUNNING – IoT SiteWise is processing - // your request to import your data from Amazon S3. - // - // * COMPLETED – IoT SiteWise - // successfully completed your request to import data from Amazon S3. - // - // * FAILED – - // IoT SiteWise couldn't process your request to import data from Amazon S3. You - // can use logs saved in the specified error report location in Amazon S3 to - // troubleshoot issues. - // - // * COMPLETED_WITH_FAILURES – IoT SiteWise completed your - // request to import data from Amazon S3 with errors. You can use logs saved in the - // specified error report location in Amazon S3 to troubleshoot issues. + // - PENDING – IoT SiteWise is waiting for the current bulk import job to finish. + // - CANCELLED – The bulk import job has been canceled. + // - RUNNING – IoT SiteWise is processing your request to import your data from + // Amazon S3. + // - COMPLETED – IoT SiteWise successfully completed your request to import data + // from Amazon S3. + // - FAILED – IoT SiteWise couldn't process your request to import data from + // Amazon S3. You can use logs saved in the specified error report location in + // Amazon S3 to troubleshoot issues. + // - COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data + // from Amazon S3 with errors. You can use logs saved in the specified error report + // location in Amazon S3 to troubleshoot issues. // // This member is required. JobStatus types.JobStatus diff --git a/service/iotsitewise/api_op_CreateDashboard.go b/service/iotsitewise/api_op_CreateDashboard.go index acd7995d391..a7e5ec5d9bf 100644 --- a/service/iotsitewise/api_op_CreateDashboard.go +++ b/service/iotsitewise/api_op_CreateDashboard.go @@ -30,8 +30,7 @@ func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInp type CreateDashboardInput struct { // The dashboard definition specified in a JSON literal. For detailed information, - // see Creating dashboards (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) + // see Creating dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) // in the IoT SiteWise User Guide. // // This member is required. @@ -56,8 +55,7 @@ type CreateDashboardInput struct { DashboardDescription *string // A list of key-value pairs that contain metadata for the dashboard. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -66,9 +64,8 @@ type CreateDashboardInput struct { type CreateDashboardOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the dashboard, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the dashboard, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} // // This member is required. diff --git a/service/iotsitewise/api_op_CreateGateway.go b/service/iotsitewise/api_op_CreateGateway.go index 86b3e761897..2e3b898a8b0 100644 --- a/service/iotsitewise/api_op_CreateGateway.go +++ b/service/iotsitewise/api_op_CreateGateway.go @@ -14,8 +14,7 @@ import ( // Creates a gateway, which is a virtual or edge device that delivers industrial // data streams from local servers to IoT SiteWise. For more information, see -// Ingesting data using a gateway -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) +// Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) // in the IoT SiteWise User Guide. func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, optFns ...func(*Options)) (*CreateGatewayOutput, error) { if params == nil { @@ -45,8 +44,7 @@ type CreateGatewayInput struct { GatewayPlatform *types.GatewayPlatform // A list of key-value pairs that contain metadata for the gateway. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -55,9 +53,8 @@ type CreateGatewayInput struct { type CreateGatewayOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the gateway, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the gateway, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} // // This member is required. diff --git a/service/iotsitewise/api_op_CreatePortal.go b/service/iotsitewise/api_op_CreatePortal.go index f556105d1dd..cfd6b61faf2 100644 --- a/service/iotsitewise/api_op_CreatePortal.go +++ b/service/iotsitewise/api_op_CreatePortal.go @@ -15,9 +15,8 @@ import ( // Creates a portal, which can contain projects and dashboards. IoT SiteWise // Monitor uses IAM Identity Center or IAM to authenticate portal users and manage // user permissions. Before you can sign in to a new portal, you must add at least -// one identity to that portal. For more information, see Adding or removing portal -// administrators -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) +// one identity to that portal. For more information, see Adding or removing +// portal administrators (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) // in the IoT SiteWise User Guide. func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, optFns ...func(*Options)) (*CreatePortalOutput, error) { if params == nil { @@ -46,12 +45,10 @@ type CreatePortalInput struct { // This member is required. PortalName *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // a service role that allows the portal's users to access your IoT SiteWise + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of a service role that allows the portal's users to access your IoT SiteWise // resources on your behalf. For more information, see Using service roles for IoT - // SiteWise Monitor - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) + // SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. // // This member is required. @@ -60,8 +57,7 @@ type CreatePortalInput struct { // Contains the configuration information of an alarm created in an IoT SiteWise // Monitor portal. You can use the alarm to monitor an asset property and get // notified when the asset property value is outside a specified range. For more - // information, see Monitoring with alarms - // (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) + // information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) // in the IoT SiteWise Application Guide. Alarms *types.Alarms @@ -71,28 +67,22 @@ type CreatePortalInput struct { ClientToken *string // The email address that sends alarm notifications. If you use the IoT Events - // managed Lambda function - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) - // to manage your emails, you must verify the sender email address in Amazon SES - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). + // managed Lambda function (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) + // to manage your emails, you must verify the sender email address in Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) + // . NotificationSenderEmail *string // The service to use to authenticate users to the portal. Choose from the // following options: - // - // * SSO – The portal uses IAM Identity Center (successor to - // Single Sign-On) to authenticate users and manage user permissions. Before you - // can create a portal that uses IAM Identity Center, you must enable IAM Identity - // Center. For more information, see Enabling IAM Identity Center - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) - // in the IoT SiteWise User Guide. This option is only available in Amazon Web - // Services Regions other than the China Regions. - // - // * IAM – The portal uses Identity - // and Access Management to authenticate users and manage user permissions. - // - // You - // can't change this value after you create a portal. Default: SSO + // - SSO – The portal uses IAM Identity Center (successor to Single Sign-On) to + // authenticate users and manage user permissions. Before you can create a portal + // that uses IAM Identity Center, you must enable IAM Identity Center. For more + // information, see Enabling IAM Identity Center (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) + // in the IoT SiteWise User Guide. This option is only available in Amazon Web + // Services Regions other than the China Regions. + // - IAM – The portal uses Identity and Access Management to authenticate users + // and manage user permissions. + // You can't change this value after you create a portal. Default: SSO PortalAuthMode types.AuthMode // A description for the portal. @@ -103,8 +93,7 @@ type CreatePortalInput struct { PortalLogoImageFile *types.ImageFile // A list of key-value pairs that contain metadata for the portal. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -113,9 +102,8 @@ type CreatePortalInput struct { type CreatePortalOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the portal, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the portal, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} // // This member is required. @@ -134,7 +122,7 @@ type CreatePortalOutput struct { // This member is required. PortalStartUrl *string - // The status of the portal, which contains a state (CREATING after successfully + // The status of the portal, which contains a state ( CREATING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_CreateProject.go b/service/iotsitewise/api_op_CreateProject.go index f8d37fc7a68..870c735f6e8 100644 --- a/service/iotsitewise/api_op_CreateProject.go +++ b/service/iotsitewise/api_op_CreateProject.go @@ -49,8 +49,7 @@ type CreateProjectInput struct { ProjectDescription *string // A list of key-value pairs that contain metadata for the project. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string @@ -59,9 +58,8 @@ type CreateProjectInput struct { type CreateProjectOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the project, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the project, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} // // This member is required. diff --git a/service/iotsitewise/api_op_DeleteAsset.go b/service/iotsitewise/api_op_DeleteAsset.go index 6fa49d58378..2ae14cde461 100644 --- a/service/iotsitewise/api_op_DeleteAsset.go +++ b/service/iotsitewise/api_op_DeleteAsset.go @@ -13,11 +13,10 @@ import ( ) // Deletes an asset. This action can't be undone. For more information, see -// Deleting assets and models -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) +// Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) // in the IoT SiteWise User Guide. You can't delete an asset that's associated to -// another asset. For more information, see DisassociateAssets -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html). +// another asset. For more information, see DisassociateAssets (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html) +// . func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error) { if params == nil { params = &DeleteAssetInput{} @@ -50,7 +49,7 @@ type DeleteAssetInput struct { type DeleteAssetOutput struct { - // The status of the asset, which contains a state (DELETING after successfully + // The status of the asset, which contains a state ( DELETING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_DeleteAssetModel.go b/service/iotsitewise/api_op_DeleteAssetModel.go index 020a3ba1eff..94e3fdfac4a 100644 --- a/service/iotsitewise/api_op_DeleteAssetModel.go +++ b/service/iotsitewise/api_op_DeleteAssetModel.go @@ -16,8 +16,7 @@ import ( // created from an asset model before you can delete the model. Also, you can't // delete an asset model if a parent asset model exists that contains a property // formula expression that depends on the asset model that you want to delete. For -// more information, see Deleting assets and models -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) +// more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) // in the IoT SiteWise User Guide. func (c *Client) DeleteAssetModel(ctx context.Context, params *DeleteAssetModelInput, optFns ...func(*Options)) (*DeleteAssetModelOutput, error) { if params == nil { @@ -51,7 +50,7 @@ type DeleteAssetModelInput struct { type DeleteAssetModelOutput struct { - // The status of the asset model, which contains a state (DELETING after + // The status of the asset model, which contains a state ( DELETING after // successfully calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_DeletePortal.go b/service/iotsitewise/api_op_DeletePortal.go index f6e7a4fcdb6..9dfbd80f826 100644 --- a/service/iotsitewise/api_op_DeletePortal.go +++ b/service/iotsitewise/api_op_DeletePortal.go @@ -45,7 +45,7 @@ type DeletePortalInput struct { type DeletePortalOutput struct { - // The status of the portal, which contains a state (DELETING after successfully + // The status of the portal, which contains a state ( DELETING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_DeleteTimeSeries.go b/service/iotsitewise/api_op_DeleteTimeSeries.go index dbb9845c047..80df05dda2f 100644 --- a/service/iotsitewise/api_op_DeleteTimeSeries.go +++ b/service/iotsitewise/api_op_DeleteTimeSeries.go @@ -15,18 +15,12 @@ import ( // associated with an asset property, the asset property still exists, but the time // series will no longer be associated with this asset property. To identify a time // series, do one of the following: -// -// * If the time series isn't associated with an -// asset property, specify the alias of the time series. -// -// * If the time series is -// associated with an asset property, specify one of the following: -// -// * The alias of -// the time series. -// -// * The assetId and propertyId that identifies the asset -// property. +// - If the time series isn't associated with an asset property, specify the +// alias of the time series. +// - If the time series is associated with an asset property, specify one of the +// following: +// - The alias of the time series. +// - The assetId and propertyId that identifies the asset property. func (c *Client) DeleteTimeSeries(ctx context.Context, params *DeleteTimeSeriesInput, optFns ...func(*Options)) (*DeleteTimeSeriesOutput, error) { if params == nil { params = &DeleteTimeSeriesInput{} diff --git a/service/iotsitewise/api_op_DescribeAccessPolicy.go b/service/iotsitewise/api_op_DescribeAccessPolicy.go index ff45dd8bbe2..f677e770a33 100644 --- a/service/iotsitewise/api_op_DescribeAccessPolicy.go +++ b/service/iotsitewise/api_op_DescribeAccessPolicy.go @@ -42,9 +42,8 @@ type DescribeAccessPolicyInput struct { type DescribeAccessPolicyOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the access policy, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the access policy, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} // // This member is required. @@ -71,8 +70,8 @@ type DescribeAccessPolicyOutput struct { // This member is required. AccessPolicyLastUpdateDate *time.Time - // The access policy permission. Note that a project ADMINISTRATOR is also known as - // a project owner. + // The access policy permission. Note that a project ADMINISTRATOR is also known + // as a project owner. // // This member is required. AccessPolicyPermission types.Permission diff --git a/service/iotsitewise/api_op_DescribeAsset.go b/service/iotsitewise/api_op_DescribeAsset.go index 49e603970ce..5b260151d50 100644 --- a/service/iotsitewise/api_op_DescribeAsset.go +++ b/service/iotsitewise/api_op_DescribeAsset.go @@ -48,9 +48,8 @@ type DescribeAssetInput struct { type DescribeAssetOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. @@ -61,7 +60,7 @@ type DescribeAssetOutput struct { // This member is required. AssetCreationDate *time.Time - // A list of asset hierarchies that each contain a hierarchyId. A hierarchy + // A list of asset hierarchies that each contain a hierarchyId . A hierarchy // specifies allowed parent/child asset relationships. // // This member is required. @@ -224,9 +223,9 @@ type AssetActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AssetActiveWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AssetActiveWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -400,9 +399,9 @@ type AssetNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AssetNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AssetNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/iotsitewise/api_op_DescribeAssetModel.go b/service/iotsitewise/api_op_DescribeAssetModel.go index a3d50bca023..107bc652b44 100644 --- a/service/iotsitewise/api_op_DescribeAssetModel.go +++ b/service/iotsitewise/api_op_DescribeAssetModel.go @@ -48,9 +48,8 @@ type DescribeAssetModelInput struct { type DescribeAssetModelOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset model, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset model, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} // // This member is required. @@ -67,7 +66,7 @@ type DescribeAssetModelOutput struct { AssetModelDescription *string // A list of asset model hierarchies that each contain a childAssetModelId and a - // hierarchyId (named id). A hierarchy specifies allowed parent/child asset + // hierarchyId (named id ). A hierarchy specifies allowed parent/child asset // relationships for an asset model. // // This member is required. @@ -224,9 +223,9 @@ type AssetModelActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AssetModelActiveWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AssetModelActiveWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -402,9 +401,10 @@ type AssetModelNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AssetModelNotExistsWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AssetModelNotExistsWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -444,9 +444,9 @@ func NewAssetModelNotExistsWaiter(client DescribeAssetModelAPIClient, optFns ... } } -// Wait calls the waiter function for AssetModelNotExists waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for AssetModelNotExists waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *AssetModelNotExistsWaiter) Wait(ctx context.Context, params *DescribeAssetModelInput, maxWaitDur time.Duration, optFns ...func(*AssetModelNotExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/iotsitewise/api_op_DescribeAssetProperty.go b/service/iotsitewise/api_op_DescribeAssetProperty.go index c1ae57b9f01..0a5bc98a8b2 100644 --- a/service/iotsitewise/api_op_DescribeAssetProperty.go +++ b/service/iotsitewise/api_op_DescribeAssetProperty.go @@ -17,8 +17,8 @@ import ( // you define in the asset model. If you update the default value in the model, // this operation's response includes the new default value. This operation doesn't // return the value of the asset property. To get the value of an asset property, -// use GetAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html). +// use GetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html) +// . func (c *Client) DescribeAssetProperty(ctx context.Context, params *DescribeAssetPropertyInput, optFns ...func(*Options)) (*DescribeAssetPropertyOutput, error) { if params == nil { params = &DescribeAssetPropertyInput{} @@ -69,7 +69,7 @@ type DescribeAssetPropertyOutput struct { // The asset property's definition, alias, and notification state. This response // includes this object for normal asset properties. If you describe an asset // property in a composite model, this response includes the asset property - // information in compositeModel. + // information in compositeModel . AssetProperty *types.Property // The composite asset model that declares this asset property, if this asset diff --git a/service/iotsitewise/api_op_DescribeBulkImportJob.go b/service/iotsitewise/api_op_DescribeBulkImportJob.go index a94e847a673..738b8ce9d8c 100644 --- a/service/iotsitewise/api_op_DescribeBulkImportJob.go +++ b/service/iotsitewise/api_op_DescribeBulkImportJob.go @@ -13,9 +13,8 @@ import ( "time" ) -// Retrieves information about a bulk import job request. For more information, see -// Describe a bulk import job (CLI) -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html) +// Retrieves information about a bulk import job request. For more information, +// see Describe a bulk import job (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html) // in the Amazon Simple Storage Service User Guide. func (c *Client) DescribeBulkImportJob(ctx context.Context, params *DescribeBulkImportJobInput, optFns ...func(*Options)) (*DescribeBulkImportJobOutput, error) { if params == nil { @@ -55,8 +54,8 @@ type DescribeBulkImportJobOutput struct { // This member is required. Files []types.File - // Contains the configuration information of a job, such as the file format used to - // save data in Amazon S3. + // Contains the configuration information of a job, such as the file format used + // to save data in Amazon S3. // // This member is required. JobConfiguration *types.JobConfiguration @@ -81,35 +80,25 @@ type DescribeBulkImportJobOutput struct { // This member is required. JobName *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IAM role that allows IoT SiteWise to read Amazon S3 data. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IAM role that allows IoT SiteWise to read Amazon S3 data. // // This member is required. JobRoleArn *string // The status of the bulk import job can be one of following values. - // - // * PENDING – - // IoT SiteWise is waiting for the current bulk import job to finish. - // - // * CANCELLED - // – The bulk import job has been canceled. - // - // * RUNNING – IoT SiteWise is processing - // your request to import your data from Amazon S3. - // - // * COMPLETED – IoT SiteWise - // successfully completed your request to import data from Amazon S3. - // - // * FAILED – - // IoT SiteWise couldn't process your request to import data from Amazon S3. You - // can use logs saved in the specified error report location in Amazon S3 to - // troubleshoot issues. - // - // * COMPLETED_WITH_FAILURES – IoT SiteWise completed your - // request to import data from Amazon S3 with errors. You can use logs saved in the - // specified error report location in Amazon S3 to troubleshoot issues. + // - PENDING – IoT SiteWise is waiting for the current bulk import job to finish. + // - CANCELLED – The bulk import job has been canceled. + // - RUNNING – IoT SiteWise is processing your request to import your data from + // Amazon S3. + // - COMPLETED – IoT SiteWise successfully completed your request to import data + // from Amazon S3. + // - FAILED – IoT SiteWise couldn't process your request to import data from + // Amazon S3. You can use logs saved in the specified error report location in + // Amazon S3 to troubleshoot issues. + // - COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data + // from Amazon S3 with errors. You can use logs saved in the specified error report + // location in Amazon S3 to troubleshoot issues. // // This member is required. JobStatus types.JobStatus diff --git a/service/iotsitewise/api_op_DescribeDashboard.go b/service/iotsitewise/api_op_DescribeDashboard.go index 05401048b83..5d32ded26f0 100644 --- a/service/iotsitewise/api_op_DescribeDashboard.go +++ b/service/iotsitewise/api_op_DescribeDashboard.go @@ -40,9 +40,8 @@ type DescribeDashboardInput struct { type DescribeDashboardOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the dashboard, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the dashboard, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} // // This member is required. @@ -54,8 +53,7 @@ type DescribeDashboardOutput struct { DashboardCreationDate *time.Time // The dashboard's definition JSON literal. For detailed information, see Creating - // dashboards (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) + // dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) // in the IoT SiteWise User Guide. // // This member is required. diff --git a/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go b/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go index f41ac772dca..4bcbaf01125 100644 --- a/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go +++ b/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go @@ -14,8 +14,7 @@ import ( // Retrieves information about the default encryption configuration for the Amazon // Web Services account in the default or specified Region. For more information, -// see Key management -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) +// see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) // in the IoT SiteWise User Guide. func (c *Client) DescribeDefaultEncryptionConfiguration(ctx context.Context, params *DescribeDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*DescribeDefaultEncryptionConfigurationOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type DescribeDefaultEncryptionConfigurationInput struct { type DescribeDefaultEncryptionConfigurationOutput struct { - // The status of the account configuration. This contains the ConfigurationState. - // If there's an error, it also contains the ErrorDetails. + // The status of the account configuration. This contains the ConfigurationState . + // If there's an error, it also contains the ErrorDetails . // // This member is required. ConfigurationStatus *types.ConfigurationStatus @@ -50,7 +49,7 @@ type DescribeDefaultEncryptionConfigurationOutput struct { EncryptionType types.EncryptionType // The key ARN of the customer managed key used for KMS encryption if you use - // KMS_BASED_ENCRYPTION. + // KMS_BASED_ENCRYPTION . KmsKeyArn *string // Metadata pertaining to the operation's result. diff --git a/service/iotsitewise/api_op_DescribeGateway.go b/service/iotsitewise/api_op_DescribeGateway.go index 8a621209fff..3f78827a963 100644 --- a/service/iotsitewise/api_op_DescribeGateway.go +++ b/service/iotsitewise/api_op_DescribeGateway.go @@ -46,19 +46,18 @@ type DescribeGatewayOutput struct { // This member is required. CreationDate *time.Time - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the gateway, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the gateway, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} // // This member is required. GatewayArn *string - // A list of gateway capability summaries that each contain a namespace and status. - // Each gateway capability defines data sources for the gateway. To retrieve a - // capability configuration's definition, use - // DescribeGatewayCapabilityConfiguration - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). + // A list of gateway capability summaries that each contain a namespace and + // status. Each gateway capability defines data sources for the gateway. To + // retrieve a capability configuration's definition, use + // DescribeGatewayCapabilityConfiguration (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html) + // . // // This member is required. GatewayCapabilitySummaries []types.GatewayCapabilitySummary diff --git a/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go b/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go index 6de0bc9a267..99b2cdbe6f1 100644 --- a/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go @@ -17,8 +17,8 @@ import ( // contain multiple data source configurations. If you define OPC-UA sources for a // gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in // one capability configuration. To list all capability configurations for a -// gateway, use DescribeGateway -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html). +// gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html) +// . func (c *Client) DescribeGatewayCapabilityConfiguration(ctx context.Context, params *DescribeGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*DescribeGatewayCapabilityConfigurationOutput, error) { if params == nil { params = &DescribeGatewayCapabilityConfigurationInput{} @@ -38,8 +38,8 @@ type DescribeGatewayCapabilityConfigurationInput struct { // The namespace of the capability configuration. For example, if you configure // OPC-UA sources from the IoT SiteWise console, your OPC-UA capability - // configuration has the namespace iotsitewise:opcuacollector:version, where - // version is a number such as 1. + // configuration has the namespace iotsitewise:opcuacollector:version , where + // version is a number such as 1 . // // This member is required. CapabilityNamespace *string @@ -55,8 +55,7 @@ type DescribeGatewayCapabilityConfigurationInput struct { type DescribeGatewayCapabilityConfigurationOutput struct { // The JSON document that defines the gateway capability's configuration. For more - // information, see Configuring data sources (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) + // information, see Configuring data sources (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) // in the IoT SiteWise User Guide. // // This member is required. @@ -69,15 +68,9 @@ type DescribeGatewayCapabilityConfigurationOutput struct { // The synchronization status of the capability configuration. The sync status can // be one of the following: - // - // * IN_SYNC – The gateway is running the capability - // configuration. - // - // * OUT_OF_SYNC – The gateway hasn't received the capability - // configuration. - // - // * SYNC_FAILED – The gateway rejected the capability - // configuration. + // - IN_SYNC – The gateway is running the capability configuration. + // - OUT_OF_SYNC – The gateway hasn't received the capability configuration. + // - SYNC_FAILED – The gateway rejected the capability configuration. // // This member is required. CapabilitySyncStatus types.CapabilitySyncStatus diff --git a/service/iotsitewise/api_op_DescribePortal.go b/service/iotsitewise/api_op_DescribePortal.go index 78608eb5ec9..de514182203 100644 --- a/service/iotsitewise/api_op_DescribePortal.go +++ b/service/iotsitewise/api_op_DescribePortal.go @@ -45,17 +45,16 @@ type DescribePortalInput struct { type DescribePortalOutput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the portal, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the portal, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} // // This member is required. PortalArn *string // The IAM Identity Center application generated client ID (used with IAM Identity - // Center APIs). IoT SiteWise includes portalClientId for only portals that use IAM - // Identity Center to authenticate users. + // Center APIs). IoT SiteWise includes portalClientId for only portals that use + // IAM Identity Center to authenticate users. // // This member is required. PortalClientId *string @@ -114,12 +113,10 @@ type DescribePortalOutput struct { // The portal's logo image, which is available at a URL. PortalLogoImageLocation *types.ImageLocation - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the service role that allows the portal's users to access your IoT SiteWise + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the service role that allows the portal's users to access your IoT SiteWise // resources on your behalf. For more information, see Using service roles for IoT - // SiteWise Monitor - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) + // SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. RoleArn *string @@ -243,9 +240,9 @@ type PortalActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, PortalActiveWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, PortalActiveWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -402,9 +399,9 @@ type PortalNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, PortalNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, PortalNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -444,9 +441,9 @@ func NewPortalNotExistsWaiter(client DescribePortalAPIClient, optFns ...func(*Po } } -// Wait calls the waiter function for PortalNotExists waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for PortalNotExists waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *PortalNotExistsWaiter) Wait(ctx context.Context, params *DescribePortalInput, maxWaitDur time.Duration, optFns ...func(*PortalNotExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/iotsitewise/api_op_DescribeProject.go b/service/iotsitewise/api_op_DescribeProject.go index 9ba5560704a..db3e5c8ee96 100644 --- a/service/iotsitewise/api_op_DescribeProject.go +++ b/service/iotsitewise/api_op_DescribeProject.go @@ -45,9 +45,8 @@ type DescribeProjectOutput struct { // This member is required. PortalId *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the project, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the project, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} // // This member is required. diff --git a/service/iotsitewise/api_op_DescribeStorageConfiguration.go b/service/iotsitewise/api_op_DescribeStorageConfiguration.go index 80933eb5750..add427b0137 100644 --- a/service/iotsitewise/api_op_DescribeStorageConfiguration.go +++ b/service/iotsitewise/api_op_DescribeStorageConfiguration.go @@ -40,34 +40,26 @@ type DescribeStorageConfigurationOutput struct { // This member is required. ConfigurationStatus *types.ConfigurationStatus - // The storage tier that you specified for your data. The storageType parameter can - // be one of the following values: - // - // * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves - // your data into the hot tier. The hot tier is a service-managed database. - // - // * - // MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the - // hot tier. The cold tier is a customer-managed Amazon S3 bucket. + // The storage tier that you specified for your data. The storageType parameter + // can be one of the following values: + // - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. + // The hot tier is a service-managed database. + // - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and + // the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // This member is required. StorageType types.StorageType // Contains the storage configuration for time series (data streams) that aren't - // associated with asset properties. The disassociatedDataStorage can be one of the - // following values: - // - // * ENABLED – IoT SiteWise accepts time series that aren't - // associated with asset properties. After the disassociatedDataStorage is enabled, - // you can't disable it. - // - // * DISABLED – IoT SiteWise doesn't accept time series - // (data streams) that aren't associated with asset properties. - // - // For more - // information, see Data streams - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in - // the IoT SiteWise User Guide. + // associated with asset properties. The disassociatedDataStorage can be one of + // the following values: + // - ENABLED – IoT SiteWise accepts time series that aren't associated with asset + // properties. After the disassociatedDataStorage is enabled, you can't disable + // it. + // - DISABLED – IoT SiteWise doesn't accept time series (data streams) that + // aren't associated with asset properties. + // For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) + // in the IoT SiteWise User Guide. DisassociatedDataStorage types.DisassociatedDataStorageState // The date the storage configuration was last updated, in Unix epoch time. diff --git a/service/iotsitewise/api_op_DescribeTimeSeries.go b/service/iotsitewise/api_op_DescribeTimeSeries.go index 408a3ca8cf3..2f0315c59d0 100644 --- a/service/iotsitewise/api_op_DescribeTimeSeries.go +++ b/service/iotsitewise/api_op_DescribeTimeSeries.go @@ -15,18 +15,12 @@ import ( // Retrieves information about a time series (data stream). To identify a time // series, do one of the following: -// -// * If the time series isn't associated with an -// asset property, specify the alias of the time series. -// -// * If the time series is -// associated with an asset property, specify one of the following: -// -// * The alias of -// the time series. -// -// * The assetId and propertyId that identifies the asset -// property. +// - If the time series isn't associated with an asset property, specify the +// alias of the time series. +// - If the time series is associated with an asset property, specify one of the +// following: +// - The alias of the time series. +// - The assetId and propertyId that identifies the asset property. func (c *Client) DescribeTimeSeries(ctx context.Context, params *DescribeTimeSeriesInput, optFns ...func(*Options)) (*DescribeTimeSeriesOutput, error) { if params == nil { params = &DescribeTimeSeriesInput{} @@ -58,15 +52,14 @@ type DescribeTimeSeriesInput struct { type DescribeTimeSeriesOutput struct { - // The data type of the time series. If you specify STRUCT, you must also specify + // The data type of the time series. If you specify STRUCT , you must also specify // dataTypeSpec to identify the type of the structure for this time series. // // This member is required. DataType types.PropertyDataType - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the time series, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the time series, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} // // This member is required. @@ -96,8 +89,8 @@ type DescribeTimeSeriesOutput struct { // The data type of the structure for this time series. This parameter is required // for time series that have the STRUCT data type. The options for this parameter // depend on the type of the composite model in which you created the asset - // property that is associated with your time series. Use AWS/ALARM_STATE for alarm - // state in alarm composite models. + // property that is associated with your time series. Use AWS/ALARM_STATE for + // alarm state in alarm composite models. DataTypeSpec *string // The ID of the asset property. diff --git a/service/iotsitewise/api_op_DisassociateAssets.go b/service/iotsitewise/api_op_DisassociateAssets.go index b740604e7f5..eec634211dc 100644 --- a/service/iotsitewise/api_op_DisassociateAssets.go +++ b/service/iotsitewise/api_op_DisassociateAssets.go @@ -43,8 +43,7 @@ type DisassociateAssetsInput struct { // The ID of a hierarchy in the parent asset's model. Hierarchies allow different // groupings of assets to be formed that all come from the same asset model. You // can use the hierarchy ID to identify the correct asset to disassociate. For more - // information, see Asset hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. // // This member is required. diff --git a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go index 91b6beb073d..349ff5d3124 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go +++ b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go @@ -13,19 +13,15 @@ import ( "time" ) -// Gets aggregated values for an asset property. For more information, see Querying -// aggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) +// Gets aggregated values for an asset property. For more information, see +// Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) // in the IoT SiteWise User Guide. To identify an asset property, you must specify // one of the following: -// -// * The assetId and propertyId of an asset property. -// -// * A -// propertyAlias, which is a data stream alias (for example, -// /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, -// see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . func (c *Client) GetAssetPropertyAggregates(ctx context.Context, params *GetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error) { if params == nil { params = &GetAssetPropertyAggregatesInput{} @@ -48,8 +44,8 @@ type GetAssetPropertyAggregatesInput struct { // This member is required. AggregateTypes []types.AggregateType - // The inclusive end of the range from which to query historical data, expressed in - // seconds in Unix epoch time. + // The inclusive end of the range from which to query historical data, expressed + // in seconds in Unix epoch time. // // This member is required. EndDate *time.Time @@ -75,9 +71,8 @@ type GetAssetPropertyAggregatesInput struct { NextToken *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string diff --git a/service/iotsitewise/api_op_GetAssetPropertyValue.go b/service/iotsitewise/api_op_GetAssetPropertyValue.go index 63ca56c3727..ece5b4115f9 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyValue.go +++ b/service/iotsitewise/api_op_GetAssetPropertyValue.go @@ -13,18 +13,14 @@ import ( ) // Gets an asset property's current value. For more information, see Querying -// current values -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) +// current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) // in the IoT SiteWise User Guide. To identify an asset property, you must specify // one of the following: -// -// * The assetId and propertyId of an asset property. -// -// * A -// propertyAlias, which is a data stream alias (for example, -// /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, -// see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . func (c *Client) GetAssetPropertyValue(ctx context.Context, params *GetAssetPropertyValueInput, optFns ...func(*Options)) (*GetAssetPropertyValueOutput, error) { if params == nil { params = &GetAssetPropertyValueInput{} @@ -46,9 +42,8 @@ type GetAssetPropertyValueInput struct { AssetId *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string diff --git a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go index f3110cd8280..4f0b75aa48a 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go +++ b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go @@ -14,18 +14,14 @@ import ( ) // Gets the history of an asset property's values. For more information, see -// Querying historical values -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) +// Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) // in the IoT SiteWise User Guide. To identify an asset property, you must specify // one of the following: -// -// * The assetId and propertyId of an asset property. -// -// * A -// propertyAlias, which is a data stream alias (for example, -// /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, -// see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . func (c *Client) GetAssetPropertyValueHistory(ctx context.Context, params *GetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error) { if params == nil { params = &GetAssetPropertyValueHistoryInput{} @@ -46,8 +42,8 @@ type GetAssetPropertyValueHistoryInput struct { // The ID of the asset. AssetId *string - // The inclusive end of the range from which to query historical data, expressed in - // seconds in Unix epoch time. + // The inclusive end of the range from which to query historical data, expressed + // in seconds in Unix epoch time. EndDate *time.Time // The maximum number of results to return for each paginated request. Default: 100 @@ -57,9 +53,8 @@ type GetAssetPropertyValueHistoryInput struct { NextToken *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string diff --git a/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go b/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go index 3703307ec26..00b739ecfa4 100644 --- a/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go +++ b/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go @@ -18,14 +18,11 @@ import ( // For example, you can use this operation to return the interpolated temperature // values for a wind turbine every 24 hours over a duration of 7 days. To identify // an asset property, you must specify one of the following: -// -// * The assetId and -// propertyId of an asset property. -// -// * A propertyAlias, which is a data stream -// alias (for example, /company/windfarm/3/turbine/7/temperature). To define an -// asset property's alias, see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . func (c *Client) GetInterpolatedAssetPropertyValues(ctx context.Context, params *GetInterpolatedAssetPropertyValuesInput, optFns ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error) { if params == nil { params = &GetInterpolatedAssetPropertyValuesInput{} @@ -67,27 +64,23 @@ type GetInterpolatedAssetPropertyValuesInput struct { // This member is required. StartTimeInSeconds *int64 - // The interpolation type. Valid values: LINEAR_INTERPOLATION | - // LOCF_INTERPOLATION - // - // * LINEAR_INTERPOLATION – Estimates missing data using linear - // interpolation (https://en.wikipedia.org/wiki/Linear_interpolation). For example, - // you can use this operation to return the interpolated temperature values for a - // wind turbine every 24 hours over a duration of 7 days. If the interpolation - // starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value - // on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 - // AM, and so on. - // - // * LOCF_INTERPOLATION – Estimates missing data using last - // observation carried forward interpolation If no data point is found for an - // interval, IoT SiteWise returns the last observed data point for the previous - // interval and carries forward this interpolated value until a new data point is - // found. For example, you can get the state of an on-off valve every 24 hours over - // a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT - // SiteWise returns the last observed data point between July 1, 2021, at 9 AM and - // July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't - // found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value - // for the rest of the days. + // The interpolation type. Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION + // - LINEAR_INTERPOLATION – Estimates missing data using linear interpolation (https://en.wikipedia.org/wiki/Linear_interpolation) + // . For example, you can use this operation to return the interpolated temperature + // values for a wind turbine every 24 hours over a duration of 7 days. If the + // interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first + // interpolated value on July 2, 2021, at 9 AM, the second interpolated value on + // July 3, 2021, at 9 AM, and so on. + // - LOCF_INTERPOLATION – Estimates missing data using last observation carried + // forward interpolation If no data point is found for an interval, IoT SiteWise + // returns the last observed data point for the previous interval and carries + // forward this interpolated value until a new data point is found. For example, + // you can get the state of an on-off valve every 24 hours over a duration of 7 + // days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns + // the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at + // 9 AM as the first interpolated value. If a data point isn't found after 9 AM on + // July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the + // days. // // This member is required. Type *string @@ -95,7 +88,7 @@ type GetInterpolatedAssetPropertyValuesInput struct { // The ID of the asset. AssetId *string - // The nanosecond offset converted from endTimeInSeconds. + // The nanosecond offset converted from endTimeInSeconds . EndTimeOffsetInNanos *int32 // The query interval for the window, in seconds. IoT SiteWise computes each @@ -103,22 +96,17 @@ type GetInterpolatedAssetPropertyValuesInput struct { // minus the window to the timestamp of each interval plus the window. If not // specified, the window ranges between the start time minus the interval and the // end time plus the interval. - // - // * If you specify a value for the - // intervalWindowInSeconds parameter, the value for the type parameter must be - // LINEAR_INTERPOLATION. - // - // * If a data point isn't found during the specified query - // window, IoT SiteWise won't return an interpolated value for the interval. This - // indicates that there's a gap in the ingested data points. - // - // For example, you can - // get the interpolated temperature values for a wind turbine every 24 hours over a - // duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a - // window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 - // hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first - // interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM - // minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the + // - If you specify a value for the intervalWindowInSeconds parameter, the value + // for the type parameter must be LINEAR_INTERPOLATION . + // - If a data point isn't found during the specified query window, IoT SiteWise + // won't return an interpolated value for the interval. This indicates that there's + // a gap in the ingested data points. + // For example, you can get the interpolated temperature values for a wind turbine + // every 24 hours over a duration of 7 days. If the interpolation starts on July 1, + // 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 + // AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute + // the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM + // (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the // second interpolated value, and so on. IntervalWindowInSeconds *int64 @@ -130,16 +118,15 @@ type GetInterpolatedAssetPropertyValuesInput struct { NextToken *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string // The ID of the asset property. PropertyId *string - // The nanosecond offset converted from startTimeInSeconds. + // The nanosecond offset converted from startTimeInSeconds . StartTimeOffsetInNanos *int32 noSmithyDocumentSerde diff --git a/service/iotsitewise/api_op_ListAccessPolicies.go b/service/iotsitewise/api_op_ListAccessPolicies.go index 23688666a8c..dc85eaff6e4 100644 --- a/service/iotsitewise/api_op_ListAccessPolicies.go +++ b/service/iotsitewise/api_op_ListAccessPolicies.go @@ -32,18 +32,17 @@ func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPolic type ListAccessPoliciesInput struct { - // The ARN of the IAM user. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. This parameter is required if you specify IAM for - // identityType. + // The ARN of the IAM user. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. This parameter is required if you specify IAM for + // identityType . IamArn *string // The ID of the identity. This parameter is required if you specify USER or GROUP - // for identityType. + // for identityType . IdentityId *string // The type of identity (IAM Identity Center user, IAM Identity Center group, or - // IAM user). This parameter is required if you specify identityId. + // IAM user). This parameter is required if you specify identityId . IdentityType types.IdentityType // The maximum number of results to return for each paginated request. Default: 50 @@ -52,11 +51,11 @@ type ListAccessPoliciesInput struct { // The token to be used for the next set of paginated results. NextToken *string - // The ID of the resource. This parameter is required if you specify resourceType. + // The ID of the resource. This parameter is required if you specify resourceType . ResourceId *string // The type of resource (portal or project). This parameter is required if you - // specify resourceId. + // specify resourceId . ResourceType types.ResourceType noSmithyDocumentSerde diff --git a/service/iotsitewise/api_op_ListAssetModelProperties.go b/service/iotsitewise/api_op_ListAssetModelProperties.go index c5ecc9229b6..4f54ab9abc0 100644 --- a/service/iotsitewise/api_op_ListAssetModelProperties.go +++ b/service/iotsitewise/api_op_ListAssetModelProperties.go @@ -39,13 +39,10 @@ type ListAssetModelPropertiesInput struct { // Filters the requested list of asset model properties. You can choose one of the // following options: - // - // * ALL – The list includes all asset model properties for a - // given asset model ID. - // - // * BASE – The list includes only base asset model - // properties for a given asset model ID. - // + // - ALL – The list includes all asset model properties for a given asset model + // ID. + // - BASE – The list includes only base asset model properties for a given asset + // model ID. // Default: BASE Filter types.ListAssetModelPropertiesFilter diff --git a/service/iotsitewise/api_op_ListAssetProperties.go b/service/iotsitewise/api_op_ListAssetProperties.go index fcedcf6ae17..ed88641db46 100644 --- a/service/iotsitewise/api_op_ListAssetProperties.go +++ b/service/iotsitewise/api_op_ListAssetProperties.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of properties associated with an asset. If you update -// properties associated with the model before you finish listing all the +// Retrieves a paginated list of properties associated with an asset. If you +// update properties associated with the model before you finish listing all the // properties, you need to start all over again. func (c *Client) ListAssetProperties(ctx context.Context, params *ListAssetPropertiesInput, optFns ...func(*Options)) (*ListAssetPropertiesOutput, error) { if params == nil { @@ -39,13 +39,9 @@ type ListAssetPropertiesInput struct { // Filters the requested list of asset properties. You can choose one of the // following options: - // - // * ALL – The list includes all asset properties for a given - // asset model ID. - // - // * BASE – The list includes only base asset properties for a - // given asset model ID. - // + // - ALL – The list includes all asset properties for a given asset model ID. + // - BASE – The list includes only base asset properties for a given asset model + // ID. // Default: BASE Filter types.ListAssetPropertiesFilter @@ -169,8 +165,8 @@ func addEndpointPrefix_opListAssetPropertiesMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opListAssetPropertiesMiddleware{}, `OperationSerializer`, middleware.After) } -// ListAssetPropertiesAPIClient is a client that implements the ListAssetProperties -// operation. +// ListAssetPropertiesAPIClient is a client that implements the +// ListAssetProperties operation. type ListAssetPropertiesAPIClient interface { ListAssetProperties(context.Context, *ListAssetPropertiesInput, ...func(*Options)) (*ListAssetPropertiesOutput, error) } diff --git a/service/iotsitewise/api_op_ListAssetRelationships.go b/service/iotsitewise/api_op_ListAssetRelationships.go index 26e6a0bb0b4..f3da971eace 100644 --- a/service/iotsitewise/api_op_ListAssetRelationships.go +++ b/service/iotsitewise/api_op_ListAssetRelationships.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of asset relationships for an asset. You can use this -// operation to identify an asset's root asset and all associated assets between -// that asset and its root. +// Retrieves a paginated list of asset relationships for an asset. You can use +// this operation to identify an asset's root asset and all associated assets +// between that asset and its root. func (c *Client) ListAssetRelationships(ctx context.Context, params *ListAssetRelationshipsInput, optFns ...func(*Options)) (*ListAssetRelationshipsOutput, error) { if params == nil { params = &ListAssetRelationshipsInput{} @@ -39,10 +39,9 @@ type ListAssetRelationshipsInput struct { // The type of traversal to use to identify asset relationships. Choose the // following option: - // - // * PATH_TO_ROOT – Identify the asset's parent assets up to the - // root asset. The asset that you specify in assetId is the first result in the - // list of assetRelationshipSummaries, and the root asset is the last result. + // - PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The + // asset that you specify in assetId is the first result in the list of + // assetRelationshipSummaries , and the root asset is the last result. // // This member is required. TraversalType types.TraversalType diff --git a/service/iotsitewise/api_op_ListAssets.go b/service/iotsitewise/api_op_ListAssets.go index 2c7aa429543..89af1ed4c70 100644 --- a/service/iotsitewise/api_op_ListAssets.go +++ b/service/iotsitewise/api_op_ListAssets.go @@ -14,15 +14,11 @@ import ( // Retrieves a paginated list of asset summaries. You can use this operation to do // the following: +// - List assets based on a specific asset model. +// - List top-level assets. // -// * List assets based on a specific asset model. -// -// * List top-level -// assets. -// -// You can't use this operation to list all assets. To retrieve summaries -// for all of your assets, use ListAssetModels -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) +// You can't use this operation to list all assets. To retrieve summaries for all +// of your assets, use ListAssetModels (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) // to get all of your asset model IDs. Then, use ListAssets to get all assets for // each asset model. func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error) { @@ -43,18 +39,15 @@ func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns type ListAssetsInput struct { // The ID of the asset model by which to filter the list of assets. This parameter - // is required if you choose ALL for filter. + // is required if you choose ALL for filter . AssetModelId *string // The filter for the requested list of assets. Choose one of the following // options: - // - // * ALL – The list includes all assets for a given asset model ID. The - // assetModelId parameter is required if you filter by ALL. - // - // * TOP_LEVEL – The list - // includes only top-level assets in the asset hierarchy tree. - // + // - ALL – The list includes all assets for a given asset model ID. The + // assetModelId parameter is required if you filter by ALL . + // - TOP_LEVEL – The list includes only top-level assets in the asset hierarchy + // tree. // Default: ALL Filter types.ListAssetsFilter diff --git a/service/iotsitewise/api_op_ListAssociatedAssets.go b/service/iotsitewise/api_op_ListAssociatedAssets.go index f34fe2e209c..320e87ff52f 100644 --- a/service/iotsitewise/api_op_ListAssociatedAssets.go +++ b/service/iotsitewise/api_op_ListAssociatedAssets.go @@ -14,11 +14,9 @@ import ( // Retrieves a paginated list of associated assets. You can use this operation to // do the following: -// -// * List child assets associated to a parent asset by a -// hierarchy that you specify. -// -// * List an asset's parent asset. +// - List child assets associated to a parent asset by a hierarchy that you +// specify. +// - List an asset's parent asset. func (c *Client) ListAssociatedAssets(ctx context.Context, params *ListAssociatedAssetsInput, optFns ...func(*Options)) (*ListAssociatedAssetsOutput, error) { if params == nil { params = &ListAssociatedAssetsInput{} @@ -42,13 +40,10 @@ type ListAssociatedAssetsInput struct { AssetId *string // The ID of the hierarchy by which child assets are associated to the asset. To - // find a hierarchy ID, use the DescribeAsset - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html) - // or DescribeAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html) + // find a hierarchy ID, use the DescribeAsset (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html) + // or DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html) // operations. This parameter is required if you choose CHILD for - // traversalDirection. For more information, see Asset hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // traversalDirection . For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. HierarchyId *string @@ -59,14 +54,9 @@ type ListAssociatedAssetsInput struct { NextToken *string // The direction to list associated assets. Choose one of the following options: - // - // * - // CHILD – The list includes all child assets associated to the asset. The - // hierarchyId parameter is required if you choose CHILD. - // - // * PARENT – The list - // includes the asset's parent asset. - // + // - CHILD – The list includes all child assets associated to the asset. The + // hierarchyId parameter is required if you choose CHILD . + // - PARENT – The list includes the asset's parent asset. // Default: CHILD TraversalDirection types.TraversalDirection diff --git a/service/iotsitewise/api_op_ListBulkImportJobs.go b/service/iotsitewise/api_op_ListBulkImportJobs.go index 8fe80fb376a..2ebbecca126 100644 --- a/service/iotsitewise/api_op_ListBulkImportJobs.go +++ b/service/iotsitewise/api_op_ListBulkImportJobs.go @@ -13,8 +13,7 @@ import ( ) // Retrieves a paginated list of bulk import job requests. For more information, -// see List bulk import jobs (CLI) -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html) +// see List bulk import jobs (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html) // in the IoT SiteWise User Guide. func (c *Client) ListBulkImportJobs(ctx context.Context, params *ListBulkImportJobsInput, optFns ...func(*Options)) (*ListBulkImportJobsOutput, error) { if params == nil { diff --git a/service/iotsitewise/api_op_ListTagsForResource.go b/service/iotsitewise/api_op_ListTagsForResource.go index 73b0350cb28..c3bb7cdc598 100644 --- a/service/iotsitewise/api_op_ListTagsForResource.go +++ b/service/iotsitewise/api_op_ListTagsForResource.go @@ -29,9 +29,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource. // // This member is required. ResourceArn *string @@ -42,8 +41,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // The list of key-value pairs that contain metadata for the resource. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]string diff --git a/service/iotsitewise/api_op_ListTimeSeries.go b/service/iotsitewise/api_op_ListTimeSeries.go index 7364648d74f..5cc7e5ba95d 100644 --- a/service/iotsitewise/api_op_ListTimeSeries.go +++ b/service/iotsitewise/api_op_ListTimeSeries.go @@ -44,11 +44,8 @@ type ListTimeSeriesInput struct { // The type of the time series. The time series type can be one of the following // values: - // - // * ASSOCIATED – The time series is associated with an asset property. - // - // * - // DISASSOCIATED – The time series isn't associated with any asset property. + // - ASSOCIATED – The time series is associated with an asset property. + // - DISASSOCIATED – The time series isn't associated with any asset property. TimeSeriesType types.ListTimeSeriesType noSmithyDocumentSerde diff --git a/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go b/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go index 274ab71c67b..ce6e62139a9 100644 --- a/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go +++ b/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go @@ -13,8 +13,7 @@ import ( ) // Sets the default encryption configuration for the Amazon Web Services account. -// For more information, see Key management -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) +// For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) // in the IoT SiteWise User Guide. func (c *Client) PutDefaultEncryptionConfiguration(ctx context.Context, params *PutDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*PutDefaultEncryptionConfigurationOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type PutDefaultEncryptionConfigurationInput struct { // This member is required. EncryptionType types.EncryptionType - // The Key ID of the customer managed key used for KMS encryption. This is required - // if you use KMS_BASED_ENCRYPTION. + // The Key ID of the customer managed key used for KMS encryption. This is + // required if you use KMS_BASED_ENCRYPTION . KmsKeyId *string noSmithyDocumentSerde @@ -47,8 +46,8 @@ type PutDefaultEncryptionConfigurationInput struct { type PutDefaultEncryptionConfigurationOutput struct { - // The status of the account configuration. This contains the ConfigurationState. - // If there is an error, it also contains the ErrorDetails. + // The status of the account configuration. This contains the ConfigurationState . + // If there is an error, it also contains the ErrorDetails . // // This member is required. ConfigurationStatus *types.ConfigurationStatus @@ -59,7 +58,7 @@ type PutDefaultEncryptionConfigurationOutput struct { EncryptionType types.EncryptionType // The Key ARN of the KMS key used for KMS encryption if you use - // KMS_BASED_ENCRYPTION. + // KMS_BASED_ENCRYPTION . KmsKeyArn *string // Metadata pertaining to the operation's result. diff --git a/service/iotsitewise/api_op_PutStorageConfiguration.go b/service/iotsitewise/api_op_PutStorageConfiguration.go index 0370486514a..9ca39c4b059 100644 --- a/service/iotsitewise/api_op_PutStorageConfiguration.go +++ b/service/iotsitewise/api_op_PutStorageConfiguration.go @@ -30,34 +30,26 @@ func (c *Client) PutStorageConfiguration(ctx context.Context, params *PutStorage type PutStorageConfigurationInput struct { - // The storage tier that you specified for your data. The storageType parameter can - // be one of the following values: - // - // * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves - // your data into the hot tier. The hot tier is a service-managed database. - // - // * - // MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the - // hot tier. The cold tier is a customer-managed Amazon S3 bucket. + // The storage tier that you specified for your data. The storageType parameter + // can be one of the following values: + // - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. + // The hot tier is a service-managed database. + // - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and + // the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // This member is required. StorageType types.StorageType // Contains the storage configuration for time series (data streams) that aren't - // associated with asset properties. The disassociatedDataStorage can be one of the - // following values: - // - // * ENABLED – IoT SiteWise accepts time series that aren't - // associated with asset properties. After the disassociatedDataStorage is enabled, - // you can't disable it. - // - // * DISABLED – IoT SiteWise doesn't accept time series - // (data streams) that aren't associated with asset properties. - // - // For more - // information, see Data streams - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in - // the IoT SiteWise User Guide. + // associated with asset properties. The disassociatedDataStorage can be one of + // the following values: + // - ENABLED – IoT SiteWise accepts time series that aren't associated with asset + // properties. After the disassociatedDataStorage is enabled, you can't disable + // it. + // - DISABLED – IoT SiteWise doesn't accept time series (data streams) that + // aren't associated with asset properties. + // For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) + // in the IoT SiteWise User Guide. DisassociatedDataStorage types.DisassociatedDataStorageState // Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the @@ -78,34 +70,26 @@ type PutStorageConfigurationOutput struct { // This member is required. ConfigurationStatus *types.ConfigurationStatus - // The storage tier that you specified for your data. The storageType parameter can - // be one of the following values: - // - // * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves - // your data into the hot tier. The hot tier is a service-managed database. - // - // * - // MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the - // hot tier. The cold tier is a customer-managed Amazon S3 bucket. + // The storage tier that you specified for your data. The storageType parameter + // can be one of the following values: + // - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. + // The hot tier is a service-managed database. + // - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and + // the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // This member is required. StorageType types.StorageType // Contains the storage configuration for time series (data streams) that aren't - // associated with asset properties. The disassociatedDataStorage can be one of the - // following values: - // - // * ENABLED – IoT SiteWise accepts time series that aren't - // associated with asset properties. After the disassociatedDataStorage is enabled, - // you can't disable it. - // - // * DISABLED – IoT SiteWise doesn't accept time series - // (data streams) that aren't associated with asset properties. - // - // For more - // information, see Data streams - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) in - // the IoT SiteWise User Guide. + // associated with asset properties. The disassociatedDataStorage can be one of + // the following values: + // - ENABLED – IoT SiteWise accepts time series that aren't associated with asset + // properties. After the disassociatedDataStorage is enabled, you can't disable + // it. + // - DISABLED – IoT SiteWise doesn't accept time series (data streams) that + // aren't associated with asset properties. + // For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) + // in the IoT SiteWise User Guide. DisassociatedDataStorage types.DisassociatedDataStorageState // Contains information about the storage destination. diff --git a/service/iotsitewise/api_op_TagResource.go b/service/iotsitewise/api_op_TagResource.go index 4b2b3c484cb..4b82b1aacbd 100644 --- a/service/iotsitewise/api_op_TagResource.go +++ b/service/iotsitewise/api_op_TagResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, -// this operation updates the tag's value. +// Adds tags to an IoT SiteWise resource. If a tag already exists for the +// resource, this operation updates the tag's value. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -30,16 +30,14 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource to tag. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource to tag. // // This member is required. ResourceArn *string // A list of key-value pairs that contain metadata for the resource. For more - // information, see Tagging your IoT SiteWise resources - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) + // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. // // This member is required. diff --git a/service/iotsitewise/api_op_UntagResource.go b/service/iotsitewise/api_op_UntagResource.go index 8cb27725e46..7557b19d940 100644 --- a/service/iotsitewise/api_op_UntagResource.go +++ b/service/iotsitewise/api_op_UntagResource.go @@ -29,9 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource to untag. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource to untag. // // This member is required. ResourceArn *string diff --git a/service/iotsitewise/api_op_UpdateAccessPolicy.go b/service/iotsitewise/api_op_UpdateAccessPolicy.go index 589ce1a44c2..2204928c9e9 100644 --- a/service/iotsitewise/api_op_UpdateAccessPolicy.go +++ b/service/iotsitewise/api_op_UpdateAccessPolicy.go @@ -48,8 +48,8 @@ type UpdateAccessPolicyInput struct { // This member is required. AccessPolicyPermission types.Permission - // The IoT SiteWise Monitor resource for this access policy. Choose either a portal - // or a project. + // The IoT SiteWise Monitor resource for this access policy. Choose either a + // portal or a project. // // This member is required. AccessPolicyResource *types.Resource diff --git a/service/iotsitewise/api_op_UpdateAsset.go b/service/iotsitewise/api_op_UpdateAsset.go index b22ec9e2ffa..eeb50ac9459 100644 --- a/service/iotsitewise/api_op_UpdateAsset.go +++ b/service/iotsitewise/api_op_UpdateAsset.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an asset's name. For more information, see Updating assets and models -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) +// Updates an asset's name. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) // in the IoT SiteWise User Guide. func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error) { if params == nil { @@ -55,7 +54,7 @@ type UpdateAssetInput struct { type UpdateAssetOutput struct { - // The status of the asset, which contains a state (UPDATING after successfully + // The status of the asset, which contains a state ( UPDATING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_UpdateAssetModel.go b/service/iotsitewise/api_op_UpdateAssetModel.go index a7c8f118c4a..96c1e1c9b35 100644 --- a/service/iotsitewise/api_op_UpdateAssetModel.go +++ b/service/iotsitewise/api_op_UpdateAssetModel.go @@ -14,17 +14,15 @@ import ( // Updates an asset model and all of the assets that were created from the model. // Each asset created from the model inherits the updated asset model's property -// and hierarchy definitions. For more information, see Updating assets and models -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) +// and hierarchy definitions. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) // in the IoT SiteWise User Guide. This operation overwrites the existing model // with the provided model. To avoid deleting your asset model's properties or // hierarchies, you must include their IDs and definitions in the updated asset -// model payload. For more information, see DescribeAssetModel -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html). -// If you remove a property from an asset model, IoT SiteWise deletes all previous -// data for that property. If you remove a hierarchy definition from an asset -// model, IoT SiteWise disassociates every asset associated with that hierarchy. -// You can't change the type or data type of an existing property. +// model payload. For more information, see DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html) +// . If you remove a property from an asset model, IoT SiteWise deletes all +// previous data for that property. If you remove a hierarchy definition from an +// asset model, IoT SiteWise disassociates every asset associated with that +// hierarchy. You can't change the type or data type of an existing property. func (c *Client) UpdateAssetModel(ctx context.Context, params *UpdateAssetModelInput, optFns ...func(*Options)) (*UpdateAssetModelOutput, error) { if params == nil { params = &UpdateAssetModelInput{} @@ -63,21 +61,17 @@ type UpdateAssetModelInput struct { // The updated hierarchy definitions of the asset model. Each hierarchy specifies // an asset model whose assets can be children of any other assets created from - // this asset model. For more information, see Asset hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // this asset model. For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset - // model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. AssetModelHierarchies []types.AssetModelHierarchy // The updated property definitions of the asset model. For more information, see - // Asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) + // Asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) // in the IoT SiteWise User Guide. You can specify up to 200 properties per asset - // model. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. AssetModelProperties []types.AssetModelProperty // A unique case-sensitive identifier that you can provide to ensure the @@ -90,7 +84,7 @@ type UpdateAssetModelInput struct { type UpdateAssetModelOutput struct { - // The status of the asset model, which contains a state (UPDATING after + // The status of the asset model, which contains a state ( UPDATING after // successfully calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/api_op_UpdateAssetProperty.go b/service/iotsitewise/api_op_UpdateAssetProperty.go index a1d83dbf601..5895d3d1a6c 100644 --- a/service/iotsitewise/api_op_UpdateAssetProperty.go +++ b/service/iotsitewise/api_op_UpdateAssetProperty.go @@ -16,8 +16,8 @@ import ( // overwrites the property's existing alias and notification state. To keep your // existing property's alias or notification state, you must include the existing // values in the UpdateAssetProperty request. For more information, see -// DescribeAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html). +// DescribeAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html) +// . func (c *Client) UpdateAssetProperty(ctx context.Context, params *UpdateAssetPropertyInput, optFns ...func(*Options)) (*UpdateAssetPropertyOutput, error) { if params == nil { params = &UpdateAssetPropertyInput{} @@ -51,9 +51,8 @@ type UpdateAssetPropertyInput struct { ClientToken *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. If you omit this parameter, the alias is removed // from the property. PropertyAlias *string @@ -61,14 +60,13 @@ type UpdateAssetPropertyInput struct { // The MQTT notification state (enabled or disabled) for this asset property. When // the notification state is enabled, IoT SiteWise publishes property value updates // to a unique MQTT topic. For more information, see Interacting with other - // services - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) + // services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) // in the IoT SiteWise User Guide. If you omit this parameter, the notification - // state is set to DISABLED. + // state is set to DISABLED . PropertyNotificationState types.PropertyNotificationState - // The unit of measure (such as Newtons or RPM) of the asset property. If you don't - // specify a value for this parameter, the service uses the value of the + // The unit of measure (such as Newtons or RPM) of the asset property. If you + // don't specify a value for this parameter, the service uses the value of the // assetModelProperty in the asset model. PropertyUnit *string diff --git a/service/iotsitewise/api_op_UpdateDashboard.go b/service/iotsitewise/api_op_UpdateDashboard.go index 8ba42ad52d4..9cec3c88732 100644 --- a/service/iotsitewise/api_op_UpdateDashboard.go +++ b/service/iotsitewise/api_op_UpdateDashboard.go @@ -30,8 +30,7 @@ func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInp type UpdateDashboardInput struct { // The new dashboard definition, as specified in a JSON literal. For detailed - // information, see Creating dashboards (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) + // information, see Creating dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) // in the IoT SiteWise User Guide. // // This member is required. diff --git a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go index a10c0d46669..85d094a5798 100644 --- a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go @@ -17,8 +17,8 @@ import ( // capability configuration can contain multiple data source configurations. If you // define OPC-UA sources for a gateway in the IoT SiteWise console, all of your // OPC-UA sources are stored in one capability configuration. To list all -// capability configurations for a gateway, use DescribeGateway -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html). +// capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html) +// . func (c *Client) UpdateGatewayCapabilityConfiguration(ctx context.Context, params *UpdateGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*UpdateGatewayCapabilityConfigurationOutput, error) { if params == nil { params = &UpdateGatewayCapabilityConfigurationInput{} @@ -36,9 +36,8 @@ func (c *Client) UpdateGatewayCapabilityConfiguration(ctx context.Context, param type UpdateGatewayCapabilityConfigurationInput struct { - // The JSON document that defines the configuration for the gateway capability. For - // more information, see Configuring data sources (CLI) - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) + // The JSON document that defines the configuration for the gateway capability. + // For more information, see Configuring data sources (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) // in the IoT SiteWise User Guide. // // This member is required. @@ -47,7 +46,7 @@ type UpdateGatewayCapabilityConfigurationInput struct { // The namespace of the gateway capability configuration to be updated. For // example, if you configure OPC-UA sources from the IoT SiteWise console, your // OPC-UA capability configuration has the namespace - // iotsitewise:opcuacollector:version, where version is a number such as 1. + // iotsitewise:opcuacollector:version , where version is a number such as 1 . // // This member is required. CapabilityNamespace *string @@ -69,19 +68,11 @@ type UpdateGatewayCapabilityConfigurationOutput struct { // The synchronization status of the capability configuration. The sync status can // be one of the following: - // - // * IN_SYNC – The gateway is running the capability - // configuration. - // - // * OUT_OF_SYNC – The gateway hasn't received the capability - // configuration. - // - // * SYNC_FAILED – The gateway rejected the capability - // configuration. - // - // After you update a capability configuration, its sync status is - // OUT_OF_SYNC until the gateway receives and applies or rejects the updated - // configuration. + // - IN_SYNC – The gateway is running the capability configuration. + // - OUT_OF_SYNC – The gateway hasn't received the capability configuration. + // - SYNC_FAILED – The gateway rejected the capability configuration. + // After you update a capability configuration, its sync status is OUT_OF_SYNC + // until the gateway receives and applies or rejects the updated configuration. // // This member is required. CapabilitySyncStatus types.CapabilitySyncStatus diff --git a/service/iotsitewise/api_op_UpdatePortal.go b/service/iotsitewise/api_op_UpdatePortal.go index 1dd92d40121..0311c3efddd 100644 --- a/service/iotsitewise/api_op_UpdatePortal.go +++ b/service/iotsitewise/api_op_UpdatePortal.go @@ -45,12 +45,10 @@ type UpdatePortalInput struct { // This member is required. PortalName *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // a service role that allows the portal's users to access your IoT SiteWise + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of a service role that allows the portal's users to access your IoT SiteWise // resources on your behalf. For more information, see Using service roles for IoT - // SiteWise Monitor - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) + // SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. // // This member is required. @@ -59,8 +57,7 @@ type UpdatePortalInput struct { // Contains the configuration information of an alarm created in an IoT SiteWise // Monitor portal. You can use the alarm to monitor an asset property and get // notified when the asset property value is outside a specified range. For more - // information, see Monitoring with alarms - // (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) + // information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) // in the IoT SiteWise Application Guide. Alarms *types.Alarms @@ -76,12 +73,8 @@ type UpdatePortalInput struct { PortalDescription *string // Contains an image that is one of the following: - // - // * An image file. Choose this - // option to upload a new image. - // - // * The ID of an existing image. Choose this option - // to keep an existing image. + // - An image file. Choose this option to upload a new image. + // - The ID of an existing image. Choose this option to keep an existing image. PortalLogoImage *types.Image noSmithyDocumentSerde @@ -89,7 +82,7 @@ type UpdatePortalInput struct { type UpdatePortalOutput struct { - // The status of the portal, which contains a state (UPDATING after successfully + // The status of the portal, which contains a state ( UPDATING after successfully // calling this operation) and any error message. // // This member is required. diff --git a/service/iotsitewise/doc.go b/service/iotsitewise/doc.go index d75ef14a08a..3b5268fead1 100644 --- a/service/iotsitewise/doc.go +++ b/service/iotsitewise/doc.go @@ -1,15 +1,12 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package iotsitewise provides the API client, operations, and parameter types for -// AWS IoT SiteWise. +// Package iotsitewise provides the API client, operations, and parameter types +// for AWS IoT SiteWise. // // Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web -// Services service that connects Industrial Internet of Things (IIoT) -// (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) +// Services service that connects Industrial Internet of Things (IIoT) (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) // devices to the power of the Amazon Web Services Cloud. For more information, see -// the IoT SiteWise User Guide -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For information -// about IoT SiteWise quotas, see Quotas -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the -// IoT SiteWise User Guide. +// the IoT SiteWise User Guide (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/) +// . For information about IoT SiteWise quotas, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) +// in the IoT SiteWise User Guide. package iotsitewise diff --git a/service/iotsitewise/types/enums.go b/service/iotsitewise/types/enums.go index 2f102d84b19..de9c21a8f9d 100644 --- a/service/iotsitewise/types/enums.go +++ b/service/iotsitewise/types/enums.go @@ -77,8 +77,8 @@ const ( AssetRelationshipTypeHierarchy AssetRelationshipType = "HIERARCHY" ) -// Values returns all known values for AssetRelationshipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AssetRelationshipType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AssetRelationshipType) Values() []AssetRelationshipType { return []AssetRelationshipType{ @@ -395,9 +395,9 @@ const ( ErrorCodeInternalFailure ErrorCode = "INTERNAL_FAILURE" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "VALIDATION_ERROR", @@ -413,8 +413,8 @@ const ( ForwardingConfigStateEnabled ForwardingConfigState = "ENABLED" ) -// Values returns all known values for ForwardingConfigState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ForwardingConfigState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ForwardingConfigState) Values() []ForwardingConfigState { return []ForwardingConfigState{ @@ -432,9 +432,9 @@ const ( IdentityTypeIam IdentityType = "IAM" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "USER", @@ -471,9 +471,9 @@ const ( JobStatusCompletedWithFailures JobStatus = "COMPLETED_WITH_FAILURES" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "PENDING", @@ -553,9 +553,9 @@ const ( ListBulkImportJobsFilterCompleted ListBulkImportJobsFilter = "COMPLETED" ) -// Values returns all known values for ListBulkImportJobsFilter. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListBulkImportJobsFilter. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ListBulkImportJobsFilter) Values() []ListBulkImportJobsFilter { return []ListBulkImportJobsFilter{ "ALL", @@ -595,9 +595,9 @@ const ( LoggingLevelOff LoggingLevel = "OFF" ) -// Values returns all known values for LoggingLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LoggingLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LoggingLevel) Values() []LoggingLevel { return []LoggingLevel{ "ERROR", @@ -738,9 +738,9 @@ const ( ResourceTypeProject ResourceType = "PROJECT" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "PORTAL", @@ -774,9 +774,9 @@ const ( TimeOrderingDescending TimeOrdering = "DESCENDING" ) -// Values returns all known values for TimeOrdering. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TimeOrdering. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TimeOrdering) Values() []TimeOrdering { return []TimeOrdering{ "ASCENDING", diff --git a/service/iotsitewise/types/errors.go b/service/iotsitewise/types/errors.go index 6d2b7b696f2..dfd4b0157bc 100644 --- a/service/iotsitewise/types/errors.go +++ b/service/iotsitewise/types/errors.go @@ -93,9 +93,8 @@ func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault { return smithy // You've reached the limit for a resource. For example, this can occur if you're // trying to associate more than the allowed number of child assets or attempting // to create more than the allowed number of properties for an asset model. For -// more information, see Quotas -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the -// IoT SiteWise User Guide. +// more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) +// in the IoT SiteWise User Guide. type LimitExceededException struct { Message *string @@ -204,9 +203,8 @@ func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault { return sm // Your request exceeded a rate limit. For example, you might have exceeded the // number of IoT SiteWise assets that can be created per second, the allowed number -// of messages per second, and so on. For more information, see Quotas -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the -// IoT SiteWise User Guide. +// of messages per second, and so on. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) +// in the IoT SiteWise User Guide. type ThrottlingException struct { Message *string @@ -232,9 +230,8 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've reached the limit for the number of tags allowed for a resource. For more -// information, see Tag naming limits and requirements -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) +// You've reached the limit for the number of tags allowed for a resource. For +// more information, see Tag naming limits and requirements (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) // in the Amazon Web Services General Reference. type TooManyTagsException struct { Message *string diff --git a/service/iotsitewise/types/types.go b/service/iotsitewise/types/types.go index 56c7df4cebe..8202469b93c 100644 --- a/service/iotsitewise/types/types.go +++ b/service/iotsitewise/types/types.go @@ -22,8 +22,8 @@ type AccessPolicySummary struct { // This member is required. Identity *Identity - // The permissions for the access policy. Note that a project ADMINISTRATOR is also - // known as a project owner. + // The permissions for the access policy. Note that a project ADMINISTRATOR is + // also known as a project owner. // // This member is required. Permission Permission @@ -89,24 +89,20 @@ type Aggregates struct { // Contains the configuration information of an alarm created in an IoT SiteWise // Monitor portal. You can use the alarm to monitor an asset property and get // notified when the asset property value is outside a specified range. For more -// information, see Monitoring with alarms -// (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) +// information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) // in the IoT SiteWise Application Guide. type Alarms struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IAM role that allows the alarm to perform actions and access Amazon Web + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IAM role that allows the alarm to perform actions and access Amazon Web // Services resources and services, such as IoT Events. // // This member is required. AlarmRoleArn *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the Lambda function that manages alarm notifications. For more information, see - // Managing alarm notifications - // (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the Lambda function that manages alarm notifications. For more information, + // see Managing alarm notifications (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) // in the IoT Events Developer Guide. NotificationLambdaArn *string @@ -128,7 +124,7 @@ type AssetCompositeModel struct { Properties []AssetProperty // The type of the composite model. For alarm composite models, this type is - // AWS/ALARM. + // AWS/ALARM . // // This member is required. Type *string @@ -166,16 +162,14 @@ type AssetErrorDetails struct { // Describes an asset hierarchy that contains a hierarchy's name and ID. type AssetHierarchy struct { - // The hierarchy name provided in the CreateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) - // or UpdateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) + // The hierarchy name provided in the CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) + // or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation. // // This member is required. Name *string - // The ID of the hierarchy. This ID is a hierarchyId. + // The ID of the hierarchy. This ID is a hierarchyId . Id *string noSmithyDocumentSerde @@ -204,7 +198,7 @@ type AssetModelCompositeModel struct { Name *string // The type of the composite model. For alarm composite models, this type is - // AWS/ALARM. + // AWS/ALARM . // // This member is required. Type *string @@ -231,7 +225,7 @@ type AssetModelCompositeModelDefinition struct { Name *string // The type of the composite model. For alarm composite models, this type is - // AWS/ALARM. + // AWS/ALARM . // // This member is required. Type *string @@ -249,23 +243,21 @@ type AssetModelCompositeModelDefinition struct { // asset model ID that specifies the type of asset that can be in this hierarchy. type AssetModelHierarchy struct { - // The ID of the asset model. All assets in this hierarchy must be instances of the - // childAssetModelId asset model. + // The ID of the asset model. All assets in this hierarchy must be instances of + // the childAssetModelId asset model. // // This member is required. ChildAssetModelId *string // The name of the asset model hierarchy that you specify by using the - // CreateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) - // or UpdateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) + // CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) + // or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation. // // This member is required. Name *string - // The ID of the asset model hierarchy. This ID is a hierarchyId. + // The ID of the asset model hierarchy. This ID is a hierarchyId . Id *string noSmithyDocumentSerde @@ -281,10 +273,8 @@ type AssetModelHierarchyDefinition struct { ChildAssetModelId *string // The name of the asset model hierarchy definition (as specified in the - // CreateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) - // or UpdateAssetModel - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) + // CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) + // or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation). // // This member is required. @@ -306,7 +296,7 @@ type AssetModelProperty struct { // This member is required. Name *string - // The property type (see PropertyType). + // The property type (see PropertyType ). // // This member is required. Type *PropertyType @@ -318,17 +308,17 @@ type AssetModelProperty struct { // The ID of the asset model property. Id *string - // The unit of the asset model property, such as Newtons or RPM. + // The unit of the asset model property, such as Newtons or RPM . Unit *string noSmithyDocumentSerde } -// Contains an asset model property definition. This property definition is applied -// to all assets created from the asset model. +// Contains an asset model property definition. This property definition is +// applied to all assets created from the asset model. type AssetModelPropertyDefinition struct { - // The data type of the property definition. If you specify STRUCT, you must also + // The data type of the property definition. If you specify STRUCT , you must also // specify dataTypeSpec to identify the type of the structure for this property. // // This member is required. @@ -339,19 +329,19 @@ type AssetModelPropertyDefinition struct { // This member is required. Name *string - // The property definition type (see PropertyType). You can only specify one type + // The property definition type (see PropertyType ). You can only specify one type // in a property definition. // // This member is required. Type *PropertyType // The data type of the structure for this property. This parameter is required on - // properties that have the STRUCT data type. The options for this parameter depend - // on the type of the composite model in which you define this property. Use + // properties that have the STRUCT data type. The options for this parameter + // depend on the type of the composite model in which you define this property. Use // AWS/ALARM_STATE for alarm state in alarm composite models. DataTypeSpec *string - // The unit of the property definition, such as Newtons or RPM. + // The unit of the property definition, such as Newtons or RPM . Unit *string noSmithyDocumentSerde @@ -370,8 +360,8 @@ type AssetModelPropertySummary struct { // This member is required. Name *string - // Contains a property type, which can be one of attribute, measurement, metric, or - // transform. + // Contains a property type, which can be one of attribute , measurement , metric , + // or transform . // // This member is required. Type *PropertyType @@ -386,15 +376,14 @@ type AssetModelPropertySummary struct { // The ID of the property. Id *string - // The unit (such as Newtons or RPM) of the property. + // The unit (such as Newtons or RPM ) of the property. Unit *string noSmithyDocumentSerde } // Contains current status information for an asset model. For more information, -// see Asset and model states -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) +// see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) // in the IoT SiteWise User Guide. type AssetModelStatus struct { @@ -412,9 +401,8 @@ type AssetModelStatus struct { // Contains a summary of an asset model. type AssetModelSummary struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset model, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset model, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} // // This member is required. @@ -472,9 +460,8 @@ type AssetProperty struct { Name *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. Alias *string @@ -483,11 +470,11 @@ type AssetProperty struct { DataTypeSpec *string // The asset property's notification topic and state. For more information, see - // UpdateAssetProperty - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). + // UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) + // . Notification *PropertyNotification - // The unit (such as Newtons or RPM) of the asset property. + // The unit (such as Newtons or RPM ) of the asset property. Unit *string noSmithyDocumentSerde @@ -497,9 +484,8 @@ type AssetProperty struct { type AssetPropertySummary struct { // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. Alias *string @@ -511,8 +497,7 @@ type AssetPropertySummary struct { // Contains asset property value notification information. When the notification // state is enabled, IoT SiteWise publishes property value updates to a unique MQTT - // topic. For more information, see Interacting with other services - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) + // topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) // in the IoT SiteWise User Guide. Notification *PropertyNotification @@ -530,7 +515,7 @@ type AssetPropertyValue struct { // This member is required. Timestamp *TimeInNanos - // The value of the asset property (see Variant). + // The value of the asset property (see Variant ). // // This member is required. Value *Variant @@ -546,24 +531,22 @@ type AssetRelationshipSummary struct { // The relationship type of the assets in this relationship. This value is one of // the following: - // - // * HIERARCHY – The assets are related through an asset hierarchy. - // If you specify this relationship type, this asset relationship includes the - // hierarchyInfo object. + // - HIERARCHY – The assets are related through an asset hierarchy. If you + // specify this relationship type, this asset relationship includes the + // hierarchyInfo object. // // This member is required. RelationshipType AssetRelationshipType // The assets that are related through an asset hierarchy. This object is present - // if the relationshipType is HIERARCHY. + // if the relationshipType is HIERARCHY . HierarchyInfo *AssetHierarchyInfo noSmithyDocumentSerde } -// Contains information about the current status of an asset. For more information, -// see Asset and model states -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) +// Contains information about the current status of an asset. For more +// information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) // in the IoT SiteWise User Guide. type AssetStatus struct { @@ -581,9 +564,8 @@ type AssetStatus struct { // Contains a summary of an asset. type AssetSummary struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. @@ -599,7 +581,7 @@ type AssetSummary struct { // This member is required. CreationDate *time.Time - // A list of asset hierarchies that each contain a hierarchyId. A hierarchy + // A list of asset hierarchies that each contain a hierarchyId . A hierarchy // specifies allowed parent/child asset relationships. // // This member is required. @@ -634,9 +616,8 @@ type AssetSummary struct { // Contains a summary of an associated asset. type AssociatedAssetsSummary struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the asset, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. @@ -652,7 +633,7 @@ type AssociatedAssetsSummary struct { // This member is required. CreationDate *time.Time - // A list of asset hierarchies that each contain a hierarchyId. A hierarchy + // A list of asset hierarchies that each contain a hierarchyId . A hierarchy // specifies allowed parent/child asset relationships. // // This member is required. @@ -684,16 +665,14 @@ type AssociatedAssetsSummary struct { noSmithyDocumentSerde } -// Contains an asset attribute property. For more information, see Attributes -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) +// Contains an asset attribute property. For more information, see Attributes (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) // in the IoT SiteWise User Guide. type Attribute struct { // The default value of the asset model property attribute. All assets that you // create from the asset model contain this attribute value. You can update an // attribute's value after you create an asset. For more information, see Updating - // attribute values - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) + // attribute values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) // in the IoT SiteWise User Guide. DefaultValue *string @@ -701,17 +680,13 @@ type Attribute struct { } // Contains information for an asset property aggregate entry that is associated -// with the BatchGetAssetPropertyAggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) +// with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. To identify an asset property, you must specify one of the following: -// -// * -// The assetId and propertyId of an asset property. -// -// * A propertyAlias, which is a -// data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To -// define an asset property's alias, see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . type BatchGetAssetPropertyAggregatesEntry struct { // The data aggregating function. @@ -719,8 +694,8 @@ type BatchGetAssetPropertyAggregatesEntry struct { // This member is required. AggregateTypes []AggregateType - // The inclusive end of the range from which to query historical data, expressed in - // seconds in Unix epoch time. + // The inclusive end of the range from which to query historical data, expressed + // in seconds in Unix epoch time. // // This member is required. EndDate *time.Time @@ -745,9 +720,8 @@ type BatchGetAssetPropertyAggregatesEntry struct { AssetId *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string @@ -764,8 +738,7 @@ type BatchGetAssetPropertyAggregatesEntry struct { } // Contains error information for an asset property aggregate entry that is -// associated with the BatchGetAssetPropertyAggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) +// associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. type BatchGetAssetPropertyAggregatesErrorEntry struct { @@ -788,8 +761,7 @@ type BatchGetAssetPropertyAggregatesErrorEntry struct { } // Contains the error code and the timestamp for an asset property aggregate entry -// that is associated with the BatchGetAssetPropertyAggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) +// that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. type BatchGetAssetPropertyAggregatesErrorInfo struct { @@ -807,14 +779,12 @@ type BatchGetAssetPropertyAggregatesErrorInfo struct { } // Contains information for an entry that has been processed by the previous -// BatchGetAssetPropertyAggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) +// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // request. type BatchGetAssetPropertyAggregatesSkippedEntry struct { // The completion status of each entry that is associated with the - // BatchGetAssetPropertyAggregates - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) + // BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. // // This member is required. @@ -832,8 +802,7 @@ type BatchGetAssetPropertyAggregatesSkippedEntry struct { } // Contains success information for an entry that is associated with the -// BatchGetAssetPropertyAggregates -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) +// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. type BatchGetAssetPropertyAggregatesSuccessEntry struct { @@ -852,17 +821,13 @@ type BatchGetAssetPropertyAggregatesSuccessEntry struct { } // Contains information for an asset property value entry that is associated with -// the BatchGetAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // API. To identify an asset property, you must specify one of the following: -// -// * -// The assetId and propertyId of an asset property. -// -// * A propertyAlias, which is a -// data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To -// define an asset property's alias, see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . type BatchGetAssetPropertyValueEntry struct { // The ID of the entry. @@ -874,9 +839,8 @@ type BatchGetAssetPropertyValueEntry struct { AssetId *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string @@ -887,8 +851,7 @@ type BatchGetAssetPropertyValueEntry struct { } // Contains error information for an asset property value entry that is associated -// with the BatchGetAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // API. type BatchGetAssetPropertyValueErrorEntry struct { @@ -927,17 +890,13 @@ type BatchGetAssetPropertyValueErrorInfo struct { } // Contains information for an asset property historical value entry that is -// associated with the BatchGetAssetPropertyValueHistory -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // API. To identify an asset property, you must specify one of the following: -// -// * -// The assetId and propertyId of an asset property. -// -// * A propertyAlias, which is a -// data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To -// define an asset property's alias, see UpdateAssetProperty -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). +// - The assetId and propertyId of an asset property. +// - A propertyAlias , which is a data stream alias (for example, +// /company/windfarm/3/turbine/7/temperature ). To define an asset property's +// alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) +// . type BatchGetAssetPropertyValueHistoryEntry struct { // The ID of the entry. @@ -948,14 +907,13 @@ type BatchGetAssetPropertyValueHistoryEntry struct { // The ID of the asset in which the asset property was created. AssetId *string - // The inclusive end of the range from which to query historical data, expressed in - // seconds in Unix epoch time. + // The inclusive end of the range from which to query historical data, expressed + // in seconds in Unix epoch time. EndDate *time.Time // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string @@ -1014,14 +972,12 @@ type BatchGetAssetPropertyValueHistoryErrorInfo struct { } // Contains information for an entry that has been processed by the previous -// BatchGetAssetPropertyValueHistory -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // request. type BatchGetAssetPropertyValueHistorySkippedEntry struct { // The completion status of each entry that is associated with the - // BatchGetAssetPropertyValueHistory - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html) + // BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html) // API. // // This member is required. @@ -1039,8 +995,7 @@ type BatchGetAssetPropertyValueHistorySkippedEntry struct { } // Contains success information for an entry that is associated with the -// BatchGetAssetPropertyValueHistory -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // API. type BatchGetAssetPropertyValueHistorySuccessEntry struct { @@ -1058,14 +1013,12 @@ type BatchGetAssetPropertyValueHistorySuccessEntry struct { } // Contains information for an entry that has been processed by the previous -// BatchGetAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // request. type BatchGetAssetPropertyValueSkippedEntry struct { // The completion status of each entry that is associated with the - // BatchGetAssetPropertyValue - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) + // BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // request. // // This member is required. @@ -1083,8 +1036,7 @@ type BatchGetAssetPropertyValueSkippedEntry struct { } // Contains success information for an entry that is associated with the -// BatchGetAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) +// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // API. type BatchGetAssetPropertyValueSuccessEntry struct { @@ -1121,8 +1073,7 @@ type BatchPutAssetPropertyError struct { } // Contains error information for asset property value entries that are associated -// with the BatchPutAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) +// with the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) // API. type BatchPutAssetPropertyErrorEntry struct { @@ -1205,20 +1156,17 @@ type Csv struct { // Contains information about a customer managed Amazon S3 bucket. type CustomerManagedS3Storage struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the Identity and Access Management role that allows IoT SiteWise to send data to - // Amazon S3. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the Identity and Access Management role that allows IoT SiteWise to send data + // to Amazon S3. // // This member is required. RoleArn *string - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the Amazon S3 object. For more information about how to find the ARN for an - // Amazon S3 object, see Amazon S3 resources - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html) in - // the Amazon Simple Storage Service User Guide. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the Amazon S3 object. For more information about how to find the ARN for an + // Amazon S3 object, see Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html) + // in the Amazon Simple Storage Service User Guide. // // This member is required. S3ResourceArn *string @@ -1290,8 +1238,8 @@ type ErrorDetails struct { // are saved. type ErrorReportLocation struct { - // The name of the Amazon S3 bucket to which errors associated with the bulk import - // job are sent. + // The name of the Amazon S3 bucket to which errors associated with the bulk + // import job are sent. // // This member is required. Bucket *string @@ -1299,9 +1247,8 @@ type ErrorReportLocation struct { // Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each // Amazon S3 object has a key that is its unique identifier in the bucket. Each // object in a bucket has exactly one key. The prefix must end with a forward slash - // (/). For more information, see Organizing objects using prefixes - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) in - // the Amazon Simple Storage Service User Guide. + // (/). For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) + // in the Amazon Simple Storage Service User Guide. // // This member is required. Prefix *string @@ -1371,23 +1318,17 @@ type GatewayCapabilitySummary struct { // The namespace of the capability configuration. For example, if you configure // OPC-UA sources from the IoT SiteWise console, your OPC-UA capability - // configuration has the namespace iotsitewise:opcuacollector:version, where - // version is a number such as 1. + // configuration has the namespace iotsitewise:opcuacollector:version , where + // version is a number such as 1 . // // This member is required. CapabilityNamespace *string // The synchronization status of the capability configuration. The sync status can // be one of the following: - // - // * IN_SYNC – The gateway is running the capability - // configuration. - // - // * OUT_OF_SYNC – The gateway hasn't received the capability - // configuration. - // - // * SYNC_FAILED – The gateway rejected the capability - // configuration. + // - IN_SYNC – The gateway is running the capability configuration. + // - OUT_OF_SYNC – The gateway hasn't received the capability configuration. + // - SYNC_FAILED – The gateway rejected the capability configuration. // // This member is required. CapabilitySyncStatus CapabilitySyncStatus @@ -1430,11 +1371,11 @@ type GatewaySummary struct { // This member is required. LastUpdateDate *time.Time - // A list of gateway capability summaries that each contain a namespace and status. - // Each gateway capability defines data sources for the gateway. To retrieve a - // capability configuration's definition, use - // DescribeGatewayCapabilityConfiguration - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). + // A list of gateway capability summaries that each contain a namespace and + // status. Each gateway capability defines data sources for the gateway. To + // retrieve a capability configuration's definition, use + // DescribeGatewayCapabilityConfiguration (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html) + // . GatewayCapabilitySummaries []GatewayCapabilitySummary // Contains a gateway's platform information. @@ -1446,19 +1387,15 @@ type GatewaySummary struct { // Contains details for a gateway that runs on IoT Greengrass. To create a gateway // that runs on IoT Greengrass, you must add the IoT SiteWise connector to a // Greengrass group and deploy it. Your Greengrass group must also have permissions -// to upload data to IoT SiteWise. For more information, see Ingesting data using a -// gateway -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) +// to upload data to IoT SiteWise. For more information, see Ingesting data using +// a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) // in the IoT SiteWise User Guide. type Greengrass struct { - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the Greengrass group. For more information about how to find a group's ARN, see - // ListGroups - // (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html) - // and GetGroup - // (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html) + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the Greengrass group. For more information about how to find a group's ARN, + // see ListGroups (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html) + // and GetGroup (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html) // in the IoT Greengrass API Reference. // // This member is required. @@ -1469,12 +1406,10 @@ type Greengrass struct { // Contains details for a gateway that runs on IoT Greengrass V2. To create a // gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge -// component to your gateway device. Your Greengrass device role -// (https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) +// component to your gateway device. Your Greengrass device role (https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) // must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using -// IoT SiteWise at the edge -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in -// the IoT SiteWise User Guide. +// IoT SiteWise at the edge (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) +// in the IoT SiteWise User Guide. type GreengrassV2 struct { // The name of the IoT thing for your IoT Greengrass V2 core device. @@ -1497,14 +1432,12 @@ type GroupIdentity struct { } // Contains information about an Identity and Access Management role. For more -// information, see IAM roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the IAM User -// Guide. +// information, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) +// in the IAM User Guide. type IAMRoleIdentity struct { - // The ARN of the IAM role. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // The ARN of the IAM role. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string @@ -1515,11 +1448,10 @@ type IAMRoleIdentity struct { // Contains information about an Identity and Access Management user. type IAMUserIdentity struct { - // The ARN of the IAM user. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. If you delete the IAM user, access policies that contain - // this identity include an empty arn. You can delete the access policy for the IAM - // user that no longer exists. + // The ARN of the IAM user. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. If you delete the IAM user, access policies that contain + // this identity include an empty arn . You can delete the access policy for the + // IAM user that no longer exists. // // This member is required. Arn *string @@ -1530,8 +1462,8 @@ type IAMUserIdentity struct { // Contains an identity that can access an IoT SiteWise Monitor resource. // Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity // Center identity IDs. You can find the IAM Identity Center identity IDs in the -// URL of user and group pages in the IAM Identity Center console -// (https://console.aws.amazon.com/singlesignon). +// URL of user and group pages in the IAM Identity Center console (https://console.aws.amazon.com/singlesignon) +// . type Identity struct { // An IAM Identity Center group identity. @@ -1550,12 +1482,8 @@ type Identity struct { } // Contains an image that is one of the following: -// -// * An image file. Choose this -// option to upload a new image. -// -// * The ID of an existing image. Choose this option -// to keep an existing image. +// - An image file. Choose this option to upload a new image. +// - The ID of an existing image. Choose this option to keep an existing image. type Image struct { // Contains an image file. @@ -1617,8 +1545,8 @@ type InterpolatedAssetPropertyValue struct { noSmithyDocumentSerde } -// Contains the configuration information of a job, such as the file format used to -// save data in Amazon S3. +// Contains the configuration information of a job, such as the file format used +// to save data in Amazon S3. type JobConfiguration struct { // The file format of the data in Amazon S3. @@ -1643,27 +1571,18 @@ type JobSummary struct { Name *string // The status of the bulk import job can be one of following values. - // - // * PENDING – - // IoT SiteWise is waiting for the current bulk import job to finish. - // - // * CANCELLED - // – The bulk import job has been canceled. - // - // * RUNNING – IoT SiteWise is processing - // your request to import your data from Amazon S3. - // - // * COMPLETED – IoT SiteWise - // successfully completed your request to import data from Amazon S3. - // - // * FAILED – - // IoT SiteWise couldn't process your request to import data from Amazon S3. You - // can use logs saved in the specified error report location in Amazon S3 to - // troubleshoot issues. - // - // * COMPLETED_WITH_FAILURES – IoT SiteWise completed your - // request to import data from Amazon S3 with errors. You can use logs saved in the - // specified error report location in Amazon S3 to troubleshoot issues. + // - PENDING – IoT SiteWise is waiting for the current bulk import job to finish. + // - CANCELLED – The bulk import job has been canceled. + // - RUNNING – IoT SiteWise is processing your request to import your data from + // Amazon S3. + // - COMPLETED – IoT SiteWise successfully completed your request to import data + // from Amazon S3. + // - FAILED – IoT SiteWise couldn't process your request to import data from + // Amazon S3. You can use logs saved in the specified error report location in + // Amazon S3 to troubleshoot issues. + // - COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data + // from Amazon S3 with errors. You can use logs saved in the specified error report + // location in Amazon S3 to troubleshoot issues. // // This member is required. Status JobStatus @@ -1682,8 +1601,7 @@ type LoggingOptions struct { noSmithyDocumentSerde } -// Contains an asset measurement property. For more information, see Measurements -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements) +// Contains an asset measurement property. For more information, see Measurements (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements) // in the IoT SiteWise User Guide. type Measurement struct { @@ -1714,17 +1632,15 @@ type MeasurementProcessingConfig struct { // maximum number of dependent/cascading variables used in any one metric // calculation is 10. Therefore, a root metric can have up to 10 cascading metrics // in its computational dependency tree. Additionally, a metric can only have a -// data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE. -// For more information, see Metrics -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) +// data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE +// . For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) // in the IoT SiteWise User Guide. type Metric struct { // The mathematical expression that defines the metric aggregation function. You // can specify up to 10 variables per expression. You can specify up to 10 - // functions per expression. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // functions per expression. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. // // This member is required. Expression *string @@ -1735,7 +1651,7 @@ type Metric struct { Variables []ExpressionVariable // The window (time interval) over which IoT SiteWise computes the metric's - // aggregation expression. IoT SiteWise computes one data point per window. + // aggregation expression. IoT SiteWise computes one data point per window . // // This member is required. Window *MetricWindow @@ -1854,12 +1770,10 @@ type PortalSummary struct { // The date the portal was last updated, in Unix epoch time. LastUpdateDate *time.Time - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the service role that allows the portal's users to access your IoT SiteWise + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the service role that allows the portal's users to access your IoT SiteWise // resources on your behalf. For more information, see Using service roles for IoT - // SiteWise Monitor - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) + // SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. RoleArn *string @@ -1921,21 +1835,20 @@ type Property struct { Name *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. Alias *string // The asset property's notification topic and state. For more information, see - // UpdateAssetProperty - // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). + // UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html) + // . Notification *PropertyNotification - // The property type (see PropertyType). A property contains one type. + // The property type (see PropertyType ). A property contains one type. Type *PropertyType - // The unit (such as Newtons or RPM) of the asset property. + // The unit (such as Newtons or RPM ) of the asset property. Unit *string noSmithyDocumentSerde @@ -1943,8 +1856,7 @@ type Property struct { // Contains asset property value notification information. When the notification // state is enabled, IoT SiteWise publishes property value updates to a unique MQTT -// topic. For more information, see Interacting with other services -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) +// topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) // in the IoT SiteWise User Guide. type PropertyNotification struct { @@ -1962,19 +1874,18 @@ type PropertyNotification struct { noSmithyDocumentSerde } -// Contains a property type, which can be one of attribute, measurement, metric, or -// transform. +// Contains a property type, which can be one of attribute , measurement , metric , +// or transform . type PropertyType struct { // Specifies an asset attribute property. An attribute generally contains static - // information, such as the serial number of an IIoT - // (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind - // turbine. + // information, such as the serial number of an IIoT (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) + // wind turbine. Attribute *Attribute - // Specifies an asset measurement property. A measurement represents a device's raw - // sensor data stream, such as timestamped temperature values or timestamped power - // values. + // Specifies an asset measurement property. A measurement represents a device's + // raw sensor data stream, such as timestamped temperature values or timestamped + // power values. Measurement *Measurement // Specifies an asset metric property. A metric contains a mathematical expression @@ -1992,8 +1903,7 @@ type PropertyType struct { } // Contains a list of value updates for an asset property in the list of asset -// entries consumed by the BatchPutAssetPropertyValue -// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) +// entries consumed by the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) // API operation. type PutAssetPropertyValueEntry struct { @@ -2013,9 +1923,8 @@ type PutAssetPropertyValueEntry struct { AssetId *string // The alias that identifies the property, such as an OPC-UA server data stream - // path (for example, /company/windfarm/3/turbine/7/temperature). For more - // information, see Mapping industrial data streams to asset properties - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) + // path (for example, /company/windfarm/3/turbine/7/temperature ). For more + // information, see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string @@ -2042,10 +1951,10 @@ type Resource struct { type RetentionPeriod struct { // The number of days that your data is kept. If you specified a value for this - // parameter, the unlimited parameter must be false. + // parameter, the unlimited parameter must be false . NumberOfDays *int32 - // If true, your data is kept indefinitely. If configured to true, you must not + // If true, your data is kept indefinitely. If configured to true , you must not // specify a value for the numberOfDays parameter. Unlimited *bool @@ -2056,12 +1965,12 @@ type RetentionPeriod struct { type TimeInNanos struct { // The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond - // data is provided by offsetInNanos. + // data is provided by offsetInNanos . // // This member is required. TimeInSeconds *int64 - // The nanosecond offset from timeInSeconds. + // The nanosecond offset from timeInSeconds . OffsetInNanos *int32 noSmithyDocumentSerde @@ -2070,15 +1979,14 @@ type TimeInNanos struct { // Contains a summary of a time series (data stream). type TimeSeriesSummary struct { - // The data type of the time series. If you specify STRUCT, you must also specify + // The data type of the time series. If you specify STRUCT , you must also specify // dataTypeSpec to identify the type of the structure for this time series. // // This member is required. DataType PropertyDataType - // The ARN - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the time series, which has the following format. + // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the time series, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} // // This member is required. @@ -2108,8 +2016,8 @@ type TimeSeriesSummary struct { // The data type of the structure for this time series. This parameter is required // for time series that have the STRUCT data type. The options for this parameter // depend on the type of the composite model in which you created the asset - // property that is associated with your time series. Use AWS/ALARM_STATE for alarm - // state in alarm composite models. + // property that is associated with your time series. Use AWS/ALARM_STATE for + // alarm state in alarm composite models. DataTypeSpec *string // The ID of the asset property. @@ -2123,16 +2031,14 @@ type TimeSeriesSummary struct { // transform to convert a Celsius data stream to Fahrenheit by applying the // transformation expression to each data point of the Celsius stream. A transform // can only have a data type of DOUBLE and consume properties with data types of -// INTEGER or DOUBLE. For more information, see Transforms -// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) +// INTEGER or DOUBLE . For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) // in the IoT SiteWise User Guide. type Transform struct { // The mathematical expression that defines the transformation function. You can // specify up to 10 variables per expression. You can specify up to 10 functions - // per expression. For more information, see Quotas - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the - // IoT SiteWise User Guide. + // per expression. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) + // in the IoT SiteWise User Guide. // // This member is required. Expression *string @@ -2142,17 +2048,19 @@ type Transform struct { // This member is required. Variables []ExpressionVariable - // The processing configuration for the given transform property. You can configure - // transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. - // You can also configure transforms to be computed at the edge or in the cloud. + // The processing configuration for the given transform property. You can + // configure transforms to be kept at the edge or forwarded to the Amazon Web + // Services Cloud. You can also configure transforms to be computed at the edge or + // in the cloud. ProcessingConfig *TransformProcessingConfig noSmithyDocumentSerde } -// The processing configuration for the given transform property. You can configure -// transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. -// You can also configure transforms to be computed at the edge or in the cloud. +// The processing configuration for the given transform property. You can +// configure transforms to be kept at the edge or forwarded to the Amazon Web +// Services Cloud. You can also configure transforms to be computed at the edge or +// in the cloud. type TransformProcessingConfig struct { // The compute location for the given transform property. @@ -2168,12 +2076,12 @@ type TransformProcessingConfig struct { // Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, // and contiguous time window. You can use this window in metrics to aggregate data -// from properties and other assets. You can use m, h, d, and w when you specify an -// interval or offset. Note that m represents minutes, h represents hours, d -// represents days, and w represents weeks. You can also use s to represent seconds -// in offset. The interval and offset parameters support the ISO 8601 format -// (https://en.wikipedia.org/wiki/ISO_8601). For example, PT5S represents 5 -// seconds, PT5M represents 5 minutes, and PT5H represents 5 hours. +// from properties and other assets. You can use m , h , d , and w when you +// specify an interval or offset. Note that m represents minutes, h represents +// hours, d represents days, and w represents weeks. You can also use s to +// represent seconds in offset . The interval and offset parameters support the +// ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601) . For example, PT5S +// represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours. type TumblingWindow struct { // The time interval for the tumbling window. The interval time must be between 1 @@ -2187,46 +2095,30 @@ type TumblingWindow struct { // This member is required. Interval *string - // The offset for the tumbling window. The offset parameter accepts the - // following: - // - // * The offset time. For example, if you specify 18h for offset and 1d - // for interval, IoT SiteWise aggregates data in one of the following ways: - // - // * If - // you create the metric before or at 6 PM (UTC), you get the first aggregation - // result at 6 PM (UTC) on the day when you create the metric. - // - // * If you create the - // metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the - // next day. - // - // * The ISO 8601 format. For example, if you specify PT18H for offset - // and 1d for interval, IoT SiteWise aggregates data in one of the following - // ways: - // - // * If you create the metric before or at 6 PM (UTC), you get the first - // aggregation result at 6 PM (UTC) on the day when you create the metric. - // - // * If - // you create the metric after 6 PM (UTC), you get the first aggregation result at - // 6 PM (UTC) the next day. - // - // * The 24-hour clock. For example, if you specify - // 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), - // you get the first aggregation result at 2:03 PM (UTC). You get the second - // aggregation result at 2:08 PM (UTC). - // - // * The offset time zone. For example, if - // you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise - // aggregates data in one of the following ways: - // - // * If you create the metric before - // or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day - // when you create the metric. - // - // * If you create the metric after 6 PM (PST), you - // get the first aggregation result at 6 PM (PST) the next day. + // The offset for the tumbling window. The offset parameter accepts the following: + // - The offset time. For example, if you specify 18h for offset and 1d for + // interval , IoT SiteWise aggregates data in one of the following ways: + // - If you create the metric before or at 6 PM (UTC), you get the first + // aggregation result at 6 PM (UTC) on the day when you create the metric. + // - If you create the metric after 6 PM (UTC), you get the first aggregation + // result at 6 PM (UTC) the next day. + // - The ISO 8601 format. For example, if you specify PT18H for offset and 1d for + // interval , IoT SiteWise aggregates data in one of the following ways: + // - If you create the metric before or at 6 PM (UTC), you get the first + // aggregation result at 6 PM (UTC) on the day when you create the metric. + // - If you create the metric after 6 PM (UTC), you get the first aggregation + // result at 6 PM (UTC) the next day. + // - The 24-hour clock. For example, if you specify 00:03:00 for offset , 5m for + // interval , and you create the metric at 2 PM (UTC), you get the first + // aggregation result at 2:03 PM (UTC). You get the second aggregation result at + // 2:08 PM (UTC). + // - The offset time zone. For example, if you specify 2021-07-23T18:00-08 for + // offset and 1d for interval , IoT SiteWise aggregates data in one of the + // following ways: + // - If you create the metric before or at 6 PM (PST), you get the first + // aggregation result at 6 PM (PST) on the day when you create the metric. + // - If you create the metric after 6 PM (PST), you get the first aggregation + // result at 6 PM (PST) the next day. Offset *string noSmithyDocumentSerde @@ -2255,10 +2147,9 @@ type VariableValue struct { // The ID of the hierarchy to query for the property ID. You can use the // hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead // of a model ID because you can have several hierarchies using the same model and - // therefore the same propertyId. For example, you might have separately grouped + // therefore the same propertyId . For example, you might have separately grouped // assets that come from the same asset model. For more information, see Asset - // hierarchies - // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) + // hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. HierarchyId *string diff --git a/service/iotthingsgraph/api_client.go b/service/iotthingsgraph/api_client.go index fe506a74453..c3bc5e8d855 100644 --- a/service/iotthingsgraph/api_client.go +++ b/service/iotthingsgraph/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotthingsgraph/api_op_CreateFlowTemplate.go b/service/iotthingsgraph/api_op_CreateFlowTemplate.go index 8b20825cf0c..b1b3f123b43 100644 --- a/service/iotthingsgraph/api_op_CreateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_CreateFlowTemplate.go @@ -35,7 +35,7 @@ func (c *Client) CreateFlowTemplate(ctx context.Context, params *CreateFlowTempl type CreateFlowTemplateInput struct { - // The workflow DefinitionDocument. + // The workflow DefinitionDocument . // // This member is required. Definition *types.DefinitionDocument diff --git a/service/iotthingsgraph/api_op_CreateSystemInstance.go b/service/iotthingsgraph/api_op_CreateSystemInstance.go index 494b4916951..b42f5ca8ffe 100644 --- a/service/iotthingsgraph/api_op_CreateSystemInstance.go +++ b/service/iotthingsgraph/api_op_CreateSystemInstance.go @@ -13,16 +13,16 @@ import ( // Creates a system instance. This action validates the system instance, prepares // the deployment-related resources. For Greengrass deployments, it updates the -// Greengrass group that is specified by the greengrassGroupName parameter. It also -// adds a file to the S3 bucket specified by the s3BucketName parameter. You need -// to call DeploySystemInstance after running this action. For Greengrass +// Greengrass group that is specified by the greengrassGroupName parameter. It +// also adds a file to the S3 bucket specified by the s3BucketName parameter. You +// need to call DeploySystemInstance after running this action. For Greengrass // deployments, since this action modifies and adds resources to a Greengrass group // and an S3 bucket on the caller's behalf, the calling identity must have write // permissions to both the specified Greengrass group and S3 bucket. Otherwise, the // call will fail with an authorization error. For cloud deployments, this action -// requires a flowActionsRoleArn value. This is an IAM role that has permissions to -// access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it -// executes. If the definition document doesn't specify a version of the user's +// requires a flowActionsRoleArn value. This is an IAM role that has permissions +// to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when +// it executes. If the definition document doesn't specify a version of the user's // namespace, the latest version will be used by default. // // Deprecated: since: 2022-08-30 @@ -48,7 +48,7 @@ type CreateSystemInstanceInput struct { // This member is required. Definition *types.DefinitionDocument - // The target type of the deployment. Valid values are GREENGRASS and CLOUD. + // The target type of the deployment. Valid values are GREENGRASS and CLOUD . // // This member is required. Target types.DeploymentTarget @@ -56,11 +56,11 @@ type CreateSystemInstanceInput struct { // The ARN of the IAM role that AWS IoT Things Graph will assume when it executes // the flow. This role must have read and write access to AWS Lambda and AWS IoT // and any other AWS services that the flow uses when it executes. This value is - // required if the value of the target parameter is CLOUD. + // required if the value of the target parameter is CLOUD . FlowActionsRoleArn *string // The name of the Greengrass group where the system instance will be deployed. - // This value is required if the value of the target parameter is GREENGRASS. + // This value is required if the value of the target parameter is GREENGRASS . GreengrassGroupName *string // An object that specifies whether cloud metrics are collected in a deployment @@ -69,7 +69,7 @@ type CreateSystemInstanceInput struct { // The name of the Amazon Simple Storage Service bucket that will be used to store // and deploy the system instance's resource file. This value is required if the - // value of the target parameter is GREENGRASS. + // value of the target parameter is GREENGRASS . S3BucketName *string // Metadata, consisting of key-value pairs, that can be used to categorize your diff --git a/service/iotthingsgraph/api_op_DeploySystemInstance.go b/service/iotthingsgraph/api_op_DeploySystemInstance.go index b03ee7c0388..c57d94708d7 100644 --- a/service/iotthingsgraph/api_op_DeploySystemInstance.go +++ b/service/iotthingsgraph/api_op_DeploySystemInstance.go @@ -12,7 +12,7 @@ import ( ) // Greengrass and Cloud Deployments Deploys the system instance to the target -// specified in CreateSystemInstance. Greengrass Deployments If the system or any +// specified in CreateSystemInstance . Greengrass Deployments If the system or any // workflows and entities have been updated before this action is called, then the // deployment will create a new Amazon Simple Storage Service resource file and // then deploy it. Since this action creates a Greengrass deployment on the @@ -20,8 +20,8 @@ import ( // specified Greengrass group. Otherwise, the call will fail with an authorization // error. For information about the artifacts that get added to your Greengrass // core device when you use this API, see AWS IoT Things Graph and AWS IoT -// Greengrass -// (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html). +// Greengrass (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html) +// . // // Deprecated: since: 2022-08-30 func (c *Client) DeploySystemInstance(ctx context.Context, params *DeploySystemInstanceInput, optFns ...func(*Options)) (*DeploySystemInstanceOutput, error) { diff --git a/service/iotthingsgraph/api_op_GetEntities.go b/service/iotthingsgraph/api_op_GetEntities.go index cb5a1ad28ff..2f1381a8750 100644 --- a/service/iotthingsgraph/api_op_GetEntities.go +++ b/service/iotthingsgraph/api_op_GetEntities.go @@ -13,29 +13,17 @@ import ( // Gets definitions of the specified entities. Uses the latest version of the // user's namespace by default. This API returns the following TDM entities. +// - Properties +// - States +// - Events +// - Actions +// - Capabilities +// - Mappings +// - Devices +// - Device Models +// - Services // -// * -// Properties -// -// * States -// -// * Events -// -// * Actions -// -// * Capabilities -// -// * Mappings -// -// * -// Devices -// -// * Device Models -// -// * Services -// -// This action doesn't return definitions for -// systems, flows, and deployments. +// This action doesn't return definitions for systems, flows, and deployments. // // Deprecated: since: 2022-08-30 func (c *Client) GetEntities(ctx context.Context, params *GetEntitiesInput, optFns ...func(*Options)) (*GetEntitiesOutput, error) { diff --git a/service/iotthingsgraph/api_op_GetSystemInstance.go b/service/iotthingsgraph/api_op_GetSystemInstance.go index 093be29d9c9..a32235aed47 100644 --- a/service/iotthingsgraph/api_op_GetSystemInstance.go +++ b/service/iotthingsgraph/api_op_GetSystemInstance.go @@ -32,7 +32,7 @@ func (c *Client) GetSystemInstance(ctx context.Context, params *GetSystemInstanc type GetSystemInstanceInput struct { // The ID of the system deployment instance. This value is returned by - // CreateSystemInstance. The ID should be in the following format. + // CreateSystemInstance . The ID should be in the following format. // urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME // // This member is required. diff --git a/service/iotthingsgraph/api_op_GetUploadStatus.go b/service/iotthingsgraph/api_op_GetUploadStatus.go index 39d4f64057c..abbac76c0a0 100644 --- a/service/iotthingsgraph/api_op_GetUploadStatus.go +++ b/service/iotthingsgraph/api_op_GetUploadStatus.go @@ -53,7 +53,7 @@ type GetUploadStatusOutput struct { // This member is required. UploadId *string - // The status of the upload. The initial status is IN_PROGRESS. The response show + // The status of the upload. The initial status is IN_PROGRESS . The response show // all validation failures if the upload fails. // // This member is required. diff --git a/service/iotthingsgraph/api_op_ListTagsForResource.go b/service/iotthingsgraph/api_op_ListTagsForResource.go index 8063f35c906..8018a7cf254 100644 --- a/service/iotthingsgraph/api_op_ListTagsForResource.go +++ b/service/iotthingsgraph/api_op_ListTagsForResource.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/iotthingsgraph/api_op_SearchEntities.go b/service/iotthingsgraph/api_op_SearchEntities.go index 04c942f11e5..7a43e8d99b9 100644 --- a/service/iotthingsgraph/api_op_SearchEntities.go +++ b/service/iotthingsgraph/api_op_SearchEntities.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for entities of the specified type. You can search for entities in your -// namespace and the public namespace that you're tracking. +// Searches for entities of the specified type. You can search for entities in +// your namespace and the public namespace that you're tracking. // // Deprecated: since: 2022-08-30 func (c *Client) SearchEntities(ctx context.Context, params *SearchEntitiesInput, optFns ...func(*Options)) (*SearchEntitiesOutput, error) { @@ -38,8 +38,8 @@ type SearchEntitiesInput struct { // This member is required. EntityTypes []types.EntityType - // Optional filter to apply to the search. Valid filters are NAMENAMESPACE, - // SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on + // Optional filter to apply to the search. Valid filters are NAME NAMESPACE , + // SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID . REFERENCED_ENTITY_ID filters on // entities that are used by the entity in the result set. For example, you can // filter on the ID of a property that is used in a state. Multiple filters // function as OR criteria in the query. Multiple values passed inside the filter diff --git a/service/iotthingsgraph/api_op_SearchFlowTemplates.go b/service/iotthingsgraph/api_op_SearchFlowTemplates.go index 79cf7c73bcf..2b691095a0d 100644 --- a/service/iotthingsgraph/api_op_SearchFlowTemplates.go +++ b/service/iotthingsgraph/api_op_SearchFlowTemplates.go @@ -33,7 +33,7 @@ func (c *Client) SearchFlowTemplates(ctx context.Context, params *SearchFlowTemp type SearchFlowTemplatesInput struct { // An array of objects that limit the result set. The only valid filter is - // DEVICE_MODEL_ID. + // DEVICE_MODEL_ID . Filters []types.FlowTemplateFilter // The maximum number of results to return in the response. @@ -124,8 +124,8 @@ func (c *Client) addOperationSearchFlowTemplatesMiddlewares(stack *middleware.St return nil } -// SearchFlowTemplatesAPIClient is a client that implements the SearchFlowTemplates -// operation. +// SearchFlowTemplatesAPIClient is a client that implements the +// SearchFlowTemplates operation. type SearchFlowTemplatesAPIClient interface { SearchFlowTemplates(context.Context, *SearchFlowTemplatesInput, ...func(*Options)) (*SearchFlowTemplatesOutput, error) } diff --git a/service/iotthingsgraph/api_op_SearchSystemInstances.go b/service/iotthingsgraph/api_op_SearchSystemInstances.go index cb2483289c8..cebfe19e180 100644 --- a/service/iotthingsgraph/api_op_SearchSystemInstances.go +++ b/service/iotthingsgraph/api_op_SearchSystemInstances.go @@ -32,8 +32,8 @@ func (c *Client) SearchSystemInstances(ctx context.Context, params *SearchSystem type SearchSystemInstancesInput struct { - // Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, - // STATUS, and GREENGRASS_GROUP_NAME. Multiple filters function as OR criteria in + // Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID , + // STATUS , and GREENGRASS_GROUP_NAME . Multiple filters function as OR criteria in // the query. Multiple values passed inside the filter function as AND criteria. Filters []types.SystemInstanceFilter diff --git a/service/iotthingsgraph/api_op_SearchSystemTemplates.go b/service/iotthingsgraph/api_op_SearchSystemTemplates.go index f0a9751f7d6..227a81929b5 100644 --- a/service/iotthingsgraph/api_op_SearchSystemTemplates.go +++ b/service/iotthingsgraph/api_op_SearchSystemTemplates.go @@ -35,7 +35,7 @@ func (c *Client) SearchSystemTemplates(ctx context.Context, params *SearchSystem type SearchSystemTemplatesInput struct { // An array of filters that limit the result set. The only valid filter is - // FLOW_TEMPLATE_ID. + // FLOW_TEMPLATE_ID . Filters []types.SystemTemplateFilter // The maximum number of results to return in the response. diff --git a/service/iotthingsgraph/api_op_SearchThings.go b/service/iotthingsgraph/api_op_SearchThings.go index 2a896b43334..1c2621176bc 100644 --- a/service/iotthingsgraph/api_op_SearchThings.go +++ b/service/iotthingsgraph/api_op_SearchThings.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for things associated with the specified entity. You can search by both -// device and device model. For example, if two different devices, camera1 and +// Searches for things associated with the specified entity. You can search by +// both device and device model. For example, if two different devices, camera1 and // camera2, implement the camera device model, the user can associate thing1 to // camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, // but SearchThings(camera) will return both thing1 and thing2. This action diff --git a/service/iotthingsgraph/api_op_UntagResource.go b/service/iotthingsgraph/api_op_UntagResource.go index 86cf1da48a4..e6db74da981 100644 --- a/service/iotthingsgraph/api_op_UntagResource.go +++ b/service/iotthingsgraph/api_op_UntagResource.go @@ -39,8 +39,7 @@ type UntagResourceInput struct { // value. Both the key and its associated value are removed. This parameter to the // API requires a JSON text string argument. For information on how to format a // JSON parameter for the various command line tool environments, see Using JSON - // for Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json) + // for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json) // in the AWS CLI User Guide. // // This member is required. diff --git a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go index e40cf25e8d4..d551dcdb035 100644 --- a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go @@ -47,8 +47,8 @@ type UpdateFlowTemplateInput struct { Id *string // The version of the user's namespace. If no value is specified, the latest - // version is used by default. Use the GetFlowTemplateRevisions if you want to find - // earlier revisions of the flow to update. + // version is used by default. Use the GetFlowTemplateRevisions if you want to + // find earlier revisions of the flow to update. CompatibleNamespaceVersion *int64 noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go index fff5a233441..ce58bbef1b2 100644 --- a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified system. You don't need to run this action after updating a -// workflow. Any deployment that uses the system will see the changes in the system -// when it is redeployed. +// Updates the specified system. You don't need to run this action after updating +// a workflow. Any deployment that uses the system will see the changes in the +// system when it is redeployed. // // Deprecated: since: 2022-08-30 func (c *Client) UpdateSystemTemplate(ctx context.Context, params *UpdateSystemTemplateInput, optFns ...func(*Options)) (*UpdateSystemTemplateOutput, error) { diff --git a/service/iotthingsgraph/api_op_UploadEntityDefinitions.go b/service/iotthingsgraph/api_op_UploadEntityDefinitions.go index 580c2ee1a20..0508a2bfaed 100644 --- a/service/iotthingsgraph/api_op_UploadEntityDefinitions.go +++ b/service/iotthingsgraph/api_op_UploadEntityDefinitions.go @@ -13,21 +13,21 @@ import ( // Asynchronously uploads one or more entity definitions to the user's namespace. // The document parameter is required if syncWithPublicNamespace and -// deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set -// to true, the user's namespace will synchronize with the latest version of the -// public namespace. If deprecateExistingEntities is set to true, all entities in -// the latest version will be deleted before the new DefinitionDocument is +// deleteExistingEntites are false. If the syncWithPublicNamespace parameter is +// set to true , the user's namespace will synchronize with the latest version of +// the public namespace. If deprecateExistingEntities is set to true, all entities +// in the latest version will be deleted before the new DefinitionDocument is // uploaded. When a user uploads entity definitions for the first time, the service // creates a new namespace for the user. The new namespace tracks the public // namespace. Currently users can have only one namespace. The namespace version // increments whenever a user uploads entity definitions that are // backwards-incompatible and whenever a user sets the syncWithPublicNamespace -// parameter or the deprecateExistingEntities parameter to true. The IDs for all of -// the entities should be in URN format. Each entity must be in the user's +// parameter or the deprecateExistingEntities parameter to true . The IDs for all +// of the entities should be in URN format. Each entity must be in the user's // namespace. Users can't create entities in the public namespace, but entity // definitions can refer to entities in the public namespace. Valid entities are -// Device, DeviceModel, Service, Capability, State, Action, Event, Property, -// Mapping, Enum. +// Device , DeviceModel , Service , Capability , State , Action , Event , Property +// , Mapping , Enum . // // Deprecated: since: 2022-08-30 func (c *Client) UploadEntityDefinitions(ctx context.Context, params *UploadEntityDefinitionsInput, optFns ...func(*Options)) (*UploadEntityDefinitionsOutput, error) { @@ -47,16 +47,16 @@ func (c *Client) UploadEntityDefinitions(ctx context.Context, params *UploadEnti type UploadEntityDefinitionsInput struct { - // A Boolean that specifies whether to deprecate all entities in the latest version - // before uploading the new DefinitionDocument. If set to true, the upload will - // create a new namespace version. + // A Boolean that specifies whether to deprecate all entities in the latest + // version before uploading the new DefinitionDocument . If set to true , the + // upload will create a new namespace version. DeprecateExistingEntities bool // The DefinitionDocument that defines the updated entities. Document *types.DefinitionDocument // A Boolean that specifies whether to synchronize with the latest version of the - // public namespace. If set to true, the upload will create a new namespace + // public namespace. If set to true , the upload will create a new namespace // version. SyncWithPublicNamespace bool @@ -65,8 +65,8 @@ type UploadEntityDefinitionsInput struct { type UploadEntityDefinitionsOutput struct { - // The ID that specifies the upload action. You can use this to track the status of - // the upload. + // The ID that specifies the upload action. You can use this to track the status + // of the upload. // // This member is required. UploadId *string diff --git a/service/iotthingsgraph/doc.go b/service/iotthingsgraph/doc.go index 85fb45a72af..a4c84743b56 100644 --- a/service/iotthingsgraph/doc.go +++ b/service/iotthingsgraph/doc.go @@ -9,6 +9,6 @@ // Graph makes it possible to build IoT applications with little to no code by // connecting devices and services and defining how they interact at an abstract // level. For more information about how AWS IoT Things Graph works, see the User -// Guide (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html). +// Guide (https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html) . // The AWS IoT Things Graph service is discontinued. package iotthingsgraph diff --git a/service/iotthingsgraph/types/enums.go b/service/iotthingsgraph/types/enums.go index 7093e823f32..a3065d73876 100644 --- a/service/iotthingsgraph/types/enums.go +++ b/service/iotthingsgraph/types/enums.go @@ -205,8 +205,8 @@ const ( NamespaceDeletionStatusErrorCodesValidationFailed NamespaceDeletionStatusErrorCodes = "VALIDATION_FAILED" ) -// Values returns all known values for NamespaceDeletionStatusErrorCodes. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for NamespaceDeletionStatusErrorCodes. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (NamespaceDeletionStatusErrorCodes) Values() []NamespaceDeletionStatusErrorCodes { @@ -255,9 +255,9 @@ const ( SystemInstanceFilterNameGreengrassGroupName SystemInstanceFilterName = "GREENGRASS_GROUP_NAME" ) -// Values returns all known values for SystemInstanceFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SystemInstanceFilterName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SystemInstanceFilterName) Values() []SystemInstanceFilterName { return []SystemInstanceFilterName{ "SYSTEM_TEMPLATE_ID", @@ -273,9 +273,9 @@ const ( SystemTemplateFilterNameFlowTemplateId SystemTemplateFilterName = "FLOW_TEMPLATE_ID" ) -// Values returns all known values for SystemTemplateFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SystemTemplateFilterName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SystemTemplateFilterName) Values() []SystemTemplateFilterName { return []SystemTemplateFilterName{ "FLOW_TEMPLATE_ID", @@ -291,9 +291,9 @@ const ( UploadStatusFailed UploadStatus = "FAILED" ) -// Values returns all known values for UploadStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UploadStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UploadStatus) Values() []UploadStatus { return []UploadStatus{ "IN_PROGRESS", diff --git a/service/iotthingsgraph/types/types.go b/service/iotthingsgraph/types/types.go index 2c8c5559789..c4b8733250f 100644 --- a/service/iotthingsgraph/types/types.go +++ b/service/iotthingsgraph/types/types.go @@ -60,7 +60,7 @@ type EntityDescription struct { // An object that filters an entity search. Multiple filters function as OR // criteria in the search. For example a search that includes a NAMESPACE and a // REFERENCED_ENTITY_ID filter searches for entities in the specified namespace -// that use the entity specified by the value of REFERENCED_ENTITY_ID. +// that use the entity specified by the value of REFERENCED_ENTITY_ID . type EntityFilter struct { // The name of the entity search filter field. REFERENCED_ENTITY_ID filters on @@ -215,8 +215,8 @@ type SystemInstanceDescription struct { noSmithyDocumentSerde } -// An object that filters a system instance search. Multiple filters function as OR -// criteria in the search. For example a search that includes a +// An object that filters a system instance search. Multiple filters function as +// OR criteria in the search. For example a search that includes a // GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the // specified Greengrass group that have the specified status. type SystemInstanceFilter struct { diff --git a/service/iottwinmaker/api_client.go b/service/iottwinmaker/api_client.go index 8558087c349..46a0d23c869 100644 --- a/service/iottwinmaker/api_client.go +++ b/service/iottwinmaker/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iottwinmaker/api_op_BatchPutPropertyValues.go b/service/iottwinmaker/api_op_BatchPutPropertyValues.go index 18a37cdd4d3..bb1808073d4 100644 --- a/service/iottwinmaker/api_op_BatchPutPropertyValues.go +++ b/service/iottwinmaker/api_op_BatchPutPropertyValues.go @@ -30,8 +30,8 @@ func (c *Client) BatchPutPropertyValues(ctx context.Context, params *BatchPutPro type BatchPutPropertyValuesInput struct { - // An object that maps strings to the property value entries to set. Each string in - // the mapping must be unique to this object. + // An object that maps strings to the property value entries to set. Each string + // in the mapping must be unique to this object. // // This member is required. Entries []types.PropertyValueEntry diff --git a/service/iottwinmaker/api_op_GetPropertyValue.go b/service/iottwinmaker/api_op_GetPropertyValue.go index e3ec717a92f..8c461e7c792 100644 --- a/service/iottwinmaker/api_op_GetPropertyValue.go +++ b/service/iottwinmaker/api_op_GetPropertyValue.go @@ -13,8 +13,8 @@ import ( ) // Gets the property values for a component, component type, entity, or workspace. -// You must specify a value for either componentName, componentTypeId, entityId, or -// workspaceId. +// You must specify a value for either componentName , componentTypeId , entityId , +// or workspaceId . func (c *Client) GetPropertyValue(ctx context.Context, params *GetPropertyValueInput, optFns ...func(*Options)) (*GetPropertyValueOutput, error) { if params == nil { params = &GetPropertyValueInput{} diff --git a/service/iottwinmaker/api_op_GetPropertyValueHistory.go b/service/iottwinmaker/api_op_GetPropertyValueHistory.go index e6ea8b741cf..9a87f110a88 100644 --- a/service/iottwinmaker/api_op_GetPropertyValueHistory.go +++ b/service/iottwinmaker/api_op_GetPropertyValueHistory.go @@ -15,8 +15,8 @@ import ( // Retrieves information about the history of a time series property value for a // component, component type, entity, or workspace. You must specify a value for -// workspaceId. For entity-specific queries, specify values for componentName and -// entityId. For cross-entity quries, specify a value for componentTypeId. +// workspaceId . For entity-specific queries, specify values for componentName and +// entityId . For cross-entity quries, specify a value for componentTypeId . func (c *Client) GetPropertyValueHistory(ctx context.Context, params *GetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetPropertyValueHistoryOutput, error) { if params == nil { params = &GetPropertyValueHistoryInput{} @@ -57,8 +57,8 @@ type GetPropertyValueHistoryInput struct { EndDateTime *time.Time // The ISO8601 DateTime of the latest property value to return. For more - // information about the ISO8601 DateTime format, see the data type PropertyValue - // (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html). + // information about the ISO8601 DateTime format, see the data type PropertyValue (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html) + // . EndTime *string // The ID of the entity. @@ -88,8 +88,8 @@ type GetPropertyValueHistoryInput struct { StartDateTime *time.Time // The ISO8601 DateTime of the earliest property value to return. For more - // information about the ISO8601 DateTime format, see the data type PropertyValue - // (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html). + // information about the ISO8601 DateTime format, see the data type PropertyValue (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html) + // . StartTime *string noSmithyDocumentSerde diff --git a/service/iottwinmaker/api_op_ListSyncResources.go b/service/iottwinmaker/api_op_ListSyncResources.go index b87e205afd9..b14d675151b 100644 --- a/service/iottwinmaker/api_op_ListSyncResources.go +++ b/service/iottwinmaker/api_op_ListSyncResources.go @@ -40,15 +40,11 @@ type ListSyncResourcesInput struct { // This member is required. WorkspaceId *string - // A list of objects that filter the request. The following filter combinations are - // supported: - // - // * Filter with state - // - // * Filter with ResourceType and ResourceId - // - // * - // Filter with ResourceType and ExternalId + // A list of objects that filter the request. The following filter combinations + // are supported: + // - Filter with state + // - Filter with ResourceType and ResourceId + // - Filter with ResourceType and ExternalId Filters []types.SyncResourceFilter // The maximum number of results to return at one time. The default is 50. Valid diff --git a/service/iottwinmaker/api_op_UpdateEntity.go b/service/iottwinmaker/api_op_UpdateEntity.go index 4342fbc4bd9..7f4652417c7 100644 --- a/service/iottwinmaker/api_op_UpdateEntity.go +++ b/service/iottwinmaker/api_op_UpdateEntity.go @@ -41,8 +41,8 @@ type UpdateEntityInput struct { // This member is required. WorkspaceId *string - // An object that maps strings to the component updates in the request. Each string - // in the mapping must be unique to this object. + // An object that maps strings to the component updates in the request. Each + // string in the mapping must be unique to this object. ComponentUpdates map[string]types.ComponentUpdateRequest // The description of the entity. diff --git a/service/iottwinmaker/doc.go b/service/iottwinmaker/doc.go index 7ae14d0bba0..4fe2ddbbbc4 100644 --- a/service/iottwinmaker/doc.go +++ b/service/iottwinmaker/doc.go @@ -3,8 +3,8 @@ // Package iottwinmaker provides the API client, operations, and parameter types // for AWS IoT TwinMaker. // -// IoT TwinMaker is a service with which you can build operational digital twins of -// physical systems. IoT TwinMaker overlays measurements and analysis from +// IoT TwinMaker is a service with which you can build operational digital twins +// of physical systems. IoT TwinMaker overlays measurements and analysis from // real-world sensors, cameras, and enterprise applications so you can create data // visualizations to monitor your physical factory, building, or industrial plant. // You can use this real-world data to monitor operations and diagnose and repair diff --git a/service/iottwinmaker/document/document.go b/service/iottwinmaker/document/document.go index 2fe6b6821e6..10bee6a87f4 100644 --- a/service/iottwinmaker/document/document.go +++ b/service/iottwinmaker/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/iottwinmaker/internal/document/document.go b/service/iottwinmaker/internal/document/document.go index 4080f81b8a8..af095544ffd 100644 --- a/service/iottwinmaker/internal/document/document.go +++ b/service/iottwinmaker/internal/document/document.go @@ -15,8 +15,8 @@ type smithyDocument interface { isSmithyDocument() } -// github.com/aws/aws-sdk-go-v2/service/iottwinmaker/internal/document.Interface is -// a JSON-like data model type that is protocol agnostic and is usedto send +// github.com/aws/aws-sdk-go-v2/service/iottwinmaker/internal/document.Interface +// is a JSON-like data model type that is protocol agnostic and is usedto send // open-content to a service. type Interface interface { smithyDocument diff --git a/service/iottwinmaker/types/enums.go b/service/iottwinmaker/types/enums.go index 1217f0b5023..52cc4acf889 100644 --- a/service/iottwinmaker/types/enums.go +++ b/service/iottwinmaker/types/enums.go @@ -53,9 +53,9 @@ const ( ErrorCodeSyncProcessingError ErrorCode = "SYNC_PROCESSING_ERROR" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "VALIDATION_ERROR", @@ -73,9 +73,9 @@ const ( GroupTypeTabular GroupType = "TABULAR" ) -// Values returns all known values for GroupType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for GroupType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (GroupType) Values() []GroupType { return []GroupType{ "TABULAR", @@ -106,8 +106,8 @@ const ( OrderDescending Order = "DESCENDING" ) -// Values returns all known values for Order. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Order. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Order) Values() []Order { return []Order{ @@ -242,8 +242,8 @@ const ( ScopeWorkspace Scope = "WORKSPACE" ) -// Values returns all known values for Scope. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Scope. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Scope) Values() []Scope { return []Scope{ @@ -263,8 +263,8 @@ const ( StateError State = "ERROR" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ @@ -287,9 +287,9 @@ const ( SyncJobStateError SyncJobState = "ERROR" ) -// Values returns all known values for SyncJobState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SyncJobState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SyncJobState) Values() []SyncJobState { return []SyncJobState{ "CREATING", @@ -383,9 +383,9 @@ const ( UpdateReasonOverwritten UpdateReason = "OVERWRITTEN" ) -// Values returns all known values for UpdateReason. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateReason. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpdateReason) Values() []UpdateReason { return []UpdateReason{ "DEFAULT", diff --git a/service/iottwinmaker/types/types.go b/service/iottwinmaker/types/types.go index d8346f98833..74ef9183b78 100644 --- a/service/iottwinmaker/types/types.go +++ b/service/iottwinmaker/types/types.go @@ -115,8 +115,8 @@ type ComponentRequest struct { // The description of the component request. Description *string - // An object that maps strings to the properties to set in the component type. Each - // string in the mapping must be unique to this object. + // An object that maps strings to the properties to set in the component type. + // Each string in the mapping must be unique to this object. Properties map[string]PropertyRequest // The property groups. @@ -141,8 +141,8 @@ type ComponentResponse struct { // The description of the component type. Description *string - // An object that maps strings to the properties to set in the component type. Each - // string in the mapping must be unique to this object. + // An object that maps strings to the properties to set in the component type. + // Each string in the mapping must be unique to this object. Properties map[string]PropertyResponse // The property groups. @@ -477,8 +477,8 @@ type ListEntitiesFilterMemberComponentTypeId struct { func (*ListEntitiesFilterMemberComponentTypeId) isListEntitiesFilter() {} -// The external-Id property of a component. The external-Id property is the primary -// key of an external storage system. +// The external-Id property of a component. The external-Id property is the +// primary key of an external storage system. type ListEntitiesFilterMemberExternalId struct { Value string @@ -615,8 +615,8 @@ type PropertyDefinitionResponse struct { // This member is required. IsImported *bool - // A Boolean value that specifies whether the property definition is inherited from - // a parent entity. + // A Boolean value that specifies whether the property definition is inherited + // from a parent entity. // // This member is required. IsInherited *bool @@ -749,31 +749,17 @@ type PropertyValue struct { // ISO8601 DateTime of a value for a time series property. The time for when the // property value was recorded in ISO 8601 format: // YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]. - // - // * [YYYY]: year - // - // * [MM]: month - // - // * - // [DD]: day - // - // * [hh]: hour - // - // * [mm]: minute - // - // * [ss]: seconds - // - // * [.SSSSSSSSS]: - // additional precision, where precedence is maintained. For example: [.573123] is - // equal to 573123000 nanoseconds. - // - // * Z: default timezone UTC - // - // * ± HH:mm: time zone - // offset in Hours and Minutes. - // - // Required sub-fields: YYYY-MM-DDThh:mm:ss and - // [Z/±HH:mm] + // - [YYYY]: year + // - [MM]: month + // - [DD]: day + // - [hh]: hour + // - [mm]: minute + // - [ss]: seconds + // - [.SSSSSSSSS]: additional precision, where precedence is maintained. For + // example: [.573123] is equal to 573123000 nanoseconds. + // - Z: default timezone UTC + // - ± HH:mm: time zone offset in Hours and Minutes. + // Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm] Time *string // The timestamp of a value for a time series property. @@ -786,8 +772,7 @@ type PropertyValue struct { } // An object that specifies information about time series property values. This -// object is used and consumed by the BatchPutPropertyValues -// (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html) +// object is used and consumed by the BatchPutPropertyValues (https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html) // action. type PropertyValueEntry struct { @@ -884,8 +869,8 @@ type SceneSummary struct { noSmithyDocumentSerde } -// An object that represents the status of an entity, component, component type, or -// workspace. +// An object that represents the status of an entity, component, component type, +// or workspace. type Status struct { // The error message. diff --git a/service/iotwireless/api_client.go b/service/iotwireless/api_client.go index 7006062b487..b8885aff14b 100644 --- a/service/iotwireless/api_client.go +++ b/service/iotwireless/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go b/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go index f91f088f5ec..79c940cd1a0 100644 --- a/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go +++ b/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go @@ -41,8 +41,8 @@ type AssociateAwsAccountWithPartnerAccountInput struct { // client request. ClientRequestToken *string - // The tags to attach to the specified resource. Tags are metadata that you can use - // to manage a resource. + // The tags to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_CreateDestination.go b/service/iotwireless/api_op_CreateDestination.go index 3f00efbbf15..d366a7a7e0e 100644 --- a/service/iotwireless/api_op_CreateDestination.go +++ b/service/iotwireless/api_op_CreateDestination.go @@ -35,7 +35,7 @@ type CreateDestinationInput struct { // This member is required. Expression *string - // The type of value in Expression. + // The type of value in Expression . // // This member is required. ExpressionType types.ExpressionType @@ -59,8 +59,8 @@ type CreateDestinationInput struct { // The description of the new resource. Description *string - // The tags to attach to the new destination. Tags are metadata that you can use to - // manage a resource. + // The tags to attach to the new destination. Tags are metadata that you can use + // to manage a resource. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_CreateDeviceProfile.go b/service/iotwireless/api_op_CreateDeviceProfile.go index 843f7765a49..769cc47af62 100644 --- a/service/iotwireless/api_op_CreateDeviceProfile.go +++ b/service/iotwireless/api_op_CreateDeviceProfile.go @@ -45,8 +45,8 @@ type CreateDeviceProfileInput struct { // The Sidewalk-related information for creating the Sidewalk device profile. Sidewalk *types.SidewalkCreateDeviceProfile - // The tags to attach to the new device profile. Tags are metadata that you can use - // to manage a resource. + // The tags to attach to the new device profile. Tags are metadata that you can + // use to manage a resource. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_CreateFuotaTask.go b/service/iotwireless/api_op_CreateFuotaTask.go index 5d210cac92d..36d4a03d4ab 100644 --- a/service/iotwireless/api_op_CreateFuotaTask.go +++ b/service/iotwireless/api_op_CreateFuotaTask.go @@ -57,8 +57,8 @@ type CreateFuotaTaskInput struct { // delay with the cloud. FragmentIntervalMS *int32 - // The size of each fragment in bytes. Currently only supported in fuota tasks with - // multicast groups. + // The size of each fragment in bytes. Currently only supported in fuota tasks + // with multicast groups. FragmentSizeBytes *int32 // The LoRaWAN information used with a FUOTA task. diff --git a/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go b/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go index bcab1527ed1..bb3cb661cfc 100644 --- a/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go +++ b/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go @@ -55,8 +55,8 @@ type CreateNetworkAnalyzerConfigurationInput struct { // the WirelessDeviceId of the resource to add in the input array. WirelessDevices []string - // Wireless gateway resources to add to the network analyzer configuration. Provide - // the WirelessGatewayId of the resource to add in the input array. + // Wireless gateway resources to add to the network analyzer configuration. + // Provide the WirelessGatewayId of the resource to add in the input array. WirelessGateways []string noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go b/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go index 9e176fe78c0..5c11e430f16 100644 --- a/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go +++ b/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go @@ -31,8 +31,8 @@ func (c *Client) CreateWirelessGatewayTaskDefinition(ctx context.Context, params type CreateWirelessGatewayTaskDefinitionInput struct { // Whether to automatically create tasks using this task definition for all - // gateways with the specified current version. If false, the task must me created - // by calling CreateWirelessGatewayTask. + // gateways with the specified current version. If false , the task must me created + // by calling CreateWirelessGatewayTask . // // This member is required. AutoCreateTasks bool @@ -46,8 +46,8 @@ type CreateWirelessGatewayTaskDefinitionInput struct { // The name of the new resource. Name *string - // The tags to attach to the specified resource. Tags are metadata that you can use - // to manage a resource. + // The tags to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. Tags []types.Tag // Information about the gateways to update. diff --git a/service/iotwireless/api_op_DeleteQueuedMessages.go b/service/iotwireless/api_op_DeleteQueuedMessages.go index 753a6a6b506..9a6e3707e4e 100644 --- a/service/iotwireless/api_op_DeleteQueuedMessages.go +++ b/service/iotwireless/api_op_DeleteQueuedMessages.go @@ -34,7 +34,7 @@ type DeleteQueuedMessagesInput struct { // This member is required. Id *string - // If message ID is "*", it cleares the entire downlink queue for a given device, + // If message ID is "*" , it cleares the entire downlink queue for a given device, // specified by the wireless device ID. Otherwise, the downlink message with the // specified message ID will be deleted. // diff --git a/service/iotwireless/api_op_DeregisterWirelessDevice.go b/service/iotwireless/api_op_DeregisterWirelessDevice.go index 0201f90e131..af2d362064c 100644 --- a/service/iotwireless/api_op_DeregisterWirelessDevice.go +++ b/service/iotwireless/api_op_DeregisterWirelessDevice.go @@ -35,7 +35,7 @@ type DeregisterWirelessDeviceInput struct { Identifier *string // The type of wireless device to deregister from AWS IoT Wireless, which can be - // LoRaWAN or Sidewalk. + // LoRaWAN or Sidewalk . WirelessDeviceType types.WirelessDeviceType noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_DisassociateAwsAccountFromPartnerAccount.go b/service/iotwireless/api_op_DisassociateAwsAccountFromPartnerAccount.go index 48c757443aa..c43afd7f69c 100644 --- a/service/iotwireless/api_op_DisassociateAwsAccountFromPartnerAccount.go +++ b/service/iotwireless/api_op_DisassociateAwsAccountFromPartnerAccount.go @@ -12,7 +12,7 @@ import ( ) // Disassociates your AWS account from a partner account. If PartnerAccountId and -// PartnerType are null, disassociates your AWS account from all partner accounts. +// PartnerType are null , disassociates your AWS account from all partner accounts. func (c *Client) DisassociateAwsAccountFromPartnerAccount(ctx context.Context, params *DisassociateAwsAccountFromPartnerAccountInput, optFns ...func(*Options)) (*DisassociateAwsAccountFromPartnerAccountOutput, error) { if params == nil { params = &DisassociateAwsAccountFromPartnerAccountInput{} diff --git a/service/iotwireless/api_op_GetDestination.go b/service/iotwireless/api_op_GetDestination.go index d895348cc41..df87e061345 100644 --- a/service/iotwireless/api_op_GetDestination.go +++ b/service/iotwireless/api_op_GetDestination.go @@ -48,7 +48,7 @@ type GetDestinationOutput struct { // The rule name or topic rule to send messages to. Expression *string - // The type of value in Expression. + // The type of value in Expression . ExpressionType types.ExpressionType // The name of the resource. diff --git a/service/iotwireless/api_op_GetFuotaTask.go b/service/iotwireless/api_op_GetFuotaTask.go index c212f2e2acd..24c1f68dab9 100644 --- a/service/iotwireless/api_op_GetFuotaTask.go +++ b/service/iotwireless/api_op_GetFuotaTask.go @@ -63,8 +63,8 @@ type GetFuotaTaskOutput struct { // delay with the cloud. FragmentIntervalMS *int32 - // The size of each fragment in bytes. Currently only supported in fuota tasks with - // multicast groups. + // The size of each fragment in bytes. Currently only supported in fuota tasks + // with multicast groups. FragmentSizeBytes *int32 // The ID of a FUOTA task. diff --git a/service/iotwireless/api_op_GetPartnerAccount.go b/service/iotwireless/api_op_GetPartnerAccount.go index 4aa7319b712..4516bbaf6b6 100644 --- a/service/iotwireless/api_op_GetPartnerAccount.go +++ b/service/iotwireless/api_op_GetPartnerAccount.go @@ -12,7 +12,7 @@ import ( ) // Gets information about a partner account. If PartnerAccountId and PartnerType -// are null, returns all partner accounts. +// are null , returns all partner accounts. func (c *Client) GetPartnerAccount(ctx context.Context, params *GetPartnerAccountInput, optFns ...func(*Options)) (*GetPartnerAccountOutput, error) { if params == nil { params = &GetPartnerAccountInput{} diff --git a/service/iotwireless/api_op_GetPosition.go b/service/iotwireless/api_op_GetPosition.go index 0bc006947ff..09be2fdb3ea 100644 --- a/service/iotwireless/api_op_GetPosition.go +++ b/service/iotwireless/api_op_GetPosition.go @@ -13,8 +13,7 @@ import ( // Get the position information for a given resource. This action is no longer // supported. Calls to retrieve the position information should use the -// GetResourcePosition -// (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) +// GetResourcePosition (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) // API operation instead. // // Deprecated: This operation is no longer supported. diff --git a/service/iotwireless/api_op_GetPositionConfiguration.go b/service/iotwireless/api_op_GetPositionConfiguration.go index dfcd2ff7a5e..0c960e791f6 100644 --- a/service/iotwireless/api_op_GetPositionConfiguration.go +++ b/service/iotwireless/api_op_GetPositionConfiguration.go @@ -13,8 +13,7 @@ import ( // Get position configuration for a given resource. This action is no longer // supported. Calls to retrieve the position configuration should use the -// GetResourcePosition -// (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) +// GetResourcePosition (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) // API operation instead. // // Deprecated: This operation is no longer supported. @@ -50,8 +49,8 @@ type GetPositionConfigurationInput struct { type GetPositionConfigurationOutput struct { - // The position data destination that describes the AWS IoT rule that processes the - // device's position data for use by AWS IoT Core for LoRaWAN. + // The position data destination that describes the AWS IoT rule that processes + // the device's position data for use by AWS IoT Core for LoRaWAN. Destination *string // The wrapper for the solver configuration details object. diff --git a/service/iotwireless/api_op_GetPositionEstimate.go b/service/iotwireless/api_op_GetPositionEstimate.go index 4582d4951c5..af99f8f2fb8 100644 --- a/service/iotwireless/api_op_GetPositionEstimate.go +++ b/service/iotwireless/api_op_GetPositionEstimate.go @@ -62,7 +62,7 @@ type GetPositionEstimateOutput struct { // The position information of the resource, displayed as a JSON payload. The // payload uses the GeoJSON format, which a format that's used to encode geographic - // data structures. For more information, see GeoJSON (https://geojson.org/). + // data structures. For more information, see GeoJSON (https://geojson.org/) . GeoJsonPayload []byte // Metadata pertaining to the operation's result. diff --git a/service/iotwireless/api_op_GetResourceEventConfiguration.go b/service/iotwireless/api_op_GetResourceEventConfiguration.go index 86a85cb657c..bb242163a21 100644 --- a/service/iotwireless/api_op_GetResourceEventConfiguration.go +++ b/service/iotwireless/api_op_GetResourceEventConfiguration.go @@ -39,7 +39,7 @@ type GetResourceEventConfigurationInput struct { // This member is required. IdentifierType types.IdentifierType - // Partner type of the resource if the identifier type is PartnerAccountId. + // Partner type of the resource if the identifier type is PartnerAccountId . PartnerType types.EventNotificationPartnerType noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_GetResourceLogLevel.go b/service/iotwireless/api_op_GetResourceLogLevel.go index 8a5b91755b1..114f05be4fd 100644 --- a/service/iotwireless/api_op_GetResourceLogLevel.go +++ b/service/iotwireless/api_op_GetResourceLogLevel.go @@ -30,13 +30,13 @@ func (c *Client) GetResourceLogLevel(ctx context.Context, params *GetResourceLog type GetResourceLogLevelInput struct { - // The identifier of the resource. For a Wireless Device, it is the wireless device - // ID. For a wireless gateway, it is the wireless gateway ID. + // The identifier of the resource. For a Wireless Device, it is the wireless + // device ID. For a wireless gateway, it is the wireless gateway ID. // // This member is required. ResourceIdentifier *string - // The type of the resource, which can be WirelessDevice or WirelessGateway. + // The type of the resource, which can be WirelessDevice or WirelessGateway . // // This member is required. ResourceType *string diff --git a/service/iotwireless/api_op_GetResourcePosition.go b/service/iotwireless/api_op_GetResourcePosition.go index 781e6ab3b03..75942354c4d 100644 --- a/service/iotwireless/api_op_GetResourcePosition.go +++ b/service/iotwireless/api_op_GetResourcePosition.go @@ -12,8 +12,8 @@ import ( ) // Get the position information for a given wireless device or a wireless gateway -// resource. The position information uses the World Geodetic System (WGS84) -// (https://gisgeography.com/wgs84-world-geodetic-system/). +// resource. The position information uses the World Geodetic System (WGS84) (https://gisgeography.com/wgs84-world-geodetic-system/) +// . func (c *Client) GetResourcePosition(ctx context.Context, params *GetResourcePositionInput, optFns ...func(*Options)) (*GetResourcePositionOutput, error) { if params == nil { params = &GetResourcePositionInput{} @@ -38,8 +38,8 @@ type GetResourcePositionInput struct { // This member is required. ResourceIdentifier *string - // The type of resource for which position information is retrieved, which can be a - // wireless device or a wireless gateway. + // The type of resource for which position information is retrieved, which can be + // a wireless device or a wireless gateway. // // This member is required. ResourceType types.PositionResourceType @@ -51,7 +51,7 @@ type GetResourcePositionOutput struct { // The position information of the resource, displayed as a JSON payload. The // payload uses the GeoJSON format, which a format that's used to encode geographic - // data structures. For more information, see GeoJSON (https://geojson.org/). + // data structures. For more information, see GeoJSON (https://geojson.org/) . GeoJsonPayload []byte // Metadata pertaining to the operation's result. diff --git a/service/iotwireless/api_op_GetWirelessDevice.go b/service/iotwireless/api_op_GetWirelessDevice.go index dec89259ae7..ebb994847e0 100644 --- a/service/iotwireless/api_op_GetWirelessDevice.go +++ b/service/iotwireless/api_op_GetWirelessDevice.go @@ -34,7 +34,7 @@ type GetWirelessDeviceInput struct { // This member is required. Identifier *string - // The type of identifier used in identifier. + // The type of identifier used in identifier . // // This member is required. IdentifierType types.WirelessDeviceIdType @@ -72,8 +72,8 @@ type GetWirelessDeviceOutput struct { // The ARN of the thing associated with the wireless device. ThingArn *string - // The name of the thing associated with the wireless device. The value is empty if - // a thing isn't associated with the device. + // The name of the thing associated with the wireless device. The value is empty + // if a thing isn't associated with the device. ThingName *string // The wireless device type. diff --git a/service/iotwireless/api_op_GetWirelessDeviceImportTask.go b/service/iotwireless/api_op_GetWirelessDeviceImportTask.go index 0a76902f3dd..0a18f9b87f9 100644 --- a/service/iotwireless/api_op_GetWirelessDeviceImportTask.go +++ b/service/iotwireless/api_op_GetWirelessDeviceImportTask.go @@ -58,8 +58,8 @@ type GetWirelessDeviceImportTaskOutput struct { // The identifier of the import task for which information is retrieved. Id *string - // The number of devices in the import task that are waiting for the control log to - // start processing. + // The number of devices in the import task that are waiting for the control log + // to start processing. InitializedImportedDeviceCount *int64 // The number of devices in the import task that have been onboarded to the import diff --git a/service/iotwireless/api_op_GetWirelessGateway.go b/service/iotwireless/api_op_GetWirelessGateway.go index f66a41e9f30..1a876e21b2f 100644 --- a/service/iotwireless/api_op_GetWirelessGateway.go +++ b/service/iotwireless/api_op_GetWirelessGateway.go @@ -34,7 +34,7 @@ type GetWirelessGatewayInput struct { // This member is required. Identifier *string - // The type of identifier used in identifier. + // The type of identifier used in identifier . // // This member is required. IdentifierType types.WirelessGatewayIdType diff --git a/service/iotwireless/api_op_GetWirelessGatewayTaskDefinition.go b/service/iotwireless/api_op_GetWirelessGatewayTaskDefinition.go index 9176b06f08d..0d8cffec675 100644 --- a/service/iotwireless/api_op_GetWirelessGatewayTaskDefinition.go +++ b/service/iotwireless/api_op_GetWirelessGatewayTaskDefinition.go @@ -43,8 +43,8 @@ type GetWirelessGatewayTaskDefinitionOutput struct { Arn *string // Whether to automatically create tasks using this task definition for all - // gateways with the specified current version. If false, the task must me created - // by calling CreateWirelessGatewayTask. + // gateways with the specified current version. If false , the task must me created + // by calling CreateWirelessGatewayTask . AutoCreateTasks bool // The name of the resource. diff --git a/service/iotwireless/api_op_ListDeviceProfiles.go b/service/iotwireless/api_op_ListDeviceProfiles.go index baf48eb59ed..80f2674c423 100644 --- a/service/iotwireless/api_op_ListDeviceProfiles.go +++ b/service/iotwireless/api_op_ListDeviceProfiles.go @@ -31,7 +31,7 @@ func (c *Client) ListDeviceProfiles(ctx context.Context, params *ListDeviceProfi type ListDeviceProfilesInput struct { // A filter to list only device profiles that use this type, which can be LoRaWAN - // or Sidewalk. + // or Sidewalk . DeviceProfileType types.DeviceProfileType // The maximum number of results to return in this operation. diff --git a/service/iotwireless/api_op_ListMulticastGroups.go b/service/iotwireless/api_op_ListMulticastGroups.go index 8d6624ac633..d11d8410e5e 100644 --- a/service/iotwireless/api_op_ListMulticastGroups.go +++ b/service/iotwireless/api_op_ListMulticastGroups.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListMulticastGroupsMiddlewares(stack *middleware.St return nil } -// ListMulticastGroupsAPIClient is a client that implements the ListMulticastGroups -// operation. +// ListMulticastGroupsAPIClient is a client that implements the +// ListMulticastGroups operation. type ListMulticastGroupsAPIClient interface { ListMulticastGroups(context.Context, *ListMulticastGroupsInput, ...func(*Options)) (*ListMulticastGroupsOutput, error) } diff --git a/service/iotwireless/api_op_ListPositionConfigurations.go b/service/iotwireless/api_op_ListPositionConfigurations.go index b3905b1f68f..430cb4cadd6 100644 --- a/service/iotwireless/api_op_ListPositionConfigurations.go +++ b/service/iotwireless/api_op_ListPositionConfigurations.go @@ -14,8 +14,7 @@ import ( // List position configurations for a given resource, such as positioning solvers. // This action is no longer supported. Calls to retrieve position information -// should use the GetResourcePosition -// (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) +// should use the GetResourcePosition (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html) // API operation instead. // // Deprecated: This operation is no longer supported. diff --git a/service/iotwireless/api_op_ListServiceProfiles.go b/service/iotwireless/api_op_ListServiceProfiles.go index 0527618eaf8..c7bfd737bbd 100644 --- a/service/iotwireless/api_op_ListServiceProfiles.go +++ b/service/iotwireless/api_op_ListServiceProfiles.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListServiceProfilesMiddlewares(stack *middleware.St return nil } -// ListServiceProfilesAPIClient is a client that implements the ListServiceProfiles -// operation. +// ListServiceProfilesAPIClient is a client that implements the +// ListServiceProfiles operation. type ListServiceProfilesAPIClient interface { ListServiceProfiles(context.Context, *ListServiceProfilesInput, ...func(*Options)) (*ListServiceProfilesOutput, error) } diff --git a/service/iotwireless/api_op_ListTagsForResource.go b/service/iotwireless/api_op_ListTagsForResource.go index 657c17ec7fb..b9318590c84 100644 --- a/service/iotwireless/api_op_ListTagsForResource.go +++ b/service/iotwireless/api_op_ListTagsForResource.go @@ -39,8 +39,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags to attach to the specified resource. Tags are metadata that you can use - // to manage a resource. + // The tags to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/iotwireless/api_op_ListWirelessDevices.go b/service/iotwireless/api_op_ListWirelessDevices.go index cc03c515063..2954f3727e7 100644 --- a/service/iotwireless/api_op_ListWirelessDevices.go +++ b/service/iotwireless/api_op_ListWirelessDevices.go @@ -133,8 +133,8 @@ func (c *Client) addOperationListWirelessDevicesMiddlewares(stack *middleware.St return nil } -// ListWirelessDevicesAPIClient is a client that implements the ListWirelessDevices -// operation. +// ListWirelessDevicesAPIClient is a client that implements the +// ListWirelessDevices operation. type ListWirelessDevicesAPIClient interface { ListWirelessDevices(context.Context, *ListWirelessDevicesInput, ...func(*Options)) (*ListWirelessDevicesOutput, error) } diff --git a/service/iotwireless/api_op_PutPositionConfiguration.go b/service/iotwireless/api_op_PutPositionConfiguration.go index cf891bc6ad0..53be85d19f2 100644 --- a/service/iotwireless/api_op_PutPositionConfiguration.go +++ b/service/iotwireless/api_op_PutPositionConfiguration.go @@ -13,8 +13,7 @@ import ( // Put position configuration for a given resource. This action is no longer // supported. Calls to update the position configuration should use the -// UpdateResourcePosition -// (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html) +// UpdateResourcePosition (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html) // API operation instead. // // Deprecated: This operation is no longer supported. @@ -46,8 +45,8 @@ type PutPositionConfigurationInput struct { // This member is required. ResourceType types.PositionResourceType - // The position data destination that describes the AWS IoT rule that processes the - // device's position data for use by AWS IoT Core for LoRaWAN. + // The position data destination that describes the AWS IoT rule that processes + // the device's position data for use by AWS IoT Core for LoRaWAN. Destination *string // The positioning solvers used to update the position configuration of the diff --git a/service/iotwireless/api_op_PutResourceLogLevel.go b/service/iotwireless/api_op_PutResourceLogLevel.go index de4ba6b4e43..1dda0bdc872 100644 --- a/service/iotwireless/api_op_PutResourceLogLevel.go +++ b/service/iotwireless/api_op_PutResourceLogLevel.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the log-level override for a resource-ID and resource-type. This option can -// be specified for a wireless gateway or a wireless device. A limit of 200 log +// Sets the log-level override for a resource-ID and resource-type. This option +// can be specified for a wireless gateway or a wireless device. A limit of 200 log // level override can be set per account. func (c *Client) PutResourceLogLevel(ctx context.Context, params *PutResourceLogLevelInput, optFns ...func(*Options)) (*PutResourceLogLevelOutput, error) { if params == nil { @@ -38,13 +38,13 @@ type PutResourceLogLevelInput struct { // This member is required. LogLevel types.LogLevel - // The identifier of the resource. For a Wireless Device, it is the wireless device - // ID. For a wireless gateway, it is the wireless gateway ID. + // The identifier of the resource. For a Wireless Device, it is the wireless + // device ID. For a wireless gateway, it is the wireless gateway ID. // // This member is required. ResourceIdentifier *string - // The type of the resource, which can be WirelessDevice or WirelessGateway. + // The type of the resource, which can be WirelessDevice or WirelessGateway . // // This member is required. ResourceType *string diff --git a/service/iotwireless/api_op_ResetResourceLogLevel.go b/service/iotwireless/api_op_ResetResourceLogLevel.go index efab8529cfb..2ce8509cab5 100644 --- a/service/iotwireless/api_op_ResetResourceLogLevel.go +++ b/service/iotwireless/api_op_ResetResourceLogLevel.go @@ -29,13 +29,13 @@ func (c *Client) ResetResourceLogLevel(ctx context.Context, params *ResetResourc type ResetResourceLogLevelInput struct { - // The identifier of the resource. For a Wireless Device, it is the wireless device - // ID. For a wireless gateway, it is the wireless gateway ID. + // The identifier of the resource. For a Wireless Device, it is the wireless + // device ID. For a wireless gateway, it is the wireless gateway ID. // // This member is required. ResourceIdentifier *string - // The type of the resource, which can be WirelessDevice or WirelessGateway. + // The type of the resource, which can be WirelessDevice or WirelessGateway . // // This member is required. ResourceType *string diff --git a/service/iotwireless/api_op_TestWirelessDevice.go b/service/iotwireless/api_op_TestWirelessDevice.go index c58d847f001..ffbe02a9b23 100644 --- a/service/iotwireless/api_op_TestWirelessDevice.go +++ b/service/iotwireless/api_op_TestWirelessDevice.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Simulates a provisioned device by sending an uplink data payload of Hello. +// Simulates a provisioned device by sending an uplink data payload of Hello . func (c *Client) TestWirelessDevice(ctx context.Context, params *TestWirelessDeviceInput, optFns ...func(*Options)) (*TestWirelessDeviceOutput, error) { if params == nil { params = &TestWirelessDeviceInput{} diff --git a/service/iotwireless/api_op_UpdateDestination.go b/service/iotwireless/api_op_UpdateDestination.go index 56f025fbfd8..930398ffc66 100644 --- a/service/iotwireless/api_op_UpdateDestination.go +++ b/service/iotwireless/api_op_UpdateDestination.go @@ -40,7 +40,7 @@ type UpdateDestinationInput struct { // The new rule name or topic rule to send messages to. Expression *string - // The type of value in Expression. + // The type of value in Expression . ExpressionType types.ExpressionType // The ARN of the IAM Role that authorizes the destination. diff --git a/service/iotwireless/api_op_UpdateFuotaTask.go b/service/iotwireless/api_op_UpdateFuotaTask.go index 23a93dbea97..4398372fe42 100644 --- a/service/iotwireless/api_op_UpdateFuotaTask.go +++ b/service/iotwireless/api_op_UpdateFuotaTask.go @@ -51,8 +51,8 @@ type UpdateFuotaTaskInput struct { // delay with the cloud. FragmentIntervalMS *int32 - // The size of each fragment in bytes. Currently only supported in fuota tasks with - // multicast groups. + // The size of each fragment in bytes. Currently only supported in fuota tasks + // with multicast groups. FragmentSizeBytes *int32 // The LoRaWAN information used with a FUOTA task. diff --git a/service/iotwireless/api_op_UpdateLogLevelsByResourceTypes.go b/service/iotwireless/api_op_UpdateLogLevelsByResourceTypes.go index 61aa449ccbc..4ca71c12cbe 100644 --- a/service/iotwireless/api_op_UpdateLogLevelsByResourceTypes.go +++ b/service/iotwireless/api_op_UpdateLogLevelsByResourceTypes.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Set default log level, or log levels by resource types. This can be for wireless -// device log options or wireless gateways log options and is used to control the -// log messages that'll be displayed in CloudWatch. +// Set default log level, or log levels by resource types. This can be for +// wireless device log options or wireless gateways log options and is used to +// control the log messages that'll be displayed in CloudWatch. func (c *Client) UpdateLogLevelsByResourceTypes(ctx context.Context, params *UpdateLogLevelsByResourceTypesInput, optFns ...func(*Options)) (*UpdateLogLevelsByResourceTypesOutput, error) { if params == nil { params = &UpdateLogLevelsByResourceTypesInput{} diff --git a/service/iotwireless/api_op_UpdateNetworkAnalyzerConfiguration.go b/service/iotwireless/api_op_UpdateNetworkAnalyzerConfiguration.go index 29174bd1b79..b4dfb5bb352 100644 --- a/service/iotwireless/api_op_UpdateNetworkAnalyzerConfiguration.go +++ b/service/iotwireless/api_op_UpdateNetworkAnalyzerConfiguration.go @@ -48,8 +48,8 @@ type UpdateNetworkAnalyzerConfigurationInput struct { // Provide the WirelessDeviceId of the resources to remove in the input array. WirelessDevicesToRemove []string - // Wireless gateway resources to add to the network analyzer configuration. Provide - // the WirelessGatewayId of the resource to add in the input array. + // Wireless gateway resources to add to the network analyzer configuration. + // Provide the WirelessGatewayId of the resource to add in the input array. WirelessGatewaysToAdd []string // Wireless gateway resources to remove from the network analyzer configuration. diff --git a/service/iotwireless/api_op_UpdatePosition.go b/service/iotwireless/api_op_UpdatePosition.go index c0f0e82ab6e..7c8fe4804da 100644 --- a/service/iotwireless/api_op_UpdatePosition.go +++ b/service/iotwireless/api_op_UpdatePosition.go @@ -13,8 +13,7 @@ import ( // Update the position information of a resource. This action is no longer // supported. Calls to update the position information should use the -// UpdateResourcePosition -// (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html) +// UpdateResourcePosition (https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html) // API operation instead. // // Deprecated: This operation is no longer supported. diff --git a/service/iotwireless/api_op_UpdateResourcePosition.go b/service/iotwireless/api_op_UpdateResourcePosition.go index 1b8bf80e2fe..4d7061dde42 100644 --- a/service/iotwireless/api_op_UpdateResourcePosition.go +++ b/service/iotwireless/api_op_UpdateResourcePosition.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the position information of a given wireless device or a wireless gateway -// resource. The position coordinates are based on the World Geodetic System -// (WGS84) (https://gisgeography.com/wgs84-world-geodetic-system/). +// Update the position information of a given wireless device or a wireless +// gateway resource. The position coordinates are based on the World Geodetic +// System (WGS84) (https://gisgeography.com/wgs84-world-geodetic-system/) . func (c *Client) UpdateResourcePosition(ctx context.Context, params *UpdateResourcePositionInput, optFns ...func(*Options)) (*UpdateResourcePositionOutput, error) { if params == nil { params = &UpdateResourcePositionInput{} @@ -31,9 +31,9 @@ func (c *Client) UpdateResourcePosition(ctx context.Context, params *UpdateResou type UpdateResourcePositionInput struct { - // The identifier of the resource for which position information is updated. It can - // be the wireless device ID or the wireless gateway ID, depending on the resource - // type. + // The identifier of the resource for which position information is updated. It + // can be the wireless device ID or the wireless gateway ID, depending on the + // resource type. // // This member is required. ResourceIdentifier *string @@ -46,7 +46,7 @@ type UpdateResourcePositionInput struct { // The position information of the resource, displayed as a JSON payload. The // payload uses the GeoJSON format, which a format that's used to encode geographic - // data structures. For more information, see GeoJSON (https://geojson.org/). + // data structures. For more information, see GeoJSON (https://geojson.org/) . GeoJsonPayload []byte noSmithyDocumentSerde diff --git a/service/iotwireless/doc.go b/service/iotwireless/doc.go index 5884ba4e239..9fb4ac0b2d2 100644 --- a/service/iotwireless/doc.go +++ b/service/iotwireless/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package iotwireless provides the API client, operations, and parameter types for -// AWS IoT Wireless. +// Package iotwireless provides the API client, operations, and parameter types +// for AWS IoT Wireless. // // AWS IoT Wireless provides bi-directional communication between // internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN diff --git a/service/iotwireless/types/enums.go b/service/iotwireless/types/enums.go index 82a8cadb7ff..7938dcedc6b 100644 --- a/service/iotwireless/types/enums.go +++ b/service/iotwireless/types/enums.go @@ -9,8 +9,8 @@ const ( ApplicationConfigTypeSemtechGeoLocation ApplicationConfigType = "SemtechGeolocation" ) -// Values returns all known values for ApplicationConfigType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ApplicationConfigType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ApplicationConfigType) Values() []ApplicationConfigType { return []ApplicationConfigType{ @@ -27,9 +27,9 @@ const ( BatteryLevelCritical BatteryLevel = "critical" ) -// Values returns all known values for BatteryLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BatteryLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BatteryLevel) Values() []BatteryLevel { return []BatteryLevel{ "normal", @@ -123,9 +123,9 @@ const ( DownlinkModeUsingUplinkGateway DownlinkMode = "USING_UPLINK_GATEWAY" ) -// Values returns all known values for DownlinkMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DownlinkMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DownlinkMode) Values() []DownlinkMode { return []DownlinkMode{ "SEQUENTIAL", @@ -145,8 +145,8 @@ const ( EventPassthrough Event = "passthrough" ) -// Values returns all known values for Event. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Event. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Event) Values() []Event { return []Event{ @@ -165,9 +165,10 @@ const ( EventNotificationPartnerTypeSidewalk EventNotificationPartnerType = "Sidewalk" ) -// Values returns all known values for EventNotificationPartnerType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EventNotificationPartnerType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (EventNotificationPartnerType) Values() []EventNotificationPartnerType { return []EventNotificationPartnerType{ "Sidewalk", @@ -203,9 +204,10 @@ const ( EventNotificationTopicStatusDisabled EventNotificationTopicStatus = "Disabled" ) -// Values returns all known values for EventNotificationTopicStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EventNotificationTopicStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (EventNotificationTopicStatus) Values() []EventNotificationTopicStatus { return []EventNotificationTopicStatus{ "Enabled", @@ -429,9 +431,9 @@ const ( PositionConfigurationFecNone PositionConfigurationFec = "NONE" ) -// Values returns all known values for PositionConfigurationFec. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PositionConfigurationFec. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionConfigurationFec) Values() []PositionConfigurationFec { return []PositionConfigurationFec{ "ROSE", @@ -657,9 +659,10 @@ const ( WirelessDeviceSidewalkStatusUnknown WirelessDeviceSidewalkStatus = "UNKNOWN" ) -// Values returns all known values for WirelessDeviceSidewalkStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for WirelessDeviceSidewalkStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (WirelessDeviceSidewalkStatus) Values() []WirelessDeviceSidewalkStatus { return []WirelessDeviceSidewalkStatus{ "PROVISIONED", @@ -714,8 +717,8 @@ const ( WirelessGatewayIdTypeThingName WirelessGatewayIdType = "ThingName" ) -// Values returns all known values for WirelessGatewayIdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for WirelessGatewayIdType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayIdType) Values() []WirelessGatewayIdType { return []WirelessGatewayIdType{ @@ -750,8 +753,8 @@ const ( WirelessGatewayTaskDefinitionTypeUpdate WirelessGatewayTaskDefinitionType = "UPDATE" ) -// Values returns all known values for WirelessGatewayTaskDefinitionType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for WirelessGatewayTaskDefinitionType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (WirelessGatewayTaskDefinitionType) Values() []WirelessGatewayTaskDefinitionType { diff --git a/service/iotwireless/types/types.go b/service/iotwireless/types/types.go index fb187f364df..2d309011af9 100644 --- a/service/iotwireless/types/types.go +++ b/service/iotwireless/types/types.go @@ -47,8 +47,8 @@ type Accuracy struct { // between the estimated location and the actual device location. HorizontalAccuracy *float32 - // The vertical accuracy of the estimated position, which is the difference between - // the estimated altitude and actual device latitude in meters. + // The vertical accuracy of the estimated position, which is the difference + // between the estimated altitude and actual device latitude in meters. VerticalAccuracy *float32 noSmithyDocumentSerde @@ -207,8 +207,8 @@ type ConnectionStatusEventConfiguration struct { // related event topics. LoRaWAN *LoRaWANConnectionStatusEventNotificationConfigurations - // Denotes whether the wireless gateway ID connection status event topic is enabled - // or disabled. + // Denotes whether the wireless gateway ID connection status event topic is + // enabled or disabled. WirelessGatewayIdEventTopic EventNotificationTopicStatus noSmithyDocumentSerde @@ -262,7 +262,7 @@ type Destinations struct { // The rule name or topic rule to send messages to. Expression *string - // The type of value in Expression. + // The type of value in Expression . ExpressionType ExpressionType // The name of the resource. @@ -459,8 +459,9 @@ type Gnss struct { // time, specified in meters above the WGS84 reference ellipsoid. AssistAltitude *float32 - // Optional assistance position information, specified using latitude and longitude - // values in degrees. The coordinates are inside the WGS84 reference frame. + // Optional assistance position information, specified using latitude and + // longitude values in degrees. The coordinates are inside the WGS84 reference + // frame. AssistPosition []float32 // Optional parameter that gives an estimate of the time when the GNSS scan @@ -581,8 +582,8 @@ type ImportedSidewalkDevice struct { // Information about a wireless device that has been added to an import task. type ImportedWirelessDevice struct { - // The Sidewalk-related information about a device that has been added to an import - // task. + // The Sidewalk-related information about a device that has been added to an + // import task. Sidewalk *ImportedSidewalkDevice noSmithyDocumentSerde @@ -635,8 +636,8 @@ type LoRaWANConnectionStatusEventNotificationConfigurations struct { // Object for LoRaWAN connection status resource type event configuration. type LoRaWANConnectionStatusResourceTypeEventConfiguration struct { - // Denotes whether the wireless gateway connection status event topic is enabled or - // disabled. + // Denotes whether the wireless gateway connection status event topic is enabled + // or disabled. WirelessGatewayEventTopic EventNotificationTopicStatus noSmithyDocumentSerde @@ -1178,8 +1179,8 @@ type LteObj struct { // relevant topics. type MessageDeliveryStatusEventConfiguration struct { - // SidewalkEventNotificationConfigurations object, which is the event configuration - // object for Sidewalk-related event topics. + // SidewalkEventNotificationConfigurations object, which is the event + // configuration object for Sidewalk-related event topics. Sidewalk *SidewalkEventNotificationConfigurations // Denotes whether the wireless device ID message delivery status event topic is @@ -1189,8 +1190,8 @@ type MessageDeliveryStatusEventConfiguration struct { noSmithyDocumentSerde } -// Message delivery status resource type event configuration object for enabling or -// disabling relevant topic. +// Message delivery status resource type event configuration object for enabling +// or disabling relevant topic. type MessageDeliveryStatusResourceTypeEventConfiguration struct { // Sidewalk resource type event configuration object for enabling or disabling @@ -1303,8 +1304,8 @@ type ParticipatingGateways struct { // The wrapper for a position configuration. type PositionConfigurationItem struct { - // The position data destination that describes the AWS IoT rule that processes the - // device's position data for use by AWS IoT Core for LoRaWAN. + // The position data destination that describes the AWS IoT rule that processes + // the device's position data for use by AWS IoT Core for LoRaWAN. Destination *string // Resource identifier for the position configuration. @@ -1545,8 +1546,8 @@ type SidewalkDeviceMetadata struct { noSmithyDocumentSerde } -// SidewalkEventNotificationConfigurations object, which is the event configuration -// object for Sidewalk-related event topics. +// SidewalkEventNotificationConfigurations object, which is the event +// configuration object for Sidewalk-related event topics. type SidewalkEventNotificationConfigurations struct { // Denotes whether the Amazon ID event topic is enabled or disabled. @@ -1624,7 +1625,7 @@ type SidewalkSendDataToDevice struct { // The duration of time in seconds to retry sending the ACK. AckModeRetryDurationSecs *int32 - // Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY. + // Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY . MessageType MessageType // The sequence number. @@ -1785,9 +1786,9 @@ type TraceContent struct { // more detailed logs. LogLevel LogLevel - // FrameInfo of your wireless device resources for the trace content. Use FrameInfo - // to debug the communication between your LoRaWAN end devices and the network - // server. + // FrameInfo of your wireless device resources for the trace content. Use + // FrameInfo to debug the communication between your LoRaWAN end devices and the + // network server. WirelessDeviceFrameInfo WirelessDeviceFrameInfo noSmithyDocumentSerde @@ -1953,9 +1954,9 @@ type WiFiAccessPoint struct { // The log options for a wireless device event and can be used to set log levels // for a specific wireless device event. For a LoRaWAN device, possible events for -// a log messsage are: Join, Rejoin, Downlink_Data, and Uplink_Data. For a Sidewalk -// device, possible events for a log message are Registration, Downlink_Data, and -// Uplink_Data. +// a log messsage are: Join , Rejoin , Downlink_Data , and Uplink_Data . For a +// Sidewalk device, possible events for a log message are Registration , +// Downlink_Data , and Uplink_Data . type WirelessDeviceEventLogOption struct { // The event for a log message, if the log message is tied to a wireless device. @@ -1998,8 +1999,8 @@ type WirelessDeviceImportTask struct { // control log to be added to an import task. InitializedImportedDeviceCount *int64 - // The summary information of count of wireless devices in an import task that have - // been onboarded to the import task. + // The summary information of count of wireless devices in an import task that + // have been onboarded to the import task. OnboardedImportedDeviceCount *int64 // The summary information of count of wireless devices in an import task that are @@ -2081,7 +2082,7 @@ type WirelessDeviceStatistics struct { // The log options for a wireless gateway event and can be used to set log levels // for a specific wireless gateway event. For a LoRaWAN gateway, possible events -// for a log message are CUPS_Request and Certificate. +// for a log message are CUPS_Request and Certificate . type WirelessGatewayEventLogOption struct { // The event for a log message, if the log message is tied to a wireless gateway. diff --git a/service/ivs/api_client.go b/service/ivs/api_client.go index 2d6ad181f94..5420b2bc8f1 100644 --- a/service/ivs/api_client.go +++ b/service/ivs/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ivs/api_op_CreateChannel.go b/service/ivs/api_op_CreateChannel.go index 9b69bd70f08..44d65ab0b6a 100644 --- a/service/ivs/api_op_CreateChannel.go +++ b/service/ivs/api_op_CreateChannel.go @@ -30,16 +30,16 @@ func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, type CreateChannelInput struct { // Whether the channel is private (enabled for playback authorization). Default: - // false. + // false . Authorized bool - // Whether the channel allows insecure RTMP ingest. Default: false. + // Whether the channel allows insecure RTMP ingest. Default: false . InsecureIngest bool // Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full // HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon - // IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) - // Default: LOW. + // IVS console, LOW and NORMAL correspond to Ultra-low and Standard, + // respectively.) Default: LOW . LatencyMode types.ChannelLatencyMode // Channel name. @@ -48,30 +48,26 @@ type CreateChannelInput struct { // Recording-configuration ARN. Default: "" (empty string, recording is disabled). RecordingConfigurationArn *string - // Array of 1-50 maps, each of the form string:string (key:value). See Tagging - // Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // Array of 1-50 maps, each of the form string:string (key:value) . See Tagging + // Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable resolution or bitrate, the stream probably will disconnect - // immediately. Default: STANDARD. Valid values: - // - // * STANDARD: Video is transcoded: - // multiple qualities are generated from the original input, to automatically give - // viewers the best experience for their devices and network conditions. - // Transcoding allows higher playback quality across a range of download speeds. - // Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is - // transcoded only for renditions 360p and below; above that, audio is passed - // through. This is the default. - // - // * BASIC: Video is transmuxed: Amazon IVS delivers - // the original input to viewers. The viewer’s video-quality choice is limited to - // the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 - // Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. + // immediately. Default: STANDARD . Valid values: + // - STANDARD : Video is transcoded: multiple qualities are generated from the + // original input, to automatically give viewers the best experience for their + // devices and network conditions. Transcoding allows higher playback quality + // across a range of download speeds. Resolution can be up to 1080p and bitrate can + // be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above + // that, audio is passed through. This is the default. + // - BASIC : Video is transmuxed: Amazon IVS delivers the original input to + // viewers. The viewer’s video-quality choice is limited to the original input. + // Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up + // to 3.5 Mbps for resolutions between 480p and 1080p. Type types.ChannelType noSmithyDocumentSerde diff --git a/service/ivs/api_op_CreateRecordingConfiguration.go b/service/ivs/api_op_CreateRecordingConfiguration.go index 8e06a93a66e..ee6d60667c9 100644 --- a/service/ivs/api_op_CreateRecordingConfiguration.go +++ b/service/ivs/api_op_CreateRecordingConfiguration.go @@ -15,7 +15,7 @@ import ( // Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to // create a recording configuration, it returns success even if the S3 bucket is in // a different region. In this case, the state of the recording configuration is -// CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns +// CREATE_FAILED (instead of ACTIVE ). (In other regions, the CLI correctly returns // failure if the bucket is in a different region.) Workaround: Ensure that your S3 // bucket is in the same region as the recording configuration. If you create a // recording configuration in a different region as your S3 bucket, delete that @@ -52,17 +52,16 @@ type CreateRecordingConfigurationInput struct { // Default: 0. RecordingReconnectWindowSeconds int32 - // Array of 1-50 maps, each of the form string:string (key:value). See Tagging - // Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // Array of 1-50 maps, each of the form string:string (key:value) . See Tagging + // Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string - // A complex type that allows you to enable/disable the recording of thumbnails for - // a live session and modify the interval at which thumbnails are generated for the - // live session. + // A complex type that allows you to enable/disable the recording of thumbnails + // for a live session and modify the interval at which thumbnails are generated for + // the live session. ThumbnailConfiguration *types.ThumbnailConfiguration noSmithyDocumentSerde diff --git a/service/ivs/api_op_CreateStreamKey.go b/service/ivs/api_op_CreateStreamKey.go index d39762ffee4..e90beafe93a 100644 --- a/service/ivs/api_op_CreateStreamKey.go +++ b/service/ivs/api_op_CreateStreamKey.go @@ -38,12 +38,11 @@ type CreateStreamKeyInput struct { // This member is required. ChannelArn *string - // Array of 1-50 maps, each of the form string:string (key:value). See Tagging - // Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // Array of 1-50 maps, each of the form string:string (key:value) . See Tagging + // Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivs/api_op_DeleteChannel.go b/service/ivs/api_op_DeleteChannel.go index 49775c13908..8095a1df4a4 100644 --- a/service/ivs/api_op_DeleteChannel.go +++ b/service/ivs/api_op_DeleteChannel.go @@ -12,10 +12,10 @@ import ( // Deletes the specified channel and its associated stream keys. If you try to // delete a live channel, you will get an error (409 ConflictException). To delete -// a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream -// End" event (to verify that the stream's state is no longer Live), then call -// DeleteChannel. (See Using EventBridge with Amazon IVS -// (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html).) +// a channel that is live, call StopStream , wait for the Amazon EventBridge +// "Stream End" event (to verify that the stream's state is no longer Live), then +// call DeleteChannel. (See Using EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html) +// .) func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error) { if params == nil { params = &DeleteChannelInput{} diff --git a/service/ivs/api_op_DeletePlaybackKeyPair.go b/service/ivs/api_op_DeletePlaybackKeyPair.go index d9f2ec9d049..0ce0d6b97f0 100644 --- a/service/ivs/api_op_DeletePlaybackKeyPair.go +++ b/service/ivs/api_op_DeletePlaybackKeyPair.go @@ -11,10 +11,9 @@ import ( ) // Deletes a specified authorization key pair. This invalidates future viewer -// tokens generated using the key pair’s privateKey. For more information, see -// Setting Up Private Channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the -// Amazon IVS User Guide. +// tokens generated using the key pair’s privateKey . For more information, see +// Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. func (c *Client) DeletePlaybackKeyPair(ctx context.Context, params *DeletePlaybackKeyPairInput, optFns ...func(*Options)) (*DeletePlaybackKeyPairOutput, error) { if params == nil { params = &DeletePlaybackKeyPairInput{} diff --git a/service/ivs/api_op_GetChannel.go b/service/ivs/api_op_GetChannel.go index ba52b69e7bf..95cab1be139 100644 --- a/service/ivs/api_op_GetChannel.go +++ b/service/ivs/api_op_GetChannel.go @@ -12,7 +12,7 @@ import ( ) // Gets the channel configuration for the specified channel ARN. See also -// BatchGetChannel. +// BatchGetChannel . func (c *Client) GetChannel(ctx context.Context, params *GetChannelInput, optFns ...func(*Options)) (*GetChannelOutput, error) { if params == nil { params = &GetChannelInput{} diff --git a/service/ivs/api_op_GetPlaybackKeyPair.go b/service/ivs/api_op_GetPlaybackKeyPair.go index 2f36bc7e9a8..6501cf0d276 100644 --- a/service/ivs/api_op_GetPlaybackKeyPair.go +++ b/service/ivs/api_op_GetPlaybackKeyPair.go @@ -12,11 +12,10 @@ import ( ) // Gets a specified playback authorization key pair and returns the arn and -// fingerprint. The privateKey held by the caller can be used to generate viewer +// fingerprint . The privateKey held by the caller can be used to generate viewer // authorization tokens, to grant viewers access to private channels. For more -// information, see Setting Up Private Channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the -// Amazon IVS User Guide. +// information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. func (c *Client) GetPlaybackKeyPair(ctx context.Context, params *GetPlaybackKeyPairInput, optFns ...func(*Options)) (*GetPlaybackKeyPairOutput, error) { if params == nil { params = &GetPlaybackKeyPairInput{} diff --git a/service/ivs/api_op_GetStreamSession.go b/service/ivs/api_op_GetStreamSession.go index 36ebee0c715..7efe09be588 100644 --- a/service/ivs/api_op_GetStreamSession.go +++ b/service/ivs/api_op_GetStreamSession.go @@ -34,9 +34,9 @@ type GetStreamSessionInput struct { // This member is required. ChannelArn *string - // Unique identifier for a live or previously live stream in the specified channel. - // If no streamId is provided, this returns the most recent stream session for the - // channel, if it exists. + // Unique identifier for a live or previously live stream in the specified + // channel. If no streamId is provided, this returns the most recent stream + // session for the channel, if it exists. StreamId *string noSmithyDocumentSerde diff --git a/service/ivs/api_op_ImportPlaybackKeyPair.go b/service/ivs/api_op_ImportPlaybackKeyPair.go index 6c187761235..f05781128e1 100644 --- a/service/ivs/api_op_ImportPlaybackKeyPair.go +++ b/service/ivs/api_op_ImportPlaybackKeyPair.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Imports the public portion of a new key pair and returns its arn and -// fingerprint. The privateKey can then be used to generate viewer authorization -// tokens, to grant viewers access to private channels. For more information, see -// Setting Up Private Channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the -// Amazon IVS User Guide. +// Imports the public portion of a new key pair and returns its arn and fingerprint +// . The privateKey can then be used to generate viewer authorization tokens, to +// grant viewers access to private channels. For more information, see Setting Up +// Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. func (c *Client) ImportPlaybackKeyPair(ctx context.Context, params *ImportPlaybackKeyPairInput, optFns ...func(*Options)) (*ImportPlaybackKeyPairOutput, error) { if params == nil { params = &ImportPlaybackKeyPairInput{} @@ -43,11 +42,10 @@ type ImportPlaybackKeyPairInput struct { Name *string // Any tags provided with the request are added to the playback key pair tags. See - // Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivs/api_op_ListChannels.go b/service/ivs/api_op_ListChannels.go index be0f87f7141..127a580af32 100644 --- a/service/ivs/api_op_ListChannels.go +++ b/service/ivs/api_op_ListChannels.go @@ -57,8 +57,8 @@ type ListChannelsOutput struct { // This member is required. Channels []types.ChannelSummary - // If there are more channels than maxResults, use nextToken in the request to get - // the next set. + // If there are more channels than maxResults , use nextToken in the request to + // get the next set. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ivs/api_op_ListPlaybackKeyPairs.go b/service/ivs/api_op_ListPlaybackKeyPairs.go index 72bf0f47cc3..eef2188370c 100644 --- a/service/ivs/api_op_ListPlaybackKeyPairs.go +++ b/service/ivs/api_op_ListPlaybackKeyPairs.go @@ -13,9 +13,8 @@ import ( ) // Gets summary information about playback key pairs. For more information, see -// Setting Up Private Channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the -// Amazon IVS User Guide. +// Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. func (c *Client) ListPlaybackKeyPairs(ctx context.Context, params *ListPlaybackKeyPairsInput, optFns ...func(*Options)) (*ListPlaybackKeyPairsOutput, error) { if params == nil { params = &ListPlaybackKeyPairsInput{} @@ -51,8 +50,8 @@ type ListPlaybackKeyPairsOutput struct { // This member is required. KeyPairs []types.PlaybackKeyPairSummary - // If there are more key pairs than maxResults, use nextToken in the request to get - // the next set. + // If there are more key pairs than maxResults , use nextToken in the request to + // get the next set. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ivs/api_op_ListRecordingConfigurations.go b/service/ivs/api_op_ListRecordingConfigurations.go index 043ff447607..6b3c53154fd 100644 --- a/service/ivs/api_op_ListRecordingConfigurations.go +++ b/service/ivs/api_op_ListRecordingConfigurations.go @@ -49,8 +49,8 @@ type ListRecordingConfigurationsOutput struct { // This member is required. RecordingConfigurations []types.RecordingConfigurationSummary - // If there are more recording configurations than maxResults, use nextToken in the - // request to get the next set. + // If there are more recording configurations than maxResults , use nextToken in + // the request to get the next set. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ivs/api_op_ListStreamKeys.go b/service/ivs/api_op_ListStreamKeys.go index 49ac90cdb32..e37c979eb2e 100644 --- a/service/ivs/api_op_ListStreamKeys.go +++ b/service/ivs/api_op_ListStreamKeys.go @@ -52,7 +52,7 @@ type ListStreamKeysOutput struct { // This member is required. StreamKeys []types.StreamKeySummary - // If there are more stream keys than maxResults, use nextToken in the request to + // If there are more stream keys than maxResults , use nextToken in the request to // get the next set. NextToken *string diff --git a/service/ivs/api_op_ListStreamSessions.go b/service/ivs/api_op_ListStreamSessions.go index ad7218c27da..f4f52ac8880 100644 --- a/service/ivs/api_op_ListStreamSessions.go +++ b/service/ivs/api_op_ListStreamSessions.go @@ -53,7 +53,7 @@ type ListStreamSessionsOutput struct { // This member is required. StreamSessions []types.StreamSessionSummary - // If there are more streams than maxResults, use nextToken in the request to get + // If there are more streams than maxResults , use nextToken in the request to get // the next set. NextToken *string diff --git a/service/ivs/api_op_ListStreams.go b/service/ivs/api_op_ListStreams.go index 2759ff8c8cc..68b3dae7b39 100644 --- a/service/ivs/api_op_ListStreams.go +++ b/service/ivs/api_op_ListStreams.go @@ -51,7 +51,7 @@ type ListStreamsOutput struct { // This member is required. Streams []types.StreamSummary - // If there are more streams than maxResults, use nextToken in the request to get + // If there are more streams than maxResults , use nextToken in the request to get // the next set. NextToken *string diff --git a/service/ivs/api_op_ListTagsForResource.go b/service/ivs/api_op_ListTagsForResource.go index 373f55da9a0..2fedd0c8483 100644 --- a/service/ivs/api_op_ListTagsForResource.go +++ b/service/ivs/api_op_ListTagsForResource.go @@ -39,7 +39,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . // // This member is required. Tags map[string]string diff --git a/service/ivs/api_op_PutMetadata.go b/service/ivs/api_op_PutMetadata.go index 7999af940fb..7fac7523184 100644 --- a/service/ivs/api_op_PutMetadata.go +++ b/service/ivs/api_op_PutMetadata.go @@ -14,9 +14,8 @@ import ( // requests per second per channel are allowed, each with a maximum 1 KB payload. // (If 5 TPS is not sufficient for your needs, we recommend batching your data into // a single PutMetadata call.) At most 155 requests per second per account are -// allowed. Also see Embedding Metadata within a Video Stream -// (https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html) in the Amazon -// IVS User Guide. +// allowed. Also see Embedding Metadata within a Video Stream (https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html) +// in the Amazon IVS User Guide. func (c *Client) PutMetadata(ctx context.Context, params *PutMetadataInput, optFns ...func(*Options)) (*PutMetadataOutput, error) { if params == nil { params = &PutMetadataInput{} diff --git a/service/ivs/api_op_StopStream.go b/service/ivs/api_op_StopStream.go index 603d2d7c765..2a6deccf0e9 100644 --- a/service/ivs/api_op_StopStream.go +++ b/service/ivs/api_op_StopStream.go @@ -11,8 +11,8 @@ import ( ) // Disconnects the incoming RTMPS stream for the specified channel. Can be used in -// conjunction with DeleteStreamKey to prevent further streaming to a channel. Many -// streaming client-software libraries automatically reconnect a dropped RTMPS +// conjunction with DeleteStreamKey to prevent further streaming to a channel. +// Many streaming client-software libraries automatically reconnect a dropped RTMPS // session, so to stop the stream permanently, you may want to first revoke the // streamKey attached to the channel. func (c *Client) StopStream(ctx context.Context, params *StopStreamInput, optFns ...func(*Options)) (*StopStreamOutput, error) { diff --git a/service/ivs/api_op_TagResource.go b/service/ivs/api_op_TagResource.go index 4db8f2c83e9..6649d7a7d35 100644 --- a/service/ivs/api_op_TagResource.go +++ b/service/ivs/api_op_TagResource.go @@ -36,11 +36,10 @@ type TagResourceInput struct { ResourceArn *string // Array of tags to be added or updated. Array of maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. // // This member is required. Tags map[string]string diff --git a/service/ivs/api_op_UntagResource.go b/service/ivs/api_op_UntagResource.go index 29052acc3e0..5b89adf3912 100644 --- a/service/ivs/api_op_UntagResource.go +++ b/service/ivs/api_op_UntagResource.go @@ -34,12 +34,11 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // Array of tags to be removed. Array of maps, each of the form string:string - // (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // Array of tags to be removed. Array of maps, each of the form s tring:string + // (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. // // This member is required. TagKeys []string diff --git a/service/ivs/api_op_UpdateChannel.go b/service/ivs/api_op_UpdateChannel.go index 7f126b55ac1..b8d5d4c90c0 100644 --- a/service/ivs/api_op_UpdateChannel.go +++ b/service/ivs/api_op_UpdateChannel.go @@ -39,7 +39,7 @@ type UpdateChannelInput struct { // Whether the channel is private (enabled for playback authorization). Authorized bool - // Whether the channel allows insecure RTMP ingest. Default: false. + // Whether the channel allows insecure RTMP ingest. Default: false . InsecureIngest bool // Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full @@ -57,19 +57,16 @@ type UpdateChannelInput struct { // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable resolution or bitrate, the stream probably will disconnect // immediately. Valid values: - // - // * STANDARD: Video is transcoded: multiple qualities - // are generated from the original input, to automatically give viewers the best - // experience for their devices and network conditions. Transcoding allows higher - // playback quality across a range of download speeds. Resolution can be up to - // 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions - // 360p and below; above that, audio is passed through. This is the default. - // - // * - // BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. - // The viewer’s video-quality choice is limited to the original input. Resolution - // can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps - // for resolutions between 480p and 1080p. + // - STANDARD : Video is transcoded: multiple qualities are generated from the + // original input, to automatically give viewers the best experience for their + // devices and network conditions. Transcoding allows higher playback quality + // across a range of download speeds. Resolution can be up to 1080p and bitrate can + // be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above + // that, audio is passed through. This is the default. + // - BASIC : Video is transmuxed: Amazon IVS delivers the original input to + // viewers. The viewer’s video-quality choice is limited to the original input. + // Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up + // to 3.5 Mbps for resolutions between 480p and 1080p. Type types.ChannelType noSmithyDocumentSerde diff --git a/service/ivs/doc.go b/service/ivs/doc.go index 5147e9584bf..6065082a931 100644 --- a/service/ivs/doc.go +++ b/service/ivs/doc.go @@ -7,219 +7,147 @@ // using a standard HTTP API and an Amazon Web Services EventBridge event stream // for responses. JSON is used for both requests and responses, including errors. // The API is an Amazon Web Services regional service. For a list of supported -// regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page -// (https://docs.aws.amazon.com/general/latest/gr/ivs.html) in the Amazon Web -// Services General Reference. All API request parameters and URLs are case -// sensitive. For a summary of notable documentation changes in each release, see -// Document History -// (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html). Allowed -// Header Values -// -// * Accept: application/json -// -// * Accept-Encoding: gzip, deflate -// -// * -// Content-Type: application/json -// -// Resources The following resources contain -// information about your IVS live stream (see Getting Started with Amazon IVS -// (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html)): -// -// * -// Channel — Stores configuration data related to your live stream. You first -// create a channel and then use the channel’s stream key to start your live -// stream. See the Channel endpoints for more information. -// -// * Stream key — An -// identifier assigned by Amazon IVS when you create a channel, which is then used -// to authorize streaming. See the StreamKey endpoints for more information. Treat -// the stream key like a secret, since it allows anyone to stream to the -// channel. -// -// * Playback key pair — Video playback may be restricted using -// playback-authorization tokens, which use public-key encryption. A playback key -// pair is the public-private pair of keys used to sign and validate the -// playback-authorization token. See the PlaybackKeyPair endpoints for more -// information. -// -// * Recording configuration — Stores configuration related to -// recording a live stream and where to store the recorded content. Multiple -// channels can reference the same recording configuration. See the Recording -// Configuration endpoints for more information. -// -// Tagging A tag is a metadata label -// that you assign to an Amazon Web Services resource. A tag comprises a key and a -// value, both set by you. For example, you might set a tag as topic:nature to -// label a particular video category. See Tagging Amazon Web Services Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more -// information, including restrictions that apply to tags and "Tag naming limits -// and requirements"; Amazon IVS has no service-specific constraints beyond what is -// documented there. Tags can help you identify and organize your Amazon Web -// Services resources. For example, you can use the same tag for different +// regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page (https://docs.aws.amazon.com/general/latest/gr/ivs.html) +// in the Amazon Web Services General Reference. All API request parameters and +// URLs are case sensitive. For a summary of notable documentation changes in each +// release, see Document History (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html) +// . Allowed Header Values +// - Accept: application/json +// - Accept-Encoding: gzip, deflate +// - Content-Type: application/json +// +// Resources The following resources contain information about your IVS live +// stream (see Getting Started with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html) +// ): +// - Channel — Stores configuration data related to your live stream. You first +// create a channel and then use the channel’s stream key to start your live +// stream. See the Channel endpoints for more information. +// - Stream key — An identifier assigned by Amazon IVS when you create a +// channel, which is then used to authorize streaming. See the StreamKey endpoints +// for more information. Treat the stream key like a secret, since it allows anyone +// to stream to the channel. +// - Playback key pair — Video playback may be restricted using +// playback-authorization tokens, which use public-key encryption. A playback key +// pair is the public-private pair of keys used to sign and validate the +// playback-authorization token. See the PlaybackKeyPair endpoints for more +// information. +// - Recording configuration — Stores configuration related to recording a live +// stream and where to store the recorded content. Multiple channels can reference +// the same recording configuration. See the Recording Configuration endpoints for +// more information. +// +// Tagging A tag is a metadata label that you assign to an Amazon Web Services +// resource. A tag comprises a key and a value, both set by you. For example, you +// might set a tag as topic:nature to label a particular video category. See +// Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// for more information, including restrictions that apply to tags and "Tag naming +// limits and requirements"; Amazon IVS has no service-specific constraints beyond +// what is documented there. Tags can help you identify and organize your Amazon +// Web Services resources. For example, you can use the same tag for different // resources to indicate that they are related. You can also use tags to manage -// access (see Access Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). The Amazon -// IVS API has these tag-related endpoints: TagResource, UntagResource, and -// ListTagsForResource. The following resources support tagging: Channels, Stream -// Keys, Playback Key Pairs, and Recording Configurations. At most 50 tags can be -// applied to a resource. Authentication versus Authorization Note the differences -// between these concepts: -// -// * Authentication is about verifying identity. You need -// to be authenticated to sign Amazon IVS API requests. -// -// * Authorization is about -// granting permissions. Your IAM roles need to have permissions for Amazon IVS API -// requests. In addition, authorization is needed to view Amazon IVS private -// channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html). -// (Private channels are channels that are enabled for "playback -// authorization.") -// -// Authentication All Amazon IVS API requests must be -// authenticated with a signature. The Amazon Web Services Command-Line Interface -// (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls -// for you. However, if your application calls the Amazon IVS API directly, it’s -// your responsibility to sign the requests. You generate a signature using valid -// Amazon Web Services credentials that have permission to perform the requested -// action. For example, you must sign PutMetadata requests with a signature -// generated from a user account that has the ivs:PutMetadata permission. For more -// information: -// -// * Authentication and generating signatures — See Authenticating -// Requests (Amazon Web Services Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) -// in the Amazon Web Services General Reference. -// -// * Managing Amazon IVS permissions -// — See Identity and Access Management -// (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) on the -// Security page of the Amazon IVS User Guide. -// -// Amazon Resource Names (ARNs) ARNs -// uniquely identify AWS resources. An ARN is required when you need to specify a -// resource unambiguously across all of AWS, such as in IAM policies and API calls. -// For more information, see Amazon Resource Names -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the AWS General Reference. Channel Endpoints -// -// * CreateChannel — Creates a new -// channel and an associated stream key to start streaming. -// -// * GetChannel — Gets -// the channel configuration for the specified channel ARN. -// -// * BatchGetChannel — -// Performs GetChannel on multiple ARNs simultaneously. -// -// * ListChannels — Gets -// summary information about all channels in your account, in the Amazon Web -// Services region where the API request is processed. This list can be filtered to -// match a specified name or recording-configuration ARN. Filters are mutually -// exclusive and cannot be used together. If you try to use both filters, you will -// get an error (409 Conflict Exception). -// -// * UpdateChannel — Updates a channel's -// configuration. This does not affect an ongoing stream of this channel. You must -// stop and restart the stream for the changes to take effect. -// -// * DeleteChannel — -// Deletes the specified channel. -// -// # StreamKey Endpoints -// -// * CreateStreamKey — Creates -// a stream key, used to initiate a stream, for the specified channel ARN. -// -// * -// GetStreamKey — Gets stream key information for the specified ARN. -// -// * -// BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously. -// -// * -// ListStreamKeys — Gets summary information about stream keys for the specified -// channel. -// -// * DeleteStreamKey — Deletes the stream key for the specified ARN, so -// it can no longer be used to stream. -// -// # Stream Endpoints -// -// * GetStream — Gets -// information about the active (live) stream on a specified channel. -// -// * -// GetStreamSession — Gets metadata on a specified stream. -// -// * ListStreams — Gets -// summary information about live streams in your account, in the Amazon Web -// Services region where the API request is processed. -// -// * ListStreamSessions — Gets -// a summary of current and previous streams for a specified channel in your -// account, in the AWS region where the API request is processed. -// -// * StopStream — -// Disconnects the incoming RTMPS stream for the specified channel. Can be used in -// conjunction with DeleteStreamKey to prevent further streaming to a channel. -// -// * -// PutMetadata — Inserts metadata into the active stream of the specified channel. -// At most 5 requests per second per channel are allowed, each with a maximum 1 KB -// payload. (If 5 TPS is not sufficient for your needs, we recommend batching your -// data into a single PutMetadata call.) At most 155 requests per second per -// account are allowed. -// -// PlaybackKeyPair Endpoints For more information, see -// Setting Up Private Channels -// (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the -// Amazon IVS User Guide. -// -// * ImportPlaybackKeyPair — Imports the public portion of -// a new key pair and returns its arn and fingerprint. The privateKey can then be -// used to generate viewer authorization tokens, to grant viewers access to private -// channels (channels enabled for playback authorization). -// -// * GetPlaybackKeyPair — -// Gets a specified playback authorization key pair and returns the arn and -// fingerprint. The privateKey held by the caller can be used to generate viewer -// authorization tokens, to grant viewers access to private channels. -// -// * -// ListPlaybackKeyPairs — Gets summary information about playback key pairs. -// -// * -// DeletePlaybackKeyPair — Deletes a specified authorization key pair. This -// invalidates future viewer tokens generated using the key pair’s -// privateKey. -// -// # RecordingConfiguration Endpoints -// -// * CreateRecordingConfiguration — -// Creates a new recording configuration, used to enable recording to Amazon S3. -// -// * -// GetRecordingConfiguration — Gets the recording-configuration metadata for the -// specified ARN. -// -// * ListRecordingConfigurations — Gets summary information about -// all recording configurations in your account, in the Amazon Web Services region -// where the API request is processed. -// -// * DeleteRecordingConfiguration — Deletes -// the recording configuration for the specified ARN. -// -// Amazon Web Services Tags -// Endpoints -// -// * TagResource — Adds or updates tags for the Amazon Web Services -// resource with the specified ARN. -// -// * UntagResource — Removes tags from the -// resource with the specified ARN. -// -// * ListTagsForResource — Gets information about -// Amazon Web Services tags for the specified ARN. +// access (see Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// ). The Amazon IVS API has these tag-related endpoints: TagResource , +// UntagResource , and ListTagsForResource . The following resources support +// tagging: Channels, Stream Keys, Playback Key Pairs, and Recording +// Configurations. At most 50 tags can be applied to a resource. Authentication +// versus Authorization Note the differences between these concepts: +// - Authentication is about verifying identity. You need to be authenticated to +// sign Amazon IVS API requests. +// - Authorization is about granting permissions. Your IAM roles need to have +// permissions for Amazon IVS API requests. In addition, authorization is needed to +// view Amazon IVS private channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// . (Private channels are channels that are enabled for "playback authorization.") +// +// Authentication All Amazon IVS API requests must be authenticated with a +// signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS +// Player SDKs take care of signing the underlying API calls for you. However, if +// your application calls the Amazon IVS API directly, it’s your responsibility to +// sign the requests. You generate a signature using valid Amazon Web Services +// credentials that have permission to perform the requested action. For example, +// you must sign PutMetadata requests with a signature generated from a user +// account that has the ivs:PutMetadata permission. For more information: +// - Authentication and generating signatures — See Authenticating Requests +// (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// in the Amazon Web Services General Reference. +// - Managing Amazon IVS permissions — See Identity and Access Management (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) +// on the Security page of the Amazon IVS User Guide. +// +// Amazon Resource Names (ARNs) ARNs uniquely identify AWS resources. An ARN is +// required when you need to specify a resource unambiguously across all of AWS, +// such as in IAM policies and API calls. For more information, see Amazon +// Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the AWS General Reference. Channel Endpoints +// - CreateChannel — Creates a new channel and an associated stream key to start +// streaming. +// - GetChannel — Gets the channel configuration for the specified channel ARN. +// - BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously. +// - ListChannels — Gets summary information about all channels in your account, +// in the Amazon Web Services region where the API request is processed. This list +// can be filtered to match a specified name or recording-configuration ARN. +// Filters are mutually exclusive and cannot be used together. If you try to use +// both filters, you will get an error (409 Conflict Exception). +// - UpdateChannel — Updates a channel's configuration. This does not affect an +// ongoing stream of this channel. You must stop and restart the stream for the +// changes to take effect. +// - DeleteChannel — Deletes the specified channel. +// +// StreamKey Endpoints +// - CreateStreamKey — Creates a stream key, used to initiate a stream, for the +// specified channel ARN. +// - GetStreamKey — Gets stream key information for the specified ARN. +// - BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously. +// - ListStreamKeys — Gets summary information about stream keys for the +// specified channel. +// - DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no +// longer be used to stream. +// +// Stream Endpoints +// - GetStream — Gets information about the active (live) stream on a specified +// channel. +// - GetStreamSession — Gets metadata on a specified stream. +// - ListStreams — Gets summary information about live streams in your account, +// in the Amazon Web Services region where the API request is processed. +// - ListStreamSessions — Gets a summary of current and previous streams for a +// specified channel in your account, in the AWS region where the API request is +// processed. +// - StopStream — Disconnects the incoming RTMPS stream for the specified +// channel. Can be used in conjunction with DeleteStreamKey to prevent further +// streaming to a channel. +// - PutMetadata — Inserts metadata into the active stream of the specified +// channel. At most 5 requests per second per channel are allowed, each with a +// maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend +// batching your data into a single PutMetadata call.) At most 155 requests per +// second per account are allowed. +// +// PlaybackKeyPair Endpoints For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. +// - ImportPlaybackKeyPair — Imports the public portion of a new key pair and +// returns its arn and fingerprint . The privateKey can then be used to generate +// viewer authorization tokens, to grant viewers access to private channels +// (channels enabled for playback authorization). +// - GetPlaybackKeyPair — Gets a specified playback authorization key pair and +// returns the arn and fingerprint . The privateKey held by the caller can be +// used to generate viewer authorization tokens, to grant viewers access to private +// channels. +// - ListPlaybackKeyPairs — Gets summary information about playback key pairs. +// - DeletePlaybackKeyPair — Deletes a specified authorization key pair. This +// invalidates future viewer tokens generated using the key pair’s privateKey . +// +// RecordingConfiguration Endpoints +// - CreateRecordingConfiguration — Creates a new recording configuration, used +// to enable recording to Amazon S3. +// - GetRecordingConfiguration — Gets the recording-configuration metadata for +// the specified ARN. +// - ListRecordingConfigurations — Gets summary information about all recording +// configurations in your account, in the Amazon Web Services region where the API +// request is processed. +// - DeleteRecordingConfiguration — Deletes the recording configuration for the +// specified ARN. +// +// Amazon Web Services Tags Endpoints +// - TagResource — Adds or updates tags for the Amazon Web Services resource with +// the specified ARN. +// - UntagResource — Removes tags from the resource with the specified ARN. +// - ListTagsForResource — Gets information about Amazon Web Services tags for +// the specified ARN. package ivs diff --git a/service/ivs/types/enums.go b/service/ivs/types/enums.go index f8c467757bf..34597872ca8 100644 --- a/service/ivs/types/enums.go +++ b/service/ivs/types/enums.go @@ -85,9 +85,9 @@ const ( StreamHealthUnknown StreamHealth = "UNKNOWN" ) -// Values returns all known values for StreamHealth. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StreamHealth. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StreamHealth) Values() []StreamHealth { return []StreamHealth{ "HEALTHY", diff --git a/service/ivs/types/types.go b/service/ivs/types/types.go index 49f1eeb9031..e7959fc28ea 100644 --- a/service/ivs/types/types.go +++ b/service/ivs/types/types.go @@ -8,8 +8,8 @@ import ( ) // Object specifying a stream’s audio configuration, as set up by the broadcaster -// (usually in an encoder). This is part of the IngestConfiguration object and used -// for monitoring stream health. +// (usually in an encoder). This is part of the IngestConfiguration object and +// used for monitoring stream health. type AudioConfiguration struct { // Number of audio channels. @@ -50,19 +50,19 @@ type Channel struct { Arn *string // Whether the channel is private (enabled for playback authorization). Default: - // false. + // false . Authorized bool // Channel ingest endpoint, part of the definition of an ingest server, used when // you set up streaming software. IngestEndpoint *string - // Whether the channel allows insecure RTMP ingest. Default: false. + // Whether the channel allows insecure RTMP ingest. Default: false . InsecureIngest bool // Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full - // HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In - // the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, + // HD. Use LOW for near-real-time interaction with viewers. Default: LOW . (Note: + // In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, // respectively.) LatencyMode ChannelLatencyMode @@ -77,29 +77,25 @@ type Channel struct { RecordingConfigurationArn *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable resolution or bitrate, the stream probably will disconnect - // immediately. Default: STANDARD. Valid values: - // - // * STANDARD: Video is transcoded: - // multiple qualities are generated from the original input, to automatically give - // viewers the best experience for their devices and network conditions. - // Transcoding allows higher playback quality across a range of download speeds. - // Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is - // transcoded only for renditions 360p and below; above that, audio is passed - // through. This is the default. - // - // * BASIC: Video is transmuxed: Amazon IVS delivers - // the original input to viewers. The viewer’s video-quality choice is limited to - // the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 - // Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. + // immediately. Default: STANDARD . Valid values: + // - STANDARD : Video is transcoded: multiple qualities are generated from the + // original input, to automatically give viewers the best experience for their + // devices and network conditions. Transcoding allows higher playback quality + // across a range of download speeds. Resolution can be up to 1080p and bitrate can + // be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above + // that, audio is passed through. This is the default. + // - BASIC : Video is transmuxed: Amazon IVS delivers the original input to + // viewers. The viewer’s video-quality choice is limited to the original input. + // Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up + // to 3.5 Mbps for resolutions between 480p and 1080p. Type ChannelType noSmithyDocumentSerde @@ -112,15 +108,15 @@ type ChannelSummary struct { Arn *string // Whether the channel is private (enabled for playback authorization). Default: - // false. + // false . Authorized bool - // Whether the channel allows insecure RTMP ingest. Default: false. + // Whether the channel allows insecure RTMP ingest. Default: false . InsecureIngest bool // Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full - // HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In - // the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, + // HD. Use LOW for near-real-time interaction with viewers. Default: LOW . (Note: + // In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, // respectively.) LatencyMode ChannelLatencyMode @@ -132,11 +128,10 @@ type ChannelSummary struct { RecordingConfigurationArn *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde @@ -153,8 +148,8 @@ type DestinationConfiguration struct { noSmithyDocumentSerde } -// Object specifying the ingest configuration set up by the broadcaster, usually in -// an encoder. +// Object specifying the ingest configuration set up by the broadcaster, usually +// in an encoder. type IngestConfiguration struct { // Encoder settings for audio. @@ -179,11 +174,10 @@ type PlaybackKeyPair struct { Name *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde @@ -199,11 +193,10 @@ type PlaybackKeyPairSummary struct { Name *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde @@ -224,7 +217,7 @@ type RecordingConfiguration struct { DestinationConfiguration *DestinationConfiguration // Indicates the current state of the recording configuration. When the state is - // ACTIVE, the configuration is ready for recording a channel stream. + // ACTIVE , the configuration is ready for recording a channel stream. // // This member is required. State RecordingConfigurationState @@ -238,16 +231,15 @@ type RecordingConfiguration struct { RecordingReconnectWindowSeconds int32 // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string - // A complex type that allows you to enable/disable the recording of thumbnails for - // a live session and modify the interval at which thumbnails are generated for the - // live session. + // A complex type that allows you to enable/disable the recording of thumbnails + // for a live session and modify the interval at which thumbnails are generated for + // the live session. ThumbnailConfiguration *ThumbnailConfiguration noSmithyDocumentSerde @@ -268,7 +260,7 @@ type RecordingConfigurationSummary struct { DestinationConfiguration *DestinationConfiguration // Indicates the current state of the recording configuration. When the state is - // ACTIVE, the configuration is ready for recording a channel stream. + // ACTIVE , the configuration is ready for recording a channel stream. // // This member is required. State RecordingConfigurationState @@ -277,11 +269,10 @@ type RecordingConfigurationSummary struct { Name *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde @@ -325,23 +316,23 @@ type Stream struct { // A count of concurrent views of the stream. Typically, a new view appears in // viewerCount within 15 seconds of when video playback starts and a view is - // removed from viewerCount within 1 minute of when video playback ends. A value of - // -1 indicates that the request timed out; in this case, retry. + // removed from viewerCount within 1 minute of when video playback ends. A value + // of -1 indicates that the request timed out; in this case, retry. ViewerCount int64 noSmithyDocumentSerde } // Object specifying a stream’s events. For a list of events, see Using Amazon -// EventBridge with Amazon IVS -// (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html). +// EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html) +// . type StreamEvent struct { // Time when the event occurred. This is an ISO 8601 timestamp; note that this is // returned as a string. EventTime *time.Time - // Name that identifies the stream event within a type. + // Name that identifies the stream event within a type . Name *string // Logical group for certain events. @@ -369,11 +360,10 @@ type StreamKey struct { ChannelArn *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string // Stream-key value. @@ -392,26 +382,25 @@ type StreamKeySummary struct { ChannelArn *string // Tags attached to the resource. Array of 1-50 maps, each of the form - // string:string (key:value). See Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more - // information, including restrictions that apply to tags and "Tag naming limits - // and requirements"; Amazon IVS has no service-specific constraints beyond what is - // documented there. + // string:string (key:value) . See Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for more information, including restrictions that apply to tags and "Tag naming + // limits and requirements"; Amazon IVS has no service-specific constraints beyond + // what is documented there. Tags map[string]string noSmithyDocumentSerde } -// Object that captures the Amazon IVS configuration that the customer provisioned, -// the ingest configurations that the broadcaster used, and the most recent Amazon -// IVS stream events it encountered. +// Object that captures the Amazon IVS configuration that the customer +// provisioned, the ingest configurations that the broadcaster used, and the most +// recent Amazon IVS stream events it encountered. type StreamSession struct { // The properties of the channel at the time of going live. Channel *Channel // Time when the channel went offline. This is an ISO 8601 timestamp; note that - // this is returned as a string. For live streams, this is NULL. + // this is returned as a string. For live streams, this is NULL . EndTime *time.Time // The properties of the incoming RTMP stream for the stream. @@ -429,8 +418,8 @@ type StreamSession struct { // List of Amazon IVS events that the stream encountered. The list is sorted by // most recent events and contains up to 500 events. For Amazon IVS events, see - // Using Amazon EventBridge with Amazon IVS - // (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html). + // Using Amazon EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html) + // . TruncatedEvents []StreamEvent noSmithyDocumentSerde @@ -440,10 +429,10 @@ type StreamSession struct { type StreamSessionSummary struct { // Time when the channel went offline. This is an ISO 8601 timestamp; note that - // this is returned as a string. For live streams, this is NULL. + // this is returned as a string. For live streams, this is NULL . EndTime *time.Time - // If true, this stream encountered a quota breach or failure. + // If true , this stream encountered a quota breach or failure. HasErrorEvent bool // Time when the channel went live. This is an ISO 8601 timestamp; note that this @@ -479,8 +468,8 @@ type StreamSummary struct { // A count of concurrent views of the stream. Typically, a new view appears in // viewerCount within 15 seconds of when video playback starts and a view is - // removed from viewerCount within 1 minute of when video playback ends. A value of - // -1 indicates that the request timed out; in this case, retry. + // removed from viewerCount within 1 minute of when video playback ends. A value + // of -1 indicates that the request timed out; in this case, retry. ViewerCount int64 noSmithyDocumentSerde @@ -489,27 +478,26 @@ type StreamSummary struct { // An object representing a configuration of thumbnails for recorded video. type ThumbnailConfiguration struct { - // Thumbnail recording mode. Default: INTERVAL. + // Thumbnail recording mode. Default: INTERVAL . RecordingMode RecordingMode - // The targeted thumbnail-generation interval in seconds. This is configurable (and - // required) only if recordingMode is INTERVAL. Default: 60. Important: Setting a - // value for targetIntervalSeconds does not guarantee that thumbnails are generated - // at the specified interval. For thumbnails to be generated at the + // The targeted thumbnail-generation interval in seconds. This is configurable + // (and required) only if recordingMode is INTERVAL . Default: 60. Important: + // Setting a value for targetIntervalSeconds does not guarantee that thumbnails + // are generated at the specified interval. For thumbnails to be generated at the // targetIntervalSeconds interval, the IDR/Keyframe value for the input video must // be less than the targetIntervalSeconds value. See Amazon IVS Streaming - // Configuration - // (https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html) for - // information on setting IDR/Keyframe to the recommended value in video-encoder - // settings. + // Configuration (https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html) + // for information on setting IDR/Keyframe to the recommended value in + // video-encoder settings. TargetIntervalSeconds int64 noSmithyDocumentSerde } // Object specifying a stream’s video configuration, as set up by the broadcaster -// (usually in an encoder). This is part of the IngestConfiguration object and used -// for monitoring stream health. +// (usually in an encoder). This is part of the IngestConfiguration object and +// used for monitoring stream health. type VideoConfiguration struct { // Indicates the degree of required decoder performance for a profile. Normally diff --git a/service/ivschat/api_client.go b/service/ivschat/api_client.go index d0dc2b94d9a..6d0086b1957 100644 --- a/service/ivschat/api_client.go +++ b/service/ivschat/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ivschat/api_op_CreateChatToken.go b/service/ivschat/api_op_CreateChatToken.go index 2989a6781b6..71c671d5cc2 100644 --- a/service/ivschat/api_op_CreateChatToken.go +++ b/service/ivschat/api_op_CreateChatToken.go @@ -77,8 +77,8 @@ type CreateChatTokenOutput struct { // The issued client token, encrypted. Token *string - // Time after which the token is no longer valid and cannot be used to connect to a - // room. This is an ISO 8601 timestamp; note that this is returned as a string. + // Time after which the token is no longer valid and cannot be used to connect to + // a room. This is an ISO 8601 timestamp; note that this is returned as a string. TokenExpirationTime *time.Time // Metadata pertaining to the operation's result. diff --git a/service/ivschat/api_op_CreateLoggingConfiguration.go b/service/ivschat/api_op_CreateLoggingConfiguration.go index 5a328e2e5fc..7f405a76ee3 100644 --- a/service/ivschat/api_op_CreateLoggingConfiguration.go +++ b/service/ivschat/api_op_CreateLoggingConfiguration.go @@ -32,8 +32,8 @@ func (c *Client) CreateLoggingConfiguration(ctx context.Context, params *CreateL type CreateLoggingConfigurationInput struct { // A complex type that contains a destination configuration for where chat content - // will be logged. There can be only one type of destination (cloudWatchLogs, - // firehose, or s3) in a destinationConfiguration. + // will be logged. There can be only one type of destination ( cloudWatchLogs , + // firehose , or s3 ) in a destinationConfiguration . // // This member is required. DestinationConfiguration types.DestinationConfiguration @@ -42,10 +42,9 @@ type CreateLoggingConfigurationInput struct { Name *string // Tags to attach to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints on tags beyond what is + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints on tags beyond what is // documented there. Tags map[string]string @@ -62,8 +61,8 @@ type CreateLoggingConfigurationOutput struct { CreateTime *time.Time // A complex type that contains a destination configuration for where chat content - // will be logged, from the request. There is only one type of destination - // (cloudWatchLogs, firehose, or s3) in a destinationConfiguration. + // will be logged, from the request. There is only one type of destination ( + // cloudWatchLogs , firehose , or s3 ) in a destinationConfiguration . DestinationConfiguration types.DestinationConfiguration // Logging-configuration ID, generated by the system. This is a relative @@ -74,12 +73,12 @@ type CreateLoggingConfigurationOutput struct { // Logging-configuration name, from the request (if specified). Name *string - // The state of the logging configuration. When the state is ACTIVE, the + // The state of the logging configuration. When the state is ACTIVE , the // configuration is ready to log chat content. State types.CreateLoggingConfigurationState // Tags attached to the resource, from the request (if specified). Array of maps, - // each of the form string:string (key:value). + // each of the form string:string (key:value) . Tags map[string]string // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; diff --git a/service/ivschat/api_op_CreateRoom.go b/service/ivschat/api_op_CreateRoom.go index da543d3906e..73041319cd8 100644 --- a/service/ivschat/api_op_CreateRoom.go +++ b/service/ivschat/api_op_CreateRoom.go @@ -49,10 +49,9 @@ type CreateRoomInput struct { Name *string // Tags to attach to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints beyond what is documented + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. Tags map[string]string @@ -64,12 +63,12 @@ type CreateRoomOutput struct { // Room ARN, assigned by the system. Arn *string - // Time when the room was created. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time when the room was created. This is an ISO 8601 timestamp; note that this + // is returned as a string. CreateTime *time.Time - // Room ID, generated by the system. This is a relative identifier, the part of the - // ARN that uniquely identifies the room. + // Room ID, generated by the system. This is a relative identifier, the part of + // the ARN that uniquely identifies the room. Id *string // Array of logging configurations attached to the room, from the request (if @@ -93,8 +92,8 @@ type CreateRoomOutput struct { // Tags attached to the resource, from the request (if specified). Tags map[string]string - // Time of the room’s last update. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time of the room’s last update. This is an ISO 8601 timestamp; note that this + // is returned as a string. UpdateTime *time.Time // Metadata pertaining to the operation's result. diff --git a/service/ivschat/api_op_DeleteMessage.go b/service/ivschat/api_op_DeleteMessage.go index 189f6e62069..958e0ab569e 100644 --- a/service/ivschat/api_op_DeleteMessage.go +++ b/service/ivschat/api_op_DeleteMessage.go @@ -12,9 +12,8 @@ import ( // Sends an event to a specific room which directs clients to delete a specific // message; that is, unrender it from view and delete it from the client’s chat -// history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the -// DeleteMessage -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) +// history. This event’s EventName is aws:DELETE_MESSAGE . This replicates the +// DeleteMessage (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) // WebSocket operation in the Amazon IVS Chat Messaging API. func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, optFns ...func(*Options)) (*DeleteMessageOutput, error) { if params == nil { @@ -34,8 +33,7 @@ func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, type DeleteMessageInput struct { // ID of the message to be deleted. This is the Id field in the received message - // (see Message (Subscribe) - // (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html) + // (see Message (Subscribe) (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html) // in the Chat Messaging API). // // This member is required. diff --git a/service/ivschat/api_op_DisconnectUser.go b/service/ivschat/api_op_DisconnectUser.go index 52dfbe4207d..7d1f37988d9 100644 --- a/service/ivschat/api_op_DisconnectUser.go +++ b/service/ivschat/api_op_DisconnectUser.go @@ -11,8 +11,7 @@ import ( ) // Disconnects all connections using a specified user ID from a room. This -// replicates the DisconnectUser -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) +// replicates the DisconnectUser (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) // WebSocket operation in the Amazon IVS Chat Messaging API. func (c *Client) DisconnectUser(ctx context.Context, params *DisconnectUserInput, optFns ...func(*Options)) (*DisconnectUserOutput, error) { if params == nil { diff --git a/service/ivschat/api_op_GetLoggingConfiguration.go b/service/ivschat/api_op_GetLoggingConfiguration.go index 22c199e9aa1..7c226617adc 100644 --- a/service/ivschat/api_op_GetLoggingConfiguration.go +++ b/service/ivschat/api_op_GetLoggingConfiguration.go @@ -48,8 +48,8 @@ type GetLoggingConfigurationOutput struct { CreateTime *time.Time // A complex type that contains a destination configuration for where chat content - // will be logged. There is only one type of destination (cloudWatchLogs, firehose, - // or s3) in a destinationConfiguration. + // will be logged. There is only one type of destination ( cloudWatchLogs , + // firehose , or s3 ) in a destinationConfiguration . DestinationConfiguration types.DestinationConfiguration // Logging-configuration ID, generated by the system. This is a relative @@ -60,12 +60,12 @@ type GetLoggingConfigurationOutput struct { // Logging-configuration name. This value does not need to be unique. Name *string - // The state of the logging configuration. When the state is ACTIVE, the + // The state of the logging configuration. When the state is ACTIVE , the // configuration is ready to log chat content. State types.LoggingConfigurationState // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . Tags map[string]string // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; diff --git a/service/ivschat/api_op_GetRoom.go b/service/ivschat/api_op_GetRoom.go index 9d42fc9de68..90ecd44bf94 100644 --- a/service/ivschat/api_op_GetRoom.go +++ b/service/ivschat/api_op_GetRoom.go @@ -30,8 +30,8 @@ func (c *Client) GetRoom(ctx context.Context, params *GetRoomInput, optFns ...fu type GetRoomInput struct { - // Identifier of the room for which the configuration is to be retrieved. Currently - // this must be an ARN. + // Identifier of the room for which the configuration is to be retrieved. + // Currently this must be an ARN. // // This member is required. Identifier *string @@ -44,12 +44,12 @@ type GetRoomOutput struct { // Room ARN, from the request (if identifier was an ARN). Arn *string - // Time when the room was created. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time when the room was created. This is an ISO 8601 timestamp; note that this + // is returned as a string. CreateTime *time.Time - // Room ID, generated by the system. This is a relative identifier, the part of the - // ARN that uniquely identifies the room. + // Room ID, generated by the system. This is a relative identifier, the part of + // the ARN that uniquely identifies the room. Id *string // Array of logging configurations attached to the room. @@ -71,11 +71,11 @@ type GetRoomOutput struct { Name *string // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . Tags map[string]string - // Time of the room’s last update. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time of the room’s last update. This is an ISO 8601 timestamp; note that this + // is returned as a string. UpdateTime *time.Time // Metadata pertaining to the operation's result. diff --git a/service/ivschat/api_op_ListLoggingConfigurations.go b/service/ivschat/api_op_ListLoggingConfigurations.go index 1ac604d2982..52f207017dc 100644 --- a/service/ivschat/api_op_ListLoggingConfigurations.go +++ b/service/ivschat/api_op_ListLoggingConfigurations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets summary information about all your logging configurations in the AWS region -// where the API request is processed. +// Gets summary information about all your logging configurations in the AWS +// region where the API request is processed. func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error) { if params == nil { params = &ListLoggingConfigurationsInput{} @@ -43,14 +43,14 @@ type ListLoggingConfigurationsInput struct { type ListLoggingConfigurationsOutput struct { - // List of the matching logging configurations (summary information only). There is - // only one type of destination (cloudWatchLogs, firehose, or s3) in a - // destinationConfiguration. + // List of the matching logging configurations (summary information only). There + // is only one type of destination ( cloudWatchLogs , firehose , or s3 ) in a + // destinationConfiguration . // // This member is required. LoggingConfigurations []types.LoggingConfigurationSummary - // If there are more logging configurations than maxResults, use nextToken in the + // If there are more logging configurations than maxResults , use nextToken in the // request to get the next set. NextToken *string diff --git a/service/ivschat/api_op_ListRooms.go b/service/ivschat/api_op_ListRooms.go index 4981350b956..38b796c1b40 100644 --- a/service/ivschat/api_op_ListRooms.go +++ b/service/ivschat/api_op_ListRooms.go @@ -13,7 +13,7 @@ import ( ) // Gets summary information about all your rooms in the AWS region where the API -// request is processed. Results are sorted in descending order of updateTime. +// request is processed. Results are sorted in descending order of updateTime . func (c *Client) ListRooms(ctx context.Context, params *ListRoomsInput, optFns ...func(*Options)) (*ListRoomsOutput, error) { if params == nil { params = &ListRoomsInput{} @@ -57,8 +57,8 @@ type ListRoomsOutput struct { // This member is required. Rooms []types.RoomSummary - // If there are more rooms than maxResults, use nextToken in the request to get the - // next set. + // If there are more rooms than maxResults , use nextToken in the request to get + // the next set. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ivschat/api_op_ListTagsForResource.go b/service/ivschat/api_op_ListTagsForResource.go index 13e2595ad2f..202a703f16a 100644 --- a/service/ivschat/api_op_ListTagsForResource.go +++ b/service/ivschat/api_op_ListTagsForResource.go @@ -39,7 +39,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . // // This member is required. Tags map[string]string diff --git a/service/ivschat/api_op_SendEvent.go b/service/ivschat/api_op_SendEvent.go index 0be39698ad4..d60106b1eef 100644 --- a/service/ivschat/api_op_SendEvent.go +++ b/service/ivschat/api_op_SendEvent.go @@ -41,8 +41,8 @@ type SendEventInput struct { // This member is required. RoomIdentifier *string - // Application-defined metadata to attach to the event sent to clients. The maximum - // length of the metadata is 1 KB total. + // Application-defined metadata to attach to the event sent to clients. The + // maximum length of the metadata is 1 KB total. Attributes map[string]string noSmithyDocumentSerde diff --git a/service/ivschat/api_op_TagResource.go b/service/ivschat/api_op_TagResource.go index ba4e2845fb6..ecbbc1a1a66 100644 --- a/service/ivschat/api_op_TagResource.go +++ b/service/ivschat/api_op_TagResource.go @@ -34,10 +34,9 @@ type TagResourceInput struct { ResourceArn *string // Array of tags to be added or updated. Array of maps, each of the form - // string:string (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints beyond what is documented + // string:string (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. // // This member is required. diff --git a/service/ivschat/api_op_UntagResource.go b/service/ivschat/api_op_UntagResource.go index bc6d0e6d388..3bfe436b37d 100644 --- a/service/ivschat/api_op_UntagResource.go +++ b/service/ivschat/api_op_UntagResource.go @@ -34,10 +34,9 @@ type UntagResourceInput struct { ResourceArn *string // Array of tags to be removed. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints beyond what is documented + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. // // This member is required. diff --git a/service/ivschat/api_op_UpdateLoggingConfiguration.go b/service/ivschat/api_op_UpdateLoggingConfiguration.go index 318e6beb586..d1daa9b6d5d 100644 --- a/service/ivschat/api_op_UpdateLoggingConfiguration.go +++ b/service/ivschat/api_op_UpdateLoggingConfiguration.go @@ -36,8 +36,8 @@ type UpdateLoggingConfigurationInput struct { Identifier *string // A complex type that contains a destination configuration for where chat content - // will be logged. There can be only one type of destination (cloudWatchLogs, - // firehose, or s3) in a destinationConfiguration. + // will be logged. There can be only one type of destination ( cloudWatchLogs , + // firehose , or s3 ) in a destinationConfiguration . DestinationConfiguration types.DestinationConfiguration // Logging-configuration name. The value does not need to be unique. @@ -56,8 +56,8 @@ type UpdateLoggingConfigurationOutput struct { CreateTime *time.Time // A complex type that contains a destination configuration for where chat content - // will be logged, from the request. There is only one type of destination - // (cloudWatchLogs, firehose, or s3) in a destinationConfiguration. + // will be logged, from the request. There is only one type of destination ( + // cloudWatchLogs , firehose , or s3 ) in a destinationConfiguration . DestinationConfiguration types.DestinationConfiguration // Logging-configuration ID, generated by the system. This is a relative @@ -67,12 +67,12 @@ type UpdateLoggingConfigurationOutput struct { // Logging-configuration name, from the request (if specified). Name *string - // The state of the logging configuration. When the state is ACTIVE, the + // The state of the logging configuration. When the state is ACTIVE , the // configuration is ready to log chat content. State types.UpdateLoggingConfigurationState // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . Tags map[string]string // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; diff --git a/service/ivschat/api_op_UpdateRoom.go b/service/ivschat/api_op_UpdateRoom.go index adffa172132..3f528e51ad3 100644 --- a/service/ivschat/api_op_UpdateRoom.go +++ b/service/ivschat/api_op_UpdateRoom.go @@ -62,12 +62,12 @@ type UpdateRoomOutput struct { // Room ARN, from the request (if identifier was an ARN). Arn *string - // Time when the room was created. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time when the room was created. This is an ISO 8601 timestamp; note that this + // is returned as a string. CreateTime *time.Time - // Room ID, generated by the system. This is a relative identifier, the part of the - // ARN that uniquely identifies the room. + // Room ID, generated by the system. This is a relative identifier, the part of + // the ARN that uniquely identifies the room. Id *string // Array of logging configurations attached to the room, from the request (if @@ -89,11 +89,11 @@ type UpdateRoomOutput struct { Name *string // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . Tags map[string]string - // Time of the room’s last update. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time of the room’s last update. This is an ISO 8601 timestamp; note that this + // is returned as a string. UpdateTime *time.Time // Metadata pertaining to the operation's result. diff --git a/service/ivschat/doc.go b/service/ivschat/doc.go index 64f118971bb..9b0636d2caf 100644 --- a/service/ivschat/doc.go +++ b/service/ivschat/doc.go @@ -4,62 +4,47 @@ // Amazon Interactive Video Service Chat. // // Introduction The Amazon IVS Chat control-plane API enables you to create and -// manage Amazon IVS Chat resources. You also need to integrate with the Amazon -// IVS Chat Messaging API -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html), -// to enable users to interact with chat rooms in real time. The API is an AWS +// manage Amazon IVS Chat resources. You also need to integrate with the Amazon +// IVS Chat Messaging API (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html) +// , to enable users to interact with chat rooms in real time. The API is an AWS // regional service. For a list of supported regions and Amazon IVS Chat HTTPS -// service endpoints, see the Amazon IVS Chat information on the Amazon IVS page -// (https://docs.aws.amazon.com/general/latest/gr/ivs.html) in the AWS General -// Reference. Notes on terminology: -// -// * You create service applications using the -// Amazon IVS Chat API. We refer to these as applications. -// -// * You create front-end -// client applications (browser and Android/iOS apps) using the Amazon IVS Chat -// Messaging API. We refer to these as clients. -// -// Resources The following resources -// are part of Amazon IVS Chat: -// -// * LoggingConfiguration — A configuration that -// allows customers to store and record sent messages in a chat room. See the -// Logging Configuration endpoints for more information. -// -// * Room — The central -// Amazon IVS Chat resource through which clients connect to and exchange chat -// messages. See the Room endpoints for more information. -// -// Tagging A tag is a -// metadata label that you assign to an AWS resource. A tag comprises a key and a -// value, both set by you. For example, you might set a tag as topic:nature to -// label a particular video category. See Tagging AWS Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more -// information, including restrictions that apply to tags and "Tag naming limits -// and requirements"; Amazon IVS Chat has no service-specific constraints beyond -// what is documented there. Tags can help you identify and organize your AWS -// resources. For example, you can use the same tag for different resources to +// service endpoints, see the Amazon IVS Chat information on the Amazon IVS page (https://docs.aws.amazon.com/general/latest/gr/ivs.html) +// in the AWS General Reference. Notes on terminology: +// - You create service applications using the Amazon IVS Chat API. We refer to +// these as applications. +// - You create front-end client applications (browser and Android/iOS apps) +// using the Amazon IVS Chat Messaging API. We refer to these as clients. +// +// Resources The following resources are part of Amazon IVS Chat: +// - LoggingConfiguration — A configuration that allows customers to store and +// record sent messages in a chat room. See the Logging Configuration endpoints for +// more information. +// - Room — The central Amazon IVS Chat resource through which clients connect +// to and exchange chat messages. See the Room endpoints for more information. +// +// Tagging A tag is a metadata label that you assign to an AWS resource. A tag +// comprises a key and a value, both set by you. For example, you might set a tag +// as topic:nature to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// for more information, including restrictions that apply to tags and "Tag naming +// limits and requirements"; Amazon IVS Chat has no service-specific constraints +// beyond what is documented there. Tags can help you identify and organize your +// AWS resources. For example, you can use the same tag for different resources to // indicate that they are related. You can also use tags to manage access (see -// Access Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). The Amazon -// IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and -// ListTagsForResource. The following resource supports tagging: Room. At most 50 -// tags can be applied to a resource. API Access Security Your Amazon IVS Chat -// applications (service applications and clients) must be authenticated and -// authorized to access Amazon IVS Chat resources. Note the differences between -// these concepts: -// -// * Authentication is about verifying identity. Requests to the -// Amazon IVS Chat API must be signed to verify your identity. -// -// * Authorization is -// about granting permissions. Your IAM roles need to have permissions for Amazon -// IVS Chat API requests. -// -// Users (viewers) connect to a room using secure access -// tokens that you create using the CreateChatToken endpoint through the AWS SDK. -// You call CreateChatToken for every user’s chat session, passing identity and +// Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// ). The Amazon IVS Chat API has these tag-related endpoints: TagResource , +// UntagResource , and ListTagsForResource . The following resource supports +// tagging: Room. At most 50 tags can be applied to a resource. API Access Security +// Your Amazon IVS Chat applications (service applications and clients) must be +// authenticated and authorized to access Amazon IVS Chat resources. Note the +// differences between these concepts: +// - Authentication is about verifying identity. Requests to the Amazon IVS Chat +// API must be signed to verify your identity. +// - Authorization is about granting permissions. Your IAM roles need to have +// permissions for Amazon IVS Chat API requests. +// +// Users (viewers) connect to a room using secure access tokens that you create +// using the CreateChatToken endpoint through the AWS SDK. You call +// CreateChatToken for every user’s chat session, passing identity and // authorization information about the user. Signing API Requests HTTP API requests // must be signed with an AWS SigV4 signature using your AWS security credentials. // The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the @@ -69,99 +54,61 @@ // permission to perform the requested action. For example, DeleteMessage requests // must be made using an IAM role that has the ivschat:DeleteMessage permission. // For more information: -// -// * Authentication and generating signatures — See -// Authenticating Requests (Amazon Web Services Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) -// in the Amazon Web Services General Reference. -// -// * Managing Amazon IVS permissions -// — See Identity and Access Management -// (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) on the -// Security page of the Amazon IVS User Guide. -// -// Amazon Resource Names (ARNs) ARNs -// uniquely identify AWS resources. An ARN is required when you need to specify a -// resource unambiguously across all of AWS, such as in IAM policies and API calls. -// For more information, see Amazon Resource Names -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the AWS General Reference. Messaging Endpoints -// -// * DeleteMessage — Sends an event -// to a specific room which directs clients to delete a specific message; that is, -// unrender it from view and delete it from the client’s chat history. This event’s -// EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) -// WebSocket operation in the Amazon IVS Chat Messaging API. -// -// * DisconnectUser — -// Disconnects all connections using a specified user ID from a room. This -// replicates the DisconnectUser -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) -// WebSocket operation in the Amazon IVS Chat Messaging API. -// -// * SendEvent — Sends -// an event to a room. Use this within your application’s business logic to send -// events to clients of a room; e.g., to notify clients to change the way the chat -// UI is rendered. -// -// # Chat Token Endpoint -// -// * CreateChatToken — Creates an encrypted -// token that is used by a chat participant to establish an individual WebSocket -// chat connection to a room. When the token is used to connect to chat, the -// connection is valid for the session duration specified in the request. The token -// becomes invalid at the token-expiration timestamp included in the -// response. -// -// # Room Endpoints -// -// * CreateRoom — Creates a room that allows clients to -// connect and pass messages. -// -// * DeleteRoom — Deletes the specified room. -// -// * -// GetRoom — Gets the specified room. -// -// * ListRooms — Gets summary information about -// all your rooms in the AWS region where the API request is processed. -// -// * -// UpdateRoom — Updates a room’s configuration. -// -// # Logging Configuration Endpoints -// -// * -// CreateLoggingConfiguration — Creates a logging configuration that allows clients -// to store and record sent messages. -// -// * DeleteLoggingConfiguration — Deletes the -// specified logging configuration. -// -// * GetLoggingConfiguration — Gets the specified -// logging configuration. -// -// * ListLoggingConfigurations — Gets summary information -// about all your logging configurations in the AWS region where the API request is -// processed. -// -// * UpdateLoggingConfiguration — Updates a specified logging -// configuration. -// -// # Tags Endpoints -// -// * ListTagsForResource — Gets information about -// AWS tags for the specified ARN. -// -// * TagResource — Adds or updates tags for the -// AWS resource with the specified ARN. -// -// * UntagResource — Removes tags from the -// resource with the specified ARN. -// -// All the above are HTTP operations. There is a -// separate messaging API for managing Chat resources; see the Amazon IVS Chat -// Messaging API Reference -// (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html). +// - Authentication and generating signatures — See Authenticating Requests +// (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// in the Amazon Web Services General Reference. +// - Managing Amazon IVS permissions — See Identity and Access Management (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) +// on the Security page of the Amazon IVS User Guide. +// +// Amazon Resource Names (ARNs) ARNs uniquely identify AWS resources. An ARN is +// required when you need to specify a resource unambiguously across all of AWS, +// such as in IAM policies and API calls. For more information, see Amazon +// Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the AWS General Reference. Messaging Endpoints +// - DeleteMessage — Sends an event to a specific room which directs clients to +// delete a specific message; that is, unrender it from view and delete it from the +// client’s chat history. This event’s EventName is aws:DELETE_MESSAGE . This +// replicates the DeleteMessage (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html) +// WebSocket operation in the Amazon IVS Chat Messaging API. +// - DisconnectUser — Disconnects all connections using a specified user ID from +// a room. This replicates the DisconnectUser (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html) +// WebSocket operation in the Amazon IVS Chat Messaging API. +// - SendEvent — Sends an event to a room. Use this within your application’s +// business logic to send events to clients of a room; e.g., to notify clients to +// change the way the chat UI is rendered. +// +// Chat Token Endpoint +// - CreateChatToken — Creates an encrypted token that is used by a chat +// participant to establish an individual WebSocket chat connection to a room. When +// the token is used to connect to chat, the connection is valid for the session +// duration specified in the request. The token becomes invalid at the +// token-expiration timestamp included in the response. +// +// Room Endpoints +// - CreateRoom — Creates a room that allows clients to connect and pass +// messages. +// - DeleteRoom — Deletes the specified room. +// - GetRoom — Gets the specified room. +// - ListRooms — Gets summary information about all your rooms in the AWS region +// where the API request is processed. +// - UpdateRoom — Updates a room’s configuration. +// +// Logging Configuration Endpoints +// - CreateLoggingConfiguration — Creates a logging configuration that allows +// clients to store and record sent messages. +// - DeleteLoggingConfiguration — Deletes the specified logging configuration. +// - GetLoggingConfiguration — Gets the specified logging configuration. +// - ListLoggingConfigurations — Gets summary information about all your logging +// configurations in the AWS region where the API request is processed. +// - UpdateLoggingConfiguration — Updates a specified logging configuration. +// +// Tags Endpoints +// - ListTagsForResource — Gets information about AWS tags for the specified ARN. +// - TagResource — Adds or updates tags for the AWS resource with the specified +// ARN. +// - UntagResource — Removes tags from the resource with the specified ARN. +// +// All the above are HTTP operations. There is a separate messaging API for +// managing Chat resources; see the Amazon IVS Chat Messaging API Reference (https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html) +// . package ivschat diff --git a/service/ivschat/types/enums.go b/service/ivschat/types/enums.go index 01e73fdac1a..e370fc92355 100644 --- a/service/ivschat/types/enums.go +++ b/service/ivschat/types/enums.go @@ -92,9 +92,9 @@ const ( ResourceTypeRoom ResourceType = "ROOM" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "ROOM", diff --git a/service/ivschat/types/types.go b/service/ivschat/types/types.go index 479c9a889e3..b0d586be5fe 100644 --- a/service/ivschat/types/types.go +++ b/service/ivschat/types/types.go @@ -95,15 +95,14 @@ type LoggingConfigurationSummary struct { // Logging-configuration name. The value does not need to be unique. Name *string - // The state of the logging configuration. When this is ACTIVE, the configuration + // The state of the logging configuration. When this is ACTIVE , the configuration // is ready for logging chat content. State LoggingConfigurationState // Tags to attach to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints on tags beyond what is + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints on tags beyond what is // documented there. Tags map[string]string @@ -119,11 +118,10 @@ type MessageReviewHandler struct { // Specifies the fallback behavior (whether the message is allowed or denied) if // the handler does not return a valid response, encounters an error, or times out. - // (For the timeout period, see Service Quotas - // (https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html).) If - // allowed, the message is delivered with returned content to all users connected - // to the room. If denied, the message is not delivered to any user. Default: - // ALLOW. + // (For the timeout period, see Service Quotas (https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html) + // .) If allowed, the message is delivered with returned content to all users + // connected to the room. If denied, the message is not delivered to any user. + // Default: ALLOW . FallbackResult FallbackResult // Identifier of the message review handler. Currently this must be an ARN of a @@ -139,12 +137,12 @@ type RoomSummary struct { // Room ARN. Arn *string - // Time when the room was created. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time when the room was created. This is an ISO 8601 timestamp; note that this + // is returned as a string. CreateTime *time.Time - // Room ID, generated by the system. This is a relative identifier, the part of the - // ARN that uniquely identifies the room. + // Room ID, generated by the system. This is a relative identifier, the part of + // the ARN that uniquely identifies the room. Id *string // List of logging-configuration identifiers attached to the room. @@ -157,15 +155,14 @@ type RoomSummary struct { Name *string // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS Chat has no constraints beyond what is documented + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented // there. Tags map[string]string - // Time of the room’s last update. This is an ISO 8601 timestamp; note that this is - // returned as a string. + // Time of the room’s last update. This is an ISO 8601 timestamp; note that this + // is returned as a string. UpdateTime *time.Time noSmithyDocumentSerde diff --git a/service/ivsrealtime/api_client.go b/service/ivsrealtime/api_client.go index fcd0cb3fa13..c1054fd7f18 100644 --- a/service/ivsrealtime/api_client.go +++ b/service/ivsrealtime/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ivsrealtime/api_op_CreateParticipantToken.go b/service/ivsrealtime/api_op_CreateParticipantToken.go index b7f1ac88b48..6d13648154c 100644 --- a/service/ivsrealtime/api_op_CreateParticipantToken.go +++ b/service/ivsrealtime/api_op_CreateParticipantToken.go @@ -44,7 +44,7 @@ type CreateParticipantTokenInput struct { Attributes map[string]string // Set of capabilities that the user is allowed to perform in the stage. Default: - // PUBLISH, SUBSCRIBE. + // PUBLISH, SUBSCRIBE . Capabilities []types.ParticipantTokenCapability // Duration (in minutes), after which the token expires. Default: 60 (1 hour). diff --git a/service/ivsrealtime/api_op_CreateStage.go b/service/ivsrealtime/api_op_CreateStage.go index 399c3d8d895..eff085422cd 100644 --- a/service/ivsrealtime/api_op_CreateStage.go +++ b/service/ivsrealtime/api_op_CreateStage.go @@ -36,11 +36,10 @@ type CreateStageInput struct { ParticipantTokenConfigurations []types.ParticipantTokenConfiguration // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS has no constraints on tags beyond what is documented - // there. + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is + // documented there. Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivsrealtime/api_op_DisconnectParticipant.go b/service/ivsrealtime/api_op_DisconnectParticipant.go index da01e1b12a8..7cd410e76ab 100644 --- a/service/ivsrealtime/api_op_DisconnectParticipant.go +++ b/service/ivsrealtime/api_op_DisconnectParticipant.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disconnects a specified participant and revokes the participant permanently from -// a specified stage. +// Disconnects a specified participant and revokes the participant permanently +// from a specified stage. func (c *Client) DisconnectParticipant(ctx context.Context, params *DisconnectParticipantInput, optFns ...func(*Options)) (*DisconnectParticipantOutput, error) { if params == nil { params = &DisconnectParticipantInput{} @@ -30,7 +30,7 @@ func (c *Client) DisconnectParticipant(ctx context.Context, params *DisconnectPa type DisconnectParticipantInput struct { // Identifier of the participant to be disconnected. This is returned by - // CreateParticipantToken. + // CreateParticipantToken . // // This member is required. ParticipantId *string diff --git a/service/ivsrealtime/api_op_ListStages.go b/service/ivsrealtime/api_op_ListStages.go index 9c655efa724..b3b0a289ba7 100644 --- a/service/ivsrealtime/api_op_ListStages.go +++ b/service/ivsrealtime/api_op_ListStages.go @@ -48,8 +48,8 @@ type ListStagesOutput struct { // This member is required. Stages []types.StageSummary - // If there are more rooms than maxResults, use nextToken in the request to get the - // next set. + // If there are more rooms than maxResults , use nextToken in the request to get + // the next set. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ivsrealtime/api_op_ListTagsForResource.go b/service/ivsrealtime/api_op_ListTagsForResource.go index ba9018d83d5..d00c9de58da 100644 --- a/service/ivsrealtime/api_op_ListTagsForResource.go +++ b/service/ivsrealtime/api_op_ListTagsForResource.go @@ -39,7 +39,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value) . // // This member is required. Tags map[string]string diff --git a/service/ivsrealtime/api_op_TagResource.go b/service/ivsrealtime/api_op_TagResource.go index 221a9bb6024..2f0b2a8a73b 100644 --- a/service/ivsrealtime/api_op_TagResource.go +++ b/service/ivsrealtime/api_op_TagResource.go @@ -34,10 +34,10 @@ type TagResourceInput struct { ResourceArn *string // Array of tags to be added or updated. Array of maps, each of the form - // string:string (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS has no constraints beyond what is documented there. + // string:string (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints beyond what is documented + // there. // // This member is required. Tags map[string]string diff --git a/service/ivsrealtime/api_op_UntagResource.go b/service/ivsrealtime/api_op_UntagResource.go index 18661319f85..a43fd35f206 100644 --- a/service/ivsrealtime/api_op_UntagResource.go +++ b/service/ivsrealtime/api_op_UntagResource.go @@ -34,10 +34,10 @@ type UntagResourceInput struct { ResourceArn *string // Array of tags to be removed. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS has no constraints beyond what is documented there. + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints beyond what is documented + // there. // // This member is required. TagKeys []string diff --git a/service/ivsrealtime/doc.go b/service/ivsrealtime/doc.go index 8db24b1a8b5..b27131036bc 100644 --- a/service/ivsrealtime/doc.go +++ b/service/ivsrealtime/doc.go @@ -1,67 +1,45 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package ivsrealtime provides the API client, operations, and parameter types for -// Amazon Interactive Video Service RealTime. +// Package ivsrealtime provides the API client, operations, and parameter types +// for Amazon Interactive Video Service RealTime. // // Introduction The Amazon Interactive Video Service (IVS) stage API is REST // compatible, using a standard HTTP API and an AWS EventBridge event stream for // responses. JSON is used for both requests and responses, including errors. // Terminology: The IVS stage API sometimes is referred to as the IVS RealTime API. // Resources The following resources contain information about your IVS live stream -// (see Getting Started with Amazon IVS -// (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html)): -// -// * -// Stage — A stage is a virtual space where multiple participants can exchange -// audio and video in real time. -// -// Tagging A tag is a metadata label that you assign -// to an AWS resource. A tag comprises a key and a value, both set by you. For -// example, you might set a tag as topic:nature to label a particular video -// category. See Tagging AWS Resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for more -// information, including restrictions that apply to tags and "Tag naming limits -// and requirements"; Amazon IVS stages has no service-specific constraints beyond -// what is documented there. Tags can help you identify and organize your AWS -// resources. For example, you can use the same tag for different resources to +// (see Getting Started with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html) +// ): +// - Stage — A stage is a virtual space where multiple participants can exchange +// audio and video in real time. +// +// Tagging A tag is a metadata label that you assign to an AWS resource. A tag +// comprises a key and a value, both set by you. For example, you might set a tag +// as topic:nature to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// for more information, including restrictions that apply to tags and "Tag naming +// limits and requirements"; Amazon IVS stages has no service-specific constraints +// beyond what is documented there. Tags can help you identify and organize your +// AWS resources. For example, you can use the same tag for different resources to // indicate that they are related. You can also use tags to manage access (see -// Access Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). The Amazon -// IVS stage API has these tag-related endpoints: TagResource, UntagResource, and -// ListTagsForResource. The following resource supports tagging: Stage. At most 50 -// tags can be applied to a resource. Stages Endpoints -// -// * CreateParticipantToken — -// Creates an additional token for a specified stage. This can be done after stage -// creation or when tokens expire. -// -// * CreateStage — Creates a new stage (and -// optionally participant tokens). -// -// * DeleteStage — Shuts down and deletes the -// specified stage (disconnecting all participants). -// -// * DisconnectParticipant — -// Disconnects a specified participant and revokes the participant permanently from -// a specified stage. -// -// * GetStage — Gets information for the specified stage. -// -// * -// ListStages — Gets summary information about all stages in your account, in the -// AWS region where the API request is processed. -// -// * UpdateStage — Updates a -// stage’s configuration. -// -// # Tags Endpoints -// -// * ListTagsForResource — Gets information -// about AWS tags for the specified ARN. -// -// * TagResource — Adds or updates tags for -// the AWS resource with the specified ARN. -// -// * UntagResource — Removes tags from -// the resource with the specified ARN. +// Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// ). The Amazon IVS stage API has these tag-related endpoints: TagResource , +// UntagResource , and ListTagsForResource . The following resource supports +// tagging: Stage. At most 50 tags can be applied to a resource. Stages Endpoints +// - CreateParticipantToken — Creates an additional token for a specified stage. +// This can be done after stage creation or when tokens expire. +// - CreateStage — Creates a new stage (and optionally participant tokens). +// - DeleteStage — Shuts down and deletes the specified stage (disconnecting all +// participants). +// - DisconnectParticipant — Disconnects a specified participant and revokes the +// participant permanently from a specified stage. +// - GetStage — Gets information for the specified stage. +// - ListStages — Gets summary information about all stages in your account, in +// the AWS region where the API request is processed. +// - UpdateStage — Updates a stage’s configuration. +// +// Tags Endpoints +// - ListTagsForResource — Gets information about AWS tags for the specified ARN. +// - TagResource — Adds or updates tags for the AWS resource with the specified +// ARN. +// - UntagResource — Removes tags from the resource with the specified ARN. package ivsrealtime diff --git a/service/ivsrealtime/types/types.go b/service/ivsrealtime/types/types.go index caa6a5065aa..5b77991e803 100644 --- a/service/ivsrealtime/types/types.go +++ b/service/ivsrealtime/types/types.go @@ -18,8 +18,8 @@ type ParticipantToken struct { // Set of capabilities that the user is allowed to perform in the stage. Capabilities []ParticipantTokenCapability - // Duration (in minutes), after which the participant token expires. Default: 60 (1 - // hour). + // Duration (in minutes), after which the participant token expires. Default: 60 + // (1 hour). Duration int32 // ISO 8601 timestamp (returned as a string) for when this token expires. @@ -56,8 +56,8 @@ type ParticipantTokenConfiguration struct { // Default: 60 (1 hour). Duration int32 - // Name that can be specified to help identify the corresponding participant token. - // This can be any UTF-8 encoded text. This field is exposed to all stage + // Name that can be specified to help identify the corresponding participant + // token. This can be any UTF-8 encoded text. This field is exposed to all stage // participants and should not be used for personally identifying, confidential, or // sensitive information. UserId *string @@ -80,11 +80,10 @@ type Stage struct { Name *string // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS has no constraints on tags beyond what is documented - // there. + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is + // documented there. Tags map[string]string noSmithyDocumentSerde @@ -105,11 +104,10 @@ type StageSummary struct { Name *string // Tags attached to the resource. Array of maps, each of the form string:string - // (key:value). See Tagging AWS Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) for details, - // including restrictions that apply to tags and "Tag naming limits and - // requirements"; Amazon IVS has no constraints on tags beyond what is documented - // there. + // (key:value) . See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is + // documented there. Tags map[string]string noSmithyDocumentSerde diff --git a/service/kafka/api_client.go b/service/kafka/api_client.go index fbcffa248ee..74af37d0811 100644 --- a/service/kafka/api_client.go +++ b/service/kafka/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "Kafka" const ServiceAPIVersion = "2018-11-14" -// Client provides the API client to make operations call for Managed Streaming for -// Kafka. +// Client provides the API client to make operations call for Managed Streaming +// for Kafka. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kafka/api_op_CreateConfiguration.go b/service/kafka/api_op_CreateConfiguration.go index 4231d5468be..78b55f53c7d 100644 --- a/service/kafka/api_op_CreateConfiguration.go +++ b/service/kafka/api_op_CreateConfiguration.go @@ -35,8 +35,8 @@ type CreateConfigurationInput struct { // This member is required. Name *string - // Contents of the server.properties file. When using the API, you must ensure that - // the contents of the file are base64 encoded. When using the AWS Management + // Contents of the server.properties file. When using the API, you must ensure + // that the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in // plaintext. // diff --git a/service/kafka/api_op_DescribeConfiguration.go b/service/kafka/api_op_DescribeConfiguration.go index 882f9b0f232..7eaca4bc659 100644 --- a/service/kafka/api_op_DescribeConfiguration.go +++ b/service/kafka/api_op_DescribeConfiguration.go @@ -30,8 +30,8 @@ func (c *Client) DescribeConfiguration(ctx context.Context, params *DescribeConf type DescribeConfigurationInput struct { - // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and - // all of its revisions. + // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration + // and all of its revisions. // // This member is required. Arn *string diff --git a/service/kafka/api_op_DescribeConfigurationRevision.go b/service/kafka/api_op_DescribeConfigurationRevision.go index 7e331259467..e31d5317df2 100644 --- a/service/kafka/api_op_DescribeConfigurationRevision.go +++ b/service/kafka/api_op_DescribeConfigurationRevision.go @@ -29,8 +29,8 @@ func (c *Client) DescribeConfigurationRevision(ctx context.Context, params *Desc type DescribeConfigurationRevisionInput struct { - // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and - // all of its revisions. + // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration + // and all of its revisions. // // This member is required. Arn *string @@ -57,8 +57,8 @@ type DescribeConfigurationRevisionOutput struct { // The revision number. Revision int64 - // Contents of the server.properties file. When using the API, you must ensure that - // the contents of the file are base64 encoded. When using the AWS Management + // Contents of the server.properties file. When using the API, you must ensure + // that the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in // plaintext. ServerProperties []byte diff --git a/service/kafka/api_op_GetBootstrapBrokers.go b/service/kafka/api_op_GetBootstrapBrokers.go index 41624683314..10fbf591af2 100644 --- a/service/kafka/api_op_GetBootstrapBrokers.go +++ b/service/kafka/api_op_GetBootstrapBrokers.go @@ -41,8 +41,8 @@ type GetBootstrapBrokersOutput struct { // A string containing one or more hostname:port pairs. BootstrapBrokerString *string - // A string that contains one or more DNS names (or IP addresses) and SASL IAM port - // pairs. + // A string that contains one or more DNS names (or IP addresses) and SASL IAM + // port pairs. BootstrapBrokerStringPublicSaslIam *string // A string containing one or more DNS names (or IP) and Sasl Scram port pairs. @@ -51,8 +51,8 @@ type GetBootstrapBrokersOutput struct { // A string containing one or more DNS names (or IP) and TLS port pairs. BootstrapBrokerStringPublicTls *string - // A string that contains one or more DNS names (or IP addresses) and SASL IAM port - // pairs. + // A string that contains one or more DNS names (or IP addresses) and SASL IAM + // port pairs. BootstrapBrokerStringSaslIam *string // A string containing one or more DNS names (or IP) and Sasl Scram port pairs. diff --git a/service/kafka/api_op_ListClusterOperations.go b/service/kafka/api_op_ListClusterOperations.go index eb786d1c3ea..691e17d2455 100644 --- a/service/kafka/api_op_ListClusterOperations.go +++ b/service/kafka/api_op_ListClusterOperations.go @@ -40,8 +40,8 @@ type ListClusterOperationsInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string @@ -53,8 +53,8 @@ type ListClusterOperationsOutput struct { // An array of cluster operation information objects. ClusterOperationInfoList []types.ClusterOperationInfo - // If the response of ListClusterOperations is truncated, it returns a NextToken in - // the response. This Nexttoken should be sent in the subsequent request to + // If the response of ListClusterOperations is truncated, it returns a NextToken + // in the response. This Nexttoken should be sent in the subsequent request to // ListClusterOperations. NextToken *string diff --git a/service/kafka/api_op_ListClusters.go b/service/kafka/api_op_ListClusters.go index dae4c15ea2f..d673adc6045 100644 --- a/service/kafka/api_op_ListClusters.go +++ b/service/kafka/api_op_ListClusters.go @@ -38,8 +38,8 @@ type ListClustersInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_ListClustersV2.go b/service/kafka/api_op_ListClustersV2.go index 2599cda03fb..b81afd2ab98 100644 --- a/service/kafka/api_op_ListClustersV2.go +++ b/service/kafka/api_op_ListClustersV2.go @@ -30,8 +30,8 @@ func (c *Client) ListClustersV2(ctx context.Context, params *ListClustersV2Input type ListClustersV2Input struct { - // Specify a prefix of the names of the clusters that you want to list. The service - // lists all the clusters whose names start with this prefix. + // Specify a prefix of the names of the clusters that you want to list. The + // service lists all the clusters whose names start with this prefix. ClusterNameFilter *string // Specify either PROVISIONED or SERVERLESS. @@ -41,8 +41,8 @@ type ListClustersV2Input struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_ListConfigurationRevisions.go b/service/kafka/api_op_ListConfigurationRevisions.go index ddb82ec79ff..9eaad3a5ce7 100644 --- a/service/kafka/api_op_ListConfigurationRevisions.go +++ b/service/kafka/api_op_ListConfigurationRevisions.go @@ -30,8 +30,8 @@ func (c *Client) ListConfigurationRevisions(ctx context.Context, params *ListCon type ListConfigurationRevisionsInput struct { - // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and - // all of its revisions. + // The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration + // and all of its revisions. // // This member is required. Arn *string @@ -40,8 +40,8 @@ type ListConfigurationRevisionsInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_ListConfigurations.go b/service/kafka/api_op_ListConfigurations.go index a9fbb91d3d3..74003bead44 100644 --- a/service/kafka/api_op_ListConfigurations.go +++ b/service/kafka/api_op_ListConfigurations.go @@ -34,8 +34,8 @@ type ListConfigurationsInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_ListKafkaVersions.go b/service/kafka/api_op_ListKafkaVersions.go index fd10808d3ab..4c7a1f287fe 100644 --- a/service/kafka/api_op_ListKafkaVersions.go +++ b/service/kafka/api_op_ListKafkaVersions.go @@ -34,8 +34,8 @@ type ListKafkaVersionsInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_ListNodes.go b/service/kafka/api_op_ListNodes.go index b078006c4f5..5a2fc1a0c71 100644 --- a/service/kafka/api_op_ListNodes.go +++ b/service/kafka/api_op_ListNodes.go @@ -39,8 +39,8 @@ type ListNodesInput struct { // results, the response includes a NextToken parameter. MaxResults int32 - // The paginated results marker. When the result of the operation is truncated, the - // call returns NextToken in the response. To get the next batch, provide this + // The paginated results marker. When the result of the operation is truncated, + // the call returns NextToken in the response. To get the next batch, provide this // token in your next request. NextToken *string diff --git a/service/kafka/api_op_UntagResource.go b/service/kafka/api_op_UntagResource.go index 8f74d99c72b..6ab3a929389 100644 --- a/service/kafka/api_op_UntagResource.go +++ b/service/kafka/api_op_UntagResource.go @@ -36,20 +36,14 @@ type UntagResourceInput struct { // Tag keys must be unique for a given cluster. In addition, the following // restrictions apply: - // - // * Each tag key must be unique. If you add a tag with a key - // that's already in use, your new tag overwrites the existing key-value pair. - // - // * - // You can't start a tag key with aws: because this prefix is reserved for use by - // AWS. AWS creates tags that begin with this prefix on your behalf, but you can't - // edit or delete them. - // - // * Tag keys must be between 1 and 128 Unicode characters in - // length. - // - // * Tag keys must consist of the following characters: Unicode letters, - // digits, white space, and the following special characters: _ . / = + - @. + // - Each tag key must be unique. If you add a tag with a key that's already in + // use, your new tag overwrites the existing key-value pair. + // - You can't start a tag key with aws: because this prefix is reserved for use + // by AWS. AWS creates tags that begin with this prefix on your behalf, but you + // can't edit or delete them. + // - Tag keys must be between 1 and 128 Unicode characters in length. + // - Tag keys must consist of the following characters: Unicode letters, digits, + // white space, and the following special characters: _ . / = + - @. // // This member is required. TagKeys []string diff --git a/service/kafka/api_op_UpdateBrokerCount.go b/service/kafka/api_op_UpdateBrokerCount.go index b6d0e18516f..4ce964b79a2 100644 --- a/service/kafka/api_op_UpdateBrokerCount.go +++ b/service/kafka/api_op_UpdateBrokerCount.go @@ -33,8 +33,8 @@ type UpdateBrokerCountInput struct { // This member is required. ClusterArn *string - // The version of cluster to update from. A successful operation will then generate - // a new version. + // The version of cluster to update from. A successful operation will then + // generate a new version. // // This member is required. CurrentVersion *string diff --git a/service/kafka/api_op_UpdateBrokerStorage.go b/service/kafka/api_op_UpdateBrokerStorage.go index fe4ecea9b88..909bdab72cc 100644 --- a/service/kafka/api_op_UpdateBrokerStorage.go +++ b/service/kafka/api_op_UpdateBrokerStorage.go @@ -34,8 +34,8 @@ type UpdateBrokerStorageInput struct { // This member is required. ClusterArn *string - // The version of cluster to update from. A successful operation will then generate - // a new version. + // The version of cluster to update from. A successful operation will then + // generate a new version. // // This member is required. CurrentVersion *string diff --git a/service/kafka/api_op_UpdateConfiguration.go b/service/kafka/api_op_UpdateConfiguration.go index c374c4a84d3..f3c4963c665 100644 --- a/service/kafka/api_op_UpdateConfiguration.go +++ b/service/kafka/api_op_UpdateConfiguration.go @@ -34,8 +34,8 @@ type UpdateConfigurationInput struct { // This member is required. Arn *string - // Contents of the server.properties file. When using the API, you must ensure that - // the contents of the file are base64 encoded. When using the AWS Management + // Contents of the server.properties file. When using the API, you must ensure + // that the contents of the file are base64 encoded. When using the AWS Management // Console, the SDK, or the AWS CLI, the contents of server.properties can be in // plaintext. // diff --git a/service/kafka/api_op_UpdateStorage.go b/service/kafka/api_op_UpdateStorage.go index fdc0bfc6e1c..499b3eda83c 100644 --- a/service/kafka/api_op_UpdateStorage.go +++ b/service/kafka/api_op_UpdateStorage.go @@ -36,8 +36,8 @@ type UpdateStorageInput struct { // This member is required. ClusterArn *string - // The version of cluster to update from. A successful operation will then generate - // a new version. + // The version of cluster to update from. A successful operation will then + // generate a new version. // // This member is required. CurrentVersion *string diff --git a/service/kafka/types/enums.go b/service/kafka/types/enums.go index c59153ff7e8..d5a21224bf9 100644 --- a/service/kafka/types/enums.go +++ b/service/kafka/types/enums.go @@ -27,9 +27,9 @@ const ( ClientBrokerPlaintext ClientBroker = "PLAINTEXT" ) -// Values returns all known values for ClientBroker. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClientBroker. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClientBroker) Values() []ClientBroker { return []ClientBroker{ "TLS", @@ -52,9 +52,9 @@ const ( ClusterStateUpdating ClusterState = "UPDATING" ) -// Values returns all known values for ClusterState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClusterState) Values() []ClusterState { return []ClusterState{ "ACTIVE", diff --git a/service/kafka/types/types.go b/service/kafka/types/types.go index bf05132991e..e37d3b885ab 100644 --- a/service/kafka/types/types.go +++ b/service/kafka/types/types.go @@ -39,9 +39,9 @@ type BrokerLogs struct { // Describes the setup to be used for Apache Kafka broker nodes in the cluster. type BrokerNodeGroupInfo struct { - // The list of subnets to connect to in the client virtual private cloud (VPC). AWS - // creates elastic network interfaces inside these subnets. Client applications use - // elastic network interfaces to produce and consume data. Client subnets can't + // The list of subnets to connect to in the client virtual private cloud (VPC). + // AWS creates elastic network interfaces inside these subnets. Client applications + // use elastic network interfaces to produce and consume data. Client subnets can't // occupy the Availability Zone with ID use use1-az3. // // This member is required. @@ -92,8 +92,8 @@ type BrokerNodeInfo struct { // The virtual private cloud (VPC) of the client. ClientVpcIpAddress *string - // Information about the version of software currently deployed on the Apache Kafka - // brokers in the cluster. + // Information about the version of software currently deployed on the Apache + // Kafka brokers in the cluster. CurrentBrokerSoftwareInfo *BrokerSoftwareInfo // Endpoints for accessing the broker. @@ -205,8 +205,8 @@ type ClusterInfo struct { // The time when the cluster was created. CreationTime *time.Time - // Information about the version of software currently deployed on the Apache Kafka - // brokers in the cluster. + // Information about the version of software currently deployed on the Apache + // Kafka brokers in the cluster. CurrentBrokerSoftwareInfo *BrokerSoftwareInfo // The current version of the MSK cluster. @@ -218,8 +218,8 @@ type ClusterInfo struct { // Specifies which metrics are gathered for the MSK cluster. This property has the // following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and // PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these - // levels of monitoring, see Monitoring - // (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html). + // levels of monitoring, see Monitoring (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html) + // . EnhancedMonitoring EnhancedMonitoring LoggingInfo *LoggingInfo @@ -462,8 +462,8 @@ type EncryptionInTransit struct { // The default value is TLS_PLAINTEXT. ClientBroker ClientBroker - // When set to true, it indicates that data communication among the broker nodes of - // the cluster is encrypted. When set to false, the communication happens in + // When set to true, it indicates that data communication among the broker nodes + // of the cluster is encrypted. When set to false, the communication happens in // plaintext. The default value is true. InCluster bool @@ -713,8 +713,8 @@ type Provisioned struct { // The connection string to use to connect to the Apache ZooKeeper cluster. ZookeeperConnectString *string - // The connection string to use to connect to the Apache ZooKeeper cluster on a TLS - // port. + // The connection string to use to connect to the Apache ZooKeeper cluster on a + // TLS port. ZookeeperConnectStringTls *string noSmithyDocumentSerde @@ -771,8 +771,8 @@ type ProvisionedThroughput struct { // Provisioned throughput is enabled or not. Enabled bool - // Throughput value of the EBS volumes for the data drive on each kafka broker node - // in MiB per second. + // Throughput value of the EBS volumes for the data drive on each kafka broker + // node in MiB per second. VolumeThroughput int32 noSmithyDocumentSerde diff --git a/service/kafkaconnect/api_client.go b/service/kafkaconnect/api_client.go index 76ac9f156a7..bd58be27157 100644 --- a/service/kafkaconnect/api_client.go +++ b/service/kafkaconnect/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "KafkaConnect" const ServiceAPIVersion = "2021-09-14" -// Client provides the API client to make operations call for Managed Streaming for -// Kafka Connect. +// Client provides the API client to make operations call for Managed Streaming +// for Kafka Connect. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kafkaconnect/api_op_CreateConnector.go b/service/kafkaconnect/api_op_CreateConnector.go index 1496221b4b8..9419a553ff7 100644 --- a/service/kafkaconnect/api_op_CreateConnector.go +++ b/service/kafkaconnect/api_op_CreateConnector.go @@ -60,8 +60,8 @@ type CreateConnectorInput struct { // This member is required. KafkaClusterEncryptionInTransit *types.KafkaClusterEncryptionInTransit - // The version of Kafka Connect. It has to be compatible with both the Apache Kafka - // cluster's version and the plugins. + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. // // This member is required. KafkaConnectVersion *string diff --git a/service/kafkaconnect/api_op_DescribeConnector.go b/service/kafkaconnect/api_op_DescribeConnector.go index 117474ee6de..638e51e503f 100644 --- a/service/kafkaconnect/api_op_DescribeConnector.go +++ b/service/kafkaconnect/api_op_DescribeConnector.go @@ -75,8 +75,8 @@ type DescribeConnectorOutput struct { // Details of encryption in transit to the Apache Kafka cluster. KafkaClusterEncryptionInTransit *types.KafkaClusterEncryptionInTransitDescription - // The version of Kafka Connect. It has to be compatible with both the Apache Kafka - // cluster's version and the plugins. + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. KafkaConnectVersion *string // Details about delivering logs to Amazon CloudWatch Logs. diff --git a/service/kafkaconnect/api_op_ListCustomPlugins.go b/service/kafkaconnect/api_op_ListCustomPlugins.go index 7acaefe5926..27f0ed4b021 100644 --- a/service/kafkaconnect/api_op_ListCustomPlugins.go +++ b/service/kafkaconnect/api_op_ListCustomPlugins.go @@ -33,9 +33,9 @@ type ListCustomPluginsInput struct { // The maximum number of custom plugins to list in one response. MaxResults int32 - // If the response of a ListCustomPlugins operation is truncated, it will include a - // NextToken. Send this NextToken in a subsequent request to continue listing from - // where the previous operation left off. + // If the response of a ListCustomPlugins operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where the previous operation left off. NextToken *string noSmithyDocumentSerde @@ -46,9 +46,9 @@ type ListCustomPluginsOutput struct { // An array of custom plugin descriptions. CustomPlugins []types.CustomPluginSummary - // If the response of a ListCustomPlugins operation is truncated, it will include a - // NextToken. Send this NextToken in a subsequent request to continue listing from - // where the previous operation left off. + // If the response of a ListCustomPlugins operation is truncated, it will include + // a NextToken. Send this NextToken in a subsequent request to continue listing + // from where the previous operation left off. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/kafkaconnect/types/errors.go b/service/kafkaconnect/types/errors.go index b3d643e9de2..4375553f8dd 100644 --- a/service/kafkaconnect/types/errors.go +++ b/service/kafkaconnect/types/errors.go @@ -195,8 +195,8 @@ func (e *TooManyRequestsException) ErrorCode() string { } func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be -// validated. +// HTTP Status Code 401: Unauthorized request. The provided credentials couldn't +// be validated. type UnauthorizedException struct { Message *string diff --git a/service/kafkaconnect/types/types.go b/service/kafkaconnect/types/types.go index 520db710fd4..05fe520f5fc 100644 --- a/service/kafkaconnect/types/types.go +++ b/service/kafkaconnect/types/types.go @@ -217,8 +217,8 @@ type ConnectorSummary struct { // Details of encryption in transit to the Apache Kafka cluster. KafkaClusterEncryptionInTransit *KafkaClusterEncryptionInTransitDescription - // The version of Kafka Connect. It has to be compatible with both the Apache Kafka - // cluster's version and the plugins. + // The version of Kafka Connect. It has to be compatible with both the Apache + // Kafka cluster's version and the plugins. KafkaConnectVersion *string // The settings for delivering connector logs to Amazon CloudWatch Logs. @@ -707,8 +707,8 @@ type VpcDescription struct { noSmithyDocumentSerde } -// The configuration of the workers, which are the processes that run the connector -// logic. +// The configuration of the workers, which are the processes that run the +// connector logic. type WorkerConfiguration struct { // The revision of the worker configuration. diff --git a/service/kendra/api_client.go b/service/kendra/api_client.go index d09ae9a1531..4921a3bfbfa 100644 --- a/service/kendra/api_client.go +++ b/service/kendra/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kendra/api_op_AssociateEntitiesToExperience.go b/service/kendra/api_op_AssociateEntitiesToExperience.go index 8b26d1c5086..d524172d94a 100644 --- a/service/kendra/api_op_AssociateEntitiesToExperience.go +++ b/service/kendra/api_op_AssociateEntitiesToExperience.go @@ -14,8 +14,8 @@ import ( // Grants users or groups in your IAM Identity Center identity source access to // your Amazon Kendra experience. You can create an Amazon Kendra experience such // as a search application. For more information on creating a search application -// experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) AssociateEntitiesToExperience(ctx context.Context, params *AssociateEntitiesToExperienceInput, optFns ...func(*Options)) (*AssociateEntitiesToExperienceOutput, error) { if params == nil { params = &AssociateEntitiesToExperienceInput{} diff --git a/service/kendra/api_op_AssociatePersonasToEntities.go b/service/kendra/api_op_AssociatePersonasToEntities.go index e703bb0f914..8d81069fcc8 100644 --- a/service/kendra/api_op_AssociatePersonasToEntities.go +++ b/service/kendra/api_op_AssociatePersonasToEntities.go @@ -15,8 +15,8 @@ import ( // identity source with access to your Amazon Kendra experience. You can create an // Amazon Kendra experience such as a search application. For more information on // creating a search application experience, see Building a search experience with -// no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) AssociatePersonasToEntities(ctx context.Context, params *AssociatePersonasToEntitiesInput, optFns ...func(*Options)) (*AssociatePersonasToEntitiesOutput, error) { if params == nil { params = &AssociatePersonasToEntitiesInput{} @@ -44,11 +44,11 @@ type AssociatePersonasToEntitiesInput struct { // This member is required. IndexId *string - // The personas that define the specific permissions of users or groups in your IAM - // Identity Center identity source. The available personas or access roles are - // Owner and Viewer. For more information on these personas, see Providing access - // to your search page - // (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + // The personas that define the specific permissions of users or groups in your + // IAM Identity Center identity source. The available personas or access roles are + // Owner and Viewer . For more information on these personas, see Providing access + // to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience) + // . // // This member is required. Personas []types.EntityPersonaConfiguration diff --git a/service/kendra/api_op_BatchDeleteDocument.go b/service/kendra/api_op_BatchDeleteDocument.go index d0ce4581171..87e12fe4989 100644 --- a/service/kendra/api_op_BatchDeleteDocument.go +++ b/service/kendra/api_op_BatchDeleteDocument.go @@ -12,10 +12,10 @@ import ( ) // Removes one or more documents from an index. The documents must have been added -// with the BatchPutDocument API. The documents are deleted asynchronously. You can -// see the progress of the deletion by using Amazon Web Services CloudWatch. Any -// error messages related to the processing of the batch are sent to you CloudWatch -// log. +// with the BatchPutDocument API. The documents are deleted asynchronously. You +// can see the progress of the deletion by using Amazon Web Services CloudWatch. +// Any error messages related to the processing of the batch are sent to you +// CloudWatch log. func (c *Client) BatchDeleteDocument(ctx context.Context, params *BatchDeleteDocumentInput, optFns ...func(*Options)) (*BatchDeleteDocumentOutput, error) { if params == nil { params = &BatchDeleteDocumentInput{} diff --git a/service/kendra/api_op_BatchGetDocumentStatus.go b/service/kendra/api_op_BatchGetDocumentStatus.go index 83b3af12517..c4e9d76941e 100644 --- a/service/kendra/api_op_BatchGetDocumentStatus.go +++ b/service/kendra/api_op_BatchGetDocumentStatus.go @@ -12,16 +12,14 @@ import ( ) // Returns the indexing status for one or more documents submitted with the -// BatchPutDocument -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API. -// When you use the BatchPutDocument API, documents are indexed asynchronously. You -// can use the BatchGetDocumentStatus API to get the current status of a list of -// documents so that you can determine if they have been successfully indexed. You -// can also use the BatchGetDocumentStatus API to check the status of the -// BatchDeleteDocument -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) API. -// When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as -// the status. +// BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) +// API. When you use the BatchPutDocument API, documents are indexed +// asynchronously. You can use the BatchGetDocumentStatus API to get the current +// status of a list of documents so that you can determine if they have been +// successfully indexed. You can also use the BatchGetDocumentStatus API to check +// the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) +// API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND +// as the status. func (c *Client) BatchGetDocumentStatus(ctx context.Context, params *BatchGetDocumentStatusInput, optFns ...func(*Options)) (*BatchGetDocumentStatusOutput, error) { if params == nil { params = &BatchGetDocumentStatusInput{} @@ -45,8 +43,8 @@ type BatchGetDocumentStatusInput struct { // This member is required. DocumentInfoList []types.DocumentInfo - // The identifier of the index to add documents to. The index ID is returned by the - // CreateIndex (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) + // The identifier of the index to add documents to. The index ID is returned by + // the CreateIndex (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) // API. // // This member is required. diff --git a/service/kendra/api_op_BatchPutDocument.go b/service/kendra/api_op_BatchPutDocument.go index bef8921a7d3..1943b76708e 100644 --- a/service/kendra/api_op_BatchPutDocument.go +++ b/service/kendra/api_op_BatchPutDocument.go @@ -19,8 +19,8 @@ import ( // see the progress of the batch using Amazon Web Services CloudWatch. Any error // messages related to processing the batch are sent to your Amazon Web Services // CloudWatch log. For an example of ingesting inline documents using Python and -// Java SDKs, see Adding files directly to an index -// (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html). +// Java SDKs, see Adding files directly to an index (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html) +// . func (c *Client) BatchPutDocument(ctx context.Context, params *BatchPutDocumentInput, optFns ...func(*Options)) (*BatchPutDocumentOutput, error) { if params == nil { params = &BatchPutDocumentInput{} @@ -40,14 +40,10 @@ type BatchPutDocumentInput struct { // One or more documents to add to the index. Documents have the following file // size limits. - // - // * 50 MB total size for any file - // - // * 5 MB extracted text for any - // file - // - // For more information, see Quotas - // (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // - 50 MB total size for any file + // - 5 MB extracted text for any file + // For more information, see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) + // . // // This member is required. Documents []types.Document @@ -58,17 +54,17 @@ type BatchPutDocumentInput struct { // This member is required. IndexId *string - // Configuration information for altering your document metadata and content during - // the document ingestion process when you use the BatchPutDocument API. For more - // information on how to create, modify and delete document metadata, or make other - // content alterations when you ingest documents into Amazon Kendra, see - // Customizing document metadata during the ingestion process - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + // Configuration information for altering your document metadata and content + // during the document ingestion process when you use the BatchPutDocument API. + // For more information on how to create, modify and delete document metadata, or + // make other content alterations when you ingest documents into Amazon Kendra, see + // Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) + // . CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration // The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 - // bucket. For more information, see IAM access roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // bucket. For more information, see IAM access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . RoleArn *string noSmithyDocumentSerde @@ -76,13 +72,12 @@ type BatchPutDocumentInput struct { type BatchPutDocumentOutput struct { - // A list of documents that were not added to the index because the document failed - // a validation check. Each document contains an error message that indicates why - // the document couldn't be added to the index. If there was an error adding a - // document to an index the error is reported in your Amazon Web Services + // A list of documents that were not added to the index because the document + // failed a validation check. Each document contains an error message that + // indicates why the document couldn't be added to the index. If there was an error + // adding a document to an index the error is reported in your Amazon Web Services // CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon - // CloudWatch Logs - // (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html) + // CloudWatch Logs (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html) FailedDocuments []types.BatchPutDocumentResponseFailedDocument // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_CreateAccessControlConfiguration.go b/service/kendra/api_op_CreateAccessControlConfiguration.go index 616dc9dcb56..5d82cb90b1c 100644 --- a/service/kendra/api_op_CreateAccessControlConfiguration.go +++ b/service/kendra/api_op_CreateAccessControlConfiguration.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an access configuration for your documents. This includes user and group -// access information for your documents. This is useful for user context +// Creates an access configuration for your documents. This includes user and +// group access information for your documents. This is useful for user context // filtering, where search results are filtered based on the user or their group // access to documents. You can use this to re-configure your existing document // level access control without indexing all of your documents again. For example, @@ -26,14 +26,12 @@ import ( // configuration to allow access if the user returns to the company and re-joins // the 'top-secret' team. You can re-configure access control for your documents as // circumstances change. To apply your access control configuration to certain -// documents, you call the BatchPutDocument -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API -// with the AccessControlConfigurationId included in the Document -// (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you -// use an S3 bucket as a data source, you update the .metadata.json with the -// AccessControlConfigurationId and synchronize your data source. Amazon Kendra -// currently only supports access control configuration for S3 data sources and -// documents indexed using the BatchPutDocument API. +// documents, you call the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) +// API with the AccessControlConfigurationId included in the Document (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) +// object. If you use an S3 bucket as a data source, you update the .metadata.json +// with the AccessControlConfigurationId and synchronize your data source. Amazon +// Kendra currently only supports access control configuration for S3 data sources +// and documents indexed using the BatchPutDocument API. func (c *Client) CreateAccessControlConfiguration(ctx context.Context, params *CreateAccessControlConfigurationInput, optFns ...func(*Options)) (*CreateAccessControlConfigurationOutput, error) { if params == nil { params = &CreateAccessControlConfigurationInput{} @@ -75,9 +73,8 @@ type CreateAccessControlConfigurationInput struct { // A description for the access control configuration. Description *string - // The list of principal - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that - // define the hierarchy for which documents users should have access to. + // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access to. HierarchicalAccessControlList []types.HierarchicalPrincipal noSmithyDocumentSerde diff --git a/service/kendra/api_op_CreateDataSource.go b/service/kendra/api_op_CreateDataSource.go index 3445f8ddacf..068e6f13173 100644 --- a/service/kendra/api_op_CreateDataSource.go +++ b/service/kendra/api_op_CreateDataSource.go @@ -18,10 +18,10 @@ import ( // connector. CreateDataSource is a synchronous operation. The operation returns // 200 if the data source was successfully created. Otherwise, an exception is // raised. For an example of creating an index and data source using the Python -// SDK, see Getting started with Python SDK -// (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of -// creating an index and data source using the Java SDK, see Getting started with -// Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html). +// SDK, see Getting started with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html) +// . For an example of creating an index and data source using the Java SDK, see +// Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html) +// . func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error) { if params == nil { params = &CreateDataSourceInput{} @@ -49,45 +49,45 @@ type CreateDataSourceInput struct { // This member is required. Name *string - // The type of data source repository. For example, SHAREPOINT. + // The type of data source repository. For example, SHAREPOINT . // // This member is required. Type types.DataSourceType // A token that you provide to identify the request to create a data source - // connector. Multiple calls to the CreateDataSource API with the same client token - // will create only one data source connector. + // connector. Multiple calls to the CreateDataSource API with the same client + // token will create only one data source connector. ClientToken *string // Configuration information to connect to your data source repository. You can't - // specify the Configuration parameter when the Type parameter is set to CUSTOM. If - // you do, you receive a ValidationException exception. The Configuration parameter - // is required for all other data sources. + // specify the Configuration parameter when the Type parameter is set to CUSTOM . + // If you do, you receive a ValidationException exception. The Configuration + // parameter is required for all other data sources. Configuration *types.DataSourceConfiguration // Configuration information for altering document metadata and content during the // document ingestion process. For more information on how to create, modify and // delete document metadata, or make other content alterations when you ingest // documents into Amazon Kendra, see Customizing document metadata during the - // ingestion process - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + // ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) + // . CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration // A description for the data source connector. Description *string - // The code for a language. This allows you to support a language for all documents - // when creating the data source connector. English is supported by default. For - // more information on supported languages, including their codes, see Adding - // documents in languages other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // The code for a language. This allows you to support a language for all + // documents when creating the data source connector. English is supported by + // default. For more information on supported languages, including their codes, see + // Adding documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) + // . LanguageCode *string - // The Amazon Resource Name (ARN) of an IAM role with permission to access the data - // source and required resources. For more information, see IAM access roles for - // Amazon Kendra. (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). - // You can't specify the RoleArn parameter when the Type parameter is set to - // CUSTOM. If you do, you receive a ValidationException exception. The RoleArn + // The Amazon Resource Name (ARN) of an IAM role with permission to access the + // data source and required resources. For more information, see IAM access roles + // for Amazon Kendra. (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . You can't specify the RoleArn parameter when the Type parameter is set to + // CUSTOM . If you do, you receive a ValidationException exception. The RoleArn // parameter is required for all other data sources. RoleArn *string @@ -96,19 +96,19 @@ type CreateDataSourceInput struct { // not periodically update the index. You can call the StartDataSourceSyncJob API // to update the index. Specify a cron- format schedule string or an empty string // to indicate that the index is updated on demand. You can't specify the Schedule - // parameter when the Type parameter is set to CUSTOM. If you do, you receive a + // parameter when the Type parameter is set to CUSTOM . If you do, you receive a // ValidationException exception. Schedule *string - // A list of key-value pairs that identify or categorize the data source connector. - // You can also use tags to help control access to the data source connector. Tag - // keys and values can consist of Unicode letters, digits, white space, and any of - // the following symbols: _ . : / = + - @. + // A list of key-value pairs that identify or categorize the data source + // connector. You can also use tags to help control access to the data source + // connector. Tag keys and values can consist of Unicode letters, digits, white + // space, and any of the following symbols: _ . : / = + - @. Tags []types.Tag - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // data source. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *types.DataSourceVpcConfiguration noSmithyDocumentSerde diff --git a/service/kendra/api_op_CreateExperience.go b/service/kendra/api_op_CreateExperience.go index e3ca3174999..b8e61bea0f1 100644 --- a/service/kendra/api_op_CreateExperience.go +++ b/service/kendra/api_op_CreateExperience.go @@ -14,8 +14,8 @@ import ( // Creates an Amazon Kendra experience such as a search application. For more // information on creating a search application experience, including using the -// Python and Java SDKs, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// Python and Java SDKs, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) CreateExperience(ctx context.Context, params *CreateExperienceInput, optFns ...func(*Options)) (*CreateExperienceOutput, error) { if params == nil { params = &CreateExperienceInput{} @@ -49,8 +49,8 @@ type CreateExperienceInput struct { ClientToken *string // Configuration information for your Amazon Kendra experience. This includes - // ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, - // and UserIdentityConfiguration, which specifies the user or group information to + // ContentSourceConfiguration , which specifies the data source IDs and/or FAQ IDs, + // and UserIdentityConfiguration , which specifies the user or group information to // grant access to your Amazon Kendra experience. Configuration *types.ExperienceConfiguration @@ -61,8 +61,8 @@ type CreateExperienceInput struct { // API, GetQuerySuggestions API, and other required APIs. The role also must // include permission to access IAM Identity Center (successor to Single Sign-On) // that stores your user and group information. For more information, see IAM - // access roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . RoleArn *string noSmithyDocumentSerde diff --git a/service/kendra/api_op_CreateFaq.go b/service/kendra/api_op_CreateFaq.go index 28484ed65e9..182265d46d2 100644 --- a/service/kendra/api_op_CreateFaq.go +++ b/service/kendra/api_op_CreateFaq.go @@ -15,8 +15,8 @@ import ( // Creates a set of frequently ask questions (FAQs) using a specified FAQ file // stored in an Amazon S3 bucket. Adding FAQs to an index is an asynchronous // operation. For an example of adding an FAQ to an index using Python and Java -// SDKs, see Using your FAQ file -// (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file). +// SDKs, see Using your FAQ file (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file) +// . func (c *Client) CreateFaq(ctx context.Context, params *CreateFaqInput, optFns ...func(*Options)) (*CreateFaqOutput, error) { if params == nil { params = &CreateFaqInput{} @@ -46,7 +46,7 @@ type CreateFaqInput struct { // The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 // bucket that contains the FAQs. For more information, see IAM access roles for - // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) . // // This member is required. RoleArn *string @@ -56,8 +56,9 @@ type CreateFaqInput struct { // This member is required. S3Path *types.S3Path - // A token that you provide to identify the request to create a FAQ. Multiple calls - // to the CreateFaqRequest API with the same client token will create only one FAQ. + // A token that you provide to identify the request to create a FAQ. Multiple + // calls to the CreateFaqRequest API with the same client token will create only + // one FAQ. ClientToken *string // A description for the FAQ. @@ -67,14 +68,14 @@ type CreateFaqInput struct { // CSV format that includes customs attributes in a header, and a JSON format that // includes custom attributes. The format must match the format of the file stored // in the S3 bucket identified in the S3Path parameter. For more information, see - // Adding questions and answers - // (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html). + // Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html) + // . FileFormat types.FaqFileFormat // The code for a language. This allows you to support a language for the FAQ // document. English is supported by default. For more information on supported // languages, including their codes, see Adding documents in languages other than - // English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) . LanguageCode *string // A list of key-value pairs that identify the FAQ. You can use the tags to diff --git a/service/kendra/api_op_CreateFeaturedResultsSet.go b/service/kendra/api_op_CreateFeaturedResultsSet.go index 33409601eba..1cdcd640030 100644 --- a/service/kendra/api_op_CreateFeaturedResultsSet.go +++ b/service/kendra/api_op_CreateFeaturedResultsSet.go @@ -16,8 +16,8 @@ import ( // You map specific queries to specific documents for featuring in the results. If // a query contains an exact match, then one or more specific documents are // featured in the search results. You can create up to 50 sets of featured results -// per index. You can request to increase this limit by contacting Support -// (http://aws.amazon.com/contact-us/). +// per index. You can request to increase this limit by contacting Support (http://aws.amazon.com/contact-us/) +// . func (c *Client) CreateFeaturedResultsSet(ctx context.Context, params *CreateFeaturedResultsSetInput, optFns ...func(*Options)) (*CreateFeaturedResultsSetOutput, error) { if params == nil { params = &CreateFeaturedResultsSetInput{} @@ -46,8 +46,8 @@ type CreateFeaturedResultsSetInput struct { IndexId *string // A token that you provide to identify the request to create a set of featured - // results. Multiple calls to the CreateFeaturedResultsSet API with the same client - // token will create only one featured results set. + // results. Multiple calls to the CreateFeaturedResultsSet API with the same + // client token will create only one featured results set. ClientToken *string // A description for the set of featured results. @@ -55,22 +55,21 @@ type CreateFeaturedResultsSetInput struct { // A list of document IDs for the documents you want to feature at the top of the // search results page. For more information on the list of documents, see - // FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . FeaturedDocuments []types.FeaturedDocument // A list of queries for featuring results. For more information on the list of - // queries, see FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . QueryTexts []string - // The current status of the set of featured results. When the value is ACTIVE, + // The current status of the set of featured results. When the value is ACTIVE , // featured results are ready for use. You can still configure your settings before - // setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using - // the UpdateFeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) + // setting the status to ACTIVE . You can set the status to ACTIVE or INACTIVE + // using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) // API. The queries you specify for featured results must be unique per featured - // results set for each index, whether the status is ACTIVE or INACTIVE. + // results set for each index, whether the status is ACTIVE or INACTIVE . Status types.FeaturedResultsSetStatus // A list of key-value pairs that identify or categorize the featured results set. diff --git a/service/kendra/api_op_CreateIndex.go b/service/kendra/api_op_CreateIndex.go index 13e174c0ba2..b41709aadcb 100644 --- a/service/kendra/api_op_CreateIndex.go +++ b/service/kendra/api_op_CreateIndex.go @@ -14,14 +14,14 @@ import ( // Creates an Amazon Kendra index. Index creation is an asynchronous API. To // determine if index creation has completed, check the Status field returned from -// a call to DescribeIndex. The Status field is set to ACTIVE when the index is +// a call to DescribeIndex . The Status field is set to ACTIVE when the index is // ready to use. Once the index is active you can index your documents using the // BatchPutDocument API or using one of the supported data sources. For an example // of creating an index and data source using the Python SDK, see Getting started -// with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). +// with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html) . // For an example of creating an index and data source using the Java SDK, see -// Getting started with Java SDK -// (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html). +// Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html) +// . func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { params = &CreateIndexInput{} @@ -46,7 +46,7 @@ type CreateIndexInput struct { // The Amazon Resource Name (ARN) of an IAM role with permission to access your // Amazon CloudWatch logs and metrics. For more information, see IAM access roles - // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) . // // This member is required. RoleArn *string @@ -63,13 +63,13 @@ type CreateIndexInput struct { // indexes intended for development, testing, or proof of concept. Use // ENTERPRISE_EDITION for production. Once you set the edition for an index, it // can't be changed. The Edition parameter is optional. If you don't supply a - // value, the default is ENTERPRISE_EDITION. For more information on quota limits - // for Enterprise and Developer editions, see Quotas - // (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // value, the default is ENTERPRISE_EDITION . For more information on quota limits + // for Enterprise and Developer editions, see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) + // . Edition types.IndexEdition - // The identifier of the KMS customer managed key (CMK) that's used to encrypt data - // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. + // The identifier of the KMS customer managed key (CMK) that's used to encrypt + // data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // A list of key-value pairs that identify or categorize the index. You can also @@ -81,15 +81,15 @@ type CreateIndexInput struct { // The user context policy. ATTRIBUTE_FILTER All indexed content is searchable and // displayable for all users. If you want to filter search results on user context, // you can use the attribute filters of _user_id and _group_ids or you can provide - // user and group information in UserContext. USER_TOKEN Enables token-based user + // user and group information in UserContext . USER_TOKEN Enables token-based user // access control to filter search results on user context. All documents with no // access control and all documents accessible to the user will be searchable and // displayable. UserContextPolicy types.UserContextPolicy // Gets users and groups from IAM Identity Center (successor to Single Sign-On) - // identity source. To configure this, see UserGroupResolutionConfiguration - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). + // identity source. To configure this, see UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html) + // . UserGroupResolutionConfiguration *types.UserGroupResolutionConfiguration // The user token configuration. @@ -100,8 +100,8 @@ type CreateIndexInput struct { type CreateIndexOutput struct { - // The identifier of the index. Use this identifier when you query an index, set up - // a data source, or index a document. + // The identifier of the index. Use this identifier when you query an index, set + // up a data source, or index a document. Id *string // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_CreateQuerySuggestionsBlockList.go b/service/kendra/api_op_CreateQuerySuggestionsBlockList.go index 8a25c234155..8187b5627f3 100644 --- a/service/kendra/api_op_CreateQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_CreateQuerySuggestionsBlockList.go @@ -12,17 +12,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a block list to exlcude certain queries from suggestions. Any query that -// contains words or phrases specified in the block list is blocked or filtered out -// from being shown as a suggestion. You need to provide the file location of your -// block list text file in your S3 bucket. In your text file, enter each block word -// or phrase on a separate line. For information on the current quota limits for -// block lists, see Quotas for Amazon Kendra -// (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). -// CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web +// Creates a block list to exlcude certain queries from suggestions. Any query +// that contains words or phrases specified in the block list is blocked or +// filtered out from being shown as a suggestion. You need to provide the file +// location of your block list text file in your S3 bucket. In your text file, +// enter each block word or phrase on a separate line. For information on the +// current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) +// . CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web // Services GovCloud (US-West) region. For an example of creating a block list for -// query suggestions using the Python SDK, see Query suggestions block list -// (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list). +// query suggestions using the Python SDK, see Query suggestions block list (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list) +// . func (c *Client) CreateQuerySuggestionsBlockList(ctx context.Context, params *CreateQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*CreateQuerySuggestionsBlockListOutput, error) { if params == nil { params = &CreateQuerySuggestionsBlockListInput{} @@ -55,16 +54,16 @@ type CreateQuerySuggestionsBlockListInput struct { // The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 // bucket that contains the block list text file. For more information, see IAM - // access roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . // // This member is required. RoleArn *string // The S3 path to your block list text file in your S3 bucket. Each block word or // phrase should be on a separate line in a text file. For information on the - // current quota limits for block lists, see Quotas for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) + // . // // This member is required. SourceS3Path *types.S3Path diff --git a/service/kendra/api_op_CreateThesaurus.go b/service/kendra/api_op_CreateThesaurus.go index 355e6230a1e..7f9855f2248 100644 --- a/service/kendra/api_op_CreateThesaurus.go +++ b/service/kendra/api_op_CreateThesaurus.go @@ -14,8 +14,8 @@ import ( // Creates a thesaurus for an index. The thesaurus contains a list of synonyms in // Solr format. For an example of adding a thesaurus file to an index, see Adding -// custom synonyms to an index -// (https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html). +// custom synonyms to an index (https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html) +// . func (c *Client) CreateThesaurus(ctx context.Context, params *CreateThesaurusInput, optFns ...func(*Options)) (*CreateThesaurusOutput, error) { if params == nil { params = &CreateThesaurusInput{} @@ -45,8 +45,8 @@ type CreateThesaurusInput struct { // The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 // bucket that contains the thesaurus file. For more information, see IAM access - // roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . // // This member is required. RoleArn *string @@ -56,9 +56,9 @@ type CreateThesaurusInput struct { // This member is required. SourceS3Path *types.S3Path - // A token that you provide to identify the request to create a thesaurus. Multiple - // calls to the CreateThesaurus API with the same client token will create only one - // thesaurus. + // A token that you provide to identify the request to create a thesaurus. + // Multiple calls to the CreateThesaurus API with the same client token will + // create only one thesaurus. ClientToken *string // A description for the thesaurus. diff --git a/service/kendra/api_op_DeleteDataSource.go b/service/kendra/api_op_DeleteDataSource.go index fbdfe7c2a70..7e004a9724c 100644 --- a/service/kendra/api_op_DeleteDataSource.go +++ b/service/kendra/api_op_DeleteDataSource.go @@ -13,8 +13,8 @@ import ( // Deletes an Amazon Kendra data source connector. An exception is not thrown if // the data source is already being deleted. While the data source is being // deleted, the Status field returned by a call to the DescribeDataSource API is -// set to DELETING. For more information, see Deleting Data Sources -// (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html). +// set to DELETING . For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html) +// . func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error) { if params == nil { params = &DeleteDataSourceInput{} diff --git a/service/kendra/api_op_DeleteExperience.go b/service/kendra/api_op_DeleteExperience.go index caa2afadf5a..82280074a1a 100644 --- a/service/kendra/api_op_DeleteExperience.go +++ b/service/kendra/api_op_DeleteExperience.go @@ -12,8 +12,8 @@ import ( // Deletes your Amazon Kendra experience such as a search application. For more // information on creating a search application experience, see Building a search -// experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) DeleteExperience(ctx context.Context, params *DeleteExperienceInput, optFns ...func(*Options)) (*DeleteExperienceOutput, error) { if params == nil { params = &DeleteExperienceInput{} diff --git a/service/kendra/api_op_DeleteIndex.go b/service/kendra/api_op_DeleteIndex.go index c02b39b2f57..c49db4f9585 100644 --- a/service/kendra/api_op_DeleteIndex.go +++ b/service/kendra/api_op_DeleteIndex.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing Amazon Kendra index. An exception is not thrown if the index -// is already being deleted. While the index is being deleted, the Status field -// returned by a call to the DescribeIndex API is set to DELETING. +// Deletes an existing Amazon Kendra index. An exception is not thrown if the +// index is already being deleted. While the index is being deleted, the Status +// field returned by a call to the DescribeIndex API is set to DELETING . func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optFns ...func(*Options)) (*DeleteIndexOutput, error) { if params == nil { params = &DeleteIndexInput{} diff --git a/service/kendra/api_op_DeletePrincipalMapping.go b/service/kendra/api_op_DeletePrincipalMapping.go index 60bd659b91e..417ca74f029 100644 --- a/service/kendra/api_op_DeletePrincipalMapping.go +++ b/service/kendra/api_op_DeletePrincipalMapping.go @@ -10,16 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a group so that all users and sub groups that belong to the group can no -// longer access documents only available to that group. For example, after +// Deletes a group so that all users and sub groups that belong to the group can +// no longer access documents only available to that group. For example, after // deleting the group "Summer Interns", all interns who belonged to that group no // longer see intern-only documents in their search results. If you want to delete // or replace users or sub groups of a group, you need to use the // PutPrincipalMapping operation. For example, if a user in the group "Engineering" // leaves the engineering team and another user takes their place, you provide an // updated list of users or sub groups that belong to the "Engineering" group when -// calling PutPrincipalMapping. You can update your internal list of users or sub -// groups and input this list when calling PutPrincipalMapping. +// calling PutPrincipalMapping . You can update your internal list of users or sub +// groups and input this list when calling PutPrincipalMapping . // DeletePrincipalMapping is currently not supported in the Amazon Web Services // GovCloud (US-West) region. func (c *Client) DeletePrincipalMapping(ctx context.Context, params *DeletePrincipalMappingInput, optFns ...func(*Options)) (*DeletePrincipalMappingOutput, error) { @@ -65,7 +65,7 @@ type DeletePrincipalMappingInput struct { // other actions with lower number IDs. This prevents previous actions with lower // number IDs from possibly overriding the latest action. The ordering ID can be // the Unix time of the last update you made to a group members list. You would - // then provide this list when calling PutPrincipalMapping. This ensures your + // then provide this list when calling PutPrincipalMapping . This ensures your // DELETE action for that updated group with the latest members list doesn't get // overwritten by earlier DELETE actions for the same group which are yet to be // processed. The default ordering ID is the current Unix time in milliseconds that diff --git a/service/kendra/api_op_DescribeAccessControlConfiguration.go b/service/kendra/api_op_DescribeAccessControlConfiguration.go index 06c820f4599..bb022ee5d32 100644 --- a/service/kendra/api_op_DescribeAccessControlConfiguration.go +++ b/service/kendra/api_op_DescribeAccessControlConfiguration.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about an access control configuration that you created for your -// documents in an index. This includes user and group access information for your -// documents. This is useful for user context filtering, where search results are -// filtered based on the user or their group access to documents. +// Gets information about an access control configuration that you created for +// your documents in an index. This includes user and group access information for +// your documents. This is useful for user context filtering, where search results +// are filtered based on the user or their group access to documents. func (c *Client) DescribeAccessControlConfiguration(ctx context.Context, params *DescribeAccessControlConfigurationInput, optFns ...func(*Options)) (*DescribeAccessControlConfigurationOutput, error) { if params == nil { params = &DescribeAccessControlConfigurationInput{} @@ -65,9 +65,8 @@ type DescribeAccessControlConfigurationOutput struct { // control configuration. ErrorMessage *string - // The list of principal - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that - // define the hierarchy for which documents users should have access to. + // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access to. HierarchicalAccessControlList []types.HierarchicalPrincipal // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_DescribeDataSource.go b/service/kendra/api_op_DescribeDataSource.go index 36db9b38adb..9ee8cc6e6c9 100644 --- a/service/kendra/api_op_DescribeDataSource.go +++ b/service/kendra/api_op_DescribeDataSource.go @@ -57,14 +57,14 @@ type DescribeDataSourceOutput struct { // document ingestion process when you describe a data source. For more information // on how to create, modify and delete document metadata, or make other content // alterations when you ingest documents into Amazon Kendra, see Customizing - // document metadata during the ingestion process - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + // document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) + // . CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration // The description for the data source connector. Description *string - // When the Status field value is FAILED, the ErrorMessage field contains a + // When the Status field value is FAILED , the ErrorMessage field contains a // description of the error that caused the data source to fail. ErrorMessage *string @@ -77,8 +77,8 @@ type DescribeDataSourceOutput struct { // The code for a language. This shows a supported language for all documents in // the data source. English is supported by default. For more information on // supported languages, including their codes, see Adding documents in languages - // other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) + // . LanguageCode *string // The name for the data source connector. @@ -92,19 +92,19 @@ type DescribeDataSourceOutput struct { Schedule *string // The current status of the data source connector. When the status is ACTIVE the - // data source is ready to use. When the status is FAILED, the ErrorMessage field + // data source is ready to use. When the status is FAILED , the ErrorMessage field // contains the reason that the data source failed. Status types.DataSourceStatus - // The type of the data source. For example, SHAREPOINT. + // The type of the data source. For example, SHAREPOINT . Type types.DataSourceType // The Unix timestamp when the data source connector was last updated. UpdatedAt *time.Time - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // data source. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *types.DataSourceVpcConfiguration // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_DescribeExperience.go b/service/kendra/api_op_DescribeExperience.go index f164efb097e..620b11a411d 100644 --- a/service/kendra/api_op_DescribeExperience.go +++ b/service/kendra/api_op_DescribeExperience.go @@ -14,8 +14,8 @@ import ( // Gets information about your Amazon Kendra experience such as a search // application. For more information on creating a search application experience, -// see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) DescribeExperience(ctx context.Context, params *DescribeExperienceInput, optFns ...func(*Options)) (*DescribeExperienceOutput, error) { if params == nil { params = &DescribeExperienceInput{} @@ -49,8 +49,8 @@ type DescribeExperienceInput struct { type DescribeExperienceOutput struct { // Shows the configuration information for your Amazon Kendra experience. This - // includes ContentSourceConfiguration, which specifies the data source IDs and/or - // FAQ IDs, and UserIdentityConfiguration, which specifies the user or group + // includes ContentSourceConfiguration , which specifies the data source IDs and/or + // FAQ IDs, and UserIdentityConfiguration , which specifies the user or group // information to grant access to your Amazon Kendra experience. Configuration *types.ExperienceConfiguration @@ -82,8 +82,8 @@ type DescribeExperienceOutput struct { RoleArn *string // The current processing status of your Amazon Kendra experience. When the status - // is ACTIVE, your Amazon Kendra experience is ready to use. When the status is - // FAILED, the ErrorMessage field contains the reason that this failed. + // is ACTIVE , your Amazon Kendra experience is ready to use. When the status is + // FAILED , the ErrorMessage field contains the reason that this failed. Status types.ExperienceStatus // The Unix timestamp when your Amazon Kendra experience was last updated. diff --git a/service/kendra/api_op_DescribeFaq.go b/service/kendra/api_op_DescribeFaq.go index f96e69e0296..52367b14e4b 100644 --- a/service/kendra/api_op_DescribeFaq.go +++ b/service/kendra/api_op_DescribeFaq.go @@ -51,7 +51,7 @@ type DescribeFaqOutput struct { // The description of the FAQ that you provided when it was created. Description *string - // If the Status field is FAILED, the ErrorMessage field contains the reason why + // If the Status field is FAILED , the ErrorMessage field contains the reason why // the FAQ failed. ErrorMessage *string @@ -66,21 +66,21 @@ type DescribeFaqOutput struct { // The code for a language. This shows a supported language for the FAQ document. // English is supported by default. For more information on supported languages, - // including their codes, see Adding documents in languages other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // including their codes, see Adding documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) + // . LanguageCode *string // The name that you gave the FAQ when it was created. Name *string - // The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket - // containing the input files for the FAQ. + // The Amazon Resource Name (ARN) of the role that provides access to the S3 + // bucket containing the input files for the FAQ. RoleArn *string // Information required to find a specific file in an Amazon S3 bucket. S3Path *types.S3Path - // The status of the FAQ. It is ready to use when the status is ACTIVE. + // The status of the FAQ. It is ready to use when the status is ACTIVE . Status types.FaqStatus // The Unix timestamp when the FAQ was last updated. diff --git a/service/kendra/api_op_DescribeFeaturedResultsSet.go b/service/kendra/api_op_DescribeFeaturedResultsSet.go index 6516cb61ce4..7c35da59592 100644 --- a/service/kendra/api_op_DescribeFeaturedResultsSet.go +++ b/service/kendra/api_op_DescribeFeaturedResultsSet.go @@ -56,15 +56,14 @@ type DescribeFeaturedResultsSetOutput struct { // The list of document IDs that don't exist but you have specified as featured // documents. Amazon Kendra cannot feature these documents if they don't exist in // the index. You can check the status of a document and its ID or check for - // documents with status errors using the BatchGetDocumentStatus - // (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) + // documents with status errors using the BatchGetDocumentStatus (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) // API. FeaturedDocumentsMissing []types.FeaturedDocumentMissing // The list of document IDs for the documents you want to feature with their // metadata information. For more information on the list of featured documents, - // see FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . FeaturedDocumentsWithMetadata []types.FeaturedDocumentWithMetadata // The identifier of the set of featured results. @@ -77,17 +76,16 @@ type DescribeFeaturedResultsSetOutput struct { LastUpdatedTimestamp *int64 // The list of queries for featuring results. For more information on the list of - // queries, see FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . QueryTexts []string - // The current status of the set of featured results. When the value is ACTIVE, + // The current status of the set of featured results. When the value is ACTIVE , // featured results are ready for use. You can still configure your settings before - // setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using - // the UpdateFeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) + // setting the status to ACTIVE . You can set the status to ACTIVE or INACTIVE + // using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) // API. The queries you specify for featured results must be unique per featured - // results set for each index, whether the status is ACTIVE or INACTIVE. + // results set for each index, whether the status is ACTIVE or INACTIVE . Status types.FeaturedResultsSetStatus // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_DescribeIndex.go b/service/kendra/api_op_DescribeIndex.go index fd60d8cb56d..40b74d3cab0 100644 --- a/service/kendra/api_op_DescribeIndex.go +++ b/service/kendra/api_op_DescribeIndex.go @@ -44,8 +44,8 @@ type DescribeIndexOutput struct { // meet the needs of your application. This contains the capacity units used for // the index. A query or document storage capacity of zero indicates that the index // is using the default capacity. For more information on the default capacity for - // an index and adjusting this, see Adjusting capacity - // (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html). + // an index and adjusting this, see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) + // . CapacityUnits *types.CapacityUnitsConfiguration // The Unix timestamp when the index was created. @@ -54,17 +54,17 @@ type DescribeIndexOutput struct { // The description for the index. Description *string - // Configuration information for document metadata or fields. Document metadata are - // fields or attributes associated with your documents. For example, the company - // department name associated with each document. + // Configuration information for document metadata or fields. Document metadata + // are fields or attributes associated with your documents. For example, the + // company department name associated with each document. DocumentMetadataConfigurations []types.DocumentMetadataConfiguration // The Amazon Kendra edition used for the index. You decide the edition when you // create the index. Edition types.IndexEdition - // When the Status field value is FAILED, the ErrorMessage field contains a message - // that explains why. + // When the Status field value is FAILED , the ErrorMessage field contains a + // message that explains why. ErrorMessage *string // The identifier of the index. @@ -85,9 +85,9 @@ type DescribeIndexOutput struct { // data. Amazon Kendra doesn't support asymmetric CMKs. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration - // The current status of the index. When the value is ACTIVE, the index is ready - // for use. If the Status field value is FAILED, the ErrorMessage field contains a - // message that explains why. + // The current status of the index. When the value is ACTIVE , the index is ready + // for use. If the Status field value is FAILED , the ErrorMessage field contains + // a message that explains why. Status types.IndexStatus // The Unix when the index was last updated. diff --git a/service/kendra/api_op_DescribePrincipalMapping.go b/service/kendra/api_op_DescribePrincipalMapping.go index c6f9ef636f2..775274786ef 100644 --- a/service/kendra/api_op_DescribePrincipalMapping.go +++ b/service/kendra/api_op_DescribePrincipalMapping.go @@ -66,20 +66,13 @@ type DescribePrincipalMappingOutput struct { // Shows the following information on the processing of PUT and DELETE actions for // mapping users to their groups: - // - // * Status—the status can be either PROCESSING, - // SUCCEEDED, DELETING, DELETED, or FAILED. - // - // * Last updated—the last date-time an - // action was updated. - // - // * Received—the last date-time an action was received or - // submitted. - // - // * Ordering ID—the latest action that should process and apply after - // other actions. - // - // * Failure reason—the reason an action could not be processed. + // - Status—the status can be either PROCESSING , SUCCEEDED , DELETING , DELETED + // , or FAILED . + // - Last updated—the last date-time an action was updated. + // - Received—the last date-time an action was received or submitted. + // - Ordering ID—the latest action that should process and apply after other + // actions. + // - Failure reason—the reason an action could not be processed. GroupOrderingIdSummaries []types.GroupOrderingIdSummary // Shows the identifier of the index to see information on the processing of PUT diff --git a/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go b/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go index 6bbb3bf76d5..38dee41b531 100644 --- a/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go @@ -83,10 +83,10 @@ type DescribeQuerySuggestionsBlockListOutput struct { // Shows the current S3 path to your block list text file in your S3 bucket. Each // block word or phrase should be on a separate line in a text file. For // information on the current quota limits for block lists, see Quotas for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) . SourceS3Path *types.S3Path - // The current status of the block list. When the value is ACTIVE, the block list + // The current status of the block list. When the value is ACTIVE , the block list // is ready for use. Status types.QuerySuggestionsBlockListStatus diff --git a/service/kendra/api_op_DescribeQuerySuggestionsConfig.go b/service/kendra/api_op_DescribeQuerySuggestionsConfig.go index 632bc888f16..152ae829285 100644 --- a/service/kendra/api_op_DescribeQuerySuggestionsConfig.go +++ b/service/kendra/api_op_DescribeQuerySuggestionsConfig.go @@ -12,8 +12,8 @@ import ( "time" ) -// Gets information on the settings of query suggestions for an index. This is used -// to check the current settings applied to query suggestions. +// Gets information on the settings of query suggestions for an index. This is +// used to check the current settings applied to query suggestions. // DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web // Services GovCloud (US-West) region. func (c *Client) DescribeQuerySuggestionsConfig(ctx context.Context, params *DescribeQuerySuggestionsConfigInput, optFns ...func(*Options)) (*DescribeQuerySuggestionsConfigOutput, error) { @@ -66,25 +66,24 @@ type DescribeQuerySuggestionsConfigOutput struct { MinimumQueryCount *int32 // Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By - // default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query + // default, Amazon Kendra enables query suggestions. LEARN_ONLY turns off query // suggestions for your users. You can change the mode using the - // UpdateQuerySuggestionsConfig - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) + // UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) // API. Mode types.Mode // How recent your queries are in your query log time window (in days). QueryLogLookBackWindowInDays *int32 - // Whether the status of query suggestions settings is currently ACTIVE or - // UPDATING. Active means the current settings apply and Updating means your - // changed settings are in the process of applying. + // Whether the status of query suggestions settings is currently ACTIVE or UPDATING + // . Active means the current settings apply and Updating means your changed + // settings are in the process of applying. Status types.QuerySuggestionsStatus - // The current total count of query suggestions for an index. This count can change - // when you update your query suggestions settings, if you filter out certain - // queries from suggestions using a block list, and as the query log accumulates - // more queries for Amazon Kendra to learn from. + // The current total count of query suggestions for an index. This count can + // change when you update your query suggestions settings, if you filter out + // certain queries from suggestions using a block list, and as the query log + // accumulates more queries for Amazon Kendra to learn from. TotalSuggestionsCount *int32 // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_DescribeThesaurus.go b/service/kendra/api_op_DescribeThesaurus.go index d23e7c3fb79..da8da7dfe77 100644 --- a/service/kendra/api_op_DescribeThesaurus.go +++ b/service/kendra/api_op_DescribeThesaurus.go @@ -51,7 +51,7 @@ type DescribeThesaurusOutput struct { // The thesaurus description. Description *string - // When the Status field value is FAILED, the ErrorMessage field provides more + // When the Status field value is FAILED , the ErrorMessage field provides more // information. ErrorMessage *string @@ -68,15 +68,15 @@ type DescribeThesaurusOutput struct { Name *string // An IAM role that gives Amazon Kendra permissions to access thesaurus file - // specified in SourceS3Path. + // specified in SourceS3Path . RoleArn *string // Information required to find a specific file in an Amazon S3 bucket. SourceS3Path *types.S3Path - // The current status of the thesaurus. When the value is ACTIVE, queries are able - // to use the thesaurus. If the Status field value is FAILED, the ErrorMessage - // field provides more information. If the status is ACTIVE_BUT_UPDATE_FAILED, it + // The current status of the thesaurus. When the value is ACTIVE , queries are able + // to use the thesaurus. If the Status field value is FAILED , the ErrorMessage + // field provides more information. If the status is ACTIVE_BUT_UPDATE_FAILED , it // means that Amazon Kendra could not ingest the new thesaurus file. The old // thesaurus file is still active. Status types.ThesaurusStatus @@ -85,7 +85,7 @@ type DescribeThesaurusOutput struct { SynonymRuleCount *int64 // The number of unique terms in the thesaurus file. For example, the synonyms - // a,b,c and a=>d, the term count would be 4. + // a,b,c and a=>d , the term count would be 4. TermCount *int64 // The Unix timestamp when the thesaurus was last updated. diff --git a/service/kendra/api_op_DisassociateEntitiesFromExperience.go b/service/kendra/api_op_DisassociateEntitiesFromExperience.go index 8573c34a899..d5aeaa62697 100644 --- a/service/kendra/api_op_DisassociateEntitiesFromExperience.go +++ b/service/kendra/api_op_DisassociateEntitiesFromExperience.go @@ -14,8 +14,8 @@ import ( // Prevents users or groups in your IAM Identity Center identity source from // accessing your Amazon Kendra experience. You can create an Amazon Kendra // experience such as a search application. For more information on creating a -// search application experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) DisassociateEntitiesFromExperience(ctx context.Context, params *DisassociateEntitiesFromExperienceInput, optFns ...func(*Options)) (*DisassociateEntitiesFromExperienceOutput, error) { if params == nil { params = &DisassociateEntitiesFromExperienceInput{} diff --git a/service/kendra/api_op_DisassociatePersonasFromEntities.go b/service/kendra/api_op_DisassociatePersonasFromEntities.go index 1e57aa74b2c..1d1227fec72 100644 --- a/service/kendra/api_op_DisassociatePersonasFromEntities.go +++ b/service/kendra/api_op_DisassociatePersonasFromEntities.go @@ -15,8 +15,8 @@ import ( // identity source with access to your Amazon Kendra experience. You can create an // Amazon Kendra experience such as a search application. For more information on // creating a search application experience, see Building a search experience with -// no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) DisassociatePersonasFromEntities(ctx context.Context, params *DisassociatePersonasFromEntitiesInput, optFns ...func(*Options)) (*DisassociatePersonasFromEntitiesOutput, error) { if params == nil { params = &DisassociatePersonasFromEntitiesInput{} diff --git a/service/kendra/api_op_GetSnapshots.go b/service/kendra/api_op_GetSnapshots.go index 2ac8474e54e..3b80eb13ea7 100644 --- a/service/kendra/api_op_GetSnapshots.go +++ b/service/kendra/api_op_GetSnapshots.go @@ -39,34 +39,26 @@ type GetSnapshotsInput struct { // The time interval or time window to get search metrics data. The time interval // uses the time zone of your index. You can view data in the following time // windows: - // - // * THIS_WEEK: The current week, starting on the Sunday and ending on - // the day before the current date. - // - // * ONE_WEEK_AGO: The previous week, starting on - // the Sunday and ending on the following Saturday. - // - // * TWO_WEEKS_AGO: The week - // before the previous week, starting on the Sunday and ending on the following - // Saturday. - // - // * THIS_MONTH: The current month, starting on the first day of the - // month and ending on the day before the current date. - // - // * ONE_MONTH_AGO: The - // previous month, starting on the first day of the month and ending on the last - // day of the month. - // - // * TWO_MONTHS_AGO: The month before the previous month, - // starting on the first day of the month and ending on last day of the month. + // - THIS_WEEK : The current week, starting on the Sunday and ending on the day + // before the current date. + // - ONE_WEEK_AGO : The previous week, starting on the Sunday and ending on the + // following Saturday. + // - TWO_WEEKS_AGO : The week before the previous week, starting on the Sunday + // and ending on the following Saturday. + // - THIS_MONTH : The current month, starting on the first day of the month and + // ending on the day before the current date. + // - ONE_MONTH_AGO : The previous month, starting on the first day of the month + // and ending on the last day of the month. + // - TWO_MONTHS_AGO : The month before the previous month, starting on the first + // day of the month and ending on last day of the month. // // This member is required. Interval types.Interval // The metric you want to retrieve. You can specify only one metric per call. For // more information about the metrics you can view, see Gaining insights with - // search analytics - // (https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html). + // search analytics (https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html) + // . // // This member is required. MetricType types.MetricType diff --git a/service/kendra/api_op_ListAccessControlConfigurations.go b/service/kendra/api_op_ListAccessControlConfigurations.go index f652ec1d946..9c2ef750445 100644 --- a/service/kendra/api_op_ListAccessControlConfigurations.go +++ b/service/kendra/api_op_ListAccessControlConfigurations.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists one or more access control configurations for an index. This includes user -// and group access information for your documents. This is useful for user context -// filtering, where search results are filtered based on the user or their group -// access to documents. +// Lists one or more access control configurations for an index. This includes +// user and group access information for your documents. This is useful for user +// context filtering, where search results are filtered based on the user or their +// group access to documents. func (c *Client) ListAccessControlConfigurations(ctx context.Context, params *ListAccessControlConfigurationsInput, optFns ...func(*Options)) (*ListAccessControlConfigurationsOutput, error) { if params == nil { params = &ListAccessControlConfigurationsInput{} @@ -41,9 +41,9 @@ type ListAccessControlConfigurationsInput struct { // The maximum number of access control configurations to return. MaxResults *int32 - // If the previous response was incomplete (because there's more data to retrieve), - // Amazon Kendra returns a pagination token in the response. You can use this - // pagination token to retrieve the next set of access control configurations. + // If the previous response was incomplete (because there's more data to + // retrieve), Amazon Kendra returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of access control configurations. NextToken *string noSmithyDocumentSerde diff --git a/service/kendra/api_op_ListEntityPersonas.go b/service/kendra/api_op_ListEntityPersonas.go index edc017807bf..a591e2f1769 100644 --- a/service/kendra/api_op_ListEntityPersonas.go +++ b/service/kendra/api_op_ListEntityPersonas.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists specific permissions of users and groups with access to your Amazon Kendra -// experience. +// Lists specific permissions of users and groups with access to your Amazon +// Kendra experience. func (c *Client) ListEntityPersonas(ctx context.Context, params *ListEntityPersonasInput, optFns ...func(*Options)) (*ListEntityPersonasOutput, error) { if params == nil { params = &ListEntityPersonasInput{} diff --git a/service/kendra/api_op_ListExperienceEntities.go b/service/kendra/api_op_ListExperienceEntities.go index 4b959c79ea0..e0ccc714017 100644 --- a/service/kendra/api_op_ListExperienceEntities.go +++ b/service/kendra/api_op_ListExperienceEntities.go @@ -15,8 +15,8 @@ import ( // Lists users or groups in your IAM Identity Center identity source that are // granted access to your Amazon Kendra experience. You can create an Amazon Kendra // experience such as a search application. For more information on creating a -// search application experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) ListExperienceEntities(ctx context.Context, params *ListExperienceEntitiesInput, optFns ...func(*Options)) (*ListExperienceEntitiesOutput, error) { if params == nil { params = &ListExperienceEntitiesInput{} diff --git a/service/kendra/api_op_ListExperiences.go b/service/kendra/api_op_ListExperiences.go index efa38d4ac3c..c661537ede8 100644 --- a/service/kendra/api_op_ListExperiences.go +++ b/service/kendra/api_op_ListExperiences.go @@ -14,8 +14,8 @@ import ( // Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra // experience such as a search application. For more information on creating a -// search application experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) ListExperiences(ctx context.Context, params *ListExperiencesInput, optFns ...func(*Options)) (*ListExperiencesOutput, error) { if params == nil { params = &ListExperiencesInput{} diff --git a/service/kendra/api_op_ListFaqs.go b/service/kendra/api_op_ListFaqs.go index fcafb384ca0..e207ead7306 100644 --- a/service/kendra/api_op_ListFaqs.go +++ b/service/kendra/api_op_ListFaqs.go @@ -35,8 +35,8 @@ type ListFaqsInput struct { // This member is required. IndexId *string - // The maximum number of FAQs to return in the response. If there are fewer results - // in the list, this response contains only the actual results. + // The maximum number of FAQs to return in the response. If there are fewer + // results in the list, this response contains only the actual results. MaxResults *int32 // If the previous response was incomplete (because there is more data to @@ -134,8 +134,8 @@ var _ ListFaqsAPIClient = (*Client)(nil) // ListFaqsPaginatorOptions is the paginator options for ListFaqs type ListFaqsPaginatorOptions struct { - // The maximum number of FAQs to return in the response. If there are fewer results - // in the list, this response contains only the actual results. + // The maximum number of FAQs to return in the response. If there are fewer + // results in the list, this response contains only the actual results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kendra/api_op_ListQuerySuggestionsBlockLists.go b/service/kendra/api_op_ListQuerySuggestionsBlockLists.go index a1aa9d9380a..5f3b2581941 100644 --- a/service/kendra/api_op_ListQuerySuggestionsBlockLists.go +++ b/service/kendra/api_op_ListQuerySuggestionsBlockLists.go @@ -13,9 +13,8 @@ import ( ) // Lists the block lists used for query suggestions for an index. For information -// on the current quota limits for block lists, see Quotas for Amazon Kendra -// (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). -// ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web +// on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) +// . ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web // Services GovCloud (US-West) region. func (c *Client) ListQuerySuggestionsBlockLists(ctx context.Context, params *ListQuerySuggestionsBlockListsInput, optFns ...func(*Options)) (*ListQuerySuggestionsBlockListsOutput, error) { if params == nil { @@ -36,7 +35,7 @@ type ListQuerySuggestionsBlockListsInput struct { // The identifier of the index for a list of all block lists that exist for that // index. For information on the current quota limits for block lists, see Quotas - // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) . // // This member is required. IndexId *string @@ -46,8 +45,8 @@ type ListQuerySuggestionsBlockListsInput struct { // If the previous response was incomplete (because there is more data to // retrieve), Amazon Kendra returns a pagination token in the response. You can use - // this pagination token to retrieve the next set of block lists - // (BlockListSummaryItems). + // this pagination token to retrieve the next set of block lists ( + // BlockListSummaryItems ). NextToken *string noSmithyDocumentSerde @@ -59,7 +58,7 @@ type ListQuerySuggestionsBlockListsOutput struct { // ID, block list name, when the block list was created, when the block list was // last updated, and the count of block words/phrases in the block list. For // information on the current quota limits for block lists, see Quotas for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) . BlockListSummaryItems []types.QuerySuggestionsBlockListSummary // If the response is truncated, Amazon Kendra returns this token that you can use diff --git a/service/kendra/api_op_ListThesauri.go b/service/kendra/api_op_ListThesauri.go index f3be9b3bdd1..9a71e08be7b 100644 --- a/service/kendra/api_op_ListThesauri.go +++ b/service/kendra/api_op_ListThesauri.go @@ -40,8 +40,8 @@ type ListThesauriInput struct { // If the previous response was incomplete (because there is more data to // retrieve), Amazon Kendra returns a pagination token in the response. You can use - // this pagination token to retrieve the next set of thesauri - // (ThesaurusSummaryItems). + // this pagination token to retrieve the next set of thesauri ( + // ThesaurusSummaryItems ). NextToken *string noSmithyDocumentSerde diff --git a/service/kendra/api_op_PutPrincipalMapping.go b/service/kendra/api_op_PutPrincipalMapping.go index d742cee74c2..f5eae15d45f 100644 --- a/service/kendra/api_op_PutPrincipalMapping.go +++ b/service/kendra/api_op_PutPrincipalMapping.go @@ -11,18 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Maps users to their groups so that you only need to provide the user ID when you -// issue the query. You can also map sub groups to groups. For example, the group -// "Company Intellectual Property Teams" includes sub groups "Research" and +// Maps users to their groups so that you only need to provide the user ID when +// you issue the query. You can also map sub groups to groups. For example, the +// group "Company Intellectual Property Teams" includes sub groups "Research" and // "Engineering". These sub groups include their own list of users or people who // work in these teams. Only users who work in research and engineering, and // therefore belong in the intellectual property group, can see top-secret company // documents in their search results. This is useful for user context filtering, // where search results are filtered based on the user or their group access to -// documents. For more information, see Filtering on user context -// (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). If more -// than five PUT actions for a group are currently processing, a validation -// exception is thrown. +// documents. For more information, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) +// . If more than five PUT actions for a group are currently processing, a +// validation exception is thrown. func (c *Client) PutPrincipalMapping(ctx context.Context, params *PutPrincipalMappingInput, optFns ...func(*Options)) (*PutPrincipalMappingOutput, error) { if params == nil { params = &PutPrincipalMappingInput{} @@ -61,9 +60,9 @@ type PutPrincipalMappingInput struct { // This member is required. IndexId *string - // The identifier of the data source you want to map users to their groups. This is - // useful if a group is tied to multiple data sources, but you only want the group - // to access documents of a certain data source. For example, the groups + // The identifier of the data source you want to map users to their groups. This + // is useful if a group is tied to multiple data sources, but you only want the + // group to access documents of a certain data source. For example, the groups // "Research", "Engineering", and "Sales and Marketing" are all tied to the // company's documents stored in the data sources Confluence and Salesforce. // However, "Sales and Marketing" team only needs access to customer-related @@ -71,22 +70,22 @@ type PutPrincipalMappingInput struct { DataSourceId *string // The timestamp identifier you specify to ensure Amazon Kendra does not override - // the latest PUT action with previous actions. The highest number ID, which is the - // ordering ID, is the latest action you want to process and apply on top of other - // actions with lower number IDs. This prevents previous actions with lower number - // IDs from possibly overriding the latest action. The ordering ID can be the Unix - // time of the last update you made to a group members list. You would then provide - // this list when calling PutPrincipalMapping. This ensures your PUT action for - // that updated group with the latest members list doesn't get overwritten by - // earlier PUT actions for the same group which are yet to be processed. The - // default ordering ID is the current Unix time in milliseconds that the action was - // received by Amazon Kendra. + // the latest PUT action with previous actions. The highest number ID, which is + // the ordering ID, is the latest action you want to process and apply on top of + // other actions with lower number IDs. This prevents previous actions with lower + // number IDs from possibly overriding the latest action. The ordering ID can be + // the Unix time of the last update you made to a group members list. You would + // then provide this list when calling PutPrincipalMapping . This ensures your PUT + // action for that updated group with the latest members list doesn't get + // overwritten by earlier PUT actions for the same group which are yet to be + // processed. The default ordering ID is the current Unix time in milliseconds that + // the action was received by Amazon Kendra. OrderingId *int64 // The Amazon Resource Name (ARN) of a role that has access to the S3 file that // contains your list of users or sub groups that belong to a group. For more - // information, see IAM roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds). + // information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds) + // . RoleArn *string noSmithyDocumentSerde diff --git a/service/kendra/api_op_Query.go b/service/kendra/api_op_Query.go index f022eda8509..be8237d131d 100644 --- a/service/kendra/api_op_Query.go +++ b/service/kendra/api_op_Query.go @@ -11,23 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches an active index. Use this API to search your documents using query. The -// Query API enables to do faceted search and to filter results based on document -// attributes. It also enables you to provide user context that Amazon Kendra uses -// to enforce document access control in the search results. Amazon Kendra searches -// your index for text content and question and answer (FAQ) content. By default -// the response contains three types of results. +// Searches an active index. Use this API to search your documents using query. +// The Query API enables to do faceted search and to filter results based on +// document attributes. It also enables you to provide user context that Amazon +// Kendra uses to enforce document access control in the search results. Amazon +// Kendra searches your index for text content and question and answer (FAQ) +// content. By default the response contains three types of results. +// - Relevant passages +// - Matching FAQs +// - Relevant documents // -// * Relevant passages -// -// * Matching -// FAQs -// -// * Relevant documents -// -// You can specify that the query return only one type -// of result using the QueryResultTypeFilter parameter. Each query returns the 100 -// most relevant results. +// You can specify that the query return only one type of result using the +// QueryResultTypeFilter parameter. Each query returns the 100 most relevant +// results. func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -51,8 +47,8 @@ type QueryInput struct { // This member is required. IndexId *string - // Enables filtered searches based on document attributes. You can only provide one - // attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters + // Enables filtered searches based on document attributes. You can only provide + // one attribute filter; however, the AndAllFilters , NotFilter , and OrAllFilters // parameters contain a list of other filters. The AttributeFilter parameter // enables you to create a set of filtering rules that a document must satisfy to // be included in the query results. @@ -87,9 +83,9 @@ type QueryInput struct { // Sets the type of query. Only results for the specified query type are returned. QueryResultTypeFilter types.QueryResultType - // The input query text for the search. Amazon Kendra truncates queries at 30 token - // words, which excludes punctuation and stop words. Truncation still applies if - // you use Boolean or more advanced, complex queries. + // The input query text for the search. Amazon Kendra truncates queries at 30 + // token words, which excludes punctuation and stop words. Truncation still applies + // if you use Boolean or more advanced, complex queries. QueryText *string // An array of document attributes to include in the response. You can limit the @@ -113,7 +109,7 @@ type QueryInput struct { // Provides an identifier for a specific user. The VisitorId should be a unique // identifier, such as a GUID. Don't use personally identifiable information, such - // as the user's email address, as the VisitorId. + // as the user's email address, as the VisitorId . VisitorId *string noSmithyDocumentSerde @@ -121,8 +117,8 @@ type QueryInput struct { type QueryOutput struct { - // Contains the facet results. A FacetResult contains the counts for each attribute - // key that was specified in the Facets input parameter. + // Contains the facet results. A FacetResult contains the counts for each + // attribute key that was specified in the Facets input parameter. FacetResults []types.FacetResult // The list of featured result items. Featured results are displayed at the top of @@ -131,8 +127,8 @@ type QueryOutput struct { // search results. FeaturedResultsItems []types.FeaturedResultsItem - // The identifier for the search. You use QueryId to identify the search when using - // the feedback API. + // The identifier for the search. You use QueryId to identify the search when + // using the feedback API. QueryId *string // The results of the search. @@ -141,16 +137,16 @@ type QueryOutput struct { // A list of information related to suggested spell corrections for a query. SpellCorrectedQueries []types.SpellCorrectedQuery - // The total number of items found by the search; however, you can only retrieve up - // to 100 items. For example, if the search found 192 items, you can only retrieve - // the first 100 of the items. + // The total number of items found by the search; however, you can only retrieve + // up to 100 items. For example, if the search found 192 items, you can only + // retrieve the first 100 of the items. TotalNumberOfResults *int32 // A list of warning codes and their messages on problems with your query. Amazon // Kendra currently only supports one type of warning, which is a warning on // invalid syntax used in the query. For examples of invalid query syntax, see - // Searching with advanced query syntax - // (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax). + // Searching with advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax) + // . Warnings []types.Warning // Metadata pertaining to the operation's result. diff --git a/service/kendra/api_op_SubmitFeedback.go b/service/kendra/api_op_SubmitFeedback.go index e7e08ca29af..375b6111e98 100644 --- a/service/kendra/api_op_SubmitFeedback.go +++ b/service/kendra/api_op_SubmitFeedback.go @@ -12,8 +12,8 @@ import ( ) // Enables you to provide feedback to Amazon Kendra to improve the performance of -// your index. SubmitFeedback is currently not supported in the Amazon Web Services -// GovCloud (US-West) region. +// your index. SubmitFeedback is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. func (c *Client) SubmitFeedback(ctx context.Context, params *SubmitFeedbackInput, optFns ...func(*Options)) (*SubmitFeedbackOutput, error) { if params == nil { params = &SubmitFeedbackInput{} diff --git a/service/kendra/api_op_UpdateAccessControlConfiguration.go b/service/kendra/api_op_UpdateAccessControlConfiguration.go index d62eeff02ca..beaf131a1c7 100644 --- a/service/kendra/api_op_UpdateAccessControlConfiguration.go +++ b/service/kendra/api_op_UpdateAccessControlConfiguration.go @@ -23,15 +23,13 @@ import ( // suddenly returns to their previous team and should no longer have access to top // secret documents. You can update the access control configuration to // re-configure access control for your documents as circumstances change. You call -// the BatchPutDocument -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API to -// apply the updated access control configuration, with the -// AccessControlConfigurationId included in the Document -// (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you -// use an S3 bucket as a data source, you synchronize your data source to apply the -// AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently -// only supports access control configuration for S3 data sources and documents -// indexed using the BatchPutDocument API. +// the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) +// API to apply the updated access control configuration, with the +// AccessControlConfigurationId included in the Document (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) +// object. If you use an S3 bucket as a data source, you synchronize your data +// source to apply the AccessControlConfigurationId in the .metadata.json file. +// Amazon Kendra currently only supports access control configuration for S3 data +// sources and documents indexed using the BatchPutDocument API. func (c *Client) UpdateAccessControlConfiguration(ctx context.Context, params *UpdateAccessControlConfigurationInput, optFns ...func(*Options)) (*UpdateAccessControlConfigurationOutput, error) { if params == nil { params = &UpdateAccessControlConfigurationInput{} @@ -68,9 +66,8 @@ type UpdateAccessControlConfigurationInput struct { // A new description for the access control configuration. Description *string - // The updated list of principal - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that - // define the hierarchy for which documents users should have access to. + // The updated list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access to. HierarchicalAccessControlList []types.HierarchicalPrincipal // A new name for the access control configuration. diff --git a/service/kendra/api_op_UpdateDataSource.go b/service/kendra/api_op_UpdateDataSource.go index ae26163b79f..b2c17d953f7 100644 --- a/service/kendra/api_op_UpdateDataSource.go +++ b/service/kendra/api_op_UpdateDataSource.go @@ -46,8 +46,8 @@ type UpdateDataSourceInput struct { // content during the document ingestion process. For more information on how to // create, modify and delete document metadata, or make other content alterations // when you ingest documents into Amazon Kendra, see Customizing document metadata - // during the ingestion process - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). + // during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) + // . CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration // A new description for the data source connector. @@ -57,7 +57,7 @@ type UpdateDataSourceInput struct { // allows you to support a language for all documents when updating the data // source. English is supported by default. For more information on supported // languages, including their codes, see Adding documents in languages other than - // English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) . LanguageCode *string // A new name for the data source connector. @@ -65,15 +65,15 @@ type UpdateDataSourceInput struct { // The Amazon Resource Name (ARN) of a role with permission to access the data // source and required resources. For more information, see IAM roles for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) . RoleArn *string // The sync schedule you want to update for the data source connector. Schedule *string - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // data source. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *types.DataSourceVpcConfiguration noSmithyDocumentSerde diff --git a/service/kendra/api_op_UpdateExperience.go b/service/kendra/api_op_UpdateExperience.go index d354a9e8b1f..11158cebada 100644 --- a/service/kendra/api_op_UpdateExperience.go +++ b/service/kendra/api_op_UpdateExperience.go @@ -13,8 +13,8 @@ import ( // Updates your Amazon Kendra experience such as a search application. For more // information on creating a search application experience, see Building a search -// experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . func (c *Client) UpdateExperience(ctx context.Context, params *UpdateExperienceInput, optFns ...func(*Options)) (*UpdateExperienceOutput, error) { if params == nil { params = &UpdateExperienceInput{} @@ -54,7 +54,7 @@ type UpdateExperienceInput struct { // The Amazon Resource Name (ARN) of a role with permission to access Query API, // QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores // your user and group information. For more information, see IAM roles for Amazon - // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) . RoleArn *string noSmithyDocumentSerde diff --git a/service/kendra/api_op_UpdateFeaturedResultsSet.go b/service/kendra/api_op_UpdateFeaturedResultsSet.go index c70e95c3c6b..4eb9168bdcf 100644 --- a/service/kendra/api_op_UpdateFeaturedResultsSet.go +++ b/service/kendra/api_op_UpdateFeaturedResultsSet.go @@ -47,23 +47,23 @@ type UpdateFeaturedResultsSetInput struct { // A list of document IDs for the documents you want to feature at the top of the // search results page. For more information on the list of featured documents, see - // FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . FeaturedDocuments []types.FeaturedDocument // A new name for the set of featured results. FeaturedResultsSetName *string // A list of queries for featuring results. For more information on the list of - // queries, see FeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html). + // queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html) + // . QueryTexts []string - // You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured - // results are ready for use. You can still configure your settings before setting - // the status to ACTIVE. The queries you specify for featured results must be - // unique per featured results set for each index, whether the status is ACTIVE or - // INACTIVE. + // You can set the status to ACTIVE or INACTIVE . When the value is ACTIVE , + // featured results are ready for use. You can still configure your settings before + // setting the status to ACTIVE . The queries you specify for featured results must + // be unique per featured results set for each index, whether the status is ACTIVE + // or INACTIVE . Status types.FeaturedResultsSetStatus noSmithyDocumentSerde diff --git a/service/kendra/api_op_UpdateIndex.go b/service/kendra/api_op_UpdateIndex.go index caa66e71fe5..48f19da2ef1 100644 --- a/service/kendra/api_op_UpdateIndex.go +++ b/service/kendra/api_op_UpdateIndex.go @@ -52,8 +52,8 @@ type UpdateIndexInput struct { // The name of the index you want to update. Name *string - // An Identity and Access Management (IAM) role that gives Amazon Kendra permission - // to access Amazon CloudWatch logs and metrics. + // An Identity and Access Management (IAM) role that gives Amazon Kendra + // permission to access Amazon CloudWatch logs and metrics. RoleArn *string // The user context policy. @@ -61,8 +61,8 @@ type UpdateIndexInput struct { // Enables fetching access levels of groups and users from an IAM Identity Center // (successor to Single Sign-On) identity source. To configure this, see - // UserGroupResolutionConfiguration - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). + // UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html) + // . UserGroupResolutionConfiguration *types.UserGroupResolutionConfiguration // The user token configuration. diff --git a/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go b/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go index 054acf84e97..b6231ff0d1e 100644 --- a/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a block list used for query suggestions for an index. Updates to a block -// list might not take effect right away. Amazon Kendra needs to refresh the entire -// suggestions list to apply any updates to the block list. Other changes not -// related to the block list apply immediately. If a block list is updating, then -// you need to wait for the first update to finish before submitting another +// Updates a block list used for query suggestions for an index. Updates to a +// block list might not take effect right away. Amazon Kendra needs to refresh the +// entire suggestions list to apply any updates to the block list. Other changes +// not related to the block list apply immediately. If a block list is updating, +// then you need to wait for the first update to finish before submitting another // update. Amazon Kendra supports partial updates, so you only need to provide the // fields you want to update. UpdateQuerySuggestionsBlockList is currently not // supported in the Amazon Web Services GovCloud (US-West) region. @@ -52,13 +52,13 @@ type UpdateQuerySuggestionsBlockListInput struct { // A new name for the block list. Name *string - // The IAM (Identity and Access Management) role used to access the block list text - // file in S3. + // The IAM (Identity and Access Management) role used to access the block list + // text file in S3. RoleArn *string - // The S3 path where your block list text file sits in S3. If you update your block - // list and provide the same path to the block list text file in S3, then Amazon - // Kendra reloads the file to refresh the block list. Amazon Kendra does not + // The S3 path where your block list text file sits in S3. If you update your + // block list and provide the same path to the block list text file in S3, then + // Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not // automatically refresh your block list. You need to call the // UpdateQuerySuggestionsBlockList API to refresh you block list. If you update // your block list, then Amazon Kendra asynchronously refreshes all query diff --git a/service/kendra/api_op_UpdateQuerySuggestionsConfig.go b/service/kendra/api_op_UpdateQuerySuggestionsConfig.go index 7beaf052809..62f3f56ba0e 100644 --- a/service/kendra/api_op_UpdateQuerySuggestionsConfig.go +++ b/service/kendra/api_op_UpdateQuerySuggestionsConfig.go @@ -42,14 +42,14 @@ type UpdateQuerySuggestionsConfigInput struct { // This member is required. IndexId *string - // TRUE to include queries without user information (i.e. all queries, irrespective - // of the user), otherwise FALSE to only include queries with user information. If - // you pass user information to Amazon Kendra along with the queries, you can set - // this flag to FALSE and instruct Amazon Kendra to only consider queries with user - // information. If you set to FALSE, Amazon Kendra only considers queries searched - // at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique - // users for suggestions. If you set to TRUE, Amazon Kendra ignores all user - // information and learns from all queries. + // TRUE to include queries without user information (i.e. all queries, + // irrespective of the user), otherwise FALSE to only include queries with user + // information. If you pass user information to Amazon Kendra along with the + // queries, you can set this flag to FALSE and instruct Amazon Kendra to only + // consider queries with user information. If you set to FALSE , Amazon Kendra only + // considers queries searched at least MinimumQueryCount times across + // MinimumNumberOfQueryingUsers unique users for suggestions. If you set to TRUE , + // Amazon Kendra ignores all user information and learns from all queries. IncludeQueriesWithoutUserInformation *bool // The minimum number of unique users who must search a query in order for the @@ -59,18 +59,18 @@ type UpdateQuerySuggestionsConfigInput struct { // depends on your specific needs. MinimumNumberOfQueryingUsers *int32 - // The the minimum number of times a query must be searched in order to be eligible - // to suggest to your users. Decreasing this number increases the number of - // suggestions. However, this affects the quality of suggestions as it sets a low - // bar for a query to be considered popular to suggest to users. How you tune this - // setting depends on your specific needs. + // The the minimum number of times a query must be searched in order to be + // eligible to suggest to your users. Decreasing this number increases the number + // of suggestions. However, this affects the quality of suggestions as it sets a + // low bar for a query to be considered popular to suggest to users. How you tune + // this setting depends on your specific needs. MinimumQueryCount *int32 - // Set the mode to ENABLED or LEARN_ONLY. By default, Amazon Kendra enables query + // Set the mode to ENABLED or LEARN_ONLY . By default, Amazon Kendra enables query // suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can - // to update this at any time. In LEARN_ONLY mode, Amazon Kendra continues to learn - // from new queries to keep suggestions up to date for when you are ready to switch - // to ENABLED mode again. + // to update this at any time. In LEARN_ONLY mode, Amazon Kendra continues to + // learn from new queries to keep suggestions up to date for when you are ready to + // switch to ENABLED mode again. Mode types.Mode // How recent your queries are in your query log time window. The time window is diff --git a/service/kendra/api_op_UpdateThesaurus.go b/service/kendra/api_op_UpdateThesaurus.go index 05c8bfcc8f3..3361e177c59 100644 --- a/service/kendra/api_op_UpdateThesaurus.go +++ b/service/kendra/api_op_UpdateThesaurus.go @@ -46,7 +46,7 @@ type UpdateThesaurusInput struct { Name *string // An IAM role that gives Amazon Kendra permissions to access thesaurus file - // specified in SourceS3Path. + // specified in SourceS3Path . RoleArn *string // Information required to find a specific file in an Amazon S3 bucket. diff --git a/service/kendra/document/document.go b/service/kendra/document/document.go index 394ba084ef8..8e8d013a482 100644 --- a/service/kendra/document/document.go +++ b/service/kendra/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/kendra/types/enums.go b/service/kendra/types/enums.go index 9acbd0eeefa..c5a3ade56bd 100644 --- a/service/kendra/types/enums.go +++ b/service/kendra/types/enums.go @@ -120,9 +120,10 @@ const ( ConfluenceAuthenticationTypePat ConfluenceAuthenticationType = "PAT" ) -// Values returns all known values for ConfluenceAuthenticationType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConfluenceAuthenticationType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ConfluenceAuthenticationType) Values() []ConfluenceAuthenticationType { return []ConfluenceAuthenticationType{ "HTTP_BASIC", @@ -210,9 +211,9 @@ const ( ConfluenceSpaceFieldNameUrl ConfluenceSpaceFieldName = "URL" ) -// Values returns all known values for ConfluenceSpaceFieldName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConfluenceSpaceFieldName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluenceSpaceFieldName) Values() []ConfluenceSpaceFieldName { return []ConfluenceSpaceFieldName{ "DISPLAY_URL", @@ -459,9 +460,9 @@ const ( EndpointTypeHome EndpointType = "HOME" ) -// Values returns all known values for EndpointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndpointType) Values() []EndpointType { return []EndpointType{ "HOME", @@ -494,9 +495,9 @@ const ( ErrorCodeInvalidRequest ErrorCode = "InvalidRequest" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "InternalError", @@ -557,9 +558,9 @@ const ( FaqStatusFailed FaqStatus = "FAILED" ) -// Values returns all known values for FaqStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FaqStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FaqStatus) Values() []FaqStatus { return []FaqStatus{ "CREATING", @@ -578,9 +579,9 @@ const ( FeaturedResultsSetStatusInactive FeaturedResultsSetStatus = "INACTIVE" ) -// Values returns all known values for FeaturedResultsSetStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FeaturedResultsSetStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FeaturedResultsSetStatus) Values() []FeaturedResultsSetStatus { return []FeaturedResultsSetStatus{ "ACTIVE", @@ -630,9 +631,9 @@ const ( IndexEditionEnterpriseEdition IndexEdition = "ENTERPRISE_EDITION" ) -// Values returns all known values for IndexEdition. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IndexEdition. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IndexEdition) Values() []IndexEdition { return []IndexEdition{ "DEVELOPER_EDITION", @@ -782,8 +783,8 @@ const ( OrderDescending Order = "DESCENDING" ) -// Values returns all known values for Order. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Order. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Order) Values() []Order { return []Order{ @@ -998,9 +999,9 @@ const ( SalesforceChatterFeedIncludeFilterTypeStandardUser SalesforceChatterFeedIncludeFilterType = "STANDARD_USER" ) -// Values returns all known values for SalesforceChatterFeedIncludeFilterType. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for SalesforceChatterFeedIncludeFilterType. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (SalesforceChatterFeedIncludeFilterType) Values() []SalesforceChatterFeedIncludeFilterType { return []SalesforceChatterFeedIncludeFilterType{ @@ -1053,9 +1054,10 @@ const ( SalesforceStandardObjectNameUser SalesforceStandardObjectName = "USER" ) -// Values returns all known values for SalesforceStandardObjectName. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SalesforceStandardObjectName. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (SalesforceStandardObjectName) Values() []SalesforceStandardObjectName { return []SalesforceStandardObjectName{ "ACCOUNT", @@ -1110,9 +1112,10 @@ const ( ServiceNowAuthenticationTypeOauth2 ServiceNowAuthenticationType = "OAUTH2" ) -// Values returns all known values for ServiceNowAuthenticationType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServiceNowAuthenticationType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ServiceNowAuthenticationType) Values() []ServiceNowAuthenticationType { return []ServiceNowAuthenticationType{ "HTTP_BASIC", @@ -1209,9 +1212,9 @@ const ( SortOrderAsc SortOrder = "ASC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "DESC", diff --git a/service/kendra/types/errors.go b/service/kendra/types/errors.go index ab501f85848..5a52d1934dd 100644 --- a/service/kendra/types/errors.go +++ b/service/kendra/types/errors.go @@ -93,8 +93,8 @@ func (e *FeaturedResultsConflictException) ErrorCode() string { func (e *FeaturedResultsConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An issue occurred with the internal server used for your Amazon Kendra service. -// Please wait a few minutes and try again, or contact Support -// (http://aws.amazon.com/contact-us/) for help. +// Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// for help. type InternalServerException struct { Message *string @@ -174,8 +174,8 @@ func (e *ResourceAlreadyExistException) ErrorCode() string { } func (e *ResourceAlreadyExistException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource you want to use is currently in use. Please check you have provided -// the correct resource and try again. +// The resource you want to use is currently in use. Please check you have +// provided the correct resource and try again. type ResourceInUseException struct { Message *string @@ -228,8 +228,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource you want to use isn't available. Please check you have provided the -// correct resource and try again. +// The resource you want to use isn't available. Please check you have provided +// the correct resource and try again. type ResourceUnavailableException struct { Message *string diff --git a/service/kendra/types/types.go b/service/kendra/types/types.go index 4c585ba01a8..9c6567b836d 100644 --- a/service/kendra/types/types.go +++ b/service/kendra/types/types.go @@ -8,8 +8,8 @@ import ( "time" ) -// Summary information on an access control configuration that you created for your -// documents in an index. +// Summary information on an access control configuration that you created for +// your documents in an index. type AccessControlConfigurationSummary struct { // The identifier of the access control configuration. @@ -21,8 +21,8 @@ type AccessControlConfigurationSummary struct { } // Access Control List files for the documents in a data source. For the format of -// the file, see Access control for S3 data sources -// (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html). +// the file, see Access control for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html) +// . type AccessControlListConfiguration struct { // Path to the Amazon S3 bucket that contains the ACL files. @@ -79,17 +79,14 @@ type AdditionalResultAttributeValue struct { // Provides the configuration information to connect to Alfresco as your data // source. Alfresco data source connector is currently in preview mode. Basic // authentication is currently supported. If you would like to use Alfresco -// connector in production, contact Support (http://aws.amazon.com/contact-us/). +// connector in production, contact Support (http://aws.amazon.com/contact-us/) . type AlfrescoConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // key-value pairs required to connect to your Alfresco data source. The secret // must contain a JSON structure with the following keys: - // - // * username—The user name - // of the Alfresco account. - // - // * password—The password of the Alfresco account. + // - username—The user name of the Alfresco account. + // - password—The password of the Alfresco account. // // This member is required. SecretArn *string @@ -108,8 +105,8 @@ type AlfrescoConfiguration struct { // connect to Alfresco if you require a secure SSL connection. You can simply // generate a self-signed X509 certificate on any computer using OpenSSL. For an // example of using OpenSSL to create an X509 certificate, see Create and sign an - // X509 certificate - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). + // X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html) + // . // // This member is required. SslCertificateS3Path *S3Path @@ -117,9 +114,9 @@ type AlfrescoConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Alfresco blogs to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Alfresco fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco - // data source field names must exist in your Alfresco custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Alfresco data source field names must exist in your Alfresco custom + // metadata. BlogFieldMappings []DataSourceToIndexFieldMapping // TRUE to index comments of blogs and other content. @@ -130,10 +127,10 @@ type AlfrescoConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Alfresco document libraries to Amazon Kendra index field names. To - // create custom fields, use the UpdateIndex API before you map to Alfresco fields. - // For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco - // data source field names must exist in your Alfresco custom metadata. + // create custom fields, use the UpdateIndex API before you map to Alfresco + // fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Alfresco data source field names must exist in your Alfresco custom + // metadata. DocumentLibraryFieldMappings []DataSourceToIndexFieldMapping // Specify whether to index document libraries, wikis, or blogs. You can specify @@ -154,32 +151,30 @@ type AlfrescoConfiguration struct { // precedence and the file isn't included in the index. InclusionPatterns []string - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Alfresco. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Alfresco. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Alfresco wikis to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Alfresco fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco - // data source field names must exist in your Alfresco custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Alfresco data source field names must exist in your Alfresco custom + // metadata. WikiFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde } // Provides filtering the query results based on document attributes or metadata -// fields. When you use the AndAllFilters or OrAllFilters, filters you can use 2 +// fields. When you use the AndAllFilters or OrAllFilters , filters you can use 2 // layers under the first attribute filter. For example, you can use: -// -// If you use -// more than 2 layers, you receive a ValidationException exception with the message -// "AttributeFilter cannot have a depth of more than 2." If you use more than 10 -// attribute filters in a given list for AndAllFilters or OrAllFilters, you receive -// a ValidationException with the message "AttributeFilter cannot have a length of -// more than 10". +// If you use more than 2 layers, you receive a ValidationException exception with +// the message " AttributeFilter cannot have a depth of more than 2." If you use +// more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters +// , you receive a ValidationException with the message " AttributeFilter cannot +// have a length of more than 10". type AttributeFilter struct { // Performs a logical AND operation on all supplied filters. @@ -196,20 +191,20 @@ type AttributeFilter struct { // Performs an equals operation on two document attributes or metadata fields. EqualsTo *DocumentAttribute - // Performs a greater than operation on two document attributes or metadata fields. - // Use with a document attribute of type Date or Long. + // Performs a greater than operation on two document attributes or metadata + // fields. Use with a document attribute of type Date or Long . GreaterThan *DocumentAttribute // Performs a greater or equals than operation on two document attributes or - // metadata fields. Use with a document attribute of type Date or Long. + // metadata fields. Use with a document attribute of type Date or Long . GreaterThanOrEquals *DocumentAttribute // Performs a less than operation on two document attributes or metadata fields. - // Use with a document attribute of type Date or Long. + // Use with a document attribute of type Date or Long . LessThan *DocumentAttribute // Performs a less than or equals operation on two document attributes or metadata - // fields. Use with a document attribute of type Date or Long. + // fields. Use with a document attribute of type Date or Long . LessThanOrEquals *DocumentAttribute // Performs a logical NOT operation on all supplied filters. @@ -233,14 +228,13 @@ type AuthenticationConfiguration struct { noSmithyDocumentSerde } -// Provides the configuration information to connect to websites that require basic -// user authentication. +// Provides the configuration information to connect to websites that require +// basic user authentication. type BasicAuthenticationConfiguration struct { - // Your secret ARN, which you can create in Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) You use - // a secret if basic authentication credentials are required to connect to a - // website. The secret stores your credentials of user name and password. + // Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // You use a secret if basic authentication credentials are required to connect to + // a website. The secret stores your credentials of user name and password. // // This member is required. Credentials *string @@ -279,8 +273,7 @@ type BatchDeleteDocumentResponseFailedDocument struct { } // Provides information about a set of featured results that couldn't be removed -// from an index by the BatchDeleteFeaturedResultsSet -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html) +// from an index by the BatchDeleteFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html) // API. type BatchDeleteFeaturedResultsSetError struct { @@ -339,9 +332,9 @@ type BatchPutDocumentResponseFailedDocument struct { // Provides the configuration information to connect to Box as your data source. type BoxConfiguration struct { - // The identifier of the Box Enterprise platform. You can find the enterprise ID in - // the Box Developer Console settings or when you create an app in Box and download - // your authentication credentials. For example, 801234567. + // The identifier of the Box Enterprise platform. You can find the enterprise ID + // in the Box Developer Console settings or when you create an app in Box and + // download your authentication credentials. For example, 801234567. // // This member is required. EnterpriseId *string @@ -349,26 +342,17 @@ type BoxConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // key-value pairs required to connect to your Box platform. The secret must // contain a JSON structure with the following keys: - // - // * clientID—The identifier of - // the client OAuth 2.0 authentication application created in Box. - // - // * - // clientSecret—A set of characters known only to the OAuth 2.0 authentication - // application created in Box. - // - // * publicKeyId—The identifier of the public key - // contained within an identity certificate. - // - // * privateKey—A set of characters that - // make up an encryption key. - // - // * passphrase—A set of characters that act like a - // password. - // - // You create an application in Box to generate the keys or credentials - // required for the secret. For more information, see Using a Box data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html). + // - clientID—The identifier of the client OAuth 2.0 authentication application + // created in Box. + // - clientSecret—A set of characters known only to the OAuth 2.0 authentication + // application created in Box. + // - publicKeyId—The identifier of the public key contained within an identity + // certificate. + // - privateKey—A set of characters that make up an encryption key. + // - passphrase—A set of characters that act like a password. + // You create an application in Box to generate the keys or credentials required + // for the secret. For more information, see Using a Box data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html) + // . // // This member is required. SecretArn *string @@ -376,9 +360,8 @@ type BoxConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Box comments to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Box fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field - // names must exist in your Box custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Box field names must exist in your Box custom metadata. CommentFieldMappings []DataSourceToIndexFieldMapping // TRUE to index comments. @@ -401,9 +384,8 @@ type BoxConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Box files to Amazon Kendra index field names. To create custom fields, // use the UpdateIndex API before you map to Box fields. For more information, see - // Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field - // names must exist in your Box custom metadata. + // Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Box field names must exist in your Box custom metadata. FileFieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files and folders in @@ -417,9 +399,8 @@ type BoxConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Box tasks to Amazon Kendra index field names. To create custom fields, // use the UpdateIndex API before you map to Box fields. For more information, see - // Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field - // names must exist in your Box custom metadata. + // Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Box field names must exist in your Box custom metadata. TaskFieldMappings []DataSourceToIndexFieldMapping // TRUE to use the Slack change log to determine which documents require updating @@ -428,16 +409,15 @@ type BoxConfiguration struct { UseChangeLog bool // Configuration information for an Amazon VPC to connect to your Box. For more - // information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Box web links to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Box fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field - // names must exist in your Box custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Box field names must exist in your Box custom metadata. WebLinkFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -447,17 +427,16 @@ type BoxConfiguration struct { // index. You can add and remove capacity units to fit your usage requirements. type CapacityUnitsConfiguration struct { - // The amount of extra query capacity for an index and GetQuerySuggestions - // (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) + // The amount of extra query capacity for an index and GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) // capacity. A single extra capacity unit for an index provides 0.1 queries per // second or approximately 8,000 queries per day. You can add up to 100 extra - // capacity units. GetQuerySuggestions capacity is five times the provisioned query - // capacity for an index, or the base capacity of 2.5 calls per second, whichever - // is higher. For example, the base capacity for an index is 0.1 queries per - // second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If - // you add another 0.1 queries per second to total 0.2 queries per second for an - // index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than - // five times 0.2 queries per second). + // capacity units. GetQuerySuggestions capacity is five times the provisioned + // query capacity for an index, or the base capacity of 2.5 calls per second, + // whichever is higher. For example, the base capacity for an index is 0.1 queries + // per second, and GetQuerySuggestions capacity has a base of 2.5 calls per + // second. If you add another 0.1 queries per second to total 0.2 queries per + // second for an index, the GetQuerySuggestions capacity is 2.5 calls per second + // (higher than five times 0.2 queries per second). // // This member is required. QueryCapacityUnits *int32 @@ -527,8 +506,8 @@ type ConflictingItem struct { // The text of the conflicting query. QueryText *string - // The identifier of the set of featured results that the conflicting query belongs - // to. + // The identifier of the set of featured results that the conflicting query + // belongs to. SetId *string // The name for the set of featured results that the conflicting query belongs to. @@ -544,9 +523,8 @@ type ConfluenceAttachmentConfiguration struct { // Maps attributes or field names of Confluence attachments to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to - // Confluence fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Confluence data source field names must exist in your Confluence custom + // Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Confluence data source field names must exist in your Confluence custom // metadata. If you specify the AttachentFieldMappings parameter, you must specify // at least one field mapping. AttachmentFieldMappings []ConfluenceAttachmentToIndexFieldMapping @@ -559,9 +537,9 @@ type ConfluenceAttachmentConfiguration struct { // Maps attributes or field names of Confluence attachments to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to -// Confluence fields. For more information, see Mapping data source fields -// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confuence -// data source field names must exist in your Confluence custom metadata. +// Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) +// . The Confuence data source field names must exist in your Confluence custom +// metadata. type ConfluenceAttachmentToIndexFieldMapping struct { // The name of the field in the data source. You must first create the index field @@ -587,9 +565,8 @@ type ConfluenceBlogConfiguration struct { // Maps attributes or field names of Confluence blogs to Amazon Kendra index field // names. To create custom fields, use the UpdateIndex API before you map to - // Confluence fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Confluence data source field names must exist in your Confluence custom + // Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Confluence data source field names must exist in your Confluence custom // metadata. If you specify the BlogFieldMappings parameter, you must specify at // least one field mapping. BlogFieldMappings []ConfluenceBlogToIndexFieldMapping @@ -599,9 +576,8 @@ type ConfluenceBlogConfiguration struct { // Maps attributes or field names of Confluence blog to Amazon Kendra index field // names. To create custom fields, use the UpdateIndex API before you map to -// Confluence fields. For more information, see Mapping data source fields -// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The -// Confluence data source field names must exist in your Confluence custom +// Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) +// . The Confluence data source field names must exist in your Confluence custom // metadata. type ConfluenceBlogToIndexFieldMapping struct { @@ -628,8 +604,8 @@ type ConfluenceConfiguration struct { // user name and password required to connect to the Confluence instance. If you // use Confluence Cloud, you use a generated API token as the password. You can // also provide authentication credentials in the form of a personal access token. - // For more information, see Using a Confluence data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html). + // For more information, see Using a Confluence data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html) + // . // // This member is required. SecretArn *string @@ -693,9 +669,9 @@ type ConfluenceConfiguration struct { // Configuration information for indexing Confluence spaces. SpaceConfiguration *ConfluenceSpaceConfiguration - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Confluence. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Confluence. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -706,9 +682,8 @@ type ConfluencePageConfiguration struct { // Maps attributes or field names of Confluence pages to Amazon Kendra index field // names. To create custom fields, use the UpdateIndex API before you map to - // Confluence fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Confluence data source field names must exist in your Confluence custom + // Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Confluence data source field names must exist in your Confluence custom // metadata. If you specify the PageFieldMappings parameter, you must specify at // least one field mapping. PageFieldMappings []ConfluencePageToIndexFieldMapping @@ -718,9 +693,8 @@ type ConfluencePageConfiguration struct { // Maps attributes or field names of Confluence pages to Amazon Kendra index field // names. To create custom fields, use the UpdateIndex API before you map to -// Confluence fields. For more information, see Mapping data source fields -// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The -// Confluence data source field names must exist in your Confluence custom +// Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) +// . The Confluence data source field names must exist in your Confluence custom // metadata. type ConfluencePageToIndexFieldMapping struct { @@ -748,8 +722,8 @@ type ConfluenceSpaceConfiguration struct { // TRUE to index personal spaces. You can add restrictions to items in personal // spaces. If personal spaces are indexed, queries without user context information // may return restricted items from a personal space in their results. For more - // information, see Filtering on user context - // (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). + // information, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) + // . CrawlPersonalSpaces bool // A list of space keys of Confluence spaces. If you include a key, the blogs, @@ -764,11 +738,10 @@ type ConfluenceSpaceConfiguration struct { // IncludeSpaces and the ExcludeSpaces list, the space is excluded. IncludeSpaces []string - // Maps attributes or field names of Confluence spaces to Amazon Kendra index field - // names. To create custom fields, use the UpdateIndex API before you map to - // Confluence fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Confluence data source field names must exist in your Confluence custom + // Maps attributes or field names of Confluence spaces to Amazon Kendra index + // field names. To create custom fields, use the UpdateIndex API before you map to + // Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Confluence data source field names must exist in your Confluence custom // metadata. If you specify the SpaceFieldMappings parameter, you must specify at // least one field mapping. SpaceFieldMappings []ConfluenceSpaceToIndexFieldMapping @@ -776,11 +749,10 @@ type ConfluenceSpaceConfiguration struct { noSmithyDocumentSerde } -// Maps attributes or field names of Confluence spaces to Amazon Kendra index field -// names. To create custom fields, use the UpdateIndex API before you map to -// Confluence fields. For more information, see Mapping data source fields -// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The -// Confluence data source field names must exist in your Confluence custom +// Maps attributes or field names of Confluence spaces to Amazon Kendra index +// field names. To create custom fields, use the UpdateIndex API before you map to +// Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) +// . The Confluence data source field names must exist in your Confluence custom // metadata. type ConfluenceSpaceToIndexFieldMapping struct { @@ -820,11 +792,9 @@ type ConnectionConfiguration struct { // The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The // credentials should be a user/password pair. For more information, see Using a - // Database Data Source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). For - // more information about Secrets Manager, see What Is Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the - // Secrets Manager user guide. + // Database Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) + // . For more information about Secrets Manager, see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // in the Secrets Manager user guide. // // This member is required. SecretArn *string @@ -838,8 +808,8 @@ type ConnectionConfiguration struct { } // Provides the configuration information for your content sources, such as data -// sources, FAQs, and content indexed directly via BatchPutDocument -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html). +// sources, FAQs, and content indexed directly via BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) +// . type ContentSourceConfiguration struct { // The identifier of the data sources you want to use for your Amazon Kendra @@ -878,8 +848,8 @@ type Correction struct { // Provides the configuration information for altering document metadata and // content during the document ingestion process. For more information, see -// Customizing document metadata during the ingestion process -// (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +// Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) +// . type CustomDocumentEnrichmentConfiguration struct { // Configuration information to alter document attributes or metadata fields and @@ -890,23 +860,23 @@ type CustomDocumentEnrichmentConfiguration struct { // structured documents with their metadata and text extracted. You can use a // Lambda function to apply advanced logic for creating, modifying, or deleting // document metadata and content. For more information, see Advanced data - // manipulation - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation). + // manipulation (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) + // . PostExtractionHookConfiguration *HookConfiguration // Configuration information for invoking a Lambda function in Lambda on the // original or raw documents before extracting their metadata and text. You can use // a Lambda function to apply advanced logic for creating, modifying, or deleting // document metadata and content. For more information, see Advanced data - // manipulation - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation). + // manipulation (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) + // . PreExtractionHookConfiguration *HookConfiguration // The Amazon Resource Name (ARN) of a role with permission to run // PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering // document metadata and content during the document ingestion process. For more - // information, see IAM roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . RoleArn *string noSmithyDocumentSerde @@ -931,8 +901,8 @@ type DatabaseConfiguration struct { // This member is required. DatabaseEngineType DatabaseEngineType - // Information about the database column that provides information for user context - // filtering. + // Information about the database column that provides information for user + // context filtering. AclConfiguration *AclConfiguration // Provides information about how Amazon Kendra uses quote marks around SQL @@ -984,8 +954,8 @@ type DataSourceConfiguration struct { // Provides the configuration information to connect to Quip as your data source. QuipConfiguration *QuipConfiguration - // Provides the configuration information to connect to an Amazon S3 bucket as your - // data source. + // Provides the configuration information to connect to an Amazon S3 bucket as + // your data source. S3Configuration *S3DataSourceConfiguration // Provides the configuration information to connect to Salesforce as your data @@ -1048,8 +1018,8 @@ type DataSourceSummary struct { // The code for a language. This shows a supported language for all documents in // the data source. English is supported by default. For more information on // supported languages, including their codes, see Adding documents in languages - // other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) + // . LanguageCode *string // The name of the data source. @@ -1078,36 +1048,37 @@ type DataSourceSyncJob struct { // The Unix timestamp when the synchronization job completed. EndTime *time.Time - // If the Status field is set to FAILED, the ErrorCode field indicates the reason + // If the Status field is set to FAILED , the ErrorCode field indicates the reason // the synchronization failed. ErrorCode ErrorCode - // If the Status field is set to ERROR, the ErrorMessage field contains a + // If the Status field is set to ERROR , the ErrorMessage field contains a // description of the error that caused the synchronization to fail. ErrorMessage *string // A identifier for the synchronization job. ExecutionId *string - // Maps a batch delete document request to a specific data source sync job. This is - // optional and should only be supplied when documents are deleted by a data source - // connector. + // Maps a batch delete document request to a specific data source sync job. This + // is optional and should only be supplied when documents are deleted by a data + // source connector. Metrics *DataSourceSyncJobMetrics // The Unix timestamp when the synchronization job started. StartTime *time.Time - // The execution status of the synchronization job. When the Status field is set to - // SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, - // the ErrorCode and ErrorMessage fields give you the reason for the failure. + // The execution status of the synchronization job. When the Status field is set + // to SUCCEEDED , the synchronization job is done. If the status code is set to + // FAILED , the ErrorCode and ErrorMessage fields give you the reason for the + // failure. Status DataSourceSyncJobStatus noSmithyDocumentSerde } -// Maps a batch delete document request to a specific data source sync job. This is -// optional and should only be supplied when documents are deleted by a data source -// connector. +// Maps a batch delete document request to a specific data source sync job. This +// is optional and should only be supplied when documents are deleted by a data +// source connector. type DataSourceSyncJobMetrics struct { // The number of documents added from the data source up to now in the data source @@ -1122,8 +1093,8 @@ type DataSourceSyncJobMetrics struct { // the data source sync run. DocumentsFailed *string - // The number of documents modified in the data source up to now in the data source - // sync run. + // The number of documents modified in the data source up to now in the data + // source sync run. DocumentsModified *string // The current number of documents crawled by the current sync job in the data @@ -1194,17 +1165,17 @@ type DataSourceVpcConfiguration struct { // A document in an index. type Document struct { - // A identifier of the document in the index. Note, each document ID must be unique - // per index. You cannot create a data source to index your documents with their - // unique IDs and then use the BatchPutDocument API to index the same documents, or - // vice versa. You can delete a data source and then use the BatchPutDocument API - // to index the same documents, or vice versa. + // A identifier of the document in the index. Note, each document ID must be + // unique per index. You cannot create a data source to index your documents with + // their unique IDs and then use the BatchPutDocument API to index the same + // documents, or vice versa. You can delete a data source and then use the + // BatchPutDocument API to index the same documents, or vice versa. // // This member is required. Id *string - // The identifier of the access control configuration that you want to apply to the - // document. + // The identifier of the access control configuration that you want to apply to + // the document. AccessControlConfigurationId *string // Information on principals (users and/or groups) and which documents they should @@ -1212,13 +1183,13 @@ type Document struct { // are filtered based on the user or their group access to documents. AccessControlList []Principal - // Custom attributes to apply to the document. Use the custom attributes to provide - // additional information for searching, to provide facets for refining searches, - // and to provide additional information in the query response. For example, - // 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide - // information on the synchronization of documents running on a data source. Note, - // 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra - // will use the ID of a running sync job. + // Custom attributes to apply to the document. Use the custom attributes to + // provide additional information for searching, to provide facets for refining + // searches, and to provide additional information in the query response. For + // example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that + // provide information on the synchronization of documents running on a data + // source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as + // Amazon Kendra will use the ID of a running sync job. Attributes []DocumentAttribute // The contents of the document. Documents passed to the Blob parameter must be @@ -1231,9 +1202,8 @@ type Document struct { // The file type of the document in the Blob field. ContentType ContentType - // The list of principal - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that - // define the hierarchy for which documents users should have access to. + // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access to. HierarchicalAccessControlList []HierarchicalPrincipal // Information required to find a specific file in an Amazon S3 bucket. @@ -1246,8 +1216,8 @@ type Document struct { } // A document attribute or metadata field. To create custom document attributes, -// see Custom attributes -// (https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html). +// see Custom attributes (https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html) +// . type DocumentAttribute struct { // The identifier for the attribute. @@ -1265,17 +1235,16 @@ type DocumentAttribute struct { // The condition used for the target document attribute or metadata field when // ingesting documents into Amazon Kendra. You use this with -// DocumentAttributeTarget to apply the condition -// (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html). -// For example, you can create the 'Department' target field and have it prefill +// DocumentAttributeTarget to apply the condition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html) +// . For example, you can create the 'Department' target field and have it prefill // department names associated with the documents based on information in the // 'Source_URI' field. Set the condition that if the 'Source_URI' field contains // 'financial' in its URI value, then prefill the target field 'Department' with // the target value 'Finance' for the document. Amazon Kendra cannot create a // target field if it has not already been created as an index field. After you // create your index field, you can create a document metadata field using -// DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata -// field to your index field. +// DocumentAttributeTarget . Amazon Kendra then will map your newly created +// metadata field to your index field. type DocumentAttributeCondition struct { // The identifier of the document attribute used for the condition. For example, @@ -1286,8 +1255,8 @@ type DocumentAttributeCondition struct { // This member is required. ConditionDocumentAttributeKey *string - // The condition operator. For example, you can use 'Contains' to partially match a - // string. + // The condition operator. For example, you can use 'Contains' to partially match + // a string. // // This member is required. Operator ConditionOperator @@ -1300,18 +1269,18 @@ type DocumentAttributeCondition struct { noSmithyDocumentSerde } -// The target document attribute or metadata field you want to alter when ingesting -// documents into Amazon Kendra. For example, you can delete customer +// The target document attribute or metadata field you want to alter when +// ingesting documents into Amazon Kendra. For example, you can delete customer // identification numbers associated with the documents, stored in the document // metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and -// the deletion flag to TRUE. This removes all customer ID values in the field +// the deletion flag to TRUE . This removes all customer ID values in the field // 'Customer_ID'. This would scrub personally identifiable information from each // document's metadata. Amazon Kendra cannot create a target field if it has not // already been created as an index field. After you create your index field, you -// can create a document metadata field using DocumentAttributeTarget. Amazon +// can create a document metadata field using DocumentAttributeTarget . Amazon // Kendra then will map your newly created metadata field to your index field. You -// can also use this with DocumentAttributeCondition -// (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html). +// can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html) +// . type DocumentAttributeTarget struct { // The identifier of the target document attribute or metadata field. For example, @@ -1324,15 +1293,15 @@ type DocumentAttributeTarget struct { TargetDocumentAttributeValue *DocumentAttributeValue // TRUE to delete the existing target value for your specified target attribute - // key. You cannot create a target value and set this to TRUE. To create a target - // value (TargetDocumentAttributeValue), set this to FALSE. + // key. You cannot create a target value and set this to TRUE . To create a target + // value ( TargetDocumentAttributeValue ), set this to FALSE . TargetDocumentAttributeValueDeletion bool noSmithyDocumentSerde } -// The value of a document attribute. You can only provide one value for a document -// attribute. +// The value of a document attribute. You can only provide one value for a +// document attribute. type DocumentAttributeValue struct { // A date expressed as an ISO 8601 string. It is important for the time zone to be @@ -1388,24 +1357,14 @@ type DocumentInfo struct { // Attributes that identify a specific version of a document to check. The only // valid attributes are: - // - // * version - // - // * datasourceId - // - // * jobExecutionId - // - // The - // attributes follow these rules: - // - // * dataSourceId and jobExecutionId must be used - // together. - // - // * version is ignored if dataSourceId and jobExecutionId are not - // provided. - // - // * If dataSourceId and jobExecutionId are provided, but version is - // not, the version defaults to "0". + // - version + // - datasourceId + // - jobExecutionId + // The attributes follow these rules: + // - dataSourceId and jobExecutionId must be used together. + // - version is ignored if dataSourceId and jobExecutionId are not provided. + // - If dataSourceId and jobExecutionId are provided, but version is not, the + // version defaults to "0". Attributes []DocumentAttribute noSmithyDocumentSerde @@ -1476,7 +1435,7 @@ type EntityConfiguration struct { // This member is required. EntityId *string - // Specifies whether you are configuring a User or a Group. + // Specifies whether you are configuring a User or a Group . // // This member is required. EntityType EntityType @@ -1519,9 +1478,9 @@ type EntityPersonaConfiguration struct { // The persona that defines the specific permissions of the user or group in your // IAM Identity Center identity source. The available personas or access roles are - // Owner and Viewer. For more information on these personas, see Providing access - // to your search page - // (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + // Owner and Viewer . For more information on these personas, see Providing access + // to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience) + // . // // This member is required. Persona Persona @@ -1534,9 +1493,9 @@ type EntityPersonaConfiguration struct { // grant access to your Amazon Kendra experience. type ExperienceConfiguration struct { - // The identifiers of your data sources and FAQs. Or, you can specify that you want - // to use documents indexed via the BatchPutDocument API. This is the content you - // want to use for your Amazon Kendra experience. + // The identifiers of your data sources and FAQs. Or, you can specify that you + // want to use documents indexed via the BatchPutDocument API. This is the content + // you want to use for your Amazon Kendra experience. ContentSourceConfiguration *ContentSourceConfiguration // The IAM Identity Center field name that contains the identifiers of your users, @@ -1554,7 +1513,7 @@ type ExperienceEndpoint struct { Endpoint *string // The type of endpoint for your Amazon Kendra experience. The type currently - // available is HOME, which is a unique and fully hosted URL to the home page of + // available is HOME , which is a unique and fully hosted URL to the home page of // your Amazon Kendra experience. EndpointType EndpointType @@ -1565,8 +1524,8 @@ type ExperienceEndpoint struct { // source with granted access to your Amazon Kendra experience. You can create an // Amazon Kendra experience such as a search application. For more information on // creating a search application experience, see Building a search experience with -// no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . type ExperienceEntitiesSummary struct { // Information about the user entity. @@ -1576,7 +1535,7 @@ type ExperienceEntitiesSummary struct { // For example, a user ID could be an email. EntityId *string - // Shows the type as User or Group. + // Shows the type as User or Group . EntityType EntityType noSmithyDocumentSerde @@ -1584,8 +1543,8 @@ type ExperienceEntitiesSummary struct { // Summary information for your Amazon Kendra experience. You can create an Amazon // Kendra experience such as a search application. For more information on creating -// a search application experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . type ExperiencesSummary struct { // The Unix timestamp when your Amazon Kendra experience was created. @@ -1612,7 +1571,7 @@ type ExperiencesSummary struct { // values "HR", "Engineering", and "Accounting". You can display these values in // the search results so that documents can be searched by department. You can // display up to 10 facet values per facet for a query. If you want to increase -// this limit, contact Support (http://aws.amazon.com/contact-us/). +// this limit, contact Support (http://aws.amazon.com/contact-us/) . type Facet struct { // The unique key for the document attribute. @@ -1626,12 +1585,12 @@ type Facet struct { // documents can be searched not only by department but also by a sub department // within a department. This helps your users further narrow their search. You can // only have one nested facet within a facet. If you want to increase this limit, - // contact Support (http://aws.amazon.com/contact-us/). + // contact Support (http://aws.amazon.com/contact-us/) . Facets []Facet - // Maximum number of facet values per facet. The default is 10. You can use this to - // limit the number of facet values to less than 10. If you want to increase the - // default, contact Support (http://aws.amazon.com/contact-us/). + // Maximum number of facet values per facet. The default is 10. You can use this + // to limit the number of facet values to less than 10. If you want to increase the + // default, contact Support (http://aws.amazon.com/contact-us/) . MaxResults int32 noSmithyDocumentSerde @@ -1644,8 +1603,8 @@ type FacetResult struct { // provided in the query. DocumentAttributeKey *string - // An array of key/value pairs, where the key is the value of the attribute and the - // count is the number of documents that share the key value. + // An array of key/value pairs, where the key is the value of the attribute and + // the count is the number of documents that share the key value. DocumentAttributeValueCountPairs []DocumentAttributeValueCountPair // The data type of the facet value. This is the same as the type defined for the @@ -1659,8 +1618,8 @@ type FacetResult struct { // that failed to properly configure with your Amazon Kendra experience. type FailedEntity struct { - // The identifier of the user or group in your IAM Identity Center identity source. - // For example, a user ID could be an email. + // The identifier of the user or group in your IAM Identity Center identity + // source. For example, a user ID could be an email. EntityId *string // The reason the user or group in your IAM Identity Center identity source failed @@ -1695,11 +1654,11 @@ type FaqSummary struct { // The identifier of the FAQ. Id *string - // The code for a language. This shows a supported language for the FAQ document as - // part of the summary information for FAQs. English is supported by default. For - // more information on supported languages, including their codes, see Adding - // documents in languages other than English - // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). + // The code for a language. This shows a supported language for the FAQ document + // as part of the summary information for FAQs. English is supported by default. + // For more information on supported languages, including their codes, see Adding + // documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) + // . LanguageCode *string // The name that you assigned the FAQ when you created or updated the FAQ. @@ -1715,13 +1674,13 @@ type FaqSummary struct { noSmithyDocumentSerde } -// A featured document. This document is displayed at the top of the search results -// page, placed above all other results for certain queries. If there's an exact -// match of a query, then the document is featured in the search results. +// A featured document. This document is displayed at the top of the search +// results page, placed above all other results for certain queries. If there's an +// exact match of a query, then the document is featured in the search results. type FeaturedDocument struct { - // The identifier of the document to feature in the search results. You can use the - // Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to + // The identifier of the document to feature in the search results. You can use + // the Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to // search for specific documents with their document IDs included in the result // items, or you can use the console. Id *string @@ -1732,8 +1691,7 @@ type FeaturedDocument struct { // A document ID doesn't exist but you have specified as a featured document. // Amazon Kendra cannot feature the document if it doesn't exist in the index. You // can check the status of a document and its ID or check for documents with status -// errors using the BatchGetDocumentStatus -// (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) +// errors using the BatchGetDocumentStatus (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) // API. type FeaturedDocumentMissing struct { @@ -1744,16 +1702,15 @@ type FeaturedDocumentMissing struct { noSmithyDocumentSerde } -// A featured document with its metadata information. This document is displayed at -// the top of the search results page, placed above all other results for certain -// queries. If there's an exact match of a query, then the document is featured in -// the search results. +// A featured document with its metadata information. This document is displayed +// at the top of the search results page, placed above all other results for +// certain queries. If there's an exact match of a query, then the document is +// featured in the search results. type FeaturedDocumentWithMetadata struct { - // The identifier of the featured document with its metadata. You can use the Query - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to search for - // specific documents with their document IDs included in the result items, or you - // can use the console. + // The identifier of the featured document with its metadata. You can use the Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) + // API to search for specific documents with their document IDs included in the + // result items, or you can use the console. Id *string // The main title of the featured document. @@ -1775,8 +1732,8 @@ type FeaturedResultsItem struct { AdditionalAttributes []AdditionalResultAttribute // An array of document attributes assigned to a featured document in the search - // results. For example, the document author (_author) or the source URI - // (_source_uri) of the document. + // results. For example, the document author ( _author ) or the source URI ( + // _source_uri ) of the document. DocumentAttributes []DocumentAttribute // Provides text and information about where to highlight the text. @@ -1793,8 +1750,8 @@ type FeaturedResultsItem struct { // A token that identifies a particular featured result from a particular query. // Use this token to provide click-through feedback for the result. For more - // information, see Submitting feedback - // (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html). + // information, see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html) + // . FeedbackToken *string // The identifier of the featured result. @@ -1819,19 +1776,18 @@ type FeaturedResultsSet struct { // The description for the set of featured results. Description *string - // The list of document IDs for the documents you want to feature at the top of the - // search results page. You can use the Query - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to search for - // specific documents with their document IDs included in the result items, or you - // can use the console. You can add up to four featured documents. You can request - // to increase this limit by contacting Support - // (http://aws.amazon.com/contact-us/). Specific queries are mapped to specific - // documents for featuring in the results. If a query contains an exact match, then - // one or more specific documents are featured in the results. The exact match - // applies to the full query. For example, if you only specify 'Kendra', queries - // such as 'How does kendra semantically rank results?' will not render the - // featured results. Featured results are designed for specific queries, rather - // than queries that are too broad in scope. + // The list of document IDs for the documents you want to feature at the top of + // the search results page. You can use the Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) + // API to search for specific documents with their document IDs included in the + // result items, or you can use the console. You can add up to four featured + // documents. You can request to increase this limit by contacting Support (http://aws.amazon.com/contact-us/) + // . Specific queries are mapped to specific documents for featuring in the + // results. If a query contains an exact match, then one or more specific documents + // are featured in the results. The exact match applies to the full query. For + // example, if you only specify 'Kendra', queries such as 'How does kendra + // semantically rank results?' will not render the featured results. Featured + // results are designed for specific queries, rather than queries that are too + // broad in scope. FeaturedDocuments []FeaturedDocument // The identifier of the set of featured results. @@ -1852,13 +1808,12 @@ type FeaturedResultsSet struct { // rather than queries that are too broad in scope. QueryTexts []string - // The current status of the set of featured results. When the value is ACTIVE, + // The current status of the set of featured results. When the value is ACTIVE , // featured results are ready for use. You can still configure your settings before - // setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using - // the UpdateFeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) + // setting the status to ACTIVE . You can set the status to ACTIVE or INACTIVE + // using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) // API. The queries you specify for featured results must be unique per featured - // results set for each index, whether the status is ACTIVE or INACTIVE. + // results set for each index, whether the status is ACTIVE or INACTIVE . Status FeaturedResultsSetStatus noSmithyDocumentSerde @@ -1881,13 +1836,12 @@ type FeaturedResultsSetSummary struct { // The Unix timestamp when the set of featured results was last updated. LastUpdatedTimestamp *int64 - // The current status of the set of featured results. When the value is ACTIVE, + // The current status of the set of featured results. When the value is ACTIVE , // featured results are ready for use. You can still configure your settings before - // setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using - // the UpdateFeaturedResultsSet - // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) + // setting the status to ACTIVE . You can set the status to ACTIVE or INACTIVE + // using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) // API. The queries you specify for featured results must be unique per featured - // results set for each index, whether the status is ACTIVE or INACTIVE. + // results set for each index, whether the status is ACTIVE or INACTIVE . Status FeaturedResultsSetStatus noSmithyDocumentSerde @@ -1900,8 +1854,8 @@ type FsxConfiguration struct { // The identifier of the Amazon FSx file system. You can find your file system ID // on the file system dashboard in the Amazon FSx console. For information on how // to create a file system in Amazon FSx console, using Windows File Server as an - // example, see Amazon FSx Getting started guide - // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html). + // example, see Amazon FSx Getting started guide (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html) + // . // // This member is required. FileSystemId *string @@ -1911,8 +1865,8 @@ type FsxConfiguration struct { // This member is required. FileSystemType FsxFileSystemType - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Amazon FSx. Your Amazon FSx instance must reside inside your VPC. + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Amazon FSx. Your Amazon FSx instance must reside inside your VPC. // // This member is required. VpcConfiguration *DataSourceVpcConfiguration @@ -1927,9 +1881,9 @@ type FsxConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source // attributes or field names to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Amazon FSx fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Amazon - // FSx data source field names must exist in your Amazon FSx custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Amazon FSx data source field names must exist in your Amazon FSx custom + // metadata. FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files in your Amazon @@ -1943,15 +1897,12 @@ type FsxConfiguration struct { // key-value pairs required to connect to your Amazon FSx file system. Windows is // currently the only supported type. The secret must contain a JSON structure with // the following keys: - // - // * username—The Active Directory user name, along with the - // Domain Name System (DNS) domain name. For example, user@corp.example.com. The - // Active Directory user account must have read and mounting access to the Amazon - // FSx file system for Windows. - // - // * password—The password of the Active Directory - // user account with read and mounting access to the Amazon FSx Windows file - // system. + // - username—The Active Directory user name, along with the Domain Name System + // (DNS) domain name. For example, user@corp.example.com. The Active Directory user + // account must have read and mounting access to the Amazon FSx file system for + // Windows. + // - password—The password of the Active Directory user account with read and + // mounting access to the Amazon FSx Windows file system. SecretArn *string noSmithyDocumentSerde @@ -1963,11 +1914,9 @@ type GitHubConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // key-value pairs required to connect to your GitHub. The secret must contain a // JSON structure with the following keys: - // - // * personalToken—The access token - // created in GitHub. For more information on creating a token in GitHub, see Using - // a GitHub data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html). + // - personalToken—The access token created in GitHub. For more information on + // creating a token in GitHub, see Using a GitHub data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html) + // . // // This member is required. SecretArn *string @@ -1996,9 +1945,8 @@ type GitHubConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub commits to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubCommitConfigurationFieldMappings []DataSourceToIndexFieldMapping // Configuration information to include certain types of GitHub content. You can @@ -2008,58 +1956,51 @@ type GitHubConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub issue attachments to Amazon Kendra index field names. To create - // custom fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // custom fields, use the UpdateIndex API before you map to GitHub fields. For + // more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubIssueAttachmentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub issue comments to Amazon Kendra index field names. To create - // custom fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // custom fields, use the UpdateIndex API before you map to GitHub fields. For + // more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubIssueCommentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub issues to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubIssueDocumentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub pull request comments to Amazon Kendra index field names. To // create custom fields, use the UpdateIndex API before you map to GitHub fields. - // For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubPullRequestCommentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub pull request attachments to Amazon Kendra index field names. To // create custom fields, use the UpdateIndex API before you map to GitHub fields. - // For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubPullRequestDocumentAttachmentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of GitHub pull requests to Amazon Kendra index field names. To create - // custom fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // custom fields, use the UpdateIndex API before you map to GitHub fields. For + // more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubPullRequestDocumentConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map GitHub repository // attributes or field names to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to GitHub fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub - // data source field names must exist in your GitHub custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The GitHub data source field names must exist in your GitHub custom metadata. GitHubRepositoryConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain file names in your @@ -2092,8 +2033,8 @@ type GitHubConfiguration struct { // Configuration information to connect to GitHub Enterprise Cloud (SaaS). SaaSConfiguration *SaaSConfiguration - // The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) - // or GitHub Enterprise Server (on premises). + // The type of GitHub service you want to connect to—GitHub Enterprise Cloud + // (SaaS) or GitHub Enterprise Server (on premises). Type Type // TRUE to use the GitHub change log to determine which documents require updating @@ -2103,8 +2044,8 @@ type GitHubConfiguration struct { UseChangeLog bool // Configuration information of an Amazon Virtual Private Cloud to connect to your - // GitHub. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // GitHub. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -2144,17 +2085,17 @@ type GitHubDocumentCrawlProperties struct { type GoogleDriveConfiguration struct { // The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the - // credentials required to connect to Google Drive. For more information, see Using - // a Google Workspace Drive data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). + // credentials required to connect to Google Drive. For more information, see + // Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) + // . // // This member is required. SecretArn *string // A list of MIME types to exclude from the index. All documents matching the // specified MIME type are excluded. For a list of MIME types, see Using a Google - // Workspace Drive data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). + // Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) + // . ExcludeMimeTypes []string // A list of identifiers or shared drives to exclude from the index. All files and @@ -2176,9 +2117,9 @@ type GoogleDriveConfiguration struct { // Maps Google Drive data source attributes or field names to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to - // Google Drive fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Google - // Drive data source field names must exist in your Google Drive custom metadata. + // Google Drive fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Google Drive data source field names must exist in your Google Drive + // custom metadata. FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain items in your Google @@ -2210,11 +2151,10 @@ type GroupMembers struct { // to provide the path to the S3 file that lists your users and sub groups for a // group. Your sub groups can contain more than 1000 users, but the list of sub // groups that belong to a group (and/or users) must be no more than 1000. You can - // download this example S3 file - // (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) that - // uses the correct format for listing group members. Note, dataSourceId is + // download this example S3 file (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) + // that uses the correct format for listing group members. Note, dataSourceId is // optional. The value of type for a group is always GROUP and for a user it is - // always USER. + // always USER . S3PathforGroupMembers *S3Path noSmithyDocumentSerde @@ -2232,8 +2172,8 @@ type GroupOrderingIdSummary struct { // DELETE action for mapping users to their groups. LastUpdatedAt *time.Time - // The order in which actions should complete processing. An action can be a PUT or - // DELETE action for mapping users to their groups. + // The order in which actions should complete processing. An action can be a PUT + // or DELETE action for mapping users to their groups. OrderingId *int64 // The Unix timestamp when an action was received by Amazon Kendra. An action can @@ -2241,7 +2181,7 @@ type GroupOrderingIdSummary struct { ReceivedAt *time.Time // The current processing status of actions for mapping users to their groups. The - // status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED. + // status can be either PROCESSING , SUCCEEDED , DELETING , DELETED , or FAILED . Status PrincipalMappingStatus noSmithyDocumentSerde @@ -2259,15 +2199,14 @@ type GroupSummary struct { noSmithyDocumentSerde } -// Information to define the hierarchy for which documents users should have access -// to. +// Information to define the hierarchy for which documents users should have +// access to. type HierarchicalPrincipal struct { - // A list of principal - // (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that - // define the hierarchy for which documents users should have access to. Each - // hierarchical list specifies which user or group has allow or deny access for - // each document. + // A list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) + // lists that define the hierarchy for which documents users should have access to. + // Each hierarchical list specifies which user or group has allow or deny access + // for each document. // // This member is required. PrincipalList []Principal @@ -2302,30 +2241,28 @@ type Highlight struct { // Provides the configuration information for invoking a Lambda function in Lambda // to alter document metadata and content when ingesting documents into Amazon // Kendra. You can configure your Lambda function using -// PreExtractionHookConfiguration -// (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) +// PreExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) // if you want to apply advanced alterations on the original or raw documents. If // you want to apply advanced alterations on the Amazon Kendra structured // documents, you must configure your Lambda function using -// PostExtractionHookConfiguration -// (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html). -// You can only invoke one Lambda function. However, this function can invoke other -// functions it requires. For more information, see Customizing document metadata -// during the ingestion process -// (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +// PostExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) +// . You can only invoke one Lambda function. However, this function can invoke +// other functions it requires. For more information, see Customizing document +// metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) +// . type HookConfiguration struct { // The Amazon Resource Name (ARN) of a role with permission to run a Lambda - // function during ingestion. For more information, see IAM roles for Amazon Kendra - // (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // function during ingestion. For more information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) + // . // // This member is required. LambdaArn *string // Stores the original, raw documents or the structured, parsed documents before // and after altering them. For more information, see Data contracts for Lambda - // functions - // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda). + // functions (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda) + // . // // This member is required. S3Bucket *string @@ -2346,7 +2283,7 @@ type IndexConfigurationSummary struct { // This member is required. CreatedAt *time.Time - // The current status of the index. When the status is ACTIVE, the index is ready + // The current status of the index. When the status is ACTIVE , the index is ready // to search. // // This member is required. @@ -2357,12 +2294,12 @@ type IndexConfigurationSummary struct { // This member is required. UpdatedAt *time.Time - // Indicates whether the index is a Enterprise Edition index or a Developer Edition - // index. + // Indicates whether the index is a Enterprise Edition index or a Developer + // Edition index. Edition IndexEdition // A identifier for the index. Use this to identify the index when you are using - // APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. + // APIs such as Query , DescribeIndex , UpdateIndex , and DeleteIndex . Id *string // The name of the index. @@ -2391,10 +2328,10 @@ type IndexStatistics struct { // Provides the configuration information for applying basic logic to alter // document metadata and content when ingesting documents into Amazon Kendra. To // apply advanced logic, to go beyond what you can do with basic logic, see -// HookConfiguration -// (https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html). For -// more information, see Customizing document metadata during the ingestion process -// (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). +// HookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html) +// . For more information, see Customizing document metadata during the ingestion +// process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) +// . type InlineCustomDocumentEnrichmentConfiguration struct { // Configuration of the condition used for the target document attribute or @@ -2422,13 +2359,10 @@ type JiraConfiguration struct { // The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the // key-value pairs required to connect to your Jira data source. The secret must // contain a JSON structure with the following keys: - // - // * jiraId—The Jira user name - // or email. - // - // * jiraCredentials—The Jira API token. For more information, see Using - // a Jira data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html). + // - jiraId—The Jira user name or email. + // - jiraCredentials—The Jira API token. For more information, see Using a Jira + // data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html) + // . // // This member is required. SecretArn *string @@ -2436,81 +2370,76 @@ type JiraConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Jira attachments to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Jira fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data - // source field names must exist in your Jira custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Jira data source field names must exist in your Jira custom metadata. AttachmentFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Jira comments to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Jira fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data - // source field names must exist in your Jira custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Jira data source field names must exist in your Jira custom metadata. CommentFieldMappings []DataSourceToIndexFieldMapping - // A list of regular expression patterns to exclude certain file paths, file names, - // and file types in your Jira data source. Files that match the patterns are - // excluded from the index. Files that don’t match the patterns are included in the - // index. If a file matches both an inclusion pattern and an exclusion pattern, the - // exclusion pattern takes precedence and the file isn't included in the index. + // A list of regular expression patterns to exclude certain file paths, file + // names, and file types in your Jira data source. Files that match the patterns + // are excluded from the index. Files that don’t match the patterns are included in + // the index. If a file matches both an inclusion pattern and an exclusion pattern, + // the exclusion pattern takes precedence and the file isn't included in the index. ExclusionPatterns []string - // A list of regular expression patterns to include certain file paths, file names, - // and file types in your Jira data source. Files that match the patterns are - // included in the index. Files that don't match the patterns are excluded from the - // index. If a file matches both an inclusion pattern and an exclusion pattern, the - // exclusion pattern takes precedence and the file isn't included in the index. + // A list of regular expression patterns to include certain file paths, file + // names, and file types in your Jira data source. Files that match the patterns + // are included in the index. Files that don't match the patterns are excluded from + // the index. If a file matches both an inclusion pattern and an exclusion pattern, + // the exclusion pattern takes precedence and the file isn't included in the index. InclusionPatterns []string // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Jira issues to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Jira fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data - // source field names must exist in your Jira custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Jira data source field names must exist in your Jira custom metadata. IssueFieldMappings []DataSourceToIndexFieldMapping // Specify whether to crawl comments, attachments, and work logs. You can specify // one or more of these options. IssueSubEntityFilter []IssueSubEntity - // Specify which issue types to crawl in your Jira data source. You can specify one - // or more of these options to crawl. + // Specify which issue types to crawl in your Jira data source. You can specify + // one or more of these options to crawl. IssueType []string - // Specify which projects to crawl in your Jira data source. You can specify one or - // more Jira project IDs. + // Specify which projects to crawl in your Jira data source. You can specify one + // or more Jira project IDs. Project []string // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Jira projects to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Jira fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data - // source field names must exist in your Jira custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Jira data source field names must exist in your Jira custom metadata. ProjectFieldMappings []DataSourceToIndexFieldMapping - // Specify which statuses to crawl in your Jira data source. You can specify one or - // more of these options to crawl. + // Specify which statuses to crawl in your Jira data source. You can specify one + // or more of these options to crawl. Status []string - // TRUE to use the Jira change log to determine which documents require updating in - // the index. Depending on the change log's size, it may take longer for Amazon + // TRUE to use the Jira change log to determine which documents require updating + // in the index. Depending on the change log's size, it may take longer for Amazon // Kendra to use the change log than to scan all of your documents in Jira. UseChangeLog bool - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Jira. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Jira. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Jira work logs to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Jira fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data - // source field names must exist in your Jira custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Jira data source field names must exist in your Jira custom metadata. WorkLogFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -2622,9 +2551,9 @@ type OneDriveConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map OneDrive data source // attributes or field names to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to OneDrive fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The OneDrive - // data source field names must exist in your OneDrive custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The OneDrive data source field names must exist in your OneDrive custom + // metadata. FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain documents in your @@ -2642,7 +2571,7 @@ type OneDriveConfiguration struct { type OneDriveUsers struct { // A list of users whose documents should be indexed. Specify the user names in - // email format, for example, username@tenantdomain. If you need to index the + // email format, for example, username@tenantdomain . If you need to index the // documents of more than 100 users, use the OneDriveUserS3Path field to specify // the location of a file containing a list of users. OneDriveUserList []string @@ -2676,8 +2605,8 @@ type OnPremiseConfiguration struct { // connect to GitHub if you require a secure SSL connection. You can simply // generate a self-signed X509 certificate on any computer using OpenSSL. For an // example of using OpenSSL to create an X509 certificate, see Create and sign an - // X509 certificate - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). + // X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html) + // . // // This member is required. SslCertificateS3Path *S3Path @@ -2689,8 +2618,8 @@ type OnPremiseConfiguration struct { // source. This applies to users and groups with specific permissions that define // their level of access to your Amazon Kendra experience. You can create an Amazon // Kendra experience such as a search application. For more information on creating -// a search application experience, see Building a search experience with no code -// (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html). +// a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html) +// . type PersonasSummary struct { // The Unix timestamp when the summary information was created. @@ -2702,9 +2631,9 @@ type PersonasSummary struct { // The persona that defines the specific permissions of the user or group in your // IAM Identity Center identity source. The available personas or access roles are - // Owner and Viewer. For more information on these personas, see Providing access - // to your search page - // (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience). + // Owner and Viewer . For more information on these personas, see Providing access + // to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience) + // . Persona Persona // The Unix timestamp when the summary information was last updated. @@ -2713,8 +2642,8 @@ type PersonasSummary struct { noSmithyDocumentSerde } -// Provides user and group information for user context filtering -// (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). +// Provides user and group information for user context filtering (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) +// . type Principal struct { // Whether to allow or deny document access to the principal. @@ -2755,10 +2684,9 @@ type ProxyConfiguration struct { // This member is required. Port *int32 - // Your secret ARN, which you can create in Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) The - // credentials are optional. You use a secret if web proxy credentials are required - // to connect to a website host. Amazon Kendra currently support basic + // Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // The credentials are optional. You use a secret if web proxy credentials are + // required to connect to a website host. Amazon Kendra currently support basic // authentication to connect to a web proxy server. The secret stores your // credentials. Credentials *string @@ -2776,8 +2704,8 @@ type QueryResultItem struct { AdditionalAttributes []AdditionalResultAttribute // An array of document attributes assigned to a document in the search results. - // For example, the document author (_author) or the source URI (_source_uri) of - // the document. + // For example, the document author ( _author ) or the source URI ( _source_uri ) + // of the document. DocumentAttributes []DocumentAttribute // An extract of the text in the document. Contains information about highlighting @@ -2796,14 +2724,14 @@ type QueryResultItem struct { // A token that identifies a particular result from a particular query. Use this // token to provide click-through feedback for the result. For more information, - // see Submitting feedback - // (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html). + // see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html) + // . FeedbackToken *string - // If the Type of document within the response is ANSWER, then it is either a TABLE - // answer or TEXT answer. If it's a table answer, a table excerpt is returned in - // TableExcerpt. If it's a text answer, a text excerpt is returned in - // DocumentExcerpt. + // If the Type of document within the response is ANSWER , then it is either a + // TABLE answer or TEXT answer. If it's a table answer, a table excerpt is + // returned in TableExcerpt . If it's a text answer, a text excerpt is returned in + // DocumentExcerpt . Format QueryResultFormat // The identifier for the query result. @@ -2811,10 +2739,10 @@ type QueryResultItem struct { // Indicates the confidence that Amazon Kendra has that a result matches the query // that you provided. Each result is placed into a bin that indicates the - // confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine - // if a response meets the confidence needed for your application. The field is - // only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not - // confident that the result matches the query. + // confidence, VERY_HIGH , HIGH , MEDIUM and LOW . You can use the score to + // determine if a response meets the confidence needed for your application. The + // field is only set to LOW when the Type field is set to DOCUMENT and Amazon + // Kendra is not confident that the result matches the query. ScoreAttributes *ScoreAttributes // An excerpt from a table within a document. @@ -2827,11 +2755,12 @@ type QueryResultItem struct { noSmithyDocumentSerde } -// Summary information on a query suggestions block list. This includes information -// on the block list ID, block list name, when the block list was created, when the -// block list was last updated, and the count of block words/phrases in the block -// list. For information on the current quota limits for block lists, see Quotas -// for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). +// Summary information on a query suggestions block list. This includes +// information on the block list ID, block list name, when the block list was +// created, when the block list was last updated, and the count of block +// words/phrases in the block list. For information on the current quota limits for +// block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) +// . type QuerySuggestionsBlockListSummary struct { // The Unix timestamp when the block list was created. @@ -2867,10 +2796,9 @@ type QuipConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // key-value pairs that are required to connect to your Quip. The secret must // contain a JSON structure with the following keys: - // - // * accessToken—The token - // created in Quip. For more information, see Using a Quip data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html). + // - accessToken—The token created in Quip. For more information, see Using a + // Quip data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html) + // . // // This member is required. SecretArn *string @@ -2878,9 +2806,8 @@ type QuipConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Quip attachments to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Quip fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip - // field names must exist in your Quip custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Quip field names must exist in your Quip custom metadata. AttachmentFieldMappings []DataSourceToIndexFieldMapping // TRUE to index attachments. @@ -2892,10 +2819,10 @@ type QuipConfiguration struct { // TRUE to index file comments. CrawlFileComments bool - // A list of regular expression patterns to exclude certain files in your Quip file - // system. Files that match the patterns are excluded from the index. Files that - // don’t match the patterns are included in the index. If a file matches both an - // inclusion pattern and an exclusion pattern, the exclusion pattern takes + // A list of regular expression patterns to exclude certain files in your Quip + // file system. Files that match the patterns are excluded from the index. Files + // that don’t match the patterns are included in the index. If a file matches both + // an inclusion pattern and an exclusion pattern, the exclusion pattern takes // precedence, and the file isn't included in the index. ExclusionPatterns []string @@ -2905,8 +2832,8 @@ type QuipConfiguration struct { // this example is "zlLuOVNSarTL". FolderIds []string - // A list of regular expression patterns to include certain files in your Quip file - // system. Files that match the patterns are included in the index. Files that + // A list of regular expression patterns to include certain files in your Quip + // file system. Files that match the patterns are included in the index. Files that // don't match the patterns are excluded from the index. If a file matches both an // inclusion pattern and an exclusion pattern, the exclusion pattern takes // precedence, and the file isn't included in the index. @@ -2915,22 +2842,20 @@ type QuipConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Quip messages to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Quip fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip - // field names must exist in your Quip custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Quip field names must exist in your Quip custom metadata. MessageFieldMappings []DataSourceToIndexFieldMapping // A list of DataSourceToIndexFieldMapping objects that map attributes or field // names of Quip threads to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Quip fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip - // field names must exist in your Quip custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Quip field names must exist in your Quip custom metadata. ThreadFieldMappings []DataSourceToIndexFieldMapping // Configuration information for an Amazon Virtual Private Cloud (VPC) to connect - // to your Quip. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // to your Quip. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -2952,8 +2877,8 @@ type Relevance struct { // Indicates that this field determines how "fresh" a document is. For example, if // document 1 was created on November 5, and document 2 was created on October 31, - // document 1 is "fresher" than document 2. You can only set the Freshness field on - // one DATE type field. Only applies to DATE fields. + // document 1 is "fresher" than document 2. You can only set the Freshness field + // on one DATE type field. Only applies to DATE fields. Freshness *bool // The relative importance of the field in the search. Larger numbers provide more @@ -2961,9 +2886,9 @@ type Relevance struct { Importance *int32 // Determines how values should be interpreted. When the RankOrder field is - // ASCENDING, higher numbers are better. For example, a document with a rating + // ASCENDING , higher numbers are better. For example, a document with a rating // score of 10 is higher ranking than a document with a rating score of 1. When the - // RankOrder field is DESCENDING, lower numbers are better. For example, in a task + // RankOrder field is DESCENDING , lower numbers are better. For example, in a task // tracking application, a priority 1 task is more important than a priority 5 // task. Only applies to LONG and DOUBLE fields. RankOrder Order @@ -3008,8 +2933,8 @@ type S3DataSourceConfiguration struct { BucketName *string // Provides the path to the S3 bucket that contains the user context filtering - // files for the data source. For the format of the file, see Access control for S3 - // data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html). + // files for the data source. For the format of the file, see Access control for + // S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html) . AccessControlListConfiguration *AccessControlListConfiguration // Document metadata files that contain information such as the document access @@ -3019,35 +2944,25 @@ type S3DataSourceConfiguration struct { // A list of glob patterns for documents that should not be indexed. If a document // that matches an inclusion prefix or inclusion pattern also matches an exclusion - // pattern, the document is not indexed. Some examples - // (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) + // pattern, the document is not indexed. Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) // are: - // - // * *.png , *.jpg will exclude all PNG and JPEG image files in a directory - // (files with the extensions .png and .jpg). - // - // * *internal* will exclude all files - // in a directory that contain 'internal' in the file name, such as 'internal', - // 'internal_only', 'company_internal'. - // - // * **/*internal* will exclude all - // internal-related files in a directory and its subdirectories. + // - *.png , *.jpg will exclude all PNG and JPEG image files in a directory + // (files with the extensions .png and .jpg). + // - *internal* will exclude all files in a directory that contain 'internal' in + // the file name, such as 'internal', 'internal_only', 'company_internal'. + // - **/*internal* will exclude all internal-related files in a directory and + // its subdirectories. ExclusionPatterns []string - // A list of glob patterns for documents that should be indexed. If a document that - // matches an inclusion pattern also matches an exclusion pattern, the document is - // not indexed. Some examples - // (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) + // A list of glob patterns for documents that should be indexed. If a document + // that matches an inclusion pattern also matches an exclusion pattern, the + // document is not indexed. Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) // are: - // - // * *.txt will include all text files in a directory (files with the - // extension .txt). - // - // * **/*.txt will include all text files in a directory and its - // subdirectories. - // - // * *tax* will include all files in a directory that contain - // 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'. + // - *.txt will include all text files in a directory (files with the extension + // .txt). + // - **/*.txt will include all text files in a directory and its subdirectories. + // - *tax* will include all files in a directory that contain 'tax' in the file + // name, such as 'tax', 'taxes', 'income_tax'. InclusionPatterns []string // A list of S3 prefixes for the documents that should be included in the index. @@ -3124,25 +3039,17 @@ type SalesforceConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the // key/value pairs required to connect to your Salesforce instance. The secret must // contain a JSON structure with the following keys: - // - // * authenticationUrl - The - // OAUTH endpoint that Amazon Kendra connects to get an OAUTH token. - // - // * consumerKey - // - The application public key generated when you created your Salesforce - // application. - // - // * consumerSecret - The application private key generated when you - // created your Salesforce application. - // - // * password - The password associated with - // the user logging in to the Salesforce instance. - // - // * securityToken - The token - // associated with the user logging in to the Salesforce instance. - // - // * username - - // The user name of the user logging in to the Salesforce instance. + // - authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get + // an OAUTH token. + // - consumerKey - The application public key generated when you created your + // Salesforce application. + // - consumerSecret - The application private key generated when you created + // your Salesforce application. + // - password - The password associated with the user logging in to the + // Salesforce instance. + // - securityToken - The token associated with the user logging in to the + // Salesforce instance. + // - username - The user name of the user logging in to the Salesforce instance. // // This member is required. SecretArn *string @@ -3193,8 +3100,8 @@ type SalesforceConfiguration struct { // Provides the configuration information for indexing Salesforce custom articles. type SalesforceCustomKnowledgeArticleTypeConfiguration struct { - // The name of the field in the custom knowledge article that contains the document - // data to index. + // The name of the field in the custom knowledge article that contains the + // document data to index. // // This member is required. DocumentDataFieldName *string @@ -3204,15 +3111,14 @@ type SalesforceCustomKnowledgeArticleTypeConfiguration struct { // This member is required. Name *string - // The name of the field in the custom knowledge article that contains the document - // title. + // The name of the field in the custom knowledge article that contains the + // document title. DocumentTitleFieldName *string // Maps attributes or field names of the custom knowledge article to Amazon Kendra // index field names. To create custom fields, use the UpdateIndex API before you - // map to Salesforce fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Salesforce data source field names must exist in your Salesforce custom + // map to Salesforce fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Salesforce data source field names must exist in your Salesforce custom // metadata. FieldMappings []DataSourceToIndexFieldMapping @@ -3225,8 +3131,8 @@ type SalesforceCustomKnowledgeArticleTypeConfiguration struct { // articles, but not both type SalesforceKnowledgeArticleConfiguration struct { - // Specifies the document states that should be included when Amazon Kendra indexes - // knowledge articles. You must specify at least one state. + // Specifies the document states that should be included when Amazon Kendra + // indexes knowledge articles. You must specify at least one state. // // This member is required. IncludedStates []SalesforceKnowledgeArticleState @@ -3254,9 +3160,8 @@ type SalesforceStandardKnowledgeArticleTypeConfiguration struct { // Maps attributes or field names of the knowledge article to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to - // Salesforce fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Salesforce data source field names must exist in your Salesforce custom + // Salesforce fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Salesforce data source field names must exist in your Salesforce custom // metadata. FieldMappings []DataSourceToIndexFieldMapping @@ -3297,9 +3202,8 @@ type SalesforceStandardObjectConfiguration struct { // Maps attributes or field names of the standard object to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to - // Salesforce fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // Salesforce data source field names must exist in your Salesforce custom + // Salesforce fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Salesforce data source field names must exist in your Salesforce custom // metadata. FieldMappings []DataSourceToIndexFieldMapping @@ -3320,22 +3224,22 @@ type ScoreAttributes struct { type Search struct { // Determines whether the field is returned in the query response. The default is - // true. + // true . Displayable bool - // Indicates that the field can be used to create search facets, a count of results - // for each value in the field. The default is false . + // Indicates that the field can be used to create search facets, a count of + // results for each value in the field. The default is false . Facetable bool // Determines whether the field is used in the search. If the Searchable field is - // true, you can use relevance tuning to manually tune how Amazon Kendra weights + // true , you can use relevance tuning to manually tune how Amazon Kendra weights // the field in the search. The default is true for string fields and false for // number and date fields. Searchable bool // Determines whether the field can be used to sort the results of a query. If you - // specify sorting on a field that does not have Sortable set to true, Amazon - // Kendra returns an exception. The default is false. + // specify sorting on a field that does not have Sortable set to true , Amazon + // Kendra returns an exception. The default is false . Sortable bool noSmithyDocumentSerde @@ -3355,20 +3259,15 @@ type SeedUrlConfiguration struct { SeedUrls []string // You can choose one of the following modes: - // - // * HOST_ONLY – crawl only the website - // host names. For example, if the seed URL is "abc.example.com", then only URLs - // with host name "abc.example.com" are crawled. - // - // * SUBDOMAINS – crawl the website - // host names with subdomains. For example, if the seed URL is "abc.example.com", - // then "a.abc.example.com" and "b.abc.example.com" are also crawled. - // - // * EVERYTHING - // – crawl the website host names with subdomains and other domains that the web - // pages link to. - // - // The default mode is set to HOST_ONLY. + // - HOST_ONLY – crawl only the website host names. For example, if the seed URL + // is "abc.example.com", then only URLs with host name "abc.example.com" are + // crawled. + // - SUBDOMAINS – crawl the website host names with subdomains. For example, if + // the seed URL is "abc.example.com", then "a.abc.example.com" and + // "b.abc.example.com" are also crawled. + // - EVERYTHING – crawl the website host names with subdomains and other domains + // that the web pages link to. + // The default mode is set to HOST_ONLY . WebCrawlerMode WebCrawlerMode noSmithyDocumentSerde @@ -3397,26 +3296,26 @@ type ServiceNowConfiguration struct { // The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the // user name and password required to connect to the ServiceNow instance. You can // also provide OAuth authentication credentials of user name, password, client ID, - // and client secret. For more information, see Using a ServiceNow data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html). + // and client secret. For more information, see Using a ServiceNow data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) + // . // // This member is required. SecretArn *string // The identifier of the release that the ServiceNow host is running. If the host - // is not running the LONDON release, use OTHERS. + // is not running the LONDON release, use OTHERS . // // This member is required. ServiceNowBuildVersion ServiceNowBuildVersionType // The type of authentication used to connect to the ServiceNow instance. If you - // choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and + // choose HTTP_BASIC , Amazon Kendra is authenticated using the user name and // password provided in the Secrets Manager secret in the SecretArn field. If you - // choose OAUTH2, Amazon Kendra is authenticated using the credentials of client + // choose OAUTH2 , Amazon Kendra is authenticated using the credentials of client // ID, client secret, user name and password. When you use OAUTH2 authentication, // you must generate a token and a client secret using the ServiceNow console. For - // more information, see Using a ServiceNow data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html). + // more information, see Using a ServiceNow data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) + // . AuthenticationType ServiceNowAuthenticationType // Configuration information for crawling knowledge articles in the ServiceNow @@ -3451,22 +3350,21 @@ type ServiceNowKnowledgeArticleConfiguration struct { // from the index. Items that don't match the patterns are included in the index. // If an item matches both an inclusion and exclusion pattern, the exclusion // pattern takes precedence and the item isn't included in the index. The regex is - // applied to the field specified in the PatternTargetField. + // applied to the field specified in the PatternTargetField . ExcludeAttachmentFilePatterns []string // Maps attributes or field names of knoweldge articles to Amazon Kendra index // field names. To create custom fields, use the UpdateIndex API before you map to - // ServiceNow fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // ServiceNow data source field names must exist in your ServiceNow custom + // ServiceNow fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The ServiceNow data source field names must exist in your ServiceNow custom // metadata. FieldMappings []DataSourceToIndexFieldMapping // A query that selects the knowledge articles to index. The query can return // articles from multiple knowledge bases, and the knowledge bases can be public or // private. The query string must be one generated by the ServiceNow console. For - // more information, see Specifying documents to index with a query - // (https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html). + // more information, see Specifying documents to index with a query (https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html) + // . FilterQuery *string // A list of regular expression patterns to include certain attachments of @@ -3474,14 +3372,14 @@ type ServiceNowKnowledgeArticleConfiguration struct { // in the index. Items that don't match the patterns are excluded from the index. // If an item matches both an inclusion and exclusion pattern, the exclusion // pattern takes precedence and the item isn't included in the index. The regex is - // applied to the field specified in the PatternTargetField. + // applied to the field specified in the PatternTargetField . IncludeAttachmentFilePatterns []string noSmithyDocumentSerde } -// Provides the configuration information for crawling service catalog items in the -// ServiceNow site +// Provides the configuration information for crawling service catalog items in +// the ServiceNow site type ServiceNowServiceCatalogConfiguration struct { // The name of the ServiceNow field that is mapped to the index document contents @@ -3497,9 +3395,9 @@ type ServiceNowServiceCatalogConfiguration struct { // field. DocumentTitleFieldName *string - // A list of regular expression patterns to exclude certain attachments of catalogs - // in your ServiceNow. Item that match the patterns are excluded from the index. - // Items that don't match the patterns are included in the index. If an item + // A list of regular expression patterns to exclude certain attachments of + // catalogs in your ServiceNow. Item that match the patterns are excluded from the + // index. Items that don't match the patterns are included in the index. If an item // matches both an inclusion and exclusion pattern, the exclusion pattern takes // precedence and the item isn't included in the index. The regex is applied to the // file name of the attachment. @@ -3507,18 +3405,17 @@ type ServiceNowServiceCatalogConfiguration struct { // Maps attributes or field names of catalogs to Amazon Kendra index field names. // To create custom fields, use the UpdateIndex API before you map to ServiceNow - // fields. For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // ServiceNow data source field names must exist in your ServiceNow custom + // fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The ServiceNow data source field names must exist in your ServiceNow custom // metadata. FieldMappings []DataSourceToIndexFieldMapping - // A list of regular expression patterns to include certain attachments of catalogs - // in your ServiceNow. Item that match the patterns are included in the index. - // Items that don't match the patterns are excluded from the index. If an item - // matches both an inclusion and exclusion pattern, the exclusion pattern takes - // precedence and the item isn't included in the index. The regex is applied to the - // file name of the attachment. + // A list of regular expression patterns to include certain attachments of + // catalogs in your ServiceNow. Item that match the patterns are included in the + // index. Items that don't match the patterns are excluded from the index. If an + // item matches both an inclusion and exclusion pattern, the exclusion pattern + // takes precedence and the item isn't included in the index. The regex is applied + // to the file name of the attachment. IncludeAttachmentFilePatterns []string noSmithyDocumentSerde @@ -3530,8 +3427,8 @@ type SharePointConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // user name and password required to connect to the SharePoint instance. For more - // information, see Microsoft SharePoint - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html). + // information, see Microsoft SharePoint (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html) + // . // // This member is required. SecretArn *string @@ -3572,9 +3469,8 @@ type SharePointConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map SharePoint data source // attributes or field names to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to SharePoint fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The - // SharePoint data source field names must exist in your SharePoint custom + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The SharePoint data source field names must exist in your SharePoint custom // metadata. FieldMappings []DataSourceToIndexFieldMapping @@ -3605,8 +3501,8 @@ type SharePointConfiguration struct { // connect to SharePoint Server if you require a secure SSL connection. You can // generate a self-signed X509 certificate on any computer using OpenSSL. For an // example of using OpenSSL to create an X509 certificate, see Create and sign an - // X509 certificate - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). + // X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html) + // . SslCertificateS3Path *S3Path // TRUE to use the SharePoint change log to determine which documents require @@ -3615,23 +3511,23 @@ type SharePointConfiguration struct { // SharePoint. UseChangeLog bool - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Microsoft SharePoint. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Microsoft SharePoint. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde } // Provides the configuration information for the sitemap URLs to crawl. When -// selecting websites to index, you must adhere to the Amazon Acceptable Use Policy -// (https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must -// only use Amazon Kendra Web Crawler to index your own web pages, or web pages -// that you have authorization to index. +// selecting websites to index, you must adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) +// and all other Amazon terms. Remember that you must only use Amazon Kendra Web +// Crawler to index your own web pages, or web pages that you have authorization to +// index. type SiteMapsConfiguration struct { - // The list of sitemap URLs of the websites you want to crawl. The list can include - // a maximum of three sitemap URLs. + // The list of sitemap URLs of the websites you want to crawl. The list can + // include a maximum of three sitemap URLs. // // This member is required. SiteMaps []string @@ -3645,17 +3541,15 @@ type SlackConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // key-value pairs required to connect to your Slack workspace team. The secret // must contain a JSON structure with the following keys: - // - // * slackToken—The user or - // bot token created in Slack. For more information on creating a token in Slack, - // see Authentication for a Slack data source - // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication). + // - slackToken—The user or bot token created in Slack. For more information on + // creating a token in Slack, see Authentication for a Slack data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication) + // . // // This member is required. SecretArn *string // The date to start crawling your data from your Slack workspace team. The date - // must follow this format: yyyy-mm-dd. + // must follow this format: yyyy-mm-dd . // // This member is required. SinceCrawlDate *string @@ -3666,10 +3560,10 @@ type SlackConfiguration struct { // This member is required. SlackEntityList []SlackEntity - // The identifier of the team in the Slack workspace. For example, T0123456789. You - // can find your team ID in the URL of the main page of your Slack workspace. When - // you log in to Slack via a browser, you are directed to the URL of the main page. - // For example, https://app.slack.com/client/T0123456789/.... + // The identifier of the team in the Slack workspace. For example, T0123456789. + // You can find your team ID in the URL of the main page of your Slack workspace. + // When you log in to Slack via a browser, you are directed to the URL of the main + // page. For example, https://app.slack.com/client/T0123456789/.... // // This member is required. TeamId *string @@ -3690,9 +3584,8 @@ type SlackConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map Slack data source // attributes or field names to Amazon Kendra index field names. To create custom // fields, use the UpdateIndex API before you map to Slack fields. For more - // information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Slack - // data source field names must exist in your Slack custom metadata. + // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Slack data source field names must exist in your Slack custom metadata. FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain attached files in your @@ -3725,9 +3618,9 @@ type SlackConfiguration struct { // Amazon Kendra to use the change log than to scan all of your documents in Slack. UseChangeLog bool - // Configuration information for an Amazon Virtual Private Cloud to connect to your - // Slack. For more information, see Configuring a VPC - // (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html). + // Configuration information for an Amazon Virtual Private Cloud to connect to + // your Slack. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) + // . VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -3735,42 +3628,30 @@ type SlackConfiguration struct { // Specifies the document attribute to use to sort the response to a Amazon Kendra // query. You can specify a single attribute for sorting. The attribute must have -// the Sortable flag set to true, otherwise Amazon Kendra returns an exception. You -// can sort attributes of the following types. -// -// * Date value -// -// * Long value -// -// * -// String value +// the Sortable flag set to true , otherwise Amazon Kendra returns an exception. +// You can sort attributes of the following types. +// - Date value +// - Long value +// - String value // // You can't sort attributes of the following type. -// -// * String list -// value +// - String list value type SortingConfiguration struct { // The name of the document attribute used to sort the response. You can use any // field that has the Sortable flag set to true. You can also sort by any of the // following built-in attributes: - // - // * _category - // - // * _created_at - // - // * - // _last_updated_at - // - // * _version - // - // * _view_count + // - _category + // - _created_at + // - _last_updated_at + // - _version + // - _view_count // // This member is required. DocumentAttributeKey *string - // The order that the results should be returned in. In case of ties, the relevance - // assigned to the result by Amazon Kendra is used as the tie-breaker. + // The order that the results should be returned in. In case of ties, the + // relevance assigned to the result by Amazon Kendra is used as the tie-breaker. // // This member is required. SortOrder SortOrder @@ -3795,8 +3676,8 @@ type SpellCorrectedQuery struct { // documents and how closely a corrected word matches a misspelled word. This // feature is designed with certain defaults or limits. For information on the // current limits and how to request more support for some limits, see the Spell -// Checker documentation -// (https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html). +// Checker documentation (https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html) +// . type SpellCorrectionConfiguration struct { // TRUE to suggest spell corrections for queries. @@ -3818,7 +3699,7 @@ type SqlConfiguration struct { // characters in identifiers unless they are quoted. Choosing this option encloses // identifiers in quotes so that PostgreSQL does not convert the character's case. // For MySQL databases, you must enable the ansi_quotes option when you set this - // field to DOUBLE_QUOTES. + // field to DOUBLE_QUOTES . QueryIdentifiersEnclosingOption QueryIdentifiersEnclosingOption noSmithyDocumentSerde @@ -3903,9 +3784,9 @@ type TableCell struct { // the query, so the value or content should be highlighted. Highlighted bool - // TRUE if the response of the table cell is the top answer. This is the cell value - // or content with the highest confidence score or is the most relevant to the - // query. + // TRUE if the response of the table cell is the top answer. This is the cell + // value or content with the highest confidence score or is the most relevant to + // the query. TopAnswer bool // The actual value or content within a table cell. A table cell could contain a @@ -3915,9 +3796,9 @@ type TableCell struct { noSmithyDocumentSerde } -// An excerpt from a table within a document. The table excerpt displays up to five -// columns and three rows, depending on how many table cells are relevant to the -// query and how many columns are available in the original table. The top most +// An excerpt from a table within a document. The table excerpt displays up to +// five columns and three rows, depending on how many table cells are relevant to +// the query and how many columns are available in the original table. The top most // relevant cell is displayed in the table excerpt, along with the next most // relevant cells. type TableExcerpt struct { @@ -3951,8 +3832,8 @@ type Tag struct { // This member is required. Key *string - // The value associated with the tag. The value may be an empty string but it can't - // be null. + // The value associated with the tag. The value may be an empty string but it + // can't be null. // // This member is required. Value *string @@ -3965,8 +3846,8 @@ type Tag struct { type TemplateConfiguration struct { // The template schema used for the data source, where templates schemas are - // supported. See Data source template schemas - // (https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html). + // supported. See Data source template schemas (https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) + // . Template document.Interface noSmithyDocumentSerde @@ -4064,26 +3945,23 @@ type Urls struct { // are these documents relevant to all users. Only specific users or groups of // teams given access to top-secret documents should see these documents in their // search results. You provide one of the following: +// - User token +// - User ID, the groups the user belongs to, and any data sources the groups +// can access. // -// * User token -// -// * User ID, the -// groups the user belongs to, and any data sources the groups can access. -// -// If you -// provide both, an exception is thrown. +// If you provide both, an exception is thrown. type UserContext struct { // The list of data source groups you want to filter search results based on // groups' access to documents in that data source. DataSourceGroups []DataSourceGroup - // The list of groups you want to filter search results based on the groups' access - // to documents. + // The list of groups you want to filter search results based on the groups' + // access to documents. Groups []string - // The user context token for filtering search results for a user. It must be a JWT - // or a JSON token. + // The user context token for filtering search results for a user. It must be a + // JWT or a JSON token. Token *string // The identifier of the user you want to filter search results based on their @@ -4096,20 +3974,18 @@ type UserContext struct { // Provides the configuration information to get users and groups from an IAM // Identity Center (successor to Single Sign-On) identity source. This is useful // for user context filtering, where search results are filtered based on the user -// or their group access to documents. You can also use the PutPrincipalMapping -// (https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API -// to map users to their groups so that you only need to provide the user ID when -// you issue the query. To set up an IAM Identity Center identity source in the -// console to use with Amazon Kendra, see Getting started with an IAM Identity -// Center identity source -// (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). You -// must also grant the required permissions to use IAM Identity Center with Amazon -// Kendra. For more information, see IAM roles for IAM Identity Center -// (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso). -// Amazon Kendra currently does not support using UserGroupResolutionConfiguration -// with an Amazon Web Services organization member account for your IAM Identity -// Center identify source. You must create your index in the management account for -// the organization in order to use UserGroupResolutionConfiguration. +// or their group access to documents. You can also use the PutPrincipalMapping (https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) +// API to map users to their groups so that you only need to provide the user ID +// when you issue the query. To set up an IAM Identity Center identity source in +// the console to use with Amazon Kendra, see Getting started with an IAM Identity +// Center identity source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html) +// . You must also grant the required permissions to use IAM Identity Center with +// Amazon Kendra. For more information, see IAM roles for IAM Identity Center (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso) +// . Amazon Kendra currently does not support using +// UserGroupResolutionConfiguration with an Amazon Web Services organization member +// account for your IAM Identity Center identify source. You must create your index +// in the management account for the organization in order to use +// UserGroupResolutionConfiguration . type UserGroupResolutionConfiguration struct { // The identity store provider (mode) you want to use to get users and groups. IAM @@ -4127,13 +4003,12 @@ type UserGroupResolutionConfiguration struct { type UserIdentityConfiguration struct { // The IAM Identity Center field name that contains the identifiers of your users, - // such as their emails. This is used for user context filtering - // (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) and for - // granting access to your Amazon Kendra experience. You must set up IAM Identity - // Center with Amazon Kendra. You must include your users and groups in your Access - // Control List when you ingest documents into your index. For more information, - // see Getting started with an IAM Identity Center identity source - // (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). + // such as their emails. This is used for user context filtering (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) + // and for granting access to your Amazon Kendra experience. You must set up IAM + // Identity Center with Amazon Kendra. You must include your users and groups in + // your Access Control List when you ingest documents into your index. For more + // information, see Getting started with an IAM Identity Center identity source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html) + // . IdentityAttributeName *string noSmithyDocumentSerde @@ -4166,24 +4041,24 @@ type Warning struct { // Provides the configuration information required for Amazon Kendra Web Crawler. type WebCrawlerConfiguration struct { - // Specifies the seed or starting point URLs of the websites or the sitemap URLs of - // the websites you want to crawl. You can include website subdomains. You can list - // up to 100 seed URLs and up to three sitemap URLs. You can only crawl websites - // that use the secure communication protocol, Hypertext Transfer Protocol Secure - // (HTTPS). If you receive an error when crawling a website, it could be that the - // website is blocked from crawling. When selecting websites to index, you must - // adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) and all - // other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to - // index your own web pages, or web pages that you have authorization to index. + // Specifies the seed or starting point URLs of the websites or the sitemap URLs + // of the websites you want to crawl. You can include website subdomains. You can + // list up to 100 seed URLs and up to three sitemap URLs. You can only crawl + // websites that use the secure communication protocol, Hypertext Transfer Protocol + // Secure (HTTPS). If you receive an error when crawling a website, it could be + // that the website is blocked from crawling. When selecting websites to index, you + // must adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) + // and all other Amazon terms. Remember that you must only use Amazon Kendra Web + // Crawler to index your own web pages, or web pages that you have authorization to + // index. // // This member is required. Urls *Urls // Configuration information required to connect to websites using authentication. // You can connect to websites using basic authentication of user name and - // password. You use a secret in Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to - // store your authentication credentials. You must provide the website host name + // password. You use a secret in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // to store your authentication credentials. You must provide the website host name // and port number. For example, the host name of https://a.example.com/page1.html // is "a.example.com" and the port is 443, the standard port for HTTPS. AuthenticationConfiguration *AuthenticationConfiguration @@ -4196,9 +4071,9 @@ type WebCrawlerConfiguration struct { // depth is set to 2. CrawlDepth *int32 - // The maximum size (in MB) of a web page or attachment to crawl. Files larger than - // this size (in MB) are skipped/not crawled. The default maximum size of a web - // page or attachment is set to 50 MB. + // The maximum size (in MB) of a web page or attachment to crawl. Files larger + // than this size (in MB) are skipped/not crawled. The default maximum size of a + // web page or attachment is set to 50 MB. MaxContentSizePerPageInMegaBytes *float32 // The maximum number of URLs on a web page to include when crawling a website. @@ -4207,9 +4082,9 @@ type WebCrawlerConfiguration struct { // appearance. The default maximum links per page is 100. MaxLinksPerPage *int32 - // The maximum number of URLs crawled per website host per minute. A minimum of one - // URL is required. The default maximum number of URLs crawled per website host per - // minute is 300. + // The maximum number of URLs crawled per website host per minute. A minimum of + // one URL is required. The default maximum number of URLs crawled per website host + // per minute is 300. MaxUrlsPerMinuteCrawlRate *int32 // Configuration information required to connect to your internal websites via a @@ -4218,8 +4093,8 @@ type WebCrawlerConfiguration struct { // port is 443, the standard port for HTTPS. Web proxy credentials are optional and // you can use them to connect to a web proxy server that requires basic // authentication. To store web proxy credentials, you use a secret in Secrets - // Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html). + // Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) + // . ProxyConfiguration *ProxyConfiguration // A list of regular expression patterns to exclude certain URLs to crawl. URLs @@ -4245,19 +4120,18 @@ type WebCrawlerConfiguration struct { type WorkDocsConfiguration struct { // The identifier of the directory corresponding to your Amazon WorkDocs site - // repository. You can find the organization ID in the Directory Service - // (https://console.aws.amazon.com/directoryservicev2/) by going to Active - // Directory, then Directories. Your Amazon WorkDocs site directory has an ID, - // which is the organization ID. You can also set up a new Amazon WorkDocs - // directory in the Directory Service console and enable a Amazon WorkDocs site for - // the directory in the Amazon WorkDocs console. + // repository. You can find the organization ID in the Directory Service (https://console.aws.amazon.com/directoryservicev2/) + // by going to Active Directory, then Directories. Your Amazon WorkDocs site + // directory has an ID, which is the organization ID. You can also set up a new + // Amazon WorkDocs directory in the Directory Service console and enable a Amazon + // WorkDocs site for the directory in the Amazon WorkDocs console. // // This member is required. OrganizationId *string // TRUE to include comments on documents in your index. Including comments in your // index means each comment is a document that can be searched on. The default is - // set to FALSE. + // set to FALSE . CrawlComments bool // A list of regular expression patterns to exclude certain files in your Amazon @@ -4269,11 +4143,10 @@ type WorkDocsConfiguration struct { // A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data // source attributes or field names to Amazon Kendra index field names. To create - // custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. - // For more information, see Mapping data source fields - // (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Amazon - // WorkDocs data source field names must exist in your Amazon WorkDocs custom - // metadata. + // custom fields, use the UpdateIndex API before you map to Amazon WorkDocs + // fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) + // . The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs + // custom metadata. FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files in your Amazon diff --git a/service/kendraranking/api_client.go b/service/kendraranking/api_client.go index a58377ee5c8..c7d4e197494 100644 --- a/service/kendraranking/api_client.go +++ b/service/kendraranking/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kendraranking/api_op_CreateRescoreExecutionPlan.go b/service/kendraranking/api_op_CreateRescoreExecutionPlan.go index de0b8d2ffd8..afb0143733c 100644 --- a/service/kendraranking/api_op_CreateRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_CreateRescoreExecutionPlan.go @@ -17,8 +17,8 @@ import ( // number of capacity units that you require for Amazon Kendra Intelligent Ranking // to rescore or re-rank a search service's results. For an example of using the // CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see -// Semantically ranking a search service's results -// (https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html). +// Semantically ranking a search service's results (https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html) +// . func (c *Client) CreateRescoreExecutionPlan(ctx context.Context, params *CreateRescoreExecutionPlanInput, optFns ...func(*Options)) (*CreateRescoreExecutionPlanOutput, error) { if params == nil { params = &CreateRescoreExecutionPlanInput{} @@ -44,8 +44,9 @@ type CreateRescoreExecutionPlanInput struct { // You can set additional capacity units to meet the needs of your rescore // execution plan. You are given a single capacity unit by default. If you want to // use the default capacity, you don't set additional capacity units. For more - // information on the default capacity and additional capacity units, see Adjusting - // capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html). + // information on the default capacity and additional capacity units, see + // Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) + // . CapacityUnits *types.CapacityUnitsConfiguration // A token that you provide to identify the request to create a rescore execution diff --git a/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go b/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go index 7a9abac857f..6cbaca3d646 100644 --- a/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go @@ -49,8 +49,8 @@ type DescribeRescoreExecutionPlanOutput struct { // The capacity units set for the rescore execution plan. A capacity of zero // indicates that the rescore execution plan is using the default capacity. For // more information on the default capacity and additional capacity units, see - // Adjusting capacity - // (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html). + // Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) + // . CapacityUnits *types.CapacityUnitsConfiguration // The Unix timestamp of when the rescore execution plan was created. @@ -59,8 +59,8 @@ type DescribeRescoreExecutionPlanOutput struct { // The description for the rescore execution plan. Description *string - // When the Status field value is FAILED, the ErrorMessage field contains a message - // that explains why. + // When the Status field value is FAILED , the ErrorMessage field contains a + // message that explains why. ErrorMessage *string // The identifier of the rescore execution plan. @@ -69,8 +69,8 @@ type DescribeRescoreExecutionPlanOutput struct { // The name for the rescore execution plan. Name *string - // The current status of the rescore execution plan. When the value is ACTIVE, the - // rescore execution plan is ready for use. If the Status field value is FAILED, + // The current status of the rescore execution plan. When the value is ACTIVE , the + // rescore execution plan is ready for use. If the Status field value is FAILED , // the ErrorMessage field contains a message that explains why. Status types.RescoreExecutionPlanStatus diff --git a/service/kendraranking/api_op_ListRescoreExecutionPlans.go b/service/kendraranking/api_op_ListRescoreExecutionPlans.go index 2f287469a3b..bcd42d99eed 100644 --- a/service/kendraranking/api_op_ListRescoreExecutionPlans.go +++ b/service/kendraranking/api_op_ListRescoreExecutionPlans.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra -// Intelligent Ranking resource used for provisioning the Rescore API. +// Lists your rescore execution plans. A rescore execution plan is an Amazon +// Kendra Intelligent Ranking resource used for provisioning the Rescore API. func (c *Client) ListRescoreExecutionPlans(ctx context.Context, params *ListRescoreExecutionPlansInput, optFns ...func(*Options)) (*ListRescoreExecutionPlansOutput, error) { if params == nil { params = &ListRescoreExecutionPlansInput{} diff --git a/service/kendraranking/api_op_Rescore.go b/service/kendraranking/api_op_Rescore.go index 6695461ad5e..8e87f8969e7 100644 --- a/service/kendraranking/api_op_Rescore.go +++ b/service/kendraranking/api_op_Rescore.go @@ -54,9 +54,9 @@ type RescoreInput struct { type RescoreOutput struct { - // The identifier associated with the scores that Amazon Kendra Intelligent Ranking - // gives to the results. Amazon Kendra Intelligent Ranking rescores or re-ranks the - // results for the search service. + // The identifier associated with the scores that Amazon Kendra Intelligent + // Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores or + // re-ranks the results for the search service. RescoreId *string // A list of result items for documents with new relevancy scores. The results are diff --git a/service/kendraranking/api_op_TagResource.go b/service/kendraranking/api_op_TagResource.go index 2881b972cd1..2bf74da3bbb 100644 --- a/service/kendraranking/api_op_TagResource.go +++ b/service/kendraranking/api_op_TagResource.go @@ -49,8 +49,8 @@ type TagResourceInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/kendraranking/api_op_UntagResource.go b/service/kendraranking/api_op_UntagResource.go index ea2a4ee5663..4f076e4cd9b 100644 --- a/service/kendraranking/api_op_UntagResource.go +++ b/service/kendraranking/api_op_UntagResource.go @@ -28,8 +28,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, return out, nil } -// The request information to remove a tag from a rescore execution plan. A rescore -// execution plan is an Amazon Kendra Intelligent Ranking resource used for +// The request information to remove a tag from a rescore execution plan. A +// rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for // provisioning the Rescore API. type UntagResourceInput struct { @@ -47,8 +47,8 @@ type UntagResourceInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go b/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go index b1a2ac950a3..fb7d556c779 100644 --- a/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go @@ -40,8 +40,9 @@ type UpdateRescoreExecutionPlanInput struct { // You can set additional capacity units to meet the needs of your rescore // execution plan. You are given a single capacity unit by default. If you want to // use the default capacity, you don't set additional capacity units. For more - // information on the default capacity and additional capacity units, see Adjusting - // capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html). + // information on the default capacity and additional capacity units, see + // Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) + // . CapacityUnits *types.CapacityUnitsConfiguration // A new description for the rescore execution plan. diff --git a/service/kendraranking/types/errors.go b/service/kendraranking/types/errors.go index 531f92cac1e..a02f904df79 100644 --- a/service/kendraranking/types/errors.go +++ b/service/kendraranking/types/errors.go @@ -144,10 +144,9 @@ func (e *ResourceUnavailableException) ErrorCode() string { func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // You have exceeded the set limits for your Amazon Kendra Intelligent Ranking -// service. Please see Quotas -// (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, -// or contact Support (http://aws.amazon.com/contact-us/) to inquire about an -// increase of limits. +// service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) +// for more information, or contact Support (http://aws.amazon.com/contact-us/) to +// inquire about an increase of limits. type ServiceQuotaExceededException struct { Message *string diff --git a/service/kendraranking/types/types.go b/service/kendraranking/types/types.go index dcf234e0aee..52a116716d1 100644 --- a/service/kendraranking/types/types.go +++ b/service/kendraranking/types/types.go @@ -43,29 +43,29 @@ type Document struct { // The body text of the search service's document. Body *string - // The optional group identifier of the document from the search service. Documents - // with the same group identifier are grouped together and processed as one - // document within the service. + // The optional group identifier of the document from the search service. + // Documents with the same group identifier are grouped together and processed as + // one document within the service. GroupId *string // The title of the search service's document. Title *string // The body text of the search service's document represented as a list of tokens - // or words. You must choose to provide Body or TokenizedBody. You cannot provide + // or words. You must choose to provide Body or TokenizedBody . You cannot provide // both. TokenizedBody []string // The title of the search service's document represented as a list of tokens or - // words. You must choose to provide Title or TokenizedTitle. You cannot provide + // words. You must choose to provide Title or TokenizedTitle . You cannot provide // both. TokenizedTitle []string noSmithyDocumentSerde } -// Summary information for a rescore execution plan. A rescore execution plan is an -// Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore +// Summary information for a rescore execution plan. A rescore execution plan is +// an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore // API. type RescoreExecutionPlanSummary struct { @@ -78,7 +78,7 @@ type RescoreExecutionPlanSummary struct { // The name of the rescore execution plan. Name *string - // The current status of the rescore execution plan. When the value is ACTIVE, the + // The current status of the rescore execution plan. When the value is ACTIVE , the // rescore execution plan is ready for use. Status RescoreExecutionPlanStatus @@ -103,8 +103,8 @@ type RescoreResultItem struct { // A key-value pair that identifies or categorizes a rescore execution plan. A // rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for -// provisioning the Rescore API. You can also use a tag to help control access to a -// rescore execution plan. A tag key and value can consist of Unicode letters, +// provisioning the Rescore API. You can also use a tag to help control access to +// a rescore execution plan. A tag key and value can consist of Unicode letters, // digits, white space, and any of the following symbols: _ . : / = + - @. type Tag struct { @@ -113,8 +113,8 @@ type Tag struct { // This member is required. Key *string - // The value associated with the tag. The value can be an empty string but it can't - // be null. + // The value associated with the tag. The value can be an empty string but it + // can't be null. // // This member is required. Value *string diff --git a/service/keyspaces/api_client.go b/service/keyspaces/api_client.go index 466608e120e..0ceaa32e2d3 100644 --- a/service/keyspaces/api_client.go +++ b/service/keyspaces/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/keyspaces/api_op_CreateKeyspace.go b/service/keyspaces/api_op_CreateKeyspace.go index 14ff4b337da..8ed0d544fc8 100644 --- a/service/keyspaces/api_op_CreateKeyspace.go +++ b/service/keyspaces/api_op_CreateKeyspace.go @@ -15,8 +15,7 @@ import ( // Web Services account, keyspace names must be unique within each Region. // CreateKeyspace is an asynchronous operation. You can monitor the creation status // of the new keyspace by using the GetKeyspace operation. For more information, -// see Creating keyspaces -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create) +// see Creating keyspaces (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create) // in the Amazon Keyspaces Developer Guide. func (c *Client) CreateKeyspace(ctx context.Context, params *CreateKeyspaceInput, optFns ...func(*Options)) (*CreateKeyspaceOutput, error) { if params == nil { @@ -41,8 +40,7 @@ type CreateKeyspaceInput struct { KeyspaceName *string // A list of key-value pair tags to be attached to the keyspace. For more - // information, see Adding tags and labels to Amazon Keyspaces resources - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) + // information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) // in the Amazon Keyspaces Developer Guide. Tags []types.Tag diff --git a/service/keyspaces/api_op_CreateTable.go b/service/keyspaces/api_op_CreateTable.go index 229425fd981..f575aa66d89 100644 --- a/service/keyspaces/api_op_CreateTable.go +++ b/service/keyspaces/api_op_CreateTable.go @@ -13,11 +13,10 @@ import ( // The CreateTable operation adds a new table to the specified keyspace. Within a // keyspace, table names must be unique. CreateTable is an asynchronous operation. -// When the request is received, the status of the table is set to CREATING. You +// When the request is received, the status of the table is set to CREATING . You // can monitor the creation status of the new table by using the GetTable // operation, which returns the current status of the table. You can start using a -// table when the status is ACTIVE. For more information, see Creating tables -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create) +// table when the status is ACTIVE . For more information, see Creating tables (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create) // in the Amazon Keyspaces Developer Guide. func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { @@ -41,42 +40,24 @@ type CreateTableInput struct { // This member is required. KeyspaceName *string - // The schemaDefinition consists of the following parameters. For each column to be - // created: - // - // * name - The name of the column. - // - // * type - An Amazon Keyspaces data - // type. For more information, see Data types - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) - // in the Amazon Keyspaces Developer Guide. - // - // The primary key of the table consists - // of the following columns: - // - // * partitionKeys - The partition key can be a single - // column, or it can be a compound value composed of two or more columns. The - // partition key portion of the primary key is required and determines how Amazon - // Keyspaces stores your data. - // - // * name - The name of each partition key column. - // - // * - // clusteringKeys - The optional clustering column portion of your primary key - // determines how the data is clustered and sorted within each partition. - // - // * name - - // The name of the clustering column. - // - // * orderBy - Sets the ascendant (ASC) or - // descendant (DESC) order modifier. To define a column as static use staticColumns - // - Static columns store values that are shared by all rows in the same - // partition: - // - // * name - The name of the column. - // - // * type - An Amazon Keyspaces data - // type. + // The schemaDefinition consists of the following parameters. For each column to + // be created: + // - name - The name of the column. + // - type - An Amazon Keyspaces data type. For more information, see Data types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // in the Amazon Keyspaces Developer Guide. + // The primary key of the table consists of the following columns: + // - partitionKeys - The partition key can be a single column, or it can be a + // compound value composed of two or more columns. The partition key portion of the + // primary key is required and determines how Amazon Keyspaces stores your data. + // - name - The name of each partition key column. + // - clusteringKeys - The optional clustering column portion of your primary key + // determines how the data is clustered and sorted within each partition. + // - name - The name of the clustering column. + // - orderBy - Sets the ascendant ( ASC ) or descendant ( DESC ) order modifier. + // To define a column as static use staticColumns - Static columns store values + // that are shared by all rows in the same partition: + // - name - The name of the column. + // - type - An Amazon Keyspaces data type. // // This member is required. SchemaDefinition *types.SchemaDefinition @@ -88,86 +69,62 @@ type CreateTableInput struct { // Specifies the read/write throughput capacity mode for the table. The options // are: - // - // * throughputMode:PAY_PER_REQUEST and - // - // * throughputMode:PROVISIONED - - // Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as - // input. - // - // The default is throughput_mode:PAY_PER_REQUEST. For more information, - // see Read/write capacity modes - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // - throughputMode:PAY_PER_REQUEST and + // - throughputMode:PROVISIONED - Provisioned capacity mode requires + // readCapacityUnits and writeCapacityUnits as input. + // The default is throughput_mode:PAY_PER_REQUEST . For more information, see + // Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. CapacitySpecification *types.CapacitySpecification // Enables client-side timestamps for the table. By default, the setting is // disabled. You can enable client-side timestamps with the following option: - // - // * - // status: "enabled" - // - // Once client-side timestamps are enabled for a table, this - // setting cannot be disabled. + // - status: "enabled" + // Once client-side timestamps are enabled for a table, this setting cannot be + // disabled. ClientSideTimestamps *types.ClientSideTimestamps // This parameter allows to enter a description of the table. Comment *types.Comment - // The default Time to Live setting in seconds for the table. For more information, - // see Setting the default TTL value for a table - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) + // The default Time to Live setting in seconds for the table. For more + // information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) // in the Amazon Keyspaces Developer Guide. DefaultTimeToLive *int32 // Specifies how the encryption key for encryption at rest is managed for the // table. You can choose one of the following KMS key (KMS key): - // - // * - // type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. - // - // * - // type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is - // created, owned, and managed by you. This option requires the kms_key_identifier - // of the KMS key in Amazon Resource Name (ARN) format as input. - // - // The default is - // type:AWS_OWNED_KMS_KEY. For more information, see Encryption at rest - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in - // the Amazon Keyspaces Developer Guide. + // - type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. + // - type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is + // created, owned, and managed by you. This option requires the + // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as + // input. + // The default is type:AWS_OWNED_KMS_KEY . For more information, see Encryption at + // rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) + // in the Amazon Keyspaces Developer Guide. EncryptionSpecification *types.EncryptionSpecification // Specifies if pointInTimeRecovery is enabled or disabled for the table. The // options are: - // - // * status=ENABLED - // - // * status=DISABLED - // - // If it's not specified, the - // default is status=DISABLED. For more information, see Point-in-time recovery - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // - status=ENABLED + // - status=DISABLED + // If it's not specified, the default is status=DISABLED . For more information, + // see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) // in the Amazon Keyspaces Developer Guide. PointInTimeRecovery *types.PointInTimeRecovery // A list of key-value pair tags to be attached to the resource. For more - // information, see Adding tags and labels to Amazon Keyspaces resources - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) + // information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) // in the Amazon Keyspaces Developer Guide. Tags []types.Tag // Enables Time to Live custom settings for the table. The options are: - // - // * - // status:enabled - // - // * status:disabled - // - // The default is status:disabled. After ttl is - // enabled, you can't disable it for the table. For more information, see Expiring - // data by using Amazon Keyspaces Time to Live (TTL) - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html) in the Amazon - // Keyspaces Developer Guide. + // - status:enabled + // - status:disabled + // The default is status:disabled . After ttl is enabled, you can't disable it for + // the table. For more information, see Expiring data by using Amazon Keyspaces + // Time to Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html) + // in the Amazon Keyspaces Developer Guide. Ttl *types.TimeToLive noSmithyDocumentSerde diff --git a/service/keyspaces/api_op_DeleteTable.go b/service/keyspaces/api_op_DeleteTable.go index 291392278da..bfd36ab1825 100644 --- a/service/keyspaces/api_op_DeleteTable.go +++ b/service/keyspaces/api_op_DeleteTable.go @@ -14,9 +14,10 @@ import ( // DeleteTable request is received, the specified table is in the DELETING state // until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE // state, you can delete it. If a table is either in the CREATING or UPDATING -// states, then Amazon Keyspaces returns a ResourceInUseException. If the specified -// table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If -// the table is already in the DELETING state, no error is returned. +// states, then Amazon Keyspaces returns a ResourceInUseException . If the +// specified table does not exist, Amazon Keyspaces returns a +// ResourceNotFoundException . If the table is already in the DELETING state, no +// error is returned. func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) { if params == nil { params = &DeleteTableInput{} diff --git a/service/keyspaces/api_op_GetTable.go b/service/keyspaces/api_op_GetTable.go index 873f0e501ad..7e355e1ae1b 100644 --- a/service/keyspaces/api_op_GetTable.go +++ b/service/keyspaces/api_op_GetTable.go @@ -14,7 +14,7 @@ import ( // Returns information about the table, including the table's name and current // status, the keyspace name, configuration settings, and metadata. To read table -// metadata using GetTable, Select action permissions for the table and system +// metadata using GetTable , Select action permissions for the table and system // tables are required to complete the operation. func (c *Client) GetTable(ctx context.Context, params *GetTableInput, optFns ...func(*Options)) (*GetTableOutput, error) { if params == nil { @@ -64,11 +64,8 @@ type GetTableOutput struct { TableName *string // The read/write throughput capacity mode for a table. The options are: - // - // * - // throughputMode:PAY_PER_REQUEST - // - // * throughputMode:PROVISIONED + // - throughputMode:PAY_PER_REQUEST + // - throughputMode:PROVISIONED CapacitySpecification *types.CapacitySpecificationSummary // The client-side timestamps setting of the table. diff --git a/service/keyspaces/api_op_ListKeyspaces.go b/service/keyspaces/api_op_ListKeyspaces.go index e487b463f58..aca7fcc1495 100644 --- a/service/keyspaces/api_op_ListKeyspaces.go +++ b/service/keyspaces/api_op_ListKeyspaces.go @@ -31,9 +31,9 @@ func (c *Client) ListKeyspaces(ctx context.Context, params *ListKeyspacesInput, type ListKeyspacesInput struct { // The total number of keyspaces to return in the output. If the total number of - // keyspaces available is more than the value specified, a NextToken is provided in - // the output. To resume pagination, provide the NextToken value as an argument of - // a subsequent API invocation. + // keyspaces available is more than the value specified, a NextToken is provided + // in the output. To resume pagination, provide the NextToken value as an argument + // of a subsequent API invocation. MaxResults *int32 // The pagination token. To resume pagination, provide the NextToken value as @@ -130,9 +130,9 @@ var _ ListKeyspacesAPIClient = (*Client)(nil) // ListKeyspacesPaginatorOptions is the paginator options for ListKeyspaces type ListKeyspacesPaginatorOptions struct { // The total number of keyspaces to return in the output. If the total number of - // keyspaces available is more than the value specified, a NextToken is provided in - // the output. To resume pagination, provide the NextToken value as an argument of - // a subsequent API invocation. + // keyspaces available is more than the value specified, a NextToken is provided + // in the output. To resume pagination, provide the NextToken value as an argument + // of a subsequent API invocation. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/keyspaces/api_op_ListTagsForResource.go b/service/keyspaces/api_op_ListTagsForResource.go index 647355d9580..e976343a48d 100644 --- a/service/keyspaces/api_op_ListTagsForResource.go +++ b/service/keyspaces/api_op_ListTagsForResource.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/keyspaces/api_op_RestoreTable.go b/service/keyspaces/api_op_RestoreTable.go index 84010ad3d9e..c88a8d5be9f 100644 --- a/service/keyspaces/api_op_RestoreTable.go +++ b/service/keyspaces/api_op_RestoreTable.go @@ -14,44 +14,30 @@ import ( // Restores the specified table to the specified point in time within the // earliest_restorable_timestamp and the current time. For more information about -// restore points, see Time window for PITR continuous backups -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window) +// restore points, see Time window for PITR continuous backups (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window) // in the Amazon Keyspaces Developer Guide. Any number of users can execute up to 4 // concurrent restores (any type of restore) in a given account. When you restore // using point in time recovery, Amazon Keyspaces restores your source table's // schema and data to the state based on the selected timestamp // (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are // also restored to the state based on the selected timestamp. In addition to the -// table's schema, data, and TTL settings, RestoreTable restores the capacity mode, -// encryption, and point-in-time recovery settings from the source table. Unlike -// the table's schema data and TTL settings, which are restored based on the +// table's schema, data, and TTL settings, RestoreTable restores the capacity +// mode, encryption, and point-in-time recovery settings from the source table. +// Unlike the table's schema data and TTL settings, which are restored based on the // selected timestamp, these settings are always restored based on the table's // settings as of the current time or when the table was deleted. You can also // overwrite these settings during restore: +// - Read/write capacity mode +// - Provisioned throughput capacity settings +// - Point-in-time (PITR) settings +// - Tags // -// * Read/write capacity mode -// -// * -// Provisioned throughput capacity settings -// -// * Point-in-time (PITR) settings -// -// * -// Tags -// -// For more information, see PITR restore settings -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings) +// For more information, see PITR restore settings (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings) // in the Amazon Keyspaces Developer Guide. Note that the following settings are // not restored, and you must configure them manually for the new table: -// -// * -// Automatic scaling policies (for tables that use provisioned capacity mode) -// -// * -// Identity and Access Management (IAM) policies -// -// * Amazon CloudWatch metrics and -// alarms +// - Automatic scaling policies (for tables that use provisioned capacity mode) +// - Identity and Access Management (IAM) policies +// - Amazon CloudWatch metrics and alarms func (c *Client) RestoreTable(ctx context.Context, params *RestoreTableInput, optFns ...func(*Options)) (*RestoreTableOutput, error) { if params == nil { params = &RestoreTableInput{} @@ -91,46 +77,32 @@ type RestoreTableInput struct { // Specifies the read/write throughput capacity mode for the target table. The // options are: - // - // * throughputMode:PAY_PER_REQUEST - // - // * throughputMode:PROVISIONED - - // Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as - // input. - // - // The default is throughput_mode:PAY_PER_REQUEST. For more information, - // see Read/write capacity modes - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // - throughputMode:PAY_PER_REQUEST + // - throughputMode:PROVISIONED - Provisioned capacity mode requires + // readCapacityUnits and writeCapacityUnits as input. + // The default is throughput_mode:PAY_PER_REQUEST . For more information, see + // Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. CapacitySpecificationOverride *types.CapacitySpecification // Specifies the encryption settings for the target table. You can choose one of // the following KMS key (KMS key): - // - // * type:AWS_OWNED_KMS_KEY - This key is owned - // by Amazon Keyspaces. - // - // * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in - // your account and is created, owned, and managed by you. This option requires the - // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as - // input. - // - // The default is type:AWS_OWNED_KMS_KEY. For more information, see - // Encryption at rest - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in - // the Amazon Keyspaces Developer Guide. + // - type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. + // - type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is + // created, owned, and managed by you. This option requires the + // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as + // input. + // The default is type:AWS_OWNED_KMS_KEY . For more information, see Encryption at + // rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) + // in the Amazon Keyspaces Developer Guide. EncryptionSpecificationOverride *types.EncryptionSpecification // Specifies the pointInTimeRecovery settings for the target table. The options // are: - // - // * status=ENABLED - // - // * status=DISABLED - // - // If it's not specified, the default is - // status=DISABLED. For more information, see Point-in-time recovery - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // - status=ENABLED + // - status=DISABLED + // If it's not specified, the default is status=DISABLED . For more information, + // see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) // in the Amazon Keyspaces Developer Guide. PointInTimeRecoveryOverride *types.PointInTimeRecovery @@ -138,8 +110,7 @@ type RestoreTableInput struct { RestoreTimestamp *time.Time // A list of key-value pair tags to be attached to the restored table. For more - // information, see Adding tags and labels to Amazon Keyspaces resources - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) + // information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) // in the Amazon Keyspaces Developer Guide. TagsOverride []types.Tag diff --git a/service/keyspaces/api_op_TagResource.go b/service/keyspaces/api_op_TagResource.go index 1e9990a8d73..7b2037eca6d 100644 --- a/service/keyspaces/api_op_TagResource.go +++ b/service/keyspaces/api_op_TagResource.go @@ -11,15 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a set of tags with a Amazon Keyspaces resource. You can then activate -// these user-defined tags so that they appear on the Cost Management Console for -// cost allocation tracking. For more information, see Adding tags and labels to -// Amazon Keyspaces resources -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) +// Associates a set of tags with a Amazon Keyspaces resource. You can then +// activate these user-defined tags so that they appear on the Cost Management +// Console for cost allocation tracking. For more information, see Adding tags and +// labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) // in the Amazon Keyspaces Developer Guide. For IAM policy examples that show how // to control access to Amazon Keyspaces resources based on tags, see Amazon -// Keyspaces resource access based on tags -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples-tags) +// Keyspaces resource access based on tags (https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples-tags) // in the Amazon Keyspaces Developer Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/keyspaces/api_op_UpdateTable.go b/service/keyspaces/api_op_UpdateTable.go index fc8c3df7c1f..5f1bf5bad6f 100644 --- a/service/keyspaces/api_op_UpdateTable.go +++ b/service/keyspaces/api_op_UpdateTable.go @@ -42,89 +42,59 @@ type UpdateTableInput struct { TableName *string // For each column to be added to the specified table: - // - // * name - The name of the - // column. - // - // * type - An Amazon Keyspaces data type. For more information, see Data - // types - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) - // in the Amazon Keyspaces Developer Guide. + // - name - The name of the column. + // - type - An Amazon Keyspaces data type. For more information, see Data types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // in the Amazon Keyspaces Developer Guide. AddColumns []types.ColumnDefinition // Modifies the read/write throughput capacity mode for the table. The options // are: - // - // * throughputMode:PAY_PER_REQUEST and - // - // * throughputMode:PROVISIONED - - // Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as - // input. - // - // The default is throughput_mode:PAY_PER_REQUEST. For more information, - // see Read/write capacity modes - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // - throughputMode:PAY_PER_REQUEST and + // - throughputMode:PROVISIONED - Provisioned capacity mode requires + // readCapacityUnits and writeCapacityUnits as input. + // The default is throughput_mode:PAY_PER_REQUEST . For more information, see + // Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. CapacitySpecification *types.CapacitySpecification // Enables client-side timestamps for the table. By default, the setting is // disabled. You can enable client-side timestamps with the following option: - // - // * - // status: "enabled" - // - // Once client-side timestamps are enabled for a table, this - // setting cannot be disabled. + // - status: "enabled" + // Once client-side timestamps are enabled for a table, this setting cannot be + // disabled. ClientSideTimestamps *types.ClientSideTimestamps - // The default Time to Live setting in seconds for the table. For more information, - // see Setting the default TTL value for a table - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) + // The default Time to Live setting in seconds for the table. For more + // information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl) // in the Amazon Keyspaces Developer Guide. DefaultTimeToLive *int32 // Modifies the encryption settings of the table. You can choose one of the // following KMS key (KMS key): - // - // * type:AWS_OWNED_KMS_KEY - This key is owned by - // Amazon Keyspaces. - // - // * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your - // account and is created, owned, and managed by you. This option requires the - // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as - // input. - // - // The default is AWS_OWNED_KMS_KEY. For more information, see Encryption - // at rest - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in - // the Amazon Keyspaces Developer Guide. + // - type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. + // - type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is + // created, owned, and managed by you. This option requires the + // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as + // input. + // The default is AWS_OWNED_KMS_KEY . For more information, see Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) + // in the Amazon Keyspaces Developer Guide. EncryptionSpecification *types.EncryptionSpecification // Modifies the pointInTimeRecovery settings of the table. The options are: - // - // * - // status=ENABLED - // - // * status=DISABLED - // - // If it's not specified, the default is - // status=DISABLED. For more information, see Point-in-time recovery - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) + // - status=ENABLED + // - status=DISABLED + // If it's not specified, the default is status=DISABLED . For more information, + // see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) // in the Amazon Keyspaces Developer Guide. PointInTimeRecovery *types.PointInTimeRecovery // Modifies Time to Live custom settings for the table. The options are: - // - // * - // status:enabled - // - // * status:disabled - // - // The default is status:disabled. After ttl is - // enabled, you can't disable it for the table. For more information, see Expiring - // data by using Amazon Keyspaces Time to Live (TTL) - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html) in the Amazon - // Keyspaces Developer Guide. + // - status:enabled + // - status:disabled + // The default is status:disabled . After ttl is enabled, you can't disable it for + // the table. For more information, see Expiring data by using Amazon Keyspaces + // Time to Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html) + // in the Amazon Keyspaces Developer Guide. Ttl *types.TimeToLive noSmithyDocumentSerde diff --git a/service/keyspaces/doc.go b/service/keyspaces/doc.go index 18633aedbd3..af4873424f5 100644 --- a/service/keyspaces/doc.go +++ b/service/keyspaces/doc.go @@ -15,14 +15,12 @@ // as infrastructure as code (IaC) services and tools such as CloudFormation and // Terraform. This API reference describes the supported DDL operations in detail. // For the list of all supported CQL APIs, see Supported Cassandra APIs, -// operations, and data types in Amazon Keyspaces -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html) in -// the Amazon Keyspaces Developer Guide. To learn how Amazon Keyspaces API actions -// are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail) +// operations, and data types in Amazon Keyspaces (https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html) +// in the Amazon Keyspaces Developer Guide. To learn how Amazon Keyspaces API +// actions are recorded with CloudTrail, see Amazon Keyspaces information in +// CloudTrail (https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail) // in the Amazon Keyspaces Developer Guide. For more information about Amazon Web // Services APIs, for example how to implement retry logic or how to sign Amazon -// Web Services API requests, see Amazon Web Services APIs -// (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html) in the General -// Reference. +// Web Services API requests, see Amazon Web Services APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html) +// in the General Reference. package keyspaces diff --git a/service/keyspaces/types/enums.go b/service/keyspaces/types/enums.go index 9a206e96fd1..087b142b4ae 100644 --- a/service/keyspaces/types/enums.go +++ b/service/keyspaces/types/enums.go @@ -62,9 +62,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", diff --git a/service/keyspaces/types/errors.go b/service/keyspaces/types/errors.go index 194daa468d7..65919e9c019 100644 --- a/service/keyspaces/types/errors.go +++ b/service/keyspaces/types/errors.go @@ -61,8 +61,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Keyspaces was unable to fully process this request because of an internal -// server error. +// Amazon Keyspaces was unable to fully process this request because of an +// internal server error. type InternalServerException struct { Message *string @@ -89,7 +89,7 @@ func (e *InternalServerException) ErrorCode() string { func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // The operation tried to access a keyspace or table that doesn't exist. The -// resource might not be specified correctly, or its status might not be ACTIVE. +// resource might not be specified correctly, or its status might not be ACTIVE . type ResourceNotFoundException struct { Message *string @@ -117,10 +117,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation exceeded the service quota for this resource. For more information -// on service quotas, see Quotas -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html) in the -// Amazon Keyspaces Developer Guide. +// The operation exceeded the service quota for this resource. For more +// information on service quotas, see Quotas (https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html) +// in the Amazon Keyspaces Developer Guide. type ServiceQuotaExceededException struct { Message *string diff --git a/service/keyspaces/types/types.go b/service/keyspaces/types/types.go index 07b7860ac96..3768cd22f57 100644 --- a/service/keyspaces/types/types.go +++ b/service/keyspaces/types/types.go @@ -9,72 +9,51 @@ import ( // Amazon Keyspaces has two read/write capacity modes for processing reads and // writes on your tables: +// - On-demand (default) +// - Provisioned // -// * On-demand (default) -// -// * Provisioned -// -// The read/write -// capacity mode that you choose controls how you are charged for read and write -// throughput and how table throughput capacity is managed. For more information, -// see Read/write capacity modes -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) +// The read/write capacity mode that you choose controls how you are charged for +// read and write throughput and how table throughput capacity is managed. For more +// information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. type CapacitySpecification struct { // The read/write throughput capacity mode for a table. The options are: - // - // * - // throughputMode:PAY_PER_REQUEST and - // - // * throughputMode:PROVISIONED - Provisioned - // capacity mode requires readCapacityUnits and writeCapacityUnits as input. - // - // The - // default is throughput_mode:PAY_PER_REQUEST. For more information, see Read/write - // capacity modes - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // - throughputMode:PAY_PER_REQUEST and + // - throughputMode:PROVISIONED - Provisioned capacity mode requires + // readCapacityUnits and writeCapacityUnits as input. + // The default is throughput_mode:PAY_PER_REQUEST . For more information, see + // Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. // // This member is required. ThroughputMode ThroughputMode // The throughput capacity specified for read operations defined in read capacity - // units(RCUs). + // units (RCUs) . ReadCapacityUnits *int64 - // The throughput capacity specified for write operations defined in write capacity - // units(WCUs). + // The throughput capacity specified for write operations defined in write + // capacity units (WCUs) . WriteCapacityUnits *int64 noSmithyDocumentSerde } // The read/write throughput capacity mode for a table. The options are: +// - throughputMode:PAY_PER_REQUEST and +// - throughputMode:PROVISIONED . // -// * -// throughputMode:PAY_PER_REQUEST and -// -// * throughputMode:PROVISIONED. -// -// For more -// information, see Read/write capacity modes -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) +// For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. type CapacitySpecificationSummary struct { // The read/write throughput capacity mode for a table. The options are: - // - // * - // throughputMode:PAY_PER_REQUEST and - // - // * throughputMode:PROVISIONED - Provisioned - // capacity mode requires readCapacityUnits and writeCapacityUnits as input. - // - // The - // default is throughput_mode:PAY_PER_REQUEST. For more information, see Read/write - // capacity modes - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) + // - throughputMode:PAY_PER_REQUEST and + // - throughputMode:PROVISIONED - Provisioned capacity mode requires + // readCapacityUnits and writeCapacityUnits as input. + // The default is throughput_mode:PAY_PER_REQUEST . For more information, see + // Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) // in the Amazon Keyspaces Developer Guide. // // This member is required. @@ -85,19 +64,18 @@ type CapacitySpecificationSummary struct { LastUpdateToPayPerRequestTimestamp *time.Time // The throughput capacity specified for read operations defined in read capacity - // units(RCUs). + // units (RCUs) . ReadCapacityUnits *int64 - // The throughput capacity specified for write operations defined in write capacity - // units(WCUs). + // The throughput capacity specified for write operations defined in write + // capacity units (WCUs) . WriteCapacityUnits *int64 noSmithyDocumentSerde } -// The client-side timestamp setting of the table. For more information, see How it -// works: Amazon Keyspaces client-side timestamps -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html) +// The client-side timestamp setting of the table. For more information, see How +// it works: Amazon Keyspaces client-side timestamps (https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html) // in the Amazon Keyspaces Developer Guide. type ClientSideTimestamps struct { @@ -118,7 +96,7 @@ type ClusteringKey struct { // This member is required. Name *string - // Sets the ascendant (ASC) or descendant (DESC) order modifier. + // Sets the ascendant ( ASC ) or descendant ( DESC ) order modifier. // // This member is required. OrderBy SortOrder @@ -134,8 +112,7 @@ type ColumnDefinition struct { // This member is required. Name *string - // The data type of the column. For a list of available data types, see Data types - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) + // The data type of the column. For a list of available data types, see Data types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) // in the Amazon Keyspaces Developer Guide. // // This member is required. @@ -158,45 +135,35 @@ type Comment struct { // Amazon Keyspaces encrypts and decrypts the table data at rest transparently and // integrates with Key Management Service for storing and managing the encryption // key. You can choose one of the following KMS keys (KMS keys): +// - Amazon Web Services owned key - This is the default encryption type. The +// key is owned by Amazon Keyspaces (no additional charge). +// - Customer managed key - This key is stored in your account and is created, +// owned, and managed by you. You have full control over the customer managed key +// (KMS charges apply). // -// * Amazon Web -// Services owned key - This is the default encryption type. The key is owned by -// Amazon Keyspaces (no additional charge). -// -// * Customer managed key - This key is -// stored in your account and is created, owned, and managed by you. You have full -// control over the customer managed key (KMS charges apply). -// -// For more information -// about encryption at rest in Amazon Keyspaces, see Encryption at rest -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in -// the Amazon Keyspaces Developer Guide. For more information about KMS, see KMS -// management service concepts -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in -// the Key Management Service Developer Guide. +// For more information about encryption at rest in Amazon Keyspaces, see +// Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) +// in the Amazon Keyspaces Developer Guide. For more information about KMS, see +// KMS management service concepts (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) +// in the Key Management Service Developer Guide. type EncryptionSpecification struct { // The encryption option specified for the table. You can choose one of the // following KMS keys (KMS keys): - // - // * type:AWS_OWNED_KMS_KEY - This key is owned by - // Amazon Keyspaces. - // - // * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your - // account and is created, owned, and managed by you. This option requires the - // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as - // input. - // - // The default is type:AWS_OWNED_KMS_KEY. For more information, see - // Encryption at rest - // (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in - // the Amazon Keyspaces Developer Guide. + // - type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces. + // - type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is + // created, owned, and managed by you. This option requires the + // kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as + // input. + // The default is type:AWS_OWNED_KMS_KEY . For more information, see Encryption at + // rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) + // in the Amazon Keyspaces Developer Guide. // // This member is required. Type EncryptionType // The Amazon Resource Name (ARN) of the customer managed KMS key, for example - // kms_key_identifier:ARN. + // kms_key_identifier:ARN . KmsKeyIdentifier *string noSmithyDocumentSerde @@ -234,16 +201,13 @@ type PartitionKey struct { // Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from // accidental write or delete operations by providing you continuous backups of -// your table data. For more information, see Point-in-time recovery -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) +// your table data. For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) // in the Amazon Keyspaces Developer Guide. type PointInTimeRecovery struct { // The options are: - // - // * status=ENABLED - // - // * status=DISABLED + // - status=ENABLED + // - status=DISABLED // // This member is required. Status PointInTimeRecoveryStatus @@ -281,7 +245,7 @@ type SchemaDefinition struct { // The columns that are part of the clustering key of the table. ClusteringKeys []ClusteringKey - // The columns that have been defined as STATIC. Static columns store values that + // The columns that have been defined as STATIC . Static columns store values that // are shared by all rows in the same partition. StaticColumns []StaticColumn @@ -325,12 +289,11 @@ type TableSummary struct { // Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a // single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and -// values are automatically assigned the aws: prefix, which the user cannot assign. -// Amazon Web Services-assigned tag names do not count towards the tag limit of 50. -// User-assigned tag names have the prefix user: in the Cost Allocation Report. You -// cannot backdate the application of a tag. For more information, see Adding tags -// and labels to Amazon Keyspaces resources -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) +// values are automatically assigned the aws: prefix, which the user cannot +// assign. Amazon Web Services-assigned tag names do not count towards the tag +// limit of 50. User-assigned tag names have the prefix user: in the Cost +// Allocation Report. You cannot backdate the application of a tag. For more +// information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) // in the Amazon Keyspaces Developer Guide. type Tag struct { @@ -349,10 +312,9 @@ type Tag struct { noSmithyDocumentSerde } -// Enable custom Time to Live (TTL) settings for rows and columns without setting a -// TTL default for the specified table. For more information, see Enabling TTL on -// tables -// (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling) +// Enable custom Time to Live (TTL) settings for rows and columns without setting +// a TTL default for the specified table. For more information, see Enabling TTL +// on tables (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling) // in the Amazon Keyspaces Developer Guide. type TimeToLive struct { diff --git a/service/kinesis/api_client.go b/service/kinesis/api_client.go index 01893b6e27e..a22c2fa2074 100644 --- a/service/kinesis/api_client.go +++ b/service/kinesis/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesis/api_op_AddTagsToStream.go b/service/kinesis/api_op_AddTagsToStream.go index cb4c6fd649c..b75459e5353 100644 --- a/service/kinesis/api_op_AddTagsToStream.go +++ b/service/kinesis/api_op_AddTagsToStream.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or updates tags for the specified Kinesis data stream. You can assign up to -// 50 tags to a data stream. When invoking this API, it is recommended you use the -// StreamARN input parameter rather than the StreamName input parameter. If tags -// have already been assigned to the stream, AddTagsToStream overwrites any +// Adds or updates tags for the specified Kinesis data stream. You can assign up +// to 50 tags to a data stream. When invoking this API, it is recommended you use +// the StreamARN input parameter rather than the StreamName input parameter. If +// tags have already been assigned to the stream, AddTagsToStream overwrites any // existing tags that correspond to the specified tag keys. AddTagsToStream has a // limit of five transactions per second per account. func (c *Client) AddTagsToStream(ctx context.Context, params *AddTagsToStreamInput, optFns ...func(*Options)) (*AddTagsToStreamOutput, error) { @@ -31,7 +31,7 @@ func (c *Client) AddTagsToStream(ctx context.Context, params *AddTagsToStreamInp return out, nil } -// Represents the input for AddTagsToStream. +// Represents the input for AddTagsToStream . type AddTagsToStreamInput struct { // A set of up to 10 key-value pairs to use to create the tags. diff --git a/service/kinesis/api_op_CreateStream.go b/service/kinesis/api_op_CreateStream.go index dc8e221c152..2efeb50b275 100644 --- a/service/kinesis/api_op_CreateStream.go +++ b/service/kinesis/api_op_CreateStream.go @@ -30,27 +30,21 @@ import ( // streams in two different accounts can have the same name, and two streams in the // same account, but in two different Regions, can have the same name. CreateStream // is an asynchronous operation. Upon receiving a CreateStream request, Kinesis -// Data Streams immediately returns and sets the stream status to CREATING. After -// the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. +// Data Streams immediately returns and sets the stream status to CREATING . After +// the stream is created, Kinesis Data Streams sets the stream status to ACTIVE . // You should perform read and write operations only on an ACTIVE stream. You -// receive a LimitExceededException when making a CreateStream request when you try -// to do one of the following: +// receive a LimitExceededException when making a CreateStream request when you +// try to do one of the following: +// - Have more than five streams in the CREATING state at any point in time. +// - Create more shards than are authorized for your account. // -// * Have more than five streams in the CREATING state -// at any point in time. -// -// * Create more shards than are authorized for your -// account. -// -// For the default shard limit for an Amazon Web Services account, see -// Amazon Kinesis Data Streams Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// For the default shard limit for an Amazon Web Services account, see Amazon +// Kinesis Data Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, -// contact Amazon Web Services Support -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). You can -// use DescribeStreamSummary to check the stream status, which is returned in -// StreamStatus. CreateStream has a limit of five transactions per second per -// account. +// contact Amazon Web Services Support (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// . You can use DescribeStreamSummary to check the stream status, which is +// returned in StreamStatus . CreateStream has a limit of five transactions per +// second per account. func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { params = &CreateStreamInput{} @@ -66,7 +60,7 @@ func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, op return out, nil } -// Represents the input for CreateStream. +// Represents the input for CreateStream . type CreateStreamInput struct { // A name to identify the stream. The stream name is scoped to the Amazon Web @@ -79,8 +73,8 @@ type CreateStreamInput struct { // This member is required. StreamName *string - // The number of shards that the stream will use. The throughput of the stream is a - // function of the number of shards; more shards are required for greater + // The number of shards that the stream will use. The throughput of the stream is + // a function of the number of shards; more shards are required for greater // provisioned throughput. ShardCount *int32 diff --git a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go index b4e2a562bda..3b0d868cd0b 100644 --- a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go +++ b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go @@ -32,7 +32,7 @@ func (c *Client) DecreaseStreamRetentionPeriod(ctx context.Context, params *Decr return out, nil } -// Represents the input for DecreaseStreamRetentionPeriod. +// Represents the input for DecreaseStreamRetentionPeriod . type DecreaseStreamRetentionPeriodInput struct { // The new retention period of the stream, in hours. Must be less than the current diff --git a/service/kinesis/api_op_DeleteStream.go b/service/kinesis/api_op_DeleteStream.go index 13e5b2e7cde..136ebfb29be 100644 --- a/service/kinesis/api_op_DeleteStream.go +++ b/service/kinesis/api_op_DeleteStream.go @@ -13,17 +13,17 @@ import ( // Deletes a Kinesis data stream and all its shards and data. You must shut down // any applications that are operating on the stream before you delete the stream. // If an application attempts to operate on a deleted stream, it receives the -// exception ResourceNotFoundException. When invoking this API, it is recommended +// exception ResourceNotFoundException . When invoking this API, it is recommended // you use the StreamARN input parameter rather than the StreamName input // parameter. If the stream is in the ACTIVE state, you can delete it. After a // DeleteStream request, the specified stream is in the DELETING state until // Kinesis Data Streams completes the deletion. Note: Kinesis Data Streams might -// continue to accept data read and write operations, such as PutRecord, -// PutRecords, and GetRecords, on a stream in the DELETING state until the stream -// deletion is complete. When you delete a stream, any shards in that stream are -// also deleted, and any tags are dissociated from the stream. You can use the +// continue to accept data read and write operations, such as PutRecord , +// PutRecords , and GetRecords , on a stream in the DELETING state until the +// stream deletion is complete. When you delete a stream, any shards in that stream +// are also deleted, and any tags are dissociated from the stream. You can use the // DescribeStreamSummary operation to check the state of the stream, which is -// returned in StreamStatus. DeleteStream has a limit of five transactions per +// returned in StreamStatus . DeleteStream has a limit of five transactions per // second per account. func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error) { if params == nil { @@ -40,12 +40,12 @@ func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, op return out, nil } -// Represents the input for DeleteStream. +// Represents the input for DeleteStream . type DeleteStreamInput struct { - // If this parameter is unset (null) or if you set it to false, and the stream has - // registered consumers, the call to DeleteStream fails with a - // ResourceInUseException. + // If this parameter is unset ( null ) or if you set it to false , and the stream + // has registered consumers, the call to DeleteStream fails with a + // ResourceInUseException . EnforceConsumerDeletion *bool // The ARN of the stream. diff --git a/service/kinesis/api_op_DeregisterStreamConsumer.go b/service/kinesis/api_op_DeregisterStreamConsumer.go index 022437e35f4..4a211063e79 100644 --- a/service/kinesis/api_op_DeregisterStreamConsumer.go +++ b/service/kinesis/api_op_DeregisterStreamConsumer.go @@ -47,8 +47,8 @@ type DeregisterStreamConsumerInput struct { // The ARN of the Kinesis data stream that the consumer is registered with. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . StreamARN *string noSmithyDocumentSerde diff --git a/service/kinesis/api_op_DescribeLimits.go b/service/kinesis/api_op_DescribeLimits.go index 9a1b45d75b7..34a558400a4 100644 --- a/service/kinesis/api_op_DescribeLimits.go +++ b/service/kinesis/api_op_DescribeLimits.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the shard limits and usage for the account. If you update your account -// limits, the old limits might be returned for a few minutes. This operation has a -// limit of one transaction per second per account. +// Describes the shard limits and usage for the account. If you update your +// account limits, the old limits might be returned for a few minutes. This +// operation has a limit of one transaction per second per account. func (c *Client) DescribeLimits(ctx context.Context, params *DescribeLimitsInput, optFns ...func(*Options)) (*DescribeLimitsOutput, error) { if params == nil { params = &DescribeLimitsInput{} diff --git a/service/kinesis/api_op_DescribeStream.go b/service/kinesis/api_op_DescribeStream.go index be97cd7e8b9..b7e64b947d5 100644 --- a/service/kinesis/api_op_DescribeStream.go +++ b/service/kinesis/api_op_DescribeStream.go @@ -30,8 +30,7 @@ import ( // creating the shard. Every record ingested in the stream is identified by a // sequence number, which is assigned when the record is put into the stream. You // can limit the number of shards returned by each call. For more information, see -// Retrieving Shards from a Stream -// (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html) +// Retrieving Shards from a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html) // in the Amazon Kinesis Data Streams Developer Guide. There are no guarantees // about the chronological order shards returned. To process shards in // chronological order, use the ID of the parent shard to track the lineage to the @@ -52,14 +51,14 @@ func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput return out, nil } -// Represents the input for DescribeStream. +// Represents the input for DescribeStream . type DescribeStreamInput struct { - // The shard ID of the shard to start with. Specify this parameter to indicate that - // you want to describe the stream starting with the shard whose ID immediately - // follows ExclusiveStartShardId. If you don't specify this parameter, the default - // behavior for DescribeStream is to describe the stream starting with the first - // shard in the stream. + // The shard ID of the shard to start with. Specify this parameter to indicate + // that you want to describe the stream starting with the shard whose ID + // immediately follows ExclusiveStartShardId . If you don't specify this parameter, + // the default behavior for DescribeStream is to describe the stream starting with + // the first shard in the stream. ExclusiveStartShardId *string // The maximum number of shards to return in a single call. The default value is @@ -75,7 +74,7 @@ type DescribeStreamInput struct { noSmithyDocumentSerde } -// Represents the output for DescribeStream. +// Represents the output for DescribeStream . type DescribeStreamOutput struct { // The current status of the stream, the stream Amazon Resource Name (ARN), an @@ -172,9 +171,9 @@ type StreamExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -331,9 +330,9 @@ type StreamNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -373,9 +372,9 @@ func NewStreamNotExistsWaiter(client DescribeStreamAPIClient, optFns ...func(*St } } -// Wait calls the waiter function for StreamNotExists waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for StreamNotExists waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *StreamNotExistsWaiter) Wait(ctx context.Context, params *DescribeStreamInput, maxWaitDur time.Duration, optFns ...func(*StreamNotExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/kinesis/api_op_DescribeStreamConsumer.go b/service/kinesis/api_op_DescribeStreamConsumer.go index ec83237c152..2627709007a 100644 --- a/service/kinesis/api_op_DescribeStreamConsumer.go +++ b/service/kinesis/api_op_DescribeStreamConsumer.go @@ -44,8 +44,8 @@ type DescribeStreamConsumerInput struct { // The ARN of the Kinesis data stream that the consumer is registered with. For // more information, see Amazon Resource Names (ARNs) and Amazon Web Services - // Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . StreamARN *string noSmithyDocumentSerde diff --git a/service/kinesis/api_op_DisableEnhancedMonitoring.go b/service/kinesis/api_op_DisableEnhancedMonitoring.go index c20a2a4e50d..86852c2e145 100644 --- a/service/kinesis/api_op_DisableEnhancedMonitoring.go +++ b/service/kinesis/api_op_DisableEnhancedMonitoring.go @@ -28,34 +28,21 @@ func (c *Client) DisableEnhancedMonitoring(ctx context.Context, params *DisableE return out, nil } -// Represents the input for DisableEnhancedMonitoring. +// Represents the input for DisableEnhancedMonitoring . type DisableEnhancedMonitoringInput struct { // List of shard-level metrics to disable. The following are the valid shard-level - // metrics. The value "ALL" disables every metric. - // - // * IncomingBytes - // - // * - // IncomingRecords - // - // * OutgoingBytes - // - // * OutgoingRecords - // - // * - // WriteProvisionedThroughputExceeded - // - // * ReadProvisionedThroughputExceeded - // - // * - // IteratorAgeMilliseconds - // - // * ALL - // - // For more information, see Monitoring the Amazon - // Kinesis Data Streams Service with Amazon CloudWatch - // (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // metrics. The value " ALL " disables every metric. + // - IncomingBytes + // - IncomingRecords + // - OutgoingBytes + // - OutgoingRecords + // - WriteProvisionedThroughputExceeded + // - ReadProvisionedThroughputExceeded + // - IteratorAgeMilliseconds + // - ALL + // For more information, see Monitoring the Amazon Kinesis Data Streams Service + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. // // This member is required. @@ -70,16 +57,16 @@ type DisableEnhancedMonitoringInput struct { noSmithyDocumentSerde } -// Represents the output for EnableEnhancedMonitoring and -// DisableEnhancedMonitoring. +// Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring +// . type DisableEnhancedMonitoringOutput struct { // Represents the current state of the metrics that are in the enhanced state // before the operation. CurrentShardLevelMetrics []types.MetricsName - // Represents the list of all the metrics that would be in the enhanced state after - // the operation. + // Represents the list of all the metrics that would be in the enhanced state + // after the operation. DesiredShardLevelMetrics []types.MetricsName // The ARN of the stream. diff --git a/service/kinesis/api_op_EnableEnhancedMonitoring.go b/service/kinesis/api_op_EnableEnhancedMonitoring.go index 5318be33322..f9bff6b0c12 100644 --- a/service/kinesis/api_op_EnableEnhancedMonitoring.go +++ b/service/kinesis/api_op_EnableEnhancedMonitoring.go @@ -29,34 +29,21 @@ func (c *Client) EnableEnhancedMonitoring(ctx context.Context, params *EnableEnh return out, nil } -// Represents the input for EnableEnhancedMonitoring. +// Represents the input for EnableEnhancedMonitoring . type EnableEnhancedMonitoringInput struct { // List of shard-level metrics to enable. The following are the valid shard-level - // metrics. The value "ALL" enables every metric. - // - // * IncomingBytes - // - // * - // IncomingRecords - // - // * OutgoingBytes - // - // * OutgoingRecords - // - // * - // WriteProvisionedThroughputExceeded - // - // * ReadProvisionedThroughputExceeded - // - // * - // IteratorAgeMilliseconds - // - // * ALL - // - // For more information, see Monitoring the Amazon - // Kinesis Data Streams Service with Amazon CloudWatch - // (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // metrics. The value " ALL " enables every metric. + // - IncomingBytes + // - IncomingRecords + // - OutgoingBytes + // - OutgoingRecords + // - WriteProvisionedThroughputExceeded + // - ReadProvisionedThroughputExceeded + // - IteratorAgeMilliseconds + // - ALL + // For more information, see Monitoring the Amazon Kinesis Data Streams Service + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. // // This member is required. @@ -71,16 +58,16 @@ type EnableEnhancedMonitoringInput struct { noSmithyDocumentSerde } -// Represents the output for EnableEnhancedMonitoring and -// DisableEnhancedMonitoring. +// Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring +// . type EnableEnhancedMonitoringOutput struct { // Represents the current state of the metrics that are in the enhanced state // before the operation. CurrentShardLevelMetrics []types.MetricsName - // Represents the list of all the metrics that would be in the enhanced state after - // the operation. + // Represents the list of all the metrics that would be in the enhanced state + // after the operation. DesiredShardLevelMetrics []types.MetricsName // The ARN of the stream. diff --git a/service/kinesis/api_op_GetRecords.go b/service/kinesis/api_op_GetRecords.go index 7d2671cea95..b84a972027f 100644 --- a/service/kinesis/api_op_GetRecords.go +++ b/service/kinesis/api_op_GetRecords.go @@ -13,8 +13,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets data records from a Kinesis data stream's shard. When invoking this API, it -// is recommended you use the StreamARN input parameter in addition to the +// Gets data records from a Kinesis data stream's shard. When invoking this API, +// it is recommended you use the StreamARN input parameter in addition to the // ShardIterator parameter. Specify a shard iterator using the ShardIterator // parameter. The shard iterator specifies the position in the shard from which you // want to start reading data records sequentially. If there are no records @@ -22,16 +22,15 @@ import ( // returns an empty list. It might take multiple calls to get to a portion of the // shard that contains records. You can scale by provisioning multiple shards per // stream while considering service limits (for more information, see Amazon -// Kinesis Data Streams Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// Kinesis Data Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide). Your application should // have one thread per shard, each reading continuously from its stream. To read // from a stream continually, call GetRecords in a loop. Use GetShardIterator to // get the shard iterator to specify in the first GetRecords call. GetRecords -// returns a new shard iterator in NextShardIterator. Specify the shard iterator -// returned in NextShardIterator in subsequent calls to GetRecords. If the shard +// returns a new shard iterator in NextShardIterator . Specify the shard iterator +// returned in NextShardIterator in subsequent calls to GetRecords . If the shard // has been closed, the shard iterator can't return more data and GetRecords -// returns null in NextShardIterator. You can terminate the loop when the shard is +// returns null in NextShardIterator . You can terminate the loop when the shard is // closed, or when the shard iterator reaches the record with the sequence number // or other attribute that marks it as the last record to process. Each data record // can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You @@ -45,26 +44,25 @@ import ( // records less frequently can lead to consumer applications falling behind. The // maximum size of data that GetRecords can return is 10 MiB. If a call returns // this amount of data, subsequent calls made within the next 5 seconds throw -// ProvisionedThroughputExceededException. If there is insufficient provisioned +// ProvisionedThroughputExceededException . If there is insufficient provisioned // throughput on the stream, subsequent calls made within the next 1 second throw -// ProvisionedThroughputExceededException. GetRecords doesn't return any data when -// it throws an exception. For this reason, we recommend that you wait 1 second -// between calls to GetRecords. However, it's possible that the application will -// get exceptions for longer than 1 second. To detect whether the application is -// falling behind in processing, you can use the MillisBehindLatest response +// ProvisionedThroughputExceededException . GetRecords doesn't return any data +// when it throws an exception. For this reason, we recommend that you wait 1 +// second between calls to GetRecords . However, it's possible that the application +// will get exceptions for longer than 1 second. To detect whether the application +// is falling behind in processing, you can use the MillisBehindLatest response // attribute. You can also monitor the stream using CloudWatch metrics and other -// mechanisms (see Monitoring -// (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html) in the Amazon -// Kinesis Data Streams Developer Guide). Each Amazon Kinesis record includes a -// value, ApproximateArrivalTimestamp, that is set when a stream successfully -// receives and stores a record. This is commonly referred to as a server-side time -// stamp, whereas a client-side time stamp is set when a data producer creates or -// sends the record to a stream (a data producer is any data source putting data -// records into a stream, for example with PutRecords). The time stamp has -// millisecond precision. There are no guarantees about the time stamp accuracy, or -// that the time stamp is always increasing. For example, records in a shard or -// across a stream might have time stamps that are out of order. This operation has -// a limit of five transactions per second per shard. +// mechanisms (see Monitoring (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html) +// in the Amazon Kinesis Data Streams Developer Guide). Each Amazon Kinesis record +// includes a value, ApproximateArrivalTimestamp , that is set when a stream +// successfully receives and stores a record. This is commonly referred to as a +// server-side time stamp, whereas a client-side time stamp is set when a data +// producer creates or sends the record to a stream (a data producer is any data +// source putting data records into a stream, for example with PutRecords ). The +// time stamp has millisecond precision. There are no guarantees about the time +// stamp accuracy, or that the time stamp is always increasing. For example, +// records in a shard or across a stream might have time stamps that are out of +// order. This operation has a limit of five transactions per second per shard. func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns ...func(*Options)) (*GetRecordsOutput, error) { if params == nil { params = &GetRecordsInput{} @@ -80,19 +78,19 @@ func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns return out, nil } -// Represents the input for GetRecords. +// Represents the input for GetRecords . type GetRecordsInput struct { - // The position in the shard from which you want to start sequentially reading data - // records. A shard iterator specifies this position using the sequence number of a - // data record in the shard. + // The position in the shard from which you want to start sequentially reading + // data records. A shard iterator specifies this position using the sequence number + // of a data record in the shard. // // This member is required. ShardIterator *string - // The maximum number of records to return. Specify a value of up to 10,000. If you - // specify a value that is greater than 10,000, GetRecords throws - // InvalidArgumentException. The default value is 10,000. + // The maximum number of records to return. Specify a value of up to 10,000. If + // you specify a value that is greater than 10,000, GetRecords throws + // InvalidArgumentException . The default value is 10,000. Limit *int32 // The ARN of the stream. @@ -101,7 +99,7 @@ type GetRecordsInput struct { noSmithyDocumentSerde } -// Represents the output for GetRecords. +// Represents the output for GetRecords . type GetRecordsOutput struct { // The data records retrieved from the shard. @@ -120,7 +118,7 @@ type GetRecordsOutput struct { MillisBehindLatest *int64 // The next position in the shard from which to start sequentially reading data - // records. If set to null, the shard has been closed and the requested iterator + // records. If set to null , the shard has been closed and the requested iterator // does not return any more data. NextShardIterator *string diff --git a/service/kinesis/api_op_GetShardIterator.go b/service/kinesis/api_op_GetShardIterator.go index cad824d6091..0ec94d099dc 100644 --- a/service/kinesis/api_op_GetShardIterator.go +++ b/service/kinesis/api_op_GetShardIterator.go @@ -24,24 +24,23 @@ import ( // exactly from the position denoted by a specific sequence number by using the // AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read // right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard -// iterator type, using sequence numbers returned by earlier calls to PutRecord, -// PutRecords, GetRecords, or DescribeStream. In the request, you can specify the -// shard iterator type AT_TIMESTAMP to read records from an arbitrary point in +// iterator type, using sequence numbers returned by earlier calls to PutRecord , +// PutRecords , GetRecords , or DescribeStream . In the request, you can specify +// the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in // time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record // in the shard in the system (the oldest data record in the shard), or LATEST so // that you always read the most recent data in the shard. When you read repeatedly // from a stream, use a GetShardIterator request to get the first shard iterator // for use in your first GetRecords request and for subsequent reads use the shard -// iterator returned by the GetRecords request in NextShardIterator. A new shard -// iterator is returned by every GetRecords request in NextShardIterator, which you -// use in the ShardIterator parameter of the next GetRecords request. If a +// iterator returned by the GetRecords request in NextShardIterator . A new shard +// iterator is returned by every GetRecords request in NextShardIterator , which +// you use in the ShardIterator parameter of the next GetRecords request. If a // GetShardIterator request is made too often, you receive a -// ProvisionedThroughputExceededException. For more information about throughput -// limits, see GetRecords, and Streams Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// ProvisionedThroughputExceededException . For more information about throughput +// limits, see GetRecords , and Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. If the shard is closed, // GetShardIterator returns a valid iterator for the last sequence number of the -// shard. A shard can be closed as a result of using SplitShard or MergeShards. +// shard. A shard can be closed as a result of using SplitShard or MergeShards . // GetShardIterator has a limit of five transactions per second per account per // open shard. func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorInput, optFns ...func(*Options)) (*GetShardIteratorOutput, error) { @@ -59,7 +58,7 @@ func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorI return out, nil } -// Represents the input for GetShardIterator. +// Represents the input for GetShardIterator . type GetShardIteratorInput struct { // The shard ID of the Kinesis Data Streams shard to get the iterator for. @@ -67,33 +66,25 @@ type GetShardIteratorInput struct { // This member is required. ShardId *string - // Determines how the shard iterator is used to start reading data records from the - // shard. The following are the valid Amazon Kinesis shard iterator types: - // - // * - // AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific - // sequence number, provided in the value StartingSequenceNumber. - // - // * - // AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a - // specific sequence number, provided in the value StartingSequenceNumber. - // - // * - // AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, - // provided in the value Timestamp. - // - // * TRIM_HORIZON - Start reading at the last - // untrimmed record in the shard in the system, which is the oldest data record in - // the shard. - // - // * LATEST - Start reading just after the most recent record in the - // shard, so that you always read the most recent data in the shard. + // Determines how the shard iterator is used to start reading data records from + // the shard. The following are the valid Amazon Kinesis shard iterator types: + // - AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific + // sequence number, provided in the value StartingSequenceNumber . + // - AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a + // specific sequence number, provided in the value StartingSequenceNumber . + // - AT_TIMESTAMP - Start reading from the position denoted by a specific time + // stamp, provided in the value Timestamp . + // - TRIM_HORIZON - Start reading at the last untrimmed record in the shard in + // the system, which is the oldest data record in the shard. + // - LATEST - Start reading just after the most recent record in the shard, so + // that you always read the most recent data in the shard. // // This member is required. ShardIteratorType types.ShardIteratorType - // The sequence number of the data record in the shard from which to start reading. - // Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. + // The sequence number of the data record in the shard from which to start + // reading. Used with shard iterator type AT_SEQUENCE_NUMBER and + // AFTER_SEQUENCE_NUMBER. StartingSequenceNumber *string // The ARN of the stream. @@ -104,7 +95,7 @@ type GetShardIteratorInput struct { // The time stamp of the data record from which to start reading. Used with shard // iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision - // in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. + // in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480 . // If a record with this exact time stamp does not exist, the iterator returned is // for the next (later) record. If the time stamp is older than the current trim // horizon, the iterator returned is for the oldest untrimmed data record @@ -114,12 +105,12 @@ type GetShardIteratorInput struct { noSmithyDocumentSerde } -// Represents the output for GetShardIterator. +// Represents the output for GetShardIterator . type GetShardIteratorOutput struct { - // The position in the shard from which to start reading data records sequentially. - // A shard iterator specifies this position using the sequence number of a data - // record in a shard. + // The position in the shard from which to start reading data records + // sequentially. A shard iterator specifies this position using the sequence number + // of a data record in a shard. ShardIterator *string // Metadata pertaining to the operation's result. diff --git a/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go b/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go index ef141e5cca4..61fda174f13 100644 --- a/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go +++ b/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go @@ -36,7 +36,7 @@ func (c *Client) IncreaseStreamRetentionPeriod(ctx context.Context, params *Incr return out, nil } -// Represents the input for IncreaseStreamRetentionPeriod. +// Represents the input for IncreaseStreamRetentionPeriod . type IncreaseStreamRetentionPeriodInput struct { // The new retention period of the stream, in hours. Must be more than the current diff --git a/service/kinesis/api_op_ListShards.go b/service/kinesis/api_op_ListShards.go index ce44e920914..6dc7c9d994a 100644 --- a/service/kinesis/api_op_ListShards.go +++ b/service/kinesis/api_op_ListShards.go @@ -17,14 +17,13 @@ import ( // invoking this API, it is recommended you use the StreamARN input parameter // rather than the StreamName input parameter. This action does not list expired // shards. For information about expired shards, see Data Routing, Data -// Persistence, and Shard State after a Reshard -// (https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing). -// This API is a new operation that is used by the Amazon Kinesis Client Library +// Persistence, and Shard State after a Reshard (https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing) +// . This API is a new operation that is used by the Amazon Kinesis Client Library // (KCL). If you have a fine-grained IAM policy that only allows specific // operations, you must update your policy to allow calls to this API. For more // information, see Controlling Access to Amazon Kinesis Data Streams Resources -// Using IAM -// (https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html). +// Using IAM (https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html) +// . func (c *Client) ListShards(ctx context.Context, params *ListShardsInput, optFns ...func(*Options)) (*ListShardsOutput, error) { if params == nil { params = &ListShardsInput{} @@ -43,52 +42,52 @@ func (c *Client) ListShards(ctx context.Context, params *ListShardsInput, optFns type ListShardsInput struct { // Specify this parameter to indicate that you want to list the shards starting - // with the shard whose ID immediately follows ExclusiveStartShardId. If you don't + // with the shard whose ID immediately follows ExclusiveStartShardId . If you don't // specify this parameter, the default behavior is for ListShards to list the // shards starting with the first one in the stream. You cannot specify this - // parameter if you specify NextToken. + // parameter if you specify NextToken . ExclusiveStartShardId *string - // The maximum number of shards to return in a single call to ListShards. The + // The maximum number of shards to return in a single call to ListShards . The // maximum number of shards to return in a single call. The default value is 1000. // If you specify a value greater than 1000, at most 1000 results are returned. - // When the number of shards to be listed is greater than the value of MaxResults, - // the response contains a NextToken value that you can use in a subsequent call to - // ListShards to list the next set of shards. + // When the number of shards to be listed is greater than the value of MaxResults , + // the response contains a NextToken value that you can use in a subsequent call + // to ListShards to list the next set of shards. MaxResults *int32 // When the number of shards in the data stream is greater than the default value // for the MaxResults parameter, or if you explicitly specify a value for // MaxResults that is less than the number of shards in the data stream, the - // response includes a pagination token named NextToken. You can specify this + // response includes a pagination token named NextToken . You can specify this // NextToken value in a subsequent call to ListShards to list the next set of // shards. Don't specify StreamName or StreamCreationTimestamp if you specify // NextToken because the latter unambiguously identifies the stream. You can // optionally specify a value for the MaxResults parameter when you specify - // NextToken. If you specify a MaxResults value that is less than the number of - // shards that the operation returns if you don't specify MaxResults, the response + // NextToken . If you specify a MaxResults value that is less than the number of + // shards that the operation returns if you don't specify MaxResults , the response // will contain a new NextToken value. You can use the new NextToken value in a // subsequent call to the ListShards operation. Tokens expire after 300 seconds. - // When you obtain a value for NextToken in the response to a call to ListShards, + // When you obtain a value for NextToken in the response to a call to ListShards , // you have 300 seconds to use that value. If you specify an expired token in a - // call to ListShards, you get ExpiredNextTokenException. + // call to ListShards , you get ExpiredNextTokenException . NextToken *string // Enables you to filter out the response of the ListShards API. You can only - // specify one filter at a time. If you use the ShardFilter parameter when invoking - // the ListShards API, the Type is the required property and must be specified. If - // you specify the AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST types, you do - // not need to specify either the ShardId or the Timestamp optional properties. If - // you specify the AFTER_SHARD_ID type, you must also provide the value for the - // optional ShardId property. The ShardId property is identical in fuctionality to - // the ExclusiveStartShardId parameter of the ListShards API. When ShardId property - // is specified, the response includes the shards starting with the shard whose ID - // immediately follows the ShardId that you provided. If you specify the - // AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also provide the value for the - // optional Timestamp property. If you specify the AT_TIMESTAMP type, then all - // shards that were open at the provided timestamp are returned. If you specify the - // FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP - // are returned. + // specify one filter at a time. If you use the ShardFilter parameter when + // invoking the ListShards API, the Type is the required property and must be + // specified. If you specify the AT_TRIM_HORIZON , FROM_TRIM_HORIZON , or AT_LATEST + // types, you do not need to specify either the ShardId or the Timestamp optional + // properties. If you specify the AFTER_SHARD_ID type, you must also provide the + // value for the optional ShardId property. The ShardId property is identical in + // fuctionality to the ExclusiveStartShardId parameter of the ListShards API. When + // ShardId property is specified, the response includes the shards starting with + // the shard whose ID immediately follows the ShardId that you provided. If you + // specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also provide the + // value for the optional Timestamp property. If you specify the AT_TIMESTAMP + // type, then all shards that were open at the provided timestamp are returned. If + // you specify the FROM_TIMESTAMP type, then all shards starting from the provided + // timestamp to TIP are returned. ShardFilter *types.ShardFilter // The ARN of the stream. @@ -113,19 +112,19 @@ type ListShardsOutput struct { // When the number of shards in the data stream is greater than the default value // for the MaxResults parameter, or if you explicitly specify a value for // MaxResults that is less than the number of shards in the data stream, the - // response includes a pagination token named NextToken. You can specify this + // response includes a pagination token named NextToken . You can specify this // NextToken value in a subsequent call to ListShards to list the next set of // shards. For more information about the use of this pagination token when calling - // the ListShards operation, see ListShardsInput$NextToken. Tokens expire after 300 - // seconds. When you obtain a value for NextToken in the response to a call to - // ListShards, you have 300 seconds to use that value. If you specify an expired - // token in a call to ListShards, you get ExpiredNextTokenException. + // the ListShards operation, see ListShardsInput$NextToken . Tokens expire after + // 300 seconds. When you obtain a value for NextToken in the response to a call to + // ListShards , you have 300 seconds to use that value. If you specify an expired + // token in a call to ListShards , you get ExpiredNextTokenException . NextToken *string - // An array of JSON objects. Each object represents one shard and specifies the IDs - // of the shard, the shard's parent, and the shard that's adjacent to the shard's - // parent. Each object also contains the starting and ending hash keys and the - // starting and ending sequence numbers for the shard. + // An array of JSON objects. Each object represents one shard and specifies the + // IDs of the shard, the shard's parent, and the shard that's adjacent to the + // shard's parent. Each object also contains the starting and ending hash keys and + // the starting and ending sequence numbers for the shard. Shards []types.Shard // Metadata pertaining to the operation's result. diff --git a/service/kinesis/api_op_ListStreamConsumers.go b/service/kinesis/api_op_ListStreamConsumers.go index 63067d27665..f5ba0aba4f6 100644 --- a/service/kinesis/api_op_ListStreamConsumers.go +++ b/service/kinesis/api_op_ListStreamConsumers.go @@ -34,9 +34,9 @@ func (c *Client) ListStreamConsumers(ctx context.Context, params *ListStreamCons type ListStreamConsumersInput struct { // The ARN of the Kinesis data stream for which you want to list the registered - // consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web - // Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // consumers. For more information, see Amazon Resource Names (ARNs) and Amazon + // Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . // // This member is required. StreamARN *string @@ -46,23 +46,23 @@ type ListStreamConsumersInput struct { // greater than 100, at most 100 results are returned. MaxResults *int32 - // When the number of consumers that are registered with the data stream is greater - // than the default value for the MaxResults parameter, or if you explicitly - // specify a value for MaxResults that is less than the number of consumers that - // are registered with the data stream, the response includes a pagination token - // named NextToken. You can specify this NextToken value in a subsequent call to - // ListStreamConsumers to list the next set of registered consumers. Don't specify - // StreamName or StreamCreationTimestamp if you specify NextToken because the - // latter unambiguously identifies the stream. You can optionally specify a value - // for the MaxResults parameter when you specify NextToken. If you specify a - // MaxResults value that is less than the number of consumers that the operation - // returns if you don't specify MaxResults, the response will contain a new - // NextToken value. You can use the new NextToken value in a subsequent call to the - // ListStreamConsumers operation to list the next set of consumers. Tokens expire - // after 300 seconds. When you obtain a value for NextToken in the response to a - // call to ListStreamConsumers, you have 300 seconds to use that value. If you - // specify an expired token in a call to ListStreamConsumers, you get - // ExpiredNextTokenException. + // When the number of consumers that are registered with the data stream is + // greater than the default value for the MaxResults parameter, or if you + // explicitly specify a value for MaxResults that is less than the number of + // consumers that are registered with the data stream, the response includes a + // pagination token named NextToken . You can specify this NextToken value in a + // subsequent call to ListStreamConsumers to list the next set of registered + // consumers. Don't specify StreamName or StreamCreationTimestamp if you specify + // NextToken because the latter unambiguously identifies the stream. You can + // optionally specify a value for the MaxResults parameter when you specify + // NextToken . If you specify a MaxResults value that is less than the number of + // consumers that the operation returns if you don't specify MaxResults , the + // response will contain a new NextToken value. You can use the new NextToken + // value in a subsequent call to the ListStreamConsumers operation to list the + // next set of consumers. Tokens expire after 300 seconds. When you obtain a value + // for NextToken in the response to a call to ListStreamConsumers , you have 300 + // seconds to use that value. If you specify an expired token in a call to + // ListStreamConsumers , you get ExpiredNextTokenException . NextToken *string // Specify this input parameter to distinguish data streams that have the same @@ -80,17 +80,17 @@ type ListStreamConsumersOutput struct { // An array of JSON objects. Each object represents one registered consumer. Consumers []types.Consumer - // When the number of consumers that are registered with the data stream is greater - // than the default value for the MaxResults parameter, or if you explicitly - // specify a value for MaxResults that is less than the number of registered - // consumers, the response includes a pagination token named NextToken. You can - // specify this NextToken value in a subsequent call to ListStreamConsumers to list - // the next set of registered consumers. For more information about the use of this - // pagination token when calling the ListStreamConsumers operation, see - // ListStreamConsumersInput$NextToken. Tokens expire after 300 seconds. When you - // obtain a value for NextToken in the response to a call to ListStreamConsumers, + // When the number of consumers that are registered with the data stream is + // greater than the default value for the MaxResults parameter, or if you + // explicitly specify a value for MaxResults that is less than the number of + // registered consumers, the response includes a pagination token named NextToken . + // You can specify this NextToken value in a subsequent call to ListStreamConsumers + // to list the next set of registered consumers. For more information about the use + // of this pagination token when calling the ListStreamConsumers operation, see + // ListStreamConsumersInput$NextToken . Tokens expire after 300 seconds. When you + // obtain a value for NextToken in the response to a call to ListStreamConsumers , // you have 300 seconds to use that value. If you specify an expired token in a - // call to ListStreamConsumers, you get ExpiredNextTokenException. + // call to ListStreamConsumers , you get ExpiredNextTokenException . NextToken *string // Metadata pertaining to the operation's result. @@ -162,8 +162,8 @@ func (c *Client) addOperationListStreamConsumersMiddlewares(stack *middleware.St return nil } -// ListStreamConsumersAPIClient is a client that implements the ListStreamConsumers -// operation. +// ListStreamConsumersAPIClient is a client that implements the +// ListStreamConsumers operation. type ListStreamConsumersAPIClient interface { ListStreamConsumers(context.Context, *ListStreamConsumersInput, ...func(*Options)) (*ListStreamConsumersOutput, error) } diff --git a/service/kinesis/api_op_ListStreams.go b/service/kinesis/api_op_ListStreams.go index f0ffef1b299..c5ac404729c 100644 --- a/service/kinesis/api_op_ListStreams.go +++ b/service/kinesis/api_op_ListStreams.go @@ -13,15 +13,15 @@ import ( ) // Lists your Kinesis data streams. The number of streams may be too large to -// return from a single call to ListStreams. You can limit the number of returned +// return from a single call to ListStreams . You can limit the number of returned // streams using the Limit parameter. If you do not specify a value for the Limit // parameter, Kinesis Data Streams uses the default limit, which is currently 100. // You can detect if there are more streams available to list by using the // HasMoreStreams flag from the returned output. If there are more streams // available, you can request more streams by using the name of the last stream -// returned by the ListStreams request in the ExclusiveStartStreamName parameter in -// a subsequent request to ListStreams. The group of stream names returned by the -// subsequent request is then added to the list. You can continue this process +// returned by the ListStreams request in the ExclusiveStartStreamName parameter +// in a subsequent request to ListStreams . The group of stream names returned by +// the subsequent request is then added to the list. You can continue this process // until all the stream names have been collected in the list. ListStreams has a // limit of five transactions per second per account. func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { @@ -39,7 +39,7 @@ func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optF return out, nil } -// Represents the input for ListStreams. +// Represents the input for ListStreams . type ListStreamsInput struct { // The name of the stream to start the list with. @@ -55,10 +55,10 @@ type ListStreamsInput struct { noSmithyDocumentSerde } -// Represents the output for ListStreams. +// Represents the output for ListStreams . type ListStreamsOutput struct { - // If set to true, there are more streams available to list. + // If set to true , there are more streams available to list. // // This member is required. HasMoreStreams *bool diff --git a/service/kinesis/api_op_ListTagsForStream.go b/service/kinesis/api_op_ListTagsForStream.go index aad2f3b71a0..bf6f944cdbd 100644 --- a/service/kinesis/api_op_ListTagsForStream.go +++ b/service/kinesis/api_op_ListTagsForStream.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags for the specified Kinesis data stream. This operation has a limit -// of five transactions per second per account. When invoking this API, it is +// Lists the tags for the specified Kinesis data stream. This operation has a +// limit of five transactions per second per account. When invoking this API, it is // recommended you use the StreamARN input parameter rather than the StreamName // input parameter. func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStreamInput, optFns ...func(*Options)) (*ListTagsForStreamOutput, error) { @@ -30,15 +30,15 @@ func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStrea return out, nil } -// Represents the input for ListTagsForStream. +// Represents the input for ListTagsForStream . type ListTagsForStreamInput struct { // The key to use as the starting point for the list of tags. If this parameter is - // set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey. + // set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey . ExclusiveStartTagKey *string // The number of tags to return. If this number is less than the total number of - // tags associated with the stream, HasMoreTags is set to true. To list additional + // tags associated with the stream, HasMoreTags is set to true . To list additional // tags, set ExclusiveStartTagKey to the last key in the response. Limit *int32 @@ -51,17 +51,17 @@ type ListTagsForStreamInput struct { noSmithyDocumentSerde } -// Represents the output for ListTagsForStream. +// Represents the output for ListTagsForStream . type ListTagsForStreamOutput struct { - // If set to true, more tags are available. To request additional tags, set + // If set to true , more tags are available. To request additional tags, set // ExclusiveStartTagKey to the key of the last tag returned. // // This member is required. HasMoreTags *bool - // A list of tags associated with StreamName, starting with the first tag after - // ExclusiveStartTagKey and up to the specified Limit. + // A list of tags associated with StreamName , starting with the first tag after + // ExclusiveStartTagKey and up to the specified Limit . // // This member is required. Tags []types.Tag diff --git a/service/kinesis/api_op_MergeShards.go b/service/kinesis/api_op_MergeShards.go index 39cf1e53703..cb413a64c1c 100644 --- a/service/kinesis/api_op_MergeShards.go +++ b/service/kinesis/api_op_MergeShards.go @@ -24,23 +24,23 @@ import ( // a need to reduce the overall capacity of a stream because of excess capacity // that is not being used. You must specify the shard to be merged and the adjacent // shard for a stream. For more information about merging shards, see Merge Two -// Shards -// (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html) +// Shards (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html) // in the Amazon Kinesis Data Streams Developer Guide. If the stream is in the -// ACTIVE state, you can call MergeShards. If a stream is in the CREATING, -// UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If +// ACTIVE state, you can call MergeShards . If a stream is in the CREATING , +// UPDATING , or DELETING state, MergeShards returns a ResourceInUseException . If // the specified stream does not exist, MergeShards returns a -// ResourceNotFoundException. You can use DescribeStreamSummary to check the state -// of the stream, which is returned in StreamStatus. MergeShards is an asynchronous -// operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams -// immediately returns a response and sets the StreamStatus to UPDATING. After the -// operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. -// Read and write operations continue to work while the stream is in the UPDATING -// state. You use DescribeStreamSummary and the ListShards APIs to determine the -// shard IDs that are specified in the MergeShards request. If you try to operate -// on too many streams in parallel using CreateStream, DeleteStream, MergeShards, -// or SplitShard, you receive a LimitExceededException. MergeShards has a limit of -// five transactions per second per account. +// ResourceNotFoundException . You can use DescribeStreamSummary to check the +// state of the stream, which is returned in StreamStatus . MergeShards is an +// asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis +// Data Streams immediately returns a response and sets the StreamStatus to +// UPDATING . After the operation is completed, Kinesis Data Streams sets the +// StreamStatus to ACTIVE . Read and write operations continue to work while the +// stream is in the UPDATING state. You use DescribeStreamSummary and the +// ListShards APIs to determine the shard IDs that are specified in the MergeShards +// request. If you try to operate on too many streams in parallel using +// CreateStream , DeleteStream , MergeShards , or SplitShard , you receive a +// LimitExceededException . MergeShards has a limit of five transactions per +// second per account. func (c *Client) MergeShards(ctx context.Context, params *MergeShardsInput, optFns ...func(*Options)) (*MergeShardsOutput, error) { if params == nil { params = &MergeShardsInput{} @@ -56,7 +56,7 @@ func (c *Client) MergeShards(ctx context.Context, params *MergeShardsInput, optF return out, nil } -// Represents the input for MergeShards. +// Represents the input for MergeShards . type MergeShardsInput struct { // The shard ID of the adjacent shard for the merge. diff --git a/service/kinesis/api_op_PutRecord.go b/service/kinesis/api_op_PutRecord.go index 13d144c33b4..0cff48dbdf8 100644 --- a/service/kinesis/api_op_PutRecord.go +++ b/service/kinesis/api_op_PutRecord.go @@ -29,21 +29,19 @@ import ( // map associated data records to shards using the hash key ranges of the shards. // You can override hashing the partition key to determine the shard by explicitly // specifying a hash value using the ExplicitHashKey parameter. For more -// information, see Adding Data to a Stream -// (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// information, see Adding Data to a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. PutRecord returns the shard // ID of where the data record was placed and the sequence number that was assigned // to the data record. Sequence numbers increase over time and are specific to a // shard within a stream, not across all shards within a stream. To guarantee // strictly increasing ordering, write serially to a shard and use the // SequenceNumberForOrdering parameter. For more information, see Adding Data to a -// Stream -// (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. After you write a record to // a stream, you cannot modify that record or its order within the stream. If a // PutRecord request cannot be processed because of insufficient provisioned // throughput on the shard involved in the request, PutRecord throws -// ProvisionedThroughputExceededException. By default, data records are accessible +// ProvisionedThroughputExceededException . By default, data records are accessible // for 24 hours from the time that they are added to a stream. You can use // IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this // retention period. @@ -62,7 +60,7 @@ func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns . return out, nil } -// Represents the input for PutRecord. +// Represents the input for PutRecord . type PutRecordInput struct { // The data blob to put into the record, which is base64-encoded when the blob is @@ -105,7 +103,7 @@ type PutRecordInput struct { noSmithyDocumentSerde } -// Represents the output for PutRecord. +// Represents the output for PutRecord . type PutRecordOutput struct { // The sequence number identifier that was assigned to the put data record. The @@ -123,12 +121,9 @@ type PutRecordOutput struct { // The encryption type to use on the record. This parameter can be one of the // following values: - // - // * NONE: Do not encrypt the records in the stream. - // - // * KMS: Use - // server-side encryption on the records in the stream using a customer-managed - // Amazon Web Services KMS key. + // - NONE : Do not encrypt the records in the stream. + // - KMS : Use server-side encryption on the records in the stream using a + // customer-managed Amazon Web Services KMS key. EncryptionType types.EncryptionType // Metadata pertaining to the operation's result. diff --git a/service/kinesis/api_op_PutRecords.go b/service/kinesis/api_op_PutRecords.go index 2fdbd7ca89e..833e594ecea 100644 --- a/service/kinesis/api_op_PutRecords.go +++ b/service/kinesis/api_op_PutRecords.go @@ -20,7 +20,7 @@ import ( // entire request, including partition keys. Each shard can support writes up to // 1,000 records per second, up to a maximum data write total of 1 MiB per second. // You must specify the name of the stream that captures, stores, and transports -// the data; and an array of request Records, with each record in the array +// the data; and an array of request Records , with each record in the array // requiring a partition key and data blob. The record size limit applies to the // total size of the partition key and data blob. The data blob can be any type of // data; for example, a segment from a log file, geographic/location data, website @@ -29,16 +29,14 @@ import ( // specific shard. An MD5 hash function is used to map partition keys to 128-bit // integer values and to map associated data records to shards. As a result of this // hashing mechanism, all data records with the same partition key map to the same -// shard within the stream. For more information, see Adding Data to a Stream -// (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// shard within the stream. For more information, see Adding Data to a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. Each record in the Records -// array may include an optional parameter, ExplicitHashKey, which overrides the +// array may include an optional parameter, ExplicitHashKey , which overrides the // partition key to shard mapping. This parameter allows a data producer to // determine explicitly the shard where the record is stored. For more information, -// see Adding Multiple Records with PutRecords -// (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords) +// see Adding Multiple Records with PutRecords (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords) // in the Amazon Kinesis Data Streams Developer Guide. The PutRecords response -// includes an array of response Records. Each record in the response array +// includes an array of response Records . Each record in the response array // directly correlates with a record in the request array using natural ordering, // from the top to the bottom of the request and response. The response Records // array always includes the same number of records as the request array. The @@ -47,19 +45,18 @@ import ( // request. A single record failure does not stop the processing of subsequent // records. As a result, PutRecords doesn't guarantee the ordering of records. If // you need to read records in the same order they are written to the stream, use -// PutRecord instead of PutRecords, and write to the same shard. A successfully +// PutRecord instead of PutRecords , and write to the same shard. A successfully // processed record includes ShardId and SequenceNumber values. The ShardId // parameter identifies the shard in the stream where the record is stored. The // SequenceNumber parameter is an identifier assigned to the put record, unique to // all records in the stream. An unsuccessfully processed record includes ErrorCode // and ErrorMessage values. ErrorCode reflects the type of error and can be one of -// the following values: ProvisionedThroughputExceededException or InternalFailure. -// ErrorMessage provides more detailed information about the +// the following values: ProvisionedThroughputExceededException or InternalFailure +// . ErrorMessage provides more detailed information about the // ProvisionedThroughputExceededException exception including the account ID, // stream name, and shard ID of the record that was throttled. For more information // about partially successful responses, see Adding Multiple Records with -// PutRecords -// (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords) +// PutRecords (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords) // in the Amazon Kinesis Data Streams Developer Guide. After you write a record to // a stream, you cannot modify that record or its order within the stream. By // default, data records are accessible for 24 hours from the time that they are @@ -110,11 +107,9 @@ type PutRecordsOutput struct { // The encryption type used on the records. This parameter can be one of the // following values: - // - // * NONE: Do not encrypt the records. - // - // * KMS: Use server-side - // encryption on the records using a customer-managed Amazon Web Services KMS key. + // - NONE : Do not encrypt the records. + // - KMS : Use server-side encryption on the records using a customer-managed + // Amazon Web Services KMS key. EncryptionType types.EncryptionType // The number of unsuccessfully processed records in a PutRecords request. diff --git a/service/kinesis/api_op_RegisterStreamConsumer.go b/service/kinesis/api_op_RegisterStreamConsumer.go index 853dd5b394b..5c80b30a2da 100644 --- a/service/kinesis/api_op_RegisterStreamConsumer.go +++ b/service/kinesis/api_op_RegisterStreamConsumer.go @@ -18,11 +18,11 @@ import ( // that read from the same stream. You can register up to 20 consumers per stream. // A given consumer can only be registered with one stream at a time. For an // example of how to use this operations, see Enhanced Fan-Out Using the Kinesis -// Data Streams API. The use of this operation has a limit of five transactions per -// second per account. Also, only 5 consumers can be created simultaneously. In +// Data Streams API . The use of this operation has a limit of five transactions +// per second per account. Also, only 5 consumers can be created simultaneously. In // other words, you cannot have more than 5 consumers in a CREATING status at the // same time. Registering a 6th consumer while there are 5 in a CREATING status -// results in a LimitExceededException. +// results in a LimitExceededException . func (c *Client) RegisterStreamConsumer(ctx context.Context, params *RegisterStreamConsumerInput, optFns ...func(*Options)) (*RegisterStreamConsumerOutput, error) { if params == nil { params = &RegisterStreamConsumerInput{} @@ -40,16 +40,16 @@ func (c *Client) RegisterStreamConsumer(ctx context.Context, params *RegisterStr type RegisterStreamConsumerInput struct { - // For a given Kinesis data stream, each consumer must have a unique name. However, - // consumer names don't have to be unique across data streams. + // For a given Kinesis data stream, each consumer must have a unique name. + // However, consumer names don't have to be unique across data streams. // // This member is required. ConsumerName *string // The ARN of the Kinesis data stream that you want to register the consumer with. // For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams). + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams) + // . // // This member is required. StreamARN *string diff --git a/service/kinesis/api_op_RemoveTagsFromStream.go b/service/kinesis/api_op_RemoveTagsFromStream.go index bc370b5bdb6..f5dc2f436cd 100644 --- a/service/kinesis/api_op_RemoveTagsFromStream.go +++ b/service/kinesis/api_op_RemoveTagsFromStream.go @@ -31,7 +31,7 @@ func (c *Client) RemoveTagsFromStream(ctx context.Context, params *RemoveTagsFro return out, nil } -// Represents the input for RemoveTagsFromStream. +// Represents the input for RemoveTagsFromStream . type RemoveTagsFromStreamInput struct { // A list of tag keys. Each corresponding tag is removed from the stream. diff --git a/service/kinesis/api_op_SplitShard.go b/service/kinesis/api_op_SplitShard.go index 878af66049a..8daa2700175 100644 --- a/service/kinesis/api_op_SplitShard.go +++ b/service/kinesis/api_op_SplitShard.go @@ -16,38 +16,36 @@ import ( // increase in the volume of data records being ingested. This API is only // supported for the data streams with the provisioned capacity mode. When invoking // this API, it is recommended you use the StreamARN input parameter rather than -// the StreamName input parameter. You can also use SplitShard when a shard appears -// to be approaching its maximum utilization; for example, the producers sending -// data into the specific shard are suddenly sending more than previously +// the StreamName input parameter. You can also use SplitShard when a shard +// appears to be approaching its maximum utilization; for example, the producers +// sending data into the specific shard are suddenly sending more than previously // anticipated. You can also call SplitShard to increase stream capacity, so that // more Kinesis Data Streams applications can simultaneously read data from the // stream for real-time processing. You must specify the shard to be split and the // new hash key, which is the position in the shard where the shard gets split in // two. In many cases, the new hash key might be the average of the beginning and // ending hash key, but it can be any hash key value in the range being mapped into -// the shard. For more information, see Split a Shard -// (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html) +// the shard. For more information, see Split a Shard (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html) // in the Amazon Kinesis Data Streams Developer Guide. You can use -// DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash -// key values for the ShardToSplit and NewStartingHashKey parameters that are +// DescribeStreamSummary and the ListShards APIs to determine the shard ID and +// hash key values for the ShardToSplit and NewStartingHashKey parameters that are // specified in the SplitShard request. SplitShard is an asynchronous operation. // Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a -// response and sets the stream status to UPDATING. After the operation is -// completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write -// operations continue to work while the stream is in the UPDATING state. You can -// use DescribeStreamSummary to check the status of the stream, which is returned -// in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. -// If the specified stream does not exist, DescribeStreamSummary returns a -// ResourceNotFoundException. If you try to create more shards than are authorized -// for your account, you receive a LimitExceededException. For the default shard -// limit for an Amazon Web Services account, see Kinesis Data Streams Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// response and sets the stream status to UPDATING . After the operation is +// completed, Kinesis Data Streams sets the stream status to ACTIVE . Read and +// write operations continue to work while the stream is in the UPDATING state. +// You can use DescribeStreamSummary to check the status of the stream, which is +// returned in StreamStatus . If the stream is in the ACTIVE state, you can call +// SplitShard . If the specified stream does not exist, DescribeStreamSummary +// returns a ResourceNotFoundException . If you try to create more shards than are +// authorized for your account, you receive a LimitExceededException . For the +// default shard limit for an Amazon Web Services account, see Kinesis Data +// Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, -// contact Amazon Web Services Support -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). If you -// try to operate on too many streams simultaneously using CreateStream, -// DeleteStream, MergeShards, and/or SplitShard, you receive a -// LimitExceededException. SplitShard has a limit of five transactions per second +// contact Amazon Web Services Support (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// . If you try to operate on too many streams simultaneously using CreateStream , +// DeleteStream , MergeShards , and/or SplitShard , you receive a +// LimitExceededException . SplitShard has a limit of five transactions per second // per account. func (c *Client) SplitShard(ctx context.Context, params *SplitShardInput, optFns ...func(*Options)) (*SplitShardOutput, error) { if params == nil { @@ -64,11 +62,11 @@ func (c *Client) SplitShard(ctx context.Context, params *SplitShardInput, optFns return out, nil } -// Represents the input for SplitShard. +// Represents the input for SplitShard . type SplitShardInput struct { - // A hash key value for the starting hash key of one of the child shards created by - // the split. The hash key range for a given shard constitutes a set of ordered + // A hash key value for the starting hash key of one of the child shards created + // by the split. The hash key range for a given shard constitutes a set of ordered // contiguous positive integers. The value for NewStartingHashKey must be in the // range of hash keys being mapped into the shard. The NewStartingHashKey hash key // value and all higher hash key values in hash key range are distributed to one of diff --git a/service/kinesis/api_op_StartStreamEncryption.go b/service/kinesis/api_op_StartStreamEncryption.go index 6d876e231bf..409d70b27cb 100644 --- a/service/kinesis/api_op_StartStreamEncryption.go +++ b/service/kinesis/api_op_StartStreamEncryption.go @@ -14,19 +14,19 @@ import ( // Enables or updates server-side encryption using an Amazon Web Services KMS key // for a specified stream. Starting encryption is an asynchronous operation. Upon // receiving the request, Kinesis Data Streams returns immediately and sets the -// status of the stream to UPDATING. After the update is complete, Kinesis Data -// Streams sets the status of the stream back to ACTIVE. Updating or applying +// status of the stream to UPDATING . After the update is complete, Kinesis Data +// Streams sets the status of the stream back to ACTIVE . Updating or applying // encryption normally takes a few seconds to complete, but it can take minutes. // You can continue to read and write data to your stream while its status is -// UPDATING. Once the status of the stream is ACTIVE, encryption begins for records -// written to the stream. API Limits: You can successfully apply a new Amazon Web -// Services KMS key for server-side encryption 25 times in a rolling 24-hour -// period. Note: It can take up to 5 seconds after the stream is in an ACTIVE -// status before all records written to the stream are encrypted. After you enable -// encryption, you can verify that encryption is applied by inspecting the API -// response from PutRecord or PutRecords. When invoking this API, it is recommended -// you use the StreamARN input parameter rather than the StreamName input -// parameter. +// UPDATING . Once the status of the stream is ACTIVE , encryption begins for +// records written to the stream. API Limits: You can successfully apply a new +// Amazon Web Services KMS key for server-side encryption 25 times in a rolling +// 24-hour period. Note: It can take up to 5 seconds after the stream is in an +// ACTIVE status before all records written to the stream are encrypted. After you +// enable encryption, you can verify that encryption is applied by inspecting the +// API response from PutRecord or PutRecords . When invoking this API, it is +// recommended you use the StreamARN input parameter rather than the StreamName +// input parameter. func (c *Client) StartStreamEncryption(ctx context.Context, params *StartStreamEncryptionInput, optFns ...func(*Options)) (*StartStreamEncryptionOutput, error) { if params == nil { params = &StartStreamEncryptionInput{} @@ -44,7 +44,7 @@ func (c *Client) StartStreamEncryption(ctx context.Context, params *StartStreamE type StartStreamEncryptionInput struct { - // The encryption type to use. The only valid value is KMS. + // The encryption type to use. The only valid value is KMS . // // This member is required. EncryptionType types.EncryptionType @@ -53,22 +53,13 @@ type StartStreamEncryptionInput struct { // encryption. This value can be a globally unique identifier, a fully specified // Amazon Resource Name (ARN) to either an alias or a key, or an alias name // prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams - // by specifying the alias aws/kinesis. - // - // * Key ARN example: - // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName - // - // * - // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 - // - // * Alias - // name example: alias/MyAliasName - // - // * Master key owned by Kinesis Data Streams: - // alias/aws/kinesis + // by specifying the alias aws/kinesis . + // - Key ARN example: + // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 + // - Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // - Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // - Alias name example: alias/MyAliasName + // - Master key owned by Kinesis Data Streams: alias/aws/kinesis // // This member is required. KeyId *string diff --git a/service/kinesis/api_op_StopStreamEncryption.go b/service/kinesis/api_op_StopStreamEncryption.go index faf07676773..b9b977b8f8f 100644 --- a/service/kinesis/api_op_StopStreamEncryption.go +++ b/service/kinesis/api_op_StopStreamEncryption.go @@ -15,17 +15,17 @@ import ( // it is recommended you use the StreamARN input parameter rather than the // StreamName input parameter. Stopping encryption is an asynchronous operation. // Upon receiving the request, Kinesis Data Streams returns immediately and sets -// the status of the stream to UPDATING. After the update is complete, Kinesis Data -// Streams sets the status of the stream back to ACTIVE. Stopping encryption +// the status of the stream to UPDATING . After the update is complete, Kinesis +// Data Streams sets the status of the stream back to ACTIVE . Stopping encryption // normally takes a few seconds to complete, but it can take minutes. You can -// continue to read and write data to your stream while its status is UPDATING. -// Once the status of the stream is ACTIVE, records written to the stream are no +// continue to read and write data to your stream while its status is UPDATING . +// Once the status of the stream is ACTIVE , records written to the stream are no // longer encrypted by Kinesis Data Streams. API Limits: You can successfully // disable server-side encryption 25 times in a rolling 24-hour period. Note: It // can take up to 5 seconds after the stream is in an ACTIVE status before all // records written to the stream are no longer subject to encryption. After you // disabled encryption, you can verify that encryption is not applied by inspecting -// the API response from PutRecord or PutRecords. +// the API response from PutRecord or PutRecords . func (c *Client) StopStreamEncryption(ctx context.Context, params *StopStreamEncryptionInput, optFns ...func(*Options)) (*StopStreamEncryptionOutput, error) { if params == nil { params = &StopStreamEncryptionInput{} @@ -43,7 +43,7 @@ func (c *Client) StopStreamEncryption(ctx context.Context, params *StopStreamEnc type StopStreamEncryptionInput struct { - // The encryption type. The only valid value is KMS. + // The encryption type. The only valid value is KMS . // // This member is required. EncryptionType types.EncryptionType @@ -52,22 +52,13 @@ type StopStreamEncryptionInput struct { // encryption. This value can be a globally unique identifier, a fully specified // Amazon Resource Name (ARN) to either an alias or a key, or an alias name // prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams - // by specifying the alias aws/kinesis. - // - // * Key ARN example: - // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName - // - // * - // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 - // - // * Alias - // name example: alias/MyAliasName - // - // * Master key owned by Kinesis Data Streams: - // alias/aws/kinesis + // by specifying the alias aws/kinesis . + // - Key ARN example: + // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 + // - Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // - Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // - Alias name example: alias/MyAliasName + // - Master key owned by Kinesis Data Streams: alias/aws/kinesis // // This member is required. KeyId *string diff --git a/service/kinesis/api_op_SubscribeToShard.go b/service/kinesis/api_op_SubscribeToShard.go index ba0b5ecfe3f..24e971f83c8 100644 --- a/service/kinesis/api_op_SubscribeToShard.go +++ b/service/kinesis/api_op_SubscribeToShard.go @@ -13,25 +13,26 @@ import ( "sync" ) -// This operation establishes an HTTP/2 connection between the consumer you specify -// in the ConsumerARN parameter and the shard you specify in the ShardId parameter. -// After the connection is successfully established, Kinesis Data Streams pushes -// records from the shard to the consumer over this connection. Before you call -// this operation, call RegisterStreamConsumer to register the consumer with -// Kinesis Data Streams. When the SubscribeToShard call succeeds, your consumer -// starts receiving events of type SubscribeToShardEvent over the HTTP/2 connection -// for up to 5 minutes, after which time you need to call SubscribeToShard again to -// renew the subscription if you want to continue to receive records. You can make -// one call to SubscribeToShard per second per registered consumer per shard. For -// example, if you have a 4000 shard stream and two registered stream consumers, -// you can make one SubscribeToShard request per second for each combination of -// shard and registered consumer, allowing you to subscribe both consumers to all -// 4000 shards in one second. If you call SubscribeToShard again with the same -// ConsumerARN and ShardId within 5 seconds of a successful call, you'll get a -// ResourceInUseException. If you call SubscribeToShard 5 seconds or more after a -// successful call, the second call takes over the subscription and the previous -// connection expires or fails with a ResourceInUseException. For an example of how -// to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API. +// This operation establishes an HTTP/2 connection between the consumer you +// specify in the ConsumerARN parameter and the shard you specify in the ShardId +// parameter. After the connection is successfully established, Kinesis Data +// Streams pushes records from the shard to the consumer over this connection. +// Before you call this operation, call RegisterStreamConsumer to register the +// consumer with Kinesis Data Streams. When the SubscribeToShard call succeeds, +// your consumer starts receiving events of type SubscribeToShardEvent over the +// HTTP/2 connection for up to 5 minutes, after which time you need to call +// SubscribeToShard again to renew the subscription if you want to continue to +// receive records. You can make one call to SubscribeToShard per second per +// registered consumer per shard. For example, if you have a 4000 shard stream and +// two registered stream consumers, you can make one SubscribeToShard request per +// second for each combination of shard and registered consumer, allowing you to +// subscribe both consumers to all 4000 shards in one second. If you call +// SubscribeToShard again with the same ConsumerARN and ShardId within 5 seconds +// of a successful call, you'll get a ResourceInUseException . If you call +// SubscribeToShard 5 seconds or more after a successful call, the second call +// takes over the subscription and the previous connection expires or fails with a +// ResourceInUseException . For an example of how to use this operations, see +// Enhanced Fan-Out Using the Kinesis Data Streams API . func (c *Client) SubscribeToShard(ctx context.Context, params *SubscribeToShardInput, optFns ...func(*Options)) (*SubscribeToShardOutput, error) { if params == nil { params = &SubscribeToShardInput{} @@ -50,13 +51,13 @@ func (c *Client) SubscribeToShard(ctx context.Context, params *SubscribeToShardI type SubscribeToShardInput struct { // For this parameter, use the value you obtained when you called - // RegisterStreamConsumer. + // RegisterStreamConsumer . // // This member is required. ConsumerARN *string // The ID of the shard you want to subscribe to. To see a list of all the shards - // for a given stream, use ListShards. + // for a given stream, use ListShards . // // This member is required. ShardId *string diff --git a/service/kinesis/api_op_UpdateShardCount.go b/service/kinesis/api_op_UpdateShardCount.go index 160f4fc038b..a6a4279a927 100644 --- a/service/kinesis/api_op_UpdateShardCount.go +++ b/service/kinesis/api_op_UpdateShardCount.go @@ -16,45 +16,33 @@ import ( // capacity mode. When invoking this API, it is recommended you use the StreamARN // input parameter rather than the StreamName input parameter. Updating the shard // count is an asynchronous operation. Upon receiving the request, Kinesis Data -// Streams returns immediately and sets the status of the stream to UPDATING. After -// the update is complete, Kinesis Data Streams sets the status of the stream back -// to ACTIVE. Depending on the size of the stream, the scaling action could take a -// few minutes to complete. You can continue to read and write data to your stream -// while its status is UPDATING. To update the shard count, Kinesis Data Streams -// performs splits or merges on individual shards. This can cause short-lived -// shards to be created, in addition to the final shards. These short-lived shards -// count towards your total shard limit for your account in the Region. When using -// this operation, we recommend that you specify a target shard count that is a -// multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within -// your shard limit. However, if you specify a target that isn't a multiple of 25%, -// the scaling action might take longer to complete. This operation has the -// following default limits. By default, you cannot do the following: +// Streams returns immediately and sets the status of the stream to UPDATING . +// After the update is complete, Kinesis Data Streams sets the status of the stream +// back to ACTIVE . Depending on the size of the stream, the scaling action could +// take a few minutes to complete. You can continue to read and write data to your +// stream while its status is UPDATING . To update the shard count, Kinesis Data +// Streams performs splits or merges on individual shards. This can cause +// short-lived shards to be created, in addition to the final shards. These +// short-lived shards count towards your total shard limit for your account in the +// Region. When using this operation, we recommend that you specify a target shard +// count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any +// target value within your shard limit. However, if you specify a target that +// isn't a multiple of 25%, the scaling action might take longer to complete. This +// operation has the following default limits. By default, you cannot do the +// following: +// - Scale more than ten times per rolling 24-hour period per stream +// - Scale up to more than double your current shard count for a stream +// - Scale down below half your current shard count for a stream +// - Scale up to more than 10000 shards in a stream +// - Scale a stream with more than 10000 shards down unless the result is less +// than 10000 shards +// - Scale up to more than the shard limit for your account // -// * Scale more -// than ten times per rolling 24-hour period per stream -// -// * Scale up to more than -// double your current shard count for a stream -// -// * Scale down below half your -// current shard count for a stream -// -// * Scale up to more than 10000 shards in a -// stream -// -// * Scale a stream with more than 10000 shards down unless the result is -// less than 10000 shards -// -// * Scale up to more than the shard limit for your -// account -// -// For the default limits for an Amazon Web Services account, see Streams -// Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// For the default limits for an Amazon Web Services account, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To request an increase in // the call rate limit, the shard limit for this API, or your overall shard limit, -// use the limits form -// (https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis). +// use the limits form (https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis) +// . func (c *Client) UpdateShardCount(ctx context.Context, params *UpdateShardCountInput, optFns ...func(*Options)) (*UpdateShardCountOutput, error) { if params == nil { params = &UpdateShardCountInput{} @@ -79,19 +67,13 @@ type UpdateShardCountInput struct { // The new number of shards. This value has the following default limits. By // default, you cannot do the following: - // - // * Set this value to more than double your - // current shard count for a stream. - // - // * Set this value below half your current - // shard count for a stream. - // - // * Set this value to more than 10000 shards in a - // stream (the default limit for shard count per stream is 10000 per account per - // region), unless you request a limit increase. - // - // * Scale a stream with more than - // 10000 shards down unless you set this value to less than 10000 shards. + // - Set this value to more than double your current shard count for a stream. + // - Set this value below half your current shard count for a stream. + // - Set this value to more than 10000 shards in a stream (the default limit for + // shard count per stream is 10000 per account per region), unless you request a + // limit increase. + // - Scale a stream with more than 10000 shards down unless you set this value + // to less than 10000 shards. // // This member is required. TargetShardCount *int32 diff --git a/service/kinesis/doc.go b/service/kinesis/doc.go index 79ced8a37f6..079c71dc260 100644 --- a/service/kinesis/doc.go +++ b/service/kinesis/doc.go @@ -3,7 +3,7 @@ // Package kinesis provides the API client, operations, and parameter types for // Amazon Kinesis. // -// Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams is -// a managed service that scales elastically for real-time processing of streaming -// big data. +// Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams +// is a managed service that scales elastically for real-time processing of +// streaming big data. package kinesis diff --git a/service/kinesis/eventstream.go b/service/kinesis/eventstream.go index 39598ca82a1..662d458db6a 100644 --- a/service/kinesis/eventstream.go +++ b/service/kinesis/eventstream.go @@ -18,8 +18,8 @@ import ( "sync" ) -// SubscribeToShardEventStreamReader provides the interface for reading events from -// a stream. +// SubscribeToShardEventStreamReader provides the interface for reading events +// from a stream. // // The writer's Close method must allow multiple concurrent calls. type SubscribeToShardEventStreamReader interface { diff --git a/service/kinesis/types/enums.go b/service/kinesis/types/enums.go index 9e36f137533..23fd058fe70 100644 --- a/service/kinesis/types/enums.go +++ b/service/kinesis/types/enums.go @@ -164,9 +164,9 @@ const ( StreamStatusUpdating StreamStatus = "UPDATING" ) -// Values returns all known values for StreamStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StreamStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StreamStatus) Values() []StreamStatus { return []StreamStatus{ "CREATING", diff --git a/service/kinesis/types/errors.go b/service/kinesis/types/errors.go index 448f1708a1a..fcd07804d42 100644 --- a/service/kinesis/types/errors.go +++ b/service/kinesis/types/errors.go @@ -140,8 +140,8 @@ func (e *InvalidArgumentException) ErrorCode() string { } func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The ciphertext references a key that doesn't exist or that you don't have access -// to. +// The ciphertext references a key that doesn't exist or that you don't have +// access to. type KMSAccessDeniedException struct { Message *string @@ -194,11 +194,10 @@ func (e *KMSDisabledException) ErrorCode() string { } func (e *KMSDisabledException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the state of the specified resource isn't valid -// for this request. For more information, see How Key State Affects Use of a -// Customer Master Key -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Amazon Web Services Key Management Service Developer Guide. +// The request was rejected because the state of the specified resource isn't +// valid for this request. For more information, see How Key State Affects Use of +// a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Amazon Web Services Key Management Service Developer Guide. type KMSInvalidStateException struct { Message *string @@ -278,8 +277,7 @@ func (e *KMSOptInRequired) ErrorCode() string { func (e *KMSOptInRequired) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was denied due to request throttling. For more information about -// throttling, see Limits -// (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the Amazon Web Services Key Management Service Developer Guide. type KMSThrottlingException struct { Message *string @@ -335,12 +333,10 @@ func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy. // The request rate for the stream is too high, or the requested data is too large // for the available throughput. Reduce the frequency or size of your requests. For -// more information, see Streams Limits -// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in Amazon Web Services -// (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon -// Web Services General Reference. +// Exponential Backoff in Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// in the Amazon Web Services General Reference. type ProvisionedThroughputExceededException struct { Message *string @@ -422,9 +418,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Specifies that you tried to invoke this API for a data stream with the on-demand -// capacity mode. This API is only supported for data streams with the provisioned -// capacity mode. +// Specifies that you tried to invoke this API for a data stream with the +// on-demand capacity mode. This API is only supported for data streams with the +// provisioned capacity mode. type ValidationException struct { Message *string diff --git a/service/kinesis/types/types.go b/service/kinesis/types/types.go index d6de9fefcfc..c28c716ae71 100644 --- a/service/kinesis/types/types.go +++ b/service/kinesis/types/types.go @@ -31,11 +31,11 @@ type ChildShard struct { } // An object that represents the details of the consumer you registered. This type -// of object is returned by RegisterStreamConsumer. +// of object is returned by RegisterStreamConsumer . type Consumer struct { // When you register a consumer, Kinesis Data Streams generates an ARN for it. You - // need this ARN to be able to call SubscribeToShard. If you delete a consumer and + // need this ARN to be able to call SubscribeToShard . If you delete a consumer and // then create a new one with the same name, it won't have the same ARN. That's // because consumer ARNs contain the creation timestamp. This is important to keep // in mind if you have IAM policies that reference consumer ARNs. @@ -62,11 +62,11 @@ type Consumer struct { } // An object that represents the details of a registered consumer. This type of -// object is returned by DescribeStreamConsumer. +// object is returned by DescribeStreamConsumer . type ConsumerDescription struct { // When you register a consumer, Kinesis Data Streams generates an ARN for it. You - // need this ARN to be able to call SubscribeToShard. If you delete a consumer and + // need this ARN to be able to call SubscribeToShard . If you delete a consumer and // then create a new one with the same name, it won't have the same ARN. That's // because consumer ARNs contain the creation timestamp. This is important to keep // in mind if you have IAM policies that reference consumer ARNs. @@ -101,30 +101,17 @@ type ConsumerDescription struct { type EnhancedMetrics struct { // List of shard-level metrics. The following are the valid shard-level metrics. - // The value "ALL" enhances every metric. - // - // * IncomingBytes - // - // * IncomingRecords - // - // * - // OutgoingBytes - // - // * OutgoingRecords - // - // * WriteProvisionedThroughputExceeded - // - // * - // ReadProvisionedThroughputExceeded - // - // * IteratorAgeMilliseconds - // - // * ALL - // - // For more - // information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon - // CloudWatch - // (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // The value " ALL " enhances every metric. + // - IncomingBytes + // - IncomingRecords + // - OutgoingBytes + // - OutgoingRecords + // - WriteProvisionedThroughputExceeded + // - ReadProvisionedThroughputExceeded + // - IteratorAgeMilliseconds + // - ALL + // For more information, see Monitoring the Amazon Kinesis Data Streams Service + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. ShardLevelMetrics []MetricsName @@ -148,7 +135,7 @@ type HashKeyRange struct { noSmithyDocumentSerde } -// Represents the output for PutRecords. +// Represents the output for PutRecords . type PutRecordsRequestEntry struct { // The data blob to put into the record, which is base64-encoded when the blob is @@ -185,13 +172,13 @@ type PutRecordsRequestEntry struct { type PutRecordsResultEntry struct { // The error code for an individual record result. ErrorCodes can be either - // ProvisionedThroughputExceededException or InternalFailure. + // ProvisionedThroughputExceededException or InternalFailure . ErrorCode *string // The error message for an individual record result. An ErrorCode value of // ProvisionedThroughputExceededException has an error message that includes the - // account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has - // the error message "Internal Service Failure". + // account ID, stream name, and shard ID. An ErrorCode value of InternalFailure + // has the error message "Internal Service Failure" . ErrorMessage *string // The sequence number for an individual record result. @@ -207,11 +194,11 @@ type PutRecordsResultEntry struct { // number, a partition key, and a data blob. type Record struct { - // The data blob. The data in the blob is both opaque and immutable to Kinesis Data - // Streams, which does not inspect, interpret, or change the data in the blob in - // any way. When the data blob (the payload before base64-encoding) is added to the - // partition key size, the total size must not exceed the maximum record size (1 - // MiB). + // The data blob. The data in the blob is both opaque and immutable to Kinesis + // Data Streams, which does not inspect, interpret, or change the data in the blob + // in any way. When the data blob (the payload before base64-encoding) is added to + // the partition key size, the total size must not exceed the maximum record size + // (1 MiB). // // This member is required. Data []byte @@ -231,12 +218,9 @@ type Record struct { // The encryption type used on the record. This parameter can be one of the // following values: - // - // * NONE: Do not encrypt the records in the stream. - // - // * KMS: Use - // server-side encryption on the records in the stream using a customer-managed - // Amazon Web Services KMS key. + // - NONE : Do not encrypt the records in the stream. + // - KMS : Use server-side encryption on the records in the stream using a + // customer-managed Amazon Web Services KMS key. EncryptionType EncryptionType noSmithyDocumentSerde @@ -250,8 +234,8 @@ type SequenceNumberRange struct { // This member is required. StartingSequenceNumber *string - // The ending sequence number for the range. Shards that are in the OPEN state have - // an ending sequence number of null. + // The ending sequence number for the range. Shards that are in the OPEN state + // have an ending sequence number of null . EndingSequenceNumber *string noSmithyDocumentSerde @@ -291,35 +275,27 @@ type ShardFilter struct { // The shard type specified in the ShardFilter parameter. This is a required // property of the ShardFilter parameter. You can specify the following valid // values: - // - // * AFTER_SHARD_ID - the response includes all the shards, starting with - // the shard whose ID immediately follows the ShardId that you provided. - // - // * - // AT_TRIM_HORIZON - the response includes all the shards that were open at - // TRIM_HORIZON. - // - // * FROM_TRIM_HORIZON - (default), the response includes all the - // shards within the retention period of the data stream (trim to tip). - // - // * - // AT_LATEST - the response includes only the currently open shards of the data - // stream. - // - // * AT_TIMESTAMP - the response includes all shards whose start timestamp - // is less than or equal to the given timestamp and end timestamp is greater than - // or equal to the given timestamp or still open. - // - // * FROM_TIMESTAMP - the response - // incldues all closed shards whose end timestamp is greater than or equal to the - // given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data - // stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value. + // - AFTER_SHARD_ID - the response includes all the shards, starting with the + // shard whose ID immediately follows the ShardId that you provided. + // - AT_TRIM_HORIZON - the response includes all the shards that were open at + // TRIM_HORIZON . + // - FROM_TRIM_HORIZON - (default), the response includes all the shards within + // the retention period of the data stream (trim to tip). + // - AT_LATEST - the response includes only the currently open shards of the data + // stream. + // - AT_TIMESTAMP - the response includes all shards whose start timestamp is + // less than or equal to the given timestamp and end timestamp is greater than or + // equal to the given timestamp or still open. + // - FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp + // is greater than or equal to the given timestamp and also all open shards. + // Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than + // the TRIM_HORIZON value. // // This member is required. Type ShardFilterType - // The exclusive start shardID speified in the ShardFilter parameter. This property - // can only be used if the AFTER_SHARD_ID shard type is specified. + // The exclusive start shardID speified in the ShardFilter parameter. This + // property can only be used if the AFTER_SHARD_ID shard type is specified. ShardId *string // The timestamps specified in the ShardFilter parameter. A timestamp is a Unix @@ -335,13 +311,13 @@ type ShardFilter struct { type StartingPosition struct { // You can set the starting position to one of the following values: - // AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence - // number specified in the SequenceNumber field. AFTER_SEQUENCE_NUMBER: Start + // AT_SEQUENCE_NUMBER : Start streaming from the position denoted by the sequence + // number specified in the SequenceNumber field. AFTER_SEQUENCE_NUMBER : Start // streaming right after the position denoted by the sequence number specified in - // the SequenceNumber field. AT_TIMESTAMP: Start streaming from the position - // denoted by the time stamp specified in the Timestamp field. TRIM_HORIZON: Start + // the SequenceNumber field. AT_TIMESTAMP : Start streaming from the position + // denoted by the time stamp specified in the Timestamp field. TRIM_HORIZON : Start // streaming at the last untrimmed record in the shard, which is the oldest data - // record in the shard. LATEST: Start streaming just after the most recent record + // record in the shard. LATEST : Start streaming just after the most recent record // in the shard, so that you always read the most recent data in the shard. // // This member is required. @@ -349,22 +325,22 @@ type StartingPosition struct { // The sequence number of the data record in the shard from which to start // streaming. To specify a sequence number, set StartingPosition to - // AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. + // AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER . SequenceNumber *string - // The time stamp of the data record from which to start reading. To specify a time - // stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch - // date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 - // or 1459799926.480. If a record with this exact time stamp does not exist, - // records will be streamed from the next (later) record. If the time stamp is - // older than the current trim horizon, records will be streamed from the oldest - // untrimmed data record (TRIM_HORIZON). + // The time stamp of the data record from which to start reading. To specify a + // time stamp, set StartingPosition to Type AT_TIMESTAMP . A time stamp is the Unix + // epoch date with precision in milliseconds. For example, + // 2016-04-04T19:58:46.480-00:00 or 1459799926.480 . If a record with this exact + // time stamp does not exist, records will be streamed from the next (later) + // record. If the time stamp is older than the current trim horizon, records will + // be streamed from the oldest untrimmed data record ( TRIM_HORIZON ). Timestamp *time.Time noSmithyDocumentSerde } -// Represents the output for DescribeStream. +// Represents the output for DescribeStream . type StreamDescription struct { // Represents the current enhanced monitoring settings of the stream. @@ -372,7 +348,7 @@ type StreamDescription struct { // This member is required. EnhancedMonitoring []EnhancedMetrics - // If set to true, more shards in the stream are available to describe. + // If set to true , more shards in the stream are available to describe. // // This member is required. HasMoreShards *bool @@ -405,55 +381,37 @@ type StreamDescription struct { // The current status of the stream being described. The stream status is one of // the following states: - // - // * CREATING - The stream is being created. Kinesis Data - // Streams immediately returns and sets StreamStatus to CREATING. - // - // * DELETING - The - // stream is being deleted. The specified stream is in the DELETING state until - // Kinesis Data Streams completes the deletion. - // - // * ACTIVE - The stream exists and - // is ready for read and write operations or deletion. You should perform read and - // write operations only on an ACTIVE stream. - // - // * UPDATING - Shards in the stream - // are being merged or split. Read and write operations continue to work while the - // stream is in the UPDATING state. + // - CREATING - The stream is being created. Kinesis Data Streams immediately + // returns and sets StreamStatus to CREATING . + // - DELETING - The stream is being deleted. The specified stream is in the + // DELETING state until Kinesis Data Streams completes the deletion. + // - ACTIVE - The stream exists and is ready for read and write operations or + // deletion. You should perform read and write operations only on an ACTIVE + // stream. + // - UPDATING - Shards in the stream are being merged or split. Read and write + // operations continue to work while the stream is in the UPDATING state. // // This member is required. StreamStatus StreamStatus - // The server-side encryption type used on the stream. This parameter can be one of - // the following values: - // - // * NONE: Do not encrypt the records in the stream. - // - // * KMS: - // Use server-side encryption on the records in the stream using a customer-managed - // Amazon Web Services KMS key. + // The server-side encryption type used on the stream. This parameter can be one + // of the following values: + // - NONE : Do not encrypt the records in the stream. + // - KMS : Use server-side encryption on the records in the stream using a + // customer-managed Amazon Web Services KMS key. EncryptionType EncryptionType // The GUID for the customer-managed Amazon Web Services KMS key to use for // encryption. This value can be a globally unique identifier, a fully specified // ARN to either an alias or a key, or an alias name prefixed by "alias/".You can // also use a master key owned by Kinesis Data Streams by specifying the alias - // aws/kinesis. - // - // * Key ARN example: - // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName - // - // * - // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 - // - // * Alias - // name example: alias/MyAliasName - // - // * Master key owned by Kinesis Data Streams: - // alias/aws/kinesis + // aws/kinesis . + // - Key ARN example: + // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 + // - Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // - Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // - Alias name example: alias/MyAliasName + // - Master key owned by Kinesis Data Streams: alias/aws/kinesis KeyId *string // Specifies the capacity mode to which you want to set your data stream. @@ -499,21 +457,15 @@ type StreamDescriptionSummary struct { // The current status of the stream being described. The stream status is one of // the following states: - // - // * CREATING - The stream is being created. Kinesis Data - // Streams immediately returns and sets StreamStatus to CREATING. - // - // * DELETING - The - // stream is being deleted. The specified stream is in the DELETING state until - // Kinesis Data Streams completes the deletion. - // - // * ACTIVE - The stream exists and - // is ready for read and write operations or deletion. You should perform read and - // write operations only on an ACTIVE stream. - // - // * UPDATING - Shards in the stream - // are being merged or split. Read and write operations continue to work while the - // stream is in the UPDATING state. + // - CREATING - The stream is being created. Kinesis Data Streams immediately + // returns and sets StreamStatus to CREATING . + // - DELETING - The stream is being deleted. The specified stream is in the + // DELETING state until Kinesis Data Streams completes the deletion. + // - ACTIVE - The stream exists and is ready for read and write operations or + // deletion. You should perform read and write operations only on an ACTIVE + // stream. + // - UPDATING - Shards in the stream are being merged or split. Read and write + // operations continue to work while the stream is in the UPDATING state. // // This member is required. StreamStatus StreamStatus @@ -522,32 +474,21 @@ type StreamDescriptionSummary struct { ConsumerCount *int32 // The encryption type used. This value is one of the following: - // - // * KMS - // - // * NONE + // - KMS + // - NONE EncryptionType EncryptionType // The GUID for the customer-managed Amazon Web Services KMS key to use for // encryption. This value can be a globally unique identifier, a fully specified // ARN to either an alias or a key, or an alias name prefixed by "alias/".You can // also use a master key owned by Kinesis Data Streams by specifying the alias - // aws/kinesis. - // - // * Key ARN example: - // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 - // - // * - // Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName - // - // * - // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 - // - // * Alias - // name example: alias/MyAliasName - // - // * Master key owned by Kinesis Data Streams: - // alias/aws/kinesis + // aws/kinesis . + // - Key ARN example: + // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 + // - Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName + // - Globally unique key ID example: 12345678-1234-1234-1234-123456789012 + // - Alias name example: alias/MyAliasName + // - Master key owned by Kinesis Data Streams: alias/aws/kinesis KeyId *string // Specifies the capacity mode to which you want to set your data stream. @@ -602,12 +543,12 @@ type StreamSummary struct { noSmithyDocumentSerde } -// After you call SubscribeToShard, Kinesis Data Streams sends events of this type +// After you call SubscribeToShard , Kinesis Data Streams sends events of this type // over an HTTP/2 connection to your consumer. type SubscribeToShardEvent struct { - // Use this as SequenceNumber in the next call to SubscribeToShard, with - // StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use + // Use this as SequenceNumber in the next call to SubscribeToShard , with + // StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER . Use // ContinuationSequenceNumber for checkpointing because it captures your shard // progress even when no data is written to the shard. // @@ -635,7 +576,7 @@ type SubscribeToShardEvent struct { } // This is a tagged union for all of the types of events an enhanced fan-out -// consumer can receive over HTTP/2 after a call to SubscribeToShard. +// consumer can receive over HTTP/2 after a call to SubscribeToShard . // // The following types satisfy this interface: // @@ -644,9 +585,9 @@ type SubscribeToShardEventStream interface { isSubscribeToShardEventStream() } -// After you call SubscribeToShard, Kinesis Data Streams sends events of this type +// After you call SubscribeToShard , Kinesis Data Streams sends events of this type // to your consumer. For an example of how to handle these events, see Enhanced -// Fan-Out Using the Kinesis Data Streams API. +// Fan-Out Using the Kinesis Data Streams API . type SubscribeToShardEventStreamMemberSubscribeToShardEvent struct { Value SubscribeToShardEvent diff --git a/service/kinesisanalytics/api_client.go b/service/kinesisanalytics/api_client.go index 8652af14380..06814530231 100644 --- a/service/kinesisanalytics/api_client.go +++ b/service/kinesisanalytics/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go index 1e5996091ac..9e88d7535ac 100644 --- a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go @@ -14,11 +14,11 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Adds a CloudWatch log stream to monitor +// Analytics API V2 Documentation . Adds a CloudWatch log stream to monitor // application configuration errors. For more information about using CloudWatch // log streams with Amazon Kinesis Analytics applications, see Working with Amazon -// CloudWatch Logs -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). +// CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html) +// . func (c *Client) AddApplicationCloudWatchLoggingOption(ctx context.Context, params *AddApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*AddApplicationCloudWatchLoggingOptionOutput, error) { if params == nil { params = &AddApplicationCloudWatchLoggingOptionInput{} diff --git a/service/kinesisanalytics/api_op_AddApplicationInput.go b/service/kinesisanalytics/api_op_AddApplicationInput.go index 215345e3ad3..e28b28adeec 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInput.go +++ b/service/kinesisanalytics/api_op_AddApplicationInput.go @@ -14,17 +14,14 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis -// application. For conceptual information, see Configuring Application Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). -// You can add a streaming source either when you create an application or you can -// use this operation to add a streaming source after you create an application. -// For more information, see CreateApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html). -// Any configuration update, including adding a streaming source using this +// Analytics API V2 Documentation . Adds a streaming source to your Amazon Kinesis +// application. For conceptual information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . You can add a streaming source either when you create an application or you +// can use this operation to add a streaming source after you create an +// application. For more information, see CreateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html) +// . Any configuration update, including adding a streaming source using this // operation, results in a new version of the application. You can use the -// DescribeApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) +// DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to find the current application version. This operation requires // permissions to perform the kinesisanalytics:AddApplicationInput action. func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplicationInputInput, optFns ...func(*Options)) (*AddApplicationInputOutput, error) { @@ -51,15 +48,14 @@ type AddApplicationInputInput struct { ApplicationName *string // Current version of your Amazon Kinesis Analytics application. You can use the - // DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to find the current application version. // // This member is required. CurrentApplicationVersionId *int64 - // The Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) to add. + // The Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) + // to add. // // This member is required. Input *types.Input diff --git a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go index 5259de52462..35034b98dba 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go @@ -14,11 +14,10 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Adds an InputProcessingConfiguration -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) +// Analytics API V2 Documentation . Adds an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to an application. An input processor preprocesses records on the input stream // before the application's SQL code executes. Currently, the only input processor -// available is AWS Lambda (https://docs.aws.amazon.com/lambda/). +// available is AWS Lambda (https://docs.aws.amazon.com/lambda/) . func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, params *AddApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*AddApplicationInputProcessingConfigurationOutput, error) { if params == nil { params = &AddApplicationInputProcessingConfigurationInput{} @@ -43,8 +42,7 @@ type AddApplicationInputProcessingConfigurationInput struct { ApplicationName *string // Version of the application to which you want to add the input processing - // configuration. You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // configuration. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified is // not the current version, the ConcurrentModificationException is returned. // @@ -53,15 +51,13 @@ type AddApplicationInputProcessingConfigurationInput struct { // The ID of the input configuration to add the input processing configuration to. // You can get a list of the input IDs for an application using the - // DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // This member is required. InputId *string - // The InputProcessingConfiguration - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) + // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to add to the application. // // This member is required. diff --git a/service/kinesisanalytics/api_op_AddApplicationOutput.go b/service/kinesisanalytics/api_op_AddApplicationOutput.go index 6077d74a1f9..86cd57e3521 100644 --- a/service/kinesisanalytics/api_op_AddApplicationOutput.go +++ b/service/kinesisanalytics/api_op_AddApplicationOutput.go @@ -14,7 +14,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Adds an external destination to your Amazon +// Analytics API V2 Documentation . Adds an external destination to your Amazon // Kinesis Analytics application. If you want Amazon Kinesis Analytics to deliver // data from an in-application stream within your application to an external // destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose @@ -24,16 +24,13 @@ import ( // and an external destination. You can use one of the output configurations to // deliver data from your in-application error stream to an external destination so // that you can analyze the errors. For more information, see Understanding -// Application Output (Destination) -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). -// Any configuration update, including adding a streaming source using this +// Application Output (Destination) (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) +// . Any configuration update, including adding a streaming source using this // operation, results in a new version of the application. You can use the -// DescribeApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) +// DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to find the current application version. For the limits on the number -// of application inputs and outputs you can configure, see Limits -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). This -// operation requires permissions to perform the +// of application inputs and outputs you can configure, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) +// . This operation requires permissions to perform the // kinesisanalytics:AddApplicationOutput action. func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicationOutputInput, optFns ...func(*Options)) (*AddApplicationOutputOutput, error) { if params == nil { @@ -58,8 +55,7 @@ type AddApplicationOutputInput struct { ApplicationName *string // Version of the application to which you want to add the output configuration. - // You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified is // not the current version, the ConcurrentModificationException is returned. // diff --git a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go index 67776698d6b..9c3ead977a0 100644 --- a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go @@ -14,18 +14,16 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Adds a reference data source to an existing +// Analytics API V2 Documentation . Adds a reference data source to an existing // application. Amazon Kinesis Analytics reads reference data (that is, an Amazon // S3 object) and creates an in-application table within your application. In the // request, you provide the source (S3 bucket name and object key name), name of // the in-application table to create, and the necessary mapping information that // describes how data in Amazon S3 object maps to columns in the resulting // in-application table. For conceptual information, see Configuring Application -// Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). -// For the limits on data sources you can add to your application, see Limits -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). This -// operation requires permissions to perform the +// Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . For the limits on data sources you can add to your application, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) +// . This operation requires permissions to perform the // kinesisanalytics:AddApplicationOutput action. func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params *AddApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*AddApplicationReferenceDataSourceOutput, error) { if params == nil { @@ -50,8 +48,7 @@ type AddApplicationReferenceDataSourceInput struct { ApplicationName *string // Version of the application for which you are adding the reference data source. - // You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified is // not the current version, the ConcurrentModificationException is returned. // diff --git a/service/kinesisanalytics/api_op_CreateApplication.go b/service/kinesisanalytics/api_op_CreateApplication.go index f7961c7016d..7c1bed3bceb 100644 --- a/service/kinesisanalytics/api_op_CreateApplication.go +++ b/service/kinesisanalytics/api_op_CreateApplication.go @@ -14,13 +14,12 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Creates an Amazon Kinesis Analytics application. -// You can configure each application with one streaming source as input, -// application code to process the input, and up to three destinations where you -// want Amazon Kinesis Analytics to write the output data from your application. -// For an overview, see How it Works -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html). In -// the input configuration, you map the streaming source to an in-application +// Analytics API V2 Documentation . Creates an Amazon Kinesis Analytics +// application. You can configure each application with one streaming source as +// input, application code to process the input, and up to three destinations where +// you want Amazon Kinesis Analytics to write the output data from your +// application. For an overview, see How it Works (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html) +// . In the input configuration, you map the streaming source to an in-application // stream, which you can think of as a constantly updating table. In the mapping, // you must provide a schema for the in-application stream and map each data column // in the in-application stream to a data element in the streaming source. Your @@ -33,8 +32,8 @@ import ( // permissions. You grant these permissions by creating IAM roles. This operation // requires permissions to perform the kinesisanalytics:CreateApplication action. // For introductory exercises to create an Amazon Kinesis Analytics application, -// see Getting Started -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html). +// see Getting Started (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html) +// . func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -53,7 +52,7 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio // TBD type CreateApplicationInput struct { - // Name of your Amazon Kinesis Analytics application (for example, sample-app). + // Name of your Amazon Kinesis Analytics application (for example, sample-app ). // // This member is required. ApplicationName *string @@ -63,14 +62,13 @@ type CreateApplicationInput struct { // in-application stream, generates a running average of the number of // advertisement clicks by vendor, and insert resulting rows in another // in-application stream using pumps. For more information about the typical - // pattern, see Application Code - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html). - // You can provide such series of SQL statements, where output of one statement can - // be used as the input for the next statement. You store intermediate results by - // creating in-application streams and pumps. Note that the application code must - // create the streams with names specified in the Outputs. For example, if your - // Outputs defines output streams named ExampleOutputStream1 and - // ExampleOutputStream2, then your application code must create these streams. + // pattern, see Application Code (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html) + // . You can provide such series of SQL statements, where output of one statement + // can be used as the input for the next statement. You store intermediate results + // by creating in-application streams and pumps. Note that the application code + // must create the streams with names specified in the Outputs . For example, if + // your Outputs defines output streams named ExampleOutputStream1 and + // ExampleOutputStream2 , then your application code must create these streams. ApplicationCode *string // Summary description of the application. @@ -78,8 +76,8 @@ type CreateApplicationInput struct { // Use this parameter to configure a CloudWatch log stream to monitor application // configuration errors. For more information, see Working with Amazon CloudWatch - // Logs - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). + // Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html) + // . CloudWatchLoggingOptions []types.CloudWatchLoggingOption // Use this parameter to configure the application input. You can configure your @@ -113,8 +111,8 @@ type CreateApplicationInput struct { // A list of one or more tags to assign to the application. A tag is a key-value // pair that identifies an application. Note that the maximum number of application // tags includes system tags. The maximum number of user-defined application tags - // is 50. For more information, see Using Tagging - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). + // is 50. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/kinesisanalytics/api_op_DeleteApplication.go b/service/kinesisanalytics/api_op_DeleteApplication.go index 22c5fe492e0..43cceb91b20 100644 --- a/service/kinesisanalytics/api_op_DeleteApplication.go +++ b/service/kinesisanalytics/api_op_DeleteApplication.go @@ -14,7 +14,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Deletes the specified application. Amazon +// Analytics API V2 Documentation . Deletes the specified application. Amazon // Kinesis Analytics halts application execution and deletes the application, // including any application artifacts (such as in-application streams, reference // table, and application code). This operation requires permissions to perform the diff --git a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go index 17efe09322d..086f6972bc8 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -13,10 +13,10 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Deletes a CloudWatch log stream from an +// Analytics API V2 Documentation . Deletes a CloudWatch log stream from an // application. For more information about using CloudWatch log streams with Amazon -// Kinesis Analytics applications, see Working with Amazon CloudWatch Logs -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). +// Kinesis Analytics applications, see Working with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html) +// . func (c *Client) DeleteApplicationCloudWatchLoggingOption(ctx context.Context, params *DeleteApplicationCloudWatchLoggingOptionInput, optFns ...func(*Options)) (*DeleteApplicationCloudWatchLoggingOptionOutput, error) { if params == nil { params = &DeleteApplicationCloudWatchLoggingOptionInput{} @@ -40,8 +40,7 @@ type DeleteApplicationCloudWatchLoggingOptionInput struct { ApplicationName *string // The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You - // can get the CloudWatchLoggingOptionId by using the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // can get the CloudWatchLoggingOptionId by using the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // This member is required. diff --git a/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go b/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go index 8736379f742..1d2f5591955 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go @@ -13,8 +13,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Deletes an InputProcessingConfiguration -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) +// Analytics API V2 Documentation . Deletes an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // from an input. func (c *Client) DeleteApplicationInputProcessingConfiguration(ctx context.Context, params *DeleteApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationInputProcessingConfigurationOutput, error) { if params == nil { @@ -45,8 +44,7 @@ type DeleteApplicationInputProcessingConfigurationInput struct { // The ID of the input configuration from which to delete the input processing // configuration. You can get a list of the input IDs for an application by using - // the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // This member is required. diff --git a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go index aa70e943efb..98074577e3c 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go @@ -13,7 +13,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Deletes output destination configuration from +// Analytics API V2 Documentation . Deletes output destination configuration from // your application configuration. Amazon Kinesis Analytics will no longer write // data from the corresponding in-application stream to the external output // destination. This operation requires permissions to perform the @@ -41,8 +41,7 @@ type DeleteApplicationOutputInput struct { ApplicationName *string // Amazon Kinesis Analytics application version. You can use the - // DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified is // not the current version, the ConcurrentModificationException is returned. // @@ -51,13 +50,11 @@ type DeleteApplicationOutputInput struct { // The ID of the configuration to delete. Each output configuration that is added // to the application, either when the application is created or later using the - // AddApplicationOutput - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html) + // AddApplicationOutput (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html) // operation, has a unique ID. You need to provide the ID to uniquely identify the // output configuration that you want to delete from the application configuration. - // You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) - // operation to get the specific OutputId. + // You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // operation to get the specific OutputId . // // This member is required. OutputId *string diff --git a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go index bbcb05d0cc7..096be4ae552 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go @@ -13,11 +13,10 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Deletes a reference data source configuration +// Analytics API V2 Documentation . Deletes a reference data source configuration // from the specified application configuration. If the application is running, // Amazon Kinesis Analytics immediately removes the in-application table that you -// created using the AddApplicationReferenceDataSource -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) +// created using the AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) // operation. This operation requires permissions to perform the // kinesisanalytics.DeleteApplicationReferenceDataSource action. func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, params *DeleteApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*DeleteApplicationReferenceDataSourceOutput, error) { @@ -42,8 +41,7 @@ type DeleteApplicationReferenceDataSourceInput struct { // This member is required. ApplicationName *string - // Version of the application. You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // Version of the application. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the current application version. If the version specified is // not the current version, the ConcurrentModificationException is returned. // @@ -51,10 +49,8 @@ type DeleteApplicationReferenceDataSourceInput struct { CurrentApplicationVersionId *int64 // ID of the reference data source. When you add a reference data source to your - // application using the AddApplicationReferenceDataSource - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html), - // Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // application using the AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) + // , Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get the reference ID. // // This member is required. diff --git a/service/kinesisanalytics/api_op_DescribeApplication.go b/service/kinesisanalytics/api_op_DescribeApplication.go index a6166dc9f53..97a41de832c 100644 --- a/service/kinesisanalytics/api_op_DescribeApplication.go +++ b/service/kinesisanalytics/api_op_DescribeApplication.go @@ -14,14 +14,13 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Returns information about a specific Amazon +// Analytics API V2 Documentation . Returns information about a specific Amazon // Kinesis Analytics application. If you want to retrieve a list of all -// applications in your account, use the ListApplications -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html) +// applications in your account, use the ListApplications (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html) // operation. This operation requires permissions to perform the // kinesisanalytics:DescribeApplication action. You can use DescribeApplication to // get the current application versionId, which you need to call other operations -// such as Update. +// such as Update . func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplicationInput, optFns ...func(*Options)) (*DescribeApplicationOutput, error) { if params == nil { params = &DescribeApplicationInput{} diff --git a/service/kinesisanalytics/api_op_DiscoverInputSchema.go b/service/kinesisanalytics/api_op_DiscoverInputSchema.go index e707690b2bd..5a63db0890a 100644 --- a/service/kinesisanalytics/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalytics/api_op_DiscoverInputSchema.go @@ -14,14 +14,13 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Infers a schema by evaluating sample records on +// Analytics API V2 Documentation . Infers a schema by evaluating sample records on // the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose // delivery stream) or S3 object. In the response, the operation returns the // inferred schema and also the sample records that the operation used to infer the // schema. You can use the inferred schema when configuring a streaming source for -// your application. For conceptual information, see Configuring Application Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). -// Note that when you create an application using the Amazon Kinesis Analytics +// your application. For conceptual information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . Note that when you create an application using the Amazon Kinesis Analytics // console, the console uses this operation to infer a schema and show it in the // console user interface. This operation requires permissions to perform the // kinesisanalytics:DiscoverInputSchema action. @@ -42,8 +41,7 @@ func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputS type DiscoverInputSchemaInput struct { - // The InputProcessingConfiguration - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) + // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // to use to preprocess the records before discovering the schema of the records. InputProcessingConfiguration *types.InputProcessingConfiguration @@ -71,8 +69,8 @@ type DiscoverInputSchemaOutput struct { // in the in-application stream that you can create. InputSchema *types.SourceSchema - // An array of elements, where each element corresponds to a row in a stream record - // (a stream record can have more than one row). + // An array of elements, where each element corresponds to a row in a stream + // record (a stream record can have more than one row). ParsedInputRecords [][]string // Stream data that was modified by the processor specified in the diff --git a/service/kinesisanalytics/api_op_ListApplications.go b/service/kinesisanalytics/api_op_ListApplications.go index 433820fd87f..f8119a4bcb0 100644 --- a/service/kinesisanalytics/api_op_ListApplications.go +++ b/service/kinesisanalytics/api_op_ListApplications.go @@ -14,17 +14,16 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Returns a list of Amazon Kinesis Analytics +// Analytics API V2 Documentation . Returns a list of Amazon Kinesis Analytics // applications in your account. For each application, the response includes the // application name, Amazon Resource Name (ARN), and status. If the response // returns the HasMoreApplications value as true, // -// you can send another request by -// adding the ExclusiveStartApplicationName in the request body, and set the value -// of this to the last application name from the previous response. If you want -// detailed information about a specific application, use DescribeApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html). -// This operation requires permissions to perform the +// you can send another request by adding the ExclusiveStartApplicationName in the +// request body, and set the value of this to the last application name from the +// previous response. If you want detailed information about a specific +// application, use DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) +// . This operation requires permissions to perform the // kinesisanalytics:ListApplications action. func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error) { if params == nil { diff --git a/service/kinesisanalytics/api_op_ListTagsForResource.go b/service/kinesisanalytics/api_op_ListTagsForResource.go index c9d7f045e7c..8c4dd9aeca3 100644 --- a/service/kinesisanalytics/api_op_ListTagsForResource.go +++ b/service/kinesisanalytics/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( ) // Retrieves the list of key-value tags assigned to the application. For more -// information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). +// information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/kinesisanalytics/api_op_StartApplication.go b/service/kinesisanalytics/api_op_StartApplication.go index e7197c37f63..b38e8676a3d 100644 --- a/service/kinesisanalytics/api_op_StartApplication.go +++ b/service/kinesisanalytics/api_op_StartApplication.go @@ -14,17 +14,15 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Starts the specified Amazon Kinesis Analytics +// Analytics API V2 Documentation . Starts the specified Amazon Kinesis Analytics // application. After creating an application, you must exclusively call this // operation to start your application. After the application starts, it begins // consuming the input data, processes it, and writes the output to the configured // destination. The application status must be READY for you to start an // application. You can get the application status in the console or using the -// DescribeApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) +// DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. After you start the application, you can stop the application from -// processing the input by calling the StopApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html) +// processing the input by calling the StopApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html) // operation. This operation requires permissions to perform the // kinesisanalytics:StartApplication action. func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error) { diff --git a/service/kinesisanalytics/api_op_StopApplication.go b/service/kinesisanalytics/api_op_StopApplication.go index 6614c8efff0..102e5d81739 100644 --- a/service/kinesisanalytics/api_op_StopApplication.go +++ b/service/kinesisanalytics/api_op_StopApplication.go @@ -13,10 +13,9 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Stops the application from processing input +// Analytics API V2 Documentation . Stops the application from processing input // data. You can stop an application only if it is in the running state. You can -// use the DescribeApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) +// use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to find the application state. After the application is stopped, // Amazon Kinesis Analytics stops reading data from the input, the application // stops processing data, and there is no output written to the destination. This diff --git a/service/kinesisanalytics/api_op_TagResource.go b/service/kinesisanalytics/api_op_TagResource.go index d564bf00ba9..4580af5f3a3 100644 --- a/service/kinesisanalytics/api_op_TagResource.go +++ b/service/kinesisanalytics/api_op_TagResource.go @@ -13,8 +13,8 @@ import ( // Adds one or more key-value tags to a Kinesis Analytics application. Note that // the maximum number of application tags includes system tags. The maximum number -// of user-defined application tags is 50. For more information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). +// of user-defined application tags is 50. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/kinesisanalytics/api_op_UntagResource.go b/service/kinesisanalytics/api_op_UntagResource.go index 035c46ea7c5..530c9c77830 100644 --- a/service/kinesisanalytics/api_op_UntagResource.go +++ b/service/kinesisanalytics/api_op_UntagResource.go @@ -11,8 +11,8 @@ import ( ) // Removes one or more tags from a Kinesis Analytics application. For more -// information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). +// information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/kinesisanalytics/api_op_UpdateApplication.go b/service/kinesisanalytics/api_op_UpdateApplication.go index 607a7895fe7..1e8d00bf63b 100644 --- a/service/kinesisanalytics/api_op_UpdateApplication.go +++ b/service/kinesisanalytics/api_op_UpdateApplication.go @@ -14,7 +14,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Updates an existing Amazon Kinesis Analytics +// Analytics API V2 Documentation . Updates an existing Amazon Kinesis Analytics // application. Using this API, you can update application code, input // configuration, and output configuration. Note that Amazon Kinesis Analytics // updates the CurrentApplicationVersionId each time you update your application. @@ -47,8 +47,7 @@ type UpdateApplicationInput struct { // This member is required. ApplicationUpdate *types.ApplicationUpdate - // The current application version ID. You can use the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // The current application version ID. You can use the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get this value. // // This member is required. diff --git a/service/kinesisanalytics/doc.go b/service/kinesisanalytics/doc.go index 400b51746c1..41276fdef52 100644 --- a/service/kinesisanalytics/doc.go +++ b/service/kinesisanalytics/doc.go @@ -6,7 +6,7 @@ // Amazon Kinesis Analytics Overview This documentation is for version 1 of the // Amazon Kinesis Data Analytics API, which only supports SQL applications. Version // 2 of the API supports SQL and Java applications. For more information about -// version 2, see Amazon Kinesis Data Analytics API V2 Documentation. This is the +// version 2, see Amazon Kinesis Data Analytics API V2 Documentation . This is the // Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics // Developer Guide provides additional information. package kinesisanalytics diff --git a/service/kinesisanalytics/types/enums.go b/service/kinesisanalytics/types/enums.go index dd15b6726c8..90e983113f3 100644 --- a/service/kinesisanalytics/types/enums.go +++ b/service/kinesisanalytics/types/enums.go @@ -37,8 +37,8 @@ const ( InputStartingPositionLastStoppedPoint InputStartingPosition = "LAST_STOPPED_POINT" ) -// Values returns all known values for InputStartingPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InputStartingPosition. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InputStartingPosition) Values() []InputStartingPosition { return []InputStartingPosition{ diff --git a/service/kinesisanalytics/types/errors.go b/service/kinesisanalytics/types/errors.go index ff1ac0a407b..44541bdb432 100644 --- a/service/kinesisanalytics/types/errors.go +++ b/service/kinesisanalytics/types/errors.go @@ -194,11 +194,10 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Discovery failed to get a record from the streaming source because of the Amazon -// Kinesis Streams ProvisionedThroughputExceededException. For more information, -// see GetRecords -// (https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) in -// the Amazon Kinesis Streams API Reference. +// Discovery failed to get a record from the streaming source because of the +// Amazon Kinesis Streams ProvisionedThroughputExceededException. For more +// information, see GetRecords (https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) +// in the Amazon Kinesis Streams API Reference. type ResourceProvisionedThroughputExceededException struct { Message *string diff --git a/service/kinesisanalytics/types/types.go b/service/kinesisanalytics/types/types.go index ce5b61f4798..b48156fe919 100644 --- a/service/kinesisanalytics/types/types.go +++ b/service/kinesisanalytics/types/types.go @@ -10,7 +10,7 @@ import ( // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Provides a description of the application, +// Analytics API V2 Documentation . Provides a description of the application, // including the application Amazon Resource Name (ARN), status, latest version, // and input and output configuration. type ApplicationDetail struct { @@ -44,29 +44,29 @@ type ApplicationDetail struct { // Describes the CloudWatch log streams that are configured to receive application // messages. For more information about using CloudWatch log streams with Amazon - // Kinesis Analytics applications, see Working with Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). + // Kinesis Analytics applications, see Working with Amazon CloudWatch Logs (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html) + // . CloudWatchLoggingOptionDescriptions []CloudWatchLoggingOptionDescription // Time stamp when the application version was created. CreateTimestamp *time.Time // Describes the application input configuration. For more information, see - // Configuring Application Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). + // Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) + // . InputDescriptions []InputDescription // Time stamp when the application was last updated. LastUpdateTimestamp *time.Time // Describes the application output configuration. For more information, see - // Configuring Application Output - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). + // Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) + // . OutputDescriptions []OutputDescription // Describes reference data sources configured for the application. For more - // information, see Configuring Application Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). + // information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) + // . ReferenceDataSourceDescriptions []ReferenceDataSourceDescription noSmithyDocumentSerde @@ -75,7 +75,7 @@ type ApplicationDetail struct { // This documentation is for version 1 of the Amazon Kinesis Data Analytics API, // which only supports SQL applications. Version 2 of the API supports SQL and Java // applications. For more information about version 2, see Amazon Kinesis Data -// Analytics API V2 Documentation. Provides application summary information, +// Analytics API V2 Documentation . Provides application summary information, // including the application Amazon Resource Name (ARN), name, and status. type ApplicationSummary struct { @@ -200,8 +200,8 @@ type CSVMappingParameters struct { } // Describes the data format when records are written to the destination. For more -// information, see Configuring Application Output -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). +// information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) +// . type DestinationSchema struct { // Specifies the format of the records on the output stream. @@ -214,8 +214,8 @@ type DestinationSchema struct { // When you configure the application input, you specify the streaming source, the // in-application stream name that is created, and the mapping between the two. For -// more information, see Configuring Application Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). +// more information, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . type Input struct { // Describes the format of the data in the streaming source, and how each data @@ -236,16 +236,15 @@ type Input struct { // Describes the number of in-application streams to create. Data from your source // is routed to these in-application input streams. (see Configuring Application - // Input - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). + // Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) + // . InputParallelism *InputParallelism - // The InputProcessingConfiguration - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) + // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) // for the input. An input processor transforms records as they are received from // the stream, before the application's SQL code executes. Currently, the only - // input processing configuration available is InputLambdaProcessor - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html). + // input processing configuration available is InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) + // . InputProcessingConfiguration *InputProcessingConfiguration // If the streaming source is an Amazon Kinesis Firehose delivery stream, @@ -268,8 +267,7 @@ type Input struct { // the application to start processing records. type InputConfiguration struct { - // Input source ID. You can get this ID by calling the DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // Input source ID. You can get this ID by calling the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation. // // This member is required. @@ -285,8 +283,8 @@ type InputConfiguration struct { } // Describes the application input configuration. For more information, see -// Configuring Application Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). +// Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . type InputDescription struct { // Returns the in-application stream names that are mapped to the stream source. @@ -297,8 +295,8 @@ type InputDescription struct { // application. InputId *string - // Describes the configured parallelism (number of in-application streams mapped to - // the streaming source). + // Describes the configured parallelism (number of in-application streams mapped + // to the streaming source). InputParallelism *InputParallelism // The description of the preprocessor that executes on records in this input @@ -329,10 +327,9 @@ type InputDescription struct { noSmithyDocumentSerde } -// An object that contains the Amazon Resource Name (ARN) of the AWS Lambda -// (https://docs.aws.amazon.com/lambda/) function that is used to preprocess -// records in the stream, and the ARN of the IAM role that is used to access the -// AWS Lambda function. +// An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/lambda/) +// function that is used to preprocess records in the stream, and the ARN of the +// IAM role that is used to access the AWS Lambda function. type InputLambdaProcessor struct { // The ARN of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function that @@ -352,14 +349,13 @@ type InputLambdaProcessor struct { noSmithyDocumentSerde } -// An object that contains the Amazon Resource Name (ARN) of the AWS Lambda -// (https://docs.aws.amazon.com/lambda/) function that is used to preprocess -// records in the stream, and the ARN of the IAM role that is used to access the -// AWS Lambda expression. +// An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/lambda/) +// function that is used to preprocess records in the stream, and the ARN of the +// IAM role that is used to access the AWS Lambda expression. type InputLambdaProcessorDescription struct { - // The ARN of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function that is - // used to preprocess the records in the stream. + // The ARN of the AWS Lambda (https://docs.aws.amazon.com/lambda/) function that + // is used to preprocess the records in the stream. ResourceARN *string // The ARN of the IAM role that is used to access the AWS Lambda function. @@ -368,16 +364,15 @@ type InputLambdaProcessorDescription struct { noSmithyDocumentSerde } -// Represents an update to the InputLambdaProcessor -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) +// Represents an update to the InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) // that is used to preprocess the records in the stream. type InputLambdaProcessorUpdate struct { - // The Amazon Resource Name (ARN) of the new AWS Lambda - // (https://docs.aws.amazon.com/lambda/) function that is used to preprocess the - // records in the stream. To specify an earlier version of the Lambda function than - // the latest, include the Lambda function version in the Lambda function ARN. For - // more information about Lambda ARNs, see Example ARNs: AWS Lambda + // The Amazon Resource Name (ARN) of the new AWS Lambda (https://docs.aws.amazon.com/lambda/) + // function that is used to preprocess the records in the stream. To specify an + // earlier version of the Lambda function than the latest, include the Lambda + // function version in the Lambda function ARN. For more information about Lambda + // ARNs, see Example ARNs: AWS Lambda ResourceARNUpdate *string // The ARN of the new IAM role that is used to access the AWS Lambda function. @@ -387,12 +382,12 @@ type InputLambdaProcessorUpdate struct { } // Describes the number of in-application streams to create for a given streaming -// source. For information about parallelism, see Configuring Application Input -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). +// source. For information about parallelism, see Configuring Application Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) +// . type InputParallelism struct { - // Number of in-application streams to create. For more information, see Limits - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). + // Number of in-application streams to create. For more information, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) + // . Count *int32 noSmithyDocumentSerde @@ -409,11 +404,10 @@ type InputParallelismUpdate struct { // Provides a description of a processor that is used to preprocess the records in // the stream before being processed by your application code. Currently, the only -// input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/). +// input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/) . type InputProcessingConfiguration struct { - // The InputLambdaProcessor - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) + // The InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) // that is used to preprocess the records in the stream before being processed by // your application code. // @@ -423,24 +417,25 @@ type InputProcessingConfiguration struct { noSmithyDocumentSerde } -// Provides configuration information about an input processor. Currently, the only -// input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/). +// Provides configuration information about an input processor. Currently, the +// only input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/) +// . type InputProcessingConfigurationDescription struct { // Provides configuration information about the associated - // InputLambdaProcessorDescription - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html). + // InputLambdaProcessorDescription (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html) + // . InputLambdaProcessorDescription *InputLambdaProcessorDescription noSmithyDocumentSerde } -// Describes updates to an InputProcessingConfiguration -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html). +// Describes updates to an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) +// . type InputProcessingConfigurationUpdate struct { - // Provides update information for an InputLambdaProcessor - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html). + // Provides update information for an InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) + // . // // This member is required. InputLambdaProcessorUpdate *InputLambdaProcessorUpdate @@ -470,17 +465,13 @@ type InputSchemaUpdate struct { type InputStartingPositionConfiguration struct { // The starting position on the stream. - // - // * NOW - Start reading just after the most - // recent record in the stream, start at the request time stamp that the customer - // issued. - // - // * TRIM_HORIZON - Start reading at the last untrimmed record in the - // stream, which is the oldest record available in the stream. This option is not - // available for an Amazon Kinesis Firehose delivery stream. - // - // * LAST_STOPPED_POINT - // - Resume reading from where the application last stopped reading. + // - NOW - Start reading just after the most recent record in the stream, start + // at the request time stamp that the customer issued. + // - TRIM_HORIZON - Start reading at the last untrimmed record in the stream, + // which is the oldest record available in the stream. This option is not available + // for an Amazon Kinesis Firehose delivery stream. + // - LAST_STOPPED_POINT - Resume reading from where the application last stopped + // reading. InputStartingPosition InputStartingPosition noSmithyDocumentSerde @@ -515,8 +506,8 @@ type InputUpdate struct { // updated stream Amazon Resource Name (ARN) and IAM role ARN. KinesisStreamsInputUpdate *KinesisStreamsInputUpdate - // Name prefix for in-application streams that Amazon Kinesis Analytics creates for - // the specific streaming source. + // Name prefix for in-application streams that Amazon Kinesis Analytics creates + // for the specific streaming source. NamePrefixUpdate *string noSmithyDocumentSerde @@ -603,8 +594,8 @@ type KinesisFirehoseOutput struct { noSmithyDocumentSerde } -// For an application output, describes the Amazon Kinesis Firehose delivery stream -// configured as its destination. +// For an application output, describes the Amazon Kinesis Firehose delivery +// stream configured as its destination. type KinesisFirehoseOutputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. @@ -617,8 +608,7 @@ type KinesisFirehoseOutputDescription struct { noSmithyDocumentSerde } -// When updating an output configuration using the UpdateApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) +// When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) // operation, provides information about an Amazon Kinesis Firehose delivery stream // configured as the destination. type KinesisFirehoseOutputUpdate struct { @@ -702,8 +692,8 @@ type KinesisStreamsOutput struct { noSmithyDocumentSerde } -// For an application output, describes the Amazon Kinesis stream configured as its -// destination. +// For an application output, describes the Amazon Kinesis stream configured as +// its destination. type KinesisStreamsOutputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis stream. @@ -716,8 +706,7 @@ type KinesisStreamsOutputDescription struct { noSmithyDocumentSerde } -// When updating an output configuration using the UpdateApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) +// When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) // operation, provides information about an Amazon Kinesis stream configured as the // destination. type KinesisStreamsOutputUpdate struct { @@ -771,8 +760,7 @@ type LambdaOutputDescription struct { noSmithyDocumentSerde } -// When updating an output configuration using the UpdateApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) +// When updating an output configuration using the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) // operation, provides information about an AWS Lambda function configured as the // destination. type LambdaOutputUpdate struct { @@ -812,13 +800,13 @@ type MappingParameters struct { // in-application stream and a destination where you want the in-application stream // data to be written. The destination can be an Amazon Kinesis stream or an Amazon // Kinesis Firehose delivery stream. For limits on how many destinations an -// application can write and other limitations, see Limits -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html). +// application can write and other limitations, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) +// . type Output struct { // Describes the data format when records are written to the destination. For more - // information, see Configuring Application Output - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). + // information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) + // . // // This member is required. DestinationSchema *DestinationSchema @@ -870,7 +858,7 @@ type OutputDescription struct { noSmithyDocumentSerde } -// Describes updates to the output configuration identified by the OutputId. +// Describes updates to the output configuration identified by the OutputId . type OutputUpdate struct { // Identifies the specific output configuration that you want to update. @@ -879,8 +867,8 @@ type OutputUpdate struct { OutputId *string // Describes the data format when records are written to the destination. For more - // information, see Configuring Application Output - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). + // information, see Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) + // . DestinationSchemaUpdate *DestinationSchema // Describes an Amazon Kinesis Firehose delivery stream as the destination for the @@ -917,9 +905,8 @@ type RecordColumn struct { SqlType *string // Reference to the data element in the streaming input or the reference data - // source. This element is required if the RecordFormatType - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) - // is JSON. + // source. This element is required if the RecordFormatType (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel) + // is JSON . Mapping *string noSmithyDocumentSerde @@ -975,8 +962,7 @@ type ReferenceDataSourceDescription struct { // ID of the reference data source. This is the ID that Amazon Kinesis Analytics // assigns when you add the reference data source to your application using the - // AddApplicationReferenceDataSource - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) + // AddApplicationReferenceDataSource (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) // operation. // // This member is required. @@ -1011,8 +997,7 @@ type ReferenceDataSourceDescription struct { type ReferenceDataSourceUpdate struct { // ID of the reference data source being updated. You can use the - // DescribeApplication - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) + // DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) // operation to get this value. // // This member is required. @@ -1059,8 +1044,7 @@ type S3Configuration struct { // Identifies the S3 bucket and object that contains the reference data. Also // identifies the IAM role Amazon Kinesis Analytics can assume to read this object // on your behalf. An Amazon Kinesis Analytics application loads reference data -// only once. If the data changes, you call the UpdateApplication -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) +// only once. If the data changes, you call the UpdateApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) // operation to trigger reloading of data into your application. type S3ReferenceDataSource struct { @@ -1150,8 +1134,8 @@ type SourceSchema struct { // resources. If you specify a tag that already exists, the tag value is replaced // with the value that you specify in the request. Note that the maximum number of // application tags includes system tags. The maximum number of user-defined -// application tags is 50. For more information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). +// application tags is 50. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) +// . type Tag struct { // The key of the key-value tag. diff --git a/service/kinesisanalyticsv2/api_client.go b/service/kinesisanalyticsv2/api_client.go index df0da6ca09e..7ef80624c16 100644 --- a/service/kinesisanalyticsv2/api_client.go +++ b/service/kinesisanalyticsv2/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go index 382c28e5185..eceb2ab5fb9 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go @@ -41,17 +41,17 @@ type AddApplicationCloudWatchLoggingOptionInput struct { CloudWatchLoggingOption *types.CloudWatchLoggingOption // A value you use to implement strong concurrency for application updates. You - // must provide the CurrentApplicationVersionId or the ConditionalToken. You get - // the application's current ConditionalToken using DescribeApplication. For better - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // must provide the CurrentApplicationVersionId or the ConditionalToken . You get + // the application's current ConditionalToken using DescribeApplication . For + // better concurrency support, use the ConditionalToken parameter instead of + // CurrentApplicationVersionId . ConditionalToken *string // The version ID of the Kinesis Data Analytics application. You must provide the - // CurrentApplicationVersionId or the ConditionalToken.You can retrieve the - // application version ID using DescribeApplication. For better concurrency + // CurrentApplicationVersionId or the ConditionalToken .You can retrieve the + // application version ID using DescribeApplication . For better concurrency // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go index 3cf23f92e48..bce743543cf 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go @@ -14,7 +14,7 @@ import ( // Adds a streaming source to your SQL-based Kinesis Data Analytics application. // You can add a streaming source when you create an application, or you can use // this operation to add a streaming source after you create an application. For -// more information, see CreateApplication. Any configuration update, including +// more information, see CreateApplication . Any configuration update, including // adding a streaming source using this operation, results in a new version of the // application. You can use the DescribeApplication operation to find the current // application version. @@ -42,8 +42,8 @@ type AddApplicationInputInput struct { ApplicationName *string // The current version of your application. You must provide the - // ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication - // operation to find the current application version. + // ApplicationVersionID or the ConditionalToken .You can use the + // DescribeApplication operation to find the current application version. // // This member is required. CurrentApplicationVersionId *int64 diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go b/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go index 44d26c63bd7..ea3d448e885 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go @@ -14,7 +14,7 @@ import ( // Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics // application. An input processor pre-processes records on the input stream before // the application's SQL code executes. Currently, the only input processor -// available is Amazon Lambda (https://docs.aws.amazon.com/lambda/). +// available is Amazon Lambda (https://docs.aws.amazon.com/lambda/) . func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, params *AddApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*AddApplicationInputProcessingConfigurationOutput, error) { if params == nil { params = &AddApplicationInputProcessingConfigurationInput{} diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go index 2629ed8ef08..42e79111300 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go @@ -75,8 +75,8 @@ type AddApplicationOutputOutput struct { ApplicationVersionId *int64 // Describes the application output configuration. For more information, see - // Configuring Application Output - // (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html). + // Configuring Application Output (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html) + // . OutputDescriptions []types.OutputDescription // Metadata pertaining to the operation's result. diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go index f8e5c1d953f..9c44c2a8759 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go @@ -14,14 +14,10 @@ import ( // Adds a Virtual Private Cloud (VPC) configuration to the application. // Applications can use VPCs to store and access resources securely. Note the // following about VPC configurations for Kinesis Data Analytics applications: -// -// * -// VPC configurations are not supported for SQL applications. -// -// * When a VPC is -// added to a Kinesis Data Analytics application, the application can no longer be -// accessed from the Internet directly. To enable Internet access to the -// application, add an Internet gateway to your VPC. +// - VPC configurations are not supported for SQL applications. +// - When a VPC is added to a Kinesis Data Analytics application, the +// application can no longer be accessed from the Internet directly. To enable +// Internet access to the application, add an Internet gateway to your VPC. func (c *Client) AddApplicationVpcConfiguration(ctx context.Context, params *AddApplicationVpcConfigurationInput, optFns ...func(*Options)) (*AddApplicationVpcConfigurationOutput, error) { if params == nil { params = &AddApplicationVpcConfigurationInput{} @@ -50,18 +46,18 @@ type AddApplicationVpcConfigurationInput struct { VpcConfiguration *types.VpcConfiguration // A value you use to implement strong concurrency for application updates. You - // must provide the ApplicationVersionID or the ConditionalToken. You get the - // application's current ConditionalToken using DescribeApplication. For better + // must provide the ApplicationVersionID or the ConditionalToken . You get the + // application's current ConditionalToken using DescribeApplication . For better // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // CurrentApplicationVersionId . ConditionalToken *string // The version of the application to which you want to add the VPC configuration. - // You must provide the CurrentApplicationVersionId or the ConditionalToken. You + // You must provide the CurrentApplicationVersionId or the ConditionalToken . You // can use the DescribeApplication operation to get the current application // version. If the version specified is not the current version, the // ConcurrentModificationException is returned. For better concurrency support, use - // the ConditionalToken parameter instead of CurrentApplicationVersionId. + // the ConditionalToken parameter instead of CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_CreateApplication.go b/service/kinesisanalyticsv2/api_op_CreateApplication.go index 0e0fb9842b7..dbf325b828c 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplication.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplication.go @@ -12,8 +12,8 @@ import ( ) // Creates a Kinesis Data Analytics application. For information about creating a -// Kinesis Data Analytics application, see Creating an Application -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html). +// Kinesis Data Analytics application, see Creating an Application (https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html) +// . func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -31,7 +31,7 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio type CreateApplicationInput struct { - // The name of your application (for example, sample-app). + // The name of your application (for example, sample-app ). // // This member is required. ApplicationName *string @@ -53,8 +53,9 @@ type CreateApplicationInput struct { // A summary description of the application. ApplicationDescription *string - // Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. - // To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode. + // Use the STREAMING mode to create a Kinesis Data Analytics For Flink + // application. To create a Kinesis Data Analytics Studio notebook, use the + // INTERACTIVE mode. ApplicationMode types.ApplicationMode // Use this parameter to configure an Amazon CloudWatch log stream to monitor @@ -64,8 +65,8 @@ type CreateApplicationInput struct { // A list of one or more tags to assign to the application. A tag is a key-value // pair that identifies an application. Note that the maximum number of application // tags includes system tags. The maximum number of user-defined application tags - // is 50. For more information, see Using Tagging - // (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). + // is 50. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go b/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go index 63905650ae9..b41a22a2888 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go @@ -45,7 +45,7 @@ type CreateApplicationPresignedUrlInput struct { ApplicationName *string // The type of the extension for which to create and return a URL. Currently, the - // only valid extension URL type is FLINK_DASHBOARD_URL. + // only valid extension URL type is FLINK_DASHBOARD_URL . // // This member is required. UrlType types.UrlType diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go index e82e156c8c9..aede13abafe 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -35,25 +35,25 @@ type DeleteApplicationCloudWatchLoggingOptionInput struct { // This member is required. ApplicationName *string - // The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. - // You can get the CloudWatchLoggingOptionId by using the DescribeApplication - // operation. + // The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to + // delete. You can get the CloudWatchLoggingOptionId by using the + // DescribeApplication operation. // // This member is required. CloudWatchLoggingOptionId *string // A value you use to implement strong concurrency for application updates. You - // must provide the CurrentApplicationVersionId or the ConditionalToken. You get - // the application's current ConditionalToken using DescribeApplication. For better - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // must provide the CurrentApplicationVersionId or the ConditionalToken . You get + // the application's current ConditionalToken using DescribeApplication . For + // better concurrency support, use the ConditionalToken parameter instead of + // CurrentApplicationVersionId . ConditionalToken *string // The version ID of the application. You must provide the - // CurrentApplicationVersionId or the ConditionalToken. You can retrieve the - // application version ID using DescribeApplication. For better concurrency + // CurrentApplicationVersionId or the ConditionalToken . You can retrieve the + // application version ID using DescribeApplication . For better concurrency // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go index 2ee85e3def8..27bb24a900d 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go @@ -48,7 +48,7 @@ type DeleteApplicationOutputInput struct { // AddApplicationOutput operation has a unique ID. You need to provide the ID to // uniquely identify the output configuration that you want to delete from the // application configuration. You can use the DescribeApplication operation to get - // the specific OutputId. + // the specific OutputId . // // This member is required. OutputId *string diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go index 1c00735314a..71325512ee2 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go @@ -44,7 +44,7 @@ type DeleteApplicationReferenceDataSourceInput struct { CurrentApplicationVersionId *int64 // The ID of the reference data source. When you add a reference data source to - // your application using the AddApplicationReferenceDataSource, Kinesis Data + // your application using the AddApplicationReferenceDataSource , Kinesis Data // Analytics assigns an ID. You can use the DescribeApplication operation to get // the reference ID. // diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go index 1c036a7aaec..68463ec0452 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go @@ -39,17 +39,17 @@ type DeleteApplicationVpcConfigurationInput struct { VpcConfigurationId *string // A value you use to implement strong concurrency for application updates. You - // must provide the CurrentApplicationVersionId or the ConditionalToken. You get - // the application's current ConditionalToken using DescribeApplication. For better - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // must provide the CurrentApplicationVersionId or the ConditionalToken . You get + // the application's current ConditionalToken using DescribeApplication . For + // better concurrency support, use the ConditionalToken parameter instead of + // CurrentApplicationVersionId . ConditionalToken *string // The current application version ID. You must provide the - // CurrentApplicationVersionId or the ConditionalToken. You can retrieve the - // application version ID using DescribeApplication. For better concurrency + // CurrentApplicationVersionId or the ConditionalToken . You can retrieve the + // application version ID using DescribeApplication . For better concurrency // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go b/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go index a8a7837866f..d405f76cdd7 100644 --- a/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go +++ b/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go @@ -47,8 +47,8 @@ type DescribeApplicationVersionInput struct { type DescribeApplicationVersionOutput struct { - // Describes the application, including the application Amazon Resource Name (ARN), - // status, latest version, and input and output configurations. + // Describes the application, including the application Amazon Resource Name + // (ARN), status, latest version, and input and output configurations. ApplicationVersionDetail *types.ApplicationDetail // Metadata pertaining to the operation's result. diff --git a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go index 3cf3a9c01bf..c5f5aef24f7 100644 --- a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating -// sample records on the specified streaming source (Kinesis data stream or Kinesis -// Data Firehose delivery stream) or Amazon S3 object. In the response, the -// operation returns the inferred schema and also the sample records that the +// Infers a schema for a SQL-based Kinesis Data Analytics application by +// evaluating sample records on the specified streaming source (Kinesis data stream +// or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, +// the operation returns the inferred schema and also the sample records that the // operation used to infer the schema. You can use the inferred schema when // configuring a streaming source for your application. When you create an // application using the Kinesis Data Analytics console, the console uses this @@ -45,8 +45,8 @@ type DiscoverInputSchemaInput struct { // discovering the schema of the records. InputProcessingConfiguration *types.InputProcessingConfiguration - // The point at which you want Kinesis Data Analytics to start reading records from - // the specified streaming source discovery purposes. + // The point at which you want Kinesis Data Analytics to start reading records + // from the specified streaming source discovery purposes. InputStartingPositionConfiguration *types.InputStartingPositionConfiguration // The Amazon Resource Name (ARN) of the streaming source. @@ -65,8 +65,8 @@ type DiscoverInputSchemaOutput struct { // columns in the in-application stream that you can create. InputSchema *types.SourceSchema - // An array of elements, where each element corresponds to a row in a stream record - // (a stream record can have more than one row). + // An array of elements, where each element corresponds to a row in a stream + // record (a stream record can have more than one row). ParsedInputRecords [][]string // The stream data that was modified by the processor specified in the diff --git a/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go b/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go index ecbfad2f8b8..3a3b7a82a44 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go +++ b/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go @@ -43,8 +43,8 @@ type ListApplicationVersionsInput struct { // If a previous invocation of this operation returned a pagination token, pass it // into this value to retrieve the next set of results. For more information about - // pagination, see Using the Amazon Command Line Interface's Pagination Options - // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). + // pagination, see Using the Amazon Command Line Interface's Pagination Options (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // . NextToken *string noSmithyDocumentSerde @@ -61,8 +61,8 @@ type ListApplicationVersionsOutput struct { // The pagination token for the next set of results, or null if there are no // additional results. To retrieve the next set of items, pass this token into a // subsequent invocation of this operation. For more information about pagination, - // see Using the Amazon Command Line Interface's Pagination Options - // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). + // see Using the Amazon Command Line Interface's Pagination Options (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/kinesisanalyticsv2/api_op_ListApplications.go b/service/kinesisanalyticsv2/api_op_ListApplications.go index ef451225a30..4de0273261e 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplications.go +++ b/service/kinesisanalyticsv2/api_op_ListApplications.go @@ -14,7 +14,7 @@ import ( // Returns a list of Kinesis Data Analytics applications in your account. For each // application, the response includes the application name, Amazon Resource Name // (ARN), and status. If you want detailed information about a specific -// application, use DescribeApplication. +// application, use DescribeApplication . func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error) { if params == nil { params = &ListApplicationsInput{} @@ -37,8 +37,8 @@ type ListApplicationsInput struct { // If a previous command returned a pagination token, pass it into this value to // retrieve the next set of results. For more information about pagination, see - // Using the Amazon Command Line Interface's Pagination Options - // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). + // Using the Amazon Command Line Interface's Pagination Options (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // . NextToken *string noSmithyDocumentSerde @@ -54,8 +54,8 @@ type ListApplicationsOutput struct { // The pagination token for the next set of results, or null if there are no // additional results. Pass this token into a subsequent command to retrieve the // next set of items For more information about pagination, see Using the Amazon - // Command Line Interface's Pagination Options - // (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html). + // Command Line Interface's Pagination Options (https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) + // . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/kinesisanalyticsv2/api_op_ListTagsForResource.go b/service/kinesisanalyticsv2/api_op_ListTagsForResource.go index a2540f36096..cb213fb246e 100644 --- a/service/kinesisanalyticsv2/api_op_ListTagsForResource.go +++ b/service/kinesisanalyticsv2/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( ) // Retrieves the list of key-value tags assigned to the application. For more -// information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). +// information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/kinesisanalyticsv2/api_op_RollbackApplication.go b/service/kinesisanalyticsv2/api_op_RollbackApplication.go index a9b2766ae4c..d9ed2f8f621 100644 --- a/service/kinesisanalyticsv2/api_op_RollbackApplication.go +++ b/service/kinesisanalyticsv2/api_op_RollbackApplication.go @@ -41,7 +41,7 @@ type RollbackApplicationInput struct { ApplicationName *string // The current application version ID. You can retrieve the application version ID - // using DescribeApplication. + // using DescribeApplication . // // This member is required. CurrentApplicationVersionId *int64 @@ -51,8 +51,8 @@ type RollbackApplicationInput struct { type RollbackApplicationOutput struct { - // Describes the application, including the application Amazon Resource Name (ARN), - // status, latest version, and input and output configurations. + // Describes the application, including the application Amazon Resource Name + // (ARN), status, latest version, and input and output configurations. // // This member is required. ApplicationDetail *types.ApplicationDetail diff --git a/service/kinesisanalyticsv2/api_op_StopApplication.go b/service/kinesisanalyticsv2/api_op_StopApplication.go index 5dbfd6d1dae..878b5a0843f 100644 --- a/service/kinesisanalyticsv2/api_op_StopApplication.go +++ b/service/kinesisanalyticsv2/api_op_StopApplication.go @@ -11,10 +11,10 @@ import ( ) // Stops the application from processing data. You can stop an application only if -// it is in the running status, unless you set the Force parameter to true. You can -// use the DescribeApplication operation to find the application status. Kinesis -// Data Analytics takes a snapshot when the application is stopped, unless Force is -// set to true. +// it is in the running status, unless you set the Force parameter to true . You +// can use the DescribeApplication operation to find the application status. +// Kinesis Data Analytics takes a snapshot when the application is stopped, unless +// Force is set to true . func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error) { if params == nil { params = &StopApplicationInput{} @@ -37,14 +37,14 @@ type StopApplicationInput struct { // This member is required. ApplicationName *string - // Set to true to force the application to stop. If you set Force to true, Kinesis + // Set to true to force the application to stop. If you set Force to true , Kinesis // Data Analytics stops the application without taking a snapshot. Force-stopping // your application may lead to data loss or duplication. To prevent data loss or // duplicate processing of data during application restarts, we recommend you to // take frequent snapshots of your application. You can only force stop a // Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based - // Kinesis Data Analytics application. The application must be in the STARTING, - // UPDATING, STOPPING, AUTOSCALING, or RUNNING status. + // Kinesis Data Analytics application. The application must be in the STARTING , + // UPDATING , STOPPING , AUTOSCALING , or RUNNING status. Force *bool noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_TagResource.go b/service/kinesisanalyticsv2/api_op_TagResource.go index 119936713af..9f166e5d934 100644 --- a/service/kinesisanalyticsv2/api_op_TagResource.go +++ b/service/kinesisanalyticsv2/api_op_TagResource.go @@ -14,8 +14,8 @@ import ( // Adds one or more key-value tags to a Kinesis Data Analytics application. Note // that the maximum number of application tags includes system tags. The maximum // number of user-defined application tags is 50. For more information, see Using -// Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). +// Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/kinesisanalyticsv2/api_op_UntagResource.go b/service/kinesisanalyticsv2/api_op_UntagResource.go index 1a51165acfe..040b5b819a0 100644 --- a/service/kinesisanalyticsv2/api_op_UntagResource.go +++ b/service/kinesisanalyticsv2/api_op_UntagResource.go @@ -11,8 +11,8 @@ import ( ) // Removes one or more tags from a Kinesis Data Analytics application. For more -// information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). +// information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/kinesisanalyticsv2/api_op_UpdateApplication.go b/service/kinesisanalyticsv2/api_op_UpdateApplication.go index 83469cf0051..6f63e954515 100644 --- a/service/kinesisanalyticsv2/api_op_UpdateApplication.go +++ b/service/kinesisanalyticsv2/api_op_UpdateApplication.go @@ -15,8 +15,8 @@ import ( // you can update application code, input configuration, and output configuration. // Kinesis Data Analytics updates the ApplicationVersionId each time you update // your application. You cannot update the RuntimeEnvironment of an existing -// application. If you need to update an application's RuntimeEnvironment, you must -// delete the application and create it again. +// application. If you need to update an application's RuntimeEnvironment , you +// must delete the application and create it again. func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error) { if params == nil { params = &UpdateApplicationInput{} @@ -44,21 +44,21 @@ type UpdateApplicationInput struct { // Describes application Amazon CloudWatch logging option updates. You can only // update existing CloudWatch logging options with this action. To add a new - // CloudWatch logging option, use AddApplicationCloudWatchLoggingOption. + // CloudWatch logging option, use AddApplicationCloudWatchLoggingOption . CloudWatchLoggingOptionUpdates []types.CloudWatchLoggingOptionUpdate // A value you use to implement strong concurrency for application updates. You - // must provide the CurrentApplicationVersionId or the ConditionalToken. You get - // the application's current ConditionalToken using DescribeApplication. For better - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // must provide the CurrentApplicationVersionId or the ConditionalToken . You get + // the application's current ConditionalToken using DescribeApplication . For + // better concurrency support, use the ConditionalToken parameter instead of + // CurrentApplicationVersionId . ConditionalToken *string // The current application version ID. You must provide the - // CurrentApplicationVersionId or the ConditionalToken.You can retrieve the - // application version ID using DescribeApplication. For better concurrency + // CurrentApplicationVersionId or the ConditionalToken .You can retrieve the + // application version ID using DescribeApplication . For better concurrency // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId. + // CurrentApplicationVersionId . CurrentApplicationVersionId *int64 // Describes updates to the application's starting parameters. diff --git a/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go b/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go index 82fded7694f..50a870f0467 100644 --- a/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go @@ -11,22 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the maintenance configuration of the Kinesis Data Analytics application. -// You can invoke this operation on an application that is in one of the two -// following states: READY or RUNNING. If you invoke it when the application is in -// a state other than these two states, it throws a ResourceInUseException. The -// service makes use of the updated configuration the next time it schedules -// maintenance for the application. If you invoke this operation after the service -// schedules maintenance, the service will apply the configuration update the next -// time it schedules maintenance for the application. This means that you might not -// see the maintenance configuration update applied to the maintenance process that -// follows a successful invocation of this operation, but to the following -// maintenance process instead. To see the current maintenance configuration of -// your application, invoke the DescribeApplication operation. For information -// about application maintenance, see Kinesis Data Analytics for Apache Flink -// Maintenance -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/maintenance.html). -// This operation is supported only for Amazon Kinesis Data Analytics for Apache +// Updates the maintenance configuration of the Kinesis Data Analytics +// application. You can invoke this operation on an application that is in one of +// the two following states: READY or RUNNING . If you invoke it when the +// application is in a state other than these two states, it throws a +// ResourceInUseException . The service makes use of the updated configuration the +// next time it schedules maintenance for the application. If you invoke this +// operation after the service schedules maintenance, the service will apply the +// configuration update the next time it schedules maintenance for the application. +// This means that you might not see the maintenance configuration update applied +// to the maintenance process that follows a successful invocation of this +// operation, but to the following maintenance process instead. To see the current +// maintenance configuration of your application, invoke the DescribeApplication +// operation. For information about application maintenance, see Kinesis Data +// Analytics for Apache Flink Maintenance (https://docs.aws.amazon.com/kinesisanalytics/latest/java/maintenance.html) +// . This operation is supported only for Amazon Kinesis Data Analytics for Apache // Flink. func (c *Client) UpdateApplicationMaintenanceConfiguration(ctx context.Context, params *UpdateApplicationMaintenanceConfigurationInput, optFns ...func(*Options)) (*UpdateApplicationMaintenanceConfigurationOutput, error) { if params == nil { diff --git a/service/kinesisanalyticsv2/types/enums.go b/service/kinesisanalyticsv2/types/enums.go index 1235ea5cde2..35db27a29d3 100644 --- a/service/kinesisanalyticsv2/types/enums.go +++ b/service/kinesisanalyticsv2/types/enums.go @@ -84,9 +84,9 @@ const ( ArtifactTypeDependencyJar ArtifactType = "DEPENDENCY_JAR" ) -// Values returns all known values for ArtifactType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ArtifactType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ArtifactType) Values() []ArtifactType { return []ArtifactType{ "UDF", @@ -139,8 +139,8 @@ const ( InputStartingPositionLastStoppedPoint InputStartingPosition = "LAST_STOPPED_POINT" ) -// Values returns all known values for InputStartingPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InputStartingPosition. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InputStartingPosition) Values() []InputStartingPosition { return []InputStartingPosition{ @@ -182,9 +182,9 @@ const ( MetricsLevelParallelism MetricsLevel = "PARALLELISM" ) -// Values returns all known values for MetricsLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MetricsLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MetricsLevel) Values() []MetricsLevel { return []MetricsLevel{ "APPLICATION", diff --git a/service/kinesisanalyticsv2/types/errors.go b/service/kinesisanalyticsv2/types/errors.go index 8c6161c7045..5ae1b46a987 100644 --- a/service/kinesisanalyticsv2/types/errors.go +++ b/service/kinesisanalyticsv2/types/errors.go @@ -34,9 +34,9 @@ func (e *CodeValidationException) ErrorCode() string { } func (e *CodeValidationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Exception thrown as a result of concurrent modifications to an application. This -// error can be the result of attempting to modify an application without using the -// current application ID. +// Exception thrown as a result of concurrent modifications to an application. +// This error can be the result of attempting to modify an application without +// using the current application ID. type ConcurrentModificationException struct { Message *string @@ -221,10 +221,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Discovery failed to get a record from the streaming source because of the -// Kinesis Streams ProvisionedThroughputExceededException. For more information, -// see GetRecords -// (http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) in -// the Amazon Kinesis Streams API Reference. +// Kinesis Streams ProvisionedThroughputExceededException . For more information, +// see GetRecords (http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) +// in the Amazon Kinesis Streams API Reference. type ResourceProvisionedThroughputExceededException struct { Message *string diff --git a/service/kinesisanalyticsv2/types/types.go b/service/kinesisanalyticsv2/types/types.go index 855d7f3a9f9..a0a12feceec 100644 --- a/service/kinesisanalyticsv2/types/types.go +++ b/service/kinesisanalyticsv2/types/types.go @@ -35,8 +35,8 @@ type ApplicationCodeConfigurationDescription struct { noSmithyDocumentSerde } -// Describes code configuration updates for an application. This is supported for a -// Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data +// Describes code configuration updates for an application. This is supported for +// a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data // Analytics application. type ApplicationCodeConfigurationUpdate struct { @@ -56,8 +56,8 @@ type ApplicationConfiguration struct { // application. ApplicationCodeConfiguration *ApplicationCodeConfiguration - // Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics - // application. + // Describes whether snapshots are enabled for a Flink-based Kinesis Data + // Analytics application. ApplicationSnapshotConfiguration *ApplicationSnapshotConfiguration // Describes execution properties for a Flink-based Kinesis Data Analytics @@ -89,8 +89,8 @@ type ApplicationConfigurationDescription struct { // application. ApplicationCodeConfigurationDescription *ApplicationCodeConfigurationDescription - // Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics - // application. + // Describes whether snapshots are enabled for a Flink-based Kinesis Data + // Analytics application. ApplicationSnapshotConfigurationDescription *ApplicationSnapshotConfigurationDescription // Describes execution properties for a Flink-based Kinesis Data Analytics @@ -123,8 +123,8 @@ type ApplicationConfigurationUpdate struct { // Describes updates to an application's code configuration. ApplicationCodeConfigurationUpdate *ApplicationCodeConfigurationUpdate - // Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics - // application. + // Describes whether snapshots are enabled for a Flink-based Kinesis Data + // Analytics application. ApplicationSnapshotConfigurationUpdate *ApplicationSnapshotConfigurationUpdate // Describes updates to the environment properties for a Flink-based Kinesis Data @@ -149,8 +149,8 @@ type ApplicationConfigurationUpdate struct { noSmithyDocumentSerde } -// Describes the application, including the application Amazon Resource Name (ARN), -// status, latest version, and input and output configurations. +// Describes the application, including the application Amazon Resource Name +// (ARN), status, latest version, and input and output configurations. type ApplicationDetail struct { // The ARN of the application. @@ -190,11 +190,11 @@ type ApplicationDetail struct { ApplicationMaintenanceConfigurationDescription *ApplicationMaintenanceConfigurationDescription // To create a Kinesis Data Analytics Studio notebook, you must set the mode to - // INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, - // the mode is optional. + // INTERACTIVE . However, for a Kinesis Data Analytics for Apache Flink + // application, the mode is optional. ApplicationMode ApplicationMode - // If you reverted the application using RollbackApplication, the application + // If you reverted the application using RollbackApplication , the application // version when RollbackApplication was called. ApplicationVersionRolledBackFrom *int64 @@ -259,20 +259,20 @@ type ApplicationRestoreConfiguration struct { // This member is required. ApplicationRestoreType ApplicationRestoreType - // The identifier of an existing snapshot of application state to use to restart an - // application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is - // specified for the ApplicationRestoreType. + // The identifier of an existing snapshot of application state to use to restart + // an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT + // is specified for the ApplicationRestoreType . SnapshotName *string noSmithyDocumentSerde } -// Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics -// application. +// Describes whether snapshots are enabled for a Flink-based Kinesis Data +// Analytics application. type ApplicationSnapshotConfiguration struct { - // Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics - // application. + // Describes whether snapshots are enabled for a Flink-based Kinesis Data + // Analytics application. // // This member is required. SnapshotsEnabled *bool @@ -280,12 +280,12 @@ type ApplicationSnapshotConfiguration struct { noSmithyDocumentSerde } -// Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics -// application. +// Describes whether snapshots are enabled for a Flink-based Kinesis Data +// Analytics application. type ApplicationSnapshotConfigurationDescription struct { - // Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics - // application. + // Describes whether snapshots are enabled for a Flink-based Kinesis Data + // Analytics application. // // This member is required. SnapshotsEnabled *bool @@ -334,8 +334,8 @@ type ApplicationSummary struct { // This member is required. RuntimeEnvironment RuntimeEnvironment - // For a Kinesis Data Analytics for Apache Flink application, the mode is - // STREAMING. For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE. + // For a Kinesis Data Analytics for Apache Flink application, the mode is STREAMING + // . For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE . ApplicationMode ApplicationMode noSmithyDocumentSerde @@ -405,51 +405,44 @@ type CatalogConfigurationUpdate struct { // Describes an application's checkpointing configuration. Checkpointing is the // process of persisting application state for fault tolerance. For more -// information, see Checkpoints for Fault Tolerance -// (https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance) -// in the Apache Flink Documentation -// (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). +// information, see Checkpoints for Fault Tolerance (https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance) +// in the Apache Flink Documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) +// . type CheckpointConfiguration struct { // Describes whether the application uses Kinesis Data Analytics' default - // checkpointing behavior. You must set this property to CUSTOM in order to set the - // CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints - // parameters. If this value is set to DEFAULT, the application will use the + // checkpointing behavior. You must set this property to CUSTOM in order to set + // the CheckpointingEnabled , CheckpointInterval , or MinPauseBetweenCheckpoints + // parameters. If this value is set to DEFAULT , the application will use the // following values, even if they are set to other values using APIs or application // code: - // - // * CheckpointingEnabled: true - // - // * CheckpointInterval: 60000 - // - // * - // MinPauseBetweenCheckpoints: 5000 + // - CheckpointingEnabled: true + // - CheckpointInterval: 60000 + // - MinPauseBetweenCheckpoints: 5000 // // This member is required. ConfigurationType ConfigurationType // Describes the interval in milliseconds between checkpoint operations. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // CheckpointInterval value of 60000, even if this value is set to another value + // CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use + // a CheckpointInterval value of 60000, even if this value is set to another value // using this API or in application code. CheckpointInterval *int64 // Describes whether checkpointing is enabled for a Flink-based Kinesis Data - // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, - // the application will use a CheckpointingEnabled value of true, even if this + // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT , + // the application will use a CheckpointingEnabled value of true , even if this // value is set to another value using this API or in application code. CheckpointingEnabled *bool // Describes the minimum time in milliseconds after a checkpoint operation // completes that a new checkpoint operation can start. If a checkpoint operation - // takes longer than the CheckpointInterval, the application otherwise performs - // continual checkpoint operations. For more information, see Tuning Checkpointing - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/large_state_tuning.html#tuning-checkpointing) - // in the Apache Flink Documentation - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this - // API or in application code. + // takes longer than the CheckpointInterval , the application otherwise performs + // continual checkpoint operations. For more information, see Tuning Checkpointing (https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/large_state_tuning.html#tuning-checkpointing) + // in the Apache Flink Documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) + // . If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will + // use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using + // this API or in application code. MinPauseBetweenCheckpoints *int64 noSmithyDocumentSerde @@ -460,76 +453,68 @@ type CheckpointConfiguration struct { type CheckpointConfigurationDescription struct { // Describes the interval in milliseconds between checkpoint operations. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // CheckpointInterval value of 60000, even if this value is set to another value + // CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use + // a CheckpointInterval value of 60000, even if this value is set to another value // using this API or in application code. CheckpointInterval *int64 // Describes whether checkpointing is enabled for a Flink-based Kinesis Data - // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, - // the application will use a CheckpointingEnabled value of true, even if this + // Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT , + // the application will use a CheckpointingEnabled value of true , even if this // value is set to another value using this API or in application code. CheckpointingEnabled *bool // Describes whether the application uses the default checkpointing behavior in - // Kinesis Data Analytics. If this value is set to DEFAULT, the application will + // Kinesis Data Analytics. If this value is set to DEFAULT , the application will // use the following values, even if they are set to other values using APIs or // application code: - // - // * CheckpointingEnabled: true - // - // * CheckpointInterval: 60000 - // - // * - // MinPauseBetweenCheckpoints: 5000 + // - CheckpointingEnabled: true + // - CheckpointInterval: 60000 + // - MinPauseBetweenCheckpoints: 5000 ConfigurationType ConfigurationType // Describes the minimum time in milliseconds after a checkpoint operation // completes that a new checkpoint operation can start. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this - // API or in application code. + // CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use + // a MinPauseBetweenCheckpoints value of 5000, even if this value is set using + // this API or in application code. MinPauseBetweenCheckpoints *int64 noSmithyDocumentSerde } -// Describes updates to the checkpointing parameters for a Flink-based Kinesis Data -// Analytics application. +// Describes updates to the checkpointing parameters for a Flink-based Kinesis +// Data Analytics application. type CheckpointConfigurationUpdate struct { - // Describes updates to the interval in milliseconds between checkpoint operations. - // If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will - // use a CheckpointInterval value of 60000, even if this value is set to another - // value using this API or in application code. + // Describes updates to the interval in milliseconds between checkpoint + // operations. If CheckpointConfiguration.ConfigurationType is DEFAULT , the + // application will use a CheckpointInterval value of 60000, even if this value is + // set to another value using this API or in application code. CheckpointIntervalUpdate *int64 // Describes updates to whether checkpointing is enabled for an application. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // CheckpointingEnabled value of true, even if this value is set to another value - // using this API or in application code. + // CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use + // a CheckpointingEnabled value of true , even if this value is set to another + // value using this API or in application code. CheckpointingEnabledUpdate *bool // Describes updates to whether the application uses the default checkpointing // behavior of Kinesis Data Analytics. You must set this property to CUSTOM in - // order to set the CheckpointingEnabled, CheckpointInterval, or - // MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT, the + // order to set the CheckpointingEnabled , CheckpointInterval , or + // MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT , the // application will use the following values, even if they are set to other values // using APIs or application code: - // - // * CheckpointingEnabled: true - // - // * - // CheckpointInterval: 60000 - // - // * MinPauseBetweenCheckpoints: 5000 + // - CheckpointingEnabled: true + // - CheckpointInterval: 60000 + // - MinPauseBetweenCheckpoints: 5000 ConfigurationTypeUpdate ConfigurationType // Describes updates to the minimum time in milliseconds after a checkpoint // operation completes that a new checkpoint operation can start. If - // CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a - // MinPauseBetweenCheckpoints value of 5000, even if this value is set using this - // API or in application code. + // CheckpointConfiguration.ConfigurationType is DEFAULT , the application will use + // a MinPauseBetweenCheckpoints value of 5000, even if this value is set using + // this API or in application code. MinPauseBetweenCheckpointsUpdate *int64 noSmithyDocumentSerde @@ -637,14 +622,13 @@ type CodeContentUpdate struct { // For a SQL-based Kinesis Data Analytics application, provides additional mapping // information when the record format uses delimiters, such as CSV. For example, // the following sample records use CSV format, where the records use the '\n' as -// the row delimiter and a comma (",") as the column delimiter: "name1", -// "address1" +// the row delimiter and a comma (",") as the column delimiter: "name1", "address1" // // "name2", "address2" type CSVMappingParameters struct { - // The column delimiter. For example, in a CSV format, a comma (",") is the typical - // column delimiter. + // The column delimiter. For example, in a CSV format, a comma (",") is the + // typical column delimiter. // // This member is required. RecordColumnDelimiter *string @@ -714,8 +698,8 @@ type DeployAsApplicationConfiguration struct { noSmithyDocumentSerde } -// The configuration information required to deploy an Amazon Data Analytics Studio -// notebook as an application with durable state. +// The configuration information required to deploy an Amazon Data Analytics +// Studio notebook as an application with durable state. type DeployAsApplicationConfigurationDescription struct { // The location that holds the data required to specify an Amazon Data Analytics @@ -789,10 +773,9 @@ type FlinkApplicationConfiguration struct { // Describes an application's checkpointing configuration. Checkpointing is the // process of persisting application state for fault tolerance. For more - // information, see Checkpoints for Fault Tolerance - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance) - // in the Apache Flink Documentation - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). + // information, see Checkpoints for Fault Tolerance (https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance) + // in the Apache Flink Documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) + // . CheckpointConfiguration *CheckpointConfiguration // Describes configuration parameters for Amazon CloudWatch logging for an @@ -815,11 +798,9 @@ type FlinkApplicationConfigurationDescription struct { CheckpointConfigurationDescription *CheckpointConfigurationDescription // The job plan for an application. For more information about the job plan, see - // Jobs and Scheduling - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/internals/job_scheduling.html) - // in the Apache Flink Documentation - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). To retrieve the - // job plan for the application, use the + // Jobs and Scheduling (https://ci.apache.org/projects/flink/flink-docs-release-1.8/internals/job_scheduling.html) + // in the Apache Flink Documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) + // . To retrieve the job plan for the application, use the // DescribeApplicationRequest$IncludeAdditionalDetails parameter of the // DescribeApplication operation. JobPlanDescription *string @@ -835,12 +816,13 @@ type FlinkApplicationConfigurationDescription struct { noSmithyDocumentSerde } -// Describes updates to the configuration parameters for a Flink-based Kinesis Data -// Analytics application. +// Describes updates to the configuration parameters for a Flink-based Kinesis +// Data Analytics application. type FlinkApplicationConfigurationUpdate struct { - // Describes updates to an application's checkpointing configuration. Checkpointing - // is the process of persisting application state for fault tolerance. + // Describes updates to an application's checkpointing configuration. + // Checkpointing is the process of persisting application state for fault + // tolerance. CheckpointConfigurationUpdate *CheckpointConfigurationUpdate // Describes updates to the configuration parameters for Amazon CloudWatch logging @@ -858,17 +840,15 @@ type FlinkApplicationConfigurationUpdate struct { // application. type FlinkRunConfiguration struct { - // When restoring from a snapshot, specifies whether the runtime is allowed to skip - // a state that cannot be mapped to the new program. This will happen if the + // When restoring from a snapshot, specifies whether the runtime is allowed to + // skip a state that cannot be mapped to the new program. This will happen if the // program is updated between snapshots to remove stateful parameters, and state // data in the snapshot no longer corresponds to valid application data. For more - // information, see Allowing Non-Restored State - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state) - // in the Apache Flink documentation - // (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). This value - // defaults to false. If you update your application without specifying this - // parameter, AllowNonRestoredState will be set to false, even if it was previously - // set to true. + // information, see Allowing Non-Restored State (https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state) + // in the Apache Flink documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) + // . This value defaults to false . If you update your application without + // specifying this parameter, AllowNonRestoredState will be set to false , even if + // it was previously set to true . AllowNonRestoredState *bool noSmithyDocumentSerde @@ -923,10 +903,10 @@ type Input struct { InputSchema *SourceSchema // The name prefix to use when creating an in-application stream. Suppose that you - // specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates + // specify a prefix " MyInApplicationStream ." Kinesis Data Analytics then creates // one or more (as per the InputParallelism count you specified) in-application - // streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," - // and so on. + // streams with the names " MyInApplicationStream_001 ," " MyInApplicationStream_002 + // ," and so on. // // This member is required. NamePrefix *string @@ -937,7 +917,7 @@ type Input struct { // The InputProcessingConfiguration for the input. An input processor transforms // records as they are received from the stream, before the application's SQL code // executes. Currently, the only input processing configuration available is - // InputLambdaProcessor. + // InputLambdaProcessor . InputProcessingConfiguration *InputProcessingConfiguration // If the streaming source is an Amazon Kinesis Data Firehose delivery stream, @@ -963,8 +943,8 @@ type InputDescription struct { // application. InputId *string - // Describes the configured parallelism (number of in-application streams mapped to - // the streaming source). + // Describes the configured parallelism (number of in-application streams mapped + // to the streaming source). InputParallelism *InputParallelism // The description of the preprocessor that executes on records in this input @@ -998,11 +978,10 @@ type InputDescription struct { // Data Analytics application. type InputLambdaProcessor struct { - // The ARN of the Amazon Lambda function that operates on records in the stream. To - // specify an earlier version of the Lambda function than the latest, include the - // Lambda function version in the Lambda function ARN. For more information about - // Lambda ARNs, see Example ARNs: Amazon Lambda - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) + // The ARN of the Amazon Lambda function that operates on records in the stream. + // To specify an earlier version of the Lambda function than the latest, include + // the Lambda function version in the Lambda function ARN. For more information + // about Lambda ARNs, see Example ARNs: Amazon Lambda (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // This member is required. ResourceARN *string @@ -1018,8 +997,7 @@ type InputLambdaProcessorDescription struct { // The ARN of the Amazon Lambda function that is used to preprocess the records in // the stream. To specify an earlier version of the Lambda function than the // latest, include the Lambda function version in the Lambda function ARN. For more - // information about Lambda ARNs, see Example ARNs: Amazon Lambda - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) + // information about Lambda ARNs, see Example ARNs: Amazon Lambda (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // This member is required. ResourceARN *string @@ -1037,12 +1015,11 @@ type InputLambdaProcessorDescription struct { // InputLambdaProcessor that is used to preprocess the records in the stream. type InputLambdaProcessorUpdate struct { - // The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to - // preprocess the records in the stream. To specify an earlier version of the + // The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used + // to preprocess the records in the stream. To specify an earlier version of the // Lambda function than the latest, include the Lambda function version in the // Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: - // Amazon Lambda - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) + // Amazon Lambda (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // This member is required. ResourceARNUpdate *string @@ -1075,8 +1052,8 @@ type InputParallelismUpdate struct { // For a SQL-based Kinesis Data Analytics application, describes a processor that // is used to preprocess the records in the stream before being processed by your -// application code. Currently, the only input processor available is Amazon Lambda -// (https://docs.aws.amazon.com/lambda/). +// application code. Currently, the only input processor available is Amazon Lambda (https://docs.aws.amazon.com/lambda/) +// . type InputProcessingConfiguration struct { // The InputLambdaProcessor that is used to preprocess the records in the stream @@ -1090,7 +1067,7 @@ type InputProcessingConfiguration struct { // For a SQL-based Kinesis Data Analytics application, provides the configuration // information about an input processor. Currently, the only input processor -// available is Amazon Lambda (https://docs.aws.amazon.com/lambda/). +// available is Amazon Lambda (https://docs.aws.amazon.com/lambda/) . type InputProcessingConfigurationDescription struct { // Provides configuration information about the associated @@ -1101,10 +1078,10 @@ type InputProcessingConfigurationDescription struct { } // For a SQL-based Kinesis Data Analytics application, describes updates to an -// InputProcessingConfiguration. +// InputProcessingConfiguration . type InputProcessingConfigurationUpdate struct { - // Provides update information for an InputLambdaProcessor. + // Provides update information for an InputLambdaProcessor . // // This member is required. InputLambdaProcessorUpdate *InputLambdaProcessorUpdate @@ -1135,18 +1112,13 @@ type InputSchemaUpdate struct { type InputStartingPositionConfiguration struct { // The starting position on the stream. - // - // * NOW - Start reading just after the most - // recent record in the stream, and start at the request timestamp that the - // customer issued. - // - // * TRIM_HORIZON - Start reading at the last untrimmed record in - // the stream, which is the oldest record available in the stream. This option is - // not available for an Amazon Kinesis Data Firehose delivery stream. - // - // * - // LAST_STOPPED_POINT - Resume reading from where the application last stopped - // reading. + // - NOW - Start reading just after the most recent record in the stream, and + // start at the request timestamp that the customer issued. + // - TRIM_HORIZON - Start reading at the last untrimmed record in the stream, + // which is the oldest record available in the stream. This option is not available + // for an Amazon Kinesis Data Firehose delivery stream. + // - LAST_STOPPED_POINT - Resume reading from where the application last stopped + // reading. InputStartingPosition InputStartingPosition noSmithyDocumentSerde @@ -1165,7 +1137,7 @@ type InputUpdate struct { // Data Analytics creates for the specific streaming source). InputParallelismUpdate *InputParallelismUpdate - // Describes updates to an InputProcessingConfiguration. + // Describes updates to an InputProcessingConfiguration . InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate // Describes the data format on the streaming source, and how record elements on @@ -1213,8 +1185,8 @@ type KinesisFirehoseInput struct { noSmithyDocumentSerde } -// Describes the Amazon Kinesis Data Firehose delivery stream that is configured as -// the streaming source in the application input configuration. +// Describes the Amazon Kinesis Data Firehose delivery stream that is configured +// as the streaming source in the application input configuration. type KinesisFirehoseInputDescription struct { // The Amazon Resource Name (ARN) of the delivery stream. @@ -1244,9 +1216,10 @@ type KinesisFirehoseInputUpdate struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, when configuring application -// output, identifies a Kinesis Data Firehose delivery stream as the destination. -// You provide the stream Amazon Resource Name (ARN) of the delivery stream. +// For a SQL-based Kinesis Data Analytics application, when configuring +// application output, identifies a Kinesis Data Firehose delivery stream as the +// destination. You provide the stream Amazon Resource Name (ARN) of the delivery +// stream. type KinesisFirehoseOutput struct { // The ARN of the destination delivery stream to write to. @@ -1385,8 +1358,7 @@ type LambdaOutput struct { // The Amazon Resource Name (ARN) of the destination Lambda function to write to. // To specify an earlier version of the Lambda function than the latest, include // the Lambda function version in the Lambda function ARN. For more information - // about Lambda ARNs, see Example ARNs: Amazon Lambda - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) + // about Lambda ARNs, see Example ARNs: Amazon Lambda (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // This member is required. ResourceARN *string @@ -1420,8 +1392,7 @@ type LambdaOutputUpdate struct { // The Amazon Resource Name (ARN) of the destination Amazon Lambda function. To // specify an earlier version of the Lambda function than the latest, include the // Lambda function version in the Lambda function ARN. For more information about - // Lambda ARNs, see Example ARNs: Amazon Lambda - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) + // Lambda ARNs, see Example ARNs: Amazon Lambda (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda) // // This member is required. ResourceARNUpdate *string @@ -1429,8 +1400,8 @@ type LambdaOutputUpdate struct { noSmithyDocumentSerde } -// When you configure a SQL-based Kinesis Data Analytics application's input at the -// time of creating or updating an application, provides additional mapping +// When you configure a SQL-based Kinesis Data Analytics application's input at +// the time of creating or updating an application, provides additional mapping // information specific to the record format (such as JSON, CSV, or record fields // delimited by some delimiter) on the streaming source. type MappingParameters struct { @@ -1469,8 +1440,8 @@ type MavenReference struct { } // Describes configuration parameters for Amazon CloudWatch logging for an -// application. For more information about CloudWatch logging, see Monitoring -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html). +// application. For more information about CloudWatch logging, see Monitoring (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html) +// . type MonitoringConfiguration struct { // Describes whether to use the default CloudWatch logging configuration for an @@ -1511,9 +1482,9 @@ type MonitoringConfigurationDescription struct { // an application. type MonitoringConfigurationUpdate struct { - // Describes updates to whether to use the default CloudWatch logging configuration - // for an application. You must set this property to CUSTOM in order to set the - // LogLevel or MetricsLevel parameters. + // Describes updates to whether to use the default CloudWatch logging + // configuration for an application. You must set this property to CUSTOM in order + // to set the LogLevel or MetricsLevel parameters. ConfigurationTypeUpdate ConfigurationType // Describes updates to the verbosity of the CloudWatch Logs for an application. @@ -1527,10 +1498,10 @@ type MonitoringConfigurationUpdate struct { noSmithyDocumentSerde } -// Describes a SQL-based Kinesis Data Analytics application's output configuration, -// in which you identify an in-application stream and a destination where you want -// the in-application stream data to be written. The destination can be a Kinesis -// data stream or a Kinesis Data Firehose delivery stream. +// Describes a SQL-based Kinesis Data Analytics application's output +// configuration, in which you identify an in-application stream and a destination +// where you want the in-application stream data to be written. The destination can +// be a Kinesis data stream or a Kinesis Data Firehose delivery stream. type Output struct { // Describes the data format when records are written to the destination. @@ -1572,8 +1543,8 @@ type OutputDescription struct { // output is written. KinesisStreamsOutputDescription *KinesisStreamsOutputDescription - // Describes the Lambda function that is configured as the destination where output - // is written. + // Describes the Lambda function that is configured as the destination where + // output is written. LambdaOutputDescription *LambdaOutputDescription // The name of the in-application stream that is configured as output. @@ -1586,7 +1557,7 @@ type OutputDescription struct { } // For a SQL-based Kinesis Data Analytics application, describes updates to the -// output configuration identified by the OutputId. +// output configuration identified by the OutputId . type OutputUpdate struct { // Identifies the specific output configuration that you want to update. @@ -1616,15 +1587,14 @@ type OutputUpdate struct { // Describes parameters for how a Flink-based Kinesis Data Analytics application // executes multiple tasks simultaneously. For more information about parallelism, -// see Parallel Execution -// (https://ci.apache.org/projects/flink/flink-docs-release-1.8/dev/parallel.html) -// in the Apache Flink Documentation -// (https://ci.apache.org/projects/flink/flink-docs-release-1.8/). +// see Parallel Execution (https://ci.apache.org/projects/flink/flink-docs-release-1.8/dev/parallel.html) +// in the Apache Flink Documentation (https://ci.apache.org/projects/flink/flink-docs-release-1.8/) +// . type ParallelismConfiguration struct { // Describes whether the application uses the default parallelism for the Kinesis // Data Analytics service. You must set this property to CUSTOM in order to change - // your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU + // your application's AutoScalingEnabled , Parallelism , or ParallelismPerKPU // properties. // // This member is required. @@ -1635,19 +1605,19 @@ type ParallelismConfiguration struct { AutoScalingEnabled *bool // Describes the initial number of parallel tasks that a Flink-based Kinesis Data - // Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis - // Data Analytics increases the CurrentParallelism value in response to application - // load. The service can increase the CurrentParallelism value up to the maximum - // parallelism, which is ParalellismPerKPU times the maximum KPUs for the - // application. The maximum KPUs for an application is 32 by default, and can be - // increased by requesting a limit increase. If application load is reduced, the + // Analytics application can perform. If AutoScalingEnabled is set to True, + // Kinesis Data Analytics increases the CurrentParallelism value in response to + // application load. The service can increase the CurrentParallelism value up to + // the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for + // the application. The maximum KPUs for an application is 32 by default, and can + // be increased by requesting a limit increase. If application load is reduced, the // service can reduce the CurrentParallelism value down to the Parallelism setting. Parallelism *int32 - // Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics - // application can perform per Kinesis Processing Unit (KPU) used by the + // Describes the number of parallel tasks that a Flink-based Kinesis Data + // Analytics application can perform per Kinesis Processing Unit (KPU) used by the // application. For more information about KPUs, see Amazon Kinesis Data Analytics - // Pricing (http://aws.amazon.com/kinesis/data-analytics/pricing/). + // Pricing (http://aws.amazon.com/kinesis/data-analytics/pricing/) . ParallelismPerKPU *int32 noSmithyDocumentSerde @@ -1666,9 +1636,9 @@ type ParallelismConfigurationDescription struct { ConfigurationType ConfigurationType // Describes the current number of parallel tasks that a Flink-based Kinesis Data - // Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis - // Data Analytics can increase this value in response to application load. The - // service can increase this value up to the maximum parallelism, which is + // Analytics application can perform. If AutoScalingEnabled is set to True, + // Kinesis Data Analytics can increase this value in response to application load. + // The service can increase this value up to the maximum parallelism, which is // ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs // for an application is 32 by default, and can be increased by requesting a limit // increase. If application load is reduced, the service can reduce the @@ -1685,8 +1655,8 @@ type ParallelismConfigurationDescription struct { // service can reduce the CurrentParallelism value down to the Parallelism setting. Parallelism *int32 - // Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics - // application can perform per Kinesis Processing Unit (KPU) used by the + // Describes the number of parallel tasks that a Flink-based Kinesis Data + // Analytics application can perform per Kinesis Processing Unit (KPU) used by the // application. ParallelismPerKPU *int32 @@ -1697,19 +1667,19 @@ type ParallelismConfigurationDescription struct { // simultaneously. type ParallelismConfigurationUpdate struct { - // Describes updates to whether the Kinesis Data Analytics service can increase the - // parallelism of a Flink-based Kinesis Data Analytics application in response to - // increased throughput. + // Describes updates to whether the Kinesis Data Analytics service can increase + // the parallelism of a Flink-based Kinesis Data Analytics application in response + // to increased throughput. AutoScalingEnabledUpdate *bool // Describes updates to whether the application uses the default parallelism for // the Kinesis Data Analytics service, or if a custom parallelism is used. You must // set this property to CUSTOM in order to change your application's - // AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties. + // AutoScalingEnabled , Parallelism , or ParallelismPerKPU properties. ConfigurationTypeUpdate ConfigurationType - // Describes updates to the number of parallel tasks an application can perform per - // Kinesis Processing Unit (KPU) used by the application. + // Describes updates to the number of parallel tasks an application can perform + // per Kinesis Processing Unit (KPU) used by the application. ParallelismPerKPUUpdate *int32 // Describes updates to the initial number of parallel tasks an application can @@ -1785,10 +1755,10 @@ type RecordFormat struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, describes the reference data -// source by providing the source information (Amazon S3 bucket name and object key -// name), the resulting in-application table name that is created, and the -// necessary schema to map the data elements in the Amazon S3 object to the +// For a SQL-based Kinesis Data Analytics application, describes the reference +// data source by providing the source information (Amazon S3 bucket name and +// object key name), the resulting in-application table name that is created, and +// the necessary schema to map the data elements in the Amazon S3 object to the // in-application table. type ReferenceDataSource struct { @@ -1812,8 +1782,8 @@ type ReferenceDataSource struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, describes the reference data -// source configured for an application. +// For a SQL-based Kinesis Data Analytics application, describes the reference +// data source configured for an application. type ReferenceDataSourceDescription struct { // The ID of the reference data source. This is the ID that Kinesis Data Analytics @@ -1934,9 +1904,9 @@ type S3ApplicationCodeLocationDescription struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, provides a description of an -// Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket -// and the name of the Amazon S3 object that contains the data. +// For a SQL-based Kinesis Data Analytics application, provides a description of +// an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 +// bucket and the name of the Amazon S3 object that contains the data. type S3Configuration struct { // The ARN of the S3 bucket that contains the data. @@ -2047,8 +2017,8 @@ type S3ReferenceDataSource struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, provides the bucket name and -// object key name that stores the reference data. +// For a SQL-based Kinesis Data Analytics application, provides the bucket name +// and object key name that stores the reference data. type S3ReferenceDataSourceDescription struct { // The Amazon Resource Name (ARN) of the S3 bucket. @@ -2175,12 +2145,12 @@ type SqlApplicationConfigurationUpdate struct { // application. InputUpdates []InputUpdate - // The array of OutputUpdate objects describing the new destination streams used by - // the application. + // The array of OutputUpdate objects describing the new destination streams used + // by the application. OutputUpdates []OutputUpdate - // The array of ReferenceDataSourceUpdate objects describing the new reference data - // sources used by the application. + // The array of ReferenceDataSourceUpdate objects describing the new reference + // data sources used by the application. ReferenceDataSourceUpdates []ReferenceDataSourceUpdate noSmithyDocumentSerde @@ -2196,8 +2166,8 @@ type SqlRunConfiguration struct { // This member is required. InputId *string - // The point at which you want the application to start processing records from the - // streaming source. + // The point at which you want the application to start processing records from + // the streaming source. // // This member is required. InputStartingPositionConfiguration *InputStartingPositionConfiguration @@ -2209,8 +2179,8 @@ type SqlRunConfiguration struct { // Amazon resources. If you specify a tag that already exists, the tag value is // replaced with the value that you specify in the request. Note that the maximum // number of application tags includes system tags. The maximum number of -// user-defined application tags is 50. For more information, see Using Tagging -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html). +// user-defined application tags is 50. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) +// . type Tag struct { // The key of the key-value tag. @@ -2227,16 +2197,14 @@ type Tag struct { // Describes the parameters of a VPC used by the application. type VpcConfiguration struct { - // The array of SecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) + // The array of SecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) // IDs used by the VPC configuration. // // This member is required. SecurityGroupIds []string - // The array of Subnet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs - // used by the VPC configuration. + // The array of Subnet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) + // IDs used by the VPC configuration. // // This member is required. SubnetIds []string @@ -2247,16 +2215,14 @@ type VpcConfiguration struct { // Describes the parameters of a VPC used by the application. type VpcConfigurationDescription struct { - // The array of SecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) + // The array of SecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) // IDs used by the VPC configuration. // // This member is required. SecurityGroupIds []string - // The array of Subnet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs - // used by the VPC configuration. + // The array of Subnet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) + // IDs used by the VPC configuration. // // This member is required. SubnetIds []string @@ -2282,14 +2248,12 @@ type VpcConfigurationUpdate struct { // This member is required. VpcConfigurationId *string - // Describes updates to the array of SecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) + // Describes updates to the array of SecurityGroup (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) // IDs used by the VPC configuration. SecurityGroupIdUpdates []string - // Describes updates to the array of Subnet - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs - // used by the VPC configuration. + // Describes updates to the array of Subnet (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) + // IDs used by the VPC configuration. SubnetIdUpdates []string noSmithyDocumentSerde @@ -2298,8 +2262,8 @@ type VpcConfigurationUpdate struct { // The configuration of a Kinesis Data Analytics Studio notebook. type ZeppelinApplicationConfiguration struct { - // The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics - // Studio notebook. + // The Amazon Glue Data Catalog that you use in queries in a Kinesis Data + // Analytics Studio notebook. CatalogConfiguration *CatalogConfiguration // Custom artifacts are dependency JARs and user-defined functions (UDF). @@ -2330,8 +2294,8 @@ type ZeppelinApplicationConfigurationDescription struct { // Custom artifacts are dependency JARs and user-defined functions (UDF). CustomArtifactsConfigurationDescription []CustomArtifactConfigurationDescription - // The parameters required to deploy a Kinesis Data Analytics Studio notebook as an - // application with durable state. + // The parameters required to deploy a Kinesis Data Analytics Studio notebook as + // an application with durable state. DeployAsApplicationConfigurationDescription *DeployAsApplicationConfigurationDescription noSmithyDocumentSerde @@ -2344,8 +2308,8 @@ type ZeppelinApplicationConfigurationUpdate struct { // with the Kinesis Data Analytics Studio notebook. CatalogConfigurationUpdate *CatalogConfigurationUpdate - // Updates to the customer artifacts. Custom artifacts are dependency JAR files and - // user-defined functions (UDF). + // Updates to the customer artifacts. Custom artifacts are dependency JAR files + // and user-defined functions (UDF). CustomArtifactsConfigurationUpdate []CustomArtifactConfiguration // Updates to the configuration information required to deploy an Amazon Data @@ -2361,8 +2325,8 @@ type ZeppelinApplicationConfigurationUpdate struct { // Describes configuration parameters for Amazon CloudWatch logging for a Kinesis // Data Analytics Studio notebook. For more information about CloudWatch logging, -// see Monitoring -// (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html). +// see Monitoring (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html) +// . type ZeppelinMonitoringConfiguration struct { // The verbosity of the CloudWatch Logs for an application. @@ -2373,8 +2337,8 @@ type ZeppelinMonitoringConfiguration struct { noSmithyDocumentSerde } -// The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics -// Studio notebook. +// The monitoring configuration for Apache Zeppelin within a Kinesis Data +// Analytics Studio notebook. type ZeppelinMonitoringConfigurationDescription struct { // Describes the verbosity of the CloudWatch Logs for an application. @@ -2387,8 +2351,8 @@ type ZeppelinMonitoringConfigurationDescription struct { // Data Analytics Studio notebook. type ZeppelinMonitoringConfigurationUpdate struct { - // Updates to the logging level for Apache Zeppelin within a Kinesis Data Analytics - // Studio notebook. + // Updates to the logging level for Apache Zeppelin within a Kinesis Data + // Analytics Studio notebook. // // This member is required. LogLevelUpdate LogLevel diff --git a/service/kinesisvideo/api_client.go b/service/kinesisvideo/api_client.go index 262643cbb6a..663bf0787b6 100644 --- a/service/kinesisvideo/api_client.go +++ b/service/kinesisvideo/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisvideo/api_op_CreateStream.go b/service/kinesisvideo/api_op_CreateStream.go index ca595025ad9..54715c4f9c6 100644 --- a/service/kinesisvideo/api_op_CreateStream.go +++ b/service/kinesisvideo/api_op_CreateStream.go @@ -13,9 +13,8 @@ import ( // Creates a new Kinesis video stream. When you create a new stream, Kinesis Video // Streams assigns it a version number. When you change the stream's metadata, // Kinesis Video Streams updates the version. CreateStream is an asynchronous -// operation. For information about how the service works, see How it Works -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html). -// You must have permissions for the KinesisVideo:CreateStream action. +// operation. For information about how the service works, see How it Works (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html) +// . You must have permissions for the KinesisVideo:CreateStream action. func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { params = &CreateStreamInput{} @@ -54,18 +53,18 @@ type CreateStreamInput struct { // The ID of the Key Management Service (KMS) key that you want Kinesis Video // Streams to use to encrypt stream data. If no key ID is specified, the default, - // Kinesis Video-managed key (aws/kinesisvideo) is used. For more information, see - // DescribeKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters). + // Kinesis Video-managed key ( aws/kinesisvideo ) is used. For more information, + // see DescribeKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // . KmsKeyId *string // The media type of the stream. Consumers of the stream can use this information // when processing the stream. For more information about media types, see Media - // Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If you - // choose to specify the MediaType, see Naming Requirements - // (https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines. Example valid - // values include "video/h264" and "video/h264,audio/aac". This parameter is - // optional; the default value is null (or empty in JSON). + // Types (http://www.iana.org/assignments/media-types/media-types.xhtml) . If you + // choose to specify the MediaType , see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2) + // for guidelines. Example valid values include "video/h264" and + // "video/h264,audio/aac". This parameter is optional; the default value is null + // (or empty in JSON). MediaType *string // A list of tags to associate with the specified stream. Each tag is a key-value diff --git a/service/kinesisvideo/api_op_DeleteSignalingChannel.go b/service/kinesisvideo/api_op_DeleteSignalingChannel.go index 3f05eb61410..84a34ff898e 100644 --- a/service/kinesisvideo/api_op_DeleteSignalingChannel.go +++ b/service/kinesisvideo/api_op_DeleteSignalingChannel.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous -// operation. If you don't specify the channel's current version, the most recent -// version is deleted. +// Deletes a specified signaling channel. DeleteSignalingChannel is an +// asynchronous operation. If you don't specify the channel's current version, the +// most recent version is deleted. func (c *Client) DeleteSignalingChannel(ctx context.Context, params *DeleteSignalingChannelInput, optFns ...func(*Options)) (*DeleteSignalingChannelOutput, error) { if params == nil { params = &DeleteSignalingChannelInput{} diff --git a/service/kinesisvideo/api_op_DeleteStream.go b/service/kinesisvideo/api_op_DeleteStream.go index 6305a9e6a9b..6da361de79e 100644 --- a/service/kinesisvideo/api_op_DeleteStream.go +++ b/service/kinesisvideo/api_op_DeleteStream.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Kinesis video stream and the data contained in the stream. This method -// marks the stream for deletion, and makes the data in the stream inaccessible -// immediately. To ensure that you have the latest version of the stream before -// deleting it, you can specify the stream version. Kinesis Video Streams assigns a -// version to each stream. When you update a stream, Kinesis Video Streams assigns -// a new version number. To get the latest stream version, use the DescribeStream -// API. This operation requires permission for the KinesisVideo:DeleteStream -// action. +// Deletes a Kinesis video stream and the data contained in the stream. This +// method marks the stream for deletion, and makes the data in the stream +// inaccessible immediately. To ensure that you have the latest version of the +// stream before deleting it, you can specify the stream version. Kinesis Video +// Streams assigns a version to each stream. When you update a stream, Kinesis +// Video Streams assigns a new version number. To get the latest stream version, +// use the DescribeStream API. This operation requires permission for the +// KinesisVideo:DeleteStream action. func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error) { if params == nil { params = &DeleteStreamInput{} @@ -40,9 +40,9 @@ type DeleteStreamInput struct { // This member is required. StreamARN *string - // Optional: The version of the stream that you want to delete. Specify the version - // as a safeguard to ensure that your are deleting the correct stream. To get the - // stream version, use the DescribeStream API. If not specified, only the + // Optional: The version of the stream that you want to delete. Specify the + // version as a safeguard to ensure that your are deleting the correct stream. To + // get the stream version, use the DescribeStream API. If not specified, only the // CreationTime is checked before deleting the stream. CurrentVersion *string diff --git a/service/kinesisvideo/api_op_DescribeEdgeConfiguration.go b/service/kinesisvideo/api_op_DescribeEdgeConfiguration.go index 654368f5b2a..f5529dc30f7 100644 --- a/service/kinesisvideo/api_op_DescribeEdgeConfiguration.go +++ b/service/kinesisvideo/api_op_DescribeEdgeConfiguration.go @@ -32,12 +32,12 @@ func (c *Client) DescribeEdgeConfiguration(ctx context.Context, params *Describe type DescribeEdgeConfigurationInput struct { - // The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor - // the StreamARN. + // The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or + // the StreamARN . StreamARN *string // The name of the stream whose edge configuration you want to update. Specify - // either the StreamName or the StreamARN. + // either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_DescribeImageGenerationConfiguration.go b/service/kinesisvideo/api_op_DescribeImageGenerationConfiguration.go index 9d0c82acf94..83a02a02a82 100644 --- a/service/kinesisvideo/api_op_DescribeImageGenerationConfiguration.go +++ b/service/kinesisvideo/api_op_DescribeImageGenerationConfiguration.go @@ -31,11 +31,11 @@ type DescribeImageGenerationConfigurationInput struct { // The Amazon Resource Name (ARN) of the Kinesis video stream from which to // retrieve the image generation configuration. You must specify either the - // StreamName or the StreamARN. + // StreamName or the StreamARN . StreamARN *string // The name of the stream from which to retrieve the image generation - // configuration. You must specify either the StreamName or the StreamARN. + // configuration. You must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_DescribeMappedResourceConfiguration.go b/service/kinesisvideo/api_op_DescribeMappedResourceConfiguration.go index 524cc17ce68..3dab74f1778 100644 --- a/service/kinesisvideo/api_op_DescribeMappedResourceConfiguration.go +++ b/service/kinesisvideo/api_op_DescribeMappedResourceConfiguration.go @@ -53,7 +53,7 @@ type DescribeMappedResourceConfigurationOutput struct { // properties. MappedResourceConfigurationList []types.MappedResourceConfigurationListItem - // The token that was used in the NextTokenrequest to fetch the next set of + // The token that was used in the NextToken request to fetch the next set of // results. NextToken *string @@ -131,8 +131,8 @@ type DescribeMappedResourceConfigurationAPIClient interface { var _ DescribeMappedResourceConfigurationAPIClient = (*Client)(nil) -// DescribeMappedResourceConfigurationPaginatorOptions is the paginator options for -// DescribeMappedResourceConfiguration +// DescribeMappedResourceConfigurationPaginatorOptions is the paginator options +// for DescribeMappedResourceConfiguration type DescribeMappedResourceConfigurationPaginatorOptions struct { // The maximum number of results to return in the response. Limit int32 diff --git a/service/kinesisvideo/api_op_DescribeNotificationConfiguration.go b/service/kinesisvideo/api_op_DescribeNotificationConfiguration.go index 4088885e2a4..f185de9bf93 100644 --- a/service/kinesisvideo/api_op_DescribeNotificationConfiguration.go +++ b/service/kinesisvideo/api_op_DescribeNotificationConfiguration.go @@ -35,7 +35,7 @@ type DescribeNotificationConfigurationInput struct { StreamARN *string // The name of the stream from which to retrieve the notification configuration. - // You must specify either the StreamName or the StreamARN. + // You must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_DescribeStream.go b/service/kinesisvideo/api_op_DescribeStream.go index 8c91ff810f3..ff29abe2ed4 100644 --- a/service/kinesisvideo/api_op_DescribeStream.go +++ b/service/kinesisvideo/api_op_DescribeStream.go @@ -12,7 +12,7 @@ import ( ) // Returns the most current information about the specified stream. You must -// specify either the StreamName or the StreamARN. +// specify either the StreamName or the StreamARN . func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error) { if params == nil { params = &DescribeStreamInput{} diff --git a/service/kinesisvideo/api_op_GetDataEndpoint.go b/service/kinesisvideo/api_op_GetDataEndpoint.go index 88c2acdc594..7134e8ff937 100644 --- a/service/kinesisvideo/api_op_GetDataEndpoint.go +++ b/service/kinesisvideo/api_op_GetDataEndpoint.go @@ -16,7 +16,7 @@ import ( // GetMedia or GetMediaForFragmentList operations) or write to it (using the // PutMedia operation). The returned endpoint does not have the API name appended. // The client needs to add the API name to the returned endpoint. In the request, -// specify the stream either by StreamName or StreamARN. +// specify the stream either by StreamName or StreamARN . func (c *Client) GetDataEndpoint(ctx context.Context, params *GetDataEndpointInput, optFns ...func(*Options)) (*GetDataEndpointOutput, error) { if params == nil { params = &GetDataEndpointInput{} @@ -52,8 +52,8 @@ type GetDataEndpointInput struct { type GetDataEndpointOutput struct { - // The endpoint value. To read data from the stream or to write data to it, specify - // this endpoint in your application. + // The endpoint value. To read data from the stream or to write data to it, + // specify this endpoint in your application. DataEndpoint *string // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go index cbb71053120..4f6c4595a1b 100644 --- a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go +++ b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go @@ -16,11 +16,11 @@ import ( // parameter, which consists of the Protocols and Role properties. Protocols is // used to determine the communication mechanism. For example, if you specify WSS // as the protocol, this API produces a secure websocket endpoint. If you specify -// HTTPS as the protocol, this API generates an HTTPS endpoint. Role determines the -// messaging permissions. A MASTER role results in this API generating an endpoint -// that a client can use to communicate with any of the viewers on the channel. A -// VIEWER role results in this API generating an endpoint that a client can use to -// communicate only with a MASTER. +// HTTPS as the protocol, this API generates an HTTPS endpoint. Role determines +// the messaging permissions. A MASTER role results in this API generating an +// endpoint that a client can use to communicate with any of the viewers on the +// channel. A VIEWER role results in this API generating an endpoint that a client +// can use to communicate only with a MASTER . func (c *Client) GetSignalingChannelEndpoint(ctx context.Context, params *GetSignalingChannelEndpointInput, optFns ...func(*Options)) (*GetSignalingChannelEndpointOutput, error) { if params == nil { params = &GetSignalingChannelEndpointInput{} diff --git a/service/kinesisvideo/api_op_ListSignalingChannels.go b/service/kinesisvideo/api_op_ListSignalingChannels.go index ff2da067305..b894cebb458 100644 --- a/service/kinesisvideo/api_op_ListSignalingChannels.go +++ b/service/kinesisvideo/api_op_ListSignalingChannels.go @@ -14,7 +14,7 @@ import ( // Returns an array of ChannelInfo objects. Each object describes a signaling // channel. To retrieve only those channels that satisfy a specific condition, you -// can specify a ChannelNameCondition. +// can specify a ChannelNameCondition . func (c *Client) ListSignalingChannels(ctx context.Context, params *ListSignalingChannelsInput, optFns ...func(*Options)) (*ListSignalingChannelsOutput, error) { if params == nil { params = &ListSignalingChannelsInput{} @@ -51,8 +51,8 @@ type ListSignalingChannelsOutput struct { // An array of ChannelInfo objects. ChannelInfoList []types.ChannelInfo - // If the response is truncated, the call returns this element with a token. To get - // the next batch of streams, use this token in your next request. + // If the response is truncated, the call returns this element with a token. To + // get the next batch of streams, use this token in your next request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideo/api_op_ListStreams.go b/service/kinesisvideo/api_op_ListStreams.go index 05e8ae8c9e8..ab31d40bc96 100644 --- a/service/kinesisvideo/api_op_ListStreams.go +++ b/service/kinesisvideo/api_op_ListStreams.go @@ -14,7 +14,7 @@ import ( // Returns an array of StreamInfo objects. Each object describes a stream. To // retrieve only streams that satisfy a specific condition, you can specify a -// StreamNameCondition. +// StreamNameCondition . func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { if params == nil { params = &ListStreamsInput{} @@ -40,8 +40,8 @@ type ListStreamsInput struct { // of streams, provide this token in your next request. NextToken *string - // Optional: Returns only streams that satisfy a specific condition. Currently, you - // can specify only the prefix of a stream name as a condition. + // Optional: Returns only streams that satisfy a specific condition. Currently, + // you can specify only the prefix of a stream name as a condition. StreamNameCondition *types.StreamNameCondition noSmithyDocumentSerde @@ -49,8 +49,8 @@ type ListStreamsInput struct { type ListStreamsOutput struct { - // If the response is truncated, the call returns this element with a token. To get - // the next batch of streams, use this token in your next request. + // If the response is truncated, the call returns this element with a token. To + // get the next batch of streams, use this token in your next request. NextToken *string // An array of StreamInfo objects. diff --git a/service/kinesisvideo/api_op_ListTagsForStream.go b/service/kinesisvideo/api_op_ListTagsForStream.go index 5d4fc3dbd0d..688ea0b3b7a 100644 --- a/service/kinesisvideo/api_op_ListTagsForStream.go +++ b/service/kinesisvideo/api_op_ListTagsForStream.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of tags associated with the specified stream. In the request, you -// must specify either the StreamName or the StreamARN. +// Returns a list of tags associated with the specified stream. In the request, +// you must specify either the StreamName or the StreamARN . func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStreamInput, optFns ...func(*Options)) (*ListTagsForStreamOutput, error) { if params == nil { params = &ListTagsForStreamInput{} diff --git a/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go b/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go index 6d364aac5c5..7f5e246975f 100644 --- a/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go +++ b/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go @@ -19,9 +19,9 @@ import ( // Device. The SyncStatus will be updated as the edge configuration is // acknowledged, and synced with the Edge Agent. If this API is invoked for the // first time, a new edge configuration will be created for the stream, and the -// sync status will be set to SYNCING. You will have to wait for the sync status to -// reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API -// again. If you invoke this API during the syncing process, a +// sync status will be set to SYNCING . You will have to wait for the sync status +// to reach a terminal state such as: IN_SYNC , or SYNC_FAILED , before using this +// API again. If you invoke this API during the syncing process, a // ResourceInUseException will be thrown. The connectivity of the stream’s edge // configuration and the Edge Agent will be retried for 15 minutes. After 15 // minutes, the status will transition into the SYNC_FAILED state. @@ -48,11 +48,11 @@ type StartEdgeConfigurationUpdateInput struct { EdgeConfig *types.EdgeConfig // The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or - // the StreamARN. + // the StreamARN . StreamARN *string // The name of the stream whose edge configuration you want to update. Specify - // either the StreamName or the StreamARN. + // either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde @@ -80,10 +80,9 @@ type StartEdgeConfigurationUpdateOutput struct { // The name of the stream from which the edge configuration was updated. StreamName *string - // The current sync status of the stream's edge configuration. When you invoke this - // API, the sync status will be set to the SYNCING state. Use the - // DescribeEdgeConfiguration API to get the latest status of the edge - // configuration. + // The current sync status of the stream's edge configuration. When you invoke + // this API, the sync status will be set to the SYNCING state. Use the + // DescribeEdgeConfiguration API to get the latest status of the edge configuration. SyncStatus types.SyncStatus // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideo/api_op_TagResource.go b/service/kinesisvideo/api_op_TagResource.go index eddc3f376d2..1ac6cc56959 100644 --- a/service/kinesisvideo/api_op_TagResource.go +++ b/service/kinesisvideo/api_op_TagResource.go @@ -15,8 +15,7 @@ import ( // value is optional) that you can define and assign to Amazon Web Services // resources. If you specify a tag that already exists, the tag value is replaced // with the value that you specify in the request. For more information, see Using -// Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management and Cost Management User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -35,8 +34,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the signaling channel to which you want to add - // tags. + // The Amazon Resource Name (ARN) of the signaling channel to which you want to + // add tags. // // This member is required. ResourceARN *string diff --git a/service/kinesisvideo/api_op_TagStream.go b/service/kinesisvideo/api_op_TagStream.go index 1c40061a0e9..a04241746e9 100644 --- a/service/kinesisvideo/api_op_TagStream.go +++ b/service/kinesisvideo/api_op_TagStream.go @@ -13,11 +13,10 @@ import ( // Adds one or more tags to a stream. A tag is a key-value pair (the value is // optional) that you can define and assign to Amazon Web Services resources. If // you specify a tag that already exists, the tag value is replaced with the value -// that you specify in the request. For more information, see Using Cost Allocation -// Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// that you specify in the request. For more information, see Using Cost +// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management and Cost Management User Guide. You must -// provide either the StreamName or the StreamARN. This operation requires +// provide either the StreamName or the StreamARN . This operation requires // permission for the KinesisVideo:TagStream action. A Kinesis video stream can // support up to 50 tags. func (c *Client) TagStream(ctx context.Context, params *TagStreamInput, optFns ...func(*Options)) (*TagStreamOutput, error) { diff --git a/service/kinesisvideo/api_op_UntagStream.go b/service/kinesisvideo/api_op_UntagStream.go index a2d2ba6e1d1..f2ddb120f0f 100644 --- a/service/kinesisvideo/api_op_UntagStream.go +++ b/service/kinesisvideo/api_op_UntagStream.go @@ -12,7 +12,7 @@ import ( // Removes one or more tags from a stream. In the request, specify only a tag key // or keys; don't specify the value. If you specify a tag key that does not exist, -// it's ignored. In the request, you must provide the StreamName or StreamARN. +// it's ignored. In the request, you must provide the StreamName or StreamARN . func (c *Client) UntagStream(ctx context.Context, params *UntagStreamInput, optFns ...func(*Options)) (*UntagStreamOutput, error) { if params == nil { params = &UntagStreamInput{} diff --git a/service/kinesisvideo/api_op_UpdateDataRetention.go b/service/kinesisvideo/api_op_UpdateDataRetention.go index 021a0bdbc53..914263614ef 100644 --- a/service/kinesisvideo/api_op_UpdateDataRetention.go +++ b/service/kinesisvideo/api_op_UpdateDataRetention.go @@ -13,22 +13,18 @@ import ( // Increases or decreases the stream's data retention period by the value that you // specify. To indicate whether you want to increase or decrease the data retention -// period, specify the Operation parameter in the request body. In the request, you -// must specify either the StreamName or the StreamARN. The retention period that -// you specify replaces the current value. This operation requires permission for -// the KinesisVideo:UpdateDataRetention action. Changing the data retention period -// affects the data in the stream as follows: -// -// * If the data retention period is -// increased, existing data is retained for the new retention period. For example, -// if the data retention period is increased from one hour to seven hours, all -// existing data is retained for seven hours. -// -// * If the data retention period is -// decreased, existing data is retained for the new retention period. For example, -// if the data retention period is decreased from seven hours to one hour, all -// existing data is retained for one hour, and any data older than one hour is -// deleted immediately. +// period, specify the Operation parameter in the request body. In the request, +// you must specify either the StreamName or the StreamARN . The retention period +// that you specify replaces the current value. This operation requires permission +// for the KinesisVideo:UpdateDataRetention action. Changing the data retention +// period affects the data in the stream as follows: +// - If the data retention period is increased, existing data is retained for +// the new retention period. For example, if the data retention period is increased +// from one hour to seven hours, all existing data is retained for seven hours. +// - If the data retention period is decreased, existing data is retained for +// the new retention period. For example, if the data retention period is decreased +// from seven hours to one hour, all existing data is retained for one hour, and +// any data older than one hour is deleted immediately. func (c *Client) UpdateDataRetention(ctx context.Context, params *UpdateDataRetentionInput, optFns ...func(*Options)) (*UpdateDataRetentionOutput, error) { if params == nil { params = &UpdateDataRetentionInput{} diff --git a/service/kinesisvideo/api_op_UpdateImageGenerationConfiguration.go b/service/kinesisvideo/api_op_UpdateImageGenerationConfiguration.go index 363bfd96a94..db11c426db8 100644 --- a/service/kinesisvideo/api_op_UpdateImageGenerationConfiguration.go +++ b/service/kinesisvideo/api_op_UpdateImageGenerationConfiguration.go @@ -36,11 +36,11 @@ type UpdateImageGenerationConfigurationInput struct { // The Amazon Resource Name (ARN) of the Kinesis video stream from where you want // to update the image generation configuration. You must specify either the - // StreamName or the StreamARN. + // StreamName or the StreamARN . StreamARN *string // The name of the stream from which to update the image generation configuration. - // You must specify either the StreamName or the StreamARN. + // You must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go b/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go index 6d476888315..5f84c614994 100644 --- a/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go +++ b/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go @@ -13,12 +13,10 @@ import ( // Associates a SignalingChannel to a stream to store the media. There are two // signaling modes that can specified : -// -// * If the StorageStatus is disabled, no -// data will be stored, and the StreamARN parameter will not be needed. -// -// * If the -// StorageStatus is enabled, the data will be stored in the StreamARN provided. +// - If the StorageStatus is disabled, no data will be stored, and the StreamARN +// parameter will not be needed. +// - If the StorageStatus is enabled, the data will be stored in the StreamARN +// provided. func (c *Client) UpdateMediaStorageConfiguration(ctx context.Context, params *UpdateMediaStorageConfigurationInput, optFns ...func(*Options)) (*UpdateMediaStorageConfigurationOutput, error) { if params == nil { params = &UpdateMediaStorageConfigurationInput{} diff --git a/service/kinesisvideo/api_op_UpdateNotificationConfiguration.go b/service/kinesisvideo/api_op_UpdateNotificationConfiguration.go index 7c09b605a5b..ca123593f3e 100644 --- a/service/kinesisvideo/api_op_UpdateNotificationConfiguration.go +++ b/service/kinesisvideo/api_op_UpdateNotificationConfiguration.go @@ -35,11 +35,11 @@ type UpdateNotificationConfigurationInput struct { // The Amazon Resource Name (ARN) of the Kinesis video stream from where you want // to update the notification configuration. You must specify either the StreamName - // or the StreamARN. + // or the StreamARN . StreamARN *string // The name of the stream from which to update the notification configuration. You - // must specify either the StreamName or the StreamARN. + // must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_UpdateStream.go b/service/kinesisvideo/api_op_UpdateStream.go index 89c336c4f4b..51f64ffe0fb 100644 --- a/service/kinesisvideo/api_op_UpdateStream.go +++ b/service/kinesisvideo/api_op_UpdateStream.go @@ -45,12 +45,11 @@ type UpdateStreamInput struct { // The stream's media type. Use MediaType to specify the type of content that the // stream contains to the consumers of the stream. For more information about media - // types, see Media Types - // (http://www.iana.org/assignments/media-types/media-types.xhtml). If you choose - // to specify the MediaType, see Naming Requirements - // (https://tools.ietf.org/html/rfc6838#section-4.2). To play video on the console, - // you must specify the correct video type. For example, if the video in the stream - // is H.264, specify video/h264 as the MediaType. + // types, see Media Types (http://www.iana.org/assignments/media-types/media-types.xhtml) + // . If you choose to specify the MediaType , see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2) + // . To play video on the console, you must specify the correct video type. For + // example, if the video in the stream is H.264, specify video/h264 as the + // MediaType . MediaType *string // The ARN of the stream whose metadata you want to update. diff --git a/service/kinesisvideo/types/enums.go b/service/kinesisvideo/types/enums.go index 593b6da7be5..304ef82d324 100644 --- a/service/kinesisvideo/types/enums.go +++ b/service/kinesisvideo/types/enums.go @@ -201,9 +201,9 @@ const ( MediaUriTypeFileUri MediaUriType = "FILE_URI" ) -// Values returns all known values for MediaUriType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MediaUriType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MediaUriType) Values() []MediaUriType { return []MediaUriType{ "RTSP_URI", @@ -285,9 +285,10 @@ const ( UpdateDataRetentionOperationDecreaseDataRetention UpdateDataRetentionOperation = "DECREASE_DATA_RETENTION" ) -// Values returns all known values for UpdateDataRetentionOperation. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateDataRetentionOperation. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (UpdateDataRetentionOperation) Values() []UpdateDataRetentionOperation { return []UpdateDataRetentionOperation{ "INCREASE_DATA_RETENTION", diff --git a/service/kinesisvideo/types/errors.go b/service/kinesisvideo/types/errors.go index c41bef4b585..824e25f0e00 100644 --- a/service/kinesisvideo/types/errors.go +++ b/service/kinesisvideo/types/errors.go @@ -278,16 +278,12 @@ func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault { return smithy. // When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped // to a different Kinesis Video Stream resource, or if the provided input StreamARN // or ChannelARN is not in Active status, try one of the following : -// -// * The -// DescribeMediaStorageConfiguration API to determine what the stream given channel -// is mapped to. -// -// * The DescribeMappedResourceConfiguration API to determine the -// channel that the given stream is mapped to. -// -// * The DescribeStream or -// DescribeSignalingChannel API to determine the status of the resource. +// - The DescribeMediaStorageConfiguration API to determine what the stream given +// channel is mapped to. +// - The DescribeMappedResourceConfiguration API to determine the channel that +// the given stream is mapped to. +// - The DescribeStream or DescribeSignalingChannel API to determine the status +// of the resource. type ResourceInUseException struct { Message *string @@ -398,8 +394,7 @@ func (e *TagsPerResourceExceededLimitException) ErrorFault() smithy.ErrorFault { } // The stream version that you specified is not the latest version. To get the -// latest version, use the DescribeStream -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) +// latest version, use the DescribeStream (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) // API. type VersionMismatchException struct { Message *string diff --git a/service/kinesisvideo/types/types.go b/service/kinesisvideo/types/types.go index c24aad3f3c1..c63233c9158 100644 --- a/service/kinesisvideo/types/types.go +++ b/service/kinesisvideo/types/types.go @@ -35,12 +35,12 @@ type ChannelInfo struct { } // An optional input parameter for the ListSignalingChannels API. When this -// parameter is specified while invoking ListSignalingChannels, the API returns -// only the channels that satisfy a condition specified in ChannelNameCondition. +// parameter is specified while invoking ListSignalingChannels , the API returns +// only the channels that satisfy a condition specified in ChannelNameCondition . type ChannelNameCondition struct { - // A comparison operator. Currently, you can only specify the BEGINS_WITH operator, - // which finds signaling channels whose names begin with a given prefix. + // A comparison operator. Currently, you can only specify the BEGINS_WITH + // operator, which finds signaling channels whose names begin with a given prefix. ComparisonOperator ComparisonOperator // A value to compare. @@ -53,13 +53,13 @@ type ChannelNameCondition struct { // the Edge Agent. type DeletionConfig struct { - // The boolean value used to indicate whether or not you want to mark the media for - // deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media - // files can be deleted if any of the deletion configuration values are set to - // true, such as when the limit for the EdgeRetentionInHours, or the - // MaxLocalMediaSizeInMB, has been reached. Since the default value is set to true, - // configure the uploader schedule such that the media files are not being deleted - // before they are initially uploaded to AWS cloud. + // The boolean value used to indicate whether or not you want to mark the media + // for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The + // media files can be deleted if any of the deletion configuration values are set + // to true , such as when the limit for the EdgeRetentionInHours , or the + // MaxLocalMediaSizeInMB , has been reached. Since the default value is set to true + // , configure the uploader schedule such that the media files are not being + // deleted before they are initially uploaded to AWS cloud. DeleteAfterUpload *bool // The number of hours that you want to retain the data in the stream on the Edge @@ -83,20 +83,21 @@ type EdgeConfig struct { // This member is required. HubDeviceArn *string - // The recorder configuration consists of the local MediaSourceConfig details, that - // are used as credentials to access the local media files streamed on the camera. + // The recorder configuration consists of the local MediaSourceConfig details, + // that are used as credentials to access the local media files streamed on the + // camera. // // This member is required. RecorderConfig *RecorderConfig - // The deletion configuration is made up of the retention time - // (EdgeRetentionInHours) and local size configuration (LocalSizeConfig) details + // The deletion configuration is made up of the retention time ( + // EdgeRetentionInHours ) and local size configuration ( LocalSizeConfig ) details // that are used to make the deletion. DeletionConfig *DeletionConfig - // The uploader configuration contains the ScheduleExpression details that are used - // to schedule upload jobs for the recorded media files from the Edge Agent to a - // Kinesis Video Stream. + // The uploader configuration contains the ScheduleExpression details that are + // used to schedule upload jobs for the recorded media files from the Edge Agent to + // a Kinesis Video Stream. UploaderConfig *UploaderConfig noSmithyDocumentSerde @@ -138,8 +139,8 @@ type ImageGenerationConfiguration struct { Status ConfigurationStatus // The list of a key-value pair structure that contains extra parameters that can - // be applied when the image is generated. The FormatConfig key is the JPEGQuality, - // which indicates the JPEG quality key to be used to generate the image. The + // be applied when the image is generated. The FormatConfig key is the JPEGQuality + // , which indicates the JPEG quality key to be used to generate the image. The // FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will // be generated with less quality and the best compression. If the value is 100, // the image will be generated with the best quality and less compression. If no @@ -158,8 +159,8 @@ type ImageGenerationConfiguration struct { // parameter. When both WidthPixels and HeightPixels parameters are provided, the // image will be stretched to fit the specified aspect ratio. If only the // WidthPixels parameter is provided, its original aspect ratio will be used to - // calculate the HeightPixels ratio. If neither parameter is provided, the original - // image size will be returned. + // calculate the HeightPixels ratio. If neither parameter is provided, the + // original image size will be returned. WidthPixels *int32 noSmithyDocumentSerde @@ -184,14 +185,14 @@ type ImageGenerationDestinationConfig struct { noSmithyDocumentSerde } -// The configuration details that include the maximum size of the media -// (MaxLocalMediaSizeInMB) that you want to store for a stream on the Edge Agent, -// as well as the strategy that should be used (StrategyOnFullSize) when a stream's -// maximum size has been reached. +// The configuration details that include the maximum size of the media ( +// MaxLocalMediaSizeInMB ) that you want to store for a stream on the Edge Agent, +// as well as the strategy that should be used ( StrategyOnFullSize ) when a +// stream's maximum size has been reached. type LocalSizeConfig struct { - // The overall maximum size of the media that you want to store for a stream on the - // Edge Agent. + // The overall maximum size of the media that you want to store for a stream on + // the Edge Agent. MaxLocalMediaSizeInMB *int32 // The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached. @@ -214,8 +215,8 @@ type MappedResourceConfigurationListItem struct { noSmithyDocumentSerde } -// The configuration details that consist of the credentials required -// (MediaUriSecretArn and MediaUriType) to access the media files that are streamed +// The configuration details that consist of the credentials required ( +// MediaUriSecretArn and MediaUriType ) to access the media files that are streamed // to the camera. type MediaSourceConfig struct { @@ -285,8 +286,8 @@ type NotificationDestinationConfig struct { // are used as credentials to accesss the local media files streamed on the camera. type RecorderConfig struct { - // The configuration details that consist of the credentials required - // (MediaUriSecretArn and MediaUriType) to access the media files streamed to the + // The configuration details that consist of the credentials required ( + // MediaUriSecretArn and MediaUriType ) to access the media files streamed to the // camera. // // This member is required. @@ -294,8 +295,8 @@ type RecorderConfig struct { // The configuration that consists of the ScheduleExpression and the // DurationInMinutes details that specify the scheduling to record from a camera, - // or local media file, onto the Edge Agent. If the ScheduleExpression attribute is - // not provided, then the Edge Agent will always be set to recording mode. + // or local media file, onto the Edge Agent. If the ScheduleExpression attribute + // is not provided, then the Edge Agent will always be set to recording mode. ScheduleConfig *ScheduleConfig noSmithyDocumentSerde @@ -329,12 +330,11 @@ type ScheduleConfig struct { // This member is required. DurationInSeconds *int32 - // The Quartz cron expression that takes care of scheduling jobs to record from the - // camera, or local media file, onto the Edge Agent. If the ScheduleExpression is - // not provided for the RecorderConfig, then the Edge Agent will always be set to - // recording mode. For more information about Quartz, refer to the Cron Trigger - // Tutorial - // (http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) + // The Quartz cron expression that takes care of scheduling jobs to record from + // the camera, or local media file, onto the Edge Agent. If the ScheduleExpression + // is not provided for the RecorderConfig , then the Edge Agent will always be set + // to recording mode. For more information about Quartz, refer to the Cron Trigger + // Tutorial (http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) // page to understand the valid expressions and its use. // // This member is required. @@ -343,8 +343,8 @@ type ScheduleConfig struct { noSmithyDocumentSerde } -// An object that contains the endpoint configuration for the SINGLE_MASTER channel -// type. +// An object that contains the endpoint configuration for the SINGLE_MASTER +// channel type. type SingleMasterChannelEndpointConfiguration struct { // This property is used to determine the nature of communication over this @@ -413,8 +413,8 @@ type StreamInfo struct { // streams whose names start with a given prefix. type StreamNameCondition struct { - // A comparison operator. Currently, you can specify only the BEGINS_WITH operator, - // which finds streams whose names start with a given prefix. + // A comparison operator. Currently, you can specify only the BEGINS_WITH + // operator, which finds streams whose names start with a given prefix. ComparisonOperator ComparisonOperator // A value to compare. @@ -440,14 +440,14 @@ type Tag struct { } // The configuration that consists of the ScheduleExpression and the -// DurationInMinutesdetails, that specify the scheduling to record from a camera, +// DurationInMinutesdetails , that specify the scheduling to record from a camera, // or local media file, onto the Edge Agent. If the ScheduleExpression is not // provided, then the Edge Agent will always be in upload mode. type UploaderConfig struct { // The configuration that consists of the ScheduleExpression and the - // DurationInMinutesdetails that specify the scheduling to record from a camera, or - // local media file, onto the Edge Agent. If the ScheduleExpression is not + // DurationInMinutes details that specify the scheduling to record from a camera, + // or local media file, onto the Edge Agent. If the ScheduleExpression is not // provided, then the Edge Agent will always be in recording mode. // // This member is required. diff --git a/service/kinesisvideoarchivedmedia/api_client.go b/service/kinesisvideoarchivedmedia/api_client.go index a5217985cef..01d615592ed 100644 --- a/service/kinesisvideoarchivedmedia/api_client.go +++ b/service/kinesisvideoarchivedmedia/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisvideoarchivedmedia/api_op_GetClip.go b/service/kinesisvideoarchivedmedia/api_op_GetClip.go index 4557a22d763..2e500d44e03 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetClip.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetClip.go @@ -16,40 +16,32 @@ import ( // specified video stream over the specified time range. Both the StreamName and // the StreamARN parameters are optional, but you must specify either the // StreamName or the StreamARN when invoking this API operation. As a prerequisite -// to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, +// to using GetCLip API, you must obtain an endpoint using GetDataEndpoint , // specifying GET_CLIP for the APIName parameter. An Amazon Kinesis video stream // has the following requirements for providing data through MP4: +// - The media must contain h.264 or h.265 encoded video and, optionally, AAC or +// G.711 encoded audio. Specifically, the codec ID of track 1 should be +// V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the +// codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711). +// - Data retention must be greater than 0. +// - The video track of each fragment must contain codec private data in the +// Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more +// information, see MPEG-4 specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html) +// . For information about adapting stream data to a given format, see NAL +// Adaptation Flags (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html) +// . +// - The audio track (if present) of each fragment must contain codec private +// data in the AAC format ( AAC specification ISO/IEC 13818-7 (https://www.iso.org/standard/43345.html) +// ) or the MS Wave format (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html) +// . // -// * The media must -// contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded -// audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for -// h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 -// should be A_AAC (for AAC) or A_MS/ACM (for G.711). -// -// * Data retention must be -// greater than 0. -// -// * The video track of each fragment must contain codec private -// data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 -// format. For more information, see MPEG-4 specification ISO/IEC 14496-15 -// (https://www.iso.org/standard/55980.html). For information about adapting stream -// data to a given format, see NAL Adaptation Flags -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html). -// -// * -// The audio track (if present) of each fragment must contain codec private data in -// the AAC format (AAC specification ISO/IEC 13818-7 -// (https://www.iso.org/standard/43345.html)) or the MS Wave format -// (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html). -// -// You can -// monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes -// Amazon CloudWatch metric. For information about using CloudWatch to monitor -// Kinesis Video Streams, see Monitoring Kinesis Video Streams -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For -// pricing information, see Amazon Kinesis Video Streams Pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/) and AWS Pricing -// (https://aws.amazon.com/pricing/). Charges for outgoing AWS data apply. +// You can monitor the amount of outgoing data by monitoring the +// GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using +// CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video +// Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html) +// . For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// and AWS Pricing (https://aws.amazon.com/pricing/) . Charges for outgoing AWS +// data apply. func (c *Client) GetClip(ctx context.Context, params *GetClipInput, optFns ...func(*Options)) (*GetClipOutput, error) { if params == nil { params = &GetClipInput{} @@ -91,7 +83,7 @@ type GetClipOutput struct { // Traditional MP4 file that contains the media clip from the specified video // stream. The output will contain the first 100 MB or the first 200 fragments from // the specified start timestamp. For more information, see Kinesis Video Streams - // Limits (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). + // Limits (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) . Payload io.ReadCloser // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go b/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go index 4ef7573e05d..1779ebeb424 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go @@ -14,122 +14,93 @@ import ( // Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the // stream. You can then open the URL in a media player to view the stream contents. // Both the StreamName and the StreamARN parameters are optional, but you must -// specify either the StreamName or the StreamARN when invoking this API operation. -// An Amazon Kinesis video stream has the following requirements for providing data -// through MPEG-DASH: +// specify either the StreamName or the StreamARN when invoking this API +// operation. An Amazon Kinesis video stream has the following requirements for +// providing data through MPEG-DASH: +// - The media must contain h.264 or h.265 encoded video and, optionally, AAC or +// G.711 encoded audio. Specifically, the codec ID of track 1 should be +// V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the +// codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711). +// - Data retention must be greater than 0. +// - The video track of each fragment must contain codec private data in the +// Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more +// information, see MPEG-4 specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html) +// . For information about adapting stream data to a given format, see NAL +// Adaptation Flags (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html) +// . +// - The audio track (if present) of each fragment must contain codec private +// data in the AAC format ( AAC specification ISO/IEC 13818-7 (https://www.iso.org/standard/43345.html) +// ) or the MS Wave format (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html) +// . // -// * The media must contain h.264 or h.265 encoded video and, -// optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 -// should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). -// Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for -// G.711). +// The following procedure shows how to use MPEG-DASH with Kinesis Video Streams: +// - Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html) +// , specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter. +// - Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL . Kinesis Video +// Streams creates an MPEG-DASH streaming session to be used for accessing content +// in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns +// an authenticated URL (that includes an encrypted session token) for the +// session's MPEG-DASH manifest (the root resource needed for streaming with +// MPEG-DASH). Don't share or store this token where an unauthorized entity can +// access it. The token provides access to the content of the stream. Safeguard the +// token with the same measures that you use with your AWS credentials. The media +// that is made available through the manifest consists only of the requested +// stream, time range, and format. No other media data (such as frames outside the +// requested window or alternate bitrates) is made available. +// - Provide the URL (containing the encrypted session token) for the MPEG-DASH +// manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video +// Streams makes the initialization fragment and media fragments available through +// the manifest URL. The initialization fragment contains the codec private data +// for the stream, and other data needed to set up the video or audio decoder and +// renderer. The media fragments contain encoded video frames or encoded audio +// samples. +// - The media player receives the authenticated URL and requests stream +// metadata and media data normally. When the media player requests data, it calls +// the following actions: +// - GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the +// metadata for the media that you want to playback. +// - GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media +// player typically loads the initialization fragment before loading any media +// fragments. This fragment contains the " fytp " and " moov " MP4 atoms, and the +// child atoms that are needed to initialize the media player decoder. The +// initialization fragment does not correspond to a fragment in a Kinesis video +// stream. It contains only the codec private data for the stream and respective +// track, which the media player needs to decode the media frames. +// - GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain +// the " moof " and " mdat " MP4 atoms and their child atoms, containing the +// encoded fragment's media frames and their timestamps. After the first media +// fragment is made available in a streaming session, any fragments that don't +// contain the same codec private data cause an error to be returned when those +// different media fragments are loaded. Therefore, the codec private data should +// not change between fragments in a session. This also means that the session +// fails if the fragments in a stream change from having only video to having both +// audio and video. Data retrieved with this action is billable. See Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// for details. // -// * Data retention must be greater than 0. -// -// * The video track of each -// fragment must contain codec private data in the Advanced Video Coding (AVC) for -// H.264 format and HEVC for H.265 format. For more information, see MPEG-4 -// specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html). For -// information about adapting stream data to a given format, see NAL Adaptation -// Flags -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html). -// -// * -// The audio track (if present) of each fragment must contain codec private data in -// the AAC format (AAC specification ISO/IEC 13818-7 -// (https://www.iso.org/standard/43345.html)) or the MS Wave format -// (http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html). -// -// The -// following procedure shows how to use MPEG-DASH with Kinesis Video Streams: -// -// * -// Get an endpoint using GetDataEndpoint -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), -// specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter. -// -// * Retrieve -// the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams -// creates an MPEG-DASH streaming session to be used for accessing content in a -// stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an -// authenticated URL (that includes an encrypted session token) for the session's -// MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH). -// Don't share or store this token where an unauthorized entity can access it. The -// token provides access to the content of the stream. Safeguard the token with the -// same measures that you use with your AWS credentials. The media that is made -// available through the manifest consists only of the requested stream, time -// range, and format. No other media data (such as frames outside the requested -// window or alternate bitrates) is made available. -// -// * Provide the URL (containing -// the encrypted session token) for the MPEG-DASH manifest to a media player that -// supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization -// fragment and media fragments available through the manifest URL. The -// initialization fragment contains the codec private data for the stream, and -// other data needed to set up the video or audio decoder and renderer. The media -// fragments contain encoded video frames or encoded audio samples. -// -// * The media -// player receives the authenticated URL and requests stream metadata and media -// data normally. When the media player requests data, it calls the following -// actions: -// -// * GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the -// metadata for the media that you want to playback. -// -// * GetMP4InitFragment: -// Retrieves the MP4 initialization fragment. The media player typically loads the -// initialization fragment before loading any media fragments. This fragment -// contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to -// initialize the media player decoder. The initialization fragment does not -// correspond to a fragment in a Kinesis video stream. It contains only the codec -// private data for the stream and respective track, which the media player needs -// to decode the media frames. -// -// * GetMP4MediaFragment: Retrieves MP4 media -// fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their -// child atoms, containing the encoded fragment's media frames and their -// timestamps. After the first media fragment is made available in a streaming -// session, any fragments that don't contain the same codec private data cause an -// error to be returned when those different media fragments are loaded. Therefore, -// the codec private data should not change between fragments in a session. This -// also means that the session fails if the fragments in a stream change from -// having only video to having both audio and video. Data retrieved with this -// action is billable. See Pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/) for details. -// -// For -// restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). You can -// monitor the amount of data that the media player consumes by monitoring the -// GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information +// For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams +// Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) . +// You can monitor the amount of data that the media player consumes by monitoring +// the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information // about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis -// Video Streams -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For -// pricing information, see Amazon Kinesis Video Streams Pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/) and AWS Pricing -// (https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing -// AWS data apply. For more information about HLS, see HTTP Live Streaming -// (https://developer.apple.com/streaming/) on the Apple Developer site -// (https://developer.apple.com). If an error is thrown after invoking a Kinesis -// Video Streams archived media API, in addition to the HTTP status code and the -// response body, it includes the following pieces of information: -// -// * -// x-amz-ErrorType HTTP header – contains a more specific error type in addition to -// what the HTTP status code provides. -// -// * x-amz-RequestId HTTP header – if you want -// to report an issue to AWS, the support team can better diagnose the problem if -// given the Request Id. +// Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html) +// . For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// and AWS Pricing (https://aws.amazon.com/pricing/) . Charges for both HLS +// sessions and outgoing AWS data apply. For more information about HLS, see HTTP +// Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer +// site (https://developer.apple.com) . If an error is thrown after invoking a +// Kinesis Video Streams archived media API, in addition to the HTTP status code +// and the response body, it includes the following pieces of information: +// - x-amz-ErrorType HTTP header – contains a more specific error type in +// addition to what the HTTP status code provides. +// - x-amz-RequestId HTTP header – if you want to report an issue to AWS, the +// support team can better diagnose the problem if given the Request Id. // -// Both the HTTP status code and the ErrorType header can be -// utilized to make programmatic decisions about whether errors are retry-able and -// under what conditions, as well as provide information on what actions the client -// programmer might need to take in order to successfully try again. For more -// information, see the Errors section at the bottom of this topic, as well as -// Common Errors -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). +// Both the HTTP status code and the ErrorType header can be utilized to make +// programmatic decisions about whether errors are retry-able and under what +// conditions, as well as provide information on what actions the client programmer +// might need to take in order to successfully try again. For more information, see +// the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html) +// . func (c *Client) GetDASHStreamingSessionURL(ctx context.Context, params *GetDASHStreamingSessionURLInput, optFns ...func(*Options)) (*GetDASHStreamingSessionURLOutput, error) { if params == nil { params = &GetDASHStreamingSessionURLInput{} @@ -148,20 +119,20 @@ func (c *Client) GetDASHStreamingSessionURL(ctx context.Context, params *GetDASH type GetDASHStreamingSessionURLInput struct { // The time range of the requested fragment and the source of the timestamps. This - // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This - // parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the + // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY . This + // parameter is optional if PlaybackMode is LIVE . If PlaybackMode is LIVE , the // FragmentSelectorType can be set, but the TimestampRange should not be set. If - // PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and + // PlaybackMode is ON_DEMAND or LIVE_REPLAY , both FragmentSelectorType and // TimestampRange must be set. DASHFragmentSelector *types.DASHFragmentSelector // Fragments are identified in the manifest file based on their sequence number in - // the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video + // the session. If DisplayFragmentNumber is set to ALWAYS , the Kinesis Video // Streams fragment number is added to each S element in the manifest file with the // attribute name “kvs:fn”. These fragment numbers can be used for logging or for - // use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom + // use with other APIs (e.g. GetMedia and GetMediaForFragmentList ). A custom // MPEG-DASH media player is necessary to leverage these this custom attribute. The - // default value is NEVER. + // default value is NEVER . DisplayFragmentNumber types.DASHDisplayFragmentNumber // Per the MPEG-DASH specification, the wall-clock time of fragments in the @@ -170,88 +141,82 @@ type GetDASHStreamingSessionURLInput struct { // media timeline. Kinesis Video Streams adjusts the media timeline in the manifest // file to enable playback of media with discontinuities. Therefore, the wall-clock // time derived from the manifest file may be inaccurate. If - // DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is + // DisplayFragmentTimestamp is set to ALWAYS , the accurate fragment timestamp is // added to each S element in the manifest file with the attribute name “kvs:ts”. A // custom MPEG-DASH media player is necessary to leverage this custom attribute. - // The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP, the + // The default value is NEVER . When DASHFragmentSelector is SERVER_TIMESTAMP , the // timestamps will be the server start timestamps. Similarly, when - // DASHFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer + // DASHFragmentSelector is PRODUCER_TIMESTAMP , the timestamps will be the producer // start timestamps. DisplayFragmentTimestamp types.DASHDisplayFragmentTimestamp // The time in seconds until the requested session expires. This value can be // between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new - // calls to GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made - // for that session. The default is 300 (5 minutes). + // calls to GetDashManifest , GetMP4InitFragment , or GetMP4MediaFragment can be + // made for that session. The default is 300 (5 minutes). Expires *int32 // The maximum number of fragments that are returned in the MPEG-DASH manifest. - // When the PlaybackMode is LIVE, the most recent fragments are returned up to this - // value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up - // to this maximum number. When there are a higher number of fragments available in - // a live MPEG-DASH manifest, video players often buffer content before starting - // playback. Increasing the buffer size increases the playback latency, but it - // decreases the likelihood that rebuffering will occur during playback. We - // recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a - // maximum of 10 fragments. The default is 5 fragments if PlaybackMode is LIVE or - // LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND. The maximum value of 1,000 - // fragments corresponds to more than 16 minutes of video on streams with 1-second - // fragments, and more than 2 1/2 hours of video on streams with 10-second - // fragments. + // When the PlaybackMode is LIVE , the most recent fragments are returned up to + // this value. When the PlaybackMode is ON_DEMAND , the oldest fragments are + // returned, up to this maximum number. When there are a higher number of fragments + // available in a live MPEG-DASH manifest, video players often buffer content + // before starting playback. Increasing the buffer size increases the playback + // latency, but it decreases the likelihood that rebuffering will occur during + // playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 + // fragments and a maximum of 10 fragments. The default is 5 fragments if + // PlaybackMode is LIVE or LIVE_REPLAY , and 1,000 if PlaybackMode is ON_DEMAND . + // The maximum value of 1,000 fragments corresponds to more than 16 minutes of + // video on streams with 1-second fragments, and more than 2 1/2 hours of video on + // streams with 10-second fragments. MaxManifestFragmentResults *int64 // Whether to retrieve live, live replay, or archived, on-demand data. Features of // the three types of sessions include the following: - // - // * LIVE : For sessions of - // this type, the MPEG-DASH manifest is continually updated with the latest - // fragments as they become available. We recommend that the media player retrieve - // a new manifest on a one-second interval. When this type of session is played in - // a media player, the user interface typically displays a "live" notification, - // with no scrubber control for choosing the position in the playback window to - // display. In LIVE mode, the newest available fragments are included in an - // MPEG-DASH manifest, even if there is a gap between fragments (that is, if a - // fragment is missing). A gap like this might cause a media player to halt or - // cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH - // manifest if they are older than the newest fragment in the playlist. If the - // missing fragment becomes available after a subsequent fragment is added to the - // manifest, the older fragment is not added, and the gap is not filled. - // - // * - // LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated - // similarly to how it is updated for LIVE mode except that it starts by including - // fragments from a given start time. Instead of fragments being added as they are - // ingested, fragments are added as the duration of the next fragment elapses. For - // example, if the fragments in the session are two seconds long, then a new - // fragment is added to the manifest every two seconds. This mode is useful to be - // able to start playback from when an event is detected and continue live - // streaming media that has not yet been ingested as of the time of the session - // creation. This mode is also useful to stream previously archived media without - // being limited by the 1,000 fragment limit in the ON_DEMAND mode. - // - // * ON_DEMAND : - // For sessions of this type, the MPEG-DASH manifest contains all the fragments for - // the session, up to the number that is specified in MaxManifestFragmentResults. - // The manifest must be retrieved only once for each session. When this type of - // session is played in a media player, the user interface typically displays a - // scrubber control for choosing the position in the playback window to - // display. - // - // In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, - // and if there are multiple fragments with the same start timestamp, the fragment - // that has the larger fragment number (that is, the newer fragment) is included in - // the MPEG-DASH manifest. The other fragments are not included. Fragments that - // have different timestamps but have overlapping durations are still included in - // the MPEG-DASH manifest. This can lead to unexpected behavior in the media - // player. The default is LIVE. + // - LIVE : For sessions of this type, the MPEG-DASH manifest is continually + // updated with the latest fragments as they become available. We recommend that + // the media player retrieve a new manifest on a one-second interval. When this + // type of session is played in a media player, the user interface typically + // displays a "live" notification, with no scrubber control for choosing the + // position in the playback window to display. In LIVE mode, the newest available + // fragments are included in an MPEG-DASH manifest, even if there is a gap between + // fragments (that is, if a fragment is missing). A gap like this might cause a + // media player to halt or cause a jump in playback. In this mode, fragments are + // not added to the MPEG-DASH manifest if they are older than the newest fragment + // in the playlist. If the missing fragment becomes available after a subsequent + // fragment is added to the manifest, the older fragment is not added, and the gap + // is not filled. + // - LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated + // similarly to how it is updated for LIVE mode except that it starts by + // including fragments from a given start time. Instead of fragments being added as + // they are ingested, fragments are added as the duration of the next fragment + // elapses. For example, if the fragments in the session are two seconds long, then + // a new fragment is added to the manifest every two seconds. This mode is useful + // to be able to start playback from when an event is detected and continue live + // streaming media that has not yet been ingested as of the time of the session + // creation. This mode is also useful to stream previously archived media without + // being limited by the 1,000 fragment limit in the ON_DEMAND mode. + // - ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all + // the fragments for the session, up to the number that is specified in + // MaxManifestFragmentResults . The manifest must be retrieved only once for each + // session. When this type of session is played in a media player, the user + // interface typically displays a scrubber control for choosing the position in the + // playback window to display. + // In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP , and if + // there are multiple fragments with the same start timestamp, the fragment that + // has the larger fragment number (that is, the newer fragment) is included in the + // MPEG-DASH manifest. The other fragments are not included. Fragments that have + // different timestamps but have overlapping durations are still included in the + // MPEG-DASH manifest. This can lead to unexpected behavior in the media player. + // The default is LIVE . PlaybackMode types.DASHPlaybackMode - // The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH - // manifest URL. You must specify either the StreamName or the StreamARN. + // The Amazon Resource Name (ARN) of the stream for which to retrieve the + // MPEG-DASH manifest URL. You must specify either the StreamName or the StreamARN . StreamARN *string // The name of the stream for which to retrieve the MPEG-DASH manifest URL. You - // must specify either the StreamName or the StreamARN. + // must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go b/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go index d6a1c9e511d..df019691af7 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go @@ -11,149 +11,117 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the -// URL in a browser or media player to view the stream contents. Both the +// Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open +// the URL in a browser or media player to view the stream contents. Both the // StreamName and the StreamARN parameters are optional, but you must specify // either the StreamName or the StreamARN when invoking this API operation. An // Amazon Kinesis video stream has the following requirements for providing data // through HLS: +// - The media must contain h.264 or h.265 encoded video and, optionally, AAC +// encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC +// (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec ID of track +// 2 should be A_AAC . +// - Data retention must be greater than 0. +// - The video track of each fragment must contain codec private data in the +// Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format ( MPEG-4 +// specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html) ). +// For information about adapting stream data to a given format, see NAL +// Adaptation Flags (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html) +// . +// - The audio track (if present) of each fragment must contain codec private +// data in the AAC format ( AAC specification ISO/IEC 13818-7 (https://www.iso.org/standard/43345.html) +// ). // -// * The media must contain h.264 or h.265 encoded video and, -// optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be -// V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec -// ID of track 2 should be A_AAC. +// Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 +// form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which +// the HLS specification also supports). For more information about HLS fragment +// types, see the HLS specification (https://tools.ietf.org/html/draft-pantos-http-live-streaming-23) +// . The following procedure shows how to use HLS with Kinesis Video Streams: +// - Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html) +// , specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. +// - Retrieve the HLS URL using GetHLSStreamingSessionURL . Kinesis Video Streams +// creates an HLS streaming session to be used for accessing content in a stream +// using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL +// (that includes an encrypted session token) for the session's HLS master playlist +// (the root resource needed for streaming with HLS). Don't share or store this +// token where an unauthorized entity could access it. The token provides access to +// the content of the stream. Safeguard the token with the same measures that you +// would use with your AWS credentials. The media that is made available through +// the playlist consists only of the requested stream, time range, and format. No +// other media data (such as frames outside the requested window or alternate +// bitrates) is made available. +// - Provide the URL (containing the encrypted session token) for the HLS master +// playlist to a media player that supports the HLS protocol. Kinesis Video Streams +// makes the HLS media playlist, initialization fragment, and media fragments +// available through the master playlist URL. The initialization fragment contains +// the codec private data for the stream, and other data needed to set up the video +// or audio decoder and renderer. The media fragments contain H.264-encoded video +// frames or AAC-encoded audio samples. +// - The media player receives the authenticated URL and requests stream +// metadata and media data normally. When the media player requests data, it calls +// the following actions: +// - GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a +// URL for the GetHLSMediaPlaylist action for each track, and additional metadata +// for the media player, including estimated bitrate and resolution. +// - GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL +// to access the MP4 initialization fragment with the GetMP4InitFragment action, +// and URLs to access the MP4 media fragments with the GetMP4MediaFragment +// actions. The HLS media playlist also contains metadata about the stream that the +// player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND +// . The HLS media playlist is typically static for sessions with a PlaybackType +// of ON_DEMAND . The HLS media playlist is continually updated with new +// fragments for sessions with a PlaybackType of LIVE . There is a distinct HLS +// media playlist for the video track and the audio track (if applicable) that +// contains MP4 media URLs for the specific track. +// - GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media +// player typically loads the initialization fragment before loading any media +// fragments. This fragment contains the " fytp " and " moov " MP4 atoms, and the +// child atoms that are needed to initialize the media player decoder. The +// initialization fragment does not correspond to a fragment in a Kinesis video +// stream. It contains only the codec private data for the stream and respective +// track, which the media player needs to decode the media frames. +// - GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain +// the " moof " and " mdat " MP4 atoms and their child atoms, containing the +// encoded fragment's media frames and their timestamps. After the first media +// fragment is made available in a streaming session, any fragments that don't +// contain the same codec private data cause an error to be returned when those +// different media fragments are loaded. Therefore, the codec private data should +// not change between fragments in a session. This also means that the session +// fails if the fragments in a stream change from having only video to having both +// audio and video. Data retrieved with this action is billable. See Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// for details. +// - GetTSFragment: Retrieves MPEG TS fragments containing both initialization +// and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS +// , this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to +// retrieve stream media. Data retrieved with this action is billable. For more +// information, see Kinesis Video Streams pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// . // -// * Data retention must be greater than 0. +// A streaming session URL must not be shared between players. The service might +// throttle a session if multiple media players are sharing it. For connection +// limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) +// . You can monitor the amount of data that the media player consumes by +// monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For +// information about using CloudWatch to monitor Kinesis Video Streams, see +// Monitoring Kinesis Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html) +// . For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) +// and AWS Pricing (https://aws.amazon.com/pricing/) . Charges for both HLS +// sessions and outgoing AWS data apply. For more information about HLS, see HTTP +// Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer +// site (https://developer.apple.com) . If an error is thrown after invoking a +// Kinesis Video Streams archived media API, in addition to the HTTP status code +// and the response body, it includes the following pieces of information: +// - x-amz-ErrorType HTTP header – contains a more specific error type in +// addition to what the HTTP status code provides. +// - x-amz-RequestId HTTP header – if you want to report an issue to AWS, the +// support team can better diagnose the problem if given the Request Id. // -// * The -// video track of each fragment must contain codec private data in the Advanced -// Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 -// specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html)). For -// information about adapting stream data to a given format, see NAL Adaptation -// Flags -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html). -// -// * -// The audio track (if present) of each fragment must contain codec private data in -// the AAC format (AAC specification ISO/IEC 13818-7 -// (https://www.iso.org/standard/43345.html)). -// -// Kinesis Video Streams HLS sessions -// contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or -// the MPEG-2 form (also called TS chunks, which the HLS specification also -// supports). For more information about HLS fragment types, see the HLS -// specification (https://tools.ietf.org/html/draft-pantos-http-live-streaming-23). -// The following procedure shows how to use HLS with Kinesis Video Streams: -// -// * Get -// an endpoint using GetDataEndpoint -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), -// specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. -// -// * Retrieve -// the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an -// HLS streaming session to be used for accessing content in a stream using the HLS -// protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes -// an encrypted session token) for the session's HLS master playlist (the root -// resource needed for streaming with HLS). Don't share or store this token where -// an unauthorized entity could access it. The token provides access to the content -// of the stream. Safeguard the token with the same measures that you would use -// with your AWS credentials. The media that is made available through the playlist -// consists only of the requested stream, time range, and format. No other media -// data (such as frames outside the requested window or alternate bitrates) is made -// available. -// -// * Provide the URL (containing the encrypted session token) for the -// HLS master playlist to a media player that supports the HLS protocol. Kinesis -// Video Streams makes the HLS media playlist, initialization fragment, and media -// fragments available through the master playlist URL. The initialization fragment -// contains the codec private data for the stream, and other data needed to set up -// the video or audio decoder and renderer. The media fragments contain -// H.264-encoded video frames or AAC-encoded audio samples. -// -// * The media player -// receives the authenticated URL and requests stream metadata and media data -// normally. When the media player requests data, it calls the following -// actions: -// -// * GetHLSMasterPlaylist: Retrieves an HLS master playlist, which -// contains a URL for the GetHLSMediaPlaylist action for each track, and additional -// metadata for the media player, including estimated bitrate and resolution. -// -// * -// GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to -// access the MP4 initialization fragment with the GetMP4InitFragment action, and -// URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The -// HLS media playlist also contains metadata about the stream that the player needs -// to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media -// playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The -// HLS media playlist is continually updated with new fragments for sessions with a -// PlaybackType of LIVE. There is a distinct HLS media playlist for the video track -// and the audio track (if applicable) that contains MP4 media URLs for the -// specific track. -// -// * GetMP4InitFragment: Retrieves the MP4 initialization -// fragment. The media player typically loads the initialization fragment before -// loading any media fragments. This fragment contains the "fytp" and "moov" MP4 -// atoms, and the child atoms that are needed to initialize the media player -// decoder. The initialization fragment does not correspond to a fragment in a -// Kinesis video stream. It contains only the codec private data for the stream and -// respective track, which the media player needs to decode the media frames. -// -// * -// GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the -// "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded -// fragment's media frames and their timestamps. After the first media fragment is -// made available in a streaming session, any fragments that don't contain the same -// codec private data cause an error to be returned when those different media -// fragments are loaded. Therefore, the codec private data should not change -// between fragments in a session. This also means that the session fails if the -// fragments in a stream change from having only video to having both audio and -// video. Data retrieved with this action is billable. See Pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/) for details. -// -// * -// GetTSFragment: Retrieves MPEG TS fragments containing both initialization and -// media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this -// API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve -// stream media. Data retrieved with this action is billable. For more information, -// see Kinesis Video Streams pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/). -// -// A streaming session -// URL must not be shared between players. The service might throttle a session if -// multiple media players are sharing it. For connection limits, see Kinesis Video -// Streams Limits -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). You can -// monitor the amount of data that the media player consumes by monitoring the -// GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information -// about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis -// Video Streams -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For -// pricing information, see Amazon Kinesis Video Streams Pricing -// (https://aws.amazon.com/kinesis/video-streams/pricing/) and AWS Pricing -// (https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing -// AWS data apply. For more information about HLS, see HTTP Live Streaming -// (https://developer.apple.com/streaming/) on the Apple Developer site -// (https://developer.apple.com). If an error is thrown after invoking a Kinesis -// Video Streams archived media API, in addition to the HTTP status code and the -// response body, it includes the following pieces of information: -// -// * -// x-amz-ErrorType HTTP header – contains a more specific error type in addition to -// what the HTTP status code provides. -// -// * x-amz-RequestId HTTP header – if you want -// to report an issue to AWS, the support team can better diagnose the problem if -// given the Request Id. -// -// Both the HTTP status code and the ErrorType header can be -// utilized to make programmatic decisions about whether errors are retry-able and -// under what conditions, as well as provide information on what actions the client -// programmer might need to take in order to successfully try again. For more -// information, see the Errors section at the bottom of this topic, as well as -// Common Errors -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). +// Both the HTTP status code and the ErrorType header can be utilized to make +// programmatic decisions about whether errors are retry-able and under what +// conditions, as well as provide information on what actions the client programmer +// might need to take in order to successfully try again. For more information, see +// the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html) +// . func (c *Client) GetHLSStreamingSessionURL(ctx context.Context, params *GetHLSStreamingSessionURLInput, optFns ...func(*Options)) (*GetHLSStreamingSessionURLOutput, error) { if params == nil { params = &GetHLSStreamingSessionURLInput{} @@ -174,137 +142,127 @@ type GetHLSStreamingSessionURLInput struct { // Specifies which format should be used for packaging the media. Specifying the // FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or // CMAF). This is the recommended packaging because there is minimal packaging - // overhead. The other container format option is MPEG_TS. HLS has supported MPEG + // overhead. The other container format option is MPEG_TS . HLS has supported MPEG // TS chunks since it was released and is sometimes the only supported packaging on // older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This // means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4. - // The default is FRAGMENTED_MP4. + // The default is FRAGMENTED_MP4 . ContainerFormat types.ContainerFormat // Specifies when flags marking discontinuities between fragments are added to the // media playlists. Media players typically build a timeline of media content to // play, based on the timestamps of each fragment. This means that if there is any - // overlap or gap between fragments (as is typical if HLSFragmentSelector is set to - // SERVER_TIMESTAMP), the media player timeline will also have small gaps between - // fragments in some places, and will overwrite frames in other places. Gaps in the - // media player timeline can cause playback to stall and overlaps can cause - // playback to be jittery. When there are discontinuity flags between fragments, - // the media player is expected to reset the timeline, resulting in the next - // fragment being played immediately after the previous fragment. The following - // modes are supported: - // - // * ALWAYS: a discontinuity marker is placed between every - // fragment in the HLS media playlist. It is recommended to use a value of ALWAYS - // if the fragment timestamps are not accurate. - // - // * NEVER: no discontinuity markers - // are placed anywhere. It is recommended to use a value of NEVER to ensure the - // media player timeline most accurately maps to the producer timestamps. - // - // * - // ON_DISCONTINUITY: a discontinuity marker is placed between fragments that have a - // gap or overlap of more than 50 milliseconds. For most playback scenarios, it is - // recommended to use a value of ON_DISCONTINUITY so that the media player timeline - // is only reset when there is a significant issue with the media timeline (e.g. a - // missing fragment). - // - // The default is ALWAYS when HLSFragmentSelector is set to - // SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP. + // overlap or gap between fragments (as is typical if HLSFragmentSelector is set + // to SERVER_TIMESTAMP ), the media player timeline will also have small gaps + // between fragments in some places, and will overwrite frames in other places. + // Gaps in the media player timeline can cause playback to stall and overlaps can + // cause playback to be jittery. When there are discontinuity flags between + // fragments, the media player is expected to reset the timeline, resulting in the + // next fragment being played immediately after the previous fragment. The + // following modes are supported: + // - ALWAYS : a discontinuity marker is placed between every fragment in the HLS + // media playlist. It is recommended to use a value of ALWAYS if the fragment + // timestamps are not accurate. + // - NEVER : no discontinuity markers are placed anywhere. It is recommended to + // use a value of NEVER to ensure the media player timeline most accurately maps + // to the producer timestamps. + // - ON_DISCONTINUITY : a discontinuity marker is placed between fragments that + // have a gap or overlap of more than 50 milliseconds. For most playback scenarios, + // it is recommended to use a value of ON_DISCONTINUITY so that the media player + // timeline is only reset when there is a significant issue with the media timeline + // (e.g. a missing fragment). + // The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP , and + // NEVER when it is set to PRODUCER_TIMESTAMP . DiscontinuityMode types.HLSDiscontinuityMode - // Specifies when the fragment start timestamps should be included in the HLS media - // playlist. Typically, media players report the playhead position as a time + // Specifies when the fragment start timestamps should be included in the HLS + // media playlist. Typically, media players report the playhead position as a time // relative to the start of the first fragment in the playback session. However, // when the start timestamps are included in the HLS media playlist, some media // players might report the current playhead as an absolute time based on the // fragment timestamps. This can be useful for creating a playback experience that - // shows viewers the wall-clock time of the media. The default is NEVER. When - // HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start - // timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the - // timestamps will be the producer start timestamps. + // shows viewers the wall-clock time of the media. The default is NEVER . When + // HLSFragmentSelector is SERVER_TIMESTAMP , the timestamps will be the server + // start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP , + // the timestamps will be the producer start timestamps. DisplayFragmentTimestamp types.HLSDisplayFragmentTimestamp // The time in seconds until the requested session expires. This value can be // between 300 (5 minutes) and 43200 (12 hours). When a session expires, no new - // calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, - // GetMP4MediaFragment, or GetTSFragment can be made for that session. The default - // is 300 (5 minutes). + // calls to GetHLSMasterPlaylist , GetHLSMediaPlaylist , GetMP4InitFragment , + // GetMP4MediaFragment , or GetTSFragment can be made for that session. The + // default is 300 (5 minutes). Expires *int32 // The time range of the requested fragment and the source of the timestamps. This - // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This - // parameter is optional if PlaybackMode isLIVE. If PlaybackMode is LIVE, the + // parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY . This + // parameter is optional if PlaybackMode is LIVE . If PlaybackMode is LIVE , the // FragmentSelectorType can be set, but the TimestampRange should not be set. If - // PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and + // PlaybackMode is ON_DEMAND or LIVE_REPLAY , both FragmentSelectorType and // TimestampRange must be set. HLSFragmentSelector *types.HLSFragmentSelector // The maximum number of fragments that are returned in the HLS media playlists. - // When the PlaybackMode is LIVE, the most recent fragments are returned up to this - // value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up - // to this maximum number. When there are a higher number of fragments available in - // a live HLS media playlist, video players often buffer content before starting - // playback. Increasing the buffer size increases the playback latency, but it - // decreases the likelihood that rebuffering will occur during playback. We - // recommend that a live HLS media playlist have a minimum of 3 fragments and a - // maximum of 10 fragments. The default is 5 fragments if PlaybackMode is LIVE or - // LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND. The maximum value of 5,000 - // fragments corresponds to more than 80 minutes of video on streams with 1-second - // fragments, and more than 13 hours of video on streams with 10-second fragments. + // When the PlaybackMode is LIVE , the most recent fragments are returned up to + // this value. When the PlaybackMode is ON_DEMAND , the oldest fragments are + // returned, up to this maximum number. When there are a higher number of fragments + // available in a live HLS media playlist, video players often buffer content + // before starting playback. Increasing the buffer size increases the playback + // latency, but it decreases the likelihood that rebuffering will occur during + // playback. We recommend that a live HLS media playlist have a minimum of 3 + // fragments and a maximum of 10 fragments. The default is 5 fragments if + // PlaybackMode is LIVE or LIVE_REPLAY , and 1,000 if PlaybackMode is ON_DEMAND . + // The maximum value of 5,000 fragments corresponds to more than 80 minutes of + // video on streams with 1-second fragments, and more than 13 hours of video on + // streams with 10-second fragments. MaxMediaPlaylistFragmentResults *int64 // Whether to retrieve live, live replay, or archived, on-demand data. Features of // the three types of sessions include the following: - // - // * LIVE : For sessions of - // this type, the HLS media playlist is continually updated with the latest - // fragments as they become available. We recommend that the media player retrieve - // a new playlist on a one-second interval. When this type of session is played in - // a media player, the user interface typically displays a "live" notification, - // with no scrubber control for choosing the position in the playback window to - // display. In LIVE mode, the newest available fragments are included in an HLS - // media playlist, even if there is a gap between fragments (that is, if a fragment - // is missing). A gap like this might cause a media player to halt or cause a jump - // in playback. In this mode, fragments are not added to the HLS media playlist if - // they are older than the newest fragment in the playlist. If the missing fragment - // becomes available after a subsequent fragment is added to the playlist, the - // older fragment is not added, and the gap is not filled. - // - // * LIVE_REPLAY : For - // sessions of this type, the HLS media playlist is updated similarly to how it is - // updated for LIVE mode except that it starts by including fragments from a given - // start time. Instead of fragments being added as they are ingested, fragments are - // added as the duration of the next fragment elapses. For example, if the - // fragments in the session are two seconds long, then a new fragment is added to - // the media playlist every two seconds. This mode is useful to be able to start - // playback from when an event is detected and continue live streaming media that - // has not yet been ingested as of the time of the session creation. This mode is - // also useful to stream previously archived media without being limited by the - // 1,000 fragment limit in the ON_DEMAND mode. - // - // * ON_DEMAND : For sessions of this - // type, the HLS media playlist contains all the fragments for the session, up to - // the number that is specified in MaxMediaPlaylistFragmentResults. The playlist - // must be retrieved only once for each session. When this type of session is - // played in a media player, the user interface typically displays a scrubber - // control for choosing the position in the playback window to display. - // - // In all - // playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are - // multiple fragments with the same start timestamp, the fragment that has the - // largest fragment number (that is, the newest fragment) is included in the HLS - // media playlist. The other fragments are not included. Fragments that have - // different timestamps but have overlapping durations are still included in the - // HLS media playlist. This can lead to unexpected behavior in the media player. - // The default is LIVE. + // - LIVE : For sessions of this type, the HLS media playlist is continually + // updated with the latest fragments as they become available. We recommend that + // the media player retrieve a new playlist on a one-second interval. When this + // type of session is played in a media player, the user interface typically + // displays a "live" notification, with no scrubber control for choosing the + // position in the playback window to display. In LIVE mode, the newest available + // fragments are included in an HLS media playlist, even if there is a gap between + // fragments (that is, if a fragment is missing). A gap like this might cause a + // media player to halt or cause a jump in playback. In this mode, fragments are + // not added to the HLS media playlist if they are older than the newest fragment + // in the playlist. If the missing fragment becomes available after a subsequent + // fragment is added to the playlist, the older fragment is not added, and the gap + // is not filled. + // - LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated + // similarly to how it is updated for LIVE mode except that it starts by + // including fragments from a given start time. Instead of fragments being added as + // they are ingested, fragments are added as the duration of the next fragment + // elapses. For example, if the fragments in the session are two seconds long, then + // a new fragment is added to the media playlist every two seconds. This mode is + // useful to be able to start playback from when an event is detected and continue + // live streaming media that has not yet been ingested as of the time of the + // session creation. This mode is also useful to stream previously archived media + // without being limited by the 1,000 fragment limit in the ON_DEMAND mode. + // - ON_DEMAND : For sessions of this type, the HLS media playlist contains all + // the fragments for the session, up to the number that is specified in + // MaxMediaPlaylistFragmentResults . The playlist must be retrieved only once for + // each session. When this type of session is played in a media player, the user + // interface typically displays a scrubber control for choosing the position in the + // playback window to display. + // In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP , and if + // there are multiple fragments with the same start timestamp, the fragment that + // has the largest fragment number (that is, the newest fragment) is included in + // the HLS media playlist. The other fragments are not included. Fragments that + // have different timestamps but have overlapping durations are still included in + // the HLS media playlist. This can lead to unexpected behavior in the media + // player. The default is LIVE . PlaybackMode types.HLSPlaybackMode // The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS - // master playlist URL. You must specify either the StreamName or the StreamARN. + // master playlist URL. You must specify either the StreamName or the StreamARN . StreamARN *string // The name of the stream for which to retrieve the HLS master playlist URL. You - // must specify either the StreamName or the StreamARN. + // must specify either the StreamName or the StreamARN . StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideoarchivedmedia/api_op_GetImages.go b/service/kinesisvideoarchivedmedia/api_op_GetImages.go index 7cce29963a3..432628351ef 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetImages.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetImages.go @@ -63,8 +63,8 @@ type GetImagesInput struct { StartTimestamp *time.Time // The list of a key-value pair structure that contains extra parameters that can - // be applied when the image is generated. The FormatConfig key is the JPEGQuality, - // which indicates the JPEG quality key to be used to generate the image. The + // be applied when the image is generated. The FormatConfig key is the JPEGQuality + // , which indicates the JPEG quality key to be used to generate the image. The // FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will // be generated with less quality and the best compression. If the value is 100, // the image will be generated with the best quality and less compression. If no @@ -79,20 +79,20 @@ type GetImagesInput struct { // image size will be returned. HeightPixels *int32 - // The maximum number of images to be returned by the API. The default limit is 100 - // images per API response. The additional results will be paginated. + // The maximum number of images to be returned by the API. The default limit is + // 100 images per API response. The additional results will be paginated. MaxResults *int64 - // A token that specifies where to start paginating the next set of Images. This is - // the GetImages:NextToken from a previously truncated response. + // A token that specifies where to start paginating the next set of Images. This + // is the GetImages:NextToken from a previously truncated response. NextToken *string // The Amazon Resource Name (ARN) of the stream from which to retrieve the images. - // You must specify either the StreamName or the StreamARN. + // You must specify either the StreamName or the StreamARN . StreamARN *string // The name of the stream from which to retrieve the images. You must specify - // either the StreamName or the StreamARN. + // either the StreamName or the StreamARN . StreamName *string // The width of the output image that is used in conjunction with the HeightPixels diff --git a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go index c682155f21a..0841499f335 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go @@ -14,28 +14,22 @@ import ( // Gets media for a list of fragments (specified by fragment number) from the // archived data in an Amazon Kinesis video stream. You must first call the // GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList -// requests to this endpoint using the --endpoint-url parameter -// (https://docs.aws.amazon.com/cli/latest/reference/). For limits, see Kinesis -// Video Streams Limits -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). If an -// error is thrown after invoking a Kinesis Video Streams archived media API, in -// addition to the HTTP status code and the response body, it includes the +// requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/) +// . For limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) +// . If an error is thrown after invoking a Kinesis Video Streams archived media +// API, in addition to the HTTP status code and the response body, it includes the // following pieces of information: +// - x-amz-ErrorType HTTP header – contains a more specific error type in +// addition to what the HTTP status code provides. +// - x-amz-RequestId HTTP header – if you want to report an issue to AWS, the +// support team can better diagnose the problem if given the Request Id. // -// * x-amz-ErrorType HTTP header – contains a -// more specific error type in addition to what the HTTP status code provides. -// -// * -// x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support -// team can better diagnose the problem if given the Request Id. -// -// Both the HTTP -// status code and the ErrorType header can be utilized to make programmatic -// decisions about whether errors are retry-able and under what conditions, as well -// as provide information on what actions the client programmer might need to take -// in order to successfully try again. For more information, see the Errors section -// at the bottom of this topic, as well as Common Errors -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). +// Both the HTTP status code and the ErrorType header can be utilized to make +// programmatic decisions about whether errors are retry-able and under what +// conditions, as well as provide information on what actions the client programmer +// might need to take in order to successfully try again. For more information, see +// the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html) +// . func (c *Client) GetMediaForFragmentList(ctx context.Context, params *GetMediaForFragmentListInput, optFns ...func(*Options)) (*GetMediaForFragmentListOutput, error) { if params == nil { params = &GetMediaForFragmentListInput{} @@ -54,7 +48,7 @@ func (c *Client) GetMediaForFragmentList(ctx context.Context, params *GetMediaFo type GetMediaForFragmentListInput struct { // A list of the numbers of fragments for which to retrieve media. You retrieve - // these values with ListFragments. + // these values with ListFragments . // // This member is required. Fragments []string @@ -76,32 +70,19 @@ type GetMediaForFragmentListOutput struct { ContentType *string // The payload that Kinesis Video Streams returns is a sequence of chunks from the - // specified stream. For information about the chunks, see PutMedia - // (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). - // The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList + // specified stream. For information about the chunks, see PutMedia (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html) + // . The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList // call also include the following additional Matroska (MKV) tags: - // - // * - // AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. - // - // * - // AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the - // fragment. - // - // * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp - // of the fragment. - // + // - AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. + // - AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the + // fragment. + // - AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the + // fragment. // The following tags will be included if an exception occurs: - // - // * - // AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the - // exception - // - // * AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the - // exception - // - // * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the - // exception + // - AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw + // the exception + // - AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception + // - AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception Payload io.ReadCloser // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideoarchivedmedia/api_op_ListFragments.go b/service/kinesisvideoarchivedmedia/api_op_ListFragments.go index 1f395d3b564..8e137307e03 100644 --- a/service/kinesisvideoarchivedmedia/api_op_ListFragments.go +++ b/service/kinesisvideoarchivedmedia/api_op_ListFragments.go @@ -11,32 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of Fragment objects from the specified stream and timestamp range -// within the archived data. Listing fragments is eventually consistent. This means -// that even if the producer receives an acknowledgment that a fragment is +// Returns a list of Fragment objects from the specified stream and timestamp +// range within the archived data. Listing fragments is eventually consistent. This +// means that even if the producer receives an acknowledgment that a fragment is // persisted, the result might not be returned immediately from a request to -// ListFragments. However, results are typically available in less than one second. -// You must first call the GetDataEndpoint API to get an endpoint. Then send the -// ListFragments requests to this endpoint using the --endpoint-url parameter -// (https://docs.aws.amazon.com/cli/latest/reference/). If an error is thrown after -// invoking a Kinesis Video Streams archived media API, in addition to the HTTP -// status code and the response body, it includes the following pieces of +// ListFragments . However, results are typically available in less than one +// second. You must first call the GetDataEndpoint API to get an endpoint. Then +// send the ListFragments requests to this endpoint using the --endpoint-url +// parameter (https://docs.aws.amazon.com/cli/latest/reference/) . If an error is +// thrown after invoking a Kinesis Video Streams archived media API, in addition to +// the HTTP status code and the response body, it includes the following pieces of // information: +// - x-amz-ErrorType HTTP header – contains a more specific error type in +// addition to what the HTTP status code provides. +// - x-amz-RequestId HTTP header – if you want to report an issue to AWS, the +// support team can better diagnose the problem if given the Request Id. // -// * x-amz-ErrorType HTTP header – contains a more specific error -// type in addition to what the HTTP status code provides. -// -// * x-amz-RequestId HTTP -// header – if you want to report an issue to AWS, the support team can better -// diagnose the problem if given the Request Id. -// -// Both the HTTP status code and the -// ErrorType header can be utilized to make programmatic decisions about whether -// errors are retry-able and under what conditions, as well as provide information -// on what actions the client programmer might need to take in order to -// successfully try again. For more information, see the Errors section at the -// bottom of this topic, as well as Common Errors -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). +// Both the HTTP status code and the ErrorType header can be utilized to make +// programmatic decisions about whether errors are retry-able and under what +// conditions, as well as provide information on what actions the client programmer +// might need to take in order to successfully try again. For more information, see +// the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html) +// . func (c *Client) ListFragments(ctx context.Context, params *ListFragmentsInput, optFns ...func(*Options)) (*ListFragmentsOutput, error) { if params == nil { params = &ListFragmentsInput{} @@ -54,12 +50,12 @@ func (c *Client) ListFragments(ctx context.Context, params *ListFragmentsInput, type ListFragmentsInput struct { - // Describes the timestamp range and timestamp origin for the range of fragments to - // return. + // Describes the timestamp range and timestamp origin for the range of fragments + // to return. FragmentSelector *types.FragmentSelector // The total number of fragments to return. If the total number of fragments - // available is more than the value specified in max-results, then a + // available is more than the value specified in max-results , then a // ListFragmentsOutput$NextToken is provided in the output that you can use to // resume pagination. MaxResults *int64 diff --git a/service/kinesisvideoarchivedmedia/types/enums.go b/service/kinesisvideoarchivedmedia/types/enums.go index 173d2b1bdc3..b3e91bf106d 100644 --- a/service/kinesisvideoarchivedmedia/types/enums.go +++ b/service/kinesisvideoarchivedmedia/types/enums.go @@ -10,9 +10,9 @@ const ( ClipFragmentSelectorTypeServerTimestamp ClipFragmentSelectorType = "SERVER_TIMESTAMP" ) -// Values returns all known values for ClipFragmentSelectorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClipFragmentSelectorType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ClipFragmentSelectorType) Values() []ClipFragmentSelectorType { return []ClipFragmentSelectorType{ "PRODUCER_TIMESTAMP", @@ -64,9 +64,10 @@ const ( DASHDisplayFragmentTimestampNever DASHDisplayFragmentTimestamp = "NEVER" ) -// Values returns all known values for DASHDisplayFragmentTimestamp. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DASHDisplayFragmentTimestamp. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DASHDisplayFragmentTimestamp) Values() []DASHDisplayFragmentTimestamp { return []DASHDisplayFragmentTimestamp{ "ALWAYS", @@ -82,9 +83,9 @@ const ( DASHFragmentSelectorTypeServerTimestamp DASHFragmentSelectorType = "SERVER_TIMESTAMP" ) -// Values returns all known values for DASHFragmentSelectorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DASHFragmentSelectorType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DASHFragmentSelectorType) Values() []DASHFragmentSelectorType { return []DASHFragmentSelectorType{ "PRODUCER_TIMESTAMP", diff --git a/service/kinesisvideoarchivedmedia/types/errors.go b/service/kinesisvideoarchivedmedia/types/errors.go index e3e6b462f87..739298a58ca 100644 --- a/service/kinesisvideoarchivedmedia/types/errors.go +++ b/service/kinesisvideoarchivedmedia/types/errors.go @@ -9,8 +9,8 @@ import ( // Kinesis Video Streams has throttled the request because you have exceeded a // limit. Try making the call later. For information about limits, see Kinesis -// Video Streams Limits -// (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). +// Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html) +// . type ClientLimitExceededException struct { Message *string @@ -197,9 +197,9 @@ func (e *NotAuthorizedException) ErrorCode() string { } func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// GetMedia throws this error when Kinesis Video Streams can't find the stream that -// you specified. GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw -// this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis +// GetMedia throws this error when Kinesis Video Streams can't find the stream +// that you specified. GetHLSStreamingSessionURL and GetDASHStreamingSessionURL +// throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAY is // requested for a stream that has no fragments within the requested time range, or // if a session with a PlaybackMode of LIVE is requested for a stream that has no // fragments within the last 30 seconds. @@ -231,7 +231,7 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) // could not be determined from the codec IDs of the tracks in the first fragment // for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, -// optionally, the codec ID for track 2 should be A_AAC. +// optionally, the codec ID for track 2 should be A_AAC . type UnsupportedStreamMediaTypeException struct { Message *string diff --git a/service/kinesisvideoarchivedmedia/types/types.go b/service/kinesisvideoarchivedmedia/types/types.go index 50a1fdfbb74..8ccf34aec28 100644 --- a/service/kinesisvideoarchivedmedia/types/types.go +++ b/service/kinesisvideoarchivedmedia/types/types.go @@ -33,9 +33,9 @@ type ClipFragmentSelector struct { type ClipTimestampRange struct { // The end of the timestamp range for the requested media. This value must be - // within 24 hours of the specified StartTimestamp, and it must be later than the + // within 24 hours of the specified StartTimestamp , and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is - // SERVER_TIMESTAMP, this value must be in the past. This value is inclusive. The + // SERVER_TIMESTAMP , this value must be in the past. This value is inclusive. The // EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments // that start before the EndTimestamp value and continue past it are included in // the session. @@ -43,11 +43,11 @@ type ClipTimestampRange struct { // This member is required. EndTimestamp *time.Time - // The starting timestamp in the range of timestamps for which to return fragments. - // Only fragments that start exactly at or after StartTimestamp are included in the - // session. Fragments that start before StartTimestamp and continue past it aren't - // included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the - // StartTimestamp must be later than the stream head. + // The starting timestamp in the range of timestamps for which to return + // fragments. Only fragments that start exactly at or after StartTimestamp are + // included in the session. Fragments that start before StartTimestamp and + // continue past it aren't included in the session. If FragmentSelectorType is + // SERVER_TIMESTAMP , the StartTimestamp must be later than the stream head. // // This member is required. StartTimestamp *time.Time @@ -60,11 +60,11 @@ type ClipTimestampRange struct { type DASHFragmentSelector struct { // The source of the timestamps for the requested media. When FragmentSelectorType - // is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is - // ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp - // within the specified FragmentSelector$TimestampRange is included in the media - // playlist. In addition, the fragments with producer timestamps within the - // TimestampRange ingested immediately following the first fragment (up to the + // is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode + // is ON_DEMAND or LIVE_REPLAY , the first fragment ingested with a producer + // timestamp within the specified FragmentSelector$TimestampRange is included in + // the media playlist. In addition, the fragments with producer timestamps within + // the TimestampRange ingested immediately following the first fragment (up to the // GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included. // Fragments that have duplicate producer timestamps are deduplicated. This means // that if producers are producing a stream of fragments with producer timestamps @@ -73,32 +73,32 @@ type DASHFragmentSelector struct { // fragments are ingested within the same time range and very different points in // time, only the oldest ingested collection of fragments are returned. When // FragmentSelectorType is set to PRODUCER_TIMESTAMP and - // GetDASHStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps + // GetDASHStreamingSessionURLInput$PlaybackMode is LIVE , the producer timestamps // are used in the MP4 fragments and for deduplication. But the most recently // ingested fragments based on server timestamps are included in the MPEG-DASH // manifest. This means that even if fragments ingested in the past have producer // timestamps with values now, they are not included in the HLS media playlist. The - // default is SERVER_TIMESTAMP. + // default is SERVER_TIMESTAMP . FragmentSelectorType DASHFragmentSelectorType // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE. + // should not be present if PlaybackType is LIVE . TimestampRange *DASHTimestampRange noSmithyDocumentSerde } // The start and end of the timestamp range for the requested media. This value -// should not be present if PlaybackType is LIVE. The values in DASHimestampRange +// should not be present if PlaybackType is LIVE . The values in DASHimestampRange // are inclusive. Fragments that start exactly at or after the start time are // included in the session. Fragments that start before the start time and continue // past it are not included in the session. type DASHTimestampRange struct { // The end of the timestamp range for the requested media. This value must be - // within 24 hours of the specified StartTimestamp, and it must be later than the + // within 24 hours of the specified StartTimestamp , and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is - // SERVER_TIMESTAMP, this value must be in the past. The EndTimestamp value is + // SERVER_TIMESTAMP , this value must be in the past. The EndTimestamp value is // required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the // EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to // include newly ingested fragments until the session expires. This value is @@ -109,10 +109,10 @@ type DASHTimestampRange struct { // The start of the timestamp range for the requested media. If the // DASHTimestampRange value is specified, the StartTimestamp value is required. - // Only fragments that start exactly at or after StartTimestamp are included in the - // session. Fragments that start before StartTimestamp and continue past it aren't - // included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the - // StartTimestamp must be later than the stream head. + // Only fragments that start exactly at or after StartTimestamp are included in + // the session. Fragments that start before StartTimestamp and continue past it + // aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP , + // the StartTimestamp must be later than the stream head. StartTimestamp *time.Time noSmithyDocumentSerde @@ -141,23 +141,17 @@ type Fragment struct { noSmithyDocumentSerde } -// Describes the timestamp range and timestamp origin of a range of fragments. Only -// fragments with a start timestamp greater than or equal to the given start time -// and less than or equal to the end time are returned. For example, if a stream -// contains fragments with the following start timestamps: -// -// * 00:00:00 -// -// * -// 00:00:02 -// -// * 00:00:04 -// -// * 00:00:06 +// Describes the timestamp range and timestamp origin of a range of fragments. +// Only fragments with a start timestamp greater than or equal to the given start +// time and less than or equal to the end time are returned. For example, if a +// stream contains fragments with the following start timestamps: +// - 00:00:00 +// - 00:00:02 +// - 00:00:04 +// - 00:00:06 // -// A fragment selector range with a start time of -// 00:00:01 and end time of 00:00:04 would return the fragments with start times of -// 00:00:02 and 00:00:04. +// A fragment selector range with a start time of 00:00:01 and end time of +// 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04. type FragmentSelector struct { // The origin of the timestamps to use (Server or Producer). @@ -179,7 +173,7 @@ type HLSFragmentSelector struct { // The source of the timestamps for the requested media. When FragmentSelectorType // is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is - // ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp + // ON_DEMAND or LIVE_REPLAY , the first fragment ingested with a producer timestamp // within the specified FragmentSelector$TimestampRange is included in the media // playlist. In addition, the fragments with producer timestamps within the // TimestampRange ingested immediately following the first fragment (up to the @@ -191,29 +185,29 @@ type HLSFragmentSelector struct { // range. If some fragments are ingested within the same time range and very // different points in time, only the oldest ingested collection of fragments are // returned. When FragmentSelectorType is set to PRODUCER_TIMESTAMP and - // GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are - // used in the MP4 fragments and for deduplication. But the most recently ingested - // fragments based on server timestamps are included in the HLS media playlist. - // This means that even if fragments ingested in the past have producer timestamps - // with values now, they are not included in the HLS media playlist. The default is - // SERVER_TIMESTAMP. + // GetHLSStreamingSessionURLInput$PlaybackMode is LIVE , the producer timestamps + // are used in the MP4 fragments and for deduplication. But the most recently + // ingested fragments based on server timestamps are included in the HLS media + // playlist. This means that even if fragments ingested in the past have producer + // timestamps with values now, they are not included in the HLS media playlist. The + // default is SERVER_TIMESTAMP . FragmentSelectorType HLSFragmentSelectorType // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE. + // should not be present if PlaybackType is LIVE . TimestampRange *HLSTimestampRange noSmithyDocumentSerde } // The start and end of the timestamp range for the requested media. This value -// should not be present if PlaybackType is LIVE. +// should not be present if PlaybackType is LIVE . type HLSTimestampRange struct { // The end of the timestamp range for the requested media. This value must be - // within 24 hours of the specified StartTimestamp, and it must be later than the + // within 24 hours of the specified StartTimestamp , and it must be later than the // StartTimestamp value. If FragmentSelectorType for the request is - // SERVER_TIMESTAMP, this value must be in the past. The EndTimestamp value is + // SERVER_TIMESTAMP , this value must be in the past. The EndTimestamp value is // required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the // EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to // include newly ingested fragments until the session expires. This value is @@ -223,36 +217,33 @@ type HLSTimestampRange struct { EndTimestamp *time.Time // The start of the timestamp range for the requested media. If the - // HLSTimestampRange value is specified, the StartTimestamp value is required. Only - // fragments that start exactly at or after StartTimestamp are included in the - // session. Fragments that start before StartTimestamp and continue past it aren't - // included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the - // StartTimestamp must be later than the stream head. + // HLSTimestampRange value is specified, the StartTimestamp value is required. + // Only fragments that start exactly at or after StartTimestamp are included in + // the session. Fragments that start before StartTimestamp and continue past it + // aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP , + // the StartTimestamp must be later than the stream head. StartTimestamp *time.Time noSmithyDocumentSerde } -// A structure that contains the Timestamp, Error, and ImageContent. +// A structure that contains the Timestamp , Error , and ImageContent . type Image struct { // The error message shown when the image for the provided timestamp was not // extracted due to a non-tryable error. An error will be returned if: + // - There is no media that exists for the specified Timestamp . // - // * There is - // no media that exists for the specified Timestamp. - // - // * The media for the specified - // time does not allow an image to be extracted. In this case the media is audio - // only, or the incorrect media has been ingested. + // - The media for the specified time does not allow an image to be extracted. + // In this case the media is audio only, or the incorrect media has been ingested. Error ImageError // An attribute of the Image object that is Base64 encoded. ImageContent *string - // An attribute of the Image object that is used to extract an image from the video - // stream. This field is used to manage gaps on images or to better understand the - // pagination window. + // An attribute of the Image object that is used to extract an image from the + // video stream. This field is used to manage gaps on images or to better + // understand the pagination window. TimeStamp *time.Time noSmithyDocumentSerde diff --git a/service/kinesisvideomedia/api_client.go b/service/kinesisvideomedia/api_client.go index 5d98a7a8e61..f064188c0d1 100644 --- a/service/kinesisvideomedia/api_client.go +++ b/service/kinesisvideomedia/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisvideomedia/api_op_GetMedia.go b/service/kinesisvideomedia/api_op_GetMedia.go index 533281bcaa9..961b90476a3 100644 --- a/service/kinesisvideomedia/api_op_GetMedia.go +++ b/service/kinesisvideomedia/api_op_GetMedia.go @@ -17,40 +17,31 @@ import ( // the starting chunk. Kinesis Video Streams then returns a stream of chunks in // order by fragment number. You must first call the GetDataEndpoint API to get an // endpoint. Then send the GetMedia requests to this endpoint using the -// --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/). +// --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/) . // When you put media data (fragments) on a stream, Kinesis Video Streams stores // each incoming fragment and related metadata in what is called a "chunk." For -// more information, see PutMedia -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html). -// The GetMedia API returns a stream of these chunks starting from the chunk that -// you specify in the request. The following limits apply when using the GetMedia -// API: +// more information, see PutMedia (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html) +// . The GetMedia API returns a stream of these chunks starting from the chunk +// that you specify in the request. The following limits apply when using the +// GetMedia API: +// - A client can call GetMedia up to five times per second per stream. +// - Kinesis Video Streams sends media data at a rate of up to 25 megabytes per +// second (or 200 megabits per second) during a GetMedia session. // -// * A client can call GetMedia up to five times per second per stream. +// If an error is thrown after invoking a Kinesis Video Streams media API, in +// addition to the HTTP status code and the response body, it includes the +// following pieces of information: +// - x-amz-ErrorType HTTP header – contains a more specific error type in +// addition to what the HTTP status code provides. +// - x-amz-RequestId HTTP header – if you want to report an issue to AWS, the +// support team can better diagnose the problem if given the Request Id. // -// * -// Kinesis Video Streams sends media data at a rate of up to 25 megabytes per -// second (or 200 megabits per second) during a GetMedia session. -// -// If an error is -// thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP -// status code and the response body, it includes the following pieces of -// information: -// -// * x-amz-ErrorType HTTP header – contains a more specific error -// type in addition to what the HTTP status code provides. -// -// * x-amz-RequestId HTTP -// header – if you want to report an issue to AWS, the support team can better -// diagnose the problem if given the Request Id. -// -// Both the HTTP status code and the -// ErrorType header can be utilized to make programmatic decisions about whether -// errors are retry-able and under what conditions, as well as provide information -// on what actions the client programmer might need to take in order to -// successfully try again. For more information, see the Errors section at the -// bottom of this topic, as well as Common Errors -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html). +// Both the HTTP status code and the ErrorType header can be utilized to make +// programmatic decisions about whether errors are retry-able and under what +// conditions, as well as provide information on what actions the client programmer +// might need to take in order to successfully try again. For more information, see +// the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html) +// . func (c *Client) GetMedia(ctx context.Context, params *GetMediaInput, optFns ...func(*Options)) (*GetMediaOutput, error) { if params == nil { params = &GetMediaInput{} @@ -73,12 +64,12 @@ type GetMediaInput struct { // This member is required. StartSelector *types.StartSelector - // The ARN of the stream from where you want to get the media content. If you don't - // specify the streamARN, you must specify the streamName. + // The ARN of the stream from where you want to get the media content. If you + // don't specify the streamARN , you must specify the streamName . StreamARN *string // The Kinesis video stream name from where you want to get the media content. If - // you don't specify the streamName, you must specify the streamARN. + // you don't specify the streamName , you must specify the streamARN . StreamName *string noSmithyDocumentSerde @@ -93,62 +84,30 @@ type GetMediaOutput struct { // specified stream. For information about the chunks, see . The chunks that // Kinesis Video Streams returns in the GetMedia call also include the following // additional Matroska (MKV) tags: - // - // * AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 - // string) - In the event your GetMedia call terminates, you can use this - // continuation token in your next request to get the next chunk where the last - // request terminated. - // - // * AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - - // Client applications can use this tag value to determine how far behind the chunk - // returned in the response is from the latest chunk on the stream. - // - // * - // AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. - // - // * - // AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment. - // - // * - // AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment. - // - // The - // following tags will be present if an error occurs: - // - // * - // AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused - // GetMedia to stop. - // - // * AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. - // - // The - // error codes are as follows: - // - // * 3002 - Error writing to the stream - // - // * 4000 - - // Requested fragment is not found - // - // * 4500 - Access denied for the stream's KMS - // key - // - // * 4501 - Stream's KMS key is disabled - // - // * 4502 - Validation error on the - // stream's KMS key - // - // * 4503 - KMS key specified in the stream is unavailable - // - // * - // 4504 - Invalid usage of the KMS key specified in the stream - // - // * 4505 - Invalid - // state of the KMS key specified in the stream - // - // * 4506 - Unable to find the KMS - // key specified in the stream - // - // * 5000 - Internal error + // - AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your + // GetMedia call terminates, you can use this continuation token in your next + // request to get the next chunk where the last request terminated. + // - AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can + // use this tag value to determine how far behind the chunk returned in the + // response is from the latest chunk on the stream. + // - AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. + // - AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment. + // - AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment. + // The following tags will be present if an error occurs: + // - AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused + // GetMedia to stop. + // - AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. + // The error codes are as follows: + // - 3002 - Error writing to the stream + // - 4000 - Requested fragment is not found + // - 4500 - Access denied for the stream's KMS key + // - 4501 - Stream's KMS key is disabled + // - 4502 - Validation error on the stream's KMS key + // - 4503 - KMS key specified in the stream is unavailable + // - 4504 - Invalid usage of the KMS key specified in the stream + // - 4505 - Invalid state of the KMS key specified in the stream + // - 4506 - Unable to find the KMS key specified in the stream + // - 5000 - Internal error Payload io.ReadCloser // Metadata pertaining to the operation's result. diff --git a/service/kinesisvideomedia/types/types.go b/service/kinesisvideomedia/types/types.go index e706bf2469f..49814256606 100644 --- a/service/kinesisvideomedia/types/types.go +++ b/service/kinesisvideomedia/types/types.go @@ -7,45 +7,30 @@ import ( "time" ) -// Identifies the chunk on the Kinesis video stream where you want the GetMedia API -// to start returning media data. You have the following options to identify the -// starting chunk: -// -// * Choose the latest (or oldest) chunk. -// -// * Identify a specific -// chunk. You can identify a specific chunk either by providing a fragment number -// or timestamp (server or producer). -// -// * Each chunk's metadata includes a -// continuation token as a Matroska (MKV) tag -// (AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request -// terminated, you can use this tag value in your next GetMedia request. The API -// then starts returning chunks starting where the last API ended. +// Identifies the chunk on the Kinesis video stream where you want the GetMedia +// API to start returning media data. You have the following options to identify +// the starting chunk: +// - Choose the latest (or oldest) chunk. +// - Identify a specific chunk. You can identify a specific chunk either by +// providing a fragment number or timestamp (server or producer). +// - Each chunk's metadata includes a continuation token as a Matroska (MKV) tag +// ( AWS_KINESISVIDEO_CONTINUATION_TOKEN ). If your previous GetMedia request +// terminated, you can use this tag value in your next GetMedia request. The API +// then starts returning chunks starting where the last API ended. type StartSelector struct { // Identifies the fragment on the Kinesis video stream where you want to start // getting the data from. - // - // * NOW - Start with the latest chunk on the stream. - // - // * - // EARLIEST - Start with earliest available chunk on the stream. - // - // * FRAGMENT_NUMBER - // - Start with the chunk after a specific fragment. You must also specify the - // AfterFragmentNumber parameter. - // - // * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start - // with the chunk containing a fragment with the specified producer or server - // timestamp. You specify the timestamp by adding StartTimestamp. - // - // * - // CONTINUATION_TOKEN - Read using the specified continuation token. - // - // If you choose - // the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't - // provide any additional information in the startSelector. + // - NOW - Start with the latest chunk on the stream. + // - EARLIEST - Start with earliest available chunk on the stream. + // - FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must + // also specify the AfterFragmentNumber parameter. + // - PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a + // fragment with the specified producer or server timestamp. You specify the + // timestamp by adding StartTimestamp . + // - CONTINUATION_TOKEN - Read using the specified continuation token. + // If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType + // , you don't provide any additional information in the startSelector . // // This member is required. StartSelectorType StartSelectorType @@ -60,7 +45,7 @@ type StartSelector struct { ContinuationToken *string // A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP - // or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts + // or the SERVER_TIMESTAMP as the startSelectorType . The GetMedia API then starts // with the chunk containing the fragment that has the specified timestamp. StartTimestamp *time.Time diff --git a/service/kinesisvideosignaling/api_client.go b/service/kinesisvideosignaling/api_client.go index f479e04c998..3e5a2b283a4 100644 --- a/service/kinesisvideosignaling/api_client.go +++ b/service/kinesisvideosignaling/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go index 25f973c1dad..282e4515f2d 100644 --- a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go +++ b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go @@ -19,12 +19,11 @@ import ( // is used to improve the connectivity of peer-to-peer applications. By providing a // cloud-based relay service, TURN ensures that a connection can be established // even when one or more peers are incapable of a direct peer-to-peer connection. -// For more information, see A REST API For Access To TURN Services -// (https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00). You can invoke -// this API to establish a fallback mechanism in case either of the peers is unable -// to establish a direct peer-to-peer connection over a signaling channel. You must -// specify either a signaling channel ARN or the client ID in order to invoke this -// API. +// For more information, see A REST API For Access To TURN Services (https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00) +// . You can invoke this API to establish a fallback mechanism in case either of +// the peers is unable to establish a direct peer-to-peer connection over a +// signaling channel. You must specify either a signaling channel ARN or the client +// ID in order to invoke this API. func (c *Client) GetIceServerConfig(ctx context.Context, params *GetIceServerConfigInput, optFns ...func(*Options)) (*GetIceServerConfigOutput, error) { if params == nil { params = &GetIceServerConfigInput{} diff --git a/service/kinesisvideosignaling/doc.go b/service/kinesisvideosignaling/doc.go index 66f0302d722..83684611c55 100644 --- a/service/kinesisvideosignaling/doc.go +++ b/service/kinesisvideosignaling/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package kinesisvideosignaling provides the API client, operations, and parameter -// types for Amazon Kinesis Video Signaling Channels. +// Package kinesisvideosignaling provides the API client, operations, and +// parameter types for Amazon Kinesis Video Signaling Channels. // // Kinesis Video Streams Signaling Service is a intermediate service that // establishes a communication channel for discovering peers, transmitting offers diff --git a/service/kinesisvideosignaling/types/errors.go b/service/kinesisvideosignaling/types/errors.go index 2d03e490adc..e4dca565fce 100644 --- a/service/kinesisvideosignaling/types/errors.go +++ b/service/kinesisvideosignaling/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// Your request was throttled because you have exceeded the limit of allowed client -// calls. Try making the call later. +// Your request was throttled because you have exceeded the limit of allowed +// client calls. Try making the call later. type ClientLimitExceededException struct { Message *string diff --git a/service/kinesisvideosignaling/types/types.go b/service/kinesisvideosignaling/types/types.go index bbed417034b..cbc64bce1a9 100644 --- a/service/kinesisvideosignaling/types/types.go +++ b/service/kinesisvideosignaling/types/types.go @@ -17,10 +17,9 @@ type IceServer struct { Ttl int32 // An array of URIs, in the form specified in the - // I-D.petithuguenin-behave-turn-uris - // (https://tools.ietf.org/html/draft-petithuguenin-behave-turn-uris-03) spec. - // These URIs provide the different addresses and/or protocols that can be used to - // reach the TURN server. + // I-D.petithuguenin-behave-turn-uris (https://tools.ietf.org/html/draft-petithuguenin-behave-turn-uris-03) + // spec. These URIs provide the different addresses and/or protocols that can be + // used to reach the TURN server. Uris []string // A username to login to the ICE server. diff --git a/service/kinesisvideowebrtcstorage/api_client.go b/service/kinesisvideowebrtcstorage/api_client.go index edf976ce8be..9238ec4722c 100644 --- a/service/kinesisvideowebrtcstorage/api_client.go +++ b/service/kinesisvideowebrtcstorage/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kms/api_client.go b/service/kms/api_client.go index e56ae816b25..47a7a75a253 100644 --- a/service/kms/api_client.go +++ b/service/kms/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/kms/api_op_CancelKeyDeletion.go b/service/kms/api_op_CancelKeyDeletion.go index ee03cf109b5..fb0b393432e 100644 --- a/service/kms/api_op_CancelKeyDeletion.go +++ b/service/kms/api_op_CancelKeyDeletion.go @@ -11,17 +11,15 @@ import ( ) // Cancels the deletion of a KMS key. When this operation succeeds, the key state -// of the KMS key is Disabled. To enable the KMS key, use EnableKey. For more +// of the KMS key is Disabled . To enable the KMS key, use EnableKey . For more // information about scheduling and canceling deletion of a KMS key, see Deleting -// KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in -// the Key Management Service Developer Guide. The KMS key that you use for this +// KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) +// in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:CancelKeyDeletion -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:CancelKeyDeletion (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: ScheduleKeyDeletion func (c *Client) CancelKeyDeletion(ctx context.Context, params *CancelKeyDeletionInput, optFns ...func(*Options)) (*CancelKeyDeletionOutput, error) { if params == nil { @@ -42,15 +40,10 @@ type CancelKeyDeletionInput struct { // Identifies the KMS key whose deletion is being canceled. Specify the key ID or // key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -60,9 +53,8 @@ type CancelKeyDeletionInput struct { type CancelKeyDeletionOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key whose deletion is canceled. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key whose deletion is canceled. KeyId *string // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_ConnectCustomKeyStore.go b/service/kms/api_op_ConnectCustomKeyStore.go index 19fd8cad41e..717c1cbd0b7 100644 --- a/service/kms/api_op_ConnectCustomKeyStore.go +++ b/service/kms/api_op_ConnectCustomKeyStore.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Connects or reconnects a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// Connects or reconnects a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // to its backing key store. For an CloudHSM key store, ConnectCustomKeyStore // connects the key store to its associated CloudHSM cluster. For an external key // store, ConnectCustomKeyStore connects the key store to the external key store @@ -24,14 +23,13 @@ import ( // HTTP 200 response and a JSON object with no properties. However, this response // does not indicate that the custom key store is connected. To get the connection // state of the custom key store, use the DescribeCustomKeyStores operation. This -// operation is part of the custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// operation is part of the custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. The // ConnectCustomKeyStore operation might fail for various reasons. To find the // reason, use the DescribeCustomKeyStores operation and see the // ConnectionErrorCode in the response. For help interpreting the -// ConnectionErrorCode, see CustomKeyStoresListEntry. To fix the failure, use the +// ConnectionErrorCode , see CustomKeyStoresListEntry . To fix the failure, use the // DisconnectCustomKeyStore operation to disconnect the custom key store, correct // the error, use the UpdateCustomKeyStore operation if necessary, and then use // ConnectCustomKeyStore again. CloudHSM key store During the connection process @@ -40,47 +38,34 @@ import ( // the cluster, logs into the CloudHSM client as the kmsuser CU, and rotates its // password. To connect an CloudHSM key store, its associated CloudHSM cluster must // have at least one active HSM. To get the number of active HSMs in a cluster, use -// the DescribeClusters -// (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) -// operation. To add HSMs to the cluster, use the CreateHsm -// (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html) -// operation. Also, the kmsuser crypto user -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) +// the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) +// operation. To add HSMs to the cluster, use the CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html) +// operation. Also, the kmsuser crypto user (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) // (CU) must not be logged into the cluster. This prevents KMS from using this // account to log in. If you are having trouble connecting or disconnecting a -// CloudHSM key store, see Troubleshooting an CloudHSM key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the -// Key Management Service Developer Guide. External key store When you connect an -// external key store that uses public endpoint connectivity, KMS tests its ability -// to communicate with your external key manager by sending a request via the -// external key store proxy. When you connect to an external key store that uses -// VPC endpoint service connectivity, KMS establishes the networking elements that -// it needs to communicate with your external key manager via the external key +// CloudHSM key store, see Troubleshooting an CloudHSM key store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) +// in the Key Management Service Developer Guide. External key store When you +// connect an external key store that uses public endpoint connectivity, KMS tests +// its ability to communicate with your external key manager by sending a request +// via the external key store proxy. When you connect to an external key store that +// uses VPC endpoint service connectivity, KMS establishes the networking elements +// that it needs to communicate with your external key manager via the external key // store proxy. This includes creating an interface endpoint to the VPC endpoint // service and a private hosted zone for traffic between KMS and the VPC endpoint // service. To connect an external key store, KMS must be able to connect to the // external key store proxy, the external key store proxy must be able to // communicate with your external key manager, and the external key manager must be // available for cryptographic operations. If you are having trouble connecting or -// disconnecting an external key store, see Troubleshooting an external key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html) +// disconnecting an external key store, see Troubleshooting an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html) // in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a custom key store in a different Amazon Web Services -// account. Required permissions: kms:ConnectCustomKeyStore -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// account. Required permissions: kms:ConnectCustomKeyStore (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations -// -// * CreateCustomKeyStore -// -// * -// DeleteCustomKeyStore -// -// * DescribeCustomKeyStores -// -// * DisconnectCustomKeyStore -// -// * -// UpdateCustomKeyStore +// - CreateCustomKeyStore +// - DeleteCustomKeyStore +// - DescribeCustomKeyStores +// - DisconnectCustomKeyStore +// - UpdateCustomKeyStore func (c *Client) ConnectCustomKeyStore(ctx context.Context, params *ConnectCustomKeyStoreInput, optFns ...func(*Options)) (*ConnectCustomKeyStoreOutput, error) { if params == nil { params = &ConnectCustomKeyStoreInput{} @@ -98,8 +83,8 @@ func (c *Client) ConnectCustomKeyStore(ctx context.Context, params *ConnectCusto type ConnectCustomKeyStoreInput struct { - // Enter the key store ID of the custom key store that you want to connect. To find - // the ID of a custom key store, use the DescribeCustomKeyStores operation. + // Enter the key store ID of the custom key store that you want to connect. To + // find the ID of a custom key store, use the DescribeCustomKeyStores operation. // // This member is required. CustomKeyStoreId *string diff --git a/service/kms/api_op_CreateAlias.go b/service/kms/api_op_CreateAlias.go index a4618675904..3bc58cfdeec 100644 --- a/service/kms/api_op_CreateAlias.go +++ b/service/kms/api_op_CreateAlias.go @@ -11,48 +11,36 @@ import ( ) // Creates a friendly name for a KMS key. Adding, deleting, or updating an alias -// can allow or deny permission to the KMS key. For details, see ABAC for KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key -// Management Service Developer Guide. You can use an alias to identify a KMS key -// in the KMS console, in the DescribeKey operation and in cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), -// such as Encrypt and GenerateDataKey. You can also change the KMS key that's -// associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any -// time. These operations don't affect the underlying KMS key. You can associate -// the alias with any customer managed key in the same Amazon Web Services Region. -// Each alias is associated with only one KMS key at a time, but a KMS key can have -// multiple aliases. A valid KMS key is required. You can't create an alias without -// a KMS key. The alias must be unique in the account and Region, but you can have -// aliases with the same name in different Regions. For detailed information about -// aliases, see Using aliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the -// Key Management Service Developer Guide. This operation does not return a +// can allow or deny permission to the KMS key. For details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) +// in the Key Management Service Developer Guide. You can use an alias to identify +// a KMS key in the KMS console, in the DescribeKey operation and in cryptographic +// operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// , such as Encrypt and GenerateDataKey . You can also change the KMS key that's +// associated with the alias ( UpdateAlias ) or delete the alias ( DeleteAlias ) at +// any time. These operations don't affect the underlying KMS key. You can +// associate the alias with any customer managed key in the same Amazon Web +// Services Region. Each alias is associated with only one KMS key at a time, but a +// KMS key can have multiple aliases. A valid KMS key is required. You can't create +// an alias without a KMS key. The alias must be unique in the account and Region, +// but you can have aliases with the same name in different Regions. For detailed +// information about aliases, see Using aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) +// in the Key Management Service Developer Guide. This operation does not return a // response. To get the alias that you created, use the ListAliases operation. The // KMS key that you use for this operation must be in a compatible key state. For -// details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on an alias in a different Amazon Web Services account. // Required permissions +// - kms:CreateAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the alias (IAM policy). +// - kms:CreateAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the KMS key (key policy). // -// * kms:CreateAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the alias (IAM policy). -// -// * kms:CreateAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the KMS key (key policy). -// -// For details, see Controlling access to aliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) +// For details, see Controlling access to aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) // in the Key Management Service Developer Guide. Related operations: -// -// * -// DeleteAlias -// -// * ListAliases -// -// * UpdateAlias +// - DeleteAlias +// - ListAliases +// - UpdateAlias func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { params = &CreateAliasInput{} @@ -71,32 +59,25 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { // Specifies the alias name. This value must begin with alias/ followed by a name, - // such as alias/ExampleAlias. The AliasName value must be string of 1-256 + // such as alias/ExampleAlias . The AliasName value must be string of 1-256 // characters. It can contain only alphanumeric characters, forward slashes (/), - // underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. - // The alias/aws/ prefix is reserved for Amazon Web Services managed keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + // underscores (_), and dashes (-). The alias name cannot begin with alias/aws/ . + // The alias/aws/ prefix is reserved for Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + // . // // This member is required. AliasName *string - // Associates the alias with the specified customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). - // The KMS key must be in the same Amazon Web Services Region. A valid key ID is + // Associates the alias with the specified customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + // . The KMS key must be in the same Amazon Web Services Region. A valid key ID is // required. If you supply a null or empty string value, this operation returns an - // error. For help finding the key ID and ARN, see Finding the Key ID and ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) + // error. For help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) // in the Key Management Service Developer Guide . Specify the key ID or key ARN of // the KMS key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. TargetKeyId *string diff --git a/service/kms/api_op_CreateCustomKeyStore.go b/service/kms/api_op_CreateCustomKeyStore.go index 9e2552c3750..7e75363c9f4 100644 --- a/service/kms/api_op_CreateCustomKeyStore.go +++ b/service/kms/api_op_CreateCustomKeyStore.go @@ -11,83 +11,63 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// Creates a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // backed by a key store that you own and manage. When you use a KMS key in a // custom key store for a cryptographic operation, the cryptographic operation is // actually performed in your key store using your keys. KMS supports CloudHSM key -// stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) -// backed by an CloudHSM cluster -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html) and -// external key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) +// stores (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) +// backed by an CloudHSM cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html) +// and external key stores (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) // backed by an external key store proxy and external key manager outside of Amazon -// Web Services. This operation is part of the custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// Web Services. This operation is part of the custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. Before // you create the custom key store, the required elements must be in place and // operational. We recommend that you use the test tools that KMS provides to // verify the configuration your external key store proxy. For details about the // required elements and verification tests, see Assemble the prerequisites (for -// CloudHSM key stores) -// (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) -// or Assemble the prerequisites (for external key stores) -// (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements) +// CloudHSM key stores) (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) +// or Assemble the prerequisites (for external key stores) (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements) // in the Key Management Service Developer Guide. To create a custom key store, use // the following parameters. +// - To create an CloudHSM key store, specify the CustomKeyStoreName , +// CloudHsmClusterId , KeyStorePassword , and TrustAnchorCertificate . The +// CustomKeyStoreType parameter is optional for CloudHSM key stores. If you +// include it, set it to the default value, AWS_CLOUDHSM . For help with +// failures, see Troubleshooting an CloudHSM key store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) +// in the Key Management Service Developer Guide. +// - To create an external key store, specify the CustomKeyStoreName and a +// CustomKeyStoreType of EXTERNAL_KEY_STORE . Also, specify values for +// XksProxyConnectivity , XksProxyAuthenticationCredential , XksProxyUriEndpoint +// , and XksProxyUriPath . If your XksProxyConnectivity value is +// VPC_ENDPOINT_SERVICE , specify the XksProxyVpcEndpointServiceName parameter. +// For help with failures, see Troubleshooting an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html) +// in the Key Management Service Developer Guide. // -// * To create an CloudHSM key store, specify the -// CustomKeyStoreName, CloudHsmClusterId, KeyStorePassword, and -// TrustAnchorCertificate. The CustomKeyStoreType parameter is optional for -// CloudHSM key stores. If you include it, set it to the default value, -// AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the -// Key Management Service Developer Guide. -// -// * To create an external key store, -// specify the CustomKeyStoreName and a CustomKeyStoreType of EXTERNAL_KEY_STORE. -// Also, specify values for XksProxyConnectivity, XksProxyAuthenticationCredential, -// XksProxyUriEndpoint, and XksProxyUriPath. If your XksProxyConnectivity value is -// VPC_ENDPOINT_SERVICE, specify the XksProxyVpcEndpointServiceName parameter. For -// help with failures, see Troubleshooting an external key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html) -// in the Key Management Service Developer Guide. -// -// For external key stores: Some -// external key managers provide a simpler method for creating an external key -// store. For details, see your external key manager documentation. When creating -// an external key store in the KMS console, you can upload a JSON-based proxy -// configuration file with the desired values. You cannot use a proxy configuration -// with the CreateCustomKeyStore operation. However, you can use the values in the -// file to help you determine the correct values for the CreateCustomKeyStore -// parameters. When the operation completes successfully, it returns the ID of the -// new custom key store. Before you can use your new custom key store, you need to -// use the ConnectCustomKeyStore operation to connect a new CloudHSM key store to -// its CloudHSM cluster, or to connect a new external key store to the external key -// store proxy for your external key manager. Even if you are not going to use your -// custom key store immediately, you might want to connect it to verify that all -// settings are correct and then disconnect it until you are ready to use it. For -// help with failures, see Troubleshooting a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// For external key stores: Some external key managers provide a simpler method +// for creating an external key store. For details, see your external key manager +// documentation. When creating an external key store in the KMS console, you can +// upload a JSON-based proxy configuration file with the desired values. You cannot +// use a proxy configuration with the CreateCustomKeyStore operation. However, you +// can use the values in the file to help you determine the correct values for the +// CreateCustomKeyStore parameters. When the operation completes successfully, it +// returns the ID of the new custom key store. Before you can use your new custom +// key store, you need to use the ConnectCustomKeyStore operation to connect a new +// CloudHSM key store to its CloudHSM cluster, or to connect a new external key +// store to the external key store proxy for your external key manager. Even if you +// are not going to use your custom key store immediately, you might want to +// connect it to verify that all settings are correct and then disconnect it until +// you are ready to use it. For help with failures, see Troubleshooting a custom +// key store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a custom key store in a different Amazon Web Services -// account. Required permissions: kms:CreateCustomKeyStore -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// account. Required permissions: kms:CreateCustomKeyStore (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy). Related operations: -// -// * ConnectCustomKeyStore -// -// * -// DeleteCustomKeyStore -// -// * DescribeCustomKeyStores -// -// * DisconnectCustomKeyStore -// -// * -// UpdateCustomKeyStore +// - ConnectCustomKeyStore +// - DeleteCustomKeyStore +// - DescribeCustomKeyStores +// - DisconnectCustomKeyStore +// - UpdateCustomKeyStore func (c *Client) CreateCustomKeyStore(ctx context.Context, params *CreateCustomKeyStoreInput, optFns ...func(*Options)) (*CreateCustomKeyStoreOutput, error) { if params == nil { params = &CreateCustomKeyStoreInput{} @@ -113,24 +93,22 @@ type CreateCustomKeyStoreInput struct { CustomKeyStoreName *string // Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is - // required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM. Enter + // required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM . Enter // the cluster ID of any active CloudHSM cluster that is not already associated - // with a custom key store. To find the cluster ID, use the DescribeClusters - // (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) + // with a custom key store. To find the cluster ID, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) // operation. CloudHsmClusterId *string - // Specifies the type of custom key store. The default value is AWS_CLOUDHSM. For a - // custom key store backed by an CloudHSM cluster, omit the parameter or enter - // AWS_CLOUDHSM. For a custom key store backed by an external key manager outside - // of Amazon Web Services, enter EXTERNAL_KEY_STORE. You cannot change this + // Specifies the type of custom key store. The default value is AWS_CLOUDHSM . For + // a custom key store backed by an CloudHSM cluster, omit the parameter or enter + // AWS_CLOUDHSM . For a custom key store backed by an external key manager outside + // of Amazon Web Services, enter EXTERNAL_KEY_STORE . You cannot change this // property after the key store is created. CustomKeyStoreType types.CustomKeyStoreType // Specifies the kmsuser password for an CloudHSM key store. This parameter is - // required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM. Enter - // the password of the kmsuser crypto user (CU) account - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) + // required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM . Enter + // the password of the kmsuser crypto user (CU) account (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) // in the specified CloudHSM cluster. KMS logs into the cluster as this user to // manage key material on your behalf. The password must be a string of 7 to 32 // characters. Its value is case sensitive. This parameter tells KMS the kmsuser @@ -138,34 +116,33 @@ type CreateCustomKeyStoreInput struct { KeyStorePassword *string // Specifies the certificate for an CloudHSM key store. This parameter is required - // for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM. Enter the + // for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM . Enter the // content of the trust anchor certificate for the CloudHSM cluster. This is the // content of the customerCA.crt file that you created when you initialized the - // cluster - // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html). + // cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html) + // . TrustAnchorCertificate *string // Specifies an authentication credential for the external key store proxy (XKS // proxy). This parameter is required for all custom key stores with a - // CustomKeyStoreType of EXTERNAL_KEY_STORE. The XksProxyAuthenticationCredential - // has two required elements: RawSecretAccessKey, a secret key, and AccessKeyId, a - // unique identifier for the RawSecretAccessKey. For character requirements, see - // XksProxyAuthenticationCredentialType. KMS uses this authentication credential to - // sign requests to the external key store proxy on your behalf. This credential is - // unrelated to Identity and Access Management (IAM) and Amazon Web Services + // CustomKeyStoreType of EXTERNAL_KEY_STORE . The XksProxyAuthenticationCredential + // has two required elements: RawSecretAccessKey , a secret key, and AccessKeyId , + // a unique identifier for the RawSecretAccessKey . For character requirements, see + // XksProxyAuthenticationCredentialType . KMS uses this authentication credential + // to sign requests to the external key store proxy on your behalf. This credential + // is unrelated to Identity and Access Management (IAM) and Amazon Web Services // credentials. This parameter doesn't set or change the authentication credentials // on the XKS proxy. It just tells KMS the credential that you established on your // external key store proxy. If you rotate your proxy authentication credential, // use the UpdateCustomKeyStore operation to provide the new credential to KMS. XksProxyAuthenticationCredential *types.XksProxyAuthenticationCredentialType - // Indicates how KMS communicates with the external key store proxy. This parameter - // is required for custom key stores with a CustomKeyStoreType of - // EXTERNAL_KEY_STORE. If the external key store proxy uses a public endpoint, - // specify PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC - // endpoint service for communication with KMS, specify VPC_ENDPOINT_SERVICE. For - // help making this choice, see Choosing a connectivity option - // (https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity) + // Indicates how KMS communicates with the external key store proxy. This + // parameter is required for custom key stores with a CustomKeyStoreType of + // EXTERNAL_KEY_STORE . If the external key store proxy uses a public endpoint, + // specify PUBLIC_ENDPOINT . If the external key store proxy uses a Amazon VPC + // endpoint service for communication with KMS, specify VPC_ENDPOINT_SERVICE . For + // help making this choice, see Choosing a connectivity option (https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity) // in the Key Management Service Developer Guide. An Amazon VPC endpoint service // keeps your communication with KMS in a private address space entirely within // Amazon Web Services, but it requires more configuration, including establishing @@ -181,58 +158,49 @@ type CreateCustomKeyStoreInput struct { // Specifies the endpoint that KMS uses to send requests to the external key store // proxy (XKS proxy). This parameter is required for custom key stores with a - // CustomKeyStoreType of EXTERNAL_KEY_STORE. The protocol must be HTTPS. KMS + // CustomKeyStoreType of EXTERNAL_KEY_STORE . The protocol must be HTTPS. KMS // communicates on port 443. Do not specify the port in the XksProxyUriEndpoint // value. For external key stores with XksProxyConnectivity value of - // VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name of the - // VPC endpoint service. For external key stores with PUBLIC_ENDPOINT connectivity, - // this endpoint must be reachable before you create the custom key store. KMS - // connects to the external key store proxy while creating the custom key store. - // For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects - // when you call the ConnectCustomKeyStore operation. The value of this parameter - // must begin with https://. The remainder can contain upper and lower case letters - // (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (/ - // and \) are not permitted. Uniqueness requirements: - // - // * The combined - // XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web - // Services account and Region. - // - // * An external key store with PUBLIC_ENDPOINT - // connectivity cannot use the same XksProxyUriEndpoint value as an external key - // store with VPC_ENDPOINT_SERVICE connectivity in the same Amazon Web Services - // Region. - // - // * Each external key store with VPC_ENDPOINT_SERVICE connectivity must - // have its own private DNS name. The XksProxyUriEndpoint value for external key - // stores with VPC_ENDPOINT_SERVICE connectivity (private DNS name) must be unique - // in the Amazon Web Services account and Region. + // VPC_ENDPOINT_SERVICE , specify https:// followed by the private DNS name of the + // VPC endpoint service. For external key stores with PUBLIC_ENDPOINT + // connectivity, this endpoint must be reachable before you create the custom key + // store. KMS connects to the external key store proxy while creating the custom + // key store. For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS + // connects when you call the ConnectCustomKeyStore operation. The value of this + // parameter must begin with https:// . The remainder can contain upper and lower + // case letters (A-Z and a-z), numbers (0-9), dots ( . ), and hyphens ( - ). + // Additional slashes ( / and \ ) are not permitted. Uniqueness requirements: + // - The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique + // in the Amazon Web Services account and Region. + // - An external key store with PUBLIC_ENDPOINT connectivity cannot use the same + // XksProxyUriEndpoint value as an external key store with VPC_ENDPOINT_SERVICE + // connectivity in the same Amazon Web Services Region. + // - Each external key store with VPC_ENDPOINT_SERVICE connectivity must have its + // own private DNS name. The XksProxyUriEndpoint value for external key stores + // with VPC_ENDPOINT_SERVICE connectivity (private DNS name) must be unique in + // the Amazon Web Services account and Region. XksProxyUriEndpoint *string // Specifies the base path to the proxy APIs for this external key store. To find // this value, see the documentation for your external key store proxy. This // parameter is required for all custom key stores with a CustomKeyStoreType of - // EXTERNAL_KEY_STORE. The value must start with / and must end with /kms/xks/v1 + // EXTERNAL_KEY_STORE . The value must start with / and must end with /kms/xks/v1 // where v1 represents the version of the KMS external key store proxy API. This // path can include an optional prefix between the required elements such as - // /prefix/kms/xks/v1. Uniqueness requirements: - // - // * The combined XksProxyUriEndpoint - // and XksProxyUriPath values must be unique in the Amazon Web Services account and - // Region. + // /prefix/kms/xks/v1 . Uniqueness requirements: + // - The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique + // in the Amazon Web Services account and Region. XksProxyUriPath *string // Specifies the name of the Amazon VPC endpoint service for interface endpoints // that is used to communicate with your external key store proxy (XKS proxy). This // parameter is required when the value of CustomKeyStoreType is EXTERNAL_KEY_STORE - // and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE. The Amazon VPC - // endpoint service must fulfill all requirements - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements) + // and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE . The Amazon VPC + // endpoint service must fulfill all requirements (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements) // for use with an external key store. Uniqueness requirements: - // - // * External key - // stores with VPC_ENDPOINT_SERVICE connectivity can share an Amazon VPC, but each - // external key store must have its own VPC endpoint service and private DNS name. + // - External key stores with VPC_ENDPOINT_SERVICE connectivity can share an + // Amazon VPC, but each external key store must have its own VPC endpoint service + // and private DNS name. XksProxyVpcEndpointServiceName *string noSmithyDocumentSerde diff --git a/service/kms/api_op_CreateGrant.go b/service/kms/api_op_CreateGrant.go index 8cce11598ee..dd044cd296c 100644 --- a/service/kms/api_op_CreateGrant.go +++ b/service/kms/api_op_CreateGrant.go @@ -11,54 +11,41 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon Web -// Services principals to use KMS keys in cryptographic operations. It also can -// allow them to view a KMS key (DescribeKey) and create and manage grants. When +// Adds a grant to a KMS key. A grant is a policy instrument that allows Amazon +// Web Services principals to use KMS keys in cryptographic operations. It also can +// allow them to view a KMS key ( DescribeKey ) and create and manage grants. When // authorizing access to a KMS key, grants are considered along with key policies // and IAM policies. Grants are often used for temporary permissions because you // can create one, use its permissions, and delete it without changing your key // policies or IAM policies. For detailed information about grants, including grant -// terminology, see Grants in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the Key -// Management Service Developer Guide . For examples of working with grants in -// several programming languages, see Programming grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html). -// The CreateGrant operation returns a GrantToken and a GrantId. +// terminology, see Grants in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) +// in the Key Management Service Developer Guide . For examples of working with +// grants in several programming languages, see Programming grants (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html) +// . The CreateGrant operation returns a GrantToken and a GrantId . +// - When you create, retire, or revoke a grant, there might be a brief delay, +// usually less than five minutes, until the grant is available throughout KMS. +// This state is known as eventual consistency. Once the grant has achieved +// eventual consistency, the grantee principal can use the permissions in the grant +// without identifying the grant. However, to use the permissions in the grant +// immediately, use the GrantToken that CreateGrant returns. For details, see +// Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) +// in the Key Management Service Developer Guide . +// - The CreateGrant operation also returns a GrantId . You can use the GrantId +// and a key identifier to identify the grant in the RetireGrant and RevokeGrant +// operations. To find the grant ID, use the ListGrants or ListRetirableGrants +// operations. // -// * When you -// create, retire, or revoke a grant, there might be a brief delay, usually less -// than five minutes, until the grant is available throughout KMS. This state is -// known as eventual consistency. Once the grant has achieved eventual consistency, -// the grantee principal can use the permissions in the grant without identifying -// the grant. However, to use the permissions in the grant immediately, use the -// GrantToken that CreateGrant returns. For details, see Using a grant token -// (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) -// in the Key Management Service Developer Guide . -// -// * The CreateGrant operation -// also returns a GrantId. You can use the GrantId and a key identifier to identify -// the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, -// use the ListGrants or ListRetirableGrants operations. -// -// The KMS key that you use -// for this operation must be in a compatible key state. For details, see Key -// states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation on a KMS key in a different Amazon Web Services account, specify the -// key ARN in the value of the KeyId parameter. Required permissions: -// kms:CreateGrant -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation on a KMS key in a different Amazon Web Services account, +// specify the key ARN in the value of the KeyId parameter. Required permissions: +// kms:CreateGrant (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * ListGrants -// -// * ListRetirableGrants -// -// * -// RetireGrant -// -// * RevokeGrant +// - ListGrants +// - ListRetirableGrants +// - RetireGrant +// - RevokeGrant func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optFns ...func(*Options)) (*CreateGrantOutput, error) { if params == nil { params = &CreateGrantInput{} @@ -80,8 +67,7 @@ type CreateGrantInput struct { // grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services // principal. Valid principals include Amazon Web Services accounts, IAM users, IAM // roles, federated users, and assumed role users. For help with the ARN syntax for - // a principal, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // a principal, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) // in the Identity and Access Management User Guide . // // This member is required. @@ -91,14 +77,10 @@ type CreateGrantInput struct { // use this KMS key. Specify the key ID or key ARN of the KMS key. To specify a KMS // key in a different Amazon Web Services account, you must use the key ARN. For // example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -108,8 +90,7 @@ type CreateGrantInput struct { // on the KMS key. For example, you cannot create a grant for a symmetric // encryption KMS key that allows the Sign operation, or a grant for an asymmetric // KMS key that allows the GenerateDataKey operation. If you try, KMS returns a - // ValidationError exception. For details, see Grant operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations) + // ValidationError exception. For details, see Grant operations (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations) // in the Key Management Service Developer Guide. // // This member is required. @@ -118,20 +99,17 @@ type CreateGrantInput struct { // Specifies a grant constraint. KMS supports the EncryptionContextEquals and // EncryptionContextSubset grant constraints. Each constraint value can include up // to 8 encryption context pairs. The encryption context value in each constraint - // cannot exceed 384 characters. For information about grant constraints, see Using - // grant constraints - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints) + // cannot exceed 384 characters. For information about grant constraints, see + // Using grant constraints (https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints) // in the Key Management Service Developer Guide. For more information about - // encryption context, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // encryption context, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide . The encryption context grant // constraints allow the permissions in the grant only when the encryption context - // in the request matches (EncryptionContextEquals) or includes - // (EncryptionContextSubset) the encryption context specified in this structure. - // The encryption context grant constraints are supported only on grant operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations) - // that include an EncryptionContext parameter, such as cryptographic operations on - // symmetric encryption KMS keys. Grants with grant constraints can include the + // in the request matches ( EncryptionContextEquals ) or includes ( + // EncryptionContextSubset ) the encryption context specified in this structure. + // The encryption context grant constraints are supported only on grant operations (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations) + // that include an EncryptionContext parameter, such as cryptographic operations + // on symmetric encryption KMS keys. Grants with grant constraints can include the // DescribeKey and RetireGrant operations, but the constraint doesn't apply to // these operations. If a grant with a grant constraint includes the CreateGrant // operation, the constraint requires that any grants created with the CreateGrant @@ -143,37 +121,32 @@ type CreateGrantInput struct { // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string - // A friendly name for the grant. Use this value to prevent the unintended creation - // of duplicate grants when retrying this request. When this value is absent, all - // CreateGrant requests result in a new grant with a unique GrantId even if all the - // supplied parameters are identical. This can result in unintended duplicates when - // you retry the CreateGrant request. When this value is present, you can retry a - // CreateGrant request with identical parameters; if the grant already exists, the - // original GrantId is returned without creating a new grant. Note that the - // returned grant token is unique with every CreateGrant request, even when a - // duplicate GrantId is returned. All grant tokens for the same grant ID can be - // used interchangeably. + // A friendly name for the grant. Use this value to prevent the unintended + // creation of duplicate grants when retrying this request. When this value is + // absent, all CreateGrant requests result in a new grant with a unique GrantId + // even if all the supplied parameters are identical. This can result in unintended + // duplicates when you retry the CreateGrant request. When this value is present, + // you can retry a CreateGrant request with identical parameters; if the grant + // already exists, the original GrantId is returned without creating a new grant. + // Note that the returned grant token is unique with every CreateGrant request, + // even when a duplicate GrantId is returned. All grant tokens for the same grant + // ID can be used interchangeably. Name *string - // The principal that has permission to use the RetireGrant operation to retire the - // grant. To specify the principal, use the Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an Amazon Web Services principal. Valid principals include Amazon Web Services - // accounts, IAM users, IAM roles, federated users, and assumed role users. For - // help with the ARN syntax for a principal, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // The principal that has permission to use the RetireGrant operation to retire + // the grant. To specify the principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an Amazon Web Services principal. Valid principals include Amazon Web + // Services accounts, IAM users, IAM roles, federated users, and assumed role + // users. For help with the ARN syntax for a principal, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) // in the Identity and Access Management User Guide . The grant determines the // retiring principal. Other principals might have permission to retire the grant // or revoke the grant. For details, see RevokeGrant and Retiring and revoking - // grants - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) + // grants (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) // in the Key Management Service Developer Guide. RetiringPrincipal *string @@ -182,16 +155,14 @@ type CreateGrantInput struct { type CreateGrantOutput struct { - // The unique identifier for the grant. You can use the GrantId in a ListGrants, - // RetireGrant, or RevokeGrant operation. + // The unique identifier for the grant. You can use the GrantId in a ListGrants , + // RetireGrant , or RevokeGrant operation. GrantId *string // The grant token. Use a grant token when your permission to call this operation // comes from a new grant that has not yet achieved eventual consistency. For more - // information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantToken *string diff --git a/service/kms/api_op_CreateKey.go b/service/kms/api_op_CreateKey.go index 8adb0703b1a..1ef40261175 100644 --- a/service/kms/api_op_CreateKey.go +++ b/service/kms/api_op_CreateKey.go @@ -11,18 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a unique customer managed KMS key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys) +// Creates a unique customer managed KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys) // in your Amazon Web Services account and Region. You can use a KMS key in // cryptographic operations, such as encryption and signing. Some Amazon Web // Services services let you use KMS keys that you create and manage to protect // your service resources. A KMS key is a logical representation of a cryptographic // key. In addition to the key material used in cryptographic operations, a KMS key // includes metadata, such as the key ID, key policy, creation date, description, -// and key state. For details, see Managing keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in -// the Key Management Service Developer Guide Use the parameters of CreateKey to -// specify the type of KMS key, the source of its key material, its key policy, +// and key state. For details, see Managing keys (https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) +// in the Key Management Service Developer Guide Use the parameters of CreateKey +// to specify the type of KMS key, the source of its key material, its key policy, // description, tags, and other properties. KMS has replaced the term customer // master key (CMK) with KMS key and KMS key. The concept has not changed. To // prevent breaking changes, KMS is keeping some variations of this term. To create @@ -30,16 +28,16 @@ import ( // KMS key By default, CreateKey creates a symmetric encryption KMS key with key // material that KMS generates. This is the basic and most widely used type of KMS // key, and provides the best performance. To create a symmetric encryption KMS -// key, you don't need to specify any parameters. The default value for KeySpec, -// SYMMETRIC_DEFAULT, the default value for KeyUsage, ENCRYPT_DECRYPT, and the -// default value for Origin, AWS_KMS, create a symmetric encryption KMS key with +// key, you don't need to specify any parameters. The default value for KeySpec , +// SYMMETRIC_DEFAULT , the default value for KeyUsage , ENCRYPT_DECRYPT , and the +// default value for Origin , AWS_KMS , create a symmetric encryption KMS key with // KMS key material. If you need a key for basic encryption and decryption or you // are creating a KMS key to protect your resources in an Amazon Web Services // service, create a symmetric encryption KMS key. The key material in a symmetric // encryption key never leaves KMS unencrypted. You can use a symmetric encryption // KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically // used to generate data keys and data keys pairs. For details, see GenerateDataKey -// and GenerateDataKeyPair. Asymmetric KMS keys To create an asymmetric KMS key, +// and GenerateDataKeyPair . Asymmetric KMS keys To create an asymmetric KMS key, // use the KeySpec parameter to specify the type of key material in the KMS key. // Then, use the KeyUsage parameter to determine whether the KMS key will be used // to encrypt and decrypt or sign and verify. You can't change these properties @@ -50,29 +48,27 @@ import ( // outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or // decrypt data or sign and verify messages (but not both). KMS keys with ECC key // pairs can be used only to sign and verify messages. For information about -// asymmetric KMS keys, see Asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// asymmetric KMS keys, see Asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. HMAC KMS key To create an HMAC // KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then -// set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage +// set the KeyUsage parameter to GENERATE_VERIFY_MAC . You must set the key usage // even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS // keys. You can't change these properties after the KMS key is created. HMAC KMS // keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys -// to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to -// 4096 bytes. HMAC KMS keys are not supported in all Amazon Web Services Regions. -// If you try to create an HMAC KMS key in an Amazon Web Services Region in which -// HMAC keys are not supported, the CreateKey operation returns an -// UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are -// supported, see HMAC keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the Key -// Management Service Developer Guide. Multi-Region primary keys Imported key -// material To create a multi-Region primary key in the local Amazon Web Services -// Region, use the MultiRegion parameter with a value of True. To create a -// multi-Region replica key, that is, a KMS key with the same key ID and key -// material as a primary key, but in a different Amazon Web Services Region, use -// the ReplicateKey operation. To change a replica key to a primary key, and its -// primary key to a replica key, use the UpdatePrimaryRegion operation. You can -// create multi-Region KMS keys for all supported KMS key types: symmetric +// to generate ( GenerateMac ) and verify ( VerifyMac ) HMAC codes for messages up +// to 4096 bytes. HMAC KMS keys are not supported in all Amazon Web Services +// Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region +// in which HMAC keys are not supported, the CreateKey operation returns an +// UnsupportedOperationException . For a list of Regions in which HMAC KMS keys are +// supported, see HMAC keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) +// in the Key Management Service Developer Guide. Multi-Region primary keys +// Imported key material To create a multi-Region primary key in the local Amazon +// Web Services Region, use the MultiRegion parameter with a value of True . To +// create a multi-Region replica key, that is, a KMS key with the same key ID and +// key material as a primary key, but in a different Amazon Web Services Region, +// use the ReplicateKey operation. To change a replica key to a primary key, and +// its primary key to a replica key, use the UpdatePrimaryRegion operation. You +// can create multi-Region KMS keys for all supported KMS key types: symmetric // encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and // asymmetric signing KMS keys. You can also create multi-Region keys with imported // key material. However, you can't create multi-Region keys in a custom key store. @@ -82,36 +78,30 @@ import ( // you can use them interchangeably to encrypt data in one Amazon Web Services // Region and decrypt it in a different Amazon Web Services Region without // re-encrypting the data or making a cross-Region call. For more information about -// multi-Region keys, see Multi-Region keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) +// multi-Region keys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. To import your own key material // into a KMS key, begin by creating a symmetric encryption KMS key with no key // material. To do this, use the Origin parameter of CreateKey with a value of -// EXTERNAL. Next, use GetParametersForImport operation to get a public key and +// EXTERNAL . Next, use GetParametersForImport operation to get a public key and // import token, and use the public key to encrypt your key material. Then, use // ImportKeyMaterial with your import token to import the key material. For -// step-by-step instructions, see Importing Key Material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in -// the Key Management Service Developer Guide . This feature supports only +// step-by-step instructions, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// in the Key Management Service Developer Guide . This feature supports only // symmetric encryption KMS keys, including multi-Region symmetric encryption KMS // keys. You cannot import key material into any other type of KMS key. To create a -// multi-Region primary key with imported key material, use the Origin parameter of -// CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of -// True. To create replicas of the multi-Region primary key, use the ReplicateKey -// operation. For instructions, see Importing key material into multi-Region keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html). -// For more information about multi-Region keys, see Multi-Region keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) +// multi-Region primary key with imported key material, use the Origin parameter +// of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a +// value of True . To create replicas of the multi-Region primary key, use the +// ReplicateKey operation. For instructions, see Importing key material into +// multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html) +// . For more information about multi-Region keys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. Custom key store A custom key -// store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // lets you protect your Amazon Web Services resources using keys in a backing key // store that you own and manage. When you request a cryptographic operation with a // KMS key in a custom key store, the operation is performed in the backing key -// store using its cryptographic keys. KMS supports CloudHSM key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) -// backed by an CloudHSM cluster and external key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) +// store using its cryptographic keys. KMS supports CloudHSM key stores (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) +// backed by an CloudHSM cluster and external key stores (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) // backed by an external key manager outside of Amazon Web Services. When you // create a KMS key in an CloudHSM key store, KMS generates an encryption key in // the CloudHSM cluster and associates it with the KMS key. When you create a KMS @@ -119,39 +109,30 @@ import ( // external key manager. Some external key managers provide a simpler method for // creating a KMS key in an external key store. For details, see your external key // manager documentation. Before you create a KMS key in a custom key store, the -// ConnectionState of the key store must be CONNECTED. To connect the custom key -// store, use the ConnectCustomKeyStore operation. To find the ConnectionState, use -// the DescribeCustomKeyStores operation. To create a KMS key in a custom key -// store, use the CustomKeyStoreId. Use the default KeySpec value, -// SYMMETRIC_DEFAULT, and the default KeyUsage value, ENCRYPT_DECRYPT to create a +// ConnectionState of the key store must be CONNECTED . To connect the custom key +// store, use the ConnectCustomKeyStore operation. To find the ConnectionState , +// use the DescribeCustomKeyStores operation. To create a KMS key in a custom key +// store, use the CustomKeyStoreId . Use the default KeySpec value, +// SYMMETRIC_DEFAULT , and the default KeyUsage value, ENCRYPT_DECRYPT to create a // symmetric encryption key. No other key type is supported in a custom key store. -// To create a KMS key in an CloudHSM key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html), -// use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that -// is associated with the custom key store must have at least two active HSMs in -// different Availability Zones in the Amazon Web Services Region. To create a KMS -// key in an external key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html), -// use the Origin parameter with a value of EXTERNAL_KEY_STORE and an XksKeyId +// To create a KMS key in an CloudHSM key store (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) +// , use the Origin parameter with a value of AWS_CLOUDHSM . The CloudHSM cluster +// that is associated with the custom key store must have at least two active HSMs +// in different Availability Zones in the Amazon Web Services Region. To create a +// KMS key in an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) +// , use the Origin parameter with a value of EXTERNAL_KEY_STORE and an XksKeyId // parameter that identifies an existing external key. Some external key managers // provide a simpler method for creating a KMS key in an external key store. For // details, see your external key manager documentation. Cross-account use: No. You // cannot use this operation to create a KMS key in a different Amazon Web Services -// account. Required permissions: kms:CreateKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// (IAM policy). To use the Tags parameter, kms:TagResource -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// account. Required permissions: kms:CreateKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// (IAM policy). To use the Tags parameter, kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy). For examples and information about related permissions, see Allow -// a user to create KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key) +// a user to create KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key) // in the Key Management Service Developer Guide. Related operations: -// -// * -// DescribeKey -// -// * ListKeys -// -// * ScheduleKeyDeletion +// - DescribeKey +// - ListKeys +// - ScheduleKeyDeletion func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error) { if params == nil { params = &CreateKeyInput{} @@ -172,16 +153,14 @@ type CreateKeyInput struct { // Skips ("bypasses") the key policy lockout safety check. The default value is // false. Setting this value to true increases the risk that the KMS key becomes // unmanageable. Do not set this value to true indiscriminately. For more - // information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) // in the Key Management Service Developer Guide. Use this parameter only when you // intend to prevent the principal that is making the request from making a // subsequent PutKeyPolicy request on the KMS key. BypassPolicyLockoutSafetyCheck bool - // Creates the KMS key in the specified custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). - // The ConnectionState of the custom key store must be CONNECTED. To find the + // Creates the KMS key in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // . The ConnectionState of the custom key store must be CONNECTED . To find the // CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation. // This parameter is valid only for symmetric encryption KMS keys in a single // Region. You cannot create any other type of KMS key in a custom key store. When @@ -204,113 +183,74 @@ type CreateKeyInput struct { // A description of the KMS key. Use a description that helps you decide whether // the KMS key is appropriate for a task. The default value is an empty string (no // description). To set or change the description after the key is created, use - // UpdateKeyDescription. + // UpdateKeyDescription . Description *string - // Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, + // Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT , // creates a KMS key with a 256-bit AES-GCM key that is used for encryption and // decryption, except in China Regions, where it creates a 128-bit symmetric key // that uses SM4 encryption. For help choosing a key spec for your KMS key, see - // Choosing a KMS key type - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose) + // Choosing a KMS key type (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose) // in the Key Management Service Developer Guide . The KeySpec determines whether // the KMS key contains a symmetric key or an asymmetric key pair. It also // determines the algorithms that the KMS key supports. You can't change the // KeySpec after the KMS key is created. To further restrict the algorithms that // can be used with the KMS key, use a condition key in its key policy or IAM - // policy. For more information, see kms:EncryptionAlgorithm - // (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm), - // kms:MacAlgorithm - // (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm) - // or kms:Signing Algorithm - // (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) + // policy. For more information, see kms:EncryptionAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm) + // , kms:MacAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm) + // or kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) // in the Key Management Service Developer Guide . Amazon Web Services services - // that are integrated with KMS - // (http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric - // encryption KMS keys to protect your data. These services do not support - // asymmetric KMS keys or HMAC KMS keys. KMS supports the following key specs for - // KMS keys: - // - // * Symmetric encryption key (default) - // - // * SYMMETRIC_DEFAULT - // - // * HMAC - // keys (symmetric) - // - // * HMAC_224 - // - // * HMAC_256 - // - // * HMAC_384 - // - // * HMAC_512 - // - // * Asymmetric - // RSA key pairs - // - // * RSA_2048 - // - // * RSA_3072 - // - // * RSA_4096 - // - // * Asymmetric NIST-recommended - // elliptic curve key pairs - // - // * ECC_NIST_P256 (secp256r1) - // - // * ECC_NIST_P384 - // (secp384r1) - // - // * ECC_NIST_P521 (secp521r1) - // - // * Other asymmetric elliptic curve key - // pairs - // - // * ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies. - // - // * SM2 - // key pairs (China Regions only) - // - // * SM2 + // that are integrated with KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration) + // use symmetric encryption KMS keys to protect your data. These services do not + // support asymmetric KMS keys or HMAC KMS keys. KMS supports the following key + // specs for KMS keys: + // - Symmetric encryption key (default) + // - SYMMETRIC_DEFAULT + // - HMAC keys (symmetric) + // - HMAC_224 + // - HMAC_256 + // - HMAC_384 + // - HMAC_512 + // - Asymmetric RSA key pairs + // - RSA_2048 + // - RSA_3072 + // - RSA_4096 + // - Asymmetric NIST-recommended elliptic curve key pairs + // - ECC_NIST_P256 (secp256r1) + // - ECC_NIST_P384 (secp384r1) + // - ECC_NIST_P521 (secp521r1) + // - Other asymmetric elliptic curve key pairs + // - ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies. + // - SM2 key pairs (China Regions only) + // - SM2 KeySpec types.KeySpec - // Determines the cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) - // for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This + // Determines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // for which you can use the KMS key. The default value is ENCRYPT_DECRYPT . This // parameter is optional when you are creating a symmetric encryption KMS key; - // otherwise, it is required. You can't change the KeyUsage value after the KMS key - // is created. Select only one valid value. - // - // * For symmetric encryption KMS keys, - // omit the parameter or specify ENCRYPT_DECRYPT. - // - // * For HMAC KMS keys (symmetric), - // specify GENERATE_VERIFY_MAC. - // - // * For asymmetric KMS keys with RSA key material, - // specify ENCRYPT_DECRYPT or SIGN_VERIFY. - // - // * For asymmetric KMS keys with ECC key - // material, specify SIGN_VERIFY. - // - // * For asymmetric KMS keys with SM2 key material - // (China Regions only), specify ENCRYPT_DECRYPT or SIGN_VERIFY. + // otherwise, it is required. You can't change the KeyUsage value after the KMS + // key is created. Select only one valid value. + // - For symmetric encryption KMS keys, omit the parameter or specify + // ENCRYPT_DECRYPT . + // - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC . + // - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or + // SIGN_VERIFY . + // - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY . + // - For asymmetric KMS keys with SM2 key material (China Regions only), specify + // ENCRYPT_DECRYPT or SIGN_VERIFY . KeyUsage types.KeyUsageType // Creates a multi-Region primary key that you can replicate into other Amazon Web // Services Regions. You cannot change this value after you create the KMS key. For - // a multi-Region key, set this parameter to True. For a single-Region KMS key, - // omit this parameter or set it to False. The default value is False. This + // a multi-Region key, set this parameter to True . For a single-Region KMS key, + // omit this parameter or set it to False . The default value is False . This // operation supports multi-Region keys, an KMS feature that lets you create // multiple interoperable KMS keys in different Amazon Web Services Regions. // Because these KMS keys have the same key ID, key material, and other metadata, // you can use them interchangeably to encrypt data in one Amazon Web Services // Region and decrypt it in a different Amazon Web Services Region without // re-encrypting the data or making a cross-Region call. For more information about - // multi-Region keys, see Multi-Region keys in KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // multi-Region keys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. This value creates a primary key, // not a replica. To create a replica key, use the ReplicateKey operation. You can // create a symmetric or asymmetric multi-Region key, and you can create a @@ -319,65 +259,50 @@ type CreateKeyInput struct { MultiRegion *bool // The source of the key material for the KMS key. You cannot change the origin - // after you create the KMS key. The default is AWS_KMS, which means that KMS - // creates the key material. To create a KMS key with no key material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) - // (for imported key material), set this value to EXTERNAL. For more information - // about importing key material into KMS, see Importing Key Material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in - // the Key Management Service Developer Guide. The EXTERNAL origin value is valid - // only for symmetric KMS keys. To create a KMS key in an CloudHSM key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html) + // after you create the KMS key. The default is AWS_KMS , which means that KMS + // creates the key material. To create a KMS key with no key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) + // (for imported key material), set this value to EXTERNAL . For more information + // about importing key material into KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) + // in the Key Management Service Developer Guide. The EXTERNAL origin value is + // valid only for symmetric KMS keys. To create a KMS key in an CloudHSM key store (https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html) // and create its key material in the associated CloudHSM cluster, set this value - // to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify - // the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT. To create a - // KMS key in an external key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html), - // set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId + // to AWS_CLOUDHSM . You must also use the CustomKeyStoreId parameter to identify + // the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT . To create + // a KMS key in an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html) + // , set this value to EXTERNAL_KEY_STORE . You must also use the CustomKeyStoreId // parameter to identify the external key store and the XksKeyId parameter to // identify the associated external key. The KeySpec value must be - // SYMMETRIC_DEFAULT. + // SYMMETRIC_DEFAULT . Origin types.OriginType // The key policy to attach to the KMS key. If you provide a key policy, it must // meet the following criteria: - // - // * The key policy must allow the calling principal - // to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk - // that the KMS key becomes unmanageable. For more information, see Default key - // policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) - // in the Key Management Service Developer Guide. (To omit this condition, set - // BypassPolicyLockoutSafetyCheck to true.) - // - // * Each statement in the key policy - // must contain one or more principals. The principals in the key policy must exist - // and be visible to KMS. When you create a new Amazon Web Services principal, you - // might need to enforce a delay before including the new principal in a key policy - // because the new principal might not be immediately visible to KMS. For more - // information, see Changes that I make are not always immediately visible - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) - // in the Amazon Web Services Identity and Access Management User Guide. - // - // If you do - // not provide a key policy, KMS attaches a default key policy to the KMS key. For - // more information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) + // - The key policy must allow the calling principal to make a subsequent + // PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key + // becomes unmanageable. For more information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // in the Key Management Service Developer Guide. (To omit this condition, set + // BypassPolicyLockoutSafetyCheck to true.) + // - Each statement in the key policy must contain one or more principals. The + // principals in the key policy must exist and be visible to KMS. When you create a + // new Amazon Web Services principal, you might need to enforce a delay before + // including the new principal in a key policy because the new principal might not + // be immediately visible to KMS. For more information, see Changes that I make + // are not always immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) + // in the Amazon Web Services Identity and Access Management User Guide. + // If you do not provide a key policy, KMS attaches a default key policy to the + // KMS key. For more information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) // in the Key Management Service Developer Guide. The key policy size quota is 32 // kilobytes (32768 bytes). For help writing and formatting a JSON policy document, - // see the IAM JSON Policy Reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in - // the Identity and Access Management User Guide . + // see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // in the Identity and Access Management User Guide . Policy *string // Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key // when it is created. To tag an existing KMS key, use the TagResource operation. // Tagging or untagging a KMS key can allow or deny permission to the KMS key. For - // details, see ABAC for KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key - // Management Service Developer Guide. To use this parameter, you must have - // kms:TagResource - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) + // details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) + // in the Key Management Service Developer Guide. To use this parameter, you must + // have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // permission in an IAM policy. Each tag consists of a tag key and a tag value. // Both the tag key and the tag value are required, but the tag value can be an // empty (null) string. You cannot have more than one tag on a KMS key with the @@ -385,34 +310,29 @@ type CreateKeyInput struct { // replaces the current tag value with the specified one. When you add tags to an // Amazon Web Services resource, Amazon Web Services generates a cost allocation // report with usage and costs aggregated by tags. Tags can also be used to control - // access to a KMS key. For details, see Tagging Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). + // access to a KMS key. For details, see Tagging Keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) + // . Tags []types.Tag - // Identifies the external key - // (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) - // that serves as key material for the KMS key in an external key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html). - // Specify the ID that the external key store proxy - // (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy) + // Identifies the external key (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) + // that serves as key material for the KMS key in an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) + // . Specify the ID that the external key store proxy (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy) // uses to refer to the external key. For help, see the documentation for your // external key store proxy. This parameter is required for a KMS key with an - // Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other + // Origin value of EXTERNAL_KEY_STORE . It is not valid for KMS keys with any other // Origin value. The external key must be an existing 256-bit AES symmetric // encryption key hosted outside of Amazon Web Services in an external key manager // associated with the external key store specified by the CustomKeyStoreId // parameter. This key must be enabled and configured to perform encryption and // decryption. Each KMS key in an external key store must use a different external - // key. For details, see Requirements for a KMS key in an external key store - // (https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements) in the - // Key Management Service Developer Guide. Each KMS key in an external key store is - // associated two backing keys. One is key material that KMS generates. The other - // is the external key specified by this parameter. When you use the KMS key in an - // external key store to encrypt data, the encryption operation is performed first - // by KMS using the KMS key material, and then by the external key manager using - // the specified external key, a process known as double encryption. For details, - // see Double encryption - // (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption) + // key. For details, see Requirements for a KMS key in an external key store (https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements) + // in the Key Management Service Developer Guide. Each KMS key in an external key + // store is associated two backing keys. One is key material that KMS generates. + // The other is the external key specified by this parameter. When you use the KMS + // key in an external key store to encrypt data, the encryption operation is + // performed first by KMS using the KMS key material, and then by the external key + // manager using the specified external key, a process known as double encryption. + // For details, see Double encryption (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption) // in the Key Management Service Developer Guide. XksKeyId *string diff --git a/service/kms/api_op_Decrypt.go b/service/kms/api_op_Decrypt.go index 8c587a84389..7e51cd85a84 100644 --- a/service/kms/api_op_Decrypt.go +++ b/service/kms/api_op_Decrypt.go @@ -13,75 +13,57 @@ import ( // Decrypts ciphertext that was encrypted by a KMS key using any of the following // operations: +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPair +// - GenerateDataKeyWithoutPlaintext +// - GenerateDataKeyPairWithoutPlaintext // -// * Encrypt -// -// * GenerateDataKey -// -// * GenerateDataKeyPair -// -// * -// GenerateDataKeyWithoutPlaintext -// -// * GenerateDataKeyPairWithoutPlaintext -// -// You can -// use this operation to decrypt ciphertext that was encrypted under a symmetric -// encryption KMS key or an asymmetric encryption KMS key. When the KMS key is -// asymmetric, you must specify the KMS key and the encryption algorithm that was -// used to encrypt the ciphertext. For information about asymmetric KMS keys, see -// Asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// You can use this operation to decrypt ciphertext that was encrypted under a +// symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS +// key is asymmetric, you must specify the KMS key and the encryption algorithm +// that was used to encrypt the ciphertext. For information about asymmetric KMS +// keys, see Asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. The Decrypt operation also // decrypts ciphertext that was encrypted outside of KMS by the public key in an // KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced -// by other libraries, such as the Amazon Web Services Encryption SDK -// (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) or Amazon -// S3 client-side encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). -// These libraries return a ciphertext format that is incompatible with KMS. If the -// ciphertext was encrypted under a symmetric encryption KMS key, the KeyId +// by other libraries, such as the Amazon Web Services Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) +// or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) +// . These libraries return a ciphertext format that is incompatible with KMS. If +// the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId // parameter is optional. KMS can get this information from metadata that it adds // to the symmetric ciphertext blob. This feature adds durability to your // implementation by ensuring that authorized users can decrypt ciphertext decades // after it was encrypted, even if they've lost track of the key ID. However, // specifying the KMS key is always recommended as a best practice. When you use -// the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. -// If the ciphertext was encrypted under a different KMS key, the Decrypt operation -// fails. This practice ensures that you use the KMS key that you intend. Whenever -// possible, use key policies to give users permission to call the Decrypt +// the KeyId parameter to specify a KMS key, KMS only uses the KMS key you +// specify. If the ciphertext was encrypted under a different KMS key, the Decrypt +// operation fails. This practice ensures that you use the KMS key that you intend. +// Whenever possible, use key policies to give users permission to call the Decrypt // operation on a particular KMS key, instead of using &IAM; policies. Otherwise, // you might create an &IAM; policy that gives the user Decrypt permission on all // KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in // other accounts if the key policy for the cross-account KMS key permits it. If -// you must use an IAM policy for Decrypt permissions, limit the user to particular -// KMS keys or particular trusted accounts. For details, see Best practices for IAM -// policies -// (https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices) +// you must use an IAM policy for Decrypt permissions, limit the user to +// particular KMS keys or particular trusted accounts. For details, see Best +// practices for IAM policies (https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices) // in the Key Management Service Developer Guide. Applications in Amazon Web -// Services Nitro Enclaves can call this operation by using the Amazon Web Services -// Nitro Enclaves Development Kit -// (https://github.com/aws/aws-nitro-enclaves-sdk-c). For information about the -// supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) +// Services Nitro Enclaves can call this operation by using the Amazon Web +// Services Nitro Enclaves Development Kit (https://github.com/aws/aws-nitro-enclaves-sdk-c) +// . For information about the supporting parameters, see How Amazon Web Services +// Nitro Enclaves use KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: Yes. If you use // the KeyId parameter to identify a KMS key in a different Amazon Web Services // account, specify the key ARN or the alias ARN of the KMS key. Required -// permissions: kms:Decrypt -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permissions: kms:Decrypt (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Encrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPair -// -// * ReEncrypt +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPair +// - ReEncrypt func (c *Client) Decrypt(ctx context.Context, params *DecryptInput, optFns ...func(*Options)) (*DecryptOutput, error) { if params == nil { params = &DecryptInput{} @@ -108,13 +90,12 @@ type DecryptInput struct { // Specify the same algorithm that was used to encrypt the data. If you specify a // different algorithm, the Decrypt operation fails. This parameter is required // only when the ciphertext was encrypted under an asymmetric KMS key. The default - // value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid + // value, SYMMETRIC_DEFAULT , represents the only supported algorithm that is valid // for symmetric encryption KMS keys. EncryptionAlgorithm types.EncryptionAlgorithmSpec // Specifies the encryption context to use when decrypting the data. An encryption - // context is valid only for cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // context is valid only for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // with a symmetric encryption KMS key. The standard asymmetric encryption // algorithms and HMAC algorithms that KMS uses do not support an encryption // context. An encryption context is a collection of non-secret key-value pairs @@ -123,47 +104,35 @@ type DecryptInput struct { // encryption context to decrypt the data. An encryption context is supported only // on operations with symmetric encryption KMS keys. On operations with symmetric // encryption KMS keys, an encryption context is optional, but it is strongly - // recommended. For more information, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // recommended. For more information, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string - // Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a key ID of - // the KMS key that was used to encrypt the ciphertext. If you identify a different - // KMS key, the Decrypt operation throws an IncorrectKeyException. This parameter - // is required only when the ciphertext was encrypted under an asymmetric KMS key. - // If you used a symmetric encryption KMS key, KMS can get the KMS key from - // metadata that it adds to the symmetric ciphertext blob. However, it is always - // recommended as a best practice. This practice ensures that you use the KMS key - // that you intend. To specify a KMS key, use its key ID, key ARN, alias name, or - // alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS - // key in a different Amazon Web Services account, you must use the key ARN or - // alias ARN. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a key ID + // of the KMS key that was used to encrypt the ciphertext. If you identify a + // different KMS key, the Decrypt operation throws an IncorrectKeyException . This + // parameter is required only when the ciphertext was encrypted under an asymmetric + // KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key + // from metadata that it adds to the symmetric ciphertext blob. However, it is + // always recommended as a best practice. This practice ensures that you use the + // KMS key that you intend. To specify a KMS key, use its key ID, key ARN, alias + // name, or alias ARN. When using an alias name, prefix it with "alias/" . To + // specify a KMS key in a different Amazon Web Services account, you must use the + // key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . KeyId *string noSmithyDocumentSerde @@ -174,9 +143,8 @@ type DecryptOutput struct { // The encryption algorithm that was used to decrypt the ciphertext. EncryptionAlgorithm types.EncryptionAlgorithmSpec - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that was used to decrypt the ciphertext. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that was used to decrypt the ciphertext. KeyId *string // Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services diff --git a/service/kms/api_op_DeleteAlias.go b/service/kms/api_op_DeleteAlias.go index 1609069b962..bc8e60a1933 100644 --- a/service/kms/api_op_DeleteAlias.go +++ b/service/kms/api_op_DeleteAlias.go @@ -10,37 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified alias. Adding, deleting, or updating an alias can allow or -// deny permission to the KMS key. For details, see ABAC for KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key -// Management Service Developer Guide. Because an alias is not a property of a KMS -// key, you can delete and change the aliases of a KMS key without affecting the -// KMS key. Also, aliases do not appear in the response from the DescribeKey -// operation. To get the aliases of all KMS keys, use the ListAliases operation. -// Each KMS key can have multiple aliases. To change the alias of a KMS key, use -// DeleteAlias to delete the current alias and CreateAlias to create a new alias. -// To associate an existing alias with a different KMS key, call UpdateAlias. -// Cross-account use: No. You cannot perform this operation on an alias in a -// different Amazon Web Services account. Required permissions +// Deletes the specified alias. Adding, deleting, or updating an alias can allow +// or deny permission to the KMS key. For details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) +// in the Key Management Service Developer Guide. Because an alias is not a +// property of a KMS key, you can delete and change the aliases of a KMS key +// without affecting the KMS key. Also, aliases do not appear in the response from +// the DescribeKey operation. To get the aliases of all KMS keys, use the +// ListAliases operation. Each KMS key can have multiple aliases. To change the +// alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias +// to create a new alias. To associate an existing alias with a different KMS key, +// call UpdateAlias . Cross-account use: No. You cannot perform this operation on +// an alias in a different Amazon Web Services account. Required permissions +// - kms:DeleteAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the alias (IAM policy). +// - kms:DeleteAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the KMS key (key policy). // -// * kms:DeleteAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the alias (IAM policy). -// -// * kms:DeleteAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the KMS key (key policy). -// -// For details, see Controlling access to aliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) +// For details, see Controlling access to aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) // in the Key Management Service Developer Guide. Related operations: -// -// * -// CreateAlias -// -// * ListAliases -// -// * UpdateAlias +// - CreateAlias +// - ListAliases +// - UpdateAlias func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error) { if params == nil { params = &DeleteAliasInput{} @@ -59,7 +49,7 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { // The alias to be deleted. The alias name must begin with alias/ followed by the - // alias name, such as alias/ExampleAlias. + // alias name, such as alias/ExampleAlias . // // This member is required. AliasName *string diff --git a/service/kms/api_op_DeleteCustomKeyStore.go b/service/kms/api_op_DeleteCustomKeyStore.go index 9bf7bcbce39..c3a1544f112 100644 --- a/service/kms/api_op_DeleteCustomKeyStore.go +++ b/service/kms/api_op_DeleteCustomKeyStore.go @@ -10,29 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). -// This operation does not affect any backing elements of the custom key store. It -// does not delete the CloudHSM cluster that is associated with an CloudHSM key +// Deletes a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// . This operation does not affect any backing elements of the custom key store. +// It does not delete the CloudHSM cluster that is associated with an CloudHSM key // store, or affect any users or keys in the cluster. For an external key store, it // does not affect the external key store proxy, external key manager, or any -// external keys. This operation is part of the custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// external keys. This operation is part of the custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. The -// custom key store that you delete cannot contain any KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). -// Before deleting the key store, verify that you will never need to use any of the -// KMS keys in the key store for any cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). -// Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. After -// the required waiting period expires and all KMS keys are deleted from the custom -// key store, use DisconnectCustomKeyStore to disconnect the key store from KMS. -// Then, you can delete the custom key store. For keys in an CloudHSM key store, -// the ScheduleKeyDeletion operation makes a best effort to delete the key material -// from the associated cluster. However, you might need to manually delete the -// orphaned key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) +// custom key store that you delete cannot contain any KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) +// . Before deleting the key store, verify that you will never need to use any of +// the KMS keys in the key store for any cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// . Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. +// After the required waiting period expires and all KMS keys are deleted from the +// custom key store, use DisconnectCustomKeyStore to disconnect the key store from +// KMS. Then, you can delete the custom key store. For keys in an CloudHSM key +// store, the ScheduleKeyDeletion operation makes a best effort to delete the key +// material from the associated cluster. However, you might need to manually +// delete the orphaned key material (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) // from the cluster and its backups. KMS never creates, manages, or deletes // cryptographic keys in the external key manager associated with an external key // store. You must manage them using your external key manager tools. Instead of @@ -43,21 +38,13 @@ import ( // disconnected custom key store at any time. If the operation succeeds, it returns // a JSON object with no properties. Cross-account use: No. You cannot perform this // operation on a custom key store in a different Amazon Web Services account. -// Required permissions: kms:DeleteCustomKeyStore -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DeleteCustomKeyStore (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations: -// -// * ConnectCustomKeyStore -// -// * -// CreateCustomKeyStore -// -// * DescribeCustomKeyStores -// -// * DisconnectCustomKeyStore -// -// * -// UpdateCustomKeyStore +// - ConnectCustomKeyStore +// - CreateCustomKeyStore +// - DescribeCustomKeyStores +// - DisconnectCustomKeyStore +// - UpdateCustomKeyStore func (c *Client) DeleteCustomKeyStore(ctx context.Context, params *DeleteCustomKeyStoreInput, optFns ...func(*Options)) (*DeleteCustomKeyStoreOutput, error) { if params == nil { params = &DeleteCustomKeyStoreInput{} diff --git a/service/kms/api_op_DeleteImportedKeyMaterial.go b/service/kms/api_op_DeleteImportedKeyMaterial.go index 7f8839b963f..1d3d4a48792 100644 --- a/service/kms/api_op_DeleteImportedKeyMaterial.go +++ b/service/kms/api_op_DeleteImportedKeyMaterial.go @@ -12,24 +12,19 @@ import ( // Deletes key material that you previously imported. This operation makes the // specified KMS key unusable. For more information about importing key material -// into KMS, see Importing Key Material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in -// the Key Management Service Developer Guide. When the specified KMS key is in the -// PendingDeletion state, this operation does not change the KMS key's state. -// Otherwise, it changes the KMS key's state to PendingImport. After you delete key -// material, you can use ImportKeyMaterial to reimport the same key material into -// the KMS key. The KMS key that you use for this operation must be in a compatible -// key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// into KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// in the Key Management Service Developer Guide. When the specified KMS key is in +// the PendingDeletion state, this operation does not change the KMS key's state. +// Otherwise, it changes the KMS key's state to PendingImport . After you delete +// key material, you can use ImportKeyMaterial to reimport the same key material +// into the KMS key. The KMS key that you use for this operation must be in a +// compatible key state. For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:DeleteImportedKeyMaterial -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DeleteImportedKeyMaterial (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * GetParametersForImport -// -// * ImportKeyMaterial +// - GetParametersForImport +// - ImportKeyMaterial func (c *Client) DeleteImportedKeyMaterial(ctx context.Context, params *DeleteImportedKeyMaterialInput, optFns ...func(*Options)) (*DeleteImportedKeyMaterialOutput, error) { if params == nil { params = &DeleteImportedKeyMaterialInput{} @@ -48,16 +43,12 @@ func (c *Client) DeleteImportedKeyMaterial(ctx context.Context, params *DeleteIm type DeleteImportedKeyMaterialInput struct { // Identifies the KMS key from which you are deleting imported key material. The - // Origin of the KMS key must be EXTERNAL. Specify the key ID or key ARN of the KMS - // key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // Origin of the KMS key must be EXTERNAL . Specify the key ID or key ARN of the + // KMS key. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_DescribeCustomKeyStores.go b/service/kms/api_op_DescribeCustomKeyStores.go index 3dfd2f9c163..46163ca137d 100644 --- a/service/kms/api_op_DescribeCustomKeyStores.go +++ b/service/kms/api_op_DescribeCustomKeyStores.go @@ -12,22 +12,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) -// in the account and Region. This operation is part of the custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// Gets information about custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// in the account and Region. This operation is part of the custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. By // default, this operation returns information about all custom key stores in the // account and Region. To get only information about a particular custom key store, // use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both). // To determine whether the custom key store is connected to its CloudHSM cluster -// or external key store proxy, use the ConnectionState element in the response. If -// an attempt to connect the custom key store failed, the ConnectionState value is -// FAILED and the ConnectionErrorCode element in the response indicates the cause -// of the failure. For help interpreting the ConnectionErrorCode, see -// CustomKeyStoresListEntry. Custom key stores have a DISCONNECTED connection state -// if the key store has never been connected or you used the +// or external key store proxy, use the ConnectionState element in the response. +// If an attempt to connect the custom key store failed, the ConnectionState value +// is FAILED and the ConnectionErrorCode element in the response indicates the +// cause of the failure. For help interpreting the ConnectionErrorCode , see +// CustomKeyStoresListEntry . Custom key stores have a DISCONNECTED connection +// state if the key store has never been connected or you used the // DisconnectCustomKeyStore operation to disconnect it. Otherwise, the connection // state is CONNECTED. If your custom key store connection state is CONNECTED but // you are having trouble using it, verify that the backing store is active and @@ -36,28 +34,18 @@ import ( // operation, if any. For an external key store, verify that the external key store // proxy and its associated external key manager are reachable and enabled. For // help repairing your CloudHSM key store, see the Troubleshooting CloudHSM key -// stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html). For -// help repairing your external key store, see the Troubleshooting external key -// stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html). -// Both topics are in the Key Management Service Developer Guide. Cross-account +// stores (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) +// . For help repairing your external key store, see the Troubleshooting external +// key stores (https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html) +// . Both topics are in the Key Management Service Developer Guide. Cross-account // use: No. You cannot perform this operation on a custom key store in a different -// Amazon Web Services account. Required permissions: kms:DescribeCustomKeyStores -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Amazon Web Services account. Required permissions: kms:DescribeCustomKeyStores (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations: -// -// * ConnectCustomKeyStore -// -// * -// CreateCustomKeyStore -// -// * DeleteCustomKeyStore -// -// * DisconnectCustomKeyStore -// -// * -// UpdateCustomKeyStore +// - ConnectCustomKeyStore +// - CreateCustomKeyStore +// - DeleteCustomKeyStore +// - DisconnectCustomKeyStore +// - UpdateCustomKeyStore func (c *Client) DescribeCustomKeyStores(ctx context.Context, params *DescribeCustomKeyStoresInput, optFns ...func(*Options)) (*DescribeCustomKeyStoresOutput, error) { if params == nil { params = &DescribeCustomKeyStoresInput{} @@ -95,8 +83,8 @@ type DescribeCustomKeyStoresInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde diff --git a/service/kms/api_op_DescribeKey.go b/service/kms/api_op_DescribeKey.go index 09613a7b024..8ad76f57e94 100644 --- a/service/kms/api_op_DescribeKey.go +++ b/service/kms/api_op_DescribeKey.go @@ -12,64 +12,45 @@ import ( ) // Provides detailed information about a KMS key. You can run DescribeKey on a -// customer managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) -// or an Amazon Web Services managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). -// This detailed information includes the key ARN, creation date (and deletion +// customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// or an Amazon Web Services managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// . This detailed information includes the key ARN, creation date (and deletion // date, if applicable), the key state, and the origin and expiration date (if any) -// of the key material. It includes fields, like KeySpec, that help you distinguish -// different types of KMS keys. It also displays the key usage (encryption, -// signing, or generating and verifying MACs) and the algorithms that the KMS key -// supports. For multi-Region keys, DescribeKey displays the primary key and all -// related replica keys. For KMS keys in CloudHSM key stores, it includes -// information about the key store, such as the key store ID and the CloudHSM -// cluster ID. For KMS keys in external key stores, it includes the custom key -// store ID and the ID of the external key. DescribeKey does not return the -// following information: +// of the key material. It includes fields, like KeySpec , that help you +// distinguish different types of KMS keys. It also displays the key usage +// (encryption, signing, or generating and verifying MACs) and the algorithms that +// the KMS key supports. For multi-Region keys , DescribeKey displays the primary +// key and all related replica keys. For KMS keys in CloudHSM key stores , it +// includes information about the key store, such as the key store ID and the +// CloudHSM cluster ID. For KMS keys in external key stores , it includes the +// custom key store ID and the ID of the external key. DescribeKey does not return +// the following information: +// - Aliases associated with the KMS key. To get this information, use +// ListAliases . +// - Whether automatic key rotation is enabled on the KMS key. To get this +// information, use GetKeyRotationStatus . Also, some key states prevent a KMS +// key from being automatically rotated. For details, see How Automatic Key +// Rotation Works (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works) +// in the Key Management Service Developer Guide. +// - Tags on the KMS key. To get this information, use ListResourceTags . +// - Key policies and grants on the KMS key. To get this information, use +// GetKeyPolicy and ListGrants . // -// * Aliases associated with the KMS key. To get this -// information, use ListAliases. -// -// * Whether automatic key rotation is enabled on -// the KMS key. To get this information, use GetKeyRotationStatus. Also, some key -// states prevent a KMS key from being automatically rotated. For details, see How -// Automatic Key Rotation Works -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works) -// in the Key Management Service Developer Guide. -// -// * Tags on the KMS key. To get -// this information, use ListResourceTags. -// -// * Key policies and grants on the KMS -// key. To get this information, use GetKeyPolicy and ListGrants. -// -// In general, -// DescribeKey is a non-mutating operation. It returns data about KMS keys, but -// doesn't change them. However, Amazon Web Services services use DescribeKey to -// create Amazon Web Services managed keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// In general, DescribeKey is a non-mutating operation. It returns data about KMS +// keys, but doesn't change them. However, Amazon Web Services services use +// DescribeKey to create Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) // from a predefined Amazon Web Services alias with no key ID. Cross-account use: // Yes. To perform this operation with a KMS key in a different Amazon Web Services // account, specify the key ARN or alias ARN in the value of the KeyId parameter. -// Required permissions: kms:DescribeKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DescribeKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * GetKeyPolicy -// -// * GetKeyRotationStatus -// -// * -// ListAliases -// -// * ListGrants -// -// * ListKeys -// -// * ListResourceTags -// -// * ListRetirableGrants +// - GetKeyPolicy +// - GetKeyRotationStatus +// - ListAliases +// - ListGrants +// - ListKeys +// - ListResourceTags +// - ListRetirableGrants func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optFns ...func(*Options)) (*DescribeKeyOutput, error) { if params == nil { params = &DescribeKeyInput{} @@ -87,40 +68,28 @@ func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optF type DescribeKeyInput struct { - // Describes the specified KMS key. If you specify a predefined Amazon Web Services - // alias (an Amazon Web Services alias with no key ID), KMS associates the alias - // with an Amazon Web Services managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk) - // and returns its KeyId and Arn in the response. To specify a KMS key, use its key - // ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with - // "alias/". To specify a KMS key in a different Amazon Web Services account, you - // must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // Describes the specified KMS key. If you specify a predefined Amazon Web + // Services alias (an Amazon Web Services alias with no key ID), KMS associates the + // alias with an Amazon Web Services managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk) + // and returns its KeyId and Arn in the response. To specify a KMS key, use its + // key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it + // with "alias/" . To specify a KMS key in a different Amazon Web Services account, + // you must use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string diff --git a/service/kms/api_op_DisableKey.go b/service/kms/api_op_DisableKey.go index 066f679ef09..4ff7d24956f 100644 --- a/service/kms/api_op_DisableKey.go +++ b/service/kms/api_op_DisableKey.go @@ -10,19 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the state of a KMS key to disabled. This change temporarily prevents use of -// the KMS key for cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). -// For more information about how key state affects the use of a KMS key, see Key -// states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide . The KMS key that you use for this -// operation must be in a compatible key state. For details, see Key states of KMS -// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in -// the Key Management Service Developer Guide. Cross-account use: No. You cannot +// Sets the state of a KMS key to disabled. This change temporarily prevents use +// of the KMS key for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// . For more information about how key state affects the use of a KMS key, see +// Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide . The KMS key that you use for +// this operation must be in a compatible key state. For details, see Key states +// of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:DisableKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DisableKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: EnableKey func (c *Client) DisableKey(ctx context.Context, params *DisableKeyInput, optFns ...func(*Options)) (*DisableKeyOutput, error) { if params == nil { @@ -41,16 +38,12 @@ func (c *Client) DisableKey(ctx context.Context, params *DisableKeyInput, optFns type DisableKeyInput struct { - // Identifies the KMS key to disable. Specify the key ID or key ARN of the KMS key. - // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // Identifies the KMS key to disable. Specify the key ID or key ARN of the KMS + // key. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_DisableKeyRotation.go b/service/kms/api_op_DisableKeyRotation.go index 003e50230a1..27e991a4ab8 100644 --- a/service/kms/api_op_DisableKeyRotation.go +++ b/service/kms/api_op_DisableKeyRotation.go @@ -10,41 +10,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables automatic rotation of the key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) of the -// specified symmetric encryption KMS key. Automatic key rotation is supported only -// on symmetric encryption KMS keys. You cannot enable automatic rotation of -// asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html), -// HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html), -// KMS keys with imported key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or -// KMS keys in a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). -// To enable or disable automatic rotation of a set of related multi-Region keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate), -// set the property on the primary key. You can enable (EnableKeyRotation) and -// disable automatic rotation of the key material in customer managed KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). -// Key material rotation of Amazon Web Services managed KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// Disables automatic rotation of the key material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) +// of the specified symmetric encryption KMS key. Automatic key rotation is +// supported only on symmetric encryption KMS keys. You cannot enable automatic +// rotation of asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// , HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) +// , KMS keys with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// , or KMS keys in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// . To enable or disable automatic rotation of a set of related multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) +// , set the property on the primary key. You can enable ( EnableKeyRotation ) and +// disable automatic rotation of the key material in customer managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// . Key material rotation of Amazon Web Services managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) // is not configurable. KMS always rotates the key material for every year. -// Rotation of Amazon Web Services owned KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) +// Rotation of Amazon Web Services owned KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) // varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services // managed keys from every three years to every year. For details, see -// EnableKeyRotation. The KMS key that you use for this operation must be in a -// compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// EnableKeyRotation . The KMS key that you use for this operation must be in a +// compatible key state. For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:DisableKeyRotation -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DisableKeyRotation (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * EnableKeyRotation -// -// * GetKeyRotationStatus +// - EnableKeyRotation +// - GetKeyRotationStatus func (c *Client) DisableKeyRotation(ctx context.Context, params *DisableKeyRotationInput, optFns ...func(*Options)) (*DisableKeyRotationOutput, error) { if params == nil { params = &DisableKeyRotationInput{} @@ -63,23 +51,15 @@ func (c *Client) DisableKeyRotation(ctx context.Context, params *DisableKeyRotat type DisableKeyRotationInput struct { // Identifies a symmetric encryption KMS key. You cannot enable or disable - // automatic rotation of asymmetric KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks), - // HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html), - // KMS keys with imported key material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or - // KMS keys in a custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). - // Specify the key ID or key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // automatic rotation of asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks) + // , HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) + // , KMS keys with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) + // , or KMS keys in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // . Specify the key ID or key ARN of the KMS key. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_DisconnectCustomKeyStore.go b/service/kms/api_op_DisconnectCustomKeyStore.go index c4f2441be16..747734e896f 100644 --- a/service/kms/api_op_DisconnectCustomKeyStore.go +++ b/service/kms/api_op_DisconnectCustomKeyStore.go @@ -10,43 +10,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disconnects the custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// Disconnects the custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // from its backing key store. This operation disconnects an CloudHSM key store // from its associated CloudHSM cluster or disconnects an external key store from // the external key store proxy that communicates with your external key manager. -// This operation is part of the custom key stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// This operation is part of the custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. While a // custom key store is disconnected, you can manage the custom key store and its // KMS keys, but you cannot create or use its KMS keys. You can reconnect the // custom key store at any time. While a custom key store is disconnected, all // attempts to create KMS keys in the custom key store or to use existing KMS keys -// in cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// in cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // will fail. This action can prevent users from storing and accessing sensitive // data. When you disconnect a custom key store, its ConnectionState changes to -// Disconnected. To find the connection state of a custom key store, use the +// Disconnected . To find the connection state of a custom key store, use the // DescribeCustomKeyStores operation. To reconnect a custom key store, use the // ConnectCustomKeyStore operation. If the operation succeeds, it returns a JSON // object with no properties. Cross-account use: No. You cannot perform this // operation on a custom key store in a different Amazon Web Services account. -// Required permissions: kms:DisconnectCustomKeyStore -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:DisconnectCustomKeyStore (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations: -// -// * ConnectCustomKeyStore -// -// * -// CreateCustomKeyStore -// -// * DeleteCustomKeyStore -// -// * DescribeCustomKeyStores -// -// * -// UpdateCustomKeyStore +// - ConnectCustomKeyStore +// - CreateCustomKeyStore +// - DeleteCustomKeyStore +// - DescribeCustomKeyStores +// - UpdateCustomKeyStore func (c *Client) DisconnectCustomKeyStore(ctx context.Context, params *DisconnectCustomKeyStoreInput, optFns ...func(*Options)) (*DisconnectCustomKeyStoreOutput, error) { if params == nil { params = &DisconnectCustomKeyStoreInput{} @@ -64,8 +53,8 @@ func (c *Client) DisconnectCustomKeyStore(ctx context.Context, params *Disconnec type DisconnectCustomKeyStoreInput struct { - // Enter the ID of the custom key store you want to disconnect. To find the ID of a - // custom key store, use the DescribeCustomKeyStores operation. + // Enter the ID of the custom key store you want to disconnect. To find the ID of + // a custom key store, use the DescribeCustomKeyStores operation. // // This member is required. CustomKeyStoreId *string diff --git a/service/kms/api_op_EnableKey.go b/service/kms/api_op_EnableKey.go index f44645321a4..2e122e22003 100644 --- a/service/kms/api_op_EnableKey.go +++ b/service/kms/api_op_EnableKey.go @@ -11,15 +11,12 @@ import ( ) // Sets the key state of a KMS key to enabled. This allows you to use the KMS key -// for cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). -// The KMS key that you use for this operation must be in a compatible key state. -// For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// . The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:EnableKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:EnableKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: DisableKey func (c *Client) EnableKey(ctx context.Context, params *EnableKeyInput, optFns ...func(*Options)) (*EnableKeyOutput, error) { if params == nil { @@ -40,14 +37,10 @@ type EnableKeyInput struct { // Identifies the KMS key to enable. Specify the key ID or key ARN of the KMS key. // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_EnableKeyRotation.go b/service/kms/api_op_EnableKeyRotation.go index 0a7b6bbeb76..d0ec598668d 100644 --- a/service/kms/api_op_EnableKeyRotation.go +++ b/service/kms/api_op_EnableKeyRotation.go @@ -10,33 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables automatic rotation of the key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) of the -// specified symmetric encryption KMS key. When you enable automatic rotation of -// acustomer managed KMS key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk), -// KMS rotates the key material of the KMS key one year (approximately 365 days) +// Enables automatic rotation of the key material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) +// of the specified symmetric encryption KMS key. When you enable automatic +// rotation of a customer managed KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// , KMS rotates the key material of the KMS key one year (approximately 365 days) // from the enable date and every year thereafter. You can monitor rotation of the // key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable // rotation of the key material in a customer managed KMS key, use the // DisableKeyRotation operation. Automatic key rotation is supported only on -// symmetric encryption KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks). -// You cannot enable automatic rotation of asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html), -// HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html), -// KMS keys with imported key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or -// KMS keys in a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). -// To enable or disable automatic rotation of a set of related multi-Region keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate), -// set the property on the primary key. You cannot enable or disable automatic -// rotation Amazon Web Services managed KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). -// KMS always rotates the key material of Amazon Web Services managed keys every -// year. Rotation of Amazon Web Services owned KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) +// symmetric encryption KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) +// . You cannot enable automatic rotation of asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// , HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) +// , KMS keys with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// , or KMS keys in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// . To enable or disable automatic rotation of a set of related multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) +// , set the property on the primary key. You cannot enable or disable automatic +// rotation Amazon Web Services managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// . KMS always rotates the key material of Amazon Web Services managed keys every +// year. Rotation of Amazon Web Services owned KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) // varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services // managed keys from every three years (approximately 1,095 days) to every year // (approximately 365 days). New Amazon Web Services managed keys are automatically @@ -44,17 +35,13 @@ import ( // thereafter. Existing Amazon Web Services managed keys are automatically rotated // one year after their most recent rotation, and every year thereafter. The KMS // key that you use for this operation must be in a compatible key state. For -// details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:EnableKeyRotation -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:EnableKeyRotation (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * DisableKeyRotation -// -// * GetKeyRotationStatus +// - DisableKeyRotation +// - GetKeyRotationStatus func (c *Client) EnableKeyRotation(ctx context.Context, params *EnableKeyRotationInput, optFns ...func(*Options)) (*EnableKeyRotationOutput, error) { if params == nil { params = &EnableKeyRotationInput{} @@ -73,25 +60,17 @@ func (c *Client) EnableKeyRotation(ctx context.Context, params *EnableKeyRotatio type EnableKeyRotationInput struct { // Identifies a symmetric encryption KMS key. You cannot enable automatic rotation - // of asymmetric KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html), - // HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html), - // KMS keys with imported key material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or - // KMS keys in a custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). - // To enable or disable automatic rotation of a set of related multi-Region keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate), - // set the property on the primary key. Specify the key ID or key ARN of the KMS + // of asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // , HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) + // , KMS keys with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) + // , or KMS keys in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // . To enable or disable automatic rotation of a set of related multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) + // , set the property on the primary key. Specify the key ID or key ARN of the KMS // key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_Encrypt.go b/service/kms/api_op_Encrypt.go index e5faf29e331..2eab28956c7 100644 --- a/service/kms/api_op_Encrypt.go +++ b/service/kms/api_op_Encrypt.go @@ -11,19 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric -// or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT. You can use this -// operation to encrypt small amounts of arbitrary data, such as a personal +// Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a +// symmetric or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT . You can use +// this operation to encrypt small amounts of arbitrary data, such as a personal // identifier or database password, or other sensitive information. You don't need // to use the Encrypt operation to encrypt a data key. The GenerateDataKey and // GenerateDataKeyPair operations return a plaintext data key and an encrypted copy // of that data key. If you use a symmetric encryption KMS key, you can use an // encryption context to add additional security to your encryption operation. If -// you specify an EncryptionContext when encrypting data, you must specify the same -// encryption context (a case-sensitive exact match) when decrypting the data. -// Otherwise, the request to decrypt fails with an InvalidCiphertextException. For -// more information, see Encryption Context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// you specify an EncryptionContext when encrypting data, you must specify the +// same encryption context (a case-sensitive exact match) when decrypting the data. +// Otherwise, the request to decrypt fails with an InvalidCiphertextException . For +// more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. If you specify an asymmetric KMS // key, you must also specify the encryption algorithm. The algorithm must be // compatible with the KMS key spec. When you use an asymmetric KMS key to encrypt @@ -37,52 +36,29 @@ import ( // asymmetric keys. The standard format for asymmetric key ciphertext does not // include configurable fields. The maximum size of the data that you can encrypt // varies with the type of KMS key and the encryption algorithm that you choose. -// -// * -// Symmetric encryption KMS keys -// -// * SYMMETRIC_DEFAULT: 4096 bytes -// -// * RSA_2048 -// -// * -// RSAES_OAEP_SHA_1: 214 bytes -// -// * RSAES_OAEP_SHA_256: 190 bytes -// -// * RSA_3072 -// -// * -// RSAES_OAEP_SHA_1: 342 bytes -// -// * RSAES_OAEP_SHA_256: 318 bytes -// -// * RSA_4096 -// -// * -// RSAES_OAEP_SHA_1: 470 bytes -// -// * RSAES_OAEP_SHA_256: 446 bytes -// -// * SM2PKE: 1024 -// bytes (China Regions only) -// -// The KMS key that you use for this operation must be -// in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation with a KMS key in a different Amazon Web Services account, specify the -// key ARN or alias ARN in the value of the KeyId parameter. Required permissions: -// kms:Encrypt -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// - Symmetric encryption KMS keys +// - SYMMETRIC_DEFAULT : 4096 bytes +// - RSA_2048 +// - RSAES_OAEP_SHA_1 : 214 bytes +// - RSAES_OAEP_SHA_256 : 190 bytes +// - RSA_3072 +// - RSAES_OAEP_SHA_1 : 342 bytes +// - RSAES_OAEP_SHA_256 : 318 bytes +// - RSA_4096 +// - RSAES_OAEP_SHA_1 : 470 bytes +// - RSAES_OAEP_SHA_256 : 446 bytes +// - SM2PKE : 1024 bytes (China Regions only) +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation with a KMS key in a different Amazon Web Services +// account, specify the key ARN or alias ARN in the value of the KeyId parameter. +// Required permissions: kms:Encrypt (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Decrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPair +// - Decrypt +// - GenerateDataKey +// - GenerateDataKeyPair func (c *Client) Encrypt(ctx context.Context, params *EncryptInput, optFns ...func(*Options)) (*EncryptOutput, error) { if params == nil { params = &EncryptInput{} @@ -100,28 +76,19 @@ func (c *Client) Encrypt(ctx context.Context, params *EncryptInput, optFns ...fu type EncryptInput struct { - // Identifies the KMS key to use in the encryption operation. The KMS key must have - // a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the + // Identifies the KMS key to use in the encryption operation. The KMS key must + // have a KeyUsage of ENCRYPT_DECRYPT . To find the KeyUsage of a KMS key, use the // DescribeKey operation. To specify a KMS key, use its key ID, key ARN, alias - // name, or alias ARN. When using an alias name, prefix it with "alias/". To + // name, or alias ARN. When using an alias name, prefix it with "alias/" . To // specify a KMS key in a different Amazon Web Services account, you must use the // key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string @@ -134,14 +101,13 @@ type EncryptInput struct { // Specifies the encryption algorithm that KMS will use to encrypt the plaintext // message. The algorithm must be compatible with the KMS key that you specify. // This parameter is required only for asymmetric KMS keys. The default value, - // SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If + // SYMMETRIC_DEFAULT , is the algorithm used for symmetric encryption KMS keys. If // you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. The SM2PKE // algorithm is only available in China Regions. EncryptionAlgorithm types.EncryptionAlgorithmSpec // Specifies the encryption context that will be used to encrypt the data. An - // encryption context is valid only for cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // encryption context is valid only for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // with a symmetric encryption KMS key. The standard asymmetric encryption // algorithms and HMAC algorithms that KMS uses do not support an encryption // context. An encryption context is a collection of non-secret key-value pairs @@ -150,17 +116,14 @@ type EncryptInput struct { // encryption context to decrypt the data. An encryption context is supported only // on operations with symmetric encryption KMS keys. On operations with symmetric // encryption KMS keys, an encryption context is optional, but it is strongly - // recommended. For more information, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // recommended. For more information, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -176,9 +139,8 @@ type EncryptOutput struct { // The encryption algorithm that was used to encrypt the plaintext. EncryptionAlgorithm types.EncryptionAlgorithmSpec - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that was used to encrypt the plaintext. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that was used to encrypt the plaintext. KeyId *string // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_GenerateDataKey.go b/service/kms/api_op_GenerateDataKey.go index 3bfee7886b1..4f4bd61f12d 100644 --- a/service/kms/api_op_GenerateDataKey.go +++ b/service/kms/api_op_GenerateDataKey.go @@ -19,77 +19,60 @@ import ( // key with the encrypted data. To generate a data key, specify the symmetric // encryption KMS key that will be used to encrypt the data key. You cannot use an // asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use -// the DescribeKey operation. You must also specify the length of the data key. Use -// either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and -// 256-bit data keys, use the KeySpec parameter. To generate a 128-bit SM4 data key -// (China Regions only), specify a KeySpec value of AES_128 or a NumberOfBytes -// value of 16. The symmetric encryption key used in China Regions to encrypt your -// data key is an SM4 encryption key. To get only an encrypted copy of the data -// key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key -// pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext -// operation. To get a cryptographically secure random byte string, use -// GenerateRandom. You can use an optional encryption context to add additional -// security to the encryption operation. If you specify an EncryptionContext, you -// must specify the same encryption context (a case-sensitive exact match) when -// decrypting the encrypted data key. Otherwise, the request to decrypt fails with -// an InvalidCiphertextException. For more information, see Encryption Context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// the DescribeKey operation. You must also specify the length of the data key. +// Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit +// and 256-bit data keys, use the KeySpec parameter. To generate a 128-bit SM4 +// data key (China Regions only), specify a KeySpec value of AES_128 or a +// NumberOfBytes value of 16 . The symmetric encryption key used in China Regions +// to encrypt your data key is an SM4 encryption key. To get only an encrypted copy +// of the data key, use GenerateDataKeyWithoutPlaintext . To generate an asymmetric +// data key pair, use the GenerateDataKeyPair or +// GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure +// random byte string, use GenerateRandom . You can use an optional encryption +// context to add additional security to the encryption operation. If you specify +// an EncryptionContext , you must specify the same encryption context (a +// case-sensitive exact match) when decrypting the encrypted data key. Otherwise, +// the request to decrypt fails with an InvalidCiphertextException . For more +// information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. Applications in Amazon Web -// Services Nitro Enclaves can call this operation by using the Amazon Web Services -// Nitro Enclaves Development Kit -// (https://github.com/aws/aws-nitro-enclaves-sdk-c). For information about the -// supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) +// Services Nitro Enclaves can call this operation by using the Amazon Web +// Services Nitro Enclaves Development Kit (https://github.com/aws/aws-nitro-enclaves-sdk-c) +// . For information about the supporting parameters, see How Amazon Web Services +// Nitro Enclaves use KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. How to use your data key We // recommend that you use the following pattern to encrypt data locally in your // application. You can write your own code or use a client-side encryption -// library, such as the Amazon Web Services Encryption SDK -// (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/), the Amazon -// DynamoDB Encryption Client -// (https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/), or -// Amazon S3 client-side encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) +// library, such as the Amazon Web Services Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) +// , the Amazon DynamoDB Encryption Client (https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/) +// , or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) // to do these tasks for you. To encrypt data outside of KMS: // -// * Use the -// GenerateDataKey operation to get a data key. +// - Use the GenerateDataKey operation to get a data key. // -// * Use the plaintext data key (in -// the Plaintext field of the response) to encrypt your data outside of KMS. Then -// erase the plaintext data key from memory. +// - Use the plaintext data key (in the Plaintext field of the response) to +// encrypt your data outside of KMS. Then erase the plaintext data key from memory. // -// * Store the encrypted data key (in -// the CiphertextBlob field of the response) with the encrypted data. +// - Store the encrypted data key (in the CiphertextBlob field of the response) +// with the encrypted data. // -// To decrypt -// data outside of KMS: +// To decrypt data outside of KMS: +// - Use the Decrypt operation to decrypt the encrypted data key. The operation +// returns a plaintext copy of the data key. +// - Use the plaintext data key to decrypt data outside of KMS, then erase the +// plaintext data key from memory. // -// * Use the Decrypt operation to decrypt the encrypted data -// key. The operation returns a plaintext copy of the data key. -// -// * Use the -// plaintext data key to decrypt data outside of KMS, then erase the plaintext data -// key from memory. -// -// Cross-account use: Yes. To perform this operation with a KMS -// key in a different Amazon Web Services account, specify the key ARN or alias ARN -// in the value of the KeyId parameter. Required permissions: kms:GenerateDataKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Cross-account use: Yes. To perform this operation with a KMS key in a different +// Amazon Web Services account, specify the key ARN or alias ARN in the value of +// the KeyId parameter. Required permissions: kms:GenerateDataKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Decrypt -// -// * Encrypt -// -// * GenerateDataKeyPair -// -// * -// GenerateDataKeyPairWithoutPlaintext -// -// * GenerateDataKeyWithoutPlaintext +// - Decrypt +// - Encrypt +// - GenerateDataKeyPair +// - GenerateDataKeyPairWithoutPlaintext +// - GenerateDataKeyWithoutPlaintext func (c *Client) GenerateDataKey(ctx context.Context, params *GenerateDataKeyInput, optFns ...func(*Options)) (*GenerateDataKeyOutput, error) { if params == nil { params = &GenerateDataKeyInput{} @@ -109,48 +92,36 @@ type GenerateDataKeyInput struct { // Specifies the symmetric encryption KMS key that encrypts the data key. You // cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get - // the type and origin of your KMS key, use the DescribeKey operation. To specify a - // KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias - // name, prefix it with "alias/". To specify a KMS key in a different Amazon Web - // Services account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // the type and origin of your KMS key, use the DescribeKey operation. To specify + // a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an + // alias name, prefix it with "alias/" . To specify a KMS key in a different Amazon + // Web Services account, you must use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string - // Specifies the encryption context that will be used when encrypting the data key. - // An encryption context is a collection of non-secret key-value pairs that + // Specifies the encryption context that will be used when encrypting the data + // key. An encryption context is a collection of non-secret key-value pairs that // represent additional authenticated data. When you use an encryption context to // encrypt data, you must specify the same (an exact case-sensitive match) // encryption context to decrypt the data. An encryption context is supported only // on operations with symmetric encryption KMS keys. On operations with symmetric // encryption KMS keys, an encryption context is optional, but it is strongly - // recommended. For more information, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // recommended. For more information, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -176,9 +147,8 @@ type GenerateDataKeyOutput struct { // Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob []byte - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that encrypted the data key. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that encrypted the data key. KeyId *string // The plaintext data key. When you use the HTTP API or the Amazon Web Services diff --git a/service/kms/api_op_GenerateDataKeyPair.go b/service/kms/api_op_GenerateDataKeyPair.go index f67b704cc0c..d47f80048dc 100644 --- a/service/kms/api_op_GenerateDataKeyPair.go +++ b/service/kms/api_op_GenerateDataKeyPair.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a unique asymmetric data key pair for use outside of KMS. This operation -// returns a plaintext public key, a plaintext private key, and a copy of the -// private key that is encrypted under the symmetric encryption KMS key you +// Returns a unique asymmetric data key pair for use outside of KMS. This +// operation returns a plaintext public key, a plaintext private key, and a copy of +// the private key that is encrypted under the symmetric encryption KMS key you // specify. You can use the data key pair to perform asymmetric cryptography and // implement digital signatures outside of KMS. The bytes in the keys are random; // they not related to the caller or to the KMS key that is used to encrypt the @@ -24,50 +24,42 @@ import ( // generate a data key pair, you must specify a symmetric encryption KMS key to // encrypt the private key in a data key pair. You cannot use an asymmetric KMS key // or a KMS key in a custom key store. To get the type and origin of your KMS key, -// use the DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA or -// Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 -// data key pair. KMS recommends that you use ECC key pairs for signing, and use -// RSA and SM2 key pairs for either encryption or signing, but not both. However, -// KMS cannot enforce any restrictions on the use of data key pairs outside of KMS. -// If you are using the data key pair to encrypt data, or for any operation where -// you don't immediately need a private key, consider using the +// use the DescribeKey operation. Use the KeyPairSpec parameter to choose an RSA +// or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an +// SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and +// use RSA and SM2 key pairs for either encryption or signing, but not both. +// However, KMS cannot enforce any restrictions on the use of data key pairs +// outside of KMS. If you are using the data key pair to encrypt data, or for any +// operation where you don't immediately need a private key, consider using the // GenerateDataKeyPairWithoutPlaintext operation. // GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an // encrypted private key, but omits the plaintext private key that you need only to // decrypt ciphertext or sign a message. Later, when you need to decrypt the data // or sign a message, use the Decrypt operation to decrypt the encrypted private -// key in the data key pair. GenerateDataKeyPair returns a unique data key pair for -// each request. The bytes in the keys are random; they are not related to the +// key in the data key pair. GenerateDataKeyPair returns a unique data key pair +// for each request. The bytes in the keys are random; they are not related to the // caller or the KMS key that is used to encrypt the private key. The public key is -// a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280 -// (https://tools.ietf.org/html/rfc5280). The private key is a DER-encoded PKCS8 -// PrivateKeyInfo, as specified in RFC 5958 (https://tools.ietf.org/html/rfc5958). -// You can use an optional encryption context to add additional security to the -// encryption operation. If you specify an EncryptionContext, you must specify the -// same encryption context (a case-sensitive exact match) when decrypting the -// encrypted data key. Otherwise, the request to decrypt fails with an -// InvalidCiphertextException. For more information, see Encryption Context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280 (https://tools.ietf.org/html/rfc5280) +// . The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC +// 5958 (https://tools.ietf.org/html/rfc5958) . You can use an optional encryption +// context to add additional security to the encryption operation. If you specify +// an EncryptionContext , you must specify the same encryption context (a +// case-sensitive exact match) when decrypting the encrypted data key. Otherwise, +// the request to decrypt fails with an InvalidCiphertextException . For more +// information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: Yes. To perform // this operation with a KMS key in a different Amazon Web Services account, // specify the key ARN or alias ARN in the value of the KeyId parameter. Required -// permissions: kms:GenerateDataKeyPair -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permissions: kms:GenerateDataKeyPair (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Decrypt -// -// * Encrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPairWithoutPlaintext -// -// * GenerateDataKeyWithoutPlaintext +// - Decrypt +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPairWithoutPlaintext +// - GenerateDataKeyWithoutPlaintext func (c *Client) GenerateDataKeyPair(ctx context.Context, params *GenerateDataKeyPairInput, optFns ...func(*Options)) (*GenerateDataKeyPairOutput, error) { if params == nil { params = &GenerateDataKeyPairInput{} @@ -89,24 +81,16 @@ type GenerateDataKeyPairInput struct { // data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom // key store. To get the type and origin of your KMS key, use the DescribeKey // operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias - // ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in + // ARN. When using an alias name, prefix it with "alias/" . To specify a KMS key in // a different Amazon Web Services account, you must use the key ARN or alias ARN. // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string @@ -128,17 +112,14 @@ type GenerateDataKeyPairInput struct { // context is supported only on operations with symmetric encryption KMS keys. On // operations with symmetric encryption KMS keys, an encryption context is // optional, but it is strongly recommended. For more information, see Encryption - // context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -147,9 +128,8 @@ type GenerateDataKeyPairInput struct { type GenerateDataKeyPairOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that encrypted the private key. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that encrypted the private key. KeyId *string // The type of data key pair that was generated. diff --git a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go index dc68638f205..875b3b98455 100644 --- a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a unique asymmetric data key pair for use outside of KMS. This operation -// returns a plaintext public key and a copy of the private key that is encrypted -// under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, -// this operation does not return a plaintext private key. The bytes in the keys -// are random; they are not related to the caller or to the KMS key that is used to -// encrypt the private key. You can use the public key that +// Returns a unique asymmetric data key pair for use outside of KMS. This +// operation returns a plaintext public key and a copy of the private key that is +// encrypted under the symmetric encryption KMS key you specify. Unlike +// GenerateDataKeyPair , this operation does not return a plaintext private key. +// The bytes in the keys are random; they are not related to the caller or to the +// KMS key that is used to encrypt the private key. You can use the public key that // GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a // signature outside of KMS. Then, store the encrypted private key with the data. // When you are ready to decrypt data or sign a message, you can use the Decrypt @@ -32,34 +32,25 @@ import ( // GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each // request. The bytes in the key are not related to the caller or KMS key that is // used to encrypt the private key. The public key is a DER-encoded X.509 -// SubjectPublicKeyInfo, as specified in RFC 5280 -// (https://tools.ietf.org/html/rfc5280). You can use an optional encryption -// context to add additional security to the encryption operation. If you specify -// an EncryptionContext, you must specify the same encryption context (a -// case-sensitive exact match) when decrypting the encrypted data key. Otherwise, -// the request to decrypt fails with an InvalidCiphertextException. For more -// information, see Encryption Context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// SubjectPublicKeyInfo, as specified in RFC 5280 (https://tools.ietf.org/html/rfc5280) +// . You can use an optional encryption context to add additional security to the +// encryption operation. If you specify an EncryptionContext , you must specify the +// same encryption context (a case-sensitive exact match) when decrypting the +// encrypted data key. Otherwise, the request to decrypt fails with an +// InvalidCiphertextException . For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: Yes. To perform // this operation with a KMS key in a different Amazon Web Services account, // specify the key ARN or alias ARN in the value of the KeyId parameter. Required -// permissions: kms:GenerateDataKeyPairWithoutPlaintext -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permissions: kms:GenerateDataKeyPairWithoutPlaintext (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Decrypt -// -// * Encrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPair -// -// * GenerateDataKeyWithoutPlaintext +// - Decrypt +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPair +// - GenerateDataKeyWithoutPlaintext func (c *Client) GenerateDataKeyPairWithoutPlaintext(ctx context.Context, params *GenerateDataKeyPairWithoutPlaintextInput, optFns ...func(*Options)) (*GenerateDataKeyPairWithoutPlaintextOutput, error) { if params == nil { params = &GenerateDataKeyPairWithoutPlaintextInput{} @@ -81,24 +72,16 @@ type GenerateDataKeyPairWithoutPlaintextInput struct { // data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom // key store. To get the type and origin of your KMS key, use the DescribeKey // operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias - // ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in + // ARN. When using an alias name, prefix it with "alias/" . To specify a KMS key in // a different Amazon Web Services account, you must use the key ARN or alias ARN. // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string @@ -120,17 +103,14 @@ type GenerateDataKeyPairWithoutPlaintextInput struct { // context is supported only on operations with symmetric encryption KMS keys. On // operations with symmetric encryption KMS keys, an encryption context is // optional, but it is strongly recommended. For more information, see Encryption - // context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -139,9 +119,8 @@ type GenerateDataKeyPairWithoutPlaintextInput struct { type GenerateDataKeyPairWithoutPlaintextOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that encrypted the private key. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that encrypted the private key. KeyId *string // The type of data key pair that was generated. diff --git a/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go b/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go index 06a49b6eac6..2d3da795bb7 100644 --- a/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go @@ -26,44 +26,36 @@ import ( // decrypts the data key, uses the plaintext data key to encrypt data, puts the // encrypted data into the container, and then destroys the plaintext data key. In // this system, the component that creates the containers never sees the plaintext -// data key. To request an asymmetric data key pair, use the GenerateDataKeyPair or -// GenerateDataKeyPairWithoutPlaintext operations. To generate a data key, you must -// specify the symmetric encryption KMS key that is used to encrypt the data key. -// You cannot use an asymmetric KMS key or a key in a custom key store to generate -// a data key. To get the type of your KMS key, use the DescribeKey operation. You -// must also specify the length of the data key. Use either the KeySpec or -// NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use -// the KeySpec parameter. To generate an SM4 data key (China Regions only), specify -// a KeySpec value of AES_128 or NumberOfBytes value of 128. The symmetric -// encryption key used in China Regions to encrypt your data key is an SM4 -// encryption key. If the operation succeeds, you will find the encrypted copy of -// the data key in the CiphertextBlob field. You can use an optional encryption -// context to add additional security to the encryption operation. If you specify -// an EncryptionContext, you must specify the same encryption context (a -// case-sensitive exact match) when decrypting the encrypted data key. Otherwise, -// the request to decrypt fails with an InvalidCiphertextException. For more -// information, see Encryption Context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// data key. To request an asymmetric data key pair, use the GenerateDataKeyPair +// or GenerateDataKeyPairWithoutPlaintext operations. To generate a data key, you +// must specify the symmetric encryption KMS key that is used to encrypt the data +// key. You cannot use an asymmetric KMS key or a key in a custom key store to +// generate a data key. To get the type of your KMS key, use the DescribeKey +// operation. You must also specify the length of the data key. Use either the +// KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit +// data keys, use the KeySpec parameter. To generate an SM4 data key (China +// Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 128 +// . The symmetric encryption key used in China Regions to encrypt your data key is +// an SM4 encryption key. If the operation succeeds, you will find the encrypted +// copy of the data key in the CiphertextBlob field. You can use an optional +// encryption context to add additional security to the encryption operation. If +// you specify an EncryptionContext , you must specify the same encryption context +// (a case-sensitive exact match) when decrypting the encrypted data key. +// Otherwise, the request to decrypt fails with an InvalidCiphertextException . For +// more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: Yes. To perform // this operation with a KMS key in a different Amazon Web Services account, // specify the key ARN or alias ARN in the value of the KeyId parameter. Required -// permissions: kms:GenerateDataKeyWithoutPlaintext -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permissions: kms:GenerateDataKeyWithoutPlaintext (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * Decrypt -// -// * Encrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPair -// -// * GenerateDataKeyPairWithoutPlaintext +// - Decrypt +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPair +// - GenerateDataKeyPairWithoutPlaintext func (c *Client) GenerateDataKeyWithoutPlaintext(ctx context.Context, params *GenerateDataKeyWithoutPlaintextInput, optFns ...func(*Options)) (*GenerateDataKeyWithoutPlaintextOutput, error) { if params == nil { params = &GenerateDataKeyWithoutPlaintextInput{} @@ -83,48 +75,36 @@ type GenerateDataKeyWithoutPlaintextInput struct { // Specifies the symmetric encryption KMS key that encrypts the data key. You // cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get - // the type and origin of your KMS key, use the DescribeKey operation. To specify a - // KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias - // name, prefix it with "alias/". To specify a KMS key in a different Amazon Web - // Services account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // the type and origin of your KMS key, use the DescribeKey operation. To specify + // a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an + // alias name, prefix it with "alias/" . To specify a KMS key in a different Amazon + // Web Services account, you must use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string - // Specifies the encryption context that will be used when encrypting the data key. - // An encryption context is a collection of non-secret key-value pairs that + // Specifies the encryption context that will be used when encrypting the data + // key. An encryption context is a collection of non-secret key-value pairs that // represent additional authenticated data. When you use an encryption context to // encrypt data, you must specify the same (an exact case-sensitive match) // encryption context to decrypt the data. An encryption context is supported only // on operations with symmetric encryption KMS keys. On operations with symmetric // encryption KMS keys, an encryption context is optional, but it is strongly - // recommended. For more information, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // recommended. For more information, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. EncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -132,8 +112,8 @@ type GenerateDataKeyWithoutPlaintextInput struct { // AES_256 to generate a 256-bit symmetric key. KeySpec types.DataKeySpec - // The length of the data key in bytes. For example, use the value 64 to generate a - // 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and + // The length of the data key in bytes. For example, use the value 64 to generate + // a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and // 256-bit symmetric keys), we recommend that you use the KeySpec field instead of // this one. NumberOfBytes *int32 @@ -147,9 +127,8 @@ type GenerateDataKeyWithoutPlaintextOutput struct { // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob []byte - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that encrypted the data key. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that encrypted the data key. KeyId *string // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_GenerateMac.go b/service/kms/api_op_GenerateMac.go index 43b03293207..8bdd38fcf24 100644 --- a/service/kms/api_op_GenerateMac.go +++ b/service/kms/api_op_GenerateMac.go @@ -11,30 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates a hash-based message authentication code (HMAC) for a message using an -// HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the -// HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104 -// (https://datatracker.ietf.org/doc/html/rfc2104). You can use value that -// GenerateMac returns in the VerifyMac operation to demonstrate that the original -// message has not changed. Also, because a secret key is used to create the hash, -// you can verify that the party that generated the hash has the required secret -// key. You can also use the raw result to implement HMAC-based algorithms such as -// key derivation functions. This operation is part of KMS support for HMAC KMS -// keys. For details, see HMAC keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the Key -// Management Service Developer Guide . Best practices recommend that you limit the -// time during which any signing mechanism, including an HMAC, is effective. This -// deters an attack where the actor uses a signed message to establish validity -// repeatedly or long after the message is superseded. HMAC tags do not include a -// timestamp, but you can include a timestamp in the token or message to help you -// detect when its time to refresh the HMAC. The KMS key that you use for this -// operation must be in a compatible key state. For details, see Key states of KMS -// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in -// the Key Management Service Developer Guide. Cross-account use: Yes. To perform -// this operation with a KMS key in a different Amazon Web Services account, -// specify the key ARN or alias ARN in the value of the KeyId parameter. Required -// permissions: kms:GenerateMac -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Generates a hash-based message authentication code (HMAC) for a message using +// an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the +// HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104 (https://datatracker.ietf.org/doc/html/rfc2104) +// . You can use value that GenerateMac returns in the VerifyMac operation to +// demonstrate that the original message has not changed. Also, because a secret +// key is used to create the hash, you can verify that the party that generated the +// hash has the required secret key. You can also use the raw result to implement +// HMAC-based algorithms such as key derivation functions. This operation is part +// of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) +// in the Key Management Service Developer Guide . Best practices recommend that +// you limit the time during which any signing mechanism, including an HMAC, is +// effective. This deters an attack where the actor uses a signed message to +// establish validity repeatedly or long after the message is superseded. HMAC tags +// do not include a timestamp, but you can include a timestamp in the token or +// message to help you detect when its time to refresh the HMAC. The KMS key that +// you use for this operation must be in a compatible key state. For details, see +// Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation with a KMS key in a different Amazon Web Services +// account, specify the key ARN or alias ARN in the value of the KeyId parameter. +// Required permissions: kms:GenerateMac (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: VerifyMac func (c *Client) GenerateMac(ctx context.Context, params *GenerateMacInput, optFns ...func(*Options)) (*GenerateMacOutput, error) { if params == nil { @@ -54,9 +51,9 @@ func (c *Client) GenerateMac(ctx context.Context, params *GenerateMacInput, optF type GenerateMacInput struct { // The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC - // for the message and the key as described in RFC 2104 - // (https://datatracker.ietf.org/doc/html/rfc2104). To identify an HMAC KMS key, - // use the DescribeKey operation and see the KeySpec field in the response. + // for the message and the key as described in RFC 2104 (https://datatracker.ietf.org/doc/html/rfc2104) + // . To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec + // field in the response. // // This member is required. KeyId *string @@ -79,10 +76,8 @@ type GenerateMacInput struct { // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -96,7 +91,7 @@ type GenerateMacOutput struct { // The hash-based message authentication code (HMAC) that was generated for the // specified message, HMAC KMS key, and MAC algorithm. This is the standard, raw - // HMAC defined in RFC 2104 (https://datatracker.ietf.org/doc/html/rfc2104). + // HMAC defined in RFC 2104 (https://datatracker.ietf.org/doc/html/rfc2104) . Mac []byte // The MAC algorithm that was used to generate the HMAC. diff --git a/service/kms/api_op_GenerateRandom.go b/service/kms/api_op_GenerateRandom.go index 7ed73007f9e..6c733db6b4f 100644 --- a/service/kms/api_op_GenerateRandom.go +++ b/service/kms/api_op_GenerateRandom.go @@ -16,17 +16,15 @@ import ( // generated in KMS. To generate the byte string in the CloudHSM cluster associated // with an CloudHSM key store, use the CustomKeyStoreId parameter. Applications in // Amazon Web Services Nitro Enclaves can call this operation by using the Amazon -// Web Services Nitro Enclaves Development Kit -// (https://github.com/aws/aws-nitro-enclaves-sdk-c). For information about the -// supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) +// Web Services Nitro Enclaves Development Kit (https://github.com/aws/aws-nitro-enclaves-sdk-c) +// . For information about the supporting parameters, see How Amazon Web Services +// Nitro Enclaves use KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) // in the Key Management Service Developer Guide. For more information about // entropy and random number generation, see Key Management Service Cryptographic -// Details (https://docs.aws.amazon.com/kms/latest/cryptographic-details/). +// Details (https://docs.aws.amazon.com/kms/latest/cryptographic-details/) . // Cross-account use: Not applicable. GenerateRandom does not use any // account-specific resources, such as KMS keys. Required permissions: -// kms:GenerateRandom -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// kms:GenerateRandom (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) func (c *Client) GenerateRandom(ctx context.Context, params *GenerateRandomInput, optFns ...func(*Options)) (*GenerateRandomOutput, error) { if params == nil { @@ -45,11 +43,11 @@ func (c *Client) GenerateRandom(ctx context.Context, params *GenerateRandomInput type GenerateRandomInput struct { - // Generates the random byte string in the CloudHSM cluster that is associated with - // the specified CloudHSM key store. To find the ID of a custom key store, use the - // DescribeCustomKeyStores operation. External key store IDs are not valid for this - // parameter. If you specify the ID of an external key store, GenerateRandom throws - // an UnsupportedOperationException. + // Generates the random byte string in the CloudHSM cluster that is associated + // with the specified CloudHSM key store. To find the ID of a custom key store, use + // the DescribeCustomKeyStores operation. External key store IDs are not valid for + // this parameter. If you specify the ID of an external key store, GenerateRandom + // throws an UnsupportedOperationException . CustomKeyStoreId *string // The length of the random byte string. This parameter is required. diff --git a/service/kms/api_op_GetKeyPolicy.go b/service/kms/api_op_GetKeyPolicy.go index ca9e135bd20..f245445c6c0 100644 --- a/service/kms/api_op_GetKeyPolicy.go +++ b/service/kms/api_op_GetKeyPolicy.go @@ -12,8 +12,7 @@ import ( // Gets a key policy attached to the specified KMS key. Cross-account use: No. You // cannot perform this operation on a KMS key in a different Amazon Web Services -// account. Required permissions: kms:GetKeyPolicy -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// account. Required permissions: kms:GetKeyPolicy (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: PutKeyPolicy func (c *Client) GetKeyPolicy(ctx context.Context, params *GetKeyPolicyInput, optFns ...func(*Options)) (*GetKeyPolicyOutput, error) { if params == nil { @@ -34,21 +33,16 @@ type GetKeyPolicyInput struct { // Gets the key policy for the specified KMS key. Specify the key ID or key ARN of // the KMS key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string - // Specifies the name of the key policy. The only valid name is default. To get the - // names of key policies, use ListKeyPolicies. + // Specifies the name of the key policy. The only valid name is default . To get + // the names of key policies, use ListKeyPolicies . // // This member is required. PolicyName *string diff --git a/service/kms/api_op_GetKeyRotationStatus.go b/service/kms/api_op_GetKeyRotationStatus.go index 0d8c4320cc2..5a5ca210c61 100644 --- a/service/kms/api_op_GetKeyRotationStatus.go +++ b/service/kms/api_op_GetKeyRotationStatus.go @@ -11,61 +11,46 @@ import ( ) // Gets a Boolean value that indicates whether automatic rotation of the key -// material -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) is -// enabled for the specified KMS key. When you enable automatic rotation for -// customer managed KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk), -// KMS rotates the key material of the KMS key one year (approximately 365 days) +// material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) +// is enabled for the specified KMS key. When you enable automatic rotation for +// customer managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// , KMS rotates the key material of the KMS key one year (approximately 365 days) // from the enable date and every year thereafter. You can monitor rotation of the // key material for your KMS keys in CloudTrail and Amazon CloudWatch. Automatic -// key rotation is supported only on symmetric encryption KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks). -// You cannot enable automatic rotation of asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html), -// HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html), -// KMS keys with imported key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or -// KMS keys in a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). -// To enable or disable automatic rotation of a set of related multi-Region keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate), -// set the property on the primary key.. You can enable (EnableKeyRotation) and -// disable automatic rotation (DisableKeyRotation) of the key material in customer -// managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// key rotation is supported only on symmetric encryption KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) +// . You cannot enable automatic rotation of asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// , HMAC KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) +// , KMS keys with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// , or KMS keys in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// . To enable or disable automatic rotation of a set of related multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) +// , set the property on the primary key.. You can enable ( EnableKeyRotation ) and +// disable automatic rotation ( DisableKeyRotation ) of the key material in +// customer managed KMS keys. Key material rotation of Amazon Web Services managed +// KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) // is not configurable. KMS always rotates the key material in Amazon Web Services // managed KMS keys every year. The key rotation status for Amazon Web Services -// managed KMS keys is always true. In May 2022, KMS changed the rotation schedule +// managed KMS keys is always true . In May 2022, KMS changed the rotation schedule // for Amazon Web Services managed keys from every three years to every year. For -// details, see EnableKeyRotation. The KMS key that you use for this operation must -// be in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. +// details, see EnableKeyRotation . The KMS key that you use for this operation +// must be in a compatible key state. For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. +// - Disabled: The key rotation status does not change when you disable a KMS +// key. However, while the KMS key is disabled, KMS does not rotate the key +// material. When you re-enable the KMS key, rotation resumes. If the key material +// in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it +// immediately, and every year thereafter. If it's been less than a year since the +// key material in the re-enabled KMS key was rotated, the KMS key resumes its +// prior rotation schedule. +// - Pending deletion: While a KMS key is pending deletion, its key rotation +// status is false and KMS does not rotate the key material. If you cancel the +// deletion, the original key rotation status returns to true . // -// * Disabled: The key rotation status -// does not change when you disable a KMS key. However, while the KMS key is -// disabled, KMS does not rotate the key material. When you re-enable the KMS key, -// rotation resumes. If the key material in the re-enabled KMS key hasn't been -// rotated in one year, KMS rotates it immediately, and every year thereafter. If -// it's been less than a year since the key material in the re-enabled KMS key was -// rotated, the KMS key resumes its prior rotation schedule. -// -// * Pending deletion: -// While a KMS key is pending deletion, its key rotation status is false and KMS -// does not rotate the key material. If you cancel the deletion, the original key -// rotation status returns to true. -// -// Cross-account use: Yes. To perform this -// operation on a KMS key in a different Amazon Web Services account, specify the -// key ARN in the value of the KeyId parameter. Required permissions: -// kms:GetKeyRotationStatus -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Cross-account use: Yes. To perform this operation on a KMS key in a different +// Amazon Web Services account, specify the key ARN in the value of the KeyId +// parameter. Required permissions: kms:GetKeyRotationStatus (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * DisableKeyRotation -// -// * EnableKeyRotation +// - DisableKeyRotation +// - EnableKeyRotation func (c *Client) GetKeyRotationStatus(ctx context.Context, params *GetKeyRotationStatusInput, optFns ...func(*Options)) (*GetKeyRotationStatusOutput, error) { if params == nil { params = &GetKeyRotationStatusInput{} @@ -86,15 +71,10 @@ type GetKeyRotationStatusInput struct { // Gets the rotation status for the specified KMS key. Specify the key ID or key // ARN of the KMS key. To specify a KMS key in a different Amazon Web Services // account, you must use the key ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_GetParametersForImport.go b/service/kms/api_op_GetParametersForImport.go index aaf5e0fd251..132174b5944 100644 --- a/service/kms/api_op_GetParametersForImport.go +++ b/service/kms/api_op_GetParametersForImport.go @@ -14,33 +14,28 @@ import ( // Returns the items you need to import key material into a symmetric encryption // KMS key. For more information about importing key material into KMS, see -// Importing key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in -// the Key Management Service Developer Guide. This operation returns a public key -// and an import token. Use the public key to encrypt the symmetric key material. -// Store the import token to send with a subsequent ImportKeyMaterial request. You -// must specify the key ID of the symmetric encryption KMS key into which you will -// import key material. The KMS key Origin must be EXTERNAL. You must also specify -// the wrapping algorithm and type of wrapping key (public key) that you will use -// to encrypt the key material. You cannot perform this operation on an asymmetric -// KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services -// account. To import key material, you must use the public key and import token -// from the same response. These items are valid for 24 hours. The expiration date -// and time appear in the GetParametersForImport response. You cannot use an -// expired token in an ImportKeyMaterial request. If your key and token expire, -// send another GetParametersForImport request. The KMS key that you use for this -// operation must be in a compatible key state. For details, see Key states of KMS -// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in -// the Key Management Service Developer Guide. Cross-account use: No. You cannot +// Importing key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// in the Key Management Service Developer Guide. This operation returns a public +// key and an import token. Use the public key to encrypt the symmetric key +// material. Store the import token to send with a subsequent ImportKeyMaterial +// request. You must specify the key ID of the symmetric encryption KMS key into +// which you will import key material. The KMS key Origin must be EXTERNAL . You +// must also specify the wrapping algorithm and type of wrapping key (public key) +// that you will use to encrypt the key material. You cannot perform this operation +// on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different +// Amazon Web Services account. To import key material, you must use the public key +// and import token from the same response. These items are valid for 24 hours. The +// expiration date and time appear in the GetParametersForImport response. You +// cannot use an expired token in an ImportKeyMaterial request. If your key and +// token expire, send another GetParametersForImport request. The KMS key that you +// use for this operation must be in a compatible key state. For details, see Key +// states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:GetParametersForImport -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:GetParametersForImport (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * ImportKeyMaterial -// -// * -// DeleteImportedKeyMaterial +// - ImportKeyMaterial +// - DeleteImportedKeyMaterial func (c *Client) GetParametersForImport(ctx context.Context, params *GetParametersForImportInput, optFns ...func(*Options)) (*GetParametersForImportOutput, error) { if params == nil { params = &GetParametersForImportInput{} @@ -59,30 +54,23 @@ func (c *Client) GetParametersForImport(ctx context.Context, params *GetParamete type GetParametersForImportInput struct { // The identifier of the symmetric encryption KMS key into which you will import - // key material. The Origin of the KMS key must be EXTERNAL. Specify the key ID or + // key material. The Origin of the KMS key must be EXTERNAL . Specify the key ID or // key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string // The algorithm you will use to encrypt the key material before using the // ImportKeyMaterial operation to import it. For more information, see Encrypt the - // key material - // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html) + // key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html) // in the Key Management Service Developer Guide. The RSAES_PKCS1_V1_5 wrapping // algorithm is deprecated. We recommend that you begin using a different wrapping // algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5 by October 1, - // 2023 pursuant to cryptographic key management guidance - // (https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar2.pdf) + // 2023 pursuant to cryptographic key management guidance (https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar2.pdf) // from the National Institute of Standards and Technology (NIST). // // This member is required. @@ -102,19 +90,18 @@ type GetParametersForImportOutput struct { // The import token to send in a subsequent ImportKeyMaterial request. ImportToken []byte - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key to use in a subsequent ImportKeyMaterial request. This is the + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key to use in a subsequent ImportKeyMaterial request. This is the // same KMS key specified in the GetParametersForImport request. KeyId *string // The time at which the import token and public key are no longer valid. After - // this time, you cannot use them to make an ImportKeyMaterial request and you must - // send another GetParametersForImport request to get new ones. + // this time, you cannot use them to make an ImportKeyMaterial request and you + // must send another GetParametersForImport request to get new ones. ParametersValidTo *time.Time // The public key to use to encrypt the key material before importing it with - // ImportKeyMaterial. + // ImportKeyMaterial . PublicKey []byte // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_GetPublicKey.go b/service/kms/api_op_GetPublicKey.go index cd093fada63..fa75b907000 100644 --- a/service/kms/api_op_GetPublicKey.go +++ b/service/kms/api_op_GetPublicKey.go @@ -16,52 +16,40 @@ import ( // kms:GetPublicKey permission can download the public key of an asymmetric KMS // key. You can share the public key to allow others to encrypt messages and verify // signatures outside of KMS. For information about asymmetric KMS keys, see -// Asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// Asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. You do not need to download the // public key. Instead, you can use the public key within KMS by calling the -// Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric +// Encrypt , ReEncrypt , or Verify operations with the identifier of an asymmetric // KMS key. When you use the public key within KMS, you benefit from the // authentication, authorization, and logging that are part of every KMS operation. // You also reduce of risk of encrypting data that cannot be decrypted. These // features are not effective outside of KMS. To help you use the public key safely // outside of KMS, GetPublicKey returns important information about the public key // in the response, including: +// - KeySpec (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec) +// : The type of key material in the public key, such as RSA_4096 or +// ECC_NIST_P521 . +// - KeyUsage (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage) +// : Whether the key is used for encryption or signing. +// - EncryptionAlgorithms (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms) +// or SigningAlgorithms (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms) +// : A list of the encryption algorithms or the signing algorithms for the key. // -// * KeySpec -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec): -// The type of key material in the public key, such as RSA_4096 or -// ECC_NIST_P521. -// -// * KeyUsage -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage): -// Whether the key is used for encryption or signing. -// -// * EncryptionAlgorithms -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms) -// or SigningAlgorithms -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms): -// A list of the encryption algorithms or the signing algorithms for the -// key. -// -// Although KMS cannot enforce these restrictions on external operations, it -// is crucial that you use this information to prevent the public key from being -// used improperly. For example, you can prevent a public signing key from being -// used encrypt data, or prevent a public key from being used with an encryption +// Although KMS cannot enforce these restrictions on external operations, it is +// crucial that you use this information to prevent the public key from being used +// improperly. For example, you can prevent a public signing key from being used +// encrypt data, or prevent a public key from being used with an encryption // algorithm that is not supported by KMS. You can also avoid errors, such as using // the wrong signing algorithm in a verification operation. To verify a signature // outside of KMS with an SM2 public key (China Regions only), you must specify the // distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing -// ID. For more information, see Offline verification with SM2 key pairs -// (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification). -// The KMS key that you use for this operation must be in a compatible key state. -// For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation with a KMS key in a different Amazon Web Services account, specify the -// key ARN or alias ARN in the value of the KeyId parameter. Required permissions: -// kms:GetPublicKey -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// ID. For more information, see Offline verification with SM2 key pairs (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification) +// . The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation with a KMS key in a different Amazon Web Services +// account, specify the key ARN or alias ARN in the value of the KeyId parameter. +// Required permissions: kms:GetPublicKey (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: CreateKey func (c *Client) GetPublicKey(ctx context.Context, params *GetPublicKeyInput, optFns ...func(*Options)) (*GetPublicKeyOutput, error) { if params == nil { @@ -80,36 +68,25 @@ func (c *Client) GetPublicKey(ctx context.Context, params *GetPublicKeyInput, op type GetPublicKeyInput struct { - // Identifies the asymmetric KMS key that includes the public key. To specify a KMS - // key, use its key ID, key ARN, alias name, or alias ARN. When using an alias - // name, prefix it with "alias/". To specify a KMS key in a different Amazon Web + // Identifies the asymmetric KMS key that includes the public key. To specify a + // KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias + // name, prefix it with "alias/" . To specify a KMS key in a different Amazon Web // Services account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -129,31 +106,29 @@ type GetPublicKeyOutput struct { // The encryption algorithms that KMS supports for this key. This information is // critical. If a public key encrypts data outside of KMS by using an unsupported // encryption algorithm, the ciphertext cannot be decrypted. This field appears in - // the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT. + // the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT . EncryptionAlgorithms []types.EncryptionAlgorithmSpec - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the asymmetric KMS key from which the public key was downloaded. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the asymmetric KMS key from which the public key was downloaded. KeyId *string // The type of the of the public key that was downloaded. KeySpec types.KeySpec // The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or - // SIGN_VERIFY. This information is critical. If a public key with SIGN_VERIFY key - // usage encrypts data outside of KMS, the ciphertext cannot be decrypted. + // SIGN_VERIFY . This information is critical. If a public key with SIGN_VERIFY + // key usage encrypts data outside of KMS, the ciphertext cannot be decrypted. KeyUsage types.KeyUsageType - // The exported public key. The value is a DER-encoded X.509 public key, also known - // as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280 - // (https://tools.ietf.org/html/rfc5280). When you use the HTTP API or the Amazon - // Web Services CLI, the value is Base64-encoded. Otherwise, it is not - // Base64-encoded. + // The exported public key. The value is a DER-encoded X.509 public key, also + // known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280 (https://tools.ietf.org/html/rfc5280) + // . When you use the HTTP API or the Amazon Web Services CLI, the value is + // Base64-encoded. Otherwise, it is not Base64-encoded. PublicKey []byte - // The signing algorithms that KMS supports for this key. This field appears in the - // response only when the KeyUsage of the public key is SIGN_VERIFY. + // The signing algorithms that KMS supports for this key. This field appears in + // the response only when the KeyUsage of the public key is SIGN_VERIFY . SigningAlgorithms []types.SigningAlgorithmSpec // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_ImportKeyMaterial.go b/service/kms/api_op_ImportKeyMaterial.go index 17f45760102..ffab5ee6e51 100644 --- a/service/kms/api_op_ImportKeyMaterial.go +++ b/service/kms/api_op_ImportKeyMaterial.go @@ -14,61 +14,47 @@ import ( // Imports key material into an existing symmetric encryption KMS key that was // created without key material. After you successfully import key material into a -// KMS key, you can reimport the same key material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material) +// KMS key, you can reimport the same key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material) // into that KMS key, but you cannot import different key material. You cannot // perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS // key in a different Amazon Web Services account. For more information about // creating KMS keys with no key material and then importing key material, see -// Importing Key Material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in -// the Key Management Service Developer Guide. Before using this operation, call -// GetParametersForImport. Its response includes a public key and an import token. +// Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) +// in the Key Management Service Developer Guide. Before using this operation, call +// GetParametersForImport . Its response includes a public key and an import token. // Use the public key to encrypt the key material. Then, submit the import token // from the same GetParametersForImport response. When calling this operation, you // must specify the following values: +// - The key ID or key ARN of a KMS key with no key material. Its Origin must be +// EXTERNAL . To create a KMS key with no key material, call CreateKey and set +// the value of its Origin parameter to EXTERNAL . To get the Origin of a KMS +// key, call DescribeKey .) +// - The encrypted key material. To get the public key to encrypt the key +// material, call GetParametersForImport . +// - The import token that GetParametersForImport returned. You must use a public +// key and token from the same GetParametersForImport response. +// - Whether the key material expires ( ExpirationModel ) and, if so, when ( +// ValidTo ). If you set an expiration date, on the specified date, KMS deletes +// the key material from the KMS key, making the KMS key unusable. To use the KMS +// key in cryptographic operations again, you must reimport the same key material. +// The only way to change the expiration model or expiration date is by reimporting +// the same key material and specifying a new expiration date. // -// * The key ID or key ARN of a KMS key with no -// key material. Its Origin must be EXTERNAL. To create a KMS key with no key -// material, call CreateKey and set the value of its Origin parameter to EXTERNAL. -// To get the Origin of a KMS key, call DescribeKey.) -// -// * The encrypted key -// material. To get the public key to encrypt the key material, call -// GetParametersForImport. -// -// * The import token that GetParametersForImport -// returned. You must use a public key and token from the same -// GetParametersForImport response. -// -// * Whether the key material expires -// (ExpirationModel) and, if so, when (ValidTo). If you set an expiration date, on -// the specified date, KMS deletes the key material from the KMS key, making the -// KMS key unusable. To use the KMS key in cryptographic operations again, you must -// reimport the same key material. The only way to change the expiration model or -// expiration date is by reimporting the same key material and specifying a new -// expiration date. -// -// When this operation is successful, the key state of the KMS -// key changes from PendingImport to Enabled, and you can use the KMS key. If this -// operation fails, use the exception to help determine the problem. If the error -// is related to the key material, the import token, or wrapping key, use -// GetParametersForImport to get a new public key and import token for the KMS key -// and repeat the import procedure. For help, see How To Import Key Material -// (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview) +// When this operation is successful, the key state of the KMS key changes from +// PendingImport to Enabled , and you can use the KMS key. If this operation fails, +// use the exception to help determine the problem. If the error is related to the +// key material, the import token, or wrapping key, use GetParametersForImport to +// get a new public key and import token for the KMS key and repeat the import +// procedure. For help, see How To Import Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview) // in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:ImportKeyMaterial -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:ImportKeyMaterial (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * DeleteImportedKeyMaterial -// -// * -// GetParametersForImport +// - DeleteImportedKeyMaterial +// - GetParametersForImport func (c *Client) ImportKeyMaterial(ctx context.Context, params *ImportKeyMaterialInput, optFns ...func(*Options)) (*ImportKeyMaterialOutput, error) { if params == nil { params = &ImportKeyMaterialInput{} @@ -87,8 +73,9 @@ func (c *Client) ImportKeyMaterial(ctx context.Context, params *ImportKeyMateria type ImportKeyMaterialInput struct { // The encrypted key material to import. The key material must be encrypted with - // the public wrapping key that GetParametersForImport returned, using the wrapping - // algorithm that you specified in the same GetParametersForImport request. + // the public wrapping key that GetParametersForImport returned, using the + // wrapping algorithm that you specified in the same GetParametersForImport + // request. // // This member is required. EncryptedKeyMaterial []byte @@ -102,42 +89,38 @@ type ImportKeyMaterialInput struct { // The identifier of the symmetric encryption KMS key that receives the imported // key material. This must be the same KMS key specified in the KeyID parameter of - // the corresponding GetParametersForImport request. The Origin of the KMS key must - // be EXTERNAL. You cannot perform this operation on an asymmetric KMS key, an HMAC - // KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon - // Web Services account Specify the key ID or key ARN of the KMS key. For + // the corresponding GetParametersForImport request. The Origin of the KMS key + // must be EXTERNAL . You cannot perform this operation on an asymmetric KMS key, + // an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different + // Amazon Web Services account Specify the key ID or key ARN of the KMS key. For // example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string - // Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES. - // When the value of ExpirationModel is KEY_MATERIAL_EXPIRES, you must specify a - // value for the ValidTo parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE, you - // must omit the ValidTo parameter. You cannot change the ExpirationModel or + // Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES + // . When the value of ExpirationModel is KEY_MATERIAL_EXPIRES , you must specify a + // value for the ValidTo parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE , + // you must omit the ValidTo parameter. You cannot change the ExpirationModel or // ValidTo values for the current import after the request completes. To change - // either value, you must delete (DeleteImportedKeyMaterial) and reimport the key + // either value, you must delete ( DeleteImportedKeyMaterial ) and reimport the key // material. ExpirationModel types.ExpirationModelType // The date and time when the imported key material expires. This parameter is - // required when the value of the ExpirationModel parameter is - // KEY_MATERIAL_EXPIRES. Otherwise it is not valid. The value of this parameter - // must be a future date and time. The maximum value is 365 days from the request - // date. When the key material expires, KMS deletes the key material from the KMS - // key. Without its key material, the KMS key is unusable. To use the KMS key in - // cryptographic operations, you must reimport the same key material. You cannot - // change the ExpirationModel or ValidTo values for the current import after the - // request completes. To change either value, you must delete - // (DeleteImportedKeyMaterial) and reimport the key material. + // required when the value of the ExpirationModel parameter is KEY_MATERIAL_EXPIRES + // . Otherwise it is not valid. The value of this parameter must be a future date + // and time. The maximum value is 365 days from the request date. When the key + // material expires, KMS deletes the key material from the KMS key. Without its key + // material, the KMS key is unusable. To use the KMS key in cryptographic + // operations, you must reimport the same key material. You cannot change the + // ExpirationModel or ValidTo values for the current import after the request + // completes. To change either value, you must delete ( DeleteImportedKeyMaterial ) + // and reimport the key material. ValidTo *time.Time noSmithyDocumentSerde diff --git a/service/kms/api_op_ListAliases.go b/service/kms/api_op_ListAliases.go index 10f9345036c..6f68cb39592 100644 --- a/service/kms/api_op_ListAliases.go +++ b/service/kms/api_op_ListAliases.go @@ -13,32 +13,25 @@ import ( ) // Gets a list of aliases in the caller's Amazon Web Services account and region. -// For more information about aliases, see CreateAlias. By default, the ListAliases -// operation returns all aliases in the account and region. To get only the aliases -// associated with a particular KMS key, use the KeyId parameter. The ListAliases -// response can include aliases that you created and associated with your customer -// managed keys, and aliases that Amazon Web Services created and associated with -// Amazon Web Services managed keys in your account. You can recognize Amazon Web -// Services aliases because their names have the format aws/, such as aws/dynamodb. -// The response might also include aliases that have no TargetKeyId field. These -// are predefined aliases that Amazon Web Services has created but has not yet -// associated with a KMS key. Aliases that Amazon Web Services creates in your -// account, including predefined aliases, do not count against your KMS aliases -// quota -// (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit). -// Cross-account use: No. ListAliases does not return aliases in other Amazon Web -// Services accounts. Required permissions: kms:ListAliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// (IAM policy) For details, see Controlling access to aliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) +// For more information about aliases, see CreateAlias . By default, the +// ListAliases operation returns all aliases in the account and region. To get only +// the aliases associated with a particular KMS key, use the KeyId parameter. The +// ListAliases response can include aliases that you created and associated with +// your customer managed keys, and aliases that Amazon Web Services created and +// associated with Amazon Web Services managed keys in your account. You can +// recognize Amazon Web Services aliases because their names have the format aws/ , +// such as aws/dynamodb . The response might also include aliases that have no +// TargetKeyId field. These are predefined aliases that Amazon Web Services has +// created but has not yet associated with a KMS key. Aliases that Amazon Web +// Services creates in your account, including predefined aliases, do not count +// against your KMS aliases quota (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit) +// . Cross-account use: No. ListAliases does not return aliases in other Amazon +// Web Services accounts. Required permissions: kms:ListAliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// (IAM policy) For details, see Controlling access to aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) // in the Key Management Service Developer Guide. Related operations: -// -// * -// CreateAlias -// -// * DeleteAlias -// -// * UpdateAlias +// - CreateAlias +// - DeleteAlias +// - UpdateAlias func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -60,15 +53,10 @@ type ListAliasesInput struct { // key in your Amazon Web Services account. This parameter is optional. If you omit // it, ListAliases returns all aliases in the account and Region. Specify the key // ID or key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . KeyId *string // Use this parameter to specify the maximum number of items to return. When this @@ -79,8 +67,8 @@ type ListAliasesInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde diff --git a/service/kms/api_op_ListGrants.go b/service/kms/api_op_ListGrants.go index 21b11e1243c..428b1ab4a34 100644 --- a/service/kms/api_op_ListGrants.go +++ b/service/kms/api_op_ListGrants.go @@ -15,31 +15,22 @@ import ( // Gets a list of all grants for the specified KMS key. You must specify the KMS // key in all requests. You can filter the grant list by grant ID or grantee // principal. For detailed information about grants, including grant terminology, -// see Grants in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the Key -// Management Service Developer Guide . For examples of working with grants in -// several programming languages, see Programming grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html). -// The GranteePrincipal field in the ListGrants response usually contains the user -// or role designated as the grantee principal in the grant. However, when the +// see Grants in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) +// in the Key Management Service Developer Guide . For examples of working with +// grants in several programming languages, see Programming grants (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html) +// . The GranteePrincipal field in the ListGrants response usually contains the +// user or role designated as the grantee principal in the grant. However, when the // grantee principal in the grant is an Amazon Web Services service, the -// GranteePrincipal field contains the service principal -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services), -// which might represent several different grantee principals. Cross-account use: +// GranteePrincipal field contains the service principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) +// , which might represent several different grantee principals. Cross-account use: // Yes. To perform this operation on a KMS key in a different Amazon Web Services // account, specify the key ARN in the value of the KeyId parameter. Required -// permissions: kms:ListGrants -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permissions: kms:ListGrants (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * CreateGrant -// -// * ListRetirableGrants -// -// * -// RetireGrant -// -// * RevokeGrant +// - CreateGrant +// - ListRetirableGrants +// - RetireGrant +// - RevokeGrant func (c *Client) ListGrants(ctx context.Context, params *ListGrantsInput, optFns ...func(*Options)) (*ListGrantsOutput, error) { if params == nil { params = &ListGrantsInput{} @@ -60,15 +51,10 @@ type ListGrantsInput struct { // Returns only grants for the specified KMS key. This parameter is required. // Specify the key ID or key ARN of the KMS key. To specify a KMS key in a // different Amazon Web Services account, you must use the key ARN. For example: - // - // * - // Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -89,8 +75,8 @@ type ListGrantsInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde diff --git a/service/kms/api_op_ListKeyPolicies.go b/service/kms/api_op_ListKeyPolicies.go index a6c31313e38..cb90304357d 100644 --- a/service/kms/api_op_ListKeyPolicies.go +++ b/service/kms/api_op_ListKeyPolicies.go @@ -13,15 +13,12 @@ import ( // Gets the names of the key policies that are attached to a KMS key. This // operation is designed to get policy names that you can use in a GetKeyPolicy -// operation. However, the only valid policy name is default. Cross-account use: +// operation. However, the only valid policy name is default . Cross-account use: // No. You cannot perform this operation on a KMS key in a different Amazon Web -// Services account. Required permissions: kms:ListKeyPolicies -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Services account. Required permissions: kms:ListKeyPolicies (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * GetKeyPolicy -// -// * PutKeyPolicy +// - GetKeyPolicy +// - PutKeyPolicy func (c *Client) ListKeyPolicies(ctx context.Context, params *ListKeyPoliciesInput, optFns ...func(*Options)) (*ListKeyPoliciesOutput, error) { if params == nil { params = &ListKeyPoliciesInput{} @@ -41,15 +38,10 @@ type ListKeyPoliciesInput struct { // Gets the names of key policies for the specified KMS key. Specify the key ID or // key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -62,8 +54,8 @@ type ListKeyPoliciesInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde @@ -75,7 +67,7 @@ type ListKeyPoliciesOutput struct { // for the Marker parameter in a subsequent request. NextMarker *string - // A list of key policy names. The only valid value is default. + // A list of key policy names. The only valid value is default . PolicyNames []string // A flag that indicates whether there are more items in the list. When this value diff --git a/service/kms/api_op_ListKeys.go b/service/kms/api_op_ListKeys.go index c554f536e11..e3a5b3817aa 100644 --- a/service/kms/api_op_ListKeys.go +++ b/service/kms/api_op_ListKeys.go @@ -14,18 +14,12 @@ import ( // Gets a list of all KMS keys in the caller's Amazon Web Services account and // Region. Cross-account use: No. You cannot perform this operation on a KMS key in -// a different Amazon Web Services account. Required permissions: kms:ListKeys -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// a different Amazon Web Services account. Required permissions: kms:ListKeys (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations: -// -// * CreateKey -// -// * DescribeKey -// -// * ListAliases -// -// * -// ListResourceTags +// - CreateKey +// - DescribeKey +// - ListAliases +// - ListResourceTags func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ...func(*Options)) (*ListKeysOutput, error) { if params == nil { params = &ListKeysInput{} @@ -51,8 +45,8 @@ type ListKeysInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde diff --git a/service/kms/api_op_ListResourceTags.go b/service/kms/api_op_ListResourceTags.go index 02c74956079..68e9493cf0d 100644 --- a/service/kms/api_op_ListResourceTags.go +++ b/service/kms/api_op_ListResourceTags.go @@ -13,25 +13,17 @@ import ( ) // Returns all tags on the specified KMS key. For general information about tags, -// including the format and syntax, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. For information about using tags in KMS, see -// Tagging keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). -// Cross-account use: No. You cannot perform this operation on a KMS key in a +// including the format and syntax, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. For information about using tags +// in KMS, see Tagging keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) +// . Cross-account use: No. You cannot perform this operation on a KMS key in a // different Amazon Web Services account. Required permissions: -// kms:ListResourceTags -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// kms:ListResourceTags (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: -// -// * CreateKey -// -// * ReplicateKey -// -// * TagResource -// -// * -// UntagResource +// - CreateKey +// - ReplicateKey +// - TagResource +// - UntagResource func (c *Client) ListResourceTags(ctx context.Context, params *ListResourceTagsInput, optFns ...func(*Options)) (*ListResourceTagsOutput, error) { if params == nil { params = &ListResourceTagsInput{} @@ -51,14 +43,10 @@ type ListResourceTagsInput struct { // Gets tags on the specified KMS key. Specify the key ID or key ARN of the KMS // key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -71,9 +59,9 @@ type ListResourceTagsInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. Do not attempt to construct this value. Use only the value of - // NextMarker from the truncated response you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Do not attempt to construct this value. Use only the + // value of NextMarker from the truncated response you just received. Marker *string noSmithyDocumentSerde @@ -88,9 +76,8 @@ type ListResourceTagsOutput struct { // A list of tags. Each tag consists of a tag key and a tag value. Tagging or // untagging a KMS key can allow or deny permission to the KMS key. For details, - // see ABAC for KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key - // Management Service Developer Guide. + // see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) + // in the Key Management Service Developer Guide. Tags []types.Tag // A flag that indicates whether there are more items in the list. When this value diff --git a/service/kms/api_op_ListRetirableGrants.go b/service/kms/api_op_ListRetirableGrants.go index 8950d89f1ec..426fd9e9545 100644 --- a/service/kms/api_op_ListRetirableGrants.go +++ b/service/kms/api_op_ListRetirableGrants.go @@ -17,28 +17,20 @@ import ( // in your Amazon Web Services account. The grants that are returned include grants // for KMS keys in your Amazon Web Services account and other Amazon Web Services // accounts. You might use this operation to determine which grants you may retire. -// To retire a grant, use the RetireGrant operation. For detailed information about -// grants, including grant terminology, see Grants in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the Key -// Management Service Developer Guide . For examples of working with grants in -// several programming languages, see Programming grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html). -// Cross-account use: You must specify a principal in your Amazon Web Services +// To retire a grant, use the RetireGrant operation. For detailed information +// about grants, including grant terminology, see Grants in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) +// in the Key Management Service Developer Guide . For examples of working with +// grants in several programming languages, see Programming grants (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html) +// . Cross-account use: You must specify a principal in your Amazon Web Services // account. However, this operation can return grants in any Amazon Web Services // account. You do not need kms:ListRetirableGrants permission (or any other // additional permission) in any Amazon Web Services account other than your own. -// Required permissions: kms:ListRetirableGrants -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:ListRetirableGrants (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) in your Amazon Web Services account. Related operations: -// -// * -// CreateGrant -// -// * ListGrants -// -// * RetireGrant -// -// * RevokeGrant +// - CreateGrant +// - ListGrants +// - RetireGrant +// - RevokeGrant func (c *Client) ListRetirableGrants(ctx context.Context, params *ListRetirableGrantsInput, optFns ...func(*Options)) (*ListRetirableGrantsOutput, error) { if params == nil { params = &ListRetirableGrantsInput{} @@ -58,12 +50,10 @@ type ListRetirableGrantsInput struct { // The retiring principal for which to list grants. Enter a principal in your // Amazon Web Services account. To specify the retiring principal, use the Amazon - // Resource Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an Amazon Web Services principal. Valid principals include Amazon Web Services - // accounts, IAM users, IAM roles, federated users, and assumed role users. For - // help with the ARN syntax for a principal, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an Amazon Web Services principal. Valid principals include Amazon Web + // Services accounts, IAM users, IAM roles, federated users, and assumed role + // users. For help with the ARN syntax for a principal, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) // in the Identity and Access Management User Guide . // // This member is required. @@ -77,8 +67,8 @@ type ListRetirableGrantsInput struct { Limit *int32 // Use this parameter in a subsequent request after you receive a response with - // truncated results. Set it to the value of NextMarker from the truncated response - // you just received. + // truncated results. Set it to the value of NextMarker from the truncated + // response you just received. Marker *string noSmithyDocumentSerde @@ -168,8 +158,8 @@ func (c *Client) addOperationListRetirableGrantsMiddlewares(stack *middleware.St return nil } -// ListRetirableGrantsAPIClient is a client that implements the ListRetirableGrants -// operation. +// ListRetirableGrantsAPIClient is a client that implements the +// ListRetirableGrants operation. type ListRetirableGrantsAPIClient interface { ListRetirableGrants(context.Context, *ListRetirableGrantsInput, ...func(*Options)) (*ListRetirableGrantsOutput, error) } diff --git a/service/kms/api_op_PutKeyPolicy.go b/service/kms/api_op_PutKeyPolicy.go index 01f1fa4ba6f..ae0b9596ce3 100644 --- a/service/kms/api_op_PutKeyPolicy.go +++ b/service/kms/api_op_PutKeyPolicy.go @@ -11,18 +11,14 @@ import ( ) // Attaches a key policy to the specified KMS key. For more information about key -// policies, see Key Policies -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the -// Key Management Service Developer Guide. For help writing and formatting a JSON -// policy document, see the IAM JSON Policy Reference -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in -// the Identity and Access Management User Guide . For examples of adding a key -// policy in multiple programming languages, see Setting a key policy -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy) +// policies, see Key Policies (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) +// in the Key Management Service Developer Guide. For help writing and formatting a +// JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) +// in the Identity and Access Management User Guide . For examples of adding a key +// policy in multiple programming languages, see Setting a key policy (https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy) // in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:PutKeyPolicy -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:PutKeyPolicy (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: GetKeyPolicy func (c *Client) PutKeyPolicy(ctx context.Context, params *PutKeyPolicyInput, optFns ...func(*Options)) (*PutKeyPolicyOutput, error) { if params == nil { @@ -43,63 +39,44 @@ type PutKeyPolicyInput struct { // Sets the key policy on the specified KMS key. Specify the key ID or key ARN of // the KMS key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string // The key policy to attach to the KMS key. The key policy must meet the following // criteria: - // - // * The key policy must allow the calling principal to make a - // subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the - // KMS key becomes unmanageable. For more information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) - // in the Key Management Service Developer Guide. (To omit this condition, set - // BypassPolicyLockoutSafetyCheck to true.) - // - // * Each statement in the key policy - // must contain one or more principals. The principals in the key policy must exist - // and be visible to KMS. When you create a new Amazon Web Services principal, you - // might need to enforce a delay before including the new principal in a key policy - // because the new principal might not be immediately visible to KMS. For more - // information, see Changes that I make are not always immediately visible - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) - // in the Amazon Web Services Identity and Access Management User Guide. - // - // A key - // policy document can include only the following characters: - // - // * Printable ASCII - // characters from the space character (\u0020) through the end of the ASCII - // character range. - // - // * Printable characters in the Basic Latin and Latin-1 - // Supplement character set (through \u00FF). - // - // * The tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) special characters - // - // For information about - // key policies, see Key policies in KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Key Management Service Developer Guide.For help writing and formatting a JSON - // policy document, see the IAM JSON Policy Reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in - // the Identity and Access Management User Guide . + // - The key policy must allow the calling principal to make a subsequent + // PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key + // becomes unmanageable. For more information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // in the Key Management Service Developer Guide. (To omit this condition, set + // BypassPolicyLockoutSafetyCheck to true.) + // - Each statement in the key policy must contain one or more principals. The + // principals in the key policy must exist and be visible to KMS. When you create a + // new Amazon Web Services principal, you might need to enforce a delay before + // including the new principal in a key policy because the new principal might not + // be immediately visible to KMS. For more information, see Changes that I make + // are not always immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) + // in the Amazon Web Services Identity and Access Management User Guide. + // A key policy document can include only the following characters: + // - Printable ASCII characters from the space character ( \u0020 ) through the + // end of the ASCII character range. + // - Printable characters in the Basic Latin and Latin-1 Supplement character + // set (through \u00FF ). + // - The tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) + // special characters + // For information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Key Management Service Developer Guide.For help writing and formatting a + // JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // in the Identity and Access Management User Guide . // // This member is required. Policy *string - // The name of the key policy. The only valid value is default. + // The name of the key policy. The only valid value is default . // // This member is required. PolicyName *string @@ -107,8 +84,7 @@ type PutKeyPolicyInput struct { // Skips ("bypasses") the key policy lockout safety check. The default value is // false. Setting this value to true increases the risk that the KMS key becomes // unmanageable. Do not set this value to true indiscriminately. For more - // information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) // in the Key Management Service Developer Guide. Use this parameter only when you // intend to prevent the principal that is making the request from making a // subsequent PutKeyPolicy request on the KMS key. diff --git a/service/kms/api_op_ReEncrypt.go b/service/kms/api_op_ReEncrypt.go index fe0f4e70aa9..4e5d96fee85 100644 --- a/service/kms/api_op_ReEncrypt.go +++ b/service/kms/api_op_ReEncrypt.go @@ -11,93 +11,72 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this -// operation to change the KMS key under which data is encrypted, such as when you -// manually rotate -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually) +// Decrypts ciphertext and then reencrypts it entirely within KMS. You can use +// this operation to change the KMS key under which data is encrypted, such as when +// you manually rotate (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually) // a KMS key or change the KMS key that protects a ciphertext. You can also use it -// to reencrypt ciphertext under the same KMS key, such as to change the encryption -// context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// to reencrypt ciphertext under the same KMS key, such as to change the +// encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // of a ciphertext. The ReEncrypt operation can decrypt ciphertext that was // encrypted by using a KMS key in an KMS operation, such as Encrypt or -// GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the -// public key of an asymmetric KMS key -// (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks) +// GenerateDataKey . It can also decrypt ciphertext that was encrypted by using the +// public key of an asymmetric KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks) // outside of KMS. However, it cannot decrypt ciphertext produced by other -// libraries, such as the Amazon Web Services Encryption SDK -// (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) or Amazon -// S3 client-side encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). -// These libraries return a ciphertext format that is incompatible with KMS. When -// you use the ReEncrypt operation, you need to provide information for the decrypt -// operation and the subsequent encrypt operation. +// libraries, such as the Amazon Web Services Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) +// or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) +// . These libraries return a ciphertext format that is incompatible with KMS. When +// you use the ReEncrypt operation, you need to provide information for the +// decrypt operation and the subsequent encrypt operation. +// - If your ciphertext was encrypted under an asymmetric KMS key, you must use +// the SourceKeyId parameter to identify the KMS key that encrypted the +// ciphertext. You must also supply the encryption algorithm that was used. This +// information is required to decrypt the data. +// - If your ciphertext was encrypted under a symmetric encryption KMS key, the +// SourceKeyId parameter is optional. KMS can get this information from metadata +// that it adds to the symmetric ciphertext blob. This feature adds durability to +// your implementation by ensuring that authorized users can decrypt ciphertext +// decades after it was encrypted, even if they've lost track of the key ID. +// However, specifying the source KMS key is always recommended as a best practice. +// When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the +// KMS key you specify. If the ciphertext was encrypted under a different KMS key, +// the ReEncrypt operation fails. This practice ensures that you use the KMS key +// that you intend. +// - To reencrypt the data, you must use the DestinationKeyId parameter to +// specify the KMS key that re-encrypts the data after it is decrypted. If the +// destination KMS key is an asymmetric KMS key, you must also provide the +// encryption algorithm. The algorithm that you choose must be compatible with the +// KMS key. When you use an asymmetric KMS key to encrypt or reencrypt data, be +// sure to record the KMS key and encryption algorithm that you choose. You will be +// required to provide the same KMS key and encryption algorithm when you decrypt +// the data. If the KMS key and algorithm do not match the values used to encrypt +// the data, the decrypt operation fails. You are not required to supply the key ID +// and encryption algorithm when you decrypt with symmetric encryption KMS keys +// because KMS stores this information in the ciphertext blob. KMS cannot store +// metadata in ciphertext generated with asymmetric keys. The standard format for +// asymmetric key ciphertext does not include configurable fields. // -// * If your ciphertext was -// encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to -// identify the KMS key that encrypted the ciphertext. You must also supply the -// encryption algorithm that was used. This information is required to decrypt the -// data. +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. The +// source KMS key and destination KMS key can be in different Amazon Web Services +// accounts. Either or both KMS keys can be in a different account than the caller. +// To specify a KMS key in a different account, you must use its key ARN or alias +// ARN. Required permissions: +// - kms:ReEncryptFrom (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permission on the source KMS key (key policy) +// - kms:ReEncryptTo (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// permission on the destination KMS key (key policy) // -// * If your ciphertext was encrypted under a symmetric encryption KMS key, -// the SourceKeyId parameter is optional. KMS can get this information from -// metadata that it adds to the symmetric ciphertext blob. This feature adds -// durability to your implementation by ensuring that authorized users can decrypt -// ciphertext decades after it was encrypted, even if they've lost track of the key -// ID. However, specifying the source KMS key is always recommended as a best -// practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses -// only the KMS key you specify. If the ciphertext was encrypted under a different -// KMS key, the ReEncrypt operation fails. This practice ensures that you use the -// KMS key that you intend. -// -// * To reencrypt the data, you must use the -// DestinationKeyId parameter to specify the KMS key that re-encrypts the data -// after it is decrypted. If the destination KMS key is an asymmetric KMS key, you -// must also provide the encryption algorithm. The algorithm that you choose must -// be compatible with the KMS key. When you use an asymmetric KMS key to encrypt or -// reencrypt data, be sure to record the KMS key and encryption algorithm that you -// choose. You will be required to provide the same KMS key and encryption -// algorithm when you decrypt the data. If the KMS key and algorithm do not match -// the values used to encrypt the data, the decrypt operation fails. You are not -// required to supply the key ID and encryption algorithm when you decrypt with -// symmetric encryption KMS keys because KMS stores this information in the -// ciphertext blob. KMS cannot store metadata in ciphertext generated with -// asymmetric keys. The standard format for asymmetric key ciphertext does not -// include configurable fields. -// -// The KMS key that you use for this operation must -// be in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. The source KMS -// key and destination KMS key can be in different Amazon Web Services accounts. -// Either or both KMS keys can be in a different account than the caller. To -// specify a KMS key in a different account, you must use its key ARN or alias ARN. -// Required permissions: -// -// * kms:ReEncryptFrom -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// permission on the source KMS key (key policy) -// -// * kms:ReEncryptTo -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// permission on the destination KMS key (key policy) -// -// To permit reencryption from -// or to a KMS key, include the "kms:ReEncrypt*" permission in your key policy -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html). This -// permission is automatically included in the key policy when you use the console -// to create a KMS key. But you must include it manually when you create a KMS key -// programmatically or when you use the PutKeyPolicy operation to set a key policy. -// Related operations: -// -// * Decrypt -// -// * Encrypt -// -// * GenerateDataKey -// -// * -// GenerateDataKeyPair +// To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" +// permission in your key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) +// . This permission is automatically included in the key policy when you use the +// console to create a KMS key. But you must include it manually when you create a +// KMS key programmatically or when you use the PutKeyPolicy operation to set a +// key policy. Related operations: +// - Decrypt +// - Encrypt +// - GenerateDataKey +// - GenerateDataKeyPair func (c *Client) ReEncrypt(ctx context.Context, params *ReEncryptInput, optFns ...func(*Options)) (*ReEncryptOutput, error) { if params == nil { params = &ReEncryptInput{} @@ -121,33 +100,25 @@ type ReEncryptInput struct { CiphertextBlob []byte // A unique identifier for the KMS key that is used to reencrypt the data. Specify - // a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of - // ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey - // operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias - // ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in - // a different Amazon Web Services account, you must use the key ARN or alias ARN. - // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value + // of ENCRYPT_DECRYPT . To find the KeyUsage value of a KMS key, use the + // DescribeKey operation. To specify a KMS key, use its key ID, key ARN, alias + // name, or alias ARN. When using an alias name, prefix it with "alias/" . To + // specify a KMS key in a different Amazon Web Services account, you must use the + // key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. DestinationKeyId *string // Specifies the encryption algorithm that KMS will use to reecrypt the data after - // it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the + // it has decrypted it. The default value, SYMMETRIC_DEFAULT , represents the // encryption algorithm used for symmetric encryption KMS keys. This parameter is // required only when the destination KMS key is an asymmetric KMS key. DestinationEncryptionAlgorithm types.EncryptionAlgorithmSpec @@ -162,22 +133,19 @@ type ReEncryptInput struct { // encryption context is supported only on operations with symmetric encryption KMS // keys. On operations with symmetric encryption KMS keys, an encryption context is // optional, but it is strongly recommended. For more information, see Encryption - // context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. DestinationEncryptionContext map[string]string // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string // Specifies the encryption algorithm that KMS will use to decrypt the ciphertext - // before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the + // before it is reencrypted. The default value, SYMMETRIC_DEFAULT , represents the // algorithm used for symmetric encryption KMS keys. Specify the same algorithm // that was used to encrypt the ciphertext. If you specify a different algorithm, // the decrypt attempt fails. This parameter is required only when the ciphertext @@ -192,38 +160,28 @@ type ReEncryptInput struct { // the data. An encryption context is supported only on operations with symmetric // encryption KMS keys. On operations with symmetric encryption KMS keys, an // encryption context is optional, but it is strongly recommended. For more - // information, see Encryption context - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) + // information, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the Key Management Service Developer Guide. SourceEncryptionContext map[string]string // Specifies the KMS key that KMS will use to decrypt the ciphertext before it is // re-encrypted. Enter a key ID of the KMS key that was used to encrypt the // ciphertext. If you identify a different KMS key, the ReEncrypt operation throws - // an IncorrectKeyException. This parameter is required only when the ciphertext + // an IncorrectKeyException . This parameter is required only when the ciphertext // was encrypted under an asymmetric KMS key. If you used a symmetric encryption // KMS key, KMS can get the KMS key from metadata that it adds to the symmetric // ciphertext blob. However, it is always recommended as a best practice. This // practice ensures that you use the KMS key that you intend. To specify a KMS key, // use its key ID, key ARN, alias name, or alias ARN. When using an alias name, - // prefix it with "alias/". To specify a KMS key in a different Amazon Web Services - // account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // prefix it with "alias/" . To specify a KMS key in a different Amazon Web + // Services account, you must use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . SourceKeyId *string noSmithyDocumentSerde @@ -238,9 +196,8 @@ type ReEncryptOutput struct { // The encryption algorithm that was used to reencrypt the data. DestinationEncryptionAlgorithm types.EncryptionAlgorithmSpec - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key that was used to reencrypt the data. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key that was used to reencrypt the data. KeyId *string // The encryption algorithm that was used to decrypt the ciphertext before it was diff --git a/service/kms/api_op_ReplicateKey.go b/service/kms/api_op_ReplicateKey.go index bb2a156fa2b..30eecd382cd 100644 --- a/service/kms/api_op_ReplicateKey.go +++ b/service/kms/api_op_ReplicateKey.go @@ -22,45 +22,37 @@ import ( // interchangeably to encrypt data in one Amazon Web Services Region and decrypt it // in a different Amazon Web Services Region without re-encrypting the data or // making a cross-Region call. For more information about multi-Region keys, see -// Multi-Region keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) +// Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. A replica key is a // fully-functional KMS key that can be used independently of its primary and peer // replica keys. A primary key and its replica keys share properties that make them -// interoperable. They have the same key ID -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) -// and key material. They also have the same key spec -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec), -// key usage -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage), -// key material origin -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin), -// and automatic key rotation status -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html). KMS -// automatically synchronizes these shared properties among related multi-Region -// keys. All other properties of a replica key can differ, including its key policy -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html), tags -// (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html), -// aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html), -// and Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html). KMS -// pricing and quotas for KMS keys apply to each primary key and replica key. When -// this operation completes, the new replica key has a transient key state of -// Creating. This key state changes to Enabled (or PendingImport) after a few +// interoperable. They have the same key ID (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) +// and key material. They also have the same key spec (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec) +// , key usage (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage) +// , key material origin (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin) +// , and automatic key rotation status (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) +// . KMS automatically synchronizes these shared properties among related +// multi-Region keys. All other properties of a replica key can differ, including +// its key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) +// , tags (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) +// , aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) +// , and Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// . KMS pricing and quotas for KMS keys apply to each primary key and replica key. +// When this operation completes, the new replica key has a transient key state of +// Creating . This key state changes to Enabled (or PendingImport ) after a few // seconds when the process of creating the new replica key is complete. While the -// key state is Creating, you can manage key, but you cannot yet use it in +// key state is Creating , you can manage key, but you cannot yet use it in // cryptographic operations. If you are creating and using the replica key -// programmatically, retry on KMSInvalidStateException or call DescribeKey to check -// its KeyState value before using it. For details about the Creating key state, -// see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. You cannot create more than one replica -// of a primary key in any Region. If the Region already includes a replica of the -// key you're trying to replicate, ReplicateKey returns an AlreadyExistsException -// error. If the key state of the existing replica is PendingDeletion, you can -// cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be -// deleted. The new replica key you create will have the same shared properties -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties) +// programmatically, retry on KMSInvalidStateException or call DescribeKey to +// check its KeyState value before using it. For details about the Creating key +// state, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. You cannot create more than one +// replica of a primary key in any Region. If the Region already includes a replica +// of the key you're trying to replicate, ReplicateKey returns an +// AlreadyExistsException error. If the key state of the existing replica is +// PendingDeletion , you can cancel the scheduled key deletion ( CancelKeyDeletion +// ) or wait for the key to be deleted. The new replica key you create will have +// the same shared properties (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties) // as the original replica key. The CloudTrail log of a ReplicateKey operation // records a ReplicateKey operation in the primary key's Region and a CreateKey // operation in the replica key's Region. If you replicate a multi-Region primary @@ -69,26 +61,19 @@ import ( // For details, see Importing key material into multi-Region keys in the Key // Management Service Developer Guide. To convert a replica key to a primary key, // use the UpdatePrimaryRegion operation. ReplicateKey uses different default -// values for the KeyPolicy and Tags parameters than those used in the KMS console. -// For details, see the parameter descriptions. Cross-account use: No. You cannot -// use this operation to create a replica key in a different Amazon Web Services -// account. Required permissions: +// values for the KeyPolicy and Tags parameters than those used in the KMS +// console. For details, see the parameter descriptions. Cross-account use: No. You +// cannot use this operation to create a replica key in a different Amazon Web +// Services account. Required permissions: +// - kms:ReplicateKey on the primary key (in the primary key's Region). Include +// this permission in the primary key's key policy. +// - kms:CreateKey in an IAM policy in the replica Region. +// - To use the Tags parameter, kms:TagResource in an IAM policy in the replica +// Region. // -// * kms:ReplicateKey on the primary key (in the -// primary key's Region). Include this permission in the primary key's key -// policy. -// -// * kms:CreateKey in an IAM policy in the replica Region. -// -// * To use the -// Tags parameter, kms:TagResource in an IAM policy in the replica Region. -// -// Related -// operations -// -// * CreateKey -// -// * UpdatePrimaryRegion +// Related operations +// - CreateKey +// - UpdatePrimaryRegion func (c *Client) ReplicateKey(ctx context.Context, params *ReplicateKeyInput, optFns ...func(*Options)) (*ReplicateKeyOutput, error) { if params == nil { params = &ReplicateKeyInput{} @@ -108,43 +93,33 @@ type ReplicateKeyInput struct { // Identifies the multi-Region primary key that is being replicated. To determine // whether a KMS key is a multi-Region primary key, use the DescribeKey operation - // to check the value of the MultiRegionKeyType property. Specify the key ID or key - // ARN of a multi-Region primary key. For example: - // - // * Key ID: - // mrk-1234abcd12ab34cd56ef1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // to check the value of the MultiRegionKeyType property. Specify the key ID or + // key ARN of a multi-Region primary key. For example: + // - Key ID: mrk-1234abcd12ab34cd56ef1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string // The Region ID of the Amazon Web Services Region for this replica key. Enter the - // Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web - // Services Regions in which KMS is supported, see KMS service endpoints - // (https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region) in the - // Amazon Web Services General Reference. HMAC KMS keys are not supported in all - // Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an + // Region ID, such as us-east-1 or ap-southeast-2 . For a list of Amazon Web + // Services Regions in which KMS is supported, see KMS service endpoints (https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region) + // in the Amazon Web Services General Reference. HMAC KMS keys are not supported in + // all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an // Amazon Web Services Region in which HMAC keys are not supported, the - // ReplicateKey operation returns an UnsupportedOperationException. For a list of - // Regions in which HMAC KMS keys are supported, see HMAC keys in KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the Key - // Management Service Developer Guide. The replica must be in a different Amazon - // Web Services Region than its primary key and other replicas of that primary key, - // but in the same Amazon Web Services partition. KMS must be available in the - // replica Region. If the Region is not enabled by default, the Amazon Web Services - // account must be enabled in the Region. For information about Amazon Web Services - // partitions, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. For information about enabling and - // disabling Regions, see Enabling a Region - // (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) - // and Disabling a Region - // (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable) + // ReplicateKey operation returns an UnsupportedOperationException . For a list of + // Regions in which HMAC KMS keys are supported, see HMAC keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) + // in the Key Management Service Developer Guide. The replica must be in a + // different Amazon Web Services Region than its primary key and other replicas of + // that primary key, but in the same Amazon Web Services partition. KMS must be + // available in the replica Region. If the Region is not enabled by default, the + // Amazon Web Services account must be enabled in the Region. For information about + // Amazon Web Services partitions, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. For information about enabling and + // disabling Regions, see Enabling a Region (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) + // and Disabling a Region (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable) // in the Amazon Web Services General Reference. // // This member is required. @@ -153,8 +128,7 @@ type ReplicateKeyInput struct { // Skips ("bypasses") the key policy lockout safety check. The default value is // false. Setting this value to true increases the risk that the KMS key becomes // unmanageable. Do not set this value to true indiscriminately. For more - // information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) // in the Key Management Service Developer Guide. Use this parameter only when you // intend to prevent the principal that is making the request from making a // subsequent PutKeyPolicy request on the KMS key. @@ -167,60 +141,42 @@ type ReplicateKeyInput struct { Description *string // The key policy to attach to the KMS key. This parameter is optional. If you do - // not provide a key policy, KMS attaches the default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) + // not provide a key policy, KMS attaches the default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) // to the KMS key. The key policy is not a shared property of multi-Region keys. // You can specify the same key policy or a different key policy for each key in a // set of related multi-Region keys. KMS does not synchronize this property. If you // provide a key policy, it must meet the following criteria: - // - // * The key policy - // must allow the calling principal to make a subsequent PutKeyPolicy request on - // the KMS key. This reduces the risk that the KMS key becomes unmanageable. For - // more information, see Default key policy - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) - // in the Key Management Service Developer Guide. (To omit this condition, set - // BypassPolicyLockoutSafetyCheck to true.) - // - // * Each statement in the key policy - // must contain one or more principals. The principals in the key policy must exist - // and be visible to KMS. When you create a new Amazon Web Services principal, you - // might need to enforce a delay before including the new principal in a key policy - // because the new principal might not be immediately visible to KMS. For more - // information, see Changes that I make are not always immediately visible - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) - // in the Amazon Web Services Identity and Access Management User Guide. - // - // A key - // policy document can include only the following characters: - // - // * Printable ASCII - // characters from the space character (\u0020) through the end of the ASCII - // character range. - // - // * Printable characters in the Basic Latin and Latin-1 - // Supplement character set (through \u00FF). - // - // * The tab (\u0009), line feed - // (\u000A), and carriage return (\u000D) special characters - // - // For information about - // key policies, see Key policies in KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Key Management Service Developer Guide. For help writing and formatting a JSON - // policy document, see the IAM JSON Policy Reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) in - // the Identity and Access Management User Guide . + // - The key policy must allow the calling principal to make a subsequent + // PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key + // becomes unmanageable. For more information, see Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) + // in the Key Management Service Developer Guide. (To omit this condition, set + // BypassPolicyLockoutSafetyCheck to true.) + // - Each statement in the key policy must contain one or more principals. The + // principals in the key policy must exist and be visible to KMS. When you create a + // new Amazon Web Services principal, you might need to enforce a delay before + // including the new principal in a key policy because the new principal might not + // be immediately visible to KMS. For more information, see Changes that I make + // are not always immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) + // in the Amazon Web Services Identity and Access Management User Guide. + // A key policy document can include only the following characters: + // - Printable ASCII characters from the space character ( \u0020 ) through the + // end of the ASCII character range. + // - Printable characters in the Basic Latin and Latin-1 Supplement character + // set (through \u00FF ). + // - The tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) + // special characters + // For information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Key Management Service Developer Guide. For help writing and formatting a + // JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // in the Identity and Access Management User Guide . Policy *string // Assigns one or more tags to the replica key. Use this parameter to tag the KMS // key when it is created. To tag an existing KMS key, use the TagResource // operation. Tagging or untagging a KMS key can allow or deny permission to the - // KMS key. For details, see ABAC for KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key - // Management Service Developer Guide. To use this parameter, you must have - // kms:TagResource - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) + // KMS key. For details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) + // in the Key Management Service Developer Guide. To use this parameter, you must + // have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // permission in an IAM policy. Tags are not a shared property of multi-Region // keys. You can specify the same tags or different tags for each key in a set of // related multi-Region keys. KMS does not synchronize this property. Each tag @@ -231,8 +187,8 @@ type ReplicateKeyInput struct { // specified one. When you add tags to an Amazon Web Services resource, Amazon Web // Services generates a cost allocation report with usage and costs aggregated by // tags. Tags can also be used to control access to a KMS key. For details, see - // Tagging Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). + // Tagging Keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -240,13 +196,11 @@ type ReplicateKeyInput struct { type ReplicateKeyOutput struct { - // Displays details about the new replica key, including its Amazon Resource Name - // (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // and Key states of KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html). It also - // includes the ARN and Amazon Web Services Region of its primary key and other - // replica keys. + // Displays details about the new replica key, including its Amazon Resource Name ( + // key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) and Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) + // . It also includes the ARN and Amazon Web Services Region of its primary key and + // other replica keys. ReplicaKeyMetadata *types.KeyMetadata // The key policy of the new replica key. The value is a key policy document in diff --git a/service/kms/api_op_RetireGrant.go b/service/kms/api_op_RetireGrant.go index adb4876b924..fb87bb6917c 100644 --- a/service/kms/api_op_RetireGrant.go +++ b/service/kms/api_op_RetireGrant.go @@ -11,36 +11,26 @@ import ( ) // Deletes a grant. Typically, you retire a grant when you no longer need its -// permissions. To identify the grant to retire, use a grant token -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token), -// or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. +// permissions. To identify the grant to retire, use a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) +// , or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. // The CreateGrant operation returns both values. This operation can be called by // the retiring principal for a grant, by the grantee principal if the grant allows // the RetireGrant operation, and by the Amazon Web Services account in which the // grant is created. It can also be called by principals to whom permission for -// retiring a grant is delegated. For details, see Retiring and revoking grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) +// retiring a grant is delegated. For details, see Retiring and revoking grants (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) // in the Key Management Service Developer Guide. For detailed information about -// grants, including grant terminology, see Grants in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the Key -// Management Service Developer Guide . For examples of working with grants in -// several programming languages, see Programming grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html). -// Cross-account use: Yes. You can retire a grant on a KMS key in a different +// grants, including grant terminology, see Grants in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) +// in the Key Management Service Developer Guide . For examples of working with +// grants in several programming languages, see Programming grants (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html) +// . Cross-account use: Yes. You can retire a grant on a KMS key in a different // Amazon Web Services account. Required permissions::Permission to retire a grant // is determined primarily by the grant. For details, see Retiring and revoking -// grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) +// grants (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete) // in the Key Management Service Developer Guide. Related operations: -// -// * -// CreateGrant -// -// * ListGrants -// -// * ListRetirableGrants -// -// * RevokeGrant +// - CreateGrant +// - ListGrants +// - ListRetirableGrants +// - RevokeGrant func (c *Client) RetireGrant(ctx context.Context, params *RetireGrantInput, optFns ...func(*Options)) (*RetireGrantOutput, error) { if params == nil { params = &RetireGrantInput{} @@ -58,19 +48,16 @@ func (c *Client) RetireGrant(ctx context.Context, params *RetireGrantInput, optF type RetireGrantInput struct { - // Identifies the grant to retire. To get the grant ID, use CreateGrant, - // ListGrants, or ListRetirableGrants. - // - // * Grant ID Example - - // 0123456789012345678901234567890123456789012345678901234567890123 + // Identifies the grant to retire. To get the grant ID, use CreateGrant , + // ListGrants , or ListRetirableGrants . + // - Grant ID Example - + // 0123456789012345678901234567890123456789012345678901234567890123 GrantId *string // Identifies the grant to be retired. You can use a grant token to identify a new // grant even before it has achieved eventual consistency. Only the CreateGrant - // operation returns a grant token. For details, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Eventual consistency - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency) + // operation returns a grant token. For details, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency) // in the Key Management Service Developer Guide. GrantToken *string diff --git a/service/kms/api_op_RevokeGrant.go b/service/kms/api_op_RevokeGrant.go index 75676053d4c..7b9b580d889 100644 --- a/service/kms/api_op_RevokeGrant.go +++ b/service/kms/api_op_RevokeGrant.go @@ -11,33 +11,23 @@ import ( ) // Deletes the specified grant. You revoke a grant to terminate the permissions -// that the grant allows. For more information, see Retiring and revoking grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete) +// that the grant allows. For more information, see Retiring and revoking grants (https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete) // in the Key Management Service Developer Guide . When you create, retire, or // revoke a grant, there might be a brief delay, usually less than five minutes, // until the grant is available throughout KMS. This state is known as eventual -// consistency. For details, see Eventual consistency -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency) +// consistency. For details, see Eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency) // in the Key Management Service Developer Guide . For detailed information about -// grants, including grant terminology, see Grants in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the Key -// Management Service Developer Guide . For examples of working with grants in -// several programming languages, see Programming grants -// (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html). -// Cross-account use: Yes. To perform this operation on a KMS key in a different +// grants, including grant terminology, see Grants in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) +// in the Key Management Service Developer Guide . For examples of working with +// grants in several programming languages, see Programming grants (https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html) +// . Cross-account use: Yes. To perform this operation on a KMS key in a different // Amazon Web Services account, specify the key ARN in the value of the KeyId -// parameter. Required permissions: kms:RevokeGrant -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// parameter. Required permissions: kms:RevokeGrant (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy). Related operations: -// -// * CreateGrant -// -// * ListGrants -// -// * -// ListRetirableGrants -// -// * RetireGrant +// - CreateGrant +// - ListGrants +// - ListRetirableGrants +// - RetireGrant func (c *Client) RevokeGrant(ctx context.Context, params *RevokeGrantInput, optFns ...func(*Options)) (*RevokeGrantOutput, error) { if params == nil { params = &RevokeGrantInput{} @@ -55,25 +45,20 @@ func (c *Client) RevokeGrant(ctx context.Context, params *RevokeGrantInput, optF type RevokeGrantInput struct { - // Identifies the grant to revoke. To get the grant ID, use CreateGrant, - // ListGrants, or ListRetirableGrants. + // Identifies the grant to revoke. To get the grant ID, use CreateGrant , + // ListGrants , or ListRetirableGrants . // // This member is required. GrantId *string - // A unique identifier for the KMS key associated with the grant. To get the key ID - // and key ARN for a KMS key, use ListKeys or DescribeKey. Specify the key ID or - // key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services - // account, you must use the key ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // A unique identifier for the KMS key associated with the grant. To get the key + // ID and key ARN for a KMS key, use ListKeys or DescribeKey . Specify the key ID + // or key ARN of the KMS key. To specify a KMS key in a different Amazon Web + // Services account, you must use the key ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_ScheduleKeyDeletion.go b/service/kms/api_op_ScheduleKeyDeletion.go index 5d8b2891289..904bca856ef 100644 --- a/service/kms/api_op_ScheduleKeyDeletion.go +++ b/service/kms/api_op_ScheduleKeyDeletion.go @@ -12,54 +12,46 @@ import ( "time" ) -// Schedules the deletion of a KMS key. By default, KMS applies a waiting period of -// 30 days, but you can specify a waiting period of 7-30 days. When this operation -// is successful, the key state of the KMS key changes to PendingDeletion and the -// key can't be used in any cryptographic operations. It remains in this state for -// the duration of the waiting period. Before the waiting period ends, you can use -// CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting -// period ends, KMS deletes the KMS key, its key material, and all KMS data +// Schedules the deletion of a KMS key. By default, KMS applies a waiting period +// of 30 days, but you can specify a waiting period of 7-30 days. When this +// operation is successful, the key state of the KMS key changes to PendingDeletion +// and the key can't be used in any cryptographic operations. It remains in this +// state for the duration of the waiting period. Before the waiting period ends, +// you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the +// waiting period ends, KMS deletes the KMS key, its key material, and all KMS data // associated with it, including all aliases that refer to it. Deleting a KMS key // is a destructive and potentially dangerous operation. When a KMS key is deleted, // all data that was encrypted under the KMS key is unrecoverable. (The only // exception is a multi-Region replica key.) To prevent the use of a KMS key -// without deleting it, use DisableKey. You can schedule the deletion of a +// without deleting it, use DisableKey . You can schedule the deletion of a // multi-Region primary key and its replica keys at any time. However, KMS will not // delete a multi-Region primary key with existing replica keys. If you schedule // the deletion of a primary key with replicas, its key state changes to // PendingReplicaDeletion and it cannot be replicated or used in cryptographic // operations. This status can continue indefinitely. When the last of its replicas // keys is deleted (not just scheduled), the key state of the primary key changes -// to PendingDeletion and its waiting period (PendingWindowInDays) begins. For -// details, see Deleting multi-Region keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) +// to PendingDeletion and its waiting period ( PendingWindowInDays ) begins. For +// details, see Deleting multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) // in the Key Management Service Developer Guide. When KMS deletes a KMS key from -// an CloudHSM key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html), -// it makes a best effort to delete the associated key material from the associated -// CloudHSM cluster. However, you might need to manually delete the orphaned key -// material -// (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) -// from the cluster and its backups. Deleting a KMS key from an external key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html) has -// no effect on the associated external key. However, for both types of custom key -// stores, deleting a KMS key is destructive and irreversible. You cannot decrypt -// ciphertext encrypted under the KMS key by using only its associated external key -// or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by -// creating a new KMS key with the same key material. For more information about -// scheduling a KMS key for deletion, see Deleting KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in -// the Key Management Service Developer Guide. The KMS key that you use for this +// an CloudHSM key store (https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html) +// , it makes a best effort to delete the associated key material from the +// associated CloudHSM cluster. However, you might need to manually delete the +// orphaned key material (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) +// from the cluster and its backups. Deleting a KMS key from an external key store (https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html) +// has no effect on the associated external key. However, for both types of custom +// key stores, deleting a KMS key is destructive and irreversible. You cannot +// decrypt ciphertext encrypted under the KMS key by using only its associated +// external key or CloudHSM key. Also, you cannot recreate a KMS key in an external +// key store by creating a new KMS key with the same key material. For more +// information about scheduling a KMS key for deletion, see Deleting KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) +// in the Key Management Service Developer Guide. The KMS key that you use for this // operation must be in a compatible key state. For details, see Key states of KMS // keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in // the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. // Required permissions: kms:ScheduleKeyDeletion (key policy) Related operations -// -// * -// CancelKeyDeletion -// -// * DisableKey +// - CancelKeyDeletion +// - DisableKey func (c *Client) ScheduleKeyDeletion(ctx context.Context, params *ScheduleKeyDeletionInput, optFns ...func(*Options)) (*ScheduleKeyDeletionOutput, error) { if params == nil { params = &ScheduleKeyDeletionInput{} @@ -77,17 +69,12 @@ func (c *Client) ScheduleKeyDeletion(ctx context.Context, params *ScheduleKeyDel type ScheduleKeyDeletionInput struct { - // The unique identifier of the KMS key to delete. Specify the key ID or key ARN of - // the KMS key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // The unique identifier of the KMS key to delete. Specify the key ID or key ARN + // of the KMS key. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string @@ -111,15 +98,13 @@ type ScheduleKeyDeletionOutput struct { // deleted. DeletionDate *time.Time - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the KMS key whose deletion is scheduled. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the KMS key whose deletion is scheduled. KeyId *string // The current status of the KMS key. For more information about how key state - // affects the use of a KMS key, see Key states of KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the - // Key Management Service Developer Guide. + // affects the use of a KMS key, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) + // in the Key Management Service Developer Guide. KeyState types.KeyState // The waiting period before the KMS key is deleted. If the KMS key is a diff --git a/service/kms/api_op_Sign.go b/service/kms/api_op_Sign.go index d7ec4f8b708..537ce0f3b4b 100644 --- a/service/kms/api_op_Sign.go +++ b/service/kms/api_op_Sign.go @@ -15,8 +15,7 @@ import ( // for a message or message digest by using the private key in an asymmetric // signing KMS key. To verify the signature, use the Verify operation, or use the // public key in the same asymmetric KMS key outside of KMS. For information about -// asymmetric KMS keys, see Asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// asymmetric KMS keys, see Asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. Digital signatures are generated // and verified by using asymmetric key pair, such as an RSA or ECC pair that is // represented by an asymmetric KMS key. The key owner (or an authorized user) uses @@ -24,39 +23,32 @@ import ( // the message was signed with that particular private key and that the message // hasn't changed since it was signed. To use the Sign operation, provide the // following information: +// - Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage +// value of SIGN_VERIFY . To get the KeyUsage value of a KMS key, use the +// DescribeKey operation. The caller must have kms:Sign permission on the KMS +// key. +// - Use the Message parameter to specify the message or message digest to sign. +// You can submit messages of up to 4096 bytes. To sign a larger message, generate +// a hash digest of the message, and then provide the hash digest in the Message +// parameter. To indicate whether the message is a full message or a digest, use +// the MessageType parameter. +// - Choose a signing algorithm that is compatible with the KMS key. // -// * Use the KeyId parameter to identify an asymmetric KMS -// key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS -// key, use the DescribeKey operation. The caller must have kms:Sign permission on -// the KMS key. -// -// * Use the Message parameter to specify the message or message -// digest to sign. You can submit messages of up to 4096 bytes. To sign a larger -// message, generate a hash digest of the message, and then provide the hash digest -// in the Message parameter. To indicate whether the message is a full message or a -// digest, use the MessageType parameter. -// -// * Choose a signing algorithm that is -// compatible with the KMS key. -// -// When signing a message, be sure to record the KMS -// key and the signing algorithm. This information is required to verify the -// signature. Best practices recommend that you limit the time during which any -// signature is effective. This deters an attack where the actor uses a signed -// message to establish validity repeatedly or long after the message is -// superseded. Signatures do not include a timestamp, but you can include a -// timestamp in the signed message to help you detect when its time to refresh the -// signature. To verify the signature that this operation generates, use the Verify -// operation. Or use the GetPublicKey operation to download the public key and then -// use the public key to verify the signature outside of KMS. The KMS key that you -// use for this operation must be in a compatible key state. For details, see Key -// states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation with a KMS key in a different Amazon Web Services account, specify the -// key ARN or alias ARN in the value of the KeyId parameter. Required permissions: -// kms:Sign -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// When signing a message, be sure to record the KMS key and the signing +// algorithm. This information is required to verify the signature. Best practices +// recommend that you limit the time during which any signature is effective. This +// deters an attack where the actor uses a signed message to establish validity +// repeatedly or long after the message is superseded. Signatures do not include a +// timestamp, but you can include a timestamp in the signed message to help you +// detect when its time to refresh the signature. To verify the signature that this +// operation generates, use the Verify operation. Or use the GetPublicKey +// operation to download the public key and then use the public key to verify the +// signature outside of KMS. The KMS key that you use for this operation must be in +// a compatible key state. For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation with a KMS key in a different Amazon Web Services +// account, specify the key ARN or alias ARN in the value of the KeyId parameter. +// Required permissions: kms:Sign (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: Verify func (c *Client) Sign(ctx context.Context, params *SignInput, optFns ...func(*Options)) (*SignOutput, error) { if params == nil { @@ -75,28 +67,20 @@ func (c *Client) Sign(ctx context.Context, params *SignInput, optFns ...func(*Op type SignInput struct { - // Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS - // key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. - // To find the KeyUsage of a KMS key, use the DescribeKey operation. To specify a - // KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias - // name, prefix it with "alias/". To specify a KMS key in a different Amazon Web - // Services account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric + // KMS key to sign the message. The KeyUsage type of the KMS key must be + // SIGN_VERIFY . To find the KeyUsage of a KMS key, use the DescribeKey operation. + // To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When + // using an alias name, prefix it with "alias/" . To specify a KMS key in a + // different Amazon Web Services account, you must use the key ARN or alias ARN. + // For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string @@ -120,40 +104,31 @@ type SignInput struct { // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string - // Tells KMS whether the value of the Message parameter should be hashed as part of - // the signing algorithm. Use RAW for unhashed messages; use DIGEST for message - // digests, which are already hashed. When the value of MessageType is RAW, KMS + // Tells KMS whether the value of the Message parameter should be hashed as part + // of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message + // digests, which are already hashed. When the value of MessageType is RAW , KMS // uses the standard signing algorithm, which begins with a hash function. When the - // value is DIGEST, KMS skips the hashing step in the signing algorithm. Use the + // value is DIGEST , KMS skips the hashing step in the signing algorithm. Use the // DIGEST value only when the value of the Message parameter is a message digest. // If you use the DIGEST value with an unhashed message, the security of the - // signing operation can be compromised. When the value of MessageTypeis DIGEST, - // the length of the Message value must match the length of hashed messages for the - // specified signing algorithm. You can submit a message digest and omit the - // MessageType or specify RAW so the digest is hashed again while signing. However, - // this can cause verification failures when verifying with a system that assumes a - // single hash. The hashing algorithm in that Sign uses is based on the + // signing operation can be compromised. When the value of MessageType is DIGEST , + // the length of the Message value must match the length of hashed messages for + // the specified signing algorithm. You can submit a message digest and omit the + // MessageType or specify RAW so the digest is hashed again while signing. + // However, this can cause verification failures when verifying with a system that + // assumes a single hash. The hashing algorithm in that Sign uses is based on the // SigningAlgorithm value. - // - // * Signing algorithms that end in SHA_256 use the - // SHA_256 hashing algorithm. - // - // * Signing algorithms that end in SHA_384 use the - // SHA_384 hashing algorithm. - // - // * Signing algorithms that end in SHA_512 use the - // SHA_512 hashing algorithm. - // - // * SM2DSA uses the SM3 hashing algorithm. For - // details, see Offline verification with SM2 key pairs - // (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification). + // - Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm. + // - Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm. + // - Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm. + // - SM2DSA uses the SM3 hashing algorithm. For details, see Offline + // verification with SM2 key pairs (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification) + // . MessageType types.MessageType noSmithyDocumentSerde @@ -161,26 +136,21 @@ type SignInput struct { type SignOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the asymmetric KMS key that was used to sign the message. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the asymmetric KMS key that was used to sign the message. KeyId *string // The cryptographic signature that was generated for the message. - // - // * When used - // with the supported RSA signing algorithms, the encoding of this value is defined - // by PKCS #1 in RFC 8017 (https://tools.ietf.org/html/rfc8017). - // - // * When used with - // the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this - // value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section - // 2.2.3 (https://tools.ietf.org/html/rfc3279#section-2.2.3). This is the most - // commonly used signature format and is appropriate for most uses. - // - // When you use - // the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. - // Otherwise, it is not Base64-encoded. + // - When used with the supported RSA signing algorithms, the encoding of this + // value is defined by PKCS #1 in RFC 8017 (https://tools.ietf.org/html/rfc8017) + // . + // - When used with the ECDSA_SHA_256 , ECDSA_SHA_384 , or ECDSA_SHA_512 signing + // algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and + // RFC 3279 Section 2.2.3 (https://tools.ietf.org/html/rfc3279#section-2.2.3) . + // This is the most commonly used signature format and is appropriate for most + // uses. + // When you use the HTTP API or the Amazon Web Services CLI, the value is + // Base64-encoded. Otherwise, it is not Base64-encoded. Signature []byte // The signing algorithm that was used to sign the message. diff --git a/service/kms/api_op_TagResource.go b/service/kms/api_op_TagResource.go index c7358175cbb..649f93a3e7a 100644 --- a/service/kms/api_op_TagResource.go +++ b/service/kms/api_op_TagResource.go @@ -11,48 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or edits tags on a customer managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). -// Tagging or untagging a KMS key can allow or deny permission to the KMS key. For -// details, see ABAC for KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key -// Management Service Developer Guide. Each tag consists of a tag key and a tag -// value, both of which are case-sensitive strings. The tag value can be an empty -// (null) string. To add a tag, specify a new tag key and a tag value. To edit a -// tag, specify an existing tag key and a new tag value. You can use this operation -// to tag a customer managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk), -// but you cannot tag an Amazon Web Services managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk), -// an Amazon Web Services owned key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk), -// a custom key store -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept), -// or an alias -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept). -// You can also add tags to a KMS key while creating it (CreateKey) or replicating -// it (ReplicateKey). For information about using tags in KMS, see Tagging keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). For -// general information about tags, including the format and syntax, see Tagging -// Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. The KMS key that you use for this operation must -// be in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// Adds or edits tags on a customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// . Tagging or untagging a KMS key can allow or deny permission to the KMS key. +// For details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) +// in the Key Management Service Developer Guide. Each tag consists of a tag key +// and a tag value, both of which are case-sensitive strings. The tag value can be +// an empty (null) string. To add a tag, specify a new tag key and a tag value. To +// edit a tag, specify an existing tag key and a new tag value. You can use this +// operation to tag a customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// , but you cannot tag an Amazon Web Services managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// , an Amazon Web Services owned key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) +// , a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept) +// , or an alias (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept) +// . You can also add tags to a KMS key while creating it ( CreateKey ) or +// replicating it ( ReplicateKey ). For information about using tags in KMS, see +// Tagging keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) +// . For general information about tags, including the format and syntax, see +// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. The KMS key that you use for this +// operation must be in a compatible key state. For details, see Key states of KMS +// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in +// the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:TagResource -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations -// -// * CreateKey -// -// * ListResourceTags -// -// * -// ReplicateKey -// -// * UntagResource +// - CreateKey +// - ListResourceTags +// - ReplicateKey +// - UntagResource func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -72,15 +58,10 @@ type TagResourceInput struct { // Identifies a customer managed key in the account and Region. Specify the key ID // or key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_UntagResource.go b/service/kms/api_op_UntagResource.go index 121e4abdee1..dca3d329e3e 100644 --- a/service/kms/api_op_UntagResource.go +++ b/service/kms/api_op_UntagResource.go @@ -10,37 +10,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes tags from a customer managed key -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). -// To delete a tag, specify the tag key and the KMS key. Tagging or untagging a KMS -// key can allow or deny permission to the KMS key. For details, see ABAC for KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key +// Deletes tags from a customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) +// . To delete a tag, specify the tag key and the KMS key. Tagging or untagging a +// KMS key can allow or deny permission to the KMS key. For details, see ABAC for +// KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key // Management Service Developer Guide. When it succeeds, the UntagResource // operation doesn't return any output. Also, if the specified tag key isn't found // on the KMS key, it doesn't throw an exception or return a response. To confirm // that the operation worked, use the ListResourceTags operation. For information -// about using tags in KMS, see Tagging keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). For -// general information about tags, including the format and syntax, see Tagging -// Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. The KMS key that you use for this operation must -// be in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// about using tags in KMS, see Tagging keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) +// . For general information about tags, including the format and syntax, see +// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. The KMS key that you use for this +// operation must be in a compatible key state. For details, see Key states of KMS +// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in +// the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:UntagResource -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:UntagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations -// -// * CreateKey -// -// * ListResourceTags -// -// * -// ReplicateKey -// -// * TagResource +// - CreateKey +// - ListResourceTags +// - ReplicateKey +// - TagResource func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -60,15 +51,10 @@ type UntagResourceInput struct { // Identifies the KMS key from which you are removing tags. Specify the key ID or // key ARN of the KMS key. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_UpdateAlias.go b/service/kms/api_op_UpdateAlias.go index 74d1a329aaf..f8979a1d982 100644 --- a/service/kms/api_op_UpdateAlias.go +++ b/service/kms/api_op_UpdateAlias.go @@ -14,47 +14,35 @@ import ( // associated with only one KMS key at a time, although a KMS key can have multiple // aliases. The alias and the KMS key must be in the same Amazon Web Services // account and Region. Adding, deleting, or updating an alias can allow or deny -// permission to the KMS key. For details, see ABAC for KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the Key -// Management Service Developer Guide. The current and new KMS key must be the same -// type (both symmetric or both asymmetric or both HMAC), and they must have the -// same key usage. This restriction prevents errors in code that uses aliases. If -// you must assign an alias to a different type of KMS key, use DeleteAlias to -// delete the old alias and CreateAlias to create a new alias. You cannot use -// UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to -// delete the old alias and CreateAlias to create a new alias. Because an alias is -// not a property of a KMS key, you can create, update, and delete the aliases of a -// KMS key without affecting the KMS key. Also, aliases do not appear in the -// response from the DescribeKey operation. To get the aliases of all KMS keys in -// the account, use the ListAliases operation. The KMS key that you use for this -// operation must be in a compatible key state. For details, see Key states of KMS -// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in -// the Key Management Service Developer Guide. Cross-account use: No. You cannot +// permission to the KMS key. For details, see ABAC for KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) +// in the Key Management Service Developer Guide. The current and new KMS key must +// be the same type (both symmetric or both asymmetric or both HMAC), and they must +// have the same key usage. This restriction prevents errors in code that uses +// aliases. If you must assign an alias to a different type of KMS key, use +// DeleteAlias to delete the old alias and CreateAlias to create a new alias. You +// cannot use UpdateAlias to change an alias name. To change an alias name, use +// DeleteAlias to delete the old alias and CreateAlias to create a new alias. +// Because an alias is not a property of a KMS key, you can create, update, and +// delete the aliases of a KMS key without affecting the KMS key. Also, aliases do +// not appear in the response from the DescribeKey operation. To get the aliases +// of all KMS keys in the account, use the ListAliases operation. The KMS key that +// you use for this operation must be in a compatible key state. For details, see +// Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. // Required permissions +// - kms:UpdateAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the alias (IAM policy). +// - kms:UpdateAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the current KMS key (key policy). +// - kms:UpdateAlias (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// on the new KMS key (key policy). // -// * kms:UpdateAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the alias (IAM policy). -// -// * kms:UpdateAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the current KMS key (key policy). -// -// * kms:UpdateAlias -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// on the new KMS key (key policy). -// -// For details, see Controlling access to aliases -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) +// For details, see Controlling access to aliases (https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access) // in the Key Management Service Developer Guide. Related operations: -// -// * -// CreateAlias -// -// * DeleteAlias -// -// * ListAliases +// - CreateAlias +// - DeleteAlias +// - ListAliases func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optFns ...func(*Options)) (*UpdateAliasOutput, error) { if params == nil { params = &UpdateAliasInput{} @@ -73,31 +61,24 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF type UpdateAliasInput struct { // Identifies the alias that is changing its KMS key. This value must begin with - // alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use + // alias/ followed by the alias name, such as alias/ExampleAlias . You cannot use // UpdateAlias to change the alias name. // // This member is required. AliasName *string - // Identifies the customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) + // Identifies the customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) // to associate with the alias. You don't have permission to associate an alias - // with an Amazon Web Services managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). - // The KMS key must be in the same Amazon Web Services account and Region as the + // with an Amazon Web Services managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + // . The KMS key must be in the same Amazon Web Services account and Region as the // alias. Also, the new target KMS key must be the same type as the current target // KMS key (both symmetric or both asymmetric or both HMAC) and they must have the // same key usage. Specify the key ID or key ARN of the KMS key. For example: - // - // * - // Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To verify - // that the alias is mapped to the correct KMS key, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // verify that the alias is mapped to the correct KMS key, use ListAliases . // // This member is required. TargetKeyId *string diff --git a/service/kms/api_op_UpdateCustomKeyStore.go b/service/kms/api_op_UpdateCustomKeyStore.go index 86b9d04c68f..ed175c1c7af 100644 --- a/service/kms/api_op_UpdateCustomKeyStore.go +++ b/service/kms/api_op_UpdateCustomKeyStore.go @@ -17,8 +17,7 @@ import ( // remaining optional parameters to change its properties. This operation does not // return any property values. To verify the updated property values, use the // DescribeCustomKeyStores operation. This operation is part of the custom key -// stores -// (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) +// stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in KMS, which combines the convenience and extensive integration of KMS // with the isolation and control of a key store that you own and manage. When // updating the properties of an external key store, verify that the updated @@ -36,47 +35,40 @@ import ( // UpdateCustomKeyStore operation. However, you can use the file to help you // determine the correct values for the UpdateCustomKeyStore parameters. For an // CloudHSM key store, you can use this operation to change the custom key store -// friendly name (NewCustomKeyStoreName), to tell KMS about a change to the kmsuser -// crypto user password (KeyStorePassword), or to associate the custom key store -// with a different, but related, CloudHSM cluster (CloudHsmClusterId). To update -// any property of an CloudHSM key store, the ConnectionState of the CloudHSM key -// store must be DISCONNECTED. For an external key store, you can use this -// operation to change the custom key store friendly name (NewCustomKeyStoreName), -// or to tell KMS about a change to the external key store proxy authentication -// credentials (XksProxyAuthenticationCredential), connection method -// (XksProxyConnectivity), external proxy endpoint (XksProxyUriEndpoint) and path -// (XksProxyUriPath). For external key stores with an XksProxyConnectivity of -// VPC_ENDPOINT_SERVICE, you can also update the Amazon VPC endpoint service name -// (XksProxyVpcEndpointServiceName). To update most properties of an external key -// store, the ConnectionState of the external key store must be DISCONNECTED. -// However, you can update the CustomKeyStoreName, -// XksProxyAuthenticationCredential, and XksProxyUriPath of an external key store +// friendly name ( NewCustomKeyStoreName ), to tell KMS about a change to the +// kmsuser crypto user password ( KeyStorePassword ), or to associate the custom +// key store with a different, but related, CloudHSM cluster ( CloudHsmClusterId ). +// To update any property of an CloudHSM key store, the ConnectionState of the +// CloudHSM key store must be DISCONNECTED . For an external key store, you can use +// this operation to change the custom key store friendly name ( +// NewCustomKeyStoreName ), or to tell KMS about a change to the external key store +// proxy authentication credentials ( XksProxyAuthenticationCredential ), +// connection method ( XksProxyConnectivity ), external proxy endpoint ( +// XksProxyUriEndpoint ) and path ( XksProxyUriPath ). For external key stores with +// an XksProxyConnectivity of VPC_ENDPOINT_SERVICE , you can also update the Amazon +// VPC endpoint service name ( XksProxyVpcEndpointServiceName ). To update most +// properties of an external key store, the ConnectionState of the external key +// store must be DISCONNECTED . However, you can update the CustomKeyStoreName , +// XksProxyAuthenticationCredential , and XksProxyUriPath of an external key store // when it is in the CONNECTED or DISCONNECTED state. If your update requires a -// DISCONNECTED state, before using UpdateCustomKeyStore, use the +// DISCONNECTED state, before using UpdateCustomKeyStore , use the // DisconnectCustomKeyStore operation to disconnect the custom key store. After the // UpdateCustomKeyStore operation completes, use the ConnectCustomKeyStore to // reconnect the custom key store. To find the ConnectionState of the custom key -// store, use the DescribeCustomKeyStores operation. Before updating the custom key -// store, verify that the new values allow KMS to connect the custom key store to -// its backing key store. For example, before you change the XksProxyUriPath value, -// verify that the external key store proxy is reachable at the new path. If the -// operation succeeds, it returns a JSON object with no properties. Cross-account -// use: No. You cannot perform this operation on a custom key store in a different -// Amazon Web Services account. Required permissions: kms:UpdateCustomKeyStore -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// store, use the DescribeCustomKeyStores operation. Before updating the custom +// key store, verify that the new values allow KMS to connect the custom key store +// to its backing key store. For example, before you change the XksProxyUriPath +// value, verify that the external key store proxy is reachable at the new path. If +// the operation succeeds, it returns a JSON object with no properties. +// Cross-account use: No. You cannot perform this operation on a custom key store +// in a different Amazon Web Services account. Required permissions: +// kms:UpdateCustomKeyStore (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (IAM policy) Related operations: -// -// * ConnectCustomKeyStore -// -// * -// CreateCustomKeyStore -// -// * DeleteCustomKeyStore -// -// * DescribeCustomKeyStores -// -// * -// DisconnectCustomKeyStore +// - ConnectCustomKeyStore +// - CreateCustomKeyStore +// - DeleteCustomKeyStore +// - DescribeCustomKeyStores +// - DisconnectCustomKeyStore func (c *Client) UpdateCustomKeyStore(ctx context.Context, params *UpdateCustomKeyStoreInput, optFns ...func(*Options)) (*UpdateCustomKeyStoreOutput, error) { if params == nil { params = &UpdateCustomKeyStoreInput{} @@ -102,38 +94,36 @@ type UpdateCustomKeyStoreInput struct { CustomKeyStoreId *string // Associates the custom key store with a related CloudHSM cluster. This parameter - // is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM. + // is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM . // Enter the cluster ID of the cluster that you used to create the custom key store // or a cluster that shares a backup history and has the same cluster certificate // as the original cluster. You cannot use this parameter to associate a custom key // store with an unrelated cluster. In addition, the replacement cluster must - // fulfill the requirements - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) + // fulfill the requirements (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) // for a cluster associated with a custom key store. To view the cluster - // certificate of a cluster, use the DescribeClusters - // (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) + // certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) // operation. To change this value, the CloudHSM key store must be disconnected. CloudHsmClusterId *string // Enter the current password of the kmsuser crypto user (CU) in the CloudHSM // cluster that is associated with the custom key store. This parameter is valid - // only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM. This + // only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM . This // parameter tells KMS the current password of the kmsuser crypto user (CU). It // does not set or change the password of any users in the CloudHSM cluster. To // change this value, the CloudHSM key store must be disconnected. KeyStorePassword *string - // Changes the friendly name of the custom key store to the value that you specify. - // The custom key store name must be unique in the Amazon Web Services account. To - // change this value, an CloudHSM key store must be disconnected. An external key - // store can be connected or disconnected. + // Changes the friendly name of the custom key store to the value that you + // specify. The custom key store name must be unique in the Amazon Web Services + // account. To change this value, an CloudHSM key store must be disconnected. An + // external key store can be connected or disconnected. NewCustomKeyStoreName *string - // Changes the credentials that KMS uses to sign requests to the external key store - // proxy (XKS proxy). This parameter is valid only for custom key stores with a - // CustomKeyStoreType of EXTERNAL_KEY_STORE. You must specify both the AccessKeyId - // and SecretAccessKey value in the authentication credential, even if you are only - // updating one value. This parameter doesn't establish or change your + // Changes the credentials that KMS uses to sign requests to the external key + // store proxy (XKS proxy). This parameter is valid only for custom key stores with + // a CustomKeyStoreType of EXTERNAL_KEY_STORE . You must specify both the + // AccessKeyId and SecretAccessKey value in the authentication credential, even if + // you are only updating one value. This parameter doesn't establish or change your // authentication credentials on the proxy. It just tells KMS the credential that // you established with your external key store proxy. For example, if you rotate // the credential on your external key store proxy, you can use this parameter to @@ -143,10 +133,10 @@ type UpdateCustomKeyStoreInput struct { // Changes the connectivity setting for the external key store. To indicate that // the external key store proxy uses a Amazon VPC endpoint service to communicate - // with KMS, specify VPC_ENDPOINT_SERVICE. Otherwise, specify PUBLIC_ENDPOINT. If - // you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE, you must also + // with KMS, specify VPC_ENDPOINT_SERVICE . Otherwise, specify PUBLIC_ENDPOINT . If + // you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE , you must also // change the XksProxyUriEndpoint and add an XksProxyVpcEndpointServiceName value. - // If you change the XksProxyConnectivity to PUBLIC_ENDPOINT, you must also change + // If you change the XksProxyConnectivity to PUBLIC_ENDPOINT , you must also change // the XksProxyUriEndpoint and specify a null or empty string for the // XksProxyVpcEndpointServiceName value. To change this value, the external key // store must be disconnected. @@ -154,9 +144,9 @@ type UpdateCustomKeyStoreInput struct { // Changes the URI endpoint that KMS uses to connect to your external key store // proxy (XKS proxy). This parameter is valid only for custom key stores with a - // CustomKeyStoreType of EXTERNAL_KEY_STORE. For external key stores with an - // XksProxyConnectivity value of PUBLIC_ENDPOINT, the protocol must be HTTPS. For - // external key stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, + // CustomKeyStoreType of EXTERNAL_KEY_STORE . For external key stores with an + // XksProxyConnectivity value of PUBLIC_ENDPOINT , the protocol must be HTTPS. For + // external key stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE , // specify https:// followed by the private DNS name associated with the VPC // endpoint service. Each external key store must use a different private DNS name. // The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in @@ -167,10 +157,10 @@ type UpdateCustomKeyStoreInput struct { // Changes the base path to the proxy APIs for this external key store. To find // this value, see the documentation for your external key manager and external key // store proxy (XKS proxy). This parameter is valid only for custom key stores with - // a CustomKeyStoreType of EXTERNAL_KEY_STORE. The value must start with / and must - // end with /kms/xks/v1, where v1 represents the version of the KMS external key - // store proxy API. You can include an optional prefix between the required - // elements such as /example/kms/xks/v1. The combined XksProxyUriEndpoint and + // a CustomKeyStoreType of EXTERNAL_KEY_STORE . The value must start with / and + // must end with /kms/xks/v1 , where v1 represents the version of the KMS external + // key store proxy API. You can include an optional prefix between the required + // elements such as /example/kms/xks/v1 . The combined XksProxyUriEndpoint and // XksProxyUriPath values must be unique in the Amazon Web Services account and // Region. You can change this value when the external key store is connected or // disconnected. @@ -179,7 +169,7 @@ type UpdateCustomKeyStoreInput struct { // Changes the name that KMS uses to identify the Amazon VPC endpoint service for // your external key store proxy (XKS proxy). This parameter is valid when the // CustomKeyStoreType is EXTERNAL_KEY_STORE and the XksProxyConnectivity is - // VPC_ENDPOINT_SERVICE. To change this value, the external key store must be + // VPC_ENDPOINT_SERVICE . To change this value, the external key store must be // disconnected. XksProxyVpcEndpointServiceName *string diff --git a/service/kms/api_op_UpdateKeyDescription.go b/service/kms/api_op_UpdateKeyDescription.go index b0700a418d0..1e68841bc02 100644 --- a/service/kms/api_op_UpdateKeyDescription.go +++ b/service/kms/api_op_UpdateKeyDescription.go @@ -11,18 +11,14 @@ import ( ) // Updates the description of a KMS key. To see the description of a KMS key, use -// DescribeKey. The KMS key that you use for this operation must be in a compatible -// key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: No. You cannot +// DescribeKey . The KMS key that you use for this operation must be in a +// compatible key state. For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: No. You cannot // perform this operation on a KMS key in a different Amazon Web Services account. -// Required permissions: kms:UpdateKeyDescription -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// Required permissions: kms:UpdateKeyDescription (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations -// -// * CreateKey -// -// * DescribeKey +// - CreateKey +// - DescribeKey func (c *Client) UpdateKeyDescription(ctx context.Context, params *UpdateKeyDescriptionInput, optFns ...func(*Options)) (*UpdateKeyDescriptionOutput, error) { if params == nil { params = &UpdateKeyDescriptionInput{} @@ -47,15 +43,10 @@ type UpdateKeyDescriptionInput struct { // Updates the description of the specified KMS key. Specify the key ID or key ARN // of the KMS key. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string diff --git a/service/kms/api_op_UpdatePrimaryRegion.go b/service/kms/api_op_UpdatePrimaryRegion.go index e7b87d5dfec..f52cdc7aa86 100644 --- a/service/kms/api_op_UpdatePrimaryRegion.go +++ b/service/kms/api_op_UpdatePrimaryRegion.go @@ -13,11 +13,10 @@ import ( // Changes the primary key of a multi-Region key. This operation changes the // replica key in the specified Region to a primary key and changes the former // primary key to a replica key. For example, suppose you have a primary key in -// us-east-1 and a replica key in eu-west-2. If you run UpdatePrimaryRegion with a -// PrimaryRegion value of eu-west-2, the primary key is now the key in eu-west-2, -// and the key in us-east-1 becomes a replica key. For details, see Updating the -// primary Region -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update) +// us-east-1 and a replica key in eu-west-2 . If you run UpdatePrimaryRegion with +// a PrimaryRegion value of eu-west-2 , the primary key is now the key in eu-west-2 +// , and the key in us-east-1 becomes a replica key. For details, see Updating the +// primary Region (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update) // in the Key Management Service Developer Guide. This operation supports // multi-Region keys, an KMS feature that lets you create multiple interoperable // KMS keys in different Amazon Web Services Regions. Because these KMS keys have @@ -25,22 +24,15 @@ import ( // interchangeably to encrypt data in one Amazon Web Services Region and decrypt it // in a different Amazon Web Services Region without re-encrypting the data or // making a cross-Region call. For more information about multi-Region keys, see -// Multi-Region keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) +// Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. The primary key of a multi-Region // key is the source for properties that are always shared by primary and replica -// keys, including the key material, key ID -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id), -// key spec -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec), -// key usage -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage), -// key material origin -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin), -// and automatic key rotation -// (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html). It's -// the only key that can be replicated. You cannot delete the primary key -// (https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) +// keys, including the key material, key ID (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) +// , key spec (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec) +// , key usage (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage) +// , key material origin (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin) +// , and automatic key rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) +// . It's the only key that can be replicated. You cannot delete the primary key (https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) // until all replica keys are deleted. The key ID and primary Region that you // specify uniquely identify the replica key that will become the primary key. The // primary Region must already have a replica key. This operation does not create a @@ -50,32 +42,25 @@ import ( // multi-Region keys in cryptographic operations. This operation should not delay, // interrupt, or cause failures in cryptographic operations. Even after this // operation completes, the process of updating the primary Region might still be -// in progress for a few more seconds. Operations such as DescribeKey might display -// both the old and new primary keys as replicas. The old and new primary keys have -// a transient key state of Updating. The original key state is restored when the -// update is complete. While the key state is Updating, you can use the keys in -// cryptographic operations, but you cannot replicate the new primary key or -// perform certain management operations, such as enabling or disabling these keys. -// For details about the Updating key state, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. This operation does not return any -// output. To verify that primary key is changed, use the DescribeKey operation. -// Cross-account use: No. You cannot use this operation in a different Amazon Web -// Services account. Required permissions: +// in progress for a few more seconds. Operations such as DescribeKey might +// display both the old and new primary keys as replicas. The old and new primary +// keys have a transient key state of Updating . The original key state is restored +// when the update is complete. While the key state is Updating , you can use the +// keys in cryptographic operations, but you cannot replicate the new primary key +// or perform certain management operations, such as enabling or disabling these +// keys. For details about the Updating key state, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. This operation does not return +// any output. To verify that primary key is changed, use the DescribeKey +// operation. Cross-account use: No. You cannot use this operation in a different +// Amazon Web Services account. Required permissions: +// - kms:UpdatePrimaryRegion on the current primary key (in the primary key's +// Region). Include this permission primary key's key policy. +// - kms:UpdatePrimaryRegion on the current replica key (in the replica key's +// Region). Include this permission in the replica key's key policy. // -// * kms:UpdatePrimaryRegion on the -// current primary key (in the primary key's Region). Include this permission -// primary key's key policy. -// -// * kms:UpdatePrimaryRegion on the current replica key -// (in the replica key's Region). Include this permission in the replica key's key -// policy. -// -// # Related operations -// -// * CreateKey -// -// * ReplicateKey +// Related operations +// - CreateKey +// - ReplicateKey func (c *Client) UpdatePrimaryRegion(ctx context.Context, params *UpdatePrimaryRegionInput, optFns ...func(*Options)) (*UpdatePrimaryRegionOutput, error) { if params == nil { params = &UpdatePrimaryRegionInput{} @@ -96,22 +81,18 @@ type UpdatePrimaryRegionInput struct { // Identifies the current primary key. When the operation completes, this KMS key // will be a replica key. Specify the key ID or key ARN of a multi-Region primary // key. For example: - // - // * Key ID: mrk-1234abcd12ab34cd56ef1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab - // - // To - // get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // - Key ID: mrk-1234abcd12ab34cd56ef1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . // // This member is required. KeyId *string - // The Amazon Web Services Region of the new primary key. Enter the Region ID, such - // as us-east-1 or ap-southeast-2. There must be an existing replica key in this - // Region. When the operation completes, the multi-Region key in this Region will - // be the primary key. + // The Amazon Web Services Region of the new primary key. Enter the Region ID, + // such as us-east-1 or ap-southeast-2 . There must be an existing replica key in + // this Region. When the operation completes, the multi-Region key in this Region + // will be the primary key. // // This member is required. PrimaryRegion *string diff --git a/service/kms/api_op_Verify.go b/service/kms/api_op_Verify.go index ff6ff03d72d..eb0ccecec79 100644 --- a/service/kms/api_op_Verify.go +++ b/service/kms/api_op_Verify.go @@ -15,37 +15,33 @@ import ( // Verification confirms that an authorized user signed the message with the // specified KMS key and signing algorithm, and the message hasn't changed since it // was signed. If the signature is verified, the value of the SignatureValid field -// in the response is True. If the signature verification fails, the Verify +// in the response is True . If the signature verification fails, the Verify // operation fails with an KMSInvalidSignatureException exception. A digital // signature is generated by using the private key in an asymmetric KMS key. The // signature is verified by using the public key in the same asymmetric KMS key. -// For information about asymmetric KMS keys, see Asymmetric KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) +// For information about asymmetric KMS keys, see Asymmetric KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Key Management Service Developer Guide. To use the Verify operation, // specify the same asymmetric KMS key, message, and signing algorithm that were // used to produce the signature. The message type does not need to be the same as // the one used for signing, but it must indicate whether the value of the Message // parameter should be hashed as part of the verification process. You can also // verify the digital signature by using the public key of the KMS key outside of -// KMS. Use the GetPublicKey operation to download the public key in the asymmetric -// KMS key and then use the public key to verify the signature outside of KMS. The -// advantage of using the Verify operation is that it is performed within KMS. As a -// result, it's easy to call, the operation is performed within the FIPS boundary, -// it is logged in CloudTrail, and you can use key policy and IAM policy to -// determine who is authorized to use the KMS key to verify signatures. To verify a -// signature outside of KMS with an SM2 public key (China Regions only), you must -// specify the distinguishing ID. By default, KMS uses 1234567812345678 as the -// distinguishing ID. For more information, see Offline verification with SM2 key -// pairs -// (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification). -// The KMS key that you use for this operation must be in a compatible key state. -// For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation with a KMS key in a different Amazon Web Services account, specify the -// key ARN or alias ARN in the value of the KeyId parameter. Required permissions: -// kms:Verify -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// KMS. Use the GetPublicKey operation to download the public key in the +// asymmetric KMS key and then use the public key to verify the signature outside +// of KMS. The advantage of using the Verify operation is that it is performed +// within KMS. As a result, it's easy to call, the operation is performed within +// the FIPS boundary, it is logged in CloudTrail, and you can use key policy and +// IAM policy to determine who is authorized to use the KMS key to verify +// signatures. To verify a signature outside of KMS with an SM2 public key (China +// Regions only), you must specify the distinguishing ID. By default, KMS uses +// 1234567812345678 as the distinguishing ID. For more information, see Offline +// verification with SM2 key pairs (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification) +// . The KMS key that you use for this operation must be in a compatible key state. +// For details, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. Cross-account use: Yes. To +// perform this operation with a KMS key in a different Amazon Web Services +// account, specify the key ARN or alias ARN in the value of the KeyId parameter. +// Required permissions: kms:Verify (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: Sign func (c *Client) Verify(ctx context.Context, params *VerifyInput, optFns ...func(*Options)) (*VerifyOutput, error) { if params == nil { @@ -68,31 +64,22 @@ type VerifyInput struct { // This must be the same KMS key that was used to generate the signature. If you // specify a different KMS key, the signature verification fails. To specify a KMS // key, use its key ID, key ARN, alias name, or alias ARN. When using an alias - // name, prefix it with "alias/". To specify a KMS key in a different Amazon Web + // name, prefix it with "alias/" . To specify a KMS key in a different Amazon Web // Services account, you must use the key ARN or alias ARN. For example: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // To get the key ID and key - // ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias - // ARN, use ListAliases. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey . To + // get the alias name and alias ARN, use ListAliases . // // This member is required. KeyId *string // Specifies the message that was signed. You can submit a raw message of up to // 4096 bytes, or a hash digest of the message. If you submit a digest, use the - // MessageType parameter with a value of DIGEST. If the message specified here is + // MessageType parameter with a value of DIGEST . If the message specified here is // different from the message that was signed, the signature verification fails. A // message and its hash digest are considered to be the same message. // @@ -112,41 +99,31 @@ type VerifyInput struct { // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string - // Tells KMS whether the value of the Message parameter should be hashed as part of - // the signing algorithm. Use RAW for unhashed messages; use DIGEST for message - // digests, which are already hashed. When the value of MessageType is RAW, KMS + // Tells KMS whether the value of the Message parameter should be hashed as part + // of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message + // digests, which are already hashed. When the value of MessageType is RAW , KMS // uses the standard signing algorithm, which begins with a hash function. When the - // value is DIGEST, KMS skips the hashing step in the signing algorithm. Use the + // value is DIGEST , KMS skips the hashing step in the signing algorithm. Use the // DIGEST value only when the value of the Message parameter is a message digest. // If you use the DIGEST value with an unhashed message, the security of the - // verification operation can be compromised. When the value of MessageTypeis - // DIGEST, the length of the Message value must match the length of hashed messages - // for the specified signing algorithm. You can submit a message digest and omit - // the MessageType or specify RAW so the digest is hashed again while signing. - // However, if the signed message is hashed once while signing, but twice while - // verifying, verification fails, even when the message hasn't changed. The hashing - // algorithm in that Verify uses is based on the SigningAlgorithm value. - // - // * Signing - // algorithms that end in SHA_256 use the SHA_256 hashing algorithm. - // - // * Signing - // algorithms that end in SHA_384 use the SHA_384 hashing algorithm. - // - // * Signing - // algorithms that end in SHA_512 use the SHA_512 hashing algorithm. - // - // * SM2DSA uses - // the SM3 hashing algorithm. For details, see Offline verification with SM2 key - // pairs - // (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification). + // verification operation can be compromised. When the value of MessageType is + // DIGEST , the length of the Message value must match the length of hashed + // messages for the specified signing algorithm. You can submit a message digest + // and omit the MessageType or specify RAW so the digest is hashed again while + // signing. However, if the signed message is hashed once while signing, but twice + // while verifying, verification fails, even when the message hasn't changed. The + // hashing algorithm in that Verify uses is based on the SigningAlgorithm value. + // - Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm. + // - Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm. + // - Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm. + // - SM2DSA uses the SM3 hashing algorithm. For details, see Offline + // verification with SM2 key pairs (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification) + // . MessageType types.MessageType noSmithyDocumentSerde @@ -154,9 +131,8 @@ type VerifyInput struct { type VerifyOutput struct { - // The Amazon Resource Name (key ARN - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) - // of the asymmetric KMS key that was used to verify the signature. + // The Amazon Resource Name ( key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) + // ) of the asymmetric KMS key that was used to verify the signature. KeyId *string // A Boolean value that indicates whether the signature was verified. A value of diff --git a/service/kms/api_op_VerifyMac.go b/service/kms/api_op_VerifyMac.go index bbd63d79a9d..f5df4839fb5 100644 --- a/service/kms/api_op_VerifyMac.go +++ b/service/kms/api_op_VerifyMac.go @@ -12,24 +12,23 @@ import ( ) // Verifies the hash-based message authentication code (HMAC) for a specified -// message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes -// an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and -// compares the computed HMAC to the HMAC that you specify. If the HMACs are -// identical, the verification succeeds; otherwise, it fails. Verification -// indicates that the message hasn't changed since the HMAC was calculated, and the -// specified key was used to generate and verify the HMAC. HMAC KMS keys and the -// HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104 -// (https://datatracker.ietf.org/doc/html/rfc2104). This operation is part of KMS -// support for HMAC KMS keys. For details, see HMAC keys in KMS -// (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the Key -// Management Service Developer Guide. The KMS key that you use for this operation -// must be in a compatible key state. For details, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. Cross-account use: Yes. To perform this -// operation with a KMS key in a different Amazon Web Services account, specify the -// key ARN or alias ARN in the value of the KeyId parameter. Required permissions: -// kms:VerifyMac -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) +// message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac +// computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you +// specify, and compares the computed HMAC to the HMAC that you specify. If the +// HMACs are identical, the verification succeeds; otherwise, it fails. +// Verification indicates that the message hasn't changed since the HMAC was +// calculated, and the specified key was used to generate and verify the HMAC. HMAC +// KMS keys and the HMAC algorithms that KMS uses conform to industry standards +// defined in RFC 2104 (https://datatracker.ietf.org/doc/html/rfc2104) . This +// operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys +// in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the +// Key Management Service Developer Guide. The KMS key that you use for this +// operation must be in a compatible key state. For details, see Key states of KMS +// keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in +// the Key Management Service Developer Guide. Cross-account use: Yes. To perform +// this operation with a KMS key in a different Amazon Web Services account, +// specify the key ARN or alias ARN in the value of the KeyId parameter. Required +// permissions: kms:VerifyMac (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // (key policy) Related operations: GenerateMac func (c *Client) VerifyMac(ctx context.Context, params *VerifyMacInput, optFns ...func(*Options)) (*VerifyMacOutput, error) { if params == nil { @@ -48,8 +47,8 @@ func (c *Client) VerifyMac(ctx context.Context, params *VerifyMacInput, optFns . type VerifyMacInput struct { - // The KMS key that will be used in the verification. Enter a key ID of the KMS key - // that was used to generate the HMAC. If you identify a different KMS key, the + // The KMS key that will be used in the verification. Enter a key ID of the KMS + // key that was used to generate the HMAC. If you identify a different KMS key, the // VerifyMac operation fails. // // This member is required. @@ -79,10 +78,8 @@ type VerifyMacInput struct { // A list of grant tokens. Use a grant token when your permission to call this // operation comes from a new grant that has not yet achieved eventual consistency. - // For more information, see Grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) - // and Using a grant token - // (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) + // For more information, see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) + // and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token) // in the Key Management Service Developer Guide. GrantTokens []string @@ -98,8 +95,8 @@ type VerifyMacOutput struct { MacAlgorithm types.MacAlgorithmSpec // A Boolean value that indicates whether the HMAC was verified. A value of True - // indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS - // key (KeyID) and MacAlgorithm.. If the HMAC is not verified, the VerifyMac + // indicates that the HMAC ( Mac ) was generated with the specified Message , HMAC + // KMS key ( KeyID ) and MacAlgorithm. . If the HMAC is not verified, the VerifyMac // operation fails with a KMSInvalidMacException exception. This exception // indicates that one or more of the inputs changed since the HMAC was computed. MacValid bool diff --git a/service/kms/doc.go b/service/kms/doc.go index 2503477374b..266b4e11176 100644 --- a/service/kms/doc.go +++ b/service/kms/doc.go @@ -1,77 +1,64 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package kms provides the API client, operations, and parameter types for AWS Key -// Management Service. +// Package kms provides the API client, operations, and parameter types for AWS +// Key Management Service. // // Key Management Service Key Management Service (KMS) is an encryption and key // management web service. This guide describes the KMS operations that you can -// call programmatically. For general information about KMS, see the Key -// Management Service Developer Guide -// (https://docs.aws.amazon.com/kms/latest/developerguide/). KMS has replaced the -// term customer master key (CMK) with KMS key and KMS key. The concept has not -// changed. To prevent breaking changes, KMS is keeping some variations of this -// term. Amazon Web Services provides SDKs that consist of libraries and sample -// code for various programming languages and platforms (Java, Ruby, .Net, macOS, -// Android, etc.). The SDKs provide a convenient way to create programmatic access -// to KMS and other Amazon Web Services services. For example, the SDKs take care -// of tasks such as signing requests (see below), managing errors, and retrying -// requests automatically. For more information about the Amazon Web Services SDKs, -// including how to download and install them, see Tools for Amazon Web Services -// (http://aws.amazon.com/tools/). We recommend that you use the Amazon Web -// Services SDKs to make programmatic API calls to KMS. If you need to use FIPS -// 140-2 validated cryptographic modules when communicating with Amazon Web -// Services, use the FIPS endpoint in your preferred Amazon Web Services Region. -// For more information about the available FIPS endpoints, see Service endpoints -// (https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region) in the Key -// Management Service topic of the Amazon Web Services General Reference. All KMS -// API calls must be signed and be transmitted using Transport Layer Security -// (TLS). KMS recommends you always use the latest supported TLS version. Clients -// must also support cipher suites with Perfect Forward Secrecy (PFS) such as -// Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman +// call programmatically. For general information about KMS, see the Key +// Management Service Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/) +// . KMS has replaced the term customer master key (CMK) with KMS key and KMS key. +// The concept has not changed. To prevent breaking changes, KMS is keeping some +// variations of this term. Amazon Web Services provides SDKs that consist of +// libraries and sample code for various programming languages and platforms (Java, +// Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create +// programmatic access to KMS and other Amazon Web Services services. For example, +// the SDKs take care of tasks such as signing requests (see below), managing +// errors, and retrying requests automatically. For more information about the +// Amazon Web Services SDKs, including how to download and install them, see Tools +// for Amazon Web Services (http://aws.amazon.com/tools/) . We recommend that you +// use the Amazon Web Services SDKs to make programmatic API calls to KMS. If you +// need to use FIPS 140-2 validated cryptographic modules when communicating with +// Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services +// Region. For more information about the available FIPS endpoints, see Service +// endpoints (https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region) in +// the Key Management Service topic of the Amazon Web Services General Reference. +// All KMS API calls must be signed and be transmitted using Transport Layer +// Security (TLS). KMS recommends you always use the latest supported TLS version. +// Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such +// as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman // (ECDHE). Most modern systems such as Java 7 and later support these modes. // Signing Requests Requests must be signed using an access key ID and a secret // access key. We strongly recommend that you do not use your Amazon Web Services // account root access key ID and secret access key for everyday work. You can use // the access key ID and secret access key for an IAM user or you can use the // Security Token Service (STS) to generate temporary security credentials and use -// those to sign requests. All KMS requests must be signed with Signature Version 4 -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). -// Logging API Requests KMS supports CloudTrail, a service that logs Amazon Web +// those to sign requests. All KMS requests must be signed with Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . Logging API Requests KMS supports CloudTrail, a service that logs Amazon Web // Services API calls and related events for your Amazon Web Services account and // delivers them to an Amazon S3 bucket that you specify. By using the information // collected by CloudTrail, you can determine what requests were made to KMS, who // made the request, when it was made, and so on. To learn more about CloudTrail, // including how to turn it on and find your log files, see the CloudTrail User -// Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/). Additional +// Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/) . Additional // Resources For more information about credentials and request signing, see the // following: +// - Amazon Web Services Security Credentials (https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) +// - This topic provides general information about the types of credentials used to +// access Amazon Web Services. +// - Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) +// - This section of the IAM User Guide describes how to create and use temporary +// security credentials. +// - Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// - This set of topics walks you through the process of signing a request using an +// access key ID and a secret access key. // -// * Amazon Web Services Security Credentials -// (https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) - -// This topic provides general information about the types of credentials used to -// access Amazon Web Services. -// -// * Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) - -// This section of the IAM User Guide describes how to create and use temporary -// security credentials. -// -// * Signature Version 4 Signing Process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) - This -// set of topics walks you through the process of signing a request using an access -// key ID and a secret access key. -// -// Commonly Used API Operations Of the API -// operations discussed in this guide, the following will prove the most useful for -// most applications. You will likely perform operations other than these, such as -// creating keys and assigning policies, by using the console. -// -// * Encrypt -// -// * -// Decrypt -// -// * GenerateDataKey -// -// * GenerateDataKeyWithoutPlaintext +// Commonly Used API Operations Of the API operations discussed in this guide, the +// following will prove the most useful for most applications. You will likely +// perform operations other than these, such as creating keys and assigning +// policies, by using the console. +// - Encrypt +// - Decrypt +// - GenerateDataKey +// - GenerateDataKeyWithoutPlaintext package kms diff --git a/service/kms/types/enums.go b/service/kms/types/enums.go index 923e3abc0f9..8c4a4fe8ff4 100644 --- a/service/kms/types/enums.go +++ b/service/kms/types/enums.go @@ -115,8 +115,8 @@ const ( CustomerMasterKeySpecSm2 CustomerMasterKeySpec = "SM2" ) -// Values returns all known values for CustomerMasterKeySpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CustomerMasterKeySpec. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CustomerMasterKeySpec) Values() []CustomerMasterKeySpec { return []CustomerMasterKeySpec{ @@ -385,9 +385,9 @@ const ( KeyUsageTypeGenerateVerifyMac KeyUsageType = "GENERATE_VERIFY_MAC" ) -// Values returns all known values for KeyUsageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for KeyUsageType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (KeyUsageType) Values() []KeyUsageType { return []KeyUsageType{ "SIGN_VERIFY", @@ -534,9 +534,9 @@ const ( XksProxyConnectivityTypeVpcEndpointService XksProxyConnectivityType = "VPC_ENDPOINT_SERVICE" ) -// Values returns all known values for XksProxyConnectivityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for XksProxyConnectivityType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (XksProxyConnectivityType) Values() []XksProxyConnectivityType { return []XksProxyConnectivityType{ "PUBLIC_ENDPOINT", diff --git a/service/kms/types/errors.go b/service/kms/types/errors.go index a025590ad6b..ec1b379ea00 100644 --- a/service/kms/types/errors.go +++ b/service/kms/types/errors.go @@ -39,8 +39,7 @@ func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy. // history with an CloudHSM key store in the account. Each CloudHSM key store in // the account must be associated with a different CloudHSM cluster. CloudHSM // clusters that share a backup history have the same cluster certificate. To view -// the cluster certificate of an CloudHSM cluster, use the DescribeClusters -// (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) +// the cluster certificate of an CloudHSM cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) // operation. type CloudHsmClusterInUseException struct { Message *string @@ -69,41 +68,30 @@ func (e *CloudHsmClusterInUseException) ErrorFault() smithy.ErrorFault { return // The request was rejected because the associated CloudHSM cluster did not meet // the configuration requirements for an CloudHSM key store. +// - The CloudHSM cluster must be configured with private subnets in at least +// two different Availability Zones in the Region. +// - The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html) +// (cloudhsm-cluster--sg) must include inbound rules and outbound rules that allow +// TCP traffic on ports 2223-2225. The Source in the inbound rules and the +// Destination in the outbound rules must match the security group ID. These rules +// are set by default when you create the CloudHSM cluster. Do not delete or change +// them. To get information about a particular security group, use the +// DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) +// operation. +// - The CloudHSM cluster must contain at least as many HSMs as the operation +// requires. To add HSMs, use the CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html) +// operation. For the CreateCustomKeyStore , UpdateCustomKeyStore , and CreateKey +// operations, the CloudHSM cluster must have at least two active HSMs, each in a +// different Availability Zone. For the ConnectCustomKeyStore operation, the +// CloudHSM must contain at least one active HSM. // -// * The CloudHSM -// cluster must be configured with private subnets in at least two different -// Availability Zones in the Region. -// -// * The security group for the cluster -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html) -// (cloudhsm-cluster--sg) must include inbound rules and outbound rules that allow -// TCP traffic on ports 2223-2225. The Source in the inbound rules and the -// Destination in the outbound rules must match the security group ID. These rules -// are set by default when you create the CloudHSM cluster. Do not delete or change -// them. To get information about a particular security group, use the -// DescribeSecurityGroups -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) -// operation. -// -// * The CloudHSM cluster must contain at least as many HSMs as the -// operation requires. To add HSMs, use the CloudHSM CreateHsm -// (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html) -// operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey -// operations, the CloudHSM cluster must have at least two active HSMs, each in a -// different Availability Zone. For the ConnectCustomKeyStore operation, the -// CloudHSM must contain at least one active HSM. -// -// For information about the -// requirements for an CloudHSM cluster that is associated with an CloudHSM key -// store, see Assemble the Prerequisites -// (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) +// For information about the requirements for an CloudHSM cluster that is +// associated with an CloudHSM key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) // in the Key Management Service Developer Guide. For information about creating a -// private subnet for an CloudHSM cluster, see Create a Private Subnet -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html) in -// the CloudHSM User Guide. For information about cluster security groups, see -// Configure a Default Security Group -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html) in the -// CloudHSM User Guide . +// private subnet for an CloudHSM cluster, see Create a Private Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html) +// in the CloudHSM User Guide. For information about cluster security groups, see +// Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html) +// in the CloudHSM User Guide . type CloudHsmClusterInvalidConfigurationException struct { Message *string @@ -133,9 +121,8 @@ func (e *CloudHsmClusterInvalidConfigurationException) ErrorFault() smithy.Error // The request was rejected because the CloudHSM cluster associated with the // CloudHSM key store is not active. Initialize and activate the cluster and try -// the command again. For detailed instructions, see Getting Started -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html) in -// the CloudHSM User Guide. +// the command again. For detailed instructions, see Getting Started (https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html) +// in the CloudHSM User Guide. type CloudHsmClusterNotActiveException struct { Message *string @@ -195,8 +182,7 @@ func (e *CloudHsmClusterNotFoundException) ErrorFault() smithy.ErrorFault { retu // clusters that were created from a backup of the current cluster, and clusters // that were created from the same backup that produced the current cluster. // CloudHSM clusters that share a backup history have the same cluster certificate. -// To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters -// (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) +// To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) // operation. type CloudHsmClusterNotRelatedException struct { Message *string @@ -254,34 +240,27 @@ func (e *CustomKeyStoreHasCMKsException) ErrorCode() string { } func (e *CustomKeyStoreHasCMKsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because of the ConnectionState of the custom key store. -// To get the ConnectionState of a custom key store, use the +// The request was rejected because of the ConnectionState of the custom key +// store. To get the ConnectionState of a custom key store, use the // DescribeCustomKeyStores operation. This exception is thrown under the following // conditions: -// -// * You requested the ConnectCustomKeyStore operation on a custom key -// store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid -// for all other ConnectionState values. To reconnect a custom key store in a -// FAILED state, disconnect it (DisconnectCustomKeyStore), then connect it -// (ConnectCustomKeyStore). -// -// * You requested the CreateKey operation in a custom -// key store that is not connected. This operations is valid only when the custom -// key store ConnectionState is CONNECTED. -// -// * You requested the -// DisconnectCustomKeyStore operation on a custom key store with a ConnectionState -// of DISCONNECTING or DISCONNECTED. This operation is valid for all other -// ConnectionState values. -// -// * You requested the UpdateCustomKeyStore or -// DeleteCustomKeyStore operation on a custom key store that is not disconnected. -// This operation is valid only when the custom key store ConnectionState is -// DISCONNECTED. -// -// * You requested the GenerateRandom operation in an CloudHSM key -// store that is not connected. This operation is valid only when the CloudHSM key -// store ConnectionState is CONNECTED. +// - You requested the ConnectCustomKeyStore operation on a custom key store with +// a ConnectionState of DISCONNECTING or FAILED . This operation is valid for all +// other ConnectionState values. To reconnect a custom key store in a FAILED +// state, disconnect it ( DisconnectCustomKeyStore ), then connect it ( +// ConnectCustomKeyStore ). +// - You requested the CreateKey operation in a custom key store that is not +// connected. This operations is valid only when the custom key store +// ConnectionState is CONNECTED . +// - You requested the DisconnectCustomKeyStore operation on a custom key store +// with a ConnectionState of DISCONNECTING or DISCONNECTED . This operation is +// valid for all other ConnectionState values. +// - You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on +// a custom key store that is not disconnected. This operation is valid only when +// the custom key store ConnectionState is DISCONNECTED . +// - You requested the GenerateRandom operation in an CloudHSM key store that is +// not connected. This operation is valid only when the CloudHSM key store +// ConnectionState is CONNECTED . type CustomKeyStoreInvalidStateException struct { Message *string @@ -503,9 +482,9 @@ func (e *IncorrectKeyMaterialException) ErrorFault() smithy.ErrorFault { return // The request was rejected because the trust anchor certificate in the request to // create an CloudHSM key store is not the trust anchor certificate for the -// specified CloudHSM cluster. When you initialize the CloudHSM cluster -// (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), -// you create the trust anchor certificate and save it in the customerCA.crt file. +// specified CloudHSM cluster. When you initialize the CloudHSM cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr) +// , you create the trust anchor certificate and save it in the customerCA.crt +// file. type IncorrectTrustAnchorException struct { Message *string @@ -694,21 +673,17 @@ func (e *InvalidImportTokenException) ErrorCode() string { func (e *InvalidImportTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was rejected for one of the following reasons: +// - The KeyUsage value of the KMS key is incompatible with the API operation. +// - The encryption algorithm or signing algorithm specified for the operation +// is incompatible with the type of key material in the KMS key (KeySpec ). // -// * The KeyUsage value -// of the KMS key is incompatible with the API operation. -// -// * The encryption -// algorithm or signing algorithm specified for the operation is incompatible with -// the type of key material in the KMS key (KeySpec). -// -// For encrypting, decrypting, -// re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. -// For signing and verifying messages, the KeyUsage must be SIGN_VERIFY. For -// generating and verifying message authentication codes (MACs), the KeyUsage must -// be GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the DescribeKey -// operation. To find the encryption or signing algorithms supported for a -// particular KMS key, use the DescribeKey operation. +// For encrypting, decrypting, re-encrypting, and generating data keys, the +// KeyUsage must be ENCRYPT_DECRYPT . For signing and verifying messages, the +// KeyUsage must be SIGN_VERIFY . For generating and verifying message +// authentication codes (MACs), the KeyUsage must be GENERATE_VERIFY_MAC . To find +// the KeyUsage of a KMS key, use the DescribeKey operation. To find the +// encryption or signing algorithms supported for a particular KMS key, use the +// DescribeKey operation. type InvalidKeyUsageException struct { Message *string @@ -788,8 +763,8 @@ func (e *KeyUnavailableException) ErrorCode() string { } func (e *KeyUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request was rejected because an internal exception occurred. The request can -// be retried. +// The request was rejected because an internal exception occurred. The request +// can be retried. type KMSInternalException struct { Message *string @@ -815,9 +790,9 @@ func (e *KMSInternalException) ErrorCode() string { } func (e *KMSInternalException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request was rejected because the HMAC verification failed. HMAC verification -// fails when the HMAC computed by using the specified message, HMAC KMS key, and -// MAC algorithm does not match the HMAC specified in the request. +// The request was rejected because the HMAC verification failed. HMAC +// verification fails when the HMAC computed by using the specified message, HMAC +// KMS key, and MAC algorithm does not match the HMAC specified in the request. type KMSInvalidMacException struct { Message *string @@ -873,18 +848,13 @@ func (e *KMSInvalidSignatureException) ErrorFault() smithy.ErrorFault { return s // The request was rejected because the state of the specified resource is not // valid for this request. This exceptions means one of the following: -// -// * The key -// state of the KMS key is not compatible with the operation. To find the key -// state, use the DescribeKey operation. For more information about which key -// states are compatible with each KMS operation, see Key states of KMS keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide . -// -// * For cryptographic operations on KMS -// keys in custom key stores, this exception represents a general failure with many -// possible causes. To identify the cause, see the error message that accompanies -// the exception. +// - The key state of the KMS key is not compatible with the operation. To find +// the key state, use the DescribeKey operation. For more information about which +// key states are compatible with each KMS operation, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide . +// - For cryptographic operations on KMS keys in custom key stores, this +// exception represents a general failure with many possible causes. To identify +// the cause, see the error message that accompanies the exception. type KMSInvalidStateException struct { Message *string @@ -910,9 +880,9 @@ func (e *KMSInvalidStateException) ErrorCode() string { } func (e *KMSInvalidStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because a quota was exceeded. For more information, see -// Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html) in -// the Key Management Service Developer Guide. +// The request was rejected because a quota was exceeded. For more information, +// see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html) +// in the Key Management Service Developer Guide. type LimitExceededException struct { Message *string @@ -1045,9 +1015,9 @@ func (e *UnsupportedOperationException) ErrorCode() string { } func (e *UnsupportedOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the (XksKeyId) is already associated with a KMS -// key in this external key store. Each KMS key in an external key store must be -// associated with a different external key. +// The request was rejected because the ( XksKeyId ) is already associated with a +// KMS key in this external key store. Each KMS key in an external key store must +// be associated with a different external key. type XksKeyAlreadyInUseException struct { Message *string @@ -1104,13 +1074,13 @@ func (e *XksKeyInvalidConfigurationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the external key store proxy could not find the -// external key. This exception is thrown when the value of the XksKeyId parameter -// doesn't identify a key in the external key manager associated with the external -// key proxy. Verify that the XksKeyId represents an existing key in the external -// key manager. Use the key identifier that the external key store proxy uses to -// identify the key. For details, see the documentation provided with your external -// key store proxy or key manager. +// The request was rejected because the external key store proxy could not find +// the external key. This exception is thrown when the value of the XksKeyId +// parameter doesn't identify a key in the external key manager associated with the +// external key proxy. Verify that the XksKeyId represents an existing key in the +// external key manager. Use the key identifier that the external key store proxy +// uses to identify the key. For details, see the documentation provided with your +// external key store proxy or key manager. type XksKeyNotFoundException struct { Message *string @@ -1136,11 +1106,11 @@ func (e *XksKeyNotFoundException) ErrorCode() string { } func (e *XksKeyNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the proxy credentials failed to authenticate to -// the specified external key store proxy. The specified external key store proxy -// rejected a status request from KMS due to invalid credentials. This can indicate -// an error in the credentials or in the identification of the external key store -// proxy. +// The request was rejected because the proxy credentials failed to authenticate +// to the specified external key store proxy. The specified external key store +// proxy rejected a status request from KMS due to invalid credentials. This can +// indicate an error in the credentials or in the identification of the external +// key store proxy. type XksProxyIncorrectAuthenticationCredentialException struct { Message *string @@ -1198,9 +1168,9 @@ func (e *XksProxyInvalidConfigurationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// KMS cannot interpret the response it received from the external key store proxy. -// The problem might be a poorly constructed response, but it could also be a -// transient network issue. If you see this error repeatedly, report it to the +// KMS cannot interpret the response it received from the external key store +// proxy. The problem might be a poorly constructed response, but it could also be +// a transient network issue. If you see this error repeatedly, report it to the // proxy vendor. type XksProxyInvalidResponseException struct { Message *string @@ -1227,10 +1197,10 @@ func (e *XksProxyInvalidResponseException) ErrorCode() string { } func (e *XksProxyInvalidResponseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the concatenation of the XksProxyUriEndpoint is -// already associated with an external key store in the Amazon Web Services account -// and Region. Each external key store in an account and Region must use a unique -// external key store proxy address. +// The request was rejected because the concatenation of the XksProxyUriEndpoint +// is already associated with an external key store in the Amazon Web Services +// account and Region. Each external key store in an account and Region must use a +// unique external key store proxy address. type XksProxyUriEndpointInUseException struct { Message *string @@ -1285,7 +1255,7 @@ func (e *XksProxyUriInUseException) ErrorCode() string { } func (e *XksProxyUriInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// KMS was unable to reach the specified XksProxyUriPath. The path must be +// KMS was unable to reach the specified XksProxyUriPath . The path must be // reachable before you create the external key store or update its settings. This // exception is also thrown when the external key store proxy response to a // GetHealthStatus request indicates that all external key manager instances are @@ -1378,10 +1348,10 @@ func (e *XksProxyVpcEndpointServiceInvalidConfigurationException) ErrorFault() s } // The request was rejected because KMS could not find the specified VPC endpoint -// service. Use DescribeCustomKeyStores to verify the VPC endpoint service name for -// the external key store. Also, confirm that the Allow principals list for the VPC -// endpoint service includes the KMS service principal for the Region, such as -// cks.kms.us-east-1.amazonaws.com. +// service. Use DescribeCustomKeyStores to verify the VPC endpoint service name +// for the external key store. Also, confirm that the Allow principals list for +// the VPC endpoint service includes the KMS service principal for the Region, such +// as cks.kms.us-east-1.amazonaws.com . type XksProxyVpcEndpointServiceNotFoundException struct { Message *string diff --git a/service/kms/types/types.go b/service/kms/types/types.go index 4e7e747f381..7dbf7f521b6 100644 --- a/service/kms/types/types.go +++ b/service/kms/types/types.go @@ -13,7 +13,7 @@ type AliasListEntry struct { // String that contains the key ARN. AliasArn *string - // String that contains the alias. This value begins with alias/. + // String that contains the alias. This value begins with alias/ . AliasName *string // Date and time that the alias was most recently created in the account and @@ -34,183 +34,134 @@ type AliasListEntry struct { // Contains information about each custom key store in the custom key store list. type CustomKeyStoresListEntry struct { - // A unique identifier for the CloudHSM cluster that is associated with an CloudHSM - // key store. This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM. + // A unique identifier for the CloudHSM cluster that is associated with an + // CloudHSM key store. This field appears only when the CustomKeyStoreType is + // AWS_CLOUDHSM . CloudHsmClusterId *string - // Describes the connection error. This field appears in the response only when the - // ConnectionState is FAILED. Many failures can be resolved by updating the + // Describes the connection error. This field appears in the response only when + // the ConnectionState is FAILED . Many failures can be resolved by updating the // properties of the custom key store. To update a custom key store, disconnect it - // (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try - // to connect again (ConnectCustomKeyStore). For additional help resolving these - // errors, see How to Fix a Connection Failure - // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) + // ( DisconnectCustomKeyStore ), correct the errors ( UpdateCustomKeyStore ), and + // try to connect again ( ConnectCustomKeyStore ). For additional help resolving + // these errors, see How to Fix a Connection Failure (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) // in Key Management Service Developer Guide. All custom key stores: - // - // * - // INTERNAL_ERROR — KMS could not complete the request due to an internal error. - // Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key - // store before trying to connect again. - // - // * NETWORK_ERRORS — Network errors are - // preventing KMS from connecting the custom key store to its backing key - // store. - // + // - INTERNAL_ERROR — KMS could not complete the request due to an internal + // error. Retry the request. For ConnectCustomKeyStore requests, disconnect the + // custom key store before trying to connect again. + // - NETWORK_ERRORS — Network errors are preventing KMS from connecting the + // custom key store to its backing key store. // CloudHSM key stores: - // - // * CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM - // cluster with the specified cluster ID. - // - // * INSUFFICIENT_CLOUDHSM_HSMS — The - // associated CloudHSM cluster does not contain any active HSMs. To connect a - // custom key store to its CloudHSM cluster, the cluster must contain at least one - // active HSM. - // - // * INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private - // subnet associated with the CloudHSM cluster doesn't have any available IP - // addresses. A CloudHSM key store connection requires one free IP address in each - // of the associated private subnets, although two are preferable. For details, see - // How to Fix a Connection Failure - // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) - // in the Key Management Service Developer Guide. - // - // * INVALID_CREDENTIALS — The - // KeyStorePassword for the custom key store doesn't match the current password of - // the kmsuser crypto user in the CloudHSM cluster. Before you can connect your - // custom key store to its CloudHSM cluster, you must change the kmsuser account - // password and update the KeyStorePassword value for the custom key store. - // - // * - // SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was deleted. - // If KMS cannot find all of the subnets in the cluster configuration, attempts to - // connect the custom key store to the CloudHSM cluster fail. To fix this error, - // create a cluster from a recent backup and associate it with your custom key - // store. (This process creates a new cluster configuration with a VPC and private - // subnets.) For details, see How to Fix a Connection Failure - // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) - // in the Key Management Service Developer Guide. - // - // * USER_LOCKED_OUT — The kmsuser - // CU account is locked out of the associated CloudHSM cluster due to too many - // failed password attempts. Before you can connect your custom key store to its - // CloudHSM cluster, you must change the kmsuser account password and update the - // key store password value for the custom key store. - // - // * USER_LOGGED_IN — The - // kmsuser CU account is logged into the associated CloudHSM cluster. This prevents - // KMS from rotating the kmsuser account password and logging into the cluster. - // Before you can connect your custom key store to its CloudHSM cluster, you must - // log the kmsuser CU out of the cluster. If you changed the kmsuser password to - // log into the cluster, you must also and update the key store password value for - // the custom key store. For help, see How to Log Out and Reconnect - // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2) - // in the Key Management Service Developer Guide. - // - // * USER_NOT_FOUND — KMS cannot - // find a kmsuser CU account in the associated CloudHSM cluster. Before you can - // connect your custom key store to its CloudHSM cluster, you must create a kmsuser - // CU account in the cluster, and then update the key store password value for the - // custom key store. - // + // - CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM cluster with the specified + // cluster ID. + // - INSUFFICIENT_CLOUDHSM_HSMS — The associated CloudHSM cluster does not + // contain any active HSMs. To connect a custom key store to its CloudHSM cluster, + // the cluster must contain at least one active HSM. + // - INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private subnet + // associated with the CloudHSM cluster doesn't have any available IP addresses. A + // CloudHSM key store connection requires one free IP address in each of the + // associated private subnets, although two are preferable. For details, see How + // to Fix a Connection Failure (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) + // in the Key Management Service Developer Guide. + // - INVALID_CREDENTIALS — The KeyStorePassword for the custom key store doesn't + // match the current password of the kmsuser crypto user in the CloudHSM cluster. + // Before you can connect your custom key store to its CloudHSM cluster, you must + // change the kmsuser account password and update the KeyStorePassword value for + // the custom key store. + // - SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was + // deleted. If KMS cannot find all of the subnets in the cluster configuration, + // attempts to connect the custom key store to the CloudHSM cluster fail. To fix + // this error, create a cluster from a recent backup and associate it with your + // custom key store. (This process creates a new cluster configuration with a VPC + // and private subnets.) For details, see How to Fix a Connection Failure (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) + // in the Key Management Service Developer Guide. + // - USER_LOCKED_OUT — The kmsuser CU account is locked out of the associated + // CloudHSM cluster due to too many failed password attempts. Before you can + // connect your custom key store to its CloudHSM cluster, you must change the + // kmsuser account password and update the key store password value for the + // custom key store. + // - USER_LOGGED_IN — The kmsuser CU account is logged into the associated + // CloudHSM cluster. This prevents KMS from rotating the kmsuser account password + // and logging into the cluster. Before you can connect your custom key store to + // its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you + // changed the kmsuser password to log into the cluster, you must also and update + // the key store password value for the custom key store. For help, see How to + // Log Out and Reconnect (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2) + // in the Key Management Service Developer Guide. + // - USER_NOT_FOUND — KMS cannot find a kmsuser CU account in the associated + // CloudHSM cluster. Before you can connect your custom key store to its CloudHSM + // cluster, you must create a kmsuser CU account in the cluster, and then update + // the key store password value for the custom key store. // External key stores: - // - // * INVALID_CREDENTIALS — One or both of - // the XksProxyAuthenticationCredential values is not valid on the specified - // external key store proxy. - // - // * XKS_PROXY_ACCESS_DENIED — KMS requests are denied - // access to the external key store proxy. If the external key store proxy has - // authorization rules, verify that they permit KMS to communicate with the proxy - // on your behalf. - // - // * XKS_PROXY_INVALID_CONFIGURATION — A configuration error is - // preventing the external key store from connecting to its proxy. Verify the value - // of the XksProxyUriPath. - // - // * XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the - // response from the external key store proxy. If you see this connection error - // code repeatedly, notify your external key store proxy vendor. - // - // * - // XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key - // store proxy because the TLS configuration is invalid. Verify that the XKS proxy - // supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, - // and that it matches the hostname in the XksProxyUriEndpoint value, and that it - // is signed by a certificate authority included in the Trusted Certificate - // Authorities - // (https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities) - // list. - // - // * XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key - // store proxy. Verify that the XksProxyUriEndpoint and XksProxyUriPath are - // correct. Use the tools for your external key store proxy to verify that the - // proxy is active and available on its network. Also, verify that your external - // key manager instances are operating properly. Connection attempts fail with this - // connection error code if the proxy reports that all external key manager - // instances are unavailable. - // - // * XKS_PROXY_TIMED_OUT — KMS can connect to the - // external key store proxy, but the proxy does not respond to KMS in the time - // allotted. If you see this connection error code repeatedly, notify your external - // key store proxy vendor. - // - // * XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The - // Amazon VPC endpoint service configuration doesn't conform to the requirements - // for an KMS external key store. - // - // * The VPC endpoint service must be an endpoint - // service for interface endpoints in the caller's Amazon Web Services account. - // - // * - // It must have a network load balancer (NLB) connected to at least two subnets, - // each in a different Availability Zone. - // - // * The Allow principals list must include - // the KMS service principal for the Region, cks.kms..amazonaws.com, such as - // cks.kms.us-east-1.amazonaws.com. - // - // * It must not require acceptance - // (https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) - // of connection requests. - // - // * It must have a private DNS name. The private DNS name - // for an external key store with VPC_ENDPOINT_SERVICE connectivity must be unique - // in its Amazon Web Services Region. - // - // * The domain of the private DNS name must - // have a verification status - // (https://docs.aws.amazon.com/vpc/latest/privatelink/verify-domains.html) of - // verified. - // - // * The TLS certificate - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) - // specifies the private DNS hostname at which the endpoint is reachable. - // - // * - // XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service - // that it uses to communicate with the external key store proxy. Verify that the - // XksProxyVpcEndpointServiceName is correct and the KMS service principal has - // service consumer permissions on the Amazon VPC endpoint service. + // - INVALID_CREDENTIALS — One or both of the XksProxyAuthenticationCredential + // values is not valid on the specified external key store proxy. + // - XKS_PROXY_ACCESS_DENIED — KMS requests are denied access to the external key + // store proxy. If the external key store proxy has authorization rules, verify + // that they permit KMS to communicate with the proxy on your behalf. + // - XKS_PROXY_INVALID_CONFIGURATION — A configuration error is preventing the + // external key store from connecting to its proxy. Verify the value of the + // XksProxyUriPath . + // - XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the response from the + // external key store proxy. If you see this connection error code repeatedly, + // notify your external key store proxy vendor. + // - XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key + // store proxy because the TLS configuration is invalid. Verify that the XKS proxy + // supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, + // and that it matches the hostname in the XksProxyUriEndpoint value, and that it + // is signed by a certificate authority included in the Trusted Certificate + // Authorities (https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities) + // list. + // - XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key store + // proxy. Verify that the XksProxyUriEndpoint and XksProxyUriPath are correct. + // Use the tools for your external key store proxy to verify that the proxy is + // active and available on its network. Also, verify that your external key manager + // instances are operating properly. Connection attempts fail with this connection + // error code if the proxy reports that all external key manager instances are + // unavailable. + // - XKS_PROXY_TIMED_OUT — KMS can connect to the external key store proxy, but + // the proxy does not respond to KMS in the time allotted. If you see this + // connection error code repeatedly, notify your external key store proxy vendor. + // - XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The Amazon VPC endpoint + // service configuration doesn't conform to the requirements for an KMS external + // key store. + // - The VPC endpoint service must be an endpoint service for interface + // endpoints in the caller's Amazon Web Services account. + // - It must have a network load balancer (NLB) connected to at least two + // subnets, each in a different Availability Zone. + // - The Allow principals list must include the KMS service principal for the + // Region, cks.kms..amazonaws.com , such as cks.kms.us-east-1.amazonaws.com . + // - It must not require acceptance (https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) + // of connection requests. + // - It must have a private DNS name. The private DNS name for an external key + // store with VPC_ENDPOINT_SERVICE connectivity must be unique in its Amazon Web + // Services Region. + // - The domain of the private DNS name must have a verification status (https://docs.aws.amazon.com/vpc/latest/privatelink/verify-domains.html) + // of verified . + // - The TLS certificate (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html) + // specifies the private DNS hostname at which the endpoint is reachable. + // - XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service + // that it uses to communicate with the external key store proxy. Verify that the + // XksProxyVpcEndpointServiceName is correct and the KMS service principal has + // service consumer permissions on the Amazon VPC endpoint service. ConnectionErrorCode ConnectionErrorCodeType // Indicates whether the custom key store is connected to its backing key store. - // For an CloudHSM key store, the ConnectionState indicates whether it is connected - // to its CloudHSM cluster. For an external key store, the ConnectionState - // indicates whether it is connected to the external key store proxy that - // communicates with your external key manager. You can create and use KMS keys in - // your custom key stores only when its ConnectionState is CONNECTED. The - // ConnectionState value is DISCONNECTED only if the key store has never been - // connected or you use the DisconnectCustomKeyStore operation to disconnect it. If - // the value is CONNECTED but you are having trouble using the custom key store, - // make sure that the backing key store is reachable and active. For an CloudHSM - // key store, verify that its associated CloudHSM cluster is active and contains at - // least one active HSM. For an external key store, verify that the external key - // store proxy and external key manager are connected and enabled. A value of - // FAILED indicates that an attempt to connect was unsuccessful. The + // For an CloudHSM key store, the ConnectionState indicates whether it is + // connected to its CloudHSM cluster. For an external key store, the + // ConnectionState indicates whether it is connected to the external key store + // proxy that communicates with your external key manager. You can create and use + // KMS keys in your custom key stores only when its ConnectionState is CONNECTED . + // The ConnectionState value is DISCONNECTED only if the key store has never been + // connected or you use the DisconnectCustomKeyStore operation to disconnect it. + // If the value is CONNECTED but you are having trouble using the custom key + // store, make sure that the backing key store is reachable and active. For an + // CloudHSM key store, verify that its associated CloudHSM cluster is active and + // contains at least one active HSM. For an external key store, verify that the + // external key store proxy and external key manager are connected and enabled. A + // value of FAILED indicates that an attempt to connect was unsuccessful. The // ConnectionErrorCode field in the response indicates the cause of the failure. - // For help resolving a connection failure, see Troubleshooting a custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the - // Key Management Service Developer Guide. + // For help resolving a connection failure, see Troubleshooting a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) + // in the Key Management Service Developer Guide. ConnectionState ConnectionStateType // The date and time when the custom key store was created. @@ -228,35 +179,31 @@ type CustomKeyStoresListEntry struct { // Amazon Web Services. CustomKeyStoreType CustomKeyStoreType - // The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM - // key store. When you initialize the cluster - // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), - // you create this certificate and save it in the customerCA.crt file. This field - // appears only when the CustomKeyStoreType is AWS_CLOUDHSM. + // The trust anchor certificate of the CloudHSM cluster associated with an + // CloudHSM key store. When you initialize the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr) + // , you create this certificate and save it in the customerCA.crt file. This + // field appears only when the CustomKeyStoreType is AWS_CLOUDHSM . TrustAnchorCertificate *string // Configuration settings for the external key store proxy (XKS proxy). The // external key store proxy translates KMS requests into a format that your // external key manager can understand. The proxy configuration includes connection // information that KMS requires. This field appears only when the - // CustomKeyStoreType is EXTERNAL_KEY_STORE. + // CustomKeyStoreType is EXTERNAL_KEY_STORE . XksProxyConfiguration *XksProxyConfigurationType noSmithyDocumentSerde } -// Use this structure to allow cryptographic operations -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) +// Use this structure to allow cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // in the grant only when the operation request includes the specified encryption -// context -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). -// KMS applies the grant constraints only to cryptographic operations that support -// an encryption context, that is, all cryptographic operations with a symmetric -// KMS key -// (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks). -// Grant constraints are not applied to operations that do not support an +// context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) +// . KMS applies the grant constraints only to cryptographic operations that +// support an encryption context, that is, all cryptographic operations with a +// symmetric KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks) +// . Grant constraints are not applied to operations that do not support an // encryption context, such as cryptographic operations with asymmetric KMS keys -// and management operations, such as DescribeKey or RetireGrant. In a +// and management operations, such as DescribeKey or RetireGrant . In a // cryptographic operation, the encryption context in the decryption operation must // be an exact, case-sensitive match for the keys and values in the encryption // context of the encryption operation. Only the order of the pairs can vary. @@ -265,21 +212,18 @@ type CustomKeyStoresListEntry struct { // multiple encryption context pairs that differ only by case. To require a fully // case-sensitive encryption context, use the kms:EncryptionContext: and // kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see -// kms:EncryptionContext: -// (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context) +// kms:EncryptionContext: (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context) // in the Key Management Service Developer Guide . type GrantConstraints struct { // A list of key-value pairs that must match the encryption context in the - // cryptographic operation - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // request. The grant allows the operation only when the encryption context in the // request is the same as the encryption context specified in this constraint. EncryptionContextEquals map[string]string - // A list of key-value pairs that must be included in the encryption context of the - // cryptographic operation - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // A list of key-value pairs that must be included in the encryption context of + // the cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // request. The grant allows the cryptographic operation only when the encryption // context in the request includes the key-value pairs specified in this // constraint, although it can include additional key-value pairs. @@ -305,9 +249,8 @@ type GrantListEntry struct { // in the ListGrants response usually contains the user or role designated as the // grantee principal in the grant. However, when the grantee principal in the grant // is an Amazon Web Services service, the GranteePrincipal field contains the - // service principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services), - // which might represent several different grantee principals. + // service principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) + // , which might represent several different grantee principals. GranteePrincipal *string // The Amazon Web Services account under which the grant was issued. @@ -342,7 +285,7 @@ type KeyListEntry struct { } // Contains metadata about a KMS key. This data type is used as a response element -// for the CreateKey, DescribeKey, and ReplicateKey operations. +// for the CreateKey , DescribeKey , and ReplicateKey operations. type KeyMetadata struct { // The globally unique identifier for the KMS key. @@ -350,28 +293,26 @@ type KeyMetadata struct { // This member is required. KeyId *string - // The twelve-digit account ID of the Amazon Web Services account that owns the KMS - // key. + // The twelve-digit account ID of the Amazon Web Services account that owns the + // KMS key. AWSAccountId *string // The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management - // Service (KMS) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) + // Service (KMS) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) // in the Example ARNs section of the Amazon Web Services General Reference. Arn *string // The cluster ID of the CloudHSM cluster that contains the key material for the - // KMS key. When you create a KMS key in an CloudHSM custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), - // KMS creates the key material for the KMS key in the associated CloudHSM cluster. - // This field is present only when the KMS key is created in an CloudHSM key store. + // KMS key. When you create a KMS key in an CloudHSM custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // , KMS creates the key material for the KMS key in the associated CloudHSM + // cluster. This field is present only when the KMS key is created in an CloudHSM + // key store. CloudHsmClusterId *string // The date and time when the KMS key was created. CreationDate *time.Time - // A unique identifier for the custom key store - // (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) + // A unique identifier for the custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // that contains the KMS key. This field is present only when the KMS key is // created in a custom key store. CustomKeyStoreId *string @@ -385,32 +326,31 @@ type KeyMetadata struct { // The date and time after which KMS deletes this KMS key. This value is present // only when the KMS key is scheduled for deletion, that is, when its KeyState is - // PendingDeletion. When the primary key in a multi-Region key is scheduled for - // deletion but still has replica keys, its key state is PendingReplicaDeletion and - // the length of its waiting period is displayed in the PendingDeletionWindowInDays - // field. + // PendingDeletion . When the primary key in a multi-Region key is scheduled for + // deletion but still has replica keys, its key state is PendingReplicaDeletion + // and the length of its waiting period is displayed in the + // PendingDeletionWindowInDays field. DeletionDate *time.Time // The description of the KMS key. Description *string - // Specifies whether the KMS key is enabled. When KeyState is Enabled this value is - // true, otherwise it is false. + // Specifies whether the KMS key is enabled. When KeyState is Enabled this value + // is true, otherwise it is false. Enabled bool // The encryption algorithms that the KMS key supports. You cannot use the KMS key // with other encryption algorithms within KMS. This value is present only when the - // KeyUsage of the KMS key is ENCRYPT_DECRYPT. + // KeyUsage of the KMS key is ENCRYPT_DECRYPT . EncryptionAlgorithms []EncryptionAlgorithmSpec - // Specifies whether the KMS key's key material expires. This value is present only - // when Origin is EXTERNAL, otherwise this value is omitted. + // Specifies whether the KMS key's key material expires. This value is present + // only when Origin is EXTERNAL , otherwise this value is omitted. ExpirationModel ExpirationModelType // The manager of the KMS key. KMS keys in your Amazon Web Services account are // either customer managed or Amazon Web Services managed. For more information - // about the difference, see KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) + // about the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) // in the Key Management Service Developer Guide. KeyManager KeyManagerType @@ -418,57 +358,49 @@ type KeyMetadata struct { KeySpec KeySpec // The current status of the KMS key. For more information about how key state - // affects the use of a KMS key, see Key states of KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the - // Key Management Service Developer Guide. + // affects the use of a KMS key, see Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) + // in the Key Management Service Developer Guide. KeyState KeyState - // The cryptographic operations - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) + // The cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // for which you can use the KMS key. KeyUsage KeyUsageType // The message authentication code (MAC) algorithm that the HMAC KMS key supports. // This value is present only when the KeyUsage of the KMS key is - // GENERATE_VERIFY_MAC. + // GENERATE_VERIFY_MAC . MacAlgorithms []MacAlgorithmSpec - // Indicates whether the KMS key is a multi-Region (True) or regional (False) key. - // This value is True for multi-Region primary and replica keys and False for + // Indicates whether the KMS key is a multi-Region ( True ) or regional ( False ) + // key. This value is True for multi-Region primary and replica keys and False for // regional KMS keys. For more information about multi-Region keys, see - // Multi-Region keys in KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) + // Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) // in the Key Management Service Developer Guide. MultiRegion *bool // Lists the primary and replica keys in same multi-Region key. This field is - // present only when the value of the MultiRegion field is True. For more + // present only when the value of the MultiRegion field is True . For more // information about any listed KMS key, use the DescribeKey operation. - // - // * - // MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key. - // - // * - // PrimaryKey displays the key ARN and Region of the primary key. This field - // displays the current KMS key if it is the primary key. - // - // * ReplicaKeys displays - // the key ARNs and Regions of all replica keys. This field includes the current - // KMS key if it is a replica key. + // - MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA + // key. + // - PrimaryKey displays the key ARN and Region of the primary key. This field + // displays the current KMS key if it is the primary key. + // - ReplicaKeys displays the key ARNs and Regions of all replica keys. This + // field includes the current KMS key if it is a replica key. MultiRegionConfiguration *MultiRegionConfiguration - // The source of the key material for the KMS key. When this value is AWS_KMS, KMS - // created the key material. When this value is EXTERNAL, the key material was + // The source of the key material for the KMS key. When this value is AWS_KMS , KMS + // created the key material. When this value is EXTERNAL , the key material was // imported or the KMS key doesn't have any key material. When this value is - // AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated + // AWS_CLOUDHSM , the key material was created in the CloudHSM cluster associated // with a custom key store. Origin OriginType - // The waiting period before the primary key in a multi-Region key is deleted. This - // waiting period begins when the last of its replica keys is deleted. This value - // is present only when the KeyState of the KMS key is PendingReplicaDeletion. That - // indicates that the KMS key is the primary key in a multi-Region key, it is - // scheduled for deletion, and it still has existing replica keys. When a + // The waiting period before the primary key in a multi-Region key is deleted. + // This waiting period begins when the last of its replica keys is deleted. This + // value is present only when the KeyState of the KMS key is PendingReplicaDeletion + // . That indicates that the KMS key is the primary key in a multi-Region key, it + // is scheduled for deletion, and it still has existing replica keys. When a // single-Region KMS key or a multi-Region replica key is scheduled for deletion, // its deletion date is displayed in the DeletionDate field. However, when the // primary key in a multi-Region key is scheduled for deletion, its waiting period @@ -481,18 +413,17 @@ type KeyMetadata struct { // The signing algorithms that the KMS key supports. You cannot use the KMS key // with other signing algorithms within KMS. This field appears only when the - // KeyUsage of the KMS key is SIGN_VERIFY. + // KeyUsage of the KMS key is SIGN_VERIFY . SigningAlgorithms []SigningAlgorithmSpec // The time at which the imported key material expires. When the key material // expires, KMS deletes the key material and the KMS key becomes unusable. This // value is present only for KMS keys whose Origin is EXTERNAL and whose - // ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted. + // ExpirationModel is KEY_MATERIAL_EXPIRES , otherwise this value is omitted. ValidTo *time.Time // Information about the external key that is associated with a KMS key in an - // external key store. For more information, see External key - // (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) + // external key store. For more information, see External key (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) // in the Key Management Service Developer Guide. XksKeyConfiguration *XksKeyConfigurationType @@ -534,8 +465,7 @@ type MultiRegionKey struct { // A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag // values are both required, but tag values can be empty (null) strings. For // information about the rules that apply to tag keys and tag values, see -// User-Defined Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) // in the Amazon Web Services Billing and Cost Management User Guide. type Tag struct { @@ -552,16 +482,14 @@ type Tag struct { noSmithyDocumentSerde } -// Information about the external key -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key)that -// is associated with a KMS key in an external key store. This element appears in a -// CreateKey or DescribeKey response only for a KMS key in an external key store. -// The external key is a symmetric encryption key that is hosted by an external key -// manager outside of Amazon Web Services. When you use the KMS key in an external -// key store in a cryptographic operation, the cryptographic operation is performed -// in the external key manager using the specified external key. For more -// information, see External key -// (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) +// Information about the external key (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) +// that is associated with a KMS key in an external key store. This element appears +// in a CreateKey or DescribeKey response only for a KMS key in an external key +// store. The external key is a symmetric encryption key that is hosted by an +// external key manager outside of Amazon Web Services. When you use the KMS key in +// an external key store in a cryptographic operation, the cryptographic operation +// is performed in the external key manager using the specified external key. For +// more information, see External key (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key) // in the Key Management Service Developer Guide. type XksKeyConfigurationType struct { @@ -596,11 +524,10 @@ type XksProxyAuthenticationCredentialType struct { // external key store proxy translates KMS requests into a format that your // external key manager can understand. These fields appear in a // DescribeCustomKeyStores response only when the CustomKeyStoreType is -// EXTERNAL_KEY_STORE. +// EXTERNAL_KEY_STORE . type XksProxyConfigurationType struct { - // The part of the external key store proxy authentication credential - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential) + // The part of the external key store proxy authentication credential (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential) // that uniquely identifies the secret access key. AccessKeyId *string diff --git a/service/lakeformation/api_client.go b/service/lakeformation/api_client.go index 88cdba36358..d20406f4896 100644 --- a/service/lakeformation/api_client.go +++ b/service/lakeformation/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go b/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go index 88c6ee91e39..bcb542b6791 100644 --- a/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go +++ b/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go @@ -19,10 +19,10 @@ import ( // permission of the assumed role. All permissions attached to the role via the // SAML federation setup will be included in the role session. This decorated role // is expected to access data in Amazon S3 by getting temporary access from Lake -// Formation which is authorized via the virtual API GetDataAccess. Therefore, all -// SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a minimum -// include lakeformation:GetDataAccess in their role policies. A typical IAM policy -// attached to such a role would look as follows: +// Formation which is authorized via the virtual API GetDataAccess . Therefore, all +// SAML roles that can be assumed via AssumeDecoratedRoleWithSAML must at a +// minimum include lakeformation:GetDataAccess in their role policies. A typical +// IAM policy attached to such a role would look as follows: func (c *Client) AssumeDecoratedRoleWithSAML(ctx context.Context, params *AssumeDecoratedRoleWithSAMLInput, optFns ...func(*Options)) (*AssumeDecoratedRoleWithSAMLOutput, error) { if params == nil { params = &AssumeDecoratedRoleWithSAMLInput{} @@ -47,7 +47,7 @@ type AssumeDecoratedRoleWithSAMLInput struct { PrincipalArn *string // The role that represents an IAM principal whose scope down policy allows it to - // call credential vending APIs such as GetTemporaryTableCredentials. The caller + // call credential vending APIs such as GetTemporaryTableCredentials . The caller // must also have iam:PassRole permission on this role. // // This member is required. diff --git a/service/lakeformation/api_op_DeleteObjectsOnCancel.go b/service/lakeformation/api_op_DeleteObjectsOnCancel.go index a9f57a73eb2..06951c13795 100644 --- a/service/lakeformation/api_op_DeleteObjectsOnCancel.go +++ b/service/lakeformation/api_op_DeleteObjectsOnCancel.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For a specific governed table, provides a list of Amazon S3 objects that will be -// written during the current transaction and that can be automatically deleted if -// the transaction is canceled. Without this call, no Amazon S3 objects are +// For a specific governed table, provides a list of Amazon S3 objects that will +// be written during the current transaction and that can be automatically deleted +// if the transaction is canceled. Without this call, no Amazon S3 objects are // automatically deleted when a transaction cancels. The Glue ETL library function // write_dynamic_frame.from_catalog() includes an option to automatically call // DeleteObjectsOnCancel before writes. For more information, see Rolling Back -// Amazon S3 Writes -// (https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes). +// Amazon S3 Writes (https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes) +// . func (c *Client) DeleteObjectsOnCancel(ctx context.Context, params *DeleteObjectsOnCancelInput, optFns ...func(*Options)) (*DeleteObjectsOnCancelOutput, error) { if params == nil { params = &DeleteObjectsOnCancelInput{} diff --git a/service/lakeformation/api_op_DescribeResource.go b/service/lakeformation/api_op_DescribeResource.go index 2ddcc4731f7..c5536f19315 100644 --- a/service/lakeformation/api_op_DescribeResource.go +++ b/service/lakeformation/api_op_DescribeResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the current data access role for the given resource registered in Lake -// Formation. +// Retrieves the current data access role for the given resource registered in +// Lake Formation. func (c *Client) DescribeResource(ctx context.Context, params *DescribeResourceInput, optFns ...func(*Options)) (*DescribeResourceOutput, error) { if params == nil { params = &DescribeResourceInput{} diff --git a/service/lakeformation/api_op_GetEffectivePermissionsForPath.go b/service/lakeformation/api_op_GetEffectivePermissionsForPath.go index 99f3d7cf62d..07218ee27dc 100644 --- a/service/lakeformation/api_op_GetEffectivePermissionsForPath.go +++ b/service/lakeformation/api_op_GetEffectivePermissionsForPath.go @@ -13,8 +13,8 @@ import ( ) // Returns the Lake Formation permissions for a specified table or database -// resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not -// return databases and tables if the catalog is encrypted. +// resource located at a path in Amazon S3. GetEffectivePermissionsForPath will +// not return databases and tables if the catalog is encrypted. func (c *Client) GetEffectivePermissionsForPath(ctx context.Context, params *GetEffectivePermissionsForPathInput, optFns ...func(*Options)) (*GetEffectivePermissionsForPathOutput, error) { if params == nil { params = &GetEffectivePermissionsForPathInput{} diff --git a/service/lakeformation/api_op_GetQueryState.go b/service/lakeformation/api_op_GetQueryState.go index 6312a066747..66b4aaadbc5 100644 --- a/service/lakeformation/api_op_GetQueryState.go +++ b/service/lakeformation/api_op_GetQueryState.go @@ -15,7 +15,7 @@ import ( // Returns the state of a query previously submitted. Clients are expected to poll // GetQueryState to monitor the current state of the planning before retrieving the // work units. A query state is only visible to the principal that made the initial -// call to StartQueryPlanning. +// call to StartQueryPlanning . func (c *Client) GetQueryState(ctx context.Context, params *GetQueryStateInput, optFns ...func(*Options)) (*GetQueryStateOutput, error) { if params == nil { params = &GetQueryStateInput{} @@ -45,18 +45,12 @@ type GetQueryStateInput struct { type GetQueryStateOutput struct { // The state of a query previously submitted. The possible states are: - // - // * PENDING: - // the query is pending. - // - // * WORKUNITS_AVAILABLE: some work units are ready for - // retrieval and execution. - // - // * FINISHED: the query planning finished successfully, - // and all work units are ready for retrieval and execution. - // - // * ERROR: an error - // occurred with the query, such as an invalid query ID or a backend error. + // - PENDING: the query is pending. + // - WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution. + // - FINISHED: the query planning finished successfully, and all work units are + // ready for retrieval and execution. + // - ERROR: an error occurred with the query, such as an invalid query ID or a + // backend error. // // This member is required. State types.QueryStateString diff --git a/service/lakeformation/api_op_GetTableObjects.go b/service/lakeformation/api_op_GetTableObjects.go index 4a671d86209..581f3aece0e 100644 --- a/service/lakeformation/api_op_GetTableObjects.go +++ b/service/lakeformation/api_op_GetTableObjects.go @@ -53,25 +53,20 @@ type GetTableObjectsInput struct { // A predicate to filter the objects returned based on the partition keys defined // in the governed table. - // - // * The comparison operators supported are: =, >, <, >=, - // <= - // - // * The logical operators supported are: AND - // - // * The data types supported are - // integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd - // HH:mm:ss"), string and decimal. + // - The comparison operators supported are: =, >, <, >=, <= + // - The logical operators supported are: AND + // - The data types supported are integer, long, date(yyyy-MM-dd), + // timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal. PartitionPredicate *string // The time as of when to read the governed table contents. If not set, the most // recent transaction commit time is used. Cannot be specified along with - // TransactionId. + // TransactionId . QueryAsOfTime *time.Time // The transaction ID at which to read the governed table contents. If this // transaction has aborted, an error is returned. If not set, defaults to the most - // recent committed transaction. Cannot be specified along with QueryAsOfTime. + // recent committed transaction. Cannot be specified along with QueryAsOfTime . TransactionId *string noSmithyDocumentSerde diff --git a/service/lakeformation/api_op_GetTemporaryGluePartitionCredentials.go b/service/lakeformation/api_op_GetTemporaryGluePartitionCredentials.go index d2120778df6..74d58b26f20 100644 --- a/service/lakeformation/api_op_GetTemporaryGluePartitionCredentials.go +++ b/service/lakeformation/api_op_GetTemporaryGluePartitionCredentials.go @@ -39,7 +39,7 @@ type GetTemporaryGluePartitionCredentialsInput struct { Partition *types.PartitionValueList // A list of supported permission types for the partition. Valid values are - // COLUMN_PERMISSION and CELL_FILTER_PERMISSION. + // COLUMN_PERMISSION and CELL_FILTER_PERMISSION . // // This member is required. SupportedPermissionTypes []types.PermissionType diff --git a/service/lakeformation/api_op_GetTemporaryGlueTableCredentials.go b/service/lakeformation/api_op_GetTemporaryGlueTableCredentials.go index 737c85e0b21..da8ee213ec3 100644 --- a/service/lakeformation/api_op_GetTemporaryGlueTableCredentials.go +++ b/service/lakeformation/api_op_GetTemporaryGlueTableCredentials.go @@ -34,7 +34,7 @@ func (c *Client) GetTemporaryGlueTableCredentials(ctx context.Context, params *G type GetTemporaryGlueTableCredentialsInput struct { // A list of supported permission types for the table. Valid values are - // COLUMN_PERMISSION and CELL_FILTER_PERMISSION. + // COLUMN_PERMISSION and CELL_FILTER_PERMISSION . // // This member is required. SupportedPermissionTypes []types.PermissionType diff --git a/service/lakeformation/api_op_GetWorkUnitResults.go b/service/lakeformation/api_op_GetWorkUnitResults.go index 77ee4a114d4..b5838a0cc0e 100644 --- a/service/lakeformation/api_op_GetWorkUnitResults.go +++ b/service/lakeformation/api_op_GetWorkUnitResults.go @@ -38,13 +38,13 @@ type GetWorkUnitResultsInput struct { // The work unit ID for which to get results. Value generated by enumerating // WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output - // of GetWorkUnits. + // of GetWorkUnits . // // This member is required. WorkUnitId int64 - // A work token used to query the execution service. Token output from - // GetWorkUnits. + // A work token used to query the execution service. Token output from GetWorkUnits + // . // // This member is required. WorkUnitToken *string diff --git a/service/lakeformation/api_op_GetWorkUnits.go b/service/lakeformation/api_op_GetWorkUnits.go index 7b025781183..43ce147bd79 100644 --- a/service/lakeformation/api_op_GetWorkUnits.go +++ b/service/lakeformation/api_op_GetWorkUnits.go @@ -62,8 +62,8 @@ type GetWorkUnitsOutput struct { // This member is required. WorkUnitRanges []types.WorkUnitRange - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lakeformation/api_op_GrantPermissions.go b/service/lakeformation/api_op_GrantPermissions.go index f15f8d3d4d4..3b05968b692 100644 --- a/service/lakeformation/api_op_GrantPermissions.go +++ b/service/lakeformation/api_op_GrantPermissions.go @@ -13,8 +13,8 @@ import ( // Grants permissions to the principal to access metadata in the Data Catalog and // data organized in underlying data storage such as Amazon S3. For information -// about permissions, see Security and Access Control to Metadata and Data -// (https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html). +// about permissions, see Security and Access Control to Metadata and Data (https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html) +// . func (c *Client) GrantPermissions(ctx context.Context, params *GrantPermissionsInput, optFns ...func(*Options)) (*GrantPermissionsOutput, error) { if params == nil { params = &GrantPermissionsInput{} @@ -32,11 +32,11 @@ func (c *Client) GrantPermissions(ctx context.Context, params *GrantPermissionsI type GrantPermissionsInput struct { - // The permissions granted to the principal on the resource. Lake Formation defines - // privileges to grant and revoke access to metadata in the Data Catalog and data - // organized in underlying data storage such as Amazon S3. Lake Formation requires - // that each principal be authorized to perform a specific task on Lake Formation - // resources. + // The permissions granted to the principal on the resource. Lake Formation + // defines privileges to grant and revoke access to metadata in the Data Catalog + // and data organized in underlying data storage such as Amazon S3. Lake Formation + // requires that each principal be authorized to perform a specific task on Lake + // Formation resources. // // This member is required. Permissions []types.Permission @@ -50,8 +50,8 @@ type GrantPermissionsInput struct { // This member is required. Principal *types.DataLakePrincipal - // The resource to which permissions are to be granted. Resources in Lake Formation - // are the Data Catalog, databases, and tables. + // The resource to which permissions are to be granted. Resources in Lake + // Formation are the Data Catalog, databases, and tables. // // This member is required. Resource *types.Resource @@ -62,9 +62,9 @@ type GrantPermissionsInput struct { // environment. CatalogId *string - // Indicates a list of the granted permissions that the principal may pass to other - // users. These permissions may only be a subset of the permissions granted in the - // Privileges. + // Indicates a list of the granted permissions that the principal may pass to + // other users. These permissions may only be a subset of the permissions granted + // in the Privileges . PermissionsWithGrantOption []types.Permission noSmithyDocumentSerde diff --git a/service/lakeformation/api_op_ListDataCellsFilter.go b/service/lakeformation/api_op_ListDataCellsFilter.go index ce4484ae1b4..1180693f362 100644 --- a/service/lakeformation/api_op_ListDataCellsFilter.go +++ b/service/lakeformation/api_op_ListDataCellsFilter.go @@ -119,8 +119,8 @@ func (c *Client) addOperationListDataCellsFilterMiddlewares(stack *middleware.St return nil } -// ListDataCellsFilterAPIClient is a client that implements the ListDataCellsFilter -// operation. +// ListDataCellsFilterAPIClient is a client that implements the +// ListDataCellsFilter operation. type ListDataCellsFilterAPIClient interface { ListDataCellsFilter(context.Context, *ListDataCellsFilterInput, ...func(*Options)) (*ListDataCellsFilterOutput, error) } diff --git a/service/lakeformation/api_op_ListLFTags.go b/service/lakeformation/api_op_ListLFTags.go index b6c86b8ffc0..0f6c35c0688 100644 --- a/service/lakeformation/api_op_ListLFTags.go +++ b/service/lakeformation/api_op_ListLFTags.go @@ -42,9 +42,9 @@ type ListLFTagsInput struct { // A continuation token, if this is not the first call to retrieve this list. NextToken *string - // If resource share type is ALL, returns both in-account LF-tags and shared + // If resource share type is ALL , returns both in-account LF-tags and shared // LF-tags that the requester has permission to view. If resource share type is - // FOREIGN, returns all share LF-tags that the requester can view. If no resource + // FOREIGN , returns all share LF-tags that the requester can view. If no resource // share type is passed, lists LF-tags in the given catalog ID that the requester // has permission to view. ResourceShareType types.ResourceShareType diff --git a/service/lakeformation/api_op_ListPermissions.go b/service/lakeformation/api_op_ListPermissions.go index 09af2151e04..7f303bae5b2 100644 --- a/service/lakeformation/api_op_ListPermissions.go +++ b/service/lakeformation/api_op_ListPermissions.go @@ -17,8 +17,8 @@ import ( // you are able to see only the principal permissions for ALTER. This operation // returns only those permissions that have been explicitly granted. For // information about permissions, see Security and Access Control to Metadata and -// Data -// (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html). +// Data (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html) +// . func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) { if params == nil { params = &ListPermissionsInput{} diff --git a/service/lakeformation/api_op_ListTableStorageOptimizers.go b/service/lakeformation/api_op_ListTableStorageOptimizers.go index 6606eb27e09..e6dd2155c47 100644 --- a/service/lakeformation/api_op_ListTableStorageOptimizers.go +++ b/service/lakeformation/api_op_ListTableStorageOptimizers.go @@ -51,7 +51,7 @@ type ListTableStorageOptimizersInput struct { NextToken *string // The specific type of storage optimizers to list. The supported value is - // compaction. + // compaction . StorageOptimizerType types.OptimizerType noSmithyDocumentSerde @@ -59,8 +59,8 @@ type ListTableStorageOptimizersInput struct { type ListTableStorageOptimizersOutput struct { - // A continuation token for paginating the returned list of tokens, returned if the - // current segment of the list is not the last. + // A continuation token for paginating the returned list of tokens, returned if + // the current segment of the list is not the last. NextToken *string // A list of the storage optimizers associated with a table. diff --git a/service/lakeformation/api_op_ListTransactions.go b/service/lakeformation/api_op_ListTransactions.go index 01428101a74..1d6d1368caa 100644 --- a/service/lakeformation/api_op_ListTransactions.go +++ b/service/lakeformation/api_op_ListTransactions.go @@ -44,7 +44,7 @@ type ListTransactionsInput struct { NextToken *string // A filter indicating the status of transactions to return. Options are ALL | - // COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL. + // COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL . StatusFilter types.TransactionStatusFilter noSmithyDocumentSerde diff --git a/service/lakeformation/api_op_PutDataLakeSettings.go b/service/lakeformation/api_op_PutDataLakeSettings.go index ac233437cb6..5580ed6e08b 100644 --- a/service/lakeformation/api_op_PutDataLakeSettings.go +++ b/service/lakeformation/api_op_PutDataLakeSettings.go @@ -13,9 +13,8 @@ import ( // Sets the list of data lake administrators who have admin privileges on all // resources managed by Lake Formation. For more information on admin privileges, -// see Granting Lake Formation Permissions -// (https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html). -// This API replaces the current list of data lake admins with the new list being +// see Granting Lake Formation Permissions (https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html) +// . This API replaces the current list of data lake admins with the new list being // passed. To add an admin, fetch the current list and add the new admin to that // list and pass that list in this API. func (c *Client) PutDataLakeSettings(ctx context.Context, params *PutDataLakeSettingsInput, optFns ...func(*Options)) (*PutDataLakeSettingsOutput, error) { diff --git a/service/lakeformation/api_op_RegisterResource.go b/service/lakeformation/api_op_RegisterResource.go index 74c566627b0..b3146634f0f 100644 --- a/service/lakeformation/api_op_RegisterResource.go +++ b/service/lakeformation/api_op_RegisterResource.go @@ -21,7 +21,7 @@ import ( // registers a new location and gives Lake Formation permission to use the // service-linked role to access that location. ResourceArn = // arn:aws:s3:::my-bucket UseServiceLinkedRole = true If UseServiceLinkedRole is -// not set to true, you must provide or set the RoleArn: +// not set to true, you must provide or set the RoleArn : // arn:aws:iam::12345:role/my-data-access-role func (c *Client) RegisterResource(ctx context.Context, params *RegisterResourceInput, optFns ...func(*Options)) (*RegisterResourceOutput, error) { if params == nil { @@ -51,8 +51,8 @@ type RegisterResourceInput struct { // Designates an Identity and Access Management (IAM) service-linked role by // registering this role with the Data Catalog. A service-linked role is a unique // type of IAM role that is linked directly to Lake Formation. For more - // information, see Using Service-Linked Roles for Lake Formation - // (https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html). + // information, see Using Service-Linked Roles for Lake Formation (https://docs.aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html) + // . UseServiceLinkedRole *bool // Whether or not the resource is a federated resource. diff --git a/service/lakeformation/api_op_RevokePermissions.go b/service/lakeformation/api_op_RevokePermissions.go index 41b60aae0c5..14d61d2bc0a 100644 --- a/service/lakeformation/api_op_RevokePermissions.go +++ b/service/lakeformation/api_op_RevokePermissions.go @@ -31,8 +31,8 @@ func (c *Client) RevokePermissions(ctx context.Context, params *RevokePermission type RevokePermissionsInput struct { // The permissions revoked to the principal on the resource. For information about - // permissions, see Security and Access Control to Metadata and Data - // (https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html). + // permissions, see Security and Access Control to Metadata and Data (https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html) + // . // // This member is required. Permissions []types.Permission diff --git a/service/lakeformation/api_op_SearchDatabasesByLFTags.go b/service/lakeformation/api_op_SearchDatabasesByLFTags.go index c67b234a4ee..a72b8a9846a 100644 --- a/service/lakeformation/api_op_SearchDatabasesByLFTags.go +++ b/service/lakeformation/api_op_SearchDatabasesByLFTags.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation allows a search on DATABASE resources by TagCondition. This +// This operation allows a search on DATABASE resources by TagCondition . This // operation is used by admins who want to grant user permissions on certain -// TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to -// find all resources where the given TagConditions are valid to verify whether the -// returned resources can be shared. +// TagConditions . Before making a grant, the admin can use SearchDatabasesByTags +// to find all resources where the given TagConditions are valid to verify whether +// the returned resources can be shared. func (c *Client) SearchDatabasesByLFTags(ctx context.Context, params *SearchDatabasesByLFTagsInput, optFns ...func(*Options)) (*SearchDatabasesByLFTagsOutput, error) { if params == nil { params = &SearchDatabasesByLFTagsInput{} @@ -34,7 +34,7 @@ func (c *Client) SearchDatabasesByLFTags(ctx context.Context, params *SearchData type SearchDatabasesByLFTagsInput struct { - // A list of conditions (LFTag structures) to search for in database resources. + // A list of conditions ( LFTag structures) to search for in database resources. // // This member is required. Expression []types.LFTag diff --git a/service/lakeformation/api_op_SearchTablesByLFTags.go b/service/lakeformation/api_op_SearchTablesByLFTags.go index 986bc3f7441..19ba51eefe5 100644 --- a/service/lakeformation/api_op_SearchTablesByLFTags.go +++ b/service/lakeformation/api_op_SearchTablesByLFTags.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation allows a search on TABLE resources by LFTags. This will be used +// This operation allows a search on TABLE resources by LFTag s. This will be used // by admins who want to grant user permissions on certain LF-tags. Before making a // grant, the admin can use SearchTablesByLFTags to find all resources where the -// given LFTags are valid to verify whether the returned resources can be shared. +// given LFTag s are valid to verify whether the returned resources can be shared. func (c *Client) SearchTablesByLFTags(ctx context.Context, params *SearchTablesByLFTagsInput, optFns ...func(*Options)) (*SearchTablesByLFTagsOutput, error) { if params == nil { params = &SearchTablesByLFTagsInput{} @@ -33,7 +33,7 @@ func (c *Client) SearchTablesByLFTags(ctx context.Context, params *SearchTablesB type SearchTablesByLFTagsInput struct { - // A list of conditions (LFTag structures) to search for in table resources. + // A list of conditions ( LFTag structures) to search for in table resources. // // This member is required. Expression []types.LFTag diff --git a/service/lakeformation/api_op_StartQueryPlanning.go b/service/lakeformation/api_op_StartQueryPlanning.go index ae6b89881a2..fc7fed07310 100644 --- a/service/lakeformation/api_op_StartQueryPlanning.go +++ b/service/lakeformation/api_op_StartQueryPlanning.go @@ -13,8 +13,8 @@ import ( ) // Submits a request to process a query statement. This operation generates work -// units that can be retrieved with the GetWorkUnits operation as soon as the query -// state is WORKUNITS_AVAILABLE or FINISHED. +// units that can be retrieved with the GetWorkUnits operation as soon as the +// query state is WORKUNITS_AVAILABLE or FINISHED. func (c *Client) StartQueryPlanning(ctx context.Context, params *StartQueryPlanningInput, optFns ...func(*Options)) (*StartQueryPlanningOutput, error) { if params == nil { params = &StartQueryPlanningInput{} diff --git a/service/lakeformation/api_op_StartTransaction.go b/service/lakeformation/api_op_StartTransaction.go index 4e54c3f753a..1b1460d97b4 100644 --- a/service/lakeformation/api_op_StartTransaction.go +++ b/service/lakeformation/api_op_StartTransaction.go @@ -30,9 +30,9 @@ func (c *Client) StartTransaction(ctx context.Context, params *StartTransactionI type StartTransactionInput struct { - // Indicates whether this transaction should be read only or read and write. Writes - // made using a read-only transaction ID will be rejected. Read-only transactions - // do not need to be committed. + // Indicates whether this transaction should be read only or read and write. + // Writes made using a read-only transaction ID will be rejected. Read-only + // transactions do not need to be committed. TransactionType types.TransactionType noSmithyDocumentSerde diff --git a/service/lakeformation/types/enums.go b/service/lakeformation/types/enums.go index 0fae78392e6..67739de6e0d 100644 --- a/service/lakeformation/types/enums.go +++ b/service/lakeformation/types/enums.go @@ -214,9 +214,9 @@ const ( ResourceTypeTable ResourceType = "TABLE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "DATABASE", diff --git a/service/lakeformation/types/errors.go b/service/lakeformation/types/errors.go index e9ff84a3f06..6baa081b4c5 100644 --- a/service/lakeformation/types/errors.go +++ b/service/lakeformation/types/errors.go @@ -243,7 +243,7 @@ func (e *OperationTimeoutException) ErrorFault() smithy.ErrorFault { return smit // The engine does not support filtering data based on the enforced permissions. // For example, if you call the GetTemporaryGlueTableCredentials operation with -// SupportedPermissionType equal to ColumnPermission, but cell-level permissions +// SupportedPermissionType equal to ColumnPermission , but cell-level permissions // exist on the table, this exception is thrown. type PermissionTypeMismatchException struct { Message *string @@ -432,8 +432,8 @@ func (e *TransactionCommitInProgressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Contains details about an error where the specified transaction has already been -// committed and cannot be used for UpdateTableObjects. +// Contains details about an error where the specified transaction has already +// been committed and cannot be used for UpdateTableObjects . type TransactionCommittedException struct { Message *string diff --git a/service/lakeformation/types/types.go b/service/lakeformation/types/types.go index 2cf1ecf73ce..e8daa414c13 100644 --- a/service/lakeformation/types/types.go +++ b/service/lakeformation/types/types.go @@ -10,8 +10,8 @@ import ( // A new object to add to the governed table. type AddObjectInput struct { - // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and - // used to identify changes to the underlying data. + // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation + // and used to identify changes to the underlying data. // // This member is required. ETag *string @@ -43,9 +43,9 @@ type AllRowsWildcard struct { // A structure used to include auditing information on the privileged API. type AuditContext struct { - // The filter engine can populate the 'AdditionalAuditContext' information with the - // request ID for you to track. This information will be displayed in CloudTrail - // log in your account. + // The filter engine can populate the 'AdditionalAuditContext' information with + // the request ID for you to track. This information will be displayed in + // CloudTrail log in your account. AdditionalAuditContext *string noSmithyDocumentSerde @@ -91,8 +91,8 @@ type CatalogResource struct { noSmithyDocumentSerde } -// A structure containing the name of a column resource and the LF-tags attached to -// it. +// A structure containing the name of a column resource and the LF-tags attached +// to it. type ColumnLFTag struct { // The LF-tags attached to a column resource. @@ -156,7 +156,7 @@ type DataCellsFilter struct { ColumnNames []string // A wildcard with exclusions. You must specify either a ColumnNames list or the - // ColumnWildCard. + // ColumnWildCard . ColumnWildcard *ColumnWildcard // A PartiQL predicate. @@ -205,13 +205,13 @@ type DataLakeSettings struct { // that are registered with Lake Formation. If false or null, no Amazon EMR // clusters will be able to access data in Amazon S3 locations that are registered // with Lake Formation. For more information, see (Optional) Allow Data Filtering - // on Amazon EMR - // (https://docs-aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#emr-switch). + // on Amazon EMR (https://docs-aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#emr-switch) + // . AllowExternalDataFiltering *bool - // Lake Formation relies on a privileged process secured by Amazon EMR or the third - // party integrator to tag the user's role while assuming it. Lake Formation will - // publish the acceptable key-value pair, for example key = + // Lake Formation relies on a privileged process secured by Amazon EMR or the + // third party integrator to tag the user's role while assuming it. Lake Formation + // will publish the acceptable key-value pair, for example key = // "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator // must properly tag the temporary security credentials that will be used to call // Lake Formation's administrative APIs. @@ -225,8 +225,8 @@ type DataLakeSettings struct { // compatibility with the Glue permission model implemented by IAM permissions. The // only permitted values are an empty array or an array that contains a single JSON // object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see - // Changing the Default Security Settings for Your Data Lake - // (https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html). + // Changing the Default Security Settings for Your Data Lake (https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) + // . CreateDatabaseDefaultPermissions []PrincipalPermissions // Specifies whether access control on newly created table is managed by Lake @@ -237,8 +237,8 @@ type DataLakeSettings struct { // compatibility with the Glue permission model implemented by IAM permissions. The // only permitted values are an empty array or an array that contains a single JSON // object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see - // Changing the Default Security Settings for Your Data Lake - // (https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html). + // Changing the Default Security Settings for Your Data Lake (https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) + // . CreateTableDefaultPermissions []PrincipalPermissions // A list of Lake Formation principals. Supported principals are IAM users or IAM @@ -287,8 +287,8 @@ type DeleteObjectInput struct { // This member is required. Uri *string - // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and - // used to identify changes to the underlying data. + // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation + // and used to identify changes to the underlying data. ETag *string // A list of partition values for the object. A value must be specified for each @@ -299,7 +299,7 @@ type DeleteObjectInput struct { } // A structure containing the additional details to be returned in the -// AdditionalDetails attribute of PrincipalResourcePermissions. If a catalog +// AdditionalDetails attribute of PrincipalResourcePermissions . If a catalog // resource is shared through Resource Access Manager (RAM), then there will exist // a corresponding RAM resource share ARN. type DetailsMap struct { @@ -508,7 +508,7 @@ type PrincipalPermissions struct { type PrincipalResourcePermissions struct { // This attribute can be used to return any additional details of - // PrincipalResourcePermissions. Currently returns only as a RAM resource share + // PrincipalResourcePermissions . Currently returns only as a RAM resource share // ARN. AdditionalDetails *DetailsMap @@ -542,7 +542,7 @@ type QueryPlanningContext struct { // The time as of when to read the table contents. If not set, the most recent // transaction commit time will be used. Cannot be specified along with - // TransactionId. + // TransactionId . QueryAsOfTime *time.Time // A map consisting of key-value pairs. @@ -552,7 +552,7 @@ type QueryPlanningContext struct { // not committed, the read will be treated as part of that transaction and will see // its writes. If this transaction has aborted, an error will be returned. If not // set, defaults to the most recent committed transaction. Cannot be specified - // along with QueryAsOfTime. + // along with QueryAsOfTime . TransactionId *string noSmithyDocumentSerde @@ -643,7 +643,7 @@ type StorageOptimizer struct { // last job run. LastRunDetails *string - // The specific type of storage optimizer. The supported value is compaction. + // The specific type of storage optimizer. The supported value is compaction . StorageOptimizerType OptimizerType // A message that contains information about any warnings (if present). @@ -655,8 +655,8 @@ type StorageOptimizer struct { // Specifies the details of a governed table. type TableObject struct { - // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and - // used to identify changes to the underlying data. + // The Amazon S3 ETag of the object. Returned by GetTableObjects for validation + // and used to identify changes to the underlying data. ETag *string // The size of the Amazon S3 object in bytes. @@ -700,18 +700,18 @@ type TableWildcard struct { // A structure for a table with columns object. This object is only used when // granting a SELECT permission. This object must take a value for at least one of -// ColumnsNames, ColumnsIndexes, or ColumnsWildcard. +// ColumnsNames , ColumnsIndexes , or ColumnsWildcard . type TableWithColumnsResource struct { - // The name of the database for the table with columns resource. Unique to the Data - // Catalog. A database is a set of associated table definitions organized into a - // logical group. You can Grant and Revoke database privileges to a principal. + // The name of the database for the table with columns resource. Unique to the + // Data Catalog. A database is a set of associated table definitions organized into + // a logical group. You can Grant and Revoke database privileges to a principal. // // This member is required. DatabaseName *string - // The name of the table resource. A table is a metadata definition that represents - // your data. You can Grant and Revoke table privileges to a principal. + // The name of the table resource. A table is a metadata definition that + // represents your data. You can Grant and Revoke table privileges to a principal. // // This member is required. Name *string diff --git a/service/lambda/api_client.go b/service/lambda/api_client.go index d78202145f9..8272b02733f 100644 --- a/service/lambda/api_client.go +++ b/service/lambda/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lambda/api_op_AddLayerVersionPermission.go b/service/lambda/api_op_AddLayerVersionPermission.go index 2d434befb54..5549672ae94 100644 --- a/service/lambda/api_op_AddLayerVersionPermission.go +++ b/service/lambda/api_op_AddLayerVersionPermission.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds permissions to the resource-based policy of a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). Use -// this action to grant layer usage permission to other accounts. You can grant -// permission to a single account, all accounts in an organization, or all Amazon -// Web Services accounts. To revoke permission, call RemoveLayerVersionPermission -// with the statement ID that you specified when you added it. +// Adds permissions to the resource-based policy of a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . Use this action to grant layer usage permission to other accounts. You can +// grant permission to a single account, all accounts in an organization, or all +// Amazon Web Services accounts. To revoke permission, call +// RemoveLayerVersionPermission with the statement ID that you specified when you +// added it. func (c *Client) AddLayerVersionPermission(ctx context.Context, params *AddLayerVersionPermissionInput, optFns ...func(*Options)) (*AddLayerVersionPermissionOutput, error) { if params == nil { params = &AddLayerVersionPermissionInput{} @@ -34,7 +34,7 @@ func (c *Client) AddLayerVersionPermission(ctx context.Context, params *AddLayer type AddLayerVersionPermissionInput struct { // The API action that grants access to the layer. For example, - // lambda:GetLayerVersion. + // lambda:GetLayerVersion . // // This member is required. Action *string @@ -63,7 +63,7 @@ type AddLayerVersionPermissionInput struct { // This member is required. VersionNumber int64 - // With the principal set to *, grant permission to all accounts in the specified + // With the principal set to * , grant permission to all accounts in the specified // organization. OrganizationId *string diff --git a/service/lambda/api_op_AddPermission.go b/service/lambda/api_op_AddPermission.go index f35f65f4d9f..595a8323631 100644 --- a/service/lambda/api_op_AddPermission.go +++ b/service/lambda/api_op_AddPermission.go @@ -17,18 +17,18 @@ import ( // version or alias. If you use a qualifier, the invoker must use the full Amazon // Resource Name (ARN) of that version or alias to invoke the function. Note: // Lambda does not support adding policies to version $LATEST. To grant permission -// to another account, specify the account ID as the Principal. To grant permission -// to an organization defined in Organizations, specify the organization ID as the -// PrincipalOrgID. For Amazon Web Services, the principal is a domain-style -// identifier that the service defines, such as s3.amazonaws.com or -// sns.amazonaws.com. For Amazon Web Services, you can also specify the ARN of the -// associated resource as the SourceArn. If you grant permission to a service +// to another account, specify the account ID as the Principal . To grant +// permission to an organization defined in Organizations, specify the organization +// ID as the PrincipalOrgID . For Amazon Web Services, the principal is a +// domain-style identifier that the service defines, such as s3.amazonaws.com or +// sns.amazonaws.com . For Amazon Web Services, you can also specify the ARN of the +// associated resource as the SourceArn . If you grant permission to a service // principal without specifying the source, other accounts could potentially // configure resources in their account to invoke your Lambda function. This // operation adds a statement to a resource-based permissions policy for the -// function. For more information about function policies, see Using resource-based -// policies for Lambda -// (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html). +// function. For more information about function policies, see Using +// resource-based policies for Lambda (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) +// . func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error) { if params == nil { params = &AddPermissionInput{} @@ -47,38 +47,31 @@ func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, type AddPermissionInput struct { // The action that the principal can use on the function. For example, - // lambda:InvokeFunction or lambda:GetFunction. + // lambda:InvokeFunction or lambda:GetFunction . // // This member is required. Action *string // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string - // The Amazon Web Service or Amazon Web Services account that invokes the function. - // If you specify a service, use SourceArn or SourceAccount to limit who can invoke - // the function through that service. + // The Amazon Web Service or Amazon Web Services account that invokes the + // function. If you specify a service, use SourceArn or SourceAccount to limit who + // can invoke the function through that service. // // This member is required. Principal *string - // A statement identifier that differentiates the statement from others in the same - // policy. + // A statement identifier that differentiates the statement from others in the + // same policy. // // This member is required. StatementId *string @@ -89,8 +82,8 @@ type AddPermissionInput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . FunctionUrlAuthType types.FunctionUrlAuthType // The identifier for your organization in Organizations. Use this to grant diff --git a/service/lambda/api_op_CreateAlias.go b/service/lambda/api_op_CreateAlias.go index 736287b9f1c..95e0371f39c 100644 --- a/service/lambda/api_op_CreateAlias.go +++ b/service/lambda/api_op_CreateAlias.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) for a -// Lambda function version. Use aliases to provide clients with a function +// Creates an alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// for a Lambda function version. Use aliases to provide clients with a function // identifier that you can update to invoke a different version. You can also map // an alias to split invocation requests between two versions. Use the // RoutingConfig parameter to specify a second version and the percentage of @@ -36,18 +35,11 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -65,16 +57,15 @@ type CreateAliasInput struct { // A description of the alias. Description *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) // of the alias. RoutingConfig *types.AliasRoutingConfiguration noSmithyDocumentSerde } -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Provides configuration information about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . type CreateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -92,8 +83,7 @@ type CreateAliasOutput struct { // A unique identifier that changes when you update the alias. RevisionId *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) // of the alias. RoutingConfig *types.AliasRoutingConfiguration diff --git a/service/lambda/api_op_CreateCodeSigningConfig.go b/service/lambda/api_op_CreateCodeSigningConfig.go index 065663df0b7..ff5dd4ff5c7 100644 --- a/service/lambda/api_op_CreateCodeSigningConfig.go +++ b/service/lambda/api_op_CreateCodeSigningConfig.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a code signing configuration. A code signing configuration -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) +// Creates a code signing configuration. A code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) // defines a list of allowed signing profiles and defines the code-signing // validation policy (action to be taken if deployment validation checks fail). func (c *Client) CreateCodeSigningConfig(ctx context.Context, params *CreateCodeSigningConfigInput, optFns ...func(*Options)) (*CreateCodeSigningConfigOutput, error) { diff --git a/service/lambda/api_op_CreateEventSourceMapping.go b/service/lambda/api_op_CreateEventSourceMapping.go index 3e3d2020033..6270b0f36b7 100644 --- a/service/lambda/api_op_CreateEventSourceMapping.go +++ b/service/lambda/api_op_CreateEventSourceMapping.go @@ -15,85 +15,38 @@ import ( // Creates a mapping between an event source and an Lambda function. Lambda reads // items from the event source and invokes the function. For details about how to // configure different event sources, see the following topics. +// - Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// - Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) +// - Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) +// - Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) +// - Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) +// - Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) +// - Amazon DocumentDB (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) // -// * Amazon DynamoDB -// Streams -// (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// The following error handling options are available only for stream sources +// (DynamoDB and Kinesis): +// - BisectBatchOnFunctionError – If the function returns an error, split the +// batch in two and retry. +// - DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon +// SNS topic. +// - MaximumRecordAgeInSeconds – Discard records older than the specified age. +// The default value is infinite (-1). When set to infinite (-1), failed records +// are retried until the record expires +// - MaximumRetryAttempts – Discard records after the specified number of +// retries. The default value is infinite (-1). When set to infinite (-1), failed +// records are retried until the record expires. +// - ParallelizationFactor – Process multiple batches from each shard +// concurrently. // -// * -// Amazon Kinesis -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) -// -// * -// Amazon SQS -// (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) -// -// * -// Amazon MQ and RabbitMQ -// (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) -// -// * -// Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) -// -// * -// Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) -// -// * -// Amazon DocumentDB -// (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) -// -// The -// following error handling options are available only for stream sources (DynamoDB -// and Kinesis): -// -// * BisectBatchOnFunctionError – If the function returns an error, -// split the batch in two and retry. -// -// * DestinationConfig – Send discarded records -// to an Amazon SQS queue or Amazon SNS topic. -// -// * MaximumRecordAgeInSeconds – -// Discard records older than the specified age. The default value is infinite -// (-1). When set to infinite (-1), failed records are retried until the record -// expires -// -// * MaximumRetryAttempts – Discard records after the specified number of -// retries. The default value is infinite (-1). When set to infinite (-1), failed -// records are retried until the record expires. -// -// * ParallelizationFactor – Process -// multiple batches from each shard concurrently. -// -// For information about which -// configuration parameters apply to each event source, see the following -// topics. -// -// * Amazon DynamoDB Streams -// (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) -// -// * -// Amazon Kinesis -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) -// -// * -// Amazon SQS -// (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) -// -// * -// Amazon MQ and RabbitMQ -// (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) -// -// * -// Amazon MSK -// (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) -// -// * -// Apache Kafka -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) -// -// * -// Amazon DocumentDB -// (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html#docdb-configuration) +// For information about which configuration parameters apply to each event +// source, see the following topics. +// - Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) +// - Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) +// - Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) +// - Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) +// - Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) +// - Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) +// - Amazon DocumentDB (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html#docdb-configuration) func (c *Client) CreateEventSourceMapping(ctx context.Context, params *CreateEventSourceMappingInput, optFns ...func(*Options)) (*CreateEventSourceMappingOutput, error) { if params == nil { params = &CreateEventSourceMappingInput{} @@ -112,53 +65,33 @@ func (c *Client) CreateEventSourceMapping(ctx context.Context, params *CreateEve type CreateEventSourceMappingInput struct { // The name of the Lambda function. Name formats - // - // * Function name – MyFunction. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Version or Alias ARN – - // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. - // - // * Partial ARN – - // 123456789012:function:MyFunction. - // - // The length constraint applies only to the - // full ARN. If you specify only the function name, it's limited to 64 characters - // in length. + // - Function name – MyFunction . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Version or Alias ARN – + // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD . + // - Partial ARN – 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it's limited to 64 characters in length. // // This member is required. FunctionName *string - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *types.AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream // or queue and sends to your function. Lambda passes all of the records in the // batch to the function in a single call, up to the payload limit for synchronous // invocation (6 MB). - // - // * Amazon Kinesis – Default 100. Max 10,000. - // - // * Amazon - // DynamoDB Streams – Default 100. Max 10,000. - // - // * Amazon Simple Queue Service – - // Default 10. For standard queues the max is 10,000. For FIFO queues the max is - // 10. - // - // * Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. - // - // * - // Self-managed Apache Kafka – Default 100. Max 10,000. - // - // * Amazon MQ (ActiveMQ and - // RabbitMQ) – Default 100. Max 10,000. - // - // * DocumentDB – Default 100. Max 10,000. + // - Amazon Kinesis – Default 100. Max 10,000. + // - Amazon DynamoDB Streams – Default 100. Max 10,000. + // - Amazon Simple Queue Service – Default 10. For standard queues the max is + // 10,000. For FIFO queues the max is 10. + // - Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. + // - Self-managed Apache Kafka – Default 100. Max 10,000. + // - Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. + // - DocumentDB – Default 100. Max 10,000. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -172,33 +105,22 @@ type CreateEventSourceMappingInput struct { // Specific configuration settings for a DocumentDB event source. DocumentDBEventSourceConfig *types.DocumentDBEventSourceConfig - // When true, the event source mapping is active. When false, Lambda pauses polling - // and invocation. Default: True + // When true, the event source mapping is active. When false, Lambda pauses + // polling and invocation. Default: True Enabled *bool // The Amazon Resource Name (ARN) of the event source. - // - // * Amazon Kinesis – The ARN - // of the data stream or a stream consumer. - // - // * Amazon DynamoDB Streams – The ARN of - // the stream. - // - // * Amazon Simple Queue Service – The ARN of the queue. - // - // * Amazon - // Managed Streaming for Apache Kafka – The ARN of the cluster. - // - // * Amazon MQ – The - // ARN of the broker. - // - // * Amazon DocumentDB – The ARN of the DocumentDB change - // stream. + // - Amazon Kinesis – The ARN of the data stream or a stream consumer. + // - Amazon DynamoDB Streams – The ARN of the stream. + // - Amazon Simple Queue Service – The ARN of the queue. + // - Amazon Managed Streaming for Apache Kafka – The ARN of the cluster. + // - Amazon MQ – The ARN of the broker. + // - Amazon DocumentDB – The ARN of the DocumentDB change stream. EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type @@ -236,8 +158,8 @@ type CreateEventSourceMappingInput struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // The self-managed Apache Kafka cluster to receive records from. @@ -255,7 +177,7 @@ type CreateEventSourceMappingInput struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition types.EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time // The name of the Kafka topic. @@ -270,11 +192,11 @@ type CreateEventSourceMappingInput struct { } // A mapping between an Amazon Web Services resource and a Lambda function. For -// details, see CreateEventSourceMapping. +// details, see CreateEventSourceMapping . type CreateEventSourceMappingOutput struct { - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *types.AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream @@ -301,8 +223,8 @@ type CreateEventSourceMappingOutput struct { EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -352,8 +274,8 @@ type CreateEventSourceMappingOutput struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // The self-managed Apache Kafka cluster for your event source. @@ -371,11 +293,11 @@ type CreateEventSourceMappingOutput struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition types.EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + // The state of the event source mapping. It can be one of the following: Creating + // , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting . State *string // Indicates whether a user or Lambda made the last change to the event source diff --git a/service/lambda/api_op_CreateFunction.go b/service/lambda/api_op_CreateFunction.go index 3106f0350de..0c71a762b74 100644 --- a/service/lambda/api_op_CreateFunction.go +++ b/service/lambda/api_op_CreateFunction.go @@ -11,57 +11,52 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Lambda function. To create a function, you need a deployment package -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and -// an execution role -// (https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role). -// The deployment package is a .zip file archive or container image that contains +// Creates a Lambda function. To create a function, you need a deployment package (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) +// and an execution role (https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role) +// . The deployment package is a .zip file archive or container image that contains // your function code. The execution role grants the function permission to use // Amazon Web Services, such as Amazon CloudWatch Logs for log streaming and X-Ray -// for request tracing. If the deployment package is a container image -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html), then you set -// the package type to Image. For a container image, the code property must include -// the URI of a container image in the Amazon ECR registry. You do not need to -// specify the handler and runtime properties. If the deployment package is a .zip -// file archive -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip), -// then you set the package type to Zip. For a .zip file archive, the code property -// specifies the location of the .zip file. You must also specify the handler and -// runtime properties. The code in the deployment package must be compatible with -// the target instruction set architecture of the function (x86-64 or arm64). If -// you do not specify the architecture, then the default value is x86-64. When you -// create a function, Lambda provisions an instance of the function and its -// supporting resources. If your function connects to a VPC, this process can take -// a minute or so. During this time, you can't invoke or modify the function. The -// State, StateReason, and StateReasonCode fields in the response from -// GetFunctionConfiguration indicate when the function is ready to invoke. For more -// information, see Lambda function states -// (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html). A function -// has an unpublished version, and can have published versions and aliases. The -// unpublished version changes when you update your function's code and -// configuration. A published version is a snapshot of your function code and +// for request tracing. If the deployment package is a container image (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) +// , then you set the package type to Image . For a container image, the code +// property must include the URI of a container image in the Amazon ECR registry. +// You do not need to specify the handler and runtime properties. If the deployment +// package is a .zip file archive (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip) +// , then you set the package type to Zip . For a .zip file archive, the code +// property specifies the location of the .zip file. You must also specify the +// handler and runtime properties. The code in the deployment package must be +// compatible with the target instruction set architecture of the function ( x86-64 +// or arm64 ). If you do not specify the architecture, then the default value is +// x86-64 . When you create a function, Lambda provisions an instance of the +// function and its supporting resources. If your function connects to a VPC, this +// process can take a minute or so. During this time, you can't invoke or modify +// the function. The State , StateReason , and StateReasonCode fields in the +// response from GetFunctionConfiguration indicate when the function is ready to +// invoke. For more information, see Lambda function states (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html) +// . A function has an unpublished version, and can have published versions and +// aliases. The unpublished version changes when you update your function's code +// and configuration. A published version is a snapshot of your function code and // configuration that can't be changed. An alias is a named resource that maps to a // version, and can be changed to map to a different version. Use the Publish // parameter to create version 1 of your function from its initial configuration. // The other parameters let you configure version-specific and function-level // settings. You can modify version-specific settings later with -// UpdateFunctionConfiguration. Function-level settings apply to both the -// unpublished and published versions of the function, and include tags -// (TagResource) and per-function concurrency limits (PutFunctionConcurrency). You -// can use code signing if your deployment package is a .zip file archive. To +// UpdateFunctionConfiguration . Function-level settings apply to both the +// unpublished and published versions of the function, and include tags ( +// TagResource ) and per-function concurrency limits ( PutFunctionConcurrency ). +// You can use code signing if your deployment package is a .zip file archive. To // enable code signing for this function, specify the ARN of a code-signing // configuration. When a user attempts to deploy a code package with -// UpdateFunctionCode, Lambda checks that the code package has a valid signature +// UpdateFunctionCode , Lambda checks that the code package has a valid signature // from a trusted publisher. The code-signing configuration includes set of signing // profiles, which define the trusted publishers for this function. If another // Amazon Web Services account or an Amazon Web Service invokes your function, use // AddPermission to grant permission by creating a resource-based Identity and // Access Management (IAM) policy. You can grant permissions at the function level, -// on a version, or on an alias. To invoke your function directly, use Invoke. To +// on a version, or on an alias. To invoke your function directly, use Invoke . To // invoke your function in response to events in other Amazon Web Services, create -// an event source mapping (CreateEventSourceMapping), or configure a function +// an event source mapping ( CreateEventSourceMapping ), or configure a function // trigger in the other service. For more information, see Invoking Lambda -// functions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html). +// functions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html) . func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error) { if params == nil { params = &CreateFunctionInput{} @@ -85,18 +80,11 @@ type CreateFunctionInput struct { Code *types.FunctionCode // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -108,7 +96,7 @@ type CreateFunctionInput struct { // The instruction set architecture that the function supports. Enter a string // array with one of the valid values (arm64 or x86_64). The default value is - // x86_64. + // x86_64 . Architectures []types.Architecture // To enable code signing for this function, specify the ARN of a code-signing @@ -116,10 +104,10 @@ type CreateFunctionInput struct { // which define the trusted publishers for this function. CodeSigningConfigArn *string - // A dead-letter queue configuration that specifies the queue or topic where Lambda - // sends asynchronous events when they fail processing. For more information, see - // Dead-letter queues - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). + // A dead-letter queue configuration that specifies the queue or topic where + // Lambda sends asynchronous events when they fail processing. For more + // information, see Dead-letter queues (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) + // . DeadLetterConfig *types.DeadLetterConfig // A description of the function. @@ -138,32 +126,27 @@ type CreateFunctionInput struct { // The name of the method within your code that Lambda calls to run your function. // Handler is required if the deployment package is a .zip file archive. The format // includes the file name. It can also include namespaces and other qualifiers, - // depending on the runtime. For more information, see Lambda programming model - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html). + // depending on the runtime. For more information, see Lambda programming model (https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html) + // . Handler *string - // Container image configuration values - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) + // Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) // that override the values in the container image Dockerfile. ImageConfig *types.ImageConfig // The ARN of the Key Management Service (KMS) customer managed key that's used to - // encrypt your function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt your function's snapshot. If you + // encrypt your function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt your function's snapshot. If you // don't provide a customer managed key, Lambda uses a default service key. KMSKeyArn *string - // A list of function layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add - // to the function's execution environment. Specify each layer by its ARN, + // A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // to add to the function's execution environment. Specify each layer by its ARN, // including the version. Layers []string - // The amount of memory available to the function - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) + // The amount of memory available to the function (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) // at runtime. Increasing the function memory also increases its CPU allocation. // The default value is 128 MB. The value can be any multiple of 1 MB. MemorySize *int32 @@ -175,16 +158,15 @@ type CreateFunctionInput struct { // Set to true to publish the first version of the function during creation. Publish bool - // The identifier of the function's runtime - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is - // required if the deployment package is a .zip file archive. The following list - // includes deprecated runtimes. For more information, see Runtime deprecation - // policy - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy). + // The identifier of the function's runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) + // . Runtime is required if the deployment package is a .zip file archive. The + // following list includes deprecated runtimes. For more information, see Runtime + // deprecation policy (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy) + // . Runtime types.Runtime - // The function's SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. + // The function's SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // setting. SnapStart *types.SnapStart // A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to @@ -193,19 +175,19 @@ type CreateFunctionInput struct { // The amount of time (in seconds) that Lambda allows a function to run before // stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. - // For more information, see Lambda execution environment - // (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). + // For more information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) + // . Timeout *int32 - // Set Mode to Active to sample and trace a subset of incoming requests with X-Ray - // (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). + // Set Mode to Active to sample and trace a subset of incoming requests with X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) + // . TracingConfig *types.TracingConfig // For network connectivity to Amazon Web Services resources in a VPC, specify a // list of security groups and subnets in the VPC. When you connect a function to a // VPC, it can access resources and the internet only through that VPC. For more - // information, see Configuring a Lambda function to access resources in a VPC - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + // information, see Configuring a Lambda function to access resources in a VPC (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -216,7 +198,7 @@ type CreateFunctionOutput struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []types.Architecture // The SHA256 hash of the function's deployment package. @@ -231,17 +213,16 @@ type CreateFunctionOutput struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *types.EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *types.EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []types.FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -256,16 +237,14 @@ type CreateFunctionOutput struct { // The function's image configuration values. ImageConfigResponse *types.ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -278,8 +257,8 @@ type CreateFunctionOutput struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []types.Layer // For Lambda@Edge functions, the ARN of the main function. @@ -288,8 +267,8 @@ type CreateFunctionOutput struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType types.PackageType // The latest updated revision of the function or alias. @@ -312,19 +291,19 @@ type CreateFunctionOutput struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *types.SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State types.State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode types.StateReasonCode // The amount of time in seconds that Lambda allows a function to run before diff --git a/service/lambda/api_op_CreateFunctionUrlConfig.go b/service/lambda/api_op_CreateFunctionUrlConfig.go index 952f97b5e7c..cb567872aa5 100644 --- a/service/lambda/api_op_CreateFunctionUrlConfig.go +++ b/service/lambda/api_op_CreateFunctionUrlConfig.go @@ -34,46 +34,35 @@ type CreateFunctionUrlConfigInput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . // // This member is required. AuthType types.FunctionUrlAuthType // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *types.Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode types.InvokeMode // The alias name. @@ -87,14 +76,14 @@ type CreateFunctionUrlConfigOutput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . // // This member is required. AuthType types.FunctionUrlAuthType - // When the function URL was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. CreationTime *string @@ -109,23 +98,19 @@ type CreateFunctionUrlConfigOutput struct { // This member is required. FunctionUrl *string - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *types.Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode types.InvokeMode // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_DeleteAlias.go b/service/lambda/api_op_DeleteAlias.go index f5acb77be31..524a041033f 100644 --- a/service/lambda/api_op_DeleteAlias.go +++ b/service/lambda/api_op_DeleteAlias.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Deletes a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error) { if params == nil { params = &DeleteAliasInput{} @@ -30,18 +30,11 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteEventSourceMapping.go b/service/lambda/api_op_DeleteEventSourceMapping.go index 06082ad5cf7..1f6b7ac8046 100644 --- a/service/lambda/api_op_DeleteEventSourceMapping.go +++ b/service/lambda/api_op_DeleteEventSourceMapping.go @@ -12,11 +12,10 @@ import ( "time" ) -// Deletes an event source mapping -// (https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html). You -// can get the identifier of a mapping from the output of ListEventSourceMappings. -// When you delete an event source mapping, it enters a Deleting state and might -// not be completely deleted for several seconds. +// Deletes an event source mapping (https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html) +// . You can get the identifier of a mapping from the output of +// ListEventSourceMappings . When you delete an event source mapping, it enters a +// Deleting state and might not be completely deleted for several seconds. func (c *Client) DeleteEventSourceMapping(ctx context.Context, params *DeleteEventSourceMappingInput, optFns ...func(*Options)) (*DeleteEventSourceMappingOutput, error) { if params == nil { params = &DeleteEventSourceMappingInput{} @@ -43,11 +42,11 @@ type DeleteEventSourceMappingInput struct { } // A mapping between an Amazon Web Services resource and a Lambda function. For -// details, see CreateEventSourceMapping. +// details, see CreateEventSourceMapping . type DeleteEventSourceMappingOutput struct { - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *types.AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream @@ -74,8 +73,8 @@ type DeleteEventSourceMappingOutput struct { EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -125,8 +124,8 @@ type DeleteEventSourceMappingOutput struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // The self-managed Apache Kafka cluster for your event source. @@ -144,11 +143,11 @@ type DeleteEventSourceMappingOutput struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition types.EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + // The state of the event source mapping. It can be one of the following: Creating + // , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting . State *string // Indicates whether a user or Lambda made the last change to the event source diff --git a/service/lambda/api_op_DeleteFunction.go b/service/lambda/api_op_DeleteFunction.go index a42182c3dd2..a97ae484795 100644 --- a/service/lambda/api_op_DeleteFunction.go +++ b/service/lambda/api_op_DeleteFunction.go @@ -13,8 +13,8 @@ import ( // Deletes a Lambda function. To delete a specific function version, use the // Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete // Lambda event source mappings that invoke a function, use -// DeleteEventSourceMapping. For Amazon Web Services and resources that invoke your -// function directly, delete the trigger in the service where you originally +// DeleteEventSourceMapping . For Amazon Web Services and resources that invoke +// your function directly, delete the trigger in the service where you originally // configured it. func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error) { if params == nil { @@ -34,19 +34,12 @@ func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput type DeleteFunctionInput struct { // The name of the Lambda function or version. Name formats - // - // * Function name – - // my-function (name-only), my-function:1 (with version). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:1 (with version). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go b/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go index 193d74e998f..092c620f98a 100644 --- a/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go @@ -29,18 +29,11 @@ func (c *Client) DeleteFunctionCodeSigningConfig(ctx context.Context, params *De type DeleteFunctionCodeSigningConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteFunctionConcurrency.go b/service/lambda/api_op_DeleteFunctionConcurrency.go index 439850ca23b..d8b26cff621 100644 --- a/service/lambda/api_op_DeleteFunctionConcurrency.go +++ b/service/lambda/api_op_DeleteFunctionConcurrency.go @@ -29,18 +29,11 @@ func (c *Client) DeleteFunctionConcurrency(ctx context.Context, params *DeleteFu type DeleteFunctionConcurrencyInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go index 76cd8bf8f8c..b249fb602c5 100644 --- a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go @@ -12,7 +12,7 @@ import ( // Deletes the configuration for asynchronous invocation for a function, version, // or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig. +// PutFunctionEventInvokeConfig . func (c *Client) DeleteFunctionEventInvokeConfig(ctx context.Context, params *DeleteFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*DeleteFunctionEventInvokeConfigOutput, error) { if params == nil { params = &DeleteFunctionEventInvokeConfigInput{} @@ -31,19 +31,12 @@ func (c *Client) DeleteFunctionEventInvokeConfig(ctx context.Context, params *De type DeleteFunctionEventInvokeConfigInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name - my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN - - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name - my-function (name-only), my-function:v1 (with alias). + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN - 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteFunctionUrlConfig.go b/service/lambda/api_op_DeleteFunctionUrlConfig.go index 348f7b66830..40d7d2adffb 100644 --- a/service/lambda/api_op_DeleteFunctionUrlConfig.go +++ b/service/lambda/api_op_DeleteFunctionUrlConfig.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Lambda function URL. When you delete a function URL, you can't recover -// it. Creating a new function URL results in a different URL address. +// Deletes a Lambda function URL. When you delete a function URL, you can't +// recover it. Creating a new function URL results in a different URL address. func (c *Client) DeleteFunctionUrlConfig(ctx context.Context, params *DeleteFunctionUrlConfigInput, optFns ...func(*Options)) (*DeleteFunctionUrlConfigOutput, error) { if params == nil { params = &DeleteFunctionUrlConfigInput{} @@ -30,18 +30,11 @@ func (c *Client) DeleteFunctionUrlConfig(ctx context.Context, params *DeleteFunc type DeleteFunctionUrlConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_DeleteLayerVersion.go b/service/lambda/api_op_DeleteLayerVersion.go index 181c42a298c..1174d6fb8ce 100644 --- a/service/lambda/api_op_DeleteLayerVersion.go +++ b/service/lambda/api_op_DeleteLayerVersion.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). -// Deleted versions can no longer be viewed or added to functions. To avoid +// Deletes a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . Deleted versions can no longer be viewed or added to functions. To avoid // breaking functions, a copy of the version remains in Lambda until no functions // refer to it. func (c *Client) DeleteLayerVersion(ctx context.Context, params *DeleteLayerVersionInput, optFns ...func(*Options)) (*DeleteLayerVersionOutput, error) { diff --git a/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go b/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go index 2d65e9aa906..ff22d59708b 100644 --- a/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go @@ -29,18 +29,11 @@ func (c *Client) DeleteProvisionedConcurrencyConfig(ctx context.Context, params type DeleteProvisionedConcurrencyConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_GetAccountSettings.go b/service/lambda/api_op_GetAccountSettings.go index e01b0e3b805..38f662b7518 100644 --- a/service/lambda/api_op_GetAccountSettings.go +++ b/service/lambda/api_op_GetAccountSettings.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details about your account's limits -// (https://docs.aws.amazon.com/lambda/latest/dg/limits.html) and usage in an -// Amazon Web Services Region. +// Retrieves details about your account's limits (https://docs.aws.amazon.com/lambda/latest/dg/limits.html) +// and usage in an Amazon Web Services Region. func (c *Client) GetAccountSettings(ctx context.Context, params *GetAccountSettingsInput, optFns ...func(*Options)) (*GetAccountSettingsOutput, error) { if params == nil { params = &GetAccountSettingsInput{} diff --git a/service/lambda/api_op_GetAlias.go b/service/lambda/api_op_GetAlias.go index 87dedefc156..9f9ce7c557f 100644 --- a/service/lambda/api_op_GetAlias.go +++ b/service/lambda/api_op_GetAlias.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns details about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Returns details about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . func (c *Client) GetAlias(ctx context.Context, params *GetAliasInput, optFns ...func(*Options)) (*GetAliasOutput, error) { if params == nil { params = &GetAliasInput{} @@ -31,18 +31,11 @@ func (c *Client) GetAlias(ctx context.Context, params *GetAliasInput, optFns ... type GetAliasInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -55,8 +48,8 @@ type GetAliasInput struct { noSmithyDocumentSerde } -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Provides configuration information about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . type GetAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -74,8 +67,7 @@ type GetAliasOutput struct { // A unique identifier that changes when you update the alias. RevisionId *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) // of the alias. RoutingConfig *types.AliasRoutingConfiguration diff --git a/service/lambda/api_op_GetEventSourceMapping.go b/service/lambda/api_op_GetEventSourceMapping.go index b142f8543ac..5d34289de79 100644 --- a/service/lambda/api_op_GetEventSourceMapping.go +++ b/service/lambda/api_op_GetEventSourceMapping.go @@ -13,7 +13,7 @@ import ( ) // Returns details about an event source mapping. You can get the identifier of a -// mapping from the output of ListEventSourceMappings. +// mapping from the output of ListEventSourceMappings . func (c *Client) GetEventSourceMapping(ctx context.Context, params *GetEventSourceMappingInput, optFns ...func(*Options)) (*GetEventSourceMappingOutput, error) { if params == nil { params = &GetEventSourceMappingInput{} @@ -40,11 +40,11 @@ type GetEventSourceMappingInput struct { } // A mapping between an Amazon Web Services resource and a Lambda function. For -// details, see CreateEventSourceMapping. +// details, see CreateEventSourceMapping . type GetEventSourceMappingOutput struct { - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *types.AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream @@ -71,8 +71,8 @@ type GetEventSourceMappingOutput struct { EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -122,8 +122,8 @@ type GetEventSourceMappingOutput struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // The self-managed Apache Kafka cluster for your event source. @@ -141,11 +141,11 @@ type GetEventSourceMappingOutput struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition types.EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + // The state of the event source mapping. It can be one of the following: Creating + // , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting . State *string // Indicates whether a user or Lambda made the last change to the event source diff --git a/service/lambda/api_op_GetFunction.go b/service/lambda/api_op_GetFunction.go index b3eb77aa450..72d8ea2c20a 100644 --- a/service/lambda/api_op_GetFunction.go +++ b/service/lambda/api_op_GetFunction.go @@ -38,19 +38,12 @@ func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optF type GetFunctionInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -67,14 +60,14 @@ type GetFunctionOutput struct { // The deployment package of the function or version. Code *types.FunctionCodeLocation - // The function's reserved concurrency - // (https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html). + // The function's reserved concurrency (https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) + // . Concurrency *types.Concurrency // The configuration of the function or version. Configuration *types.FunctionConfiguration - // The function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html). + // The function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. @@ -166,9 +159,9 @@ type FunctionActiveV2WaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FunctionActiveV2Waiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FunctionActiveV2Waiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -360,9 +353,9 @@ type FunctionExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FunctionExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FunctionExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -514,9 +507,9 @@ type FunctionUpdatedV2WaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FunctionUpdatedV2Waiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FunctionUpdatedV2Waiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -564,10 +557,10 @@ func (w *FunctionUpdatedV2Waiter) Wait(ctx context.Context, params *GetFunctionI return err } -// WaitForOutput calls the waiter function for FunctionUpdatedV2 waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for FunctionUpdatedV2 waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *FunctionUpdatedV2Waiter) WaitForOutput(ctx context.Context, params *GetFunctionInput, maxWaitDur time.Duration, optFns ...func(*FunctionUpdatedV2WaiterOptions)) (*GetFunctionOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/lambda/api_op_GetFunctionCodeSigningConfig.go b/service/lambda/api_op_GetFunctionCodeSigningConfig.go index 3c22f88864c..82dd09167cb 100644 --- a/service/lambda/api_op_GetFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_GetFunctionCodeSigningConfig.go @@ -29,18 +29,11 @@ func (c *Client) GetFunctionCodeSigningConfig(ctx context.Context, params *GetFu type GetFunctionCodeSigningConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -56,18 +49,11 @@ type GetFunctionCodeSigningConfigOutput struct { CodeSigningConfigArn *string // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_GetFunctionConcurrency.go b/service/lambda/api_op_GetFunctionConcurrency.go index 449630ebc75..1da66ef8d36 100644 --- a/service/lambda/api_op_GetFunctionConcurrency.go +++ b/service/lambda/api_op_GetFunctionConcurrency.go @@ -11,7 +11,7 @@ import ( ) // Returns details about the reserved concurrency configuration for a function. To -// set a concurrency limit for a function, use PutFunctionConcurrency. +// set a concurrency limit for a function, use PutFunctionConcurrency . func (c *Client) GetFunctionConcurrency(ctx context.Context, params *GetFunctionConcurrencyInput, optFns ...func(*Options)) (*GetFunctionConcurrencyOutput, error) { if params == nil { params = &GetFunctionConcurrencyInput{} @@ -30,18 +30,11 @@ func (c *Client) GetFunctionConcurrency(ctx context.Context, params *GetFunction type GetFunctionConcurrencyInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_GetFunctionConfiguration.go b/service/lambda/api_op_GetFunctionConfiguration.go index a209f5b13bb..534482d372a 100644 --- a/service/lambda/api_op_GetFunctionConfiguration.go +++ b/service/lambda/api_op_GetFunctionConfiguration.go @@ -18,8 +18,8 @@ import ( // Returns the version-specific settings of a Lambda function or version. The // output includes only options that can vary between versions of a function. To -// modify these settings, use UpdateFunctionConfiguration. To get all of a -// function's details, including function-level settings, use GetFunction. +// modify these settings, use UpdateFunctionConfiguration . To get all of a +// function's details, including function-level settings, use GetFunction . func (c *Client) GetFunctionConfiguration(ctx context.Context, params *GetFunctionConfigurationInput, optFns ...func(*Options)) (*GetFunctionConfigurationOutput, error) { if params == nil { params = &GetFunctionConfigurationInput{} @@ -38,19 +38,12 @@ func (c *Client) GetFunctionConfiguration(ctx context.Context, params *GetFuncti type GetFunctionConfigurationInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -67,7 +60,7 @@ type GetFunctionConfigurationOutput struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []types.Architecture // The SHA256 hash of the function's deployment package. @@ -82,17 +75,16 @@ type GetFunctionConfigurationOutput struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *types.EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *types.EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []types.FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -107,16 +99,14 @@ type GetFunctionConfigurationOutput struct { // The function's image configuration values. ImageConfigResponse *types.ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -129,8 +119,8 @@ type GetFunctionConfigurationOutput struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []types.Layer // For Lambda@Edge functions, the ARN of the main function. @@ -139,8 +129,8 @@ type GetFunctionConfigurationOutput struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType types.PackageType // The latest updated revision of the function or alias. @@ -163,19 +153,19 @@ type GetFunctionConfigurationOutput struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *types.SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State types.State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode types.StateReasonCode // The amount of time in seconds that Lambda allows a function to run before @@ -281,9 +271,9 @@ type FunctionActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FunctionActiveWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FunctionActiveWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -475,9 +465,9 @@ type FunctionUpdatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FunctionUpdatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FunctionUpdatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -517,9 +507,9 @@ func NewFunctionUpdatedWaiter(client GetFunctionConfigurationAPIClient, optFns . } } -// Wait calls the waiter function for FunctionUpdated waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for FunctionUpdated waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *FunctionUpdatedWaiter) Wait(ctx context.Context, params *GetFunctionConfigurationInput, maxWaitDur time.Duration, optFns ...func(*FunctionUpdatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -670,9 +660,10 @@ type PublishedVersionActiveWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, PublishedVersionActiveWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, PublishedVersionActiveWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -712,9 +703,9 @@ func NewPublishedVersionActiveWaiter(client GetFunctionConfigurationAPIClient, o } } -// Wait calls the waiter function for PublishedVersionActive waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for PublishedVersionActive waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *PublishedVersionActiveWaiter) Wait(ctx context.Context, params *GetFunctionConfigurationInput, maxWaitDur time.Duration, optFns ...func(*PublishedVersionActiveWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/lambda/api_op_GetFunctionEventInvokeConfig.go b/service/lambda/api_op_GetFunctionEventInvokeConfig.go index 350fa137af2..19a1efa8737 100644 --- a/service/lambda/api_op_GetFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_GetFunctionEventInvokeConfig.go @@ -12,9 +12,9 @@ import ( "time" ) -// Retrieves the configuration for asynchronous invocation for a function, version, -// or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig. +// Retrieves the configuration for asynchronous invocation for a function, +// version, or alias. To configure options for asynchronous invocation, use +// PutFunctionEventInvokeConfig . func (c *Client) GetFunctionEventInvokeConfig(ctx context.Context, params *GetFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*GetFunctionEventInvokeConfigOutput, error) { if params == nil { params = &GetFunctionEventInvokeConfigInput{} @@ -33,19 +33,12 @@ func (c *Client) GetFunctionEventInvokeConfig(ctx context.Context, params *GetFu type GetFunctionEventInvokeConfigInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name - my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN - - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name - my-function (name-only), my-function:v1 (with alias). + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN - 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -58,18 +51,12 @@ type GetFunctionEventInvokeConfigInput struct { type GetFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig // The Amazon Resource Name (ARN) of the function. diff --git a/service/lambda/api_op_GetFunctionUrlConfig.go b/service/lambda/api_op_GetFunctionUrlConfig.go index 5e826dcbc07..5c0753dbc9c 100644 --- a/service/lambda/api_op_GetFunctionUrlConfig.go +++ b/service/lambda/api_op_GetFunctionUrlConfig.go @@ -30,18 +30,11 @@ func (c *Client) GetFunctionUrlConfig(ctx context.Context, params *GetFunctionUr type GetFunctionUrlConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -57,14 +50,14 @@ type GetFunctionUrlConfigOutput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . // // This member is required. AuthType types.FunctionUrlAuthType - // When the function URL was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. CreationTime *string @@ -79,29 +72,25 @@ type GetFunctionUrlConfigOutput struct { // This member is required. FunctionUrl *string - // When the function URL configuration was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL configuration was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. LastModifiedTime *string - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *types.Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode types.InvokeMode // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_GetLayerVersion.go b/service/lambda/api_op_GetLayerVersion.go index 49f7e959882..7de4ab67684 100644 --- a/service/lambda/api_op_GetLayerVersion.go +++ b/service/lambda/api_op_GetLayerVersion.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a -// link to download the layer archive that's valid for 10 minutes. +// Returns information about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// , with a link to download the layer archive that's valid for 10 minutes. func (c *Client) GetLayerVersion(ctx context.Context, params *GetLayerVersionInput, optFns ...func(*Options)) (*GetLayerVersionOutput, error) { if params == nil { params = &GetLayerVersionInput{} @@ -46,8 +45,8 @@ type GetLayerVersionInput struct { type GetLayerVersionOutput struct { - // A list of compatible instruction set architectures - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // A list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitectures []types.Architecture // The layer's compatible runtimes. @@ -56,8 +55,8 @@ type GetLayerVersionOutput struct { // Details about the layer version. Content *types.LayerVersionContentOutput - // The date that the layer version was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_GetLayerVersionByArn.go b/service/lambda/api_op_GetLayerVersionByArn.go index 43529ce142b..59221a6b76a 100644 --- a/service/lambda/api_op_GetLayerVersionByArn.go +++ b/service/lambda/api_op_GetLayerVersionByArn.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html), with a -// link to download the layer archive that's valid for 10 minutes. +// Returns information about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// , with a link to download the layer archive that's valid for 10 minutes. func (c *Client) GetLayerVersionByArn(ctx context.Context, params *GetLayerVersionByArnInput, optFns ...func(*Options)) (*GetLayerVersionByArnOutput, error) { if params == nil { params = &GetLayerVersionByArnInput{} @@ -41,8 +40,8 @@ type GetLayerVersionByArnInput struct { type GetLayerVersionByArnOutput struct { - // A list of compatible instruction set architectures - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // A list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitectures []types.Architecture // The layer's compatible runtimes. @@ -51,8 +50,8 @@ type GetLayerVersionByArnOutput struct { // Details about the layer version. Content *types.LayerVersionContentOutput - // The date that the layer version was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_GetLayerVersionPolicy.go b/service/lambda/api_op_GetLayerVersionPolicy.go index e55025bc17b..b5bfb4ca431 100644 --- a/service/lambda/api_op_GetLayerVersionPolicy.go +++ b/service/lambda/api_op_GetLayerVersionPolicy.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the permission policy for a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). For -// more information, see AddLayerVersionPermission. +// Returns the permission policy for a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . For more information, see AddLayerVersionPermission . func (c *Client) GetLayerVersionPolicy(ctx context.Context, params *GetLayerVersionPolicyInput, optFns ...func(*Options)) (*GetLayerVersionPolicyOutput, error) { if params == nil { params = &GetLayerVersionPolicyInput{} diff --git a/service/lambda/api_op_GetPolicy.go b/service/lambda/api_op_GetPolicy.go index fc637d74ce3..bedc1dcf2b9 100644 --- a/service/lambda/api_op_GetPolicy.go +++ b/service/lambda/api_op_GetPolicy.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the resource-based IAM policy -// (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) +// Returns the resource-based IAM policy (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) // for a function, version, or alias. func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { @@ -31,19 +30,12 @@ func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns . type GetPolicyInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go index 1e61ae7f959..17870c35e41 100644 --- a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go @@ -31,18 +31,11 @@ func (c *Client) GetProvisionedConcurrencyConfig(ctx context.Context, params *Ge type GetProvisionedConcurrencyConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -65,8 +58,8 @@ type GetProvisionedConcurrencyConfigOutput struct { // The amount of provisioned concurrency available. AvailableProvisionedConcurrentExecutions *int32 - // The date and time that a user last updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html). + // The date and time that a user last updated the configuration, in ISO 8601 format (https://www.iso.org/iso-8601-date-and-time-format.html) + // . LastModified *string // The amount of provisioned concurrency requested. diff --git a/service/lambda/api_op_GetRuntimeManagementConfig.go b/service/lambda/api_op_GetRuntimeManagementConfig.go index 9798b744de3..ea789e5dec7 100644 --- a/service/lambda/api_op_GetRuntimeManagementConfig.go +++ b/service/lambda/api_op_GetRuntimeManagementConfig.go @@ -14,9 +14,9 @@ import ( // Retrieves the runtime management configuration for a function's version. If the // runtime update mode is Manual, this includes the ARN of the runtime version and // the runtime update mode. If the runtime update mode is Auto or Function update, -// this includes the runtime update mode and null is returned for the ARN. For more -// information, see Runtime updates -// (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). +// this includes the runtime update mode and null is returned for the ARN. For +// more information, see Runtime updates (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html) +// . func (c *Client) GetRuntimeManagementConfig(ctx context.Context, params *GetRuntimeManagementConfigInput, optFns ...func(*Options)) (*GetRuntimeManagementConfigOutput, error) { if params == nil { params = &GetRuntimeManagementConfigInput{} @@ -35,18 +35,11 @@ func (c *Client) GetRuntimeManagementConfig(ctx context.Context, params *GetRunt type GetRuntimeManagementConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_Invoke.go b/service/lambda/api_op_Invoke.go index 61324f977f9..e78e72bdaf1 100644 --- a/service/lambda/api_op_Invoke.go +++ b/service/lambda/api_op_Invoke.go @@ -11,46 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Invokes a Lambda function. You can invoke a function synchronously (and wait for -// the response), or asynchronously. To invoke a function asynchronously, set -// InvocationType to Event. For synchronous invocation -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html), details -// about the function response, including errors, are included in the response body -// and headers. For either invocation type, you can find more information in the -// execution log -// (https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html) and -// trace (https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html). When an -// error occurs, your function may be invoked multiple times. Retry behavior varies -// by error type, client, event source, and invocation type. For example, if you -// invoke a function asynchronously and it returns an error, Lambda executes the -// function up to two more times. For more information, see Error handling and -// automatic retries in Lambda -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html). For -// asynchronous invocation -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html), Lambda -// adds events to a queue before sending them to your function. If your function -// does not have enough capacity to keep up with the queue, events may be lost. -// Occasionally, your function may receive the same event multiple times, even if -// no error occurs. To retain events that were not processed, configure your -// function with a dead-letter queue -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). -// The status code in the API response doesn't reflect function errors. Error codes -// are reserved for errors that prevent your function from executing, such as -// permissions errors, quota -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) +// Invokes a Lambda function. You can invoke a function synchronously (and wait +// for the response), or asynchronously. To invoke a function asynchronously, set +// InvocationType to Event . For synchronous invocation (https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html) +// , details about the function response, including errors, are included in the +// response body and headers. For either invocation type, you can find more +// information in the execution log (https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html) +// and trace (https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html) . +// When an error occurs, your function may be invoked multiple times. Retry +// behavior varies by error type, client, event source, and invocation type. For +// example, if you invoke a function asynchronously and it returns an error, Lambda +// executes the function up to two more times. For more information, see Error +// handling and automatic retries in Lambda (https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html) +// . For asynchronous invocation (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) +// , Lambda adds events to a queue before sending them to your function. If your +// function does not have enough capacity to keep up with the queue, events may be +// lost. Occasionally, your function may receive the same event multiple times, +// even if no error occurs. To retain events that were not processed, configure +// your function with a dead-letter queue (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) +// . The status code in the API response doesn't reflect function errors. Error +// codes are reserved for errors that prevent your function from executing, such as +// permissions errors, quota (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) // errors, or issues with your function's code and configuration. For example, // Lambda returns TooManyRequestsException if running the function would cause you -// to exceed a concurrency limit at either the account level -// (ConcurrentInvocationLimitExceeded) or function level -// (ReservedFunctionConcurrentInvocationLimitExceeded). For functions with a long +// to exceed a concurrency limit at either the account level ( +// ConcurrentInvocationLimitExceeded ) or function level ( +// ReservedFunctionConcurrentInvocationLimitExceeded ). For functions with a long // timeout, your client might disconnect during synchronous invocation while it // waits for a response. Configure your HTTP client, SDK, firewall, proxy, or // operating system to allow for long connections with timeout or keep-alive -// settings. This operation requires permission for the lambda:InvokeFunction -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html) action. -// For details on how to set up permissions for cross-account invocations, see -// Granting function access to other accounts -// (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountinvoke). +// settings. This operation requires permission for the lambda:InvokeFunction (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html) +// action. For details on how to set up permissions for cross-account invocations, +// see Granting function access to other accounts (https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountinvoke) +// . func (c *Client) Invoke(ctx context.Context, params *InvokeInput, optFns ...func(*Options)) (*InvokeOutput, error) { if params == nil { params = &InvokeInput{} @@ -69,19 +62,12 @@ func (c *Client) Invoke(ctx context.Context, params *InvokeInput, optFns ...func type InvokeInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -91,18 +77,14 @@ type InvokeInput struct { ClientContext *string // Choose from the following options. - // - // * RequestResponse (default) – Invoke the - // function synchronously. Keep the connection open until the function returns a - // response or times out. The API response includes the function response and - // additional data. - // - // * Event – Invoke the function asynchronously. Send events that - // fail multiple times to the function's dead-letter queue (if one is configured). - // The API response only includes a status code. - // - // * DryRun – Validate parameter - // values and verify that the user or role has permission to invoke the function. + // - RequestResponse (default) – Invoke the function synchronously. Keep the + // connection open until the function returns a response or times out. The API + // response includes the function response and additional data. + // - Event – Invoke the function asynchronously. Send events that fail multiple + // times to the function's dead-letter queue (if one is configured). The API + // response only includes a status code. + // - DryRun – Validate parameter values and verify that the user or role has + // permission to invoke the function. InvocationType types.InvocationType // Set to Tail to include the execution log in the response. Applies to @@ -110,8 +92,8 @@ type InvokeInput struct { LogType types.LogType // The JSON that you want to provide to your Lambda function as input. You can - // enter the JSON directly. For example, --payload '{ "key": "value" }'. You can - // also specify a file path. For example, --payload file://payload.json. + // enter the JSON directly. For example, --payload '{ "key": "value" }' . You can + // also specify a file path. For example, --payload file://payload.json . Payload []byte // Specify a version or alias to invoke a published version of the function. diff --git a/service/lambda/api_op_InvokeAsync.go b/service/lambda/api_op_InvokeAsync.go index c700aa3ca28..163775138d7 100644 --- a/service/lambda/api_op_InvokeAsync.go +++ b/service/lambda/api_op_InvokeAsync.go @@ -11,7 +11,7 @@ import ( "io" ) -// For asynchronous function invocation, use Invoke. Invokes a function +// For asynchronous function invocation, use Invoke . Invokes a function // asynchronously. // // Deprecated: This operation has been deprecated. @@ -33,18 +33,11 @@ func (c *Client) InvokeAsync(ctx context.Context, params *InvokeAsyncInput, optF type InvokeAsyncInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -57,7 +50,7 @@ type InvokeAsyncInput struct { noSmithyDocumentSerde } -// A success response (202 Accepted) indicates that the request is queued for +// A success response ( 202 Accepted ) indicates that the request is queued for // invocation. type InvokeAsyncOutput struct { diff --git a/service/lambda/api_op_InvokeWithResponseStream.go b/service/lambda/api_op_InvokeWithResponseStream.go index e8c563c9f9c..26e9ca7c3c7 100644 --- a/service/lambda/api_op_InvokeWithResponseStream.go +++ b/service/lambda/api_op_InvokeWithResponseStream.go @@ -13,9 +13,9 @@ import ( "sync" ) -// Configure your Lambda functions to stream response payloads back to clients. For -// more information, see Configuring a Lambda function to stream responses -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html). +// Configure your Lambda functions to stream response payloads back to clients. +// For more information, see Configuring a Lambda function to stream responses (https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html) +// . func (c *Client) InvokeWithResponseStream(ctx context.Context, params *InvokeWithResponseStreamInput, optFns ...func(*Options)) (*InvokeWithResponseStreamOutput, error) { if params == nil { params = &InvokeWithResponseStreamInput{} @@ -34,18 +34,11 @@ func (c *Client) InvokeWithResponseStream(ctx context.Context, params *InvokeWit type InvokeWithResponseStreamInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -55,14 +48,11 @@ type InvokeWithResponseStreamInput struct { ClientContext *string // Use one of the following options: - // - // * RequestResponse (default) – Invoke the - // function synchronously. Keep the connection open until the function returns a - // response or times out. The API operation response includes the function response - // and additional data. - // - // * DryRun – Validate parameter values and verify that the - // IAM user or role has permission to invoke the function. + // - RequestResponse (default) – Invoke the function synchronously. Keep the + // connection open until the function returns a response or times out. The API + // operation response includes the function response and additional data. + // - DryRun – Validate parameter values and verify that the IAM user or role has + // permission to invoke the function. InvocationType types.ResponseStreamingInvocationType // Set to Tail to include the execution log in the response. Applies to @@ -70,8 +60,8 @@ type InvokeWithResponseStreamInput struct { LogType types.LogType // The JSON that you want to provide to your Lambda function as input. You can - // enter the JSON directly. For example, --payload '{ "key": "value" }'. You can - // also specify a file path. For example, --payload file://payload.json. + // enter the JSON directly. For example, --payload '{ "key": "value" }' . You can + // also specify a file path. For example, --payload file://payload.json . Payload []byte // The alias name. diff --git a/service/lambda/api_op_ListAliases.go b/service/lambda/api_op_ListAliases.go index be4726d6bf2..c7d2c55285f 100644 --- a/service/lambda/api_op_ListAliases.go +++ b/service/lambda/api_op_ListAliases.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of aliases -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) for a -// Lambda function. +// Returns a list of aliases (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// for a Lambda function. func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -33,18 +32,11 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF type ListAliasesInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_ListCodeSigningConfigs.go b/service/lambda/api_op_ListCodeSigningConfigs.go index ae39655d353..1ae0f9f658c 100644 --- a/service/lambda/api_op_ListCodeSigningConfigs.go +++ b/service/lambda/api_op_ListCodeSigningConfigs.go @@ -12,10 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of code signing configurations -// (https://docs.aws.amazon.com/lambda/latest/dg/configuring-codesigning.html). A -// request returns up to 10,000 configurations per call. You can use the MaxItems -// parameter to return fewer configurations per call. +// Returns a list of code signing configurations (https://docs.aws.amazon.com/lambda/latest/dg/configuring-codesigning.html) +// . A request returns up to 10,000 configurations per call. You can use the +// MaxItems parameter to return fewer configurations per call. func (c *Client) ListCodeSigningConfigs(ctx context.Context, params *ListCodeSigningConfigsInput, optFns ...func(*Options)) (*ListCodeSigningConfigsOutput, error) { if params == nil { params = &ListCodeSigningConfigsInput{} diff --git a/service/lambda/api_op_ListEventSourceMappings.go b/service/lambda/api_op_ListEventSourceMappings.go index 8ef09c9253a..e77764adc76 100644 --- a/service/lambda/api_op_ListEventSourceMappings.go +++ b/service/lambda/api_op_ListEventSourceMappings.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists event source mappings. Specify an EventSourceArn to show only event source -// mappings for a single event source. +// Lists event source mappings. Specify an EventSourceArn to show only event +// source mappings for a single event source. func (c *Client) ListEventSourceMappings(ctx context.Context, params *ListEventSourceMappingsInput, optFns ...func(*Options)) (*ListEventSourceMappingsOutput, error) { if params == nil { params = &ListEventSourceMappingsInput{} @@ -32,42 +32,22 @@ func (c *Client) ListEventSourceMappings(ctx context.Context, params *ListEventS type ListEventSourceMappingsInput struct { // The Amazon Resource Name (ARN) of the event source. - // - // * Amazon Kinesis – The ARN - // of the data stream or a stream consumer. - // - // * Amazon DynamoDB Streams – The ARN of - // the stream. - // - // * Amazon Simple Queue Service – The ARN of the queue. - // - // * Amazon - // Managed Streaming for Apache Kafka – The ARN of the cluster. - // - // * Amazon MQ – The - // ARN of the broker. - // - // * Amazon DocumentDB – The ARN of the DocumentDB change - // stream. + // - Amazon Kinesis – The ARN of the data stream or a stream consumer. + // - Amazon DynamoDB Streams – The ARN of the stream. + // - Amazon Simple Queue Service – The ARN of the queue. + // - Amazon Managed Streaming for Apache Kafka – The ARN of the cluster. + // - Amazon MQ – The ARN of the broker. + // - Amazon DocumentDB – The ARN of the DocumentDB change stream. EventSourceArn *string // The name of the Lambda function. Name formats - // - // * Function name – MyFunction. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Version or Alias ARN – - // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. - // - // * Partial ARN – - // 123456789012:function:MyFunction. - // - // The length constraint applies only to the - // full ARN. If you specify only the function name, it's limited to 64 characters - // in length. + // - Function name – MyFunction . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Version or Alias ARN – + // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD . + // - Partial ARN – 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it's limited to 64 characters in length. FunctionName *string // A pagination token returned by a previous call. diff --git a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go index a6815d2e188..b9d7eb6903a 100644 --- a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go +++ b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go @@ -14,7 +14,7 @@ import ( // Retrieves a list of configurations for asynchronous invocation for a function. // To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig. +// PutFunctionEventInvokeConfig . func (c *Client) ListFunctionEventInvokeConfigs(ctx context.Context, params *ListFunctionEventInvokeConfigsInput, optFns ...func(*Options)) (*ListFunctionEventInvokeConfigsOutput, error) { if params == nil { params = &ListFunctionEventInvokeConfigsInput{} @@ -33,18 +33,11 @@ func (c *Client) ListFunctionEventInvokeConfigs(ctx context.Context, params *Lis type ListFunctionEventInvokeConfigsInput struct { // The name of the Lambda function. Name formats - // - // * Function name - my-function. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN - 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - my-function . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN - 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_ListFunctionUrlConfigs.go b/service/lambda/api_op_ListFunctionUrlConfigs.go index 315501e7447..5f1c434bbf9 100644 --- a/service/lambda/api_op_ListFunctionUrlConfigs.go +++ b/service/lambda/api_op_ListFunctionUrlConfigs.go @@ -31,18 +31,11 @@ func (c *Client) ListFunctionUrlConfigs(ctx context.Context, params *ListFunctio type ListFunctionUrlConfigsInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_ListFunctions.go b/service/lambda/api_op_ListFunctions.go index 78527e8e19e..9c8e692e994 100644 --- a/service/lambda/api_op_ListFunctions.go +++ b/service/lambda/api_op_ListFunctions.go @@ -19,7 +19,7 @@ import ( // FunctionConfiguration fields. To get the additional fields (State, // StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, // LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use -// GetFunction. +// GetFunction . func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, optFns ...func(*Options)) (*ListFunctionsOutput, error) { if params == nil { params = &ListFunctionsInput{} @@ -47,7 +47,7 @@ type ListFunctionsInput struct { // For Lambda@Edge functions, the Amazon Web Services Region of the master // function. For example, us-east-1 filters the list of functions to include only // Lambda@Edge functions replicated from a master function in US East (N. - // Virginia). If specified, you must set FunctionVersion to ALL. + // Virginia). If specified, you must set FunctionVersion to ALL . MasterRegion *string // The maximum number of functions to return in the response. Note that diff --git a/service/lambda/api_op_ListLayerVersions.go b/service/lambda/api_op_ListLayerVersions.go index 0536fb5af59..45681f7bd11 100644 --- a/service/lambda/api_op_ListLayerVersions.go +++ b/service/lambda/api_op_ListLayerVersions.go @@ -12,13 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the versions of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). -// Versions that have been deleted aren't listed. Specify a runtime identifier -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only -// versions that indicate that they're compatible with that runtime. Specify a -// compatible architecture to include only layer versions that are compatible with -// that architecture. +// Lists the versions of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . Versions that have been deleted aren't listed. Specify a runtime identifier (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) +// to list only versions that indicate that they're compatible with that runtime. +// Specify a compatible architecture to include only layer versions that are +// compatible with that architecture. func (c *Client) ListLayerVersions(ctx context.Context, params *ListLayerVersionsInput, optFns ...func(*Options)) (*ListLayerVersionsOutput, error) { if params == nil { params = &ListLayerVersionsInput{} @@ -41,11 +39,11 @@ type ListLayerVersionsInput struct { // This member is required. LayerName *string - // The compatible instruction set architecture - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // The compatible instruction set architecture (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitecture types.Architecture - // A runtime identifier. For example, go1.x. + // A runtime identifier. For example, go1.x . CompatibleRuntime types.Runtime // A pagination token returned by a previous call. diff --git a/service/lambda/api_op_ListLayers.go b/service/lambda/api_op_ListLayers.go index b4c010c4c16..c3b584c5981 100644 --- a/service/lambda/api_op_ListLayers.go +++ b/service/lambda/api_op_ListLayers.go @@ -12,14 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists Lambda layers -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html) and shows -// information about the latest version of each. Specify a runtime identifier -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) to list only -// layers that indicate that they're compatible with that runtime. Specify a -// compatible architecture to include only layers that are compatible with that -// instruction set architecture -// (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). +// Lists Lambda layers (https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html) +// and shows information about the latest version of each. Specify a runtime +// identifier (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) +// to list only layers that indicate that they're compatible with that runtime. +// Specify a compatible architecture to include only layers that are compatible +// with that instruction set architecture (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) +// . func (c *Client) ListLayers(ctx context.Context, params *ListLayersInput, optFns ...func(*Options)) (*ListLayersOutput, error) { if params == nil { params = &ListLayersInput{} @@ -37,11 +36,11 @@ func (c *Client) ListLayers(ctx context.Context, params *ListLayersInput, optFns type ListLayersInput struct { - // The compatible instruction set architecture - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // The compatible instruction set architecture (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitecture types.Architecture - // A runtime identifier. For example, go1.x. + // A runtime identifier. For example, go1.x . CompatibleRuntime types.Runtime // A pagination token returned by a previous call. diff --git a/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go b/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go index 06460392dd9..0c8533bf7a3 100644 --- a/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go +++ b/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go @@ -31,18 +31,11 @@ func (c *Client) ListProvisionedConcurrencyConfigs(ctx context.Context, params * type ListProvisionedConcurrencyConfigsInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_ListTags.go b/service/lambda/api_op_ListTags.go index 7bfad35262f..46f9b094d1c 100644 --- a/service/lambda/api_op_ListTags.go +++ b/service/lambda/api_op_ListTags.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a function's tags -// (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html). You can also view -// tags with GetFunction. +// Returns a function's tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) +// . You can also view tags with GetFunction . func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} diff --git a/service/lambda/api_op_ListVersionsByFunction.go b/service/lambda/api_op_ListVersionsByFunction.go index 60e3726fb73..1205adea934 100644 --- a/service/lambda/api_op_ListVersionsByFunction.go +++ b/service/lambda/api_op_ListVersionsByFunction.go @@ -12,10 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of versions -// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html), with the -// version-specific configuration of each. Lambda returns up to 50 versions per -// call. +// Returns a list of versions (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) +// , with the version-specific configuration of each. Lambda returns up to 50 +// versions per call. func (c *Client) ListVersionsByFunction(ctx context.Context, params *ListVersionsByFunctionInput, optFns ...func(*Options)) (*ListVersionsByFunctionOutput, error) { if params == nil { params = &ListVersionsByFunctionInput{} @@ -34,18 +33,11 @@ func (c *Client) ListVersionsByFunction(ctx context.Context, params *ListVersion type ListVersionsByFunctionInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_PublishLayerVersion.go b/service/lambda/api_op_PublishLayerVersion.go index af3bcaf16a9..f87228065b6 100644 --- a/service/lambda/api_op_PublishLayerVersion.go +++ b/service/lambda/api_op_PublishLayerVersion.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a -// ZIP archive. Each time you call PublishLayerVersion with the same layer name, a -// new version is created. Add layers to your function with CreateFunction or -// UpdateFunctionConfiguration. +// Creates an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// from a ZIP archive. Each time you call PublishLayerVersion with the same layer +// name, a new version is created. Add layers to your function with CreateFunction +// or UpdateFunctionConfiguration . func (c *Client) PublishLayerVersion(ctx context.Context, params *PublishLayerVersionInput, optFns ...func(*Options)) (*PublishLayerVersionOutput, error) { if params == nil { params = &PublishLayerVersionInput{} @@ -43,28 +42,22 @@ type PublishLayerVersionInput struct { // This member is required. LayerName *string - // A list of compatible instruction set architectures - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // A list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitectures []types.Architecture - // A list of compatible function runtimes - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Used for - // filtering with ListLayers and ListLayerVersions. + // A list of compatible function runtimes (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) + // . Used for filtering with ListLayers and ListLayerVersions . CompatibleRuntimes []types.Runtime // The description of the version. Description *string // The layer's software license. It can be any of the following: - // - // * An SPDX license - // identifier (https://spdx.org/licenses/). For example, MIT. - // - // * The URL of a - // license hosted on the internet. For example, - // https://opensource.org/licenses/MIT. - // - // * The full text of the license. + // - An SPDX license identifier (https://spdx.org/licenses/) . For example, MIT . + // - The URL of a license hosted on the internet. For example, + // https://opensource.org/licenses/MIT . + // - The full text of the license. LicenseInfo *string noSmithyDocumentSerde @@ -72,8 +65,8 @@ type PublishLayerVersionInput struct { type PublishLayerVersionOutput struct { - // A list of compatible instruction set architectures - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // A list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitectures []types.Architecture // The layer's compatible runtimes. @@ -82,8 +75,8 @@ type PublishLayerVersionOutput struct { // Details about the layer version. Content *types.LayerVersionContentOutput - // The date that the layer version was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_PublishVersion.go b/service/lambda/api_op_PublishVersion.go index 1c5bcc41b3b..0a2718b35e6 100644 --- a/service/lambda/api_op_PublishVersion.go +++ b/service/lambda/api_op_PublishVersion.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a version -// (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) from the -// current code and configuration of a function. Use versions to create a snapshot -// of your function code and configuration that doesn't change. Lambda doesn't -// publish a version if the function's configuration and code haven't changed since -// the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to -// update the function before publishing a version. Clients can invoke versions -// directly or with an alias. To create an alias, use CreateAlias. +// Creates a version (https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) +// from the current code and configuration of a function. Use versions to create a +// snapshot of your function code and configuration that doesn't change. Lambda +// doesn't publish a version if the function's configuration and code haven't +// changed since the last version. Use UpdateFunctionCode or +// UpdateFunctionConfiguration to update the function before publishing a version. +// Clients can invoke versions directly or with an alias. To create an alias, use +// CreateAlias . func (c *Client) PublishVersion(ctx context.Context, params *PublishVersionInput, optFns ...func(*Options)) (*PublishVersionOutput, error) { if params == nil { params = &PublishVersionInput{} @@ -37,34 +37,27 @@ func (c *Client) PublishVersion(ctx context.Context, params *PublishVersionInput type PublishVersionInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string - // Only publish a version if the hash value matches the value that's specified. Use - // this option to avoid publishing a version if the function code has changed since - // you last updated it. You can get the hash for the version that you uploaded from - // the output of UpdateFunctionCode. + // Only publish a version if the hash value matches the value that's specified. + // Use this option to avoid publishing a version if the function code has changed + // since you last updated it. You can get the hash for the version that you + // uploaded from the output of UpdateFunctionCode . CodeSha256 *string // A description for the version to override the description in the function // configuration. Description *string - // Only update the function if the revision ID matches the ID that's specified. Use - // this option to avoid publishing a version if the function configuration has + // Only update the function if the revision ID matches the ID that's specified. + // Use this option to avoid publishing a version if the function configuration has // changed since you last updated it. RevisionId *string @@ -76,7 +69,7 @@ type PublishVersionOutput struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []types.Architecture // The SHA256 hash of the function's deployment package. @@ -91,17 +84,16 @@ type PublishVersionOutput struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *types.EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *types.EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []types.FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -116,16 +108,14 @@ type PublishVersionOutput struct { // The function's image configuration values. ImageConfigResponse *types.ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -138,8 +128,8 @@ type PublishVersionOutput struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []types.Layer // For Lambda@Edge functions, the ARN of the main function. @@ -148,8 +138,8 @@ type PublishVersionOutput struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType types.PackageType // The latest updated revision of the function or alias. @@ -172,19 +162,19 @@ type PublishVersionOutput struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *types.SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State types.State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode types.StateReasonCode // The amount of time in seconds that Lambda allows a function to run before diff --git a/service/lambda/api_op_PutFunctionCodeSigningConfig.go b/service/lambda/api_op_PutFunctionCodeSigningConfig.go index 8789ac7d487..6e12a050af7 100644 --- a/service/lambda/api_op_PutFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_PutFunctionCodeSigningConfig.go @@ -36,18 +36,11 @@ type PutFunctionCodeSigningConfigInput struct { CodeSigningConfigArn *string // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -63,18 +56,11 @@ type PutFunctionCodeSigningConfigOutput struct { CodeSigningConfigArn *string // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string diff --git a/service/lambda/api_op_PutFunctionConcurrency.go b/service/lambda/api_op_PutFunctionConcurrency.go index 554c0625598..8326e604860 100644 --- a/service/lambda/api_op_PutFunctionConcurrency.go +++ b/service/lambda/api_op_PutFunctionConcurrency.go @@ -19,8 +19,8 @@ import ( // Use GetAccountSettings to see your Regional concurrency limit. You can reserve // concurrency for as many functions as you like, as long as you leave at least 100 // simultaneous executions unreserved for functions that aren't configured with a -// per-function limit. For more information, see Lambda function scaling -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-scaling.html). +// per-function limit. For more information, see Lambda function scaling (https://docs.aws.amazon.com/lambda/latest/dg/invocation-scaling.html) +// . func (c *Client) PutFunctionConcurrency(ctx context.Context, params *PutFunctionConcurrencyInput, optFns ...func(*Options)) (*PutFunctionConcurrencyOutput, error) { if params == nil { params = &PutFunctionConcurrencyInput{} @@ -39,18 +39,11 @@ func (c *Client) PutFunctionConcurrency(ctx context.Context, params *PutFunction type PutFunctionConcurrencyInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -66,8 +59,8 @@ type PutFunctionConcurrencyInput struct { type PutFunctionConcurrencyOutput struct { // The number of concurrent executions that are reserved for this function. For - // more information, see Managing Lambda reserved concurrency - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html). + // more information, see Managing Lambda reserved concurrency (https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) + // . ReservedConcurrentExecutions *int32 // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_PutFunctionEventInvokeConfig.go b/service/lambda/api_op_PutFunctionEventInvokeConfig.go index 96a90071e4a..dce12162ef1 100644 --- a/service/lambda/api_op_PutFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_PutFunctionEventInvokeConfig.go @@ -12,22 +12,20 @@ import ( "time" ) -// Configures options for asynchronous invocation -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a -// function, version, or alias. If a configuration already exists for a function, -// version, or alias, this operation overwrites it. If you exclude any settings, -// they are removed. To set one option without affecting existing settings for -// other options, use UpdateFunctionEventInvokeConfig. By default, Lambda retries -// an asynchronous invocation twice if the function returns an error. It retains -// events in a queue for up to six hours. When an event fails all processing -// attempts or stays in the asynchronous invocation queue for too long, Lambda -// discards it. To retain discarded events, configure a dead-letter queue with -// UpdateFunctionConfiguration. To send an invocation record to a queue, topic, -// function, or event bus, specify a destination -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations). -// You can configure separate destinations for successful invocations (on-success) -// and events that fail all processing attempts (on-failure). You can configure -// destinations in addition to or instead of a dead-letter queue. +// Configures options for asynchronous invocation (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) +// on a function, version, or alias. If a configuration already exists for a +// function, version, or alias, this operation overwrites it. If you exclude any +// settings, they are removed. To set one option without affecting existing +// settings for other options, use UpdateFunctionEventInvokeConfig . By default, +// Lambda retries an asynchronous invocation twice if the function returns an +// error. It retains events in a queue for up to six hours. When an event fails all +// processing attempts or stays in the asynchronous invocation queue for too long, +// Lambda discards it. To retain discarded events, configure a dead-letter queue +// with UpdateFunctionConfiguration . To send an invocation record to a queue, +// topic, function, or event bus, specify a destination (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) +// . You can configure separate destinations for successful invocations +// (on-success) and events that fail all processing attempts (on-failure). You can +// configure destinations in addition to or instead of a dead-letter queue. func (c *Client) PutFunctionEventInvokeConfig(ctx context.Context, params *PutFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*PutFunctionEventInvokeConfigOutput, error) { if params == nil { params = &PutFunctionEventInvokeConfigInput{} @@ -46,35 +44,22 @@ func (c *Client) PutFunctionEventInvokeConfig(ctx context.Context, params *PutFu type PutFunctionEventInvokeConfigInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name - my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN - - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name - my-function (name-only), my-function:v1 (with alias). + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN - 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig // The maximum age of a request that Lambda sends to a function for processing. @@ -91,18 +76,12 @@ type PutFunctionEventInvokeConfigInput struct { type PutFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig // The Amazon Resource Name (ARN) of the function. diff --git a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go index 1abde23e02a..d37132a2f66 100644 --- a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go @@ -30,18 +30,11 @@ func (c *Client) PutProvisionedConcurrencyConfig(ctx context.Context, params *Pu type PutProvisionedConcurrencyConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -69,8 +62,8 @@ type PutProvisionedConcurrencyConfigOutput struct { // The amount of provisioned concurrency available. AvailableProvisionedConcurrentExecutions *int32 - // The date and time that a user last updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html). + // The date and time that a user last updated the configuration, in ISO 8601 format (https://www.iso.org/iso-8601-date-and-time-format.html) + // . LastModified *string // The amount of provisioned concurrency requested. diff --git a/service/lambda/api_op_PutRuntimeManagementConfig.go b/service/lambda/api_op_PutRuntimeManagementConfig.go index 58071b85305..b114298deb5 100644 --- a/service/lambda/api_op_PutRuntimeManagementConfig.go +++ b/service/lambda/api_op_PutRuntimeManagementConfig.go @@ -12,8 +12,8 @@ import ( ) // Sets the runtime management configuration for a function's version. For more -// information, see Runtime updates -// (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). +// information, see Runtime updates (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html) +// . func (c *Client) PutRuntimeManagementConfig(ctx context.Context, params *PutRuntimeManagementConfigInput, optFns ...func(*Options)) (*PutRuntimeManagementConfigOutput, error) { if params == nil { params = &PutRuntimeManagementConfigInput{} @@ -32,44 +32,32 @@ func (c *Client) PutRuntimeManagementConfig(ctx context.Context, params *PutRunt type PutRuntimeManagementConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string // Specify the runtime update mode. - // - // * Auto (default) - Automatically update to the - // most recent and secure runtime version using a Two-phase runtime version rollout - // (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). - // This is the best choice for most customers to ensure they always benefit from - // runtime updates. - // - // * Function update - Lambda updates the runtime of your - // function to the most recent and secure runtime version when you update your - // function. This approach synchronizes runtime updates with function deployments, - // giving you control over when runtime updates are applied and allowing you to - // detect and mitigate rare runtime update incompatibilities early. When using this - // setting, you need to regularly update your functions to keep their runtime - // up-to-date. - // - // * Manual - You specify a runtime version in your function - // configuration. The function will use this runtime version indefinitely. In the - // rare case where a new runtime version is incompatible with an existing function, - // this allows you to roll back your function to an earlier runtime version. For - // more information, see Roll back a runtime version - // (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). + // - Auto (default) - Automatically update to the most recent and secure runtime + // version using a Two-phase runtime version rollout (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase) + // . This is the best choice for most customers to ensure they always benefit from + // runtime updates. + // - Function update - Lambda updates the runtime of your function to the most + // recent and secure runtime version when you update your function. This approach + // synchronizes runtime updates with function deployments, giving you control over + // when runtime updates are applied and allowing you to detect and mitigate rare + // runtime update incompatibilities early. When using this setting, you need to + // regularly update your functions to keep their runtime up-to-date. + // - Manual - You specify a runtime version in your function configuration. The + // function will use this runtime version indefinitely. In the rare case where a + // new runtime version is incompatible with an existing function, this allows you + // to roll back your function to an earlier runtime version. For more information, + // see Roll back a runtime version (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback) + // . // // This member is required. UpdateRuntimeOn types.UpdateRuntimeOn diff --git a/service/lambda/api_op_RemoveLayerVersionPermission.go b/service/lambda/api_op_RemoveLayerVersionPermission.go index d9f213ff106..e267adcb86d 100644 --- a/service/lambda/api_op_RemoveLayerVersionPermission.go +++ b/service/lambda/api_op_RemoveLayerVersionPermission.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a statement from the permissions policy for a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). For -// more information, see AddLayerVersionPermission. +// Removes a statement from the permissions policy for a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . For more information, see AddLayerVersionPermission . func (c *Client) RemoveLayerVersionPermission(ctx context.Context, params *RemoveLayerVersionPermissionInput, optFns ...func(*Options)) (*RemoveLayerVersionPermissionOutput, error) { if params == nil { params = &RemoveLayerVersionPermissionInput{} diff --git a/service/lambda/api_op_RemovePermission.go b/service/lambda/api_op_RemovePermission.go index 5d3a20cc376..159b7f9413b 100644 --- a/service/lambda/api_op_RemovePermission.go +++ b/service/lambda/api_op_RemovePermission.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Revokes function-use permission from an Amazon Web Service or another Amazon Web -// Services account. You can get the ID of the statement from the output of -// GetPolicy. +// Revokes function-use permission from an Amazon Web Service or another Amazon +// Web Services account. You can get the ID of the statement from the output of +// GetPolicy . func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} @@ -31,19 +31,12 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI type RemovePermissionInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name – my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN – - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN – - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name – my-function (name-only), my-function:v1 (with alias). + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -53,8 +46,8 @@ type RemovePermissionInput struct { // This member is required. StatementId *string - // Specify a version or alias to remove permissions from a published version of the - // function. + // Specify a version or alias to remove permissions from a published version of + // the function. Qualifier *string // Update the policy only if the revision ID matches the ID that's specified. Use diff --git a/service/lambda/api_op_UpdateAlias.go b/service/lambda/api_op_UpdateAlias.go index 2be1f8f3dfd..18415f612a4 100644 --- a/service/lambda/api_op_UpdateAlias.go +++ b/service/lambda/api_op_UpdateAlias.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the configuration of a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Updates the configuration of a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optFns ...func(*Options)) (*UpdateAliasOutput, error) { if params == nil { params = &UpdateAliasInput{} @@ -31,18 +31,11 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF type UpdateAliasInput struct { // The name of the Lambda function. Name formats - // - // * Function name - MyFunction. - // - // * - // Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Partial ARN - 123456789012:function:MyFunction. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name - MyFunction . + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Partial ARN - 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -62,16 +55,15 @@ type UpdateAliasInput struct { // this option to avoid modifying an alias that has changed since you last read it. RevisionId *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing) // of the alias. RoutingConfig *types.AliasRoutingConfiguration noSmithyDocumentSerde } -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Provides configuration information about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . type UpdateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -89,8 +81,7 @@ type UpdateAliasOutput struct { // A unique identifier that changes when you update the alias. RevisionId *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) // of the alias. RoutingConfig *types.AliasRoutingConfiguration diff --git a/service/lambda/api_op_UpdateCodeSigningConfig.go b/service/lambda/api_op_UpdateCodeSigningConfig.go index e51052ba72a..fc4a74fb80d 100644 --- a/service/lambda/api_op_UpdateCodeSigningConfig.go +++ b/service/lambda/api_op_UpdateCodeSigningConfig.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the code signing configuration. Changes to the code signing configuration -// take effect the next time a user tries to deploy a code package to the function. +// Update the code signing configuration. Changes to the code signing +// configuration take effect the next time a user tries to deploy a code package to +// the function. func (c *Client) UpdateCodeSigningConfig(ctx context.Context, params *UpdateCodeSigningConfigInput, optFns ...func(*Options)) (*UpdateCodeSigningConfigOutput, error) { if params == nil { params = &UpdateCodeSigningConfigInput{} diff --git a/service/lambda/api_op_UpdateEventSourceMapping.go b/service/lambda/api_op_UpdateEventSourceMapping.go index bf2bc09eabc..916c9f11568 100644 --- a/service/lambda/api_op_UpdateEventSourceMapping.go +++ b/service/lambda/api_op_UpdateEventSourceMapping.go @@ -16,84 +16,38 @@ import ( // invokes, or pause invocation and resume later from the same location. For // details about how to configure different event sources, see the following // topics. +// - Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// - Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) +// - Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) +// - Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) +// - Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) +// - Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) +// - Amazon DocumentDB (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) // -// * Amazon DynamoDB Streams -// (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// The following error handling options are available only for stream sources +// (DynamoDB and Kinesis): +// - BisectBatchOnFunctionError – If the function returns an error, split the +// batch in two and retry. +// - DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon +// SNS topic. +// - MaximumRecordAgeInSeconds – Discard records older than the specified age. +// The default value is infinite (-1). When set to infinite (-1), failed records +// are retried until the record expires +// - MaximumRetryAttempts – Discard records after the specified number of +// retries. The default value is infinite (-1). When set to infinite (-1), failed +// records are retried until the record expires. +// - ParallelizationFactor – Process multiple batches from each shard +// concurrently. // -// * -// Amazon Kinesis -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) -// -// * -// Amazon SQS -// (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) -// -// * -// Amazon MQ and RabbitMQ -// (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) -// -// * -// Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) -// -// * -// Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) -// -// * -// Amazon DocumentDB -// (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) -// -// The -// following error handling options are available only for stream sources (DynamoDB -// and Kinesis): -// -// * BisectBatchOnFunctionError – If the function returns an error, -// split the batch in two and retry. -// -// * DestinationConfig – Send discarded records -// to an Amazon SQS queue or Amazon SNS topic. -// -// * MaximumRecordAgeInSeconds – -// Discard records older than the specified age. The default value is infinite -// (-1). When set to infinite (-1), failed records are retried until the record -// expires -// -// * MaximumRetryAttempts – Discard records after the specified number of -// retries. The default value is infinite (-1). When set to infinite (-1), failed -// records are retried until the record expires. -// -// * ParallelizationFactor – Process -// multiple batches from each shard concurrently. -// -// For information about which -// configuration parameters apply to each event source, see the following -// topics. -// -// * Amazon DynamoDB Streams -// (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) -// -// * -// Amazon Kinesis -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) -// -// * -// Amazon SQS -// (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) -// -// * -// Amazon MQ and RabbitMQ -// (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) -// -// * -// Amazon MSK -// (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) -// -// * -// Apache Kafka -// (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) -// -// * -// Amazon DocumentDB -// (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html#docdb-configuration) +// For information about which configuration parameters apply to each event +// source, see the following topics. +// - Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) +// - Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) +// - Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) +// - Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) +// - Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) +// - Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) +// - Amazon DocumentDB (https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html#docdb-configuration) func (c *Client) UpdateEventSourceMapping(ctx context.Context, params *UpdateEventSourceMappingInput, optFns ...func(*Options)) (*UpdateEventSourceMappingOutput, error) { if params == nil { params = &UpdateEventSourceMappingInput{} @@ -120,25 +74,14 @@ type UpdateEventSourceMappingInput struct { // or queue and sends to your function. Lambda passes all of the records in the // batch to the function in a single call, up to the payload limit for synchronous // invocation (6 MB). - // - // * Amazon Kinesis – Default 100. Max 10,000. - // - // * Amazon - // DynamoDB Streams – Default 100. Max 10,000. - // - // * Amazon Simple Queue Service – - // Default 10. For standard queues the max is 10,000. For FIFO queues the max is - // 10. - // - // * Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. - // - // * - // Self-managed Apache Kafka – Default 100. Max 10,000. - // - // * Amazon MQ (ActiveMQ and - // RabbitMQ) – Default 100. Max 10,000. - // - // * DocumentDB – Default 100. Max 10,000. + // - Amazon Kinesis – Default 100. Max 10,000. + // - Amazon DynamoDB Streams – Default 100. Max 10,000. + // - Amazon Simple Queue Service – Default 10. For standard queues the max is + // 10,000. For FIFO queues the max is 10. + // - Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. + // - Self-managed Apache Kafka – Default 100. Max 10,000. + // - Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. + // - DocumentDB – Default 100. Max 10,000. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -152,32 +95,23 @@ type UpdateEventSourceMappingInput struct { // Specific configuration settings for a DocumentDB event source. DocumentDBEventSourceConfig *types.DocumentDBEventSourceConfig - // When true, the event source mapping is active. When false, Lambda pauses polling - // and invocation. Default: True + // When true, the event source mapping is active. When false, Lambda pauses + // polling and invocation. Default: True Enabled *bool // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // The name of the Lambda function. Name formats - // - // * Function name – MyFunction. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction. - // - // * - // Version or Alias ARN – - // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. - // - // * Partial ARN – - // 123456789012:function:MyFunction. - // - // The length constraint applies only to the - // full ARN. If you specify only the function name, it's limited to 64 characters - // in length. + // - Function name – MyFunction . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction . + // - Version or Alias ARN – + // arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD . + // - Partial ARN – 123456789012:function:MyFunction . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it's limited to 64 characters in length. FunctionName *string // (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type @@ -212,8 +146,8 @@ type UpdateEventSourceMappingInput struct { ParallelizationFactor *int32 // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // An array of authentication protocols or VPC components required to secure your @@ -229,11 +163,11 @@ type UpdateEventSourceMappingInput struct { } // A mapping between an Amazon Web Services resource and a Lambda function. For -// details, see CreateEventSourceMapping. +// details, see CreateEventSourceMapping . type UpdateEventSourceMappingOutput struct { - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *types.AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream @@ -260,8 +194,8 @@ type UpdateEventSourceMappingOutput struct { EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -311,8 +245,8 @@ type UpdateEventSourceMappingOutput struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *types.ScalingConfig // The self-managed Apache Kafka cluster for your event source. @@ -330,11 +264,11 @@ type UpdateEventSourceMappingOutput struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition types.EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + // The state of the event source mapping. It can be one of the following: Creating + // , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting . State *string // Indicates whether a user or Lambda made the last change to the event source diff --git a/service/lambda/api_op_UpdateFunctionCode.go b/service/lambda/api_op_UpdateFunctionCode.go index 832763710ba..b515bcbcb65 100644 --- a/service/lambda/api_op_UpdateFunctionCode.go +++ b/service/lambda/api_op_UpdateFunctionCode.go @@ -13,18 +13,15 @@ import ( // Updates a Lambda function's code. If code signing is enabled for the function, // the code package must be signed by a trusted publisher. For more information, -// see Configuring code signing for Lambda -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). -// If the function's package type is Image, then you must specify the code package -// in ImageUri as the URI of a container image -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon -// ECR registry. If the function's package type is Zip, then you must specify the -// deployment package as a .zip file archive -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip). -// Enter the Amazon S3 bucket and key of the code .zip file location. You can also -// provide the function code inline using the ZipFile field. The code in the +// see Configuring code signing for Lambda (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) +// . If the function's package type is Image , then you must specify the code +// package in ImageUri as the URI of a container image (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) +// in the Amazon ECR registry. If the function's package type is Zip , then you +// must specify the deployment package as a .zip file archive (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip) +// . Enter the Amazon S3 bucket and key of the code .zip file location. You can +// also provide the function code inline using the ZipFile field. The code in the // deployment package must be compatible with the target instruction set -// architecture of the function (x86-64 or arm64). The function's code is locked +// architecture of the function ( x86-64 or arm64 ). The function's code is locked // when you publish a version. You can't modify the code of a published version, // only the unpublished version. For a function defined as a container image, // Lambda resolves the image tag to an image digest. In Amazon ECR, if you update @@ -47,25 +44,18 @@ func (c *Client) UpdateFunctionCode(ctx context.Context, params *UpdateFunctionC type UpdateFunctionCodeInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string // The instruction set architecture that the function supports. Enter a string // array with one of the valid values (arm64 or x86_64). The default value is - // x86_64. + // x86_64 . Architectures []types.Architecture // Set to true to validate the request parameters and access permissions without @@ -80,13 +70,13 @@ type UpdateFunctionCodeInput struct { // This has the same effect as calling PublishVersion separately. Publish bool - // Update the function only if the revision ID matches the ID that's specified. Use - // this option to avoid modifying a function that has changed since you last read - // it. + // Update the function only if the revision ID matches the ID that's specified. + // Use this option to avoid modifying a function that has changed since you last + // read it. RevisionId *string - // An Amazon S3 bucket in the same Amazon Web Services Region as your function. The - // bucket can be in a different Amazon Web Services account. Use only with a + // An Amazon S3 bucket in the same Amazon Web Services Region as your function. + // The bucket can be in a different Amazon Web Services account. Use only with a // function defined with a .zip file archive deployment package. S3Bucket *string @@ -110,7 +100,7 @@ type UpdateFunctionCodeOutput struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []types.Architecture // The SHA256 hash of the function's deployment package. @@ -125,17 +115,16 @@ type UpdateFunctionCodeOutput struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *types.EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *types.EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []types.FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -150,16 +139,14 @@ type UpdateFunctionCodeOutput struct { // The function's image configuration values. ImageConfigResponse *types.ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -172,8 +159,8 @@ type UpdateFunctionCodeOutput struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []types.Layer // For Lambda@Edge functions, the ARN of the main function. @@ -182,8 +169,8 @@ type UpdateFunctionCodeOutput struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType types.PackageType // The latest updated revision of the function or alias. @@ -206,19 +193,19 @@ type UpdateFunctionCodeOutput struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *types.SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State types.State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode types.StateReasonCode // The amount of time in seconds that Lambda allows a function to run before diff --git a/service/lambda/api_op_UpdateFunctionConfiguration.go b/service/lambda/api_op_UpdateFunctionConfiguration.go index bb6fb746c79..7e6408e359c 100644 --- a/service/lambda/api_op_UpdateFunctionConfiguration.go +++ b/service/lambda/api_op_UpdateFunctionConfiguration.go @@ -15,16 +15,15 @@ import ( // function, Lambda provisions an instance of the function and its supporting // resources. If your function connects to a VPC, this process can take a minute. // During this time, you can't modify the function, but you can still invoke it. -// The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode -// fields in the response from GetFunctionConfiguration indicate when the update is -// complete and the function is processing events with the new configuration. For -// more information, see Lambda function states -// (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html). These -// settings can vary between versions of a function and are locked when you publish -// a version. You can't modify the configuration of a published version, only the -// unpublished version. To configure function concurrency, use -// PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services -// account or Amazon Web Service, use AddPermission. +// The LastUpdateStatus , LastUpdateStatusReason , and LastUpdateStatusReasonCode +// fields in the response from GetFunctionConfiguration indicate when the update +// is complete and the function is processing events with the new configuration. +// For more information, see Lambda function states (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html) +// . These settings can vary between versions of a function and are locked when you +// publish a version. You can't modify the configuration of a published version, +// only the unpublished version. To configure function concurrency, use +// PutFunctionConcurrency . To grant invoke permissions to an Amazon Web Services +// account or Amazon Web Service, use AddPermission . func (c *Client) UpdateFunctionConfiguration(ctx context.Context, params *UpdateFunctionConfigurationInput, optFns ...func(*Options)) (*UpdateFunctionConfigurationOutput, error) { if params == nil { params = &UpdateFunctionConfigurationInput{} @@ -43,26 +42,19 @@ func (c *Client) UpdateFunctionConfiguration(ctx context.Context, params *Update type UpdateFunctionConfigurationInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string - // A dead-letter queue configuration that specifies the queue or topic where Lambda - // sends asynchronous events when they fail processing. For more information, see - // Dead-letter queues - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). + // A dead-letter queue configuration that specifies the queue or topic where + // Lambda sends asynchronous events when they fail processing. For more + // information, see Dead-letter queues (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) + // . DeadLetterConfig *types.DeadLetterConfig // A description of the function. @@ -81,71 +73,65 @@ type UpdateFunctionConfigurationInput struct { // The name of the method within your code that Lambda calls to run your function. // Handler is required if the deployment package is a .zip file archive. The format // includes the file name. It can also include namespaces and other qualifiers, - // depending on the runtime. For more information, see Lambda programming model - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html). + // depending on the runtime. For more information, see Lambda programming model (https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html) + // . Handler *string - // Container image configuration values - // (https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html) that override - // the values in the container image Docker file. + // Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html) + // that override the values in the container image Docker file. ImageConfig *types.ImageConfig // The ARN of the Key Management Service (KMS) customer managed key that's used to - // encrypt your function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt your function's snapshot. If you + // encrypt your function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt your function's snapshot. If you // don't provide a customer managed key, Lambda uses a default service key. KMSKeyArn *string - // A list of function layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add - // to the function's execution environment. Specify each layer by its ARN, + // A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // to add to the function's execution environment. Specify each layer by its ARN, // including the version. Layers []string - // The amount of memory available to the function - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) + // The amount of memory available to the function (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) // at runtime. Increasing the function memory also increases its CPU allocation. // The default value is 128 MB. The value can be any multiple of 1 MB. MemorySize *int32 - // Update the function only if the revision ID matches the ID that's specified. Use - // this option to avoid modifying a function that has changed since you last read - // it. + // Update the function only if the revision ID matches the ID that's specified. + // Use this option to avoid modifying a function that has changed since you last + // read it. RevisionId *string // The Amazon Resource Name (ARN) of the function's execution role. Role *string - // The identifier of the function's runtime - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is - // required if the deployment package is a .zip file archive. The following list - // includes deprecated runtimes. For more information, see Runtime deprecation - // policy - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy). + // The identifier of the function's runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) + // . Runtime is required if the deployment package is a .zip file archive. The + // following list includes deprecated runtimes. For more information, see Runtime + // deprecation policy (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy) + // . Runtime types.Runtime - // The function's SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. + // The function's SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // setting. SnapStart *types.SnapStart // The amount of time (in seconds) that Lambda allows a function to run before // stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. - // For more information, see Lambda execution environment - // (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). + // For more information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) + // . Timeout *int32 - // Set Mode to Active to sample and trace a subset of incoming requests with X-Ray - // (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). + // Set Mode to Active to sample and trace a subset of incoming requests with X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) + // . TracingConfig *types.TracingConfig // For network connectivity to Amazon Web Services resources in a VPC, specify a // list of security groups and subnets in the VPC. When you connect a function to a // VPC, it can access resources and the internet only through that VPC. For more - // information, see Configuring a Lambda function to access resources in a VPC - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). + // information, see Configuring a Lambda function to access resources in a VPC (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -156,7 +142,7 @@ type UpdateFunctionConfigurationOutput struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []types.Architecture // The SHA256 hash of the function's deployment package. @@ -171,17 +157,16 @@ type UpdateFunctionConfigurationOutput struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *types.EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *types.EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []types.FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -196,16 +181,14 @@ type UpdateFunctionConfigurationOutput struct { // The function's image configuration values. ImageConfigResponse *types.ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -218,8 +201,8 @@ type UpdateFunctionConfigurationOutput struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode types.LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []types.Layer // For Lambda@Edge functions, the ARN of the main function. @@ -228,8 +211,8 @@ type UpdateFunctionConfigurationOutput struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType types.PackageType // The latest updated revision of the function or alias. @@ -252,19 +235,19 @@ type UpdateFunctionConfigurationOutput struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *types.SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State types.State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode types.StateReasonCode // The amount of time in seconds that Lambda allows a function to run before diff --git a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go index 264dc864ea6..851aee9c0f9 100644 --- a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go @@ -14,7 +14,7 @@ import ( // Updates the configuration for asynchronous invocation for a function, version, // or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig. +// PutFunctionEventInvokeConfig . func (c *Client) UpdateFunctionEventInvokeConfig(ctx context.Context, params *UpdateFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*UpdateFunctionEventInvokeConfigOutput, error) { if params == nil { params = &UpdateFunctionEventInvokeConfigInput{} @@ -33,35 +33,22 @@ func (c *Client) UpdateFunctionEventInvokeConfig(ctx context.Context, params *Up type UpdateFunctionEventInvokeConfigInput struct { // The name of the Lambda function, version, or alias. Name formats - // - // * Function - // name - my-function (name-only), my-function:v1 (with alias). - // - // * Function ARN - - // arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * Partial ARN - - // 123456789012:function:my-function. - // - // You can append a version number or alias to - // any of the formats. The length constraint applies only to the full ARN. If you - // specify only the function name, it is limited to 64 characters in length. + // - Function name - my-function (name-only), my-function:v1 (with alias). + // - Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN - 123456789012:function:my-function . + // You can append a version number or alias to any of the formats. The length + // constraint applies only to the full ARN. If you specify only the function name, + // it is limited to 64 characters in length. // // This member is required. FunctionName *string - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig // The maximum age of a request that Lambda sends to a function for processing. @@ -78,18 +65,12 @@ type UpdateFunctionEventInvokeConfigInput struct { type UpdateFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *types.DestinationConfig // The Amazon Resource Name (ARN) of the function. diff --git a/service/lambda/api_op_UpdateFunctionUrlConfig.go b/service/lambda/api_op_UpdateFunctionUrlConfig.go index 6daf6487d18..56aada379f8 100644 --- a/service/lambda/api_op_UpdateFunctionUrlConfig.go +++ b/service/lambda/api_op_UpdateFunctionUrlConfig.go @@ -30,18 +30,11 @@ func (c *Client) UpdateFunctionUrlConfig(ctx context.Context, params *UpdateFunc type UpdateFunctionUrlConfigInput struct { // The name of the Lambda function. Name formats - // - // * Function name – my-function. - // - // * - // Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function. - // - // * - // Partial ARN – 123456789012:function:my-function. - // - // The length constraint applies - // only to the full ARN. If you specify only the function name, it is limited to 64 - // characters in length. + // - Function name – my-function . + // - Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function . + // - Partial ARN – 123456789012:function:my-function . + // The length constraint applies only to the full ARN. If you specify only the + // function name, it is limited to 64 characters in length. // // This member is required. FunctionName *string @@ -49,27 +42,23 @@ type UpdateFunctionUrlConfigInput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . AuthType types.FunctionUrlAuthType - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *types.Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode types.InvokeMode // The alias name. @@ -83,14 +72,14 @@ type UpdateFunctionUrlConfigOutput struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . // // This member is required. AuthType types.FunctionUrlAuthType - // When the function URL was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. CreationTime *string @@ -105,29 +94,25 @@ type UpdateFunctionUrlConfigOutput struct { // This member is required. FunctionUrl *string - // When the function URL configuration was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL configuration was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. LastModifiedTime *string - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *types.Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode types.InvokeMode // Metadata pertaining to the operation's result. diff --git a/service/lambda/doc.go b/service/lambda/doc.go index 71c9666fa0c..552a69351d0 100644 --- a/service/lambda/doc.go +++ b/service/lambda/doc.go @@ -9,62 +9,46 @@ // resources, including server and operating system maintenance, capacity // provisioning and automatic scaling, code monitoring and logging. With Lambda, // you can run code for virtually any type of application or backend service. For -// more information about the Lambda service, see What is Lambda -// (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) in the Lambda -// Developer Guide. The Lambda API Reference provides information about each of the -// API methods, including details about the parameters in each API request and -// response. You can use Software Development Kits (SDKs), Integrated Development -// Environment (IDE) Toolkits, and command line tools to access the API. For -// installation instructions, see Tools for Amazon Web Services -// (http://aws.amazon.com/tools/). For a list of Region-specific endpoints that -// Lambda supports, see Lambda endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/) in the -// Amazon Web Services General Reference.. When making the API calls, you will need -// to authenticate your request by providing a signature. Lambda supports signature -// version 4. For more information, see Signature Version 4 signing process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the -// Amazon Web Services General Reference.. CA certificates Because Amazon Web -// Services SDKs use the CA certificates from your computer, changes to the +// more information about the Lambda service, see What is Lambda (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) +// in the Lambda Developer Guide. The Lambda API Reference provides information +// about each of the API methods, including details about the parameters in each +// API request and response. You can use Software Development Kits (SDKs), +// Integrated Development Environment (IDE) Toolkits, and command line tools to +// access the API. For installation instructions, see Tools for Amazon Web Services (http://aws.amazon.com/tools/) +// . For a list of Region-specific endpoints that Lambda supports, see Lambda +// endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/) +// in the Amazon Web Services General Reference.. When making the API calls, you +// will need to authenticate your request by providing a signature. Lambda supports +// signature version 4. For more information, see Signature Version 4 signing +// process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// in the Amazon Web Services General Reference.. CA certificates Because Amazon +// Web Services SDKs use the CA certificates from your computer, changes to the // certificates on the Amazon Web Services servers can cause connection failures // when you attempt to use an SDK. You can prevent these failures by keeping your // computer's CA certificates and operating system up-to-date. If you encounter // this issue in a corporate environment and do not manage your own computer, you // might need to ask an administrator to assist with the update process. The // following list shows minimum operating system and Java versions: -// -// * Microsoft -// Windows versions that have updates from January 2005 or later installed contain -// at least one of the required CAs in their trust list. -// -// * Mac OS X 10.4 with Java -// for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and -// later versions contain at least one of the required CAs in their trust list. -// -// * -// Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all -// contain at least one of the required CAs in their default trusted CA list. -// -// * -// Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, -// including Java 6 (December 2006), 7, and 8, contain at least one of the required -// CAs in their default trusted CA list. -// -// When accessing the Lambda management -// console or Lambda API endpoints, whether through browsers or programmatically, -// you will need to ensure your client machines support any of the following -// CAs: -// -// * Amazon Root CA 1 -// -// * Starfield Services Root Certificate Authority - -// G2 -// -// * Starfield Class 2 Certification Authority -// -// Root certificates from the -// first two authorities are available from Amazon trust services -// (https://www.amazontrust.com/repository/), but keeping your computer up-to-date -// is the more straightforward solution. To learn more about ACM-provided -// certificates, see Amazon Web Services Certificate Manager FAQs. -// (http://aws.amazon.com/certificate-manager/faqs/#certificates) +// - Microsoft Windows versions that have updates from January 2005 or later +// installed contain at least one of the required CAs in their trust list. +// - Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS +// X 10.5 (October 2007), and later versions contain at least one of the required +// CAs in their trust list. +// - Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 +// all contain at least one of the required CAs in their default trusted CA list. +// - Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, +// including Java 6 (December 2006), 7, and 8, contain at least one of the required +// CAs in their default trusted CA list. +// +// When accessing the Lambda management console or Lambda API endpoints, whether +// through browsers or programmatically, you will need to ensure your client +// machines support any of the following CAs: +// - Amazon Root CA 1 +// - Starfield Services Root Certificate Authority - G2 +// - Starfield Class 2 Certification Authority +// +// Root certificates from the first two authorities are available from Amazon +// trust services (https://www.amazontrust.com/repository/) , but keeping your +// computer up-to-date is the more straightforward solution. To learn more about +// ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs. (http://aws.amazon.com/certificate-manager/faqs/#certificates) package lambda diff --git a/service/lambda/types/enums.go b/service/lambda/types/enums.go index f7a5429cc9c..05707234a44 100644 --- a/service/lambda/types/enums.go +++ b/service/lambda/types/enums.go @@ -10,9 +10,9 @@ const ( ArchitectureArm64 Architecture = "arm64" ) -// Values returns all known values for Architecture. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Architecture. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Architecture) Values() []Architecture { return []Architecture{ "x86_64", @@ -45,9 +45,9 @@ const ( EndPointTypeKafkaBootstrapServers EndPointType = "KAFKA_BOOTSTRAP_SERVERS" ) -// Values returns all known values for EndPointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndPointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndPointType) Values() []EndPointType { return []EndPointType{ "KAFKA_BOOTSTRAP_SERVERS", @@ -82,9 +82,9 @@ const ( FullDocumentDefault FullDocument = "Default" ) -// Values returns all known values for FullDocument. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FullDocument. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FullDocument) Values() []FullDocument { return []FullDocument{ "UpdateLookup", @@ -478,8 +478,8 @@ const ( StateFailed State = "Failed" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ diff --git a/service/lambda/types/errors.go b/service/lambda/types/errors.go index b8b2c7a8c3c..df9b0bbc117 100644 --- a/service/lambda/types/errors.go +++ b/service/lambda/types/errors.go @@ -38,8 +38,8 @@ func (e *CodeSigningConfigNotFoundException) ErrorFault() smithy.ErrorFault { } // Your Amazon Web Services account has exceeded its maximum total code size. For -// more information, see Lambda quotas -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html). +// more information, see Lambda quotas (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) +// . type CodeStorageExceededException struct { Message *string @@ -270,8 +270,8 @@ func (e *EFSMountFailureException) ErrorCode() string { } func (e *EFSMountFailureException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Lambda function made a network connection to the configured file system, but -// the mount operation timed out. +// The Lambda function made a network connection to the configured file system, +// but the mount operation timed out. type EFSMountTimeoutException struct { Message *string @@ -301,8 +301,8 @@ func (e *EFSMountTimeoutException) ErrorFault() smithy.ErrorFault { return smith // Lambda couldn't create an elastic network interface in the VPC, specified as // part of Lambda function configuration, because the limit for network interfaces -// has been reached. For more information, see Lambda quotas -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html). +// has been reached. For more information, see Lambda quotas (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) +// . type ENILimitReachedException struct { Message *string @@ -528,8 +528,8 @@ func (e *InvalidZipFileException) ErrorCode() string { } func (e *InvalidZipFileException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// Lambda couldn't decrypt the environment variables because KMS access was denied. -// Check the Lambda function's KMS permissions. +// Lambda couldn't decrypt the environment variables because KMS access was +// denied. Check the Lambda function's KMS permissions. type KMSAccessDeniedException struct { Message *string @@ -645,8 +645,8 @@ func (e *KMSNotFoundException) ErrorCode() string { func (e *KMSNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // The permissions policy for the resource is too large. For more information, see -// Lambda quotas -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html). +// Lambda quotas (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) +// . type PolicyLengthExceededException struct { Message *string @@ -735,8 +735,8 @@ func (e *ProvisionedConcurrencyConfigNotFoundException) ErrorFault() smithy.Erro } // The request payload exceeded the Invoke request body JSON input quota. For more -// information, see Lambda quotas -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html). +// information, see Lambda quotas (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) +// . type RequestTooLargeException struct { Message *string @@ -792,9 +792,9 @@ func (e *ResourceConflictException) ErrorCode() string { } func (e *ResourceConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation conflicts with the resource's availability. For example, you tried -// to update an event source mapping in the CREATING state, or you tried to delete -// an event source mapping currently UPDATING. +// The operation conflicts with the resource's availability. For example, you +// tried to update an event source mapping in the CREATING state, or you tried to +// delete an event source mapping currently UPDATING. type ResourceInUseException struct { Message *string @@ -850,8 +850,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The function is inactive and its VPC connection is no longer available. Wait for -// the VPC connection to reestablish and try again. +// The function is inactive and its VPC connection is no longer available. Wait +// for the VPC connection to reestablish and try again. type ResourceNotReadyException struct { Message *string @@ -907,8 +907,7 @@ func (e *ServiceException) ErrorCode() string { } func (e *ServiceException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The afterRestore()runtime hook -// (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-runtime-hooks.html) +// The afterRestore() runtime hook (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-runtime-hooks.html) // encountered an error. For more information, check the Amazon CloudWatch logs. type SnapStartException struct { Message *string @@ -938,9 +937,8 @@ func (e *SnapStartException) ErrorCode() string { func (e *SnapStartException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Lambda is initializing your function. You can invoke the function when the -// function state -// (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html) becomes -// Active. +// function state (https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html) +// becomes Active . type SnapStartNotReadyException struct { Message *string @@ -1028,8 +1026,8 @@ func (e *SubnetIPAddressLimitReachedException) ErrorFault() smithy.ErrorFault { } // The request throughput limit was exceeded. For more information, see Lambda -// quotas -// (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests). +// quotas (https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests) +// . type TooManyRequestsException struct { Message *string diff --git a/service/lambda/types/types.go b/service/lambda/types/types.go index bceda1b0567..ea3afa12337 100644 --- a/service/lambda/types/types.go +++ b/service/lambda/types/types.go @@ -27,7 +27,7 @@ type AccountLimit struct { TotalCodeSize int64 // The maximum number of simultaneous function executions, minus the capacity - // that's reserved for individual functions with PutFunctionConcurrency. + // that's reserved for individual functions with PutFunctionConcurrency . UnreservedConcurrentExecutions *int32 noSmithyDocumentSerde @@ -46,8 +46,8 @@ type AccountUsage struct { noSmithyDocumentSerde } -// Provides configuration information about a Lambda function alias -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html). +// Provides configuration information about a Lambda function alias (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) +// . type AliasConfiguration struct { // The Amazon Resource Name (ARN) of the alias. @@ -65,16 +65,14 @@ type AliasConfiguration struct { // A unique identifier that changes when you update the alias. RevisionId *string - // The routing configuration - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) + // The routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) // of the alias. RoutingConfig *AliasRoutingConfiguration noSmithyDocumentSerde } -// The traffic-shifting -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) +// The traffic-shifting (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) // configuration of a Lambda function alias. type AliasRoutingConfiguration struct { @@ -96,22 +94,22 @@ type AllowedPublishers struct { noSmithyDocumentSerde } -// Specific configuration settings for an Amazon Managed Streaming for Apache Kafka -// (Amazon MSK) event source. +// Specific configuration settings for an Amazon Managed Streaming for Apache +// Kafka (Amazon MSK) event source. type AmazonManagedKafkaEventSourceConfig struct { // The identifier for the Kafka consumer group to join. The consumer group ID must // be unique among all your Kafka event sources. After creating a Kafka event // source mapping with the consumer group ID specified, you cannot update this - // value. For more information, see Customizable consumer group ID - // (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). + // value. For more information, see Customizable consumer group ID (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id) + // . ConsumerGroupId *string noSmithyDocumentSerde } -// Details about a Code signing configuration -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). +// Details about a Code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) +// . type CodeSigningConfig struct { // List of allowed publishers. @@ -147,14 +145,13 @@ type CodeSigningConfig struct { noSmithyDocumentSerde } -// Code signing configuration policies -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies) +// Code signing configuration policies (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies) // specify the validation failure action for signature mismatch or expiry. type CodeSigningPolicies struct { // Code signing configuration policy for deployment validation failure. If you set - // the policy to Enforce, Lambda blocks the deployment request if signature - // validation checks fail. If you set the policy to Warn, Lambda allows the + // the policy to Enforce , Lambda blocks the deployment request if signature + // validation checks fail. If you set the policy to Warn , Lambda allows the // deployment and creates a CloudWatch log. Default value: Warn UntrustedArtifactOnDeployment CodeSigningPolicy @@ -164,53 +161,51 @@ type CodeSigningPolicies struct { type Concurrency struct { // The number of concurrent executions that are reserved for this function. For - // more information, see Managing Lambda reserved concurrency - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html). + // more information, see Managing Lambda reserved concurrency (https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) + // . ReservedConcurrentExecutions *int32 noSmithyDocumentSerde } -// The cross-origin resource sharing (CORS) -// (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your -// Lambda function URL. Use CORS to grant access to your function URL from any -// origin. You can also use CORS to control access for specific HTTP headers and -// methods in requests to your function URL. +// The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) +// settings for your Lambda function URL. Use CORS to grant access to your function +// URL from any origin. You can also use CORS to control access for specific HTTP +// headers and methods in requests to your function URL. type Cors struct { // Whether to allow cookies or other credentials in requests to your function URL. - // The default is false. + // The default is false . AllowCredentials *bool // The HTTP headers that origins can include in requests to your function URL. For - // example: Date, Keep-Alive, X-Custom-Header. + // example: Date , Keep-Alive , X-Custom-Header . AllowHeaders []string // The HTTP methods that are allowed when calling your function URL. For example: - // GET, POST, DELETE, or the wildcard character (*). + // GET , POST , DELETE , or the wildcard character ( * ). AllowMethods []string // The origins that can access your function URL. You can list any number of - // specific origins, separated by a comma. For example: https://www.example.com, - // http://localhost:60905. Alternatively, you can grant access to all origins using - // the wildcard character (*). + // specific origins, separated by a comma. For example: https://www.example.com , + // http://localhost:60905 . Alternatively, you can grant access to all origins + // using the wildcard character ( * ). AllowOrigins []string // The HTTP headers in your function response that you want to expose to origins - // that call your function URL. For example: Date, Keep-Alive, X-Custom-Header. + // that call your function URL. For example: Date , Keep-Alive , X-Custom-Header . ExposeHeaders []string - // The maximum amount of time, in seconds, that web browsers can cache results of a - // preflight request. By default, this is set to 0, which means that the browser + // The maximum amount of time, in seconds, that web browsers can cache results of + // a preflight request. By default, this is set to 0 , which means that the browser // doesn't cache results. MaxAge *int32 noSmithyDocumentSerde } -// The dead-letter queue -// (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for -// failed asynchronous invocations. +// The dead-letter queue (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) +// for failed asynchronous invocations. type DeadLetterConfig struct { // The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. @@ -235,8 +230,8 @@ type DestinationConfig struct { // Specific configuration settings for a DocumentDB event source. type DocumentDBEventSourceConfig struct { - // The name of the collection to consume within the database. If you do not specify - // a collection, Lambda consumes all collections. + // The name of the collection to consume within the database. If you do not + // specify a collection, Lambda consumes all collections. CollectionName *string // The name of the database to consume within the DocumentDB cluster. @@ -251,15 +246,15 @@ type DocumentDBEventSourceConfig struct { noSmithyDocumentSerde } -// A function's environment variable settings. You can use environment variables to -// adjust your function's behavior without updating code. An environment variable -// is a pair of strings that are stored in a function's version-specific +// A function's environment variable settings. You can use environment variables +// to adjust your function's behavior without updating code. An environment +// variable is a pair of strings that are stored in a function's version-specific // configuration. type Environment struct { // Environment variable key-value pairs. For more information, see Using Lambda - // environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). + // environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Variables map[string]string noSmithyDocumentSerde @@ -304,11 +299,11 @@ type EphemeralStorage struct { } // A mapping between an Amazon Web Services resource and a Lambda function. For -// details, see CreateEventSourceMapping. +// details, see CreateEventSourceMapping . type EventSourceMappingConfiguration struct { - // Specific configuration settings for an Amazon Managed Streaming for Apache Kafka - // (Amazon MSK) event source. + // Specific configuration settings for an Amazon Managed Streaming for Apache + // Kafka (Amazon MSK) event source. AmazonManagedKafkaEventSourceConfig *AmazonManagedKafkaEventSourceConfig // The maximum number of records in each batch that Lambda pulls from your stream @@ -335,8 +330,8 @@ type EventSourceMappingConfiguration struct { EventSourceArn *string // An object that defines the filter criteria that determine whether Lambda should - // process an event. For more information, see Lambda event filtering - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + // process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) + // . FilterCriteria *FilterCriteria // The ARN of the Lambda function. @@ -386,8 +381,8 @@ type EventSourceMappingConfiguration struct { Queues []string // (Amazon SQS only) The scaling configuration for the event source. For more - // information, see Configuring maximum concurrency for Amazon SQS event sources - // (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + // information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) + // . ScalingConfig *ScalingConfig // The self-managed Apache Kafka cluster for your event source. @@ -405,11 +400,11 @@ type EventSourceMappingConfiguration struct { // supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPosition EventSourcePosition - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start reading. StartingPositionTimestamp *time.Time - // The state of the event source mapping. It can be one of the following: Creating, - // Enabling, Enabled, Disabling, Disabled, Updating, or Deleting. + // The state of the event source mapping. It can be one of the following: Creating + // , Enabling , Enabled , Disabling , Disabled , Updating , or Deleting . State *string // Indicates whether a user or Lambda made the last change to the event source @@ -431,8 +426,8 @@ type EventSourceMappingConfiguration struct { } // Details about the connection between a Lambda function and an Amazon EFS file -// system -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). +// system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) +// . type FileSystemConfig struct { // The Amazon Resource Name (ARN) of the Amazon EFS access point that provides @@ -441,7 +436,7 @@ type FileSystemConfig struct { // This member is required. Arn *string - // The path where the function can access the file system, starting with /mnt/. + // The path where the function can access the file system, starting with /mnt/ . // // This member is required. LocalMountPath *string @@ -454,8 +449,8 @@ type FileSystemConfig struct { type Filter struct { // A filter pattern. For more information on the syntax of a filter pattern, see - // Filter rule syntax - // (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). + // Filter rule syntax (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax) + // . Pattern *string noSmithyDocumentSerde @@ -470,18 +465,17 @@ type FilterCriteria struct { noSmithyDocumentSerde } -// The code for the Lambda function. You can either specify an object in Amazon S3, -// upload a .zip file archive deployment package directly, or specify the URI of a -// container image. +// The code for the Lambda function. You can either specify an object in Amazon +// S3, upload a .zip file archive deployment package directly, or specify the URI +// of a container image. type FunctionCode struct { - // URI of a container image - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon - // ECR registry. + // URI of a container image (https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) + // in the Amazon ECR registry. ImageUri *string - // An Amazon S3 bucket in the same Amazon Web Services Region as your function. The - // bucket can be in a different Amazon Web Services account. + // An Amazon S3 bucket in the same Amazon Web Services Region as your function. + // The bucket can be in a different Amazon Web Services account. S3Bucket *string // The Amazon S3 key of the deployment package. @@ -520,7 +514,7 @@ type FunctionConfiguration struct { // The instruction set architecture that the function supports. Architecture is a // string array with one of the valid values. The default architecture value is - // x86_64. + // x86_64 . Architectures []Architecture // The SHA256 hash of the function's deployment package. @@ -535,17 +529,16 @@ type FunctionConfiguration struct { // The function's description. Description *string - // The function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). - // Omitted from CloudTrail logs. + // The function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) + // . Omitted from CloudTrail logs. Environment *EnvironmentResponse // The size of the function’s /tmp directory in MB. The default value is 512, but // it can be any whole number between 512 and 10,240 MB. EphemeralStorage *EphemeralStorage - // Connection settings for an Amazon EFS file system - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html). + // Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) + // . FileSystemConfigs []FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -560,16 +553,14 @@ type FunctionConfiguration struct { // The function's image configuration values. ImageConfigResponse *ImageConfigResponse - // The KMS key that's used to encrypt the function's environment variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). - // When Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is - // activated, this key is also used to encrypt the function's snapshot. This key is - // returned only if you've configured a customer managed key. + // The KMS key that's used to encrypt the function's environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption) + // . When Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) + // is activated, this key is also used to encrypt the function's snapshot. This key + // is returned only if you've configured a customer managed key. KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModified *string // The status of the last update that was performed on the function. This is first @@ -582,8 +573,8 @@ type FunctionConfiguration struct { // The reason code for the last update that was performed on the function. LastUpdateStatusReasonCode LastUpdateStatusReasonCode - // The function's layers - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). + // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) + // . Layers []Layer // For Lambda@Edge functions, the ARN of the main function. @@ -592,8 +583,8 @@ type FunctionConfiguration struct { // The amount of memory available to the function at runtime. MemorySize *int32 - // The type of deployment package. Set to Image for container image and set Zip for - // .zip file archive. + // The type of deployment package. Set to Image for container image and set Zip + // for .zip file archive. PackageType PackageType // The latest updated revision of the function or alias. @@ -616,19 +607,19 @@ type FunctionConfiguration struct { // Set ApplyOn to PublishedVersions to create a snapshot of the initialized // execution environment when you publish a function version. For more information, - // see Improving startup performance with Lambda SnapStart - // (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). + // see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) + // . SnapStart *SnapStartResponse - // The current state of the function. When the state is Inactive, you can + // The current state of the function. When the state is Inactive , you can // reactivate the function by invoking it. State State // The reason for the function's current state. StateReason *string - // The reason code for the function's current state. When the code is Creating, you - // can't invoke or modify the function. + // The reason code for the function's current state. When the code is Creating , + // you can't invoke or modify the function. StateReasonCode StateReasonCode // The amount of time in seconds that Lambda allows a function to run before @@ -649,18 +640,12 @@ type FunctionConfiguration struct { type FunctionEventInvokeConfig struct { - // A destination for events after they have been sent to a function for processing. - // Destinations - // - // * Function - The Amazon Resource Name (ARN) of a Lambda - // function. - // - // * Queue - The ARN of a standard SQS queue. - // - // * Topic - The ARN of a - // standard SNS topic. - // - // * Event Bus - The ARN of an Amazon EventBridge event bus. + // A destination for events after they have been sent to a function for + // processing. Destinations + // - Function - The Amazon Resource Name (ARN) of a Lambda function. + // - Queue - The ARN of a standard SQS queue. + // - Topic - The ARN of a standard SNS topic. + // - Event Bus - The ARN of an Amazon EventBridge event bus. DestinationConfig *DestinationConfig // The Amazon Resource Name (ARN) of the function. @@ -684,14 +669,14 @@ type FunctionUrlConfig struct { // The type of authentication that your function URL uses. Set to AWS_IAM if you // want to restrict access to authenticated users only. Set to NONE if you want to // bypass IAM authentication to create a public endpoint. For more information, see - // Security and auth model for Lambda function URLs - // (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). + // Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) + // . // // This member is required. AuthType FunctionUrlAuthType - // When the function URL was created, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. CreationTime *string @@ -706,37 +691,33 @@ type FunctionUrlConfig struct { // This member is required. FunctionUrl *string - // When the function URL configuration was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the function URL configuration was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). // // This member is required. LastModifiedTime *string - // The cross-origin resource sharing (CORS) - // (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your - // function URL. + // The cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) + // settings for your function URL. Cors *Cors // Use one of the following options: - // - // * BUFFERED – This is the default option. - // Lambda invokes your function using the Invoke API operation. Invocation results - // are available when the payload is complete. The maximum payload size is 6 MB. - // - // * - // RESPONSE_STREAM – Your function streams payload results as they become - // available. Lambda invokes your function using the InvokeWithResponseStream API - // operation. The maximum response payload size is 20 MB, however, you can request - // a quota increase - // (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html). + // - BUFFERED – This is the default option. Lambda invokes your function using + // the Invoke API operation. Invocation results are available when the payload is + // complete. The maximum payload size is 6 MB. + // - RESPONSE_STREAM – Your function streams payload results as they become + // available. Lambda invokes your function using the InvokeWithResponseStream API + // operation. The maximum response payload size is 20 MB, however, you can + // request a quota increase (https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) + // . InvokeMode InvokeMode noSmithyDocumentSerde } // Configuration values that override the container image Dockerfile settings. For -// more information, see Container image settings -// (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). +// more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) +// . type ImageConfig struct { // Specifies parameters that you want to pass in with ENTRYPOINT. @@ -752,7 +733,7 @@ type ImageConfig struct { noSmithyDocumentSerde } -// Error response to GetFunctionConfiguration. +// Error response to GetFunctionConfiguration . type ImageConfigError struct { // Error code. @@ -767,7 +748,7 @@ type ImageConfigError struct { // Response to a GetFunctionConfiguration request. type ImageConfigResponse struct { - // Error response to GetFunctionConfiguration. + // Error response to GetFunctionConfiguration . Error *ImageConfigError // Configuration values that override the container image Dockerfile. @@ -832,8 +813,8 @@ type InvokeWithResponseStreamResponseEventMemberPayloadChunk struct { func (*InvokeWithResponseStreamResponseEventMemberPayloadChunk) isInvokeWithResponseStreamResponseEvent() { } -// An Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . type Layer struct { // The Amazon Resource Name (ARN) of the function layer. @@ -851,8 +832,8 @@ type Layer struct { noSmithyDocumentSerde } -// Details about an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . type LayersListItem struct { // The newest version of the layer. @@ -867,9 +848,9 @@ type LayersListItem struct { noSmithyDocumentSerde } -// A ZIP archive that contains the contents of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). You -// can specify either an Amazon S3 location, or upload a layer archive directly. +// A ZIP archive that contains the contents of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . You can specify either an Amazon S3 location, or upload a layer archive +// directly. type LayerVersionContentInput struct { // The Amazon S3 bucket of the layer archive. @@ -888,8 +869,8 @@ type LayerVersionContentInput struct { noSmithyDocumentSerde } -// Details about a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . type LayerVersionContentOutput struct { // The SHA-256 hash of the layer archive. @@ -910,19 +891,19 @@ type LayerVersionContentOutput struct { noSmithyDocumentSerde } -// Details about a version of an Lambda layer -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). +// Details about a version of an Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) +// . type LayerVersionsListItem struct { - // A list of compatible instruction set architectures - // (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html). + // A list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) + // . CompatibleArchitectures []Architecture // The layer's compatible runtimes. CompatibleRuntimes []Runtime // The date that the version was created, in ISO 8601 format. For example, - // 2018-11-27T15:10:45.123+0000. + // 2018-11-27T15:10:45.123+0000 . CreatedDate *string // The description of the version. @@ -973,8 +954,8 @@ type ProvisionedConcurrencyConfigListItem struct { // The Amazon Resource Name (ARN) of the alias or version. FunctionArn *string - // The date and time that a user last updated the configuration, in ISO 8601 format - // (https://www.iso.org/iso-8601-date-and-time-format.html). + // The date and time that a user last updated the configuration, in ISO 8601 format (https://www.iso.org/iso-8601-date-and-time-format.html) + // . LastModified *string // The amount of provisioned concurrency requested. @@ -1031,7 +1012,7 @@ type ScalingConfig struct { type SelfManagedEventSource struct { // The list of bootstrap servers for your Kafka brokers in the following format: - // "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]. + // "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"] . Endpoints map[string][]string noSmithyDocumentSerde @@ -1043,8 +1024,8 @@ type SelfManagedKafkaEventSourceConfig struct { // The identifier for the Kafka consumer group to join. The consumer group ID must // be unique among all your Kafka event sources. After creating a Kafka event // source mapping with the consumer group ID specified, you cannot update this - // value. For more information, see Customizable consumer group ID - // (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). + // value. For more information, see Customizable consumer group ID (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id) + // . ConsumerGroupId *string noSmithyDocumentSerde @@ -1053,8 +1034,8 @@ type SelfManagedKafkaEventSourceConfig struct { // The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to // create a snapshot of the initialized execution environment when you publish a // function version. SnapStart is supported with the java11 runtime. For more -// information, see Improving startup performance with Lambda SnapStart -// (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html). +// information, see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) +// . type SnapStart struct { // Set to PublishedVersions to create a snapshot of the initialized execution @@ -1064,18 +1045,17 @@ type SnapStart struct { noSmithyDocumentSerde } -// The function's SnapStart -// (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. +// The function's SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) +// setting. type SnapStartResponse struct { - // When set to PublishedVersions, Lambda creates a snapshot of the execution + // When set to PublishedVersions , Lambda creates a snapshot of the execution // environment when you publish a function version. ApplyOn SnapStartApplyOn - // When you provide a qualified Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), - // this response element indicates whether SnapStart is activated for the specified - // function version. + // When you provide a qualified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using) + // , this response element indicates whether SnapStart is activated for the + // specified function version. OptimizationStatus SnapStartOptimizationStatus noSmithyDocumentSerde @@ -1086,59 +1066,44 @@ type SnapStartResponse struct { type SourceAccessConfiguration struct { // The type of authentication protocol, VPC components, or virtual host for your - // event source. For example: "Type":"SASL_SCRAM_512_AUTH". - // - // * BASIC_AUTH – (Amazon - // MQ) The Secrets Manager secret that stores your broker credentials. - // - // * - // BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret - // key used for SASL/PLAIN authentication of your Apache Kafka brokers. - // - // * - // VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. - // Lambda connects to these subnets to fetch data from your self-managed Apache - // Kafka cluster. - // - // * VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC - // security group used to manage access to your self-managed Apache Kafka - // brokers. - // - // * SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets - // Manager ARN of your secret key used for SASL SCRAM-256 authentication of your - // self-managed Apache Kafka brokers. - // - // * SASL_SCRAM_512_AUTH – (Amazon MSK, - // Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for - // SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. - // - // * - // VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. - // Lambda uses this RabbitMQ host as the event source. This property cannot be - // specified in an UpdateEventSourceMapping API call. - // - // * - // CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The - // Secrets Manager ARN of your secret key containing the certificate chain (X.509 - // PEM), private key (PKCS#8 PEM), and private key password (optional) used for - // mutual TLS authentication of your MSK/Apache Kafka brokers. - // - // * - // SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN - // of your secret key containing the root CA certificate (X.509 PEM) used for TLS - // encryption of your Apache Kafka brokers. + // event source. For example: "Type":"SASL_SCRAM_512_AUTH" . + // - BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker + // credentials. + // - BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your + // secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. + // - VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your + // VPC. Lambda connects to these subnets to fetch data from your self-managed + // Apache Kafka cluster. + // - VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used + // to manage access to your self-managed Apache Kafka brokers. + // - SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of + // your secret key used for SASL SCRAM-256 authentication of your self-managed + // Apache Kafka brokers. + // - SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets + // Manager ARN of your secret key used for SASL SCRAM-512 authentication of your + // self-managed Apache Kafka brokers. + // - VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ + // broker. Lambda uses this RabbitMQ host as the event source. This property cannot + // be specified in an UpdateEventSourceMapping API call. + // - CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The + // Secrets Manager ARN of your secret key containing the certificate chain (X.509 + // PEM), private key (PKCS#8 PEM), and private key password (optional) used for + // mutual TLS authentication of your MSK/Apache Kafka brokers. + // - SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager + // ARN of your secret key containing the root CA certificate (X.509 PEM) used for + // TLS encryption of your Apache Kafka brokers. Type SourceAccessType - // The value for your chosen configuration in Type. For example: "URI": - // "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName". + // The value for your chosen configuration in Type . For example: "URI": + // "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName" . URI *string noSmithyDocumentSerde } -// The function's X-Ray -// (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing -// configuration. To sample and record incoming requests, set Mode to Active. +// The function's X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) +// tracing configuration. To sample and record incoming requests, set Mode to +// Active . type TracingConfig struct { // The tracing mode. @@ -1157,8 +1122,8 @@ type TracingConfigResponse struct { } // The VPC security groups and subnets that are attached to a Lambda function. For -// more information, see Configuring a Lambda function to access resources in a VPC -// (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). +// more information, see Configuring a Lambda function to access resources in a VPC (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) +// . type VpcConfig struct { // A list of VPC security group IDs. diff --git a/service/lexmodelbuildingservice/api_client.go b/service/lexmodelbuildingservice/api_client.go index 43f8005daf7..3f6edfdf1d6 100644 --- a/service/lexmodelbuildingservice/api_client.go +++ b/service/lexmodelbuildingservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go index aef381ccd8e..e4928a81c86 100644 --- a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go @@ -18,7 +18,7 @@ import ( // You can update only the $LATEST version of the bot. You can't update the // numbered versions that you create with the CreateBotVersion operation. When you // create the first version of a bot, Amazon Lex sets the version to 1. Subsequent -// versions increment by 1. For more information, see versioning-intro. This +// versions increment by 1. For more information, see versioning-intro . This // operation requires permission for the lex:CreateBotVersion action. func (c *Client) CreateBotVersion(ctx context.Context, params *CreateBotVersionInput, optFns ...func(*Options)) (*CreateBotVersionOutput, error) { if params == nil { @@ -43,11 +43,11 @@ type CreateBotVersionInput struct { // This member is required. Name *string - // Identifies a specific revision of the $LATEST version of the bot. If you specify - // a checksum and the $LATEST version of the bot has a different checksum, a - // PreconditionFailedException exception is returned and Amazon Lex doesn't publish - // a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST - // version. + // Identifies a specific revision of the $LATEST version of the bot. If you + // specify a checksum and the $LATEST version of the bot has a different checksum, + // a PreconditionFailedException exception is returned and Amazon Lex doesn't + // publish a new version. If you don't specify a checksum, Amazon Lex publishes the + // $LATEST version. Checksum *string noSmithyDocumentSerde @@ -55,8 +55,8 @@ type CreateBotVersionInput struct { type CreateBotVersionOutput struct { - // The message that Amazon Lex uses to cancel a conversation. For more information, - // see PutBot. + // The message that Amazon Lex uses to cancel a conversation. For more + // information, see PutBot . AbortStatement *types.Statement // Checksum identifying the version of the bot that was created. @@ -67,26 +67,25 @@ type CreateBotVersionOutput struct { // other application that is directed or targeted, in whole or in part, to children // under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) // by specifying true or false in the childDirected field. By specifying true in - // the childDirected field, you confirm that your use of Amazon Lex is related to a - // website, program, or other application that is directed or targeted, in whole or - // in part, to children under age 13 and subject to COPPA. By specifying false in - // the childDirected field, you confirm that your use of Amazon Lex is not related - // to a website, program, or other application that is directed or targeted, in - // whole or in part, to children under age 13 and subject to COPPA. You may not - // specify a default value for the childDirected field that does not accurately - // reflect whether your use of Amazon Lex is related to a website, program, or - // other application that is directed or targeted, in whole or in part, to children - // under age 13 and subject to COPPA. If your use of Amazon Lex relates to a - // website, program, or other application that is directed in whole or in part, to - // children under age 13, you must obtain any required verifiable parental consent - // under COPPA. For information regarding the use of Amazon Lex in connection with - // websites, programs, or other applications that are directed or targeted, in - // whole or in part, to children under age 13, see the Amazon Lex FAQ. - // (https://aws.amazon.com/lex/faqs#data-security) + // the childDirected field, you confirm that your use of Amazon Lex is related to + // a website, program, or other application that is directed or targeted, in whole + // or in part, to children under age 13 and subject to COPPA. By specifying false + // in the childDirected field, you confirm that your use of Amazon Lex is not + // related to a website, program, or other application that is directed or + // targeted, in whole or in part, to children under age 13 and subject to COPPA. + // You may not specify a default value for the childDirected field that does not + // accurately reflect whether your use of Amazon Lex is related to a website, + // program, or other application that is directed or targeted, in whole or in part, + // to children under age 13 and subject to COPPA. If your use of Amazon Lex relates + // to a website, program, or other application that is directed in whole or in + // part, to children under age 13, you must obtain any required verifiable parental + // consent under COPPA. For information regarding the use of Amazon Lex in + // connection with websites, programs, or other applications that are directed or + // targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool // The message that Amazon Lex uses when it doesn't understand the user's request. - // For more information, see PutBot. + // For more information, see PutBot . ClarificationPrompt *types.Prompt // The date when the bot version was created. @@ -100,18 +99,18 @@ type CreateBotVersionOutput struct { DetectSentiment *bool // Indicates whether the bot uses accuracy improvements. true indicates that the - // bot is using the improvements, otherwise, false. + // bot is using the improvements, otherwise, false . EnableModelImprovements *bool - // If status is FAILED, Amazon Lex provides the reason that it failed to build the + // If status is FAILED , Amazon Lex provides the reason that it failed to build the // bot. FailureReason *string // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot. + // conversation. For more information, see PutBot . IdleSessionTTLInSeconds *int32 - // An array of Intent objects. For more information, see PutBot. + // An array of Intent objects. For more information, see PutBot . Intents []types.Intent // The date when the $LATEST version of this bot was updated. @@ -124,9 +123,9 @@ type CreateBotVersionOutput struct { Name *string // When you send a request to create or update a bot, Amazon Lex sets the status - // response element to BUILDING. After Amazon Lex builds the bot, it sets status to - // READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex - // returns the reason for the failure in the failureReason response element. + // response element to BUILDING . After Amazon Lex builds the bot, it sets status + // to READY . If Amazon Lex can't build the bot, it sets status to FAILED . Amazon + // Lex returns the reason for the failure in the failureReason response element. Status types.Status // The version of the bot. diff --git a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go index 2d29607fee8..bed979e29c3 100644 --- a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go @@ -15,12 +15,12 @@ import ( // Creates a new version of an intent based on the $LATEST version of the intent. // If the $LATEST version of this intent hasn't changed since you last updated it, // Amazon Lex doesn't create a new version. It returns the last version you -// created. You can update only the $LATEST version of the intent. You can't update -// the numbered versions that you create with the CreateIntentVersion operation. -// When you create a version of an intent, Amazon Lex sets the version to 1. -// Subsequent versions increment by 1. For more information, see versioning-intro. -// This operation requires permissions to perform the lex:CreateIntentVersion -// action. +// created. You can update only the $LATEST version of the intent. You can't +// update the numbered versions that you create with the CreateIntentVersion +// operation. When you create a version of an intent, Amazon Lex sets the version +// to 1. Subsequent versions increment by 1. For more information, see +// versioning-intro . This operation requires permissions to perform the +// lex:CreateIntentVersion action. func (c *Client) CreateIntentVersion(ctx context.Context, params *CreateIntentVersionInput, optFns ...func(*Options)) (*CreateIntentVersionOutput, error) { if params == nil { params = &CreateIntentVersionInput{} @@ -45,10 +45,10 @@ type CreateIntentVersionInput struct { Name *string // Checksum of the $LATEST version of the intent that should be used to create the - // new version. If you specify a checksum and the $LATEST version of the intent has - // a different checksum, Amazon Lex returns a PreconditionFailedException exception - // and doesn't publish a new version. If you don't specify a checksum, Amazon Lex - // publishes the $LATEST version. + // new version. If you specify a checksum and the $LATEST version of the intent + // has a different checksum, Amazon Lex returns a PreconditionFailedException + // exception and doesn't publish a new version. If you don't specify a checksum, + // Amazon Lex publishes the $LATEST version. Checksum *string noSmithyDocumentSerde @@ -83,8 +83,8 @@ type CreateIntentVersionOutput struct { // Describes how the intent is fulfilled. FulfillmentActivity *types.FulfillmentActivity - // An array of InputContext objects that lists the contexts that must be active for - // Amazon Lex to choose the intent in a conversation with the user. + // An array of InputContext objects that lists the contexts that must be active + // for Amazon Lex to choose the intent in a conversation with the user. InputContexts []types.InputContext // Configuration information, if any, for connecting an Amazon Kendra index with @@ -104,7 +104,7 @@ type CreateIntentVersionOutput struct { // A unique identifier for a built-in intent. ParentIntentSignature *string - // If the user answers "no" to the question defined in confirmationPrompt, Amazon + // If the user answers "no" to the question defined in confirmationPrompt , Amazon // Lex responds with this statement to acknowledge that the intent was canceled. RejectionStatement *types.Statement diff --git a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go index c9b7e719565..ee5f43f0fcd 100644 --- a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go @@ -19,7 +19,7 @@ import ( // $LATEST version of a slot type. You can't update the numbered versions that you // create with the CreateSlotTypeVersion operation. When you create a version of a // slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. -// For more information, see versioning-intro. This operation requires permissions +// For more information, see versioning-intro . This operation requires permissions // for the lex:CreateSlotTypeVersion action. func (c *Client) CreateSlotTypeVersion(ctx context.Context, params *CreateSlotTypeVersionInput, optFns ...func(*Options)) (*CreateSlotTypeVersionOutput, error) { if params == nil { @@ -38,17 +38,17 @@ func (c *Client) CreateSlotTypeVersion(ctx context.Context, params *CreateSlotTy type CreateSlotTypeVersionInput struct { - // The name of the slot type that you want to create a new version for. The name is - // case sensitive. + // The name of the slot type that you want to create a new version for. The name + // is case sensitive. // // This member is required. Name *string // Checksum for the $LATEST version of the slot type that you want to publish. If // you specify a checksum and the $LATEST version of the slot type has a different - // checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't - // publish the new version. If you don't specify a checksum, Amazon Lex publishes - // the $LATEST version. + // checksum, Amazon Lex returns a PreconditionFailedException exception and + // doesn't publish the new version. If you don't specify a checksum, Amazon Lex + // publishes the $LATEST version. Checksum *string noSmithyDocumentSerde @@ -83,7 +83,7 @@ type CreateSlotTypeVersionOutput struct { SlotTypeConfigurations []types.SlotTypeConfiguration // The strategy that Amazon Lex uses to determine the value of the slot. For more - // information, see PutSlotType. + // information, see PutSlotType . ValueSelectionStrategy types.SlotValueSelectionStrategy // The version assigned to the new slot type version. diff --git a/service/lexmodelbuildingservice/api_op_DeleteBot.go b/service/lexmodelbuildingservice/api_op_DeleteBot.go index 30612d7e73e..e97750f42ba 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBot.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBot.go @@ -17,11 +17,11 @@ import ( // improving the ability of your bot to respond to user inputs. These utterances // are not removed when the bot is deleted. To remove the utterances, use the // DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, -// the DeleteBot operation returns a ResourceInUseException exception that includes -// a reference to the alias that refers to the bot. To remove the reference to the -// bot, delete the alias. If you get the same exception again, delete the referring -// alias until the DeleteBot operation is successful. This operation requires -// permissions for the lex:DeleteBot action. +// the DeleteBot operation returns a ResourceInUseException exception that +// includes a reference to the alias that refers to the bot. To remove the +// reference to the bot, delete the alias. If you get the same exception again, +// delete the referring alias until the DeleteBot operation is successful. This +// operation requires permissions for the lex:DeleteBot action. func (c *Client) DeleteBot(ctx context.Context, params *DeleteBotInput, optFns ...func(*Options)) (*DeleteBotOutput, error) { if params == nil { params = &DeleteBotInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go index 77a561f69fd..f2d705aa4f4 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the association between an Amazon Lex bot and a messaging platform. This -// operation requires permission for the lex:DeleteBotChannelAssociation action. +// Deletes the association between an Amazon Lex bot and a messaging platform. +// This operation requires permission for the lex:DeleteBotChannelAssociation +// action. func (c *Client) DeleteBotChannelAssociation(ctx context.Context, params *DeleteBotChannelAssociationInput, optFns ...func(*Options)) (*DeleteBotChannelAssociationOutput, error) { if params == nil { params = &DeleteBotChannelAssociationInput{} @@ -29,8 +30,8 @@ func (c *Client) DeleteBotChannelAssociation(ctx context.Context, params *Delete type DeleteBotChannelAssociationInput struct { - // An alias that points to the specific version of the Amazon Lex bot to which this - // association is being made. + // An alias that points to the specific version of the Amazon Lex bot to which + // this association is being made. // // This member is required. BotAlias *string diff --git a/service/lexmodelbuildingservice/api_op_DeleteIntent.go b/service/lexmodelbuildingservice/api_op_DeleteIntent.go index bf4425752e4..5a4c0f25aa2 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteIntent.go +++ b/service/lexmodelbuildingservice/api_op_DeleteIntent.go @@ -13,7 +13,7 @@ import ( // Deletes all versions of the intent, including the $LATEST version. To delete a // specific version of the intent, use the DeleteIntentVersion operation. You can // delete a version of an intent only if it is not referenced. To delete an intent -// that is referred to in one or more bots (see how-it-works), you must remove +// that is referred to in one or more bots (see how-it-works ), you must remove // those references first. If you get the ResourceInUseException exception, it // provides an example reference that shows where the intent is referenced. To // remove the reference to the intent, either update the bot or delete it. If you diff --git a/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go b/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go index fc18b0fcb06..ac800d64dbd 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific version of an intent. To delete all versions of a intent, use -// the DeleteIntent operation. This operation requires permissions for the +// Deletes a specific version of an intent. To delete all versions of a intent, +// use the DeleteIntent operation. This operation requires permissions for the // lex:DeleteIntentVersion action. func (c *Client) DeleteIntentVersion(ctx context.Context, params *DeleteIntentVersionInput, optFns ...func(*Options)) (*DeleteIntentVersionOutput, error) { if params == nil { diff --git a/service/lexmodelbuildingservice/api_op_DeleteSlotType.go b/service/lexmodelbuildingservice/api_op_DeleteSlotType.go index a4bc103d9c1..f807f0d3dfa 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteSlotType.go +++ b/service/lexmodelbuildingservice/api_op_DeleteSlotType.go @@ -14,12 +14,12 @@ import ( // a specific version of the slot type, use the DeleteSlotTypeVersion operation. // You can delete a version of a slot type only if it is not referenced. To delete // a slot type that is referred to in one or more intents, you must remove those -// references first. If you get the ResourceInUseException exception, the exception -// provides an example reference that shows the intent where the slot type is -// referenced. To remove the reference to the slot type, either update the intent -// or delete it. If you get the same exception when you attempt to delete the slot -// type again, repeat until the slot type has no references and the DeleteSlotType -// call is successful. This operation requires permission for the +// references first. If you get the ResourceInUseException exception, the +// exception provides an example reference that shows the intent where the slot +// type is referenced. To remove the reference to the slot type, either update the +// intent or delete it. If you get the same exception when you attempt to delete +// the slot type again, repeat until the slot type has no references and the +// DeleteSlotType call is successful. This operation requires permission for the // lex:DeleteSlotType action. func (c *Client) DeleteSlotType(ctx context.Context, params *DeleteSlotTypeInput, optFns ...func(*Options)) (*DeleteSlotTypeOutput, error) { if params == nil { diff --git a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go index f42ecab0848..2ac61568101 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go @@ -35,8 +35,9 @@ type DeleteSlotTypeVersionInput struct { // This member is required. Name *string - // The version of the slot type to delete. You cannot delete the $LATEST version of - // the slot type. To delete the $LATEST version, use the DeleteSlotType operation. + // The version of the slot type to delete. You cannot delete the $LATEST version + // of the slot type. To delete the $LATEST version, use the DeleteSlotType + // operation. // // This member is required. Version *string diff --git a/service/lexmodelbuildingservice/api_op_DeleteUtterances.go b/service/lexmodelbuildingservice/api_op_DeleteUtterances.go index ef6dc157afa..2bda1b458b9 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteUtterances.go +++ b/service/lexmodelbuildingservice/api_op_DeleteUtterances.go @@ -41,10 +41,9 @@ type DeleteUtterancesInput struct { // This member is required. BotName *string - // The unique identifier for the user that made the utterances. This is the user ID - // that was sent in the PostContent - // (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or - // PostText (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) + // The unique identifier for the user that made the utterances. This is the user + // ID that was sent in the PostContent (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) + // or PostText (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) // operation request that contained the utterance. // // This member is required. diff --git a/service/lexmodelbuildingservice/api_op_GetBot.go b/service/lexmodelbuildingservice/api_op_GetBot.go index 25789268b51..7ac2954614e 100644 --- a/service/lexmodelbuildingservice/api_op_GetBot.go +++ b/service/lexmodelbuildingservice/api_op_GetBot.go @@ -47,8 +47,8 @@ type GetBotInput struct { type GetBotOutput struct { - // The message that Amazon Lex returns when the user elects to end the conversation - // without completing it. For more information, see PutBot. + // The message that Amazon Lex returns when the user elects to end the + // conversation without completing it. For more information, see PutBot . AbortStatement *types.Statement // Checksum of the bot used to identify a specific revision of the bot's $LATEST @@ -60,26 +60,25 @@ type GetBotOutput struct { // other application that is directed or targeted, in whole or in part, to children // under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) // by specifying true or false in the childDirected field. By specifying true in - // the childDirected field, you confirm that your use of Amazon Lex is related to a - // website, program, or other application that is directed or targeted, in whole or - // in part, to children under age 13 and subject to COPPA. By specifying false in - // the childDirected field, you confirm that your use of Amazon Lex is not related - // to a website, program, or other application that is directed or targeted, in - // whole or in part, to children under age 13 and subject to COPPA. You may not - // specify a default value for the childDirected field that does not accurately - // reflect whether your use of Amazon Lex is related to a website, program, or - // other application that is directed or targeted, in whole or in part, to children - // under age 13 and subject to COPPA. If your use of Amazon Lex relates to a - // website, program, or other application that is directed in whole or in part, to - // children under age 13, you must obtain any required verifiable parental consent - // under COPPA. For information regarding the use of Amazon Lex in connection with - // websites, programs, or other applications that are directed or targeted, in - // whole or in part, to children under age 13, see the Amazon Lex FAQ. - // (https://aws.amazon.com/lex/faqs#data-security) + // the childDirected field, you confirm that your use of Amazon Lex is related to + // a website, program, or other application that is directed or targeted, in whole + // or in part, to children under age 13 and subject to COPPA. By specifying false + // in the childDirected field, you confirm that your use of Amazon Lex is not + // related to a website, program, or other application that is directed or + // targeted, in whole or in part, to children under age 13 and subject to COPPA. + // You may not specify a default value for the childDirected field that does not + // accurately reflect whether your use of Amazon Lex is related to a website, + // program, or other application that is directed or targeted, in whole or in part, + // to children under age 13 and subject to COPPA. If your use of Amazon Lex relates + // to a website, program, or other application that is directed in whole or in + // part, to children under age 13, you must obtain any required verifiable parental + // consent under COPPA. For information regarding the use of Amazon Lex in + // connection with websites, programs, or other applications that are directed or + // targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool // The message Amazon Lex uses when it doesn't understand the user's request. For - // more information, see PutBot. + // more information, see PutBot . ClarificationPrompt *types.Prompt // The date that the bot was created. @@ -93,21 +92,21 @@ type GetBotOutput struct { DetectSentiment *bool // Indicates whether the bot uses accuracy improvements. true indicates that the - // bot is using the improvements, otherwise, false. + // bot is using the improvements, otherwise, false . EnableModelImprovements *bool - // If status is FAILED, Amazon Lex explains why it failed to build the bot. + // If status is FAILED , Amazon Lex explains why it failed to build the bot. FailureReason *string // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot. + // conversation. For more information, see PutBot . IdleSessionTTLInSeconds *int32 - // An array of intent objects. For more information, see PutBot. + // An array of intent objects. For more information, see PutBot . Intents []types.Intent - // The date that the bot was updated. When you create a resource, the creation date - // and last updated date are the same. + // The date that the bot was updated. When you create a resource, the creation + // date and last updated date are the same. LastUpdatedDate *time.Time // The target locale for the bot. @@ -116,30 +115,29 @@ type GetBotOutput struct { // The name of the bot. Name *string - // The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, - // AMAZON.KendraSearchIntent, or both when returning alternative intents in a - // PostContent - // (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or - // PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) + // The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent , + // AMAZON.KendraSearchIntent , or both when returning alternative intents in a + // PostContent (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) + // or PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) // response. AMAZON.FallbackIntent is inserted if the confidence score for all - // intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is - // configured for the bot. + // intents is below this value. AMAZON.KendraSearchIntent is only inserted if it + // is configured for the bot. NluIntentConfidenceThreshold *float64 // The status of the bot. When the status is BUILDING Amazon Lex is building the - // bot for testing and use. If the status of the bot is READY_BASIC_TESTING, you + // bot for testing and use. If the status of the bot is READY_BASIC_TESTING , you // can test the bot using the exact utterances specified in the bot's intents. When - // the bot is ready for full testing or to run, the status is READY. If there was a - // problem with building the bot, the status is FAILED and the failureReason field - // explains why the bot did not build. If the bot was saved but not built, the - // status is NOT_BUILT. + // the bot is ready for full testing or to run, the status is READY . If there was + // a problem with building the bot, the status is FAILED and the failureReason + // field explains why the bot did not build. If the bot was saved but not built, + // the status is NOT_BUILT . Status types.Status - // The version of the bot. For a new bot, the version is always $LATEST. + // The version of the bot. For a new bot, the version is always $LATEST . Version *string // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the - // user. For more information, see PutBot. + // user. For more information, see PutBot . VoiceId *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelbuildingservice/api_op_GetBotAlias.go b/service/lexmodelbuildingservice/api_op_GetBotAlias.go index a77675612ef..ecb0d733cfc 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_GetBotAlias.go @@ -13,7 +13,7 @@ import ( ) // Returns information about an Amazon Lex bot alias. For more information about -// aliases, see versioning-aliases. This operation requires permissions for the +// aliases, see versioning-aliases . This operation requires permissions for the // lex:GetBotAlias action. func (c *Client) GetBotAlias(ctx context.Context, params *GetBotAliasInput, optFns ...func(*Options)) (*GetBotAliasOutput, error) { if params == nil { diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go index 8f28955aad1..8db9c0e174d 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go @@ -71,23 +71,18 @@ type GetBotChannelAssociationOutput struct { // A description of the association between the bot and the channel. Description *string - // If status is FAILED, Amazon Lex provides the reason that it failed to create the - // association. + // If status is FAILED , Amazon Lex provides the reason that it failed to create + // the association. FailureReason *string // The name of the association between the bot and the channel. Name *string // The status of the bot channel. - // - // * CREATED - The channel has been created and is - // ready for use. - // - // * IN_PROGRESS - Channel creation is in progress. - // - // * FAILED - - // There was an error creating the channel. For information about the reason for - // the failure, see the failureReason field. + // - CREATED - The channel has been created and is ready for use. + // - IN_PROGRESS - Channel creation is in progress. + // - FAILED - There was an error creating the channel. For information about the + // reason for the failure, see the failureReason field. Status types.ChannelStatus // The type of the messaging platform. diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go index 9f251a60cff..705286bc82f 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go @@ -46,10 +46,10 @@ type GetBotChannelAssociationsInput struct { // The maximum number of associations to return in the response. The default is 50. MaxResults *int32 - // Substring to match in channel association names. An association will be returned - // if any part of its name matches the substring. For example, "xyz" matches both - // "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen - // ("-") as the nameContains parameter. + // Substring to match in channel association names. An association will be + // returned if any part of its name matches the substring. For example, "xyz" + // matches both "xyzabc" and "abcxyz." To return all bot channel associations, use + // a hyphen ("-") as the nameContains parameter. NameContains *string // A pagination token for fetching the next page of associations. If the response diff --git a/service/lexmodelbuildingservice/api_op_GetBots.go b/service/lexmodelbuildingservice/api_op_GetBots.go index adac1390361..56c254a1359 100644 --- a/service/lexmodelbuildingservice/api_op_GetBots.go +++ b/service/lexmodelbuildingservice/api_op_GetBots.go @@ -13,14 +13,10 @@ import ( ) // Returns bot information as follows: -// -// * If you provide the nameContains field, -// the response includes information for the $LATEST version of all bots whose name -// contains the specified string. -// -// * If you don't specify the nameContains field, -// the operation returns information about the $LATEST version of all of your -// bots. +// - If you provide the nameContains field, the response includes information for +// the $LATEST version of all bots whose name contains the specified string. +// - If you don't specify the nameContains field, the operation returns +// information about the $LATEST version of all of your bots. // // This operation requires permission for the lex:GetBots action. func (c *Client) GetBots(ctx context.Context, params *GetBotsInput, optFns ...func(*Options)) (*GetBotsOutput, error) { diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go index 7d4758b6580..2bcae86d2cf 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go @@ -31,8 +31,7 @@ func (c *Client) GetBuiltinIntent(ctx context.Context, params *GetBuiltinIntentI type GetBuiltinIntentInput struct { // The unique identifier for a built-in intent. To find the signature for an - // intent, see Standard Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // intent, see Standard Built-in Intents (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. // // This member is required. diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go index aaf4a8ece4b..ecdf9feb4b5 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of built-in intents that meet the specified criteria. This operation -// requires permission for the lex:GetBuiltinIntents action. +// Gets a list of built-in intents that meet the specified criteria. This +// operation requires permission for the lex:GetBuiltinIntents action. func (c *Client) GetBuiltinIntents(ctx context.Context, params *GetBuiltinIntentsInput, optFns ...func(*Options)) (*GetBuiltinIntentsOutput, error) { if params == nil { params = &GetBuiltinIntentsInput{} @@ -45,8 +45,7 @@ type GetBuiltinIntentsInput struct { // Substring to match in built-in intent signatures. An intent will be returned if // any part of its signature matches the substring. For example, "xyz" matches both // "xyzabc" and "abcxyz." To find the signature for an intent, see Standard - // Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // Built-in Intents (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. SignatureContains *string diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go index c052acb5ec1..64eae8d0db5 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go @@ -13,8 +13,7 @@ import ( ) // Gets a list of built-in slot types that meet the specified criteria. For a list -// of built-in slot types, see Slot Type Reference -// (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) +// of built-in slot types, see Slot Type Reference (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) // in the Alexa Skills Kit. This operation requires permission for the // lex:GetBuiltInSlotTypes action. func (c *Client) GetBuiltinSlotTypes(ctx context.Context, params *GetBuiltinSlotTypesInput, optFns ...func(*Options)) (*GetBuiltinSlotTypesOutput, error) { @@ -130,8 +129,8 @@ func (c *Client) addOperationGetBuiltinSlotTypesMiddlewares(stack *middleware.St return nil } -// GetBuiltinSlotTypesAPIClient is a client that implements the GetBuiltinSlotTypes -// operation. +// GetBuiltinSlotTypesAPIClient is a client that implements the +// GetBuiltinSlotTypes operation. type GetBuiltinSlotTypesAPIClient interface { GetBuiltinSlotTypes(context.Context, *GetBuiltinSlotTypesInput, ...func(*Options)) (*GetBuiltinSlotTypesOutput, error) } diff --git a/service/lexmodelbuildingservice/api_op_GetExport.go b/service/lexmodelbuildingservice/api_op_GetExport.go index 7f914090591..53b6cb51474 100644 --- a/service/lexmodelbuildingservice/api_op_GetExport.go +++ b/service/lexmodelbuildingservice/api_op_GetExport.go @@ -55,20 +55,16 @@ type GetExportInput struct { type GetExportOutput struct { // The status of the export. - // - // * IN_PROGRESS - The export is in progress. - // - // * READY - - // The export is complete. - // - // * FAILED - The export could not be completed. + // - IN_PROGRESS - The export is in progress. + // - READY - The export is complete. + // - FAILED - The export could not be completed. ExportStatus types.ExportStatus // The format of the exported data. ExportType types.ExportType - // If status is FAILED, Amazon Lex provides the reason that it failed to export the - // resource. + // If status is FAILED , Amazon Lex provides the reason that it failed to export + // the resource. FailureReason *string // The name of the bot being exported. diff --git a/service/lexmodelbuildingservice/api_op_GetImport.go b/service/lexmodelbuildingservice/api_op_GetImport.go index 1cc34b6014c..b2445b97761 100644 --- a/service/lexmodelbuildingservice/api_op_GetImport.go +++ b/service/lexmodelbuildingservice/api_op_GetImport.go @@ -49,7 +49,7 @@ type GetImportOutput struct { // The identifier for the specific import job. ImportId *string - // The status of the import job. If the status is FAILED, you can get the reason + // The status of the import job. If the status is FAILED , you can get the reason // for the failure from the failureReason field. ImportStatus types.ImportStatus diff --git a/service/lexmodelbuildingservice/api_op_GetIntent.go b/service/lexmodelbuildingservice/api_op_GetIntent.go index 2220a7b3c6b..987a7fa2ec4 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetIntent.go @@ -55,7 +55,7 @@ type GetIntentOutput struct { ConclusionStatement *types.Statement // If defined in the bot, Amazon Lex uses prompt to confirm the intent before - // fulfilling the user's request. For more information, see PutIntent. + // fulfilling the user's request. For more information, see PutIntent . ConfirmationPrompt *types.Prompt // The date that the intent was created. @@ -65,22 +65,22 @@ type GetIntentOutput struct { Description *string // If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each - // user input. For more information, see PutIntent. + // user input. For more information, see PutIntent . DialogCodeHook *types.CodeHook // If defined in the bot, Amazon Lex uses this prompt to solicit additional user - // activity after the intent is fulfilled. For more information, see PutIntent. + // activity after the intent is fulfilled. For more information, see PutIntent . FollowUpPrompt *types.FollowUpPrompt - // Describes how the intent is fulfilled. For more information, see PutIntent. + // Describes how the intent is fulfilled. For more information, see PutIntent . FulfillmentActivity *types.FulfillmentActivity - // An array of InputContext objects that lists the contexts that must be active for - // Amazon Lex to choose the intent in a conversation with the user. + // An array of InputContext objects that lists the contexts that must be active + // for Amazon Lex to choose the intent in a conversation with the user. InputContexts []types.InputContext - // Configuration information, if any, to connect to an Amazon Kendra index with the - // AMAZON.KendraSearchIntent intent. + // Configuration information, if any, to connect to an Amazon Kendra index with + // the AMAZON.KendraSearchIntent intent. KendraConfiguration *types.KendraConfiguration // The date that the intent was updated. When you create a resource, the creation @@ -97,7 +97,7 @@ type GetIntentOutput struct { // A unique identifier for a built-in intent. ParentIntentSignature *string - // If the user answers "no" to the question defined in confirmationPrompt, Amazon + // If the user answers "no" to the question defined in confirmationPrompt , Amazon // Lex responds with this statement to acknowledge that the intent was canceled. RejectionStatement *types.Statement diff --git a/service/lexmodelbuildingservice/api_op_GetIntents.go b/service/lexmodelbuildingservice/api_op_GetIntents.go index fe6be1ba359..b64cdc99914 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetIntents.go @@ -13,16 +13,12 @@ import ( ) // Returns intent information as follows: +// - If you specify the nameContains field, returns the $LATEST version of all +// intents that contain the specified string. +// - If you don't specify the nameContains field, returns information about the +// $LATEST version of all intents. // -// * If you specify the nameContains field, -// returns the $LATEST version of all intents that contain the specified string. -// -// * -// If you don't specify the nameContains field, returns information about the -// $LATEST version of all intents. -// -// The operation requires permission for the -// lex:GetIntents action. +// The operation requires permission for the lex:GetIntents action. func (c *Client) GetIntents(ctx context.Context, params *GetIntentsInput, optFns ...func(*Options)) (*GetIntentsOutput, error) { if params == nil { params = &GetIntentsInput{} @@ -59,7 +55,7 @@ type GetIntentsInput struct { type GetIntentsOutput struct { - // An array of Intent objects. For more information, see PutBot. + // An array of Intent objects. For more information, see PutBot . Intents []types.IntentMetadata // If the response is truncated, the response includes a pagination token that you diff --git a/service/lexmodelbuildingservice/api_op_GetMigration.go b/service/lexmodelbuildingservice/api_op_GetMigration.go index 9f2765941eb..5801aa37417 100644 --- a/service/lexmodelbuildingservice/api_op_GetMigration.go +++ b/service/lexmodelbuildingservice/api_op_GetMigration.go @@ -54,20 +54,18 @@ type GetMigrationOutput struct { // when calling the GetMigration operation. MigrationId *string - // Indicates the status of the migration. When the status is COMPLETE the migration - // is finished and the bot is available in Amazon Lex V2. There may be alerts and - // warnings that need to be resolved to complete the migration. + // Indicates the status of the migration. When the status is COMPLETE the + // migration is finished and the bot is available in Amazon Lex V2. There may be + // alerts and warnings that need to be resolved to complete the migration. MigrationStatus types.MigrationStatus // The strategy used to conduct the migration. - // - // * CREATE_NEW - Creates a new Amazon - // Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot. - // - // * UPDATE_EXISTING - // - Overwrites the existing Amazon Lex V2 bot metadata and the locale being - // migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the - // locale doesn't exist, a new locale is created in the Amazon Lex V2 bot. + // - CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 + // bot to the new bot. + // - UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the + // locale being migrated. It doesn't change any other locales in the Amazon Lex V2 + // bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 + // bot. MigrationStrategy types.MigrationStrategy // The date and time that the migration started. diff --git a/service/lexmodelbuildingservice/api_op_GetMigrations.go b/service/lexmodelbuildingservice/api_op_GetMigrations.go index 77b66180409..eca252d1cb9 100644 --- a/service/lexmodelbuildingservice/api_op_GetMigrations.go +++ b/service/lexmodelbuildingservice/api_op_GetMigrations.go @@ -58,9 +58,9 @@ type GetMigrationsInput struct { type GetMigrationsOutput struct { - // An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see - // details of the migration, use the migrationId from the summary in a call to the - // operation. + // An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To + // see details of the migration, use the migrationId from the summary in a call to + // the operation. MigrationSummaries []types.MigrationSummary // If the response is truncated, it includes a pagination token that you can diff --git a/service/lexmodelbuildingservice/api_op_GetSlotType.go b/service/lexmodelbuildingservice/api_op_GetSlotType.go index 531ebd9b889..26123a01269 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotType.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotType.go @@ -74,7 +74,7 @@ type GetSlotTypeOutput struct { SlotTypeConfigurations []types.SlotTypeConfiguration // The strategy that Amazon Lex uses to determine the value of the slot. For more - // information, see PutSlotType. + // information, see PutSlotType . ValueSelectionStrategy types.SlotValueSelectionStrategy // The version of the slot type. diff --git a/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go b/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go index 2b280013cc5..61522ed8462 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go @@ -13,8 +13,8 @@ import ( ) // Gets information about all versions of a slot type. The GetSlotTypeVersions -// operation returns a SlotTypeMetadata object for each version of a slot type. For -// example, if a slot type has three numbered versions, the GetSlotTypeVersions +// operation returns a SlotTypeMetadata object for each version of a slot type. +// For example, if a slot type has three numbered versions, the GetSlotTypeVersions // operation returns four SlotTypeMetadata objects in the response, one for each // numbered version and one for the $LATEST version. The GetSlotTypeVersions // operation always returns at least one version, the $LATEST version. This @@ -135,8 +135,8 @@ func (c *Client) addOperationGetSlotTypeVersionsMiddlewares(stack *middleware.St return nil } -// GetSlotTypeVersionsAPIClient is a client that implements the GetSlotTypeVersions -// operation. +// GetSlotTypeVersionsAPIClient is a client that implements the +// GetSlotTypeVersions operation. type GetSlotTypeVersionsAPIClient interface { GetSlotTypeVersions(context.Context, *GetSlotTypeVersionsInput, ...func(*Options)) (*GetSlotTypeVersionsOutput, error) } diff --git a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go index e0e5be4a529..312ef75635f 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go @@ -13,16 +13,12 @@ import ( ) // Returns slot type information as follows: +// - If you specify the nameContains field, returns the $LATEST version of all +// slot types that contain the specified string. +// - If you don't specify the nameContains field, returns information about the +// $LATEST version of all slot types. // -// * If you specify the nameContains -// field, returns the $LATEST version of all slot types that contain the specified -// string. -// -// * If you don't specify the nameContains field, returns information -// about the $LATEST version of all slot types. -// -// The operation requires permission -// for the lex:GetSlotTypes action. +// The operation requires permission for the lex:GetSlotTypes action. func (c *Client) GetSlotTypes(ctx context.Context, params *GetSlotTypesInput, optFns ...func(*Options)) (*GetSlotTypesOutput, error) { if params == nil { params = &GetSlotTypesInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go index ca49d70988d..7d497bcd0c2 100644 --- a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go +++ b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use the GetUtterancesView operation to get information about the utterances that -// your users have made to your bot. You can use this list to tune the utterances -// that your bot responds to. For example, say that you have created a bot to order -// flowers. After your users have used your bot for a while, use the +// Use the GetUtterancesView operation to get information about the utterances +// that your users have made to your bot. You can use this list to tune the +// utterances that your bot responds to. For example, say that you have created a +// bot to order flowers. After your users have used your bot for a while, use the // GetUtterancesView operation to see the requests that they have made and whether // they have been successful. You might find that the utterance "I want flowers" is -// not being recognized. You could add this utterance to the OrderFlowers intent so -// that your bot recognizes that utterance. After you publish a new version of a +// not being recognized. You could add this utterance to the OrderFlowers intent +// so that your bot recognizes that utterance. After you publish a new version of a // bot, you can get information about the old version and the new so that you can // compare the performance across the two versions. Utterance statistics are // generated once a day. Data is available for the last 15 days. You can request @@ -51,14 +51,14 @@ type GetUtterancesViewInput struct { // This member is required. BotName *string - // An array of bot versions for which utterance information should be returned. The - // limit is 5 versions per request. + // An array of bot versions for which utterance information should be returned. + // The limit is 5 versions per request. // // This member is required. BotVersions []string - // To return utterances that were recognized and handled, use Detected. To return - // utterances that were not recognized, use Missed. + // To return utterances that were recognized and handled, use Detected . To return + // utterances that were not recognized, use Missed . // // This member is required. StatusType types.StatusType diff --git a/service/lexmodelbuildingservice/api_op_PutBot.go b/service/lexmodelbuildingservice/api_op_PutBot.go index 4cae9a14a28..7f2857df18e 100644 --- a/service/lexmodelbuildingservice/api_op_PutBot.go +++ b/service/lexmodelbuildingservice/api_op_PutBot.go @@ -17,15 +17,15 @@ import ( // whether the bot is directed toward children under age 13. You can use this to // add intents later, or to remove intents from an existing bot. When you create a // bot with the minimum information, the bot is created or updated but Amazon Lex -// returns the response FAILED. You can build the bot after you add one or more -// intents. For more information about Amazon Lex bots, see how-it-works. If you +// returns the response FAILED . You can build the bot after you add one or more +// intents. For more information about Amazon Lex bots, see how-it-works . If you // specify the name of an existing bot, the fields in the request replace the -// existing values in the $LATEST version of the bot. Amazon Lex removes any fields -// that you don't provide values for in the request, except for the +// existing values in the $LATEST version of the bot. Amazon Lex removes any +// fields that you don't provide values for in the request, except for the // idleTTLInSeconds and privacySettings fields, which are set to their default // values. If you don't specify values for required fields, Amazon Lex throws an // exception. This operation requires permissions for the lex:PutBot action. For -// more information, see security-iam. +// more information, see security-iam . func (c *Client) PutBot(ctx context.Context, params *PutBotInput, optFns ...func(*Options)) (*PutBotOutput, error) { if params == nil { params = &PutBotInput{} @@ -48,28 +48,27 @@ type PutBotInput struct { // other application that is directed or targeted, in whole or in part, to children // under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) // by specifying true or false in the childDirected field. By specifying true in - // the childDirected field, you confirm that your use of Amazon Lex is related to a - // website, program, or other application that is directed or targeted, in whole or - // in part, to children under age 13 and subject to COPPA. By specifying false in - // the childDirected field, you confirm that your use of Amazon Lex is not related - // to a website, program, or other application that is directed or targeted, in - // whole or in part, to children under age 13 and subject to COPPA. You may not - // specify a default value for the childDirected field that does not accurately - // reflect whether your use of Amazon Lex is related to a website, program, or - // other application that is directed or targeted, in whole or in part, to children - // under age 13 and subject to COPPA. If your use of Amazon Lex relates to a - // website, program, or other application that is directed in whole or in part, to - // children under age 13, you must obtain any required verifiable parental consent - // under COPPA. For information regarding the use of Amazon Lex in connection with - // websites, programs, or other applications that are directed or targeted, in - // whole or in part, to children under age 13, see the Amazon Lex FAQ. - // (https://aws.amazon.com/lex/faqs#data-security) + // the childDirected field, you confirm that your use of Amazon Lex is related to + // a website, program, or other application that is directed or targeted, in whole + // or in part, to children under age 13 and subject to COPPA. By specifying false + // in the childDirected field, you confirm that your use of Amazon Lex is not + // related to a website, program, or other application that is directed or + // targeted, in whole or in part, to children under age 13 and subject to COPPA. + // You may not specify a default value for the childDirected field that does not + // accurately reflect whether your use of Amazon Lex is related to a website, + // program, or other application that is directed or targeted, in whole or in part, + // to children under age 13 and subject to COPPA. If your use of Amazon Lex relates + // to a website, program, or other application that is directed in whole or in + // part, to children under age 13, you must obtain any required verifiable parental + // consent under COPPA. For information regarding the use of Amazon Lex in + // connection with websites, programs, or other applications that are directed or + // targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security) // // This member is required. ChildDirected *bool // Specifies the target locale for the bot. Any intent used in the bot must be - // compatible with the locale of the bot. The default is en-US. + // compatible with the locale of the bot. The default is en-US . // // This member is required. Locale types.Locale @@ -79,28 +78,28 @@ type PutBotInput struct { // This member is required. Name *string - // When Amazon Lex can't understand the user's input in context, it tries to elicit - // the information a few times. After that, Amazon Lex sends the message defined in - // abortStatement to the user, and then cancels the conversation. To set the number - // of retries, use the valueElicitationPrompt field for the slot type. For example, - // in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would - // you like?" If the user's response is not one of the expected responses (for - // example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct - // response a few more times. For example, in a pizza ordering application, - // OrderPizza might be one of the intents. This intent might require the CrustType - // slot. You specify the valueElicitationPrompt field when you create the CrustType - // slot. If you have defined a fallback intent the cancel statement will not be - // sent to the user, the fallback intent is used instead. For more information, see - // AMAZON.FallbackIntent - // (https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html). + // When Amazon Lex can't understand the user's input in context, it tries to + // elicit the information a few times. After that, Amazon Lex sends the message + // defined in abortStatement to the user, and then cancels the conversation. To + // set the number of retries, use the valueElicitationPrompt field for the slot + // type. For example, in a pizza ordering bot, Amazon Lex might ask a user "What + // type of crust would you like?" If the user's response is not one of the expected + // responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to + // elicit a correct response a few more times. For example, in a pizza ordering + // application, OrderPizza might be one of the intents. This intent might require + // the CrustType slot. You specify the valueElicitationPrompt field when you + // create the CrustType slot. If you have defined a fallback intent the cancel + // statement will not be sent to the user, the fallback intent is used instead. For + // more information, see AMAZON.FallbackIntent (https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html) + // . AbortStatement *types.Statement // Identifies a specific revision of the $LATEST version. When you create a new // bot, leave the checksum field blank. If you specify a checksum you get a // BadRequestException exception. When you want to update a bot, set the checksum - // field to the checksum of the most recent revision of the $LATEST version. If you - // don't specify the checksum field, or if the checksum does not match the $LATEST - // version, you get a PreconditionFailedException exception. + // field to the checksum of the most recent revision of the $LATEST version. If + // you don't specify the checksum field, or if the checksum does not match the + // $LATEST version, you get a PreconditionFailedException exception. Checksum *string // When Amazon Lex doesn't understand the user's intent, it uses this message to @@ -112,62 +111,49 @@ type PutBotInput struct { // clarification prompt: "What would you like to do? You can say 'Order a pizza' or // 'Order a drink.'" If you have defined a fallback intent, it will be invoked if // the clarification prompt is repeated the number of times defined in the - // maxAttempts field. For more information, see AMAZON.FallbackIntent - // (https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html). If - // you don't define a clarification prompt, at runtime Amazon Lex will return a 400 - // Bad Request exception in three cases: - // - // * Follow-up prompt - When the user - // responds to a follow-up prompt but does not provide an intent. For example, in - // response to a follow-up prompt that says "Would you like anything else today?" - // the user says "Yes." Amazon Lex will return a 400 Bad Request exception because - // it does not have a clarification prompt to send to the user to get an intent. - // - // * - // Lambda function - When using a Lambda function, you return an ElicitIntent - // dialog type. Since Amazon Lex does not have a clarification prompt to get an - // intent from the user, it returns a 400 Bad Request exception. - // - // * PutSession - // operation - When using the PutSession operation, you send an ElicitIntent dialog - // type. Since Amazon Lex does not have a clarification prompt to get an intent - // from the user, it returns a 400 Bad Request exception. + // maxAttempts field. For more information, see AMAZON.FallbackIntent (https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html) + // . If you don't define a clarification prompt, at runtime Amazon Lex will return + // a 400 Bad Request exception in three cases: + // - Follow-up prompt - When the user responds to a follow-up prompt but does + // not provide an intent. For example, in response to a follow-up prompt that says + // "Would you like anything else today?" the user says "Yes." Amazon Lex will + // return a 400 Bad Request exception because it does not have a clarification + // prompt to send to the user to get an intent. + // - Lambda function - When using a Lambda function, you return an ElicitIntent + // dialog type. Since Amazon Lex does not have a clarification prompt to get an + // intent from the user, it returns a 400 Bad Request exception. + // - PutSession operation - When using the PutSession operation, you send an + // ElicitIntent dialog type. Since Amazon Lex does not have a clarification + // prompt to get an intent from the user, it returns a 400 Bad Request exception. ClarificationPrompt *types.Prompt // When set to true a new numbered version of the bot is created. This is the same - // as calling the CreateBotVersion operation. If you don't specify createVersion, - // the default is false. + // as calling the CreateBotVersion operation. If you don't specify createVersion , + // the default is false . CreateVersion *bool // A description of the bot. Description *string // When set to true user utterances are sent to Amazon Comprehend for sentiment - // analysis. If you don't specify detectSentiment, the default is false. + // analysis. If you don't specify detectSentiment , the default is false . DetectSentiment *bool // Set to true to enable access to natural language understanding improvements. // When you set the enableModelImprovements parameter to true you can use the // nluIntentConfidenceThreshold parameter to configure confidence scores. For more - // information, see Confidence Scores - // (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html). You can only - // set the enableModelImprovements parameter in certain Regions. If you set the - // parameter to true, your bot has access to accuracy improvements. The Regions - // where you can set the enableModelImprovements parameter to true are: - // - // * US East - // (N. Virginia) (us-east-1) - // - // * US West (Oregon) (us-west-2) - // - // * Asia Pacific - // (Sydney) (ap-southeast-2) - // - // * EU (Ireland) (eu-west-1) - // - // In other Regions, the - // enableModelImprovements parameter is set to true by default. In these Regions - // setting the parameter to false throws a ValidationException exception. + // information, see Confidence Scores (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html) + // . You can only set the enableModelImprovements parameter in certain Regions. If + // you set the parameter to true , your bot has access to accuracy improvements. + // The Regions where you can set the enableModelImprovements parameter to true + // are: + // - US East (N. Virginia) (us-east-1) + // - US West (Oregon) (us-west-2) + // - Asia Pacific (Sydney) (ap-southeast-2) + // - EU (Ireland) (eu-west-1) + // In other Regions, the enableModelImprovements parameter is set to true by + // default. In these Regions setting the parameter to false throws a + // ValidationException exception. EnableModelImprovements *bool // The maximum time in seconds that Amazon Lex retains the data gathered in a @@ -184,48 +170,35 @@ type PutBotInput struct { // An array of Intent objects. Each intent represents a command that a user can // express. For example, a pizza ordering bot might support an OrderPizza intent. - // For more information, see how-it-works. + // For more information, see how-it-works . Intents []types.Intent - // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, - // AMAZON.KendraSearchIntent, or both when returning alternative intents in a - // PostContent - // (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or - // PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) + // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent + // , AMAZON.KendraSearchIntent , or both when returning alternative intents in a + // PostContent (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) + // or PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) // response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted // if they are configured for the bot. You must set the enableModelImprovements // parameter to true to use confidence scores in the following regions. - // - // * US East - // (N. Virginia) (us-east-1) - // - // * US West (Oregon) (us-west-2) - // - // * Asia Pacific - // (Sydney) (ap-southeast-2) - // - // * EU (Ireland) (eu-west-1) - // - // In other Regions, the - // enableModelImprovements parameter is set to true by default. For example, - // suppose a bot is configured with the confidence threshold of 0.80 and the - // AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the - // following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The - // response from the PostText operation would be: - // - // * AMAZON.FallbackIntent - // - // * - // IntentA - // - // * IntentB - // - // * IntentC + // - US East (N. Virginia) (us-east-1) + // - US West (Oregon) (us-west-2) + // - Asia Pacific (Sydney) (ap-southeast-2) + // - EU (Ireland) (eu-west-1) + // In other Regions, the enableModelImprovements parameter is set to true by + // default. For example, suppose a bot is configured with the confidence threshold + // of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns three alternative + // intents with the following confidence scores: IntentA (0.70), IntentB (0.60), + // IntentC (0.50). The response from the PostText operation would be: + // - AMAZON.FallbackIntent + // - IntentA + // - IntentB + // - IntentC NluIntentConfidenceThreshold *float64 - // If you set the processBehavior element to BUILD, Amazon Lex builds the bot so - // that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but - // doesn't build it. If you don't specify this value, the default value is BUILD. + // If you set the processBehavior element to BUILD , Amazon Lex builds the bot so + // that it can be run. If you set the element to SAVE Amazon Lex saves the bot, + // but doesn't build it. If you don't specify this value, the default value is + // BUILD . ProcessBehavior types.ProcessBehavior // A list of tags to add to the bot. You can only add tags when you create a bot, @@ -233,11 +206,10 @@ type PutBotInput struct { // use the TagResource operation. Tags []types.Tag - // The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions - // with the user. The locale configured for the voice must match the locale of the - // bot. For more information, see Voices in Amazon Polly - // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the Amazon Polly - // Developer Guide. + // The Amazon Polly voice ID that you want Amazon Lex to use for voice + // interactions with the user. The locale configured for the voice must match the + // locale of the bot. For more information, see Voices in Amazon Polly (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) + // in the Amazon Polly Developer Guide. VoiceId *string noSmithyDocumentSerde @@ -245,8 +217,8 @@ type PutBotInput struct { type PutBotOutput struct { - // The message that Amazon Lex uses to cancel a conversation. For more information, - // see PutBot. + // The message that Amazon Lex uses to cancel a conversation. For more + // information, see PutBot . AbortStatement *types.Statement // Checksum of the bot that you created. @@ -257,30 +229,29 @@ type PutBotOutput struct { // other application that is directed or targeted, in whole or in part, to children // under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) // by specifying true or false in the childDirected field. By specifying true in - // the childDirected field, you confirm that your use of Amazon Lex is related to a - // website, program, or other application that is directed or targeted, in whole or - // in part, to children under age 13 and subject to COPPA. By specifying false in - // the childDirected field, you confirm that your use of Amazon Lex is not related - // to a website, program, or other application that is directed or targeted, in - // whole or in part, to children under age 13 and subject to COPPA. You may not - // specify a default value for the childDirected field that does not accurately - // reflect whether your use of Amazon Lex is related to a website, program, or - // other application that is directed or targeted, in whole or in part, to children - // under age 13 and subject to COPPA. If your use of Amazon Lex relates to a - // website, program, or other application that is directed in whole or in part, to - // children under age 13, you must obtain any required verifiable parental consent - // under COPPA. For information regarding the use of Amazon Lex in connection with - // websites, programs, or other applications that are directed or targeted, in - // whole or in part, to children under age 13, see the Amazon Lex FAQ. - // (https://aws.amazon.com/lex/faqs#data-security) + // the childDirected field, you confirm that your use of Amazon Lex is related to + // a website, program, or other application that is directed or targeted, in whole + // or in part, to children under age 13 and subject to COPPA. By specifying false + // in the childDirected field, you confirm that your use of Amazon Lex is not + // related to a website, program, or other application that is directed or + // targeted, in whole or in part, to children under age 13 and subject to COPPA. + // You may not specify a default value for the childDirected field that does not + // accurately reflect whether your use of Amazon Lex is related to a website, + // program, or other application that is directed or targeted, in whole or in part, + // to children under age 13 and subject to COPPA. If your use of Amazon Lex relates + // to a website, program, or other application that is directed in whole or in + // part, to children under age 13, you must obtain any required verifiable parental + // consent under COPPA. For information regarding the use of Amazon Lex in + // connection with websites, programs, or other applications that are directed or + // targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security) ChildDirected *bool // The prompts that Amazon Lex uses when it doesn't understand the user's intent. - // For more information, see PutBot. + // For more information, see PutBot . ClarificationPrompt *types.Prompt - // True if a new version of the bot was created. If the createVersion field was not - // specified in the request, the createVersion field is set to false in the + // True if a new version of the bot was created. If the createVersion field was + // not specified in the request, the createVersion field is set to false in the // response. CreateVersion *bool @@ -296,22 +267,22 @@ type PutBotOutput struct { DetectSentiment *bool // Indicates whether the bot uses accuracy improvements. true indicates that the - // bot is using the improvements, otherwise, false. + // bot is using the improvements, otherwise, false . EnableModelImprovements *bool - // If status is FAILED, Amazon Lex provides the reason that it failed to build the + // If status is FAILED , Amazon Lex provides the reason that it failed to build the // bot. FailureReason *string // The maximum length of time that Amazon Lex retains the data gathered in a - // conversation. For more information, see PutBot. + // conversation. For more information, see PutBot . IdleSessionTTLInSeconds *int32 - // An array of Intent objects. For more information, see PutBot. + // An array of Intent objects. For more information, see PutBot . Intents []types.Intent - // The date that the bot was updated. When you create a resource, the creation date - // and last updated date are the same. + // The date that the bot was updated. When you create a resource, the creation + // date and last updated date are the same. LastUpdatedDate *time.Time // The target locale for the bot. @@ -320,35 +291,34 @@ type PutBotOutput struct { // The name of the bot. Name *string - // The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, - // AMAZON.KendraSearchIntent, or both when returning alternative intents in a - // PostContent - // (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) or - // PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) + // The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent , + // AMAZON.KendraSearchIntent , or both when returning alternative intents in a + // PostContent (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) + // or PostText (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) // response. AMAZON.FallbackIntent is inserted if the confidence score for all - // intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is - // configured for the bot. + // intents is below this value. AMAZON.KendraSearchIntent is only inserted if it + // is configured for the bot. NluIntentConfidenceThreshold *float64 - // When you send a request to create a bot with processBehavior set to BUILD, - // Amazon Lex sets the status response element to BUILDING. In the + // When you send a request to create a bot with processBehavior set to BUILD , + // Amazon Lex sets the status response element to BUILDING . In the // READY_BASIC_TESTING state you can test the bot with user inputs that exactly // match the utterances configured for the bot's intents and values in the slot - // types. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. + // types. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED . // Amazon Lex returns the reason for the failure in the failureReason response - // element. When you set processBehavior to SAVE, Amazon Lex sets the status code - // to NOT BUILT. When the bot is in the READY state you can test and publish the + // element. When you set processBehavior to SAVE , Amazon Lex sets the status code + // to NOT BUILT . When the bot is in the READY state you can test and publish the // bot. Status types.Status // A list of tags associated with the bot. Tags []types.Tag - // The version of the bot. For a new bot, the version is always $LATEST. + // The version of the bot. For a new bot, the version is always $LATEST . Version *string // The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the - // user. For more information, see PutBot. + // user. For more information, see PutBot . VoiceId *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelbuildingservice/api_op_PutBotAlias.go b/service/lexmodelbuildingservice/api_op_PutBotAlias.go index 634ca26898f..0f0a419d5db 100644 --- a/service/lexmodelbuildingservice/api_op_PutBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_PutBotAlias.go @@ -14,7 +14,7 @@ import ( // Creates an alias for the specified version of the bot or replaces an alias for // the specified bot. To change the version of the bot that the alias points to, -// replace the alias. For more information about aliases, see versioning-aliases. +// replace the alias. For more information about aliases, see versioning-aliases . // This operation requires permissions for the lex:PutBotAlias action. func (c *Client) PutBotAlias(ctx context.Context, params *PutBotAliasInput, optFns ...func(*Options)) (*PutBotAliasOutput, error) { if params == nil { @@ -48,11 +48,11 @@ type PutBotAliasInput struct { // This member is required. Name *string - // Identifies a specific revision of the $LATEST version. When you create a new bot - // alias, leave the checksum field blank. If you specify a checksum you get a + // Identifies a specific revision of the $LATEST version. When you create a new + // bot alias, leave the checksum field blank. If you specify a checksum you get a // BadRequestException exception. When you want to update a bot alias, set the // checksum field to the checksum of the most recent revision of the $LATEST - // version. If you don't specify the checksum field, or if the checksum does not + // version. If you don't specify the checksum field, or if the checksum does not // match the $LATEST version, you get a PreconditionFailedException exception. Checksum *string @@ -62,8 +62,8 @@ type PutBotAliasInput struct { // A description of the alias. Description *string - // A list of tags to add to the bot alias. You can only add tags when you create an - // alias, you can't use the PutBotAlias operation to update the tags on a bot + // A list of tags to add to the bot alias. You can only add tags when you create + // an alias, you can't use the PutBotAlias operation to update the tags on a bot // alias. To update tags, use the TagResource operation. Tags []types.Tag diff --git a/service/lexmodelbuildingservice/api_op_PutIntent.go b/service/lexmodelbuildingservice/api_op_PutIntent.go index 8ffc7fe06ba..405e3aec753 100644 --- a/service/lexmodelbuildingservice/api_op_PutIntent.go +++ b/service/lexmodelbuildingservice/api_op_PutIntent.go @@ -17,45 +17,37 @@ import ( // bot, for example, you would create an OrderPizza intent. To create an intent or // replace an existing intent, you must provide the following: // -// * Intent name. For -// example, OrderPizza. +// - Intent name. For example, OrderPizza . // -// * Sample utterances. For example, "Can I order a pizza, -// please." and "I want to order a pizza." +// - Sample utterances. For example, "Can I order a pizza, please." and "I want +// to order a pizza." // -// * Information to be gathered. You -// specify slot types for the information that your bot will request from the user. -// You can specify standard slot types, such as a date or a time, or custom slot -// types such as the size and crust of a pizza. +// - Information to be gathered. You specify slot types for the information that +// your bot will request from the user. You can specify standard slot types, such +// as a date or a time, or custom slot types such as the size and crust of a pizza. // -// * How the intent will be -// fulfilled. You can provide a Lambda function or configure the intent to return -// the intent information to the client application. If you use a Lambda function, -// when all of the intent information is available, Amazon Lex invokes your Lambda -// function. If you configure your intent to return the intent information to the -// client application. +// - How the intent will be fulfilled. You can provide a Lambda function or +// configure the intent to return the intent information to the client application. +// If you use a Lambda function, when all of the intent information is available, +// Amazon Lex invokes your Lambda function. If you configure your intent to return +// the intent information to the client application. // -// You can specify other optional information in the request, -// such as: +// You can specify other optional information in the request, such as: +// - A confirmation prompt to ask the user to confirm an intent. For example, +// "Shall I order your pizza?" +// - A conclusion statement to send to the user after the intent has been +// fulfilled. For example, "I placed your pizza order." +// - A follow-up prompt that asks the user for additional activity. For example, +// asking "Do you want to order a drink with your pizza?" // -// * A confirmation prompt to ask the user to confirm an intent. For -// example, "Shall I order your pizza?" -// -// * A conclusion statement to send to the -// user after the intent has been fulfilled. For example, "I placed your pizza -// order." -// -// * A follow-up prompt that asks the user for additional activity. For -// example, asking "Do you want to order a drink with your pizza?" -// -// If you specify -// an existing intent name to update the intent, Amazon Lex replaces the values in -// the $LATEST version of the intent with the values in the request. Amazon Lex -// removes fields that you don't provide in the request. If you don't specify the -// required fields, Amazon Lex throws an exception. When you update the $LATEST -// version of an intent, the status field of any bot that uses the $LATEST version -// of the intent is set to NOT_BUILT. For more information, see how-it-works. This -// operation requires permissions for the lex:PutIntent action. +// If you specify an existing intent name to update the intent, Amazon Lex +// replaces the values in the $LATEST version of the intent with the values in the +// request. Amazon Lex removes fields that you don't provide in the request. If you +// don't specify the required fields, Amazon Lex throws an exception. When you +// update the $LATEST version of an intent, the status field of any bot that uses +// the $LATEST version of the intent is set to NOT_BUILT . For more information, +// see how-it-works . This operation requires permissions for the lex:PutIntent +// action. func (c *Client) PutIntent(ctx context.Context, params *PutIntentInput, optFns ...func(*Options)) (*PutIntentOutput, error) { if params == nil { params = &PutIntentInput{} @@ -75,10 +67,9 @@ type PutIntentInput struct { // The name of the intent. The name is not case sensitive. The name can't match a // built-in intent name, or a built-in intent name with "AMAZON." removed. For - // example, because there is a built-in intent called AMAZON.HelpIntent, you can't - // create a custom intent called HelpIntent. For a list of built-in intents, see - // Standard Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // example, because there is a built-in intent called AMAZON.HelpIntent , you can't + // create a custom intent called HelpIntent . For a list of built-in intents, see + // Standard Built-in Intents (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. // // This member is required. @@ -88,13 +79,13 @@ type PutIntentInput struct { // intent, leave the checksum field blank. If you specify a checksum you get a // BadRequestException exception. When you want to update a intent, set the // checksum field to the checksum of the most recent revision of the $LATEST - // version. If you don't specify the checksum field, or if the checksum does not + // version. If you don't specify the checksum field, or if the checksum does not // match the $LATEST version, you get a PreconditionFailedException exception. Checksum *string - // The statement that you want Amazon Lex to convey to the user after the intent is - // successfully fulfilled by the Lambda function. This element is relevant only if - // you provide a Lambda function in the fulfillmentActivity. If you return the + // The statement that you want Amazon Lex to convey to the user after the intent + // is successfully fulfilled by the Lambda function. This element is relevant only + // if you provide a Lambda function in the fulfillmentActivity . If you return the // intent to the client application, you can't specify this element. The // followUpPrompt and conclusionStatement are mutually exclusive. You can specify // only one. @@ -106,12 +97,12 @@ type PutIntentInput struct { // you might want to confirm that the order is correct before placing it. For other // intents, such as intents that simply respond to user questions, you might not // need to ask the user for confirmation before providing the information. You you - // must provide both the rejectionStatement and the confirmationPrompt, or neither. + // must provide both the rejectionStatement and the confirmationPrompt , or neither. ConfirmationPrompt *types.Prompt // When set to true a new numbered version of the intent is created. This is the // same as calling the CreateIntentVersion operation. If you do not specify - // createVersion, the default is false. + // createVersion , the default is false . CreateVersion *bool // A description of the intent. @@ -122,7 +113,7 @@ type PutIntentInput struct { // determines that the user is John. Your Lambda function might retrieve John's // information from a backend database and prepopulate some of the values. For // example, if you find that John is gluten intolerant, you might set the - // corresponding intent slot, GlutenIntolerant, to true. You might find John's + // corresponding intent slot, GlutenIntolerant , to true. You might find John's // phone number and set the corresponding session attribute. DialogCodeHook *types.CodeHook @@ -130,23 +121,16 @@ type PutIntentInput struct { // intent. For example, after the OrderPizza intent is fulfilled, you might prompt // the user to order a drink. The action that Amazon Lex takes depends on the // user's response, as follows: - // - // * If the user says "Yes" it responds with the - // clarification prompt that is configured for the bot. - // - // * if the user says "Yes" - // and continues with an utterance that triggers an intent it starts a conversation - // for the intent. - // - // * If the user says "No" it responds with the rejection - // statement configured for the the follow-up prompt. - // - // * If it doesn't recognize - // the utterance it repeats the follow-up prompt again. - // - // The followUpPrompt field - // and the conclusionStatement field are mutually exclusive. You can specify only - // one. + // - If the user says "Yes" it responds with the clarification prompt that is + // configured for the bot. + // - if the user says "Yes" and continues with an utterance that triggers an + // intent it starts a conversation for the intent. + // - If the user says "No" it responds with the rejection statement configured + // for the the follow-up prompt. + // - If it doesn't recognize the utterance it repeats the follow-up prompt + // again. + // The followUpPrompt field and the conclusionStatement field are mutually + // exclusive. You can specify only one. FollowUpPrompt *types.FollowUpPrompt // Required. Describes how the intent is fulfilled. For example, after a user @@ -157,14 +141,14 @@ type PutIntentInput struct { // an order with a pizzeria). FulfillmentActivity *types.FulfillmentActivity - // An array of InputContext objects that lists the contexts that must be active for - // Amazon Lex to choose the intent in a conversation with the user. + // An array of InputContext objects that lists the contexts that must be active + // for Amazon Lex to choose the intent in a conversation with the user. InputContexts []types.InputContext // Configuration information required to use the AMAZON.KendraSearchIntent intent // to connect to an Amazon Kendra index. For more information, see - // AMAZON.KendraSearchIntent - // (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). + // AMAZON.KendraSearchIntent (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html) + // . KendraConfiguration *types.KendraConfiguration // An array of OutputContext objects that lists the contexts that the intent @@ -172,25 +156,24 @@ type PutIntentInput struct { OutputContexts []types.OutputContext // A unique identifier for the built-in intent to base this intent on. To find the - // signature for an intent, see Standard Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // signature for an intent, see Standard Built-in Intents (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. ParentIntentSignature *string - // When the user answers "no" to the question defined in confirmationPrompt, Amazon - // Lex responds with this statement to acknowledge that the intent was canceled. - // You must provide both the rejectionStatement and the confirmationPrompt, or - // neither. + // When the user answers "no" to the question defined in confirmationPrompt , + // Amazon Lex responds with this statement to acknowledge that the intent was + // canceled. You must provide both the rejectionStatement and the + // confirmationPrompt , or neither. RejectionStatement *types.Statement - // An array of utterances (strings) that a user might say to signal the intent. For - // example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". In - // each utterance, a slot name is enclosed in curly braces. + // An array of utterances (strings) that a user might say to signal the intent. + // For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". + // In each utterance, a slot name is enclosed in curly braces. SampleUtterances []string // An array of intent slots. At runtime, Amazon Lex elicits required slot values // from the user using prompts defined in the slots. For more information, see - // how-it-works. + // how-it-works . Slots []types.Slot noSmithyDocumentSerde @@ -198,11 +181,11 @@ type PutIntentInput struct { type PutIntentOutput struct { - // Checksum of the $LATESTversion of the intent created or updated. + // Checksum of the $LATEST version of the intent created or updated. Checksum *string - // After the Lambda function specified in thefulfillmentActivityintent fulfills the - // intent, Amazon Lex conveys this statement to the user. + // After the Lambda function specified in the fulfillmentActivity intent fulfills + // the intent, Amazon Lex conveys this statement to the user. ConclusionStatement *types.Statement // If defined in the intent, Amazon Lex prompts the user to confirm the intent @@ -224,20 +207,21 @@ type PutIntentOutput struct { // input. DialogCodeHook *types.CodeHook - // If defined in the intent, Amazon Lex uses this prompt to solicit additional user - // activity after the intent is fulfilled. + // If defined in the intent, Amazon Lex uses this prompt to solicit additional + // user activity after the intent is fulfilled. FollowUpPrompt *types.FollowUpPrompt - // If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the - // intent after the user provides all of the information required by the intent. + // If defined in the intent, Amazon Lex invokes this Lambda function to fulfill + // the intent after the user provides all of the information required by the + // intent. FulfillmentActivity *types.FulfillmentActivity - // An array of InputContext objects that lists the contexts that must be active for - // Amazon Lex to choose the intent in a conversation with the user. + // An array of InputContext objects that lists the contexts that must be active + // for Amazon Lex to choose the intent in a conversation with the user. InputContexts []types.InputContext - // Configuration information, if any, required to connect to an Amazon Kendra index - // and use the AMAZON.KendraSearchIntent intent. + // Configuration information, if any, required to connect to an Amazon Kendra + // index and use the AMAZON.KendraSearchIntent intent. KendraConfiguration *types.KendraConfiguration // The date that the intent was updated. When you create a resource, the creation @@ -264,7 +248,7 @@ type PutIntentOutput struct { // An array of intent slots that are configured for the intent. Slots []types.Slot - // The version of the intent. For a new intent, the version is always $LATEST. + // The version of the intent. For a new intent, the version is always $LATEST . Version *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelbuildingservice/api_op_PutSlotType.go b/service/lexmodelbuildingservice/api_op_PutSlotType.go index 5bc7129e9d5..a313a65a5ba 100644 --- a/service/lexmodelbuildingservice/api_op_PutSlotType.go +++ b/service/lexmodelbuildingservice/api_op_PutSlotType.go @@ -12,17 +12,17 @@ import ( "time" ) -// Creates a custom slot type or replaces an existing custom slot type. To create a -// custom slot type, specify a name for the slot type and a set of enumeration +// Creates a custom slot type or replaces an existing custom slot type. To create +// a custom slot type, specify a name for the slot type and a set of enumeration // values, which are the values that a slot of this type can assume. For more -// information, see how-it-works. If you specify the name of an existing slot type, -// the fields in the request replace the existing values in the $LATEST version of -// the slot type. Amazon Lex removes the fields that you don't provide in the -// request. If you don't specify required fields, Amazon Lex throws an exception. -// When you update the $LATEST version of a slot type, if a bot uses the $LATEST -// version of an intent that contains the slot type, the bot's status field is set -// to NOT_BUILT. This operation requires permissions for the lex:PutSlotType -// action. +// information, see how-it-works . If you specify the name of an existing slot +// type, the fields in the request replace the existing values in the $LATEST +// version of the slot type. Amazon Lex removes the fields that you don't provide +// in the request. If you don't specify required fields, Amazon Lex throws an +// exception. When you update the $LATEST version of a slot type, if a bot uses +// the $LATEST version of an intent that contains the slot type, the bot's status +// field is set to NOT_BUILT . This operation requires permissions for the +// lex:PutSlotType action. func (c *Client) PutSlotType(ctx context.Context, params *PutSlotTypeInput, optFns ...func(*Options)) (*PutSlotTypeOutput, error) { if params == nil { params = &PutSlotTypeInput{} @@ -42,10 +42,9 @@ type PutSlotTypeInput struct { // The name of the slot type. The name is not case sensitive. The name can't match // a built-in slot type name, or a built-in slot type name with "AMAZON." removed. - // For example, because there is a built-in slot type called AMAZON.DATE, you can't - // create a custom slot type called DATE. For a list of built-in slot types, see - // Slot Type Reference - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) + // For example, because there is a built-in slot type called AMAZON.DATE , you + // can't create a custom slot type called DATE . For a list of built-in slot types, + // see Slot Type Reference (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) // in the Alexa Skills Kit. // // This member is required. @@ -55,20 +54,20 @@ type PutSlotTypeInput struct { // slot type, leave the checksum field blank. If you specify a checksum you get a // BadRequestException exception. When you want to update a slot type, set the // checksum field to the checksum of the most recent revision of the $LATEST - // version. If you don't specify the checksum field, or if the checksum does not + // version. If you don't specify the checksum field, or if the checksum does not // match the $LATEST version, you get a PreconditionFailedException exception. Checksum *string - // When set to true a new numbered version of the slot type is created. This is the - // same as calling the CreateSlotTypeVersion operation. If you do not specify - // createVersion, the default is false. + // When set to true a new numbered version of the slot type is created. This is + // the same as calling the CreateSlotTypeVersion operation. If you do not specify + // createVersion , the default is false . CreateVersion *bool // A description of the slot type. Description *string // A list of EnumerationValue objects that defines the values that the slot type - // can take. Each value can have a list of synonyms, which are additional values + // can take. Each value can have a list of synonyms , which are additional values // that help train the machine learning model about the values that it resolves for // a slot. A regular expression slot type doesn't require enumeration values. All // other slot types require a list of enumeration values. When Amazon Lex resolves @@ -88,19 +87,14 @@ type PutSlotTypeInput struct { // configuration is added to the settings for the parent slot type. SlotTypeConfigurations []types.SlotTypeConfiguration - // Determines the slot resolution strategy that Amazon Lex uses to return slot type - // values. The field can be set to one of the following values: - // - // * ORIGINAL_VALUE - - // Returns the value entered by the user, if the user value is similar to the slot - // value. - // - // * TOP_RESOLUTION - If there is a resolution list for the slot, return - // the first value in the resolution list as the slot type value. If there is no - // resolution list, null is returned. - // - // If you don't specify the - // valueSelectionStrategy, the default is ORIGINAL_VALUE. + // Determines the slot resolution strategy that Amazon Lex uses to return slot + // type values. The field can be set to one of the following values: + // - ORIGINAL_VALUE - Returns the value entered by the user, if the user value is + // similar to the slot value. + // - TOP_RESOLUTION - If there is a resolution list for the slot, return the + // first value in the resolution list as the slot type value. If there is no + // resolution list, null is returned. + // If you don't specify the valueSelectionStrategy , the default is ORIGINAL_VALUE . ValueSelectionStrategy types.SlotValueSelectionStrategy noSmithyDocumentSerde @@ -112,8 +106,8 @@ type PutSlotTypeOutput struct { Checksum *string // True if a new version of the slot type was created. If the createVersion field - // was not specified in the request, the createVersion field is set to false in the - // response. + // was not specified in the request, the createVersion field is set to false in + // the response. CreateVersion *bool // The date that the slot type was created. @@ -140,11 +134,11 @@ type PutSlotTypeOutput struct { SlotTypeConfigurations []types.SlotTypeConfiguration // The slot resolution strategy that Amazon Lex uses to determine the value of the - // slot. For more information, see PutSlotType. + // slot. For more information, see PutSlotType . ValueSelectionStrategy types.SlotValueSelectionStrategy // The version of the slot type. For a new slot type, the version is always - // $LATEST. + // $LATEST . Version *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelbuildingservice/api_op_StartImport.go b/service/lexmodelbuildingservice/api_op_StartImport.go index fb68c553028..858a276e9a0 100644 --- a/service/lexmodelbuildingservice/api_op_StartImport.go +++ b/service/lexmodelbuildingservice/api_op_StartImport.go @@ -30,40 +30,35 @@ func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optF type StartImportInput struct { - // Specifies the action that the StartImport operation should take when there is an - // existing resource with the same name. - // - // * FAIL_ON_CONFLICT - The import operation - // is stopped on the first conflict between a resource in the import file and an - // existing resource. The name of the resource causing the conflict is in the - // failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - // - The import operation proceeds even if there is a conflict with an existing - // resource. The $LASTEST version of the existing resource is overwritten with the - // data from the import file. + // Specifies the action that the StartImport operation should take when there is + // an existing resource with the same name. + // - FAIL_ON_CONFLICT - The import operation is stopped on the first conflict + // between a resource in the import file and an existing resource. The name of the + // resource causing the conflict is in the failureReason field of the response to + // the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even + // if there is a conflict with an existing resource. The $LASTEST version of the + // existing resource is overwritten with the data from the import file. // // This member is required. MergeStrategy types.MergeStrategy - // A zip archive in binary format. The archive should contain one file, a JSON file - // containing the resource to import. The resource should match the type specified - // in the resourceType field. + // A zip archive in binary format. The archive should contain one file, a JSON + // file containing the resource to import. The resource should match the type + // specified in the resourceType field. // // This member is required. Payload []byte // Specifies the type of resource to export. Each resource also exports any // resources that it depends on. - // - // * A bot exports dependent intents. - // - // * An intent - // exports dependent slot types. + // - A bot exports dependent intents. + // - An intent exports dependent slot types. // // This member is required. ResourceType types.ResourceType - // A list of tags to add to the imported bot. You can only add tags when you import - // a bot, you can't add tags to an intent or slot type. + // A list of tags to add to the imported bot. You can only add tags when you + // import a bot, you can't add tags to an intent or slot type. Tags []types.Tag noSmithyDocumentSerde @@ -77,7 +72,7 @@ type StartImportOutput struct { // The identifier for the specific import job. ImportId *string - // The status of the import job. If the status is FAILED, you can get the reason + // The status of the import job. If the status is FAILED , you can get the reason // for the failure using the GetImport operation. ImportStatus types.ImportStatus diff --git a/service/lexmodelbuildingservice/api_op_StartMigration.go b/service/lexmodelbuildingservice/api_op_StartMigration.go index 3b211d34f72..29513ca2fc7 100644 --- a/service/lexmodelbuildingservice/api_op_StartMigration.go +++ b/service/lexmodelbuildingservice/api_op_StartMigration.go @@ -14,9 +14,8 @@ import ( // Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot // when you want to take advantage of the new features of Amazon Lex V2. For more -// information, see Migrating a bot -// (https://docs.aws.amazon.com/lex/latest/dg/migrate.html) in the Amazon Lex -// developer guide. +// information, see Migrating a bot (https://docs.aws.amazon.com/lex/latest/dg/migrate.html) +// in the Amazon Lex developer guide. func (c *Client) StartMigration(ctx context.Context, params *StartMigrationInput, optFns ...func(*Options)) (*StartMigrationOutput, error) { if params == nil { params = &StartMigrationInput{} @@ -35,14 +34,12 @@ func (c *Client) StartMigration(ctx context.Context, params *StartMigrationInput type StartMigrationInput struct { // The strategy used to conduct the migration. - // - // * CREATE_NEW - Creates a new Amazon - // Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot. - // - // * UPDATE_EXISTING - // - Overwrites the existing Amazon Lex V2 bot metadata and the locale being - // migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the - // locale doesn't exist, a new locale is created in the Amazon Lex V2 bot. + // - CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 + // bot to the new bot. + // - UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the + // locale being migrated. It doesn't change any other locales in the Amazon Lex V2 + // bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 + // bot. // // This member is required. MigrationStrategy types.MigrationStrategy @@ -60,13 +57,10 @@ type StartMigrationInput struct { // The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot // to. - // - // * If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW - // migration strategy. - // - // * If the Amazon Lex V2 bot exists, you must use the - // UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 - // bot. + // - If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW + // migration strategy. + // - If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration + // strategy to change the contents of the Amazon Lex V2 bot. // // This member is required. V2BotName *string diff --git a/service/lexmodelbuildingservice/types/enums.go b/service/lexmodelbuildingservice/types/enums.go index 6d319e81685..a9387838f20 100644 --- a/service/lexmodelbuildingservice/types/enums.go +++ b/service/lexmodelbuildingservice/types/enums.go @@ -91,9 +91,9 @@ const ( ExportStatusFailed ExportStatus = "FAILED" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "IN_PROGRESS", @@ -147,9 +147,9 @@ const ( ImportStatusFailed ImportStatus = "FAILED" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "IN_PROGRESS", @@ -375,9 +375,9 @@ const ( ResourceTypeSlotType ResourceType = "SLOT_TYPE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "BOT", @@ -430,9 +430,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/lexmodelbuildingservice/types/errors.go b/service/lexmodelbuildingservice/types/errors.go index dbb6a6b9332..e2144a3e0c3 100644 --- a/service/lexmodelbuildingservice/types/errors.go +++ b/service/lexmodelbuildingservice/types/errors.go @@ -200,7 +200,7 @@ func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault { return sm // trying to delete. The body of the exception contains a JSON object that // describes the resource. { "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT, // -// "resourceReference": { +// "resourceReference": { // // "name": string, "version": string } } type ResourceInUseException struct { diff --git a/service/lexmodelbuildingservice/types/types.go b/service/lexmodelbuildingservice/types/types.go index 4fe8ee7c966..4d3194857fc 100644 --- a/service/lexmodelbuildingservice/types/types.go +++ b/service/lexmodelbuildingservice/types/types.go @@ -60,23 +60,18 @@ type BotChannelAssociation struct { // A text description of the association you are creating. Description *string - // If status is FAILED, Amazon Lex provides the reason that it failed to create the - // association. + // If status is FAILED , Amazon Lex provides the reason that it failed to create + // the association. FailureReason *string // The name of the association between the bot and the channel. Name *string // The status of the bot channel. - // - // * CREATED - The channel has been created and is - // ready for use. - // - // * IN_PROGRESS - Channel creation is in progress. - // - // * FAILED - - // There was an error creating the channel. For information about the reason for - // the failure, see the failureReason field. + // - CREATED - The channel has been created and is ready for use. + // - IN_PROGRESS - Channel creation is in progress. + // - FAILED - There was an error creating the channel. For information about the + // reason for the failure, see the failureReason field. Status ChannelStatus // Specifies the type of association by indicating the type of channel being @@ -105,7 +100,7 @@ type BotMetadata struct { // The status of the bot. Status Status - // The version of the bot. For a new bot, the version is always $LATEST. + // The version of the bot. For a new bot, the version is always $LATEST . Version *string noSmithyDocumentSerde @@ -115,8 +110,7 @@ type BotMetadata struct { type BuiltinIntentMetadata struct { // A unique identifier for the built-in intent. To find the signature for an - // intent, see Standard Built-in Intents - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) + // intent, see Standard Built-in Intents (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents) // in the Alexa Skills Kit. Signature *string @@ -138,9 +132,8 @@ type BuiltinIntentSlot struct { // Provides information about a built in slot type. type BuiltinSlotTypeMetadata struct { - // A unique identifier for the built-in slot type. To find the signature for a slot - // type, see Slot Type Reference - // (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) + // A unique identifier for the built-in slot type. To find the signature for a + // slot type, see Slot Type Reference (https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference) // in the Alexa Skills Kit. Signature *string @@ -155,7 +148,7 @@ type BuiltinSlotTypeMetadata struct { type CodeHook struct { // The version of the request-response that you want Amazon Lex to use to invoke - // your Lambda function. For more information, see using-lambda. + // your Lambda function. For more information, see using-lambda . // // This member is required. MessageVersion *string @@ -175,8 +168,8 @@ type ConversationLogsRequest struct { // CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio // encryption is enabled, this role also provides access permission for the AWS KMS // key used for encrypting audio logs. For more information, see Creating an IAM - // Role and Policy for Conversation Logs - // (https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html). + // Role and Policy for Conversation Logs (https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html) + // . // // This member is required. IamRoleArn *string @@ -207,12 +200,9 @@ type ConversationLogsResponse struct { // value the slot type can take. For example, a pizza ordering bot could have a // slot type that specifies the type of crust that the pizza should have. The slot // type could include the values -// -// * thick -// -// * thin -// -// * stuffed +// - thick +// - thin +// - stuffed type EnumerationValue struct { // The value of the slot type. @@ -236,8 +226,8 @@ type FollowUpPrompt struct { // This member is required. Prompt *Prompt - // If the user answers "no" to the question defined in the prompt field, Amazon Lex - // responds with this statement to acknowledge that the intent was canceled. + // If the user answers "no" to the question defined in the prompt field, Amazon + // Lex responds with this statement to acknowledge that the intent was canceled. // // This member is required. RejectionStatement *Statement @@ -253,15 +243,13 @@ type FollowUpPrompt struct { // presentation. If you need to update the logic, you only update the Lambda // function; you don't need to upgrade your client application. Consider the // following examples: -// -// * In a pizza ordering application, after the user provides -// all of the information for placing an order, you use a Lambda function to place -// an order with a pizzeria. -// -// * In a gaming application, when a user says "pick up -// a rock," this information must go back to the client application so that it can -// perform the operation and update the graphics. In this case, you want Amazon Lex -// to return the intent data to the client. +// - In a pizza ordering application, after the user provides all of the +// information for placing an order, you use a Lambda function to place an order +// with a pizzeria. +// - In a gaming application, when a user says "pick up a rock," this +// information must go back to the client application so that it can perform the +// operation and update the graphics. In this case, you want Amazon Lex to return +// the intent data to the client. type FulfillmentActivity struct { // How the intent should be fulfilled, either by running a Lambda function or by @@ -276,8 +264,8 @@ type FulfillmentActivity struct { noSmithyDocumentSerde } -// The name of a context that must be active for an intent to be selected by Amazon -// Lex. +// The name of a context that must be active for an intent to be selected by +// Amazon Lex. type InputContext struct { // The name of the context. @@ -329,8 +317,8 @@ type IntentMetadata struct { // Provides configuration information for the AMAZON.KendraSearchIntent intent. // When you use this intent, Amazon Lex searches the specified Amazon Kendra index // and returns documents from the index that match the user's utterance. For more -// information, see AMAZON.KendraSearchIntent -// (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html). +// information, see AMAZON.KendraSearchIntent (http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html) +// . type KendraConfiguration struct { // The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the @@ -351,9 +339,8 @@ type KendraConfiguration struct { // A query filter that Amazon Lex sends to Amazon Kendra to filter the response // from the query. The filter is in the format defined by Amazon Kendra. For more - // information, see Filtering queries - // (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html). You can override - // this filter string with a new filter string at runtime. + // information, see Filtering queries (http://docs.aws.amazon.com/kendra/latest/dg/filtering.html) + // . You can override this filter string with a new filter string at runtime. QueryFilterString *string noSmithyDocumentSerde @@ -448,13 +435,10 @@ type MigrationAlert struct { ReferenceURLs []string // The type of alert. There are two kinds of alerts: - // - // * ERROR - There was an issue - // with the migration that can't be resolved. The migration stops. - // - // * WARN - There - // was an issue with the migration that requires manual changes to the new Amazon - // Lex V2 bot. The migration continues. + // - ERROR - There was an issue with the migration that can't be resolved. The + // migration stops. + // - WARN - There was an issue with the migration that requires manual changes to + // the new Amazon Lex V2 bot. The migration continues. Type MigrationAlertType noSmithyDocumentSerde @@ -466,8 +450,8 @@ type MigrationSummary struct { // The unique identifier that Amazon Lex assigned to the migration. MigrationId *string - // The status of the operation. When the status is COMPLETE the bot is available in - // Amazon Lex V2. There may be alerts and warnings that need to be resolved to + // The status of the operation. When the status is COMPLETE the bot is available + // in Amazon Lex V2. There may be alerts and warnings that need to be resolved to // complete the migration. MigrationStatus MigrationStatus @@ -524,7 +508,7 @@ type OutputContext struct { // Obtains information from the user. To define a prompt, provide one or more // messages and specify the number of attempts to get information from the user. If // you provide more than one message, Amazon Lex chooses one of the messages to use -// to prompt the user. For more information, see how-it-works. +// to prompt the user. For more information, see how-it-works . type Prompt struct { // The number of times to prompt the user for information. @@ -541,7 +525,7 @@ type Prompt struct { // A response card. Amazon Lex uses this prompt at runtime, in the PostText API // response. It substitutes session attributes and slot values for placeholders in - // the response card. For more information, see ex-resp-card. + // the response card. For more information, see ex-resp-card . ResponseCard *string noSmithyDocumentSerde @@ -586,8 +570,8 @@ type Slot struct { // Determines whether a slot is obfuscated in conversation logs and stored // utterances. When you obfuscate a slot, the value is replaced by the slot name in // curly braces ({}). For example, if the slot name is "full_name", obfuscated - // values are replaced with "{full_name}". For more information, see Slot - // Obfuscation (https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html). + // values are replaced with "{full_name}". For more information, see Slot + // Obfuscation (https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html) . ObfuscationSetting ObfuscationSetting // Directs Amazon Lex the order in which to elicit this slot value from the user. @@ -596,8 +580,8 @@ type Slot struct { // same priority, the order in which Amazon Lex elicits values is arbitrary. Priority *int32 - // A set of possible responses for the slot type used by text-based clients. A user - // chooses an option from the response card, instead of using text to reply. + // A set of possible responses for the slot type used by text-based clients. A + // user chooses an option from the response card, instead of using text to reply. ResponseCard *string // If you know a specific pattern with which users might respond to an Amazon Lex @@ -623,15 +607,10 @@ type Slot struct { type SlotDefaultValue struct { // The default value for the slot. You can specify one of the following: - // - // * - // #context-name.slot-name - The slot value "slot-name" in the context - // "context-name." - // - // * {attribute} - The slot value of the session attribute - // "attribute." - // - // * 'value' - The discrete value "value." + // - #context-name.slot-name - The slot value "slot-name" in the context + // "context-name." + // - {attribute} - The slot value of the session attribute "attribute." + // - 'value' - The discrete value "value." // // This member is required. DefaultValue *string @@ -693,21 +672,13 @@ type SlotTypeRegexConfiguration struct { // A regular expression used to validate the value of a slot. Use a standard // regular expression. Amazon Lex supports the following characters in the regular // expression: - // - // * A-Z, a-z - // - // * 0-9 - // - // * Unicode characters ("\ u") - // - // Represent Unicode - // characters with four digits, for example "\u0041" or "\u005A". The following - // regular expression operators are not supported: - // - // * Infinite repeaters: *, +, or - // {x,} with no upper bound. - // - // * Wild card (.) + // - A-Z, a-z + // - 0-9 + // - Unicode characters ("\ u") + // Represent Unicode characters with four digits, for example "\u0041" or + // "\u005A". The following regular expression operators are not supported: + // - Infinite repeaters: *, +, or {x,} with no upper bound. + // - Wild card (.) // // This member is required. Pattern *string @@ -715,8 +686,8 @@ type SlotTypeRegexConfiguration struct { noSmithyDocumentSerde } -// A collection of messages that convey information to the user. At runtime, Amazon -// Lex selects the message to convey. +// A collection of messages that convey information to the user. At runtime, +// Amazon Lex selects the message to convey. type Statement struct { // A collection of message objects. @@ -724,10 +695,9 @@ type Statement struct { // This member is required. Messages []Message - // At runtime, if the client is using the PostText - // (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) API, Amazon - // Lex includes the response card in the response. It substitutes all of the - // session attributes and slot values for placeholders in the response card. + // At runtime, if the client is using the PostText (http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) + // API, Amazon Lex includes the response card in the response. It substitutes all + // of the session attributes and slot values for placeholders in the response card. ResponseCard *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_client.go b/service/lexmodelsv2/api_client.go index d7d51961863..c237f0868d8 100644 --- a/service/lexmodelsv2/api_client.go +++ b/service/lexmodelsv2/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go b/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go index 04aa21ed913..c87e38882e7 100644 --- a/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go @@ -48,8 +48,8 @@ type BatchCreateCustomVocabularyItemInput struct { // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -71,8 +71,8 @@ type BatchCreateCustomVocabularyItemOutput struct { // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . LocaleId *string // A list of custom vocabulary items that were successfully created during the diff --git a/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go b/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go index 8428ef0d468..fadb5bcd29c 100644 --- a/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go @@ -48,8 +48,8 @@ type BatchDeleteCustomVocabularyItemInput struct { // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go b/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go index afdab4acd03..c3aa9e08356 100644 --- a/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go @@ -40,16 +40,16 @@ type BatchUpdateCustomVocabularyItemInput struct { // This member is required. BotVersion *string - // A list of custom vocabulary items with updated fields. Each entry must contain a - // phrase and can optionally contain a displayAs and/or a weight. + // A list of custom vocabulary items with updated fields. Each entry must contain + // a phrase and can optionally contain a displayAs and/or a weight. // // This member is required. CustomVocabularyItemList []types.CustomVocabularyItem // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -71,8 +71,8 @@ type BatchUpdateCustomVocabularyItemOutput struct { // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . LocaleId *string // A list of custom vocabulary items that were successfully updated during the diff --git a/service/lexmodelsv2/api_op_BuildBotLocale.go b/service/lexmodelsv2/api_op_BuildBotLocale.go index 3fea6029050..94e249e127c 100644 --- a/service/lexmodelsv2/api_op_BuildBotLocale.go +++ b/service/lexmodelsv2/api_op_BuildBotLocale.go @@ -33,8 +33,7 @@ func (c *Client) BuildBotLocale(ctx context.Context, params *BuildBotLocaleInput type BuildBotLocaleInput struct { // The identifier of the bot to build. The identifier is returned in the response - // from the CreateBot - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) + // from the CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) // operation. // // This member is required. @@ -48,8 +47,8 @@ type BuildBotLocaleInput struct { // The identifier of the language and locale that the bot will be used in. The // string must match one of the supported locales. All of the intents, slot types, // and slots used in the bot must have the same locale. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -64,7 +63,7 @@ type BuildBotLocaleOutput struct { // The bot's build status. When the status is ReadyExpressTesting you can test the // bot using the utterances defined for the intents and slot types. When the status - // is Built, the bot is ready for use and can be tested using any utterance. + // is Built , the bot is ready for use and can be tested using any utterance. BotLocaleStatus types.BotLocaleStatus // The version of the bot that was built. This is only the draft version of the diff --git a/service/lexmodelsv2/api_op_CreateBot.go b/service/lexmodelsv2/api_op_CreateBot.go index 2f252eb0ca2..1bef66a7676 100644 --- a/service/lexmodelsv2/api_op_CreateBot.go +++ b/service/lexmodelsv2/api_op_CreateBot.go @@ -30,8 +30,8 @@ func (c *Client) CreateBot(ctx context.Context, params *CreateBotInput, optFns . type CreateBotInput struct { - // The name of the bot. The bot name must be unique in the account that creates the - // bot. + // The name of the bot. The bot name must be unique in the account that creates + // the bot. // // This member is required. BotName *string diff --git a/service/lexmodelsv2/api_op_CreateBotAlias.go b/service/lexmodelsv2/api_op_CreateBotAlias.go index f02d35eafcc..9a2d80e009d 100644 --- a/service/lexmodelsv2/api_op_CreateBotAlias.go +++ b/service/lexmodelsv2/api_op_CreateBotAlias.go @@ -48,8 +48,7 @@ type CreateBotAliasInput struct { // locales. BotAliasLocaleSettings map[string]types.BotAliasLocaleSettings - // The version of the bot that this alias points to. You can use the UpdateBotAlias - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html) + // The version of the bot that this alias points to. You can use the UpdateBotAlias (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html) // operation to change the bot version associated with the alias. BotVersion *string @@ -62,13 +61,13 @@ type CreateBotAliasInput struct { // A description of the alias. Use this description to help identify the alias. Description *string - // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment - // of user utterances. + // Determines whether Amazon Lex will use Amazon Comprehend to detect the + // sentiment of user utterances. SentimentAnalysisSettings *types.SentimentAnalysisSettings - // A list of tags to add to the bot alias. You can only add tags when you create an - // alias, you can't use the UpdateBotAlias operation to update the tags on a bot - // alias. To update tags, use the TagResource operation. + // A list of tags to add to the bot alias. You can only add tags when you create + // an alias, you can't use the UpdateBotAlias operation to update the tags on a + // bot alias. To update tags, use the TagResource operation. Tags map[string]string noSmithyDocumentSerde @@ -85,9 +84,9 @@ type CreateBotAliasOutput struct { // The name specified for the bot alias. BotAliasName *string - // The current status of the alias. The alias is first put into the Creating state. - // When the alias is ready to be used, it is put into the Available state. You can - // use the DescribeBotAlias operation to get the current state of an alias. + // The current status of the alias. The alias is first put into the Creating + // state. When the alias is ready to be used, it is put into the Available state. + // You can use the DescribeBotAlias operation to get the current state of an alias. BotAliasStatus types.BotAliasStatus // The unique identifier of the bot that this alias applies to. @@ -105,8 +104,8 @@ type CreateBotAliasOutput struct { // The description specified for the bot alias. Description *string - // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment - // of user utterances. + // Determines whether Amazon Lex will use Amazon Comprehend to detect the + // sentiment of user utterances. SentimentAnalysisSettings *types.SentimentAnalysisSettings // A list of tags associated with the bot alias. diff --git a/service/lexmodelsv2/api_op_CreateBotLocale.go b/service/lexmodelsv2/api_op_CreateBotLocale.go index 6c0455815a5..56009c667ac 100644 --- a/service/lexmodelsv2/api_op_CreateBotLocale.go +++ b/service/lexmodelsv2/api_op_CreateBotLocale.go @@ -12,10 +12,10 @@ import ( "time" ) -// Creates a locale in the bot. The locale contains the intents and slot types that -// the bot uses in conversations with users in the specified language and locale. -// You must add a locale to a bot before you can add intents and slot types to the -// bot. +// Creates a locale in the bot. The locale contains the intents and slot types +// that the bot uses in conversations with users in the specified language and +// locale. You must add a locale to a bot before you can add intents and slot types +// to the bot. func (c *Client) CreateBotLocale(ctx context.Context, params *CreateBotLocaleInput, optFns ...func(*Options)) (*CreateBotLocaleOutput, error) { if params == nil { params = &CreateBotLocaleInput{} @@ -47,28 +47,24 @@ type CreateBotLocaleInput struct { // The identifier of the language and locale that the bot will be used in. The // string must match one of the supported locales. All of the intents, slot types, // and slots used in the bot must have the same locale. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string - // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, - // AMAZON.KendraSearchIntent, or both when returning alternative intents. + // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent + // , AMAZON.KendraSearchIntent , or both when returning alternative intents. // AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they // are configured for the bot. For example, suppose a bot is configured with the - // confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns + // confidence threshold of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns // three alternative intents with the following confidence scores: IntentA (0.70), // IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation // would be: - // - // * AMAZON.FallbackIntent - // - // * IntentA - // - // * IntentB - // - // * IntentC + // - AMAZON.FallbackIntent + // - IntentA + // - IntentB + // - IntentC // // This member is required. NluIntentConfidenceThreshold *float64 @@ -91,11 +87,11 @@ type CreateBotLocaleOutput struct { // The status of the bot. When the status is Creating the bot locale is being // configured. When the status is Building Amazon Lex is building the bot for - // testing and use. If the status of the bot is ReadyExpressTesting, you can test + // testing and use. If the status of the bot is ReadyExpressTesting , you can test // the bot using the exact utterances specified in the bots' intents. When the bot - // is ready for full testing or to run, the status is Built. If there was a problem - // with building the bot, the status is Failed. If the bot was saved but not built, - // the status is NotBuilt. + // is ready for full testing or to run, the status is Built . If there was a + // problem with building the bot, the status is Failed . If the bot was saved but + // not built, the status is NotBuilt . BotLocaleStatus types.BotLocaleStatus // The specified bot version. diff --git a/service/lexmodelsv2/api_op_CreateBotVersion.go b/service/lexmodelsv2/api_op_CreateBotVersion.go index 1c83861ac54..0353836b2c1 100644 --- a/service/lexmodelsv2/api_op_CreateBotVersion.go +++ b/service/lexmodelsv2/api_op_CreateBotVersion.go @@ -60,8 +60,8 @@ type CreateBotVersionOutput struct { BotId *string // When you send a request to create or update a bot, Amazon Lex sets the status - // response element to Creating. After Amazon Lex builds the bot, it sets status to - // Available. If Amazon Lex can't build the bot, it sets status to Failed. + // response element to Creating . After Amazon Lex builds the bot, it sets status + // to Available . If Amazon Lex can't build the bot, it sets status to Failed . BotStatus types.BotStatus // The version number assigned to the version. diff --git a/service/lexmodelsv2/api_op_CreateExport.go b/service/lexmodelsv2/api_op_CreateExport.go index d3b9059b950..2e538cbaada 100644 --- a/service/lexmodelsv2/api_op_CreateExport.go +++ b/service/lexmodelsv2/api_op_CreateExport.go @@ -17,8 +17,7 @@ import ( // bot. You can create an archive that contains the complete definition of a bot, // or you can specify that the archive contain only the definition of a single bot // locale. For more information about exporting bots, and about the structure of -// the export archive, see Importing and exporting bots -// (https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html) +// the export archive, see Importing and exporting bots (https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html) func (c *Client) CreateExport(ctx context.Context, params *CreateExportInput, optFns ...func(*Options)) (*CreateExportOutput, error) { if params == nil { params = &CreateExportInput{} @@ -63,9 +62,8 @@ type CreateExportOutput struct { // An identifier for a specific request to create an export. ExportId *string - // The status of the export. When the status is Completed, you can use the - // DescribeExport - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) + // The status of the export. When the status is Completed , you can use the + // DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) // operation to get the pre-signed S3 URL link to your exported bot or bot locale. ExportStatus types.ExportStatus diff --git a/service/lexmodelsv2/api_op_CreateIntent.go b/service/lexmodelsv2/api_op_CreateIntent.go index 8836c87932f..5d5bb05480a 100644 --- a/service/lexmodelsv2/api_op_CreateIntent.go +++ b/service/lexmodelsv2/api_op_CreateIntent.go @@ -14,32 +14,23 @@ import ( // Creates an intent. To define the interaction between the user and your bot, you // define one or more intents. For example, for a pizza ordering bot you would -// create an OrderPizza intent. When you create an intent, you must provide a name. -// You can optionally provide the following: -// -// * Sample utterances. For example, "I -// want to order a pizza" and "Can I order a pizza." You can't provide utterances -// for built-in intents. -// -// * Information to be gathered. You specify slots for the -// information that you bot requests from the user. You can specify standard slot -// types, such as date and time, or custom slot types for your application. -// -// * How -// the intent is fulfilled. You can provide a Lambda function or configure the -// intent to return the intent information to your client application. If you use a -// Lambda function, Amazon Lex invokes the function when all of the intent -// information is available. -// -// * A confirmation prompt to send to the user to -// confirm an intent. For example, "Shall I order your pizza?" -// -// * A conclusion -// statement to send to the user after the intent is fulfilled. For example, "I -// ordered your pizza." -// -// * A follow-up prompt that asks the user for additional -// activity. For example, "Do you want a drink with your pizza?" +// create an OrderPizza intent. When you create an intent, you must provide a +// name. You can optionally provide the following: +// - Sample utterances. For example, "I want to order a pizza" and "Can I order +// a pizza." You can't provide utterances for built-in intents. +// - Information to be gathered. You specify slots for the information that you +// bot requests from the user. You can specify standard slot types, such as date +// and time, or custom slot types for your application. +// - How the intent is fulfilled. You can provide a Lambda function or configure +// the intent to return the intent information to your client application. If you +// use a Lambda function, Amazon Lex invokes the function when all of the intent +// information is available. +// - A confirmation prompt to send to the user to confirm an intent. For +// example, "Shall I order your pizza?" +// - A conclusion statement to send to the user after the intent is fulfilled. +// For example, "I ordered your pizza." +// - A follow-up prompt that asks the user for additional activity. For example, +// "Do you want a drink with your pizza?" func (c *Client) CreateIntent(ctx context.Context, params *CreateIntentInput, optFns ...func(*Options)) (*CreateIntentOutput, error) { if params == nil { params = &CreateIntentInput{} @@ -75,8 +66,8 @@ type CreateIntentInput struct { // The identifier of the language and locale where this intent is used. All of the // bots, slot types, and slots used by the intent must have the same locale. For - // more information, see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -85,13 +76,13 @@ type CreateIntentInput struct { // lists. Description *string - // Specifies that Amazon Lex invokes the alias Lambda function for each user input. - // You can invoke this Lambda function to personalize user interaction. For + // Specifies that Amazon Lex invokes the alias Lambda function for each user + // input. You can invoke this Lambda function to personalize user interaction. For // example, suppose that your bot determines that the user's name is John. You // Lambda function might retrieve John's information from a backend database and // prepopulate some of the values. For example, if you find that John is gluten // intolerant, you might set the corresponding intent slot, glutenIntolerant to - // true. You might find John's phone number and set the corresponding session + // true . You might find John's phone number and set the corresponding session // attribute. DialogCodeHook *types.DialogCodeHookSettings diff --git a/service/lexmodelsv2/api_op_CreateResourcePolicy.go b/service/lexmodelsv2/api_op_CreateResourcePolicy.go index 0dcd90ab4e8..1af089eadf1 100644 --- a/service/lexmodelsv2/api_op_CreateResourcePolicy.go +++ b/service/lexmodelsv2/api_op_CreateResourcePolicy.go @@ -31,9 +31,8 @@ type CreateResourcePolicyInput struct { // A resource policy to add to the resource. The policy is a JSON structure that // contains one or more statements that define the policy. The policy must follow // the IAM syntax. For more information about the contents of a JSON policy - // document, see IAM JSON policy reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html). If - // the policy isn't valid, Amazon Lex returns a validation exception. + // document, see IAM JSON policy reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // . If the policy isn't valid, Amazon Lex returns a validation exception. // // This member is required. Policy *string diff --git a/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go b/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go index f02647fed67..15ec0035fc1 100644 --- a/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go +++ b/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a new resource policy statement to a bot or bot alias. If a resource policy -// exists, the statement is added to the current resource policy. If a policy -// doesn't exist, a new policy is created. You can't create a resource policy -// statement that allows cross-account access. +// Adds a new resource policy statement to a bot or bot alias. If a resource +// policy exists, the statement is added to the current resource policy. If a +// policy doesn't exist, a new policy is created. You can't create a resource +// policy statement that allows cross-account access. func (c *Client) CreateResourcePolicyStatement(ctx context.Context, params *CreateResourcePolicyStatementInput, optFns ...func(*Options)) (*CreateResourcePolicyStatementOutput, error) { if params == nil { params = &CreateResourcePolicyStatementInput{} @@ -34,8 +34,8 @@ type CreateResourcePolicyStatementInput struct { // The Amazon Lex action that this policy either allows or denies. The action must // apply to the resource type of the specified ARN. For more information, see - // Actions, resources, and condition keys for Amazon Lex V2 - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html). + // Actions, resources, and condition keys for Amazon Lex V2 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html) + // . // // This member is required. Action []string @@ -47,8 +47,8 @@ type CreateResourcePolicyStatementInput struct { // An IAM principal, such as an IAM users, IAM roles, or AWS services that is // allowed or denied access to a resource. For more information, see AWS JSON - // policy elements: Principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). + // policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) + // . // // This member is required. Principal []types.Principal @@ -61,8 +61,8 @@ type CreateResourcePolicyStatementInput struct { // The name of the statement. The ID is the same as the Sid IAM property. The // statement name must be unique within the policy. For more information, see IAM - // JSON policy elements: Sid - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html). + // JSON policy elements: Sid (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) + // . // // This member is required. StatementId *string @@ -70,8 +70,8 @@ type CreateResourcePolicyStatementInput struct { // Specifies a condition when the policy is in effect. If the principal of the // policy is a service principal, you must provide two condition blocks, one with a // SourceAccount global condition key and one with a SourceArn global condition - // key. For more information, see IAM JSON policy elements: Condition - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html). + // key. For more information, see IAM JSON policy elements: Condition (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) + // . Condition map[string]map[string]string // The identifier of the revision of the policy to edit. If this revision ID diff --git a/service/lexmodelsv2/api_op_CreateSlot.go b/service/lexmodelsv2/api_op_CreateSlot.go index f4576520bae..57c805cd5f8 100644 --- a/service/lexmodelsv2/api_op_CreateSlot.go +++ b/service/lexmodelsv2/api_op_CreateSlot.go @@ -51,14 +51,14 @@ type CreateSlotInput struct { // The identifier of the language and locale that the slot will be used in. The // string must match one of the supported locales. All of the bots, intents, slot // types used by the slot must have the same locale. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string - // The name of the slot. Slot names must be unique within the bot that contains the - // slot. + // The name of the slot. Slot names must be unique within the bot that contains + // the slot. // // This member is required. SlotName *string @@ -74,18 +74,18 @@ type CreateSlotInput struct { // Indicates whether the slot returns multiple values in one response. Multi-value // slots are only available in the en-US locale. If you set this value to true in - // any other locale, Amazon Lex throws a ValidationException. If the - // multipleValuesSetting is not set, the default value is false. + // any other locale, Amazon Lex throws a ValidationException . If the + // multipleValuesSetting is not set, the default value is false . MultipleValuesSetting *types.MultipleValuesSetting // Determines how slot values are used in Amazon CloudWatch logs. If the value of - // the obfuscationSetting parameter is DefaultObfuscation, slot values are - // obfuscated in the log output. If the value is None, the actual value is present + // the obfuscationSetting parameter is DefaultObfuscation , slot values are + // obfuscated in the log output. If the value is None , the actual value is present // in the log output. The default is to obfuscate values in the CloudWatch logs. ObfuscationSetting *types.ObfuscationSetting - // The unique identifier for the slot type associated with this slot. The slot type - // determines the values that can be entered into the slot. + // The unique identifier for the slot type associated with this slot. The slot + // type determines the values that can be entered into the slot. SlotTypeId *string // Specifications for the constituent sub slots and the expression for the diff --git a/service/lexmodelsv2/api_op_CreateSlotType.go b/service/lexmodelsv2/api_op_CreateSlotType.go index 2d6da5d2c20..b150f7cb0a7 100644 --- a/service/lexmodelsv2/api_op_CreateSlotType.go +++ b/service/lexmodelsv2/api_op_CreateSlotType.go @@ -45,8 +45,8 @@ type CreateSlotTypeInput struct { // The identifier of the language and locale that the slot type will be used in. // The string must match one of the supported locales. All of the bots, intents, // and slots used by the slot type must have the same locale. For more information, - // see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -78,17 +78,12 @@ type CreateSlotTypeInput struct { // Determines the strategy that Amazon Lex uses to select a value from the list of // possible values. The field can be set to one of the following values: - // - // * - // OriginalValue - Returns the value entered by the user, if the user value is - // similar to the slot value. - // - // * TopResolution - If there is a resolution list for - // the slot, return the first value in the resolution list. If there is no - // resolution list, return null. - // - // If you don't specify the valueSelectionSetting - // parameter, the default is OriginalValue. + // - OriginalValue - Returns the value entered by the user, if the user value is + // similar to the slot value. + // - TopResolution - If there is a resolution list for the slot, return the first + // value in the resolution list. If there is no resolution list, return null. + // If you don't specify the valueSelectionSetting parameter, the default is + // OriginalValue . ValueSelectionSetting *types.SlotValueSelectionSetting noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_CreateUploadUrl.go b/service/lexmodelsv2/api_op_CreateUploadUrl.go index b1df95b8469..09cf06a1885 100644 --- a/service/lexmodelsv2/api_op_CreateUploadUrl.go +++ b/service/lexmodelsv2/api_op_CreateUploadUrl.go @@ -33,8 +33,7 @@ type CreateUploadUrlInput struct { type CreateUploadUrlOutput struct { - // An identifier for a unique import job. Use it when you call the StartImport - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html) + // An identifier for a unique import job. Use it when you call the StartImport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html) // operation. ImportId *string diff --git a/service/lexmodelsv2/api_op_DeleteBot.go b/service/lexmodelsv2/api_op_DeleteBot.go index 0f557e339ee..474715bbc38 100644 --- a/service/lexmodelsv2/api_op_DeleteBot.go +++ b/service/lexmodelsv2/api_op_DeleteBot.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes all versions of a bot, including the Draft version. To delete a specific -// version, use the DeleteBotVersion operation. When you delete a bot, all of the -// resources contained in the bot are also deleted. Deleting a bot removes all -// locales, intents, slot, and slot types defined for the bot. If a bot has an -// alias, the DeleteBot operation returns a ResourceInUseException exception. If -// you want to delete the bot and the alias, set the skipResourceInUseCheck -// parameter to true. +// Deletes all versions of a bot, including the Draft version. To delete a +// specific version, use the DeleteBotVersion operation. When you delete a bot, +// all of the resources contained in the bot are also deleted. Deleting a bot +// removes all locales, intents, slot, and slot types defined for the bot. If a bot +// has an alias, the DeleteBot operation returns a ResourceInUseException +// exception. If you want to delete the bot and the alias, set the +// skipResourceInUseCheck parameter to true . func (c *Client) DeleteBot(ctx context.Context, params *DeleteBotInput, optFns ...func(*Options)) (*DeleteBotOutput, error) { if params == nil { params = &DeleteBotInput{} diff --git a/service/lexmodelsv2/api_op_DeleteBotLocale.go b/service/lexmodelsv2/api_op_DeleteBotLocale.go index 9785822d9ab..297194ee179 100644 --- a/service/lexmodelsv2/api_op_DeleteBotLocale.go +++ b/service/lexmodelsv2/api_op_DeleteBotLocale.go @@ -42,7 +42,7 @@ type DeleteBotLocaleInput struct { // The identifier of the language and locale that will be deleted. The string must // match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DeleteBotVersion.go b/service/lexmodelsv2/api_op_DeleteBotVersion.go index e72abdccd0c..437935f813c 100644 --- a/service/lexmodelsv2/api_op_DeleteBotVersion.go +++ b/service/lexmodelsv2/api_op_DeleteBotVersion.go @@ -12,8 +12,7 @@ import ( ) // Deletes a specific version of a bot. To delete all versions of a bot, use the -// DeleteBot -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html) +// DeleteBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html) // operation. func (c *Client) DeleteBotVersion(ctx context.Context, params *DeleteBotVersionInput, optFns ...func(*Options)) (*DeleteBotVersionOutput, error) { if params == nil { diff --git a/service/lexmodelsv2/api_op_DeleteExport.go b/service/lexmodelsv2/api_op_DeleteExport.go index 22023d6e25b..326489edbe2 100644 --- a/service/lexmodelsv2/api_op_DeleteExport.go +++ b/service/lexmodelsv2/api_op_DeleteExport.go @@ -43,10 +43,8 @@ type DeleteExportOutput struct { ExportId *string // The current status of the deletion. When the deletion is complete, the export - // will no longer be returned by the ListExports - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) - // operation and calls to the DescribeExport - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) + // will no longer be returned by the ListExports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) + // operation and calls to the DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) // operation with the export identifier will fail. ExportStatus types.ExportStatus diff --git a/service/lexmodelsv2/api_op_DeleteImport.go b/service/lexmodelsv2/api_op_DeleteImport.go index 835b64a5b33..fa25c990d1b 100644 --- a/service/lexmodelsv2/api_op_DeleteImport.go +++ b/service/lexmodelsv2/api_op_DeleteImport.go @@ -43,10 +43,8 @@ type DeleteImportOutput struct { ImportId *string // The current status of the deletion. When the deletion is complete, the import - // will no longer be returned by the ListImports - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) - // operation and calls to the DescribeImport - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html) + // will no longer be returned by the ListImports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) + // operation and calls to the DescribeImport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html) // operation with the import identifier will fail. ImportStatus types.ImportStatus diff --git a/service/lexmodelsv2/api_op_DeleteIntent.go b/service/lexmodelsv2/api_op_DeleteIntent.go index eb722447a18..b350c9e7bb7 100644 --- a/service/lexmodelsv2/api_op_DeleteIntent.go +++ b/service/lexmodelsv2/api_op_DeleteIntent.go @@ -46,8 +46,8 @@ type DeleteIntentInput struct { // The identifier of the language and locale where the bot will be deleted. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DeleteResourcePolicy.go b/service/lexmodelsv2/api_op_DeleteResourcePolicy.go index 583acdce46f..175440e02ee 100644 --- a/service/lexmodelsv2/api_op_DeleteResourcePolicy.go +++ b/service/lexmodelsv2/api_op_DeleteResourcePolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes an existing policy from a bot or bot alias. If the resource doesn't have -// a policy attached, Amazon Lex returns an exception. +// Removes an existing policy from a bot or bot alias. If the resource doesn't +// have a policy attached, Amazon Lex returns an exception. func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} diff --git a/service/lexmodelsv2/api_op_DeleteSlot.go b/service/lexmodelsv2/api_op_DeleteSlot.go index 172a38d5653..b7fe8852504 100644 --- a/service/lexmodelsv2/api_op_DeleteSlot.go +++ b/service/lexmodelsv2/api_op_DeleteSlot.go @@ -45,8 +45,8 @@ type DeleteSlotInput struct { // The identifier of the language and locale that the slot will be deleted from. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DeleteSlotType.go b/service/lexmodelsv2/api_op_DeleteSlotType.go index dc0fef4defe..ad073b89ff9 100644 --- a/service/lexmodelsv2/api_op_DeleteSlotType.go +++ b/service/lexmodelsv2/api_op_DeleteSlotType.go @@ -12,7 +12,7 @@ import ( // Deletes a slot type from a bot locale. If a slot is using the slot type, Amazon // Lex throws a ResourceInUseException exception. To avoid the exception, set the -// skipResourceInUseCheck parameter to true. +// skipResourceInUseCheck parameter to true . func (c *Client) DeleteSlotType(ctx context.Context, params *DeleteSlotTypeInput, optFns ...func(*Options)) (*DeleteSlotTypeOutput, error) { if params == nil { params = &DeleteSlotTypeInput{} @@ -42,8 +42,8 @@ type DeleteSlotTypeInput struct { // The identifier of the language and locale that the slot type will be deleted // from. The string must match one of the supported locales. For more information, - // see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DeleteUtterances.go b/service/lexmodelsv2/api_op_DeleteUtterances.go index d66dbf1a6cc..29463d12a44 100644 --- a/service/lexmodelsv2/api_op_DeleteUtterances.go +++ b/service/lexmodelsv2/api_op_DeleteUtterances.go @@ -12,8 +12,7 @@ import ( // Deletes stored utterances. Amazon Lex stores the utterances that users send to // your bot. Utterances are stored for 15 days for use with the -// ListAggregatedUtterances -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) +// ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) // operation, and then stored indefinitely for use in improving the ability of your // bot to respond to user input.. Use the DeleteUtterances operation to manually // delete utterances for a specific session. When you use the DeleteUtterances @@ -44,15 +43,13 @@ type DeleteUtterancesInput struct { // The identifier of the language and locale where the utterances were collected. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . LocaleId *string // The unique identifier of the session with the user. The ID is returned in the - // response from the RecognizeText - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html) - // and RecognizeUtterance - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html) + // response from the RecognizeText (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html) + // and RecognizeUtterance (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html) // operations. SessionId *string diff --git a/service/lexmodelsv2/api_op_DescribeBot.go b/service/lexmodelsv2/api_op_DescribeBot.go index d5c724e4940..9a40ab35b45 100644 --- a/service/lexmodelsv2/api_op_DescribeBot.go +++ b/service/lexmodelsv2/api_op_DescribeBot.go @@ -69,7 +69,7 @@ type DescribeBotOutput struct { // The description of the bot. Description *string - // If the botStatus is Failed, this contains a list of reasons that the bot + // If the botStatus is Failed , this contains a list of reasons that the bot // couldn't be built. FailureReasons []string @@ -173,9 +173,9 @@ type BotAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotAvailableWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotAvailableWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/lexmodelsv2/api_op_DescribeBotAlias.go b/service/lexmodelsv2/api_op_DescribeBotAlias.go index 9a28315e3c8..4e032e72e17 100644 --- a/service/lexmodelsv2/api_op_DescribeBotAlias.go +++ b/service/lexmodelsv2/api_op_DescribeBotAlias.go @@ -49,8 +49,8 @@ type DescribeBotAliasInput struct { type DescribeBotAliasOutput struct { - // A list of events that affect a bot alias. For example, an event is recorded when - // the version that the alias points to changes. + // A list of events that affect a bot alias. For example, an event is recorded + // when the version that the alias points to changes. BotAliasHistoryEvents []types.BotAliasHistoryEvent // The identifier of the bot alias. @@ -62,8 +62,8 @@ type DescribeBotAliasOutput struct { // The name of the bot alias. BotAliasName *string - // The current status of the alias. When the alias is Available, the alias is ready - // for use with your bot. + // The current status of the alias. When the alias is Available , the alias is + // ready for use with your bot. BotAliasStatus types.BotAliasStatus // The identifier of the bot associated with the bot alias. @@ -88,8 +88,8 @@ type DescribeBotAliasOutput struct { // A list of the networks to which the bot alias you described belongs. ParentBotNetworks []types.ParentBotNetwork - // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment - // of user utterances. + // Determines whether Amazon Lex will use Amazon Comprehend to detect the + // sentiment of user utterances. SentimentAnalysisSettings *types.SentimentAnalysisSettings // Metadata pertaining to the operation's result. @@ -182,9 +182,9 @@ type BotAliasAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotAliasAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotAliasAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -232,10 +232,10 @@ func (w *BotAliasAvailableWaiter) Wait(ctx context.Context, params *DescribeBotA return err } -// WaitForOutput calls the waiter function for BotAliasAvailable waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for BotAliasAvailable waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *BotAliasAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeBotAliasInput, maxWaitDur time.Duration, optFns ...func(*BotAliasAvailableWaiterOptions)) (*DescribeBotAliasOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/lexmodelsv2/api_op_DescribeBotLocale.go b/service/lexmodelsv2/api_op_DescribeBotLocale.go index 65a85867d0a..670f20855bc 100644 --- a/service/lexmodelsv2/api_op_DescribeBotLocale.go +++ b/service/lexmodelsv2/api_op_DescribeBotLocale.go @@ -45,8 +45,8 @@ type DescribeBotLocaleInput struct { BotVersion *string // The unique identifier of the locale to describe. The string must match one of - // the supported locales. For more information, see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -63,7 +63,7 @@ type DescribeBotLocaleOutput struct { // place for the locale. BotLocaleHistoryEvents []types.BotLocaleHistoryEvent - // The status of the bot. If the status is Failed, the reasons for the failure are + // The status of the bot. If the status is Failed , the reasons for the failure are // listed in the failureReasons field. BotLocaleStatus types.BotLocaleStatus @@ -76,7 +76,7 @@ type DescribeBotLocaleOutput struct { // The description of the locale. Description *string - // if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the + // if botLocaleStatus is Failed , Amazon Lex explains why it failed to build the // bot. FailureReasons []string @@ -199,9 +199,9 @@ type BotLocaleBuiltWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotLocaleBuiltWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotLocaleBuiltWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -410,9 +410,9 @@ type BotLocaleCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotLocaleCreatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotLocaleCreatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -640,10 +640,10 @@ type BotLocaleExpressTestingAvailableWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotLocaleExpressTestingAvailableWaiter will use default max delay of - // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to - // the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotLocaleExpressTestingAvailableWaiter will use default max delay + // of 120 seconds. Note that MaxDelay must resolve to value greater than or equal + // to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/lexmodelsv2/api_op_DescribeBotRecommendation.go b/service/lexmodelsv2/api_op_DescribeBotRecommendation.go index 2f6b1af57c0..1296a639ee4 100644 --- a/service/lexmodelsv2/api_op_DescribeBotRecommendation.go +++ b/service/lexmodelsv2/api_op_DescribeBotRecommendation.go @@ -48,10 +48,10 @@ type DescribeBotRecommendationInput struct { // This member is required. BotVersion *string - // The identifier of the language and locale of the bot recommendation to describe. - // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // The identifier of the language and locale of the bot recommendation to + // describe. The string must match one of the supported locales. For more + // information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -67,8 +67,9 @@ type DescribeBotRecommendationOutput struct { // The identifier of the bot recommendation being described. BotRecommendationId *string - // The object representing the URL of the bot definition, the URL of the associated - // transcript and a statistical summary of the bot recommendation results. + // The object representing the URL of the bot definition, the URL of the + // associated transcript and a statistical summary of the bot recommendation + // results. BotRecommendationResults *types.BotRecommendationResults // The status of the bot recommendation. If the status is Failed, then the reasons @@ -81,9 +82,9 @@ type DescribeBotRecommendationOutput struct { // The date and time that the bot recommendation was created. CreationDateTime *time.Time - // The object representing the passwords that were used to encrypt the data related - // to the bot recommendation results, as well as the KMS key ARN used to encrypt - // the associated metadata. + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used to + // encrypt the associated metadata. EncryptionSetting *types.EncryptionSetting // If botRecommendationStatus is Failed, Amazon Lex explains why. diff --git a/service/lexmodelsv2/api_op_DescribeBotVersion.go b/service/lexmodelsv2/api_op_DescribeBotVersion.go index 1a7da9cd29c..25e3a683d49 100644 --- a/service/lexmodelsv2/api_op_DescribeBotVersion.go +++ b/service/lexmodelsv2/api_op_DescribeBotVersion.go @@ -59,7 +59,7 @@ type DescribeBotVersionOutput struct { // The name of the bot that contains the version. BotName *string - // The current status of the bot. When the status is Available, the bot version is + // The current status of the bot. When the status is Available , the bot version is // ready for use. BotStatus types.BotStatus @@ -78,7 +78,7 @@ type DescribeBotVersionOutput struct { // The description specified for the bot. Description *string - // If the botStatus is Failed, this contains a list of reasons that the version + // If the botStatus is Failed , this contains a list of reasons that the version // couldn't be built. FailureReasons []string @@ -184,9 +184,10 @@ type BotVersionAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotVersionAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotVersionAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -226,9 +227,9 @@ func NewBotVersionAvailableWaiter(client DescribeBotVersionAPIClient, optFns ... } } -// Wait calls the waiter function for BotVersionAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for BotVersionAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *BotVersionAvailableWaiter) Wait(ctx context.Context, params *DescribeBotVersionInput, maxWaitDur time.Duration, optFns ...func(*BotVersionAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/lexmodelsv2/api_op_DescribeCustomVocabularyMetadata.go b/service/lexmodelsv2/api_op_DescribeCustomVocabularyMetadata.go index e02c2bf423e..1b53afb5739 100644 --- a/service/lexmodelsv2/api_op_DescribeCustomVocabularyMetadata.go +++ b/service/lexmodelsv2/api_op_DescribeCustomVocabularyMetadata.go @@ -41,7 +41,7 @@ type DescribeCustomVocabularyMetadataInput struct { BotVersion *string // The locale to return the custom vocabulary information for. The locale must be - // en_GB. + // en_GB . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DescribeExport.go b/service/lexmodelsv2/api_op_DescribeExport.go index d7b7a1ac690..0cb9b624aa2 100644 --- a/service/lexmodelsv2/api_op_DescribeExport.go +++ b/service/lexmodelsv2/api_op_DescribeExport.go @@ -54,12 +54,12 @@ type DescribeExportOutput struct { // The unique identifier of the described export. ExportId *string - // The status of the export. When the status is Complete the export archive file is - // available for download. + // The status of the export. When the status is Complete the export archive file + // is available for download. ExportStatus types.ExportStatus - // If the exportStatus is failed, contains one or more reasons why the export could - // not be completed. + // If the exportStatus is failed, contains one or more reasons why the export + // could not be completed. FailureReasons []string // The file format used in the files that describe the resource. @@ -161,8 +161,8 @@ type BotExportCompletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotExportCompletedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotExportCompletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/lexmodelsv2/api_op_DescribeImport.go b/service/lexmodelsv2/api_op_DescribeImport.go index cb8c2908791..96c28a59fee 100644 --- a/service/lexmodelsv2/api_op_DescribeImport.go +++ b/service/lexmodelsv2/api_op_DescribeImport.go @@ -47,7 +47,7 @@ type DescribeImportOutput struct { // The date and time that the import was created. CreationDateTime *time.Time - // If the importStatus field is Failed, this provides one or more reasons for the + // If the importStatus field is Failed , this provides one or more reasons for the // failure. FailureReasons []string @@ -166,8 +166,8 @@ type BotImportCompletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BotImportCompletedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BotImportCompletedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/lexmodelsv2/api_op_DescribeIntent.go b/service/lexmodelsv2/api_op_DescribeIntent.go index 27d9f620b90..11510b4cf50 100644 --- a/service/lexmodelsv2/api_op_DescribeIntent.go +++ b/service/lexmodelsv2/api_op_DescribeIntent.go @@ -47,7 +47,7 @@ type DescribeIntentInput struct { // The identifier of the language and locale of the intent to describe. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_DescribeResourcePolicy.go b/service/lexmodelsv2/api_op_DescribeResourcePolicy.go index 0ddffe71bdc..d7c0ed52d64 100644 --- a/service/lexmodelsv2/api_op_DescribeResourcePolicy.go +++ b/service/lexmodelsv2/api_op_DescribeResourcePolicy.go @@ -39,9 +39,9 @@ type DescribeResourcePolicyInput struct { type DescribeResourcePolicyOutput struct { - // The JSON structure that contains the resource policy. For more information about - // the contents of a JSON policy document, see IAM JSON policy reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html). + // The JSON structure that contains the resource policy. For more information + // about the contents of a JSON policy document, see IAM JSON policy reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // . Policy *string // The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy diff --git a/service/lexmodelsv2/api_op_DescribeSlot.go b/service/lexmodelsv2/api_op_DescribeSlot.go index b8191becb5a..134de1e7e71 100644 --- a/service/lexmodelsv2/api_op_DescribeSlot.go +++ b/service/lexmodelsv2/api_op_DescribeSlot.go @@ -47,7 +47,7 @@ type DescribeSlotInput struct { // The identifier of the language and locale of the slot to describe. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -83,11 +83,11 @@ type DescribeSlotOutput struct { // The language and locale specified for the slot. LocaleId *string - // Indicates whether the slot accepts multiple values in a single utterance. If the - // multipleValuesSetting is not set, the default value is false. + // Indicates whether the slot accepts multiple values in a single utterance. If + // the multipleValuesSetting is not set, the default value is false . MultipleValuesSetting *types.MultipleValuesSetting - // Whether slot values are shown in Amazon CloudWatch logs. If the value is None, + // Whether slot values are shown in Amazon CloudWatch logs. If the value is None , // the actual value of the slot is shown in logs. ObfuscationSetting *types.ObfuscationSetting diff --git a/service/lexmodelsv2/api_op_DescribeSlotType.go b/service/lexmodelsv2/api_op_DescribeSlotType.go index 96a61eb12be..93d902f32ed 100644 --- a/service/lexmodelsv2/api_op_DescribeSlotType.go +++ b/service/lexmodelsv2/api_op_DescribeSlotType.go @@ -42,8 +42,8 @@ type DescribeSlotTypeInput struct { // The identifier of the language and locale of the slot type to describe. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string diff --git a/service/lexmodelsv2/api_op_ListAggregatedUtterances.go b/service/lexmodelsv2/api_op_ListAggregatedUtterances.go index f580ac08400..1b46b15412e 100644 --- a/service/lexmodelsv2/api_op_ListAggregatedUtterances.go +++ b/service/lexmodelsv2/api_op_ListAggregatedUtterances.go @@ -22,15 +22,9 @@ import ( // recognized by the bot and didn't activate an intent. Utterances can be // aggregated for a bot alias or for a bot version, but not both at the same time. // Utterances statistics are not generated under the following conditions: -// -// * The -// childDirected field was set to true when the bot was created. -// -// * You are using -// slot obfuscation with one or more slots. -// -// * You opted out of participating in -// improving Amazon Lex. +// - The childDirected field was set to true when the bot was created. +// - You are using slot obfuscation with one or more slots. +// - You opted out of participating in improving Amazon Lex. func (c *Client) ListAggregatedUtterances(ctx context.Context, params *ListAggregatedUtterancesInput, optFns ...func(*Options)) (*ListAggregatedUtterancesOutput, error) { if params == nil { params = &ListAggregatedUtterancesInput{} @@ -60,14 +54,14 @@ type ListAggregatedUtterancesInput struct { BotId *string // The identifier of the language and locale where the utterances were collected. - // For more information, see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string - // The identifier of the bot alias associated with this request. If you specify the - // bot alias, you can't specify the bot version. + // The identifier of the bot alias associated with this request. If you specify + // the bot alias, you can't specify the bot version. BotAliasId *string // The identifier of the bot version associated with this request. If you specify @@ -79,9 +73,9 @@ type ListAggregatedUtterancesInput struct { // one filter and one string to filter on. Filters []types.AggregatedUtterancesFilter - // The maximum number of utterances to return in each page of results. If there are - // fewer results than the maximum page size, only the actual number of results are - // returned. If you don't specify the maxResults parameter, 1,000 results are + // The maximum number of utterances to return in each page of results. If there + // are fewer results than the maximum page size, only the actual number of results + // are returned. If you don't specify the maxResults parameter, 1,000 results are // returned. MaxResults *int32 @@ -91,8 +85,8 @@ type ListAggregatedUtterancesInput struct { // results. NextToken *string - // Specifies sorting parameters for the list of utterances. You can sort by the hit - // count, the missed count, or the number of distinct sessions the utterance + // Specifies sorting parameters for the list of utterances. You can sort by the + // hit count, the missed count, or the number of distinct sessions the utterance // appeared in. SortBy *types.AggregatedUtterancesSortBy @@ -111,14 +105,9 @@ type ListAggregatedUtterancesOutput struct { // The last date and time that the aggregated data was collected. The time period // depends on the length of the aggregation window. - // - // * Hours - for 1 hour time - // window, every half hour; otherwise every hour. - // - // * Days - every 6 hours - // - // * Weeks - // - for a one week time window, every 12 hours; otherwise, every day + // - Hours - for 1 hour time window, every half hour; otherwise every hour. + // - Days - every 6 hours + // - Weeks - for a one week time window, every 12 hours; otherwise, every day AggregationLastRefreshedDateTime *time.Time // The date and time that the aggregation window ends. Only data collected between @@ -136,16 +125,16 @@ type ListAggregatedUtterancesOutput struct { // The identifier of the bot that contains the utterances. BotId *string - // The identifier of the bot version that contains the utterances. If you specified - // the bot alias, the bot version isn't returned. + // The identifier of the bot version that contains the utterances. If you + // specified the bot alias, the bot version isn't returned. BotVersion *string // The identifier of the language and locale that the utterances are in. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListAggregatedUtterances operation. If the nextToken field is present, you - // send the contents as the nextToken parameter of a ListAggregatedUtterances + // A token that indicates whether there are more results to return in a response + // to the ListAggregatedUtterances operation. If the nextToken field is present, + // you send the contents as the nextToken parameter of a ListAggregatedUtterances // operation request to get the next page of results. NextToken *string @@ -229,9 +218,9 @@ var _ ListAggregatedUtterancesAPIClient = (*Client)(nil) // ListAggregatedUtterancesPaginatorOptions is the paginator options for // ListAggregatedUtterances type ListAggregatedUtterancesPaginatorOptions struct { - // The maximum number of utterances to return in each page of results. If there are - // fewer results than the maximum page size, only the actual number of results are - // returned. If you don't specify the maxResults parameter, 1,000 results are + // The maximum number of utterances to return in each page of results. If there + // are fewer results than the maximum page size, only the actual number of results + // are returned. If you don't specify the maxResults parameter, 1,000 results are // returned. Limit int32 diff --git a/service/lexmodelsv2/api_op_ListBotAliases.go b/service/lexmodelsv2/api_op_ListBotAliases.go index 0224050d068..553ef34ba45 100644 --- a/service/lexmodelsv2/api_op_ListBotAliases.go +++ b/service/lexmodelsv2/api_op_ListBotAliases.go @@ -59,10 +59,10 @@ type ListBotAliasesOutput struct { // The identifier of the bot associated with the aliases. BotId *string - // A token that indicates whether there are more results to return in a response to - // the ListBotAliases operation. If the nextToken field is present, you send the - // contents as the nextToken parameter of a ListBotAliases operation request to get - // the next page of results. + // A token that indicates whether there are more results to return in a response + // to the ListBotAliases operation. If the nextToken field is present, you send + // the contents as the nextToken parameter of a ListBotAliases operation request + // to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_ListBotLocales.go b/service/lexmodelsv2/api_op_ListBotLocales.go index 440769ab5b5..be4923e9c75 100644 --- a/service/lexmodelsv2/api_op_ListBotLocales.go +++ b/service/lexmodelsv2/api_op_ListBotLocales.go @@ -40,9 +40,9 @@ type ListBotLocalesInput struct { // This member is required. BotVersion *string - // Provides the specification for a filter used to limit the response to only those - // locales that match the filter specification. You can only specify one filter and - // one value to filter on. + // Provides the specification for a filter used to limit the response to only + // those locales that match the filter specification. You can only specify one + // filter and one value to filter on. Filters []types.BotLocaleFilter // The maximum number of aliases to return in each page of results. If there are @@ -69,17 +69,17 @@ type ListBotLocalesOutput struct { // Summary information for the locales that meet the filter criteria specified in // the request. The length of the list is specified in the maxResults parameter of - // the request. If there are more locales available, the nextToken field contains a - // token to get the next page of results. + // the request. If there are more locales available, the nextToken field contains + // a token to get the next page of results. BotLocaleSummaries []types.BotLocaleSummary // The version of the bot. BotVersion *string - // A token that indicates whether there are more results to return in a response to - // the ListBotLocales operation. If the nextToken field is present, you send the - // contents as the nextToken parameter of a ListBotLocales operation request to get - // the next page of results. + // A token that indicates whether there are more results to return in a response + // to the ListBotLocales operation. If the nextToken field is present, you send + // the contents as the nextToken parameter of a ListBotLocales operation request + // to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_ListBotRecommendations.go b/service/lexmodelsv2/api_op_ListBotRecommendations.go index d1662277478..9800fde8ded 100644 --- a/service/lexmodelsv2/api_op_ListBotRecommendations.go +++ b/service/lexmodelsv2/api_op_ListBotRecommendations.go @@ -75,8 +75,8 @@ type ListBotRecommendationsOutput struct { // The identifier of the language and locale of the bot recommendation list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListBotRecommendations operation. If the nextToken field is present, you + // A token that indicates whether there are more results to return in a response + // to the ListBotRecommendations operation. If the nextToken field is present, you // send the contents as the nextToken parameter of a ListBotRecommendations // operation request to get the next page of results. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListBotVersions.go b/service/lexmodelsv2/api_op_ListBotVersions.go index b548036f750..e80e428cd54 100644 --- a/service/lexmodelsv2/api_op_ListBotVersions.go +++ b/service/lexmodelsv2/api_op_ListBotVersions.go @@ -61,16 +61,16 @@ type ListBotVersionsOutput struct { // The identifier of the bot to list versions for. BotId *string - // Summary information for the bot versions that meet the filter criteria specified - // in the request. The length of the list is specified in the maxResults parameter - // of the request. If there are more versions available, the nextToken field - // contains a token to get the next page of results. + // Summary information for the bot versions that meet the filter criteria + // specified in the request. The length of the list is specified in the maxResults + // parameter of the request. If there are more versions available, the nextToken + // field contains a token to get the next page of results. BotVersionSummaries []types.BotVersionSummary - // A token that indicates whether there are more results to return in a response to - // the ListBotVersions operation. If the nextToken field is present, you send the - // contents as the nextToken parameter of a ListBotAliases operation request to get - // the next page of results. + // A token that indicates whether there are more results to return in a response + // to the ListBotVersions operation. If the nextToken field is present, you send + // the contents as the nextToken parameter of a ListBotAliases operation request + // to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_ListBots.go b/service/lexmodelsv2/api_op_ListBots.go index 43537cfecae..a2aebbe0f1e 100644 --- a/service/lexmodelsv2/api_op_ListBots.go +++ b/service/lexmodelsv2/api_op_ListBots.go @@ -30,25 +30,25 @@ func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ... type ListBotsInput struct { - // Provides the specification of a filter used to limit the bots in the response to - // only those that match the filter specification. You can only specify one filter - // and one string to filter on. + // Provides the specification of a filter used to limit the bots in the response + // to only those that match the filter specification. You can only specify one + // filter and one string to filter on. Filters []types.BotFilter - // The maximum number of bots to return in each page of results. If there are fewer - // results than the maximum page size, only the actual number of results are + // The maximum number of bots to return in each page of results. If there are + // fewer results than the maximum page size, only the actual number of results are // returned. MaxResults *int32 - // If the response from the ListBots operation contains more results than specified - // in the maxResults parameter, a token is returned in the response. Use the - // returned token in the nextToken parameter of a ListBots request to return the - // next page of results. For a complete set of results, call the ListBots operation - // until the nextToken returned in the response is null. + // If the response from the ListBots operation contains more results than + // specified in the maxResults parameter, a token is returned in the response. Use + // the returned token in the nextToken parameter of a ListBots request to return + // the next page of results. For a complete set of results, call the ListBots + // operation until the nextToken returned in the response is null. NextToken *string - // Specifies sorting parameters for the list of bots. You can specify that the list - // be sorted by bot name in ascending or descending order. + // Specifies sorting parameters for the list of bots. You can specify that the + // list be sorted by bot name in ascending or descending order. SortBy *types.BotSortBy noSmithyDocumentSerde @@ -62,10 +62,10 @@ type ListBotsOutput struct { // to the next page of results. BotSummaries []types.BotSummary - // A token that indicates whether there are more results to return in a response to - // the ListBots operation. If the nextToken field is present, you send the contents - // as the nextToken parameter of a ListBots operation request to get the next page - // of results. + // A token that indicates whether there are more results to return in a response + // to the ListBots operation. If the nextToken field is present, you send the + // contents as the nextToken parameter of a ListBots operation request to get the + // next page of results. NextToken *string // Metadata pertaining to the operation's result. @@ -146,8 +146,8 @@ var _ ListBotsAPIClient = (*Client)(nil) // ListBotsPaginatorOptions is the paginator options for ListBots type ListBotsPaginatorOptions struct { - // The maximum number of bots to return in each page of results. If there are fewer - // results than the maximum page size, only the actual number of results are + // The maximum number of bots to return in each page of results. If there are + // fewer results than the maximum page size, only the actual number of results are // returned. Limit int32 diff --git a/service/lexmodelsv2/api_op_ListBuiltInIntents.go b/service/lexmodelsv2/api_op_ListBuiltInIntents.go index 724854a3ebe..40dbe6904ce 100644 --- a/service/lexmodelsv2/api_op_ListBuiltInIntents.go +++ b/service/lexmodelsv2/api_op_ListBuiltInIntents.go @@ -15,8 +15,8 @@ import ( // Gets a list of built-in intents provided by Amazon Lex that you can use in your // bot. To use a built-in intent as a the base for your own intent, include the // built-in intent signature in the parentIntentSignature parameter when you call -// the CreateIntent operation. For more information, see CreateIntent -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html). +// the CreateIntent operation. For more information, see CreateIntent (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateIntent.html) +// . func (c *Client) ListBuiltInIntents(ctx context.Context, params *ListBuiltInIntentsInput, optFns ...func(*Options)) (*ListBuiltInIntentsOutput, error) { if params == nil { params = &ListBuiltInIntentsInput{} @@ -36,7 +36,7 @@ type ListBuiltInIntentsInput struct { // The identifier of the language and locale of the intents to list. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -46,9 +46,10 @@ type ListBuiltInIntentsInput struct { // results are returned. MaxResults *int32 - // If the response from the ListBuiltInIntents operation contains more results than - // specified in the maxResults parameter, a token is returned in the response. Use - // that token in the nextToken parameter to return the next page of results. + // If the response from the ListBuiltInIntents operation contains more results + // than specified in the maxResults parameter, a token is returned in the + // response. Use that token in the nextToken parameter to return the next page of + // results. NextToken *string // Specifies sorting parameters for the list of built-in intents. You can specify @@ -70,10 +71,10 @@ type ListBuiltInIntentsOutput struct { // The language and locale of the intents in the list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListBuiltInIntents operation. If the nextToken field is present, you send - // the contents as the nextToken parameter of a ListBotAliases operation request to - // get the next page of results. + // A token that indicates whether there are more results to return in a response + // to the ListBuiltInIntents operation. If the nextToken field is present, you + // send the contents as the nextToken parameter of a ListBotAliases operation + // request to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go b/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go index e81122cef4f..6d4134a41c6 100644 --- a/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go +++ b/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go @@ -32,7 +32,7 @@ type ListBuiltInSlotTypesInput struct { // The identifier of the language and locale of the slot types to list. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -43,8 +43,9 @@ type ListBuiltInSlotTypesInput struct { MaxResults *int32 // If the response from the ListBuiltInSlotTypes operation contains more results - // than specified in the maxResults parameter, a token is returned in the response. - // Use that token in the nextToken parameter to return the next page of results. + // than specified in the maxResults parameter, a token is returned in the + // response. Use that token in the nextToken parameter to return the next page of + // results. NextToken *string // Determines the sort order for the response from the ListBuiltInSlotTypes @@ -66,10 +67,10 @@ type ListBuiltInSlotTypesOutput struct { // The language and locale of the slot types in the list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListBuiltInSlotTypes operation. If the nextToken field is present, you send - // the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation - // request to get the next page of results. + // A token that indicates whether there are more results to return in a response + // to the ListBuiltInSlotTypes operation. If the nextToken field is present, you + // send the contents as the nextToken parameter of a LIstBuiltInSlotTypes + // operation request to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go b/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go index fd0490e6aec..799a13cf7d2 100644 --- a/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go +++ b/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go @@ -71,8 +71,8 @@ type ListCustomVocabularyItemsOutput struct { // The identifier of the language and locale where this custom vocabulary is used. // The string must match one of the supported locales. For more information, see - // Supported Languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported Languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . LocaleId *string // The nextToken identifier to the list custom vocabulary response. diff --git a/service/lexmodelsv2/api_op_ListExports.go b/service/lexmodelsv2/api_op_ListExports.go index 6430f80d45b..dec0c70986e 100644 --- a/service/lexmodelsv2/api_op_ListExports.go +++ b/service/lexmodelsv2/api_op_ListExports.go @@ -37,14 +37,14 @@ type ListExportsInput struct { // The version of the bot to list exports for. BotVersion *string - // Provides the specification of a filter used to limit the exports in the response - // to only those that match the filter specification. You can only specify one - // filter and one string to filter on. + // Provides the specification of a filter used to limit the exports in the + // response to only those that match the filter specification. You can only specify + // one filter and one string to filter on. Filters []types.ExportFilter - // Specifies the resources that should be exported. If you don't specify a resource - // type in the filters parameter, both bot locales and custom vocabularies are - // exported. + // Specifies the resources that should be exported. If you don't specify a + // resource type in the filters parameter, both bot locales and custom + // vocabularies are exported. LocaleId *string // The maximum number of exports to return in each page of results. If there are @@ -54,9 +54,9 @@ type ListExportsInput struct { // If the response from the ListExports operation contains more results that // specified in the maxResults parameter, a token is returned in the response. Use - // the returned token in the nextToken parameter of a ListExports request to return - // the next page of results. For a complete set of results, call the ListExports - // operation until the nextToken returned in the response is null. + // the returned token in the nextToken parameter of a ListExports request to + // return the next page of results. For a complete set of results, call the + // ListExports operation until the nextToken returned in the response is null. NextToken *string // Determines the field that the list of exports is sorted by. You can sort by the @@ -75,16 +75,16 @@ type ListExportsOutput struct { BotVersion *string // Summary information for the exports that meet the filter criteria specified in - // the request. The length of the list is specified in the maxResults parameter. If - // there are more exports available, the nextToken field contains a token to get - // the next page of results. + // the request. The length of the list is specified in the maxResults parameter. + // If there are more exports available, the nextToken field contains a token to + // get the next page of results. ExportSummaries []types.ExportSummary // The locale specified in the request. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListExports operation. If the nextToken field is present, you send the + // A token that indicates whether there are more results to return in a response + // to the ListExports operation. If the nextToken field is present, you send the // contents as the nextToken parameter of a ListExports operation request to get // the next page of results. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListImports.go b/service/lexmodelsv2/api_op_ListImports.go index fc8510f4d6a..feb1964d599 100644 --- a/service/lexmodelsv2/api_op_ListImports.go +++ b/service/lexmodelsv2/api_op_ListImports.go @@ -37,9 +37,9 @@ type ListImportsInput struct { // The version of the bot to list imports for. BotVersion *string - // Provides the specification of a filter used to limit the bots in the response to - // only those that match the filter specification. You can only specify one filter - // and one string to filter on. + // Provides the specification of a filter used to limit the bots in the response + // to only those that match the filter specification. You can only specify one + // filter and one string to filter on. Filters []types.ImportFilter // Specifies the locale that should be present in the list. If you don't specify a @@ -54,9 +54,9 @@ type ListImportsInput struct { // If the response from the ListImports operation contains more results than // specified in the maxResults parameter, a token is returned in the response. Use - // the returned token in the nextToken parameter of a ListImports request to return - // the next page of results. For a complete set of results, call the ListImports - // operation until the nextToken returned in the response is null. + // the returned token in the nextToken parameter of a ListImports request to + // return the next page of results. For a complete set of results, call the + // ListImports operation until the nextToken returned in the response is null. NextToken *string // Determines the field that the list of imports is sorted by. You can sort by the @@ -71,20 +71,20 @@ type ListImportsOutput struct { // The unique identifier assigned by Amazon Lex to the bot. BotId *string - // The version of the bot that was imported. It will always be DRAFT. + // The version of the bot that was imported. It will always be DRAFT . BotVersion *string // Summary information for the imports that meet the filter criteria specified in - // the request. The length of the list is specified in the maxResults parameter. If - // there are more imports available, the nextToken field contains a token to get - // the next page of results. + // the request. The length of the list is specified in the maxResults parameter. + // If there are more imports available, the nextToken field contains a token to + // get the next page of results. ImportSummaries []types.ImportSummary // The locale specified in the request. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListImports operation. If the nextToken field is present, you send the + // A token that indicates whether there are more results to return in a response + // to the ListImports operation. If the nextToken field is present, you send the // contents as the nextToken parameter of a ListImports operation request to get // the next page of results. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListIntents.go b/service/lexmodelsv2/api_op_ListIntents.go index 64b14a420c9..3219eb3a5a9 100644 --- a/service/lexmodelsv2/api_op_ListIntents.go +++ b/service/lexmodelsv2/api_op_ListIntents.go @@ -42,14 +42,14 @@ type ListIntentsInput struct { // The identifier of the language and locale of the intents to list. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string - // Provides the specification of a filter used to limit the intents in the response - // to only those that match the filter specification. You can only specify one - // filter and only one string to filter on. + // Provides the specification of a filter used to limit the intents in the + // response to only those that match the filter specification. You can only specify + // one filter and only one string to filter on. Filters []types.IntentFilter // The maximum number of intents to return in each page of results. If there are @@ -59,9 +59,9 @@ type ListIntentsInput struct { // If the response from the ListIntents operation contains more results than // specified in the maxResults parameter, a token is returned in the response. Use - // the returned token in the nextToken parameter of a ListIntents request to return - // the next page of results. For a complete set of results, call the ListIntents - // operation until the nextToken returned in the response is null. + // the returned token in the nextToken parameter of a ListIntents request to + // return the next page of results. For a complete set of results, call the + // ListIntents operation until the nextToken returned in the response is null. NextToken *string // Determines the sort order for the response from the ListIntents operation. You @@ -82,15 +82,15 @@ type ListIntentsOutput struct { // Summary information for the intents that meet the filter criteria specified in // the request. The length of the list is specified in the maxResults parameter of - // the request. If there are more intents available, the nextToken field contains a - // token to get the next page of results. + // the request. If there are more intents available, the nextToken field contains + // a token to get the next page of results. IntentSummaries []types.IntentSummary // The language and locale of the intents in the list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListIntents operation. If the nextToken field is present, you send the + // A token that indicates whether there are more results to return in a response + // to the ListIntents operation. If the nextToken field is present, you send the // contents as the nextToken parameter of a ListIntents operation request to get // the next page of results. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListRecommendedIntents.go b/service/lexmodelsv2/api_op_ListRecommendedIntents.go index 92b5f80f48d..48c68265bad 100644 --- a/service/lexmodelsv2/api_op_ListRecommendedIntents.go +++ b/service/lexmodelsv2/api_op_ListRecommendedIntents.go @@ -77,11 +77,11 @@ type ListRecommendedIntentsOutput struct { // The identifier of the language and locale of the intents to list. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListRecommendedIntents operation. If the nextToken field is present, you + // A token that indicates whether there are more results to return in a response + // to the ListRecommendedIntents operation. If the nextToken field is present, you // send the contents as the nextToken parameter of a ListRecommendedIntents // operation request to get the next page of results. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListSlotTypes.go b/service/lexmodelsv2/api_op_ListSlotTypes.go index 88f8600cbd7..8309773ef55 100644 --- a/service/lexmodelsv2/api_op_ListSlotTypes.go +++ b/service/lexmodelsv2/api_op_ListSlotTypes.go @@ -42,7 +42,7 @@ type ListSlotTypesInput struct { // The identifier of the language and locale of the slot types to list. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -52,8 +52,8 @@ type ListSlotTypesInput struct { // one filter and only one string to filter on. Filters []types.SlotTypeFilter - // The maximum number of slot types to return in each page of results. If there are - // fewer results than the max page size, only the actual number of results are + // The maximum number of slot types to return in each page of results. If there + // are fewer results than the max page size, only the actual number of results are // returned. MaxResults *int32 @@ -62,8 +62,8 @@ type ListSlotTypesInput struct { // that token in the nextToken parameter to return the next page of results. NextToken *string - // Determines the sort order for the response from the ListSlotTypes operation. You - // can choose to sort by the slot type name or last updated date in either + // Determines the sort order for the response from the ListSlotTypes operation. + // You can choose to sort by the slot type name or last updated date in either // ascending or descending order. SortBy *types.SlotTypeSortBy @@ -81,8 +81,8 @@ type ListSlotTypesOutput struct { // The language and local of the slot types in the list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListSlotTypes operation. If the nextToken field is present, you send the + // A token that indicates whether there are more results to return in a response + // to the ListSlotTypes operation. If the nextToken field is present, you send the // contents as the nextToken parameter of a ListSlotTypes operation request to get // the next page of results. NextToken *string @@ -171,8 +171,8 @@ var _ ListSlotTypesAPIClient = (*Client)(nil) // ListSlotTypesPaginatorOptions is the paginator options for ListSlotTypes type ListSlotTypesPaginatorOptions struct { - // The maximum number of slot types to return in each page of results. If there are - // fewer results than the max page size, only the actual number of results are + // The maximum number of slot types to return in each page of results. If there + // are fewer results than the max page size, only the actual number of results are // returned. Limit int32 diff --git a/service/lexmodelsv2/api_op_ListSlots.go b/service/lexmodelsv2/api_op_ListSlots.go index 152920dd187..75e214faea4 100644 --- a/service/lexmodelsv2/api_op_ListSlots.go +++ b/service/lexmodelsv2/api_op_ListSlots.go @@ -47,7 +47,7 @@ type ListSlotsInput struct { // The identifier of the language and locale of the slots to list. The string must // match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -67,8 +67,8 @@ type ListSlotsInput struct { // that token in the nextToken parameter to return the next page of results. NextToken *string - // Determines the sort order for the response from the ListSlots operation. You can - // choose to sort by the slot name or last updated date in either ascending or + // Determines the sort order for the response from the ListSlots operation. You + // can choose to sort by the slot name or last updated date in either ascending or // descending order. SortBy *types.SlotSortBy @@ -89,16 +89,16 @@ type ListSlotsOutput struct { // The language and locale of the slots in the list. LocaleId *string - // A token that indicates whether there are more results to return in a response to - // the ListSlots operation. If the nextToken field is present, you send the + // A token that indicates whether there are more results to return in a response + // to the ListSlots operation. If the nextToken field is present, you send the // contents as the nextToken parameter of a ListSlots operation request to get the // next page of results. NextToken *string - // Summary information for the slots that meet the filter criteria specified in the - // request. The length of the list is specified in the maxResults parameter of the - // request. If there are more slots available, the nextToken field contains a token - // to get the next page of results. + // Summary information for the slots that meet the filter criteria specified in + // the request. The length of the list is specified in the maxResults parameter of + // the request. If there are more slots available, the nextToken field contains a + // token to get the next page of results. SlotSummaries []types.SlotSummary // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go b/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go index a2b86d18156..57541115c95 100644 --- a/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go +++ b/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go @@ -53,8 +53,7 @@ type SearchAssociatedTranscriptsInput struct { // The identifier of the language and locale of the transcripts to search. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) // // This member is required. LocaleId *string @@ -96,12 +95,11 @@ type SearchAssociatedTranscriptsOutput struct { // The identifier of the language and locale of the transcripts to search. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) LocaleId *string - // A index that indicates whether there are more results to return in a response to - // the SearchAssociatedTranscripts operation. If the nextIndex field is present, + // A index that indicates whether there are more results to return in a response + // to the SearchAssociatedTranscripts operation. If the nextIndex field is present, // you send the contents as the nextIndex parameter of a // SearchAssociatedTranscriptsRequest operation to get the next page of results. NextIndex *int32 diff --git a/service/lexmodelsv2/api_op_StartBotRecommendation.go b/service/lexmodelsv2/api_op_StartBotRecommendation.go index d517b548de2..a92af9270d0 100644 --- a/service/lexmodelsv2/api_op_StartBotRecommendation.go +++ b/service/lexmodelsv2/api_op_StartBotRecommendation.go @@ -43,8 +43,7 @@ type StartBotRecommendationInput struct { // The identifier of the language and locale of the bot recommendation to start. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) // // This member is required. LocaleId *string @@ -81,15 +80,14 @@ type StartBotRecommendationOutput struct { // A timestamp of the date and time that the bot recommendation was created. CreationDateTime *time.Time - // The object representing the passwords that were used to encrypt the data related - // to the bot recommendation results, as well as the KMS key ARN used to encrypt - // the associated metadata. + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used to + // encrypt the associated metadata. EncryptionSetting *types.EncryptionSetting // The identifier of the language and locale of the bot recommendation to start. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) LocaleId *string // The object representing the Amazon S3 bucket containing the transcript, as well diff --git a/service/lexmodelsv2/api_op_StartImport.go b/service/lexmodelsv2/api_op_StartImport.go index 99c5f3b7fbb..13753826686 100644 --- a/service/lexmodelsv2/api_op_StartImport.go +++ b/service/lexmodelsv2/api_op_StartImport.go @@ -12,8 +12,8 @@ import ( "time" ) -// Starts importing a bot, bot locale, or custom vocabulary from a zip archive that -// you uploaded to an S3 bucket. +// Starts importing a bot, bot locale, or custom vocabulary from a zip archive +// that you uploaded to an S3 bucket. func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optFns ...func(*Options)) (*StartImportOutput, error) { if params == nil { params = &StartImportInput{} @@ -32,8 +32,7 @@ func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optF type StartImportInput struct { // The unique identifier for the import. It is included in the response from the - // CreateUploadUrl - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html) + // CreateUploadUrl (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html) // operation. // // This member is required. diff --git a/service/lexmodelsv2/api_op_StopBotRecommendation.go b/service/lexmodelsv2/api_op_StopBotRecommendation.go index 13af10fec45..576d4e947cd 100644 --- a/service/lexmodelsv2/api_op_StopBotRecommendation.go +++ b/service/lexmodelsv2/api_op_StopBotRecommendation.go @@ -45,10 +45,9 @@ type StopBotRecommendationInput struct { // This member is required. BotVersion *string - // The identifier of the language and locale of the bot recommendation to stop. The - // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // The identifier of the language and locale of the bot recommendation to stop. + // The string must match one of the supported locales. For more information, see + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) // // This member is required. LocaleId *string @@ -58,8 +57,8 @@ type StopBotRecommendationInput struct { type StopBotRecommendationOutput struct { - // The unique identifier of the bot containing the bot recommendation that is being - // stopped. + // The unique identifier of the bot containing the bot recommendation that is + // being stopped. BotId *string // The unique identifier of the bot recommendation that is being stopped. @@ -74,8 +73,7 @@ type StopBotRecommendationOutput struct { // The identifier of the language and locale of the bot response to stop. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) LocaleId *string // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_UpdateBot.go b/service/lexmodelsv2/api_op_UpdateBot.go index b76a2b29c3e..b4dd02ca28d 100644 --- a/service/lexmodelsv2/api_op_UpdateBot.go +++ b/service/lexmodelsv2/api_op_UpdateBot.go @@ -31,15 +31,14 @@ func (c *Client) UpdateBot(ctx context.Context, params *UpdateBotInput, optFns . type UpdateBotInput struct { // The unique identifier of the bot to update. This identifier is returned by the - // CreateBot - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) + // CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) // operation. // // This member is required. BotId *string - // The new name of the bot. The name must be unique in the account that creates the - // bot. + // The new name of the bot. The name must be unique in the account that creates + // the bot. // // This member is required. BotName *string @@ -59,8 +58,8 @@ type UpdateBotInput struct { // This member is required. IdleSessionTTLInSeconds *int32 - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // bot. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the bot. // // This member is required. RoleArn *string diff --git a/service/lexmodelsv2/api_op_UpdateBotAlias.go b/service/lexmodelsv2/api_op_UpdateBotAlias.go index a863285f0e9..b4c7f669421 100644 --- a/service/lexmodelsv2/api_op_UpdateBotAlias.go +++ b/service/lexmodelsv2/api_op_UpdateBotAlias.go @@ -58,8 +58,8 @@ type UpdateBotAliasInput struct { // The new description to assign to the bot alias. Description *string - // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment - // of user utterances. + // Determines whether Amazon Lex will use Amazon Comprehend to detect the + // sentiment of user utterances. SentimentAnalysisSettings *types.SentimentAnalysisSettings noSmithyDocumentSerde @@ -86,8 +86,8 @@ type UpdateBotAliasOutput struct { // The updated version of the bot that the alias points to. BotVersion *string - // The updated settings for storing conversation logs in Amazon CloudWatch Logs and - // Amazon S3 buckets. + // The updated settings for storing conversation logs in Amazon CloudWatch Logs + // and Amazon S3 buckets. ConversationLogSettings *types.ConversationLogSettings // A timestamp of the date and time that the bot was created. @@ -99,8 +99,8 @@ type UpdateBotAliasOutput struct { // A timestamp of the date and time that the bot was last updated. LastUpdatedDateTime *time.Time - // Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment - // of user utterances. + // Determines whether Amazon Lex will use Amazon Comprehend to detect the + // sentiment of user utterances. SentimentAnalysisSettings *types.SentimentAnalysisSettings // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_UpdateBotLocale.go b/service/lexmodelsv2/api_op_UpdateBotLocale.go index 7107e7f49ad..752256b727e 100644 --- a/service/lexmodelsv2/api_op_UpdateBotLocale.go +++ b/service/lexmodelsv2/api_op_UpdateBotLocale.go @@ -42,8 +42,8 @@ type UpdateBotLocaleInput struct { BotVersion *string // The identifier of the language and locale to update. The string must match one - // of the supported locales. For more information, see Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -83,8 +83,8 @@ type UpdateBotLocaleOutput struct { // The updated description of the locale. Description *string - // If the botLocaleStatus is Failed, the failureReasons field lists the errors that - // occurred while building the bot. + // If the botLocaleStatus is Failed , the failureReasons field lists the errors + // that occurred while building the bot. FailureReasons []string // A timestamp of the date and time that the locale was last updated. diff --git a/service/lexmodelsv2/api_op_UpdateBotRecommendation.go b/service/lexmodelsv2/api_op_UpdateBotRecommendation.go index 49a5706f1c8..0fb08f1cba6 100644 --- a/service/lexmodelsv2/api_op_UpdateBotRecommendation.go +++ b/service/lexmodelsv2/api_op_UpdateBotRecommendation.go @@ -55,8 +55,7 @@ type UpdateBotRecommendationInput struct { // The identifier of the language and locale of the bot recommendation to update. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) // // This member is required. LocaleId *string @@ -66,8 +65,8 @@ type UpdateBotRecommendationInput struct { type UpdateBotRecommendationOutput struct { - // The unique identifier of the bot containing the bot recommendation that has been - // updated. + // The unique identifier of the bot containing the bot recommendation that has + // been updated. BotId *string // The unique identifier of the bot recommendation to be updated. @@ -83,9 +82,9 @@ type UpdateBotRecommendationOutput struct { // A timestamp of the date and time that the bot recommendation was created. CreationDateTime *time.Time - // The object representing the passwords that were used to encrypt the data related - // to the bot recommendation results, as well as the KMS key ARN used to encrypt - // the associated metadata. + // The object representing the passwords that were used to encrypt the data + // related to the bot recommendation results, as well as the KMS key ARN used to + // encrypt the associated metadata. EncryptionSetting *types.EncryptionSetting // A timestamp of the date and time that the bot recommendation was last updated. @@ -93,8 +92,7 @@ type UpdateBotRecommendationOutput struct { // The identifier of the language and locale of the bot recommendation to update. // The string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) LocaleId *string // The object representing the Amazon S3 bucket containing the transcript, as well diff --git a/service/lexmodelsv2/api_op_UpdateExport.go b/service/lexmodelsv2/api_op_UpdateExport.go index de858d0e284..0685330ca29 100644 --- a/service/lexmodelsv2/api_op_UpdateExport.go +++ b/service/lexmodelsv2/api_op_UpdateExport.go @@ -15,8 +15,7 @@ import ( // Updates the password used to protect an export zip archive. The password is not // required. If you don't supply a password, Amazon Lex generates a zip file that // is not protected by a password. This is the archive that is available at the -// pre-signed S3 URL provided by the DescribeExport -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) +// pre-signed S3 URL provided by the DescribeExport (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) // operation. func (c *Client) UpdateExport(ctx context.Context, params *UpdateExportInput, optFns ...func(*Options)) (*UpdateExportOutput, error) { if params == nil { diff --git a/service/lexmodelsv2/api_op_UpdateIntent.go b/service/lexmodelsv2/api_op_UpdateIntent.go index 389a616c407..06e92fb87cb 100644 --- a/service/lexmodelsv2/api_op_UpdateIntent.go +++ b/service/lexmodelsv2/api_op_UpdateIntent.go @@ -35,7 +35,7 @@ type UpdateIntentInput struct { // This member is required. BotId *string - // The version of the bot that contains the intent. Must be DRAFT. + // The version of the bot that contains the intent. Must be DRAFT . // // This member is required. BotVersion *string @@ -52,7 +52,7 @@ type UpdateIntentInput struct { // The identifier of the language and locale where this intent is used. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -105,7 +105,7 @@ type UpdateIntentOutput struct { // The identifier of the bot that contains the intent. BotId *string - // The version of the bot that contains the intent. Will always be DRAFT. + // The version of the bot that contains the intent. Will always be DRAFT . BotVersion *string // A timestamp of when the intent was created. @@ -114,8 +114,8 @@ type UpdateIntentOutput struct { // The updated description of the intent. Description *string - // The updated Lambda function called during each turn of the conversation with the - // user. + // The updated Lambda function called during each turn of the conversation with + // the user. DialogCodeHook *types.DialogCodeHookSettings // The updated Lambda function called when the intent is ready for fulfillment. @@ -124,8 +124,8 @@ type UpdateIntentOutput struct { // InitialResponseSetting *types.InitialResponseSetting - // The updated list of contexts that must be active for the intent to be considered - // by Amazon Lex. + // The updated list of contexts that must be active for the intent to be + // considered by Amazon Lex. InputContexts []types.InputContext // The updated response that Amazon Lex sends the user when the intent is closed. diff --git a/service/lexmodelsv2/api_op_UpdateResourcePolicy.go b/service/lexmodelsv2/api_op_UpdateResourcePolicy.go index c205b3ec53c..b20e63f0c38 100644 --- a/service/lexmodelsv2/api_op_UpdateResourcePolicy.go +++ b/service/lexmodelsv2/api_op_UpdateResourcePolicy.go @@ -32,9 +32,8 @@ type UpdateResourcePolicyInput struct { // A resource policy to add to the resource. The policy is a JSON structure that // contains one or more statements that define the policy. The policy must follow // the IAM syntax. For more information about the contents of a JSON policy - // document, see IAM JSON policy reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html). If - // the policy isn't valid, Amazon Lex returns a validation exception. + // document, see IAM JSON policy reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // . If the policy isn't valid, Amazon Lex returns a validation exception. // // This member is required. Policy *string diff --git a/service/lexmodelsv2/api_op_UpdateSlot.go b/service/lexmodelsv2/api_op_UpdateSlot.go index 1aa3019b6fd..f86984c24ea 100644 --- a/service/lexmodelsv2/api_op_UpdateSlot.go +++ b/service/lexmodelsv2/api_op_UpdateSlot.go @@ -35,7 +35,7 @@ type UpdateSlotInput struct { // This member is required. BotId *string - // The version of the bot that contains the slot. Must always be DRAFT. + // The version of the bot that contains the slot. Must always be DRAFT . // // This member is required. BotVersion *string @@ -47,7 +47,7 @@ type UpdateSlotInput struct { // The identifier of the language and locale that contains the slot. The string // must match one of the supported locales. For more information, see Supported - // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . // // This member is required. LocaleId *string @@ -73,8 +73,8 @@ type UpdateSlotInput struct { // Determines whether the slot accepts multiple values in one response. Multiple // value slots are only available in the en-US locale. If you set this value to - // true in any other locale, Amazon Lex throws a ValidationException. If the - // multipleValuesSetting is not set, the default value is false. + // true in any other locale, Amazon Lex throws a ValidationException . If the + // multipleValuesSetting is not set, the default value is false . MultipleValuesSetting *types.MultipleValuesSetting // New settings that determine how slot values are formatted in Amazon CloudWatch @@ -96,7 +96,7 @@ type UpdateSlotOutput struct { // The identifier of the bot that contains the slot. BotId *string - // The identifier of the slot version that contains the slot. Will always be DRAFT. + // The identifier of the slot version that contains the slot. Will always be DRAFT . BotVersion *string // The timestamp of the date and time that the slot was created. diff --git a/service/lexmodelsv2/api_op_UpdateSlotType.go b/service/lexmodelsv2/api_op_UpdateSlotType.go index 15249a29f41..4e32aaf6831 100644 --- a/service/lexmodelsv2/api_op_UpdateSlotType.go +++ b/service/lexmodelsv2/api_op_UpdateSlotType.go @@ -35,15 +35,15 @@ type UpdateSlotTypeInput struct { // This member is required. BotId *string - // The version of the bot that contains the slot type. Must be DRAFT. + // The version of the bot that contains the slot type. Must be DRAFT . // // This member is required. BotVersion *string // The identifier of the language and locale that contains the slot type. The // string must match one of the supported locales. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string @@ -70,8 +70,8 @@ type UpdateSlotTypeInput struct { // The new built-in slot type that should be used as the parent of this slot type. ParentSlotTypeSignature *string - // A new list of values and their optional synonyms that define the values that the - // slot type can take. + // A new list of values and their optional synonyms that define the values that + // the slot type can take. SlotTypeValues []types.SlotTypeValue // The strategy that Amazon Lex should use when deciding on a value from the list @@ -86,7 +86,7 @@ type UpdateSlotTypeOutput struct { // The identifier of the bot that contains the slot type. BotId *string - // The version of the bot that contains the slot type. This is always DRAFT. + // The version of the bot that contains the slot type. This is always DRAFT . BotVersion *string // Specifications for a composite slot type. diff --git a/service/lexmodelsv2/doc.go b/service/lexmodelsv2/doc.go index 28dd51c4b03..54d974a6f01 100644 --- a/service/lexmodelsv2/doc.go +++ b/service/lexmodelsv2/doc.go @@ -1,5 +1,5 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package lexmodelsv2 provides the API client, operations, and parameter types for -// Amazon Lex Model Building V2. +// Package lexmodelsv2 provides the API client, operations, and parameter types +// for Amazon Lex Model Building V2. package lexmodelsv2 diff --git a/service/lexmodelsv2/types/enums.go b/service/lexmodelsv2/types/enums.go index 69e23c334f4..ea679047f20 100644 --- a/service/lexmodelsv2/types/enums.go +++ b/service/lexmodelsv2/types/enums.go @@ -46,8 +46,8 @@ const ( AggregatedUtterancesSortAttributeMissedCount AggregatedUtterancesSortAttribute = "MissedCount" ) -// Values returns all known values for AggregatedUtterancesSortAttribute. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AggregatedUtterancesSortAttribute. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AggregatedUtterancesSortAttribute) Values() []AggregatedUtterancesSortAttribute { @@ -83,9 +83,9 @@ const ( AudioRecognitionStrategyUseSlotValuesAsCustomVocabulary AudioRecognitionStrategy = "UseSlotValuesAsCustomVocabulary" ) -// Values returns all known values for AudioRecognitionStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioRecognitionStrategy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioRecognitionStrategy) Values() []AudioRecognitionStrategy { return []AudioRecognitionStrategy{ "UseSlotValuesAsCustomVocabulary", @@ -296,9 +296,9 @@ const ( BotStatusUpdating BotStatus = "Updating" ) -// Values returns all known values for BotStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BotStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BotStatus) Values() []BotStatus { return []BotStatus{ "Creating", @@ -369,9 +369,10 @@ const ( BuiltInSlotTypeSortAttributeSlotTypeSignature BuiltInSlotTypeSortAttribute = "SlotTypeSignature" ) -// Values returns all known values for BuiltInSlotTypeSortAttribute. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for BuiltInSlotTypeSortAttribute. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (BuiltInSlotTypeSortAttribute) Values() []BuiltInSlotTypeSortAttribute { return []BuiltInSlotTypeSortAttribute{ "SlotTypeSignature", @@ -462,9 +463,9 @@ const ( ErrorCodeInternalServerFailure ErrorCode = "INTERNAL_SERVER_FAILURE" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "DUPLICATE_INPUT", @@ -534,9 +535,9 @@ const ( ExportStatusDeleting ExportStatus = "Deleting" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "InProgress", @@ -644,9 +645,9 @@ const ( ImportStatusDeleting ImportStatus = "Deleting" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "InProgress", @@ -736,9 +737,9 @@ const ( MessageSelectionStrategyOrdered MessageSelectionStrategy = "Ordered" ) -// Values returns all known values for MessageSelectionStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MessageSelectionStrategy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageSelectionStrategy) Values() []MessageSelectionStrategy { return []MessageSelectionStrategy{ "Random", @@ -868,9 +869,9 @@ const ( SlotShapeList SlotShape = "List" ) -// Values returns all known values for SlotShape. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SlotShape. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SlotShape) Values() []SlotShape { return []SlotShape{ "Scalar", @@ -962,8 +963,8 @@ const ( SlotTypeSortAttributeLastUpdatedDateTime SlotTypeSortAttribute = "LastUpdatedDateTime" ) -// Values returns all known values for SlotTypeSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SlotTypeSortAttribute. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SlotTypeSortAttribute) Values() []SlotTypeSortAttribute { return []SlotTypeSortAttribute{ @@ -1000,9 +1001,9 @@ const ( SortOrderDescending SortOrder = "Descending" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "Ascending", diff --git a/service/lexmodelsv2/types/errors.go b/service/lexmodelsv2/types/errors.go index 6cd3dd045d3..fdf1c136c9e 100644 --- a/service/lexmodelsv2/types/errors.go +++ b/service/lexmodelsv2/types/errors.go @@ -88,8 +88,8 @@ func (e *PreconditionFailedException) ErrorCode() string { } func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You asked to describe a resource that doesn't exist. Check the resource that you -// are requesting and try again. +// You asked to describe a resource that doesn't exist. Check the resource that +// you are requesting and try again. type ResourceNotFoundException struct { Message *string diff --git a/service/lexmodelsv2/types/types.go b/service/lexmodelsv2/types/types.go index e13531f201d..f4508828d58 100644 --- a/service/lexmodelsv2/types/types.go +++ b/service/lexmodelsv2/types/types.go @@ -114,8 +114,8 @@ type AllowedInputTypes struct { type AssociatedTranscript struct { // The content of the transcript that meets the search filter criteria. For the - // JSON format of the transcript, see Output transcript format - // (https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html). + // JSON format of the transcript, see Output transcript format (https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html) + // . Transcript *string noSmithyDocumentSerde @@ -161,8 +161,7 @@ type AudioAndDTMFInputSpecification struct { type AudioLogDestination struct { // The Amazon S3 bucket where the audio log files are stored. The IAM role - // specified in the roleArn parameter of the CreateBot - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) + // specified in the roleArn parameter of the CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html) // operation must have permission to write to this bucket. // // This member is required. @@ -228,8 +227,8 @@ type BotAliasHistoryEvent struct { // different Lambda function depending on the bot's locale. type BotAliasLocaleSettings struct { - // Determines whether the locale is enabled for the bot. If the value is false, the - // locale isn't available for use. + // Determines whether the locale is enabled for the bot. If the value is false , + // the locale isn't available for use. // // This member is required. Enabled bool @@ -240,21 +239,19 @@ type BotAliasLocaleSettings struct { noSmithyDocumentSerde } -// Summary information about bot aliases returned from the ListBotAliases -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) +// Summary information about bot aliases returned from the ListBotAliases (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) // operation. type BotAliasSummary struct { // The unique identifier assigned to the bot alias. You can use this ID to get - // detailed information about the alias using the DescribeBotAlias - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html) + // detailed information about the alias using the DescribeBotAlias (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html) // operation. BotAliasId *string // The name of the bot alias. BotAliasName *string - // The current state of the bot alias. If the status is Available, the alias is + // The current state of the bot alias. If the status is Available , the alias is // ready for use. BotAliasStatus BotAliasStatus @@ -383,9 +380,10 @@ type BotLocaleFilter struct { // This member is required. Name BotLocaleFilterName - // The operator to use for the filter. Specify EQ when the ListBotLocales operation - // should return only aliases that equal the specified value. Specify CO when the - // ListBotLocales operation should return aliases that contain the specified value. + // The operator to use for the filter. Specify EQ when the ListBotLocales + // operation should return only aliases that equal the specified value. Specify CO + // when the ListBotLocales operation should return aliases that contain the + // specified value. // // This member is required. Operator BotLocaleFilterOperator @@ -431,28 +429,24 @@ type BotLocaleImportSpecification struct { // The identifier of the language and locale that the bot will be used in. The // string must match one of the supported locales. All of the intents, slot types, // and slots used in the bot must have the same locale. For more information, see - // Supported languages - // (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // . // // This member is required. LocaleId *string - // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, - // AMAZON.KendraSearchIntent, or both when returning alternative intents. + // Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent + // , AMAZON.KendraSearchIntent , or both when returning alternative intents. // AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they // are configured for the bot. For example, suppose a bot is configured with the - // confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns + // confidence threshold of 0.80 and the AMAZON.FallbackIntent . Amazon Lex returns // three alternative intents with the following confidence scores: IntentA (0.70), // IntentB (0.60), IntentC (0.50). The response from the PostText operation would // be: - // - // * AMAZON.FallbackIntent - // - // * IntentA - // - // * IntentB - // - // * IntentC + // - AMAZON.FallbackIntent + // - IntentA + // - IntentB + // - IntentC NluIntentConfidenceThreshold *float64 // Defines settings for using an Amazon Polly voice to communicate with a user. @@ -477,8 +471,7 @@ type BotLocaleSortBy struct { noSmithyDocumentSerde } -// Summary information about bot locales returned by the ListBotLocales -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) +// Summary information about bot locales returned by the ListBotLocales (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) // operation. type BotLocaleSummary struct { @@ -535,8 +528,9 @@ type BotMember struct { noSmithyDocumentSerde } -// The object representing the URL of the bot definition, the URL of the associated -// transcript, and a statistical summary of the bot recommendation results. +// The object representing the URL of the bot definition, the URL of the +// associated transcript, and a statistical summary of the bot recommendation +// results. type BotRecommendationResults struct { // The presigned url link of the associated transcript. @@ -604,22 +598,20 @@ type BotSortBy struct { noSmithyDocumentSerde } -// Summary information about a bot returned by the ListBots -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) +// Summary information about a bot returned by the ListBots (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) // operation. type BotSummary struct { // The unique identifier assigned to the bot. Use this ID to get detailed - // information about the bot with the DescribeBot - // (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html) + // information about the bot with the DescribeBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html) // operation. BotId *string // The name of the bot. BotName *string - // The current status of the bot. When the status is Available the bot is ready for - // use. + // The current status of the bot. When the status is Available the bot is ready + // for use. BotStatus BotStatus // The type of the bot. @@ -664,8 +656,7 @@ type BotVersionSortBy struct { noSmithyDocumentSerde } -// Summary information about a bot version returned by the ListBotVersions -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html) +// Summary information about a bot version returned by the ListBotVersions (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html) // operation. type BotVersionSummary struct { @@ -676,8 +667,8 @@ type BotVersionSummary struct { // ready for use. BotStatus BotStatus - // The numeric version of the bot, or DRAFT to indicate that this is the version of - // the bot that can be updated.. + // The numeric version of the bot, or DRAFT to indicate that this is the version + // of the bot that can be updated.. BotVersion *string // A timestamp of the date and time that the version was created. @@ -705,16 +696,16 @@ type BuiltInIntentSortBy struct { noSmithyDocumentSerde } -// Provides summary information about a built-in intent for the ListBuiltInIntents -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html) +// Provides summary information about a built-in intent for the +// ListBuiltInIntents (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html) // operation. type BuiltInIntentSummary struct { // The description of the intent. Description *string - // The signature of the built-in intent. Use this to specify the parent intent of a - // derived intent. + // The signature of the built-in intent. Use this to specify the parent intent of + // a derived intent. IntentSignature *string noSmithyDocumentSerde @@ -737,8 +728,7 @@ type BuiltInSlotTypeSortBy struct { } // Provides summary information about a built-in slot type for the -// ListBuiltInSlotTypes -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) +// ListBuiltInSlotTypes (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) // operation. type BuiltInSlotTypeSummary struct { @@ -762,8 +752,8 @@ type Button struct { // This member is required. Text *string - // The value returned to Amazon Lex when the user chooses this button. This must be - // one of the slot values configured for the slot. + // The value returned to Amazon Lex when the user chooses this button. This must + // be one of the slot values configured for the slot. // // This member is required. Value *string @@ -775,8 +765,8 @@ type Button struct { // delivered. The log group must exist before you enable logging. type CloudWatchLogGroupLogDestination struct { - // The Amazon Resource Name (ARN) of the log group where text and metadata logs are - // delivered. + // The Amazon Resource Name (ARN) of the log group where text and metadata logs + // are delivered. // // This member is required. CloudWatchLogGroupArn *string @@ -950,7 +940,7 @@ type CustomVocabularyImportSpecification struct { BotVersion *string // The identifier of the local to import the custom vocabulary to. The value must - // be en_GB. + // be en_GB . // // This member is required. LocaleId *string @@ -994,22 +984,22 @@ type DataPrivacy struct { // other application that is directed or targeted, in whole or in part, to children // under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) // by specifying true or false in the childDirected field. By specifying true in - // the childDirected field, you confirm that your use of Amazon Lex is related to a - // website, program, or other application that is directed or targeted, in whole or - // in part, to children under age 13 and subject to COPPA. By specifying false in - // the childDirected field, you confirm that your use of Amazon Lex is not related - // to a website, program, or other application that is directed or targeted, in - // whole or in part, to children under age 13 and subject to COPPA. You may not - // specify a default value for the childDirected field that does not accurately - // reflect whether your use of Amazon Lex is related to a website, program, or - // other application that is directed or targeted, in whole or in part, to children - // under age 13 and subject to COPPA. If your use of Amazon Lex relates to a - // website, program, or other application that is directed in whole or in part, to - // children under age 13, you must obtain any required verifiable parental consent - // under COPPA. For information regarding the use of Amazon Lex in connection with - // websites, programs, or other applications that are directed or targeted, in - // whole or in part, to children under age 13, see the Amazon Lex FAQ - // (https://aws.amazon.com/lex/faqs#data-security). + // the childDirected field, you confirm that your use of Amazon Lex is related to + // a website, program, or other application that is directed or targeted, in whole + // or in part, to children under age 13 and subject to COPPA. By specifying false + // in the childDirected field, you confirm that your use of Amazon Lex is not + // related to a website, program, or other application that is directed or + // targeted, in whole or in part, to children under age 13 and subject to COPPA. + // You may not specify a default value for the childDirected field that does not + // accurately reflect whether your use of Amazon Lex is related to a website, + // program, or other application that is directed or targeted, in whole or in part, + // to children under age 13 and subject to COPPA. If your use of Amazon Lex relates + // to a website, program, or other application that is directed in whole or in + // part, to children under age 13, you must obtain any required verifiable parental + // consent under COPPA. For information regarding the use of Amazon Lex in + // connection with websites, programs, or other applications that are directed or + // targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ (https://aws.amazon.com/lex/faqs#data-security) + // . // // This member is required. ChildDirected bool @@ -1017,8 +1007,8 @@ type DataPrivacy struct { noSmithyDocumentSerde } -// The object used for specifying the data range that the customer wants Amazon Lex -// to read through in the input transcripts. +// The object used for specifying the data range that the customer wants Amazon +// Lex to read through in the input transcripts. type DateRangeFilter struct { // A timestamp indicating the end date for the date range filter. @@ -1057,7 +1047,7 @@ type DialogAction struct { // This member is required. Type DialogActionType - // If the dialog action is ElicitSlot, defines the slot to elicit from the user. + // If the dialog action is ElicitSlot , defines the slot to elicit from the user. SlotToElicit *string // When true the next message for the intent is not used. @@ -1138,8 +1128,8 @@ type DTMFSpecification struct { // This member is required. EndCharacter *string - // How long the bot should wait after the last DTMF character input before assuming - // that the input has concluded. + // How long the bot should wait after the last DTMF character input before + // assuming that the input has concluded. // // This member is required. EndTimeoutMs *int32 @@ -1168,9 +1158,9 @@ type ElicitationCodeHookInvocationSetting struct { noSmithyDocumentSerde } -// The object representing the passwords that were used to encrypt the data related -// to the bot recommendation, as well as the KMS key ARN used to encrypt the -// associated metadata. +// The object representing the passwords that were used to encrypt the data +// related to the bot recommendation, as well as the KMS key ARN used to encrypt +// the associated metadata. type EncryptionSetting struct { // The password used to encrypt the associated transcript file. @@ -1186,8 +1176,7 @@ type EncryptionSetting struct { noSmithyDocumentSerde } -// Filters the response form the ListExports -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) +// Filters the response form the ListExports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) // operation type ExportFilter struct { @@ -1204,8 +1193,8 @@ type ExportFilter struct { // This member is required. Operator ExportFilterOperator - // The values to use to filter the response. The values must be Bot, BotLocale, or - // CustomVocabulary. + // The values to use to filter the response. The values must be Bot , BotLocale , + // or CustomVocabulary . // // This member is required. Values []string @@ -1214,7 +1203,7 @@ type ExportFilter struct { } // Provides information about the bot or bot locale that you want to export. You -// can specify the botExportSpecification or the botLocaleExportSpecification, but +// can specify the botExportSpecification or the botLocaleExportSpecification , but // not both. type ExportResourceSpecification struct { @@ -1316,9 +1305,9 @@ type FulfillmentCodeHookSettings struct { // conversations. FulfillmentUpdatesSpecification *FulfillmentUpdatesSpecification - // Provides settings for messages sent to the user for after the Lambda fulfillment - // function completes. Post-fulfillment messages can be sent for both streaming and - // non-streaming conversations. + // Provides settings for messages sent to the user for after the Lambda + // fulfillment function completes. Post-fulfillment messages can be sent for both + // streaming and non-streaming conversations. PostFulfillmentStatusSpecification *PostFulfillmentStatusSpecification noSmithyDocumentSerde @@ -1376,8 +1365,8 @@ type FulfillmentUpdateResponseSpecification struct { type FulfillmentUpdatesSpecification struct { // Determines whether fulfillment updates are sent to the user. When this field is - // true, updates are sent. If the active field is set to true, the startResponse, - // updateResponse, and timeoutInSeconds fields are required. + // true, updates are sent. If the active field is set to true, the startResponse , + // updateResponse , and timeoutInSeconds fields are required. // // This member is required. Active *bool @@ -1432,14 +1421,15 @@ type GrammarSlotTypeSource struct { // with a button on the card. type ImageResponseCard struct { - // The title to display on the response card. The format of the title is determined - // by the platform displaying the response card. + // The title to display on the response card. The format of the title is + // determined by the platform displaying the response card. // // This member is required. Title *string - // A list of buttons that should be displayed on the response card. The arrangement - // of the buttons is determined by the platform that displays the button. + // A list of buttons that should be displayed on the response card. The + // arrangement of the buttons is determined by the platform that displays the + // button. Buttons []Button // The URL of an image to display on the response card. The image URL must be @@ -1454,8 +1444,7 @@ type ImageResponseCard struct { noSmithyDocumentSerde } -// Filters the response from the ListImports -// (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) +// Filters the response from the ListImports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) // operation. type ImportFilter struct { @@ -1472,8 +1461,8 @@ type ImportFilter struct { // This member is required. Operator ImportFilterOperator - // The values to use to filter the response. The values must be Bot, BotLocale, or - // CustomVocabulary. + // The values to use to filter the response. The values must be Bot , BotLocale , + // or CustomVocabulary . // // This member is required. Values []string @@ -1482,7 +1471,7 @@ type ImportFilter struct { } // Provides information about the bot or bot locale that you want to import. You -// can specify the botImportSpecification or the botLocaleImportSpecification, but +// can specify the botImportSpecification or the botLocaleImportSpecification , but // not both. type ImportResourceSpecification struct { @@ -1571,8 +1560,8 @@ type InitialResponseSetting struct { noSmithyDocumentSerde } -// The name of a context that must be active for an intent to be selected by Amazon -// Lex. +// The name of a context that must be active for an intent to be selected by +// Amazon Lex. type InputContext struct { // The name of the context. @@ -1597,11 +1586,11 @@ type IntentClosingSetting struct { // A list of conditional branches associated with the intent's closing response. // These branches are executed when the nextStep attribute is set to - // EvalutateConditional. + // EvalutateConditional . Conditional *ConditionalSpecification - // Specifies the next step that the bot executes after playing the intent's closing - // response. + // Specifies the next step that the bot executes after playing the intent's + // closing response. NextStep *DialogState noSmithyDocumentSerde @@ -1621,15 +1610,15 @@ type IntentConfirmationSetting struct { // This member is required. PromptSpecification *PromptSpecification - // Specifies whether the intent's confirmation is sent to the user. When this field - // is false, confirmation and declination responses aren't sent. If the active - // field isn't specified, the default is true. + // Specifies whether the intent's confirmation is sent to the user. When this + // field is false, confirmation and declination responses aren't sent. If the + // active field isn't specified, the default is true. Active *bool - // The DialogCodeHookInvocationSetting object associated with intent's confirmation - // step. The dialog code hook is triggered based on these invocation settings when - // the confirmation next step or declination next step or failure next step is - // InvokeDialogCodeHook. + // The DialogCodeHookInvocationSetting object associated with intent's + // confirmation step. The dialog code hook is triggered based on these invocation + // settings when the confirmation next step or declination next step or failure + // next step is InvokeDialogCodeHook . CodeHook *DialogCodeHookInvocationSetting // A list of conditional branches to evaluate after the intent is closed. @@ -1650,7 +1639,7 @@ type IntentConfirmationSetting struct { // intent. DeclinationNextStep *DialogState - // When the user answers "no" to the question defined in promptSpecification, + // When the user answers "no" to the question defined in promptSpecification , // Amazon Lex responds with this response to acknowledge that the intent was // canceled. DeclinationResponse *ResponseSpecification @@ -1782,8 +1771,8 @@ type KendraConfiguration struct { // A query filter that Amazon Lex sends to Amazon Kendra to filter the response // from a query. The filter is in the format defined by Amazon Kendra. For more - // information, see Filtering queries - // (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html). + // information, see Filtering queries (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html) + // . QueryFilterString *string // Determines whether the AMAZON.KendraSearchIntent intent uses a custom query @@ -1860,12 +1849,12 @@ type MessageGroup struct { // Indicates whether a slot can return multiple values. type MultipleValuesSetting struct { - // Indicates whether a slot can return multiple values. When true, the slot may - // return more than one value in a response. When false, the slot returns only a + // Indicates whether a slot can return multiple values. When true , the slot may + // return more than one value in a response. When false , the slot returns only a // single value. Multi-value slots are only available in the en-US locale. If you // set this value to true in any other locale, Amazon Lex throws a - // ValidationException. If the allowMutlipleValues is not set, the default value is - // false. + // ValidationException . If the allowMutlipleValues is not set, the default value + // is false . AllowMultipleValues bool noSmithyDocumentSerde @@ -1884,8 +1873,8 @@ type NewCustomVocabularyItem struct { // vocabulary list. DisplayAs *string - // The weight assigned to the new custom vocabulary item from the custom vocabulary - // list. + // The weight assigned to the new custom vocabulary item from the custom + // vocabulary list. Weight *int32 noSmithyDocumentSerde @@ -1948,9 +1937,9 @@ type ParentBotNetwork struct { // only want Lex to read a subset of files in your Amazon S3 bucket. type PathFormat struct { - // A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. - // Specify this list if you only want Lex to read the files under this set of - // sub-folders. + // A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 + // bucket. Specify this list if you only want Lex to read the files under this set + // of sub-folders. ObjectPrefixes []string noSmithyDocumentSerde @@ -1971,11 +1960,11 @@ type PlainTextMessage struct { type PostDialogCodeHookInvocationSpecification struct { // A list of conditional branches to evaluate after the dialog code hook throws an - // exception or returns with the State field of the Intent object set to Failed. + // exception or returns with the State field of the Intent object set to Failed . FailureConditional *ConditionalSpecification // Specifies the next step the bot runs after the dialog code hook throws an - // exception or returns with the State field of the Intent object set to Failed. + // exception or returns with the State field of the Intent object set to Failed . FailureNextStep *DialogState // Specifies a list of message groups that Amazon Lex uses to respond the user @@ -2007,19 +1996,18 @@ type PostDialogCodeHookInvocationSpecification struct { noSmithyDocumentSerde } -// Provides a setting that determines whether the post-fulfillment response is sent -// to the user. For more information, see -// https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete -// (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete) +// Provides a setting that determines whether the post-fulfillment response is +// sent to the user. For more information, see +// https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete) type PostFulfillmentStatusSpecification struct { // A list of conditional branches to evaluate after the fulfillment code hook // throws an exception or returns with the State field of the Intent object set to - // Failed. + // Failed . FailureConditional *ConditionalSpecification // Specifies the next step the bot runs after the fulfillment code hook throws an - // exception or returns with the State field of the Intent object set to Failed. + // exception or returns with the State field of the Intent object set to Failed . FailureNextStep *DialogState // Specifies a list of message groups that Amazon Lex uses to respond the user @@ -2054,9 +2042,9 @@ type PostFulfillmentStatusSpecification struct { } // The IAM principal that you allowing or denying access to an Amazon Lex action. -// You must provide a service or an arn, but not both in the same statement. For -// more information, see AWS JSON policy elements: Principal -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). +// You must provide a service or an arn , but not both in the same statement. For +// more information, see AWS JSON policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) +// . type Principal struct { // The Amazon Resource Name (ARN) of the principal. @@ -2127,8 +2115,8 @@ type RecommendedIntentSummary struct { // The name of a recommended intent associated with the bot recommendation. IntentName *string - // The count of sample utterances of a recommended intent that is associated with a - // bot recommendation. + // The count of sample utterances of a recommended intent that is associated with + // a bot recommendation. SampleUtterancesCount *int32 noSmithyDocumentSerde @@ -2140,18 +2128,14 @@ type RecommendedIntentSummary struct { // 1600, the time window is set to 1 hour, and the last refresh time was 1530, only // utterances made between 1430 and 1530 are returned. You can choose the time // window that statistics should be returned for. -// -// * Hours - You can request -// utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are -// refreshed every half hour for 1 hour time windows, and hourly for the other time -// windows. -// -// * Days - You can request utterance statistics for 3 days. Statistics -// are refreshed every 6 hours. -// -// * Weeks - You can see statistics for one or two -// weeks. Statistics are refreshed every 12 hours for one week time windows, and -// once per day for two week time windows. +// - Hours - You can request utterance statistics for 1, 3, 6, 12, or 24 hour +// time windows. Statistics are refreshed every half hour for 1 hour time windows, +// and hourly for the other time windows. +// - Days - You can request utterance statistics for 3 days. Statistics are +// refreshed every 6 hours. +// - Weeks - You can see statistics for one or two weeks. Statistics are +// refreshed every 12 hours for one week time windows, and once per day for two +// week time windows. type RelativeAggregationDuration struct { // The type of time period that the timeValue field represents. @@ -2161,13 +2145,9 @@ type RelativeAggregationDuration struct { // The period of the time window to gather statistics for. The valid value depends // on the setting of the timeDimension field. - // - // * Hours - 1/3/6/12/24 - // - // * Days - 3 - // - // * - // Weeks - 1/2 + // - Hours - 1/3/6/12/24 + // - Days - 3 + // - Weeks - 1/2 // // This member is required. TimeValue int32 @@ -2227,8 +2207,9 @@ type S3BucketTranscriptSource struct { // This member is required. TranscriptFormat TranscriptFormat - // The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only - // use this field if your bucket is encrypted using a customer managed KMS key. + // The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. + // Only use this field if your bucket is encrypted using a customer managed KMS + // key. KmsKeyArn *string // The object that contains a path format that will be applied when Amazon Lex @@ -2248,8 +2229,8 @@ type S3BucketTranscriptSource struct { // prompt. type SampleUtterance struct { - // The sample utterance that Amazon Lex uses to build its machine-learning model to - // recognize intents. + // The sample utterance that Amazon Lex uses to build its machine-learning model + // to recognize intents. // // This member is required. Utterance *string @@ -2268,8 +2249,8 @@ type SampleValue struct { noSmithyDocumentSerde } -// Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment -// of user utterances. +// Determines whether Amazon Lex will use Amazon Comprehend to detect the +// sentiment of user utterances. type SentimentAnalysisSettings struct { // Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user @@ -2287,8 +2268,8 @@ type SlotCaptureSetting struct { // A list of conditional branches to evaluate after the slot value is captured. CaptureConditional *ConditionalSpecification - // Specifies the next step that the bot runs when the slot value is captured before - // the code hook times out. + // Specifies the next step that the bot runs when the slot value is captured + // before the code hook times out. CaptureNextStep *DialogState // Specifies a list of message groups that Amazon Lex uses to respond the user @@ -2487,20 +2468,15 @@ type SlotTypeSummary struct { ParentSlotTypeSignature *string // Indicates the type of the slot type. - // - // * Custom - A slot type that you created - // using custom values. For more information, see Creating custom slot types - // (https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html). - // - // * - // Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in - // slot type. For more information, see AMAZON.AlphaNumeric - // (https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html). - // - // * - // ExternalGrammar - A slot type using a custom GRXML grammar to define values. For - // more information, see Using a custom grammar slot type - // (https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html). + // - Custom - A slot type that you created using custom values. For more + // information, see Creating custom slot types (https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html) + // . + // - Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in + // slot type. For more information, see AMAZON.AlphaNumeric (https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html) + // . + // - ExternalGrammar - A slot type using a custom GRXML grammar to define values. + // For more information, see Using a custom grammar slot type (https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html) + // . SlotTypeCategory SlotTypeCategory // The unique identifier assigned to the slot type. @@ -2554,9 +2530,10 @@ type SlotValueElicitationSetting struct { // The prompt that Amazon Lex uses to elicit the slot value from the user. PromptSpecification *PromptSpecification - // If you know a specific pattern that users might respond to an Amazon Lex request - // for a slot value, you can provide those utterances to improve accuracy. This is - // optional. In most cases, Amazon Lex is capable of understanding user utterances. + // If you know a specific pattern that users might respond to an Amazon Lex + // request for a slot value, you can provide those utterances to improve accuracy. + // This is optional. In most cases, Amazon Lex is capable of understanding user + // utterances. SampleUtterances []SampleUtterance // Specifies the settings that Amazon Lex uses when a slot value is successfully @@ -2573,9 +2550,9 @@ type SlotValueElicitationSetting struct { // The slot values that Amazon Lex uses when it sets slot values in a dialog step. type SlotValueOverride struct { - // When the shape value is List, it indicates that the values field contains a list - // of slot values. When the value is Scalar, it indicates that the value field - // contains a single value. + // When the shape value is List , it indicates that the values field contains a + // list of slot values. When the value is Scalar , it indicates that the value + // field contains a single value. Shape SlotShape // The current value of the slot. @@ -2595,21 +2572,13 @@ type SlotValueRegexFilter struct { // A regular expression used to validate the value of a slot. Use a standard // regular expression. Amazon Lex supports the following characters in the regular // expression: - // - // * A-Z, a-z - // - // * 0-9 - // - // * Unicode characters ("\ u") - // - // Represent Unicode - // characters with four digits, for example "\u0041" or "\u005A". The following - // regular expression operators are not supported: - // - // * Infinite repeaters: *, +, or - // {x,} with no upper bound. - // - // * Wild card (.) + // - A-Z, a-z + // - 0-9 + // - Unicode characters ("\ u") + // Represent Unicode characters with four digits, for example "\u0041" or + // "\u005A". The following regular expression operators are not supported: + // - Infinite repeaters: *, +, or {x,} with no upper bound. + // - Wild card (.) // // This member is required. Pattern *string @@ -2620,19 +2589,14 @@ type SlotValueRegexFilter struct { // Contains settings used by Amazon Lex to select a slot value. type SlotValueSelectionSetting struct { - // Determines the slot resolution strategy that Amazon Lex uses to return slot type - // values. The field can be set to one of the following values: - // - // * OriginalValue - - // Returns the value entered by the user, if the user value is similar to the slot - // value. - // - // * TopResolution - If there is a resolution list for the slot, return the - // first value in the resolution list as the slot type value. If there is no - // resolution list, null is returned. - // - // If you don't specify the - // valueSelectionStrategy, the default is OriginalValue. + // Determines the slot resolution strategy that Amazon Lex uses to return slot + // type values. The field can be set to one of the following values: + // - OriginalValue - Returns the value entered by the user, if the user value is + // similar to the slot value. + // - TopResolution - If there is a resolution list for the slot, return the + // first value in the resolution list as the slot type value. If there is no + // resolution list, null is returned. + // If you don't specify the valueSelectionStrategy, the default is OriginalValue. // // This member is required. ResolutionStrategy SlotValueResolutionStrategy @@ -2674,8 +2638,8 @@ type SSMLMessage struct { noSmithyDocumentSerde } -// Defines the messages that Amazon Lex sends to a user to remind them that the bot -// is waiting for a response. +// Defines the messages that Amazon Lex sends to a user to remind them that the +// bot is waiting for a response. type StillWaitingResponseSpecification struct { // How often a message should be sent to the user. Minimum of 1 second, maximum of @@ -2690,14 +2654,14 @@ type StillWaitingResponseSpecification struct { // This member is required. MessageGroups []MessageGroup - // If Amazon Lex waits longer than this length of time for a response, it will stop - // sending messages. + // If Amazon Lex waits longer than this length of time for a response, it will + // stop sending messages. // // This member is required. TimeoutInSeconds *int32 - // Indicates that the user can interrupt the response by speaking while the message - // is being played. + // Indicates that the user can interrupt the response by speaking while the + // message is being played. AllowInterrupt *bool noSmithyDocumentSerde @@ -2707,8 +2671,8 @@ type StillWaitingResponseSpecification struct { // composite slot. type SubSlotSetting struct { - // The expression text for defining the constituent sub slots in the composite slot - // using logical AND and OR operators. + // The expression text for defining the constituent sub slots in the composite + // slot using logical AND and OR operators. Expression *string // Specifications for the constituent sub slots of a composite slot. @@ -2753,10 +2717,10 @@ type SubSlotValueElicitationSetting struct { // slot. DefaultValueSpecification *SlotDefaultValueSpecification - // If you know a specific pattern that users might respond to an Amazon Lex request - // for a sub slot value, you can provide those utterances to improve accuracy. This - // is optional. In most cases Amazon Lex is capable of understanding user - // utterances. This is similar to SampleUtterances for slots. + // If you know a specific pattern that users might respond to an Amazon Lex + // request for a sub slot value, you can provide those utterances to improve + // accuracy. This is optional. In most cases Amazon Lex is capable of understanding + // user utterances. This is similar to SampleUtterances for slots. SampleUtterances []SampleUtterance // Specifies the prompts that Amazon Lex uses while a bot is waiting for customer @@ -2848,11 +2812,10 @@ type VoiceSettings struct { VoiceId *string // Indicates the type of Amazon Polly voice that Amazon Lex should use for voice - // interaction with the user. For more information, see the engine parameter of the - // SynthesizeSpeech operation - // (https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) + // interaction with the user. For more information, see the engine parameter of + // the SynthesizeSpeech operation (https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) // in the Amazon Polly developer guide. If you do not specify a value, the default - // is standard. + // is standard . Engine VoiceEngine noSmithyDocumentSerde @@ -2862,8 +2825,8 @@ type VoiceSettings struct { // input. type WaitAndContinueSpecification struct { - // The response that Amazon Lex sends to indicate that the bot is ready to continue - // the conversation. + // The response that Amazon Lex sends to indicate that the bot is ready to + // continue the conversation. // // This member is required. ContinueResponse *ResponseSpecification diff --git a/service/lexruntimeservice/api_client.go b/service/lexruntimeservice/api_client.go index eb8fa5c713d..cc7f5a39054 100644 --- a/service/lexruntimeservice/api_client.go +++ b/service/lexruntimeservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lexruntimeservice/api_op_GetSession.go b/service/lexruntimeservice/api_op_GetSession.go index 0d114896d8a..b6b36b8a64e 100644 --- a/service/lexruntimeservice/api_op_GetSession.go +++ b/service/lexruntimeservice/api_op_GetSession.go @@ -39,8 +39,8 @@ type GetSessionInput struct { // This member is required. BotName *string - // The ID of the client application user. Amazon Lex uses this to identify a user's - // conversation with your bot. + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. // // This member is required. UserId *string @@ -56,9 +56,9 @@ type GetSessionInput struct { type GetSessionOutput struct { // A list of active contexts for the session. A context can be set when an intent - // is fulfilled or by calling the PostContent, PostText, or PutSession operation. - // You can use a context to control the intents that can follow up an intent, or to - // modify the operation of your application. + // is fulfilled or by calling the PostContent , PostText , or PutSession + // operation. You can use a context to control the intents that can follow up an + // intent, or to modify the operation of your application. ActiveContexts []types.ActiveContext // Describes the current state of the bot. @@ -71,8 +71,8 @@ type GetSessionOutput struct { // request, the array contains only the intents with the specified label. RecentIntentSummaryView []types.IntentSummary - // Map of key/value pairs representing the session-specific context information. It - // contains application information passed between Amazon Lex and a client + // Map of key/value pairs representing the session-specific context information. + // It contains application information passed between Amazon Lex and a client // application. SessionAttributes map[string]string diff --git a/service/lexruntimeservice/api_op_PostContent.go b/service/lexruntimeservice/api_op_PostContent.go index c327cafaddf..a3d56dc07e2 100644 --- a/service/lexruntimeservice/api_op_PostContent.go +++ b/service/lexruntimeservice/api_op_PostContent.go @@ -19,55 +19,38 @@ import ( // audio to achieve higher speech recognition accuracy in telephone audio // applications. In response, Amazon Lex returns the next message to convey to the // user. Consider the following example messages: +// - For a user input "I would like a pizza," Amazon Lex might return a response +// with a message eliciting slot data (for example, PizzaSize ): "What size pizza +// would you like?". +// - After the user provides all of the pizza order information, Amazon Lex +// might return a response with a message to get user confirmation: "Order the +// pizza?". +// - After the user replies "Yes" to the confirmation prompt, Amazon Lex might +// return a conclusion statement: "Thank you, your cheese pizza has been ordered.". // -// * For a user input "I would like -// a pizza," Amazon Lex might return a response with a message eliciting slot data -// (for example, PizzaSize): "What size pizza would you like?". +// Not all Amazon Lex messages require a response from the user. For example, +// conclusion statements do not require a response. Some messages require only a +// yes or no response. In addition to the message , Amazon Lex provides additional +// context about the message in the response that you can use to enhance client +// behavior, such as displaying the appropriate client user interface. Consider the +// following examples: +// - If the message is to elicit slot data, Amazon Lex returns the following +// context information: +// - x-amz-lex-dialog-state header set to ElicitSlot +// - x-amz-lex-intent-name header set to the intent name in the current context +// - x-amz-lex-slot-to-elicit header set to the slot name for which the message +// is eliciting information +// - x-amz-lex-slots header set to a map of slots configured for the intent with +// their current values +// - If the message is a confirmation prompt, the x-amz-lex-dialog-state header +// is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted. +// - If the message is a clarification prompt configured for the intent, +// indicating that the user intent is not understood, the x-amz-dialog-state +// header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted. // -// * After the user -// provides all of the pizza order information, Amazon Lex might return a response -// with a message to get user confirmation: "Order the pizza?". -// -// * After the user -// replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion -// statement: "Thank you, your cheese pizza has been ordered.". -// -// Not all Amazon Lex -// messages require a response from the user. For example, conclusion statements do -// not require a response. Some messages require only a yes or no response. In -// addition to the message, Amazon Lex provides additional context about the -// message in the response that you can use to enhance client behavior, such as -// displaying the appropriate client user interface. Consider the following -// examples: -// -// * If the message is to elicit slot data, Amazon Lex returns the -// following context information: -// -// * x-amz-lex-dialog-state header set to -// ElicitSlot -// -// * x-amz-lex-intent-name header set to the intent name in the current -// context -// -// * x-amz-lex-slot-to-elicit header set to the slot name for which the -// message is eliciting information -// -// * x-amz-lex-slots header set to a map of slots -// configured for the intent with their current values -// -// * If the message is a -// confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation -// and the x-amz-lex-slot-to-elicit header is omitted. -// -// * If the message is a -// clarification prompt configured for the intent, indicating that the user intent -// is not understood, the x-amz-dialog-state header is set to ElicitIntent and the -// x-amz-slot-to-elicit header is omitted. -// -// In addition, Amazon Lex also returns -// your application-specific sessionAttributes. For more information, see Managing -// Conversation Context -// (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). +// In addition, Amazon Lex also returns your application-specific sessionAttributes +// . For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html) +// . func (c *Client) PostContent(ctx context.Context, params *PostContentInput, optFns ...func(*Options)) (*PostContentOutput, error) { if params == nil { params = &PostContentInput{} @@ -97,28 +80,16 @@ type PostContentInput struct { // You pass this value as the Content-Type HTTP header. Indicates the audio format // or text. The header value must start with one of the following prefixes: - // - // * PCM - // format, audio data must be in little-endian byte order. - // - // * audio/l16; - // rate=16000; channels=1 - // - // * audio/x-l16; sample-rate=16000; channel-count=1 - // - // * - // audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; - // is-big-endian=false - // - // * Opus format - // - // * audio/x-cbr-opus-with-preamble; - // preamble-size=0; bit-rate=256000; frame-size-milliseconds=4 - // - // * Text format - // - // * - // text/plain; charset=utf-8 + // - PCM format, audio data must be in little-endian byte order. + // - audio/l16; rate=16000; channels=1 + // - audio/x-l16; sample-rate=16000; channel-count=1 + // - audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; + // is-big-endian=false + // - Opus format + // - audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; + // frame-size-milliseconds=4 + // - Text format + // - text/plain; charset=utf-8 // // This member is required. ContentType *string @@ -132,61 +103,43 @@ type PostContentInput struct { // This member is required. InputStream io.Reader - // The ID of the client application user. Amazon Lex uses this to identify a user's - // conversation with your bot. At runtime, each request must contain the userID - // field. To decide the user ID to use for your application, consider the following - // factors. - // - // * The userID field must not contain any personally identifiable - // information of the user, for example, name, personal identification numbers, or - // other end user personal information. - // - // * If you want a user to start a - // conversation on one device and continue on another device, use a user-specific - // identifier. - // - // * If you want the same user to be able to have two independent - // conversations on two different devices, choose a device-specific identifier. - // - // * - // A user can't have two independent conversations with two different versions of - // the same bot. For example, a user can't have a conversation with the PROD and - // BETA versions of the same bot. If you anticipate that a user will need to have - // conversation with two different versions, for example, while testing, include - // the bot alias in the user ID to separate the two conversations. + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. At runtime, each request must contain the + // userID field. To decide the user ID to use for your application, consider the + // following factors. + // - The userID field must not contain any personally identifiable information of + // the user, for example, name, personal identification numbers, or other end user + // personal information. + // - If you want a user to start a conversation on one device and continue on + // another device, use a user-specific identifier. + // - If you want the same user to be able to have two independent conversations + // on two different devices, choose a device-specific identifier. + // - A user can't have two independent conversations with two different versions + // of the same bot. For example, a user can't have a conversation with the PROD and + // BETA versions of the same bot. If you anticipate that a user will need to have + // conversation with two different versions, for example, while testing, include + // the bot alias in the user ID to separate the two conversations. // // This member is required. UserId *string - // You pass this value as the Accept HTTP header. The message Amazon Lex returns in - // the response can be either text or speech based on the Accept HTTP header value - // in the request. - // - // * If the value is text/plain; charset=utf-8, Amazon Lex returns - // text in the response. - // - // * If the value begins with audio/, Amazon Lex returns - // speech in the response. Amazon Lex uses Amazon Polly to generate the speech - // (using the configuration you specified in the Accept header). For example, if - // you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG - // format. - // - // * If the value is audio/pcm, the speech returned is audio/pcm in - // 16-bit, little endian format. - // - // * The following are the accepted values: - // - // * - // audio/mpeg - // - // * audio/ogg - // - // * audio/pcm - // - // * text/plain; charset=utf-8 - // - // * audio/* - // (defaults to mpeg) + // You pass this value as the Accept HTTP header. The message Amazon Lex returns + // in the response can be either text or speech based on the Accept HTTP header + // value in the request. + // - If the value is text/plain; charset=utf-8 , Amazon Lex returns text in the + // response. + // - If the value begins with audio/ , Amazon Lex returns speech in the response. + // Amazon Lex uses Amazon Polly to generate the speech (using the configuration you + // specified in the Accept header). For example, if you specify audio/mpeg as the + // value, Amazon Lex returns speech in the MPEG format. + // - If the value is audio/pcm , the speech returned is audio/pcm in 16-bit, + // little endian format. + // - The following are the accepted values: + // - audio/mpeg + // - audio/ogg + // - audio/pcm + // - text/plain; charset=utf-8 + // - audio/* (defaults to mpeg) Accept *string // A list of contexts active for the request. A context can be activated when a @@ -201,11 +154,11 @@ type PostContentInput struct { // You pass this value as the x-amz-lex-request-attributes HTTP header. // Request-specific information passed between Amazon Lex and a client application. // The value must be a JSON serialized and base64 encoded map with string keys and - // values. The total size of the requestAttributes and sessionAttributes headers is - // limited to 12 KB. The namespace x-amz-lex: is reserved for special attributes. - // Don't create any request attributes with the prefix x-amz-lex:. For more - // information, see Setting Request Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). + // values. The total size of the requestAttributes and sessionAttributes headers + // is limited to 12 KB. The namespace x-amz-lex: is reserved for special + // attributes. Don't create any request attributes with the prefix x-amz-lex: . For + // more information, see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs) + // . // // This value conforms to the media type: application/json RequestAttributes *string @@ -214,9 +167,9 @@ type PostContentInput struct { // Application-specific information passed between Amazon Lex and a client // application. The value must be a JSON serialized and base64 encoded map with // string keys and values. The total size of the sessionAttributes and - // requestAttributes headers is limited to 12 KB. For more information, see Setting - // Session Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). + // requestAttributes headers is limited to 12 KB. For more information, see + // Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs) + // . // // This value conforms to the media type: application/json SessionAttributes *string @@ -227,9 +180,9 @@ type PostContentInput struct { type PostContentOutput struct { // A list of active contexts for the session. A context can be set when an intent - // is fulfilled or by calling the PostContent, PostText, or PutSession operation. - // You can use a context to control the intents that can follow up an intent, or to - // modify the operation of your application. + // is fulfilled or by calling the PostContent , PostText , or PutSession + // operation. You can use a context to control the intents that can follow up an + // intent, or to modify the operation of your application. // // This value conforms to the media type: application/json ActiveContexts *string @@ -246,7 +199,7 @@ type PostContentOutput struct { // configuration and context. For example, if Amazon Lex did not understand the // user intent, it sends the clarificationPrompt configured for the bot. If the // intent requires confirmation before taking the fulfillment action, it sends the - // confirmationPrompt. Another example: Suppose that the Lambda function + // confirmationPrompt . Another example: Suppose that the Lambda function // successfully fulfilled the intent, and sent a message to convey to the user. // Then Amazon Lex sends that message in the response. AudioStream io.ReadCloser @@ -260,41 +213,33 @@ type PostContentOutput struct { ContentType *string // Identifies the current state of the user interaction. Amazon Lex returns one of - // the following values as dialogState. The client can optionally use this + // the following values as dialogState . The client can optionally use this // information to customize the user interface. - // - // * ElicitIntent - Amazon Lex wants - // to elicit the user's intent. Consider the following examples: For example, a - // user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot - // infer the user intent from this utterance, it will return this dialog state. - // - // * - // ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For example, - // Amazon Lex wants user confirmation before fulfilling an intent. Instead of a - // simple "yes" or "no" response, a user might respond with additional information. - // For example, "yes, but make it a thick crust pizza" or "no, I want to order a - // drink." Amazon Lex can process such additional information (in these examples, - // update the crust type slot or change the intent from OrderPizza to - // OrderDrink). - // - // * ElicitSlot - Amazon Lex is expecting the value of a slot for the - // current intent. For example, suppose that in the response Amazon Lex sends this - // message: "What size pizza would you like?". A user might reply with the slot - // value (e.g., "medium"). The user might also provide additional information in - // the response (e.g., "medium thick crust pizza"). Amazon Lex can process such - // additional information appropriately. - // - // * Fulfilled - Conveys that the Lambda - // function has successfully fulfilled the intent. - // - // * ReadyForFulfillment - Conveys - // that the client has to fulfill the request. - // - // * Failed - Conveys that the - // conversation with the user failed. This can happen for various reasons, - // including that the user does not provide an appropriate response to prompts from - // the service (you can configure how many times Amazon Lex can prompt a user for - // specific information), or if the Lambda function fails to fulfill the intent. + // - ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the + // following examples: For example, a user might utter an intent ("I want to order + // a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it + // will return this dialog state. + // - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For + // example, Amazon Lex wants user confirmation before fulfilling an intent. Instead + // of a simple "yes" or "no" response, a user might respond with additional + // information. For example, "yes, but make it a thick crust pizza" or "no, I want + // to order a drink." Amazon Lex can process such additional information (in these + // examples, update the crust type slot or change the intent from OrderPizza to + // OrderDrink). + // - ElicitSlot - Amazon Lex is expecting the value of a slot for the current + // intent. For example, suppose that in the response Amazon Lex sends this message: + // "What size pizza would you like?". A user might reply with the slot value (e.g., + // "medium"). The user might also provide additional information in the response + // (e.g., "medium thick crust pizza"). Amazon Lex can process such additional + // information appropriately. + // - Fulfilled - Conveys that the Lambda function has successfully fulfilled the + // intent. + // - ReadyForFulfillment - Conveys that the client has to fulfill the request. + // - Failed - Conveys that the conversation with the user failed. This can happen + // for various reasons, including that the user does not provide an appropriate + // response to prompts from the service (you can configure how many times Amazon + // Lex can prompt a user for specific information), or if the Lambda function fails + // to fulfill the intent. DialogState types.DialogState // The text used to process the request. If the input was an audio stream, the @@ -316,9 +261,9 @@ type PostContentOutput struct { // groups Amazon Lex returns one message from each group in the response. The // message field is an escaped JSON string containing the messages. For more // information about the structure of the JSON string returned, see - // msg-prompts-formats. If the Lambda function returns a message, Amazon Lex passes - // it to the client in its response. The encodedMessage field is base-64 encoded. - // You must decode the field before you can use the value. + // msg-prompts-formats . If the Lambda function returns a message, Amazon Lex + // passes it to the client in its response. The encodedMessage field is base-64 + // encoded. You must decode the field before you can use the value. EncodedMessage *string // The text used to process the request. You can use this field only in the de-DE, @@ -352,7 +297,7 @@ type PostContentOutput struct { // to groups. When messages are assigned to groups Amazon Lex returns one message // from each group in the response. The message field is an escaped JSON string // containing the messages. For more information about the structure of the JSON - // string returned, see msg-prompts-formats. If the Lambda function returns a + // string returned, see msg-prompts-formats . If the Lambda function returns a // message, Amazon Lex passes it to the client in its response. // // Deprecated: The message field is deprecated, use the encodedMessage field @@ -361,19 +306,12 @@ type PostContentOutput struct { Message *string // The format of the response message. One of the following values: - // - // * PlainText - - // The message contains plain UTF-8 text. - // - // * CustomPayload - The message is a - // custom format for the client. - // - // * SSML - The message contains text formatted for - // voice output. - // - // * Composite - The message contains an escaped JSON object - // containing one or more messages from the groups that messages were assigned to - // when the intent was created. + // - PlainText - The message contains plain UTF-8 text. + // - CustomPayload - The message is a custom format for the client. + // - SSML - The message contains text formatted for voice output. + // - Composite - The message contains an escaped JSON object containing one or + // more messages from the groups that messages were assigned to when the intent was + // created. MessageFormat types.MessageFormatType // Provides a score that indicates how confident Amazon Lex is that the returned @@ -397,19 +335,19 @@ type PostContentOutput struct { // The unique identifier for the session. SessionId *string - // If the dialogState value is ElicitSlot, returns the name of the slot for which + // If the dialogState value is ElicitSlot , returns the name of the slot for which // Amazon Lex is eliciting a value. SlotToElicit *string - // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the - // user input during the conversation. The field is base-64 encoded. Amazon Lex + // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from + // the user input during the conversation. The field is base-64 encoded. Amazon Lex // creates a resolution list containing likely values for a slot. The value that it // returns is determined by the valueSelectionStrategy selected when the slot type - // was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the + // was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE , the // value provided by the user is returned, if the user value is similar to the slot // values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns // the first value in the resolution list or, if there is no resolution list, null. - // If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE. + // If you don't specify a valueSelectionStrategy , the default is ORIGINAL_VALUE . // // This value conforms to the media type: application/json Slots *string diff --git a/service/lexruntimeservice/api_op_PostText.go b/service/lexruntimeservice/api_op_PostText.go index 1939d523a51..3432fe5e725 100644 --- a/service/lexruntimeservice/api_op_PostText.go +++ b/service/lexruntimeservice/api_op_PostText.go @@ -16,55 +16,40 @@ import ( // using the machine learning model it built for the bot. In response, Amazon Lex // returns the next message to convey to the user an optional responseCard to // display. Consider the following example messages: +// - For a user input "I would like a pizza", Amazon Lex might return a response +// with a message eliciting slot data (for example, PizzaSize): "What size pizza +// would you like?" +// - After the user provides all of the pizza order information, Amazon Lex +// might return a response with a message to obtain user confirmation "Proceed with +// the pizza order?". +// - After the user replies to a confirmation prompt with a "yes", Amazon Lex +// might return a conclusion statement: "Thank you, your cheese pizza has been +// ordered.". // -// * For a user input "I would -// like a pizza", Amazon Lex might return a response with a message eliciting slot -// data (for example, PizzaSize): "What size pizza would you like?" +// Not all Amazon Lex messages require a user response. For example, a conclusion +// statement does not require a response. Some messages require only a "yes" or +// "no" user response. In addition to the message , Amazon Lex provides additional +// context about the message in the response that you might use to enhance client +// behavior, for example, to display the appropriate client user interface. These +// are the slotToElicit , dialogState , intentName , and slots fields in the +// response. Consider the following examples: +// - If the message is to elicit slot data, Amazon Lex returns the following +// context information: +// - dialogState set to ElicitSlot +// - intentName set to the intent name in the current context +// - slotToElicit set to the slot name for which the message is eliciting +// information +// - slots set to a map of slots, configured for the intent, with currently known +// values +// - If the message is a confirmation prompt, the dialogState is set to +// ConfirmIntent and SlotToElicit is set to null. +// - If the message is a clarification prompt (configured for the intent) that +// indicates that user intent is not understood, the dialogState is set to +// ElicitIntent and slotToElicit is set to null. // -// * After the -// user provides all of the pizza order information, Amazon Lex might return a -// response with a message to obtain user confirmation "Proceed with the pizza -// order?". -// -// * After the user replies to a confirmation prompt with a "yes", Amazon -// Lex might return a conclusion statement: "Thank you, your cheese pizza has been -// ordered.". -// -// Not all Amazon Lex messages require a user response. For example, a -// conclusion statement does not require a response. Some messages require only a -// "yes" or "no" user response. In addition to the message, Amazon Lex provides -// additional context about the message in the response that you might use to -// enhance client behavior, for example, to display the appropriate client user -// interface. These are the slotToElicit, dialogState, intentName, and slots fields -// in the response. Consider the following examples: -// -// * If the message is to elicit -// slot data, Amazon Lex returns the following context information: -// -// * dialogState -// set to ElicitSlot -// -// * intentName set to the intent name in the current context -// -// * -// slotToElicit set to the slot name for which the message is eliciting -// information -// -// * slots set to a map of slots, configured for the intent, with -// currently known values -// -// * If the message is a confirmation prompt, the -// dialogState is set to ConfirmIntent and SlotToElicit is set to null. -// -// * If the -// message is a clarification prompt (configured for the intent) that indicates -// that user intent is not understood, the dialogState is set to ElicitIntent and -// slotToElicit is set to null. -// -// In addition, Amazon Lex also returns your -// application-specific sessionAttributes. For more information, see Managing -// Conversation Context -// (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). +// In addition, Amazon Lex also returns your application-specific sessionAttributes +// . For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html) +// . func (c *Client) PostText(ctx context.Context, params *PostTextInput, optFns ...func(*Options)) (*PostTextOutput, error) { if params == nil { params = &PostTextInput{} @@ -97,28 +82,22 @@ type PostTextInput struct { // This member is required. InputText *string - // The ID of the client application user. Amazon Lex uses this to identify a user's - // conversation with your bot. At runtime, each request must contain the userID - // field. To decide the user ID to use for your application, consider the following - // factors. - // - // * The userID field must not contain any personally identifiable - // information of the user, for example, name, personal identification numbers, or - // other end user personal information. - // - // * If you want a user to start a - // conversation on one device and continue on another device, use a user-specific - // identifier. - // - // * If you want the same user to be able to have two independent - // conversations on two different devices, choose a device-specific identifier. - // - // * - // A user can't have two independent conversations with two different versions of - // the same bot. For example, a user can't have a conversation with the PROD and - // BETA versions of the same bot. If you anticipate that a user will need to have - // conversation with two different versions, for example, while testing, include - // the bot alias in the user ID to separate the two conversations. + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. At runtime, each request must contain the + // userID field. To decide the user ID to use for your application, consider the + // following factors. + // - The userID field must not contain any personally identifiable information of + // the user, for example, name, personal identification numbers, or other end user + // personal information. + // - If you want a user to start a conversation on one device and continue on + // another device, use a user-specific identifier. + // - If you want the same user to be able to have two independent conversations + // on two different devices, choose a device-specific identifier. + // - A user can't have two independent conversations with two different versions + // of the same bot. For example, a user can't have a conversation with the PROD and + // BETA versions of the same bot. If you anticipate that a user will need to have + // conversation with two different versions, for example, while testing, include + // the bot alias in the user ID to separate the two conversations. // // This member is required. UserId *string @@ -130,16 +109,16 @@ type PostTextInput struct { // session are cleared. ActiveContexts []types.ActiveContext - // Request-specific information passed between Amazon Lex and a client application. - // The namespace x-amz-lex: is reserved for special attributes. Don't create any - // request attributes with the prefix x-amz-lex:. For more information, see Setting - // Request Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). + // Request-specific information passed between Amazon Lex and a client + // application. The namespace x-amz-lex: is reserved for special attributes. Don't + // create any request attributes with the prefix x-amz-lex: . For more information, + // see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs) + // . RequestAttributes map[string]string // Application-specific information passed between Amazon Lex and a client - // application. For more information, see Setting Session Attributes - // (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). + // application. For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs) + // . SessionAttributes map[string]string noSmithyDocumentSerde @@ -148,9 +127,9 @@ type PostTextInput struct { type PostTextOutput struct { // A list of active contexts for the session. A context can be set when an intent - // is fulfilled or by calling the PostContent, PostText, or PutSession operation. - // You can use a context to control the intents that can follow up an intent, or to - // modify the operation of your application. + // is fulfilled or by calling the PostContent , PostText , or PutSession + // operation. You can use a context to control the intents that can follow up an + // intent, or to modify the operation of your application. ActiveContexts []types.ActiveContext // One to four alternative intents that may be applicable to the user's intent. @@ -165,41 +144,31 @@ type PostTextOutput struct { BotVersion *string // Identifies the current state of the user interaction. Amazon Lex returns one of - // the following values as dialogState. The client can optionally use this + // the following values as dialogState . The client can optionally use this // information to customize the user interface. - // - // * ElicitIntent - Amazon Lex wants - // to elicit user intent. For example, a user might utter an intent ("I want to - // order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, - // it will return this dialogState. - // - // * ConfirmIntent - Amazon Lex is expecting a - // "yes" or "no" response. For example, Amazon Lex wants user confirmation before - // fulfilling an intent. Instead of a simple "yes" or "no," a user might respond - // with additional information. For example, "yes, but make it thick crust pizza" - // or "no, I want to order a drink". Amazon Lex can process such additional - // information (in these examples, update the crust type slot value, or change - // intent from OrderPizza to OrderDrink). - // - // * ElicitSlot - Amazon Lex is expecting a - // slot value for the current intent. For example, suppose that in the response - // Amazon Lex sends this message: "What size pizza would you like?". A user might - // reply with the slot value (e.g., "medium"). The user might also provide - // additional information in the response (e.g., "medium thick crust pizza"). - // Amazon Lex can process such additional information appropriately. - // - // * Fulfilled - - // Conveys that the Lambda function configured for the intent has successfully - // fulfilled the intent. - // - // * ReadyForFulfillment - Conveys that the client has to - // fulfill the intent. - // - // * Failed - Conveys that the conversation with the user - // failed. This can happen for various reasons including that the user did not - // provide an appropriate response to prompts from the service (you can configure - // how many times Amazon Lex can prompt a user for specific information), or the - // Lambda function failed to fulfill the intent. + // - ElicitIntent - Amazon Lex wants to elicit user intent. For example, a user + // might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer + // the user intent from this utterance, it will return this dialogState. + // - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response. For + // example, Amazon Lex wants user confirmation before fulfilling an intent. Instead + // of a simple "yes" or "no," a user might respond with additional information. For + // example, "yes, but make it thick crust pizza" or "no, I want to order a drink". + // Amazon Lex can process such additional information (in these examples, update + // the crust type slot value, or change intent from OrderPizza to OrderDrink). + // - ElicitSlot - Amazon Lex is expecting a slot value for the current intent. + // For example, suppose that in the response Amazon Lex sends this message: "What + // size pizza would you like?". A user might reply with the slot value (e.g., + // "medium"). The user might also provide additional information in the response + // (e.g., "medium thick crust pizza"). Amazon Lex can process such additional + // information appropriately. + // - Fulfilled - Conveys that the Lambda function configured for the intent has + // successfully fulfilled the intent. + // - ReadyForFulfillment - Conveys that the client has to fulfill the intent. + // - Failed - Conveys that the conversation with the user failed. This can happen + // for various reasons including that the user did not provide an appropriate + // response to prompts from the service (you can configure how many times Amazon + // Lex can prompt a user for specific information), or the Lambda function failed + // to fulfill the intent. DialogState types.DialogState // The current user intent that Amazon Lex is aware of. @@ -215,32 +184,25 @@ type PostTextOutput struct { // you can assign messages to groups. When messages are assigned to groups Amazon // Lex returns one message from each group in the response. The message field is an // escaped JSON string containing the messages. For more information about the - // structure of the JSON string returned, see msg-prompts-formats. If the Lambda + // structure of the JSON string returned, see msg-prompts-formats . If the Lambda // function returns a message, Amazon Lex passes it to the client in its response. Message *string // The format of the response message. One of the following values: - // - // * PlainText - - // The message contains plain UTF-8 text. - // - // * CustomPayload - The message is a - // custom format defined by the Lambda function. - // - // * SSML - The message contains - // text formatted for voice output. - // - // * Composite - The message contains an escaped - // JSON object containing one or more messages from the groups that messages were - // assigned to when the intent was created. + // - PlainText - The message contains plain UTF-8 text. + // - CustomPayload - The message is a custom format defined by the Lambda + // function. + // - SSML - The message contains text formatted for voice output. + // - Composite - The message contains an escaped JSON object containing one or + // more messages from the groups that messages were assigned to when the intent was + // created. MessageFormat types.MessageFormatType // Provides a score that indicates how confident Amazon Lex is that the returned // intent is the one that matches the user's intent. The score is between 0.0 and - // 1.0. For more information, see Confidence Scores - // (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html). The score is - // a relative score, not an absolute score. The score may change based on - // improvements to Amazon Lex. + // 1.0. For more information, see Confidence Scores (https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html) + // . The score is a relative score, not an absolute score. The score may change + // based on improvements to Amazon Lex. NluIntentConfidence *types.IntentConfidence // Represents the options that the user has to respond to the current prompt. @@ -260,19 +222,19 @@ type PostTextOutput struct { // A unique identifier for the session. SessionId *string - // If the dialogState value is ElicitSlot, returns the name of the slot for which + // If the dialogState value is ElicitSlot , returns the name of the slot for which // Amazon Lex is eliciting a value. SlotToElicit *string // The intent slots that Amazon Lex detected from the user input in the // conversation. Amazon Lex creates a resolution list containing likely values for // a slot. The value that it returns is determined by the valueSelectionStrategy - // selected when the slot type was created or updated. If valueSelectionStrategy is - // set to ORIGINAL_VALUE, the value provided by the user is returned, if the user - // value is similar to the slot values. If valueSelectionStrategy is set to + // selected when the slot type was created or updated. If valueSelectionStrategy + // is set to ORIGINAL_VALUE , the value provided by the user is returned, if the + // user value is similar to the slot values. If valueSelectionStrategy is set to // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if - // there is no resolution list, null. If you don't specify a - // valueSelectionStrategy, the default is ORIGINAL_VALUE. + // there is no resolution list, null. If you don't specify a valueSelectionStrategy + // , the default is ORIGINAL_VALUE . Slots map[string]string // Metadata pertaining to the operation's result. diff --git a/service/lexruntimeservice/api_op_PutSession.go b/service/lexruntimeservice/api_op_PutSession.go index 40d24207841..3ad2d75f132 100644 --- a/service/lexruntimeservice/api_op_PutSession.go +++ b/service/lexruntimeservice/api_op_PutSession.go @@ -14,8 +14,8 @@ import ( // Creates a new session or modifies an existing session with an Amazon Lex bot. // Use this operation to enable your application to set the state of the bot. For -// more information, see Managing Sessions -// (https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html). +// more information, see Managing Sessions (https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html) +// . func (c *Client) PutSession(ctx context.Context, params *PutSessionInput, optFns ...func(*Options)) (*PutSessionOutput, error) { if params == nil { params = &PutSessionInput{} @@ -43,40 +43,28 @@ type PutSessionInput struct { // This member is required. BotName *string - // The ID of the client application user. Amazon Lex uses this to identify a user's - // conversation with your bot. + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. // // This member is required. UserId *string - // The message that Amazon Lex returns in the response can be either text or speech - // based depending on the value of this field. - // - // * If the value is text/plain; - // charset=utf-8, Amazon Lex returns text in the response. - // - // * If the value begins - // with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon - // Polly to generate the speech in the configuration that you specify. For example, - // if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG - // format. - // - // * If the value is audio/pcm, the speech is returned as audio/pcm in - // 16-bit, little endian format. - // - // * The following are the accepted values: - // - // * - // audio/mpeg - // - // * audio/ogg - // - // * audio/pcm - // - // * audio/* (defaults to mpeg) - // - // * - // text/plain; charset=utf-8 + // The message that Amazon Lex returns in the response can be either text or + // speech based depending on the value of this field. + // - If the value is text/plain; charset=utf-8 , Amazon Lex returns text in the + // response. + // - If the value begins with audio/ , Amazon Lex returns speech in the response. + // Amazon Lex uses Amazon Polly to generate the speech in the configuration that + // you specify. For example, if you specify audio/mpeg as the value, Amazon Lex + // returns speech in the MPEG format. + // - If the value is audio/pcm , the speech is returned as audio/pcm in 16-bit, + // little endian format. + // - The following are the accepted values: + // - audio/mpeg + // - audio/ogg + // - audio/pcm + // - audio/* (defaults to mpeg) + // - text/plain; charset=utf-8 Accept *string // A list of contexts active for the request. A context can be activated when a @@ -89,28 +77,24 @@ type PutSessionInput struct { // Sets the next action that the bot should take to fulfill the conversation. DialogAction *types.DialogAction - // A summary of the recent intents for the bot. You can use the intent summary view - // to set a checkpoint label on an intent and modify attributes of intents. You can - // also use it to remove or add intent summary objects to the list. An intent that - // you modify or add to the list must make sense for the bot. For example, the - // intent name must be valid for the bot. You must provide valid values for: - // - // * - // intentName - // - // * slot names - // - // * slotToElict - // - // If you send the recentIntentSummaryView - // parameter in a PutSession request, the contents of the new summary view replaces - // the old summary view. For example, if a GetSession request returns three intents - // in the summary view and you call PutSession with one intent in the summary view, - // the next call to GetSession will only return one intent. + // A summary of the recent intents for the bot. You can use the intent summary + // view to set a checkpoint label on an intent and modify attributes of intents. + // You can also use it to remove or add intent summary objects to the list. An + // intent that you modify or add to the list must make sense for the bot. For + // example, the intent name must be valid for the bot. You must provide valid + // values for: + // - intentName + // - slot names + // - slotToElict + // If you send the recentIntentSummaryView parameter in a PutSession request, the + // contents of the new summary view replaces the old summary view. For example, if + // a GetSession request returns three intents in the summary view and you call + // PutSession with one intent in the summary view, the next call to GetSession + // will only return one intent. RecentIntentSummaryView []types.IntentSummary - // Map of key/value pairs representing the session-specific context information. It - // contains application information passed between Amazon Lex and a client + // Map of key/value pairs representing the session-specific context information. + // It contains application information passed between Amazon Lex and a client // application. SessionAttributes map[string]string @@ -130,25 +114,18 @@ type PutSessionOutput struct { // Content type as specified in the Accept HTTP header in the request. ContentType *string - // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm - // the intent before fulfilling an intent. - // - // * ElicitIntent - Amazon Lex wants to - // elicit the user's intent. - // - // * ElicitSlot - Amazon Lex is expecting the value of a - // slot for the current intent. - // - // * Failed - Conveys that the conversation with the - // user has failed. This can happen for various reasons, including the user does - // not provide an appropriate response to prompts from the service, or if the - // Lambda function fails to fulfill the intent. - // - // * Fulfilled - Conveys that the - // Lambda function has sucessfully fulfilled the intent. - // - // * ReadyForFulfillment - - // Conveys that the client has to fulfill the intent. + // - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm + // the intent before fulfilling an intent. + // - ElicitIntent - Amazon Lex wants to elicit the user's intent. + // - ElicitSlot - Amazon Lex is expecting the value of a slot for the current + // intent. + // - Failed - Conveys that the conversation with the user has failed. This can + // happen for various reasons, including the user does not provide an appropriate + // response to prompts from the service, or if the Lambda function fails to fulfill + // the intent. + // - Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the + // intent. + // - ReadyForFulfillment - Conveys that the client has to fulfill the intent. DialogState types.DialogState // The next message that should be presented to the user. The encodedMessage field @@ -169,19 +146,12 @@ type PutSessionOutput struct { Message *string // The format of the response message. One of the following values: - // - // * PlainText - - // The message contains plain UTF-8 text. - // - // * CustomPayload - The message is a - // custom format for the client. - // - // * SSML - The message contains text formatted for - // voice output. - // - // * Composite - The message contains an escaped JSON object - // containing one or more messages from the groups that messages were assigned to - // when the intent was created. + // - PlainText - The message contains plain UTF-8 text. + // - CustomPayload - The message is a custom format for the client. + // - SSML - The message contains text formatted for voice output. + // - Composite - The message contains an escaped JSON object containing one or + // more messages from the groups that messages were assigned to when the intent was + // created. MessageFormat types.MessageFormatType // Map of key/value pairs representing session-specific context information. @@ -192,7 +162,7 @@ type PutSessionOutput struct { // A unique identifier for the session. SessionId *string - // If the dialogState is ElicitSlot, returns the name of the slot for which Amazon + // If the dialogState is ElicitSlot , returns the name of the slot for which Amazon // Lex is eliciting a value. SlotToElicit *string @@ -200,11 +170,11 @@ type PutSessionOutput struct { // the conversation. Amazon Lex creates a resolution list containing likely values // for a slot. The value that it returns is determined by the // valueSelectionStrategy selected when the slot type was created or updated. If - // valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user + // valueSelectionStrategy is set to ORIGINAL_VALUE , the value provided by the user // is returned, if the user value is similar to the slot values. If // valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first // value in the resolution list or, if there is no resolution list, null. If you - // don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE. + // don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE . // // This value conforms to the media type: application/json Slots *string diff --git a/service/lexruntimeservice/types/errors.go b/service/lexruntimeservice/types/errors.go index 643fd3a63c7..bf8f31addd1 100644 --- a/service/lexruntimeservice/types/errors.go +++ b/service/lexruntimeservice/types/errors.go @@ -34,8 +34,8 @@ func (e *BadGatewayException) ErrorCode() string { } func (e *BadGatewayException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// Request validation failed, there is no usable message in the context, or the bot -// build failed, is still in progress, or contains unbuilt changes. +// Request validation failed, there is no usable message in the context, or the +// bot build failed, is still in progress, or contains unbuilt changes. type BadRequestException struct { Message *string @@ -87,17 +87,13 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. -// For example, -// -// * If Amazon Lex does not have sufficient permissions to call a -// Lambda function. -// -// * If a Lambda function takes longer than 30 seconds to -// execute. -// -// * If a fulfillment Lambda function returns a Delegate dialog action -// without removing any slot values. +// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an +// exception. For example, +// - If Amazon Lex does not have sufficient permissions to call a Lambda +// function. +// - If a Lambda function takes longer than 30 seconds to execute. +// - If a fulfillment Lambda function returns a Delegate dialog action without +// removing any slot values. type DependencyFailedException struct { Message *string @@ -229,8 +225,8 @@ func (e *NotAcceptableException) ErrorCode() string { } func (e *NotAcceptableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The resource (such as the Amazon Lex bot or an alias) that is referred to is not -// found. +// The resource (such as the Amazon Lex bot or an alias) that is referred to is +// not found. type NotFoundException struct { Message *string @@ -282,7 +278,7 @@ func (e *RequestTimeoutException) ErrorCode() string { } func (e *RequestTimeoutException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Content-Type header (PostContent API) has an invalid value. +// The Content-Type header ( PostContent API) has an invalid value. type UnsupportedMediaTypeException struct { Message *string diff --git a/service/lexruntimeservice/types/types.go b/service/lexruntimeservice/types/types.go index f34b51c078d..f153b6f46d8 100644 --- a/service/lexruntimeservice/types/types.go +++ b/service/lexruntimeservice/types/types.go @@ -6,10 +6,10 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// A context is a variable that contains information about the current state of the -// conversation between a user and Amazon Lex. Context can be set automatically by -// Amazon Lex when an intent is fulfilled, or it can be set at runtime using the -// PutContent, PutText, or PutSession operation. +// A context is a variable that contains information about the current state of +// the conversation between a user and Amazon Lex. Context can be set automatically +// by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the +// PutContent , PutText , or PutSession operation. type ActiveContext struct { // The name of the context. @@ -67,44 +67,32 @@ type Button struct { // Describes the next action that the bot should take in its interaction with the // user and provides information about the context in which the action takes place. -// Use the DialogAction data type to set the interaction to a specific state, or to -// return the interaction to a previous state. +// Use the DialogAction data type to set the interaction to a specific state, or +// to return the interaction to a previous state. type DialogAction struct { // The next action that the bot should take in its interaction with the user. The // possible values are: + // - ConfirmIntent - The next action is asking the user if the intent is complete + // and ready to be fulfilled. This is a yes/no question such as "Place the order?" + // - Close - Indicates that the there will not be a response from the user. For + // example, the statement "Your order has been placed" does not require a response. // - // * ConfirmIntent - The next action is asking the user if - // the intent is complete and ready to be fulfilled. This is a yes/no question such - // as "Place the order?" - // - // * Close - Indicates that the there will not be a response - // from the user. For example, the statement "Your order has been placed" does not - // require a response. - // - // * Delegate - The next action is determined by Amazon - // Lex. - // - // * ElicitIntent - The next action is to determine the intent that the user - // wants to fulfill. - // - // * ElicitSlot - The next action is to elicit a slot value from - // the user. + // - Delegate - The next action is determined by Amazon Lex. + // - ElicitIntent - The next action is to determine the intent that the user + // wants to fulfill. + // - ElicitSlot - The next action is to elicit a slot value from the user. // // This member is required. Type DialogActionType // The fulfillment state of the intent. The possible values are: - // - // * Failed - The - // Lambda function associated with the intent failed to fulfill the intent. - // - // * - // Fulfilled - The intent has fulfilled by the Lambda function associated with the - // intent. - // - // * ReadyForFulfillment - All of the information necessary for the intent - // is present and the intent ready to be fulfilled by the client application. + // - Failed - The Lambda function associated with the intent failed to fulfill + // the intent. + // - Fulfilled - The intent has fulfilled by the Lambda function associated with + // the intent. + // - ReadyForFulfillment - All of the information necessary for the intent is + // present and the intent ready to be fulfilled by the client application. FulfillmentState FulfillmentState // The name of the intent. @@ -114,17 +102,12 @@ type DialogAction struct { // Amazon Lex will use the message configured for the intent. Message *string - // * PlainText - The message contains plain UTF-8 text. - // - // * CustomPayload - The - // message is a custom format for the client. - // - // * SSML - The message contains text - // formatted for voice output. - // - // * Composite - The message contains an escaped JSON - // object containing one or more messages. For more information, see Message Groups - // (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html). + // - PlainText - The message contains plain UTF-8 text. + // - CustomPayload - The message is a custom format for the client. + // - SSML - The message contains text formatted for voice output. + // - Composite - The message contains an escaped JSON object containing one or + // more messages. For more information, see Message Groups (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html) + // . MessageFormat MessageFormatType // The name of the slot that should be elicited from the user. @@ -136,8 +119,8 @@ type DialogAction struct { noSmithyDocumentSerde } -// Represents an option rendered to the user when a prompt is shown. It could be an -// image, a button, a link, or text. +// Represents an option rendered to the user when a prompt is shown. It could be +// an image, a button, a link, or text. type GenericAttachment struct { // The URL of an attachment to the response card. @@ -177,64 +160,49 @@ type IntentSummary struct { // The next action that the bot should take in its interaction with the user. The // possible values are: + // - ConfirmIntent - The next action is asking the user if the intent is complete + // and ready to be fulfilled. This is a yes/no question such as "Place the order?" + // - Close - Indicates that the there will not be a response from the user. For + // example, the statement "Your order has been placed" does not require a response. // - // * ConfirmIntent - The next action is asking the user if - // the intent is complete and ready to be fulfilled. This is a yes/no question such - // as "Place the order?" - // - // * Close - Indicates that the there will not be a response - // from the user. For example, the statement "Your order has been placed" does not - // require a response. - // - // * ElicitIntent - The next action is to determine the intent - // that the user wants to fulfill. - // - // * ElicitSlot - The next action is to elicit a - // slot value from the user. + // - ElicitIntent - The next action is to determine the intent that the user + // wants to fulfill. + // - ElicitSlot - The next action is to elicit a slot value from the user. // // This member is required. DialogActionType DialogActionType - // A user-defined label that identifies a particular intent. You can use this label - // to return to a previous intent. Use the checkpointLabelFilter parameter of the - // GetSessionRequest operation to filter the intents returned by the operation to - // those with only the specified label. + // A user-defined label that identifies a particular intent. You can use this + // label to return to a previous intent. Use the checkpointLabelFilter parameter + // of the GetSessionRequest operation to filter the intents returned by the + // operation to those with only the specified label. CheckpointLabel *string // The status of the intent after the user responds to the confirmation prompt. If - // the user confirms the intent, Amazon Lex sets this field to Confirmed. If the - // user denies the intent, Amazon Lex sets this value to Denied. The possible + // the user confirms the intent, Amazon Lex sets this field to Confirmed . If the + // user denies the intent, Amazon Lex sets this value to Denied . The possible // values are: - // - // * Confirmed - The user has responded "Yes" to the confirmation - // prompt, confirming that the intent is complete and that it is ready to be - // fulfilled. - // - // * Denied - The user has responded "No" to the confirmation - // prompt. - // - // * None - The user has never been prompted for confirmation; or, the - // user was prompted but did not confirm or deny the prompt. + // - Confirmed - The user has responded "Yes" to the confirmation prompt, + // confirming that the intent is complete and that it is ready to be fulfilled. + // - Denied - The user has responded "No" to the confirmation prompt. + // - None - The user has never been prompted for confirmation; or, the user was + // prompted but did not confirm or deny the prompt. ConfirmationStatus ConfirmationStatus // The fulfillment state of the intent. The possible values are: - // - // * Failed - The - // Lambda function associated with the intent failed to fulfill the intent. - // - // * - // Fulfilled - The intent has fulfilled by the Lambda function associated with the - // intent. - // - // * ReadyForFulfillment - All of the information necessary for the intent - // is present and the intent ready to be fulfilled by the client application. + // - Failed - The Lambda function associated with the intent failed to fulfill + // the intent. + // - Fulfilled - The intent has fulfilled by the Lambda function associated with + // the intent. + // - ReadyForFulfillment - All of the information necessary for the intent is + // present and the intent ready to be fulfilled by the client application. FulfillmentState FulfillmentState // The name of the intent. IntentName *string - // The next slot to elicit from the user. If there is not slot to elicit, the field - // is blank. + // The next slot to elicit from the user. If there is not slot to elicit, the + // field is blank. SlotToElicit *string // Map of the slots that have been gathered and their values. @@ -261,10 +229,10 @@ type PredictedIntent struct { noSmithyDocumentSerde } -// If you configure a response card when creating your bots, Amazon Lex substitutes -// the session attributes and slot values that are available, and then returns it. -// The response card can also come from a Lambda function ( dialogCodeHook and -// fulfillmentActivity on an intent). +// If you configure a response card when creating your bots, Amazon Lex +// substitutes the session attributes and slot values that are available, and then +// returns it. The response card can also come from a Lambda function ( +// dialogCodeHook and fulfillmentActivity on an intent). type ResponseCard struct { // The content type of the response. diff --git a/service/lexruntimev2/api_client.go b/service/lexruntimev2/api_client.go index 83af61be5b6..c575a94386b 100644 --- a/service/lexruntimev2/api_client.go +++ b/service/lexruntimev2/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lexruntimev2/api_op_DeleteSession.go b/service/lexruntimev2/api_op_DeleteSession.go index 9d82f425e00..e300c87bb15 100644 --- a/service/lexruntimev2/api_op_DeleteSession.go +++ b/service/lexruntimev2/api_op_DeleteSession.go @@ -10,15 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes session information for a specified bot, alias, and user ID. You can use -// this operation to restart a conversation with a bot. When you remove a session, -// the entire history of the session is removed so that you can start again. You -// don't need to delete a session. Sessions have a time limit and will expire. Set -// the session time limit when you create the bot. The default is 5 minutes, but -// you can specify anything between 1 minute and 24 hours. If you specify a bot or -// alias ID that doesn't exist, you receive a BadRequestException. If the locale -// doesn't exist in the bot, or if the locale hasn't been enables for the alias, -// you receive a BadRequestException. +// Removes session information for a specified bot, alias, and user ID. You can +// use this operation to restart a conversation with a bot. When you remove a +// session, the entire history of the session is removed so that you can start +// again. You don't need to delete a session. Sessions have a time limit and will +// expire. Set the session time limit when you create the bot. The default is 5 +// minutes, but you can specify anything between 1 minute and 24 hours. If you +// specify a bot or alias ID that doesn't exist, you receive a BadRequestException. +// If the locale doesn't exist in the bot, or if the locale hasn't been enables for +// the alias, you receive a BadRequestException . func (c *Client) DeleteSession(ctx context.Context, params *DeleteSessionInput, optFns ...func(*Options)) (*DeleteSessionOutput, error) { if params == nil { params = &DeleteSessionInput{} diff --git a/service/lexruntimev2/api_op_GetSession.go b/service/lexruntimev2/api_op_GetSession.go index 6fddce62223..c6efe6295f1 100644 --- a/service/lexruntimev2/api_op_GetSession.go +++ b/service/lexruntimev2/api_op_GetSession.go @@ -14,9 +14,9 @@ import ( // Returns session information for a specified bot, alias, and user. For example, // you can use this operation to retrieve session information for a user that has // left a long-running session in use. If the bot, alias, or session identifier -// doesn't exist, Amazon Lex V2 returns a BadRequestException. If the locale -// doesn't exist or is not enabled for the alias, you receive a -// BadRequestException. +// doesn't exist, Amazon Lex V2 returns a BadRequestException . If the locale +// doesn't exist or is not enabled for the alias, you receive a BadRequestException +// . func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error) { if params == nil { params = &GetSessionInput{} @@ -74,9 +74,9 @@ type GetSessionOutput struct { // The identifier of the returned session. SessionId *string - // Represents the current state of the dialog between the user and the bot. You can - // use this to determine the progress of the conversation and what the next action - // might be. + // Represents the current state of the dialog between the user and the bot. You + // can use this to determine the progress of the conversation and what the next + // action might be. SessionState *types.SessionState // Metadata pertaining to the operation's result. diff --git a/service/lexruntimev2/api_op_PutSession.go b/service/lexruntimev2/api_op_PutSession.go index 9966252cb17..a2d44e1c0d7 100644 --- a/service/lexruntimev2/api_op_PutSession.go +++ b/service/lexruntimev2/api_op_PutSession.go @@ -12,8 +12,8 @@ import ( "io" ) -// Creates a new session or modifies an existing session with an Amazon Lex V2 bot. -// Use this operation to enable your application to set the state of the bot. +// Creates a new session or modifies an existing session with an Amazon Lex V2 +// bot. Use this operation to enable your application to set the state of the bot. func (c *Client) PutSession(ctx context.Context, params *PutSessionInput, optFns ...func(*Options)) (*PutSessionOutput, error) { if params == nil { params = &PutSessionInput{} @@ -51,28 +51,27 @@ type PutSessionInput struct { // This member is required. SessionId *string - // Sets the state of the session with the user. You can use this to set the current - // intent, attributes, context, and dialog action. Use the dialog action to + // Sets the state of the session with the user. You can use this to set the + // current intent, attributes, context, and dialog action. Use the dialog action to // determine the next step that Amazon Lex V2 should use in the conversation with // the user. // // This member is required. SessionState *types.SessionState - // A list of messages to send to the user. Messages are sent in the order that they - // are defined in the list. + // A list of messages to send to the user. Messages are sent in the order that + // they are defined in the list. Messages []types.Message // Request-specific information passed between Amazon Lex V2 and the client // application. The namespace x-amz-lex: is reserved for special attributes. Don't - // create any request attributes with the prefix x-amz-lex:. + // create any request attributes with the prefix x-amz-lex: . RequestAttributes map[string]string // The message that Amazon Lex V2 returns in the response can be either text or // speech depending on the value of this parameter. - // - // * If the value is text/plain; - // charset=utf-8, Amazon Lex V2 returns text in the response. + // - If the value is text/plain; charset=utf-8 , Amazon Lex V2 returns text in + // the response. ResponseContentType *string noSmithyDocumentSerde diff --git a/service/lexruntimev2/api_op_RecognizeText.go b/service/lexruntimev2/api_op_RecognizeText.go index 6fc7efb44fa..822c91eaeea 100644 --- a/service/lexruntimev2/api_op_RecognizeText.go +++ b/service/lexruntimev2/api_op_RecognizeText.go @@ -17,25 +17,21 @@ import ( // Amazon Lex V2 returns the next message to convey to the user and an optional // response card to display. If the optional post-fulfillment response is // specified, the messages are returned as follows. For more information, see -// PostFulfillmentStatusSpecification -// (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html). +// PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html) +// . +// - Success message - Returned if the Lambda function completes successfully +// and the intent state is fulfilled or ready fulfillment if the message is +// present. +// - Failed message - The failed message is returned if the Lambda function +// throws an exception or if the Lambda function returns a failed intent state +// without a message. +// - Timeout message - If you don't configure a timeout message and a timeout, +// and the Lambda function doesn't return within 30 seconds, the timeout message is +// returned. If you configure a timeout, the timeout message is returned when the +// period times out. // -// * -// Success message - Returned if the Lambda function completes successfully and the -// intent state is fulfilled or ready fulfillment if the message is present. -// -// * -// Failed message - The failed message is returned if the Lambda function throws an -// exception or if the Lambda function returns a failed intent state without a -// message. -// -// * Timeout message - If you don't configure a timeout message and a -// timeout, and the Lambda function doesn't return within 30 seconds, the timeout -// message is returned. If you configure a timeout, the timeout message is returned -// when the period times out. -// -// For more information, see Completion message -// (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html). +// For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html) +// . func (c *Client) RecognizeText(ctx context.Context, params *RecognizeTextInput, optFns ...func(*Options)) (*RecognizeTextOutput, error) { if params == nil { params = &RecognizeTextInput{} @@ -79,8 +75,8 @@ type RecognizeTextInput struct { Text *string // Request-specific information passed between the client application and Amazon - // Lex V2 The namespace x-amz-lex: is reserved for special attributes. Don't create - // any request attributes with the prefix x-amz-lex:. + // Lex V2 The namespace x-amz-lex: is reserved for special attributes. Don't + // create any request attributes with the prefix x-amz-lex: . RequestAttributes map[string]string // The current state of the dialog between the user and the bot. diff --git a/service/lexruntimev2/api_op_RecognizeUtterance.go b/service/lexruntimev2/api_op_RecognizeUtterance.go index aebbff8821b..8eca3a6e852 100644 --- a/service/lexruntimev2/api_op_RecognizeUtterance.go +++ b/service/lexruntimev2/api_op_RecognizeUtterance.go @@ -11,55 +11,42 @@ import ( "io" ) -// Sends user input to Amazon Lex V2. You can send text or speech. Clients use this -// API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 -// interprets the user input using the machine learning model built for the bot. +// Sends user input to Amazon Lex V2. You can send text or speech. Clients use +// this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex +// V2 interprets the user input using the machine learning model built for the bot. // The following request fields must be compressed with gzip and then base64 // encoded before you send them to Amazon Lex V2. +// - requestAttributes +// - sessionState // -// * requestAttributes +// The following response fields are compressed using gzip and then base64 encoded +// by Amazon Lex V2. Before you can use these fields, you must decode and +// decompress them. +// - inputTranscript +// - interpretations +// - messages +// - requestAttributes +// - sessionState // -// * -// sessionState +// The example contains a Java application that compresses and encodes a Java +// object to send to Amazon Lex V2, and a second that decodes and decompresses a +// response from Amazon Lex V2. If the optional post-fulfillment response is +// specified, the messages are returned as follows. For more information, see +// PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html) +// . +// - Success message - Returned if the Lambda function completes successfully +// and the intent state is fulfilled or ready fulfillment if the message is +// present. +// - Failed message - The failed message is returned if the Lambda function +// throws an exception or if the Lambda function returns a failed intent state +// without a message. +// - Timeout message - If you don't configure a timeout message and a timeout, +// and the Lambda function doesn't return within 30 seconds, the timeout message is +// returned. If you configure a timeout, the timeout message is returned when the +// period times out. // -// The following response fields are compressed using gzip and then -// base64 encoded by Amazon Lex V2. Before you can use these fields, you must -// decode and decompress them. -// -// * inputTranscript -// -// * interpretations -// -// * messages -// -// * -// requestAttributes -// -// * sessionState -// -// The example contains a Java application that -// compresses and encodes a Java object to send to Amazon Lex V2, and a second that -// decodes and decompresses a response from Amazon Lex V2. If the optional -// post-fulfillment response is specified, the messages are returned as follows. -// For more information, see PostFulfillmentStatusSpecification -// (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html). -// -// * -// Success message - Returned if the Lambda function completes successfully and the -// intent state is fulfilled or ready fulfillment if the message is present. -// -// * -// Failed message - The failed message is returned if the Lambda function throws an -// exception or if the Lambda function returns a failed intent state without a -// message. -// -// * Timeout message - If you don't configure a timeout message and a -// timeout, and the Lambda function doesn't return within 30 seconds, the timeout -// message is returned. If you configure a timeout, the timeout message is returned -// when the period times out. -// -// For more information, see Completion message -// (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html). +// For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html) +// . func (c *Client) RecognizeUtterance(ctx context.Context, params *RecognizeUtteranceInput, optFns ...func(*Options)) (*RecognizeUtteranceOutput, error) { if params == nil { params = &RecognizeUtteranceInput{} @@ -94,27 +81,17 @@ type RecognizeUtteranceInput struct { // Indicates the format for audio input or that the content is text. The header // must start with one of the following prefixes: + // - PCM format, audio data must be in little-endian byte order. + // - audio/l16; rate=16000; channels=1 + // - audio/x-l16; sample-rate=16000; channel-count=1 + // - audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; + // is-big-endian=false + // - Opus format + // - + // audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4 // - // * PCM format, audio data must be - // in little-endian byte order. - // - // * audio/l16; rate=16000; channels=1 - // - // * - // audio/x-l16; sample-rate=16000; channel-count=1 - // - // * audio/lpcm; sample-rate=8000; - // sample-size-bits=16; channel-count=1; is-big-endian=false - // - // * Opus format - // - // * - // audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4 - // - // * - // Text format - // - // * text/plain; charset=utf-8 + // - Text format + // - text/plain; charset=utf-8 // // This member is required. RequestContentType *string @@ -129,45 +106,33 @@ type RecognizeUtteranceInput struct { InputStream io.Reader // Request-specific information passed between the client application and Amazon - // Lex V2 The namespace x-amz-lex: is reserved for special attributes. Don't create - // any request attributes for prefix x-amz-lex:. The requestAttributes field must - // be compressed using gzip and then base64 encoded before sending to Amazon Lex - // V2. + // Lex V2 The namespace x-amz-lex: is reserved for special attributes. Don't + // create any request attributes for prefix x-amz-lex: . The requestAttributes + // field must be compressed using gzip and then base64 encoded before sending to + // Amazon Lex V2. RequestAttributes *string // The message that Amazon Lex V2 returns in the response can be either text or // speech based on the responseContentType value. - // - // * If the value is - // text/plain;charset=utf-8, Amazon Lex V2 returns text in the response. - // - // * If the - // value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon - // Lex V2 uses Amazon Polly to generate the speech using the configuration that you - // specified in the responseContentType parameter. For example, if you specify - // audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format. - // - // * If - // the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, - // little-endian format. - // - // * The following are the accepted values: - // - // * audio/mpeg - // - // * - // audio/ogg - // - // * audio/pcm (16 KHz) - // - // * audio/* (defaults to mpeg) - // - // * text/plain; - // charset=utf-8 + // - If the value is text/plain;charset=utf-8 , Amazon Lex V2 returns text in the + // response. + // - If the value begins with audio/ , Amazon Lex V2 returns speech in the + // response. Amazon Lex V2 uses Amazon Polly to generate the speech using the + // configuration that you specified in the responseContentType parameter. For + // example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech + // in the MPEG format. + // - If the value is audio/pcm , the speech returned is audio/pcm at 16 KHz in + // 16-bit, little-endian format. + // - The following are the accepted values: + // - audio/mpeg + // - audio/ogg + // - audio/pcm (16 KHz) + // - audio/* (defaults to mpeg) + // - text/plain; charset=utf-8 ResponseContentType *string - // Sets the state of the session with the user. You can use this to set the current - // intent, attributes, context, and dialog action. Use the dialog action to + // Sets the state of the session with the user. You can use this to set the + // current intent, attributes, context, and dialog action. Use the dialog action to // determine the next step that Amazon Lex V2 should use in the conversation with // the user. The sessionState field must be compressed using gzip and then base64 // encoded before sending to Amazon Lex V2. @@ -182,7 +147,7 @@ type RecognizeUtteranceOutput struct { // configuration and context. For example, if Amazon Lex V2 did not understand the // user intent, it sends the clarificationPrompt configured for the bot. If the // intent requires confirmation before taking the fulfillment action, it sends the - // confirmationPrompt. Another example: Suppose that the Lambda function + // confirmationPrompt . Another example: Suppose that the Lambda function // successfully fulfilled the intent, and sent a message to convey to the user. // Then Amazon Lex V2 sends that message in the response. AudioStream io.ReadCloser diff --git a/service/lexruntimev2/api_op_StartConversation.go b/service/lexruntimev2/api_op_StartConversation.go index 1952972bd22..883359147c1 100644 --- a/service/lexruntimev2/api_op_StartConversation.go +++ b/service/lexruntimev2/api_op_StartConversation.go @@ -20,45 +20,30 @@ import ( // users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes // the incoming events and responds with streaming text or audio events. Audio // input must be in the following format: audio/lpcm sample-rate=8000 -// sample-size-bits=16 channel-count=1; is-big-endian=false. If the optional +// sample-size-bits=16 channel-count=1; is-big-endian=false . If the optional // post-fulfillment response is specified, the messages are returned as follows. -// For more information, see PostFulfillmentStatusSpecification -// (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html). +// For more information, see PostFulfillmentStatusSpecification (https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html) +// . +// - Success message - Returned if the Lambda function completes successfully +// and the intent state is fulfilled or ready fulfillment if the message is +// present. +// - Failed message - The failed message is returned if the Lambda function +// throws an exception or if the Lambda function returns a failed intent state +// without a message. +// - Timeout message - If you don't configure a timeout message and a timeout, +// and the Lambda function doesn't return within 30 seconds, the timeout message is +// returned. If you configure a timeout, the timeout message is returned when the +// period times out. // -// * -// Success message - Returned if the Lambda function completes successfully and the -// intent state is fulfilled or ready fulfillment if the message is present. -// -// * -// Failed message - The failed message is returned if the Lambda function throws an -// exception or if the Lambda function returns a failed intent state without a -// message. -// -// * Timeout message - If you don't configure a timeout message and a -// timeout, and the Lambda function doesn't return within 30 seconds, the timeout -// message is returned. If you configure a timeout, the timeout message is returned -// when the period times out. -// -// For more information, see Completion message -// (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html). -// If the optional update message is configured, it is played at the specified +// For more information, see Completion message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html) +// . If the optional update message is configured, it is played at the specified // frequency while the Lambda function is running and the update message state is // active. If the fulfillment update message is not active, the Lambda function -// runs with a 30 second timeout. For more information, see Update message -// (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html) +// runs with a 30 second timeout. For more information, see Update message (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html) // The StartConversation operation is supported only in the following SDKs: -// -// * AWS -// SDK for C++ -// (https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversation) -// -// * -// AWS SDK for Java V2 -// (https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversation) -// -// * -// AWS SDK for Ruby V3 -// (https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation) +// - AWS SDK for C++ (https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex.v2-2020-08-07/StartConversation) +// - AWS SDK for Java V2 (https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex.v2-2020-08-07/StartConversation) +// - AWS SDK for Ruby V3 (https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation) func (c *Client) StartConversation(ctx context.Context, params *StartConversationInput, optFns ...func(*Options)) (*StartConversationOutput, error) { if params == nil { params = &StartConversationInput{} diff --git a/service/lexruntimev2/types/enums.go b/service/lexruntimev2/types/enums.go index b62dbecd1c3..aebabee8e85 100644 --- a/service/lexruntimev2/types/enums.go +++ b/service/lexruntimev2/types/enums.go @@ -75,9 +75,9 @@ const ( InputModeDtmf InputMode = "DTMF" ) -// Values returns all known values for InputMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for InputMode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (InputMode) Values() []InputMode { return []InputMode{ "Text", @@ -185,8 +185,8 @@ const ( ShapeComposite Shape = "Composite" ) -// Values returns all known values for Shape. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Shape. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Shape) Values() []Shape { return []Shape{ @@ -205,9 +205,9 @@ const ( StyleTypeSpellByWord StyleType = "SpellByWord" ) -// Values returns all known values for StyleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for StyleType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (StyleType) Values() []StyleType { return []StyleType{ "Default", diff --git a/service/lexruntimev2/types/types.go b/service/lexruntimev2/types/types.go index 1f7213a7c14..ed7f6f48830 100644 --- a/service/lexruntimev2/types/types.go +++ b/service/lexruntimev2/types/types.go @@ -10,7 +10,7 @@ import ( // can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you // can set a context using the , , or operations. Use a context to indicate to // Amazon Lex V2 intents that should be used as follow-up intents. For example, if -// the active context is order-fulfilled, only intents that have order-fulfilled +// the active context is order-fulfilled , only intents that have order-fulfilled // configured as a trigger are considered for follow up. type ActiveContext struct { @@ -63,8 +63,9 @@ type ActiveContextTimeToLive struct { type AudioInputEvent struct { // The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit - // mono-channel little-endian format. The value of the field should be: audio/lpcm; - // sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false + // mono-channel little-endian format. The value of the field should be: + // audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; + // is-big-endian=false // // This member is required. ContentType *string @@ -76,8 +77,8 @@ type AudioInputEvent struct { // Amazon Lex V2. ClientTimestampMillis int64 - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string noSmithyDocumentSerde @@ -91,12 +92,12 @@ type AudioResponseEvent struct { AudioChunk []byte // The encoding of the audio chunk. This is the same as the encoding configure in - // the contentType field of the ConfigurationEvent. + // the contentType field of the ConfigurationEvent . ContentType *string - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string noSmithyDocumentSerde @@ -137,33 +138,21 @@ type ConfigurationEvent struct { // The message that Amazon Lex V2 returns in the response can be either text or // speech based on the responseContentType value. - // - // * If the value is - // text/plain;charset=utf-8, Amazon Lex V2 returns text in the response. - // - // * If the - // value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon - // Lex V2 uses Amazon Polly to generate the speech using the configuration that you - // specified in the requestContentType parameter. For example, if you specify - // audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format. - // - // * If - // the value is audio/pcm, the speech returned is audio/pcm in 16-bit, - // little-endian format. - // - // * The following are the accepted values: - // - // * audio/mpeg - // - // * - // audio/ogg - // - // * audio/pcm - // - // * audio/* (defaults to mpeg) - // - // * text/plain; - // charset=utf-8 + // - If the value is text/plain;charset=utf-8 , Amazon Lex V2 returns text in the + // response. + // - If the value begins with audio/ , Amazon Lex V2 returns speech in the + // response. Amazon Lex V2 uses Amazon Polly to generate the speech using the + // configuration that you specified in the requestContentType parameter. For + // example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech + // in the MPEG format. + // - If the value is audio/pcm , the speech returned is audio/pcm in 16-bit, + // little-endian format. + // - The following are the accepted values: + // - audio/mpeg + // - audio/ogg + // - audio/pcm + // - audio/* (defaults to mpeg) + // - text/plain; charset=utf-8 // // This member is required. ResponseContentType *string @@ -179,23 +168,21 @@ type ConfigurationEvent struct { // Amazon Lex V2 doesn't wait for the prompt to finish playing on the client. DisablePlayback bool - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string // Request-specific information passed between the client application and Amazon // Lex V2. The namespace x-amz-lex: is reserved for special attributes. Don't - // create any request attributes for prefix x-amz-lex:. + // create any request attributes for prefix x-amz-lex: . RequestAttributes map[string]string // The state of the user's session with Amazon Lex V2. SessionState *SessionState - // A list of messages to send to the user. If you set the welcomeMessage field, you - // must also set the DialogAction - // (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html) - // structure's type - // (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type) + // A list of messages to send to the user. If you set the welcomeMessage field, + // you must also set the DialogAction (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html) + // structure's type (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type) // field. WelcomeMessages []Message @@ -207,37 +194,25 @@ type DialogAction struct { // The next action that the bot should take in its interaction with the user. The // possible values are: + // - Close - Indicates that there will not be a response from the user. For + // example, the statement "Your order has been placed" does not require a response. // - // * Close - Indicates that there will not be a response from - // the user. For example, the statement "Your order has been placed" does not - // require a response. - // - // * ConfirmIntent - The next action is asking the user if the - // intent is complete and ready to be fulfilled. This is a yes/no question such as - // "Place the order?" - // - // * Delegate - The next action is determined by Amazon Lex - // V2. - // - // * ElicitIntent - The next action is to elicit an intent from the user. - // - // * - // ElicitSlot - The next action is to elicit a slot value from the user. + // - ConfirmIntent - The next action is asking the user if the intent is complete + // and ready to be fulfilled. This is a yes/no question such as "Place the order?" + // - Delegate - The next action is determined by Amazon Lex V2. + // - ElicitIntent - The next action is to elicit an intent from the user. + // - ElicitSlot - The next action is to elicit a slot value from the user. // // This member is required. Type DialogActionType // Configures the slot to use spell-by-letter or spell-by-word style. When you use - // a style on a slot, users can spell out their input to make it clear to your - // bot. - // - // * Spell by letter - "b" "o" "b" - // - // * Spell by word - "b as in boy" "o as in - // oscar" "b as in boy" + // a style on a slot, users can spell out their input to make it clear to your bot. // - // For more information, see Using spelling to enter slot - // values (https://docs.aws.amazon.com/lexv2/latest/dg/using-spelling.html). + // - Spell by letter - "b" "o" "b" + // - Spell by word - "b as in boy" "o as in oscar" "b as in boy" + // For more information, see Using spelling to enter slot values (https://docs.aws.amazon.com/lexv2/latest/dg/using-spelling.html) + // . SlotElicitationStyle StyleType // The name of the slot that should be elicited from the user. @@ -259,16 +234,16 @@ type DisconnectionEvent struct { // Amazon Lex V2. ClientTimestampMillis int64 - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string noSmithyDocumentSerde } -// A DTMF character sent from the client application. DTMF characters are typically -// sent from a phone keypad to represent numbers. For example, you can have Amazon -// Lex V2 process a credit card number input from a phone. +// A DTMF character sent from the client application. DTMF characters are +// typically sent from a phone keypad to represent numbers. For example, you can +// have Amazon Lex V2 process a credit card number input from a phone. type DTMFInputEvent struct { // The DTMF character that the user pressed. The allowed characters are A - D, 0 - @@ -281,8 +256,8 @@ type DTMFInputEvent struct { // Amazon Lex V2. ClientTimestampMillis int64 - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string noSmithyDocumentSerde @@ -303,13 +278,13 @@ type ElicitSubSlot struct { noSmithyDocumentSerde } -// Event that Amazon Lex V2 sends to indicate that the stream is still open between -// the client application and Amazon Lex V2 +// Event that Amazon Lex V2 sends to indicate that the stream is still open +// between the client application and Amazon Lex V2 type HeartbeatEvent struct { - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string noSmithyDocumentSerde @@ -321,14 +296,15 @@ type HeartbeatEvent struct { // with a button on the card. type ImageResponseCard struct { - // The title to display on the response card. The format of the title is determined - // by the platform displaying the response card. + // The title to display on the response card. The format of the title is + // determined by the platform displaying the response card. // // This member is required. Title *string - // A list of buttons that should be displayed on the response card. The arrangement - // of the buttons is determined by the platform that displays the button. + // A list of buttons that should be displayed on the response card. The + // arrangement of the buttons is determined by the platform that displays the + // button. Buttons []Button // The URL of an image to display on the response card. The image URL must be @@ -354,8 +330,8 @@ type Intent struct { // Contains information about whether fulfillment of the intent has been confirmed. ConfirmationState ConfirmationState - // A map of all of the slots for the intent. The name of the slot maps to the value - // of the slot. If a slot has not been filled, the value is null. + // A map of all of the slots for the intent. The name of the slot maps to the + // value of the slot. If a slot has not been filled, the value is null. Slots map[string]Slot // Contains fulfillment information for the intent. @@ -368,9 +344,9 @@ type Intent struct { // and Amazon Lex V2. type IntentResultEvent struct { - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string // Indicates whether the input to the operation was text or speech. @@ -407,7 +383,7 @@ type Interpretation struct { Intent *Intent // Determines the threshold where Amazon Lex V2 will insert the - // AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning + // AMAZON.FallbackIntent , AMAZON.KendraSearchIntent , or both when returning // alternative intents in a response. AMAZON.FallbackIntent and // AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. NluConfidence *ConfidenceScore @@ -449,8 +425,8 @@ type PlaybackCompletionEvent struct { // Amazon Lex V2. ClientTimestampMillis int64 - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string noSmithyDocumentSerde @@ -468,9 +444,9 @@ type PlaybackInterruptionEvent struct { // the interruption. CausedByEventId *string - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string // Indicates the type of user input that Amazon Lex V2 detected. @@ -516,16 +492,15 @@ type RuntimeHintDetails struct { // runtime hints are preferred in the resolution. You can provide hints for a // maximum of 100 intents. You can provide a maximum of 100 slots. Before you can // use runtime hints with an existing bot, you must first rebuild the bot. For more -// information, see Using runtime hints to improve recognition of slot values -// (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html). +// information, see Using runtime hints to improve recognition of slot values (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html) +// . type RuntimeHints struct { // A list of the slots in the intent that should have runtime hints added, and the - // phrases that should be added for each slot. The first level of the slotHints map - // is the name of the intent. The second level is the name of the slot within the - // intent. For more information, see Using hints to improve accuracy - // (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html). The intent name - // and slot name must exist. + // phrases that should be added for each slot. The first level of the slotHints + // map is the name of the intent. The second level is the name of the slot within + // the intent. For more information, see Using hints to improve accuracy (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html) + // . The intent name and slot name must exist. SlotHints map[string]map[string]RuntimeHintDetails noSmithyDocumentSerde @@ -546,9 +521,8 @@ type RuntimeHintValue struct { // Provides information about the sentiment expressed in a user's response in a // conversation. Sentiments are determined using Amazon Comprehend. Sentiments are // only returned if they are enabled for the bot. For more information, see -// Determine Sentiment -// (https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) in the -// Amazon Comprehend developer guide. +// Determine Sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) +// in the Amazon Comprehend developer guide. type SentimentResponse struct { // The overall sentiment expressed in the user's response. This is the sentiment @@ -615,9 +589,9 @@ type SessionState struct { // A value that Amazon Lex V2 uses to fulfill an intent. type Slot struct { - // When the shape value is List, it indicates that the values field contains a list - // of slot values. When the value is Scalar, it indicates that the value field - // contains a single value. + // When the shape value is List , it indicates that the values field contains a + // list of slot values. When the value is Scalar , it indicates that the value + // field contains a single value. Shape Shape // The constituent sub slots of a composite slot. @@ -684,15 +658,10 @@ func (*StartConversationRequestEventStreamMemberDisconnectionEvent) isStartConve // DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 // accumulates the DMTF information from when the user sends the first character // and ends -// -// * when there's a pause longer that the value configured for the end -// timeout. -// -// * when there's a digit that is the configured end character. -// -// * when -// Amazon Lex V2 accumulates characters equal to the maximum DTMF character -// configuration. +// - when there's a pause longer that the value configured for the end timeout. +// - when there's a digit that is the configured end character. +// - when Amazon Lex V2 accumulates characters equal to the maximum DTMF +// character configuration. type StartConversationRequestEventStreamMemberDTMFInputEvent struct { Value DTMFInputEvent @@ -750,8 +719,8 @@ type StartConversationResponseEventStreamMemberAudioResponseEvent struct { func (*StartConversationResponseEventStreamMemberAudioResponseEvent) isStartConversationResponseEventStream() { } -// Event that Amazon Lex V2 sends to indicate that the stream is still open between -// the client application and Amazon Lex V2 +// Event that Amazon Lex V2 sends to indicate that the stream is still open +// between the client application and Amazon Lex V2 type StartConversationResponseEventStreamMemberHeartbeatEvent struct { Value HeartbeatEvent @@ -822,8 +791,8 @@ type TextInputEvent struct { // Amazon Lex V2. ClientTimestampMillis int64 - // A unique identifier that your application assigns to the event. You can use this - // to identify events in logs. + // A unique identifier that your application assigns to the event. You can use + // this to identify events in logs. EventId *string noSmithyDocumentSerde @@ -833,9 +802,9 @@ type TextInputEvent struct { // the user. type TextResponseEvent struct { - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string // A list of messages to send to the user. Messages are ordered based on the order @@ -850,9 +819,9 @@ type TextResponseEvent struct { // transcript of voice audio. type TranscriptEvent struct { - // A unique identifier of the event sent by Amazon Lex V2. The identifier is in the - // form RESPONSE-N, where N is a number starting with one and incremented for each - // event sent by Amazon Lex V2 in the current session. + // A unique identifier of the event sent by Amazon Lex V2. The identifier is in + // the form RESPONSE-N , where N is a number starting with one and incremented for + // each event sent by Amazon Lex V2 in the current session. EventId *string // The transcript of the voice audio from the user. diff --git a/service/licensemanager/api_client.go b/service/licensemanager/api_client.go index fea8019e4ca..774e6edc87d 100644 --- a/service/licensemanager/api_client.go +++ b/service/licensemanager/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/licensemanager/api_op_CheckoutBorrowLicense.go b/service/licensemanager/api_op_CheckoutBorrowLicense.go index 11aab526cb5..7b4b76af7eb 100644 --- a/service/licensemanager/api_op_CheckoutBorrowLicense.go +++ b/service/licensemanager/api_op_CheckoutBorrowLicense.go @@ -37,7 +37,7 @@ type CheckoutBorrowLicenseInput struct { // Digital signature method. The possible value is JSON Web Signature (JWS) // algorithm PS384. For more information, see RFC 7518 Digital Signature with - // RSASSA-PSS (https://tools.ietf.org/html/rfc7518#section-3.5). + // RSASSA-PSS (https://tools.ietf.org/html/rfc7518#section-3.5) . // // This member is required. DigitalSignatureMethod types.DigitalSignatureMethod diff --git a/service/licensemanager/api_op_CheckoutLicense.go b/service/licensemanager/api_op_CheckoutLicense.go index 1d24a6e5c11..ec3a1575bb1 100644 --- a/service/licensemanager/api_op_CheckoutLicense.go +++ b/service/licensemanager/api_op_CheckoutLicense.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Checks out the specified license. If the account that created the license is the -// same that is performing the check out, you must specify the account as the +// Checks out the specified license. If the account that created the license is +// the same that is performing the check out, you must specify the account as the // beneficiary. func (c *Client) CheckoutLicense(ctx context.Context, params *CheckoutLicenseInput, optFns ...func(*Options)) (*CheckoutLicenseOutput, error) { if params == nil { diff --git a/service/licensemanager/api_op_CreateGrant.go b/service/licensemanager/api_op_CreateGrant.go index 23a22a857fa..7b52e41a94d 100644 --- a/service/licensemanager/api_op_CreateGrant.go +++ b/service/licensemanager/api_op_CreateGrant.go @@ -14,8 +14,7 @@ import ( // Creates a grant for the specified license. A grant shares the use of license // entitlements with a specific Amazon Web Services account, an organization, or an // organizational unit (OU). For more information, see Granted licenses in License -// Manager -// (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) +// Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) // in the License Manager User Guide. func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optFns ...func(*Options)) (*CreateGrantOutput, error) { if params == nil { @@ -60,17 +59,13 @@ type CreateGrantInput struct { // This member is required. LicenseArn *string - // The grant principals. You can specify one of the following as an Amazon Resource - // Name (ARN): + // The grant principals. You can specify one of the following as an Amazon + // Resource Name (ARN): + // - An Amazon Web Services account, which includes only the account specified. // - // * An Amazon Web Services account, which includes only the account - // specified. + // - An organizational unit (OU), which includes all accounts in the OU. // - // * An organizational unit (OU), which includes all accounts in the - // OU. - // - // * An organization, which will include all accounts across your - // organization. + // - An organization, which will include all accounts across your organization. // // This member is required. Principals []string diff --git a/service/licensemanager/api_op_CreateGrantVersion.go b/service/licensemanager/api_op_CreateGrantVersion.go index 3a626ed9f85..9bd55a9f4a5 100644 --- a/service/licensemanager/api_op_CreateGrantVersion.go +++ b/service/licensemanager/api_op_CreateGrantVersion.go @@ -12,8 +12,7 @@ import ( ) // Creates a new version of the specified grant. For more information, see Granted -// licenses in License Manager -// (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) +// licenses in License Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) // in the License Manager User Guide. func (c *Client) CreateGrantVersion(ctx context.Context, params *CreateGrantVersionInput, optFns ...func(*Options)) (*CreateGrantVersionOutput, error) { if params == nil { diff --git a/service/licensemanager/api_op_CreateLicense.go b/service/licensemanager/api_op_CreateLicense.go index c22362b0940..c03d19eda83 100644 --- a/service/licensemanager/api_op_CreateLicense.go +++ b/service/licensemanager/api_op_CreateLicense.go @@ -40,9 +40,9 @@ type CreateLicenseInput struct { // This member is required. ClientToken *string - // Configuration for consumption of the license. Choose a provisional configuration - // for workloads running with continuous connectivity. Choose a borrow - // configuration for workloads with offline usage. + // Configuration for consumption of the license. Choose a provisional + // configuration for workloads running with continuous connectivity. Choose a + // borrow configuration for workloads with offline usage. // // This member is required. ConsumptionConfiguration *types.ConsumptionConfiguration diff --git a/service/licensemanager/api_op_CreateLicenseConfiguration.go b/service/licensemanager/api_op_CreateLicenseConfiguration.go index ca8ffdf6253..09f83f87fb3 100644 --- a/service/licensemanager/api_op_CreateLicenseConfiguration.go +++ b/service/licensemanager/api_op_CreateLicenseConfiguration.go @@ -60,24 +60,18 @@ type CreateLicenseConfigurationInput struct { // License rules. The syntax is #name=value (for example, // #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as // follows. - // - // * Cores dimension: allowedTenancy | licenseAffinityToHost | - // maximumCores | minimumCores - // - // * Instances dimension: allowedTenancy | - // maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | - // minimumVcpus - // - // * Sockets dimension: allowedTenancy | licenseAffinityToHost | - // maximumSockets | minimumSockets - // - // * vCPUs dimension: allowedTenancy | - // honorVcpuOptimization | maximumVcpus | minimumVcpus - // - // The unit for - // licenseAffinityToHost is days and the range is 1 to 180. The possible values for - // allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. - // The possible values for honorVcpuOptimization are True and False. + // - Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | + // minimumCores + // - Instances dimension: allowedTenancy | maximumCores | minimumCores | + // maximumSockets | minimumSockets | maximumVcpus | minimumVcpus + // - Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | + // minimumSockets + // - vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | + // minimumVcpus + // The unit for licenseAffinityToHost is days and the range is 1 to 180. The + // possible values for allowedTenancy are EC2-Default , EC2-DedicatedHost , and + // EC2-DedicatedInstance . The possible values for honorVcpuOptimization are True + // and False . LicenseRules []string // Product information. diff --git a/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go b/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go index f507f09c017..34caa7c3ccf 100644 --- a/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go +++ b/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go @@ -30,8 +30,7 @@ func (c *Client) CreateLicenseConversionTaskForResource(ctx context.Context, par type CreateLicenseConversionTaskForResourceInput struct { // Information that identifies the license type you are converting to. For the - // structure of the destination license, see Convert a license type using the CLI - // (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli) + // structure of the destination license, see Convert a license type using the CLI (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli) // in the License Manager User Guide. // // This member is required. @@ -44,8 +43,7 @@ type CreateLicenseConversionTaskForResourceInput struct { ResourceArn *string // Information that identifies the license type you are converting from. For the - // structure of the source license, see Convert a license type using the CLI - // (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli) + // structure of the source license, see Convert a license type using the CLI (https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli) // in the License Manager User Guide. // // This member is required. diff --git a/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go b/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go index dd94dc49ae6..ea8f021d7bb 100644 --- a/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go +++ b/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go @@ -52,13 +52,10 @@ type CreateLicenseManagerReportGeneratorInput struct { ReportGeneratorName *string // Type of reports to generate. The following report types an be generated: - // - // * - // License configuration report - Reports the number and details of consumed - // licenses for a license configuration. - // - // * Resource report - Reports the tracked - // licenses and resource consumption for a license configuration. + // - License configuration report - Reports the number and details of consumed + // licenses for a license configuration. + // - Resource report - Reports the tracked licenses and resource consumption for + // a license configuration. // // This member is required. Type []types.ReportType diff --git a/service/licensemanager/api_op_CreateLicenseVersion.go b/service/licensemanager/api_op_CreateLicenseVersion.go index 7a894afc523..4ec17de16b5 100644 --- a/service/licensemanager/api_op_CreateLicenseVersion.go +++ b/service/licensemanager/api_op_CreateLicenseVersion.go @@ -35,9 +35,9 @@ type CreateLicenseVersionInput struct { // This member is required. ClientToken *string - // Configuration for consumption of the license. Choose a provisional configuration - // for workloads running with continuous connectivity. Choose a borrow - // configuration for workloads with offline usage. + // Configuration for consumption of the license. Choose a provisional + // configuration for workloads running with continuous connectivity. Choose a + // borrow configuration for workloads with offline usage. // // This member is required. ConsumptionConfiguration *types.ConsumptionConfiguration diff --git a/service/licensemanager/api_op_CreateToken.go b/service/licensemanager/api_op_CreateToken.go index da9a05cae84..8ab008c59fd 100644 --- a/service/licensemanager/api_op_CreateToken.go +++ b/service/licensemanager/api_op_CreateToken.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a long-lived token. A refresh token is a JWT token used to get an access -// token. With an access token, you can call AssumeRoleWithWebIdentity to get role -// credentials that you can use to call License Manager to manage the specified -// license. +// Creates a long-lived token. A refresh token is a JWT token used to get an +// access token. With an access token, you can call AssumeRoleWithWebIdentity to +// get role credentials that you can use to call License Manager to manage the +// specified license. func (c *Client) CreateToken(ctx context.Context, params *CreateTokenInput, optFns ...func(*Options)) (*CreateTokenOutput, error) { if params == nil { params = &CreateTokenInput{} @@ -37,8 +37,8 @@ type CreateTokenInput struct { // This member is required. ClientToken *string - // Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of - // the JWT token. + // Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim + // of the JWT token. // // This member is required. LicenseArn *string @@ -50,8 +50,8 @@ type CreateTokenInput struct { // Manager does not check whether the roles are in use. RoleArns []string - // Data specified by the caller to be included in the JWT token. The data is mapped - // to the amr claim of the JWT token. + // Data specified by the caller to be included in the JWT token. The data is + // mapped to the amr claim of the JWT token. TokenProperties []string noSmithyDocumentSerde diff --git a/service/licensemanager/api_op_GetServiceSettings.go b/service/licensemanager/api_op_GetServiceSettings.go index 6c14d8148b9..ae8c0fc43c6 100644 --- a/service/licensemanager/api_op_GetServiceSettings.go +++ b/service/licensemanager/api_op_GetServiceSettings.go @@ -36,16 +36,16 @@ type GetServiceSettingsOutput struct { // Indicates whether cross-account discovery is enabled. EnableCrossAccountsDiscovery *bool - // Amazon Resource Name (ARN) of the resource share. The License Manager management - // account provides member accounts with access to this share. + // Amazon Resource Name (ARN) of the resource share. The License Manager + // management account provides member accounts with access to this share. LicenseManagerResourceShareArn *string // Indicates whether Organizations is integrated with License Manager for // cross-account discovery. OrganizationConfiguration *types.OrganizationConfiguration - // Regional S3 bucket path for storing reports, license trail event data, discovery - // data, and so on. + // Regional S3 bucket path for storing reports, license trail event data, + // discovery data, and so on. S3BucketArn *string // SNS topic configured to receive notifications from License Manager. diff --git a/service/licensemanager/api_op_ListDistributedGrants.go b/service/licensemanager/api_op_ListDistributedGrants.go index 759f76f8441..1afd2107b78 100644 --- a/service/licensemanager/api_op_ListDistributedGrants.go +++ b/service/licensemanager/api_op_ListDistributedGrants.go @@ -30,18 +30,11 @@ func (c *Client) ListDistributedGrants(ctx context.Context, params *ListDistribu type ListDistributedGrantsInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // LicenseArn - // - // * GrantStatus - // - // * GranteePrincipalARN - // - // * ProductSKU - // - // * - // LicenseIssuerName + // - LicenseArn + // - GrantStatus + // - GranteePrincipalARN + // - ProductSKU + // - LicenseIssuerName Filters []types.Filter // Amazon Resource Names (ARNs) of the grants. diff --git a/service/licensemanager/api_op_ListLicenseConfigurations.go b/service/licensemanager/api_op_ListLicenseConfigurations.go index 7582ef14d16..c424ec5fb35 100644 --- a/service/licensemanager/api_op_ListLicenseConfigurations.go +++ b/service/licensemanager/api_op_ListLicenseConfigurations.go @@ -31,18 +31,13 @@ type ListLicenseConfigurationsInput struct { // Filters to scope the results. The following filters and logical operators are // supported: - // - // * licenseCountingType - The dimension for which licenses are - // counted. Possible values are vCPU | Instance | Core | Socket. Logical operators - // are EQUALS | NOT_EQUALS. - // - // * enforceLicenseCount - A Boolean value that indicates - // whether hard license enforcement is used. Logical operators are EQUALS | - // NOT_EQUALS. - // - // * usagelimitExceeded - A Boolean value that indicates whether the - // available licenses have been exceeded. Logical operators are EQUALS | - // NOT_EQUALS. + // - licenseCountingType - The dimension for which licenses are counted. Possible + // values are vCPU | Instance | Core | Socket . Logical operators are EQUALS | + // NOT_EQUALS . + // - enforceLicenseCount - A Boolean value that indicates whether hard license + // enforcement is used. Logical operators are EQUALS | NOT_EQUALS . + // - usagelimitExceeded - A Boolean value that indicates whether the available + // licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS . Filters []types.Filter // Amazon Resource Names (ARN) of the license configurations. diff --git a/service/licensemanager/api_op_ListLicenseConversionTasks.go b/service/licensemanager/api_op_ListLicenseConversionTasks.go index 53b265233f3..c378e524add 100644 --- a/service/licensemanager/api_op_ListLicenseConversionTasks.go +++ b/service/licensemanager/api_op_ListLicenseConversionTasks.go @@ -29,7 +29,7 @@ func (c *Client) ListLicenseConversionTasks(ctx context.Context, params *ListLic type ListLicenseConversionTasksInput struct { - // Filters to scope the results. Valid filters are ResourceArns and Status. + // Filters to scope the results. Valid filters are ResourceArns and Status . Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go b/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go index 51d3903483f..d0f261ae7bb 100644 --- a/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go +++ b/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go @@ -30,9 +30,7 @@ func (c *Client) ListLicenseManagerReportGenerators(ctx context.Context, params type ListLicenseManagerReportGeneratorsInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // LicenseConfigurationArn + // - LicenseConfigurationArn Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListLicenses.go b/service/licensemanager/api_op_ListLicenses.go index f6568452c0e..a3528c81047 100644 --- a/service/licensemanager/api_op_ListLicenses.go +++ b/service/licensemanager/api_op_ListLicenses.go @@ -30,15 +30,10 @@ func (c *Client) ListLicenses(ctx context.Context, params *ListLicensesInput, op type ListLicensesInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // Beneficiary - // - // * ProductSKU - // - // * Fingerprint - // - // * Status + // - Beneficiary + // - ProductSKU + // - Fingerprint + // - Status Filters []types.Filter // Amazon Resource Names (ARNs) of the licenses. diff --git a/service/licensemanager/api_op_ListReceivedGrants.go b/service/licensemanager/api_op_ListReceivedGrants.go index 46664914d63..335f707cd6a 100644 --- a/service/licensemanager/api_op_ListReceivedGrants.go +++ b/service/licensemanager/api_op_ListReceivedGrants.go @@ -32,17 +32,11 @@ func (c *Client) ListReceivedGrants(ctx context.Context, params *ListReceivedGra type ListReceivedGrantsInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // ProductSKU - // - // * LicenseIssuerName - // - // * LicenseArn - // - // * GrantStatus - // - // * GranterAccountId + // - ProductSKU + // - LicenseIssuerName + // - LicenseArn + // - GrantStatus + // - GranterAccountId Filters []types.Filter // Amazon Resource Names (ARNs) of the grants. diff --git a/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go b/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go index b8209107b84..006d5b2b984 100644 --- a/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go +++ b/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go @@ -35,11 +35,8 @@ type ListReceivedGrantsForOrganizationInput struct { LicenseArn *string // Filters to scope the results. The following filters are supported: - // - // * - // ParentArn - // - // * GranteePrincipalArn + // - ParentArn + // - GranteePrincipalArn Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListReceivedLicenses.go b/service/licensemanager/api_op_ListReceivedLicenses.go index c427749cdcb..1e70bb2b611 100644 --- a/service/licensemanager/api_op_ListReceivedLicenses.go +++ b/service/licensemanager/api_op_ListReceivedLicenses.go @@ -30,17 +30,11 @@ func (c *Client) ListReceivedLicenses(ctx context.Context, params *ListReceivedL type ListReceivedLicensesInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // ProductSKU - // - // * Status - // - // * Fingerprint - // - // * IssuerName - // - // * Beneficiary + // - ProductSKU + // - Status + // - Fingerprint + // - IssuerName + // - Beneficiary Filters []types.Filter // Amazon Resource Names (ARNs) of the licenses. diff --git a/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go b/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go index d55a759d4a7..1d5ee0bb518 100644 --- a/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go +++ b/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go @@ -30,11 +30,8 @@ func (c *Client) ListReceivedLicensesForOrganization(ctx context.Context, params type ListReceivedLicensesForOrganizationInput struct { // Filters to scope the results. The following filters are supported: - // - // * - // Beneficiary - // - // * ProductSKU + // - Beneficiary + // - ProductSKU Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListResourceInventory.go b/service/licensemanager/api_op_ListResourceInventory.go index 58d510e1cde..6622e59c852 100644 --- a/service/licensemanager/api_op_ListResourceInventory.go +++ b/service/licensemanager/api_op_ListResourceInventory.go @@ -31,27 +31,19 @@ type ListResourceInventoryInput struct { // Filters to scope the results. The following filters and logical operators are // supported: - // - // * account_id - The ID of the Amazon Web Services account that owns - // the resource. Logical operators are EQUALS | NOT_EQUALS. - // - // * application_name - - // The name of the application. Logical operators are EQUALS | BEGINS_WITH. - // - // * - // license_included - The type of license included. Logical operators are EQUALS | - // NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | - // sql-server-web | windows-server-datacenter. - // - // * platform - The platform of the - // resource. Logical operators are EQUALS | BEGINS_WITH. - // - // * resource_id - The ID of - // the resource. Logical operators are EQUALS | NOT_EQUALS. - // - // * tag: - The key/value - // combination of a tag assigned to the resource. Logical operators are EQUALS - // (single account) or EQUALS | NOT_EQUALS (cross account). + // - account_id - The ID of the Amazon Web Services account that owns the + // resource. Logical operators are EQUALS | NOT_EQUALS . + // - application_name - The name of the application. Logical operators are EQUALS + // | BEGINS_WITH . + // - license_included - The type of license included. Logical operators are + // EQUALS | NOT_EQUALS . Possible values are sql-server-enterprise | + // sql-server-standard | sql-server-web | windows-server-datacenter . + // - platform - The platform of the resource. Logical operators are EQUALS | + // BEGINS_WITH . + // - resource_id - The ID of the resource. Logical operators are EQUALS | + // NOT_EQUALS . + // - tag: - The key/value combination of a tag assigned to the resource. Logical + // operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account). Filters []types.InventoryFilter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListTokens.go b/service/licensemanager/api_op_ListTokens.go index 0a0e6ba8e5d..864bc874aa7 100644 --- a/service/licensemanager/api_op_ListTokens.go +++ b/service/licensemanager/api_op_ListTokens.go @@ -30,8 +30,7 @@ func (c *Client) ListTokens(ctx context.Context, params *ListTokensInput, optFns type ListTokensInput struct { // Filters to scope the results. The following filter is supported: - // - // * LicenseArns + // - LicenseArns Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go index 7890fb6e46d..5eae05cd1f5 100644 --- a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go +++ b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go @@ -39,16 +39,13 @@ type ListUsageForLicenseConfigurationInput struct { // Filters to scope the results. The following filters and logical operators are // supported: - // - // * resourceArn - The ARN of the license configuration resource. - // Logical operators are EQUALS | NOT_EQUALS. - // - // * resourceType - The resource type - // (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical - // operators are EQUALS | NOT_EQUALS. - // - // * resourceAccount - The ID of the account - // that owns the resource. Logical operators are EQUALS | NOT_EQUALS. + // - resourceArn - The ARN of the license configuration resource. Logical + // operators are EQUALS | NOT_EQUALS . + // - resourceType - The resource type ( EC2_INSTANCE | EC2_HOST | EC2_AMI | + // SYSTEMS_MANAGER_MANAGED_INSTANCE ). Logical operators are EQUALS | NOT_EQUALS + // . + // - resourceAccount - The ID of the account that owns the resource. Logical + // operators are EQUALS | NOT_EQUALS . Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go b/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go index be74b662c66..28191b8fd09 100644 --- a/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go +++ b/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go @@ -57,13 +57,10 @@ type UpdateLicenseManagerReportGeneratorInput struct { ReportGeneratorName *string // Type of reports to generate. The following report types are supported: - // - // * - // License configuration report - Reports the number and details of consumed - // licenses for a license configuration. - // - // * Resource report - Reports the tracked - // licenses and resource consumption for a license configuration. + // - License configuration report - Reports the number and details of consumed + // licenses for a license configuration. + // - Resource report - Reports the tracked licenses and resource consumption for + // a license configuration. // // This member is required. Type []types.ReportType diff --git a/service/licensemanager/types/enums.go b/service/licensemanager/types/enums.go index f43a2935aeb..97039f0e05a 100644 --- a/service/licensemanager/types/enums.go +++ b/service/licensemanager/types/enums.go @@ -56,9 +56,9 @@ const ( CheckoutTypePerpetual CheckoutType = "PERPETUAL" ) -// Values returns all known values for CheckoutType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CheckoutType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CheckoutType) Values() []CheckoutType { return []CheckoutType{ "PROVISIONAL", @@ -260,9 +260,9 @@ const ( InventoryFilterConditionContains InventoryFilterCondition = "CONTAINS" ) -// Values returns all known values for InventoryFilterCondition. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InventoryFilterCondition. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryFilterCondition) Values() []InventoryFilterCondition { return []InventoryFilterCondition{ "EQUALS", @@ -340,8 +340,8 @@ const ( LicenseDeletionStatusDeleted LicenseDeletionStatus = "DELETED" ) -// Values returns all known values for LicenseDeletionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LicenseDeletionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LicenseDeletionStatus) Values() []LicenseDeletionStatus { return []LicenseDeletionStatus{ @@ -417,9 +417,9 @@ const ( RenewTypeMonthly RenewType = "Monthly" ) -// Values returns all known values for RenewType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RenewType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RenewType) Values() []RenewType { return []RenewType{ "None", @@ -477,9 +477,9 @@ const ( ResourceTypeSystemsManagerManagedInstance ResourceType = "SYSTEMS_MANAGER_MANAGED_INSTANCE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "EC2_INSTANCE", @@ -497,9 +497,9 @@ const ( TokenTypeRefreshToken TokenType = "REFRESH_TOKEN" ) -// Values returns all known values for TokenType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TokenType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TokenType) Values() []TokenType { return []TokenType{ "REFRESH_TOKEN", diff --git a/service/licensemanager/types/types.go b/service/licensemanager/types/types.go index c27db7c889e..2d5a14f120b 100644 --- a/service/licensemanager/types/types.go +++ b/service/licensemanager/types/types.go @@ -144,16 +144,16 @@ type EntitlementUsage struct { noSmithyDocumentSerde } -// A filter name and value pair that is used to return more specific results from a -// describe operation. Filters can be used to match a set of resources by specific -// criteria, such as tags, attributes, or IDs. +// A filter name and value pair that is used to return more specific results from +// a describe operation. Filters can be used to match a set of resources by +// specific criteria, such as tags, attributes, or IDs. type Filter struct { // Name of the filter. Filter names are case-sensitive. Name *string - // The value of the filter, which is case-sensitive. You can only specify one value - // for the filter. + // The value of the filter, which is case-sensitive. You can only specify one + // value for the filter. Values []string noSmithyDocumentSerde @@ -428,7 +428,7 @@ type LicenseConfiguration struct { // Describes an association with a license configuration. type LicenseConfigurationAssociation struct { - // Scope of AMI associations. The possible value is cross-account. + // Scope of AMI associations. The possible value is cross-account . AmiAssociationScope *string // Time when the license configuration was associated with the resource. @@ -476,8 +476,7 @@ type LicenseConversionContext struct { // The Usage operation value that corresponds to the license type you are // converting your resource from. For more information about which platforms // correspond to which usage operation values see Sample data: usage operation by - // platform - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html#billing-info) + // platform (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html#billing-info) UsageOperation *string noSmithyDocumentSerde @@ -555,7 +554,7 @@ type LicenseSpecification struct { // This member is required. LicenseConfigurationArn *string - // Scope of AMI associations. The possible value is cross-account. + // Scope of AMI associations. The possible value is cross-account . AmiAssociationScope *string noSmithyDocumentSerde @@ -596,30 +595,23 @@ type Metadata struct { // The options you can specify when you create a new version of a grant, such as // activation override behavior. For more information, see Granted licenses in -// License Manager -// (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) +// License Manager (https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) // in the License Manager User Guide. type Options struct { - // An activation option for your grant that determines the behavior of activating a - // grant. Activation options can only be used with granted licenses sourced from + // An activation option for your grant that determines the behavior of activating + // a grant. Activation options can only be used with granted licenses sourced from // the Amazon Web Services Marketplace. Additionally, the operation must specify // the value of ACTIVE for the Status parameter. - // - // * As a license administrator, you - // can optionally specify an ActivationOverrideBehavior when activating a grant. - // - // * - // As a grantor, you can optionally specify an ActivationOverrideBehavior when you - // activate a grant for a grantee account in your organization. - // - // * As a grantee, if - // the grantor creating the distributed grant doesn’t specify an - // ActivationOverrideBehavior, you can optionally specify one when you are - // activating the grant. - // - // DISTRIBUTED_GRANTS_ONLY Use this value to activate a - // grant without replacing any member account’s active grants for the same product. + // - As a license administrator, you can optionally specify an + // ActivationOverrideBehavior when activating a grant. + // - As a grantor, you can optionally specify an ActivationOverrideBehavior when + // you activate a grant for a grantee account in your organization. + // - As a grantee, if the grantor creating the distributed grant doesn’t specify + // an ActivationOverrideBehavior , you can optionally specify one when you are + // activating the grant. + // DISTRIBUTED_GRANTS_ONLY Use this value to activate a grant without replacing + // any member account’s active grants for the same product. // ALL_GRANTS_PERMITTED_BY_ISSUER Use this value to activate a grant and disable // other active grants in any member accounts for the same product. This action // will also replace their previously activated grants with this activated grant. @@ -647,54 +639,38 @@ type ProductInformation struct { // type of filter being declared, and a ProductInformationFilterValue that // specifies the value to filter on. Accepted values for // ProductInformationFilterName are listed here along with descriptions and valid - // options for ProductInformationFilterComparator. The following filters and are - // supported when the resource type is SSM_MANAGED: - // - // * Application Name - The name - // of the application. Logical operator is EQUALS. - // - // * Application Publisher - The - // publisher of the application. Logical operator is EQUALS. - // - // * Application Version - // - The version of the application. Logical operator is EQUALS. - // - // * Platform Name - - // The name of the platform. Logical operator is EQUALS. - // - // * Platform Type - The - // platform type. Logical operator is EQUALS. - // - // * Tag:key - The key of a tag - // attached to an Amazon Web Services resource you wish to exclude from automated - // discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended - // to Tag: following the example: Tag:name-of-your-key. - // ProductInformationFilterValue is optional if you are not using values for the - // key. - // - // * AccountId - The 12-digit ID of an Amazon Web Services account you wish - // to exclude from automated discovery. Logical operator is NOT_EQUALS. - // - // * License - // Included - The type of license included. Logical operators are EQUALS and - // NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | - // sql-server-web | windows-server-datacenter. - // - // The following filters and logical - // operators are supported when the resource type is RDS: - // - // * Engine Edition - The - // edition of the database engine. Logical operator is EQUALS. Possible values are: - // oracle-ee | oracle-se | oracle-se1 | oracle-se2. - // - // * License Pack - The license - // pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic - // pack sqlt | tuning pack sqlt | ols | olap. + // options for ProductInformationFilterComparator . The following filters and are + // supported when the resource type is SSM_MANAGED : + // - Application Name - The name of the application. Logical operator is EQUALS . + // - Application Publisher - The publisher of the application. Logical operator + // is EQUALS . + // - Application Version - The version of the application. Logical operator is + // EQUALS . + // - Platform Name - The name of the platform. Logical operator is EQUALS . + // - Platform Type - The platform type. Logical operator is EQUALS . + // - Tag:key - The key of a tag attached to an Amazon Web Services resource you + // wish to exclude from automated discovery. Logical operator is NOT_EQUALS . The + // key for your tag must be appended to Tag: following the example: + // Tag:name-of-your-key . ProductInformationFilterValue is optional if you are + // not using values for the key. + // - AccountId - The 12-digit ID of an Amazon Web Services account you wish to + // exclude from automated discovery. Logical operator is NOT_EQUALS . + // - License Included - The type of license included. Logical operators are + // EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | + // sql-server-standard | sql-server-web | windows-server-datacenter . + // The following filters and logical operators are supported when the resource + // type is RDS : + // - Engine Edition - The edition of the database engine. Logical operator is + // EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 + // . + // - License Pack - The license pack. Logical operator is EQUALS . Possible + // values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap + // . // // This member is required. ProductInformationFilterList []ProductInformationFilter - // Resource type. The possible values are SSM_MANAGED | RDS. + // Resource type. The possible values are SSM_MANAGED | RDS . // // This member is required. ResourceType *string @@ -765,8 +741,8 @@ type ReportFrequency struct { // Time period between each report. The period can be daily, weekly, or monthly. Period ReportFrequencyType - // Number of times within the frequency period that a report is generated. The only - // supported value is 1. + // Number of times within the frequency period that a report is generated. The + // only supported value is 1 . Value *int32 noSmithyDocumentSerde @@ -877,7 +853,7 @@ type TokenData struct { // Amazon Resource Names (ARN) of the roles included in the token. RoleArns []string - // Token status. The possible values are AVAILABLE and DELETED. + // Token status. The possible values are AVAILABLE and DELETED . Status *string // Token ID. @@ -886,7 +862,7 @@ type TokenData struct { // Data specified by the caller. TokenProperties []string - // Type of token generated. The supported value is REFRESH_TOKEN. + // Type of token generated. The supported value is REFRESH_TOKEN . TokenType *string noSmithyDocumentSerde diff --git a/service/licensemanagerlinuxsubscriptions/api_client.go b/service/licensemanagerlinuxsubscriptions/api_client.go index 85f7e91a9c4..a83d486e4f4 100644 --- a/service/licensemanagerlinuxsubscriptions/api_client.go +++ b/service/licensemanagerlinuxsubscriptions/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go index b17458e3ef3..f6c726b6394 100644 --- a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go +++ b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go @@ -38,32 +38,18 @@ type ListLinuxSubscriptionInstancesInput struct { // filter by the name of AmiID with an optional operator to see subscriptions that // match, partially match, or don't match a certain Amazon Machine Image (AMI) ID. // The valid names for this filter are: - // - // * AmiID - // - // * InstanceID - // - // * AccountID - // - // * - // Status - // - // * Region - // - // * UsageOperation - // - // * ProductCode - // - // * InstanceType - // - // The valid - // Operators for this filter are: - // - // * contains - // - // * equals - // - // * Notequal + // - AmiID + // - InstanceID + // - AccountID + // - Status + // - Region + // - UsageOperation + // - ProductCode + // - InstanceType + // The valid Operators for this filter are: + // - contains + // - equals + // - Notequal Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go index 40bd68bbdc1..e9d894dbcd7 100644 --- a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go +++ b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Linux subscriptions that have been discovered. If you have linked your -// organization, the returned results will include data aggregated across your +// Lists the Linux subscriptions that have been discovered. If you have linked +// your organization, the returned results will include data aggregated across your // accounts in Organizations. func (c *Client) ListLinuxSubscriptions(ctx context.Context, params *ListLinuxSubscriptionsInput, optFns ...func(*Options)) (*ListLinuxSubscriptionsOutput, error) { if params == nil { @@ -39,17 +39,11 @@ type ListLinuxSubscriptionsInput struct { // filter by the name of Subscription with an optional operator to see // subscriptions that match, partially match, or don't match a certain // subscription's name. The valid names for this filter are: - // - // * Subscription - // - // The - // valid Operators for this filter are: - // - // * contains - // - // * equals - // - // * Notequal + // - Subscription + // The valid Operators for this filter are: + // - contains + // - equals + // - Notequal Filters []types.Filter // Maximum number of results to return in a single call. diff --git a/service/licensemanagerlinuxsubscriptions/types/types.go b/service/licensemanagerlinuxsubscriptions/types/types.go index 1dd765c0258..ec384f90543 100644 --- a/service/licensemanagerlinuxsubscriptions/types/types.go +++ b/service/licensemanagerlinuxsubscriptions/types/types.go @@ -42,8 +42,7 @@ type Instance struct { LastUpdatedTime *string // The product code for the instance. For more information, see Usage operation - // values - // (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html) + // values (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html) // in the License Manager User Guide . ProductCode []string @@ -57,8 +56,7 @@ type Instance struct { SubscriptionName *string // The usage operation of the instance. For more information, see For more - // information, see Usage operation values - // (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html) + // information, see Usage operation values (https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html) // in the License Manager User Guide. UsageOperation *string @@ -91,8 +89,8 @@ type Subscription struct { // The name of the subscription. Name *string - // The type of subscription. The type can be subscription-included with Amazon EC2, - // Bring Your Own Subscription model (BYOS), or from the Amazon Web Services + // The type of subscription. The type can be subscription-included with Amazon + // EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services // Marketplace. Certain subscriptions may use licensing from the Amazon Web // Services Marketplace as well as OS licensing from Amazon EC2 or BYOS. Type *string diff --git a/service/licensemanagerusersubscriptions/api_client.go b/service/licensemanagerusersubscriptions/api_client.go index 54017998776..f375d64863d 100644 --- a/service/licensemanagerusersubscriptions/api_client.go +++ b/service/licensemanagerusersubscriptions/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/licensemanagerusersubscriptions/api_op_AssociateUser.go b/service/licensemanagerusersubscriptions/api_op_AssociateUser.go index 3ba1357d0dc..feba0245d68 100644 --- a/service/licensemanagerusersubscriptions/api_op_AssociateUser.go +++ b/service/licensemanagerusersubscriptions/api_op_AssociateUser.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the user to an EC2 instance to utilize user-based subscriptions. Your -// estimated bill for charges on the number of users and related costs will take 48 -// hours to appear for billing periods that haven't closed (marked as Pending -// billing status) in Amazon Web Services Billing. For more information, see -// Viewing your monthly charges -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html) in -// the Amazon Web Services Billing User Guide. +// Associates the user to an EC2 instance to utilize user-based subscriptions. +// Your estimated bill for charges on the number of users and related costs will +// take 48 hours to appear for billing periods that haven't closed (marked as +// Pending billing status) in Amazon Web Services Billing. For more information, +// see Viewing your monthly charges (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html) +// in the Amazon Web Services Billing User Guide. func (c *Client) AssociateUser(ctx context.Context, params *AssociateUserInput, optFns ...func(*Options)) (*AssociateUserOutput, error) { if params == nil { params = &AssociateUserInput{} diff --git a/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go b/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go index e726e1bce06..a2307e4876b 100644 --- a/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go +++ b/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go @@ -15,9 +15,8 @@ import ( // Your estimated bill for charges on the number of users and related costs will // take 48 hours to appear for billing periods that haven't closed (marked as // Pending billing status) in Amazon Web Services Billing. For more information, -// see Viewing your monthly charges -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html) in -// the Amazon Web Services Billing User Guide. +// see Viewing your monthly charges (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html) +// in the Amazon Web Services Billing User Guide. func (c *Client) StartProductSubscription(ctx context.Context, params *StartProductSubscriptionInput, optFns ...func(*Options)) (*StartProductSubscriptionOutput, error) { if params == nil { params = &StartProductSubscriptionInput{} diff --git a/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go b/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go index 243de5d2601..0867af8a770 100644 --- a/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go +++ b/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go @@ -43,14 +43,9 @@ type UpdateIdentityProviderSettingsInput struct { // Updates the registered identity provider’s product related configuration // settings. You can update any combination of settings in a single operation such // as the: - // - // * Subnets which you want to add to provision VPC endpoints. - // - // * Subnets - // which you want to remove the VPC endpoints from. - // - // * Security group ID which - // permits traffic to the VPC endpoints. + // - Subnets which you want to add to provision VPC endpoints. + // - Subnets which you want to remove the VPC endpoints from. + // - Security group ID which permits traffic to the VPC endpoints. // // This member is required. UpdateSettings *types.UpdateSettings diff --git a/service/licensemanagerusersubscriptions/doc.go b/service/licensemanagerusersubscriptions/doc.go index 192a8534099..287ea0ffaa0 100644 --- a/service/licensemanagerusersubscriptions/doc.go +++ b/service/licensemanagerusersubscriptions/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package licensemanagerusersubscriptions provides the API client, operations, and -// parameter types for AWS License Manager User Subscriptions. +// Package licensemanagerusersubscriptions provides the API client, operations, +// and parameter types for AWS License Manager User Subscriptions. // // With License Manager, you can create user-based subscriptions to utilize // licensed software with a per user subscription fee on Amazon EC2 instances. diff --git a/service/licensemanagerusersubscriptions/types/types.go b/service/licensemanagerusersubscriptions/types/types.go index 1f8cb661d91..0b8e0ed2305 100644 --- a/service/licensemanagerusersubscriptions/types/types.go +++ b/service/licensemanagerusersubscriptions/types/types.go @@ -15,9 +15,9 @@ type ActiveDirectoryIdentityProvider struct { noSmithyDocumentSerde } -// A filter name and value pair that is used to return more specific results from a -// describe operation. Filters can be used to match a set of resources by specific -// criteria, such as tags, attributes, or IDs. +// A filter name and value pair that is used to return more specific results from +// a describe operation. Filters can be used to match a set of resources by +// specific criteria, such as tags, attributes, or IDs. type Filter struct { // The name of an attribute to use as a filter. diff --git a/service/lightsail/api_client.go b/service/lightsail/api_client.go index b8301db8c29..d92c1e29a19 100644 --- a/service/lightsail/api_client.go +++ b/service/lightsail/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lightsail/api_op_AttachCertificateToDistribution.go b/service/lightsail/api_op_AttachCertificateToDistribution.go index 71ec424af98..f3aabb167c8 100644 --- a/service/lightsail/api_op_AttachCertificateToDistribution.go +++ b/service/lightsail/api_op_AttachCertificateToDistribution.go @@ -44,14 +44,13 @@ type AttachCertificateToDistributionInput struct { // in other API actions. It can be different than the domain name of the // certificate. For example, your certificate name might be // WordPress-Blog-Certificate and the domain name of the certificate might be - // example.com. + // example.com . // // This member is required. CertificateName *string // The name of the distribution that the certificate will be attached to. Use the - // GetDistributions action to get a list of distribution names that you can - // specify. + // GetDistributions action to get a list of distribution names that you can specify. // // This member is required. DistributionName *string diff --git a/service/lightsail/api_op_AttachDisk.go b/service/lightsail/api_op_AttachDisk.go index 24d236fd89f..9dcf15c6c88 100644 --- a/service/lightsail/api_op_AttachDisk.go +++ b/service/lightsail/api_op_AttachDisk.go @@ -14,9 +14,9 @@ import ( // Attaches a block storage disk to a running or stopped Lightsail instance and // exposes it to the instance with the specified disk name. The attach disk // operation supports tag-based access control via resource tags applied to the -// resource identified by disk name. For more information, see the Amazon Lightsail -// Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource identified by disk name . For more information, see the Amazon +// Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) AttachDisk(ctx context.Context, params *AttachDiskInput, optFns ...func(*Options)) (*AttachDiskOutput, error) { if params == nil { params = &AttachDiskInput{} @@ -34,12 +34,12 @@ func (c *Client) AttachDisk(ctx context.Context, params *AttachDiskInput, optFns type AttachDiskInput struct { - // The unique Lightsail disk name (e.g., my-disk). + // The unique Lightsail disk name (e.g., my-disk ). // // This member is required. DiskName *string - // The disk path to expose to the instance (e.g., /dev/xvdf). + // The disk path to expose to the instance (e.g., /dev/xvdf ). // // This member is required. DiskPath *string @@ -50,7 +50,7 @@ type AttachDiskInput struct { InstanceName *string // A Boolean value used to determine the automatic mounting of a storage volume to - // a virtual computer. The default value is False. This value only applies to + // a virtual computer. The default value is False . This value only applies to // Lightsail for Research resources. AutoMounting *bool diff --git a/service/lightsail/api_op_AttachInstancesToLoadBalancer.go b/service/lightsail/api_op_AttachInstancesToLoadBalancer.go index 53f9736cdfd..8e62c3af8ff 100644 --- a/service/lightsail/api_op_AttachInstancesToLoadBalancer.go +++ b/service/lightsail/api_op_AttachInstancesToLoadBalancer.go @@ -15,8 +15,8 @@ import ( // the instances are attached to the load balancer and the health check status is // available. The attach instances to load balancer operation supports tag-based // access control via resource tags applied to the resource identified by load -// balancer name. For more information, see the Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// balancer name . For more information, see the Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) AttachInstancesToLoadBalancer(ctx context.Context, params *AttachInstancesToLoadBalancerInput, optFns ...func(*Options)) (*AttachInstancesToLoadBalancerOutput, error) { if params == nil { params = &AttachInstancesToLoadBalancerInput{} @@ -34,11 +34,11 @@ func (c *Client) AttachInstancesToLoadBalancer(ctx context.Context, params *Atta type AttachInstancesToLoadBalancerInput struct { - // An array of strings representing the instance name(s) you want to attach to your - // load balancer. An instance must be running before you can attach it to your load - // balancer. There are no additional limits on the number of instances you can - // attach to your load balancer, aside from the limit of Lightsail instances you - // can create in your account (20). + // An array of strings representing the instance name(s) you want to attach to + // your load balancer. An instance must be running before you can attach it to + // your load balancer. There are no additional limits on the number of instances + // you can attach to your load balancer, aside from the limit of Lightsail + // instances you can create in your account (20). // // This member is required. InstanceNames []string diff --git a/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go b/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go index d9227273abe..5b2abaa08eb 100644 --- a/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS -// is just an updated, more secure version of Secure Socket Layer (SSL). Once you -// create and validate your certificate, you can attach it to your load balancer. -// You can also use this API to rotate the certificates on your account. Use the -// AttachLoadBalancerTlsCertificate action with the non-attached certificate, and -// it will replace the existing one and become the attached certificate. The -// AttachLoadBalancerTlsCertificate operation supports tag-based access control via -// resource tags applied to the resource identified by load balancer name. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Attaches a Transport Layer Security (TLS) certificate to your load balancer. +// TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once +// you create and validate your certificate, you can attach it to your load +// balancer. You can also use this API to rotate the certificates on your account. +// Use the AttachLoadBalancerTlsCertificate action with the non-attached +// certificate, and it will replace the existing one and become the attached +// certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based +// access control via resource tags applied to the resource identified by load +// balancer name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) AttachLoadBalancerTlsCertificate(ctx context.Context, params *AttachLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*AttachLoadBalancerTlsCertificateOutput, error) { if params == nil { params = &AttachLoadBalancerTlsCertificateInput{} diff --git a/service/lightsail/api_op_CloseInstancePublicPorts.go b/service/lightsail/api_op_CloseInstancePublicPorts.go index 98e45b083d6..08bc7d9eca6 100644 --- a/service/lightsail/api_op_CloseInstancePublicPorts.go +++ b/service/lightsail/api_op_CloseInstancePublicPorts.go @@ -13,9 +13,9 @@ import ( // Closes ports for a specific Amazon Lightsail instance. The // CloseInstancePublicPorts action supports tag-based access control via resource -// tags applied to the resource identified by instanceName. For more information, -// see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// tags applied to the resource identified by instanceName . For more information, +// see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CloseInstancePublicPorts(ctx context.Context, params *CloseInstancePublicPortsInput, optFns ...func(*Options)) (*CloseInstancePublicPortsOutput, error) { if params == nil { params = &CloseInstancePublicPortsInput{} diff --git a/service/lightsail/api_op_CopySnapshot.go b/service/lightsail/api_op_CopySnapshot.go index 426dd3c687b..c028fb48b26 100644 --- a/service/lightsail/api_op_CopySnapshot.go +++ b/service/lightsail/api_op_CopySnapshot.go @@ -15,10 +15,10 @@ import ( // copies an automatic snapshot of an instance or disk as a manual snapshot. This // operation can also be used to copy a manual or automatic snapshot of an instance // or a disk from one Amazon Web Services Region to another in Amazon Lightsail. -// When copying a manual snapshot, be sure to define the source region, source -// snapshot name, and target snapshot name parameters. When copying an automatic -// snapshot, be sure to define the source region, source resource name, target -// snapshot name, and either the restore date or the use latest restorable auto +// When copying a manual snapshot, be sure to define the source region , source +// snapshot name , and target snapshot name parameters. When copying an automatic +// snapshot, be sure to define the source region , source resource name , target +// snapshot name , and either the restore date or the use latest restorable auto // snapshot parameters. func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error) { if params == nil { @@ -51,45 +51,35 @@ type CopySnapshotInput struct { // The date of the source automatic snapshot to copy. Use the get auto snapshots // operation to identify the dates of the available automatic snapshots. // Constraints: - // - // * Must be specified in YYYY-MM-DD format. - // - // * This parameter cannot - // be defined together with the use latest restorable auto snapshot parameter. The - // restore date and use latest restorable auto snapshot parameters are mutually - // exclusive. - // - // * Define this parameter only when copying an automatic snapshot as a - // manual snapshot. For more information, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). + // - Must be specified in YYYY-MM-DD format. + // - This parameter cannot be defined together with the use latest restorable + // auto snapshot parameter. The restore date and use latest restorable auto + // snapshot parameters are mutually exclusive. + // - Define this parameter only when copying an automatic snapshot as a manual + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) + // . RestoreDate *string - // The name of the source instance or disk from which the source automatic snapshot - // was created. Constraint: - // - // * Define this parameter only when copying an automatic - // snapshot as a manual snapshot. For more information, see the Amazon Lightsail - // Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). + // The name of the source instance or disk from which the source automatic + // snapshot was created. Constraint: + // - Define this parameter only when copying an automatic snapshot as a manual + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) + // . SourceResourceName *string // The name of the source manual snapshot to copy. Constraint: - // - // * Define this - // parameter only when copying a manual snapshot as another manual snapshot. + // - Define this parameter only when copying a manual snapshot as another manual + // snapshot. SourceSnapshotName *string // A Boolean value to indicate whether to use the latest available automatic // snapshot of the specified source instance or disk. Constraints: - // - // * This - // parameter cannot be defined together with the restore date parameter. The use - // latest restorable auto snapshot and restore date parameters are mutually - // exclusive. - // - // * Define this parameter only when copying an automatic snapshot as a - // manual snapshot. For more information, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). + // - This parameter cannot be defined together with the restore date parameter. + // The use latest restorable auto snapshot and restore date parameters are + // mutually exclusive. + // - Define this parameter only when copying an automatic snapshot as a manual + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots) + // . UseLatestRestorableAutoSnapshot *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateBucket.go b/service/lightsail/api_op_CreateBucket.go index a2abdb1ddb0..c6ea59723dd 100644 --- a/service/lightsail/api_op_CreateBucket.go +++ b/service/lightsail/api_op_CreateBucket.go @@ -14,8 +14,7 @@ import ( // Creates an Amazon Lightsail bucket. A bucket is a cloud storage resource // available in the Lightsail object storage service. Use buckets to store objects // such as data and its descriptive metadata. For more information about buckets, -// see Buckets in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) +// see Buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) // in the Amazon Lightsail Developer Guide. func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { @@ -35,8 +34,7 @@ func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, op type CreateBucketInput struct { // The name for the bucket. For more information about bucket names, see Bucket - // naming rules in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail) + // naming rules in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail) // in the Amazon Lightsail Developer Guide. // // This member is required. @@ -44,11 +42,9 @@ type CreateBucketInput struct { // The ID of the bundle to use for the bucket. A bucket bundle specifies the // monthly cost, storage space, and data transfer quota for a bucket. Use the - // GetBucketBundles - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) + // GetBucketBundles (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) // action to get a list of bundle IDs that you can specify. Use the - // UpdateBucketBundle - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) + // UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) // action to change the bundle after the bucket is created. // // This member is required. @@ -56,14 +52,12 @@ type CreateBucketInput struct { // A Boolean value that indicates whether to enable versioning of objects in the // bucket. For more information about versioning, see Enabling and suspending - // object versioning in a bucket in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning) + // object versioning in a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning) // in the Amazon Lightsail Developer Guide. EnableObjectVersioning *bool // The tag keys and optional values to add to the bucket during creation. Use the - // TagResource - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html) + // TagResource (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html) // action to tag the bucket after it's created. Tags []types.Tag diff --git a/service/lightsail/api_op_CreateBucketAccessKey.go b/service/lightsail/api_op_CreateBucketAccessKey.go index e2e02daa23e..f4d5129377e 100644 --- a/service/lightsail/api_op_CreateBucketAccessKey.go +++ b/service/lightsail/api_op_CreateBucketAccessKey.go @@ -14,12 +14,10 @@ import ( // Creates a new access key for the specified Amazon Lightsail bucket. Access keys // consist of an access key ID and corresponding secret access key. Access keys // grant full programmatic access to the specified bucket and its objects. You can -// have a maximum of two access keys per bucket. Use the GetBucketAccessKeys -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) +// have a maximum of two access keys per bucket. Use the GetBucketAccessKeys (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) // action to get a list of current access keys for a specific bucket. For more // information about access keys, see Creating access keys for a bucket in Amazon -// Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) +// Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) // in the Amazon Lightsail Developer Guide. The secretAccessKey value is returned // only in response to the CreateBucketAccessKey action. You can get a secret // access key only when you first create an access key; you cannot get the secret diff --git a/service/lightsail/api_op_CreateCertificate.go b/service/lightsail/api_op_CreateCertificate.go index 32ce42e2ff0..255c96ae0d5 100644 --- a/service/lightsail/api_op_CreateCertificate.go +++ b/service/lightsail/api_op_CreateCertificate.go @@ -16,10 +16,11 @@ import ( // the AttachCertificateToDistribution action to use the certificate and its // domains with your distribution. Or use the UpdateContainerService action to use // the certificate and its domains with your container service. Only certificates -// created in the us-east-1 Amazon Web Services Region can be attached to Lightsail -// distributions. Lightsail distributions are global resources that can reference -// an origin in any Amazon Web Services Region, and distribute its content -// globally. However, all distributions are located in the us-east-1 Region. +// created in the us-east-1 Amazon Web Services Region can be attached to +// Lightsail distributions. Lightsail distributions are global resources that can +// reference an origin in any Amazon Web Services Region, and distribute its +// content globally. However, all distributions are located in the us-east-1 +// Region. func (c *Client) CreateCertificate(ctx context.Context, params *CreateCertificateInput, optFns ...func(*Options)) (*CreateCertificateOutput, error) { if params == nil { params = &CreateCertificateInput{} @@ -42,15 +43,15 @@ type CreateCertificateInput struct { // This member is required. CertificateName *string - // The domain name (e.g., example.com) for the certificate. + // The domain name (e.g., example.com ) for the certificate. // // This member is required. DomainName *string - // An array of strings that specify the alternate domains (e.g., example2.com) and - // subdomains (e.g., blog.example.com) for the certificate. You can specify a + // An array of strings that specify the alternate domains (e.g., example2.com ) and + // subdomains (e.g., blog.example.com ) for the certificate. You can specify a // maximum of nine alternate domains (in addition to the primary domain name). - // Wildcard domain entries (e.g., *.example.com) are not supported. + // Wildcard domain entries (e.g., *.example.com ) are not supported. SubjectAlternativeNames []string // The tag keys and optional values to add to the certificate during create. Use diff --git a/service/lightsail/api_op_CreateCloudFormationStack.go b/service/lightsail/api_op_CreateCloudFormationStack.go index 66dc46b7222..130bdf0b331 100644 --- a/service/lightsail/api_op_CreateCloudFormationStack.go +++ b/service/lightsail/api_op_CreateCloudFormationStack.go @@ -14,8 +14,8 @@ import ( // Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance // from an exported Amazon Lightsail snapshot. This operation results in a // CloudFormation stack record that can be used to track the AWS CloudFormation -// stack created. Use the get cloud formation stack records operation to get a list -// of the CloudFormation stacks created. Wait until after your new Amazon EC2 +// stack created. Use the get cloud formation stack records operation to get a +// list of the CloudFormation stacks created. Wait until after your new Amazon EC2 // instance is created before running the create cloud formation stack operation // again with the same export snapshot record. func (c *Client) CreateCloudFormationStack(ctx context.Context, params *CreateCloudFormationStackInput, optFns ...func(*Options)) (*CreateCloudFormationStackOutput, error) { diff --git a/service/lightsail/api_op_CreateContactMethod.go b/service/lightsail/api_op_CreateContactMethod.go index d4b5d0eef31..f4d49faea61 100644 --- a/service/lightsail/api_op_CreateContactMethod.go +++ b/service/lightsail/api_op_CreateContactMethod.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an email or SMS text message contact method. A contact method is used to -// send you notifications about your Amazon Lightsail resources. You can add one +// Creates an email or SMS text message contact method. A contact method is used +// to send you notifications about your Amazon Lightsail resources. You can add one // email address and one mobile phone number contact method in each Amazon Web // Services Region. However, SMS text messaging is not supported in some Amazon Web // Services Regions, and SMS text messages cannot be sent to some -// countries/regions. For more information, see Notifications in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) +// . func (c *Client) CreateContactMethod(ctx context.Context, params *CreateContactMethodInput, optFns ...func(*Options)) (*CreateContactMethodOutput, error) { if params == nil { params = &CreateContactMethodInput{} @@ -41,38 +41,26 @@ type CreateContactMethodInput struct { // telecommunication. Phone numbers that follow this format can have a maximum of // 15 digits, and they are prefixed with the plus character (+) and the country // code. For example, a U.S. phone number in E.164 format would be specified as - // +1XXX5550100. For more information, see E.164 - // (https://en.wikipedia.org/wiki/E.164) on Wikipedia. + // +1XXX5550100. For more information, see E.164 (https://en.wikipedia.org/wiki/E.164) + // on Wikipedia. // // This member is required. ContactEndpoint *string // The protocol of the contact method, such as Email or SMS (text messaging). The // SMS protocol is supported only in the following Amazon Web Services Regions. - // - // * - // US East (N. Virginia) (us-east-1) - // - // * US West (Oregon) (us-west-2) - // - // * Europe - // (Ireland) (eu-west-1) - // - // * Asia Pacific (Tokyo) (ap-northeast-1) - // - // * Asia Pacific - // (Singapore) (ap-southeast-1) - // - // * Asia Pacific (Sydney) (ap-southeast-2) - // - // For a - // list of countries/regions where SMS text messages can be sent, and the latest - // Amazon Web Services Regions where SMS text messaging is supported, see Supported - // Regions and Countries - // (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html) + // - US East (N. Virginia) ( us-east-1 ) + // - US West (Oregon) ( us-west-2 ) + // - Europe (Ireland) ( eu-west-1 ) + // - Asia Pacific (Tokyo) ( ap-northeast-1 ) + // - Asia Pacific (Singapore) ( ap-southeast-1 ) + // - Asia Pacific (Sydney) ( ap-southeast-2 ) + // For a list of countries/regions where SMS text messages can be sent, and the + // latest Amazon Web Services Regions where SMS text messaging is supported, see + // Supported Regions and Countries (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html) // in the Amazon SNS Developer Guide. For more information about notifications in - // Amazon Lightsail, see Notifications in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). + // Amazon Lightsail, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) + // . // // This member is required. Protocol types.ContactProtocol diff --git a/service/lightsail/api_op_CreateContainerService.go b/service/lightsail/api_op_CreateContainerService.go index c733e9bbcba..f8c4b13b6eb 100644 --- a/service/lightsail/api_op_CreateContainerService.go +++ b/service/lightsail/api_op_CreateContainerService.go @@ -13,8 +13,7 @@ import ( // Creates an Amazon Lightsail container service. A Lightsail container service is // a compute resource to which you can deploy containers. For more information, see -// Container services in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services) +// Container services in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services) // in the Lightsail Dev Guide. func (c *Client) CreateContainerService(ctx context.Context, params *CreateContainerServiceInput, optFns ...func(*Options)) (*CreateContainerServiceOutput, error) { if params == nil { @@ -37,9 +36,9 @@ type CreateContainerServiceInput struct { // amount of memory, vCPUs, and base monthly cost of each node of the container // service. The power and scale of a container service makes up its configured // capacity. To determine the monthly price of your container service, multiply the - // base price of the power with the scale (the number of nodes) of the service. Use - // the GetContainerServicePowers action to get a list of power options that you can - // specify using this parameter, and their base monthly cost. + // base price of the power with the scale (the number of nodes) of the service. + // Use the GetContainerServicePowers action to get a list of power options that + // you can specify using this parameter, and their base monthly cost. // // This member is required. Power types.ContainerServicePowerName @@ -53,26 +52,20 @@ type CreateContainerServiceInput struct { // This member is required. Scale *int32 - // The name for the container service. The name that you specify for your container - // service will make up part of its default domain. The default domain of a - // container service is typically https://...cs.amazonlightsail.com. If the name of - // your container service is container-service-1, and it's located in the US East - // (Ohio) Amazon Web Services Region (us-east-2), then the domain for your + // The name for the container service. The name that you specify for your + // container service will make up part of its default domain. The default domain of + // a container service is typically https://...cs.amazonlightsail.com . If the name + // of your container service is container-service-1 , and it's located in the US + // East (Ohio) Amazon Web Services Region ( us-east-2 ), then the domain for your // container service will be like the following example: // https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com The // following are the requirements for container service names: - // - // * Must be unique - // within each Amazon Web Services Region in your Lightsail account. - // - // * Must - // contain 1 to 63 characters. - // - // * Must contain only alphanumeric characters and - // hyphens. - // - // * A hyphen (-) can separate words but cannot be at the start or end of - // the name. + // - Must be unique within each Amazon Web Services Region in your Lightsail + // account. + // - Must contain 1 to 63 characters. + // - Must contain only alphanumeric characters and hyphens. + // - A hyphen (-) can separate words but cannot be at the start or end of the + // name. // // This member is required. ServiceName *string @@ -88,13 +81,12 @@ type CreateContainerServiceInput struct { // An object to describe the configuration for the container service to access // private container image repositories, such as Amazon Elastic Container Registry // (Amazon ECR) private repositories. For more information, see Configuring access - // to an Amazon ECR private repository for an Amazon Lightsail container service - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) + // to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. PrivateRegistryAccess *types.PrivateRegistryAccessRequest // The public domain names to use with the container service, such as example.com - // and www.example.com. You can specify up to four public domain names for a + // and www.example.com . You can specify up to four public domain names for a // container service. The domain names that you specify are used when you create a // deployment with a container configured as the public endpoint of your container // service. If you don't specify public domain names, then you can use the default @@ -107,8 +99,8 @@ type CreateContainerServiceInput struct { // The tag keys and optional values to add to the container service during create. // Use the TagResource action to tag a resource after it's created. For more - // information about tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // information about tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateContainerServiceDeployment.go b/service/lightsail/api_op_CreateContainerServiceDeployment.go index ae1f549a0a8..81ee9e9aa7b 100644 --- a/service/lightsail/api_op_CreateContainerServiceDeployment.go +++ b/service/lightsail/api_op_CreateContainerServiceDeployment.go @@ -19,8 +19,7 @@ import ( // HTTPS port to use, and the health check configuration. You can deploy containers // to your container service using container images from a public registry such as // Amazon ECR Public, or from your local machine. For more information, see -// Creating container images for your Amazon Lightsail container services -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images) +// Creating container images for your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images) // in the Amazon Lightsail Developer Guide. func (c *Client) CreateContainerServiceDeployment(ctx context.Context, params *CreateContainerServiceDeploymentInput, optFns ...func(*Options)) (*CreateContainerServiceDeploymentOutput, error) { if params == nil { @@ -44,8 +43,8 @@ type CreateContainerServiceDeploymentInput struct { // This member is required. ServiceName *string - // An object that describes the settings of the containers that will be launched on - // the container service. + // An object that describes the settings of the containers that will be launched + // on the container service. Containers map[string]types.Container // An object that describes the settings of the public endpoint for the container diff --git a/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go b/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go index a87f1db6238..2f9b82cdd77 100644 --- a/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go +++ b/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go @@ -26,8 +26,7 @@ import ( // you install and use the Lightsail Control (lightsailctl) plugin to push // container images to your Lightsail container service. For more information, see // Pushing and managing container images on your Amazon Lightsail container -// services -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) +// services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) // in the Amazon Lightsail Developer Guide. func (c *Client) CreateContainerServiceRegistryLogin(ctx context.Context, params *CreateContainerServiceRegistryLoginInput, optFns ...func(*Options)) (*CreateContainerServiceRegistryLoginOutput, error) { if params == nil { diff --git a/service/lightsail/api_op_CreateDisk.go b/service/lightsail/api_op_CreateDisk.go index 1135c1565d5..c3c0f7040e5 100644 --- a/service/lightsail/api_op_CreateDisk.go +++ b/service/lightsail/api_op_CreateDisk.go @@ -12,10 +12,10 @@ import ( ) // Creates a block storage disk that can be attached to an Amazon Lightsail -// instance in the same Availability Zone (e.g., us-east-2a). The create disk +// instance in the same Availability Zone (e.g., us-east-2a ). The create disk // operation supports tag-based access control via request tags. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateDisk(ctx context.Context, params *CreateDiskInput, optFns ...func(*Options)) (*CreateDiskOutput, error) { if params == nil { params = &CreateDiskInput{} @@ -33,7 +33,7 @@ func (c *Client) CreateDisk(ctx context.Context, params *CreateDiskInput, optFns type CreateDiskInput struct { - // The Availability Zone where you want to create the disk (e.g., us-east-2a). Use + // The Availability Zone where you want to create the disk (e.g., us-east-2a ). Use // the same Availability Zone as the Lightsail instance to which you want to attach // the disk. Use the get regions operation to list the Availability Zones where // Lightsail is currently available. @@ -41,12 +41,12 @@ type CreateDiskInput struct { // This member is required. AvailabilityZone *string - // The unique Lightsail disk name (e.g., my-disk). + // The unique Lightsail disk name (e.g., my-disk ). // // This member is required. DiskName *string - // The size of the disk in GB (e.g., 32). + // The size of the disk in GB (e.g., 32 ). // // This member is required. SizeInGb *int32 diff --git a/service/lightsail/api_op_CreateDiskFromSnapshot.go b/service/lightsail/api_op_CreateDiskFromSnapshot.go index a41033c0295..9f50ba3d497 100644 --- a/service/lightsail/api_op_CreateDiskFromSnapshot.go +++ b/service/lightsail/api_op_CreateDiskFromSnapshot.go @@ -13,11 +13,11 @@ import ( // Creates a block storage disk from a manual or automatic snapshot of a disk. The // resulting disk can be attached to an Amazon Lightsail instance in the same -// Availability Zone (e.g., us-east-2a). The create disk from snapshot operation +// Availability Zone (e.g., us-east-2a ). The create disk from snapshot operation // supports tag-based access control via request tags and resource tags applied to -// the resource identified by disk snapshot name. For more information, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// the resource identified by disk snapshot name . For more information, see the +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateDiskFromSnapshot(ctx context.Context, params *CreateDiskFromSnapshotInput, optFns ...func(*Options)) (*CreateDiskFromSnapshotOutput, error) { if params == nil { params = &CreateDiskFromSnapshotInput{} @@ -35,7 +35,7 @@ func (c *Client) CreateDiskFromSnapshot(ctx context.Context, params *CreateDiskF type CreateDiskFromSnapshotInput struct { - // The Availability Zone where you want to create the disk (e.g., us-east-2a). + // The Availability Zone where you want to create the disk (e.g., us-east-2a ). // Choose the same Availability Zone as the Lightsail instance where you want to // create the disk. Use the GetRegions operation to list the Availability Zones // where Lightsail is currently available. @@ -43,12 +43,12 @@ type CreateDiskFromSnapshotInput struct { // This member is required. AvailabilityZone *string - // The unique Lightsail disk name (e.g., my-disk). + // The unique Lightsail disk name (e.g., my-disk ). // // This member is required. DiskName *string - // The size of the disk in GB (e.g., 32). + // The size of the disk in GB (e.g., 32 ). // // This member is required. SizeInGb *int32 @@ -56,42 +56,33 @@ type CreateDiskFromSnapshotInput struct { // An array of objects that represent the add-ons to enable for the new disk. AddOns []types.AddOnRequest - // The name of the disk snapshot (e.g., my-snapshot) from which to create the new + // The name of the disk snapshot (e.g., my-snapshot ) from which to create the new // storage disk. Constraint: - // - // * This parameter cannot be defined together with the - // source disk name parameter. The disk snapshot name and source disk name - // parameters are mutually exclusive. + // - This parameter cannot be defined together with the source disk name + // parameter. The disk snapshot name and source disk name parameters are mutually + // exclusive. DiskSnapshotName *string // The date of the automatic snapshot to use for the new disk. Use the get auto // snapshots operation to identify the dates of the available automatic snapshots. // Constraints: - // - // * Must be specified in YYYY-MM-DD format. - // - // * This parameter cannot - // be defined together with the use latest restorable auto snapshot parameter. The - // restore date and use latest restorable auto snapshot parameters are mutually - // exclusive. - // - // * Define this parameter only when creating a new disk from an - // automatic snapshot. For more information, see the Amazon Lightsail Developer - // Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // - Must be specified in YYYY-MM-DD format. + // - This parameter cannot be defined together with the use latest restorable + // auto snapshot parameter. The restore date and use latest restorable auto + // snapshot parameters are mutually exclusive. + // - Define this parameter only when creating a new disk from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . RestoreDate *string // The name of the source disk from which the source automatic snapshot was // created. Constraints: - // - // * This parameter cannot be defined together with the disk - // snapshot name parameter. The source disk name and disk snapshot name parameters - // are mutually exclusive. - // - // * Define this parameter only when creating a new disk - // from an automatic snapshot. For more information, see the Amazon Lightsail - // Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // - This parameter cannot be defined together with the disk snapshot name + // parameter. The source disk name and disk snapshot name parameters are mutually + // exclusive. + // - Define this parameter only when creating a new disk from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . SourceDiskName *string // The tag keys and optional values to add to the resource during create. Use the @@ -100,15 +91,12 @@ type CreateDiskFromSnapshotInput struct { // A Boolean value to indicate whether to use the latest available automatic // snapshot. Constraints: - // - // * This parameter cannot be defined together with the - // restore date parameter. The use latest restorable auto snapshot and restore date - // parameters are mutually exclusive. - // - // * Define this parameter only when creating a - // new disk from an automatic snapshot. For more information, see the Amazon - // Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // - This parameter cannot be defined together with the restore date parameter. + // The use latest restorable auto snapshot and restore date parameters are + // mutually exclusive. + // - Define this parameter only when creating a new disk from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . UseLatestRestorableAutoSnapshot *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateDiskSnapshot.go b/service/lightsail/api_op_CreateDiskSnapshot.go index 4ac9cbae162..71a36fccc87 100644 --- a/service/lightsail/api_op_CreateDiskSnapshot.go +++ b/service/lightsail/api_op_CreateDiskSnapshot.go @@ -31,8 +31,8 @@ import ( // After the snapshot is available, you can create a block storage disk from the // snapshot and attach it to a running instance to access the data on the disk. The // create disk snapshot operation supports tag-based access control via request -// tags. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// tags. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateDiskSnapshot(ctx context.Context, params *CreateDiskSnapshotInput, optFns ...func(*Options)) (*CreateDiskSnapshotOutput, error) { if params == nil { params = &CreateDiskSnapshotInput{} @@ -50,18 +50,18 @@ func (c *Client) CreateDiskSnapshot(ctx context.Context, params *CreateDiskSnaps type CreateDiskSnapshotInput struct { - // The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the + // The name of the destination disk snapshot (e.g., my-disk-snapshot ) based on the // source disk. // // This member is required. DiskSnapshotName *string - // The unique name of the source disk (e.g., Disk-Virginia-1). This parameter + // The unique name of the source disk (e.g., Disk-Virginia-1 ). This parameter // cannot be defined together with the instance name parameter. The disk name and // instance name parameters are mutually exclusive. DiskName *string - // The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). + // The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1 ). // When this is defined, a snapshot of the instance's system volume is created. // This parameter cannot be defined together with the disk name parameter. The // instance name and disk name parameters are mutually exclusive. diff --git a/service/lightsail/api_op_CreateDistribution.go b/service/lightsail/api_op_CreateDistribution.go index 53059ce2560..3dfd5b4188a 100644 --- a/service/lightsail/api_op_CreateDistribution.go +++ b/service/lightsail/api_op_CreateDistribution.go @@ -15,8 +15,8 @@ import ( // distribution is a globally distributed network of caching servers that improve // the performance of your website or web application hosted on a Lightsail // instance. For more information, see Content delivery networks in Amazon -// Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions). +// Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions) +// . func (c *Client) CreateDistribution(ctx context.Context, params *CreateDistributionInput, optFns ...func(*Options)) (*CreateDistributionOutput, error) { if params == nil { params = &CreateDistributionInput{} @@ -67,7 +67,7 @@ type CreateDistributionInput struct { CacheBehaviors []types.CacheBehaviorPerPath // The IP address type for the distribution. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. The default value is dualstack. + // only, and dualstack for IPv4 and IPv6. The default value is dualstack . IpAddressType types.IpAddressType // The tag keys and optional values to add to the distribution during create. Use diff --git a/service/lightsail/api_op_CreateDomain.go b/service/lightsail/api_op_CreateDomain.go index e02219a1486..f6eae149ecc 100644 --- a/service/lightsail/api_op_CreateDomain.go +++ b/service/lightsail/api_op_CreateDomain.go @@ -13,8 +13,8 @@ import ( // Creates a domain resource for the specified domain (e.g., example.com). The // create domain operation supports tag-based access control via request tags. For -// more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -32,7 +32,7 @@ func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, op type CreateDomainInput struct { - // The domain name to manage (e.g., example.com). + // The domain name to manage (e.g., example.com ). // // This member is required. DomainName *string diff --git a/service/lightsail/api_op_CreateDomainEntry.go b/service/lightsail/api_op_CreateDomainEntry.go index 0e4c7427307..95df4c45c4b 100644 --- a/service/lightsail/api_op_CreateDomainEntry.go +++ b/service/lightsail/api_op_CreateDomainEntry.go @@ -13,11 +13,11 @@ import ( // Creates one of the following domain name system (DNS) records in a domain DNS // zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server -// (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create -// domain entry operation supports tag-based access control via resource tags -// applied to the resource identified by domain name. For more information, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// (NS), start of authority (SOA), service locator (SRV), or text (TXT). The +// create domain entry operation supports tag-based access control via resource +// tags applied to the resource identified by domain name . For more information, +// see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateDomainEntry(ctx context.Context, params *CreateDomainEntryInput, optFns ...func(*Options)) (*CreateDomainEntryOutput, error) { if params == nil { params = &CreateDomainEntryInput{} @@ -41,7 +41,7 @@ type CreateDomainEntryInput struct { // This member is required. DomainEntry *types.DomainEntry - // The domain name (e.g., example.com) for which you want to create the domain + // The domain name (e.g., example.com ) for which you want to create the domain // entry. // // This member is required. diff --git a/service/lightsail/api_op_CreateInstanceSnapshot.go b/service/lightsail/api_op_CreateInstanceSnapshot.go index 6e0b312bd92..9fa6d49518f 100644 --- a/service/lightsail/api_op_CreateInstanceSnapshot.go +++ b/service/lightsail/api_op_CreateInstanceSnapshot.go @@ -14,8 +14,8 @@ import ( // Creates a snapshot of a specific virtual private server, or instance. You can // use a snapshot to create a new instance that is based on that snapshot. The // create instance snapshot operation supports tag-based access control via request -// tags. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// tags. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateInstanceSnapshot(ctx context.Context, params *CreateInstanceSnapshotInput, optFns ...func(*Options)) (*CreateInstanceSnapshotOutput, error) { if params == nil { params = &CreateInstanceSnapshotInput{} diff --git a/service/lightsail/api_op_CreateInstances.go b/service/lightsail/api_op_CreateInstances.go index 6f550c61e1d..4ad50776cbe 100644 --- a/service/lightsail/api_op_CreateInstances.go +++ b/service/lightsail/api_op_CreateInstances.go @@ -13,8 +13,8 @@ import ( // Creates one or more Amazon Lightsail instances. The create instances operation // supports tag-based access control via request tags. For more information, see -// the Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// the Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateInstances(ctx context.Context, params *CreateInstancesInput, optFns ...func(*Options)) (*CreateInstancesOutput, error) { if params == nil { params = &CreateInstancesInput{} @@ -33,9 +33,8 @@ func (c *Client) CreateInstances(ctx context.Context, params *CreateInstancesInp type CreateInstancesInput struct { // The Availability Zone in which to create your instance. Use the following - // format: us-east-2a (case sensitive). You can get a list of Availability Zones by - // using the get regions - // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) + // format: us-east-2a (case sensitive). You can get a list of Availability Zones + // by using the get regions (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) // operation. Be sure to add the include Availability Zones parameter to your // request. // @@ -43,7 +42,7 @@ type CreateInstancesInput struct { AvailabilityZone *string // The ID for a virtual private server image (e.g., app_wordpress_4_4 or - // app_lamp_7_0). Use the get blueprints operation to return a list of available + // app_lamp_7_0 ). Use the get blueprints operation to return a list of available // images (or blueprints). Use active blueprints when creating new instances. // Inactive blueprints are listed to support customers with existing instances and // are not necessarily available to create new instances. Blueprints are marked @@ -54,7 +53,7 @@ type CreateInstancesInput struct { BlueprintId *string // The bundle of specification information for your virtual private server (or - // instance), including the pricing plan (e.g., micro_1_0). + // instance), including the pricing plan (e.g., micro_1_0 ). // // This member is required. BundleId *string @@ -69,14 +68,14 @@ type CreateInstancesInput struct { // An array of objects representing the add-ons to enable for the new instance. AddOns []types.AddOnRequest - // (Deprecated) The name for your custom image. In releases prior to June 12, 2017, - // this parameter was ignored by the API. It is now deprecated. + // (Deprecated) The name for your custom image. In releases prior to June 12, + // 2017, this parameter was ignored by the API. It is now deprecated. // // Deprecated: This member has been deprecated. CustomImageName *string // The IP address type for the instance. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. The default value is dualstack. + // only, and dualstack for IPv4 and IPv6. The default value is dualstack . IpAddressType types.IpAddressType // The name of your key pair. @@ -87,11 +86,11 @@ type CreateInstancesInput struct { Tags []types.Tag // A launch script you can create that configures a server with additional user - // data. For example, you might want to run apt-get -y update. Depending on the + // data. For example, you might want to run apt-get -y update . Depending on the // machine image you choose, the command to get software on your instance varies. - // Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses - // pkg. For a complete list, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image). + // Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD + // uses pkg . For a complete list, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image) + // . UserData *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateInstancesFromSnapshot.go b/service/lightsail/api_op_CreateInstancesFromSnapshot.go index 2d33aa578be..182262d56ed 100644 --- a/service/lightsail/api_op_CreateInstancesFromSnapshot.go +++ b/service/lightsail/api_op_CreateInstancesFromSnapshot.go @@ -12,11 +12,11 @@ import ( ) // Creates one or more new instances from a manual or automatic snapshot of an -// instance. The create instances from snapshot operation supports tag-based access -// control via request tags and resource tags applied to the resource identified by -// instance snapshot name. For more information, see the Amazon Lightsail Developer -// Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// instance. The create instances from snapshot operation supports tag-based +// access control via request tags and resource tags applied to the resource +// identified by instance snapshot name . For more information, see the Amazon +// Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateInstancesFromSnapshot(ctx context.Context, params *CreateInstancesFromSnapshotInput, optFns ...func(*Options)) (*CreateInstancesFromSnapshotOutput, error) { if params == nil { params = &CreateInstancesFromSnapshotInput{} @@ -34,10 +34,9 @@ func (c *Client) CreateInstancesFromSnapshot(ctx context.Context, params *Create type CreateInstancesFromSnapshotInput struct { - // The Availability Zone where you want to create your instances. Use the following - // formatting: us-east-2a (case sensitive). You can get a list of Availability - // Zones by using the get regions - // (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) + // The Availability Zone where you want to create your instances. Use the + // following formatting: us-east-2a (case sensitive). You can get a list of + // Availability Zones by using the get regions (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) // operation. Be sure to add the include Availability Zones parameter to your // request. // @@ -45,7 +44,7 @@ type CreateInstancesFromSnapshotInput struct { AvailabilityZone *string // The bundle of specification information for your virtual private server (or - // instance), including the pricing plan (e.g., micro_1_0). + // instance), including the pricing plan (e.g., micro_1_0 ). // // This member is required. BundleId *string @@ -64,47 +63,38 @@ type CreateInstancesFromSnapshotInput struct { // The name of the instance snapshot on which you are basing your new instances. // Use the get instance snapshots operation to return information about your // existing snapshots. Constraint: - // - // * This parameter cannot be defined together - // with the source instance name parameter. The instance snapshot name and source - // instance name parameters are mutually exclusive. + // - This parameter cannot be defined together with the source instance name + // parameter. The instance snapshot name and source instance name parameters are + // mutually exclusive. InstanceSnapshotName *string // The IP address type for the instance. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. The default value is dualstack. + // only, and dualstack for IPv4 and IPv6. The default value is dualstack . IpAddressType types.IpAddressType // The name for your key pair. KeyPairName *string - // The date of the automatic snapshot to use for the new instance. Use the get auto - // snapshots operation to identify the dates of the available automatic snapshots. - // Constraints: - // - // * Must be specified in YYYY-MM-DD format. - // - // * This parameter cannot - // be defined together with the use latest restorable auto snapshot parameter. The - // restore date and use latest restorable auto snapshot parameters are mutually - // exclusive. - // - // * Define this parameter only when creating a new instance from an - // automatic snapshot. For more information, see the Amazon Lightsail Developer - // Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // The date of the automatic snapshot to use for the new instance. Use the get + // auto snapshots operation to identify the dates of the available automatic + // snapshots. Constraints: + // - Must be specified in YYYY-MM-DD format. + // - This parameter cannot be defined together with the use latest restorable + // auto snapshot parameter. The restore date and use latest restorable auto + // snapshot parameters are mutually exclusive. + // - Define this parameter only when creating a new instance from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . RestoreDate *string // The name of the source instance from which the source automatic snapshot was // created. Constraints: - // - // * This parameter cannot be defined together with the - // instance snapshot name parameter. The source instance name and instance snapshot - // name parameters are mutually exclusive. - // - // * Define this parameter only when - // creating a new instance from an automatic snapshot. For more information, see - // the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // - This parameter cannot be defined together with the instance snapshot name + // parameter. The source instance name and instance snapshot name parameters are + // mutually exclusive. + // - Define this parameter only when creating a new instance from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . SourceInstanceName *string // The tag keys and optional values to add to the resource during create. Use the @@ -113,23 +103,20 @@ type CreateInstancesFromSnapshotInput struct { // A Boolean value to indicate whether to use the latest available automatic // snapshot. Constraints: - // - // * This parameter cannot be defined together with the - // restore date parameter. The use latest restorable auto snapshot and restore date - // parameters are mutually exclusive. - // - // * Define this parameter only when creating a - // new instance from an automatic snapshot. For more information, see the Amazon - // Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). + // - This parameter cannot be defined together with the restore date parameter. + // The use latest restorable auto snapshot and restore date parameters are + // mutually exclusive. + // - Define this parameter only when creating a new instance from an automatic + // snapshot. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) + // . UseLatestRestorableAutoSnapshot *bool // You can create a launch script that configures a server with additional user - // data. For example, apt-get -y update. Depending on the machine image you choose, - // the command to get software on your instance varies. Amazon Linux and CentOS use - // yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, - // see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image). + // data. For example, apt-get -y update . Depending on the machine image you + // choose, the command to get software on your instance varies. Amazon Linux and + // CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD uses pkg . For a + // complete list, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image) + // . UserData *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateKeyPair.go b/service/lightsail/api_op_CreateKeyPair.go index e22817a743c..0b3e81be934 100644 --- a/service/lightsail/api_op_CreateKeyPair.go +++ b/service/lightsail/api_op_CreateKeyPair.go @@ -12,13 +12,12 @@ import ( ) // Creates a custom SSH key pair that you can use with an Amazon Lightsail -// instance. Use the DownloadDefaultKeyPair -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) +// instance. Use the DownloadDefaultKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) // action to create a Lightsail default key pair in an Amazon Web Services Region -// where a default key pair does not currently exist. The create key pair operation -// supports tag-based access control via request tags. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// where a default key pair does not currently exist. The create key pair +// operation supports tag-based access control via request tags. For more +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, optFns ...func(*Options)) (*CreateKeyPairOutput, error) { if params == nil { params = &CreateKeyPairInput{} diff --git a/service/lightsail/api_op_CreateLoadBalancer.go b/service/lightsail/api_op_CreateLoadBalancer.go index d9dfc87d62b..8519b89f015 100644 --- a/service/lightsail/api_op_CreateLoadBalancer.go +++ b/service/lightsail/api_op_CreateLoadBalancer.go @@ -13,14 +13,13 @@ import ( // Creates a Lightsail load balancer. To learn more about deciding whether to load // balance your application, see Configure your Lightsail instances for load -// balancing -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/configure-lightsail-instances-for-load-balancing). -// You can create up to 5 load balancers per AWS Region in your account. When you +// balancing (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/configure-lightsail-instances-for-load-balancing) +// . You can create up to 5 load balancers per AWS Region in your account. When you // create a load balancer, you can specify a unique name and port settings. To // change additional load balancer settings, use the UpdateLoadBalancerAttribute // operation. The create load balancer operation supports tag-based access control -// via request tags. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// via request tags. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error) { if params == nil { params = &CreateLoadBalancerInput{} @@ -49,28 +48,28 @@ type CreateLoadBalancerInput struct { LoadBalancerName *string // The optional alternative domains and subdomains to use with your SSL/TLS - // certificate (e.g., www.example.com, example.com, m.example.com, - // blog.example.com). + // certificate (e.g., www.example.com , example.com , m.example.com , + // blog.example.com ). CertificateAlternativeNames []string - // The domain name with which your certificate is associated (e.g., example.com). - // If you specify certificateDomainName, then certificateName is required (and + // The domain name with which your certificate is associated (e.g., example.com ). + // If you specify certificateDomainName , then certificateName is required (and // vice-versa). CertificateDomainName *string - // The name of the SSL/TLS certificate. If you specify certificateName, then + // The name of the SSL/TLS certificate. If you specify certificateName , then // certificateDomainName is required (and vice-versa). CertificateName *string // The path you provided to perform the load balancer health check. If you didn't // specify a health check path, Lightsail uses the root path of your website (e.g., - // "/"). You may want to specify a custom health check path other than the root of + // "/" ). You may want to specify a custom health check path other than the root of // your application if your home page loads slowly or has a lot of media or // scripting on it. HealthCheckPath *string - // The IP address type for the load balancer. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. The default value is dualstack. + // The IP address type for the load balancer. The possible values are ipv4 for + // IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack . IpAddressType types.IpAddressType // The tag keys and optional values to add to the resource during create. Use the @@ -78,12 +77,10 @@ type CreateLoadBalancerInput struct { Tags []types.Tag // The name of the TLS policy to apply to the load balancer. Use the - // GetLoadBalancerTlsPolicies - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) + // GetLoadBalancerTlsPolicies (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) // action to get a list of TLS policy names that you can specify. For more // information about load balancer TLS policies, see Configuring TLS security - // policies on your Amazon Lightsail load balancers - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) + // policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) // in the Amazon Lightsail Developer Guide. TlsPolicyName *string diff --git a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go index ae8e1835589..745068bc9ce 100644 --- a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go @@ -14,9 +14,9 @@ import ( // Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is // just an updated, more secure version of Secure Socket Layer (SSL). The // CreateLoadBalancerTlsCertificate operation supports tag-based access control via -// resource tags applied to the resource identified by load balancer name. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource tags applied to the resource identified by load balancer name . For +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateLoadBalancerTlsCertificate(ctx context.Context, params *CreateLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*CreateLoadBalancerTlsCertificateOutput, error) { if params == nil { params = &CreateLoadBalancerTlsCertificateInput{} @@ -34,16 +34,16 @@ func (c *Client) CreateLoadBalancerTlsCertificate(ctx context.Context, params *C type CreateLoadBalancerTlsCertificateInput struct { - // The domain name (e.g., example.com) for your SSL/TLS certificate. + // The domain name (e.g., example.com ) for your SSL/TLS certificate. // // This member is required. CertificateDomainName *string - // The SSL/TLS certificate name. You can have up to 10 certificates in your account - // at one time. Each Lightsail load balancer can have up to 2 certificates + // The SSL/TLS certificate name. You can have up to 10 certificates in your + // account at one time. Each Lightsail load balancer can have up to 2 certificates // associated with it at one time. There is also an overall limit to the number of // certificates that can be issue in a 365-day period. For more information, see - // Limits (http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html). + // Limits (http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html) . // // This member is required. CertificateName *string @@ -56,7 +56,7 @@ type CreateLoadBalancerTlsCertificateInput struct { // An array of strings listing alternative domains and subdomains for your SSL/TLS // certificate. Lightsail will de-dupe the names for you. You can have a maximum of // 9 alternative names (in addition to the 1 primary domain). We do not support - // wildcards (e.g., *.example.com). + // wildcards (e.g., *.example.com ). CertificateAlternativeNames []string // The tag keys and optional values to add to the resource during create. Use the diff --git a/service/lightsail/api_op_CreateRelationalDatabase.go b/service/lightsail/api_op_CreateRelationalDatabase.go index 4b8f7a7a9a0..77bdffa0ddf 100644 --- a/service/lightsail/api_op_CreateRelationalDatabase.go +++ b/service/lightsail/api_op_CreateRelationalDatabase.go @@ -13,8 +13,8 @@ import ( // Creates a new database in Amazon Lightsail. The create relational database // operation supports tag-based access control via request tags. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateRelationalDatabase(ctx context.Context, params *CreateRelationalDatabaseInput, optFns ...func(*Options)) (*CreateRelationalDatabaseOutput, error) { if params == nil { params = &CreateRelationalDatabaseInput{} @@ -36,77 +36,51 @@ type CreateRelationalDatabaseInput struct { // MySQL The name of the database to create when the Lightsail database resource is // created. If this parameter isn't specified, no database is created in the // database resource. Constraints: - // - // * Must contain 1 to 64 letters or numbers. - // - // * - // Must begin with a letter. Subsequent characters can be letters, underscores, or - // digits (0- 9). - // - // * Can't be a word reserved by the specified database engine. For - // more information about reserved words in MySQL, see the Keywords and Reserved - // Words articles for MySQL 5.6 - // (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7 - // (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and MySQL 8.0 - // (https://dev.mysql.com/doc/refman/8.0/en/keywords.html). - // - // PostgreSQL The name of - // the database to create when the Lightsail database resource is created. If this - // parameter isn't specified, a database named postgres is created in the database - // resource. Constraints: - // - // * Must contain 1 to 63 letters or numbers. - // - // * Must begin - // with a letter. Subsequent characters can be letters, underscores, or digits (0- - // 9). - // - // * Can't be a word reserved by the specified database engine. For more - // information about reserved words in PostgreSQL, see the SQL Key Words articles - // for PostgreSQL 9.6 - // (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), PostgreSQL 10 - // (https://www.postgresql.org/docs/10/sql-keywords-appendix.html), PostgreSQL 11 - // (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and PostgreSQL - // 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html). + // - Must contain 1 to 64 letters or numbers. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0- 9). + // - Can't be a word reserved by the specified database engine. For more + // information about reserved words in MySQL, see the Keywords and Reserved Words + // articles for MySQL 5.6 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html) + // , MySQL 5.7 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , and + // MySQL 8.0 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html) . + // PostgreSQL The name of the database to create when the Lightsail database + // resource is created. If this parameter isn't specified, a database named + // postgres is created in the database resource. Constraints: + // - Must contain 1 to 63 letters or numbers. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0- 9). + // - Can't be a word reserved by the specified database engine. For more + // information about reserved words in PostgreSQL, see the SQL Key Words articles + // for PostgreSQL 9.6 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) + // , PostgreSQL 10 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html) + // , PostgreSQL 11 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html) + // , and PostgreSQL 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html) + // . // // This member is required. MasterDatabaseName *string // The name for the master user. MySQL Constraints: - // - // * Required for MySQL. - // - // * Must - // be 1 to 16 letters or numbers. Can contain underscores. - // - // * First character must - // be a letter. - // - // * Can't be a reserved word for the chosen database engine. For - // more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and - // Reserved Words articles for MySQL 5.6 - // (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7 - // (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or MySQL 8.0 - // (https://dev.mysql.com/doc/refman/8.0/en/keywords.html). - // - // PostgreSQL - // Constraints: - // - // * Required for PostgreSQL. - // - // * Must be 1 to 63 letters or numbers. - // Can contain underscores. - // - // * First character must be a letter. - // - // * Can't be a - // reserved word for the chosen database engine. For more information about - // reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles - // for PostgreSQL 9.6 - // (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), PostgreSQL 10 - // (https://www.postgresql.org/docs/10/sql-keywords-appendix.html), PostgreSQL 11 - // (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and PostgreSQL - // 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html). + // - Required for MySQL. + // - Must be 1 to 16 letters or numbers. Can contain underscores. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. For more + // information about reserved words in MySQL 5.6 or 5.7, see the Keywords and + // Reserved Words articles for MySQL 5.6 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html) + // , MySQL 5.7 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html) , or + // MySQL 8.0 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html) . + // PostgreSQL Constraints: + // - Required for PostgreSQL. + // - Must be 1 to 63 letters or numbers. Can contain underscores. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. For more + // information about reserved words in MySQL 5.6 or 5.7, see the Keywords and + // Reserved Words articles for PostgreSQL 9.6 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html) + // , PostgreSQL 10 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html) + // , PostgreSQL 11 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html) + // , and PostgreSQL 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html) + // . // // This member is required. MasterUsername *string @@ -126,20 +100,16 @@ type CreateRelationalDatabaseInput struct { RelationalDatabaseBundleId *string // The name to use for your new Lightsail database resource. Constraints: - // - // * Must - // contain from 2 to 255 alphanumeric characters, or hyphens. - // - // * The first and last - // character must be a letter or number. + // - Must contain from 2 to 255 alphanumeric characters, or hyphens. + // - The first and last character must be a letter or number. // // This member is required. RelationalDatabaseName *string // The Availability Zone in which to create your new database. Use the us-east-2a - // case-sensitive format. You can get a list of Availability Zones by using the get - // regions operation. Be sure to add the include relational database Availability - // Zones parameter to your request. + // case-sensitive format. You can get a list of Availability Zones by using the + // get regions operation. Be sure to add the include relational database + // Availability Zones parameter to your request. AvailabilityZone *string // The password for the master user. The password can include any printable ASCII @@ -152,38 +122,23 @@ type CreateRelationalDatabaseInput struct { // database if automated backups are enabled. The default is a 30-minute window // selected at random from an 8-hour block of time for each AWS Region. For more // information about the preferred backup window time blocks for each region, see - // the Working With Backups - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) + // the Working With Backups (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // guide in the Amazon Relational Database Service documentation. Constraints: - // - // * - // Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 - // - // * Specified in - // Coordinated Universal Time (UTC). - // - // * Must not conflict with the preferred - // maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 + // - Specified in Coordinated Universal Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur on your new // database. The default is a 30-minute window selected at random from an 8-hour // block of time for each AWS Region, occurring on a random day of the week. // Constraints: - // - // * Must be in the ddd:hh24:mi-ddd:hh24:mi format. - // - // * Valid days: - // Mon, Tue, Wed, Thu, Fri, Sat, Sun. - // - // * Must be at least 30 minutes. - // - // * Specified - // in Coordinated Universal Time (UTC). - // - // * Example: Tue:17:00-Tue:17:30 + // - Must be in the ddd:hh24:mi-ddd:hh24:mi format. + // - Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // - Must be at least 30 minutes. + // - Specified in Coordinated Universal Time (UTC). + // - Example: Tue:17:00-Tue:17:30 PreferredMaintenanceWindow *string // Specifies the accessibility options for your new database. A value of true diff --git a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go index f54f8302f29..042a1fe1a96 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go @@ -18,8 +18,8 @@ import ( // availability or standard plan. The create relational database from snapshot // operation supports tag-based access control via request tags and resource tags // applied to the resource identified by relationalDatabaseSnapshotName. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateRelationalDatabaseFromSnapshot(ctx context.Context, params *CreateRelationalDatabaseFromSnapshotInput, optFns ...func(*Options)) (*CreateRelationalDatabaseFromSnapshotOutput, error) { if params == nil { params = &CreateRelationalDatabaseFromSnapshotInput{} @@ -38,20 +38,16 @@ func (c *Client) CreateRelationalDatabaseFromSnapshot(ctx context.Context, param type CreateRelationalDatabaseFromSnapshotInput struct { // The name to use for your new Lightsail database resource. Constraints: - // - // * Must - // contain from 2 to 255 alphanumeric characters, or hyphens. - // - // * The first and last - // character must be a letter or number. + // - Must contain from 2 to 255 alphanumeric characters, or hyphens. + // - The first and last character must be a letter or number. // // This member is required. RelationalDatabaseName *string // The Availability Zone in which to create your new database. Use the us-east-2a - // case-sensitive format. You can get a list of Availability Zones by using the get - // regions operation. Be sure to add the include relational database Availability - // Zones parameter to your request. + // case-sensitive format. You can get a list of Availability Zones by using the + // get regions operation. Be sure to add the include relational database + // Availability Zones parameter to your request. AvailabilityZone *string // Specifies the accessibility options for your new database. A value of true @@ -71,19 +67,12 @@ type CreateRelationalDatabaseFromSnapshotInput struct { RelationalDatabaseSnapshotName *string // The date and time to restore your database from. Constraints: - // - // * Must be before - // the latest restorable time for the database. - // - // * Cannot be specified if the use - // latest restorable time parameter is true. - // - // * Specified in Coordinated Universal - // Time (UTC). - // - // * Specified in the Unix time format. For example, if you wish to - // use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as - // the restore time. + // - Must be before the latest restorable time for the database. + // - Cannot be specified if the use latest restorable time parameter is true . + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a + // restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the + // restore time. RestoreTime *time.Time // The name of the source database. @@ -93,9 +82,9 @@ type CreateRelationalDatabaseFromSnapshotInput struct { // TagResource action to tag a resource after it's created. Tags []types.Tag - // Specifies whether your database is restored from the latest backup time. A value - // of true restores from the latest backup time. Default: false Constraints: Cannot - // be specified if the restore time parameter is provided. + // Specifies whether your database is restored from the latest backup time. A + // value of true restores from the latest backup time. Default: false Constraints: + // Cannot be specified if the restore time parameter is provided. UseLatestRestorableTime *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go b/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go index d0c6149a432..d6f4ffc43d7 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go @@ -15,8 +15,8 @@ import ( // for backups, to make copies of a database, and to save data before deleting a // database. The create relational database snapshot operation supports tag-based // access control via request tags. For more information, see the Amazon Lightsail -// Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) CreateRelationalDatabaseSnapshot(ctx context.Context, params *CreateRelationalDatabaseSnapshotInput, optFns ...func(*Options)) (*CreateRelationalDatabaseSnapshotOutput, error) { if params == nil { params = &CreateRelationalDatabaseSnapshotInput{} @@ -40,12 +40,8 @@ type CreateRelationalDatabaseSnapshotInput struct { RelationalDatabaseName *string // The name for your new database snapshot. Constraints: - // - // * Must contain from 2 to - // 255 alphanumeric characters, or hyphens. - // - // * The first and last character must be - // a letter or number. + // - Must contain from 2 to 255 alphanumeric characters, or hyphens. + // - The first and last character must be a letter or number. // // This member is required. RelationalDatabaseSnapshotName *string diff --git a/service/lightsail/api_op_DeleteAlarm.go b/service/lightsail/api_op_DeleteAlarm.go index d5e43cf9532..b48cb80a221 100644 --- a/service/lightsail/api_op_DeleteAlarm.go +++ b/service/lightsail/api_op_DeleteAlarm.go @@ -14,8 +14,8 @@ import ( // Deletes an alarm. An alarm is used to monitor a single metric for one of your // resources. When a metric condition is met, the alarm can notify you by email, // SMS text message, and a banner displayed on the Amazon Lightsail console. For -// more information, see Alarms in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). +// more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . func (c *Client) DeleteAlarm(ctx context.Context, params *DeleteAlarmInput, optFns ...func(*Options)) (*DeleteAlarmOutput, error) { if params == nil { params = &DeleteAlarmInput{} diff --git a/service/lightsail/api_op_DeleteAutoSnapshot.go b/service/lightsail/api_op_DeleteAutoSnapshot.go index 64e7ba9aea1..0fb40f4d4f3 100644 --- a/service/lightsail/api_op_DeleteAutoSnapshot.go +++ b/service/lightsail/api_op_DeleteAutoSnapshot.go @@ -12,8 +12,8 @@ import ( ) // Deletes an automatic snapshot of an instance or disk. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) +// . func (c *Client) DeleteAutoSnapshot(ctx context.Context, params *DeleteAutoSnapshotInput, optFns ...func(*Options)) (*DeleteAutoSnapshotOutput, error) { if params == nil { params = &DeleteAutoSnapshotInput{} @@ -32,8 +32,7 @@ func (c *Client) DeleteAutoSnapshot(ctx context.Context, params *DeleteAutoSnaps type DeleteAutoSnapshotInput struct { // The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get - // auto snapshots operation to get the available automatic snapshots for a - // resource. + // auto snapshots operation to get the available automatic snapshots for a resource. // // This member is required. Date *string diff --git a/service/lightsail/api_op_DeleteBucket.go b/service/lightsail/api_op_DeleteBucket.go index 468f30b4220..95c57173e80 100644 --- a/service/lightsail/api_op_DeleteBucket.go +++ b/service/lightsail/api_op_DeleteBucket.go @@ -31,8 +31,7 @@ func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, op type DeleteBucketInput struct { - // The name of the bucket to delete. Use the GetBuckets - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) + // The name of the bucket to delete. Use the GetBuckets (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) // action to get a list of bucket names that you can specify. // // This member is required. @@ -40,22 +39,14 @@ type DeleteBucketInput struct { // A Boolean value that indicates whether to force delete the bucket. You must // force delete the bucket if it has one of the following conditions: - // - // * The bucket - // is the origin of a distribution. - // - // * The bucket has instances that were granted - // access to it using the SetResourceAccessForBucket - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) - // action. - // - // * The bucket has objects. - // - // * The bucket has access keys. - // - // Force - // deleting a bucket might impact other resources that rely on the bucket, such as - // instances, distributions, or software that use the issued access keys. + // - The bucket is the origin of a distribution. + // - The bucket has instances that were granted access to it using the + // SetResourceAccessForBucket (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) + // action. + // - The bucket has objects. + // - The bucket has access keys. + // Force deleting a bucket might impact other resources that rely on the bucket, + // such as instances, distributions, or software that use the issued access keys. ForceDelete *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteBucketAccessKey.go b/service/lightsail/api_op_DeleteBucketAccessKey.go index 988041a48b0..3252a0db7ba 100644 --- a/service/lightsail/api_op_DeleteBucketAccessKey.go +++ b/service/lightsail/api_op_DeleteBucketAccessKey.go @@ -14,8 +14,7 @@ import ( // Deletes an access key for the specified Amazon Lightsail bucket. We recommend // that you delete an access key if the secret access key is compromised. For more // information about access keys, see Creating access keys for a bucket in Amazon -// Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) +// Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) // in the Amazon Lightsail Developer Guide. func (c *Client) DeleteBucketAccessKey(ctx context.Context, params *DeleteBucketAccessKeyInput, optFns ...func(*Options)) (*DeleteBucketAccessKeyOutput, error) { if params == nil { @@ -34,8 +33,7 @@ func (c *Client) DeleteBucketAccessKey(ctx context.Context, params *DeleteBucket type DeleteBucketAccessKeyInput struct { - // The ID of the access key to delete. Use the GetBucketAccessKeys - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) + // The ID of the access key to delete. Use the GetBucketAccessKeys (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) // action to get a list of access key IDs that you can specify. // // This member is required. diff --git a/service/lightsail/api_op_DeleteCertificate.go b/service/lightsail/api_op_DeleteCertificate.go index 0116e52633e..6a4d9df94ad 100644 --- a/service/lightsail/api_op_DeleteCertificate.go +++ b/service/lightsail/api_op_DeleteCertificate.go @@ -13,8 +13,8 @@ import ( // Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery // network (CDN) distribution. Certificates that are currently attached to a -// distribution cannot be deleted. Use the DetachCertificateFromDistribution action -// to detach a certificate from a distribution. +// distribution cannot be deleted. Use the DetachCertificateFromDistribution +// action to detach a certificate from a distribution. func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error) { if params == nil { params = &DeleteCertificateInput{} diff --git a/service/lightsail/api_op_DeleteContactMethod.go b/service/lightsail/api_op_DeleteContactMethod.go index 5d142cc3781..25c81d68e80 100644 --- a/service/lightsail/api_op_DeleteContactMethod.go +++ b/service/lightsail/api_op_DeleteContactMethod.go @@ -16,8 +16,8 @@ import ( // mobile phone number contact method in each Amazon Web Services Region. However, // SMS text messaging is not supported in some Amazon Web Services Regions, and SMS // text messages cannot be sent to some countries/regions. For more information, -// see Notifications in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) +// . func (c *Client) DeleteContactMethod(ctx context.Context, params *DeleteContactMethodInput, optFns ...func(*Options)) (*DeleteContactMethodOutput, error) { if params == nil { params = &DeleteContactMethodInput{} diff --git a/service/lightsail/api_op_DeleteContainerImage.go b/service/lightsail/api_op_DeleteContainerImage.go index a8ad1232999..ddecd682b96 100644 --- a/service/lightsail/api_op_DeleteContainerImage.go +++ b/service/lightsail/api_op_DeleteContainerImage.go @@ -33,9 +33,9 @@ type DeleteContainerImageInput struct { // GetContainerImages action to get the name of the container images that are // registered to a container service. Container images sourced from your Lightsail // container service, that are registered and stored on your service, start with a - // colon (:). For example, :container-service-1.mystaticwebsite.1. Container images - // sourced from a public registry like Docker Hub don't start with a colon. For - // example, nginx:latest or nginx. + // colon ( : ). For example, :container-service-1.mystaticwebsite.1 . Container + // images sourced from a public registry like Docker Hub don't start with a colon. + // For example, nginx:latest or nginx . // // This member is required. Image *string diff --git a/service/lightsail/api_op_DeleteDisk.go b/service/lightsail/api_op_DeleteDisk.go index 670f3f3e87c..11e93be23ab 100644 --- a/service/lightsail/api_op_DeleteDisk.go +++ b/service/lightsail/api_op_DeleteDisk.go @@ -13,10 +13,10 @@ import ( // Deletes the specified block storage disk. The disk must be in the available // state (not attached to a Lightsail instance). The disk may remain in the -// deleting state for several minutes. The delete disk operation supports tag-based -// access control via resource tags applied to the resource identified by disk -// name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// deleting state for several minutes. The delete disk operation supports +// tag-based access control via resource tags applied to the resource identified by +// disk name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteDisk(ctx context.Context, params *DeleteDiskInput, optFns ...func(*Options)) (*DeleteDiskOutput, error) { if params == nil { params = &DeleteDiskInput{} @@ -34,7 +34,7 @@ func (c *Client) DeleteDisk(ctx context.Context, params *DeleteDiskInput, optFns type DeleteDiskInput struct { - // The unique name of the disk you want to delete (e.g., my-disk). + // The unique name of the disk you want to delete (e.g., my-disk ). // // This member is required. DiskName *string diff --git a/service/lightsail/api_op_DeleteDiskSnapshot.go b/service/lightsail/api_op_DeleteDiskSnapshot.go index 3b14a557fa9..e14b3729384 100644 --- a/service/lightsail/api_op_DeleteDiskSnapshot.go +++ b/service/lightsail/api_op_DeleteDiskSnapshot.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified disk snapshot. When you make periodic snapshots of a disk, -// the snapshots are incremental, and only the blocks on the device that have +// Deletes the specified disk snapshot. When you make periodic snapshots of a +// disk, the snapshots are incremental, and only the blocks on the device that have // changed since your last snapshot are saved in the new snapshot. When you delete // a snapshot, only the data not needed for any other snapshot is removed. So // regardless of which prior snapshots have been deleted, all active snapshots will // have access to all the information needed to restore the disk. The delete disk // snapshot operation supports tag-based access control via resource tags applied -// to the resource identified by disk snapshot name. For more information, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// to the resource identified by disk snapshot name . For more information, see the +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteDiskSnapshot(ctx context.Context, params *DeleteDiskSnapshotInput, optFns ...func(*Options)) (*DeleteDiskSnapshotOutput, error) { if params == nil { params = &DeleteDiskSnapshotInput{} @@ -38,7 +38,7 @@ func (c *Client) DeleteDiskSnapshot(ctx context.Context, params *DeleteDiskSnaps type DeleteDiskSnapshotInput struct { - // The name of the disk snapshot you want to delete (e.g., my-disk-snapshot). + // The name of the disk snapshot you want to delete (e.g., my-disk-snapshot ). // // This member is required. DiskSnapshotName *string diff --git a/service/lightsail/api_op_DeleteDistribution.go b/service/lightsail/api_op_DeleteDistribution.go index b9ca6ffb6c0..ebe79a6fc31 100644 --- a/service/lightsail/api_op_DeleteDistribution.go +++ b/service/lightsail/api_op_DeleteDistribution.go @@ -29,8 +29,8 @@ func (c *Client) DeleteDistribution(ctx context.Context, params *DeleteDistribut type DeleteDistributionInput struct { - // The name of the distribution to delete. Use the GetDistributions action to get a - // list of distribution names that you can specify. + // The name of the distribution to delete. Use the GetDistributions action to get + // a list of distribution names that you can specify. DistributionName *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteDomain.go b/service/lightsail/api_op_DeleteDomain.go index f27135f17a8..0272bbc0817 100644 --- a/service/lightsail/api_op_DeleteDomain.go +++ b/service/lightsail/api_op_DeleteDomain.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified domain recordset and all of its domain records. The delete -// domain operation supports tag-based access control via resource tags applied to -// the resource identified by domain name. For more information, see the Amazon -// Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Deletes the specified domain recordset and all of its domain records. The +// delete domain operation supports tag-based access control via resource tags +// applied to the resource identified by domain name . For more information, see +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} diff --git a/service/lightsail/api_op_DeleteDomainEntry.go b/service/lightsail/api_op_DeleteDomainEntry.go index 362bfedb083..360c84b656f 100644 --- a/service/lightsail/api_op_DeleteDomainEntry.go +++ b/service/lightsail/api_op_DeleteDomainEntry.go @@ -13,8 +13,8 @@ import ( // Deletes a specific domain entry. The delete domain entry operation supports // tag-based access control via resource tags applied to the resource identified by -// domain name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// domain name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteDomainEntry(ctx context.Context, params *DeleteDomainEntryInput, optFns ...func(*Options)) (*DeleteDomainEntryOutput, error) { if params == nil { params = &DeleteDomainEntryInput{} diff --git a/service/lightsail/api_op_DeleteInstance.go b/service/lightsail/api_op_DeleteInstance.go index 42f9fb74a2e..eb6cca50fea 100644 --- a/service/lightsail/api_op_DeleteInstance.go +++ b/service/lightsail/api_op_DeleteInstance.go @@ -13,8 +13,8 @@ import ( // Deletes an Amazon Lightsail instance. The delete instance operation supports // tag-based access control via resource tags applied to the resource identified by -// instance name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// instance name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error) { if params == nil { params = &DeleteInstanceInput{} diff --git a/service/lightsail/api_op_DeleteInstanceSnapshot.go b/service/lightsail/api_op_DeleteInstanceSnapshot.go index 62c8c8aa444..0764bb950b3 100644 --- a/service/lightsail/api_op_DeleteInstanceSnapshot.go +++ b/service/lightsail/api_op_DeleteInstanceSnapshot.go @@ -13,9 +13,9 @@ import ( // Deletes a specific snapshot of a virtual private server (or instance). The // delete instance snapshot operation supports tag-based access control via -// resource tags applied to the resource identified by instance snapshot name. For -// more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource tags applied to the resource identified by instance snapshot name . For +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteInstanceSnapshot(ctx context.Context, params *DeleteInstanceSnapshotInput, optFns ...func(*Options)) (*DeleteInstanceSnapshotOutput, error) { if params == nil { params = &DeleteInstanceSnapshotInput{} diff --git a/service/lightsail/api_op_DeleteKeyPair.go b/service/lightsail/api_op_DeleteKeyPair.go index a7f12abbd97..d26cbc48386 100644 --- a/service/lightsail/api_op_DeleteKeyPair.go +++ b/service/lightsail/api_op_DeleteKeyPair.go @@ -11,19 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified key pair by removing the public key from Amazon Lightsail. -// You can delete key pairs that were created using the ImportKeyPair -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html) -// and CreateKeyPair -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html) +// Deletes the specified key pair by removing the public key from Amazon +// Lightsail. You can delete key pairs that were created using the ImportKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html) +// and CreateKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html) // actions, as well as the Lightsail default key pair. A new default key pair will // not be created unless you launch an instance without specifying a custom key -// pair, or you call the DownloadDefaultKeyPair -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) +// pair, or you call the DownloadDefaultKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) // API. The delete key pair operation supports tag-based access control via -// resource tags applied to the resource identified by key pair name. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource tags applied to the resource identified by key pair name . For more +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteKeyPair(ctx context.Context, params *DeleteKeyPairInput, optFns ...func(*Options)) (*DeleteKeyPairOutput, error) { if params == nil { params = &DeleteKeyPairInput{} diff --git a/service/lightsail/api_op_DeleteKnownHostKeys.go b/service/lightsail/api_op_DeleteKnownHostKeys.go index 7693ccddbf8..43625f7a3ae 100644 --- a/service/lightsail/api_op_DeleteKnownHostKeys.go +++ b/service/lightsail/api_op_DeleteKnownHostKeys.go @@ -18,8 +18,8 @@ import ( // expecting the host key or certificate mismatch or if you are familiar with the // new host key or certificate on the instance. For more information, see // Troubleshooting connection issues when using the Amazon Lightsail browser-based -// SSH or RDP client -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection). +// SSH or RDP client (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection) +// . func (c *Client) DeleteKnownHostKeys(ctx context.Context, params *DeleteKnownHostKeysInput, optFns ...func(*Options)) (*DeleteKnownHostKeysOutput, error) { if params == nil { params = &DeleteKnownHostKeysInput{} diff --git a/service/lightsail/api_op_DeleteLoadBalancer.go b/service/lightsail/api_op_DeleteLoadBalancer.go index 99b88445ba1..78ba6a0be55 100644 --- a/service/lightsail/api_op_DeleteLoadBalancer.go +++ b/service/lightsail/api_op_DeleteLoadBalancer.go @@ -15,9 +15,9 @@ import ( // Once the load balancer is deleted, you will need to create a new load balancer, // create a new certificate, and verify domain ownership again. The delete load // balancer operation supports tag-based access control via resource tags applied -// to the resource identified by load balancer name. For more information, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// to the resource identified by load balancer name . For more information, see the +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteLoadBalancer(ctx context.Context, params *DeleteLoadBalancerInput, optFns ...func(*Options)) (*DeleteLoadBalancerOutput, error) { if params == nil { params = &DeleteLoadBalancerInput{} diff --git a/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go b/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go index d63342ffece..01c4bfadbc5 100644 --- a/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go @@ -13,9 +13,9 @@ import ( // Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The // DeleteLoadBalancerTlsCertificate operation supports tag-based access control via -// resource tags applied to the resource identified by load balancer name. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource tags applied to the resource identified by load balancer name . For +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteLoadBalancerTlsCertificate(ctx context.Context, params *DeleteLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*DeleteLoadBalancerTlsCertificateOutput, error) { if params == nil { params = &DeleteLoadBalancerTlsCertificateInput{} @@ -43,7 +43,7 @@ type DeleteLoadBalancerTlsCertificateInput struct { // This member is required. LoadBalancerName *string - // When true, forces the deletion of an SSL/TLS certificate. There can be two + // When true , forces the deletion of an SSL/TLS certificate. There can be two // certificates associated with a Lightsail load balancer: the primary and the // backup. The force parameter is required when the primary SSL/TLS certificate is // in use by an instance attached to the load balancer. diff --git a/service/lightsail/api_op_DeleteRelationalDatabase.go b/service/lightsail/api_op_DeleteRelationalDatabase.go index c27eb6c8896..2b2cbe32774 100644 --- a/service/lightsail/api_op_DeleteRelationalDatabase.go +++ b/service/lightsail/api_op_DeleteRelationalDatabase.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a database in Amazon Lightsail. The delete relational database operation -// supports tag-based access control via resource tags applied to the resource -// identified by relationalDatabaseName. For more information, see the Amazon -// Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Deletes a database in Amazon Lightsail. The delete relational database +// operation supports tag-based access control via resource tags applied to the +// resource identified by relationalDatabaseName. For more information, see the +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteRelationalDatabase(ctx context.Context, params *DeleteRelationalDatabaseInput, optFns ...func(*Options)) (*DeleteRelationalDatabaseOutput, error) { if params == nil { params = &DeleteRelationalDatabaseInput{} @@ -38,22 +38,19 @@ type DeleteRelationalDatabaseInput struct { // This member is required. RelationalDatabaseName *string - // The name of the database snapshot created if skip final snapshot is false, which - // is the default value for that parameter. Specifying this parameter and also - // specifying the skip final snapshot parameter to true results in an error. + // The name of the database snapshot created if skip final snapshot is false , + // which is the default value for that parameter. Specifying this parameter and + // also specifying the skip final snapshot parameter to true results in an error. // Constraints: - // - // * Must contain from 2 to 255 alphanumeric characters, or - // hyphens. - // - // * The first and last character must be a letter or number. + // - Must contain from 2 to 255 alphanumeric characters, or hyphens. + // - The first and last character must be a letter or number. FinalRelationalDatabaseSnapshotName *string // Determines whether a final database snapshot is created before your database is // deleted. If true is specified, no database snapshot is created. If false is // specified, a database snapshot is created before your database is deleted. You // must specify the final relational database snapshot name parameter if the skip - // final snapshot parameter is false. Default: false + // final snapshot parameter is false . Default: false SkipFinalSnapshot *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go b/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go index f9eb752247e..a871045fd1f 100644 --- a/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go +++ b/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go @@ -14,8 +14,8 @@ import ( // Deletes a database snapshot in Amazon Lightsail. The delete relational database // snapshot operation supports tag-based access control via resource tags applied // to the resource identified by relationalDatabaseName. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DeleteRelationalDatabaseSnapshot(ctx context.Context, params *DeleteRelationalDatabaseSnapshotInput, optFns ...func(*Options)) (*DeleteRelationalDatabaseSnapshotOutput, error) { if params == nil { params = &DeleteRelationalDatabaseSnapshotInput{} diff --git a/service/lightsail/api_op_DetachCertificateFromDistribution.go b/service/lightsail/api_op_DetachCertificateFromDistribution.go index a56649bfbb4..d17b1052f3f 100644 --- a/service/lightsail/api_op_DetachCertificateFromDistribution.go +++ b/service/lightsail/api_op_DetachCertificateFromDistribution.go @@ -33,8 +33,7 @@ func (c *Client) DetachCertificateFromDistribution(ctx context.Context, params * type DetachCertificateFromDistributionInput struct { // The name of the distribution from which to detach the certificate. Use the - // GetDistributions action to get a list of distribution names that you can - // specify. + // GetDistributions action to get a list of distribution names that you can specify. // // This member is required. DistributionName *string diff --git a/service/lightsail/api_op_DetachDisk.go b/service/lightsail/api_op_DetachDisk.go index ab43703b94d..e635175817f 100644 --- a/service/lightsail/api_op_DetachDisk.go +++ b/service/lightsail/api_op_DetachDisk.go @@ -13,10 +13,11 @@ import ( // Detaches a stopped block storage disk from a Lightsail instance. Make sure to // unmount any file systems on the device within your operating system before -// stopping the instance and detaching the disk. The detach disk operation supports -// tag-based access control via resource tags applied to the resource identified by -// disk name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// stopping the instance and detaching the disk. The detach disk operation +// supports tag-based access control via resource tags applied to the resource +// identified by disk name . For more information, see the Amazon Lightsail +// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DetachDisk(ctx context.Context, params *DetachDiskInput, optFns ...func(*Options)) (*DetachDiskOutput, error) { if params == nil { params = &DetachDiskInput{} @@ -34,8 +35,8 @@ func (c *Client) DetachDisk(ctx context.Context, params *DetachDiskInput, optFns type DetachDiskInput struct { - // The unique name of the disk you want to detach from your instance (e.g., - // my-disk). + // The unique name of the disk you want to detach from your instance (e.g., my-disk + // ). // // This member is required. DiskName *string diff --git a/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go b/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go index e2a8472a5dd..ef7f0b0ca64 100644 --- a/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go +++ b/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go @@ -15,9 +15,9 @@ import ( // waits until the instances are no longer needed before they are detached from the // load balancer. The detach instances from load balancer operation supports // tag-based access control via resource tags applied to the resource identified by -// load balancer name. For more information, see the Amazon Lightsail Developer -// Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// load balancer name . For more information, see the Amazon Lightsail Developer +// Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) DetachInstancesFromLoadBalancer(ctx context.Context, params *DetachInstancesFromLoadBalancerInput, optFns ...func(*Options)) (*DetachInstancesFromLoadBalancerOutput, error) { if params == nil { params = &DetachInstancesFromLoadBalancerInput{} diff --git a/service/lightsail/api_op_DisableAddOn.go b/service/lightsail/api_op_DisableAddOn.go index 00cea303b4f..8d8fe6877a5 100644 --- a/service/lightsail/api_op_DisableAddOn.go +++ b/service/lightsail/api_op_DisableAddOn.go @@ -12,8 +12,8 @@ import ( ) // Disables an add-on for an Amazon Lightsail resource. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) +// . func (c *Client) DisableAddOn(ctx context.Context, params *DisableAddOnInput, optFns ...func(*Options)) (*DisableAddOnOutput, error) { if params == nil { params = &DisableAddOnInput{} diff --git a/service/lightsail/api_op_EnableAddOn.go b/service/lightsail/api_op_EnableAddOn.go index db2672b9154..9ed1946cf30 100644 --- a/service/lightsail/api_op_EnableAddOn.go +++ b/service/lightsail/api_op_EnableAddOn.go @@ -12,8 +12,8 @@ import ( ) // Enables or modifies an add-on for an Amazon Lightsail resource. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) +// . func (c *Client) EnableAddOn(ctx context.Context, params *EnableAddOnInput, optFns ...func(*Options)) (*EnableAddOnOutput, error) { if params == nil { params = &EnableAddOnInput{} diff --git a/service/lightsail/api_op_ExportSnapshot.go b/service/lightsail/api_op_ExportSnapshot.go index c26c02f5078..bebc3b3bf3d 100644 --- a/service/lightsail/api_op_ExportSnapshot.go +++ b/service/lightsail/api_op_ExportSnapshot.go @@ -20,11 +20,10 @@ import ( // in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon // Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export // snapshot operation supports tag-based access control via resource tags applied -// to the resource identified by source snapshot name. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). -// Use the get instance snapshots or get disk snapshots operations to get a list of -// snapshots that you can export to Amazon EC2. +// to the resource identified by source snapshot name . For more information, see +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . Use the get instance snapshots or get disk snapshots operations to get a list +// of snapshots that you can export to Amazon EC2. func (c *Client) ExportSnapshot(ctx context.Context, params *ExportSnapshotInput, optFns ...func(*Options)) (*ExportSnapshotOutput, error) { if params == nil { params = &ExportSnapshotInput{} diff --git a/service/lightsail/api_op_GetAlarms.go b/service/lightsail/api_op_GetAlarms.go index eb9fee8508b..749d85ad612 100644 --- a/service/lightsail/api_op_GetAlarms.go +++ b/service/lightsail/api_op_GetAlarms.go @@ -17,8 +17,8 @@ import ( // alarm is used to monitor a single metric for one of your resources. When a // metric condition is met, the alarm can notify you by email, SMS text message, // and a banner displayed on the Amazon Lightsail console. For more information, -// see Alarms in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). +// see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . func (c *Client) GetAlarms(ctx context.Context, params *GetAlarmsInput, optFns ...func(*Options)) (*GetAlarmsOutput, error) { if params == nil { params = &GetAlarmsInput{} @@ -46,9 +46,9 @@ type GetAlarmsInput struct { MonitoredResourceName *string // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetAlarms request. If your results are paginated, - // the response will return a next page token that you can specify as the page - // token in a subsequent request. + // page token, perform an initial GetAlarms request. If your results are + // paginated, the response will return a next page token that you can specify as + // the page token in a subsequent request. PageToken *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetAutoSnapshots.go b/service/lightsail/api_op_GetAutoSnapshots.go index d5dcbcf5cb3..866dec39536 100644 --- a/service/lightsail/api_op_GetAutoSnapshots.go +++ b/service/lightsail/api_op_GetAutoSnapshots.go @@ -12,8 +12,8 @@ import ( ) // Returns the available automatic snapshots for an instance or disk. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots). +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots) +// . func (c *Client) GetAutoSnapshots(ctx context.Context, params *GetAutoSnapshotsInput, optFns ...func(*Options)) (*GetAutoSnapshotsOutput, error) { if params == nil { params = &GetAutoSnapshotsInput{} @@ -42,14 +42,14 @@ type GetAutoSnapshotsInput struct { type GetAutoSnapshotsOutput struct { - // An array of objects that describe the automatic snapshots that are available for - // the specified source instance or disk. + // An array of objects that describe the automatic snapshots that are available + // for the specified source instance or disk. AutoSnapshots []types.AutoSnapshotDetails // The name of the source instance or disk for the automatic snapshots. ResourceName *string - // The resource type (e.g., Instance or Disk). + // The resource type (e.g., Instance or Disk ). ResourceType types.ResourceType // Metadata pertaining to the operation's result. diff --git a/service/lightsail/api_op_GetBlueprints.go b/service/lightsail/api_op_GetBlueprints.go index de2fefe9ef3..db75f31d583 100644 --- a/service/lightsail/api_op_GetBlueprints.go +++ b/service/lightsail/api_op_GetBlueprints.go @@ -61,8 +61,8 @@ type GetBlueprintsOutput struct { // The token to advance to the next page of results from your request. A next page // token is not returned if there are no more results to display. To get the next - // page of results, perform another GetBlueprints request and specify the next page - // token using the pageToken parameter. + // page of results, perform another GetBlueprints request and specify the next + // page token using the pageToken parameter. NextPageToken *string // Metadata pertaining to the operation's result. diff --git a/service/lightsail/api_op_GetBucketAccessKeys.go b/service/lightsail/api_op_GetBucketAccessKeys.go index b1c60ece8f6..e10b25929d4 100644 --- a/service/lightsail/api_op_GetBucketAccessKeys.go +++ b/service/lightsail/api_op_GetBucketAccessKeys.go @@ -14,8 +14,7 @@ import ( // Returns the existing access key IDs for the specified Amazon Lightsail bucket. // This action does not return the secret access key value of an access key. You // can get a secret access key only when you create it from the response of the -// CreateBucketAccessKey -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) +// CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) // action. If you lose the secret access key, you must create a new access key. func (c *Client) GetBucketAccessKeys(ctx context.Context, params *GetBucketAccessKeysInput, optFns ...func(*Options)) (*GetBucketAccessKeysOutput, error) { if params == nil { diff --git a/service/lightsail/api_op_GetBucketBundles.go b/service/lightsail/api_op_GetBucketBundles.go index 24d6f6a391d..7f6f82de11e 100644 --- a/service/lightsail/api_op_GetBucketBundles.go +++ b/service/lightsail/api_op_GetBucketBundles.go @@ -13,8 +13,7 @@ import ( // Returns the bundles that you can apply to a Amazon Lightsail bucket. The bucket // bundle specifies the monthly cost, storage quota, and data transfer quota for a -// bucket. Use the UpdateBucketBundle -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) +// bucket. Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) // action to update the bundle for a bucket. func (c *Client) GetBucketBundles(ctx context.Context, params *GetBucketBundlesInput, optFns ...func(*Options)) (*GetBucketBundlesOutput, error) { if params == nil { @@ -33,8 +32,8 @@ func (c *Client) GetBucketBundles(ctx context.Context, params *GetBucketBundlesI type GetBucketBundlesInput struct { - // A Boolean value that indicates whether to include inactive (unavailable) bundles - // in the response of your request. + // A Boolean value that indicates whether to include inactive (unavailable) + // bundles in the response of your request. IncludeInactive *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetBucketMetricData.go b/service/lightsail/api_op_GetBucketMetricData.go index 01d011e898f..30e4072c70b 100644 --- a/service/lightsail/api_op_GetBucketMetricData.go +++ b/service/lightsail/api_op_GetBucketMetricData.go @@ -47,25 +47,23 @@ type GetBucketMetricDataInput struct { // are listed below, along with the most useful statistics to include in your // request, and the published unit value. These bucket metrics are reported once // per day. - // - // * BucketSizeBytes - The amount of data in bytes stored in a bucket. - // This value is calculated by summing the size of all objects in the bucket - // (including object versions), including the size of all parts for all incomplete - // multipart uploads to the bucket. Statistics: The most useful statistic is - // Maximum. Unit: The published unit is Bytes. - // - // * NumberOfObjects - The total - // number of objects stored in a bucket. This value is calculated by counting all - // objects in the bucket (including object versions) and the total number of parts - // for all incomplete multipart uploads to the bucket. Statistics: The most useful - // statistic is Average. Unit: The published unit is Count. + // - BucketSizeBytes - The amount of data in bytes stored in a bucket. This value + // is calculated by summing the size of all objects in the bucket (including object + // versions), including the size of all parts for all incomplete multipart uploads + // to the bucket. Statistics: The most useful statistic is Maximum . Unit: The + // published unit is Bytes . + // - NumberOfObjects - The total number of objects stored in a bucket. This value + // is calculated by counting all objects in the bucket (including object versions) + // and the total number of parts for all incomplete multipart uploads to the + // bucket. Statistics: The most useful statistic is Average . Unit: The published + // unit is Count . // // This member is required. MetricName types.BucketMetricName - // The granularity, in seconds, of the returned data points. Bucket storage metrics - // are reported once per day. Therefore, you should specify a period of 86400 - // seconds, which is the number of seconds in a day. + // The granularity, in seconds, of the returned data points. Bucket storage + // metrics are reported once per day. Therefore, you should specify a period of + // 86400 seconds, which is the number of seconds in a day. // // This member is required. Period int32 @@ -76,27 +74,19 @@ type GetBucketMetricDataInput struct { StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - The sum of all values - // submitted for the matching metric. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - The sum of all values submitted for the matching metric. You can use + // this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can + // determine the full scope of a metric and how close the average use is to the + // Minimum and Maximum values. This comparison helps you to know when to increase + // or decrease your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_GetBuckets.go b/service/lightsail/api_op_GetBuckets.go index e277b31f323..9010565686c 100644 --- a/service/lightsail/api_op_GetBuckets.go +++ b/service/lightsail/api_op_GetBuckets.go @@ -14,8 +14,7 @@ import ( // Returns information about one or more Amazon Lightsail buckets. The information // returned includes the synchronization status of the Amazon Simple Storage // Service (Amazon S3) account-level block public access feature for your Lightsail -// buckets. For more information about buckets, see Buckets in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) +// buckets. For more information about buckets, see Buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) // in the Amazon Lightsail Developer Guide. func (c *Client) GetBuckets(ctx context.Context, params *GetBucketsInput, optFns ...func(*Options)) (*GetBucketsOutput, error) { if params == nil { @@ -40,8 +39,7 @@ type GetBucketsInput struct { BucketName *string // A Boolean value that indicates whether to include Lightsail instances that were - // given access to the bucket using the SetResourceAccessForBucket - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) + // given access to the bucket using the SetResourceAccessForBucket (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) // action. IncludeConnectedResources *bool @@ -59,8 +57,8 @@ type GetBucketsOutput struct { // An object that describes the synchronization status of the Amazon S3 // account-level block public access feature for your Lightsail buckets. For more // information about this feature and how it affects Lightsail buckets, see Block - // public access for buckets in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets). + // public access for buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets) + // . AccountLevelBpaSync *types.AccountLevelBpaSync // An array of objects that describe buckets. diff --git a/service/lightsail/api_op_GetBundles.go b/service/lightsail/api_op_GetBundles.go index a87d6f2bcfe..f58858dbcdc 100644 --- a/service/lightsail/api_op_GetBundles.go +++ b/service/lightsail/api_op_GetBundles.go @@ -37,8 +37,8 @@ type GetBundlesInput struct { // use this parameter to view Lightsail for Research bundles. AppCategory types.AppCategory - // A Boolean value that indicates whether to include inactive (unavailable) bundles - // in the response of your request. + // A Boolean value that indicates whether to include inactive (unavailable) + // bundles in the response of your request. IncludeInactive *bool // The token to advance to the next page of results from your request. To get a diff --git a/service/lightsail/api_op_GetContactMethods.go b/service/lightsail/api_op_GetContactMethods.go index f86375627b6..431a8bc31ce 100644 --- a/service/lightsail/api_op_GetContactMethods.go +++ b/service/lightsail/api_op_GetContactMethods.go @@ -17,8 +17,8 @@ import ( // You can add one email address and one mobile phone number contact method in each // Amazon Web Services Region. However, SMS text messaging is not supported in some // Amazon Web Services Regions, and SMS text messages cannot be sent to some -// countries/regions. For more information, see Notifications in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) +// . func (c *Client) GetContactMethods(ctx context.Context, params *GetContactMethodsInput, optFns ...func(*Options)) (*GetContactMethodsOutput, error) { if params == nil { params = &GetContactMethodsInput{} @@ -36,7 +36,7 @@ func (c *Client) GetContactMethods(ctx context.Context, params *GetContactMethod type GetContactMethodsInput struct { - // The protocols used to send notifications, such as Email, or SMS (text + // The protocols used to send notifications, such as Email , or SMS (text // messaging). Specify a protocol in your request to return information about a // specific contact method protocol. Protocols []types.ContactProtocol diff --git a/service/lightsail/api_op_GetContainerLog.go b/service/lightsail/api_op_GetContainerLog.go index b9ff51f1d7c..7d2af7a7fe8 100644 --- a/service/lightsail/api_op_GetContainerLog.go +++ b/service/lightsail/api_op_GetContainerLog.go @@ -48,38 +48,24 @@ type GetContainerLogInput struct { ServiceName *string // The end of the time interval for which to get log data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 9 PM - // UTC, specify 1538427600 as the end time. - // - // You can convert a human-friendly time - // to Unix time format using a converter like Epoch converter - // (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use an end + // time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . EndTime *time.Time // The pattern to use to filter the returned log events to a specific term. The // following are a few examples of filter patterns that you can specify: - // - // * To - // return all log events, specify a filter pattern of "". - // - // * To exclude log events - // that contain the ERROR term, and return all other log events, specify a filter - // pattern of "-ERROR". - // - // * To return log events that contain the ERROR term, - // specify a filter pattern of "ERROR". - // - // * To return log events that contain both - // the ERROR and Exception terms, specify a filter pattern of "ERROR Exception". - // - // * - // To return log events that contain the ERROR or the Exception term, specify a - // filter pattern of "?ERROR ?Exception". + // - To return all log events, specify a filter pattern of "" . + // - To exclude log events that contain the ERROR term, and return all other log + // events, specify a filter pattern of "-ERROR" . + // - To return log events that contain the ERROR term, specify a filter pattern + // of "ERROR" . + // - To return log events that contain both the ERROR and Exception terms, + // specify a filter pattern of "ERROR Exception" . + // - To return log events that contain the ERROR or the Exception term, specify a + // filter pattern of "?ERROR ?Exception" . FilterPattern *string // The token to advance to the next page of results from your request. To get a @@ -89,17 +75,11 @@ type GetContainerLogInput struct { PageToken *string // The start of the time interval for which to get log data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, specify 1538424000 as the start time. - // - // You can convert a human-friendly - // time to Unix time format using a converter like Epoch converter - // (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a start + // time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . StartTime *time.Time noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetContainerServiceDeployments.go b/service/lightsail/api_op_GetContainerServiceDeployments.go index 85d52eafcce..7679f4ab9c9 100644 --- a/service/lightsail/api_op_GetContainerServiceDeployments.go +++ b/service/lightsail/api_op_GetContainerServiceDeployments.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the deployments for your Amazon Lightsail container service A deployment -// specifies the settings, such as the ports and launch command, of containers that -// are deployed to your container service. The deployments are ordered by version -// in ascending order. The newest version is listed at the top of the response. A -// set number of deployments are kept before the oldest one is replaced with the -// newest one. For more information, see Amazon Lightsail endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the Amazon Web -// Services General Reference. +// Returns the deployments for your Amazon Lightsail container service A +// deployment specifies the settings, such as the ports and launch command, of +// containers that are deployed to your container service. The deployments are +// ordered by version in ascending order. The newest version is listed at the top +// of the response. A set number of deployments are kept before the oldest one is +// replaced with the newest one. For more information, see Amazon Lightsail +// endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) +// in the Amazon Web Services General Reference. func (c *Client) GetContainerServiceDeployments(ctx context.Context, params *GetContainerServiceDeploymentsInput, optFns ...func(*Options)) (*GetContainerServiceDeploymentsOutput, error) { if params == nil { params = &GetContainerServiceDeploymentsInput{} diff --git a/service/lightsail/api_op_GetContainerServiceMetricData.go b/service/lightsail/api_op_GetContainerServiceMetricData.go index 9d37f0b9969..eadeccf0b00 100644 --- a/service/lightsail/api_op_GetContainerServiceMetricData.go +++ b/service/lightsail/api_op_GetContainerServiceMetricData.go @@ -41,19 +41,16 @@ type GetContainerServiceMetricDataInput struct { // The metric for which you want to return information. Valid container service // metric names are listed below, along with the most useful statistics to include // in your request, and the published unit value. - // - // * CPUUtilization - The average - // percentage of compute units that are currently in use across all nodes of the - // container service. This metric identifies the processing power required to run - // containers on each node of the container service. Statistics: The most useful - // statistics are Maximum and Average. Unit: The published unit is Percent. - // - // * - // MemoryUtilization - The average percentage of available memory that is currently - // in use across all nodes of the container service. This metric identifies the - // memory required to run containers on each node of the container service. - // Statistics: The most useful statistics are Maximum and Average. Unit: The - // published unit is Percent. + // - CPUUtilization - The average percentage of compute units that are currently + // in use across all nodes of the container service. This metric identifies the + // processing power required to run containers on each node of the container + // service. Statistics: The most useful statistics are Maximum and Average . + // Unit: The published unit is Percent . + // - MemoryUtilization - The average percentage of available memory that is + // currently in use across all nodes of the container service. This metric + // identifies the memory required to run containers on each node of the container + // service. Statistics: The most useful statistics are Maximum and Average . + // Unit: The published unit is Percent . // // This member is required. MetricName types.ContainerServiceMetricName @@ -75,27 +72,19 @@ type GetContainerServiceMetricDataInput struct { StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - All values submitted for the - // matching metric added together. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can + // determine the full scope of a metric and how close the average use is to the + // Minimum and Maximum values. This comparison helps you to know when to increase + // or decrease your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_GetContainerServices.go b/service/lightsail/api_op_GetContainerServices.go index 839667f8c5f..6654fc24cfa 100644 --- a/service/lightsail/api_op_GetContainerServices.go +++ b/service/lightsail/api_op_GetContainerServices.go @@ -30,9 +30,9 @@ func (c *Client) GetContainerServices(ctx context.Context, params *GetContainerS type GetContainerServicesInput struct { - // The name of the container service for which to return information. When omitted, - // the response includes all of your container services in the Amazon Web Services - // Region where the request is made. + // The name of the container service for which to return information. When + // omitted, the response includes all of your container services in the Amazon Web + // Services Region where the request is made. ServiceName *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetCostEstimate.go b/service/lightsail/api_op_GetCostEstimate.go index 9f4dfc82591..5734d559e73 100644 --- a/service/lightsail/api_op_GetCostEstimate.go +++ b/service/lightsail/api_op_GetCostEstimate.go @@ -32,16 +32,11 @@ func (c *Client) GetCostEstimate(ctx context.Context, params *GetCostEstimateInp type GetCostEstimateInput struct { // The cost estimate end time. Constraints: - // - // * Specified in Coordinated Universal - // Time (UTC). - // - // * Specified in the Unix time format. For example, if you wish to - // use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end - // time. - // - // You can convert a human-friendly time to Unix time format using a - // converter like Epoch converter (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use an end + // time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . // // This member is required. EndTime *time.Time @@ -52,16 +47,11 @@ type GetCostEstimateInput struct { ResourceName *string // The cost estimate start time. Constraints: - // - // * Specified in Coordinated Universal - // Time (UTC). - // - // * Specified in the Unix time format. For example, if you wish to - // use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the - // start time. - // - // You can convert a human-friendly time to Unix time format using a - // converter like Epoch converter (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a start + // time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . // // This member is required. StartTime *time.Time diff --git a/service/lightsail/api_op_GetDisk.go b/service/lightsail/api_op_GetDisk.go index 6b27ef78b4c..61e4afe1265 100644 --- a/service/lightsail/api_op_GetDisk.go +++ b/service/lightsail/api_op_GetDisk.go @@ -29,7 +29,7 @@ func (c *Client) GetDisk(ctx context.Context, params *GetDiskInput, optFns ...fu type GetDiskInput struct { - // The name of the disk (e.g., my-disk). + // The name of the disk (e.g., my-disk ). // // This member is required. DiskName *string diff --git a/service/lightsail/api_op_GetDiskSnapshot.go b/service/lightsail/api_op_GetDiskSnapshot.go index 177daebe4b4..e1a16aa391f 100644 --- a/service/lightsail/api_op_GetDiskSnapshot.go +++ b/service/lightsail/api_op_GetDiskSnapshot.go @@ -29,7 +29,7 @@ func (c *Client) GetDiskSnapshot(ctx context.Context, params *GetDiskSnapshotInp type GetDiskSnapshotInput struct { - // The name of the disk snapshot (e.g., my-disk-snapshot). + // The name of the disk snapshot (e.g., my-disk-snapshot ). // // This member is required. DiskSnapshotName *string diff --git a/service/lightsail/api_op_GetDistributionLatestCacheReset.go b/service/lightsail/api_op_GetDistributionLatestCacheReset.go index 0fa4a13bf66..bb7dc0f3370 100644 --- a/service/lightsail/api_op_GetDistributionLatestCacheReset.go +++ b/service/lightsail/api_op_GetDistributionLatestCacheReset.go @@ -30,10 +30,10 @@ func (c *Client) GetDistributionLatestCacheReset(ctx context.Context, params *Ge type GetDistributionLatestCacheResetInput struct { - // The name of the distribution for which to return the timestamp of the last cache - // reset. Use the GetDistributions action to get a list of distribution names that - // you can specify. When omitted, the response includes the latest cache reset - // timestamp of all your distributions. + // The name of the distribution for which to return the timestamp of the last + // cache reset. Use the GetDistributions action to get a list of distribution + // names that you can specify. When omitted, the response includes the latest cache + // reset timestamp of all your distributions. DistributionName *string noSmithyDocumentSerde @@ -41,7 +41,7 @@ type GetDistributionLatestCacheResetInput struct { type GetDistributionLatestCacheResetOutput struct { - // The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format. + // The timestamp of the last cache reset (e.g., 1479734909.17 ) in Unix time format. CreateTime *time.Time // The status of the last cache reset. diff --git a/service/lightsail/api_op_GetDistributionMetricData.go b/service/lightsail/api_op_GetDistributionMetricData.go index 1434a710c14..c201739b355 100644 --- a/service/lightsail/api_op_GetDistributionMetricData.go +++ b/service/lightsail/api_op_GetDistributionMetricData.go @@ -35,63 +35,47 @@ func (c *Client) GetDistributionMetricData(ctx context.Context, params *GetDistr type GetDistributionMetricDataInput struct { // The name of the distribution for which to get metric data. Use the - // GetDistributions action to get a list of distribution names that you can - // specify. + // GetDistributions action to get a list of distribution names that you can specify. // // This member is required. DistributionName *string // The end of the time interval for which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 9 PM - // UTC, specify 1538427600 as the end time. - // - // You can convert a human-friendly time - // to Unix time format using a converter like Epoch converter - // (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use an end + // time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . // // This member is required. EndTime *time.Time // The metric for which you want to return information. Valid distribution metric - // names are listed below, along with the most useful statistics to include in your - // request, and the published unit value. - // - // * Requests - The total number of viewer - // requests received by your Lightsail distribution, for all HTTP methods, and for - // both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. - // Unit: The published unit is None. - // - // * BytesDownloaded - The number of bytes - // downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most - // useful statistic is Sum. Unit: The published unit is None. - // - // * BytesUploaded - - // The number of bytes uploaded to your origin by your Lightsail distribution, - // using POST and PUT requests. Statistics: The most useful statistic is Sum. Unit: - // The published unit is None. - // - // * TotalErrorRate - The percentage of all viewer - // requests for which the response's HTTP status code was 4xx or 5xx. Statistics: - // The most useful statistic is Average. Unit: The published unit is Percent. - // - // * - // 4xxErrorRate - The percentage of all viewer requests for which the response's - // HTTP status cod was 4xx. In these cases, the client or client viewer may have - // made an error. For example, a status code of 404 (Not Found) means that the - // client requested an object that could not be found. Statistics: The most useful - // statistic is Average. Unit: The published unit is Percent. - // - // * 5xxErrorRate - The - // percentage of all viewer requests for which the response's HTTP status code was - // 5xx. In these cases, the origin server did not satisfy the requests. For - // example, a status code of 503 (Service Unavailable) means that the origin server - // is currently unavailable. Statistics: The most useful statistic is Average. - // Unit: The published unit is Percent. + // names are listed below, along with the most useful statistics to include in + // your request, and the published unit value. + // - Requests - The total number of viewer requests received by your Lightsail + // distribution, for all HTTP methods, and for both HTTP and HTTPS requests. + // Statistics : The most useful statistic is Sum . Unit : The published unit is + // None . + // - BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, + // and OPTIONS requests. Statistics : The most useful statistic is Sum . Unit : + // The published unit is None . + // - BytesUploaded - The number of bytes uploaded to your origin by your + // Lightsail distribution, using POST and PUT requests. Statistics : The most + // useful statistic is Sum . Unit : The published unit is None . + // - TotalErrorRate - The percentage of all viewer requests for which the + // response's HTTP status code was 4xx or 5xx. Statistics : The most useful + // statistic is Average . Unit : The published unit is Percent . + // - 4xxErrorRate - The percentage of all viewer requests for which the + // response's HTTP status cod was 4xx. In these cases, the client or client viewer + // may have made an error. For example, a status code of 404 (Not Found) means that + // the client requested an object that could not be found. Statistics : The most + // useful statistic is Average . Unit : The published unit is Percent . + // - 5xxErrorRate - The percentage of all viewer requests for which the + // response's HTTP status code was 5xx. In these cases, the origin server did not + // satisfy the requests. For example, a status code of 503 (Service Unavailable) + // means that the origin server is currently unavailable. Statistics : The most + // useful statistic is Average . Unit : The published unit is Percent . // // This member is required. MetricName types.DistributionMetricName @@ -102,43 +86,29 @@ type GetDistributionMetricDataInput struct { Period int32 // The start of the time interval for which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, specify 1538424000 as the start time. - // - // You can convert a human-friendly - // time to Unix time format using a converter like Epoch converter - // (https://www.epochconverter.com/). + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a start + // time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. + // You can convert a human-friendly time to Unix time format using a converter + // like Epoch converter (https://www.epochconverter.com/) . // // This member is required. StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - All values submitted for the - // matching metric added together. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can determine + // the full scope of a metric and how close the average use is to the Minimum and + // Maximum values. This comparison helps you to know when to increase or decrease + // your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_GetExportSnapshotRecords.go b/service/lightsail/api_op_GetExportSnapshotRecords.go index c010171c796..94b7785bdc0 100644 --- a/service/lightsail/api_op_GetExportSnapshotRecords.go +++ b/service/lightsail/api_op_GetExportSnapshotRecords.go @@ -13,8 +13,7 @@ import ( // Returns all export snapshot records created as a result of the export snapshot // operation. An export snapshot record can be used to create a new Amazon EC2 -// instance and its related resources with the CreateCloudFormationStack -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html) +// instance and its related resources with the CreateCloudFormationStack (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html) // action. func (c *Client) GetExportSnapshotRecords(ctx context.Context, params *GetExportSnapshotRecordsInput, optFns ...func(*Options)) (*GetExportSnapshotRecordsOutput, error) { if params == nil { @@ -34,9 +33,9 @@ func (c *Client) GetExportSnapshotRecords(ctx context.Context, params *GetExport type GetExportSnapshotRecordsInput struct { // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetExportSnapshotRecords request. If your results - // are paginated, the response will return a next page token that you can specify - // as the page token in a subsequent request. + // page token, perform an initial GetExportSnapshotRecords request. If your + // results are paginated, the response will return a next page token that you can + // specify as the page token in a subsequent request. PageToken *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetInstanceAccessDetails.go b/service/lightsail/api_op_GetInstanceAccessDetails.go index 394160743b0..85534dab236 100644 --- a/service/lightsail/api_op_GetInstanceAccessDetails.go +++ b/service/lightsail/api_op_GetInstanceAccessDetails.go @@ -14,8 +14,8 @@ import ( // Returns temporary SSH keys you can use to connect to a specific virtual private // server, or instance. The get instance access details operation supports // tag-based access control via resource tags applied to the resource identified by -// instance name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// instance name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) GetInstanceAccessDetails(ctx context.Context, params *GetInstanceAccessDetailsInput, optFns ...func(*Options)) (*GetInstanceAccessDetailsOutput, error) { if params == nil { params = &GetInstanceAccessDetailsInput{} @@ -38,7 +38,7 @@ type GetInstanceAccessDetailsInput struct { // This member is required. InstanceName *string - // The protocol to use to connect to your instance. Defaults to ssh. + // The protocol to use to connect to your instance. Defaults to ssh . Protocol types.InstanceAccessProtocol noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetInstanceMetricData.go b/service/lightsail/api_op_GetInstanceMetricData.go index 5c720ca093e..4b4d3dbbbec 100644 --- a/service/lightsail/api_op_GetInstanceMetricData.go +++ b/service/lightsail/api_op_GetInstanceMetricData.go @@ -43,89 +43,74 @@ type GetInstanceMetricDataInput struct { // This member is required. InstanceName *string - // The metric for which you want to return information. Valid instance metric names - // are listed below, along with the most useful statistics to include in your - // request, and the published unit value. - // - // * BurstCapacityPercentage - The - // percentage of CPU performance available for your instance to burst above its - // baseline. Your instance continuously accrues and consumes burst capacity. Burst - // capacity stops accruing when your instance's BurstCapacityPercentage reaches - // 100%. For more information, see Viewing instance burst capacity in Amazon - // Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity). - // Statistics: The most useful statistics are Maximum and Average. Unit: The - // published unit is Percent. - // - // * BurstCapacityTime - The available amount of time - // for your instance to burst at 100% CPU utilization. Your instance continuously - // accrues and consumes burst capacity. Burst capacity time stops accruing when - // your instance's BurstCapacityPercentage metric reaches 100%. Burst capacity time - // is consumed at the full rate only when your instance operates at 100% CPU - // utilization. For example, if your instance operates at 50% CPU utilization in - // the burstable zone for a 5-minute period, then it consumes CPU burst capacity - // minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 - // seconds of CPU burst capacity minutes in the 5-minute period. For more - // information, see Viewing instance burst capacity in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity). - // Statistics: The most useful statistics are Maximum and Average. Unit: The - // published unit is Seconds. - // - // * CPUUtilization - The percentage of allocated - // compute units that are currently in use on the instance. This metric identifies - // the processing power to run the applications on the instance. Tools in your - // operating system can show a lower percentage than Lightsail when the instance is - // not allocated a full processor core. Statistics: The most useful statistics are - // Maximum and Average. Unit: The published unit is Percent. - // - // * NetworkIn - The - // number of bytes received on all network interfaces by the instance. This metric - // identifies the volume of incoming network traffic to the instance. The number - // reported is the number of bytes received during the period. Because this metric - // is reported in 5-minute intervals, divide the reported number by 300 to find - // Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published - // unit is Bytes. - // - // * NetworkOut - The number of bytes sent out on all network - // interfaces by the instance. This metric identifies the volume of outgoing - // network traffic from the instance. The number reported is the number of bytes - // sent during the period. Because this metric is reported in 5-minute intervals, - // divide the reported number by 300 to find Bytes/second. Statistics: The most - // useful statistic is Sum. Unit: The published unit is Bytes. - // - // * StatusCheckFailed - // - Reports whether the instance passed or failed both the instance status check - // and the system status check. This metric can be either 0 (passed) or 1 (failed). - // This metric data is available in 1-minute (60 seconds) granularity. Statistics: - // The most useful statistic is Sum. Unit: The published unit is Count. - // - // * - // StatusCheckFailed_Instance - Reports whether the instance passed or failed the - // instance status check. This metric can be either 0 (passed) or 1 (failed). This - // metric data is available in 1-minute (60 seconds) granularity. Statistics: The - // most useful statistic is Sum. Unit: The published unit is Count. - // - // * - // StatusCheckFailed_System - Reports whether the instance passed or failed the - // system status check. This metric can be either 0 (passed) or 1 (failed). This - // metric data is available in 1-minute (60 seconds) granularity. Statistics: The - // most useful statistic is Sum. Unit: The published unit is Count. - // - // * - // MetadataNoToken - Reports the number of times that the instance metadata service - // was successfully accessed without a token. This metric determines if there are - // any processes accessing instance metadata by using Instance Metadata Service - // Version 1, which doesn't use a token. If all requests use token-backed sessions, - // such as Instance Metadata Service Version 2, then the value is 0. Statistics: - // The most useful statistic is Sum. Unit: The published unit is Count. + // The metric for which you want to return information. Valid instance metric + // names are listed below, along with the most useful statistics to include in + // your request, and the published unit value. + // - BurstCapacityPercentage - The percentage of CPU performance available for + // your instance to burst above its baseline. Your instance continuously accrues + // and consumes burst capacity. Burst capacity stops accruing when your instance's + // BurstCapacityPercentage reaches 100%. For more information, see Viewing + // instance burst capacity in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity) + // . Statistics : The most useful statistics are Maximum and Average . Unit : The + // published unit is Percent . + // - BurstCapacityTime - The available amount of time for your instance to burst + // at 100% CPU utilization. Your instance continuously accrues and consumes burst + // capacity. Burst capacity time stops accruing when your instance's + // BurstCapacityPercentage metric reaches 100%. Burst capacity time is consumed + // at the full rate only when your instance operates at 100% CPU utilization. For + // example, if your instance operates at 50% CPU utilization in the burstable zone + // for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate + // in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst + // capacity minutes in the 5-minute period. For more information, see Viewing + // instance burst capacity in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity) + // . Statistics : The most useful statistics are Maximum and Average . Unit : The + // published unit is Seconds . + // - CPUUtilization - The percentage of allocated compute units that are + // currently in use on the instance. This metric identifies the processing power to + // run the applications on the instance. Tools in your operating system can show a + // lower percentage than Lightsail when the instance is not allocated a full + // processor core. Statistics : The most useful statistics are Maximum and + // Average . Unit : The published unit is Percent . + // - NetworkIn - The number of bytes received on all network interfaces by the + // instance. This metric identifies the volume of incoming network traffic to the + // instance. The number reported is the number of bytes received during the period. + // Because this metric is reported in 5-minute intervals, divide the reported + // number by 300 to find Bytes/second. Statistics : The most useful statistic is + // Sum . Unit : The published unit is Bytes . + // - NetworkOut - The number of bytes sent out on all network interfaces by the + // instance. This metric identifies the volume of outgoing network traffic from the + // instance. The number reported is the number of bytes sent during the period. + // Because this metric is reported in 5-minute intervals, divide the reported + // number by 300 to find Bytes/second. Statistics : The most useful statistic is + // Sum . Unit : The published unit is Bytes . + // - StatusCheckFailed - Reports whether the instance passed or failed both the + // instance status check and the system status check. This metric can be either 0 + // (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) + // granularity. Statistics : The most useful statistic is Sum . Unit : The + // published unit is Count . + // - StatusCheckFailed_Instance - Reports whether the instance passed or failed + // the instance status check. This metric can be either 0 (passed) or 1 (failed). + // This metric data is available in 1-minute (60 seconds) granularity. Statistics + // : The most useful statistic is Sum . Unit : The published unit is Count . + // - StatusCheckFailed_System - Reports whether the instance passed or failed the + // system status check. This metric can be either 0 (passed) or 1 (failed). This + // metric data is available in 1-minute (60 seconds) granularity. Statistics : + // The most useful statistic is Sum . Unit : The published unit is Count . + // - MetadataNoToken - Reports the number of times that the instance metadata + // service was successfully accessed without a token. This metric determines if + // there are any processes accessing instance metadata by using Instance Metadata + // Service Version 1, which doesn't use a token. If all requests use token-backed + // sessions, such as Instance Metadata Service Version 2, then the value is 0. + // Statistics : The most useful statistic is Sum . Unit : The published unit is + // Count . // // This member is required. MetricName types.InstanceMetricName - // The granularity, in seconds, of the returned data points. The StatusCheckFailed, - // StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is - // available in 1-minute (60 seconds) granularity. All other instance metric data - // is available in 5-minute (300 seconds) granularity. + // The granularity, in seconds, of the returned data points. The StatusCheckFailed + // , StatusCheckFailed_Instance , and StatusCheckFailed_System instance metric + // data is available in 1-minute (60 seconds) granularity. All other instance + // metric data is available in 5-minute (300 seconds) granularity. // // This member is required. Period int32 @@ -136,27 +121,19 @@ type GetInstanceMetricDataInput struct { StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - All values submitted for the - // matching metric added together. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can determine + // the full scope of a metric and how close the average use is to the Minimum and + // Maximum values. This comparison helps you to know when to increase or decrease + // your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_GetInstanceSnapshot.go b/service/lightsail/api_op_GetInstanceSnapshot.go index ec657ab947e..93046b97e93 100644 --- a/service/lightsail/api_op_GetInstanceSnapshot.go +++ b/service/lightsail/api_op_GetInstanceSnapshot.go @@ -39,8 +39,8 @@ type GetInstanceSnapshotInput struct { type GetInstanceSnapshotOutput struct { - // An array of key-value pairs containing information about the results of your get - // instance snapshot request. + // An array of key-value pairs containing information about the results of your + // get instance snapshot request. InstanceSnapshot *types.InstanceSnapshot // Metadata pertaining to the operation's result. diff --git a/service/lightsail/api_op_GetInstanceSnapshots.go b/service/lightsail/api_op_GetInstanceSnapshots.go index db0c916093f..418d73654e1 100644 --- a/service/lightsail/api_op_GetInstanceSnapshots.go +++ b/service/lightsail/api_op_GetInstanceSnapshots.go @@ -30,9 +30,9 @@ func (c *Client) GetInstanceSnapshots(ctx context.Context, params *GetInstanceSn type GetInstanceSnapshotsInput struct { // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetInstanceSnapshots request. If your results are - // paginated, the response will return a next page token that you can specify as - // the page token in a subsequent request. + // page token, perform an initial GetInstanceSnapshots request. If your results + // are paginated, the response will return a next page token that you can specify + // as the page token in a subsequent request. PageToken *string noSmithyDocumentSerde @@ -40,8 +40,8 @@ type GetInstanceSnapshotsInput struct { type GetInstanceSnapshotsOutput struct { - // An array of key-value pairs containing information about the results of your get - // instance snapshots request. + // An array of key-value pairs containing information about the results of your + // get instance snapshots request. InstanceSnapshots []types.InstanceSnapshot // The token to advance to the next page of results from your request. A next page diff --git a/service/lightsail/api_op_GetLoadBalancerMetricData.go b/service/lightsail/api_op_GetLoadBalancerMetricData.go index a4907dba325..0b013dda607 100644 --- a/service/lightsail/api_op_GetLoadBalancerMetricData.go +++ b/service/lightsail/api_op_GetLoadBalancerMetricData.go @@ -44,80 +44,65 @@ type GetLoadBalancerMetricDataInput struct { LoadBalancerName *string // The metric for which you want to return information. Valid load balancer metric - // names are listed below, along with the most useful statistics to include in your - // request, and the published unit value. - // - // * ClientTLSNegotiationErrorCount - The - // number of TLS connections initiated by the client that did not establish a - // session with the load balancer due to a TLS error generated by the load - // balancer. Possible causes include a mismatch of ciphers or protocols. - // Statistics: The most useful statistic is Sum. Unit: The published unit is - // Count. - // - // * HealthyHostCount - The number of target instances that are considered - // healthy. Statistics: The most useful statistic are Average, Minimum, and - // Maximum. Unit: The published unit is Count. - // - // * HTTPCode_Instance_2XX_Count - The - // number of HTTP 2XX response codes generated by the target instances. This does - // not include any response codes generated by the load balancer. Statistics: The - // most useful statistic is Sum. Note that Minimum, Maximum, and Average all return - // 1. Unit: The published unit is Count. - // - // * HTTPCode_Instance_3XX_Count - The - // number of HTTP 3XX response codes generated by the target instances. This does - // not include any response codes generated by the load balancer. Statistics: The - // most useful statistic is Sum. Note that Minimum, Maximum, and Average all return - // 1. Unit: The published unit is Count. - // - // * HTTPCode_Instance_4XX_Count - The - // number of HTTP 4XX response codes generated by the target instances. This does - // not include any response codes generated by the load balancer. Statistics: The - // most useful statistic is Sum. Note that Minimum, Maximum, and Average all return - // 1. Unit: The published unit is Count. - // - // * HTTPCode_Instance_5XX_Count - The - // number of HTTP 5XX response codes generated by the target instances. This does - // not include any response codes generated by the load balancer. Statistics: The - // most useful statistic is Sum. Note that Minimum, Maximum, and Average all return - // 1. Unit: The published unit is Count. - // - // * HTTPCode_LB_4XX_Count - The number of - // HTTP 4XX client error codes that originated from the load balancer. Client - // errors are generated when requests are malformed or incomplete. These requests - // were not received by the target instance. This count does not include response - // codes generated by the target instances. Statistics: The most useful statistic - // is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The - // published unit is Count. - // - // * HTTPCode_LB_5XX_Count - The number of HTTP 5XX - // server error codes that originated from the load balancer. This does not include - // any response codes generated by the target instance. This metric is reported if - // there are no healthy instances attached to the load balancer, or if the request - // rate exceeds the capacity of the instances (spillover) or the load balancer. - // Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and - // Average all return 1. Unit: The published unit is Count. - // - // * InstanceResponseTime - // - The time elapsed, in seconds, after the request leaves the load balancer until - // a response from the target instance is received. Statistics: The most useful - // statistic is Average. Unit: The published unit is Seconds. - // - // * - // RejectedConnectionCount - The number of connections that were rejected because - // the load balancer had reached its maximum number of connections. Statistics: The - // most useful statistic is Sum. Unit: The published unit is Count. - // - // * RequestCount - // - The number of requests processed over IPv4. This count includes only the - // requests with a response generated by a target instance of the load balancer. - // Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and - // Average all return 1. Unit: The published unit is Count. - // - // * UnhealthyHostCount - - // The number of target instances that are considered unhealthy. Statistics: The - // most useful statistic are Average, Minimum, and Maximum. Unit: The published - // unit is Count. + // names are listed below, along with the most useful statistics to include in + // your request, and the published unit value. + // - ClientTLSNegotiationErrorCount - The number of TLS connections initiated by + // the client that did not establish a session with the load balancer due to a TLS + // error generated by the load balancer. Possible causes include a mismatch of + // ciphers or protocols. Statistics : The most useful statistic is Sum . Unit : + // The published unit is Count . + // - HealthyHostCount - The number of target instances that are considered + // healthy. Statistics : The most useful statistic are Average , Minimum , and + // Maximum . Unit : The published unit is Count . + // - HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes + // generated by the target instances. This does not include any response codes + // generated by the load balancer. Statistics : The most useful statistic is Sum + // . Note that Minimum , Maximum , and Average all return 1 . Unit : The + // published unit is Count . + // - HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes + // generated by the target instances. This does not include any response codes + // generated by the load balancer. Statistics : The most useful statistic is Sum + // . Note that Minimum , Maximum , and Average all return 1 . Unit : The + // published unit is Count . + // - HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes + // generated by the target instances. This does not include any response codes + // generated by the load balancer. Statistics : The most useful statistic is Sum + // . Note that Minimum , Maximum , and Average all return 1 . Unit : The + // published unit is Count . + // - HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes + // generated by the target instances. This does not include any response codes + // generated by the load balancer. Statistics : The most useful statistic is Sum + // . Note that Minimum , Maximum , and Average all return 1 . Unit : The + // published unit is Count . + // - HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that + // originated from the load balancer. Client errors are generated when requests are + // malformed or incomplete. These requests were not received by the target + // instance. This count does not include response codes generated by the target + // instances. Statistics : The most useful statistic is Sum . Note that Minimum , + // Maximum , and Average all return 1 . Unit : The published unit is Count . + // - HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that + // originated from the load balancer. This does not include any response codes + // generated by the target instance. This metric is reported if there are no + // healthy instances attached to the load balancer, or if the request rate exceeds + // the capacity of the instances (spillover) or the load balancer. Statistics : + // The most useful statistic is Sum . Note that Minimum , Maximum , and Average + // all return 1 . Unit : The published unit is Count . + // - InstanceResponseTime - The time elapsed, in seconds, after the request + // leaves the load balancer until a response from the target instance is received. + // Statistics : The most useful statistic is Average . Unit : The published unit + // is Seconds . + // - RejectedConnectionCount - The number of connections that were rejected + // because the load balancer had reached its maximum number of connections. + // Statistics : The most useful statistic is Sum . Unit : The published unit is + // Count . + // - RequestCount - The number of requests processed over IPv4. This count + // includes only the requests with a response generated by a target instance of the + // load balancer. Statistics : The most useful statistic is Sum . Note that + // Minimum , Maximum , and Average all return 1 . Unit : The published unit is + // Count . + // - UnhealthyHostCount - The number of target instances that are considered + // unhealthy. Statistics : The most useful statistic are Average , Minimum , and + // Maximum . Unit : The published unit is Count . // // This member is required. MetricName types.LoadBalancerMetricName @@ -133,27 +118,19 @@ type GetLoadBalancerMetricDataInput struct { StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - All values submitted for the - // matching metric added together. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can determine + // the full scope of a metric and how close the average use is to the Minimum and + // Maximum values. This comparison helps you to know when to increase or decrease + // your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go b/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go index 08f4e8d54fe..6b8ef921d09 100644 --- a/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go +++ b/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go @@ -13,8 +13,7 @@ import ( // Returns a list of TLS security policies that you can apply to Lightsail load // balancers. For more information about load balancer TLS security policies, see -// Configuring TLS security policies on your Amazon Lightsail load balancers -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) +// Configuring TLS security policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) // in the Amazon Lightsail Developer Guide. func (c *Client) GetLoadBalancerTlsPolicies(ctx context.Context, params *GetLoadBalancerTlsPoliciesInput, optFns ...func(*Options)) (*GetLoadBalancerTlsPoliciesOutput, error) { if params == nil { diff --git a/service/lightsail/api_op_GetOperations.go b/service/lightsail/api_op_GetOperations.go index a910ae7a0ab..77d9b60acf9 100644 --- a/service/lightsail/api_op_GetOperations.go +++ b/service/lightsail/api_op_GetOperations.go @@ -45,8 +45,8 @@ type GetOperationsOutput struct { // The token to advance to the next page of results from your request. A next page // token is not returned if there are no more results to display. To get the next - // page of results, perform another GetOperations request and specify the next page - // token using the pageToken parameter. + // page of results, perform another GetOperations request and specify the next + // page token using the pageToken parameter. NextPageToken *string // An array of objects that describe the result of the action, such as the status diff --git a/service/lightsail/api_op_GetOperationsForResource.go b/service/lightsail/api_op_GetOperationsForResource.go index 4aacbc1fa7d..e034fc26e8f 100644 --- a/service/lightsail/api_op_GetOperationsForResource.go +++ b/service/lightsail/api_op_GetOperationsForResource.go @@ -35,9 +35,9 @@ type GetOperationsForResourceInput struct { ResourceName *string // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetOperationsForResource request. If your results - // are paginated, the response will return a next page token that you can specify - // as the page token in a subsequent request. + // page token, perform an initial GetOperationsForResource request. If your + // results are paginated, the response will return a next page token that you can + // specify as the page token in a subsequent request. PageToken *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetRegions.go b/service/lightsail/api_op_GetRegions.go index ef84780d77d..66163291643 100644 --- a/service/lightsail/api_op_GetRegions.go +++ b/service/lightsail/api_op_GetRegions.go @@ -32,12 +32,12 @@ type GetRegionsInput struct { // A Boolean value indicating whether to also include Availability Zones in your // get regions request. Availability Zones are indicated with a letter: e.g., - // us-east-2a. + // us-east-2a . IncludeAvailabilityZones *bool // A Boolean value indicating whether to also include Availability Zones for // databases in your get regions request. Availability Zones are indicated with a - // letter (e.g., us-east-2a). + // letter (e.g., us-east-2a ). IncludeRelationalDatabaseAvailabilityZones *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go b/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go index 58233f23fa1..b76dd270d2f 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go +++ b/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of available database blueprints in Amazon Lightsail. A blueprint -// describes the major engine version of a database. You can use a blueprint ID to -// create a new database that runs a specific database engine. +// Returns a list of available database blueprints in Amazon Lightsail. A +// blueprint describes the major engine version of a database. You can use a +// blueprint ID to create a new database that runs a specific database engine. func (c *Client) GetRelationalDatabaseBlueprints(ctx context.Context, params *GetRelationalDatabaseBlueprintsInput, optFns ...func(*Options)) (*GetRelationalDatabaseBlueprintsOutput, error) { if params == nil { params = &GetRelationalDatabaseBlueprintsInput{} diff --git a/service/lightsail/api_op_GetRelationalDatabaseBundles.go b/service/lightsail/api_op_GetRelationalDatabaseBundles.go index a1df0c8bd30..aa044f5dfe7 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseBundles.go +++ b/service/lightsail/api_op_GetRelationalDatabaseBundles.go @@ -31,8 +31,8 @@ func (c *Client) GetRelationalDatabaseBundles(ctx context.Context, params *GetRe type GetRelationalDatabaseBundlesInput struct { - // A Boolean value that indicates whether to include inactive (unavailable) bundles - // in the response of your request. + // A Boolean value that indicates whether to include inactive (unavailable) + // bundles in the response of your request. IncludeInactive *bool // The token to advance to the next page of results from your request. To get a diff --git a/service/lightsail/api_op_GetRelationalDatabaseEvents.go b/service/lightsail/api_op_GetRelationalDatabaseEvents.go index 90ffd348f4c..074f3e36d1d 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseEvents.go @@ -34,9 +34,9 @@ type GetRelationalDatabaseEventsInput struct { // This member is required. RelationalDatabaseName *string - // The number of minutes in the past from which to retrieve events. For example, to - // get all events from the past 2 hours, enter 120. Default: 60 The minimum is 1 - // and the maximum is 14 days (20160 minutes). + // The number of minutes in the past from which to retrieve events. For example, + // to get all events from the past 2 hours, enter 120. Default: 60 The minimum is + // 1 and the maximum is 14 days (20160 minutes). DurationInMinutes *int32 // The token to advance to the next page of results from your request. To get a @@ -52,8 +52,8 @@ type GetRelationalDatabaseEventsOutput struct { // The token to advance to the next page of results from your request. A next page // token is not returned if there are no more results to display. To get the next - // page of results, perform another GetRelationalDatabaseEvents request and specify - // the next page token using the pageToken parameter. + // page of results, perform another GetRelationalDatabaseEvents request and + // specify the next page token using the pageToken parameter. NextPageToken *string // An object describing the result of your get relational database events request. diff --git a/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go b/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go index 3d2fb3e57a0..d2fbab7ef33 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go @@ -42,13 +42,10 @@ type GetRelationalDatabaseLogEventsInput struct { RelationalDatabaseName *string // The end of the time interval from which to get log events. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the end time. + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use an end + // time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end + // time. EndTime *time.Time // The token to advance to the next or previous page of results from your request. @@ -59,19 +56,16 @@ type GetRelationalDatabaseLogEventsInput struct { PageToken *string // Parameter to specify if the log should start from head or tail. If true is - // specified, the log event starts from the head of the log. If false is specified, - // the log event starts from the tail of the log. For PostgreSQL, the default value - // of false is the only option available. + // specified, the log event starts from the head of the log. If false is + // specified, the log event starts from the tail of the log. For PostgreSQL, the + // default value of false is the only option available. StartFromHead *bool // The start of the time interval from which to get log events. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the start time. + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a start + // time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start + // time. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go b/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go index a0bf54cabe1..51acc73c294 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go @@ -40,8 +40,8 @@ type GetRelationalDatabaseMasterUserPasswordInput struct { // The password version to return. Specifying CURRENT or PREVIOUS returns the // current or previous passwords respectively. Specifying PENDING returns the - // newest version of the password that will rotate to CURRENT. After the PENDING - // password rotates to CURRENT, the PENDING password is no longer available. + // newest version of the password that will rotate to CURRENT . After the PENDING + // password rotates to CURRENT , the PENDING password is no longer available. // Default: CURRENT PasswordVersion types.RelationalDatabasePasswordVersion diff --git a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go index e4e1460c5e0..c9d056bae60 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go @@ -34,13 +34,10 @@ func (c *Client) GetRelationalDatabaseMetricData(ctx context.Context, params *Ge type GetRelationalDatabaseMetricDataInput struct { // The end of the time interval from which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use an end time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the end time. + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use an end + // time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end + // time. // // This member is required. EndTime *time.Time @@ -49,34 +46,25 @@ type GetRelationalDatabaseMetricDataInput struct { // metric names are listed below, along with the most useful statistics to include // in your request, and the published unit value. All relational database metric // data is available in 1-minute (60 seconds) granularity. - // - // * CPUUtilization - The - // percentage of CPU utilization currently in use on the database. Statistics: The - // most useful statistics are Maximum and Average. Unit: The published unit is - // Percent. - // - // * DatabaseConnections - The number of database connections in use. - // Statistics: The most useful statistics are Maximum and Sum. Unit: The published - // unit is Count. - // - // * DiskQueueDepth - The number of outstanding IOs (read/write - // requests) that are waiting to access the disk. Statistics: The most useful - // statistic is Sum. Unit: The published unit is Count. - // - // * FreeStorageSpace - The - // amount of available storage space. Statistics: The most useful statistic is Sum. - // Unit: The published unit is Bytes. - // - // * NetworkReceiveThroughput - The incoming - // (Receive) network traffic on the database, including both customer database - // traffic and AWS traffic used for monitoring and replication. Statistics: The - // most useful statistic is Average. Unit: The published unit is Bytes/Second. - // - // * - // NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the - // database, including both customer database traffic and AWS traffic used for - // monitoring and replication. Statistics: The most useful statistic is Average. - // Unit: The published unit is Bytes/Second. + // - CPUUtilization - The percentage of CPU utilization currently in use on the + // database. Statistics : The most useful statistics are Maximum and Average . + // Unit : The published unit is Percent . + // - DatabaseConnections - The number of database connections in use. Statistics + // : The most useful statistics are Maximum and Sum . Unit : The published unit + // is Count . + // - DiskQueueDepth - The number of outstanding IOs (read/write requests) that + // are waiting to access the disk. Statistics : The most useful statistic is Sum + // . Unit : The published unit is Count . + // - FreeStorageSpace - The amount of available storage space. Statistics : The + // most useful statistic is Sum . Unit : The published unit is Bytes . + // - NetworkReceiveThroughput - The incoming (Receive) network traffic on the + // database, including both customer database traffic and AWS traffic used for + // monitoring and replication. Statistics : The most useful statistic is Average + // . Unit : The published unit is Bytes/Second . + // - NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the + // database, including both customer database traffic and AWS traffic used for + // monitoring and replication. Statistics : The most useful statistic is Average + // . Unit : The published unit is Bytes/Second . // // This member is required. MetricName types.RelationalDatabaseMetricName @@ -93,39 +81,28 @@ type GetRelationalDatabaseMetricDataInput struct { RelationalDatabaseName *string // The start of the time interval from which to get metric data. Constraints: - // - // * - // Specified in Coordinated Universal Time (UTC). - // - // * Specified in the Unix time - // format. For example, if you wish to use a start time of October 1, 2018, at 8 PM - // UTC, then you input 1538424000 as the start time. + // - Specified in Coordinated Universal Time (UTC). + // - Specified in the Unix time format. For example, if you wish to use a start + // time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start + // time. // // This member is required. StartTime *time.Time // The statistic for the metric. The following statistics are available: - // - // * Minimum - // - The lowest value observed during the specified period. Use this value to - // determine low volumes of activity for your application. - // - // * Maximum - The highest - // value observed during the specified period. Use this value to determine high - // volumes of activity for your application. - // - // * Sum - All values submitted for the - // matching metric added together. You can use this statistic to determine the - // total volume of a metric. - // - // * Average - The value of Sum / SampleCount during the - // specified period. By comparing this statistic with the Minimum and Maximum - // values, you can determine the full scope of a metric and how close the average - // use is to the Minimum and Maximum values. This comparison helps you to know when - // to increase or decrease your resources. - // - // * SampleCount - The count, or number, - // of data points used for the statistical calculation. + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can determine + // the full scope of a metric and how close the average use is to the Minimum and + // Maximum values. This comparison helps you to know when to increase or decrease + // your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. // // This member is required. Statistics []types.MetricStatistic diff --git a/service/lightsail/api_op_IsVpcPeered.go b/service/lightsail/api_op_IsVpcPeered.go index a298b644528..c0b4c577fa0 100644 --- a/service/lightsail/api_op_IsVpcPeered.go +++ b/service/lightsail/api_op_IsVpcPeered.go @@ -32,7 +32,7 @@ type IsVpcPeeredInput struct { type IsVpcPeeredOutput struct { - // Returns true if the Lightsail VPC is peered; otherwise, false. + // Returns true if the Lightsail VPC is peered; otherwise, false . IsPeered *bool // Metadata pertaining to the operation's result. diff --git a/service/lightsail/api_op_OpenInstancePublicPorts.go b/service/lightsail/api_op_OpenInstancePublicPorts.go index 485cba91415..f6a6c13a538 100644 --- a/service/lightsail/api_op_OpenInstancePublicPorts.go +++ b/service/lightsail/api_op_OpenInstancePublicPorts.go @@ -14,9 +14,9 @@ import ( // Opens ports for a specific Amazon Lightsail instance, and specifies the IP // addresses allowed to connect to the instance through the ports, and the // protocol. The OpenInstancePublicPorts action supports tag-based access control -// via resource tags applied to the resource identified by instanceName. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// via resource tags applied to the resource identified by instanceName . For more +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) OpenInstancePublicPorts(ctx context.Context, params *OpenInstancePublicPortsInput, optFns ...func(*Options)) (*OpenInstancePublicPortsOutput, error) { if params == nil { params = &OpenInstancePublicPortsInput{} diff --git a/service/lightsail/api_op_PutAlarm.go b/service/lightsail/api_op_PutAlarm.go index 6e34b8899be..d951668bb05 100644 --- a/service/lightsail/api_op_PutAlarm.go +++ b/service/lightsail/api_op_PutAlarm.go @@ -15,10 +15,9 @@ import ( // alarm is used to monitor a single metric for one of your resources. When a // metric condition is met, the alarm can notify you by email, SMS text message, // and a banner displayed on the Amazon Lightsail console. For more information, -// see Alarms in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). -// When this action creates an alarm, the alarm state is immediately set to -// INSUFFICIENT_DATA. The alarm is then evaluated and its state is set +// see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . When this action creates an alarm, the alarm state is immediately set to +// INSUFFICIENT_DATA . The alarm is then evaluated and its state is set // appropriately. Any actions associated with the new state are then executed. When // you update an existing alarm, its state is left unchanged, but the update // completely overwrites the previous configuration of the alarm. The alarm is then @@ -53,8 +52,8 @@ type PutAlarmInput struct { ComparisonOperator types.ComparisonOperator // The number of most recent periods over which data is compared to the specified - // threshold. If you are setting an "M out of N" alarm, this value - // (evaluationPeriods) is the N. If you are setting an alarm that requires that a + // threshold. If you are setting an "M out of N" alarm, this value ( + // evaluationPeriods ) is the N. If you are setting an alarm that requires that a // number of consecutive data points be breaching to trigger the alarm, this value // specifies the rolling period of time in which data points are evaluated. Each // evaluation period is five minutes long. For example, specify an evaluation @@ -66,26 +65,20 @@ type PutAlarmInput struct { EvaluationPeriods *int32 // The name of the metric to associate with the alarm. You can configure up to two - // alarms per metric. The following metrics are available for each resource - // type: - // - // * Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, - // NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and - // StatusCheckFailed_System. - // - // * Load balancers: ClientTLSNegotiationErrorCount, - // HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, - // HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, - // HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, - // RejectedConnectionCount, and RequestCount. - // - // * Relational databases: - // CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, - // NetworkReceiveThroughput, and NetworkTransmitThroughput. - // - // For more information - // about these metrics, see Metrics available in Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics). + // alarms per metric. The following metrics are available for each resource type: + // - Instances: BurstCapacityPercentage , BurstCapacityTime , CPUUtilization , + // NetworkIn , NetworkOut , StatusCheckFailed , StatusCheckFailed_Instance , and + // StatusCheckFailed_System . + // - Load balancers: ClientTLSNegotiationErrorCount , HealthyHostCount , + // UnhealthyHostCount , HTTPCode_LB_4XX_Count , HTTPCode_LB_5XX_Count , + // HTTPCode_Instance_2XX_Count , HTTPCode_Instance_3XX_Count , + // HTTPCode_Instance_4XX_Count , HTTPCode_Instance_5XX_Count , + // InstanceResponseTime , RejectedConnectionCount , and RequestCount . + // - Relational databases: CPUUtilization , DatabaseConnections , DiskQueueDepth + // , FreeStorageSpace , NetworkReceiveThroughput , and NetworkTransmitThroughput + // . + // For more information about these metrics, see Metrics available in Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics) + // . // // This member is required. MetricName types.MetricName @@ -102,19 +95,19 @@ type PutAlarmInput struct { // This member is required. Threshold *float64 - // The contact protocols to use for the alarm, such as Email, SMS (text messaging), - // or both. A notification is sent via the specified contact protocol if - // notifications are enabled for the alarm, and when the alarm is triggered. A + // The contact protocols to use for the alarm, such as Email , SMS (text + // messaging), or both. A notification is sent via the specified contact protocol + // if notifications are enabled for the alarm, and when the alarm is triggered. A // notification is not sent if a contact protocol is not specified, if the // specified contact protocol is not configured in the Amazon Web Services Region, // or if notifications are not enabled for the alarm using the notificationEnabled - // paramater. Use the CreateContactMethod action to configure a contact protocol in - // an Amazon Web Services Region. + // paramater. Use the CreateContactMethod action to configure a contact protocol + // in an Amazon Web Services Region. ContactProtocols []types.ContactProtocol // The number of data points that must be not within the specified threshold to - // trigger the alarm. If you are setting an "M out of N" alarm, this value - // (datapointsToAlarm) is the M. + // trigger the alarm. If you are setting an "M out of N" alarm, this value ( + // datapointsToAlarm ) is the M. DatapointsToAlarm *int32 // Indicates whether the alarm is enabled. Notifications are enabled by default if @@ -123,51 +116,32 @@ type PutAlarmInput struct { // The alarm states that trigger a notification. An alarm has the following // possible states: - // - // * ALARM - The metric is outside of the defined threshold. - // - // * - // INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or - // not enough data is available for the metric to determine the alarm state. - // - // * OK - // - The metric is within the defined threshold. - // - // When you specify a notification - // trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states - // can be specified in addition to the ALARM state. - // - // * If you specify OK as an - // alarm trigger, a notification is sent when the alarm switches from an ALARM or - // INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all - // clear alarm notification. - // - // * If you specify INSUFFICIENT_DATA as the alarm - // trigger, a notification is sent when the alarm switches from an OK or ALARM - // alarm state to an INSUFFICIENT_DATA state. - // - // The notification trigger defaults to - // ALARM if you don't specify this parameter. + // - ALARM - The metric is outside of the defined threshold. + // - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, + // or not enough data is available for the metric to determine the alarm state. + // - OK - The metric is within the defined threshold. + // When you specify a notification trigger, the ALARM state must be specified. The + // INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM + // state. + // - If you specify OK as an alarm trigger, a notification is sent when the alarm + // switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This + // can be thought of as an all clear alarm notification. + // - If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is + // sent when the alarm switches from an OK or ALARM alarm state to an + // INSUFFICIENT_DATA state. + // The notification trigger defaults to ALARM if you don't specify this parameter. NotificationTriggers []types.AlarmState // Sets how this alarm will handle missing data points. An alarm can treat missing // data in the following ways: - // - // * breaching - Assume the missing data is not within - // the threshold. Missing data counts towards the number of times the metric is not - // within the threshold. - // - // * notBreaching - Assume the missing data is within the - // threshold. Missing data does not count towards the number of times the metric is - // not within the threshold. - // - // * ignore - Ignore the missing data. Maintains the - // current alarm state. - // - // * missing - Missing data is treated as missing. - // - // If - // treatMissingData is not specified, the default behavior of missing is used. + // - breaching - Assume the missing data is not within the threshold. Missing + // data counts towards the number of times the metric is not within the threshold. + // - notBreaching - Assume the missing data is within the threshold. Missing data + // does not count towards the number of times the metric is not within the + // threshold. + // - ignore - Ignore the missing data. Maintains the current alarm state. + // - missing - Missing data is treated as missing. + // If treatMissingData is not specified, the default behavior of missing is used. TreatMissingData types.TreatMissingData noSmithyDocumentSerde diff --git a/service/lightsail/api_op_PutInstancePublicPorts.go b/service/lightsail/api_op_PutInstancePublicPorts.go index 3ad2c3b0f94..e4515a92654 100644 --- a/service/lightsail/api_op_PutInstancePublicPorts.go +++ b/service/lightsail/api_op_PutInstancePublicPorts.go @@ -15,12 +15,12 @@ import ( // addresses allowed to connect to the instance through the ports, and the // protocol. This action also closes all currently open ports that are not included // in the request. Include all of the ports and the protocols you want to open in -// your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to -// open ports without closing currently open ports. The PutInstancePublicPorts +// your PutInstancePublicPorts request. Or use the OpenInstancePublicPorts action +// to open ports without closing currently open ports. The PutInstancePublicPorts // action supports tag-based access control via resource tags applied to the -// resource identified by instanceName. For more information, see the Amazon -// Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource identified by instanceName . For more information, see the Amazon +// Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) PutInstancePublicPorts(ctx context.Context, params *PutInstancePublicPortsInput, optFns ...func(*Options)) (*PutInstancePublicPortsOutput, error) { if params == nil { params = &PutInstancePublicPortsInput{} diff --git a/service/lightsail/api_op_RebootInstance.go b/service/lightsail/api_op_RebootInstance.go index ed93a5f6104..16c14254af2 100644 --- a/service/lightsail/api_op_RebootInstance.go +++ b/service/lightsail/api_op_RebootInstance.go @@ -13,8 +13,8 @@ import ( // Restarts a specific instance. The reboot instance operation supports tag-based // access control via resource tags applied to the resource identified by instance -// name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// name . For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) RebootInstance(ctx context.Context, params *RebootInstanceInput, optFns ...func(*Options)) (*RebootInstanceOutput, error) { if params == nil { params = &RebootInstanceInput{} diff --git a/service/lightsail/api_op_RebootRelationalDatabase.go b/service/lightsail/api_op_RebootRelationalDatabase.go index 325d3ac35df..77787613dc0 100644 --- a/service/lightsail/api_op_RebootRelationalDatabase.go +++ b/service/lightsail/api_op_RebootRelationalDatabase.go @@ -14,8 +14,8 @@ import ( // Restarts a specific database in Amazon Lightsail. The reboot relational database // operation supports tag-based access control via resource tags applied to the // resource identified by relationalDatabaseName. For more information, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) RebootRelationalDatabase(ctx context.Context, params *RebootRelationalDatabaseInput, optFns ...func(*Options)) (*RebootRelationalDatabaseOutput, error) { if params == nil { params = &RebootRelationalDatabaseInput{} diff --git a/service/lightsail/api_op_RegisterContainerImage.go b/service/lightsail/api_op_RegisterContainerImage.go index 6efbe8b8c0f..5b4968bff7f 100644 --- a/service/lightsail/api_op_RegisterContainerImage.go +++ b/service/lightsail/api_op_RegisterContainerImage.go @@ -14,9 +14,8 @@ import ( // Registers a container image to your Amazon Lightsail container service. This // action is not required if you install and use the Lightsail Control // (lightsailctl) plugin to push container images to your Lightsail container -// service. For more information, see Pushing and managing container images on your -// Amazon Lightsail container services -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) +// service. For more information, see Pushing and managing container images on +// your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) // in the Amazon Lightsail Developer Guide. func (c *Client) RegisterContainerImage(ctx context.Context, params *RegisterContainerImageInput, optFns ...func(*Options)) (*RegisterContainerImageOutput, error) { if params == nil { @@ -40,23 +39,20 @@ type RegisterContainerImageInput struct { // This member is required. Digest *string - // The label for the container image when it's registered to the container service. - // Use a descriptive label that you can use to track the different versions of your - // registered container images. Use the GetContainerImages action to return the - // container images registered to a Lightsail container service. The label is the - // portion of the following image name example: - // - // * :container-service-1..1 - // - // If the - // name of your container service is mycontainerservice, and the label that you - // specify is mystaticwebsite, then the name of the registered container image will - // be :mycontainerservice.mystaticwebsite.1. The number at the end of these image - // name examples represents the version of the registered container image. If you - // push and register another container image to the same Lightsail container + // The label for the container image when it's registered to the container + // service. Use a descriptive label that you can use to track the different + // versions of your registered container images. Use the GetContainerImages action + // to return the container images registered to a Lightsail container service. The + // label is the portion of the following image name example: + // - :container-service-1..1 + // If the name of your container service is mycontainerservice , and the label that + // you specify is mystaticwebsite , then the name of the registered container image + // will be :mycontainerservice.mystaticwebsite.1 . The number at the end of these + // image name examples represents the version of the registered container image. If + // you push and register another container image to the same Lightsail container // service, with the same label, then the version number for the new registered - // container image will be 2. If you push and register another container image, the - // version number will be 3, and so on. + // container image will be 2 . If you push and register another container image, + // the version number will be 3 , and so on. // // This member is required. Label *string diff --git a/service/lightsail/api_op_ResetDistributionCache.go b/service/lightsail/api_op_ResetDistributionCache.go index da915fee13f..32e44269e67 100644 --- a/service/lightsail/api_op_ResetDistributionCache.go +++ b/service/lightsail/api_op_ResetDistributionCache.go @@ -41,7 +41,7 @@ type ResetDistributionCacheInput struct { type ResetDistributionCacheOutput struct { - // The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time + // The timestamp of the reset cache request (e.g., 1479734909.17 ) in Unix time // format. CreateTime *time.Time diff --git a/service/lightsail/api_op_SendContactMethodVerification.go b/service/lightsail/api_op_SendContactMethodVerification.go index aea9719dd26..1f9d1bf32eb 100644 --- a/service/lightsail/api_op_SendContactMethodVerification.go +++ b/service/lightsail/api_op_SendContactMethodVerification.go @@ -17,9 +17,8 @@ import ( // add one email address and one mobile phone number contact method in each Amazon // Web Services Region. However, SMS text messaging is not supported in some Amazon // Web Services Regions, and SMS text messages cannot be sent to some -// countries/regions. For more information, see Notifications in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). -// A verification request is sent to the contact method when you initially create +// countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) +// . A verification request is sent to the contact method when you initially create // it. Use this action to send another verification request if a previous // verification request was deleted, or has expired. Notifications are not sent to // an email contact method until after it is verified, and confirmed as valid. diff --git a/service/lightsail/api_op_SetIpAddressType.go b/service/lightsail/api_op_SetIpAddressType.go index 25a9c77a09f..7d4b6307a99 100644 --- a/service/lightsail/api_op_SetIpAddressType.go +++ b/service/lightsail/api_op_SetIpAddressType.go @@ -43,9 +43,9 @@ type SetIpAddressTypeInput struct { // This member is required. ResourceName *string - // The resource type. The possible values are Distribution, Instance, and - // LoadBalancer. Distribution-related APIs are available only in the N. Virginia - // (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region + // The resource type. The possible values are Distribution , Instance , and + // LoadBalancer . Distribution-related APIs are available only in the N. Virginia ( + // us-east-1 ) Amazon Web Services Region. Set your Amazon Web Services Region // configuration to us-east-1 to create, view, or edit distributions. // // This member is required. diff --git a/service/lightsail/api_op_SetResourceAccessForBucket.go b/service/lightsail/api_op_SetResourceAccessForBucket.go index 730eb484ae9..a33cc85a707 100644 --- a/service/lightsail/api_op_SetResourceAccessForBucket.go +++ b/service/lightsail/api_op_SetResourceAccessForBucket.go @@ -32,13 +32,9 @@ func (c *Client) SetResourceAccessForBucket(ctx context.Context, params *SetReso type SetResourceAccessForBucketInput struct { // The access setting. The following access settings are available: - // - // * allow - - // Allows access to the bucket and its objects. - // - // * deny - Denies access to the - // bucket and its objects. Use this setting to remove access for a resource - // previously set to allow. + // - allow - Allows access to the bucket and its objects. + // - deny - Denies access to the bucket and its objects. Use this setting to + // remove access for a resource previously set to allow . // // This member is required. Access types.ResourceBucketAccess diff --git a/service/lightsail/api_op_StartInstance.go b/service/lightsail/api_op_StartInstance.go index 2e29ae3514d..68aa46d8bff 100644 --- a/service/lightsail/api_op_StartInstance.go +++ b/service/lightsail/api_op_StartInstance.go @@ -16,12 +16,11 @@ import ( // Lightsail assigns a new public IP address to the instance. To use the same IP // address after stopping and starting an instance, create a static IP address and // attach it to the instance. For more information, see the Amazon Lightsail -// Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip). -// The start instance operation supports tag-based access control via resource tags -// applied to the resource identified by instance name. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip) +// . The start instance operation supports tag-based access control via resource +// tags applied to the resource identified by instance name . For more information, +// see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) StartInstance(ctx context.Context, params *StartInstanceInput, optFns ...func(*Options)) (*StartInstanceOutput, error) { if params == nil { params = &StartInstanceInput{} diff --git a/service/lightsail/api_op_StartRelationalDatabase.go b/service/lightsail/api_op_StartRelationalDatabase.go index 28eaa73b4e0..54f4ff2fb36 100644 --- a/service/lightsail/api_op_StartRelationalDatabase.go +++ b/service/lightsail/api_op_StartRelationalDatabase.go @@ -15,8 +15,8 @@ import ( // a database, use the reboot relational database operation. The start relational // database operation supports tag-based access control via resource tags applied // to the resource identified by relationalDatabaseName. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) StartRelationalDatabase(ctx context.Context, params *StartRelationalDatabaseInput, optFns ...func(*Options)) (*StartRelationalDatabaseOutput, error) { if params == nil { params = &StartRelationalDatabaseInput{} diff --git a/service/lightsail/api_op_StopInstance.go b/service/lightsail/api_op_StopInstance.go index 0a018588cf4..8dc5ccf7146 100644 --- a/service/lightsail/api_op_StopInstance.go +++ b/service/lightsail/api_op_StopInstance.go @@ -15,12 +15,11 @@ import ( // start a stopped instance, Lightsail assigns a new public IP address to the // instance. To use the same IP address after stopping and starting an instance, // create a static IP address and attach it to the instance. For more information, -// see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip). -// The stop instance operation supports tag-based access control via resource tags -// applied to the resource identified by instance name. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip) +// . The stop instance operation supports tag-based access control via resource +// tags applied to the resource identified by instance name . For more information, +// see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) StopInstance(ctx context.Context, params *StopInstanceInput, optFns ...func(*Options)) (*StopInstanceOutput, error) { if params == nil { params = &StopInstanceInput{} @@ -43,10 +42,10 @@ type StopInstanceInput struct { // This member is required. InstanceName *string - // When set to True, forces a Lightsail instance that is stuck in a stopping state - // to stop. Only use the force parameter if your instance is stuck in the stopping - // state. In any other state, your instance should stop normally without adding - // this parameter to your API request. + // When set to True , forces a Lightsail instance that is stuck in a stopping + // state to stop. Only use the force parameter if your instance is stuck in the + // stopping state. In any other state, your instance should stop normally without + // adding this parameter to your API request. Force *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_StopRelationalDatabase.go b/service/lightsail/api_op_StopRelationalDatabase.go index 018b3c040cc..6fa0f3a340c 100644 --- a/service/lightsail/api_op_StopRelationalDatabase.go +++ b/service/lightsail/api_op_StopRelationalDatabase.go @@ -14,8 +14,8 @@ import ( // Stops a specific database that is currently running in Amazon Lightsail. The // stop relational database operation supports tag-based access control via // resource tags applied to the resource identified by relationalDatabaseName. For -// more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) StopRelationalDatabase(ctx context.Context, params *StopRelationalDatabaseInput, optFns ...func(*Options)) (*StopRelationalDatabaseOutput, error) { if params == nil { params = &StopRelationalDatabaseInput{} diff --git a/service/lightsail/api_op_TagResource.go b/service/lightsail/api_op_TagResource.go index 26483792ca2..286f9aaa69a 100644 --- a/service/lightsail/api_op_TagResource.go +++ b/service/lightsail/api_op_TagResource.go @@ -14,12 +14,11 @@ import ( // Adds one or more tags to the specified Amazon Lightsail resource. Each resource // can have a maximum of 50 tags. Each tag consists of a key and an optional value. // Tag keys must be unique per resource. For more information about tags, see the -// Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). -// The tag resource operation supports tag-based access control via request tags -// and resource tags applied to the resource identified by resource name. For more -// information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) +// . The tag resource operation supports tag-based access control via request tags +// and resource tags applied to the resource identified by resource name . For more +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/lightsail/api_op_TestAlarm.go b/service/lightsail/api_op_TestAlarm.go index ef83c6ff73c..a3ef61165be 100644 --- a/service/lightsail/api_op_TestAlarm.go +++ b/service/lightsail/api_op_TestAlarm.go @@ -13,12 +13,12 @@ import ( // Tests an alarm by displaying a banner on the Amazon Lightsail console. If a // notification trigger is configured for the specified alarm, the test also sends -// a notification to the notification protocol (Email and/or SMS) configured for +// a notification to the notification protocol ( Email and/or SMS ) configured for // the alarm. An alarm is used to monitor a single metric for one of your // resources. When a metric condition is met, the alarm can notify you by email, // SMS text message, and a banner displayed on the Amazon Lightsail console. For -// more information, see Alarms in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). +// more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . func (c *Client) TestAlarm(ctx context.Context, params *TestAlarmInput, optFns ...func(*Options)) (*TestAlarmOutput, error) { if params == nil { params = &TestAlarmInput{} @@ -43,15 +43,10 @@ type TestAlarmInput struct { // The alarm state to test. An alarm has the following possible states that can be // tested: - // - // * ALARM - The metric is outside of the defined threshold. - // - // * - // INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or - // not enough data is available for the metric to determine the alarm state. - // - // * OK - // - The metric is within the defined threshold. + // - ALARM - The metric is outside of the defined threshold. + // - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, + // or not enough data is available for the metric to determine the alarm state. + // - OK - The metric is within the defined threshold. // // This member is required. State types.AlarmState diff --git a/service/lightsail/api_op_UntagResource.go b/service/lightsail/api_op_UntagResource.go index 278b2e95985..f1905fe1edf 100644 --- a/service/lightsail/api_op_UntagResource.go +++ b/service/lightsail/api_op_UntagResource.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified set of tag keys and their values from the specified Amazon -// Lightsail resource. The untag resource operation supports tag-based access -// control via request tags and resource tags applied to the resource identified by -// resource name. For more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// Deletes the specified set of tag keys and their values from the specified +// Amazon Lightsail resource. The untag resource operation supports tag-based +// access control via request tags and resource tags applied to the resource +// identified by resource name . For more information, see the Amazon Lightsail +// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/lightsail/api_op_UpdateBucket.go b/service/lightsail/api_op_UpdateBucket.go index 5a24b0fb823..f3cea264c26 100644 --- a/service/lightsail/api_op_UpdateBucket.go +++ b/service/lightsail/api_op_UpdateBucket.go @@ -49,12 +49,9 @@ type UpdateBucketInput struct { // Specifies whether to enable or suspend versioning of objects in the bucket. The // following options can be specified: - // - // * Enabled - Enables versioning of objects - // in the specified bucket. - // - // * Suspended - Suspends versioning of objects in the - // specified bucket. Existing object versions are retained. + // - Enabled - Enables versioning of objects in the specified bucket. + // - Suspended - Suspends versioning of objects in the specified bucket. Existing + // object versions are retained. Versioning *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateBucketBundle.go b/service/lightsail/api_op_UpdateBucketBundle.go index 83d3ae865af..b7aaa170ad5 100644 --- a/service/lightsail/api_op_UpdateBucketBundle.go +++ b/service/lightsail/api_op_UpdateBucketBundle.go @@ -15,8 +15,7 @@ import ( // bucket bundle specifies the monthly cost, storage space, and data transfer quota // for a bucket. You can update a bucket's bundle only one time within a monthly // Amazon Web Services billing cycle. To determine if you can update a bucket's -// bundle, use the GetBuckets -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) +// bundle, use the GetBuckets (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) // action. The ableToUpdateBundle parameter in the response will indicate whether // you can currently update a bucket's bundle. Update a bucket's bundle if it's // consistently going over its storage space or data transfer quota, or if a @@ -48,8 +47,7 @@ type UpdateBucketBundleInput struct { // This member is required. BucketName *string - // The ID of the new bundle to apply to the bucket. Use the GetBucketBundles - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) + // The ID of the new bundle to apply to the bucket. Use the GetBucketBundles (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) // action to get a list of bundle IDs that you can specify. // // This member is required. diff --git a/service/lightsail/api_op_UpdateContainerService.go b/service/lightsail/api_op_UpdateContainerService.go index ac3496c2f81..2b9c398b3ae 100644 --- a/service/lightsail/api_op_UpdateContainerService.go +++ b/service/lightsail/api_op_UpdateContainerService.go @@ -43,20 +43,18 @@ type UpdateContainerServiceInput struct { // and scale of a container service makes up its configured capacity. To determine // the monthly price of your container service, multiply the base price of the // power with the scale (the number of nodes) of the service. Use the - // GetContainerServicePowers action to view the specifications of each power - // option. + // GetContainerServicePowers action to view the specifications of each power option. Power types.ContainerServicePowerName // An object to describe the configuration for the container service to access // private container image repositories, such as Amazon Elastic Container Registry // (Amazon ECR) private repositories. For more information, see Configuring access - // to an Amazon ECR private repository for an Amazon Lightsail container service - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) + // to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. PrivateRegistryAccess *types.PrivateRegistryAccessRequest // The public domain names to use with the container service, such as example.com - // and www.example.com. You can specify up to four public domain names for a + // and www.example.com . You can specify up to four public domain names for a // container service. The domain names that you specify are used when you create a // deployment with a container configured as the public endpoint of your container // service. If you don't specify public domain names, then you can use the default @@ -68,10 +66,10 @@ type UpdateContainerServiceInput struct { PublicDomainNames map[string][]string // The scale for the container service. The scale specifies the allocated compute - // nodes of the container service. The power and scale of a container service makes - // up its configured capacity. To determine the monthly price of your container - // service, multiply the base price of the power with the scale (the number of - // nodes) of the service. + // nodes of the container service. The power and scale of a container service + // makes up its configured capacity. To determine the monthly price of your + // container service, multiply the base price of the power with the scale (the + // number of nodes) of the service. Scale *int32 noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateDistribution.go b/service/lightsail/api_op_UpdateDistribution.go index b67388cfa39..205b2841428 100644 --- a/service/lightsail/api_op_UpdateDistribution.go +++ b/service/lightsail/api_op_UpdateDistribution.go @@ -31,8 +31,8 @@ func (c *Client) UpdateDistribution(ctx context.Context, params *UpdateDistribut type UpdateDistributionInput struct { - // The name of the distribution to update. Use the GetDistributions action to get a - // list of distribution names that you can specify. + // The name of the distribution to update. Use the GetDistributions action to get + // a list of distribution names that you can specify. // // This member is required. DistributionName *string diff --git a/service/lightsail/api_op_UpdateDistributionBundle.go b/service/lightsail/api_op_UpdateDistributionBundle.go index 235391dadbb..c888bab514b 100644 --- a/service/lightsail/api_op_UpdateDistributionBundle.go +++ b/service/lightsail/api_op_UpdateDistributionBundle.go @@ -43,8 +43,7 @@ type UpdateDistributionBundleInput struct { BundleId *string // The name of the distribution for which to update the bundle. Use the - // GetDistributions action to get a list of distribution names that you can - // specify. + // GetDistributions action to get a list of distribution names that you can specify. DistributionName *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateDomainEntry.go b/service/lightsail/api_op_UpdateDomainEntry.go index c5b2ed41140..2e6fda12a98 100644 --- a/service/lightsail/api_op_UpdateDomainEntry.go +++ b/service/lightsail/api_op_UpdateDomainEntry.go @@ -13,9 +13,9 @@ import ( // Updates a domain recordset after it is created. The update domain entry // operation supports tag-based access control via resource tags applied to the -// resource identified by domain name. For more information, see the Amazon -// Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// resource identified by domain name . For more information, see the Amazon +// Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) UpdateDomainEntry(ctx context.Context, params *UpdateDomainEntryInput, optFns ...func(*Options)) (*UpdateDomainEntryOutput, error) { if params == nil { params = &UpdateDomainEntryInput{} diff --git a/service/lightsail/api_op_UpdateInstanceMetadataOptions.go b/service/lightsail/api_op_UpdateInstanceMetadataOptions.go index 701daeca39b..93231d90c4e 100644 --- a/service/lightsail/api_op_UpdateInstanceMetadataOptions.go +++ b/service/lightsail/api_op_UpdateInstanceMetadataOptions.go @@ -14,10 +14,9 @@ import ( // Modifies the Amazon Lightsail instance metadata parameters on a running or // stopped instance. When you modify the parameters on a running instance, the // GetInstance or GetInstances API operation initially responds with a state of -// pending. After the parameter modifications are successfully applied, the state -// changes to applied in subsequent GetInstance or GetInstances API calls. For more -// information, see Use IMDSv2 with an Amazon Lightsail instance -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service) +// pending . After the parameter modifications are successfully applied, the state +// changes to applied in subsequent GetInstance or GetInstances API calls. For +// more information, see Use IMDSv2 with an Amazon Lightsail instance (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service) // in the Amazon Lightsail Developer Guide. func (c *Client) UpdateInstanceMetadataOptions(ctx context.Context, params *UpdateInstanceMetadataOptionsInput, optFns ...func(*Options)) (*UpdateInstanceMetadataOptionsOutput, error) { if params == nil { @@ -43,29 +42,29 @@ type UpdateInstanceMetadataOptionsInput struct { // Enables or disables the HTTP metadata endpoint on your instances. If this // parameter is not specified, the existing state is maintained. If you specify a - // value of disabled, you cannot access your instance metadata. + // value of disabled , you cannot access your instance metadata. HttpEndpoint types.HttpEndpoint // Enables or disables the IPv6 endpoint for the instance metadata service. This // setting applies only when the HTTP metadata endpoint is enabled. This parameter // is available only for instances in the Europe (Stockholm) Amazon Web Services - // Region (eu-north-1). + // Region ( eu-north-1 ). HttpProtocolIpv6 types.HttpProtocolIpv6 - // The desired HTTP PUT response hop limit for instance metadata requests. A larger - // number means that the instance metadata requests can travel farther. If no - // parameter is specified, the existing state is maintained. + // The desired HTTP PUT response hop limit for instance metadata requests. A + // larger number means that the instance metadata requests can travel farther. If + // no parameter is specified, the existing state is maintained. HttpPutResponseHopLimit *int32 // The state of token usage for your instance metadata requests. If the parameter - // is not specified in the request, the default state is optional. If the state is - // optional, you can choose whether to retrieve instance metadata with a signed + // is not specified in the request, the default state is optional . If the state is + // optional , you can choose whether to retrieve instance metadata with a signed // token header on your request. If you retrieve the IAM role credentials without a // token, the version 1.0 role credentials are returned. If you retrieve the IAM // role credentials by using a valid signed token, the version 2.0 role credentials - // are returned. If the state is required, you must send a signed token header with - // all instance metadata retrieval requests. In this state, retrieving the IAM role - // credential always returns the version 2.0 credentials. The version 1.0 + // are returned. If the state is required , you must send a signed token header + // with all instance metadata retrieval requests. In this state, retrieving the IAM + // role credential always returns the version 2.0 credentials. The version 1.0 // credentials are not available. HttpTokens types.HttpTokens diff --git a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go index 2e841d37595..9eee61b223b 100644 --- a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go +++ b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go @@ -14,9 +14,9 @@ import ( // Updates the specified attribute for a load balancer. You can only update one // attribute at a time. The update load balancer attribute operation supports // tag-based access control via resource tags applied to the resource identified by -// load balancer name. For more information, see the Amazon Lightsail Developer -// Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// load balancer name . For more information, see the Amazon Lightsail Developer +// Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) UpdateLoadBalancerAttribute(ctx context.Context, params *UpdateLoadBalancerAttributeInput, optFns ...func(*Options)) (*UpdateLoadBalancerAttributeOutput, error) { if params == nil { params = &UpdateLoadBalancerAttributeInput{} @@ -42,37 +42,27 @@ type UpdateLoadBalancerAttributeInput struct { // The value that you want to specify for the attribute name. The following values // are supported depending on what you specify for the attributeName request // parameter: - // - // * If you specify HealthCheckPath for the attributeName request - // parameter, then the attributeValue request parameter must be the path to ping on - // the target (for example, /weather/us/wa/seattle). - // - // * If you specify - // SessionStickinessEnabled for the attributeName request parameter, then the - // attributeValue request parameter must be true to activate session stickiness or - // false to deactivate session stickiness. - // - // * If you specify - // SessionStickiness_LB_CookieDurationSeconds for the attributeName request - // parameter, then the attributeValue request parameter must be an interger that - // represents the cookie duration in seconds. - // - // * If you specify - // HttpsRedirectionEnabled for the attributeName request parameter, then the - // attributeValue request parameter must be true to activate HTTP to HTTPS - // redirection or false to deactivate HTTP to HTTPS redirection. - // - // * If you specify - // TlsPolicyName for the attributeName request parameter, then the attributeValue - // request parameter must be the name of the TLS policy. Use the - // GetLoadBalancerTlsPolicies - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) - // action to get a list of TLS policy names that you can specify. + // - If you specify HealthCheckPath for the attributeName request parameter, then + // the attributeValue request parameter must be the path to ping on the target + // (for example, /weather/us/wa/seattle ). + // - If you specify SessionStickinessEnabled for the attributeName request + // parameter, then the attributeValue request parameter must be true to activate + // session stickiness or false to deactivate session stickiness. + // - If you specify SessionStickiness_LB_CookieDurationSeconds for the + // attributeName request parameter, then the attributeValue request parameter + // must be an interger that represents the cookie duration in seconds. + // - If you specify HttpsRedirectionEnabled for the attributeName request + // parameter, then the attributeValue request parameter must be true to activate + // HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection. + // - If you specify TlsPolicyName for the attributeName request parameter, then + // the attributeValue request parameter must be the name of the TLS policy. Use + // the GetLoadBalancerTlsPolicies (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) + // action to get a list of TLS policy names that you can specify. // // This member is required. AttributeValue *string - // The name of the load balancer that you want to modify (e.g., my-load-balancer. + // The name of the load balancer that you want to modify (e.g., my-load-balancer . // // This member is required. LoadBalancerName *string diff --git a/service/lightsail/api_op_UpdateRelationalDatabase.go b/service/lightsail/api_op_UpdateRelationalDatabase.go index 653863e0ecf..19a5c6bb5d1 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabase.go +++ b/service/lightsail/api_op_UpdateRelationalDatabase.go @@ -16,8 +16,8 @@ import ( // an outage, are applied during the database's predefined maintenance window. The // update relational database operation supports tag-based access control via // resource tags applied to the resource identified by relationalDatabaseName. For -// more information, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) UpdateRelationalDatabase(ctx context.Context, params *UpdateRelationalDatabaseInput, optFns ...func(*Options)) (*UpdateRelationalDatabaseOutput, error) { if params == nil { params = &UpdateRelationalDatabaseInput{} @@ -40,21 +40,21 @@ type UpdateRelationalDatabaseInput struct { // This member is required. RelationalDatabaseName *string - // When true, applies changes immediately. When false, applies changes during the + // When true , applies changes immediately. When false , applies changes during the // preferred maintenance window. Some changes may cause an outage. Default: false ApplyImmediately *bool // Indicates the certificate that needs to be associated with the database. CaCertificateIdentifier *string - // When true, disables automated backup retention for your database. Disabling + // When true , disables automated backup retention for your database. Disabling // backup retention deletes all automated database backups. Before disabling this, // you may want to create a snapshot of your database using the create relational // database snapshot operation. Updates are applied during the next maintenance // window because this can result in an outage. DisableBackupRetention *bool - // When true, enables automated backup retention for your database. Updates are + // When true , enables automated backup retention for your database. Updates are // applied during the next maintenance window because this can result in an outage. EnableBackupRetention *bool @@ -65,45 +65,30 @@ type UpdateRelationalDatabaseInput struct { // The daily time range during which automated backups are created for your // database if automated backups are enabled. Constraints: - // - // * Must be in the - // hh24:mi-hh24:mi format. Example: 16:00-16:30 - // - // * Specified in Coordinated - // Universal Time (UTC). - // - // * Must not conflict with the preferred maintenance - // window. - // - // * Must be at least 30 minutes. + // - Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 + // - Specified in Coordinated Universal Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur on your // database. The default is a 30-minute window selected at random from an 8-hour // block of time for each Amazon Web Services Region, occurring on a random day of // the week. Constraints: - // - // * Must be in the ddd:hh24:mi-ddd:hh24:mi format. - // - // * - // Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. - // - // * Must be at least 30 - // minutes. - // - // * Specified in Coordinated Universal Time (UTC). - // - // * Example: - // Tue:17:00-Tue:17:30 + // - Must be in the ddd:hh24:mi-ddd:hh24:mi format. + // - Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // - Must be at least 30 minutes. + // - Specified in Coordinated Universal Time (UTC). + // - Example: Tue:17:00-Tue:17:30 PreferredMaintenanceWindow *string - // Specifies the accessibility options for your database. A value of true specifies - // a database that is available to resources outside of your Lightsail account. A - // value of false specifies a database that is available only to your Lightsail - // resources in the same region as your database. + // Specifies the accessibility options for your database. A value of true + // specifies a database that is available to resources outside of your Lightsail + // account. A value of false specifies a database that is available only to your + // Lightsail resources in the same region as your database. PubliclyAccessible *bool - // When true, the master user password is changed to a new strong password + // When true , the master user password is changed to a new strong password // generated by Lightsail. Use the get relational database master user password // operation to get the new password. RotateMasterUserPassword *bool diff --git a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go index 85ebad146e7..486ac0a7426 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go +++ b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go @@ -14,14 +14,14 @@ import ( // Allows the update of one or more parameters of a database in Amazon Lightsail. // Parameter updates don't cause outages; therefore, their application is not // subject to the preferred maintenance window. However, there are two ways in -// which parameter updates are applied: dynamic or pending-reboot. Parameters -// marked with a dynamic apply type are applied immediately. Parameters marked with -// a pending-reboot apply type are applied only after the database is rebooted -// using the reboot relational database operation. The update relational database -// parameters operation supports tag-based access control via resource tags applied -// to the resource identified by relationalDatabaseName. For more information, see -// the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags). +// which parameter updates are applied: dynamic or pending-reboot . Parameters +// marked with a dynamic apply type are applied immediately. Parameters marked +// with a pending-reboot apply type are applied only after the database is +// rebooted using the reboot relational database operation. The update relational +// database parameters operation supports tag-based access control via resource +// tags applied to the resource identified by relationalDatabaseName. For more +// information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags) +// . func (c *Client) UpdateRelationalDatabaseParameters(ctx context.Context, params *UpdateRelationalDatabaseParametersInput, optFns ...func(*Options)) (*UpdateRelationalDatabaseParametersOutput, error) { if params == nil { params = &UpdateRelationalDatabaseParametersInput{} diff --git a/service/lightsail/doc.go b/service/lightsail/doc.go index 4110643de89..cdbfd6bbe84 100644 --- a/service/lightsail/doc.go +++ b/service/lightsail/doc.go @@ -12,12 +12,10 @@ // domains, and resource snapshots (backups) - for a low, predictable monthly // price. You can manage your Lightsail resources using the Lightsail console, // Lightsail API, Command Line Interface (CLI), or SDKs. For more information about -// Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli). -// This API Reference provides detailed information about the actions, data types, -// parameters, and errors of the Lightsail service. For more information about the -// supported Amazon Web Services Regions, endpoints, and service quotas of the -// Lightsail service, see Amazon Lightsail Endpoints and Quotas -// (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the Amazon Web -// Services General Reference. +// Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli) +// . This API Reference provides detailed information about the actions, data +// types, parameters, and errors of the Lightsail service. For more information +// about the supported Amazon Web Services Regions, endpoints, and service quotas +// of the Lightsail service, see Amazon Lightsail Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) +// in the Amazon Web Services General Reference. package lightsail diff --git a/service/lightsail/types/enums.go b/service/lightsail/types/enums.go index e59f8dcfeb6..27bae720fb3 100644 --- a/service/lightsail/types/enums.go +++ b/service/lightsail/types/enums.go @@ -68,9 +68,9 @@ const ( AddOnTypeStopInstanceOnIdle AddOnType = "StopInstanceOnIdle" ) -// Values returns all known values for AddOnType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AddOnType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AddOnType) Values() []AddOnType { return []AddOnType{ "AutoSnapshot", @@ -166,9 +166,9 @@ const ( BehaviorEnumCacheSetting BehaviorEnum = "cache" ) -// Values returns all known values for BehaviorEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BehaviorEnum. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BehaviorEnum) Values() []BehaviorEnum { return []BehaviorEnum{ "dont-cache", @@ -243,8 +243,8 @@ const ( CertificateDomainValidationStatusSuccess CertificateDomainValidationStatus = "SUCCESS" ) -// Values returns all known values for CertificateDomainValidationStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for CertificateDomainValidationStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (CertificateDomainValidationStatus) Values() []CertificateDomainValidationStatus { @@ -349,8 +349,8 @@ const ( ContactMethodVerificationProtocolEmail ContactMethodVerificationProtocol = "Email" ) -// Values returns all known values for ContactMethodVerificationProtocol. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for ContactMethodVerificationProtocol. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (ContactMethodVerificationProtocol) Values() []ContactMethodVerificationProtocol { @@ -454,9 +454,9 @@ const ( ContainerServiceProtocolUdp ContainerServiceProtocol = "UDP" ) -// Values returns all known values for ContainerServiceProtocol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ContainerServiceProtocol. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerServiceProtocol) Values() []ContainerServiceProtocol { return []ContainerServiceProtocol{ "HTTP", @@ -479,8 +479,8 @@ const ( ContainerServiceStateDeploying ContainerServiceState = "DEPLOYING" ) -// Values returns all known values for ContainerServiceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ContainerServiceState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ContainerServiceState) Values() []ContainerServiceState { return []ContainerServiceState{ @@ -576,9 +576,9 @@ const ( DiskStateUnknown DiskState = "unknown" ) -// Values returns all known values for DiskState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DiskState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DiskState) Values() []DiskState { return []DiskState{ "pending", @@ -726,9 +726,9 @@ const ( HttpEndpointEnabled HttpEndpoint = "enabled" ) -// Values returns all known values for HttpEndpoint. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HttpEndpoint. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HttpEndpoint) Values() []HttpEndpoint { return []HttpEndpoint{ "disabled", @@ -860,8 +860,8 @@ const ( InstanceMetadataStateApplied InstanceMetadataState = "applied" ) -// Values returns all known values for InstanceMetadataState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceMetadataState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataState) Values() []InstanceMetadataState { return []InstanceMetadataState{ @@ -929,8 +929,8 @@ const ( InstanceSnapshotStateAvailable InstanceSnapshotState = "available" ) -// Values returns all known values for InstanceSnapshotState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for InstanceSnapshotState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (InstanceSnapshotState) Values() []InstanceSnapshotState { return []InstanceSnapshotState{ @@ -1092,9 +1092,9 @@ const ( LoadBalancerTlsCertificateDomainStatusSuccess LoadBalancerTlsCertificateDomainStatus = "SUCCESS" ) -// Values returns all known values for LoadBalancerTlsCertificateDomainStatus. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for LoadBalancerTlsCertificateDomainStatus. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (LoadBalancerTlsCertificateDomainStatus) Values() []LoadBalancerTlsCertificateDomainStatus { return []LoadBalancerTlsCertificateDomainStatus{ @@ -1628,9 +1628,9 @@ const ( OriginProtocolPolicyEnumHTTPSOnly OriginProtocolPolicyEnum = "https-only" ) -// Values returns all known values for OriginProtocolPolicyEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OriginProtocolPolicyEnum. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginProtocolPolicyEnum) Values() []OriginProtocolPolicyEnum { return []OriginProtocolPolicyEnum{ "http-only", @@ -1686,9 +1686,9 @@ const ( PortStateClosed PortState = "closed" ) -// Values returns all known values for PortState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for PortState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (PortState) Values() []PortState { return []PortState{ "open", @@ -1814,9 +1814,9 @@ const ( RelationalDatabaseEngineMysql RelationalDatabaseEngine = "mysql" ) -// Values returns all known values for RelationalDatabaseEngine. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RelationalDatabaseEngine. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationalDatabaseEngine) Values() []RelationalDatabaseEngine { return []RelationalDatabaseEngine{ "mysql", @@ -1835,9 +1835,10 @@ const ( RelationalDatabaseMetricNameNetworkTransmitThroughput RelationalDatabaseMetricName = "NetworkTransmitThroughput" ) -// Values returns all known values for RelationalDatabaseMetricName. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RelationalDatabaseMetricName. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RelationalDatabaseMetricName) Values() []RelationalDatabaseMetricName { return []RelationalDatabaseMetricName{ "CPUUtilization", @@ -1858,8 +1859,8 @@ const ( RelationalDatabasePasswordVersionPending RelationalDatabasePasswordVersion = "PENDING" ) -// Values returns all known values for RelationalDatabasePasswordVersion. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for RelationalDatabasePasswordVersion. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (RelationalDatabasePasswordVersion) Values() []RelationalDatabasePasswordVersion { @@ -1936,9 +1937,9 @@ const ( ResourceTypeBucket ResourceType = "Bucket" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "ContainerService", diff --git a/service/lightsail/types/errors.go b/service/lightsail/types/errors.go index 92daeb42f60..c2d54c67ec6 100644 --- a/service/lightsail/types/errors.go +++ b/service/lightsail/types/errors.go @@ -71,9 +71,9 @@ func (e *AccountSetupInProgressException) ErrorFault() smithy.ErrorFault { retur // Lightsail throws this exception when user input does not conform to the // validation rules of an input field. Domain and distribution APIs are only -// available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set -// your Amazon Web Services Region configuration to us-east-1 to create, view, or -// edit these resources. +// available in the N. Virginia ( us-east-1 ) Amazon Web Services Region. Please +// set your Amazon Web Services Region configuration to us-east-1 to create, view, +// or edit these resources. type InvalidInputException struct { Message *string diff --git a/service/lightsail/types/types.go b/service/lightsail/types/types.go index 7fae8bd72e1..09423f66691 100644 --- a/service/lightsail/types/types.go +++ b/service/lightsail/types/types.go @@ -9,11 +9,9 @@ import ( // Describes an access key for an Amazon Lightsail bucket. Access keys grant full // programmatic access to the specified bucket and its objects. You can have a -// maximum of two access keys per bucket. Use the CreateBucketAccessKey -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) +// maximum of two access keys per bucket. Use the CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) // action to create an access key for a specific bucket. For more information about -// access keys, see Creating access keys for a bucket in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) +// access keys, see Creating access keys for a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) // in the Amazon Lightsail Developer Guide. The secretAccessKey value is returned // only in response to the CreateBucketAccessKey action. You can get a secret // access key only when you first create an access key; you cannot get the secret @@ -27,11 +25,10 @@ type AccessKey struct { // The timestamp when the access key was created. CreatedAt *time.Time - // An object that describes the last time the access key was used. This object does - // not include data in the response of a CreateBucketAccessKey - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) + // An object that describes the last time the access key was used. This object + // does not include data in the response of a CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) // action. If the access key has not been used, the region and serviceName values - // are N/A, and the lastUsedDate value is null. + // are N/A , and the lastUsedDate value is null. LastUsed *AccessKeyLastUsed // The secret access key used to sign requests. You should store the secret access @@ -47,13 +44,12 @@ type AccessKey struct { } // Describes the last time an access key was used. This object does not include -// data in the response of a CreateBucketAccessKey -// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) +// data in the response of a CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) // action. type AccessKeyLastUsed struct { - // The date and time when the access key was most recently used. This value is null - // if the access key has not been used. + // The date and time when the access key was most recently used. This value is + // null if the access key has not been used. LastUsedDate *time.Time // The Amazon Web Services Region where this access key was most recently used. @@ -69,33 +65,30 @@ type AccessKeyLastUsed struct { // Describes the anonymous access permissions for an Amazon Lightsail bucket and // its objects. For more information about bucket access permissions, see -// Understanding bucket permissions in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions) +// Understanding bucket permissions in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions) // in the Amazon Lightsail Developer Guide. type AccessRules struct { - // A Boolean value that indicates whether the access control list (ACL) permissions - // that are applied to individual objects override the getObject option that is - // currently specified. When this is true, you can use the PutObjectAcl - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html) Amazon - // S3 API action to set individual objects to public (read-only) using the + // A Boolean value that indicates whether the access control list (ACL) + // permissions that are applied to individual objects override the getObject + // option that is currently specified. When this is true, you can use the + // PutObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html) + // Amazon S3 API action to set individual objects to public (read-only) using the // public-read ACL, or to private using the private ACL. AllowPublicOverrides *bool - // Specifies the anonymous access to all objects in a bucket. The following options - // can be specified: - // - // * public - Sets all objects in the bucket to public - // (read-only), making them readable by anyone in the world. If the getObject value - // is set to public, then all objects in the bucket default to public regardless of - // the allowPublicOverrides value. - // - // * private - Sets all objects in the bucket to - // private, making them readable only by you or anyone you give access to. If the - // getObject value is set to private, and the allowPublicOverrides value is set to - // true, then all objects in the bucket default to private unless they are - // configured with a public-read ACL. Individual objects with a public-read ACL are - // readable by anyone in the world. + // Specifies the anonymous access to all objects in a bucket. The following + // options can be specified: + // - public - Sets all objects in the bucket to public (read-only), making them + // readable by anyone in the world. If the getObject value is set to public , + // then all objects in the bucket default to public regardless of the + // allowPublicOverrides value. + // - private - Sets all objects in the bucket to private, making them readable + // only by you or anyone you give access to. If the getObject value is set to + // private , and the allowPublicOverrides value is set to true , then all objects + // in the bucket default to private unless they are configured with a public-read + // ACL. Individual objects with a public-read ACL are readable by anyone in the + // world. GetObject AccessType noSmithyDocumentSerde @@ -110,11 +103,10 @@ type AccessRules struct { // buckets take into account the Amazon S3 account-level BPA configuration when // allowing or denying public access. To do this, Lightsail periodically fetches // the account-level BPA configuration from Amazon S3. When the account-level BPA -// status is InSync, the Amazon S3 account-level BPA configuration is synchronized +// status is InSync , the Amazon S3 account-level BPA configuration is synchronized // and it applies to your Lightsail buckets. For more information about Amazon // Simple Storage Service account-level BPA and how it affects Lightsail buckets, -// see Block public access for buckets in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets) +// see Block public access for buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets) // in the Amazon Lightsail Developer Guide. type AccountLevelBpaSync struct { @@ -122,65 +114,49 @@ type AccountLevelBpaSync struct { // affecting your Lightsail buckets. BpaImpactsLightsail *bool - // The timestamp of when the account-level BPA configuration was last synchronized. - // This value is null when the account-level BPA configuration has not been - // synchronized. + // The timestamp of when the account-level BPA configuration was last + // synchronized. This value is null when the account-level BPA configuration has + // not been synchronized. LastSyncedAt *time.Time // A message that provides a reason for a Failed or Defaulted synchronization // status. The following messages are possible: - // - // * SYNC_ON_HOLD - The - // synchronization has not yet happened. This status message occurs immediately - // after you create your first Lightsail bucket. This status message should change - // after the first synchronization happens, approximately 1 hour after the first - // bucket is created. - // - // * DEFAULTED_FOR_SLR_MISSING - The synchronization failed - // because the required service-linked role is missing from your Amazon Web - // Services account. The account-level BPA configuration for your Lightsail buckets - // is defaulted to active until the synchronization can occur. This means that all - // your buckets are private and not publicly accessible. For more information about - // how to create the required service-linked role to allow synchronization, see - // Using Service-Linked Roles for Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) - // in the Amazon Lightsail Developer Guide. - // - // * DEFAULTED_FOR_SLR_MISSING_ON_HOLD - - // The synchronization failed because the required service-linked role is missing - // from your Amazon Web Services account. Account-level BPA is not yet configured - // for your Lightsail buckets. Therefore, only the bucket access permissions and - // individual object access permissions apply to your Lightsail buckets. For more - // information about how to create the required service-linked role to allow - // synchronization, see Using Service-Linked Roles for Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) - // in the Amazon Lightsail Developer Guide. - // - // * Unknown - The reason that - // synchronization failed is unknown. Contact Amazon Web Services Support for more - // information. + // - SYNC_ON_HOLD - The synchronization has not yet happened. This status message + // occurs immediately after you create your first Lightsail bucket. This status + // message should change after the first synchronization happens, approximately 1 + // hour after the first bucket is created. + // - DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required + // service-linked role is missing from your Amazon Web Services account. The + // account-level BPA configuration for your Lightsail buckets is defaulted to + // active until the synchronization can occur. This means that all your buckets are + // private and not publicly accessible. For more information about how to create + // the required service-linked role to allow synchronization, see Using + // Service-Linked Roles for Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) + // in the Amazon Lightsail Developer Guide. + // - DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the + // required service-linked role is missing from your Amazon Web Services account. + // Account-level BPA is not yet configured for your Lightsail buckets. Therefore, + // only the bucket access permissions and individual object access permissions + // apply to your Lightsail buckets. For more information about how to create the + // required service-linked role to allow synchronization, see Using + // Service-Linked Roles for Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles) + // in the Amazon Lightsail Developer Guide. + // - Unknown - The reason that synchronization failed is unknown. Contact Amazon + // Web Services Support for more information. Message BPAStatusMessage // The status of the account-level BPA synchronization. The following statuses are // possible: - // - // * InSync - Account-level BPA is synchronized. The Amazon S3 - // account-level BPA configuration applies to your Lightsail buckets. - // - // * - // NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level - // BPA configuration does not apply to your Lightsail buckets. - // - // * Failed - - // Synchronization failed. The Amazon S3 account-level BPA configuration does not - // apply to your Lightsail buckets. - // - // * Defaulted - Synchronization failed and - // account-level BPA for your Lightsail buckets is defaulted to active. - // - // You might - // need to complete further actions if the status is Failed or Defaulted. The - // message parameter provides more information for those statuses. + // - InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA + // configuration applies to your Lightsail buckets. + // - NeverSynced - Synchronization has not yet happened. The Amazon S3 + // account-level BPA configuration does not apply to your Lightsail buckets. + // - Failed - Synchronization failed. The Amazon S3 account-level BPA + // configuration does not apply to your Lightsail buckets. + // - Defaulted - Synchronization failed and account-level BPA for your Lightsail + // buckets is defaulted to active. + // You might need to complete further actions if the status is Failed or Defaulted + // . The message parameter provides more information for those statuses. Status AccountLevelBpaSyncStatus noSmithyDocumentSerde @@ -219,8 +195,8 @@ type AddOn struct { // Describes a request to enable, modify, or disable an add-on for an Amazon // Lightsail resource. An additional cost may be associated with enabling add-ons. -// For more information, see the Lightsail pricing page -// (https://aws.amazon.com/lightsail/pricing/). +// For more information, see the Lightsail pricing page (https://aws.amazon.com/lightsail/pricing/) +// . type AddOnRequest struct { // The add-on type. @@ -241,8 +217,8 @@ type AddOnRequest struct { } // Describes an alarm. An alarm is a way to monitor your Lightsail resource -// metrics. For more information, see Alarms in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). +// metrics. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . type Alarm struct { // The Amazon Resource Name (ARN) of the alarm. @@ -252,7 +228,7 @@ type Alarm struct { // threshold. ComparisonOperator ComparisonOperator - // The contact protocols for the alarm, such as Email, SMS (text messaging), or + // The contact protocols for the alarm, such as Email , SMS (text messaging), or // both. ContactProtocols []ContactProtocol @@ -287,45 +263,31 @@ type Alarm struct { // The period, in seconds, over which the statistic is applied. Period int32 - // The Lightsail resource type (e.g., Alarm). + // The Lightsail resource type (e.g., Alarm ). ResourceType ResourceType // The current state of the alarm. An alarm has the following possible states: - // - // * - // ALARM - The metric is outside of the defined threshold. - // - // * INSUFFICIENT_DATA - - // The alarm has just started, the metric is not available, or not enough data is - // available for the metric to determine the alarm state. - // - // * OK - The metric is - // within the defined threshold. + // - ALARM - The metric is outside of the defined threshold. + // - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, + // or not enough data is available for the metric to determine the alarm state. + // - OK - The metric is within the defined threshold. State AlarmState - // The statistic for the metric associated with the alarm. The following statistics - // are available: - // - // * Minimum - The lowest value observed during the specified - // period. Use this value to determine low volumes of activity for your - // application. - // - // * Maximum - The highest value observed during the specified - // period. Use this value to determine high volumes of activity for your - // application. - // - // * Sum - All values submitted for the matching metric added - // together. You can use this statistic to determine the total volume of a - // metric. - // - // * Average - The value of Sum / SampleCount during the specified period. - // By comparing this statistic with the Minimum and Maximum values, you can - // determine the full scope of a metric and how close the average use is to the - // Minimum and Maximum values. This comparison helps you to know when to increase - // or decrease your resources. - // - // * SampleCount - The count, or number, of data - // points used for the statistical calculation. + // The statistic for the metric associated with the alarm. The following + // statistics are available: + // - Minimum - The lowest value observed during the specified period. Use this + // value to determine low volumes of activity for your application. + // - Maximum - The highest value observed during the specified period. Use this + // value to determine high volumes of activity for your application. + // - Sum - All values submitted for the matching metric added together. You can + // use this statistic to determine the total volume of a metric. + // - Average - The value of Sum / SampleCount during the specified period. By + // comparing this statistic with the Minimum and Maximum values, you can determine + // the full scope of a metric and how close the average use is to the Minimum and + // Maximum values. This comparison helps you to know when to increase or decrease + // your resources. + // - SampleCount - The count, or number, of data points used for the statistical + // calculation. Statistic MetricStatistic // The support code. Include this code in your email to support when you have @@ -338,19 +300,13 @@ type Alarm struct { // Specifies how the alarm handles missing data points. An alarm can treat missing // data in the following ways: - // - // * breaching - Assume the missing data is not within - // the threshold. Missing data counts towards the number of times the metric is not - // within the threshold. - // - // * notBreaching - Assume the missing data is within the - // threshold. Missing data does not count towards the number of times the metric is - // not within the threshold. - // - // * ignore - Ignore the missing data. Maintains the - // current alarm state. - // - // * missing - Missing data is treated as missing. + // - breaching - Assume the missing data is not within the threshold. Missing + // data counts towards the number of times the metric is not within the threshold. + // - notBreaching - Assume the missing data is within the threshold. Missing data + // does not count towards the number of times the metric is not within the + // threshold. + // - ignore - Ignore the missing data. Maintains the current alarm state. + // - missing - Missing data is treated as missing. TreatMissingData TreatMissingData // The unit of the metric associated with the alarm. @@ -363,7 +319,7 @@ type Alarm struct { // in an automatic snapshot. type AttachedDisk struct { - // The path of the disk (e.g., /dev/xvdf). + // The path of the disk (e.g., /dev/xvdf ). Path *string // The size of the disk in GB. @@ -376,45 +332,35 @@ type AttachedDisk struct { // Amazon Lightsail instance or disk. When you modify the automatic snapshot time // for a resource, it is typically effective immediately except under the following // conditions: -// -// * If an automatic snapshot has been created for the current day, -// and you change the snapshot time to a later time of day, then the new snapshot -// time will be effective the following day. This ensures that two snapshots are -// not created for the current day. -// -// * If an automatic snapshot has not yet been -// created for the current day, and you change the snapshot time to an earlier time -// of day, then the new snapshot time will be effective the following day and a -// snapshot is automatically created at the previously set time for the current -// day. This ensures that a snapshot is created for the current day. -// -// * If an -// automatic snapshot has not yet been created for the current day, and you change -// the snapshot time to a time that is within 30 minutes from your current time, -// then the new snapshot time will be effective the following day and a snapshot is -// automatically created at the previously set time for the current day. This -// ensures that a snapshot is created for the current day, because 30 minutes is -// required between your current time and the new snapshot time that you -// specify. -// -// * If an automatic snapshot is scheduled to be created within 30 -// minutes from your current time and you change the snapshot time, then the new -// snapshot time will be effective the following day and a snapshot is -// automatically created at the previously set time for the current day. This -// ensures that a snapshot is created for the current day, because 30 minutes is -// required between your current time and the new snapshot time that you specify. +// - If an automatic snapshot has been created for the current day, and you +// change the snapshot time to a later time of day, then the new snapshot time will +// be effective the following day. This ensures that two snapshots are not created +// for the current day. +// - If an automatic snapshot has not yet been created for the current day, and +// you change the snapshot time to an earlier time of day, then the new snapshot +// time will be effective the following day and a snapshot is automatically created +// at the previously set time for the current day. This ensures that a snapshot is +// created for the current day. +// - If an automatic snapshot has not yet been created for the current day, and +// you change the snapshot time to a time that is within 30 minutes from your +// current time, then the new snapshot time will be effective the following day and +// a snapshot is automatically created at the previously set time for the current +// day. This ensures that a snapshot is created for the current day, because 30 +// minutes is required between your current time and the new snapshot time that you +// specify. +// - If an automatic snapshot is scheduled to be created within 30 minutes from +// your current time and you change the snapshot time, then the new snapshot time +// will be effective the following day and a snapshot is automatically created at +// the previously set time for the current day. This ensures that a snapshot is +// created for the current day, because 30 minutes is required between your current +// time and the new snapshot time that you specify. type AutoSnapshotAddOnRequest struct { // The daily time when an automatic snapshot will be created. Constraints: - // - // * Must - // be in HH:00 format, and in an hourly increment. - // - // * Specified in Coordinated - // Universal Time (UTC). - // - // * The snapshot will be automatically created between the - // time specified and up to 45 minutes after. + // - Must be in HH:00 format, and in an hourly increment. + // - Specified in Coordinated Universal Time (UTC). + // - The snapshot will be automatically created between the time specified and + // up to 45 minutes after. SnapshotTimeOfDay *string noSmithyDocumentSerde @@ -460,13 +406,13 @@ type Blueprint struct { AppCategory AppCategory // The ID for the virtual private server image (e.g., app_wordpress_4_4 or - // app_lamp_7_0). + // app_lamp_7_0 ). BlueprintId *string // The description of the blueprint. Description *string - // The group name of the blueprint (e.g., amazon-linux). + // The group name of the blueprint (e.g., amazon-linux ). Group *string // A Boolean value indicating whether the blueprint is active. Inactive blueprints @@ -478,13 +424,13 @@ type Blueprint struct { // The end-user license agreement URL for the image or blueprint. LicenseUrl *string - // The minimum bundle power required to run this blueprint. For example, you need a - // bundle with a power value of 500 or more to create an instance that uses a - // blueprint with a minimum power value of 500. 0 indicates that the blueprint runs - // on all instance sizes. + // The minimum bundle power required to run this blueprint. For example, you need + // a bundle with a power value of 500 or more to create an instance that uses a + // blueprint with a minimum power value of 500. 0 indicates that the blueprint + // runs on all instance sizes. MinPower *int32 - // The friendly name of the blueprint (e.g., Amazon Linux). + // The friendly name of the blueprint (e.g., Amazon Linux ). Name *string // The operating system platform (either Linux/Unix-based or Windows Server-based) @@ -494,11 +440,11 @@ type Blueprint struct { // The product URL to learn more about the image or blueprint. ProductUrl *string - // The type of the blueprint (e.g., os or app). + // The type of the blueprint (e.g., os or app ). Type BlueprintType // The version number of the operating system, application, or stack (e.g., - // 2016.03.0). + // 2016.03.0 ). Version *string // The version code. @@ -512,8 +458,7 @@ type Bucket struct { // Indicates whether the bundle that is currently applied to a bucket can be // changed to another bundle. You can update a bucket's bundle only one time within - // a monthly Amazon Web Services billing cycle. Use the UpdateBucketBundle - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) + // a monthly Amazon Web Services billing cycle. Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) // action to change a bucket's bundle. AbleToUpdateBundle *bool @@ -528,8 +473,7 @@ type Bucket struct { // The ID of the bundle currently applied to the bucket. A bucket bundle specifies // the monthly cost, storage space, and data transfer quota for a bucket. Use the - // UpdateBucketBundle - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) + // UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) // action to change the bundle of a bucket. BundleId *string @@ -545,27 +489,21 @@ type Bucket struct { // Indicates whether object versioning is enabled for the bucket. The following // options can be configured: - // - // * Enabled - Object versioning is enabled. - // - // * - // Suspended - Object versioning was previously enabled but is currently suspended. - // Existing object versions are retained. - // - // * NeverEnabled - Object versioning has - // never been enabled. + // - Enabled - Object versioning is enabled. + // - Suspended - Object versioning was previously enabled but is currently + // suspended. Existing object versions are retained. + // - NeverEnabled - Object versioning has never been enabled. ObjectVersioning *string // An array of strings that specify the Amazon Web Services account IDs that have // read-only access to the bucket. ReadonlyAccessAccounts []string - // The Lightsail resource type of the bucket (for example, Bucket). + // The Lightsail resource type of the bucket (for example, Bucket ). ResourceType *string // An array of objects that describe Lightsail instances that have access to the - // bucket. Use the SetResourceAccessForBucket - // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) + // bucket. Use the SetResourceAccessForBucket (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) // action to update the instances that have access to a bucket. ResourcesReceivingAccess []ResourceReceivingAccess @@ -578,9 +516,8 @@ type Bucket struct { SupportCode *string // The tag keys and optional values for the bucket. For more information, see Tags - // in Amazon Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags) in - // the Amazon Lightsail Developer Guide. + // in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags) + // in the Amazon Lightsail Developer Guide. Tags []Tag // The URL of the bucket. @@ -591,8 +528,7 @@ type Bucket struct { // Describes the access log configuration for a bucket in the Amazon Lightsail // object storage service. For more information about bucket access logs, see -// Logging bucket requests using access logging in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs) +// Logging bucket requests using access logging in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs) // in the Amazon Lightsail Developer Guide. type BucketAccessLogConfig struct { @@ -602,17 +538,17 @@ type BucketAccessLogConfig struct { // This member is required. Enabled *bool - // The name of the bucket where the access logs are saved. The destination can be a - // Lightsail bucket in the same account, and in the same Amazon Web Services Region - // as the source bucket. This parameter is required when enabling the access log - // for a bucket, and should be omitted when disabling the access log. + // The name of the bucket where the access logs are saved. The destination can be + // a Lightsail bucket in the same account, and in the same Amazon Web Services + // Region as the source bucket. This parameter is required when enabling the access + // log for a bucket, and should be omitted when disabling the access log. Destination *string // The optional object prefix for the bucket access log. The prefix is an optional // addition to the object key that organizes your access log files in the // destination bucket. For example, if you specify a logs/ prefix, then each log // object will begin with the logs/ prefix in its key (for example, - // logs/2021-11-01-21-32-16-E568B2907131C0C0). This parameter can be optionally + // logs/2021-11-01-21-32-16-E568B2907131C0C0 ). This parameter can be optionally // specified when enabling the access log for a bucket, and should be omitted when // disabling the access log. Prefix *string @@ -650,12 +586,9 @@ type BucketBundle struct { type BucketState struct { // The state code of the bucket. The following codes are possible: - // - // * OK - The - // bucket is in a running state. - // - // * Unknown - Creation of the bucket might have - // timed-out. You might want to delete the bucket and create a new one. + // - OK - The bucket is in a running state. + // - Unknown - Creation of the bucket might have timed-out. You might want to + // delete the bucket and create a new one. Code *string // A message that describes the state of the bucket. @@ -668,35 +601,35 @@ type BucketState struct { // server (or instance). type Bundle struct { - // The bundle ID (e.g., micro_1_0). + // The bundle ID (e.g., micro_1_0 ). BundleId *string - // The number of vCPUs included in the bundle (e.g., 2). + // The number of vCPUs included in the bundle (e.g., 2 ). CpuCount *int32 - // The size of the SSD (e.g., 30). + // The size of the SSD (e.g., 30 ). DiskSizeInGb *int32 - // The Amazon EC2 instance type (e.g., t2.micro). + // The Amazon EC2 instance type (e.g., t2.micro ). InstanceType *string // A Boolean value indicating whether the bundle is active. IsActive *bool - // A friendly name for the bundle (e.g., Micro). + // A friendly name for the bundle (e.g., Micro ). Name *string - // A numeric value that represents the power of the bundle (e.g., 500). You can use - // the bundle's power value in conjunction with a blueprint's minimum power value - // to determine whether the blueprint will run on the bundle. For example, you need - // a bundle with a power value of 500 or more to create an instance that uses a - // blueprint with a minimum power value of 500. + // A numeric value that represents the power of the bundle (e.g., 500 ). You can + // use the bundle's power value in conjunction with a blueprint's minimum power + // value to determine whether the blueprint will run on the bundle. For example, + // you need a bundle with a power value of 500 or more to create an instance that + // uses a blueprint with a minimum power value of 500. Power *int32 - // The price in US dollars (e.g., 5.0) of the bundle. + // The price in US dollars (e.g., 5.0 ) of the bundle. Price *float32 - // The amount of RAM in GB (e.g., 2.0). + // The amount of RAM in GB (e.g., 2.0 ). RamSizeInGb *float32 // Virtual computer blueprints that are supported by a Lightsail for Research @@ -709,7 +642,7 @@ type Bundle struct { // bundle. SupportedPlatforms []InstancePlatform - // The data transfer rate per month in GB (e.g., 2000). + // The data transfer rate per month in GB (e.g., 2000 ). TransferPerMonthInGb *int32 noSmithyDocumentSerde @@ -721,19 +654,16 @@ type CacheBehavior struct { // The cache behavior of the distribution. The following cache behaviors can be // specified: - // - // * cache - This option is best for static sites. When specified, your - // distribution caches and serves your entire website as static content. This - // behavior is ideal for websites with static content that doesn't change depending - // on who views it, or for websites that don't use cookies, headers, or query - // strings to personalize content. - // - // * dont-cache - This option is best for sites - // that serve a mix of static and dynamic content. When specified, your - // distribution caches and serve only the content that is specified in the - // distribution's CacheBehaviorPerPath parameter. This behavior is ideal for - // websites or web applications that use cookies, headers, and query strings to - // personalize content for individual users. + // - cache - This option is best for static sites. When specified, your + // distribution caches and serves your entire website as static content. This + // behavior is ideal for websites with static content that doesn't change depending + // on who views it, or for websites that don't use cookies, headers, or query + // strings to personalize content. + // - dont-cache - This option is best for sites that serve a mix of static and + // dynamic content. When specified, your distribution caches and serve only the + // content that is specified in the distribution's CacheBehaviorPerPath + // parameter. This behavior is ideal for websites or web applications that use + // cookies, headers, and query strings to personalize content for individual users. Behavior BehaviorEnum noSmithyDocumentSerde @@ -742,43 +672,33 @@ type CacheBehavior struct { // Describes the per-path cache behavior of an Amazon Lightsail content delivery // network (CDN) distribution. A per-path cache behavior is used to override, or // add an exception to, the default cache behavior of a distribution. For example, -// if the cacheBehavior is set to cache, then a per-path cache behavior can be used -// to specify a directory, file, or file type that your distribution will cache. -// Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path -// cache behavior can be used to specify a directory, file, or file type that your -// distribution will not cache. +// if the cacheBehavior is set to cache , then a per-path cache behavior can be +// used to specify a directory, file, or file type that your distribution will +// cache. Alternately, if the distribution's cacheBehavior is dont-cache , then a +// per-path cache behavior can be used to specify a directory, file, or file type +// that your distribution will not cache. type CacheBehaviorPerPath struct { // The cache behavior for the specified path. You can specify one of the following // per-path cache behaviors: - // - // * cache - This behavior caches the specified path. - // - // * - // dont-cache - This behavior doesn't cache the specified path. + // - cache - This behavior caches the specified path. + // - dont-cache - This behavior doesn't cache the specified path. Behavior BehaviorEnum // The path to a directory or file to cached, or not cache. Use an asterisk symbol - // to specify wildcard directories (path/to/assets/*), and file types (*.html, - // *jpg, *js). Directories and file paths are case-sensitive. Examples: - // - // * Specify - // the following to cache all files in the document root of an Apache web server - // running on a Lightsail instance. var/www/html/ - // - // * Specify the following file to - // cache only the index page in the document root of an Apache web server. - // var/www/html/index.html - // - // * Specify the following to cache only the .html files - // in the document root of an Apache web server. var/www/html/*.html - // - // * Specify the - // following to cache only the .jpg, .png, and .gif files in the images - // sub-directory of the document root of an Apache web server. - // var/www/html/images/*.jpgvar/www/html/images/*.pngvar/www/html/images/*.gif - // Specify the following to cache all files in the images sub-directory of the - // document root of an Apache web server. var/www/html/images/ + // to specify wildcard directories ( path/to/assets/* ), and file types ( *.html, + // *jpg, *js ). Directories and file paths are case-sensitive. Examples: + // - Specify the following to cache all files in the document root of an Apache + // web server running on a Lightsail instance. var/www/html/ + // - Specify the following file to cache only the index page in the document + // root of an Apache web server. var/www/html/index.html + // - Specify the following to cache only the .html files in the document root of + // an Apache web server. var/www/html/*.html + // - Specify the following to cache only the .jpg, .png, and .gif files in the + // images sub-directory of the document root of an Apache web server. + // var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif + // Specify the following to cache all files in the images sub-directory of the + // document root of an Apache web server. var/www/html/images/ Path *string noSmithyDocumentSerde @@ -786,44 +706,35 @@ type CacheBehaviorPerPath struct { // Describes the cache settings of an Amazon Lightsail content delivery network // (CDN) distribution. These settings apply only to your distribution's -// cacheBehaviors (including the defaultCacheBehavior) that have a behavior of -// cache. +// cacheBehaviors (including the defaultCacheBehavior ) that have a behavior of +// cache . type CacheSettings struct { // The HTTP methods that are processed and forwarded to the distribution's origin. // You can specify the following options: - // - // * GET,HEAD - The distribution forwards - // the GET and HEAD methods. - // - // * GET,HEAD,OPTIONS - The distribution forwards the - // GET, HEAD, and OPTIONS methods. - // - // * GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The - // distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE - // methods. - // - // If you specify the third option, you might need to restrict access to - // your distribution's origin so users can't perform operations that you don't want - // them to. For example, you might not want users to have permission to delete - // objects from your origin. + // - GET,HEAD - The distribution forwards the GET and HEAD methods. + // - GET,HEAD,OPTIONS - The distribution forwards the GET , HEAD , and OPTIONS + // methods. + // - GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET , + // HEAD , OPTIONS , PUT , PATCH , POST , and DELETE methods. + // If you specify the third option, you might need to restrict access to your + // distribution's origin so users can't perform operations that you don't want them + // to. For example, you might not want users to have permission to delete objects + // from your origin. AllowedHTTPMethods *string // The HTTP method responses that are cached by your distribution. You can specify // the following options: - // - // * GET,HEAD - The distribution caches responses to the - // GET and HEAD methods. - // - // * GET,HEAD,OPTIONS - The distribution caches responses to - // the GET, HEAD, and OPTIONS methods. + // - GET,HEAD - The distribution caches responses to the GET and HEAD methods. + // - GET,HEAD,OPTIONS - The distribution caches responses to the GET , HEAD , and + // OPTIONS methods. CachedHTTPMethods *string // The default amount of time that objects stay in the distribution's cache before // the distribution forwards another request to the origin to determine whether the // content has been updated. The value specified applies only when the origin does - // not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and - // Expires to objects. + // not add HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , + // and Expires to objects. DefaultTTL *int64 // An object that describes the cookies that are forwarded to the origin. Your @@ -841,8 +752,8 @@ type CacheSettings struct { // The maximum amount of time that objects stay in the distribution's cache before // the distribution forwards another request to the origin to determine whether the // object has been updated. The value specified applies only when the origin adds - // HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires - // to objects. + // HTTP headers such as Cache-Control max-age , Cache-Control s-maxage , and + // Expires to objects. MaximumTTL *int64 // The minimum amount of time that objects stay in the distribution's cache before @@ -889,7 +800,7 @@ type Certificate struct { // certificate. KeyAlgorithm *string - // The name of the certificate (e.g., my-certificate). + // The name of the certificate (e.g., my-certificate ). Name *string // The timestamp when the certificate expires. @@ -902,57 +813,48 @@ type Certificate struct { // Lightsail. RenewalSummary *RenewalSummary - // The validation failure reason, if any, of the certificate. The following failure - // reasons are possible: - // - // * NO_AVAILABLE_CONTACTS - This failure applies to email - // validation, which is not available for Lightsail certificates. - // - // * - // ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to - // process this certificate request. This can happen as a fraud-protection measure, - // such as when the domain ranks within the Alexa top 1000 websites. To provide the - // required information, use the Amazon Web Services Support Center - // (https://console.aws.amazon.com/support/home) to contact Amazon Web Services - // Support. You cannot request a certificate for Amazon-owned domain names such as - // those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. - // - // * - // DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request - // was reported as an unsafe domain by VirusTotal - // (https://www.virustotal.com/gui/home/url). To correct the problem, search for - // your domain name on the VirusTotal (https://www.virustotal.com/gui/home/url) - // website. If your domain is reported as suspicious, see Google Help for Hacked - // Websites (https://developers.google.com/web/fundamentals/security/hacked) to - // learn what you can do. If you believe that the result is a false positive, - // notify the organization that is reporting the domain. VirusTotal is an aggregate - // of several antivirus and URL scanners and cannot remove your domain from a block - // list itself. After you correct the problem and the VirusTotal registry has been - // updated, request a new certificate. If you see this error and your domain is not - // included in the VirusTotal list, visit the Amazon Web Services Support Center - // (https://console.aws.amazon.com/support/home) and create a case. - // - // * - // INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate - // request is not valid. Typically, this is because a domain name in the request is - // not a valid top-level domain. Try to request a certificate again, correcting any - // spelling errors or typos that were in the failed request, and ensure that all - // domain names in the request are for valid top-level domains. For example, you - // cannot request a certificate for example.invalidpublicdomain because - // invalidpublicdomain is not a valid top-level domain. - // - // * OTHER - Typically, this - // failure occurs when there is a typographical error in one or more of the domain - // names in the certificate request. Try to request a certificate again, correcting - // any spelling errors or typos that were in the failed request. + // The validation failure reason, if any, of the certificate. The following + // failure reasons are possible: + // - NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is + // not available for Lightsail certificates. + // - ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information + // to process this certificate request. This can happen as a fraud-protection + // measure, such as when the domain ranks within the Alexa top 1000 websites. To + // provide the required information, use the Amazon Web Services Support Center (https://console.aws.amazon.com/support/home) + // to contact Amazon Web Services Support. You cannot request a certificate for + // Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, + // or elasticbeanstalk.com. + // - DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate + // request was reported as an unsafe domain by VirusTotal (https://www.virustotal.com/gui/home/url) + // . To correct the problem, search for your domain name on the VirusTotal (https://www.virustotal.com/gui/home/url) + // website. If your domain is reported as suspicious, see Google Help for Hacked + // Websites (https://developers.google.com/web/fundamentals/security/hacked) to + // learn what you can do. If you believe that the result is a false positive, + // notify the organization that is reporting the domain. VirusTotal is an aggregate + // of several antivirus and URL scanners and cannot remove your domain from a block + // list itself. After you correct the problem and the VirusTotal registry has been + // updated, request a new certificate. If you see this error and your domain is not + // included in the VirusTotal list, visit the Amazon Web Services Support Center (https://console.aws.amazon.com/support/home) + // and create a case. + // - INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate + // request is not valid. Typically, this is because a domain name in the request is + // not a valid top-level domain. Try to request a certificate again, correcting any + // spelling errors or typos that were in the failed request, and ensure that all + // domain names in the request are for valid top-level domains. For example, you + // cannot request a certificate for example.invalidpublicdomain because + // invalidpublicdomain is not a valid top-level domain. + // - OTHER - Typically, this failure occurs when there is a typographical error + // in one or more of the domain names in the certificate request. Try to request a + // certificate again, correcting any spelling errors or typos that were in the + // failed request. RequestFailureReason *string // The reason the certificate was revoked. This value is present only when the - // certificate status is REVOKED. + // certificate status is REVOKED . RevocationReason *string // The timestamp when the certificate was revoked. This value is present only when - // the certificate status is REVOKED. + // the certificate status is REVOKED . RevokedAt *time.Time // The serial number of the certificate. @@ -961,8 +863,8 @@ type Certificate struct { // The validation status of the certificate. Status CertificateStatus - // An array of strings that specify the alternate domains (e.g., example2.com) and - // subdomains (e.g., blog.example.com) of the certificate. + // An array of strings that specify the alternate domains (e.g., example2.com ) and + // subdomains (e.g., blog.example.com ) of the certificate. SubjectAlternativeNames []string // The support code. Include this code in your email to support when you have @@ -971,8 +873,8 @@ type Certificate struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -994,8 +896,8 @@ type CertificateSummary struct { DomainName *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -1026,7 +928,7 @@ type CloudFormationStackRecord struct { // CloudFormationStackRecord followed by a GUID. Name *string - // The Lightsail resource type (e.g., CloudFormationStackRecord). + // The Lightsail resource type (e.g., CloudFormationStackRecord ). ResourceType ResourceType // A list of objects describing the source of the CloudFormation stack record. @@ -1038,8 +940,8 @@ type CloudFormationStackRecord struct { noSmithyDocumentSerde } -// Describes the source of a CloudFormation stack record (i.e., the export snapshot -// record). +// Describes the source of a CloudFormation stack record (i.e., the export +// snapshot record). type CloudFormationStackRecordSourceInfo struct { // The Amazon Resource Name (ARN) of the export snapshot record. @@ -1048,15 +950,15 @@ type CloudFormationStackRecordSourceInfo struct { // The name of the record. Name *string - // The Lightsail resource type (e.g., ExportSnapshotRecord). + // The Lightsail resource type (e.g., ExportSnapshotRecord ). ResourceType CloudFormationStackRecordSourceType noSmithyDocumentSerde } -// Describes a contact method. A contact method is a way to send you notifications. -// For more information, see Notifications in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// Describes a contact method. A contact method is a way to send you +// notifications. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications) +// . type ContactMethod struct { // The Amazon Resource Name (ARN) of the contact method. @@ -1079,20 +981,16 @@ type ContactMethod struct { // The protocol of the contact method, such as email or SMS (text messaging). Protocol ContactProtocol - // The Lightsail resource type (e.g., ContactMethod). + // The Lightsail resource type (e.g., ContactMethod ). ResourceType ResourceType // The current status of the contact method. A contact method has the following // possible status: - // - // * PendingVerification - The contact method has not yet been - // verified, and the verification has not yet expired. - // - // * Valid - The contact - // method has been verified. - // - // * InValid - An attempt was made to verify the contact - // method, but the verification has expired. + // - PendingVerification - The contact method has not yet been verified, and the + // verification has not yet expired. + // - Valid - The contact method has been verified. + // - InValid - An attempt was made to verify the contact method, but the + // verification has expired. Status ContactMethodStatus // The support code. Include this code in your email to support when you have @@ -1113,17 +1011,17 @@ type Container struct { // The environment variables of the container. Environment map[string]string - // The name of the image used for the container. Container images sourced from your - // Lightsail container service, that are registered and stored on your service, - // start with a colon (:). For example, if your container service name is - // container-service-1, the container image label is mystaticsite, and you want to - // use the third (3) version of the registered container image, then you should - // specify :container-service-1.mystaticsite.3. To use the latest version of a - // container image, specify latest instead of a version number (for example, - // :container-service-1.mystaticsite.latest). Lightsail will automatically use the + // The name of the image used for the container. Container images sourced from + // your Lightsail container service, that are registered and stored on your + // service, start with a colon ( : ). For example, if your container service name + // is container-service-1 , the container image label is mystaticsite , and you + // want to use the third ( 3 ) version of the registered container image, then you + // should specify :container-service-1.mystaticsite.3 . To use the latest version + // of a container image, specify latest instead of a version number (for example, + // :container-service-1.mystaticsite.latest ). Lightsail will automatically use the // highest numbered version of the registered container image. Container images // sourced from a public registry like Docker Hub don't start with a colon. For - // example, nginx:latest or nginx. + // example, nginx:latest or nginx . Image *string // The open firewall ports of the container. @@ -1175,8 +1073,8 @@ type ContainerService struct { // value is null when there is no deployment in a pending state. NextDeployment *ContainerServiceDeployment - // The power specification of the container service. The power specifies the amount - // of RAM, the number of vCPUs, and the base price of the container service. + // The power specification of the container service. The power specifies the + // amount of RAM, the number of vCPUs, and the base price of the container service. Power ContainerServicePowerName // The ID of the power of the container service. @@ -1196,13 +1094,12 @@ type ContainerService struct { // An object that describes the configuration for the container service to access // private container image repositories, such as Amazon Elastic Container Registry // (Amazon ECR) private repositories. For more information, see Configuring access - // to an Amazon ECR private repository for an Amazon Lightsail container service - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) + // to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. PrivateRegistryAccess *PrivateRegistryAccess // The public domain name of the container service, such as example.com and - // www.example.com. You can specify up to four public domain names for a container + // www.example.com . You can specify up to four public domain names for a container // service. The domain names that you specify are used when you create a deployment // with a container configured as the public endpoint of your container service. If // you don't specify public domain names, then you can use the default domain of @@ -1214,7 +1111,7 @@ type ContainerService struct { // for your Lightsail container service. PublicDomainNames map[string][]string - // The Lightsail resource type of the container service (i.e., ContainerService). + // The Lightsail resource type of the container service (i.e., ContainerService ). ResourceType ResourceType // The scale specification of the container service. The scale specifies the @@ -1223,41 +1120,31 @@ type ContainerService struct { // The current state of the container service. The following container service // states are possible: - // - // * PENDING - The container service is being created. - // - // * - // READY - The container service is running but it does not have an active - // container deployment. - // - // * DEPLOYING - The container service is launching a - // container deployment. - // - // * RUNNING - The container service is running and it has - // an active container deployment. - // - // * UPDATING - The container service capacity or - // its custom domains are being updated. - // - // * DELETING - The container service is - // being deleted. - // - // * DISABLED - The container service is disabled, and its active - // deployment and containers, if any, are shut down. + // - PENDING - The container service is being created. + // - READY - The container service is running but it does not have an active + // container deployment. + // - DEPLOYING - The container service is launching a container deployment. + // - RUNNING - The container service is running and it has an active container + // deployment. + // - UPDATING - The container service capacity or its custom domains are being + // updated. + // - DELETING - The container service is being deleted. + // - DISABLED - The container service is disabled, and its active deployment and + // containers, if any, are shut down. State ContainerServiceState // An object that describes the current state of the container service. The state - // detail is populated only when a container service is in a PENDING, DEPLOYING, or - // UPDATING state. + // detail is populated only when a container service is in a PENDING , DEPLOYING , + // or UPDATING state. StateDetail *ContainerServiceStateDetail // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag // The publicly accessible URL of the container service. If no public endpoint is - // specified in the currentDeployment, this URL returns a 404 response. + // specified in the currentDeployment , this URL returns a 404 response. Url *string noSmithyDocumentSerde @@ -1279,20 +1166,15 @@ type ContainerServiceDeployment struct { // The state of the deployment. A deployment can be in one of the following // states: - // - // * Activating - The deployment is being created. - // - // * Active - The - // deployment was successfully created, and it's currently running on the container - // service. The container service can have only one deployment in an active state - // at a time. - // - // * Inactive - The deployment was previously successfully created, but - // it is not currently running on the container service. - // - // * Failed - The deployment - // failed. Use the GetContainerLog action to view the log events for the containers - // in the deployment to try to determine the reason for the failure. + // - Activating - The deployment is being created. + // - Active - The deployment was successfully created, and it's currently running + // on the container service. The container service can have only one deployment in + // an active state at a time. + // - Inactive - The deployment was previously successfully created, but it is not + // currently running on the container service. + // - Failed - The deployment failed. Use the GetContainerLog action to view the + // log events for the containers in the deployment to try to determine the reason + // for the failure. State ContainerServiceDeploymentState // The version number of the deployment. @@ -1322,9 +1204,8 @@ type ContainerServiceDeploymentRequest struct { // can use the ARN of the role to create a trust relationship between your // Lightsail container service and an Amazon ECR private repository in your Amazon // Web Services account. This allows your container service to pull images from -// Amazon ECR private repositories. For more information, see Configuring access to -// an Amazon ECR private repository for an Amazon Lightsail container service -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) +// Amazon ECR private repositories. For more information, see Configuring access +// to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. type ContainerServiceECRImagePullerRole struct { @@ -1337,8 +1218,8 @@ type ContainerServiceECRImagePullerRole struct { noSmithyDocumentSerde } -// Describes a request to activate or deactivate the role that you can use to grant -// an Amazon Lightsail container service access to Amazon Elastic Container +// Describes a request to activate or deactivate the role that you can use to +// grant an Amazon Lightsail container service access to Amazon Elastic Container // Registry (Amazon ECR) private repositories. When activated, Lightsail creates an // Identity and Access Management (IAM) role for the specified Lightsail container // service. You can use the ARN of the role to create a trust relationship between @@ -1346,8 +1227,7 @@ type ContainerServiceECRImagePullerRole struct { // Amazon Web Services account. This allows your container service to pull images // from Amazon ECR private repositories. For more information, see Configuring // access to an Amazon ECR private repository for an Amazon Lightsail container -// service -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) +// service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. type ContainerServiceECRImagePullerRoleRequest struct { @@ -1379,28 +1259,28 @@ type ContainerServiceEndpoint struct { type ContainerServiceHealthCheckConfig struct { // The number of consecutive health checks successes required before moving the - // container to the Healthy state. The default value is 2. + // container to the Healthy state. The default value is 2 . HealthyThreshold *int32 // The approximate interval, in seconds, between health checks of an individual - // container. You can specify between 5 and 300 seconds. The default value is 5. + // container. You can specify between 5 and 300 seconds. The default value is 5 . IntervalSeconds *int32 // The path on the container on which to perform the health check. The default - // value is /. + // value is / . Path *string // The HTTP codes to use when checking for a successful response from a container. - // You can specify values between 200 and 499. You can specify multiple values (for - // example, 200,202) or a range of values (for example, 200-299). + // You can specify values between 200 and 499 . You can specify multiple values + // (for example, 200,202 ) or a range of values (for example, 200-299 ). SuccessCodes *string // The amount of time, in seconds, during which no response means a failed health - // check. You can specify between 2 and 60 seconds. The default value is 2. + // check. You can specify between 2 and 60 seconds. The default value is 2 . TimeoutSeconds *int32 // The number of consecutive health check failures required before moving the - // container to the Unhealthy state. The default value is 2. + // container to the Unhealthy state. The default value is 2 . UnhealthyThreshold *int32 noSmithyDocumentSerde @@ -1431,10 +1311,10 @@ type ContainerServicePower struct { // container services. IsActive *bool - // The friendly name of the power (e.g., nano). + // The friendly name of the power (e.g., nano ). Name *string - // The ID of the power (e.g., nano-1). + // The ID of the power (e.g., nano-1 ). PowerId *string // The monthly price of the power in USD. @@ -1460,8 +1340,8 @@ type ContainerServiceRegistryLogin struct { // container image registry of a Lightsail account Password *string - // The address to use to push container images to the container image registry of a - // Lightsail account. + // The address to use to push container images to the container image registry of + // a Lightsail account. Registry *string // The container service registry username to use to push container images to the @@ -1476,46 +1356,31 @@ type ContainerServiceStateDetail struct { // The state code of the container service. The following state codes are // possible: - // - // * The following state codes are possible if your container service is - // in a DEPLOYING or UPDATING state: - // - // * CREATING_SYSTEM_RESOURCES - The system - // resources for your container service are being created. - // - // * - // CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container - // service are being created. - // - // * PROVISIONING_CERTIFICATE - The SSL/TLS certificate - // for your container service is being created. - // - // * PROVISIONING_SERVICE - Your - // container service is being provisioned. - // - // * CREATING_DEPLOYMENT - Your deployment - // is being created on your container service. - // - // * EVALUATING_HEALTH_CHECK - The - // health of your deployment is being evaluated. - // - // * ACTIVATING_DEPLOYMENT - Your - // deployment is being activated. - // - // * The following state codes are possible if your - // container service is in a PENDING state: - // - // * CERTIFICATE_LIMIT_EXCEEDED - The - // SSL/TLS certificate required for your container service exceeds the maximum - // number of certificates allowed for your account. - // - // * UNKNOWN_ERROR - An error was - // experienced when your container service was being created. + // - The following state codes are possible if your container service is in a + // DEPLOYING or UPDATING state: + // - CREATING_SYSTEM_RESOURCES - The system resources for your container service + // are being created. + // - CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your + // container service are being created. + // - PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container + // service is being created. + // - PROVISIONING_SERVICE - Your container service is being provisioned. + // - CREATING_DEPLOYMENT - Your deployment is being created on your container + // service. + // - EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated. + // - ACTIVATING_DEPLOYMENT - Your deployment is being activated. + // - The following state codes are possible if your container service is in a + // PENDING state: + // - CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your + // container service exceeds the maximum number of certificates allowed for your + // account. + // - UNKNOWN_ERROR - An error was experienced when your container service was + // being created. Code ContainerServiceStateDetailCode - // A message that provides more information for the state code. The state detail is - // populated only when a container service is in a PENDING, DEPLOYING, or UPDATING - // state. + // A message that provides more information for the state code. The state detail + // is populated only when a container service is in a PENDING , DEPLOYING , or + // UPDATING state. Message *string noSmithyDocumentSerde @@ -1531,8 +1396,8 @@ type CookieObject struct { CookiesAllowList []string // Specifies which cookies to forward to the distribution's origin for a cache - // behavior: all, none, or allow-list to forward only the cookies specified in the - // cookiesAllowList parameter. + // behavior: all , none , or allow-list to forward only the cookies specified in + // the cookiesAllowList parameter. Option ForwardValues noSmithyDocumentSerde @@ -1576,9 +1441,10 @@ type Disk struct { // The resources to which the disk is attached. AttachedTo *string - // (Deprecated) The attachment state of the disk. In releases prior to November 14, - // 2017, this parameter returned attached for system disks in the API response. It - // is now deprecated, but still included in the response. Use isAttached instead. + // (Deprecated) The attachment state of the disk. In releases prior to November + // 14, 2017, this parameter returned attached for system disks in the API + // response. It is now deprecated, but still included in the response. Use + // isAttached instead. // // Deprecated: This member has been deprecated. AttachmentState *string @@ -1616,7 +1482,7 @@ type Disk struct { // The disk path. Path *string - // The Lightsail resource type (e.g., Disk). + // The Lightsail resource type (e.g., Disk ). ResourceType ResourceType // The size of the disk in GB. @@ -1631,8 +1497,8 @@ type Disk struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -1651,7 +1517,7 @@ type DiskInfo struct { // The disk path. Path *string - // The size of the disk in GB (e.g., 32). + // The size of the disk in GB (e.g., 32 ). SizeInGb *int32 noSmithyDocumentSerde @@ -1660,10 +1526,10 @@ type DiskInfo struct { // Describes a block storage disk mapping. type DiskMap struct { - // The new disk name (e.g., my-new-disk). + // The new disk name (e.g., my-new-disk ). NewDiskName *string - // The original disk path exposed to the instance (for example, /dev/sdh). + // The original disk path exposed to the instance (for example, /dev/sdh ). OriginalDiskPath *string noSmithyDocumentSerde @@ -1700,13 +1566,13 @@ type DiskSnapshot struct { // The AWS Region and Availability Zone where the disk snapshot was created. Location *ResourceLocation - // The name of the disk snapshot (e.g., my-disk-snapshot). + // The name of the disk snapshot (e.g., my-disk-snapshot ). Name *string // The progress of the snapshot. Progress *string - // The Lightsail resource type (e.g., DiskSnapshot). + // The Lightsail resource type (e.g., DiskSnapshot ). ResourceType ResourceType // The size of the disk in GB. @@ -1721,8 +1587,8 @@ type DiskSnapshot struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -1731,7 +1597,7 @@ type DiskSnapshot struct { // Describes a disk snapshot. type DiskSnapshotInfo struct { - // The size of the disk in GB (e.g., 32). + // The size of the disk in GB (e.g., 32 ). SizeInGb *int32 noSmithyDocumentSerde @@ -1769,21 +1635,15 @@ type DistributionBundle struct { // record addition fails, or if you manage the DNS of your domain using a // third-party service, then you must manually add the CNAME records to the DNS of // your domain. For more information, see Verify an SSL/TLS certificate in Amazon -// Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/verify-tls-ssl-certificate-using-dns-cname-https) +// Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/verify-tls-ssl-certificate-using-dns-cname-https) // in the Amazon Lightsail Developer Guide. type DnsRecordCreationState struct { // The status code for the automated DNS record creation. Following are the // possible values: - // - // * SUCCEEDED - The validation records were successfully added - // to the domain. - // - // * STARTED - The automatic DNS record creation has started. - // - // * - // FAILED - The validation records failed to be added to the domain. + // - SUCCEEDED - The validation records were successfully added to the domain. + // - STARTED - The automatic DNS record creation has started. + // - FAILED - The validation records failed to be added to the domain. Code DnsRecordCreationStateCode // The message that describes the reason for the status code. @@ -1796,7 +1656,8 @@ type DnsRecordCreationState struct { type Domain struct { // The Amazon Resource Name (ARN) of the domain recordset (e.g., - // arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE). + // arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE + // ). Arn *string // The date when the domain recordset was created. @@ -1824,8 +1685,8 @@ type Domain struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -1837,7 +1698,7 @@ type DomainEntry struct { // The ID of the domain recordset entry. Id *string - // When true, specifies whether the domain entry is an alias used by the Lightsail + // When true , specifies whether the domain entry is an alias used by the Lightsail // load balancer, Lightsail container service, Lightsail content delivery network // (CDN) distribution, or another Amazon Web Services resource. You can include an // alias (A type) record in your request, which points to the DNS name of a load @@ -1848,42 +1709,35 @@ type DomainEntry struct { // The name of the domain. Name *string - // (Deprecated) The options for the domain entry. In releases prior to November 29, - // 2017, this parameter was not included in the API response. It is now deprecated. + // (Deprecated) The options for the domain entry. In releases prior to November + // 29, 2017, this parameter was not included in the API response. It is now + // deprecated. // // Deprecated: This member has been deprecated. Options map[string]string - // The target IP address (e.g., 192.0.2.0), or AWS name server (e.g., - // ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like - // ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For - // Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For - // Lightsail container services, the value looks like - // container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to + // The target IP address (e.g., 192.0.2.0 ), or AWS name server (e.g., + // ns-111.awsdns-22.com. ). For Lightsail load balancers, the value looks like + // ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . For + // Lightsail distributions, the value looks like exampled1182ne.cloudfront.net . + // For Lightsail container services, the value looks like + // container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com . Be sure to // also set isAlias to true when setting up an A record for a Lightsail load // balancer, distribution, or container service. Target *string - // The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), - // canonical name (CNAME), mail exchanger (MX), name server (NS), start of + // The type of domain entry, such as address for IPv4 (A), address for IPv6 + // (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of // authority (SOA), service locator (SRV), or text (TXT). The following domain // entry types can be used: - // - // * A - // - // * AAAA - // - // * CNAME - // - // * MX - // - // * NS - // - // * SOA - // - // * SRV - // - // * TXT + // - A + // - AAAA + // - CNAME + // - MX + // - NS + // - SOA + // - SRV + // - TXT Type *string noSmithyDocumentSerde @@ -1900,11 +1754,11 @@ type DomainValidationRecord struct { DnsRecordCreationState *DnsRecordCreationState // The domain name of the certificate validation record. For example, example.com - // or www.example.com. + // or www.example.com . DomainName *string - // An object that describes the DNS records to add to your domain's DNS to validate - // it for the certificate. + // An object that describes the DNS records to add to your domain's DNS to + // validate it for the certificate. ResourceRecord *ResourceRecord // The validation status of the record. @@ -1975,7 +1829,7 @@ type ExportSnapshotRecord struct { // The export snapshot record name. Name *string - // The Lightsail resource type (e.g., ExportSnapshotRecord). + // The Lightsail resource type (e.g., ExportSnapshotRecord ). ResourceType ResourceType // A list of objects describing the source of the export snapshot record. @@ -2011,7 +1865,7 @@ type ExportSnapshotRecordSourceInfo struct { // The name of the source instance or disk snapshot. Name *string - // The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot). + // The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot ). ResourceType ExportSnapshotRecordSourceType noSmithyDocumentSerde @@ -2021,7 +1875,7 @@ type ExportSnapshotRecordSourceInfo struct { // For the headers that you specify, your distribution caches separate versions of // the specified content based on the header values in viewer requests. For // example, suppose viewer requests for logo.jpg contain a custom product header -// that has a value of either acme or apex, and you configure your distribution to +// that has a value of either acme or apex , and you configure your distribution to // cache your content based on values in the product header. Your distribution // forwards the product header to the origin and caches the response from the // origin once for each header value. @@ -2032,15 +1886,10 @@ type HeaderObject struct { // The headers that you want your distribution to forward to your origin and base // caching on. You can configure your distribution to do one of the following: - // - // * - // all - Forward all headers to your origin. - // - // * none - Forward only the default - // headers. - // - // * allow-list - Forward only the headers you specify using the - // headersAllowList parameter. + // - all - Forward all headers to your origin. + // - none - Forward only the default headers. + // - allow-list - Forward only the headers you specify using the headersAllowList + // parameter. Option ForwardValues noSmithyDocumentSerde @@ -2049,30 +1898,22 @@ type HeaderObject struct { // Describes the public SSH host keys or the RDP certificate. type HostKeyAttributes struct { - // The SSH host key algorithm or the RDP certificate format. For SSH host keys, the - // algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP - // certificates, the algorithm is always x509-cert. + // The SSH host key algorithm or the RDP certificate format. For SSH host keys, + // the algorithm may be ssh-rsa , ecdsa-sha2-nistp256 , ssh-ed25519 , etc. For RDP + // certificates, the algorithm is always x509-cert . Algorithm *string // The SHA-1 fingerprint of the returned SSH host key or RDP certificate. - // - // * - // Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 - // - // * Example - // of an SHA-1 RDP fingerprint: - // af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 + // - Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 + // - Example of an SHA-1 RDP fingerprint: + // af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45 FingerprintSHA1 *string // The SHA-256 fingerprint of the returned SSH host key or RDP certificate. - // - // * - // Example of an SHA-256 SSH fingerprint: - // SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o - // - // * Example of an SHA-256 RDP - // fingerprint: - // 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68 + // - Example of an SHA-256 SSH fingerprint: + // SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o + // - Example of an SHA-256 RDP fingerprint: + // 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68 FingerprintSHA256 *string // The returned RDP certificate is not valid after this point in time. This value @@ -2118,27 +1959,28 @@ type Instance struct { AddOns []AddOn // The Amazon Resource Name (ARN) of the instance (e.g., - // arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE). + // arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE + // ). Arn *string - // The blueprint ID (e.g., os_amlinux_2016_03). + // The blueprint ID (e.g., os_amlinux_2016_03 ). BlueprintId *string - // The friendly name of the blueprint (e.g., Amazon Linux). + // The friendly name of the blueprint (e.g., Amazon Linux ). BlueprintName *string - // The bundle for the instance (e.g., micro_1_0). + // The bundle for the instance (e.g., micro_1_0 ). BundleId *string - // The timestamp when the instance was created (e.g., 1479734909.17) in Unix time + // The timestamp when the instance was created (e.g., 1479734909.17 ) in Unix time // format. CreatedAt *time.Time // The size of the vCPU and the amount of RAM for the instance. Hardware *InstanceHardware - // The IP address type of the instance. The possible values are ipv4 for IPv4 only, - // and dualstack for IPv4 and IPv6. + // The IP address type of the instance. The possible values are ipv4 for IPv4 + // only, and dualstack for IPv4 and IPv6. IpAddressType IpAddressType // The IPv6 addresses of the instance. @@ -2153,7 +1995,7 @@ type Instance struct { // The metadata options for the Amazon Lightsail instance. MetadataOptions *InstanceMetadataOptions - // The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1). + // The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1 ). Name *string // Information about the public ports and monthly data transfer rates for the @@ -2166,14 +2008,14 @@ type Instance struct { // The public IP address of the instance. PublicIpAddress *string - // The type of resource (usually Instance). + // The type of resource (usually Instance ). ResourceType ResourceType // The name of the SSH key being used to connect to the instance (e.g., - // LightsailDefaultKeyPair). + // LightsailDefaultKeyPair ). SshKeyName *string - // The status code and the state (e.g., running) for the instance. + // The status code and the state (e.g., running ) for the instance. State *InstanceState // The support code. Include this code in your email to support when you have @@ -2182,11 +2024,11 @@ type Instance struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag - // The user name for connecting to the instance (e.g., ec2-user). + // The user name for connecting to the instance (e.g., ec2-user ). Username *string noSmithyDocumentSerde @@ -2197,8 +2039,8 @@ type Instance struct { type InstanceAccessDetails struct { // For SSH access, the public key to use when accessing your instance For OpenSSH - // clients (e.g., command line SSH), you should save this value to - // tempkey-cert.pub. + // clients (e.g., command line SSH), you should save this value to tempkey-cert.pub + // . CertKey *string // For SSH access, the date on which the temporary keys expire. @@ -2216,8 +2058,8 @@ type InstanceAccessDetails struct { // For RDP access, the password for your Amazon Lightsail instance. Password will // be an empty string if the password for your new instance is not ready yet. When // you create an instance, it can take up to 15 minutes for the instance to be - // ready. If you create an instance using any key pair other than the default - // (LightsailDefaultKeyPair), password will always be an empty string. If you + // ready. If you create an instance using any key pair other than the default ( + // LightsailDefaultKeyPair ), password will always be an empty string. If you // change the Administrator password on the instance, Lightsail will continue to // return the original password value. When accessing the instance using RDP, you // need to manually enter the Administrator password after changing it from the @@ -2231,7 +2073,7 @@ type InstanceAccessDetails struct { PasswordData *PasswordData // For SSH access, the temporary private key. For OpenSSH clients (e.g., command - // line SSH), you should save this value to tempkey). + // line SSH), you should save this value to tempkey ). PrivateKey *string // The protocol for these Amazon Lightsail instance access details. @@ -2252,39 +2094,32 @@ type InstanceEntry struct { // This member is required. AvailabilityZone *string - // The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance. + // The instance type (e.g., t2.micro ) to use for the new Amazon EC2 instance. // // This member is required. InstanceType *string // The port configuration to use for the new Amazon EC2 instance. The following // configuration options are available: - // - // * DEFAULT - Use the default firewall - // settings from the Lightsail instance blueprint. If this is specified, then IPv4 - // and IPv6 will be configured for the new instance that is created in Amazon - // EC2. - // - // * INSTANCE - Use the configured firewall settings from the source - // Lightsail instance. If this is specified, the new instance that is created in - // Amazon EC2 will be configured to match the configuration of the source Lightsail - // instance. For example, if the source instance is configured for dual-stack (IPv4 - // and IPv6), then IPv4 and IPv6 will be configured for the new instance that is - // created in Amazon EC2. If the source instance is configured for IPv4 only, then - // only IPv4 will be configured for the new instance that is created in Amazon - // EC2. - // - // * NONE - Use the default Amazon EC2 security group. If this is specified, - // then only IPv4 will be configured for the new instance that is created in Amazon - // EC2. - // - // * CLOSED - All ports closed. If this is specified, then only IPv4 will be - // configured for the new instance that is created in Amazon EC2. - // - // If you - // configured lightsail-connect as a cidrListAliases on your instance, or if you - // chose to allow the Lightsail browser-based SSH or RDP clients to connect to your - // instance, that configuration is not carried over to your new Amazon EC2 + // - DEFAULT - Use the default firewall settings from the Lightsail instance + // blueprint. If this is specified, then IPv4 and IPv6 will be configured for the + // new instance that is created in Amazon EC2. + // - INSTANCE - Use the configured firewall settings from the source Lightsail + // instance. If this is specified, the new instance that is created in Amazon EC2 + // will be configured to match the configuration of the source Lightsail instance. + // For example, if the source instance is configured for dual-stack (IPv4 and + // IPv6), then IPv4 and IPv6 will be configured for the new instance that is + // created in Amazon EC2. If the source instance is configured for IPv4 only, then + // only IPv4 will be configured for the new instance that is created in Amazon EC2. + // + // - NONE - Use the default Amazon EC2 security group. If this is specified, then + // only IPv4 will be configured for the new instance that is created in Amazon EC2. + // + // - CLOSED - All ports closed. If this is specified, then only IPv4 will be + // configured for the new instance that is created in Amazon EC2. + // If you configured lightsail-connect as a cidrListAliases on your instance, or + // if you chose to allow the Lightsail browser-based SSH or RDP clients to connect + // to your instance, that configuration is not carried over to your new Amazon EC2 // instance. // // This member is required. @@ -2299,10 +2134,10 @@ type InstanceEntry struct { SourceName *string // A launch script you can create that configures a server with additional user - // data. For example, you might want to run apt-get -y update. Depending on the + // data. For example, you might want to run apt-get -y update . Depending on the // machine image you choose, the command to get software on your instance varies. - // Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses - // pkg. + // Amazon Linux and CentOS use yum , Debian and Ubuntu use apt-get , and FreeBSD + // uses pkg . UserData *string noSmithyDocumentSerde @@ -2317,7 +2152,7 @@ type InstanceHardware struct { // The disks attached to the instance. Disks []Disk - // The amount of RAM in GB on the instance (e.g., 1.0). + // The amount of RAM in GB on the instance (e.g., 1.0 ). RamSizeInGb *float32 noSmithyDocumentSerde @@ -2329,58 +2164,38 @@ type InstanceHealthSummary struct { // Describes the overall instance health. Valid values are below. InstanceHealth InstanceHealthState - // More information about the instance health. If the instanceHealth is healthy, - // then an instanceHealthReason value is not provided. If instanceHealth is - // initial, the instanceHealthReason value can be one of the following: - // - // * - // Lb.RegistrationInProgress - The target instance is in the process of being - // registered with the load balancer. - // - // * Lb.InitialHealthChecking - The Lightsail - // load balancer is still sending the target instance the minimum number of health - // checks required to determine its health status. - // - // If instanceHealth is unhealthy, - // the instanceHealthReason value can be one of the following: - // - // * - // Instance.ResponseCodeMismatch - The health checks did not return an expected - // HTTP code. - // - // * Instance.Timeout - The health check requests timed out. - // - // * - // Instance.FailedHealthChecks - The health checks failed because the connection to - // the target instance timed out, the target instance response was malformed, or - // the target instance failed the health check for an unknown reason. - // - // * - // Lb.InternalError - The health checks failed due to an internal error. - // - // If - // instanceHealth is unused, the instanceHealthReason value can be one of the + // More information about the instance health. If the instanceHealth is healthy , + // then an instanceHealthReason value is not provided. If instanceHealth is initial + // , the instanceHealthReason value can be one of the following: + // - Lb.RegistrationInProgress - The target instance is in the process of being + // registered with the load balancer. + // - Lb.InitialHealthChecking - The Lightsail load balancer is still sending the + // target instance the minimum number of health checks required to determine its + // health status. + // If instanceHealth is unhealthy , the instanceHealthReason value can be one of + // the following: + // - Instance.ResponseCodeMismatch - The health checks did not return an expected + // HTTP code. + // - Instance.Timeout - The health check requests timed out. + // - Instance.FailedHealthChecks - The health checks failed because the + // connection to the target instance timed out, the target instance response was + // malformed, or the target instance failed the health check for an unknown reason. + // + // - Lb.InternalError - The health checks failed due to an internal error. + // If instanceHealth is unused , the instanceHealthReason value can be one of the // following: - // - // * Instance.NotRegistered - The target instance is not registered - // with the target group. - // - // * Instance.NotInUse - The target group is not used by - // any load balancer, or the target instance is in an Availability Zone that is not - // enabled for its load balancer. - // - // * Instance.IpUnusable - The target IP address is - // reserved for use by a Lightsail load balancer. - // - // * Instance.InvalidState - The - // target is in the stopped or terminated state. - // - // If instanceHealth is draining, - // the instanceHealthReason value can be one of the following: - // - // * - // Instance.DeregistrationInProgress - The target instance is in the process of - // being deregistered and the deregistration delay period has not expired. + // - Instance.NotRegistered - The target instance is not registered with the + // target group. + // - Instance.NotInUse - The target group is not used by any load balancer, or + // the target instance is in an Availability Zone that is not enabled for its load + // balancer. + // - Instance.IpUnusable - The target IP address is reserved for use by a + // Lightsail load balancer. + // - Instance.InvalidState - The target is in the stopped or terminated state. + // If instanceHealth is draining , the instanceHealthReason value can be one of + // the following: + // - Instance.DeregistrationInProgress - The target instance is in the process of + // being deregistered and the deregistration delay period has not expired. InstanceHealthReason InstanceHealthReason // The name of the Lightsail instance for which you are requesting health check @@ -2394,42 +2209,38 @@ type InstanceHealthSummary struct { type InstanceMetadataOptions struct { // Indicates whether the HTTP metadata endpoint on your instances is enabled or - // disabled. If the value is disabled, you cannot access your instance metadata. + // disabled. If the value is disabled , you cannot access your instance metadata. HttpEndpoint HttpEndpoint - // Indicates whether the IPv6 endpoint for the instance metadata service is enabled - // or disabled. + // Indicates whether the IPv6 endpoint for the instance metadata service is + // enabled or disabled. HttpProtocolIpv6 HttpProtocolIpv6 - // The desired HTTP PUT response hop limit for instance metadata requests. A larger - // number means that the instance metadata requests can travel farther. + // The desired HTTP PUT response hop limit for instance metadata requests. A + // larger number means that the instance metadata requests can travel farther. HttpPutResponseHopLimit *int32 // The state of token usage for your instance metadata requests. If the state is - // optional, you can choose whether to retrieve instance metadata with a signed + // optional , you can choose whether to retrieve instance metadata with a signed // token header on your request. If you retrieve the IAM role credentials without a // token, the version 1.0 role credentials are returned. If you retrieve the IAM // role credentials by using a valid signed token, the version 2.0 role credentials - // are returned. If the state is required, you must send a signed token header with - // all instance metadata retrieval requests. In this state, retrieving the IAM role - // credential always returns the version 2.0 credentials. The version 1.0 + // are returned. If the state is required , you must send a signed token header + // with all instance metadata retrieval requests. In this state, retrieving the IAM + // role credential always returns the version 2.0 credentials. The version 1.0 // credentials are not available. Not all instance blueprints in Lightsail support // version 2.0 credentials. Use the MetadataNoToken instance metric to track the // number of calls to the instance metadata service that are using version 1.0 // credentials. For more information, see Viewing instance metrics in Amazon - // Lightsail - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics) + // Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics) // in the Amazon Lightsail Developer Guide. HttpTokens HttpTokens // The state of the metadata option changes. The following states are possible: - // - // * - // pending - The metadata options are being updated. The instance is not yet ready - // to process metadata traffic with the new selection. - // - // * applied - The metadata - // options have been successfully applied to the instance. + // - pending - The metadata options are being updated. The instance is not yet + // ready to process metadata traffic with the new selection. + // - applied - The metadata options have been successfully applied to the + // instance. State InstanceMetadataState noSmithyDocumentSerde @@ -2451,105 +2262,87 @@ type InstanceNetworking struct { // Describes information about ports for an Amazon Lightsail instance. type InstancePortInfo struct { - // The access direction (inbound or outbound). Lightsail currently supports only + // The access direction ( inbound or outbound ). Lightsail currently supports only // inbound access direction. AccessDirection AccessDirection - // The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or - // Custom if a specific IP address or range of IP addresses is allowed. + // The location from which access is allowed. For example, Anywhere (0.0.0.0/0) , + // or Custom if a specific IP address or range of IP addresses is allowed. AccessFrom *string - // The type of access (Public or Private). + // The type of access ( Public or Private ). AccessType PortAccessType - // An alias that defines access for a preconfigured range of IP addresses. The only - // alias currently supported is lightsail-connect, which allows IP addresses of the - // browser-based RDP/SSH client in the Lightsail console to connect to your + // An alias that defines access for a preconfigured range of IP addresses. The + // only alias currently supported is lightsail-connect , which allows IP addresses + // of the browser-based RDP/SSH client in the Lightsail console to connect to your // instance. CidrListAliases []string - // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. The ipv6Cidrs - // parameter lists the IPv6 addresses that are allowed to connect to an instance. - // For more information about CIDR block notation, see Classless Inter-Domain - // Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. The + // ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an + // instance. For more information about CIDR block notation, see Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Cidrs []string // The common name of the port information. CommonName *string // The first port in a range of open ports on an instance. Allowed ports: - // - // * TCP - // and UDP - 0 to 65535 - // - // * ICMP - The ICMP type for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . FromPort int32 - // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. Only devices with - // an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should - // be used. The cidrs parameter lists the IPv4 addresses that are allowed to - // connect to an instance. For more information about CIDR block notation, see - // Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. Only + // devices with an IPv6 address can connect to an instance through IPv6; otherwise, + // IPv4 should be used. The cidrs parameter lists the IPv4 addresses that are + // allowed to connect to an instance. For more information about CIDR block + // notation, see Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Ipv6Cidrs []string // The IP protocol name. The name can be one of the following: - // - // * tcp - - // Transmission Control Protocol (TCP) provides reliable, ordered, and - // error-checked delivery of streamed data between applications running on hosts - // communicating by an IP network. If you have an application that doesn't require - // reliable data stream service, use UDP instead. - // - // * all - All transport layer - // protocol types. For more general information, see Transport layer - // (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. - // - // * udp - With User - // Datagram Protocol (UDP), computer applications can send messages (or datagrams) - // to other hosts on an Internet Protocol (IP) network. Prior communications are - // not required to set up transmission channels or data paths. Applications that - // don't require reliable data stream service can use UDP, which provides a - // connectionless datagram service that emphasizes reduced latency over - // reliability. If you do require reliable data stream service, use TCP instead. - // - // * - // icmp - Internet Control Message Protocol (ICMP) is used to send error messages - // and operational information indicating success or failure when communicating - // with an instance. For example, an error is indicated when an instance could not - // be reached. When you specify icmp as the protocol, you must specify the ICMP - // type using the fromPort parameter, and ICMP code using the toPort parameter. + // - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and + // error-checked delivery of streamed data between applications running on hosts + // communicating by an IP network. If you have an application that doesn't require + // reliable data stream service, use UDP instead. + // - all - All transport layer protocol types. For more general information, see + // Transport layer (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. + // - udp - With User Datagram Protocol (UDP), computer applications can send + // messages (or datagrams) to other hosts on an Internet Protocol (IP) network. + // Prior communications are not required to set up transmission channels or data + // paths. Applications that don't require reliable data stream service can use UDP, + // which provides a connectionless datagram service that emphasizes reduced latency + // over reliability. If you do require reliable data stream service, use TCP + // instead. + // - icmp - Internet Control Message Protocol (ICMP) is used to send error + // messages and operational information indicating success or failure when + // communicating with an instance. For example, an error is indicated when an + // instance could not be reached. When you specify icmp as the protocol , you + // must specify the ICMP type using the fromPort parameter, and ICMP code using + // the toPort parameter. Protocol NetworkProtocol // The last port in a range of open ports on an instance. Allowed ports: - // - // * TCP and - // UDP - 0 to 65535 - // - // * ICMP - The ICMP code for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . ToPort int32 noSmithyDocumentSerde @@ -2559,95 +2352,77 @@ type InstancePortInfo struct { // instance through the ports, and the protocol. type InstancePortState struct { - // An alias that defines access for a preconfigured range of IP addresses. The only - // alias currently supported is lightsail-connect, which allows IP addresses of the - // browser-based RDP/SSH client in the Lightsail console to connect to your + // An alias that defines access for a preconfigured range of IP addresses. The + // only alias currently supported is lightsail-connect , which allows IP addresses + // of the browser-based RDP/SSH client in the Lightsail console to connect to your // instance. CidrListAliases []string - // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. The ipv6Cidrs - // parameter lists the IPv6 addresses that are allowed to connect to an instance. - // For more information about CIDR block notation, see Classless Inter-Domain - // Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. The + // ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an + // instance. For more information about CIDR block notation, see Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Cidrs []string // The first port in a range of open ports on an instance. Allowed ports: - // - // * TCP - // and UDP - 0 to 65535 - // - // * ICMP - The ICMP type for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . FromPort int32 - // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. Only devices with - // an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should - // be used. The cidrs parameter lists the IPv4 addresses that are allowed to - // connect to an instance. For more information about CIDR block notation, see - // Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. Only + // devices with an IPv6 address can connect to an instance through IPv6; otherwise, + // IPv4 should be used. The cidrs parameter lists the IPv4 addresses that are + // allowed to connect to an instance. For more information about CIDR block + // notation, see Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Ipv6Cidrs []string // The IP protocol name. The name can be one of the following: - // - // * tcp - - // Transmission Control Protocol (TCP) provides reliable, ordered, and - // error-checked delivery of streamed data between applications running on hosts - // communicating by an IP network. If you have an application that doesn't require - // reliable data stream service, use UDP instead. - // - // * all - All transport layer - // protocol types. For more general information, see Transport layer - // (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. - // - // * udp - With User - // Datagram Protocol (UDP), computer applications can send messages (or datagrams) - // to other hosts on an Internet Protocol (IP) network. Prior communications are - // not required to set up transmission channels or data paths. Applications that - // don't require reliable data stream service can use UDP, which provides a - // connectionless datagram service that emphasizes reduced latency over - // reliability. If you do require reliable data stream service, use TCP instead. - // - // * - // icmp - Internet Control Message Protocol (ICMP) is used to send error messages - // and operational information indicating success or failure when communicating - // with an instance. For example, an error is indicated when an instance could not - // be reached. When you specify icmp as the protocol, you must specify the ICMP - // type using the fromPort parameter, and ICMP code using the toPort parameter. + // - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and + // error-checked delivery of streamed data between applications running on hosts + // communicating by an IP network. If you have an application that doesn't require + // reliable data stream service, use UDP instead. + // - all - All transport layer protocol types. For more general information, see + // Transport layer (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. + // - udp - With User Datagram Protocol (UDP), computer applications can send + // messages (or datagrams) to other hosts on an Internet Protocol (IP) network. + // Prior communications are not required to set up transmission channels or data + // paths. Applications that don't require reliable data stream service can use UDP, + // which provides a connectionless datagram service that emphasizes reduced latency + // over reliability. If you do require reliable data stream service, use TCP + // instead. + // - icmp - Internet Control Message Protocol (ICMP) is used to send error + // messages and operational information indicating success or failure when + // communicating with an instance. For example, an error is indicated when an + // instance could not be reached. When you specify icmp as the protocol , you + // must specify the ICMP type using the fromPort parameter, and ICMP code using + // the toPort parameter. Protocol NetworkProtocol - // Specifies whether the instance port is open or closed. The port state for - // Lightsail instances is always open. + // Specifies whether the instance port is open or closed . The port state for + // Lightsail instances is always open . State PortState // The last port in a range of open ports on an instance. Allowed ports: - // - // * TCP and - // UDP - 0 to 65535 - // - // * ICMP - The ICMP code for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . ToPort int32 noSmithyDocumentSerde @@ -2657,26 +2432,28 @@ type InstancePortState struct { type InstanceSnapshot struct { // The Amazon Resource Name (ARN) of the snapshot (e.g., - // arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE). + // arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE + // ). Arn *string - // The timestamp when the snapshot was created (e.g., 1479907467.024). + // The timestamp when the snapshot was created (e.g., 1479907467.024 ). CreatedAt *time.Time // An array of disk objects containing information about all block storage disks. FromAttachedDisks []Disk - // The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A + // The blueprint ID from which you created the snapshot (e.g., os_debian_8_3 ). A // blueprint is a virtual private server (or instance) image used to create // instances quickly. FromBlueprintId *string - // The bundle ID from which you created the snapshot (e.g., micro_1_0). + // The bundle ID from which you created the snapshot (e.g., micro_1_0 ). FromBundleId *string // The Amazon Resource Name (ARN) of the instance from which the snapshot was // created (e.g., - // arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE). + // arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE + // ). FromInstanceArn *string // The instance from which the snapshot was created. @@ -2696,7 +2473,7 @@ type InstanceSnapshot struct { // null for instance snapshots. Progress *string - // The type of resource (usually InstanceSnapshot). + // The type of resource (usually InstanceSnapshot ). ResourceType ResourceType // The size in GB of the SSD. @@ -2711,8 +2488,8 @@ type InstanceSnapshot struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -2721,10 +2498,10 @@ type InstanceSnapshot struct { // Describes an instance snapshot. type InstanceSnapshotInfo struct { - // The blueprint ID from which the source instance (e.g., os_debian_8_3). + // The blueprint ID from which the source instance (e.g., os_debian_8_3 ). FromBlueprintId *string - // The bundle ID from which the source instance was created (e.g., micro_1_0). + // The bundle ID from which the source instance was created (e.g., micro_1_0 ). FromBundleId *string // A list of objects describing the disks that were attached to the source @@ -2740,7 +2517,7 @@ type InstanceState struct { // The status code for the instance. Code *int32 - // The state of the instance (e.g., running or pending). + // The state of the instance (e.g., running or pending ). Name *string noSmithyDocumentSerde @@ -2750,10 +2527,11 @@ type InstanceState struct { type KeyPair struct { // The Amazon Resource Name (ARN) of the key pair (e.g., - // arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE). + // arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE + // ). Arn *string - // The timestamp when the key pair was created (e.g., 1479816991.349). + // The timestamp when the key pair was created (e.g., 1479816991.349 ). CreatedAt *time.Time // The RSA fingerprint of the key pair. @@ -2765,7 +2543,7 @@ type KeyPair struct { // The friendly name of the SSH key pair. Name *string - // The resource type (usually KeyPair). + // The resource type (usually KeyPair ). ResourceType ResourceType // The support code. Include this code in your email to support when you have @@ -2774,8 +2552,8 @@ type KeyPair struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -2843,7 +2621,7 @@ type LightsailDistribution struct { // The public DNS of the origin. OriginPublicDNS *string - // The Lightsail resource type (e.g., Distribution). + // The Lightsail resource type (e.g., Distribution ). ResourceType ResourceType // The status of the distribution. @@ -2855,8 +2633,8 @@ type LightsailDistribution struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -2882,8 +2660,8 @@ type LoadBalancer struct { // the load balancer tries to make a request to the default (root) page. HealthCheckPath *string - // A Boolean value that indicates whether HTTPS redirection is enabled for the load - // balancer. + // A Boolean value that indicates whether HTTPS redirection is enabled for the + // load balancer. HttpsRedirectionEnabled *bool // An array of InstanceHealthSummary objects describing the health of the load @@ -2898,22 +2676,22 @@ type LoadBalancer struct { // only, and dualstack for IPv4 and IPv6. IpAddressType IpAddressType - // The AWS Region where your load balancer was created (e.g., us-east-2a). + // The AWS Region where your load balancer was created (e.g., us-east-2a ). // Lightsail automatically creates your load balancer across Availability Zones. Location *ResourceLocation - // The name of the load balancer (e.g., my-load-balancer). + // The name of the load balancer (e.g., my-load-balancer ). Name *string // The protocol you have enabled for your load balancer. Valid values are below. - // You can't just have HTTP_HTTPS, but you can have just HTTP. + // You can't just have HTTP_HTTPS , but you can have just HTTP . Protocol LoadBalancerProtocol // An array of public port settings for your load balancer. For HTTP, use port 80. // For HTTPS, use port 443. PublicPorts []int32 - // The resource type (e.g., LoadBalancer. + // The resource type (e.g., LoadBalancer . ResourceType ResourceType // The status of your load balancer. Valid values are below. @@ -2925,12 +2703,12 @@ type LoadBalancer struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag // An array of LoadBalancerTlsCertificateSummary objects that provide additional - // information about the SSL/TLS certificates. For example, if true, the + // information about the SSL/TLS certificates. For example, if true , the // certificate is attached to the load balancer. TlsCertificateSummaries []LoadBalancerTlsCertificateSummary @@ -2957,52 +2735,43 @@ type LoadBalancerTlsCertificate struct { // the records. DomainValidationRecords []LoadBalancerTlsCertificateDomainValidationRecord - // The validation failure reason, if any, of the certificate. The following failure - // reasons are possible: - // - // * NO_AVAILABLE_CONTACTS - This failure applies to email - // validation, which is not available for Lightsail certificates. - // - // * - // ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to - // process this certificate request. This can happen as a fraud-protection measure, - // such as when the domain ranks within the Alexa top 1000 websites. To provide the - // required information, use the AWS Support Center - // (https://console.aws.amazon.com/support/home) to contact AWS Support. You cannot - // request a certificate for Amazon-owned domain names such as those ending in - // amazonaws.com, cloudfront.net, or elasticbeanstalk.com. - // - // * DOMAIN_NOT_ALLOWED - - // One or more of the domain names in the certificate request was reported as an - // unsafe domain by VirusTotal (https://www.virustotal.com/gui/home/url). To - // correct the problem, search for your domain name on the VirusTotal - // (https://www.virustotal.com/gui/home/url) website. If your domain is reported as - // suspicious, see Google Help for Hacked Websites - // (https://developers.google.com/web/fundamentals/security/hacked) to learn what - // you can do. If you believe that the result is a false positive, notify the - // organization that is reporting the domain. VirusTotal is an aggregate of several - // antivirus and URL scanners and cannot remove your domain from a block list - // itself. After you correct the problem and the VirusTotal registry has been - // updated, request a new certificate. If you see this error and your domain is not - // included in the VirusTotal list, visit the AWS Support Center - // (https://console.aws.amazon.com/support/home) and create a case. - // - // * - // INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate - // request is not valid. Typically, this is because a domain name in the request is - // not a valid top-level domain. Try to request a certificate again, correcting any - // spelling errors or typos that were in the failed request, and ensure that all - // domain names in the request are for valid top-level domains. For example, you - // cannot request a certificate for example.invalidpublicdomain because - // invalidpublicdomain is not a valid top-level domain. - // - // * OTHER - Typically, this - // failure occurs when there is a typographical error in one or more of the domain - // names in the certificate request. Try to request a certificate again, correcting - // any spelling errors or typos that were in the failed request. + // The validation failure reason, if any, of the certificate. The following + // failure reasons are possible: + // - NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is + // not available for Lightsail certificates. + // - ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information + // to process this certificate request. This can happen as a fraud-protection + // measure, such as when the domain ranks within the Alexa top 1000 websites. To + // provide the required information, use the AWS Support Center (https://console.aws.amazon.com/support/home) + // to contact AWS Support. You cannot request a certificate for Amazon-owned domain + // names such as those ending in amazonaws.com, cloudfront.net, or + // elasticbeanstalk.com. + // - DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate + // request was reported as an unsafe domain by VirusTotal (https://www.virustotal.com/gui/home/url) + // . To correct the problem, search for your domain name on the VirusTotal (https://www.virustotal.com/gui/home/url) + // website. If your domain is reported as suspicious, see Google Help for Hacked + // Websites (https://developers.google.com/web/fundamentals/security/hacked) to + // learn what you can do. If you believe that the result is a false positive, + // notify the organization that is reporting the domain. VirusTotal is an aggregate + // of several antivirus and URL scanners and cannot remove your domain from a block + // list itself. After you correct the problem and the VirusTotal registry has been + // updated, request a new certificate. If you see this error and your domain is not + // included in the VirusTotal list, visit the AWS Support Center (https://console.aws.amazon.com/support/home) + // and create a case. + // - INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate + // request is not valid. Typically, this is because a domain name in the request is + // not a valid top-level domain. Try to request a certificate again, correcting any + // spelling errors or typos that were in the failed request, and ensure that all + // domain names in the request are for valid top-level domains. For example, you + // cannot request a certificate for example.invalidpublicdomain because + // invalidpublicdomain is not a valid top-level domain. + // - OTHER - Typically, this failure occurs when there is a typographical error + // in one or more of the domain names in the certificate request. Try to request a + // certificate again, correcting any spelling errors or typos that were in the + // failed request. FailureReason LoadBalancerTlsCertificateFailureReason - // When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + // When true , the SSL/TLS certificate is attached to the Lightsail load balancer. IsAttached *bool // The time when the SSL/TLS certificate was issued. @@ -3021,7 +2790,7 @@ type LoadBalancerTlsCertificate struct { // certificate. Location *ResourceLocation - // The name of the SSL/TLS certificate (e.g., my-certificate). + // The name of the SSL/TLS certificate (e.g., my-certificate ). Name *string // The timestamp when the SSL/TLS certificate expires. @@ -3034,41 +2803,26 @@ type LoadBalancerTlsCertificate struct { // Lightsail. RenewalSummary *LoadBalancerTlsCertificateRenewalSummary - // The resource type (e.g., LoadBalancerTlsCertificate). - // - // * Instance - A Lightsail - // instance (a virtual private server) - // - // * StaticIp - A static IP address - // - // * KeyPair - // - The key pair used to connect to a Lightsail instance - // - // * InstanceSnapshot - A - // Lightsail instance snapshot - // - // * Domain - A DNS zone - // - // * PeeredVpc - A peered - // VPC - // - // * LoadBalancer - A Lightsail load balancer - // - // * LoadBalancerTlsCertificate - - // An SSL/TLS certificate associated with a Lightsail load balancer - // - // * Disk - A - // Lightsail block storage disk - // - // * DiskSnapshot - A block storage disk snapshot + // The resource type (e.g., LoadBalancerTlsCertificate ). + // - Instance - A Lightsail instance (a virtual private server) + // - StaticIp - A static IP address + // - KeyPair - The key pair used to connect to a Lightsail instance + // - InstanceSnapshot - A Lightsail instance snapshot + // - Domain - A DNS zone + // - PeeredVpc - A peered VPC + // - LoadBalancer - A Lightsail load balancer + // - LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a + // Lightsail load balancer + // - Disk - A Lightsail block storage disk + // - DiskSnapshot - A block storage disk snapshot ResourceType ResourceType // The reason the certificate was revoked. This value is present only when the - // certificate status is REVOKED. + // certificate status is REVOKED . RevocationReason LoadBalancerTlsCertificateRevocationReason // The timestamp when the certificate was revoked. This value is present only when - // the certificate status is REVOKED. + // the certificate status is REVOKED . RevokedAt *time.Time // The serial number of the certificate. @@ -3084,8 +2838,8 @@ type LoadBalancerTlsCertificate struct { // certificate. Subject *string - // An array of strings that specify the alternate domains (e.g., example2.com) and - // subdomains (e.g., blog.example.com) for the certificate. + // An array of strings that specify the alternate domains (e.g., example2.com ) and + // subdomains (e.g., blog.example.com ) for the certificate. SubjectAlternativeNames []string // The support code. Include this code in your email to support when you have @@ -3094,8 +2848,8 @@ type LoadBalancerTlsCertificate struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -3108,14 +2862,9 @@ type LoadBalancerTlsCertificateDnsRecordCreationState struct { // The status code for the automated DNS record creation. Following are the // possible values: - // - // * SUCCEEDED - The validation records were successfully - // added. - // - // * STARTED - The automatic DNS record creation has started. - // - // * FAILED - - // The validation record addition failed. + // - SUCCEEDED - The validation records were successfully added. + // - STARTED - The automatic DNS record creation has started. + // - FAILED - The validation record addition failed. Code LoadBalancerTlsCertificateDnsRecordCreationStateCode // The message that describes the reason for the status code. @@ -3148,7 +2897,7 @@ type LoadBalancerTlsCertificateDomainValidationRecord struct { // The domain name against which your SSL/TLS certificate was validated. DomainName *string - // A fully qualified domain name in the certificate. For example, example.com. + // A fully qualified domain name in the certificate. For example, example.com . Name *string // The type of validation record. For example, CNAME for domain validation. @@ -3166,24 +2915,18 @@ type LoadBalancerTlsCertificateDomainValidationRecord struct { // Contains information about the status of Lightsail's managed renewal for the // certificate. The renewal status of the certificate. The following renewal status // are possible: -// -// * PendingAutoRenewal - Lightsail is attempting to automatically -// validate the domain names in the certificate. No further action is required. -// -// * -// PendingValidation - Lightsail couldn't automatically validate one or more domain -// names in the certificate. You must take action to validate these domain names or -// the certificate won't be renewed. If you used DNS validation, check to make sure -// your certificate's domain validation records exist in your domain's DNS, and -// that your certificate remains in use. -// -// * Success - All domain names in the -// certificate are validated, and Lightsail renewed the certificate. No further -// action is required. -// -// * Failed - One or more domain names were not validated -// before the certificate expired, and Lightsail did not renew the certificate. You -// can request a new certificate using the CreateCertificate action. +// - PendingAutoRenewal - Lightsail is attempting to automatically validate the +// domain names in the certificate. No further action is required. +// - PendingValidation - Lightsail couldn't automatically validate one or more +// domain names in the certificate. You must take action to validate these domain +// names or the certificate won't be renewed. If you used DNS validation, check to +// make sure your certificate's domain validation records exist in your domain's +// DNS, and that your certificate remains in use. +// - Success - All domain names in the certificate are validated, and Lightsail +// renewed the certificate. No further action is required. +// - Failed - One or more domain names were not validated before the certificate +// expired, and Lightsail did not renew the certificate. You can request a new +// certificate using the CreateCertificate action. type LoadBalancerTlsCertificateRenewalSummary struct { // Contains information about the validation of each domain name in the @@ -3194,24 +2937,18 @@ type LoadBalancerTlsCertificateRenewalSummary struct { // The renewal status of the certificate. The following renewal status are // possible: - // - // * PendingAutoRenewal - Lightsail is attempting to automatically - // validate the domain names of the certificate. No further action is required. - // - // * - // PendingValidation - Lightsail couldn't automatically validate one or more domain - // names of the certificate. You must take action to validate these domain names or - // the certificate won't be renewed. Check to make sure your certificate's domain - // validation records exist in your domain's DNS, and that your certificate remains - // in use. - // - // * Success - All domain names in the certificate are validated, and - // Lightsail renewed the certificate. No further action is required. - // - // * Failed - - // One or more domain names were not validated before the certificate expired, and - // Lightsail did not renew the certificate. You can request a new certificate using - // the CreateCertificate action. + // - PendingAutoRenewal - Lightsail is attempting to automatically validate the + // domain names of the certificate. No further action is required. + // - PendingValidation - Lightsail couldn't automatically validate one or more + // domain names of the certificate. You must take action to validate these domain + // names or the certificate won't be renewed. Check to make sure your certificate's + // domain validation records exist in your domain's DNS, and that your certificate + // remains in use. + // - Success - All domain names in the certificate are validated, and Lightsail + // renewed the certificate. No further action is required. + // - Failed - One or more domain names were not validated before the certificate + // expired, and Lightsail did not renew the certificate. You can request a new + // certificate using the CreateCertificate action. RenewalStatus LoadBalancerTlsCertificateRenewalStatus noSmithyDocumentSerde @@ -3220,7 +2957,7 @@ type LoadBalancerTlsCertificateRenewalSummary struct { // Provides a summary of SSL/TLS certificate metadata. type LoadBalancerTlsCertificateSummary struct { - // When true, the SSL/TLS certificate is attached to the Lightsail load balancer. + // When true , the SSL/TLS certificate is attached to the Lightsail load balancer. IsAttached *bool // The name of the SSL/TLS certificate. @@ -3231,8 +2968,7 @@ type LoadBalancerTlsCertificateSummary struct { // Describes the TLS security policies that are available for Lightsail load // balancers. For more information about load balancer TLS security policies, see -// Configuring TLS security policies on your Amazon Lightsail load balancers -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) +// Configuring TLS security policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) // in the Amazon Lightsail Developer Guide. type LoadBalancerTlsPolicy struct { @@ -3285,7 +3021,7 @@ type MetricDatapoint struct { // The sum. Sum *float64 - // The timestamp (e.g., 1479816991.349). + // The timestamp (e.g., 1479816991.349 ). Timestamp *time.Time // The unit. @@ -3296,8 +3032,8 @@ type MetricDatapoint struct { // Describes resource being monitored by an alarm. An alarm is a way to monitor // your Amazon Lightsail resource metrics. For more information, see Alarms in -// Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). +// Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms) +// . type MonitoredResourceInfo struct { // The Amazon Resource Name (ARN) of the resource being monitored. @@ -3325,25 +3061,16 @@ type MonthlyTransfer struct { } // Describes the state of the name server records update made by Amazon Lightsail -// to an Amazon Route 53 registered domain. For more information, see DNS in Amazon -// Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail) +// to an Amazon Route 53 registered domain. For more information, see DNS in +// Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail) // in the Amazon Lightsail Developer Guide. type NameServersUpdateState struct { - // The status code for the name servers update. Following are the possible - // values: - // - // * SUCCEEDED - The name server records were successfully updated. - // - // * - // PENDING - The name server record update is in progress. - // - // * FAILED - The name - // server record update failed. - // - // * STARTED - The automatic name server record - // update started. + // The status code for the name servers update. Following are the possible values: + // - SUCCEEDED - The name server records were successfully updated. + // - PENDING - The name server record update is in progress. + // - FAILED - The name server record update failed. + // - STARTED - The automatic name server record update started. Code NameServersUpdateStateCode // The message that describes the reason for the status code. @@ -3355,7 +3082,7 @@ type NameServersUpdateState struct { // Describes the API operation. type Operation struct { - // The timestamp when the operation was initialized (e.g., 1479816991.349). + // The timestamp when the operation was initialized (e.g., 1479816991.349 ). CreatedAt *time.Time // The error code. @@ -3373,7 +3100,7 @@ type Operation struct { // The Amazon Web Services Region and Availability Zone. Location *ResourceLocation - // Details about the operation (e.g., Debian-1GB-Ohio-1). + // Details about the operation (e.g., Debian-1GB-Ohio-1 ). OperationDetails *string // The type of operation. @@ -3388,7 +3115,7 @@ type Operation struct { // The status of the operation. Status OperationStatus - // The timestamp when the status was changed (e.g., 1479816991.349). + // The timestamp when the status was changed (e.g., 1479816991.349 ). StatusChangedAt *time.Time noSmithyDocumentSerde @@ -3420,10 +3147,10 @@ type Origin struct { // ciphertext and the key pair name. type PasswordData struct { - // The encrypted password. Ciphertext will be an empty string if access to your new - // instance is not ready yet. When you create an instance, it can take up to 15 - // minutes for the instance to be ready. If you use the default key pair - // (LightsailDefaultKeyPair), the decrypted password will be available in the + // The encrypted password. Ciphertext will be an empty string if access to your + // new instance is not ready yet. When you create an instance, it can take up to 15 + // minutes for the instance to be ready. If you use the default key pair ( + // LightsailDefaultKeyPair ), the decrypted password will be available in the // password field. If you are using a custom key pair, you need to use your own // means of decryption. If you change the Administrator password on the instance, // Lightsail will continue to return the original ciphertext value. When accessing @@ -3433,8 +3160,8 @@ type PasswordData struct { // The name of the key pair that you used when creating your instance. If no key // pair name was specified when creating the instance, Lightsail uses the default - // key pair (LightsailDefaultKeyPair). If you are using a custom key pair, you need - // to use your own means of decrypting your password using the ciphertext. + // key pair ( LightsailDefaultKeyPair ). If you are using a custom key pair, you + // need to use your own means of decrypting your password using the ciphertext . // Lightsail creates the ciphertext by encrypting your password with the public key // part of this key pair. KeyPairName *string @@ -3476,99 +3203,76 @@ type PendingModifiedRelationalDatabaseValues struct { // the instance through the ports, and the protocol. type PortInfo struct { - // An alias that defines access for a preconfigured range of IP addresses. The only - // alias currently supported is lightsail-connect, which allows IP addresses of the - // browser-based RDP/SSH client in the Lightsail console to connect to your + // An alias that defines access for a preconfigured range of IP addresses. The + // only alias currently supported is lightsail-connect , which allows IP addresses + // of the browser-based RDP/SSH client in the Lightsail console to connect to your // instance. CidrListAliases []string - // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. The ipv6Cidrs - // parameter lists the IPv6 addresses that are allowed to connect to an instance. - // Examples: - // - // * To allow the IP address 192.0.2.44, specify 192.0.2.44 or - // 192.0.2.44/32. - // - // * To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify - // 192.0.2.0/24. - // - // For more information about CIDR block notation, see Classless - // Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. The + // ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an + // instance. Examples: + // - To allow the IP address 192.0.2.44 , specify 192.0.2.44 or 192.0.2.44/32 . + // - To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 . + // For more information about CIDR block notation, see Classless Inter-Domain + // Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Cidrs []string // The first port in a range of open ports on an instance. Allowed ports: - // - // * TCP - // and UDP - 0 to 65535 - // - // * ICMP - The ICMP type for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . FromPort int32 - // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed - // to connect to an instance through the ports, and the protocol. Only devices with - // an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should - // be used. The cidrs parameter lists the IPv4 addresses that are allowed to - // connect to an instance. For more information about CIDR block notation, see - // Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on - // Wikipedia. + // The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are + // allowed to connect to an instance through the ports, and the protocol. Only + // devices with an IPv6 address can connect to an instance through IPv6; otherwise, + // IPv4 should be used. The cidrs parameter lists the IPv4 addresses that are + // allowed to connect to an instance. For more information about CIDR block + // notation, see Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) + // on Wikipedia. Ipv6Cidrs []string // The IP protocol name. The name can be one of the following: - // - // * tcp - - // Transmission Control Protocol (TCP) provides reliable, ordered, and - // error-checked delivery of streamed data between applications running on hosts - // communicating by an IP network. If you have an application that doesn't require - // reliable data stream service, use UDP instead. - // - // * all - All transport layer - // protocol types. For more general information, see Transport layer - // (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. - // - // * udp - With User - // Datagram Protocol (UDP), computer applications can send messages (or datagrams) - // to other hosts on an Internet Protocol (IP) network. Prior communications are - // not required to set up transmission channels or data paths. Applications that - // don't require reliable data stream service can use UDP, which provides a - // connectionless datagram service that emphasizes reduced latency over - // reliability. If you do require reliable data stream service, use TCP instead. - // - // * - // icmp - Internet Control Message Protocol (ICMP) is used to send error messages - // and operational information indicating success or failure when communicating - // with an instance. For example, an error is indicated when an instance could not - // be reached. When you specify icmp as the protocol, you must specify the ICMP - // type using the fromPort parameter, and ICMP code using the toPort parameter. + // - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and + // error-checked delivery of streamed data between applications running on hosts + // communicating by an IP network. If you have an application that doesn't require + // reliable data stream service, use UDP instead. + // - all - All transport layer protocol types. For more general information, see + // Transport layer (https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia. + // - udp - With User Datagram Protocol (UDP), computer applications can send + // messages (or datagrams) to other hosts on an Internet Protocol (IP) network. + // Prior communications are not required to set up transmission channels or data + // paths. Applications that don't require reliable data stream service can use UDP, + // which provides a connectionless datagram service that emphasizes reduced latency + // over reliability. If you do require reliable data stream service, use TCP + // instead. + // - icmp - Internet Control Message Protocol (ICMP) is used to send error + // messages and operational information indicating success or failure when + // communicating with an instance. For example, an error is indicated when an + // instance could not be reached. When you specify icmp as the protocol , you + // must specify the ICMP type using the fromPort parameter, and ICMP code using + // the toPort parameter. Protocol NetworkProtocol // The last port in a range of open ports on an instance. Allowed ports: - // - // * TCP and - // UDP - 0 to 65535 - // - // * ICMP - The ICMP code for IPv4 addresses. For example, - // specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to - // enable ICMP Ping. For more information, see Control Messages - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) - // on Wikipedia. - // - // * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify - // 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more - // information, see Internet Control Message Protocol for IPv6 - // (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6). + // - TCP and UDP - 0 to 65535 + // - ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the + // fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. + // For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) + // on Wikipedia. + // - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the + // fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, + // see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6) + // . ToPort int32 noSmithyDocumentSerde @@ -3577,8 +3281,7 @@ type PortInfo struct { // Describes the configuration for an Amazon Lightsail container service to access // private container image repositories, such as Amazon Elastic Container Registry // (Amazon ECR) private repositories. For more information, see Configuring access -// to an Amazon ECR private repository for an Amazon Lightsail container service -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) +// to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. type PrivateRegistryAccess struct { @@ -3591,11 +3294,11 @@ type PrivateRegistryAccess struct { noSmithyDocumentSerde } -// Describes a request to configure an Amazon Lightsail container service to access -// private container image repositories, such as Amazon Elastic Container Registry -// (Amazon ECR) private repositories. For more information, see Configuring access -// to an Amazon ECR private repository for an Amazon Lightsail container service -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) +// Describes a request to configure an Amazon Lightsail container service to +// access private container image repositories, such as Amazon Elastic Container +// Registry (Amazon ECR) private repositories. For more information, see +// Configuring access to an Amazon ECR private repository for an Amazon Lightsail +// container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) // in the Amazon Lightsail Developer Guide. type PrivateRegistryAccessRequest struct { @@ -3625,22 +3328,15 @@ type QueryStringObject struct { noSmithyDocumentSerde } -// Describes the deletion state of an Amazon Route 53 hosted zone for a domain that -// is being automatically delegated to an Amazon Lightsail DNS zone. +// Describes the deletion state of an Amazon Route 53 hosted zone for a domain +// that is being automatically delegated to an Amazon Lightsail DNS zone. type R53HostedZoneDeletionState struct { // The status code for the deletion state. Following are the possible values: - // - // * - // SUCCEEDED - The hosted zone was successfully deleted. - // - // * PENDING - The hosted - // zone deletion is in progress. - // - // * FAILED - The hosted zone deletion failed. - // - // * - // STARTED - The hosted zone deletion started. + // - SUCCEEDED - The hosted zone was successfully deleted. + // - PENDING - The hosted zone deletion is in progress. + // - FAILED - The hosted zone deletion failed. + // - STARTED - The hosted zone deletion started. Code R53HostedZoneDeletionStateCode // The message that describes the reason for the status code. @@ -3655,17 +3351,17 @@ type Region struct { // The Availability Zones. Follows the format us-east-2a (case-sensitive). AvailabilityZones []AvailabilityZone - // The continent code (e.g., NA, meaning North America). + // The continent code (e.g., NA , meaning North America). ContinentCode *string // The description of the Amazon Web Services Region (e.g., This region is - // recommended to serve users in the eastern United States and eastern Canada). + // recommended to serve users in the eastern United States and eastern Canada ). Description *string - // The display name (e.g., Ohio). + // The display name (e.g., Ohio ). DisplayName *string - // The region name (e.g., us-east-2). + // The region name (e.g., us-east-2 ). Name RegionName // The Availability Zones for databases. Follows the format us-east-2a @@ -3675,32 +3371,27 @@ type Region struct { noSmithyDocumentSerde } -// Describes the delegation state of an Amazon Route 53 registered domain to Amazon -// Lightsail. When you delegate an Amazon Route 53 registered domain to Lightsail, -// you can manage the DNS of the domain using a Lightsail DNS zone. You no longer -// use the Route 53 hosted zone to manage the DNS of the domain. To delegate the -// domain, Lightsail automatically updates the domain's name servers in Route 53 to -// the name servers of the Lightsail DNS zone. Then, Lightsail automatically -// deletes the Route 53 hosted zone for the domain. All of the following conditions -// must be true for automatic domain delegation to be successful: -// -// * The registered -// domain must be in the same Amazon Web Services account as the Lightsail account -// making the request. +// Describes the delegation state of an Amazon Route 53 registered domain to +// Amazon Lightsail. When you delegate an Amazon Route 53 registered domain to +// Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You +// no longer use the Route 53 hosted zone to manage the DNS of the domain. To +// delegate the domain, Lightsail automatically updates the domain's name servers +// in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail +// automatically deletes the Route 53 hosted zone for the domain. All of the +// following conditions must be true for automatic domain delegation to be +// successful: +// - The registered domain must be in the same Amazon Web Services account as +// the Lightsail account making the request. +// - The user or entity making the request must have permission to manage +// domains in Route 53. +// - The Route 53 hosted zone for the domain must be empty. It cannot contain +// DNS records other than start of authority (SOA) and name server records. // -// * The user or entity making the request must have -// permission to manage domains in Route 53. -// -// * The Route 53 hosted zone for the -// domain must be empty. It cannot contain DNS records other than start of -// authority (SOA) and name server records. -// -// If automatic domain delegation fails, -// or if you manage the DNS of your domain using a service other than Route 53, -// then you must manually add the Lightsail DNS zone name servers to your domain in -// order to delegate management of its DNS to Lightsail. For more information, see -// Creating a DNS zone to manage your domain’s records in Amazon Lightsail -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry) +// If automatic domain delegation fails, or if you manage the DNS of your domain +// using a service other than Route 53, then you must manually add the Lightsail +// DNS zone name servers to your domain in order to delegate management of its DNS +// to Lightsail. For more information, see Creating a DNS zone to manage your +// domain’s records in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry) // in the Amazon Lightsail Developer Guide. type RegisteredDomainDelegationInfo struct { @@ -3708,8 +3399,8 @@ type RegisteredDomainDelegationInfo struct { // automatically added to the Route 53 domain by Lightsail. NameServersUpdateState *NameServersUpdateState - // Describes the deletion state of an Amazon Route 53 hosted zone for a domain that - // is being automatically delegated to an Amazon Lightsail DNS zone. + // Describes the deletion state of an Amazon Route 53 hosted zone for a domain + // that is being automatically delegated to an Amazon Lightsail DNS zone. R53HostedZoneDeletionState *R53HostedZoneDeletionState noSmithyDocumentSerde @@ -3721,8 +3412,8 @@ type RelationalDatabase struct { // The Amazon Resource Name (ARN) of the database. Arn *string - // A Boolean value indicating whether automated backup retention is enabled for the - // database. + // A Boolean value indicating whether automated backup retention is enabled for + // the database. BackupRetentionEnabled *bool // The certificate associated with the database. @@ -3731,10 +3422,10 @@ type RelationalDatabase struct { // The timestamp when the database was created. Formatted in Unix time. CreatedAt *time.Time - // The database software (for example, MySQL). + // The database software (for example, MySQL ). Engine *string - // The database engine version (for example, 5.7.23). + // The database engine version (for example, 5.7.23 ). EngineVersion *string // Describes the hardware of the database. @@ -3769,12 +3460,13 @@ type RelationalDatabase struct { // Describes pending database value modifications. PendingModifiedValues *PendingModifiedRelationalDatabaseValues - // The daily time range during which automated backups are created for the database - // (for example, 16:00-16:30). + // The daily time range during which automated backups are created for the + // database (for example, 16:00-16:30 ). PreferredBackupWindow *string - // The weekly time range during which system maintenance can occur on the database. - // In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30. + // The weekly time range during which system maintenance can occur on the + // database. In the format ddd:hh24:mi-ddd:hh24:mi . For example, + // Tue:17:00-Tue:17:30 . PreferredMaintenanceWindow *string // A Boolean value indicating whether the database is publicly accessible. @@ -3788,7 +3480,7 @@ type RelationalDatabase struct { // specifications for your database. RelationalDatabaseBundleId *string - // The Lightsail resource type for the database (for example, RelationalDatabase). + // The Lightsail resource type for the database (for example, RelationalDatabase ). ResourceType ResourceType // Describes the secondary Availability Zone of a high availability database. The @@ -3804,27 +3496,27 @@ type RelationalDatabase struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde } -// Describes a database image, or blueprint. A blueprint describes the major engine -// version of a database. +// Describes a database image, or blueprint. A blueprint describes the major +// engine version of a database. type RelationalDatabaseBlueprint struct { // The ID for the database blueprint. BlueprintId *string - // The database software of the database blueprint (for example, MySQL). + // The database software of the database blueprint (for example, MySQL ). Engine RelationalDatabaseEngine // The description of the database engine for the database blueprint. EngineDescription *string - // The database engine version for the database blueprint (for example, 5.7.23). + // The database engine version for the database blueprint (for example, 5.7.23 ). EngineVersion *string // The description of the database engine version for the database blueprint. @@ -3862,7 +3554,7 @@ type RelationalDatabaseBundle struct { // The cost of the database bundle in US currency. Price *float32 - // The amount of RAM in GB (for example, 2.0) for the database bundle. + // The amount of RAM in GB (for example, 2.0 ) for the database bundle. RamSizeInGb *float32 // The data transfer rate per month in GB for the database bundle. @@ -3922,8 +3614,8 @@ type RelationalDatabaseParameter struct { // Specifies the valid range of values for the parameter. AllowedValues *string - // Indicates when parameter updates are applied. Can be immediate or - // pending-reboot. + // Indicates when parameter updates are applied. Can be immediate or pending-reboot + // . ApplyMethod *string // Specifies the engine-specific parameter type. @@ -3956,18 +3648,18 @@ type RelationalDatabaseSnapshot struct { // The timestamp when the database snapshot was created. CreatedAt *time.Time - // The software of the database snapshot (for example, MySQL) + // The software of the database snapshot (for example, MySQL ) Engine *string - // The database engine version for the database snapshot (for example, 5.7.23). + // The database engine version for the database snapshot (for example, 5.7.23 ). EngineVersion *string // The Amazon Resource Name (ARN) of the database from which the database snapshot // was created. FromRelationalDatabaseArn *string - // The blueprint ID of the database from which the database snapshot was created. A - // blueprint describes the major engine version of a database. + // The blueprint ID of the database from which the database snapshot was created. + // A blueprint describes the major engine version of a database. FromRelationalDatabaseBlueprintId *string // The bundle ID of the database from which the database snapshot was created. @@ -3985,7 +3677,7 @@ type RelationalDatabaseSnapshot struct { // The Lightsail resource type. ResourceType ResourceType - // The size of the disk in GB (for example, 32) for the database snapshot. + // The size of the disk in GB (for example, 32 ) for the database snapshot. SizeInGb *int32 // The state of the database snapshot. @@ -3997,8 +3689,8 @@ type RelationalDatabaseSnapshot struct { SupportCode *string // The tag keys and optional values for the resource. For more information about - // tags in Lightsail, see the Amazon Lightsail Developer Guide - // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). + // tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) + // . Tags []Tag noSmithyDocumentSerde @@ -4014,24 +3706,18 @@ type RenewalSummary struct { // The renewal status of the certificate. The following renewal status are // possible: - // - // * PendingAutoRenewal - Lightsail is attempting to automatically - // validate the domain names of the certificate. No further action is required. - // - // * - // PendingValidation - Lightsail couldn't automatically validate one or more domain - // names of the certificate. You must take action to validate these domain names or - // the certificate won't be renewed. Check to make sure your certificate's domain - // validation records exist in your domain's DNS, and that your certificate remains - // in use. - // - // * Success - All domain names in the certificate are validated, and - // Lightsail renewed the certificate. No further action is required. - // - // * Failed - - // One or more domain names were not validated before the certificate expired, and - // Lightsail did not renew the certificate. You can request a new certificate using - // the CreateCertificate action. + // - PendingAutoRenewal - Lightsail is attempting to automatically validate the + // domain names of the certificate. No further action is required. + // - PendingValidation - Lightsail couldn't automatically validate one or more + // domain names of the certificate. You must take action to validate these domain + // names or the certificate won't be renewed. Check to make sure your certificate's + // domain validation records exist in your domain's DNS, and that your certificate + // remains in use. + // - Success - All domain names in the certificate are validated, and Lightsail + // renewed the certificate. No further action is required. + // - Failed - One or more domain names were not validated before the certificate + // expired, and Lightsail did not renew the certificate. You can request a new + // certificate using the CreateCertificate action. RenewalStatus RenewalStatus // The reason for the renewal status of the certificate. @@ -4082,7 +3768,7 @@ type ResourceReceivingAccess struct { // The name of the Lightsail instance. Name *string - // The Lightsail resource type (for example, Instance). + // The Lightsail resource type (for example, Instance ). ResourceType *string noSmithyDocumentSerde @@ -4126,13 +3812,14 @@ type Session struct { type StaticIp struct { // The Amazon Resource Name (ARN) of the static IP (e.g., - // arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE). + // arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE + // ). Arn *string - // The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1). + // The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1 ). AttachedTo *string - // The timestamp when the static IP was created (e.g., 1479735304.222). + // The timestamp when the static IP was created (e.g., 1479735304.222 ). CreatedAt *time.Time // The static IP address. @@ -4144,10 +3831,10 @@ type StaticIp struct { // The region and Availability Zone where the static IP was created. Location *ResourceLocation - // The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE). + // The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE ). Name *string - // The resource type (usually StaticIp). + // The resource type (usually StaticIp ). ResourceType ResourceType // The support code. Include this code in your email to support when you have @@ -4158,8 +3845,8 @@ type StaticIp struct { noSmithyDocumentSerde } -// Describes a request to create or edit the StopInstanceOnIdle add-on. This add-on -// only applies to Lightsail for Research resources. +// Describes a request to create or edit the StopInstanceOnIdle add-on. This +// add-on only applies to Lightsail for Research resources. type StopInstanceOnIdleRequest struct { // The amount of idle time in minutes after which your virtual computer will @@ -4172,10 +3859,10 @@ type StopInstanceOnIdleRequest struct { noSmithyDocumentSerde } -// Describes a tag key and optional value assigned to an Amazon Lightsail resource. -// For more information about tags in Lightsail, see the Amazon Lightsail Developer -// Guide -// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags). +// Describes a tag key and optional value assigned to an Amazon Lightsail +// resource. For more information about tags in Lightsail, see the Amazon +// Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags) +// . type Tag struct { // The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, @@ -4191,19 +3878,19 @@ type Tag struct { // Sets the start date and end date for retrieving a cost estimate. The start date // is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 -// and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 -// up to and including 2017-04-30 but not including 2017-05-01. +// and end is 2017-05-01 , then the cost and usage data is retrieved from +// 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 . type TimePeriod struct { // The end of the time period. The end date is exclusive. For example, if end is - // 2017-05-01, Lightsail for Research retrieves cost and usage data from the start - // date up to, but not including, 2017-05-01. + // 2017-05-01 , Lightsail for Research retrieves cost and usage data from the start + // date up to, but not including, 2017-05-01 . End *time.Time // The beginning of the time period. The start date is inclusive. For example, if - // start is 2017-01-01, Lightsail for Research retrieves cost and usage data - // starting at 2017-01-01 up to the end date. The start date must be equal to or no - // later than the current date to avoid a validation error. + // start is 2017-01-01 , Lightsail for Research retrieves cost and usage data + // starting at 2017-01-01 up to the end date. The start date must be equal to or + // no later than the current date to avoid a validation error. Start *time.Time noSmithyDocumentSerde diff --git a/service/location/api_client.go b/service/location/api_client.go index 32816b4cceb..ffbb5d5f9ad 100644 --- a/service/location/api_client.go +++ b/service/location/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/location/api_op_AssociateTrackerConsumer.go b/service/location/api_op_AssociateTrackerConsumer.go index d44215f57da..21875a0862f 100644 --- a/service/location/api_op_AssociateTrackerConsumer.go +++ b/service/location/api_op_AssociateTrackerConsumer.go @@ -37,9 +37,8 @@ type AssociateTrackerConsumerInput struct { // The Amazon Resource Name (ARN) for the geofence collection to be associated to // tracker resource. Used when you need to specify a resource across all Amazon Web // Services. - // - // * Format example: - // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer + // - Format example: + // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer // // This member is required. ConsumerArn *string diff --git a/service/location/api_op_BatchDeleteDevicePositionHistory.go b/service/location/api_op_BatchDeleteDevicePositionHistory.go index 6b1ce2fbdc0..8e4594d4caa 100644 --- a/service/location/api_op_BatchDeleteDevicePositionHistory.go +++ b/service/location/api_op_BatchDeleteDevicePositionHistory.go @@ -31,9 +31,7 @@ func (c *Client) BatchDeleteDevicePositionHistory(ctx context.Context, params *B type BatchDeleteDevicePositionHistoryInput struct { // Devices whose position history you want to delete. - // - // * For example, for two - // devices: “DeviceIds” : [DeviceId1,DeviceId2] + // - For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2] // // This member is required. DeviceIds []string diff --git a/service/location/api_op_BatchEvaluateGeofences.go b/service/location/api_op_BatchEvaluateGeofences.go index 9eea734ce01..6082ac947b9 100644 --- a/service/location/api_op_BatchEvaluateGeofences.go +++ b/service/location/api_op_BatchEvaluateGeofences.go @@ -12,24 +12,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Evaluates device positions against the geofence geometries from a given geofence -// collection. This operation always returns an empty response because geofences -// are asynchronously evaluated. The evaluation determines if the device has -// entered or exited a geofenced area, and then publishes one of the following +// Evaluates device positions against the geofence geometries from a given +// geofence collection. This operation always returns an empty response because +// geofences are asynchronously evaluated. The evaluation determines if the device +// has entered or exited a geofenced area, and then publishes one of the following // events to Amazon EventBridge: +// - ENTER if Amazon Location determines that the tracked device has entered a +// geofenced area. +// - EXIT if Amazon Location determines that the tracked device has exited a +// geofenced area. // -// * ENTER if Amazon Location determines that the -// tracked device has entered a geofenced area. -// -// * EXIT if Amazon Location -// determines that the tracked device has exited a geofenced area. -// -// The last -// geofence that a device was observed within is tracked for 30 days after the most -// recent device position update. Geofence evaluation uses the given device -// position. It does not account for the optional Accuracy of a -// DevicePositionUpdate. The DeviceID is used as a string to represent the device. -// You do not need to have a Tracker associated with the DeviceID. +// The last geofence that a device was observed within is tracked for 30 days +// after the most recent device position update. Geofence evaluation uses the given +// device position. It does not account for the optional Accuracy of a +// DevicePositionUpdate . The DeviceID is used as a string to represent the +// device. You do not need to have a Tracker associated with the DeviceID . func (c *Client) BatchEvaluateGeofences(ctx context.Context, params *BatchEvaluateGeofencesInput, optFns ...func(*Options)) (*BatchEvaluateGeofencesOutput, error) { if params == nil { params = &BatchEvaluateGeofencesInput{} diff --git a/service/location/api_op_BatchGetDevicePosition.go b/service/location/api_op_BatchGetDevicePosition.go index 066c1a32ec5..b8b4c442ab5 100644 --- a/service/location/api_op_BatchGetDevicePosition.go +++ b/service/location/api_op_BatchGetDevicePosition.go @@ -31,9 +31,7 @@ func (c *Client) BatchGetDevicePosition(ctx context.Context, params *BatchGetDev type BatchGetDevicePositionInput struct { // Devices whose position you want to retrieve. - // - // * For example, for two devices: - // device-ids=DeviceId1&device-ids=DeviceId2 + // - For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2 // // This member is required. DeviceIds []string @@ -48,8 +46,8 @@ type BatchGetDevicePositionInput struct { type BatchGetDevicePositionOutput struct { - // Contains device position details such as the device ID, position, and timestamps - // for when the position was received and sampled. + // Contains device position details such as the device ID, position, and + // timestamps for when the position was received and sampled. // // This member is required. DevicePositions []types.DevicePosition diff --git a/service/location/api_op_BatchUpdateDevicePosition.go b/service/location/api_op_BatchUpdateDevicePosition.go index 9915ad3a942..6b6c9b4157a 100644 --- a/service/location/api_op_BatchUpdateDevicePosition.go +++ b/service/location/api_op_BatchUpdateDevicePosition.go @@ -15,21 +15,21 @@ import ( // Uploads position update data for one or more devices to a tracker resource. // Amazon Location uses the data when it reports the last known device position and // position history. Amazon Location retains location data for 30 days. Position -// updates are handled based on the PositionFiltering property of the tracker. When -// PositionFiltering is set to TimeBased, updates are evaluated against linked -// geofence collections, and location data is stored at a maximum of one position -// per 30 second interval. If your update frequency is more often than every 30 -// seconds, only one update per 30 seconds is stored for each unique device ID. -// When PositionFiltering is set to DistanceBased filtering, location data is -// stored and evaluated against linked geofence collections only if the device has -// moved more than 30 m (98.4 ft). When PositionFiltering is set to AccuracyBased -// filtering, location data is stored and evaluated against linked geofence -// collections only if the device has moved more than the measured accuracy. For -// example, if two consecutive updates from a device have a horizontal accuracy of -// 5 m and 10 m, the second update is neither stored or evaluated if the device has -// moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, -// Amazon Location uses the default value { "Horizontal": 0} when accuracy is not -// provided on a DevicePositionUpdate. +// updates are handled based on the PositionFiltering property of the tracker. +// When PositionFiltering is set to TimeBased , updates are evaluated against +// linked geofence collections, and location data is stored at a maximum of one +// position per 30 second interval. If your update frequency is more often than +// every 30 seconds, only one update per 30 seconds is stored for each unique +// device ID. When PositionFiltering is set to DistanceBased filtering, location +// data is stored and evaluated against linked geofence collections only if the +// device has moved more than 30 m (98.4 ft). When PositionFiltering is set to +// AccuracyBased filtering, location data is stored and evaluated against linked +// geofence collections only if the device has moved more than the measured +// accuracy. For example, if two consecutive updates from a device have a +// horizontal accuracy of 5 m and 10 m, the second update is neither stored or +// evaluated if the device has moved less than 15 m. If PositionFiltering is set +// to AccuracyBased filtering, Amazon Location uses the default value { +// "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate . func (c *Client) BatchUpdateDevicePosition(ctx context.Context, params *BatchUpdateDevicePositionInput, optFns ...func(*Options)) (*BatchUpdateDevicePositionOutput, error) { if params == nil { params = &BatchUpdateDevicePositionInput{} diff --git a/service/location/api_op_CalculateRoute.go b/service/location/api_op_CalculateRoute.go index 8f7614422d1..aea57facc0a 100644 --- a/service/location/api_op_CalculateRoute.go +++ b/service/location/api_op_CalculateRoute.go @@ -13,29 +13,23 @@ import ( "time" ) -// Calculates a route -// (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html) +// Calculates a route (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html) // given the following required parameters: DeparturePosition and -// DestinationPosition. Requires that you first create a route calculator resource -// (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html). -// By default, a request that doesn't specify a departure time uses the best time +// DestinationPosition . Requires that you first create a route calculator resource (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html) +// . By default, a request that doesn't specify a departure time uses the best time // of day to travel with the best traffic conditions when calculating the route. // Additional options include: -// -// * Specifying a departure time -// (https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) -// using either DepartureTime or DepartNow. This calculates a route based on -// predictive traffic data at the given time. You can't specify both DepartureTime -// and DepartNow in a single request. Specifying both parameters returns a -// validation error. -// -// * Specifying a travel mode -// (https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) -// using TravelMode sets the transportation mode used to calculate the routes. This -// also lets you specify additional route preferences in CarModeOptions if -// traveling by Car, or TruckModeOptions if traveling by Truck. If you specify -// walking for the travel mode and your data provider is Esri, the start and -// destination must be within 40km. +// - Specifying a departure time (https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) +// using either DepartureTime or DepartNow . This calculates a route based on +// predictive traffic data at the given time. You can't specify both +// DepartureTime and DepartNow in a single request. Specifying both parameters +// returns a validation error. +// - Specifying a travel mode (https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) +// using TravelMode sets the transportation mode used to calculate the routes. This +// also lets you specify additional route preferences in CarModeOptions if +// traveling by Car , or TruckModeOptions if traveling by Truck . If you specify +// walking for the travel mode and your data provider is Esri, the start and +// destination must be within 40km. func (c *Client) CalculateRoute(ctx context.Context, params *CalculateRouteInput, optFns ...func(*Options)) (*CalculateRouteOutput, error) { if params == nil { params = &CalculateRouteInput{} @@ -59,40 +53,30 @@ type CalculateRouteInput struct { // This member is required. CalculatorName *string - // The start position for the route. Defined in World Geodetic System (WGS 84) - // (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) format: - // [longitude, latitude]. - // - // * For example, [-123.115, 49.285] - // - // If you specify a - // departure that's not located on a road, Amazon Location moves the position to - // the nearest road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). - // If Esri is the provider for your route calculator, specifying a route that is + // The start position for the route. Defined in World Geodetic System (WGS 84) (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) + // format: [longitude, latitude] . + // - For example, [-123.115, 49.285] + // If you specify a departure that's not located on a road, Amazon Location moves + // the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . If Esri is the provider for your route calculator, specifying a route that is // longer than 400 km returns a 400 RoutesValidationException error. Valid Values: // [-180 to 180,-90 to 90] // // This member is required. DeparturePosition []float64 - // The finish position for the route. Defined in World Geodetic System (WGS 84) - // (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) format: - // [longitude, latitude]. - // - // * For example, [-122.339, 47.615] - // - // If you specify a - // destination that's not located on a road, Amazon Location moves the position to - // the nearest road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). - // Valid Values: [-180 to 180,-90 to 90] + // The finish position for the route. Defined in World Geodetic System (WGS 84) (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) + // format: [longitude, latitude] . + // - For example, [-122.339, 47.615] + // If you specify a destination that's not located on a road, Amazon Location + // moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . Valid Values: [-180 to 180,-90 to 90] // // This member is required. DestinationPosition []float64 - // Specifies route preferences when traveling by Car, such as avoiding routes that - // use ferries or tolls. Requirements: TravelMode must be specified as Car. + // Specifies route preferences when traveling by Car , such as avoiding routes that + // use ferries or tolls. Requirements: TravelMode must be specified as Car . CarModeOptions *types.CalculateRouteCarModeOptions // Sets the time of departure as the current time. Uses the current time to @@ -105,10 +89,8 @@ type CalculateRouteInput struct { // route. Otherwise, the best time of day to travel with the best traffic // conditions is used to calculate the route. Setting a departure time in the past // returns a 400 ValidationException error. - // - // * In ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00 + // - In ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ . For example, 2020–07-2T12:15:20.000Z+01:00 DepartureTime *time.Time // Set the unit system to specify the distance. Default Value: Kilometers @@ -118,42 +100,32 @@ type CalculateRouteInput struct { // of positions. Default Value: false Valid Values: false | true IncludeLegGeometry *bool - // Specifies the mode of transport when calculating a route. Used in estimating the - // speed of travel and road compatibility. You can choose Car, Truck, Walking, - // Bicycle or Motorcycle as options for the TravelMode. Bicycle and Motorcycle are - // only valid when using Grab as a data provider, and only within Southeast Asia. - // Truck is not available for Grab. For more details on the using Grab for routing, - // including areas of coverage, see GrabMaps - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) in the - // Amazon Location Service Developer Guide. The TravelMode you specify also + // Specifies the mode of transport when calculating a route. Used in estimating + // the speed of travel and road compatibility. You can choose Car , Truck , Walking + // , Bicycle or Motorcycle as options for the TravelMode . Bicycle and Motorcycle + // are only valid when using Grab as a data provider, and only within Southeast + // Asia. Truck is not available for Grab. For more details on the using Grab for + // routing, including areas of coverage, see GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // in the Amazon Location Service Developer Guide. The TravelMode you specify also // determines how you specify route preferences: - // - // * If traveling by Car use the - // CarModeOptions parameter. - // - // * If traveling by Truck use the TruckModeOptions - // parameter. - // + // - If traveling by Car use the CarModeOptions parameter. + // - If traveling by Truck use the TruckModeOptions parameter. // Default Value: Car TravelMode types.TravelMode - // Specifies route preferences when traveling by Truck, such as avoiding routes + // Specifies route preferences when traveling by Truck , such as avoiding routes // that use ferries or tolls, and truck specifications to consider when choosing an - // optimal road. Requirements: TravelMode must be specified as Truck. + // optimal road. Requirements: TravelMode must be specified as Truck . TruckModeOptions *types.CalculateRouteTruckModeOptions // Specifies an ordered list of up to 23 intermediate positions to include along a // route between the departure position and destination position. - // - // * For example, - // from the DeparturePosition[-123.115, 49.285], the route follows the order that - // the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]] - // - // If - // you specify a waypoint position that's not located on a road, Amazon Location - // moves the position to the nearest road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). - // Specifying more than 23 waypoints returns a 400 ValidationException error. If + // - For example, from the DeparturePosition [-123.115, 49.285] , the route + // follows the order that the waypoint positions are given [[-122.757, + // 49.0021],[-122.349, 47.620]] + // If you specify a waypoint position that's not located on a road, Amazon + // Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . Specifying more than 23 waypoints returns a 400 ValidationException error. If // Esri is the provider for your route calculator, specifying a route that is // longer than 400 km returns a 400 RoutesValidationException error. Valid Values: // [-180 to 180,-90 to 90] @@ -167,34 +139,26 @@ type CalculateRouteInput struct { type CalculateRouteOutput struct { // Contains details about each path between a pair of positions included along a - // route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, - // and Steps. The number of legs returned corresponds to one fewer than the total - // number of positions in the request. For example, a route with a departure - // position and destination position returns one leg with the positions snapped to - // a nearby road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html): - // - // * - // The StartPosition is the departure position. - // - // * The EndPosition is the - // destination position. - // - // A route with a waypoint between the departure and - // destination position returns two legs with the positions snapped to a nearby - // road: - // - // * Leg 1: The StartPosition is the departure position . The EndPosition is - // the waypoint positon. - // - // * Leg 2: The StartPosition is the waypoint position. The - // EndPosition is the destination position. + // route such as: StartPosition , EndPosition , Distance , DurationSeconds , + // Geometry , and Steps . The number of legs returned corresponds to one fewer than + // the total number of positions in the request. For example, a route with a + // departure position and destination position returns one leg with the positions + // snapped to a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // : + // - The StartPosition is the departure position. + // - The EndPosition is the destination position. + // A route with a waypoint between the departure and destination position returns + // two legs with the positions snapped to a nearby road: + // - Leg 1: The StartPosition is the departure position . The EndPosition is the + // waypoint positon. + // - Leg 2: The StartPosition is the waypoint position. The EndPosition is the + // destination position. // // This member is required. Legs []types.Leg - // Contains information about the whole route, such as: RouteBBox, DataSource, - // Distance, DistanceUnit, and DurationSeconds. + // Contains information about the whole route, such as: RouteBBox , DataSource , + // Distance , DistanceUnit , and DurationSeconds . // // This member is required. Summary *types.CalculateRouteSummary diff --git a/service/location/api_op_CalculateRouteMatrix.go b/service/location/api_op_CalculateRouteMatrix.go index b830e51f85c..31eeb356b38 100644 --- a/service/location/api_op_CalculateRouteMatrix.go +++ b/service/location/api_op_CalculateRouteMatrix.go @@ -13,35 +13,30 @@ import ( "time" ) -// Calculates a route matrix -// (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html) +// Calculates a route matrix (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html) +// // given the following required parameters: DeparturePositions and -// DestinationPositions. CalculateRouteMatrix calculates routes and returns the +// DestinationPositions . CalculateRouteMatrix calculates routes and returns the // travel time and travel distance from each departure position to each destination // position in the request. For example, given departure positions A and B, and // destination positions X and Y, CalculateRouteMatrix will return time and // distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The // number of results returned (and routes calculated) will be the number of -// DeparturePositions times the number of DestinationPositions. Your account is +// DeparturePositions times the number of DestinationPositions . Your account is // charged for each route calculated, not the number of requests. Requires that you -// first create a route calculator resource -// (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html). -// By default, a request that doesn't specify a departure time uses the best time +// first create a route calculator resource (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html) +// . By default, a request that doesn't specify a departure time uses the best time // of day to travel with the best traffic conditions when calculating routes. // Additional options include: -// -// * Specifying a departure time -// (https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) -// using either DepartureTime or DepartNow. This calculates routes based on -// predictive traffic data at the given time. You can't specify both DepartureTime -// and DepartNow in a single request. Specifying both parameters returns a -// validation error. -// -// * Specifying a travel mode -// (https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) -// using TravelMode sets the transportation mode used to calculate the routes. This -// also lets you specify additional route preferences in CarModeOptions if -// traveling by Car, or TruckModeOptions if traveling by Truck. +// - Specifying a departure time (https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html) +// using either DepartureTime or DepartNow . This calculates routes based on +// predictive traffic data at the given time. You can't specify both +// DepartureTime and DepartNow in a single request. Specifying both parameters +// returns a validation error. +// - Specifying a travel mode (https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html) +// using TravelMode sets the transportation mode used to calculate the routes. This +// also lets you specify additional route preferences in CarModeOptions if +// traveling by Car , or TruckModeOptions if traveling by Truck . func (c *Client) CalculateRouteMatrix(ctx context.Context, params *CalculateRouteMatrixInput, optFns ...func(*Options)) (*CalculateRouteMatrixOutput, error) { if params == nil { params = &CalculateRouteMatrixInput{} @@ -66,84 +61,70 @@ type CalculateRouteMatrixInput struct { CalculatorName *string // The list of departure (origin) positions for the route matrix. An array of - // points, each of which is itself a 2-value array defined in WGS 84 - // (https://earth-info.nga.mil/GandG/wgs84/index.html) format: [longitude, - // latitude]. For example, [-123.115, 49.285]. Depending on the data provider - // selected in the route calculator resource there may be additional restrictions - // on the inputs you can choose. See Position restrictions - // (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits) + // points, each of which is itself a 2-value array defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) + // format: [longitude, latitude] . For example, [-123.115, 49.285] . Depending on + // the data provider selected in the route calculator resource there may be + // additional restrictions on the inputs you can choose. See Position restrictions (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits) // in the Amazon Location Service Developer Guide. For route calculators that use // Esri as the data provider, if you specify a departure that's not located on a - // road, Amazon Location moves the position to the nearest road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). - // The snapped value is available in the result in SnappedDeparturePositions. Valid - // Values: [-180 to 180,-90 to 90] + // road, Amazon Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . The snapped value is available in the result in SnappedDeparturePositions . + // Valid Values: [-180 to 180,-90 to 90] // // This member is required. DeparturePositions [][]float64 - // The list of destination positions for the route matrix. An array of points, each - // of which is itself a 2-value array defined in WGS 84 - // (https://earth-info.nga.mil/GandG/wgs84/index.html) format: [longitude, - // latitude]. For example, [-122.339, 47.615] Depending on the data provider - // selected in the route calculator resource there may be additional restrictions - // on the inputs you can choose. See Position restrictions - // (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits) + // The list of destination positions for the route matrix. An array of points, + // each of which is itself a 2-value array defined in WGS 84 (https://earth-info.nga.mil/GandG/wgs84/index.html) + // format: [longitude, latitude] . For example, [-122.339, 47.615] Depending on + // the data provider selected in the route calculator resource there may be + // additional restrictions on the inputs you can choose. See Position restrictions (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits) // in the Amazon Location Service Developer Guide. For route calculators that use // Esri as the data provider, if you specify a destination that's not located on a - // road, Amazon Location moves the position to the nearest road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). - // The snapped value is available in the result in SnappedDestinationPositions. + // road, Amazon Location moves the position to the nearest road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . The snapped value is available in the result in SnappedDestinationPositions . // Valid Values: [-180 to 180,-90 to 90] // // This member is required. DestinationPositions [][]float64 - // Specifies route preferences when traveling by Car, such as avoiding routes that - // use ferries or tolls. Requirements: TravelMode must be specified as Car. + // Specifies route preferences when traveling by Car , such as avoiding routes that + // use ferries or tolls. Requirements: TravelMode must be specified as Car . CarModeOptions *types.CalculateRouteCarModeOptions // Sets the time of departure as the current time. Uses the current time to - // calculate the route matrix. You can't set both DepartureTime and DepartNow. If + // calculate the route matrix. You can't set both DepartureTime and DepartNow . If // neither is set, the best time of day to travel with the best traffic conditions // is used to calculate the route matrix. Default Value: false Valid Values: false // | true DepartNow *bool // Specifies the desired time of departure. Uses the given time to calculate the - // route matrix. You can't set both DepartureTime and DepartNow. If neither is set, - // the best time of day to travel with the best traffic conditions is used to + // route matrix. You can't set both DepartureTime and DepartNow . If neither is + // set, the best time of day to travel with the best traffic conditions is used to // calculate the route matrix. Setting a departure time in the past returns a 400 // ValidationException error. - // - // * In ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00 + // - In ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ . For example, 2020–07-2T12:15:20.000Z+01:00 DepartureTime *time.Time // Set the unit system to specify the distance. Default Value: Kilometers DistanceUnit types.DistanceUnit - // Specifies the mode of transport when calculating a route. Used in estimating the - // speed of travel and road compatibility. The TravelMode you specify also + // Specifies the mode of transport when calculating a route. Used in estimating + // the speed of travel and road compatibility. The TravelMode you specify also // determines how you specify route preferences: - // - // * If traveling by Car use the - // CarModeOptions parameter. - // - // * If traveling by Truck use the TruckModeOptions - // parameter. - // - // Bicycle or Motorcycle are only valid when using Grab as a data - // provider, and only within Southeast Asia. Truck is not available for Grab. For - // more information about using Grab as a data provider, see GrabMaps - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) in the - // Amazon Location Service Developer Guide. Default Value: Car + // - If traveling by Car use the CarModeOptions parameter. + // - If traveling by Truck use the TruckModeOptions parameter. + // Bicycle or Motorcycle are only valid when using Grab as a data provider, and + // only within Southeast Asia. Truck is not available for Grab. For more + // information about using Grab as a data provider, see GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // in the Amazon Location Service Developer Guide. Default Value: Car TravelMode types.TravelMode - // Specifies route preferences when traveling by Truck, such as avoiding routes + // Specifies route preferences when traveling by Truck , such as avoiding routes // that use ferries or tolls, and truck specifications to consider when choosing an - // optimal road. Requirements: TravelMode must be specified as Truck. + // optimal road. Requirements: TravelMode must be specified as Truck . TruckModeOptions *types.CalculateRouteTruckModeOptions noSmithyDocumentSerde @@ -153,15 +134,15 @@ type CalculateRouteMatrixInput struct { type CalculateRouteMatrixOutput struct { // The calculated route matrix containing the results for all pairs of - // DeparturePositions to DestinationPositions. Each row corresponds to one entry in - // DeparturePositions. Each entry in the row corresponds to the route from that - // entry in DeparturePositions to an entry in DestinationPositions. + // DeparturePositions to DestinationPositions . Each row corresponds to one entry + // in DeparturePositions . Each entry in the row corresponds to the route from that + // entry in DeparturePositions to an entry in DestinationPositions . // // This member is required. RouteMatrix [][]types.RouteMatrixEntry - // Contains information about the route matrix, DataSource, DistanceUnit, - // RouteCount and ErrorCount. + // Contains information about the route matrix, DataSource , DistanceUnit , + // RouteCount and ErrorCount . // // This member is required. Summary *types.CalculateRouteMatrixSummary @@ -169,11 +150,11 @@ type CalculateRouteMatrixOutput struct { // For routes calculated using an Esri route calculator resource, departure // positions are snapped to the closest road. For Esri route calculator resources, // this returns the list of departure/origin positions used for calculation of the - // RouteMatrix. + // RouteMatrix . SnappedDeparturePositions [][]float64 // The list of destination positions for the route matrix used for calculation of - // the RouteMatrix. + // the RouteMatrix . SnappedDestinationPositions [][]float64 // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_CreateGeofenceCollection.go b/service/location/api_op_CreateGeofenceCollection.go index ba4fcf0e056..ccd92c5a0d7 100644 --- a/service/location/api_op_CreateGeofenceCollection.go +++ b/service/location/api_op_CreateGeofenceCollection.go @@ -32,15 +32,10 @@ func (c *Client) CreateGeofenceCollection(ctx context.Context, params *CreateGeo type CreateGeofenceCollectionInput struct { // A custom name for the geofence collection. Requirements: - // - // * Contain only - // alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and - // underscores (_). - // - // * Must be a unique geofence collection name. - // - // * No spaces - // allowed. For example, ExampleGeofenceCollection. + // - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods + // (.), and underscores (_). + // - Must be a unique geofence collection name. + // - No spaces allowed. For example, ExampleGeofenceCollection . // // This member is required. CollectionName *string @@ -48,12 +43,11 @@ type CreateGeofenceCollectionInput struct { // An optional description for the geofence collection. Description *string - // A key identifier for an Amazon Web Services KMS customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). Enter - // a key ID, key ARN, alias name, or alias ARN. + // A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // . Enter a key ID, key ARN, alias name, or alias ARN. KmsKeyId *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -67,22 +61,13 @@ type CreateGeofenceCollectionInput struct { // Applies one or more tags to the geofence collection. A tag is a key-value pair // helps manage, identify, search, and filter your resources by labelling them. // Format: "key" : "value" Restrictions: - // - // * Maximum 50 tags per resource - // - // * Each - // resource tag must be unique with a maximum of one value. - // - // * Maximum key length: - // 128 Unicode characters in UTF-8 - // - // * Maximum value length: 256 Unicode characters - // in UTF-8 - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following - // characters: + - = . _ : / @. - // - // * Cannot use "aws:" as a prefix for a key. + // - Maximum 50 tags per resource + // - Each resource tag must be unique with a maximum of one value. + // - Maximum key length: 128 Unicode characters in UTF-8 + // - Maximum value length: 256 Unicode characters in UTF-8 + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -92,10 +77,8 @@ type CreateGeofenceCollectionOutput struct { // The Amazon Resource Name (ARN) for the geofence collection resource. Used when // you need to specify a resource across all Amazon Web Services. - // - // * Format - // example: - // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection + // - Format example: + // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection // // This member is required. CollectionArn *string @@ -105,9 +88,8 @@ type CreateGeofenceCollectionOutput struct { // This member is required. CollectionName *string - // The timestamp for when the geofence collection was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence collection was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. CreateTime *time.Time diff --git a/service/location/api_op_CreateKey.go b/service/location/api_op_CreateKey.go index f418756ef0a..d82459e0b4b 100644 --- a/service/location/api_op_CreateKey.go +++ b/service/location/api_op_CreateKey.go @@ -16,9 +16,9 @@ import ( // Creates an API key resource in your Amazon Web Services account, which lets you // grant geo:GetMap* actions for Amazon Location Map resources to the API key // bearer. The API keys feature is in preview. We may add, change, or remove -// features before announcing general availability. For more information, see Using -// API keys -// (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html). +// features before announcing general availability. For more information, see +// Using API keys (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) +// . func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error) { if params == nil { params = &CreateKeyInput{} @@ -37,15 +37,10 @@ func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns . type CreateKeyInput struct { // A custom name for the API key resource. Requirements: - // - // * Contain only - // alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and - // underscores (_). - // - // * Must be a unique API key name. - // - // * No spaces allowed. For - // example, ExampleAPIKey. + // - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods + // (.), and underscores (_). + // - Must be a unique API key name. + // - No spaces allowed. For example, ExampleAPIKey . // // This member is required. KeyName *string @@ -58,9 +53,8 @@ type CreateKeyInput struct { // An optional description for the API key resource. Description *string - // The optional timestamp for when the API key resource will expire in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set. + // The optional timestamp for when the API key resource will expire in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . One of NoExpiry or ExpireTime must be set. ExpireTime *time.Time // Optionally set to true to set no expiration time for the API key. One of @@ -70,22 +64,13 @@ type CreateKeyInput struct { // Applies one or more tags to the map resource. A tag is a key-value pair that // helps manage, identify, search, and filter your resources by labelling them. // Format: "key" : "value" Restrictions: - // - // * Maximum 50 tags per resource - // - // * Each - // resource tag must be unique with a maximum of one value. - // - // * Maximum key length: - // 128 Unicode characters in UTF-8 - // - // * Maximum value length: 256 Unicode characters - // in UTF-8 - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following - // characters: + - = . _ : / @. - // - // * Cannot use "aws:" as a prefix for a key. + // - Maximum 50 tags per resource + // - Each resource tag must be unique with a maximum of one value. + // - Maximum key length: 128 Unicode characters in UTF-8 + // - Maximum value length: 256 Unicode characters in UTF-8 + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -93,25 +78,22 @@ type CreateKeyInput struct { type CreateKeyOutput struct { - // The timestamp for when the API key resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The key value/string of an API key. This value is used when making API calls to - // authorize the call. For example, see GetMapGlyphs - // (https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html). + // authorize the call. For example, see GetMapGlyphs (https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html) + // . // // This member is required. Key *string // The Amazon Resource Name (ARN) for the API key resource. Used when you need to // specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:key/ExampleKey + // - Format example: arn:aws:geo:region:account-id:key/ExampleKey // // This member is required. KeyArn *string diff --git a/service/location/api_op_CreateMap.go b/service/location/api_op_CreateMap.go index 9e405eb32a7..a75c1a09ab7 100644 --- a/service/location/api_op_CreateMap.go +++ b/service/location/api_op_CreateMap.go @@ -17,8 +17,8 @@ import ( // tiles of different styles sourced from global location data providers. If your // application is tracking or routing assets you use in your business, such as // delivery vehicles or employees, you must not use Esri as your geolocation -// provider. See section 82 of the Amazon Web Services service terms -// (http://aws.amazon.com/service-terms) for more details. +// provider. See section 82 of the Amazon Web Services service terms (http://aws.amazon.com/service-terms) +// for more details. func (c *Client) CreateMap(ctx context.Context, params *CreateMapInput, optFns ...func(*Options)) (*CreateMapOutput, error) { if params == nil { params = &CreateMapInput{} @@ -36,7 +36,7 @@ func (c *Client) CreateMap(ctx context.Context, params *CreateMapInput, optFns . type CreateMapInput struct { - // Specifies the MapConfiguration, including the map style, for the map resource + // Specifies the MapConfiguration , including the map style, for the map resource // that you create. The map style defines the look of maps and the data provider // for your map resource. // @@ -44,15 +44,10 @@ type CreateMapInput struct { Configuration *types.MapConfiguration // The name for the map resource. Requirements: - // - // * Must contain only alphanumeric - // characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). - // - // * - // Must be a unique map resource name. - // - // * No spaces allowed. For example, - // ExampleMap. + // - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), + // periods (.), and underscores (_). + // - Must be a unique map resource name. + // - No spaces allowed. For example, ExampleMap . // // This member is required. MapName *string @@ -60,7 +55,7 @@ type CreateMapInput struct { // An optional description for the map resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -69,22 +64,13 @@ type CreateMapInput struct { // Applies one or more tags to the map resource. A tag is a key-value pair helps // manage, identify, search, and filter your resources by labelling them. Format: // "key" : "value" Restrictions: - // - // * Maximum 50 tags per resource - // - // * Each resource - // tag must be unique with a maximum of one value. - // - // * Maximum key length: 128 - // Unicode characters in UTF-8 - // - // * Maximum value length: 256 Unicode characters in - // UTF-8 - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following - // characters: + - = . _ : / @. - // - // * Cannot use "aws:" as a prefix for a key. + // - Maximum 50 tags per resource + // - Each resource tag must be unique with a maximum of one value. + // - Maximum key length: 128 Unicode characters in UTF-8 + // - Maximum value length: 256 Unicode characters in UTF-8 + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -92,18 +78,15 @@ type CreateMapInput struct { type CreateMapOutput struct { - // The timestamp for when the map resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The Amazon Resource Name (ARN) for the map resource. Used to specify a resource // across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:map/ExampleMap + // - Format example: arn:aws:geo:region:account-id:map/ExampleMap // // This member is required. MapArn *string diff --git a/service/location/api_op_CreatePlaceIndex.go b/service/location/api_op_CreatePlaceIndex.go index d17d5cdd56d..175ad11ae40 100644 --- a/service/location/api_op_CreatePlaceIndex.go +++ b/service/location/api_op_CreatePlaceIndex.go @@ -19,8 +19,8 @@ import ( // SearchPlaceIndexForPosition operation, and enable autosuggestions by using the // SearchPlaceIndexForSuggestions operation. If your application is tracking or // routing assets you use in your business, such as delivery vehicles or employees, -// you must not use Esri as your geolocation provider. See section 82 of the Amazon -// Web Services service terms (http://aws.amazon.com/service-terms) for more +// you must not use Esri as your geolocation provider. See section 82 of the +// Amazon Web Services service terms (http://aws.amazon.com/service-terms) for more // details. func (c *Client) CreatePlaceIndex(ctx context.Context, params *CreatePlaceIndexInput, optFns ...func(*Options)) (*CreatePlaceIndexOutput, error) { if params == nil { @@ -42,49 +42,31 @@ type CreatePlaceIndexInput struct { // Specifies the geospatial data provider for the new place index. This field is // case-sensitive. Enter the valid values as shown. For example, entering HERE // returns an error. Valid values include: - // - // * Esri – For additional information - // about Esri - // (https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s - // coverage in your region of interest, see Esri details on geocoding coverage - // (https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm). - // - // * - // Grab – Grab provides place index functionality for Southeast Asia. For - // additional information about GrabMaps - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)' - // coverage, see GrabMaps countries and areas covered - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area). - // - // * - // Here – For additional information about HERE Technologies - // (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' coverage - // in your region of interest, see HERE details on goecoding coverage - // (https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html). - // If you specify HERE Technologies (Here) as the data provider, you may not store - // results - // (https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) - // for locations in Japan. For more information, see the Amazon Web Services - // Service Terms (http://aws.amazon.com/service-terms/) for Amazon Location - // Service. - // - // For additional information , see Data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // - Esri – For additional information about Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) + // 's coverage in your region of interest, see Esri details on geocoding coverage (https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) + // . + // - Grab – Grab provides place index functionality for Southeast Asia. For + // additional information about GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // ' coverage, see GrabMaps countries and areas covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) + // . + // - Here – For additional information about HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) + // ' coverage in your region of interest, see HERE details on goecoding coverage (https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) + // . If you specify HERE Technologies ( Here ) as the data provider, you may not + // store results (https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) + // for locations in Japan. For more information, see the Amazon Web Services + // Service Terms (http://aws.amazon.com/service-terms/) for Amazon Location + // Service. + // For additional information , see Data providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) // on the Amazon Location Service Developer Guide. // // This member is required. DataSource *string // The name of the place index resource. Requirements: - // - // * Contain only alphanumeric - // characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). - // - // * - // Must be a unique place index resource name. - // - // * No spaces allowed. For example, - // ExamplePlaceIndex. + // - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods + // (.), and underscores (_). + // - Must be a unique place index resource name. + // - No spaces allowed. For example, ExamplePlaceIndex . // // This member is required. IndexName *string @@ -95,7 +77,7 @@ type CreatePlaceIndexInput struct { // The optional description for the place index resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -104,23 +86,13 @@ type CreatePlaceIndexInput struct { // Applies one or more tags to the place index resource. A tag is a key-value pair // that helps you manage, identify, search, and filter your resources. Format: // "key" : "value" Restrictions: - // - // * Maximum 50 tags per resource. - // - // * Each tag key - // must be unique and must have exactly one associated value. - // - // * Maximum key - // length: 128 Unicode characters in UTF-8. - // - // * Maximum value length: 256 Unicode - // characters in UTF-8. - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the - // following characters: + - = . _ : / @ - // - // * Cannot use "aws:" as a prefix for a - // key. + // - Maximum 50 tags per resource. + // - Each tag key must be unique and must have exactly one associated value. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @ + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -128,18 +100,15 @@ type CreatePlaceIndexInput struct { type CreatePlaceIndexOutput struct { - // The timestamp for when the place index resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The Amazon Resource Name (ARN) for the place index resource. Used to specify a // resource across Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex + // - Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex // // This member is required. IndexArn *string diff --git a/service/location/api_op_CreateRouteCalculator.go b/service/location/api_op_CreateRouteCalculator.go index b204343ecf1..d7acf619d8f 100644 --- a/service/location/api_op_CreateRouteCalculator.go +++ b/service/location/api_op_CreateRouteCalculator.go @@ -13,13 +13,14 @@ import ( "time" ) -// Creates a route calculator resource in your Amazon Web Services account. You can -// send requests to a route calculator resource to estimate travel time, distance, -// and get directions. A route calculator sources traffic and road network data -// from your chosen data provider. If your application is tracking or routing -// assets you use in your business, such as delivery vehicles or employees, you -// must not use Esri as your geolocation provider. See section 82 of the Amazon Web -// Services service terms (http://aws.amazon.com/service-terms) for more details. +// Creates a route calculator resource in your Amazon Web Services account. You +// can send requests to a route calculator resource to estimate travel time, +// distance, and get directions. A route calculator sources traffic and road +// network data from your chosen data provider. If your application is tracking or +// routing assets you use in your business, such as delivery vehicles or employees, +// you must not use Esri as your geolocation provider. See section 82 of the +// Amazon Web Services service terms (http://aws.amazon.com/service-terms) for more +// details. func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteCalculatorInput, optFns ...func(*Options)) (*CreateRouteCalculatorOutput, error) { if params == nil { params = &CreateRouteCalculatorInput{} @@ -38,15 +39,10 @@ func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteC type CreateRouteCalculatorInput struct { // The name of the route calculator resource. Requirements: - // - // * Can use alphanumeric - // characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_). - // - // * - // Must be a unique Route calculator resource name. - // - // * No spaces allowed. For - // example, ExampleRouteCalculator. + // - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), + // and underscores (_). + // - Must be a unique Route calculator resource name. + // - No spaces allowed. For example, ExampleRouteCalculator . // // This member is required. CalculatorName *string @@ -54,33 +50,20 @@ type CreateRouteCalculatorInput struct { // Specifies the data provider of traffic and road network data. This field is // case-sensitive. Enter the valid values as shown. For example, entering HERE // returns an error. Valid values include: - // - // * Esri – For additional information - // about Esri - // (https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s - // coverage in your region of interest, see Esri details on street networks and - // traffic coverage - // (https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm). Route - // calculators that use Esri as a data source only calculate routes that are - // shorter than 400 km. - // - // * Grab – Grab provides routing functionality for Southeast - // Asia. For additional information about GrabMaps - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html)' - // coverage, see GrabMaps countries and areas covered - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area). - // - // * - // Here – For additional information about HERE Technologies - // (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' coverage - // in your region of interest, see HERE car routing coverage - // (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html) - // and HERE truck routing coverage - // (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html). - // - // For - // additional information , see Data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // - Esri – For additional information about Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) + // 's coverage in your region of interest, see Esri details on street networks + // and traffic coverage (https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm) + // . Route calculators that use Esri as a data source only calculate routes that + // are shorter than 400 km. + // - Grab – Grab provides routing functionality for Southeast Asia. For + // additional information about GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // ' coverage, see GrabMaps countries and areas covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) + // . + // - Here – For additional information about HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) + // ' coverage in your region of interest, see HERE car routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html) + // and HERE truck routing coverage (https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html) + // . + // For additional information , see Data providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) // on the Amazon Location Service Developer Guide. // // This member is required. @@ -89,7 +72,7 @@ type CreateRouteCalculatorInput struct { // The optional description for the route calculator resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -98,27 +81,15 @@ type CreateRouteCalculatorInput struct { // Applies one or more tags to the route calculator resource. A tag is a key-value // pair helps manage, identify, search, and filter your resources by labelling // them. - // - // * For example: { "tag1" : "value1", "tag2" : "value2"} - // - // Format: "key" : - // "value" Restrictions: - // - // * Maximum 50 tags per resource - // - // * Each resource tag must - // be unique with a maximum of one value. - // - // * Maximum key length: 128 Unicode - // characters in UTF-8 - // - // * Maximum value length: 256 Unicode characters in UTF-8 - // - // * - // Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - // - = . _ : / @. - // - // * Cannot use "aws:" as a prefix for a key. + // - For example: { "tag1" : "value1" , "tag2" : "value2" } + // Format: "key" : "value" Restrictions: + // - Maximum 50 tags per resource + // - Each resource tag must be unique with a maximum of one value. + // - Maximum key length: 128 Unicode characters in UTF-8 + // - Maximum value length: 256 Unicode characters in UTF-8 + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -128,26 +99,21 @@ type CreateRouteCalculatorOutput struct { // The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN // when you specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:route-calculator/ExampleCalculator + // - Format example: + // arn:aws:geo:region:account-id:route-calculator/ExampleCalculator // // This member is required. CalculatorArn *string // The name of the route calculator resource. - // - // * For example, - // ExampleRouteCalculator. + // - For example, ExampleRouteCalculator . // // This member is required. CalculatorName *string - // The timestamp when the route calculator resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. - // - // * For example, 2020–07-2T12:15:20.000Z+01:00 + // The timestamp when the route calculator resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // - For example, 2020–07-2T12:15:20.000Z+01:00 // // This member is required. CreateTime *time.Time diff --git a/service/location/api_op_CreateTracker.go b/service/location/api_op_CreateTracker.go index d66ae61ce01..8368453090f 100644 --- a/service/location/api_op_CreateTracker.go +++ b/service/location/api_op_CreateTracker.go @@ -33,15 +33,10 @@ func (c *Client) CreateTracker(ctx context.Context, params *CreateTrackerInput, type CreateTrackerInput struct { // The name for the tracker resource. Requirements: - // - // * Contain only alphanumeric - // characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). - // - // * - // Must be a unique tracker resource name. - // - // * No spaces allowed. For example, - // ExampleTracker. + // - Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods + // (.), and underscores (_). + // - Must be a unique tracker resource name. + // - No spaces allowed. For example, ExampleTracker . // // This member is required. TrackerName *string @@ -49,40 +44,32 @@ type CreateTrackerInput struct { // An optional description for the tracker resource. Description *string - // A key identifier for an Amazon Web Services KMS customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). Enter - // a key ID, key ARN, alias name, or alias ARN. + // A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // . Enter a key ID, key ARN, alias name, or alias ARN. KmsKeyId *string // Specifies the position filtering for the tracker resource. Valid values: - // - // * - // TimeBased - Location updates are evaluated against linked geofence collections, - // but not every location update is stored. If your update frequency is more often - // than 30 seconds, only one update per 30 seconds is stored for each unique device - // ID. - // - // * DistanceBased - If the device has moved less than 30 m (98.4 ft), - // location updates are ignored. Location updates within this area are neither - // evaluated against linked geofence collections, nor stored. This helps control - // costs by reducing the number of geofence evaluations and historical device - // positions to paginate through. Distance-based filtering can also reduce the - // effects of GPS noise when displaying device trajectories on a map. - // - // * - // AccuracyBased - If the device has moved less than the measured accuracy, - // location updates are ignored. For example, if two consecutive updates from a - // device have a horizontal accuracy of 5 m and 10 m, the second update is ignored - // if the device has moved less than 15 m. Ignored location updates are neither - // evaluated against linked geofence collections, nor stored. This can reduce the - // effects of GPS noise when displaying device trajectories on a map, and can help - // control your costs by reducing the number of geofence evaluations. - // - // This field - // is optional. If not specified, the default value is TimeBased. + // - TimeBased - Location updates are evaluated against linked geofence + // collections, but not every location update is stored. If your update frequency + // is more often than 30 seconds, only one update per 30 seconds is stored for each + // unique device ID. + // - DistanceBased - If the device has moved less than 30 m (98.4 ft), location + // updates are ignored. Location updates within this area are neither evaluated + // against linked geofence collections, nor stored. This helps control costs by + // reducing the number of geofence evaluations and historical device positions to + // paginate through. Distance-based filtering can also reduce the effects of GPS + // noise when displaying device trajectories on a map. + // - AccuracyBased - If the device has moved less than the measured accuracy, + // location updates are ignored. For example, if two consecutive updates from a + // device have a horizontal accuracy of 5 m and 10 m, the second update is ignored + // if the device has moved less than 15 m. Ignored location updates are neither + // evaluated against linked geofence collections, nor stored. This can reduce the + // effects of GPS noise when displaying device trajectories on a map, and can help + // control your costs by reducing the number of geofence evaluations. + // This field is optional. If not specified, the default value is TimeBased . PositionFiltering types.PositionFiltering - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -96,22 +83,13 @@ type CreateTrackerInput struct { // Applies one or more tags to the tracker resource. A tag is a key-value pair // helps manage, identify, search, and filter your resources by labelling them. // Format: "key" : "value" Restrictions: - // - // * Maximum 50 tags per resource - // - // * Each - // resource tag must be unique with a maximum of one value. - // - // * Maximum key length: - // 128 Unicode characters in UTF-8 - // - // * Maximum value length: 256 Unicode characters - // in UTF-8 - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following - // characters: + - = . _ : / @. - // - // * Cannot use "aws:" as a prefix for a key. + // - Maximum 50 tags per resource + // - Each resource tag must be unique with a maximum of one value. + // - Maximum key length: 128 Unicode characters in UTF-8 + // - Maximum value length: 256 Unicode characters in UTF-8 + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @. + // - Cannot use "aws:" as a prefix for a key. Tags map[string]string noSmithyDocumentSerde @@ -119,18 +97,15 @@ type CreateTrackerInput struct { type CreateTrackerOutput struct { - // The timestamp for when the tracker resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The Amazon Resource Name (ARN) for the tracker resource. Used when you need to // specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:tracker/ExampleTracker + // - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker // // This member is required. TrackerArn *string diff --git a/service/location/api_op_DeleteTracker.go b/service/location/api_op_DeleteTracker.go index 5fbcf2263cf..66f204eff26 100644 --- a/service/location/api_op_DeleteTracker.go +++ b/service/location/api_op_DeleteTracker.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a tracker resource from your Amazon Web Services account. This operation -// deletes the resource permanently. If the tracker resource is in use, you may -// encounter an error. Make sure that the target resource isn't a dependency for -// your applications. +// Deletes a tracker resource from your Amazon Web Services account. This +// operation deletes the resource permanently. If the tracker resource is in use, +// you may encounter an error. Make sure that the target resource isn't a +// dependency for your applications. func (c *Client) DeleteTracker(ctx context.Context, params *DeleteTrackerInput, optFns ...func(*Options)) (*DeleteTrackerOutput, error) { if params == nil { params = &DeleteTrackerInput{} diff --git a/service/location/api_op_DescribeGeofenceCollection.go b/service/location/api_op_DescribeGeofenceCollection.go index 4e1fa4ef529..f94a2bb211f 100644 --- a/service/location/api_op_DescribeGeofenceCollection.go +++ b/service/location/api_op_DescribeGeofenceCollection.go @@ -43,10 +43,8 @@ type DescribeGeofenceCollectionOutput struct { // The Amazon Resource Name (ARN) for the geofence collection resource. Used when // you need to specify a resource across all Amazon Web Services. - // - // * Format - // example: - // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection + // - Format example: + // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection // // This member is required. CollectionArn *string @@ -56,9 +54,8 @@ type DescribeGeofenceCollectionOutput struct { // This member is required. CollectionName *string - // The timestamp for when the geofence resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. CreateTime *time.Time @@ -68,19 +65,17 @@ type DescribeGeofenceCollectionOutput struct { // This member is required. Description *string - // The timestamp for when the geofence collection was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence collection was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time - // A key identifier for an Amazon Web Services KMS customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) // assigned to the Amazon Location resource KmsKeyId *string - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan types.PricingPlan diff --git a/service/location/api_op_DescribeKey.go b/service/location/api_op_DescribeKey.go index 6c9e2aacbc8..3d5c0bfdbbf 100644 --- a/service/location/api_op_DescribeKey.go +++ b/service/location/api_op_DescribeKey.go @@ -15,8 +15,8 @@ import ( // Retrieves the API key resource details. The API keys feature is in preview. We // may add, change, or remove features before announcing general availability. For -// more information, see Using API keys -// (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html). +// more information, see Using API keys (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) +// . func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optFns ...func(*Options)) (*DescribeKeyOutput, error) { if params == nil { params = &DescribeKeyInput{} @@ -44,16 +44,14 @@ type DescribeKeyInput struct { type DescribeKeyOutput struct { - // The timestamp for when the API key resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time - // The timestamp for when the API key resource will expire in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource will expire in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. ExpireTime *time.Time @@ -65,9 +63,7 @@ type DescribeKeyOutput struct { // The Amazon Resource Name (ARN) for the API key resource. Used when you need to // specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:key/ExampleKey + // - Format example: arn:aws:geo:region:account-id:key/ExampleKey // // This member is required. KeyArn *string @@ -83,9 +79,8 @@ type DescribeKeyOutput struct { // This member is required. Restrictions *types.ApiKeyRestrictions - // The timestamp for when the API key resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_DescribeMap.go b/service/location/api_op_DescribeMap.go index 7e55e73d288..621034be006 100644 --- a/service/location/api_op_DescribeMap.go +++ b/service/location/api_op_DescribeMap.go @@ -46,9 +46,8 @@ type DescribeMapOutput struct { // This member is required. Configuration *types.MapConfiguration - // The timestamp for when the map resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time @@ -65,9 +64,7 @@ type DescribeMapOutput struct { // The Amazon Resource Name (ARN) for the map resource. Used to specify a resource // across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:map/ExampleMap + // - Format example: arn:aws:geo:region:account-id:map/ExampleMap // // This member is required. MapArn *string @@ -77,14 +74,13 @@ type DescribeMapOutput struct { // This member is required. MapName *string - // The timestamp for when the map resource was last update in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was last update in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan types.PricingPlan diff --git a/service/location/api_op_DescribePlaceIndex.go b/service/location/api_op_DescribePlaceIndex.go index 924aedaed5a..f0db9104ddd 100644 --- a/service/location/api_op_DescribePlaceIndex.go +++ b/service/location/api_op_DescribePlaceIndex.go @@ -41,25 +41,19 @@ type DescribePlaceIndexInput struct { type DescribePlaceIndexOutput struct { - // The timestamp for when the place index resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The data provider of geospatial data. Values can be one of the following: - // - // * - // Esri - // - // * Grab - // - // * Here - // - // For more information about data providers, see Amazon - // Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -76,9 +70,7 @@ type DescribePlaceIndexOutput struct { // The Amazon Resource Name (ARN) for the place index resource. Used to specify a // resource across Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex + // - Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex // // This member is required. IndexArn *string @@ -88,14 +80,13 @@ type DescribePlaceIndexOutput struct { // This member is required. IndexName *string - // The timestamp for when the place index resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan types.PricingPlan diff --git a/service/location/api_op_DescribeRouteCalculator.go b/service/location/api_op_DescribeRouteCalculator.go index 6d3e6d064b6..53a1e6821cf 100644 --- a/service/location/api_op_DescribeRouteCalculator.go +++ b/service/location/api_op_DescribeRouteCalculator.go @@ -43,9 +43,8 @@ type DescribeRouteCalculatorOutput struct { // The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN // when you specify a resource across Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:route-calculator/ExampleCalculator + // - Format example: + // arn:aws:geo:region:account-id:route-calculator/ExampleCalculator // // This member is required. CalculatorArn *string @@ -55,27 +54,21 @@ type DescribeRouteCalculatorOutput struct { // This member is required. CalculatorName *string - // The timestamp when the route calculator resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. - // - // * For example, 2020–07-2T12:15:20.000Z+01:00 + // The timestamp when the route calculator resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // - For example, 2020–07-2T12:15:20.000Z+01:00 // // This member is required. CreateTime *time.Time // The data provider of traffic and road network data. Indicates one of the // available providers: - // - // * Esri - // - // * Grab - // - // * Here - // - // For more information about data - // providers, see Amazon Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -85,16 +78,14 @@ type DescribeRouteCalculatorOutput struct { // This member is required. Description *string - // The timestamp when the route calculator resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. - // - // * For example, 2020–07-2T12:15:20.000Z+01:00 + // The timestamp when the route calculator resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // - For example, 2020–07-2T12:15:20.000Z+01:00 // // This member is required. UpdateTime *time.Time - // Always returns RequestBasedUsage. + // Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan types.PricingPlan diff --git a/service/location/api_op_DescribeTracker.go b/service/location/api_op_DescribeTracker.go index 5687c76cc22..50a7b1dc852 100644 --- a/service/location/api_op_DescribeTracker.go +++ b/service/location/api_op_DescribeTracker.go @@ -41,9 +41,8 @@ type DescribeTrackerInput struct { type DescribeTrackerOutput struct { - // The timestamp for when the tracker resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time @@ -55,9 +54,7 @@ type DescribeTrackerOutput struct { // The Amazon Resource Name (ARN) for the tracker resource. Used when you need to // specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:tracker/ExampleTracker + // - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker // // This member is required. TrackerArn *string @@ -67,22 +64,20 @@ type DescribeTrackerOutput struct { // This member is required. TrackerName *string - // The timestamp for when the tracker resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // A key identifier for an Amazon Web Services KMS customer managed key - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) + // A key identifier for an Amazon Web Services KMS customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) // assigned to the Amazon Location resource. KmsKeyId *string // The position filtering method of the tracker resource. PositionFiltering types.PositionFiltering - // Always returns RequestBasedUsage. + // Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan types.PricingPlan diff --git a/service/location/api_op_DisassociateTrackerConsumer.go b/service/location/api_op_DisassociateTrackerConsumer.go index 34561e56c84..cfdae6c849d 100644 --- a/service/location/api_op_DisassociateTrackerConsumer.go +++ b/service/location/api_op_DisassociateTrackerConsumer.go @@ -34,9 +34,8 @@ type DisassociateTrackerConsumerInput struct { // The Amazon Resource Name (ARN) for the geofence collection to be disassociated // from the tracker resource. Used when you need to specify a resource across all // Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer + // - Format example: + // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer // // This member is required. ConsumerArn *string diff --git a/service/location/api_op_GetDevicePosition.go b/service/location/api_op_GetDevicePosition.go index 8fd542addaa..c766729e92b 100644 --- a/service/location/api_op_GetDevicePosition.go +++ b/service/location/api_op_GetDevicePosition.go @@ -52,16 +52,15 @@ type GetDevicePositionOutput struct { // This member is required. Position []float64 - // The timestamp for when the tracker resource received the device position in ISO - // 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource received the device position in + // ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. ReceivedTime *time.Time - // The timestamp at which the device's position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp at which the device's position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. SampleTime *time.Time diff --git a/service/location/api_op_GetDevicePositionHistory.go b/service/location/api_op_GetDevicePositionHistory.go index 4c209bd8c76..ba21a294831 100644 --- a/service/location/api_op_GetDevicePositionHistory.go +++ b/service/location/api_op_GetDevicePositionHistory.go @@ -13,8 +13,8 @@ import ( "time" ) -// Retrieves the device position history from a tracker resource within a specified -// range of time. Device positions are deleted after 30 days. +// Retrieves the device position history from a tracker resource within a +// specified range of time. Device positions are deleted after 30 days. func (c *Client) GetDevicePositionHistory(ctx context.Context, params *GetDevicePositionHistoryInput, optFns ...func(*Options)) (*GetDevicePositionHistoryOutput, error) { if params == nil { params = &GetDevicePositionHistoryInput{} @@ -42,30 +42,26 @@ type GetDevicePositionHistoryInput struct { // This member is required. TrackerName *string - // Specify the end time for the position history in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the - // request is made. Requirement: - // - // * The time specified for EndTimeExclusive must be - // after the time for StartTimeInclusive. + // Specify the end time for the position history in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . By default, the value will be the time that + // the request is made. Requirement: + // - The time specified for EndTimeExclusive must be after the time for + // StartTimeInclusive . EndTimeExclusive *time.Time // An optional limit for the number of device positions returned in a single call. // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string - // Specify the start time for the position history in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the - // time that the request is made. Requirement: - // - // * The time specified for - // StartTimeInclusive must be before EndTimeExclusive. + // Specify the start time for the position history in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . By default, the value will be 24 hours prior + // to the time that the request is made. Requirement: + // - The time specified for StartTimeInclusive must be before EndTimeExclusive . StartTimeInclusive *time.Time noSmithyDocumentSerde diff --git a/service/location/api_op_GetGeofence.go b/service/location/api_op_GetGeofence.go index 25a7e26d110..cdb60679733 100644 --- a/service/location/api_op_GetGeofence.go +++ b/service/location/api_op_GetGeofence.go @@ -46,9 +46,8 @@ type GetGeofenceInput struct { type GetGeofenceOutput struct { - // The timestamp for when the geofence collection was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence collection was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. CreateTime *time.Time @@ -65,26 +64,17 @@ type GetGeofenceOutput struct { // Identifies the state of the geofence. A geofence will hold one of the following // states: - // - // * ACTIVE — The geofence has been indexed by the system. - // - // * PENDING — - // The geofence is being processed by the system. - // - // * FAILED — The geofence failed - // to be indexed by the system. - // - // * DELETED — The geofence has been deleted from the - // system index. - // - // * DELETING — The geofence is being deleted from the system index. + // - ACTIVE — The geofence has been indexed by the system. + // - PENDING — The geofence is being processed by the system. + // - FAILED — The geofence failed to be indexed by the system. + // - DELETED — The geofence has been deleted from the system index. + // - DELETING — The geofence is being deleted from the system index. // // This member is required. Status *string - // The timestamp for when the geofence collection was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence collection was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_GetMapGlyphs.go b/service/location/api_op_GetMapGlyphs.go index 0b22f04289c..09225c710a0 100644 --- a/service/location/api_op_GetMapGlyphs.go +++ b/service/location/api_op_GetMapGlyphs.go @@ -30,65 +30,43 @@ func (c *Client) GetMapGlyphs(ctx context.Context, params *GetMapGlyphsInput, op type GetMapGlyphsInput struct { // A comma-separated list of fonts to load glyphs from in order of preference. For - // example, Noto Sans Regular, Arial Unicode. Valid fonts stacks for Esri - // (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) + // example, Noto Sans Regular, Arial Unicode . Valid fonts stacks for Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) // styles: - // - // * VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | - // Ubuntu Italic | Ubuntu Regular | Ubuntu Bold - // - // * VectorEsriLightGrayCanvas – - // Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold - // - // * - // VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | - // Noto Serif Regular | Roboto Condensed Light Italic - // - // * VectorEsriStreets – Arial - // Regular | Arial Italic | Arial Bold - // - // * VectorEsriNavigation – Arial Regular | - // Arial Italic | Arial Bold - // - // Valid font stacks for HERE Technologies - // (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) + // - VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu + // Italic | Ubuntu Regular | Ubuntu Bold + // - VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | + // Ubuntu Bold + // - VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans + // Bold | Noto Serif Regular | Roboto Condensed Light Italic + // - VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold + // - VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold + // Valid font stacks for HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) // styles: - // - // * VectorHereContrast – Fira GO Regular | Fira GO Bold - // - // * - // VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO - // Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK - // JP Light | Noto Sans CJK JP Regular - // - // Valid font stacks for GrabMaps - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // - VectorHereContrast – Fira GO Regular | Fira GO Bold + // - VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – + // Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | + // Noto Sans CJK JP Light | Noto Sans CJK JP Regular + // Valid font stacks for GrabMaps (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) // styles: - // - // * VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | - // Noto Sans Medium | Noto Sans Bold - // - // Valid font stacks for Open Data - // (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html) + // - VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto + // Sans Medium | Noto Sans Bold + // Valid font stacks for Open Data (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html) // styles: - // - // * VectorOpenDataStandardLight, VectorOpenDataStandardDark, - // VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon Ember - // Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember - // Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon - // Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC - // Bold,Noto Sans Bold - // - // The fonts used by the Open Data map styles are combined - // fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported - // by Amazon Ember. + // - VectorOpenDataStandardLight, VectorOpenDataStandardDark, + // VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon + // Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon + // Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | + // Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed + // RC Bold,Noto Sans Bold + // The fonts used by the Open Data map styles are combined fonts that use Amazon + // Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember . // // This member is required. FontStack *string - // A Unicode range of characters to download glyphs for. Each response will contain - // 256 characters. For example, 0–255 includes all characters from range U+0000 to - // 00FF. Must be aligned to multiples of 256. + // A Unicode range of characters to download glyphs for. Each response will + // contain 256 characters. For example, 0–255 includes all characters from range + // U+0000 to 00FF . Must be aligned to multiples of 256. // // This member is required. FontUnicodeRange *string @@ -98,8 +76,7 @@ type GetMapGlyphsInput struct { // This member is required. MapName *string - // The optional API key - // (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) + // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) // to authorize the request. Key *string @@ -114,7 +91,7 @@ type GetMapGlyphsOutput struct { // The HTTP Cache-Control directive for the value. CacheControl *string - // The map glyph content type. For example, application/octet-stream. + // The map glyph content type. For example, application/octet-stream . ContentType *string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_GetMapSprites.go b/service/location/api_op_GetMapSprites.go index bd07a503047..b868051b431 100644 --- a/service/location/api_op_GetMapSprites.go +++ b/service/location/api_op_GetMapSprites.go @@ -32,19 +32,11 @@ func (c *Client) GetMapSprites(ctx context.Context, params *GetMapSpritesInput, type GetMapSpritesInput struct { // The name of the sprite file. Use the following file names for the sprite sheet: - // - // * - // sprites.png - // - // * sprites@2x.png for high pixel density displays - // - // For the JSON - // document containing image offsets. Use the following file names: - // - // * - // sprites.json - // - // * sprites@2x.json for high pixel density displays + // - sprites.png + // - sprites@2x.png for high pixel density displays + // For the JSON document containing image offsets. Use the following file names: + // - sprites.json + // - sprites@2x.json for high pixel density displays // // This member is required. FileName *string @@ -54,8 +46,7 @@ type GetMapSpritesInput struct { // This member is required. MapName *string - // The optional API key - // (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) + // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) // to authorize the request. Key *string @@ -71,8 +62,8 @@ type GetMapSpritesOutput struct { CacheControl *string // The content type of the sprite sheet and offsets. For example, the sprite sheet - // content type is image/png, and the sprite offset JSON document is - // application/json. + // content type is image/png , and the sprite offset JSON document is + // application/json . ContentType *string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_GetMapStyleDescriptor.go b/service/location/api_op_GetMapStyleDescriptor.go index 80a420d5877..e15dd59d2ca 100644 --- a/service/location/api_op_GetMapStyleDescriptor.go +++ b/service/location/api_op_GetMapStyleDescriptor.go @@ -37,8 +37,7 @@ type GetMapStyleDescriptorInput struct { // This member is required. MapName *string - // The optional API key - // (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) + // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) // to authorize the request. Key *string @@ -53,7 +52,7 @@ type GetMapStyleDescriptorOutput struct { // The HTTP Cache-Control directive for the value. CacheControl *string - // The style descriptor's content type. For example, application/json. + // The style descriptor's content type. For example, application/json . ContentType *string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_GetMapTile.go b/service/location/api_op_GetMapTile.go index ee0d06441b8..60e7b918b2a 100644 --- a/service/location/api_op_GetMapTile.go +++ b/service/location/api_op_GetMapTile.go @@ -54,8 +54,7 @@ type GetMapTileInput struct { // This member is required. Z *string - // The optional API key - // (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) + // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) // to authorize the request. Key *string @@ -70,7 +69,7 @@ type GetMapTileOutput struct { // The HTTP Cache-Control directive for the value. CacheControl *string - // The map tile's content type. For example, application/vnd.mapbox-vector-tile. + // The map tile's content type. For example, application/vnd.mapbox-vector-tile . ContentType *string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_GetPlace.go b/service/location/api_op_GetPlace.go index 6b02cd17f2d..175c3446e07 100644 --- a/service/location/api_op_GetPlace.go +++ b/service/location/api_op_GetPlace.go @@ -14,15 +14,10 @@ import ( // Finds a place by its unique ID. A PlaceId is returned by other search // operations. A PlaceId is valid only if all of the following are the same in the -// original search request and the call to GetPlace. -// -// * Customer Amazon Web -// Services account -// -// * Amazon Web Services Region -// -// * Data provider specified in the -// place index resource +// original search request and the call to GetPlace . +// - Customer Amazon Web Services account +// - Amazon Web Services Region +// - Data provider specified in the place index resource func (c *Client) GetPlace(ctx context.Context, params *GetPlaceInput, optFns ...func(*Options)) (*GetPlaceOutput, error) { if params == nil { params = &GetPlaceInput{} @@ -50,17 +45,17 @@ type GetPlaceInput struct { // This member is required. PlaceId *string - // The preferred language used to return results. The value must be a valid BCP 47 - // (https://tools.ietf.org/search/bcp47) language tag, for example, en for English. - // This setting affects the languages used in the results, but not the results - // themselves. If no language is specified, or not supported for a particular - // result, the partner automatically chooses a language for the result. For an - // example, we'll use the Greek language. You search for a location around Athens, - // Greece, with the language parameter set to en. The city in the results will most - // likely be returned as Athens. If you set the language parameter to el, for - // Greek, then the city in the results will more likely be returned as Αθήνα. If - // the data provider does not have a value for Greek, the result will be in a - // language that the provider does support. + // The preferred language used to return results. The value must be a valid BCP 47 (https://tools.ietf.org/search/bcp47) + // language tag, for example, en for English. This setting affects the languages + // used in the results, but not the results themselves. If no language is + // specified, or not supported for a particular result, the partner automatically + // chooses a language for the result. For an example, we'll use the Greek language. + // You search for a location around Athens, Greece, with the language parameter + // set to en . The city in the results will most likely be returned as Athens . If + // you set the language parameter to el , for Greek, then the city in the results + // will more likely be returned as Αθήνα . If the data provider does not have a + // value for Greek, the result will be in a language that the provider does + // support. Language *string noSmithyDocumentSerde diff --git a/service/location/api_op_ListDevicePositions.go b/service/location/api_op_ListDevicePositions.go index 32fd3ff2871..2fb2506fa46 100644 --- a/service/location/api_op_ListDevicePositions.go +++ b/service/location/api_op_ListDevicePositions.go @@ -39,8 +39,9 @@ type ListDevicePositionsInput struct { // value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -48,9 +49,9 @@ type ListDevicePositionsInput struct { type ListDevicePositionsOutput struct { - // Contains details about each device's last known position. These details includes - // the device ID, the time when the position was sampled on the device, the time - // that the service received the update, and the most recent coordinates. + // Contains details about each device's last known position. These details + // includes the device ID, the time when the position was sampled on the device, + // the time that the service received the update, and the most recent coordinates. // // This member is required. Entries []types.ListDevicePositionsResponseEntry @@ -158,8 +159,8 @@ func addEndpointPrefix_opListDevicePositionsMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opListDevicePositionsMiddleware{}, `OperationSerializer`, middleware.After) } -// ListDevicePositionsAPIClient is a client that implements the ListDevicePositions -// operation. +// ListDevicePositionsAPIClient is a client that implements the +// ListDevicePositions operation. type ListDevicePositionsAPIClient interface { ListDevicePositions(context.Context, *ListDevicePositionsInput, ...func(*Options)) (*ListDevicePositionsOutput, error) } diff --git a/service/location/api_op_ListGeofenceCollections.go b/service/location/api_op_ListGeofenceCollections.go index dbd4e1d0126..93abc8f8833 100644 --- a/service/location/api_op_ListGeofenceCollections.go +++ b/service/location/api_op_ListGeofenceCollections.go @@ -30,12 +30,13 @@ func (c *Client) ListGeofenceCollections(ctx context.Context, params *ListGeofen type ListGeofenceCollectionsInput struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -159,8 +160,8 @@ var _ ListGeofenceCollectionsAPIClient = (*Client)(nil) // ListGeofenceCollectionsPaginatorOptions is the paginator options for // ListGeofenceCollections type ListGeofenceCollectionsPaginatorOptions struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_ListGeofences.go b/service/location/api_op_ListGeofences.go index b979927e449..f065c0a67e8 100644 --- a/service/location/api_op_ListGeofences.go +++ b/service/location/api_op_ListGeofences.go @@ -35,12 +35,13 @@ type ListGeofencesInput struct { // This member is required. CollectionName *string - // An optional limit for the number of geofences returned in a single call. Default - // value: 100 + // An optional limit for the number of geofences returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -165,8 +166,8 @@ var _ ListGeofencesAPIClient = (*Client)(nil) // ListGeofencesPaginatorOptions is the paginator options for ListGeofences type ListGeofencesPaginatorOptions struct { - // An optional limit for the number of geofences returned in a single call. Default - // value: 100 + // An optional limit for the number of geofences returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_ListKeys.go b/service/location/api_op_ListKeys.go index b851e0eef8c..75f2d1ba169 100644 --- a/service/location/api_op_ListKeys.go +++ b/service/location/api_op_ListKeys.go @@ -14,8 +14,8 @@ import ( // Lists API key resources in your Amazon Web Services account. The API keys // feature is in preview. We may add, change, or remove features before announcing -// general availability. For more information, see Using API keys -// (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html). +// general availability. For more information, see Using API keys (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) +// . func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ...func(*Options)) (*ListKeysOutput, error) { if params == nil { params = &ListKeysInput{} @@ -36,12 +36,13 @@ type ListKeysInput struct { // Optionally filter the list to only Active or Expired API keys. Filter *types.ApiKeyFilter - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -164,8 +165,8 @@ var _ ListKeysAPIClient = (*Client)(nil) // ListKeysPaginatorOptions is the paginator options for ListKeys type ListKeysPaginatorOptions struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_ListMaps.go b/service/location/api_op_ListMaps.go index 7cb37524982..84a6ab302f9 100644 --- a/service/location/api_op_ListMaps.go +++ b/service/location/api_op_ListMaps.go @@ -30,12 +30,13 @@ func (c *Client) ListMaps(ctx context.Context, params *ListMapsInput, optFns ... type ListMapsInput struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -157,8 +158,8 @@ var _ ListMapsAPIClient = (*Client)(nil) // ListMapsPaginatorOptions is the paginator options for ListMaps type ListMapsPaginatorOptions struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_ListPlaceIndexes.go b/service/location/api_op_ListPlaceIndexes.go index 0b78c98f431..19a90afcd0e 100644 --- a/service/location/api_op_ListPlaceIndexes.go +++ b/service/location/api_op_ListPlaceIndexes.go @@ -34,8 +34,9 @@ type ListPlaceIndexesInput struct { // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -48,8 +49,8 @@ type ListPlaceIndexesOutput struct { // This member is required. Entries []types.ListPlaceIndexesResponseEntry - // A pagination token indicating that there are additional pages available. You can - // use the token in a new request to fetch the next page of results. + // A pagination token indicating that there are additional pages available. You + // can use the token in a new request to fetch the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_ListRouteCalculators.go b/service/location/api_op_ListRouteCalculators.go index 688c15b1f2a..9a4a8d6c035 100644 --- a/service/location/api_op_ListRouteCalculators.go +++ b/service/location/api_op_ListRouteCalculators.go @@ -34,8 +34,9 @@ type ListRouteCalculatorsInput struct { // 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default Value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // Value: null NextToken *string noSmithyDocumentSerde diff --git a/service/location/api_op_ListTagsForResource.go b/service/location/api_op_ListTagsForResource.go index d820fc73c07..e9aed22c86c 100644 --- a/service/location/api_op_ListTagsForResource.go +++ b/service/location/api_op_ListTagsForResource.go @@ -30,11 +30,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource whose tags you want to - // retrieve. - // - // * Format example: - // arn:aws:geo:region:account-id:resourcetype/ExampleResource + // The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. + // - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource // // This member is required. ResourceArn *string @@ -45,10 +42,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // Tags that have been applied to the specified resource. Tags are mapped from the - // tag key to the tag value: "TagKey" : "TagValue". - // - // * Format example: {"tag1" : - // "value1", "tag2" : "value2"} + // tag key to the tag value: "TagKey" : "TagValue" . + // - Format example: {"tag1" : "value1", "tag2" : "value2"} Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/location/api_op_ListTrackerConsumers.go b/service/location/api_op_ListTrackerConsumers.go index e78e5c9ea93..d066e91e897 100644 --- a/service/location/api_op_ListTrackerConsumers.go +++ b/service/location/api_op_ListTrackerConsumers.go @@ -34,12 +34,13 @@ type ListTrackerConsumersInput struct { // This member is required. TrackerName *string - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -167,8 +168,8 @@ var _ ListTrackerConsumersAPIClient = (*Client)(nil) // ListTrackerConsumersPaginatorOptions is the paginator options for // ListTrackerConsumers type ListTrackerConsumersPaginatorOptions struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_ListTrackers.go b/service/location/api_op_ListTrackers.go index d6ff9181cd7..e56bed7818a 100644 --- a/service/location/api_op_ListTrackers.go +++ b/service/location/api_op_ListTrackers.go @@ -30,12 +30,13 @@ func (c *Client) ListTrackers(ctx context.Context, params *ListTrackersInput, op type ListTrackersInput struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 MaxResults *int32 - // The pagination token specifying which page of results to return in the response. - // If no token is provided, the default page is the first page. Default value: null + // The pagination token specifying which page of results to return in the + // response. If no token is provided, the default page is the first page. Default + // value: null NextToken *string noSmithyDocumentSerde @@ -159,8 +160,8 @@ var _ ListTrackersAPIClient = (*Client)(nil) // ListTrackersPaginatorOptions is the paginator options for ListTrackers type ListTrackersPaginatorOptions struct { - // An optional limit for the number of resources returned in a single call. Default - // value: 100 + // An optional limit for the number of resources returned in a single call. + // Default value: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/location/api_op_PutGeofence.go b/service/location/api_op_PutGeofence.go index fdcfb9e90f4..efb33b6b25c 100644 --- a/service/location/api_op_PutGeofence.go +++ b/service/location/api_op_PutGeofence.go @@ -37,15 +37,14 @@ type PutGeofenceInput struct { // This member is required. CollectionName *string - // An identifier for the geofence. For example, ExampleGeofence-1. + // An identifier for the geofence. For example, ExampleGeofence-1 . // // This member is required. GeofenceId *string // Contains the details to specify the position of the geofence. Can be either a // polygon or a circle. Including both will return a validation error. Each - // geofence polygon - // (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // geofence polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) // can have a maximum of 1,000 vertices. // // This member is required. @@ -56,9 +55,8 @@ type PutGeofenceInput struct { type PutGeofenceOutput struct { - // The timestamp for when the geofence was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. CreateTime *time.Time @@ -68,9 +66,8 @@ type PutGeofenceOutput struct { // This member is required. GeofenceId *string - // The timestamp for when the geofence was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_SearchPlaceIndexForPosition.go b/service/location/api_op_SearchPlaceIndexForPosition.go index 209b480110a..7dc9d8302fd 100644 --- a/service/location/api_op_SearchPlaceIndexForPosition.go +++ b/service/location/api_op_SearchPlaceIndexForPosition.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reverse geocodes a given coordinate and returns a legible address. Allows you to -// search for Places or points of interest near a given position. +// Reverse geocodes a given coordinate and returns a legible address. Allows you +// to search for Places or points of interest near a given position. func (c *Client) SearchPlaceIndexForPosition(ctx context.Context, params *SearchPlaceIndexForPositionInput, optFns ...func(*Options)) (*SearchPlaceIndexForPositionOutput, error) { if params == nil { params = &SearchPlaceIndexForPositionInput{} @@ -39,23 +39,23 @@ type SearchPlaceIndexForPositionInput struct { // Specifies the longitude and latitude of the position to query. This parameter // must contain a pair of numbers. The first number represents the X coordinate, or // longitude; the second number represents the Y coordinate, or latitude. For - // example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and - // latitude 49.2847. + // example, [-123.1174, 49.2847] represents a position with longitude -123.1174 + // and latitude 49.2847 . // // This member is required. Position []float64 - // The preferred language used to return results. The value must be a valid BCP 47 - // (https://tools.ietf.org/search/bcp47) language tag, for example, en for English. - // This setting affects the languages used in the results, but not the results - // themselves. If no language is specified, or not supported for a particular - // result, the partner automatically chooses a language for the result. For an - // example, we'll use the Greek language. You search for a location around Athens, - // Greece, with the language parameter set to en. The city in the results will most - // likely be returned as Athens. If you set the language parameter to el, for - // Greek, then the city in the results will more likely be returned as Αθήνα. If - // the data provider does not have a value for Greek, the result will be in a - // language that the provider does support. + // The preferred language used to return results. The value must be a valid BCP 47 (https://tools.ietf.org/search/bcp47) + // language tag, for example, en for English. This setting affects the languages + // used in the results, but not the results themselves. If no language is + // specified, or not supported for a particular result, the partner automatically + // chooses a language for the result. For an example, we'll use the Greek language. + // You search for a location around Athens, Greece, with the language parameter + // set to en . The city in the results will most likely be returned as Athens . If + // you set the language parameter to el , for Greek, then the city in the results + // will more likely be returned as Αθήνα . If the data provider does not have a + // value for Greek, the result will be in a language that the provider does + // support. Language *string // An optional parameter. The maximum number of results returned per request. @@ -67,14 +67,14 @@ type SearchPlaceIndexForPositionInput struct { type SearchPlaceIndexForPositionOutput struct { - // Returns a list of Places closest to the specified position. Each result contains - // additional information about the Places returned. + // Returns a list of Places closest to the specified position. Each result + // contains additional information about the Places returned. // // This member is required. Results []types.SearchForPositionResult - // Contains a summary of the request. Echoes the input values for Position, - // Language, MaxResults, and the DataSource of the place index. + // Contains a summary of the request. Echoes the input values for Position , + // Language , MaxResults , and the DataSource of the place index. // // This member is required. Summary *types.SearchPlaceIndexForPositionSummary diff --git a/service/location/api_op_SearchPlaceIndexForSuggestions.go b/service/location/api_op_SearchPlaceIndexForSuggestions.go index 536365978b2..495c71dace3 100644 --- a/service/location/api_op_SearchPlaceIndexForSuggestions.go +++ b/service/location/api_op_SearchPlaceIndexForSuggestions.go @@ -17,9 +17,9 @@ import ( // autosuggest, or fuzzy matching. Optional parameters let you narrow your search // results by bounding box or country, or bias your search toward a specific // position on the globe. You can search for suggested place names near a specified -// position by using BiasPosition, or filter results within a bounding box by using -// FilterBBox. These parameters are mutually exclusive; using both BiasPosition and -// FilterBBox in the same command returns an error. +// position by using BiasPosition , or filter results within a bounding box by +// using FilterBBox . These parameters are mutually exclusive; using both +// BiasPosition and FilterBBox in the same command returns an error. func (c *Client) SearchPlaceIndexForSuggestions(ctx context.Context, params *SearchPlaceIndexForSuggestionsInput, optFns ...func(*Options)) (*SearchPlaceIndexForSuggestionsOutput, error) { if params == nil { params = &SearchPlaceIndexForSuggestionsInput{} @@ -43,18 +43,18 @@ type SearchPlaceIndexForSuggestionsInput struct { IndexName *string // The free-form partial text to use to generate place suggestions. For example, - // eiffel tow. + // eiffel tow . // // This member is required. Text *string - // An optional parameter that indicates a preference for place suggestions that are - // closer to a specified position. If provided, this parameter must contain a pair - // of numbers. The first number represents the X coordinate, or longitude; the - // second number represents the Y coordinate, or latitude. For example, [-123.1174, - // 49.2847] represents the position with longitude -123.1174 and latitude 49.2847. - // BiasPosition and FilterBBox are mutually exclusive. Specifying both options - // results in an error. + // An optional parameter that indicates a preference for place suggestions that + // are closer to a specified position. If provided, this parameter must contain a + // pair of numbers. The first number represents the X coordinate, or longitude; the + // second number represents the Y coordinate, or latitude. For example, + // [-123.1174, 49.2847] represents the position with longitude -123.1174 and + // latitude 49.2847 . BiasPosition and FilterBBox are mutually exclusive. + // Specifying both options results in an error. BiasPosition []float64 // An optional parameter that limits the search results by returning only @@ -65,29 +65,27 @@ type SearchPlaceIndexForSuggestionsInput struct { // numbers represents the X and Y coordinates (longitude and latitude, // respectively) of the northeast corner of the bounding box. For example, // [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the - // southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast - // corner has longitude -12.0684 and latitude -36.9542. FilterBBox and BiasPosition - // are mutually exclusive. Specifying both options results in an error. + // southwest corner has longitude -12.7935 and latitude -37.4835 , and the + // northeast corner has longitude -12.0684 and latitude -36.9542 . FilterBBox and + // BiasPosition are mutually exclusive. Specifying both options results in an error. FilterBBox []float64 // An optional parameter that limits the search results by returning only // suggestions within the provided list of countries. - // - // * Use the ISO 3166 - // (https://www.iso.org/iso-3166-country-codes.html) 3-digit country code. For - // example, Australia uses three upper-case characters: AUS. + // - Use the ISO 3166 (https://www.iso.org/iso-3166-country-codes.html) 3-digit + // country code. For example, Australia uses three upper-case characters: AUS . FilterCountries []string - // The preferred language used to return results. The value must be a valid BCP 47 - // (https://tools.ietf.org/search/bcp47) language tag, for example, en for English. - // This setting affects the languages used in the results. If no language is - // specified, or not supported for a particular result, the partner automatically - // chooses a language for the result. For an example, we'll use the Greek language. - // You search for Athens, Gr to get suggestions with the language parameter set to - // en. The results found will most likely be returned as Athens, Greece. If you set - // the language parameter to el, for Greek, then the result found will more likely - // be returned as Αθήνα, Ελλάδα. If the data provider does not have a value for - // Greek, the result will be in a language that the provider does support. + // The preferred language used to return results. The value must be a valid BCP 47 (https://tools.ietf.org/search/bcp47) + // language tag, for example, en for English. This setting affects the languages + // used in the results. If no language is specified, or not supported for a + // particular result, the partner automatically chooses a language for the result. + // For an example, we'll use the Greek language. You search for Athens, Gr to get + // suggestions with the language parameter set to en . The results found will most + // likely be returned as Athens, Greece . If you set the language parameter to el , + // for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα . + // If the data provider does not have a value for Greek, the result will be in a + // language that the provider does support. Language *string // An optional parameter. The maximum number of results returned per request. The @@ -104,9 +102,9 @@ type SearchPlaceIndexForSuggestionsOutput struct { // This member is required. Results []types.SearchForSuggestionsResult - // Contains a summary of the request. Echoes the input values for BiasPosition, - // FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the - // DataSource of the place index. + // Contains a summary of the request. Echoes the input values for BiasPosition , + // FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes + // the DataSource of the place index. // // This member is required. Summary *types.SearchPlaceIndexForSuggestionsSummary diff --git a/service/location/api_op_SearchPlaceIndexForText.go b/service/location/api_op_SearchPlaceIndexForText.go index 4ffaffc935b..ea847ea2949 100644 --- a/service/location/api_op_SearchPlaceIndexForText.go +++ b/service/location/api_op_SearchPlaceIndexForText.go @@ -16,7 +16,7 @@ import ( // to search for Places or points of interest. Optional parameters let you narrow // your search results by bounding box or country, or bias your search toward a // specific position on the globe. You can search for places near a given position -// using BiasPosition, or filter results within a bounding box using FilterBBox. +// using BiasPosition , or filter results within a bounding box using FilterBBox . // Providing both parameters simultaneously returns an error. Search results are // returned in order of highest to lowest relevance. func (c *Client) SearchPlaceIndexForText(ctx context.Context, params *SearchPlaceIndexForTextInput, optFns ...func(*Options)) (*SearchPlaceIndexForTextOutput, error) { @@ -42,7 +42,7 @@ type SearchPlaceIndexForTextInput struct { IndexName *string // The address, name, city, or region to be used in the search in free-form text - // format. For example, 123 Any Street. + // format. For example, 123 Any Street . // // This member is required. Text *string @@ -51,7 +51,7 @@ type SearchPlaceIndexForTextInput struct { // a specified position. If provided, this parameter must contain a pair of // numbers. The first number represents the X coordinate, or longitude; the second // number represents the Y coordinate, or latitude. For example, [-123.1174, - // 49.2847] represents the position with longitude -123.1174 and latitude 49.2847. + // 49.2847] represents the position with longitude -123.1174 and latitude 49.2847 . // BiasPosition and FilterBBox are mutually exclusive. Specifying both options // results in an error. BiasPosition []float64 @@ -64,30 +64,28 @@ type SearchPlaceIndexForTextInput struct { // numbers represents the X and Y coordinates (longitude and latitude, // respectively) of the northeast corner of the bounding box. For example, // [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the - // southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast - // corner has longitude -12.0684 and latitude -36.9542. FilterBBox and BiasPosition - // are mutually exclusive. Specifying both options results in an error. + // southwest corner has longitude -12.7935 and latitude -37.4835 , and the + // northeast corner has longitude -12.0684 and latitude -36.9542 . FilterBBox and + // BiasPosition are mutually exclusive. Specifying both options results in an error. FilterBBox []float64 // An optional parameter that limits the search results by returning only places // that are in a specified list of countries. - // - // * Valid values include ISO 3166 - // (https://www.iso.org/iso-3166-country-codes.html) 3-digit country codes. For - // example, Australia uses three upper-case characters: AUS. + // - Valid values include ISO 3166 (https://www.iso.org/iso-3166-country-codes.html) + // 3-digit country codes. For example, Australia uses three upper-case characters: + // AUS . FilterCountries []string - // The preferred language used to return results. The value must be a valid BCP 47 - // (https://tools.ietf.org/search/bcp47) language tag, for example, en for English. - // This setting affects the languages used in the results, but not the results - // themselves. If no language is specified, or not supported for a particular - // result, the partner automatically chooses a language for the result. For an - // example, we'll use the Greek language. You search for Athens, Greece, with the - // language parameter set to en. The result found will most likely be returned as - // Athens. If you set the language parameter to el, for Greek, then the result - // found will more likely be returned as Αθήνα. If the data provider does not have - // a value for Greek, the result will be in a language that the provider does - // support. + // The preferred language used to return results. The value must be a valid BCP 47 (https://tools.ietf.org/search/bcp47) + // language tag, for example, en for English. This setting affects the languages + // used in the results, but not the results themselves. If no language is + // specified, or not supported for a particular result, the partner automatically + // chooses a language for the result. For an example, we'll use the Greek language. + // You search for Athens, Greece , with the language parameter set to en . The + // result found will most likely be returned as Athens . If you set the language + // parameter to el , for Greek, then the result found will more likely be returned + // as Αθήνα . If the data provider does not have a value for Greek, the result will + // be in a language that the provider does support. Language *string // An optional parameter. The maximum number of results returned per request. The @@ -107,10 +105,10 @@ type SearchPlaceIndexForTextOutput struct { // This member is required. Results []types.SearchForTextResult - // Contains a summary of the request. Echoes the input values for BiasPosition, - // FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the - // DataSource of the place index and the bounding box, ResultBBox, which surrounds - // the search results. + // Contains a summary of the request. Echoes the input values for BiasPosition , + // FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes + // the DataSource of the place index and the bounding box, ResultBBox , which + // surrounds the search results. // // This member is required. Summary *types.SearchPlaceIndexForTextSummary diff --git a/service/location/api_op_TagResource.go b/service/location/api_op_TagResource.go index 63daf697563..84d08eca300 100644 --- a/service/location/api_op_TagResource.go +++ b/service/location/api_op_TagResource.go @@ -39,9 +39,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource whose tags you want to update. - // - // * - // Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource + // - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource // // This member is required. ResourceArn *string @@ -49,22 +47,13 @@ type TagResourceInput struct { // Applies one or more tags to specific resource. A tag is a key-value pair that // helps you manage, identify, search, and filter your resources. Format: "key" : // "value" Restrictions: - // - // * Maximum 50 tags per resource. - // - // * Each tag key must be - // unique and must have exactly one associated value. - // - // * Maximum key length: 128 - // Unicode characters in UTF-8. - // - // * Maximum value length: 256 Unicode characters in - // UTF-8. - // - // * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following - // characters: + - = . _ : / @ - // - // * Cannot use "aws:" as a prefix for a key. + // - Maximum 50 tags per resource. + // - Each tag key must be unique and must have exactly one associated value. + // - Maximum key length: 128 Unicode characters in UTF-8. + // - Maximum value length: 256 Unicode characters in UTF-8. + // - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following + // characters: + - = . _ : / @ + // - Cannot use "aws:" as a prefix for a key. // // This member is required. Tags map[string]string diff --git a/service/location/api_op_UntagResource.go b/service/location/api_op_UntagResource.go index 3ac6b4f62b0..86fe55602e8 100644 --- a/service/location/api_op_UntagResource.go +++ b/service/location/api_op_UntagResource.go @@ -31,9 +31,7 @@ type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource from which you want to remove // tags. - // - // * Format example: - // arn:aws:geo:region:account-id:resourcetype/ExampleResource + // - Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource // // This member is required. ResourceArn *string diff --git a/service/location/api_op_UpdateGeofenceCollection.go b/service/location/api_op_UpdateGeofenceCollection.go index 384d1772c89..858940b54f4 100644 --- a/service/location/api_op_UpdateGeofenceCollection.go +++ b/service/location/api_op_UpdateGeofenceCollection.go @@ -39,7 +39,7 @@ type UpdateGeofenceCollectionInput struct { // Updates the description for the geofence collection. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -57,9 +57,8 @@ type UpdateGeofenceCollectionOutput struct { // The Amazon Resource Name (ARN) of the updated geofence collection. Used to // specify a resource across Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection + // - Format example: + // arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection // // This member is required. CollectionArn *string @@ -69,9 +68,8 @@ type UpdateGeofenceCollectionOutput struct { // This member is required. CollectionName *string - // The time when the geofence collection was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The time when the geofence collection was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateKey.go b/service/location/api_op_UpdateKey.go index 87738bb4cf4..50642b3aa24 100644 --- a/service/location/api_op_UpdateKey.go +++ b/service/location/api_op_UpdateKey.go @@ -15,8 +15,8 @@ import ( // Updates the specified properties of a given API key resource. The API keys // feature is in preview. We may add, change, or remove features before announcing -// general availability. For more information, see Using API keys -// (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html). +// general availability. For more information, see Using API keys (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) +// . func (c *Client) UpdateKey(ctx context.Context, params *UpdateKeyInput, optFns ...func(*Options)) (*UpdateKeyOutput, error) { if params == nil { params = &UpdateKeyInput{} @@ -42,14 +42,13 @@ type UpdateKeyInput struct { // Updates the description for the API key resource. Description *string - // Updates the timestamp for when the API key resource will expire in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // Updates the timestamp for when the API key resource will expire in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . ExpireTime *time.Time - // The boolean flag to be included for updating ExpireTime or Restrictions details. - // Must be set to true to update an API key resource that has been used in the past - // 7 days. False if force update is not preferred Default value: False + // The boolean flag to be included for updating ExpireTime or Restrictions + // details. Must be set to true to update an API key resource that has been used + // in the past 7 days. False if force update is not preferred Default value: False ForceUpdate *bool // Whether the API key should expire. Set to true to set the API key to have no @@ -66,9 +65,7 @@ type UpdateKeyOutput struct { // The Amazon Resource Name (ARN) for the API key resource. Used when you need to // specify a resource across all Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:key/ExampleKey + // - Format example: arn:aws:geo:region:account-id:key/ExampleKey // // This member is required. KeyArn *string @@ -78,9 +75,8 @@ type UpdateKeyOutput struct { // This member is required. KeyName *string - // The timestamp for when the API key resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateMap.go b/service/location/api_op_UpdateMap.go index 4e898cb44e4..93fb830e188 100644 --- a/service/location/api_op_UpdateMap.go +++ b/service/location/api_op_UpdateMap.go @@ -39,7 +39,7 @@ type UpdateMapInput struct { // Updates the description for the map resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -52,9 +52,7 @@ type UpdateMapOutput struct { // The Amazon Resource Name (ARN) of the updated map resource. Used to specify a // resource across AWS. - // - // * Format example: - // arn:aws:geo:region:account-id:map/ExampleMap + // - Format example: arn:aws:geo:region:account-id:map/ExampleMap // // This member is required. MapArn *string @@ -64,9 +62,8 @@ type UpdateMapOutput struct { // This member is required. MapName *string - // The timestamp for when the map resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdatePlaceIndex.go b/service/location/api_op_UpdatePlaceIndex.go index f5ba19add1d..97eb2ee8342 100644 --- a/service/location/api_op_UpdatePlaceIndex.go +++ b/service/location/api_op_UpdatePlaceIndex.go @@ -42,7 +42,7 @@ type UpdatePlaceIndexInput struct { // Updates the description for the place index resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -55,9 +55,7 @@ type UpdatePlaceIndexOutput struct { // The Amazon Resource Name (ARN) of the upated place index resource. Used to // specify a resource across Amazon Web Services. - // - // * Format example: - // arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex + // - Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex // // This member is required. IndexArn *string @@ -67,9 +65,8 @@ type UpdatePlaceIndexOutput struct { // This member is required. IndexName *string - // The timestamp for when the place index resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateRouteCalculator.go b/service/location/api_op_UpdateRouteCalculator.go index 6cbd9a62e53..1d2ea899dd0 100644 --- a/service/location/api_op_UpdateRouteCalculator.go +++ b/service/location/api_op_UpdateRouteCalculator.go @@ -39,7 +39,7 @@ type UpdateRouteCalculatorInput struct { // Updates the description for the route calculator resource. Description *string - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -50,11 +50,10 @@ type UpdateRouteCalculatorInput struct { type UpdateRouteCalculatorOutput struct { - // The Amazon Resource Name (ARN) of the updated route calculator resource. Used to - // specify a resource across AWS. - // - // * Format example: - // arn:aws:geo:region:account-id:route- calculator/ExampleCalculator + // The Amazon Resource Name (ARN) of the updated route calculator resource. Used + // to specify a resource across AWS. + // - Format example: arn:aws:geo:region:account-id:route- + // calculator/ExampleCalculator // // This member is required. CalculatorArn *string @@ -64,9 +63,8 @@ type UpdateRouteCalculatorOutput struct { // This member is required. CalculatorName *string - // The timestamp for when the route calculator was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the route calculator was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateTracker.go b/service/location/api_op_UpdateTracker.go index dcbcd308b56..a1329d858e5 100644 --- a/service/location/api_op_UpdateTracker.go +++ b/service/location/api_op_UpdateTracker.go @@ -40,31 +40,26 @@ type UpdateTrackerInput struct { Description *string // Updates the position filtering for the tracker resource. Valid values: - // - // * - // TimeBased - Location updates are evaluated against linked geofence collections, - // but not every location update is stored. If your update frequency is more often - // than 30 seconds, only one update per 30 seconds is stored for each unique device - // ID. - // - // * DistanceBased - If the device has moved less than 30 m (98.4 ft), - // location updates are ignored. Location updates within this distance are neither - // evaluated against linked geofence collections, nor stored. This helps control - // costs by reducing the number of geofence evaluations and historical device - // positions to paginate through. Distance-based filtering can also reduce the - // effects of GPS noise when displaying device trajectories on a map. - // - // * - // AccuracyBased - If the device has moved less than the measured accuracy, - // location updates are ignored. For example, if two consecutive updates from a - // device have a horizontal accuracy of 5 m and 10 m, the second update is ignored - // if the device has moved less than 15 m. Ignored location updates are neither - // evaluated against linked geofence collections, nor stored. This helps educe the - // effects of GPS noise when displaying device trajectories on a map, and can help - // control costs by reducing the number of geofence evaluations. + // - TimeBased - Location updates are evaluated against linked geofence + // collections, but not every location update is stored. If your update frequency + // is more often than 30 seconds, only one update per 30 seconds is stored for each + // unique device ID. + // - DistanceBased - If the device has moved less than 30 m (98.4 ft), location + // updates are ignored. Location updates within this distance are neither evaluated + // against linked geofence collections, nor stored. This helps control costs by + // reducing the number of geofence evaluations and historical device positions to + // paginate through. Distance-based filtering can also reduce the effects of GPS + // noise when displaying device trajectories on a map. + // - AccuracyBased - If the device has moved less than the measured accuracy, + // location updates are ignored. For example, if two consecutive updates from a + // device have a horizontal accuracy of 5 m and 10 m, the second update is ignored + // if the device has moved less than 15 m. Ignored location updates are neither + // evaluated against linked geofence collections, nor stored. This helps educe the + // effects of GPS noise when displaying device trajectories on a map, and can help + // control costs by reducing the number of geofence evaluations. PositionFiltering types.PositionFiltering - // No longer used. If included, the only allowed value is RequestBasedUsage. + // No longer used. If included, the only allowed value is RequestBasedUsage . // // Deprecated: Deprecated. If included, the only allowed value is // RequestBasedUsage. @@ -82,9 +77,7 @@ type UpdateTrackerOutput struct { // The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify // a resource across AWS. - // - // * Format example: - // arn:aws:geo:region:account-id:tracker/ExampleTracker + // - Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker // // This member is required. TrackerArn *string @@ -94,9 +87,8 @@ type UpdateTrackerOutput struct { // This member is required. TrackerName *string - // The timestamp for when the tracker resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time diff --git a/service/location/types/enums.go b/service/location/types/enums.go index db20b0c7586..e7f94237fda 100644 --- a/service/location/types/enums.go +++ b/service/location/types/enums.go @@ -32,9 +32,9 @@ func (DimensionUnit) Values() []DimensionUnit { type DistanceUnit string -// Values returns all known values for DistanceUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DistanceUnit. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DistanceUnit) Values() []DistanceUnit { return []DistanceUnit{ "Kilometers", diff --git a/service/location/types/errors.go b/service/location/types/errors.go index c4a35c0844b..cfcbe84270d 100644 --- a/service/location/types/errors.go +++ b/service/location/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// The request was denied because of insufficient access or permissions. Check with -// an administrator to verify your permissions. +// The request was denied because of insufficient access or permissions. Check +// with an administrator to verify your permissions. type AccessDeniedException struct { Message *string @@ -60,8 +60,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request has failed to process because of an unknown server error, exception, -// or failure. +// The request has failed to process because of an unknown server error, +// exception, or failure. type InternalServerException struct { Message *string @@ -113,8 +113,7 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation was denied because the request would exceed the maximum quota -// (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) +// The operation was denied because the request would exceed the maximum quota (https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html) // set for Amazon Location Service. type ServiceQuotaExceededException struct { Message *string diff --git a/service/location/types/types.go b/service/location/types/types.go index 183cb392171..2681617b9f8 100644 --- a/service/location/types/types.go +++ b/service/location/types/types.go @@ -20,39 +20,30 @@ type ApiKeyFilter struct { // resource. type ApiKeyRestrictions struct { - // A list of allowed actions that an API key resource grants permissions to perform - // Currently, the only valid action is geo:GetMap* as an input to the list. For - // example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. + // A list of allowed actions that an API key resource grants permissions to + // perform Currently, the only valid action is geo:GetMap* as an input to the + // list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. // // This member is required. AllowActions []string - // A list of allowed resource ARNs that a API key bearer can perform actions on For - // more information about ARN format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). In - // this preview, you can allow only map resources. Requirements: - // - // * Must be - // prefixed with arn. - // - // * partition and service must not be empty and should begin - // with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric - // numbers, hyphens (-) and periods (.). - // - // * region and account-id can be empty or - // should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only - // alphanumeric numbers, hyphens (-) and periods (.). - // - // * resource-id can begin with - // any character except for forward slash (/) and contain any characters after, - // including forward slashes to form a path. resource-id can also include wildcard - // characters, denoted by an asterisk (*). - // - // * arn, partition, service, region, - // account-id and resource-id must be delimited by a colon (:). - // - // * No spaces - // allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap*. + // A list of allowed resource ARNs that a API key bearer can perform actions on + // For more information about ARN format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . In this preview, you can allow only map resources. Requirements: + // - Must be prefixed with arn . + // - partition and service must not be empty and should begin with only + // alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, + // hyphens (-) and periods (.). + // - region and account-id can be empty or should begin with only alphanumeric + // characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) + // and periods (.). + // - resource-id can begin with any character except for forward slash (/) and + // contain any characters after, including forward slashes to form a path. + // resource-id can also include wildcard characters, denoted by an asterisk (*). + // - arn , partition , service , region , account-id and resource-id must be + // delimited by a colon (:). + // - No spaces allowed. For example, + // arn:aws:geo:region:account-id:map/ExampleMap* . // // This member is required. AllowResources []string @@ -60,20 +51,15 @@ type ApiKeyRestrictions struct { // An optional list of allowed HTTP referers for which requests must originate // from. Requests using this API key from other domains will not be allowed. // Requirements: - // - // * Contain only alphanumeric characters (A–Z, a–z, 0–9) or any - // symbols in this list $\-._+!*`(),;/?:@=& - // - // * May contain a percent (%) if - // followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding - // purposes. - // - // * May contain wildcard characters question mark (?) and asterisk (*). - // Question mark (?) will replace any single character (including hexadecimal - // digits). Asterisk (*) will replace any multiple characters (including multiple - // hexadecimal digits). - // - // * No spaces allowed. For example, https://example.com. + // - Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this + // list $\-._+!*`(),;/?:@=& + // - May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, + // 0-9); this is used for URL encoding purposes. + // - May contain wildcard characters question mark (?) and asterisk (*). + // Question mark (?) will replace any single character (including hexadecimal + // digits). Asterisk (*) will replace any multiple characters (including multiple + // hexadecimal digits). + // - No spaces allowed. For example, https://example.com . AllowReferers []string noSmithyDocumentSerde @@ -95,8 +81,8 @@ type BatchDeleteDevicePositionHistoryError struct { noSmithyDocumentSerde } -// Contains error details for each geofence that failed to delete from the geofence -// collection. +// Contains error details for each geofence that failed to delete from the +// geofence collection. type BatchDeleteGeofenceError struct { // Contains details associated to the batch error. @@ -126,9 +112,8 @@ type BatchEvaluateGeofencesError struct { // This member is required. Error *BatchItemError - // Specifies a timestamp for when the error occurred in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // Specifies a timestamp for when the error occurred in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. SampleTime *time.Time @@ -189,9 +174,9 @@ type BatchPutGeofenceRequestEntry struct { // This member is required. GeofenceId *string - // Contains the details of the position of the geofence. Can be either a polygon or - // a circle. Including both will return a validation error. Each geofence polygon - // (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) + // Contains the details of the position of the geofence. Can be either a polygon + // or a circle. Including both will return a validation error. Each geofence + // polygon (https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html) // can have a maximum of 1,000 vertices. // // This member is required. @@ -216,9 +201,8 @@ type BatchPutGeofenceSuccess struct { // This member is required. GeofenceId *string - // The timestamp for when the geofence was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time @@ -240,9 +224,8 @@ type BatchUpdateDevicePositionError struct { // This member is required. Error *BatchItemError - // The timestamp at which the device position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp at which the device position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. SampleTime *time.Time @@ -251,15 +234,15 @@ type BatchUpdateDevicePositionError struct { } // Contains details about additional route preferences for requests that specify -// TravelMode as Car. +// TravelMode as Car . type CalculateRouteCarModeOptions struct { // Avoids ferries when calculating routes. Default Value: false Valid Values: false // | true AvoidFerries *bool - // Avoids tolls when calculating routes. Default Value: false Valid Values: false | - // true + // Avoids tolls when calculating routes. Default Value: false Valid Values: false + // | true AvoidTolls *bool noSmithyDocumentSerde @@ -268,18 +251,14 @@ type CalculateRouteCarModeOptions struct { // A summary of the calculated route matrix. type CalculateRouteMatrixSummary struct { - // The data provider of traffic and road network data used to calculate the routes. - // Indicates one of the available providers: - // - // * Esri - // - // * Grab - // - // * Here - // - // For more - // information about data providers, see Amazon Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // The data provider of traffic and road network data used to calculate the + // routes. Indicates one of the available providers: + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -296,7 +275,7 @@ type CalculateRouteMatrixSummary struct { ErrorCount *int32 // The count of cells in the route matrix. Equal to the number of - // DeparturePositions multiplied by the number of DestinationPositions. + // DeparturePositions multiplied by the number of DestinationPositions . // // This member is required. RouteCount *int32 @@ -309,16 +288,12 @@ type CalculateRouteSummary struct { // The data provider of traffic and road network data used to calculate the route. // Indicates one of the available providers: - // - // * Esri - // - // * Grab - // - // * Here - // - // For more - // information about data providers, see Amazon Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -342,25 +317,18 @@ type CalculateRouteSummary struct { // This member is required. DurationSeconds *float64 - // Specifies a geographical box surrounding a route. Used to zoom into a route when - // displaying it in a map. For example, [min x, min y, max x, max y]. The first 2 - // bbox parameters describe the lower southwest corner: - // - // * The first bbox position - // is the X coordinate or longitude of the lower southwest corner. - // - // * The second - // bbox position is the Y coordinate or latitude of the lower southwest - // corner. - // + // Specifies a geographical box surrounding a route. Used to zoom into a route + // when displaying it in a map. For example, [min x, min y, max x, max y] . The + // first 2 bbox parameters describe the lower southwest corner: + // - The first bbox position is the X coordinate or longitude of the lower + // southwest corner. + // - The second bbox position is the Y coordinate or latitude of the lower + // southwest corner. // The next 2 bbox parameters describe the upper northeast corner: - // - // * The - // third bbox position is the X coordinate, or longitude of the upper northeast - // corner. - // - // * The fourth bbox position is the Y coordinate, or latitude of the - // upper northeast corner. + // - The third bbox position is the X coordinate, or longitude of the upper + // northeast corner. + // - The fourth bbox position is the Y coordinate, or latitude of the upper + // northeast corner. // // This member is required. RouteBBox []float64 @@ -369,15 +337,15 @@ type CalculateRouteSummary struct { } // Contains details about additional route preferences for requests that specify -// TravelMode as Truck. +// TravelMode as Truck . type CalculateRouteTruckModeOptions struct { // Avoids ferries when calculating routes. Default Value: false Valid Values: false // | true AvoidFerries *bool - // Avoids tolls when calculating routes. Default Value: false Valid Values: false | - // true + // Avoids tolls when calculating routes. Default Value: false Valid Values: false + // | true AvoidTolls *bool // Specifies the truck's dimension specifications including length, height, width, @@ -395,15 +363,14 @@ type CalculateRouteTruckModeOptions struct { // A circle on the earth, as defined by a center point and a radius. type Circle struct { - // A single point geometry, specifying the center of the circle, using WGS 84 - // (https://gisgeography.com/wgs84-world-geodetic-system/) coordinates, in the form - // [longitude, latitude]. + // A single point geometry, specifying the center of the circle, using WGS 84 (https://gisgeography.com/wgs84-world-geodetic-system/) + // coordinates, in the form [longitude, latitude] . // // This member is required. Center []float64 - // The radius of the circle in meters. Must be greater than zero and no larger than - // 100,000 (100 kilometers). + // The radius of the circle in meters. Must be greater than zero and no larger + // than 100,000 (100 kilometers). // // This member is required. Radius *float64 @@ -413,29 +380,20 @@ type Circle struct { // Specifies the data storage option chosen for requesting Places. When using // Amazon Location Places: +// - If using HERE Technologies as a data provider, you can't store results for +// locations in Japan by setting IntendedUse to Storage . parameter. +// - Under the MobileAssetTracking or MobilAssetManagement pricing plan, you +// can't store results from your place index resources by setting IntendedUse to +// Storage . This returns a validation exception error. // -// * If using HERE Technologies as a data provider, you -// can't store results for locations in Japan by setting IntendedUse to Storage. -// parameter. -// -// * Under the MobileAssetTracking or MobilAssetManagement pricing -// plan, you can't store results from your place index resources by setting -// IntendedUse to Storage. This returns a validation exception error. -// -// For more -// information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) +// For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) // for Amazon Location Service. type DataSourceConfiguration struct { // Specifies how the results of an operation will be stored by the caller. Valid // values include: - // - // * SingleUse specifies that the results won't be stored. - // - // * - // Storage specifies that the result can be cached or stored in a - // database. - // + // - SingleUse specifies that the results won't be stored. + // - Storage specifies that the result can be cached or stored in a database. // Default value: SingleUse IntendedUse IntendedUse @@ -450,16 +408,15 @@ type DevicePosition struct { // This member is required. Position []float64 - // The timestamp for when the tracker resource received the device position in ISO - // 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource received the device position in + // ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) format: + // YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. ReceivedTime *time.Time - // The timestamp at which the device's position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp at which the device's position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. SampleTime *time.Time @@ -484,16 +441,14 @@ type DevicePositionUpdate struct { // This member is required. DeviceId *string - // The latest device position defined in WGS 84 - // (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) format: [X or - // longitude, Y or latitude]. + // The latest device position defined in WGS 84 (https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84) + // format: [X or longitude, Y or latitude] . // // This member is required. Position []float64 - // The timestamp at which the device's position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp at which the device's position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. SampleTime *time.Time @@ -509,11 +464,11 @@ type DevicePositionUpdate struct { noSmithyDocumentSerde } -// Contains the geofence geometry details. A geofence geometry is made up of either -// a polygon or a circle. Can be either a polygon or a circle. Including both will -// return a validation error. Amazon Location doesn't currently support polygons -// with holes, multipolygons, polygons that are wound clockwise, or that cross the -// antimeridian. +// Contains the geofence geometry details. A geofence geometry is made up of +// either a polygon or a circle. Can be either a polygon or a circle. Including +// both will return a validation error. Amazon Location doesn't currently support +// polygons with holes, multipolygons, polygons that are wound clockwise, or that +// cross the antimeridian. type GeofenceGeometry struct { // A circle on the earth, as defined by a center point and a radius. @@ -521,15 +476,15 @@ type GeofenceGeometry struct { // A polygon is a list of linear rings which are each made up of a list of // vertices. Each vertex is a 2-dimensional point of the form: [longitude, - // latitude]. This is represented as an array of doubles of length 2 (so [double, - // double]). An array of 4 or more vertices, where the first and last vertex are + // latitude] . This is represented as an array of doubles of length 2 (so [double, + // double] ). An array of 4 or more vertices, where the first and last vertex are // the same (to form a closed boundary), is called a linear ring. The linear ring // vertices must be listed in counter-clockwise order around the ring’s interior. // The linear ring is represented as an array of vertices, or an array of arrays of - // doubles ([[double, double], ...]). A geofence consists of a single linear ring. - // To allow for future expansion, the Polygon parameter takes an array of linear - // rings, which is represented as an array of arrays of arrays of doubles - // ([[[double, double], ...], ...]). A linear ring for use in geofences can consist + // doubles ( [[double, double], ...] ). A geofence consists of a single linear + // ring. To allow for future expansion, the Polygon parameter takes an array of + // linear rings, which is represented as an array of arrays of arrays of doubles ( + // [[[double, double], ...], ...] ). A linear ring for use in geofences can consist // of between 4 and 1,000 vertices. Polygon [][][]float64 @@ -540,52 +495,44 @@ type GeofenceGeometry struct { // positions. The number of legs returned corresponds to one fewer than the total // number of positions in the request. For example, a route with a departure // position and destination position returns one leg with the positions snapped to -// a nearby road -// (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html): +// a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) +// : +// - The StartPosition is the departure position. +// - The EndPosition is the destination position. // -// * -// The StartPosition is the departure position. -// -// * The EndPosition is the -// destination position. -// -// A route with a waypoint between the departure and -// destination position returns two legs with the positions snapped to a nearby -// road: -// -// * Leg 1: The StartPosition is the departure position . The EndPosition is -// the waypoint positon. -// -// * Leg 2: The StartPosition is the waypoint position. The -// EndPosition is the destination position. +// A route with a waypoint between the departure and destination position returns +// two legs with the positions snapped to a nearby road: +// - Leg 1: The StartPosition is the departure position . The EndPosition is the +// waypoint positon. +// - Leg 2: The StartPosition is the waypoint position. The EndPosition is the +// destination position. type Leg struct { // The distance between the leg's StartPosition and EndPosition along a calculated // route. - // - // * The default measurement is Kilometers unless the request specifies a - // DistanceUnit of Miles. + // - The default measurement is Kilometers unless the request specifies a + // DistanceUnit of Miles . // // This member is required. Distance *float64 - // The estimated travel time between the leg's StartPosition and EndPosition. The + // The estimated travel time between the leg's StartPosition and EndPosition . The // travel mode and departure time that you specify in the request determines the // calculated time. // // This member is required. DurationSeconds *float64 - // The terminating position of the leg. Follows the format [longitude,latitude]. If - // the EndPosition isn't located on a road, it's snapped to a nearby road - // (https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html). + // The terminating position of the leg. Follows the format [longitude,latitude] . + // If the EndPosition isn't located on a road, it's snapped to a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html) + // . // // This member is required. EndPosition []float64 - // The starting position of the leg. Follows the format [longitude,latitude]. If - // the StartPosition isn't located on a road, it's snapped to a nearby road - // (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html). + // The starting position of the leg. Follows the format [longitude,latitude] . If + // the StartPosition isn't located on a road, it's snapped to a nearby road (https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html) + // . // // This member is required. StartPosition []float64 @@ -604,16 +551,14 @@ type Leg struct { noSmithyDocumentSerde } -// Contains the geometry details for each path between a pair of positions. Used in -// plotting a route leg on a map. +// Contains the geometry details for each path between a pair of positions. Used +// in plotting a route leg on a map. type LegGeometry struct { // An ordered list of positions used to plot a route on a map. The first position // is closest to the start position for the leg, and the last position is the // closest to the end position for the leg. - // - // * For example, [[-123.117, - // 49.284],[-123.115, 49.285],[-123.115, 49.285]] + // - For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]] LineString [][]float64 noSmithyDocumentSerde @@ -632,9 +577,8 @@ type ListDevicePositionsResponseEntry struct { // This member is required. Position []float64 - // The timestamp at which the device position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp at which the device position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. SampleTime *time.Time @@ -656,9 +600,8 @@ type ListGeofenceCollectionsResponseEntry struct { // This member is required. CollectionName *string - // The timestamp for when the geofence collection was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence collection was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. CreateTime *time.Time @@ -668,14 +611,13 @@ type ListGeofenceCollectionsResponseEntry struct { // This member is required. Description *string - // Specifies a timestamp for when the resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // Specifies a timestamp for when the resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan PricingPlan @@ -710,26 +652,17 @@ type ListGeofenceResponseEntry struct { // Identifies the state of the geofence. A geofence will hold one of the following // states: - // - // * ACTIVE — The geofence has been indexed by the system. - // - // * PENDING — - // The geofence is being processed by the system. - // - // * FAILED — The geofence failed - // to be indexed by the system. - // - // * DELETED — The geofence has been deleted from the - // system index. - // - // * DELETING — The geofence is being deleted from the system index. + // - ACTIVE — The geofence has been indexed by the system. + // - PENDING — The geofence is being processed by the system. + // - FAILED — The geofence failed to be indexed by the system. + // - DELETED — The geofence has been deleted from the system index. + // - DELETING — The geofence is being deleted from the system index. // // This member is required. Status *string - // The timestamp for when the geofence was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ + // The timestamp for when the geofence was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ // // This member is required. UpdateTime *time.Time @@ -740,16 +673,14 @@ type ListGeofenceResponseEntry struct { // An API key resource listed in your Amazon Web Services account. type ListKeysResponseEntry struct { - // The timestamp of when the API key was created, in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp of when the API key was created, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time - // The timestamp for when the API key resource will expire, in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the API key resource will expire, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. ExpireTime *time.Time @@ -765,9 +696,8 @@ type ListKeysResponseEntry struct { // This member is required. Restrictions *ApiKeyRestrictions - // The timestamp of when the API key was last updated, in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp of when the API key was last updated, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time @@ -782,9 +712,8 @@ type ListKeysResponseEntry struct { // account. type ListMapsResponseEntry struct { - // The timestamp for when the map resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time @@ -804,14 +733,13 @@ type ListMapsResponseEntry struct { // This member is required. MapName *string - // The timestamp for when the map resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the map resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan PricingPlan @@ -822,25 +750,19 @@ type ListMapsResponseEntry struct { // A place index resource listed in your Amazon Web Services account. type ListPlaceIndexesResponseEntry struct { - // The timestamp for when the place index resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time // The data provider of geospatial data. Values can be one of the following: - // - // * - // Esri - // - // * Grab - // - // * Here - // - // For more information about data providers, see Amazon - // Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -855,14 +777,13 @@ type ListPlaceIndexesResponseEntry struct { // This member is required. IndexName *string - // The timestamp for when the place index resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the place index resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // No longer used. Always returns RequestBasedUsage. + // No longer used. Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan PricingPlan @@ -878,27 +799,21 @@ type ListRouteCalculatorsResponseEntry struct { // This member is required. CalculatorName *string - // The timestamp when the route calculator resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. - // - // * For example, 2020–07-2T12:15:20.000Z+01:00 + // The timestamp when the route calculator resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // - For example, 2020–07-2T12:15:20.000Z+01:00 // // This member is required. CreateTime *time.Time // The data provider of traffic and road network data. Indicates one of the // available providers: - // - // * Esri - // - // * Grab - // - // * Here - // - // For more information about data - // providers, see Amazon Location Service data providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -908,16 +823,14 @@ type ListRouteCalculatorsResponseEntry struct { // This member is required. Description *string - // The timestamp when the route calculator resource was last updated in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. - // - // * For example, 2020–07-2T12:15:20.000Z+01:00 + // The timestamp when the route calculator resource was last updated in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // - For example, 2020–07-2T12:15:20.000Z+01:00 // // This member is required. UpdateTime *time.Time - // Always returns RequestBasedUsage. + // Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan PricingPlan @@ -928,9 +841,8 @@ type ListRouteCalculatorsResponseEntry struct { // Contains the tracker resource details. type ListTrackersResponseEntry struct { - // The timestamp for when the tracker resource was created in ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp for when the tracker resource was created in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. CreateTime *time.Time @@ -945,14 +857,13 @@ type ListTrackersResponseEntry struct { // This member is required. TrackerName *string - // The timestamp at which the device's position was determined. Uses ISO 8601 - // (https://www.iso.org/iso-8601-date-and-time-format.html) format: - // YYYY-MM-DDThh:mm:ss.sssZ. + // The timestamp at which the device's position was determined. Uses ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html) + // format: YYYY-MM-DDThh:mm:ss.sssZ . // // This member is required. UpdateTime *time.Time - // Always returns RequestBasedUsage. + // Always returns RequestBasedUsage . // // Deprecated: Deprecated. Always returns RequestBasedUsage. PricingPlan PricingPlan @@ -968,110 +879,79 @@ type ListTrackersResponseEntry struct { // Specifies the map tile style selected from an available provider. type MapConfiguration struct { - // Specifies the map style selected from an available data provider. Valid Esri map - // styles - // (https://docs.aws.amazon.com/location/latest/developerguide/esri.html): - // - // * - // VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap - // with a dark gray, neutral background with minimal colors, labels, and features - // that's designed to draw attention to your thematic content. - // - // * RasterEsriImagery - // – The Esri Imagery map style. A raster basemap that provides one meter or better - // satellite and aerial imagery in many parts of the world and lower resolution - // satellite imagery worldwide. - // - // * VectorEsriLightGrayCanvas – The Esri Light Gray - // Canvas map style, which provides a detailed vector basemap with a light gray, - // neutral background style with minimal colors, labels, and features that's - // designed to draw attention to your thematic content. - // - // * VectorEsriTopographic – - // The Esri Light map style, which provides a detailed vector basemap with a - // classic Esri map style. - // - // * VectorEsriStreets – The Esri World Streets map style, - // which provides a detailed vector basemap for the world symbolized with a classic - // Esri street map style. The vector tile layer is similar in content and style to - // the World Street Map raster map. - // - // * VectorEsriNavigation – The Esri World - // Navigation map style, which provides a detailed basemap for the world symbolized - // with a custom navigation map style that's designed for use during the day in - // mobile devices. - // - // Valid HERE Technologies map styles - // (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html): - // - // * - // VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast - // detailed base map of the world that blends 3D and 2D rendering. The - // VectorHereContrast style has been renamed from VectorHereBerlin. - // VectorHereBerlin has been deprecated, but will continue to work in applications - // that use it. - // - // * VectorHereExplore – A default HERE map style containing a - // neutral, global map and its features including roads, buildings, landmarks, and - // water features. It also now includes a fully designed map of Japan. - // - // * - // VectorHereExploreTruck – A global map containing truck restrictions and - // attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments - // and icons on top of HERE Explore to support use cases within transport and - // logistics. - // - // * RasterHereExploreSatellite – A global map containing high - // resolution satellite imagery. - // - // * HybridHereExploreSatellite – A global map - // displaying the road network, street names, and city labels over satellite - // imagery. This style will automatically retrieve both raster and vector tiles, - // and your charges will be based on total tiles retrieved. Hybrid styles use both - // vector and raster tiles when rendering the map that you see. This means that - // more tiles are retrieved than when using either vector or raster tiles alone. - // Your charges will include all tiles retrieved. - // - // Valid GrabMaps map styles - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html): - // - // * - // VectorGrabStandardLight – The Grab Standard Light map style provides a basemap - // with detailed land use coloring, area names, roads, landmarks, and points of - // interest covering Southeast Asia. - // - // * VectorGrabStandardDark – The Grab Standard - // Dark map style provides a dark variation of the standard basemap covering - // Southeast Asia. - // - // Grab provides maps only for countries in Southeast Asia, and is - // only available in the Asia Pacific (Singapore) Region (ap-southeast-1). For more - // information, see GrabMaps countries and area covered - // (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area). - // Valid Open Data map styles - // (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html): - // - // * - // VectorOpenDataStandardLight – The Open Data Standard Light map style provides a - // detailed basemap for the world suitable for website and mobile application use. - // The map includes highways major roads, minor roads, railways, water features, - // cities, parks, landmarks, building footprints, and administrative boundaries. - // - // * - // VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style - // that provides a detailed basemap for the world suitable for website and mobile - // application use. The map includes highways major roads, minor roads, railways, - // water features, cities, parks, landmarks, building footprints, and - // administrative boundaries. - // - // * VectorOpenDataVisualizationLight – The Open Data - // Visualization Light map style is a light-themed style with muted colors and - // fewer features that aids in understanding overlaid data. - // - // * - // VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is - // a dark-themed style with muted colors and fewer features that aids in - // understanding overlaid data. + // Specifies the map style selected from an available data provider. Valid Esri + // map styles (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) + // : + // - VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector + // basemap with a dark gray, neutral background with minimal colors, labels, and + // features that's designed to draw attention to your thematic content. + // - RasterEsriImagery – The Esri Imagery map style. A raster basemap that + // provides one meter or better satellite and aerial imagery in many parts of the + // world and lower resolution satellite imagery worldwide. + // - VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which + // provides a detailed vector basemap with a light gray, neutral background style + // with minimal colors, labels, and features that's designed to draw attention to + // your thematic content. + // - VectorEsriTopographic – The Esri Light map style, which provides a detailed + // vector basemap with a classic Esri map style. + // - VectorEsriStreets – The Esri World Streets map style, which provides a + // detailed vector basemap for the world symbolized with a classic Esri street map + // style. The vector tile layer is similar in content and style to the World Street + // Map raster map. + // - VectorEsriNavigation – The Esri World Navigation map style, which provides a + // detailed basemap for the world symbolized with a custom navigation map style + // that's designed for use during the day in mobile devices. + // Valid HERE Technologies map styles (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) + // : + // - VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast + // detailed base map of the world that blends 3D and 2D rendering. The + // VectorHereContrast style has been renamed from VectorHereBerlin . + // VectorHereBerlin has been deprecated, but will continue to work in + // applications that use it. + // - VectorHereExplore – A default HERE map style containing a neutral, global + // map and its features including roads, buildings, landmarks, and water features. + // It also now includes a fully designed map of Japan. + // - VectorHereExploreTruck – A global map containing truck restrictions and + // attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments + // and icons on top of HERE Explore to support use cases within transport and + // logistics. + // - RasterHereExploreSatellite – A global map containing high resolution + // satellite imagery. + // - HybridHereExploreSatellite – A global map displaying the road network, + // street names, and city labels over satellite imagery. This style will + // automatically retrieve both raster and vector tiles, and your charges will be + // based on total tiles retrieved. Hybrid styles use both vector and raster tiles + // when rendering the map that you see. This means that more tiles are retrieved + // than when using either vector or raster tiles alone. Your charges will include + // all tiles retrieved. + // Valid GrabMaps map styles (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) + // : + // - VectorGrabStandardLight – The Grab Standard Light map style provides a + // basemap with detailed land use coloring, area names, roads, landmarks, and + // points of interest covering Southeast Asia. + // - VectorGrabStandardDark – The Grab Standard Dark map style provides a dark + // variation of the standard basemap covering Southeast Asia. + // Grab provides maps only for countries in Southeast Asia, and is only available + // in the Asia Pacific (Singapore) Region ( ap-southeast-1 ). For more information, + // see GrabMaps countries and area covered (https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area) + // . Valid Open Data map styles (https://docs.aws.amazon.com/location/latest/developerguide/open-data.html) + // : + // - VectorOpenDataStandardLight – The Open Data Standard Light map style + // provides a detailed basemap for the world suitable for website and mobile + // application use. The map includes highways major roads, minor roads, railways, + // water features, cities, parks, landmarks, building footprints, and + // administrative boundaries. + // - VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map + // style that provides a detailed basemap for the world suitable for website and + // mobile application use. The map includes highways major roads, minor roads, + // railways, water features, cities, parks, landmarks, building footprints, and + // administrative boundaries. + // - VectorOpenDataVisualizationLight – The Open Data Visualization Light map + // style is a light-themed style with muted colors and fewer features that aids in + // understanding overlaid data. + // - VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style + // is a dark-themed style with muted colors and fewer features that aids in + // understanding overlaid data. // // This member is required. Style *string @@ -1092,27 +972,26 @@ type Place struct { // The numerical portion of an address, such as a building number. AddressNumber *string - // A country/region specified using ISO 3166 - // (https://www.iso.org/iso-3166-country-codes.html) 3-digit country/region code. - // For example, CAN. + // A country/region specified using ISO 3166 (https://www.iso.org/iso-3166-country-codes.html) + // 3-digit country/region code. For example, CAN . Country *string // True if the result is interpolated from other known places. False if the Place // is a known place. Not returned when the partner does not provide the - // information. For example, returns False for an address location that is found in - // the partner data, but returns True if an address does not exist in the partner - // data and its location is calculated by interpolating between other known + // information. For example, returns False for an address location that is found + // in the partner data, but returns True if an address does not exist in the + // partner data and its location is calculated by interpolating between other known // addresses. Interpolated *bool // The full name and address of the point of interest such as a city, region, or - // country. For example, 123 Any Street, Any Town, USA. + // country. For example, 123 Any Street, Any Town, USA . Label *string - // A name for a local area, such as a city or town name. For example, Toronto. + // A name for a local area, such as a city or town name. For example, Toronto . Municipality *string - // The name of a community district. For example, Downtown. + // The name of a community district. For example, Downtown . Neighborhood *string // A group of numbers and letters in a country-specific format, which accompanies @@ -1120,15 +999,15 @@ type Place struct { PostalCode *string // A name for an area or geographical division, such as a province or state name. - // For example, British Columbia. + // For example, British Columbia . Region *string - // The name for a street or a road to identify a location. For example, Main - // Street. + // The name for a street or a road to identify a location. For example, Main Street + // . Street *string // A county, or an area that's part of a larger region. For example, Metro - // Vancouver. + // Vancouver . SubRegion *string // The time zone in which the Place is located. Returned only when using HERE as @@ -1136,11 +1015,11 @@ type Place struct { TimeZone *TimeZone // For addresses with multiple units, the unit identifier. Can include numbers and - // letters, for example 3B or Unit 123. Returned only for a place index that uses - // Esri as a data provider. Is not returned for SearchPlaceIndexForPosition. + // letters, for example 3B or Unit 123 . Returned only for a place index that uses + // Esri as a data provider. Is not returned for SearchPlaceIndexForPosition . UnitNumber *string - // For addresses with a UnitNumber, the type of unit. For example, Apartment. + // For addresses with a UnitNumber , the type of unit. For example, Apartment . UnitType *string noSmithyDocumentSerde @@ -1149,14 +1028,10 @@ type Place struct { // Places uses a point geometry to specify a location or a Place. type PlaceGeometry struct { - // A single point geometry specifies a location for a Place using WGS 84 - // (https://gisgeography.com/wgs84-world-geodetic-system/) coordinates: - // - // * x — - // Specifies the x coordinate or longitude. - // - // * y — Specifies the y coordinate or - // latitude. + // A single point geometry specifies a location for a Place using WGS 84 (https://gisgeography.com/wgs84-world-geodetic-system/) + // coordinates: + // - x — Specifies the x coordinate or longitude. + // - y — Specifies the y coordinate or latitude. Point []float64 noSmithyDocumentSerde @@ -1174,7 +1049,7 @@ type PositionalAccuracy struct { noSmithyDocumentSerde } -// The result for the calculated route of one DeparturePositionDestinationPosition +// The result for the calculated route of one DeparturePosition DestinationPosition // pair. type RouteMatrixEntry struct { @@ -1185,34 +1060,32 @@ type RouteMatrixEntry struct { DurationSeconds *float64 // An error corresponding to the calculation of a route between the - // DeparturePosition and DestinationPosition. + // DeparturePosition and DestinationPosition . Error *RouteMatrixEntryError noSmithyDocumentSerde } // An error corresponding to the calculation of a route between the -// DeparturePosition and DestinationPosition. The error code can be one of the +// DeparturePosition and DestinationPosition . The error code can be one of the // following: // -// * RouteNotFound - Unable to find a valid route with the given -// parameters. +// - RouteNotFound - Unable to find a valid route with the given parameters. // -// * RouteTooLong - Route calculation went beyond the maximum size of -// a route and was terminated before completion. +// - RouteTooLong - Route calculation went beyond the maximum size of a route and +// was terminated before completion. // -// * PositionsNotFound - One or more -// of the input positions were not found on the route network. +// - PositionsNotFound - One or more of the input positions were not found on the +// route network. // -// * -// DestinationPositionNotFound - The destination position was not found on the -// route network. +// - DestinationPositionNotFound - The destination position was not found on the +// route network. // -// * DeparturePositionNotFound - The departure position was not -// found on the route network. +// - DeparturePositionNotFound - The departure position was not found on the +// route network. // -// * OtherValidationError - The given inputs were not -// valid or a route was not found. More information is given in the error Message +// - OtherValidationError - The given inputs were not valid or a route was not +// found. More information is given in the error Message type RouteMatrixEntryError struct { // The type of error which occurred for the route calculation. @@ -1242,10 +1115,10 @@ type SearchForPositionResult struct { // This member is required. Place *Place - // The unique identifier of the place. You can use this with the GetPlace operation - // to find the place again later. For SearchPlaceIndexForPosition operations, the - // PlaceId is returned only by place indexes that use HERE or Grab as a data - // provider. + // The unique identifier of the place. You can use this with the GetPlace + // operation to find the place again later. For SearchPlaceIndexForPosition + // operations, the PlaceId is returned only by place indexes that use HERE or Grab + // as a data provider. PlaceId *string noSmithyDocumentSerde @@ -1260,10 +1133,10 @@ type SearchForSuggestionsResult struct { // This member is required. Text *string - // The unique identifier of the place. You can use this with the GetPlace operation - // to find the place again later. For SearchPlaceIndexForSuggestions operations, - // the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data - // providers. + // The unique identifier of the place. You can use this with the GetPlace + // operation to find the place again later. For SearchPlaceIndexForSuggestions + // operations, the PlaceId is returned by place indexes that use Esri, Grab, or + // HERE as data providers. PlaceId *string noSmithyDocumentSerde @@ -1278,16 +1151,16 @@ type SearchForTextResult struct { // This member is required. Place *Place - // The distance in meters of a great-circle arc between the bias position specified - // and the result. Distance will be returned only if a bias position was specified - // in the query. A great-circle arc is the shortest path on a sphere, in this case - // the Earth. This returns the shortest distance between two locations. + // The distance in meters of a great-circle arc between the bias position + // specified and the result. Distance will be returned only if a bias position was + // specified in the query. A great-circle arc is the shortest path on a sphere, in + // this case the Earth. This returns the shortest distance between two locations. Distance *float64 - // The unique identifier of the place. You can use this with the GetPlace operation - // to find the place again later. For SearchPlaceIndexForText operations, the - // PlaceId is returned only by place indexes that use HERE or Grab as a data - // provider. + // The unique identifier of the place. You can use this with the GetPlace + // operation to find the place again later. For SearchPlaceIndexForText + // operations, the PlaceId is returned only by place indexes that use HERE or Grab + // as a data provider. PlaceId *string // The relative confidence in the match for a result among the results returned. @@ -1299,22 +1172,17 @@ type SearchForTextResult struct { noSmithyDocumentSerde } -// A summary of the request sent by using SearchPlaceIndexForPosition. +// A summary of the request sent by using SearchPlaceIndexForPosition . type SearchPlaceIndexForPositionSummary struct { // The geospatial data provider attached to the place index resource specified in // the request. Values can be one of the following: - // - // * Esri - // - // * Grab - // - // * Here - // - // For - // more information about data providers, see Amazon Location Service data - // providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -1336,22 +1204,17 @@ type SearchPlaceIndexForPositionSummary struct { noSmithyDocumentSerde } -// A summary of the request sent by using SearchPlaceIndexForSuggestions. +// A summary of the request sent by using SearchPlaceIndexForSuggestions . type SearchPlaceIndexForSuggestionsSummary struct { // The geospatial data provider attached to the place index resource specified in // the request. Values can be one of the following: - // - // * Esri - // - // * Grab - // - // * Here - // - // For - // more information about data providers, see Amazon Location Service data - // providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -1365,7 +1228,7 @@ type SearchPlaceIndexForSuggestionsSummary struct { // request. This parameter contains a pair of numbers. The first number represents // the X coordinate, or longitude; the second number represents the Y coordinate, // or latitude. For example, [-123.1174, 49.2847] represents the position with - // longitude -123.1174 and latitude 49.2847. + // longitude -123.1174 and latitude 49.2847 . BiasPosition []float64 // Contains the coordinates for the optional bounding box specified in the request. @@ -1385,22 +1248,17 @@ type SearchPlaceIndexForSuggestionsSummary struct { noSmithyDocumentSerde } -// A summary of the request sent by using SearchPlaceIndexForText. +// A summary of the request sent by using SearchPlaceIndexForText . type SearchPlaceIndexForTextSummary struct { // The geospatial data provider attached to the place index resource specified in // the request. Values can be one of the following: - // - // * Esri - // - // * Grab - // - // * Here - // - // For - // more information about data providers, see Amazon Location Service data - // providers - // (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html). + // - Esri + // - Grab + // - Here + // For more information about data providers, see Amazon Location Service data + // providers (https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) + // . // // This member is required. DataSource *string @@ -1414,7 +1272,7 @@ type SearchPlaceIndexForTextSummary struct { // request. This parameter contains a pair of numbers. The first number represents // the X coordinate, or longitude; the second number represents the Y coordinate, // or latitude. For example, [-123.1174, 49.2847] represents the position with - // longitude -123.1174 and latitude 49.2847. + // longitude -123.1174 and latitude 49.2847 . BiasPosition []float64 // Contains the coordinates for the optional bounding box specified in the request. @@ -1433,7 +1291,7 @@ type SearchPlaceIndexForTextSummary struct { // The bounding box that fully contains all search results. If you specified the // optional FilterBBox parameter in the request, ResultBBox is contained within - // FilterBBox. + // FilterBBox . ResultBBox []float64 noSmithyDocumentSerde @@ -1443,13 +1301,13 @@ type SearchPlaceIndexForTextSummary struct { // how to move to the next step in the leg. type Step struct { - // The travel distance between the step's StartPosition and EndPosition. + // The travel distance between the step's StartPosition and EndPosition . // // This member is required. Distance *float64 // The estimated travel time, in seconds, from the step's StartPosition to the - // EndPosition. . The travel mode and departure time that you specify in the + // EndPosition . . The travel mode and departure time that you specify in the // request determines the calculated time. // // This member is required. @@ -1467,20 +1325,21 @@ type Step struct { // This member is required. StartPosition []float64 - // Represents the start position, or index, in a sequence of steps within the leg's - // line string geometry. For example, the index of the first step in a leg geometry - // is 0. Included in the response for queries that set IncludeLegGeometry to True. + // Represents the start position, or index, in a sequence of steps within the + // leg's line string geometry. For example, the index of the first step in a leg + // geometry is 0 . Included in the response for queries that set IncludeLegGeometry + // to True . GeometryOffset *int32 noSmithyDocumentSerde } -// Information about a time zone. Includes the name of the time zone and the offset -// from UTC in seconds. +// Information about a time zone. Includes the name of the time zone and the +// offset from UTC in seconds. type TimeZone struct { - // The name of the time zone, following the IANA time zone standard - // (https://www.iana.org/time-zones). For example, America/Los_Angeles. + // The name of the time zone, following the IANA time zone standard (https://www.iana.org/time-zones) + // . For example, America/Los_Angeles . // // This member is required. Name *string @@ -1493,23 +1352,19 @@ type TimeZone struct { // Contains details about the truck dimensions in the unit of measurement that you // specify. Used to filter out roads that can't support or allow the specified -// dimensions for requests that specify TravelMode as Truck. +// dimensions for requests that specify TravelMode as Truck . type TruckDimensions struct { // The height of the truck. - // - // * For example, 4.5. - // - // For routes calculated with a HERE - // resource, this value must be between 0 and 50 meters. + // - For example, 4.5 . + // For routes calculated with a HERE resource, this value must be between 0 and 50 + // meters. Height *float64 // The length of the truck. - // - // * For example, 15.5. - // - // For routes calculated with a - // HERE resource, this value must be between 0 and 300 meters. + // - For example, 15.5 . + // For routes calculated with a HERE resource, this value must be between 0 and + // 300 meters. Length *float64 // Specifies the unit of measurement for the truck dimensions. Default Value: @@ -1517,11 +1372,9 @@ type TruckDimensions struct { Unit DimensionUnit // The width of the truck. - // - // * For example, 4.5. - // - // For routes calculated with a HERE - // resource, this value must be between 0 and 50 meters. + // - For example, 4.5 . + // For routes calculated with a HERE resource, this value must be between 0 and 50 + // meters. Width *float64 noSmithyDocumentSerde @@ -1529,12 +1382,11 @@ type TruckDimensions struct { // Contains details about the truck's weight specifications. Used to avoid roads // that can't support or allow the total weight for requests that specify -// TravelMode as Truck. +// TravelMode as Truck . type TruckWeight struct { // The total weight of the truck. - // - // * For example, 3500. + // - For example, 3500 . Total *float64 // The unit of measurement to use for the truck weight. Default Value: Kilograms diff --git a/service/lookoutequipment/api_client.go b/service/lookoutequipment/api_client.go index 5c708d44f68..46c8c80d8b0 100644 --- a/service/lookoutequipment/api_client.go +++ b/service/lookoutequipment/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lookoutequipment/api_op_CreateDataset.go b/service/lookoutequipment/api_op_CreateDataset.go index ec1b96f8ff5..f7e8f584050 100644 --- a/service/lookoutequipment/api_op_CreateDataset.go +++ b/service/lookoutequipment/api_op_CreateDataset.go @@ -34,8 +34,8 @@ func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, type CreateDatasetInput struct { - // A unique identifier for the request. If you do not set the client request token, - // Amazon Lookout for Equipment generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Lookout for Equipment generates one. // // This member is required. ClientToken *string diff --git a/service/lookoutequipment/api_op_CreateInferenceScheduler.go b/service/lookoutequipment/api_op_CreateInferenceScheduler.go index 0c1074ecd71..2dcd0829bef 100644 --- a/service/lookoutequipment/api_op_CreateInferenceScheduler.go +++ b/service/lookoutequipment/api_op_CreateInferenceScheduler.go @@ -35,8 +35,8 @@ func (c *Client) CreateInferenceScheduler(ctx context.Context, params *CreateInf type CreateInferenceSchedulerInput struct { - // A unique identifier for the request. If you do not set the client request token, - // Amazon Lookout for Equipment generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Lookout for Equipment generates one. // // This member is required. ClientToken *string @@ -58,8 +58,8 @@ type CreateInferenceSchedulerInput struct { // you select 5 minutes, Amazon Lookout for Equipment will upload the real-time // data to the source bucket once every 5 minutes. This frequency also determines // how often Amazon Lookout for Equipment runs inference on your data. For more - // information, see Understanding the inference process - // (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html). + // information, see Understanding the inference process (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html) + // . // // This member is required. DataUploadFrequency types.DataUploadFrequency @@ -89,8 +89,8 @@ type CreateInferenceSchedulerInput struct { // bucket. The delay provides a buffer for you to upload data at the same // frequency, so that you don't have to stop and restart the scheduler when // uploading new data. For more information, see Understanding the inference - // process - // (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html). + // process (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html) + // . DataDelayOffsetInMinutes *int64 // Provides the identifier of the KMS key used to encrypt inference scheduler data diff --git a/service/lookoutequipment/api_op_CreateLabel.go b/service/lookoutequipment/api_op_CreateLabel.go index 94970c56ca7..e9df62d3ae6 100644 --- a/service/lookoutequipment/api_op_CreateLabel.go +++ b/service/lookoutequipment/api_op_CreateLabel.go @@ -58,9 +58,9 @@ type CreateLabelInput struct { // This member is required. StartTime *time.Time - // Indicates that a label pertains to a particular piece of equipment. Data in this - // field will be retained for service usage. Follow best practices for the security - // of your data. + // Indicates that a label pertains to a particular piece of equipment. Data in + // this field will be retained for service usage. Follow best practices for the + // security of your data. Equipment *string // Provides additional information about the label. The fault code must be defined diff --git a/service/lookoutequipment/api_op_CreateModel.go b/service/lookoutequipment/api_op_CreateModel.go index 9869133e9d8..99844f983cb 100644 --- a/service/lookoutequipment/api_op_CreateModel.go +++ b/service/lookoutequipment/api_op_CreateModel.go @@ -39,8 +39,8 @@ func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optF type CreateModelInput struct { - // A unique identifier for the request. If you do not set the client request token, - // Amazon Lookout for Equipment generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Lookout for Equipment generates one. // // This member is required. ClientToken *string @@ -55,11 +55,11 @@ type CreateModelInput struct { // This member is required. ModelName *string - // The configuration is the TargetSamplingRate, which is the sampling rate of the + // The configuration is the TargetSamplingRate , which is the sampling rate of the // data after post processing by Amazon Lookout for Equipment. For example, if you // provide data that has been collected at a 1 second level and you want the system // to resample the data at a 1 minute rate before training, the TargetSamplingRate - // is 1 minute. When providing a value for the TargetSamplingRate, you must attach + // is 1 minute. When providing a value for the TargetSamplingRate , you must attach // the prefix "PT" to the rate you want. The value for a 1 second rate is therefore // PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate // is PT1H diff --git a/service/lookoutequipment/api_op_DescribeDataIngestionJob.go b/service/lookoutequipment/api_op_DescribeDataIngestionJob.go index 4643df5a4a5..b9be118c66c 100644 --- a/service/lookoutequipment/api_op_DescribeDataIngestionJob.go +++ b/service/lookoutequipment/api_op_DescribeDataIngestionJob.go @@ -79,8 +79,8 @@ type DescribeDataIngestionJobOutput struct { // Indicates the job ID of the data ingestion job. JobId *string - // The Amazon Resource Name (ARN) of an IAM role with permission to access the data - // source being ingested. + // The Amazon Resource Name (ARN) of an IAM role with permission to access the + // data source being ingested. RoleArn *string // Indicates the status of the DataIngestionJob operation. diff --git a/service/lookoutequipment/api_op_DescribeDataset.go b/service/lookoutequipment/api_op_DescribeDataset.go index b6dc98fc8d1..11b79ee1719 100644 --- a/service/lookoutequipment/api_op_DescribeDataset.go +++ b/service/lookoutequipment/api_op_DescribeDataset.go @@ -64,8 +64,8 @@ type DescribeDatasetOutput struct { // The name of the dataset being described. DatasetName *string - // IngestedFilesSummary associated with the given dataset for the latest successful - // associated ingestion job id. + // IngestedFilesSummary associated with the given dataset for the latest + // successful associated ingestion job id. IngestedFilesSummary *types.IngestedFilesSummary // Specifies the S3 location configuration for the data input for the data diff --git a/service/lookoutequipment/api_op_DescribeInferenceScheduler.go b/service/lookoutequipment/api_op_DescribeInferenceScheduler.go index fa3b1f67a40..e7f01351303 100644 --- a/service/lookoutequipment/api_op_DescribeInferenceScheduler.go +++ b/service/lookoutequipment/api_op_DescribeInferenceScheduler.go @@ -62,12 +62,12 @@ type DescribeInferenceSchedulerOutput struct { // including the output S3 location. DataOutputConfiguration *types.InferenceOutputConfiguration - // Specifies how often data is uploaded to the source S3 bucket for the input data. - // This value is the length of time between data uploads. For instance, if you - // select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to - // the source bucket once every 5 minutes. This frequency also determines how often - // Amazon Lookout for Equipment starts a scheduled inference on your data. In this - // example, it starts once every 5 minutes. + // Specifies how often data is uploaded to the source S3 bucket for the input + // data. This value is the length of time between data uploads. For instance, if + // you select 5 minutes, Amazon Lookout for Equipment will upload the real-time + // data to the source bucket once every 5 minutes. This frequency also determines + // how often Amazon Lookout for Equipment starts a scheduled inference on your + // data. In this example, it starts once every 5 minutes. DataUploadFrequency types.DataUploadFrequency // The Amazon Resource Name (ARN) of the inference scheduler being described. @@ -76,8 +76,8 @@ type DescribeInferenceSchedulerOutput struct { // The name of the inference scheduler being described. InferenceSchedulerName *string - // Indicates whether the latest execution for the inference scheduler was Anomalous - // (anomalous events found) or Normal (no anomalous events found). + // Indicates whether the latest execution for the inference scheduler was + // Anomalous (anomalous events found) or Normal (no anomalous events found). LatestInferenceResult types.LatestInferenceResult // The Amazon Resource Name (ARN) of the ML model of the inference scheduler being diff --git a/service/lookoutequipment/api_op_DescribeLabel.go b/service/lookoutequipment/api_op_DescribeLabel.go index 22c23e93941..1d05585d419 100644 --- a/service/lookoutequipment/api_op_DescribeLabel.go +++ b/service/lookoutequipment/api_op_DescribeLabel.go @@ -54,9 +54,9 @@ type DescribeLabelOutput struct { // Indicates that a label pertains to a particular piece of equipment. Equipment *string - // Indicates the type of anomaly associated with the label. Data in this field will - // be retained for service usage. Follow best practices for the security of your - // data. + // Indicates the type of anomaly associated with the label. Data in this field + // will be retained for service usage. Follow best practices for the security of + // your data. FaultCode *string // The ARN of the requested label group. diff --git a/service/lookoutequipment/api_op_DescribeModel.go b/service/lookoutequipment/api_op_DescribeModel.go index e3d94a98b04..9bcd28c49fe 100644 --- a/service/lookoutequipment/api_op_DescribeModel.go +++ b/service/lookoutequipment/api_op_DescribeModel.go @@ -45,11 +45,11 @@ type DescribeModelOutput struct { // Indicates the time and date at which the ML model was created. CreatedAt *time.Time - // The configuration is the TargetSamplingRate, which is the sampling rate of the + // The configuration is the TargetSamplingRate , which is the sampling rate of the // data after post processing by Amazon Lookout for Equipment. For example, if you // provide data that has been collected at a 1 second level and you want the system // to resample the data at a 1 minute rate before training, the TargetSamplingRate - // is 1 minute. When providing a value for the TargetSamplingRate, you must attach + // is 1 minute. When providing a value for the TargetSamplingRate , you must attach // the prefix "PT" to the rate you want. The value for a 1 second rate is therefore // PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate // is PT1H @@ -66,8 +66,8 @@ type DescribeModelOutput struct { // evaluation data for the ML model. EvaluationDataEndTime *time.Time - // Indicates the time reference in the dataset that was used to begin the subset of - // evaluation data for the ML model. + // Indicates the time reference in the dataset that was used to begin the subset + // of evaluation data for the ML model. EvaluationDataStartTime *time.Time // If the training of the ML model failed, this indicates the reason for that @@ -122,8 +122,8 @@ type DescribeModelOutput struct { // training data for the ML model. TrainingDataEndTime *time.Time - // Indicates the time reference in the dataset that was used to begin the subset of - // training data for the ML model. + // Indicates the time reference in the dataset that was used to begin the subset + // of training data for the ML model. TrainingDataStartTime *time.Time // Indicates the time at which the training of the ML model was completed. diff --git a/service/lookoutequipment/api_op_ListDatasets.go b/service/lookoutequipment/api_op_ListDatasets.go index 7c248f5aac7..e7e817c2557 100644 --- a/service/lookoutequipment/api_op_ListDatasets.go +++ b/service/lookoutequipment/api_op_ListDatasets.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all datasets currently available in your account, filtering on the dataset -// name. +// Lists all datasets currently available in your account, filtering on the +// dataset name. func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error) { if params == nil { params = &ListDatasetsInput{} diff --git a/service/lookoutequipment/api_op_ListInferenceEvents.go b/service/lookoutequipment/api_op_ListInferenceEvents.go index 021db42f7ad..bb506c7aca1 100644 --- a/service/lookoutequipment/api_op_ListInferenceEvents.go +++ b/service/lookoutequipment/api_op_ListInferenceEvents.go @@ -37,8 +37,8 @@ type ListInferenceEventsInput struct { // This member is required. InferenceSchedulerName *string - // Returns all the inference events with an end start time equal to or greater than - // less than the end time given + // Returns all the inference events with an end start time equal to or greater + // than less than the end time given // // This member is required. IntervalEndTime *time.Time @@ -52,8 +52,8 @@ type ListInferenceEventsInput struct { // Specifies the maximum number of inference events to list. MaxResults *int32 - // An opaque pagination token indicating where to continue the listing of inference - // events. + // An opaque pagination token indicating where to continue the listing of + // inference events. NextToken *string noSmithyDocumentSerde @@ -66,8 +66,8 @@ type ListInferenceEventsOutput struct { // time, event end time, diagnostics, and so on. InferenceEventSummaries []types.InferenceEventSummary - // An opaque pagination token indicating where to continue the listing of inference - // executions. + // An opaque pagination token indicating where to continue the listing of + // inference executions. NextToken *string // Metadata pertaining to the operation's result. @@ -139,8 +139,8 @@ func (c *Client) addOperationListInferenceEventsMiddlewares(stack *middleware.St return nil } -// ListInferenceEventsAPIClient is a client that implements the ListInferenceEvents -// operation. +// ListInferenceEventsAPIClient is a client that implements the +// ListInferenceEvents operation. type ListInferenceEventsAPIClient interface { ListInferenceEvents(context.Context, *ListInferenceEventsInput, ...func(*Options)) (*ListInferenceEventsOutput, error) } diff --git a/service/lookoutequipment/api_op_ListInferenceExecutions.go b/service/lookoutequipment/api_op_ListInferenceExecutions.go index 21f59a023a2..1b82321dd6e 100644 --- a/service/lookoutequipment/api_op_ListInferenceExecutions.go +++ b/service/lookoutequipment/api_op_ListInferenceExecutions.go @@ -48,8 +48,8 @@ type ListInferenceExecutionsInput struct { // Specifies the maximum number of inference executions to list. MaxResults *int32 - // An opaque pagination token indicating where to continue the listing of inference - // executions. + // An opaque pagination token indicating where to continue the listing of + // inference executions. NextToken *string // The status of the inference execution. @@ -65,8 +65,8 @@ type ListInferenceExecutionsOutput struct { // inference scheduler, data configuration, and so on. InferenceExecutionSummaries []types.InferenceExecutionSummary - // An opaque pagination token indicating where to continue the listing of inference - // executions. + // An opaque pagination token indicating where to continue the listing of + // inference executions. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_ListInferenceSchedulers.go b/service/lookoutequipment/api_op_ListInferenceSchedulers.go index 199dd127d9e..152024e128c 100644 --- a/service/lookoutequipment/api_op_ListInferenceSchedulers.go +++ b/service/lookoutequipment/api_op_ListInferenceSchedulers.go @@ -40,8 +40,8 @@ type ListInferenceSchedulersInput struct { // The name of the ML model used by the inference scheduler to be listed. ModelName *string - // An opaque pagination token indicating where to continue the listing of inference - // schedulers. + // An opaque pagination token indicating where to continue the listing of + // inference schedulers. NextToken *string // Specifies the current status of the inference schedulers to list. @@ -56,8 +56,8 @@ type ListInferenceSchedulersOutput struct { // upload frequency, model name and ARN, and status. InferenceSchedulerSummaries []types.InferenceSchedulerSummary - // An opaque pagination token indicating where to continue the listing of inference - // schedulers. + // An opaque pagination token indicating where to continue the listing of + // inference schedulers. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_ListSensorStatistics.go b/service/lookoutequipment/api_op_ListSensorStatistics.go index b428c79c731..79683f0493f 100644 --- a/service/lookoutequipment/api_op_ListSensorStatistics.go +++ b/service/lookoutequipment/api_op_ListSensorStatistics.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists statistics about the data collected for each of the sensors that have been -// successfully ingested in the particular dataset. Can also be used to retreive -// Sensor Statistics for a previous ingestion job. +// Lists statistics about the data collected for each of the sensors that have +// been successfully ingested in the particular dataset. Can also be used to +// retreive Sensor Statistics for a previous ingestion job. func (c *Client) ListSensorStatistics(ctx context.Context, params *ListSensorStatisticsInput, optFns ...func(*Options)) (*ListSensorStatisticsOutput, error) { if params == nil { params = &ListSensorStatisticsInput{} diff --git a/service/lookoutequipment/api_op_StartDataIngestionJob.go b/service/lookoutequipment/api_op_StartDataIngestionJob.go index 5ca026ed052..cf7edf69542 100644 --- a/service/lookoutequipment/api_op_StartDataIngestionJob.go +++ b/service/lookoutequipment/api_op_StartDataIngestionJob.go @@ -31,8 +31,8 @@ func (c *Client) StartDataIngestionJob(ctx context.Context, params *StartDataIng type StartDataIngestionJobInput struct { - // A unique identifier for the request. If you do not set the client request token, - // Amazon Lookout for Equipment generates one. + // A unique identifier for the request. If you do not set the client request + // token, Amazon Lookout for Equipment generates one. // // This member is required. ClientToken *string diff --git a/service/lookoutequipment/api_op_UpdateInferenceScheduler.go b/service/lookoutequipment/api_op_UpdateInferenceScheduler.go index bf02c51baeb..c0c04e82360 100644 --- a/service/lookoutequipment/api_op_UpdateInferenceScheduler.go +++ b/service/lookoutequipment/api_op_UpdateInferenceScheduler.go @@ -52,10 +52,10 @@ type UpdateInferenceSchedulerInput struct { // including the output S3 location. DataOutputConfiguration *types.InferenceOutputConfiguration - // How often data is uploaded to the source S3 bucket for the input data. The value - // chosen is the length of time between data uploads. For instance, if you select 5 - // minutes, Amazon Lookout for Equipment will upload the real-time data to the - // source bucket once every 5 minutes. This frequency also determines how often + // How often data is uploaded to the source S3 bucket for the input data. The + // value chosen is the length of time between data uploads. For instance, if you + // select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to + // the source bucket once every 5 minutes. This frequency also determines how often // Amazon Lookout for Equipment starts a scheduled inference on your data. In this // example, it starts once every 5 minutes. DataUploadFrequency types.DataUploadFrequency diff --git a/service/lookoutequipment/types/enums.go b/service/lookoutequipment/types/enums.go index 12b8205da87..b7f6805fc9b 100644 --- a/service/lookoutequipment/types/enums.go +++ b/service/lookoutequipment/types/enums.go @@ -55,9 +55,9 @@ const ( InferenceExecutionStatusFailed InferenceExecutionStatus = "FAILED" ) -// Values returns all known values for InferenceExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InferenceExecutionStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceExecutionStatus) Values() []InferenceExecutionStatus { return []InferenceExecutionStatus{ "IN_PROGRESS", @@ -76,9 +76,9 @@ const ( InferenceSchedulerStatusStopped InferenceSchedulerStatus = "STOPPED" ) -// Values returns all known values for InferenceSchedulerStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InferenceSchedulerStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceSchedulerStatus) Values() []InferenceSchedulerStatus { return []InferenceSchedulerStatus{ "PENDING", @@ -136,8 +136,8 @@ const ( LatestInferenceResultNormal LatestInferenceResult = "NORMAL" ) -// Values returns all known values for LatestInferenceResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LatestInferenceResult. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LatestInferenceResult) Values() []LatestInferenceResult { return []LatestInferenceResult{ @@ -175,9 +175,9 @@ const ( MonotonicityStatic Monotonicity = "STATIC" ) -// Values returns all known values for Monotonicity. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Monotonicity. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Monotonicity) Values() []Monotonicity { return []Monotonicity{ "DECREASING", diff --git a/service/lookoutequipment/types/errors.go b/service/lookoutequipment/types/errors.go index c3adccf91fd..61f94440cb8 100644 --- a/service/lookoutequipment/types/errors.go +++ b/service/lookoutequipment/types/errors.go @@ -88,8 +88,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The resource requested could not be found. Verify the resource ID and retry your -// request. +// The resource requested could not be found. Verify the resource ID and retry +// your request. type ResourceNotFoundException struct { Message *string @@ -167,8 +167,8 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The input fails to satisfy constraints specified by Amazon Lookout for Equipment -// or a related AWS service that's being utilized. +// The input fails to satisfy constraints specified by Amazon Lookout for +// Equipment or a related AWS service that's being utilized. type ValidationException struct { Message *string diff --git a/service/lookoutequipment/types/types.go b/service/lookoutequipment/types/types.go index 63464ecda08..94aa9210449 100644 --- a/service/lookoutequipment/types/types.go +++ b/service/lookoutequipment/types/types.go @@ -60,11 +60,11 @@ type DataIngestionJobSummary struct { noSmithyDocumentSerde } -// The configuration is the TargetSamplingRate, which is the sampling rate of the +// The configuration is the TargetSamplingRate , which is the sampling rate of the // data after post processing by Amazon Lookout for Equipment. For example, if you // provide data that has been collected at a 1 second level and you want the system // to resample the data at a 1 minute rate before training, the TargetSamplingRate -// is 1 minute. When providing a value for the TargetSamplingRate, you must attach +// is 1 minute. When providing a value for the TargetSamplingRate , you must attach // the prefix "PT" to the rate you want. The value for a 1 second rate is therefore // PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate // is PT1H @@ -74,7 +74,7 @@ type DataPreProcessingConfiguration struct { // Equipment. For example, if you provide data that has been collected at a 1 // second level and you want the system to resample the data at a 1 minute rate // before training, the TargetSamplingRate is 1 minute. When providing a value for - // the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. + // the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. // The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate // is PT15M, and the value for a 1 hour rate is PT1H TargetSamplingRate TargetSamplingRate @@ -100,14 +100,14 @@ type DataQualitySummary struct { // This member is required. InsufficientSensorData *InsufficientSensorData - // Parameter that gives information about data that is invalid over all the sensors - // in the input data. + // Parameter that gives information about data that is invalid over all the + // sensors in the input data. // // This member is required. InvalidSensorData *InvalidSensorData - // Parameter that gives information about data that is missing over all the sensors - // in the input data. + // Parameter that gives information about data that is missing over all the + // sensors in the input data. // // This member is required. MissingSensorData *MissingSensorData @@ -161,8 +161,8 @@ type DuplicateTimestamps struct { noSmithyDocumentSerde } -// Contains information about the specific inference event, including start and end -// time, diagnostics information, event duration and so on. +// Contains information about the specific inference event, including start and +// end time, diagnostics information, event duration and so on. type InferenceEventSummary struct { // An array which specifies the names and values of all sensors contributing to an @@ -188,8 +188,9 @@ type InferenceEventSummary struct { noSmithyDocumentSerde } -// Contains information about the specific inference execution, including input and -// output data configuration, inference scheduling information, status, and so on. +// Contains information about the specific inference execution, including input +// and output data configuration, inference scheduling information, status, and so +// on. type InferenceExecutionSummary struct { // @@ -344,8 +345,8 @@ type InferenceSchedulerSummary struct { // The name of the inference scheduler. InferenceSchedulerName *string - // Indicates whether the latest execution for the inference scheduler was Anomalous - // (anomalous events found) or Normal (no anomalous events found). + // Indicates whether the latest execution for the inference scheduler was + // Anomalous (anomalous events found) or Normal (no anomalous events found). LatestInferenceResult LatestInferenceResult // The Amazon Resource Name (ARN) of the ML model used by the inference scheduler. @@ -394,8 +395,8 @@ type IngestionInputConfiguration struct { noSmithyDocumentSerde } -// Specifies S3 configuration information for the input data for the data ingestion -// job. +// Specifies S3 configuration information for the input data for the data +// ingestion job. type IngestionS3InputConfiguration struct { // The name of the S3 bucket used for the input data for the data ingestion. @@ -403,9 +404,9 @@ type IngestionS3InputConfiguration struct { // This member is required. Bucket *string - // Pattern for matching the Amazon S3 files which will be used for ingestion. If no - // KeyPattern is provided, we will use the default hierarchy file structure, which - // is same as KeyPattern {prefix}/{component_name}/* + // Pattern for matching the Amazon S3 files which will be used for ingestion. If + // no KeyPattern is provided, we will use the default hierarchy file structure, + // which is same as KeyPattern {prefix}/{component_name}/* KeyPattern *string // The prefix for the S3 location being used for the input data for the data @@ -482,8 +483,8 @@ type LabelsInputConfiguration struct { noSmithyDocumentSerde } -// The location information (prefix and bucket name) for the s3 location being used -// for label data. +// The location information (prefix and bucket name) for the s3 location being +// used for label data. type LabelsS3InputConfiguration struct { // The name of the S3 bucket holding the label data. @@ -509,9 +510,9 @@ type LabelSummary struct { // Indicates that a label pertains to a particular piece of equipment. Equipment *string - // Indicates the type of anomaly associated with the label. Data in this field will - // be retained for service usage. Follow best practices for the security of your - // data. + // Indicates the type of anomaly associated with the label. Data in this field + // will be retained for service usage. Follow best practices for the security of + // your data. FaultCode *string // The ARN of the label group. @@ -680,16 +681,16 @@ type SensorStatisticsSummary struct { // with the sensor that the statistics belong to. InvalidDateEntries *CountPercent - // Parameter that describes the total number of, and percentage of, values that are - // invalid for the sensor that the statistics belong to. + // Parameter that describes the total number of, and percentage of, values that + // are invalid for the sensor that the statistics belong to. InvalidValues *CountPercent // Parameter that describes potential risk about whether data associated with the // sensor contains one or more large gaps between consecutive timestamps. LargeTimestampGaps *LargeTimestampGaps - // Parameter that describes the total number of, and percentage of, values that are - // missing for the sensor that the statistics belong to. + // Parameter that describes the total number of, and percentage of, values that + // are missing for the sensor that the statistics belong to. MissingValues *CountPercent // Parameter that describes potential risk about whether data associated with the diff --git a/service/lookoutmetrics/api_client.go b/service/lookoutmetrics/api_client.go index bdc9b7727c1..173189b200e 100644 --- a/service/lookoutmetrics/api_client.go +++ b/service/lookoutmetrics/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lookoutmetrics/api_op_CreateAlert.go b/service/lookoutmetrics/api_op_CreateAlert.go index b61b89c4a1c..27fbaca147c 100644 --- a/service/lookoutmetrics/api_op_CreateAlert.go +++ b/service/lookoutmetrics/api_op_CreateAlert.go @@ -54,9 +54,8 @@ type CreateAlertInput struct { // An integer from 0 to 100 specifying the alert sensitivity threshold. AlertSensitivityThreshold int32 - // A list of tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to - // apply to the alert. + // A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // to apply to the alert. Tags map[string]string noSmithyDocumentSerde diff --git a/service/lookoutmetrics/api_op_CreateAnomalyDetector.go b/service/lookoutmetrics/api_op_CreateAnomalyDetector.go index 5694d344c7c..49225fa101b 100644 --- a/service/lookoutmetrics/api_op_CreateAnomalyDetector.go +++ b/service/lookoutmetrics/api_op_CreateAnomalyDetector.go @@ -45,9 +45,8 @@ type CreateAnomalyDetectorInput struct { // The ARN of the KMS key to use to encrypt your data. KmsKeyArn *string - // A list of tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to - // apply to the anomaly detector. + // A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // to apply to the anomaly detector. Tags map[string]string noSmithyDocumentSerde diff --git a/service/lookoutmetrics/api_op_CreateMetricSet.go b/service/lookoutmetrics/api_op_CreateMetricSet.go index 38887a195e1..401fe3a46c1 100644 --- a/service/lookoutmetrics/api_op_CreateMetricSet.go +++ b/service/lookoutmetrics/api_op_CreateMetricSet.go @@ -66,9 +66,8 @@ type CreateMetricSetInput struct { // datasources. Offset *int32 - // A list of tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to - // apply to the dataset. + // A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // to apply to the dataset. Tags map[string]string // Contains information about the column used for tracking time in your source diff --git a/service/lookoutmetrics/api_op_ListAlerts.go b/service/lookoutmetrics/api_op_ListAlerts.go index eb78811b639..c054aeb7d55 100644 --- a/service/lookoutmetrics/api_op_ListAlerts.go +++ b/service/lookoutmetrics/api_op_ListAlerts.go @@ -40,7 +40,7 @@ type ListAlertsInput struct { MaxResults *int32 // If the result of the previous request is truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/lookoutmetrics/api_op_ListAnomalyDetectors.go b/service/lookoutmetrics/api_op_ListAnomalyDetectors.go index e85ab1e6701..cc4902a710e 100644 --- a/service/lookoutmetrics/api_op_ListAnomalyDetectors.go +++ b/service/lookoutmetrics/api_op_ListAnomalyDetectors.go @@ -37,7 +37,7 @@ type ListAnomalyDetectorsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/lookoutmetrics/api_op_ListAnomalyGroupRelatedMetrics.go b/service/lookoutmetrics/api_op_ListAnomalyGroupRelatedMetrics.go index 22534237d7d..4549adc37c1 100644 --- a/service/lookoutmetrics/api_op_ListAnomalyGroupRelatedMetrics.go +++ b/service/lookoutmetrics/api_op_ListAnomalyGroupRelatedMetrics.go @@ -48,8 +48,8 @@ type ListAnomalyGroupRelatedMetricsInput struct { // the next page of results. NextToken *string - // Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects - // (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group. + // Filter for potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ) or downstream + // effects ( EFFECT_OF_INPUT_ANOMALY_GROUP ) of the anomaly group. RelationshipTypeFilter types.RelationshipType noSmithyDocumentSerde @@ -57,8 +57,8 @@ type ListAnomalyGroupRelatedMetricsInput struct { type ListAnomalyGroupRelatedMetricsOutput struct { - // Aggregated details about the measures contributing to the anomaly group, and the - // measures potentially impacted by the anomaly group. + // Aggregated details about the measures contributing to the anomaly group, and + // the measures potentially impacted by the anomaly group. InterMetricImpactList []types.InterMetricImpactDetails // The pagination token that's included if more results are available. diff --git a/service/lookoutmetrics/api_op_ListMetricSets.go b/service/lookoutmetrics/api_op_ListMetricSets.go index e23341e8cde..4db6fe27725 100644 --- a/service/lookoutmetrics/api_op_ListMetricSets.go +++ b/service/lookoutmetrics/api_op_ListMetricSets.go @@ -40,7 +40,7 @@ type ListMetricSetsInput struct { MaxResults *int32 // If the result of the previous request was truncated, the response includes a - // NextToken. To retrieve the next set of results, use the token in the next + // NextToken . To retrieve the next set of results, use the token in the next // request. Tokens expire after 24 hours. NextToken *string diff --git a/service/lookoutmetrics/api_op_ListTagsForResource.go b/service/lookoutmetrics/api_op_ListTagsForResource.go index 323ce7c8550..00fc948f667 100644 --- a/service/lookoutmetrics/api_op_ListTagsForResource.go +++ b/service/lookoutmetrics/api_op_ListTagsForResource.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of tags -// (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) for -// a detector, dataset, or alert. +// Gets a list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) +// for a detector, dataset, or alert. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/lookoutmetrics/api_op_TagResource.go b/service/lookoutmetrics/api_op_TagResource.go index 9ba01a8294f..74a9fec28fd 100644 --- a/service/lookoutmetrics/api_op_TagResource.go +++ b/service/lookoutmetrics/api_op_TagResource.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds tags -// (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to a -// detector, dataset, or alert. +// Adds tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) +// to a detector, dataset, or alert. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -35,8 +34,8 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // Tags to apply to the resource. Tag keys and values can contain letters, numbers, - // spaces, and the following symbols: _.:/=+@- + // Tags to apply to the resource. Tag keys and values can contain letters, + // numbers, spaces, and the following symbols: _.:/=+@- // // This member is required. Tags map[string]string diff --git a/service/lookoutmetrics/api_op_UntagResource.go b/service/lookoutmetrics/api_op_UntagResource.go index 2291c53811a..a431adcc305 100644 --- a/service/lookoutmetrics/api_op_UntagResource.go +++ b/service/lookoutmetrics/api_op_UntagResource.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags -// (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) from -// a detector, dataset, or alert. +// Removes tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) +// from a detector, dataset, or alert. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/lookoutmetrics/api_op_UpdateAnomalyDetector.go b/service/lookoutmetrics/api_op_UpdateAnomalyDetector.go index efb6dd3c5b1..a7711fffd57 100644 --- a/service/lookoutmetrics/api_op_UpdateAnomalyDetector.go +++ b/service/lookoutmetrics/api_op_UpdateAnomalyDetector.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a detector. After activation, you can only change a detector's ingestion -// delay and description. +// Updates a detector. After activation, you can only change a detector's +// ingestion delay and description. func (c *Client) UpdateAnomalyDetector(ctx context.Context, params *UpdateAnomalyDetectorInput, optFns ...func(*Options)) (*UpdateAnomalyDetectorOutput, error) { if params == nil { params = &UpdateAnomalyDetectorInput{} diff --git a/service/lookoutmetrics/doc.go b/service/lookoutmetrics/doc.go index 2a877c91eff..01c003ce057 100644 --- a/service/lookoutmetrics/doc.go +++ b/service/lookoutmetrics/doc.go @@ -3,7 +3,7 @@ // Package lookoutmetrics provides the API client, operations, and parameter types // for Amazon Lookout for Metrics. // -// This is the Amazon Lookout for Metrics API Reference. For an introduction to the -// service with tutorials for getting started, visit Amazon Lookout for Metrics -// Developer Guide (https://docs.aws.amazon.com/lookoutmetrics/latest/dev). +// This is the Amazon Lookout for Metrics API Reference. For an introduction to +// the service with tutorials for getting started, visit Amazon Lookout for +// Metrics Developer Guide (https://docs.aws.amazon.com/lookoutmetrics/latest/dev) . package lookoutmetrics diff --git a/service/lookoutmetrics/types/enums.go b/service/lookoutmetrics/types/enums.go index 79d0932be28..af8c4a0ac1a 100644 --- a/service/lookoutmetrics/types/enums.go +++ b/service/lookoutmetrics/types/enums.go @@ -46,9 +46,9 @@ const ( AlertTypeLambda AlertType = "LAMBDA" ) -// Values returns all known values for AlertType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AlertType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AlertType) Values() []AlertType { return []AlertType{ "SNS", @@ -119,8 +119,8 @@ const ( AnomalyDetectorStatusDeactivating AnomalyDetectorStatus = "DEACTIVATING" ) -// Values returns all known values for AnomalyDetectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AnomalyDetectorStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AnomalyDetectorStatus) Values() []AnomalyDetectorStatus { return []AnomalyDetectorStatus{ @@ -192,8 +192,8 @@ const ( DataQualityMetricTypeBacktestInferenceDataEndTimeStamp DataQualityMetricType = "BACKTEST_INFERENCE_DATA_END_TIME_STAMP" ) -// Values returns all known values for DataQualityMetricType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DataQualityMetricType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DataQualityMetricType) Values() []DataQualityMetricType { return []DataQualityMetricType{ @@ -236,9 +236,9 @@ const ( FrequencyPt5m Frequency = "PT5M" ) -// Values returns all known values for Frequency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Frequency. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Frequency) Values() []Frequency { return []Frequency{ "P1D", @@ -293,9 +293,9 @@ const ( SnsFormatJson SnsFormat = "JSON" ) -// Values returns all known values for SnsFormat. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SnsFormat. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SnsFormat) Values() []SnsFormat { return []SnsFormat{ "LONG_TEXT", diff --git a/service/lookoutmetrics/types/types.go b/service/lookoutmetrics/types/types.go index 4f4949479e3..0133de4a5cc 100644 --- a/service/lookoutmetrics/types/types.go +++ b/service/lookoutmetrics/types/types.go @@ -99,8 +99,8 @@ type AlertSummary struct { // The time at which the alert was last modified. LastModificationTime *time.Time - // The alert's tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html). + // The alert's tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // . Tags map[string]string noSmithyDocumentSerde @@ -159,8 +159,8 @@ type AnomalyDetectorSummary struct { // The status of detector. Status AnomalyDetectorStatus - // The detector's tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html). + // The detector's tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // . Tags map[string]string noSmithyDocumentSerde @@ -536,8 +536,8 @@ type DimensionFilter struct { // The name of the dimension to filter on. DimensionName *string - // The list of values for the dimension specified in DimensionName that you want to - // filter on. + // The list of values for the dimension specified in DimensionName that you want + // to filter on. DimensionValueList []string noSmithyDocumentSerde @@ -612,23 +612,23 @@ type Filter struct { noSmithyDocumentSerde } -// Aggregated details about the measures contributing to the anomaly group, and the -// measures potentially impacted by the anomaly group. +// Aggregated details about the measures contributing to the anomaly group, and +// the measures potentially impacted by the anomaly group. type InterMetricImpactDetails struct { // The ID of the anomaly group. AnomalyGroupId *string - // For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution - // the measure has in causing the anomalies. + // For potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ), the percentage + // contribution the measure has in causing the anomalies. ContributionPercentage *float64 // The name of the measure. MetricName *string - // Whether a measure is a potential cause of the anomaly group - // (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the - // anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP). + // Whether a measure is a potential cause of the anomaly group ( + // CAUSE_OF_INPUT_ANOMALY_GROUP ), or whether the measure is impacted by the + // anomaly group ( EFFECT_OF_INPUT_ANOMALY_GROUP ). RelationshipType RelationshipType noSmithyDocumentSerde @@ -758,8 +758,8 @@ type MetricSetSummary struct { // The name of the dataset. MetricSetName *string - // The dataset's tags - // (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html). + // The dataset's tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) + // . Tags map[string]string noSmithyDocumentSerde @@ -909,17 +909,12 @@ type SNSConfiguration struct { SnsTopicArn *string // The format of the SNS topic. - // - // * JSON – Send JSON alerts with an anomaly ID and a - // link to the anomaly detail page. This is the default. - // - // * LONG_TEXT – Send - // human-readable alerts with information about the impacted timeseries and a link - // to the anomaly detail page. We recommend this for email. - // - // * SHORT_TEXT – Send - // human-readable alerts with a link to the anomaly detail page. We recommend this - // for SMS. + // - JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail + // page. This is the default. + // - LONG_TEXT – Send human-readable alerts with information about the impacted + // timeseries and a link to the anomaly detail page. We recommend this for email. + // - SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail + // page. We recommend this for SMS. SnsFormat SnsFormat noSmithyDocumentSerde @@ -996,7 +991,7 @@ type VpcConfiguration struct { SecurityGroupIdList []string // An array of strings containing the Amazon VPC subnet IDs (e.g., - // subnet-0bb1c79de3EXAMPLE. + // subnet-0bb1c79de3EXAMPLE . // // This member is required. SubnetIdList []string diff --git a/service/lookoutvision/api_client.go b/service/lookoutvision/api_client.go index a033d0b5b42..f7b14b1ff2c 100644 --- a/service/lookoutvision/api_client.go +++ b/service/lookoutvision/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/lookoutvision/api_op_CreateDataset.go b/service/lookoutvision/api_op_CreateDataset.go index faab9bcf693..3a12a449a62 100644 --- a/service/lookoutvision/api_op_CreateDataset.go +++ b/service/lookoutvision/api_op_CreateDataset.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can -// create a training or a test dataset from a valid dataset source (DatasetSource). -// If you want a single dataset project, specify train for the value of -// DatasetType. To have a project with separate training and test datasets, call -// CreateDataset twice. On the first call, specify train for the value of -// DatasetType. On the second call, specify test for the value of DatasetType. This -// operation requires permissions to perform the lookoutvision:CreateDataset -// operation. +// Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset +// can create a training or a test dataset from a valid dataset source ( +// DatasetSource ). If you want a single dataset project, specify train for the +// value of DatasetType . To have a project with separate training and test +// datasets, call CreateDataset twice. On the first call, specify train for the +// value of DatasetType . On the second call, specify test for the value of +// DatasetType . This operation requires permissions to perform the +// lookoutvision:CreateDataset operation. func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -50,24 +50,24 @@ type CreateDatasetInput struct { // ClientToken is an idempotency token that ensures a call to CreateDataset // completes only once. You choose the value to pass. For example, An issue might - // prevent you from getting a response from CreateDataset. In this case, safely + // prevent you from getting a response from CreateDataset . In this case, safely // retry your call to CreateDataset by using the same ClientToken parameter value. - // If you don't supply a value for ClientToken, the AWS SDK you are using inserts a - // value for you. This prevents retries after a network error from making multiple - // dataset creation requests. You'll need to provide your own value for other use - // cases. An error occurs if the other input parameters are not the same as in the - // first request. Using a different value for ClientToken is considered a new call - // to CreateDataset. An idempotency token is active for 8 hours. + // If you don't supply a value for ClientToken , the AWS SDK you are using inserts + // a value for you. This prevents retries after a network error from making + // multiple dataset creation requests. You'll need to provide your own value for + // other use cases. An error occurs if the other input parameters are not the same + // as in the first request. Using a different value for ClientToken is considered + // a new call to CreateDataset . An idempotency token is active for 8 hours. ClientToken *string // The location of the manifest file that Amazon Lookout for Vision uses to create - // the dataset. If you don't specify DatasetSource, an empty dataset is created and - // the operation synchronously returns. Later, you can add JSON Lines by calling - // UpdateDatasetEntries. If you specify a value for DataSource, the manifest at the - // S3 location is validated and used to create the dataset. The call to - // CreateDataset is asynchronous and might take a while to complete. To find out - // the current status, Check the value of Status returned in a call to - // DescribeDataset. + // the dataset. If you don't specify DatasetSource , an empty dataset is created + // and the operation synchronously returns. Later, you can add JSON Lines by + // calling UpdateDatasetEntries . If you specify a value for DataSource , the + // manifest at the S3 location is validated and used to create the dataset. The + // call to CreateDataset is asynchronous and might take a while to complete. To + // find out the current status, Check the value of Status returned in a call to + // DescribeDataset . DatasetSource *types.DatasetSource noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_CreateModel.go b/service/lookoutvision/api_op_CreateModel.go index c465827927f..7d75e8b84b6 100644 --- a/service/lookoutvision/api_op_CreateModel.go +++ b/service/lookoutvision/api_op_CreateModel.go @@ -12,15 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new version of a model within an an Amazon Lookout for Vision project. -// CreateModel is an asynchronous operation in which Amazon Lookout for Vision -// trains, tests, and evaluates a new version of a model. To get the current -// status, check the Status field returned in the response from DescribeModel. If +// Creates a new version of a model within an an Amazon Lookout for Vision +// project. CreateModel is an asynchronous operation in which Amazon Lookout for +// Vision trains, tests, and evaluates a new version of a model. To get the current +// status, check the Status field returned in the response from DescribeModel . If // the project has a single dataset, Amazon Lookout for Vision internally splits // the dataset to create a training and a test dataset. If the project has a // training and a test dataset, Lookout for Vision uses the respective datasets to // train and test the model. After training completes, the evaluation metrics are -// stored at the location specified in OutputConfig. This operation requires +// stored at the location specified in OutputConfig . This operation requires // permissions to perform the lookoutvision:CreateModel operation. If you want to // tag your model, you also require permission to the lookoutvision:TagResource // operation. @@ -51,16 +51,16 @@ type CreateModelInput struct { // This member is required. ProjectName *string - // ClientToken is an idempotency token that ensures a call to CreateModel completes - // only once. You choose the value to pass. For example, An issue might prevent you - // from getting a response from CreateModel. In this case, safely retry your call - // to CreateModel by using the same ClientToken parameter value. If you don't - // supply a value for ClientToken, the AWS SDK you are using inserts a value for - // you. This prevents retries after a network error from starting multiple training - // jobs. You'll need to provide your own value for other use cases. An error occurs - // if the other input parameters are not the same as in the first request. Using a - // different value for ClientToken is considered a new call to CreateModel. An - // idempotency token is active for 8 hours. + // ClientToken is an idempotency token that ensures a call to CreateModel + // completes only once. You choose the value to pass. For example, An issue might + // prevent you from getting a response from CreateModel . In this case, safely + // retry your call to CreateModel by using the same ClientToken parameter value. + // If you don't supply a value for ClientToken , the AWS SDK you are using inserts + // a value for you. This prevents retries after a network error from starting + // multiple training jobs. You'll need to provide your own value for other use + // cases. An error occurs if the other input parameters are not the same as in the + // first request. Using a different value for ClientToken is considered a new call + // to CreateModel . An idempotency token is active for 8 hours. ClientToken *string // A description for the version of the model. @@ -80,7 +80,7 @@ type CreateModelInput struct { type CreateModelOutput struct { - // The response from a call to CreateModel. + // The response from a call to CreateModel . ModelMetadata *types.ModelMetadata // Metadata pertaining to the operation's result. diff --git a/service/lookoutvision/api_op_CreateProject.go b/service/lookoutvision/api_op_CreateProject.go index 6dff2948004..21a0ece1fb9 100644 --- a/service/lookoutvision/api_op_CreateProject.go +++ b/service/lookoutvision/api_op_CreateProject.go @@ -13,7 +13,7 @@ import ( ) // Creates an empty Amazon Lookout for Vision project. After you create the -// project, add a dataset by calling CreateDataset. This operation requires +// project, add a dataset by calling CreateDataset . This operation requires // permissions to perform the lookoutvision:CreateProject operation. func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error) { if params == nil { @@ -39,14 +39,14 @@ type CreateProjectInput struct { // ClientToken is an idempotency token that ensures a call to CreateProject // completes only once. You choose the value to pass. For example, An issue might - // prevent you from getting a response from CreateProject. In this case, safely + // prevent you from getting a response from CreateProject . In this case, safely // retry your call to CreateProject by using the same ClientToken parameter value. - // If you don't supply a value for ClientToken, the AWS SDK you are using inserts a - // value for you. This prevents retries after a network error from making multiple - // project creation requests. You'll need to provide your own value for other use - // cases. An error occurs if the other input parameters are not the same as in the - // first request. Using a different value for ClientToken is considered a new call - // to CreateProject. An idempotency token is active for 8 hours. + // If you don't supply a value for ClientToken , the AWS SDK you are using inserts + // a value for you. This prevents retries after a network error from making + // multiple project creation requests. You'll need to provide your own value for + // other use cases. An error occurs if the other input parameters are not the same + // as in the first request. Using a different value for ClientToken is considered + // a new call to CreateProject . An idempotency token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_DeleteDataset.go b/service/lookoutvision/api_op_DeleteDataset.go index 71937ff74f2..0dfe9197aa7 100644 --- a/service/lookoutvision/api_op_DeleteDataset.go +++ b/service/lookoutvision/api_op_DeleteDataset.go @@ -11,21 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing Amazon Lookout for Vision dataset. If your the project has a -// single dataset, you must create a new dataset before you can create a model. If -// you project has a training dataset and a test dataset consider the following. +// Deletes an existing Amazon Lookout for Vision dataset . If your the project has +// a single dataset, you must create a new dataset before you can create a model. +// If you project has a training dataset and a test dataset consider the following. // -// * -// If you delete the test dataset, your project reverts to a single dataset -// project. If you then train the model, Amazon Lookout for Vision internally -// splits the remaining dataset into a training and test dataset. +// - If you delete the test dataset, your project reverts to a single dataset +// project. If you then train the model, Amazon Lookout for Vision internally +// splits the remaining dataset into a training and test dataset. +// - If you delete the training dataset, you must create a training dataset +// before you can create a model. // -// * If you delete -// the training dataset, you must create a training dataset before you can create a -// model. -// -// This operation requires permissions to perform the -// lookoutvision:DeleteDataset operation. +// This operation requires permissions to perform the lookoutvision:DeleteDataset +// operation. func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} @@ -43,9 +40,9 @@ func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, type DeleteDatasetInput struct { - // The type of the dataset to delete. Specify train to delete the training dataset. - // Specify test to delete the test dataset. To delete the dataset in a single - // dataset project, specify train. + // The type of the dataset to delete. Specify train to delete the training + // dataset. Specify test to delete the test dataset. To delete the dataset in a + // single dataset project, specify train . // // This member is required. DatasetType *string @@ -57,14 +54,14 @@ type DeleteDatasetInput struct { // ClientToken is an idempotency token that ensures a call to DeleteDataset // completes only once. You choose the value to pass. For example, An issue might - // prevent you from getting a response from DeleteDataset. In this case, safely + // prevent you from getting a response from DeleteDataset . In this case, safely // retry your call to DeleteDataset by using the same ClientToken parameter value. - // If you don't supply a value for ClientToken, the AWS SDK you are using inserts a - // value for you. This prevents retries after a network error from making multiple - // deletetion requests. You'll need to provide your own value for other use cases. - // An error occurs if the other input parameters are not the same as in the first - // request. Using a different value for ClientToken is considered a new call to - // DeleteDataset. An idempotency token is active for 8 hours. + // If you don't supply a value for ClientToken , the AWS SDK you are using inserts + // a value for you. This prevents retries after a network error from making + // multiple deletetion requests. You'll need to provide your own value for other + // use cases. An error occurs if the other input parameters are not the same as in + // the first request. Using a different value for ClientToken is considered a new + // call to DeleteDataset . An idempotency token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_DeleteModel.go b/service/lookoutvision/api_op_DeleteModel.go index 493f807bd8d..c4ae6ce7674 100644 --- a/service/lookoutvision/api_op_DeleteModel.go +++ b/service/lookoutvision/api_op_DeleteModel.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Amazon Lookout for Vision model. You can't delete a running model. To -// stop a running model, use the StopModel operation. It might take a few seconds -// to delete a model. To determine if a model has been deleted, call ListModels and -// check if the version of the model (ModelVersion) is in the Models array. This -// operation requires permissions to perform the lookoutvision:DeleteModel -// operation. +// Deletes an Amazon Lookout for Vision model. You can't delete a running model. +// To stop a running model, use the StopModel operation. It might take a few +// seconds to delete a model. To determine if a model has been deleted, call +// ListModels and check if the version of the model ( ModelVersion ) is in the +// Models array. This operation requires permissions to perform the +// lookoutvision:DeleteModel operation. func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error) { if params == nil { params = &DeleteModelInput{} @@ -44,18 +44,18 @@ type DeleteModelInput struct { // This member is required. ProjectName *string - // ClientToken is an idempotency token that ensures a call to DeleteModel completes - // only once. You choose the value to pass. For example, an issue might prevent you - // from getting a response from DeleteModel. In this case, safely retry your call - // to DeleteModel by using the same ClientToken parameter value. If you don't - // supply a value for ClientToken, the AWS SDK you are using inserts a value for - // you. This prevents retries after a network error from making multiple model - // deletion requests. You'll need to provide your own value for other use cases. An - // error occurs if the other input parameters are not the same as in the first - // request. Using a different + // ClientToken is an idempotency token that ensures a call to DeleteModel + // completes only once. You choose the value to pass. For example, an issue might + // prevent you from getting a response from DeleteModel . In this case, safely + // retry your call to DeleteModel by using the same ClientToken parameter value. + // If you don't supply a value for ClientToken, the AWS SDK you are using inserts a + // value for you. This prevents retries after a network error from making multiple + // model deletion requests. You'll need to provide your own value for other use + // cases. An error occurs if the other input parameters are not the same as in the + // first request. Using a different // - // value for ClientToken is considered a new call to - // DeleteModel. An idempotency token is active for 8 hours. + // value for ClientToken is considered a new call to DeleteModel . An idempotency + // token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_DeleteProject.go b/service/lookoutvision/api_op_DeleteProject.go index 802bd3f7302..813f18b87cf 100644 --- a/service/lookoutvision/api_op_DeleteProject.go +++ b/service/lookoutvision/api_op_DeleteProject.go @@ -14,7 +14,7 @@ import ( // Deletes an Amazon Lookout for Vision project. To delete a project, you must // first delete each version of the model associated with the project. To delete a // model use the DeleteModel operation. You also have to delete the dataset(s) -// associated with the model. For more information, see DeleteDataset. The images +// associated with the model. For more information, see DeleteDataset . The images // referenced by the training and test datasets aren't deleted. This operation // requires permissions to perform the lookoutvision:DeleteProject operation. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { @@ -41,14 +41,14 @@ type DeleteProjectInput struct { // ClientToken is an idempotency token that ensures a call to DeleteProject // completes only once. You choose the value to pass. For example, An issue might - // prevent you from getting a response from DeleteProject. In this case, safely + // prevent you from getting a response from DeleteProject . In this case, safely // retry your call to DeleteProject by using the same ClientToken parameter value. - // If you don't supply a value for ClientToken, the AWS SDK you are using inserts a - // value for you. This prevents retries after a network error from making multiple - // project deletion requests. You'll need to provide your own value for other use - // cases. An error occurs if the other input parameters are not the same as in the - // first request. Using a different value for ClientToken is considered a new call - // to DeleteProject. An idempotency token is active for 8 hours. + // If you don't supply a value for ClientToken , the AWS SDK you are using inserts + // a value for you. This prevents retries after a network error from making + // multiple project deletion requests. You'll need to provide your own value for + // other use cases. An error occurs if the other input parameters are not the same + // as in the first request. Using a different value for ClientToken is considered + // a new call to DeleteProject . An idempotency token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_DescribeDataset.go b/service/lookoutvision/api_op_DescribeDataset.go index 192ea48218c..7750dd24074 100644 --- a/service/lookoutvision/api_op_DescribeDataset.go +++ b/service/lookoutvision/api_op_DescribeDataset.go @@ -31,8 +31,8 @@ func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInp type DescribeDatasetInput struct { // The type of the dataset to describe. Specify train to describe the training - // dataset. Specify test to describe the test dataset. If you have a single dataset - // project, specify train + // dataset. Specify test to describe the test dataset. If you have a single + // dataset project, specify train // // This member is required. DatasetType *string diff --git a/service/lookoutvision/api_op_DetectAnomalies.go b/service/lookoutvision/api_op_DetectAnomalies.go index bbe2f707a3d..6ec6e2ed4dd 100644 --- a/service/lookoutvision/api_op_DetectAnomalies.go +++ b/service/lookoutvision/api_op_DetectAnomalies.go @@ -16,9 +16,9 @@ import ( // includes a boolean prediction that the image contains one or more anomalies and // a confidence value for the prediction. If the model is an image segmentation // model, the response also includes segmentation information for each type of -// anomaly found in the image. Before calling DetectAnomalies, you must first start -// your model with the StartModel operation. You are charged for the amount of -// time, in minutes, that a model runs and for the number of anomaly detection +// anomaly found in the image. Before calling DetectAnomalies , you must first +// start your model with the StartModel operation. You are charged for the amount +// of time, in minutes, that a model runs and for the number of anomaly detection // units that your model uses. If you are not using a model, use the StopModel // operation to stop your model. For more information, see Detecting anomalies in // an image in the Amazon Lookout for Vision developer guide. This operation @@ -45,7 +45,7 @@ type DetectAnomaliesInput struct { // This member is required. Body io.Reader - // The type of the image passed in Body. Valid values are image/png (PNG format + // The type of the image passed in Body . Valid values are image/png (PNG format // images) and image/jpeg (JPG format images). // // This member is required. diff --git a/service/lookoutvision/api_op_ListDatasetEntries.go b/service/lookoutvision/api_op_ListDatasetEntries.go index 4d36009cf33..b1374ed285d 100644 --- a/service/lookoutvision/api_op_ListDatasetEntries.go +++ b/service/lookoutvision/api_op_ListDatasetEntries.go @@ -35,7 +35,7 @@ type ListDatasetEntriesInput struct { // The type of the dataset that you want to list. Specify train to list the // training dataset. Specify test to list the test dataset. If you have a single - // dataset project, specify train. + // dataset project, specify train . // // This member is required. DatasetType *string @@ -46,7 +46,7 @@ type ListDatasetEntriesInput struct { ProjectName *string // Only includes entries after the specified date in the response. For example, - // 2020-06-23T00:00:00. + // 2020-06-23T00:00:00 . AfterCreationDate *time.Time // Specify normal to include only normal images. Specify anomaly to only include @@ -55,10 +55,10 @@ type ListDatasetEntriesInput struct { AnomalyClass *string // Only includes entries before the specified date in the response. For example, - // 2020-06-23T00:00:00. + // 2020-06-23T00:00:00 . BeforeCreationDate *time.Time - // Specify true to include labeled entries, otherwise specify false. If you don't + // Specify true to include labeled entries, otherwise specify false . If you don't // specify a value, Lookout for Vision returns all entries. Labeled *bool diff --git a/service/lookoutvision/api_op_ListModelPackagingJobs.go b/service/lookoutvision/api_op_ListModelPackagingJobs.go index 00b54f154d1..2b6419dfa2b 100644 --- a/service/lookoutvision/api_op_ListModelPackagingJobs.go +++ b/service/lookoutvision/api_op_ListModelPackagingJobs.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the model packaging jobs created for an Amazon Lookout for Vision project. -// This operation requires permissions to perform the +// Lists the model packaging jobs created for an Amazon Lookout for Vision +// project. This operation requires permissions to perform the // lookoutvision:ListModelPackagingJobs operation. For more information, see Using // your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for // Vision Developer Guide. diff --git a/service/lookoutvision/api_op_ListModels.go b/service/lookoutvision/api_op_ListModels.go index 476604b9ab8..6c038b7e6c3 100644 --- a/service/lookoutvision/api_op_ListModels.go +++ b/service/lookoutvision/api_op_ListModels.go @@ -13,8 +13,8 @@ import ( ) // Lists the versions of a model in an Amazon Lookout for Vision project. The -// ListModels operation is eventually consistent. Recent calls to CreateModel might -// take a while to appear in the response from ListProjects. This operation +// ListModels operation is eventually consistent. Recent calls to CreateModel +// might take a while to appear in the response from ListProjects . This operation // requires permissions to perform the lookoutvision:ListModels operation. func (c *Client) ListModels(ctx context.Context, params *ListModelsInput, optFns ...func(*Options)) (*ListModelsOutput, error) { if params == nil { diff --git a/service/lookoutvision/api_op_ListProjects.go b/service/lookoutvision/api_op_ListProjects.go index 4685e13db6b..cfaadd12d36 100644 --- a/service/lookoutvision/api_op_ListProjects.go +++ b/service/lookoutvision/api_op_ListProjects.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Amazon Lookout for Vision projects in your AWS account that are in the -// AWS Region in which you call ListProjects. The ListProjects operation is +// Lists the Amazon Lookout for Vision projects in your AWS account that are in +// the AWS Region in which you call ListProjects . The ListProjects operation is // eventually consistent. Recent calls to CreateProject and DeleteProject might -// take a while to appear in the response from ListProjects. This operation +// take a while to appear in the response from ListProjects . This operation // requires permissions to perform the lookoutvision:ListProjects operation. func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error) { if params == nil { diff --git a/service/lookoutvision/api_op_StartModel.go b/service/lookoutvision/api_op_StartModel.go index 7f184a288b4..7063d1e1e64 100644 --- a/service/lookoutvision/api_op_StartModel.go +++ b/service/lookoutvision/api_op_StartModel.go @@ -14,10 +14,10 @@ import ( // Starts the running of the version of an Amazon Lookout for Vision model. // Starting a model takes a while to complete. To check the current state of the -// model, use DescribeModel. A model is ready to use when its status is HOSTED. +// model, use DescribeModel . A model is ready to use when its status is HOSTED . // Once the model is running, you can detect custom labels in new images by calling -// DetectAnomalies. You are charged for the amount of time that the model is -// running. To stop a running model, call StopModel. This operation requires +// DetectAnomalies . You are charged for the amount of time that the model is +// running. To stop a running model, call StopModel . This operation requires // permissions to perform the lookoutvision:StartModel operation. func (c *Client) StartModel(ctx context.Context, params *StartModelInput, optFns ...func(*Options)) (*StartModelOutput, error) { if params == nil { @@ -36,9 +36,10 @@ func (c *Client) StartModel(ctx context.Context, params *StartModelInput, optFns type StartModelInput struct { - // The minimum number of inference units to use. A single inference unit represents - // 1 hour of processing. Use a higher number to increase the TPS throughput of your - // model. You are charged for the number of inference units that you use. + // The minimum number of inference units to use. A single inference unit + // represents 1 hour of processing. Use a higher number to increase the TPS + // throughput of your model. You are charged for the number of inference units that + // you use. // // This member is required. MinInferenceUnits *int32 @@ -55,16 +56,16 @@ type StartModelInput struct { // ClientToken is an idempotency token that ensures a call to StartModel completes // only once. You choose the value to pass. For example, An issue might prevent you - // from getting a response from StartModel. In this case, safely retry your call to - // StartModel by using the same ClientToken parameter value. If you don't supply a - // value for ClientToken, the AWS SDK you are using inserts a value for you. This - // prevents retries after a network error from making multiple start requests. - // You'll need to provide your own value for other use cases. An error occurs if - // the other input parameters are not the same as in the first request. Using a - // different + // from getting a response from StartModel . In this case, safely retry your call + // to StartModel by using the same ClientToken parameter value. If you don't + // supply a value for ClientToken , the AWS SDK you are using inserts a value for + // you. This prevents retries after a network error from making multiple start + // requests. You'll need to provide your own value for other use cases. An error + // occurs if the other input parameters are not the same as in the first request. + // Using a different // - // value for ClientToken is considered a new call to StartModel. An - // idempotency token is active for 8 hours. + // value for ClientToken is considered a new call to StartModel . An idempotency + // token is active for 8 hours. ClientToken *string // The maximum number of inference units to use for auto-scaling the model. If you diff --git a/service/lookoutvision/api_op_StartModelPackagingJob.go b/service/lookoutvision/api_op_StartModelPackagingJob.go index c7f9c26a6f8..a0489676330 100644 --- a/service/lookoutvision/api_op_StartModelPackagingJob.go +++ b/service/lookoutvision/api_op_StartModelPackagingJob.go @@ -16,33 +16,21 @@ import ( // creates an AWS IoT Greengrass component for a Lookout for Vision model. You can // use the component to deploy your model to an edge device managed by Greengrass. // Use the DescribeModelPackagingJob API to determine the current status of the -// job. The model packaging job is complete if the value of Status is SUCCEEDED. To -// deploy the component to the target device, use the component name and component -// version with the AWS IoT Greengrass CreateDeployment -// (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html) +// job. The model packaging job is complete if the value of Status is SUCCEEDED . +// To deploy the component to the target device, use the component name and +// component version with the AWS IoT Greengrass CreateDeployment (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html) // API. This operation requires the following permissions: +// - lookoutvision:StartModelPackagingJob +// - s3:PutObject +// - s3:GetBucketLocation +// - kms:GenerateDataKey +// - greengrass:CreateComponentVersion +// - greengrass:DescribeComponent +// - (Optional) greengrass:TagResource . Only required if you want to tag the +// component. // -// * -// lookoutvision:StartModelPackagingJob -// -// * s3:PutObject -// -// * s3:GetBucketLocation -// -// * -// kms:GenerateDataKey -// -// * greengrass:CreateComponentVersion -// -// * -// greengrass:DescribeComponent -// -// * (Optional) greengrass:TagResource. Only required -// if you want to tag the component. -// -// For more information, see Using your Amazon -// Lookout for Vision model on an edge device in the Amazon Lookout for Vision -// Developer Guide. +// For more information, see Using your Amazon Lookout for Vision model on an edge +// device in the Amazon Lookout for Vision Developer Guide. func (c *Client) StartModelPackagingJob(ctx context.Context, params *StartModelPackagingJobInput, optFns ...func(*Options)) (*StartModelPackagingJobOutput, error) { if params == nil { params = &StartModelPackagingJobInput{} @@ -70,8 +58,8 @@ type StartModelPackagingJobInput struct { // This member is required. ModelVersion *string - // The name of the project which contains the version of the model that you want to - // package. + // The name of the project which contains the version of the model that you want + // to package. // // This member is required. ProjectName *string @@ -79,14 +67,14 @@ type StartModelPackagingJobInput struct { // ClientToken is an idempotency token that ensures a call to // StartModelPackagingJob completes only once. You choose the value to pass. For // example, An issue might prevent you from getting a response from - // StartModelPackagingJob. In this case, safely retry your call to + // StartModelPackagingJob . In this case, safely retry your call to // StartModelPackagingJob by using the same ClientToken parameter value. If you - // don't supply a value for ClientToken, the AWS SDK you are using inserts a value + // don't supply a value for ClientToken , the AWS SDK you are using inserts a value // for you. This prevents retries after a network error from making multiple // dataset creation requests. You'll need to provide your own value for other use // cases. An error occurs if the other input parameters are not the same as in the // first request. Using a different value for ClientToken is considered a new call - // to StartModelPackagingJob. An idempotency token is active for 8 hours. + // to StartModelPackagingJob . An idempotency token is active for 8 hours. ClientToken *string // A description for the model packaging job. diff --git a/service/lookoutvision/api_op_StopModel.go b/service/lookoutvision/api_op_StopModel.go index 60a12152e51..110b658fe1b 100644 --- a/service/lookoutvision/api_op_StopModel.go +++ b/service/lookoutvision/api_op_StopModel.go @@ -13,8 +13,8 @@ import ( ) // Stops the hosting of a running model. The operation might take a while to -// complete. To check the current status, call DescribeModel. After the model -// hosting stops, the Status of the model is TRAINED. This operation requires +// complete. To check the current status, call DescribeModel . After the model +// hosting stops, the Status of the model is TRAINED . This operation requires // permissions to perform the lookoutvision:StopModel operation. func (c *Client) StopModel(ctx context.Context, params *StopModelInput, optFns ...func(*Options)) (*StopModelOutput, error) { if params == nil { @@ -45,13 +45,13 @@ type StopModelInput struct { // ClientToken is an idempotency token that ensures a call to StopModel completes // only once. You choose the value to pass. For example, An issue might prevent you - // from getting a response from StopModel. In this case, safely retry your call to + // from getting a response from StopModel . In this case, safely retry your call to // StopModel by using the same ClientToken parameter value. If you don't supply a - // value for ClientToken, the AWS SDK you are using inserts a value for you. This + // value for ClientToken , the AWS SDK you are using inserts a value for you. This // prevents retries after a network error from making multiple stop requests. // You'll need to provide your own value for other use cases. An error occurs if // the other input parameters are not the same as in the first request. Using a - // different value for ClientToken is considered a new call to StopModel. An + // different value for ClientToken is considered a new call to StopModel . An // idempotency token is active for 8 hours. ClientToken *string diff --git a/service/lookoutvision/api_op_UpdateDatasetEntries.go b/service/lookoutvision/api_op_UpdateDatasetEntries.go index 7673f0c9e0e..276523bb057 100644 --- a/service/lookoutvision/api_op_UpdateDatasetEntries.go +++ b/service/lookoutvision/api_op_UpdateDatasetEntries.go @@ -12,18 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes -// information about an image used for training or testing an Amazon Lookout for -// Vision model. To update an existing JSON Line, use the source-ref field to -// identify the JSON Line. The JSON line that you supply replaces the existing JSON -// line. Any existing annotations that are not in the new JSON line are removed -// from the dataset. For more information, see Defining JSON lines for anomaly -// classification in the Amazon Lookout for Vision Developer Guide. The images you -// reference in the source-ref field of a JSON line, must be in the same S3 bucket -// as the existing images in the dataset. Updating a dataset might take a while to -// complete. To check the current status, call DescribeDataset and check the Status -// field in the response. This operation requires permissions to perform the -// lookoutvision:UpdateDatasetEntries operation. +// Adds or updates one or more JSON Line entries in a dataset. A JSON Line +// includes information about an image used for training or testing an Amazon +// Lookout for Vision model. To update an existing JSON Line, use the source-ref +// field to identify the JSON Line. The JSON line that you supply replaces the +// existing JSON line. Any existing annotations that are not in the new JSON line +// are removed from the dataset. For more information, see Defining JSON lines for +// anomaly classification in the Amazon Lookout for Vision Developer Guide. The +// images you reference in the source-ref field of a JSON line, must be in the +// same S3 bucket as the existing images in the dataset. Updating a dataset might +// take a while to complete. To check the current status, call DescribeDataset and +// check the Status field in the response. This operation requires permissions to +// perform the lookoutvision:UpdateDatasetEntries operation. func (c *Client) UpdateDatasetEntries(ctx context.Context, params *UpdateDatasetEntriesInput, optFns ...func(*Options)) (*UpdateDatasetEntriesOutput, error) { if params == nil { params = &UpdateDatasetEntriesInput{} @@ -48,7 +48,7 @@ type UpdateDatasetEntriesInput struct { // The type of the dataset that you want to update. Specify train to update the // training dataset. Specify test to update the test dataset. If you have a single - // dataset project, specify train. + // dataset project, specify train . // // This member is required. DatasetType *string @@ -60,14 +60,14 @@ type UpdateDatasetEntriesInput struct { // ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries // completes only once. You choose the value to pass. For example, An issue might - // prevent you from getting a response from UpdateDatasetEntries. In this case, + // prevent you from getting a response from UpdateDatasetEntries . In this case, // safely retry your call to UpdateDatasetEntries by using the same ClientToken - // parameter value. If you don't supply a value for ClientToken, the AWS SDK you + // parameter value. If you don't supply a value for ClientToken , the AWS SDK you // are using inserts a value for you. This prevents retries after a network error // from making multiple updates with the same dataset entries. You'll need to // provide your own value for other use cases. An error occurs if the other input // parameters are not the same as in the first request. Using a different value for - // ClientToken is considered a new call to UpdateDatasetEntries. An idempotency + // ClientToken is considered a new call to UpdateDatasetEntries . An idempotency // token is active for 8 hours. ClientToken *string diff --git a/service/lookoutvision/doc.go b/service/lookoutvision/doc.go index a043c9e2dd6..913a8af6410 100644 --- a/service/lookoutvision/doc.go +++ b/service/lookoutvision/doc.go @@ -3,8 +3,8 @@ // Package lookoutvision provides the API client, operations, and parameter types // for Amazon Lookout for Vision. // -// This is the Amazon Lookout for Vision API Reference. It provides descriptions of -// actions, data types, common parameters, and common errors. Amazon Lookout for +// This is the Amazon Lookout for Vision API Reference. It provides descriptions +// of actions, data types, common parameters, and common errors. Amazon Lookout for // Vision enables you to find visual defects in industrial products, accurately and // at scale. It uses computer vision to identify missing components in an // industrial product, damage to vehicles or structures, irregularities in diff --git a/service/lookoutvision/types/enums.go b/service/lookoutvision/types/enums.go index dcead9c2235..3920d0a9f9f 100644 --- a/service/lookoutvision/types/enums.go +++ b/service/lookoutvision/types/enums.go @@ -125,9 +125,9 @@ const ( ResourceTypeModelPackageJob ResourceType = "MODEL_PACKAGE_JOB" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "PROJECT", @@ -145,9 +145,9 @@ const ( TargetDeviceJetsonXavier TargetDevice = "jetson_xavier" ) -// Values returns all known values for TargetDevice. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetDevice. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetDevice) Values() []TargetDevice { return []TargetDevice{ "jetson_xavier", diff --git a/service/lookoutvision/types/errors.go b/service/lookoutvision/types/errors.go index d4d95d4a11e..811ed95270c 100644 --- a/service/lookoutvision/types/errors.go +++ b/service/lookoutvision/types/errors.go @@ -119,8 +119,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A service quota was exceeded the allowed limit. For more information, see Limits -// in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide. +// A service quota was exceeded the allowed limit. For more information, see +// Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer +// Guide. type ServiceQuotaExceededException struct { Message *string @@ -151,8 +152,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Lookout for Vision is temporarily unable to process the request. Try your -// call again. +// Amazon Lookout for Vision is temporarily unable to process the request. Try +// your call again. type ThrottlingException struct { Message *string diff --git a/service/lookoutvision/types/types.go b/service/lookoutvision/types/types.go index 08a23b981e1..45068e29caa 100644 --- a/service/lookoutvision/types/types.go +++ b/service/lookoutvision/types/types.go @@ -8,13 +8,13 @@ import ( ) // Information about an anomaly type found on an image by an image segmentation -// model. For more information, see DetectAnomalies. +// model. For more information, see DetectAnomalies . type Anomaly struct { // The name of an anomaly type found in an image. Name maps to an anomaly type in - // the training dataset, apart from the anomaly type background. The service + // the training dataset, apart from the anomaly type background . The service // automatically inserts the background anomaly type into the response from - // DetectAnomalies. + // DetectAnomalies . Name *string // Information about the pixel mask that covers an anomaly type. @@ -23,14 +23,14 @@ type Anomaly struct { noSmithyDocumentSerde } -// The description for a dataset. For more information, see DescribeDataset. +// The description for a dataset. For more information, see DescribeDataset . type DatasetDescription struct { // The Unix timestamp for the time and date that the dataset was created. CreationTimestamp *time.Time - // The type of the dataset. The value train represents a training dataset or single - // dataset project. The value test represents a test dataset. + // The type of the dataset. The value train represents a training dataset or + // single dataset project. The value test represents a test dataset. DatasetType *string // Statistics about the images in a dataset. @@ -80,7 +80,7 @@ type DatasetImageStats struct { } // Summary information for an Amazon Lookout for Vision dataset. For more -// information, see DescribeDataset and ProjectDescription. +// information, see DescribeDataset and ProjectDescription . type DatasetMetadata struct { // The Unix timestamp for the date and time that the dataset was created. @@ -98,8 +98,8 @@ type DatasetMetadata struct { noSmithyDocumentSerde } -// Information about the location of a manifest file that Amazon Lookout for Vision -// uses to to create a dataset. +// Information about the location of a manifest file that Amazon Lookout for +// Vision uses to to create a dataset. type DatasetSource struct { // Location information for the manifest file. @@ -108,11 +108,11 @@ type DatasetSource struct { noSmithyDocumentSerde } -// The prediction results from a call to DetectAnomalies. DetectAnomalyResult -// includes classification information for the prediction (IsAnomalous and -// Confidence). If the model you use is an image segementation model, -// DetectAnomalyResult also includes segmentation information (Anomalies and -// AnomalyMask). Classification information is calculated separately from +// The prediction results from a call to DetectAnomalies . DetectAnomalyResult +// includes classification information for the prediction ( IsAnomalous and +// Confidence ). If the model you use is an image segementation model, +// DetectAnomalyResult also includes segmentation information ( Anomalies and +// AnomalyMask ). Classification information is calculated separately from // segmentation information and you shouldn't assume a relationship between them. type DetectAnomalyResult struct { @@ -134,12 +134,12 @@ type DetectAnomalyResult struct { // Anomalies list. AnomalyMask []byte - // The confidence that Lookout for Vision has in the accuracy of the classification - // in IsAnomalous. + // The confidence that Lookout for Vision has in the accuracy of the + // classification in IsAnomalous . Confidence *float32 - // True if Amazon Lookout for Vision classifies the image as containing an anomaly, - // otherwise false. + // True if Amazon Lookout for Vision classifies the image as containing an + // anomaly, otherwise false. IsAnomalous bool // The source of the image that was analyzed. direct means that the images was @@ -150,9 +150,9 @@ type DetectAnomalyResult struct { } // Configuration information for the AWS IoT Greengrass component created in a -// model packaging job. For more information, see StartModelPackagingJob. You can't -// specify a component with the same ComponentName and Componentversion as an -// existing component with the same component name and component version. +// model packaging job. For more information, see StartModelPackagingJob . You +// can't specify a component with the same ComponentName and Componentversion as +// an existing component with the same component name and component version. type GreengrassConfiguration struct { // A name for the AWS IoT Greengrass component. @@ -165,17 +165,17 @@ type GreengrassConfiguration struct { // This member is required. S3OutputLocation *S3Location - // Additional compiler options for the Greengrass component. Currently, only NVIDIA - // Graphics Processing Units (GPU) and CPU accelerators are supported. If you - // specify TargetDevice, don't specify CompilerOptions. For more information, see - // Compiler options in the Amazon Lookout for Vision Developer Guide. + // Additional compiler options for the Greengrass component. Currently, only + // NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If + // you specify TargetDevice , don't specify CompilerOptions . For more information, + // see Compiler options in the Amazon Lookout for Vision Developer Guide. CompilerOptions *string // A description for the AWS IoT Greengrass component. ComponentDescription *string // A Version for the AWS IoT Greengrass component. If you don't provide a value, a - // default value of Model Version.0.0 is used. + // default value of Model Version.0.0 is used. ComponentVersion *string // A set of tags (key-value pairs) that you want to attach to the AWS IoT @@ -183,11 +183,11 @@ type GreengrassConfiguration struct { Tags []Tag // The target device for the model. Currently the only supported value is - // jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform. + // jetson_xavier . If you specify TargetDevice , you can't specify TargetPlatform . TargetDevice TargetDevice - // The target platform for the model. If you specify TargetPlatform, you can't - // specify TargetDevice. + // The target platform for the model. If you specify TargetPlatform , you can't + // specify TargetDevice . TargetPlatform *TargetPlatform noSmithyDocumentSerde @@ -249,8 +249,8 @@ type ModelDescription struct { // The unix timestamp for the date and time that the evaluation ended. EvaluationEndTimestamp *time.Time - // The S3 location where Amazon Lookout for Vision saves the manifest file that was - // used to test the trained model and generate the performance scores. + // The S3 location where Amazon Lookout for Vision saves the manifest file that + // was used to test the trained model and generate the performance scores. EvaluationManifest *OutputS3Object // The S3 location where Amazon Lookout for Vision saves the performance metrics. @@ -261,7 +261,7 @@ type ModelDescription struct { KmsKeyId *string // The maximum number of inference units Amazon Lookout for Vision uses to - // auto-scale the model. For more information, see StartModel. + // auto-scale the model. For more information, see StartModel . MaxInferenceUnits *int32 // The minimum number of inference units used by the model. For more information, @@ -304,8 +304,8 @@ type ModelMetadata struct { // The version of the model. ModelVersion *string - // Performance metrics for the model. Not available until training has successfully - // completed. + // Performance metrics for the model. Not available until training has + // successfully completed. Performance *ModelPerformance // The status of the model. @@ -318,7 +318,7 @@ type ModelMetadata struct { } // Configuration information for a Amazon Lookout for Vision model packaging job. -// For more information, see StartModelPackagingJob. +// For more information, see StartModelPackagingJob . type ModelPackagingConfiguration struct { // Configuration information for the AWS IoT Greengrass component in a model @@ -331,7 +331,7 @@ type ModelPackagingConfiguration struct { } // Information about a model packaging job. For more information, see -// DescribeModelPackagingJob. +// DescribeModelPackagingJob . type ModelPackagingDescription struct { // The Unix timestamp for the time and date that the model packaging job was @@ -356,7 +356,7 @@ type ModelPackagingDescription struct { ModelPackagingMethod *string // Information about the output of the model packaging job. For more information, - // see DescribeModelPackagingJob. + // see DescribeModelPackagingJob . ModelPackagingOutputDetails *ModelPackagingOutputDetails // The version of the model used in the model packaging job. @@ -376,7 +376,7 @@ type ModelPackagingDescription struct { } // Metadata for a model packaging job. For more information, see -// ListModelPackagingJobs. +// ListModelPackagingJobs . type ModelPackagingJobMetadata struct { // The Unix timestamp for the time and date that the model packaging job was @@ -464,7 +464,7 @@ type OutputS3Object struct { } // Information about the pixels in an anomaly mask. For more information, see -// Anomaly. PixelAnomaly is only returned by image segmentation models. +// Anomaly . PixelAnomaly is only returned by image segmentation models. type PixelAnomaly struct { // A hex color value for the mask that covers an anomaly type. Each anomaly type @@ -479,7 +479,7 @@ type PixelAnomaly struct { } // Describe an Amazon Lookout for Vision project. For more information, see -// DescribeProject. +// DescribeProject . type ProjectDescription struct { // The unix timestamp for the date and time that the project was created. @@ -530,8 +530,8 @@ type S3Location struct { noSmithyDocumentSerde } -// A key and value pair that is attached to the specified Amazon Lookout for Vision -// model. +// A key and value pair that is attached to the specified Amazon Lookout for +// Vision model. type Tag struct { // The key of the tag that is attached to the specified model. @@ -550,8 +550,8 @@ type Tag struct { // The platform on which a model runs on an AWS IoT Greengrass core device. type TargetPlatform struct { - // The target architecture for the model. The currently supported architectures are - // X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit + // The target architecture for the model. The currently supported architectures + // are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit // CPU). // // This member is required. @@ -565,17 +565,13 @@ type TargetPlatform struct { // The target accelerator for the model. Currently, Amazon Lookout for Vision only // supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you - // specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver, + // specify NVIDIA as an accelerator, you must also specify the gpu-code , trt-ver , // and cuda-ver compiler options. If you don't specify an accelerator, Lookout for // Vision uses the CPU for compilation and we highly recommend that you use the // GreengrassConfiguration$CompilerOptions field. For example, you can use the // following compiler options for CPU: - // - // * mcpu: CPU micro-architecture. For - // example, {'mcpu': 'skylake-avx512'} - // - // * mattr: CPU flags. For example, {'mattr': - // ['+neon', '+vfpv4']} + // - mcpu : CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'} + // - mattr : CPU flags. For example, {'mattr': ['+neon', '+vfpv4']} Accelerator TargetPlatformAccelerator noSmithyDocumentSerde diff --git a/service/m2/api_client.go b/service/m2/api_client.go index bee058d4180..e9bd3510e25 100644 --- a/service/m2/api_client.go +++ b/service/m2/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/m2/api_op_GetApplication.go b/service/m2/api_op_GetApplication.go index 6857d39d618..8cde5b92f41 100644 --- a/service/m2/api_op_GetApplication.go +++ b/service/m2/api_op_GetApplication.go @@ -92,8 +92,8 @@ type GetApplicationOutput struct { // runs for the first time. LastStartTime *time.Time - // The Amazon Resource Name (ARN) for the network load balancer listener created in - // your Amazon Web Services account. Amazon Web Services Mainframe Modernization + // The Amazon Resource Name (ARN) for the network load balancer listener created + // in your Amazon Web Services account. Amazon Web Services Mainframe Modernization // creates this listener for you the first time you deploy an application. ListenerArns []string @@ -105,10 +105,10 @@ type GetApplicationOutput struct { // account. LoadBalancerDnsName *string - // The list of log summaries. Each log summary includes the log type as well as the - // log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe - // Modernization pushes the application log to CloudWatch under the customer's - // account. + // The list of log summaries. Each log summary includes the log type as well as + // the log group identifier. These are CloudWatch logs. Amazon Web Services + // Mainframe Modernization pushes the application log to CloudWatch under the + // customer's account. LogGroups []types.LogGroupSummary // The reason for the reported status. diff --git a/service/m2/api_op_ListDataSets.go b/service/m2/api_op_ListDataSets.go index 84f9bd43531..56ed226028b 100644 --- a/service/m2/api_op_ListDataSets.go +++ b/service/m2/api_op_ListDataSets.go @@ -16,8 +16,8 @@ import ( // Mainframe Modernization, data sets are associated with applications deployed on // runtime environments. This is known as importing data sets. Currently, Amazon // Web Services Mainframe Modernization can import data sets into catalogs using -// CreateDataSetImportTask -// (https://docs.aws.amazon.com/m2/latest/APIReference/API_CreateDataSetImportTask.html). +// CreateDataSetImportTask (https://docs.aws.amazon.com/m2/latest/APIReference/API_CreateDataSetImportTask.html) +// . func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error) { if params == nil { params = &ListDataSetsInput{} diff --git a/service/m2/api_op_StartBatchJob.go b/service/m2/api_op_StartBatchJob.go index 829deeadaa7..cc9b5ae736d 100644 --- a/service/m2/api_op_StartBatchJob.go +++ b/service/m2/api_op_StartBatchJob.go @@ -42,8 +42,8 @@ type StartBatchJobInput struct { BatchJobIdentifier types.BatchJobIdentifier // The collection of batch job parameters. For details about limits for keys and - // values, see Coding variables in JCL - // (https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl). + // values, see Coding variables in JCL (https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl) + // . JobParams map[string]string noSmithyDocumentSerde diff --git a/service/m2/api_op_UpdateEnvironment.go b/service/m2/api_op_UpdateEnvironment.go index 63c01976a17..fe131c6fff9 100644 --- a/service/m2/api_op_UpdateEnvironment.go +++ b/service/m2/api_op_UpdateEnvironment.go @@ -37,7 +37,7 @@ type UpdateEnvironmentInput struct { // window. The default is false. Currently, Amazon Web Services Mainframe // Modernization accepts the engineVersion parameter only if // applyDuringMaintenanceWindow is true. If any parameter other than engineVersion - // is provided in UpdateEnvironmentRequest, it will fail if + // is provided in UpdateEnvironmentRequest , it will fail if // applyDuringMaintenanceWindow is set to true. ApplyDuringMaintenanceWindow bool diff --git a/service/m2/doc.go b/service/m2/doc.go index 32b9af789bc..c3984a62db3 100644 --- a/service/m2/doc.go +++ b/service/m2/doc.go @@ -3,10 +3,10 @@ // Package m2 provides the API client, operations, and parameter types for // AWSMainframeModernization. // -// Amazon Web Services Mainframe Modernization provides tools and resources to help -// you plan and implement migration and modernization from mainframes to Amazon Web -// Services managed runtime environments. It provides tools for analyzing existing -// mainframe applications, developing or updating mainframe applications using -// COBOL or PL/I, and implementing an automated pipeline for continuous integration -// and continuous delivery (CI/CD) of the applications. +// Amazon Web Services Mainframe Modernization provides tools and resources to +// help you plan and implement migration and modernization from mainframes to +// Amazon Web Services managed runtime environments. It provides tools for +// analyzing existing mainframe applications, developing or updating mainframe +// applications using COBOL or PL/I, and implementing an automated pipeline for +// continuous integration and continuous delivery (CI/CD) of the applications. package m2 diff --git a/service/m2/types/enums.go b/service/m2/types/enums.go index 8a4ade6add7..a800f8c4167 100644 --- a/service/m2/types/enums.go +++ b/service/m2/types/enums.go @@ -118,9 +118,9 @@ const ( BatchJobTypeJes3 BatchJobType = "JES3" ) -// Values returns all known values for BatchJobType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BatchJobType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BatchJobType) Values() []BatchJobType { return []BatchJobType{ "VSE", diff --git a/service/m2/types/types.go b/service/m2/types/types.go index b2ca582d448..574414181ff 100644 --- a/service/m2/types/types.go +++ b/service/m2/types/types.go @@ -206,8 +206,8 @@ type BatchJobIdentifierMemberFileBatchJobIdentifier struct { func (*BatchJobIdentifierMemberFileBatchJobIdentifier) isBatchJobIdentifier() {} -// A batch job identifier in which the batch job to run is identified by the script -// name. +// A batch job identifier in which the batch job to run is identified by the +// script name. type BatchJobIdentifierMemberScriptBatchJobIdentifier struct { Value ScriptBatchJobIdentifier @@ -661,8 +661,8 @@ type FsxStorageConfiguration struct { // set is one of a collection of successive, historically related, catalogued data // sets that together are known as a generation data group (GDG). Use this // structure when you want to import a GDG. For more information on GDG, see -// Generation data sets -// (https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets). +// Generation data sets (https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets) +// . type GdgAttributes struct { // The maximum number of generation data sets, up to 255, in a GDG. @@ -678,8 +678,8 @@ type GdgAttributes struct { // set is one of a collection of successive, historically related, catalogued data // sets that together are known as a generation data group (GDG). Use this // structure when you want to import a GDG. For more information on GDG, see -// Generation data sets -// (https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets). +// Generation data sets (https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets) +// . type GdgDetailAttributes struct { // The maximum number of generation data sets, up to 255, in a GDG. @@ -792,8 +792,8 @@ type ScriptBatchJobDefinition struct { noSmithyDocumentSerde } -// A batch job identifier in which the batch job to run is identified by the script -// name. +// A batch job identifier in which the batch job to run is identified by the +// script name. type ScriptBatchJobIdentifier struct { // The name of the script containing the batch job definition. @@ -883,8 +883,8 @@ type VsamDetailAttributes struct { // them as some applications will make use of them. AlternateKeys []AlternateKey - // If set to True, enforces loading the data set into cache before it’s used by the - // application. + // If set to True, enforces loading the data set into cache before it’s used by + // the application. CacheAtStartup *bool // Indicates whether indexes for this dataset are stored as compressed values. If diff --git a/service/machinelearning/api_client.go b/service/machinelearning/api_client.go index f7ce2dc9915..e2549251196 100644 --- a/service/machinelearning/api_client.go +++ b/service/machinelearning/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/machinelearning/api_op_AddTags.go b/service/machinelearning/api_op_AddTags.go index c64861cd0a5..20e78a23d5b 100644 --- a/service/machinelearning/api_op_AddTags.go +++ b/service/machinelearning/api_op_AddTags.go @@ -31,7 +31,7 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu type AddTagsInput struct { - // The ID of the ML object to tag. For example, exampleModelId. + // The ID of the ML object to tag. For example, exampleModelId . // // This member is required. ResourceId *string diff --git a/service/machinelearning/api_op_CreateBatchPrediction.go b/service/machinelearning/api_op_CreateBatchPrediction.go index 53f7793a246..6fc256fd70d 100644 --- a/service/machinelearning/api_op_CreateBatchPrediction.go +++ b/service/machinelearning/api_op_CreateBatchPrediction.go @@ -11,13 +11,13 @@ import ( ) // Generates predictions for a group of observations. The observations to process -// exist in one or more data files referenced by a DataSource. This operation -// creates a new BatchPrediction, and uses an MLModel and the data files referenced -// by the DataSource as information sources. CreateBatchPrediction is an -// asynchronous operation. In response to CreateBatchPrediction, Amazon Machine +// exist in one or more data files referenced by a DataSource . This operation +// creates a new BatchPrediction , and uses an MLModel and the data files +// referenced by the DataSource as information sources. CreateBatchPrediction is +// an asynchronous operation. In response to CreateBatchPrediction , Amazon Machine // Learning (Amazon ML) immediately returns and sets the BatchPrediction status to -// PENDING. After the BatchPrediction completes, Amazon ML sets the status to -// COMPLETED. You can poll for status updates by using the GetBatchPrediction +// PENDING . After the BatchPrediction completes, Amazon ML sets the status to +// COMPLETED . You can poll for status updates by using the GetBatchPrediction // operation and checking the Status parameter of the result. After the COMPLETED // status appears, the results are available in the location specified by the // OutputUri parameter. @@ -43,7 +43,7 @@ type CreateBatchPredictionInput struct { // This member is required. BatchPredictionDataSourceId *string - // A user-supplied ID that uniquely identifies the BatchPrediction. + // A user-supplied ID that uniquely identifies the BatchPrediction . // // This member is required. BatchPredictionId *string @@ -54,17 +54,18 @@ type CreateBatchPredictionInput struct { // This member is required. MLModelId *string - // The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory - // to store the batch prediction results. The following substrings are not allowed - // in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'. Amazon - // ML needs permissions to store and retrieve the logs on your behalf. For - // information about how to set permissions, see the Amazon Machine Learning - // Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg). + // The location of an Amazon Simple Storage Service (Amazon S3) bucket or + // directory to store the batch prediction results. The following substrings are + // not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', + // '/../'. Amazon ML needs permissions to store and retrieve the logs on your + // behalf. For information about how to set permissions, see the Amazon Machine + // Learning Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg) + // . // // This member is required. OutputUri *string - // A user-supplied name or description of the BatchPrediction. BatchPredictionName + // A user-supplied name or description of the BatchPrediction . BatchPredictionName // can only use the UTF-8 character set. BatchPredictionName *string @@ -77,7 +78,7 @@ type CreateBatchPredictionInput struct { // >GetBatchPrediction operation and checking the Status parameter of the result. type CreateBatchPredictionOutput struct { - // A user-supplied ID that uniquely identifies the BatchPrediction. This value is + // A user-supplied ID that uniquely identifies the BatchPrediction . This value is // identical to the value of the BatchPredictionId in the request. BatchPredictionId *string diff --git a/service/machinelearning/api_op_CreateDataSourceFromRDS.go b/service/machinelearning/api_op_CreateDataSourceFromRDS.go index c446cfe1326..a245c56c87d 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRDS.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRDS.go @@ -11,17 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a DataSource object from an Amazon Relational Database Service -// (http://aws.amazon.com/rds/) (Amazon RDS). A DataSource references data that can -// be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction -// operations. CreateDataSourceFromRDS is an asynchronous operation. In response to -// CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns -// and sets the DataSource status to PENDING. After the DataSource is created and -// ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in -// the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, -// CreateEvaluation, or CreateBatchPrediction operations. If Amazon ML cannot -// accept the input source, it sets the Status parameter to FAILED and includes an -// error message in the Message attribute of the GetDataSource operation response. +// Creates a DataSource object from an Amazon Relational Database Service (http://aws.amazon.com/rds/) +// (Amazon RDS). A DataSource references data that can be used to perform +// CreateMLModel , CreateEvaluation , or CreateBatchPrediction operations. +// CreateDataSourceFromRDS is an asynchronous operation. In response to +// CreateDataSourceFromRDS , Amazon Machine Learning (Amazon ML) immediately +// returns and sets the DataSource status to PENDING . After the DataSource is +// created and ready for use, Amazon ML sets the Status parameter to COMPLETED . +// DataSource in the COMPLETED or PENDING state can be used only to perform +// >CreateMLModel >, CreateEvaluation , or CreateBatchPrediction operations. If +// Amazon ML cannot accept the input source, it sets the Status parameter to FAILED +// and includes an error message in the Message attribute of the GetDataSource +// operation response. func (c *Client) CreateDataSourceFromRDS(ctx context.Context, params *CreateDataSourceFromRDSInput, optFns ...func(*Options)) (*CreateDataSourceFromRDSOutput, error) { if params == nil { params = &CreateDataSourceFromRDSInput{} @@ -39,95 +40,76 @@ func (c *Client) CreateDataSourceFromRDS(ctx context.Context, params *CreateData type CreateDataSourceFromRDSInput struct { - // A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon - // Resource Number (ARN) becomes the ID for a DataSource. + // A user-supplied ID that uniquely identifies the DataSource . Typically, an + // Amazon Resource Number (ARN) becomes the ID for a DataSource . // // This member is required. DataSourceId *string - // The data specification of an Amazon RDS DataSource: - // - // * DatabaseInformation - - // - // * - // DatabaseName - The name of the Amazon RDS database. - // - // * InstanceIdentifier - A - // unique identifier for the Amazon RDS database instance. - // - // * DatabaseCredentials - - // AWS Identity and Access Management (IAM) credentials that are used to connect to - // the Amazon RDS database. - // - // * ResourceRole - A role - // (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the - // copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more - // information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) - // for data pipelines. - // - // * ServiceRole - A role (DataPipelineDefaultRole) assumed by - // the AWS Data Pipeline service to monitor the progress of the copy task from - // Amazon RDS to Amazon S3. For more information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) - // for data pipelines. - // - // * SecurityInfo - The security information to use to access - // an RDS DB instance. You need to set up appropriate ingress rules for the - // security entity IDs provided to allow access to the Amazon RDS instance. Specify - // a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance. - // - // * - // SelectSqlQuery - A query that is used to retrieve the observation data for the - // Datasource. - // - // * S3StagingLocation - The Amazon S3 location for staging Amazon RDS - // data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this - // location. - // - // * DataSchemaUri - The Amazon S3 location of the DataSchema. - // - // * - // DataSchema - A JSON string representing the schema. This is not required if - // DataSchemaUri is specified. - // - // * DataRearrangement - A JSON string that represents - // the splitting and rearrangement requirements for the Datasource. Sample - - // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + // The data specification of an Amazon RDS DataSource : + // - DatabaseInformation - + // - DatabaseName - The name of the Amazon RDS database. + // - InstanceIdentifier - A unique identifier for the Amazon RDS database + // instance. + // - DatabaseCredentials - AWS Identity and Access Management (IAM) credentials + // that are used to connect to the Amazon RDS database. + // - ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 + // instance to carry out the copy task from Amazon RDS to Amazon Simple Storage + // Service (Amazon S3). For more information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // for data pipelines. + // - ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data + // Pipeline service to monitor the progress of the copy task from Amazon RDS to + // Amazon S3. For more information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // for data pipelines. + // - SecurityInfo - The security information to use to access an RDS DB + // instance. You need to set up appropriate ingress rules for the security entity + // IDs provided to allow access to the Amazon RDS instance. Specify a [ SubnetId + // , SecurityGroupIds ] pair for a VPC-based RDS DB instance. + // - SelectSqlQuery - A query that is used to retrieve the observation data for + // the Datasource . + // - S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The + // data retrieved from Amazon RDS using SelectSqlQuery is stored in this + // location. + // - DataSchemaUri - The Amazon S3 location of the DataSchema . + // - DataSchema - A JSON string representing the schema. This is not required if + // DataSchemaUri is specified. + // - DataRearrangement - A JSON string that represents the splitting and + // rearrangement requirements for the Datasource . Sample - + // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" // // This member is required. RDSData *types.RDSDataSpec // The role that Amazon ML assumes on behalf of the user to create and activate a - // data pipeline in the user's account and copy data using the SelectSqlQuery query - // from Amazon RDS to Amazon S3. + // data pipeline in the user's account and copy data using the SelectSqlQuery + // query from Amazon RDS to Amazon S3. // // This member is required. RoleARN *string - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics + // The compute statistics for a DataSource . The statistics are generated from the + // observation data referenced by a DataSource . Amazon ML uses the statistics // internally during MLModel training. This parameter must be set to true if the // DataSource needs to be used for MLModel training. ComputeStatistics bool - // A user-supplied name or description of the DataSource. + // A user-supplied name or description of the DataSource . DataSourceName *string noSmithyDocumentSerde } // Represents the output of a CreateDataSourceFromRDS operation, and is an -// acknowledgement that Amazon ML received the request. The -// CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by -// using the GetBatchPrediction operation and checking the Status parameter. You -// can inspect the Message when Status shows up as FAILED. You can also check the -// progress of the copy operation by going to the DataPipeline console and looking -// up the pipeline using the pipelineId from the describe call. +// acknowledgement that Amazon ML received the request. The CreateDataSourceFromRDS +// > operation is asynchronous. You can poll for updates by using the +// GetBatchPrediction operation and checking the Status parameter. You can inspect +// the Message when Status shows up as FAILED . You can also check the progress of +// the copy operation by going to the DataPipeline console and looking up the +// pipeline using the pipelineId from the describe call. type CreateDataSourceFromRDSOutput struct { - // A user-supplied ID that uniquely identifies the datasource. This value should be - // identical to the value of the DataSourceID in the request. + // A user-supplied ID that uniquely identifies the datasource. This value should + // be identical to the value of the DataSourceID in the request. DataSourceId *string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go index f98edb6d2ef..e063f10821f 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go @@ -12,31 +12,32 @@ import ( ) // Creates a DataSource from a database hosted on an Amazon Redshift cluster. A -// DataSource references data that can be used to perform either CreateMLModel, -// CreateEvaluation, or CreateBatchPrediction operations. +// DataSource references data that can be used to perform either CreateMLModel , +// CreateEvaluation , or CreateBatchPrediction operations. // CreateDataSourceFromRedshift is an asynchronous operation. In response to -// CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately -// returns and sets the DataSource status to PENDING. After the DataSource is -// created and ready for use, Amazon ML sets the Status parameter to COMPLETED. +// CreateDataSourceFromRedshift , Amazon Machine Learning (Amazon ML) immediately +// returns and sets the DataSource status to PENDING . After the DataSource is +// created and ready for use, Amazon ML sets the Status parameter to COMPLETED . // DataSource in COMPLETED or PENDING states can be used to perform only -// CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. If Amazon -// ML can't accept the input source, it sets the Status parameter to FAILED and -// includes an error message in the Message attribute of the GetDataSource +// CreateMLModel , CreateEvaluation , or CreateBatchPrediction operations. If +// Amazon ML can't accept the input source, it sets the Status parameter to FAILED +// and includes an error message in the Message attribute of the GetDataSource // operation response. The observations should be contained in the database hosted -// on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. -// Amazon ML executes an Unload command in Amazon Redshift to transfer the result -// set of the SelectSqlQuery query to S3StagingLocation. After the DataSource has -// been created, it's ready for use in evaluations and batch predictions. If you -// plan to use the DataSource to train an MLModel, the DataSource also requires a -// recipe. A recipe describes how each input variable will be used in training an -// MLModel. Will the variable be included or excluded from training? Will the -// variable be manipulated; for example, will it be combined with another variable -// or will it be split apart into word combinations? The recipe provides answers to -// these questions. You can't change an existing datasource, but you can copy and -// modify the settings from an existing Amazon Redshift datasource to create a new -// datasource. To do so, call GetDataSource for an existing datasource and copy the -// values to a CreateDataSource call. Change the settings that you want to change -// and make sure that all required fields have the appropriate values. +// on an Amazon Redshift cluster and should be specified by a SelectSqlQuery +// query. Amazon ML executes an Unload command in Amazon Redshift to transfer the +// result set of the SelectSqlQuery query to S3StagingLocation . After the +// DataSource has been created, it's ready for use in evaluations and batch +// predictions. If you plan to use the DataSource to train an MLModel , the +// DataSource also requires a recipe. A recipe describes how each input variable +// will be used in training an MLModel . Will the variable be included or excluded +// from training? Will the variable be manipulated; for example, will it be +// combined with another variable or will it be split apart into word combinations? +// The recipe provides answers to these questions. You can't change an existing +// datasource, but you can copy and modify the settings from an existing Amazon +// Redshift datasource to create a new datasource. To do so, call GetDataSource +// for an existing datasource and copy the values to a CreateDataSource call. +// Change the settings that you want to change and make sure that all required +// fields have the appropriate values. func (c *Client) CreateDataSourceFromRedshift(ctx context.Context, params *CreateDataSourceFromRedshiftInput, optFns ...func(*Options)) (*CreateDataSourceFromRedshiftOutput, error) { if params == nil { params = &CreateDataSourceFromRedshiftInput{} @@ -54,67 +55,49 @@ func (c *Client) CreateDataSourceFromRedshift(ctx context.Context, params *Creat type CreateDataSourceFromRedshiftInput struct { - // A user-supplied ID that uniquely identifies the DataSource. + // A user-supplied ID that uniquely identifies the DataSource . // // This member is required. DataSourceId *string - // The data specification of an Amazon Redshift DataSource: - // - // * DatabaseInformation - // - - // - // * DatabaseName - The name of the Amazon Redshift database. - // - // * - // ClusterIdentifier - The unique ID for the Amazon Redshift cluster. - // - // * - // DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials - // that are used to connect to the Amazon Redshift database. - // - // * SelectSqlQuery - - // The query that is used to retrieve the observation data for the Datasource. - // - // * - // S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for - // staging Amazon Redshift data. The data retrieved from Amazon Redshift using the - // SelectSqlQuery query is stored in this location. - // - // * DataSchemaUri - The Amazon - // S3 location of the DataSchema. - // - // * DataSchema - A JSON string representing the - // schema. This is not required if DataSchemaUri is specified. - // - // * DataRearrangement - // - A JSON string that represents the splitting and rearrangement requirements for - // the DataSource. Sample - - // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + // The data specification of an Amazon Redshift DataSource : + // - DatabaseInformation - + // - DatabaseName - The name of the Amazon Redshift database. + // - ClusterIdentifier - The unique ID for the Amazon Redshift cluster. + // - DatabaseCredentials - The AWS Identity and Access Management (IAM) + // credentials that are used to connect to the Amazon Redshift database. + // - SelectSqlQuery - The query that is used to retrieve the observation data + // for the Datasource . + // - S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location + // for staging Amazon Redshift data. The data retrieved from Amazon Redshift using + // the SelectSqlQuery query is stored in this location. + // - DataSchemaUri - The Amazon S3 location of the DataSchema . + // - DataSchema - A JSON string representing the schema. This is not required if + // DataSchemaUri is specified. + // - DataRearrangement - A JSON string that represents the splitting and + // rearrangement requirements for the DataSource . Sample - + // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" // // This member is required. DataSpec *types.RedshiftDataSpec - // A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on - // behalf of the user to create the following: - // - // * A security group to allow Amazon - // ML to execute the SelectSqlQuery query on an Amazon Redshift cluster - // - // * An - // Amazon S3 bucket policy to grant Amazon ML read/write permissions on the - // S3StagingLocation + // A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role + // on behalf of the user to create the following: + // - A security group to allow Amazon ML to execute the SelectSqlQuery query on + // an Amazon Redshift cluster + // - An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the + // S3StagingLocation // // This member is required. RoleARN *string - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics + // The compute statistics for a DataSource . The statistics are generated from the + // observation data referenced by a DataSource . Amazon ML uses the statistics // internally during MLModel training. This parameter must be set to true if the // DataSource needs to be used for MLModel training. ComputeStatistics bool - // A user-supplied name or description of the DataSource. + // A user-supplied name or description of the DataSource . DataSourceName *string noSmithyDocumentSerde @@ -126,8 +109,8 @@ type CreateDataSourceFromRedshiftInput struct { // by using the GetBatchPrediction operation and checking the Status parameter. type CreateDataSourceFromRedshiftOutput struct { - // A user-supplied ID that uniquely identifies the datasource. This value should be - // identical to the value of the DataSourceID in the request. + // A user-supplied ID that uniquely identifies the datasource. This value should + // be identical to the value of the DataSourceID in the request. DataSourceId *string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_CreateDataSourceFromS3.go b/service/machinelearning/api_op_CreateDataSourceFromS3.go index ab331f7469c..44a08f212d1 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromS3.go +++ b/service/machinelearning/api_op_CreateDataSourceFromS3.go @@ -12,25 +12,25 @@ import ( ) // Creates a DataSource object. A DataSource references data that can be used to -// perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations. +// perform CreateMLModel , CreateEvaluation , or CreateBatchPrediction operations. // CreateDataSourceFromS3 is an asynchronous operation. In response to -// CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns -// and sets the DataSource status to PENDING. After the DataSource has been created -// and is ready for use, Amazon ML sets the Status parameter to COMPLETED. +// CreateDataSourceFromS3 , Amazon Machine Learning (Amazon ML) immediately returns +// and sets the DataSource status to PENDING . After the DataSource has been +// created and is ready for use, Amazon ML sets the Status parameter to COMPLETED . // DataSource in the COMPLETED or PENDING state can be used to perform only -// CreateMLModel, CreateEvaluation or CreateBatchPrediction operations. If Amazon +// CreateMLModel , CreateEvaluation or CreateBatchPrediction operations. If Amazon // ML can't accept the input source, it sets the Status parameter to FAILED and // includes an error message in the Message attribute of the GetDataSource -// operation response. The observation data used in a DataSource should be ready to -// use; that is, it should have a consistent structure, and missing data values +// operation response. The observation data used in a DataSource should be ready +// to use; that is, it should have a consistent structure, and missing data values // should be kept to a minimum. The observation data must reside in one or more // .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with // a schema that describes the data items by name and type. The same schema must be -// used for all of the data files referenced by the DataSource. After the +// used for all of the data files referenced by the DataSource . After the // DataSource has been created, it's ready to use in evaluations and batch -// predictions. If you plan to use the DataSource to train an MLModel, the +// predictions. If you plan to use the DataSource to train an MLModel , the // DataSource also needs a recipe. A recipe describes how each input variable will -// be used in training an MLModel. Will the variable be included or excluded from +// be used in training an MLModel . Will the variable be included or excluded from // training? Will the variable be manipulated; for example, will it be combined // with another variable or will it be split apart into word combinations? The // recipe provides answers to these questions. @@ -51,37 +51,30 @@ func (c *Client) CreateDataSourceFromS3(ctx context.Context, params *CreateDataS type CreateDataSourceFromS3Input struct { - // A user-supplied identifier that uniquely identifies the DataSource. + // A user-supplied identifier that uniquely identifies the DataSource . // // This member is required. DataSourceId *string - // The data specification of a DataSource: - // - // * DataLocationS3 - The Amazon S3 - // location of the observation data. - // - // * DataSchemaLocationS3 - The Amazon S3 - // location of the DataSchema. - // - // * DataSchema - A JSON string representing the - // schema. This is not required if DataSchemaUri is specified. - // - // * DataRearrangement - // - A JSON string that represents the splitting and rearrangement requirements for - // the Datasource. Sample - - // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + // The data specification of a DataSource : + // - DataLocationS3 - The Amazon S3 location of the observation data. + // - DataSchemaLocationS3 - The Amazon S3 location of the DataSchema . + // - DataSchema - A JSON string representing the schema. This is not required if + // DataSchemaUri is specified. + // - DataRearrangement - A JSON string that represents the splitting and + // rearrangement requirements for the Datasource . Sample - + // "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" // // This member is required. DataSpec *types.S3DataSpec - // The compute statistics for a DataSource. The statistics are generated from the - // observation data referenced by a DataSource. Amazon ML uses the statistics + // The compute statistics for a DataSource . The statistics are generated from the + // observation data referenced by a DataSource . Amazon ML uses the statistics // internally during MLModel training. This parameter must be set to true if the // DataSource needs to be used for MLModel training. ComputeStatistics bool - // A user-supplied name or description of the DataSource. + // A user-supplied name or description of the DataSource . DataSourceName *string noSmithyDocumentSerde @@ -93,8 +86,8 @@ type CreateDataSourceFromS3Input struct { // GetBatchPrediction operation and checking the Status parameter. type CreateDataSourceFromS3Output struct { - // A user-supplied ID that uniquely identifies the DataSource. This value should be - // identical to the value of the DataSourceID in the request. + // A user-supplied ID that uniquely identifies the DataSource . This value should + // be identical to the value of the DataSourceID in the request. DataSourceId *string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_CreateEvaluation.go b/service/machinelearning/api_op_CreateEvaluation.go index db4e051bcaf..49ecfa805a9 100644 --- a/service/machinelearning/api_op_CreateEvaluation.go +++ b/service/machinelearning/api_op_CreateEvaluation.go @@ -10,18 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of -// observations associated to a DataSource. Like a DataSource for an MLModel, the -// DataSource for an Evaluation contains values for the Target Variable. The +// Creates a new Evaluation of an MLModel . An MLModel is evaluated on a set of +// observations associated to a DataSource . Like a DataSource for an MLModel , the +// DataSource for an Evaluation contains values for the Target Variable . The // Evaluation compares the predicted result for each observation to the actual // outcome and provides a summary so that you know how effective the MLModel // functions on the test data. Evaluation generates a relevant performance metric, // such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the -// corresponding MLModelType: BINARY, REGRESSION or MULTICLASS. CreateEvaluation is -// an asynchronous operation. In response to CreateEvaluation, Amazon Machine +// corresponding MLModelType : BINARY , REGRESSION or MULTICLASS . CreateEvaluation +// is an asynchronous operation. In response to CreateEvaluation , Amazon Machine // Learning (Amazon ML) immediately returns and sets the evaluation status to -// PENDING. After the Evaluation is created and ready for use, Amazon ML sets the -// status to COMPLETED. You can use the GetEvaluation operation to check progress +// PENDING . After the Evaluation is created and ready for use, Amazon ML sets the +// status to COMPLETED . You can use the GetEvaluation operation to check progress // of the evaluation during the creation operation. func (c *Client) CreateEvaluation(ctx context.Context, params *CreateEvaluationInput, optFns ...func(*Options)) (*CreateEvaluationOutput, error) { if params == nil { @@ -41,35 +41,35 @@ func (c *Client) CreateEvaluation(ctx context.Context, params *CreateEvaluationI type CreateEvaluationInput struct { // The ID of the DataSource for the evaluation. The schema of the DataSource must - // match the schema used to create the MLModel. + // match the schema used to create the MLModel . // // This member is required. EvaluationDataSourceId *string - // A user-supplied ID that uniquely identifies the Evaluation. + // A user-supplied ID that uniquely identifies the Evaluation . // // This member is required. EvaluationId *string // The ID of the MLModel to evaluate. The schema used in creating the MLModel must - // match the schema of the DataSource used in the Evaluation. + // match the schema of the DataSource used in the Evaluation . // // This member is required. MLModelId *string - // A user-supplied name or description of the Evaluation. + // A user-supplied name or description of the Evaluation . EvaluationName *string noSmithyDocumentSerde } -// Represents the output of a CreateEvaluation operation, and is an acknowledgement -// that Amazon ML received the request. CreateEvaluation operation is asynchronous. -// You can poll for status updates by using the GetEvcaluation operation and -// checking the Status parameter. +// Represents the output of a CreateEvaluation operation, and is an +// acknowledgement that Amazon ML received the request. CreateEvaluation operation +// is asynchronous. You can poll for status updates by using the GetEvcaluation +// operation and checking the Status parameter. type CreateEvaluationOutput struct { - // The user-supplied ID that uniquely identifies the Evaluation. This value should + // The user-supplied ID that uniquely identifies the Evaluation . This value should // be identical to the value of the EvaluationId in the request. EvaluationId *string diff --git a/service/machinelearning/api_op_CreateMLModel.go b/service/machinelearning/api_op_CreateMLModel.go index 503f2c7f84b..b2a2138509b 100644 --- a/service/machinelearning/api_op_CreateMLModel.go +++ b/service/machinelearning/api_op_CreateMLModel.go @@ -13,15 +13,15 @@ import ( // Creates a new MLModel using the DataSource and the recipe as information // sources. An MLModel is nearly immutable. Users can update only the MLModelName -// and the ScoreThreshold in an MLModel without creating a new MLModel. -// CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon -// Machine Learning (Amazon ML) immediately returns and sets the MLModel status to -// PENDING. After the MLModel has been created and ready is for use, Amazon ML sets -// the status to COMPLETED. You can use the GetMLModel operation to check the -// progress of the MLModel during the creation operation. CreateMLModel requires a -// DataSource with computed statistics, which can be created by setting -// ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or -// CreateDataSourceFromRedshift operations. +// and the ScoreThreshold in an MLModel without creating a new MLModel . +// CreateMLModel is an asynchronous operation. In response to CreateMLModel , +// Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel +// status to PENDING . After the MLModel has been created and ready is for use, +// Amazon ML sets the status to COMPLETED . You can use the GetMLModel operation +// to check the progress of the MLModel during the creation operation. +// CreateMLModel requires a DataSource with computed statistics, which can be +// created by setting ComputeStatistics to true in CreateDataSourceFromRDS , +// CreateDataSourceFromS3 , or CreateDataSourceFromRedshift operations. func (c *Client) CreateMLModel(ctx context.Context, params *CreateMLModelInput, optFns ...func(*Options)) (*CreateMLModelOutput, error) { if params == nil { params = &CreateMLModelInput{} @@ -39,25 +39,18 @@ func (c *Client) CreateMLModel(ctx context.Context, params *CreateMLModelInput, type CreateMLModelInput struct { - // A user-supplied ID that uniquely identifies the MLModel. + // A user-supplied ID that uniquely identifies the MLModel . // // This member is required. MLModelId *string // The category of supervised learning that this MLModel will address. Choose from // the following types: - // - // * Choose REGRESSION if the MLModel will be used to predict - // a numeric value. - // - // * Choose BINARY if the MLModel result has two possible - // values. - // - // * Choose MULTICLASS if the MLModel result has a limited number of - // values. - // - // For more information, see the Amazon Machine Learning Developer Guide - // (https://docs.aws.amazon.com/machine-learning/latest/dg). + // - Choose REGRESSION if the MLModel will be used to predict a numeric value. + // - Choose BINARY if the MLModel result has two possible values. + // - Choose MULTICLASS if the MLModel result has a limited number of values. + // For more information, see the Amazon Machine Learning Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg) + // . // // This member is required. MLModelType types.MLModelType @@ -67,46 +60,39 @@ type CreateMLModelInput struct { // This member is required. TrainingDataSourceId *string - // A user-supplied name or description of the MLModel. + // A user-supplied name or description of the MLModel . MLModelName *string - // A list of the training parameters in the MLModel. The list is implemented as a - // map of key-value pairs. The following is the current set of training - // parameters: - // - // * sgd.maxMLModelSizeInBytes - The maximum allowed size of the - // model. Depending on the input data, the size of the model might affect its - // performance. The value is an integer that ranges from 100000 to 2147483648. The - // default value is 33554432. - // - // * sgd.maxPasses - The number of times that the - // training process traverses the observations to build the MLModel. The value is - // an integer that ranges from 1 to 10000. The default value is 10. - // - // * - // sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the - // data improves a model's ability to find the optimal solution for a variety of - // data types. The valid values are auto and none. The default value is none. We - // strongly recommend that you shuffle your data. - // - // * sgd.l1RegularizationAmount - - // The coefficient regularization L1 norm. It controls overfitting the data by - // penalizing large coefficients. This tends to drive coefficients to zero, - // resulting in a sparse feature set. If you use this parameter, start by - // specifying a small value, such as 1.0E-08. The value is a double that ranges - // from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter - // can't be used when L2 is specified. Use this parameter sparingly. + // A list of the training parameters in the MLModel . The list is implemented as a + // map of key-value pairs. The following is the current set of training parameters: // - // * - // sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls - // overfitting the data by penalizing large coefficients. This tends to drive - // coefficients to small, nonzero values. If you use this parameter, start by - // specifying a small value, such as 1.0E-08. The value is a double that ranges - // from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter - // can't be used when L1 is specified. Use this parameter sparingly. + // - sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending + // on the input data, the size of the model might affect its performance. The value + // is an integer that ranges from 100000 to 2147483648 . The default value is + // 33554432 . + // - sgd.maxPasses - The number of times that the training process traverses the + // observations to build the MLModel . The value is an integer that ranges from 1 + // to 10000 . The default value is 10 . + // - sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling + // the data improves a model's ability to find the optimal solution for a variety + // of data types. The valid values are auto and none . The default value is none + // . We strongly recommend that you shuffle your data. + // - sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It + // controls overfitting the data by penalizing large coefficients. This tends to + // drive coefficients to zero, resulting in a sparse feature set. If you use this + // parameter, start by specifying a small value, such as 1.0E-08 . The value is a + // double that ranges from 0 to MAX_DOUBLE . The default is to not use L1 + // normalization. This parameter can't be used when L2 is specified. Use this + // parameter sparingly. + // - sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It + // controls overfitting the data by penalizing large coefficients. This tends to + // drive coefficients to small, nonzero values. If you use this parameter, start by + // specifying a small value, such as 1.0E-08 . The value is a double that ranges + // from 0 to MAX_DOUBLE . The default is to not use L2 normalization. This + // parameter can't be used when L1 is specified. Use this parameter sparingly. Parameters map[string]string - // The data recipe for creating the MLModel. You must specify either the recipe or + // The data recipe for creating the MLModel . You must specify either the recipe or // its URI. If you don't specify a recipe or its URI, Amazon ML creates a default. Recipe *string @@ -124,7 +110,7 @@ type CreateMLModelInput struct { // and checking the Status parameter. type CreateMLModelOutput struct { - // A user-supplied ID that uniquely identifies the MLModel. This value should be + // A user-supplied ID that uniquely identifies the MLModel . This value should be // identical to the value of the MLModelId in the request. MLModelId *string diff --git a/service/machinelearning/api_op_CreateRealtimeEndpoint.go b/service/machinelearning/api_op_CreateRealtimeEndpoint.go index dfcc315fd0b..838e8dfd13f 100644 --- a/service/machinelearning/api_op_CreateRealtimeEndpoint.go +++ b/service/machinelearning/api_op_CreateRealtimeEndpoint.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a real-time endpoint for the MLModel. The endpoint contains the URI of -// the MLModel; that is, the location to send real-time prediction requests for the -// specified MLModel. +// Creates a real-time endpoint for the MLModel . The endpoint contains the URI of +// the MLModel ; that is, the location to send real-time prediction requests for +// the specified MLModel . func (c *Client) CreateRealtimeEndpoint(ctx context.Context, params *CreateRealtimeEndpointInput, optFns ...func(*Options)) (*CreateRealtimeEndpointOutput, error) { if params == nil { params = &CreateRealtimeEndpointInput{} @@ -40,12 +40,12 @@ type CreateRealtimeEndpointInput struct { } // Represents the output of an CreateRealtimeEndpoint operation. The result -// contains the MLModelId and the endpoint information for the MLModel. Note: The -// endpoint information includes the URI of the MLModel; that is, the location to -// send online prediction requests for the specified MLModel. +// contains the MLModelId and the endpoint information for the MLModel . Note: The +// endpoint information includes the URI of the MLModel ; that is, the location to +// send online prediction requests for the specified MLModel . type CreateRealtimeEndpointOutput struct { - // A user-supplied ID that uniquely identifies the MLModel. This value should be + // A user-supplied ID that uniquely identifies the MLModel . This value should be // identical to the value of the MLModelId in the request. MLModelId *string diff --git a/service/machinelearning/api_op_DeleteBatchPrediction.go b/service/machinelearning/api_op_DeleteBatchPrediction.go index cc4d819cac1..d01c9383164 100644 --- a/service/machinelearning/api_op_DeleteBatchPrediction.go +++ b/service/machinelearning/api_op_DeleteBatchPrediction.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns the DELETED status to a BatchPrediction, rendering it unusable. After +// Assigns the DELETED status to a BatchPrediction , rendering it unusable. After // using the DeleteBatchPrediction operation, you can use the GetBatchPrediction // operation to verify that the status of the BatchPrediction changed to DELETED. // Caution: The result of the DeleteBatchPrediction operation is irreversible. @@ -31,7 +31,7 @@ func (c *Client) DeleteBatchPrediction(ctx context.Context, params *DeleteBatchP type DeleteBatchPredictionInput struct { - // A user-supplied ID that uniquely identifies the BatchPrediction. + // A user-supplied ID that uniquely identifies the BatchPrediction . // // This member is required. BatchPredictionId *string @@ -41,10 +41,10 @@ type DeleteBatchPredictionInput struct { // Represents the output of a DeleteBatchPrediction operation. You can use the // GetBatchPrediction operation and check the value of the Status parameter to see -// whether a BatchPrediction is marked as DELETED. +// whether a BatchPrediction is marked as DELETED . type DeleteBatchPredictionOutput struct { - // A user-supplied ID that uniquely identifies the BatchPrediction. This value + // A user-supplied ID that uniquely identifies the BatchPrediction . This value // should be identical to the value of the BatchPredictionID in the request. BatchPredictionId *string diff --git a/service/machinelearning/api_op_DeleteDataSource.go b/service/machinelearning/api_op_DeleteDataSource.go index 38b79f527e4..3be9c3c45f9 100644 --- a/service/machinelearning/api_op_DeleteDataSource.go +++ b/service/machinelearning/api_op_DeleteDataSource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns the DELETED status to a DataSource, rendering it unusable. After using +// Assigns the DELETED status to a DataSource , rendering it unusable. After using // the DeleteDataSource operation, you can use the GetDataSource operation to // verify that the status of the DataSource changed to DELETED. Caution: The // results of the DeleteDataSource operation are irreversible. @@ -31,7 +31,7 @@ func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceI type DeleteDataSourceInput struct { - // A user-supplied ID that uniquely identifies the DataSource. + // A user-supplied ID that uniquely identifies the DataSource . // // This member is required. DataSourceId *string @@ -42,8 +42,8 @@ type DeleteDataSourceInput struct { // Represents the output of a DeleteDataSource operation. type DeleteDataSourceOutput struct { - // A user-supplied ID that uniquely identifies the DataSource. This value should be - // identical to the value of the DataSourceID in the request. + // A user-supplied ID that uniquely identifies the DataSource . This value should + // be identical to the value of the DataSourceID in the request. DataSourceId *string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_DeleteEvaluation.go b/service/machinelearning/api_op_DeleteEvaluation.go index e940f858e00..79f9e3516b6 100644 --- a/service/machinelearning/api_op_DeleteEvaluation.go +++ b/service/machinelearning/api_op_DeleteEvaluation.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns the DELETED status to an Evaluation, rendering it unusable. After -// invoking the DeleteEvaluation operation, you can use the GetEvaluation operation -// to verify that the status of the Evaluation changed to DELETED. Caution: The -// results of the DeleteEvaluation operation are irreversible. +// Assigns the DELETED status to an Evaluation , rendering it unusable. After +// invoking the DeleteEvaluation operation, you can use the GetEvaluation +// operation to verify that the status of the Evaluation changed to DELETED . +// Caution: The results of the DeleteEvaluation operation are irreversible. func (c *Client) DeleteEvaluation(ctx context.Context, params *DeleteEvaluationInput, optFns ...func(*Options)) (*DeleteEvaluationOutput, error) { if params == nil { params = &DeleteEvaluationInput{} @@ -39,14 +39,14 @@ type DeleteEvaluationInput struct { noSmithyDocumentSerde } -// Represents the output of a DeleteEvaluation operation. The output indicates that -// Amazon Machine Learning (Amazon ML) received the request. You can use the +// Represents the output of a DeleteEvaluation operation. The output indicates +// that Amazon Machine Learning (Amazon ML) received the request. You can use the // GetEvaluation operation and check the value of the Status parameter to see -// whether an Evaluation is marked as DELETED. +// whether an Evaluation is marked as DELETED . type DeleteEvaluationOutput struct { - // A user-supplied ID that uniquely identifies the Evaluation. This value should be - // identical to the value of the EvaluationId in the request. + // A user-supplied ID that uniquely identifies the Evaluation . This value should + // be identical to the value of the EvaluationId in the request. EvaluationId *string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_DeleteMLModel.go b/service/machinelearning/api_op_DeleteMLModel.go index d4420f88734..d72ac4c2c41 100644 --- a/service/machinelearning/api_op_DeleteMLModel.go +++ b/service/machinelearning/api_op_DeleteMLModel.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns the DELETED status to an MLModel, rendering it unusable. After using the -// DeleteMLModel operation, you can use the GetMLModel operation to verify that the -// status of the MLModel changed to DELETED. Caution: The result of the +// Assigns the DELETED status to an MLModel , rendering it unusable. After using +// the DeleteMLModel operation, you can use the GetMLModel operation to verify +// that the status of the MLModel changed to DELETED. Caution: The result of the // DeleteMLModel operation is irreversible. func (c *Client) DeleteMLModel(ctx context.Context, params *DeleteMLModelInput, optFns ...func(*Options)) (*DeleteMLModelOutput, error) { if params == nil { @@ -31,7 +31,7 @@ func (c *Client) DeleteMLModel(ctx context.Context, params *DeleteMLModelInput, type DeleteMLModelInput struct { - // A user-supplied ID that uniquely identifies the MLModel. + // A user-supplied ID that uniquely identifies the MLModel . // // This member is required. MLModelId *string @@ -41,10 +41,10 @@ type DeleteMLModelInput struct { // Represents the output of a DeleteMLModel operation. You can use the GetMLModel // operation and check the value of the Status parameter to see whether an MLModel -// is marked as DELETED. +// is marked as DELETED . type DeleteMLModelOutput struct { - // A user-supplied ID that uniquely identifies the MLModel. This value should be + // A user-supplied ID that uniquely identifies the MLModel . This value should be // identical to the value of the MLModelID in the request. MLModelId *string diff --git a/service/machinelearning/api_op_DeleteRealtimeEndpoint.go b/service/machinelearning/api_op_DeleteRealtimeEndpoint.go index b0b2d5f593e..39112607a83 100644 --- a/service/machinelearning/api_op_DeleteRealtimeEndpoint.go +++ b/service/machinelearning/api_op_DeleteRealtimeEndpoint.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a real time endpoint of an MLModel. +// Deletes a real time endpoint of an MLModel . func (c *Client) DeleteRealtimeEndpoint(ctx context.Context, params *DeleteRealtimeEndpointInput, optFns ...func(*Options)) (*DeleteRealtimeEndpointOutput, error) { if params == nil { params = &DeleteRealtimeEndpointInput{} @@ -38,10 +38,10 @@ type DeleteRealtimeEndpointInput struct { } // Represents the output of an DeleteRealtimeEndpoint operation. The result -// contains the MLModelId and the endpoint information for the MLModel. +// contains the MLModelId and the endpoint information for the MLModel . type DeleteRealtimeEndpointOutput struct { - // A user-supplied ID that uniquely identifies the MLModel. This value should be + // A user-supplied ID that uniquely identifies the MLModel . This value should be // identical to the value of the MLModelId in the request. MLModelId *string diff --git a/service/machinelearning/api_op_DeleteTags.go b/service/machinelearning/api_op_DeleteTags.go index 1ddd5b1f7fa..327230c50f2 100644 --- a/service/machinelearning/api_op_DeleteTags.go +++ b/service/machinelearning/api_op_DeleteTags.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified tags associated with an ML object. After this operation is -// complete, you can't recover deleted tags. If you specify a tag that doesn't +// Deletes the specified tags associated with an ML object. After this operation +// is complete, you can't recover deleted tags. If you specify a tag that doesn't // exist, Amazon ML ignores it. func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error) { if params == nil { @@ -31,7 +31,7 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { - // The ID of the tagged ML object. For example, exampleModelId. + // The ID of the tagged ML object. For example, exampleModelId . // // This member is required. ResourceId *string diff --git a/service/machinelearning/api_op_DescribeBatchPredictions.go b/service/machinelearning/api_op_DescribeBatchPredictions.go index 0d5359362ae..03012cc3593 100644 --- a/service/machinelearning/api_op_DescribeBatchPredictions.go +++ b/service/machinelearning/api_op_DescribeBatchPredictions.go @@ -36,94 +36,75 @@ func (c *Client) DescribeBatchPredictions(ctx context.Context, params *DescribeB type DescribeBatchPredictionsInput struct { // The equal to operator. The BatchPrediction results will have FilterVariable - // values that exactly match the value specified with EQ. + // values that exactly match the value specified with EQ . EQ *string - // Use one of the following variables to filter a list of BatchPrediction: - // - // * - // CreatedAt - Sets the search criteria to the BatchPrediction creation date. - // - // * - // Status - Sets the search criteria to the BatchPrediction status. - // - // * Name - Sets - // the search criteria to the contents of the BatchPredictionName. - // - // * IAMUser - - // Sets the search criteria to the user account that invoked the BatchPrediction - // creation. - // - // * MLModelId - Sets the search criteria to the MLModel used in the - // BatchPrediction. - // - // * DataSourceId - Sets the search criteria to the DataSource - // used in the BatchPrediction. - // - // * DataURI - Sets the search criteria to the data - // file(s) used in the BatchPrediction. The URL can identify either a file or an - // Amazon Simple Storage Solution (Amazon S3) bucket or directory. + // Use one of the following variables to filter a list of BatchPrediction : + // - CreatedAt - Sets the search criteria to the BatchPrediction creation date. + // - Status - Sets the search criteria to the BatchPrediction status. + // - Name - Sets the search criteria to the contents of the BatchPrediction Name + // . + // - IAMUser - Sets the search criteria to the user account that invoked the + // BatchPrediction creation. + // - MLModelId - Sets the search criteria to the MLModel used in the + // BatchPrediction . + // - DataSourceId - Sets the search criteria to the DataSource used in the + // BatchPrediction . + // - DataURI - Sets the search criteria to the data file(s) used in the + // BatchPrediction . The URL can identify either a file or an Amazon Simple + // Storage Solution (Amazon S3) bucket or directory. FilterVariable types.BatchPredictionFilterVariable // The greater than or equal to operator. The BatchPrediction results will have // FilterVariable values that are greater than or equal to the value specified with - // GE. + // GE . GE *string // The greater than operator. The BatchPrediction results will have FilterVariable - // values that are greater than the value specified with GT. + // values that are greater than the value specified with GT . GT *string // The less than or equal to operator. The BatchPrediction results will have - // FilterVariable values that are less than or equal to the value specified with - // LE. + // FilterVariable values that are less than or equal to the value specified with LE + // . LE *string // The less than operator. The BatchPrediction results will have FilterVariable - // values that are less than the value specified with LT. + // values that are less than the value specified with LT . LT *string // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. + // acceptable values is 1 through 100 . The default value is 100 . Limit *int32 // The not equal to operator. The BatchPrediction results will have FilterVariable - // values not equal to the value specified with NE. + // values not equal to the value specified with NE . NE *string // An ID of the page in the paginated results. NextToken *string - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, a Batch Prediction operation could have the - // Name2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select - // Name for the FilterVariable and any of the following strings for the Prefix: - // - // * - // 2014-09 - // - // * 2014-09-09 - // - // * 2014-09-09-Holiday + // A string that is found at the beginning of a variable, such as Name or Id . For + // example, a Batch Prediction operation could have the Name + // 2014-09-09-HolidayGiftMailer . To search for this BatchPrediction , select Name + // for the FilterVariable and any of the following strings for the Prefix : + // - 2014-09 + // - 2014-09-09 + // - 2014-09-09-Holiday Prefix *string // A two-value parameter that determines the sequence of the resulting list of - // MLModels. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * dsc - - // Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. + // MLModel s. + // - asc - Arranges the list in ascending order (A-Z, 0-9). + // - dsc - Arranges the list in descending order (Z-A, 9-0). + // Results are sorted by FilterVariable . SortOrder types.SortOrder noSmithyDocumentSerde } // Represents the output of a DescribeBatchPredictions operation. The content is -// essentially a list of BatchPredictions. +// essentially a list of BatchPrediction s. type DescribeBatchPredictionsOutput struct { // The ID of the next page in the paginated results that indicates at least one @@ -211,7 +192,7 @@ var _ DescribeBatchPredictionsAPIClient = (*Client)(nil) // DescribeBatchPredictions type DescribeBatchPredictionsPaginatorOptions struct { // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. + // acceptable values is 1 through 100 . The default value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -306,8 +287,8 @@ type BatchPredictionAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BatchPredictionAvailableWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BatchPredictionAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/machinelearning/api_op_DescribeDataSources.go b/service/machinelearning/api_op_DescribeDataSources.go index 20009b30f13..441defcd048 100644 --- a/service/machinelearning/api_op_DescribeDataSources.go +++ b/service/machinelearning/api_op_DescribeDataSources.go @@ -35,90 +35,73 @@ func (c *Client) DescribeDataSources(ctx context.Context, params *DescribeDataSo type DescribeDataSourcesInput struct { // The equal to operator. The DataSource results will have FilterVariable values - // that exactly match the value specified with EQ. + // that exactly match the value specified with EQ . EQ *string - // Use one of the following variables to filter a list of DataSource: - // - // * CreatedAt - // - Sets the search criteria to DataSource creation dates. - // - // * Status - Sets the - // search criteria to DataSource statuses. - // - // * Name - Sets the search criteria to - // the contents of DataSourceName. - // - // * DataUri - Sets the search criteria to the URI - // of data files used to create the DataSource. The URI can identify either a file - // or an Amazon Simple Storage Service (Amazon S3) bucket or directory. - // - // * IAMUser - // - Sets the search criteria to the user account that invoked the DataSource - // creation. + // Use one of the following variables to filter a list of DataSource : + // - CreatedAt - Sets the search criteria to DataSource creation dates. + // - Status - Sets the search criteria to DataSource statuses. + // - Name - Sets the search criteria to the contents of DataSource Name . + // - DataUri - Sets the search criteria to the URI of data files used to create + // the DataSource . The URI can identify either a file or an Amazon Simple + // Storage Service (Amazon S3) bucket or directory. + // - IAMUser - Sets the search criteria to the user account that invoked the + // DataSource creation. FilterVariable types.DataSourceFilterVariable // The greater than or equal to operator. The DataSource results will have // FilterVariable values that are greater than or equal to the value specified with - // GE. + // GE . GE *string // The greater than operator. The DataSource results will have FilterVariable - // values that are greater than the value specified with GT. + // values that are greater than the value specified with GT . GT *string // The less than or equal to operator. The DataSource results will have - // FilterVariable values that are less than or equal to the value specified with - // LE. + // FilterVariable values that are less than or equal to the value specified with LE + // . LE *string // The less than operator. The DataSource results will have FilterVariable values - // that are less than the value specified with LT. + // that are less than the value specified with LT . LT *string // The maximum number of DataSource to include in the result. Limit *int32 // The not equal to operator. The DataSource results will have FilterVariable - // values not equal to the value specified with NE. + // values not equal to the value specified with NE . NE *string // The ID of the page in the paginated results. NextToken *string - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, a DataSource could have the Name2014-09-09-HolidayGiftMailer. To search - // for this DataSource, select Name for the FilterVariable and any of the following - // strings for the Prefix: - // - // * 2014-09 - // - // * 2014-09-09 - // - // * 2014-09-09-Holiday + // A string that is found at the beginning of a variable, such as Name or Id . For + // example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer . To + // search for this DataSource , select Name for the FilterVariable and any of the + // following strings for the Prefix : + // - 2014-09 + // - 2014-09-09 + // - 2014-09-09-Holiday Prefix *string // A two-value parameter that determines the sequence of the resulting list of - // DataSource. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * dsc - - // Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. + // DataSource . + // - asc - Arranges the list in ascending order (A-Z, 0-9). + // - dsc - Arranges the list in descending order (Z-A, 9-0). + // Results are sorted by FilterVariable . SortOrder types.SortOrder noSmithyDocumentSerde } // Represents the query results from a DescribeDataSources operation. The content -// is essentially a list of DataSource. +// is essentially a list of DataSource . type DescribeDataSourcesOutput struct { - // An ID of the next page in the paginated results that indicates at least one more - // page follows. + // An ID of the next page in the paginated results that indicates at least one + // more page follows. NextToken *string // A list of DataSource that meet the search criteria. @@ -190,8 +173,8 @@ func (c *Client) addOperationDescribeDataSourcesMiddlewares(stack *middleware.St return nil } -// DescribeDataSourcesAPIClient is a client that implements the DescribeDataSources -// operation. +// DescribeDataSourcesAPIClient is a client that implements the +// DescribeDataSources operation. type DescribeDataSourcesAPIClient interface { DescribeDataSources(context.Context, *DescribeDataSourcesInput, ...func(*Options)) (*DescribeDataSourcesOutput, error) } @@ -295,9 +278,10 @@ type DataSourceAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DataSourceAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DataSourceAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -337,9 +321,9 @@ func NewDataSourceAvailableWaiter(client DescribeDataSourcesAPIClient, optFns .. } } -// Wait calls the waiter function for DataSourceAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for DataSourceAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *DataSourceAvailableWaiter) Wait(ctx context.Context, params *DescribeDataSourcesInput, maxWaitDur time.Duration, optFns ...func(*DataSourceAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/machinelearning/api_op_DescribeEvaluations.go b/service/machinelearning/api_op_DescribeEvaluations.go index c2f76112f66..19660c61d3e 100644 --- a/service/machinelearning/api_op_DescribeEvaluations.go +++ b/service/machinelearning/api_op_DescribeEvaluations.go @@ -36,92 +36,72 @@ func (c *Client) DescribeEvaluations(ctx context.Context, params *DescribeEvalua type DescribeEvaluationsInput struct { // The equal to operator. The Evaluation results will have FilterVariable values - // that exactly match the value specified with EQ. + // that exactly match the value specified with EQ . EQ *string // Use one of the following variable to filter a list of Evaluation objects: - // - // * - // CreatedAt - Sets the search criteria to the Evaluation creation date. - // - // * Status - // - Sets the search criteria to the Evaluation status. - // - // * Name - Sets the search - // criteria to the contents of EvaluationName. - // - // * IAMUser - Sets the search - // criteria to the user account that invoked an Evaluation. - // - // * MLModelId - Sets the - // search criteria to the MLModel that was evaluated. - // - // * DataSourceId - Sets the - // search criteria to the DataSource used in Evaluation. - // - // * DataUri - Sets the - // search criteria to the data file(s) used in Evaluation. The URL can identify - // either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or - // directory. + // - CreatedAt - Sets the search criteria to the Evaluation creation date. + // - Status - Sets the search criteria to the Evaluation status. + // - Name - Sets the search criteria to the contents of Evaluation Name . + // - IAMUser - Sets the search criteria to the user account that invoked an + // Evaluation . + // - MLModelId - Sets the search criteria to the MLModel that was evaluated. + // - DataSourceId - Sets the search criteria to the DataSource used in Evaluation + // . + // - DataUri - Sets the search criteria to the data file(s) used in Evaluation . + // The URL can identify either a file or an Amazon Simple Storage Solution (Amazon + // S3) bucket or directory. FilterVariable types.EvaluationFilterVariable // The greater than or equal to operator. The Evaluation results will have // FilterVariable values that are greater than or equal to the value specified with - // GE. + // GE . GE *string // The greater than operator. The Evaluation results will have FilterVariable - // values that are greater than the value specified with GT. + // values that are greater than the value specified with GT . GT *string // The less than or equal to operator. The Evaluation results will have - // FilterVariable values that are less than or equal to the value specified with - // LE. + // FilterVariable values that are less than or equal to the value specified with LE + // . LE *string // The less than operator. The Evaluation results will have FilterVariable values - // that are less than the value specified with LT. + // that are less than the value specified with LT . LT *string // The maximum number of Evaluation to include in the result. Limit *int32 // The not equal to operator. The Evaluation results will have FilterVariable - // values not equal to the value specified with NE. + // values not equal to the value specified with NE . NE *string // The ID of the page in the paginated results. NextToken *string - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, an Evaluation could have the Name2014-09-09-HolidayGiftMailer. To - // search for this Evaluation, select Name for the FilterVariable and any of the - // following strings for the Prefix: - // - // * 2014-09 - // - // * 2014-09-09 - // - // * 2014-09-09-Holiday + // A string that is found at the beginning of a variable, such as Name or Id . For + // example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer . To + // search for this Evaluation , select Name for the FilterVariable and any of the + // following strings for the Prefix : + // - 2014-09 + // - 2014-09-09 + // - 2014-09-09-Holiday Prefix *string // A two-value parameter that determines the sequence of the resulting list of - // Evaluation. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * dsc - - // Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. + // Evaluation . + // - asc - Arranges the list in ascending order (A-Z, 0-9). + // - dsc - Arranges the list in descending order (Z-A, 9-0). + // Results are sorted by FilterVariable . SortOrder types.SortOrder noSmithyDocumentSerde } // Represents the query results from a DescribeEvaluations operation. The content -// is essentially a list of Evaluation. +// is essentially a list of Evaluation . type DescribeEvaluationsOutput struct { // The ID of the next page in the paginated results that indicates at least one @@ -197,8 +177,8 @@ func (c *Client) addOperationDescribeEvaluationsMiddlewares(stack *middleware.St return nil } -// DescribeEvaluationsAPIClient is a client that implements the DescribeEvaluations -// operation. +// DescribeEvaluationsAPIClient is a client that implements the +// DescribeEvaluations operation. type DescribeEvaluationsAPIClient interface { DescribeEvaluations(context.Context, *DescribeEvaluationsInput, ...func(*Options)) (*DescribeEvaluationsOutput, error) } @@ -302,9 +282,10 @@ type EvaluationAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EvaluationAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EvaluationAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -344,9 +325,9 @@ func NewEvaluationAvailableWaiter(client DescribeEvaluationsAPIClient, optFns .. } } -// Wait calls the waiter function for EvaluationAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for EvaluationAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *EvaluationAvailableWaiter) Wait(ctx context.Context, params *DescribeEvaluationsInput, maxWaitDur time.Duration, optFns ...func(*EvaluationAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/machinelearning/api_op_DescribeMLModels.go b/service/machinelearning/api_op_DescribeMLModels.go index 66333c5ac50..0481dc0fd68 100644 --- a/service/machinelearning/api_op_DescribeMLModels.go +++ b/service/machinelearning/api_op_DescribeMLModels.go @@ -35,98 +35,76 @@ func (c *Client) DescribeMLModels(ctx context.Context, params *DescribeMLModelsI type DescribeMLModelsInput struct { // The equal to operator. The MLModel results will have FilterVariable values that - // exactly match the value specified with EQ. + // exactly match the value specified with EQ . EQ *string - // Use one of the following variables to filter a list of MLModel: - // - // * CreatedAt - - // Sets the search criteria to MLModel creation date. - // - // * Status - Sets the search - // criteria to MLModel status. - // - // * Name - Sets the search criteria to the contents - // of MLModelName. - // - // * IAMUser - Sets the search criteria to the user account that - // invoked the MLModel creation. - // - // * TrainingDataSourceId - Sets the search criteria - // to the DataSource used to train one or more MLModel. - // - // * RealtimeEndpointStatus - - // Sets the search criteria to the MLModel real-time endpoint status. - // - // * - // MLModelType - Sets the search criteria to MLModel type: binary, regression, or - // multi-class. - // - // * Algorithm - Sets the search criteria to the algorithm that the - // MLModel uses. - // - // * TrainingDataURI - Sets the search criteria to the data file(s) - // used in training a MLModel. The URL can identify either a file or an Amazon - // Simple Storage Service (Amazon S3) bucket or directory. + // Use one of the following variables to filter a list of MLModel : + // - CreatedAt - Sets the search criteria to MLModel creation date. + // - Status - Sets the search criteria to MLModel status. + // - Name - Sets the search criteria to the contents of MLModel Name . + // - IAMUser - Sets the search criteria to the user account that invoked the + // MLModel creation. + // - TrainingDataSourceId - Sets the search criteria to the DataSource used to + // train one or more MLModel . + // - RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time + // endpoint status. + // - MLModelType - Sets the search criteria to MLModel type: binary, regression, + // or multi-class. + // - Algorithm - Sets the search criteria to the algorithm that the MLModel uses. + // - TrainingDataURI - Sets the search criteria to the data file(s) used in + // training a MLModel . The URL can identify either a file or an Amazon Simple + // Storage Service (Amazon S3) bucket or directory. FilterVariable types.MLModelFilterVariable // The greater than or equal to operator. The MLModel results will have // FilterVariable values that are greater than or equal to the value specified with - // GE. + // GE . GE *string // The greater than operator. The MLModel results will have FilterVariable values - // that are greater than the value specified with GT. + // that are greater than the value specified with GT . GT *string // The less than or equal to operator. The MLModel results will have FilterVariable - // values that are less than or equal to the value specified with LE. + // values that are less than or equal to the value specified with LE . LE *string - // The less than operator. The MLModel results will have FilterVariable values that - // are less than the value specified with LT. + // The less than operator. The MLModel results will have FilterVariable values + // that are less than the value specified with LT . LT *string // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. + // acceptable values is 1 through 100 . The default value is 100 . Limit *int32 // The not equal to operator. The MLModel results will have FilterVariable values - // not equal to the value specified with NE. + // not equal to the value specified with NE . NE *string // The ID of the page in the paginated results. NextToken *string - // A string that is found at the beginning of a variable, such as Name or Id. For - // example, an MLModel could have the Name2014-09-09-HolidayGiftMailer. To search - // for this MLModel, select Name for the FilterVariable and any of the following - // strings for the Prefix: - // - // * 2014-09 - // - // * 2014-09-09 - // - // * 2014-09-09-Holiday + // A string that is found at the beginning of a variable, such as Name or Id . For + // example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer . To search + // for this MLModel , select Name for the FilterVariable and any of the following + // strings for the Prefix : + // - 2014-09 + // - 2014-09-09 + // - 2014-09-09-Holiday Prefix *string // A two-value parameter that determines the sequence of the resulting list of - // MLModel. - // - // * asc - Arranges the list in ascending order (A-Z, 0-9). - // - // * dsc - - // Arranges the list in descending order (Z-A, 9-0). - // - // Results are sorted by - // FilterVariable. + // MLModel . + // - asc - Arranges the list in ascending order (A-Z, 0-9). + // - dsc - Arranges the list in descending order (Z-A, 9-0). + // Results are sorted by FilterVariable . SortOrder types.SortOrder noSmithyDocumentSerde } // Represents the output of a DescribeMLModels operation. The content is -// essentially a list of MLModel. +// essentially a list of MLModel . type DescribeMLModelsOutput struct { // The ID of the next page in the paginated results that indicates at least one @@ -213,7 +191,7 @@ var _ DescribeMLModelsAPIClient = (*Client)(nil) // DescribeMLModelsPaginatorOptions is the paginator options for DescribeMLModels type DescribeMLModelsPaginatorOptions struct { // The number of pages of information to include in the result. The range of - // acceptable values is 1 through 100. The default value is 100. + // acceptable values is 1 through 100 . The default value is 100 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -306,9 +284,9 @@ type MLModelAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, MLModelAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, MLModelAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/machinelearning/api_op_DescribeTags.go b/service/machinelearning/api_op_DescribeTags.go index b4318ab7314..bdf6a1e5e62 100644 --- a/service/machinelearning/api_op_DescribeTags.go +++ b/service/machinelearning/api_op_DescribeTags.go @@ -29,7 +29,7 @@ func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, op type DescribeTagsInput struct { - // The ID of the ML object. For example, exampleModelId. + // The ID of the ML object. For example, exampleModelId . // // This member is required. ResourceId *string diff --git a/service/machinelearning/api_op_GetBatchPrediction.go b/service/machinelearning/api_op_GetBatchPrediction.go index f3e1c193722..ee1745a6d3c 100644 --- a/service/machinelearning/api_op_GetBatchPrediction.go +++ b/service/machinelearning/api_op_GetBatchPrediction.go @@ -12,8 +12,8 @@ import ( "time" ) -// Returns a BatchPrediction that includes detailed metadata, status, and data file -// information for a Batch Prediction request. +// Returns a BatchPrediction that includes detailed metadata, status, and data +// file information for a Batch Prediction request. func (c *Client) GetBatchPrediction(ctx context.Context, params *GetBatchPredictionInput, optFns ...func(*Options)) (*GetBatchPredictionOutput, error) { if params == nil { params = &GetBatchPredictionInput{} @@ -40,10 +40,10 @@ type GetBatchPredictionInput struct { } // Represents the output of a GetBatchPrediction operation and describes a -// BatchPrediction. +// BatchPrediction . type GetBatchPredictionOutput struct { - // The ID of the DataSource that was used to create the BatchPrediction. + // The ID of the DataSource that was used to create the BatchPrediction . BatchPredictionDataSourceId *string // An ID assigned to the BatchPrediction at creation. This value should be @@ -51,7 +51,7 @@ type GetBatchPredictionOutput struct { BatchPredictionId *string // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the BatchPrediction, normalized and scaled on computation resources. + // processing the BatchPrediction , normalized and scaled on computation resources. // ComputeTime is only available if the BatchPrediction is in the COMPLETED state. ComputeTime *int64 @@ -59,14 +59,14 @@ type GetBatchPredictionOutput struct { // time. CreatedAt *time.Time - // The AWS user account that invoked the BatchPrediction. The account type can be + // The AWS user account that invoked the BatchPrediction . The account type can be // either an AWS root account or an AWS Identity and Access Management (IAM) user // account. CreatedByIamUser *string // The epoch time when Amazon Machine Learning marked the BatchPrediction as - // COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in - // the COMPLETED or FAILED state. + // COMPLETED or FAILED . FinishedAt is only available when the BatchPrediction is + // in the COMPLETED or FAILED state. FinishedAt *time.Time // The location of the data file or directory in Amazon Simple Storage Service @@ -74,10 +74,10 @@ type GetBatchPredictionOutput struct { InputDataLocationS3 *string // The number of invalid records that Amazon Machine Learning saw while processing - // the BatchPrediction. + // the BatchPrediction . InvalidRecordCount *int64 - // The time of the most recent edit to BatchPrediction. The time is expressed in + // The time of the most recent edit to BatchPrediction . The time is expressed in // epoch time. LastUpdatedAt *time.Time @@ -92,7 +92,7 @@ type GetBatchPredictionOutput struct { // request. Message *string - // A user-supplied name or description of the BatchPrediction. + // A user-supplied name or description of the BatchPrediction . Name *string // The location of an Amazon S3 bucket or directory to receive the operation @@ -100,31 +100,22 @@ type GetBatchPredictionOutput struct { OutputUri *string // The epoch time when Amazon Machine Learning marked the BatchPrediction as - // INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING + // INPROGRESS . StartedAt isn't available if the BatchPrediction is in the PENDING // state. StartedAt *time.Time - // The status of the BatchPrediction, which can be one of the following values: - // - // * - // PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate - // batch predictions. - // - // * INPROGRESS - The batch predictions are in progress. - // - // * - // FAILED - The request to perform a batch prediction did not run to completion. It - // is not usable. - // - // * COMPLETED - The batch prediction process completed - // successfully. - // - // * DELETED - The BatchPrediction is marked as deleted. It is not - // usable. + // The status of the BatchPrediction , which can be one of the following values: + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to + // generate batch predictions. + // - INPROGRESS - The batch predictions are in progress. + // - FAILED - The request to perform a batch prediction did not run to + // completion. It is not usable. + // - COMPLETED - The batch prediction process completed successfully. + // - DELETED - The BatchPrediction is marked as deleted. It is not usable. Status types.EntityStatus // The number of total records that Amazon Machine Learning saw while processing - // the BatchPrediction. + // the BatchPrediction . TotalRecordCount *int64 // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_GetDataSource.go b/service/machinelearning/api_op_GetDataSource.go index e5f46fad9a9..56b68633978 100644 --- a/service/machinelearning/api_op_GetDataSource.go +++ b/service/machinelearning/api_op_GetDataSource.go @@ -13,7 +13,7 @@ import ( ) // Returns a DataSource that includes metadata and data file information, as well -// as the current status of the DataSource. GetDataSource provides results in +// as the current status of the DataSource . GetDataSource provides results in // normal or verbose format. The verbose format adds the schema description and the // list of files pointed to by the DataSource to the normal format. func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error) { @@ -38,14 +38,15 @@ type GetDataSourceInput struct { // This member is required. DataSourceId *string - // Specifies whether the GetDataSource operation should return DataSourceSchema. If - // true, DataSourceSchema is returned. If false, DataSourceSchema is not returned. + // Specifies whether the GetDataSource operation should return DataSourceSchema . + // If true, DataSourceSchema is returned. If false, DataSourceSchema is not + // returned. Verbose bool noSmithyDocumentSerde } -// Represents the output of a GetDataSource operation and describes a DataSource. +// Represents the output of a GetDataSource operation and describes a DataSource . type GetDataSourceOutput struct { // The parameter is true if statistics need to be generated from the observation @@ -53,7 +54,7 @@ type GetDataSourceOutput struct { ComputeStatistics bool // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the DataSource, normalized and scaled on computation resources. + // processing the DataSource , normalized and scaled on computation resources. // ComputeTime is only available if the DataSource is in the COMPLETED state and // the ComputeStatistics is set to true. ComputeTime *int64 @@ -61,8 +62,8 @@ type GetDataSourceOutput struct { // The time that the DataSource was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account from which the DataSource was created. The account type can - // be either an AWS root account or an AWS Identity and Access Management (IAM) + // The AWS user account from which the DataSource was created. The account type + // can be either an AWS root account or an AWS Identity and Access Management (IAM) // user account. CreatedByIamUser *string @@ -77,20 +78,20 @@ type GetDataSourceOutput struct { // The total size of observations in the data files. DataSizeInBytes *int64 - // The ID assigned to the DataSource at creation. This value should be identical to - // the value of the DataSourceId in the request. + // The ID assigned to the DataSource at creation. This value should be identical + // to the value of the DataSourceId in the request. DataSourceId *string - // The schema used by all of the data files of this DataSource. Note: This + // The schema used by all of the data files of this DataSource . Note: This // parameter is provided as part of the verbose format. DataSourceSchema *string // The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED - // or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED + // or FAILED . FinishedAt is only available when the DataSource is in the COMPLETED // or FAILED state. FinishedAt *time.Time - // The time of the most recent edit to the DataSource. The time is expressed in + // The time of the most recent edit to the DataSource . The time is expressed in // epoch time. LastUpdatedAt *time.Time @@ -98,13 +99,13 @@ type GetDataSourceOutput struct { LogUri *string // The user-supplied description of the most recent details about creating the - // DataSource. + // DataSource . Message *string - // A user-supplied name or description of the DataSource. + // A user-supplied name or description of the DataSource . Name *string - // The number of data files referenced by the DataSource. + // The number of data files referenced by the DataSource . NumberOfFiles *int64 // The datasource details that are specific to Amazon RDS. @@ -113,31 +114,22 @@ type GetDataSourceOutput struct { // Describes the DataSource details specific to Amazon Redshift. RedshiftMetadata *types.RedshiftMetadata - // The Amazon Resource Name (ARN) of an AWS IAM Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), - // such as the following: arn:aws:iam::account:role/rolename. + // The Amazon Resource Name (ARN) of an AWS IAM Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts) + // , such as the following: arn:aws:iam::account:role/rolename. RoleARN *string - // The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. - // StartedAt isn't available if the DataSource is in the PENDING state. + // The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS + // . StartedAt isn't available if the DataSource is in the PENDING state. StartedAt *time.Time - // The current status of the DataSource. This element can have one of the following - // values: - // - // * PENDING - Amazon ML submitted a request to create a DataSource. - // - // * - // INPROGRESS - The creation process is underway. - // - // * FAILED - The request to create - // a DataSource did not run to completion. It is not usable. - // - // * COMPLETED - The - // creation process completed successfully. - // - // * DELETED - The DataSource is marked - // as deleted. It is not usable. + // The current status of the DataSource . This element can have one of the + // following values: + // - PENDING - Amazon ML submitted a request to create a DataSource . + // - INPROGRESS - The creation process is underway. + // - FAILED - The request to create a DataSource did not run to completion. It is + // not usable. + // - COMPLETED - The creation process completed successfully. + // - DELETED - The DataSource is marked as deleted. It is not usable. Status types.EntityStatus // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_GetEvaluation.go b/service/machinelearning/api_op_GetEvaluation.go index 17c7335e86e..4b902b81612 100644 --- a/service/machinelearning/api_op_GetEvaluation.go +++ b/service/machinelearning/api_op_GetEvaluation.go @@ -13,7 +13,7 @@ import ( ) // Returns an Evaluation that includes metadata as well as the current status of -// the Evaluation. +// the Evaluation . func (c *Client) GetEvaluation(ctx context.Context, params *GetEvaluationInput, optFns ...func(*Options)) (*GetEvaluationOutput, error) { if params == nil { params = &GetEvaluationInput{} @@ -31,8 +31,8 @@ func (c *Client) GetEvaluation(ctx context.Context, params *GetEvaluationInput, type GetEvaluationInput struct { - // The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded - // and cataloged. The ID provides the means to access the information. + // The ID of the Evaluation to retrieve. The evaluation of each MLModel is + // recorded and cataloged. The ID provides the means to access the information. // // This member is required. EvaluationId *string @@ -40,19 +40,20 @@ type GetEvaluationInput struct { noSmithyDocumentSerde } -// Represents the output of a GetEvaluation operation and describes an Evaluation. +// Represents the output of a GetEvaluation operation and describes an Evaluation . type GetEvaluationOutput struct { // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the Evaluation, normalized and scaled on computation resources. + // processing the Evaluation , normalized and scaled on computation resources. // ComputeTime is only available if the Evaluation is in the COMPLETED state. ComputeTime *int64 // The time that the Evaluation was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account that invoked the evaluation. The account type can be either - // an AWS root account or an AWS Identity and Access Management (IAM) user account. + // The AWS user account that invoked the evaluation. The account type can be + // either an AWS root account or an AWS Identity and Access Management (IAM) user + // account. CreatedByIamUser *string // The DataSource used for this evaluation. @@ -62,7 +63,7 @@ type GetEvaluationOutput struct { EvaluationId *string // The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED - // or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED + // or FAILED . FinishedAt is only available when the Evaluation is in the COMPLETED // or FAILED state. FinishedAt *time.Time @@ -70,7 +71,7 @@ type GetEvaluationOutput struct { // (Amazon S3). InputDataLocationS3 *string - // The time of the most recent edit to the Evaluation. The time is expressed in + // The time of the most recent edit to the Evaluation . The time is expressed in // epoch time. LastUpdatedAt *time.Time @@ -80,52 +81,40 @@ type GetEvaluationOutput struct { // The ID of the MLModel that was the focus of the evaluation. MLModelId *string - // A description of the most recent details about evaluating the MLModel. + // A description of the most recent details about evaluating the MLModel . Message *string - // A user-supplied name or description of the Evaluation. + // A user-supplied name or description of the Evaluation . Name *string // Measurements of how well the MLModel performed using observations referenced by - // the DataSource. One of the following metric is returned based on the type of the - // MLModel: - // - // * BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) - // technique to measure performance. - // - // * RegressionRMSE: A regression MLModel uses - // the Root Mean Square Error (RMSE) technique to measure performance. RMSE - // measures the difference between predicted and actual values for a single - // variable. - // - // * MulticlassAvgFScore: A multiclass MLModel uses the F1 score - // technique to measure performance. - // - // For more information about performance - // metrics, please see the Amazon Machine Learning Developer Guide - // (https://docs.aws.amazon.com/machine-learning/latest/dg). + // the DataSource . One of the following metric is returned based on the type of + // the MLModel : + // - BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to + // measure performance. + // - RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) + // technique to measure performance. RMSE measures the difference between predicted + // and actual values for a single variable. + // - MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to + // measure performance. + // For more information about performance metrics, please see the Amazon Machine + // Learning Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg) + // . PerformanceMetrics *types.PerformanceMetrics - // The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. - // StartedAt isn't available if the Evaluation is in the PENDING state. + // The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS + // . StartedAt isn't available if the Evaluation is in the PENDING state. StartedAt *time.Time // The status of the evaluation. This element can have one of the following // values: - // - // * PENDING - Amazon Machine Language (Amazon ML) submitted a request to - // evaluate an MLModel. - // - // * INPROGRESS - The evaluation is underway. - // - // * FAILED - The - // request to evaluate an MLModel did not run to completion. It is not usable. - // - // * - // COMPLETED - The evaluation process completed successfully. - // - // * DELETED - The - // Evaluation is marked as deleted. It is not usable. + // - PENDING - Amazon Machine Language (Amazon ML) submitted a request to + // evaluate an MLModel . + // - INPROGRESS - The evaluation is underway. + // - FAILED - The request to evaluate an MLModel did not run to completion. It is + // not usable. + // - COMPLETED - The evaluation process completed successfully. + // - DELETED - The Evaluation is marked as deleted. It is not usable. Status types.EntityStatus // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_GetMLModel.go b/service/machinelearning/api_op_GetMLModel.go index d055d2c8542..a6e26fab3c8 100644 --- a/service/machinelearning/api_op_GetMLModel.go +++ b/service/machinelearning/api_op_GetMLModel.go @@ -12,9 +12,9 @@ import ( "time" ) -// Returns an MLModel that includes detailed metadata, data source information, and -// the current status of the MLModel. GetMLModel provides results in normal or -// verbose format. +// Returns an MLModel that includes detailed metadata, data source information, +// and the current status of the MLModel . GetMLModel provides results in normal +// or verbose format. func (c *Client) GetMLModel(ctx context.Context, params *GetMLModelInput, optFns ...func(*Options)) (*GetMLModelOutput, error) { if params == nil { params = &GetMLModelInput{} @@ -37,35 +37,35 @@ type GetMLModelInput struct { // This member is required. MLModelId *string - // Specifies whether the GetMLModel operation should return Recipe. If true, Recipe - // is returned. If false, Recipe is not returned. + // Specifies whether the GetMLModel operation should return Recipe . If true, + // Recipe is returned. If false, Recipe is not returned. Verbose bool noSmithyDocumentSerde } // Represents the output of a GetMLModel operation, and provides detailed -// information about a MLModel. +// information about a MLModel . type GetMLModelOutput struct { // The approximate CPU time in milliseconds that Amazon Machine Learning spent - // processing the MLModel, normalized and scaled on computation resources. + // processing the MLModel , normalized and scaled on computation resources. // ComputeTime is only available if the MLModel is in the COMPLETED state. ComputeTime *int64 // The time that the MLModel was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account from which the MLModel was created. The account type can be - // either an AWS root account or an AWS Identity and Access Management (IAM) user - // account. + // The AWS user account from which the MLModel was created. The account type can + // be either an AWS root account or an AWS Identity and Access Management (IAM) + // user account. CreatedByIamUser *string // The current endpoint of the MLModel EndpointInfo *types.RealtimeEndpointInfo // The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or - // FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or + // FAILED . FinishedAt is only available when the MLModel is in the COMPLETED or // FAILED state. FinishedAt *time.Time @@ -73,7 +73,7 @@ type GetMLModelOutput struct { // (Amazon S3). InputDataLocationS3 *string - // The time of the most recent edit to the MLModel. The time is expressed in epoch + // The time of the most recent edit to the MLModel . The time is expressed in epoch // time. LastUpdatedAt *time.Time @@ -84,107 +84,88 @@ type GetMLModelOutput struct { MLModelId *string // Identifies the MLModel category. The following are the available types: - // - // * - // REGRESSION -- Produces a numeric result. For example, "What price should a house - // be listed at?" - // - // * BINARY -- Produces one of two possible results. For example, - // "Is this an e-commerce website?" - // - // * MULTICLASS -- Produces one of several - // possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?" + // - REGRESSION -- Produces a numeric result. For example, "What price should a + // house be listed at?" + // - BINARY -- Produces one of two possible results. For example, "Is this an + // e-commerce website?" + // - MULTICLASS -- Produces one of several possible results. For example, "Is + // this a HIGH, LOW or MEDIUM risk trade?" MLModelType types.MLModelType - // A description of the most recent details about accessing the MLModel. + // A description of the most recent details about accessing the MLModel . Message *string - // A user-supplied name or description of the MLModel. + // A user-supplied name or description of the MLModel . Name *string - // The recipe to use when training the MLModel. The Recipe provides detailed + // The recipe to use when training the MLModel . The Recipe provides detailed // information about the observation data to use during training, and manipulations // to perform on the observation data during training. Note: This parameter is // provided as part of the verbose format. Recipe *string - // The schema used by all of the data files referenced by the DataSource. Note: + // The schema used by all of the data files referenced by the DataSource . Note: // This parameter is provided as part of the verbose format. Schema *string // The scoring threshold is used in binary classification MLModel models. It marks // the boundary between a positive prediction and a negative prediction. Output // values greater than or equal to the threshold receive a positive result from the - // MLModel, such as true. Output values less than the threshold receive a negative - // response from the MLModel, such as false. + // MLModel, such as true . Output values less than the threshold receive a negative + // response from the MLModel, such as false . ScoreThreshold *float32 - // The time of the most recent edit to the ScoreThreshold. The time is expressed in - // epoch time. + // The time of the most recent edit to the ScoreThreshold . The time is expressed + // in epoch time. ScoreThresholdLastUpdatedAt *time.Time // Long integer type that is a 64-bit signed number. SizeInBytes *int64 - // The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. + // The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS . // StartedAt isn't available if the MLModel is in the PENDING state. StartedAt *time.Time - // The current status of the MLModel. This element can have one of the following + // The current status of the MLModel . This element can have one of the following // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to - // describe a MLModel. - // - // * INPROGRESS - The request is processing. - // - // * FAILED - The - // request did not run to completion. The ML model isn't usable. - // - // * COMPLETED - The - // request completed successfully. - // - // * DELETED - The MLModel is marked as deleted. - // It isn't usable. + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to + // describe a MLModel . + // - INPROGRESS - The request is processing. + // - FAILED - The request did not run to completion. The ML model isn't usable. + // - COMPLETED - The request completed successfully. + // - DELETED - The MLModel is marked as deleted. It isn't usable. Status types.EntityStatus - // The ID of the training DataSource. + // The ID of the training DataSource . TrainingDataSourceId *string - // A list of the training parameters in the MLModel. The list is implemented as a - // map of key-value pairs. The following is the current set of training - // parameters: - // - // * sgd.maxMLModelSizeInBytes - The maximum allowed size of the - // model. Depending on the input data, the size of the model might affect its - // performance. The value is an integer that ranges from 100000 to 2147483648. The - // default value is 33554432. - // - // * sgd.maxPasses - The number of times that the - // training process traverses the observations to build the MLModel. The value is - // an integer that ranges from 1 to 10000. The default value is 10. - // - // * - // sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data - // improves a model's ability to find the optimal solution for a variety of data - // types. The valid values are auto and none. The default value is none. We - // strongly recommend that you shuffle your data. - // - // * sgd.l1RegularizationAmount - - // The coefficient regularization L1 norm. It controls overfitting the data by - // penalizing large coefficients. This tends to drive coefficients to zero, - // resulting in a sparse feature set. If you use this parameter, start by - // specifying a small value, such as 1.0E-08. The value is a double that ranges - // from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter - // can't be used when L2 is specified. Use this parameter sparingly. + // A list of the training parameters in the MLModel . The list is implemented as a + // map of key-value pairs. The following is the current set of training parameters: // - // * - // sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls - // overfitting the data by penalizing large coefficients. This tends to drive - // coefficients to small, nonzero values. If you use this parameter, start by - // specifying a small value, such as 1.0E-08. The value is a double that ranges - // from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter - // can't be used when L1 is specified. Use this parameter sparingly. + // - sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending + // on the input data, the size of the model might affect its performance. The value + // is an integer that ranges from 100000 to 2147483648 . The default value is + // 33554432 . + // - sgd.maxPasses - The number of times that the training process traverses the + // observations to build the MLModel . The value is an integer that ranges from 1 + // to 10000 . The default value is 10 . + // - sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling + // data improves a model's ability to find the optimal solution for a variety of + // data types. The valid values are auto and none . The default value is none . + // We strongly recommend that you shuffle your data. + // - sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It + // controls overfitting the data by penalizing large coefficients. This tends to + // drive coefficients to zero, resulting in a sparse feature set. If you use this + // parameter, start by specifying a small value, such as 1.0E-08 . The value is a + // double that ranges from 0 to MAX_DOUBLE . The default is to not use L1 + // normalization. This parameter can't be used when L2 is specified. Use this + // parameter sparingly. + // - sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It + // controls overfitting the data by penalizing large coefficients. This tends to + // drive coefficients to small, nonzero values. If you use this parameter, start by + // specifying a small value, such as 1.0E-08 . The value is a double that ranges + // from 0 to MAX_DOUBLE . The default is to not use L2 normalization. This + // parameter can't be used when L1 is specified. Use this parameter sparingly. TrainingParameters map[string]string // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_Predict.go b/service/machinelearning/api_op_Predict.go index 7c8c4b1b7a5..93e29d469c7 100644 --- a/service/machinelearning/api_op_Predict.go +++ b/service/machinelearning/api_op_Predict.go @@ -14,7 +14,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates a prediction for the observation using the specified ML Model. Note: +// Generates a prediction for the observation using the specified ML Model . Note: // Not all response parameters will be populated. Whether a response parameter is // populated depends on the type of model requested. func (c *Client) Predict(ctx context.Context, params *PredictInput, optFns ...func(*Options)) (*PredictOutput, error) { @@ -34,7 +34,7 @@ func (c *Client) Predict(ctx context.Context, params *PredictInput, optFns ...fu type PredictInput struct { - // A unique identifier of the MLModel. + // A unique identifier of the MLModel . // // This member is required. MLModelId *string @@ -53,19 +53,13 @@ type PredictInput struct { type PredictOutput struct { // The output from a Predict operation: - // - // * Details - Contains the following - // attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | - // MULTICLASSDetailsAttributes.ALGORITHM - SGD - // - // * PredictedLabel - Present for - // either a BINARY or MULTICLASSMLModel request. - // - // * PredictedScores - Contains the - // raw classification score corresponding to each label. - // - // * PredictedValue - - // Present for a REGRESSIONMLModel request. + // - Details - Contains the following attributes: + // DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS + // DetailsAttributes.ALGORITHM - SGD + // - PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request. + // - PredictedScores - Contains the raw classification score corresponding to + // each label. + // - PredictedValue - Present for a REGRESSION MLModel request. Prediction *types.Prediction // Metadata pertaining to the operation's result. diff --git a/service/machinelearning/api_op_UpdateBatchPrediction.go b/service/machinelearning/api_op_UpdateBatchPrediction.go index af15cfa26c0..01b2febe437 100644 --- a/service/machinelearning/api_op_UpdateBatchPrediction.go +++ b/service/machinelearning/api_op_UpdateBatchPrediction.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the BatchPredictionName of a BatchPrediction. You can use the +// Updates the BatchPredictionName of a BatchPrediction . You can use the // GetBatchPrediction operation to view the contents of the updated data element. func (c *Client) UpdateBatchPrediction(ctx context.Context, params *UpdateBatchPredictionInput, optFns ...func(*Options)) (*UpdateBatchPredictionOutput, error) { if params == nil { @@ -34,7 +34,7 @@ type UpdateBatchPredictionInput struct { // This member is required. BatchPredictionId *string - // A new user-supplied name or description of the BatchPrediction. + // A new user-supplied name or description of the BatchPrediction . // // This member is required. BatchPredictionName *string diff --git a/service/machinelearning/api_op_UpdateDataSource.go b/service/machinelearning/api_op_UpdateDataSource.go index c8235556cdc..e48fa288683 100644 --- a/service/machinelearning/api_op_UpdateDataSource.go +++ b/service/machinelearning/api_op_UpdateDataSource.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the DataSourceName of a DataSource. You can use the GetDataSource +// Updates the DataSourceName of a DataSource . You can use the GetDataSource // operation to view the contents of the updated data element. func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error) { if params == nil { diff --git a/service/machinelearning/api_op_UpdateEvaluation.go b/service/machinelearning/api_op_UpdateEvaluation.go index f2f0c38ab83..beeff75ea6f 100644 --- a/service/machinelearning/api_op_UpdateEvaluation.go +++ b/service/machinelearning/api_op_UpdateEvaluation.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the EvaluationName of an Evaluation. You can use the GetEvaluation +// Updates the EvaluationName of an Evaluation . You can use the GetEvaluation // operation to view the contents of the updated data element. func (c *Client) UpdateEvaluation(ctx context.Context, params *UpdateEvaluationInput, optFns ...func(*Options)) (*UpdateEvaluationOutput, error) { if params == nil { diff --git a/service/machinelearning/api_op_UpdateMLModel.go b/service/machinelearning/api_op_UpdateMLModel.go index 129bc032d48..65e73ce6d05 100644 --- a/service/machinelearning/api_op_UpdateMLModel.go +++ b/service/machinelearning/api_op_UpdateMLModel.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the MLModelName and the ScoreThreshold of an MLModel. You can use the +// Updates the MLModelName and the ScoreThreshold of an MLModel . You can use the // GetMLModel operation to view the contents of the updated data element. func (c *Client) UpdateMLModel(ctx context.Context, params *UpdateMLModelInput, optFns ...func(*Options)) (*UpdateMLModelOutput, error) { if params == nil { @@ -34,14 +34,14 @@ type UpdateMLModelInput struct { // This member is required. MLModelId *string - // A user-supplied name or description of the MLModel. + // A user-supplied name or description of the MLModel . MLModelName *string - // The ScoreThreshold used in binary classification MLModel that marks the boundary - // between a positive prediction and a negative prediction. Output values greater - // than or equal to the ScoreThreshold receive a positive result from the MLModel, - // such as true. Output values less than the ScoreThreshold receive a negative - // response from the MLModel, such as false. + // The ScoreThreshold used in binary classification MLModel that marks the + // boundary between a positive prediction and a negative prediction. Output values + // greater than or equal to the ScoreThreshold receive a positive result from the + // MLModel , such as true . Output values less than the ScoreThreshold receive a + // negative response from the MLModel , such as false . ScoreThreshold *float32 noSmithyDocumentSerde diff --git a/service/machinelearning/doc.go b/service/machinelearning/doc.go index 54481dcfbbd..20badeef512 100644 --- a/service/machinelearning/doc.go +++ b/service/machinelearning/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package machinelearning provides the API client, operations, and parameter types -// for Amazon Machine Learning. +// Package machinelearning provides the API client, operations, and parameter +// types for Amazon Machine Learning. // // Definition of the public APIs exposed by Amazon Machine Learning package machinelearning diff --git a/service/machinelearning/types/enums.go b/service/machinelearning/types/enums.go index 00582a1dcfb..8348ddc6e20 100644 --- a/service/machinelearning/types/enums.go +++ b/service/machinelearning/types/enums.go @@ -9,9 +9,9 @@ const ( AlgorithmSgd Algorithm = "sgd" ) -// Values returns all known values for Algorithm. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Algorithm. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Algorithm) Values() []Algorithm { return []Algorithm{ "sgd", @@ -61,9 +61,9 @@ const ( DataSourceFilterVariableIamUser DataSourceFilterVariable = "IAMUser" ) -// Values returns all known values for DataSourceFilterVariable. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DataSourceFilterVariable. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceFilterVariable) Values() []DataSourceFilterVariable { return []DataSourceFilterVariable{ "CreatedAt", @@ -104,9 +104,9 @@ const ( EntityStatusDeleted EntityStatus = "DELETED" ) -// Values returns all known values for EntityStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EntityStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EntityStatus) Values() []EntityStatus { return []EntityStatus{ "PENDING", @@ -131,9 +131,9 @@ const ( EvaluationFilterVariableDataUri EvaluationFilterVariable = "DataURI" ) -// Values returns all known values for EvaluationFilterVariable. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EvaluationFilterVariable. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFilterVariable) Values() []EvaluationFilterVariable { return []EvaluationFilterVariable{ "CreatedAt", @@ -163,8 +163,8 @@ const ( MLModelFilterVariableTrainingDataUri MLModelFilterVariable = "TrainingDataURI" ) -// Values returns all known values for MLModelFilterVariable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MLModelFilterVariable. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MLModelFilterVariable) Values() []MLModelFilterVariable { return []MLModelFilterVariable{ @@ -231,9 +231,9 @@ const ( SortOrderDsc SortOrder = "dsc" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "asc", diff --git a/service/machinelearning/types/errors.go b/service/machinelearning/types/errors.go index e1427b3757c..f5ecb134c2e 100644 --- a/service/machinelearning/types/errors.go +++ b/service/machinelearning/types/errors.go @@ -121,7 +121,7 @@ func (e *InvalidTagException) ErrorCode() string { func (e *InvalidTagException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The subscriber exceeded the maximum number of operations. This exception can -// occur when listing objects such as DataSource. +// occur when listing objects such as DataSource . type LimitExceededException struct { Message *string @@ -149,7 +149,7 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The exception is thrown when a predict request is made to an unmounted MLModel. +// The exception is thrown when a predict request is made to an unmounted MLModel . type PredictorNotMountedException struct { Message *string diff --git a/service/machinelearning/types/types.go b/service/machinelearning/types/types.go index 9150002b128..fd8aab8abdb 100644 --- a/service/machinelearning/types/types.go +++ b/service/machinelearning/types/types.go @@ -7,9 +7,9 @@ import ( "time" ) -// Represents the output of a GetBatchPrediction operation. The content consists of -// the detailed metadata, the status, and the data file information of a Batch -// Prediction. +// Represents the output of a GetBatchPrediction operation. The content consists +// of the detailed metadata, the status, and the data file information of a Batch +// Prediction . type BatchPrediction struct { // The ID of the DataSource that points to the group of observations to predict. @@ -26,7 +26,7 @@ type BatchPrediction struct { // time. CreatedAt *time.Time - // The AWS user account that invoked the BatchPrediction. The account type can be + // The AWS user account that invoked the BatchPrediction . The account type can be // either an AWS root account or an AWS Identity and Access Management (IAM) user // account. CreatedByIamUser *string @@ -41,7 +41,7 @@ type BatchPrediction struct { // Long integer type that is a 64-bit signed number. InvalidRecordCount *int64 - // The time of the most recent edit to the BatchPrediction. The time is expressed + // The time of the most recent edit to the BatchPrediction . The time is expressed // in epoch time. LastUpdatedAt *time.Time @@ -53,7 +53,7 @@ type BatchPrediction struct { // request. Message *string - // A user-supplied name or description of the BatchPrediction. + // A user-supplied name or description of the BatchPrediction . Name *string // The location of an Amazon S3 bucket or directory to receive the operation @@ -64,23 +64,15 @@ type BatchPrediction struct { // A timestamp represented in epoch time. StartedAt *time.Time - // The status of the BatchPrediction. This element can have one of the following + // The status of the BatchPrediction . This element can have one of the following // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to - // generate predictions for a batch of observations. - // - // * INPROGRESS - The process is - // underway. - // - // * FAILED - The request to perform a batch prediction did not run to - // completion. It is not usable. - // - // * COMPLETED - The batch prediction process - // completed successfully. - // - // * DELETED - The BatchPrediction is marked as deleted. - // It is not usable. + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to + // generate predictions for a batch of observations. + // - INPROGRESS - The process is underway. + // - FAILED - The request to perform a batch prediction did not run to + // completion. It is not usable. + // - COMPLETED - The batch prediction process completed successfully. + // - DELETED - The BatchPrediction is marked as deleted. It is not usable. Status EntityStatus // Long integer type that is a 64-bit signed number. @@ -91,7 +83,7 @@ type BatchPrediction struct { // Represents the output of the GetDataSource operation. The content consists of // the detailed metadata and data file information and the current status of the -// DataSource. +// DataSource . type DataSource struct { // The parameter is true if statistics need to be generated from the observation @@ -104,13 +96,13 @@ type DataSource struct { // The time that the DataSource was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account from which the DataSource was created. The account type can - // be either an AWS root account or an AWS Identity and Access Management (IAM) + // The AWS user account from which the DataSource was created. The account type + // can be either an AWS root account or an AWS Identity and Access Management (IAM) // user account. CreatedByIamUser *string // The location and name of the data in Amazon Simple Storage Service (Amazon S3) - // that is used by a DataSource. + // that is used by a DataSource . DataLocationS3 *string // A JSON string that represents the splitting and rearrangement requirement used @@ -127,17 +119,17 @@ type DataSource struct { // A timestamp represented in epoch time. FinishedAt *time.Time - // The time of the most recent edit to the BatchPrediction. The time is expressed + // The time of the most recent edit to the BatchPrediction . The time is expressed // in epoch time. LastUpdatedAt *time.Time - // A description of the most recent details about creating the DataSource. + // A description of the most recent details about creating the DataSource . Message *string - // A user-supplied name or description of the DataSource. + // A user-supplied name or description of the DataSource . Name *string - // The number of data files referenced by the DataSource. + // The number of data files referenced by the DataSource . NumberOfFiles *int64 // The datasource details that are specific to Amazon RDS. @@ -146,30 +138,22 @@ type DataSource struct { // Describes the DataSource details specific to Amazon Redshift. RedshiftMetadata *RedshiftMetadata - // The Amazon Resource Name (ARN) of an AWS IAM Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts), - // such as the following: arn:aws:iam::account:role/rolename. + // The Amazon Resource Name (ARN) of an AWS IAM Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts) + // , such as the following: arn:aws:iam::account:role/rolename. RoleARN *string // A timestamp represented in epoch time. StartedAt *time.Time - // The current status of the DataSource. This element can have one of the following - // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to - // create a DataSource. - // - // * INPROGRESS - The creation process is underway. - // - // * FAILED - // - The request to create a DataSource did not run to completion. It is not - // usable. - // - // * COMPLETED - The creation process completed successfully. - // - // * DELETED - - // The DataSource is marked as deleted. It is not usable. + // The current status of the DataSource . This element can have one of the + // following values: + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create + // a DataSource . + // - INPROGRESS - The creation process is underway. + // - FAILED - The request to create a DataSource did not run to completion. It is + // not usable. + // - COMPLETED - The creation process completed successfully. + // - DELETED - The DataSource is marked as deleted. It is not usable. Status EntityStatus noSmithyDocumentSerde @@ -177,7 +161,7 @@ type DataSource struct { // Represents the output of GetEvaluation operation. The content consists of the // detailed metadata and data file information and the current status of the -// Evaluation. +// Evaluation . type Evaluation struct { // Long integer type that is a 64-bit signed number. @@ -186,11 +170,12 @@ type Evaluation struct { // The time that the Evaluation was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account that invoked the evaluation. The account type can be either - // an AWS root account or an AWS Identity and Access Management (IAM) user account. + // The AWS user account that invoked the evaluation. The account type can be + // either an AWS root account or an AWS Identity and Access Management (IAM) user + // account. CreatedByIamUser *string - // The ID of the DataSource that is used to evaluate the MLModel. + // The ID of the DataSource that is used to evaluate the MLModel . EvaluationDataSourceId *string // The ID that is assigned to the Evaluation at creation. @@ -203,37 +188,32 @@ type Evaluation struct { // that is used in the evaluation. InputDataLocationS3 *string - // The time of the most recent edit to the Evaluation. The time is expressed in + // The time of the most recent edit to the Evaluation . The time is expressed in // epoch time. LastUpdatedAt *time.Time // The ID of the MLModel that is the focus of the evaluation. MLModelId *string - // A description of the most recent details about evaluating the MLModel. + // A description of the most recent details about evaluating the MLModel . Message *string - // A user-supplied name or description of the Evaluation. + // A user-supplied name or description of the Evaluation . Name *string - // Measurements of how well the MLModel performed, using observations referenced by - // the DataSource. One of the following metrics is returned, based on the type of - // the MLModel: - // - // * BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) - // technique to measure performance. - // - // * RegressionRMSE: A regression MLModel uses - // the Root Mean Square Error (RMSE) technique to measure performance. RMSE - // measures the difference between predicted and actual values for a single - // variable. - // - // * MulticlassAvgFScore: A multiclass MLModel uses the F1 score - // technique to measure performance. - // - // For more information about performance - // metrics, please see the Amazon Machine Learning Developer Guide - // (https://docs.aws.amazon.com/machine-learning/latest/dg). + // Measurements of how well the MLModel performed, using observations referenced + // by the DataSource . One of the following metrics is returned, based on the type + // of the MLModel : + // - BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to + // measure performance. + // - RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) + // technique to measure performance. RMSE measures the difference between predicted + // and actual values for a single variable. + // - MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to + // measure performance. + // For more information about performance metrics, please see the Amazon Machine + // Learning Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg) + // . PerformanceMetrics *PerformanceMetrics // A timestamp represented in epoch time. @@ -241,34 +221,25 @@ type Evaluation struct { // The status of the evaluation. This element can have one of the following // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to - // evaluate an MLModel. - // - // * INPROGRESS - The evaluation is underway. - // - // * FAILED - The - // request to evaluate an MLModel did not run to completion. It is not usable. - // - // * - // COMPLETED - The evaluation process completed successfully. - // - // * DELETED - The - // Evaluation is marked as deleted. It is not usable. + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to + // evaluate an MLModel . + // - INPROGRESS - The evaluation is underway. + // - FAILED - The request to evaluate an MLModel did not run to completion. It is + // not usable. + // - COMPLETED - The evaluation process completed successfully. + // - DELETED - The Evaluation is marked as deleted. It is not usable. Status EntityStatus noSmithyDocumentSerde } // Represents the output of a GetMLModel operation. The content consists of the -// detailed metadata and the current status of the MLModel. +// detailed metadata and the current status of the MLModel . type MLModel struct { - // The algorithm used to train the MLModel. The following algorithm is - // supported: - // - // * SGD -- Stochastic gradient descent. The goal of SGD is to minimize - // the gradient of the loss function. + // The algorithm used to train the MLModel . The following algorithm is supported: + // - SGD -- Stochastic gradient descent. The goal of SGD is to minimize the + // gradient of the loss function. Algorithm Algorithm // Long integer type that is a 64-bit signed number. @@ -277,12 +248,12 @@ type MLModel struct { // The time that the MLModel was created. The time is expressed in epoch time. CreatedAt *time.Time - // The AWS user account from which the MLModel was created. The account type can be - // either an AWS root account or an AWS Identity and Access Management (IAM) user - // account. + // The AWS user account from which the MLModel was created. The account type can + // be either an AWS root account or an AWS Identity and Access Management (IAM) + // user account. CreatedByIamUser *string - // The current endpoint of the MLModel. + // The current endpoint of the MLModel . EndpointInfo *RealtimeEndpointInfo // A timestamp represented in epoch time. @@ -292,7 +263,7 @@ type MLModel struct { // (Amazon S3). InputDataLocationS3 *string - // The time of the most recent edit to the MLModel. The time is expressed in epoch + // The time of the most recent edit to the MLModel . The time is expressed in epoch // time. LastUpdatedAt *time.Time @@ -300,28 +271,24 @@ type MLModel struct { MLModelId *string // Identifies the MLModel category. The following are the available types: - // - // * - // REGRESSION - Produces a numeric result. For example, "What price should a house - // be listed at?" - // - // * BINARY - Produces one of two possible results. For example, - // "Is this a child-friendly web site?". - // - // * MULTICLASS - Produces one of several - // possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?". + // - REGRESSION - Produces a numeric result. For example, "What price should a + // house be listed at?" + // - BINARY - Produces one of two possible results. For example, "Is this a + // child-friendly web site?". + // - MULTICLASS - Produces one of several possible results. For example, "Is this + // a HIGH-, LOW-, or MEDIUM-risk trade?". MLModelType MLModelType - // A description of the most recent details about accessing the MLModel. + // A description of the most recent details about accessing the MLModel . Message *string - // A user-supplied name or description of the MLModel. + // A user-supplied name or description of the MLModel . Name *string ScoreThreshold *float32 - // The time of the most recent edit to the ScoreThreshold. The time is expressed in - // epoch time. + // The time of the most recent edit to the ScoreThreshold . The time is expressed + // in epoch time. ScoreThresholdLastUpdatedAt *time.Time // Long integer type that is a 64-bit signed number. @@ -330,85 +297,66 @@ type MLModel struct { // A timestamp represented in epoch time. StartedAt *time.Time - // The current status of an MLModel. This element can have one of the following + // The current status of an MLModel . This element can have one of the following // values: - // - // * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to - // create an MLModel. - // - // * INPROGRESS - The creation process is underway. - // - // * FAILED - - // The request to create an MLModel didn't run to completion. The model isn't - // usable. - // - // * COMPLETED - The creation process completed successfully. - // - // * DELETED - - // The MLModel is marked as deleted. It isn't usable. + // - PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create + // an MLModel . + // - INPROGRESS - The creation process is underway. + // - FAILED - The request to create an MLModel didn't run to completion. The + // model isn't usable. + // - COMPLETED - The creation process completed successfully. + // - DELETED - The MLModel is marked as deleted. It isn't usable. Status EntityStatus - // The ID of the training DataSource. The CreateMLModel operation uses the - // TrainingDataSourceId. + // The ID of the training DataSource . The CreateMLModel operation uses the + // TrainingDataSourceId . TrainingDataSourceId *string - // A list of the training parameters in the MLModel. The list is implemented as a - // map of key-value pairs. The following is the current set of training - // parameters: - // - // * sgd.maxMLModelSizeInBytes - The maximum allowed size of the - // model. Depending on the input data, the size of the model might affect its - // performance. The value is an integer that ranges from 100000 to 2147483648. The - // default value is 33554432. - // - // * sgd.maxPasses - The number of times that the - // training process traverses the observations to build the MLModel. The value is - // an integer that ranges from 1 to 10000. The default value is 10. - // - // * - // sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the - // data improves a model's ability to find the optimal solution for a variety of - // data types. The valid values are auto and none. The default value is none. - // - // * - // sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which - // controls overfitting the data by penalizing large coefficients. This parameter - // tends to drive coefficients to zero, resulting in sparse feature set. If you use - // this parameter, start by specifying a small value, such as 1.0E-08. The value is - // a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 - // normalization. This parameter can't be used when L2 is specified. Use this - // parameter sparingly. - // - // * sgd.l2RegularizationAmount - The coefficient - // regularization L2 norm, which controls overfitting the data by penalizing large - // coefficients. This tends to drive coefficients to small, nonzero values. If you - // use this parameter, start by specifying a small value, such as 1.0E-08. The - // value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 - // normalization. This parameter can't be used when L1 is specified. Use this - // parameter sparingly. + // A list of the training parameters in the MLModel . The list is implemented as a + // map of key-value pairs. The following is the current set of training parameters: + // + // - sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending + // on the input data, the size of the model might affect its performance. The value + // is an integer that ranges from 100000 to 2147483648 . The default value is + // 33554432 . + // - sgd.maxPasses - The number of times that the training process traverses the + // observations to build the MLModel . The value is an integer that ranges from 1 + // to 10000 . The default value is 10 . + // - sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling + // the data improves a model's ability to find the optimal solution for a variety + // of data types. The valid values are auto and none . The default value is none + // . + // - sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which + // controls overfitting the data by penalizing large coefficients. This parameter + // tends to drive coefficients to zero, resulting in sparse feature set. If you use + // this parameter, start by specifying a small value, such as 1.0E-08 . The value + // is a double that ranges from 0 to MAX_DOUBLE . The default is to not use L1 + // normalization. This parameter can't be used when L2 is specified. Use this + // parameter sparingly. + // - sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which + // controls overfitting the data by penalizing large coefficients. This tends to + // drive coefficients to small, nonzero values. If you use this parameter, start by + // specifying a small value, such as 1.0E-08 . The value is a double that ranges + // from 0 to MAX_DOUBLE . The default is to not use L2 normalization. This + // parameter can't be used when L1 is specified. Use this parameter sparingly. TrainingParameters map[string]string noSmithyDocumentSerde } -// Measurements of how well the MLModel performed on known observations. One of the -// following metrics is returned, based on the type of the MLModel: +// Measurements of how well the MLModel performed on known observations. One of +// the following metrics is returned, based on the type of the MLModel : +// - BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique +// to measure performance. +// - RegressionRMSE: The regression MLModel uses the Root Mean Square Error +// (RMSE) technique to measure performance. RMSE measures the difference between +// predicted and actual values for a single variable. +// - MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to +// measure performance. // -// * BinaryAUC: -// The binary MLModel uses the Area Under the Curve (AUC) technique to measure -// performance. -// -// * RegressionRMSE: The regression MLModel uses the Root Mean Square -// Error (RMSE) technique to measure performance. RMSE measures the difference -// between predicted and actual values for a single variable. -// -// * -// MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to -// measure performance. -// -// For more information about performance metrics, please see -// the Amazon Machine Learning Developer Guide -// (https://docs.aws.amazon.com/machine-learning/latest/dg). +// For more information about performance metrics, please see the Amazon Machine +// Learning Developer Guide (https://docs.aws.amazon.com/machine-learning/latest/dg) +// . type PerformanceMetrics struct { Properties map[string]string @@ -416,31 +364,25 @@ type PerformanceMetrics struct { } // The output from a Predict operation: -// -// * Details - Contains the following -// attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | -// MULTICLASSDetailsAttributes.ALGORITHM - SGD -// -// * PredictedLabel - Present for -// either a BINARY or MULTICLASSMLModel request. -// -// * PredictedScores - Contains the -// raw classification score corresponding to each label. -// -// * PredictedValue - -// Present for a REGRESSIONMLModel request. +// - Details - Contains the following attributes: +// DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS +// DetailsAttributes.ALGORITHM - SGD +// - PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request. +// - PredictedScores - Contains the raw classification score corresponding to +// each label. +// - PredictedValue - Present for a REGRESSION MLModel request. type Prediction struct { // Provides any additional details regarding the prediction. Details map[string]string - // The prediction label for either a BINARY or MULTICLASSMLModel. + // The prediction label for either a BINARY or MULTICLASS MLModel . PredictedLabel *string // Provides the raw classification score corresponding to each label. PredictedScores map[string]float32 - // The prediction value for REGRESSIONMLModel. + // The prediction value for REGRESSION MLModel . PredictedValue *float32 noSmithyDocumentSerde @@ -483,7 +425,7 @@ type RDSDatabaseCredentials struct { } // The data specification of an Amazon Relational Database Service (Amazon RDS) -// DataSource. +// DataSource . type RDSDataSpec struct { // The AWS Identity and Access Management (IAM) credentials that are used connect @@ -499,8 +441,7 @@ type RDSDataSpec struct { // The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute // Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to - // an Amazon S3 task. For more information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // an Amazon S3 task. For more information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) // for data pipelines. // // This member is required. @@ -520,15 +461,14 @@ type RDSDataSpec struct { // This member is required. SecurityGroupIds []string - // The query that is used to retrieve the observation data for the DataSource. + // The query that is used to retrieve the observation data for the DataSource . // // This member is required. SelectSqlQuery *string // The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more - // information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) // for data pipelines. // // This member is required. @@ -542,70 +482,63 @@ type RDSDataSpec struct { SubnetId *string // A JSON string that represents the splitting and rearrangement processing to be - // applied to a DataSource. If the DataRearrangement parameter is not provided, all - // of the input data is used to create the Datasource. There are multiple + // applied to a DataSource . If the DataRearrangement parameter is not provided, + // all of the input data is used to create the Datasource . There are multiple // parameters that control what data is used to create a datasource: - // - // * - // percentBegin Use percentBegin to indicate the beginning of the range of the data - // used to create the Datasource. If you do not include percentBegin and - // percentEnd, Amazon ML includes all of the data when creating the datasource. - // - // * - // percentEnd Use percentEnd to indicate the end of the range of the data used to - // create the Datasource. If you do not include percentBegin and percentEnd, Amazon - // ML includes all of the data when creating the datasource. - // - // * complement The - // complement parameter instructs Amazon ML to use the data that is not included in - // the range of percentBegin to percentEnd to create a datasource. The complement - // parameter is useful if you need to create complementary datasources for training - // and evaluation. To create a complementary datasource, use the same values for - // percentBegin and percentEnd, along with the complement parameter. For example, - // the following two datasources do not share any data, and can be used to train - // and evaluate a model. The first datasource has 25 percent of the data, and the - // second one has 75 percent of the data. Datasource for evaluation: - // {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: - // {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} - // - // * - // strategy To change how Amazon ML splits the data for a datasource, use the - // strategy parameter. The default value for the strategy parameter is sequential, - // meaning that Amazon ML takes all of the data records between the percentBegin - // and percentEnd parameters for the datasource, in the order that the records - // appear in the input data. The following two DataRearrangement lines are examples - // of sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"sequential"}} Datasource for training: - // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", - // "complement":"true"}} To randomly split the input data into the proportions - // indicated by the percentBegin and percentEnd parameters, set the strategy - // parameter to random and provide a string that is used as the seed value for the - // random data splitting (for example, you can use the S3 path to your data as the - // random seed string). If you choose the random split strategy, Amazon ML assigns - // each row of data a pseudo-random number between 0 and 100, and then selects the - // rows that have an assigned number between percentBegin and percentEnd. - // Pseudo-random numbers are assigned using both the input seed string value and - // the byte offset as a seed, so changing the data results in a different split. - // Any existing ordering is preserved. The random splitting strategy ensures that - // variables in the training and evaluation data are distributed similarly. It is - // useful in the cases where the input data may have an implicit sort order, which - // would otherwise result in training and evaluation datasources containing - // non-similar data records. The following two DataRearrangement lines are examples - // of non-sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource - // for training: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", - // "complement":"true"}} + // - percentBegin Use percentBegin to indicate the beginning of the range of the + // data used to create the Datasource. If you do not include percentBegin and + // percentEnd , Amazon ML includes all of the data when creating the datasource. + // - percentEnd Use percentEnd to indicate the end of the range of the data used + // to create the Datasource. If you do not include percentBegin and percentEnd , + // Amazon ML includes all of the data when creating the datasource. + // - complement The complement parameter instructs Amazon ML to use the data that + // is not included in the range of percentBegin to percentEnd to create a + // datasource. The complement parameter is useful if you need to create + // complementary datasources for training and evaluation. To create a complementary + // datasource, use the same values for percentBegin and percentEnd , along with + // the complement parameter. For example, the following two datasources do not + // share any data, and can be used to train and evaluate a model. The first + // datasource has 25 percent of the data, and the second one has 75 percent of the + // data. Datasource for evaluation: {"splitting":{"percentBegin":0, + // "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, + // "percentEnd":25, "complement":"true"}} + // - strategy To change how Amazon ML splits the data for a datasource, use the + // strategy parameter. The default value for the strategy parameter is sequential + // , meaning that Amazon ML takes all of the data records between the + // percentBegin and percentEnd parameters for the datasource, in the order that + // the records appear in the input data. The following two DataRearrangement + // lines are examples of sequentially ordered training and evaluation datasources: + // Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, + // "strategy":"sequential"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", + // "complement":"true"}} To randomly split the input data into the proportions + // indicated by the percentBegin and percentEnd parameters, set the strategy + // parameter to random and provide a string that is used as the seed value for + // the random data splitting (for example, you can use the S3 path to your data as + // the random seed string). If you choose the random split strategy, Amazon ML + // assigns each row of data a pseudo-random number between 0 and 100, and then + // selects the rows that have an assigned number between percentBegin and + // percentEnd . Pseudo-random numbers are assigned using both the input seed + // string value and the byte offset as a seed, so changing the data results in a + // different split. Any existing ordering is preserved. The random splitting + // strategy ensures that variables in the training and evaluation data are + // distributed similarly. It is useful in the cases where the input data may have + // an implicit sort order, which would otherwise result in training and evaluation + // datasources containing non-similar data records. The following two + // DataRearrangement lines are examples of non-sequentially ordered training and + // evaluation datasources: Datasource for evaluation: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} DataRearrangement *string - // A JSON string that represents the schema for an Amazon RDS DataSource. The + // A JSON string that represents the schema for an Amazon RDS DataSource . The // DataSchema defines the structure of the observation data in the data file(s) - // referenced in the DataSource. A DataSchema is not required if you specify a + // referenced in the DataSource . A DataSchema is not required if you specify a // DataSchemaUri Define your DataSchema as a series of key-value pairs. attributes // and excludedVariableNames have an array of key-value pairs for their value. Use - // the following format to define your DataSchema. { "version": "1.0", + // the following format to define your DataSchema . { "version": "1.0", // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", // "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, // "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", @@ -616,7 +549,7 @@ type RDSDataSpec struct { // "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } DataSchema *string - // The Amazon S3 location of the DataSchema. + // The Amazon S3 location of the DataSchema . DataSchemaUri *string noSmithyDocumentSerde @@ -640,50 +573,43 @@ type RDSMetadata struct { // The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to // carry out the copy task from Amazon RDS to Amazon S3. For more information, see - // Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) // for data pipelines. ResourceRole *string - // The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if - // Verbose is true in GetDataSourceInput. + // The SQL query that is supplied during CreateDataSourceFromRDS . Returns only if + // Verbose is true in GetDataSourceInput . SelectSqlQuery *string // The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more - // information, see Role templates - // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) + // information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) // for data pipelines. ServiceRole *string noSmithyDocumentSerde } -// Describes the real-time endpoint information for an MLModel. +// Describes the real-time endpoint information for an MLModel . type RealtimeEndpointInfo struct { // The time that the request to create the real-time endpoint for the MLModel was // received. The time is expressed in epoch time. CreatedAt *time.Time - // The current status of the real-time endpoint for the MLModel. This element can + // The current status of the real-time endpoint for the MLModel . This element can // have one of the following values: - // - // * NONE - Endpoint does not exist or was - // previously deleted. - // - // * READY - Endpoint is ready to be used for real-time - // predictions. - // - // * UPDATING - Updating/creating the endpoint. + // - NONE - Endpoint does not exist or was previously deleted. + // - READY - Endpoint is ready to be used for real-time predictions. + // - UPDATING - Updating/creating the endpoint. EndpointStatus RealtimeEndpointStatus // The URI that specifies where to send real-time prediction requests for the - // MLModel. Note: The application must wait until the real-time endpoint is ready + // MLModel . Note: The application must wait until the real-time endpoint is ready // before using this URI. EndpointUrl *string - // The maximum processing rate for the real-time endpoint for MLModel, measured in + // The maximum processing rate for the real-time endpoint for MLModel , measured in // incoming requests per second. PeakRequestsPerSecond int32 @@ -714,8 +640,8 @@ type RedshiftDatabaseCredentials struct { // A password to be used by Amazon ML to connect to a database on an Amazon // Redshift cluster. The password should have sufficient permissions to execute a // RedshiftSelectSqlQuery query. The password should be valid for an Amazon - // Redshift USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). + // Redshift USER (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) + // . // // This member is required. Password *string @@ -723,8 +649,8 @@ type RedshiftDatabaseCredentials struct { // A username to be used by Amazon Machine Learning (Amazon ML)to connect to a // database on an Amazon Redshift cluster. The username should have sufficient // permissions to execute the RedshiftSelectSqlQuery query. The username should be - // valid for an Amazon Redshift USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). + // valid for an Amazon Redshift USER (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) + // . // // This member is required. Username *string @@ -732,7 +658,7 @@ type RedshiftDatabaseCredentials struct { noSmithyDocumentSerde } -// Describes the data specification of an Amazon Redshift DataSource. +// Describes the data specification of an Amazon Redshift DataSource . type RedshiftDataSpec struct { // Describes AWS Identity and Access Management (IAM) credentials that are used @@ -742,7 +668,7 @@ type RedshiftDataSpec struct { DatabaseCredentials *RedshiftDatabaseCredentials // Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift - // DataSource. + // DataSource . // // This member is required. DatabaseInformation *RedshiftDatabase @@ -754,76 +680,69 @@ type RedshiftDataSpec struct { S3StagingLocation *string // Describes the SQL Query to execute on an Amazon Redshift database for an Amazon - // Redshift DataSource. + // Redshift DataSource . // // This member is required. SelectSqlQuery *string // A JSON string that represents the splitting and rearrangement processing to be - // applied to a DataSource. If the DataRearrangement parameter is not provided, all - // of the input data is used to create the Datasource. There are multiple + // applied to a DataSource . If the DataRearrangement parameter is not provided, + // all of the input data is used to create the Datasource . There are multiple // parameters that control what data is used to create a datasource: - // - // * - // percentBegin Use percentBegin to indicate the beginning of the range of the data - // used to create the Datasource. If you do not include percentBegin and - // percentEnd, Amazon ML includes all of the data when creating the datasource. - // - // * - // percentEnd Use percentEnd to indicate the end of the range of the data used to - // create the Datasource. If you do not include percentBegin and percentEnd, Amazon - // ML includes all of the data when creating the datasource. - // - // * complement The - // complement parameter instructs Amazon ML to use the data that is not included in - // the range of percentBegin to percentEnd to create a datasource. The complement - // parameter is useful if you need to create complementary datasources for training - // and evaluation. To create a complementary datasource, use the same values for - // percentBegin and percentEnd, along with the complement parameter. For example, - // the following two datasources do not share any data, and can be used to train - // and evaluate a model. The first datasource has 25 percent of the data, and the - // second one has 75 percent of the data. Datasource for evaluation: - // {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: - // {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} - // - // * - // strategy To change how Amazon ML splits the data for a datasource, use the - // strategy parameter. The default value for the strategy parameter is sequential, - // meaning that Amazon ML takes all of the data records between the percentBegin - // and percentEnd parameters for the datasource, in the order that the records - // appear in the input data. The following two DataRearrangement lines are examples - // of sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"sequential"}} Datasource for training: - // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", - // "complement":"true"}} To randomly split the input data into the proportions - // indicated by the percentBegin and percentEnd parameters, set the strategy - // parameter to random and provide a string that is used as the seed value for the - // random data splitting (for example, you can use the S3 path to your data as the - // random seed string). If you choose the random split strategy, Amazon ML assigns - // each row of data a pseudo-random number between 0 and 100, and then selects the - // rows that have an assigned number between percentBegin and percentEnd. - // Pseudo-random numbers are assigned using both the input seed string value and - // the byte offset as a seed, so changing the data results in a different split. - // Any existing ordering is preserved. The random splitting strategy ensures that - // variables in the training and evaluation data are distributed similarly. It is - // useful in the cases where the input data may have an implicit sort order, which - // would otherwise result in training and evaluation datasources containing - // non-similar data records. The following two DataRearrangement lines are examples - // of non-sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource - // for training: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", - // "complement":"true"}} + // - percentBegin Use percentBegin to indicate the beginning of the range of the + // data used to create the Datasource. If you do not include percentBegin and + // percentEnd , Amazon ML includes all of the data when creating the datasource. + // - percentEnd Use percentEnd to indicate the end of the range of the data used + // to create the Datasource. If you do not include percentBegin and percentEnd , + // Amazon ML includes all of the data when creating the datasource. + // - complement The complement parameter instructs Amazon ML to use the data that + // is not included in the range of percentBegin to percentEnd to create a + // datasource. The complement parameter is useful if you need to create + // complementary datasources for training and evaluation. To create a complementary + // datasource, use the same values for percentBegin and percentEnd , along with + // the complement parameter. For example, the following two datasources do not + // share any data, and can be used to train and evaluate a model. The first + // datasource has 25 percent of the data, and the second one has 75 percent of the + // data. Datasource for evaluation: {"splitting":{"percentBegin":0, + // "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, + // "percentEnd":25, "complement":"true"}} + // - strategy To change how Amazon ML splits the data for a datasource, use the + // strategy parameter. The default value for the strategy parameter is sequential + // , meaning that Amazon ML takes all of the data records between the + // percentBegin and percentEnd parameters for the datasource, in the order that + // the records appear in the input data. The following two DataRearrangement + // lines are examples of sequentially ordered training and evaluation datasources: + // Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, + // "strategy":"sequential"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", + // "complement":"true"}} To randomly split the input data into the proportions + // indicated by the percentBegin and percentEnd parameters, set the strategy + // parameter to random and provide a string that is used as the seed value for + // the random data splitting (for example, you can use the S3 path to your data as + // the random seed string). If you choose the random split strategy, Amazon ML + // assigns each row of data a pseudo-random number between 0 and 100, and then + // selects the rows that have an assigned number between percentBegin and + // percentEnd . Pseudo-random numbers are assigned using both the input seed + // string value and the byte offset as a seed, so changing the data results in a + // different split. Any existing ordering is preserved. The random splitting + // strategy ensures that variables in the training and evaluation data are + // distributed similarly. It is useful in the cases where the input data may have + // an implicit sort order, which would otherwise result in training and evaluation + // datasources containing non-similar data records. The following two + // DataRearrangement lines are examples of non-sequentially ordered training and + // evaluation datasources: Datasource for evaluation: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} DataRearrangement *string - // A JSON string that represents the schema for an Amazon Redshift DataSource. The + // A JSON string that represents the schema for an Amazon Redshift DataSource . The // DataSchema defines the structure of the observation data in the data file(s) - // referenced in the DataSource. A DataSchema is not required if you specify a - // DataSchemaUri. Define your DataSchema as a series of key-value pairs. attributes - // and excludedVariableNames have an array of key-value pairs for their value. Use - // the following format to define your DataSchema. { "version": "1.0", + // referenced in the DataSource . A DataSchema is not required if you specify a + // DataSchemaUri . Define your DataSchema as a series of key-value pairs. + // attributes and excludedVariableNames have an array of key-value pairs for their + // value. Use the following format to define your DataSchema . { "version": "1.0", // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", // "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, // "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", @@ -834,7 +753,7 @@ type RedshiftDataSpec struct { // "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } DataSchema *string - // Describes the schema location for an Amazon Redshift DataSource. + // Describes the schema location for an Amazon Redshift DataSource . DataSchemaUri *string noSmithyDocumentSerde @@ -846,25 +765,25 @@ type RedshiftMetadata struct { // A username to be used by Amazon Machine Learning (Amazon ML)to connect to a // database on an Amazon Redshift cluster. The username should have sufficient // permissions to execute the RedshiftSelectSqlQuery query. The username should be - // valid for an Amazon Redshift USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html). + // valid for an Amazon Redshift USER (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) + // . DatabaseUserName *string // Describes the database details required to connect to an Amazon Redshift // database. RedshiftDatabase *RedshiftDatabase - // The SQL query that is specified during CreateDataSourceFromRedshift. Returns + // The SQL query that is specified during CreateDataSourceFromRedshift . Returns // only if Verbose is true in GetDataSourceInput. SelectSqlQuery *string noSmithyDocumentSerde } -// Describes the data specification of a DataSource. +// Describes the data specification of a DataSource . type S3DataSpec struct { - // The location of the data file(s) used by a DataSource. The URI specifies a data + // The location of the data file(s) used by a DataSource . The URI specifies a data // file or an Amazon Simple Storage Service (Amazon S3) directory or bucket // containing data files. // @@ -872,70 +791,63 @@ type S3DataSpec struct { DataLocationS3 *string // A JSON string that represents the splitting and rearrangement processing to be - // applied to a DataSource. If the DataRearrangement parameter is not provided, all - // of the input data is used to create the Datasource. There are multiple + // applied to a DataSource . If the DataRearrangement parameter is not provided, + // all of the input data is used to create the Datasource . There are multiple // parameters that control what data is used to create a datasource: - // - // * - // percentBegin Use percentBegin to indicate the beginning of the range of the data - // used to create the Datasource. If you do not include percentBegin and - // percentEnd, Amazon ML includes all of the data when creating the datasource. - // - // * - // percentEnd Use percentEnd to indicate the end of the range of the data used to - // create the Datasource. If you do not include percentBegin and percentEnd, Amazon - // ML includes all of the data when creating the datasource. - // - // * complement The - // complement parameter instructs Amazon ML to use the data that is not included in - // the range of percentBegin to percentEnd to create a datasource. The complement - // parameter is useful if you need to create complementary datasources for training - // and evaluation. To create a complementary datasource, use the same values for - // percentBegin and percentEnd, along with the complement parameter. For example, - // the following two datasources do not share any data, and can be used to train - // and evaluate a model. The first datasource has 25 percent of the data, and the - // second one has 75 percent of the data. Datasource for evaluation: - // {"splitting":{"percentBegin":0, "percentEnd":25}} Datasource for training: - // {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}} - // - // * - // strategy To change how Amazon ML splits the data for a datasource, use the - // strategy parameter. The default value for the strategy parameter is sequential, - // meaning that Amazon ML takes all of the data records between the percentBegin - // and percentEnd parameters for the datasource, in the order that the records - // appear in the input data. The following two DataRearrangement lines are examples - // of sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"sequential"}} Datasource for training: - // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", - // "complement":"true"}} To randomly split the input data into the proportions - // indicated by the percentBegin and percentEnd parameters, set the strategy - // parameter to random and provide a string that is used as the seed value for the - // random data splitting (for example, you can use the S3 path to your data as the - // random seed string). If you choose the random split strategy, Amazon ML assigns - // each row of data a pseudo-random number between 0 and 100, and then selects the - // rows that have an assigned number between percentBegin and percentEnd. - // Pseudo-random numbers are assigned using both the input seed string value and - // the byte offset as a seed, so changing the data results in a different split. - // Any existing ordering is preserved. The random splitting strategy ensures that - // variables in the training and evaluation data are distributed similarly. It is - // useful in the cases where the input data may have an implicit sort order, which - // would otherwise result in training and evaluation datasources containing - // non-similar data records. The following two DataRearrangement lines are examples - // of non-sequentially ordered training and evaluation datasources: Datasource for - // evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource - // for training: {"splitting":{"percentBegin":70, "percentEnd":100, - // "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", - // "complement":"true"}} + // - percentBegin Use percentBegin to indicate the beginning of the range of the + // data used to create the Datasource. If you do not include percentBegin and + // percentEnd , Amazon ML includes all of the data when creating the datasource. + // - percentEnd Use percentEnd to indicate the end of the range of the data used + // to create the Datasource. If you do not include percentBegin and percentEnd , + // Amazon ML includes all of the data when creating the datasource. + // - complement The complement parameter instructs Amazon ML to use the data that + // is not included in the range of percentBegin to percentEnd to create a + // datasource. The complement parameter is useful if you need to create + // complementary datasources for training and evaluation. To create a complementary + // datasource, use the same values for percentBegin and percentEnd , along with + // the complement parameter. For example, the following two datasources do not + // share any data, and can be used to train and evaluate a model. The first + // datasource has 25 percent of the data, and the second one has 75 percent of the + // data. Datasource for evaluation: {"splitting":{"percentBegin":0, + // "percentEnd":25}} Datasource for training: {"splitting":{"percentBegin":0, + // "percentEnd":25, "complement":"true"}} + // - strategy To change how Amazon ML splits the data for a datasource, use the + // strategy parameter. The default value for the strategy parameter is sequential + // , meaning that Amazon ML takes all of the data records between the + // percentBegin and percentEnd parameters for the datasource, in the order that + // the records appear in the input data. The following two DataRearrangement + // lines are examples of sequentially ordered training and evaluation datasources: + // Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, + // "strategy":"sequential"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", + // "complement":"true"}} To randomly split the input data into the proportions + // indicated by the percentBegin and percentEnd parameters, set the strategy + // parameter to random and provide a string that is used as the seed value for + // the random data splitting (for example, you can use the S3 path to your data as + // the random seed string). If you choose the random split strategy, Amazon ML + // assigns each row of data a pseudo-random number between 0 and 100, and then + // selects the rows that have an assigned number between percentBegin and + // percentEnd . Pseudo-random numbers are assigned using both the input seed + // string value and the byte offset as a seed, so changing the data results in a + // different split. Any existing ordering is preserved. The random splitting + // strategy ensures that variables in the training and evaluation data are + // distributed similarly. It is useful in the cases where the input data may have + // an implicit sort order, which would otherwise result in training and evaluation + // datasources containing non-similar data records. The following two + // DataRearrangement lines are examples of non-sequentially ordered training and + // evaluation datasources: Datasource for evaluation: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv"}} Datasource for training: + // {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", + // "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}} DataRearrangement *string - // A JSON string that represents the schema for an Amazon S3 DataSource. The + // A JSON string that represents the schema for an Amazon S3 DataSource . The // DataSchema defines the structure of the observation data in the data file(s) - // referenced in the DataSource. You must provide either the DataSchema or the - // DataSchemaLocationS3. Define your DataSchema as a series of key-value pairs. + // referenced in the DataSource . You must provide either the DataSchema or the + // DataSchemaLocationS3 . Define your DataSchema as a series of key-value pairs. // attributes and excludedVariableNames have an array of key-value pairs for their - // value. Use the following format to define your DataSchema. { "version": "1.0", + // value. Use the following format to define your DataSchema . { "version": "1.0", // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", // "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, // "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", @@ -947,7 +859,7 @@ type S3DataSpec struct { DataSchema *string // Describes the schema location in Amazon S3. You must provide either the - // DataSchema or the DataSchemaLocationS3. + // DataSchema or the DataSchemaLocationS3 . DataSchemaLocationS3 *string noSmithyDocumentSerde diff --git a/service/macie/api_client.go b/service/macie/api_client.go index af881bb136a..2b7e93ac63e 100644 --- a/service/macie/api_client.go +++ b/service/macie/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/macie/api_op_AssociateS3Resources.go b/service/macie/api_op_AssociateS3Resources.go index b954ea7aad9..9f5b8b6b5de 100644 --- a/service/macie/api_op_AssociateS3Resources.go +++ b/service/macie/api_op_AssociateS3Resources.go @@ -14,9 +14,9 @@ import ( // (Discontinued) Associates specified S3 resources with Amazon Macie Classic for // monitoring and data classification. If memberAccountId isn't specified, the // action associates specified S3 resources with Macie Classic for the current -// Macie Classic administrator account. If memberAccountId is specified, the action -// associates specified S3 resources with Macie Classic for the specified member -// account. +// Macie Classic administrator account. If memberAccountId is specified, the +// action associates specified S3 resources with Macie Classic for the specified +// member account. func (c *Client) AssociateS3Resources(ctx context.Context, params *AssociateS3ResourcesInput, optFns ...func(*Options)) (*AssociateS3ResourcesOutput, error) { if params == nil { params = &AssociateS3ResourcesInput{} @@ -40,8 +40,8 @@ type AssociateS3ResourcesInput struct { // This member is required. S3Resources []types.S3ResourceClassification - // (Discontinued) The ID of the Amazon Macie Classic member account whose resources - // you want to associate with Macie Classic. + // (Discontinued) The ID of the Amazon Macie Classic member account whose + // resources you want to associate with Macie Classic. MemberAccountId *string noSmithyDocumentSerde diff --git a/service/macie/api_op_DisassociateS3Resources.go b/service/macie/api_op_DisassociateS3Resources.go index 8f68f9b8e45..9438ccf74cf 100644 --- a/service/macie/api_op_DisassociateS3Resources.go +++ b/service/macie/api_op_DisassociateS3Resources.go @@ -39,8 +39,8 @@ type DisassociateS3ResourcesInput struct { // This member is required. AssociatedS3Resources []types.S3Resource - // (Discontinued) The ID of the Amazon Macie Classic member account whose resources - // you want to remove from being monitored by Macie Classic. + // (Discontinued) The ID of the Amazon Macie Classic member account whose + // resources you want to remove from being monitored by Macie Classic. MemberAccountId *string noSmithyDocumentSerde diff --git a/service/macie/api_op_ListMemberAccounts.go b/service/macie/api_op_ListMemberAccounts.go index c6894008c23..2bc973c3b91 100644 --- a/service/macie/api_op_ListMemberAccounts.go +++ b/service/macie/api_op_ListMemberAccounts.go @@ -35,8 +35,8 @@ type ListMemberAccountsInput struct { // you want in the response. The default value is 250. MaxResults *int32 - // (Discontinued) Use this parameter when paginating results. Set the value of this - // parameter to null on your first call to the ListMemberAccounts action. + // (Discontinued) Use this parameter when paginating results. Set the value of + // this parameter to null on your first call to the ListMemberAccounts action. // Subsequent calls to the action fill nextToken in the request with the value of // nextToken from the previous response to continue listing data. NextToken *string @@ -51,10 +51,10 @@ type ListMemberAccountsOutput struct { // this list. MemberAccounts []types.MemberAccount - // (Discontinued) When a response is generated, if there is more data to be listed, - // this parameter is present in the response and contains the value to use for the - // nextToken parameter in a subsequent pagination request. If there is no more data - // to be listed, this parameter is set to null. + // (Discontinued) When a response is generated, if there is more data to be + // listed, this parameter is present in the response and contains the value to use + // for the nextToken parameter in a subsequent pagination request. If there is no + // more data to be listed, this parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/macie/api_op_ListS3Resources.go b/service/macie/api_op_ListS3Resources.go index 25fddeb8ebe..30d60e6ee9d 100644 --- a/service/macie/api_op_ListS3Resources.go +++ b/service/macie/api_op_ListS3Resources.go @@ -13,10 +13,10 @@ import ( ) // (Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. -// If memberAccountId isn't specified, the action lists the S3 resources associated -// with Macie Classic for the current Macie Classic administrator account. If -// memberAccountId is specified, the action lists the S3 resources associated with -// Macie Classic for the specified member account. +// If memberAccountId isn't specified, the action lists the S3 resources +// associated with Macie Classic for the current Macie Classic administrator +// account. If memberAccountId is specified, the action lists the S3 resources +// associated with Macie Classic for the specified member account. func (c *Client) ListS3Resources(ctx context.Context, params *ListS3ResourcesInput, optFns ...func(*Options)) (*ListS3ResourcesOutput, error) { if params == nil { params = &ListS3ResourcesInput{} @@ -42,10 +42,10 @@ type ListS3ResourcesInput struct { // resources you want to list. MemberAccountId *string - // (Discontinued) Use this parameter when paginating results. Set its value to null - // on your first call to the ListS3Resources action. Subsequent calls to the action - // fill nextToken in the request with the value of nextToken from the previous - // response to continue listing data. + // (Discontinued) Use this parameter when paginating results. Set its value to + // null on your first call to the ListS3Resources action. Subsequent calls to the + // action fill nextToken in the request with the value of nextToken from the + // previous response to continue listing data. NextToken *string noSmithyDocumentSerde @@ -53,10 +53,10 @@ type ListS3ResourcesInput struct { type ListS3ResourcesOutput struct { - // (Discontinued) When a response is generated, if there is more data to be listed, - // this parameter is present in the response and contains the value to use for the - // nextToken parameter in a subsequent pagination request. If there is no more data - // to be listed, this parameter is set to null. + // (Discontinued) When a response is generated, if there is more data to be + // listed, this parameter is present in the response and contains the value to use + // for the nextToken parameter in a subsequent pagination request. If there is no + // more data to be listed, this parameter is set to null. NextToken *string // (Discontinued) A list of the associated S3 resources returned by the action. diff --git a/service/macie/doc.go b/service/macie/doc.go index fd0a75428a6..7a233c38bf5 100644 --- a/service/macie/doc.go +++ b/service/macie/doc.go @@ -3,12 +3,12 @@ // Package macie provides the API client, operations, and parameter types for // Amazon Macie. // -// Amazon Macie Classic Amazon Macie Classic has been discontinued and is no longer -// available. A new Amazon Macie is now available with significant design +// Amazon Macie Classic Amazon Macie Classic has been discontinued and is no +// longer available. A new Amazon Macie is now available with significant design // improvements and additional features, at a lower price and in most Amazon Web // Services Regions. We encourage you to take advantage of the new and improved // features, and benefit from the reduced cost. To learn about features and pricing -// for the new Macie, see Amazon Macie (http://aws.amazon.com/macie/). To learn how -// to use the new Macie, see the Amazon Macie User Guide -// (https://docs.aws.amazon.com/macie/latest/user/what-is-macie.html). +// for the new Macie, see Amazon Macie (http://aws.amazon.com/macie/) . To learn +// how to use the new Macie, see the Amazon Macie User Guide (https://docs.aws.amazon.com/macie/latest/user/what-is-macie.html) +// . package macie diff --git a/service/macie/types/errors.go b/service/macie/types/errors.go index 7455fb386ef..8c8b0494ddd 100644 --- a/service/macie/types/errors.go +++ b/service/macie/types/errors.go @@ -64,8 +64,8 @@ func (e *InternalException) ErrorCode() string { } func (e *InternalException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// (Discontinued) The request was rejected because an invalid or out-of-range value -// was supplied for an input parameter. +// (Discontinued) The request was rejected because an invalid or out-of-range +// value was supplied for an input parameter. type InvalidInputException struct { Message *string @@ -94,9 +94,9 @@ func (e *InvalidInputException) ErrorCode() string { } func (e *InvalidInputException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// (Discontinued) The request was rejected because it attempted to create resources -// beyond the current Amazon Web Services account quotas. The error code describes -// the quota exceeded. +// (Discontinued) The request was rejected because it attempted to create +// resources beyond the current Amazon Web Services account quotas. The error code +// describes the quota exceeded. type LimitExceededException struct { Message *string diff --git a/service/macie/types/types.go b/service/macie/types/types.go index 5457aea78c5..fe3b9c99be5 100644 --- a/service/macie/types/types.go +++ b/service/macie/types/types.go @@ -27,8 +27,8 @@ type ClassificationType struct { } // (Discontinued) The classification type that Amazon Macie Classic applies to the -// associated S3 resources. At least one of the classification types (oneTime or -// continuous) must be specified. +// associated S3 resources. At least one of the classification types ( oneTime or +// continuous ) must be specified. type ClassificationTypeUpdate struct { // (Discontinued) A continuous classification of the objects that are added to a @@ -88,8 +88,8 @@ type S3Resource struct { // (Discontinued) The S3 resources that you want to associate with Amazon Macie // Classic for monitoring and data classification. This data type is used as a -// request parameter in the AssociateS3Resources action and a response parameter in -// the ListS3Resources action. +// request parameter in the AssociateS3Resources action and a response parameter +// in the ListS3Resources action. type S3ResourceClassification struct { // (Discontinued) The name of the S3 bucket that you want to associate with Amazon @@ -98,8 +98,8 @@ type S3ResourceClassification struct { // This member is required. BucketName *string - // (Discontinued) The classification type that you want to specify for the resource - // associated with Amazon Macie Classic. + // (Discontinued) The classification type that you want to specify for the + // resource associated with Amazon Macie Classic. // // This member is required. ClassificationType *ClassificationType diff --git a/service/macie2/api_client.go b/service/macie2/api_client.go index 49e715a1c84..456c28c036f 100644 --- a/service/macie2/api_client.go +++ b/service/macie2/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/macie2/api_op_BatchGetCustomDataIdentifiers.go b/service/macie2/api_op_BatchGetCustomDataIdentifiers.go index 2e0ba5e2710..ed05e108451 100644 --- a/service/macie2/api_op_BatchGetCustomDataIdentifiers.go +++ b/service/macie2/api_op_BatchGetCustomDataIdentifiers.go @@ -42,9 +42,9 @@ type BatchGetCustomDataIdentifiersOutput struct { // criteria specified in the request. CustomDataIdentifiers []types.BatchGetCustomDataIdentifierSummary - // An array of custom data identifier IDs, one for each custom data identifier that - // was specified in the request but doesn't correlate to an existing custom data - // identifier. + // An array of custom data identifier IDs, one for each custom data identifier + // that was specified in the request but doesn't correlate to an existing custom + // data identifier. NotFoundIdentifierIds []string // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_CreateAllowList.go b/service/macie2/api_op_CreateAllowList.go index 8744c877b7b..9bfe08682a9 100644 --- a/service/macie2/api_op_CreateAllowList.go +++ b/service/macie2/api_op_CreateAllowList.go @@ -30,8 +30,8 @@ func (c *Client) CreateAllowList(ctx context.Context, params *CreateAllowListInp type CreateAllowListInput struct { - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. // // This member is required. ClientToken *string diff --git a/service/macie2/api_op_CreateClassificationJob.go b/service/macie2/api_op_CreateClassificationJob.go index 501bd4a2f17..7f027e150d3 100644 --- a/service/macie2/api_op_CreateClassificationJob.go +++ b/service/macie2/api_op_CreateClassificationJob.go @@ -30,21 +30,18 @@ func (c *Client) CreateClassificationJob(ctx context.Context, params *CreateClas type CreateClassificationJobInput struct { - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. // // This member is required. ClientToken *string // The schedule for running the job. Valid values are: - // - // * ONE_TIME - Run the job - // only once. If you specify this value, don't specify a value for the - // scheduleFrequency property. - // - // * SCHEDULED - Run the job on a daily, weekly, or - // monthly basis. If you specify this value, use the scheduleFrequency property to - // define the recurrence pattern for the job. + // - ONE_TIME - Run the job only once. If you specify this value, don't specify + // a value for the scheduleFrequency property. + // - SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you + // specify this value, use the scheduleFrequency property to define the recurrence + // pattern for the job. // // This member is required. JobType types.JobType @@ -74,15 +71,15 @@ type CreateClassificationJobInput struct { // characters. Description *string - // For a recurring job, specifies whether to analyze all existing, eligible objects - // immediately after the job is created (true). To analyze only those objects that - // are created or changed after you create the job and before the job's first - // scheduled run, set this value to false. If you configure the job to run only - // once, don't specify a value for this property. + // For a recurring job, specifies whether to analyze all existing, eligible + // objects immediately after the job is created (true). To analyze only those + // objects that are created or changed after you create the job and before the + // job's first scheduled run, set this value to false. If you configure the job to + // run only once, don't specify a value for this property. InitialRun bool - // An array of unique identifiers, one for each managed data identifier for the job - // to include (use) or exclude (not use) when it analyzes data. Inclusion or + // An array of unique identifiers, one for each managed data identifier for the + // job to include (use) or exclude (not use) when it analyzes data. Inclusion or // exclusion depends on the managed data identifier selection type that you specify // for the job (managedDataIdentifierSelector). To retrieve a list of valid values // for this property, use the ListManagedDataIdentifiers operation. @@ -90,28 +87,21 @@ type CreateClassificationJobInput struct { // The selection type to apply when determining which managed data identifiers the // job uses to analyze data. Valid values are: - // - // * ALL - Use all the managed data - // identifiers that Amazon Macie provides. If you specify this value, don't specify - // any values for the managedDataIdentifierIds property. - // - // * EXCLUDE - Use all the - // managed data identifiers that Macie provides except the managed data identifiers - // specified by the managedDataIdentifierIds property. - // - // * INCLUDE - Use only the - // managed data identifiers specified by the managedDataIdentifierIds property. - // - // * - // NONE - Don't use any managed data identifiers. If you specify this value, - // specify at least one custom data identifier for the job - // (customDataIdentifierIds) and don't specify any values for the - // managedDataIdentifierIds property. - // - // If you don't specify a value for this - // property, the job uses all managed data identifiers. If you don't specify a - // value for this property or you specify ALL or EXCLUDE for a recurring job, the - // job also uses new managed data identifiers as they are released. + // - ALL - Use all the managed data identifiers that Amazon Macie provides. If + // you specify this value, don't specify any values for the + // managedDataIdentifierIds property. + // - EXCLUDE - Use all the managed data identifiers that Macie provides except + // the managed data identifiers specified by the managedDataIdentifierIds property. + // - INCLUDE - Use only the managed data identifiers specified by the + // managedDataIdentifierIds property. + // - NONE - Don't use any managed data identifiers. If you specify this value, + // specify at least one custom data identifier for the job + // (customDataIdentifierIds) and don't specify any values for the + // managedDataIdentifierIds property. + // If you don't specify a value for this property, the job uses all managed data + // identifiers. If you don't specify a value for this property or you specify ALL + // or EXCLUDE for a recurring job, the job also uses new managed data identifiers + // as they are released. ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector // The sampling depth, as a percentage, for the job to apply when processing diff --git a/service/macie2/api_op_CreateCustomDataIdentifier.go b/service/macie2/api_op_CreateCustomDataIdentifier.go index 10273bdf6c3..f50d844f08f 100644 --- a/service/macie2/api_op_CreateCustomDataIdentifier.go +++ b/service/macie2/api_op_CreateCustomDataIdentifier.go @@ -40,14 +40,14 @@ type CreateCustomDataIdentifierInput struct { // This member is required. Name *string - // The regular expression (regex) that defines the pattern to match. The expression - // can contain as many as 512 characters. + // The regular expression (regex) that defines the pattern to match. The + // expression can contain as many as 512 characters. // // This member is required. Regex *string - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string // A custom description of the custom data identifier. The description can contain diff --git a/service/macie2/api_op_CreateFindingsFilter.go b/service/macie2/api_op_CreateFindingsFilter.go index d1b32f98d73..7cff32fe77d 100644 --- a/service/macie2/api_op_CreateFindingsFilter.go +++ b/service/macie2/api_op_CreateFindingsFilter.go @@ -51,8 +51,8 @@ type CreateFindingsFilterInput struct { // This member is required. Name *string - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string // A custom description of the filter. The description can contain as many as 512 @@ -67,8 +67,8 @@ type CreateFindingsFilterInput struct { // findings, relative to other filters that are also applied to the findings. Position int32 - // A map of key-value pairs that specifies the tags to associate with the filter. A - // findings filter can have a maximum of 50 tags. Each tag consists of a tag key + // A map of key-value pairs that specifies the tags to associate with the filter. + // A findings filter can have a maximum of 50 tags. Each tag consists of a 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 map[string]string diff --git a/service/macie2/api_op_DeclineInvitations.go b/service/macie2/api_op_DeclineInvitations.go index 6bf75fbf315..821cac9d7c5 100644 --- a/service/macie2/api_op_DeclineInvitations.go +++ b/service/macie2/api_op_DeclineInvitations.go @@ -41,9 +41,9 @@ type DeclineInvitationsInput struct { type DeclineInvitationsOutput struct { - // An array of objects, one for each account whose invitation hasn't been declined. - // Each object identifies the account and explains why the request hasn't been - // processed for that account. + // An array of objects, one for each account whose invitation hasn't been + // declined. Each object identifies the account and explains why the request hasn't + // been processed for that account. UnprocessedAccounts []types.UnprocessedAccount // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_DescribeBuckets.go b/service/macie2/api_op_DescribeBuckets.go index 2fe8bf969be..cd926dbe87a 100644 --- a/service/macie2/api_op_DescribeBuckets.go +++ b/service/macie2/api_op_DescribeBuckets.go @@ -34,8 +34,8 @@ type DescribeBucketsInput struct { // The criteria to use to filter the query results. Criteria map[string]types.BucketCriteriaAdditionalProperties - // The maximum number of items to include in each page of the response. The default - // value is 50. + // The maximum number of items to include in each page of the response. The + // default value is 50. MaxResults int32 // The nextToken string that specifies which page of results to return in a @@ -134,8 +134,8 @@ var _ DescribeBucketsAPIClient = (*Client)(nil) // DescribeBucketsPaginatorOptions is the paginator options for DescribeBuckets type DescribeBucketsPaginatorOptions struct { - // The maximum number of items to include in each page of the response. The default - // value is 50. + // The maximum number of items to include in each page of the response. The + // default value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/macie2/api_op_DescribeClassificationJob.go b/service/macie2/api_op_DescribeClassificationJob.go index 2a8635f78bd..b49518d71e8 100644 --- a/service/macie2/api_op_DescribeClassificationJob.go +++ b/service/macie2/api_op_DescribeClassificationJob.go @@ -52,9 +52,9 @@ type DescribeClassificationJobOutput struct { // created. CreatedAt *time.Time - // An array of unique identifiers, one for each custom data identifier that the job - // uses when it analyzes data. This value is null if the job uses only managed data - // identifiers to analyze data. + // An array of unique identifiers, one for each custom data identifier that the + // job uses when it analyzes data. This value is null if the job uses only managed + // data identifiers to analyze data. CustomDataIdentifierIds []string // The custom description of the job. @@ -74,41 +74,27 @@ type DescribeClassificationJobOutput struct { JobId *string // The current status of the job. Possible values are: - // - // * CANCELLED - You cancelled - // the job or, if it's a one-time job, you paused the job and didn't resume it - // within 30 days. - // - // * COMPLETE - For a one-time job, Amazon Macie finished - // processing the data specified for the job. This value doesn't apply to recurring - // jobs. - // - // * IDLE - For a recurring job, the previous scheduled run is complete and - // the next scheduled run is pending. This value doesn't apply to one-time jobs. - // - // * - // PAUSED - Macie started running the job but additional processing would exceed - // the monthly sensitive data discovery quota for your account or one or more - // member accounts that the job analyzes data for. - // - // * RUNNING - For a one-time job, - // the job is in progress. For a recurring job, a scheduled run is in progress. - // - // * - // USER_PAUSED - You paused the job. If you paused the job while it had a status of - // RUNNING and you don't resume it within 30 days of pausing it, the job or job run - // will expire and be cancelled, depending on the job's type. To check the - // expiration date, refer to the UserPausedDetails.jobExpiresAt property. + // - CANCELLED - You cancelled the job or, if it's a one-time job, you paused + // the job and didn't resume it within 30 days. + // - COMPLETE - For a one-time job, Amazon Macie finished processing the data + // specified for the job. This value doesn't apply to recurring jobs. + // - IDLE - For a recurring job, the previous scheduled run is complete and the + // next scheduled run is pending. This value doesn't apply to one-time jobs. + // - PAUSED - Macie started running the job but additional processing would + // exceed the monthly sensitive data discovery quota for your account or one or + // more member accounts that the job analyzes data for. + // - RUNNING - For a one-time job, the job is in progress. For a recurring job, + // a scheduled run is in progress. + // - USER_PAUSED - You paused the job. If you paused the job while it had a + // status of RUNNING and you don't resume it within 30 days of pausing it, the job + // or job run will expire and be cancelled, depending on the job's type. To check + // the expiration date, refer to the UserPausedDetails.jobExpiresAt property. JobStatus types.JobStatus // The schedule for running the job. Possible values are: - // - // * ONE_TIME - The job - // runs only once. - // - // * SCHEDULED - The job runs on a daily, weekly, or monthly - // basis. The scheduleFrequency property indicates the recurrence pattern for the - // job. + // - ONE_TIME - The job runs only once. + // - SCHEDULED - The job runs on a daily, weekly, or monthly basis. The + // scheduleFrequency property indicates the recurrence pattern for the job. JobType types.JobType // Specifies whether any account- or bucket-level access errors occurred when the @@ -116,8 +102,8 @@ type DescribeClassificationJobOutput struct { // most recent run. LastRunErrorStatus *types.LastRunErrorStatus - // The date and time, in UTC and extended ISO 8601 format, when the job started. If - // the job is a recurring job, this value indicates when the most recent run + // The date and time, in UTC and extended ISO 8601 format, when the job started. + // If the job is a recurring job, this value indicates when the most recent run // started or, if the job hasn't run yet, when the job was created. LastRunTime *time.Time @@ -131,23 +117,15 @@ type DescribeClassificationJobOutput struct { // The selection type that determines which managed data identifiers the job uses // to analyze data. Possible values are: - // - // * ALL - Use all the managed data - // identifiers that Amazon Macie provides. - // - // * EXCLUDE - Use all the managed data - // identifiers that Macie provides except the managed data identifiers specified by - // the managedDataIdentifierIds property. - // - // * INCLUDE - Use only the managed data - // identifiers specified by the managedDataIdentifierIds property. - // - // * NONE - Don't - // use any managed data identifiers. - // - // If this value is null, the job uses all - // managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring - // job, the job also uses new managed data identifiers as they are released. + // - ALL - Use all the managed data identifiers that Amazon Macie provides. + // - EXCLUDE - Use all the managed data identifiers that Macie provides except + // the managed data identifiers specified by the managedDataIdentifierIds property. + // - INCLUDE - Use only the managed data identifiers specified by the + // managedDataIdentifierIds property. + // - NONE - Don't use any managed data identifiers. + // If this value is null, the job uses all managed data identifiers. If this value + // is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data + // identifiers as they are released. ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector // The custom name of the job. @@ -165,8 +143,8 @@ type DescribeClassificationJobOutput struct { // configured to run only once. ScheduleFrequency *types.JobScheduleFrequency - // The number of times that the job has run and processing statistics for the job's - // current run. + // The number of times that the job has run and processing statistics for the + // job's current run. Statistics *types.Statistics // A map of key-value pairs that specifies which tags (keys and values) are diff --git a/service/macie2/api_op_DescribeOrganizationConfiguration.go b/service/macie2/api_op_DescribeOrganizationConfiguration.go index be4a375422e..12e5439d74e 100644 --- a/service/macie2/api_op_DescribeOrganizationConfiguration.go +++ b/service/macie2/api_op_DescribeOrganizationConfiguration.go @@ -37,8 +37,8 @@ type DescribeOrganizationConfigurationOutput struct { // added to the organization. AutoEnable bool - // Specifies whether the maximum number of Amazon Macie member accounts are part of - // the organization. + // Specifies whether the maximum number of Amazon Macie member accounts are part + // of the organization. MaxAccountLimitReached bool // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_EnableMacie.go b/service/macie2/api_op_EnableMacie.go index 94cf8d0d5b8..6958ce0e90b 100644 --- a/service/macie2/api_op_EnableMacie.go +++ b/service/macie2/api_op_EnableMacie.go @@ -31,8 +31,8 @@ func (c *Client) EnableMacie(ctx context.Context, params *EnableMacieInput, optF type EnableMacieInput struct { - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string // Specifies how often to publish updates to policy findings for the account. This diff --git a/service/macie2/api_op_EnableOrganizationAdminAccount.go b/service/macie2/api_op_EnableOrganizationAdminAccount.go index 6cab8b01bb7..a3a97b63d3f 100644 --- a/service/macie2/api_op_EnableOrganizationAdminAccount.go +++ b/service/macie2/api_op_EnableOrganizationAdminAccount.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Designates an account as the delegated Amazon Macie administrator account for an -// organization in Organizations. +// Designates an account as the delegated Amazon Macie administrator account for +// an organization in Organizations. func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *EnableOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableOrganizationAdminAccountOutput, error) { if params == nil { params = &EnableOrganizationAdminAccountInput{} @@ -30,14 +30,14 @@ func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *Ena type EnableOrganizationAdminAccountInput struct { - // The Amazon Web Services account ID for the account to designate as the delegated - // Amazon Macie administrator account for the organization. + // The Amazon Web Services account ID for the account to designate as the + // delegated Amazon Macie administrator account for the organization. // // This member is required. AdminAccountId *string - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string noSmithyDocumentSerde diff --git a/service/macie2/api_op_GetAutomatedDiscoveryConfiguration.go b/service/macie2/api_op_GetAutomatedDiscoveryConfiguration.go index ded574ad49c..5ca8ca85060 100644 --- a/service/macie2/api_op_GetAutomatedDiscoveryConfiguration.go +++ b/service/macie2/api_op_GetAutomatedDiscoveryConfiguration.go @@ -40,19 +40,20 @@ type GetAutomatedDiscoveryConfigurationOutput struct { // specifies S3 buckets to exclude from automated sensitive data discovery. ClassificationScopeId *string - // The date and time, in UTC and extended ISO 8601 format, when automated sensitive - // data discovery was most recently disabled for the account. This value is null if - // automated sensitive data discovery wasn't enabled and subsequently disabled for - // the account. + // The date and time, in UTC and extended ISO 8601 format, when automated + // sensitive data discovery was most recently disabled for the account. This value + // is null if automated sensitive data discovery wasn't enabled and subsequently + // disabled for the account. DisabledAt *time.Time - // The date and time, in UTC and extended ISO 8601 format, when automated sensitive - // data discovery was initially enabled for the account. This value is null if - // automated sensitive data discovery has never been enabled for the account. + // The date and time, in UTC and extended ISO 8601 format, when automated + // sensitive data discovery was initially enabled for the account. This value is + // null if automated sensitive data discovery has never been enabled for the + // account. FirstEnabledAt *time.Time - // The date and time, in UTC and extended ISO 8601 format, when automated sensitive - // data discovery was most recently enabled or disabled for the account. + // The date and time, in UTC and extended ISO 8601 format, when automated + // sensitive data discovery was most recently enabled or disabled for the account. LastUpdatedAt *time.Time // The unique identifier for the sensitivity inspection template that's used when diff --git a/service/macie2/api_op_GetBucketStatistics.go b/service/macie2/api_op_GetBucketStatistics.go index b5f4dbde76b..c92cfaa6eb2 100644 --- a/service/macie2/api_op_GetBucketStatistics.go +++ b/service/macie2/api_op_GetBucketStatistics.go @@ -42,8 +42,8 @@ type GetBucketStatisticsOutput struct { // The total number of buckets. BucketCount int64 - // The total number of buckets that are publicly accessible due to a combination of - // permissions settings for each bucket. + // The total number of buckets that are publicly accessible due to a combination + // of permissions settings for each bucket. BucketCountByEffectivePermission *types.BucketCountByEffectivePermission // The total number of buckets whose settings do or don't specify default @@ -59,9 +59,9 @@ type GetBucketStatisticsOutput struct { // CloudFront origin access controls (OACs). BucketCountBySharedAccessType *types.BucketCountBySharedAccessType - // The aggregated sensitive data discovery statistics for the buckets. If automated - // sensitive data discovery is currently disabled for your account, the value for - // each statistic is 0. + // The aggregated sensitive data discovery statistics for the buckets. If + // automated sensitive data discovery is currently disabled for your account, the + // value for each statistic is 0. BucketStatisticsBySensitivity *types.BucketStatisticsBySensitivity // The total number of objects that Amazon Macie can analyze in the buckets. These @@ -102,9 +102,9 @@ type GetBucketStatisticsOutput struct { // extension for a supported file or storage format. UnclassifiableObjectCount *types.ObjectLevelStatistics - // The total storage size, in bytes, of the objects that Amazon Macie can't analyze - // in the buckets. These objects don't use a supported storage class or don't have - // a file name extension for a supported file or storage format. + // The total storage size, in bytes, of the objects that Amazon Macie can't + // analyze in the buckets. These objects don't use a supported storage class or + // don't have a file name extension for a supported file or storage format. UnclassifiableObjectSizeInBytes *types.ObjectLevelStatistics // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_GetCustomDataIdentifier.go b/service/macie2/api_op_GetCustomDataIdentifier.go index 40ab7715063..5335bf29f5c 100644 --- a/service/macie2/api_op_GetCustomDataIdentifier.go +++ b/service/macie2/api_op_GetCustomDataIdentifier.go @@ -47,9 +47,9 @@ type GetCustomDataIdentifierOutput struct { // identifier was created. CreatedAt *time.Time - // Specifies whether the custom data identifier was deleted. If you delete a custom - // data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft - // deletes the identifier. + // Specifies whether the custom data identifier was deleted. If you delete a + // custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it + // soft deletes the identifier. Deleted bool // The custom description of the custom data identifier. diff --git a/service/macie2/api_op_GetFindingStatistics.go b/service/macie2/api_op_GetFindingStatistics.go index 96393296e1d..b1309ad43b3 100644 --- a/service/macie2/api_op_GetFindingStatistics.go +++ b/service/macie2/api_op_GetFindingStatistics.go @@ -30,19 +30,14 @@ func (c *Client) GetFindingStatistics(ctx context.Context, params *GetFindingSta type GetFindingStatisticsInput struct { // The finding property to use to group the query results. Valid values are: - // - // * - // classificationDetails.jobId - The unique identifier for the classification job - // that produced the finding. - // - // * resourcesAffected.s3Bucket.name - The name of the - // S3 bucket that the finding applies to. - // - // * severity.description - The severity - // level of the finding, such as High or Medium. - // - // * type - The type of finding, - // such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal. + // - classificationDetails.jobId - The unique identifier for the classification + // job that produced the finding. + // - resourcesAffected.s3Bucket.name - The name of the S3 bucket that the + // finding applies to. + // - severity.description - The severity level of the finding, such as High or + // Medium. + // - type - The type of finding, such as Policy:IAMUser/S3BucketPublic and + // SensitiveData:S3Object/Personal. // // This member is required. GroupBy types.GroupBy diff --git a/service/macie2/api_op_GetFindings.go b/service/macie2/api_op_GetFindings.go index 1ac1d8165ed..a60154e1795 100644 --- a/service/macie2/api_op_GetFindings.go +++ b/service/macie2/api_op_GetFindings.go @@ -43,8 +43,8 @@ type GetFindingsInput struct { type GetFindingsOutput struct { - // An array of objects, one for each finding that matches the criteria specified in - // the request. + // An array of objects, one for each finding that matches the criteria specified + // in the request. Findings []types.Finding // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_GetInvitationsCount.go b/service/macie2/api_op_GetInvitationsCount.go index da2e1de31db..a5e1e78eb1e 100644 --- a/service/macie2/api_op_GetInvitationsCount.go +++ b/service/macie2/api_op_GetInvitationsCount.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the count of Amazon Macie membership invitations that were received by -// an account. +// Retrieves the count of Amazon Macie membership invitations that were received +// by an account. func (c *Client) GetInvitationsCount(ctx context.Context, params *GetInvitationsCountInput, optFns ...func(*Options)) (*GetInvitationsCountOutput, error) { if params == nil { params = &GetInvitationsCountInput{} @@ -33,8 +33,8 @@ type GetInvitationsCountInput struct { type GetInvitationsCountOutput struct { - // The total number of invitations that were received by the account, not including - // the currently accepted invitation. + // The total number of invitations that were received by the account, not + // including the currently accepted invitation. InvitationsCount int64 // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_GetMacieSession.go b/service/macie2/api_op_GetMacieSession.go index 6c348f3719d..a8fa8885b9c 100644 --- a/service/macie2/api_op_GetMacieSession.go +++ b/service/macie2/api_op_GetMacieSession.go @@ -48,8 +48,8 @@ type GetMacieSessionOutput struct { // account. ServiceRole *string - // The current status of the Amazon Macie account. Possible values are: PAUSED, the - // account is enabled but all Macie activities are suspended (paused) for the + // The current status of the Amazon Macie account. Possible values are: PAUSED, + // the account is enabled but all Macie activities are suspended (paused) for the // account; and, ENABLED, the account is enabled and all Macie activities are // enabled for the account. Status types.MacieStatus diff --git a/service/macie2/api_op_GetMember.go b/service/macie2/api_op_GetMember.go index b8619a2d2b3..15a4dd56ed8 100644 --- a/service/macie2/api_op_GetMember.go +++ b/service/macie2/api_op_GetMember.go @@ -64,8 +64,8 @@ type GetMemberOutput struct { // retained only for backward compatibility. MasterAccountId *string - // The current status of the relationship between the account and the administrator - // account. + // The current status of the relationship between the account and the + // administrator account. RelationshipStatus types.RelationshipStatus // A map of key-value pairs that specifies which tags (keys and values) are diff --git a/service/macie2/api_op_GetSensitiveDataOccurrences.go b/service/macie2/api_op_GetSensitiveDataOccurrences.go index 283bfe6fc88..107a10ca900 100644 --- a/service/macie2/api_op_GetSensitiveDataOccurrences.go +++ b/service/macie2/api_op_GetSensitiveDataOccurrences.go @@ -56,16 +56,12 @@ type GetSensitiveDataOccurrencesOutput struct { // The status of the request to retrieve occurrences of sensitive data reported by // the finding. Possible values are: - // - // * ERROR - An error occurred when Amazon Macie - // attempted to locate, retrieve, or encrypt the sensitive data. The error value - // indicates the nature of the error that occurred. - // - // * PROCESSING - Macie is - // processing the request. - // - // * SUCCESS - Macie successfully located, retrieved, and - // encrypted the sensitive data. + // - ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, + // or encrypt the sensitive data. The error value indicates the nature of the error + // that occurred. + // - PROCESSING - Macie is processing the request. + // - SUCCESS - Macie successfully located, retrieved, and encrypted the + // sensitive data. Status types.RevealRequestStatus // Metadata pertaining to the operation's result. @@ -158,9 +154,9 @@ type FindingRevealedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FindingRevealedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FindingRevealedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -200,9 +196,9 @@ func NewFindingRevealedWaiter(client GetSensitiveDataOccurrencesAPIClient, optFn } } -// Wait calls the waiter function for FindingRevealed waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for FindingRevealed waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *FindingRevealedWaiter) Wait(ctx context.Context, params *GetSensitiveDataOccurrencesInput, maxWaitDur time.Duration, optFns ...func(*FindingRevealedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go b/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go index d9f5428eec0..aee1ca4756c 100644 --- a/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go +++ b/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go @@ -47,32 +47,22 @@ type GetSensitiveDataOccurrencesAvailabilityOutput struct { // Specifies why occurrences of sensitive data can't be retrieved for the finding. // Possible values are: - // - // * INVALID_CLASSIFICATION_RESULT - Amazon Macie can't - // verify the location of the sensitive data to retrieve. There isn't a - // corresponding sensitive data discovery result for the finding. Or the sensitive - // data discovery result specified by the - // ClassificationDetails.detailedResultsLocation field of the finding isn't - // available, is malformed or corrupted, or uses an unsupported storage format. - // - // * - // OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds - // the size quota for retrieving occurrences of sensitive data. - // - // * - // OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might - // have been renamed, moved, or deleted. Or the object was changed after Macie - // created the finding. - // - // * UNSUPPORTED_FINDING_TYPE - The specified finding isn't a - // sensitive data finding. - // - // * UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses - // a file or storage format that Macie doesn't support for retrieving occurrences - // of sensitive data. - // - // This value is null if sensitive data can be retrieved for - // the finding. + // - INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of + // the sensitive data to retrieve. There isn't a corresponding sensitive data + // discovery result for the finding. Or the sensitive data discovery result + // specified by the ClassificationDetails.detailedResultsLocation field of the + // finding isn't available, is malformed or corrupted, or uses an unsupported + // storage format. + // - OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object + // exceeds the size quota for retrieving occurrences of sensitive data. + // - OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object + // might have been renamed, moved, or deleted. Or the object was changed after + // Macie created the finding. + // - UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data + // finding. + // - UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage + // format that Macie doesn't support for retrieving occurrences of sensitive data. + // This value is null if sensitive data can be retrieved for the finding. Reasons []types.UnavailabilityReasonCode // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_GetUsageStatistics.go b/service/macie2/api_op_GetUsageStatistics.go index 8ba196a98c1..d643338ca0e 100644 --- a/service/macie2/api_op_GetUsageStatistics.go +++ b/service/macie2/api_op_GetUsageStatistics.go @@ -60,9 +60,9 @@ type GetUsageStatisticsOutput struct { // paginated response. This value is null if there are no additional pages. NextToken *string - // An array of objects that contains the results of the query. Each object contains - // the data for an account that matches the filter criteria specified in the - // request. + // An array of objects that contains the results of the query. Each object + // contains the data for an account that matches the filter criteria specified in + // the request. Records []types.UsageRecord // The inclusive time period that the usage data applies to. Possible values are: diff --git a/service/macie2/api_op_GetUsageTotals.go b/service/macie2/api_op_GetUsageTotals.go index d897779f78e..2a3a050c893 100644 --- a/service/macie2/api_op_GetUsageTotals.go +++ b/service/macie2/api_op_GetUsageTotals.go @@ -45,8 +45,8 @@ type GetUsageTotalsOutput struct { // the preceding 30 days. TimeRange types.TimeRange - // An array of objects that contains the results of the query. Each object contains - // the data for a specific usage metric. + // An array of objects that contains the results of the query. Each object + // contains the data for a specific usage metric. UsageTotals []types.UsageTotal // Metadata pertaining to the operation's result. diff --git a/service/macie2/api_op_ListClassificationJobs.go b/service/macie2/api_op_ListClassificationJobs.go index a2f14f9afdd..f4268c4b28e 100644 --- a/service/macie2/api_op_ListClassificationJobs.go +++ b/service/macie2/api_op_ListClassificationJobs.go @@ -48,8 +48,8 @@ type ListClassificationJobsInput struct { type ListClassificationJobsOutput struct { - // An array of objects, one for each job that matches the filter criteria specified - // in the request. + // An array of objects, one for each job that matches the filter criteria + // specified in the request. Items []types.JobSummary // The string to use in a subsequent request to get the next page of results in a diff --git a/service/macie2/api_op_ListFindingsFilters.go b/service/macie2/api_op_ListFindingsFilters.go index 9ab713aab24..77446719097 100644 --- a/service/macie2/api_op_ListFindingsFilters.go +++ b/service/macie2/api_op_ListFindingsFilters.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListFindingsFiltersMiddlewares(stack *middleware.St return nil } -// ListFindingsFiltersAPIClient is a client that implements the ListFindingsFilters -// operation. +// ListFindingsFiltersAPIClient is a client that implements the +// ListFindingsFilters operation. type ListFindingsFiltersAPIClient interface { ListFindingsFilters(context.Context, *ListFindingsFiltersInput, ...func(*Options)) (*ListFindingsFiltersOutput, error) } diff --git a/service/macie2/api_op_ListOrganizationAdminAccounts.go b/service/macie2/api_op_ListOrganizationAdminAccounts.go index eab8d8843cd..7dda796e54f 100644 --- a/service/macie2/api_op_ListOrganizationAdminAccounts.go +++ b/service/macie2/api_op_ListOrganizationAdminAccounts.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the delegated Amazon Macie administrator account for -// an organization in Organizations. +// Retrieves information about the delegated Amazon Macie administrator account +// for an organization in Organizations. func (c *Client) ListOrganizationAdminAccounts(ctx context.Context, params *ListOrganizationAdminAccountsInput, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error) { if params == nil { params = &ListOrganizationAdminAccountsInput{} diff --git a/service/macie2/api_op_ListResourceProfileArtifacts.go b/service/macie2/api_op_ListResourceProfileArtifacts.go index 13b6542690b..af27c3b38f3 100644 --- a/service/macie2/api_op_ListResourceProfileArtifacts.go +++ b/service/macie2/api_op_ListResourceProfileArtifacts.go @@ -45,13 +45,13 @@ type ListResourceProfileArtifactsInput struct { type ListResourceProfileArtifactsOutput struct { - // An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected - // for analysis. If Macie has analyzed more than 100 objects in the bucket, Macie - // populates the array based on the value for the ResourceProfileArtifact.sensitive - // field for an object: true (sensitive), followed by false (not sensitive). Macie - // then populates any remaining items in the array with information about objects - // where the value for the ResourceProfileArtifact.classificationResultStatus field - // is SKIPPED. + // An array of objects, one for each of 1-100 S3 objects that Amazon Macie + // selected for analysis. If Macie has analyzed more than 100 objects in the + // bucket, Macie populates the array based on the value for the + // ResourceProfileArtifact.sensitive field for an object: true (sensitive), + // followed by false (not sensitive). Macie then populates any remaining items in + // the array with information about objects where the value for the + // ResourceProfileArtifact.classificationResultStatus field is SKIPPED. Artifacts []types.ResourceProfileArtifact // The string to use in a subsequent request to get the next page of results in a diff --git a/service/macie2/api_op_ListResourceProfileDetections.go b/service/macie2/api_op_ListResourceProfileDetections.go index 732f4251943..15ccef7d254 100644 --- a/service/macie2/api_op_ListResourceProfileDetections.go +++ b/service/macie2/api_op_ListResourceProfileDetections.go @@ -48,10 +48,10 @@ type ListResourceProfileDetectionsInput struct { type ListResourceProfileDetectionsOutput struct { - // An array of objects, one for each type of sensitive data that Amazon Macie found - // in the bucket. Each object reports the number of occurrences of the specified - // type and provides information about the custom data identifier or managed data - // identifier that detected the data. + // An array of objects, one for each type of sensitive data that Amazon Macie + // found in the bucket. Each object reports the number of occurrences of the + // specified type and provides information about the custom data identifier or + // managed data identifier that detected the data. Detections []types.Detection // The string to use in a subsequent request to get the next page of results in a diff --git a/service/macie2/api_op_PutFindingsPublicationConfiguration.go b/service/macie2/api_op_PutFindingsPublicationConfiguration.go index a84a0acee8b..f8faff2dd1b 100644 --- a/service/macie2/api_op_PutFindingsPublicationConfiguration.go +++ b/service/macie2/api_op_PutFindingsPublicationConfiguration.go @@ -30,8 +30,8 @@ func (c *Client) PutFindingsPublicationConfiguration(ctx context.Context, params type PutFindingsPublicationConfigurationInput struct { - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string // The configuration settings that determine which findings to publish to Security diff --git a/service/macie2/api_op_SearchResources.go b/service/macie2/api_op_SearchResources.go index 819a284c211..384a49f4ff9 100644 --- a/service/macie2/api_op_SearchResources.go +++ b/service/macie2/api_op_SearchResources.go @@ -31,12 +31,12 @@ func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInp type SearchResourcesInput struct { - // The filter conditions that determine which S3 buckets to include or exclude from - // the query results. + // The filter conditions that determine which S3 buckets to include or exclude + // from the query results. BucketCriteria *types.SearchResourcesBucketCriteria - // The maximum number of items to include in each page of the response. The default - // value is 50. + // The maximum number of items to include in each page of the response. The + // default value is 50. MaxResults int32 // The nextToken string that specifies which page of results to return in a @@ -135,8 +135,8 @@ var _ SearchResourcesAPIClient = (*Client)(nil) // SearchResourcesPaginatorOptions is the paginator options for SearchResources type SearchResourcesPaginatorOptions struct { - // The maximum number of items to include in each page of the response. The default - // value is 50. + // The maximum number of items to include in each page of the response. The + // default value is 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/macie2/api_op_TagResource.go b/service/macie2/api_op_TagResource.go index ec5c51bb20e..f685dbb0844 100644 --- a/service/macie2/api_op_TagResource.go +++ b/service/macie2/api_op_TagResource.go @@ -34,10 +34,10 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // A map of key-value pairs that specifies the tags to associate with the resource. - // A resource can have a maximum of 50 tags. Each tag consists of a 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. + // A map of key-value pairs that specifies the tags to associate with the + // resource. A resource can have a maximum of 50 tags. Each tag consists of a 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. // // This member is required. Tags map[string]string diff --git a/service/macie2/api_op_TestCustomDataIdentifier.go b/service/macie2/api_op_TestCustomDataIdentifier.go index d7a845a1932..fc9845b01dc 100644 --- a/service/macie2/api_op_TestCustomDataIdentifier.go +++ b/service/macie2/api_op_TestCustomDataIdentifier.go @@ -28,8 +28,8 @@ func (c *Client) TestCustomDataIdentifier(ctx context.Context, params *TestCusto type TestCustomDataIdentifierInput struct { - // The regular expression (regex) that defines the pattern to match. The expression - // can contain as many as 512 characters. + // The regular expression (regex) that defines the pattern to match. The + // expression can contain as many as 512 characters. // // This member is required. Regex *string diff --git a/service/macie2/api_op_UpdateClassificationJob.go b/service/macie2/api_op_UpdateClassificationJob.go index f40dde2ad03..363166b90e6 100644 --- a/service/macie2/api_op_UpdateClassificationJob.go +++ b/service/macie2/api_op_UpdateClassificationJob.go @@ -35,29 +35,25 @@ type UpdateClassificationJobInput struct { JobId *string // The new status for the job. Valid values are: - // - // * CANCELLED - Stops the job - // permanently and cancels it. This value is valid only if the job's current status - // is IDLE, PAUSED, RUNNING, or USER_PAUSED. If you specify this value and the - // job's current status is RUNNING, Amazon Macie immediately begins to stop all - // processing tasks for the job. You can't resume or restart a job after you cancel - // it. - // - // * RUNNING - Resumes the job. This value is valid only if the job's current - // status is USER_PAUSED. If you paused the job while it was actively running and - // you specify this value less than 30 days after you paused the job, Macie - // immediately resumes processing from the point where you paused the job. - // Otherwise, Macie resumes the job according to the schedule and other settings - // for the job. - // - // * USER_PAUSED - Pauses the job temporarily. This value is valid - // only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify - // this value and the job's current status is RUNNING, Macie immediately begins to - // pause all processing tasks for the job. If you pause a one-time job and you - // don't resume it within 30 days, the job expires and Macie cancels the job. If - // you pause a recurring job when its status is RUNNING and you don't resume it - // within 30 days, the job run expires and Macie cancels the run. To check the - // expiration date, refer to the UserPausedDetails.jobExpiresAt property. + // - CANCELLED - Stops the job permanently and cancels it. This value is valid + // only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED. If + // you specify this value and the job's current status is RUNNING, Amazon Macie + // immediately begins to stop all processing tasks for the job. You can't resume or + // restart a job after you cancel it. + // - RUNNING - Resumes the job. This value is valid only if the job's current + // status is USER_PAUSED. If you paused the job while it was actively running and + // you specify this value less than 30 days after you paused the job, Macie + // immediately resumes processing from the point where you paused the job. + // Otherwise, Macie resumes the job according to the schedule and other settings + // for the job. + // - USER_PAUSED - Pauses the job temporarily. This value is valid only if the + // job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and + // the job's current status is RUNNING, Macie immediately begins to pause all + // processing tasks for the job. If you pause a one-time job and you don't resume + // it within 30 days, the job expires and Macie cancels the job. If you pause a + // recurring job when its status is RUNNING and you don't resume it within 30 days, + // the job run expires and Macie cancels the run. To check the expiration date, + // refer to the UserPausedDetails.jobExpiresAt property. // // This member is required. JobStatus types.JobStatus diff --git a/service/macie2/api_op_UpdateFindingsFilter.go b/service/macie2/api_op_UpdateFindingsFilter.go index 9254bdddab5..8ee9d32629e 100644 --- a/service/macie2/api_op_UpdateFindingsFilter.go +++ b/service/macie2/api_op_UpdateFindingsFilter.go @@ -40,8 +40,8 @@ type UpdateFindingsFilterInput struct { // the findings; and, NOOP, don't perform any action on the findings. Action types.FindingsFilterAction - // A unique, case-sensitive token that you provide to ensure the idempotency of the - // request. + // A unique, case-sensitive token that you provide to ensure the idempotency of + // the request. ClientToken *string // A custom description of the filter. The description can contain as many as 512 diff --git a/service/macie2/api_op_UpdateMacieSession.go b/service/macie2/api_op_UpdateMacieSession.go index 748aebb0425..bf7648115c0 100644 --- a/service/macie2/api_op_UpdateMacieSession.go +++ b/service/macie2/api_op_UpdateMacieSession.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Suspends or re-enables Amazon Macie, or updates the configuration settings for a -// Macie account. +// Suspends or re-enables Amazon Macie, or updates the configuration settings for +// a Macie account. func (c *Client) UpdateMacieSession(ctx context.Context, params *UpdateMacieSessionInput, optFns ...func(*Options)) (*UpdateMacieSessionOutput, error) { if params == nil { params = &UpdateMacieSessionInput{} diff --git a/service/macie2/api_op_UpdateMemberSession.go b/service/macie2/api_op_UpdateMemberSession.go index f45a36250ec..0e7341e12d2 100644 --- a/service/macie2/api_op_UpdateMemberSession.go +++ b/service/macie2/api_op_UpdateMemberSession.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables an Amazon Macie administrator to suspend or re-enable Macie for a member -// account. +// Enables an Amazon Macie administrator to suspend or re-enable Macie for a +// member account. func (c *Client) UpdateMemberSession(ctx context.Context, params *UpdateMemberSessionInput, optFns ...func(*Options)) (*UpdateMemberSessionOutput, error) { if params == nil { params = &UpdateMemberSessionInput{} diff --git a/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go b/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go index b89b516c48c..e91a9a090e3 100644 --- a/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go +++ b/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go @@ -34,8 +34,8 @@ type UpdateSensitivityInspectionTemplateInput struct { // This member is required. Id *string - // A custom description of the template. The description can contain as many as 200 - // characters. + // A custom description of the template. The description can contain as many as + // 200 characters. Description *string // The managed data identifiers to explicitly exclude (not use) when analyzing diff --git a/service/macie2/types/enums.go b/service/macie2/types/enums.go index 3b6492482b6..15fe9341ce6 100644 --- a/service/macie2/types/enums.go +++ b/service/macie2/types/enums.go @@ -79,9 +79,9 @@ const ( AutomatedDiscoveryStatusDisabled AutomatedDiscoveryStatus = "DISABLED" ) -// Values returns all known values for AutomatedDiscoveryStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutomatedDiscoveryStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomatedDiscoveryStatus) Values() []AutomatedDiscoveryStatus { return []AutomatedDiscoveryStatus{ "ENABLED", @@ -211,9 +211,9 @@ const ( DayOfWeekSaturday DayOfWeek = "SATURDAY" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "SUNDAY", @@ -276,9 +276,9 @@ const ( ErrorCodeInternalError ErrorCode = "InternalError" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "ClientError", @@ -517,9 +517,9 @@ const ( JobStatusUserPaused JobStatus = "USER_PAUSED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "RUNNING", @@ -750,9 +750,9 @@ const ( RevealStatusDisabled RevealStatus = "DISABLED" ) -// Values returns all known values for RevealStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RevealStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RevealStatus) Values() []RevealStatus { return []RevealStatus{ "ENABLED", @@ -810,8 +810,8 @@ const ( SearchResourcesSimpleCriterionKeyS3BucketSharedAccess SearchResourcesSimpleCriterionKey = "S3_BUCKET_SHARED_ACCESS" ) -// Values returns all known values for SearchResourcesSimpleCriterionKey. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for SearchResourcesSimpleCriterionKey. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (SearchResourcesSimpleCriterionKey) Values() []SearchResourcesSimpleCriterionKey { @@ -898,9 +898,9 @@ const ( SharedAccessUnknown SharedAccess = "UNKNOWN" ) -// Values returns all known values for SharedAccess. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SharedAccess. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SharedAccess) Values() []SharedAccess { return []SharedAccess{ "EXTERNAL", @@ -920,9 +920,9 @@ const ( SimpleCriterionKeyForJobS3BucketSharedAccess SimpleCriterionKeyForJob = "S3_BUCKET_SHARED_ACCESS" ) -// Values returns all known values for SimpleCriterionKeyForJob. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SimpleCriterionKeyForJob. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SimpleCriterionKeyForJob) Values() []SimpleCriterionKeyForJob { return []SimpleCriterionKeyForJob{ "ACCOUNT_ID", @@ -947,9 +947,9 @@ const ( StorageClassOutposts StorageClass = "OUTPOSTS" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "STANDARD", @@ -971,9 +971,9 @@ const ( TagTargetS3Object TagTarget = "S3_OBJECT" ) -// Values returns all known values for TagTarget. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TagTarget. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TagTarget) Values() []TagTarget { return []TagTarget{ "S3_OBJECT", @@ -988,9 +988,9 @@ const ( TimeRangePast30Days TimeRange = "PAST_30_DAYS" ) -// Values returns all known values for TimeRange. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TimeRange. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TimeRange) Values() []TimeRange { return []TimeRange{ "MONTH_TO_DATE", @@ -1029,9 +1029,9 @@ const ( UnavailabilityReasonCodeObjectUnavailable UnavailabilityReasonCode = "OBJECT_UNAVAILABLE" ) -// Values returns all known values for UnavailabilityReasonCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UnavailabilityReasonCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (UnavailabilityReasonCode) Values() []UnavailabilityReasonCode { return []UnavailabilityReasonCode{ "OBJECT_EXCEEDS_SIZE_QUOTA", @@ -1097,9 +1097,9 @@ const ( UsageStatisticsFilterKeyTotal UsageStatisticsFilterKey = "total" ) -// Values returns all known values for UsageStatisticsFilterKey. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UsageStatisticsFilterKey. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageStatisticsFilterKey) Values() []UsageStatisticsFilterKey { return []UsageStatisticsFilterKey{ "accountId", @@ -1141,9 +1141,9 @@ const ( UsageTypeAutomatedObjectMonitoring UsageType = "AUTOMATED_OBJECT_MONITORING" ) -// Values returns all known values for UsageType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for UsageType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (UsageType) Values() []UsageType { return []UsageType{ "DATA_INVENTORY_EVALUATION", diff --git a/service/macie2/types/errors.go b/service/macie2/types/errors.go index f02ea6f24d4..cbf865200b9 100644 --- a/service/macie2/types/errors.go +++ b/service/macie2/types/errors.go @@ -142,8 +142,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Provides information about an error that occurred because too many requests were -// sent during a certain amount of time. +// Provides information about an error that occurred because too many requests +// were sent during a certain amount of time. type ThrottlingException struct { Message *string diff --git a/service/macie2/types/types.go b/service/macie2/types/types.go index 7abb1b99dde..4c7d02749e4 100644 --- a/service/macie2/types/types.go +++ b/service/macie2/types/types.go @@ -11,8 +11,8 @@ import ( // control list (ACL) for an S3 bucket. type AccessControlList struct { - // Specifies whether the ACL grants the general public with read access permissions - // for the bucket. + // Specifies whether the ACL grants the general public with read access + // permissions for the bucket. AllowsPublicReadAccess bool // Specifies whether the ACL grants the general public with write access @@ -85,48 +85,34 @@ type AllowListStatus struct { // The current status of the allow list. If the list's criteria specify a regular // expression (regex), this value is typically OK. Amazon Macie can compile the // expression. If the list's criteria specify an S3 object, possible values are: - // - // * - // OK - Macie can retrieve and parse the contents of the object. - // - // * - // S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object - // is encrypted with a customer managed KMS key that Macie isn't allowed to use. - // Check the bucket policy and other permissions settings for the bucket and the - // object. If the object is encrypted, also ensure that it's encrypted with a key - // that Macie is allowed to use. - // - // * S3_OBJECT_EMPTY - Macie can retrieve the object - // but the object doesn't contain any content. Ensure that the object contains the - // correct entries. Also ensure that the list's criteria specify the correct bucket - // and object names. - // - // * S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon - // S3. Ensure that the list's criteria specify the correct bucket and object - // names. - // - // * S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the - // object contains too many entries or its storage size exceeds the quota for an - // allow list. Try breaking the list into multiple files and ensure that each file - // doesn't exceed any quotas. Then configure list settings in Macie for each - // file. - // - // * S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. - // Wait a few minutes and then try again. - // - // * S3_USER_ACCESS_DENIED - Amazon S3 - // denied the request to retrieve the object. If the specified object exists, - // you're not allowed to access it or it's encrypted with an KMS key that you're - // not allowed to use. Work with your Amazon Web Services administrator to ensure - // that the list's criteria specify the correct bucket and object names, and you - // have read access to the bucket and the object. If the object is encrypted, also - // ensure that it's encrypted with a key that you're allowed to use. - // - // * - // UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to - // retrieve or parse the object. Wait a few minutes and then try again. A list can - // also have this status if it's encrypted with a key that Amazon S3 and Macie - // can't access or use. + // - OK - Macie can retrieve and parse the contents of the object. + // - S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the + // object is encrypted with a customer managed KMS key that Macie isn't allowed to + // use. Check the bucket policy and other permissions settings for the bucket and + // the object. If the object is encrypted, also ensure that it's encrypted with a + // key that Macie is allowed to use. + // - S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't + // contain any content. Ensure that the object contains the correct entries. Also + // ensure that the list's criteria specify the correct bucket and object names. + // - S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that + // the list's criteria specify the correct bucket and object names. + // - S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object + // contains too many entries or its storage size exceeds the quota for an allow + // list. Try breaking the list into multiple files and ensure that each file + // doesn't exceed any quotas. Then configure list settings in Macie for each file. + // - S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait + // a few minutes and then try again. + // - S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the + // object. If the specified object exists, you're not allowed to access it or it's + // encrypted with an KMS key that you're not allowed to use. Work with your Amazon + // Web Services administrator to ensure that the list's criteria specify the + // correct bucket and object names, and you have read access to the bucket and the + // object. If the object is encrypted, also ensure that it's encrypted with a key + // that you're allowed to use. + // - UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted + // to retrieve or parse the object. Wait a few minutes and then try again. A list + // can also have this status if it's encrypted with a key that Amazon S3 and Macie + // can't access or use. // // This member is required. Code AllowListStatusCode @@ -177,8 +163,8 @@ type ApiCallDetails struct { // s3.amazonaws.com. ApiServiceName *string - // The first date and time, in UTC and extended ISO 8601 format, when any operation - // was invoked and produced the finding. + // The first date and time, in UTC and extended ISO 8601 format, when any + // operation was invoked and produced the finding. FirstSeen *time.Time // The most recent date and time, in UTC and extended ISO 8601 format, when the @@ -248,9 +234,9 @@ type BatchGetCustomDataIdentifierSummary struct { // identifier was created. CreatedAt *time.Time - // Specifies whether the custom data identifier was deleted. If you delete a custom - // data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft - // deletes the identifier. + // Specifies whether the custom data identifier was deleted. If you delete a + // custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it + // soft deletes the identifier. Deleted bool // The custom description of the custom data identifier. @@ -268,8 +254,7 @@ type BatchGetCustomDataIdentifierSummary struct { // Provides information about the block public access settings for an S3 bucket. // These settings can apply to a bucket at the account or bucket level. For // detailed information about each setting, see Blocking public access to your -// Amazon S3 storage -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html) +// Amazon S3 storage (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html) // in the Amazon Simple Storage Service User Guide. type BlockPublicAccess struct { @@ -290,16 +275,16 @@ type BlockPublicAccess struct { noSmithyDocumentSerde } -// Provides information about the number of S3 buckets that are publicly accessible -// due to a combination of permissions settings for each bucket. +// Provides information about the number of S3 buckets that are publicly +// accessible due to a combination of permissions settings for each bucket. type BucketCountByEffectivePermission struct { // The total number of buckets that allow the general public to have read or write // access to the bucket. PubliclyAccessible int64 - // The total number of buckets that allow the general public to have read access to - // the bucket. + // The total number of buckets that allow the general public to have read access + // to the bucket. PubliclyReadable int64 // The total number of buckets that allow the general public to have write access @@ -317,8 +302,7 @@ type BucketCountByEffectivePermission struct { // Provides information about the number of S3 buckets whose settings do or don't // specify default server-side encryption behavior for objects that are added to // the buckets. For detailed information about these settings, see Setting default -// server-side encryption behavior for Amazon S3 buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html) +// server-side encryption behavior for Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html) // in the Amazon Simple Storage Service User Guide. type BucketCountByEncryptionType struct { @@ -354,14 +338,15 @@ type BucketCountByEncryptionType struct { // Macie invitation. type BucketCountBySharedAccessType struct { - // The total number of buckets that are shared with one or more of the following or - // any combination of the following: an Amazon CloudFront OAI, a CloudFront OAC, or - // an Amazon Web Services account that isn't in the same Amazon Macie organization. + // The total number of buckets that are shared with one or more of the following + // or any combination of the following: an Amazon CloudFront OAI, a CloudFront OAC, + // or an Amazon Web Services account that isn't in the same Amazon Macie + // organization. External int64 - // The total number of buckets that are shared with one or more Amazon Web Services - // accounts in the same Amazon Macie organization. These buckets aren't shared with - // Amazon CloudFront OAIs or OACs. + // The total number of buckets that are shared with one or more Amazon Web + // Services accounts in the same Amazon Macie organization. These buckets aren't + // shared with Amazon CloudFront OAIs or OACs. Internal int64 // The total number of buckets that aren't shared with other Amazon Web Services @@ -389,10 +374,10 @@ type BucketCountPolicyAllowsUnencryptedObjectUploads struct { // x-amz-server-side-encryption-customer-algorithm header with a value of AES256. AllowsUnencryptedObjectUploads int64 - // The total number of buckets whose bucket policies require server-side encryption - // of new objects. PutObject requests for these buckets must include a valid - // server-side encryption header: the x-amz-server-side-encryption header with a - // value of AES256 or aws:kms, or the + // The total number of buckets whose bucket policies require server-side + // encryption of new objects. PutObject requests for these buckets must include a + // valid server-side encryption header: the x-amz-server-side-encryption header + // with a value of AES256 or aws:kms, or the // x-amz-server-side-encryption-customer-algorithm header with a value of AES256. DeniesUnencryptedObjectUploads int64 @@ -424,8 +409,8 @@ type BucketCriteriaAdditionalProperties struct { // The value for the property is less than or equal to the specified value. Lte int64 - // The value for the property doesn't match (doesn't equal) the specified value. If - // you specify multiple values, Amazon Macie uses OR logic to join the values. + // The value for the property doesn't match (doesn't equal) the specified value. + // If you specify multiple values, Amazon Macie uses OR logic to join the values. Neq []string // The name of the bucket begins with the specified value. @@ -445,8 +430,8 @@ type BucketLevelPermissions struct { // The block public access settings for the bucket. BlockPublicAccess *BlockPublicAccess - // The permissions settings of the bucket policy for the bucket. This value is null - // if a bucket policy hasn't been defined for the bucket. + // The permissions settings of the bucket policy for the bucket. This value is + // null if a bucket policy hasn't been defined for the bucket. BucketPolicy *BucketPolicy noSmithyDocumentSerde @@ -456,8 +441,7 @@ type BucketLevelPermissions struct { // Macie monitors and analyzes for your account. By default, object count and // storage size values include data for object parts that are the result of // incomplete multipart uploads. For more information, see How Macie monitors -// Amazon S3 data security -// (https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html) +// Amazon S3 data security (https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html) // in the Amazon Macie User Guide. If an error occurs when Macie attempts to // retrieve and process metadata from Amazon S3 for the bucket or the bucket's // objects, the value for the versioning property is false and the value for most @@ -470,25 +454,19 @@ type BucketMetadata struct { AccountId *string // Specifies whether the bucket policy for the bucket requires server-side - // encryption of objects when objects are added to the bucket. Possible values - // are: - // - // * FALSE - The bucket policy requires server-side encryption of new - // objects. PutObject requests must include a valid server-side encryption - // header. - // - // * TRUE - The bucket doesn't have a bucket policy or it has a bucket - // policy that doesn't require server-side encryption of new objects. If a bucket - // policy exists, it doesn't require PutObject requests to include a valid - // server-side encryption header. - // - // * UNKNOWN - Amazon Macie can't determine whether - // the bucket policy requires server-side encryption of new objects. - // - // Valid - // server-side encryption headers are: x-amz-server-side-encryption with a value of - // AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a - // value of AES256. + // encryption of objects when objects are added to the bucket. Possible values are: + // + // - FALSE - The bucket policy requires server-side encryption of new objects. + // PutObject requests must include a valid server-side encryption header. + // - TRUE - The bucket doesn't have a bucket policy or it has a bucket policy + // that doesn't require server-side encryption of new objects. If a bucket policy + // exists, it doesn't require PutObject requests to include a valid server-side + // encryption header. + // - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires + // server-side encryption of new objects. + // Valid server-side encryption headers are: x-amz-server-side-encryption with a + // value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm + // with a value of AES256. AllowsUnencryptedObjectUploads AllowsUnencryptedObjectUploads // The Amazon Resource Name (ARN) of the bucket. @@ -571,29 +549,22 @@ type BucketMetadata struct { // The default server-side encryption settings for the bucket. ServerSideEncryption *BucketServerSideEncryption - // Specifies whether the bucket is shared with another Amazon Web Services account, - // an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access - // control (OAC). Possible values are: - // - // * EXTERNAL - The bucket is shared with one - // or more of the following or any combination of the following: a CloudFront OAI, - // a CloudFront OAC, or an Amazon Web Services account that isn't part of your - // Amazon Macie organization. - // - // * INTERNAL - The bucket is shared with one or more - // Amazon Web Services accounts that are part of your Amazon Macie organization. It - // isn't shared with a CloudFront OAI or OAC. - // - // * NOT_SHARED - The bucket isn't - // shared with another Amazon Web Services account, a CloudFront OAI, or a - // CloudFront OAC. - // - // * UNKNOWN - Amazon Macie wasn't able to evaluate the shared - // access settings for the bucket. - // - // An Amazon Macie organization is a set of Macie - // accounts that are centrally managed as a group of related accounts through - // Organizations or by Macie invitation. + // Specifies whether the bucket is shared with another Amazon Web Services + // account, an Amazon CloudFront origin access identity (OAI), or a CloudFront + // origin access control (OAC). Possible values are: + // - EXTERNAL - The bucket is shared with one or more of the following or any + // combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon + // Web Services account that isn't part of your Amazon Macie organization. + // - INTERNAL - The bucket is shared with one or more Amazon Web Services + // accounts that are part of your Amazon Macie organization. It isn't shared with a + // CloudFront OAI or OAC. + // - NOT_SHARED - The bucket isn't shared with another Amazon Web Services + // account, a CloudFront OAI, or a CloudFront OAC. + // - UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings + // for the bucket. + // An Amazon Macie organization is a set of Macie accounts that are centrally + // managed as a group of related accounts through Organizations or by Macie + // invitation. SharedAccess SharedAccess // The total storage size, in bytes, of the bucket. If versioning is enabled for @@ -613,14 +584,14 @@ type BucketMetadata struct { // bucket. Tags []KeyValuePair - // The total number of objects that Amazon Macie can't analyze in the bucket. These - // objects don't use a supported storage class or don't have a file name extension - // for a supported file or storage format. + // The total number of objects that Amazon Macie can't analyze in the bucket. + // These objects don't use a supported storage class or don't have a file name + // extension for a supported file or storage format. UnclassifiableObjectCount *ObjectLevelStatistics - // The total storage size, in bytes, of the objects that Amazon Macie can't analyze - // in the bucket. These objects don't use a supported storage class or don't have a - // file name extension for a supported file or storage format. + // The total storage size, in bytes, of the objects that Amazon Macie can't + // analyze in the bucket. These objects don't use a supported storage class or + // don't have a file name extension for a supported file or storage format. UnclassifiableObjectSizeInBytes *ObjectLevelStatistics // Specifies whether versioning is enabled for the bucket. @@ -657,21 +628,16 @@ type BucketPolicy struct { noSmithyDocumentSerde } -// Provides information about the permissions settings that determine whether an S3 -// bucket is publicly accessible. +// Provides information about the permissions settings that determine whether an +// S3 bucket is publicly accessible. type BucketPublicAccess struct { // Specifies whether the bucket is publicly accessible due to the combination of // permissions settings that apply to the bucket. Possible values are: - // - // * - // NOT_PUBLIC - The bucket isn't publicly accessible. - // - // * PUBLIC - The bucket is - // publicly accessible. - // - // * UNKNOWN - Amazon Macie can't determine whether the - // bucket is publicly accessible. + // - NOT_PUBLIC - The bucket isn't publicly accessible. + // - PUBLIC - The bucket is publicly accessible. + // - UNKNOWN - Amazon Macie can't determine whether the bucket is publicly + // accessible. EffectivePermission EffectivePermission // The account-level and bucket-level permissions settings for the bucket. @@ -680,10 +646,9 @@ type BucketPublicAccess struct { noSmithyDocumentSerde } -// Provides information about the default server-side encryption settings for an S3 -// bucket. For detailed information about these settings, see Setting default -// server-side encryption behavior for Amazon S3 buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html) +// Provides information about the default server-side encryption settings for an +// S3 bucket. For detailed information about these settings, see Setting default +// server-side encryption behavior for Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html) // in the Amazon Simple Storage Service User Guide. type BucketServerSideEncryption struct { @@ -695,17 +660,13 @@ type BucketServerSideEncryption struct { // The server-side encryption algorithm that's used by default to encrypt objects // that are added to the bucket. Possible values are: - // - // * AES256 - New objects are - // encrypted with an Amazon S3 managed key. They use SSE-S3 encryption. - // - // * aws:kms - // - New objects are encrypted with an KMS key (kmsMasterKeyId), either an Amazon - // Web Services managed key or a customer managed key. They use SSE-KMS - // encryption. - // - // * NONE - The bucket's default encryption settings don't specify - // server-side encryption behavior for new objects. + // - AES256 - New objects are encrypted with an Amazon S3 managed key. They use + // SSE-S3 encryption. + // - aws:kms - New objects are encrypted with an KMS key (kmsMasterKeyId), + // either an Amazon Web Services managed key or a customer managed key. They use + // SSE-KMS encryption. + // - NONE - The bucket's default encryption settings don't specify server-side + // encryption behavior for new objects. Type Type noSmithyDocumentSerde @@ -715,8 +676,8 @@ type BucketServerSideEncryption struct { // buckets. type BucketSortCriteria struct { - // The name of the bucket property to sort the results by. This value can be one of - // the following properties that Amazon Macie defines as bucket metadata: + // The name of the bucket property to sort the results by. This value can be one + // of the following properties that Amazon Macie defines as bucket metadata: // accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, // objectCount, sensitivityScore, or sizeInBytes. AttributeName *string @@ -735,20 +696,20 @@ type BucketSortCriteria struct { // value for each metric is 0. type BucketStatisticsBySensitivity struct { - // The aggregated statistical data for all buckets that have a sensitivity score of - // -1. + // The aggregated statistical data for all buckets that have a sensitivity score + // of -1. ClassificationError *SensitivityAggregations - // The aggregated statistical data for all buckets that have a sensitivity score of - // 50. + // The aggregated statistical data for all buckets that have a sensitivity score + // of 50. NotClassified *SensitivityAggregations - // The aggregated statistical data for all buckets that have a sensitivity score of - // 1-49. + // The aggregated statistical data for all buckets that have a sensitivity score + // of 1-49. NotSensitive *SensitivityAggregations - // The aggregated statistical data for all buckets that have a sensitivity score of - // 51-100. + // The aggregated statistical data for all buckets that have a sensitivity score + // of 51-100. Sensitive *SensitivityAggregations noSmithyDocumentSerde @@ -792,8 +753,8 @@ type ClassificationDetails struct { // AUTOMATED_SENSITIVE_DATA_DISCOVERY. JobArn *string - // The unique identifier for the classification job that produced the finding. This - // value is null if the origin of the finding (originType) is + // The unique identifier for the classification job that produced the finding. + // This value is null if the origin of the finding (originType) is // AUTOMATED_SENSITIVE_DATA_DISCOVERY. JobId *string @@ -820,12 +781,12 @@ type ClassificationExportConfiguration struct { noSmithyDocumentSerde } -// Provides the details of a sensitive data finding, including the types, number of -// occurrences, and locations of the sensitive data that was detected. +// Provides the details of a sensitive data finding, including the types, number +// of occurrences, and locations of the sensitive data that was detected. type ClassificationResult struct { - // Specifies whether Amazon Macie detected additional occurrences of sensitive data - // in the S3 object. A finding includes location data for a maximum of 15 + // Specifies whether Amazon Macie detected additional occurrences of sensitive + // data in the S3 object. A finding includes location data for a maximum of 15 // occurrences of sensitive data. This value can help you determine whether to // investigate additional occurrences of sensitive data in an object. You can do // this by referring to the corresponding sensitive data discovery result for the @@ -858,126 +819,85 @@ type ClassificationResult struct { type ClassificationResultStatus struct { // The status of the finding. Possible values are: - // - // * COMPLETE - Amazon Macie - // successfully completed its analysis of the S3 object that the finding applies - // to. - // - // * PARTIAL - Macie analyzed only a subset of the data in the S3 object that - // the finding applies to. For example, the object is an archive file that contains - // files in an unsupported format. - // - // * SKIPPED - Macie wasn't able to analyze the S3 - // object that the finding applies to. For example, the object is a file that uses - // an unsupported format. + // - COMPLETE - Amazon Macie successfully completed its analysis of the S3 + // object that the finding applies to. + // - PARTIAL - Macie analyzed only a subset of the data in the S3 object that + // the finding applies to. For example, the object is an archive file that contains + // files in an unsupported format. + // - SKIPPED - Macie wasn't able to analyze the S3 object that the finding + // applies to. For example, the object is a file that uses an unsupported format. Code *string // A brief description of the status of the finding. This value is null if the // status (code) of the finding is COMPLETE. Amazon Macie uses this value to notify // you of any errors, warnings, or considerations that might impact your analysis // of the finding and the affected S3 object. Possible values are: - // - // * - // ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and Macie - // extracted and analyzed only some or none of the files in the archive. To - // determine which files Macie analyzed, if any, refer to the corresponding - // sensitive data discovery result for the finding - // (ClassificationDetails.detailedResultsLocation). - // - // * ARCHIVE_EXCEEDS_SIZE_LIMIT - - // The object is an archive file whose total storage size exceeds the size quota - // for this type of archive. - // - // * ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an - // archive file whose nested depth exceeds the quota for the maximum number of - // nested levels that Macie analyzes for this type of archive. - // - // * - // ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file that - // exceeds the quota for the maximum amount of data that Macie extracts and - // analyzes for this type of archive. - // - // * - // ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive file - // that contains more than the maximum number of files that Macie extracts and - // analyzes for this type of archive. - // - // * FILE_EXCEEDS_SIZE_LIMIT - The storage size - // of the object exceeds the size quota for this type of file. - // - // * - // INVALID_ENCRYPTION - The object is encrypted using server-side encryption but - // Macie isn't allowed to use the key. Macie can't decrypt and analyze the - // object. - // - // * INVALID_KMS_KEY - The object is encrypted with an KMS key that was - // disabled or is being deleted. Macie can't decrypt and analyze the object. - // - // * - // INVALID_OBJECT_STATE - The object doesn't use a supported Amazon S3 storage - // class. - // - // * JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the - // nested depth of the data exceeds the quota for the number of nested levels that - // Macie analyzes for this type of file. - // - // * MALFORMED_FILE - The object is a - // malformed or corrupted file. An error occurred when Macie attempted to detect - // the file's type or extract data from the file. - // - // * - // MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office file - // that is malformed or exceeds the size quota for this type of file. If the file - // is malformed, an error occurred when Macie attempted to extract data from the - // file. - // - // * NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted - // shortly before or when Macie attempted to analyze the object. - // - // * - // OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing - // it. - // - // * OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML - // file whose compression ratio exceeds the compression quota for this type of - // file. - // - // * OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open - // XML file that exceeds the size quota for this type of file. - // - // * PERMISSION_DENIED - // - Macie isn't allowed to access the object. The object's permissions settings - // prevent Macie from analyzing the object. - // - // * SOURCE_OBJECT_NO_LONGER_AVAILABLE - - // The object was deleted shortly before or when Macie attempted to analyze it. - // - // * - // TIME_CUT_OFF_REACHED - Macie started analyzing the object but additional - // analysis would exceed the time quota for analyzing an object. - // - // * - // UNABLE_TO_PARSE_FILE - The object is a file that contains structured data and an - // error occurred when Macie attempted to parse the data. - // - // * - // UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an unsupported - // file or storage format. - // - // For information about quotas, supported storage - // classes, and supported file and storage formats, see Quotas - // (https://docs.aws.amazon.com/macie/latest/user/macie-quotas.html) and Supported - // storage classes and formats - // (https://docs.aws.amazon.com/macie/latest/user/discovery-supported-storage.html) + // - ARCHIVE_CONTAINS_UNPROCESSED_FILES - The object is an archive file and + // Macie extracted and analyzed only some or none of the files in the archive. To + // determine which files Macie analyzed, if any, refer to the corresponding + // sensitive data discovery result for the finding + // (ClassificationDetails.detailedResultsLocation). + // - ARCHIVE_EXCEEDS_SIZE_LIMIT - The object is an archive file whose total + // storage size exceeds the size quota for this type of archive. + // - ARCHIVE_NESTING_LEVEL_OVER_LIMIT - The object is an archive file whose + // nested depth exceeds the quota for the maximum number of nested levels that + // Macie analyzes for this type of archive. + // - ARCHIVE_TOTAL_BYTES_EXTRACTED_OVER_LIMIT - The object is an archive file + // that exceeds the quota for the maximum amount of data that Macie extracts and + // analyzes for this type of archive. + // - ARCHIVE_TOTAL_DOCUMENTS_PROCESSED_OVER_LIMIT - The object is an archive + // file that contains more than the maximum number of files that Macie extracts and + // analyzes for this type of archive. + // - FILE_EXCEEDS_SIZE_LIMIT - The storage size of the object exceeds the size + // quota for this type of file. + // - INVALID_ENCRYPTION - The object is encrypted using server-side encryption + // but Macie isn't allowed to use the key. Macie can't decrypt and analyze the + // object. + // - INVALID_KMS_KEY - The object is encrypted with an KMS key that was disabled + // or is being deleted. Macie can't decrypt and analyze the object. + // - INVALID_OBJECT_STATE - The object doesn't use a supported Amazon S3 storage + // class. + // - JSON_NESTING_LEVEL_OVER_LIMIT - The object contains JSON data and the + // nested depth of the data exceeds the quota for the number of nested levels that + // Macie analyzes for this type of file. + // - MALFORMED_FILE - The object is a malformed or corrupted file. An error + // occurred when Macie attempted to detect the file's type or extract data from the + // file. + // - MALFORMED_OR_FILE_SIZE_EXCEEDS_LIMIT - The object is a Microsoft Office + // file that is malformed or exceeds the size quota for this type of file. If the + // file is malformed, an error occurred when Macie attempted to extract data from + // the file. + // - NO_SUCH_BUCKET_AVAILABLE - The object was in a bucket that was deleted + // shortly before or when Macie attempted to analyze the object. + // - OBJECT_VERSION_MISMATCH - The object was changed while Macie was analyzing + // it. + // - OOXML_UNCOMPRESSED_RATIO_EXCEEDS_LIMIT - The object is an Office Open XML + // file whose compression ratio exceeds the compression quota for this type of + // file. + // - OOXML_UNCOMPRESSED_SIZE_EXCEEDS_LIMIT - The object is an Office Open XML + // file that exceeds the size quota for this type of file. + // - PERMISSION_DENIED - Macie isn't allowed to access the object. The object's + // permissions settings prevent Macie from analyzing the object. + // - SOURCE_OBJECT_NO_LONGER_AVAILABLE - The object was deleted shortly before + // or when Macie attempted to analyze it. + // - TIME_CUT_OFF_REACHED - Macie started analyzing the object but additional + // analysis would exceed the time quota for analyzing an object. + // - UNABLE_TO_PARSE_FILE - The object is a file that contains structured data + // and an error occurred when Macie attempted to parse the data. + // - UNSUPPORTED_FILE_TYPE_EXCEPTION - The object is a file that uses an + // unsupported file or storage format. + // For information about quotas, supported storage classes, and supported file and + // storage formats, see Quotas (https://docs.aws.amazon.com/macie/latest/user/macie-quotas.html) + // and Supported storage classes and formats (https://docs.aws.amazon.com/macie/latest/user/discovery-supported-storage.html) // in the Amazon Macie User Guide. Reason *string noSmithyDocumentSerde } -// Provides information about the classification scope for an Amazon Macie account. -// Macie uses the scope's settings when it performs automated sensitive data -// discovery for the account. +// Provides information about the classification scope for an Amazon Macie +// account. Macie uses the scope's settings when it performs automated sensitive +// data discovery for the account. type ClassificationScopeSummary struct { // The unique identifier for the classification scope. @@ -1001,8 +921,8 @@ type CriteriaBlockForJob struct { noSmithyDocumentSerde } -// Specifies a property- or tag-based condition that defines criteria for including -// or excluding S3 buckets from a classification job. +// Specifies a property- or tag-based condition that defines criteria for +// including or excluding S3 buckets from a classification job. type CriteriaForJob struct { // A property-based condition that defines a property, operator, and one or more @@ -1018,9 +938,8 @@ type CriteriaForJob struct { // Specifies the operator to use in a property-based condition that filters the // results of a query for findings. For detailed information and examples of each -// operator, see Fundamentals of filtering findings -// (https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html) in -// the Amazon Macie User Guide. +// operator, see Fundamentals of filtering findings (https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html) +// in the Amazon Macie User Guide. type CriterionAdditionalProperties struct { // The value for the property matches (equals) the specified value. If you specify @@ -1049,8 +968,8 @@ type CriterionAdditionalProperties struct { // The value for the property is less than or equal to the specified value. Lte int64 - // The value for the property doesn't match (doesn't equal) the specified value. If - // you specify multiple values, Macie uses OR logic to join the values. + // The value for the property doesn't match (doesn't equal) the specified value. + // If you specify multiple values, Macie uses OR logic to join the values. Neq []string noSmithyDocumentSerde @@ -1065,8 +984,8 @@ type CustomDataIdentifiers struct { // occurrences of the data that each identifier detected. Detections []CustomDetection - // The total number of occurrences of the data that was detected by the custom data - // identifiers and produced the finding. + // The total number of occurrences of the data that was detected by the custom + // data identifiers and produced the finding. TotalCount int64 noSmithyDocumentSerde @@ -1116,8 +1035,8 @@ type CustomDetection struct { noSmithyDocumentSerde } -// Specifies that a classification job runs once a day, every day. This is an empty -// object. +// Specifies that a classification job runs once a day, every day. This is an +// empty object. type DailySchedule struct { noSmithyDocumentSerde } @@ -1171,9 +1090,8 @@ type Detection struct { // The unique identifier for the custom data identifier or managed data identifier // that detected the sensitive data. For additional details about a specified - // managed data identifier, see Using managed data identifiers - // (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) in - // the Amazon Macie User Guide. + // managed data identifier, see Using managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) + // in the Amazon Macie User Guide. Id *string // The name of the custom data identifier or managed data identifier that detected @@ -1181,8 +1099,8 @@ type Detection struct { // unique identifier (id). Name *string - // Specifies whether occurrences of this type of sensitive data are excluded (true) - // or included (false) in the bucket's sensitivity score. + // Specifies whether occurrences of this type of sensitive data are excluded + // (true) or included (false) in the bucket's sensitivity score. Suppressed bool // The type of data identifier that detected the sensitive data. Possible values @@ -1258,8 +1176,8 @@ type Finding struct { // The description of the finding. Description *string - // The unique identifier for the finding. This is a random string that Amazon Macie - // generates and assigns to a finding when it creates the finding. + // The unique identifier for the finding. This is a random string that Amazon + // Macie generates and assigns to a finding when it creates the finding. Id *string // The Amazon Web Services partition that Amazon Macie created the finding in. @@ -1275,8 +1193,8 @@ type Finding struct { // The resources that the finding applies to. ResourcesAffected *ResourcesAffected - // Specifies whether the finding is a sample finding. A sample finding is a finding - // that uses example data to demonstrate what a finding might contain. + // Specifies whether the finding is a sample finding. A sample finding is a + // finding that uses example data to demonstrate what a finding might contain. Sample bool // The version of the schema that was used to define the data structures in the @@ -1301,8 +1219,8 @@ type Finding struct { noSmithyDocumentSerde } -// Provides information about an action that occurred for a resource and produced a -// policy finding. +// Provides information about an action that occurred for a resource and produced +// a policy finding. type FindingAction struct { // The type of action that occurred for the affected resource. This value is @@ -1341,8 +1259,8 @@ type FindingActor struct { // results of a query for findings. type FindingCriteria struct { - // A condition that specifies the property, operator, and one or more values to use - // to filter the results. + // A condition that specifies the property, operator, and one or more values to + // use to filter the results. Criterion map[string]CriterionAdditionalProperties noSmithyDocumentSerde @@ -1351,9 +1269,9 @@ type FindingCriteria struct { // Provides information about a findings filter. type FindingsFilterListItem struct { - // The action that's performed on findings that match the filter criteria. Possible - // values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, - // don't perform any action on the findings. + // The action that's performed on findings that match the filter criteria. + // Possible values are: ARCHIVE, suppress (automatically archive) the findings; + // and, NOOP, don't perform any action on the findings. Action FindingsFilterAction // The Amazon Resource Name (ARN) of the filter. @@ -1407,8 +1325,8 @@ type GroupCount struct { // performed an action on an affected resource. type IamUser struct { - // The unique identifier for the Amazon Web Services account that's associated with - // the IAM user who performed the action. + // The unique identifier for the Amazon Web Services account that's associated + // with the IAM user who performed the action. AccountId *string // The Amazon Resource Name (ARN) of the principal that performed the action. The @@ -1528,40 +1446,32 @@ type JobDetails struct { // Specifies whether any one-time or recurring jobs are configured to analyze data // in the bucket. Possible values are: - // - // * TRUE - The bucket is explicitly included - // in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at - // least one of those jobs has a status other than CANCELLED. Or the bucket matched - // the bucket criteria (S3BucketCriteriaForJob) for at least one job that - // previously ran. - // - // * FALSE - The bucket isn't explicitly included in the bucket - // definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly - // include the bucket in their bucket definitions have a status of CANCELLED, or - // the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any - // jobs that previously ran. - // - // * UNKNOWN - An exception occurred when Amazon Macie - // attempted to retrieve job data for the bucket. + // - TRUE - The bucket is explicitly included in the bucket definition + // (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs + // has a status other than CANCELLED. Or the bucket matched the bucket criteria + // (S3BucketCriteriaForJob) for at least one job that previously ran. + // - FALSE - The bucket isn't explicitly included in the bucket definition + // (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include + // the bucket in their bucket definitions have a status of CANCELLED, or the bucket + // didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that + // previously ran. + // - UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job + // data for the bucket. IsDefinedInJob IsDefinedInJob // Specifies whether any recurring jobs are configured to analyze data in the // bucket. Possible values are: - // - // * TRUE - The bucket is explicitly included in the - // bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or - // the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more - // recurring jobs. At least one of those jobs has a status other than CANCELLED. - // - // * - // FALSE - The bucket isn't explicitly included in the bucket definition - // (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the - // bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the - // recurring jobs that are configured to analyze data in the bucket have a status - // of CANCELLED. - // - // * UNKNOWN - An exception occurred when Amazon Macie attempted to - // retrieve job data for the bucket. + // - TRUE - The bucket is explicitly included in the bucket definition + // (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches + // the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At + // least one of those jobs has a status other than CANCELLED. + // - FALSE - The bucket isn't explicitly included in the bucket definition + // (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the + // bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the + // recurring jobs that are configured to analyze data in the bucket have a status + // of CANCELLED. + // - UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job + // data for the bucket. IsMonitoredByJob IsMonitoredByJob // The unique identifier for the job that ran most recently and is configured to @@ -1570,9 +1480,9 @@ type JobDetails struct { // isDefinedInJob property is FALSE or UNKNOWN. LastJobId *string - // The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) - // started. If the job is a recurring job, this value indicates when the most - // recent run started. This value is typically null if the value for the + // The date and time, in UTC and extended ISO 8601 format, when the job + // (lastJobId) started. If the job is a recurring job, this value indicates when + // the most recent run started. This value is typically null if the value for the // isDefinedInJob property is FALSE or UNKNOWN. LastJobRunTime *time.Time @@ -1594,9 +1504,9 @@ type JobScheduleFrequency struct { noSmithyDocumentSerde } -// Specifies a property- or tag-based condition that defines criteria for including -// or excluding S3 objects from a classification job. A JobScopeTerm object can -// contain only one simpleScopeTerm object or one tagScopeTerm object. +// Specifies a property- or tag-based condition that defines criteria for +// including or excluding S3 objects from a classification job. A JobScopeTerm +// object can contain only one simpleScopeTerm object or one tagScopeTerm object. type JobScopeTerm struct { // A property-based condition that defines a property, operator, and one or more @@ -1622,8 +1532,8 @@ type JobScopingBlock struct { noSmithyDocumentSerde } -// Provides information about a classification job, including the current status of -// the job. +// Provides information about a classification job, including the current status +// of the job. type JobSummary struct { // The property- and tag-based conditions that determine which S3 buckets are @@ -1632,10 +1542,11 @@ type JobSummary struct { // can contain a bucketCriteria object or a bucketDefinitions array, not both. BucketCriteria *S3BucketCriteriaForJob - // An array of objects, one for each Amazon Web Services account that owns specific - // S3 buckets for the job to analyze. Each object specifies the account ID for an - // account and one or more buckets to analyze for that account. A job's definition - // can contain a bucketDefinitions array or a bucketCriteria object, not both. + // An array of objects, one for each Amazon Web Services account that owns + // specific S3 buckets for the job to analyze. Each object specifies the account ID + // for an account and one or more buckets to analyze for that account. A job's + // definition can contain a bucketDefinitions array or a bucketCriteria object, not + // both. BucketDefinitions []S3BucketDefinitionForJob // The date and time, in UTC and extended ISO 8601 format, when the job was @@ -1646,40 +1557,26 @@ type JobSummary struct { JobId *string // The current status of the job. Possible values are: - // - // * CANCELLED - You cancelled - // the job or, if it's a one-time job, you paused the job and didn't resume it - // within 30 days. - // - // * COMPLETE - For a one-time job, Amazon Macie finished - // processing the data specified for the job. This value doesn't apply to recurring - // jobs. - // - // * IDLE - For a recurring job, the previous scheduled run is complete and - // the next scheduled run is pending. This value doesn't apply to one-time jobs. - // - // * - // PAUSED - Macie started running the job but additional processing would exceed - // the monthly sensitive data discovery quota for your account or one or more - // member accounts that the job analyzes data for. - // - // * RUNNING - For a one-time job, - // the job is in progress. For a recurring job, a scheduled run is in progress. - // - // * - // USER_PAUSED - You paused the job. If you paused the job while it had a status of - // RUNNING and you don't resume it within 30 days of pausing it, the job or job run - // will expire and be cancelled, depending on the job's type. To check the - // expiration date, refer to the UserPausedDetails.jobExpiresAt property. + // - CANCELLED - You cancelled the job or, if it's a one-time job, you paused + // the job and didn't resume it within 30 days. + // - COMPLETE - For a one-time job, Amazon Macie finished processing the data + // specified for the job. This value doesn't apply to recurring jobs. + // - IDLE - For a recurring job, the previous scheduled run is complete and the + // next scheduled run is pending. This value doesn't apply to one-time jobs. + // - PAUSED - Macie started running the job but additional processing would + // exceed the monthly sensitive data discovery quota for your account or one or + // more member accounts that the job analyzes data for. + // - RUNNING - For a one-time job, the job is in progress. For a recurring job, + // a scheduled run is in progress. + // - USER_PAUSED - You paused the job. If you paused the job while it had a + // status of RUNNING and you don't resume it within 30 days of pausing it, the job + // or job run will expire and be cancelled, depending on the job's type. To check + // the expiration date, refer to the UserPausedDetails.jobExpiresAt property. JobStatus JobStatus // The schedule for running the job. Possible values are: - // - // * ONE_TIME - The job - // runs only once. - // - // * SCHEDULED - The job runs on a daily, weekly, or monthly - // basis. + // - ONE_TIME - The job runs only once. + // - SCHEDULED - The job runs on a daily, weekly, or monthly basis. JobType JobType // Specifies whether any account- or bucket-level access errors occurred when the @@ -1715,20 +1612,17 @@ type KeyValuePair struct { // Specifies whether any account- or bucket-level access errors occurred when a // classification job ran. For information about using logging data to investigate -// these errors, see Monitoring sensitive data discovery jobs -// (https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-monitor-cw-logs.html) +// these errors, see Monitoring sensitive data discovery jobs (https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-monitor-cw-logs.html) // in the Amazon Macie User Guide. type LastRunErrorStatus struct { // Specifies whether any account- or bucket-level access errors occurred when the // job ran. For a recurring job, this value indicates the error status of the job's // most recent run. Possible values are: - // - // * ERROR - One or more errors occurred. - // Amazon Macie didn't process all the data specified for the job. - // - // * NONE - No - // errors occurred. Macie processed all the data specified for the job. + // - ERROR - One or more errors occurred. Amazon Macie didn't process all the + // data specified for the job. + // - NONE - No errors occurred. Macie processed all the data specified for the + // job. Code LastRunErrorStatusCode noSmithyDocumentSerde @@ -1782,9 +1676,8 @@ type ListJobsSortCriteria struct { } // Provides information about a managed data identifier. For additional -// information, see Using managed data identifiers -// (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) in -// the Amazon Macie User Guide. +// information, see Using managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) +// in the Amazon Macie User Guide. type ManagedDataIdentifierSummary struct { // The category of sensitive data that the managed data identifier detects: @@ -1808,8 +1701,7 @@ type ManagedDataIdentifierSummary struct { // Macie monitors and analyzes for your account. By default, object count and // storage size values include data for object parts that are the result of // incomplete multipart uploads. For more information, see How Macie monitors -// Amazon S3 data security -// (https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html) +// Amazon S3 data security (https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html) // in the Amazon Macie User Guide. If an error occurs when Macie attempts to // retrieve and process information about the bucket or the bucket's objects, the // value for most of these properties is null. Key exceptions are accountId and @@ -1886,14 +1778,14 @@ type MatchingBucket struct { // size of all versions of each applicable object in the bucket. SizeInBytesCompressed int64 - // The total number of objects that Amazon Macie can't analyze in the bucket. These - // objects don't use a supported storage class or don't have a file name extension - // for a supported file or storage format. + // The total number of objects that Amazon Macie can't analyze in the bucket. + // These objects don't use a supported storage class or don't have a file name + // extension for a supported file or storage format. UnclassifiableObjectCount *ObjectLevelStatistics - // The total storage size, in bytes, of the objects that Amazon Macie can't analyze - // in the bucket. These objects don't use a supported storage class or don't have a - // file name extension for a supported file or storage format. + // The total storage size, in bytes, of the objects that Amazon Macie can't + // analyze in the bucket. These objects don't use a supported storage class or + // don't have a file name extension for a supported file or storage format. UnclassifiableObjectSizeInBytes *ObjectLevelStatistics noSmithyDocumentSerde @@ -1936,8 +1828,8 @@ type Member struct { // retained only for backward compatibility. MasterAccountId *string - // The current status of the relationship between the account and the administrator - // account. + // The current status of the relationship between the account and the + // administrator account. RelationshipStatus RelationshipStatus // A map of key-value pairs that specifies which tags (keys and values) are @@ -1971,12 +1863,12 @@ type MonthlySchedule struct { // aren't encrypted. type ObjectCountByEncryptionType struct { - // The total number of objects that are encrypted with a customer-provided key. The - // objects use customer-provided server-side encryption (SSE-C). + // The total number of objects that are encrypted with a customer-provided key. + // The objects use customer-provided server-side encryption (SSE-C). CustomerManaged int64 - // The total number of objects that are encrypted with an KMS key, either an Amazon - // Web Services managed key or a customer managed key. The objects use KMS + // The total number of objects that are encrypted with an KMS key, either an + // Amazon Web Services managed key or a customer managed key. The objects use KMS // encryption (SSE-KMS). KmsManaged int64 @@ -2051,14 +1943,14 @@ type Occurrences struct { // Each Page object specifies a page that contains the sensitive data. Pages []Page - // An array of objects, one for each occurrence of sensitive data in an Apache Avro - // object container, Apache Parquet file, JSON file, or JSON Lines file. This value - // is null for all other types of files. For an Avro object container or Parquet - // file, each Record object specifies a record index and the path to a field in a - // record that contains the sensitive data. For a JSON or JSON Lines file, each - // Record object specifies the path to a field or array that contains the sensitive - // data. For a JSON Lines file, it also specifies the index of the line that - // contains the data. + // An array of objects, one for each occurrence of sensitive data in an Apache + // Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This + // value is null for all other types of files. For an Avro object container or + // Parquet file, each Record object specifies a record index and the path to a + // field in a record that contains the sensitive data. For a JSON or JSON Lines + // file, each Record object specifies the path to a field or array that contains + // the sensitive data. For a JSON Lines file, it also specifies the index of the + // line that contains the data. Records []Record noSmithyDocumentSerde @@ -2092,8 +1984,8 @@ type PolicyDetails struct { noSmithyDocumentSerde } -// Specifies the location of an occurrence of sensitive data in an email message or -// a non-binary text file such as an HTML, TXT, or XML file. +// Specifies the location of an occurrence of sensitive data in an email message +// or a non-binary text file such as an HTML, TXT, or XML file. type Range struct { // The number of lines from the beginning of the file to the end of the sensitive @@ -2104,9 +1996,9 @@ type Range struct { // sensitive data. Start int64 - // The number of characters, with spaces and starting from 1, from the beginning of - // the first line that contains the sensitive data (start) to the beginning of the - // sensitive data. + // The number of characters, with spaces and starting from 1, from the beginning + // of the first line that contains the sensitive data (start) to the beginning of + // the sensitive data. StartColumn int64 noSmithyDocumentSerde @@ -2128,9 +2020,9 @@ type Record struct { // first element in the path, until the path contains 250 or fewer characters. JsonPath *string - // For an Avro object container or Parquet file, the record index, starting from 0, - // for the record that contains the sensitive data. For a JSON Lines file, the line - // index, starting from 0, for the line that contains the sensitive data. This + // For an Avro object container or Parquet file, the record index, starting from + // 0, for the record that contains the sensitive data. For a JSON Lines file, the + // line index, starting from 0, for the line that contains the sensitive data. This // value is always 0 for JSON files. RecordIndex int64 @@ -2146,8 +2038,8 @@ type ReplicationDetails struct { // any destination. Replicated bool - // Specifies whether the bucket is configured to replicate one or more objects to a - // bucket for an Amazon Web Services account that isn't part of your Amazon Macie + // Specifies whether the bucket is configured to replicate one or more objects to + // a bucket for an Amazon Web Services account that isn't part of your Amazon Macie // organization. An Amazon Macie organization is a set of Macie accounts that are // centrally managed as a group of related accounts through Organizations or by // Macie invitation. @@ -2173,16 +2065,11 @@ type ResourceProfileArtifact struct { Arn *string // The status of the analysis. Possible values are: - // - // * COMPLETE - Amazon Macie - // successfully completed its analysis of the object. - // - // * PARTIAL - Macie analyzed - // only a subset of data in the object. For example, the object is an archive file - // that contains files in an unsupported format. - // - // * SKIPPED - Macie wasn't able to - // analyze the object. For example, the object is a malformed file. + // - COMPLETE - Amazon Macie successfully completed its analysis of the object. + // - PARTIAL - Macie analyzed only a subset of data in the object. For example, + // the object is an archive file that contains files in an unsupported format. + // - SKIPPED - Macie wasn't able to analyze the object. For example, the object + // is a malformed file. // // This member is required. ClassificationResultStatus *string @@ -2216,9 +2103,9 @@ type ResourceStatistics struct { // bucket. TotalBytesClassified int64 - // The total number of occurrences of sensitive data that Amazon Macie has found in - // the bucket's objects. This includes occurrences that are currently suppressed by - // the sensitivity scoring settings for the bucket (totalDetectionsSuppressed). + // The total number of occurrences of sensitive data that Amazon Macie has found + // in the bucket's objects. This includes occurrences that are currently suppressed + // by the sensitivity scoring settings for the bucket (totalDetectionsSuppressed). TotalDetections int64 // The total number of occurrences of sensitive data that are currently suppressed @@ -2289,25 +2176,19 @@ type RevealConfiguration struct { type S3Bucket struct { // Specifies whether the bucket policy for the bucket requires server-side - // encryption of objects when objects are added to the bucket. Possible values - // are: - // - // * FALSE - The bucket policy requires server-side encryption of new - // objects. PutObject requests must include a valid server-side encryption - // header. - // - // * TRUE - The bucket doesn't have a bucket policy or it has a bucket - // policy that doesn't require server-side encryption of new objects. If a bucket - // policy exists, it doesn't require PutObject requests to include a valid - // server-side encryption header. - // - // * UNKNOWN - Amazon Macie can't determine whether - // the bucket policy requires server-side encryption of new objects. - // - // Valid - // server-side encryption headers are: x-amz-server-side-encryption with a value of - // AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a - // value of AES256. + // encryption of objects when objects are added to the bucket. Possible values are: + // + // - FALSE - The bucket policy requires server-side encryption of new objects. + // PutObject requests must include a valid server-side encryption header. + // - TRUE - The bucket doesn't have a bucket policy or it has a bucket policy + // that doesn't require server-side encryption of new objects. If a bucket policy + // exists, it doesn't require PutObject requests to include a valid server-side + // encryption header. + // - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires + // server-side encryption of new objects. + // Valid server-side encryption headers are: x-amz-server-side-encryption with a + // value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm + // with a value of AES256. AllowsUnencryptedObjectUploads AllowsUnencryptedObjectUploads // The Amazon Resource Name (ARN) of the bucket. @@ -2398,12 +2279,12 @@ type S3ClassificationScope struct { noSmithyDocumentSerde } -// Specifies the names of the S3 buckets that are excluded from automated sensitive -// data discovery. +// Specifies the names of the S3 buckets that are excluded from automated +// sensitive data discovery. type S3ClassificationScopeExclusion struct { - // An array of strings, one for each S3 bucket that is excluded. Each string is the - // full name of an excluded bucket. + // An array of strings, one for each S3 bucket that is excluded. Each string is + // the full name of an excluded bucket. // // This member is required. BucketNames []string @@ -2425,17 +2306,11 @@ type S3ClassificationScopeExclusionUpdate struct { BucketNames []string // Specifies how to apply the changes to the exclusion list. Valid values are: - // - // * - // ADD - Append the specified bucket names to the current list. - // - // * REMOVE - Remove - // the specified bucket names from the current list. - // - // * REPLACE - Overwrite the - // current list with the specified list of bucket names. If you specify this value, - // Amazon Macie removes all existing names from the list and adds all the specified - // names to the list. + // - ADD - Append the specified bucket names to the current list. + // - REMOVE - Remove the specified bucket names from the current list. + // - REPLACE - Overwrite the current list with the specified list of bucket + // names. If you specify this value, Amazon Macie removes all existing names from + // the list and adds all the specified names to the list. // // This member is required. Operation ClassificationScopeUpdateOperation @@ -2493,10 +2368,10 @@ type S3JobDefinition struct { // both. BucketCriteria *S3BucketCriteriaForJob - // An array of objects, one for each Amazon Web Services account that owns specific - // S3 buckets to analyze. Each object specifies the account ID for an account and - // one or more buckets to analyze for that account. A job's definition can contain - // a bucketDefinitions array or a bucketCriteria object, not both. + // An array of objects, one for each Amazon Web Services account that owns + // specific S3 buckets to analyze. Each object specifies the account ID for an + // account and one or more buckets to analyze for that account. A job's definition + // can contain a bucketDefinitions array or a bucketCriteria object, not both. BucketDefinitions []S3BucketDefinitionForJob // The property- and tag-based conditions that determine which S3 objects to @@ -2513,9 +2388,9 @@ type S3Object struct { // The Amazon Resource Name (ARN) of the bucket that contains the object. BucketArn *string - // The entity tag (ETag) that identifies the affected version of the object. If the - // object was overwritten or changed after Amazon Macie produced the finding, this - // value might be different from the current ETag for the object. + // The entity tag (ETag) that identifies the affected version of the object. If + // the object was overwritten or changed after Amazon Macie produced the finding, + // this value might be different from the current ETag for the object. ETag *string // The file name extension of the object. If the object doesn't have a file name @@ -2525,8 +2400,8 @@ type S3Object struct { // The full key (name) that's assigned to the object. Key *string - // The date and time, in UTC and extended ISO 8601 format, when the object was last - // modified. + // The date and time, in UTC and extended ISO 8601 format, when the object was + // last modified. LastModified *time.Time // The path to the object, including the full key (name). @@ -2621,9 +2496,9 @@ type SearchResourcesCriteria struct { // including or excluding Amazon Web Services resources from the query results. type SearchResourcesCriteriaBlock struct { - // An array of objects, one for each property- or tag-based condition that includes - // or excludes resources from the query results. If you specify more than one - // condition, Amazon Macie uses AND logic to join the conditions. + // An array of objects, one for each property- or tag-based condition that + // includes or excludes resources from the query results. If you specify more than + // one condition, Amazon Macie uses AND logic to join the conditions. And []SearchResourcesCriteria noSmithyDocumentSerde @@ -2643,26 +2518,17 @@ type SearchResourcesSimpleCriterion struct { // An array that lists one or more values to use in the condition. If you specify // multiple values, Amazon Macie uses OR logic to join the values. Valid values for // each supported property (key) are: - // - // * ACCOUNT_ID - A string that represents the - // unique identifier for the Amazon Web Services account that owns the resource. - // - // * - // S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value - // that Macie defines for the BucketPublicAccess.effectivePermission - // (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission) - // property of an S3 bucket. - // - // * S3_BUCKET_NAME - A string that represents the name - // of an S3 bucket. - // - // * S3_BUCKET_SHARED_ACCESS - A string that represents an - // enumerated value that Macie defines for the BucketMetadata.sharedAccess - // (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess) - // property of an S3 bucket. - // - // Values are case sensitive. Also, Macie doesn't - // support use of partial values or wildcard characters in values. + // - ACCOUNT_ID - A string that represents the unique identifier for the Amazon + // Web Services account that owns the resource. + // - S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated + // value that Macie defines for the BucketPublicAccess.effectivePermission (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission) + // property of an S3 bucket. + // - S3_BUCKET_NAME - A string that represents the name of an S3 bucket. + // - S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that + // Macie defines for the BucketMetadata.sharedAccess (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess) + // property of an S3 bucket. + // Values are case sensitive. Also, Macie doesn't support use of partial values or + // wildcard characters in values. Values []string noSmithyDocumentSerde @@ -2683,8 +2549,8 @@ type SearchResourcesSortCriteria struct { noSmithyDocumentSerde } -// Specifies a tag-based filter condition that determines which Amazon Web Services -// resources are included or excluded from the query results. +// Specifies a tag-based filter condition that determines which Amazon Web +// Services resources are included or excluded from the query results. type SearchResourcesTagCriterion struct { // The operator to use in the condition. Valid values are EQ (equals) and NE (not @@ -2697,10 +2563,10 @@ type SearchResourcesTagCriterion struct { noSmithyDocumentSerde } -// Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a -// tag-based filter condition for a query. Tag keys and values are case sensitive. -// Also, Amazon Macie doesn't support use of partial values or wildcard characters -// in tag-based filter conditions. +// Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in +// a tag-based filter condition for a query. Tag keys and values are case +// sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard +// characters in tag-based filter conditions. type SearchResourcesTagCriterionPair struct { // The value for the tag key to use in the condition. @@ -2714,13 +2580,12 @@ type SearchResourcesTagCriterionPair struct { // Specifies configuration settings that determine which findings are published to // Security Hub automatically. For information about how Macie publishes findings -// to Security Hub, see Amazon Macie integration with Security Hub -// (https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html) in -// the Amazon Macie User Guide. +// to Security Hub, see Amazon Macie integration with Security Hub (https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html) +// in the Amazon Macie User Guide. type SecurityHubConfiguration struct { - // Specifies whether to publish sensitive data findings to Security Hub. If you set - // this value to true, Amazon Macie automatically publishes all sensitive data + // Specifies whether to publish sensitive data findings to Security Hub. If you + // set this value to true, Amazon Macie automatically publishes all sensitive data // findings that weren't suppressed by a findings filter. The default value is // false. // @@ -2750,9 +2615,9 @@ type SensitiveDataItem struct { // numbers. Category SensitiveDataItemCategory - // An array of objects, one for each type of sensitive data that was detected. Each - // object reports the number of occurrences of a specific type of sensitive data - // that was detected, and the location of up to 15 of those occurrences. + // An array of objects, one for each type of sensitive data that was detected. + // Each object reports the number of occurrences of a specific type of sensitive + // data that was detected, and the location of up to 15 of those occurrences. Detections []DefaultDetection // The total number of occurrences of the sensitive data that was detected. @@ -2776,8 +2641,8 @@ type SensitivityAggregations struct { // storage size of all versions of all applicable objects in the buckets. ClassifiableSizeInBytes int64 - // The total number of buckets that are publicly accessible due to a combination of - // permissions settings for each bucket. + // The total number of buckets that are publicly accessible due to a combination + // of permissions settings for each bucket. PubliclyAccessibleCount int64 // The total number of buckets. @@ -2795,27 +2660,25 @@ type SensitivityAggregations struct { // Specifies managed data identifiers to exclude (not use) when performing // automated sensitive data discovery for an Amazon Macie account. For information // about the managed data identifiers that Amazon Macie currently provides, see -// Using managed data identifiers -// (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) in -// the Amazon Macie User Guide. +// Using managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) +// in the Amazon Macie User Guide. type SensitivityInspectionTemplateExcludes struct { - // An array of unique identifiers, one for each managed data identifier to exclude. - // To retrieve a list of valid values, use the ListManagedDataIdentifiers + // An array of unique identifiers, one for each managed data identifier to + // exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers // operation. ManagedDataIdentifierIds []string noSmithyDocumentSerde } -// Specifies the allow lists, custom data identifiers, and managed data identifiers -// to include (use) when performing automated sensitive data discovery for an -// Amazon Macie account. The configuration must specify at least one custom data -// identifier or managed data identifier. For information about the managed data -// identifiers that Amazon Macie currently provides, see Using managed data -// identifiers -// (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) in -// the Amazon Macie User Guide. +// Specifies the allow lists, custom data identifiers, and managed data +// identifiers to include (use) when performing automated sensitive data discovery +// for an Amazon Macie account. The configuration must specify at least one custom +// data identifier or managed data identifier. For information about the managed +// data identifiers that Amazon Macie currently provides, see Using managed data +// identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) +// in the Amazon Macie User Guide. type SensitivityInspectionTemplateIncludes struct { // An array of unique identifiers, one for each allow list to include. @@ -2824,9 +2687,9 @@ type SensitivityInspectionTemplateIncludes struct { // An array of unique identifiers, one for each custom data identifier to include. CustomDataIdentifierIds []string - // An array of unique identifiers, one for each managed data identifier to include. - // Amazon Macie uses these managed data identifiers in addition to managed data - // identifiers that are subsequently released and recommended for automated + // An array of unique identifiers, one for each managed data identifier to + // include. Amazon Macie uses these managed data identifiers in addition to managed + // data identifiers that are subsequently released and recommended for automated // sensitive data discovery. To retrieve a list of valid values for the managed // data identifiers that are currently available, use the // ListManagedDataIdentifiers operation. @@ -2850,13 +2713,14 @@ type SensitivityInspectionTemplatesEntry struct { noSmithyDocumentSerde } -// Provides information about the default server-side encryption settings for an S3 -// bucket or the encryption settings for an S3 object. +// Provides information about the default server-side encryption settings for an +// S3 bucket or the encryption settings for an S3 object. type ServerSideEncryption struct { - // The server-side encryption algorithm that's used when storing data in the bucket - // or object. If default encryption settings aren't configured for the bucket or - // the object isn't encrypted using server-side encryption, this value is NONE. + // The server-side encryption algorithm that's used when storing data in the + // bucket or object. If default encryption settings aren't configured for the + // bucket or the object isn't encrypted using server-side encryption, this value is + // NONE. EncryptionType EncryptionType // The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key @@ -2912,8 +2776,8 @@ type SessionContextAttributes struct { noSmithyDocumentSerde } -// Provides information about the source and type of temporary security credentials -// that were issued to an entity. +// Provides information about the source and type of temporary security +// credentials that were issued to an entity. type SessionIssuer struct { // The unique identifier for the Amazon Web Services account that owns the entity @@ -2992,26 +2856,17 @@ type SimpleCriterionForJob struct { // An array that lists one or more values to use in the condition. If you specify // multiple values, Amazon Macie uses OR logic to join the values. Valid values for // each supported property (key) are: - // - // * ACCOUNT_ID - A string that represents the - // unique identifier for the Amazon Web Services account that owns the bucket. - // - // * - // S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value - // that Macie defines for the BucketPublicAccess.effectivePermission - // (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission) - // property of a bucket. - // - // * S3_BUCKET_NAME - A string that represents the name of a - // bucket. - // - // * S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated - // value that Macie defines for the BucketMetadata.sharedAccess - // (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess) - // property of a bucket. - // - // Values are case sensitive. Also, Macie doesn't support - // use of partial values or wildcard characters in these values. + // - ACCOUNT_ID - A string that represents the unique identifier for the Amazon + // Web Services account that owns the bucket. + // - S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated + // value that Macie defines for the BucketPublicAccess.effectivePermission (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission) + // property of a bucket. + // - S3_BUCKET_NAME - A string that represents the name of a bucket. + // - S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that + // Macie defines for the BucketMetadata.sharedAccess (https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess) + // property of a bucket. + // Values are case sensitive. Also, Macie doesn't support use of partial values or + // wildcard characters in these values. Values []string noSmithyDocumentSerde @@ -3023,45 +2878,31 @@ type SimpleScopeTerm struct { // The operator to use in the condition. Valid values for each supported property // (key) are: - // - // * OBJECT_EXTENSION - EQ (equals) or NE (not equals) - // - // * OBJECT_KEY - - // STARTS_WITH - // - // * OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS - // - // * - // OBJECT_SIZE - Any operator except CONTAINS + // - OBJECT_EXTENSION - EQ (equals) or NE (not equals) + // - OBJECT_KEY - STARTS_WITH + // - OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS + // - OBJECT_SIZE - Any operator except CONTAINS Comparator JobComparator // The object property to use in the condition. Key ScopeFilterKey - // An array that lists the values to use in the condition. If the value for the key - // property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple + // An array that lists the values to use in the condition. If the value for the + // key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple // values and Amazon Macie uses OR logic to join the values. Otherwise, this array - // can specify only one value. Valid values for each supported property (key) - // are: - // - // * OBJECT_EXTENSION - A string that represents the file name extension of - // an object. For example: docx or pdf - // - // * OBJECT_KEY - A string that represents the - // key prefix (folder name or path) of an object. For example: logs or - // awslogs/eventlogs. This value applies a condition to objects whose keys (names) - // begin with the specified value. - // - // * OBJECT_LAST_MODIFIED_DATE - The date and time - // (in UTC and extended ISO 8601 format) when an object was created or last - // changed, whichever is latest. For example: 2020-09-28T14:31:13Z - // - // * OBJECT_SIZE - - // An integer that represents the storage size (in bytes) of an object. - // - // Macie - // doesn't support use of wildcard characters in these values. Also, string values - // are case sensitive. + // can specify only one value. Valid values for each supported property (key) are: + // - OBJECT_EXTENSION - A string that represents the file name extension of an + // object. For example: docx or pdf + // - OBJECT_KEY - A string that represents the key prefix (folder name or path) + // of an object. For example: logs or awslogs/eventlogs. This value applies a + // condition to objects whose keys (names) begin with the specified value. + // - OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 + // format) when an object was created or last changed, whichever is latest. For + // example: 2020-09-28T14:31:13Z + // - OBJECT_SIZE - An integer that represents the storage size (in bytes) of an + // object. + // Macie doesn't support use of wildcard characters in these values. Also, string + // values are case sensitive. Values []string noSmithyDocumentSerde @@ -3112,8 +2953,8 @@ type SuppressDataIdentifier struct { noSmithyDocumentSerde } -// Specifies a tag-based condition that determines whether an S3 bucket is included -// or excluded from a classification job. +// Specifies a tag-based condition that determines whether an S3 bucket is +// included or excluded from a classification job. type TagCriterionForJob struct { // The operator to use in the condition. Valid values are EQ (equals) and NE (not @@ -3126,11 +2967,11 @@ type TagCriterionForJob struct { noSmithyDocumentSerde } -// Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a -// tag-based condition that determines whether an S3 bucket is included or excluded -// from a classification job. Tag keys and values are case sensitive. Also, Amazon -// Macie doesn't support use of partial values or wildcard characters in tag-based -// conditions. +// Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in +// a tag-based condition that determines whether an S3 bucket is included or +// excluded from a classification job. Tag keys and values are case sensitive. +// Also, Amazon Macie doesn't support use of partial values or wildcard characters +// in tag-based conditions. type TagCriterionPairForJob struct { // The value for the tag key to use in the condition. @@ -3142,8 +2983,8 @@ type TagCriterionPairForJob struct { noSmithyDocumentSerde } -// Specifies a tag-based condition that determines whether an S3 object is included -// or excluded from a classification job. +// Specifies a tag-based condition that determines whether an S3 object is +// included or excluded from a classification job. type TagScopeTerm struct { // The operator to use in the condition. Valid values are EQ (equals) or NE (not @@ -3153,9 +2994,9 @@ type TagScopeTerm struct { // The object property to use in the condition. The only valid value is TAG. Key *string - // The tag keys or tag key and value pairs to use in the condition. To specify only - // tag keys in a condition, specify the keys in this array and set the value for - // each associated tag value to an empty string. + // The tag keys or tag key and value pairs to use in the condition. To specify + // only tag keys in a condition, specify the keys in this array and set the value + // for each associated tag value to an empty string. TagValues []TagValuePair // The type of object to apply the condition to. @@ -3264,20 +3105,12 @@ type UsageStatisticsFilter struct { // field specified by the key property. If the value for the key property is // accountId, this array can specify multiple values. Otherwise, this array can // specify only one value. Valid values for each supported field are: - // - // * accountId - // - The unique identifier for an Amazon Web Services account. - // - // * - // freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, - // when the Amazon Macie free trial started for an account. - // - // * serviceLimit - A - // Boolean (true or false) value that indicates whether an account has reached its - // monthly quota. - // - // * total - A string that represents the current estimated cost - // for an account. + // - accountId - The unique identifier for an Amazon Web Services account. + // - freeTrialStartDate - The date and time, in UTC and extended ISO 8601 + // format, when the Amazon Macie free trial started for an account. + // - serviceLimit - A Boolean (true or false) value that indicates whether an + // account has reached its monthly quota. + // - total - A string that represents the current estimated cost for an account. Values []string noSmithyDocumentSerde @@ -3334,8 +3167,8 @@ type UserIdentity struct { // Services account, the details of that account. AwsAccount *AwsAccount - // If the action was performed by an Amazon Web Services account that belongs to an - // Amazon Web Service, the name of the service. + // If the action was performed by an Amazon Web Services account that belongs to + // an Amazon Web Service, the name of the service. AwsService *AwsService // If the action was performed with temporary security credentials that were diff --git a/service/managedblockchain/api_client.go b/service/managedblockchain/api_client.go index 333ec7845da..4903d5b97d4 100644 --- a/service/managedblockchain/api_client.go +++ b/service/managedblockchain/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/managedblockchain/api_op_CreateAccessor.go b/service/managedblockchain/api_op_CreateAccessor.go index d31f37b9fd6..f252bc6cbf0 100644 --- a/service/managedblockchain/api_op_CreateAccessor.go +++ b/service/managedblockchain/api_op_CreateAccessor.go @@ -32,7 +32,7 @@ func (c *Client) CreateAccessor(ctx context.Context, params *CreateAccessorInput type CreateAccessorInput struct { - // The type of accessor. Currently accessor type is restricted to BILLING_TOKEN. + // The type of accessor. Currently accessor type is restricted to BILLING_TOKEN . // // This member is required. AccessorType types.AccessorType @@ -49,10 +49,8 @@ type CreateAccessorInput struct { // Tags to assign to the Accessor. Each tag consists of a key and an optional // value. You can specify multiple key-value pairs in a single request with an // overall maximum of 50 tags allowed per resource. For more information about - // tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -64,9 +62,10 @@ type CreateAccessorOutput struct { // The unique identifier of the accessor. AccessorId *string - // The billing token is a property of the Accessor. Use this token to make Ethereum - // API calls to your Ethereum node. The billing token is used to track your - // accessor object for billing Ethereum API requests made to your Ethereum nodes. + // The billing token is a property of the Accessor. Use this token to make + // Ethereum API calls to your Ethereum node. The billing token is used to track + // your accessor object for billing Ethereum API requests made to your Ethereum + // nodes. BillingToken *string // Metadata pertaining to the operation's result. diff --git a/service/managedblockchain/api_op_CreateNetwork.go b/service/managedblockchain/api_op_CreateNetwork.go index 94d33c80435..31a0f09657a 100644 --- a/service/managedblockchain/api_op_CreateNetwork.go +++ b/service/managedblockchain/api_op_CreateNetwork.go @@ -72,13 +72,11 @@ type CreateNetworkInput struct { // configuration. FrameworkConfiguration *types.NetworkFrameworkConfiguration - // Tags to assign to the network. Each tag consists of a key and an optional value. - // You can specify multiple key-value pairs in a single request with an overall - // maximum of 50 tags allowed per resource. For more information about tags, see - // Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // Tags to assign to the network. Each tag consists of a key and an optional + // value. You can specify multiple key-value pairs in a single request with an + // overall maximum of 50 tags allowed per resource. For more information about + // tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string diff --git a/service/managedblockchain/api_op_CreateNode.go b/service/managedblockchain/api_op_CreateNode.go index f19365428ab..25166d0082f 100644 --- a/service/managedblockchain/api_op_CreateNode.go +++ b/service/managedblockchain/api_op_CreateNode.go @@ -40,17 +40,12 @@ type CreateNodeInput struct { // This member is required. ClientRequestToken *string - // The unique identifier of the network for the node. Ethereum public networks have - // the following NetworkIds: - // - // * n-ethereum-mainnet - // - // * n-ethereum-goerli - // - // * - // n-ethereum-rinkeby - // - // * n-ethereum-ropsten + // The unique identifier of the network for the node. Ethereum public networks + // have the following NetworkId s: + // - n-ethereum-mainnet + // - n-ethereum-goerli + // - n-ethereum-rinkeby + // - n-ethereum-ropsten // // This member is required. NetworkId *string @@ -67,10 +62,8 @@ type CreateNodeInput struct { // Tags to assign to the node. Each tag consists of a key and an optional value. // You can specify multiple key-value pairs in a single request with an overall // maximum of 50 tags allowed per resource. For more information about tags, see - // Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string diff --git a/service/managedblockchain/api_op_CreateProposal.go b/service/managedblockchain/api_op_CreateProposal.go index d5b336af46a..3a84218faae 100644 --- a/service/managedblockchain/api_op_CreateProposal.go +++ b/service/managedblockchain/api_op_CreateProposal.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a proposal for a change to the network that other members of the network -// can vote on, for example, a proposal to add a new member to the network. Any -// member can create a proposal. Applies only to Hyperledger Fabric. +// Creates a proposal for a change to the network that other members of the +// network can vote on, for example, a proposal to add a new member to the network. +// Any member can create a proposal. Applies only to Hyperledger Fabric. func (c *Client) CreateProposal(ctx context.Context, params *CreateProposalInput, optFns ...func(*Options)) (*CreateProposalOutput, error) { if params == nil { params = &CreateProposalInput{} @@ -67,10 +67,8 @@ type CreateProposalInput struct { // Tags to assign to the proposal. Each tag consists of a key and an optional // value. You can specify multiple key-value pairs in a single request with an // overall maximum of 50 tags allowed per resource. For more information about - // tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string diff --git a/service/managedblockchain/api_op_DeleteAccessor.go b/service/managedblockchain/api_op_DeleteAccessor.go index 4528787e412..e4e2c523392 100644 --- a/service/managedblockchain/api_op_DeleteAccessor.go +++ b/service/managedblockchain/api_op_DeleteAccessor.go @@ -12,8 +12,8 @@ import ( // Deletes an accessor that your Amazon Web Services account owns. An accessor // object is a container that has the information required for token based access -// to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is -// deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. +// to your Ethereum nodes including, the BILLING_TOKEN . After an accessor is +// deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION . // An accessor in the PENDING_DELETION state can’t be used for new WebSocket // requests or HTTP requests. However, WebSocket connections that were initiated // while the accessor was in the AVAILABLE state remain open until they expire (up diff --git a/service/managedblockchain/api_op_DeleteNode.go b/service/managedblockchain/api_op_DeleteNode.go index ee1521dbdec..6150407dea7 100644 --- a/service/managedblockchain/api_op_DeleteNode.go +++ b/service/managedblockchain/api_op_DeleteNode.go @@ -30,16 +30,11 @@ func (c *Client) DeleteNode(ctx context.Context, params *DeleteNodeInput, optFns type DeleteNodeInput struct { // The unique identifier of the network that the node is on. Ethereum public - // networks have the following NetworkIds: - // - // * n-ethereum-mainnet - // - // * - // n-ethereum-goerli - // - // * n-ethereum-rinkeby - // - // * n-ethereum-ropsten + // networks have the following NetworkId s: + // - n-ethereum-mainnet + // - n-ethereum-goerli + // - n-ethereum-rinkeby + // - n-ethereum-ropsten // // This member is required. NetworkId *string diff --git a/service/managedblockchain/api_op_ListMembers.go b/service/managedblockchain/api_op_ListMembers.go index ecddd90b207..4729acf70f9 100644 --- a/service/managedblockchain/api_op_ListMembers.go +++ b/service/managedblockchain/api_op_ListMembers.go @@ -36,9 +36,9 @@ type ListMembersInput struct { // This member is required. NetworkId *string - // An optional Boolean value. If provided, the request is limited either to members - // that the current Amazon Web Services account owns (true) or that other Amazon - // Web Services accountsn own (false). If omitted, all members are listed. + // An optional Boolean value. If provided, the request is limited either to + // members that the current Amazon Web Services account owns ( true ) or that other + // Amazon Web Services accountsn own ( false ). If omitted, all members are listed. IsOwned *bool // The maximum number of members to return in the request. @@ -50,8 +50,8 @@ type ListMembersInput struct { // The pagination token that indicates the next set of results to retrieve. NextToken *string - // An optional status specifier. If provided, only members currently in this status - // are listed. + // An optional status specifier. If provided, only members currently in this + // status are listed. Status types.MemberStatus noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_ListTagsForResource.go b/service/managedblockchain/api_op_ListTagsForResource.go index 849c402210a..afa4d304803 100644 --- a/service/managedblockchain/api_op_ListTagsForResource.go +++ b/service/managedblockchain/api_op_ListTagsForResource.go @@ -11,10 +11,8 @@ import ( ) // Returns a list of tags for the specified resource. Each tag consists of a key -// and optional value. For more information about tags, see Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) -// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) +// and optional value. For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) +// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -34,9 +32,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/managedblockchain/api_op_TagResource.go b/service/managedblockchain/api_op_TagResource.go index 8b1ab547822..d96274767b2 100644 --- a/service/managedblockchain/api_op_TagResource.go +++ b/service/managedblockchain/api_op_TagResource.go @@ -15,10 +15,8 @@ import ( // specify a tag key that already exists, the tag value is overwritten with the new // value. Use UntagResource to remove tag keys. A resource can have up to 50 tags. // If you try to create more than 50 tags for a resource, your request fails and -// returns an error. For more information about tags, see Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) -// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) +// returns an error. For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) +// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -38,15 +36,14 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string // The tags to assign to the specified resource. Tag values can be empty, for - // example, "MyTagKey" : "". You can specify multiple key-value pairs in a single + // example, "MyTagKey" : "" . You can specify multiple key-value pairs in a single // request, with an overall maximum of 50 tags added to each resource. // // This member is required. diff --git a/service/managedblockchain/api_op_UntagResource.go b/service/managedblockchain/api_op_UntagResource.go index ce655e40ba5..d0bd520bda3 100644 --- a/service/managedblockchain/api_op_UntagResource.go +++ b/service/managedblockchain/api_op_UntagResource.go @@ -10,11 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified tags from the Amazon Managed Blockchain resource. For more -// information about tags, see Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) -// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources -// (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) +// Removes the specified tags from the Amazon Managed Blockchain resource. For +// more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) +// in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { @@ -34,9 +32,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/managedblockchain/api_op_VoteOnProposal.go b/service/managedblockchain/api_op_VoteOnProposal.go index 7e28159c815..6deea09e41d 100644 --- a/service/managedblockchain/api_op_VoteOnProposal.go +++ b/service/managedblockchain/api_op_VoteOnProposal.go @@ -12,7 +12,7 @@ import ( ) // Casts a vote for a specified ProposalId on behalf of a member. The member to -// vote as, specified by VoterMemberId, must be in the same Amazon Web Services +// vote as, specified by VoterMemberId , must be in the same Amazon Web Services // account as the principal that calls the action. Applies only to Hyperledger // Fabric. func (c *Client) VoteOnProposal(ctx context.Context, params *VoteOnProposalInput, optFns ...func(*Options)) (*VoteOnProposalOutput, error) { diff --git a/service/managedblockchain/types/enums.go b/service/managedblockchain/types/enums.go index 9fa5cb5f72f..f031308ed74 100644 --- a/service/managedblockchain/types/enums.go +++ b/service/managedblockchain/types/enums.go @@ -29,9 +29,9 @@ const ( AccessorTypeBillingToken AccessorType = "BILLING_TOKEN" ) -// Values returns all known values for AccessorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AccessorType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AccessorType) Values() []AccessorType { return []AccessorType{ "BILLING_TOKEN", @@ -64,9 +64,9 @@ const ( FrameworkEthereum Framework = "ETHEREUM" ) -// Values returns all known values for Framework. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Framework. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Framework) Values() []Framework { return []Framework{ "HYPERLEDGER_FABRIC", @@ -111,9 +111,9 @@ const ( MemberStatusInaccessibleEncryptionKey MemberStatus = "INACCESSIBLE_ENCRYPTION_KEY" ) -// Values returns all known values for MemberStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MemberStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MemberStatus) Values() []MemberStatus { return []MemberStatus{ "CREATING", @@ -250,9 +250,9 @@ const ( VoteValueNo VoteValue = "NO" ) -// Values returns all known values for VoteValue. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for VoteValue. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (VoteValue) Values() []VoteValue { return []VoteValue{ "YES", diff --git a/service/managedblockchain/types/errors.go b/service/managedblockchain/types/errors.go index df32e0850f7..e76883088cc 100644 --- a/service/managedblockchain/types/errors.go +++ b/service/managedblockchain/types/errors.go @@ -138,9 +138,9 @@ func (e *ResourceAlreadyExistsException) ErrorCode() string { } func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The maximum number of resources of that type already exist. Ensure the resources -// requested are within the boundaries of the service edition and your account -// limits. +// The maximum number of resources of that type already exist. Ensure the +// resources requested are within the boundaries of the service edition and your +// account limits. type ResourceLimitExceededException struct { Message *string diff --git a/service/managedblockchain/types/types.go b/service/managedblockchain/types/types.go index e9af8cad522..c01c91c062a 100644 --- a/service/managedblockchain/types/types.go +++ b/service/managedblockchain/types/types.go @@ -11,14 +11,14 @@ import ( type Accessor struct { // The Amazon Resource Name (ARN) of the accessor. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string - // The billing token is a property of the accessor. Use this token to make Ethereum - // API calls to your Ethereum node. The billing token is used to track your - // accessor object for billing Ethereum API requests made to your Ethereum nodes. + // The billing token is a property of the accessor. Use this token to make + // Ethereum API calls to your Ethereum node. The billing token is used to track + // your accessor object for billing Ethereum API requests made to your Ethereum + // nodes. BillingToken *string // The creation date and time of the accessor. @@ -31,15 +31,13 @@ type Accessor struct { Status AccessorStatus // The tags assigned to the Accessor. For more information about tags, see Tagging - // Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string - // The type of the accessor. Currently accessor type is restricted to - // BILLING_TOKEN. + // The type of the accessor. Currently accessor type is restricted to BILLING_TOKEN + // . Type AccessorType noSmithyDocumentSerde @@ -49,9 +47,8 @@ type Accessor struct { type AccessorSummary struct { // The Amazon Resource Name (ARN) of the accessor. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The creation date and time of the accessor. @@ -63,17 +60,17 @@ type AccessorSummary struct { // The current status of the accessor. Status AccessorStatus - // The type of the accessor. Currently accessor type is restricted to - // BILLING_TOKEN. + // The type of the accessor. Currently accessor type is restricted to BILLING_TOKEN + // . Type AccessorType noSmithyDocumentSerde } -// A policy type that defines the voting rules for the network. The rules decide if -// a proposal is approved. Approval may be based on criteria such as the percentage -// of YES votes and the duration of the proposal. The policy applies to all -// proposals and is specified when the network is created. Applies only to +// A policy type that defines the voting rules for the network. The rules decide +// if a proposal is approved. Approval may be based on criteria such as the +// percentage of YES votes and the duration of the proposal. The policy applies to +// all proposals and is specified when the network is created. Applies only to // Hyperledger Fabric. type ApprovalThresholdPolicy struct { @@ -92,7 +89,7 @@ type ApprovalThresholdPolicy struct { // approved. For example, a ThresholdPercentage value of 50 indicates 50%. The // ThresholdComparator determines the precise comparison. If a ThresholdPercentage // value of 50 is specified on a network with 10 members, along with a - // ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are + // ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are // required for the proposal to be approved. ThresholdPercentage *int32 @@ -104,18 +101,17 @@ type ApprovalThresholdPolicy struct { type Invitation struct { // The Amazon Resource Name (ARN) of the invitation. For more information about - // ARNs and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // ARNs and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the invitation was created. CreationDate *time.Time - // The date and time that the invitation expires. This is the CreationDate plus the - // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After - // this date and time, the invitee can no longer create a member and join the - // network using this InvitationId. + // The date and time that the invitation expires. This is the CreationDate plus + // the ProposalDurationInHours that is specified in the ProposalThresholdPolicy . + // After this date and time, the invitee can no longer create a member and join the + // network using this InvitationId . ExpirationDate *time.Time // The unique identifier for the invitation. @@ -125,22 +121,15 @@ type Invitation struct { NetworkSummary *NetworkSummary // The status of the invitation: - // - // * PENDING - The invitee hasn't created a member - // to join the network, and the invitation hasn't yet expired. - // - // * ACCEPTING - The - // invitee has begun creating a member, and creation hasn't yet completed. - // - // * - // ACCEPTED - The invitee created a member and joined the network using the - // InvitationID. - // - // * REJECTED - The invitee rejected the invitation. - // - // * EXPIRED - - // The invitee neither created a member nor rejected the invitation before the - // ExpirationDate. + // - PENDING - The invitee hasn't created a member to join the network, and the + // invitation hasn't yet expired. + // - ACCEPTING - The invitee has begun creating a member, and creation hasn't yet + // completed. + // - ACCEPTED - The invitee created a member and joined the network using the + // InvitationID . + // - REJECTED - The invitee rejected the invitation. + // - EXPIRED - The invitee neither created a member nor rejected the invitation + // before the ExpirationDate . Status InvitationStatus noSmithyDocumentSerde @@ -148,7 +137,7 @@ type Invitation struct { // An action to invite a specific Amazon Web Services account to create a member // and join the network. The InviteAction is carried out when a Proposal is -// APPROVED. Applies only to Hyperledger Fabric. +// APPROVED . Applies only to Hyperledger Fabric. type InviteAction struct { // The Amazon Web Services account ID to invite. @@ -181,9 +170,8 @@ type LogConfigurations struct { type Member struct { // The Amazon Resource Name (ARN) of the member. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the member was created. @@ -201,10 +189,9 @@ type Member struct { // The Amazon Resource Name (ARN) of the customer managed key in Key Management // Service (KMS) that the member uses for encryption at rest. If the value of this - // parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned + // parameter is "AWS Owned KMS Key" , the member uses an Amazon Web Services owned // KMS key for encryption. This parameter is inherited by the nodes that this - // member owns. For more information, see Encryption at Rest - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) + // member owns. For more information, see Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. KmsKeyArn *string @@ -218,44 +205,32 @@ type Member struct { NetworkId *string // The status of a member. - // - // * CREATING - The Amazon Web Services account is in the - // process of creating a member. - // - // * AVAILABLE - The member has been created and can - // participate in the network. - // - // * CREATE_FAILED - The Amazon Web Services account - // attempted to create a member and creation failed. - // - // * UPDATING - The member is in - // the process of being updated. - // - // * DELETING - The member and all associated - // resources are in the process of being deleted. Either the Amazon Web Services - // account that owns the member deleted it, or the member is being deleted as the - // result of an APPROVEDPROPOSAL to remove the member. - // - // * DELETED - The member can - // no longer participate on the network and all associated resources are deleted. - // Either the Amazon Web Services account that owns the member deleted it, or the - // member is being deleted as the result of an APPROVEDPROPOSAL to remove the - // member. - // - // * INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not - // function as expected because it cannot access the specified customer managed key - // in KMS for encryption at rest. Either the KMS key was disabled or deleted, or - // the grants on the key were revoked. The effect of disabling or deleting a key or - // of revoking a grant isn't immediate. It might take some time for the member - // resource to discover that the key is inaccessible. When a resource is in this - // state, we recommend deleting and recreating the resource. + // - CREATING - The Amazon Web Services account is in the process of creating a + // member. + // - AVAILABLE - The member has been created and can participate in the network. + // - CREATE_FAILED - The Amazon Web Services account attempted to create a member + // and creation failed. + // - UPDATING - The member is in the process of being updated. + // - DELETING - The member and all associated resources are in the process of + // being deleted. Either the Amazon Web Services account that owns the member + // deleted it, or the member is being deleted as the result of an APPROVED + // PROPOSAL to remove the member. + // - DELETED - The member can no longer participate on the network and all + // associated resources are deleted. Either the Amazon Web Services account that + // owns the member deleted it, or the member is being deleted as the result of an + // APPROVED PROPOSAL to remove the member. + // - INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function + // as expected because it cannot access the specified customer managed key in KMS + // for encryption at rest. Either the KMS key was disabled or deleted, or the + // grants on the key were revoked. The effect of disabling or deleting a key or of + // revoking a grant isn't immediate. It might take some time for the member + // resource to discover that the key is inaccessible. When a resource is in this + // state, we recommend deleting and recreating the resource. Status MemberStatus // Tags assigned to the member. Tags consist of a key and optional value. For more - // information about tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -281,23 +256,18 @@ type MemberConfiguration struct { // The Amazon Resource Name (ARN) of the customer managed key in Key Management // Service (KMS) to use for encryption at rest in the member. This parameter is // inherited by any nodes that this member creates. For more information, see - // Encryption at Rest - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) + // Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Use one of // the following options to specify this parameter: - // - // * Undefined or empty string - - // By default, use an KMS key that is owned and managed by Amazon Web Services on - // your behalf. - // - // * A valid symmetric customer managed KMS key - Use the specified - // KMS key in your account that you create, own, and manage. Amazon Managed - // Blockchain doesn't support asymmetric keys. For more information, see Using - // symmetric and asymmetric keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) - // in the Key Management Service Developer Guide. The following is an example of a - // KMS key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Undefined or empty string - By default, use an KMS key that is owned and + // managed by Amazon Web Services on your behalf. + // - A valid symmetric customer managed KMS key - Use the specified KMS key in + // your account that you create, own, and manage. Amazon Managed Blockchain doesn't + // support asymmetric keys. For more information, see Using symmetric and + // asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // in the Key Management Service Developer Guide. The following is an example of a + // KMS key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab KmsKeyArn *string // Configuration properties for logging events associated with a member of a @@ -307,10 +277,8 @@ type MemberConfiguration struct { // Tags assigned to the member. Tags consist of a key and optional value. When // specifying tags during creation, you can specify multiple key-value pairs in a // single request, with an overall maximum of 50 tags added to each resource. For - // more information about tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -401,9 +369,8 @@ type MemberLogPublishingConfiguration struct { type MemberSummary struct { // The Amazon Resource Name (ARN) of the member. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the member was created. @@ -423,38 +390,27 @@ type MemberSummary struct { Name *string // The status of the member. - // - // * CREATING - The Amazon Web Services account is in - // the process of creating a member. - // - // * AVAILABLE - The member has been created and - // can participate in the network. - // - // * CREATE_FAILED - The Amazon Web Services - // account attempted to create a member and creation failed. - // - // * UPDATING - The - // member is in the process of being updated. - // - // * DELETING - The member and all - // associated resources are in the process of being deleted. Either the Amazon Web - // Services account that owns the member deleted it, or the member is being deleted - // as the result of an APPROVEDPROPOSAL to remove the member. - // - // * DELETED - The - // member can no longer participate on the network and all associated resources are - // deleted. Either the Amazon Web Services account that owns the member deleted it, - // or the member is being deleted as the result of an APPROVEDPROPOSAL to remove - // the member. - // - // * INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might - // not function as expected because it cannot access the specified customer managed - // key in Key Management Service (KMS) for encryption at rest. Either the KMS key - // was disabled or deleted, or the grants on the key were revoked. The effect of - // disabling or deleting a key or of revoking a grant isn't immediate. It might - // take some time for the member resource to discover that the key is inaccessible. - // When a resource is in this state, we recommend deleting and recreating the - // resource. + // - CREATING - The Amazon Web Services account is in the process of creating a + // member. + // - AVAILABLE - The member has been created and can participate in the network. + // - CREATE_FAILED - The Amazon Web Services account attempted to create a member + // and creation failed. + // - UPDATING - The member is in the process of being updated. + // - DELETING - The member and all associated resources are in the process of + // being deleted. Either the Amazon Web Services account that owns the member + // deleted it, or the member is being deleted as the result of an APPROVED + // PROPOSAL to remove the member. + // - DELETED - The member can no longer participate on the network and all + // associated resources are deleted. Either the Amazon Web Services account that + // owns the member deleted it, or the member is being deleted as the result of an + // APPROVED PROPOSAL to remove the member. + // - INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function + // as expected because it cannot access the specified customer managed key in Key + // Management Service (KMS) for encryption at rest. Either the KMS key was disabled + // or deleted, or the grants on the key were revoked. The effect of disabling or + // deleting a key or of revoking a grant isn't immediate. It might take some time + // for the member resource to discover that the key is inaccessible. When a + // resource is in this state, we recommend deleting and recreating the resource. Status MemberStatus noSmithyDocumentSerde @@ -464,9 +420,8 @@ type MemberSummary struct { type Network struct { // The Amazon Resource Name (ARN) of the network. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the network was created. @@ -493,11 +448,9 @@ type Network struct { // The current status of the network. Status NetworkStatus - // Tags assigned to the network. Each tag consists of a key and optional value. For - // more information about tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // Tags assigned to the network. Each tag consists of a key and optional value. + // For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -517,14 +470,10 @@ type NetworkEthereumAttributes struct { // The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as // follows: - // - // * mainnet = 1 - // - // * goerli = 5 - // - // * rinkeby = 4 - // - // * ropsten = 3 + // - mainnet = 1 + // - goerli = 5 + // - rinkeby = 4 + // - ropsten = 3 ChainId *string noSmithyDocumentSerde @@ -534,8 +483,8 @@ type NetworkEthereumAttributes struct { type NetworkFabricAttributes struct { // The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more - // information, see Amazon Managed Blockchain Pricing - // (http://aws.amazon.com/managed-blockchain/pricing/). + // information, see Amazon Managed Blockchain Pricing (http://aws.amazon.com/managed-blockchain/pricing/) + // . Edition Edition // The endpoint of the ordering service for the network. @@ -548,8 +497,8 @@ type NetworkFabricAttributes struct { type NetworkFabricConfiguration struct { // The edition of Amazon Managed Blockchain that the network uses. For more - // information, see Amazon Managed Blockchain Pricing - // (http://aws.amazon.com/managed-blockchain/pricing/). + // information, see Amazon Managed Blockchain Pricing (http://aws.amazon.com/managed-blockchain/pricing/) + // . // // This member is required. Edition Edition @@ -557,12 +506,12 @@ type NetworkFabricConfiguration struct { noSmithyDocumentSerde } -// Attributes relevant to the network for the blockchain framework that the network -// uses. +// Attributes relevant to the network for the blockchain framework that the +// network uses. type NetworkFrameworkAttributes struct { - // Attributes of an Ethereum network for Managed Blockchain resources participating - // in an Ethereum network. + // Attributes of an Ethereum network for Managed Blockchain resources + // participating in an Ethereum network. Ethereum *NetworkEthereumAttributes // Attributes of Hyperledger Fabric for a Managed Blockchain network that uses @@ -587,9 +536,8 @@ type NetworkFrameworkConfiguration struct { type NetworkSummary struct { // The Amazon Resource Name (ARN) of the network. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the network was created. @@ -620,9 +568,8 @@ type NetworkSummary struct { type Node struct { // The Amazon Resource Name (ARN) of the node. For more information about ARNs and - // their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The Availability Zone in which the node exists. Required for Ethereum nodes. @@ -642,10 +589,9 @@ type Node struct { // The Amazon Resource Name (ARN) of the customer managed key in Key Management // Service (KMS) that the node uses for encryption at rest. If the value of this - // parameter is "AWS Owned KMS Key", the node uses an Amazon Web Services owned KMS - // key for encryption. The node inherits this parameter from the member that it - // belongs to. For more information, see Encryption at Rest - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) + // parameter is "AWS Owned KMS Key" , the node uses an Amazon Web Services owned + // KMS key for encryption. The node inherits this parameter from the member that it + // belongs to. For more information, see Encryption at Rest (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Applies // only to Hyperledger Fabric. KmsKeyArn *string @@ -661,52 +607,37 @@ type Node struct { // The unique identifier of the network that the node is on. NetworkId *string - // The state database that the node uses. Values are LevelDB or CouchDB. Applies + // The state database that the node uses. Values are LevelDB or CouchDB . Applies // only to Hyperledger Fabric. StateDB StateDBType // The status of the node. - // - // * CREATING - The Amazon Web Services account is in the - // process of creating a node. - // - // * AVAILABLE - The node has been created and can - // participate in the network. - // - // * UNHEALTHY - The node is impaired and might not - // function as expected. Amazon Managed Blockchain automatically finds nodes in - // this state and tries to recover them. If a node is recoverable, it returns to - // AVAILABLE. Otherwise, it moves to FAILED status. - // - // * CREATE_FAILED - The Amazon - // Web Services account attempted to create a node and creation failed. - // - // * UPDATING - // - The node is in the process of being updated. - // - // * DELETING - The node is in the - // process of being deleted. - // - // * DELETED - The node can no longer participate on the - // network. - // - // * FAILED - The node is no longer functional, cannot be recovered, and - // must be deleted. - // - // * INACCESSIBLE_ENCRYPTION_KEY - The node is impaired and might - // not function as expected because it cannot access the specified customer managed - // key in KMS for encryption at rest. Either the KMS key was disabled or deleted, - // or the grants on the key were revoked. The effect of disabling or deleting a key - // or of revoking a grant isn't immediate. It might take some time for the node - // resource to discover that the key is inaccessible. When a resource is in this - // state, we recommend deleting and recreating the resource. + // - CREATING - The Amazon Web Services account is in the process of creating a + // node. + // - AVAILABLE - The node has been created and can participate in the network. + // - UNHEALTHY - The node is impaired and might not function as expected. Amazon + // Managed Blockchain automatically finds nodes in this state and tries to recover + // them. If a node is recoverable, it returns to AVAILABLE . Otherwise, it moves + // to FAILED status. + // - CREATE_FAILED - The Amazon Web Services account attempted to create a node + // and creation failed. + // - UPDATING - The node is in the process of being updated. + // - DELETING - The node is in the process of being deleted. + // - DELETED - The node can no longer participate on the network. + // - FAILED - The node is no longer functional, cannot be recovered, and must be + // deleted. + // - INACCESSIBLE_ENCRYPTION_KEY - The node is impaired and might not function as + // expected because it cannot access the specified customer managed key in KMS for + // encryption at rest. Either the KMS key was disabled or deleted, or the grants on + // the key were revoked. The effect of disabling or deleting a key or of revoking a + // grant isn't immediate. It might take some time for the node resource to discover + // that the key is inaccessible. When a resource is in this state, we recommend + // deleting and recreating the resource. Status NodeStatus // Tags assigned to the node. Each tag consists of a key and optional value. For - // more information about tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -728,9 +659,9 @@ type NodeConfiguration struct { // Hyperledger Fabric network on Managed Blockchain. LogPublishingConfiguration *NodeLogPublishingConfiguration - // The state database that the node uses. Values are LevelDB or CouchDB. When using - // an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or - // later, the default is CouchDB. Applies only to Hyperledger Fabric. + // The state database that the node uses. Values are LevelDB or CouchDB . When + // using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 + // or later, the default is CouchDB . Applies only to Hyperledger Fabric. StateDB StateDBType noSmithyDocumentSerde @@ -739,25 +670,25 @@ type NodeConfiguration struct { // Attributes of an Ethereum node. type NodeEthereumAttributes struct { - // The endpoint on which the Ethereum node listens to run Ethereum API methods over - // HTTP connections from a client. Use this endpoint in client code for smart + // The endpoint on which the Ethereum node listens to run Ethereum API methods + // over HTTP connections from a client. Use this endpoint in client code for smart // contracts when using an HTTP connection. Connections to this endpoint are - // authenticated using Signature Version 4 - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). + // authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . HttpEndpoint *string - // The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods - // over WebSocket connections from a client. Use this endpoint in client code for - // smart contracts when using a WebSocket connection. Connections to this endpoint - // are authenticated using Signature Version 4 - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). + // The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC + // methods over WebSocket connections from a client. Use this endpoint in client + // code for smart contracts when using a WebSocket connection. Connections to this + // endpoint are authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . WebSocketEndpoint *string noSmithyDocumentSerde } -// Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric network -// on Managed Blockchain. +// Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric +// network on Managed Blockchain. type NodeFabricAttributes struct { // The endpoint that identifies the peer node for all services except peer @@ -771,8 +702,8 @@ type NodeFabricAttributes struct { noSmithyDocumentSerde } -// Configuration properties for logging events associated with a peer node owned by -// a member in a Managed Blockchain network. +// Configuration properties for logging events associated with a peer node owned +// by a member in a Managed Blockchain network. type NodeFabricLogPublishingConfiguration struct { // Configuration properties for logging events associated with chaincode execution @@ -791,16 +722,16 @@ type NodeFabricLogPublishingConfiguration struct { noSmithyDocumentSerde } -// Attributes relevant to a node on a Managed Blockchain network for the blockchain -// framework that the network uses. +// Attributes relevant to a node on a Managed Blockchain network for the +// blockchain framework that the network uses. type NodeFrameworkAttributes struct { // Attributes of Ethereum for a node on a Managed Blockchain network that uses // Ethereum. Ethereum *NodeEthereumAttributes - // Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network - // that uses Hyperledger Fabric. + // Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain + // network that uses Hyperledger Fabric. Fabric *NodeFabricAttributes noSmithyDocumentSerde @@ -810,8 +741,8 @@ type NodeFrameworkAttributes struct { // Hyperledger Fabric network on Managed Blockchain. type NodeLogPublishingConfiguration struct { - // Configuration properties for logging events associated with a node that is owned - // by a member of a Managed Blockchain network using the Hyperledger Fabric + // Configuration properties for logging events associated with a node that is + // owned by a member of a Managed Blockchain network using the Hyperledger Fabric // framework. Fabric *NodeFabricLogPublishingConfiguration @@ -822,9 +753,8 @@ type NodeLogPublishingConfiguration struct { type NodeSummary struct { // The Amazon Resource Name (ARN) of the node. For more information about ARNs and - // their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The Availability Zone in which the node exists. @@ -849,13 +779,12 @@ type NodeSummary struct { // Hyperledger Fabric. type Proposal struct { - // The actions to perform on the network if the proposal is APPROVED. + // The actions to perform on the network if the proposal is APPROVED . Actions *ProposalActions // The Amazon Resource Name (ARN) of the proposal. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the proposal was created. @@ -865,7 +794,7 @@ type Proposal struct { Description *string // The date and time that the proposal expires. This is the CreationDate plus the - // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After + // ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After // this date and time, if members haven't cast enough votes to determine the // outcome according to the voting policy, the proposal is EXPIRED and Actions // aren't carried out. @@ -891,34 +820,25 @@ type Proposal struct { ProposedByMemberName *string // The status of the proposal. Values are as follows: - // - // * IN_PROGRESS - The proposal - // is active and open for member voting. - // - // * APPROVED - The proposal was approved - // with sufficient YES votes among members according to the VotingPolicy specified - // for the Network. The specified proposal actions are carried out. - // - // * REJECTED - - // The proposal was rejected with insufficient YES votes among members according to - // the VotingPolicy specified for the Network. The specified ProposalActions aren't - // carried out. - // - // * EXPIRED - Members didn't cast the number of votes required to - // determine the proposal outcome before the proposal expired. The specified - // ProposalActions aren't carried out. - // - // * ACTION_FAILED - One or more of the - // specified ProposalActions in a proposal that was approved couldn't be completed - // because of an error. The ACTION_FAILED status occurs even if only one - // ProposalAction fails and other actions are successful. + // - IN_PROGRESS - The proposal is active and open for member voting. + // - APPROVED - The proposal was approved with sufficient YES votes among members + // according to the VotingPolicy specified for the Network . The specified + // proposal actions are carried out. + // - REJECTED - The proposal was rejected with insufficient YES votes among + // members according to the VotingPolicy specified for the Network . The + // specified ProposalActions aren't carried out. + // - EXPIRED - Members didn't cast the number of votes required to determine the + // proposal outcome before the proposal expired. The specified ProposalActions + // aren't carried out. + // - ACTION_FAILED - One or more of the specified ProposalActions in a proposal + // that was approved couldn't be completed because of an error. The ACTION_FAILED + // status occurs even if only one ProposalAction fails and other actions are + // successful. Status ProposalStatus // Tags assigned to the proposal. Each tag consists of a key and optional value. - // For more information about tags, see Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) - // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources - // (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) + // For more information about tags, see Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html) + // in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources (https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html) // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Tags map[string]string @@ -928,12 +848,12 @@ type Proposal struct { noSmithyDocumentSerde } -// The actions to carry out if a proposal is APPROVED. Applies only to Hyperledger +// The actions to carry out if a proposal is APPROVED . Applies only to Hyperledger // Fabric. type ProposalActions struct { - // The actions to perform for an APPROVED proposal to invite an Amazon Web Services - // account to create a member and join the network. + // The actions to perform for an APPROVED proposal to invite an Amazon Web + // Services account to create a member and join the network. Invitations []InviteAction // The actions to perform for an APPROVED proposal to remove a member from the @@ -948,9 +868,8 @@ type ProposalActions struct { type ProposalSummary struct { // The Amazon Resource Name (ARN) of the proposal. For more information about ARNs - // and their format, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // and their format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The date and time that the proposal was created. @@ -960,7 +879,7 @@ type ProposalSummary struct { Description *string // The date and time that the proposal expires. This is the CreationDate plus the - // ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After + // ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After // this date and time, if members haven't cast enough votes to determine the // outcome according to the voting policy, the proposal is EXPIRED and Actions // aren't carried out. @@ -976,34 +895,26 @@ type ProposalSummary struct { ProposedByMemberName *string // The status of the proposal. Values are as follows: - // - // * IN_PROGRESS - The proposal - // is active and open for member voting. - // - // * APPROVED - The proposal was approved - // with sufficient YES votes among members according to the VotingPolicy specified - // for the Network. The specified proposal actions are carried out. - // - // * REJECTED - - // The proposal was rejected with insufficient YES votes among members according to - // the VotingPolicy specified for the Network. The specified ProposalActions aren't - // carried out. - // - // * EXPIRED - Members didn't cast the number of votes required to - // determine the proposal outcome before the proposal expired. The specified - // ProposalActions aren't carried out. - // - // * ACTION_FAILED - One or more of the - // specified ProposalActions in a proposal that was approved couldn't be completed - // because of an error. + // - IN_PROGRESS - The proposal is active and open for member voting. + // - APPROVED - The proposal was approved with sufficient YES votes among members + // according to the VotingPolicy specified for the Network . The specified + // proposal actions are carried out. + // - REJECTED - The proposal was rejected with insufficient YES votes among + // members according to the VotingPolicy specified for the Network . The + // specified ProposalActions aren't carried out. + // - EXPIRED - Members didn't cast the number of votes required to determine the + // proposal outcome before the proposal expired. The specified ProposalActions + // aren't carried out. + // - ACTION_FAILED - One or more of the specified ProposalActions in a proposal + // that was approved couldn't be completed because of an error. Status ProposalStatus noSmithyDocumentSerde } // An action to remove a member from a Managed Blockchain network as the result of -// a removal proposal that is APPROVED. The member and all associated resources are -// deleted from the network. Applies only to Hyperledger Fabric. +// a removal proposal that is APPROVED . The member and all associated resources +// are deleted from the network. Applies only to Hyperledger Fabric. type RemoveAction struct { // The unique identifier of the member to remove. @@ -1014,8 +925,8 @@ type RemoveAction struct { noSmithyDocumentSerde } -// Properties of an individual vote that a member cast for a proposal. Applies only -// to Hyperledger Fabric. +// Properties of an individual vote that a member cast for a proposal. Applies +// only to Hyperledger Fabric. type VoteSummary struct { // The unique identifier of the member that cast the vote. @@ -1024,7 +935,7 @@ type VoteSummary struct { // The name of the member that cast the vote. MemberName *string - // The vote value, either YES or NO. + // The vote value, either YES or NO . Vote VoteValue noSmithyDocumentSerde diff --git a/service/marketplacecatalog/api_client.go b/service/marketplacecatalog/api_client.go index b12ed586673..73b8b375fe1 100644 --- a/service/marketplacecatalog/api_client.go +++ b/service/marketplacecatalog/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/marketplacecatalog/api_op_CancelChangeSet.go b/service/marketplacecatalog/api_op_CancelChangeSet.go index 7295ce72af9..7cc20d09a5a 100644 --- a/service/marketplacecatalog/api_op_CancelChangeSet.go +++ b/service/marketplacecatalog/api_op_CancelChangeSet.go @@ -11,7 +11,7 @@ import ( ) // Used to cancel an open change request. Must be sent before the status of the -// request changes to APPLYING, the final stage of completing your change request. +// request changes to APPLYING , the final stage of completing your change request. // You can describe a change during the 60-day request history retention period for // API calls. func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInput, optFns ...func(*Options)) (*CancelChangeSetOutput, error) { @@ -31,7 +31,7 @@ func (c *Client) CancelChangeSet(ctx context.Context, params *CancelChangeSetInp type CancelChangeSetInput struct { - // Required. The catalog related to the request. Fixed value: AWSMarketplace. + // Required. The catalog related to the request. Fixed value: AWSMarketplace . // // This member is required. Catalog *string diff --git a/service/marketplacecatalog/api_op_DescribeChangeSet.go b/service/marketplacecatalog/api_op_DescribeChangeSet.go index 4b7703e6c0c..7b76c0c4206 100644 --- a/service/marketplacecatalog/api_op_DescribeChangeSet.go +++ b/service/marketplacecatalog/api_op_DescribeChangeSet.go @@ -64,10 +64,10 @@ type DescribeChangeSetOutput struct { // state. Null if the request is not in a terminal state. EndTime *string - // Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, - // which means that there are issues with the request (see the ErrorDetailList), or - // SERVER_FAULT, which means that there is a problem in the system, and you should - // retry your request. + // Returned if the change set is in FAILED status. Can be either CLIENT_ERROR , + // which means that there are issues with the request (see the ErrorDetailList ), + // or SERVER_FAULT , which means that there is a problem in the system, and you + // should retry your request. FailureCode types.FailureCode // Returned if there is a failure on the change set, but that failure is not diff --git a/service/marketplacecatalog/api_op_DescribeEntity.go b/service/marketplacecatalog/api_op_DescribeEntity.go index 3d7872dba0d..57bbe3eb49c 100644 --- a/service/marketplacecatalog/api_op_DescribeEntity.go +++ b/service/marketplacecatalog/api_op_DescribeEntity.go @@ -50,10 +50,10 @@ type DescribeEntityOutput struct { // request. EntityArn *string - // The identifier of the entity, in the format of EntityId@RevisionId. + // The identifier of the entity, in the format of EntityId@RevisionId . EntityIdentifier *string - // The named type of the entity, in the format of EntityType@Version. + // The named type of the entity, in the format of EntityType@Version . EntityType *string // The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z). diff --git a/service/marketplacecatalog/api_op_ListChangeSets.go b/service/marketplacecatalog/api_op_ListChangeSets.go index 37be9cac080..713eebdb54d 100644 --- a/service/marketplacecatalog/api_op_ListChangeSets.go +++ b/service/marketplacecatalog/api_op_ListChangeSets.go @@ -13,8 +13,8 @@ import ( ) // Returns the list of change sets owned by the account being used to make the -// call. You can filter this list by providing any combination of entityId, -// ChangeSetName, and status. If you provide more than one filter, the API +// call. You can filter this list by providing any combination of entityId , +// ChangeSetName , and status. If you provide more than one filter, the API // operation applies a logical AND between the filters. You can describe a change // during the 60-day request history retention period for API calls. func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error) { @@ -51,7 +51,7 @@ type ListChangeSetsInput struct { // results. NextToken *string - // An object that contains two attributes, SortBy and SortOrder. + // An object that contains two attributes, SortBy and SortOrder . Sort *types.Sort noSmithyDocumentSerde diff --git a/service/marketplacecatalog/api_op_ListEntities.go b/service/marketplacecatalog/api_op_ListEntities.go index db80a56eff9..0f43982e639 100644 --- a/service/marketplacecatalog/api_op_ListEntities.go +++ b/service/marketplacecatalog/api_op_ListEntities.go @@ -41,7 +41,7 @@ type ListEntitiesInput struct { EntityType *string // An array of filter objects. Each filter object contains two attributes, - // filterName and filterValues. + // filterName and filterValues . FilterList []types.Filter // Specifies the upper limit of the elements on a single page. If a value isn't @@ -51,7 +51,7 @@ type ListEntitiesInput struct { // The value of the next token, if it exists. Null if there are no more results. NextToken *string - // An object that contains two attributes, SortBy and SortOrder. + // An object that contains two attributes, SortBy and SortOrder . Sort *types.Sort noSmithyDocumentSerde diff --git a/service/marketplacecatalog/api_op_ListTagsForResource.go b/service/marketplacecatalog/api_op_ListTagsForResource.go index b068fcdd402..887725b05b1 100644 --- a/service/marketplacecatalog/api_op_ListTagsForResource.go +++ b/service/marketplacecatalog/api_op_ListTagsForResource.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all tags that have been added to a resource (either an entity -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) -// or change set -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets)). +// Lists all tags that have been added to a resource (either an entity (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) +// or change set (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets) +// ). func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/marketplacecatalog/api_op_StartChangeSet.go b/service/marketplacecatalog/api_op_StartChangeSet.go index 3cf2e0e433e..8e091b95dae 100644 --- a/service/marketplacecatalog/api_op_StartChangeSet.go +++ b/service/marketplacecatalog/api_op_StartChangeSet.go @@ -12,19 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to request changes for your entities. Within a single ChangeSet, you +// Allows you to request changes for your entities. Within a single ChangeSet , you // can't start the same change type against the same entity multiple times. // Additionally, when a ChangeSet is running, all the entities targeted by the // different changes are locked until the change set has completed (either // succeeded, cancelled, or failed). If you try to start a change set containing a // change against an entity that is already locked, you will receive a // ResourceInUseException error. For example, you can't start the ChangeSet -// described in the example -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples) +// described in the example (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples) // later in this topic because it contains two changes to run the same change type -// (AddRevisions) against the same entity (entity-id@1). For more information about -// working with change sets, see Working with change sets -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets). +// ( AddRevisions ) against the same entity ( entity-id@1 ). For more information +// about working with change sets, see Working with change sets (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets) +// . func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput, optFns ...func(*Options)) (*StartChangeSetOutput, error) { if params == nil { params = &StartChangeSetInput{} diff --git a/service/marketplacecatalog/api_op_TagResource.go b/service/marketplacecatalog/api_op_TagResource.go index 7d0108a54eb..32ba0450f98 100644 --- a/service/marketplacecatalog/api_op_TagResource.go +++ b/service/marketplacecatalog/api_op_TagResource.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tags a resource (either an entity -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) -// or change set -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets)). +// Tags a resource (either an entity (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) +// or change set (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets) +// ). func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/marketplacecatalog/api_op_UntagResource.go b/service/marketplacecatalog/api_op_UntagResource.go index 575b36280ce..44166b380f0 100644 --- a/service/marketplacecatalog/api_op_UntagResource.go +++ b/service/marketplacecatalog/api_op_UntagResource.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a tag or list of tags from a resource (either an entity -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) -// or change set -// (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets)). +// Removes a tag or list of tags from a resource (either an entity (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities) +// or change set (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets) +// ). func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/marketplacecatalog/types/enums.go b/service/marketplacecatalog/types/enums.go index 9af3e3e2e43..1627e1ad18c 100644 --- a/service/marketplacecatalog/types/enums.go +++ b/service/marketplacecatalog/types/enums.go @@ -13,9 +13,9 @@ const ( ChangeStatusFailed ChangeStatus = "FAILED" ) -// Values returns all known values for ChangeStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeStatus) Values() []ChangeStatus { return []ChangeStatus{ "PREPARING", @@ -52,9 +52,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/marketplacecatalog/types/types.go b/service/marketplacecatalog/types/types.go index f4c085f6aa9..30e65ea5462 100644 --- a/service/marketplacecatalog/types/types.go +++ b/service/marketplacecatalog/types/types.go @@ -6,7 +6,7 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// An object that contains the ChangeType, Details, and Entity. +// An object that contains the ChangeType , Details , and Entity . type Change struct { // Change types are single string values that describe your intention for the @@ -59,10 +59,10 @@ type ChangeSetSummaryListItem struct { // entity. EntityIdList []string - // Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, + // Returned if the change set is in FAILED status. Can be either CLIENT_ERROR , // which means that there are issues with the request (see the ErrorDetailList of - // DescribeChangeSet), or SERVER_FAULT, which means that there is a problem in the - // system, and you should retry your request. + // DescribeChangeSet ), or SERVER_FAULT , which means that there is a problem in + // the system, and you should retry your request. FailureCode FailureCode // The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was @@ -98,8 +98,8 @@ type ChangeSummary struct { noSmithyDocumentSerde } -// An entity contains data that describes your product, its supported features, and -// how it can be used or launched by your customer. +// An entity contains data that describes your product, its supported features, +// and how it can be used or launched by your customer. type Entity struct { // The type of entity. @@ -136,8 +136,8 @@ type EntitySummary struct { // The visibility status of the entity to buyers. This value can be Public // (everyone can view the entity), Limited (the entity is visible to limited - // accounts only), or Restricted (the entity was published and then unpublished and - // only existing buyers can view it). + // accounts only), or Restricted (the entity was published and then unpublished + // and only existing buyers can view it). Visibility *string noSmithyDocumentSerde @@ -159,51 +159,40 @@ type ErrorDetail struct { // ListEntities and ListChangeSets actions. type Filter struct { - // For ListEntities, the supported value for this is an EntityId. For - // ListChangeSets, the supported values are as follows: + // For ListEntities , the supported value for this is an EntityId . For + // ListChangeSets , the supported values are as follows: Name *string - // ListEntities - This is a list of unique EntityIds. ListChangeSets - The - // supported filter names and associated ValueLists is as follows: - // - // * ChangeSetName - // - The supported ValueList is a list of non-unique ChangeSetNames. These are - // defined when you call the StartChangeSet action. - // - // * Status - The supported - // ValueList is a list of statuses for all change set requests. - // - // * EntityId - The - // supported ValueList is a list of unique EntityIds. - // - // * BeforeStartTime - The - // supported ValueList is a list of all change sets that started before the filter - // value. - // - // * AfterStartTime - The supported ValueList is a list of all change sets - // that started after the filter value. - // - // * BeforeEndTime - The supported ValueList - // is a list of all change sets that ended before the filter value. - // - // * AfterEndTime - // - The supported ValueList is a list of all change sets that ended after the - // filter value. + // ListEntities - This is a list of unique EntityId s. ListChangeSets - The + // supported filter names and associated ValueList s is as follows: + // - ChangeSetName - The supported ValueList is a list of non-unique + // ChangeSetName s. These are defined when you call the StartChangeSet action. + // - Status - The supported ValueList is a list of statuses for all change set + // requests. + // - EntityId - The supported ValueList is a list of unique EntityId s. + // - BeforeStartTime - The supported ValueList is a list of all change sets that + // started before the filter value. + // - AfterStartTime - The supported ValueList is a list of all change sets that + // started after the filter value. + // - BeforeEndTime - The supported ValueList is a list of all change sets that + // ended before the filter value. + // - AfterEndTime - The supported ValueList is a list of all change sets that + // ended after the filter value. ValueList []string noSmithyDocumentSerde } -// An object that contains two attributes, SortBy and SortOrder. +// An object that contains two attributes, SortBy and SortOrder . type Sort struct { - // For ListEntities, supported attributes include LastModifiedDate (default), - // Visibility, EntityId, and Name. For ListChangeSets, supported attributes include - // StartTime and EndTime. + // For ListEntities , supported attributes include LastModifiedDate (default), + // Visibility , EntityId , and Name . For ListChangeSets , supported attributes + // include StartTime and EndTime . SortBy *string - // The sorting order. Can be ASCENDING or DESCENDING. The default value is - // DESCENDING. + // The sorting order. Can be ASCENDING or DESCENDING . The default value is + // DESCENDING . SortOrder SortOrder noSmithyDocumentSerde diff --git a/service/marketplacecommerceanalytics/api_client.go b/service/marketplacecommerceanalytics/api_client.go index 93a74d5f131..790473e1f9d 100644 --- a/service/marketplacecommerceanalytics/api_client.go +++ b/service/marketplacecommerceanalytics/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go index 8c75cac08f3..f0253e70163 100644 --- a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go +++ b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go @@ -52,98 +52,60 @@ type GenerateDataSetInput struct { DataSetPublicationDate *time.Time // The desired data set type. - // - // * customer_subscriber_hourly_monthly_subscriptions - // From 2017-09-15 to present: Available daily by 24:00 UTC. - // - // * - // customer_subscriber_annual_subscriptions From 2017-09-15 to present: Available - // daily by 24:00 UTC. - // - // * daily_business_usage_by_instance_type From 2017-09-15 to - // present: Available daily by 24:00 UTC. - // - // * daily_business_fees From 2017-09-15 to - // present: Available daily by 24:00 UTC. - // - // * daily_business_free_trial_conversions - // From 2017-09-15 to present: Available daily by 24:00 UTC. - // - // * - // daily_business_new_instances From 2017-09-15 to present: Available daily by - // 24:00 UTC. - // - // * daily_business_new_product_subscribers From 2017-09-15 to present: - // Available daily by 24:00 UTC. - // - // * daily_business_canceled_product_subscribers - // From 2017-09-15 to present: Available daily by 24:00 UTC. - // - // * - // monthly_revenue_billing_and_revenue_data From 2017-09-15 to present: Available - // monthly on the 15th day of the month by 24:00 UTC. Data includes metered - // transactions (e.g. hourly) from one month prior. - // - // * - // monthly_revenue_annual_subscriptions From 2017-09-15 to present: Available - // monthly on the 15th day of the month by 24:00 UTC. Data includes up-front - // software charges (e.g. annual) from one month prior. - // - // * - // monthly_revenue_field_demonstration_usage From 2018-03-15 to present: Available - // monthly on the 15th day of the month by 24:00 UTC. - // - // * - // monthly_revenue_flexible_payment_schedule From 2018-11-15 to present: Available - // monthly on the 15th day of the month by 24:00 UTC. - // - // * - // disbursed_amount_by_product From 2017-09-15 to present: Available every 30 days - // by 24:00 UTC. - // - // * disbursed_amount_by_instance_hours From 2017-09-15 to present: - // Available every 30 days by 24:00 UTC. - // - // * disbursed_amount_by_customer_geo From - // 2017-09-15 to present: Available every 30 days by 24:00 UTC. - // - // * - // disbursed_amount_by_age_of_uncollected_funds From 2017-09-15 to present: - // Available every 30 days by 24:00 UTC. - // - // * - // disbursed_amount_by_age_of_disbursed_funds From 2017-09-15 to present: Available - // every 30 days by 24:00 UTC. - // - // * disbursed_amount_by_age_of_past_due_funds From - // 2018-04-07 to present: Available every 30 days by 24:00 UTC. - // - // * - // disbursed_amount_by_uncollected_funds_breakdown From 2019-10-04 to present: - // Available every 30 days by 24:00 UTC. - // - // * sales_compensation_billed_revenue From - // 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 - // UTC. Data includes metered transactions (e.g. hourly) from one month prior, and - // up-front software charges (e.g. annual) from one month prior. - // - // * - // us_sales_and_use_tax_records From 2017-09-15 to present: Available monthly on - // the 15th day of the month by 24:00 UTC. - // - // * - // disbursed_amount_by_product_with_uncollected_funds This data set is deprecated. - // Download related reports from AMMP instead! - // - // * customer_profile_by_industry This - // data set is deprecated. Download related reports from AMMP instead! - // - // * - // customer_profile_by_revenue This data set is deprecated. Download related - // reports from AMMP instead! - // - // * customer_profile_by_geography This data set is - // deprecated. Download related reports from AMMP instead! + // - customer_subscriber_hourly_monthly_subscriptions From 2017-09-15 to + // present: Available daily by 24:00 UTC. + // - customer_subscriber_annual_subscriptions From 2017-09-15 to present: + // Available daily by 24:00 UTC. + // - daily_business_usage_by_instance_type From 2017-09-15 to present: Available + // daily by 24:00 UTC. + // - daily_business_fees From 2017-09-15 to present: Available daily by 24:00 + // UTC. + // - daily_business_free_trial_conversions From 2017-09-15 to present: Available + // daily by 24:00 UTC. + // - daily_business_new_instances From 2017-09-15 to present: Available daily by + // 24:00 UTC. + // - daily_business_new_product_subscribers From 2017-09-15 to present: + // Available daily by 24:00 UTC. + // - daily_business_canceled_product_subscribers From 2017-09-15 to present: + // Available daily by 24:00 UTC. + // - monthly_revenue_billing_and_revenue_data From 2017-09-15 to present: + // Available monthly on the 15th day of the month by 24:00 UTC. Data includes + // metered transactions (e.g. hourly) from one month prior. + // - monthly_revenue_annual_subscriptions From 2017-09-15 to present: Available + // monthly on the 15th day of the month by 24:00 UTC. Data includes up-front + // software charges (e.g. annual) from one month prior. + // - monthly_revenue_field_demonstration_usage From 2018-03-15 to present: + // Available monthly on the 15th day of the month by 24:00 UTC. + // - monthly_revenue_flexible_payment_schedule From 2018-11-15 to present: + // Available monthly on the 15th day of the month by 24:00 UTC. + // - disbursed_amount_by_product From 2017-09-15 to present: Available every 30 + // days by 24:00 UTC. + // - disbursed_amount_by_instance_hours From 2017-09-15 to present: Available + // every 30 days by 24:00 UTC. + // - disbursed_amount_by_customer_geo From 2017-09-15 to present: Available + // every 30 days by 24:00 UTC. + // - disbursed_amount_by_age_of_uncollected_funds From 2017-09-15 to present: + // Available every 30 days by 24:00 UTC. + // - disbursed_amount_by_age_of_disbursed_funds From 2017-09-15 to present: + // Available every 30 days by 24:00 UTC. + // - disbursed_amount_by_age_of_past_due_funds From 2018-04-07 to present: + // Available every 30 days by 24:00 UTC. + // - disbursed_amount_by_uncollected_funds_breakdown From 2019-10-04 to present: + // Available every 30 days by 24:00 UTC. + // - sales_compensation_billed_revenue From 2017-09-15 to present: Available + // monthly on the 15th day of the month by 24:00 UTC. Data includes metered + // transactions (e.g. hourly) from one month prior, and up-front software charges + // (e.g. annual) from one month prior. + // - us_sales_and_use_tax_records From 2017-09-15 to present: Available monthly + // on the 15th day of the month by 24:00 UTC. + // - disbursed_amount_by_product_with_uncollected_funds This data set is + // deprecated. Download related reports from AMMP instead! + // - customer_profile_by_industry This data set is deprecated. Download related + // reports from AMMP instead! + // - customer_profile_by_revenue This data set is deprecated. Download related + // reports from AMMP instead! + // - customer_profile_by_geography This data set is deprecated. Download related + // reports from AMMP instead! // // This member is required. DataSetType types.DataSetType @@ -159,15 +121,16 @@ type GenerateDataSetInput struct { // This member is required. RoleNameArn *string - // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data - // set has been published or if an error has occurred. + // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the + // data set has been published or if an error has occurred. // // This member is required. SnsTopicArn *string - // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS - // notification message and the data set metadata file. These key-value pairs can - // be used to correlated responses with tracking information from other systems. + // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon + // SNS notification message and the data set metadata file. These key-value pairs + // can be used to correlated responses with tracking information from other + // systems. CustomerDefinedValues map[string]string // (Optional) The desired S3 prefix for the published data set, similar to a diff --git a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go index 0bed5391f5d..855176bbcc0 100644 --- a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go +++ b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go @@ -47,15 +47,11 @@ type StartSupportDataExportInput struct { // Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, // AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country // Code, ZIP Code, Operation Type, and Operation Time. - // - // * - // customer_support_contacts_data Customer support contact data. The data set will - // contain all changes (Creates, Updates, and Deletes) to customer support contact - // data from the date specified in the from_date parameter. - // - // * - // test_customer_support_contacts_data An example data set containing static test - // data in the same format as customer_support_contacts_data + // - customer_support_contacts_data Customer support contact data. The data set + // will contain all changes (Creates, Updates, and Deletes) to customer support + // contact data from the date specified in the from_date parameter. + // - test_customer_support_contacts_data An example data set containing static + // test data in the same format as customer_support_contacts_data // // This member is required. DataSetType types.SupportDataSetType @@ -77,14 +73,14 @@ type StartSupportDataExportInput struct { // This member is required. RoleNameArn *string - // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data - // set has been published or if an error has occurred. + // Amazon Resource Name (ARN) for the SNS Topic that will be notified when the + // data set has been published or if an error has occurred. // // This member is required. SnsTopicArn *string - // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS - // notification message and the data set metadata file. + // (Optional) Key-value pairs which will be returned, unmodified, in the Amazon + // SNS notification message and the data set metadata file. CustomerDefinedValues map[string]string // (Optional) The desired S3 prefix for the published data set, similar to a diff --git a/service/marketplaceentitlementservice/api_client.go b/service/marketplaceentitlementservice/api_client.go index 772789e1079..cd637a91be3 100644 --- a/service/marketplaceentitlementservice/api_client.go +++ b/service/marketplaceentitlementservice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/marketplaceentitlementservice/doc.go b/service/marketplaceentitlementservice/doc.go index 881d3280e07..490b70c3704 100644 --- a/service/marketplaceentitlementservice/doc.go +++ b/service/marketplaceentitlementservice/doc.go @@ -10,6 +10,5 @@ // a customer might own some number of users or seats in an SaaS application or // some amount of data capacity in a multi-tenant database. Getting Entitlement // Records -// -// * GetEntitlements- Gets the entitlements for a Marketplace product. +// - GetEntitlements- Gets the entitlements for a Marketplace product. package marketplaceentitlementservice diff --git a/service/marketplaceentitlementservice/types/enums.go b/service/marketplaceentitlementservice/types/enums.go index 4746028113c..6d5b693c192 100644 --- a/service/marketplaceentitlementservice/types/enums.go +++ b/service/marketplaceentitlementservice/types/enums.go @@ -10,9 +10,9 @@ const ( GetEntitlementFilterNameDimension GetEntitlementFilterName = "DIMENSION" ) -// Values returns all known values for GetEntitlementFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for GetEntitlementFilterName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (GetEntitlementFilterName) Values() []GetEntitlementFilterName { return []GetEntitlementFilterName{ "CUSTOMER_IDENTIFIER", diff --git a/service/marketplaceentitlementservice/types/types.go b/service/marketplaceentitlementservice/types/types.go index a526c1662a6..841741a1357 100644 --- a/service/marketplaceentitlementservice/types/types.go +++ b/service/marketplaceentitlementservice/types/types.go @@ -48,16 +48,16 @@ type EntitlementValue struct { // entitlement is a boolean type. Otherwise, the field will not be set. BooleanValue *bool - // The DoubleValue field will be populated with a double value when the entitlement - // is a double type. Otherwise, the field will not be set. + // The DoubleValue field will be populated with a double value when the + // entitlement is a double type. Otherwise, the field will not be set. DoubleValue *float64 // The IntegerValue field will be populated with an integer value when the // entitlement is an integer type. Otherwise, the field will not be set. IntegerValue *int32 - // The StringValue field will be populated with a string value when the entitlement - // is a string type. Otherwise, the field will not be set. + // The StringValue field will be populated with a string value when the + // entitlement is a string type. Otherwise, the field will not be set. StringValue *string noSmithyDocumentSerde diff --git a/service/marketplacemetering/api_client.go b/service/marketplacemetering/api_client.go index ba753956c72..4ae84b086e0 100644 --- a/service/marketplacemetering/api_client.go +++ b/service/marketplacemetering/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/marketplacemetering/api_op_BatchMeterUsage.go b/service/marketplacemetering/api_op_BatchMeterUsage.go index 348fa29aecd..e91160d4f22 100644 --- a/service/marketplacemetering/api_op_BatchMeterUsage.go +++ b/service/marketplacemetering/api_op_BatchMeterUsage.go @@ -16,17 +16,16 @@ import ( // idempotent; requests can be retried with the same records or a subset of the // input records. Every request to BatchMeterUsage is for one product. If you need // to meter usage for multiple products, you must make multiple calls to -// BatchMeterUsage. Usage records are expected to be submitted as quickly as +// BatchMeterUsage . Usage records are expected to be submitted as quickly as // possible after the event that is being recorded, and are not accepted more than // 6 hours after the event. BatchMeterUsage can process up to 25 UsageRecords at a // time. A UsageRecord can optionally include multiple usage allocations, to // provide customers with usage data split into buckets by tags that you define (or // allow the customer to define). BatchMeterUsage returns a list of -// UsageRecordResult objects, showing the result for each UsageRecord, as well as a -// list of UnprocessedRecords, indicating errors in the service side that you +// UsageRecordResult objects, showing the result for each UsageRecord , as well as +// a list of UnprocessedRecords , indicating errors in the service side that you // should retry. BatchMeterUsage requests must be less than 1MB in size. For an -// example of using BatchMeterUsage, see BatchMeterUsage code example -// (https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example) +// example of using BatchMeterUsage , see BatchMeterUsage code example (https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example) // in the AWS Marketplace Seller Guide. func (c *Client) BatchMeterUsage(ctx context.Context, params *BatchMeterUsageInput, optFns ...func(*Options)) (*BatchMeterUsageOutput, error) { if params == nil { @@ -43,7 +42,7 @@ func (c *Client) BatchMeterUsage(ctx context.Context, params *BatchMeterUsageInp return out, nil } -// A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of +// A BatchMeterUsageRequest contains UsageRecords , which indicate quantities of // usage within your application. type BatchMeterUsageInput struct { @@ -63,18 +62,18 @@ type BatchMeterUsageInput struct { noSmithyDocumentSerde } -// Contains the UsageRecords processed by BatchMeterUsage and any records that have -// failed due to transient error. +// Contains the UsageRecords processed by BatchMeterUsage and any records that +// have failed due to transient error. type BatchMeterUsageOutput struct { - // Contains all UsageRecords processed by BatchMeterUsage. These records were + // Contains all UsageRecords processed by BatchMeterUsage . These records were // either honored by AWS Marketplace Metering Service or were invalid. Invalid // records should be fixed before being resubmitted. Results []types.UsageRecordResult - // Contains all UsageRecords that were not processed by BatchMeterUsage. This is a - // list of UsageRecords. You can retry the failed request by making another - // BatchMeterUsage call with this list as input in the BatchMeterUsageRequest. + // Contains all UsageRecords that were not processed by BatchMeterUsage . This is a + // list of UsageRecords . You can retry the failed request by making another + // BatchMeterUsage call with this list as input in the BatchMeterUsageRequest . UnprocessedRecords []types.UsageRecord // Metadata pertaining to the operation's result. diff --git a/service/marketplacemetering/api_op_MeterUsage.go b/service/marketplacemetering/api_op_MeterUsage.go index 9e3bc9a3295..6cafc365df2 100644 --- a/service/marketplacemetering/api_op_MeterUsage.go +++ b/service/marketplacemetering/api_op_MeterUsage.go @@ -45,8 +45,8 @@ type MeterUsageInput struct { ProductCode *string // Timestamp, in UTC, for which the usage is being reported. Your application can - // meter usage for up to one hour in the past. Make sure the timestamp value is not - // before the start of the software usage. + // meter usage for up to one hour in the past. Make sure the timestamp value is + // not before the start of the software usage. // // This member is required. Timestamp *time.Time @@ -59,13 +59,13 @@ type MeterUsageInput struct { // Checks whether you have the permissions required for the action, but does not // make the request. If you have the permissions, the request returns - // DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false - // if not specified. + // DryRunOperation ; otherwise, it returns UnauthorizedException . Defaults to + // false if not specified. DryRun *bool - // The set of UsageAllocations to submit. The sum of all UsageAllocation quantities - // must equal the UsageQuantity of the MeterUsage request, and each UsageAllocation - // must have a unique set of tags (include no tags). + // The set of UsageAllocations to submit. The sum of all UsageAllocation + // quantities must equal the UsageQuantity of the MeterUsage request, and each + // UsageAllocation must have a unique set of tags (include no tags). UsageAllocations []types.UsageAllocation // Consumption value for the hour. Defaults to 0 if not specified. diff --git a/service/marketplacemetering/api_op_RegisterUsage.go b/service/marketplacemetering/api_op_RegisterUsage.go index c2808c49ca7..6570b229a09 100644 --- a/service/marketplacemetering/api_op_RegisterUsage.go +++ b/service/marketplacemetering/api_op_RegisterUsage.go @@ -14,35 +14,33 @@ import ( // Paid container software products sold through AWS Marketplace must integrate // with the AWS Marketplace Metering Service and call the RegisterUsage operation // for software entitlement and metering. Free and BYOL products for Amazon ECS or -// Amazon EKS aren't required to call RegisterUsage, but you may choose to do so if -// you would like to receive usage data in your seller reports. The sections below -// explain the behavior of RegisterUsage. RegisterUsage performs two primary -// functions: metering and entitlement. -// -// * Entitlement: RegisterUsage allows you to -// verify that the customer running your paid software is subscribed to your -// product on AWS Marketplace, enabling you to guard against unauthorized use. Your -// container image that integrates with RegisterUsage is only required to guard -// against unauthorized use at container startup, as such a -// CustomerNotSubscribedException or PlatformNotSupportedException will only be -// thrown on the initial call to RegisterUsage. Subsequent calls from the same -// Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a -// CustomerNotSubscribedException, even if the customer unsubscribes while the -// Amazon ECS task or Amazon EKS pod is still running. -// -// * Metering: RegisterUsage -// meters software use per ECS task, per hour, or per pod for Amazon EKS with usage -// prorated to the second. A minimum of 1 minute of usage applies to tasks that are -// short lived. For example, if a customer has a 10 node Amazon ECS or Amazon EKS -// cluster and a service configured as a Daemon Set, then Amazon ECS or Amazon EKS -// will launch a task on all 10 cluster nodes and the customer will be charged: (10 -// * hourly_rate). Metering for software use is automatically handled by the AWS -// Marketplace Metering Control Plane -- your software is not required to perform -// any metering specific actions, other than call RegisterUsage once for metering -// of software use to commence. The AWS Marketplace Metering Control Plane will -// also continue to bill customers for running ECS tasks and Amazon EKS pods, -// regardless of the customers subscription state, removing the need for your -// software to perform entitlement checks at runtime. +// Amazon EKS aren't required to call RegisterUsage , but you may choose to do so +// if you would like to receive usage data in your seller reports. The sections +// below explain the behavior of RegisterUsage . RegisterUsage performs two +// primary functions: metering and entitlement. +// - Entitlement: RegisterUsage allows you to verify that the customer running +// your paid software is subscribed to your product on AWS Marketplace, enabling +// you to guard against unauthorized use. Your container image that integrates with +// RegisterUsage is only required to guard against unauthorized use at container +// startup, as such a CustomerNotSubscribedException or +// PlatformNotSupportedException will only be thrown on the initial call to +// RegisterUsage . Subsequent calls from the same Amazon ECS task instance (e.g. +// task-id) or Amazon EKS pod will not throw a CustomerNotSubscribedException , +// even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is +// still running. +// - Metering: RegisterUsage meters software use per ECS task, per hour, or per +// pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of +// usage applies to tasks that are short lived. For example, if a customer has a 10 +// node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, +// then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the +// customer will be charged: (10 * hourly_rate). Metering for software use is +// automatically handled by the AWS Marketplace Metering Control Plane -- your +// software is not required to perform any metering specific actions, other than +// call RegisterUsage once for metering of software use to commence. The AWS +// Marketplace Metering Control Plane will also continue to bill customers for +// running ECS tasks and Amazon EKS pods, regardless of the customers subscription +// state, removing the need for your software to perform entitlement checks at +// runtime. func (c *Client) RegisterUsage(ctx context.Context, params *RegisterUsageInput, optFns ...func(*Options)) (*RegisterUsageOutput, error) { if params == nil { params = &RegisterUsageInput{} diff --git a/service/marketplacemetering/api_op_ResolveCustomer.go b/service/marketplacemetering/api_op_ResolveCustomer.go index 76dd8b552fd..b611665a36a 100644 --- a/service/marketplacemetering/api_op_ResolveCustomer.go +++ b/service/marketplacemetering/api_op_ResolveCustomer.go @@ -10,15 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// ResolveCustomer is called by a SaaS application during the registration process. -// When a buyer visits your website during the registration process, the buyer -// submits a registration token through their browser. The registration token is -// resolved through this API to obtain a CustomerIdentifier along with the -// CustomerAWSAccountId and ProductCode. The API needs to called from the seller +// ResolveCustomer is called by a SaaS application during the registration +// process. When a buyer visits your website during the registration process, the +// buyer submits a registration token through their browser. The registration token +// is resolved through this API to obtain a CustomerIdentifier along with the +// CustomerAWSAccountId and ProductCode . The API needs to called from the seller // account id used to publish the SaaS application to successfully resolve the -// token. For an example of using ResolveCustomer, see ResolveCustomer code -// example -// (https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example) +// token. For an example of using ResolveCustomer , see ResolveCustomer code +// example (https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example) // in the AWS Marketplace Seller Guide. func (c *Client) ResolveCustomer(ctx context.Context, params *ResolveCustomerInput, optFns ...func(*Options)) (*ResolveCustomerOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type ResolveCustomerInput struct { // When a buyer visits your website during the registration process, the buyer // submits a registration token through the browser. The registration token is // resolved to obtain a CustomerIdentifier along with the CustomerAWSAccountId and - // ProductCode. + // ProductCode . // // This member is required. RegistrationToken *string @@ -50,7 +49,7 @@ type ResolveCustomerInput struct { } // The result of the ResolveCustomer operation. Contains the CustomerIdentifier -// along with the CustomerAWSAccountId and ProductCode. +// along with the CustomerAWSAccountId and ProductCode . type ResolveCustomerOutput struct { // The CustomerAWSAccountId provides the AWS account ID associated with the @@ -59,7 +58,7 @@ type ResolveCustomerOutput struct { // The CustomerIdentifier is used to identify an individual customer in your // application. Calls to BatchMeterUsage require CustomerIdentifiers for each - // UsageRecord. + // UsageRecord . CustomerIdentifier *string // The product code is returned to confirm that the buyer is registering for your diff --git a/service/marketplacemetering/doc.go b/service/marketplacemetering/doc.go index ebf4893d589..d686a967f36 100644 --- a/service/marketplacemetering/doc.go +++ b/service/marketplacemetering/doc.go @@ -7,42 +7,34 @@ // low-level AWS Marketplace Metering Service API. AWS Marketplace sellers can use // this API to submit usage data for custom usage dimensions. For information on // the permissions you need to use this API, see AWS Marketplace metering and -// entitlement API permissions -// (https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html) +// entitlement API permissions (https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html) // in the AWS Marketplace Seller Guide. Submitting Metering Records -// -// * MeterUsage - -// Submits the metering record for an AWS Marketplace product. MeterUsage is called -// from an EC2 instance or a container running on EKS or ECS. -// -// * BatchMeterUsage - -// Submits the metering record for a set of customers. BatchMeterUsage is called -// from a software-as-a-service (SaaS) application. -// -// # Accepting New Customers -// -// * -// ResolveCustomer - Called by a SaaS application during the registration process. -// When a buyer visits your website during the registration process, the buyer -// submits a Registration Token through the browser. The Registration Token is -// resolved through this API to obtain a CustomerIdentifier along with the -// CustomerAWSAccountId and ProductCode. -// -// Entitlement and Metering for Paid -// Container Products -// -// * Paid container software products sold through AWS -// Marketplace must integrate with the AWS Marketplace Metering Service and call -// the RegisterUsage operation for software entitlement and metering. Free and BYOL -// products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but -// you can do so if you want to receive usage data in your seller reports. For more -// information on using the RegisterUsage operation, see Container-Based Products -// (https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html). -// -// BatchMeterUsage -// API calls are captured by AWS CloudTrail. You can use Cloudtrail to verify that -// the SaaS metering records that you sent are accurate by searching for records -// with the eventName of BatchMeterUsage. You can also use CloudTrail to audit -// records over time. For more information, see the AWS CloudTrail User Guide -// (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html). +// - MeterUsage - Submits the metering record for an AWS Marketplace product. +// MeterUsage is called from an EC2 instance or a container running on EKS or +// ECS. +// - BatchMeterUsage - Submits the metering record for a set of customers. +// BatchMeterUsage is called from a software-as-a-service (SaaS) application. +// +// Accepting New Customers +// - ResolveCustomer - Called by a SaaS application during the registration +// process. When a buyer visits your website during the registration process, the +// buyer submits a Registration Token through the browser. The Registration Token +// is resolved through this API to obtain a CustomerIdentifier along with the +// CustomerAWSAccountId and ProductCode . +// +// Entitlement and Metering for Paid Container Products +// - Paid container software products sold through AWS Marketplace must +// integrate with the AWS Marketplace Metering Service and call the RegisterUsage +// operation for software entitlement and metering. Free and BYOL products for +// Amazon ECS or Amazon EKS aren't required to call RegisterUsage , but you can +// do so if you want to receive usage data in your seller reports. For more +// information on using the RegisterUsage operation, see Container-Based Products (https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html) +// . +// +// BatchMeterUsage API calls are captured by AWS CloudTrail. You can use +// Cloudtrail to verify that the SaaS metering records that you sent are accurate +// by searching for records with the eventName of BatchMeterUsage . You can also +// use CloudTrail to audit records over time. For more information, see the AWS +// CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html) +// . package marketplacemetering diff --git a/service/marketplacemetering/types/errors.go b/service/marketplacemetering/types/errors.go index d8de3d2b188..6e13eeb870f 100644 --- a/service/marketplacemetering/types/errors.go +++ b/service/marketplacemetering/types/errors.go @@ -61,8 +61,8 @@ func (e *DisabledApiException) ErrorCode() string { func (e *DisabledApiException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // A metering record has already been emitted by the same EC2 instance, ECS task, -// or EKS pod for the given {usageDimension, timestamp} with a different -// usageQuantity. +// or EKS pod for the given { usageDimension , timestamp } with a different +// usageQuantity . type DuplicateRequestException struct { Message *string @@ -256,7 +256,7 @@ func (e *InvalidPublicKeyVersionException) ErrorFault() smithy.ErrorFault { retu // RegisterUsage must be called in the same AWS Region the ECS task was launched // in. This prevents a container from hardcoding a Region (e.g. -// withRegion(“us-east-1”) when calling RegisterUsage. +// withRegion(“us-east-1”) when calling RegisterUsage . type InvalidRegionException struct { Message *string @@ -442,7 +442,7 @@ func (e *ThrottlingException) ErrorCode() string { func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The timestamp value passed in the UsageRecord is out of allowed range. For -// BatchMeterUsage, if any of the records are outside of the allowed range, the +// BatchMeterUsage , if any of the records are outside of the allowed range, the // entire batch is not processed. You must remove invalid records and try again. type TimestampOutOfBoundsException struct { Message *string diff --git a/service/marketplacemetering/types/types.go b/service/marketplacemetering/types/types.go index 3c4a063ea31..da02bc441e3 100644 --- a/service/marketplacemetering/types/types.go +++ b/service/marketplacemetering/types/types.go @@ -7,16 +7,16 @@ import ( "time" ) -// Metadata assigned to an allocation. Each tag is made up of a key and a value. +// Metadata assigned to an allocation. Each tag is made up of a key and a value . type Tag struct { - // One part of a key-value pair that makes up a tag. A key is a label that acts + // One part of a key-value pair that makes up a tag . A key is a label that acts // like a category for the specific tag values. // // This member is required. Key *string - // One part of a key-value pair that makes up a tag. A value acts as a descriptor + // One part of a key-value pair that makes up a tag . A value acts as a descriptor // within a tag category (key). The value can be empty or null. // // This member is required. @@ -34,8 +34,8 @@ type UsageAllocation struct { // This member is required. AllocatedUsageQuantity *int32 - // The set of tags that define the bucket of usage. For the bucket of items with no - // tags, this parameter can be left out. + // The set of tags that define the bucket of usage. For the bucket of items with + // no tags, this parameter can be left out. Tags []Tag noSmithyDocumentSerde @@ -59,53 +59,44 @@ type UsageRecord struct { Dimension *string // Timestamp, in UTC, for which the usage is being reported. Your application can - // meter usage for up to one hour in the past. Make sure the timestamp value is not - // before the start of the software usage. + // meter usage for up to one hour in the past. Make sure the timestamp value is + // not before the start of the software usage. // // This member is required. Timestamp *time.Time - // The quantity of usage consumed by the customer for the given dimension and time. - // Defaults to 0 if not specified. + // The quantity of usage consumed by the customer for the given dimension and + // time. Defaults to 0 if not specified. Quantity *int32 - // The set of UsageAllocations to submit. The sum of all UsageAllocation quantities - // must equal the Quantity of the UsageRecord. + // The set of UsageAllocations to submit. The sum of all UsageAllocation + // quantities must equal the Quantity of the UsageRecord . UsageAllocations []UsageAllocation noSmithyDocumentSerde } // A UsageRecordResult indicates the status of a given UsageRecord processed by -// BatchMeterUsage. +// BatchMeterUsage . type UsageRecordResult struct { // The MeteringRecordId is a unique identifier for this metering event. MeteringRecordId *string - // The UsageRecordResultStatus indicates the status of an individual UsageRecord - // processed by BatchMeterUsage. - // - // * Success- The UsageRecord was accepted and - // honored by BatchMeterUsage. - // - // * CustomerNotSubscribed- The CustomerIdentifier - // specified is not able to use your product. The UsageRecord was not honored. - // There are three causes for this result: - // - // * The customer identifier is - // invalid. - // - // * The customer identifier provided in the metering record does not - // have an active agreement or subscription with this product. Future UsageRecords - // for this customer will fail until the customer subscribes to your product. - // - // * - // The customer's AWS account was suspended. - // - // * DuplicateRecord- Indicates that the - // UsageRecord was invalid and not honored. A previously metered UsageRecord had - // the same customer, dimension, and time, but a different quantity. + // The UsageRecordResult Status indicates the status of an individual UsageRecord + // processed by BatchMeterUsage . + // - Success- The UsageRecord was accepted and honored by BatchMeterUsage . + // - CustomerNotSubscribed- The CustomerIdentifier specified is not able to use + // your product. The UsageRecord was not honored. There are three causes for this + // result: + // - The customer identifier is invalid. + // - The customer identifier provided in the metering record does not have an + // active agreement or subscription with this product. Future UsageRecords for + // this customer will fail until the customer subscribes to your product. + // - The customer's AWS account was suspended. + // - DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. + // A previously metered UsageRecord had the same customer, dimension, and time, + // but a different quantity. Status UsageRecordResultStatus // The UsageRecord that was part of the BatchMeterUsage request. diff --git a/service/mediaconnect/api_client.go b/service/mediaconnect/api_client.go index 8d8b4fe8091..8ed63d7c12f 100644 --- a/service/mediaconnect/api_client.go +++ b/service/mediaconnect/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediaconnect/api_op_DescribeFlow.go b/service/mediaconnect/api_op_DescribeFlow.go index 73ea5271202..c612569c92f 100644 --- a/service/mediaconnect/api_op_DescribeFlow.go +++ b/service/mediaconnect/api_op_DescribeFlow.go @@ -142,9 +142,9 @@ type FlowActiveWaiterOptions struct { // must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FlowActiveWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FlowActiveWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -366,9 +366,9 @@ type FlowDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FlowDeletedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FlowDeletedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -563,9 +563,9 @@ type FlowStandbyWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, FlowStandbyWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, FlowStandbyWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/mediaconnect/api_op_DescribeReservation.go b/service/mediaconnect/api_op_DescribeReservation.go index 76bdea45477..5faa1782f64 100644 --- a/service/mediaconnect/api_op_DescribeReservation.go +++ b/service/mediaconnect/api_op_DescribeReservation.go @@ -41,12 +41,12 @@ type DescribeReservationInput struct { type DescribeReservationOutput struct { - // A pricing agreement for a discounted rate for a specific outbound bandwidth that - // your MediaConnect account will use each month over a specific time period. The - // discounted rate in the reservation applies to outbound bandwidth for all flows - // from your account until your account reaches the amount of bandwidth in your - // reservation. If you use more outbound bandwidth than the agreed upon amount in a - // single month, the overage is charged at the on-demand rate. + // A pricing agreement for a discounted rate for a specific outbound bandwidth + // that your MediaConnect account will use each month over a specific time period. + // The discounted rate in the reservation applies to outbound bandwidth for all + // flows from your account until your account reaches the amount of bandwidth in + // your reservation. If you use more outbound bandwidth than the agreed upon amount + // in a single month, the overage is charged at the on-demand rate. Reservation *types.Reservation // Metadata pertaining to the operation's result. diff --git a/service/mediaconnect/api_op_ListEntitlements.go b/service/mediaconnect/api_op_ListEntitlements.go index c7ccc6ced25..ac0d3272814 100644 --- a/service/mediaconnect/api_op_ListEntitlements.go +++ b/service/mediaconnect/api_op_ListEntitlements.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Displays a list of all entitlements that have been granted to this account. This -// request returns 20 results per page. +// Displays a list of all entitlements that have been granted to this account. +// This request returns 20 results per page. func (c *Client) ListEntitlements(ctx context.Context, params *ListEntitlementsInput, optFns ...func(*Options)) (*ListEntitlementsOutput, error) { if params == nil { params = &ListEntitlementsInput{} @@ -31,12 +31,12 @@ func (c *Client) ListEntitlements(ctx context.Context, params *ListEntitlementsI type ListEntitlementsInput struct { - // The maximum number of results to return per API request. For example, you submit - // a ListEntitlements request with MaxResults set at 5. Although 20 items match - // your request, the service returns no more than the first 5 items. (The service - // also returns a NextToken value that you can use to fetch the next batch of - // results.) The service might return fewer results than the MaxResults value. If - // MaxResults is not included in the request, the service defaults to pagination + // The maximum number of results to return per API request. For example, you + // submit a ListEntitlements request with MaxResults set at 5. Although 20 items + // match your request, the service returns no more than the first 5 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to pagination // with a maximum of 20 results per page. MaxResults int32 @@ -138,12 +138,12 @@ var _ ListEntitlementsAPIClient = (*Client)(nil) // ListEntitlementsPaginatorOptions is the paginator options for ListEntitlements type ListEntitlementsPaginatorOptions struct { - // The maximum number of results to return per API request. For example, you submit - // a ListEntitlements request with MaxResults set at 5. Although 20 items match - // your request, the service returns no more than the first 5 items. (The service - // also returns a NextToken value that you can use to fetch the next batch of - // results.) The service might return fewer results than the MaxResults value. If - // MaxResults is not included in the request, the service defaults to pagination + // The maximum number of results to return per API request. For example, you + // submit a ListEntitlements request with MaxResults set at 5. Although 20 items + // match your request, the service returns no more than the first 5 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to pagination // with a maximum of 20 results per page. Limit int32 diff --git a/service/mediaconnect/api_op_ListFlows.go b/service/mediaconnect/api_op_ListFlows.go index 2ffce8bcf77..b173a085a31 100644 --- a/service/mediaconnect/api_op_ListFlows.go +++ b/service/mediaconnect/api_op_ListFlows.go @@ -31,13 +31,13 @@ func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns . type ListFlowsInput struct { - // The maximum number of results to return per API request. For example, you submit - // a ListFlows request with MaxResults set at 5. Although 20 items match your - // request, the service returns no more than the first 5 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 10 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListFlows request with MaxResults set at 5. Although 20 items match + // your request, the service returns no more than the first 5 items. (The service + // also returns a NextToken value that you can use to fetch the next batch of + // results.) The service might return fewer results than the MaxResults value. If + // MaxResults is not included in the request, the service defaults to pagination + // with a maximum of 10 results per page. MaxResults int32 // The token that identifies which batch of results that you want to see. For @@ -137,13 +137,13 @@ var _ ListFlowsAPIClient = (*Client)(nil) // ListFlowsPaginatorOptions is the paginator options for ListFlows type ListFlowsPaginatorOptions struct { - // The maximum number of results to return per API request. For example, you submit - // a ListFlows request with MaxResults set at 5. Although 20 items match your - // request, the service returns no more than the first 5 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 10 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListFlows request with MaxResults set at 5. Although 20 items match + // your request, the service returns no more than the first 5 items. (The service + // also returns a NextToken value that you can use to fetch the next batch of + // results.) The service might return fewer results than the MaxResults value. If + // MaxResults is not included in the request, the service defaults to pagination + // with a maximum of 10 results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mediaconnect/api_op_ListOfferings.go b/service/mediaconnect/api_op_ListOfferings.go index 925a70c6b8c..af541fe734a 100644 --- a/service/mediaconnect/api_op_ListOfferings.go +++ b/service/mediaconnect/api_op_ListOfferings.go @@ -33,13 +33,13 @@ func (c *Client) ListOfferings(ctx context.Context, params *ListOfferingsInput, type ListOfferingsInput struct { - // The maximum number of results to return per API request. For example, you submit - // a ListOfferings request with MaxResults set at 5. Although 20 items match your - // request, the service returns no more than the first 5 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 10 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListOfferings request with MaxResults set at 5. Although 20 items match + // your request, the service returns no more than the first 5 items. (The service + // also returns a NextToken value that you can use to fetch the next batch of + // results.) The service might return fewer results than the MaxResults value. If + // MaxResults is not included in the request, the service defaults to pagination + // with a maximum of 10 results per page. MaxResults int32 // The token that identifies which batch of results that you want to see. For @@ -140,13 +140,13 @@ var _ ListOfferingsAPIClient = (*Client)(nil) // ListOfferingsPaginatorOptions is the paginator options for ListOfferings type ListOfferingsPaginatorOptions struct { - // The maximum number of results to return per API request. For example, you submit - // a ListOfferings request with MaxResults set at 5. Although 20 items match your - // request, the service returns no more than the first 5 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 10 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListOfferings request with MaxResults set at 5. Although 20 items match + // your request, the service returns no more than the first 5 items. (The service + // also returns a NextToken value that you can use to fetch the next batch of + // results.) The service might return fewer results than the MaxResults value. If + // MaxResults is not included in the request, the service defaults to pagination + // with a maximum of 10 results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mediaconnect/api_op_ListReservations.go b/service/mediaconnect/api_op_ListReservations.go index b037f76d1ab..a90b413945a 100644 --- a/service/mediaconnect/api_op_ListReservations.go +++ b/service/mediaconnect/api_op_ListReservations.go @@ -32,12 +32,12 @@ func (c *Client) ListReservations(ctx context.Context, params *ListReservationsI type ListReservationsInput struct { - // The maximum number of results to return per API request. For example, you submit - // a ListReservations request with MaxResults set at 5. Although 20 items match - // your request, the service returns no more than the first 5 items. (The service - // also returns a NextToken value that you can use to fetch the next batch of - // results.) The service might return fewer results than the MaxResults value. If - // MaxResults is not included in the request, the service defaults to pagination + // The maximum number of results to return per API request. For example, you + // submit a ListReservations request with MaxResults set at 5. Although 20 items + // match your request, the service returns no more than the first 5 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to pagination // with a maximum of 10 results per page. MaxResults int32 @@ -140,12 +140,12 @@ var _ ListReservationsAPIClient = (*Client)(nil) // ListReservationsPaginatorOptions is the paginator options for ListReservations type ListReservationsPaginatorOptions struct { - // The maximum number of results to return per API request. For example, you submit - // a ListReservations request with MaxResults set at 5. Although 20 items match - // your request, the service returns no more than the first 5 items. (The service - // also returns a NextToken value that you can use to fetch the next batch of - // results.) The service might return fewer results than the MaxResults value. If - // MaxResults is not included in the request, the service defaults to pagination + // The maximum number of results to return per API request. For example, you + // submit a ListReservations request with MaxResults set at 5. Although 20 items + // match your request, the service returns no more than the first 5 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to pagination // with a maximum of 10 results per page. Limit int32 diff --git a/service/mediaconnect/api_op_PurchaseOffering.go b/service/mediaconnect/api_op_PurchaseOffering.go index a8bbe72b816..5342c08f01c 100644 --- a/service/mediaconnect/api_op_PurchaseOffering.go +++ b/service/mediaconnect/api_op_PurchaseOffering.go @@ -56,12 +56,12 @@ type PurchaseOfferingInput struct { type PurchaseOfferingOutput struct { - // A pricing agreement for a discounted rate for a specific outbound bandwidth that - // your MediaConnect account will use each month over a specific time period. The - // discounted rate in the reservation applies to outbound bandwidth for all flows - // from your account until your account reaches the amount of bandwidth in your - // reservation. If you use more outbound bandwidth than the agreed upon amount in a - // single month, the overage is charged at the on-demand rate. + // A pricing agreement for a discounted rate for a specific outbound bandwidth + // that your MediaConnect account will use each month over a specific time period. + // The discounted rate in the reservation applies to outbound bandwidth for all + // flows from your account until your account reaches the amount of bandwidth in + // your reservation. If you use more outbound bandwidth than the agreed upon amount + // in a single month, the overage is charged at the on-demand rate. Reservation *types.Reservation // Metadata pertaining to the operation's result. diff --git a/service/mediaconnect/api_op_UpdateFlowEntitlement.go b/service/mediaconnect/api_op_UpdateFlowEntitlement.go index d487cd36800..507a1f21679 100644 --- a/service/mediaconnect/api_op_UpdateFlowEntitlement.go +++ b/service/mediaconnect/api_op_UpdateFlowEntitlement.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You can change an entitlement's description, subscribers, and encryption. If you -// change the subscribers, the service will remove the outputs that are are used by -// the subscribers that are removed. +// You can change an entitlement's description, subscribers, and encryption. If +// you change the subscribers, the service will remove the outputs that are are +// used by the subscribers that are removed. func (c *Client) UpdateFlowEntitlement(ctx context.Context, params *UpdateFlowEntitlementInput, optFns ...func(*Options)) (*UpdateFlowEntitlementOutput, error) { if params == nil { params = &UpdateFlowEntitlementInput{} diff --git a/service/mediaconnect/types/enums.go b/service/mediaconnect/types/enums.go index 60e6abd31c0..3e5c4f4b2b3 100644 --- a/service/mediaconnect/types/enums.go +++ b/service/mediaconnect/types/enums.go @@ -11,9 +11,9 @@ const ( AlgorithmAes256 Algorithm = "aes256" ) -// Values returns all known values for Algorithm. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Algorithm. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Algorithm) Values() []Algorithm { return []Algorithm{ "aes128", @@ -94,9 +94,9 @@ const ( EncodingNamePcm EncodingName = "pcm" ) -// Values returns all known values for EncodingName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EncodingName. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EncodingName) Values() []EncodingName { return []EncodingName{ "jxsv", @@ -132,9 +132,9 @@ const ( FailoverModeFailover FailoverMode = "FAILOVER" ) -// Values returns all known values for FailoverMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for FailoverMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (FailoverMode) Values() []FailoverMode { return []FailoverMode{ "MERGE", @@ -287,8 +287,8 @@ const ( RangeFullprotect Range = "FULLPROTECT" ) -// Values returns all known values for Range. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Range. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Range) Values() []Range { return []Range{ @@ -327,9 +327,9 @@ const ( ResourceTypeMbpsOutboundBandwidth ResourceType = "Mbps_Outbound_Bandwidth" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "Mbps_Outbound_Bandwidth", @@ -382,8 +382,8 @@ const ( StateDisabled State = "DISABLED" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ diff --git a/service/mediaconnect/types/types.go b/service/mediaconnect/types/types.go index 7d5e07f2955..d2817fa5d77 100644 --- a/service/mediaconnect/types/types.go +++ b/service/mediaconnect/types/types.go @@ -228,8 +228,8 @@ type EncodingParametersRequest struct { // Information about the encryption of the flow. type Encryption struct { - // The ARN of the role that you created during setup (when you set up AWS Elemental - // MediaConnect as a trusted entity). + // The ARN of the role that you created during setup (when you set up AWS + // Elemental MediaConnect as a trusted entity). // // This member is required. RoleArn *string @@ -257,10 +257,10 @@ type Encryption struct { // encryption. Region *string - // An identifier for the content. The service sends this value to the key server to - // identify the current endpoint. The resource ID is also known as the content ID. - // This parameter is required for SPEKE encryption and is not valid for static key - // encryption. + // An identifier for the content. The service sends this value to the key server + // to identify the current endpoint. The resource ID is also known as the content + // ID. This parameter is required for SPEKE encryption and is not valid for static + // key encryption. ResourceId *string // The ARN of the secret that you created in AWS Secrets Manager to store the @@ -315,16 +315,16 @@ type Entitlement struct { // The settings for source failover. type FailoverConfig struct { - // The type of failover you choose for this flow. MERGE combines the source streams - // into a single stream, allowing graceful recovery from any single-source loss. - // FAILOVER allows switching between different streams. + // The type of failover you choose for this flow. MERGE combines the source + // streams into a single stream, allowing graceful recovery from any single-source + // loss. FAILOVER allows switching between different streams. FailoverMode FailoverMode // Search window time to look for dash-7 packets RecoveryWindow int32 - // The priority you want to assign to a source. You can have a primary stream and a - // backup stream or two equally prioritized streams. + // The priority you want to assign to a source. You can have a primary stream and + // a backup stream or two equally prioritized streams. SourcePriority *SourcePriority State State @@ -346,8 +346,8 @@ type Flow struct { // This member is required. Entitlements []Entitlement - // The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the - // flow. + // The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of + // the flow. // // This member is required. FlowArn *string @@ -372,8 +372,8 @@ type Flow struct { // This member is required. Status Status - // A description of the flow. This value is not used or seen outside of the current - // AWS Elemental MediaConnect account. + // A description of the flow. This value is not used or seen outside of the + // current AWS Elemental MediaConnect account. Description *string // The IP address from which video will be sent to output destinations. @@ -382,8 +382,8 @@ type Flow struct { // The maintenance setting of a flow Maintenance *Maintenance - // The media streams that are associated with the flow. After you associate a media - // stream with a source, you can also associate it with outputs on the flow. + // The media streams that are associated with the flow. After you associate a + // media stream with a source, you can also associate it with outputs on the flow. MediaStreams []MediaStream // The settings for source failover. @@ -633,10 +633,11 @@ type Maintenance struct { noSmithyDocumentSerde } -// A single track or stream of media that contains video, audio, or ancillary data. -// After you add a media stream to a flow, you can associate it with sources and -// outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG -// XS protocol. Each source or output can consist of one or many media streams. +// A single track or stream of media that contains video, audio, or ancillary +// data. After you add a media stream to a flow, you can associate it with sources +// and outputs on that flow, as long as they use the CDI protocol or the ST 2110 +// JPEG XS protocol. Each source or output can consist of one or many media +// streams. type MediaStream struct { // The format type number (sometimes referred to as RTP payload type) of the media @@ -703,14 +704,14 @@ type MediaStreamAttributesRequest struct { noSmithyDocumentSerde } -// The media stream that is associated with the output, and the parameters for that -// association. +// The media stream that is associated with the output, and the parameters for +// that association. type MediaStreamOutputConfiguration struct { - // The format that was used to encode the data. For ancillary data streams, set the - // encoding name to smpte291. For audio streams, set the encoding name to pcm. For - // video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, - // set the encoding name to jxsv. + // The format that was used to encode the data. For ancillary data streams, set + // the encoding name to smpte291. For audio streams, set the encoding name to pcm. + // For video, 2110 streams, set the encoding name to raw. For video, JPEG XS + // streams, set the encoding name to jxsv. // // This member is required. EncodingName EncodingName @@ -733,9 +734,9 @@ type MediaStreamOutputConfiguration struct { // for that association. type MediaStreamOutputConfigurationRequest struct { - // The format that will be used to encode the data. For ancillary data streams, set - // the encoding name to smpte291. For audio streams, set the encoding name to pcm. - // For video, 2110 streams, set the encoding name to raw. For video, JPEG XS + // The format that will be used to encode the data. For ancillary data streams, + // set the encoding name to smpte291. For audio streams, set the encoding name to + // pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS // streams, set the encoding name to jxsv. // // This member is required. @@ -756,14 +757,14 @@ type MediaStreamOutputConfigurationRequest struct { noSmithyDocumentSerde } -// The media stream that is associated with the source, and the parameters for that -// association. +// The media stream that is associated with the source, and the parameters for +// that association. type MediaStreamSourceConfiguration struct { - // The format that was used to encode the data. For ancillary data streams, set the - // encoding name to smpte291. For audio streams, set the encoding name to pcm. For - // video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, - // set the encoding name to jxsv. + // The format that was used to encode the data. For ancillary data streams, set + // the encoding name to smpte291. For audio streams, set the encoding name to pcm. + // For video, 2110 streams, set the encoding name to raw. For video, JPEG XS + // streams, set the encoding name to jxsv. // // This member is required. EncodingName EncodingName @@ -900,8 +901,8 @@ type Output struct { // applies only to outputs that use the Zixi pull or SRT listener protocol. ListenerAddress *string - // The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant - // only for outputs that were added by creating a MediaLive input. + // The input ARN of the AWS Elemental MediaLive channel. This parameter is + // relevant only for outputs that were added by creating a MediaLive input. MediaLiveInputArn *string // The configuration for each media stream that is associated with the output. @@ -919,12 +920,12 @@ type Output struct { noSmithyDocumentSerde } -// A pricing agreement for a discounted rate for a specific outbound bandwidth that -// your MediaConnect account will use each month over a specific time period. The -// discounted rate in the reservation applies to outbound bandwidth for all flows -// from your account until your account reaches the amount of bandwidth in your -// reservation. If you use more outbound bandwidth than the agreed upon amount in a -// single month, the overage is charged at the on-demand rate. +// A pricing agreement for a discounted rate for a specific outbound bandwidth +// that your MediaConnect account will use each month over a specific time period. +// The discounted rate in the reservation applies to outbound bandwidth for all +// flows from your account until your account reaches the amount of bandwidth in +// your reservation. If you use more outbound bandwidth than the agreed upon amount +// in a single month, the overage is charged at the on-demand rate. type Reservation struct { // The type of currency that is used for billing. The currencyCode used for your @@ -974,8 +975,8 @@ type Reservation struct { // This member is required. PriceUnits PriceUnits - // The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when - // you purchase an offering. + // The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation + // when you purchase an offering. // // This member is required. ReservationArn *string @@ -1154,8 +1155,8 @@ type Source struct { noSmithyDocumentSerde } -// The priority you want to assign to a source. You can have a primary stream and a -// backup stream or two equally prioritized streams. +// The priority you want to assign to a source. You can have a primary stream and +// a backup stream or two equally prioritized streams. type SourcePriority struct { // The name of the source you choose as the primary source for this flow. @@ -1247,14 +1248,14 @@ type UpdateEncryption struct { // encryption. Region *string - // An identifier for the content. The service sends this value to the key server to - // identify the current endpoint. The resource ID is also known as the content ID. - // This parameter is required for SPEKE encryption and is not valid for static key - // encryption. + // An identifier for the content. The service sends this value to the key server + // to identify the current endpoint. The resource ID is also known as the content + // ID. This parameter is required for SPEKE encryption and is not valid for static + // key encryption. ResourceId *string - // The ARN of the role that you created during setup (when you set up AWS Elemental - // MediaConnect as a trusted entity). + // The ARN of the role that you created during setup (when you set up AWS + // Elemental MediaConnect as a trusted entity). RoleArn *string // The ARN of the secret that you created in AWS Secrets Manager to store the @@ -1273,16 +1274,16 @@ type UpdateEncryption struct { // The settings for source failover. type UpdateFailoverConfig struct { - // The type of failover you choose for this flow. MERGE combines the source streams - // into a single stream, allowing graceful recovery from any single-source loss. - // FAILOVER allows switching between different streams. + // The type of failover you choose for this flow. MERGE combines the source + // streams into a single stream, allowing graceful recovery from any single-source + // loss. FAILOVER allows switching between different streams. FailoverMode FailoverMode // Recovery window time to look for dash-7 packets RecoveryWindow int32 - // The priority you want to assign to a source. You can have a primary stream and a - // backup stream or two equally prioritized streams. + // The priority you want to assign to a source. You can have a primary stream and + // a backup stream or two equally prioritized streams. SourcePriority *SourcePriority State State diff --git a/service/mediaconvert/api_client.go b/service/mediaconvert/api_client.go index d992173208c..5cbb1697a5d 100644 --- a/service/mediaconvert/api_client.go +++ b/service/mediaconvert/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediaconvert/api_op_AssociateCertificate.go b/service/mediaconvert/api_op_AssociateCertificate.go index 65e4581d62f..24f8bff164d 100644 --- a/service/mediaconvert/api_op_AssociateCertificate.go +++ b/service/mediaconvert/api_op_AssociateCertificate.go @@ -29,8 +29,8 @@ func (c *Client) AssociateCertificate(ctx context.Context, params *AssociateCert type AssociateCertificateInput struct { - // The ARN of the ACM certificate that you want to associate with your MediaConvert - // resource. + // The ARN of the ACM certificate that you want to associate with your + // MediaConvert resource. // // This member is required. Arn *string diff --git a/service/mediaconvert/api_op_CreateJobTemplate.go b/service/mediaconvert/api_op_CreateJobTemplate.go index 19b4f67b3c8..60f64147a05 100644 --- a/service/mediaconvert/api_op_CreateJobTemplate.go +++ b/service/mediaconvert/api_op_CreateJobTemplate.go @@ -65,8 +65,8 @@ type CreateJobTemplateInput struct { // first. If you don't specify a priority, the service uses the default value 0. Priority int32 - // Optional. The queue that jobs created from this template are assigned to. If you - // don't specify this, jobs will go to the default queue. + // Optional. The queue that jobs created from this template are assigned to. If + // you don't specify this, jobs will go to the default queue. Queue *string // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch diff --git a/service/mediaconvert/api_op_TagResource.go b/service/mediaconvert/api_op_TagResource.go index 3c8d17f67f2..37750d7ec22 100644 --- a/service/mediaconvert/api_op_TagResource.go +++ b/service/mediaconvert/api_op_TagResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add tags to a MediaConvert queue, preset, or job template. For information about -// tagging, see the User Guide at +// Add tags to a MediaConvert queue, preset, or job template. For information +// about tagging, see the User Guide at // https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/mediaconvert/types/enums.go b/service/mediaconvert/types/enums.go index eb7f22ea918..e5ddc987892 100644 --- a/service/mediaconvert/types/enums.go +++ b/service/mediaconvert/types/enums.go @@ -10,8 +10,8 @@ const ( AacAudioDescriptionBroadcasterMixNormal AacAudioDescriptionBroadcasterMix = "NORMAL" ) -// Values returns all known values for AacAudioDescriptionBroadcasterMix. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AacAudioDescriptionBroadcasterMix. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AacAudioDescriptionBroadcasterMix) Values() []AacAudioDescriptionBroadcasterMix { @@ -91,9 +91,9 @@ const ( AacRawFormatNone AacRawFormat = "NONE" ) -// Values returns all known values for AacRawFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AacRawFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AacRawFormat) Values() []AacRawFormat { return []AacRawFormat{ "LATM_LOAS", @@ -228,8 +228,8 @@ const ( Ac3DynamicRangeCompressionProfileNone Ac3DynamicRangeCompressionProfile = "NONE" ) -// Values returns all known values for Ac3DynamicRangeCompressionProfile. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for Ac3DynamicRangeCompressionProfile. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (Ac3DynamicRangeCompressionProfile) Values() []Ac3DynamicRangeCompressionProfile { @@ -251,9 +251,10 @@ const ( Ac3DynamicRangeCompressionRfNone Ac3DynamicRangeCompressionRf = "NONE" ) -// Values returns all known values for Ac3DynamicRangeCompressionRf. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Ac3DynamicRangeCompressionRf. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (Ac3DynamicRangeCompressionRf) Values() []Ac3DynamicRangeCompressionRf { return []Ac3DynamicRangeCompressionRf{ "FILM_STANDARD", @@ -273,9 +274,9 @@ const ( Ac3LfeFilterDisabled Ac3LfeFilter = "DISABLED" ) -// Values returns all known values for Ac3LfeFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Ac3LfeFilter. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Ac3LfeFilter) Values() []Ac3LfeFilter { return []Ac3LfeFilter{ "ENABLED", @@ -352,9 +353,9 @@ const ( AfdSignalingFixed AfdSignaling = "FIXED" ) -// Values returns all known values for AfdSignaling. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AfdSignaling. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AfdSignaling) Values() []AfdSignaling { return []AfdSignaling{ "NONE", @@ -389,9 +390,9 @@ const ( AncillaryConvert608To708Disabled AncillaryConvert608To708 = "DISABLED" ) -// Values returns all known values for AncillaryConvert608To708. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AncillaryConvert608To708. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AncillaryConvert608To708) Values() []AncillaryConvert608To708 { return []AncillaryConvert608To708{ "UPCONVERT", @@ -425,9 +426,9 @@ const ( AntiAliasEnabled AntiAlias = "ENABLED" ) -// Values returns all known values for AntiAlias. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AntiAlias. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AntiAlias) Values() []AntiAlias { return []AntiAlias{ "DISABLED", @@ -523,8 +524,8 @@ const ( AudioDefaultSelectionNotDefault AudioDefaultSelection = "NOT_DEFAULT" ) -// Values returns all known values for AudioDefaultSelection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AudioDefaultSelection. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AudioDefaultSelection) Values() []AudioDefaultSelection { return []AudioDefaultSelection{ @@ -563,9 +564,9 @@ const ( AudioLanguageCodeControlUseConfigured AudioLanguageCodeControl = "USE_CONFIGURED" ) -// Values returns all known values for AudioLanguageCodeControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioLanguageCodeControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioLanguageCodeControl) Values() []AudioLanguageCodeControl { return []AudioLanguageCodeControl{ "FOLLOW_INPUT", @@ -622,8 +623,8 @@ const ( AudioNormalizationLoudnessLoggingDontLog AudioNormalizationLoudnessLogging = "DONT_LOG" ) -// Values returns all known values for AudioNormalizationLoudnessLogging. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AudioNormalizationLoudnessLogging. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AudioNormalizationLoudnessLogging) Values() []AudioNormalizationLoudnessLogging { @@ -641,8 +642,8 @@ const ( AudioNormalizationPeakCalculationNone AudioNormalizationPeakCalculation = "NONE" ) -// Values returns all known values for AudioNormalizationPeakCalculation. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AudioNormalizationPeakCalculation. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AudioNormalizationPeakCalculation) Values() []AudioNormalizationPeakCalculation { @@ -840,9 +841,9 @@ const ( AvcIntraFramerateControlSpecified AvcIntraFramerateControl = "SPECIFIED" ) -// Values returns all known values for AvcIntraFramerateControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AvcIntraFramerateControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraFramerateControl) Values() []AvcIntraFramerateControl { return []AvcIntraFramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -882,8 +883,8 @@ const ( AvcIntraInterlaceModeFollowBottomField AvcIntraInterlaceMode = "FOLLOW_BOTTOM_FIELD" ) -// Values returns all known values for AvcIntraInterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AvcIntraInterlaceMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraInterlaceMode) Values() []AvcIntraInterlaceMode { return []AvcIntraInterlaceMode{ @@ -1067,9 +1068,10 @@ const ( BurninSubtitleApplyFontColorAllText BurninSubtitleApplyFontColor = "ALL_TEXT" ) -// Values returns all known values for BurninSubtitleApplyFontColor. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for BurninSubtitleApplyFontColor. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (BurninSubtitleApplyFontColor) Values() []BurninSubtitleApplyFontColor { return []BurninSubtitleApplyFontColor{ "WHITE_TEXT_ONLY", @@ -1499,9 +1501,10 @@ const ( CmafMpdManifestBandwidthTypeMax CmafMpdManifestBandwidthType = "MAX" ) -// Values returns all known values for CmafMpdManifestBandwidthType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CmafMpdManifestBandwidthType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (CmafMpdManifestBandwidthType) Values() []CmafMpdManifestBandwidthType { return []CmafMpdManifestBandwidthType{ "AVERAGE", @@ -1572,9 +1575,9 @@ const ( CmafSegmentLengthControlGopMultiple CmafSegmentLengthControl = "GOP_MULTIPLE" ) -// Values returns all known values for CmafSegmentLengthControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CmafSegmentLengthControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafSegmentLengthControl) Values() []CmafSegmentLengthControl { return []CmafSegmentLengthControl{ "EXACT", @@ -1645,8 +1648,8 @@ const ( CmafWriteDASHManifestEnabled CmafWriteDASHManifest = "ENABLED" ) -// Values returns all known values for CmafWriteDASHManifest. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CmafWriteDASHManifest. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CmafWriteDASHManifest) Values() []CmafWriteDASHManifest { return []CmafWriteDASHManifest{ @@ -2202,8 +2205,8 @@ const ( DashIsoSegmentControlSegmentedFiles DashIsoSegmentControl = "SEGMENTED_FILES" ) -// Values returns all known values for DashIsoSegmentControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DashIsoSegmentControl. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DashIsoSegmentControl) Values() []DashIsoSegmentControl { return []DashIsoSegmentControl{ @@ -2257,10 +2260,10 @@ const ( DashIsoWriteSegmentTimelineInRepresentationDisabled DashIsoWriteSegmentTimelineInRepresentation = "DISABLED" ) -// Values returns all known values for DashIsoWriteSegmentTimelineInRepresentation. -// Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// Values returns all known values for +// DashIsoWriteSegmentTimelineInRepresentation. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this +// slice is not guaranteed to be stable across updates. func (DashIsoWriteSegmentTimelineInRepresentation) Values() []DashIsoWriteSegmentTimelineInRepresentation { return []DashIsoWriteSegmentTimelineInRepresentation{ "ENABLED", @@ -2376,8 +2379,8 @@ const ( DescribeEndpointsModeGetOnly DescribeEndpointsMode = "GET_ONLY" ) -// Values returns all known values for DescribeEndpointsMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DescribeEndpointsMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DescribeEndpointsMode) Values() []DescribeEndpointsMode { return []DescribeEndpointsMode{ @@ -2395,8 +2398,8 @@ const ( DolbyVisionLevel6ModeSpecify DolbyVisionLevel6Mode = "SPECIFY" ) -// Values returns all known values for DolbyVisionLevel6Mode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DolbyVisionLevel6Mode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DolbyVisionLevel6Mode) Values() []DolbyVisionLevel6Mode { return []DolbyVisionLevel6Mode{ @@ -2837,9 +2840,10 @@ const ( Eac3AtmosDynamicRangeControlInitializeFromSource Eac3AtmosDynamicRangeControl = "INITIALIZE_FROM_SOURCE" ) -// Values returns all known values for Eac3AtmosDynamicRangeControl. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Eac3AtmosDynamicRangeControl. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (Eac3AtmosDynamicRangeControl) Values() []Eac3AtmosDynamicRangeControl { return []Eac3AtmosDynamicRangeControl{ "SPECIFIED", @@ -2858,8 +2862,8 @@ const ( Eac3AtmosMeteringModeItuBs17704 Eac3AtmosMeteringMode = "ITU_BS_1770_4" ) -// Values returns all known values for Eac3AtmosMeteringMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Eac3AtmosMeteringMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosMeteringMode) Values() []Eac3AtmosMeteringMode { return []Eac3AtmosMeteringMode{ @@ -2983,9 +2987,9 @@ const ( Eac3DcFilterDisabled Eac3DcFilter = "DISABLED" ) -// Values returns all known values for Eac3DcFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Eac3DcFilter. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Eac3DcFilter) Values() []Eac3DcFilter { return []Eac3DcFilter{ "ENABLED", @@ -3243,9 +3247,9 @@ const ( EmbeddedTimecodeOverrideUseMdpm EmbeddedTimecodeOverride = "USE_MDPM" ) -// Values returns all known values for EmbeddedTimecodeOverride. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EmbeddedTimecodeOverride. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EmbeddedTimecodeOverride) Values() []EmbeddedTimecodeOverride { return []EmbeddedTimecodeOverride{ "NONE", @@ -3297,9 +3301,9 @@ const ( FileSourceTimeDeltaUnitsMilliseconds FileSourceTimeDeltaUnits = "MILLISECONDS" ) -// Values returns all known values for FileSourceTimeDeltaUnits. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FileSourceTimeDeltaUnits. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSourceTimeDeltaUnits) Values() []FileSourceTimeDeltaUnits { return []FileSourceTimeDeltaUnits{ "SECONDS", @@ -3340,9 +3344,9 @@ const ( H264AdaptiveQuantizationMax H264AdaptiveQuantization = "MAX" ) -// Values returns all known values for H264AdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H264AdaptiveQuantization. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H264AdaptiveQuantization) Values() []H264AdaptiveQuantization { return []H264AdaptiveQuantization{ "OFF", @@ -3708,8 +3712,8 @@ const ( H264SceneChangeDetectTransitionDetection H264SceneChangeDetect = "TRANSITION_DETECTION" ) -// Values returns all known values for H264SceneChangeDetect. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for H264SceneChangeDetect. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (H264SceneChangeDetect) Values() []H264SceneChangeDetect { return []H264SceneChangeDetect{ @@ -3783,9 +3787,9 @@ const ( H264TelecineHard H264Telecine = "HARD" ) -// Values returns all known values for H264Telecine. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for H264Telecine. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (H264Telecine) Values() []H264Telecine { return []H264Telecine{ "NONE", @@ -3844,9 +3848,9 @@ const ( H265AdaptiveQuantizationAuto H265AdaptiveQuantization = "AUTO" ) -// Values returns all known values for H265AdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H265AdaptiveQuantization. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H265AdaptiveQuantization) Values() []H265AdaptiveQuantization { return []H265AdaptiveQuantization{ "OFF", @@ -4194,8 +4198,8 @@ const ( H265SceneChangeDetectTransitionDetection H265SceneChangeDetect = "TRANSITION_DETECTION" ) -// Values returns all known values for H265SceneChangeDetect. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for H265SceneChangeDetect. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (H265SceneChangeDetect) Values() []H265SceneChangeDetect { return []H265SceneChangeDetect{ @@ -4251,9 +4255,9 @@ const ( H265TelecineHard H265Telecine = "HARD" ) -// Values returns all known values for H265Telecine. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for H265Telecine. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (H265Telecine) Values() []H265Telecine { return []H265Telecine{ "NONE", @@ -4307,9 +4311,9 @@ const ( H265TilesEnabled H265Tiles = "ENABLED" ) -// Values returns all known values for H265Tiles. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for H265Tiles. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (H265Tiles) Values() []H265Tiles { return []H265Tiles{ "DISABLED", @@ -4379,9 +4383,9 @@ const ( HlsAdMarkersElementalScte35 HlsAdMarkers = "ELEMENTAL_SCTE35" ) -// Values returns all known values for HlsAdMarkers. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HlsAdMarkers. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HlsAdMarkers) Values() []HlsAdMarkers { return []HlsAdMarkers{ "ELEMENTAL", @@ -4397,8 +4401,8 @@ const ( HlsAudioOnlyContainerM2ts HlsAudioOnlyContainer = "M2TS" ) -// Values returns all known values for HlsAudioOnlyContainer. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsAudioOnlyContainer. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsAudioOnlyContainer) Values() []HlsAudioOnlyContainer { return []HlsAudioOnlyContainer{ @@ -4512,8 +4516,8 @@ const ( HlsCodecSpecificationRfc4281 HlsCodecSpecification = "RFC_4281" ) -// Values returns all known values for HlsCodecSpecification. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsCodecSpecification. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsCodecSpecification) Values() []HlsCodecSpecification { return []HlsCodecSpecification{ @@ -4549,8 +4553,8 @@ const ( HlsDirectoryStructureSubdirectoryPerStream HlsDirectoryStructure = "SUBDIRECTORY_PER_STREAM" ) -// Values returns all known values for HlsDirectoryStructure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsDirectoryStructure. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsDirectoryStructure) Values() []HlsDirectoryStructure { return []HlsDirectoryStructure{ @@ -4585,8 +4589,8 @@ const ( HlsIFrameOnlyManifestExclude HlsIFrameOnlyManifest = "EXCLUDE" ) -// Values returns all known values for HlsIFrameOnlyManifest. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsIFrameOnlyManifest. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsIFrameOnlyManifest) Values() []HlsIFrameOnlyManifest { return []HlsIFrameOnlyManifest{ @@ -4625,8 +4629,8 @@ const ( HlsInitializationVectorInManifestExclude HlsInitializationVectorInManifest = "EXCLUDE" ) -// Values returns all known values for HlsInitializationVectorInManifest. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for HlsInitializationVectorInManifest. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (HlsInitializationVectorInManifest) Values() []HlsInitializationVectorInManifest { @@ -4844,9 +4848,9 @@ const ( HlsTimedMetadataId3FrameTdrl HlsTimedMetadataId3Frame = "TDRL" ) -// Values returns all known values for HlsTimedMetadataId3Frame. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for HlsTimedMetadataId3Frame. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsTimedMetadataId3Frame) Values() []HlsTimedMetadataId3Frame { return []HlsTimedMetadataId3Frame{ "NONE", @@ -4863,8 +4867,8 @@ const ( ImscAccessibilitySubsEnabled ImscAccessibilitySubs = "ENABLED" ) -// Values returns all known values for ImscAccessibilitySubs. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ImscAccessibilitySubs. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ImscAccessibilitySubs) Values() []ImscAccessibilitySubs { return []ImscAccessibilitySubs{ @@ -5096,9 +5100,9 @@ const ( JobStatusError JobStatus = "ERROR" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -5327,9 +5331,9 @@ const ( LanguageCodeSrp LanguageCode = "SRP" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "ENG", @@ -5661,9 +5665,9 @@ const ( M2tsForceTsVideoEbpOrderDefault M2tsForceTsVideoEbpOrder = "DEFAULT" ) -// Values returns all known values for M2tsForceTsVideoEbpOrder. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for M2tsForceTsVideoEbpOrder. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsForceTsVideoEbpOrder) Values() []M2tsForceTsVideoEbpOrder { return []M2tsForceTsVideoEbpOrder{ "FORCE", @@ -5733,9 +5737,9 @@ const ( M2tsRateModeCbr M2tsRateMode = "CBR" ) -// Values returns all known values for M2tsRateMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for M2tsRateMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (M2tsRateMode) Values() []M2tsRateMode { return []M2tsRateMode{ "VBR", @@ -5795,8 +5799,8 @@ const ( M2tsSegmentationStyleResetCadence M2tsSegmentationStyle = "RESET_CADENCE" ) -// Values returns all known values for M2tsSegmentationStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for M2tsSegmentationStyle. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (M2tsSegmentationStyle) Values() []M2tsSegmentationStyle { return []M2tsSegmentationStyle{ @@ -5903,9 +5907,9 @@ const ( MotionImageInsertionModePng MotionImageInsertionMode = "PNG" ) -// Values returns all known values for MotionImageInsertionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MotionImageInsertionMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MotionImageInsertionMode) Values() []MotionImageInsertionMode { return []MotionImageInsertionMode{ "MOV", @@ -5975,8 +5979,8 @@ const ( MovMpeg2FourCCControlMpeg MovMpeg2FourCCControl = "MPEG" ) -// Values returns all known values for MovMpeg2FourCCControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MovMpeg2FourCCControl. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MovMpeg2FourCCControl) Values() []MovMpeg2FourCCControl { return []MovMpeg2FourCCControl{ @@ -6011,9 +6015,9 @@ const ( MovReferenceExternal MovReference = "EXTERNAL" ) -// Values returns all known values for MovReference. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MovReference. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MovReference) Values() []MovReference { return []MovReference{ "SELF_CONTAINED", @@ -6101,9 +6105,10 @@ const ( MpdAccessibilityCaptionHintsExclude MpdAccessibilityCaptionHints = "EXCLUDE" ) -// Values returns all known values for MpdAccessibilityCaptionHints. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MpdAccessibilityCaptionHints. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (MpdAccessibilityCaptionHints) Values() []MpdAccessibilityCaptionHints { return []MpdAccessibilityCaptionHints{ "INCLUDE", @@ -6173,9 +6178,10 @@ const ( MpdManifestMetadataSignalingDisabled MpdManifestMetadataSignaling = "DISABLED" ) -// Values returns all known values for MpdManifestMetadataSignaling. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MpdManifestMetadataSignaling. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (MpdManifestMetadataSignaling) Values() []MpdManifestMetadataSignaling { return []MpdManifestMetadataSignaling{ "ENABLED", @@ -6345,8 +6351,8 @@ const ( Mpeg2FramerateControlSpecified Mpeg2FramerateControl = "SPECIFIED" ) -// Values returns all known values for Mpeg2FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Mpeg2FramerateControl. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2FramerateControl) Values() []Mpeg2FramerateControl { return []Mpeg2FramerateControl{ @@ -6364,8 +6370,8 @@ const ( Mpeg2FramerateConversionAlgorithmFrameformer Mpeg2FramerateConversionAlgorithm = "FRAMEFORMER" ) -// Values returns all known values for Mpeg2FramerateConversionAlgorithm. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for Mpeg2FramerateConversionAlgorithm. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (Mpeg2FramerateConversionAlgorithm) Values() []Mpeg2FramerateConversionAlgorithm { @@ -6429,8 +6435,8 @@ const ( Mpeg2IntraDcPrecisionIntraDcPrecision11 Mpeg2IntraDcPrecision = "INTRA_DC_PRECISION_11" ) -// Values returns all known values for Mpeg2IntraDcPrecision. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Mpeg2IntraDcPrecision. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2IntraDcPrecision) Values() []Mpeg2IntraDcPrecision { return []Mpeg2IntraDcPrecision{ @@ -6540,9 +6546,9 @@ const ( Mpeg2SlowPalEnabled Mpeg2SlowPal = "ENABLED" ) -// Values returns all known values for Mpeg2SlowPal. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Mpeg2SlowPal. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2SlowPal) Values() []Mpeg2SlowPal { return []Mpeg2SlowPal{ "DISABLED", @@ -6615,8 +6621,8 @@ const ( Mpeg2TemporalAdaptiveQuantizationEnabled Mpeg2TemporalAdaptiveQuantization = "ENABLED" ) -// Values returns all known values for Mpeg2TemporalAdaptiveQuantization. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for Mpeg2TemporalAdaptiveQuantization. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (Mpeg2TemporalAdaptiveQuantization) Values() []Mpeg2TemporalAdaptiveQuantization { @@ -6671,9 +6677,9 @@ const ( MsSmoothManifestEncodingUtf16 MsSmoothManifestEncoding = "UTF16" ) -// Values returns all known values for MsSmoothManifestEncoding. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MsSmoothManifestEncoding. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MsSmoothManifestEncoding) Values() []MsSmoothManifestEncoding { return []MsSmoothManifestEncoding{ "UTF8", @@ -6748,8 +6754,8 @@ const ( NielsenActiveWatermarkProcessTypeNaes2AndNwAndCbet NielsenActiveWatermarkProcessType = "NAES2_AND_NW_AND_CBET" ) -// Values returns all known values for NielsenActiveWatermarkProcessType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for NielsenActiveWatermarkProcessType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (NielsenActiveWatermarkProcessType) Values() []NielsenActiveWatermarkProcessType { @@ -6787,8 +6793,8 @@ const ( NielsenUniqueTicPerAudioTrackTypeSameTicsPerTrack NielsenUniqueTicPerAudioTrackType = "SAME_TICS_PER_TRACK" ) -// Values returns all known values for NielsenUniqueTicPerAudioTrackType. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for NielsenUniqueTicPerAudioTrackType. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (NielsenUniqueTicPerAudioTrackType) Values() []NielsenUniqueTicPerAudioTrackType { @@ -6807,8 +6813,8 @@ const ( NoiseFilterPostTemporalSharpeningAuto NoiseFilterPostTemporalSharpening = "AUTO" ) -// Values returns all known values for NoiseFilterPostTemporalSharpening. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for NoiseFilterPostTemporalSharpening. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (NoiseFilterPostTemporalSharpening) Values() []NoiseFilterPostTemporalSharpening { @@ -6878,8 +6884,8 @@ const ( OrderDescending Order = "DESCENDING" ) -// Values returns all known values for Order. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Order. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Order) Values() []Order { return []Order{ @@ -6922,9 +6928,9 @@ const ( OutputSdtSdtNone OutputSdt = "SDT_NONE" ) -// Values returns all known values for OutputSdt. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputSdt. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OutputSdt) Values() []OutputSdt { return []OutputSdt{ "SDT_FOLLOW", @@ -6961,9 +6967,9 @@ const ( PresetListBySystem PresetListBy = "SYSTEM" ) -// Values returns all known values for PresetListBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PresetListBy. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PresetListBy) Values() []PresetListBy { return []PresetListBy{ "NAME", @@ -7123,9 +7129,10 @@ const ( ProresScanTypeConversionModeInterlacedOptimize ProresScanTypeConversionMode = "INTERLACED_OPTIMIZE" ) -// Values returns all known values for ProresScanTypeConversionMode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProresScanTypeConversionMode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ProresScanTypeConversionMode) Values() []ProresScanTypeConversionMode { return []ProresScanTypeConversionMode{ "INTERLACED", @@ -7231,9 +7238,9 @@ const ( RequiredFlagDisabled RequiredFlag = "DISABLED" ) -// Values returns all known values for RequiredFlag. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RequiredFlag. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RequiredFlag) Values() []RequiredFlag { return []RequiredFlag{ "ENABLED", @@ -7249,8 +7256,8 @@ const ( ReservationPlanStatusExpired ReservationPlanStatus = "EXPIRED" ) -// Values returns all known values for ReservationPlanStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReservationPlanStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReservationPlanStatus) Values() []ReservationPlanStatus { return []ReservationPlanStatus{ @@ -7268,9 +7275,9 @@ const ( RespondToAfdPassthrough RespondToAfd = "PASSTHROUGH" ) -// Values returns all known values for RespondToAfd. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RespondToAfd. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RespondToAfd) Values() []RespondToAfd { return []RespondToAfd{ "NONE", @@ -7350,8 +7357,8 @@ const ( SampleRangeConversionLimitedRangeClip SampleRangeConversion = "LIMITED_RANGE_CLIP" ) -// Values returns all known values for SampleRangeConversion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SampleRangeConversion. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SampleRangeConversion) Values() []SampleRangeConversion { return []SampleRangeConversion{ @@ -7411,8 +7418,8 @@ const ( SimulateReservedQueueEnabled SimulateReservedQueue = "ENABLED" ) -// Values returns all known values for SimulateReservedQueue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SimulateReservedQueue. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SimulateReservedQueue) Values() []SimulateReservedQueue { return []SimulateReservedQueue{ @@ -7881,8 +7888,8 @@ const ( Vp8QualityTuningLevelMultiPassHq Vp8QualityTuningLevel = "MULTI_PASS_HQ" ) -// Values returns all known values for Vp8QualityTuningLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Vp8QualityTuningLevel. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Vp8QualityTuningLevel) Values() []Vp8QualityTuningLevel { return []Vp8QualityTuningLevel{ @@ -7972,8 +7979,8 @@ const ( Vp9QualityTuningLevelMultiPassHq Vp9QualityTuningLevel = "MULTI_PASS_HQ" ) -// Values returns all known values for Vp9QualityTuningLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Vp9QualityTuningLevel. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Vp9QualityTuningLevel) Values() []Vp9QualityTuningLevel { return []Vp9QualityTuningLevel{ @@ -8030,9 +8037,9 @@ const ( WavFormatRf64 WavFormat = "RF64" ) -// Values returns all known values for WavFormat. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for WavFormat. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (WavFormat) Values() []WavFormat { return []WavFormat{ "RIFF", @@ -8190,9 +8197,9 @@ const ( XavcAdaptiveQuantizationMax XavcAdaptiveQuantization = "MAX" ) -// Values returns all known values for XavcAdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for XavcAdaptiveQuantization. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcAdaptiveQuantization) Values() []XavcAdaptiveQuantization { return []XavcAdaptiveQuantization{ "OFF", @@ -8370,8 +8377,8 @@ const ( XavcHdProfileTelecineHard XavcHdProfileTelecine = "HARD" ) -// Values returns all known values for XavcHdProfileTelecine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for XavcHdProfileTelecine. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (XavcHdProfileTelecine) Values() []XavcHdProfileTelecine { return []XavcHdProfileTelecine{ diff --git a/service/mediaconvert/types/types.go b/service/mediaconvert/types/types.go index 3dbd2d2a92d..2df358d4df7 100644 --- a/service/mediaconvert/types/types.go +++ b/service/mediaconvert/types/types.go @@ -16,20 +16,20 @@ import ( // control mode. type AacSettings struct { - // Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio - // description (AD) as a stereo pair. The value for AudioType will be set to 3, - // which signals to downstream systems that this stream contains "broadcaster mixed - // AD". Note that the input received by the encoder must contain pre-mixed audio; - // the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, - // the encoder ignores any values you provide in AudioType and - // FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed - // audio + audio description (AD). In this case, the encoder will use any values - // you provide for AudioType and FollowInputAudioType. + // Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + + // audio description (AD) as a stereo pair. The value for AudioType will be set to + // 3, which signals to downstream systems that this stream contains "broadcaster + // mixed AD". Note that the input received by the encoder must contain pre-mixed + // audio; the encoder does not perform the mixing. When you choose + // BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType + // and FollowInputAudioType. Choose NORMAL when the input does not contain + // pre-mixed audio + audio description (AD). In this case, the encoder will use any + // values you provide for AudioType and FollowInputAudioType. AudioDescriptionBroadcasterMix AacAudioDescriptionBroadcasterMix - // Specify the average bitrate in bits per second. The set of valid values for this - // setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, - // 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, + // Specify the average bitrate in bits per second. The set of valid values for + // this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, + // 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, // 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, // 896000, 1024000. The value you set is also constrained by the values that you // choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample @@ -39,14 +39,14 @@ type AacSettings struct { // AAC Profile. CodecProfile AacCodecProfile - // The Coding mode that you specify determines the number of audio channels and the - // audio channel layout metadata in your AAC output. Valid coding modes depend on - // the Rate control mode and Profile that you select. The following list shows the - // number of audio channels and channel layout for each coding mode. * 1.0 Audio - // Description (Receiver Mix): One channel, C. Includes audio description data from - // your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: - // One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Five channels, - // C, L, R, Ls, Rs, LFE. + // The Coding mode that you specify determines the number of audio channels and + // the audio channel layout metadata in your AAC output. Valid coding modes depend + // on the Rate control mode and Profile that you select. The following list shows + // the number of audio channels and channel layout for each coding mode. * 1.0 + // Audio Description (Receiver Mix): One channel, C. Includes audio description + // data from your stereo input. For more information see ETSI TS 101 154 Annex E. * + // 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Five + // channels, C, L, R, Ls, Rs, LFE. CodingMode AacCodingMode // Rate Control Mode. @@ -166,8 +166,8 @@ type AccelerationSettings struct { // value AIFF. type AiffSettings struct { - // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality - // for this audio track. + // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding + // quality for this audio track. BitDepth int32 // Specify the number of channels in this output audio track. Valid values are 1 @@ -241,8 +241,8 @@ type AudioChannelTaggingSettings struct { noSmithyDocumentSerde } -// Settings related to audio encoding. The settings in this group vary depending on -// the value that you choose for your audio codec. +// Settings related to audio encoding. The settings in this group vary depending +// on the value that you choose for your audio codec. type AudioCodecSettings struct { // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the @@ -287,16 +287,16 @@ type AudioCodecSettings struct { // value MP2. Mp2Settings *Mp2Settings - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // MP3. + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the + // value MP3. Mp3Settings *Mp3Settings - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // OPUS. + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the + // value OPUS. OpusSettings *OpusSettings - // Required when you set Codec, under AudioDescriptions>CodecSettings, to the value - // Vorbis. + // Required when you set Codec, under AudioDescriptions>CodecSettings, to the + // value Vorbis. VorbisSettings *VorbisSettings // Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the @@ -306,11 +306,11 @@ type AudioCodecSettings struct { noSmithyDocumentSerde } -// Settings related to one audio tab on the MediaConvert console. In your job JSON, -// an instance of AudioDescription is equivalent to one audio tab in the console. -// Usually, one audio tab corresponds to one output audio track. Depending on how -// you set up your input audio selectors and whether you use audio selector groups, -// one audio tab can correspond to a group of output audio tracks. +// Settings related to one audio tab on the MediaConvert console. In your job +// JSON, an instance of AudioDescription is equivalent to one audio tab in the +// console. Usually, one audio tab corresponds to one output audio track. Depending +// on how you set up your input audio selectors and whether you use audio selector +// groups, one audio tab can correspond to a group of output audio tracks. type AudioDescription struct { // When you mimic a multi-channel audio layout with multiple mono-channel tracks, @@ -326,10 +326,10 @@ type AudioDescription struct { // comply with a loudness standard. AudioNormalizationSettings *AudioNormalizationSettings - // Specifies which audio data to use from each input. In the simplest case, specify - // an "Audio Selector":#inputs-audio_selector by name based on its order within - // each input. For example if you specify "Audio Selector 3", then the third audio - // selector will be used from each input. If an input does not have an "Audio + // Specifies which audio data to use from each input. In the simplest case, + // specify an "Audio Selector":#inputs-audio_selector by name based on its order + // within each input. For example if you specify "Audio Selector 3", then the third + // audio selector will be used from each input. If an input does not have an "Audio // Selector 3", then the audio selector marked as "default" in that input will be // used. If there is no audio selector marked as "default", silence will be // inserted for the duration of that input. Alternatively, an "Audio Selector @@ -338,26 +338,26 @@ type AudioDescription struct { // Selector 1" will be chosen automatically. AudioSourceName *string - // Applies only if Follow Input Audio Type is unchecked (false). A number between 0 - // and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean - // Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = + // Applies only if Follow Input Audio Type is unchecked (false). A number between + // 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = + // Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = // Reserved. AudioType int32 - // When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that - // value is passed through to the output. If the input contains no ISO 639 + // When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then + // that value is passed through to the output. If the input contains no ISO 639 // audio_type, the value in Audio Type is included in the output. Otherwise the // value in Audio Type is included in the output. Note that this field and // audioType are both ignored if audioDescriptionBroadcasterMix is set to // BROADCASTER_MIXED_AD. AudioTypeControl AudioTypeControl - // Settings related to audio encoding. The settings in this group vary depending on - // the value that you choose for your audio codec. + // Settings related to audio encoding. The settings in this group vary depending + // on the value that you choose for your audio codec. CodecSettings *AudioCodecSettings - // Specify the language for this audio output track. The service puts this language - // code into your output audio track when you set Language code control + // Specify the language for this audio output track. The service puts this + // language code into your output audio track when you set Language code control // (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also // uses your specified custom language code when you set Language code control // (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file @@ -368,10 +368,10 @@ type AudioDescription struct { // Streaming. CustomLanguageCode *string - // Indicates the language of the audio output track. The ISO 639 language specified - // in the 'Language Code' drop down will be used when 'Follow Input Language Code' - // is not selected or when 'Follow Input Language Code' is selected but there is no - // ISO 639 language code specified by the input. + // Indicates the language of the audio output track. The ISO 639 language + // specified in the 'Language Code' drop down will be used when 'Follow Input + // Language Code' is not selected or when 'Follow Input Language Code' is selected + // but there is no ISO 639 language code specified by the input. LanguageCode LanguageCode // Specify which source for language code takes precedence for this audio track. @@ -605,24 +605,24 @@ type AutomatedAbrRule struct { noSmithyDocumentSerde } -// Use automated ABR to have MediaConvert set up the renditions in your ABR package -// for you automatically, based on characteristics of your input video. This -// feature optimizes video quality while minimizing the overall size of your ABR -// package. +// Use automated ABR to have MediaConvert set up the renditions in your ABR +// package for you automatically, based on characteristics of your input video. +// This feature optimizes video quality while minimizing the overall size of your +// ABR package. type AutomatedAbrSettings struct { - // Optional. The maximum target bit rate used in your automated ABR stack. Use this - // value to set an upper limit on the bandwidth consumed by the highest-quality - // rendition. This is the rendition that is delivered to viewers with the fastest - // internet connections. If you don't specify a value, MediaConvert uses 8,000,000 - // (8 mb/s) by default. + // Optional. The maximum target bit rate used in your automated ABR stack. Use + // this value to set an upper limit on the bandwidth consumed by the + // highest-quality rendition. This is the rendition that is delivered to viewers + // with the fastest internet connections. If you don't specify a value, + // MediaConvert uses 8,000,000 (8 mb/s) by default. MaxAbrBitrate int32 - // Optional. The maximum number of renditions that MediaConvert will create in your - // automated ABR stack. The number of renditions is determined automatically, based - // on analysis of each job, but will never exceed this limit. When you set this to - // Auto in the console, which is equivalent to excluding it from your JSON job - // specification, MediaConvert defaults to a limit of 15. + // Optional. The maximum number of renditions that MediaConvert will create in + // your automated ABR stack. The number of renditions is determined automatically, + // based on analysis of each job, but will never exceed this limit. When you set + // this to Auto in the console, which is equivalent to excluding it from your JSON + // job specification, MediaConvert defaults to a limit of 15. MaxRenditions int32 // Optional. The minimum target bitrate used in your automated ABR stack. Use this @@ -644,10 +644,10 @@ type AutomatedAbrSettings struct { // you, based on characteristics of your input video. type AutomatedEncodingSettings struct { - // Use automated ABR to have MediaConvert set up the renditions in your ABR package - // for you automatically, based on characteristics of your input video. This - // feature optimizes video quality while minimizing the overall size of your ABR - // package. + // Use automated ABR to have MediaConvert set up the renditions in your ABR + // package for you automatically, based on characteristics of your input video. + // This feature optimizes video quality while minimizing the overall size of your + // ABR package. AbrSettings *AutomatedAbrSettings noSmithyDocumentSerde @@ -750,8 +750,9 @@ type Av1Settings struct { // file size; choose a smaller number for better video quality. NumberBFramesBetweenReferenceFrames int32 - // Settings for quality-defined variable bitrate encoding with the H.265 codec. Use - // these settings only when you set QVBR for Rate control mode (RateControlMode). + // Settings for quality-defined variable bitrate encoding with the H.265 codec. + // Use these settings only when you set QVBR for Rate control mode + // (RateControlMode). QvbrSettings *Av1QvbrSettings // 'With AV1 outputs, for rate control mode, MediaConvert supports only @@ -989,9 +990,9 @@ type BurninDestinationSettings struct { // backgrounds from your output captions. BackgroundOpacity int32 - // Specify the font that you want the service to use for your burn in captions when - // your input captions specify a font that MediaConvert doesn't support. When you - // set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, + // Specify the font that you want the service to use for your burn in captions + // when your input captions specify a font that MediaConvert doesn't support. When + // you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, // MediaConvert uses a supported font that most closely matches the font that your // input captions specify. When there are multiple unsupported fonts in your input // captions, MediaConvert matches each font with the supported font that matches @@ -1049,8 +1050,8 @@ type BurninDestinationSettings struct { // shadows from your output captions. ShadowOpacity int32 - // Specify the horizontal offset of the shadow, relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels to the left. + // Specify the horizontal offset of the shadow, relative to the captions in + // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. ShadowXOffset int32 // Specify the vertical offset of the shadow relative to the captions in pixels. A @@ -1205,8 +1206,8 @@ type CaptionDestinationSettings struct { // plus SCTE-20 (EMBEDDED_PLUS_SCTE20). DestinationType CaptionDestinationType - // Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output - // as your video. For more information, see + // Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same + // output as your video. For more information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. // When you work directly in your JSON job specification, include this object and // any required children when you set destinationType to DVB_SUB. @@ -1230,20 +1231,20 @@ type CaptionDestinationSettings struct { // any required children when you set destinationType to IMSC. ImscDestinationSettings *ImscDestinationSettings - // Settings related to SCC captions. SCC is a sidecar format that holds captions in - // a file that is separate from the video container. Set up sidecar captions in the - // same output group, but different output from your video. For more information, - // see + // Settings related to SCC captions. SCC is a sidecar format that holds captions + // in a file that is separate from the video container. Set up sidecar captions in + // the same output group, but different output from your video. For more + // information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. // When you work directly in your JSON job specification, include this object and // any required children when you set destinationType to SCC. SccDestinationSettings *SccDestinationSettings - // Settings related to SRT captions. SRT is a sidecar format that holds captions in - // a file that is separate from the video container. Set up sidecar captions in the - // same output group, but different output from your video. When you work directly - // in your JSON job specification, include this object and any required children - // when you set destinationType to SRT. + // Settings related to SRT captions. SRT is a sidecar format that holds captions + // in a file that is separate from the video container. Set up sidecar captions in + // the same output group, but different output from your video. When you work + // directly in your JSON job specification, include this object and any required + // children when you set destinationType to SRT. SrtDestinationSettings *SrtDestinationSettings // Settings related to teletext captions. Set up teletext captions in the same @@ -1274,8 +1275,8 @@ type CaptionDestinationSettings struct { noSmithyDocumentSerde } -// Use captions selectors to specify the captions data from your input that you use -// in your outputs. You can use up to 20 captions selectors per input. +// Use captions selectors to specify the captions data from your input that you +// use in your outputs. You can use up to 20 captions selectors per input. type CaptionSelector struct { // The specific language to extract from source, using the ISO 639-2 or ISO 639-3 @@ -1287,12 +1288,12 @@ type CaptionSelector struct { // pass-through captions. CustomLanguageCode *string - // The specific language to extract from source. If input is SCTE-27, complete this - // field and/or PID to select the caption language to extract. If input is DVB-Sub - // and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the - // caption language to extract. If input is DVB-Sub that is being passed through, - // omit this field (and PID field); there is no way to extract a specific language - // with pass-through captions. + // The specific language to extract from source. If input is SCTE-27, complete + // this field and/or PID to select the caption language to extract. If input is + // DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to + // select the caption language to extract. If input is DVB-Sub that is being passed + // through, omit this field (and PID field); there is no way to extract a specific + // language with pass-through captions. LanguageCode LanguageCode // If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, @@ -1514,8 +1515,8 @@ type CmafGroupSettings struct { // generation. CodecSpecification CmafCodecSpecification - // Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To - // write a SegmentTimeline in each video Representation: Keep the default value, + // Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. + // To write a SegmentTimeline in each video Representation: Keep the default value, // Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose // Compact. Note that MediaConvert will still write a SegmentTimeline in any // Representation that does not share a common timeline. To write a video @@ -1759,11 +1760,11 @@ type CmfcSettings struct { // #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8 AudioRenditionSets *string - // Use this setting to control the values that MediaConvert puts in your HLS parent - // playlist to control how the client player selects which audio track to play. The - // other options for this setting determine the values that MediaConvert writes for - // the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio - // variant. For more information about these attributes, see the Apple + // Use this setting to control the values that MediaConvert puts in your HLS + // parent playlist to control how the client player selects which audio track to + // play. The other options for this setting determine the values that MediaConvert + // writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for + // the audio variant. For more information about these attributes, see the Apple // documentation article // https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. // Choose Alternate audio, auto select, default @@ -1802,8 +1803,8 @@ type CmfcSettings struct { // leave blank. KlvMetadata CmfcKlvMetadata - // To add an InbandEventStream element in your output MPD manifest for each type of - // event message, set Manifest metadata signaling to Enabled. For ID3 event + // To add an InbandEventStream element in your output MPD manifest for each type + // of event message, set Manifest metadata signaling to Enabled. For ID3 event // messages, the InbandEventStream element schemeIdUri will be same value that you // specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the // InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To @@ -1837,9 +1838,9 @@ type CmfcSettings struct { // 1, you must also set ID3 metadata (timedMetadata) to Passthrough. TimedMetadataBoxVersion CmfcTimedMetadataBoxVersion - // Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed - // metadata in your output. For more information, see ISO/IEC 23009-1:2022 section - // 5.10.3.3.4 Semantics. Leave blank to use the default value: + // Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 + // timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 + // section 5.10.3.3.4 Semantics. Leave blank to use the default value: // https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID // URI, you must also set ID3 metadata (timedMetadata) to Passthrough. TimedMetadataSchemeIdUri *string @@ -1871,32 +1872,24 @@ type ColorCorrector struct { // outcome of manually regrading from HDR to SDR. When you specify an output color // space, MediaConvert uses the following color space metadata, which includes // color primaries, transfer characteristics, and matrix coefficients: - // - // * HDR 10: - // BT.2020, PQ, BT.2020 non-constant - // - // * HLG 2020: BT.2020, HLG, BT.2020 - // non-constant - // - // * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 - // - // * P3D65 (SDR): - // Display P3, sRGB, BT.709 - // - // * P3D65 (HDR): Display P3, PQ, BT.709 + // - HDR 10: BT.2020, PQ, BT.2020 non-constant + // - HLG 2020: BT.2020, HLG, BT.2020 non-constant + // - P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 + // - P3D65 (SDR): Display P3, sRGB, BT.709 + // - P3D65 (HDR): Display P3, PQ, BT.709 ColorSpaceConversion ColorSpaceConversion // Contrast level. Contrast int32 - // Use these settings when you convert to the HDR 10 color space. Specify the SMPTE - // ST 2086 Mastering Display Color Volume static metadata that you want signaled in - // the output. These values don't affect the pixel values that are encoded in the - // video stream. They are intended to help the downstream video player display - // content in a way that reflects the intentions of the the content creator. When - // you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), - // these settings are required. You must set values for Max frame average light - // level (maxFrameAverageLightLevel) and Max content light level + // Use these settings when you convert to the HDR 10 color space. Specify the + // SMPTE ST 2086 Mastering Display Color Volume static metadata that you want + // signaled in the output. These values don't affect the pixel values that are + // encoded in the video stream. They are intended to help the downstream video + // player display content in a way that reflects the intentions of the the content + // creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 + // (FORCE_HDR10), these settings are required. You must set values for Max frame + // average light level (maxFrameAverageLightLevel) and Max content light level // (maxContentLightLevel); these settings don't have a default value. The default // values for the other HDR 10 metadata settings are defined by the P3D65 color // space. For more information about MediaConvert HDR jobs, see @@ -1965,16 +1958,16 @@ type ContainerSettings struct { // Settings for F4v container F4vSettings *F4vSettings - // MPEG-2 TS container settings. These apply to outputs in a File output group when - // the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In - // these assets, data is organized by the program map table (PMT). Each transport - // stream program contains subsets of data, including audio, video, and metadata. - // Each of these subsets of data has a numerical label called a packet identifier - // (PID). Each transport stream program corresponds to one MediaConvert output. The - // PMT lists the types of data in a program along with their PID. Downstream - // systems and players use the program map table to look up the PID for each type - // of data it accesses and then uses the PIDs to locate specific data within the - // asset. + // MPEG-2 TS container settings. These apply to outputs in a File output group + // when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). + // In these assets, data is organized by the program map table (PMT). Each + // transport stream program contains subsets of data, including audio, video, and + // metadata. Each of these subsets of data has a numerical label called a packet + // identifier (PID). Each transport stream program corresponds to one MediaConvert + // output. The PMT lists the types of data in a program along with their PID. + // Downstream systems and players use the program map table to look up the PID for + // each type of data it accesses and then uses the PIDs to locate specific data + // within the asset. M2tsSettings *M2tsSettings // These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for @@ -2050,15 +2043,16 @@ type DashIsoGroupSettings struct { // outputs in the output group, specify a list of them here. AdditionalManifests []DashAdditionalManifest - // Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) - // and your downstream workflow requires that your DASH manifest use the Dolby - // channel configuration tag, rather than the MPEG one. For example, you might need - // to use this to make dynamic ad insertion work. Specify which audio channel - // configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the - // default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have - // MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby - // channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write - // this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011. + // Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or + // Atmos) and your downstream workflow requires that your DASH manifest use the + // Dolby channel configuration tag, rather than the MPEG one. For example, you + // might need to use this to make dynamic ad insertion work. Specify which audio + // channel configuration scheme ID URI MediaConvert writes in your DASH manifest. + // Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), + // to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. + // Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have + // MediaConvert write this instead: + // tag:dolby.com,2014:dash:audio_channel_configuration:2011. AudioChannelConfigSchemeIdUri DashIsoGroupAudioChannelConfigSchemeIdUri // A partial URI prefix that will be put in the manifest (.mpd) file at the top @@ -2066,8 +2060,8 @@ type DashIsoGroupSettings struct { // than the manifest file. BaseUrl *string - // Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To - // write a SegmentTimeline in each video Representation: Keep the default value, + // Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. + // To write a SegmentTimeline in each video Representation: Keep the default value, // Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose // Compact. Note that MediaConvert will still write a SegmentTimeline in any // Representation that does not share a common timeline. To write a video @@ -2089,12 +2083,12 @@ type DashIsoGroupSettings struct { // DRM settings. Encryption *DashIsoEncryptionSettings - // Length of fragments to generate (in seconds). Fragment length must be compatible - // with GOP size and Framerate. Note that fragments will end on the next keyframe - // after this number of seconds, so actual fragment length may be longer. When Emit - // Single File is checked, the fragmentation is internal to a single output file - // and it does not cause the creation of many output files as in other output - // types. + // Length of fragments to generate (in seconds). Fragment length must be + // compatible with GOP size and Framerate. Note that fragments will end on the next + // keyframe after this number of seconds, so actual fragment length may be longer. + // When Emit Single File is checked, the fragmentation is internal to a single + // output file and it does not cause the creation of many output files as in other + // output types. FragmentLength int32 // Supports HbbTV specification as indicated @@ -2245,14 +2239,14 @@ type Deinterlacer struct { // such as a scrolling headline at the bottom of the frame. Algorithm DeinterlaceAlgorithm - // * When set to NORMAL (default), the deinterlacer does not convert frames that - // are tagged in metadata as progressive. It will only convert those that are - // tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer - // converts every frame to progressive - even those that are already tagged as - // progressive. Turn Force mode on only if there is a good chance that the metadata - // has tagged frames as progressive when they are not progressive. Do not turn on - // otherwise; processing frames that are already progressive into progressive will - // probably result in lower quality video. + // - When set to NORMAL (default), the deinterlacer does not convert frames that + // are tagged in metadata as progressive. It will only convert those that are + // tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer + // converts every frame to progressive - even those that are already tagged as + // progressive. Turn Force mode on only if there is a good chance that the metadata + // has tagged frames as progressive when they are not progressive. Do not turn on + // otherwise; processing frames that are already progressive into progressive will + // probably result in lower quality video. Control DeinterlacerControl // Use Deinterlacer (DeinterlaceMode) to choose how the service will do @@ -2277,8 +2271,8 @@ type DestinationSettings struct { // Create Dolby Vision Profile 5 or Profile 8.1 compatible video output. type DolbyVision struct { - // Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the - // MaxCLL and MaxFALL values in your input with new values. + // Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override + // the MaxCLL and MaxFALL values in your input with new values. L6Metadata *DolbyVisionLevel6Metadata // Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL @@ -2306,8 +2300,8 @@ type DolbyVision struct { noSmithyDocumentSerde } -// Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the -// MaxCLL and MaxFALL values in your input with new values. +// Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override +// the MaxCLL and MaxFALL values in your input with new values. type DolbyVisionLevel6Metadata struct { // Maximum Content Light Level. Static HDR metadata that corresponds to the @@ -2370,8 +2364,8 @@ type DvbSdtSettings struct { noSmithyDocumentSerde } -// Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output -// as your video. For more information, see +// Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same +// output as your video. For more information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. // When you work directly in your JSON job specification, include this object and // any required children when you set destinationType to DVB_SUB. @@ -2443,9 +2437,9 @@ type DvbSubDestinationSettings struct { // and DVB-Sub font settings must match. DdsYCoordinate int32 - // Specify the font that you want the service to use for your burn in captions when - // your input captions specify a font that MediaConvert doesn't support. When you - // set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, + // Specify the font that you want the service to use for your burn in captions + // when your input captions specify a font that MediaConvert doesn't support. When + // you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, // MediaConvert uses a supported font that most closely matches the font that your // input captions specify. When there are multiple unsupported fonts in your input // captions, MediaConvert matches each font with the supported font that matches @@ -2463,8 +2457,8 @@ type DvbSubDestinationSettings struct { // Within your job settings, all of your DVB-Sub settings must be identical. FontOpacity int32 - // Specify the Font resolution (FontResolution) in DPI (dots per inch). Within your - // job settings, all of your DVB-Sub settings must be identical. + // Specify the Font resolution (FontResolution) in DPI (dots per inch). Within + // your job settings, all of your DVB-Sub settings must be identical. FontResolution int32 // Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave @@ -2518,9 +2512,9 @@ type DvbSubDestinationSettings struct { // settings must be identical. ShadowOpacity int32 - // Specify the horizontal offset of the shadow, relative to the captions in pixels. - // A value of -2 would result in a shadow offset 2 pixels to the left. Within your - // job settings, all of your DVB-Sub settings must be identical. + // Specify the horizontal offset of the shadow, relative to the captions in + // pixels. A value of -2 would result in a shadow offset 2 pixels to the left. + // Within your job settings, all of your DVB-Sub settings must be identical. ShadowXOffset int32 // Specify the vertical offset of the shadow relative to the captions in pixels. A @@ -2554,9 +2548,9 @@ type DvbSubDestinationSettings struct { // be identical. TeletextSpacing DvbSubtitleTeletextSpacing - // Specify the width, in pixels, of this set of DVB-Sub captions. The default value - // is 720 pixels. Related setting: When you use this setting, you must set DDS - // handling (ddsHandling) to a value other than None (NONE). All burn-in and + // Specify the width, in pixels, of this set of DVB-Sub captions. The default + // value is 720 pixels. Related setting: When you use this setting, you must set + // DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and // DVB-Sub font settings must match. Width int32 @@ -2636,11 +2630,11 @@ type Eac3AtmosSettings struct { // MediaConvert uses default values for those settings. DownmixControl Eac3AtmosDownmixControl - // Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when - // encoding the metadata in the Dolby stream for the line operating mode. Default - // value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have - // MediaConvert use the value you specify here, keep the default value, Custom - // (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). + // Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses + // when encoding the metadata in the Dolby stream for the line operating mode. + // Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: + // To have MediaConvert use the value you specify here, keep the default value, + // Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). // Otherwise, MediaConvert ignores Dynamic range compression line // (DynamicRangeCompressionLine). For information about the Dolby DRC operating // modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata @@ -2648,11 +2642,11 @@ type Eac3AtmosSettings struct { // https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. DynamicRangeCompressionLine Eac3AtmosDynamicRangeCompressionLine - // Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when - // encoding the metadata in the Dolby stream for the RF operating mode. Default - // value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have - // MediaConvert use the value you specify here, keep the default value, Custom - // (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). + // Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses + // when encoding the metadata in the Dolby stream for the RF operating mode. + // Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: + // To have MediaConvert use the value you specify here, keep the default value, + // Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). // Otherwise, MediaConvert ignores Dynamic range compression RF // (DynamicRangeCompressionRf). For information about the Dolby DRC operating modes // and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide @@ -2722,9 +2716,9 @@ type Eac3AtmosSettings struct { // This value is always 48000. It represents the sample rate in Hz. SampleRate int32 - // Specify the percentage of audio content, from 0% to 100%, that must be speech in - // order for the encoder to use the measured speech loudness as the overall program - // loudness. Default value: 15% + // Specify the percentage of audio content, from 0% to 100%, that must be speech + // in order for the encoder to use the measured speech loudness as the overall + // program loudness. Default value: 15% SpeechThreshold int32 // Choose how the service does stereo downmixing. Default value: Not indicated @@ -2951,8 +2945,8 @@ type EsamManifestConfirmConditionNotification struct { noSmithyDocumentSerde } -// Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, -// you can ignore these settings. +// Settings for Event Signaling And Messaging (ESAM). If you don't do ad +// insertion, you can ignore these settings. type EsamSettings struct { // Specifies an ESAM ManifestConfirmConditionNotification XML as per @@ -2977,29 +2971,29 @@ type EsamSettings struct { // ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025. type EsamSignalProcessingNotification struct { - // Provide your ESAM SignalProcessingNotification XML document inside your JSON job - // settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder - // will use the signal processing instructions in the message that you supply. - // Provide your ESAM SignalProcessingNotification XML document inside your JSON job - // settings. For your MPEG2-TS file outputs, if you want the service to place - // SCTE-35 markers at the insertion points you specify in the XML document, you - // must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an - // ESAM XML document or enable SCTE-35 passthrough. You can't do both. + // Provide your ESAM SignalProcessingNotification XML document inside your JSON + // job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The + // transcoder will use the signal processing instructions in the message that you + // supply. Provide your ESAM SignalProcessingNotification XML document inside your + // JSON job settings. For your MPEG2-TS file outputs, if you want the service to + // place SCTE-35 markers at the insertion points you specify in the XML document, + // you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify + // an ESAM XML document or enable SCTE-35 passthrough. You can't do both. SccXml *string noSmithyDocumentSerde } -// If your source content has EIA-608 Line 21 Data Services, enable this feature to -// specify what MediaConvert does with the Extended Data Services (XDS) packets. +// If your source content has EIA-608 Line 21 Data Services, enable this feature +// to specify what MediaConvert does with the Extended Data Services (XDS) packets. // You can choose to pass through XDS packets, or remove them from the output. For // more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h // Content Advisory. type ExtendedDataServices struct { - // The action to take on copy and redistribution control XDS packets. If you select - // PASSTHROUGH, packets will not be changed. If you select STRIP, any packets will - // be removed in output captions. + // The action to take on copy and redistribution control XDS packets. If you + // select PASSTHROUGH, packets will not be changed. If you select STRIP, any + // packets will be removed in output captions. CopyProtectionAction CopyProtectionAction // The action to take on content advisory XDS packets. If you select PASSTHROUGH, @@ -3068,8 +3062,8 @@ type FileSourceSettings struct { // 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', 'webvtt', and 'vtt'. SourceFile *string - // Optional. Use this setting when you need to adjust the sync between your sidecar - // captions and your video. For more information, see + // Optional. Use this setting when you need to adjust the sync between your + // sidecar captions and your video. For more information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. // Enter a positive or negative number to modify the times in the captions file. // For example, type 15 to add 15 seconds to all the times in the captions file. @@ -3142,14 +3136,15 @@ type FrameCaptureSettings struct { noSmithyDocumentSerde } -// Settings for quality-defined variable bitrate encoding with the H.264 codec. Use -// these settings only when you set QVBR for Rate control mode (RateControlMode). +// Settings for quality-defined variable bitrate encoding with the H.264 codec. +// Use these settings only when you set QVBR for Rate control mode +// (RateControlMode). type H264QvbrSettings struct { - // Use this setting only when Rate control mode is QVBR and Quality tuning level is - // Multi-pass HQ. For Max average bitrate values suited to the complexity of your - // input video, the service limits the average bitrate of the video part of this - // output to the value that you choose. That is, the total size of the video + // Use this setting only when Rate control mode is QVBR and Quality tuning level + // is Multi-pass HQ. For Max average bitrate values suited to the complexity of + // your input video, the service limits the average bitrate of the video part of + // this output to the value that you choose. That is, the total size of the video // element is less than or equal to the value you set multiplied by the number of // seconds of encoded output. MaxAverageBitrate int32 @@ -3205,8 +3200,8 @@ type H264Settings struct { // reducer preprocessor. BandwidthReductionFilter *BandwidthReductionFilter - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest + // Specify the average bitrate in bits per second. Required for VBR and CBR. For + // MS Smooth outputs, bitrates must be unique when rounded down to the nearest // multiple of 1000. Bitrate int32 @@ -3305,14 +3300,15 @@ type H264Settings struct { // this value to 0. GopClosedCadence int32 - // Use this setting only when you set GOP mode control (GopSizeUnits) to Specified, - // frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP length using a - // whole number of frames or a decimal value of seconds. MediaConvert will - // interpret this value as frames or seconds depending on the value you choose for - // GOP mode control (GopSizeUnits). If you want to allow MediaConvert to - // automatically determine GOP size, leave GOP size blank and set GOP mode control - // to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP - // size blank and set GOP mode control to Auto in each output in your output group. + // Use this setting only when you set GOP mode control (GopSizeUnits) to + // Specified, frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP + // length using a whole number of frames or a decimal value of seconds. + // MediaConvert will interpret this value as frames or seconds depending on the + // value you choose for GOP mode control (GopSizeUnits). If you want to allow + // MediaConvert to automatically determine GOP size, leave GOP size blank and set + // GOP mode control to Auto (AUTO). If your output group specifies HLS, DASH, or + // CMAF, leave GOP size blank and set GOP mode control to Auto in each output in + // your output group. GopSize float64 // Specify how the transcoder determines GOP size for this output. We recommend @@ -3376,13 +3372,13 @@ type H264Settings struct { // change are smaller than the usual cadence GOPs. MinIInterval int32 - // This setting to determines the number of B-frames that MediaConvert puts between - // reference frames in this output. We recommend that you use automatic behavior to - // allow the transcoder to choose the best value based on characteristics of your - // input video. In the console, choose AUTO to select this automatic behavior. When - // you manually edit your JSON job specification, leave this setting out to choose - // automatic behavior. When you want to specify this number explicitly, choose a - // whole number from 0 through 7. + // This setting to determines the number of B-frames that MediaConvert puts + // between reference frames in this output. We recommend that you use automatic + // behavior to allow the transcoder to choose the best value based on + // characteristics of your input video. In the console, choose AUTO to select this + // automatic behavior. When you manually edit your JSON job specification, leave + // this setting out to choose automatic behavior. When you want to specify this + // number explicitly, choose a whole number from 0 through 7. NumberBFramesBetweenReferenceFrames int32 // Number of reference frames to use. The encoder may use more than requested if @@ -3419,8 +3415,9 @@ type H264Settings struct { // faster, lower quality, single-pass encoding. QualityTuningLevel H264QualityTuningLevel - // Settings for quality-defined variable bitrate encoding with the H.265 codec. Use - // these settings only when you set QVBR for Rate control mode (RateControlMode). + // Settings for quality-defined variable bitrate encoding with the H.265 codec. + // Use these settings only when you set QVBR for Rate control mode + // (RateControlMode). QvbrSettings *H264QvbrSettings // Use this setting to specify whether this output has a variable bitrate (VBR), @@ -3466,10 +3463,10 @@ type H264Settings struct { // (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. SlowPal H264SlowPal - // Ignore this setting unless you need to comply with a specification that requires - // a specific value. If you don't have a specification requirement, we recommend - // that you adjust the softness of your output by using a lower value for the - // setting Sharpness (sharpness) or by enabling a noise reducer filter + // Ignore this setting unless you need to comply with a specification that + // requires a specific value. If you don't have a specification requirement, we + // recommend that you adjust the softness of your output by using a lower value for + // the setting Sharpness (sharpness) or by enabling a noise reducer filter // (noiseReducerFilter). The Softness (softness) setting specifies the quantization // matrices that the encoder uses. Keep the default value, 0, for flat // quantization. Choose the value 1 or 16 to use the default JVT softening @@ -3546,14 +3543,15 @@ type H264Settings struct { noSmithyDocumentSerde } -// Settings for quality-defined variable bitrate encoding with the H.265 codec. Use -// these settings only when you set QVBR for Rate control mode (RateControlMode). +// Settings for quality-defined variable bitrate encoding with the H.265 codec. +// Use these settings only when you set QVBR for Rate control mode +// (RateControlMode). type H265QvbrSettings struct { - // Use this setting only when Rate control mode is QVBR and Quality tuning level is - // Multi-pass HQ. For Max average bitrate values suited to the complexity of your - // input video, the service limits the average bitrate of the video part of this - // output to the value that you choose. That is, the total size of the video + // Use this setting only when Rate control mode is QVBR and Quality tuning level + // is Multi-pass HQ. For Max average bitrate values suited to the complexity of + // your input video, the service limits the average bitrate of the video part of + // this output to the value that you choose. That is, the total size of the video // element is less than or equal to the value you set multiplied by the number of // seconds of encoded output. MaxAverageBitrate int32 @@ -3586,8 +3584,8 @@ type H265QvbrSettings struct { // Settings for H265 codec type H265Settings struct { - // When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), or - // leave blank, MediaConvert automatically applies quantization to improve the + // When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), + // or leave blank, MediaConvert automatically applies quantization to improve the // video quality of your output. Set Adaptive Quantization to Low (LOW), Medium // (MEDIUM), High (HIGH), Higher (HIGHER), or Max (MAX) to manually control the // strength of the quantization filter. When you do, you can specify a value for @@ -3602,8 +3600,8 @@ type H265Settings struct { // Gamma (HLG) Electro-Optical Transfer Function (EOTF). AlternateTransferFunctionSei H265AlternateTransferFunctionSei - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest + // Specify the average bitrate in bits per second. Required for VBR and CBR. For + // MS Smooth outputs, bitrates must be unique when rounded down to the nearest // multiple of 1000. Bitrate int32 @@ -3686,14 +3684,15 @@ type H265Settings struct { // this value to 0. GopClosedCadence int32 - // Use this setting only when you set GOP mode control (GopSizeUnits) to Specified, - // frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP length using a - // whole number of frames or a decimal value of seconds. MediaConvert will - // interpret this value as frames or seconds depending on the value you choose for - // GOP mode control (GopSizeUnits). If you want to allow MediaConvert to - // automatically determine GOP size, leave GOP size blank and set GOP mode control - // to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP - // size blank and set GOP mode control to Auto in each output in your output group. + // Use this setting only when you set GOP mode control (GopSizeUnits) to + // Specified, frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP + // length using a whole number of frames or a decimal value of seconds. + // MediaConvert will interpret this value as frames or seconds depending on the + // value you choose for GOP mode control (GopSizeUnits). If you want to allow + // MediaConvert to automatically determine GOP size, leave GOP size blank and set + // GOP mode control to Auto (AUTO). If your output group specifies HLS, DASH, or + // CMAF, leave GOP size blank and set GOP mode control to Auto in each output in + // your output group. GopSize float64 // Specify how the transcoder determines GOP size for this output. We recommend @@ -3796,8 +3795,9 @@ type H265Settings struct { // faster, lower quality, single-pass encoding. QualityTuningLevel H265QualityTuningLevel - // Settings for quality-defined variable bitrate encoding with the H.265 codec. Use - // these settings only when you set QVBR for Rate control mode (RateControlMode). + // Settings for quality-defined variable bitrate encoding with the H.265 codec. + // Use these settings only when you set QVBR for Rate control mode + // (RateControlMode). QvbrSettings *H265QvbrSettings // Use this setting to specify whether this output has a variable bitrate (VBR), @@ -3986,9 +3986,9 @@ type Hdr10Metadata struct { // Setting for HDR10+ metadata insertion type Hdr10Plus struct { - // Specify the HDR10+ mastering display normalized peak luminance, in nits. This is - // the normalized actual peak luminance of the mastering display, as defined by ST - // 2094-40. + // Specify the HDR10+ mastering display normalized peak luminance, in nits. This + // is the normalized actual peak luminance of the mastering display, as defined by + // ST 2094-40. MasteringMonitorNits int32 // Specify the HDR10+ target display nominal peak luminance, in nits. This is the @@ -4026,8 +4026,8 @@ type HlsCaptionLanguageMapping struct { // Caption channel. CaptionChannel int32 - // Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 - // three-letter language code + // Specify the language for this captions channel, using the ISO 639-2 or ISO + // 639-3 three-letter language code CustomLanguageCode *string // Specify the language, using the ISO 639-2 three-letter code listed at @@ -4389,15 +4389,15 @@ type HopDestination struct { // specify, the relative priority will remain the same as in the previous queue. Priority int32 - // Optional unless the job is submitted on the default queue. When you set up a job - // to use queue hopping, you can specify a destination queue. This queue cannot be - // the original queue to which the job is submitted. If the original queue isn't + // Optional unless the job is submitted on the default queue. When you set up a + // job to use queue hopping, you can specify a destination queue. This queue cannot + // be the original queue to which the job is submitted. If the original queue isn't // the default queue and you don't specify the destination queue, the job will move // to the default queue. Queue *string - // Required for setting up a job to use queue hopping. Minimum wait time in minutes - // until the job can hop to the destination queue. Valid range is 1 to 1440 + // Required for setting up a job to use queue hopping. Minimum wait time in + // minutes until the job can hop to the destination queue. Valid range is 1 to 1440 // minutes, inclusive. WaitMinutes int32 @@ -4487,8 +4487,8 @@ type Input struct { // selectors per input. AudioSelectors map[string]AudioSelector - // Use captions selectors to specify the captions data from your input that you use - // in your outputs. You can use up to 20 captions selectors per input. + // Use captions selectors to specify the captions data from your input that you + // use in your outputs. You can use up to 20 captions selectors per input. CaptionSelectors map[string]CaptionSelector // Use Cropping selection (crop) to specify the video area that the service will @@ -4522,8 +4522,8 @@ type Input struct { // https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. DolbyVisionMetadataXml *string - // Specify the source file for your transcoding job. You can use multiple inputs in - // a single job. The service concatenates these inputs, in the order that you + // Specify the source file for your transcoding job. You can use multiple inputs + // in a single job. The service concatenates these inputs, in the order that you // specify them in the job, to create the outputs. If your input format is IMF, // specify your input by providing the path to your CPL. For example, // "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use @@ -4531,9 +4531,9 @@ type Input struct { // contain assets referenced by the CPL. FileInput *string - // Specify how the transcoding service applies the denoise and deblock filters. You - // must also enable the filters separately, with Denoise (InputDenoiseFilter) and - // Deblock (InputDeblockFilter). * Auto - The transcoding service determines + // Specify how the transcoding service applies the denoise and deblock filters. + // You must also enable the filters separately, with Denoise (InputDenoiseFilter) + // and Deblock (InputDeblockFilter). * Auto - The transcoding service determines // whether to apply filtering, depending on input type and quality. * Disable - The // input is not filtered. This is true even if you use the API to enable them in // (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered @@ -4587,12 +4587,12 @@ type Input struct { // video. * Use PSI - Scan only PSI data. PsiControl InputPsiControl - // Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if - // the CPL that you're using for your input is in an incomplete IMP. Specify either - // the supplemental IMP directories with a trailing slash or the ASSETMAP.xml - // files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You - // don't need to specify the IMP that contains your input CPL, because the service - // automatically detects it. + // Provide a list of any necessary supplemental IMPs. You need supplemental IMPs + // if the CPL that you're using for your input is in an incomplete IMP. Specify + // either the supplemental IMP directories with a trailing slash or the + // ASSETMAP.xml files. For example ["s3://bucket/ov/", + // "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the IMP that contains + // your input CPL, because the service automatically detects it. SupplementalImps []string // Use this Timecode source setting, located under the input settings @@ -4669,11 +4669,11 @@ type InputDecryptionSettings struct { // Specify the encryption mode that you used to encrypt your input files. DecryptionMode DecryptionMode - // Warning! Don't provide your encryption key in plaintext. Your job settings could - // be intercepted, making your encrypted content vulnerable. Specify the encrypted - // version of the data key that you used to encrypt your content. The data key must - // be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or - // 256 bits. + // Warning! Don't provide your encryption key in plaintext. Your job settings + // could be intercepted, making your encrypted content vulnerable. Specify the + // encrypted version of the data key that you used to encrypt your content. The + // data key must be encrypted by AWS Key Management Service (KMS). The key can be + // 128, 192, or 256 bits. EncryptedDecryptionKey *string // Specify the initialization vector that you used when you encrypted your content @@ -4705,8 +4705,8 @@ type InputTemplate struct { // selectors per input. AudioSelectors map[string]AudioSelector - // Use captions selectors to specify the captions data from your input that you use - // in your outputs. You can use up to 20 captions selectors per input. + // Use captions selectors to specify the captions data from your input that you + // use in your outputs. You can use up to 20 captions selectors per input. CaptionSelectors map[string]CaptionSelector // Use Cropping selection (crop) to specify the video area that the service will @@ -4734,9 +4734,9 @@ type InputTemplate struct { // https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. DolbyVisionMetadataXml *string - // Specify how the transcoding service applies the denoise and deblock filters. You - // must also enable the filters separately, with Denoise (InputDenoiseFilter) and - // Deblock (InputDeblockFilter). * Auto - The transcoding service determines + // Specify how the transcoding service applies the denoise and deblock filters. + // You must also enable the filters separately, with Denoise (InputDenoiseFilter) + // and Deblock (InputDeblockFilter). * Auto - The transcoding service determines // whether to apply filtering, depending on input type and quality. * Disable - The // input is not filtered. This is true even if you use the API to enable them in // (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered @@ -4864,8 +4864,8 @@ type InsertableImage struct { // overlay on the video. Use a PNG or TGA file. ImageInserterInput *string - // Specify the distance, in pixels, between the inserted image and the left edge of - // the video frame. Required for any image overlay that you specify. + // Specify the distance, in pixels, between the inserted image and the left edge + // of the video frame. Required for any image overlay that you specify. ImageX int32 // Specify the distance, in pixels, between the overlaid image and the top edge of @@ -4885,9 +4885,10 @@ type InsertableImage struct { // into account your timecode source settings. StartTime *string - // Specify the width of the inserted image in pixels. If you specify a value that's - // larger than the video resolution width, the service will crop your overlaid - // image to fit. To use the native width of the image, keep this setting blank. + // Specify the width of the inserted image in pixels. If you specify a value + // that's larger than the video resolution width, the service will crop your + // overlaid image to fit. To use the native width of the image, keep this setting + // blank. Width int32 noSmithyDocumentSerde @@ -4967,8 +4968,8 @@ type Job struct { // template. JobTemplate *string - // Provides messages from the service about jobs that you have already successfully - // submitted. + // Provides messages from the service about jobs that you have already + // successfully submitted. Messages *JobMessages // List of output group details @@ -4986,8 +4987,8 @@ type Job struct { // The job's queue hopping history. QueueTransitions []QueueTransition - // The number of times that the service automatically attempted to process your job - // after encountering an error. + // The number of times that the service automatically attempted to process your + // job after encountering an error. RetryCount int32 // Enable this setting when you run a test job to estimate how many reserved @@ -5005,8 +5006,8 @@ type Job struct { // to the time it completes the transcode or encounters an error. StatusUpdateInterval StatusUpdateInterval - // Information about when jobs are submitted, started, and finished is specified in - // Unix epoch format in seconds. + // Information about when jobs are submitted, started, and finished is specified + // in Unix epoch format in seconds. Timing *Timing // User-defined metadata that you want to associate with an MediaConvert job. You @@ -5016,16 +5017,16 @@ type Job struct { noSmithyDocumentSerde } -// Provides messages from the service about jobs that you have already successfully -// submitted. +// Provides messages from the service about jobs that you have already +// successfully submitted. type JobMessages struct { // List of messages that are informational only and don't indicate a problem with // your job. Info []string - // List of messages that warn about conditions that might cause your job not to run - // or to fail. + // List of messages that warn about conditions that might cause your job not to + // run or to fail. Warning []string noSmithyDocumentSerde @@ -5034,20 +5035,20 @@ type JobMessages struct { // JobSettings contains all the transcode settings for a job. type JobSettings struct { - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. + // When specified, this offset (in milliseconds) is added to the input Ad Avail + // PTS time. AdAvailOffset int32 // Settings for ad avail blanking. Video can be blanked or overlaid with an image, // and audio muted during SCTE-35 triggered ad avails. AvailBlanking *AvailBlanking - // Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, - // you can ignore these settings. + // Settings for Event Signaling And Messaging (ESAM). If you don't do ad + // insertion, you can ignore these settings. Esam *EsamSettings - // If your source content has EIA-608 Line 21 Data Services, enable this feature to - // specify what MediaConvert does with the Extended Data Services (XDS) packets. + // If your source content has EIA-608 Line 21 Data Services, enable this feature + // to specify what MediaConvert does with the Extended Data Services (XDS) packets. // You can choose to pass through XDS packets, or remove them from the output. For // more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h // Content Advisory. @@ -5072,8 +5073,8 @@ type JobSettings struct { // https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. MotionImageInserter *MotionImageInserter - // Settings for your Nielsen configuration. If you don't do Nielsen measurement and - // analytics, ignore these settings. When you enable Nielsen configuration + // Settings for your Nielsen configuration. If you don't do Nielsen measurement + // and analytics, ignore these settings. When you enable Nielsen configuration // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs // in the job. To enable Nielsen configuration programmatically, include an // instance of nielsenConfiguration in your JSON job specification. Even if you @@ -5090,9 +5091,9 @@ type JobSettings struct { // Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0] NielsenNonLinearWatermark *NielsenNonLinearWatermarkSettings - // (OutputGroups) contains one group of settings for each set of outputs that share - // a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, - // and no container) are grouped in a single output group as well. Required in + // (OutputGroups) contains one group of settings for each set of outputs that + // share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, + // MXF, and no container) are grouped in a single output group as well. Required in // (OutputGroups) is a group of settings that apply to the whole group. This // required object depends on the value you set for (Type) under // (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as @@ -5155,8 +5156,8 @@ type JobTemplate struct { // Relative priority on the job. Priority int32 - // Optional. The queue that jobs created from this template are assigned to. If you - // don't specify this, jobs will go to the default queue. + // Optional. The queue that jobs created from this template are assigned to. If + // you don't specify this, jobs will go to the default queue. Queue *string // Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch @@ -5176,20 +5177,20 @@ type JobTemplate struct { // that will be applied to jobs created from it. type JobTemplateSettings struct { - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. + // When specified, this offset (in milliseconds) is added to the input Ad Avail + // PTS time. AdAvailOffset int32 // Settings for ad avail blanking. Video can be blanked or overlaid with an image, // and audio muted during SCTE-35 triggered ad avails. AvailBlanking *AvailBlanking - // Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, - // you can ignore these settings. + // Settings for Event Signaling And Messaging (ESAM). If you don't do ad + // insertion, you can ignore these settings. Esam *EsamSettings - // If your source content has EIA-608 Line 21 Data Services, enable this feature to - // specify what MediaConvert does with the Extended Data Services (XDS) packets. + // If your source content has EIA-608 Line 21 Data Services, enable this feature + // to specify what MediaConvert does with the Extended Data Services (XDS) packets. // You can choose to pass through XDS packets, or remove them from the output. For // more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h // Content Advisory. @@ -5214,8 +5215,8 @@ type JobTemplateSettings struct { // https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. MotionImageInserter *MotionImageInserter - // Settings for your Nielsen configuration. If you don't do Nielsen measurement and - // analytics, ignore these settings. When you enable Nielsen configuration + // Settings for your Nielsen configuration. If you don't do Nielsen measurement + // and analytics, ignore these settings. When you enable Nielsen configuration // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs // in the job. To enable Nielsen configuration programmatically, include an // instance of nielsenConfiguration in your JSON job specification. Even if you @@ -5232,9 +5233,9 @@ type JobTemplateSettings struct { // Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0] NielsenNonLinearWatermark *NielsenNonLinearWatermarkSettings - // (OutputGroups) contains one group of settings for each set of outputs that share - // a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, - // and no container) are grouped in a single output group as well. Required in + // (OutputGroups) contains one group of settings for each set of outputs that + // share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, + // MXF, and no container) are grouped in a single output group as well. Required in // (OutputGroups) is a group of settings that apply to the whole group. This // required object depends on the value you set for (Type) under // (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as @@ -5270,17 +5271,17 @@ type KantarWatermarkSettings struct { // Specify a unique identifier for Kantar to use for this piece of content. ContentReference *string - // Provide the name of the AWS Secrets Manager secret where your Kantar credentials - // are stored. Note that your MediaConvert service role must provide access to this - // secret. For more information, see + // Provide the name of the AWS Secrets Manager secret where your Kantar + // credentials are stored. Note that your MediaConvert service role must provide + // access to this secret. For more information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. // For instructions on creating a secret, see // https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, // in the AWS Secrets Manager User Guide. CredentialsSecretName *string - // Optional. Specify an offset, in whole seconds, from the start of your output and - // the beginning of the watermarking. When you don't specify an offset, Kantar + // Optional. Specify an offset, in whole seconds, from the start of your output + // and the beginning of the watermarking. When you don't specify an offset, Kantar // defaults to zero. FileOffset float64 @@ -5291,10 +5292,10 @@ type KantarWatermarkSettings struct { // from Kantar. KantarServerUrl *string - // Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your - // Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't - // save these logs. Note that your MediaConvert service role must provide access to - // this location. For more information, see + // Optional. Specify the Amazon S3 bucket where you want MediaConvert to store + // your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert + // doesn't save these logs. Note that your MediaConvert service role must provide + // access to this location. For more information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html LogDestination *string @@ -5328,10 +5329,10 @@ type KantarWatermarkSettings struct { noSmithyDocumentSerde } -// Settings for SCTE-35 signals from ESAM. Include this in your job settings to put -// SCTE-35 markers in your HLS and transport stream outputs at the insertion points -// that you specify in an ESAM XML document. Provide the document in the setting -// SCC XML (sccXml). +// Settings for SCTE-35 signals from ESAM. Include this in your job settings to +// put SCTE-35 markers in your HLS and transport stream outputs at the insertion +// points that you specify in an ESAM XML document. Provide the document in the +// setting SCC XML (sccXml). type M2tsScte35Esam struct { // Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated @@ -5341,16 +5342,16 @@ type M2tsScte35Esam struct { noSmithyDocumentSerde } -// MPEG-2 TS container settings. These apply to outputs in a File output group when -// the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In -// these assets, data is organized by the program map table (PMT). Each transport -// stream program contains subsets of data, including audio, video, and metadata. -// Each of these subsets of data has a numerical label called a packet identifier -// (PID). Each transport stream program corresponds to one MediaConvert output. The -// PMT lists the types of data in a program along with their PID. Downstream -// systems and players use the program map table to look up the PID for each type -// of data it accesses and then uses the PIDs to locate specific data within the -// asset. +// MPEG-2 TS container settings. These apply to outputs in a File output group +// when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). +// In these assets, data is organized by the program map table (PMT). Each +// transport stream program contains subsets of data, including audio, video, and +// metadata. Each of these subsets of data has a numerical label called a packet +// identifier (PID). Each transport stream program corresponds to one MediaConvert +// output. The PMT lists the types of data in a program along with their PID. +// Downstream systems and players use the program map table to look up the PID for +// each type of data it accesses and then uses the PIDs to locate specific data +// within the asset. type M2tsSettings struct { // Selects between the DVB and ATSC buffer models for Dolby Digital audio. @@ -5390,9 +5391,9 @@ type M2tsSettings struct { // interruptions. BufferModel M2tsBufferModel - // If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with - // Presentation Timestamp (PTS) values greater than or equal to the first video - // packet PTS (MediaConvert drops captions and data packets with lesser PTS + // If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets + // with Presentation Timestamp (PTS) values greater than or equal to the first + // video packet PTS (MediaConvert drops captions and data packets with lesser PTS // values). Keep the default value (AUTO) to allow all PTS values. DataPTSControl M2tsDataPtsControl @@ -5439,9 +5440,9 @@ type M2tsSettings struct { // Controls whether to include the ES Rate field in the PES header. EsRateInPes M2tsEsRateInPes - // Keep the default value (DEFAULT) unless you know that your audio EBP markers are - // incorrectly appearing before your video EBP markers. To correct this problem, - // set this value to Force (FORCE). + // Keep the default value (DEFAULT) unless you know that your audio EBP markers + // are incorrectly appearing before your video EBP markers. To correct this + // problem, set this value to Force (FORCE). ForceTsVideoEbpOrder M2tsForceTsVideoEbpOrder // The length, in seconds, of each fragment. Only used with EBP markers. @@ -5457,12 +5458,13 @@ type M2tsSettings struct { // (PCRs) inserted into the transport stream. MaxPcrInterval int32 - // When set, enforces that Encoder Boundary Points do not come within the specified - // time interval of each other by looking ahead at input video. If another EBP is - // going to come in within the specified time interval, the current EBP is not - // emitted, and the segment is "stretched" to the next marker. The lookahead value - // does not add latency to the system. The Live Event must be configured elsewhere - // to create sufficient latency to make the lookahead accurate. + // When set, enforces that Encoder Boundary Points do not come within the + // specified time interval of each other by looking ahead at input video. If + // another EBP is going to come in within the specified time interval, the current + // EBP is not emitted, and the segment is "stretched" to the next marker. The + // lookahead value does not add latency to the system. The Live Event must be + // configured elsewhere to create sufficient latency to make the lookahead + // accurate. MinEbpInterval int32 // If INSERT, Nielsen inaudible tones for media tracking will be detected in the @@ -5528,9 +5530,9 @@ type M2tsSettings struct { // enable ESAM SCTE-35 (include the property scte35Esam). Scte35Source M2tsScte35Source - // Inserts segmentation markers at each segmentation_time period. rai_segstart sets - // the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI - // bit and adds the current timecode in the private data bytes. psi_segstart + // Inserts segmentation markers at each segmentation_time period. rai_segstart + // sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the + // RAI bit and adds the current timecode in the private data bytes. psi_segstart // inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary // Point information to the adaptation field as per OpenCable specification // OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the @@ -5557,8 +5559,8 @@ type M2tsSettings struct { // Packet Identifier (PID) of the ID3 metadata stream in the transport stream. TimedMetadataPid int32 - // Specify the ID for the transport stream itself in the program map table for this - // output. Transport stream IDs and program map tables are parts of MPEG-2 + // Specify the ID for the transport stream itself in the program map table for + // this output. Transport stream IDs and program map tables are parts of MPEG-2 // transport stream containers, used for organizing data. TransportStreamId int32 @@ -5596,9 +5598,9 @@ type M3u8Settings struct { // comma separation. AudioPids []int32 - // If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with - // Presentation Timestamp (PTS) values greater than or equal to the first video - // packet PTS (MediaConvert drops captions and data packets with lesser PTS + // If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets + // with Presentation Timestamp (PTS) values greater than or equal to the first + // video packet PTS (MediaConvert drops captions and data packets with lesser PTS // values). Keep the default value (AUTO) to allow all PTS values. DataPTSControl M3u8DataPtsControl @@ -5614,8 +5616,8 @@ type M3u8Settings struct { // transport stream. PatInterval int32 - // When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for - // every Packetized Elementary Stream (PES) header. This parameter is effective + // When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted + // for every Packetized Elementary Stream (PES) header. This parameter is effective // only when the PCR PID is the same as the video or audio elementary stream. PcrControl M3u8PcrControl @@ -5732,8 +5734,8 @@ type MotionImageInserter struct { // can be 100 images in the sequence. Input *string - // Choose the type of motion graphic asset that you are providing for your overlay. - // You can choose either a .mov file or a series of .png files. + // Choose the type of motion graphic asset that you are providing for your + // overlay. You can choose either a .mov file or a series of .png files. InsertionMode MotionImageInsertionMode // Use Offset to specify the placement of your motion graphic overlay on the video @@ -5813,8 +5815,8 @@ type MovSettings struct { // video codec is MPEG2. Mpeg2FourCCControl MovMpeg2FourCCControl - // Unless you need Omneon compatibility: Keep the default value, None. To make this - // output compatible with Omneon: Choose Omneon. When you do, MediaConvert + // Unless you need Omneon compatibility: Keep the default value, None. To make + // this output compatible with Omneon: Choose Omneon. When you do, MediaConvert // increases the length of the 'elst' edit list atom. Note that this might cause // file rejections when a recipient of the output file doesn't expect this extra // padding. @@ -5844,8 +5846,8 @@ type Mp2Settings struct { noSmithyDocumentSerde } -// Required when you set Codec, under AudioDescriptions>CodecSettings, to the value -// MP3. +// Required when you set Codec, under AudioDescriptions>CodecSettings, to the +// value MP3. type Mp3Settings struct { // Specify the average bitrate in bits per second. @@ -5863,8 +5865,9 @@ type Mp3Settings struct { // Sample rate in hz. SampleRate int32 - // Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the - // audio quality of this MP3 output from 0 (highest quality) to 9 (lowest quality). + // Required when you set Bitrate control mode (rateControlMode) to VBR. Specify + // the audio quality of this MP3 output from 0 (highest quality) to 9 (lowest + // quality). VbrQuality int32 noSmithyDocumentSerde @@ -5961,8 +5964,8 @@ type MpdSettings struct { // leave blank. KlvMetadata MpdKlvMetadata - // To add an InbandEventStream element in your output MPD manifest for each type of - // event message, set Manifest metadata signaling to Enabled. For ID3 event + // To add an InbandEventStream element in your output MPD manifest for each type + // of event message, set Manifest metadata signaling to Enabled. For ID3 event // messages, the InbandEventStream element schemeIdUri will be same value that you // specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the // InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To @@ -5996,9 +5999,9 @@ type MpdSettings struct { // 1, you must also set ID3 metadata (timedMetadata) to Passthrough. TimedMetadataBoxVersion MpdTimedMetadataBoxVersion - // Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed - // metadata in your output. For more information, see ISO/IEC 23009-1:2022 section - // 5.10.3.3.4 Semantics. Leave blank to use the default value: + // Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 + // timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 + // section 5.10.3.3.4 Semantics. Leave blank to use the default value: // https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID // URI, you must also set ID3 metadata (timedMetadata) to Passthrough. TimedMetadataSchemeIdUri *string @@ -6022,8 +6025,8 @@ type Mpeg2Settings struct { // (temporalAdaptiveQuantization). AdaptiveQuantization Mpeg2AdaptiveQuantization - // Specify the average bitrate in bits per second. Required for VBR and CBR. For MS - // Smooth outputs, bitrates must be unique when rounded down to the nearest + // Specify the average bitrate in bits per second. Required for VBR and CBR. For + // MS Smooth outputs, bitrates must be unique when rounded down to the nearest // multiple of 1000. Bitrate int32 @@ -6127,8 +6130,8 @@ type Mpeg2Settings struct { // options you choose. InterlaceMode Mpeg2InterlaceMode - // Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for - // intra-block DC coefficients. If you choose the value auto, the service will + // Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision + // for intra-block DC coefficients. If you choose the value auto, the service will // automatically select the precision based on the per-frame compression ratio. IntraDcPrecision Mpeg2IntraDcPrecision @@ -6217,10 +6220,10 @@ type Mpeg2Settings struct { // (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. SlowPal Mpeg2SlowPal - // Ignore this setting unless you need to comply with a specification that requires - // a specific value. If you don't have a specification requirement, we recommend - // that you adjust the softness of your output by using a lower value for the - // setting Sharpness (sharpness) or by enabling a noise reducer filter + // Ignore this setting unless you need to comply with a specification that + // requires a specific value. If you don't have a specification requirement, we + // recommend that you adjust the softness of your output by using a lower value for + // the setting Sharpness (sharpness) or by enabling a noise reducer filter // (noiseReducerFilter). The Softness (softness) setting specifies the quantization // matrices that the encoder uses. Keep the default value, 0, to use the AWS // Elemental default matrices. Choose a value from 17 to 128 to use planar @@ -6277,8 +6280,8 @@ type Mpeg2Settings struct { noSmithyDocumentSerde } -// Specify the details for each additional Microsoft Smooth Streaming manifest that -// you want the service to generate for this output group. Each manifest can +// Specify the details for each additional Microsoft Smooth Streaming manifest +// that you want the service to generate for this output group. Each manifest can // reference a different subset of outputs in the group. type MsSmoothAdditionalManifest struct { @@ -6297,8 +6300,8 @@ type MsSmoothAdditionalManifest struct { noSmithyDocumentSerde } -// If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the -// value SpekeKeyProvider. +// If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify +// the value SpekeKeyProvider. type MsSmoothEncryptionSettings struct { // If your output group type is HLS, DASH, or Microsoft Smooth, use these settings @@ -6317,11 +6320,11 @@ type MsSmoothEncryptionSettings struct { // MS_SMOOTH_GROUP_SETTINGS. type MsSmoothGroupSettings struct { - // By default, the service creates one .ism Microsoft Smooth Streaming manifest for - // each Microsoft Smooth Streaming output group in your job. This default manifest - // references every output in the output group. To create additional manifests that - // reference a subset of the outputs in the output group, specify a list of them - // here. + // By default, the service creates one .ism Microsoft Smooth Streaming manifest + // for each Microsoft Smooth Streaming output group in your job. This default + // manifest references every output in the output group. To create additional + // manifests that reference a subset of the outputs in the output group, specify a + // list of them here. AdditionalManifests []MsSmoothAdditionalManifest // COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a @@ -6339,19 +6342,19 @@ type MsSmoothGroupSettings struct { // destination DestinationSettings *DestinationSettings - // If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the - // value SpekeKeyProvider. + // If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify + // the value SpekeKeyProvider. Encryption *MsSmoothEncryptionSettings - // Specify how you want MediaConvert to determine the fragment length. Choose Exact - // (EXACT) to have the encoder use the exact length that you specify with the + // Specify how you want MediaConvert to determine the fragment length. Choose + // Exact (EXACT) to have the encoder use the exact length that you specify with the // setting Fragment length (FragmentLength). This might result in extra I-frames. // Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment // lengths to match the next GOP boundary. FragmentLength int32 - // Specify how you want MediaConvert to determine the fragment length. Choose Exact - // (EXACT) to have the encoder use the exact length that you specify with the + // Specify how you want MediaConvert to determine the fragment length. Choose + // Exact (EXACT) to have the encoder use the exact length that you specify with the // setting Fragment length (FragmentLength). This might result in extra I-frames. // Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment // lengths to match the next GOP boundary. @@ -6421,8 +6424,8 @@ type MxfXavcProfileSettings struct { // OTT Streaming workflows. type NexGuardFileMarkerSettings struct { - // Use the base64 license string that Nagra provides you. Enter it directly in your - // JSON job specification or in the console. Required when you include Nagra + // Use the base64 license string that Nagra provides you. Enter it directly in + // your JSON job specification or in the console. Required when you include Nagra // NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. License *string @@ -6453,8 +6456,8 @@ type NexGuardFileMarkerSettings struct { noSmithyDocumentSerde } -// Settings for your Nielsen configuration. If you don't do Nielsen measurement and -// analytics, ignore these settings. When you enable Nielsen configuration +// Settings for your Nielsen configuration. If you don't do Nielsen measurement +// and analytics, ignore these settings. When you enable Nielsen configuration // (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs // in the job. To enable Nielsen configuration programmatically, include an // instance of nielsenConfiguration in your JSON job specification. Even if you @@ -6535,8 +6538,8 @@ type NielsenNonLinearWatermarkSettings struct { // only clean content that doesn't already have non-linear Nielsen watermarks. SourceWatermarkStatus NielsenSourceWatermarkStatusType - // Specify the endpoint for the TIC server that you have deployed and configured in - // the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert + // Specify the endpoint for the TIC server that you have deployed and configured + // in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert // can't connect directly to a TIC server. Instead, you must use API Gateway to // provide a RESTful interface between MediaConvert and a TIC server that you // deploy in your AWS account. For more information on deploying a TIC server in @@ -6593,12 +6596,12 @@ type NoiseReducerFilterSettings struct { // Noise reducer filter settings for spatial filter. type NoiseReducerSpatialFilterSettings struct { - // Specify strength of post noise reduction sharpening filter, with 0 disabling the - // filter and 3 enabling it at maximum strength. + // Specify strength of post noise reduction sharpening filter, with 0 disabling + // the filter and 3 enabling it at maximum strength. PostFilterSharpenStrength int32 - // The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being - // the nominal value. + // The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 + // being the nominal value. Speed int32 // Relative strength of noise reducing filter. Higher values produce stronger @@ -6628,8 +6631,8 @@ type NoiseReducerTemporalFilterSettings struct { // Disabled (DISABLED) to not apply sharpening. PostTemporalSharpening NoiseFilterPostTemporalSharpening - // Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define - // the amount of sharpening the transcoder applies to your output. Set Post + // Use Post temporal sharpening strength (postTemporalSharpeningStrength) to + // define the amount of sharpening the transcoder applies to your output. Set Post // temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High (HIGH) to // indicate the amount of sharpening. PostTemporalSharpeningStrength NoiseFilterPostTemporalSharpeningStrength @@ -6649,8 +6652,8 @@ type NoiseReducerTemporalFilterSettings struct { noSmithyDocumentSerde } -// Required when you set Codec, under AudioDescriptions>CodecSettings, to the value -// OPUS. +// Required when you set Codec, under AudioDescriptions>CodecSettings, to the +// value OPUS. type OpusSettings struct { // Optional. Specify the average bitrate in bits per second. Valid values are @@ -6680,8 +6683,8 @@ type Output struct { // (AudioDescriptions) can contain multiple groups of encoding settings. AudioDescriptions []AudioDescription - // (CaptionDescriptions) contains groups of captions settings. For each output that - // has captions, include one instance of (CaptionDescriptions). + // (CaptionDescriptions) contains groups of captions settings. For each output + // that has captions, include one instance of (CaptionDescriptions). // (CaptionDescriptions) can contain multiple groups of captions settings. CaptionDescriptions []CaptionDescription @@ -6700,8 +6703,9 @@ type Output struct { // each output filename. You specify the base filename as part of your destination // URI. When you create multiple outputs in the same output group, Name modifier // (NameModifier) is required. Name modifier also accepts format identifiers. For - // DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one - // output, you must use them in the same way in all outputs of the output group. + // DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in + // one output, you must use them in the same way in all outputs of the output + // group. NameModifier *string // Specific settings for this type of output. @@ -6712,8 +6716,8 @@ type Output struct { // Container settings (ContainerSettings), but not both. Preset *string - // VideoDescription contains a group of video encoding settings. The specific video - // settings depend on the video codec that you choose for the property codec. + // VideoDescription contains a group of video encoding settings. The specific + // video settings depend on the video codec that you choose for the property codec. // Include one instance of VideoDescription per output. VideoDescription *VideoDescription @@ -6917,8 +6921,8 @@ type PresetSettings struct { // Container specific settings. ContainerSettings *ContainerSettings - // VideoDescription contains a group of video encoding settings. The specific video - // settings depend on the video codec that you choose for the property codec. + // VideoDescription contains a group of video encoding settings. The specific + // video settings depend on the video codec that you choose for the property codec. // Include one instance of VideoDescription per output. VideoDescription *VideoDescription @@ -7268,9 +7272,9 @@ type ResourceTags struct { noSmithyDocumentSerde } -// Optional. Have MediaConvert automatically apply Amazon S3 access control for the -// outputs in this output group. When you don't use this setting, S3 automatically -// applies the default access control list PRIVATE. +// Optional. Have MediaConvert automatically apply Amazon S3 access control for +// the outputs in this output group. When you don't use this setting, S3 +// automatically applies the default access control list PRIVATE. type S3DestinationAccessControl struct { // Choose an Amazon S3 canned ACL for MediaConvert to apply to this output. @@ -7282,9 +7286,9 @@ type S3DestinationAccessControl struct { // Settings associated with S3 destination type S3DestinationSettings struct { - // Optional. Have MediaConvert automatically apply Amazon S3 access control for the - // outputs in this output group. When you don't use this setting, S3 automatically - // applies the default access control list PRIVATE. + // Optional. Have MediaConvert automatically apply Amazon S3 access control for + // the outputs in this output group. When you don't use this setting, S3 + // automatically applies the default access control list PRIVATE. AccessControl *S3DestinationAccessControl // Settings for how your job outputs are encrypted as they are uploaded to Amazon @@ -7333,10 +7337,10 @@ type S3EncryptionSettings struct { noSmithyDocumentSerde } -// Settings related to SCC captions. SCC is a sidecar format that holds captions in -// a file that is separate from the video container. Set up sidecar captions in the -// same output group, but different output from your video. For more information, -// see +// Settings related to SCC captions. SCC is a sidecar format that holds captions +// in a file that is separate from the video container. Set up sidecar captions in +// the same output group, but different output from your video. For more +// information, see // https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. // When you work directly in your JSON job specification, include this object and // any required children when you set destinationType to SCC. @@ -7412,11 +7416,11 @@ type SpekeKeyProviderCmaf struct { noSmithyDocumentSerde } -// Settings related to SRT captions. SRT is a sidecar format that holds captions in -// a file that is separate from the video container. Set up sidecar captions in the -// same output group, but different output from your video. When you work directly -// in your JSON job specification, include this object and any required children -// when you set destinationType to SRT. +// Settings related to SRT captions. SRT is a sidecar format that holds captions +// in a file that is separate from the video container. Set up sidecar captions in +// the same output group, but different output from your video. When you work +// directly in your JSON job specification, include this object and any required +// children when you set destinationType to SRT. type SrtDestinationSettings struct { // Set Style passthrough (StylePassthrough) to ENABLED to use the available style, @@ -7438,8 +7442,8 @@ type StaticKeyProvider struct { // value of 'identity'. KeyFormat *string - // Relates to DRM implementation. Either a single positive integer version value or - // a slash delimited list of version values (1/2/3). + // Relates to DRM implementation. Either a single positive integer version value + // or a slash delimited list of version values (1/2/3). KeyFormatVersions *string // Relates to DRM implementation. Use a 32-character hexidecimal string to specify @@ -7460,10 +7464,10 @@ type StaticKeyProvider struct { // any required children when you set destinationType to TELETEXT. type TeletextDestinationSettings struct { - // Set pageNumber to the Teletext page number for the destination captions for this - // output. This value must be a three-digit hexadecimal string; strings ending in - // -FF are invalid. If you are passing through the entire set of Teletext data, do - // not use this field. + // Set pageNumber to the Teletext page number for the destination captions for + // this output. This value must be a three-digit hexadecimal string; strings ending + // in -FF are invalid. If you are passing through the entire set of Teletext data, + // do not use this field. PageNumber *string // Specify the page types for this Teletext page. If you don't specify a value @@ -7494,15 +7498,15 @@ type TimecodeBurnin struct { // values are 10, 16, 32, 48. FontSize int32 - // Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify - // the location the burned-in timecode on output video. + // Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to + // specify the location the burned-in timecode on output video. Position TimecodeBurninPosition - // Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For - // example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". Provide - // either the characters themselves or the ASCII code equivalents. The supported - // range of characters is 0x20 through 0x7e. This includes letters, numbers, and - // all special characters represented on a standard English keyboard. + // Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. + // For example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". + // Provide either the characters themselves or the ASCII code equivalents. The + // supported range of characters is 0x20 through 0x7e. This includes letters, + // numbers, and all special characters represented on a standard English keyboard. Prefix *string noSmithyDocumentSerde @@ -7525,8 +7529,8 @@ type TimecodeConfig struct { // first frame is the timecode value on the first input frame of the input. Anchor *string - // Use Source (TimecodeSource) to set how timecodes are handled within this job. To - // make sure that your video, audio, captions, and markers are synchronized and + // Use Source (TimecodeSource) to set how timecodes are handled within this job. + // To make sure that your video, audio, captions, and markers are synchronized and // that time-based features, such as image inserter, work correctly, choose the // Timecode source option that matches your assets. All timecodes are in a 24-hour // format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode @@ -7566,8 +7570,8 @@ type TimedMetadataInsertion struct { noSmithyDocumentSerde } -// Information about when jobs are submitted, started, and finished is specified in -// Unix epoch format in seconds. +// Information about when jobs are submitted, started, and finished is specified +// in Unix epoch format in seconds. type Timing struct { // The time, in Unix epoch format, that the transcoding job finished @@ -7608,8 +7612,8 @@ type TrackSourceSettings struct { // any required children when you set destinationType to TTML. type TtmlDestinationSettings struct { - // Pass through style and position information from a TTML-like input source (TTML, - // IMSC, SMPTE-TT) to the TTML output. + // Pass through style and position information from a TTML-like input source + // (TTML, IMSC, SMPTE-TT) to the TTML output. StylePassthrough TtmlStylePassthrough noSmithyDocumentSerde @@ -7694,8 +7698,8 @@ type Vc3Settings struct { // doing anything with the field polarity to create a smoother picture. Telecine Vc3Telecine - // Specify the VC3 class to choose the quality characteristics for this output. VC3 - // class, together with the settings Framerate (framerateNumerator and + // Specify the VC3 class to choose the quality characteristics for this output. + // VC3 class, together with the settings Framerate (framerateNumerator and // framerateDenominator) and Resolution (height and width), determine your output // bitrate. For example, say that your video resolution is 1920x1080 and your // framerate is 29.97. Then Class 145 (CLASS_145) gives you an output with a @@ -7845,8 +7849,8 @@ type VideoDescription struct { // that you specify for the setting Selection placement (position) in this output. ScalingBehavior ScalingBehavior - // Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This - // setting changes the width of the anti-alias filter kernel used for scaling. + // Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. + // This setting changes the width of the anti-alias filter kernel used for scaling. // Sharpness only applies if your output resolution is different from your input // resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for // most content. @@ -7959,18 +7963,11 @@ type VideoSelector struct { // an input color space, MediaConvert uses the following color space metadata, // which includes color primaries, transfer characteristics, and matrix // coefficients: - // - // * HDR 10: BT.2020, PQ, BT.2020 non-constant - // - // * HLG 2020: BT.2020, - // HLG, BT.2020 non-constant - // - // * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 - // - // * P3D65 - // (SDR): Display P3, sRGB, BT.709 - // - // * P3D65 (HDR): Display P3, PQ, BT.709 + // - HDR 10: BT.2020, PQ, BT.2020 non-constant + // - HLG 2020: BT.2020, HLG, BT.2020 non-constant + // - P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 + // - P3D65 (SDR): Display P3, sRGB, BT.709 + // - P3D65 (HDR): Display P3, PQ, BT.709 ColorSpace ColorSpace // There are two sources for color metadata, the input file and the job input @@ -7984,11 +7981,12 @@ type VideoSelector struct { // input settings. ColorSpaceUsage ColorSpaceUsage - // Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) - // when your AVCHD input contains timecode tag data in the Modified Digital Video - // Pack Metadata (MDPM). When you do, we recommend you also set Timecode source - // (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override - // blank, or set to None (NONE), when your input does not contain MDPM timecode. + // Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM + // (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified + // Digital Video Pack Metadata (MDPM). When you do, we recommend you also set + // Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded + // timecode override blank, or set to None (NONE), when your input does not contain + // MDPM timecode. EmbeddedTimecodeOverride EmbeddedTimecodeOverride // Use these settings to provide HDR 10 metadata that is missing or inaccurate in @@ -8049,8 +8047,8 @@ type VideoSelector struct { noSmithyDocumentSerde } -// Required when you set Codec, under AudioDescriptions>CodecSettings, to the value -// Vorbis. +// Required when you set Codec, under AudioDescriptions>CodecSettings, to the +// value Vorbis. type VorbisSettings struct { // Optional. Specify the number of channels in this output audio track. Choosing @@ -8269,8 +8267,8 @@ type Vp9Settings struct { // value WAV. type WavSettings struct { - // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality - // for this audio track. + // Specify Bit depth (BitDepth), in bits per sample, to choose the encoding + // quality for this audio track. BitDepth int32 // Specify the number of channels in this output audio track. Valid values are 1 @@ -8348,9 +8346,9 @@ type WebvttHlsSourceSettings struct { // XAVC_4K_INTRA_CBG. type Xavc4kIntraCbgProfileSettings struct { - // Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. Outputs - // of the same class have similar image quality over the operating points that are - // valid for that class. + // Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. + // Outputs of the same class have similar image quality over the operating points + // that are valid for that class. XavcClass Xavc4kIntraCbgProfileClass noSmithyDocumentSerde @@ -8361,9 +8359,9 @@ type Xavc4kIntraCbgProfileSettings struct { // XAVC_4K_INTRA_VBR. type Xavc4kIntraVbrProfileSettings struct { - // Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. Outputs - // of the same class have similar image quality over the operating points that are - // valid for that class. + // Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. + // Outputs of the same class have similar image quality over the operating points + // that are valid for that class. XavcClass Xavc4kIntraVbrProfileClass noSmithyDocumentSerde @@ -8398,15 +8396,15 @@ type Xavc4kProfileSettings struct { // Flicker adaptive quantization provides. FlickerAdaptiveQuantization XavcFlickerAdaptiveQuantization - // Specify whether the encoder uses B-frames as reference frames for other pictures - // in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as - // reference frames. Choose Don't allow (DISABLED) to prevent the encoder from - // using B-frames as reference frames. + // Specify whether the encoder uses B-frames as reference frames for other + // pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use + // B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the + // encoder from using B-frames as reference frames. GopBReference XavcGopBReference - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. + // Frequency of closed GOPs. In streaming applications, it is recommended that + // this be set to 1 so a decoder joining mid-stream will receive an IDR frame as + // quickly as possible. Setting this value to 0 will break output segmenting. GopClosedCadence int32 // Specify the size of the buffer that MediaConvert uses in the HRD buffer model @@ -8433,9 +8431,9 @@ type Xavc4kProfileSettings struct { // XAVC_HD_INTRA_CBG. type XavcHdIntraCbgProfileSettings struct { - // Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. Outputs - // of the same class have similar image quality over the operating points that are - // valid for that class. + // Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. + // Outputs of the same class have similar image quality over the operating points + // that are valid for that class. XavcClass XavcHdIntraCbgProfileClass noSmithyDocumentSerde @@ -8466,15 +8464,15 @@ type XavcHdProfileSettings struct { // Flicker adaptive quantization provides. FlickerAdaptiveQuantization XavcFlickerAdaptiveQuantization - // Specify whether the encoder uses B-frames as reference frames for other pictures - // in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as - // reference frames. Choose Don't allow (DISABLED) to prevent the encoder from - // using B-frames as reference frames. + // Specify whether the encoder uses B-frames as reference frames for other + // pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use + // B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the + // encoder from using B-frames as reference frames. GopBReference XavcGopBReference - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. + // Frequency of closed GOPs. In streaming applications, it is recommended that + // this be set to 1 so a decoder joining mid-stream will receive an IDR frame as + // quickly as possible. Setting this value to 0 will break output segmenting. GopClosedCadence int32 // Specify the size of the buffer that MediaConvert uses in the HRD buffer model @@ -8533,9 +8531,10 @@ type XavcSettings struct { // (temporalAdaptiveQuantization). AdaptiveQuantization XavcAdaptiveQuantization - // Optional. Choose a specific entropy encoding mode only when you want to override - // XAVC recommendations. If you choose the value auto, MediaConvert uses the mode - // that the XAVC file format specifies given this output's operating point. + // Optional. Choose a specific entropy encoding mode only when you want to + // override XAVC recommendations. If you choose the value auto, MediaConvert uses + // the mode that the XAVC file format specifies given this output's operating + // point. EntropyEncoding XavcEntropyEncoding // If you are using the console, use the Frame rate setting to specify the frame @@ -8592,16 +8591,16 @@ type XavcSettings struct { // (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. SlowPal XavcSlowPal - // Ignore this setting unless your downstream workflow requires that you specify it - // explicitly. Otherwise, we recommend that you adjust the softness of your output - // by using a lower value for the setting Sharpness (sharpness) or by enabling a - // noise reducer filter (noiseReducerFilter). The Softness (softness) setting - // specifies the quantization matrices that the encoder uses. Keep the default - // value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT - // softening quantization matricies from the H.264 specification. Choose a value - // from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 - // result in increasing reduction of high-frequency data. The value 128 results in - // the softest video. + // Ignore this setting unless your downstream workflow requires that you specify + // it explicitly. Otherwise, we recommend that you adjust the softness of your + // output by using a lower value for the setting Sharpness (sharpness) or by + // enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) + // setting specifies the quantization matrices that the encoder uses. Keep the + // default value, 0, for flat quantization. Choose the value 1 or 16 to use the + // default JVT softening quantization matricies from the H.264 specification. + // Choose a value from 17 to 128 to use planar interpolation. Increasing values + // from 17 to 128 result in increasing reduction of high-frequency data. The value + // 128 results in the softest video. Softness int32 // The best way to set up adaptive quantization is to keep the default value, Auto diff --git a/service/medialive/api_client.go b/service/medialive/api_client.go index e3622397f8c..d44745acf0e 100644 --- a/service/medialive/api_client.go +++ b/service/medialive/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/medialive/api_op_DeleteChannel.go b/service/medialive/api_op_DeleteChannel.go index 36b7e290c95..478a7c972d8 100644 --- a/service/medialive/api_op_DeleteChannel.go +++ b/service/medialive/api_op_DeleteChannel.go @@ -51,9 +51,9 @@ type DeleteChannelOutput struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []types.OutputDestination // The endpoints where outgoing connections initiate from diff --git a/service/medialive/api_op_DeleteReservation.go b/service/medialive/api_op_DeleteReservation.go index 63cbfec47e6..b8e289d3584 100644 --- a/service/medialive/api_op_DeleteReservation.go +++ b/service/medialive/api_op_DeleteReservation.go @@ -66,8 +66,8 @@ type DeleteReservationOutput struct { // User specified reservation name Name *string - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard + // VQ in US West (Oregon)' OfferingDescription *string // Unique offering ID, e.g. '87654321' diff --git a/service/medialive/api_op_DescribeChannel.go b/service/medialive/api_op_DescribeChannel.go index afefd44e459..9d056fea7c3 100644 --- a/service/medialive/api_op_DescribeChannel.go +++ b/service/medialive/api_op_DescribeChannel.go @@ -57,9 +57,9 @@ type DescribeChannelOutput struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []types.OutputDestination // The endpoints where outgoing connections initiate from @@ -194,9 +194,9 @@ type ChannelCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ChannelCreatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ChannelCreatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -395,9 +395,9 @@ type ChannelDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ChannelDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ChannelDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -579,9 +579,9 @@ type ChannelRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ChannelRunningWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ChannelRunningWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -763,9 +763,9 @@ type ChannelStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ChannelStoppedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ChannelStoppedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/medialive/api_op_DescribeInput.go b/service/medialive/api_op_DescribeInput.go index cf1063b1be9..d349c728b73 100644 --- a/service/medialive/api_op_DescribeInput.go +++ b/service/medialive/api_op_DescribeInput.go @@ -194,8 +194,8 @@ type InputAttachedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InputAttachedWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InputAttachedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -244,9 +244,10 @@ func (w *InputAttachedWaiter) Wait(ctx context.Context, params *DescribeInputInp return err } -// WaitForOutput calls the waiter function for InputAttached waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for InputAttached waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *InputAttachedWaiter) WaitForOutput(ctx context.Context, params *DescribeInputInput, maxWaitDur time.Duration, optFns ...func(*InputAttachedWaiterOptions)) (*DescribeInputOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -377,9 +378,9 @@ type InputDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InputDeletedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InputDeletedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -560,8 +561,8 @@ type InputDetachedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InputDetachedWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InputDetachedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -610,9 +611,10 @@ func (w *InputDetachedWaiter) Wait(ctx context.Context, params *DescribeInputInp return err } -// WaitForOutput calls the waiter function for InputDetached waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for InputDetached waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *InputDetachedWaiter) WaitForOutput(ctx context.Context, params *DescribeInputInput, maxWaitDur time.Duration, optFns ...func(*InputDetachedWaiterOptions)) (*DescribeInputOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/medialive/api_op_DescribeInputDeviceThumbnail.go b/service/medialive/api_op_DescribeInputDeviceThumbnail.go index f1cfae74870..b03362d79f0 100644 --- a/service/medialive/api_op_DescribeInputDeviceThumbnail.go +++ b/service/medialive/api_op_DescribeInputDeviceThumbnail.go @@ -48,8 +48,8 @@ type DescribeInputDeviceThumbnailInput struct { // Placeholder documentation for DescribeInputDeviceThumbnailResponse type DescribeInputDeviceThumbnailOutput struct { - // The binary data for the thumbnail that the Link device has most recently sent to - // MediaLive. + // The binary data for the thumbnail that the Link device has most recently sent + // to MediaLive. Body io.ReadCloser // The length of the content. diff --git a/service/medialive/api_op_DescribeMultiplex.go b/service/medialive/api_op_DescribeMultiplex.go index 4780aee79e8..d5c346d8b77 100644 --- a/service/medialive/api_op_DescribeMultiplex.go +++ b/service/medialive/api_op_DescribeMultiplex.go @@ -167,9 +167,9 @@ type MultiplexCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, MultiplexCreatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, MultiplexCreatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -368,9 +368,9 @@ type MultiplexDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, MultiplexDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, MultiplexDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -552,9 +552,9 @@ type MultiplexRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, MultiplexRunningWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, MultiplexRunningWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -736,9 +736,9 @@ type MultiplexStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, MultiplexStoppedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, MultiplexStoppedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/medialive/api_op_DescribeOffering.go b/service/medialive/api_op_DescribeOffering.go index aa8bc75bb74..24d49c76f62 100644 --- a/service/medialive/api_op_DescribeOffering.go +++ b/service/medialive/api_op_DescribeOffering.go @@ -57,8 +57,8 @@ type DescribeOfferingOutput struct { // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering FixedPrice float64 - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard + // VQ in US West (Oregon)' OfferingDescription *string // Unique offering ID, e.g. '87654321' diff --git a/service/medialive/api_op_DescribeReservation.go b/service/medialive/api_op_DescribeReservation.go index 95acac76b1f..efb6e9d78ab 100644 --- a/service/medialive/api_op_DescribeReservation.go +++ b/service/medialive/api_op_DescribeReservation.go @@ -66,8 +66,8 @@ type DescribeReservationOutput struct { // User specified reservation name Name *string - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard + // VQ in US West (Oregon)' OfferingDescription *string // Unique offering ID, e.g. '87654321' diff --git a/service/medialive/api_op_ListInputDeviceTransfers.go b/service/medialive/api_op_ListInputDeviceTransfers.go index dcee25cccf9..26420b71059 100644 --- a/service/medialive/api_op_ListInputDeviceTransfers.go +++ b/service/medialive/api_op_ListInputDeviceTransfers.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List input devices that are currently being transferred. List input devices that -// you are transferring from your AWS account or input devices that another AWS -// account is transferring to you. +// List input devices that are currently being transferred. List input devices +// that you are transferring from your AWS account or input devices that another +// AWS account is transferring to you. func (c *Client) ListInputDeviceTransfers(ctx context.Context, params *ListInputDeviceTransfersInput, optFns ...func(*Options)) (*ListInputDeviceTransfersOutput, error) { if params == nil { params = &ListInputDeviceTransfersInput{} diff --git a/service/medialive/api_op_StartChannel.go b/service/medialive/api_op_StartChannel.go index 9bd4c13d8d4..57202effcd2 100644 --- a/service/medialive/api_op_StartChannel.go +++ b/service/medialive/api_op_StartChannel.go @@ -51,9 +51,9 @@ type StartChannelOutput struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []types.OutputDestination // The endpoints where outgoing connections initiate from diff --git a/service/medialive/api_op_StopChannel.go b/service/medialive/api_op_StopChannel.go index ed1998a74e4..58cf4af5ab6 100644 --- a/service/medialive/api_op_StopChannel.go +++ b/service/medialive/api_op_StopChannel.go @@ -51,9 +51,9 @@ type StopChannelOutput struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []types.OutputDestination // The endpoints where outgoing connections initiate from diff --git a/service/medialive/types/enums.go b/service/medialive/types/enums.go index e768d7f0362..5423b6b0502 100644 --- a/service/medialive/types/enums.go +++ b/service/medialive/types/enums.go @@ -34,9 +34,9 @@ const ( AacInputTypeNormal AacInputType = "NORMAL" ) -// Values returns all known values for AacInputType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AacInputType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AacInputType) Values() []AacInputType { return []AacInputType{ "BROADCASTER_MIXED_AD", @@ -90,9 +90,9 @@ const ( AacRawFormatNone AacRawFormat = "NONE" ) -// Values returns all known values for AacRawFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AacRawFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AacRawFormat) Values() []AacRawFormat { return []AacRawFormat{ "LATM_LOAS", @@ -218,9 +218,9 @@ const ( Ac3LfeFilterEnabled Ac3LfeFilter = "ENABLED" ) -// Values returns all known values for Ac3LfeFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Ac3LfeFilter. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Ac3LfeFilter) Values() []Ac3LfeFilter { return []Ac3LfeFilter{ "DISABLED", @@ -253,9 +253,9 @@ const ( AcceptHeaderImageJpeg AcceptHeader = "image/jpeg" ) -// Values returns all known values for AcceptHeader. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AcceptHeader. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AcceptHeader) Values() []AcceptHeader { return []AcceptHeader{ "image/jpeg", @@ -289,9 +289,9 @@ const ( AfdSignalingNone AfdSignaling = "NONE" ) -// Values returns all known values for AfdSignaling. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AfdSignaling. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AfdSignaling) Values() []AfdSignaling { return []AfdSignaling{ "AUTO", @@ -346,9 +346,10 @@ const ( AudioLanguageSelectionPolicyStrict AudioLanguageSelectionPolicy = "STRICT" ) -// Values returns all known values for AudioLanguageSelectionPolicy. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioLanguageSelectionPolicy. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AudioLanguageSelectionPolicy) Values() []AudioLanguageSelectionPolicy { return []AudioLanguageSelectionPolicy{ "LOOSE", @@ -419,8 +420,8 @@ const ( AudioOnlyHlsTrackTypeAudioOnlyVariantStream AudioOnlyHlsTrackType = "AUDIO_ONLY_VARIANT_STREAM" ) -// Values returns all known values for AudioOnlyHlsTrackType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AudioOnlyHlsTrackType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AudioOnlyHlsTrackType) Values() []AudioOnlyHlsTrackType { return []AudioOnlyHlsTrackType{ @@ -441,9 +442,9 @@ const ( AudioTypeVisualImpairedCommentary AudioType = "VISUAL_IMPAIRED_COMMENTARY" ) -// Values returns all known values for AudioType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AudioType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AudioType) Values() []AudioType { return []AudioType{ "CLEAN_EFFECTS", @@ -555,8 +556,8 @@ const ( BurnInBackgroundColorWhite BurnInBackgroundColor = "WHITE" ) -// Values returns all known values for BurnInBackgroundColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for BurnInBackgroundColor. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (BurnInBackgroundColor) Values() []BurnInBackgroundColor { return []BurnInBackgroundColor{ @@ -686,9 +687,9 @@ const ( ChannelClassSinglePipeline ChannelClass = "SINGLE_PIPELINE" ) -// Values returns all known values for ChannelClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChannelClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChannelClass) Values() []ChannelClass { return []ChannelClass{ "STANDARD", @@ -713,9 +714,9 @@ const ( ChannelStateUpdateFailed ChannelState = "UPDATE_FAILED" ) -// Values returns all known values for ChannelState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChannelState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChannelState) Values() []ChannelState { return []ChannelState{ "CREATING", @@ -943,9 +944,10 @@ const ( DvbSubDestinationShadowColorWhite DvbSubDestinationShadowColor = "WHITE" ) -// Values returns all known values for DvbSubDestinationShadowColor. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DvbSubDestinationShadowColor. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DvbSubDestinationShadowColor) Values() []DvbSubDestinationShadowColor { return []DvbSubDestinationShadowColor{ "BLACK", @@ -1141,9 +1143,9 @@ const ( Eac3DcFilterEnabled Eac3DcFilter = "ENABLED" ) -// Values returns all known values for Eac3DcFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Eac3DcFilter. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Eac3DcFilter) Values() []Eac3DcFilter { return []Eac3DcFilter{ "DISABLED", @@ -1189,9 +1191,9 @@ const ( Eac3DrcRfSpeech Eac3DrcRf = "SPEECH" ) -// Values returns all known values for Eac3DrcRf. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Eac3DrcRf. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Eac3DrcRf) Values() []Eac3DrcRf { return []Eac3DrcRf{ "FILM_LIGHT", @@ -1382,9 +1384,9 @@ const ( EbuTtDFillLineGapControlEnabled EbuTtDFillLineGapControl = "ENABLED" ) -// Values returns all known values for EbuTtDFillLineGapControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EbuTtDFillLineGapControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EbuTtDFillLineGapControl) Values() []EbuTtDFillLineGapControl { return []EbuTtDFillLineGapControl{ "DISABLED", @@ -1563,9 +1565,9 @@ const ( FrameCaptureIntervalUnitSeconds FrameCaptureIntervalUnit = "SECONDS" ) -// Values returns all known values for FrameCaptureIntervalUnit. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FrameCaptureIntervalUnit. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FrameCaptureIntervalUnit) Values() []FrameCaptureIntervalUnit { return []FrameCaptureIntervalUnit{ "MILLISECONDS", @@ -1581,8 +1583,8 @@ const ( GlobalConfigurationInputEndActionSwitchAndLoopInputs GlobalConfigurationInputEndAction = "SWITCH_AND_LOOP_INPUTS" ) -// Values returns all known values for GlobalConfigurationInputEndAction. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for GlobalConfigurationInputEndAction. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (GlobalConfigurationInputEndAction) Values() []GlobalConfigurationInputEndAction { @@ -1662,9 +1664,9 @@ const ( H264AdaptiveQuantizationOff H264AdaptiveQuantization = "OFF" ) -// Values returns all known values for H264AdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H264AdaptiveQuantization. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H264AdaptiveQuantization) Values() []H264AdaptiveQuantization { return []H264AdaptiveQuantization{ "AUTO", @@ -1826,9 +1828,9 @@ const ( H264LevelH264LevelAuto H264Level = "H264_LEVEL_AUTO" ) -// Values returns all known values for H264Level. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for H264Level. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (H264Level) Values() []H264Level { return []H264Level{ "H264_LEVEL_1", @@ -1860,9 +1862,9 @@ const ( H264LookAheadRateControlMedium H264LookAheadRateControl = "MEDIUM" ) -// Values returns all known values for H264LookAheadRateControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H264LookAheadRateControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H264LookAheadRateControl) Values() []H264LookAheadRateControl { return []H264LookAheadRateControl{ "HIGH", @@ -1963,9 +1965,9 @@ const ( H264ScanTypeProgressive H264ScanType = "PROGRESSIVE" ) -// Values returns all known values for H264ScanType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for H264ScanType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (H264ScanType) Values() []H264ScanType { return []H264ScanType{ "INTERLACED", @@ -1981,8 +1983,8 @@ const ( H264SceneChangeDetectEnabled H264SceneChangeDetect = "ENABLED" ) -// Values returns all known values for H264SceneChangeDetect. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for H264SceneChangeDetect. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (H264SceneChangeDetect) Values() []H264SceneChangeDetect { return []H264SceneChangeDetect{ @@ -2095,9 +2097,9 @@ const ( H265AdaptiveQuantizationOff H265AdaptiveQuantization = "OFF" ) -// Values returns all known values for H265AdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H265AdaptiveQuantization. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H265AdaptiveQuantization) Values() []H265AdaptiveQuantization { return []H265AdaptiveQuantization{ "AUTO", @@ -2203,9 +2205,9 @@ const ( H265LevelH265LevelAuto H265Level = "H265_LEVEL_AUTO" ) -// Values returns all known values for H265Level. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for H265Level. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (H265Level) Values() []H265Level { return []H265Level{ "H265_LEVEL_1", @@ -2234,9 +2236,9 @@ const ( H265LookAheadRateControlMedium H265LookAheadRateControl = "MEDIUM" ) -// Values returns all known values for H265LookAheadRateControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for H265LookAheadRateControl. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (H265LookAheadRateControl) Values() []H265LookAheadRateControl { return []H265LookAheadRateControl{ "HIGH", @@ -2291,9 +2293,9 @@ const ( H265ScanTypeProgressive H265ScanType = "PROGRESSIVE" ) -// Values returns all known values for H265ScanType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for H265ScanType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (H265ScanType) Values() []H265ScanType { return []H265ScanType{ "INTERLACED", @@ -2309,8 +2311,8 @@ const ( H265SceneChangeDetectEnabled H265SceneChangeDetect = "ENABLED" ) -// Values returns all known values for H265SceneChangeDetect. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for H265SceneChangeDetect. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (H265SceneChangeDetect) Values() []H265SceneChangeDetect { return []H265SceneChangeDetect{ @@ -2365,9 +2367,9 @@ const ( HlsAdMarkersElementalScte35 HlsAdMarkers = "ELEMENTAL_SCTE35" ) -// Values returns all known values for HlsAdMarkers. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HlsAdMarkers. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HlsAdMarkers) Values() []HlsAdMarkers { return []HlsAdMarkers{ "ADOBE", @@ -2440,8 +2442,8 @@ const ( HlsCodecSpecificationRfc6381 HlsCodecSpecification = "RFC_6381" ) -// Values returns all known values for HlsCodecSpecification. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsCodecSpecification. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsCodecSpecification) Values() []HlsCodecSpecification { return []HlsCodecSpecification{ @@ -2458,8 +2460,8 @@ const ( HlsDirectoryStructureSubdirectoryPerStream HlsDirectoryStructure = "SUBDIRECTORY_PER_STREAM" ) -// Values returns all known values for HlsDirectoryStructure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HlsDirectoryStructure. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HlsDirectoryStructure) Values() []HlsDirectoryStructure { return []HlsDirectoryStructure{ @@ -2548,9 +2550,10 @@ const ( HlsIncompleteSegmentBehaviorSuppress HlsIncompleteSegmentBehavior = "SUPPRESS" ) -// Values returns all known values for HlsIncompleteSegmentBehavior. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for HlsIncompleteSegmentBehavior. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (HlsIncompleteSegmentBehavior) Values() []HlsIncompleteSegmentBehavior { return []HlsIncompleteSegmentBehavior{ "AUTO", @@ -2801,9 +2804,9 @@ const ( HlsTimedMetadataId3FrameTdrl HlsTimedMetadataId3Frame = "TDRL" ) -// Values returns all known values for HlsTimedMetadataId3Frame. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for HlsTimedMetadataId3Frame. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsTimedMetadataId3Frame) Values() []HlsTimedMetadataId3Frame { return []HlsTimedMetadataId3Frame{ "NONE", @@ -3114,9 +3117,9 @@ const ( InputLossActionForHlsOutPauseOutput InputLossActionForHlsOut = "PAUSE_OUTPUT" ) -// Values returns all known values for InputLossActionForHlsOut. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InputLossActionForHlsOut. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InputLossActionForHlsOut) Values() []InputLossActionForHlsOut { return []InputLossActionForHlsOut{ "EMIT_OUTPUT", @@ -3170,9 +3173,9 @@ const ( InputLossActionForUdpOutEmitProgram InputLossActionForUdpOut = "EMIT_PROGRAM" ) -// Values returns all known values for InputLossActionForUdpOut. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InputLossActionForUdpOut. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (InputLossActionForUdpOut) Values() []InputLossActionForUdpOut { return []InputLossActionForUdpOut{ "DROP_PROGRAM", @@ -3373,9 +3376,9 @@ const ( InputTypeTsFile InputType = "TS_FILE" ) -// Values returns all known values for InputType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for InputType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (InputType) Values() []InputType { return []InputType{ "UDP_PUSH", @@ -3441,9 +3444,10 @@ const ( M2tsAbsentInputAudioBehaviorEncodeSilence M2tsAbsentInputAudioBehavior = "ENCODE_SILENCE" ) -// Values returns all known values for M2tsAbsentInputAudioBehavior. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for M2tsAbsentInputAudioBehavior. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (M2tsAbsentInputAudioBehavior) Values() []M2tsAbsentInputAudioBehavior { return []M2tsAbsentInputAudioBehavior{ "DROP", @@ -3693,9 +3697,9 @@ const ( M2tsRateModeVbr M2tsRateMode = "VBR" ) -// Values returns all known values for M2tsRateMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for M2tsRateMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (M2tsRateMode) Values() []M2tsRateMode { return []M2tsRateMode{ "CBR", @@ -3755,8 +3759,8 @@ const ( M2tsSegmentationStyleResetCadence M2tsSegmentationStyle = "RESET_CADENCE" ) -// Values returns all known values for M2tsSegmentationStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for M2tsSegmentationStyle. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (M2tsSegmentationStyle) Values() []M2tsSegmentationStyle { return []M2tsSegmentationStyle{ @@ -4128,9 +4132,10 @@ const ( NetworkInputServerValidationCheckCryptographyOnly NetworkInputServerValidation = "CHECK_CRYPTOGRAPHY_ONLY" ) -// Values returns all known values for NetworkInputServerValidation. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NetworkInputServerValidation. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (NetworkInputServerValidation) Values() []NetworkInputServerValidation { return []NetworkInputServerValidation{ "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME", @@ -4235,8 +4240,8 @@ const ( OfferingDurationUnitsMonths OfferingDurationUnits = "MONTHS" ) -// Values returns all known values for OfferingDurationUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OfferingDurationUnits. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OfferingDurationUnits) Values() []OfferingDurationUnits { return []OfferingDurationUnits{ @@ -4251,9 +4256,9 @@ const ( OfferingTypeNoUpfront OfferingType = "NO_UPFRONT" ) -// Values returns all known values for OfferingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OfferingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OfferingType) Values() []OfferingType { return []OfferingType{ "NO_UPFRONT", @@ -4287,9 +4292,9 @@ const ( PreferredChannelPipelinePipeline1 PreferredChannelPipeline = "PIPELINE_1" ) -// Values returns all known values for PreferredChannelPipeline. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PreferredChannelPipeline. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PreferredChannelPipeline) Values() []PreferredChannelPipeline { return []PreferredChannelPipeline{ "CURRENTLY_ACTIVE", @@ -4408,8 +4413,8 @@ const ( ReservationResolutionUhd ReservationResolution = "UHD" ) -// Values returns all known values for ReservationResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReservationResolution. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReservationResolution) Values() []ReservationResolution { return []ReservationResolution{ @@ -4530,8 +4535,8 @@ const ( RtmpCacheFullBehaviorWaitForServer RtmpCacheFullBehavior = "WAIT_FOR_SERVER" ) -// Values returns all known values for RtmpCacheFullBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RtmpCacheFullBehavior. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RtmpCacheFullBehavior) Values() []RtmpCacheFullBehavior { return []RtmpCacheFullBehavior{ @@ -4608,8 +4613,8 @@ const ( Scte20Convert608To708Upconvert Scte20Convert608To708 = "UPCONVERT" ) -// Values returns all known values for Scte20Convert608To708. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for Scte20Convert608To708. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (Scte20Convert608To708) Values() []Scte20Convert608To708 { return []Scte20Convert608To708{ @@ -4690,9 +4695,9 @@ const ( Scte35ArchiveAllowedFlagArchiveAllowed Scte35ArchiveAllowedFlag = "ARCHIVE_ALLOWED" ) -// Values returns all known values for Scte35ArchiveAllowedFlag. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Scte35ArchiveAllowedFlag. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35ArchiveAllowedFlag) Values() []Scte35ArchiveAllowedFlag { return []Scte35ArchiveAllowedFlag{ "ARCHIVE_NOT_ALLOWED", @@ -4710,9 +4715,9 @@ const ( Scte35DeviceRestrictionsRestrictGroup2 Scte35DeviceRestrictions = "RESTRICT_GROUP2" ) -// Values returns all known values for Scte35DeviceRestrictions. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Scte35DeviceRestrictions. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35DeviceRestrictions) Values() []Scte35DeviceRestrictions { return []Scte35DeviceRestrictions{ "NONE", @@ -4748,9 +4753,10 @@ const ( Scte35NoRegionalBlackoutFlagNoRegionalBlackout Scte35NoRegionalBlackoutFlag = "NO_REGIONAL_BLACKOUT" ) -// Values returns all known values for Scte35NoRegionalBlackoutFlag. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Scte35NoRegionalBlackoutFlag. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (Scte35NoRegionalBlackoutFlag) Values() []Scte35NoRegionalBlackoutFlag { return []Scte35NoRegionalBlackoutFlag{ "REGIONAL_BLACKOUT", @@ -4766,8 +4772,8 @@ const ( Scte35SegmentationCancelIndicatorSegmentationEventCanceled Scte35SegmentationCancelIndicator = "SEGMENTATION_EVENT_CANCELED" ) -// Values returns all known values for Scte35SegmentationCancelIndicator. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for Scte35SegmentationCancelIndicator. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (Scte35SegmentationCancelIndicator) Values() []Scte35SegmentationCancelIndicator { @@ -4823,9 +4829,10 @@ const ( Scte35WebDeliveryAllowedFlagWebDeliveryAllowed Scte35WebDeliveryAllowedFlag = "WEB_DELIVERY_ALLOWED" ) -// Values returns all known values for Scte35WebDeliveryAllowedFlag. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for Scte35WebDeliveryAllowedFlag. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (Scte35WebDeliveryAllowedFlag) Values() []Scte35WebDeliveryAllowedFlag { return []Scte35WebDeliveryAllowedFlag{ "WEB_DELIVERY_NOT_ALLOWED", @@ -4898,9 +4905,10 @@ const ( SmoothGroupEventStopBehaviorSendEos SmoothGroupEventStopBehavior = "SEND_EOS" ) -// Values returns all known values for SmoothGroupEventStopBehavior. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SmoothGroupEventStopBehavior. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (SmoothGroupEventStopBehavior) Values() []SmoothGroupEventStopBehavior { return []SmoothGroupEventStopBehavior{ "NONE", @@ -4954,8 +4962,8 @@ const ( SmoothGroupStreamManifestBehaviorSend SmoothGroupStreamManifestBehavior = "SEND" ) -// Values returns all known values for SmoothGroupStreamManifestBehavior. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for SmoothGroupStreamManifestBehavior. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (SmoothGroupStreamManifestBehavior) Values() []SmoothGroupStreamManifestBehavior { @@ -5172,9 +5180,9 @@ const ( UdpTimedMetadataId3FrameTdrl UdpTimedMetadataId3Frame = "TDRL" ) -// Values returns all known values for UdpTimedMetadataId3Frame. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for UdpTimedMetadataId3Frame. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (UdpTimedMetadataId3Frame) Values() []UdpTimedMetadataId3Frame { return []UdpTimedMetadataId3Frame{ "NONE", @@ -5192,9 +5200,10 @@ const ( VideoDescriptionRespondToAfdRespond VideoDescriptionRespondToAfd = "RESPOND" ) -// Values returns all known values for VideoDescriptionRespondToAfd. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VideoDescriptionRespondToAfd. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (VideoDescriptionRespondToAfd) Values() []VideoDescriptionRespondToAfd { return []VideoDescriptionRespondToAfd{ "NONE", @@ -5254,9 +5263,10 @@ const ( VideoSelectorColorSpaceUsageForce VideoSelectorColorSpaceUsage = "FORCE" ) -// Values returns all known values for VideoSelectorColorSpaceUsage. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VideoSelectorColorSpaceUsage. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (VideoSelectorColorSpaceUsage) Values() []VideoSelectorColorSpaceUsage { return []VideoSelectorColorSpaceUsage{ "FALLBACK", diff --git a/service/medialive/types/types.go b/service/medialive/types/types.go index 16d911b6c7f..ff46e4ad852 100644 --- a/service/medialive/types/types.go +++ b/service/medialive/types/types.go @@ -75,9 +75,9 @@ type Ac3Settings struct { // encoding. Only valid in codingMode32Lfe mode. LfeFilter Ac3LfeFilter - // When set to "followInput", encoder metadata will be sourced from the DD, DD+, or - // DolbyE decoder that supplied this audio data. If audio was not supplied from one - // of these streams, then the static metadata settings will be used. + // When set to "followInput", encoder metadata will be sourced from the DD, DD+, + // or DolbyE decoder that supplied this audio data. If audio was not supplied from + // one of these streams, then the static metadata settings will be used. MetadataControl Ac3MetadataControl noSmithyDocumentSerde @@ -254,9 +254,9 @@ type AudioDescription struct { // Audio codec settings. CodecSettings *AudioCodecSettings - // RFC 5646 language code representing the language of the audio output track. Only - // used if languageControlMode is useConfigured, or there is no ISO 639 language - // code specified in the input. + // RFC 5646 language code representing the language of the audio output track. + // Only used if languageControlMode is useConfigured, or there is no ISO 639 + // language code specified in the input. LanguageCode *string // Choosing followInput will cause the ISO 639 language code of the output to @@ -265,8 +265,8 @@ type AudioDescription struct { // 639 language code specified by the input. LanguageCodeControl AudioDescriptionLanguageCodeControl - // Settings that control how input audio channels are remixed into the output audio - // channels. + // Settings that control how input audio channels are remixed into the output + // audio channels. RemixSettings *RemixSettings // Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the @@ -394,8 +394,8 @@ type AudioPidSelection struct { // Audio Selector type AudioSelector struct { - // The name of this AudioSelector. AudioDescriptions will use this name to uniquely - // identify this Selector. Selector names should be unique per input. + // The name of this AudioSelector. AudioDescriptions will use this name to + // uniquely identify this Selector. Selector names should be unique per input. // // This member is required. Name *string @@ -434,9 +434,9 @@ type AudioSilenceFailoverSettings struct { // This member is required. AudioSelectorName *string - // The amount of time (in milliseconds) that the active input must be silent before - // automatic input failover occurs. Silence is defined as audio loss or audio - // quieter than -50 dBFS. + // The amount of time (in milliseconds) that the active input must be silent + // before automatic input failover occurs. Silence is defined as audio loss or + // audio quieter than -50 dBFS. AudioSilenceThresholdMsec int32 noSmithyDocumentSerde @@ -639,8 +639,8 @@ type BlackoutSlate struct { // entered in "Network ID". NetworkEndBlackout BlackoutSlateNetworkEndBlackout - // Path to local file to use as Network End Blackout image. Image will be scaled to - // fill the entire output raster. + // Path to local file to use as Network End Blackout image. Image will be scaled + // to fill the entire output raster. NetworkEndBlackoutImage *InputLocation // Provides Network ID that matches EIDR ID format (e.g., @@ -657,13 +657,14 @@ type BlackoutSlate struct { // Burn In Destination Settings type BurnInDestinationSettings struct { - // If no explicit xPosition or yPosition is provided, setting alignment to centered - // will place the captions at the bottom center of the output. Similarly, setting a - // left alignment will align captions to the bottom left of the output. If x and y - // positions are given in conjunction with the alignment parameter, the font will - // be justified (either left or centered) relative to those coordinates. Selecting - // "smart" justification will left-justify live subtitles and center-justify - // pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. + // If no explicit xPosition or yPosition is provided, setting alignment to + // centered will place the captions at the bottom center of the output. Similarly, + // setting a left alignment will align captions to the bottom left of the output. + // If x and y positions are given in conjunction with the alignment parameter, the + // font will be justified (either left or centered) relative to those coordinates. + // Selecting "smart" justification will left-justify live subtitles and + // center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings + // must match. Alignment BurnInAlignment // Specifies the color of the rectangle behind the captions. All burn-in and @@ -732,8 +733,9 @@ type BurnInDestinationSettings struct { // burn-in and DVB-Sub font settings must match. ShadowYOffset int32 - // Controls whether a fixed grid size will be used to generate the output subtitles - // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + // Controls whether a fixed grid size will be used to generate the output + // subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in + // outputs. TeletextGridControl BurnInTeletextGridControl // Specifies the horizontal position of the caption relative to the left side of @@ -743,11 +745,11 @@ type BurnInDestinationSettings struct { // burn-in and DVB-Sub font settings must match. XPosition int32 - // Specifies the vertical position of the caption relative to the top of the output - // in pixels. A value of 10 would result in the captions starting 10 pixels from - // the top of the output. If no explicit yPosition is provided, the caption will be - // positioned towards the bottom of the output. All burn-in and DVB-Sub font - // settings must match. + // Specifies the vertical position of the caption relative to the top of the + // output in pixels. A value of 10 would result in the captions starting 10 pixels + // from the top of the output. If no explicit yPosition is provided, the caption + // will be positioned towards the bottom of the output. All burn-in and DVB-Sub + // font settings must match. YPosition int32 noSmithyDocumentSerde @@ -762,8 +764,8 @@ type CaptionDescription struct { // This member is required. CaptionSelectorName *string - // Name of the caption description. Used to associate a caption description with an - // output. Names must be unique within an event. + // Name of the caption description. Used to associate a caption description with + // an output. Names must be unique within an event. // // This member is required. Name *string @@ -867,8 +869,8 @@ type CaptionRectangle struct { // This member is required. Height float64 - // Applies only if you plan to convert these source captions to EBU-TT-D or TTML in - // an output. (Make sure to leave the default if you don't have either of these + // Applies only if you plan to convert these source captions to EBU-TT-D or TTML + // in an output. (Make sure to leave the default if you don't have either of these // formats in the output.) You can define a display rectangle for the captions that // is smaller than the underlying video frame. You define the rectangle by // specifying the position of the left edge, top edge, bottom edge, and right edge @@ -975,9 +977,9 @@ type Channel struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []OutputDestination // The endpoints where outgoing connections initiate from @@ -1047,9 +1049,9 @@ type ChannelSummary struct { // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass ChannelClass - // A list of destinations of the channel. For UDP outputs, there is one destination - // per output. For other types (HLS, for example), there is one destination per - // packager. + // A list of destinations of the channel. For UDP outputs, there is one + // destination per output. For other types (HLS, for example), there is one + // destination per packager. Destinations []OutputDestination // The endpoints where outgoing connections initiate from @@ -1152,15 +1154,16 @@ type DvbSdtSettings struct { // Dvb Sub Destination Settings type DvbSubDestinationSettings struct { - // If no explicit xPosition or yPosition is provided, setting alignment to centered - // will place the captions at the bottom center of the output. Similarly, setting a - // left alignment will align captions to the bottom left of the output. If x and y - // positions are given in conjunction with the alignment parameter, the font will - // be justified (either left or centered) relative to those coordinates. Selecting - // "smart" justification will left-justify live subtitles and center-justify - // pre-recorded subtitles. This option is not valid for source captions that are - // STL or 608/embedded. These source settings are already pre-defined by the - // caption stream. All burn-in and DVB-Sub font settings must match. + // If no explicit xPosition or yPosition is provided, setting alignment to + // centered will place the captions at the bottom center of the output. Similarly, + // setting a left alignment will align captions to the bottom left of the output. + // If x and y positions are given in conjunction with the alignment parameter, the + // font will be justified (either left or centered) relative to those coordinates. + // Selecting "smart" justification will left-justify live subtitles and + // center-justify pre-recorded subtitles. This option is not valid for source + // captions that are STL or 608/embedded. These source settings are already + // pre-defined by the caption stream. All burn-in and DVB-Sub font settings must + // match. Alignment DvbSubDestinationAlignment // Specifies the color of the rectangle behind the captions. All burn-in and @@ -1193,9 +1196,9 @@ type DvbSubDestinationSettings struct { // DVB-Sub font settings must match. FontResolution int32 - // When set to auto fontSize will scale depending on the size of the output. Giving - // a positive integer will specify the exact font size in points. All burn-in and - // DVB-Sub font settings must match. + // When set to auto fontSize will scale depending on the size of the output. + // Giving a positive integer will specify the exact font size in points. All + // burn-in and DVB-Sub font settings must match. FontSize *string // Specifies font outline color. This option is not valid for source captions that @@ -1229,8 +1232,9 @@ type DvbSubDestinationSettings struct { // burn-in and DVB-Sub font settings must match. ShadowYOffset int32 - // Controls whether a fixed grid size will be used to generate the output subtitles - // bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. + // Controls whether a fixed grid size will be used to generate the output + // subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in + // outputs. TeletextGridControl DvbSubDestinationTeletextGridControl // Specifies the horizontal position of the caption relative to the left side of @@ -1242,13 +1246,13 @@ type DvbSubDestinationSettings struct { // and DVB-Sub font settings must match. XPosition int32 - // Specifies the vertical position of the caption relative to the top of the output - // in pixels. A value of 10 would result in the captions starting 10 pixels from - // the top of the output. If no explicit yPosition is provided, the caption will be - // positioned towards the bottom of the output. This option is not valid for source - // captions that are STL, 608/embedded or teletext. These source settings are - // already pre-defined by the caption stream. All burn-in and DVB-Sub font settings - // must match. + // Specifies the vertical position of the caption relative to the top of the + // output in pixels. A value of 10 would result in the captions starting 10 pixels + // from the top of the output. If no explicit yPosition is provided, the caption + // will be positioned towards the bottom of the output. This option is not valid + // for source captions that are STL, 608/embedded or teletext. These source + // settings are already pre-defined by the caption stream. All burn-in and DVB-Sub + // font settings must match. YPosition int32 noSmithyDocumentSerde @@ -1400,12 +1404,9 @@ type EbuTtDDestinationSettings struct { CopyrightHolder *string // Specifies how to handle the gap between the lines (in multi-line captions). - // - // * - // enabled: Fill with the captions background color (as specified in the input - // captions). - // - // * disabled: Leave the gap unfilled. + // - enabled: Fill with the captions background color (as specified in the input + // captions). + // - disabled: Leave the gap unfilled. FillLineGap EbuTtDFillLineGapControl // Specifies the font family to include in the font data attached to the EBU-TT @@ -1415,27 +1416,21 @@ type EbuTtDDestinationSettings struct { // font family. All other style information (color, bold, position and so on) is // copied from the input captions. The size is always set to 100% to allow the // downstream player to choose the size. - // - // * Enter a list of font families, as a - // comma-separated list of font names, in order of preference. The name can be a - // font family (such as “Arial”), or a generic font family (such as “serif”), or - // “default” (to let the downstream player choose the font). - // - // * Leave blank to set - // the family to “monospace”. + // - Enter a list of font families, as a comma-separated list of font names, in + // order of preference. The name can be a font family (such as “Arial”), or a + // generic font family (such as “serif”), or “default” (to let the downstream + // player choose the font). + // - Leave blank to set the family to “monospace”. FontFamily *string // Specifies the style information (font color, font position, and so on) to // include in the font data that is attached to the EBU-TT captions. - // - // * include: - // Take the style information (font color, font position, and so on) from the - // source captions and include that information in the font data attached to the - // EBU-TT captions. This option is valid only if the source captions are Embedded - // or Teletext. - // - // * exclude: In the font data attached to the EBU-TT captions, set - // the font family to "monospaced". Do not include any other style information. + // - include: Take the style information (font color, font position, and so on) + // from the source captions and include that information in the font data attached + // to the EBU-TT captions. This option is valid only if the source captions are + // Embedded or Teletext. + // - exclude: In the font data attached to the EBU-TT captions, set the font + // family to "monospaced". Do not include any other style information. StyleControl EbuTtDDestinationStyleControl noSmithyDocumentSerde @@ -1459,8 +1454,8 @@ type EmbeddedSourceSettings struct { // the source content will be discarded. Convert608To708 EmbeddedConvert608To708 - // Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and - // Embedded captions. + // Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 + // and Embedded captions. Scte20Detection EmbeddedScte20Detection // Specifies the 608/708 channel number within the video track from which to @@ -1538,9 +1533,9 @@ type Esam struct { // This member is required. PoisEndpoint *string - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. This only applies to embedded SCTE 104/35 messages and does not apply to - // OOB messages. + // When specified, this offset (in milliseconds) is added to the input Ad Avail + // PTS time. This only applies to embedded SCTE 104/35 messages and does not apply + // to OOB messages. AdAvailOffset int32 // Documentation update needed @@ -1756,15 +1751,15 @@ type GlobalConfiguration struct { // Settings for system actions when input is lost. InputLossBehavior *InputLossBehavior - // Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive - // will attempt to synchronize the output of each pipeline to the other. + // Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - + // MediaLive will attempt to synchronize the output of each pipeline to the other. // EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each // pipeline to the Unix epoch. OutputLockingMode GlobalConfigurationOutputLockingMode - // Indicates whether the rate of frames emitted by the Live encoder should be paced - // by its system clock (which optionally may be locked to another source via NTP) - // or should be locked to the clock of the source that is providing the input + // Indicates whether the rate of frames emitted by the Live encoder should be + // paced by its system clock (which optionally may be locked to another source via + // NTP) or should be locked to the clock of the source that is providing the input // stream. OutputTimingSource GlobalConfigurationOutputTimingSource @@ -1883,9 +1878,9 @@ type H264Settings struct { // Documentation update needed GopBReference H264GopBReference - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. + // Frequency of closed GOPs. In streaming applications, it is recommended that + // this be set to 1 so a decoder joining mid-stream will receive an IDR frame as + // quickly as possible. Setting this value to 0 will break output segmenting. GopClosedCadence int32 // Number of B-frames between reference frames. @@ -1904,8 +1899,8 @@ type H264Settings struct { // H.264 Level. Level H264Level - // Amount of lookahead. A value of low can decrease latency and memory usage, while - // high can produce better quality for certain content. + // Amount of lookahead. A value of low can decrease latency and memory usage, + // while high can produce better quality for certain content. LookAheadRateControl H264LookAheadRateControl // For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in @@ -1943,14 +1938,11 @@ type H264Settings struct { // Leave as STANDARD_QUALITY or choose a different value (which might result in // additional costs to run the channel). - // - // * ENHANCED_QUALITY: Produces a slightly - // better video quality without an increase in the bitrate. Has an effect only when - // the Rate control mode is QVBR or CBR. If this channel is in a MediaLive - // multiplex, the value must be ENHANCED_QUALITY. - // - // * STANDARD_QUALITY: Valid for - // any Rate control mode. + // - ENHANCED_QUALITY: Produces a slightly better video quality without an + // increase in the bitrate. Has an effect only when the Rate control mode is QVBR + // or CBR. If this channel is in a MediaLive multiplex, the value must be + // ENHANCED_QUALITY. + // - STANDARD_QUALITY: Valid for any Rate control mode. QualityLevel H264QualityLevel // Controls the target quality for the video encode. Applies only when the rate @@ -1958,17 +1950,12 @@ type H264Settings struct { // determine the best quality. To set a target quality, enter values in the QVBR // quality level field and the Max bitrate field. Enter values that suit your most // important viewing devices. Recommended values are: - // - // * Primary screen: Quality - // level: 8 to 10. Max bitrate: 4M - // - // * PC or tablet: Quality level: 7. Max bitrate: - // 1.5M to 3M - // - // * Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let - // MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate - // enter the maximum rate you want in the video. For more information, see the - // section called "Video - rate control mode" in the MediaLive user guide + // - Primary screen: Quality level: 8 to 10. Max bitrate: 4M + // - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M + // - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive + // decide, leave the QVBR quality level field empty, and in Max bitrate enter the + // maximum rate you want in the video. For more information, see the section called + // "Video - rate control mode" in the MediaLive user guide QvbrQualityLevel int32 // Rate control mode. QVBR: Quality will match the specified quality level except @@ -1987,11 +1974,8 @@ type H264Settings struct { ScanType H264ScanType // Scene change detection. - // - // * On: inserts I-frames when scene change is - // detected. - // - // * Off: does not force an I-frame when scene change is detected. + // - On: inserts I-frames when scene change is detected. + // - Off: does not force an I-frame when scene change is detected. SceneChangeDetect H264SceneChangeDetect // Number of slices per picture. Must be less than or equal to the number of @@ -2040,12 +2024,9 @@ type H264Settings struct { TimecodeBurninSettings *TimecodeBurninSettings // Determines how timecodes should be inserted into the video elementary stream. - // - // * - // 'disabled': Do not include timecodes - // - // * 'picTimingSei': Pass through picture - // timing SEI messages from the source specified in Timecode Config + // - 'disabled': Do not include timecodes + // - 'picTimingSei': Pass through picture timing SEI messages from the source + // specified in Timecode Config TimecodeInsertion H264TimecodeInsertionBehavior noSmithyDocumentSerde @@ -2104,8 +2085,8 @@ type H265Settings struct { // will be the value configured in the fixedAfd parameter. AfdSignaling AfdSignaling - // Whether or not EML should insert an Alternative Transfer Function SEI message to - // support backwards compatibility with non-HDR decoders and displays. + // Whether or not EML should insert an Alternative Transfer Function SEI message + // to support backwards compatibility with non-HDR decoders and displays. AlternativeTransferFunction H265AlternativeTransferFunction // Average bitrate in bits/second. Required when the rate control mode is VBR or @@ -2133,9 +2114,9 @@ type H265Settings struct { // 'pop' on I-frames. FlickerAq H265FlickerAq - // Frequency of closed GOPs. In streaming applications, it is recommended that this - // be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly - // as possible. Setting this value to 0 will break output segmenting. + // Frequency of closed GOPs. In streaming applications, it is recommended that + // this be set to 1 so a decoder joining mid-stream will receive an IDR frame as + // quickly as possible. Setting this value to 0 will break output segmenting. GopClosedCadence int32 // GOP size (keyframe interval) in units of either frames or seconds per @@ -2151,8 +2132,8 @@ type H265Settings struct { // H.265 Level. Level H265Level - // Amount of lookahead. A value of low can decrease latency and memory usage, while - // high can produce better quality for certain content. + // Amount of lookahead. A value of low can decrease latency and memory usage, + // while high can produce better quality for certain content. LookAheadRateControl H265LookAheadRateControl // For QVBR: See the tooltip for Quality level @@ -2180,14 +2161,9 @@ type H265Settings struct { // control mode is QVBR. Set values for the QVBR quality level field and Max // bitrate field that suit your most important viewing devices. Recommended values // are: - // - // * Primary screen: Quality level: 8 to 10. Max bitrate: 4M - // - // * PC or tablet: - // Quality level: 7. Max bitrate: 1.5M to 3M - // - // * Smartphone: Quality level: 6. Max - // bitrate: 1M to 1.5M + // - Primary screen: Quality level: 8 to 10. Max bitrate: 4M + // - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M + // - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M QvbrQualityLevel int32 // Rate control mode. QVBR: Quality will match the specified quality level except @@ -2220,12 +2196,9 @@ type H265Settings struct { TimecodeBurninSettings *TimecodeBurninSettings // Determines how timecodes should be inserted into the video elementary stream. - // - // * - // 'disabled': Do not include timecodes - // - // * 'picTimingSei': Pass through picture - // timing SEI messages from the source specified in Timecode Config + // - 'disabled': Do not include timecodes + // - 'picTimingSei': Pass through picture timing SEI messages from the source + // specified in Timecode Config TimecodeInsertion H265TimecodeInsertionBehavior noSmithyDocumentSerde @@ -2234,13 +2207,14 @@ type H265Settings struct { // Hdr10 Settings type Hdr10Settings struct { - // Maximum Content Light Level An integer metadata value defining the maximum light - // level, in nits, of any single pixel within an encoded HDR video stream or file. + // Maximum Content Light Level An integer metadata value defining the maximum + // light level, in nits, of any single pixel within an encoded HDR video stream or + // file. MaxCll int32 - // Maximum Frame Average Light Level An integer metadata value defining the maximum - // average light level, in nits, for any single frame within an encoded HDR video - // stream or file. + // Maximum Frame Average Light Level An integer metadata value defining the + // maximum average light level, in nits, for any single frame within an encoded HDR + // video stream or file. MaxFall int32 noSmithyDocumentSerde @@ -2379,9 +2353,9 @@ type HlsGroupSettings struct { // generation. CodecSpecification HlsCodecSpecification - // For use with encryptionType. This is a 128-bit, 16-byte hex value represented by - // a 32-character text string. If ivSource is set to "explicit" then this parameter - // is required and is used as the IV for encryption. + // For use with encryptionType. This is a 128-bit, 16-byte hex value represented + // by a 32-character text string. If ivSource is set to "explicit" then this + // parameter is required and is used as the IV for encryption. ConstantIv *string // Place segments in subdirectories. @@ -2452,9 +2426,9 @@ type HlsGroupSettings struct { // indexNSegments). This situation would result in a 404 HTTP error on the player. KeepSegments int32 - // The value specifies how the key is represented in the resource identified by the - // URI. If parameter is absent, an implicit value of "identity" is used. A reverse - // DNS string can also be given. + // The value specifies how the key is represented in the resource identified by + // the URI. If parameter is absent, an implicit value of "identity" is used. A + // reverse DNS string can also be given. KeyFormat *string // Either a single positive integer version value or a slash delimited list of @@ -2471,9 +2445,9 @@ type HlsGroupSettings struct { // values for segment duration. ManifestDurationFormat HlsManifestDurationFormat - // Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum - // segment length is enforced by looking ahead and back within the specified range - // for a nearby avail and extending the segment size if needed. + // Minimum length of MPEG-2 Transport Stream segments in seconds. When set, + // minimum segment length is enforced by looking ahead and back within the + // specified range for a nearby avail and extending the segment size if needed. MinSegmentLength int32 // If "vod", all segments are indexed and kept permanently in the destination and @@ -2484,8 +2458,8 @@ type HlsGroupSettings struct { // converting it to a "VOD" type manifest on completion of the stream. Mode HlsMode - // MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and - // media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: + // MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, + // and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: // Generates media manifests for this output group, but not a master manifest. // SEGMENTS_ONLY: Does not generate any manifests for this output group. OutputSelection HlsOutputSelection @@ -2506,13 +2480,13 @@ type HlsGroupSettings struct { // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. ProgramDateTimePeriod int32 - // ENABLED: The master manifest (.m3u8 file) for each pipeline includes information - // about both pipelines: first its own media files, then the media files of the - // other pipeline. This feature allows playout device that support stale manifest - // detection to switch from one manifest to the other, when the current manifest - // seems to be stale. There are still two destinations and two master manifests, - // but both master manifests reference the media files from both pipelines. - // DISABLED: The master manifest (.m3u8 file) for each pipeline includes + // ENABLED: The master manifest (.m3u8 file) for each pipeline includes + // information about both pipelines: first its own media files, then the media + // files of the other pipeline. This feature allows playout device that support + // stale manifest detection to switch from one manifest to the other, when the + // current manifest seems to be stale. There are still two destinations and two + // master manifests, but both master manifests reference the media files from both + // pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes // information about its own pipeline only. For an HLS output group with // MediaPackage as the destination, the DISABLED behavior is always followed. // MediaPackage regenerates the manifests it serves to players so a redundant @@ -2586,8 +2560,8 @@ type HlsInputSettings struct { // will begin with the first segment specified in the m3u8. BufferSegments int32 - // The number of consecutive times that attempts to read a manifest or segment must - // fail before the input is considered unavailable. + // The number of consecutive times that attempts to read a manifest or segment + // must fail before the input is considered unavailable. Retries int32 // The number of seconds between retries when an attempt to read a manifest or @@ -2897,8 +2871,8 @@ type InputDeviceConfigurableSettings struct { // The Link device's buffer size (latency) in milliseconds (ms). LatencyMs int32 - // The maximum bitrate in bits per second. Set a value here to throttle the bitrate - // of the source video. + // The maximum bitrate in bits per second. Set a value here to throttle the + // bitrate of the source video. MaxBitrate int32 noSmithyDocumentSerde @@ -2908,8 +2882,8 @@ type InputDeviceConfigurableSettings struct { // characteristics of that source. type InputDeviceHdSettings struct { - // If you specified Auto as the configured input, specifies which of the sources is - // currently active (SDI or HDMI). + // If you specified Auto as the configured input, specifies which of the sources + // is currently active (SDI or HDMI). ActiveInput InputDeviceActiveInput // The source at the input device that is currently active. You can specify this @@ -2954,8 +2928,8 @@ type InputDeviceNetworkSettings struct { // The IP address of the input device. IpAddress *string - // Specifies whether the input device has been configured (outside of MediaLive) to - // use a dynamic IP address assignment (DHCP) or a static IP address. + // Specifies whether the input device has been configured (outside of MediaLive) + // to use a dynamic IP address assignment (DHCP) or a static IP address. IpScheme InputDeviceIpScheme // The subnet mask of the input device. @@ -3035,8 +3009,8 @@ type InputDeviceSummary struct { // characteristics of that source. type InputDeviceUhdSettings struct { - // If you specified Auto as the configured input, specifies which of the sources is - // currently active (SDI or HDMI). + // If you specified Auto as the configured input, specifies which of the sources + // is currently active (SDI or HDMI). ActiveInput InputDeviceActiveInput // The source at the input device that is currently active. You can specify this @@ -3116,8 +3090,8 @@ type InputLossBehavior struct { // the specified period. type InputLossFailoverSettings struct { - // The amount of time (in milliseconds) that no input is detected. After that time, - // an input failover will occur. + // The amount of time (in milliseconds) that no input is detected. After that + // time, an input failover will occur. InputLossThresholdMsec int32 noSmithyDocumentSerde @@ -3190,14 +3164,9 @@ type InputSettings struct { // Turns on the filter for this input. MPEG-2 inputs have the deblocking filter // enabled by default. - // - // * auto - filtering will be applied depending on input - // type/quality - // - // * disabled - no filtering will be applied to the input - // - // * forced - - // filtering will be applied regardless of input type + // - auto - filtering will be applied depending on input type/quality + // - disabled - no filtering will be applied to the input + // - forced - filtering will be applied regardless of input type InputFilter InputFilter // Input settings. @@ -3210,12 +3179,9 @@ type InputSettings struct { // Specifies whether to extract applicable ancillary data from a SMPTE-2038 source // in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 // messages. - // - // * PREFER: Extract from SMPTE-2038 if present in this input, otherwise - // extract from another source (if any). - // - // * IGNORE: Never extract any ancillary - // data from SMPTE-2038. + // - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract + // from another source (if any). + // - IGNORE: Never extract any ancillary data from SMPTE-2038. Smpte2038DataPreference Smpte2038DataPreference // Loop input if it is a file. This allows a file input to be streamed @@ -3385,8 +3351,8 @@ type M2tsSettings struct { // EAC3. When set to dvb, uses stream type = 0x06. AudioStreamType M2tsAudioStreamType - // The output bitrate of the transport stream in bits per second. Setting to 0 lets - // the muxer automatically determine the appropriate bitrate. + // The output bitrate of the transport stream in bits per second. Setting to 0 + // lets the muxer automatically determine the appropriate bitrate. Bitrate int32 // Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to @@ -3433,12 +3399,13 @@ type M2tsSettings struct { // always follow the video interval. EbpAudioInterval M2tsAudioInterval - // When set, enforces that Encoder Boundary Points do not come within the specified - // time interval of each other by looking ahead at input video. If another EBP is - // going to come in within the specified time interval, the current EBP is not - // emitted, and the segment is "stretched" to the next marker. The lookahead value - // does not add latency to the system. The Live Event must be configured elsewhere - // to create sufficient latency to make the lookahead accurate. + // When set, enforces that Encoder Boundary Points do not come within the + // specified time interval of each other by looking ahead at input video. If + // another EBP is going to come in within the specified time interval, the current + // EBP is not emitted, and the segment is "stretched" to the next marker. The + // lookahead value does not add latency to the system. The Live Event must be + // configured elsewhere to create sufficient latency to make the lookahead + // accurate. EbpLookaheadMs int32 // Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP @@ -3507,9 +3474,9 @@ type M2tsSettings struct { // transport stream. Valid values are 0, 10..1000. PmtInterval int32 - // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. - // Can be entered as a decimal or hexadecimal value. Valid values are 32 (or - // 0x20)..8182 (or 0x1ff6). + // Packet Identifier (PID) for the Program Map Table (PMT) in the transport + // stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 + // (or 0x20)..8182 (or 0x1ff6). PmtPid *string // The value of the program number field in the Program Map Table. @@ -3555,8 +3522,8 @@ type M2tsSettings struct { // truncated, which can influence where future segmentation markers are inserted. // When a segmentation style of "resetCadence" is selected and a segment is // truncated due to an avail, we will reset the segmentation cadence. This means - // the subsequent segment will have a duration of $segmentationTime seconds. When a - // segmentation style of "maintainCadence" is selected and a segment is truncated + // the subsequent segment will have a duration of $segmentationTime seconds. When + // a segmentation style of "maintainCadence" is selected and a segment is truncated // due to an avail, we will not reset the segmentation cadence. This means the // subsequent segment will likely be truncated as well. However, all segments after // that will have a duration of $segmentationTime seconds. Note that EBP lookahead @@ -3627,8 +3594,8 @@ type M3u8Settings struct { // transport stream. A value of "0" writes out the PMT once per segment file. PmtInterval int32 - // Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. - // Can be entered as a decimal or hexadecimal value. + // Packet Identifier (PID) for the Program Map Table (PMT) in the transport + // stream. Can be entered as a decimal or hexadecimal value. PmtPid *string // The value of the program number field in the Program Map Table. @@ -3699,8 +3666,8 @@ type MaintenanceUpdateSettings struct { // future maintenance windows. MaintenanceDay MaintenanceDay - // Choose a specific date for maintenance to occur. The chosen date is used for the - // next maintenance window only. + // Choose a specific date for maintenance to occur. The chosen date is used for + // the next maintenance window only. MaintenanceScheduledDate *string // Choose the hour that maintenance will start. The chosen time is used for all @@ -3742,11 +3709,11 @@ type MediaPackageGroupSettings struct { // MediaPackage Output Destination Settings type MediaPackageOutputDestinationSettings struct { - // ID of the channel in MediaPackage that is the destination for this output group. - // You do not need to specify the individual inputs in MediaPackage; MediaLive will - // handle the connection of the two MediaLive pipelines to the two MediaPackage - // inputs. The MediaPackage channel and MediaLive channel must be in the same - // region. + // ID of the channel in MediaPackage that is the destination for this output + // group. You do not need to specify the individual inputs in MediaPackage; + // MediaLive will handle the connection of the two MediaLive pipelines to the two + // MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in + // the same region. ChannelId *string noSmithyDocumentSerde @@ -3853,11 +3820,11 @@ type Mpeg2Settings struct { // vary, which might improve visual quality. AdaptiveQuantization Mpeg2AdaptiveQuantization - // Indicates the AFD values that MediaLive will write into the video encode. If you - // do not know what AFD signaling is, or if your downstream system has not given - // you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD - // value (in cases where multiple AFD values are valid). FIXED: MediaLive will use - // the value you specify in fixedAFD. + // Indicates the AFD values that MediaLive will write into the video encode. If + // you do not know what AFD signaling is, or if your downstream system has not + // given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input + // AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will + // use the value you specify in fixedAFD. AfdSignaling AfdSignaling // Specifies whether to include the color space metadata. The metadata describes @@ -3936,8 +3903,8 @@ type Mpeg2Settings struct { // Ms Smooth Group Settings type MsSmoothGroupSettings struct { - // Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" - // encoder to IIS. + // Smooth Streaming publish point on an IIS server. Elemental Live acts as a + // "Push" encoder to IIS. // // This member is required. Destination *OutputLocationRef @@ -3968,15 +3935,10 @@ type MsSmoothGroupSettings struct { // Specifies whether or not to send an event ID to the IIS server. If no event ID // is sent and the same Live Event is used without changing the publishing point, // clients might see cached video from the previous run. Options: - // - // * - // "useConfigured" - use the value provided in eventId - // - // * "useTimestamp" - generate - // and send an event ID based on the current timestamp - // - // * "noEventId" - do not send - // an event ID to the IIS server. + // - "useConfigured" - use the value provided in eventId + // - "useTimestamp" - generate and send an event ID based on the current + // timestamp + // - "noEventId" - do not send an event ID to the IIS server. EventIdMode SmoothGroupEventIdMode // When set to sendEos, send EOS signal to IIS server when stopping the event @@ -4007,17 +3969,11 @@ type MsSmoothGroupSettings struct { SendDelayMs int32 // Identifies the type of data to place in the sparse track: - // - // * SCTE35: Insert - // SCTE-35 messages from the source content. With each message, insert an IDR frame - // to start a new segment. - // - // * SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages - // from the source content. With each message, insert an IDR frame but don't start - // a new segment. - // - // * NONE: Don't generate a sparse track for any outputs in this - // output group. + // - SCTE35: Insert SCTE-35 messages from the source content. With each message, + // insert an IDR frame to start a new segment. + // - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source + // content. With each message, insert an IDR frame but don't start a new segment. + // - NONE: Don't generate a sparse track for any outputs in this output group. SparseTrackType SmoothGroupSparseTrackType // When set to send, send stream manifest so publishing point doesn't start until @@ -4029,12 +3985,8 @@ type MsSmoothGroupSettings struct { TimestampOffset *string // Type of timestamp date offset to use. - // - // * useEventStartDate: Use the date the - // event was started as the offset - // - // * useConfiguredOffset: Use an explicitly - // configured date as the offset + // - useEventStartDate: Use the date the event was started as the offset + // - useConfiguredOffset: Use an explicitly configured date as the offset TimestampOffsetMode SmoothGroupTimestampOffsetMode noSmithyDocumentSerde @@ -4152,10 +4104,10 @@ type MultiplexProgram struct { // Multiplex type MultiplexProgramChannelDestinationSettings struct { - // The ID of the Multiplex that the encoder is providing output to. You do not need - // to specify the individual inputs to the Multiplex; MediaLive will handle the - // connection of the two MediaLive pipelines to the two Multiplex instances. The - // Multiplex must be in the same region as the Channel. + // The ID of the Multiplex that the encoder is providing output to. You do not + // need to specify the individual inputs to the Multiplex; MediaLive will handle + // the connection of the two MediaLive pipelines to the two Multiplex instances. + // The Multiplex must be in the same region as the Channel. MultiplexId *string // The program name of the Multiplex program that the encoder is providing output @@ -4375,11 +4327,12 @@ type NetworkInputSettings struct { // Specifies HLS input settings when the uri is for a HLS manifest. HlsInputSettings *HlsInputSettings - // Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography - // in the certificate will be checked, but not the server's name. Certain - // subdomains (notably S3 buckets that use dots in the bucket name) do not strictly - // match the corresponding certificate's wildcard pattern and would otherwise cause - // the event to error. This setting is ignored for protocols that do not use https. + // Check HTTPS server certificates. When set to checkCryptographyOnly, + // cryptography in the certificate will be checked, but not the server's name. + // Certain subdomains (notably S3 buckets that use dots in the bucket name) do not + // strictly match the corresponding certificate's wildcard pattern and would + // otherwise cause the event to error. This setting is ignored for protocols that + // do not use https. ServerValidation NetworkInputServerValidation noSmithyDocumentSerde @@ -4446,15 +4399,12 @@ type NielsenWatermarksSettings struct { NielsenCbetSettings *NielsenCBET // Choose the distribution types that you want to assign to the watermarks: - // - // * - // PROGRAM_CONTENT - // - // * FINAL_DISTRIBUTOR + // - PROGRAM_CONTENT + // - FINAL_DISTRIBUTOR NielsenDistributionType NielsenWatermarksDistributionTypes - // Complete these fields only if you want to insert watermarks of type Nielsen NAES - // II (N2) and Nielsen NAES VI (NW). + // Complete these fields only if you want to insert watermarks of type Nielsen + // NAES II (N2) and Nielsen NAES VI (NW). NielsenNaesIiNwSettings *NielsenNaesIiNw noSmithyDocumentSerde @@ -4479,8 +4429,8 @@ type Offering struct { // One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering FixedPrice float64 - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard + // VQ in US West (Oregon)' OfferingDescription *string // Unique offering ID, e.g. '87654321' @@ -4562,8 +4512,8 @@ type OutputDestinationSettings struct { noSmithyDocumentSerde } -// Output groups for this Live Event. Output groups contain information about where -// streams should be distributed. +// Output groups for this Live Event. Output groups contain information about +// where streams should be distributed. type OutputGroup struct { // Settings associated with the output group. @@ -4772,8 +4722,8 @@ type Reservation struct { // User specified reservation name Name *string - // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ - // in US West (Oregon)' + // Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard + // VQ in US West (Oregon)' OfferingDescription *string // Unique offering ID, e.g. '87654321' @@ -4848,9 +4798,9 @@ type RtmpCaptionInfoDestinationSettings struct { // Rtmp Group Settings type RtmpGroupSettings struct { - // Choose the ad marker type for this output group. MediaLive will create a message - // based on the content of each SCTE-35 message, format it for that marker type, - // and insert it in the datastream. + // Choose the ad marker type for this output group. MediaLive will create a + // message based on the content of each SCTE-35 message, format it for that marker + // type, and insert it in the datastream. AdMarkers []RtmpAdMarkers // Authentication scheme to use when connecting with CDN @@ -4868,20 +4818,17 @@ type RtmpGroupSettings struct { // Cache length, in seconds, is used to calculate buffer size. CacheLength int32 - // Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' - // then 608 and 708 carried DTVCC data will be passed. If set to + // Controls the types of data that passes to onCaptionInfo outputs. If set to + // 'all' then 608 and 708 carried DTVCC data will be passed. If set to // 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from // both fields will be passed. If set to 'field1608' then only the data carried in // 608 from field 1 video will be passed. CaptionData RtmpCaptionData // Controls the behavior of this RTMP group if input becomes unavailable. - // - // * - // emitOutput: Emit a slate until input returns. - // - // * pauseOutput: Stop transmitting - // data until input returns. This does not close the underlying RTMP connection. + // - emitOutput: Emit a slate until input returns. + // - pauseOutput: Stop transmitting data until input returns. This does not + // close the underlying RTMP connection. InputLossAction InputLossActionForRtmpOut // If a streaming output fails, number of seconds to wait until a restart is @@ -4906,8 +4853,8 @@ type RtmpOutputSettings struct { // certificates to fail. CertificateMode RtmpOutputCertificateMode - // Number of seconds to wait before retrying a connection to the Flash Media server - // if the connection is lost. + // Number of seconds to wait before retrying a connection to the Flash Media + // server if the connection is lost. ConnectionRetryInterval int32 // Number of retry attempts. @@ -4986,8 +4933,8 @@ type ScheduleActionSettings struct { noSmithyDocumentSerde } -// Settings to specify when an action should occur. Only one of the options must be -// selected. +// Settings to specify when an action should occur. Only one of the options must +// be selected. type ScheduleActionStartSettings struct { // Option for specifying the start time for an action. @@ -5037,19 +4984,13 @@ type Scte27SourceSettings struct { // The pid field is used in conjunction with the caption selector languageCode // field as follows: - // - // * Specify PID and Language: Extracts captions from that PID; - // the language is "informational". - // - // * Specify PID and omit Language: Extracts the - // specified PID. - // - // * Omit PID and specify Language: Extracts the specified - // language, whichever PID that happens to be. - // - // * Omit PID and omit Language: Valid - // only if source is DVB-Sub that is being passed through; all languages will be - // passed through. + // - Specify PID and Language: Extracts captions from that PID; the language is + // "informational". + // - Specify PID and omit Language: Extracts the specified PID. + // - Omit PID and specify Language: Extracts the specified language, whichever + // PID that happens to be. + // - Omit PID and omit Language: Valid only if source is DVB-Sub that is being + // passed through; all languages will be passed through. Pid int32 noSmithyDocumentSerde @@ -5196,9 +5137,9 @@ type Scte35SegmentationDescriptor struct { // signal placement opportunities, breaks, and advertisements. type Scte35SpliceInsert struct { - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. This only applies to embedded SCTE 104/35 messages and does not apply to - // OOB messages. + // When specified, this offset (in milliseconds) is added to the input Ad Avail + // PTS time. This only applies to embedded SCTE 104/35 messages and does not apply + // to OOB messages. AdAvailOffset int32 // When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 @@ -5235,9 +5176,9 @@ type Scte35SpliceInsertScheduleActionSettings struct { // placement opportunities and breaks. type Scte35TimeSignalApos struct { - // When specified, this offset (in milliseconds) is added to the input Ad Avail PTS - // time. This only applies to embedded SCTE 104/35 messages and does not apply to - // OOB messages. + // When specified, this offset (in milliseconds) is added to the input Ad Avail + // PTS time. This only applies to embedded SCTE 104/35 messages and does not apply + // to OOB messages. AdAvailOffset int32 // When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 @@ -5303,8 +5244,8 @@ type StaticImageActivateScheduleActionSettings struct { // This member is required. Image *InputLocation - // The duration in milliseconds for the image to remain on the video. If omitted or - // set to 0 the duration is unlimited and the image will remain until it is + // The duration in milliseconds for the image to remain on the video. If omitted + // or set to 0 the duration is unlimited and the image will remain until it is // explicitly deactivated. Duration int32 @@ -5322,8 +5263,8 @@ type StaticImageActivateScheduleActionSettings struct { // height of the overlay. Height int32 - // Placement of the left edge of the overlay relative to the left edge of the video - // frame, in pixels. 0 (the default) is the left edge of the frame. If the + // Placement of the left edge of the overlay relative to the left edge of the + // video frame, in pixels. 0 (the default) is the left edge of the frame. If the // placement causes the overlay to extend beyond the right edge of the underlying // video, then the overlay is cropped on the right. ImageX int32 @@ -5343,9 +5284,9 @@ type StaticImageActivateScheduleActionSettings struct { // Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. Opacity int32 - // The width of the image when inserted into the video, in pixels. The overlay will - // be scaled up or down to the specified width. Leave blank to use the native width - // of the overlay. + // The width of the image when inserted into the video, in pixels. The overlay + // will be scaled up or down to the specified width. Leave blank to use the native + // width of the overlay. Width int32 noSmithyDocumentSerde @@ -5416,13 +5357,10 @@ type TeletextSourceSettings struct { type TemporalFilterSettings struct { // If you enable this filter, the results are the following: - // - // * If the source - // content is noisy (it contains excessive digital artifacts), the filter cleans up - // the source. - // - // * If the source content is already clean, the filter tends to - // decrease the bitrate, especially when the rate control mode is QVBR. + // - If the source content is noisy (it contains excessive digital artifacts), + // the filter cleans up the source. + // - If the source content is already clean, the filter tends to decrease the + // bitrate, especially when the rate control mode is QVBR. PostFilterSharpening TemporalFilterPostFilterSharpening // Choose a filter strength. We recommend a strength of 1 or 2. A higher strength @@ -5545,10 +5483,10 @@ type UdpOutputSettings struct { // This member is required. Destination *OutputLocationRef - // UDP output buffering in milliseconds. Larger values increase latency through the - // transcoder but simultaneously assist the transcoder in maintaining a constant, - // low-jitter UDP/RTP output while accommodating clock recovery, input switching, - // input disruptions, picture reordering, etc. + // UDP output buffering in milliseconds. Larger values increase latency through + // the transcoder but simultaneously assist the transcoder in maintaining a + // constant, low-jitter UDP/RTP output while accommodating clock recovery, input + // switching, input disruptions, picture reordering, etc. BufferMsec int32 // Settings for enabling and adjusting Forward Error Correction on UDP outputs. @@ -5621,8 +5559,8 @@ type VideoDescription struct { // Video codec settings. CodecSettings *VideoCodecSettings - // Output video height, in pixels. Must be an even number. For most codecs, you can - // leave this field and width blank in order to use the height and width + // Output video height, in pixels. Must be an even number. For most codecs, you + // can leave this field and width blank in order to use the height and width // (resolution) from the source. Note, however, that leaving blank is not // recommended. For the Frame Capture codec, height and width are required. Height int32 @@ -5645,8 +5583,9 @@ type VideoDescription struct { // around the video to provide the specified output resolution. ScalingBehavior VideoDescriptionScalingBehavior - // Changes the strength of the anti-alias filter used for scaling. 0 is the softest - // setting, 100 is the sharpest. A setting of 50 is recommended for most content. + // Changes the strength of the anti-alias filter used for scaling. 0 is the + // softest setting, 100 is the sharpest. A setting of 50 is recommended for most + // content. Sharpness int32 // Output video width, in pixels. Must be an even number. For most codecs, you can @@ -5670,8 +5609,8 @@ type VideoSelector struct { // Color space settings ColorSpaceSettings *VideoSelectorColorSpaceSettings - // Applies only if colorSpace is a value other than follow. This field controls how - // the value in the colorSpace field will be used. fallback means that when the + // Applies only if colorSpace is a value other than follow. This field controls + // how the value in the colorSpace field will be used. fallback means that when the // input does include color space data, that data will be used, but when the input // has no color space data, the value in colorSpace will be used. Choose fallback // if your input is sometimes missing color space data, but when it does have color @@ -5731,8 +5670,8 @@ type VideoSelectorSettings struct { // output egress addresses will be created in a user specified VPC type VpcOutputSettings struct { - // A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must - // be mapped to two unique availability zones (AZ). + // A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs + // must be mapped to two unique availability zones (AZ). // // This member is required. SubnetIds []string @@ -5742,9 +5681,9 @@ type VpcOutputSettings struct { // channels PublicAddressAllocationIds []string - // A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network - // interfaces. If none are specified then the VPC default security group will be - // used + // A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC + // network interfaces. If none are specified then the VPC default security group + // will be used SecurityGroupIds []string noSmithyDocumentSerde @@ -5753,9 +5692,9 @@ type VpcOutputSettings struct { // The properties for a private VPC Output type VpcOutputSettingsDescription struct { - // The Availability Zones where the vpc subnets are located. The first Availability - // Zone applies to the first subnet in the list of subnets. The second Availability - // Zone applies to the second subnet. + // The Availability Zones where the vpc subnets are located. The first + // Availability Zone applies to the first subnet in the list of subnets. The second + // Availability Zone applies to the second subnet. AvailabilityZones []string // A list of Elastic Network Interfaces created by MediaLive in the customer's VPC @@ -5765,8 +5704,8 @@ type VpcOutputSettingsDescription struct { // interfaces. SecurityGroupIds []string - // A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must - // be mapped to two unique availability zones (AZ). + // A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs + // must be mapped to two unique availability zones (AZ). SubnetIds []string noSmithyDocumentSerde @@ -5791,10 +5730,10 @@ type WavSettings struct { // Webvtt Destination Settings type WebvttDestinationSettings struct { - // Controls whether the color and position of the source captions is passed through - // to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions - // are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The - // output captions will not contain any font styling information. + // Controls whether the color and position of the source captions is passed + // through to the WebVTT output captions. PASSTHROUGH - Valid only if the source + // captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. + // The output captions will not contain any font styling information. StyleControl WebvttDestinationStyleControl noSmithyDocumentSerde diff --git a/service/mediapackage/api_client.go b/service/mediapackage/api_client.go index 39a119618ab..9745bd467fe 100644 --- a/service/mediapackage/api_client.go +++ b/service/mediapackage/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediapackage/api_op_ListOriginEndpoints.go b/service/mediapackage/api_op_ListOriginEndpoints.go index 0ece10cbcf0..bf44e652821 100644 --- a/service/mediapackage/api_op_ListOriginEndpoints.go +++ b/service/mediapackage/api_op_ListOriginEndpoints.go @@ -30,8 +30,8 @@ func (c *Client) ListOriginEndpoints(ctx context.Context, params *ListOriginEndp type ListOriginEndpointsInput struct { - // When specified, the request will return only OriginEndpoints associated with the - // given Channel ID. + // When specified, the request will return only OriginEndpoints associated with + // the given Channel ID. ChannelId *string // The upper bound on the number of records to return. @@ -117,8 +117,8 @@ func (c *Client) addOperationListOriginEndpointsMiddlewares(stack *middleware.St return nil } -// ListOriginEndpointsAPIClient is a client that implements the ListOriginEndpoints -// operation. +// ListOriginEndpointsAPIClient is a client that implements the +// ListOriginEndpoints operation. type ListOriginEndpointsAPIClient interface { ListOriginEndpoints(context.Context, *ListOriginEndpointsInput, ...func(*Options)) (*ListOriginEndpointsOutput, error) } diff --git a/service/mediapackage/types/enums.go b/service/mediapackage/types/enums.go index bad1e7f1fba..2626daa688d 100644 --- a/service/mediapackage/types/enums.go +++ b/service/mediapackage/types/enums.go @@ -39,8 +39,8 @@ const ( PeriodTriggersElementAds PeriodTriggersElement = "ADS" ) -// Values returns all known values for PeriodTriggersElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PeriodTriggersElement. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PeriodTriggersElement) Values() []PeriodTriggersElement { return []PeriodTriggersElement{ @@ -58,9 +58,9 @@ const ( AdMarkersDaterange AdMarkers = "DATERANGE" ) -// Values returns all known values for AdMarkers. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AdMarkers. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AdMarkers) Values() []AdMarkers { return []AdMarkers{ "NONE", @@ -173,9 +173,9 @@ const ( PlaylistTypeVod PlaylistType = "VOD" ) -// Values returns all known values for PlaylistType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PlaylistType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PlaylistType) Values() []PlaylistType { return []PlaylistType{ "NONE", @@ -273,8 +273,8 @@ const ( SegmentTemplateFormatNumberWithDuration SegmentTemplateFormat = "NUMBER_WITH_DURATION" ) -// Values returns all known values for SegmentTemplateFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SegmentTemplateFormat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SegmentTemplateFormat) Values() []SegmentTemplateFormat { return []SegmentTemplateFormat{ @@ -334,9 +334,9 @@ const ( UtcTimingHttpXsdate UtcTiming = "HTTP-XSDATE" ) -// Values returns all known values for UtcTiming. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for UtcTiming. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (UtcTiming) Values() []UtcTiming { return []UtcTiming{ "NONE", diff --git a/service/mediapackage/types/types.go b/service/mediapackage/types/types.go index e993b695e81..81a90a305f1 100644 --- a/service/mediapackage/types/types.go +++ b/service/mediapackage/types/types.go @@ -142,9 +142,9 @@ type DashEncryption struct { // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. type DashPackage struct { - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. + // A list of SCTE-35 message types that are treated as ad markers in the output. + // If empty, no ad markers are output. Specify multiple items to create ad markers + // for all of the included message types. AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation @@ -202,8 +202,8 @@ type DashPackage struct { // Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is // presented in each SegmentTemplate, with $Number$ media URLs. When set to // TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with - // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included - // in each SegmentTemplate, with $Number$ media URLs. + // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is + // included in each SegmentTemplate, with $Number$ media URLs. SegmentTemplateFormat SegmentTemplateFormat // A StreamSelection configuration. @@ -347,9 +347,9 @@ type HlsManifest struct { // must set a programDateTimeIntervalSeconds value that is greater than 0. AdMarkers AdMarkers - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. + // A list of SCTE-35 message types that are treated as ad markers in the output. + // If empty, no ad markers are output. Specify multiple items to create ad markers + // for all of the included message types. AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation @@ -379,8 +379,8 @@ type HlsManifest struct { // Time window (in seconds) contained in each parent manifest. PlaylistWindowSeconds int32 - // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into - // manifests. Additionally, when an interval is specified ID3Timed Metadata + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted + // into manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. // If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME // tags will be inserted into manifests and no ID3Timed Metadata messages will be @@ -414,9 +414,9 @@ type HlsManifestCreateOrUpdateParameters struct { // must set a programDateTimeIntervalSeconds value that is greater than 0. AdMarkers AdMarkers - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. + // A list of SCTE-35 message types that are treated as ad markers in the output. + // If empty, no ad markers are output. Specify multiple items to create ad markers + // for all of the included message types. AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation @@ -446,8 +446,8 @@ type HlsManifestCreateOrUpdateParameters struct { // Time window (in seconds) contained in each parent manifest. PlaylistWindowSeconds int32 - // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into - // manifests. Additionally, when an interval is specified ID3Timed Metadata + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted + // into manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. // If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME // tags will be inserted into manifests and no ID3Timed Metadata messages will be @@ -472,9 +472,9 @@ type HlsPackage struct { // must set a programDateTimeIntervalSeconds value that is greater than 0. AdMarkers AdMarkers - // A list of SCTE-35 message types that are treated as ad markers in the output. If - // empty, no ad markers are output. Specify multiple items to create ad markers for - // all of the included message types. + // A list of SCTE-35 message types that are treated as ad markers in the output. + // If empty, no ad markers are output. Specify multiple items to create ad markers + // for all of the included message types. AdTriggers []AdTriggersElement // This setting allows the delivery restriction flags on SCTE-35 segmentation @@ -507,8 +507,8 @@ type HlsPackage struct { // Time window (in seconds) contained in each parent manifest. PlaylistWindowSeconds int32 - // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into - // manifests. Additionally, when an interval is specified ID3Timed Metadata + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted + // into manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. // If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME // tags will be inserted into manifests and no ID3Timed Metadata messages will be diff --git a/service/mediapackagevod/api_client.go b/service/mediapackagevod/api_client.go index dbb576fb0f4..e412a751f2f 100644 --- a/service/mediapackagevod/api_client.go +++ b/service/mediapackagevod/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediapackagevod/api_op_ListPackagingGroups.go b/service/mediapackagevod/api_op_ListPackagingGroups.go index d3e50a5fd21..0f950087ea4 100644 --- a/service/mediapackagevod/api_op_ListPackagingGroups.go +++ b/service/mediapackagevod/api_op_ListPackagingGroups.go @@ -113,8 +113,8 @@ func (c *Client) addOperationListPackagingGroupsMiddlewares(stack *middleware.St return nil } -// ListPackagingGroupsAPIClient is a client that implements the ListPackagingGroups -// operation. +// ListPackagingGroupsAPIClient is a client that implements the +// ListPackagingGroups operation. type ListPackagingGroupsAPIClient interface { ListPackagingGroups(context.Context, *ListPackagingGroupsInput, ...func(*Options)) (*ListPackagingGroupsOutput, error) } diff --git a/service/mediapackagevod/doc.go b/service/mediapackagevod/doc.go index 5c5ff212b7b..981da0fe56f 100644 --- a/service/mediapackagevod/doc.go +++ b/service/mediapackagevod/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package mediapackagevod provides the API client, operations, and parameter types -// for AWS Elemental MediaPackage VOD. +// Package mediapackagevod provides the API client, operations, and parameter +// types for AWS Elemental MediaPackage VOD. // // AWS Elemental MediaPackage VOD package mediapackagevod diff --git a/service/mediapackagevod/types/enums.go b/service/mediapackagevod/types/enums.go index 07489f3e5ed..9deaa430e41 100644 --- a/service/mediapackagevod/types/enums.go +++ b/service/mediapackagevod/types/enums.go @@ -9,8 +9,8 @@ const ( PeriodTriggersElementAds PeriodTriggersElement = "ADS" ) -// Values returns all known values for PeriodTriggersElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PeriodTriggersElement. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PeriodTriggersElement) Values() []PeriodTriggersElement { return []PeriodTriggersElement{ @@ -27,9 +27,9 @@ const ( AdMarkersPassthrough AdMarkers = "PASSTHROUGH" ) -// Values returns all known values for AdMarkers. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AdMarkers. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AdMarkers) Values() []AdMarkers { return []AdMarkers{ "NONE", @@ -177,8 +177,8 @@ const ( SegmentTemplateFormatNumberWithDuration SegmentTemplateFormat = "NUMBER_WITH_DURATION" ) -// Values returns all known values for SegmentTemplateFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SegmentTemplateFormat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SegmentTemplateFormat) Values() []SegmentTemplateFormat { return []SegmentTemplateFormat{ diff --git a/service/mediapackagevod/types/types.go b/service/mediapackagevod/types/types.go index 03e57607497..243418ba1c9 100644 --- a/service/mediapackagevod/types/types.go +++ b/service/mediapackagevod/types/types.go @@ -175,8 +175,8 @@ type DashPackage struct { // Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is // presented in each SegmentTemplate, with $Number$ media URLs. When set to // TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with - // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included - // in each SegmentTemplate, with $Number$ media URLs. + // $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is + // included in each SegmentTemplate, with $Number$ media URLs. SegmentTemplateFormat SegmentTemplateFormat noSmithyDocumentSerde @@ -197,9 +197,10 @@ type EgressEndpoint struct { // The ID of the PackagingConfiguration being applied to the Asset. PackagingConfigurationId *string - // The current processing status of the asset used for the packaging configuration. - // The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status - // information won't be available for most assets ingested before 2021-09-30. + // The current processing status of the asset used for the packaging + // configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. + // Status information won't be available for most assets ingested before + // 2021-09-30. Status *string // The URL of the parent manifest for the repackaged Asset. @@ -268,8 +269,8 @@ type HlsManifest struct { // An optional string to include in the name of the manifest. ManifestName *string - // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into - // manifests. Additionally, when an interval is specified ID3Timed Metadata + // The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted + // into manifests. Additionally, when an interval is specified ID3Timed Metadata // messages will be generated every 5 seconds using the ingest time of the content. // If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME // tags will be inserted into manifests and no ID3Timed Metadata messages will be diff --git a/service/mediastore/api_client.go b/service/mediastore/api_client.go index 776eab51477..a04b348fa3b 100644 --- a/service/mediastore/api_client.go +++ b/service/mediastore/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediastore/api_op_CreateContainer.go b/service/mediastore/api_op_CreateContainer.go index 7781992d92c..726b5154433 100644 --- a/service/mediastore/api_op_CreateContainer.go +++ b/service/mediastore/api_op_CreateContainer.go @@ -30,10 +30,10 @@ func (c *Client) CreateContainer(ctx context.Context, params *CreateContainerInp type CreateContainerInput struct { - // The name for the container. The name must be from 1 to 255 characters. Container - // names must be unique to your AWS account within a specific region. As an - // example, you could create a container named movies in every region, as long as - // you don’t have an existing container with that name. + // The name for the container. The name must be from 1 to 255 characters. + // Container names must be unique to your AWS account within a specific region. As + // an example, you could create a container named movies in every region, as long + // as you don’t have an existing container with that name. // // This member is required. ContainerName *string @@ -43,8 +43,8 @@ type CreateContainerInput struct { // and the tag value represents a specific value within that category (such as // "test," "development," or "production"). You can add up to 50 tags to each // container. For more information about tagging, including naming and usage - // conventions, see Tagging Resources in MediaStore - // (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html). + // conventions, see Tagging Resources in MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -52,16 +52,16 @@ type CreateContainerInput struct { type CreateContainerOutput struct { - // ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The - // ARN has the following format: arn:aws:::container/. For example: + // ContainerARN: The Amazon Resource Name (ARN) of the newly created container. + // The ARN has the following format: arn:aws:::container/. For example: // arn:aws:mediastore:us-west-2:111122223333:container/movies ContainerName: The // container name as specified in the request. CreationTime: Unix time stamp. // Status: The status of container creation or deletion. The status is one of the - // following: CREATING, ACTIVE, or DELETING. While the service is creating the - // container, the status is CREATING. When an endpoint is available, the status - // changes to ACTIVE. The return value does not include the container's endpoint. + // following: CREATING , ACTIVE , or DELETING . While the service is creating the + // container, the status is CREATING . When an endpoint is available, the status + // changes to ACTIVE . The return value does not include the container's endpoint. // To make downstream requests, you must obtain this value by using - // DescribeContainer or ListContainers. + // DescribeContainer or ListContainers . // // This member is required. Container *types.Container diff --git a/service/mediastore/api_op_DescribeContainer.go b/service/mediastore/api_op_DescribeContainer.go index 81904424afa..c6ca9eb72ad 100644 --- a/service/mediastore/api_op_DescribeContainer.go +++ b/service/mediastore/api_op_DescribeContainer.go @@ -15,8 +15,8 @@ import ( // used to retrieve the endpoint of a container. An endpoint is a value assigned by // the service when a new container is created. A container's endpoint does not // change after it has been assigned. The DescribeContainer request returns a -// single Container object based on ContainerName. To return all Container objects -// that are associated with a specified AWS account, use ListContainers. +// single Container object based on ContainerName . To return all Container +// objects that are associated with a specified AWS account, use ListContainers . func (c *Client) DescribeContainer(ctx context.Context, params *DescribeContainerInput, optFns ...func(*Options)) (*DescribeContainerOutput, error) { if params == nil { params = &DescribeContainerInput{} diff --git a/service/mediastore/api_op_GetContainerPolicy.go b/service/mediastore/api_op_GetContainerPolicy.go index 3ae0aa8b93a..cee447dc50d 100644 --- a/service/mediastore/api_op_GetContainerPolicy.go +++ b/service/mediastore/api_op_GetContainerPolicy.go @@ -12,7 +12,7 @@ import ( // Retrieves the access policy for the specified container. For information about // the data that is included in an access policy, see the AWS Identity and Access -// Management User Guide (https://aws.amazon.com/documentation/iam/). +// Management User Guide (https://aws.amazon.com/documentation/iam/) . func (c *Client) GetContainerPolicy(ctx context.Context, params *GetContainerPolicyInput, optFns ...func(*Options)) (*GetContainerPolicyOutput, error) { if params == nil { params = &GetContainerPolicyInput{} diff --git a/service/mediastore/api_op_GetCorsPolicy.go b/service/mediastore/api_op_GetCorsPolicy.go index e3d2de5b2d0..a9db63bede3 100644 --- a/service/mediastore/api_op_GetCorsPolicy.go +++ b/service/mediastore/api_op_GetCorsPolicy.go @@ -13,8 +13,8 @@ import ( // Returns the cross-origin resource sharing (CORS) configuration information that // is set for the container. To use this operation, you must have permission to -// perform the MediaStore:GetCorsPolicy action. By default, the container owner has -// this permission and can grant it to others. +// perform the MediaStore:GetCorsPolicy action. By default, the container owner +// has this permission and can grant it to others. func (c *Client) GetCorsPolicy(ctx context.Context, params *GetCorsPolicyInput, optFns ...func(*Options)) (*GetCorsPolicyOutput, error) { if params == nil { params = &GetCorsPolicyInput{} diff --git a/service/mediastore/api_op_ListContainers.go b/service/mediastore/api_op_ListContainers.go index 329a4e0d7d5..9d6861ceeea 100644 --- a/service/mediastore/api_op_ListContainers.go +++ b/service/mediastore/api_op_ListContainers.go @@ -18,7 +18,7 @@ import ( // In this case, the response includes a token. To get the next set of containers, // send the command again, this time with the NextToken parameter (with the // returned token as its value). The next set of responses appears, with a token if -// there are still more containers to receive. See also DescribeContainer, which +// there are still more containers to receive. See also DescribeContainer , which // gets the properties of one container. func (c *Client) ListContainers(ctx context.Context, params *ListContainersInput, optFns ...func(*Options)) (*ListContainersOutput, error) { if params == nil { @@ -57,7 +57,7 @@ type ListContainersOutput struct { // This member is required. Containers []types.Container - // NextToken is the token to use in the next call to ListContainers. This token is + // NextToken is the token to use in the next call to ListContainers . This token is // returned only if you included the MaxResults tag in the original command, and // only if there are still containers to return. NextToken *string diff --git a/service/mediastore/api_op_PutContainerPolicy.go b/service/mediastore/api_op_PutContainerPolicy.go index 28d45d3d449..7b9b5db64e0 100644 --- a/service/mediastore/api_op_PutContainerPolicy.go +++ b/service/mediastore/api_op_PutContainerPolicy.go @@ -12,10 +12,10 @@ import ( // Creates an access policy for the specified container to restrict the users and // clients that can access it. For information about the data that is included in -// an access policy, see the AWS Identity and Access Management User Guide -// (https://aws.amazon.com/documentation/iam/). For this release of the REST API, -// you can create only one policy for a container. If you enter PutContainerPolicy -// twice, the second command modifies the existing policy. +// an access policy, see the AWS Identity and Access Management User Guide (https://aws.amazon.com/documentation/iam/) +// . For this release of the REST API, you can create only one policy for a +// container. If you enter PutContainerPolicy twice, the second command modifies +// the existing policy. func (c *Client) PutContainerPolicy(ctx context.Context, params *PutContainerPolicyInput, optFns ...func(*Options)) (*PutContainerPolicyOutput, error) { if params == nil { params = &PutContainerPolicyInput{} @@ -39,11 +39,8 @@ type PutContainerPolicyInput struct { ContainerName *string // The contents of the policy, which includes the following: - // - // * One Version tag - // - // * - // One Statement tag that contains the standard tags for the policy. + // - One Version tag + // - One Statement tag that contains the standard tags for the policy. // // This member is required. Policy *string diff --git a/service/mediastore/api_op_PutCorsPolicy.go b/service/mediastore/api_op_PutCorsPolicy.go index 2539fbdd630..4929bdf40d9 100644 --- a/service/mediastore/api_op_PutCorsPolicy.go +++ b/service/mediastore/api_op_PutCorsPolicy.go @@ -21,8 +21,8 @@ import ( // The policy can contain up to 398,000 characters. You can add up to 100 rules to // a CORS policy. If more than one rule applies, the service uses the first // applicable rule listed. To learn more about CORS, see Cross-Origin Resource -// Sharing (CORS) in AWS Elemental MediaStore -// (https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html). +// Sharing (CORS) in AWS Elemental MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html) +// . func (c *Client) PutCorsPolicy(ctx context.Context, params *PutCorsPolicyInput, optFns ...func(*Options)) (*PutCorsPolicyOutput, error) { if params == nil { params = &PutCorsPolicyInput{} diff --git a/service/mediastore/api_op_PutLifecyclePolicy.go b/service/mediastore/api_op_PutLifecyclePolicy.go index a76b95f863a..17e238b4779 100644 --- a/service/mediastore/api_op_PutLifecyclePolicy.go +++ b/service/mediastore/api_op_PutLifecyclePolicy.go @@ -13,9 +13,9 @@ import ( // Writes an object lifecycle policy to a container. If the container already has // an object lifecycle policy, the service replaces the existing policy with the // new policy. It takes up to 20 minutes for the change to take effect. For -// information about how to construct an object lifecycle policy, see Components of -// an Object Lifecycle Policy -// (https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html). +// information about how to construct an object lifecycle policy, see Components +// of an Object Lifecycle Policy (https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html) +// . func (c *Client) PutLifecyclePolicy(ctx context.Context, params *PutLifecyclePolicyInput, optFns ...func(*Options)) (*PutLifecyclePolicyOutput, error) { if params == nil { params = &PutLifecyclePolicyInput{} diff --git a/service/mediastore/api_op_PutMetricPolicy.go b/service/mediastore/api_op_PutMetricPolicy.go index b5b6aaf8d1c..1d00a543983 100644 --- a/service/mediastore/api_op_PutMetricPolicy.go +++ b/service/mediastore/api_op_PutMetricPolicy.go @@ -41,17 +41,14 @@ type PutMetricPolicyInput struct { // You can also include up to five rules to define groups of objects that you want // MediaStore to send object-level metrics for. If you include rules in the policy, // construct each rule with both of the following: - // - // * An object group that defines - // which objects to include in the group. The definition can be a path or a file - // name, but it can't have more than 900 characters. Valid characters are: a-z, - // A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ - // (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable. - // - // * - // An object group name that allows you to refer to the object group. The name - // can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ - // (underscore). + // - An object group that defines which objects to include in the group. The + // definition can be a path or a file name, but it can't have more than 900 + // characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : + // (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). + // Wildcards (*) are acceptable. + // - An object group name that allows you to refer to the object group. The name + // can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ + // (underscore). // // This member is required. MetricPolicy *types.MetricPolicy diff --git a/service/mediastore/api_op_StartAccessLogging.go b/service/mediastore/api_op_StartAccessLogging.go index 82b24c3f502..59a05f09ec6 100644 --- a/service/mediastore/api_op_StartAccessLogging.go +++ b/service/mediastore/api_op_StartAccessLogging.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts access logging on the specified container. When you enable access logging -// on a container, MediaStore delivers access logs for objects stored in that -// container to Amazon CloudWatch Logs. +// Starts access logging on the specified container. When you enable access +// logging on a container, MediaStore delivers access logs for objects stored in +// that container to Amazon CloudWatch Logs. func (c *Client) StartAccessLogging(ctx context.Context, params *StartAccessLoggingInput, optFns ...func(*Options)) (*StartAccessLoggingOutput, error) { if params == nil { params = &StartAccessLoggingInput{} diff --git a/service/mediastore/api_op_StopAccessLogging.go b/service/mediastore/api_op_StopAccessLogging.go index abb4584cfe3..d0c0c9eb020 100644 --- a/service/mediastore/api_op_StopAccessLogging.go +++ b/service/mediastore/api_op_StopAccessLogging.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops access logging on the specified container. When you stop access logging on -// a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. +// Stops access logging on the specified container. When you stop access logging +// on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. // These access logs are not saved and are not retrievable. func (c *Client) StopAccessLogging(ctx context.Context, params *StopAccessLoggingInput, optFns ...func(*Options)) (*StopAccessLoggingOutput, error) { if params == nil { diff --git a/service/mediastore/api_op_TagResource.go b/service/mediastore/api_op_TagResource.go index a9d135c23d6..ad53434b84d 100644 --- a/service/mediastore/api_op_TagResource.go +++ b/service/mediastore/api_op_TagResource.go @@ -16,8 +16,8 @@ import ( // key might be "customer" and the tag value might be "companyA." You can specify // one or more tags to add to each container. You can add up to 50 tags to each // container. For more information about tagging, including naming and usage -// conventions, see Tagging Resources in MediaStore -// (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html). +// conventions, see Tagging Resources in MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/mediastore/types/enums.go b/service/mediastore/types/enums.go index b452cb11b75..3bb52b7f915 100644 --- a/service/mediastore/types/enums.go +++ b/service/mediastore/types/enums.go @@ -10,8 +10,8 @@ const ( ContainerLevelMetricsDisabled ContainerLevelMetrics = "DISABLED" ) -// Values returns all known values for ContainerLevelMetrics. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ContainerLevelMetrics. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ContainerLevelMetrics) Values() []ContainerLevelMetrics { return []ContainerLevelMetrics{ diff --git a/service/mediastore/types/types.go b/service/mediastore/types/types.go index 70329984366..10e2ef570ff 100644 --- a/service/mediastore/types/types.go +++ b/service/mediastore/types/types.go @@ -19,8 +19,8 @@ type Container struct { // The state of access logging on the container. This value is false by default, // indicating that AWS Elemental MediaStore does not send access logs to Amazon // CloudWatch Logs. When you enable access logging on the container, MediaStore - // changes this value to true, indicating that the service delivers access logs for - // objects stored in that container to CloudWatch Logs. + // changes this value to true , indicating that the service delivers access logs + // for objects stored in that container to CloudWatch Logs. AccessLoggingEnabled *bool // Unix timestamp. @@ -36,9 +36,9 @@ type Container struct { Name *string // The status of container creation or deletion. The status is one of the - // following: CREATING, ACTIVE, or DELETING. While the service is creating the - // container, the status is CREATING. When the endpoint is available, the status - // changes to ACTIVE. + // following: CREATING , ACTIVE , or DELETING . While the service is creating the + // container, the status is CREATING . When the endpoint is available, the status + // changes to ACTIVE . Status ContainerStatus noSmithyDocumentSerde @@ -57,10 +57,10 @@ type CorsRule struct { // This member is required. AllowedHeaders []string - // One or more response headers that you want users to be able to access from their - // applications (for example, from a JavaScript XMLHttpRequest object). Each CORS - // rule must have at least one AllowedOrigins element. The string value can include - // only one wildcard character (*), for example, http://*.example.com. + // One or more response headers that you want users to be able to access from + // their applications (for example, from a JavaScript XMLHttpRequest object). Each + // CORS rule must have at least one AllowedOrigins element. The string value can + // include only one wildcard character (*), for example, http://*.example.com. // Additionally, you can specify only one wildcard character to allow cross-origin // access for all origins. // @@ -89,8 +89,8 @@ type CorsRule struct { // you must indicate whether you want MediaStore to send container-level metrics. // You can also include rules to define groups of objects that you want MediaStore // to send object-level metrics for. To view examples of how to construct a metric -// policy for your use case, see Example Metric Policies -// (https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html). +// policy for your use case, see Example Metric Policies (https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html) +// . type MetricPolicy struct { // A setting to enable or disable metrics at the container level. @@ -101,19 +101,18 @@ type MetricPolicy struct { // A parameter that holds an array of rules that enable metrics at the object // level. This parameter is optional, but if you choose to include it, you must // also include at least one rule. By default, you can include up to five rules. - // You can also request a quota increase - // (https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) + // You can also request a quota increase (https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) // to allow up to 300 rules per policy. MetricPolicyRules []MetricPolicyRule noSmithyDocumentSerde } -// A setting that enables metrics at the object level. Each rule contains an object -// group and an object group name. If the policy includes the MetricPolicyRules -// parameter, you must include at least one rule. Each metric policy can include up -// to five rules by default. You can also request a quota increase -// (https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) +// A setting that enables metrics at the object level. Each rule contains an +// object group and an object group name. If the policy includes the +// MetricPolicyRules parameter, you must include at least one rule. Each metric +// policy can include up to five rules by default. You can also request a quota +// increase (https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas) // to allow up to 300 rules per policy. type MetricPolicyRule struct { @@ -137,11 +136,12 @@ type MetricPolicyRule struct { // specific value within that category (such as "test," "development," or // "production"). You can add up to 50 tags to each container. For more information // about tagging, including naming and usage conventions, see Tagging Resources in -// MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html). +// MediaStore (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html) . type Tag struct { - // Part of the key:value pair that defines a tag. You can use a tag key to describe - // a category of information, such as "customer." Tag keys are case-sensitive. + // Part of the key:value pair that defines a tag. You can use a tag key to + // describe a category of information, such as "customer." Tag keys are + // case-sensitive. // // This member is required. Key *string diff --git a/service/mediastoredata/api_client.go b/service/mediastoredata/api_client.go index 31726e84f11..d5365eaa0d7 100644 --- a/service/mediastoredata/api_client.go +++ b/service/mediastoredata/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediastoredata/api_op_DescribeObject.go b/service/mediastoredata/api_op_DescribeObject.go index a2e89434a27..95c407d1732 100644 --- a/service/mediastoredata/api_op_DescribeObject.go +++ b/service/mediastoredata/api_op_DescribeObject.go @@ -42,9 +42,8 @@ type DescribeObjectOutput struct { // An optional CacheControl header that allows the caller to control the object's // cache behavior. Headers can be passed in as specified in the HTTP at - // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with - // a custom user-defined value are also accepted. + // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) + // . Headers with a custom user-defined value are also accepted. CacheControl *string // The length of the object in bytes. diff --git a/service/mediastoredata/api_op_GetObject.go b/service/mediastoredata/api_op_GetObject.go index c006263ccba..c89b8a2642c 100644 --- a/service/mediastoredata/api_op_GetObject.go +++ b/service/mediastoredata/api_op_GetObject.go @@ -13,7 +13,7 @@ import ( ) // Downloads the object at the specified path. If the object’s upload availability -// is set to streaming, AWS Elemental MediaStore downloads the object even if it’s +// is set to streaming , AWS Elemental MediaStore downloads the object even if it’s // still uploading the object. func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error) { if params == nil { @@ -34,28 +34,26 @@ type GetObjectInput struct { // The path (including the file name) where the object is stored in the container. // Format: // For example, to upload the file mlaw.avi to the folder path - // premium\canada in the container movies, enter the path premium/canada/mlaw.avi. - // Do not include the container name in this path. If the path includes any folders - // that don't exist yet, the service creates them. For example, suppose you have an - // existing premium/usa subfolder. If you specify premium/canada, the service - // creates a canada subfolder in the premium folder. You then have two subfolders, - // usa and canada, in the premium folder. There is no correlation between the path - // to the source and the path (folders) in the container in AWS Elemental - // MediaStore. For more information about folders and how they exist in a - // container, see the AWS Elemental MediaStore User Guide - // (http://docs.aws.amazon.com/mediastore/latest/ug/). The file name is the name - // that is assigned to the file that you upload. The file can have the same name - // inside and outside of AWS Elemental MediaStore, or it can have the same name. - // The file name can include or omit an extension. + // premium\canada in the container movies , enter the path premium/canada/mlaw.avi + // . Do not include the container name in this path. If the path includes any + // folders that don't exist yet, the service creates them. For example, suppose you + // have an existing premium/usa subfolder. If you specify premium/canada , the + // service creates a canada subfolder in the premium folder. You then have two + // subfolders, usa and canada , in the premium folder. There is no correlation + // between the path to the source and the path (folders) in the container in AWS + // Elemental MediaStore. For more information about folders and how they exist in a + // container, see the AWS Elemental MediaStore User Guide (http://docs.aws.amazon.com/mediastore/latest/ug/) + // . The file name is the name that is assigned to the file that you upload. The + // file can have the same name inside and outside of AWS Elemental MediaStore, or + // it can have the same name. The file name can include or omit an extension. // // This member is required. Path *string // The range bytes of an object to retrieve. For more information about the Range - // header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35). AWS Elemental - // MediaStore ignores this header for partially uploaded objects that have - // streaming upload availability. + // header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35) + // . AWS Elemental MediaStore ignores this header for partially uploaded objects + // that have streaming upload availability. Range *string noSmithyDocumentSerde @@ -75,9 +73,8 @@ type GetObjectOutput struct { // An optional CacheControl header that allows the caller to control the object's // cache behavior. Headers can be passed in as specified in the HTTP spec at - // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with - // a custom user-defined value are also accepted. + // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) + // . Headers with a custom user-defined value are also accepted. CacheControl *string // The length of the object in bytes. diff --git a/service/mediastoredata/api_op_ListItems.go b/service/mediastoredata/api_op_ListItems.go index e79c3875796..4ea36a2d493 100644 --- a/service/mediastoredata/api_op_ListItems.go +++ b/service/mediastoredata/api_op_ListItems.go @@ -31,20 +31,20 @@ func (c *Client) ListItems(ctx context.Context, params *ListItemsInput, optFns . type ListItemsInput struct { - // The maximum number of results to return per API request. For example, you submit - // a ListItems request with MaxResults set at 500. Although 2,000 items match your - // request, the service returns no more than the first 500 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 1,000 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListItems request with MaxResults set at 500. Although 2,000 items + // match your request, the service returns no more than the first 500 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to + // pagination with a maximum of 1,000 results per page. MaxResults *int32 // The token that identifies which batch of results that you want to see. For // example, you submit a ListItems request with MaxResults set at 500. The service - // returns the first batch of results (up to 500) and a NextToken value. To see the - // next batch of results, you can submit the ListItems request a second time and - // specify the NextToken value. Tokens expire after 15 minutes. + // returns the first batch of results (up to 500) and a NextToken value. To see + // the next batch of results, you can submit the ListItems request a second time + // and specify the NextToken value. Tokens expire after 15 minutes. NextToken *string // The path in the container from which to retrieve items. Format: // @@ -139,13 +139,13 @@ var _ ListItemsAPIClient = (*Client)(nil) // ListItemsPaginatorOptions is the paginator options for ListItems type ListItemsPaginatorOptions struct { - // The maximum number of results to return per API request. For example, you submit - // a ListItems request with MaxResults set at 500. Although 2,000 items match your - // request, the service returns no more than the first 500 items. (The service also - // returns a NextToken value that you can use to fetch the next batch of results.) - // The service might return fewer results than the MaxResults value. If MaxResults - // is not included in the request, the service defaults to pagination with a - // maximum of 1,000 results per page. + // The maximum number of results to return per API request. For example, you + // submit a ListItems request with MaxResults set at 500. Although 2,000 items + // match your request, the service returns no more than the first 500 items. (The + // service also returns a NextToken value that you can use to fetch the next batch + // of results.) The service might return fewer results than the MaxResults value. + // If MaxResults is not included in the request, the service defaults to + // pagination with a maximum of 1,000 results per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mediastoredata/api_op_PutObject.go b/service/mediastoredata/api_op_PutObject.go index d322bd75799..ffbcc14ee61 100644 --- a/service/mediastoredata/api_op_PutObject.go +++ b/service/mediastoredata/api_op_PutObject.go @@ -38,28 +38,26 @@ type PutObjectInput struct { // The path (including the file name) where the object is stored in the container. // Format: // For example, to upload the file mlaw.avi to the folder path - // premium\canada in the container movies, enter the path premium/canada/mlaw.avi. - // Do not include the container name in this path. If the path includes any folders - // that don't exist yet, the service creates them. For example, suppose you have an - // existing premium/usa subfolder. If you specify premium/canada, the service - // creates a canada subfolder in the premium folder. You then have two subfolders, - // usa and canada, in the premium folder. There is no correlation between the path - // to the source and the path (folders) in the container in AWS Elemental - // MediaStore. For more information about folders and how they exist in a - // container, see the AWS Elemental MediaStore User Guide - // (http://docs.aws.amazon.com/mediastore/latest/ug/). The file name is the name - // that is assigned to the file that you upload. The file can have the same name - // inside and outside of AWS Elemental MediaStore, or it can have the same name. - // The file name can include or omit an extension. + // premium\canada in the container movies , enter the path premium/canada/mlaw.avi + // . Do not include the container name in this path. If the path includes any + // folders that don't exist yet, the service creates them. For example, suppose you + // have an existing premium/usa subfolder. If you specify premium/canada , the + // service creates a canada subfolder in the premium folder. You then have two + // subfolders, usa and canada , in the premium folder. There is no correlation + // between the path to the source and the path (folders) in the container in AWS + // Elemental MediaStore. For more information about folders and how they exist in a + // container, see the AWS Elemental MediaStore User Guide (http://docs.aws.amazon.com/mediastore/latest/ug/) + // . The file name is the name that is assigned to the file that you upload. The + // file can have the same name inside and outside of AWS Elemental MediaStore, or + // it can have the same name. The file name can include or omit an extension. // // This member is required. Path *string // An optional CacheControl header that allows the caller to control the object's // cache behavior. Headers can be passed in as specified in the HTTP at - // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with - // a custom user-defined value are also accepted. + // https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) + // . Headers with a custom user-defined value are also accepted. CacheControl *string // The content type of the object. @@ -71,11 +69,11 @@ type PutObjectInput struct { StorageClass types.StorageClass // Indicates the availability of an object while it is still uploading. If the - // value is set to streaming, the object is available for downloading after some + // value is set to streaming , the object is available for downloading after some // initial buffering but before the object is uploaded completely. If the value is - // set to standard, the object is available for downloading only when it is - // uploaded completely. The default value for this header is standard. To use this - // header, you must also set the HTTP Transfer-Encoding header to chunked. + // set to standard , the object is available for downloading only when it is + // uploaded completely. The default value for this header is standard . To use this + // header, you must also set the HTTP Transfer-Encoding header to chunked . UploadAvailability types.UploadAvailability noSmithyDocumentSerde diff --git a/service/mediastoredata/types/enums.go b/service/mediastoredata/types/enums.go index 053dc895487..98e380f8358 100644 --- a/service/mediastoredata/types/enums.go +++ b/service/mediastoredata/types/enums.go @@ -27,9 +27,9 @@ const ( StorageClassTemporal StorageClass = "TEMPORAL" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "TEMPORAL", diff --git a/service/mediatailor/api_client.go b/service/mediatailor/api_client.go index ea670ea07e2..ea2daf00d4e 100644 --- a/service/mediatailor/api_client.go +++ b/service/mediatailor/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go b/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go index 19f6d87481e..0e8655cbbc4 100644 --- a/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go +++ b/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go @@ -31,12 +31,11 @@ type ConfigureLogsForPlaybackConfigurationInput struct { // The percentage of session logs that MediaTailor sends to your Cloudwatch Logs // account. For example, if your playback configuration has 1000 sessions and - // percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to + // percentEnabled is set to 60 , MediaTailor sends logs for 600 of the sessions to // CloudWatch Logs. MediaTailor decides at random which of the playback // configuration sessions to send logs for. If you want to view logs for a specific - // session, you can use the debug log mode - // (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html). Valid - // values: 0 - 100 + // session, you can use the debug log mode (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html) + // . Valid values: 0 - 100 // // This member is required. PercentEnabled int32 diff --git a/service/mediatailor/api_op_CreateChannel.go b/service/mediatailor/api_op_CreateChannel.go index a1be5d91c5c..9e1d845bd1a 100644 --- a/service/mediatailor/api_op_CreateChannel.go +++ b/service/mediatailor/api_op_CreateChannel.go @@ -13,8 +13,7 @@ import ( ) // Creates a channel. For information about MediaTailor channels, see Working with -// channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error) { if params == nil { @@ -52,15 +51,16 @@ type CreateChannelInput struct { // This member is required. PlaybackMode types.PlaybackMode - // The slate used to fill gaps between programs in the schedule. You must configure - // filler slate if your channel uses the LINEARPlaybackMode. MediaTailor doesn't - // support filler slate for channels using the LOOPPlaybackMode. + // The slate used to fill gaps between programs in the schedule. You must + // configure filler slate if your channel uses the LINEAR PlaybackMode . + // MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode + // . FillerSlate *types.SlateSource // The tags to assign to the channel. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The tier of the channel. @@ -99,7 +99,7 @@ type CreateChannelOutput struct { // The tags to assign to the channel. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The tier of the channel. diff --git a/service/mediatailor/api_op_CreateLiveSource.go b/service/mediatailor/api_op_CreateLiveSource.go index 715fcefb5e2..c913f3d9ef3 100644 --- a/service/mediatailor/api_op_CreateLiveSource.go +++ b/service/mediatailor/api_op_CreateLiveSource.go @@ -48,7 +48,7 @@ type CreateLiveSourceInput struct { // The tags to assign to the live source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -77,7 +77,7 @@ type CreateLiveSourceOutput struct { // The tags to assign to the live source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_CreatePrefetchSchedule.go b/service/mediatailor/api_op_CreatePrefetchSchedule.go index 87e8a20ab8b..628c51a1fc8 100644 --- a/service/mediatailor/api_op_CreatePrefetchSchedule.go +++ b/service/mediatailor/api_op_CreatePrefetchSchedule.go @@ -14,9 +14,8 @@ import ( // Creates a prefetch schedule for a playback configuration. A prefetch schedule // allows you to tell MediaTailor to fetch and prepare certain ads before an ad // break happens. For more information about ad prefetching, see Using ad -// prefetching -// (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the -// MediaTailor User Guide. +// prefetching (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) +// in the MediaTailor User Guide. func (c *Client) CreatePrefetchSchedule(ctx context.Context, params *CreatePrefetchScheduleInput, optFns ...func(*Options)) (*CreatePrefetchScheduleOutput, error) { if params == nil { params = &CreatePrefetchScheduleInput{} @@ -59,11 +58,11 @@ type CreatePrefetchScheduleInput struct { // This member is required. Retrieval *types.PrefetchRetrieval - // An optional stream identifier that MediaTailor uses to prefetch ads for multiple - // streams that use the same playback configuration. If StreamId is specified, - // MediaTailor returns all of the prefetch schedules with an exact match on - // StreamId. If not specified, MediaTailor returns all of the prefetch schedules - // for the playback configuration, regardless of StreamId. + // An optional stream identifier that MediaTailor uses to prefetch ads for + // multiple streams that use the same playback configuration. If StreamId is + // specified, MediaTailor returns all of the prefetch schedules with an exact match + // on StreamId . If not specified, MediaTailor returns all of the prefetch + // schedules for the playback configuration, regardless of StreamId . StreamId *string noSmithyDocumentSerde @@ -91,11 +90,11 @@ type CreatePrefetchScheduleOutput struct { // consumed for each ad break. Retrieval *types.PrefetchRetrieval - // An optional stream identifier that MediaTailor uses to prefetch ads for multiple - // streams that use the same playback configuration. If StreamId is specified, - // MediaTailor returns all of the prefetch schedules with an exact match on - // StreamId. If not specified, MediaTailor returns all of the prefetch schedules - // for the playback configuration, regardless of StreamId. + // An optional stream identifier that MediaTailor uses to prefetch ads for + // multiple streams that use the same playback configuration. If StreamId is + // specified, MediaTailor returns all of the prefetch schedules with an exact match + // on StreamId . If not specified, MediaTailor returns all of the prefetch + // schedules for the playback configuration, regardless of StreamId . StreamId *string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_CreateProgram.go b/service/mediatailor/api_op_CreateProgram.go index 651a3dc9b3e..1bc2a2e6883 100644 --- a/service/mediatailor/api_op_CreateProgram.go +++ b/service/mediatailor/api_op_CreateProgram.go @@ -13,8 +13,7 @@ import ( ) // Creates a program within a channel. For information about programs, see Working -// with programs -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) +// with programs (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) // in the MediaTailor User Guide. func (c *Client) CreateProgram(ctx context.Context, params *CreateProgramInput, optFns ...func(*Options)) (*CreateProgramOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_CreateSourceLocation.go b/service/mediatailor/api_op_CreateSourceLocation.go index 81fb928c670..539db5e02a9 100644 --- a/service/mediatailor/api_op_CreateSourceLocation.go +++ b/service/mediatailor/api_op_CreateSourceLocation.go @@ -13,8 +13,7 @@ import ( ) // Creates a source location. A source location is a container for sources. For -// more information about source locations, see Working with source locations -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) +// more information about source locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) // in the MediaTailor User Guide. func (c *Client) CreateSourceLocation(ctx context.Context, params *CreateSourceLocationInput, optFns ...func(*Options)) (*CreateSourceLocationOutput, error) { if params == nil { @@ -53,10 +52,10 @@ type CreateSourceLocationInput struct { // A list of the segment delivery configurations associated with this resource. SegmentDeliveryConfigurations []types.SegmentDeliveryConfiguration - // The tags to assign to the source location. Tags are key-value pairs that you can - // associate with Amazon resources to help with organization, access control, and - // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // The tags to assign to the source location. Tags are key-value pairs that you + // can associate with Amazon resources to help with organization, access control, + // and cost tracking. For more information, see Tagging AWS Elemental MediaTailor + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -85,17 +84,17 @@ type CreateSourceLocationOutput struct { // The segment delivery configurations for the source location. For information // about MediaTailor configurations, see Working with configurations in AWS - // Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). + // Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) + // . SegmentDeliveryConfigurations []types.SegmentDeliveryConfiguration // The name to assign to the source location. SourceLocationName *string - // The tags to assign to the source location. Tags are key-value pairs that you can - // associate with Amazon resources to help with organization, access control, and - // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // The tags to assign to the source location. Tags are key-value pairs that you + // can associate with Amazon resources to help with organization, access control, + // and cost tracking. For more information, see Tagging AWS Elemental MediaTailor + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_CreateVodSource.go b/service/mediatailor/api_op_CreateVodSource.go index e549720566e..6ad53cce326 100644 --- a/service/mediatailor/api_op_CreateVodSource.go +++ b/service/mediatailor/api_op_CreateVodSource.go @@ -48,7 +48,7 @@ type CreateVodSourceInput struct { // The tags to assign to the VOD source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -74,7 +74,7 @@ type CreateVodSourceOutput struct { // The tags to assign to the VOD source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The name to assign to the VOD source. diff --git a/service/mediatailor/api_op_DeleteChannel.go b/service/mediatailor/api_op_DeleteChannel.go index 4fd8b0bba74..7086d118afb 100644 --- a/service/mediatailor/api_op_DeleteChannel.go +++ b/service/mediatailor/api_op_DeleteChannel.go @@ -11,8 +11,7 @@ import ( ) // Deletes a channel. For information about MediaTailor channels, see Working with -// channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_DeletePlaybackConfiguration.go b/service/mediatailor/api_op_DeletePlaybackConfiguration.go index 2cbb17c572b..b284b13d9b6 100644 --- a/service/mediatailor/api_op_DeletePlaybackConfiguration.go +++ b/service/mediatailor/api_op_DeletePlaybackConfiguration.go @@ -11,8 +11,8 @@ import ( ) // Deletes a playback configuration. For information about MediaTailor -// configurations, see Working with configurations in AWS Elemental MediaTailor -// (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). +// configurations, see Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) +// . func (c *Client) DeletePlaybackConfiguration(ctx context.Context, params *DeletePlaybackConfigurationInput, optFns ...func(*Options)) (*DeletePlaybackConfigurationOutput, error) { if params == nil { params = &DeletePlaybackConfigurationInput{} diff --git a/service/mediatailor/api_op_DeletePrefetchSchedule.go b/service/mediatailor/api_op_DeletePrefetchSchedule.go index 7bc0787129c..3b918c1d673 100644 --- a/service/mediatailor/api_op_DeletePrefetchSchedule.go +++ b/service/mediatailor/api_op_DeletePrefetchSchedule.go @@ -13,9 +13,8 @@ import ( // Deletes a prefetch schedule for a specific playback configuration. If you call // DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an // HTTP 404 status code. For more information about ad prefetching, see Using ad -// prefetching -// (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the -// MediaTailor User Guide. +// prefetching (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) +// in the MediaTailor User Guide. func (c *Client) DeletePrefetchSchedule(ctx context.Context, params *DeletePrefetchScheduleInput, optFns ...func(*Options)) (*DeletePrefetchScheduleOutput, error) { if params == nil { params = &DeletePrefetchScheduleInput{} diff --git a/service/mediatailor/api_op_DeleteProgram.go b/service/mediatailor/api_op_DeleteProgram.go index 0e210a9f778..b0dec15c86d 100644 --- a/service/mediatailor/api_op_DeleteProgram.go +++ b/service/mediatailor/api_op_DeleteProgram.go @@ -11,8 +11,7 @@ import ( ) // Deletes a program within a channel. For information about programs, see Working -// with programs -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) +// with programs (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) // in the MediaTailor User Guide. func (c *Client) DeleteProgram(ctx context.Context, params *DeleteProgramInput, optFns ...func(*Options)) (*DeleteProgramOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_DeleteSourceLocation.go b/service/mediatailor/api_op_DeleteSourceLocation.go index eb8d1ae0da3..6cda4c76fb0 100644 --- a/service/mediatailor/api_op_DeleteSourceLocation.go +++ b/service/mediatailor/api_op_DeleteSourceLocation.go @@ -11,8 +11,7 @@ import ( ) // Deletes a source location. A source location is a container for sources. For -// more information about source locations, see Working with source locations -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) +// more information about source locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) // in the MediaTailor User Guide. func (c *Client) DeleteSourceLocation(ctx context.Context, params *DeleteSourceLocationInput, optFns ...func(*Options)) (*DeleteSourceLocationOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_DescribeChannel.go b/service/mediatailor/api_op_DescribeChannel.go index 7606d432269..4d64c5f50c4 100644 --- a/service/mediatailor/api_op_DescribeChannel.go +++ b/service/mediatailor/api_op_DescribeChannel.go @@ -13,8 +13,7 @@ import ( ) // Describes a channel. For information about MediaTailor channels, see Working -// with channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// with channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { if params == nil { @@ -76,7 +75,7 @@ type DescribeChannelOutput struct { // The tags assigned to the channel. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The channel's tier. diff --git a/service/mediatailor/api_op_DescribeLiveSource.go b/service/mediatailor/api_op_DescribeLiveSource.go index 2c44d207c29..9ee09ddeaeb 100644 --- a/service/mediatailor/api_op_DescribeLiveSource.go +++ b/service/mediatailor/api_op_DescribeLiveSource.go @@ -66,7 +66,7 @@ type DescribeLiveSourceOutput struct { // The tags assigned to the live source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_DescribeProgram.go b/service/mediatailor/api_op_DescribeProgram.go index 8765daa293e..0b47073240a 100644 --- a/service/mediatailor/api_op_DescribeProgram.go +++ b/service/mediatailor/api_op_DescribeProgram.go @@ -13,8 +13,7 @@ import ( ) // Describes a program within a channel. For information about programs, see -// Working with programs -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) +// Working with programs (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) // in the MediaTailor User Guide. func (c *Client) DescribeProgram(ctx context.Context, params *DescribeProgramInput, optFns ...func(*Options)) (*DescribeProgramOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_DescribeSourceLocation.go b/service/mediatailor/api_op_DescribeSourceLocation.go index 65493b39c80..0c37bc6f6f3 100644 --- a/service/mediatailor/api_op_DescribeSourceLocation.go +++ b/service/mediatailor/api_op_DescribeSourceLocation.go @@ -13,8 +13,7 @@ import ( ) // Describes a source location. A source location is a container for sources. For -// more information about source locations, see Working with source locations -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) +// more information about source locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) // in the MediaTailor User Guide. func (c *Client) DescribeSourceLocation(ctx context.Context, params *DescribeSourceLocationInput, optFns ...func(*Options)) (*DescribeSourceLocationOutput, error) { if params == nil { @@ -70,7 +69,7 @@ type DescribeSourceLocationOutput struct { // The tags assigned to the source location. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_DescribeVodSource.go b/service/mediatailor/api_op_DescribeVodSource.go index c3ba03c2476..2bfcc0e0b2e 100644 --- a/service/mediatailor/api_op_DescribeVodSource.go +++ b/service/mediatailor/api_op_DescribeVodSource.go @@ -64,7 +64,7 @@ type DescribeVodSourceOutput struct { // The tags assigned to the VOD source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The name of the VOD source. diff --git a/service/mediatailor/api_op_GetChannelSchedule.go b/service/mediatailor/api_op_GetChannelSchedule.go index 84931fca09f..0b357009a02 100644 --- a/service/mediatailor/api_op_GetChannelSchedule.go +++ b/service/mediatailor/api_op_GetChannelSchedule.go @@ -46,10 +46,10 @@ type GetChannelScheduleInput struct { // (Optional) If the playback configuration has more than MaxResults channel // schedules, use NextToken to get the second and subsequent pages of results. For - // the first GetChannelScheduleRequest request, omit this value. For the second and - // subsequent requests, get the value of NextToken from the previous response and - // specify that value for NextToken in the request. If the previous response didn't - // include a NextToken element, there are no more channel schedules to get. + // the first GetChannelScheduleRequest request, omit this value. For the second + // and subsequent requests, get the value of NextToken from the previous response + // and specify that value for NextToken in the request. If the previous response + // didn't include a NextToken element, there are no more channel schedules to get. NextToken *string noSmithyDocumentSerde diff --git a/service/mediatailor/api_op_GetPlaybackConfiguration.go b/service/mediatailor/api_op_GetPlaybackConfiguration.go index 85b42b7ad06..c2a39f84823 100644 --- a/service/mediatailor/api_op_GetPlaybackConfiguration.go +++ b/service/mediatailor/api_op_GetPlaybackConfiguration.go @@ -12,8 +12,8 @@ import ( ) // Retrieves a playback configuration. For information about MediaTailor -// configurations, see Working with configurations in AWS Elemental MediaTailor -// (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). +// configurations, see Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) +// . func (c *Client) GetPlaybackConfiguration(ctx context.Context, params *GetPlaybackConfigurationInput, optFns ...func(*Options)) (*GetPlaybackConfigurationOutput, error) { if params == nil { params = &GetPlaybackConfigurationInput{} @@ -49,13 +49,13 @@ type GetPlaybackConfigurationOutput struct { AdDecisionServerUrl *string // The configuration for avail suppression, also known as ad suppression. For more - // information about ad suppression, see Ad Suppression - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . AvailSuppression *types.AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. To learn more about bumpers, see - // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). + // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . Bumper *types.Bumper // The configuration for using a content delivery network (CDN), like Amazon @@ -63,8 +63,8 @@ type GetPlaybackConfigurationOutput struct { CdnConfiguration *types.CdnConfiguration // The player parameters and aliases used as dynamic variables during session - // initialization. For more information, see Domain Variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). + // initialization. For more information, see Domain Variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) + // . ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -92,8 +92,8 @@ type GetPlaybackConfigurationOutput struct { // underlying content is shown. This feature applies to ad replacement in live and // VOD streams, rather than ad insertion, because it relies on an underlying // content stream. For more information about ad break behavior, including ad - // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . PersonalizationThresholdSeconds int32 // The Amazon Resource Name (ARN) for the playback configuration. @@ -118,8 +118,8 @@ type GetPlaybackConfigurationOutput struct { // The tags assigned to the playback configuration. Tags are key-value pairs that // you can associate with Amazon resources to help with organization, access // control, and cost tracking. For more information, see Tagging AWS Elemental - // MediaTailor Resources - // (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) + // . Tags map[string]string // The name that is used to associate this playback configuration with a custom diff --git a/service/mediatailor/api_op_GetPrefetchSchedule.go b/service/mediatailor/api_op_GetPrefetchSchedule.go index f68d8ef993d..2d7a8883a76 100644 --- a/service/mediatailor/api_op_GetPrefetchSchedule.go +++ b/service/mediatailor/api_op_GetPrefetchSchedule.go @@ -14,9 +14,8 @@ import ( // Retrieves a prefetch schedule for a playback configuration. A prefetch schedule // allows you to tell MediaTailor to fetch and prepare certain ads before an ad // break happens. For more information about ad prefetching, see Using ad -// prefetching -// (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the -// MediaTailor User Guide. +// prefetching (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) +// in the MediaTailor User Guide. func (c *Client) GetPrefetchSchedule(ctx context.Context, params *GetPrefetchScheduleInput, optFns ...func(*Options)) (*GetPrefetchScheduleOutput, error) { if params == nil { params = &GetPrefetchScheduleInput{} diff --git a/service/mediatailor/api_op_ListLiveSources.go b/service/mediatailor/api_op_ListLiveSources.go index 71bfe9aca6f..b6c6dd203ab 100644 --- a/service/mediatailor/api_op_ListLiveSources.go +++ b/service/mediatailor/api_op_ListLiveSources.go @@ -37,8 +37,9 @@ type ListLiveSourcesInput struct { SourceLocationName *string // The maximum number of live sources that you want MediaTailor to return in - // response to the current request. If there are more than MaxResults live sources, - // use the value of NextToken in the response to get the next page of results. + // response to the current request. If there are more than MaxResults live + // sources, use the value of NextToken in the response to get the next page of + // results. MaxResults int32 // Pagination token returned by the list request when results exceed the maximum @@ -137,8 +138,9 @@ var _ ListLiveSourcesAPIClient = (*Client)(nil) // ListLiveSourcesPaginatorOptions is the paginator options for ListLiveSources type ListLiveSourcesPaginatorOptions struct { // The maximum number of live sources that you want MediaTailor to return in - // response to the current request. If there are more than MaxResults live sources, - // use the value of NextToken in the response to get the next page of results. + // response to the current request. If there are more than MaxResults live + // sources, use the value of NextToken in the response to get the next page of + // results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mediatailor/api_op_ListPlaybackConfigurations.go b/service/mediatailor/api_op_ListPlaybackConfigurations.go index 19784a8f981..f66948a207c 100644 --- a/service/mediatailor/api_op_ListPlaybackConfigurations.go +++ b/service/mediatailor/api_op_ListPlaybackConfigurations.go @@ -13,8 +13,8 @@ import ( ) // Retrieves existing playback configurations. For information about MediaTailor -// configurations, see Working with Configurations in AWS Elemental MediaTailor -// (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). +// configurations, see Working with Configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) +// . func (c *Client) ListPlaybackConfigurations(ctx context.Context, params *ListPlaybackConfigurationsInput, optFns ...func(*Options)) (*ListPlaybackConfigurationsOutput, error) { if params == nil { params = &ListPlaybackConfigurationsInput{} @@ -47,9 +47,9 @@ type ListPlaybackConfigurationsInput struct { type ListPlaybackConfigurationsOutput struct { - // Array of playback configurations. This might be all the available configurations - // or a subset, depending on the settings that you provide and the total number of - // configurations stored. + // Array of playback configurations. This might be all the available + // configurations or a subset, depending on the settings that you provide and the + // total number of configurations stored. Items []types.PlaybackConfiguration // Pagination token returned by the GET list request when results exceed the diff --git a/service/mediatailor/api_op_ListPrefetchSchedules.go b/service/mediatailor/api_op_ListPrefetchSchedules.go index 10b0942c0cc..793b84e6289 100644 --- a/service/mediatailor/api_op_ListPrefetchSchedules.go +++ b/service/mediatailor/api_op_ListPrefetchSchedules.go @@ -58,8 +58,8 @@ type ListPrefetchSchedulesInput struct { type ListPrefetchSchedulesOutput struct { - // Lists the prefetch schedules. An empty Items list doesn't mean there aren't more - // items to fetch, just that that page was empty. + // Lists the prefetch schedules. An empty Items list doesn't mean there aren't + // more items to fetch, just that that page was empty. Items []types.PrefetchSchedule // Pagination token returned by the list request when results exceed the maximum diff --git a/service/mediatailor/api_op_ListSourceLocations.go b/service/mediatailor/api_op_ListSourceLocations.go index 05a74247ecd..ea0a6d40e64 100644 --- a/service/mediatailor/api_op_ListSourceLocations.go +++ b/service/mediatailor/api_op_ListSourceLocations.go @@ -119,8 +119,8 @@ func (c *Client) addOperationListSourceLocationsMiddlewares(stack *middleware.St return nil } -// ListSourceLocationsAPIClient is a client that implements the ListSourceLocations -// operation. +// ListSourceLocationsAPIClient is a client that implements the +// ListSourceLocations operation. type ListSourceLocationsAPIClient interface { ListSourceLocations(context.Context, *ListSourceLocationsInput, ...func(*Options)) (*ListSourceLocationsOutput, error) } diff --git a/service/mediatailor/api_op_ListTagsForResource.go b/service/mediatailor/api_op_ListTagsForResource.go index b2fc7ccc782..9e8381ebc99 100644 --- a/service/mediatailor/api_op_ListTagsForResource.go +++ b/service/mediatailor/api_op_ListTagsForResource.go @@ -13,8 +13,8 @@ import ( // A list of tags that are associated with this resource. Tags are key-value pairs // that you can associate with Amazon resources to help with organization, access // control, and cost tracking. For more information, see Tagging AWS Elemental -// MediaTailor Resources -// (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). +// MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -45,7 +45,7 @@ type ListTagsForResourceOutput struct { // The tags associated with this resource. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_PutPlaybackConfiguration.go b/service/mediatailor/api_op_PutPlaybackConfiguration.go index 4475361e846..faeebab5d67 100644 --- a/service/mediatailor/api_op_PutPlaybackConfiguration.go +++ b/service/mediatailor/api_op_PutPlaybackConfiguration.go @@ -12,8 +12,8 @@ import ( ) // Creates a playback configuration. For information about MediaTailor -// configurations, see Working with configurations in AWS Elemental MediaTailor -// (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). +// configurations, see Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) +// . func (c *Client) PutPlaybackConfiguration(ctx context.Context, params *PutPlaybackConfigurationInput, optFns ...func(*Options)) (*PutPlaybackConfigurationOutput, error) { if params == nil { params = &PutPlaybackConfigurationInput{} @@ -44,13 +44,13 @@ type PutPlaybackConfigurationInput struct { AdDecisionServerUrl *string // The configuration for avail suppression, also known as ad suppression. For more - // information about ad suppression, see Ad Suppression - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . AvailSuppression *types.AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. To learn more about bumpers, see - // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). + // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . Bumper *types.Bumper // The configuration for using a content delivery network (CDN), like Amazon @@ -58,8 +58,8 @@ type PutPlaybackConfigurationInput struct { CdnConfiguration *types.CdnConfiguration // The player parameters and aliases used as dynamic variables during session - // initialization. For more information, see Domain Variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). + // initialization. For more information, see Domain Variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) + // . ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -78,8 +78,8 @@ type PutPlaybackConfigurationInput struct { // underlying content is shown. This feature applies to ad replacement in live and // VOD streams, rather than ad insertion, because it relies on an underlying // content stream. For more information about ad break behavior, including ad - // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . PersonalizationThresholdSeconds int32 // The URL for a high-quality video asset to transcode and use to fill in time @@ -93,8 +93,8 @@ type PutPlaybackConfigurationInput struct { // The tags to assign to the playback configuration. Tags are key-value pairs that // you can associate with Amazon resources to help with organization, access // control, and cost tracking. For more information, see Tagging AWS Elemental - // MediaTailor Resources - // (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) + // . Tags map[string]string // The name that is used to associate this playback configuration with a custom @@ -120,13 +120,13 @@ type PutPlaybackConfigurationOutput struct { AdDecisionServerUrl *string // The configuration for avail suppression, also known as ad suppression. For more - // information about ad suppression, see Ad Suppression - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . AvailSuppression *types.AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. To learn more about bumpers, see - // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). + // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . Bumper *types.Bumper // The configuration for using a content delivery network (CDN), like Amazon @@ -134,8 +134,8 @@ type PutPlaybackConfigurationOutput struct { CdnConfiguration *types.CdnConfiguration // The player parameters and aliases used as dynamic variables during session - // initialization. For more information, see Domain Variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). + // initialization. For more information, see Domain Variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) + // . ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -163,8 +163,8 @@ type PutPlaybackConfigurationOutput struct { // underlying content is shown. This feature applies to ad replacement in live and // VOD streams, rather than ad insertion, because it relies on an underlying // content stream. For more information about ad break behavior, including ad - // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . PersonalizationThresholdSeconds int32 // The Amazon Resource Name (ARN) associated with the playback configuration. @@ -188,8 +188,8 @@ type PutPlaybackConfigurationOutput struct { // The tags to assign to the playback configuration. Tags are key-value pairs that // you can associate with Amazon resources to help with organization, access // control, and cost tracking. For more information, see Tagging AWS Elemental - // MediaTailor Resources - // (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) + // . Tags map[string]string // The name that is used to associate this playback configuration with a custom diff --git a/service/mediatailor/api_op_StartChannel.go b/service/mediatailor/api_op_StartChannel.go index b170c03add6..6e89a788d6b 100644 --- a/service/mediatailor/api_op_StartChannel.go +++ b/service/mediatailor/api_op_StartChannel.go @@ -11,8 +11,7 @@ import ( ) // Starts a channel. For information about MediaTailor channels, see Working with -// channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) StartChannel(ctx context.Context, params *StartChannelInput, optFns ...func(*Options)) (*StartChannelOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_StopChannel.go b/service/mediatailor/api_op_StopChannel.go index 3277cdc5064..d56f4f2efa7 100644 --- a/service/mediatailor/api_op_StopChannel.go +++ b/service/mediatailor/api_op_StopChannel.go @@ -11,8 +11,7 @@ import ( ) // Stops a channel. For information about MediaTailor channels, see Working with -// channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) StopChannel(ctx context.Context, params *StopChannelInput, optFns ...func(*Options)) (*StopChannelOutput, error) { if params == nil { diff --git a/service/mediatailor/api_op_TagResource.go b/service/mediatailor/api_op_TagResource.go index 0dc01c8f38d..4b32c090d2d 100644 --- a/service/mediatailor/api_op_TagResource.go +++ b/service/mediatailor/api_op_TagResource.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The resource to tag. Tags are key-value pairs that you can associate with Amazon -// resources to help with organization, access control, and cost tracking. For more -// information, see Tagging AWS Elemental MediaTailor Resources -// (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). +// The resource to tag. Tags are key-value pairs that you can associate with +// Amazon resources to help with organization, access control, and cost tracking. +// For more information, see Tagging AWS Elemental MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -39,7 +39,7 @@ type TagResourceInput struct { // The tags to assign to the resource. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . // // This member is required. Tags map[string]string diff --git a/service/mediatailor/api_op_UpdateChannel.go b/service/mediatailor/api_op_UpdateChannel.go index 9f25b1b64a6..5b61a5fc60d 100644 --- a/service/mediatailor/api_op_UpdateChannel.go +++ b/service/mediatailor/api_op_UpdateChannel.go @@ -13,8 +13,7 @@ import ( ) // Updates a channel. For information about MediaTailor channels, see Working with -// channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error) { if params == nil { @@ -43,9 +42,10 @@ type UpdateChannelInput struct { // This member is required. Outputs []types.RequestOutputItem - // The slate used to fill gaps between programs in the schedule. You must configure - // filler slate if your channel uses the LINEARPlaybackMode. MediaTailor doesn't - // support filler slate for channels using the LOOPPlaybackMode. + // The slate used to fill gaps between programs in the schedule. You must + // configure filler slate if your channel uses the LINEAR PlaybackMode . + // MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode + // . FillerSlate *types.SlateSource noSmithyDocumentSerde @@ -65,9 +65,10 @@ type UpdateChannelOutput struct { // The timestamp of when the channel was created. CreationTime *time.Time - // The slate used to fill gaps between programs in the schedule. You must configure - // filler slate if your channel uses the LINEARPlaybackMode. MediaTailor doesn't - // support filler slate for channels using the LOOPPlaybackMode. + // The slate used to fill gaps between programs in the schedule. You must + // configure filler slate if your channel uses the LINEAR PlaybackMode . + // MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode + // . FillerSlate *types.SlateSource // The timestamp that indicates when the channel was last modified. @@ -85,7 +86,7 @@ type UpdateChannelOutput struct { // The tags to assign to the channel. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The tier associated with this Channel. diff --git a/service/mediatailor/api_op_UpdateLiveSource.go b/service/mediatailor/api_op_UpdateLiveSource.go index 12238d248fa..119c4ecf84d 100644 --- a/service/mediatailor/api_op_UpdateLiveSource.go +++ b/service/mediatailor/api_op_UpdateLiveSource.go @@ -71,7 +71,7 @@ type UpdateLiveSourceOutput struct { // The tags to assign to the live source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_UpdateSourceLocation.go b/service/mediatailor/api_op_UpdateSourceLocation.go index 5a6306ec500..680b4e765b8 100644 --- a/service/mediatailor/api_op_UpdateSourceLocation.go +++ b/service/mediatailor/api_op_UpdateSourceLocation.go @@ -13,8 +13,7 @@ import ( ) // Updates a source location. A source location is a container for sources. For -// more information about source locations, see Working with source locations -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) +// more information about source locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) // in the MediaTailor User Guide. func (c *Client) UpdateSourceLocation(ctx context.Context, params *UpdateSourceLocationInput, optFns ...func(*Options)) (*UpdateSourceLocationOutput, error) { if params == nil { @@ -79,17 +78,17 @@ type UpdateSourceLocationOutput struct { // The segment delivery configurations for the source location. For information // about MediaTailor configurations, see Working with configurations in AWS - // Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). + // Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) + // . SegmentDeliveryConfigurations []types.SegmentDeliveryConfiguration // The name of the source location. SourceLocationName *string - // The tags to assign to the source location. Tags are key-value pairs that you can - // associate with Amazon resources to help with organization, access control, and - // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // The tags to assign to the source location. Tags are key-value pairs that you + // can associate with Amazon resources to help with organization, access control, + // and cost tracking. For more information, see Tagging AWS Elemental MediaTailor + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_UpdateVodSource.go b/service/mediatailor/api_op_UpdateVodSource.go index 02f196006ce..5b64a547d9d 100644 --- a/service/mediatailor/api_op_UpdateVodSource.go +++ b/service/mediatailor/api_op_UpdateVodSource.go @@ -68,7 +68,7 @@ type UpdateVodSourceOutput struct { // The tags to assign to the VOD source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string // The name of the VOD source. diff --git a/service/mediatailor/doc.go b/service/mediatailor/doc.go index f49525696f9..672c638dcdf 100644 --- a/service/mediatailor/doc.go +++ b/service/mediatailor/doc.go @@ -1,16 +1,16 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package mediatailor provides the API client, operations, and parameter types for -// AWS MediaTailor. +// Package mediatailor provides the API client, operations, and parameter types +// for AWS MediaTailor. // // Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad // insertion and linear channels. With MediaTailor, you can assemble existing // content into a linear stream and serve targeted ads to viewers while maintaining // broadcast quality in over-the-top (OTT) video applications. For information // about using the service, including detailed information about the settings -// covered in this guide, see the AWS Elemental MediaTailor User Guide -// (https://docs.aws.amazon.com/mediatailor/latest/ug/). Through the SDKs and the -// CLI you manage AWS Elemental MediaTailor configurations and channels the same as -// you do through the console. For example, you specify ad insertion behavior and -// mapping information for the origin server and the ad decision server (ADS). +// covered in this guide, see the AWS Elemental MediaTailor User Guide (https://docs.aws.amazon.com/mediatailor/latest/ug/) +// . Through the SDKs and the CLI you manage AWS Elemental MediaTailor +// configurations and channels the same as you do through the console. For example, +// you specify ad insertion behavior and mapping information for the origin server +// and the ad decision server (ADS). package mediatailor diff --git a/service/mediatailor/types/enums.go b/service/mediatailor/types/enums.go index f8b2258175b..9d723be156b 100644 --- a/service/mediatailor/types/enums.go +++ b/service/mediatailor/types/enums.go @@ -28,9 +28,9 @@ const ( ChannelStateStopped ChannelState = "STOPPED" ) -// Values returns all known values for ChannelState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChannelState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChannelState) Values() []ChannelState { return []ChannelState{ "RUNNING", @@ -132,9 +132,9 @@ const ( PlaybackModeLinear PlaybackMode = "LINEAR" ) -// Values returns all known values for PlaybackMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PlaybackMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PlaybackMode) Values() []PlaybackMode { return []PlaybackMode{ "LOOP", diff --git a/service/mediatailor/types/types.go b/service/mediatailor/types/types.go index 5f525301921..c5b0f12e4a7 100644 --- a/service/mediatailor/types/types.go +++ b/service/mediatailor/types/types.go @@ -11,14 +11,14 @@ import ( type AccessConfiguration struct { // The type of authentication used to access content from - // HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4. + // HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4 . // S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted // virtual-style access. If your source location base URL is an Amazon S3 bucket, // MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the // bucket where your source content is stored. Your MediaTailor source location // baseURL must follow the S3 virtual hosted-style request URL format. For example, // https://bucket-name.s3.Region.amazonaws.com/key-name. Before you can use - // S3_SIGV4, you must meet these requirements: • You must allow MediaTailor to + // S3_SIGV4 , you must meet these requirements: • You must allow MediaTailor to // access your S3 bucket by granting mediatailor.amazonaws.com principal access in // IAM. For information about configuring access in IAM, see Access management in // the IAM User Guide. • The mediatailor.amazonaws.com service principal must have @@ -37,19 +37,19 @@ type AccessConfiguration struct { // Ad break configuration parameters. type AdBreak struct { - // The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL. + // The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT , TIME_SIGNAL . MessageType MessageType - // How long (in milliseconds) after the beginning of the program that an ad starts. - // This value must fall within 100ms of a segment boundary, otherwise the ad break - // will be skipped. + // How long (in milliseconds) after the beginning of the program that an ad + // starts. This value must fall within 100ms of a segment boundary, otherwise the + // ad break will be skipped. OffsetMillis int64 // Ad break slate configuration. Slate *SlateSource // This defines the SCTE-35 splice_insert() message inserted around the ad. For - // information about using splice_insert(), see the SCTE-35 specficiaiton, section + // information about using splice_insert() , see the SCTE-35 specficiaiton, section // 9.7.3.1. SpliceInsertMessage *SpliceInsertMessage @@ -63,11 +63,11 @@ type AdBreak struct { noSmithyDocumentSerde } -// For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, -// EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest -// to the MediaTailor personalized manifest. No logic is applied to these ad -// markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled -// for that ad break, MediaTailor will not set the value to 0. +// For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN , +// EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin +// manifest to the MediaTailor personalized manifest. No logic is applied to these +// ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are +// filled for that ad break, MediaTailor will not set the value to 0 . type AdMarkerPassthrough struct { // Enables ad marker passthrough for your configuration. @@ -79,7 +79,7 @@ type AdMarkerPassthrough struct { // Alert configuration parameters. type Alert struct { - // The code for the alert. For example, NOT_PROCESSED. + // The code for the alert. For example, NOT_PROCESSED . // // This member is required. AlertCode *string @@ -111,31 +111,30 @@ type Alert struct { // MediaTailor only places (consumes) prefetched ads if the ad break meets the // criteria defined by the dynamic variables. This gives you granular control over // which ad break to place the prefetched ads into. As an example, let's say that -// you set DynamicVariable to scte.event_id and Operator to EQUALS, and your +// you set DynamicVariable to scte.event_id and Operator to EQUALS , and your // playback configuration has an ADS URL of -// https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. -// And the prefetch request to the ADS contains these values -// https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. +// https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs] +// . And the prefetch request to the ADS contains these values +// https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30 . // MediaTailor will only insert the prefetched ads into the ad break if has a SCTE -// marker with an event id of my-awesome-event, since it must match the event id +// marker with an event id of my-awesome-event , since it must match the event id // that MediaTailor uses to query the ADS. You can specify up to five -// AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, -// MediaTailor combines them to match using a logical AND. You can model logical OR -// combinations by creating multiple prefetch schedules. +// AvailMatchingCriteria . If you specify multiple AvailMatchingCriteria , +// MediaTailor combines them to match using a logical AND . You can model logical +// OR combinations by creating multiple prefetch schedules. type AvailMatchingCriteria struct { // The dynamic variable(s) that MediaTailor should use as avail matching criteria. // MediaTailor only places the prefetched ads into the avail if the avail matches // the criteria defined by the dynamic variable. For information about dynamic - // variables, see Using dynamic ad variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) in the - // MediaTailor User Guide. You can include up to 100 dynamic variables. + // variables, see Using dynamic ad variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) + // in the MediaTailor User Guide. You can include up to 100 dynamic variables. // // This member is required. DynamicVariable *string - // For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is - // used for the comparison. + // For the DynamicVariable specified in AvailMatchingCriteria , the Operator that + // is used for the comparison. // // This member is required. Operator Operator @@ -144,12 +143,12 @@ type AvailMatchingCriteria struct { } // The configuration for avail suppression, also known as ad suppression. For more -// information about ad suppression, see Ad Suppression -// (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). +// information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) +// . type AvailSuppression struct { // Sets the ad suppression mode. By default, ad suppression is off and all ad - // breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad + // breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad // suppression is active and MediaTailor won't fill ad breaks on or behind the ad // suppression Value time in the manifest lookback window. Mode Mode @@ -169,7 +168,7 @@ type AvailSuppression struct { // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. To learn more about bumpers, see -// Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). +// Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . type Bumper struct { // The URL for the end bumper asset. @@ -189,14 +188,14 @@ type CdnConfiguration struct { // AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as // its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN // for the origin ads.mediatailor..amazonaws.com. Then specify the rule's - // name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a + // name in this AdSegmentUrlPrefix . When AWS Elemental MediaTailor serves a // manifest, it reports your CDN as the source for ad segments. AdSegmentUrlPrefix *string // A content delivery network (CDN) to cache content segments, so that content // requests don’t always have to go to the origin server. First, create a rule in // your CDN for the content segment origin server. Then specify the rule's name in - // this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, + // this ContentSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest, // it reports your CDN as the source for content segments. ContentSegmentUrlPrefix *string @@ -204,8 +203,7 @@ type CdnConfiguration struct { } // The configuration parameters for a channel. For information about MediaTailor -// channels, see Working with channels -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) +// channels, see Working with channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) // in the MediaTailor User Guide. type Channel struct { @@ -250,9 +248,10 @@ type Channel struct { // The timestamp of when the channel was created. CreationTime *time.Time - // The slate used to fill gaps between programs in the schedule. You must configure - // filler slate if your channel uses the LINEARPlaybackMode. MediaTailor doesn't - // support filler slate for channels using the LOOPPlaybackMode. + // The slate used to fill gaps between programs in the schedule. You must + // configure filler slate if your channel uses the LINEAR PlaybackMode . + // MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode + // . FillerSlate *SlateSource // The timestamp of when the channel was last modified. @@ -261,7 +260,7 @@ type Channel struct { // The tags to assign to the channel. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -291,15 +290,15 @@ type DashConfiguration struct { // update requests, to be used by players that don't support sticky redirects. // Disable this if you have CDN routing rules set up for accessing MediaTailor // manifests, and you are either using client-side reporting or your players - // support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The + // support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The // EMT_DEFAULT setting enables the inclusion of the tag and is the default value. MpdLocation *string // The setting that controls whether MediaTailor handles manifests from the origin // server as multi-period manifests or single-period manifests. If your origin - // server produces single-period manifests, set this to SINGLE_PERIOD. The default - // setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it - // to MULTI_PERIOD. + // server produces single-period manifests, set this to SINGLE_PERIOD . The default + // setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set + // it to MULTI_PERIOD . OriginManifestType OriginManifestType noSmithyDocumentSerde @@ -313,15 +312,15 @@ type DashConfigurationForPut struct { // update requests, to be used by players that don't support sticky redirects. // Disable this if you have CDN routing rules set up for accessing MediaTailor // manifests, and you are either using client-side reporting or your players - // support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The + // support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The // EMT_DEFAULT setting enables the inclusion of the tag and is the default value. MpdLocation *string // The setting that controls whether MediaTailor handles manifests from the origin // server as multi-period manifests or single-period manifests. If your origin - // server produces single-period manifests, set this to SINGLE_PERIOD. The default - // setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it - // to MULTI_PERIOD. + // server produces single-period manifests, set this to SINGLE_PERIOD . The default + // setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set + // it to MULTI_PERIOD . OriginManifestType OriginManifestType noSmithyDocumentSerde @@ -343,8 +342,8 @@ type DashPlaylistSettings struct { // seconds. MinUpdatePeriodSeconds int32 - // Amount of time (in seconds) that the player should be from the live point at the - // end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds. + // Amount of time (in seconds) that the player should be from the live point at + // the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds. SuggestedPresentationDelaySeconds int32 noSmithyDocumentSerde @@ -358,8 +357,8 @@ type DashPlaylistSettings struct { // segment delivery server, then the source location server is used. type DefaultSegmentDeliveryConfiguration struct { - // The hostname of the server that will be used to serve segments. This string must - // include the protocol, such as https://. + // The hostname of the server that will be used to serve segments. This string + // must include the protocol, such as https://. BaseUrl *string noSmithyDocumentSerde @@ -407,13 +406,13 @@ type HttpPackageConfiguration struct { Path *string // The name of the source group. This has to match one of the - // Channel::Outputs::SourceGroup. + // Channel::Outputs::SourceGroup . // // This member is required. SourceGroup *string // The streaming protocol for this package configuration. Supported values are HLS - // and DASH. + // and DASH . // // This member is required. Type Type @@ -471,7 +470,7 @@ type LiveSource struct { // The tags assigned to the live source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -482,12 +481,11 @@ type LogConfiguration struct { // The percentage of session logs that MediaTailor sends to your Cloudwatch Logs // account. For example, if your playback configuration has 1000 sessions and - // percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to + // percentEnabled is set to 60 , MediaTailor sends logs for 600 of the sessions to // CloudWatch Logs. MediaTailor decides at random which of the playback // configuration sessions to send logs for. If you want to view logs for a specific - // session, you can use the debug log mode - // (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html). Valid - // values: 0 - 100 + // session, you can use the debug log mode (https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html) + // . Valid values: 0 - 100 // // This member is required. PercentEnabled int32 @@ -508,19 +506,19 @@ type LogConfigurationForChannel struct { // enable customization of the personalized manifests created by MediaTailor. type ManifestProcessingRules struct { - // For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, - // EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest - // to the MediaTailor personalized manifest. No logic is applied to these ad - // markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled - // for that ad break, MediaTailor will not set the value to 0. + // For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN , + // EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin + // manifest to the MediaTailor personalized manifest. No logic is applied to these + // ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are + // filled for that ad break, MediaTailor will not set the value to 0 . AdMarkerPassthrough *AdMarkerPassthrough noSmithyDocumentSerde } // A playback configuration. For information about MediaTailor configurations, see -// Working with configurations in AWS Elemental MediaTailor -// (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). +// Working with configurations in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html) +// . type PlaybackConfiguration struct { // The URL for the ad decision server (ADS). This includes the specification of @@ -531,13 +529,13 @@ type PlaybackConfiguration struct { AdDecisionServerUrl *string // The configuration for avail suppression, also known as ad suppression. For more - // information about ad suppression, see Ad Suppression - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . AvailSuppression *AvailSuppression // The configuration for bumpers. Bumpers are short audio or video clips that play // at the start or before the end of an ad break. To learn more about bumpers, see - // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). + // Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . Bumper *Bumper // The configuration for using a content delivery network (CDN), like Amazon @@ -545,8 +543,8 @@ type PlaybackConfiguration struct { CdnConfiguration *CdnConfiguration // The player parameters and aliases used as dynamic variables during session - // initialization. For more information, see Domain Variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). + // initialization. For more information, see Domain Variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) + // . ConfigurationAliases map[string]map[string]string // The configuration for a DASH source. @@ -574,8 +572,8 @@ type PlaybackConfiguration struct { // underlying content is shown. This feature applies to ad replacement in live and // VOD streams, rather than ad insertion, because it relies on an underlying // content stream. For more information about ad break behavior, including ad - // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor - // (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). + // replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) + // . PersonalizationThresholdSeconds int32 // The Amazon Resource Name (ARN) for the playback configuration. @@ -600,8 +598,8 @@ type PlaybackConfiguration struct { // The tags to assign to the playback configuration. Tags are key-value pairs that // you can associate with Amazon resources to help with organization, access // control, and cost tracking. For more information, see Tagging AWS Elemental - // MediaTailor Resources - // (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // MediaTailor Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) + // . Tags map[string]string // The name that is used to associate this playback configuration with a custom @@ -624,27 +622,27 @@ type PrefetchConsumption struct { // The time when MediaTailor no longer considers the prefetched ads for use in an // ad break. MediaTailor automatically deletes prefetch schedules no less than // seven days after the end time. If you'd like to manually delete the prefetch - // schedule, you can call DeletePrefetchSchedule. + // schedule, you can call DeletePrefetchSchedule . // // This member is required. EndTime *time.Time // If you only want MediaTailor to insert prefetched ads into avails (ad breaks) - // that match specific dynamic variables, such as scte.event_id, set the avail + // that match specific dynamic variables, such as scte.event_id , set the avail // matching criteria. AvailMatchingCriteria []AvailMatchingCriteria - // The time when prefetched ads are considered for use in an ad break. If you don't - // specify StartTime, the prefetched ads are available after MediaTailor retrives - // them from the ad decision server. + // The time when prefetched ads are considered for use in an ad break. If you + // don't specify StartTime , the prefetched ads are available after MediaTailor + // retrives them from the ad decision server. StartTime *time.Time noSmithyDocumentSerde } -// A complex type that contains settings governing when MediaTailor prefetches ads, -// and which dynamic variables that MediaTailor includes in the request to the ad -// decision server. +// A complex type that contains settings governing when MediaTailor prefetches +// ads, and which dynamic variables that MediaTailor includes in the request to the +// ad decision server. type PrefetchRetrieval struct { // The time when prefetch retrieval ends for the ad break. Prefetching will be @@ -653,10 +651,9 @@ type PrefetchRetrieval struct { // This member is required. EndTime *time.Time - // The dynamic variables to use for substitution during prefetch requests to the ad - // decision server (ADS). You initially configure dynamic variables - // (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) for the ADS - // URL when you set up your playback configuration. When you specify + // The dynamic variables to use for substitution during prefetch requests to the + // ad decision server (ADS). You initially configure dynamic variables (https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) + // for the ADS URL when you set up your playback configuration. When you specify // DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic // variables in the request to the ADS. DynamicVariables map[string]string @@ -672,9 +669,8 @@ type PrefetchRetrieval struct { // A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain // ads before an ad break happens. For more information about ad prefetching, see -// Using ad prefetching -// (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the -// MediaTailor User Guide. +// Using ad prefetching (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) +// in the MediaTailor User Guide. type PrefetchSchedule struct { // The Amazon Resource Name (ARN) of the prefetch schedule. @@ -717,13 +713,13 @@ type PrefetchSchedule struct { // The output configuration for this channel. type RequestOutputItem struct { - // The name of the manifest for the channel. The name appears in the PlaybackUrl. + // The name of the manifest for the channel. The name appears in the PlaybackUrl . // // This member is required. ManifestName *string - // A string used to match which HttpPackageConfiguration is used for each - // VodSource. + // A string used to match which HttpPackageConfiguration is used for each VodSource + // . // // This member is required. SourceGroup *string @@ -843,10 +839,10 @@ type ScheduleEntry struct { noSmithyDocumentSerde } -// AWS Secrets Manager access token configuration parameters. For information about -// Secrets Manager access token authentication, see Working with AWS Secrets -// Manager access token authentication -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html). +// AWS Secrets Manager access token configuration parameters. For information +// about Secrets Manager access token authentication, see Working with AWS Secrets +// Manager access token authentication (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html) +// . type SecretsManagerAccessTokenConfiguration struct { // The name of the HTTP header used to supply the access token in requests to the @@ -857,8 +853,7 @@ type SecretsManagerAccessTokenConfiguration struct { // the access token. SecretArn *string - // The AWS Secrets Manager SecretString - // (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html) + // The AWS Secrets Manager SecretString (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html) // key associated with the access token. MediaTailor uses the key to look up // SecretString key and value pair containing the access token. SecretStringKey *string @@ -875,9 +870,9 @@ type SecretsManagerAccessTokenConfiguration struct { // information. type SegmentationDescriptor struct { - // The segment number to assign to the segmentation_descriptor.segment_num message, - // as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be - // between 0 and 256, inclusive. The default value is 0. + // The segment number to assign to the segmentation_descriptor.segment_num + // message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values + // must be between 0 and 256, inclusive. The default value is 0. SegmentNum *int32 // The Event Identifier to assign to the @@ -928,8 +923,8 @@ type SegmentDeliveryConfiguration struct { // The base URL of the host or path of the segment delivery server that you're // using to serve segments. This is typically a content delivery network (CDN). The // URL can be absolute or relative. To use an absolute URL include the protocol, - // such as https://example.com/some/path. To use a relative URL specify the - // relative path, such as /some/path*. + // such as https://example.com/some/path . To use a relative URL specify the + // relative path, such as /some/path* . BaseUrl *string // A unique identifier used to distinguish between multiple segment delivery @@ -953,8 +948,7 @@ type SlateSource struct { } // A source location is a container for sources. For more information about source -// locations, see Working with source locations -// (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) +// locations, see Working with source locations (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) // in the MediaTailor User Guide. type SourceLocation struct { @@ -991,7 +985,7 @@ type SourceLocation struct { // The tags assigned to the source location. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde @@ -1000,23 +994,23 @@ type SourceLocation struct { // Splice insert message configuration. type SpliceInsertMessage struct { - // This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the - // SCTE-35 specification. The default value is 0. Values must be between 0 and 256, - // inclusive. + // This is written to splice_insert.avail_num , as defined in section 9.7.3.1 of + // the SCTE-35 specification. The default value is 0 . Values must be between 0 + // and 256 , inclusive. AvailNum int32 - // This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 - // of the SCTE-35 specification. The default value is 0. Values must be between 0 - // and 256, inclusive. + // This is written to splice_insert.avails_expected , as defined in section 9.7.3.1 + // of the SCTE-35 specification. The default value is 0 . Values must be between 0 + // and 256 , inclusive. AvailsExpected int32 - // This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 - // of the SCTE-35 specification. The default value is 1. + // This is written to splice_insert.splice_event_id , as defined in section 9.7.3.1 + // of the SCTE-35 specification. The default value is 1 . SpliceEventId int32 - // This is written to splice_insert.unique_program_id, as defined in section - // 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be - // between 0 and 256, inclusive. + // This is written to splice_insert.unique_program_id , as defined in section + // 9.7.3.1 of the SCTE-35 specification. The default value is 0 . Values must be + // between 0 and 256 , inclusive. UniqueProgramId int32 noSmithyDocumentSerde @@ -1024,11 +1018,12 @@ type SpliceInsertMessage struct { // The SCTE-35 time_signal message can be sent with one or more // segmentation_descriptor messages. A time_signal message can be sent only if a -// single segmentation_descriptor message is sent. The time_signal message contains -// only the splice_time field which is constructed using a given presentation -// timestamp. When sending a time_signal message, the splice_command_type field in -// the splice_info_section message is set to 6 (0x06). See the time_signal() table -// of the 2022 SCTE-35 specification for more information. +// single segmentation_descriptor message is sent. The time_signal message +// contains only the splice_time field which is constructed using a given +// presentation timestamp. When sending a time_signal message, the +// splice_command_type field in the splice_info_section message is set to 6 +// (0x06). See the time_signal() table of the 2022 SCTE-35 specification for more +// information. type TimeSignalMessage struct { // The configurations for the SCTE-35 segmentation_descriptor message(s) sent with @@ -1042,20 +1037,20 @@ type TimeSignalMessage struct { type Transition struct { // The position where this program will be inserted relative to the - // RelativePosition. + // RelativePosition . // // This member is required. RelativePosition RelativePosition // Defines when the program plays in the schedule. You can set the value to - // ABSOLUTE or RELATIVE. ABSOLUTE - The program plays at a specific wall clock - // time. This setting can only be used for channels using the LINEARPlaybackMode. + // ABSOLUTE or RELATIVE . ABSOLUTE - The program plays at a specific wall clock + // time. This setting can only be used for channels using the LINEAR PlaybackMode . // Note the following considerations when using ABSOLUTE transitions: If the // preceding program in the schedule has a duration that extends past the wall // clock time, MediaTailor truncates the preceding program on a common segment // boundary. If there are gaps in playback, MediaTailor plays the FillerSlate you // configured for your linear channel. RELATIVE - The program is inserted into the - // schedule either before or after a program that you specify via RelativePosition. + // schedule either before or after a program that you specify via RelativePosition . // // This member is required. Type *string @@ -1064,7 +1059,7 @@ type Transition struct { DurationMillis int64 // The name of the program that this program will be inserted next to, as defined - // by RelativePosition. + // by RelativePosition . RelativeProgram *string // The date and time that the program is scheduled to start, in epoch milliseconds. @@ -1129,7 +1124,7 @@ type VodSource struct { // The tags assigned to the VOD source. Tags are key-value pairs that you can // associate with Amazon resources to help with organization, access control, and // cost tracking. For more information, see Tagging AWS Elemental MediaTailor - // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html). + // Resources (https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . Tags map[string]string noSmithyDocumentSerde diff --git a/service/memorydb/api_client.go b/service/memorydb/api_client.go index f666b91a605..38592983504 100644 --- a/service/memorydb/api_client.go +++ b/service/memorydb/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/memorydb/api_op_BatchUpdateCluster.go b/service/memorydb/api_op_BatchUpdateCluster.go index df411988c02..6865ae935b1 100644 --- a/service/memorydb/api_op_BatchUpdateCluster.go +++ b/service/memorydb/api_op_BatchUpdateCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Apply the service update to a list of clusters supplied. For more information on -// service updates and applying them, see Applying the service updates -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/managing-updates.html#applying-updates). +// Apply the service update to a list of clusters supplied. For more information +// on service updates and applying them, see Applying the service updates (https://docs.aws.amazon.com/MemoryDB/latest/devguide/managing-updates.html#applying-updates) +// . func (c *Client) BatchUpdateCluster(ctx context.Context, params *BatchUpdateClusterInput, optFns ...func(*Options)) (*BatchUpdateClusterOutput, error) { if params == nil { params = &BatchUpdateClusterInput{} diff --git a/service/memorydb/api_op_CopySnapshot.go b/service/memorydb/api_op_CopySnapshot.go index 17bf920527a..ca99369d3a1 100644 --- a/service/memorydb/api_op_CopySnapshot.go +++ b/service/memorydb/api_op_CopySnapshot.go @@ -52,8 +52,8 @@ type CopySnapshotInput struct { // only when exporting a snapshot for external access. When using this parameter to // export a snapshot, be sure MemoryDB has the needed permissions to this S3 // bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon - // S3 Bucket - // (https://docs.aws.amazon.com/MemoryDB/latest/devguide/snapshots-exporting.html). + // S3 Bucket (https://docs.aws.amazon.com/MemoryDB/latest/devguide/snapshots-exporting.html) + // . TargetBucket *string noSmithyDocumentSerde diff --git a/service/memorydb/api_op_CreateACL.go b/service/memorydb/api_op_CreateACL.go index c94d30f9d65..3b35d64910e 100644 --- a/service/memorydb/api_op_CreateACL.go +++ b/service/memorydb/api_op_CreateACL.go @@ -12,8 +12,8 @@ import ( ) // Creates an Access Control List. For more information, see Authenticating users -// with Access Contol Lists (ACLs) -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). +// with Access Contol Lists (ACLs) (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html) +// . func (c *Client) CreateACL(ctx context.Context, params *CreateACLInput, optFns ...func(*Options)) (*CreateACLOutput, error) { if params == nil { params = &CreateACLInput{} diff --git a/service/memorydb/api_op_CreateCluster.go b/service/memorydb/api_op_CreateCluster.go index fcae6038726..cf570e29f97 100644 --- a/service/memorydb/api_op_CreateCluster.go +++ b/service/memorydb/api_op_CreateCluster.go @@ -50,10 +50,10 @@ type CreateClusterInput struct { // upgrades after launch. AutoMinorVersionUpgrade *bool - // Enables data tiering. Data tiering is only supported for clusters using the r6gd - // node type. This parameter must be set when using r6gd nodes. For more - // information, see Data tiering - // (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). + // Enables data tiering. Data tiering is only supported for clusters using the + // r6gd node type. This parameter must be set when using r6gd nodes. For more + // information, see Data tiering (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html) + // . DataTiering *bool // An optional description of the cluster. @@ -69,23 +69,14 @@ type CreateClusterInput struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 MaintenanceWindow *string // The number of replicas to apply to each shard. The default value is 1. The diff --git a/service/memorydb/api_op_CreateParameterGroup.go b/service/memorydb/api_op_CreateParameterGroup.go index 4f0e52ccc96..ae7639ec8e1 100644 --- a/service/memorydb/api_op_CreateParameterGroup.go +++ b/service/memorydb/api_op_CreateParameterGroup.go @@ -13,8 +13,8 @@ import ( // Creates a new MemoryDB parameter group. A parameter group is a collection of // parameters and their values that are applied to all of the nodes in any cluster. -// For more information, see Configuring engine parameters using parameter groups -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/parametergroups.html). +// For more information, see Configuring engine parameters using parameter groups (https://docs.aws.amazon.com/MemoryDB/latest/devguide/parametergroups.html) +// . func (c *Client) CreateParameterGroup(ctx context.Context, params *CreateParameterGroupInput, optFns ...func(*Options)) (*CreateParameterGroupOutput, error) { if params == nil { params = &CreateParameterGroupInput{} diff --git a/service/memorydb/api_op_CreateSubnetGroup.go b/service/memorydb/api_op_CreateSubnetGroup.go index 87d19233146..54f688374a9 100644 --- a/service/memorydb/api_op_CreateSubnetGroup.go +++ b/service/memorydb/api_op_CreateSubnetGroup.go @@ -16,8 +16,8 @@ import ( // Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you // must specify a subnet group. MemoryDB uses that subnet group to choose a subnet // and IP addresses within that subnet to associate with your nodes. For more -// information, see Subnets and subnet groups -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/subnetgroups.html). +// information, see Subnets and subnet groups (https://docs.aws.amazon.com/MemoryDB/latest/devguide/subnetgroups.html) +// . func (c *Client) CreateSubnetGroup(ctx context.Context, params *CreateSubnetGroupInput, optFns ...func(*Options)) (*CreateSubnetGroupOutput, error) { if params == nil { params = &CreateSubnetGroupInput{} diff --git a/service/memorydb/api_op_CreateUser.go b/service/memorydb/api_op_CreateUser.go index 3e1dccb351b..b97f539babf 100644 --- a/service/memorydb/api_op_CreateUser.go +++ b/service/memorydb/api_op_CreateUser.go @@ -12,8 +12,8 @@ import ( ) // Creates a MemoryDB user. For more information, see Authenticating users with -// Access Contol Lists (ACLs) -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). +// Access Contol Lists (ACLs) (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html) +// . func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} diff --git a/service/memorydb/api_op_DeleteACL.go b/service/memorydb/api_op_DeleteACL.go index 8b1a074470a..cd7a44daf15 100644 --- a/service/memorydb/api_op_DeleteACL.go +++ b/service/memorydb/api_op_DeleteACL.go @@ -12,9 +12,9 @@ import ( ) // Deletes an Access Control List. The ACL must first be disassociated from the -// cluster before it can be deleted. For more information, see Authenticating users -// with Access Contol Lists (ACLs) -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). +// cluster before it can be deleted. For more information, see Authenticating +// users with Access Contol Lists (ACLs) (https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html) +// . func (c *Client) DeleteACL(ctx context.Context, params *DeleteACLInput, optFns ...func(*Options)) (*DeleteACLOutput, error) { if params == nil { params = &DeleteACLInput{} diff --git a/service/memorydb/api_op_DeleteCluster.go b/service/memorydb/api_op_DeleteCluster.go index 9d614900cea..33d2c136da1 100644 --- a/service/memorydb/api_op_DeleteCluster.go +++ b/service/memorydb/api_op_DeleteCluster.go @@ -34,9 +34,9 @@ type DeleteClusterInput struct { // This member is required. ClusterName *string - // The user-supplied name of a final cluster snapshot. This is the unique name that - // identifies the snapshot. MemoryDB creates the snapshot, and then deletes the - // cluster immediately afterward. + // The user-supplied name of a final cluster snapshot. This is the unique name + // that identifies the snapshot. MemoryDB creates the snapshot, and then deletes + // the cluster immediately afterward. FinalSnapshotName *string noSmithyDocumentSerde diff --git a/service/memorydb/api_op_DeleteParameterGroup.go b/service/memorydb/api_op_DeleteParameterGroup.go index 5fe0ffe4003..34485e9fdee 100644 --- a/service/memorydb/api_op_DeleteParameterGroup.go +++ b/service/memorydb/api_op_DeleteParameterGroup.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified parameter group. You cannot delete a parameter group if it -// is associated with any clusters. You cannot delete the default parameter groups -// in your account. +// Deletes the specified parameter group. You cannot delete a parameter group if +// it is associated with any clusters. You cannot delete the default parameter +// groups in your account. func (c *Client) DeleteParameterGroup(ctx context.Context, params *DeleteParameterGroupInput, optFns ...func(*Options)) (*DeleteParameterGroupOutput, error) { if params == nil { params = &DeleteParameterGroupInput{} diff --git a/service/memorydb/api_op_DescribeEvents.go b/service/memorydb/api_op_DescribeEvents.go index 7f2bb3300f6..1f346d03e7e 100644 --- a/service/memorydb/api_op_DescribeEvents.go +++ b/service/memorydb/api_op_DescribeEvents.go @@ -38,8 +38,8 @@ type DescribeEventsInput struct { // The number of minutes worth of events to retrieve. Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. Example: 2017-03-30T07:03:49.555Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. Example: 2017-03-30T07:03:49.555Z EndTime *time.Time // The maximum number of records to include in the response. If more records exist @@ -62,8 +62,8 @@ type DescribeEventsInput struct { // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. Example: 2017-03-30T07:03:49.555Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. Example: 2017-03-30T07:03:49.555Z StartTime *time.Time noSmithyDocumentSerde diff --git a/service/memorydb/api_op_DescribeReservedNodes.go b/service/memorydb/api_op_DescribeReservedNodes.go index a163c3070f0..0013b61ace3 100644 --- a/service/memorydb/api_op_DescribeReservedNodes.go +++ b/service/memorydb/api_op_DescribeReservedNodes.go @@ -40,15 +40,15 @@ type DescribeReservedNodesInput struct { // that the remaining results can be retrieved. MaxResults *int32 - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. NextToken *string // The node type filter value. Use this parameter to show only those reservations - // matching the specified node type. For more information, see Supported node types - // (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported). + // matching the specified node type. For more information, see Supported node types (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported) + // . NodeType *string // The offering type filter value. Use this parameter to show only the available @@ -69,9 +69,9 @@ type DescribeReservedNodesInput struct { type DescribeReservedNodesOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. NextToken *string diff --git a/service/memorydb/api_op_DescribeReservedNodesOfferings.go b/service/memorydb/api_op_DescribeReservedNodesOfferings.go index ef31399cf4c..df4494fdec8 100644 --- a/service/memorydb/api_op_DescribeReservedNodesOfferings.go +++ b/service/memorydb/api_op_DescribeReservedNodesOfferings.go @@ -30,8 +30,8 @@ func (c *Client) DescribeReservedNodesOfferings(ctx context.Context, params *Des type DescribeReservedNodesOfferingsInput struct { - // Duration filter value, specified in years or seconds. Use this parameter to show - // only reservations for a given duration. + // Duration filter value, specified in years or seconds. Use this parameter to + // show only reservations for a given duration. Duration *string // The maximum number of records to include in the response. If more records exist @@ -39,15 +39,15 @@ type DescribeReservedNodesOfferingsInput struct { // that the remaining results can be retrieved. MaxResults *int32 - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. NextToken *string // The node type for the reserved nodes. For more information, see Supported node - // types - // (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported). + // types (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported) + // . NodeType *string // The offering type filter value. Use this parameter to show only the available @@ -64,9 +64,9 @@ type DescribeReservedNodesOfferingsInput struct { type DescribeReservedNodesOfferingsOutput struct { - // An optional marker returned from a prior request. Use this marker for pagination - // of results from this operation. If this parameter is specified, the response - // includes only records beyond the marker, up to the value specified by + // An optional marker returned from a prior request. Use this marker for + // pagination of results from this operation. If this parameter is specified, the + // response includes only records beyond the marker, up to the value specified by // MaxRecords. NextToken *string diff --git a/service/memorydb/api_op_DescribeSnapshots.go b/service/memorydb/api_op_DescribeSnapshots.go index 2cedee2cdd1..af019dd35ee 100644 --- a/service/memorydb/api_op_DescribeSnapshots.go +++ b/service/memorydb/api_op_DescribeSnapshots.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about cluster snapshots. By default, DescribeSnapshots lists -// all of your snapshots; it can optionally describe a single snapshot, or just the -// snapshots associated with a particular cluster. +// Returns information about cluster snapshots. By default, DescribeSnapshots +// lists all of your snapshots; it can optionally describe a single snapshot, or +// just the snapshots associated with a particular cluster. func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} diff --git a/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go b/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go index 250e66c6e78..f2c0b673f2b 100644 --- a/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go +++ b/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all available node types that you can scale to from your cluster's current -// node type. When you use the UpdateCluster operation to scale your cluster, the -// value of the NodeType parameter must be one of the node types returned by this -// operation. +// Lists all available node types that you can scale to from your cluster's +// current node type. When you use the UpdateCluster operation to scale your +// cluster, the value of the NodeType parameter must be one of the node types +// returned by this operation. func (c *Client) ListAllowedNodeTypeUpdates(ctx context.Context, params *ListAllowedNodeTypeUpdatesInput, optFns ...func(*Options)) (*ListAllowedNodeTypeUpdatesOutput, error) { if params == nil { params = &ListAllowedNodeTypeUpdatesInput{} diff --git a/service/memorydb/api_op_ListTags.go b/service/memorydb/api_op_ListTags.go index c0594cbff49..2c4674d2a69 100644 --- a/service/memorydb/api_op_ListTags.go +++ b/service/memorydb/api_op_ListTags.go @@ -14,8 +14,7 @@ import ( // Lists all tags currently on a named resource. A tag is a key-value pair where // the key and value are case-sensitive. You can use tags to categorize and track // your MemoryDB resources. For more information, see Tagging your MemoryDB -// resources -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html) +// resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html) func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} diff --git a/service/memorydb/api_op_PurchaseReservedNodesOffering.go b/service/memorydb/api_op_PurchaseReservedNodesOffering.go index 4c828dc4164..e718b43ab73 100644 --- a/service/memorydb/api_op_PurchaseReservedNodesOffering.go +++ b/service/memorydb/api_op_PurchaseReservedNodesOffering.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to purchase a reserved node offering. Reserved nodes are not eligible -// for cancellation and are non-refundable. +// Allows you to purchase a reserved node offering. Reserved nodes are not +// eligible for cancellation and are non-refundable. func (c *Client) PurchaseReservedNodesOffering(ctx context.Context, params *PurchaseReservedNodesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedNodesOfferingOutput, error) { if params == nil { params = &PurchaseReservedNodesOfferingInput{} diff --git a/service/memorydb/api_op_TagResource.go b/service/memorydb/api_op_TagResource.go index 4b037e51612..08ad201e004 100644 --- a/service/memorydb/api_op_TagResource.go +++ b/service/memorydb/api_op_TagResource.go @@ -14,15 +14,14 @@ import ( // A tag is a key-value pair where the key and value are case-sensitive. You can // use tags to categorize and track all your MemoryDB resources. When you add or // remove tags on clusters, those actions will be replicated to all nodes in the -// cluster. For more information, see Resource-level permissions -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/iam.resourcelevelpermissions.html). -// For example, you can use cost-allocation tags to your MemoryDB resources, Amazon -// generates a cost allocation report as a comma-separated value (CSV) file with -// your usage and costs aggregated by your tags. You can apply tags that represent -// business categories (such as cost centers, application names, or owners) to -// organize your costs across multiple services. For more information, see Using -// Cost Allocation Tags -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging.html). +// cluster. For more information, see Resource-level permissions (https://docs.aws.amazon.com/MemoryDB/latest/devguide/iam.resourcelevelpermissions.html) +// . For example, you can use cost-allocation tags to your MemoryDB resources, +// Amazon generates a cost allocation report as a comma-separated value (CSV) file +// with your usage and costs aggregated by your tags. You can apply tags that +// represent business categories (such as cost centers, application names, or +// owners) to organize your costs across multiple services. For more information, +// see Using Cost Allocation Tags (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/memorydb/api_op_UpdateCluster.go b/service/memorydb/api_op_UpdateCluster.go index b911b3225f3..4ab95aa6f39 100644 --- a/service/memorydb/api_op_UpdateCluster.go +++ b/service/memorydb/api_op_UpdateCluster.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the settings for a cluster. You can use this operation to change one or -// more cluster configuration settings by specifying the settings and the new +// Modifies the settings for a cluster. You can use this operation to change one +// or more cluster configuration settings by specifying the settings and the new // values. func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error) { if params == nil { @@ -52,23 +52,14 @@ type UpdateClusterInput struct { // performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H // Clock UTC). The minimum maintenance window is a 60 minute period. Valid values // for ddd are: - // - // * sun - // - // * mon - // - // * tue - // - // * wed - // - // * thu - // - // * fri - // - // * sat - // - // Example: - // sun:23:00-mon:01:30 + // - sun + // - mon + // - tue + // - wed + // - thu + // - fri + // - sat + // Example: sun:23:00-mon:01:30 MaintenanceWindow *string // A valid node type that you want to scale this cluster up or down to. @@ -86,9 +77,9 @@ type UpdateClusterInput struct { // The number of shards in the cluster ShardConfiguration *types.ShardConfigurationRequest - // The number of days for which MemoryDB retains automatic cluster snapshots before - // deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot - // that was taken today is retained for 5 days before being deleted. + // The number of days for which MemoryDB retains automatic cluster snapshots + // before deleting them. For example, if you set SnapshotRetentionLimit to 5, a + // snapshot that was taken today is retained for 5 days before being deleted. SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which MemoryDB begins taking a daily diff --git a/service/memorydb/api_op_UpdateParameterGroup.go b/service/memorydb/api_op_UpdateParameterGroup.go index 727b34f6276..7e624a92098 100644 --- a/service/memorydb/api_op_UpdateParameterGroup.go +++ b/service/memorydb/api_op_UpdateParameterGroup.go @@ -35,9 +35,9 @@ type UpdateParameterGroupInput struct { // This member is required. ParameterGroupName *string - // An array of parameter names and values for the parameter update. You must supply - // at least one parameter name and value; subsequent arguments are optional. A - // maximum of 20 parameters may be updated per request. + // An array of parameter names and values for the parameter update. You must + // supply at least one parameter name and value; subsequent arguments are optional. + // A maximum of 20 parameters may be updated per request. // // This member is required. ParameterNameValues []types.ParameterNameValue diff --git a/service/memorydb/api_op_UpdateSubnetGroup.go b/service/memorydb/api_op_UpdateSubnetGroup.go index 5e597fa09a0..d96dbe34d89 100644 --- a/service/memorydb/api_op_UpdateSubnetGroup.go +++ b/service/memorydb/api_op_UpdateSubnetGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a subnet group. For more information, see Updating a subnet group -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/ubnetGroups.Modifying.html) +// Updates a subnet group. For more information, see Updating a subnet group (https://docs.aws.amazon.com/MemoryDB/latest/devguide/ubnetGroups.Modifying.html) func (c *Client) UpdateSubnetGroup(ctx context.Context, params *UpdateSubnetGroupInput, optFns ...func(*Options)) (*UpdateSubnetGroupOutput, error) { if params == nil { params = &UpdateSubnetGroupInput{} diff --git a/service/memorydb/doc.go b/service/memorydb/doc.go index c34ea3e6c73..9bd4224c543 100644 --- a/service/memorydb/doc.go +++ b/service/memorydb/doc.go @@ -3,10 +3,10 @@ // Package memorydb provides the API client, operations, and parameter types for // Amazon MemoryDB. // -// MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that -// delivers ultra-fast performance and Multi-AZ durability for modern applications -// built using microservices architectures. MemoryDB stores the entire database -// in-memory, enabling low latency and high throughput data access. It is +// MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database +// that delivers ultra-fast performance and Multi-AZ durability for modern +// applications built using microservices architectures. MemoryDB stores the entire +// database in-memory, enabling low latency and high throughput data access. It is // compatible with Redis, a popular open source data store, enabling you to // leverage Redis’ flexible and friendly data structures, APIs, and commands. package memorydb diff --git a/service/memorydb/types/types.go b/service/memorydb/types/types.go index 3fe8087d860..ec327e1215e 100644 --- a/service/memorydb/types/types.go +++ b/service/memorydb/types/types.go @@ -114,10 +114,10 @@ type Cluster struct { // The cluster's configuration endpoint ClusterEndpoint *Endpoint - // Enables data tiering. Data tiering is only supported for clusters using the r6gd - // node type. This parameter must be set when using r6gd nodes. For more - // information, see Data tiering - // (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). + // Enables data tiering. Data tiering is only supported for clusters using the + // r6gd node type. This parameter must be set when using r6gd nodes. For more + // information, see Data tiering (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html) + // . DataTiering DataTieringStatus // A description of the cluster @@ -333,9 +333,9 @@ type Node struct { // The hostname for connecting to this node. Endpoint *Endpoint - // The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The - // combination of cluster name, shard name and node name uniquely identifies every - // node used in a customer's Amazon account. + // The node identifier. A node name is a numeric identifier (0001, 0002, etc.). + // The combination of cluster name, shard name and node name uniquely identifies + // every node used in a customer's Amazon account. Name *string // The status of the service update on the node @@ -484,8 +484,8 @@ type ReservedNodesOffering struct { FixedPrice float64 // The node type for the reserved nodes. For more information, see Supported node - // types - // (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported). + // types (https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported) + // . NodeType *string // The offering type of this reserved node. @@ -562,8 +562,8 @@ type ServiceUpdateRequest struct { noSmithyDocumentSerde } -// Represents a collection of nodes in a cluster. One node in the node group is the -// read/write primary node. All the other nodes are read-only Replica nodes. +// Represents a collection of nodes in a cluster. One node in the node group is +// the read/write primary node. All the other nodes are read-only Replica nodes. type Shard struct { // The name of the shard @@ -645,10 +645,10 @@ type Snapshot struct { // The configuration of the cluster from which the snapshot was taken ClusterConfiguration *ClusterConfiguration - // Enables data tiering. Data tiering is only supported for clusters using the r6gd - // node type. This parameter must be set when using r6gd nodes. For more - // information, see Data tiering - // (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). + // Enables data tiering. Data tiering is only supported for clusters using the + // r6gd node type. This parameter must be set when using r6gd nodes. For more + // information, see Data tiering (https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html) + // . DataTiering DataTieringStatus // The ID of the KMS key used to encrypt the snapshot. @@ -683,15 +683,12 @@ type Subnet struct { } // Represents the output of one of the following operations: +// - CreateSubnetGroup +// - UpdateSubnetGroup // -// * -// CreateSubnetGroup -// -// * UpdateSubnetGroup -// -// A subnet group is a collection of -// subnets (typically private) that you can designate for your clusters running in -// an Amazon Virtual Private Cloud (VPC) environment. +// A subnet group is a collection of subnets (typically private) that you can +// designate for your clusters running in an Amazon Virtual Private Cloud (VPC) +// environment. type SubnetGroup struct { // The ARN (Amazon Resource Name) of the subnet group. @@ -716,8 +713,7 @@ type SubnetGroup struct { // Key/Value pair. You can use tags to categorize and track all your MemoryDB // resources. When you add or remove tags on clusters, those actions will be // replicated to all nodes in the cluster. A tag with a null Value is permitted. -// For more information, see Tagging your MemoryDB resources -// (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html) +// For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html) type Tag struct { // The key for the tag. May not be null. @@ -744,10 +740,10 @@ type UnprocessedCluster struct { noSmithyDocumentSerde } -// You create users and assign them specific permissions by using an access string. -// You assign the users to Access Control Lists aligned with a specific role -// (administrators, human resources) that are then deployed to one or more MemoryDB -// clusters. +// You create users and assign them specific permissions by using an access +// string. You assign the users to Access Control Lists aligned with a specific +// role (administrators, human resources) that are then deployed to one or more +// MemoryDB clusters. type User struct { // The names of the Access Control Lists to which the user belongs diff --git a/service/mgn/api_client.go b/service/mgn/api_client.go index 25324bbcf34..1abea03486e 100644 --- a/service/mgn/api_client.go +++ b/service/mgn/api_client.go @@ -26,8 +26,8 @@ import ( const ServiceID = "mgn" const ServiceAPIVersion = "2020-02-26" -// Client provides the API client to make operations call for Application Migration -// Service. +// Client provides the API client to make operations call for Application +// Migration Service. type Client struct { options Options } @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mgn/api_op_CreateReplicationConfigurationTemplate.go b/service/mgn/api_op_CreateReplicationConfigurationTemplate.go index a5b1b7f4753..43d95150dfb 100644 --- a/service/mgn/api_op_CreateReplicationConfigurationTemplate.go +++ b/service/mgn/api_op_CreateReplicationConfigurationTemplate.go @@ -70,8 +70,8 @@ type CreateReplicationConfigurationTemplateInput struct { // This member is required. ReplicationServerInstanceType *string - // Request to configure the Replication Server Security group ID during Replication - // Settings template creation. + // Request to configure the Replication Server Security group ID during + // Replication Settings template creation. // // This member is required. ReplicationServersSecurityGroupsIDs []string diff --git a/service/mgn/api_op_DeleteReplicationConfigurationTemplate.go b/service/mgn/api_op_DeleteReplicationConfigurationTemplate.go index c9ec0c42718..1e8075ed36d 100644 --- a/service/mgn/api_op_DeleteReplicationConfigurationTemplate.go +++ b/service/mgn/api_op_DeleteReplicationConfigurationTemplate.go @@ -28,8 +28,8 @@ func (c *Client) DeleteReplicationConfigurationTemplate(ctx context.Context, par type DeleteReplicationConfigurationTemplateInput struct { - // Request to delete Replication Configuration Template from service by Replication - // Configuration Template ID. + // Request to delete Replication Configuration Template from service by + // Replication Configuration Template ID. // // This member is required. ReplicationConfigurationTemplateID *string diff --git a/service/mgn/api_op_DescribeJobLogItems.go b/service/mgn/api_op_DescribeJobLogItems.go index a7762499591..469173358c9 100644 --- a/service/mgn/api_op_DescribeJobLogItems.go +++ b/service/mgn/api_op_DescribeJobLogItems.go @@ -121,8 +121,8 @@ func (c *Client) addOperationDescribeJobLogItemsMiddlewares(stack *middleware.St return nil } -// DescribeJobLogItemsAPIClient is a client that implements the DescribeJobLogItems -// operation. +// DescribeJobLogItemsAPIClient is a client that implements the +// DescribeJobLogItems operation. type DescribeJobLogItemsAPIClient interface { DescribeJobLogItems(context.Context, *DescribeJobLogItemsInput, ...func(*Options)) (*DescribeJobLogItemsOutput, error) } diff --git a/service/mgn/api_op_FinalizeCutover.go b/service/mgn/api_op_FinalizeCutover.go index efb8096df42..a61d939e7cb 100644 --- a/service/mgn/api_op_FinalizeCutover.go +++ b/service/mgn/api_op_FinalizeCutover.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Finalizes the cutover immediately for specific Source Servers. All AWS resources -// created by Application Migration Service for enabling the replication of these -// source servers will be terminated / deleted within 90 minutes. Launched Test or -// Cutover instances will NOT be terminated. The AWS Replication Agent will receive -// a command to uninstall itself (within 10 minutes). The following properties of -// the SourceServer will be changed immediately: +// Finalizes the cutover immediately for specific Source Servers. All AWS +// resources created by Application Migration Service for enabling the replication +// of these source servers will be terminated / deleted within 90 minutes. Launched +// Test or Cutover instances will NOT be terminated. The AWS Replication Agent will +// receive a command to uninstall itself (within 10 minutes). The following +// properties of the SourceServer will be changed immediately: // dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The // SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes // property fo each of dataReplicationInfo.replicatedDisks will be set to zero; diff --git a/service/mgn/api_op_ListTemplateActions.go b/service/mgn/api_op_ListTemplateActions.go index b61550a4ada..0281ce83937 100644 --- a/service/mgn/api_op_ListTemplateActions.go +++ b/service/mgn/api_op_ListTemplateActions.go @@ -125,8 +125,8 @@ func (c *Client) addOperationListTemplateActionsMiddlewares(stack *middleware.St return nil } -// ListTemplateActionsAPIClient is a client that implements the ListTemplateActions -// operation. +// ListTemplateActionsAPIClient is a client that implements the +// ListTemplateActions operation. type ListTemplateActionsAPIClient interface { ListTemplateActions(context.Context, *ListTemplateActionsInput, ...func(*Options)) (*ListTemplateActionsOutput, error) } diff --git a/service/mgn/api_op_MarkAsArchived.go b/service/mgn/api_op_MarkAsArchived.go index 14a5c5303f2..db6a2491a49 100644 --- a/service/mgn/api_op_MarkAsArchived.go +++ b/service/mgn/api_op_MarkAsArchived.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Archives specific Source Servers by setting the SourceServer.isArchived property -// to true for specified SourceServers by ID. This command only works for +// Archives specific Source Servers by setting the SourceServer.isArchived +// property to true for specified SourceServers by ID. This command only works for // SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER. func (c *Client) MarkAsArchived(ctx context.Context, params *MarkAsArchivedInput, optFns ...func(*Options)) (*MarkAsArchivedOutput, error) { if params == nil { diff --git a/service/mgn/api_op_UpdateReplicationConfiguration.go b/service/mgn/api_op_UpdateReplicationConfiguration.go index 2aee4ef4045..b5aeb1b34bb 100644 --- a/service/mgn/api_op_UpdateReplicationConfiguration.go +++ b/service/mgn/api_op_UpdateReplicationConfiguration.go @@ -34,8 +34,8 @@ type UpdateReplicationConfigurationInput struct { // This member is required. SourceServerID *string - // Update replication configuration associate default Application Migration Service - // Security group request. + // Update replication configuration associate default Application Migration + // Service Security group request. AssociateDefaultSecurityGroup *bool // Update replication configuration bandwidth throttling request. diff --git a/service/mgn/api_op_UpdateReplicationConfigurationTemplate.go b/service/mgn/api_op_UpdateReplicationConfigurationTemplate.go index 6d3ab837510..40e01fd500e 100644 --- a/service/mgn/api_op_UpdateReplicationConfigurationTemplate.go +++ b/service/mgn/api_op_UpdateReplicationConfigurationTemplate.go @@ -64,8 +64,8 @@ type UpdateReplicationConfigurationTemplateInput struct { // request. ReplicationServerInstanceType *string - // Update replication configuration template Replication Server Security groups IDs - // request. + // Update replication configuration template Replication Server Security groups + // IDs request. ReplicationServersSecurityGroupsIDs []string // Update replication configuration template Staging Area subnet ID request. diff --git a/service/mgn/types/enums.go b/service/mgn/types/enums.go index 371b18a5eb0..1b5f1b9cfd9 100644 --- a/service/mgn/types/enums.go +++ b/service/mgn/types/enums.go @@ -178,8 +178,8 @@ const ( DataReplicationInitiationStepNameStartDataTransfer DataReplicationInitiationStepName = "START_DATA_TRANSFER" ) -// Values returns all known values for DataReplicationInitiationStepName. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DataReplicationInitiationStepName. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DataReplicationInitiationStepName) Values() []DataReplicationInitiationStepName { @@ -271,9 +271,9 @@ const ( ExportStatusSucceeded ExportStatus = "SUCCEEDED" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "PENDING", @@ -293,9 +293,9 @@ const ( FirstBootStopped FirstBoot = "STOPPED" ) -// Values returns all known values for FirstBoot. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FirstBoot. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FirstBoot) Values() []FirstBoot { return []FirstBoot{ "WAITING", @@ -333,9 +333,9 @@ const ( ImportStatusSucceeded ImportStatus = "SUCCEEDED" ) -// Values returns all known values for ImportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ImportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ImportStatus) Values() []ImportStatus { return []ImportStatus{ "PENDING", @@ -422,9 +422,9 @@ const ( JobStatusCompleted JobStatus = "COMPLETED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "PENDING", @@ -480,9 +480,9 @@ const ( LaunchStatusTerminated LaunchStatus = "TERMINATED" ) -// Values returns all known values for LaunchStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LaunchStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LaunchStatus) Values() []LaunchStatus { return []LaunchStatus{ "PENDING", diff --git a/service/mgn/types/errors.go b/service/mgn/types/errors.go index 3eaea7e5876..3341550b838 100644 --- a/service/mgn/types/errors.go +++ b/service/mgn/types/errors.go @@ -67,8 +67,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The server encountered an unexpected condition that prevented it from fulfilling -// the request. +// The server encountered an unexpected condition that prevented it from +// fulfilling the request. type InternalServerException struct { Message *string diff --git a/service/migrationhub/api_client.go b/service/migrationhub/api_client.go index 284c68b29d4..5c2ae805561 100644 --- a/service/migrationhub/api_client.go +++ b/service/migrationhub/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/migrationhub/api_op_AssociateCreatedArtifact.go b/service/migrationhub/api_op_AssociateCreatedArtifact.go index b677d6309cd..4f5cb434ffb 100644 --- a/service/migrationhub/api_op_AssociateCreatedArtifact.go +++ b/service/migrationhub/api_op_AssociateCreatedArtifact.go @@ -11,21 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a created artifact of an AWS cloud resource, the target receiving the -// migration, with the migration task performed by a migration tool. This API has -// the following traits: -// -// * Migration tools can call the AssociateCreatedArtifact -// operation to indicate which AWS artifact is associated with a migration task. -// -// * -// The created artifact name must be provided in ARN (Amazon Resource Name) format -// which will contain information about type and region; for example: -// arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. -// -// * Examples of the AWS -// resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, -// etc. +// Associates a created artifact of an AWS cloud resource, the target receiving +// the migration, with the migration task performed by a migration tool. This API +// has the following traits: +// - Migration tools can call the AssociateCreatedArtifact operation to indicate +// which AWS artifact is associated with a migration task. +// - The created artifact name must be provided in ARN (Amazon Resource Name) +// format which will contain information about type and region; for example: +// arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b . +// - Examples of the AWS resource behind the created artifact are, AMI's, EC2 +// instance, or DMS endpoint, etc. func (c *Client) AssociateCreatedArtifact(ctx context.Context, params *AssociateCreatedArtifactInput, optFns ...func(*Options)) (*AssociateCreatedArtifactOutput, error) { if params == nil { params = &AssociateCreatedArtifactInput{} @@ -49,8 +44,8 @@ type AssociateCreatedArtifactInput struct { // This member is required. CreatedArtifact *types.CreatedArtifact - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. // // This member is required. MigrationTaskName *string diff --git a/service/migrationhub/api_op_DeleteProgressUpdateStream.go b/service/migrationhub/api_op_DeleteProgressUpdateStream.go index e8eccf6a467..0a655e03b35 100644 --- a/service/migrationhub/api_op_DeleteProgressUpdateStream.go +++ b/service/migrationhub/api_op_DeleteProgressUpdateStream.go @@ -13,27 +13,21 @@ import ( // Deletes a progress update stream, including all of its tasks, which was // previously created as an AWS resource used for access control. This API has the // following traits: -// -// * The only parameter needed for DeleteProgressUpdateStream is -// the stream name (same as a CreateProgressUpdateStream call). -// -// * The call will -// return, and a background process will asynchronously delete the stream and all -// of its resources (tasks, associated resources, resource attributes, created -// artifacts). -// -// * If the stream takes time to be deleted, it might still show up on -// a ListProgressUpdateStreams call. -// -// * CreateProgressUpdateStream, -// ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related -// to the tasks belonging to the stream will throw "InvalidInputException" if the -// stream of the same name is in the process of being deleted. -// -// * Once the stream -// and all of its resources are deleted, CreateProgressUpdateStream for a stream of -// the same name will succeed, and that stream will be an entirely new logical -// resource (without any resources associated with the old stream). +// - The only parameter needed for DeleteProgressUpdateStream is the stream name +// (same as a CreateProgressUpdateStream call). +// - The call will return, and a background process will asynchronously delete +// the stream and all of its resources (tasks, associated resources, resource +// attributes, created artifacts). +// - If the stream takes time to be deleted, it might still show up on a +// ListProgressUpdateStreams call. +// - CreateProgressUpdateStream , ImportMigrationTask , NotifyMigrationTaskState +// , and all Associate[*] APIs related to the tasks belonging to the stream will +// throw "InvalidInputException" if the stream of the same name is in the process +// of being deleted. +// - Once the stream and all of its resources are deleted, +// CreateProgressUpdateStream for a stream of the same name will succeed, and +// that stream will be an entirely new logical resource (without any resources +// associated with the old stream). func (c *Client) DeleteProgressUpdateStream(ctx context.Context, params *DeleteProgressUpdateStreamInput, optFns ...func(*Options)) (*DeleteProgressUpdateStreamOutput, error) { if params == nil { params = &DeleteProgressUpdateStreamInput{} diff --git a/service/migrationhub/api_op_DisassociateCreatedArtifact.go b/service/migrationhub/api_op_DisassociateCreatedArtifact.go index c2eb1a65d43..cce6a23c805 100644 --- a/service/migrationhub/api_op_DisassociateCreatedArtifact.go +++ b/service/migrationhub/api_op_DisassociateCreatedArtifact.go @@ -13,18 +13,13 @@ import ( // Disassociates a created artifact of an AWS resource with a migration task // performed by a migration tool that was previously associated. This API has the // following traits: -// -// * A migration user can call the DisassociateCreatedArtifacts -// operation to disassociate a created AWS Artifact from a migration task. -// -// * The -// created artifact name must be provided in ARN (Amazon Resource Name) format -// which will contain information about type and region; for example: -// arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b. -// -// * Examples of the AWS -// resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, -// etc. +// - A migration user can call the DisassociateCreatedArtifacts operation to +// disassociate a created AWS Artifact from a migration task. +// - The created artifact name must be provided in ARN (Amazon Resource Name) +// format which will contain information about type and region; for example: +// arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b . +// - Examples of the AWS resource behind the created artifact are, AMI's, EC2 +// instance, or RDS instance, etc. func (c *Client) DisassociateCreatedArtifact(ctx context.Context, params *DisassociateCreatedArtifactInput, optFns ...func(*Options)) (*DisassociateCreatedArtifactOutput, error) { if params == nil { params = &DisassociateCreatedArtifactInput{} diff --git a/service/migrationhub/api_op_ImportMigrationTask.go b/service/migrationhub/api_op_ImportMigrationTask.go index 1fec09db544..4cb746fd9df 100644 --- a/service/migrationhub/api_op_ImportMigrationTask.go +++ b/service/migrationhub/api_op_ImportMigrationTask.go @@ -31,8 +31,8 @@ func (c *Client) ImportMigrationTask(ctx context.Context, params *ImportMigratio type ImportMigrationTaskInput struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. // // This member is required. MigrationTaskName *string diff --git a/service/migrationhub/api_op_ListApplicationStates.go b/service/migrationhub/api_op_ListApplicationStates.go index 2dcf11c253c..777c42f8d83 100644 --- a/service/migrationhub/api_op_ListApplicationStates.go +++ b/service/migrationhub/api_op_ListApplicationStates.go @@ -41,7 +41,7 @@ type ListApplicationStatesInput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string noSmithyDocumentSerde @@ -54,7 +54,7 @@ type ListApplicationStatesOutput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhub/api_op_ListCreatedArtifacts.go b/service/migrationhub/api_op_ListCreatedArtifacts.go index 1f8d8d6d4c3..fc8a3a0293f 100644 --- a/service/migrationhub/api_op_ListCreatedArtifacts.go +++ b/service/migrationhub/api_op_ListCreatedArtifacts.go @@ -14,15 +14,10 @@ import ( // Lists the created artifacts attached to a given migration task in an update // stream. This API has the following traits: -// -// * Gets the list of the created -// artifacts while migration is taking place. -// -// * Shows the artifacts created by the -// migration tool that was associated by the AssociateCreatedArtifact API. -// -// * Lists -// created artifacts in a paginated interface. +// - Gets the list of the created artifacts while migration is taking place. +// - Shows the artifacts created by the migration tool that was associated by +// the AssociateCreatedArtifact API. +// - Lists created artifacts in a paginated interface. func (c *Client) ListCreatedArtifacts(ctx context.Context, params *ListCreatedArtifactsInput, optFns ...func(*Options)) (*ListCreatedArtifactsOutput, error) { if params == nil { params = &ListCreatedArtifactsInput{} @@ -40,8 +35,8 @@ func (c *Client) ListCreatedArtifacts(ctx context.Context, params *ListCreatedAr type ListCreatedArtifactsInput struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. // // This member is required. MigrationTaskName *string @@ -56,7 +51,7 @@ type ListCreatedArtifactsInput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhub/api_op_ListDiscoveredResources.go b/service/migrationhub/api_op_ListDiscoveredResources.go index ddb6676737d..816a1ff684b 100644 --- a/service/migrationhub/api_op_ListDiscoveredResources.go +++ b/service/migrationhub/api_op_ListDiscoveredResources.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists discovered resources associated with the given MigrationTask. +// Lists discovered resources associated with the given MigrationTask . func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscoveredResourcesInput, optFns ...func(*Options)) (*ListDiscoveredResourcesOutput, error) { if params == nil { params = &ListDiscoveredResourcesInput{} @@ -45,7 +45,7 @@ type ListDiscoveredResourcesInput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhub/api_op_ListMigrationTasks.go b/service/migrationhub/api_op_ListMigrationTasks.go index 7846151b1f2..2fc4d7a5f29 100644 --- a/service/migrationhub/api_op_ListMigrationTasks.go +++ b/service/migrationhub/api_op_ListMigrationTasks.go @@ -14,15 +14,10 @@ import ( // Lists all, or filtered by resource name, migration tasks associated with the // user account making this call. This API has the following traits: -// -// * Can show a -// summary list of the most recent migration tasks. -// -// * Can show a summary list of -// migration tasks associated with a given discovered resource. -// -// * Lists migration -// tasks in a paginated interface. +// - Can show a summary list of the most recent migration tasks. +// - Can show a summary list of migration tasks associated with a given +// discovered resource. +// - Lists migration tasks in a paginated interface. func (c *Client) ListMigrationTasks(ctx context.Context, params *ListMigrationTasksInput, optFns ...func(*Options)) (*ListMigrationTasksOutput, error) { if params == nil { params = &ListMigrationTasksInput{} @@ -45,7 +40,7 @@ type ListMigrationTasksInput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string // Filter migration tasks by discovered resource name. @@ -56,9 +51,9 @@ type ListMigrationTasksInput struct { type ListMigrationTasksOutput struct { - // Lists the migration task's summary which includes: MigrationTaskName, - // ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each - // task. + // Lists the migration task's summary which includes: MigrationTaskName , + // ProgressPercent , ProgressUpdateStream , Status , and the UpdateDateTime for + // each task. MigrationTaskSummaryList []types.MigrationTaskSummary // If there are more migration tasks than the max result, return the next token to diff --git a/service/migrationhub/api_op_ListProgressUpdateStreams.go b/service/migrationhub/api_op_ListProgressUpdateStreams.go index 68fc9d065ea..226ef7fe3ce 100644 --- a/service/migrationhub/api_op_ListProgressUpdateStreams.go +++ b/service/migrationhub/api_op_ListProgressUpdateStreams.go @@ -35,7 +35,7 @@ type ListProgressUpdateStreamsInput struct { // If a NextToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in NextToken. + // returned token in NextToken . NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhub/api_op_NotifyApplicationState.go b/service/migrationhub/api_op_NotifyApplicationState.go index d1300af8a97..441ca989e29 100644 --- a/service/migrationhub/api_op_NotifyApplicationState.go +++ b/service/migrationhub/api_op_NotifyApplicationState.go @@ -13,8 +13,8 @@ import ( ) // Sets the migration state of an application. For a given application identified -// by the value passed to ApplicationId, its status is set or updated by passing -// one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED. +// by the value passed to ApplicationId , its status is set or updated by passing +// one of three values to Status : NOT_STARTED | IN_PROGRESS | COMPLETED . func (c *Client) NotifyApplicationState(ctx context.Context, params *NotifyApplicationStateInput, optFns ...func(*Options)) (*NotifyApplicationStateOutput, error) { if params == nil { params = &NotifyApplicationStateInput{} diff --git a/service/migrationhub/api_op_NotifyMigrationTaskState.go b/service/migrationhub/api_op_NotifyMigrationTaskState.go index ebfe0fba33a..57cb805ea4d 100644 --- a/service/migrationhub/api_op_NotifyMigrationTaskState.go +++ b/service/migrationhub/api_op_NotifyMigrationTaskState.go @@ -14,16 +14,11 @@ import ( // Notifies Migration Hub of the current status, progress, or other detail // regarding a migration task. This API has the following traits: -// -// * Migration -// tools will call the NotifyMigrationTaskState API to share the latest progress -// and status. -// -// * MigrationTaskName is used for addressing updates to the correct -// target. -// -// * ProgressUpdateStream is used for access control and to provide a -// namespace for each migration tool. +// - Migration tools will call the NotifyMigrationTaskState API to share the +// latest progress and status. +// - MigrationTaskName is used for addressing updates to the correct target. +// - ProgressUpdateStream is used for access control and to provide a namespace +// for each migration tool. func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMigrationTaskStateInput, optFns ...func(*Options)) (*NotifyMigrationTaskStateOutput, error) { if params == nil { params = &NotifyMigrationTaskStateInput{} @@ -41,8 +36,8 @@ func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMig type NotifyMigrationTaskStateInput struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. // // This member is required. MigrationTaskName *string diff --git a/service/migrationhub/api_op_PutResourceAttributes.go b/service/migrationhub/api_op_PutResourceAttributes.go index ba5ecd6cb12..51784ad92cb 100644 --- a/service/migrationhub/api_op_PutResourceAttributes.go +++ b/service/migrationhub/api_op_PutResourceAttributes.go @@ -14,22 +14,18 @@ import ( // Provides identifying details of the resource being migrated so that it can be // associated in the Application Discovery Service repository. This association // occurs asynchronously after PutResourceAttributes returns. +// - Keep in mind that subsequent calls to PutResourceAttributes will override +// previously stored attributes. For example, if it is first called with a MAC +// address, but later, it is desired to add an IP address, it will then be required +// to call it with both the IP and MAC addresses to prevent overriding the MAC +// address. +// - Note the instructions regarding the special use case of the +// ResourceAttributeList (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList) +// parameter when specifying any "VM" related value. // -// * Keep in mind that -// subsequent calls to PutResourceAttributes will override previously stored -// attributes. For example, if it is first called with a MAC address, but later, it -// is desired to add an IP address, it will then be required to call it with both -// the IP and MAC addresses to prevent overriding the MAC address. -// -// * Note the -// instructions regarding the special use case of the ResourceAttributeList -// (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList) -// parameter when specifying any "VM" related value. -// -// Because this is an -// asynchronous call, it will always return 200, whether an association occurs or -// not. To confirm if an association was found based on the provided details, call -// ListDiscoveredResources. +// Because this is an asynchronous call, it will always return 200, whether an +// association occurs or not. To confirm if an association was found based on the +// provided details, call ListDiscoveredResources . func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceAttributesInput, optFns ...func(*Options)) (*PutResourceAttributesOutput, error) { if params == nil { params = &PutResourceAttributesInput{} @@ -47,8 +43,8 @@ func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceA type PutResourceAttributesInput struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. // // This member is required. MigrationTaskName *string @@ -58,26 +54,22 @@ type PutResourceAttributesInput struct { // This member is required. ProgressUpdateStream *string - // Information about the resource that is being migrated. This data will be used to - // map the task to a resource in the Application Discovery Service repository. - // Takes the object array of ResourceAttribute where the Type field is reserved for - // the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | + // Information about the resource that is being migrated. This data will be used + // to map the task to a resource in the Application Discovery Service repository. + // Takes the object array of ResourceAttribute where the Type field is reserved + // for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | // VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | // MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 // characters. - // - // * If any "VM" related value is set for a ResourceAttribute object, - // it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID - // is not set, then all "VM" fields will be discarded and "VM" fields will not be - // used for matching the migration task to a server in Application Discovery - // Service repository. See the Example - // (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples) - // section below for a use case of specifying "VM" related values. - // - // * If a server - // you are trying to match has multiple IP or MAC addresses, you should provide as - // many as you know in separate type/value pairs passed to the - // ResourceAttributeList parameter to maximize the chances of matching. + // - If any "VM" related value is set for a ResourceAttribute object, it is + // required that VM_MANAGER_ID , as a minimum, is always set. If VM_MANAGER_ID is + // not set, then all "VM" fields will be discarded and "VM" fields will not be used + // for matching the migration task to a server in Application Discovery Service + // repository. See the Example (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples) + // section below for a use case of specifying "VM" related values. + // - If a server you are trying to match has multiple IP or MAC addresses, you + // should provide as many as you know in separate type/value pairs passed to the + // ResourceAttributeList parameter to maximize the chances of matching. // // This member is required. ResourceAttributeList []types.ResourceAttribute diff --git a/service/migrationhub/types/enums.go b/service/migrationhub/types/enums.go index d0892e664c0..6dd02b5451e 100644 --- a/service/migrationhub/types/enums.go +++ b/service/migrationhub/types/enums.go @@ -38,8 +38,8 @@ const ( ResourceAttributeTypeMotherboardSerialNumber ResourceAttributeType = "MOTHERBOARD_SERIAL_NUMBER" ) -// Values returns all known values for ResourceAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ResourceAttributeType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ResourceAttributeType) Values() []ResourceAttributeType { return []ResourceAttributeType{ diff --git a/service/migrationhub/types/errors.go b/service/migrationhub/types/errors.go index 097c7c62822..7753a1b824f 100644 --- a/service/migrationhub/types/errors.go +++ b/service/migrationhub/types/errors.go @@ -140,9 +140,10 @@ func (e *InvalidInputException) ErrorCode() string { } func (e *InvalidInputException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Exception raised when there are problems accessing Application Discovery Service -// (Application Discovery Service); most likely due to a misconfigured policy or -// the migrationhub-discovery role is missing or not configured correctly. +// Exception raised when there are problems accessing Application Discovery +// Service (Application Discovery Service); most likely due to a misconfigured +// policy or the migrationhub-discovery role is missing or not configured +// correctly. type PolicyErrorException struct { Message *string diff --git a/service/migrationhub/types/types.go b/service/migrationhub/types/types.go index df9a4ea11ec..904aca8ab72 100644 --- a/service/migrationhub/types/types.go +++ b/service/migrationhub/types/types.go @@ -59,15 +59,15 @@ type DiscoveredResource struct { // Represents a migration task in a migration tool. type MigrationTask struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. MigrationTaskName *string // A name that identifies the vendor of the migration tool being used. ProgressUpdateStream *string - // Information about the resource that is being migrated. This data will be used to - // map the task to a resource in the Application Discovery Service repository. + // Information about the resource that is being migrated. This data will be used + // to map the task to a resource in the Application Discovery Service repository. ResourceAttributeList []ResourceAttribute // Task object encapsulating task information. @@ -79,12 +79,12 @@ type MigrationTask struct { noSmithyDocumentSerde } -// MigrationTaskSummary includes MigrationTaskName, ProgressPercent, -// ProgressUpdateStream, Status, and UpdateDateTime for each task. +// MigrationTaskSummary includes MigrationTaskName , ProgressPercent , +// ProgressUpdateStream , Status , and UpdateDateTime for each task. type MigrationTaskSummary struct { - // Unique identifier that references the migration task. Do not store personal data - // in this field. + // Unique identifier that references the migration task. Do not store personal + // data in this field. MigrationTaskName *string // Indication of the percentage completion of the task. @@ -106,8 +106,8 @@ type MigrationTaskSummary struct { noSmithyDocumentSerde } -// Summary of the AWS resource used for access control that is implicitly linked to -// your AWS account. +// Summary of the AWS resource used for access control that is implicitly linked +// to your AWS account. type ProgressUpdateStreamSummary struct { // The name of the ProgressUpdateStream. Do not store personal data in this field. @@ -116,10 +116,10 @@ type ProgressUpdateStreamSummary struct { noSmithyDocumentSerde } -// Attribute associated with a resource. Note the corresponding format required per -// type listed below: IPV4 x.x.x.x where x is an integer in the range [0,255] IPV6 -// y : y : y : y : y : y : y : y where y is a hexadecimal between 0 and FFFF. [0, -// FFFF] MAC_ADDRESS ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ FQDN +// Attribute associated with a resource. Note the corresponding format required +// per type listed below: IPV4 x.x.x.x where x is an integer in the range [0,255] +// IPV6 y : y : y : y : y : y : y : y where y is a hexadecimal between 0 and FFFF. +// [0, FFFF] MAC_ADDRESS ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ FQDN // ^[^<>{}\\/?,=\p{Cntrl}]{1,256}$ type ResourceAttribute struct { diff --git a/service/migrationhubconfig/api_client.go b/service/migrationhubconfig/api_client.go index f48fa383578..06583fb361c 100644 --- a/service/migrationhubconfig/api_client.go +++ b/service/migrationhubconfig/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/migrationhubconfig/api_op_CreateHomeRegionControl.go b/service/migrationhubconfig/api_op_CreateHomeRegionControl.go index 1517b3290fe..92c62190db3 100644 --- a/service/migrationhubconfig/api_op_CreateHomeRegionControl.go +++ b/service/migrationhubconfig/api_op_CreateHomeRegionControl.go @@ -35,13 +35,13 @@ type CreateHomeRegionControlInput struct { HomeRegion *string // The account for which this command sets up a home region control. The Target is - // always of type ACCOUNT. + // always of type ACCOUNT . // // This member is required. Target *types.Target - // Optional Boolean flag to indicate whether any effect should take place. It tests - // whether the caller has permission to make the call. + // Optional Boolean flag to indicate whether any effect should take place. It + // tests whether the caller has permission to make the call. DryRun bool noSmithyDocumentSerde @@ -49,8 +49,8 @@ type CreateHomeRegionControlInput struct { type CreateHomeRegionControlOutput struct { - // This object is the HomeRegionControl object that's returned by a successful call - // to CreateHomeRegionControl. + // This object is the HomeRegionControl object that's returned by a successful + // call to CreateHomeRegionControl . HomeRegionControl *types.HomeRegionControl // Metadata pertaining to the operation's result. diff --git a/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go b/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go index 66c8f6be8ba..3e332cb93b1 100644 --- a/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go +++ b/service/migrationhubconfig/api_op_DescribeHomeRegionControls.go @@ -41,12 +41,12 @@ type DescribeHomeRegionControlsInput struct { // If a NextToken was returned by a previous call, more results are available. To // retrieve the next page of results, make the call again using the returned token - // in NextToken. + // in NextToken . NextToken *string // The target parameter specifies the identifier to which the home region is - // applied, which is always of type ACCOUNT. It applies the home region to the - // current ACCOUNT. + // applied, which is always of type ACCOUNT . It applies the home region to the + // current ACCOUNT . Target *types.Target noSmithyDocumentSerde @@ -59,7 +59,7 @@ type DescribeHomeRegionControlsOutput struct { // If a NextToken was returned by a previous call, more results are available. To // retrieve the next page of results, make the call again using the returned token - // in NextToken. + // in NextToken . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhubconfig/doc.go b/service/migrationhubconfig/doc.go index 6d9ac701826..ada54308b23 100644 --- a/service/migrationhubconfig/doc.go +++ b/service/migrationhubconfig/doc.go @@ -7,21 +7,16 @@ // with your Migration Hub home region. You can use these APIs to determine a home // region, as well as to create and work with controls that describe the home // region. +// - You must make API calls for write actions (create, notify, associate, +// disassociate, import, or put) while in your home region, or a +// HomeRegionNotSetException error is returned. +// - API calls for read actions (list, describe, stop, and delete) are permitted +// outside of your home region. +// - If you call a write API outside the home region, an InvalidInputException is +// returned. +// - You can call GetHomeRegion action to obtain the account's Migration Hub home +// region. // -// * You must make API calls for write actions (create, notify, associate, -// disassociate, import, or put) while in your home region, or a -// HomeRegionNotSetException error is returned. -// -// * API calls for read actions -// (list, describe, stop, and delete) are permitted outside of your home region. -// -// * -// If you call a write API outside the home region, an InvalidInputException is -// returned. -// -// * You can call GetHomeRegion action to obtain the account's Migration -// Hub home region. -// -// For specific API usage, see the sections that follow in this -// AWS Migration Hub Home Region API reference. +// For specific API usage, see the sections that follow in this AWS Migration Hub +// Home Region API reference. package migrationhubconfig diff --git a/service/migrationhubconfig/types/types.go b/service/migrationhubconfig/types/types.go index fade9315aaa..6b01fb8ec35 100644 --- a/service/migrationhubconfig/types/types.go +++ b/service/migrationhubconfig/types/types.go @@ -9,11 +9,11 @@ import ( // A home region control is an object that specifies the home region for an // account, with some additional information. It contains a target (always of type -// ACCOUNT), an ID, and a time at which the home region was set. +// ACCOUNT ), an ID, and a time at which the home region was set. type HomeRegionControl struct { - // A unique identifier that's generated for each home region control. It's always a - // string that begins with "hrc-" followed by 12 lowercase letters and numbers. + // A unique identifier that's generated for each home region control. It's always + // a string that begins with "hrc-" followed by 12 lowercase letters and numbers. ControlId *string // The AWS Region that's been set as home region. For example, "us-west-2" or @@ -25,19 +25,19 @@ type HomeRegionControl struct { RequestedTime *time.Time // The target parameter specifies the identifier to which the home region is - // applied, which is always an ACCOUNT. It applies the home region to the current - // ACCOUNT. + // applied, which is always an ACCOUNT . It applies the home region to the current + // ACCOUNT . Target *Target noSmithyDocumentSerde } // The target parameter specifies the identifier to which the home region is -// applied, which is always an ACCOUNT. It applies the home region to the current -// ACCOUNT. +// applied, which is always an ACCOUNT . It applies the home region to the current +// ACCOUNT . type Target struct { - // The target type is always an ACCOUNT. + // The target type is always an ACCOUNT . // // This member is required. Type TargetType diff --git a/service/migrationhuborchestrator/api_client.go b/service/migrationhuborchestrator/api_client.go index db9fc0887ce..cc9206e7c58 100644 --- a/service/migrationhuborchestrator/api_client.go +++ b/service/migrationhuborchestrator/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/migrationhuborchestrator/api_op_CreateWorkflowStep.go b/service/migrationhuborchestrator/api_op_CreateWorkflowStep.go index 41db6482b0c..d8ff6a8e027 100644 --- a/service/migrationhuborchestrator/api_op_CreateWorkflowStep.go +++ b/service/migrationhuborchestrator/api_op_CreateWorkflowStep.go @@ -34,8 +34,8 @@ type CreateWorkflowStepInput struct { // This member is required. Name *string - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. // // This member is required. StepActionType types.StepActionType diff --git a/service/migrationhuborchestrator/api_op_GetTemplateStep.go b/service/migrationhuborchestrator/api_op_GetTemplateStep.go index 890040aca32..e40faa302f8 100644 --- a/service/migrationhuborchestrator/api_op_GetTemplateStep.go +++ b/service/migrationhuborchestrator/api_op_GetTemplateStep.go @@ -70,8 +70,8 @@ type GetTemplateStepOutput struct { // The previous step. Previous []string - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The custom script to run tests on source or target environments. diff --git a/service/migrationhuborchestrator/api_op_GetWorkflowStep.go b/service/migrationhuborchestrator/api_op_GetWorkflowStep.go index f1b2ccad245..36baa5592ed 100644 --- a/service/migrationhuborchestrator/api_op_GetWorkflowStep.go +++ b/service/migrationhuborchestrator/api_op_GetWorkflowStep.go @@ -92,8 +92,8 @@ type GetWorkflowStepOutput struct { // The status message of the migration workflow. StatusMessage *string - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The ID of the step group. diff --git a/service/migrationhuborchestrator/api_op_ListTemplates.go b/service/migrationhuborchestrator/api_op_ListTemplates.go index d4f959d4b65..28ab3423052 100644 --- a/service/migrationhuborchestrator/api_op_ListTemplates.go +++ b/service/migrationhuborchestrator/api_op_ListTemplates.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the templates available in Migration Hub Orchestrator to create a migration -// workflow. +// List the templates available in Migration Hub Orchestrator to create a +// migration workflow. func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error) { if params == nil { params = &ListTemplatesInput{} diff --git a/service/migrationhuborchestrator/api_op_UpdateWorkflowStep.go b/service/migrationhuborchestrator/api_op_UpdateWorkflowStep.go index d76ef794283..68f37cd15f5 100644 --- a/service/migrationhuborchestrator/api_op_UpdateWorkflowStep.go +++ b/service/migrationhuborchestrator/api_op_UpdateWorkflowStep.go @@ -62,8 +62,8 @@ type UpdateWorkflowStepInput struct { // The status of the step. Status types.StepStatus - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The servers on which a step will be run. diff --git a/service/migrationhuborchestrator/types/enums.go b/service/migrationhuborchestrator/types/enums.go index e5a3aa40b68..06958d0c166 100644 --- a/service/migrationhuborchestrator/types/enums.go +++ b/service/migrationhuborchestrator/types/enums.go @@ -74,8 +74,8 @@ const ( OwnerCustom Owner = "CUSTOM" ) -// Values returns all known values for Owner. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Owner. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Owner) Values() []Owner { return []Owner{ @@ -92,9 +92,9 @@ const ( PluginHealthPluginUnhealthy PluginHealth = "UNHEALTHY" ) -// Values returns all known values for PluginHealth. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PluginHealth. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PluginHealth) Values() []PluginHealth { return []PluginHealth{ "HEALTHY", diff --git a/service/migrationhuborchestrator/types/types.go b/service/migrationhuborchestrator/types/types.go index 60c7ab34889..ce19ce3cfee 100644 --- a/service/migrationhuborchestrator/types/types.go +++ b/service/migrationhuborchestrator/types/types.go @@ -112,8 +112,9 @@ type StepAutomationConfiguration struct { noSmithyDocumentSerde } -// A map of key value pairs that is generated when you create a migration workflow. -// The key value pairs will differ based on your selection of the template. +// A map of key value pairs that is generated when you create a migration +// workflow. The key value pairs will differ based on your selection of the +// template. // // The following types satisfy this interface: // @@ -227,8 +228,8 @@ type TemplateStepSummary struct { // The previous step. Previous []string - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. StepActionType StepActionType // The ID of the step group. @@ -407,8 +408,8 @@ type WorkflowStepSummary struct { // The status message of the migration workflow. StatusMessage *string - // The action type of the step. You must run and update the status of a manual step - // for the workflow to continue after the completion of the step. + // The action type of the step. You must run and update the status of a manual + // step for the workflow to continue after the completion of the step. StepActionType StepActionType // The ID of the step. diff --git a/service/migrationhubrefactorspaces/api_client.go b/service/migrationhubrefactorspaces/api_client.go index 0f90282dcf5..6ba07938f8e 100644 --- a/service/migrationhubrefactorspaces/api_client.go +++ b/service/migrationhubrefactorspaces/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/migrationhubrefactorspaces/api_op_CreateApplication.go b/service/migrationhubrefactorspaces/api_op_CreateApplication.go index 7f9baae1569..e91ed332839 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateApplication.go +++ b/service/migrationhubrefactorspaces/api_op_CreateApplication.go @@ -81,9 +81,8 @@ type CreateApplicationOutput struct { // The Amazon Resource Name (ARN) of the application. The format for this ARN is // arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The Amazon Web Services account ID of application creator. @@ -101,8 +100,8 @@ type CreateApplicationOutput struct { // The name of the application. Name *string - // The Amazon Web Services account ID of the application owner (which is always the - // same as the environment owner account ID). + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string // The proxy type of the proxy created within the application. diff --git a/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go b/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go index f52f5fd8321..a80f082a068 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go +++ b/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go @@ -19,7 +19,7 @@ import ( // environment owner. The environment owner has cross-account visibility and // control of Refactor Spaces resources that are added to the environment by other // accounts that the environment is shared with. When creating an environment with -// a network fabric type of TRANSIT_GATEWAY, Refactor Spaces provisions a transit +// a network fabric type of TRANSIT_GATEWAY , Refactor Spaces provisions a transit // gateway in your account. func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error) { if params == nil { diff --git a/service/migrationhubrefactorspaces/api_op_CreateRoute.go b/service/migrationhubrefactorspaces/api_op_CreateRoute.go index 2a2e3a02a9c..bf94eb25369 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateRoute.go +++ b/service/migrationhubrefactorspaces/api_op_CreateRoute.go @@ -17,51 +17,45 @@ import ( // owner of the service resource is always the environment owner, regardless of // which account creates the route. Routes target a service in the application. If // an application does not have any routes, then the first route must be created as -// a DEFAULTRouteType. When created, the default route defaults to an active state -// so state is not a required input. However, like all other state values the state -// of the default route can be updated after creation, but only when all other -// routes are also inactive. Conversely, no route can be active without the default -// route also being active. When you create a route, Refactor Spaces configures the -// Amazon API Gateway to send traffic to the target service as follows: +// a DEFAULT RouteType . When created, the default route defaults to an active +// state so state is not a required input. However, like all other state values the +// state of the default route can be updated after creation, but only when all +// other routes are also inactive. Conversely, no route can be active without the +// default route also being active. When you create a route, Refactor Spaces +// configures the Amazon API Gateway to send traffic to the target service as +// follows: +// - If the service has a URL endpoint, and the endpoint resolves to a private +// IP address, Refactor Spaces routes traffic using the API Gateway VPC link. +// - If the service has a URL endpoint, and the endpoint resolves to a public IP +// address, Refactor Spaces routes traffic over the public internet. +// - If the service has an Lambda function endpoint, then Refactor Spaces +// configures the Lambda function's resource policy to allow the application's API +// Gateway to invoke the function. // -// * If the -// service has a URL endpoint, and the endpoint resolves to a private IP address, -// Refactor Spaces routes traffic using the API Gateway VPC link. -// -// * If the service -// has a URL endpoint, and the endpoint resolves to a public IP address, Refactor -// Spaces routes traffic over the public internet. -// -// * If the service has an Lambda -// function endpoint, then Refactor Spaces configures the Lambda function's -// resource policy to allow the application's API Gateway to invoke the -// function. -// -// A one-time health check is performed on the service when either the -// route is updated from inactive to active, or when it is created with an active -// state. If the health check fails, the route transitions the route state to -// FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and -// no traffic is sent to the service. For Lambda functions, the Lambda function -// state is checked. If the function is not active, the function configuration is -// updated so that Lambda resources are provisioned. If the Lambda state is Failed, -// then the route creation fails. For more information, see the -// GetFunctionConfiguration's State response parameter -// (https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) +// A one-time health check is performed on the service when either the route is +// updated from inactive to active, or when it is created with an active state. If +// the health check fails, the route transitions the route state to FAILED , an +// error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic +// is sent to the service. For Lambda functions, the Lambda function state is +// checked. If the function is not active, the function configuration is updated so +// that Lambda resources are provisioned. If the Lambda state is Failed , then the +// route creation fails. For more information, see the GetFunctionConfiguration's +// State response parameter (https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) // in the Lambda Developer Guide. For Lambda endpoints, a check is performed to // determine that a Lambda function with the specified ARN exists. If it does not // exist, the health check fails. For public URLs, a connection is opened to the // public endpoint. If the URL is not reachable, the health check fails. Refactor // Spaces automatically resolves the public Domain Name System (DNS) names that are -// set in CreateServiceRequest$UrlEndpoint when you create a service. The DNS names -// resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs -// less than 60 seconds. This periodic DNS resolution ensures that the route +// set in CreateServiceRequest$UrlEndpoint when you create a service. The DNS +// names resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for +// TTLs less than 60 seconds. This periodic DNS resolution ensures that the route // configuration remains up-to-date. For private URLS, a target group is created on // the Elastic Load Balancing and the target group health check is run. The -// HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, -// port, and path specified in the URL or health URL, if used. All other settings -// use the default values, as described in Health checks for your target groups -// (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html). -// The health check is considered successful if at least one target within the +// HealthCheckProtocol , HealthCheckPort , and HealthCheckPath are the same +// protocol, port, and path specified in the URL or health URL, if used. All other +// settings use the default values, as described in Health checks for your target +// groups (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) +// . The health check is considered successful if at least one target within the // target group transitions to a healthy state. Services can have HTTP or HTTPS URL // endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private // Certificate Authorities (CAs) are permitted only if the CA's domain is also @@ -95,8 +89,8 @@ type CreateRouteInput struct { // The route type of the route. DEFAULT indicates that all traffic that does not // match another route is forwarded to the default route. Applications must have a - // default route before any other routes can be created. URI_PATH indicates a route - // that is based on a URI path. + // default route before any other routes can be created. URI_PATH indicates a + // route that is based on a URI path. // // This member is required. RouteType types.RouteType @@ -131,9 +125,8 @@ type CreateRouteOutput struct { // The Amazon Resource Name (ARN) of the route. The format for this ARN is // arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // The Amazon Web Services account ID of the route creator. @@ -154,8 +147,8 @@ type CreateRouteOutput struct { // The route type of the route. RouteType types.RouteType - // The ID of service in which the route is created. Traffic that matches this route - // is forwarded to this service. + // The ID of service in which the route is created. Traffic that matches this + // route is forwarded to this service. ServiceId *string // The current state of the route. Activation state only allows ACTIVE or INACTIVE diff --git a/service/migrationhubrefactorspaces/api_op_CreateService.go b/service/migrationhubrefactorspaces/api_op_CreateService.go index 62a9d60467c..b7ff46ab375 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateService.go +++ b/service/migrationhubrefactorspaces/api_op_CreateService.go @@ -69,14 +69,14 @@ type CreateServiceInput struct { // The configuration for the Lambda endpoint type. LambdaEndpoint *types.LambdaEndpointInput - // The tags to assign to the service. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key-value pair.. + // The tags to assign to the service. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key-value pair.. Tags map[string]string - // The configuration for the URL endpoint type. When creating a route to a service, - // Refactor Spaces automatically resolves the address in the UrlEndpointInput - // object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or - // every 60 seconds for TTLs less than 60 seconds. + // The configuration for the URL endpoint type. When creating a route to a + // service, Refactor Spaces automatically resolves the address in the + // UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) + // expires, or every 60 seconds for TTLs less than 60 seconds. UrlEndpoint *types.UrlEndpointInput // The ID of the VPC. @@ -126,8 +126,8 @@ type CreateServiceOutput struct { // The current state of the service. State types.ServiceState - // The tags assigned to the created service. A tag is a label that you assign to an - // Amazon Web Services resource. Each tag consists of a key-value pair.. + // The tags assigned to the created service. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair.. Tags map[string]string // The configuration for the URL endpoint type. diff --git a/service/migrationhubrefactorspaces/api_op_DeleteApplication.go b/service/migrationhubrefactorspaces/api_op_DeleteApplication.go index c834b206026..ded652cde16 100644 --- a/service/migrationhubrefactorspaces/api_op_DeleteApplication.go +++ b/service/migrationhubrefactorspaces/api_op_DeleteApplication.go @@ -12,9 +12,9 @@ import ( "time" ) -// Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before -// you can delete an application, you must first delete any services or routes -// within the application. +// Deletes an Amazon Web Services Migration Hub Refactor Spaces application. +// Before you can delete an application, you must first delete any services or +// routes within the application. func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error) { if params == nil { params = &DeleteApplicationInput{} diff --git a/service/migrationhubrefactorspaces/api_op_DeleteEnvironment.go b/service/migrationhubrefactorspaces/api_op_DeleteEnvironment.go index 88bb950a109..6dc8d08113c 100644 --- a/service/migrationhubrefactorspaces/api_op_DeleteEnvironment.go +++ b/service/migrationhubrefactorspaces/api_op_DeleteEnvironment.go @@ -12,8 +12,8 @@ import ( "time" ) -// Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before -// you can delete an environment, you must first delete any applications and +// Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. +// Before you can delete an environment, you must first delete any applications and // services within the environment. func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error) { if params == nil { diff --git a/service/migrationhubrefactorspaces/api_op_GetApplication.go b/service/migrationhubrefactorspaces/api_op_GetApplication.go index 6c9c9464ee1..89daae9fedd 100644 --- a/service/migrationhubrefactorspaces/api_op_GetApplication.go +++ b/service/migrationhubrefactorspaces/api_op_GetApplication.go @@ -72,8 +72,8 @@ type GetApplicationOutput struct { // The name of the application. Name *string - // The Amazon Web Services account ID of the application owner (which is always the - // same as the environment owner account ID). + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string // The proxy type of the proxy created within the application. diff --git a/service/migrationhubrefactorspaces/api_op_GetRoute.go b/service/migrationhubrefactorspaces/api_op_GetRoute.go index 71bb295e5ba..11b94607d15 100644 --- a/service/migrationhubrefactorspaces/api_op_GetRoute.go +++ b/service/migrationhubrefactorspaces/api_op_GetRoute.go @@ -69,7 +69,7 @@ type GetRouteOutput struct { Error *types.ErrorResponse // Indicates whether to match all subpaths of the given source path. If this value - // is false, requests must match the source path exactly before they are forwarded + // is false , requests must match the source path exactly before they are forwarded // to this route's service. IncludeChildPaths *bool diff --git a/service/migrationhubrefactorspaces/api_op_ListEnvironmentVpcs.go b/service/migrationhubrefactorspaces/api_op_ListEnvironmentVpcs.go index 6c24223e0c4..fb384791ec6 100644 --- a/service/migrationhubrefactorspaces/api_op_ListEnvironmentVpcs.go +++ b/service/migrationhubrefactorspaces/api_op_ListEnvironmentVpcs.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListEnvironmentVpcsMiddlewares(stack *middleware.St return nil } -// ListEnvironmentVpcsAPIClient is a client that implements the ListEnvironmentVpcs -// operation. +// ListEnvironmentVpcsAPIClient is a client that implements the +// ListEnvironmentVpcs operation. type ListEnvironmentVpcsAPIClient interface { ListEnvironmentVpcs(context.Context, *ListEnvironmentVpcsInput, ...func(*Options)) (*ListEnvironmentVpcsOutput, error) } diff --git a/service/migrationhubrefactorspaces/api_op_ListRoutes.go b/service/migrationhubrefactorspaces/api_op_ListRoutes.go index 3b44672a7ce..24ba7f5beb5 100644 --- a/service/migrationhubrefactorspaces/api_op_ListRoutes.go +++ b/service/migrationhubrefactorspaces/api_op_ListRoutes.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an -// application. +// Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within +// an application. func (c *Client) ListRoutes(ctx context.Context, params *ListRoutesInput, optFns ...func(*Options)) (*ListRoutesOutput, error) { if params == nil { params = &ListRoutesInput{} diff --git a/service/migrationhubrefactorspaces/api_op_ListTagsForResource.go b/service/migrationhubrefactorspaces/api_op_ListTagsForResource.go index 12015b188ff..dfb1f578ccc 100644 --- a/service/migrationhubrefactorspaces/api_op_ListTagsForResource.go +++ b/service/migrationhubrefactorspaces/api_op_ListTagsForResource.go @@ -11,7 +11,7 @@ import ( ) // Lists the tags of a resource. The caller account must be the same as the -// resource’s OwnerAccountId. Listing tags in other accounts is not supported. +// resource’s OwnerAccountId . Listing tags in other accounts is not supported. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/migrationhubrefactorspaces/api_op_PutResourcePolicy.go b/service/migrationhubrefactorspaces/api_op_PutResourcePolicy.go index 8276a5fc6a1..cac79b7ae9c 100644 --- a/service/migrationhubrefactorspaces/api_op_PutResourcePolicy.go +++ b/service/migrationhubrefactorspaces/api_op_PutResourcePolicy.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a resource-based permission policy to the Amazon Web Services Migration -// Hub Refactor Spaces environment. The policy must contain the same actions and -// condition statements as the +// Attaches a resource-based permission policy to the Amazon Web Services +// Migration Hub Refactor Spaces environment. The policy must contain the same +// actions and condition statements as the // arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment // permission in Resource Access Manager. The policy must not contain new lines or // blank lines. diff --git a/service/migrationhubrefactorspaces/api_op_TagResource.go b/service/migrationhubrefactorspaces/api_op_TagResource.go index c01ea791c62..43926dd3c71 100644 --- a/service/migrationhubrefactorspaces/api_op_TagResource.go +++ b/service/migrationhubrefactorspaces/api_op_TagResource.go @@ -12,9 +12,9 @@ import ( // Removes the tags of a given resource. Tags are metadata which can be used to // manage a resource. To tag a resource, the caller account must be the same as the -// resource’s OwnerAccountId. Tagging resources in other accounts is not supported. -// Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to -// orchestrated resources, such as an environment’s transit gateway. +// resource’s OwnerAccountId . Tagging resources in other accounts is not +// supported. Amazon Web Services Migration Hub Refactor Spaces does not propagate +// tags to orchestrated resources, such as an environment’s transit gateway. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/migrationhubrefactorspaces/api_op_UntagResource.go b/service/migrationhubrefactorspaces/api_op_UntagResource.go index ca6c6a89d59..3314ec195ab 100644 --- a/service/migrationhubrefactorspaces/api_op_UntagResource.go +++ b/service/migrationhubrefactorspaces/api_op_UntagResource.go @@ -12,7 +12,7 @@ import ( // Adds to or modifies the tags of the given resource. Tags are metadata which can // be used to manage a resource. To untag a resource, the caller account must be -// the same as the resource’s OwnerAccountId. Untagging resources across accounts +// the same as the resource’s OwnerAccountId . Untagging resources across accounts // is not supported. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/migrationhubrefactorspaces/api_op_UpdateRoute.go b/service/migrationhubrefactorspaces/api_op_UpdateRoute.go index 1f29c58d497..7f5e328e3cd 100644 --- a/service/migrationhubrefactorspaces/api_op_UpdateRoute.go +++ b/service/migrationhubrefactorspaces/api_op_UpdateRoute.go @@ -30,7 +30,7 @@ func (c *Client) UpdateRoute(ctx context.Context, params *UpdateRouteInput, optF type UpdateRouteInput struct { - // If set to ACTIVE, traffic is forwarded to this route’s service after the route + // If set to ACTIVE , traffic is forwarded to this route’s service after the route // is updated. // // This member is required. @@ -61,9 +61,8 @@ type UpdateRouteOutput struct { // The Amazon Resource Name (ARN) of the route. The format for this ARN is // arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string // A timestamp that indicates when the route was last updated. diff --git a/service/migrationhubrefactorspaces/doc.go b/service/migrationhubrefactorspaces/doc.go index 8fd5ce4de82..a05c5d917f7 100644 --- a/service/migrationhubrefactorspaces/doc.go +++ b/service/migrationhubrefactorspaces/doc.go @@ -9,10 +9,9 @@ // topic for each action shows the API request parameters and the response. // Alternatively, you can use one of the Amazon Web Services SDKs to access an API // that is tailored to the programming language or platform that you're using. For -// more information, see Amazon Web Services SDKs -// (https://aws.amazon.com/tools/#SDKs). To share Refactor Spaces environments with -// other Amazon Web Services accounts or with Organizations and their OUs, use -// Resource Access Manager's CreateResourceShare API. See CreateResourceShare -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) +// more information, see Amazon Web Services SDKs (https://aws.amazon.com/tools/#SDKs) +// . To share Refactor Spaces environments with other Amazon Web Services accounts +// or with Organizations and their OUs, use Resource Access Manager's +// CreateResourceShare API. See CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) // in the Amazon Web Services RAM API Reference. package migrationhubrefactorspaces diff --git a/service/migrationhubrefactorspaces/types/enums.go b/service/migrationhubrefactorspaces/types/enums.go index 801d9a32988..4fa89aa70d4 100644 --- a/service/migrationhubrefactorspaces/types/enums.go +++ b/service/migrationhubrefactorspaces/types/enums.go @@ -84,9 +84,9 @@ const ( ErrorCodeNotAuthorized ErrorCode = "NOT_AUTHORIZED" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "INVALID_RESOURCE_STATE", @@ -209,9 +209,9 @@ const ( ProxyTypeApiGateway ProxyType = "API_GATEWAY" ) -// Values returns all known values for ProxyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ProxyType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ProxyType) Values() []ProxyType { return []ProxyType{ "API_GATEWAY", @@ -270,9 +270,9 @@ const ( RouteTypeUriPath RouteType = "URI_PATH" ) -// Values returns all known values for RouteType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RouteType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RouteType) Values() []RouteType { return []RouteType{ "DEFAULT", @@ -308,9 +308,9 @@ const ( ServiceStateFailed ServiceState = "FAILED" ) -// Values returns all known values for ServiceState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServiceState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServiceState) Values() []ServiceState { return []ServiceState{ "CREATING", diff --git a/service/migrationhubrefactorspaces/types/types.go b/service/migrationhubrefactorspaces/types/types.go index 34e58e6d43b..270b9c0f81a 100644 --- a/service/migrationhubrefactorspaces/types/types.go +++ b/service/migrationhubrefactorspaces/types/types.go @@ -27,7 +27,7 @@ type ApiGatewayProxyConfig struct { // The endpoint URL of the API Gateway proxy. ProxyUrl *string - // The name of the API Gateway stage. The name defaults to prod. + // The name of the API Gateway stage. The name defaults to prod . StageName *string // The VpcLink ID of the API Gateway proxy. @@ -47,7 +47,7 @@ type ApiGatewayProxyInput struct { // have been granted access. EndpointType ApiGatewayEndpointType - // The name of the API Gateway stage. The name defaults to prod. + // The name of the API Gateway stage. The name defaults to prod . StageName *string noSmithyDocumentSerde @@ -73,7 +73,7 @@ type ApiGatewayProxySummary struct { // The endpoint URL of the API Gateway proxy. ProxyUrl *string - // The name of the API Gateway stage. The name defaults to prod. + // The name of the API Gateway stage. The name defaults to prod . StageName *string // The VpcLink ID of the API Gateway proxy. @@ -112,8 +112,8 @@ type ApplicationSummary struct { // The name of the application. Name *string - // The Amazon Web Services account ID of the application owner (which is always the - // same as the environment owner account ID). + // The Amazon Web Services account ID of the application owner (which is always + // the same as the environment owner account ID). OwnerAccountId *string // The proxy type of the proxy created within the application. @@ -134,14 +134,14 @@ type ApplicationSummary struct { // The configuration for the default route type. type DefaultRouteInput struct { - // If set to ACTIVE, traffic is forwarded to this route’s service after the route + // If set to ACTIVE , traffic is forwarded to this route’s service after the route // is created. ActivationState RouteActivationState noSmithyDocumentSerde } -// The summary information for environments as a response to ListEnvironments. +// The summary information for environments as a response to ListEnvironments . type EnvironmentSummary struct { // The Amazon Resource Name (ARN) of the environment. @@ -184,7 +184,7 @@ type EnvironmentSummary struct { } // Provides summary information for the EnvironmentVpc resource as a response to -// ListEnvironmentVpc. +// ListEnvironmentVpc . type EnvironmentVpc struct { // The Amazon Web Services account ID of the virtual private cloud (VPC) owner. @@ -264,7 +264,7 @@ type LambdaEndpointSummary struct { noSmithyDocumentSerde } -// The summary information for the routes as a response to ListRoutes. +// The summary information for the routes as a response to ListRoutes . type RouteSummary struct { // The unique identifier of the application. @@ -286,7 +286,7 @@ type RouteSummary struct { Error *ErrorResponse // Indicates whether to match all subpaths of the given source path. If this value - // is false, requests must match the source path exactly before they are forwarded + // is false , requests must match the source path exactly before they are forwarded // to this route's service. IncludeChildPaths *bool @@ -326,7 +326,7 @@ type RouteSummary struct { noSmithyDocumentSerde } -// A summary for the service as a response to ListServices. +// A summary for the service as a response to ListServices . type ServiceSummary struct { // The unique identifier of the application. @@ -386,7 +386,7 @@ type ServiceSummary struct { // The configuration for the URI path route type. type UriPathRouteInput struct { - // If set to ACTIVE, traffic is forwarded to this route’s service after the route + // If set to ACTIVE , traffic is forwarded to this route’s service after the route // is created. // // This member is required. @@ -399,7 +399,7 @@ type UriPathRouteInput struct { SourcePath *string // Indicates whether to match all subpaths of the given source path. If this value - // is false, requests must match the source path exactly before they are forwarded + // is false , requests must match the source path exactly before they are forwarded // to this route's service. IncludeChildPaths *bool @@ -426,11 +426,10 @@ type UrlEndpointConfig struct { // The configuration for the URL endpoint type. type UrlEndpointInput struct { - // The URL to route traffic to. The URL must be an rfc3986-formatted URL - // (https://datatracker.ietf.org/doc/html/rfc3986). If the host is a domain name, - // the name must be resolvable over the public internet. If the scheme is https, - // the top level domain of the host must be listed in the IANA root zone database - // (https://www.iana.org/domains/root/db). + // The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986) + // . If the host is a domain name, the name must be resolvable over the public + // internet. If the scheme is https , the top level domain of the host must be + // listed in the IANA root zone database (https://www.iana.org/domains/root/db) . // // This member is required. Url *string @@ -453,11 +452,10 @@ type UrlEndpointSummary struct { // endpoint, and the host must be the same as the URL. HealthUrl *string - // The URL to route traffic to. The URL must be an rfc3986-formatted URL - // (https://datatracker.ietf.org/doc/html/rfc3986). If the host is a domain name, - // the name must be resolvable over the public internet. If the scheme is https, - // the top level domain of the host must be listed in the IANA root zone database - // (https://www.iana.org/domains/root/db). + // The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986) + // . If the host is a domain name, the name must be resolvable over the public + // internet. If the scheme is https , the top level domain of the host must be + // listed in the IANA root zone database (https://www.iana.org/domains/root/db) . Url *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_client.go b/service/migrationhubstrategy/api_client.go index 357e88479fd..94b0a6195c8 100644 --- a/service/migrationhubstrategy/api_client.go +++ b/service/migrationhubstrategy/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/migrationhubstrategy/api_op_GetAssessment.go b/service/migrationhubstrategy/api_op_GetAssessment.go index 92e586d774a..d37e611a66f 100644 --- a/service/migrationhubstrategy/api_op_GetAssessment.go +++ b/service/migrationhubstrategy/api_op_GetAssessment.go @@ -29,7 +29,7 @@ func (c *Client) GetAssessment(ctx context.Context, params *GetAssessmentInput, type GetAssessmentInput struct { - // The assessmentid returned by StartAssessment. + // The assessmentid returned by StartAssessment . // // This member is required. Id *string diff --git a/service/migrationhubstrategy/api_op_GetImportFileTask.go b/service/migrationhubstrategy/api_op_GetImportFileTask.go index 922187dceae..19234ace182 100644 --- a/service/migrationhubstrategy/api_op_GetImportFileTask.go +++ b/service/migrationhubstrategy/api_op_GetImportFileTask.go @@ -31,7 +31,7 @@ func (c *Client) GetImportFileTask(ctx context.Context, params *GetImportFileTas type GetImportFileTaskInput struct { // The ID of the import file task. This ID is returned in the response of - // StartImportFileTask. + // StartImportFileTask . // // This member is required. Id *string @@ -44,10 +44,10 @@ type GetImportFileTaskOutput struct { // The time that the import task completed. CompletionTime *time.Time - // The import file task id returned in the response of StartImportFileTask. + // The import file task id returned in the response of StartImportFileTask . Id *string - // The name of the import task given in StartImportFileTask. + // The name of the import task given in StartImportFileTask . ImportName *string // The S3 bucket where import file is located. diff --git a/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go b/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go index ea17b851ed4..17033a65e60 100644 --- a/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go +++ b/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go @@ -30,7 +30,7 @@ func (c *Client) GetRecommendationReportDetails(ctx context.Context, params *Get type GetRecommendationReportDetailsInput struct { // The recommendation report generation task id returned by - // StartRecommendationReportGeneration. + // StartRecommendationReportGeneration . // // This member is required. Id *string @@ -41,7 +41,7 @@ type GetRecommendationReportDetailsInput struct { type GetRecommendationReportDetailsOutput struct { // The ID of the recommendation report generation task. See the response of - // StartRecommendationReportGeneration. + // StartRecommendationReportGeneration . Id *string // Detailed information about the recommendation report. diff --git a/service/migrationhubstrategy/api_op_GetServerDetails.go b/service/migrationhubstrategy/api_op_GetServerDetails.go index 61714e85845..be6bf962235 100644 --- a/service/migrationhubstrategy/api_op_GetServerDetails.go +++ b/service/migrationhubstrategy/api_op_GetServerDetails.go @@ -39,10 +39,10 @@ type GetServerDetailsInput struct { // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of results. - // For example, if a previous call to this action returned 100 items, but you set - // maxResults to 10. You'll receive a set of 10 results along with a token. You - // then use the returned token to retrieve the next set of 10. + // The token from a previous call that you use to retrieve the next set of + // results. For example, if a previous call to this action returned 100 items, but + // you set maxResults to 10. You'll receive a set of 10 results along with a + // token. You then use the returned token to retrieve the next set of 10. NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_ListApplicationComponents.go b/service/migrationhubstrategy/api_op_ListApplicationComponents.go index 52ba4b07bcc..011df93d92b 100644 --- a/service/migrationhubstrategy/api_op_ListApplicationComponents.go +++ b/service/migrationhubstrategy/api_op_ListApplicationComponents.go @@ -33,10 +33,10 @@ type ListApplicationComponentsInput struct { // Criteria for filtering the list of application components. ApplicationComponentCriteria types.ApplicationComponentCriteria - // Specify the value based on the application component criteria type. For example, - // if applicationComponentCriteria is set to SERVER_ID and filterValue is set to - // server1, then ListApplicationComponents returns all the application components - // running on server1. + // Specify the value based on the application component criteria type. For + // example, if applicationComponentCriteria is set to SERVER_ID and filterValue is + // set to server1 , then ListApplicationComponents returns all the application + // components running on server1. FilterValue *string // The group ID specified in to filter on. @@ -46,13 +46,13 @@ type ListApplicationComponentsInput struct { // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of results. - // For example, if a previous call to this action returned 100 items, but you set - // maxResults to 10. You'll receive a set of 10 results along with a token. You - // then use the returned token to retrieve the next set of 10. + // The token from a previous call that you use to retrieve the next set of + // results. For example, if a previous call to this action returned 100 items, but + // you set maxResults to 10. You'll receive a set of 10 results along with a + // token. You then use the returned token to retrieve the next set of 10. NextToken *string - // Specifies whether to sort by ascending (ASC) or descending (DESC) order. + // Specifies whether to sort by ascending ( ASC ) or descending ( DESC ) order. Sort types.SortOrder noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_ListCollectors.go b/service/migrationhubstrategy/api_op_ListCollectors.go index 46f4c8e8c21..99a2a03c25c 100644 --- a/service/migrationhubstrategy/api_op_ListCollectors.go +++ b/service/migrationhubstrategy/api_op_ListCollectors.go @@ -34,10 +34,10 @@ type ListCollectorsInput struct { // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of results. - // For example, if a previous call to this action returned 100 items, but you set - // maxResults to 10. You'll receive a set of 10 results along with a token. You - // then use the returned token to retrieve the next set of 10. + // The token from a previous call that you use to retrieve the next set of + // results. For example, if a previous call to this action returned 100 items, but + // you set maxResults to 10. You'll receive a set of 10 results along with a + // token. You then use the returned token to retrieve the next set of 10. NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_ListImportFileTask.go b/service/migrationhubstrategy/api_op_ListImportFileTask.go index 4c2761757a9..fc9144eb58d 100644 --- a/service/migrationhubstrategy/api_op_ListImportFileTask.go +++ b/service/migrationhubstrategy/api_op_ListImportFileTask.go @@ -33,10 +33,10 @@ type ListImportFileTaskInput struct { // The total number of items to return. The maximum value is 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of results. - // For example, if a previous call to this action returned 100 items, but you set - // maxResults to 10. You'll receive a set of 10 results along with a token. You - // then use the returned token to retrieve the next set of 10. + // The token from a previous call that you use to retrieve the next set of + // results. For example, if a previous call to this action returned 100 items, but + // you set maxResults to 10. You'll receive a set of 10 results along with a + // token. You then use the returned token to retrieve the next set of 10. NextToken *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_ListServers.go b/service/migrationhubstrategy/api_op_ListServers.go index 21013c1ab06..a921ee7c445 100644 --- a/service/migrationhubstrategy/api_op_ListServers.go +++ b/service/migrationhubstrategy/api_op_ListServers.go @@ -31,9 +31,9 @@ func (c *Client) ListServers(ctx context.Context, params *ListServersInput, optF type ListServersInput struct { // Specifies the filter value, which is based on the type of server criteria. For - // example, if serverCriteria is OS_NAME, and the filterValue is equal to - // WindowsServer, then ListServers returns all of the servers matching the OS name - // WindowsServer. + // example, if serverCriteria is OS_NAME , and the filterValue is equal to + // WindowsServer , then ListServers returns all of the servers matching the OS + // name WindowsServer . FilterValue *string // Specifies the group ID to filter on. @@ -43,16 +43,16 @@ type ListServersInput struct { // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of results. - // For example, if a previous call to this action returned 100 items, but you set - // maxResults to 10. You'll receive a set of 10 results along with a token. You - // then use the returned token to retrieve the next set of 10. + // The token from a previous call that you use to retrieve the next set of + // results. For example, if a previous call to this action returned 100 items, but + // you set maxResults to 10. You'll receive a set of 10 results along with a + // token. You then use the returned token to retrieve the next set of 10. NextToken *string // Criteria for filtering servers. ServerCriteria types.ServerCriteria - // Specifies whether to sort by ascending (ASC) or descending (DESC) order. + // Specifies whether to sort by ascending ( ASC ) or descending ( DESC ) order. Sort types.SortOrder noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_StartAssessment.go b/service/migrationhubstrategy/api_op_StartAssessment.go index d2d7335aa64..1742b5310bd 100644 --- a/service/migrationhubstrategy/api_op_StartAssessment.go +++ b/service/migrationhubstrategy/api_op_StartAssessment.go @@ -33,11 +33,11 @@ type StartAssessmentInput struct { AssessmentTargets []types.AssessmentTarget // The S3 bucket used by the collectors to send analysis data to the service. The - // bucket name must begin with migrationhub-strategy-. + // bucket name must begin with migrationhub-strategy- . S3bucketForAnalysisData *string // The S3 bucket where all the reports generated by the service are stored. The - // bucket name must begin with migrationhub-strategy-. + // bucket name must begin with migrationhub-strategy- . S3bucketForReportData *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_StartImportFileTask.go b/service/migrationhubstrategy/api_op_StartImportFileTask.go index 5007176c5df..aeb36f41bea 100644 --- a/service/migrationhubstrategy/api_op_StartImportFileTask.go +++ b/service/migrationhubstrategy/api_op_StartImportFileTask.go @@ -35,7 +35,7 @@ type StartImportFileTaskInput struct { Name *string // The S3 bucket where the import file is located. The bucket name is required to - // begin with migrationhub-strategy-. + // begin with migrationhub-strategy- . // // This member is required. S3Bucket *string @@ -50,8 +50,8 @@ type StartImportFileTaskInput struct { // available in AWS Application Discovery Service. DataSourceType types.DataSourceType - // Groups the resources in the import file together with a unique name. This ID can - // be as filter in ListApplicationComponents and ListServers. + // Groups the resources in the import file together with a unique name. This ID + // can be as filter in ListApplicationComponents and ListServers . GroupId []types.Group // The S3 bucket where Strategy Recommendations uploads import results. The bucket diff --git a/service/migrationhubstrategy/api_op_StopAssessment.go b/service/migrationhubstrategy/api_op_StopAssessment.go index 3f6073d83b1..c950afa5b62 100644 --- a/service/migrationhubstrategy/api_op_StopAssessment.go +++ b/service/migrationhubstrategy/api_op_StopAssessment.go @@ -28,7 +28,7 @@ func (c *Client) StopAssessment(ctx context.Context, params *StopAssessmentInput type StopAssessmentInput struct { - // The assessmentId returned by StartAssessment. + // The assessmentId returned by StartAssessment . // // This member is required. AssessmentId *string diff --git a/service/migrationhubstrategy/api_op_UpdateServerConfig.go b/service/migrationhubstrategy/api_op_UpdateServerConfig.go index 337ad36dc79..7f1f91833d0 100644 --- a/service/migrationhubstrategy/api_op_UpdateServerConfig.go +++ b/service/migrationhubstrategy/api_op_UpdateServerConfig.go @@ -35,7 +35,7 @@ type UpdateServerConfigInput struct { ServerId *string // The preferred strategy options for the application component. See the response - // from GetServerStrategies. + // from GetServerStrategies . StrategyOption *types.StrategyOption noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/doc.go b/service/migrationhubstrategy/doc.go index 07372839f43..f2988416a1f 100644 --- a/service/migrationhubstrategy/doc.go +++ b/service/migrationhubstrategy/doc.go @@ -3,11 +3,11 @@ // Package migrationhubstrategy provides the API client, operations, and parameter // types for Migration Hub Strategy Recommendations. // -// Migration Hub Strategy Recommendations This API reference provides descriptions, -// syntax, and other details about each of the actions and data types for Migration -// Hub Strategy Recommendations (Strategy Recommendations). The topic for each -// action shows the API request parameters and the response. Alternatively, you can -// use one of the AWS SDKs to access an API that is tailored to the programming -// language or platform that you're using. For more information, see AWS SDKs -// (http://aws.amazon.com/tools/#SDKs). +// Migration Hub Strategy Recommendations This API reference provides +// descriptions, syntax, and other details about each of the actions and data types +// for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic +// for each action shows the API request parameters and the response. +// Alternatively, you can use one of the AWS SDKs to access an API that is tailored +// to the programming language or platform that you're using. For more information, +// see AWS SDKs (http://aws.amazon.com/tools/#SDKs) . package migrationhubstrategy diff --git a/service/migrationhubstrategy/types/enums.go b/service/migrationhubstrategy/types/enums.go index 69c8745953c..ad9318bddb1 100644 --- a/service/migrationhubstrategy/types/enums.go +++ b/service/migrationhubstrategy/types/enums.go @@ -12,9 +12,9 @@ const ( AnalysisTypeBinaryAnalysis AnalysisType = "BINARY_ANALYSIS" ) -// Values returns all known values for AnalysisType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AnalysisType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AnalysisType) Values() []AnalysisType { return []AnalysisType{ "SOURCE_CODE_ANALYSIS", @@ -58,9 +58,10 @@ const ( ApplicationComponentCriteriaErrorCategory ApplicationComponentCriteria = "ERROR_CATEGORY" ) -// Values returns all known values for ApplicationComponentCriteria. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ApplicationComponentCriteria. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ApplicationComponentCriteria) Values() []ApplicationComponentCriteria { return []ApplicationComponentCriteria{ "NOT_DEFINED", @@ -284,9 +285,9 @@ const ( ConditionNotContains Condition = "NOT_CONTAINS" ) -// Values returns all known values for Condition. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Condition. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Condition) Values() []Condition { return []Condition{ "EQUALS", @@ -305,9 +306,10 @@ const ( DatabaseManagementPreferenceNoPreference DatabaseManagementPreference = "No preference" ) -// Values returns all known values for DatabaseManagementPreference. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DatabaseManagementPreference. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (DatabaseManagementPreference) Values() []DatabaseManagementPreference { return []DatabaseManagementPreference{ "AWS-managed", @@ -344,9 +346,9 @@ const ( GroupNameExternalSourceType GroupName = "ExternalSourceType" ) -// Values returns all known values for GroupName. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for GroupName. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (GroupName) Values() []GroupName { return []GroupName{ "ExternalId", @@ -370,8 +372,8 @@ const ( HeterogeneousTargetDatabaseEngineMongoDb HeterogeneousTargetDatabaseEngine = "MongoDB" ) -// Values returns all known values for HeterogeneousTargetDatabaseEngine. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for HeterogeneousTargetDatabaseEngine. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (HeterogeneousTargetDatabaseEngine) Values() []HeterogeneousTargetDatabaseEngine { @@ -507,9 +509,9 @@ const ( OutputFormatJson OutputFormat = "Json" ) -// Values returns all known values for OutputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OutputFormat) Values() []OutputFormat { return []OutputFormat{ "Excel", @@ -524,9 +526,9 @@ const ( PipelineTypeAzureDevops PipelineType = "AZURE_DEVOPS" ) -// Values returns all known values for PipelineType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PipelineType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PipelineType) Values() []PipelineType { return []PipelineType{ "AZURE_DEVOPS", @@ -583,8 +585,8 @@ const ( RuntimeAnalysisStatusAnalysisFailed RuntimeAnalysisStatus = "ANALYSIS_FAILED" ) -// Values returns all known values for RuntimeAnalysisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RuntimeAnalysisStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RuntimeAnalysisStatus) Values() []RuntimeAnalysisStatus { return []RuntimeAnalysisStatus{ @@ -732,9 +734,9 @@ const ( ServerOsTypeOther ServerOsType = "Other" ) -// Values returns all known values for ServerOsType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServerOsType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServerOsType) Values() []ServerOsType { return []ServerOsType{ "WindowsServer", @@ -773,9 +775,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", diff --git a/service/migrationhubstrategy/types/types.go b/service/migrationhubstrategy/types/types.go index 606c85fad3e..195cfa4f0c1 100644 --- a/service/migrationhubstrategy/types/types.go +++ b/service/migrationhubstrategy/types/types.go @@ -185,8 +185,8 @@ type ApplicationComponentDetail struct { // Summary of the analysis status of the application component. type ApplicationComponentStatusSummary struct { - // The number of application components successfully analyzed, partially successful - // or failed analysis. + // The number of application components successfully analyzed, partially + // successful or failed analysis. Count *int32 // The status of database analysis. @@ -301,8 +301,8 @@ type AssessmentTarget struct { noSmithyDocumentSerde } -// Object containing details about applications as defined in Application Discovery -// Service. +// Object containing details about applications as defined in Application +// Discovery Service. type AssociatedApplication struct { // ID of the application as defined in Application Discovery Service. @@ -428,8 +428,8 @@ type DatabaseMigrationPreferenceMemberHeterogeneous struct { func (*DatabaseMigrationPreferenceMemberHeterogeneous) isDatabaseMigrationPreference() {} -// Indicates whether you are interested in moving to the same type of database into -// AWS. For example, from SQL Server in your environment to SQL Server on AWS. +// Indicates whether you are interested in moving to the same type of database +// into AWS. For example, from SQL Server in your environment to SQL Server on AWS. type DatabaseMigrationPreferenceMemberHomogeneous struct { Value Homogeneous @@ -469,7 +469,7 @@ type DataCollectionDetails struct { // The number of failed servers in the assessment. Failed *int32 - // The number of servers with the assessment status IN_PROGESS. + // The number of servers with the assessment status IN_PROGESS . InProgress *int32 // The total number of servers in the assessment. @@ -532,7 +532,7 @@ type ImportFileTaskInformation struct { // The ID of the import file task. Id *string - // The name of the import task given in StartImportFileTask. + // The name of the import task given in StartImportFileTask . ImportName *string // The S3 bucket where the import file is located. @@ -942,7 +942,7 @@ type StrategyOption struct { Strategy Strategy // Destination information about where the application component can migrate to. - // For example, EC2, ECS, and so on. + // For example, EC2 , ECS , and so on. TargetDestination TargetDestination // The name of the tool that can be used to transform an application component @@ -982,8 +982,8 @@ type SystemInfo struct { noSmithyDocumentSerde } -// Information of the transformation tool that can be used to migrate and modernize -// the application. +// Information of the transformation tool that can be used to migrate and +// modernize the application. type TransformationTool struct { // Description of the tool. diff --git a/service/mobile/api_client.go b/service/mobile/api_client.go index 6ed52a0dd01..bdfb668ba80 100644 --- a/service/mobile/api_client.go +++ b/service/mobile/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mobile/api_op_ExportBundle.go b/service/mobile/api_op_ExportBundle.go index ef0de57ff8c..34ea058dbbb 100644 --- a/service/mobile/api_op_ExportBundle.go +++ b/service/mobile/api_op_ExportBundle.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates customized software development kit (SDK) and or tool packages used to -// integrate mobile web or mobile app clients with backend AWS resources. +// Generates customized software development kit (SDK) and or tool packages used +// to integrate mobile web or mobile app clients with backend AWS resources. func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, optFns ...func(*Options)) (*ExportBundleOutput, error) { if params == nil { params = &ExportBundleInput{} diff --git a/service/mobile/api_op_UpdateProject.go b/service/mobile/api_op_UpdateProject.go index a82050d1e7d..d079f33f7b0 100644 --- a/service/mobile/api_op_UpdateProject.go +++ b/service/mobile/api_op_UpdateProject.go @@ -35,8 +35,8 @@ type UpdateProjectInput struct { // This member is required. ProjectId *string - // ZIP or YAML file which contains project configuration to be updated. This should - // be the contents of the file downloaded from the URL provided in an export + // ZIP or YAML file which contains project configuration to be updated. This + // should be the contents of the file downloaded from the URL provided in an export // project operation. Contents []byte diff --git a/service/mobile/types/enums.go b/service/mobile/types/enums.go index b10432f3874..d5cd56954fe 100644 --- a/service/mobile/types/enums.go +++ b/service/mobile/types/enums.go @@ -39,9 +39,9 @@ const ( ProjectStateImporting ProjectState = "IMPORTING" ) -// Values returns all known values for ProjectState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProjectState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ProjectState) Values() []ProjectState { return []ProjectState{ "NORMAL", diff --git a/service/mobile/types/errors.go b/service/mobile/types/errors.go index 39b3d3b458a..c6817354256 100644 --- a/service/mobile/types/errors.go +++ b/service/mobile/types/errors.go @@ -60,8 +60,8 @@ func (e *BadRequestException) ErrorCode() string { } func (e *BadRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The service has encountered an unexpected error condition which prevents it from -// servicing the request. +// The service has encountered an unexpected error condition which prevents it +// from servicing the request. type InternalFailureException struct { Message *string @@ -144,8 +144,8 @@ func (e *NotFoundException) ErrorCode() string { } func (e *NotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The service is temporarily unavailable. The request should be retried after some -// time delay. +// The service is temporarily unavailable. The request should be retried after +// some time delay. type ServiceUnavailableException struct { Message *string diff --git a/service/mq/api_client.go b/service/mq/api_client.go index 691b3b86ef9..0ca43f35808 100644 --- a/service/mq/api_client.go +++ b/service/mq/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mq/api_op_CreateBroker.go b/service/mq/api_op_CreateBroker.go index b17dff67203..df506f6bc63 100644 --- a/service/mq/api_op_CreateBroker.go +++ b/service/mq/api_op_CreateBroker.go @@ -15,44 +15,23 @@ import ( // Creates a broker. Note: This API is asynchronous. To create a broker, you must // either use the AmazonMQFullAccess IAM policy or include the following EC2 // permissions in your IAM policy. +// - ec2:CreateNetworkInterface This permission is required to allow Amazon MQ +// to create an elastic network interface (ENI) on behalf of your account. +// - ec2:CreateNetworkInterfacePermission This permission is required to attach +// the ENI to the broker instance. +// - ec2:DeleteNetworkInterface +// - ec2:DeleteNetworkInterfacePermission +// - ec2:DetachNetworkInterface +// - ec2:DescribeInternetGateways +// - ec2:DescribeNetworkInterfaces +// - ec2:DescribeNetworkInterfacePermissions +// - ec2:DescribeRouteTables +// - ec2:DescribeSecurityGroups +// - ec2:DescribeSubnets +// - ec2:DescribeVpcs // -// * ec2:CreateNetworkInterface This permission is -// required to allow Amazon MQ to create an elastic network interface (ENI) on -// behalf of your account. -// -// * ec2:CreateNetworkInterfacePermission This permission -// is required to attach the ENI to the broker instance. -// -// * -// ec2:DeleteNetworkInterface -// -// * ec2:DeleteNetworkInterfacePermission -// -// * -// ec2:DetachNetworkInterface -// -// * ec2:DescribeInternetGateways -// -// * -// ec2:DescribeNetworkInterfaces -// -// * ec2:DescribeNetworkInterfacePermissions -// -// * -// ec2:DescribeRouteTables -// -// * ec2:DescribeSecurityGroups -// -// * ec2:DescribeSubnets -// -// * -// ec2:DescribeVpcs -// -// For more information, see Create an IAM User and Get Your AWS -// Credentials -// (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user) -// and Never Modify or Delete the Amazon MQ Elastic Network Interface -// (https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface) +// For more information, see Create an IAM User and Get Your AWS Credentials (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user) +// and Never Modify or Delete the Amazon MQ Elastic Network Interface (https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface) // in the Amazon MQ Developer Guide. func (c *Client) CreateBroker(ctx context.Context, params *CreateBrokerInput, optFns ...func(*Options)) (*CreateBrokerOutput, error) { if params == nil { @@ -80,10 +59,10 @@ type CreateBrokerInput struct { // This member is required. AutoMinorVersionUpgrade bool - // Required. The broker's name. This value must be unique in your AWS account, 1-50 - // characters long, must contain only letters, numbers, dashes, and underscores, - // and must not contain white spaces, brackets, wildcard characters, or special - // characters. + // Required. The broker's name. This value must be unique in your AWS account, + // 1-50 characters long, must contain only letters, numbers, dashes, and + // underscores, and must not contain white spaces, brackets, wildcard characters, + // or special characters. // // This member is required. BrokerName *string @@ -100,8 +79,8 @@ type CreateBrokerInput struct { EngineType types.EngineType // Required. The broker engine's version. For a list of supported engine versions, - // see Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // see Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . // // This member is required. EngineVersion *string @@ -111,8 +90,8 @@ type CreateBrokerInput struct { // This member is required. HostInstanceType *string - // Enables connections from applications outside of the VPC that hosts the broker's - // subnets. Set to false by default, if no value is provided. + // Enables connections from applications outside of the VPC that hosts the + // broker's subnets. Set to false by default, if no value is provided. // // This member is required. PubliclyAccessible bool @@ -170,11 +149,10 @@ type CreateBrokerInput struct { // deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ // deployment has no subnet requirements when deployed with public accessibility. // Deployment without public accessibility requires at least one subnet. If you - // specify subnets in a shared VPC - // (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html) for a - // RabbitMQ broker, the associated VPC to which the specified subnets belong must - // be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints - // in VPCs that are not owned by your AWS account. + // specify subnets in a shared VPC (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html) + // for a RabbitMQ broker, the associated VPC to which the specified subnets belong + // must be owned by your AWS account. Amazon MQ will not be able to create VPC + // endpoints in VPCs that are not owned by your AWS account. SubnetIds []string // Create tags when creating the broker. diff --git a/service/mq/api_op_CreateConfiguration.go b/service/mq/api_op_CreateConfiguration.go index 4ac252dfbae..0b59da19890 100644 --- a/service/mq/api_op_CreateConfiguration.go +++ b/service/mq/api_op_CreateConfiguration.go @@ -12,8 +12,8 @@ import ( "time" ) -// Creates a new configuration for the specified configuration name. Amazon MQ uses -// the default configuration (the engine type and version). +// Creates a new configuration for the specified configuration name. Amazon MQ +// uses the default configuration (the engine type and version). func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigurationInput, optFns ...func(*Options)) (*CreateConfigurationOutput, error) { if params == nil { params = &CreateConfigurationInput{} @@ -29,8 +29,8 @@ func (c *Client) CreateConfiguration(ctx context.Context, params *CreateConfigur return out, nil } -// Creates a new configuration for the specified configuration name. Amazon MQ uses -// the default configuration (the engine type and version). +// Creates a new configuration for the specified configuration name. Amazon MQ +// uses the default configuration (the engine type and version). type CreateConfigurationInput struct { // Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and @@ -40,8 +40,8 @@ type CreateConfigurationInput struct { EngineType types.EngineType // Required. The broker engine's version. For a list of supported engine versions, - // see Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // see Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . // // This member is required. EngineVersion *string diff --git a/service/mq/api_op_DescribeBroker.go b/service/mq/api_op_DescribeBroker.go index 358858aa2f5..1a724eb1d80 100644 --- a/service/mq/api_op_DescribeBroker.go +++ b/service/mq/api_op_DescribeBroker.go @@ -85,8 +85,8 @@ type DescribeBrokerOutput struct { EngineType types.EngineType // The broker engine's version. For a list of supported engine versions, see - // Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . EngineVersion *string // The broker's instance type. @@ -108,13 +108,13 @@ type DescribeBrokerOutput struct { PendingAuthenticationStrategy types.AuthenticationStrategy // The broker engine version to upgrade to. For a list of supported engine - // versions, see Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // versions, see Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . PendingEngineVersion *string // The broker's host instance type to upgrade to. For a list of supported instance - // types, see Broker instance types - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types). + // types, see Broker instance types (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types) + // . PendingHostInstanceType *string // The metadata of the LDAP server that will be used to authenticate and authorize @@ -124,8 +124,8 @@ type DescribeBrokerOutput struct { // The list of pending security groups to authorize connections to brokers. PendingSecurityGroups []string - // Enables connections from applications outside of the VPC that hosts the broker's - // subnets. + // Enables connections from applications outside of the VPC that hosts the + // broker's subnets. PubliclyAccessible bool // The list of rules (1 minimum, 125 maximum) that authorize connections to diff --git a/service/mq/api_op_DescribeConfiguration.go b/service/mq/api_op_DescribeConfiguration.go index a82739e04c8..262d1dfa648 100644 --- a/service/mq/api_op_DescribeConfiguration.go +++ b/service/mq/api_op_DescribeConfiguration.go @@ -58,8 +58,8 @@ type DescribeConfigurationOutput struct { EngineType types.EngineType // Required. The broker engine's version. For a list of supported engine versions, - // see, Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // see, Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . EngineVersion *string // Required. The unique ID that Amazon MQ generates for the configuration. diff --git a/service/mq/api_op_ListUsers.go b/service/mq/api_op_ListUsers.go index d85a958ad6d..fc007a0180a 100644 --- a/service/mq/api_op_ListUsers.go +++ b/service/mq/api_op_ListUsers.go @@ -50,8 +50,8 @@ type ListUsersOutput struct { // Required. The unique ID that Amazon MQ generates for the broker. BrokerId *string - // Required. The maximum number of ActiveMQ users that can be returned per page (20 - // by default). This value must be an integer from 5 to 100. + // Required. The maximum number of ActiveMQ users that can be returned per page + // (20 by default). This value must be an integer from 5 to 100. MaxResults int32 // The token that specifies the next page of results Amazon MQ should return. To diff --git a/service/mq/api_op_UpdateBroker.go b/service/mq/api_op_UpdateBroker.go index eeec8df7ca6..51d7402ad08 100644 --- a/service/mq/api_op_UpdateBroker.go +++ b/service/mq/api_op_UpdateBroker.go @@ -48,13 +48,13 @@ type UpdateBrokerInput struct { Configuration *types.ConfigurationId // The broker engine version. For a list of supported engine versions, see - // Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . EngineVersion *string // The broker's host instance type to upgrade to. For a list of supported instance - // types, see Broker instance types - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types). + // types, see Broker instance types (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types) + // . HostInstanceType *string // Optional. The metadata of the LDAP server used to authenticate and authorize @@ -92,13 +92,13 @@ type UpdateBrokerOutput struct { Configuration *types.ConfigurationId // The broker engine version to upgrade to. For a list of supported engine - // versions, see Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // versions, see Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . EngineVersion *string // The broker's host instance type to upgrade to. For a list of supported instance - // types, see Broker instance types - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types). + // types, see Broker instance types (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types) + // . HostInstanceType *string // Optional. The metadata of the LDAP server used to authenticate and authorize diff --git a/service/mq/types/enums.go b/service/mq/types/enums.go index 49dc3be35c3..ad49d5c34b8 100644 --- a/service/mq/types/enums.go +++ b/service/mq/types/enums.go @@ -97,9 +97,9 @@ const ( DayOfWeekSunday DayOfWeek = "SUNDAY" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "MONDAY", diff --git a/service/mq/types/types.go b/service/mq/types/types.go index 3631684cebc..517c067fb78 100644 --- a/service/mq/types/types.go +++ b/service/mq/types/types.go @@ -14,9 +14,8 @@ type ActionRequired struct { // The code you can use to resolve your broker issue when the broker is in a // CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing the link // for your code from the list of action required codes in Amazon MQ action - // required codes - // (https://docs.aws.amazon.com//latest/developer-guide/troubleshooting-action-required-codes.html). - // Each code references a topic with detailed information, instructions, and + // required codes (https://docs.aws.amazon.com//latest/developer-guide/troubleshooting-action-required-codes.html) + // . Each code references a topic with detailed information, instructions, and // recommendations for how to resolve the issue and prevent future occurrences. ActionRequiredCode *string @@ -155,8 +154,8 @@ type Configuration struct { EngineType EngineType // Required. The broker engine's version. For a list of supported engine versions, - // see, Supported engines - // (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html). + // see, Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html) + // . // // This member is required. EngineVersion *string @@ -276,13 +275,14 @@ type LdapServerMetadataInput struct { // This member is required. RoleBase *string - // The LDAP search filter used to find roles within the roleBase. The distinguished - // name of the user matched by userSearchMatching is substituted into the {0} - // placeholder in the search filter. The client's username is substituted into the - // {1} placeholder. For example, if you set this option to (member=uid={1})for the - // user janedoe, the search filter becomes (member=uid=janedoe) after string - // substitution. It matches all role entries that have a member attribute equal to - // uid=janedoe under the subtree selected by the roleBase. + // The LDAP search filter used to find roles within the roleBase. The + // distinguished name of the user matched by userSearchMatching is substituted into + // the {0} placeholder in the search filter. The client's username is substituted + // into the {1} placeholder. For example, if you set this option to + // (member=uid={1})for the user janedoe, the search filter becomes + // (member=uid=janedoe) after string substitution. It matches all role entries that + // have a member attribute equal to uid=janedoe under the subtree selected by the + // roleBase. // // This member is required. RoleSearchMatching *string @@ -355,13 +355,14 @@ type LdapServerMetadataOutput struct { // This member is required. RoleBase *string - // The LDAP search filter used to find roles within the roleBase. The distinguished - // name of the user matched by userSearchMatching is substituted into the {0} - // placeholder in the search filter. The client's username is substituted into the - // {1} placeholder. For example, if you set this option to (member=uid={1})for the - // user janedoe, the search filter becomes (member=uid=janedoe) after string - // substitution. It matches all role entries that have a member attribute equal to - // uid=janedoe under the subtree selected by the roleBase. + // The LDAP search filter used to find roles within the roleBase. The + // distinguished name of the user matched by userSearchMatching is substituted into + // the {0} placeholder in the search filter. The client's username is substituted + // into the {1} placeholder. For example, if you set this option to + // (member=uid={1})for the user janedoe, the search filter becomes + // (member=uid=janedoe) after string substitution. It matches all role entries that + // have a member attribute equal to uid=janedoe under the subtree selected by the + // roleBase. // // This member is required. RoleSearchMatching *string @@ -464,8 +465,8 @@ type PendingLogs struct { noSmithyDocumentSerde } -// Returns information about the XML element or attribute that was sanitized in the -// configuration. +// Returns information about the XML element or attribute that was sanitized in +// the configuration. type SanitizationWarning struct { // Required. The reason for which the XML elements or attributes were sanitized. @@ -506,8 +507,8 @@ type User struct { // This member is required. Username *string - // Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply - // to RabbitMQ brokers. + // Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not + // apply to RabbitMQ brokers. ConsoleAccess bool // The list of groups (20 maximum) to which the ActiveMQ user belongs. This value @@ -555,8 +556,8 @@ type UserSummary struct { noSmithyDocumentSerde } -// The scheduled time period relative to UTC during which Amazon MQ begins to apply -// pending updates or patches to the broker. +// The scheduled time period relative to UTC during which Amazon MQ begins to +// apply pending updates or patches to the broker. type WeeklyStartTime struct { // Required. The day of the week. diff --git a/service/mturk/api_client.go b/service/mturk/api_client.go index cf760e289b9..5905adf09d6 100644 --- a/service/mturk/api_client.go +++ b/service/mturk/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mturk/api_op_ApproveAssignment.go b/service/mturk/api_op_ApproveAssignment.go index 4fd67936bba..12b85399373 100644 --- a/service/mturk/api_op_ApproveAssignment.go +++ b/service/mturk/api_op_ApproveAssignment.go @@ -13,21 +13,18 @@ import ( // The ApproveAssignment operation approves the results of a completed assignment. // Approving an assignment initiates two payments from the Requester's Amazon.com // account +// - The Worker who submitted the results is paid the reward specified in the +// HIT. +// - Amazon Mechanical Turk fees are debited. // -// * The Worker who submitted the results is paid the reward specified in -// the HIT. -// -// * Amazon Mechanical Turk fees are debited. -// -// If the Requester's account -// does not have adequate funds for these payments, the call to ApproveAssignment -// returns an exception, and the approval is not processed. You can include an -// optional feedback message with the approval, which the Worker can see in the -// Status section of the web site. You can also call this operation for assignments -// that were previous rejected and approve them by explicitly overriding the -// previous rejection. This only works on rejected assignments that were submitted -// within the previous 30 days and only if the assignment's related HIT has not -// been deleted. +// If the Requester's account does not have adequate funds for these payments, the +// call to ApproveAssignment returns an exception, and the approval is not +// processed. You can include an optional feedback message with the approval, which +// the Worker can see in the Status section of the web site. You can also call this +// operation for assignments that were previous rejected and approve them by +// explicitly overriding the previous rejection. This only works on rejected +// assignments that were submitted within the previous 30 days and only if the +// assignment's related HIT has not been deleted. func (c *Client) ApproveAssignment(ctx context.Context, params *ApproveAssignmentInput, optFns ...func(*Options)) (*ApproveAssignmentOutput, error) { if params == nil { params = &ApproveAssignmentInput{} @@ -45,14 +42,14 @@ func (c *Client) ApproveAssignment(ctx context.Context, params *ApproveAssignmen type ApproveAssignmentInput struct { - // The ID of the assignment. The assignment must correspond to a HIT created by the - // Requester. + // The ID of the assignment. The assignment must correspond to a HIT created by + // the Requester. // // This member is required. AssignmentId *string // A flag indicating that an assignment should be approved even if it was - // previously rejected. Defaults to False. + // previously rejected. Defaults to False . OverrideRejection *bool // A message for the Worker, which the Worker can see in the Status section of the diff --git a/service/mturk/api_op_AssociateQualificationWithWorker.go b/service/mturk/api_op_AssociateQualificationWithWorker.go index e236c71e192..452178aea82 100644 --- a/service/mturk/api_op_AssociateQualificationWithWorker.go +++ b/service/mturk/api_op_AssociateQualificationWithWorker.go @@ -43,8 +43,8 @@ type AssociateQualificationWithWorkerInput struct { // This member is required. QualificationTypeId *string - // The ID of the Worker to whom the Qualification is being assigned. Worker IDs are - // included with submitted HIT assignments and Qualification requests. + // The ID of the Worker to whom the Qualification is being assigned. Worker IDs + // are included with submitted HIT assignments and Qualification requests. // // This member is required. WorkerId *string @@ -52,8 +52,9 @@ type AssociateQualificationWithWorkerInput struct { // The value of the Qualification to assign. IntegerValue *int32 - // Specifies whether to send a notification email message to the Worker saying that - // the qualification was assigned to the Worker. Note: this is true by default. + // Specifies whether to send a notification email message to the Worker saying + // that the qualification was assigned to the Worker. Note: this is true by + // default. SendNotification *bool noSmithyDocumentSerde diff --git a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go index 694bcad3683..017cd684eb7 100644 --- a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go +++ b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go @@ -13,17 +13,14 @@ import ( // The CreateAdditionalAssignmentsForHIT operation increases the maximum number of // assignments of an existing HIT. To extend the maximum number of assignments, // specify the number of additional assignments. -// -// * HITs created with fewer than 10 -// assignments cannot be extended to have 10 or more assignments. Attempting to add -// assignments in a way that brings the total number of assignments for a HIT from -// fewer than 10 assignments to 10 or more assignments will result in an -// AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. -// -// * HITs that -// were created before July 22, 2015 cannot be extended. Attempting to extend HITs -// that were created before July 22, 2015 will result in an -// AWS.MechanicalTurk.HITTooOldForExtension exception. +// - HITs created with fewer than 10 assignments cannot be extended to have 10 +// or more assignments. Attempting to add assignments in a way that brings the +// total number of assignments for a HIT from fewer than 10 assignments to 10 or +// more assignments will result in an +// AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. +// - HITs that were created before July 22, 2015 cannot be extended. Attempting +// to extend HITs that were created before July 22, 2015 will result in an +// AWS.MechanicalTurk.HITTooOldForExtension exception. func (c *Client) CreateAdditionalAssignmentsForHIT(ctx context.Context, params *CreateAdditionalAssignmentsForHITInput, optFns ...func(*Options)) (*CreateAdditionalAssignmentsForHITOutput, error) { if params == nil { params = &CreateAdditionalAssignmentsForHITInput{} @@ -55,7 +52,7 @@ type CreateAdditionalAssignmentsForHITInput struct { // error without extending the HIT multiple times. This is useful in cases such as // network timeouts where it is unclear whether or not the call succeeded on the // server. If the extend HIT already exists in the system from a previous call - // using the same UniqueRequestToken, subsequent calls will return an error with a + // using the same UniqueRequestToken , subsequent calls will return an error with a // message containing the request ID. UniqueRequestToken *string diff --git a/service/mturk/api_op_CreateHIT.go b/service/mturk/api_op_CreateHIT.go index 05951ac6eb0..35eca52113d 100644 --- a/service/mturk/api_op_CreateHIT.go +++ b/service/mturk/api_op_CreateHIT.go @@ -11,22 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT -// is made available for Workers to find and accept on the Amazon Mechanical Turk -// website. This operation allows you to specify a new HIT by passing in values for -// the properties of the HIT, such as its title, reward amount and number of -// assignments. When you pass these values to CreateHIT, a new HIT is created for -// you, with a new HITTypeID. The HITTypeID can be used to create additional HITs -// in the future without needing to specify common parameters such as the title, -// description and reward amount each time. An alternative way to create HITs is to -// first generate a HITTypeID using the CreateHITType operation and then call the -// CreateHITWithHITType operation. This is the recommended best practice for -// Requesters who are creating large numbers of HITs. CreateHIT also supports -// several ways to provide question data: by providing a value for the Question -// parameter that fully specifies the contents of the HIT, or by providing a -// HitLayoutId and associated HitLayoutParameters. If a HIT is created with 10 or -// more maximum assignments, there is an additional fee. For more information, see -// Amazon Mechanical Turk Pricing (https://requester.mturk.com/pricing). +// The CreateHIT operation creates a new Human Intelligence Task (HIT). The new +// HIT is made available for Workers to find and accept on the Amazon Mechanical +// Turk website. This operation allows you to specify a new HIT by passing in +// values for the properties of the HIT, such as its title, reward amount and +// number of assignments. When you pass these values to CreateHIT , a new HIT is +// created for you, with a new HITTypeID . The HITTypeID can be used to create +// additional HITs in the future without needing to specify common parameters such +// as the title, description and reward amount each time. An alternative way to +// create HITs is to first generate a HITTypeID using the CreateHITType operation +// and then call the CreateHITWithHITType operation. This is the recommended best +// practice for Requesters who are creating large numbers of HITs. CreateHIT also +// supports several ways to provide question data: by providing a value for the +// Question parameter that fully specifies the contents of the HIT, or by providing +// a HitLayoutId and associated HitLayoutParameters . If a HIT is created with 10 +// or more maximum assignments, there is an additional fee. For more information, +// see Amazon Mechanical Turk Pricing (https://requester.mturk.com/pricing) . func (c *Client) CreateHIT(ctx context.Context, params *CreateHITInput, optFns ...func(*Options)) (*CreateHITOutput, error) { if params == nil { params = &CreateHITInput{} @@ -83,8 +83,8 @@ type CreateHITInput struct { // This member is required. Title *string - // The Assignment-level Review Policy applies to the assignments under the HIT. You - // can specify for Mechanical Turk to take various actions based on the policy. + // The Assignment-level Review Policy applies to the assignments under the HIT. + // You can specify for Mechanical Turk to take various actions based on the policy. AssignmentReviewPolicy *types.ReviewPolicy // The number of seconds after an assignment for the HIT has been submitted, after @@ -111,8 +111,8 @@ type CreateHITInput struct { // words are used in searches to find HITs. Keywords *string - // The number of times the HIT can be accepted and completed before the HIT becomes - // unavailable. + // The number of times the HIT can be accepted and completed before the HIT + // becomes unavailable. MaxAssignments *int32 // Conditions that a Worker's Qualifications must meet in order to accept the HIT. @@ -122,24 +122,24 @@ type CreateHITInput struct { // QualificationRequirement structure. QualificationRequirements []types.QualificationRequirement - // The data the person completing the HIT uses to produce the results. Constraints: - // Must be a QuestionForm data structure, an ExternalQuestion data structure, or an - // HTMLQuestion data structure. The XML question data must not be larger than 64 - // kilobytes (65,535 bytes) in size, including whitespace. Either a Question - // parameter or a HITLayoutId parameter must be provided. + // The data the person completing the HIT uses to produce the results. + // Constraints: Must be a QuestionForm data structure, an ExternalQuestion data + // structure, or an HTMLQuestion data structure. The XML question data must not be + // larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a + // Question parameter or a HITLayoutId parameter must be provided. Question *string - // An arbitrary data field. The RequesterAnnotation parameter lets your application - // attach arbitrary data to the HIT for tracking purposes. For example, this - // parameter could be an identifier internal to the Requester's application that - // corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only - // visible to the Requester who created the HIT. It is not shown to the Worker, or - // any other Requester. The RequesterAnnotation parameter may be different for each - // HIT you submit. It does not affect how your HITs are grouped. + // An arbitrary data field. The RequesterAnnotation parameter lets your + // application attach arbitrary data to the HIT for tracking purposes. For example, + // this parameter could be an identifier internal to the Requester's application + // that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is + // only visible to the Requester who created the HIT. It is not shown to the + // Worker, or any other Requester. The RequesterAnnotation parameter may be + // different for each HIT you submit. It does not affect how your HITs are grouped. RequesterAnnotation *string - // A unique identifier for this request which allows you to retry the call on error - // without creating duplicate HITs. This is useful in cases such as network + // A unique identifier for this request which allows you to retry the call on + // error without creating duplicate HITs. This is useful in cases such as network // timeouts where it is unclear whether or not the call succeeded on the server. If // the HIT already exists in the system from a previous call using the same // UniqueRequestToken, subsequent calls will return a @@ -154,8 +154,8 @@ type CreateHITInput struct { type CreateHITOutput struct { - // Contains the newly created HIT data. For a description of the HIT data structure - // as it appears in responses, see the HIT Data Structure documentation. + // Contains the newly created HIT data. For a description of the HIT data + // structure as it appears in responses, see the HIT Data Structure documentation. HIT *types.HIT // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_CreateHITType.go b/service/mturk/api_op_CreateHITType.go index a234d676c2e..d5b9680a94c 100644 --- a/service/mturk/api_op_CreateHITType.go +++ b/service/mturk/api_op_CreateHITType.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The CreateHITType operation creates a new HIT type. This operation allows you to -// define a standard set of HIT properties to use when creating HITs. If you +// The CreateHITType operation creates a new HIT type. This operation allows you +// to define a standard set of HIT properties to use when creating HITs. If you // register a HIT type with values that match an existing HIT type, the HIT type ID // of the existing type will be returned. func (c *Client) CreateHITType(ctx context.Context, params *CreateHITTypeInput, optFns ...func(*Options)) (*CreateHITTypeOutput, error) { diff --git a/service/mturk/api_op_CreateHITWithHITType.go b/service/mturk/api_op_CreateHITWithHITType.go index e0f26dd7b07..1242aacd8fe 100644 --- a/service/mturk/api_op_CreateHITWithHITType.go +++ b/service/mturk/api_op_CreateHITWithHITType.go @@ -12,15 +12,15 @@ import ( ) // The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) -// using an existing HITTypeID generated by the CreateHITType operation. This is an -// alternative way to create HITs from the CreateHIT operation. This is the +// using an existing HITTypeID generated by the CreateHITType operation. This is +// an alternative way to create HITs from the CreateHIT operation. This is the // recommended best practice for Requesters who are creating large numbers of HITs. // CreateHITWithHITType also supports several ways to provide question data: by // providing a value for the Question parameter that fully specifies the contents -// of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters. If -// a HIT is created with 10 or more maximum assignments, there is an additional -// fee. For more information, see Amazon Mechanical Turk Pricing -// (https://requester.mturk.com/pricing). +// of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters . +// If a HIT is created with 10 or more maximum assignments, there is an additional +// fee. For more information, see Amazon Mechanical Turk Pricing (https://requester.mturk.com/pricing) +// . func (c *Client) CreateHITWithHITType(ctx context.Context, params *CreateHITWithHITTypeInput, optFns ...func(*Options)) (*CreateHITWithHITTypeOutput, error) { if params == nil { params = &CreateHITWithHITTypeInput{} @@ -51,8 +51,8 @@ type CreateHITWithHITTypeInput struct { // This member is required. LifetimeInSeconds *int64 - // The Assignment-level Review Policy applies to the assignments under the HIT. You - // can specify for Mechanical Turk to take various actions based on the policy. + // The Assignment-level Review Policy applies to the assignments under the HIT. + // You can specify for Mechanical Turk to take various actions based on the policy. AssignmentReviewPolicy *types.ReviewPolicy // The HITLayoutId allows you to use a pre-existing HIT design with placeholder @@ -70,28 +70,28 @@ type CreateHITWithHITTypeInput struct { // Turk to take various actions based on the policy. HITReviewPolicy *types.ReviewPolicy - // The number of times the HIT can be accepted and completed before the HIT becomes - // unavailable. + // The number of times the HIT can be accepted and completed before the HIT + // becomes unavailable. MaxAssignments *int32 - // The data the person completing the HIT uses to produce the results. Constraints: - // Must be a QuestionForm data structure, an ExternalQuestion data structure, or an - // HTMLQuestion data structure. The XML question data must not be larger than 64 - // kilobytes (65,535 bytes) in size, including whitespace. Either a Question - // parameter or a HITLayoutId parameter must be provided. + // The data the person completing the HIT uses to produce the results. + // Constraints: Must be a QuestionForm data structure, an ExternalQuestion data + // structure, or an HTMLQuestion data structure. The XML question data must not be + // larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a + // Question parameter or a HITLayoutId parameter must be provided. Question *string - // An arbitrary data field. The RequesterAnnotation parameter lets your application - // attach arbitrary data to the HIT for tracking purposes. For example, this - // parameter could be an identifier internal to the Requester's application that - // corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only - // visible to the Requester who created the HIT. It is not shown to the Worker, or - // any other Requester. The RequesterAnnotation parameter may be different for each - // HIT you submit. It does not affect how your HITs are grouped. + // An arbitrary data field. The RequesterAnnotation parameter lets your + // application attach arbitrary data to the HIT for tracking purposes. For example, + // this parameter could be an identifier internal to the Requester's application + // that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is + // only visible to the Requester who created the HIT. It is not shown to the + // Worker, or any other Requester. The RequesterAnnotation parameter may be + // different for each HIT you submit. It does not affect how your HITs are grouped. RequesterAnnotation *string - // A unique identifier for this request which allows you to retry the call on error - // without creating duplicate HITs. This is useful in cases such as network + // A unique identifier for this request which allows you to retry the call on + // error without creating duplicate HITs. This is useful in cases such as network // timeouts where it is unclear whether or not the call succeeded on the server. If // the HIT already exists in the system from a previous call using the same // UniqueRequestToken, subsequent calls will return a @@ -106,8 +106,8 @@ type CreateHITWithHITTypeInput struct { type CreateHITWithHITTypeOutput struct { - // Contains the newly created HIT data. For a description of the HIT data structure - // as it appears in responses, see the HIT Data Structure documentation. + // Contains the newly created HIT data. For a description of the HIT data + // structure as it appears in responses, see the HIT Data Structure documentation. HIT *types.HIT // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_CreateQualificationType.go b/service/mturk/api_op_CreateQualificationType.go index 934597b2143..9eb7c1f3fcc 100644 --- a/service/mturk/api_op_CreateQualificationType.go +++ b/service/mturk/api_op_CreateQualificationType.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The CreateQualificationType operation creates a new Qualification type, which is -// represented by a QualificationType data structure. +// The CreateQualificationType operation creates a new Qualification type, which +// is represented by a QualificationType data structure. func (c *Client) CreateQualificationType(ctx context.Context, params *CreateQualificationTypeInput, optFns ...func(*Options)) (*CreateQualificationTypeOutput, error) { if params == nil { params = &CreateQualificationTypeInput{} diff --git a/service/mturk/api_op_DeleteHIT.go b/service/mturk/api_op_DeleteHIT.go index 6769ded2ae7..6b6eefa6d7f 100644 --- a/service/mturk/api_op_DeleteHIT.go +++ b/service/mturk/api_op_DeleteHIT.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeleteHIT operation is used to delete HIT that is no longer needed. Only the -// Requester who created the HIT can delete it. You can only dispose of HITs that -// are in the Reviewable state, with all of their submitted assignments already -// either approved or rejected. If you call the DeleteHIT operation on a HIT that -// is not in the Reviewable state (for example, that has not expired, or still has -// active assignments), or on a HIT that is Reviewable but without all of its -// submitted assignments already approved or rejected, the service will return an -// error. -// -// * HITs are automatically disposed of after 120 days. -// -// * After you -// dispose of a HIT, you can no longer approve the HIT's rejected assignments. -// -// * -// Disposed HITs are not returned in results for the ListHITs operation. -// -// * -// Disposing HITs can improve the performance of operations such as -// ListReviewableHITs and ListHITs. +// The DeleteHIT operation is used to delete HIT that is no longer needed. Only +// the Requester who created the HIT can delete it. You can only dispose of HITs +// that are in the Reviewable state, with all of their submitted assignments +// already either approved or rejected. If you call the DeleteHIT operation on a +// HIT that is not in the Reviewable state (for example, that has not expired, or +// still has active assignments), or on a HIT that is Reviewable but without all of +// its submitted assignments already approved or rejected, the service will return +// an error. +// - HITs are automatically disposed of after 120 days. +// - After you dispose of a HIT, you can no longer approve the HIT's rejected +// assignments. +// - Disposed HITs are not returned in results for the ListHITs operation. +// - Disposing HITs can improve the performance of operations such as +// ListReviewableHITs and ListHITs. func (c *Client) DeleteHIT(ctx context.Context, params *DeleteHITInput, optFns ...func(*Options)) (*DeleteHITOutput, error) { if params == nil { params = &DeleteHITInput{} diff --git a/service/mturk/api_op_DeleteWorkerBlock.go b/service/mturk/api_op_DeleteWorkerBlock.go index 8cfeb61bb9c..832cee66c56 100644 --- a/service/mturk/api_op_DeleteWorkerBlock.go +++ b/service/mturk/api_op_DeleteWorkerBlock.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work -// on your HITs. This operation reverses the effects of the CreateWorkerBlock +// The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to +// work on your HITs. This operation reverses the effects of the CreateWorkerBlock // operation. You need the Worker ID to use this operation. If the Worker ID is // missing or invalid, this operation fails and returns the message “WorkerId is // invalid.” If the specified Worker is not blocked, this operation returns diff --git a/service/mturk/api_op_DisassociateQualificationFromWorker.go b/service/mturk/api_op_DisassociateQualificationFromWorker.go index e92699f6725..d7124891ed8 100644 --- a/service/mturk/api_op_DisassociateQualificationFromWorker.go +++ b/service/mturk/api_op_DisassociateQualificationFromWorker.go @@ -41,8 +41,8 @@ type DisassociateQualificationFromWorkerInput struct { // This member is required. WorkerId *string - // A text message that explains why the Qualification was revoked. The user who had - // the Qualification sees this message. + // A text message that explains why the Qualification was revoked. The user who + // had the Qualification sees this message. Reason *string noSmithyDocumentSerde diff --git a/service/mturk/api_op_GetFileUploadURL.go b/service/mturk/api_op_GetFileUploadURL.go index 43d56fe79f8..e7c0cedba40 100644 --- a/service/mturk/api_op_GetFileUploadURL.go +++ b/service/mturk/api_op_GetFileUploadURL.go @@ -18,10 +18,9 @@ import ( // HIT is disposed, any uploaded files are deleted, and cannot be retrieved. // Pending Deprecation on December 12, 2017. The Answer Specification // -// structure -// will no longer support the FileUploadAnswer element to be used for the -// QuestionForm data structure. Instead, we recommend that Requesters who want to -// create HITs asking Workers to upload files to use Amazon S3. +// structure will no longer support the FileUploadAnswer element to be used for +// the QuestionForm data structure. Instead, we recommend that Requesters who want +// to create HITs asking Workers to upload files to use Amazon S3. func (c *Client) GetFileUploadURL(ctx context.Context, params *GetFileUploadURLInput, optFns ...func(*Options)) (*GetFileUploadURLOutput, error) { if params == nil { params = &GetFileUploadURLInput{} diff --git a/service/mturk/api_op_GetQualificationType.go b/service/mturk/api_op_GetQualificationType.go index 8e0f7c48833..7ecbe943b76 100644 --- a/service/mturk/api_op_GetQualificationType.go +++ b/service/mturk/api_op_GetQualificationType.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetQualificationTypeoperation retrieves information about a Qualification +// The GetQualificationType operation retrieves information about a Qualification // type using its ID. func (c *Client) GetQualificationType(ctx context.Context, params *GetQualificationTypeInput, optFns ...func(*Options)) (*GetQualificationTypeOutput, error) { if params == nil { diff --git a/service/mturk/api_op_ListQualificationRequests.go b/service/mturk/api_op_ListQualificationRequests.go index f7fd7169e99..952b8d3b5d0 100644 --- a/service/mturk/api_op_ListQualificationRequests.go +++ b/service/mturk/api_op_ListQualificationRequests.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListQualificationRequests operation retrieves requests for Qualifications of -// a particular Qualification type. The owner of the Qualification type calls this -// operation to poll for pending requests, and accepts them using the +// The ListQualificationRequests operation retrieves requests for Qualifications +// of a particular Qualification type. The owner of the Qualification type calls +// this operation to poll for pending requests, and accepts them using the // AcceptQualification operation. func (c *Client) ListQualificationRequests(ctx context.Context, params *ListQualificationRequestsInput, optFns ...func(*Options)) (*ListQualificationRequestsOutput, error) { if params == nil { diff --git a/service/mturk/api_op_ListQualificationTypes.go b/service/mturk/api_op_ListQualificationTypes.go index 58dbbd06f2c..a1159300dbc 100644 --- a/service/mturk/api_op_ListQualificationTypes.go +++ b/service/mturk/api_op_ListQualificationTypes.go @@ -44,8 +44,8 @@ type ListQualificationTypesInput struct { // The maximum number of results to return in a single call. MaxResults *int32 - // Specifies that only Qualification types that the Requester created are returned. - // If false, the operation returns all Qualification types. + // Specifies that only Qualification types that the Requester created are + // returned. If false, the operation returns all Qualification types. MustBeOwnedByCaller *bool // If the previous response was incomplete (because there is more data to diff --git a/service/mturk/api_op_ListReviewableHITs.go b/service/mturk/api_op_ListReviewableHITs.go index 37a45e3433e..2652bbf55c8 100644 --- a/service/mturk/api_op_ListReviewableHITs.go +++ b/service/mturk/api_op_ListReviewableHITs.go @@ -42,7 +42,7 @@ type ListReviewableHITsInput struct { // Pagination Token NextToken *string - // Can be either Reviewable or Reviewing. Reviewable is the default value. + // Can be either Reviewable or Reviewing . Reviewable is the default value. Status types.ReviewableHITStatus noSmithyDocumentSerde diff --git a/service/mturk/api_op_ListWorkerBlocks.go b/service/mturk/api_op_ListWorkerBlocks.go index 05597e008c2..7a7189fe822 100644 --- a/service/mturk/api_op_ListWorkerBlocks.go +++ b/service/mturk/api_op_ListWorkerBlocks.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListWorkersBlocks operation retrieves a list of Workers who are blocked from -// working on your HITs. +// The ListWorkersBlocks operation retrieves a list of Workers who are blocked +// from working on your HITs. func (c *Client) ListWorkerBlocks(ctx context.Context, params *ListWorkerBlocksInput, optFns ...func(*Options)) (*ListWorkerBlocksOutput, error) { if params == nil { params = &ListWorkerBlocksInput{} diff --git a/service/mturk/api_op_ListWorkersWithQualificationType.go b/service/mturk/api_op_ListWorkersWithQualificationType.go index d92f9eab748..9f6f3986f70 100644 --- a/service/mturk/api_op_ListWorkersWithQualificationType.go +++ b/service/mturk/api_op_ListWorkersWithQualificationType.go @@ -42,7 +42,7 @@ type ListWorkersWithQualificationTypeInput struct { // Pagination Token NextToken *string - // The status of the Qualifications to return. Can be Granted | Revoked. + // The status of the Qualifications to return. Can be Granted | Revoked . Status types.QualificationStatus noSmithyDocumentSerde diff --git a/service/mturk/api_op_RejectAssignment.go b/service/mturk/api_op_RejectAssignment.go index e3e5e3b6af4..94217bbe6db 100644 --- a/service/mturk/api_op_RejectAssignment.go +++ b/service/mturk/api_op_RejectAssignment.go @@ -34,8 +34,8 @@ func (c *Client) RejectAssignment(ctx context.Context, params *RejectAssignmentI type RejectAssignmentInput struct { - // The ID of the assignment. The assignment must correspond to a HIT created by the - // Requester. + // The ID of the assignment. The assignment must correspond to a HIT created by + // the Requester. // // This member is required. AssignmentId *string diff --git a/service/mturk/api_op_SendBonus.go b/service/mturk/api_op_SendBonus.go index 4f2d410477c..95707207029 100644 --- a/service/mturk/api_op_SendBonus.go +++ b/service/mturk/api_op_SendBonus.go @@ -10,14 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The SendBonus operation issues a payment of money from your account to a Worker. -// This payment happens separately from the reward you pay to the Worker when you -// approve the Worker's assignment. The SendBonus operation requires the Worker's -// ID and the assignment ID as parameters to initiate payment of the bonus. You -// must include a message that explains the reason for the bonus payment, as the -// Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee -// for bonus payments, similar to the HIT listing fee. This operation fails if your -// account does not have enough funds to pay for both the bonus and the fees. +// The SendBonus operation issues a payment of money from your account to a +// Worker. This payment happens separately from the reward you pay to the Worker +// when you approve the Worker's assignment. The SendBonus operation requires the +// Worker's ID and the assignment ID as parameters to initiate payment of the +// bonus. You must include a message that explains the reason for the bonus +// payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk +// collects a fee for bonus payments, similar to the HIT listing fee. This +// operation fails if your account does not have enough funds to pay for both the +// bonus and the fees. func (c *Client) SendBonus(ctx context.Context, params *SendBonusInput, optFns ...func(*Options)) (*SendBonusOutput, error) { if params == nil { params = &SendBonusInput{} diff --git a/service/mturk/api_op_SendTestEventNotification.go b/service/mturk/api_op_SendTestEventNotification.go index 6e40c290476..8162c02e044 100644 --- a/service/mturk/api_op_SendTestEventNotification.go +++ b/service/mturk/api_op_SendTestEventNotification.go @@ -34,9 +34,9 @@ func (c *Client) SendTestEventNotification(ctx context.Context, params *SendTest type SendTestEventNotificationInput struct { - // The notification specification to test. This value is identical to the value you - // would provide to the UpdateNotificationSettings operation when you establish the - // notification specification for a HIT type. + // The notification specification to test. This value is identical to the value + // you would provide to the UpdateNotificationSettings operation when you establish + // the notification specification for a HIT type. // // This member is required. Notification *types.NotificationSpecification diff --git a/service/mturk/api_op_UpdateHITReviewStatus.go b/service/mturk/api_op_UpdateHITReviewStatus.go index 81757ea2c39..96f457be747 100644 --- a/service/mturk/api_op_UpdateHITReviewStatus.go +++ b/service/mturk/api_op_UpdateHITReviewStatus.go @@ -35,13 +35,10 @@ type UpdateHITReviewStatusInput struct { // This member is required. HITId *string - // Specifies how to update the HIT status. Default is False. - // - // * Setting this to - // false will only transition a HIT from Reviewable to Reviewing - // - // * Setting this to - // true will only transition a HIT from Reviewing to Reviewable + // Specifies how to update the HIT status. Default is False . + // - Setting this to false will only transition a HIT from Reviewable to + // Reviewing + // - Setting this to true will only transition a HIT from Reviewing to Reviewable Revert *bool noSmithyDocumentSerde diff --git a/service/mturk/api_op_UpdateNotificationSettings.go b/service/mturk/api_op_UpdateNotificationSettings.go index d452ff7a48b..f17f4d0aec0 100644 --- a/service/mturk/api_op_UpdateNotificationSettings.go +++ b/service/mturk/api_op_UpdateNotificationSettings.go @@ -21,7 +21,7 @@ import ( // without specifying a new notification specification. To change the Active status // of a HIT type's notifications, the HIT type must already have a notification // specification, or one must be provided in the same call to -// UpdateNotificationSettings. +// UpdateNotificationSettings . func (c *Client) UpdateNotificationSettings(ctx context.Context, params *UpdateNotificationSettingsInput, optFns ...func(*Options)) (*UpdateNotificationSettingsOutput, error) { if params == nil { params = &UpdateNotificationSettingsInput{} @@ -44,8 +44,8 @@ type UpdateNotificationSettingsInput struct { // This member is required. HITTypeId *string - // Specifies whether notifications are sent for HITs of this HIT type, according to - // the notification specification. You must specify either the Notification + // Specifies whether notifications are sent for HITs of this HIT type, according + // to the notification specification. You must specify either the Notification // parameter or the Active parameter for the call to UpdateNotificationSettings to // succeed. Active *bool diff --git a/service/mturk/types/enums.go b/service/mturk/types/enums.go index 5b273668dcd..56a19f95419 100644 --- a/service/mturk/types/enums.go +++ b/service/mturk/types/enums.go @@ -74,9 +74,9 @@ const ( EventTypePing EventType = "Ping" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "AssignmentAccepted", @@ -147,9 +147,9 @@ const ( HITStatusDisposed HITStatus = "Disposed" ) -// Values returns all known values for HITStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for HITStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (HITStatus) Values() []HITStatus { return []HITStatus{ "Assignable", @@ -169,8 +169,8 @@ const ( NotificationTransportSns NotificationTransport = "SNS" ) -// Values returns all known values for NotificationTransport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NotificationTransport. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NotificationTransport) Values() []NotificationTransport { return []NotificationTransport{ @@ -188,9 +188,9 @@ const ( NotifyWorkersFailureCodeHardFailure NotifyWorkersFailureCode = "HardFailure" ) -// Values returns all known values for NotifyWorkersFailureCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NotifyWorkersFailureCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (NotifyWorkersFailureCode) Values() []NotifyWorkersFailureCode { return []NotifyWorkersFailureCode{ "SoftFailure", diff --git a/service/mturk/types/types.go b/service/mturk/types/types.go index 2d1c09cfccb..a62579072db 100644 --- a/service/mturk/types/types.go +++ b/service/mturk/types/types.go @@ -41,9 +41,9 @@ type Assignment struct { // submitted results. AutoApprovalTime *time.Time - // The date and time of the deadline for the assignment. This value is derived from - // the deadline specification for the HIT and the date and time the Worker accepted - // the HIT. + // The date and time of the deadline for the assignment. This value is derived + // from the deadline specification for the HIT and the date and time the Worker + // accepted the HIT. Deadline *time.Time // The ID of the HIT. @@ -53,8 +53,8 @@ type Assignment struct { // RejectionTime is the date and time the Requester rejected the results. RejectionTime *time.Time - // The feedback string included with the call to the ApproveAssignment operation or - // the RejectAssignment operation, if the Requester approved or rejected the + // The feedback string included with the call to the ApproveAssignment operation + // or the RejectAssignment operation, if the Requester approved or rejected the // assignment and specified feedback. RequesterFeedback *string @@ -138,8 +138,8 @@ type HIT struct { // search results. Keywords *string - // The number of times the HIT can be accepted and completed before the HIT becomes - // unavailable. + // The number of times the HIT can be accepted and completed before the HIT + // becomes unavailable. MaxAssignments *int32 // The number of assignments for this HIT that are available for Workers to accept. @@ -163,8 +163,8 @@ type HIT struct { // either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure. Question *string - // An arbitrary data field the Requester who created the HIT can use. This field is - // visible only to the creator of the HIT. + // An arbitrary data field the Requester who created the HIT can use. This field + // is visible only to the creator of the HIT. RequesterAnnotation *string // A string representing a currency amount. @@ -203,8 +203,8 @@ type Locale struct { // This member is required. Country *string - // The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For - // example, the code WA refers to the state of Washington. + // The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. + // For example, the code WA refers to the state of Washington. Subdivision *string noSmithyDocumentSerde @@ -216,14 +216,9 @@ type NotificationSpecification struct { // The target for notification messages. The Destination’s format is determined by // the specified Transport: - // - // * When Transport is Email, the Destination is your - // email address. - // - // * When Transport is SQS, the Destination is your queue URL. - // - // * - // When Transport is SNS, the Destination is the ARN of your topic. + // - When Transport is Email, the Destination is your email address. + // - When Transport is SQS, the Destination is your queue URL. + // - When Transport is SNS, the Destination is the ARN of your topic. // // This member is required. Destination *string @@ -455,8 +450,8 @@ type QualificationType struct { // False. AutoGranted *bool - // The Qualification integer value to use for automatically granted Qualifications, - // if AutoGranted is true. This is 1 by default. + // The Qualification integer value to use for automatically granted + // Qualifications, if AutoGranted is true. This is 1 by default. AutoGrantedValue *int32 // The date and time the Qualification type was created. @@ -489,12 +484,12 @@ type QualificationType struct { // Inactive. QualificationTypeStatus QualificationTypeStatus - // The amount of time, in seconds, Workers must wait after taking the Qualification - // test before they can take it again. Workers can take a Qualification test - // multiple times if they were not granted the Qualification from a previous - // attempt, or if the test offers a gradient score and they want a better score. If - // not specified, retries are disabled and Workers can request a Qualification only - // once. + // The amount of time, in seconds, Workers must wait after taking the + // Qualification test before they can take it again. Workers can take a + // Qualification test multiple times if they were not granted the Qualification + // from a previous attempt, or if the test offers a gradient score and they want a + // better score. If not specified, retries are disabled and Workers can request a + // Qualification only once. RetryDelayInSeconds *int64 // The questions for a Qualification test associated with this Qualification type @@ -591,10 +586,10 @@ type ReviewResultDetail struct { // HIT. QuestionId *string - // The HITID or AssignmentId about which this result was taken. Note that HIT-level - // Review Policies will often emit results about both the HIT itself and its - // Assignments, while Assignment-level review policies generally only emit results - // about the Assignment itself. + // The HITID or AssignmentId about which this result was taken. Note that + // HIT-level Review Policies will often emit results about both the HIT itself and + // its Assignments, while Assignment-level review policies generally only emit + // results about the Assignment itself. SubjectId *string // The type of the object from the SubjectId field. diff --git a/service/mwaa/api_client.go b/service/mwaa/api_client.go index a26cf2eb966..4cd597dc1cf 100644 --- a/service/mwaa/api_client.go +++ b/service/mwaa/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/mwaa/api_op_CreateCliToken.go b/service/mwaa/api_op_CreateCliToken.go index e592b860ce7..04c4035378d 100644 --- a/service/mwaa/api_op_CreateCliToken.go +++ b/service/mwaa/api_op_CreateCliToken.go @@ -12,8 +12,8 @@ import ( ) // Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache -// Airflow CLI token -// (https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-cli.html). +// Airflow CLI token (https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-cli.html) +// . func (c *Client) CreateCliToken(ctx context.Context, params *CreateCliTokenInput, optFns ...func(*Options)) (*CreateCliTokenOutput, error) { if params == nil { params = &CreateCliTokenInput{} @@ -31,7 +31,7 @@ func (c *Client) CreateCliToken(ctx context.Context, params *CreateCliTokenInput type CreateCliTokenInput struct { - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string diff --git a/service/mwaa/api_op_CreateEnvironment.go b/service/mwaa/api_op_CreateEnvironment.go index 65a1aec546f..2934dd2eb9c 100644 --- a/service/mwaa/api_op_CreateEnvironment.go +++ b/service/mwaa/api_op_CreateEnvironment.go @@ -28,15 +28,15 @@ func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmen return out, nil } -// This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API -// reference documentation to create an environment. For more information, see Get -// started with Amazon Managed Workflows for Apache Airflow -// (https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html). +// This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) +// API reference documentation to create an environment. For more information, see +// Get started with Amazon Managed Workflows for Apache Airflow (https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html) +// . type CreateEnvironmentInput struct { - // The relative path to the DAGs folder on your Amazon S3 bucket. For example, - // dags. For more information, see Adding or updating DAGs - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html). + // The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags + // . For more information, see Adding or updating DAGs (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) + // . // // This member is required. DagS3Path *string @@ -45,58 +45,58 @@ type CreateEnvironmentInput struct { // execution role is an Amazon Web Services Identity and Access Management (IAM) // role that grants MWAA permission to access Amazon Web Services services and // resources used by your environment. For example, - // arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon - // MWAA Execution role - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html). + // arn:aws:iam::123456789:role/my-execution-role . For more information, see + // Amazon MWAA Execution role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) + // . // // This member is required. ExecutionRoleArn *string - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string // The VPC networking components used to secure and enable network traffic between // the Amazon Web Services resources for your environment. For more information, - // see About networking on Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). + // see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) + // . // // This member is required. NetworkConfiguration *types.NetworkConfiguration // The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and // supporting files are stored. For example, - // arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an - // Amazon S3 bucket for Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html). + // arn:aws:s3:::my-airflow-bucket-unique-name . For more information, see Create + // an Amazon S3 bucket for Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) + // . // // This member is required. SourceBucketArn *string // A list of key-value pairs containing the Apache Airflow configuration options - // you want to attach to your environment. For more information, see Apache Airflow - // configuration options - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html). + // you want to attach to your environment. For more information, see Apache + // Airflow configuration options (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html) + // . AirflowConfigurationOptions map[string]string // The Apache Airflow version for your environment. If no value is specified, it - // defaults to the latest version. Valid values: 1.10.12, 2.0.2, 2.2.2, and 2.4.3. - // For more information, see Apache Airflow versions on Amazon Managed Workflows - // for Apache Airflow (MWAA) - // (https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html). + // defaults to the latest version. Valid values: 1.10.12 , 2.0.2 , 2.2.2 , and + // 2.4.3 . For more information, see Apache Airflow versions on Amazon Managed + // Workflows for Apache Airflow (MWAA) (https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html) + // . AirflowVersion *string - // The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For - // more information, see Amazon MWAA environment class - // (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html). + // The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . + // For more information, see Amazon MWAA environment class (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) + // . EnvironmentClass *string // The Amazon Web Services Key Management Service (KMS) key to encrypt the data in // your environment. You can use an Amazon Web Services owned CMK, or a Customer // managed CMK (advanced). For more information, see Create an Amazon MWAA - // environment - // (https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html). + // environment (https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html) + // . KmsKey *string // Defines the Apache Airflow logs to send to CloudWatch Logs. @@ -104,83 +104,81 @@ type CreateEnvironmentInput struct { // The maximum number of workers that you want to run in your environment. MWAA // scales the number of Apache Airflow workers up to the number you specify in the - // MaxWorkers field. For example, 20. When there are no more tasks running, and no + // MaxWorkers field. For example, 20 . When there are no more tasks running, and no // more in the queue, MWAA disposes of the extra workers leaving the one worker - // that is included with your environment, or the number you specify in MinWorkers. + // that is included with your environment, or the number you specify in MinWorkers . MaxWorkers *int32 // The minimum number of workers that you want to run in your environment. MWAA // scales the number of Apache Airflow workers up to the number you specify in the // MaxWorkers field. When there are no more tasks running, and no more in the // queue, MWAA disposes of the extra workers leaving the worker count you specify - // in the MinWorkers field. For example, 2. + // in the MinWorkers field. For example, 2 . MinWorkers *int32 - // The version of the plugins.zip file on your Amazon S3 bucket. You must specify a - // version each time a plugins.zip file is updated. For more information, see How - // S3 Versioning works - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). + // The version of the plugins.zip file on your Amazon S3 bucket. You must specify + // a version each time a plugins.zip file is updated. For more information, see + // How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // . PluginsS3ObjectVersion *string - // The relative path to the plugins.zip file on your Amazon S3 bucket. For example, - // plugins.zip. If specified, then the plugins.zip version is required. For more - // information, see Installing custom plugins - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html). + // The relative path to the plugins.zip file on your Amazon S3 bucket. For + // example, plugins.zip . If specified, then the plugins.zip version is required. + // For more information, see Installing custom plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) + // . PluginsS3Path *string // The version of the requirements.txt file on your Amazon S3 bucket. You must // specify a version each time a requirements.txt file is updated. For more - // information, see How S3 Versioning works - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). + // information, see How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // . RequirementsS3ObjectVersion *string // The relative path to the requirements.txt file on your Amazon S3 bucket. For - // example, requirements.txt. If specified, then a version is required. For more - // information, see Installing Python dependencies - // (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html). + // example, requirements.txt . If specified, then a version is required. For more + // information, see Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) + // . RequirementsS3Path *string // The number of Apache Airflow schedulers to run in your environment. Valid // values: - // - // * v2 - Accepts between 2 to 5. Defaults to 2. - // - // * v1 - Accepts 1. + // - v2 - Accepts between 2 to 5. Defaults to 2. + // - v1 - Accepts 1. Schedulers *int32 // The version of the startup shell script in your Amazon S3 bucket. You must - // specify the version ID - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) // that Amazon S3 assigns to the file every time you update the script. Version IDs // are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than // 1,024 bytes long. The following is an example: // 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo For more - // information, see Using a startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // information, see Using a startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3ObjectVersion *string // The relative path to the startup shell script in your Amazon S3 bucket. For - // example, s3://mwaa-environment/startup.sh. Amazon MWAA runs the script as your + // example, s3://mwaa-environment/startup.sh . Amazon MWAA runs the script as your // environment starts, and before running the Apache Airflow process. You can use // this script to install dependencies, modify Apache Airflow configuration // options, and set environment variables. For more information, see Using a - // startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3Path *string // The key-value tag pairs you want to associate to your environment. For example, - // "Environment": "Staging". For more information, see Tagging Amazon Web Services - // resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // "Environment": "Staging" . For more information, see Tagging Amazon Web + // Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string // The Apache Airflow Web server access mode. For more information, see Apache - // Airflow access modes - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html). + // Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) + // . WebserverAccessMode types.WebserverAccessMode // The day and time of the week in Coordinated Universal Time (UTC) 24-hour // standard time to start weekly maintenance updates of your environment in the - // following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start + // following format: DAY:HH:MM . For example: TUE:03:30 . You can specify a start // time in 30 minute increments only. WeeklyMaintenanceWindowStart *string diff --git a/service/mwaa/api_op_CreateWebLoginToken.go b/service/mwaa/api_op_CreateWebLoginToken.go index c0ab6cc03f3..a79576e25ef 100644 --- a/service/mwaa/api_op_CreateWebLoginToken.go +++ b/service/mwaa/api_op_CreateWebLoginToken.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a web login token for the Airflow Web UI. To learn more, see Creating an -// Apache Airflow web login token -// (https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html). +// Creates a web login token for the Airflow Web UI. To learn more, see Creating +// an Apache Airflow web login token (https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html) +// . func (c *Client) CreateWebLoginToken(ctx context.Context, params *CreateWebLoginTokenInput, optFns ...func(*Options)) (*CreateWebLoginTokenOutput, error) { if params == nil { params = &CreateWebLoginTokenInput{} @@ -31,7 +31,7 @@ func (c *Client) CreateWebLoginToken(ctx context.Context, params *CreateWebLogin type CreateWebLoginTokenInput struct { - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string diff --git a/service/mwaa/api_op_DeleteEnvironment.go b/service/mwaa/api_op_DeleteEnvironment.go index 50d3c9e8ac8..ac778e58cec 100644 --- a/service/mwaa/api_op_DeleteEnvironment.go +++ b/service/mwaa/api_op_DeleteEnvironment.go @@ -29,7 +29,7 @@ func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmen type DeleteEnvironmentInput struct { - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string diff --git a/service/mwaa/api_op_GetEnvironment.go b/service/mwaa/api_op_GetEnvironment.go index 4c80e1978e3..e6cc19b37d1 100644 --- a/service/mwaa/api_op_GetEnvironment.go +++ b/service/mwaa/api_op_GetEnvironment.go @@ -30,7 +30,7 @@ func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput type GetEnvironmentInput struct { - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string diff --git a/service/mwaa/api_op_ListTagsForResource.go b/service/mwaa/api_op_ListTagsForResource.go index 2ddab4ac6b3..5e10520f7eb 100644 --- a/service/mwaa/api_op_ListTagsForResource.go +++ b/service/mwaa/api_op_ListTagsForResource.go @@ -12,7 +12,7 @@ import ( ) // Lists the key-value tag pairs associated to the Amazon Managed Workflows for -// Apache Airflow (MWAA) environment. For example, "Environment": "Staging". +// Apache Airflow (MWAA) environment. For example, "Environment": "Staging" . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -31,7 +31,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, - // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment. + // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment . // // This member is required. ResourceArn *string @@ -42,8 +42,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { // The key-value tag pairs associated to your environment. For more information, - // see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/mwaa/api_op_PublishMetrics.go b/service/mwaa/api_op_PublishMetrics.go index 989bd04cb45..0be9252c1ce 100644 --- a/service/mwaa/api_op_PublishMetrics.go +++ b/service/mwaa/api_op_PublishMetrics.go @@ -37,8 +37,8 @@ type PublishMetricsInput struct { // Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the // metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in - // Amazon CloudWatch - // (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html). + // Amazon CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html) + // . // // This member is required. MetricData []types.MetricDatum diff --git a/service/mwaa/api_op_TagResource.go b/service/mwaa/api_op_TagResource.go index f977e71962a..5ff713e7ee3 100644 --- a/service/mwaa/api_op_TagResource.go +++ b/service/mwaa/api_op_TagResource.go @@ -31,14 +31,15 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, - // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment. + // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment . // // This member is required. ResourceArn *string // The key-value tag pairs you want to associate to your environment. For example, - // "Environment": "Staging". For more information, see Tagging Amazon Web Services - // resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // "Environment": "Staging" . For more information, see Tagging Amazon Web + // Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . // // This member is required. Tags map[string]string diff --git a/service/mwaa/api_op_UntagResource.go b/service/mwaa/api_op_UntagResource.go index 584080378de..f50201de2c7 100644 --- a/service/mwaa/api_op_UntagResource.go +++ b/service/mwaa/api_op_UntagResource.go @@ -12,7 +12,7 @@ import ( ) // Removes key-value tag pairs associated to your Amazon Managed Workflows for -// Apache Airflow (MWAA) environment. For example, "Environment": "Staging". +// Apache Airflow (MWAA) environment. For example, "Environment": "Staging" . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -31,13 +31,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, - // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment. + // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment . // // This member is required. ResourceArn *string - // The key-value tag pair you want to remove. For example, "Environment": - // "Staging". + // The key-value tag pair you want to remove. For example, "Environment": "Staging" + // . // // This member is required. TagKeys []string diff --git a/service/mwaa/api_op_UpdateEnvironment.go b/service/mwaa/api_op_UpdateEnvironment.go index 603e2842143..992c82abab3 100644 --- a/service/mwaa/api_op_UpdateEnvironment.go +++ b/service/mwaa/api_op_UpdateEnvironment.go @@ -30,36 +30,37 @@ func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmen type UpdateEnvironmentInput struct { - // The name of your Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of your Amazon MWAA environment. For example, MyMWAAEnvironment . // // This member is required. Name *string // A list of key-value pairs containing the Apache Airflow configuration options - // you want to attach to your environment. For more information, see Apache Airflow - // configuration options - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html). + // you want to attach to your environment. For more information, see Apache + // Airflow configuration options (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html) + // . AirflowConfigurationOptions map[string]string // The Apache Airflow version for your environment. If no value is specified, - // defaults to the latest version. Valid values: 1.10.12, 2.0.2, 2.2.2, and 2.4.3. + // defaults to the latest version. Valid values: 1.10.12 , 2.0.2 , 2.2.2 , and + // 2.4.3 . AirflowVersion *string - // The relative path to the DAGs folder on your Amazon S3 bucket. For example, - // dags. For more information, see Adding or updating DAGs - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html). + // The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags + // . For more information, see Adding or updating DAGs (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) + // . DagS3Path *string - // The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For - // more information, see Amazon MWAA environment class - // (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html). + // The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . + // For more information, see Amazon MWAA environment class (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) + // . EnvironmentClass *string // The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to // access Amazon Web Services resources in your environment. For example, - // arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon - // MWAA Execution role - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html). + // arn:aws:iam::123456789:role/my-execution-role . For more information, see + // Amazon MWAA Execution role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) + // . ExecutionRoleArn *string // The Apache Airflow log types to send to CloudWatch Logs. @@ -67,46 +68,46 @@ type UpdateEnvironmentInput struct { // The maximum number of workers that you want to run in your environment. MWAA // scales the number of Apache Airflow workers up to the number you specify in the - // MaxWorkers field. For example, 20. When there are no more tasks running, and no + // MaxWorkers field. For example, 20 . When there are no more tasks running, and no // more in the queue, MWAA disposes of the extra workers leaving the one worker - // that is included with your environment, or the number you specify in MinWorkers. + // that is included with your environment, or the number you specify in MinWorkers . MaxWorkers *int32 // The minimum number of workers that you want to run in your environment. MWAA // scales the number of Apache Airflow workers up to the number you specify in the // MaxWorkers field. When there are no more tasks running, and no more in the // queue, MWAA disposes of the extra workers leaving the worker count you specify - // in the MinWorkers field. For example, 2. + // in the MinWorkers field. For example, 2 . MinWorkers *int32 // The VPC networking components used to secure and enable network traffic between // the Amazon Web Services resources for your environment. For more information, - // see About networking on Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). + // see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) + // . NetworkConfiguration *types.UpdateNetworkConfigurationInput - // The version of the plugins.zip file on your Amazon S3 bucket. You must specify a - // version each time a plugins.zip file is updated. For more information, see How - // S3 Versioning works - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). + // The version of the plugins.zip file on your Amazon S3 bucket. You must specify + // a version each time a plugins.zip file is updated. For more information, see + // How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // . PluginsS3ObjectVersion *string - // The relative path to the plugins.zip file on your Amazon S3 bucket. For example, - // plugins.zip. If specified, then the plugins.zip version is required. For more - // information, see Installing custom plugins - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html). + // The relative path to the plugins.zip file on your Amazon S3 bucket. For + // example, plugins.zip . If specified, then the plugins.zip version is required. + // For more information, see Installing custom plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) + // . PluginsS3Path *string // The version of the requirements.txt file on your Amazon S3 bucket. You must // specify a version each time a requirements.txt file is updated. For more - // information, see How S3 Versioning works - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). + // information, see How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // . RequirementsS3ObjectVersion *string // The relative path to the requirements.txt file on your Amazon S3 bucket. For - // example, requirements.txt. If specified, then a file version is required. For - // more information, see Installing Python dependencies - // (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html). + // example, requirements.txt . If specified, then a file version is required. For + // more information, see Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) + // . RequirementsS3Path *string // The number of Apache Airflow schedulers to run in your Amazon MWAA environment. @@ -114,39 +115,38 @@ type UpdateEnvironmentInput struct { // The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and // supporting files are stored. For example, - // arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an - // Amazon S3 bucket for Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html). + // arn:aws:s3:::my-airflow-bucket-unique-name . For more information, see Create + // an Amazon S3 bucket for Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) + // . SourceBucketArn *string // The version of the startup shell script in your Amazon S3 bucket. You must - // specify the version ID - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) // that Amazon S3 assigns to the file every time you update the script. Version IDs // are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than // 1,024 bytes long. The following is an example: // 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo For more - // information, see Using a startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // information, see Using a startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3ObjectVersion *string // The relative path to the startup shell script in your Amazon S3 bucket. For - // example, s3://mwaa-environment/startup.sh. Amazon MWAA runs the script as your + // example, s3://mwaa-environment/startup.sh . Amazon MWAA runs the script as your // environment starts, and before running the Apache Airflow process. You can use // this script to install dependencies, modify Apache Airflow configuration // options, and set environment variables. For more information, see Using a - // startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3Path *string // The Apache Airflow Web server access mode. For more information, see Apache - // Airflow access modes - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html). + // Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) + // . WebserverAccessMode types.WebserverAccessMode // The day and time of the week in Coordinated Universal Time (UTC) 24-hour // standard time to start weekly maintenance updates of your environment in the - // following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start + // following format: DAY:HH:MM . For example: TUE:03:30 . You can specify a start // time in 30 minute increments only. WeeklyMaintenanceWindowStart *string @@ -156,7 +156,7 @@ type UpdateEnvironmentInput struct { type UpdateEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, - // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment. + // arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment . Arn *string // Metadata pertaining to the operation's result. diff --git a/service/mwaa/doc.go b/service/mwaa/doc.go index 67f2ea34796..8b44e77787d 100644 --- a/service/mwaa/doc.go +++ b/service/mwaa/doc.go @@ -5,64 +5,26 @@ // // Amazon Managed Workflows for Apache Airflow This section contains the Amazon // Managed Workflows for Apache Airflow (MWAA) API reference documentation. For -// more information, see What Is Amazon MWAA? -// (https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html). -// Endpoints -// -// * api.airflow.{region}.amazonaws.com - This endpoint is used for -// environment management. -// -// * CreateEnvironment -// (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.html) -// -// * -// DeleteEnvironment -// (https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.html) -// -// * -// GetEnvironment -// (https://docs.aws.amazon.com/mwaa/latest/API/API_GetEnvironment.html) -// -// * -// ListEnvironments -// (https://docs.aws.amazon.com/mwaa/latest/API/API_ListEnvironments.html) -// -// * -// ListTagsForResource -// (https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html) -// -// * -// TagResource -// (https://docs.aws.amazon.com/mwaa/latest/API/API_TagResource.html) -// -// * -// UntagResource -// (https://docs.aws.amazon.com/mwaa/latest/API/API_UntagResource.html) -// -// * -// UpdateEnvironment -// (https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html) -// -// * -// env.airflow.{region}.amazonaws.com - This endpoint is used to operate the -// Airflow environment. -// -// * CreateCliToken -// (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html) -// -// * -// CreateWebLoginToken -// (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html) -// -// * -// ops.airflow.{region}.amazonaws.com - This endpoint is used to push environment -// metrics that track environment health. -// -// * PublishMetrics -// (https://docs.aws.amazon.com/mwaa/latest/API/API_PublishMetrics.html) -// -// Regions -// For a list of regions that Amazon MWAA supports, see Region availability -// (https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html#regions-mwaa) +// more information, see What Is Amazon MWAA? (https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html) +// . Endpoints +// - api.airflow.{region}.amazonaws.com - This endpoint is used for environment +// management. +// - CreateEnvironment (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.html) +// - DeleteEnvironment (https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.html) +// - GetEnvironment (https://docs.aws.amazon.com/mwaa/latest/API/API_GetEnvironment.html) +// - ListEnvironments (https://docs.aws.amazon.com/mwaa/latest/API/API_ListEnvironments.html) +// - ListTagsForResource (https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html) +// - TagResource (https://docs.aws.amazon.com/mwaa/latest/API/API_TagResource.html) +// - UntagResource (https://docs.aws.amazon.com/mwaa/latest/API/API_UntagResource.html) +// - UpdateEnvironment (https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html) +// - env.airflow.{region}.amazonaws.com - This endpoint is used to operate the +// Airflow environment. +// - CreateCliToken (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html) +// - CreateWebLoginToken (https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html) +// - ops.airflow.{region}.amazonaws.com - This endpoint is used to push +// environment metrics that track environment health. +// - PublishMetrics (https://docs.aws.amazon.com/mwaa/latest/API/API_PublishMetrics.html) +// +// Regions For a list of regions that Amazon MWAA supports, see Region availability (https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html#regions-mwaa) // in the Amazon MWAA User Guide. package mwaa diff --git a/service/mwaa/types/enums.go b/service/mwaa/types/enums.go index 11ce31355fb..2ef3372c7ad 100644 --- a/service/mwaa/types/enums.go +++ b/service/mwaa/types/enums.go @@ -43,9 +43,9 @@ const ( LoggingLevelDebug LoggingLevel = "DEBUG" ) -// Values returns all known values for LoggingLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LoggingLevel. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LoggingLevel) Values() []LoggingLevel { return []LoggingLevel{ "CRITICAL", @@ -133,9 +133,9 @@ const ( UpdateStatusFailed UpdateStatus = "FAILED" ) -// Values returns all known values for UpdateStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UpdateStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UpdateStatus) Values() []UpdateStatus { return []UpdateStatus{ "SUCCESS", diff --git a/service/mwaa/types/errors.go b/service/mwaa/types/errors.go index 83a98a0cfe4..e3d8b1bd121 100644 --- a/service/mwaa/types/errors.go +++ b/service/mwaa/types/errors.go @@ -8,8 +8,8 @@ import ( ) // Access to the Apache Airflow Web UI or CLI has been denied due to insufficient -// permissions. To learn more, see Accessing an Amazon MWAA environment -// (https://docs.aws.amazon.com/mwaa/latest/userguide/access-policies.html). +// permissions. To learn more, see Accessing an Amazon MWAA environment (https://docs.aws.amazon.com/mwaa/latest/userguide/access-policies.html) +// . type AccessDeniedException struct { Message *string diff --git a/service/mwaa/types/types.go b/service/mwaa/types/types.go index d343bb79e59..0c3ad0967aa 100644 --- a/service/mwaa/types/types.go +++ b/service/mwaa/types/types.go @@ -9,8 +9,8 @@ import ( // Internal only. Represents the dimensions of a metric. To learn more about the // metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in -// Amazon CloudWatch -// (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html). +// Amazon CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html) +// . type Dimension struct { // Internal only. The name of the dimension. @@ -31,12 +31,12 @@ type Environment struct { // A list of key-value pairs containing the Apache Airflow configuration options // attached to your environment. For more information, see Apache Airflow - // configuration options - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html). + // configuration options (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html) + // . AirflowConfigurationOptions map[string]string - // The Apache Airflow version on your environment. Valid values: 1.10.12, 2.0.2, - // 2.2.2, and 2.4.3. + // The Apache Airflow version on your environment. Valid values: 1.10.12 , 2.0.2 , + // 2.2.2 , and 2.4.3 . AirflowVersion *string // The Amazon Resource Name (ARN) of the Amazon MWAA environment. @@ -46,20 +46,20 @@ type Environment struct { CreatedAt *time.Time // The relative path to the DAGs folder in your Amazon S3 bucket. For example, - // s3://mwaa-environment/dags. For more information, see Adding or updating DAGs - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html). + // s3://mwaa-environment/dags . For more information, see Adding or updating DAGs (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) + // . DagS3Path *string - // The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For - // more information, see Amazon MWAA environment class - // (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html). + // The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . + // For more information, see Amazon MWAA environment class (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) + // . EnvironmentClass *string // The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to // access Amazon Web Services resources in your environment. For example, - // arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon - // MWAA Execution role - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html). + // arn:aws:iam::123456789:role/my-execution-role . For more information, see + // Amazon MWAA Execution role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) + // . ExecutionRoleArn *string // The Amazon Web Services Key Management Service (KMS) encryption key used to @@ -72,51 +72,49 @@ type Environment struct { // The Apache Airflow logs published to CloudWatch Logs. LoggingConfiguration *LoggingConfiguration - // The maximum number of workers that run in your environment. For example, 20. + // The maximum number of workers that run in your environment. For example, 20 . MaxWorkers *int32 - // The minimum number of workers that run in your environment. For example, 2. + // The minimum number of workers that run in your environment. For example, 2 . MinWorkers *int32 - // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment. + // The name of the Amazon MWAA environment. For example, MyMWAAEnvironment . Name *string // Describes the VPC networking components used to secure and enable network // traffic between the Amazon Web Services resources for your environment. For more - // information, see About networking on Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). + // information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) + // . NetworkConfiguration *NetworkConfiguration // The version of the plugins.zip file in your Amazon S3 bucket. You must specify - // the version ID - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) // that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded, // URL-ready, opaque strings that are no more than 1,024 bytes long. The following // is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo - // For more information, see Installing custom plugins - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html). + // For more information, see Installing custom plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) + // . PluginsS3ObjectVersion *string // The relative path to the file in your Amazon S3 bucket. For example, - // s3://mwaa-environment/plugins.zip. For more information, see Installing custom - // plugins - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html). + // s3://mwaa-environment/plugins.zip . For more information, see Installing custom + // plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) + // . PluginsS3Path *string // The version of the requirements.txt file on your Amazon S3 bucket. You must - // specify the version ID - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) // that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded, // URL-ready, opaque strings that are no more than 1,024 bytes long. The following // is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo - // For more information, see Installing Python dependencies - // (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html). + // For more information, see Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) + // . RequirementsS3ObjectVersion *string // The relative path to the requirements.txt file in your Amazon S3 bucket. For - // example, s3://mwaa-environment/requirements.txt. For more information, see - // Installing Python dependencies - // (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html). + // example, s3://mwaa-environment/requirements.txt . For more information, see + // Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) + // . RequirementsS3Path *string // The number of Apache Airflow schedulers that run in your Amazon MWAA @@ -124,89 +122,73 @@ type Environment struct { Schedulers *int32 // The Amazon Resource Name (ARN) for the service-linked role of the environment. - // For more information, see Amazon MWAA Service-linked role - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html). + // For more information, see Amazon MWAA Service-linked role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html) + // . ServiceRoleArn *string // The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and // supporting files are stored. For example, - // arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an - // Amazon S3 bucket for Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html). + // arn:aws:s3:::my-airflow-bucket-unique-name . For more information, see Create + // an Amazon S3 bucket for Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) + // . SourceBucketArn *string // The version of the startup shell script in your Amazon S3 bucket. You must - // specify the version ID - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) + // specify the version ID (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) // that Amazon S3 assigns to the file. Version IDs are Unicode, UTF-8 encoded, // URL-ready, opaque strings that are no more than 1,024 bytes long. The following // is an example: 3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo - // For more information, see Using a startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // For more information, see Using a startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3ObjectVersion *string // The relative path to the startup shell script in your Amazon S3 bucket. For - // example, s3://mwaa-environment/startup.sh. Amazon MWAA runs the script as your + // example, s3://mwaa-environment/startup.sh . Amazon MWAA runs the script as your // environment starts, and before running the Apache Airflow process. You can use // this script to install dependencies, modify Apache Airflow configuration // options, and set environment variables. For more information, see Using a - // startup script - // (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). + // startup script (https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) + // . StartupScriptS3Path *string // The status of the Amazon MWAA environment. Valid values: - // - // * CREATING - Indicates - // the request to create the environment is in progress. - // - // * CREATE_FAILED - - // Indicates the request to create the environment failed, and the environment - // could not be created. - // - // * AVAILABLE - Indicates the request was successful and - // the environment is ready to use. - // - // * UPDATING - Indicates the request to update - // the environment is in progress. - // - // * DELETING - Indicates the request to delete - // the environment is in progress. - // - // * DELETED - Indicates the request to delete the - // environment is complete, and the environment has been deleted. - // - // * UNAVAILABLE - - // Indicates the request failed, but the environment was unable to rollback and is - // not in a stable state. - // - // * UPDATE_FAILED - Indicates the request to update the - // environment failed, and the environment has rolled back successfully and is - // ready to use. - // - // We recommend reviewing our troubleshooting guide for a list of - // common errors and their solutions. For more information, see Amazon MWAA - // troubleshooting - // (https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html). + // - CREATING - Indicates the request to create the environment is in progress. + // - CREATE_FAILED - Indicates the request to create the environment failed, and + // the environment could not be created. + // - AVAILABLE - Indicates the request was successful and the environment is + // ready to use. + // - UPDATING - Indicates the request to update the environment is in progress. + // - DELETING - Indicates the request to delete the environment is in progress. + // - DELETED - Indicates the request to delete the environment is complete, and + // the environment has been deleted. + // - UNAVAILABLE - Indicates the request failed, but the environment was unable + // to rollback and is not in a stable state. + // - UPDATE_FAILED - Indicates the request to update the environment failed, and + // the environment has rolled back successfully and is ready to use. + // We recommend reviewing our troubleshooting guide for a list of common errors + // and their solutions. For more information, see Amazon MWAA troubleshooting (https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html) + // . Status EnvironmentStatus // The key-value tag pairs associated to your environment. For example, - // "Environment": "Staging". For more information, see Tagging Amazon Web Services - // resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // "Environment": "Staging" . For more information, see Tagging Amazon Web + // Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string // The Apache Airflow Web server access mode. For more information, see Apache - // Airflow access modes - // (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html). + // Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) + // . WebserverAccessMode WebserverAccessMode // The Apache Airflow Web server host name for the Amazon MWAA environment. For - // more information, see Accessing the Apache Airflow UI - // (https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html). + // more information, see Accessing the Apache Airflow UI (https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html) + // . WebserverUrl *string // The day and time of the week in Coordinated Universal Time (UTC) 24-hour // standard time that weekly maintenance updates are scheduled. For example: - // TUE:03:30. + // TUE:03:30 . WeeklyMaintenanceWindowStart *string noSmithyDocumentSerde @@ -222,8 +204,8 @@ type LastUpdate struct { // The error that was encountered during the last update of the environment. Error *UpdateError - // The source of the last update to the environment. Includes internal processes by - // Amazon MWAA, such as an environment maintenance update. + // The source of the last update to the environment. Includes internal processes + // by Amazon MWAA, such as an environment maintenance update. Source *string // The status of the last update on the environment. @@ -276,7 +258,7 @@ type LoggingConfigurationInput struct { // Internal only. Collects Apache Airflow metrics. To learn more about the metrics // published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon -// CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html). +// CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html) . type MetricDatum struct { // Internal only. The name of the metric. @@ -305,35 +287,36 @@ type MetricDatum struct { } // Describes the Apache Airflow log details for the log type (e.g. -// DagProcessingLogs). +// DagProcessingLogs ). type ModuleLoggingConfiguration struct { // The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache - // Airflow log type (e.g. DagProcessingLogs) is published. For example, - // arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*. + // Airflow log type (e.g. DagProcessingLogs ) is published. For example, + // arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:* + // . CloudWatchLogGroupArn *string - // Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is + // Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is // enabled. Enabled *bool - // The Apache Airflow log level for the log type (e.g. DagProcessingLogs). + // The Apache Airflow log level for the log type (e.g. DagProcessingLogs ). LogLevel LoggingLevel noSmithyDocumentSerde } -// Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log -// level to send to CloudWatch Logs (e.g. INFO). +// Enables the Apache Airflow log type (e.g. DagProcessingLogs ) and defines the +// log level to send to CloudWatch Logs (e.g. INFO ). type ModuleLoggingConfigurationInput struct { - // Indicates whether to enable the Apache Airflow log type (e.g. - // DagProcessingLogs). + // Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs + // ). // // This member is required. Enabled *bool - // Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs. + // Defines the Apache Airflow log level (e.g. INFO ) to send to CloudWatch Logs. // // This member is required. LogLevel LoggingLevel @@ -343,17 +326,17 @@ type ModuleLoggingConfigurationInput struct { // Describes the VPC networking components used to secure and enable network // traffic between the Amazon Web Services resources for your environment. For more -// information, see About networking on Amazon MWAA -// (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). +// information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) +// . type NetworkConfiguration struct { // A list of security group IDs. For more information, see Security in your VPC on - // Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html). + // Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html) + // . SecurityGroupIds []string - // A list of subnet IDs. For more information, see About networking on Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). + // A list of subnet IDs. For more information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) + // . SubnetIds []string noSmithyDocumentSerde @@ -361,8 +344,8 @@ type NetworkConfiguration struct { // Internal only. Represents a set of statistics that describe a specific metric. // To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA -// performance metrics in Amazon CloudWatch -// (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html). +// performance metrics in Amazon CloudWatch (https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html) +// . type StatisticSet struct { // Internal only. The maximum value of the sample set. @@ -394,13 +377,13 @@ type UpdateError struct { // Defines the VPC networking components used to secure and enable network traffic // between the Amazon Web Services resources for your environment. For more -// information, see About networking on Amazon MWAA -// (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). +// information, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) +// . type UpdateNetworkConfigurationInput struct { // A list of security group IDs. A security group must be attached to the same VPC - // as the subnets. For more information, see Security in your VPC on Amazon MWAA - // (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html). + // as the subnets. For more information, see Security in your VPC on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html) + // . // // This member is required. SecurityGroupIds []string diff --git a/service/neptune/api_client.go b/service/neptune/api_client.go index d042dfdfe50..cae85f97e3d 100644 --- a/service/neptune/api_client.go +++ b/service/neptune/api_client.go @@ -116,7 +116,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/neptune/api_op_AddRoleToDBCluster.go b/service/neptune/api_op_AddRoleToDBCluster.go index f0fa4a59e01..63bea44dd05 100644 --- a/service/neptune/api_op_AddRoleToDBCluster.go +++ b/service/neptune/api_op_AddRoleToDBCluster.go @@ -35,13 +35,13 @@ type AddRoleToDBClusterInput struct { DBClusterIdentifier *string // The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB - // cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole. + // cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole . // // This member is required. RoleArn *string // The name of the feature for the Neptune DB cluster that the IAM role is to be - // associated with. For the list of supported feature names, see DBEngineVersion. + // associated with. For the list of supported feature names, see DBEngineVersion . FeatureName *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_AddSourceIdentifierToSubscription.go b/service/neptune/api_op_AddSourceIdentifierToSubscription.go index 0fd0af755a1..933be1bff30 100644 --- a/service/neptune/api_op_AddSourceIdentifierToSubscription.go +++ b/service/neptune/api_op_AddSourceIdentifierToSubscription.go @@ -30,19 +30,14 @@ func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params * type AddSourceIdentifierToSubscriptionInput struct { // The identifier of the event source to be added. Constraints: - // - // * If the source - // type is a DB instance, then a DBInstanceIdentifier must be supplied. - // - // * If the - // source type is a DB security group, a DBSecurityGroupName must be supplied. - // - // * - // If the source type is a DB parameter group, a DBParameterGroupName must be - // supplied. - // - // * If the source type is a DB snapshot, a DBSnapshotIdentifier must be - // supplied. + // - If the source type is a DB instance, then a DBInstanceIdentifier must be + // supplied. + // - If the source type is a DB security group, a DBSecurityGroupName must be + // supplied. + // - If the source type is a DB parameter group, a DBParameterGroupName must be + // supplied. + // - If the source type is a DB snapshot, a DBSnapshotIdentifier must be + // supplied. // // This member is required. SourceIdentifier *string diff --git a/service/neptune/api_op_AddTagsToResource.go b/service/neptune/api_op_AddTagsToResource.go index 5c4bc2330fe..fb60ef9c1bc 100644 --- a/service/neptune/api_op_AddTagsToResource.go +++ b/service/neptune/api_op_AddTagsToResource.go @@ -32,9 +32,9 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { // The Amazon Neptune resource that the tags are added to. This value is an Amazon - // Resource Name (ARN). For information about creating an ARN, see Constructing an - // Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + // Resource Name (ARN). For information about creating an ARN, see Constructing an + // Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . // // This member is required. ResourceName *string diff --git a/service/neptune/api_op_ApplyPendingMaintenanceAction.go b/service/neptune/api_op_ApplyPendingMaintenanceAction.go index 2db23f73ce8..54c9e61e7c7 100644 --- a/service/neptune/api_op_ApplyPendingMaintenanceAction.go +++ b/service/neptune/api_op_ApplyPendingMaintenanceAction.go @@ -31,30 +31,25 @@ func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *Appl type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. Valid values: - // system-update, db-upgrade + // system-update , db-upgrade // // This member is required. ApplyAction *string // A value that specifies the type of opt-in request, or undoes an opt-in request. // An opt-in request of type immediate can't be undone. Valid values: - // - // * immediate - // - Apply the maintenance action immediately. - // - // * next-maintenance - Apply the - // maintenance action during the next maintenance window for the resource. - // - // * - // undo-opt-in - Cancel any existing next-maintenance opt-in requests. + // - immediate - Apply the maintenance action immediately. + // - next-maintenance - Apply the maintenance action during the next maintenance + // window for the resource. + // - undo-opt-in - Cancel any existing next-maintenance opt-in requests. // // This member is required. OptInType *string // The Amazon Resource Name (ARN) of the resource that the pending maintenance - // action applies to. For information about creating an ARN, see Constructing an - // Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + // action applies to. For information about creating an ARN, see Constructing an + // Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . // // This member is required. ResourceIdentifier *string diff --git a/service/neptune/api_op_CopyDBClusterParameterGroup.go b/service/neptune/api_op_CopyDBClusterParameterGroup.go index 97f971936b3..5166db9921f 100644 --- a/service/neptune/api_op_CopyDBClusterParameterGroup.go +++ b/service/neptune/api_op_CopyDBClusterParameterGroup.go @@ -29,23 +29,17 @@ func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDB type CopyDBClusterParameterGroupInput struct { - // The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter - // group. For information about creating an ARN, see Constructing an Amazon - // Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). - // Constraints: - // - // * Must specify a valid DB cluster parameter group. - // - // * If the - // source DB cluster parameter group is in the same Amazon Region as the copy, - // specify a valid DB parameter group identifier, for example - // my-db-cluster-param-group, or a valid ARN. - // - // * If the source DB parameter group - // is in a different Amazon Region than the copy, specify a valid DB cluster - // parameter group ARN, for example - // arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1. + // The identifier or Amazon Resource Name (ARN) for the source DB cluster + // parameter group. For information about creating an ARN, see Constructing an + // Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . Constraints: + // - Must specify a valid DB cluster parameter group. + // - If the source DB cluster parameter group is in the same Amazon Region as + // the copy, specify a valid DB parameter group identifier, for example + // my-db-cluster-param-group , or a valid ARN. + // - If the source DB parameter group is in a different Amazon Region than the + // copy, specify a valid DB cluster parameter group ARN, for example + // arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1 . // // This member is required. SourceDBClusterParameterGroupIdentifier *string @@ -56,18 +50,10 @@ type CopyDBClusterParameterGroupInput struct { TargetDBClusterParameterGroupDescription *string // The identifier for the copied DB cluster parameter group. Constraints: - // - // * Cannot - // be null, empty, or blank - // - // * Must contain from 1 to 255 letters, numbers, or - // hyphens - // - // * First character must be a letter - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens - // + // - Cannot be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens // Example: my-cluster-param-group1 // // This member is required. diff --git a/service/neptune/api_op_CopyDBClusterSnapshot.go b/service/neptune/api_op_CopyDBClusterSnapshot.go index 7e06994f791..7a6256d4077 100644 --- a/service/neptune/api_op_CopyDBClusterSnapshot.go +++ b/service/neptune/api_op_CopyDBClusterSnapshot.go @@ -14,8 +14,8 @@ import ( ) // Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared -// manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon -// Resource Name (ARN) of the shared DB cluster snapshot. +// manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the +// Amazon Resource Name (ARN) of the shared DB cluster snapshot. func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) { if params == nil { params = &CopyDBClusterSnapshotInput{} @@ -35,30 +35,18 @@ type CopyDBClusterSnapshotInput struct { // The identifier of the DB cluster snapshot to copy. This parameter is not // case-sensitive. Constraints: - // - // * Must specify a valid system snapshot in the - // "available" state. - // - // * Specify a valid DB snapshot identifier. - // - // Example: - // my-cluster-snapshot1 + // - Must specify a valid system snapshot in the "available" state. + // - Specify a valid DB snapshot identifier. + // Example: my-cluster-snapshot1 // // This member is required. SourceDBClusterSnapshotIdentifier *string // The identifier of the new DB cluster snapshot to create from the source DB // cluster snapshot. This parameter is not case-sensitive. Constraints: - // - // * Must - // contain from 1 to 63 letters, numbers, or hyphens. - // - // * First character must be a - // letter. - // - // * Cannot end with a hyphen or contain two consecutive - // hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster-snapshot2 // // This member is required. @@ -72,10 +60,10 @@ type CopyDBClusterSnapshotInput struct { // ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias // for the KMS encryption key. If you copy an encrypted DB cluster snapshot from // your Amazon account, you can specify a value for KmsKeyId to encrypt the copy - // with a new KMS encryption key. If you don't specify a value for KmsKeyId, then + // with a new KMS encryption key. If you don't specify a value for KmsKeyId , then // the copy of the DB cluster snapshot is encrypted with the same KMS key as the // source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is - // shared from another Amazon account, then you must specify a value for KmsKeyId. + // shared from another Amazon account, then you must specify a value for KmsKeyId . // KMS encryption keys are specific to the Amazon Region that they are created in, // and you can't use encryption keys from one Amazon Region in another Amazon // Region. You cannot encrypt an unencrypted DB cluster snapshot when you copy it. @@ -93,8 +81,8 @@ type CopyDBClusterSnapshotInput struct { // The tags to assign to the new DB cluster snapshot copy. Tags []types.Tag - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde @@ -102,8 +90,8 @@ type CopyDBClusterSnapshotInput struct { type CopyDBClusterSnapshotOutput struct { - // Contains the details for an Amazon Neptune DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon Neptune DB cluster snapshot This data type + // is used as a response element in the DescribeDBClusterSnapshots action. DBClusterSnapshot *types.DBClusterSnapshot // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_CopyDBParameterGroup.go b/service/neptune/api_op_CopyDBParameterGroup.go index f44cec1d79f..cf1ff56d347 100644 --- a/service/neptune/api_op_CopyDBParameterGroup.go +++ b/service/neptune/api_op_CopyDBParameterGroup.go @@ -30,14 +30,11 @@ func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParamet type CopyDBParameterGroupInput struct { // The identifier or ARN for the source DB parameter group. For information about - // creating an ARN, see Constructing an Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). - // Constraints: - // - // * Must specify a valid DB parameter group. - // - // * Must specify a valid - // DB parameter group identifier, for example my-db-param-group, or a valid ARN. + // creating an ARN, see Constructing an Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . Constraints: + // - Must specify a valid DB parameter group. + // - Must specify a valid DB parameter group identifier, for example + // my-db-param-group , or a valid ARN. // // This member is required. SourceDBParameterGroupIdentifier *string @@ -48,18 +45,10 @@ type CopyDBParameterGroupInput struct { TargetDBParameterGroupDescription *string // The identifier for the copied DB parameter group. Constraints: - // - // * Cannot be - // null, empty, or blank. - // - // * Must contain from 1 to 255 letters, numbers, or - // hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Cannot be null, empty, or blank. + // - Must contain from 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-db-parameter-group // // This member is required. diff --git a/service/neptune/api_op_CreateDBCluster.go b/service/neptune/api_op_CreateDBCluster.go index fb2b54d7e58..91940e0cc9b 100644 --- a/service/neptune/api_op_CreateDBCluster.go +++ b/service/neptune/api_op_CreateDBCluster.go @@ -19,7 +19,7 @@ import ( // new cluster using CreateDBCluster directly, deletion protection is disabled by // default (when you create a new production cluster in the console, deletion // protection is enabled by default). You can only delete a DB cluster if its -// DeletionProtection field is set to false. +// DeletionProtection field is set to false . func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error) { if params == nil { params = &CreateDBClusterInput{} @@ -39,15 +39,9 @@ type CreateDBClusterInput struct { // The DB cluster identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster1 // // This member is required. @@ -59,32 +53,30 @@ type CreateDBClusterInput struct { // This member is required. Engine *string - // A list of EC2 Availability Zones that instances in the DB cluster can be created - // in. + // A list of EC2 Availability Zones that instances in the DB cluster can be + // created in. AvailabilityZones []string // The number of days for which automated backups are retained. You must specify a // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35 + // - Must be a value from 1 to 35 BackupRetentionPeriod *int32 // (Not supported by Neptune) CharacterSetName *string - // If set to true, tags are copied to any snapshot of the DB cluster that is + // If set to true , tags are copied to any snapshot of the DB cluster that is // created. CopyTagsToSnapshot *bool - // The name of the DB cluster parameter group to associate with this DB cluster. If - // this argument is omitted, the default is used. Constraints: - // - // * If supplied, must - // match the name of an existing DBClusterParameterGroup. + // The name of the DB cluster parameter group to associate with this DB cluster. + // If this argument is omitted, the default is used. Constraints: + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string - // A DB subnet group to associate with this DB cluster. Constraints: Must match the - // name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup + // A DB subnet group to associate with this DB cluster. Constraints: Must match + // the name of an existing DBSubnetGroup. Must not be default. Example: + // mySubnetgroup DBSubnetGroupName *string // The name for your database of up to 64 alpha-numeric characters. If you do not @@ -100,9 +92,9 @@ type CreateDBClusterInput struct { // The list of log types that need to be enabled for exporting to CloudWatch Logs. EnableCloudwatchLogsExports []string - // If set to true, enables Amazon Identity and Access Management (IAM) + // If set to true , enables Amazon Identity and Access Management (IAM) // authentication for the entire DB cluster (this cannot be set at an instance - // level). Default: false. + // level). Default: false . EnableIAMDatabaseAuthentication *bool // The version number of the database engine to use for the new DB cluster. @@ -118,22 +110,17 @@ type CreateDBClusterInput struct { // are creating a DB cluster with the same Amazon account that owns the KMS // encryption key used to encrypt the new DB cluster, then you can use the KMS key // alias instead of the ARN for the KMS encryption key. If an encryption key is not - // specified in KmsKeyId: - // - // * If ReplicationSourceIdentifier identifies an encrypted - // source, then Amazon Neptune will use the encryption key used to encrypt the - // source. Otherwise, Amazon Neptune will use your default encryption key. - // - // * If - // the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not - // specified, then Amazon Neptune will use your default encryption key. - // - // Amazon KMS - // creates the default encryption key for your Amazon account. Your Amazon account - // has a different default encryption key for each Amazon Region. If you create a - // Read Replica of an encrypted DB cluster in another Amazon Region, you must set - // KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This - // key is used to encrypt the Read Replica in that Amazon Region. + // specified in KmsKeyId : + // - If ReplicationSourceIdentifier identifies an encrypted source, then Amazon + // Neptune will use the encryption key used to encrypt the source. Otherwise, + // Amazon Neptune will use your default encryption key. + // - If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is + // not specified, then Amazon Neptune will use your default encryption key. + // Amazon KMS creates the default encryption key for your Amazon account. Your + // Amazon account has a different default encryption key for each Amazon Region. If + // you create a Read Replica of an encrypted DB cluster in another Amazon Region, + // you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon + // Region. This key is used to encrypt the Read Replica in that Amazon Region. KmsKeyId *string // Not supported by Neptune. @@ -155,28 +142,20 @@ type CreateDBClusterInput struct { // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Region. To see the time blocks available, see Adjusting the Preferred - // Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) + // Region. To see the time blocks available, see Adjusting the Preferred + // Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) // in the Amazon Neptune User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon // Region, occurring on a random day of the week. To see the time blocks available, - // see Adjusting the Preferred Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) + // see Adjusting the Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) // in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string @@ -186,8 +165,7 @@ type CreateDBClusterInput struct { ReplicationSourceIdentifier *string // Contains the scaling configuration of a Neptune Serverless DB cluster. For more - // information, see Using Amazon Neptune Serverless - // (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) + // information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration @@ -204,8 +182,8 @@ type CreateDBClusterInput struct { // A list of EC2 VPC security groups to associate with this DB cluster. VpcSecurityGroupIds []string - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_CreateDBClusterEndpoint.go b/service/neptune/api_op_CreateDBClusterEndpoint.go index 5101ec744de..eb8c7d3d31d 100644 --- a/service/neptune/api_op_CreateDBClusterEndpoint.go +++ b/service/neptune/api_op_CreateDBClusterEndpoint.go @@ -42,7 +42,7 @@ type CreateDBClusterEndpointInput struct { // This member is required. DBClusterIdentifier *string - // The type of the endpoint. One of: READER, WRITER, ANY. + // The type of the endpoint. One of: READER , WRITER , ANY . // // This member is required. EndpointType *string @@ -64,21 +64,16 @@ type CreateDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Neptune DB cluster. This data type is used as a response element in the // following actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon Neptune DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon Neptune DB instance endpoints, +// see Endpoint . type CreateDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -99,7 +94,7 @@ type CreateDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -110,8 +105,8 @@ type CreateDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that cannot be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that cannot be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/neptune/api_op_CreateDBClusterParameterGroup.go b/service/neptune/api_op_CreateDBClusterParameterGroup.go index a3ca26a714b..a51bb43042a 100644 --- a/service/neptune/api_op_CreateDBClusterParameterGroup.go +++ b/service/neptune/api_op_CreateDBClusterParameterGroup.go @@ -16,21 +16,21 @@ import ( // group is initially created with the default parameters for the database engine // used by instances in the DB cluster. To provide custom values for any of the // parameters, you must modify the group after creating it using -// ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, -// you need to associate it with your DB cluster using ModifyDBCluster. When you -// associate a new DB cluster parameter group with a running DB cluster, you need -// to reboot the DB instances in the DB cluster without failover for the new DB -// cluster parameter group and associated settings to take effect. After you create -// a DB cluster parameter group, you should wait at least 5 minutes before creating -// your first DB cluster that uses that DB cluster parameter group as the default -// parameter group. This allows Amazon Neptune to fully complete the create action -// before the DB cluster parameter group is used as the default for a new DB +// ModifyDBClusterParameterGroup . Once you've created a DB cluster parameter +// group, you need to associate it with your DB cluster using ModifyDBCluster . +// When you associate a new DB cluster parameter group with a running DB cluster, +// you need to reboot the DB instances in the DB cluster without failover for the +// new DB cluster parameter group and associated settings to take effect. After you +// create a DB cluster parameter group, you should wait at least 5 minutes before +// creating your first DB cluster that uses that DB cluster parameter group as the +// default parameter group. This allows Amazon Neptune to fully complete the create +// action before the DB cluster parameter group is used as the default for a new DB // cluster. This is especially important for parameters that are critical when // creating the default database for a DB cluster, such as the character set for // the default database defined by the character_set_database parameter. You can -// use the Parameter Groups option of the Amazon Neptune console -// (https://console.aws.amazon.com/rds/) or the DescribeDBClusterParameters command -// to verify that your DB cluster parameter group has been created or modified. +// use the Parameter Groups option of the Amazon Neptune console (https://console.aws.amazon.com/rds/) +// or the DescribeDBClusterParameters command to verify that your DB cluster +// parameter group has been created or modified. func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { params = &CreateDBClusterParameterGroupInput{} @@ -49,12 +49,8 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea type CreateDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must match the name - // of an existing DBClusterParameterGroup. - // - // This value is stored as a lowercase - // string. + // - Must match the name of an existing DBClusterParameterGroup. + // This value is stored as a lowercase string. // // This member is required. DBClusterParameterGroupName *string diff --git a/service/neptune/api_op_CreateDBClusterSnapshot.go b/service/neptune/api_op_CreateDBClusterSnapshot.go index db41970c6fd..8374432b05e 100644 --- a/service/neptune/api_op_CreateDBClusterSnapshot.go +++ b/service/neptune/api_op_CreateDBClusterSnapshot.go @@ -29,12 +29,9 @@ func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBCl type CreateDBClusterSnapshotInput struct { - // The identifier of the DB cluster to create a snapshot for. This parameter is not - // case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. - // + // The identifier of the DB cluster to create a snapshot for. This parameter is + // not case-sensitive. Constraints: + // - Must match the identifier of an existing DBCluster. // Example: my-cluster1 // // This member is required. @@ -42,15 +39,9 @@ type CreateDBClusterSnapshotInput struct { // The identifier of the DB cluster snapshot. This parameter is stored as a // lowercase string. Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or - // hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: my-cluster1-snapshot1 // // This member is required. @@ -64,8 +55,8 @@ type CreateDBClusterSnapshotInput struct { type CreateDBClusterSnapshotOutput struct { - // Contains the details for an Amazon Neptune DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon Neptune DB cluster snapshot This data type + // is used as a response element in the DescribeDBClusterSnapshots action. DBClusterSnapshot *types.DBClusterSnapshot // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_CreateDBInstance.go b/service/neptune/api_op_CreateDBInstance.go index 021844cf443..65a725d1a46 100644 --- a/service/neptune/api_op_CreateDBInstance.go +++ b/service/neptune/api_op_CreateDBInstance.go @@ -30,12 +30,12 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI type CreateDBInstanceInput struct { // The identifier of the DB cluster that the instance will belong to. For - // information on creating a DB cluster, see CreateDBCluster. Type: String + // information on creating a DB cluster, see CreateDBCluster . Type: String // // This member is required. DBClusterIdentifier *string - // The compute and memory capacity of the DB instance, for example, db.m4.large. + // The compute and memory capacity of the DB instance, for example, db.m4.large . // Not all DB instance classes are available in all Amazon Regions. // // This member is required. @@ -43,15 +43,9 @@ type CreateDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance // // This member is required. @@ -73,19 +67,15 @@ type CreateDBInstanceInput struct { // The EC2 Availability Zone that the DB instance is created in Default: A random, // system-chosen Availability Zone in the endpoint's Amazon Region. Example: // us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the - // MultiAZ parameter is set to true. The specified Availability Zone must be in the - // same Amazon Region as the current endpoint. + // MultiAZ parameter is set to true . The specified Availability Zone must be in + // the same Amazon Region as the current endpoint. AvailabilityZone *string - // The number of days for which automated backups are retained. Not applicable. The - // retention period for automated backups is managed by the DB cluster. For more - // information, see CreateDBCluster. Default: 1 Constraints: - // - // * Must be a value - // from 0 to 35 - // - // * Cannot be set to 0 if the DB instance is a source to Read - // Replicas + // The number of days for which automated backups are retained. Not applicable. + // The retention period for automated backups is managed by the DB cluster. For + // more information, see CreateDBCluster . Default: 1 Constraints: + // - Must be a value from 0 to 35 + // - Cannot be set to 0 if the DB instance is a source to Read Replicas BackupRetentionPeriod *int32 // (Not supported by Neptune) @@ -101,14 +91,9 @@ type CreateDBInstanceInput struct { // The name of the DB parameter group to associate with this DB instance. If this // argument is omitted, the default DBParameterGroup for the specified engine is // used. Constraints: - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * First - // character must be a letter - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens DBParameterGroupName *string // A list of DB security groups to associate with this DB instance. Default: The @@ -121,9 +106,8 @@ type CreateDBInstanceInput struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. See Deleting a DB Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). - // DB instances in a DB cluster can be deleted even when deletion protection is + // deletion protection is disabled. See Deleting a DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html) + // . DB instances in a DB cluster can be deleted even when deletion protection is // enabled in their parent DB cluster. DeletionProtection *bool @@ -157,15 +141,15 @@ type CreateDBInstanceInput struct { // encryption key used to encrypt the new DB instance, then you can use the KMS key // alias instead of the ARN for the KM encryption key. Not applicable. The KMS key // identifier is managed by the DB cluster. For more information, see - // CreateDBCluster. If the StorageEncrypted parameter is true, and you do not + // CreateDBCluster . If the StorageEncrypted parameter is true, and you do not // specify a value for the KmsKeyId parameter, then Amazon Neptune will use your // default encryption key. Amazon KMS creates the default encryption key for your // Amazon account. Your Amazon account has a different default encryption key for // each Amazon Region. KmsKeyId *string - // License model information for this DB instance. Valid values: license-included | - // bring-your-own-license | general-public-license + // License model information for this DB instance. Valid values: license-included + // | bring-your-own-license | general-public-license LicenseModel *string // Not supported by Neptune. @@ -183,8 +167,8 @@ type CreateDBInstanceInput struct { // The ARN for the IAM role that permits Neptune to send enhanced monitoring // metrics to Amazon CloudWatch Logs. For example, - // arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value - // other than 0, then you must supply a MonitoringRoleArn value. + // arn:aws:iam:123456789012:role/emaccess . If MonitoringInterval is set to a + // value other than 0, then you must supply a MonitoringRoleArn value. MonitoringRoleArn *string // Specifies if the DB instance is a Multi-AZ deployment. You can't set the @@ -198,20 +182,20 @@ type CreateDBInstanceInput struct { PerformanceInsightsKMSKeyId *string // The port number on which the database accepts connections. Not applicable. The - // port is managed by the DB cluster. For more information, see CreateDBCluster. + // port is managed by the DB cluster. For more information, see CreateDBCluster . // Default: 8182 Type: Integer Port *int32 - // The daily time range during which automated backups are created. Not applicable. - // The daily time range for creating automated backups is managed by the DB - // cluster. For more information, see CreateDBCluster. + // The daily time range during which automated backups are created. Not + // applicable. The daily time range for creating automated backups is managed by + // the DB cluster. For more information, see CreateDBCluster . PreferredBackupWindow *string - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, - // Fri, Sat, Sun. Constraints: Minimum 30-minute window. + // The time range each week during which system maintenance can occur, in + // Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default + // is a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, + // Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string // A value that specifies the order in which an Read Replica is promoted to the @@ -226,7 +210,7 @@ type CreateDBInstanceInput struct { // Specifies whether the DB instance is encrypted. Not applicable. The encryption // for DB instances is managed by the DB cluster. For more information, see - // CreateDBCluster. Default: false + // CreateDBCluster . Default: false StorageEncrypted *bool // Specifies the storage type to be associated with the DB instance. Not @@ -248,8 +232,8 @@ type CreateDBInstanceInput struct { // A list of EC2 VPC security groups to associate with this DB instance. Not // applicable. The associated list of EC2 VPC security groups is managed by the DB - // cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC - // security group for the DB subnet group's VPC. + // cluster. For more information, see CreateDBCluster . Default: The default EC2 + // VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -257,8 +241,8 @@ type CreateDBInstanceInput struct { type CreateDBInstanceOutput struct { - // Contains the details of an Amazon Neptune DB instance. This data type is used as - // a response element in the DescribeDBInstances action. + // Contains the details of an Amazon Neptune DB instance. This data type is used + // as a response element in the DescribeDBInstances action. DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_CreateDBParameterGroup.go b/service/neptune/api_op_CreateDBParameterGroup.go index 3bf89c6b57c..e3511bd04cd 100644 --- a/service/neptune/api_op_CreateDBParameterGroup.go +++ b/service/neptune/api_op_CreateDBParameterGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB parameter group. A DB parameter group is initially created with -// the default parameters for the database engine used by the DB instance. To +// Creates a new DB parameter group. A DB parameter group is initially created +// with the default parameters for the database engine used by the DB instance. To // provide custom values for any of the parameters, you must modify the group after // creating it using ModifyDBParameterGroup. Once you've created a DB parameter // group, you need to associate it with your DB instance using ModifyDBInstance. @@ -54,17 +54,10 @@ type CreateDBParameterGroupInput struct { DBParameterGroupFamily *string // The name of the DB parameter group. Constraints: - // - // * Must be 1 to 255 letters, - // numbers, or hyphens. - // - // * First character must be a letter - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. // // This member is required. DBParameterGroupName *string diff --git a/service/neptune/api_op_CreateDBSubnetGroup.go b/service/neptune/api_op_CreateDBSubnetGroup.go index 856da62862d..09c068e97f5 100644 --- a/service/neptune/api_op_CreateDBSubnetGroup.go +++ b/service/neptune/api_op_CreateDBSubnetGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB subnet group. DB subnet groups must contain at least one subnet -// in at least two AZs in the Amazon Region. +// Creates a new DB subnet group. DB subnet groups must contain at least one +// subnet in at least two AZs in the Amazon Region. func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnetGroupInput, optFns ...func(*Options)) (*CreateDBSubnetGroupOutput, error) { if params == nil { params = &CreateDBSubnetGroupInput{} diff --git a/service/neptune/api_op_CreateEventSubscription.go b/service/neptune/api_op_CreateEventSubscription.go index 378b3d2836d..ac6e65e8ae2 100644 --- a/service/neptune/api_op_CreateEventSubscription.go +++ b/service/neptune/api_op_CreateEventSubscription.go @@ -69,26 +69,20 @@ type CreateEventSubscriptionInput struct { // not specified, then all sources are included in the response. An identifier must // begin with a letter and must contain only ASCII letters, digits, and hyphens; it // can't end with a hyphen or contain two consecutive hyphens. Constraints: - // - // * If - // SourceIds are supplied, SourceType must also be provided. - // - // * If the source type - // is a DB instance, then a DBInstanceIdentifier must be supplied. - // - // * If the source - // type is a DB security group, a DBSecurityGroupName must be supplied. - // - // * If the - // source type is a DB parameter group, a DBParameterGroupName must be supplied. - // - // * - // If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied. + // - If SourceIds are supplied, SourceType must also be provided. + // - If the source type is a DB instance, then a DBInstanceIdentifier must be + // supplied. + // - If the source type is a DB security group, a DBSecurityGroupName must be + // supplied. + // - If the source type is a DB parameter group, a DBParameterGroupName must be + // supplied. + // - If the source type is a DB snapshot, a DBSnapshotIdentifier must be + // supplied. SourceIds []string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by a DB instance, you would set this parameter to - // db-instance. if this value is not specified, all events are returned. Valid + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by a DB instance, you would set this parameter + // to db-instance. if this value is not specified, all events are returned. Valid // values: db-instance | db-cluster | db-parameter-group | db-security-group | // db-snapshot | db-cluster-snapshot SourceType *string diff --git a/service/neptune/api_op_CreateGlobalCluster.go b/service/neptune/api_op_CreateGlobalCluster.go index 8b7d5620757..0f2cebe13be 100644 --- a/service/neptune/api_op_CreateGlobalCluster.go +++ b/service/neptune/api_op_CreateGlobalCluster.go @@ -41,12 +41,12 @@ type CreateGlobalClusterInput struct { // This member is required. GlobalClusterIdentifier *string - // The deletion protection setting for the new global database. The global database - // can't be deleted when deletion protection is enabled. + // The deletion protection setting for the new global database. The global + // database can't be deleted when deletion protection is enabled. DeletionProtection *bool - // The name of the database engine to be used in the global database. Valid values: - // neptune + // The name of the database engine to be used in the global database. Valid + // values: neptune Engine *string // The Neptune engine version to be used by the global database. Valid values: @@ -66,8 +66,8 @@ type CreateGlobalClusterInput struct { type CreateGlobalClusterOutput struct { // Contains the details of an Amazon Neptune global database. This data type is - // used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, - // ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and + // used as a response element for the CreateGlobalCluster , DescribeGlobalClusters + // , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster diff --git a/service/neptune/api_op_DeleteDBCluster.go b/service/neptune/api_op_DeleteDBCluster.go index 1838eec0e0b..393b60f00de 100644 --- a/service/neptune/api_op_DeleteDBCluster.go +++ b/service/neptune/api_op_DeleteDBCluster.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeleteDBCluster action deletes a previously provisioned DB cluster. When you -// delete a DB cluster, all automated backups for that DB cluster are deleted and -// can't be recovered. Manual DB cluster snapshots of the specified DB cluster are -// not deleted. Note that the DB Cluster cannot be deleted if deletion protection -// is enabled. To delete it, you must first set its DeletionProtection field to -// False. +// The DeleteDBCluster action deletes a previously provisioned DB cluster. When +// you delete a DB cluster, all automated backups for that DB cluster are deleted +// and can't be recovered. Manual DB cluster snapshots of the specified DB cluster +// are not deleted. Note that the DB Cluster cannot be deleted if deletion +// protection is enabled. To delete it, you must first set its DeletionProtection +// field to False . func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInput, optFns ...func(*Options)) (*DeleteDBClusterOutput, error) { if params == nil { params = &DeleteDBClusterInput{} @@ -34,32 +34,26 @@ func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInp type DeleteDBClusterInput struct { - // The DB cluster identifier for the DB cluster to be deleted. This parameter isn't - // case-sensitive. Constraints: - // - // * Must match an existing DBClusterIdentifier. + // The DB cluster identifier for the DB cluster to be deleted. This parameter + // isn't case-sensitive. Constraints: + // - Must match an existing DBClusterIdentifier. // // This member is required. DBClusterIdentifier *string // The DB cluster snapshot identifier of the new DB cluster snapshot created when - // SkipFinalSnapshot is set to false. Specifying this parameter and also setting + // SkipFinalSnapshot is set to false . Specifying this parameter and also setting // the SkipFinalShapshot parameter to true results in an error. Constraints: - // - // * - // Must be 1 to 255 letters, numbers, or hyphens. - // - // * First character must be a - // letter - // - // * Cannot end with a hyphen or contain two consecutive hyphens + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens FinalDBSnapshotIdentifier *string // Determines whether a final DB cluster snapshot is created before the DB cluster - // is deleted. If true is specified, no DB cluster snapshot is created. If false is - // specified, a DB cluster snapshot is created before the DB cluster is deleted. + // is deleted. If true is specified, no DB cluster snapshot is created. If false + // is specified, a DB cluster snapshot is created before the DB cluster is deleted. // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is - // false. Default: false + // false . Default: false SkipFinalSnapshot bool noSmithyDocumentSerde diff --git a/service/neptune/api_op_DeleteDBClusterEndpoint.go b/service/neptune/api_op_DeleteDBClusterEndpoint.go index 9c526ec56af..d2e73ea28da 100644 --- a/service/neptune/api_op_DeleteDBClusterEndpoint.go +++ b/service/neptune/api_op_DeleteDBClusterEndpoint.go @@ -40,21 +40,16 @@ type DeleteDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Neptune DB cluster. This data type is used as a response element in the // following actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type DeleteDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -75,7 +70,7 @@ type DeleteDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -86,8 +81,8 @@ type DeleteDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that cannot be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that cannot be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/neptune/api_op_DeleteDBClusterParameterGroup.go b/service/neptune/api_op_DeleteDBClusterParameterGroup.go index c7c8570f5a8..d02d65b00ac 100644 --- a/service/neptune/api_op_DeleteDBClusterParameterGroup.go +++ b/service/neptune/api_op_DeleteDBClusterParameterGroup.go @@ -30,14 +30,9 @@ func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *Dele type DeleteDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be the name of - // an existing DB cluster parameter group. - // - // * You can't delete a default DB cluster - // parameter group. - // - // * Cannot be associated with any DB clusters. + // - Must be the name of an existing DB cluster parameter group. + // - You can't delete a default DB cluster parameter group. + // - Cannot be associated with any DB clusters. // // This member is required. DBClusterParameterGroupName *string diff --git a/service/neptune/api_op_DeleteDBClusterSnapshot.go b/service/neptune/api_op_DeleteDBClusterSnapshot.go index 41dbebe57a8..f5f88d2f1c0 100644 --- a/service/neptune/api_op_DeleteDBClusterSnapshot.go +++ b/service/neptune/api_op_DeleteDBClusterSnapshot.go @@ -42,8 +42,8 @@ type DeleteDBClusterSnapshotInput struct { type DeleteDBClusterSnapshotOutput struct { - // Contains the details for an Amazon Neptune DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon Neptune DB cluster snapshot This data type + // is used as a response element in the DescribeDBClusterSnapshots action. DBClusterSnapshot *types.DBClusterSnapshot // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DeleteDBInstance.go b/service/neptune/api_op_DeleteDBInstance.go index 0b9b2fe738c..4c9f615b54d 100644 --- a/service/neptune/api_op_DeleteDBInstance.go +++ b/service/neptune/api_op_DeleteDBInstance.go @@ -18,10 +18,10 @@ import ( // of the Amazon Neptune DB instance is deleting until the DB snapshot is created. // The API action DescribeDBInstance is used to monitor the status of this // operation. The action can't be canceled or reverted once submitted. Note that -// when a DB instance is in a failure state and has a status of failed, -// incompatible-restore, or incompatible-network, you can only delete it when the -// SkipFinalSnapshot parameter is set to true. You can't delete a DB instance if it -// is the only instance in the DB cluster, or if it has deletion protection +// when a DB instance is in a failure state and has a status of failed , +// incompatible-restore , or incompatible-network , you can only delete it when the +// SkipFinalSnapshot parameter is set to true . You can't delete a DB instance if +// it is the only instance in the DB cluster, or if it has deletion protection // enabled. func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error) { if params == nil { @@ -42,27 +42,18 @@ type DeleteDBInstanceInput struct { // The DB instance identifier for the DB instance to be deleted. This parameter // isn't case-sensitive. Constraints: - // - // * Must match the name of an existing DB - // instance. + // - Must match the name of an existing DB instance. // // This member is required. DBInstanceIdentifier *string - // The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is - // set to false. Specifying this parameter and also setting the SkipFinalShapshot - // parameter to true results in an error. Constraints: - // - // * Must be 1 to 255 letters - // or numbers. - // - // * First character must be a letter - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens - // - // * Cannot be specified when deleting a Read - // Replica. + // The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot + // is set to false . Specifying this parameter and also setting the + // SkipFinalShapshot parameter to true results in an error. Constraints: + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // - Cannot be specified when deleting a Read Replica. FinalDBSnapshotIdentifier *string // Determines whether a final DB snapshot is created before the DB instance is @@ -72,7 +63,7 @@ type DeleteDBInstanceInput struct { // 'incompatible-restore', or 'incompatible-network', it can only be deleted when // the SkipFinalSnapshot parameter is set to "true". Specify true when deleting a // Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if - // SkipFinalSnapshot is false. Default: false + // SkipFinalSnapshot is false . Default: false SkipFinalSnapshot bool noSmithyDocumentSerde @@ -80,8 +71,8 @@ type DeleteDBInstanceInput struct { type DeleteDBInstanceOutput struct { - // Contains the details of an Amazon Neptune DB instance. This data type is used as - // a response element in the DescribeDBInstances action. + // Contains the details of an Amazon Neptune DB instance. This data type is used + // as a response element in the DescribeDBInstances action. DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DeleteDBParameterGroup.go b/service/neptune/api_op_DeleteDBParameterGroup.go index 4a849fdfcd1..be642fe88c3 100644 --- a/service/neptune/api_op_DeleteDBParameterGroup.go +++ b/service/neptune/api_op_DeleteDBParameterGroup.go @@ -30,14 +30,9 @@ func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBPar type DeleteDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * Must be the name of an - // existing DB parameter group - // - // * You can't delete a default DB parameter group - // - // * - // Cannot be associated with any DB instances + // - Must be the name of an existing DB parameter group + // - You can't delete a default DB parameter group + // - Cannot be associated with any DB instances // // This member is required. DBParameterGroupName *string diff --git a/service/neptune/api_op_DeleteGlobalCluster.go b/service/neptune/api_op_DeleteGlobalCluster.go index 70ad67a6d2a..1be1f2e120b 100644 --- a/service/neptune/api_op_DeleteGlobalCluster.go +++ b/service/neptune/api_op_DeleteGlobalCluster.go @@ -41,8 +41,8 @@ type DeleteGlobalClusterInput struct { type DeleteGlobalClusterOutput struct { // Contains the details of an Amazon Neptune global database. This data type is - // used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, - // ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and + // used as a response element for the CreateGlobalCluster , DescribeGlobalClusters + // , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster diff --git a/service/neptune/api_op_DescribeDBClusterEndpoints.go b/service/neptune/api_op_DescribeDBClusterEndpoints.go index 30a206dbf72..2dbfde1a092 100644 --- a/service/neptune/api_op_DescribeDBClusterEndpoints.go +++ b/service/neptune/api_op_DescribeDBClusterEndpoints.go @@ -42,18 +42,18 @@ type DescribeDBClusterEndpointsInput struct { // A set of name-value pairs that define which endpoints to include in the output. // The filters are specified as name-value pairs, in the format - // Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: - // db-cluster-endpoint-type, db-cluster-endpoint-custom-type, - // db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the - // db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. - // Values for the db-cluster-endpoint-custom-type filter can be one or more of: - // reader, any. Values for the db-cluster-endpoint-status filter can be one or more - // of: available, creating, deleting, inactive, modifying. + // Name=endpoint_type,Values=endpoint_type1,endpoint_type2,... . Name can be one + // of: db-cluster-endpoint-type , db-cluster-endpoint-custom-type , + // db-cluster-endpoint-id , db-cluster-endpoint-status . Values for the + // db-cluster-endpoint-type filter can be one or more of: reader , writer , custom + // . Values for the db-cluster-endpoint-custom-type filter can be one or more of: + // reader , any . Values for the db-cluster-endpoint-status filter can be one or + // more of: available , creating , deleting , inactive , modifying . Filters []types.Filter // An optional pagination token provided by a previous DescribeDBClusterEndpoints // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -73,7 +73,7 @@ type DescribeDBClusterEndpointsOutput struct { // An optional pagination token provided by a previous DescribeDBClusterEndpoints // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBClusterParameterGroups.go b/service/neptune/api_op_DescribeDBClusterParameterGroups.go index 43196d90b48..f2ff333ac3a 100644 --- a/service/neptune/api_op_DescribeDBClusterParameterGroups.go +++ b/service/neptune/api_op_DescribeDBClusterParameterGroups.go @@ -34,9 +34,7 @@ type DescribeDBClusterParameterGroupsInput struct { // The name of a specific DB cluster parameter group to return details for. // Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string // This parameter is not currently supported. @@ -45,7 +43,7 @@ type DescribeDBClusterParameterGroupsInput struct { // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -65,7 +63,7 @@ type DescribeDBClusterParameterGroupsOutput struct { // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBClusterParameters.go b/service/neptune/api_op_DescribeDBClusterParameters.go index dee0c9b2721..d6a905467a9 100644 --- a/service/neptune/api_op_DescribeDBClusterParameters.go +++ b/service/neptune/api_op_DescribeDBClusterParameters.go @@ -32,9 +32,7 @@ type DescribeDBClusterParametersInput struct { // The name of a specific DB cluster parameter group to return parameter details // for. Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. // // This member is required. DBClusterParameterGroupName *string @@ -44,7 +42,7 @@ type DescribeDBClusterParametersInput struct { // An optional pagination token provided by a previous DescribeDBClusterParameters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -54,7 +52,7 @@ type DescribeDBClusterParametersInput struct { MaxRecords *int32 // A value that indicates to return only parameters for a specific source. - // Parameter sources can be engine, service, or customer. + // Parameter sources can be engine , service , or customer . Source *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go b/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go index 97621986dee..d519581b0bf 100644 --- a/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of DB cluster snapshot attribute names and values for a manual DB -// cluster snapshot. When sharing snapshots with other Amazon accounts, +// Returns a list of DB cluster snapshot attribute names and values for a manual +// DB cluster snapshot. When sharing snapshots with other Amazon accounts, // DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of // IDs for the Amazon accounts that are authorized to copy or restore the manual DB // cluster snapshot. If all is included in the list of values for the restore // attribute, then the manual DB cluster snapshot is public and can be copied or // restored by all Amazon accounts. To add or remove access for an Amazon account // to copy or restore a manual DB cluster snapshot, or to make the manual DB -// cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API -// action. +// cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute +// API action. func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotAttributesInput{} diff --git a/service/neptune/api_op_DescribeDBClusterSnapshots.go b/service/neptune/api_op_DescribeDBClusterSnapshots.go index 3eb6d3da3f8..7e4ec8452bc 100644 --- a/service/neptune/api_op_DescribeDBClusterSnapshots.go +++ b/service/neptune/api_op_DescribeDBClusterSnapshots.go @@ -34,41 +34,36 @@ type DescribeDBClusterSnapshotsInput struct { // The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This // parameter can't be used in conjunction with the DBClusterSnapshotIdentifier // parameter. This parameter is not case-sensitive. Constraints: - // - // * If supplied, - // must match the identifier of an existing DBCluster. + // - If supplied, must match the identifier of an existing DBCluster. DBClusterIdentifier *string // A specific DB cluster snapshot identifier to describe. This parameter can't be - // used in conjunction with the DBClusterIdentifier parameter. This value is stored - // as a lowercase string. Constraints: - // - // * If supplied, must match the identifier of - // an existing DBClusterSnapshot. - // - // * If this identifier is for an automated - // snapshot, the SnapshotType parameter must also be specified. + // used in conjunction with the DBClusterIdentifier parameter. This value is + // stored as a lowercase string. Constraints: + // - If supplied, must match the identifier of an existing DBClusterSnapshot. + // - If this identifier is for an automated snapshot, the SnapshotType parameter + // must also be specified. DBClusterSnapshotIdentifier *string // This parameter is not currently supported. Filters []types.Filter - // True to include manual DB cluster snapshots that are public and can be copied or - // restored by any Amazon account, and otherwise false. The default is false. The - // default is false. You can share a manual DB cluster snapshot as public by using - // the ModifyDBClusterSnapshotAttribute API action. + // True to include manual DB cluster snapshots that are public and can be copied + // or restored by any Amazon account, and otherwise false. The default is false . + // The default is false. You can share a manual DB cluster snapshot as public by + // using the ModifyDBClusterSnapshotAttribute API action. IncludePublic bool // True to include shared manual DB cluster snapshots from other Amazon accounts // that this Amazon account has been given permission to copy or restore, and - // otherwise false. The default is false. You can give an Amazon account permission - // to restore a manual DB cluster snapshot from another Amazon account by the - // ModifyDBClusterSnapshotAttribute API action. + // otherwise false. The default is false . You can give an Amazon account + // permission to restore a manual DB cluster snapshot from another Amazon account + // by the ModifyDBClusterSnapshotAttribute API action. IncludeShared bool // An optional pagination token provided by a previous DescribeDBClusterSnapshots // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -79,28 +74,21 @@ type DescribeDBClusterSnapshotsInput struct { // The type of DB cluster snapshots to be returned. You can specify one of the // following values: - // - // * automated - Return all DB cluster snapshots that have been - // automatically taken by Amazon Neptune for my Amazon account. - // - // * manual - Return - // all DB cluster snapshots that have been taken by my Amazon account. - // - // * shared - - // Return all manual DB cluster snapshots that have been shared to my Amazon - // account. - // - // * public - Return all DB cluster snapshots that have been marked as - // public. - // - // If you don't specify a SnapshotType value, then both automated and - // manual DB cluster snapshots are returned. You can include shared DB cluster - // snapshots with these results by setting the IncludeShared parameter to true. You - // can include public DB cluster snapshots with these results by setting the - // IncludePublic parameter to true. The IncludeShared and IncludePublic parameters - // don't apply for SnapshotType values of manual or automated. The IncludePublic - // parameter doesn't apply when SnapshotType is set to shared. The IncludeShared - // parameter doesn't apply when SnapshotType is set to public. + // - automated - Return all DB cluster snapshots that have been automatically + // taken by Amazon Neptune for my Amazon account. + // - manual - Return all DB cluster snapshots that have been taken by my Amazon + // account. + // - shared - Return all manual DB cluster snapshots that have been shared to my + // Amazon account. + // - public - Return all DB cluster snapshots that have been marked as public. + // If you don't specify a SnapshotType value, then both automated and manual DB + // cluster snapshots are returned. You can include shared DB cluster snapshots with + // these results by setting the IncludeShared parameter to true . You can include + // public DB cluster snapshots with these results by setting the IncludePublic + // parameter to true . The IncludeShared and IncludePublic parameters don't apply + // for SnapshotType values of manual or automated . The IncludePublic parameter + // doesn't apply when SnapshotType is set to shared . The IncludeShared parameter + // doesn't apply when SnapshotType is set to public . SnapshotType *string noSmithyDocumentSerde @@ -113,7 +101,7 @@ type DescribeDBClusterSnapshotsOutput struct { // An optional pagination token provided by a previous DescribeDBClusterSnapshots // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBClusters.go b/service/neptune/api_op_DescribeDBClusters.go index c1f00e8ea74..ef2cfd6bbef 100644 --- a/service/neptune/api_op_DescribeDBClusters.go +++ b/service/neptune/api_op_DescribeDBClusters.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about provisioned DB clusters, and supports pagination. This -// operation can also return information for Amazon RDS clusters and Amazon DocDB -// clusters. +// Returns information about provisioned DB clusters, and supports pagination. +// This operation can also return information for Amazon RDS clusters and Amazon +// DocDB clusters. func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClustersInput, optFns ...func(*Options)) (*DescribeDBClustersOutput, error) { if params == nil { params = &DescribeDBClustersInput{} @@ -35,29 +35,22 @@ type DescribeDBClustersInput struct { // The user-supplied DB cluster identifier. If this parameter is specified, // information from only the specific DB cluster is returned. This parameter isn't // case-sensitive. Constraints: - // - // * If supplied, must match an existing - // DBClusterIdentifier. + // - If supplied, must match an existing DBClusterIdentifier. DBClusterIdentifier *string - // A filter that specifies one or more DB clusters to describe. Supported - // filters: - // - // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon - // Resource Names (ARNs). The results list will only include information about the - // DB clusters identified by these ARNs. - // - // * engine - Accepts an engine name (such - // as neptune), and restricts the results list to DB clusters created by that - // engine. - // - // For example, to invoke this API from the Amazon CLI and filter so that - // only Neptune DB clusters are returned, you could use the following command: + // A filter that specifies one or more DB clusters to describe. Supported filters: + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list will only include information about the + // DB clusters identified by these ARNs. + // - engine - Accepts an engine name (such as neptune ), and restricts the + // results list to DB clusters created by that engine. + // For example, to invoke this API from the Amazon CLI and filter so that only + // Neptune DB clusters are returned, you could use the following command: Filters []types.Filter // An optional pagination token provided by a previous DescribeDBClusters request. // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/neptune/api_op_DescribeDBEngineVersions.go b/service/neptune/api_op_DescribeDBEngineVersions.go index 8f13890bb1a..69dfd45eefe 100644 --- a/service/neptune/api_op_DescribeDBEngineVersions.go +++ b/service/neptune/api_op_DescribeDBEngineVersions.go @@ -32,8 +32,7 @@ type DescribeDBEngineVersionsInput struct { // The name of a specific DB parameter group family to return details for. // Constraints: - // - // * If supplied, must match an existing DBParameterGroupFamily. + // - If supplied, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string // Indicates that only the default version of the specified engine or engine and @@ -50,18 +49,18 @@ type DescribeDBEngineVersionsInput struct { Filters []types.Filter // If this parameter is specified and the requested engine supports the - // CharacterSetName parameter for CreateDBInstance, the response includes a list of - // supported character sets for each engine version. + // CharacterSetName parameter for CreateDBInstance , the response includes a list + // of supported character sets for each engine version. ListSupportedCharacterSets *bool // If this parameter is specified and the requested engine supports the TimeZone - // parameter for CreateDBInstance, the response includes a list of supported time + // parameter for CreateDBInstance , the response includes a list of supported time // zones for each engine version. ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more than the @@ -80,7 +79,7 @@ type DescribeDBEngineVersionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBInstances.go b/service/neptune/api_op_DescribeDBInstances.go index 709c5ce22bb..858befcbcfe 100644 --- a/service/neptune/api_op_DescribeDBInstances.go +++ b/service/neptune/api_op_DescribeDBInstances.go @@ -41,30 +41,23 @@ type DescribeDBInstancesInput struct { // The user-supplied instance identifier. If this parameter is specified, // information from only the specific DB instance is returned. This parameter isn't // case-sensitive. Constraints: - // - // * If supplied, must match the identifier of an - // existing DBInstance. + // - If supplied, must match the identifier of an existing DBInstance. DBInstanceIdentifier *string // A filter that specifies one or more DB instances to describe. Supported // filters: - // - // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon - // Resource Names (ARNs). The results list will only include information about the - // DB instances associated with the DB clusters identified by these ARNs. - // - // * engine - // - Accepts an engine name (such as neptune), and restricts the results list to DB - // instances created by that engine. - // - // For example, to invoke this API from the - // Amazon CLI and filter so that only Neptune DB instances are returned, you could - // use the following command: + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list will only include information about the + // DB instances associated with the DB clusters identified by these ARNs. + // - engine - Accepts an engine name (such as neptune ), and restricts the + // results list to DB instances created by that engine. + // For example, to invoke this API from the Amazon CLI and filter so that only + // Neptune DB instances are returned, you could use the following command: Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBInstances request. - // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // An optional pagination token provided by a previous DescribeDBInstances + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -155,8 +148,8 @@ func (c *Client) addOperationDescribeDBInstancesMiddlewares(stack *middleware.St return nil } -// DescribeDBInstancesAPIClient is a client that implements the DescribeDBInstances -// operation. +// DescribeDBInstancesAPIClient is a client that implements the +// DescribeDBInstances operation. type DescribeDBInstancesAPIClient interface { DescribeDBInstances(context.Context, *DescribeDBInstancesInput, ...func(*Options)) (*DescribeDBInstancesOutput, error) } @@ -263,9 +256,10 @@ type DBInstanceAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -305,9 +299,9 @@ func NewDBInstanceAvailableWaiter(client DescribeDBInstancesAPIClient, optFns .. } } -// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *DBInstanceAvailableWaiter) Wait(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -558,9 +552,9 @@ type DBInstanceDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -608,10 +602,10 @@ func (w *DBInstanceDeletedWaiter) Wait(ctx context.Context, params *DescribeDBIn return err } -// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *DBInstanceDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceDeletedWaiterOptions)) (*DescribeDBInstancesOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/neptune/api_op_DescribeDBParameterGroups.go b/service/neptune/api_op_DescribeDBParameterGroups.go index c523579946e..df0824bf360 100644 --- a/service/neptune/api_op_DescribeDBParameterGroups.go +++ b/service/neptune/api_op_DescribeDBParameterGroups.go @@ -33,9 +33,7 @@ func (c *Client) DescribeDBParameterGroups(ctx context.Context, params *Describe type DescribeDBParameterGroupsInput struct { // The name of a specific DB parameter group to return details for. Constraints: - // - // * - // If supplied, must match the name of an existing DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBParameterGroupName *string // This parameter is not currently supported. @@ -43,7 +41,7 @@ type DescribeDBParameterGroupsInput struct { // An optional pagination token provided by a previous DescribeDBParameterGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -62,7 +60,7 @@ type DescribeDBParameterGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBParameters.go b/service/neptune/api_op_DescribeDBParameters.go index 24c7f956e7c..902caa0bfcf 100644 --- a/service/neptune/api_op_DescribeDBParameters.go +++ b/service/neptune/api_op_DescribeDBParameters.go @@ -31,9 +31,7 @@ func (c *Client) DescribeDBParameters(ctx context.Context, params *DescribeDBPar type DescribeDBParametersInput struct { // The name of a specific DB parameter group to return details for. Constraints: - // - // * - // If supplied, must match the name of an existing DBParameterGroup. + // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. DBParameterGroupName *string @@ -43,7 +41,7 @@ type DescribeDBParametersInput struct { // An optional pagination token provided by a previous DescribeDBParameters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -63,7 +61,7 @@ type DescribeDBParametersOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A list of Parameter values. diff --git a/service/neptune/api_op_DescribeDBSubnetGroups.go b/service/neptune/api_op_DescribeDBSubnetGroups.go index 2b2696c73db..94dfac9915b 100644 --- a/service/neptune/api_op_DescribeDBSubnetGroups.go +++ b/service/neptune/api_op_DescribeDBSubnetGroups.go @@ -14,8 +14,8 @@ import ( // Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is // specified, the list will contain only the descriptions of the specified -// DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial -// (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). +// DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBSubnetGroupsInput, optFns ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error) { if params == nil { params = &DescribeDBSubnetGroupsInput{} @@ -41,7 +41,7 @@ type DescribeDBSubnetGroupsInput struct { // An optional pagination token provided by a previous DescribeDBSubnetGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -60,7 +60,7 @@ type DescribeDBSubnetGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go index 787d58f3593..187d8d24bdc 100644 --- a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go @@ -42,7 +42,7 @@ type DescribeEngineDefaultClusterParametersInput struct { // An optional pagination token provided by a previous // DescribeEngineDefaultClusterParameters request. If this parameter is specified, // the response includes only records beyond the marker, up to the value specified - // by MaxRecords. + // by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/neptune/api_op_DescribeEngineDefaultParameters.go b/service/neptune/api_op_DescribeEngineDefaultParameters.go index 36f3a67edcc..34737c9ae9b 100644 --- a/service/neptune/api_op_DescribeEngineDefaultParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultParameters.go @@ -42,7 +42,7 @@ type DescribeEngineDefaultParametersInput struct { // An optional pagination token provided by a previous // DescribeEngineDefaultParameters request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/neptune/api_op_DescribeEventSubscriptions.go b/service/neptune/api_op_DescribeEventSubscriptions.go index 336bc123c71..02114823e8a 100644 --- a/service/neptune/api_op_DescribeEventSubscriptions.go +++ b/service/neptune/api_op_DescribeEventSubscriptions.go @@ -62,7 +62,7 @@ type DescribeEventSubscriptionsOutput struct { // An optional pagination token provided by a previous // DescribeOrderableDBInstanceOptions request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeEvents.go b/service/neptune/api_op_DescribeEvents.go index 01841bf02ed..ce2853ac12e 100644 --- a/service/neptune/api_op_DescribeEvents.go +++ b/service/neptune/api_op_DescribeEvents.go @@ -13,8 +13,8 @@ import ( "time" ) -// Returns events related to DB instances, DB security groups, DB snapshots, and DB -// parameter groups for the past 14 days. Events specific to a particular DB +// Returns events related to DB instances, DB security groups, DB snapshots, and +// DB parameter groups for the past 14 days. Events specific to a particular DB // instance, DB security group, database snapshot, or DB parameter group can be // obtained by providing the name as a parameter. By default, the past hour of // events are returned. @@ -38,9 +38,9 @@ type DescribeEventsInput struct { // The number of minutes to retrieve events for. Default: 60 Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z EndTime *time.Time // A list of event categories that trigger notifications for a event notification @@ -52,7 +52,7 @@ type DescribeEventsInput struct { // An optional pagination token provided by a previous DescribeEvents request. If // this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -63,33 +63,24 @@ type DescribeEventsInput struct { // The identifier of the event source for which events are returned. If not // specified, then all sources are included in the response. Constraints: - // - // * If - // SourceIdentifier is supplied, SourceType must also be provided. - // - // * If the source - // type is DBInstance, then a DBInstanceIdentifier must be supplied. - // - // * If the - // source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. - // - // * If - // the source type is DBParameterGroup, a DBParameterGroupName must be supplied. - // - // * - // If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. + // - If SourceIdentifier is supplied, SourceType must also be provided. + // - If the source type is DBInstance , then a DBInstanceIdentifier must be + // supplied. + // - If the source type is DBSecurityGroup , a DBSecurityGroupName must be + // supplied. + // - If the source type is DBParameterGroup , a DBParameterGroupName must be + // supplied. + // - If the source type is DBSnapshot , a DBSnapshotIdentifier must be supplied. + // - Cannot end with a hyphen or contain two consecutive hyphens. SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z StartTime *time.Time noSmithyDocumentSerde diff --git a/service/neptune/api_op_DescribeGlobalClusters.go b/service/neptune/api_op_DescribeGlobalClusters.go index d21e2d2d7ac..7ec6c29f0c8 100644 --- a/service/neptune/api_op_DescribeGlobalClusters.go +++ b/service/neptune/api_op_DescribeGlobalClusters.go @@ -38,8 +38,8 @@ type DescribeGlobalClustersInput struct { GlobalClusterIdentifier *string // (Optional) A pagination token returned by a previous call to - // DescribeGlobalClusters. If this parameter is specified, the response will only - // include records beyond the marker, up to the number specified by MaxRecords. + // DescribeGlobalClusters . If this parameter is specified, the response will only + // include records beyond the marker, up to the number specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -58,7 +58,7 @@ type DescribeGlobalClustersOutput struct { // A pagination token. If this parameter is returned in the response, more records // are available, which can be retrieved by one or more additional calls to - // DescribeGlobalClusters. + // DescribeGlobalClusters . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribePendingMaintenanceActions.go b/service/neptune/api_op_DescribePendingMaintenanceActions.go index c729ae57ee0..4ca665076a4 100644 --- a/service/neptune/api_op_DescribePendingMaintenanceActions.go +++ b/service/neptune/api_op_DescribePendingMaintenanceActions.go @@ -33,21 +33,18 @@ type DescribePendingMaintenanceActionsInput struct { // A filter that specifies one or more resources to return pending maintenance // actions for. Supported filters: - // - // * db-cluster-id - Accepts DB cluster - // identifiers and DB cluster Amazon Resource Names (ARNs). The results list will - // only include pending maintenance actions for the DB clusters identified by these - // ARNs. - // - // * db-instance-id - Accepts DB instance identifiers and DB instance ARNs. - // The results list will only include pending maintenance actions for the DB - // instances identified by these ARNs. + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list will only include pending maintenance + // actions for the DB clusters identified by these ARNs. + // - db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The + // results list will only include pending maintenance actions for the DB instances + // identified by these ARNs. Filters []types.Filter // An optional pagination token provided by a previous // DescribePendingMaintenanceActions request. If this parameter is specified, the // response includes only records beyond the marker, up to a number of records - // specified by MaxRecords. + // specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -67,7 +64,7 @@ type DescribePendingMaintenanceActionsOutput struct { // An optional pagination token provided by a previous // DescribePendingMaintenanceActions request. If this parameter is specified, the // response includes only records beyond the marker, up to a number of records - // specified by MaxRecords. + // specified by MaxRecords . Marker *string // A list of the pending maintenance actions for the resource. diff --git a/service/neptune/api_op_DescribeValidDBInstanceModifications.go b/service/neptune/api_op_DescribeValidDBInstanceModifications.go index 6675ca71bb3..e72f2f439de 100644 --- a/service/neptune/api_op_DescribeValidDBInstanceModifications.go +++ b/service/neptune/api_op_DescribeValidDBInstanceModifications.go @@ -13,7 +13,7 @@ import ( // You can call DescribeValidDBInstanceModifications to learn what modifications // you can make to your DB instance. You can use this information when you call -// ModifyDBInstance. +// ModifyDBInstance . func (c *Client) DescribeValidDBInstanceModifications(ctx context.Context, params *DescribeValidDBInstanceModificationsInput, optFns ...func(*Options)) (*DescribeValidDBInstanceModificationsOutput, error) { if params == nil { params = &DescribeValidDBInstanceModificationsInput{} @@ -44,7 +44,7 @@ type DescribeValidDBInstanceModificationsOutput struct { // Information about valid modifications that you can make to your DB instance. // Contains the result of a successful call to the // DescribeValidDBInstanceModifications action. You can use this information when - // you call ModifyDBInstance. + // you call ModifyDBInstance . ValidDBInstanceModificationsMessage *types.ValidDBInstanceModificationsMessage // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_FailoverDBCluster.go b/service/neptune/api_op_FailoverDBCluster.go index c305670aebf..973c6bd2ec4 100644 --- a/service/neptune/api_op_FailoverDBCluster.go +++ b/service/neptune/api_op_FailoverDBCluster.go @@ -38,14 +38,12 @@ type FailoverDBClusterInput struct { // A DB cluster identifier to force a failover for. This parameter is not // case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. + // - Must match the identifier of an existing DBCluster. DBClusterIdentifier *string // The name of the instance to promote to the primary instance. You must specify // the instance identifier for an Read Replica in the DB cluster. For example, - // mydbcluster-replica1. + // mydbcluster-replica1 . TargetDBInstanceIdentifier *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_FailoverGlobalCluster.go b/service/neptune/api_op_FailoverGlobalCluster.go index 97e4f3699fa..1aea12f6e26 100644 --- a/service/neptune/api_op_FailoverGlobalCluster.go +++ b/service/neptune/api_op_FailoverGlobalCluster.go @@ -47,8 +47,8 @@ type FailoverGlobalClusterInput struct { // This member is required. GlobalClusterIdentifier *string - // The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want - // to promote to primary for the global database. + // The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you + // want to promote to primary for the global database. // // This member is required. TargetDbClusterIdentifier *string @@ -59,8 +59,8 @@ type FailoverGlobalClusterInput struct { type FailoverGlobalClusterOutput struct { // Contains the details of an Amazon Neptune global database. This data type is - // used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, - // ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and + // used as a response element for the CreateGlobalCluster , DescribeGlobalClusters + // , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster diff --git a/service/neptune/api_op_ListTagsForResource.go b/service/neptune/api_op_ListTagsForResource.go index 8ab981c1baa..8bef74f0fc1 100644 --- a/service/neptune/api_op_ListTagsForResource.go +++ b/service/neptune/api_op_ListTagsForResource.go @@ -30,9 +30,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Neptune resource with tags to be listed. This value is an Amazon - // Resource Name (ARN). For information about creating an ARN, see Constructing an - // Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + // Resource Name (ARN). For information about creating an ARN, see Constructing an + // Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . // // This member is required. ResourceName *string diff --git a/service/neptune/api_op_ModifyDBCluster.go b/service/neptune/api_op_ModifyDBCluster.go index 57a298e3151..367266ce79d 100644 --- a/service/neptune/api_op_ModifyDBCluster.go +++ b/service/neptune/api_op_ModifyDBCluster.go @@ -33,9 +33,7 @@ type ModifyDBClusterInput struct { // The DB cluster identifier for the cluster being modified. This parameter is not // case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. + // - Must match the identifier of an existing DBCluster. // // This member is required. DBClusterIdentifier *string @@ -46,28 +44,27 @@ type ModifyDBClusterInput struct { // the DB cluster's current version. AllowMajorVersionUpgrade bool - // A value that specifies whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set - // to false, changes to the DB cluster are applied during the next maintenance - // window. The ApplyImmediately parameter only affects NewDBClusterIdentifier - // values. If you set the ApplyImmediately parameter value to false, then changes - // to NewDBClusterIdentifier values are applied during the next maintenance window. - // All other changes are applied immediately, regardless of the value of the - // ApplyImmediately parameter. Default: false + // A value that specifies whether the modifications in this request and any + // pending modifications are asynchronously applied as soon as possible, regardless + // of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter + // is set to false , changes to the DB cluster are applied during the next + // maintenance window. The ApplyImmediately parameter only affects + // NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value + // to false, then changes to NewDBClusterIdentifier values are applied during the + // next maintenance window. All other changes are applied immediately, regardless + // of the value of the ApplyImmediately parameter. Default: false ApplyImmediately bool // The number of days for which automated backups are retained. You must specify a // minimum value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35 + // - Must be a value from 1 to 35 BackupRetentionPeriod *int32 // The configuration setting for the log types to be enabled for export to // CloudWatch Logs for a specific DB cluster. CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration - // If set to true, tags are copied to any snapshot of the DB cluster that is + // If set to true , tags are copied to any snapshot of the DB cluster that is // created. CopyTagsToSnapshot *bool @@ -75,16 +72,13 @@ type ModifyDBClusterInput struct { DBClusterParameterGroupName *string // The name of the DB parameter group to apply to all instances of the DB cluster. - // When you apply a parameter group using DBInstanceParameterGroupName, parameter + // When you apply a parameter group using DBInstanceParameterGroupName , parameter // changes aren't applied during the next maintenance window but instead are // applied immediately. Default: The existing name setting Constraints: - // - // * The DB - // parameter group must be in the same DB parameter group family as the target DB - // cluster version. - // - // * The DBInstanceParameterGroupName parameter is only valid in - // combination with the AllowMajorVersionUpgrade parameter. + // - The DB parameter group must be in the same DB parameter group family as the + // target DB cluster version. + // - The DBInstanceParameterGroupName parameter is only valid in combination with + // the AllowMajorVersionUpgrade parameter. DBInstanceParameterGroupName *string // A value that indicates whether the DB cluster has deletion protection enabled. @@ -96,13 +90,12 @@ type ModifyDBClusterInput struct { // to database accounts, and otherwise false. Default: false EnableIAMDatabaseAuthentication *bool - // The version number of the database engine to which you want to upgrade. Changing - // this parameter results in an outage. The change is applied during the next - // maintenance window unless the ApplyImmediately parameter is set to true. For a - // list of valid engine versions, see Engine Releases for Amazon Neptune - // (https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html), or - // call DescribeDBEngineVersions - // (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions). + // The version number of the database engine to which you want to upgrade. + // Changing this parameter results in an outage. The change is applied during the + // next maintenance window unless the ApplyImmediately parameter is set to true. + // For a list of valid engine versions, see Engine Releases for Amazon Neptune (https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html) + // , or call DescribeDBEngineVersions (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions) + // . EngineVersion *string // Not supported by Neptune. @@ -110,17 +103,10 @@ type ModifyDBClusterInput struct { // The new DB cluster identifier for the DB cluster when renaming a DB cluster. // This value is stored as a lowercase string. Constraints: - // - // * Must contain from 1 - // to 63 letters, numbers, or hyphens - // - // * The first character must be a letter - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens - // - // Example: - // my-cluster2 + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - The first character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // Example: my-cluster2 NewDBClusterIdentifier *string // Not supported by Neptune. @@ -131,19 +117,13 @@ type ModifyDBClusterInput struct { Port *int32 // The daily time range during which automated backups are created if automated - // backups are enabled, using the BackupRetentionPeriod parameter. The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Region. Constraints: - // - // * Must be in the format hh24:mi-hh24:mi. - // - // * Must be in - // Universal Coordinated Time (UTC). - // - // * Must not conflict with the preferred - // maintenance window. - // - // * Must be at least 30 minutes. + // backups are enabled, using the BackupRetentionPeriod parameter. The default is + // a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Region. Constraints: + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal @@ -154,8 +134,7 @@ type ModifyDBClusterInput struct { PreferredMaintenanceWindow *string // Contains the scaling configuration of a Neptune Serverless DB cluster. For more - // information, see Using Amazon Neptune Serverless - // (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) + // information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration diff --git a/service/neptune/api_op_ModifyDBClusterEndpoint.go b/service/neptune/api_op_ModifyDBClusterEndpoint.go index efe826c88a7..47c6195c447 100644 --- a/service/neptune/api_op_ModifyDBClusterEndpoint.go +++ b/service/neptune/api_op_ModifyDBClusterEndpoint.go @@ -34,7 +34,7 @@ type ModifyDBClusterEndpointInput struct { // This member is required. DBClusterEndpointIdentifier *string - // The type of the endpoint. One of: READER, WRITER, ANY. + // The type of the endpoint. One of: READER , WRITER , ANY . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -51,21 +51,16 @@ type ModifyDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Neptune DB cluster. This data type is used as a response element in the // following actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type ModifyDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -86,7 +81,7 @@ type ModifyDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -97,8 +92,8 @@ type ModifyDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that cannot be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that cannot be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/neptune/api_op_ModifyDBClusterParameterGroup.go b/service/neptune/api_op_ModifyDBClusterParameterGroup.go index 7c3360ce3fe..6df3c5c3723 100644 --- a/service/neptune/api_op_ModifyDBClusterParameterGroup.go +++ b/service/neptune/api_op_ModifyDBClusterParameterGroup.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group. To modify more than one -// parameter, submit a list of the following: ParameterName, ParameterValue, and -// ApplyMethod. A maximum of 20 parameters can be modified in a single request. -// Changes to dynamic parameters are applied immediately. Changes to static -// parameters require a reboot without failover to the DB cluster associated with -// the parameter group before the change can take effect. After you create a DB -// cluster parameter group, you should wait at least 5 minutes before creating your -// first DB cluster that uses that DB cluster parameter group as the default +// Modifies the parameters of a DB cluster parameter group. To modify more than +// one parameter, submit a list of the following: ParameterName , ParameterValue , +// and ApplyMethod . A maximum of 20 parameters can be modified in a single +// request. Changes to dynamic parameters are applied immediately. Changes to +// static parameters require a reboot without failover to the DB cluster associated +// with the parameter group before the change can take effect. After you create a +// DB cluster parameter group, you should wait at least 5 minutes before creating +// your first DB cluster that uses that DB cluster parameter group as the default // parameter group. This allows Amazon Neptune to fully complete the create action // before the parameter group is used as the default for a new DB cluster. This is // especially important for parameters that are critical when creating the default @@ -60,17 +60,10 @@ type ModifyDBClusterParameterGroupInput struct { type ModifyDBClusterParameterGroupOutput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be 1 to 255 - // letters or numbers. - // - // * First character must be a letter - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go index 00e344edb2b..4c5b04e9fbc 100644 --- a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go @@ -21,8 +21,8 @@ import ( // that contain private information that you don't want available to all Amazon // accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but // only by specifying a list of authorized Amazon account IDs for the ValuesToAdd -// parameter. You can't use all as a value for that parameter in this case. To view -// which Amazon accounts have access to copy or restore a manual DB cluster +// parameter. You can't use all as a value for that parameter in this case. To +// view which Amazon accounts have access to copy or restore a manual DB cluster // snapshot, or whether a manual DB cluster snapshot public or private, use the // DescribeDBClusterSnapshotAttributes API action. func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBClusterSnapshotAttributeOutput, error) { @@ -42,9 +42,9 @@ func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *M type ModifyDBClusterSnapshotAttributeInput struct { - // The name of the DB cluster snapshot attribute to modify. To manage authorization - // for other Amazon accounts to copy or restore a manual DB cluster snapshot, set - // this value to restore. + // The name of the DB cluster snapshot attribute to modify. To manage + // authorization for other Amazon accounts to copy or restore a manual DB cluster + // snapshot, set this value to restore . // // This member is required. AttributeName *string @@ -55,20 +55,20 @@ type ModifyDBClusterSnapshotAttributeInput struct { DBClusterSnapshotIdentifier *string // A list of DB cluster snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other Amazon accounts to copy or restore a manual DB - // cluster snapshot, set this list to include one or more Amazon account IDs, or + // AttributeName . To authorize other Amazon accounts to copy or restore a manual + // DB cluster snapshot, set this list to include one or more Amazon account IDs, or // all to make the manual DB cluster snapshot restorable by any Amazon account. Do // not add the all value for any manual DB cluster snapshots that contain private // information that you don't want available to all Amazon accounts. ValuesToAdd []string // A list of DB cluster snapshot attributes to remove from the attribute specified - // by AttributeName. To remove authorization for other Amazon accounts to copy or + // by AttributeName . To remove authorization for other Amazon accounts to copy or // restore a manual DB cluster snapshot, set this list to include one or more // Amazon account identifiers, or all to remove authorization for any Amazon - // account to copy or restore the DB cluster snapshot. If you specify all, an - // Amazon account whose account ID is explicitly added to the restore attribute can - // still copy or restore a manual DB cluster snapshot. + // account to copy or restore the DB cluster snapshot. If you specify all , an + // Amazon account whose account ID is explicitly added to the restore attribute + // can still copy or restore a manual DB cluster snapshot. ValuesToRemove []string noSmithyDocumentSerde diff --git a/service/neptune/api_op_ModifyDBInstance.go b/service/neptune/api_op_ModifyDBInstance.go index fc463e3d3fb..f751b25d20e 100644 --- a/service/neptune/api_op_ModifyDBInstance.go +++ b/service/neptune/api_op_ModifyDBInstance.go @@ -14,7 +14,7 @@ import ( // Modifies settings for a DB instance. You can change one or more database // configuration parameters by specifying these parameters and the new values in // the request. To learn what modifications you can make to your DB instance, call -// DescribeValidDBInstanceModifications before you call ModifyDBInstance. +// DescribeValidDBInstanceModifications before you call ModifyDBInstance . func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error) { if params == nil { params = &ModifyDBInstanceInput{} @@ -34,8 +34,7 @@ type ModifyDBInstanceInput struct { // The DB instance identifier. This value is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string @@ -51,9 +50,9 @@ type ModifyDBInstanceInput struct { // Specifies whether the modifications in this request and any pending // modifications are asynchronously applied as soon as possible, regardless of the // PreferredMaintenanceWindow setting for the DB instance. If this parameter is set - // to false, changes to the DB instance are applied during the next maintenance + // to false , changes to the DB instance are applied during the next maintenance // window. Some parameter changes can cause an outage and are applied on the next - // call to RebootDBInstance, or the next failure reboot. Default: false + // call to RebootDBInstance , or the next failure reboot. Default: false ApplyImmediately bool // Indicates that minor version upgrades are applied automatically to the DB @@ -65,7 +64,7 @@ type ModifyDBInstanceInput struct { AutoMinorVersionUpgrade *bool // Not applicable. The retention period for automated backups is managed by the DB - // cluster. For more information, see ModifyDBCluster. Default: Uses existing + // cluster. For more information, see ModifyDBCluster . Default: Uses existing // setting BackupRetentionPeriod *int32 @@ -80,11 +79,11 @@ type ModifyDBInstanceInput struct { // otherwise false. The default is false. CopyTagsToSnapshot *bool - // The new compute and memory capacity of the DB instance, for example, - // db.m4.large. Not all DB instance classes are available in all Amazon Regions. If - // you modify the DB instance class, an outage occurs during the change. The change - // is applied during the next maintenance window, unless ApplyImmediately is - // specified as true for this request. Default: Uses existing setting + // The new compute and memory capacity of the DB instance, for example, db.m4.large + // . Not all DB instance classes are available in all Amazon Regions. If you modify + // the DB instance class, an outage occurs during the change. The change is applied + // during the next maintenance window, unless ApplyImmediately is specified as true + // for this request. Default: Uses existing setting DBInstanceClass *string // The name of the DB parameter group to apply to the DB instance. Changing this @@ -106,9 +105,7 @@ type ModifyDBInstanceInput struct { // A list of DB security groups to authorize on this DB instance. Changing this // setting doesn't result in an outage and the change is asynchronously applied as // soon as possible. Constraints: - // - // * If supplied, must match existing - // DBSecurityGroups. + // - If supplied, must match existing DBSecurityGroups. DBSecurityGroups []string // The new DB subnet group for the DB instance. You can use this parameter to move @@ -121,8 +118,8 @@ type ModifyDBInstanceInput struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection is disabled. See Deleting a DB Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). + // deletion protection is disabled. See Deleting a DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html) + // . DeletionProtection *bool // Not supported. @@ -135,14 +132,14 @@ type ModifyDBInstanceInput struct { // to database accounts, and otherwise false. You can enable IAM database // authentication for the following database engines Not applicable. Mapping Amazon // IAM accounts to database accounts is managed by the DB cluster. For more - // information, see ModifyDBCluster. Default: false + // information, see ModifyDBCluster . Default: false EnableIAMDatabaseAuthentication *bool // (Not supported by Neptune) EnablePerformanceInsights *bool - // The version number of the database engine to upgrade to. Currently, setting this - // parameter has no effect. To upgrade your database engine to the most recent + // The version number of the database engine to upgrade to. Currently, setting + // this parameter has no effect. To upgrade your database engine to the most recent // release, use the ApplyPendingMaintenanceAction API. EngineVersion *string @@ -167,14 +164,14 @@ type ModifyDBInstanceInput struct { // The ARN for the IAM role that permits Neptune to send enhanced monitoring // metrics to Amazon CloudWatch Logs. For example, - // arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value - // other than 0, then you must supply a MonitoringRoleArn value. + // arn:aws:iam:123456789012:role/emaccess . If MonitoringInterval is set to a + // value other than 0, then you must supply a MonitoringRoleArn value. MonitoringRoleArn *string // Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter // doesn't result in an outage and the change is applied during the next - // maintenance window unless the ApplyImmediately parameter is set to true for this - // request. + // maintenance window unless the ApplyImmediately parameter is set to true for + // this request. MultiAZ *bool // The new DB instance identifier for the DB instance when renaming a DB instance. @@ -182,15 +179,9 @@ type ModifyDBInstanceInput struct { // immediately if you set Apply Immediately to true, or will occur during the next // maintenance window if Apply Immediately to false. This value is stored as a // lowercase string. Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or - // hyphens. - // - // * The first character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance NewDBInstanceIdentifier *string @@ -202,18 +193,12 @@ type ModifyDBInstanceInput struct { // The daily time range during which automated backups are created if automated // backups are enabled. Not applicable. The daily time range for creating automated - // backups is managed by the DB cluster. For more information, see ModifyDBCluster. - // Constraints: - // - // * Must be in the format hh24:mi-hh24:mi - // - // * Must be in Universal - // Time Coordinated (UTC) - // - // * Must not conflict with the preferred maintenance - // window - // - // * Must be at least 30 minutes + // backups is managed by the DB cluster. For more information, see ModifyDBCluster + // . Constraints: + // - Must be in the format hh24:mi-hh24:mi + // - Must be in Universal Time Coordinated (UTC) + // - Must not conflict with the preferred maintenance window + // - Must be at least 30 minutes PreferredBackupWindow *string // The weekly time range (in UTC) during which system maintenance can occur, which @@ -251,10 +236,8 @@ type ModifyDBInstanceInput struct { // A list of EC2 VPC security groups to authorize on this DB instance. This change // is asynchronously applied as soon as possible. Not applicable. The associated // list of EC2 VPC security groups is managed by the DB cluster. For more - // information, see ModifyDBCluster. Constraints: - // - // * If supplied, must match - // existing VpcSecurityGroupIds. + // information, see ModifyDBCluster . Constraints: + // - If supplied, must match existing VpcSecurityGroupIds. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -262,8 +245,8 @@ type ModifyDBInstanceInput struct { type ModifyDBInstanceOutput struct { - // Contains the details of an Amazon Neptune DB instance. This data type is used as - // a response element in the DescribeDBInstances action. + // Contains the details of an Amazon Neptune DB instance. This data type is used + // as a response element in the DescribeDBInstances action. DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ModifyDBParameterGroup.go b/service/neptune/api_op_ModifyDBParameterGroup.go index c443b4d4ed2..2b8acb0aa54 100644 --- a/service/neptune/api_op_ModifyDBParameterGroup.go +++ b/service/neptune/api_op_ModifyDBParameterGroup.go @@ -12,8 +12,8 @@ import ( ) // Modifies the parameters of a DB parameter group. To modify more than one -// parameter, submit a list of the following: ParameterName, ParameterValue, and -// ApplyMethod. A maximum of 20 parameters can be modified in a single request. +// parameter, submit a list of the following: ParameterName , ParameterValue , and +// ApplyMethod . A maximum of 20 parameters can be modified in a single request. // Changes to dynamic parameters are applied immediately. Changes to static // parameters require a reboot without failover to the DB instance associated with // the parameter group before the change can take effect. After you modify a DB @@ -23,8 +23,8 @@ import ( // parameter group is used as the default for a new DB instance. This is especially // important for parameters that are critical when creating the default database // for a DB instance, such as the character set for the default database defined by -// the character_set_database parameter. You can use the Parameter Groups option of -// the Amazon Neptune console or the DescribeDBParameters command to verify that +// the character_set_database parameter. You can use the Parameter Groups option +// of the Amazon Neptune console or the DescribeDBParameters command to verify that // your DB parameter group has been created or modified. func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBParameterGroupInput, optFns ...func(*Options)) (*ModifyDBParameterGroupOutput, error) { if params == nil { @@ -44,9 +44,7 @@ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBPar type ModifyDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * If supplied, must match the - // name of an existing DBParameterGroup. + // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. DBParameterGroupName *string diff --git a/service/neptune/api_op_ModifyDBSubnetGroup.go b/service/neptune/api_op_ModifyDBSubnetGroup.go index db57e158ca5..38b5b9b4aa4 100644 --- a/service/neptune/api_op_ModifyDBSubnetGroup.go +++ b/service/neptune/api_op_ModifyDBSubnetGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an existing DB subnet group. DB subnet groups must contain at least one -// subnet in at least two AZs in the Amazon Region. +// Modifies an existing DB subnet group. DB subnet groups must contain at least +// one subnet in at least two AZs in the Amazon Region. func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnetGroupInput, optFns ...func(*Options)) (*ModifyDBSubnetGroupOutput, error) { if params == nil { params = &ModifyDBSubnetGroupInput{} diff --git a/service/neptune/api_op_ModifyEventSubscription.go b/service/neptune/api_op_ModifyEventSubscription.go index b32baa1a50f..1595430945d 100644 --- a/service/neptune/api_op_ModifyEventSubscription.go +++ b/service/neptune/api_op_ModifyEventSubscription.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an existing event notification subscription. Note that you can't modify -// the source identifiers using this call; to change source identifiers for a -// subscription, use the AddSourceIdentifierToSubscription and +// Modifies an existing event notification subscription. Note that you can't +// modify the source identifiers using this call; to change source identifiers for +// a subscription, use the AddSourceIdentifierToSubscription and // RemoveSourceIdentifierFromSubscription calls. You can see a list of the event // categories for a given SourceType by using the DescribeEventCategories action. func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEventSubscriptionInput, optFns ...func(*Options)) (*ModifyEventSubscriptionOutput, error) { @@ -50,9 +50,9 @@ type ModifyEventSubscriptionInput struct { // The ARN is created by Amazon SNS when you create a topic and subscribe to it. SnsTopicArn *string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by a DB instance, you would set this parameter to - // db-instance. if this value is not specified, all events are returned. Valid + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by a DB instance, you would set this parameter + // to db-instance. if this value is not specified, all events are returned. Valid // values: db-instance | db-parameter-group | db-security-group | db-snapshot SourceType *string diff --git a/service/neptune/api_op_ModifyGlobalCluster.go b/service/neptune/api_op_ModifyGlobalCluster.go index 50e163cafa2..15b9a9f7715 100644 --- a/service/neptune/api_op_ModifyGlobalCluster.go +++ b/service/neptune/api_op_ModifyGlobalCluster.go @@ -51,23 +51,17 @@ type ModifyGlobalClusterInput struct { // global database cannot be deleted when deletion protection is enabled. DeletionProtection *bool - // The version number of the database engine to which you want to upgrade. Changing - // this parameter will result in an outage. The change is applied during the next - // maintenance window unless ApplyImmediately is enabled. To list all of the - // available Neptune engine versions, use the following command: + // The version number of the database engine to which you want to upgrade. + // Changing this parameter will result in an outage. The change is applied during + // the next maintenance window unless ApplyImmediately is enabled. To list all of + // the available Neptune engine versions, use the following command: EngineVersion *string // A new cluster identifier to assign to the global database. This value is stored // as a lowercase string. Constraints: - // - // * Must contain from 1 to 63 letters, - // numbers, or hyphens. - // - // * The first character must be a letter. - // - // * Can't end with - // a hyphen or contain two consecutive hyphens - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-cluster2 NewGlobalClusterIdentifier *string @@ -77,8 +71,8 @@ type ModifyGlobalClusterInput struct { type ModifyGlobalClusterOutput struct { // Contains the details of an Amazon Neptune global database. This data type is - // used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, - // ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and + // used as a response element for the CreateGlobalCluster , DescribeGlobalClusters + // , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster diff --git a/service/neptune/api_op_RebootDBInstance.go b/service/neptune/api_op_RebootDBInstance.go index a397d41ffaa..55794eb29f7 100644 --- a/service/neptune/api_op_RebootDBInstance.go +++ b/service/neptune/api_op_RebootDBInstance.go @@ -36,13 +36,12 @@ type RebootDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string - // When true, the reboot is conducted through a MultiAZ failover. Constraint: You + // When true , the reboot is conducted through a MultiAZ failover. Constraint: You // can't specify true if the instance is not configured for MultiAZ. ForceFailover *bool @@ -51,8 +50,8 @@ type RebootDBInstanceInput struct { type RebootDBInstanceOutput struct { - // Contains the details of an Amazon Neptune DB instance. This data type is used as - // a response element in the DescribeDBInstances action. + // Contains the details of an Amazon Neptune DB instance. This data type is used + // as a response element in the DescribeDBInstances action. DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_RemoveFromGlobalCluster.go b/service/neptune/api_op_RemoveFromGlobalCluster.go index 6dd83f8b40d..7bf7a0451df 100644 --- a/service/neptune/api_op_RemoveFromGlobalCluster.go +++ b/service/neptune/api_op_RemoveFromGlobalCluster.go @@ -37,8 +37,8 @@ type RemoveFromGlobalClusterInput struct { // This member is required. DbClusterIdentifier *string - // The identifier of the Neptune global database from which to detach the specified - // Neptune DB cluster. + // The identifier of the Neptune global database from which to detach the + // specified Neptune DB cluster. // // This member is required. GlobalClusterIdentifier *string @@ -49,8 +49,8 @@ type RemoveFromGlobalClusterInput struct { type RemoveFromGlobalClusterOutput struct { // Contains the details of an Amazon Neptune global database. This data type is - // used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, - // ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and + // used as a response element for the CreateGlobalCluster , DescribeGlobalClusters + // , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster diff --git a/service/neptune/api_op_RemoveRoleFromDBCluster.go b/service/neptune/api_op_RemoveRoleFromDBCluster.go index 4c8c1013d78..86b0236b363 100644 --- a/service/neptune/api_op_RemoveRoleFromDBCluster.go +++ b/service/neptune/api_op_RemoveRoleFromDBCluster.go @@ -34,15 +34,15 @@ type RemoveRoleFromDBClusterInput struct { DBClusterIdentifier *string // The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB - // cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole. + // cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole . // // This member is required. RoleArn *string // The name of the feature for the DB cluster that the IAM role is to be // disassociated from. For the list of supported feature names, see - // DescribeDBEngineVersions - // (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions). + // DescribeDBEngineVersions (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions) + // . FeatureName *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_RemoveTagsFromResource.go b/service/neptune/api_op_RemoveTagsFromResource.go index d2609815399..0a681fcbef0 100644 --- a/service/neptune/api_op_RemoveTagsFromResource.go +++ b/service/neptune/api_op_RemoveTagsFromResource.go @@ -30,8 +30,8 @@ type RemoveTagsFromResourceInput struct { // The Amazon Neptune resource that the tags are removed from. This value is an // Amazon Resource Name (ARN). For information about creating an ARN, see - // Constructing an Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + // Constructing an Amazon Resource Name (ARN) (https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing) + // . // // This member is required. ResourceName *string diff --git a/service/neptune/api_op_ResetDBClusterParameterGroup.go b/service/neptune/api_op_ResetDBClusterParameterGroup.go index ca9e4b86fb3..588cf385fdd 100644 --- a/service/neptune/api_op_ResetDBClusterParameterGroup.go +++ b/service/neptune/api_op_ResetDBClusterParameterGroup.go @@ -11,15 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group to the default value. To -// reset specific parameters submit a list of the following: ParameterName and -// ApplyMethod. To reset the entire DB cluster parameter group, specify the +// Modifies the parameters of a DB cluster parameter group to the default value. +// To reset specific parameters submit a list of the following: ParameterName and +// ApplyMethod . To reset the entire DB cluster parameter group, specify the // DBClusterParameterGroupName and ResetAllParameters parameters. When resetting // the entire group, dynamic parameters are updated immediately and static // parameters are set to pending-reboot to take effect on the next DB instance -// restart or RebootDBInstance request. You must call RebootDBInstance for every DB -// instance in your DB cluster that you want the updated static parameter to apply -// to. +// restart or RebootDBInstance request. You must call RebootDBInstance for every +// DB instance in your DB cluster that you want the updated static parameter to +// apply to. func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, optFns ...func(*Options)) (*ResetDBClusterParameterGroupOutput, error) { if params == nil { params = &ResetDBClusterParameterGroupInput{} @@ -43,13 +43,14 @@ type ResetDBClusterParameterGroupInput struct { DBClusterParameterGroupName *string // A list of parameter names in the DB cluster parameter group to reset to the - // default values. You can't use this parameter if the ResetAllParameters parameter - // is set to true. + // default values. You can't use this parameter if the ResetAllParameters + // parameter is set to true . Parameters []types.Parameter // A value that is set to true to reset all parameters in the DB cluster parameter - // group to their default values, and false otherwise. You can't use this parameter - // if there is a list of parameter names specified for the Parameters parameter. + // group to their default values, and false otherwise. You can't use this + // parameter if there is a list of parameter names specified for the Parameters + // parameter. ResetAllParameters bool noSmithyDocumentSerde @@ -58,17 +59,10 @@ type ResetDBClusterParameterGroupInput struct { type ResetDBClusterParameterGroupOutput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be 1 to 255 - // letters or numbers. - // - // * First character must be a letter - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ResetDBParameterGroup.go b/service/neptune/api_op_ResetDBParameterGroup.go index 7e7cdfaf464..823e0daf051 100644 --- a/service/neptune/api_op_ResetDBParameterGroup.go +++ b/service/neptune/api_op_ResetDBParameterGroup.go @@ -13,7 +13,7 @@ import ( // Modifies the parameters of a DB parameter group to the engine/system default // value. To reset specific parameters, provide a list of the following: -// ParameterName and ApplyMethod. To reset the entire DB parameter group, specify +// ParameterName and ApplyMethod . To reset the entire DB parameter group, specify // the DBParameterGroup name and ResetAllParameters parameters. When resetting the // entire group, dynamic parameters are updated immediately and static parameters // are set to pending-reboot to take effect on the next DB instance restart or @@ -36,20 +36,18 @@ func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParam type ResetDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * Must match the name of an - // existing DBParameterGroup. + // - Must match the name of an existing DBParameterGroup. // // This member is required. DBParameterGroupName *string // To reset the entire DB parameter group, specify the DBParameterGroup name and // ResetAllParameters parameters. To reset specific parameters, provide a list of - // the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be + // the following: ParameterName and ApplyMethod . A maximum of 20 parameters can be // modified in a single request. Valid Values (for Apply method): pending-reboot Parameters []types.Parameter - // Specifies whether (true) or not (false) to reset all parameters in the DB + // Specifies whether ( true ) or not ( false ) to reset all parameters in the DB // parameter group to default values. Default: true ResetAllParameters bool diff --git a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go index 4eb3042011e..713476504f1 100644 --- a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go @@ -37,17 +37,10 @@ type RestoreDBClusterFromSnapshotInput struct { // The name of the DB cluster to create from the DB snapshot or DB cluster // snapshot. This parameter isn't case-sensitive. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens - // - // Example: - // my-snapshot-id + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens + // Example: my-snapshot-id // // This member is required. DBClusterIdentifier *string @@ -62,8 +55,7 @@ type RestoreDBClusterFromSnapshotInput struct { // can use either the name or the Amazon Resource Name (ARN) to specify a DB // cluster snapshot. However, you can use only the ARN to specify a DB snapshot. // Constraints: - // - // * Must match the identifier of an existing Snapshot. + // - Must match the identifier of an existing Snapshot. // // This member is required. SnapshotIdentifier *string @@ -72,15 +64,13 @@ type RestoreDBClusterFromSnapshotInput struct { // cluster can be created in. AvailabilityZones []string - // If set to true, tags are copied to any snapshot of the restored DB cluster that + // If set to true , tags are copied to any snapshot of the restored DB cluster that // is created. CopyTagsToSnapshot *bool - // The name of the DB cluster parameter group to associate with the new DB cluster. - // Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // The name of the DB cluster parameter group to associate with the new DB + // cluster. Constraints: + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string // The name of the DB subnet group to use for the new DB cluster. Constraints: If @@ -107,22 +97,18 @@ type RestoreDBClusterFromSnapshotInput struct { // The version of the database engine to use for the new DB cluster. EngineVersion *string - // The Amazon KMS key identifier to use when restoring an encrypted DB cluster from - // a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon + // The Amazon KMS key identifier to use when restoring an encrypted DB cluster + // from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon // Resource Name (ARN) for the KMS encryption key. If you are restoring a DB // cluster with the same Amazon account that owns the KMS encryption key used to // encrypt the new DB cluster, then you can use the KMS key alias instead of the // ARN for the KMS encryption key. If you do not specify a value for the KmsKeyId // parameter, then the following will occur: - // - // * If the DB snapshot or DB cluster - // snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is - // encrypted using the KMS key that was used to encrypt the DB snapshot or DB - // cluster snapshot. - // - // * If the DB snapshot or DB cluster snapshot in - // SnapshotIdentifier is not encrypted, then the restored DB cluster is not - // encrypted. + // - If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is + // encrypted, then the restored DB cluster is encrypted using the KMS key that was + // used to encrypt the DB snapshot or DB cluster snapshot. + // - If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not + // encrypted, then the restored DB cluster is not encrypted. KmsKeyId *string // (Not supported by Neptune) @@ -133,8 +119,7 @@ type RestoreDBClusterFromSnapshotInput struct { Port *int32 // Contains the scaling configuration of a Neptune Serverless DB cluster. For more - // information, see Using Amazon Neptune Serverless - // (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) + // information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration diff --git a/service/neptune/api_op_RestoreDBClusterToPointInTime.go b/service/neptune/api_op_RestoreDBClusterToPointInTime.go index 5d8bb37ee98..4f2e89680a2 100644 --- a/service/neptune/api_op_RestoreDBClusterToPointInTime.go +++ b/service/neptune/api_op_RestoreDBClusterToPointInTime.go @@ -19,9 +19,9 @@ import ( // created with the default DB security group. This action only restores the DB // cluster, not the DB instances for that DB cluster. You must invoke the // CreateDBInstance action to create DB instances for the restored DB cluster, -// specifying the identifier of the restored DB cluster in DBClusterIdentifier. You -// can create DB instances only after the RestoreDBClusterToPointInTime action has -// completed and the DB cluster is available. +// specifying the identifier of the restored DB cluster in DBClusterIdentifier . +// You can create DB instances only after the RestoreDBClusterToPointInTime action +// has completed and the DB cluster is available. func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error) { if params == nil { params = &RestoreDBClusterToPointInTimeInput{} @@ -40,31 +40,22 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest type RestoreDBClusterToPointInTimeInput struct { // The name of the new DB cluster to be created. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens // // This member is required. DBClusterIdentifier *string // The identifier of the source DB cluster from which to restore. Constraints: - // - // * - // Must match the identifier of an existing DBCluster. + // - Must match the identifier of an existing DBCluster. // // This member is required. SourceDBClusterIdentifier *string - // The name of the DB cluster parameter group to associate with the new DB cluster. - // Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // The name of the DB cluster parameter group to associate with the new DB + // cluster. Constraints: + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string // The DB subnet group name to use for the new DB cluster. Constraints: If @@ -84,8 +75,8 @@ type RestoreDBClusterToPointInTimeInput struct { // to database accounts, and otherwise false. Default: false EnableIAMDatabaseAuthentication *bool - // The Amazon KMS key identifier to use when restoring an encrypted DB cluster from - // an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name + // The Amazon KMS key identifier to use when restoring an encrypted DB cluster + // from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name // (ARN) for the KMS encryption key. If you are restoring a DB cluster with the // same Amazon account that owns the KMS encryption key used to encrypt the new DB // cluster, then you can use the KMS key alias instead of the ARN for the KMS @@ -94,16 +85,12 @@ type RestoreDBClusterToPointInTimeInput struct { // source DB cluster. The new DB cluster is encrypted with the KMS key identified // by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId // parameter, then the following will occur: - // - // * If the DB cluster is encrypted, - // then the restored DB cluster is encrypted using the KMS key that was used to - // encrypt the source DB cluster. - // - // * If the DB cluster is not encrypted, then the - // restored DB cluster is not encrypted. - // - // If DBClusterIdentifier refers to a DB - // cluster that is not encrypted, then the restore request is rejected. + // - If the DB cluster is encrypted, then the restored DB cluster is encrypted + // using the KMS key that was used to encrypt the source DB cluster. + // - If the DB cluster is not encrypted, then the restored DB cluster is not + // encrypted. + // If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the + // restore request is rejected. KmsKeyId *string // (Not supported by Neptune) @@ -115,38 +102,25 @@ type RestoreDBClusterToPointInTimeInput struct { // The date and time to restore the DB cluster to. Valid Values: Value must be a // time in Universal Coordinated Time (UTC) format Constraints: - // - // * Must be before - // the latest restorable time for the DB instance - // - // * Must be specified if - // UseLatestRestorableTime parameter is not provided - // - // * Cannot be specified if - // UseLatestRestorableTime parameter is true - // - // * Cannot be specified if RestoreType - // parameter is copy-on-write - // + // - Must be before the latest restorable time for the DB instance + // - Must be specified if UseLatestRestorableTime parameter is not provided + // - Cannot be specified if UseLatestRestorableTime parameter is true + // - Cannot be specified if RestoreType parameter is copy-on-write // Example: 2015-03-07T23:45:00Z RestoreToTime *time.Time // The type of restore to be performed. You can specify one of the following // values: - // - // * full-copy - The new DB cluster is restored as a full copy of the - // source DB cluster. - // - // * copy-on-write - The new DB cluster is restored as a clone - // of the source DB cluster. - // - // If you don't specify a RestoreType value, then the - // new DB cluster is restored as a full copy of the source DB cluster. + // - full-copy - The new DB cluster is restored as a full copy of the source DB + // cluster. + // - copy-on-write - The new DB cluster is restored as a clone of the source DB + // cluster. + // If you don't specify a RestoreType value, then the new DB cluster is restored + // as a full copy of the source DB cluster. RestoreType *string // Contains the scaling configuration of a Neptune Serverless DB cluster. For more - // information, see Using Amazon Neptune Serverless - // (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) + // information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration diff --git a/service/neptune/types/errors.go b/service/neptune/types/errors.go index d8991906caf..17c147c5109 100644 --- a/service/neptune/types/errors.go +++ b/service/neptune/types/errors.go @@ -251,8 +251,8 @@ func (e *DBClusterQuotaExceededFault) ErrorCode() string { } func (e *DBClusterQuotaExceededFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified IAM role Amazon Resource Name (ARN) is already associated with the -// specified DB cluster. +// The specified IAM role Amazon Resource Name (ARN) is already associated with +// the specified DB cluster. type DBClusterRoleAlreadyExistsFault struct { Message *string @@ -1329,8 +1329,8 @@ func (e *InvalidRestoreFault) ErrorCode() string { } func (e *InvalidRestoreFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested subnet is invalid, or multiple subnets were requested that are not -// all in a common VPC. +// The requested subnet is invalid, or multiple subnets were requested that are +// not all in a common VPC. type InvalidSubnet struct { Message *string diff --git a/service/neptune/types/types.go b/service/neptune/types/types.go index 2e32f1d03c6..1ace0c54883 100644 --- a/service/neptune/types/types.go +++ b/service/neptune/types/types.go @@ -29,9 +29,9 @@ type CharacterSet struct { } // The configuration setting for the log types to be enabled for export to -// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and -// DisableLogTypes arrays determine which logs will be exported (or not exported) -// to CloudWatch Logs. +// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes +// and DisableLogTypes arrays determine which logs will be exported (or not +// exported) to CloudWatch Logs. type CloudwatchLogsExportConfiguration struct { // The list of log types to disable. @@ -47,9 +47,9 @@ type CloudwatchLogsExportConfiguration struct { // and contains changes that will be applied during the next maintenance window. type ClusterPendingModifiedValues struct { - // The allocated storage size in gibibytes (GiB) for database engines. For Neptune, - // AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't - // fixed, but instead automatically adjusts as needed. + // The allocated storage size in gibibytes (GiB) for database engines. For + // Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage + // size isn't fixed, but instead automatically adjusts as needed. AllocatedStorage *int32 // The number of days for which automatic DB snapshots are retained. @@ -65,8 +65,8 @@ type ClusterPendingModifiedValues struct { // Access Management (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool - // The Provisioned IOPS (I/O operations per second) value. This setting is only for - // non-Aurora Multi-AZ DB clusters. + // The Provisioned IOPS (I/O operations per second) value. This setting is only + // for non-Aurora Multi-AZ DB clusters. Iops *int32 // This PendingCloudwatchLogsExports structure specifies pending changes to which @@ -93,8 +93,8 @@ type DBCluster struct { // Time at which the DB cluster will be automatically restarted. AutomaticRestartTime *time.Time - // Provides the list of EC2 Availability Zones that instances in the DB cluster can - // be created in. + // Provides the list of EC2 Availability Zones that instances in the DB cluster + // can be created in. AvailabilityZones []string // Specifies the number of days for which automatic DB snapshots are retained. @@ -110,11 +110,11 @@ type DBCluster struct { // Time (UTC). ClusterCreateTime *time.Time - // If set to true, tags are copied to any snapshot of the DB cluster that is + // If set to true , tags are copied to any snapshot of the DB cluster that is // created. CopyTagsToSnapshot *bool - // If set to true, the DB cluster can be cloned across accounts. + // If set to true , the DB cluster can be cloned across accounts. CrossAccountClone *bool // The Amazon Resource Name (ARN) for the DB cluster. @@ -183,8 +183,8 @@ type DBCluster struct { // cluster. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // Not supported by Neptune. @@ -204,7 +204,7 @@ type DBCluster struct { Port *int32 // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in @@ -230,8 +230,7 @@ type DBCluster struct { ReplicationSourceIdentifier *string // Shows the scaling configuration for a Neptune Serverless DB cluster. For more - // information, see Using Amazon Neptune Serverless - // (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) + // information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo @@ -250,21 +249,16 @@ type DBCluster struct { // This data type represents the information you need to connect to an Amazon // Neptune DB cluster. This data type is used as a response element in the // following actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon Neptune DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon Neptune DB instance endpoints, +// see Endpoint . type DBClusterEndpoint struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -285,7 +279,7 @@ type DBClusterEndpoint struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -296,8 +290,8 @@ type DBClusterEndpoint struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that cannot be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that cannot be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string @@ -308,8 +302,8 @@ type DBClusterEndpoint struct { // Contains information about an instance that is part of a DB cluster. type DBClusterMember struct { - // Specifies the status of the DB cluster parameter group for this member of the DB - // cluster. + // Specifies the status of the DB cluster parameter group for this member of the + // DB cluster. DBClusterParameterGroupStatus *string // Specifies the instance identifier for this member of the DB cluster. @@ -359,14 +353,14 @@ type DBClusterParameterGroup struct { noSmithyDocumentSerde } -// Describes an Amazon Identity and Access Management (IAM) role that is associated -// with a DB cluster. +// Describes an Amazon Identity and Access Management (IAM) role that is +// associated with a DB cluster. type DBClusterRole struct { // The name of the feature associated with the Amazon Identity and Access // Management (IAM) role. For the list of supported feature names, see - // DescribeDBEngineVersions - // (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions). + // DescribeDBEngineVersions (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions) + // . FeatureName *string // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB @@ -375,24 +369,19 @@ type DBClusterRole struct { // Describes the state of association between the IAM role and the DB cluster. The // Status property returns one of the following values: - // - // * ACTIVE - the IAM role - // ARN is associated with the DB cluster and can be used to access other Amazon - // services on your behalf. - // - // * PENDING - the IAM role ARN is being associated with - // the DB cluster. - // - // * INVALID - the IAM role ARN is associated with the DB cluster, - // but the DB cluster is unable to assume the IAM role in order to access other - // Amazon services on your behalf. + // - ACTIVE - the IAM role ARN is associated with the DB cluster and can be used + // to access other Amazon services on your behalf. + // - PENDING - the IAM role ARN is being associated with the DB cluster. + // - INVALID - the IAM role ARN is associated with the DB cluster, but the DB + // cluster is unable to assume the IAM role in order to access other Amazon + // services on your behalf. Status *string noSmithyDocumentSerde } -// Contains the details for an Amazon Neptune DB cluster snapshot This data type is -// used as a response element in the DescribeDBClusterSnapshots action. +// Contains the details for an Amazon Neptune DB cluster snapshot This data type +// is used as a response element in the DescribeDBClusterSnapshots action. type DBClusterSnapshot struct { // Specifies the allocated storage size in gibibytes (GiB). @@ -413,17 +402,17 @@ type DBClusterSnapshot struct { // The Amazon Resource Name (ARN) for the DB cluster snapshot. DBClusterSnapshotArn *string - // Specifies the identifier for a DB cluster snapshot. Must match the identifier of - // an existing snapshot. After you restore a DB cluster using a - // DBClusterSnapshotIdentifier, you must specify the same + // Specifies the identifier for a DB cluster snapshot. Must match the identifier + // of an existing snapshot. After you restore a DB cluster using a + // DBClusterSnapshotIdentifier , you must specify the same // DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you // specify this property for an update, the DB cluster is not restored from the // snapshot again, and the data in the database is not changed. However, if you - // don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, + // don't specify the DBClusterSnapshotIdentifier , an empty DB cluster is created, // and the original DB cluster is deleted. If you specify a property that is // different from the previous snapshot restore property, the DB cluster is - // restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the - // original DB cluster is deleted. + // restored from the snapshot specified by the DBClusterSnapshotIdentifier , and + // the original DB cluster is deleted. DBClusterSnapshotIdentifier *string // Specifies the name of the database engine. @@ -490,7 +479,7 @@ type DBClusterSnapshotAttribute struct { AttributeName *string // The value(s) for the manual DB cluster snapshot attribute. If the AttributeName - // field is set to restore, then this element returns a list of IDs of the Amazon + // field is set to restore , then this element returns a list of IDs of the Amazon // accounts that are authorized to copy or restore the manual DB cluster snapshot. // If a value of all is in the list, then the manual DB cluster snapshot is public // and available for any Amazon account to copy or restore. @@ -516,7 +505,7 @@ type DBClusterSnapshotAttributesResult struct { } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type DBEngineVersion struct { // The description of the database engine. @@ -565,8 +554,8 @@ type DBEngineVersion struct { noSmithyDocumentSerde } -// Contains the details of an Amazon Neptune DB instance. This data type is used as -// a response element in the DescribeDBInstances action. +// Contains the details of an Amazon Neptune DB instance. This data type is used +// as a response element in the DescribeDBInstances action. type DBInstance struct { // Not supported by Neptune. @@ -632,9 +621,9 @@ type DBInstance struct { DbiResourceId *string // Indicates whether or not the DB instance has deletion protection enabled. The - // instance can't be deleted when deletion protection is enabled. See Deleting a DB - // Instance - // (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). + // instance can't be deleted when deletion protection is enabled. See Deleting a + // DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html) + // . DeletionProtection *bool // Not supported @@ -670,8 +659,8 @@ type DBInstance struct { // Not supported: The encryption for DB instances is managed by the DB cluster. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // License model information for this DB instance. @@ -706,7 +695,7 @@ type DBInstance struct { PerformanceInsightsKMSKeyId *string // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in @@ -804,15 +793,10 @@ type DBParameterGroup struct { // The status of the DB parameter group. This data type is used as a response // element in the following actions: -// -// * CreateDBInstance -// -// * DeleteDBInstance -// -// * -// ModifyDBInstance -// -// * RebootDBInstance +// - CreateDBInstance +// - DeleteDBInstance +// - ModifyDBInstance +// - RebootDBInstance type DBParameterGroupStatus struct { // The name of the DP parameter group. @@ -894,7 +878,7 @@ type DoubleRange struct { } // Specifies a connection endpoint. For the data structure that represents Amazon -// Neptune DB cluster endpoints, see DBClusterEndpoint. +// Neptune DB cluster endpoints, see DBClusterEndpoint . type Endpoint struct { // Specifies the DNS address of the DB instance. @@ -1024,15 +1008,15 @@ type Filter struct { } // Contains the details of an Amazon Neptune global database. This data type is -// used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, -// ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and +// used as a response element for the CreateGlobalCluster , DescribeGlobalClusters +// , ModifyGlobalCluster , DeleteGlobalCluster , FailoverGlobalCluster , and // RemoveFromGlobalCluster actions. type GlobalCluster struct { // The deletion protection setting for the global database. DeletionProtection *bool - // The Neptune database engine used by the global database ("neptune"). + // The Neptune database engine used by the global database ( "neptune" ). Engine *string // The Neptune engine version used by the global database. @@ -1140,8 +1124,8 @@ type OrderableDBInstanceOption struct { // Indicates the storage type for a DB instance. StorageType *string - // Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 - // to 60 seconds. + // Indicates whether a DB instance supports Enhanced Monitoring at intervals from + // 1 to 60 seconds. SupportsEnhancedMonitoring bool // A value that indicates whether you can use Neptune global databases with a @@ -1184,7 +1168,7 @@ type Parameter struct { // Provides a description of the parameter. Description *string - // Indicates whether (true) or not (false) the parameter can be modified. Some + // Indicates whether ( true ) or not ( false ) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable bool @@ -1233,9 +1217,9 @@ type PendingMaintenanceAction struct { // The effective date when the pending maintenance action is applied to the // resource. This date takes into account opt-in requests received from the - // ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the - // ForcedApplyDate. This value is blank if an opt-in request has not been received - // and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. + // ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the + // ForcedApplyDate . This value is blank if an opt-in request has not been received + // and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate . CurrentApplyDate *time.Time // A description providing more detail about the maintenance action. @@ -1338,8 +1322,7 @@ type ResourcePendingMaintenanceActions struct { } // Contains the scaling configuration of a Neptune Serverless DB cluster. For more -// information, see Using Amazon Neptune Serverless -// (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) +// information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. type ServerlessV2ScalingConfiguration struct { @@ -1357,8 +1340,7 @@ type ServerlessV2ScalingConfiguration struct { } // Shows the scaling configuration for a Neptune Serverless DB cluster. For more -// information, see Using Amazon Neptune Serverless -// (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) +// information, see Using Amazon Neptune Serverless (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) // in the Amazon Neptune User Guide. type ServerlessV2ScalingConfigurationInfo struct { @@ -1395,21 +1377,21 @@ type Subnet struct { type Tag struct { // A key is the required name of the tag. The string value can be from 1 to 128 - // Unicode characters in length and can't be prefixed with aws: or rds:. The string - // can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', - // '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + // Unicode characters in length and can't be prefixed with aws: or rds: . The + // string can only contain the set of Unicode letters, digits, white-space, '_', + // '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Key *string // A value is the optional value of the tag. The string value can be from 1 to 256 - // Unicode characters in length and can't be prefixed with aws: or rds:. The string - // can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', - // '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). + // Unicode characters in length and can't be prefixed with aws: or rds: . The + // string can only contain the set of Unicode letters, digits, white-space, '_', + // '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). Value *string noSmithyDocumentSerde } -// A time zone associated with a DBInstance. +// A time zone associated with a DBInstance . type Timezone struct { // The name of the time zone. @@ -1447,7 +1429,7 @@ type UpgradeTarget struct { // Information about valid modifications that you can make to your DB instance. // Contains the result of a successful call to the // DescribeValidDBInstanceModifications action. You can use this information when -// you call ModifyDBInstance. +// you call ModifyDBInstance . type ValidDBInstanceModificationsMessage struct { // Valid storage options for your DB instance. diff --git a/service/networkfirewall/api_client.go b/service/networkfirewall/api_client.go index c4e3e4e8a6e..88d165d8099 100644 --- a/service/networkfirewall/api_client.go +++ b/service/networkfirewall/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/networkfirewall/api_op_AssociateFirewallPolicy.go b/service/networkfirewall/api_op_AssociateFirewallPolicy.go index 046c9bd0e81..c43ecbb3609 100644 --- a/service/networkfirewall/api_op_AssociateFirewallPolicy.go +++ b/service/networkfirewall/api_op_AssociateFirewallPolicy.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a FirewallPolicy to a Firewall. A firewall policy defines how to +// Associates a FirewallPolicy to a Firewall . A firewall policy defines how to // monitor and manage your VPC network traffic, using a collection of inspection // rule groups and other settings. Each firewall requires one firewall policy // association, and you can use the same firewall policy for multiple firewalls. @@ -54,7 +54,7 @@ type AssociateFirewallPolicyInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -83,7 +83,7 @@ type AssociateFirewallPolicyOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_AssociateSubnets.go b/service/networkfirewall/api_op_AssociateSubnets.go index 835677e6aba..9f3deda2876 100644 --- a/service/networkfirewall/api_op_AssociateSubnets.go +++ b/service/networkfirewall/api_op_AssociateSubnets.go @@ -57,7 +57,7 @@ type AssociateSubnetsInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -86,7 +86,7 @@ type AssociateSubnetsOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_CreateFirewall.go b/service/networkfirewall/api_op_CreateFirewall.go index 193f31afa02..29244c5e0b2 100644 --- a/service/networkfirewall/api_op_CreateFirewall.go +++ b/service/networkfirewall/api_op_CreateFirewall.go @@ -18,11 +18,11 @@ import ( // that are attached to the firewall Amazon Web Services resource. After you create // a firewall, you can provide additional settings, like the logging configuration. // To update the settings for a firewall, you use the operations that apply to the -// settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, -// and UpdateFirewallDeleteProtection. To manage a firewall's tags, use the -// standard Amazon Web Services resource tagging operations, ListTagsForResource, -// TagResource, and UntagResource. To retrieve information about firewalls, use -// ListFirewalls and DescribeFirewall. +// settings themselves, for example UpdateLoggingConfiguration , AssociateSubnets , +// and UpdateFirewallDeleteProtection . To manage a firewall's tags, use the +// standard Amazon Web Services resource tagging operations, ListTagsForResource , +// TagResource , and UntagResource . To retrieve information about firewalls, use +// ListFirewalls and DescribeFirewall . func (c *Client) CreateFirewall(ctx context.Context, params *CreateFirewallInput, optFns ...func(*Options)) (*CreateFirewallOutput, error) { if params == nil { params = &CreateFirewallInput{} @@ -68,7 +68,7 @@ type CreateFirewallInput struct { // A flag indicating whether it is possible to delete the firewall. A setting of // TRUE indicates that the firewall is protected against deletion. Use this setting // to protect against accidentally deleting a firewall that is in use. When you - // create a firewall, the operation initializes this flag to TRUE. + // create a firewall, the operation initializes this flag to TRUE . DeleteProtection bool // A description of the firewall. @@ -80,13 +80,13 @@ type CreateFirewallInput struct { // A setting indicating whether the firewall is protected against a change to the // firewall policy association. Use this setting to protect against accidentally // modifying the firewall policy for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . FirewallPolicyChangeProtection bool // A setting indicating whether the firewall is protected against changes to the // subnet associations. Use this setting to protect against accidentally modifying // the subnet associations for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . SubnetChangeProtection bool // The key:value pairs to associate with the resource. @@ -97,11 +97,11 @@ type CreateFirewallInput struct { type CreateFirewallOutput struct { - // The configuration settings for the firewall. These settings include the firewall - // policy and the subnets in your VPC to use for the firewall endpoints. + // The configuration settings for the firewall. These settings include the + // firewall policy and the subnets in your VPC to use for the firewall endpoints. Firewall *types.Firewall - // Detailed information about the current status of a Firewall. You can retrieve + // Detailed information about the current status of a Firewall . You can retrieve // this for a firewall by calling DescribeFirewall and providing the firewall name // and ARN. FirewallStatus *types.FirewallStatus diff --git a/service/networkfirewall/api_op_CreateFirewallPolicy.go b/service/networkfirewall/api_op_CreateFirewallPolicy.go index 3d76a8444fd..07a68179d00 100644 --- a/service/networkfirewall/api_op_CreateFirewallPolicy.go +++ b/service/networkfirewall/api_op_CreateFirewallPolicy.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the firewall policy for the firewall according to the specifications. An -// Network Firewall firewall policy defines the behavior of a firewall, in a +// Creates the firewall policy for the firewall according to the specifications. +// An Network Firewall firewall policy defines the behavior of a firewall, in a // collection of stateless and stateful rule groups and other settings. You can use // one firewall policy for multiple firewalls. func (c *Client) CreateFirewallPolicy(ctx context.Context, params *CreateFirewallPolicyInput, optFns ...func(*Options)) (*CreateFirewallPolicyOutput, error) { @@ -47,13 +47,13 @@ type CreateFirewallPolicyInput struct { Description *string // Indicates whether you want Network Firewall to just check the validity of the - // request, rather than run the request. If set to TRUE, Network Firewall checks + // request, rather than run the request. If set to TRUE , Network Firewall checks // whether the request can run successfully, but doesn't actually make the // requested changes. The call returns the value that the request would return if - // you ran it with dry run set to FALSE, but doesn't make additions or changes to + // you ran it with dry run set to FALSE , but doesn't make additions or changes to // your resources. This option allows you to make sure that you have the required // permissions to run the request and that your request parameters are valid. If - // set to FALSE, Network Firewall makes the requested changes to your resources. + // set to FALSE , Network Firewall makes the requested changes to your resources. DryRun bool // A complex type that contains settings for encryption of your firewall policy @@ -69,8 +69,8 @@ type CreateFirewallPolicyInput struct { type CreateFirewallPolicyOutput struct { // The high-level properties of a firewall policy. This, along with the - // FirewallPolicy, define the policy. You can retrieve all objects for a firewall - // policy by calling DescribeFirewallPolicy. + // FirewallPolicy , define the policy. You can retrieve all objects for a firewall + // policy by calling DescribeFirewallPolicy . // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse @@ -80,9 +80,10 @@ type CreateFirewallPolicyOutput struct { // policy resource at the time of the request. To make changes to the policy, you // provide the token in your request. Network Firewall uses the token to ensure // that the policy hasn't changed since you last retrieved it. If it has changed, - // the operation fails with an InvalidTokenException. If this happens, retrieve the - // firewall policy again to get a current copy of it with current token. Reapply - // your changes as needed, then try the operation again using the new token. + // the operation fails with an InvalidTokenException . If this happens, retrieve + // the firewall policy again to get a current copy of it with current token. + // Reapply your changes as needed, then try the operation again using the new + // token. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_CreateRuleGroup.go b/service/networkfirewall/api_op_CreateRuleGroup.go index a03da3ee403..46b121a52da 100644 --- a/service/networkfirewall/api_op_CreateRuleGroup.go +++ b/service/networkfirewall/api_op_CreateRuleGroup.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the specified stateless or stateful rule group, which includes the rules -// for network traffic inspection, a capacity setting, and tags. You provide your -// rule group specification in your request using either RuleGroup or Rules. +// Creates the specified stateless or stateful rule group, which includes the +// rules for network traffic inspection, a capacity setting, and tags. You provide +// your rule group specification in your request using either RuleGroup or Rules . func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) { if params == nil { params = &CreateRuleGroupInput{} @@ -36,33 +36,27 @@ type CreateRuleGroupInput struct { // this capacity. When you reference a rule group from a firewall policy, Network // Firewall reserves this capacity for the rule group. You can retrieve the // capacity that would be required for a rule group before you create the rule - // group by calling CreateRuleGroup with DryRun set to TRUE. You can't change or + // group by calling CreateRuleGroup with DryRun set to TRUE . You can't change or // exceed this capacity when you update the rule group, so leave room for your rule // group to grow. Capacity for a stateless rule group For a stateless rule group, // the capacity required is the sum of the capacity requirements of the individual // rules that you expect to have in the rule group. To calculate the capacity // requirement of a single rule, multiply the capacity requirement values of each // of the rule's match settings: - // - // * A match setting with no criteria specified has - // a value of 1. - // - // * A match setting with Any specified has a value of 1. - // - // * All - // other match settings have a value equal to the number of elements provided in - // the setting. For example, a protocol setting ["UDP"] and a source setting - // ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a - // value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a - // value of 3. - // - // A rule with no criteria specified in any of its match settings has - // a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source - // setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification - // or no specification for each of the other match settings has a capacity - // requirement of 6. Capacity for a stateful rule group For a stateful rule group, - // the minimum capacity required is the number of individual rules that you expect - // to have in the rule group. + // - A match setting with no criteria specified has a value of 1. + // - A match setting with Any specified has a value of 1. + // - All other match settings have a value equal to the number of elements + // provided in the setting. For example, a protocol setting ["UDP"] and a source + // setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] + // has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] + // has a value of 3. + // A rule with no criteria specified in any of its match settings has a capacity + // requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting + // ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no + // specification for each of the other match settings has a capacity requirement of + // 6. Capacity for a stateful rule group For a stateful rule group, the minimum + // capacity required is the number of individual rules that you expect to have in + // the rule group. // // This member is required. Capacity *int32 @@ -84,13 +78,13 @@ type CreateRuleGroupInput struct { Description *string // Indicates whether you want Network Firewall to just check the validity of the - // request, rather than run the request. If set to TRUE, Network Firewall checks + // request, rather than run the request. If set to TRUE , Network Firewall checks // whether the request can run successfully, but doesn't actually make the // requested changes. The call returns the value that the request would return if - // you ran it with dry run set to FALSE, but doesn't make additions or changes to + // you ran it with dry run set to FALSE , but doesn't make additions or changes to // your resources. This option allows you to make sure that you have the required // permissions to run the request and that your request parameters are valid. If - // set to FALSE, Network Firewall makes the requested changes to your resources. + // set to FALSE , Network Firewall makes the requested changes to your resources. DryRun bool // A complex type that contains settings for encryption of your rule group @@ -123,9 +117,9 @@ type CreateRuleGroupInput struct { type CreateRuleGroupOutput struct { - // The high-level properties of a rule group. This, along with the RuleGroup, + // The high-level properties of a rule group. This, along with the RuleGroup , // define the rule group. You can retrieve all objects for a rule group by calling - // DescribeRuleGroup. + // DescribeRuleGroup . // // This member is required. RuleGroupResponse *types.RuleGroupResponse @@ -135,7 +129,7 @@ type CreateRuleGroupOutput struct { // resource at the time of the request. To make changes to the rule group, you // provide the token in your request. Network Firewall uses the token to ensure // that the rule group hasn't changed since you last retrieved it. If it has - // changed, the operation fails with an InvalidTokenException. If this happens, + // changed, the operation fails with an InvalidTokenException . If this happens, // retrieve the rule group again to get a current copy of it with a current token. // Reapply your changes as needed, then try the operation again using the new // token. diff --git a/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go b/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go index 906b713044d..515ca80e137 100644 --- a/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go @@ -16,14 +16,13 @@ import ( // Network Firewall uses to decrypt and re-encrypt inbound traffic. After you // create a TLS inspection configuration, you associate it with a firewall policy. // To update the settings for a TLS inspection configuration, use -// UpdateTLSInspectionConfiguration. To manage a TLS inspection configuration's +// UpdateTLSInspectionConfiguration . To manage a TLS inspection configuration's // tags, use the standard Amazon Web Services resource tagging operations, -// ListTagsForResource, TagResource, and UntagResource. To retrieve information +// ListTagsForResource , TagResource , and UntagResource . To retrieve information // about TLS inspection configurations, use ListTLSInspectionConfigurations and -// DescribeTLSInspectionConfiguration. For more information about TLS inspection +// DescribeTLSInspectionConfiguration . For more information about TLS inspection // configurations, see Decrypting SSL/TLS traffic with TLS inspection -// configurations -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) +// configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) // in the Network Firewall Developer Guide. func (c *Client) CreateTLSInspectionConfiguration(ctx context.Context, params *CreateTLSInspectionConfigurationInput, optFns ...func(*Options)) (*CreateTLSInspectionConfigurationOutput, error) { if params == nil { @@ -43,9 +42,9 @@ func (c *Client) CreateTLSInspectionConfiguration(ctx context.Context, params *C type CreateTLSInspectionConfigurationInput struct { // The object that defines a TLS inspection configuration. This, along with - // TLSInspectionConfigurationResponse, define the TLS inspection configuration. You - // can retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection + // TLSInspectionConfigurationResponse , define the TLS inspection configuration. + // You can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . Network Firewall uses a TLS inspection // configuration to decrypt traffic. Network Firewall re-encrypts the traffic // before sending it to its destination. To use a TLS inspection configuration, you // add it to a Network Firewall firewall policy, then you apply the firewall policy @@ -53,8 +52,7 @@ type CreateTLSInspectionConfigurationInput struct { // inbound traffic. You can reference a TLS inspection configuration from more than // one firewall policy, and you can use a firewall policy in more than one // firewall. For more information about using TLS inspection configurations, see - // Decrypting SSL/TLS traffic with TLS inspection configurations - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) + // Decrypting SSL/TLS traffic with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) // in the Network Firewall Developer Guide. // // This member is required. @@ -69,14 +67,13 @@ type CreateTLSInspectionConfigurationInput struct { // A description of the TLS inspection configuration. Description *string - // A complex type that contains optional Amazon Web Services Key Management Service - // (KMS) encryption settings for your Network Firewall resources. Your data is - // encrypted by default with an Amazon Web Services owned key that Amazon Web + // A complex type that contains optional Amazon Web Services Key Management + // Service (KMS) encryption settings for your Network Firewall resources. Your data + // is encrypted by default with an Amazon Web Services owned key that Amazon Web // Services owns and manages for you. You can use either the Amazon Web Services // owned key, or provide your own customer managed key. To learn more about KMS // encryption of your Network Firewall resources, see Encryption at rest with - // Amazon Web Services Key Managment Service - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) + // Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) // in the Network Firewall Developer Guide. EncryptionConfiguration *types.EncryptionConfiguration @@ -89,9 +86,9 @@ type CreateTLSInspectionConfigurationInput struct { type CreateTLSInspectionConfigurationOutput struct { // The high-level properties of a TLS inspection configuration. This, along with - // the TLSInspectionConfiguration, define the TLS inspection configuration. You can - // retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. + // the TLSInspectionConfiguration , define the TLS inspection configuration. You + // can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . // // This member is required. TLSInspectionConfigurationResponse *types.TLSInspectionConfigurationResponse @@ -102,10 +99,10 @@ type CreateTLSInspectionConfigurationOutput struct { // changes to the TLS inspection configuration, you provide the token in your // request. Network Firewall uses the token to ensure that the TLS inspection // configuration hasn't changed since you last retrieved it. If it has changed, the - // operation fails with an InvalidTokenException. If this happens, retrieve the TLS - // inspection configuration again to get a current copy of it with a current token. - // Reapply your changes as needed, then try the operation again using the new - // token. + // operation fails with an InvalidTokenException . If this happens, retrieve the + // TLS inspection configuration again to get a current copy of it with a current + // token. Reapply your changes as needed, then try the operation again using the + // new token. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_DeleteFirewall.go b/service/networkfirewall/api_op_DeleteFirewall.go index 620f872577a..a0e293ba240 100644 --- a/service/networkfirewall/api_op_DeleteFirewall.go +++ b/service/networkfirewall/api_op_DeleteFirewall.go @@ -11,17 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Firewall and its FirewallStatus. This operation requires -// the firewall's DeleteProtection flag to be FALSE. You can't revert this +// Deletes the specified Firewall and its FirewallStatus . This operation requires +// the firewall's DeleteProtection flag to be FALSE . You can't revert this // operation. You can check whether a firewall is in use by reviewing the route // tables for the Availability Zones where you have firewall subnet mappings. -// Retrieve the subnet mappings by calling DescribeFirewall. You define and update +// Retrieve the subnet mappings by calling DescribeFirewall . You define and update // the route tables through Amazon VPC. As needed, update the route tables for the // zones to remove the firewall endpoints. When the route tables no longer use the // firewall endpoints, you can remove the firewall safely. To delete a firewall, -// remove the delete protection if you need to using -// UpdateFirewallDeleteProtection, then delete the firewall by calling -// DeleteFirewall. +// remove the delete protection if you need to using UpdateFirewallDeleteProtection +// , then delete the firewall by calling DeleteFirewall . func (c *Client) DeleteFirewall(ctx context.Context, params *DeleteFirewallInput, optFns ...func(*Options)) (*DeleteFirewallOutput, error) { if params == nil { params = &DeleteFirewallInput{} @@ -58,10 +57,10 @@ type DeleteFirewallOutput struct { // use for the firewall endpoints, and any tags that are attached to the firewall // Amazon Web Services resource. The status of the firewall, for example whether // it's ready to filter network traffic, is provided in the corresponding - // FirewallStatus. You can retrieve both objects by calling DescribeFirewall. + // FirewallStatus . You can retrieve both objects by calling DescribeFirewall . Firewall *types.Firewall - // Detailed information about the current status of a Firewall. You can retrieve + // Detailed information about the current status of a Firewall . You can retrieve // this for a firewall by calling DescribeFirewall and providing the firewall name // and ARN. FirewallStatus *types.FirewallStatus diff --git a/service/networkfirewall/api_op_DeleteFirewallPolicy.go b/service/networkfirewall/api_op_DeleteFirewallPolicy.go index 9bdb6e02339..56a55d82867 100644 --- a/service/networkfirewall/api_op_DeleteFirewallPolicy.go +++ b/service/networkfirewall/api_op_DeleteFirewallPolicy.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified FirewallPolicy. +// Deletes the specified FirewallPolicy . func (c *Client) DeleteFirewallPolicy(ctx context.Context, params *DeleteFirewallPolicyInput, optFns ...func(*Options)) (*DeleteFirewallPolicyOutput, error) { if params == nil { params = &DeleteFirewallPolicyInput{} diff --git a/service/networkfirewall/api_op_DeleteRuleGroup.go b/service/networkfirewall/api_op_DeleteRuleGroup.go index 9bb44033f2b..05664118b27 100644 --- a/service/networkfirewall/api_op_DeleteRuleGroup.go +++ b/service/networkfirewall/api_op_DeleteRuleGroup.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified RuleGroup. +// Deletes the specified RuleGroup . func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -41,7 +41,7 @@ type DeleteRuleGroupInput struct { // Indicates whether the rule group is stateless or stateful. If the rule group is // stateless, it contains stateless rules. If it is stateful, it contains stateful // rules. This setting is required for requests that do not include the - // RuleGroupARN. + // RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -49,9 +49,9 @@ type DeleteRuleGroupInput struct { type DeleteRuleGroupOutput struct { - // The high-level properties of a rule group. This, along with the RuleGroup, + // The high-level properties of a rule group. This, along with the RuleGroup , // define the rule group. You can retrieve all objects for a rule group by calling - // DescribeRuleGroup. + // DescribeRuleGroup . // // This member is required. RuleGroupResponse *types.RuleGroupResponse diff --git a/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go b/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go index adaed30e22d..c4350bf1cb7 100644 --- a/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified TLSInspectionConfiguration. +// Deletes the specified TLSInspectionConfiguration . func (c *Client) DeleteTLSInspectionConfiguration(ctx context.Context, params *DeleteTLSInspectionConfigurationInput, optFns ...func(*Options)) (*DeleteTLSInspectionConfigurationOutput, error) { if params == nil { params = &DeleteTLSInspectionConfigurationInput{} @@ -44,9 +44,9 @@ type DeleteTLSInspectionConfigurationInput struct { type DeleteTLSInspectionConfigurationOutput struct { // The high-level properties of a TLS inspection configuration. This, along with - // the TLSInspectionConfiguration, define the TLS inspection configuration. You can - // retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. + // the TLSInspectionConfiguration , define the TLS inspection configuration. You + // can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . // // This member is required. TLSInspectionConfigurationResponse *types.TLSInspectionConfigurationResponse diff --git a/service/networkfirewall/api_op_DescribeFirewall.go b/service/networkfirewall/api_op_DescribeFirewall.go index 4660594f0de..8e37d94e52b 100644 --- a/service/networkfirewall/api_op_DescribeFirewall.go +++ b/service/networkfirewall/api_op_DescribeFirewall.go @@ -43,11 +43,11 @@ type DescribeFirewallInput struct { type DescribeFirewallOutput struct { - // The configuration settings for the firewall. These settings include the firewall - // policy and the subnets in your VPC to use for the firewall endpoints. + // The configuration settings for the firewall. These settings include the + // firewall policy and the subnets in your VPC to use for the firewall endpoints. Firewall *types.Firewall - // Detailed information about the current status of a Firewall. You can retrieve + // Detailed information about the current status of a Firewall . You can retrieve // this for a firewall by calling DescribeFirewall and providing the firewall name // and ARN. FirewallStatus *types.FirewallStatus @@ -61,7 +61,7 @@ type DescribeFirewallOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_DescribeFirewallPolicy.go b/service/networkfirewall/api_op_DescribeFirewallPolicy.go index a72455acee4..2e9e6e31471 100644 --- a/service/networkfirewall/api_op_DescribeFirewallPolicy.go +++ b/service/networkfirewall/api_op_DescribeFirewallPolicy.go @@ -44,8 +44,8 @@ type DescribeFirewallPolicyInput struct { type DescribeFirewallPolicyOutput struct { // The high-level properties of a firewall policy. This, along with the - // FirewallPolicy, define the policy. You can retrieve all objects for a firewall - // policy by calling DescribeFirewallPolicy. + // FirewallPolicy , define the policy. You can retrieve all objects for a firewall + // policy by calling DescribeFirewallPolicy . // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse @@ -55,9 +55,10 @@ type DescribeFirewallPolicyOutput struct { // policy resource at the time of the request. To make changes to the policy, you // provide the token in your request. Network Firewall uses the token to ensure // that the policy hasn't changed since you last retrieved it. If it has changed, - // the operation fails with an InvalidTokenException. If this happens, retrieve the - // firewall policy again to get a current copy of it with current token. Reapply - // your changes as needed, then try the operation again using the new token. + // the operation fails with an InvalidTokenException . If this happens, retrieve + // the firewall policy again to get a current copy of it with current token. + // Reapply your changes as needed, then try the operation again using the new + // token. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_DescribeLoggingConfiguration.go b/service/networkfirewall/api_op_DescribeLoggingConfiguration.go index deefa0b99ff..54076905322 100644 --- a/service/networkfirewall/api_op_DescribeLoggingConfiguration.go +++ b/service/networkfirewall/api_op_DescribeLoggingConfiguration.go @@ -46,7 +46,7 @@ type DescribeLoggingConfigurationOutput struct { // The Amazon Resource Name (ARN) of the firewall. FirewallArn *string - // Defines how Network Firewall performs logging for a Firewall. + // Defines how Network Firewall performs logging for a Firewall . LoggingConfiguration *types.LoggingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_DescribeRuleGroup.go b/service/networkfirewall/api_op_DescribeRuleGroup.go index 29d4cd5e3ba..1e92e0f276c 100644 --- a/service/networkfirewall/api_op_DescribeRuleGroup.go +++ b/service/networkfirewall/api_op_DescribeRuleGroup.go @@ -41,7 +41,7 @@ type DescribeRuleGroupInput struct { // Indicates whether the rule group is stateless or stateful. If the rule group is // stateless, it contains stateless rules. If it is stateful, it contains stateful // rules. This setting is required for requests that do not include the - // RuleGroupARN. + // RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -49,9 +49,9 @@ type DescribeRuleGroupInput struct { type DescribeRuleGroupOutput struct { - // The high-level properties of a rule group. This, along with the RuleGroup, + // The high-level properties of a rule group. This, along with the RuleGroup , // define the rule group. You can retrieve all objects for a rule group by calling - // DescribeRuleGroup. + // DescribeRuleGroup . // // This member is required. RuleGroupResponse *types.RuleGroupResponse @@ -61,7 +61,7 @@ type DescribeRuleGroupOutput struct { // resource at the time of the request. To make changes to the rule group, you // provide the token in your request. Network Firewall uses the token to ensure // that the rule group hasn't changed since you last retrieved it. If it has - // changed, the operation fails with an InvalidTokenException. If this happens, + // changed, the operation fails with an InvalidTokenException . If this happens, // retrieve the rule group again to get a current copy of it with a current token. // Reapply your changes as needed, then try the operation again using the new // token. @@ -70,8 +70,8 @@ type DescribeRuleGroupOutput struct { UpdateToken *string // The object that defines the rules in a rule group. This, along with - // RuleGroupResponse, define the rule group. You can retrieve all objects for a - // rule group by calling DescribeRuleGroup. Network Firewall uses a rule group to + // RuleGroupResponse , define the rule group. You can retrieve all objects for a + // rule group by calling DescribeRuleGroup . Network Firewall uses a rule group to // inspect and control network traffic. You define stateless rule groups to inspect // individual packets and you define stateful rule groups to inspect packets in the // context of their traffic flow. To use a rule group, you include it by reference diff --git a/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go b/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go index a9c5f3b8563..e2fc4016c4f 100644 --- a/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go +++ b/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go @@ -15,7 +15,7 @@ import ( // High-level information about a rule group, returned by operations like create // and describe. You can use the information provided in the metadata to retrieve // and manage a rule group. You can retrieve all objects for a rule group by -// calling DescribeRuleGroup. +// calling DescribeRuleGroup . func (c *Client) DescribeRuleGroupMetadata(ctx context.Context, params *DescribeRuleGroupMetadataInput, optFns ...func(*Options)) (*DescribeRuleGroupMetadataOutput, error) { if params == nil { params = &DescribeRuleGroupMetadataInput{} @@ -46,7 +46,7 @@ type DescribeRuleGroupMetadataInput struct { // Indicates whether the rule group is stateless or stateful. If the rule group is // stateless, it contains stateless rules. If it is stateful, it contains stateful // rules. This setting is required for requests that do not include the - // RuleGroupARN. + // RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -73,7 +73,7 @@ type DescribeRuleGroupMetadataOutput struct { // this capacity. When you reference a rule group from a firewall policy, Network // Firewall reserves this capacity for the rule group. You can retrieve the // capacity that would be required for a rule group before you create the rule - // group by calling CreateRuleGroup with DryRun set to TRUE. + // group by calling CreateRuleGroup with DryRun set to TRUE . Capacity *int32 // Returns the metadata objects for the specified rule group. @@ -89,7 +89,7 @@ type DescribeRuleGroupMetadataOutput struct { // Indicates whether the rule group is stateless or stateful. If the rule group is // stateless, it contains stateless rules. If it is stateful, it contains stateful // rules. This setting is required for requests that do not include the - // RuleGroupARN. + // RuleGroupARN . Type types.RuleGroupType // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go b/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go index 264eac64451..329cfbc4555 100644 --- a/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go @@ -44,9 +44,9 @@ type DescribeTLSInspectionConfigurationInput struct { type DescribeTLSInspectionConfigurationOutput struct { // The high-level properties of a TLS inspection configuration. This, along with - // the TLSInspectionConfiguration, define the TLS inspection configuration. You can - // retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. + // the TLSInspectionConfiguration , define the TLS inspection configuration. You + // can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . // // This member is required. TLSInspectionConfigurationResponse *types.TLSInspectionConfigurationResponse @@ -57,18 +57,18 @@ type DescribeTLSInspectionConfigurationOutput struct { // changes to the TLS inspection configuration, you provide the token in your // request. Network Firewall uses the token to ensure that the TLS inspection // configuration hasn't changed since you last retrieved it. If it has changed, the - // operation fails with an InvalidTokenException. If this happens, retrieve the TLS - // inspection configuration again to get a current copy of it with a current token. - // Reapply your changes as needed, then try the operation again using the new - // token. + // operation fails with an InvalidTokenException . If this happens, retrieve the + // TLS inspection configuration again to get a current copy of it with a current + // token. Reapply your changes as needed, then try the operation again using the + // new token. // // This member is required. UpdateToken *string // The object that defines a TLS inspection configuration. This, along with - // TLSInspectionConfigurationResponse, define the TLS inspection configuration. You - // can retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection + // TLSInspectionConfigurationResponse , define the TLS inspection configuration. + // You can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . Network Firewall uses a TLS inspection // configuration to decrypt traffic. Network Firewall re-encrypts the traffic // before sending it to its destination. To use a TLS inspection configuration, you // add it to a Network Firewall firewall policy, then you apply the firewall policy @@ -76,8 +76,7 @@ type DescribeTLSInspectionConfigurationOutput struct { // inbound traffic. You can reference a TLS inspection configuration from more than // one firewall policy, and you can use a firewall policy in more than one // firewall. For more information about using TLS inspection configurations, see - // Decrypting SSL/TLS traffic with TLS inspection configurations - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) + // Decrypting SSL/TLS traffic with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) // in the Network Firewall Developer Guide. TLSInspectionConfiguration *types.TLSInspectionConfiguration diff --git a/service/networkfirewall/api_op_DisassociateSubnets.go b/service/networkfirewall/api_op_DisassociateSubnets.go index 0fa0c478859..3b508ed1b9d 100644 --- a/service/networkfirewall/api_op_DisassociateSubnets.go +++ b/service/networkfirewall/api_op_DisassociateSubnets.go @@ -54,7 +54,7 @@ type DisassociateSubnetsInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -83,7 +83,7 @@ type DisassociateSubnetsOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_ListFirewallPolicies.go b/service/networkfirewall/api_op_ListFirewallPolicies.go index a32943f5ce3..7fd68737f62 100644 --- a/service/networkfirewall/api_op_ListFirewallPolicies.go +++ b/service/networkfirewall/api_op_ListFirewallPolicies.go @@ -34,8 +34,8 @@ type ListFirewallPoliciesInput struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of @@ -141,8 +141,8 @@ var _ ListFirewallPoliciesAPIClient = (*Client)(nil) type ListFirewallPoliciesPaginatorOptions struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkfirewall/api_op_ListFirewalls.go b/service/networkfirewall/api_op_ListFirewalls.go index 369a311b041..adb7b915ef3 100644 --- a/service/networkfirewall/api_op_ListFirewalls.go +++ b/service/networkfirewall/api_op_ListFirewalls.go @@ -35,8 +35,8 @@ type ListFirewallsInput struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of @@ -56,8 +56,8 @@ type ListFirewallsInput struct { type ListFirewallsOutput struct { - // The firewall metadata objects for the VPCs that you specified. Depending on your - // setting for max results and the number of firewalls you have, a single call + // The firewall metadata objects for the VPCs that you specified. Depending on + // your setting for max results and the number of firewalls you have, a single call // might not be the full list. Firewalls []types.FirewallMetadata @@ -145,8 +145,8 @@ var _ ListFirewallsAPIClient = (*Client)(nil) type ListFirewallsPaginatorOptions struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkfirewall/api_op_ListRuleGroups.go b/service/networkfirewall/api_op_ListRuleGroups.go index e620b3a585b..cdbf8f6f10a 100644 --- a/service/networkfirewall/api_op_ListRuleGroups.go +++ b/service/networkfirewall/api_op_ListRuleGroups.go @@ -37,8 +37,8 @@ type ListRuleGroupsInput struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of @@ -49,8 +49,8 @@ type ListRuleGroupsInput struct { NextToken *string // The scope of the request. The default setting of ACCOUNT or a setting of NULL - // returns all of the rule groups in your account. A setting of MANAGED returns all - // available managed rule groups. + // returns all of the rule groups in your account. A setting of MANAGED returns + // all available managed rule groups. Scope types.ResourceManagedStatus // Indicates whether the rule group is stateless or stateful. If the rule group is @@ -152,8 +152,8 @@ var _ ListRuleGroupsAPIClient = (*Client)(nil) type ListRuleGroupsPaginatorOptions struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkfirewall/api_op_ListTLSInspectionConfigurations.go b/service/networkfirewall/api_op_ListTLSInspectionConfigurations.go index b4367d56745..d7ce91569e0 100644 --- a/service/networkfirewall/api_op_ListTLSInspectionConfigurations.go +++ b/service/networkfirewall/api_op_ListTLSInspectionConfigurations.go @@ -34,8 +34,8 @@ type ListTLSInspectionConfigurationsInput struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of @@ -57,9 +57,9 @@ type ListTLSInspectionConfigurationsOutput struct { // request in your next request. NextToken *string - // The TLS inspection configuration metadata objects that you've defined. Depending - // on your setting for max results and the number of TLS inspection configurations, - // this might not be the full list. + // The TLS inspection configuration metadata objects that you've defined. + // Depending on your setting for max results and the number of TLS inspection + // configurations, this might not be the full list. TLSInspectionConfigurations []types.TLSInspectionConfigurationMetadata // Metadata pertaining to the operation's result. @@ -141,8 +141,8 @@ var _ ListTLSInspectionConfigurationsAPIClient = (*Client)(nil) type ListTLSInspectionConfigurationsPaginatorOptions struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkfirewall/api_op_ListTagsForResource.go b/service/networkfirewall/api_op_ListTagsForResource.go index 0cf66b4d997..b0ea519fcaa 100644 --- a/service/networkfirewall/api_op_ListTagsForResource.go +++ b/service/networkfirewall/api_op_ListTagsForResource.go @@ -43,8 +43,8 @@ type ListTagsForResourceInput struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. MaxResults *int32 // When you request a list of objects with a MaxResults setting, if the number of @@ -138,8 +138,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -151,8 +151,8 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) type ListTagsForResourcePaginatorOptions struct { // The maximum number of objects that you want Network Firewall to return for this // request. If more objects are available, in the response, Network Firewall - // provides a NextToken value that you can use in a subsequent call to get the next - // batch of objects. + // provides a NextToken value that you can use in a subsequent call to get the + // next batch of objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkfirewall/api_op_PutResourcePolicy.go b/service/networkfirewall/api_op_PutResourcePolicy.go index 56e7fd06027..69e7f183126 100644 --- a/service/networkfirewall/api_op_PutResourcePolicy.go +++ b/service/networkfirewall/api_op_PutResourcePolicy.go @@ -20,19 +20,14 @@ import ( // add an account in the resource policy, you then run the following Resource // Access Manager (RAM) operations to access and accept the shared rule group or // firewall policy. +// - GetResourceShareInvitations (https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html) +// - Returns the Amazon Resource Names (ARNs) of the resource share invitations. +// - AcceptResourceShareInvitation (https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html) +// - Accepts the share invitation for a specified resource share. // -// * GetResourceShareInvitations -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html) -// - Returns the Amazon Resource Names (ARNs) of the resource share invitations. -// -// * -// AcceptResourceShareInvitation -// (https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html) -// - Accepts the share invitation for a specified resource share. -// -// For additional -// information about resource sharing using RAM, see Resource Access Manager User -// Guide (https://docs.aws.amazon.com/ram/latest/userguide/what-is.html). +// For additional information about resource sharing using RAM, see Resource +// Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/what-is.html) +// . func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -54,38 +49,24 @@ type PutResourcePolicyInput struct { // rule group or firewall policy with and the operations that you want the accounts // to be able to perform. For a rule group resource, you can specify the following // operations in the Actions section of the statement: - // - // * - // network-firewall:CreateFirewallPolicy - // - // * - // network-firewall:UpdateFirewallPolicy - // - // * network-firewall:ListRuleGroups - // - // For a - // firewall policy resource, you can specify the following operations in the + // - network-firewall:CreateFirewallPolicy + // - network-firewall:UpdateFirewallPolicy + // - network-firewall:ListRuleGroups + // For a firewall policy resource, you can specify the following operations in the // Actions section of the statement: - // - // * network-firewall:CreateFirewall - // - // * - // network-firewall:UpdateFirewall - // - // * network-firewall:AssociateFirewallPolicy - // - // * - // network-firewall:ListFirewallPolicies - // - // In the Resource section of the statement, - // you specify the ARNs for the rule groups and firewall policies that you want to - // share with the account that you specified in Arn. + // - network-firewall:CreateFirewall + // - network-firewall:UpdateFirewall + // - network-firewall:AssociateFirewallPolicy + // - network-firewall:ListFirewallPolicies + // In the Resource section of the statement, you specify the ARNs for the rule + // groups and firewall policies that you want to share with the account that you + // specified in Arn . // // This member is required. Policy *string - // The Amazon Resource Name (ARN) of the account that you want to share rule groups - // and firewall policies with. + // The Amazon Resource Name (ARN) of the account that you want to share rule + // groups and firewall policies with. // // This member is required. ResourceArn *string diff --git a/service/networkfirewall/api_op_TagResource.go b/service/networkfirewall/api_op_TagResource.go index c5155a9dbfb..ef8fdc022de 100644 --- a/service/networkfirewall/api_op_TagResource.go +++ b/service/networkfirewall/api_op_TagResource.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified tags to the specified resource. Tags are key:value pairs that -// you can use to categorize and manage your resources, for purposes like billing. -// For example, you might set the tag key to "customer" and the value to the -// customer name or ID. You can specify one or more tags to add to each Amazon Web -// Services resource, up to 50 tags for a resource. You can tag the Amazon Web +// Adds the specified tags to the specified resource. Tags are key:value pairs +// that you can use to categorize and manage your resources, for purposes like +// billing. For example, you might set the tag key to "customer" and the value to +// the customer name or ID. You can specify one or more tags to add to each Amazon +// Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web // Services resources that you manage through Network Firewall: firewalls, firewall // policies, and rule groups. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { diff --git a/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go b/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go index b21c18d4cf4..07eee05d279 100644 --- a/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go +++ b/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the flag, DeleteProtection, which indicates whether it is possible to -// delete the firewall. If the flag is set to TRUE, the firewall is protected +// Modifies the flag, DeleteProtection , which indicates whether it is possible to +// delete the firewall. If the flag is set to TRUE , the firewall is protected // against deletion. This setting helps protect against accidentally deleting a // firewall that's in use. func (c *Client) UpdateFirewallDeleteProtection(ctx context.Context, params *UpdateFirewallDeleteProtectionInput, optFns ...func(*Options)) (*UpdateFirewallDeleteProtectionOutput, error) { @@ -34,7 +34,7 @@ type UpdateFirewallDeleteProtectionInput struct { // A flag indicating whether it is possible to delete the firewall. A setting of // TRUE indicates that the firewall is protected against deletion. Use this setting // to protect against accidentally deleting a firewall that is in use. When you - // create a firewall, the operation initializes this flag to TRUE. + // create a firewall, the operation initializes this flag to TRUE . // // This member is required. DeleteProtection bool @@ -57,7 +57,7 @@ type UpdateFirewallDeleteProtectionInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -70,7 +70,7 @@ type UpdateFirewallDeleteProtectionOutput struct { // A flag indicating whether it is possible to delete the firewall. A setting of // TRUE indicates that the firewall is protected against deletion. Use this setting // to protect against accidentally deleting a firewall that is in use. When you - // create a firewall, the operation initializes this flag to TRUE. + // create a firewall, the operation initializes this flag to TRUE . DeleteProtection bool // The Amazon Resource Name (ARN) of the firewall. @@ -89,7 +89,7 @@ type UpdateFirewallDeleteProtectionOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateFirewallDescription.go b/service/networkfirewall/api_op_UpdateFirewallDescription.go index dea9c7a5bd0..8d69491ce0e 100644 --- a/service/networkfirewall/api_op_UpdateFirewallDescription.go +++ b/service/networkfirewall/api_op_UpdateFirewallDescription.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the description for the specified firewall. Use the description to help -// you identify the firewall when you're working with it. +// Modifies the description for the specified firewall. Use the description to +// help you identify the firewall when you're working with it. func (c *Client) UpdateFirewallDescription(ctx context.Context, params *UpdateFirewallDescriptionInput, optFns ...func(*Options)) (*UpdateFirewallDescriptionOutput, error) { if params == nil { params = &UpdateFirewallDescriptionInput{} @@ -29,8 +29,8 @@ func (c *Client) UpdateFirewallDescription(ctx context.Context, params *UpdateFi type UpdateFirewallDescriptionInput struct { - // The new description for the firewall. If you omit this setting, Network Firewall - // removes the description for the firewall. + // The new description for the firewall. If you omit this setting, Network + // Firewall removes the description for the firewall. Description *string // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the @@ -51,7 +51,7 @@ type UpdateFirewallDescriptionInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -80,7 +80,7 @@ type UpdateFirewallDescriptionOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go b/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go index 3b8e7f69aa0..c0272f90dda 100644 --- a/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go +++ b/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go @@ -29,14 +29,13 @@ func (c *Client) UpdateFirewallEncryptionConfiguration(ctx context.Context, para type UpdateFirewallEncryptionConfigurationInput struct { - // A complex type that contains optional Amazon Web Services Key Management Service - // (KMS) encryption settings for your Network Firewall resources. Your data is - // encrypted by default with an Amazon Web Services owned key that Amazon Web + // A complex type that contains optional Amazon Web Services Key Management + // Service (KMS) encryption settings for your Network Firewall resources. Your data + // is encrypted by default with an Amazon Web Services owned key that Amazon Web // Services owns and manages for you. You can use either the Amazon Web Services // owned key, or provide your own customer managed key. To learn more about KMS // encryption of your Network Firewall resources, see Encryption at rest with - // Amazon Web Services Key Managment Service - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) + // Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) // in the Network Firewall Developer Guide. EncryptionConfiguration *types.EncryptionConfiguration @@ -56,7 +55,7 @@ type UpdateFirewallEncryptionConfigurationInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -66,14 +65,13 @@ type UpdateFirewallEncryptionConfigurationInput struct { type UpdateFirewallEncryptionConfigurationOutput struct { - // A complex type that contains optional Amazon Web Services Key Management Service - // (KMS) encryption settings for your Network Firewall resources. Your data is - // encrypted by default with an Amazon Web Services owned key that Amazon Web + // A complex type that contains optional Amazon Web Services Key Management + // Service (KMS) encryption settings for your Network Firewall resources. Your data + // is encrypted by default with an Amazon Web Services owned key that Amazon Web // Services owns and manages for you. You can use either the Amazon Web Services // owned key, or provide your own customer managed key. To learn more about KMS // encryption of your Network Firewall resources, see Encryption at rest with - // Amazon Web Services Key Managment Service - // (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) + // Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) // in the Network Firewall Developer Guide. EncryptionConfiguration *types.EncryptionConfiguration @@ -93,7 +91,7 @@ type UpdateFirewallEncryptionConfigurationOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateFirewallPolicy.go b/service/networkfirewall/api_op_UpdateFirewallPolicy.go index e9a5161fbfb..a667743fc75 100644 --- a/service/networkfirewall/api_op_UpdateFirewallPolicy.go +++ b/service/networkfirewall/api_op_UpdateFirewallPolicy.go @@ -39,9 +39,10 @@ type UpdateFirewallPolicyInput struct { // policy resource at the time of the request. To make changes to the policy, you // provide the token in your request. Network Firewall uses the token to ensure // that the policy hasn't changed since you last retrieved it. If it has changed, - // the operation fails with an InvalidTokenException. If this happens, retrieve the - // firewall policy again to get a current copy of it with current token. Reapply - // your changes as needed, then try the operation again using the new token. + // the operation fails with an InvalidTokenException . If this happens, retrieve + // the firewall policy again to get a current copy of it with current token. + // Reapply your changes as needed, then try the operation again using the new + // token. // // This member is required. UpdateToken *string @@ -50,13 +51,13 @@ type UpdateFirewallPolicyInput struct { Description *string // Indicates whether you want Network Firewall to just check the validity of the - // request, rather than run the request. If set to TRUE, Network Firewall checks + // request, rather than run the request. If set to TRUE , Network Firewall checks // whether the request can run successfully, but doesn't actually make the // requested changes. The call returns the value that the request would return if - // you ran it with dry run set to FALSE, but doesn't make additions or changes to + // you ran it with dry run set to FALSE , but doesn't make additions or changes to // your resources. This option allows you to make sure that you have the required // permissions to run the request and that your request parameters are valid. If - // set to FALSE, Network Firewall makes the requested changes to your resources. + // set to FALSE , Network Firewall makes the requested changes to your resources. DryRun bool // A complex type that contains settings for encryption of your firewall policy @@ -78,8 +79,8 @@ type UpdateFirewallPolicyInput struct { type UpdateFirewallPolicyOutput struct { // The high-level properties of a firewall policy. This, along with the - // FirewallPolicy, define the policy. You can retrieve all objects for a firewall - // policy by calling DescribeFirewallPolicy. + // FirewallPolicy , define the policy. You can retrieve all objects for a firewall + // policy by calling DescribeFirewallPolicy . // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse @@ -89,9 +90,10 @@ type UpdateFirewallPolicyOutput struct { // policy resource at the time of the request. To make changes to the policy, you // provide the token in your request. Network Firewall uses the token to ensure // that the policy hasn't changed since you last retrieved it. If it has changed, - // the operation fails with an InvalidTokenException. If this happens, retrieve the - // firewall policy again to get a current copy of it with current token. Reapply - // your changes as needed, then try the operation again using the new token. + // the operation fails with an InvalidTokenException . If this happens, retrieve + // the firewall policy again to get a current copy of it with current token. + // Reapply your changes as needed, then try the operation again using the new + // token. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go b/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go index bd02d36a2a9..65b458afe0a 100644 --- a/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go +++ b/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the flag, ChangeProtection, which indicates whether it is possible to -// change the firewall. If the flag is set to TRUE, the firewall is protected from +// Modifies the flag, ChangeProtection , which indicates whether it is possible to +// change the firewall. If the flag is set to TRUE , the firewall is protected from // changes. This setting helps protect against accidentally changing a firewall // that's in use. func (c *Client) UpdateFirewallPolicyChangeProtection(ctx context.Context, params *UpdateFirewallPolicyChangeProtectionInput, optFns ...func(*Options)) (*UpdateFirewallPolicyChangeProtectionOutput, error) { @@ -34,7 +34,7 @@ type UpdateFirewallPolicyChangeProtectionInput struct { // A setting indicating whether the firewall is protected against a change to the // firewall policy association. Use this setting to protect against accidentally // modifying the firewall policy for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . // // This member is required. FirewallPolicyChangeProtection bool @@ -57,7 +57,7 @@ type UpdateFirewallPolicyChangeProtectionInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -77,7 +77,7 @@ type UpdateFirewallPolicyChangeProtectionOutput struct { // A setting indicating whether the firewall is protected against a change to the // firewall policy association. Use this setting to protect against accidentally // modifying the firewall policy for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . FirewallPolicyChangeProtection bool // An optional token that you can use for optimistic locking. Network Firewall @@ -89,7 +89,7 @@ type UpdateFirewallPolicyChangeProtectionOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateLoggingConfiguration.go b/service/networkfirewall/api_op_UpdateLoggingConfiguration.go index 7f46cffe7a2..f21ac02080f 100644 --- a/service/networkfirewall/api_op_UpdateLoggingConfiguration.go +++ b/service/networkfirewall/api_op_UpdateLoggingConfiguration.go @@ -11,28 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the logging configuration for the specified firewall. To change the logging -// configuration, retrieve the LoggingConfiguration by calling -// DescribeLoggingConfiguration, then change it and provide the modified object to +// Sets the logging configuration for the specified firewall. To change the +// logging configuration, retrieve the LoggingConfiguration by calling +// DescribeLoggingConfiguration , then change it and provide the modified object to // this update call. You must change the logging configuration one -// LogDestinationConfig at a time inside the retrieved LoggingConfiguration object. -// You can perform only one of the following actions in any call to -// UpdateLoggingConfiguration: +// LogDestinationConfig at a time inside the retrieved LoggingConfiguration +// object. You can perform only one of the following actions in any call to +// UpdateLoggingConfiguration : +// - Create a new log destination object by adding a single LogDestinationConfig +// array element to LogDestinationConfigs . +// - Delete a log destination object by removing a single LogDestinationConfig +// array element from LogDestinationConfigs . +// - Change the LogDestination setting in a single LogDestinationConfig array +// element. // -// * Create a new log destination object by adding a -// single LogDestinationConfig array element to LogDestinationConfigs. -// -// * Delete a -// log destination object by removing a single LogDestinationConfig array element -// from LogDestinationConfigs. -// -// * Change the LogDestination setting in a single -// LogDestinationConfig array element. -// -// You can't change the LogDestinationType or -// LogType in a LogDestinationConfig. To change these settings, delete the existing -// LogDestinationConfig object and create a new one, using two separate calls to -// this update operation. +// You can't change the LogDestinationType or LogType in a LogDestinationConfig . +// To change these settings, delete the existing LogDestinationConfig object and +// create a new one, using two separate calls to this update operation. func (c *Client) UpdateLoggingConfiguration(ctx context.Context, params *UpdateLoggingConfigurationInput, optFns ...func(*Options)) (*UpdateLoggingConfigurationOutput, error) { if params == nil { params = &UpdateLoggingConfigurationInput{} @@ -75,7 +70,7 @@ type UpdateLoggingConfigurationOutput struct { // after you create it. FirewallName *string - // Defines how Network Firewall performs logging for a Firewall. + // Defines how Network Firewall performs logging for a Firewall . LoggingConfiguration *types.LoggingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_UpdateRuleGroup.go b/service/networkfirewall/api_op_UpdateRuleGroup.go index ef519a92157..9f998b32212 100644 --- a/service/networkfirewall/api_op_UpdateRuleGroup.go +++ b/service/networkfirewall/api_op_UpdateRuleGroup.go @@ -38,7 +38,7 @@ type UpdateRuleGroupInput struct { // resource at the time of the request. To make changes to the rule group, you // provide the token in your request. Network Firewall uses the token to ensure // that the rule group hasn't changed since you last retrieved it. If it has - // changed, the operation fails with an InvalidTokenException. If this happens, + // changed, the operation fails with an InvalidTokenException . If this happens, // retrieve the rule group again to get a current copy of it with a current token. // Reapply your changes as needed, then try the operation again using the new // token. @@ -50,13 +50,13 @@ type UpdateRuleGroupInput struct { Description *string // Indicates whether you want Network Firewall to just check the validity of the - // request, rather than run the request. If set to TRUE, Network Firewall checks + // request, rather than run the request. If set to TRUE , Network Firewall checks // whether the request can run successfully, but doesn't actually make the // requested changes. The call returns the value that the request would return if - // you ran it with dry run set to FALSE, but doesn't make additions or changes to + // you ran it with dry run set to FALSE , but doesn't make additions or changes to // your resources. This option allows you to make sure that you have the required // permissions to run the request and that your request parameters are valid. If - // set to FALSE, Network Firewall makes the requested changes to your resources. + // set to FALSE , Network Firewall makes the requested changes to your resources. DryRun bool // A complex type that contains settings for encryption of your rule group @@ -93,7 +93,7 @@ type UpdateRuleGroupInput struct { // Indicates whether the rule group is stateless or stateful. If the rule group is // stateless, it contains stateless rules. If it is stateful, it contains stateful // rules. This setting is required for requests that do not include the - // RuleGroupARN. + // RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -101,9 +101,9 @@ type UpdateRuleGroupInput struct { type UpdateRuleGroupOutput struct { - // The high-level properties of a rule group. This, along with the RuleGroup, + // The high-level properties of a rule group. This, along with the RuleGroup , // define the rule group. You can retrieve all objects for a rule group by calling - // DescribeRuleGroup. + // DescribeRuleGroup . // // This member is required. RuleGroupResponse *types.RuleGroupResponse @@ -113,7 +113,7 @@ type UpdateRuleGroupOutput struct { // resource at the time of the request. To make changes to the rule group, you // provide the token in your request. Network Firewall uses the token to ensure // that the rule group hasn't changed since you last retrieved it. If it has - // changed, the operation fails with an InvalidTokenException. If this happens, + // changed, the operation fails with an InvalidTokenException . If this happens, // retrieve the rule group again to get a current copy of it with a current token. // Reapply your changes as needed, then try the operation again using the new // token. diff --git a/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go b/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go index b3c041daa18..26905088e84 100644 --- a/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go +++ b/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go @@ -30,7 +30,7 @@ type UpdateSubnetChangeProtectionInput struct { // A setting indicating whether the firewall is protected against changes to the // subnet associations. Use this setting to protect against accidentally modifying // the subnet associations for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . // // This member is required. SubnetChangeProtection bool @@ -53,7 +53,7 @@ type UpdateSubnetChangeProtectionInput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -73,7 +73,7 @@ type UpdateSubnetChangeProtectionOutput struct { // A setting indicating whether the firewall is protected against changes to the // subnet associations. Use this setting to protect against accidentally modifying // the subnet associations for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . SubnetChangeProtection bool // An optional token that you can use for optimistic locking. Network Firewall @@ -85,7 +85,7 @@ type UpdateSubnetChangeProtectionOutput struct { // change to the firewall, provide the token in your update request. Network // Firewall uses the token to ensure that the firewall hasn't changed since you // last retrieved it. If it has changed, the operation fails with an - // InvalidTokenException. If this happens, retrieve the firewall again to get a + // InvalidTokenException . If this happens, retrieve the firewall again to get a // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go b/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go index 1059a160af6..52217bacd27 100644 --- a/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go @@ -37,9 +37,9 @@ func (c *Client) UpdateTLSInspectionConfiguration(ctx context.Context, params *U type UpdateTLSInspectionConfigurationInput struct { // The object that defines a TLS inspection configuration. This, along with - // TLSInspectionConfigurationResponse, define the TLS inspection configuration. You - // can retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection + // TLSInspectionConfigurationResponse , define the TLS inspection configuration. + // You can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . Network Firewall uses a TLS inspection // configuration to decrypt traffic. Network Firewall re-encrypts the traffic // before sending it to its destination. To use a TLS inspection configuration, you // add it to a Network Firewall firewall policy, then you apply the firewall policy @@ -47,8 +47,7 @@ type UpdateTLSInspectionConfigurationInput struct { // inbound traffic. You can reference a TLS inspection configuration from more than // one firewall policy, and you can use a firewall policy in more than one // firewall. For more information about using TLS inspection configurations, see - // Decrypting SSL/TLS traffic with TLS inspection configurations - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) + // Decrypting SSL/TLS traffic with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) // in the Network Firewall Developer Guide. // // This member is required. @@ -60,10 +59,10 @@ type UpdateTLSInspectionConfigurationInput struct { // changes to the TLS inspection configuration, you provide the token in your // request. Network Firewall uses the token to ensure that the TLS inspection // configuration hasn't changed since you last retrieved it. If it has changed, the - // operation fails with an InvalidTokenException. If this happens, retrieve the TLS - // inspection configuration again to get a current copy of it with a current token. - // Reapply your changes as needed, then try the operation again using the new - // token. + // operation fails with an InvalidTokenException . If this happens, retrieve the + // TLS inspection configuration again to get a current copy of it with a current + // token. Reapply your changes as needed, then try the operation again using the + // new token. // // This member is required. UpdateToken *string @@ -88,9 +87,9 @@ type UpdateTLSInspectionConfigurationInput struct { type UpdateTLSInspectionConfigurationOutput struct { // The high-level properties of a TLS inspection configuration. This, along with - // the TLSInspectionConfiguration, define the TLS inspection configuration. You can - // retrieve all objects for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration. + // the TLSInspectionConfiguration , define the TLS inspection configuration. You + // can retrieve all objects for a TLS inspection configuration by calling + // DescribeTLSInspectionConfiguration . // // This member is required. TLSInspectionConfigurationResponse *types.TLSInspectionConfigurationResponse @@ -101,10 +100,10 @@ type UpdateTLSInspectionConfigurationOutput struct { // changes to the TLS inspection configuration, you provide the token in your // request. Network Firewall uses the token to ensure that the TLS inspection // configuration hasn't changed since you last retrieved it. If it has changed, the - // operation fails with an InvalidTokenException. If this happens, retrieve the TLS - // inspection configuration again to get a current copy of it with a current token. - // Reapply your changes as needed, then try the operation again using the new - // token. + // operation fails with an InvalidTokenException . If this happens, retrieve the + // TLS inspection configuration again to get a current copy of it with a current + // token. Reapply your changes as needed, then try the operation again using the + // new token. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/doc.go b/service/networkfirewall/doc.go index 9db008f6b29..55e994046b4 100644 --- a/service/networkfirewall/doc.go +++ b/service/networkfirewall/doc.go @@ -1,81 +1,60 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package networkfirewall provides the API client, operations, and parameter types -// for AWS Network Firewall. -// -// This is the API Reference for Network Firewall. This guide is for developers who -// need detailed information about the Network Firewall API actions, data types, -// and errors. -// -// * The REST API requires you to handle connection details, such as -// calculating signatures, handling request retries, and error handling. For -// general information about using the Amazon Web Services REST APIs, see Amazon -// Web Services APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html). -// To access Network Firewall using the REST API endpoint: -// https://network-firewall..amazonaws.com -// -// * Alternatively, you can use one of the -// Amazon Web Services SDKs to access an API that's tailored to the programming -// language or platform that you're using. For more information, see Amazon Web -// Services SDKs (http://aws.amazon.com/tools/#SDKs). -// -// * For descriptions of -// Network Firewall features, including and step-by-step instructions on how to use -// them through the Network Firewall console, see the Network Firewall Developer -// Guide -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/). -// -// Network -// Firewall is a stateful, managed, network firewall and intrusion detection and -// prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network -// Firewall, you can filter traffic at the perimeter of your VPC. This includes -// filtering traffic going to and coming from an internet gateway, NAT gateway, or -// over VPN or Direct Connect. Network Firewall uses rules that are compatible with -// Suricata, a free, open source network analysis and threat detection engine. -// Network Firewall supports Suricata version 6.0.9. For information about -// Suricata, see the Suricata website (https://suricata.io/). You can use Network -// Firewall to monitor and protect your VPC traffic in a number of ways. The -// following are just a few examples: -// -// * Allow domains or IP addresses for known -// Amazon Web Services service endpoints, such as Amazon S3, and block all other -// forms of traffic. -// -// * Use custom lists of known bad domains to limit the types of -// domain names that your applications can access. -// -// * Perform deep packet -// inspection on traffic entering or leaving your VPC. -// -// * Use stateful protocol -// detection to filter protocols like HTTPS, regardless of the port used. -// -// To -// enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and -// in Network Firewall. For information about using Amazon VPC, see Amazon VPC User -// Guide (https://docs.aws.amazon.com/vpc/latest/userguide/). To start using +// Package networkfirewall provides the API client, operations, and parameter +// types for AWS Network Firewall. +// +// This is the API Reference for Network Firewall. This guide is for developers +// who need detailed information about the Network Firewall API actions, data +// types, and errors. +// - The REST API requires you to handle connection details, such as calculating +// signatures, handling request retries, and error handling. For general +// information about using the Amazon Web Services REST APIs, see Amazon Web +// Services APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html) . +// To access Network Firewall using the REST API endpoint: +// https://network-firewall..amazonaws.com +// - Alternatively, you can use one of the Amazon Web Services SDKs to access an +// API that's tailored to the programming language or platform that you're using. +// For more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs) +// . +// - For descriptions of Network Firewall features, including and step-by-step +// instructions on how to use them through the Network Firewall console, see the +// Network Firewall Developer Guide (https://docs.aws.amazon.com/network-firewall/latest/developerguide/) +// . +// +// Network Firewall is a stateful, managed, network firewall and intrusion +// detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). +// With Network Firewall, you can filter traffic at the perimeter of your VPC. This +// includes filtering traffic going to and coming from an internet gateway, NAT +// gateway, or over VPN or Direct Connect. Network Firewall uses rules that are +// compatible with Suricata, a free, open source network analysis and threat +// detection engine. Network Firewall supports Suricata version 6.0.9. For +// information about Suricata, see the Suricata website (https://suricata.io/) . +// You can use Network Firewall to monitor and protect your VPC traffic in a number +// of ways. The following are just a few examples: +// - Allow domains or IP addresses for known Amazon Web Services service +// endpoints, such as Amazon S3, and block all other forms of traffic. +// - Use custom lists of known bad domains to limit the types of domain names +// that your applications can access. +// - Perform deep packet inspection on traffic entering or leaving your VPC. +// - Use stateful protocol detection to filter protocols like HTTPS, regardless +// of the port used. +// +// To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC +// and in Network Firewall. For information about using Amazon VPC, see Amazon VPC +// User Guide (https://docs.aws.amazon.com/vpc/latest/userguide/) . To start using // Network Firewall, do the following: -// -// * (Optional) If you don't already have a -// VPC that you want to protect, create it in Amazon VPC. -// -// * In Amazon VPC, in each -// Availability Zone where you want to have a firewall endpoint, create a subnet -// for the sole use of Network Firewall. -// -// * In Network Firewall, create stateless -// and stateful rule groups, to define the components of the network traffic -// filtering behavior that you want your firewall to have. -// -// * In Network Firewall, -// create a firewall policy that uses your rule groups and specifies additional -// default traffic filtering behavior. -// -// * In Network Firewall, create a firewall -// and specify your new firewall policy and VPC subnets. Network Firewall creates a -// firewall endpoint in each subnet that you specify, with the behavior that's -// defined in the firewall policy. -// -// * In Amazon VPC, use ingress routing -// enhancements to route traffic through the new firewall endpoints. +// - (Optional) If you don't already have a VPC that you want to protect, create +// it in Amazon VPC. +// - In Amazon VPC, in each Availability Zone where you want to have a firewall +// endpoint, create a subnet for the sole use of Network Firewall. +// - In Network Firewall, create stateless and stateful rule groups, to define +// the components of the network traffic filtering behavior that you want your +// firewall to have. +// - In Network Firewall, create a firewall policy that uses your rule groups +// and specifies additional default traffic filtering behavior. +// - In Network Firewall, create a firewall and specify your new firewall policy +// and VPC subnets. Network Firewall creates a firewall endpoint in each subnet +// that you specify, with the behavior that's defined in the firewall policy. +// - In Amazon VPC, use ingress routing enhancements to route traffic through +// the new firewall endpoints. package networkfirewall diff --git a/service/networkfirewall/types/enums.go b/service/networkfirewall/types/enums.go index 44c6c815531..9f9f08fb2ea 100644 --- a/service/networkfirewall/types/enums.go +++ b/service/networkfirewall/types/enums.go @@ -202,8 +202,8 @@ const ( ResourceManagedStatusAccount ResourceManagedStatus = "ACCOUNT" ) -// Values returns all known values for ResourceManagedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ResourceManagedStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ResourceManagedStatus) Values() []ResourceManagedStatus { return []ResourceManagedStatus{ @@ -274,9 +274,9 @@ const ( RuleOrderStrictOrder RuleOrder = "STRICT_ORDER" ) -// Values returns all known values for RuleOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RuleOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RuleOrder) Values() []RuleOrder { return []RuleOrder{ "DEFAULT_ACTION_ORDER", @@ -314,8 +314,8 @@ const ( StatefulRuleDirectionAny StatefulRuleDirection = "ANY" ) -// Values returns all known values for StatefulRuleDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StatefulRuleDirection. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StatefulRuleDirection) Values() []StatefulRuleDirection { return []StatefulRuleDirection{ @@ -384,8 +384,8 @@ const ( StreamExceptionPolicyContinue StreamExceptionPolicy = "CONTINUE" ) -// Values returns all known values for StreamExceptionPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StreamExceptionPolicy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StreamExceptionPolicy) Values() []StreamExceptionPolicy { return []StreamExceptionPolicy{ diff --git a/service/networkfirewall/types/errors.go b/service/networkfirewall/types/errors.go index fd63816169d..fe09e5e6098 100644 --- a/service/networkfirewall/types/errors.go +++ b/service/networkfirewall/types/errors.go @@ -88,17 +88,12 @@ func (e *InvalidOperationException) ErrorCode() string { } func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because of a problem with your request. Examples -// include: -// -// * You specified an unsupported parameter name or value. -// -// * You tried -// to update a property with a value that isn't among the available types. -// -// * Your -// request references an ARN that is malformed, or corresponds to a resource that -// isn't valid in the context of the request. +// The operation failed because of a problem with your request. Examples include: +// - You specified an unsupported parameter name or value. +// - You tried to update a property with a value that isn't among the available +// types. +// - Your request references an ARN that is malformed, or corresponds to a +// resource that isn't valid in the context of the request. type InvalidRequestException struct { Message *string diff --git a/service/networkfirewall/types/types.go b/service/networkfirewall/types/types.go index ca6a3d369c4..a7b60ce0b00 100644 --- a/service/networkfirewall/types/types.go +++ b/service/networkfirewall/types/types.go @@ -8,7 +8,7 @@ import ( ) // A custom action to use in stateless rule actions settings. This is used in -// CustomAction. +// CustomAction . type ActionDefinition struct { // Stateless inspection criteria that publishes the specified metrics to Amazon @@ -30,26 +30,20 @@ type Address struct { // Specify an IP address or a block of IP addresses in Classless Inter-Domain // Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 // and IPv6. Examples: - // - // * To configure Network Firewall to inspect for the IP - // address 192.0.2.44, specify 192.0.2.44/32. - // - // * To configure Network Firewall to - // inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. - // - // * - // To configure Network Firewall to inspect for the IP address - // 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure Network Firewall to - // inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). + // - To configure Network Firewall to inspect for the IP address 192.0.2.44, + // specify 192.0.2.44/32 . + // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to + // 192.0.2.255, specify 192.0.2.0/24 . + // - To configure Network Firewall to inspect for the IP address + // 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure Network Firewall to inspect for IP addresses from + // 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . // // This member is required. AddressDefinition *string @@ -58,7 +52,7 @@ type Address struct { } // The configuration and status for a single subnet that you've specified for use -// by the Network Firewall firewall. This is part of the FirewallStatus. +// by the Network Firewall firewall. This is part of the FirewallStatus . type Attachment struct { // The identifier of the firewall endpoint that Network Firewall has instantiated @@ -68,18 +62,17 @@ type Attachment struct { // The current status of the firewall endpoint in the subnet. This value reflects // both the instantiation of the endpoint in the VPC subnet and the sync states - // that are reported in the Config settings. When this value is READY, the endpoint - // is available and configured properly to handle network traffic. When the - // endpoint isn't available for traffic, this value will reflect its state, for - // example CREATING or DELETING. + // that are reported in the Config settings. When this value is READY , the + // endpoint is available and configured properly to handle network traffic. When + // the endpoint isn't available for traffic, this value will reflect its state, for + // example CREATING or DELETING . Status AttachmentStatus // If Network Firewall fails to create or delete the firewall endpoint in the // subnet, it populates this with the reason for the failure and how to resolve it. // Depending on the error, it can take as many as 15 minutes to populate this // field. For more information about the errors and solutions available for this - // field, see Troubleshooting firewall endpoint failures - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html) + // field, see Troubleshooting firewall endpoint failures (https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html) // in the Network Firewall Developer Guide. StatusMessage *string @@ -94,8 +87,8 @@ type Attachment struct { // firewall. type CapacityUsageSummary struct { - // Describes the capacity usage of the CIDR blocks used by the IP set references in - // a firewall. + // Describes the capacity usage of the CIDR blocks used by the IP set references + // in a firewall. CIDRs *CIDRSummary noSmithyDocumentSerde @@ -124,18 +117,15 @@ type CIDRSummary struct { // and name the custom actions that you want to be able to use, and then you // reference them by name in your actions settings. You can use custom actions in // the following places: -// -// * In a rule group's StatelessRulesAndCustomActions -// specification. The custom actions are available for use by name inside the -// StatelessRulesAndCustomActions where you define them. You can use them for your -// stateless rule actions to specify what to do with a packet that matches the -// rule's match attributes. -// -// * In a FirewallPolicy specification, in -// StatelessCustomActions. The custom actions are available for use inside the -// policy where you define them. You can use them for the policy's default -// stateless actions settings to specify what to do with packets that don't match -// any of the policy's stateless rules. +// - In a rule group's StatelessRulesAndCustomActions specification. The custom +// actions are available for use by name inside the +// StatelessRulesAndCustomActions where you define them. You can use them for +// your stateless rule actions to specify what to do with a packet that matches the +// rule's match attributes. +// - In a FirewallPolicy specification, in StatelessCustomActions . The custom +// actions are available for use inside the policy where you define them. You can +// use them for the policy's default stateless actions settings to specify what to +// do with packets that don't match any of the policy's stateless rules. type CustomAction struct { // The custom action associated with the action name. @@ -143,8 +133,8 @@ type CustomAction struct { // This member is required. ActionDefinition *ActionDefinition - // The descriptive name of the custom action. You can't change the name of a custom - // action after you create it. + // The descriptive name of the custom action. You can't change the name of a + // custom action after you create it. // // This member is required. ActionName *string @@ -153,14 +143,13 @@ type CustomAction struct { } // The value to use in an Amazon CloudWatch custom metric dimension. This is used -// in the PublishMetricsCustomAction. A CloudWatch custom metric dimension is a +// in the PublishMetrics CustomAction . A CloudWatch custom metric dimension is a // name/value pair that's part of the identity of a metric. Network Firewall sets -// the dimension name to CustomAction and you provide the dimension value. For more -// information about CloudWatch custom metric dimensions, see Publishing Custom -// Metrics -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) -// in the Amazon CloudWatch User Guide -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). +// the dimension name to CustomAction and you provide the dimension value. For +// more information about CloudWatch custom metric dimensions, see Publishing +// Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) +// in the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) +// . type Dimension struct { // The value to use in the custom metric dimension. @@ -171,14 +160,13 @@ type Dimension struct { noSmithyDocumentSerde } -// A complex type that contains optional Amazon Web Services Key Management Service -// (KMS) encryption settings for your Network Firewall resources. Your data is -// encrypted by default with an Amazon Web Services owned key that Amazon Web +// A complex type that contains optional Amazon Web Services Key Management +// Service (KMS) encryption settings for your Network Firewall resources. Your data +// is encrypted by default with an Amazon Web Services owned key that Amazon Web // Services owns and manages for you. You can use either the Amazon Web Services // owned key, or provide your own customer managed key. To learn more about KMS // encryption of your Network Firewall resources, see Encryption at rest with -// Amazon Web Services Key Managment Service -// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) +// Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) // in the Network Firewall Developer Guide. type EncryptionConfiguration struct { @@ -191,9 +179,8 @@ type EncryptionConfiguration struct { // The ID of the Amazon Web Services Key Management Service (KMS) customer managed // key. You can use any of the key identifiers that KMS supports, unless you're // using a key that's managed by another account. If you're using a key managed by - // another account, then specify the key ARN. For more information, see Key ID - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in - // the Amazon Web Services KMS Developer Guide. + // another account, then specify the key ARN. For more information, see Key ID (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) + // in the Amazon Web Services KMS Developer Guide. KeyId *string noSmithyDocumentSerde @@ -204,7 +191,7 @@ type EncryptionConfiguration struct { // use for the firewall endpoints, and any tags that are attached to the firewall // Amazon Web Services resource. The status of the firewall, for example whether // it's ready to filter network traffic, is provided in the corresponding -// FirewallStatus. You can retrieve both objects by calling DescribeFirewall. +// FirewallStatus . You can retrieve both objects by calling DescribeFirewall . type Firewall struct { // The unique identifier for the firewall. @@ -234,7 +221,7 @@ type Firewall struct { // A flag indicating whether it is possible to delete the firewall. A setting of // TRUE indicates that the firewall is protected against deletion. Use this setting // to protect against accidentally deleting a firewall that is in use. When you - // create a firewall, the operation initializes this flag to TRUE. + // create a firewall, the operation initializes this flag to TRUE . DeleteProtection bool // A description of the firewall. @@ -254,13 +241,13 @@ type Firewall struct { // A setting indicating whether the firewall is protected against a change to the // firewall policy association. Use this setting to protect against accidentally // modifying the firewall policy for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . FirewallPolicyChangeProtection bool // A setting indicating whether the firewall is protected against changes to the // subnet associations. Use this setting to protect against accidentally modifying // the subnet associations for a firewall that is in use. When you create a - // firewall, the operation initializes this setting to TRUE. + // firewall, the operation initializes this setting to TRUE . SubnetChangeProtection bool // @@ -286,19 +273,19 @@ type FirewallMetadata struct { // The firewall policy defines the behavior of a firewall using a collection of // stateless and stateful rule groups and other settings. You can use one firewall -// policy for multiple firewalls. This, along with FirewallPolicyResponse, define +// policy for multiple firewalls. This, along with FirewallPolicyResponse , define // the policy. You can retrieve all objects for a firewall policy by calling -// DescribeFirewallPolicy. +// DescribeFirewallPolicy . type FirewallPolicy struct { // The actions to take on a packet if it doesn't match any of the stateless rules // in the policy. If you want non-matching packets to be forwarded for stateful - // inspection, specify aws:forward_to_sfe. You must specify one of the standard - // actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify - // custom actions that are compatible with your standard section choice. For - // example, you could specify ["aws:pass"] or you could specify ["aws:pass", - // “customActionName”]. For information about compatibility, see the custom action - // descriptions under CustomAction. + // inspection, specify aws:forward_to_sfe . You must specify one of the standard + // actions: aws:pass , aws:drop , or aws:forward_to_sfe . In addition, you can + // specify custom actions that are compatible with your standard section choice. + // For example, you could specify ["aws:pass"] or you could specify ["aws:pass", + // “customActionName”] . For information about compatibility, see the custom action + // descriptions under CustomAction . // // This member is required. StatelessDefaultActions []string @@ -307,12 +294,12 @@ type FirewallPolicy struct { // stateless rules in the policy. Network Firewall only manages UDP packet // fragments and silently drops packet fragments for other protocols. If you want // non-matching fragmented UDP packets to be forwarded for stateful inspection, - // specify aws:forward_to_sfe. You must specify one of the standard actions: - // aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom - // actions that are compatible with your standard section choice. For example, you - // could specify ["aws:pass"] or you could specify ["aws:pass", - // “customActionName”]. For information about compatibility, see the custom action - // descriptions under CustomAction. + // specify aws:forward_to_sfe . You must specify one of the standard actions: + // aws:pass , aws:drop , or aws:forward_to_sfe . In addition, you can specify + // custom actions that are compatible with your standard section choice. For + // example, you could specify ["aws:pass"] or you could specify ["aws:pass", + // “customActionName”] . For information about compatibility, see the custom action + // descriptions under CustomAction . // // This member is required. StatelessFragmentDefaultActions []string @@ -320,19 +307,11 @@ type FirewallPolicy struct { // The default actions to take on a packet that doesn't match any stateful rules. // The stateful default action is optional, and is only valid when using the strict // rule order. Valid values of the stateful default action: - // - // * aws:drop_strict - // - // * - // aws:drop_established - // - // * aws:alert_strict - // - // * aws:alert_established - // - // For more - // information, see Strict evaluation order - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) + // - aws:drop_strict + // - aws:drop_established + // - aws:alert_strict + // - aws:alert_established + // For more information, see Strict evaluation order (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) // in the Network Firewall Developer Guide. StatefulDefaultActions []string @@ -341,8 +320,8 @@ type FirewallPolicy struct { // settings that are compatible with these settings. StatefulEngineOptions *StatefulEngineOptions - // References to the stateful rule groups that are used in the policy. These define - // the inspection criteria in stateful rules. + // References to the stateful rule groups that are used in the policy. These + // define the inspection criteria in stateful rules. StatefulRuleGroupReferences []StatefulRuleGroupReference // The custom action definitions that are available for use in the firewall @@ -363,7 +342,7 @@ type FirewallPolicy struct { // High-level information about a firewall policy, returned by operations like // create and describe. You can use the information provided in the metadata to // retrieve and manage a firewall policy. You can retrieve all objects for a -// firewall policy by calling DescribeFirewallPolicy. +// firewall policy by calling DescribeFirewallPolicy . type FirewallPolicyMetadata struct { // The Amazon Resource Name (ARN) of the firewall policy. @@ -377,13 +356,13 @@ type FirewallPolicyMetadata struct { } // The high-level properties of a firewall policy. This, along with the -// FirewallPolicy, define the policy. You can retrieve all objects for a firewall -// policy by calling DescribeFirewallPolicy. +// FirewallPolicy , define the policy. You can retrieve all objects for a firewall +// policy by calling DescribeFirewallPolicy . type FirewallPolicyResponse struct { - // The Amazon Resource Name (ARN) of the firewall policy. If this response is for a - // create request that had DryRun set to TRUE, then this ARN is a placeholder that - // isn't attached to a valid resource. + // The Amazon Resource Name (ARN) of the firewall policy. If this response is for + // a create request that had DryRun set to TRUE , then this ARN is a placeholder + // that isn't attached to a valid resource. // // This member is required. FirewallPolicyArn *string @@ -429,28 +408,28 @@ type FirewallPolicyResponse struct { noSmithyDocumentSerde } -// Detailed information about the current status of a Firewall. You can retrieve +// Detailed information about the current status of a Firewall . You can retrieve // this for a firewall by calling DescribeFirewall and providing the firewall name // and ARN. type FirewallStatus struct { // The configuration sync state for the firewall. This summarizes the sync states - // reported in the Config settings for all of the Availability Zones where you have - // configured the firewall. When you create a firewall or update its configuration, - // for example by adding a rule group to its firewall policy, Network Firewall - // distributes the configuration changes to all zones where the firewall is in use. - // This summary indicates whether the configuration changes have been applied - // everywhere. This status must be IN_SYNC for the firewall to be ready for use, - // but it doesn't indicate that the firewall is ready. The Status setting indicates - // firewall readiness. + // reported in the Config settings for all of the Availability Zones where you + // have configured the firewall. When you create a firewall or update its + // configuration, for example by adding a rule group to its firewall policy, + // Network Firewall distributes the configuration changes to all zones where the + // firewall is in use. This summary indicates whether the configuration changes + // have been applied everywhere. This status must be IN_SYNC for the firewall to + // be ready for use, but it doesn't indicate that the firewall is ready. The Status + // setting indicates firewall readiness. // // This member is required. ConfigurationSyncStateSummary ConfigurationSyncState - // The readiness of the configured firewall to handle network traffic across all of - // the Availability Zones where you've configured it. This setting is READY only - // when the ConfigurationSyncStateSummary value is IN_SYNC and the AttachmentStatus - // values for all of the configured subnets are READY. + // The readiness of the configured firewall to handle network traffic across all + // of the Availability Zones where you've configured it. This setting is READY + // only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment + // Status values for all of the configured subnets are READY . // // This member is required. Status FirewallStatusValue @@ -464,98 +443,86 @@ type FirewallStatus struct { // The subnets that you've configured for use by the Network Firewall firewall. // This contains one array element per Availability Zone where you've configured a // subnet. These objects provide details of the information that is summarized in - // the ConfigurationSyncStateSummary and Status, broken down by zone and + // the ConfigurationSyncStateSummary and Status , broken down by zone and // configuration object. SyncStates map[string]SyncState noSmithyDocumentSerde } -// The basic rule criteria for Network Firewall to use to inspect packet headers in -// stateful traffic flow inspection. Traffic flows that match the criteria are a -// match for the corresponding StatefulRule. +// The basic rule criteria for Network Firewall to use to inspect packet headers +// in stateful traffic flow inspection. Traffic flows that match the criteria are a +// match for the corresponding StatefulRule . type Header struct { - // The destination IP address or address range to inspect for, in CIDR notation. To - // match with any address, specify ANY. Specify an IP address or a block of IP + // The destination IP address or address range to inspect for, in CIDR notation. + // To match with any address, specify ANY . Specify an IP address or a block of IP // addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall // supports all address ranges for IPv4 and IPv6. Examples: - // - // * To configure Network - // Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32. - // - // * To - // configure Network Firewall to inspect for IP addresses from 192.0.2.0 to - // 192.0.2.255, specify 192.0.2.0/24. - // - // * To configure Network Firewall to inspect - // for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure Network Firewall to - // inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). + // - To configure Network Firewall to inspect for the IP address 192.0.2.44, + // specify 192.0.2.44/32 . + // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to + // 192.0.2.255, specify 192.0.2.0/24 . + // - To configure Network Firewall to inspect for the IP address + // 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure Network Firewall to inspect for IP addresses from + // 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . // // This member is required. Destination *string // The destination port to inspect for. You can specify an individual port, for - // example 1994 and you can specify a port range, for example 1990:1994. To match - // with any port, specify ANY. + // example 1994 and you can specify a port range, for example 1990:1994 . To match + // with any port, specify ANY . // // This member is required. DestinationPort *string - // The direction of traffic flow to inspect. If set to ANY, the inspection matches + // The direction of traffic flow to inspect. If set to ANY , the inspection matches // bidirectional traffic, both from the source to the destination and from the - // destination to the source. If set to FORWARD, the inspection only matches + // destination to the source. If set to FORWARD , the inspection only matches // traffic going from the source to the destination. // // This member is required. Direction StatefulRuleDirection - // The protocol to inspect for. To specify all, you can use IP, because all traffic - // on Amazon Web Services and on the internet is IP. + // The protocol to inspect for. To specify all, you can use IP , because all + // traffic on Amazon Web Services and on the internet is IP. // // This member is required. Protocol StatefulRuleProtocol // The source IP address or address range to inspect for, in CIDR notation. To - // match with any address, specify ANY. Specify an IP address or a block of IP + // match with any address, specify ANY . Specify an IP address or a block of IP // addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall // supports all address ranges for IPv4 and IPv6. Examples: - // - // * To configure Network - // Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32. - // - // * To - // configure Network Firewall to inspect for IP addresses from 192.0.2.0 to - // 192.0.2.255, specify 192.0.2.0/24. - // - // * To configure Network Firewall to inspect - // for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure Network Firewall to - // inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). + // - To configure Network Firewall to inspect for the IP address 192.0.2.44, + // specify 192.0.2.44/32 . + // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to + // 192.0.2.255, specify 192.0.2.0/24 . + // - To configure Network Firewall to inspect for the IP address + // 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure Network Firewall to inspect for IP addresses from + // 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . // // This member is required. Source *string // The source port to inspect for. You can specify an individual port, for example - // 1994 and you can specify a port range, for example 1990:1994. To match with any - // port, specify ANY. + // 1994 and you can specify a port range, for example 1990:1994 . To match with any + // port, specify ANY . // // This member is required. SourcePort *string @@ -564,7 +531,7 @@ type Header struct { } // A list of IP addresses and address ranges, in CIDR notation. This is part of a -// RuleVariables. +// RuleVariables . type IPSet struct { // The list of IP addresses and address ranges, in CIDR notation. @@ -580,27 +547,24 @@ type IPSetMetadata struct { // Describes the total number of CIDR blocks currently in use by the IP set // references in a firewall. To determine how many CIDR blocks are available for - // you to use in a firewall, you can call AvailableCIDRCount. + // you to use in a firewall, you can call AvailableCIDRCount . ResolvedCIDRCount *int32 noSmithyDocumentSerde } // Configures one or more IP set references for a Suricata-compatible rule group. -// This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a +// This is used in CreateRuleGroup or UpdateRuleGroup . An IP set reference is a // rule variable that references resources that you create and manage in another // Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall // IP set references enable you to dynamically update the contents of your rules. // When you create, update, or delete the resource you are referencing in your // rule, Network Firewall automatically updates the rule's content with the // changes. For more information about IP set references in Network Firewall, see -// Using IP set references -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references) +// Using IP set references (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references) // in the Network Firewall Developer Guide. Network Firewall currently supports -// Amazon VPC prefix lists -// (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) and -// resource groups -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html#rule-groups-referencing-resource-groups) +// Amazon VPC prefix lists (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) +// and resource groups (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html#rule-groups-referencing-resource-groups) // in IP set references. type IPSetReference struct { @@ -612,32 +576,27 @@ type IPSetReference struct { } // Defines where Network Firewall sends logs for the firewall for one log type. -// This is used in LoggingConfiguration. You can send each type of log to an Amazon -// S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream. -// Network Firewall generates logs for stateful rule groups. You can save alert and -// flow log types. The stateful rules engine records flow logs for all network -// traffic that it receives. It records alert logs for traffic that matches -// stateful rules that have the rule action set to DROP or ALERT. +// This is used in LoggingConfiguration . You can send each type of log to an +// Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery +// stream. Network Firewall generates logs for stateful rule groups. You can save +// alert and flow log types. The stateful rules engine records flow logs for all +// network traffic that it receives. It records alert logs for traffic that matches +// stateful rules that have the rule action set to DROP or ALERT . type LogDestinationConfig struct { // The named location for the logs, provided in a key:value mapping that is // specific to the chosen destination type. - // - // * For an Amazon S3 bucket, provide the - // name of the bucket, with key bucketName, and optionally provide a prefix, with - // key prefix. The following example specifies an Amazon S3 bucket named - // DOC-EXAMPLE-BUCKET and the prefix alerts: "LogDestination": { "bucketName": - // "DOC-EXAMPLE-BUCKET", "prefix": "alerts" } - // - // * For a CloudWatch log group, - // provide the name of the CloudWatch log group, with key logGroup. The following - // example specifies a log group named alert-log-group: "LogDestination": { - // "logGroup": "alert-log-group" } - // - // * For a Kinesis Data Firehose delivery stream, - // provide the name of the delivery stream, with key deliveryStream. The following - // example specifies a delivery stream named alert-delivery-stream: - // "LogDestination": { "deliveryStream": "alert-delivery-stream" } + // - For an Amazon S3 bucket, provide the name of the bucket, with key bucketName + // , and optionally provide a prefix, with key prefix . The following example + // specifies an Amazon S3 bucket named DOC-EXAMPLE-BUCKET and the prefix alerts : + // "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" } + // - For a CloudWatch log group, provide the name of the CloudWatch log group, + // with key logGroup . The following example specifies a log group named + // alert-log-group : "LogDestination": { "logGroup": "alert-log-group" } + // - For a Kinesis Data Firehose delivery stream, provide the name of the + // delivery stream, with key deliveryStream . The following example specifies a + // delivery stream named alert-delivery-stream : "LogDestination": { + // "deliveryStream": "alert-delivery-stream" } // // This member is required. LogDestination map[string]string @@ -659,7 +618,7 @@ type LogDestinationConfig struct { noSmithyDocumentSerde } -// Defines how Network Firewall performs logging for a Firewall. +// Defines how Network Firewall performs logging for a Firewall . type LoggingConfiguration struct { // Defines the logging destinations for the logs for a firewall. Network Firewall @@ -679,7 +638,7 @@ type MatchAttributes struct { // The destination ports to inspect for. If not specified, this matches with any // destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP). // You can specify individual ports, for example 1994 and you can specify port - // ranges, for example 1990:1994. + // ranges, for example 1990:1994 . DestinationPorts []PortRange // The destination IP addresses and address ranges to inspect for, in CIDR @@ -693,7 +652,7 @@ type MatchAttributes struct { // The source ports to inspect for. If not specified, this matches with any source // port. This setting is only used for protocols 6 (TCP) and 17 (UDP). You can // specify individual ports, for example 1994 and you can specify port ranges, for - // example 1990:1994. + // example 1990:1994 . SourcePorts []PortRange // The source IP addresses and address ranges to inspect for, in CIDR notation. If @@ -707,10 +666,10 @@ type MatchAttributes struct { noSmithyDocumentSerde } -// Provides configuration status for a single policy or rule group that is used for -// a firewall endpoint. Network Firewall provides each endpoint with the rules that -// are configured in the firewall policy. Each time you add a subnet or modify the -// associated firewall policy, Network Firewall synchronizes the rules in the +// Provides configuration status for a single policy or rule group that is used +// for a firewall endpoint. Network Firewall provides each endpoint with the rules +// that are configured in the firewall policy. Each time you add a subnet or modify +// the associated firewall policy, Network Firewall synchronizes the rules in the // endpoint, so it can properly filter network traffic. This is part of a SyncState // for a firewall. type PerObjectStatus struct { @@ -727,8 +686,8 @@ type PerObjectStatus struct { } // A single port range specification. This is used for source and destination port -// ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts -// settings. +// ranges in the stateless rule MatchAttributes , SourcePorts , and +// DestinationPorts settings. type PortRange struct { // The lower limit of the port range. This must be less than or equal to the ToPort @@ -777,38 +736,33 @@ type ReferenceSets struct { noSmithyDocumentSerde } -// The inspection criteria and action for a single stateless rule. Network Firewall -// inspects each packet for the specified matching criteria. When a packet matches -// the criteria, Network Firewall performs the rule's actions on the packet. +// The inspection criteria and action for a single stateless rule. Network +// Firewall inspects each packet for the specified matching criteria. When a packet +// matches the criteria, Network Firewall performs the rule's actions on the +// packet. type RuleDefinition struct { // The actions to take on a packet that matches one of the stateless rule // definition's match attributes. You must specify a standard action and you can // add custom actions. Network Firewall only forwards a packet for stateful rule - // inspection if you specify aws:forward_to_sfe for a rule that the packet matches, - // or if the packet doesn't match any stateless rule and you specify + // inspection if you specify aws:forward_to_sfe for a rule that the packet + // matches, or if the packet doesn't match any stateless rule and you specify // aws:forward_to_sfe for the StatelessDefaultActions setting for the - // FirewallPolicy. For every rule, you must specify exactly one of the following + // FirewallPolicy . For every rule, you must specify exactly one of the following // standard actions. - // - // * aws:pass - Discontinues all inspection of the packet and - // permits it to go to its intended destination. - // - // * aws:drop - Discontinues all - // inspection of the packet and blocks it from going to its intended - // destination. - // - // * aws:forward_to_sfe - Discontinues stateless inspection of the - // packet and forwards it to the stateful rule engine for - // inspection. - // - // Additionally, you can specify a custom action. To do this, you - // define a custom action by name and type, then provide the name you've assigned - // to the action in this Actions setting. For information about the options, see - // CustomAction. To provide more than one action in this setting, separate the - // settings with a comma. For example, if you have a custom PublishMetrics action - // that you've named MyMetricsAction, then you could specify the standard action - // aws:pass and the custom action with [“aws:pass”, “MyMetricsAction”]. + // - aws:pass - Discontinues all inspection of the packet and permits it to go + // to its intended destination. + // - aws:drop - Discontinues all inspection of the packet and blocks it from + // going to its intended destination. + // - aws:forward_to_sfe - Discontinues stateless inspection of the packet and + // forwards it to the stateful rule engine for inspection. + // Additionally, you can specify a custom action. To do this, you define a custom + // action by name and type, then provide the name you've assigned to the action in + // this Actions setting. For information about the options, see CustomAction . To + // provide more than one action in this setting, separate the settings with a + // comma. For example, if you have a custom PublishMetrics action that you've + // named MyMetricsAction , then you could specify the standard action aws:pass and + // the custom action with [“aws:pass”, “MyMetricsAction”] . // // This member is required. Actions []string @@ -824,8 +778,8 @@ type RuleDefinition struct { } // The object that defines the rules in a rule group. This, along with -// RuleGroupResponse, define the rule group. You can retrieve all objects for a -// rule group by calling DescribeRuleGroup. Network Firewall uses a rule group to +// RuleGroupResponse , define the rule group. You can retrieve all objects for a +// rule group by calling DescribeRuleGroup . Network Firewall uses a rule group to // inspect and control network traffic. You define stateless rule groups to inspect // individual packets and you define stateful rule groups to inspect packets in the // context of their traffic flow. To use a rule group, you include it by reference @@ -842,8 +796,8 @@ type RuleGroup struct { // The list of a rule group's reference sets. ReferenceSets *ReferenceSets - // Settings that are available for use in the rules in the rule group. You can only - // use these for stateful rule groups. + // Settings that are available for use in the rules in the rule group. You can + // only use these for stateful rule groups. RuleVariables *RuleVariables // Additional options governing how Network Firewall handles stateful rules. The @@ -854,7 +808,7 @@ type RuleGroup struct { noSmithyDocumentSerde } -// High-level information about a rule group, returned by ListRuleGroups. You can +// High-level information about a rule group, returned by ListRuleGroups . You can // use the information provided in the metadata to retrieve and manage a rule // group. type RuleGroupMetadata struct { @@ -869,13 +823,13 @@ type RuleGroupMetadata struct { noSmithyDocumentSerde } -// The high-level properties of a rule group. This, along with the RuleGroup, +// The high-level properties of a rule group. This, along with the RuleGroup , // define the rule group. You can retrieve all objects for a rule group by calling -// DescribeRuleGroup. +// DescribeRuleGroup . type RuleGroupResponse struct { // The Amazon Resource Name (ARN) of the rule group. If this response is for a - // create request that had DryRun set to TRUE, then this ARN is a placeholder that + // create request that had DryRun set to TRUE , then this ARN is a placeholder that // isn't attached to a valid resource. // // This member is required. @@ -897,7 +851,7 @@ type RuleGroupResponse struct { // this capacity. When you reference a rule group from a firewall policy, Network // Firewall reserves this capacity for the rule group. You can retrieve the // capacity that would be required for a rule group before you create the rule - // group by calling CreateRuleGroup with DryRun set to TRUE. + // group by calling CreateRuleGroup with DryRun set to TRUE . Capacity *int32 // The number of capacity units currently consumed by the rule group rules. @@ -923,8 +877,8 @@ type RuleGroupResponse struct { // topic that's used to record changes to the managed rule group. You can subscribe // to the SNS topic to receive notifications when the managed rule group is // modified, such as for new versions and for version expiration. For more - // information, see the Amazon Simple Notification Service Developer Guide. - // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). + // information, see the Amazon Simple Notification Service Developer Guide. (https://docs.aws.amazon.com/sns/latest/dg/welcome.html) + // . SnsTopic *string // A complex type that contains metadata about the rule group that your own rule @@ -958,9 +912,9 @@ type RuleOption struct { noSmithyDocumentSerde } -// The stateless or stateful rules definitions for use in a single rule group. Each -// rule group requires a single RulesSource. You can use an instance of this for -// either stateless rules or stateful rules. +// The stateless or stateful rules definitions for use in a single rule group. +// Each rule group requires a single RulesSource . You can use an instance of this +// for either stateless rules or stateful rules. type RulesSource struct { // Stateful inspection criteria for a domain list rule group. @@ -974,11 +928,11 @@ type RulesSource struct { // setting. RulesString *string - // An array of individual stateful rules inspection criteria to be used together in - // a stateful rule group. Use this option to specify simple Suricata rules with + // An array of individual stateful rules inspection criteria to be used together + // in a stateful rule group. Use this option to specify simple Suricata rules with // protocol, source and destination, ports, direction, and rule options. For - // information about the Suricata Rules format, see Rules Format - // (https://suricata.readthedocs.iorules/intro.html#). + // information about the Suricata Rules format, see Rules Format (https://suricata.readthedocs.iorules/intro.html#) + // . StatefulRules []StatefulRule // Stateless inspection criteria to be used in a stateless rule group. @@ -994,8 +948,7 @@ type RulesSource struct { // traffic from IP addresses outside of the deployment VPC, you set the HOME_NET // rule variable to include the CIDR range of the deployment VPC plus the other // CIDR ranges. For more information, see RuleVariables in this guide and Stateful -// domain list rule groups in Network Firewall -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) +// domain list rule groups in Network Firewall (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) // in the Network Firewall Developer Guide. type RulesSourceList struct { @@ -1004,22 +957,19 @@ type RulesSourceList struct { // This member is required. GeneratedRulesType GeneratedRulesType - // The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST - // for HTTP. You can specify either or both. + // The protocols you want to inspect. Specify TLS_SNI for HTTPS . Specify HTTP_HOST + // for HTTP . You can specify either or both. // // This member is required. TargetTypes []TargetType // The domains that you want to inspect for in your traffic flows. Valid domain // specifications are the following: - // - // * Explicit names. For example, - // abc.example.com matches only the domain abc.example.com. - // - // * Names that use a - // domain wildcard, which you indicate with an initial '.'. For - // example,.example.com matches example.com and matches all subdomains of - // example.com, such as abc.example.com and www.example.com. + // - Explicit names. For example, abc.example.com matches only the domain + // abc.example.com . + // - Names that use a domain wildcard, which you indicate with an initial ' . '. + // For example, .example.com matches example.com and matches all subdomains of + // example.com , such as abc.example.com and www.example.com . // // This member is required. Targets []string @@ -1042,15 +992,13 @@ type RuleVariables struct { // Any Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) // server certificate that's associated with a ServerCertificateConfiguration used -// in a TLSInspectionConfiguration. You must request or import a SSL/TLS +// in a TLSInspectionConfiguration . You must request or import a SSL/TLS // certificate into ACM for each domain Network Firewall needs to decrypt and // inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified // inbound SSL/TLS traffic going to your firewall. For information about working -// with certificates in Certificate Manager, see Request a public certificate -// (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) or -// Importing certificates -// (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in -// the Certificate Manager User Guide. +// with certificates in Certificate Manager, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) +// or Importing certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) +// in the Certificate Manager User Guide. type ServerCertificate struct { // The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server @@ -1062,10 +1010,9 @@ type ServerCertificate struct { // Configures the associated Certificate Manager Secure Sockets Layer/Transport // Layer Security (SSL/TLS) server certificates and scope settings Network Firewall -// uses to decrypt traffic in a TLSInspectionConfiguration. For information about -// working with SSL/TLS certificates for TLS inspection, see Requirements for -// using SSL/TLS server certficiates with TLS inspection configurations -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) +// uses to decrypt traffic in a TLSInspectionConfiguration . For information about +// working with SSL/TLS certificates for TLS inspection, see Requirements for +// using SSL/TLS server certficiates with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) // in the Network Firewall Developer Guide. If a server certificate that's // associated with your TLSInspectionConfiguration is revoked, deleted, or expired // it can result in client-side TLS errors. @@ -1081,15 +1028,15 @@ type ServerCertificateConfiguration struct { noSmithyDocumentSerde } -// Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) -// traffic that Network Firewall should decrypt for inspection by the stateful rule -// engine. +// Settings that define the Secure Sockets Layer/Transport Layer Security +// (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the +// stateful rule engine. type ServerCertificateScope struct { // The destination ports to decrypt for inspection, in Transmission Control // Protocol (TCP) format. If not specified, this matches with any destination port. - // You can specify individual ports, for example 1994, and you can specify port - // ranges, such as 1990:1994. + // You can specify individual ports, for example 1994 , and you can specify port + // ranges, such as 1990:1994 . DestinationPorts []PortRange // The destination IP addresses and address ranges to decrypt for inspection, in @@ -1103,8 +1050,8 @@ type ServerCertificateScope struct { // The source ports to decrypt for inspection, in Transmission Control Protocol // (TCP) format. If not specified, this matches with any source port. You can - // specify individual ports, for example 1994, and you can specify port ranges, - // such as 1990:1994. + // specify individual ports, for example 1994 , and you can specify port ranges, + // such as 1990:1994 . SourcePorts []PortRange // The source IP addresses and address ranges to decrypt for inspection, in CIDR @@ -1117,8 +1064,8 @@ type ServerCertificateScope struct { // High-level information about the managed rule group that your own rule group is // copied from. You can use the the metadata to track version updates made to the // originating rule group. You can retrieve all objects for a rule group by calling -// DescribeRuleGroup -// (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html). +// DescribeRuleGroup (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html) +// . type SourceMetadata struct { // The Amazon Resource Name (ARN) of the rule group that your own rule group is @@ -1127,8 +1074,8 @@ type SourceMetadata struct { // The update token of the Amazon Web Services managed rule group that your own // rule group is copied from. To determine the update token for the managed rule - // group, call DescribeRuleGroup - // (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken). + // group, call DescribeRuleGroup (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken) + // . SourceUpdateToken *string noSmithyDocumentSerde @@ -1141,27 +1088,23 @@ type StatefulEngineOptions struct { // Indicates how to manage the order of stateful rule evaluation for the policy. // DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the // rule engine as Suricata compatible strings, and Suricata evaluates them based on - // certain settings. For more information, see Evaluation order for stateful rules - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) + // certain settings. For more information, see Evaluation order for stateful rules (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) // in the Network Firewall Developer Guide. RuleOrder RuleOrder // Configures how Network Firewall processes traffic when a network connection // breaks midstream. Network connections can break due to disruptions in external // networks or within the firewall itself. - // - // * DROP - Network Firewall fails closed - // and drops all subsequent traffic going to the firewall. This is the default - // behavior. - // - // * CONTINUE - Network Firewall continues to apply rules to the - // subsequent traffic without context from traffic before the break. This impacts - // the behavior of rules that depend on this context. For example, if you have a - // stateful rule to drop http traffic, Network Firewall won't match the traffic for - // this rule because the service won't have the context from session initialization - // defining the application layer protocol as HTTP. However, this behavior is rule - // dependent—a TCP-layer rule using a flow:stateless rule would still match, as - // would the aws:drop_strict default action. + // - DROP - Network Firewall fails closed and drops all subsequent traffic going + // to the firewall. This is the default behavior. + // - CONTINUE - Network Firewall continues to apply rules to the subsequent + // traffic without context from traffic before the break. This impacts the behavior + // of rules that depend on this context. For example, if you have a stateful rule + // to drop http traffic, Network Firewall won't match the traffic for this rule + // because the service won't have the context from session initialization defining + // the application layer protocol as HTTP. However, this behavior is rule + // dependent—a TCP-layer rule using a flow:stateless rule would still match, as + // would the aws:drop_strict default action. StreamExceptionPolicy StreamExceptionPolicy noSmithyDocumentSerde @@ -1170,35 +1113,30 @@ type StatefulEngineOptions struct { // A single Suricata rules specification, for use in a stateful rule group. Use // this option to specify a simple Suricata rule with protocol, source and // destination, ports, direction, and rule options. For information about the -// Suricata Rules format, see Rules Format -// (https://suricata.readthedocs.iorules/intro.html#). +// Suricata Rules format, see Rules Format (https://suricata.readthedocs.iorules/intro.html#) +// . type StatefulRule struct { // Defines what Network Firewall should do with the packets in a traffic flow when // the flow matches the stateful rule criteria. For all actions, Network Firewall // performs the specified action and discontinues stateful inspection of the // traffic flow. The actions for a stateful rule are defined as follows: - // - // * PASS - - // Permits the packets to go to the intended destination. - // - // * DROP - Blocks the - // packets from going to the intended destination and sends an alert log message, - // if alert logging is configured in the FirewallLoggingConfiguration. - // - // * ALERT - - // Permits the packets to go to the intended destination and sends an alert log - // message, if alert logging is configured in the FirewallLoggingConfiguration. You - // can use this action to test a rule that you intend to use to drop traffic. You - // can enable the rule with ALERT action, verify in the logs that the rule is - // filtering as you want, then change the action to DROP. - // - // * REJECT - Drops TCP - // traffic that matches the conditions of the stateful rule, and sends a TCP reset - // packet back to sender of the packet. A TCP reset packet is a packet with no - // payload and a RST bit contained in the TCP header flags. Also sends an alert log - // mesage if alert logging is configured in the FirewallLoggingConfiguration. - // REJECT isn't currently available for use with IMAP and FTP protocols. + // - PASS - Permits the packets to go to the intended destination. + // - DROP - Blocks the packets from going to the intended destination and sends + // an alert log message, if alert logging is configured in the Firewall + // LoggingConfiguration . + // - ALERT - Permits the packets to go to the intended destination and sends an + // alert log message, if alert logging is configured in the Firewall + // LoggingConfiguration . You can use this action to test a rule that you intend + // to use to drop traffic. You can enable the rule with ALERT action, verify in + // the logs that the rule is filtering as you want, then change the action to + // DROP . + // - REJECT - Drops TCP traffic that matches the conditions of the stateful + // rule, and sends a TCP reset packet back to sender of the packet. A TCP reset + // packet is a packet with no payload and a RST bit contained in the TCP header + // flags. Also sends an alert log mesage if alert logging is configured in the + // Firewall LoggingConfiguration . REJECT isn't currently available for use with + // IMAP and FTP protocols. // // This member is required. Action StatefulAction @@ -1220,7 +1158,7 @@ type StatefulRule struct { // group within a policy. type StatefulRuleGroupOverride struct { - // The action that changes the rule group from DROP to ALERT. This only applies to + // The action that changes the rule group from DROP to ALERT . This only applies to // managed rule groups. Action OverrideAction @@ -1241,14 +1179,14 @@ type StatefulRuleGroupReference struct { Override *StatefulRuleGroupOverride // An integer setting that indicates the order in which to run the stateful rule - // groups in a single FirewallPolicy. This setting only applies to firewall - // policies that specify the STRICT_ORDER rule order in the stateful engine options - // settings. Network Firewall evalutes each stateful rule group against a packet - // starting with the group that has the lowest priority setting. You must ensure - // that the priority settings are unique within each policy. You can change the - // priority settings of your rule groups at any time. To make it easier to insert - // rule groups later, number them so there's a wide range in between, for example - // use 100, 200, and so on. + // groups in a single FirewallPolicy . This setting only applies to firewall + // policies that specify the STRICT_ORDER rule order in the stateful engine + // options settings. Network Firewall evalutes each stateful rule group against a + // packet starting with the group that has the lowest priority setting. You must + // ensure that the priority settings are unique within each policy. You can change + // the priority settings of your rule groups at any time. To make it easier to + // insert rule groups later, number them so there's a wide range in between, for + // example use 100, 200, and so on. Priority *int32 noSmithyDocumentSerde @@ -1261,15 +1199,14 @@ type StatefulRuleOptions struct { // Indicates how to manage the order of the rule evaluation for the rule group. // DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the // rule engine as Suricata compatible strings, and Suricata evaluates them based on - // certain settings. For more information, see Evaluation order for stateful rules - // (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) + // certain settings. For more information, see Evaluation order for stateful rules (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) // in the Network Firewall Developer Guide. RuleOrder RuleOrder noSmithyDocumentSerde } -// A single stateless rule. This is used in StatelessRulesAndCustomActions. +// A single stateless rule. This is used in StatelessRulesAndCustomActions . type StatelessRule struct { // Indicates the order in which to run this rule relative to all of the rules that @@ -1279,10 +1216,10 @@ type StatelessRule struct { // exactly one StatelessRulesAndCustomActions object, and each // StatelessRulesAndCustomActions contains exactly one StatelessRules object. To // ensure unique priority settings for your rule groups, set unique priorities for - // the stateless rules that you define inside any single StatelessRules object. You - // can change the priority settings of your rules at any time. To make it easier to - // insert rules later, number them so there's a wide range in between, for example - // use 100, 200, and so on. + // the stateless rules that you define inside any single StatelessRules object. + // You can change the priority settings of your rules at any time. To make it + // easier to insert rules later, number them so there's a wide range in between, + // for example use 100, 200, and so on. // // This member is required. Priority int32 @@ -1296,12 +1233,12 @@ type StatelessRule struct { noSmithyDocumentSerde } -// Identifier for a single stateless rule group, used in a firewall policy to refer -// to the rule group. +// Identifier for a single stateless rule group, used in a firewall policy to +// refer to the rule group. type StatelessRuleGroupReference struct { // An integer setting that indicates the order in which to run the stateless rule - // groups in a single FirewallPolicy. Network Firewall applies each stateless rule + // groups in a single FirewallPolicy . Network Firewall applies each stateless rule // group to a packet starting with the group that has the lowest priority setting. // You must ensure that the priority settings are unique within each policy. // @@ -1326,16 +1263,16 @@ type StatelessRulesAndCustomActions struct { StatelessRules []StatelessRule // Defines an array of individual custom action definitions that are available for - // use by the stateless rules in this StatelessRulesAndCustomActions specification. - // You name each custom action that you define, and then you can use it by name in - // your StatelessRuleRuleDefinitionActions specification. + // use by the stateless rules in this StatelessRulesAndCustomActions + // specification. You name each custom action that you define, and then you can use + // it by name in your StatelessRule RuleDefinition Actions specification. CustomActions []CustomAction noSmithyDocumentSerde } // The ID for a subnet that you want to associate with the firewall. This is used -// with CreateFirewall and AssociateSubnets. Network Firewall creates an instance +// with CreateFirewall and AssociateSubnets . Network Firewall creates an instance // of the associated firewall in each subnet that you specify, to filter traffic in // the subnet's Availability Zone. type SubnetMapping struct { @@ -1355,30 +1292,26 @@ type SubnetMapping struct { // The status of the firewall endpoint and firewall policy configuration for a // single VPC subnet. For each VPC subnet that you associate with a firewall, // Network Firewall does the following: +// - Instantiates a firewall endpoint in the subnet, ready to take traffic. +// - Configures the endpoint with the current firewall policy settings, to +// provide the filtering behavior for the endpoint. // -// * Instantiates a firewall endpoint in the -// subnet, ready to take traffic. -// -// * Configures the endpoint with the current -// firewall policy settings, to provide the filtering behavior for the -// endpoint. -// -// When you update a firewall, for example to add a subnet association -// or change a rule group in the firewall policy, the affected sync states reflect -// out-of-sync or not ready status until the changes are complete. +// When you update a firewall, for example to add a subnet association or change a +// rule group in the firewall policy, the affected sync states reflect out-of-sync +// or not ready status until the changes are complete. type SyncState struct { // The attachment status of the firewall's association with a single VPC subnet. // For each configured subnet, Network Firewall creates the attachment by // instantiating the firewall endpoint in the subnet so that it's ready to take - // traffic. This is part of the FirewallStatus. + // traffic. This is part of the FirewallStatus . Attachment *Attachment // The configuration status of the firewall endpoint in a single VPC subnet. // Network Firewall provides each endpoint with the rules that are configured in // the firewall policy. Each time you add a subnet or modify the associated // firewall policy, Network Firewall synchronizes the rules in the endpoint, so it - // can properly filter network traffic. This is part of the FirewallStatus. + // can properly filter network traffic. This is part of the FirewallStatus . Config map[string]PerObjectStatus noSmithyDocumentSerde @@ -1417,12 +1350,9 @@ type TCPFlagField struct { // can only specify values that are also specified in the Masks setting. For the // flags that are specified in the masks setting, the following must be true for // the packet to match: - // - // * The ones that are set in this flags setting must be set - // in the packet. - // - // * The ones that are not set in this flags setting must also not - // be set in the packet. + // - The ones that are set in this flags setting must be set in the packet. + // - The ones that are not set in this flags setting must also not be set in the + // packet. // // This member is required. Flags []TCPFlag @@ -1454,9 +1384,9 @@ type TlsCertificateData struct { } // The object that defines a TLS inspection configuration. This, along with -// TLSInspectionConfigurationResponse, define the TLS inspection configuration. You -// can retrieve all objects for a TLS inspection configuration by calling -// DescribeTLSInspectionConfiguration. Network Firewall uses a TLS inspection +// TLSInspectionConfigurationResponse , define the TLS inspection configuration. +// You can retrieve all objects for a TLS inspection configuration by calling +// DescribeTLSInspectionConfiguration . Network Firewall uses a TLS inspection // configuration to decrypt traffic. Network Firewall re-encrypts the traffic // before sending it to its destination. To use a TLS inspection configuration, you // add it to a Network Firewall firewall policy, then you apply the firewall policy @@ -1464,8 +1394,7 @@ type TlsCertificateData struct { // inbound traffic. You can reference a TLS inspection configuration from more than // one firewall policy, and you can use a firewall policy in more than one // firewall. For more information about using TLS inspection configurations, see -// Decrypting SSL/TLS traffic with TLS inspection configurations -// (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) +// Decrypting SSL/TLS traffic with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) // in the Network Firewall Developer Guide. type TLSInspectionConfiguration struct { @@ -1477,7 +1406,7 @@ type TLSInspectionConfiguration struct { } // High-level information about a TLS inspection configuration, returned by -// ListTLSInspectionConfigurations. You can use the information provided in the +// ListTLSInspectionConfigurations . You can use the information provided in the // metadata to retrieve and manage a TLS configuration. type TLSInspectionConfigurationMetadata struct { @@ -1492,9 +1421,9 @@ type TLSInspectionConfigurationMetadata struct { } // The high-level properties of a TLS inspection configuration. This, along with -// the TLSInspectionConfiguration, define the TLS inspection configuration. You can -// retrieve all objects for a TLS inspection configuration by calling -// DescribeTLSInspectionConfiguration. +// the TLSInspectionConfiguration , define the TLS inspection configuration. You +// can retrieve all objects for a TLS inspection configuration by calling +// DescribeTLSInspectionConfiguration . type TLSInspectionConfigurationResponse struct { // The Amazon Resource Name (ARN) of the TLS inspection configuration. @@ -1502,9 +1431,9 @@ type TLSInspectionConfigurationResponse struct { // This member is required. TLSInspectionConfigurationArn *string - // A unique identifier for the TLS inspection configuration. This ID is returned in - // the responses to create and list commands. You provide it to operations such as - // update and delete. + // A unique identifier for the TLS inspection configuration. This ID is returned + // in the responses to create and list commands. You provide it to operations such + // as update and delete. // // This member is required. TLSInspectionConfigurationId *string @@ -1531,7 +1460,7 @@ type TLSInspectionConfigurationResponse struct { // The number of firewall policies that use this TLS inspection configuration. NumberOfAssociations *int32 - // Detailed information about the current status of a TLSInspectionConfiguration. + // Detailed information about the current status of a TLSInspectionConfiguration . // You can retrieve this for a TLS inspection configuration by calling // DescribeTLSInspectionConfiguration and providing the TLS inspection // configuration name and ARN. diff --git a/service/networkmanager/api_client.go b/service/networkmanager/api_client.go index eebd61c9e73..90aa5055c20 100644 --- a/service/networkmanager/api_client.go +++ b/service/networkmanager/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/networkmanager/api_op_AssociateCustomerGateway.go b/service/networkmanager/api_op_AssociateCustomerGateway.go index fa112b855a3..473c5e2fe31 100644 --- a/service/networkmanager/api_op_AssociateCustomerGateway.go +++ b/service/networkmanager/api_op_AssociateCustomerGateway.go @@ -18,9 +18,8 @@ import ( // transit gateway or core network, customer gateways that are connected to the // transit gateway are automatically included in the global network. To list // customer gateways that are connected to a transit gateway, use the -// DescribeVpnConnections -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) -// EC2 API and filter by transit-gateway-id. You cannot associate a customer +// DescribeVpnConnections (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) +// EC2 API and filter by transit-gateway-id . You cannot associate a customer // gateway with more than one device and link. func (c *Client) AssociateCustomerGateway(ctx context.Context, params *AssociateCustomerGatewayInput, optFns ...func(*Options)) (*AssociateCustomerGatewayOutput, error) { if params == nil { diff --git a/service/networkmanager/api_op_CreateSite.go b/service/networkmanager/api_op_CreateSite.go index c1569a5220a..a4c77dee570 100644 --- a/service/networkmanager/api_op_CreateSite.go +++ b/service/networkmanager/api_op_CreateSite.go @@ -40,13 +40,9 @@ type CreateSiteInput struct { // The site location. This information is used for visualization in the Network // Manager console. If you specify the address, the latitude and longitude are // automatically calculated. - // - // * Address: The physical address of the site. - // - // * - // Latitude: The latitude of the site. - // - // * Longitude: The longitude of the site. + // - Address : The physical address of the site. + // - Latitude : The latitude of the site. + // - Longitude : The longitude of the site. Location *types.Location // The tags to apply to the resource during creation. diff --git a/service/networkmanager/api_op_CreateTransitGatewayRouteTableAttachment.go b/service/networkmanager/api_op_CreateTransitGatewayRouteTableAttachment.go index 13317718da0..696416858be 100644 --- a/service/networkmanager/api_op_CreateTransitGatewayRouteTableAttachment.go +++ b/service/networkmanager/api_op_CreateTransitGatewayRouteTableAttachment.go @@ -37,7 +37,8 @@ type CreateTransitGatewayRouteTableAttachmentInput struct { // The ARN of the transit gateway route table for the attachment request. For // example, "TransitGatewayRouteTableArn": - // "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456". + // "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456" + // . // // This member is required. TransitGatewayRouteTableArn *string diff --git a/service/networkmanager/api_op_DeleteResourcePolicy.go b/service/networkmanager/api_op_DeleteResourcePolicy.go index b7caade1ebf..82e018a9441 100644 --- a/service/networkmanager/api_op_DeleteResourcePolicy.go +++ b/service/networkmanager/api_op_DeleteResourcePolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a resource policy for the specified resource. This revokes the access of -// the principals specified in the resource policy. +// Deletes a resource policy for the specified resource. This revokes the access +// of the principals specified in the resource policy. func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} diff --git a/service/networkmanager/api_op_DescribeGlobalNetworks.go b/service/networkmanager/api_op_DescribeGlobalNetworks.go index 730971c3df8..44540fab92c 100644 --- a/service/networkmanager/api_op_DescribeGlobalNetworks.go +++ b/service/networkmanager/api_op_DescribeGlobalNetworks.go @@ -15,7 +15,7 @@ import ( // Describes one or more global networks. By default, all global networks are // described. To describe the objects in your global network, you must use the // appropriate Get* action. For example, to list the transit gateways in your -// global network, use GetTransitGatewayRegistrations. +// global network, use GetTransitGatewayRegistrations . func (c *Client) DescribeGlobalNetworks(ctx context.Context, params *DescribeGlobalNetworksInput, optFns ...func(*Options)) (*DescribeGlobalNetworksOutput, error) { if params == nil { params = &DescribeGlobalNetworksInput{} diff --git a/service/networkmanager/api_op_GetCoreNetworkChangeEvents.go b/service/networkmanager/api_op_GetCoreNetworkChangeEvents.go index a843a953f57..b8e09afdb71 100644 --- a/service/networkmanager/api_op_GetCoreNetworkChangeEvents.go +++ b/service/networkmanager/api_op_GetCoreNetworkChangeEvents.go @@ -51,7 +51,7 @@ type GetCoreNetworkChangeEventsInput struct { type GetCoreNetworkChangeEventsOutput struct { - // The response to GetCoreNetworkChangeEventsRequest. + // The response to GetCoreNetworkChangeEventsRequest . CoreNetworkChangeEvents []types.CoreNetworkChangeEvent // The token for the next page of results. diff --git a/service/networkmanager/api_op_GetLinkAssociations.go b/service/networkmanager/api_op_GetLinkAssociations.go index 85e4107a077..b3c474a1166 100644 --- a/service/networkmanager/api_op_GetLinkAssociations.go +++ b/service/networkmanager/api_op_GetLinkAssociations.go @@ -128,8 +128,8 @@ func (c *Client) addOperationGetLinkAssociationsMiddlewares(stack *middleware.St return nil } -// GetLinkAssociationsAPIClient is a client that implements the GetLinkAssociations -// operation. +// GetLinkAssociationsAPIClient is a client that implements the +// GetLinkAssociations operation. type GetLinkAssociationsAPIClient interface { GetLinkAssociations(context.Context, *GetLinkAssociationsInput, ...func(*Options)) (*GetLinkAssociationsOutput, error) } diff --git a/service/networkmanager/api_op_GetNetworkResourceCounts.go b/service/networkmanager/api_op_GetNetworkResourceCounts.go index 3cffabb533a..15b4703ad01 100644 --- a/service/networkmanager/api_op_GetNetworkResourceCounts.go +++ b/service/networkmanager/api_op_GetNetworkResourceCounts.go @@ -44,40 +44,21 @@ type GetNetworkResourceCountsInput struct { // The resource type. The following are the supported resource types for Direct // Connect: - // - // * dxcon - // - // * dx-gateway - // - // * dx-vif - // - // The following are the supported - // resource types for Network Manager: - // - // * connection - // - // * device - // - // * link - // - // * site - // - // The - // following are the supported resource types for Amazon VPC: - // - // * - // customer-gateway - // - // * transit-gateway - // - // * transit-gateway-attachment - // - // * - // transit-gateway-connect-peer - // - // * transit-gateway-route-table - // - // * vpn-connection + // - dxcon + // - dx-gateway + // - dx-vif + // The following are the supported resource types for Network Manager: + // - connection + // - device + // - link + // - site + // The following are the supported resource types for Amazon VPC: + // - customer-gateway + // - transit-gateway + // - transit-gateway-attachment + // - transit-gateway-connect-peer + // - transit-gateway-route-table + // - vpn-connection ResourceType *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_GetNetworkResourceRelationships.go b/service/networkmanager/api_op_GetNetworkResourceRelationships.go index 31ed5ce0bb5..4d5e631efc3 100644 --- a/service/networkmanager/api_op_GetNetworkResourceRelationships.go +++ b/service/networkmanager/api_op_GetNetworkResourceRelationships.go @@ -58,40 +58,21 @@ type GetNetworkResourceRelationshipsInput struct { // The resource type. The following are the supported resource types for Direct // Connect: - // - // * dxcon - // - // * dx-gateway - // - // * dx-vif - // - // The following are the supported - // resource types for Network Manager: - // - // * connection - // - // * device - // - // * link - // - // * site - // - // The - // following are the supported resource types for Amazon VPC: - // - // * - // customer-gateway - // - // * transit-gateway - // - // * transit-gateway-attachment - // - // * - // transit-gateway-connect-peer - // - // * transit-gateway-route-table - // - // * vpn-connection + // - dxcon + // - dx-gateway + // - dx-vif + // The following are the supported resource types for Network Manager: + // - connection + // - device + // - link + // - site + // The following are the supported resource types for Amazon VPC: + // - customer-gateway + // - transit-gateway + // - transit-gateway-attachment + // - transit-gateway-connect-peer + // - transit-gateway-route-table + // - vpn-connection ResourceType *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_GetNetworkResources.go b/service/networkmanager/api_op_GetNetworkResources.go index 01d066953b3..dad36339404 100644 --- a/service/networkmanager/api_op_GetNetworkResources.go +++ b/service/networkmanager/api_op_GetNetworkResources.go @@ -60,63 +60,37 @@ type GetNetworkResourcesInput struct { // The resource type. The following are the supported resource types for Direct // Connect: - // - // * dxcon - The definition model is Connection - // (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Connection.html). - // - // * - // dx-gateway - The definition model is DirectConnectGateway - // (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGateway.html). - // - // * - // dx-vif - The definition model is VirtualInterface - // (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterface.html). - // - // The - // following are the supported resource types for Network Manager: - // - // * connection - - // The definition model is Connection - // (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Connection.html). - // - // * - // device - The definition model is Device - // (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Device.html). - // - // * - // link - The definition model is Link - // (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Link.html). - // - // * - // site - The definition model is Site - // (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Site.html). - // - // The - // following are the supported resource types for Amazon VPC: - // - // * customer-gateway - - // The definition model is CustomerGateway - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CustomerGateway.html). - // - // * - // transit-gateway - The definition model is TransitGateway - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGateway.html). - // - // * - // transit-gateway-attachment - The definition model is TransitGatewayAttachment - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayAttachment.html). - // - // * - // transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayConnectPeer.html). - // - // * - // transit-gateway-route-table - The definition model is TransitGatewayRouteTable - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayRouteTable.html). - // - // * - // vpn-connection - The definition model is VpnConnection - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpnConnection.html). + // - dxcon - The definition model is Connection (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Connection.html) + // . + // - dx-gateway - The definition model is DirectConnectGateway (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGateway.html) + // . + // - dx-vif - The definition model is VirtualInterface (https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterface.html) + // . + // The following are the supported resource types for Network Manager: + // - connection - The definition model is Connection (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Connection.html) + // . + // - device - The definition model is Device (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Device.html) + // . + // - link - The definition model is Link (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Link.html) + // . + // - site - The definition model is Site (https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Site.html) + // . + // The following are the supported resource types for Amazon VPC: + // - customer-gateway - The definition model is CustomerGateway (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CustomerGateway.html) + // . + // - transit-gateway - The definition model is TransitGateway (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGateway.html) + // . + // - transit-gateway-attachment - The definition model is + // TransitGatewayAttachment (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayAttachment.html) + // . + // - transit-gateway-connect-peer - The definition model is + // TransitGatewayConnectPeer (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayConnectPeer.html) + // . + // - transit-gateway-route-table - The definition model is + // TransitGatewayRouteTable (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayRouteTable.html) + // . + // - vpn-connection - The definition model is VpnConnection (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpnConnection.html) + // . ResourceType *string noSmithyDocumentSerde @@ -199,8 +173,8 @@ func (c *Client) addOperationGetNetworkResourcesMiddlewares(stack *middleware.St return nil } -// GetNetworkResourcesAPIClient is a client that implements the GetNetworkResources -// operation. +// GetNetworkResourcesAPIClient is a client that implements the +// GetNetworkResources operation. type GetNetworkResourcesAPIClient interface { GetNetworkResources(context.Context, *GetNetworkResourcesInput, ...func(*Options)) (*GetNetworkResourcesOutput, error) } diff --git a/service/networkmanager/api_op_GetNetworkRoutes.go b/service/networkmanager/api_op_GetNetworkRoutes.go index 3f326a5b04e..4612eaae280 100644 --- a/service/networkmanager/api_op_GetNetworkRoutes.go +++ b/service/networkmanager/api_op_GetNetworkRoutes.go @@ -59,8 +59,8 @@ type GetNetworkRoutesInput struct { // The routes with a subnet that match the specified CIDR filter. SubnetOfMatches []string - // The routes with a CIDR that encompasses the CIDR filter. Example: If you specify - // 10.0.1.0/30, then the result returns 10.0.1.0/29. + // The routes with a CIDR that encompasses the CIDR filter. Example: If you + // specify 10.0.1.0/30, then the result returns 10.0.1.0/29. SupernetOfMatches []string // The route types. diff --git a/service/networkmanager/api_op_GetNetworkTelemetry.go b/service/networkmanager/api_op_GetNetworkTelemetry.go index 363b0b79f6d..cab84dd2f3c 100644 --- a/service/networkmanager/api_op_GetNetworkTelemetry.go +++ b/service/networkmanager/api_op_GetNetworkTelemetry.go @@ -58,40 +58,21 @@ type GetNetworkTelemetryInput struct { // The resource type. The following are the supported resource types for Direct // Connect: - // - // * dxcon - // - // * dx-gateway - // - // * dx-vif - // - // The following are the supported - // resource types for Network Manager: - // - // * connection - // - // * device - // - // * link - // - // * site - // - // The - // following are the supported resource types for Amazon VPC: - // - // * - // customer-gateway - // - // * transit-gateway - // - // * transit-gateway-attachment - // - // * - // transit-gateway-connect-peer - // - // * transit-gateway-route-table - // - // * vpn-connection + // - dxcon + // - dx-gateway + // - dx-vif + // The following are the supported resource types for Network Manager: + // - connection + // - device + // - link + // - site + // The following are the supported resource types for Amazon VPC: + // - customer-gateway + // - transit-gateway + // - transit-gateway-attachment + // - transit-gateway-connect-peer + // - transit-gateway-route-table + // - vpn-connection ResourceType *string noSmithyDocumentSerde @@ -174,8 +155,8 @@ func (c *Client) addOperationGetNetworkTelemetryMiddlewares(stack *middleware.St return nil } -// GetNetworkTelemetryAPIClient is a client that implements the GetNetworkTelemetry -// operation. +// GetNetworkTelemetryAPIClient is a client that implements the +// GetNetworkTelemetry operation. type GetNetworkTelemetryAPIClient interface { GetNetworkTelemetry(context.Context, *GetNetworkTelemetryInput, ...func(*Options)) (*GetNetworkTelemetryOutput, error) } diff --git a/service/networkmanager/api_op_GetTransitGatewayRegistrations.go b/service/networkmanager/api_op_GetTransitGatewayRegistrations.go index 0f747fcd635..bb8b5d2320b 100644 --- a/service/networkmanager/api_op_GetTransitGatewayRegistrations.go +++ b/service/networkmanager/api_op_GetTransitGatewayRegistrations.go @@ -42,8 +42,8 @@ type GetTransitGatewayRegistrationsInput struct { // The token for the next page of results. NextToken *string - // The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is - // 10. + // The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum + // is 10. TransitGatewayArns []string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_RegisterTransitGateway.go b/service/networkmanager/api_op_RegisterTransitGateway.go index 3f4798cdf0a..d3e59f94fca 100644 --- a/service/networkmanager/api_op_RegisterTransitGateway.go +++ b/service/networkmanager/api_op_RegisterTransitGateway.go @@ -13,8 +13,7 @@ import ( // Registers a transit gateway in your global network. Not all Regions support // transit gateways for global networks. For a list of the supported Regions, see -// Region Availability -// (https://docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions) +// Region Availability (https://docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions) // in the Amazon Web Services Transit Gateways for Global Networks User Guide. The // transit gateway can be in any of the supported Amazon Web Services Regions, but // it must be owned by the same Amazon Web Services account that owns the global diff --git a/service/networkmanager/api_op_RestoreCoreNetworkPolicyVersion.go b/service/networkmanager/api_op_RestoreCoreNetworkPolicyVersion.go index 3f0b923b00f..ff1617b9123 100644 --- a/service/networkmanager/api_op_RestoreCoreNetworkPolicyVersion.go +++ b/service/networkmanager/api_op_RestoreCoreNetworkPolicyVersion.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restores a previous policy version as a new, immutable version of a core network -// policy. A subsequent change set is created showing the differences between the -// LIVE policy and restored policy. +// Restores a previous policy version as a new, immutable version of a core +// network policy. A subsequent change set is created showing the differences +// between the LIVE policy and restored policy. func (c *Client) RestoreCoreNetworkPolicyVersion(ctx context.Context, params *RestoreCoreNetworkPolicyVersionInput, optFns ...func(*Options)) (*RestoreCoreNetworkPolicyVersionOutput, error) { if params == nil { params = &RestoreCoreNetworkPolicyVersionInput{} diff --git a/service/networkmanager/api_op_StartOrganizationServiceAccessUpdate.go b/service/networkmanager/api_op_StartOrganizationServiceAccessUpdate.go index 75af345b896..3cae2adc1cd 100644 --- a/service/networkmanager/api_op_StartOrganizationServiceAccessUpdate.go +++ b/service/networkmanager/api_op_StartOrganizationServiceAccessUpdate.go @@ -30,7 +30,7 @@ func (c *Client) StartOrganizationServiceAccessUpdate(ctx context.Context, param type StartOrganizationServiceAccessUpdateInput struct { - // The action to take for the update request. This can be either ENABLE or DISABLE. + // The action to take for the update request. This can be either ENABLE or DISABLE . // // This member is required. Action *string diff --git a/service/networkmanager/api_op_StartRouteAnalysis.go b/service/networkmanager/api_op_StartRouteAnalysis.go index 018b78da9cf..4e949a4b540 100644 --- a/service/networkmanager/api_op_StartRouteAnalysis.go +++ b/service/networkmanager/api_op_StartRouteAnalysis.go @@ -12,8 +12,8 @@ import ( ) // Starts analyzing the routing path between the specified source and destination. -// For more information, see Route Analyzer -// (https://docs.aws.amazon.com/vpc/latest/tgw/route-analyzer.html). +// For more information, see Route Analyzer (https://docs.aws.amazon.com/vpc/latest/tgw/route-analyzer.html) +// . func (c *Client) StartRouteAnalysis(ctx context.Context, params *StartRouteAnalysisInput, optFns ...func(*Options)) (*StartRouteAnalysisOutput, error) { if params == nil { params = &StartRouteAnalysisInput{} @@ -46,11 +46,11 @@ type StartRouteAnalysisInput struct { // This member is required. Source *types.RouteAnalysisEndpointOptionsSpecification - // Indicates whether to analyze the return path. The default is false. + // Indicates whether to analyze the return path. The default is false . IncludeReturnPath bool // Indicates whether to include the location of middlebox appliances in the route - // analysis. The default is false. + // analysis. The default is false . UseMiddleboxes bool noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_UpdateDevice.go b/service/networkmanager/api_op_UpdateDevice.go index 7f70fedfbb0..6c28a6a6fff 100644 --- a/service/networkmanager/api_op_UpdateDevice.go +++ b/service/networkmanager/api_op_UpdateDevice.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details for an existing device. To remove information for any of the -// parameters, specify an empty string. +// Updates the details for an existing device. To remove information for any of +// the parameters, specify an empty string. func (c *Client) UpdateDevice(ctx context.Context, params *UpdateDeviceInput, optFns ...func(*Options)) (*UpdateDeviceOutput, error) { if params == nil { params = &UpdateDeviceInput{} diff --git a/service/networkmanager/api_op_UpdateSite.go b/service/networkmanager/api_op_UpdateSite.go index 28d0d86eef7..0a4ac9760af 100644 --- a/service/networkmanager/api_op_UpdateSite.go +++ b/service/networkmanager/api_op_UpdateSite.go @@ -44,13 +44,9 @@ type UpdateSiteInput struct { Description *string // The site location: - // - // * Address: The physical address of the site. - // - // * Latitude: - // The latitude of the site. - // - // * Longitude: The longitude of the site. + // - Address : The physical address of the site. + // - Latitude : The latitude of the site. + // - Longitude : The longitude of the site. Location *types.Location noSmithyDocumentSerde diff --git a/service/networkmanager/types/enums.go b/service/networkmanager/types/enums.go index b3c5a7db95a..59511b30887 100644 --- a/service/networkmanager/types/enums.go +++ b/service/networkmanager/types/enums.go @@ -65,9 +65,9 @@ const ( ChangeActionRemove ChangeAction = "REMOVE" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "ADD", @@ -112,9 +112,9 @@ const ( ChangeStatusFailed ChangeStatus = "FAILED" ) -// Values returns all known values for ChangeStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeStatus) Values() []ChangeStatus { return []ChangeStatus{ "NOT_STARTED", @@ -397,9 +397,9 @@ const ( LinkStateUpdating LinkState = "UPDATING" ) -// Values returns all known values for LinkState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LinkState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LinkState) Values() []LinkState { return []LinkState{ "PENDING", @@ -419,9 +419,9 @@ const ( PeeringStateDeleting PeeringState = "DELETING" ) -// Values returns all known values for PeeringState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PeeringState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PeeringState) Values() []PeeringState { return []PeeringState{ "CREATING", @@ -464,8 +464,8 @@ const ( RouteAnalysisCompletionReasonCodeNoDestinationArnProvided RouteAnalysisCompletionReasonCode = "NO_DESTINATION_ARN_PROVIDED" ) -// Values returns all known values for RouteAnalysisCompletionReasonCode. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for RouteAnalysisCompletionReasonCode. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (RouteAnalysisCompletionReasonCode) Values() []RouteAnalysisCompletionReasonCode { @@ -492,8 +492,8 @@ const ( RouteAnalysisCompletionResultCodeNotConnected RouteAnalysisCompletionResultCode = "NOT_CONNECTED" ) -// Values returns all known values for RouteAnalysisCompletionResultCode. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for RouteAnalysisCompletionResultCode. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (RouteAnalysisCompletionResultCode) Values() []RouteAnalysisCompletionResultCode { @@ -567,9 +567,9 @@ const ( RouteTypeStatic RouteType = "STATIC" ) -// Values returns all known values for RouteType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RouteType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RouteType) Values() []RouteType { return []RouteType{ "PROPAGATED", @@ -587,9 +587,9 @@ const ( SiteStateUpdating SiteState = "UPDATING" ) -// Values returns all known values for SiteState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SiteState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SiteState) Values() []SiteState { return []SiteState{ "PENDING", diff --git a/service/networkmanager/types/types.go b/service/networkmanager/types/types.go index 091533900d6..06abc6c740b 100644 --- a/service/networkmanager/types/types.go +++ b/service/networkmanager/types/types.go @@ -339,9 +339,9 @@ type CoreNetworkChange struct { // The resource identifier. Identifier *string - // Uniquely identifies the path for a change within the changeset. For example, the - // IdentifierPath for a core network segment change might be - // "CORE_NETWORK_SEGMENT/us-east-1/devsegment". + // Uniquely identifies the path for a change within the changeset. For example, + // the IdentifierPath for a core network segment change might be + // "CORE_NETWORK_SEGMENT/us-east-1/devsegment" . IdentifierPath *string // The new value for a core network @@ -366,9 +366,9 @@ type CoreNetworkChangeEvent struct { // The timestamp for an event change in status. EventTime *time.Time - // Uniquely identifies the path for a change within the changeset. For example, the - // IdentifierPath for a core network segment change might be - // "CORE_NETWORK_SEGMENT/us-east-1/devsegment". + // Uniquely identifies the path for a change within the changeset. For example, + // the IdentifierPath for a core network segment change might be + // "CORE_NETWORK_SEGMENT/us-east-1/devsegment" . IdentifierPath *string // The status of the core network change event. @@ -778,40 +778,21 @@ type NetworkResource struct { // The resource type. The following are the supported resource types for Direct // Connect: - // - // * dxcon - // - // * dx-gateway - // - // * dx-vif - // - // The following are the supported - // resource types for Network Manager: - // - // * connection - // - // * device - // - // * link - // - // * site - // - // The - // following are the supported resource types for Amazon VPC: - // - // * - // customer-gateway - // - // * transit-gateway - // - // * transit-gateway-attachment - // - // * - // transit-gateway-connect-peer - // - // * transit-gateway-route-table - // - // * vpn-connection + // - dxcon + // - dx-gateway + // - dx-vif + // The following are the supported resource types for Network Manager: + // - connection + // - device + // - link + // - site + // The following are the supported resource types for Amazon VPC: + // - customer-gateway + // - transit-gateway + // - transit-gateway-attachment + // - transit-gateway-connect-peer + // - transit-gateway-route-table + // - vpn-connection ResourceType *string // The tags. @@ -869,10 +850,10 @@ type NetworkRoute struct { // The ID of the prefix list. PrefixListId *string - // The route state. The possible values are active and blackhole. + // The route state. The possible values are active and blackhole . State RouteState - // The route type. The possible values are propagated and static. + // The route type. The possible values are propagated and static . Type RouteType noSmithyDocumentSerde @@ -940,18 +921,18 @@ type NetworkTelemetry struct { type OrganizationStatus struct { // The current service-linked role (SLR) deployment status for an Amazon Web - // Services Organization's accounts. This will be either SUCCEEDED or IN_PROGRESS. + // Services Organization's accounts. This will be either SUCCEEDED or IN_PROGRESS . AccountStatusList []AccountStatus // The status of the organization's AWS service access. This will be ENABLED or - // DISABLED. + // DISABLED . OrganizationAwsServiceAccessStatus *string // The ID of an Amazon Web Services Organization. OrganizationId *string // The status of the SLR deployment for the account. This will be either SUCCEEDED - // or IN_PROGRESS. + // or IN_PROGRESS . SLRDeploymentStatus *string noSmithyDocumentSerde @@ -993,7 +974,7 @@ type Peering struct { // The ID of the peering attachment. PeeringId *string - // The type of peering. This will be TRANSIT_GATEWAY. + // The type of peering. This will be TRANSIT_GATEWAY . PeeringType PeeringType // The resource ARN of the peer. @@ -1048,8 +1029,8 @@ type RouteAnalysis struct { // The ID of the global network. GlobalNetworkId *string - // Indicates whether to analyze the return path. The return path is not analyzed if - // the forward path analysis does not succeed. + // Indicates whether to analyze the return path. The return path is not analyzed + // if the forward path analysis does not succeed. IncludeReturnPath bool // The ID of the AWS account that created the route analysis. @@ -1081,42 +1062,29 @@ type RouteAnalysis struct { type RouteAnalysisCompletion struct { // The reason code. Available only if a connection is not found. - // - // * - // BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the - // destination CIDR block. - // - // * CYCLIC_PATH_DETECTED - Found the same resource - // multiple times while traversing the path. - // - // * - // INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the - // destination CIDR block. - // - // * MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without - // finding the destination. - // - // * ROUTE_NOT_FOUND - Cannot find a route table with the - // destination CIDR block. - // - // * TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but - // not with the correct destination ARN. - // - // * TGW_ATTACH_NOT_FOUND - Cannot find an - // attachment. - // - // * TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the - // correct transit gateway. - // - // * TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state - // of the route table association is not associated. + // - BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the + // destination CIDR block. + // - CYCLIC_PATH_DETECTED - Found the same resource multiple times while + // traversing the path. + // - INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the + // destination CIDR block. + // - MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the + // destination. + // - ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block. + // - TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct + // destination ARN. + // - TGW_ATTACH_NOT_FOUND - Cannot find an attachment. + // - TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit + // gateway. + // - TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table + // association is not associated. ReasonCode RouteAnalysisCompletionReasonCode // Additional information about the path. Available only if a connection is not // found. ReasonContext map[string]string - // The result of the analysis. If the status is NOT_CONNECTED, check the reason + // The result of the analysis. If the status is NOT_CONNECTED , check the reason // code. ResultCode RouteAnalysisCompletionResultCode @@ -1302,7 +1270,8 @@ type TransitGatewayRouteTableAttachment struct { // The ARN of the transit gateway attachment route table. For example, // "TransitGatewayRouteTableArn": - // "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456". + // "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456" + // . TransitGatewayRouteTableArn *string noSmithyDocumentSerde @@ -1344,7 +1313,7 @@ type VpcOptions struct { // Indicates whether appliance mode is supported. If enabled, traffic flow between // a source and destination use the same Availability Zone for the VPC attachment - // for the lifetime of that flow. The default value is false. + // for the lifetime of that flow. The default value is false . ApplianceModeSupport bool // Indicates whether IPv6 is supported. diff --git a/service/nimble/api_client.go b/service/nimble/api_client.go index 021fddaaf54..48babf23af7 100644 --- a/service/nimble/api_client.go +++ b/service/nimble/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/nimble/api_op_CreateLaunchProfile.go b/service/nimble/api_op_CreateLaunchProfile.go index 01628c2a8ec..4bb69947302 100644 --- a/service/nimble/api_op_CreateLaunchProfile.go +++ b/service/nimble/api_op_CreateLaunchProfile.go @@ -30,8 +30,8 @@ func (c *Client) CreateLaunchProfile(ctx context.Context, params *CreateLaunchPr type CreateLaunchProfileInput struct { - // Specifies the IDs of the EC2 subnets where streaming sessions will be accessible - // from. These subnets must support the specified instance types. + // Specifies the IDs of the EC2 subnets where streaming sessions will be + // accessible from. These subnets must support the specified instance types. // // This member is required. Ec2SubnetIds []string diff --git a/service/nimble/api_op_CreateStreamingSession.go b/service/nimble/api_op_CreateStreamingSession.go index 7fa87968d6c..29b7e089bad 100644 --- a/service/nimble/api_op_CreateStreamingSession.go +++ b/service/nimble/api_op_CreateStreamingSession.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a streaming session in a studio. After invoking this operation, you must -// poll GetStreamingSession until the streaming session is in the READY state. +// Creates a streaming session in a studio. After invoking this operation, you +// must poll GetStreamingSession until the streaming session is in the READY state. func (c *Client) CreateStreamingSession(ctx context.Context, params *CreateStreamingSessionInput, optFns ...func(*Options)) (*CreateStreamingSessionOutput, error) { if params == nil { params = &CreateStreamingSessionInput{} diff --git a/service/nimble/api_op_CreateStudio.go b/service/nimble/api_op_CreateStudio.go index 87149cf8d5e..d7f9863d0d9 100644 --- a/service/nimble/api_op_CreateStudio.go +++ b/service/nimble/api_op_CreateStudio.go @@ -12,13 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new studio. When creating a studio, two IAM roles must be provided: the -// admin role and the user role. These roles are assumed by your users when they -// log in to the Nimble Studio portal. The user role must have the +// Create a new studio. When creating a studio, two IAM roles must be provided: +// the admin role and the user role. These roles are assumed by your users when +// they log in to the Nimble Studio portal. The user role must have the // AmazonNimbleStudio-StudioUser managed policy attached for the portal to function // properly. The admin role must have the AmazonNimbleStudio-StudioAdmin managed // policy attached for the portal to function properly. You may optionally specify -// a KMS key in the StudioEncryptionConfiguration. In Nimble Studio, resource +// a KMS key in the StudioEncryptionConfiguration . In Nimble Studio, resource // names, descriptions, initialization scripts, and other data you provide are // always encrypted at rest using an KMS key. By default, this key is owned by // Amazon Web Services and managed on your behalf. You may provide your own KMS key @@ -45,8 +45,8 @@ func (c *Client) CreateStudio(ctx context.Context, params *CreateStudioInput, op type CreateStudioInput struct { - // The IAM role that studio admins will assume when logging in to the Nimble Studio - // portal. + // The IAM role that studio admins will assume when logging in to the Nimble + // Studio portal. // // This member is required. AdminRoleArn *string diff --git a/service/nimble/api_op_DeleteStreamingSession.go b/service/nimble/api_op_DeleteStreamingSession.go index 25f7fb2669e..3f13b0ea383 100644 --- a/service/nimble/api_op_DeleteStreamingSession.go +++ b/service/nimble/api_op_DeleteStreamingSession.go @@ -15,7 +15,7 @@ import ( // Deletes streaming session resource. After invoking this operation, use // GetStreamingSession to poll the resource until it transitions to a DELETED // state. A streaming session will count against your streaming session quota until -// it is marked DELETED. +// it is marked DELETED . func (c *Client) DeleteStreamingSession(ctx context.Context, params *DeleteStreamingSessionInput, optFns ...func(*Options)) (*DeleteStreamingSessionOutput, error) { if params == nil { params = &DeleteStreamingSessionInput{} diff --git a/service/nimble/api_op_GetLaunchProfile.go b/service/nimble/api_op_GetLaunchProfile.go index 239cfe298c1..ecc9c287eb9 100644 --- a/service/nimble/api_op_GetLaunchProfile.go +++ b/service/nimble/api_op_GetLaunchProfile.go @@ -142,8 +142,8 @@ type LaunchProfileReadyWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LaunchProfileReadyWaiter will use default max delay of 750 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LaunchProfileReadyWaiter will use default max delay of 750 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -337,9 +337,10 @@ type LaunchProfileDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, LaunchProfileDeletedWaiter will use default max delay of 750 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, LaunchProfileDeletedWaiter will use default max delay of 750 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/nimble/api_op_GetStreamingImage.go b/service/nimble/api_op_GetStreamingImage.go index 608b151138c..42da8308f7e 100644 --- a/service/nimble/api_op_GetStreamingImage.go +++ b/service/nimble/api_op_GetStreamingImage.go @@ -143,9 +143,10 @@ type StreamingImageReadyWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingImageReadyWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingImageReadyWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -185,9 +186,9 @@ func NewStreamingImageReadyWaiter(client GetStreamingImageAPIClient, optFns ...f } } -// Wait calls the waiter function for StreamingImageReady waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for StreamingImageReady waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *StreamingImageReadyWaiter) Wait(ctx context.Context, params *GetStreamingImageInput, maxWaitDur time.Duration, optFns ...func(*StreamingImageReadyWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -338,9 +339,10 @@ type StreamingImageDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingImageDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingImageDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/nimble/api_op_GetStreamingSession.go b/service/nimble/api_op_GetStreamingSession.go index 5c8554396eb..e3c746e4ad1 100644 --- a/service/nimble/api_op_GetStreamingSession.go +++ b/service/nimble/api_op_GetStreamingSession.go @@ -122,8 +122,8 @@ func (c *Client) addOperationGetStreamingSessionMiddlewares(stack *middleware.St return nil } -// GetStreamingSessionAPIClient is a client that implements the GetStreamingSession -// operation. +// GetStreamingSessionAPIClient is a client that implements the +// GetStreamingSession operation. type GetStreamingSessionAPIClient interface { GetStreamingSession(context.Context, *GetStreamingSessionInput, ...func(*Options)) (*GetStreamingSessionOutput, error) } @@ -144,9 +144,10 @@ type StreamingSessionReadyWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingSessionReadyWaiter will use default max delay of 1800 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingSessionReadyWaiter will use default max delay of 1800 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -339,8 +340,8 @@ type StreamingSessionStoppedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingSessionStoppedWaiter will use default max delay of 900 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingSessionStoppedWaiter will use default max delay of 900 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -518,8 +519,8 @@ type StreamingSessionDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingSessionDeletedWaiter will use default max delay of 900 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingSessionDeletedWaiter will use default max delay of 900 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/nimble/api_op_GetStreamingSessionStream.go b/service/nimble/api_op_GetStreamingSessionStream.go index f601e2829cc..4dc37531229 100644 --- a/service/nimble/api_op_GetStreamingSessionStream.go +++ b/service/nimble/api_op_GetStreamingSessionStream.go @@ -17,9 +17,9 @@ import ( ) // Gets a StreamingSessionStream for a streaming session. Invoke this operation to -// poll the resource after invoking CreateStreamingSessionStream. After the -// StreamingSessionStream changes to the READY state, the url property will contain -// a stream to be used with the DCV streaming client. +// poll the resource after invoking CreateStreamingSessionStream . After the +// StreamingSessionStream changes to the READY state, the url property will +// contain a stream to be used with the DCV streaming client. func (c *Client) GetStreamingSessionStream(ctx context.Context, params *GetStreamingSessionStreamInput, optFns ...func(*Options)) (*GetStreamingSessionStreamOutput, error) { if params == nil { params = &GetStreamingSessionStreamInput{} @@ -151,8 +151,8 @@ type StreamingSessionStreamReadyWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StreamingSessionStreamReadyWaiter will use default max delay of 150 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StreamingSessionStreamReadyWaiter will use default max delay of 150 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/nimble/api_op_GetStudio.go b/service/nimble/api_op_GetStudio.go index 4fbff1a8eb9..652abd3947d 100644 --- a/service/nimble/api_op_GetStudio.go +++ b/service/nimble/api_op_GetStudio.go @@ -138,9 +138,9 @@ type StudioReadyWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StudioReadyWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StudioReadyWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -331,8 +331,8 @@ type StudioDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StudioDeletedWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StudioDeletedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -381,9 +381,10 @@ func (w *StudioDeletedWaiter) Wait(ctx context.Context, params *GetStudioInput, return err } -// WaitForOutput calls the waiter function for StudioDeleted waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for StudioDeleted waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *StudioDeletedWaiter) WaitForOutput(ctx context.Context, params *GetStudioInput, maxWaitDur time.Duration, optFns ...func(*StudioDeletedWaiterOptions)) (*GetStudioOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/nimble/api_op_GetStudioComponent.go b/service/nimble/api_op_GetStudioComponent.go index 009685f57b2..2bc0ad25844 100644 --- a/service/nimble/api_op_GetStudioComponent.go +++ b/service/nimble/api_op_GetStudioComponent.go @@ -143,9 +143,10 @@ type StudioComponentReadyWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StudioComponentReadyWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StudioComponentReadyWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -338,9 +339,10 @@ type StudioComponentDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, StudioComponentDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, StudioComponentDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -380,9 +382,9 @@ func NewStudioComponentDeletedWaiter(client GetStudioComponentAPIClient, optFns } } -// Wait calls the waiter function for StudioComponentDeleted waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for StudioComponentDeleted waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *StudioComponentDeletedWaiter) Wait(ctx context.Context, params *GetStudioComponentInput, maxWaitDur time.Duration, optFns ...func(*StudioComponentDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/nimble/api_op_ListEulaAcceptances.go b/service/nimble/api_op_ListEulaAcceptances.go index 96e6c39725a..8125d78d1c4 100644 --- a/service/nimble/api_op_ListEulaAcceptances.go +++ b/service/nimble/api_op_ListEulaAcceptances.go @@ -121,8 +121,8 @@ func (c *Client) addOperationListEulaAcceptancesMiddlewares(stack *middleware.St return nil } -// ListEulaAcceptancesAPIClient is a client that implements the ListEulaAcceptances -// operation. +// ListEulaAcceptancesAPIClient is a client that implements the +// ListEulaAcceptances operation. type ListEulaAcceptancesAPIClient interface { ListEulaAcceptances(context.Context, *ListEulaAcceptancesInput, ...func(*Options)) (*ListEulaAcceptancesOutput, error) } diff --git a/service/nimble/api_op_ListStreamingImages.go b/service/nimble/api_op_ListStreamingImages.go index 7a79595dedf..468430f43cb 100644 --- a/service/nimble/api_op_ListStreamingImages.go +++ b/service/nimble/api_op_ListStreamingImages.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListStreamingImagesMiddlewares(stack *middleware.St return nil } -// ListStreamingImagesAPIClient is a client that implements the ListStreamingImages -// operation. +// ListStreamingImagesAPIClient is a client that implements the +// ListStreamingImages operation. type ListStreamingImagesAPIClient interface { ListStreamingImages(context.Context, *ListStreamingImagesInput, ...func(*Options)) (*ListStreamingImagesOutput, error) } diff --git a/service/nimble/api_op_ListStudioMembers.go b/service/nimble/api_op_ListStudioMembers.go index a79bc3e909b..5447c03dcca 100644 --- a/service/nimble/api_op_ListStudioMembers.go +++ b/service/nimble/api_op_ListStudioMembers.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get all users in a given studio membership. ListStudioMembers only returns admin -// members. +// Get all users in a given studio membership. ListStudioMembers only returns +// admin members. func (c *Client) ListStudioMembers(ctx context.Context, params *ListStudioMembersInput, optFns ...func(*Options)) (*ListStudioMembersOutput, error) { if params == nil { params = &ListStudioMembersInput{} diff --git a/service/nimble/api_op_StartStreamingSession.go b/service/nimble/api_op_StartStreamingSession.go index 7ce64c72451..93962598788 100644 --- a/service/nimble/api_op_StartStreamingSession.go +++ b/service/nimble/api_op_StartStreamingSession.go @@ -32,7 +32,7 @@ func (c *Client) StartStreamingSession(ctx context.Context, params *StartStreami type StartStreamingSessionInput struct { - // The streaming session ID for the StartStreamingSessionRequest. + // The streaming session ID for the StartStreamingSessionRequest . // // This member is required. SessionId *string diff --git a/service/nimble/api_op_StopStreamingSession.go b/service/nimble/api_op_StopStreamingSession.go index bfea570c50e..4ca4e848807 100644 --- a/service/nimble/api_op_StopStreamingSession.go +++ b/service/nimble/api_op_StopStreamingSession.go @@ -32,7 +32,7 @@ func (c *Client) StopStreamingSession(ctx context.Context, params *StopStreaming type StopStreamingSessionInput struct { - // The streaming session ID for the StopStreamingSessionRequest. + // The streaming session ID for the StopStreamingSessionRequest . // // This member is required. SessionId *string @@ -48,8 +48,8 @@ type StopStreamingSessionInput struct { // idempotency. ClientToken *string - // Adds additional instructions to a streaming session stop action to either retain - // the EBS volumes or delete the EBS volumes. + // Adds additional instructions to a streaming session stop action to either + // retain the EBS volumes or delete the EBS volumes. VolumeRetentionMode types.VolumeRetentionMode noSmithyDocumentSerde diff --git a/service/nimble/api_op_UpdateStreamingImage.go b/service/nimble/api_op_UpdateStreamingImage.go index d299554008b..f6a58f44b52 100644 --- a/service/nimble/api_op_UpdateStreamingImage.go +++ b/service/nimble/api_op_UpdateStreamingImage.go @@ -57,8 +57,8 @@ type UpdateStreamingImageInput struct { type UpdateStreamingImageOutput struct { - // Represents a streaming image resource. Streaming images are used by studio users - // to select which operating system and software they want to use in a Nimble + // Represents a streaming image resource. Streaming images are used by studio + // users to select which operating system and software they want to use in a Nimble // Studio streaming session. Amazon provides a number of streaming images that // include popular 3rd-party software. You can create your own streaming images // using an Amazon EC2 machine image that you create for this purpose. You can also diff --git a/service/nimble/api_op_UpdateStudio.go b/service/nimble/api_op_UpdateStudio.go index d9c8c9ea952..7b0827ec043 100644 --- a/service/nimble/api_op_UpdateStudio.go +++ b/service/nimble/api_op_UpdateStudio.go @@ -36,8 +36,8 @@ type UpdateStudioInput struct { // This member is required. StudioId *string - // The IAM role that Studio Admins will assume when logging in to the Nimble Studio - // portal. + // The IAM role that Studio Admins will assume when logging in to the Nimble + // Studio portal. AdminRoleArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of diff --git a/service/nimble/types/enums.go b/service/nimble/types/enums.go index 0154fef9621..e4de2621e3e 100644 --- a/service/nimble/types/enums.go +++ b/service/nimble/types/enums.go @@ -10,9 +10,9 @@ const ( AutomaticTerminationModeActivated AutomaticTerminationMode = "ACTIVATED" ) -// Values returns all known values for AutomaticTerminationMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutomaticTerminationMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomaticTerminationMode) Values() []AutomaticTerminationMode { return []AutomaticTerminationMode{ "DEACTIVATED", @@ -44,8 +44,8 @@ const ( LaunchProfilePlatformWindows LaunchProfilePlatform = "WINDOWS" ) -// Values returns all known values for LaunchProfilePlatform. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LaunchProfilePlatform. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfilePlatform) Values() []LaunchProfilePlatform { return []LaunchProfilePlatform{ @@ -139,9 +139,10 @@ const ( LaunchProfileValidationStateValidationFailedInternalServerError LaunchProfileValidationState = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" ) -// Values returns all known values for LaunchProfileValidationState. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for LaunchProfileValidationState. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (LaunchProfileValidationState) Values() []LaunchProfileValidationState { return []LaunchProfileValidationState{ "VALIDATION_NOT_STARTED", @@ -167,8 +168,8 @@ const ( LaunchProfileValidationStatusCodeValidationFailedInternalServerError LaunchProfileValidationStatusCode = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" ) -// Values returns all known values for LaunchProfileValidationStatusCode. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for LaunchProfileValidationStatusCode. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (LaunchProfileValidationStatusCode) Values() []LaunchProfileValidationStatusCode { @@ -321,9 +322,9 @@ const ( StreamingImageStatusCodeAccessDenied StreamingImageStatusCode = "ACCESS_DENIED" ) -// Values returns all known values for StreamingImageStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StreamingImageStatusCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingImageStatusCode) Values() []StreamingImageStatusCode { return []StreamingImageStatusCode{ "STREAMING_IMAGE_CREATE_IN_PROGRESS", @@ -355,8 +356,8 @@ const ( StreamingInstanceTypeG516xlarge StreamingInstanceType = "g5.16xlarge" ) -// Values returns all known values for StreamingInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StreamingInstanceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StreamingInstanceType) Values() []StreamingInstanceType { return []StreamingInstanceType{ @@ -393,8 +394,8 @@ const ( StreamingSessionStateStartFailed StreamingSessionState = "START_FAILED" ) -// Values returns all known values for StreamingSessionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StreamingSessionState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StreamingSessionState) Values() []StreamingSessionState { return []StreamingSessionState{ diff --git a/service/nimble/types/types.go b/service/nimble/types/types.go index a6bf60fc1ca..372441496fb 100644 --- a/service/nimble/types/types.go +++ b/service/nimble/types/types.go @@ -197,8 +197,8 @@ type LaunchProfileInitialization struct { noSmithyDocumentSerde } -// The launch profile initialization Active Directory contains information required -// for the launch profile to connect to the Active Directory. +// The launch profile initialization Active Directory contains information +// required for the launch profile to connect to the Active Directory. type LaunchProfileInitializationActiveDirectory struct { // A collection of custom attributes for an Active Directory computer. @@ -258,20 +258,12 @@ type LaunchProfileInitializationScript struct { // from your studio identity source who is granted permissions to a launch profile. // A launch profile member (type USER) provides the following permissions to that // launch profile: -// -// * GetLaunchProfile -// -// * GetLaunchProfileInitialization -// -// * -// GetLaunchProfileMembers -// -// * GetLaunchProfileMember -// -// * CreateStreamingSession -// -// * -// GetLaunchProfileDetails +// - GetLaunchProfile +// - GetLaunchProfileInitialization +// - GetLaunchProfileMembers +// - GetLaunchProfileMember +// - CreateStreamingSession +// - GetLaunchProfileDetails type LaunchProfileMembership struct { // The ID of the identity store. @@ -391,33 +383,29 @@ type StreamConfiguration struct { // Indicates if a streaming session created from this launch profile should be // terminated automatically or retained without termination after being in a // STOPPED state. - // - // * When ACTIVATED, the streaming session is scheduled for - // termination after being in the STOPPED state for the time specified in - // maxStoppedSessionLengthInMinutes. - // - // * When DEACTIVATED, the streaming session can - // remain in the STOPPED state indefinitely. - // - // This parameter is only allowed when - // sessionPersistenceMode is ACTIVATED. When allowed, the default value for this - // parameter is DEACTIVATED. + // - When ACTIVATED , the streaming session is scheduled for termination after + // being in the STOPPED state for the time specified in + // maxStoppedSessionLengthInMinutes . + // - When DEACTIVATED , the streaming session can remain in the STOPPED state + // indefinitely. + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When + // allowed, the default value for this parameter is DEACTIVATED . AutomaticTerminationMode AutomaticTerminationMode - // The length of time, in minutes, that a streaming session can be active before it - // is stopped or terminated. After this point, Nimble Studio automatically + // The length of time, in minutes, that a streaming session can be active before + // it is stopped or terminated. After this point, Nimble Studio automatically // terminates or stops the session. The default length of time is 690 minutes, and // the maximum length of time is 30 days. MaxSessionLengthInMinutes *int32 // Integer that determines if you can start and stop your sessions and how long a - // session can stay in the STOPPED state. The default value is 0. The maximum value - // is 5760. This field is allowed only when sessionPersistenceMode is ACTIVATED and - // automaticTerminationMode is ACTIVATED. If the value is set to 0, your sessions - // can’t be STOPPED. If you then call StopStreamingSession, the session fails. If - // the time that a session stays in the READY state exceeds the + // session can stay in the STOPPED state. The default value is 0. The maximum + // value is 5760. This field is allowed only when sessionPersistenceMode is + // ACTIVATED and automaticTerminationMode is ACTIVATED . If the value is set to 0, + // your sessions can’t be STOPPED . If you then call StopStreamingSession , the + // session fails. If the time that a session stays in the READY state exceeds the // maxSessionLengthInMinutes value, the session will automatically be terminated - // (instead of STOPPED). If the value is set to a positive number, the session can + // (instead of STOPPED ). If the value is set to a positive number, the session can // be stopped. You can call StopStreamingSession to stop sessions in the READY // state. If the time that a session stays in the READY state exceeds the // maxSessionLengthInMinutes value, the session will automatically be stopped @@ -437,7 +425,7 @@ type StreamConfiguration struct { // Custom volume configuration for the root volumes that are attached to streaming // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED. + // ACTIVATED . VolumeConfiguration *VolumeConfiguration noSmithyDocumentSerde @@ -467,33 +455,29 @@ type StreamConfigurationCreate struct { // Indicates if a streaming session created from this launch profile should be // terminated automatically or retained without termination after being in a // STOPPED state. - // - // * When ACTIVATED, the streaming session is scheduled for - // termination after being in the STOPPED state for the time specified in - // maxStoppedSessionLengthInMinutes. - // - // * When DEACTIVATED, the streaming session can - // remain in the STOPPED state indefinitely. - // - // This parameter is only allowed when - // sessionPersistenceMode is ACTIVATED. When allowed, the default value for this - // parameter is DEACTIVATED. + // - When ACTIVATED , the streaming session is scheduled for termination after + // being in the STOPPED state for the time specified in + // maxStoppedSessionLengthInMinutes . + // - When DEACTIVATED , the streaming session can remain in the STOPPED state + // indefinitely. + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When + // allowed, the default value for this parameter is DEACTIVATED . AutomaticTerminationMode AutomaticTerminationMode - // The length of time, in minutes, that a streaming session can be active before it - // is stopped or terminated. After this point, Nimble Studio automatically + // The length of time, in minutes, that a streaming session can be active before + // it is stopped or terminated. After this point, Nimble Studio automatically // terminates or stops the session. The default length of time is 690 minutes, and // the maximum length of time is 30 days. MaxSessionLengthInMinutes *int32 // Integer that determines if you can start and stop your sessions and how long a - // session can stay in the STOPPED state. The default value is 0. The maximum value - // is 5760. This field is allowed only when sessionPersistenceMode is ACTIVATED and - // automaticTerminationMode is ACTIVATED. If the value is set to 0, your sessions - // can’t be STOPPED. If you then call StopStreamingSession, the session fails. If - // the time that a session stays in the READY state exceeds the + // session can stay in the STOPPED state. The default value is 0. The maximum + // value is 5760. This field is allowed only when sessionPersistenceMode is + // ACTIVATED and automaticTerminationMode is ACTIVATED . If the value is set to 0, + // your sessions can’t be STOPPED . If you then call StopStreamingSession , the + // session fails. If the time that a session stays in the READY state exceeds the // maxSessionLengthInMinutes value, the session will automatically be terminated - // (instead of STOPPED). If the value is set to a positive number, the session can + // (instead of STOPPED ). If the value is set to a positive number, the session can // be stopped. You can call StopStreamingSession to stop sessions in the READY // state. If the time that a session stays in the READY state exceeds the // maxSessionLengthInMinutes value, the session will automatically be stopped @@ -509,13 +493,13 @@ type StreamConfigurationCreate struct { // automaticTerminationMode are configured. SessionPersistenceMode SessionPersistenceMode - // The upload storage for a streaming workstation that is created using this launch - // profile. + // The upload storage for a streaming workstation that is created using this + // launch profile. SessionStorage *StreamConfigurationSessionStorage // Custom volume configuration for the root volumes that are attached to streaming // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED. + // ACTIVATED . VolumeConfiguration *VolumeConfiguration noSmithyDocumentSerde @@ -530,9 +514,9 @@ type StreamConfigurationSessionBackup struct { MaxBackupsToRetain int32 // Specifies how artists sessions are backed up. Configures backups for streaming - // sessions launched with this launch profile. The default value is DEACTIVATED, + // sessions launched with this launch profile. The default value is DEACTIVATED , // which means that backups are deactivated. To allow backups, set this value to - // AUTOMATIC. + // AUTOMATIC . Mode SessionBackupMode noSmithyDocumentSerde @@ -542,7 +526,7 @@ type StreamConfigurationSessionBackup struct { type StreamConfigurationSessionStorage struct { // Allows artists to upload files to their workstations. The only valid option is - // UPLOAD. + // UPLOAD . // // This member is required. Mode []StreamingSessionStorageMode @@ -553,8 +537,8 @@ type StreamConfigurationSessionStorage struct { noSmithyDocumentSerde } -// Represents a streaming image resource. Streaming images are used by studio users -// to select which operating system and software they want to use in a Nimble +// Represents a streaming image resource. Streaming images are used by studio +// users to select which operating system and software they want to use in a Nimble // Studio streaming session. Amazon provides a number of streaming images that // include popular 3rd-party software. You can create your own streaming images // using an Amazon EC2 machine image that you create for this purpose. You can also @@ -632,17 +616,13 @@ type StreamingSession struct { // Indicates if a streaming session created from this launch profile should be // terminated automatically or retained without termination after being in a // STOPPED state. - // - // * When ACTIVATED, the streaming session is scheduled for - // termination after being in the STOPPED state for the time specified in - // maxStoppedSessionLengthInMinutes. - // - // * When DEACTIVATED, the streaming session can - // remain in the STOPPED state indefinitely. - // - // This parameter is only allowed when - // sessionPersistenceMode is ACTIVATED. When allowed, the default value for this - // parameter is DEACTIVATED. + // - When ACTIVATED , the streaming session is scheduled for termination after + // being in the STOPPED state for the time specified in + // maxStoppedSessionLengthInMinutes . + // - When DEACTIVATED , the streaming session can remain in the STOPPED state + // indefinitely. + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When + // allowed, the default value for this parameter is DEACTIVATED . AutomaticTerminationMode AutomaticTerminationMode // Shows the current backup setting of the session. @@ -660,8 +640,8 @@ type StreamingSession struct { // The ID of the launch profile used to control access from the streaming session. LaunchProfileId *string - // The maximum number of backups of a streaming session that you can have. When the - // maximum number of backups is reached, the oldest backup is deleted. + // The maximum number of backups of a streaming session that you can have. When + // the maximum number of backups is reached, the oldest backup is deleted. MaxBackupsToRetain int32 // The user ID of the user that owns the streaming session. The user that owns the @@ -695,8 +675,8 @@ type StreamingSession struct { // The status message for the streaming session. StatusMessage *string - // The time the streaming session will automatically be stopped if the user doesn’t - // stop the session themselves. + // The time the streaming session will automatically be stopped if the user + // doesn’t stop the session themselves. StopAt *time.Time // The time the session entered STOP_IN_PROGRESS state. @@ -712,8 +692,8 @@ type StreamingSession struct { // resource. Tags map[string]string - // The time the streaming session will automatically terminate if not terminated by - // the user. + // The time the streaming session will automatically terminate if not terminated + // by the user. TerminateAt *time.Time // The ISO timestamp in seconds for when the resource was updated. @@ -724,7 +704,7 @@ type StreamingSession struct { // Custom volume configuration for the root volumes that are attached to streaming // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED. + // ACTIVATED . VolumeConfiguration *VolumeConfiguration // Determine if an EBS volume created from this streaming session will be backed @@ -754,7 +734,7 @@ type StreamingSessionBackup struct { // The user ID of the user that owns the streaming session. OwnedBy *string - // The streaming session ID for the StreamingSessionBackup. + // The streaming session ID for the StreamingSessionBackup . SessionId *string // The streaming session state. @@ -898,7 +878,7 @@ type Studio struct { // following: render farm, Active Directory, licensing, and file system. Access to // a studio component is managed by specifying security groups for the resource, as // well as its endpoint. A studio component also has a set of initialization -// scripts that are returned by GetLaunchProfileInitialization. These +// scripts that are returned by GetLaunchProfileInitialization . These // initialization scripts run on streaming sessions when they start. They provide // users with flexibility in controlling how the studio resources are configured on // a streaming session. @@ -1095,7 +1075,7 @@ type ValidationResult struct { State LaunchProfileValidationState // The status code. This will contain the failure reason if the state is - // VALIDATION_FAILED. + // VALIDATION_FAILED . // // This member is required. StatusCode LaunchProfileValidationStatusCode @@ -1115,7 +1095,7 @@ type ValidationResult struct { // Custom volume configuration for the root volumes that are attached to streaming // sessions. This parameter is only allowed when sessionPersistenceMode is -// ACTIVATED. +// ACTIVATED . type VolumeConfiguration struct { // The number of I/O operations per second for the root volume that is attached to diff --git a/service/oam/api_client.go b/service/oam/api_client.go index 8652ad62b5e..a369f753719 100644 --- a/service/oam/api_client.go +++ b/service/oam/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/oam/api_op_CreateLink.go b/service/oam/api_op_CreateLink.go index 540624cbe7a..dda16c967a1 100644 --- a/service/oam/api_op_CreateLink.go +++ b/service/oam/api_op_CreateLink.go @@ -16,11 +16,9 @@ import ( // monitoring account and create a sink policy in that account. The sink policy // must permit the source account to link to it. You can grant permission to source // accounts by granting permission to an entire organization or to individual -// accounts. For more information, see CreateSink -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html) and -// PutSinkPolicy -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html). -// Each monitoring account can be linked to as many as 100,000 source accounts. +// accounts. For more information, see CreateSink (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html) +// and PutSinkPolicy (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html) +// . Each monitoring account can be linked to as many as 100,000 source accounts. // Each source account can be linked to as many as five monitoring accounts. func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns ...func(*Options)) (*CreateLinkOutput, error) { if params == nil { @@ -42,15 +40,10 @@ type CreateLinkInput struct { // Specify a friendly human-readable name to use to identify this source account // when you are viewing data from it in the monitoring account. You can use a // custom label or use the following variables: - // - // * $AccountName is the name of the - // account - // - // * $AccountEmail is the globally unique email address of the account - // - // * - // $AccountEmailNoDomain is the email address of the account without the domain - // name + // - $AccountName is the name of the account + // - $AccountEmail is the globally unique email address of the account + // - $AccountEmailNoDomain is the email address of the account without the domain + // name // // This member is required. LabelTemplate *string @@ -61,10 +54,9 @@ type CreateLinkInput struct { // This member is required. ResourceTypes []types.ResourceType - // The ARN of the sink to use to create this link. You can use ListSinks - // (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) to find - // the ARNs of sinks. For more information about sinks, see CreateSink - // (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html). + // The ARN of the sink to use to create this link. You can use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) + // to find the ARNs of sinks. For more information about sinks, see CreateSink (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html) + // . // // This member is required. SinkIdentifier *string @@ -73,8 +65,8 @@ type CreateLinkInput struct { // organize and categorize your resources. You can also use them to scope user // permissions by granting a user permission to access or change only resources // with certain tag values. For more information about using tags to control - // access, see Controlling access to Amazon Web Services resources using tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). + // access, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/oam/api_op_CreateSink.go b/service/oam/api_op_CreateSink.go index 7db75cc0f66..4cb7ae10ae9 100644 --- a/service/oam/api_op_CreateSink.go +++ b/service/oam/api_op_CreateSink.go @@ -15,9 +15,8 @@ import ( // resource that represents an attachment point in a monitoring account. Source // accounts can link to the sink to send observability data. After you create a // sink, you must create a sink policy that allows source accounts to attach to it. -// For more information, see PutSinkPolicy -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html). -// Each account can contain one sink. If you delete a sink, you can then create a +// For more information, see PutSinkPolicy (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html) +// . Each account can contain one sink. If you delete a sink, you can then create a // new one in that account. func (c *Client) CreateSink(ctx context.Context, params *CreateSinkInput, optFns ...func(*Options)) (*CreateSinkOutput, error) { if params == nil { @@ -45,8 +44,8 @@ type CreateSinkInput struct { // organize and categorize your resources. You can also use them to scope user // permissions by granting a user permission to access or change only resources // with certain tag values. For more information about using tags to control - // access, see Controlling access to Amazon Web Services resources using tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). + // access, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/oam/api_op_GetLink.go b/service/oam/api_op_GetLink.go index baea6cf8203..2f20bc7e374 100644 --- a/service/oam/api_op_GetLink.go +++ b/service/oam/api_op_GetLink.go @@ -11,8 +11,8 @@ import ( ) // Returns complete information about one link. To use this operation, provide the -// link ARN. To retrieve a list of link ARNs, use ListLinks -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html). +// link ARN. To retrieve a list of link ARNs, use ListLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html) +// . func (c *Client) GetLink(ctx context.Context, params *GetLinkInput, optFns ...func(*Options)) (*GetLinkOutput, error) { if params == nil { params = &GetLinkInput{} diff --git a/service/oam/api_op_GetSink.go b/service/oam/api_op_GetSink.go index 5c9b2f615af..8d2ba345f8c 100644 --- a/service/oam/api_op_GetSink.go +++ b/service/oam/api_op_GetSink.go @@ -11,8 +11,8 @@ import ( ) // Returns complete information about one monitoring account sink. To use this -// operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html). +// operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) +// . func (c *Client) GetSink(ctx context.Context, params *GetSinkInput, optFns ...func(*Options)) (*GetSinkOutput, error) { if params == nil { params = &GetSinkInput{} diff --git a/service/oam/api_op_GetSinkPolicy.go b/service/oam/api_op_GetSinkPolicy.go index b64cd022d39..b7e966b491d 100644 --- a/service/oam/api_op_GetSinkPolicy.go +++ b/service/oam/api_op_GetSinkPolicy.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the current sink policy attached to this sink. The sink policy specifies -// what accounts can attach to this sink as source accounts, and what types of data -// they can share. +// Returns the current sink policy attached to this sink. The sink policy +// specifies what accounts can attach to this sink as source accounts, and what +// types of data they can share. func (c *Client) GetSinkPolicy(ctx context.Context, params *GetSinkPolicyInput, optFns ...func(*Options)) (*GetSinkPolicyOutput, error) { if params == nil { params = &GetSinkPolicyInput{} diff --git a/service/oam/api_op_ListAttachedLinks.go b/service/oam/api_op_ListAttachedLinks.go index 8fc200631d3..f3d69a5e555 100644 --- a/service/oam/api_op_ListAttachedLinks.go +++ b/service/oam/api_op_ListAttachedLinks.go @@ -14,10 +14,9 @@ import ( // Returns a list of source account links that are linked to this monitoring // account sink. To use this operation, provide the sink ARN. To retrieve a list of -// sink ARNs, use ListSinks -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html). To -// find a list of links for one source account, use ListLinks -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html). +// sink ARNs, use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) +// . To find a list of links for one source account, use ListLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html) +// . func (c *Client) ListAttachedLinks(ctx context.Context, params *ListAttachedLinksInput, optFns ...func(*Options)) (*ListAttachedLinksOutput, error) { if params == nil { params = &ListAttachedLinksInput{} diff --git a/service/oam/api_op_ListLinks.go b/service/oam/api_op_ListLinks.go index c37dc470159..4e6d77c8c2a 100644 --- a/service/oam/api_op_ListLinks.go +++ b/service/oam/api_op_ListLinks.go @@ -14,8 +14,7 @@ import ( // Use this operation in a source account to return a list of links to monitoring // account sinks that this source account has. To find a list of links for one -// monitoring account sink, use ListAttachedLinks -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.html) +// monitoring account sink, use ListAttachedLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.html) // from within the monitoring account. func (c *Client) ListLinks(ctx context.Context, params *ListLinksInput, optFns ...func(*Options)) (*ListLinksOutput, error) { if params == nil { diff --git a/service/oam/api_op_ListTagsForResource.go b/service/oam/api_op_ListTagsForResource.go index fcdc47da88e..4e249e57bb7 100644 --- a/service/oam/api_op_ListTagsForResource.go +++ b/service/oam/api_op_ListTagsForResource.go @@ -29,15 +29,14 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN of the resource that you want to view tags for. The ARN format of a sink - // is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is - // arn:aws:oam:Region:account-id:link/link-id For more information about ARN - // format, see CloudWatch Logs resources and operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). - // Unlike tagging permissions in other Amazon Web Services services, to retrieve - // the list of tags for links or sinks you must have the oam:RequestTag permission. - // The aws:ReguestTag permission does not allow you to tag and untag links and - // sinks. + // The ARN of the resource that you want to view tags for. The ARN format of a + // sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is + // arn:aws:oam:Region:account-id:link/link-id For more information about ARN + // format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . Unlike tagging permissions in other Amazon Web Services services, to retrieve + // the list of tags for links or sinks you must have the oam:RequestTag + // permission. The aws:ReguestTag permission does not allow you to tag and untag + // links and sinks. // // This member is required. ResourceArn *string diff --git a/service/oam/api_op_PutSinkPolicy.go b/service/oam/api_op_PutSinkPolicy.go index b7052429784..e58bc0f462d 100644 --- a/service/oam/api_op_PutSinkPolicy.go +++ b/service/oam/api_op_PutSinkPolicy.go @@ -15,17 +15,12 @@ import ( // you can grant permissions to all accounts in an organization or to individual // accounts. You can also use a sink policy to limit the types of data that is // shared. The three types that you can allow or deny are: +// - Metrics - Specify with AWS::CloudWatch::Metric +// - Log groups - Specify with AWS::Logs::LogGroup +// - Traces - Specify with AWS::XRay::Trace // -// * Metrics - Specify -// with AWS::CloudWatch::Metric -// -// * Log groups - Specify with AWS::Logs::LogGroup -// -// * -// Traces - Specify with AWS::XRay::Trace -// -// See the examples in this section to see -// how to specify permitted source accounts and data types. +// See the examples in this section to see how to specify permitted source +// accounts and data types. func (c *Client) PutSinkPolicy(ctx context.Context, params *PutSinkPolicyInput, optFns ...func(*Options)) (*PutSinkPolicyOutput, error) { if params == nil { params = &PutSinkPolicyInput{} diff --git a/service/oam/api_op_TagResource.go b/service/oam/api_op_TagResource.go index 7959e10a90d..7378a15d07e 100644 --- a/service/oam/api_op_TagResource.go +++ b/service/oam/api_op_TagResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns one or more tags (key-value pairs) to the specified resource. Both sinks -// and links can be tagged. Tags can help you organize and categorize your +// Assigns one or more tags (key-value pairs) to the specified resource. Both +// sinks and links can be tagged. Tags can help you organize and categorize your // resources. You can also use them to scope user permissions by granting a user // permission to access or change only resources with certain tag values. Tags // don't have any semantic meaning to Amazon Web Services and are interpreted @@ -42,10 +42,10 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The ARN of the resource that you're adding tags to. The ARN format of a sink is - // arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is - // arn:aws:oam:Region:account-id:link/link-id For more information about ARN - // format, see CloudWatch Logs resources and operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). + // arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is + // arn:aws:oam:Region:account-id:link/link-id For more information about ARN + // format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . // // This member is required. ResourceArn *string diff --git a/service/oam/api_op_UntagResource.go b/service/oam/api_op_UntagResource.go index 643fc542897..8815becbba8 100644 --- a/service/oam/api_op_UntagResource.go +++ b/service/oam/api_op_UntagResource.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more tags from the specified resource. Unlike tagging permissions -// in other Amazon Web Services services, to tag or untag links and sinks you must -// have the oam:ResourceTag permission. The iam:TagResource permission does not -// allow you to tag and untag links and sinks. +// Removes one or more tags from the specified resource. Unlike tagging +// permissions in other Amazon Web Services services, to tag or untag links and +// sinks you must have the oam:ResourceTag permission. The iam:TagResource +// permission does not allow you to tag and untag links and sinks. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -31,11 +31,11 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ARN of the resource that you're removing tags from. The ARN format of a sink - // is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is - // arn:aws:oam:Region:account-id:link/link-id For more information about ARN - // format, see CloudWatch Logs resources and operations - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html). + // The ARN of the resource that you're removing tags from. The ARN format of a + // sink is arn:aws:oam:Region:account-id:sink/sink-id The ARN format of a link is + // arn:aws:oam:Region:account-id:link/link-id For more information about ARN + // format, see CloudWatch Logs resources and operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html) + // . // // This member is required. ResourceArn *string diff --git a/service/oam/api_op_UpdateLink.go b/service/oam/api_op_UpdateLink.go index d34c40b8c5d..4bcc400a0ed 100644 --- a/service/oam/api_op_UpdateLink.go +++ b/service/oam/api_op_UpdateLink.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use this operation to change what types of data are shared from a source account -// to its linked monitoring account sink. You can't change the sink or change the -// monitoring account with this operation. To update the list of tags associated -// with the sink, use TagResource -// (https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html). +// Use this operation to change what types of data are shared from a source +// account to its linked monitoring account sink. You can't change the sink or +// change the monitoring account with this operation. To update the list of tags +// associated with the sink, use TagResource (https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateLink(ctx context.Context, params *UpdateLinkInput, optFns ...func(*Options)) (*UpdateLinkOutput, error) { if params == nil { params = &UpdateLinkInput{} @@ -38,9 +38,9 @@ type UpdateLinkInput struct { // This member is required. Identifier *string - // An array of strings that define which types of data that the source account will - // send to the monitoring account. Your input here replaces the current set of data - // types that are shared. + // An array of strings that define which types of data that the source account + // will send to the monitoring account. Your input here replaces the current set of + // data types that are shared. // // This member is required. ResourceTypes []types.ResourceType diff --git a/service/oam/types/enums.go b/service/oam/types/enums.go index b886260ced9..c0dd5811c4d 100644 --- a/service/oam/types/enums.go +++ b/service/oam/types/enums.go @@ -11,9 +11,9 @@ const ( ResourceTypeAwsXrayTrace ResourceType = "AWS::XRay::Trace" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "AWS::CloudWatch::Metric", diff --git a/service/oam/types/types.go b/service/oam/types/types.go index a79653f8f05..e8f8ee77b10 100644 --- a/service/oam/types/types.go +++ b/service/oam/types/types.go @@ -6,8 +6,8 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// A structure that contains information about one link attached to this monitoring -// account sink. +// A structure that contains information about one link attached to this +// monitoring account sink. type ListAttachedLinksItem struct { // The label that was assigned to this link at creation, with the variables diff --git a/service/omics/api_client.go b/service/omics/api_client.go index f4d8ba105ca..3212a9f7d63 100644 --- a/service/omics/api_client.go +++ b/service/omics/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/omics/api_op_GetAnnotationImportJob.go b/service/omics/api_op_GetAnnotationImportJob.go index 75c3054ae39..57e30f066ab 100644 --- a/service/omics/api_op_GetAnnotationImportJob.go +++ b/service/omics/api_op_GetAnnotationImportJob.go @@ -220,8 +220,8 @@ type AnnotationImportJobCreatedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AnnotationImportJobCreatedWaiter will use default max delay of 600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AnnotationImportJobCreatedWaiter will use default max delay of 600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/omics/api_op_GetAnnotationStore.go b/service/omics/api_op_GetAnnotationStore.go index b8528214caf..fb744cae5d8 100644 --- a/service/omics/api_op_GetAnnotationStore.go +++ b/service/omics/api_op_GetAnnotationStore.go @@ -232,9 +232,10 @@ type AnnotationStoreCreatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AnnotationStoreCreatedWaiter will use default max delay of 600 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AnnotationStoreCreatedWaiter will use default max delay of 600 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -274,9 +275,9 @@ func NewAnnotationStoreCreatedWaiter(client GetAnnotationStoreAPIClient, optFns } } -// Wait calls the waiter function for AnnotationStoreCreated waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for AnnotationStoreCreated waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *AnnotationStoreCreatedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreCreatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -444,9 +445,10 @@ type AnnotationStoreDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AnnotationStoreDeletedWaiter will use default max delay of 600 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AnnotationStoreDeletedWaiter will use default max delay of 600 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -486,9 +488,9 @@ func NewAnnotationStoreDeletedWaiter(client GetAnnotationStoreAPIClient, optFns } } -// Wait calls the waiter function for AnnotationStoreDeleted waiter. The maxWaitDur -// is the maximum wait duration the waiter will wait. The maxWaitDur is required -// and must be greater than zero. +// Wait calls the waiter function for AnnotationStoreDeleted waiter. The +// maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is +// required and must be greater than zero. func (w *AnnotationStoreDeletedWaiter) Wait(ctx context.Context, params *GetAnnotationStoreInput, maxWaitDur time.Duration, optFns ...func(*AnnotationStoreDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/omics/api_op_GetReadSetActivationJob.go b/service/omics/api_op_GetReadSetActivationJob.go index f783206542b..e2af93cbc5b 100644 --- a/service/omics/api_op_GetReadSetActivationJob.go +++ b/service/omics/api_op_GetReadSetActivationJob.go @@ -200,10 +200,10 @@ type ReadSetActivationJobCompletedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReadSetActivationJobCompletedWaiter will use default max delay of 600 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReadSetActivationJobCompletedWaiter will use default max delay of + // 600 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -253,8 +253,8 @@ func (w *ReadSetActivationJobCompletedWaiter) Wait(ctx context.Context, params * return err } -// WaitForOutput calls the waiter function for ReadSetActivationJobCompleted waiter -// and returns the output of the successful operation. The maxWaitDur is the +// WaitForOutput calls the waiter function for ReadSetActivationJobCompleted +// waiter and returns the output of the successful operation. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *ReadSetActivationJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetActivationJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetActivationJobCompletedWaiterOptions)) (*GetReadSetActivationJobOutput, error) { diff --git a/service/omics/api_op_GetReadSetExportJob.go b/service/omics/api_op_GetReadSetExportJob.go index 10cf3a26875..1f20bd9b6b3 100644 --- a/service/omics/api_op_GetReadSetExportJob.go +++ b/service/omics/api_op_GetReadSetExportJob.go @@ -182,8 +182,8 @@ func addEndpointPrefix_opGetReadSetExportJobMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opGetReadSetExportJobMiddleware{}, `OperationSerializer`, middleware.After) } -// GetReadSetExportJobAPIClient is a client that implements the GetReadSetExportJob -// operation. +// GetReadSetExportJobAPIClient is a client that implements the +// GetReadSetExportJob operation. type GetReadSetExportJobAPIClient interface { GetReadSetExportJob(context.Context, *GetReadSetExportJobInput, ...func(*Options)) (*GetReadSetExportJobOutput, error) } @@ -204,8 +204,8 @@ type ReadSetExportJobCompletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReadSetExportJobCompletedWaiter will use default max delay of 600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReadSetExportJobCompletedWaiter will use default max delay of 600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -256,10 +256,10 @@ func (w *ReadSetExportJobCompletedWaiter) Wait(ctx context.Context, params *GetR return err } -// WaitForOutput calls the waiter function for ReadSetExportJobCompleted waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for ReadSetExportJobCompleted waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *ReadSetExportJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetExportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetExportJobCompletedWaiterOptions)) (*GetReadSetExportJobOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/omics/api_op_GetReadSetImportJob.go b/service/omics/api_op_GetReadSetImportJob.go index a4d614baae5..d702e5e250a 100644 --- a/service/omics/api_op_GetReadSetImportJob.go +++ b/service/omics/api_op_GetReadSetImportJob.go @@ -184,8 +184,8 @@ func addEndpointPrefix_opGetReadSetImportJobMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opGetReadSetImportJobMiddleware{}, `OperationSerializer`, middleware.After) } -// GetReadSetImportJobAPIClient is a client that implements the GetReadSetImportJob -// operation. +// GetReadSetImportJobAPIClient is a client that implements the +// GetReadSetImportJob operation. type GetReadSetImportJobAPIClient interface { GetReadSetImportJob(context.Context, *GetReadSetImportJobInput, ...func(*Options)) (*GetReadSetImportJobOutput, error) } @@ -206,8 +206,8 @@ type ReadSetImportJobCompletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReadSetImportJobCompletedWaiter will use default max delay of 600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReadSetImportJobCompletedWaiter will use default max delay of 600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -258,10 +258,10 @@ func (w *ReadSetImportJobCompletedWaiter) Wait(ctx context.Context, params *GetR return err } -// WaitForOutput calls the waiter function for ReadSetImportJobCompleted waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for ReadSetImportJobCompleted waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *ReadSetImportJobCompletedWaiter) WaitForOutput(ctx context.Context, params *GetReadSetImportJobInput, maxWaitDur time.Duration, optFns ...func(*ReadSetImportJobCompletedWaiterOptions)) (*GetReadSetImportJobOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/omics/api_op_GetReferenceImportJob.go b/service/omics/api_op_GetReferenceImportJob.go index b7ef97dab72..2135293c336 100644 --- a/service/omics/api_op_GetReferenceImportJob.go +++ b/service/omics/api_op_GetReferenceImportJob.go @@ -206,8 +206,8 @@ type ReferenceImportJobCompletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ReferenceImportJobCompletedWaiter will use default max delay of 600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ReferenceImportJobCompletedWaiter will use default max delay of 600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/omics/api_op_GetRun.go b/service/omics/api_op_GetRun.go index 8e27e3ca6c9..ee972755a71 100644 --- a/service/omics/api_op_GetRun.go +++ b/service/omics/api_op_GetRun.go @@ -236,9 +236,9 @@ type RunRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RunRunningWaiter will use default max delay of 600 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RunRunningWaiter will use default max delay of 600 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -463,9 +463,9 @@ type RunCompletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RunCompletedWaiter will use default max delay of 600 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RunCompletedWaiter will use default max delay of 600 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/omics/api_op_GetRunTask.go b/service/omics/api_op_GetRunTask.go index 1f4808183dd..2a46a695f5d 100644 --- a/service/omics/api_op_GetRunTask.go +++ b/service/omics/api_op_GetRunTask.go @@ -198,9 +198,9 @@ type TaskRunningWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TaskRunningWaiter will use default max delay of 600 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TaskRunningWaiter will use default max delay of 600 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -425,8 +425,8 @@ type TaskCompletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TaskCompletedWaiter will use default max delay of 600 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TaskCompletedWaiter will use default max delay of 600 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -475,9 +475,10 @@ func (w *TaskCompletedWaiter) Wait(ctx context.Context, params *GetRunTaskInput, return err } -// WaitForOutput calls the waiter function for TaskCompleted waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for TaskCompleted waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *TaskCompletedWaiter) WaitForOutput(ctx context.Context, params *GetRunTaskInput, maxWaitDur time.Duration, optFns ...func(*TaskCompletedWaiterOptions)) (*GetRunTaskOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/omics/api_op_GetVariantImportJob.go b/service/omics/api_op_GetVariantImportJob.go index c3833f9b11c..0bf0f279669 100644 --- a/service/omics/api_op_GetVariantImportJob.go +++ b/service/omics/api_op_GetVariantImportJob.go @@ -191,8 +191,8 @@ func addEndpointPrefix_opGetVariantImportJobMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opGetVariantImportJobMiddleware{}, `OperationSerializer`, middleware.After) } -// GetVariantImportJobAPIClient is a client that implements the GetVariantImportJob -// operation. +// GetVariantImportJobAPIClient is a client that implements the +// GetVariantImportJob operation. type GetVariantImportJobAPIClient interface { GetVariantImportJob(context.Context, *GetVariantImportJobInput, ...func(*Options)) (*GetVariantImportJobOutput, error) } @@ -213,8 +213,8 @@ type VariantImportJobCreatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VariantImportJobCreatedWaiter will use default max delay of 600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VariantImportJobCreatedWaiter will use default max delay of 600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/omics/api_op_GetVariantStore.go b/service/omics/api_op_GetVariantStore.go index ed4bdefff20..8b1a110550f 100644 --- a/service/omics/api_op_GetVariantStore.go +++ b/service/omics/api_op_GetVariantStore.go @@ -226,9 +226,10 @@ type VariantStoreCreatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VariantStoreCreatedWaiter will use default max delay of 600 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VariantStoreCreatedWaiter will use default max delay of 600 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -268,9 +269,9 @@ func NewVariantStoreCreatedWaiter(client GetVariantStoreAPIClient, optFns ...fun } } -// Wait calls the waiter function for VariantStoreCreated waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for VariantStoreCreated waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *VariantStoreCreatedWaiter) Wait(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreCreatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -438,9 +439,10 @@ type VariantStoreDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, VariantStoreDeletedWaiter will use default max delay of 600 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, VariantStoreDeletedWaiter will use default max delay of 600 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -480,9 +482,9 @@ func NewVariantStoreDeletedWaiter(client GetVariantStoreAPIClient, optFns ...fun } } -// Wait calls the waiter function for VariantStoreDeleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for VariantStoreDeleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *VariantStoreDeletedWaiter) Wait(ctx context.Context, params *GetVariantStoreInput, maxWaitDur time.Duration, optFns ...func(*VariantStoreDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/omics/api_op_GetWorkflow.go b/service/omics/api_op_GetWorkflow.go index 2145cf60f57..eee5cdaf71c 100644 --- a/service/omics/api_op_GetWorkflow.go +++ b/service/omics/api_op_GetWorkflow.go @@ -214,8 +214,8 @@ type WorkflowActiveWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, WorkflowActiveWaiter will use default max delay of 30 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, WorkflowActiveWaiter will use default max delay of 30 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/omics/api_op_ListReferenceStores.go b/service/omics/api_op_ListReferenceStores.go index 669cc8be426..450c3582d52 100644 --- a/service/omics/api_op_ListReferenceStores.go +++ b/service/omics/api_op_ListReferenceStores.go @@ -149,8 +149,8 @@ func addEndpointPrefix_opListReferenceStoresMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opListReferenceStoresMiddleware{}, `OperationSerializer`, middleware.After) } -// ListReferenceStoresAPIClient is a client that implements the ListReferenceStores -// operation. +// ListReferenceStoresAPIClient is a client that implements the +// ListReferenceStores operation. type ListReferenceStoresAPIClient interface { ListReferenceStores(context.Context, *ListReferenceStoresInput, ...func(*Options)) (*ListReferenceStoresOutput, error) } diff --git a/service/omics/api_op_StartReadSetActivationJob.go b/service/omics/api_op_StartReadSetActivationJob.go index 303b9148e6e..defc4fa8b38 100644 --- a/service/omics/api_op_StartReadSetActivationJob.go +++ b/service/omics/api_op_StartReadSetActivationJob.go @@ -13,8 +13,8 @@ import ( "time" ) -// Activates an archived read set. To reduce storage charges, Amazon Omics archives -// unused read sets after 30 days. +// Activates an archived read set. To reduce storage charges, Amazon Omics +// archives unused read sets after 30 days. func (c *Client) StartReadSetActivationJob(ctx context.Context, params *StartReadSetActivationJobInput, optFns ...func(*Options)) (*StartReadSetActivationJobOutput, error) { if params == nil { params = &StartReadSetActivationJobInput{} diff --git a/service/omics/document/document.go b/service/omics/document/document.go index a593ab00c9c..e3fa0ab97ba 100644 --- a/service/omics/document/document.go +++ b/service/omics/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/omics/internal/document/document.go b/service/omics/internal/document/document.go index c84adc33ca1..d9281d5a133 100644 --- a/service/omics/internal/document/document.go +++ b/service/omics/internal/document/document.go @@ -85,8 +85,9 @@ func NewDocumentUnmarshaler(v interface{}) Interface { } } -// github.com/aws/aws-sdk-go-v2/service/omics/internal/document.IsInterface returns -// whether the given Interface implementation is a valid client implementation +// github.com/aws/aws-sdk-go-v2/service/omics/internal/document.IsInterface +// returns whether the given Interface implementation is a valid client +// implementation func IsInterface(v Interface) (ok bool) { defer func() { if err := recover(); err != nil { diff --git a/service/omics/types/enums.go b/service/omics/types/enums.go index 0f78c319545..308e4452c25 100644 --- a/service/omics/types/enums.go +++ b/service/omics/types/enums.go @@ -120,9 +120,9 @@ const ( JobStatusCompletedWithFailures JobStatus = "COMPLETED_WITH_FAILURES" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -357,9 +357,10 @@ const ( ReferenceImportJobItemStatusFailed ReferenceImportJobItemStatus = "FAILED" ) -// Values returns all known values for ReferenceImportJobItemStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReferenceImportJobItemStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ReferenceImportJobItemStatus) Values() []ReferenceImportJobItemStatus { return []ReferenceImportJobItemStatus{ "NOT_STARTED", @@ -382,9 +383,9 @@ const ( ReferenceImportJobStatusCompletedWithFailures ReferenceImportJobStatus = "COMPLETED_WITH_FAILURES" ) -// Values returns all known values for ReferenceImportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReferenceImportJobStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceImportJobStatus) Values() []ReferenceImportJobStatus { return []ReferenceImportJobStatus{ "SUBMITTED", @@ -424,9 +425,9 @@ const ( RunExportDefinition RunExport = "DEFINITION" ) -// Values returns all known values for RunExport. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RunExport. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RunExport) Values() []RunExport { return []RunExport{ "DEFINITION", @@ -469,9 +470,9 @@ const ( RunStatusFailed RunStatus = "FAILED" ) -// Values returns all known values for RunStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RunStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RunStatus) Values() []RunStatus { return []RunStatus{ "PENDING", @@ -665,9 +666,9 @@ const ( WorkflowTypeService WorkflowType = "SERVICE" ) -// Values returns all known values for WorkflowType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WorkflowType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WorkflowType) Values() []WorkflowType { return []WorkflowType{ "PRIVATE", diff --git a/service/opensearch/api_client.go b/service/opensearch/api_client.go index 5e2730b3a91..abe8469ec37 100644 --- a/service/opensearch/api_client.go +++ b/service/opensearch/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/opensearch/api_op_AcceptInboundConnection.go b/service/opensearch/api_op_AcceptInboundConnection.go index 121d8ae4e24..63f65cae6dc 100644 --- a/service/opensearch/api_op_AcceptInboundConnection.go +++ b/service/opensearch/api_op_AcceptInboundConnection.go @@ -13,8 +13,8 @@ import ( // Allows the destination Amazon OpenSearch Service domain owner to accept an // inbound cross-cluster search connection request. For more information, see -// Cross-cluster search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) AcceptInboundConnection(ctx context.Context, params *AcceptInboundConnectionInput, optFns ...func(*Options)) (*AcceptInboundConnectionOutput, error) { if params == nil { params = &AcceptInboundConnectionInput{} diff --git a/service/opensearch/api_op_AddTags.go b/service/opensearch/api_op_AddTags.go index e95da171590..8531858d6f6 100644 --- a/service/opensearch/api_op_AddTags.go +++ b/service/opensearch/api_op_AddTags.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of -// case-sensitive key-value pairs. A domain can have up to 10 tags. For more -// information, see Tagging Amazon OpenSearch Service domains -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html). +// Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set +// of case-sensitive key-value pairs. A domain can have up to 10 tags. For more +// information, see Tagging Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html) +// . func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} diff --git a/service/opensearch/api_op_AssociatePackage.go b/service/opensearch/api_op_AssociatePackage.go index ecf07ba975a..94187f42586 100644 --- a/service/opensearch/api_op_AssociatePackage.go +++ b/service/opensearch/api_op_AssociatePackage.go @@ -12,8 +12,8 @@ import ( ) // Associates a package with an Amazon OpenSearch Service domain. For more -// information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) AssociatePackage(ctx context.Context, params *AssociatePackageInput, optFns ...func(*Options)) (*AssociatePackageOutput, error) { if params == nil { params = &AssociatePackageInput{} diff --git a/service/opensearch/api_op_CancelServiceSoftwareUpdate.go b/service/opensearch/api_op_CancelServiceSoftwareUpdate.go index d72ea1ac282..970d7112f7a 100644 --- a/service/opensearch/api_op_CancelServiceSoftwareUpdate.go +++ b/service/opensearch/api_op_CancelServiceSoftwareUpdate.go @@ -13,9 +13,9 @@ import ( // Cancels a scheduled service software update for an Amazon OpenSearch Service // domain. You can only perform this operation before the AutomatedUpdateDate and -// when the domain's UpdateStatus is PENDING_UPDATE. For more information, see -// Service software updates in Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html). +// when the domain's UpdateStatus is PENDING_UPDATE . For more information, see +// Service software updates in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// . func (c *Client) CancelServiceSoftwareUpdate(ctx context.Context, params *CancelServiceSoftwareUpdateInput, optFns ...func(*Options)) (*CancelServiceSoftwareUpdateOutput, error) { if params == nil { params = &CancelServiceSoftwareUpdateInput{} diff --git a/service/opensearch/api_op_CreateDomain.go b/service/opensearch/api_op_CreateDomain.go index 1ba7f6fd3e1..7aa28c38cbe 100644 --- a/service/opensearch/api_op_CreateDomain.go +++ b/service/opensearch/api_op_CreateDomain.go @@ -12,8 +12,8 @@ import ( ) // Creates an Amazon OpenSearch Service domain. For more information, see Creating -// and managing Amazon OpenSearch Service domains -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html). +// and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) +// . func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -43,32 +43,24 @@ type CreateDomainInput struct { // Key-value pairs to specify advanced configuration options. The following // key-value pairs are supported: - // - // * "rest.action.multi.allow_explicit_index": - // "true" | "false" - Note the use of a string rather than a boolean. Specifies - // whether explicit references to indexes are allowed inside the body of HTTP - // requests. If you want to configure access policies for domain sub-resources, - // such as specific indexes and domain APIs, you must disable this property. - // Default is true. - // - // * "indices.fielddata.cache.size": "80" - Note the use of a - // string rather than a boolean. Specifies the percentage of heap space allocated - // to field data. Default is unbounded. - // - // * "indices.query.bool.max_clause_count": - // "1024" - Note the use of a string rather than a boolean. Specifies the maximum - // number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries - // with more than the permitted number of clauses result in a TooManyClauses - // error. - // - // * "override_main_response_version": "true" | "false" - Note the use of a - // string rather than a boolean. Specifies whether the domain reports its version - // as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with - // it. Default is false when creating a domain and true when upgrading a - // domain. - // - // For more information, see Advanced cluster parameters - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). + // - "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of + // a string rather than a boolean. Specifies whether explicit references to indexes + // are allowed inside the body of HTTP requests. If you want to configure access + // policies for domain sub-resources, such as specific indexes and domain APIs, you + // must disable this property. Default is true. + // - "indices.fielddata.cache.size": "80" - Note the use of a string rather than + // a boolean. Specifies the percentage of heap space allocated to field data. + // Default is unbounded. + // - "indices.query.bool.max_clause_count": "1024" - Note the use of a string + // rather than a boolean. Specifies the maximum number of clauses allowed in a + // Lucene boolean query. Default is 1,024. Queries with more than the permitted + // number of clauses result in a TooManyClauses error. + // - "override_main_response_version": "true" | "false" - Note the use of a + // string rather than a boolean. Specifies whether the domain reports its version + // as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with + // it. Default is false when creating a domain and true when upgrading a domain. + // For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) + // . AdvancedOptions map[string]string // Options for fine-grained access control. @@ -82,12 +74,12 @@ type CreateDomainInput struct { // Key-value pairs to configure Amazon Cognito authentication. For more // information, see Configuring Amazon Cognito authentication for OpenSearch - // Dashboards - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html). + // Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) + // . CognitoOptions *types.CognitoOptions - // Additional options for the domain endpoint, such as whether to require HTTPS for - // all traffic. + // Additional options for the domain endpoint, such as whether to require HTTPS + // for all traffic. DomainEndpointOptions *types.DomainEndpointOptions // Container for the parameters required to enable EBS-based storage for an @@ -99,9 +91,9 @@ type CreateDomainInput struct { // String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine // version for the OpenSearch Service domain. For example, OpenSearch_1.0 or - // Elasticsearch_7.9. For more information, see Creating and managing Amazon - // OpenSearch Service domains - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains). + // Elasticsearch_7.9 . For more information, see Creating and managing Amazon + // OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains) + // . EngineVersion *string // Key-value pairs to configure slow log publishing. @@ -110,11 +102,11 @@ type CreateDomainInput struct { // Enables node-to-node encryption. NodeToNodeEncryptionOptions *types.NodeToNodeEncryptionOptions - // Specifies a daily 10-hour time block during which OpenSearch Service can perform - // configuration changes on the domain, including service software updates and - // Auto-Tune enhancements that require a blue/green deployment. If no options are - // specified, the default start time of 10:00 P.M. local time (for the Region that - // the domain is created in) is used. + // Specifies a daily 10-hour time block during which OpenSearch Service can + // perform configuration changes on the domain, including service software updates + // and Auto-Tune enhancements that require a blue/green deployment. If no options + // are specified, the default start time of 10:00 P.M. local time (for the Region + // that the domain is created in) is used. OffPeakWindowOptions *types.OffPeakWindowOptions // DEPRECATED. Container for the parameters required to configure automated @@ -130,15 +122,15 @@ type CreateDomainInput struct { // Container for the values required to configure VPC access domains. If you don't // specify these values, OpenSearch Service creates the domain with a public // endpoint. For more information, see Launching your Amazon OpenSearch Service - // domains using a VPC - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). + // domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) + // . VPCOptions *types.VPCOptions noSmithyDocumentSerde } -// The result of a CreateDomain operation. Contains the status of the newly created -// domain. +// The result of a CreateDomain operation. Contains the status of the newly +// created domain. type CreateDomainOutput struct { // The status of the newly created domain. diff --git a/service/opensearch/api_op_CreateOutboundConnection.go b/service/opensearch/api_op_CreateOutboundConnection.go index cff55c56991..5147de8975d 100644 --- a/service/opensearch/api_op_CreateOutboundConnection.go +++ b/service/opensearch/api_op_CreateOutboundConnection.go @@ -13,8 +13,8 @@ import ( // Creates a new cross-cluster search connection from a source Amazon OpenSearch // Service domain to a destination domain. For more information, see Cross-cluster -// search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) CreateOutboundConnection(ctx context.Context, params *CreateOutboundConnectionInput, optFns ...func(*Options)) (*CreateOutboundConnectionOutput, error) { if params == nil { params = &CreateOutboundConnectionInput{} diff --git a/service/opensearch/api_op_CreatePackage.go b/service/opensearch/api_op_CreatePackage.go index 81da072975d..08670a7c058 100644 --- a/service/opensearch/api_op_CreatePackage.go +++ b/service/opensearch/api_op_CreatePackage.go @@ -12,8 +12,8 @@ import ( ) // Creates a package for use with Amazon OpenSearch Service domains. For more -// information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, optFns ...func(*Options)) (*CreatePackageOutput, error) { if params == nil { params = &CreatePackageInput{} diff --git a/service/opensearch/api_op_DeleteInboundConnection.go b/service/opensearch/api_op_DeleteInboundConnection.go index 647a1bd9bff..bf2979787c3 100644 --- a/service/opensearch/api_op_DeleteInboundConnection.go +++ b/service/opensearch/api_op_DeleteInboundConnection.go @@ -13,8 +13,8 @@ import ( // Allows the destination Amazon OpenSearch Service domain owner to delete an // existing inbound cross-cluster search connection. For more information, see -// Cross-cluster search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) DeleteInboundConnection(ctx context.Context, params *DeleteInboundConnectionInput, optFns ...func(*Options)) (*DeleteInboundConnectionOutput, error) { if params == nil { params = &DeleteInboundConnectionInput{} diff --git a/service/opensearch/api_op_DeleteOutboundConnection.go b/service/opensearch/api_op_DeleteOutboundConnection.go index ebfd82ec690..9893e43646c 100644 --- a/service/opensearch/api_op_DeleteOutboundConnection.go +++ b/service/opensearch/api_op_DeleteOutboundConnection.go @@ -13,8 +13,8 @@ import ( // Allows the source Amazon OpenSearch Service domain owner to delete an existing // outbound cross-cluster search connection. For more information, see -// Cross-cluster search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) DeleteOutboundConnection(ctx context.Context, params *DeleteOutboundConnectionInput, optFns ...func(*Options)) (*DeleteOutboundConnectionOutput, error) { if params == nil { params = &DeleteOutboundConnectionInput{} diff --git a/service/opensearch/api_op_DeletePackage.go b/service/opensearch/api_op_DeletePackage.go index 71c56c2296e..65180f73357 100644 --- a/service/opensearch/api_op_DeletePackage.go +++ b/service/opensearch/api_op_DeletePackage.go @@ -12,8 +12,8 @@ import ( ) // Deletes an Amazon OpenSearch Service package. For more information, see Custom -// packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error) { if params == nil { params = &DeletePackageInput{} diff --git a/service/opensearch/api_op_DeleteVpcEndpoint.go b/service/opensearch/api_op_DeleteVpcEndpoint.go index 6f182270d02..28f593feebe 100644 --- a/service/opensearch/api_op_DeleteVpcEndpoint.go +++ b/service/opensearch/api_op_DeleteVpcEndpoint.go @@ -39,8 +39,8 @@ type DeleteVpcEndpointInput struct { type DeleteVpcEndpointOutput struct { - // Information about the deleted endpoint, including its current status (DELETING - // or DELETE_FAILED). + // Information about the deleted endpoint, including its current status ( DELETING + // or DELETE_FAILED ). // // This member is required. VpcEndpointSummary *types.VpcEndpointSummary diff --git a/service/opensearch/api_op_DescribeDomainAutoTunes.go b/service/opensearch/api_op_DescribeDomainAutoTunes.go index 795110508c1..4ddc0ebf729 100644 --- a/service/opensearch/api_op_DescribeDomainAutoTunes.go +++ b/service/opensearch/api_op_DescribeDomainAutoTunes.go @@ -14,8 +14,8 @@ import ( // Returns the list of optimizations that Auto-Tune has made to an Amazon // OpenSearch Service domain. For more information, see Auto-Tune for Amazon -// OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . func (c *Client) DescribeDomainAutoTunes(ctx context.Context, params *DescribeDomainAutoTunesInput, optFns ...func(*Options)) (*DescribeDomainAutoTunesOutput, error) { if params == nil { params = &DescribeDomainAutoTunesInput{} @@ -43,9 +43,9 @@ type DescribeDomainAutoTunesInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribeDomainAutoTunes operation returns a nextToken, you can - // include the returned nextToken in subsequent DescribeDomainAutoTunes operations, - // which returns results in the next page. + // If your initial DescribeDomainAutoTunes operation returns a nextToken , you can + // include the returned nextToken in subsequent DescribeDomainAutoTunes + // operations, which returns results in the next page. NextToken *string noSmithyDocumentSerde diff --git a/service/opensearch/api_op_DescribeDomainChangeProgress.go b/service/opensearch/api_op_DescribeDomainChangeProgress.go index 66722c0cd65..e39163395ea 100644 --- a/service/opensearch/api_op_DescribeDomainChangeProgress.go +++ b/service/opensearch/api_op_DescribeDomainChangeProgress.go @@ -12,9 +12,9 @@ import ( ) // Returns information about the current blue/green deployment happening on an -// Amazon OpenSearch Service domain. For more information, see Making configuration -// changes in Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html). +// Amazon OpenSearch Service domain. For more information, see Making +// configuration changes in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html) +// . func (c *Client) DescribeDomainChangeProgress(ctx context.Context, params *DescribeDomainChangeProgressInput, optFns ...func(*Options)) (*DescribeDomainChangeProgressOutput, error) { if params == nil { params = &DescribeDomainChangeProgressInput{} diff --git a/service/opensearch/api_op_DescribeDomains.go b/service/opensearch/api_op_DescribeDomains.go index 5527dc766f0..7f119fa5cf3 100644 --- a/service/opensearch/api_op_DescribeDomains.go +++ b/service/opensearch/api_op_DescribeDomains.go @@ -31,8 +31,8 @@ func (c *Client) DescribeDomains(ctx context.Context, params *DescribeDomainsInp // Container for the parameters to the DescribeDomains operation. type DescribeDomainsInput struct { - // Array of OpenSearch Service domain names that you want information about. If you - // don't specify any domains, OpenSearch Service returns information about all + // Array of OpenSearch Service domain names that you want information about. If + // you don't specify any domains, OpenSearch Service returns information about all // domains owned by the account. // // This member is required. diff --git a/service/opensearch/api_op_DescribeDryRunProgress.go b/service/opensearch/api_op_DescribeDryRunProgress.go index 03f1e4f2d23..a686dde8806 100644 --- a/service/opensearch/api_op_DescribeDryRunProgress.go +++ b/service/opensearch/api_op_DescribeDryRunProgress.go @@ -13,8 +13,8 @@ import ( // Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch // Service domain. For more information, see Determining whether a change will -// cause a blue/green deployment -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun). +// cause a blue/green deployment (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun) +// . func (c *Client) DescribeDryRunProgress(ctx context.Context, params *DescribeDryRunProgressInput, optFns ...func(*Options)) (*DescribeDryRunProgressOutput, error) { if params == nil { params = &DescribeDryRunProgressInput{} diff --git a/service/opensearch/api_op_DescribeInboundConnections.go b/service/opensearch/api_op_DescribeInboundConnections.go index 6d70c27705d..9fa93903058 100644 --- a/service/opensearch/api_op_DescribeInboundConnections.go +++ b/service/opensearch/api_op_DescribeInboundConnections.go @@ -14,8 +14,8 @@ import ( // Lists all the inbound cross-cluster search connections for a destination // (remote) Amazon OpenSearch Service domain. For more information, see -// Cross-cluster search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) DescribeInboundConnections(ctx context.Context, params *DescribeInboundConnectionsInput, optFns ...func(*Options)) (*DescribeInboundConnectionsOutput, error) { if params == nil { params = &DescribeInboundConnectionsInput{} @@ -42,7 +42,7 @@ type DescribeInboundConnectionsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribeInboundConnections operation returns a nextToken, you + // If your initial DescribeInboundConnections operation returns a nextToken , you // can include the returned nextToken in subsequent DescribeInboundConnections // operations, which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_DescribeInstanceTypeLimits.go b/service/opensearch/api_op_DescribeInstanceTypeLimits.go index c1d0344c99e..1c33091429a 100644 --- a/service/opensearch/api_op_DescribeInstanceTypeLimits.go +++ b/service/opensearch/api_op_DescribeInstanceTypeLimits.go @@ -53,8 +53,8 @@ type DescribeInstanceTypeLimitsInput struct { // operation. type DescribeInstanceTypeLimitsOutput struct { - // Map that contains all applicable instance type limits.data refers to data - // nodes.master refers to dedicated master nodes. + // Map that contains all applicable instance type limits. data refers to data + // nodes. master refers to dedicated master nodes. LimitsByRole map[string]types.Limits // Metadata pertaining to the operation's result. diff --git a/service/opensearch/api_op_DescribeOutboundConnections.go b/service/opensearch/api_op_DescribeOutboundConnections.go index ad918c4d4d4..3a91dfe1ee8 100644 --- a/service/opensearch/api_op_DescribeOutboundConnections.go +++ b/service/opensearch/api_op_DescribeOutboundConnections.go @@ -14,8 +14,8 @@ import ( // Lists all the outbound cross-cluster connections for a local (source) Amazon // OpenSearch Service domain. For more information, see Cross-cluster search for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . func (c *Client) DescribeOutboundConnections(ctx context.Context, params *DescribeOutboundConnectionsInput, optFns ...func(*Options)) (*DescribeOutboundConnectionsOutput, error) { if params == nil { params = &DescribeOutboundConnectionsInput{} @@ -41,7 +41,7 @@ type DescribeOutboundConnectionsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribeOutboundConnections operation returns a nextToken, you + // If your initial DescribeOutboundConnections operation returns a nextToken , you // can include the returned nextToken in subsequent DescribeOutboundConnections // operations, which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_DescribePackages.go b/service/opensearch/api_op_DescribePackages.go index 05b17a5ff41..cc9ed10b4e5 100644 --- a/service/opensearch/api_op_DescribePackages.go +++ b/service/opensearch/api_op_DescribePackages.go @@ -13,8 +13,8 @@ import ( ) // Describes all packages available to OpenSearch Service. For more information, -// see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) DescribePackages(ctx context.Context, params *DescribePackagesInput, optFns ...func(*Options)) (*DescribePackagesOutput, error) { if params == nil { params = &DescribePackagesInput{} @@ -40,7 +40,7 @@ type DescribePackagesInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribePackageFilters operation returns a nextToken, you can + // If your initial DescribePackageFilters operation returns a nextToken , you can // include the returned nextToken in subsequent DescribePackageFilters operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_DescribeReservedInstanceOfferings.go b/service/opensearch/api_op_DescribeReservedInstanceOfferings.go index 6e6218a9b71..dad4f03f984 100644 --- a/service/opensearch/api_op_DescribeReservedInstanceOfferings.go +++ b/service/opensearch/api_op_DescribeReservedInstanceOfferings.go @@ -14,8 +14,8 @@ import ( // Describes the available Amazon OpenSearch Service Reserved Instance offerings // for a given Region. For more information, see Reserved Instances in Amazon -// OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html). +// OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html) +// . func (c *Client) DescribeReservedInstanceOfferings(ctx context.Context, params *DescribeReservedInstanceOfferingsInput, optFns ...func(*Options)) (*DescribeReservedInstanceOfferingsOutput, error) { if params == nil { params = &DescribeReservedInstanceOfferingsInput{} @@ -39,8 +39,8 @@ type DescribeReservedInstanceOfferingsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribeReservedInstanceOfferings operation returns a nextToken, - // you can include the returned nextToken in subsequent + // If your initial DescribeReservedInstanceOfferings operation returns a nextToken + // , you can include the returned nextToken in subsequent // DescribeReservedInstanceOfferings operations, which returns results in the next // page. NextToken *string diff --git a/service/opensearch/api_op_DescribeReservedInstances.go b/service/opensearch/api_op_DescribeReservedInstances.go index af7ad5cf332..f7a82521bf8 100644 --- a/service/opensearch/api_op_DescribeReservedInstances.go +++ b/service/opensearch/api_op_DescribeReservedInstances.go @@ -14,8 +14,8 @@ import ( // Describes the Amazon OpenSearch Service instances that you have reserved in a // given Region. For more information, see Reserved Instances in Amazon OpenSearch -// Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html). +// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html) +// . func (c *Client) DescribeReservedInstances(ctx context.Context, params *DescribeReservedInstancesInput, optFns ...func(*Options)) (*DescribeReservedInstancesOutput, error) { if params == nil { params = &DescribeReservedInstancesInput{} @@ -38,8 +38,8 @@ type DescribeReservedInstancesInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial DescribeReservedInstances operation returns a nextToken, you can - // include the returned nextToken in subsequent DescribeReservedInstances + // If your initial DescribeReservedInstances operation returns a nextToken , you + // can include the returned nextToken in subsequent DescribeReservedInstances // operations, which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_DissociatePackage.go b/service/opensearch/api_op_DissociatePackage.go index 072c8c37487..78c23c93751 100644 --- a/service/opensearch/api_op_DissociatePackage.go +++ b/service/opensearch/api_op_DissociatePackage.go @@ -14,8 +14,8 @@ import ( // Removes a package from the specified Amazon OpenSearch Service domain. The // package can't be in use with any OpenSearch index for the dissociation to // succeed. The package is still available in OpenSearch Service for association -// later. For more information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// later. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) DissociatePackage(ctx context.Context, params *DissociatePackageInput, optFns ...func(*Options)) (*DissociatePackageOutput, error) { if params == nil { params = &DissociatePackageInput{} diff --git a/service/opensearch/api_op_GetCompatibleVersions.go b/service/opensearch/api_op_GetCompatibleVersions.go index c52ad7d355e..d87fd2487f6 100644 --- a/service/opensearch/api_op_GetCompatibleVersions.go +++ b/service/opensearch/api_op_GetCompatibleVersions.go @@ -31,8 +31,8 @@ func (c *Client) GetCompatibleVersions(ctx context.Context, params *GetCompatibl // Container for the request parameters to GetCompatibleVersions operation. type GetCompatibleVersionsInput struct { - // The name of an existing domain. Provide this parameter to limit the results to a - // single domain. + // The name of an existing domain. Provide this parameter to limit the results to + // a single domain. DomainName *string noSmithyDocumentSerde diff --git a/service/opensearch/api_op_GetPackageVersionHistory.go b/service/opensearch/api_op_GetPackageVersionHistory.go index 73d25715ab5..7466b306398 100644 --- a/service/opensearch/api_op_GetPackageVersionHistory.go +++ b/service/opensearch/api_op_GetPackageVersionHistory.go @@ -14,8 +14,8 @@ import ( // Returns a list of Amazon OpenSearch Service package versions, along with their // creation time and commit message. For more information, see Custom packages for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) GetPackageVersionHistory(ctx context.Context, params *GetPackageVersionHistoryInput, optFns ...func(*Options)) (*GetPackageVersionHistoryOutput, error) { if params == nil { params = &GetPackageVersionHistoryInput{} @@ -43,7 +43,7 @@ type GetPackageVersionHistoryInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial GetPackageVersionHistory operation returns a nextToken, you can + // If your initial GetPackageVersionHistory operation returns a nextToken , you can // include the returned nextToken in subsequent GetPackageVersionHistory // operations, which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_GetUpgradeHistory.go b/service/opensearch/api_op_GetUpgradeHistory.go index 10aba6e6544..599e76040d7 100644 --- a/service/opensearch/api_op_GetUpgradeHistory.go +++ b/service/opensearch/api_op_GetUpgradeHistory.go @@ -41,9 +41,9 @@ type GetUpgradeHistoryInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial GetUpgradeHistory operation returns a nextToken, you can include - // the returned nextToken in subsequent GetUpgradeHistory operations, which returns - // results in the next page. + // If your initial GetUpgradeHistory operation returns a nextToken , you can + // include the returned nextToken in subsequent GetUpgradeHistory operations, + // which returns results in the next page. NextToken *string noSmithyDocumentSerde diff --git a/service/opensearch/api_op_ListDomainsForPackage.go b/service/opensearch/api_op_ListDomainsForPackage.go index 9bee0e58568..ccd1f933dbe 100644 --- a/service/opensearch/api_op_ListDomainsForPackage.go +++ b/service/opensearch/api_op_ListDomainsForPackage.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Amazon OpenSearch Service domains associated with a given package. For -// more information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// Lists all Amazon OpenSearch Service domains associated with a given package. +// For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) ListDomainsForPackage(ctx context.Context, params *ListDomainsForPackageInput, optFns ...func(*Options)) (*ListDomainsForPackageOutput, error) { if params == nil { params = &ListDomainsForPackageInput{} @@ -42,7 +42,7 @@ type ListDomainsForPackageInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial ListDomainsForPackage operation returns a nextToken, you can + // If your initial ListDomainsForPackage operation returns a nextToken , you can // include the returned nextToken in subsequent ListDomainsForPackage operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_ListInstanceTypeDetails.go b/service/opensearch/api_op_ListInstanceTypeDetails.go index 143cb18b9dc..b05318da6d3 100644 --- a/service/opensearch/api_op_ListInstanceTypeDetails.go +++ b/service/opensearch/api_op_ListInstanceTypeDetails.go @@ -44,9 +44,9 @@ type ListInstanceTypeDetailsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial ListInstanceTypeDetails operation returns a nextToken, you can - // include the returned nextToken in subsequent ListInstanceTypeDetails operations, - // which returns results in the next page. + // If your initial ListInstanceTypeDetails operation returns a nextToken , you can + // include the returned nextToken in subsequent ListInstanceTypeDetails + // operations, which returns results in the next page. NextToken *string noSmithyDocumentSerde diff --git a/service/opensearch/api_op_ListPackagesForDomain.go b/service/opensearch/api_op_ListPackagesForDomain.go index 5b9cad80c5a..a3a73232299 100644 --- a/service/opensearch/api_op_ListPackagesForDomain.go +++ b/service/opensearch/api_op_ListPackagesForDomain.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all packages associated with an Amazon OpenSearch Service domain. For more -// information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// Lists all packages associated with an Amazon OpenSearch Service domain. For +// more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) ListPackagesForDomain(ctx context.Context, params *ListPackagesForDomainInput, optFns ...func(*Options)) (*ListPackagesForDomainOutput, error) { if params == nil { params = &ListPackagesForDomainInput{} @@ -42,7 +42,7 @@ type ListPackagesForDomainInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial ListPackagesForDomain operation returns a nextToken, you can + // If your initial ListPackagesForDomain operation returns a nextToken , you can // include the returned nextToken in subsequent ListPackagesForDomain operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_ListScheduledActions.go b/service/opensearch/api_op_ListScheduledActions.go index f00acde6bfa..0b2767547af 100644 --- a/service/opensearch/api_op_ListScheduledActions.go +++ b/service/opensearch/api_op_ListScheduledActions.go @@ -12,11 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of configuration changes that are scheduled for a domain. These -// changes can be service software updates -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) -// or blue/green Auto-Tune enhancements -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types). +// Retrieves a list of configuration changes that are scheduled for a domain. +// These changes can be service software updates (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// or blue/green Auto-Tune enhancements (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types) +// . func (c *Client) ListScheduledActions(ctx context.Context, params *ListScheduledActionsInput, optFns ...func(*Options)) (*ListScheduledActionsOutput, error) { if params == nil { params = &ListScheduledActionsInput{} @@ -43,7 +42,7 @@ type ListScheduledActionsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial ListScheduledActions operation returns a nextToken, you can + // If your initial ListScheduledActions operation returns a nextToken , you can // include the returned nextToken in subsequent ListScheduledActions operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_ListTags.go b/service/opensearch/api_op_ListTags.go index 5ade71b6635..410e6b8c25f 100644 --- a/service/opensearch/api_op_ListTags.go +++ b/service/opensearch/api_op_ListTags.go @@ -12,8 +12,8 @@ import ( ) // Returns all resource tags for an Amazon OpenSearch Service domain. For more -// information, see Tagging Amazon OpenSearch Service domains -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html). +// information, see Tagging Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html) +// . func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} diff --git a/service/opensearch/api_op_ListVersions.go b/service/opensearch/api_op_ListVersions.go index da9389d8070..555db59b4c7 100644 --- a/service/opensearch/api_op_ListVersions.go +++ b/service/opensearch/api_op_ListVersions.go @@ -35,7 +35,7 @@ type ListVersionsInput struct { // You can use nextToken to get the next page of results. MaxResults int32 - // If your initial ListVersions operation returns a nextToken, you can include the + // If your initial ListVersions operation returns a nextToken , you can include the // returned nextToken in subsequent ListVersions operations, which returns results // in the next page. NextToken *string diff --git a/service/opensearch/api_op_ListVpcEndpointAccess.go b/service/opensearch/api_op_ListVpcEndpointAccess.go index eb8b1c2922e..76f6e497bf5 100644 --- a/service/opensearch/api_op_ListVpcEndpointAccess.go +++ b/service/opensearch/api_op_ListVpcEndpointAccess.go @@ -36,7 +36,7 @@ type ListVpcEndpointAccessInput struct { // This member is required. DomainName *string - // If your initial ListVpcEndpointAccess operation returns a nextToken, you can + // If your initial ListVpcEndpointAccess operation returns a nextToken , you can // include the returned nextToken in subsequent ListVpcEndpointAccess operations, // which returns results in the next page. NextToken *string @@ -46,8 +46,7 @@ type ListVpcEndpointAccessInput struct { type ListVpcEndpointAccessOutput struct { - // A list of IAM principals - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) + // A list of IAM principals (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) // that can currently access the domain. // // This member is required. diff --git a/service/opensearch/api_op_ListVpcEndpoints.go b/service/opensearch/api_op_ListVpcEndpoints.go index f6a62dd2fbd..ea302cd2eac 100644 --- a/service/opensearch/api_op_ListVpcEndpoints.go +++ b/service/opensearch/api_op_ListVpcEndpoints.go @@ -30,7 +30,7 @@ func (c *Client) ListVpcEndpoints(ctx context.Context, params *ListVpcEndpointsI type ListVpcEndpointsInput struct { - // If your initial ListVpcEndpoints operation returns a nextToken, you can include + // If your initial ListVpcEndpoints operation returns a nextToken , you can include // the returned nextToken in subsequent ListVpcEndpoints operations, which returns // results in the next page. NextToken *string diff --git a/service/opensearch/api_op_ListVpcEndpointsForDomain.go b/service/opensearch/api_op_ListVpcEndpointsForDomain.go index c0046db80f2..04ed04e37de 100644 --- a/service/opensearch/api_op_ListVpcEndpointsForDomain.go +++ b/service/opensearch/api_op_ListVpcEndpointsForDomain.go @@ -35,7 +35,7 @@ type ListVpcEndpointsForDomainInput struct { // This member is required. DomainName *string - // If your initial ListEndpointsForDomain operation returns a nextToken, you can + // If your initial ListEndpointsForDomain operation returns a nextToken , you can // include the returned nextToken in subsequent ListEndpointsForDomain operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearch/api_op_RemoveTags.go b/service/opensearch/api_op_RemoveTags.go index 6c93b9838ab..3e9276a691e 100644 --- a/service/opensearch/api_op_RemoveTags.go +++ b/service/opensearch/api_op_RemoveTags.go @@ -11,8 +11,8 @@ import ( ) // Removes the specified set of tags from an Amazon OpenSearch Service domain. For -// more information, see Tagging Amazon OpenSearch Service domains -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging). +// more information, see Tagging Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging) +// . func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error) { if params == nil { params = &RemoveTagsInput{} diff --git a/service/opensearch/api_op_StartServiceSoftwareUpdate.go b/service/opensearch/api_op_StartServiceSoftwareUpdate.go index 4997ad410c7..69c6eb222b1 100644 --- a/service/opensearch/api_op_StartServiceSoftwareUpdate.go +++ b/service/opensearch/api_op_StartServiceSoftwareUpdate.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Schedules a service software update for an Amazon OpenSearch Service domain. For -// more information, see Service software updates in Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html). +// Schedules a service software update for an Amazon OpenSearch Service domain. +// For more information, see Service software updates in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// . func (c *Client) StartServiceSoftwareUpdate(ctx context.Context, params *StartServiceSoftwareUpdateInput, optFns ...func(*Options)) (*StartServiceSoftwareUpdateOutput, error) { if params == nil { params = &StartServiceSoftwareUpdateInput{} @@ -38,27 +38,21 @@ type StartServiceSoftwareUpdateInput struct { // This member is required. DomainName *string - // The Epoch timestamp when you want the service software update to start. You only - // need to specify this parameter if you set ScheduleAt to TIMESTAMP. + // The Epoch timestamp when you want the service software update to start. You + // only need to specify this parameter if you set ScheduleAt to TIMESTAMP . DesiredStartTime *int64 // When to start the service software update. - // - // * NOW - Immediately schedules the - // update to happen in the current hour if there's capacity available. - // - // * TIMESTAMP - // - Lets you specify a custom date and time to apply the update. If you specify - // this value, you must also provide a value for DesiredStartTime. - // - // * - // OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak - // window. There's no guarantee that the update will happen during the next - // immediate window. Depending on capacity, it might happen in subsequent - // days. - // - // Default: NOW if you don't specify a value for DesiredStartTime, and - // TIMESTAMP if you do. + // - NOW - Immediately schedules the update to happen in the current hour if + // there's capacity available. + // - TIMESTAMP - Lets you specify a custom date and time to apply the update. If + // you specify this value, you must also provide a value for DesiredStartTime . + // - OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming + // off-peak window. There's no guarantee that the update will happen during the + // next immediate window. Depending on capacity, it might happen in subsequent + // days. + // Default: NOW if you don't specify a value for DesiredStartTime , and TIMESTAMP + // if you do. ScheduleAt types.ScheduleAt noSmithyDocumentSerde diff --git a/service/opensearch/api_op_UpdateDomainConfig.go b/service/opensearch/api_op_UpdateDomainConfig.go index 8d5cc41c61f..6066b4e2d14 100644 --- a/service/opensearch/api_op_UpdateDomainConfig.go +++ b/service/opensearch/api_op_UpdateDomainConfig.go @@ -41,32 +41,24 @@ type UpdateDomainConfigInput struct { // Key-value pairs to specify advanced configuration options. The following // key-value pairs are supported: - // - // * "rest.action.multi.allow_explicit_index": - // "true" | "false" - Note the use of a string rather than a boolean. Specifies - // whether explicit references to indexes are allowed inside the body of HTTP - // requests. If you want to configure access policies for domain sub-resources, - // such as specific indexes and domain APIs, you must disable this property. - // Default is true. - // - // * "indices.fielddata.cache.size": "80" - Note the use of a - // string rather than a boolean. Specifies the percentage of heap space allocated - // to field data. Default is unbounded. - // - // * "indices.query.bool.max_clause_count": - // "1024" - Note the use of a string rather than a boolean. Specifies the maximum - // number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries - // with more than the permitted number of clauses result in a TooManyClauses - // error. - // - // * "override_main_response_version": "true" | "false" - Note the use of a - // string rather than a boolean. Specifies whether the domain reports its version - // as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with - // it. Default is false when creating a domain and true when upgrading a - // domain. - // - // For more information, see Advanced cluster parameters - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). + // - "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of + // a string rather than a boolean. Specifies whether explicit references to indexes + // are allowed inside the body of HTTP requests. If you want to configure access + // policies for domain sub-resources, such as specific indexes and domain APIs, you + // must disable this property. Default is true. + // - "indices.fielddata.cache.size": "80" - Note the use of a string rather than + // a boolean. Specifies the percentage of heap space allocated to field data. + // Default is unbounded. + // - "indices.query.bool.max_clause_count": "1024" - Note the use of a string + // rather than a boolean. Specifies the maximum number of clauses allowed in a + // Lucene boolean query. Default is 1,024. Queries with more than the permitted + // number of clauses result in a TooManyClauses error. + // - "override_main_response_version": "true" | "false" - Note the use of a + // string rather than a boolean. Specifies whether the domain reports its version + // as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with + // it. Default is false when creating a domain and true when upgrading a domain. + // For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) + // . AdvancedOptions map[string]string // Options for fine-grained access control. @@ -75,16 +67,16 @@ type UpdateDomainConfigInput struct { // Options for Auto-Tune. AutoTuneOptions *types.AutoTuneOptions - // Changes that you want to make to the cluster configuration, such as the instance - // type and number of EC2 instances. + // Changes that you want to make to the cluster configuration, such as the + // instance type and number of EC2 instances. ClusterConfig *types.ClusterConfig // Key-value pairs to configure Amazon Cognito authentication for OpenSearch // Dashboards. CognitoOptions *types.CognitoOptions - // Additional options for the domain endpoint, such as whether to require HTTPS for - // all traffic. + // Additional options for the domain endpoint, such as whether to require HTTPS + // for all traffic. DomainEndpointOptions *types.DomainEndpointOptions // This flag, when set to True, specifies whether the UpdateDomain request should @@ -93,14 +85,11 @@ type UpdateDomainConfigInput struct { DryRun *bool // The type of dry run to perform. - // - // * Basic only returns the type of deployment - // (blue/green or dynamic) that the update will cause. - // - // * Verbose runs an - // additional check to validate the changes you're making. For more information, - // see Validating a domain update - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check). + // - Basic only returns the type of deployment (blue/green or dynamic) that the + // update will cause. + // - Verbose runs an additional check to validate the changes you're making. For + // more information, see Validating a domain update (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check) + // . DryRunMode types.DryRunMode // The type and size of the EBS volume to attach to instances in the domain. @@ -118,16 +107,16 @@ type UpdateDomainConfigInput struct { // Off-peak window options for the domain. OffPeakWindowOptions *types.OffPeakWindowOptions - // Option to set the time, in UTC format, for the daily automated snapshot. Default - // value is 0 hours. + // Option to set the time, in UTC format, for the daily automated snapshot. + // Default value is 0 hours. SnapshotOptions *types.SnapshotOptions // Service software update options for the domain. SoftwareUpdateOptions *types.SoftwareUpdateOptions // Options to specify the subnets and security groups for a VPC endpoint. For more - // information, see Launching your Amazon OpenSearch Service domains using a VPC - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). + // information, see Launching your Amazon OpenSearch Service domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) + // . VPCOptions *types.VPCOptions noSmithyDocumentSerde diff --git a/service/opensearch/api_op_UpdatePackage.go b/service/opensearch/api_op_UpdatePackage.go index e2add7b2883..20fa73ea221 100644 --- a/service/opensearch/api_op_UpdatePackage.go +++ b/service/opensearch/api_op_UpdatePackage.go @@ -12,8 +12,8 @@ import ( ) // Updates a package for use with Amazon OpenSearch Service domains. For more -// information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . func (c *Client) UpdatePackage(ctx context.Context, params *UpdatePackageInput, optFns ...func(*Options)) (*UpdatePackageOutput, error) { if params == nil { params = &UpdatePackageInput{} @@ -43,7 +43,7 @@ type UpdatePackageInput struct { PackageSource *types.PackageSource // Commit message for the updated file, which is shown as part of - // GetPackageVersionHistoryResponse. + // GetPackageVersionHistoryResponse . CommitMessage *string // A new description of the package. diff --git a/service/opensearch/api_op_UpdateScheduledAction.go b/service/opensearch/api_op_UpdateScheduledAction.go index 3830389d9dd..fe6620ebe29 100644 --- a/service/opensearch/api_op_UpdateScheduledAction.go +++ b/service/opensearch/api_op_UpdateScheduledAction.go @@ -12,10 +12,9 @@ import ( ) // Reschedules a planned domain configuration change for a later time. This change -// can be a scheduled service software update -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) -// or a blue/green Auto-Tune enhancement -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types). +// can be a scheduled service software update (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// or a blue/green Auto-Tune enhancement (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types) +// . func (c *Client) UpdateScheduledAction(ctx context.Context, params *UpdateScheduledActionInput, optFns ...func(*Options)) (*UpdateScheduledActionOutput, error) { if params == nil { params = &UpdateScheduledActionInput{} @@ -34,17 +33,15 @@ func (c *Client) UpdateScheduledAction(ctx context.Context, params *UpdateSchedu type UpdateScheduledActionInput struct { // The unique identifier of the action to reschedule. To retrieve this ID, send a - // ListScheduledActions - // (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) + // ListScheduledActions (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) // request. // // This member is required. ActionID *string - // The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, - // JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a - // ListScheduledActions - // (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) + // The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE , + // JVM_HEAP_SIZE_TUNING , or JVM_YOUNG_GEN_TUNING . To retrieve this value, send a + // ListScheduledActions (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) // request. // // This member is required. @@ -56,24 +53,20 @@ type UpdateScheduledActionInput struct { DomainName *string // When to schedule the action. - // - // * NOW - Immediately schedules the update to happen - // in the current hour if there's capacity available. - // - // * TIMESTAMP - Lets you - // specify a custom date and time to apply the update. If you specify this value, - // you must also provide a value for DesiredStartTime. - // - // * OFF_PEAK_WINDOW - Marks - // the action to be picked up during an upcoming off-peak window. There's no - // guarantee that the change will be implemented during the next immediate window. - // Depending on capacity, it might happen in subsequent days. + // - NOW - Immediately schedules the update to happen in the current hour if + // there's capacity available. + // - TIMESTAMP - Lets you specify a custom date and time to apply the update. If + // you specify this value, you must also provide a value for DesiredStartTime . + // - OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming + // off-peak window. There's no guarantee that the change will be implemented during + // the next immediate window. Depending on capacity, it might happen in subsequent + // days. // // This member is required. ScheduleAt types.ScheduleAt // The time to implement the change, in Coordinated Universal Time (UTC). Only - // specify this parameter if you set ScheduleAt to TIMESTAMP. + // specify this parameter if you set ScheduleAt to TIMESTAMP . DesiredStartTime *int64 noSmithyDocumentSerde diff --git a/service/opensearch/api_op_UpgradeDomain.go b/service/opensearch/api_op_UpgradeDomain.go index 1da32926e3a..2fe74158c8c 100644 --- a/service/opensearch/api_op_UpgradeDomain.go +++ b/service/opensearch/api_op_UpgradeDomain.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to either upgrade your Amazon OpenSearch Service domain or perform an -// upgrade eligibility check to a compatible version of OpenSearch or +// Allows you to either upgrade your Amazon OpenSearch Service domain or perform +// an upgrade eligibility check to a compatible version of OpenSearch or // Elasticsearch. func (c *Client) UpgradeDomain(ctx context.Context, params *UpgradeDomainInput, optFns ...func(*Options)) (*UpgradeDomainOutput, error) { if params == nil { diff --git a/service/opensearch/doc.go b/service/opensearch/doc.go index 4a054975d4a..854cbac2d5f 100644 --- a/service/opensearch/doc.go +++ b/service/opensearch/doc.go @@ -5,13 +5,11 @@ // // Use the Amazon OpenSearch Service configuration API to create, configure, and // manage OpenSearch Service domains. For sample code that uses the configuration -// API, see the Amazon OpenSearch Service Developer Guide -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-configuration-samples.html). -// The guide also contains sample code -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html) +// API, see the Amazon OpenSearch Service Developer Guide (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-configuration-samples.html) +// . The guide also contains sample code (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html) // for sending signed HTTP requests to the OpenSearch APIs. The endpoint for // configuration service requests is Region specific: es.region.amazonaws.com. For // example, es.us-east-1.amazonaws.com. For a current list of supported Regions and -// endpoints, see Amazon Web Services service endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions). +// endpoints, see Amazon Web Services service endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions) +// . package opensearch diff --git a/service/opensearch/types/enums.go b/service/opensearch/types/enums.go index 35b8589a8d5..2ec6016e307 100644 --- a/service/opensearch/types/enums.go +++ b/service/opensearch/types/enums.go @@ -34,9 +34,9 @@ const ( ActionStatusEligible ActionStatus = "ELIGIBLE" ) -// Values returns all known values for ActionStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActionStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ActionStatus) Values() []ActionStatus { return []ActionStatus{ "PENDING_UPDATE", @@ -125,9 +125,9 @@ const ( AutoTuneTypeScheduledAction AutoTuneType = "SCHEDULED_ACTION" ) -// Values returns all known values for AutoTuneType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoTuneType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneType) Values() []AutoTuneType { return []AutoTuneType{ "SCHEDULED_ACTION", @@ -570,9 +570,10 @@ const ( OutboundConnectionStatusCodeDeleted OutboundConnectionStatusCode = "DELETED" ) -// Values returns all known values for OutboundConnectionStatusCode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutboundConnectionStatusCode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (OutboundConnectionStatusCode) Values() []OutboundConnectionStatusCode { return []OutboundConnectionStatusCode{ "VALIDATING", diff --git a/service/opensearch/types/errors.go b/service/opensearch/types/errors.go index 115acb3de70..d08f5540294 100644 --- a/service/opensearch/types/errors.go +++ b/service/opensearch/types/errors.go @@ -166,8 +166,8 @@ func (e *InvalidPaginationTokenException) ErrorCode() string { } func (e *InvalidPaginationTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An exception for trying to create or access a sub-resource that's either invalid -// or not supported. +// An exception for trying to create or access a sub-resource that's either +// invalid or not supported. type InvalidTypeException struct { Message *string diff --git a/service/opensearch/types/types.go b/service/opensearch/types/types.go index e6f2a911c17..61e356a9f2e 100644 --- a/service/opensearch/types/types.go +++ b/service/opensearch/types/types.go @@ -13,8 +13,8 @@ type AccessPoliciesStatus struct { // The access policy configured for the domain. Access policies can be // resource-based, IP-based, or IAM-based. For more information, see Configuring - // access policies - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies). + // access policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies) + // . // // This member is required. Options *string @@ -30,13 +30,12 @@ type AccessPoliciesStatus struct { // List of limits that are specific to a given instance type. type AdditionalLimit struct { - // * MaximumNumberOfDataNodesSupported - This attribute only applies to master - // nodes and specifies the maximum number of data nodes of a given instance type a - // master node can support. - // - // * MaximumNumberOfDataNodesWithoutMasterNode - This - // attribute only applies to data nodes and specifies the maximum number of data - // nodes of a given instance type can exist without a master node governing them. + // - MaximumNumberOfDataNodesSupported - This attribute only applies to master + // nodes and specifies the maximum number of data nodes of a given instance type a + // master node can support. + // - MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to + // data nodes and specifies the maximum number of data nodes of a given instance + // type can exist without a master node governing them. LimitName *string // The values of the additional instance type limits. @@ -47,32 +46,25 @@ type AdditionalLimit struct { // Status of the advanced options for the specified domain. The following options // are available: +// - "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of +// a string rather than a boolean. Specifies whether explicit references to indexes +// are allowed inside the body of HTTP requests. If you want to configure access +// policies for domain sub-resources, such as specific indexes and domain APIs, you +// must disable this property. Default is true. +// - "indices.fielddata.cache.size": "80" - Note the use of a string rather than +// a boolean. Specifies the percentage of heap space allocated to field data. +// Default is unbounded. +// - "indices.query.bool.max_clause_count": "1024" - Note the use of a string +// rather than a boolean. Specifies the maximum number of clauses allowed in a +// Lucene boolean query. Default is 1,024. Queries with more than the permitted +// number of clauses result in a TooManyClauses error. +// - "override_main_response_version": "true" | "false" - Note the use of a +// string rather than a boolean. Specifies whether the domain reports its version +// as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with +// it. Default is false when creating a domain and true when upgrading a domain. // -// * "rest.action.multi.allow_explicit_index": "true" | "false" - -// Note the use of a string rather than a boolean. Specifies whether explicit -// references to indexes are allowed inside the body of HTTP requests. If you want -// to configure access policies for domain sub-resources, such as specific indexes -// and domain APIs, you must disable this property. Default is true. -// -// * -// "indices.fielddata.cache.size": "80" - Note the use of a string rather than a -// boolean. Specifies the percentage of heap space allocated to field data. Default -// is unbounded. -// -// * "indices.query.bool.max_clause_count": "1024" - Note the use of -// a string rather than a boolean. Specifies the maximum number of clauses allowed -// in a Lucene boolean query. Default is 1,024. Queries with more than the -// permitted number of clauses result in a TooManyClauses error. -// -// * -// "override_main_response_version": "true" | "false" - Note the use of a string -// rather than a boolean. Specifies whether the domain reports its version as 7.10 -// to allow Elasticsearch OSS clients and plugins to continue working with it. -// Default is false when creating a domain and true when upgrading a domain. -// -// For -// more information, see Advanced cluster parameters -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). +// For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) +// . type AdvancedOptionsStatus struct { // The status of advanced options for the specified domain. @@ -92,14 +84,14 @@ type AdvancedOptionsStatus struct { type AdvancedSecurityOptions struct { // Date and time when the migration period will be disabled. Only necessary when - // enabling fine-grained access control on an existing domain - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). + // enabling fine-grained access control on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) + // . AnonymousAuthDisableDate *time.Time // True if a 30-day migration period is enabled, during which administrators can // create role mappings. Only necessary when enabling fine-grained access control - // on an existing domain - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). + // on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) + // . AnonymousAuthEnabled *bool // True if fine-grained access control is enabled. @@ -116,14 +108,14 @@ type AdvancedSecurityOptions struct { } // Options for enabling and configuring fine-grained access control. For more -// information, see Fine-grained access control in Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html). +// information, see Fine-grained access control in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html) +// . type AdvancedSecurityOptionsInput struct { // True to enable a 30-day migration period during which administrators can create // role mappings. Only necessary when enabling fine-grained access control on an - // existing domain - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). + // existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) + // . AnonymousAuthEnabled *bool // True to enable fine-grained access control. @@ -163,8 +155,7 @@ type AdvancedSecurityOptionsStatus struct { // endpoint. type AuthorizedPrincipal struct { - // The IAM principal - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) + // The IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) // that is allowed access to the domain. Principal *string @@ -175,8 +166,8 @@ type AuthorizedPrincipal struct { } // Information about an Auto-Tune action. For more information, see Auto-Tune for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type AutoTune struct { // Details about an Auto-Tune action. @@ -189,8 +180,8 @@ type AutoTune struct { } // Specifies details about a scheduled Auto-Tune action. For more information, see -// Auto-Tune for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type AutoTuneDetails struct { // Container for details about a scheduled Auto-Tune action. @@ -199,14 +190,12 @@ type AutoTuneDetails struct { noSmithyDocumentSerde } -// This object is deprecated. Use the domain's off-peak window -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) +// This object is deprecated. Use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) // to schedule Auto-Tune optimizations. For migration instructions, see Migrating -// from Auto-Tune maintenance windows -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate). -// The Auto-Tune maintenance schedule. For more information, see Auto-Tune for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// from Auto-Tune maintenance windows (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate) +// . The Auto-Tune maintenance schedule. For more information, see Auto-Tune for +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type AutoTuneMaintenanceSchedule struct { // A cron expression for a recurring maintenance schedule during which Auto-Tune @@ -214,7 +203,7 @@ type AutoTuneMaintenanceSchedule struct { CronExpressionForRecurrence *string // The duration of the maintenance schedule. For example, "Duration": {"Value": 2, - // "Unit": "HOURS"}. + // "Unit": "HOURS"} . Duration *Duration // The Epoch timestamp at which the Auto-Tune maintenance schedule starts. @@ -224,27 +213,25 @@ type AutoTuneMaintenanceSchedule struct { } // Auto-Tune settings when updating a domain. For more information, see Auto-Tune -// for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type AutoTuneOptions struct { // Whether Auto-Tune is enabled or disabled. DesiredState AutoTuneDesiredState - // DEPRECATED. Use off-peak window - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) + // DEPRECATED. Use off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) // instead. A list of maintenance schedules during which Auto-Tune can deploy // changes. MaintenanceSchedules []AutoTuneMaintenanceSchedule // When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune // settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If - // you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the + // you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the // request. Otherwise, OpenSearch Service is unable to perform the rollback. RollbackOnDisable RollbackOnDisable - // Whether to use the domain's off-peak window - // (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) + // Whether to use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) // to deploy configuration changes on the domain rather than a maintenance // schedule. UseOffPeakWindow *bool @@ -253,16 +240,15 @@ type AutoTuneOptions struct { } // Options for configuring Auto-Tune. For more information, see Auto-Tune for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) type AutoTuneOptionsInput struct { // Whether Auto-Tune is enabled or disabled. DesiredState AutoTuneDesiredState // A list of maintenance schedules during which Auto-Tune can deploy changes. - // Maintenance windows are deprecated and have been replaced with off-peak windows - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html). + // Maintenance windows are deprecated and have been replaced with off-peak windows (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) + // . MaintenanceSchedules []AutoTuneMaintenanceSchedule // Whether to schedule Auto-Tune optimizations that require blue/green deployments @@ -302,8 +288,8 @@ type AutoTuneOptionsStatus struct { } // The current status of Auto-Tune for the domain. For more information, see -// Auto-Tune for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type AutoTuneStatus struct { // Date and time when Auto-Tune was enabled for the domain. @@ -411,8 +397,8 @@ type ChangeProgressStatusDetails struct { } // Container for the cluster configuration of an OpenSearch Service domain. For -// more information, see Creating and managing Amazon OpenSearch Service domains -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html). +// more information, see Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) +// . type ClusterConfig struct { // Container for cold storage configuration options. @@ -422,8 +408,8 @@ type ClusterConfig struct { // than 1, otherwise you receive a validation exception. DedicatedMasterCount *int32 - // Indicates whether dedicated master nodes are enabled for the cluster.True if the - // cluster will use a dedicated master node.False if the cluster will not. + // Indicates whether dedicated master nodes are enabled for the cluster. True if + // the cluster will use a dedicated master node. False if the cluster will not. DedicatedMasterEnabled *bool // OpenSearch Service instance type of the dedicated master nodes in the cluster. @@ -446,12 +432,12 @@ type ClusterConfig struct { WarmType OpenSearchWarmPartitionInstanceType // Container for zone awareness configuration options. Only required if - // ZoneAwarenessEnabled is true. + // ZoneAwarenessEnabled is true . ZoneAwarenessConfig *ZoneAwarenessConfig - // Indicates whether multiple Availability Zones are enabled. For more information, - // see Configuring a multi-AZ domain in Amazon OpenSearch Service - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html). + // Indicates whether multiple Availability Zones are enabled. For more + // information, see Configuring a multi-AZ domain in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) + // . ZoneAwarenessEnabled *bool noSmithyDocumentSerde @@ -475,8 +461,8 @@ type ClusterConfigStatus struct { // Container for the parameters required to enable Cognito authentication for an // OpenSearch Service domain. For more information, see Configuring Amazon Cognito -// authentication for OpenSearch Dashboards -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html). +// authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) +// . type CognitoOptions struct { // Whether to enable or disable Amazon Cognito authentication for OpenSearch @@ -516,8 +502,8 @@ type CognitoOptionsStatus struct { // Container for the parameters required to enable cold storage for an OpenSearch // Service domain. For more information, see Cold storage for Amazon OpenSearch -// Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html). +// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html) +// . type ColdStorageOptions struct { // Whether to enable or disable cold storage on the domain. @@ -553,7 +539,7 @@ type ConnectionProperties struct { // A filter to apply to the DescribePackage response. type DescribePackagesFilter struct { - // Any field from PackageDetails. + // Any field from PackageDetails . Name DescribePackagesFilterName // A list of values for the specified filter field. @@ -568,9 +554,9 @@ type DomainConfig struct { // Specifies the access policies for the domain. AccessPolicies *AccessPoliciesStatus - // Key-value pairs to specify advanced configuration options. For more information, - // see Advanced options - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). + // Key-value pairs to specify advanced configuration options. For more + // information, see Advanced options (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) + // . AdvancedOptions *AdvancedOptionsStatus // Container for fine-grained access control settings for the domain. @@ -589,8 +575,8 @@ type DomainConfig struct { // Container for Amazon Cognito options for the domain. CognitoOptions *CognitoOptionsStatus - // Additional options for the domain endpoint, such as whether to require HTTPS for - // all traffic. + // Additional options for the domain endpoint, such as whether to require HTTPS + // for all traffic. DomainEndpointOptions *DomainEndpointOptionsStatus // Container for EBS options configured for the domain. @@ -643,12 +629,10 @@ type DomainEndpointOptions struct { // Specify the TLS security policy to apply to the HTTPS endpoint of the domain. // Can be one of the following values: - // - // * Policy-Min-TLS-1-0-2019-07: TLS security - // policy which supports TLS version 1.0 and higher. - // - // * Policy-Min-TLS-1-2-2019-07: - // TLS security policy which supports only TLS version 1.2 + // - Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version + // 1.0 and higher. + // - Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS + // version 1.2 TLSSecurityPolicy TLSSecurityPolicy noSmithyDocumentSerde @@ -676,7 +660,7 @@ type DomainInfo struct { // Name of the domain. DomainName *string - // The type of search engine that the domain is running.OpenSearch for an + // The type of search engine that the domain is running. OpenSearch for an // OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine. EngineType EngineType @@ -693,8 +677,8 @@ type DomainInformationContainer struct { } // Information about a package that is associated with a domain. For more -// information, see Custom packages for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). +// information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) +// . type DomainPackageDetails struct { // Name of the domain that the package is associated with. @@ -732,9 +716,8 @@ type DomainPackageDetails struct { type DomainStatus struct { // The Amazon Resource Name (ARN) of the domain. For more information, see IAM - // identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the AWS Identity and Access Management User Guide. + // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the AWS Identity and Access Management User Guide. // // This member is required. ARN *string @@ -749,8 +732,8 @@ type DomainStatus struct { // This member is required. DomainId *string - // Name of the domain. Domain names are unique across all domains owned by the same - // account within an Amazon Web Services Region. + // Name of the domain. Domain names are unique across all domains owned by the + // same account within an Amazon Web Services Region. // // This member is required. DomainName *string @@ -784,8 +767,8 @@ type DomainStatus struct { // complete, the status of the domain is no longer returned. Deleted *bool - // Additional options for the domain endpoint, such as whether to require HTTPS for - // all traffic. + // Additional options for the domain endpoint, such as whether to require HTTPS + // for all traffic. DomainEndpointOptions *DomainEndpointOptions // Container for EBS-based storage settings for the domain. @@ -799,12 +782,12 @@ type DomainStatus struct { Endpoint *string // The key-value pair that exists if the OpenSearch Service domain uses VPC - // endpoints.. Example key, value: - // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'. + // endpoints.. Example key, value : + // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' . Endpoints map[string]string - // Version of OpenSearch or Elasticsearch that the domain is running, in the format - // Elasticsearch_X.Y or OpenSearch_X.Y. + // Version of OpenSearch or Elasticsearch that the domain is running, in the + // format Elasticsearch_X.Y or OpenSearch_X.Y . EngineVersion *string // Log publishing options for the domain. @@ -813,12 +796,12 @@ type DomainStatus struct { // Whether node-to-node encryption is enabled or disabled. NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions - // Options that specify a custom 10-hour window during which OpenSearch Service can - // perform configuration changes on the domain. + // Options that specify a custom 10-hour window during which OpenSearch Service + // can perform configuration changes on the domain. OffPeakWindowOptions *OffPeakWindowOptions - // The status of the domain configuration. True if OpenSearch Service is processing - // configuration changes. False if the configuration is active. + // The status of the domain configuration. True if OpenSearch Service is + // processing configuration changes. False if the configuration is active. Processing *bool // The current status of the domain's service software. @@ -876,18 +859,11 @@ type DryRunResults struct { // Specifies the way in which OpenSearch Service will apply an update. Possible // values are: - // - // * Blue/Green - The update requires a blue/green deployment. - // - // * - // DynamicUpdate - No blue/green deployment required - // - // * Undetermined - The domain - // is in the middle of an update and can't predict the deployment type. Try again - // after the update is complete. - // - // * None - The request doesn't include any - // configuration changes. + // - Blue/Green - The update requires a blue/green deployment. + // - DynamicUpdate - No blue/green deployment required + // - Undetermined - The domain is in the middle of an update and can't predict + // the deployment type. Try again after the update is complete. + // - None - The request doesn't include any configuration changes. DeploymentType *string // A message corresponding to the deployment type. @@ -897,8 +873,8 @@ type DryRunResults struct { } // The duration of a maintenance schedule. For more information, see Auto-Tune for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type Duration struct { // The unit of measurement for the duration of a maintenance schedule. @@ -918,8 +894,9 @@ type EBSOptions struct { // Service domain. EBSEnabled *bool - // Specifies the baseline input/output (I/O) performance of EBS volumes attached to - // data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types. + // Specifies the baseline input/output (I/O) performance of EBS volumes attached + // to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume + // types. Iops *int32 // Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. @@ -959,7 +936,7 @@ type EncryptionAtRestOptions struct { // True to enable encryption at rest. Enabled *bool - // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. + // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . KmsKeyId *string noSmithyDocumentSerde @@ -994,10 +971,10 @@ type ErrorDetails struct { noSmithyDocumentSerde } -// A filter used to limit results when describing inbound or outbound cross-cluster -// connections. You can specify multiple values per filter. A cross-cluster -// connection must match at least one of the specified values for it to be returned -// from an operation. +// A filter used to limit results when describing inbound or outbound +// cross-cluster connections. You can specify multiple values per filter. A +// cross-cluster connection must match at least one of the specified values for it +// to be returned from an operation. type Filter struct { // The name of the filter. @@ -1009,9 +986,9 @@ type Filter struct { noSmithyDocumentSerde } -// Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For -// more information, see Cross-cluster search for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). +// Describes an inbound cross-cluster connection for Amazon OpenSearch Service. +// For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html) +// . type InboundConnection struct { // The unique identifier of the connection. @@ -1039,29 +1016,16 @@ type InboundConnectionStatus struct { Message *string // The status code for the connection. Can be one of the following: - // - // * - // PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain - // owner. - // - // * APPROVED: Inbound connection is pending acceptance by the remote - // domain owner. - // - // * PROVISIONING: Inbound connection is being provisioned. - // - // * - // ACTIVE: Inbound connection is active and ready to use. - // - // * REJECTING: Inbound - // connection rejection is in process. - // - // * REJECTED: Inbound connection is - // rejected. - // - // * DELETING: Inbound connection deletion is in progress. - // - // * DELETED: - // Inbound connection is deleted and can no longer be used. + // - PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote + // domain owner. + // - APPROVED: Inbound connection is pending acceptance by the remote domain + // owner. + // - PROVISIONING: Inbound connection is being provisioned. + // - ACTIVE: Inbound connection is active and ready to use. + // - REJECTING: Inbound connection rejection is in process. + // - REJECTED: Inbound connection is rejected. + // - DELETING: Inbound connection deletion is in progress. + // - DELETED: Inbound connection is deleted and can no longer be used. StatusCode InboundConnectionStatusCode noSmithyDocumentSerde @@ -1122,8 +1086,8 @@ type InstanceTypeDetails struct { // Limits for a given instance type and for each of its roles. type Limits struct { - // List of additional limits that are specific to a given instance type for each of - // its instance roles. + // List of additional limits that are specific to a given instance type for each + // of its instance roles. AdditionalLimits []AdditionalLimit // The limits for a given instance type. @@ -1137,10 +1101,9 @@ type Limits struct { // Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch // application and slow logs to Amazon CloudWatch. For more information, see -// Monitoring OpenSearch logs with Amazon CloudWatch Logs -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html). -// After you enable log publishing, you still have to enable the collection of slow -// logs using the OpenSearch REST API. +// Monitoring OpenSearch logs with Amazon CloudWatch Logs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html) +// . After you enable log publishing, you still have to enable the collection of +// slow logs using the OpenSearch REST API. type LogPublishingOption struct { // The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. @@ -1168,23 +1131,23 @@ type LogPublishingOptionsStatus struct { type MasterUserOptions struct { // Amazon Resource Name (ARN) for the master user. Only specify if - // InternalUserDatabaseEnabled is false. + // InternalUserDatabaseEnabled is false . MasterUserARN *string // User name for the master user. Only specify if InternalUserDatabaseEnabled is - // true. + // true . MasterUserName *string // Password for the master user. Only specify if InternalUserDatabaseEnabled is - // true. + // true . MasterUserPassword *string noSmithyDocumentSerde } // Enables or disables node-to-node encryption. For more information, see -// Node-to-node encryption for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html). +// Node-to-node encryption for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html) +// . type NodeToNodeEncryptionOptions struct { // True to enable node-to-node encryption. @@ -1209,14 +1172,14 @@ type NodeToNodeEncryptionOptionsStatus struct { noSmithyDocumentSerde } -// A custom 10-hour, low-traffic window during which OpenSearch Service can perform -// mandatory configuration changes on the domain. These actions can include +// A custom 10-hour, low-traffic window during which OpenSearch Service can +// perform mandatory configuration changes on the domain. These actions can include // scheduled service software updates and blue/green Auto-Tune enhancements. // OpenSearch Service will schedule these actions during the window that you // specify. If you don't specify a window start time, it defaults to 10:00 P.M. // local time. For more information, see Defining off-peak maintenance windows for -// Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html). +// Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) +// . type OffPeakWindow struct { // A custom start time for the off-peak window, in Coordinated Universal Time @@ -1228,9 +1191,8 @@ type OffPeakWindow struct { noSmithyDocumentSerde } -// Options for a domain's off-peak window -// (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html), -// during which OpenSearch Service can perform mandatory configuration changes on +// Options for a domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) +// , during which OpenSearch Service can perform mandatory configuration changes on // the domain. type OffPeakWindowOptions struct { @@ -1246,8 +1208,7 @@ type OffPeakWindowOptions struct { noSmithyDocumentSerde } -// The status of off-peak window -// (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) +// The status of off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) // options for a domain. type OffPeakWindowOptionsStatus struct { @@ -1321,37 +1282,19 @@ type OutboundConnectionStatus struct { Message *string // The status code for the outbound connection. Can be one of the following: - // - // * - // VALIDATING - The outbound connection request is being validated. - // - // * - // VALIDATION_FAILED - Validation failed for the connection request. - // - // * - // PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet - // accepted by the remote domain owner. - // - // * APPROVED - Outbound connection has been - // approved by the remote domain owner for getting provisioned. - // - // * PROVISIONING - - // Outbound connection request is in process. - // - // * ACTIVE - Outbound connection is - // active and ready to use. - // - // * REJECTING - Outbound connection rejection by remote - // domain owner is in progress. - // - // * REJECTED - Outbound connection request is - // rejected by remote domain owner. - // - // * DELETING - Outbound connection deletion is - // in progress. - // - // * DELETED - Outbound connection is deleted and can no longer be - // used. + // - VALIDATING - The outbound connection request is being validated. + // - VALIDATION_FAILED - Validation failed for the connection request. + // - PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet + // accepted by the remote domain owner. + // - APPROVED - Outbound connection has been approved by the remote domain owner + // for getting provisioned. + // - PROVISIONING - Outbound connection request is in process. + // - ACTIVE - Outbound connection is active and ready to use. + // - REJECTING - Outbound connection rejection by remote domain owner is in + // progress. + // - REJECTED - Outbound connection request is rejected by remote domain owner. + // - DELETING - Outbound connection deletion is in progress. + // - DELETED - Outbound connection is deleted and can no longer be used. StatusCode OutboundConnectionStatusCode noSmithyDocumentSerde @@ -1491,8 +1434,8 @@ type ReservedInstanceOffering struct { // instance. Duration int32 - // The upfront fixed charge you will pay to purchase the specific Reserved Instance - // offering. + // The upfront fixed charge you will pay to purchase the specific Reserved + // Instance offering. FixedPrice *float64 // The OpenSearch instance type offered by the Reserved Instance offering. @@ -1547,14 +1490,14 @@ type SAMLOptionsInput struct { // database. MasterUserName *string - // Element of the SAML assertion to use for backend roles. Default is roles. + // Element of the SAML assertion to use for backend roles. Default is roles . RolesKey *string // The duration, in minutes, after which a user session becomes inactive. // Acceptable values are between 1 and 1440, and the default value is 60. SessionTimeoutMinutes *int32 - // Element of the SAML assertion to use for the user name. Default is NameID. + // Element of the SAML assertion to use for the user name. Default is NameID . SubjectKey *string noSmithyDocumentSerde @@ -1582,10 +1525,9 @@ type SAMLOptionsOutput struct { } // Information about a scheduled configuration change for an OpenSearch Service -// domain. This actions can be a service software update -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) -// or a blue/green Auto-Tune enhancement -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types). +// domain. This actions can be a service software update (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// or a blue/green Auto-Tune enhancement (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types) +// . type ScheduledAction struct { // The unique identifier of the scheduled action. @@ -1617,8 +1559,8 @@ type ScheduledAction struct { // Whether the action is required or optional. Mandatory *bool - // Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service - // automatically (SYSTEM). + // Whether the action was scheduled manually ( CUSTOMER , or by OpenSearch Service + // automatically ( SYSTEM ). ScheduledBy ScheduledBy // The current status of the scheduled action. @@ -1628,8 +1570,8 @@ type ScheduledAction struct { } // Specifies details about a scheduled Auto-Tune action. For more information, see -// Auto-Tune for Amazon OpenSearch Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). +// Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) +// . type ScheduledAutoTuneDetails struct { // A description of the Auto-Tune action. @@ -1641,7 +1583,7 @@ type ScheduledAutoTuneDetails struct { // The date and time when the Auto-Tune action is scheduled for the domain. Date *time.Time - // The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH. + // The severity of the Auto-Tune action. Valid values are LOW , MEDIUM , and HIGH . Severity ScheduledAutoTuneSeverityType noSmithyDocumentSerde @@ -1649,16 +1591,16 @@ type ScheduledAutoTuneDetails struct { // The current status of the service software for an Amazon OpenSearch Service // domain. For more information, see Service software updates in Amazon OpenSearch -// Service -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html). +// Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) +// . type ServiceSoftwareOptions struct { // The timestamp, in Epoch time, until which you can manually request a service // software update. After this date, we automatically update your service software. AutomatedUpdateDate *time.Time - // True if you're able to cancel your service software version update. False if you - // can't cancel your service software update. + // True if you're able to cancel your service software version update. False if + // you can't cancel your service software update. Cancellable *bool // The current service software version present on the domain. @@ -1738,7 +1680,7 @@ type SoftwareUpdateOptionsStatus struct { // available for a given intance type. type StorageType struct { - // The storage sub-type, such as gp3 or io1. + // The storage sub-type, such as gp3 or io1 . StorageSubTypeName *string // Limits that are applicable for the given storage type. @@ -1754,29 +1696,19 @@ type StorageType struct { type StorageTypeLimit struct { // Name of storage limits that are applicable for the given storage type. If - // StorageType is ebs, the following options are available: - // - // * MinimumVolumeSize - - // Minimum volume size that is available for the given storage type. Can be empty - // if not applicable. - // - // * MaximumVolumeSize - Maximum volume size that is available - // for the given storage type. Can be empty if not applicable. - // - // * MaximumIops - - // Maximum amount of IOPS that is available for the given the storage type. Can be - // empty if not applicable. - // - // * MinimumIops - Minimum amount of IOPS that is - // available for the given the storage type. Can be empty if not applicable. - // - // * - // MaximumThroughput - Maximum amount of throughput that is available for the given - // the storage type. Can be empty if not applicable. - // - // * MinimumThroughput - Minimum - // amount of throughput that is available for the given the storage type. Can be - // empty if not applicable. + // StorageType is ebs , the following options are available: + // - MinimumVolumeSize - Minimum volume size that is available for the given + // storage type. Can be empty if not applicable. + // - MaximumVolumeSize - Maximum volume size that is available for the given + // storage type. Can be empty if not applicable. + // - MaximumIops - Maximum amount of IOPS that is available for the given the + // storage type. Can be empty if not applicable. + // - MinimumIops - Minimum amount of IOPS that is available for the given the + // storage type. Can be empty if not applicable. + // - MaximumThroughput - Maximum amount of throughput that is available for the + // given the storage type. Can be empty if not applicable. + // - MinimumThroughput - Minimum amount of throughput that is available for the + // given the storage type. Can be empty if not applicable. LimitName *string // The limit values. @@ -1808,7 +1740,7 @@ type Tag struct { type UpgradeHistory struct { // UTC timestamp at which the upgrade API call was made, in the format - // yyyy-MM-ddTHH:mm:ssZ. + // yyyy-MM-ddTHH:mm:ssZ . StartTimestamp *time.Time // A list of each step performed as part of a specific upgrade or upgrade @@ -1820,14 +1752,10 @@ type UpgradeHistory struct { // The current status of the upgrade. The status can take one of the following // values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with Issues - // - // * Failed + // - In Progress + // - Succeeded + // - Succeeded with Issues + // - Failed UpgradeStatus UpgradeStatus noSmithyDocumentSerde @@ -1845,25 +1773,17 @@ type UpgradeStepItem struct { ProgressPercent *float64 // One of three steps that an upgrade or upgrade eligibility check goes through: - // - // * - // PreUpgradeCheck - // - // * Snapshot - // - // * Upgrade + // - PreUpgradeCheck + // - Snapshot + // - Upgrade UpgradeStep UpgradeStep // The current status of the upgrade. The status can take one of the following // values: - // - // * In Progress - // - // * Succeeded - // - // * Succeeded with Issues - // - // * Failed + // - In Progress + // - Succeeded + // - Succeeded with Issues + // - Failed UpgradeStepStatus UpgradeStatus noSmithyDocumentSerde @@ -1901,9 +1821,8 @@ type VersionStatus struct { // Information about the subnets and security groups for an Amazon OpenSearch // Service domain provisioned within a virtual private cloud (VPC). For more -// information, see Launching your Amazon OpenSearch Service domains using a VPC -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). -// This information only exists if the domain was created with VPCOptions. +// information, see Launching your Amazon OpenSearch Service domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) +// . This information only exists if the domain was created with VPCOptions . type VPCDerivedInfo struct { // The list of Availability Zones associated with the VPC subnets. @@ -1998,14 +1917,14 @@ type VpcEndpointSummary struct { } // Options to specify the subnets and security groups for an Amazon OpenSearch -// Service VPC endpoint. For more information, see Launching your Amazon OpenSearch -// Service domains using a VPC -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). +// Service VPC endpoint. For more information, see Launching your Amazon +// OpenSearch Service domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) +// . type VPCOptions struct { - // The list of security group IDs associated with the VPC endpoints for the domain. - // If you do not provide a security group ID, OpenSearch Service uses the default - // security group for the VPC. + // The list of security group IDs associated with the VPC endpoints for the + // domain. If you do not provide a security group ID, OpenSearch Service uses the + // default security group for the VPC. SecurityGroupIds []string // A list of subnet IDs associated with the VPC endpoints for the domain. If your @@ -2016,8 +1935,8 @@ type VPCOptions struct { noSmithyDocumentSerde } -// The desired start time for an off-peak maintenance window -// (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html). +// The desired start time for an off-peak maintenance window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) +// . type WindowStartTime struct { // The start hour of the window in Coordinated Universal Time (UTC), using 24-hour @@ -2038,7 +1957,7 @@ type WindowStartTime struct { type ZoneAwarenessConfig struct { // If you enabled multiple Availability Zones, this value is the number of zones - // that you want the domain to use. Valid values are 2 and 3. If your domain is + // that you want the domain to use. Valid values are 2 and 3 . If your domain is // provisioned within a VPC, this value be equal to number of subnets. AvailabilityZoneCount *int32 diff --git a/service/opensearchserverless/api_client.go b/service/opensearchserverless/api_client.go index a6d3c72e871..e67aa54c310 100644 --- a/service/opensearchserverless/api_client.go +++ b/service/opensearchserverless/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/opensearchserverless/api_op_BatchGetCollection.go b/service/opensearchserverless/api_op_BatchGetCollection.go index f6f420a8371..bd9a7316ec1 100644 --- a/service/opensearchserverless/api_op_BatchGetCollection.go +++ b/service/opensearchserverless/api_op_BatchGetCollection.go @@ -13,8 +13,8 @@ import ( // Returns attributes for one or more collections, including the collection // endpoint and the OpenSearch Dashboards endpoint. For more information, see -// Creating and managing Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html). +// Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) +// . func (c *Client) BatchGetCollection(ctx context.Context, params *BatchGetCollectionInput, optFns ...func(*Options)) (*BatchGetCollectionOutput, error) { if params == nil { params = &BatchGetCollectionInput{} @@ -34,8 +34,7 @@ type BatchGetCollectionInput struct { // A list of collection IDs. You can't provide names and IDs in the same request. // The ID is part of the collection endpoint. You can also retrieve it using the - // ListCollections - // (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html) + // ListCollections (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html) // API. Ids []string diff --git a/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go b/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go index 4ba91f5b7bc..dde312400f0 100644 --- a/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go +++ b/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go @@ -13,8 +13,8 @@ import ( // Returns attributes for one or more VPC endpoints associated with the current // account. For more information, see Access Amazon OpenSearch Serverless using an -// interface endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . func (c *Client) BatchGetVpcEndpoint(ctx context.Context, params *BatchGetVpcEndpointInput, optFns ...func(*Options)) (*BatchGetVpcEndpointOutput, error) { if params == nil { params = &BatchGetVpcEndpointInput{} diff --git a/service/opensearchserverless/api_op_CreateAccessPolicy.go b/service/opensearchserverless/api_op_CreateAccessPolicy.go index edc2ce38ddc..98553e9f209 100644 --- a/service/opensearchserverless/api_op_CreateAccessPolicy.go +++ b/service/opensearchserverless/api_op_CreateAccessPolicy.go @@ -15,8 +15,8 @@ import ( // Creates a data access policy for OpenSearch Serverless. Access policies limit // access to collections and the resources within them, and allow a user to access // that data irrespective of the access mechanism or network source. For more -// information, see Data access control for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html). +// information, see Data access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) +// . func (c *Client) CreateAccessPolicy(ctx context.Context, params *CreateAccessPolicyInput, optFns ...func(*Options)) (*CreateAccessPolicyOutput, error) { if params == nil { params = &CreateAccessPolicyInput{} diff --git a/service/opensearchserverless/api_op_CreateCollection.go b/service/opensearchserverless/api_op_CreateCollection.go index de28cf564a4..48ec00f4b96 100644 --- a/service/opensearchserverless/api_op_CreateCollection.go +++ b/service/opensearchserverless/api_op_CreateCollection.go @@ -13,8 +13,8 @@ import ( ) // Creates a new OpenSearch Serverless collection. For more information, see -// Creating and managing Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html). +// Creating and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) +// . func (c *Client) CreateCollection(ctx context.Context, params *CreateCollectionInput, optFns ...func(*Options)) (*CreateCollectionOutput, error) { if params == nil { params = &CreateCollectionInput{} diff --git a/service/opensearchserverless/api_op_CreateSecurityConfig.go b/service/opensearchserverless/api_op_CreateSecurityConfig.go index 34e530fbe98..797c2dde21f 100644 --- a/service/opensearchserverless/api_op_CreateSecurityConfig.go +++ b/service/opensearchserverless/api_op_CreateSecurityConfig.go @@ -13,8 +13,8 @@ import ( ) // Specifies a security configuration for OpenSearch Serverless. For more -// information, see SAML authentication for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html). +// information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) +// . func (c *Client) CreateSecurityConfig(ctx context.Context, params *CreateSecurityConfigInput, optFns ...func(*Options)) (*CreateSecurityConfigOutput, error) { if params == nil { params = &CreateSecurityConfigInput{} @@ -48,8 +48,8 @@ type CreateSecurityConfigInput struct { // A description of the security configuration. Description *string - // Describes SAML options in in the form of a key-value map. This field is required - // if you specify saml for the type parameter. + // Describes SAML options in in the form of a key-value map. This field is + // required if you specify saml for the type parameter. SamlOptions *types.SamlConfigOptions noSmithyDocumentSerde diff --git a/service/opensearchserverless/api_op_CreateSecurityPolicy.go b/service/opensearchserverless/api_op_CreateSecurityPolicy.go index 772b0544c3f..aa886f7dbe5 100644 --- a/service/opensearchserverless/api_op_CreateSecurityPolicy.go +++ b/service/opensearchserverless/api_op_CreateSecurityPolicy.go @@ -16,10 +16,9 @@ import ( // collections. Security policies provide access to a collection and its OpenSearch // Dashboards endpoint from public networks or specific VPC endpoints. They also // allow you to secure a collection with a KMS encryption key. For more -// information, see Network access for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) -// and Encryption at rest for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html). +// information, see Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) +// and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) +// . func (c *Client) CreateSecurityPolicy(ctx context.Context, params *CreateSecurityPolicyInput, optFns ...func(*Options)) (*CreateSecurityPolicyOutput, error) { if params == nil { params = &CreateSecurityPolicyInput{} diff --git a/service/opensearchserverless/api_op_CreateVpcEndpoint.go b/service/opensearchserverless/api_op_CreateVpcEndpoint.go index c9d6b7553c6..132fc1a8028 100644 --- a/service/opensearchserverless/api_op_CreateVpcEndpoint.go +++ b/service/opensearchserverless/api_op_CreateVpcEndpoint.go @@ -13,8 +13,8 @@ import ( ) // Creates an OpenSearch Serverless-managed interface VPC endpoint. For more -// information, see Access Amazon OpenSearch Serverless using an interface endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . func (c *Client) CreateVpcEndpoint(ctx context.Context, params *CreateVpcEndpointInput, optFns ...func(*Options)) (*CreateVpcEndpointOutput, error) { if params == nil { params = &CreateVpcEndpointInput{} diff --git a/service/opensearchserverless/api_op_DeleteAccessPolicy.go b/service/opensearchserverless/api_op_DeleteAccessPolicy.go index 76213997961..7d81846dd98 100644 --- a/service/opensearchserverless/api_op_DeleteAccessPolicy.go +++ b/service/opensearchserverless/api_op_DeleteAccessPolicy.go @@ -13,8 +13,8 @@ import ( ) // Deletes an OpenSearch Serverless access policy. For more information, see Data -// access control for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html). +// access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) +// . func (c *Client) DeleteAccessPolicy(ctx context.Context, params *DeleteAccessPolicyInput, optFns ...func(*Options)) (*DeleteAccessPolicyOutput, error) { if params == nil { params = &DeleteAccessPolicyInput{} diff --git a/service/opensearchserverless/api_op_DeleteCollection.go b/service/opensearchserverless/api_op_DeleteCollection.go index 817264982b7..74cb659a8ad 100644 --- a/service/opensearchserverless/api_op_DeleteCollection.go +++ b/service/opensearchserverless/api_op_DeleteCollection.go @@ -13,8 +13,8 @@ import ( ) // Deletes an OpenSearch Serverless collection. For more information, see Creating -// and managing Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html). +// and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) +// . func (c *Client) DeleteCollection(ctx context.Context, params *DeleteCollectionInput, optFns ...func(*Options)) (*DeleteCollectionOutput, error) { if params == nil { params = &DeleteCollectionInput{} @@ -32,10 +32,9 @@ func (c *Client) DeleteCollection(ctx context.Context, params *DeleteCollectionI type DeleteCollectionInput struct { - // The unique identifier of the collection. For example, 1iu5usc406kd. The ID is + // The unique identifier of the collection. For example, 1iu5usc406kd . The ID is // part of the collection endpoint. You can also retrieve it using the - // ListCollections - // (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html) + // ListCollections (https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html) // API. // // This member is required. diff --git a/service/opensearchserverless/api_op_DeleteSecurityConfig.go b/service/opensearchserverless/api_op_DeleteSecurityConfig.go index b0bb34c9b8a..c0cd0511108 100644 --- a/service/opensearchserverless/api_op_DeleteSecurityConfig.go +++ b/service/opensearchserverless/api_op_DeleteSecurityConfig.go @@ -12,8 +12,8 @@ import ( ) // Deletes a security configuration for OpenSearch Serverless. For more -// information, see SAML authentication for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html). +// information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) +// . func (c *Client) DeleteSecurityConfig(ctx context.Context, params *DeleteSecurityConfigInput, optFns ...func(*Options)) (*DeleteSecurityConfigOutput, error) { if params == nil { params = &DeleteSecurityConfigInput{} @@ -32,7 +32,7 @@ func (c *Client) DeleteSecurityConfig(ctx context.Context, params *DeleteSecurit type DeleteSecurityConfigInput struct { // The security configuration identifier. For SAML the ID will be - // saml//. For example, saml/123456789123/OKTADev. + // saml// . For example, saml/123456789123/OKTADev . // // This member is required. Id *string diff --git a/service/opensearchserverless/api_op_DeleteVpcEndpoint.go b/service/opensearchserverless/api_op_DeleteVpcEndpoint.go index c6955b5b1e7..c23e2cfae63 100644 --- a/service/opensearchserverless/api_op_DeleteVpcEndpoint.go +++ b/service/opensearchserverless/api_op_DeleteVpcEndpoint.go @@ -13,8 +13,8 @@ import ( ) // Deletes an OpenSearch Serverless-managed interface endpoint. For more -// information, see Access Amazon OpenSearch Serverless using an interface endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . func (c *Client) DeleteVpcEndpoint(ctx context.Context, params *DeleteVpcEndpointInput, optFns ...func(*Options)) (*DeleteVpcEndpointOutput, error) { if params == nil { params = &DeleteVpcEndpointInput{} diff --git a/service/opensearchserverless/api_op_GetAccessPolicy.go b/service/opensearchserverless/api_op_GetAccessPolicy.go index b6f0f0347b8..cc9984c9aef 100644 --- a/service/opensearchserverless/api_op_GetAccessPolicy.go +++ b/service/opensearchserverless/api_op_GetAccessPolicy.go @@ -12,8 +12,8 @@ import ( ) // Returns an OpenSearch Serverless access policy. For more information, see Data -// access control for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html). +// access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) +// . func (c *Client) GetAccessPolicy(ctx context.Context, params *GetAccessPolicyInput, optFns ...func(*Options)) (*GetAccessPolicyOutput, error) { if params == nil { params = &GetAccessPolicyInput{} @@ -36,7 +36,7 @@ type GetAccessPolicyInput struct { // This member is required. Name *string - // Tye type of policy. Currently the only supported value is data. + // Tye type of policy. Currently the only supported value is data . // // This member is required. Type types.AccessPolicyType diff --git a/service/opensearchserverless/api_op_GetSecurityConfig.go b/service/opensearchserverless/api_op_GetSecurityConfig.go index 6562e62adc5..6d602694dc6 100644 --- a/service/opensearchserverless/api_op_GetSecurityConfig.go +++ b/service/opensearchserverless/api_op_GetSecurityConfig.go @@ -12,8 +12,8 @@ import ( ) // Returns information about an OpenSearch Serverless security configuration. For -// more information, see SAML authentication for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html). +// more information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) +// . func (c *Client) GetSecurityConfig(ctx context.Context, params *GetSecurityConfigInput, optFns ...func(*Options)) (*GetSecurityConfigOutput, error) { if params == nil { params = &GetSecurityConfigInput{} diff --git a/service/opensearchserverless/api_op_GetSecurityPolicy.go b/service/opensearchserverless/api_op_GetSecurityPolicy.go index 23ceb011d65..52ff80b7acb 100644 --- a/service/opensearchserverless/api_op_GetSecurityPolicy.go +++ b/service/opensearchserverless/api_op_GetSecurityPolicy.go @@ -12,10 +12,9 @@ import ( ) // Returns information about a configured OpenSearch Serverless security policy. -// For more information, see Network access for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) -// and Encryption at rest for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html). +// For more information, see Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) +// and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) +// . func (c *Client) GetSecurityPolicy(ctx context.Context, params *GetSecurityPolicyInput, optFns ...func(*Options)) (*GetSecurityPolicyOutput, error) { if params == nil { params = &GetSecurityPolicyInput{} diff --git a/service/opensearchserverless/api_op_ListAccessPolicies.go b/service/opensearchserverless/api_op_ListAccessPolicies.go index bb5fb37a111..62c8a7d576a 100644 --- a/service/opensearchserverless/api_op_ListAccessPolicies.go +++ b/service/opensearchserverless/api_op_ListAccessPolicies.go @@ -39,7 +39,7 @@ type ListAccessPoliciesInput struct { // You can use nextToken to get the next page of results. The default is 20. MaxResults *int32 - // If your initial ListAccessPolicies operation returns a nextToken, you can + // If your initial ListAccessPolicies operation returns a nextToken , you can // include the returned nextToken in subsequent ListAccessPolicies operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearchserverless/api_op_ListCollections.go b/service/opensearchserverless/api_op_ListCollections.go index d6a4147735c..a26aad1b1c0 100644 --- a/service/opensearchserverless/api_op_ListCollections.go +++ b/service/opensearchserverless/api_op_ListCollections.go @@ -13,9 +13,8 @@ import ( ) // Lists all OpenSearch Serverless collections. For more information, see Creating -// and managing Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html). -// Make sure to include an empty request body {} if you don't include any +// and managing Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) +// . Make sure to include an empty request body {} if you don't include any // collection filters in the request. func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInput, optFns ...func(*Options)) (*ListCollectionsOutput, error) { if params == nil { @@ -37,11 +36,11 @@ type ListCollectionsInput struct { // List of filter names and values that you can use for requests. CollectionFilters *types.CollectionFilters - // The maximum number of results to return. Default is 20. You can use nextToken to - // get the next page of results. + // The maximum number of results to return. Default is 20. You can use nextToken + // to get the next page of results. MaxResults *int32 - // If your initial ListCollections operation returns a nextToken, you can include + // If your initial ListCollections operation returns a nextToken , you can include // the returned nextToken in subsequent ListCollections operations, which returns // results in the next page. NextToken *string diff --git a/service/opensearchserverless/api_op_ListSecurityConfigs.go b/service/opensearchserverless/api_op_ListSecurityConfigs.go index c9d51d9f3f7..580c9781596 100644 --- a/service/opensearchserverless/api_op_ListSecurityConfigs.go +++ b/service/opensearchserverless/api_op_ListSecurityConfigs.go @@ -14,8 +14,8 @@ import ( // Returns information about configured OpenSearch Serverless security // configurations. For more information, see SAML authentication for Amazon -// OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html). +// OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) +// . func (c *Client) ListSecurityConfigs(ctx context.Context, params *ListSecurityConfigsInput, optFns ...func(*Options)) (*ListSecurityConfigsOutput, error) { if params == nil { params = &ListSecurityConfigsInput{} @@ -42,7 +42,7 @@ type ListSecurityConfigsInput struct { // You can use nextToken to get the next page of results. The default is 20. MaxResults *int32 - // If your initial ListSecurityConfigs operation returns a nextToken, you can + // If your initial ListSecurityConfigs operation returns a nextToken , you can // include the returned nextToken in subsequent ListSecurityConfigs operations, // which returns results in the next page. NextToken *string @@ -129,8 +129,8 @@ func (c *Client) addOperationListSecurityConfigsMiddlewares(stack *middleware.St return nil } -// ListSecurityConfigsAPIClient is a client that implements the ListSecurityConfigs -// operation. +// ListSecurityConfigsAPIClient is a client that implements the +// ListSecurityConfigs operation. type ListSecurityConfigsAPIClient interface { ListSecurityConfigs(context.Context, *ListSecurityConfigsInput, ...func(*Options)) (*ListSecurityConfigsOutput, error) } diff --git a/service/opensearchserverless/api_op_ListSecurityPolicies.go b/service/opensearchserverless/api_op_ListSecurityPolicies.go index 267e8e1f2cb..79567f30333 100644 --- a/service/opensearchserverless/api_op_ListSecurityPolicies.go +++ b/service/opensearchserverless/api_op_ListSecurityPolicies.go @@ -39,7 +39,7 @@ type ListSecurityPoliciesInput struct { // You can use nextToken to get the next page of results. The default is 20. MaxResults *int32 - // If your initial ListSecurityPolicies operation returns a nextToken, you can + // If your initial ListSecurityPolicies operation returns a nextToken , you can // include the returned nextToken in subsequent ListSecurityPolicies operations, // which returns results in the next page. NextToken *string diff --git a/service/opensearchserverless/api_op_ListTagsForResource.go b/service/opensearchserverless/api_op_ListTagsForResource.go index 8b58d06db95..a686497a27c 100644 --- a/service/opensearchserverless/api_op_ListTagsForResource.go +++ b/service/opensearchserverless/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( ) // Returns the tags for an OpenSearch Serverless resource. For more information, -// see Tagging Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html). +// see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -31,9 +31,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. The resource must be active (not - // in the DELETING state), and must be owned by the account ID included in the - // request. + // The Amazon Resource Name (ARN) of the resource. The resource must be active + // (not in the DELETING state), and must be owned by the account ID included in + // the request. // // This member is required. ResourceArn *string diff --git a/service/opensearchserverless/api_op_ListVpcEndpoints.go b/service/opensearchserverless/api_op_ListVpcEndpoints.go index d6fb96fb276..769007eaa8d 100644 --- a/service/opensearchserverless/api_op_ListVpcEndpoints.go +++ b/service/opensearchserverless/api_op_ListVpcEndpoints.go @@ -14,8 +14,8 @@ import ( // Returns the OpenSearch Serverless-managed interface VPC endpoints associated // with the current account. For more information, see Access Amazon OpenSearch -// Serverless using an interface endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . func (c *Client) ListVpcEndpoints(ctx context.Context, params *ListVpcEndpointsInput, optFns ...func(*Options)) (*ListVpcEndpointsOutput, error) { if params == nil { params = &ListVpcEndpointsInput{} @@ -37,13 +37,13 @@ type ListVpcEndpointsInput struct { // You can use nextToken to get the next page of results. The default is 20. MaxResults *int32 - // If your initial ListVpcEndpoints operation returns a nextToken, you can include + // If your initial ListVpcEndpoints operation returns a nextToken , you can include // the returned nextToken in subsequent ListVpcEndpoints operations, which returns // results in the next page. NextToken *string - // Filter the results according to the current status of the VPC endpoint. Possible - // statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED. + // Filter the results according to the current status of the VPC endpoint. + // Possible statuses are CREATING , DELETING , UPDATING , ACTIVE , and FAILED . VpcEndpointFilters *types.VpcEndpointFilters noSmithyDocumentSerde diff --git a/service/opensearchserverless/api_op_TagResource.go b/service/opensearchserverless/api_op_TagResource.go index 07ae24c84d9..c8a73e73a36 100644 --- a/service/opensearchserverless/api_op_TagResource.go +++ b/service/opensearchserverless/api_op_TagResource.go @@ -12,8 +12,8 @@ import ( ) // Associates tags with an OpenSearch Serverless resource. For more information, -// see Tagging Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html). +// see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -31,9 +31,9 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. The resource must be active (not - // in the DELETING state), and must be owned by the account ID included in the - // request. + // The Amazon Resource Name (ARN) of the resource. The resource must be active + // (not in the DELETING state), and must be owned by the account ID included in + // the request. // // This member is required. ResourceArn *string diff --git a/service/opensearchserverless/api_op_UntagResource.go b/service/opensearchserverless/api_op_UntagResource.go index 9fed3b11f0e..eb4ec403513 100644 --- a/service/opensearchserverless/api_op_UntagResource.go +++ b/service/opensearchserverless/api_op_UntagResource.go @@ -11,8 +11,8 @@ import ( ) // Removes a tag or set of tags from an OpenSearch Serverless resource. For more -// information, see Tagging Amazon OpenSearch Serverless collections -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html). +// information, see Tagging Amazon OpenSearch Serverless collections (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -30,9 +30,9 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource to remove tags from. The resource - // must be active (not in the DELETING state), and must be owned by the account ID - // included in the request. + // The Amazon Resource Name (ARN) of the resource to remove tags from. The + // resource must be active (not in the DELETING state), and must be owned by the + // account ID included in the request. // // This member is required. ResourceArn *string diff --git a/service/opensearchserverless/api_op_UpdateAccessPolicy.go b/service/opensearchserverless/api_op_UpdateAccessPolicy.go index afaf7af974e..8d315808ec0 100644 --- a/service/opensearchserverless/api_op_UpdateAccessPolicy.go +++ b/service/opensearchserverless/api_op_UpdateAccessPolicy.go @@ -13,8 +13,8 @@ import ( ) // Updates an OpenSearch Serverless access policy. For more information, see Data -// access control for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html). +// access control for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) +// . func (c *Client) UpdateAccessPolicy(ctx context.Context, params *UpdateAccessPolicyInput, optFns ...func(*Options)) (*UpdateAccessPolicyOutput, error) { if params == nil { params = &UpdateAccessPolicyInput{} diff --git a/service/opensearchserverless/api_op_UpdateAccountSettings.go b/service/opensearchserverless/api_op_UpdateAccountSettings.go index 7fc32a32f1b..ea20bb30f89 100644 --- a/service/opensearchserverless/api_op_UpdateAccountSettings.go +++ b/service/opensearchserverless/api_op_UpdateAccountSettings.go @@ -13,8 +13,8 @@ import ( // Update the OpenSearch Serverless settings for the current Amazon Web Services // account. For more information, see Managing capacity limits for Amazon -// OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html). +// OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html) +// . func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) { if params == nil { params = &UpdateAccountSettingsInput{} @@ -35,8 +35,8 @@ type UpdateAccountSettingsInput struct { // The maximum capacity limits for all OpenSearch Serverless collections, in // OpenSearch Compute Units (OCUs). These limits are used to scale your collections // based on the current workload. For more information, see Managing capacity - // limits for Amazon OpenSearch Serverless - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html). + // limits for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html) + // . CapacityLimits *types.CapacityLimits noSmithyDocumentSerde diff --git a/service/opensearchserverless/api_op_UpdateSecurityConfig.go b/service/opensearchserverless/api_op_UpdateSecurityConfig.go index 3c217f656ad..5eeb796a135 100644 --- a/service/opensearchserverless/api_op_UpdateSecurityConfig.go +++ b/service/opensearchserverless/api_op_UpdateSecurityConfig.go @@ -13,8 +13,8 @@ import ( ) // Updates a security configuration for OpenSearch Serverless. For more -// information, see SAML authentication for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html). +// information, see SAML authentication for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) +// . func (c *Client) UpdateSecurityConfig(ctx context.Context, params *UpdateSecurityConfigInput, optFns ...func(*Options)) (*UpdateSecurityConfigOutput, error) { if params == nil { params = &UpdateSecurityConfigInput{} @@ -39,7 +39,7 @@ type UpdateSecurityConfigInput struct { ConfigVersion *string // The security configuration identifier. For SAML the ID will be - // saml//. For example, saml/123456789123/OKTADev. + // saml// . For example, saml/123456789123/OKTADev . // // This member is required. Id *string diff --git a/service/opensearchserverless/api_op_UpdateSecurityPolicy.go b/service/opensearchserverless/api_op_UpdateSecurityPolicy.go index b8ab9315fc6..3592839affe 100644 --- a/service/opensearchserverless/api_op_UpdateSecurityPolicy.go +++ b/service/opensearchserverless/api_op_UpdateSecurityPolicy.go @@ -13,10 +13,9 @@ import ( ) // Updates an OpenSearch Serverless security policy. For more information, see -// Network access for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) -// and Encryption at rest for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html). +// Network access for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) +// and Encryption at rest for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) +// . func (c *Client) UpdateSecurityPolicy(ctx context.Context, params *UpdateSecurityPolicyInput, optFns ...func(*Options)) (*UpdateSecurityPolicyOutput, error) { if params == nil { params = &UpdateSecurityPolicyInput{} diff --git a/service/opensearchserverless/api_op_UpdateVpcEndpoint.go b/service/opensearchserverless/api_op_UpdateVpcEndpoint.go index 023d21747fa..65a3b120851 100644 --- a/service/opensearchserverless/api_op_UpdateVpcEndpoint.go +++ b/service/opensearchserverless/api_op_UpdateVpcEndpoint.go @@ -13,8 +13,8 @@ import ( ) // Updates an OpenSearch Serverless-managed interface endpoint. For more -// information, see Access Amazon OpenSearch Serverless using an interface endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// information, see Access Amazon OpenSearch Serverless using an interface endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . func (c *Client) UpdateVpcEndpoint(ctx context.Context, params *UpdateVpcEndpointInput, optFns ...func(*Options)) (*UpdateVpcEndpointOutput, error) { if params == nil { params = &UpdateVpcEndpointInput{} diff --git a/service/opensearchserverless/doc.go b/service/opensearchserverless/doc.go index 84c0413866c..c1ff55e1a0b 100644 --- a/service/opensearchserverless/doc.go +++ b/service/opensearchserverless/doc.go @@ -10,6 +10,5 @@ // provisioning, configuring, and tuning your OpenSearch clusters. It enables you // to easily search and analyze petabytes of data without having to worry about the // underlying infrastructure and data management. To learn more about OpenSearch -// Serverless, see What is Amazon OpenSearch Serverless? -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html) +// Serverless, see What is Amazon OpenSearch Serverless? (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html) package opensearchserverless diff --git a/service/opensearchserverless/document/document.go b/service/opensearchserverless/document/document.go index b4d31654d47..757e2ab9e3b 100644 --- a/service/opensearchserverless/document/document.go +++ b/service/opensearchserverless/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/opensearchserverless/types/types.go b/service/opensearchserverless/types/types.go index 9cbab850d28..3bd2a8a55c1 100644 --- a/service/opensearchserverless/types/types.go +++ b/service/opensearchserverless/types/types.go @@ -61,7 +61,7 @@ type AccessPolicySummary struct { // The version of the policy. PolicyVersion *string - // The type of access policy. Currently the only available type is data. + // The type of access policy. Currently the only available type is data . Type AccessPolicyType noSmithyDocumentSerde @@ -73,8 +73,8 @@ type AccountSettingsDetail struct { // The maximum capacity limits for all OpenSearch Serverless collections, in // OpenSearch Compute Units (OCUs). These limits are used to scale your collections // based on the current workload. For more information, see Managing capacity - // limits for Amazon OpenSearch Serverless - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html). + // limits for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html) + // . CapacityLimits *CapacityLimits noSmithyDocumentSerde @@ -83,8 +83,8 @@ type AccountSettingsDetail struct { // The maximum capacity limits for all OpenSearch Serverless collections, in // OpenSearch Compute Units (OCUs). These limits are used to scale your collections // based on the current workload. For more information, see Managing capacity -// limits for Amazon OpenSearch Serverless -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html). +// limits for Amazon OpenSearch Serverless (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html) +// . type CapacityLimits struct { // The maximum indexing capacity for collections. @@ -140,7 +140,7 @@ type CollectionDetail struct { // Error information for an OpenSearch Serverless request. type CollectionErrorDetail struct { - // The error code for the request. For example, NOT_FOUND. + // The error code for the request. For example, NOT_FOUND . ErrorCode *string // A description of the error. For example, The specified Collection is not found. @@ -224,8 +224,8 @@ type CreateCollectionDetail struct { // Creation details for an OpenSearch Serverless-managed interface endpoint. For // more information, see Access Amazon OpenSearch Serverless using an interface -// endpoint -// (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html). +// endpoint (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) +// . type CreateVpcEndpointDetail struct { // The unique identifier of the endpoint. diff --git a/service/opsworks/api_client.go b/service/opsworks/api_client.go index 341a24d8415..14ae5b54861 100644 --- a/service/opsworks/api_client.go +++ b/service/opsworks/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/opsworks/api_op_AssignInstance.go b/service/opsworks/api_op_AssignInstance.go index 6f3be666f1e..c566caf06cc 100644 --- a/service/opsworks/api_op_AssignInstance.go +++ b/service/opsworks/api_op_AssignInstance.go @@ -11,22 +11,16 @@ import ( ) // Assign a registered instance to a layer. +// - You can assign registered on-premises instances to any layer type. +// - You can assign registered Amazon EC2 instances only to custom layers. +// - You cannot use this action with instances that were created with AWS +// OpsWorks Stacks. // -// * You can assign registered -// on-premises instances to any layer type. -// -// * You can assign registered Amazon EC2 -// instances only to custom layers. -// -// * You cannot use this action with instances -// that were created with AWS OpsWorks Stacks. -// -// Required Permissions: To use this -// action, an AWS Identity and Access Management (IAM) user must have a Manage -// permissions level for the stack or an attached policy that explicitly grants -// permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Required Permissions: To use this action, an AWS Identity and Access Management +// (IAM) user must have a Manage permissions level for the stack or an attached +// policy that explicitly grants permissions. For more information on user +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) AssignInstance(ctx context.Context, params *AssignInstanceInput, optFns ...func(*Options)) (*AssignInstanceOutput, error) { if params == nil { params = &AssignInstanceInput{} diff --git a/service/opsworks/api_op_AssignVolume.go b/service/opsworks/api_op_AssignVolume.go index deb784e7faa..bcd419ec0e8 100644 --- a/service/opsworks/api_op_AssignVolume.go +++ b/service/opsworks/api_op_AssignVolume.go @@ -12,14 +12,14 @@ import ( // Assigns one of the stack's registered Amazon EBS volumes to a specified // instance. The volume must first be registered with the stack by calling -// RegisterVolume. After you register the volume, you must call UpdateVolume to -// specify a mount point before calling AssignVolume. For more information, see -// Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// RegisterVolume . After you register the volume, you must call UpdateVolume to +// specify a mount point before calling AssignVolume . For more information, see +// Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) AssignVolume(ctx context.Context, params *AssignVolumeInput, optFns ...func(*Options)) (*AssignVolumeOutput, error) { if params == nil { params = &AssignVolumeInput{} diff --git a/service/opsworks/api_op_AssociateElasticIp.go b/service/opsworks/api_op_AssociateElasticIp.go index ae2700368da..cc9c8aebc69 100644 --- a/service/opsworks/api_op_AssociateElasticIp.go +++ b/service/opsworks/api_op_AssociateElasticIp.go @@ -12,12 +12,12 @@ import ( // Associates one of the stack's registered Elastic IP addresses with a specified // instance. The address must first be registered with the stack by calling -// RegisterElasticIp. For more information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// RegisterElasticIp . For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) AssociateElasticIp(ctx context.Context, params *AssociateElasticIpInput, optFns ...func(*Options)) (*AssociateElasticIpOutput, error) { if params == nil { params = &AssociateElasticIpInput{} diff --git a/service/opsworks/api_op_AttachElasticLoadBalancer.go b/service/opsworks/api_op_AttachElasticLoadBalancer.go index 83e791bb6e9..014c88d720c 100644 --- a/service/opsworks/api_op_AttachElasticLoadBalancer.go +++ b/service/opsworks/api_op_AttachElasticLoadBalancer.go @@ -13,17 +13,15 @@ import ( // Attaches an Elastic Load Balancing load balancer to a specified layer. AWS // OpsWorks Stacks does not support Application Load Balancer. You can only use // Classic Load Balancer with AWS OpsWorks Stacks. For more information, see -// Elastic Load Balancing -// (https://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html). You -// must create the Elastic Load Balancing instance separately, by using the Elastic -// Load Balancing console, API, or CLI. For more information, see Elastic Load -// Balancing Developer Guide -// (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Elastic Load Balancing (https://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html) +// . You must create the Elastic Load Balancing instance separately, by using the +// Elastic Load Balancing console, API, or CLI. For more information, see Elastic +// Load Balancing Developer Guide (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) AttachElasticLoadBalancer(ctx context.Context, params *AttachElasticLoadBalancerInput, optFns ...func(*Options)) (*AttachElasticLoadBalancerOutput, error) { if params == nil { params = &AttachElasticLoadBalancerInput{} diff --git a/service/opsworks/api_op_CloneStack.go b/service/opsworks/api_op_CloneStack.go index c9fadd021f5..49a6bbec760 100644 --- a/service/opsworks/api_op_CloneStack.go +++ b/service/opsworks/api_op_CloneStack.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a clone of a specified stack. For more information, see Clone a Stack -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html). -// By default, all parameters are set to the values used by the parent stack. +// Creates a clone of a specified stack. For more information, see Clone a Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html) +// . By default, all parameters are set to the values used by the parent stack. // Required Permissions: To use this action, an IAM user must have an attached // policy that explicitly grants permissions. For more information about user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CloneStack(ctx context.Context, params *CloneStackInput, optFns ...func(*Options)) (*CloneStackOutput, error) { if params == nil { params = &CloneStackInput{} @@ -40,11 +39,10 @@ type CloneStackInput struct { // parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you // create a stack by using the AWS OpsWorks Stacks console, it creates the role for // you. You can obtain an existing stack's IAM ARN programmatically by calling - // DescribePermissions. For more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). You - // must set this parameter to a valid service role ARN or the action will fail; - // there is no default value. You can specify the source stack's service role ARN, - // if you prefer, but you must do so explicitly. + // DescribePermissions . For more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . You must set this parameter to a valid service role ARN or the action will + // fail; there is no default value. You can specify the source stack's service role + // ARN, if you prefer, but you must do so explicitly. // // This member is required. ServiceRoleArn *string @@ -54,24 +52,20 @@ type CloneStackInput struct { // This member is required. SourceStackId *string - // The default AWS OpsWorks Stacks agent version. You have the following - // options: - // - // * Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks - // automatically installs new agent versions on the stack's instances as soon as - // they are available. - // - // * Fixed version - Set this parameter to your preferred - // agent version. To update the agent version, you must edit the stack - // configuration and specify a new version. AWS OpsWorks Stacks then automatically - // installs that version on the stack's instances. - // - // The default setting is LATEST. - // To specify an agent version, you must use the complete version number, not the - // abbreviated number shown on the console. For a list of available agent version - // numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. - // You can also specify an agent version when you create or update an instance, - // which overrides the stack's default setting. + // The default AWS OpsWorks Stacks agent version. You have the following options: + // - Auto-update - Set this parameter to LATEST . AWS OpsWorks Stacks + // automatically installs new agent versions on the stack's instances as soon as + // they are available. + // - Fixed version - Set this parameter to your preferred agent version. To + // update the agent version, you must edit the stack configuration and specify a + // new version. AWS OpsWorks Stacks then automatically installs that version on the + // stack's instances. + // The default setting is LATEST . To specify an agent version, you must use the + // complete version number, not the abbreviated number shown on the console. For a + // list of available agent version numbers, call DescribeAgentVersions . + // AgentVersion cannot be set to Chef 12.2. You can also specify an agent version + // when you create or update an instance, which overrides the stack's default + // setting. AgentVersion *string // A list of stack attributes and values as key/value pairs to be added to the @@ -80,8 +74,8 @@ type CloneStackInput struct { // A ChefConfiguration object that specifies whether to enable Berkshelf and the // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . ChefConfiguration *types.ChefConfiguration // A list of source stack app IDs to be included in the cloned stack. @@ -97,133 +91,101 @@ type CloneStackInput struct { ConfigurationManager *types.StackConfigurationManager // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + // repository. For more information, see Adding Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) + // . CustomCookbooksSource *types.Source // A string that contains user-defined, custom JSON. It is used to override the // corresponding default stack configuration JSON values. The string should be in // the following format: "{\"key1\": \"value1\", \"key2\": \"value2\",...}" For // more information about custom JSON, see Use Custom JSON to Modify the Stack - // Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) CustomJson *string // The cloned stack's default Availability Zone, which must be in the specified - // region. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see the VpcId parameter description. + // region. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . If you also specify a value for DefaultSubnetId , the subnet must be in the + // same zone. For more information, see the VpcId parameter description. DefaultAvailabilityZone *string - // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for - // all of the stack's EC2 instances. For more information about IAM ARNs, see Using - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // The Amazon Resource Name (ARN) of an IAM profile that is the default profile + // for all of the stack's EC2 instances. For more information about IAM ARNs, see + // Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . DefaultInstanceProfileArn *string // The stack's operating system, which must be set to one of the following. - // - // * A - // supported Linux operating system: An Amazon Linux version, such as Amazon Linux - // 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, - // Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. - // - // * A - // supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, - // or Ubuntu 12.04 LTS. - // - // * CentOS Linux 7 - // - // * Red Hat Enterprise Linux 7 - // - // * - // Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL - // Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or - // Microsoft Windows Server 2012 R2 with SQL Server Web. - // - // * A custom AMI: Custom. - // You specify the custom AMI you want to use when you create instances. For more - // information about how to use custom AMIs with OpsWorks, see Using Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // - // The - // default option is the parent stack's operating system. For more information - // about supported operating systems, see AWS OpsWorks Stacks Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). - // You can specify a different Linux operating system for the cloned stack, but you - // cannot change from Linux to Windows or Windows to Linux. + // - A supported Linux operating system: An Amazon Linux version, such as Amazon + // Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux + // 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux + // 2015.03 . + // - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu + // 14.04 LTS , or Ubuntu 12.04 LTS . + // - CentOS Linux 7 + // - Red Hat Enterprise Linux 7 + // - Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 + // with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server + // Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web . + // - A custom AMI: Custom . You specify the custom AMI you want to use when you + // create instances. For more information about how to use custom AMIs with + // OpsWorks, see Using Custom AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . + // The default option is the parent stack's operating system. For more information + // about supported operating systems, see AWS OpsWorks Stacks Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . You can specify a different Linux operating system for the cloned stack, but + // you cannot change from Linux to Windows or Windows to Linux. DefaultOs *string - // The default root device type. This value is used by default for all instances in - // the cloned stack, but you can override it when you create an instance. For more - // information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // The default root device type. This value is used by default for all instances + // in the cloned stack, but you can override it when you create an instance. For + // more information, see Storage for the Root Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . DefaultRootDeviceType types.RootDeviceType // A default Amazon EC2 key pair name. The default value is none. If you specify a // key pair name, AWS OpsWorks installs the public key on the instance and you can // use the private key with an SSH client to log in to the instance. For more - // information, see Using SSH to Communicate with an Instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) - // and Managing SSH Access - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). - // You can override this setting by specifying a different key pair, or no key - // pair, when you create an instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). + // information, see Using SSH to Communicate with an Instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) + // and Managing SSH Access (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html) + // . You can override this setting by specifying a different key pair, or no key + // pair, when you create an instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html) + // . DefaultSshKeyName *string // The stack's default VPC subnet ID. This parameter is required if you specify a // value for the VpcId parameter. All instances are launched into this subnet // unless you specify otherwise when you create the instance. If you also specify a - // value for DefaultAvailabilityZone, the subnet must be in that zone. For + // value for DefaultAvailabilityZone , the subnet must be in that zone. For // information on default values and when this parameter is required, see the VpcId // parameter description. DefaultSubnetId *string // The stack's host name theme, with spaces are replaced by underscores. The theme // is used to generate host names for the stack's instances. By default, - // HostnameTheme is set to Layer_Dependent, which creates host names by appending + // HostnameTheme is set to Layer_Dependent , which creates host names by appending // integers to the layer's short name. The other themes are: - // - // * Baked_Goods - // - // * - // Clouds - // - // * Europe_Cities - // - // * Fruits - // - // * Greek_Deities_and_Titans - // - // * - // Legendary_creatures_from_Japan - // - // * Planets_and_Moons - // - // * Roman_Deities - // - // * - // Scottish_Islands - // - // * US_Cities - // - // * Wild_Cats - // - // To obtain a generated host name, - // call GetHostNameSuggestion, which returns a host name based on the current - // theme. + // - Baked_Goods + // - Clouds + // - Europe_Cities + // - Fruits + // - Greek_Deities_and_Titans + // - Legendary_creatures_from_Japan + // - Planets_and_Moons + // - Roman_Deities + // - Scottish_Islands + // - US_Cities + // - Wild_Cats + // To obtain a generated host name, call GetHostNameSuggestion , which returns a + // host name based on the current theme. HostnameTheme *string // The cloned stack name. Name *string // The cloned stack AWS region, such as "ap-northeast-2". For more information - // about AWS regions, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // about AWS regions, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . Region *string // Whether to use custom cookbooks. @@ -234,53 +196,40 @@ type CloneStackInput struct { // groups, one for each layer, which are associated with layers by default. With // UseOpsworksSecurityGroups you can instead provide your own custom security // groups. UseOpsworksSecurityGroups has the following settings: - // - // * True - AWS - // OpsWorks Stacks automatically associates the appropriate built-in security group - // with each layer (default setting). You can associate additional security groups - // with a layer after you create it but you cannot delete the built-in security - // group. - // - // * False - AWS OpsWorks Stacks does not associate built-in security - // groups with layers. You must create appropriate Amazon Elastic Compute Cloud - // (Amazon EC2) security groups and associate a security group with each layer that - // you create. However, you can still manually associate a built-in security group - // with a layer on creation; custom security groups are required only for those - // layers that need custom settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // - True - AWS OpsWorks Stacks automatically associates the appropriate + // built-in security group with each layer (default setting). You can associate + // additional security groups with a layer after you create it but you cannot + // delete the built-in security group. + // - False - AWS OpsWorks Stacks does not associate built-in security groups + // with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon + // EC2) security groups and associate a security group with each layer that you + // create. However, you can still manually associate a built-in security group with + // a layer on creation; custom security groups are required only for those layers + // that need custom settings. + // For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . UseOpsworksSecurityGroups *bool // The ID of the VPC that the cloned stack is to be launched into. It must be in // the specified region. All instances are launched into this VPC, and you cannot // change the ID later. - // - // * If your account supports EC2 Classic, the default value - // is no VPC. - // - // * If your account does not support EC2 Classic, the default value is - // the default VPC for the specified region. - // - // If the VPC ID corresponds to a - // default VPC and you have specified either the DefaultAvailabilityZone or the - // DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the - // other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets - // these parameters to the first valid Availability Zone for the specified region - // and the corresponding default VPC subnet ID, respectively. If you specify a - // nondefault VPC ID, note the following: - // - // * It must belong to a VPC in your - // account that is in the specified region. - // - // * You must specify a value for - // DefaultSubnetId. - // - // For more information about how to use AWS OpsWorks Stacks with - // a VPC, see Running a Stack in a VPC - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). - // For more information about default VPC and EC2 Classic, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + // - If your account supports EC2 Classic, the default value is no VPC. + // - If your account does not support EC2 Classic, the default value is the + // default VPC for the specified region. + // If the VPC ID corresponds to a default VPC and you have specified either the + // DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks + // Stacks infers the value of the other parameter. If you specify neither + // parameter, AWS OpsWorks Stacks sets these parameters to the first valid + // Availability Zone for the specified region and the corresponding default VPC + // subnet ID, respectively. If you specify a nondefault VPC ID, note the following: + // + // - It must belong to a VPC in your account that is in the specified region. + // - You must specify a value for DefaultSubnetId . + // For more information about how to use AWS OpsWorks Stacks with a VPC, see + // Running a Stack in a VPC (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html) + // . For more information about default VPC and EC2 Classic, see Supported + // Platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // . VpcId *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_CreateApp.go b/service/opsworks/api_op_CreateApp.go index 8d9a5ce2698..6fadd4aa6dd 100644 --- a/service/opsworks/api_op_CreateApp.go +++ b/service/opsworks/api_op_CreateApp.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an app for a specified stack. For more information, see Creating Apps -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Creates an app for a specified stack. For more information, see Creating Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error) { if params == nil { params = &CreateAppInput{} @@ -49,7 +48,7 @@ type CreateAppInput struct { // example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks // deploys an application to those instances that are members of the corresponding // layer. If your app isn't one of the standard types, or you prefer to implement - // your own Deploy recipes, specify other. + // your own Deploy recipes, specify other . // // This member is required. Type types.AppType @@ -73,13 +72,12 @@ type CreateAppInput struct { // Whether to enable SSL for the app. EnableSsl *bool - // An array of EnvironmentVariable objects that specify environment variables to be - // associated with the app. After you deploy the app, these variables are defined - // on the associated app server instance. For more information, see Environment - // Variables - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). - // There is no specific limit on the number of environment variables. However, the - // size of the associated data structure - which includes the variables' names, + // An array of EnvironmentVariable objects that specify environment variables to + // be associated with the app. After you deploy the app, these variables are + // defined on the associated app server instance. For more information, see + // Environment Variables (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) + // . There is no specific limit on the number of environment variables. However, + // the size of the associated data structure - which includes the variables' names, // values, and protected flag values - cannot exceed 20 KB. This limit should // accommodate most if not all use cases. Exceeding it will cause an exception with // the message, "Environment: is too large (maximum is 20KB)." If you have diff --git a/service/opsworks/api_op_CreateDeployment.go b/service/opsworks/api_op_CreateDeployment.go index c577b416820..91d6892707c 100644 --- a/service/opsworks/api_op_CreateDeployment.go +++ b/service/opsworks/api_op_CreateDeployment.go @@ -11,15 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs deployment or stack commands. For more information, see Deploying Apps -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html) -// and Run Stack Commands -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html). -// Required Permissions: To use this action, an IAM user must have a Deploy or +// Runs deployment or stack commands. For more information, see Deploying Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html) +// and Run Stack Commands (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html) +// . Required Permissions: To use this action, an IAM user must have a Deploy or // Manage permissions level for the stack, or an attached policy that explicitly // grants permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { params = &CreateDeploymentInput{} @@ -59,10 +57,9 @@ type CreateDeploymentInput struct { // override some corresponding default stack configuration JSON values. The string // should be in the following format: "{\"key1\": \"value1\", \"key2\": // \"value2\",...}" For more information about custom JSON, see Use Custom JSON to - // Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) - // and Overriding Attributes With Custom JSON - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). + // Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // and Overriding Attributes With Custom JSON (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html) + // . CustomJson *string // The instance IDs for the deployment targets. diff --git a/service/opsworks/api_op_CreateInstance.go b/service/opsworks/api_op_CreateInstance.go index e1ccc5dff67..7aa86479b29 100644 --- a/service/opsworks/api_op_CreateInstance.go +++ b/service/opsworks/api_op_CreateInstance.go @@ -12,13 +12,12 @@ import ( ) // Creates an instance in a specified stack. For more information, see Adding an -// Instance to a Layer -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Instance to a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput, optFns ...func(*Options)) (*CreateInstanceOutput, error) { if params == nil { params = &CreateInstanceInput{} @@ -36,13 +35,12 @@ func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput type CreateInstanceInput struct { - // The instance type, such as t2.micro. For a list of supported instance types, + // The instance type, such as t2.micro . For a list of supported instance types, // open the stack in the console, choose Instances, and choose + Instance. The Size // list contains the currently supported types. For more information, see Instance - // Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The - // parameter values that you use to specify the various types are in the API Name - // column of the Available Instance Types table. + // Families and Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // . The parameter values that you use to specify the various types are in the API + // Name column of the Available Instance Types table. // // This member is required. InstanceType *string @@ -57,48 +55,41 @@ type CreateInstanceInput struct { // This member is required. StackId *string - // The default AWS OpsWorks Stacks agent version. You have the following - // options: - // - // * INHERIT - Use the stack's default agent version setting. - // - // * - // version_number - Use the specified agent version. This value overrides the - // stack's default setting. To update the agent version, edit the instance - // configuration and specify a new version. AWS OpsWorks Stacks then automatically - // installs that version on the instance. - // - // The default setting is INHERIT. To - // specify an agent version, you must use the complete version number, not the - // abbreviated number shown on the console. For a list of available agent version - // numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. + // The default AWS OpsWorks Stacks agent version. You have the following options: + // - INHERIT - Use the stack's default agent version setting. + // - version_number - Use the specified agent version. This value overrides the + // stack's default setting. To update the agent version, edit the instance + // configuration and specify a new version. AWS OpsWorks Stacks then automatically + // installs that version on the instance. + // The default setting is INHERIT . To specify an agent version, you must use the + // complete version number, not the abbreviated number shown on the console. For a + // list of available agent version numbers, call DescribeAgentVersions . + // AgentVersion cannot be set to Chef 12.2. AgentVersion *string // A custom AMI ID to be used to create the instance. The AMI should be based on // one of the supported operating systems. For more information, see Using Custom - // AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // If you specify a custom AMI, you must set Os to Custom. + // AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . If you specify a custom AMI, you must set Os to Custom . AmiId *string - // The instance architecture. The default option is x86_64. Instance types do not + // The instance architecture. The default option is x86_64 . Instance types do not // necessarily support both architectures. For a list of the architectures that are - // supported by the different instance types, see Instance Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). + // supported by the different instance types, see Instance Families and Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // . Architecture types.Architecture // For load-based or time-based instances, the type. Windows stacks can use only // time-based instances. AutoScalingType types.AutoScalingType - // The instance Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // The instance Availability Zone. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . AvailabilityZone *string // An array of BlockDeviceMapping objects that specify the instance's block - // devices. For more information, see Block Device Mapping - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html). - // Note that block device mappings are not supported for custom AMIs. + // devices. For more information, see Block Device Mapping (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) + // . Note that block device mappings are not supported for custom AMIs. BlockDeviceMappings []types.BlockDeviceMapping // Whether to create an Amazon EBS-optimized instance. @@ -107,55 +98,44 @@ type CreateInstanceInput struct { // The instance host name. Hostname *string - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // to run the update_dependencies stack command or by manually running yum (Amazon - // Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the - // default value of true to ensure that your instances have the latest security - // updates. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . To control when updates are installed, set + // this value to false . You must then update your instances manually by using + // CreateDeployment to run the update_dependencies stack command or by manually + // running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly + // recommend using the default value of true to ensure that your instances have + // the latest security updates. InstallUpdatesOnBoot *bool // The instance's operating system, which must be set to one of the following. - // - // * A - // supported Linux operating system: An Amazon Linux version, such as Amazon Linux - // 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, - // Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. - // - // * A - // supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, - // or Ubuntu 12.04 LTS. - // - // * CentOS Linux 7 - // - // * Red Hat Enterprise Linux 7 - // - // * A - // supported Windows operating system, such as Microsoft Windows Server 2012 R2 - // Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft - // Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server - // 2012 R2 with SQL Server Web. - // - // * A custom AMI: Custom. - // - // For more information - // about the supported operating systems, see AWS OpsWorks Stacks Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). - // The default option is the current Amazon Linux version. If you set this - // parameter to Custom, you must use the CreateInstance action's AmiId parameter to - // specify the custom AMI that you want to use. Block device mappings are not - // supported if the value is Custom. For more information about supported operating - // systems, see Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html)For - // more information about how to use custom AMIs with AWS OpsWorks Stacks, see - // Using Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). + // - A supported Linux operating system: An Amazon Linux version, such as Amazon + // Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux + // 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux + // 2015.03 . + // - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu + // 14.04 LTS , or Ubuntu 12.04 LTS . + // - CentOS Linux 7 + // - Red Hat Enterprise Linux 7 + // - A supported Windows operating system, such as Microsoft Windows Server 2012 + // R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , + // Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft + // Windows Server 2012 R2 with SQL Server Web . + // - A custom AMI: Custom . + // For more information about the supported operating systems, see AWS OpsWorks + // Stacks Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . The default option is the current Amazon Linux version. If you set this + // parameter to Custom , you must use the CreateInstance action's AmiId parameter + // to specify the custom AMI that you want to use. Block device mappings are not + // supported if the value is Custom . For more information about supported + // operating systems, see Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // For more information about how to use custom AMIs with AWS OpsWorks Stacks, see + // Using Custom AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . Os *string // The instance root device type. For more information, see Storage for the Root - // Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . RootDeviceType types.RootDeviceType // The instance's Amazon EC2 key-pair name. @@ -168,19 +148,17 @@ type CreateInstanceInput struct { // The instance's tenancy option. The default option is no tenancy, or if the // instance is running in a VPC, inherit tenancy settings from the VPC. The - // following are valid values for this parameter: dedicated, default, or host. + // following are valid values for this parameter: dedicated , default , or host . // Because there are costs associated with changes in tenancy options, we recommend // that you research tenancy options before choosing them for your instances. For - // more information about dedicated hosts, see Dedicated Hosts Overview - // (http://aws.amazon.com/ec2/dedicated-hosts/) and Amazon EC2 Dedicated Hosts - // (http://aws.amazon.com/ec2/dedicated-hosts/). For more information about - // dedicated instances, see Dedicated Instances - // (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html) - // and Amazon EC2 Dedicated Instances - // (http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/). + // more information about dedicated hosts, see Dedicated Hosts Overview (http://aws.amazon.com/ec2/dedicated-hosts/) + // and Amazon EC2 Dedicated Hosts (http://aws.amazon.com/ec2/dedicated-hosts/) . + // For more information about dedicated instances, see Dedicated Instances (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html) + // and Amazon EC2 Dedicated Instances (http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/) + // . Tenancy *string - // The instance's virtualization type, paravirtual or hvm. + // The instance's virtualization type, paravirtual or hvm . VirtualizationType *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_CreateLayer.go b/service/opsworks/api_op_CreateLayer.go index 1fcae0a4fea..1862d9f9248 100644 --- a/service/opsworks/api_op_CreateLayer.go +++ b/service/opsworks/api_op_CreateLayer.go @@ -11,18 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a layer. For more information, see How to Create a Layer -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html). -// You should use CreateLayer for noncustom layer types such as PHP App Server only -// if the stack does not have an existing layer of that type. A stack can have at -// most one instance of each noncustom layer; if you attempt to create a second +// Creates a layer. For more information, see How to Create a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html) +// . You should use CreateLayer for noncustom layer types such as PHP App Server +// only if the stack does not have an existing layer of that type. A stack can have +// at most one instance of each noncustom layer; if you attempt to create a second // instance, CreateLayer fails. A stack can have an arbitrary number of custom // layers, so you can call CreateLayer as many times as you like for that layer // type. Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateLayer(ctx context.Context, params *CreateLayerInput, optFns ...func(*Options)) (*CreateLayerOutput, error) { if params == nil { params = &CreateLayerInput{} @@ -50,8 +49,8 @@ type CreateLayerInput struct { // name is also used as the name for the directory where your app files are // installed. It can have a maximum of 200 characters, which are limited to the // alphanumeric characters, '-', '_', and '.'. The built-in layers' short names are - // defined by AWS OpsWorks Stacks. For more information, see the Layer Reference - // (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html). + // defined by AWS OpsWorks Stacks. For more information, see the Layer Reference (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) + // . // // This member is required. Shortname *string @@ -68,36 +67,34 @@ type CreateLayerInput struct { // This member is required. Type types.LayerType - // One or more user-defined key-value pairs to be added to the stack attributes. To - // create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. + // One or more user-defined key-value pairs to be added to the stack attributes. + // To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN. Attributes map[string]string - // Whether to automatically assign an Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // to the layer's instances. For more information, see How to Edit a Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Whether to automatically assign an Elastic IP address (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // to the layer's instances. For more information, see How to Edit a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignElasticIps *bool // For stacks that are running in a VPC, whether to automatically assign a public // IP address to the layer's instances. For more information, see How to Edit a - // Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignPublicIps *bool // Specifies CloudWatch Logs configuration options for the layer. For more - // information, see CloudWatchLogsLogStream. + // information, see CloudWatchLogsLogStream . CloudWatchLogsConfiguration *types.CloudWatchLogsConfiguration // The ARN of an IAM profile to be used for the layer's EC2 instances. For more - // information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . CustomInstanceProfileArn *string // A JSON-formatted string containing custom stack configuration and deployment // attributes to be installed on the layer's instances. For more information, see - // Using Custom JSON - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). - // This feature is supported as of version 1.7.42 of the AWS CLI. + // Using Custom JSON (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html) + // . This feature is supported as of version 1.7.42 of the AWS CLI. CustomJson *string // A LayerCustomRecipes object that specifies the layer custom recipes. @@ -109,13 +106,13 @@ type CreateLayerInput struct { // Whether to disable auto healing for the layer. EnableAutoHealing *bool - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // to run the update_dependencies stack command or by manually running yum (Amazon - // Linux) or apt-get (Ubuntu) on the instances. To ensure that your instances have - // the latest security updates, we strongly recommend using the default value of - // true. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . To control when updates are installed, set + // this value to false . You must then update your instances manually by using + // CreateDeployment to run the update_dependencies stack command or by manually + // running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. To ensure that + // your instances have the latest security updates, we strongly recommend using the + // default value of true . InstallUpdatesOnBoot *bool // A LifeCycleEventConfiguration object that you can use to configure the Shutdown diff --git a/service/opsworks/api_op_CreateStack.go b/service/opsworks/api_op_CreateStack.go index 63196715de2..c2a086fa478 100644 --- a/service/opsworks/api_op_CreateStack.go +++ b/service/opsworks/api_op_CreateStack.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new stack. For more information, see Create a New Stack -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html). -// Required Permissions: To use this action, an IAM user must have an attached +// Creates a new stack. For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html) +// . Required Permissions: To use this action, an IAM user must have an attached // policy that explicitly grants permissions. For more information about user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error) { if params == nil { params = &CreateStackInput{} @@ -34,10 +33,10 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF type CreateStackInput struct { - // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for - // all of the stack's EC2 instances. For more information about IAM ARNs, see Using - // Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // The Amazon Resource Name (ARN) of an IAM profile that is the default profile + // for all of the stack's EC2 instances. For more information about IAM ARNs, see + // Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . // // This member is required. DefaultInstanceProfileArn *string @@ -47,23 +46,23 @@ type CreateStackInput struct { // This member is required. Name *string - // The stack's AWS region, such as ap-south-1. For more information about Amazon - // regions, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). In the AWS CLI, this - // API maps to the --stack-region parameter. If the --stack-region parameter and - // the AWS CLI common parameter --region are set to the same value, the stack uses - // a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI - // --region parameter is, this also results in a stack with a regional endpoint. - // However, if the --region parameter is set to us-east-1, and the --stack-region - // parameter is set to one of the following, then the stack uses a legacy or - // classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, - // ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API - // endpoint of the stack is in us-east-1. Only the preceding regions are supported - // as classic regions in the us-east-1 API endpoint. Because it is a best practice - // to choose the regional endpoint that is closest to where you manage AWS, we - // recommend that you use regional endpoints for new stacks. The AWS CLI common - // --region parameter always specifies a regional API endpoint; it cannot be used - // to specify a classic AWS OpsWorks Stacks region. + // The stack's AWS region, such as ap-south-1 . For more information about Amazon + // regions, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . In the AWS CLI, this API maps to the --stack-region parameter. If the + // --stack-region parameter and the AWS CLI common parameter --region are set to + // the same value, the stack uses a regional endpoint. If the --stack-region + // parameter is not set, but the AWS CLI --region parameter is, this also results + // in a stack with a regional endpoint. However, if the --region parameter is set + // to us-east-1 , and the --stack-region parameter is set to one of the following, + // then the stack uses a legacy or classic region: us-west-1, us-west-2, + // sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, + // ap-southeast-2 . In this case, the actual API endpoint of the stack is in + // us-east-1 . Only the preceding regions are supported as classic regions in the + // us-east-1 API endpoint. Because it is a best practice to choose the regional + // endpoint that is closest to where you manage AWS, we recommend that you use + // regional endpoints for new stacks. The AWS CLI common --region parameter always + // specifies a regional API endpoint; it cannot be used to specify a classic AWS + // OpsWorks Stacks region. // // This member is required. Region *string @@ -71,31 +70,26 @@ type CreateStackInput struct { // The stack's AWS Identity and Access Management (IAM) role, which allows AWS // OpsWorks Stacks to work with AWS resources on your behalf. You must set this // parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more - // information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . // // This member is required. ServiceRoleArn *string - // The default AWS OpsWorks Stacks agent version. You have the following - // options: - // - // * Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks - // automatically installs new agent versions on the stack's instances as soon as - // they are available. - // - // * Fixed version - Set this parameter to your preferred - // agent version. To update the agent version, you must edit the stack - // configuration and specify a new version. AWS OpsWorks Stacks then automatically - // installs that version on the stack's instances. - // - // The default setting is the most - // recent release of the agent. To specify an agent version, you must use the - // complete version number, not the abbreviated number shown on the console. For a - // list of available agent version numbers, call DescribeAgentVersions. - // AgentVersion cannot be set to Chef 12.2. You can also specify an agent version - // when you create or update an instance, which overrides the stack's default - // setting. + // The default AWS OpsWorks Stacks agent version. You have the following options: + // - Auto-update - Set this parameter to LATEST . AWS OpsWorks Stacks + // automatically installs new agent versions on the stack's instances as soon as + // they are available. + // - Fixed version - Set this parameter to your preferred agent version. To + // update the agent version, you must edit the stack configuration and specify a + // new version. AWS OpsWorks Stacks then automatically installs that version on the + // stack's instances. + // The default setting is the most recent release of the agent. To specify an + // agent version, you must use the complete version number, not the abbreviated + // number shown on the console. For a list of available agent version numbers, call + // DescribeAgentVersions . AgentVersion cannot be set to Chef 12.2. You can also + // specify an agent version when you create or update an instance, which overrides + // the stack's default setting. AgentVersion *string // One or more user-defined key-value pairs to be added to the stack attributes. @@ -103,130 +97,100 @@ type CreateStackInput struct { // A ChefConfiguration object that specifies whether to enable Berkshelf and the // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . ChefConfiguration *types.ChefConfiguration - // The configuration manager. When you create a stack we recommend that you use the - // configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux - // stacks, or 12.2 for Windows stacks. The default value for Linux stacks is + // The configuration manager. When you create a stack we recommend that you use + // the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for + // Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is // currently 12. ConfigurationManager *types.StackConfigurationManager // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + // repository. For more information, see Adding Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) + // . CustomCookbooksSource *types.Source - // A string that contains user-defined, custom JSON. It can be used to override the - // corresponding default stack configuration attribute values or to pass data to - // recipes. The string should be in the following format: "{\"key1\": \"value1\", - // \"key2\": \"value2\",...}" For more information about custom JSON, see Use - // Custom JSON to Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). + // A string that contains user-defined, custom JSON. It can be used to override + // the corresponding default stack configuration attribute values or to pass data + // to recipes. The string should be in the following format: "{\"key1\": + // \"value1\", \"key2\": \"value2\",...}" For more information about custom JSON, + // see Use Custom JSON to Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // . CustomJson *string // The stack's default Availability Zone, which must be in the specified region. - // For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see the VpcId parameter description. + // For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . If you also specify a value for DefaultSubnetId , the subnet must be in the + // same zone. For more information, see the VpcId parameter description. DefaultAvailabilityZone *string // The stack's default operating system, which is installed on every instance // unless you specify a different operating system when you create the instance. // You can specify one of the following. - // - // * A supported Linux operating system: An - // Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon - // Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, - // or Amazon Linux 2015.03. - // - // * A supported Ubuntu operating system, such as Ubuntu - // 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. - // - // * CentOS Linux 7 - // - // * Red Hat - // Enterprise Linux 7 - // - // * A supported Windows operating system, such as Microsoft - // Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server - // Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft - // Windows Server 2012 R2 with SQL Server Web. - // - // * A custom AMI: Custom. You specify - // the custom AMI you want to use when you create instances. For more information, - // see Using Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // - // The - // default option is the current Amazon Linux version. For more information about - // supported operating systems, see AWS OpsWorks Stacks Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). + // - A supported Linux operating system: An Amazon Linux version, such as Amazon + // Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux + // 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux + // 2015.03 . + // - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu + // 14.04 LTS , or Ubuntu 12.04 LTS . + // - CentOS Linux 7 + // - Red Hat Enterprise Linux 7 + // - A supported Windows operating system, such as Microsoft Windows Server 2012 + // R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , + // Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft + // Windows Server 2012 R2 with SQL Server Web . + // - A custom AMI: Custom . You specify the custom AMI you want to use when you + // create instances. For more information, see Using Custom AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . + // The default option is the current Amazon Linux version. For more information + // about supported operating systems, see AWS OpsWorks Stacks Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . DefaultOs *string - // The default root device type. This value is the default for all instances in the - // stack, but you can override it when you create an instance. The default option - // is instance-store. For more information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // The default root device type. This value is the default for all instances in + // the stack, but you can override it when you create an instance. The default + // option is instance-store . For more information, see Storage for the Root Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . DefaultRootDeviceType types.RootDeviceType // A default Amazon EC2 key pair name. The default value is none. If you specify a // key pair name, AWS OpsWorks installs the public key on the instance and you can // use the private key with an SSH client to log in to the instance. For more - // information, see Using SSH to Communicate with an Instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) - // and Managing SSH Access - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). - // You can override this setting by specifying a different key pair, or no key - // pair, when you create an instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). + // information, see Using SSH to Communicate with an Instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) + // and Managing SSH Access (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html) + // . You can override this setting by specifying a different key pair, or no key + // pair, when you create an instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html) + // . DefaultSshKeyName *string // The stack's default VPC subnet ID. This parameter is required if you specify a // value for the VpcId parameter. All instances are launched into this subnet // unless you specify otherwise when you create the instance. If you also specify a - // value for DefaultAvailabilityZone, the subnet must be in that zone. For + // value for DefaultAvailabilityZone , the subnet must be in that zone. For // information on default values and when this parameter is required, see the VpcId // parameter description. DefaultSubnetId *string // The stack's host name theme, with spaces replaced by underscores. The theme is // used to generate host names for the stack's instances. By default, HostnameTheme - // is set to Layer_Dependent, which creates host names by appending integers to the - // layer's short name. The other themes are: - // - // * Baked_Goods - // - // * Clouds - // - // * - // Europe_Cities - // - // * Fruits - // - // * Greek_Deities_and_Titans - // - // * - // Legendary_creatures_from_Japan - // - // * Planets_and_Moons - // - // * Roman_Deities - // - // * - // Scottish_Islands - // - // * US_Cities - // - // * Wild_Cats - // - // To obtain a generated host name, - // call GetHostNameSuggestion, which returns a host name based on the current - // theme. + // is set to Layer_Dependent , which creates host names by appending integers to + // the layer's short name. The other themes are: + // - Baked_Goods + // - Clouds + // - Europe_Cities + // - Fruits + // - Greek_Deities_and_Titans + // - Legendary_creatures_from_Japan + // - Planets_and_Moons + // - Roman_Deities + // - Scottish_Islands + // - US_Cities + // - Wild_Cats + // To obtain a generated host name, call GetHostNameSuggestion , which returns a + // host name based on the current theme. HostnameTheme *string // Whether the stack uses custom cookbooks. @@ -237,53 +201,39 @@ type CreateStackInput struct { // groups, one for each layer, which are associated with layers by default. With // UseOpsworksSecurityGroups you can instead provide your own custom security // groups. UseOpsworksSecurityGroups has the following settings: - // - // * True - AWS - // OpsWorks Stacks automatically associates the appropriate built-in security group - // with each layer (default setting). You can associate additional security groups - // with a layer after you create it, but you cannot delete the built-in security - // group. - // - // * False - AWS OpsWorks Stacks does not associate built-in security - // groups with layers. You must create appropriate EC2 security groups and - // associate a security group with each layer that you create. However, you can - // still manually associate a built-in security group with a layer on creation; - // custom security groups are required only for those layers that need custom - // settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // - True - AWS OpsWorks Stacks automatically associates the appropriate + // built-in security group with each layer (default setting). You can associate + // additional security groups with a layer after you create it, but you cannot + // delete the built-in security group. + // - False - AWS OpsWorks Stacks does not associate built-in security groups + // with layers. You must create appropriate EC2 security groups and associate a + // security group with each layer that you create. However, you can still manually + // associate a built-in security group with a layer on creation; custom security + // groups are required only for those layers that need custom settings. + // For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . UseOpsworksSecurityGroups *bool // The ID of the VPC that the stack is to be launched into. The VPC must be in the // stack's region. All instances are launched into this VPC. You cannot change the // ID later. - // - // * If your account supports EC2-Classic, the default value is no - // VPC. - // - // * If your account does not support EC2-Classic, the default value is the - // default VPC for the specified region. - // - // If the VPC ID corresponds to a default - // VPC and you have specified either the DefaultAvailabilityZone or the - // DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the - // other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets - // these parameters to the first valid Availability Zone for the specified region - // and the corresponding default VPC subnet ID, respectively. If you specify a - // nondefault VPC ID, note the following: - // - // * It must belong to a VPC in your - // account that is in the specified region. - // - // * You must specify a value for - // DefaultSubnetId. - // - // For more information about how to use AWS OpsWorks Stacks with - // a VPC, see Running a Stack in a VPC - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). - // For more information about default VPC and EC2-Classic, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + // - If your account supports EC2-Classic, the default value is no VPC . + // - If your account does not support EC2-Classic, the default value is the + // default VPC for the specified region. + // If the VPC ID corresponds to a default VPC and you have specified either the + // DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks + // Stacks infers the value of the other parameter. If you specify neither + // parameter, AWS OpsWorks Stacks sets these parameters to the first valid + // Availability Zone for the specified region and the corresponding default VPC + // subnet ID, respectively. If you specify a nondefault VPC ID, note the following: + // + // - It must belong to a VPC in your account that is in the specified region. + // - You must specify a value for DefaultSubnetId . + // For more information about how to use AWS OpsWorks Stacks with a VPC, see + // Running a Stack in a VPC (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html) + // . For more information about default VPC and EC2-Classic, see Supported + // Platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // . VpcId *string noSmithyDocumentSerde @@ -293,7 +243,7 @@ type CreateStackInput struct { type CreateStackOutput struct { // The stack ID, which is an opaque string that you use to identify the stack when - // performing actions such as DescribeStacks. + // performing actions such as DescribeStacks . StackId *string // Metadata pertaining to the operation's result. diff --git a/service/opsworks/api_op_CreateUserProfile.go b/service/opsworks/api_op_CreateUserProfile.go index a6e939df4ab..955a756b8b2 100644 --- a/service/opsworks/api_op_CreateUserProfile.go +++ b/service/opsworks/api_op_CreateUserProfile.go @@ -12,8 +12,8 @@ import ( // Creates a new user profile. Required Permissions: To use this action, an IAM // user must have an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) CreateUserProfile(ctx context.Context, params *CreateUserProfileInput, optFns ...func(*Options)) (*CreateUserProfileOutput, error) { if params == nil { params = &CreateUserProfileInput{} @@ -36,19 +36,19 @@ type CreateUserProfileInput struct { // This member is required. IamUserArn *string - // Whether users can specify their own SSH public key through the My Settings page. - // For more information, see Setting an IAM User's Public SSH Key - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). + // Whether users can specify their own SSH public key through the My Settings + // page. For more information, see Setting an IAM User's Public SSH Key (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html) + // . AllowSelfManagement *bool // The user's public SSH key. SshPublicKey *string - // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', - // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks - // Stacks removes them. For example, my.name will be changed to myname. If you do - // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM - // user name. + // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], + // '-', and '_'. If the specified name includes other punctuation marks, AWS + // OpsWorks Stacks removes them. For example, my.name will be changed to myname . + // If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from + // the IAM user name. SshUsername *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_DeleteApp.go b/service/opsworks/api_op_DeleteApp.go index 1cc6a589a2a..78002c23c1f 100644 --- a/service/opsworks/api_op_DeleteApp.go +++ b/service/opsworks/api_op_DeleteApp.go @@ -13,8 +13,8 @@ import ( // Deletes a specified app. Required Permissions: To use this action, an IAM user // must have a Manage permissions level for the stack, or an attached policy that // explicitly grants permissions. For more information on user permissions, see -// Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error) { if params == nil { params = &DeleteAppInput{} diff --git a/service/opsworks/api_op_DeleteInstance.go b/service/opsworks/api_op_DeleteInstance.go index abac7bdbaf3..e886b410634 100644 --- a/service/opsworks/api_op_DeleteInstance.go +++ b/service/opsworks/api_op_DeleteInstance.go @@ -12,13 +12,12 @@ import ( // Deletes a specified instance, which terminates the associated Amazon EC2 // instance. You must stop an instance before you can delete it. For more -// information, see Deleting Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// information, see Deleting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error) { if params == nil { params = &DeleteInstanceInput{} diff --git a/service/opsworks/api_op_DeleteLayer.go b/service/opsworks/api_op_DeleteLayer.go index 2adffc527e8..b7c06a472cb 100644 --- a/service/opsworks/api_op_DeleteLayer.go +++ b/service/opsworks/api_op_DeleteLayer.go @@ -12,13 +12,12 @@ import ( // Deletes a specified layer. You must first stop and then delete all associated // instances or unassign registered instances. For more information, see How to -// Delete a Layer -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Delete a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeleteLayer(ctx context.Context, params *DeleteLayerInput, optFns ...func(*Options)) (*DeleteLayerOutput, error) { if params == nil { params = &DeleteLayerInput{} diff --git a/service/opsworks/api_op_DeleteStack.go b/service/opsworks/api_op_DeleteStack.go index 3bb49ab3de0..593da479f2e 100644 --- a/service/opsworks/api_op_DeleteStack.go +++ b/service/opsworks/api_op_DeleteStack.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specified stack. You must first delete all instances, layers, and apps -// or deregister registered instances. For more information, see Shut Down a Stack -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Deletes a specified stack. You must first delete all instances, layers, and +// apps or deregister registered instances. For more information, see Shut Down a +// Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error) { if params == nil { params = &DeleteStackInput{} diff --git a/service/opsworks/api_op_DeleteUserProfile.go b/service/opsworks/api_op_DeleteUserProfile.go index bfc8cfabad5..4a475336a00 100644 --- a/service/opsworks/api_op_DeleteUserProfile.go +++ b/service/opsworks/api_op_DeleteUserProfile.go @@ -12,8 +12,8 @@ import ( // Deletes a user profile. Required Permissions: To use this action, an IAM user // must have an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeleteUserProfile(ctx context.Context, params *DeleteUserProfileInput, optFns ...func(*Options)) (*DeleteUserProfileOutput, error) { if params == nil { params = &DeleteUserProfileInput{} diff --git a/service/opsworks/api_op_DeregisterEcsCluster.go b/service/opsworks/api_op_DeregisterEcsCluster.go index 109e64e0d4d..0ae13472879 100644 --- a/service/opsworks/api_op_DeregisterEcsCluster.go +++ b/service/opsworks/api_op_DeregisterEcsCluster.go @@ -11,13 +11,12 @@ import ( ) // Deregisters a specified Amazon ECS cluster from a stack. For more information, -// see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete). -// Required Permissions: To use this action, an IAM user must have a Manage +// see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack or an attached policy that explicitly grants // permissions. For more information on user permissions, see -// https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeregisterEcsCluster(ctx context.Context, params *DeregisterEcsClusterInput, optFns ...func(*Options)) (*DeregisterEcsClusterOutput, error) { if params == nil { params = &DeregisterEcsClusterInput{} diff --git a/service/opsworks/api_op_DeregisterElasticIp.go b/service/opsworks/api_op_DeregisterElasticIp.go index 9c409dd9c17..272218042ec 100644 --- a/service/opsworks/api_op_DeregisterElasticIp.go +++ b/service/opsworks/api_op_DeregisterElasticIp.go @@ -11,12 +11,12 @@ import ( ) // Deregisters a specified Elastic IP address. The address can then be registered -// by another stack. For more information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// by another stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeregisterElasticIp(ctx context.Context, params *DeregisterElasticIpInput, optFns ...func(*Options)) (*DeregisterElasticIpOutput, error) { if params == nil { params = &DeregisterElasticIpInput{} diff --git a/service/opsworks/api_op_DeregisterInstance.go b/service/opsworks/api_op_DeregisterInstance.go index e9cff953d91..f96cfd7c29e 100644 --- a/service/opsworks/api_op_DeregisterInstance.go +++ b/service/opsworks/api_op_DeregisterInstance.go @@ -15,8 +15,8 @@ import ( // be used with instances that were created with AWS OpsWorks Stacks. Required // Permissions: To use this action, an IAM user must have a Manage permissions // level for the stack or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// For more information on user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeregisterInstance(ctx context.Context, params *DeregisterInstanceInput, optFns ...func(*Options)) (*DeregisterInstanceOutput, error) { if params == nil { params = &DeregisterInstanceInput{} diff --git a/service/opsworks/api_op_DeregisterRdsDbInstance.go b/service/opsworks/api_op_DeregisterRdsDbInstance.go index 9724197d176..16141a18708 100644 --- a/service/opsworks/api_op_DeregisterRdsDbInstance.go +++ b/service/opsworks/api_op_DeregisterRdsDbInstance.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregisters an Amazon RDS instance. Required Permissions: To use this action, an -// IAM user must have a Manage permissions level for the stack, or an attached +// Deregisters an Amazon RDS instance. Required Permissions: To use this action, +// an IAM user must have a Manage permissions level for the stack, or an attached // policy that explicitly grants permissions. For more information on user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeregisterRdsDbInstance(ctx context.Context, params *DeregisterRdsDbInstanceInput, optFns ...func(*Options)) (*DeregisterRdsDbInstanceOutput, error) { if params == nil { params = &DeregisterRdsDbInstanceInput{} diff --git a/service/opsworks/api_op_DeregisterVolume.go b/service/opsworks/api_op_DeregisterVolume.go index ac878774984..001253db6a3 100644 --- a/service/opsworks/api_op_DeregisterVolume.go +++ b/service/opsworks/api_op_DeregisterVolume.go @@ -11,12 +11,12 @@ import ( ) // Deregisters an Amazon EBS volume. The volume can then be registered by another -// stack. For more information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DeregisterVolume(ctx context.Context, params *DeregisterVolumeInput, optFns ...func(*Options)) (*DeregisterVolumeOutput, error) { if params == nil { params = &DeregisterVolumeInput{} diff --git a/service/opsworks/api_op_DescribeApps.go b/service/opsworks/api_op_DescribeApps.go index 3b602437b33..8a14c580a3e 100644 --- a/service/opsworks/api_op_DescribeApps.go +++ b/service/opsworks/api_op_DescribeApps.go @@ -19,8 +19,8 @@ import ( // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeApps(ctx context.Context, params *DescribeAppsInput, optFns ...func(*Options)) (*DescribeAppsOutput, error) { if params == nil { params = &DescribeAppsInput{} @@ -142,9 +142,9 @@ type AppExistsWaiterOptions struct { // must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, AppExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, AppExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/opsworks/api_op_DescribeCommands.go b/service/opsworks/api_op_DescribeCommands.go index 93fd275cd60..378cbc034c7 100644 --- a/service/opsworks/api_op_DescribeCommands.go +++ b/service/opsworks/api_op_DescribeCommands.go @@ -15,8 +15,8 @@ import ( // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeCommands(ctx context.Context, params *DescribeCommandsInput, optFns ...func(*Options)) (*DescribeCommandsOutput, error) { if params == nil { params = &DescribeCommandsInput{} @@ -34,9 +34,9 @@ func (c *Client) DescribeCommands(ctx context.Context, params *DescribeCommandsI type DescribeCommandsInput struct { - // An array of command IDs. If you include this parameter, DescribeCommands returns - // a description of the specified commands. Otherwise, it returns a description of - // every command. + // An array of command IDs. If you include this parameter, DescribeCommands + // returns a description of the specified commands. Otherwise, it returns a + // description of every command. CommandIds []string // The deployment ID. If you include this parameter, DescribeCommands returns a diff --git a/service/opsworks/api_op_DescribeDeployments.go b/service/opsworks/api_op_DescribeDeployments.go index 7e2cbaf5dfd..d5169a77c28 100644 --- a/service/opsworks/api_op_DescribeDeployments.go +++ b/service/opsworks/api_op_DescribeDeployments.go @@ -16,12 +16,12 @@ import ( "time" ) -// Requests a description of a specified set of deployments. This call accepts only -// one resource-identifying parameter. Required Permissions: To use this action, an -// IAM user must have a Show, Deploy, or Manage permissions level for the stack, or -// an attached policy that explicitly grants permissions. For more information -// about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Requests a description of a specified set of deployments. This call accepts +// only one resource-identifying parameter. Required Permissions: To use this +// action, an IAM user must have a Show, Deploy, or Manage permissions level for +// the stack, or an attached policy that explicitly grants permissions. For more +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeDeployments(ctx context.Context, params *DescribeDeploymentsInput, optFns ...func(*Options)) (*DescribeDeploymentsOutput, error) { if params == nil { params = &DescribeDeploymentsInput{} @@ -127,8 +127,8 @@ func (c *Client) addOperationDescribeDeploymentsMiddlewares(stack *middleware.St return nil } -// DescribeDeploymentsAPIClient is a client that implements the DescribeDeployments -// operation. +// DescribeDeploymentsAPIClient is a client that implements the +// DescribeDeployments operation. type DescribeDeploymentsAPIClient interface { DescribeDeployments(context.Context, *DescribeDeploymentsInput, ...func(*Options)) (*DescribeDeploymentsOutput, error) } @@ -149,9 +149,10 @@ type DeploymentSuccessfulWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DeploymentSuccessfulWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DeploymentSuccessfulWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/opsworks/api_op_DescribeEcsClusters.go b/service/opsworks/api_op_DescribeEcsClusters.go index b3f2aff0a8c..b78457aeec5 100644 --- a/service/opsworks/api_op_DescribeEcsClusters.go +++ b/service/opsworks/api_op_DescribeEcsClusters.go @@ -13,14 +13,14 @@ import ( ) // Describes Amazon ECS clusters that are registered with a stack. If you specify -// only a stack ID, you can use the MaxResults and NextToken parameters to paginate -// the response. However, AWS OpsWorks Stacks currently supports only one cluster -// per layer, so the result set has a maximum of one element. Required Permissions: -// To use this action, an IAM user must have a Show, Deploy, or Manage permissions -// level for the stack or an attached policy that explicitly grants permission. For -// more information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). -// This call accepts only one resource-identifying parameter. +// only a stack ID, you can use the MaxResults and NextToken parameters to +// paginate the response. However, AWS OpsWorks Stacks currently supports only one +// cluster per layer, so the result set has a maximum of one element. Required +// Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage +// permissions level for the stack or an attached policy that explicitly grants +// permission. For more information about user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . This call accepts only one resource-identifying parameter. func (c *Client) DescribeEcsClusters(ctx context.Context, params *DescribeEcsClustersInput, optFns ...func(*Options)) (*DescribeEcsClustersOutput, error) { if params == nil { params = &DescribeEcsClustersInput{} @@ -48,10 +48,10 @@ type DescribeEcsClustersInput struct { MaxResults *int32 // If the previous paginated request did not return all of the remaining results, - // the response object'sNextToken parameter value is set to a token. To retrieve - // the next set of results, call DescribeEcsClusters again and assign that token to - // the request object's NextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the response object's NextToken parameter value is set to a token. To retrieve + // the next set of results, call DescribeEcsClusters again and assign that token + // to the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null . NextToken *string // A stack ID. DescribeEcsClusters returns a description of the cluster that is @@ -71,7 +71,7 @@ type DescribeEcsClustersOutput struct { // parameter is set to a token that you can assign to the request object's // NextToken parameter to retrieve the next set of results. If the previous // paginated request returned all of the remaining results, this parameter is set - // to null. + // to null . NextToken *string // Metadata pertaining to the operation's result. @@ -140,8 +140,8 @@ func (c *Client) addOperationDescribeEcsClustersMiddlewares(stack *middleware.St return nil } -// DescribeEcsClustersAPIClient is a client that implements the DescribeEcsClusters -// operation. +// DescribeEcsClustersAPIClient is a client that implements the +// DescribeEcsClusters operation. type DescribeEcsClustersAPIClient interface { DescribeEcsClusters(context.Context, *DescribeEcsClustersInput, ...func(*Options)) (*DescribeEcsClustersOutput, error) } diff --git a/service/opsworks/api_op_DescribeElasticIps.go b/service/opsworks/api_op_DescribeElasticIps.go index f53327ce6c4..82365556e6c 100644 --- a/service/opsworks/api_op_DescribeElasticIps.go +++ b/service/opsworks/api_op_DescribeElasticIps.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes Elastic IP addresses -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html). -// This call accepts only one resource-identifying parameter. Required Permissions: -// To use this action, an IAM user must have a Show, Deploy, or Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Describes Elastic IP addresses (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) +// . This call accepts only one resource-identifying parameter. Required +// Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information about user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeElasticIps(ctx context.Context, params *DescribeElasticIpsInput, optFns ...func(*Options)) (*DescribeElasticIpsOutput, error) { if params == nil { params = &DescribeElasticIpsInput{} @@ -39,9 +39,9 @@ type DescribeElasticIpsInput struct { // description of the Elastic IP addresses associated with the specified instance. InstanceId *string - // An array of Elastic IP addresses to be described. If you include this parameter, - // DescribeElasticIps returns a description of the specified Elastic IP addresses. - // Otherwise, it returns a description of every Elastic IP address. + // An array of Elastic IP addresses to be described. If you include this + // parameter, DescribeElasticIps returns a description of the specified Elastic IP + // addresses. Otherwise, it returns a description of every Elastic IP address. Ips []string // A stack ID. If you include this parameter, DescribeElasticIps returns a diff --git a/service/opsworks/api_op_DescribeElasticLoadBalancers.go b/service/opsworks/api_op_DescribeElasticLoadBalancers.go index 8c846fd9adf..8cf855a4e2b 100644 --- a/service/opsworks/api_op_DescribeElasticLoadBalancers.go +++ b/service/opsworks/api_op_DescribeElasticLoadBalancers.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a stack's Elastic Load Balancing instances. This call accepts only one -// resource-identifying parameter. Required Permissions: To use this action, an IAM -// user must have a Show, Deploy, or Manage permissions level for the stack, or an -// attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Describes a stack's Elastic Load Balancing instances. This call accepts only +// one resource-identifying parameter. Required Permissions: To use this action, an +// IAM user must have a Show, Deploy, or Manage permissions level for the stack, or +// an attached policy that explicitly grants permissions. For more information +// about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeElasticLoadBalancers(ctx context.Context, params *DescribeElasticLoadBalancersInput, optFns ...func(*Options)) (*DescribeElasticLoadBalancersOutput, error) { if params == nil { params = &DescribeElasticLoadBalancersInput{} diff --git a/service/opsworks/api_op_DescribeInstances.go b/service/opsworks/api_op_DescribeInstances.go index 1e3e6e08255..aedbcd6b2ec 100644 --- a/service/opsworks/api_op_DescribeInstances.go +++ b/service/opsworks/api_op_DescribeInstances.go @@ -21,8 +21,8 @@ import ( // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstancesInput, optFns ...func(*Options)) (*DescribeInstancesOutput, error) { if params == nil { params = &DescribeInstancesInput{} @@ -45,12 +45,12 @@ type DescribeInstancesInput struct { // it returns a description of every instance. InstanceIds []string - // A layer ID. If you use this parameter, DescribeInstances returns descriptions of - // the instances associated with the specified layer. + // A layer ID. If you use this parameter, DescribeInstances returns descriptions + // of the instances associated with the specified layer. LayerId *string - // A stack ID. If you use this parameter, DescribeInstances returns descriptions of - // the instances associated with the specified stack. + // A stack ID. If you use this parameter, DescribeInstances returns descriptions + // of the instances associated with the specified stack. StackId *string noSmithyDocumentSerde @@ -149,9 +149,9 @@ type InstanceOnlineWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceOnlineWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceOnlineWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -516,8 +516,8 @@ type InstanceRegisteredWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceRegisteredWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceRegisteredWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -859,9 +859,9 @@ type InstanceStoppedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceStoppedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceStoppedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -901,9 +901,9 @@ func NewInstanceStoppedWaiter(client DescribeInstancesAPIClient, optFns ...func( } } -// Wait calls the waiter function for InstanceStopped waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for InstanceStopped waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *InstanceStoppedWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceStoppedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -1226,8 +1226,8 @@ type InstanceTerminatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, InstanceTerminatedWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, InstanceTerminatedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration diff --git a/service/opsworks/api_op_DescribeLayers.go b/service/opsworks/api_op_DescribeLayers.go index a8fb69e84a8..75ae8fa52c7 100644 --- a/service/opsworks/api_op_DescribeLayers.go +++ b/service/opsworks/api_op_DescribeLayers.go @@ -15,8 +15,8 @@ import ( // accepts only one resource-identifying parameter. Required Permissions: To use // this action, an IAM user must have a Show, Deploy, or Manage permissions level // for the stack, or an attached policy that explicitly grants permissions. For -// more information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeLayers(ctx context.Context, params *DescribeLayersInput, optFns ...func(*Options)) (*DescribeLayersOutput, error) { if params == nil { params = &DescribeLayersInput{} diff --git a/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go b/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go index 9d1c87a22f2..881bdeed009 100644 --- a/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go +++ b/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go @@ -15,8 +15,8 @@ import ( // specify at least one of the parameters. Required Permissions: To use this // action, an IAM user must have a Show, Deploy, or Manage permissions level for // the stack, or an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeLoadBasedAutoScaling(ctx context.Context, params *DescribeLoadBasedAutoScalingInput, optFns ...func(*Options)) (*DescribeLoadBasedAutoScalingOutput, error) { if params == nil { params = &DescribeLoadBasedAutoScalingInput{} @@ -45,8 +45,8 @@ type DescribeLoadBasedAutoScalingInput struct { // Contains the response to a DescribeLoadBasedAutoScaling request. type DescribeLoadBasedAutoScalingOutput struct { - // An array of LoadBasedAutoScalingConfiguration objects that describe each layer's - // configuration. + // An array of LoadBasedAutoScalingConfiguration objects that describe each + // layer's configuration. LoadBasedAutoScalingConfigurations []types.LoadBasedAutoScalingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/opsworks/api_op_DescribeMyUserProfile.go b/service/opsworks/api_op_DescribeMyUserProfile.go index e105289f47b..5f215a7d92b 100644 --- a/service/opsworks/api_op_DescribeMyUserProfile.go +++ b/service/opsworks/api_op_DescribeMyUserProfile.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a user's SSH information. Required Permissions: To use this action, an -// IAM user must have self-management enabled or an attached policy that explicitly -// grants permissions. For more information about user permissions, see Managing -// User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Describes a user's SSH information. Required Permissions: To use this action, +// an IAM user must have self-management enabled or an attached policy that +// explicitly grants permissions. For more information about user permissions, see +// Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeMyUserProfile(ctx context.Context, params *DescribeMyUserProfileInput, optFns ...func(*Options)) (*DescribeMyUserProfileOutput, error) { if params == nil { params = &DescribeMyUserProfileInput{} diff --git a/service/opsworks/api_op_DescribePermissions.go b/service/opsworks/api_op_DescribePermissions.go index 84d8d01db29..10b4e412a40 100644 --- a/service/opsworks/api_op_DescribePermissions.go +++ b/service/opsworks/api_op_DescribePermissions.go @@ -14,8 +14,8 @@ import ( // Describes the permissions for a specified stack. Required Permissions: To use // this action, an IAM user must have a Manage permissions level for the stack, or // an attached policy that explicitly grants permissions. For more information on -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribePermissions(ctx context.Context, params *DescribePermissionsInput, optFns ...func(*Options)) (*DescribePermissionsOutput, error) { if params == nil { params = &DescribePermissionsInput{} @@ -34,8 +34,8 @@ func (c *Client) DescribePermissions(ctx context.Context, params *DescribePermis type DescribePermissionsInput struct { // The user's IAM ARN. This can also be a federated user's ARN. For more - // information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . IamUserArn *string // The stack ID. @@ -48,18 +48,12 @@ type DescribePermissionsInput struct { type DescribePermissionsOutput struct { // An array of Permission objects that describe the stack permissions. - // - // * If the - // request object contains only a stack ID, the array contains a Permission object - // with permissions for each of the stack IAM ARNs. - // - // * If the request object - // contains only an IAM ARN, the array contains a Permission object with - // permissions for each of the user's stack IDs. - // - // * If the request contains a stack - // ID and an IAM ARN, the array contains a single Permission object with - // permissions for the specified stack and IAM ARN. + // - If the request object contains only a stack ID, the array contains a + // Permission object with permissions for each of the stack IAM ARNs. + // - If the request object contains only an IAM ARN, the array contains a + // Permission object with permissions for each of the user's stack IDs. + // - If the request contains a stack ID and an IAM ARN, the array contains a + // single Permission object with permissions for the specified stack and IAM ARN. Permissions []types.Permission // Metadata pertaining to the operation's result. diff --git a/service/opsworks/api_op_DescribeRaidArrays.go b/service/opsworks/api_op_DescribeRaidArrays.go index ea4d2924ecb..48d0f260027 100644 --- a/service/opsworks/api_op_DescribeRaidArrays.go +++ b/service/opsworks/api_op_DescribeRaidArrays.go @@ -15,8 +15,8 @@ import ( // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeRaidArrays(ctx context.Context, params *DescribeRaidArraysInput, optFns ...func(*Options)) (*DescribeRaidArraysOutput, error) { if params == nil { params = &DescribeRaidArraysInput{} diff --git a/service/opsworks/api_op_DescribeRdsDbInstances.go b/service/opsworks/api_op_DescribeRdsDbInstances.go index 54878704646..9edf87b7544 100644 --- a/service/opsworks/api_op_DescribeRdsDbInstances.go +++ b/service/opsworks/api_op_DescribeRdsDbInstances.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes Amazon RDS instances. Required Permissions: To use this action, an IAM -// user must have a Show, Deploy, or Manage permissions level for the stack, or an -// attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). -// This call accepts only one resource-identifying parameter. +// Describes Amazon RDS instances. Required Permissions: To use this action, an +// IAM user must have a Show, Deploy, or Manage permissions level for the stack, or +// an attached policy that explicitly grants permissions. For more information +// about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . This call accepts only one resource-identifying parameter. func (c *Client) DescribeRdsDbInstances(ctx context.Context, params *DescribeRdsDbInstancesInput, optFns ...func(*Options)) (*DescribeRdsDbInstancesOutput, error) { if params == nil { params = &DescribeRdsDbInstancesInput{} diff --git a/service/opsworks/api_op_DescribeServiceErrors.go b/service/opsworks/api_op_DescribeServiceErrors.go index c6fdbbd9a02..0fdb1d2b2e3 100644 --- a/service/opsworks/api_op_DescribeServiceErrors.go +++ b/service/opsworks/api_op_DescribeServiceErrors.go @@ -14,9 +14,8 @@ import ( // Describes AWS OpsWorks Stacks service errors. Required Permissions: To use this // action, an IAM user must have a Show, Deploy, or Manage permissions level for // the stack, or an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). -// This call accepts only one resource-identifying parameter. +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . This call accepts only one resource-identifying parameter. func (c *Client) DescribeServiceErrors(ctx context.Context, params *DescribeServiceErrorsInput, optFns ...func(*Options)) (*DescribeServiceErrorsOutput, error) { if params == nil { params = &DescribeServiceErrorsInput{} diff --git a/service/opsworks/api_op_DescribeStackProvisioningParameters.go b/service/opsworks/api_op_DescribeStackProvisioningParameters.go index 39720da1a45..93d872c9d80 100644 --- a/service/opsworks/api_op_DescribeStackProvisioningParameters.go +++ b/service/opsworks/api_op_DescribeStackProvisioningParameters.go @@ -14,8 +14,8 @@ import ( // Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage // permissions level for the stack or an attached policy that explicitly grants // permissions. For more information about user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeStackProvisioningParameters(ctx context.Context, params *DescribeStackProvisioningParametersInput, optFns ...func(*Options)) (*DescribeStackProvisioningParametersOutput, error) { if params == nil { params = &DescribeStackProvisioningParametersInput{} diff --git a/service/opsworks/api_op_DescribeStackSummary.go b/service/opsworks/api_op_DescribeStackSummary.go index 8d686d70eec..324f50d9fe2 100644 --- a/service/opsworks/api_op_DescribeStackSummary.go +++ b/service/opsworks/api_op_DescribeStackSummary.go @@ -12,11 +12,11 @@ import ( ) // Describes the number of layers and apps in a specified stack, and the number of -// instances in each state, such as running_setup or online. Required Permissions: +// instances in each state, such as running_setup or online . Required Permissions: // To use this action, an IAM user must have a Show, Deploy, or Manage permissions // level for the stack, or an attached policy that explicitly grants permissions. -// For more information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// For more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeStackSummary(ctx context.Context, params *DescribeStackSummaryInput, optFns ...func(*Options)) (*DescribeStackSummaryOutput, error) { if params == nil { params = &DescribeStackSummaryInput{} diff --git a/service/opsworks/api_op_DescribeStacks.go b/service/opsworks/api_op_DescribeStacks.go index b9325fb9e42..179956adcfb 100644 --- a/service/opsworks/api_op_DescribeStacks.go +++ b/service/opsworks/api_op_DescribeStacks.go @@ -14,8 +14,8 @@ import ( // Requests a description of one or more stacks. Required Permissions: To use this // action, an IAM user must have a Show, Deploy, or Manage permissions level for // the stack, or an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error) { if params == nil { params = &DescribeStacksInput{} diff --git a/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go b/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go index 3068063e24e..857aee6a2f0 100644 --- a/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go +++ b/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go @@ -15,8 +15,8 @@ import ( // must specify at least one of the parameters. Required Permissions: To use this // action, an IAM user must have a Show, Deploy, or Manage permissions level for // the stack, or an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeTimeBasedAutoScaling(ctx context.Context, params *DescribeTimeBasedAutoScalingInput, optFns ...func(*Options)) (*DescribeTimeBasedAutoScalingOutput, error) { if params == nil { params = &DescribeTimeBasedAutoScalingInput{} diff --git a/service/opsworks/api_op_DescribeUserProfiles.go b/service/opsworks/api_op_DescribeUserProfiles.go index 5bdd2016a8b..073f69e3d79 100644 --- a/service/opsworks/api_op_DescribeUserProfiles.go +++ b/service/opsworks/api_op_DescribeUserProfiles.go @@ -13,8 +13,8 @@ import ( // Describe specified users. Required Permissions: To use this action, an IAM user // must have an attached policy that explicitly grants permissions. For more -// information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeUserProfiles(ctx context.Context, params *DescribeUserProfilesInput, optFns ...func(*Options)) (*DescribeUserProfilesOutput, error) { if params == nil { params = &DescribeUserProfilesInput{} diff --git a/service/opsworks/api_op_DescribeVolumes.go b/service/opsworks/api_op_DescribeVolumes.go index fd3ba15efba..b86933f6db9 100644 --- a/service/opsworks/api_op_DescribeVolumes.go +++ b/service/opsworks/api_op_DescribeVolumes.go @@ -15,8 +15,8 @@ import ( // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about -// user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInput, optFns ...func(*Options)) (*DescribeVolumesOutput, error) { if params == nil { params = &DescribeVolumesInput{} @@ -34,8 +34,8 @@ func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInp type DescribeVolumesInput struct { - // The instance ID. If you use this parameter, DescribeVolumes returns descriptions - // of the volumes associated with the specified instance. + // The instance ID. If you use this parameter, DescribeVolumes returns + // descriptions of the volumes associated with the specified instance. InstanceId *string // The RAID array ID. If you use this parameter, DescribeVolumes returns diff --git a/service/opsworks/api_op_DetachElasticLoadBalancer.go b/service/opsworks/api_op_DetachElasticLoadBalancer.go index 432aad0b289..6063e0114bb 100644 --- a/service/opsworks/api_op_DetachElasticLoadBalancer.go +++ b/service/opsworks/api_op_DetachElasticLoadBalancer.go @@ -13,8 +13,8 @@ import ( // Detaches a specified Elastic Load Balancing instance from its layer. Required // Permissions: To use this action, an IAM user must have a Manage permissions // level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// For more information on user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DetachElasticLoadBalancer(ctx context.Context, params *DetachElasticLoadBalancerInput, optFns ...func(*Options)) (*DetachElasticLoadBalancerOutput, error) { if params == nil { params = &DetachElasticLoadBalancerInput{} diff --git a/service/opsworks/api_op_DisassociateElasticIp.go b/service/opsworks/api_op_DisassociateElasticIp.go index 4a875d13508..bb8561f06bf 100644 --- a/service/opsworks/api_op_DisassociateElasticIp.go +++ b/service/opsworks/api_op_DisassociateElasticIp.go @@ -11,12 +11,12 @@ import ( ) // Disassociates an Elastic IP address from its instance. The address remains -// registered with the stack. For more information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// registered with the stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) DisassociateElasticIp(ctx context.Context, params *DisassociateElasticIpInput, optFns ...func(*Options)) (*DisassociateElasticIpOutput, error) { if params == nil { params = &DisassociateElasticIpInput{} diff --git a/service/opsworks/api_op_GetHostnameSuggestion.go b/service/opsworks/api_op_GetHostnameSuggestion.go index 30ce51f4134..439bcd8fef8 100644 --- a/service/opsworks/api_op_GetHostnameSuggestion.go +++ b/service/opsworks/api_op_GetHostnameSuggestion.go @@ -14,8 +14,8 @@ import ( // name theme. Required Permissions: To use this action, an IAM user must have a // Manage permissions level for the stack, or an attached policy that explicitly // grants permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) GetHostnameSuggestion(ctx context.Context, params *GetHostnameSuggestionInput, optFns ...func(*Options)) (*GetHostnameSuggestionOutput, error) { if params == nil { params = &GetHostnameSuggestionInput{} diff --git a/service/opsworks/api_op_GrantAccess.go b/service/opsworks/api_op_GrantAccess.go index 11d76e66b25..cc85a3ed7bf 100644 --- a/service/opsworks/api_op_GrantAccess.go +++ b/service/opsworks/api_op_GrantAccess.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action can be used only with Windows stacks. Grants RDP access to a Windows -// instance for a specified time period. +// This action can be used only with Windows stacks. Grants RDP access to a +// Windows instance for a specified time period. func (c *Client) GrantAccess(ctx context.Context, params *GrantAccessInput, optFns ...func(*Options)) (*GrantAccessOutput, error) { if params == nil { params = &GrantAccessInput{} diff --git a/service/opsworks/api_op_ListTags.go b/service/opsworks/api_op_ListTags.go index 23565b2200d..c14d128270b 100644 --- a/service/opsworks/api_op_ListTags.go +++ b/service/opsworks/api_op_ListTags.go @@ -33,8 +33,8 @@ type ListTagsInput struct { // This member is required. ResourceArn *string - // Do not use. A validation exception occurs if you add a MaxResults parameter to a - // ListTagsRequest call. + // Do not use. A validation exception occurs if you add a MaxResults parameter to + // a ListTagsRequest call. MaxResults int32 // Do not use. A validation exception occurs if you add a NextToken parameter to a @@ -50,7 +50,7 @@ type ListTagsOutput struct { // If a paginated request does not return all of the remaining results, this // parameter is set to a token that you can assign to the request object's // NextToken parameter to get the next set of results. If the previous paginated - // request returned all of the remaining results, this parameter is set to null. + // request returned all of the remaining results, this parameter is set to null . NextToken *string // A set of key-value pairs that contain tag keys and tag values that are attached diff --git a/service/opsworks/api_op_RebootInstance.go b/service/opsworks/api_op_RebootInstance.go index 3b0c5e5e8a7..e43df85b647 100644 --- a/service/opsworks/api_op_RebootInstance.go +++ b/service/opsworks/api_op_RebootInstance.go @@ -11,13 +11,12 @@ import ( ) // Reboots a specified instance. For more information, see Starting, Stopping, and -// Rebooting Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Rebooting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RebootInstance(ctx context.Context, params *RebootInstanceInput, optFns ...func(*Options)) (*RebootInstanceOutput, error) { if params == nil { params = &RebootInstanceInput{} diff --git a/service/opsworks/api_op_RegisterEcsCluster.go b/service/opsworks/api_op_RegisterEcsCluster.go index b2fead9fd3e..89ec861f47d 100644 --- a/service/opsworks/api_op_RegisterEcsCluster.go +++ b/service/opsworks/api_op_RegisterEcsCluster.go @@ -10,15 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a specified Amazon ECS cluster with a stack. You can register only one -// cluster with a stack. A cluster can be registered with only one stack. For more -// information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Registers a specified Amazon ECS cluster with a stack. You can register only +// one cluster with a stack. A cluster can be registered with only one stack. For +// more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack or an attached policy that explicitly grants -// permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RegisterEcsCluster(ctx context.Context, params *RegisterEcsClusterInput, optFns ...func(*Options)) (*RegisterEcsClusterOutput, error) { if params == nil { params = &RegisterEcsClusterInput{} diff --git a/service/opsworks/api_op_RegisterElasticIp.go b/service/opsworks/api_op_RegisterElasticIp.go index bfd9ef8669a..ad72d743f49 100644 --- a/service/opsworks/api_op_RegisterElasticIp.go +++ b/service/opsworks/api_op_RegisterElasticIp.go @@ -12,13 +12,13 @@ import ( // Registers an Elastic IP address with a specified stack. An address can be // registered with only one stack at a time. If the address is already registered, -// you must first deregister it by calling DeregisterElasticIp. For more -// information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// you must first deregister it by calling DeregisterElasticIp . For more +// information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RegisterElasticIp(ctx context.Context, params *RegisterElasticIpInput, optFns ...func(*Options)) (*RegisterElasticIpOutput, error) { if params == nil { params = &RegisterElasticIpInput{} diff --git a/service/opsworks/api_op_RegisterInstance.go b/service/opsworks/api_op_RegisterInstance.go index 8d4a64b17a5..deeef130517 100644 --- a/service/opsworks/api_op_RegisterInstance.go +++ b/service/opsworks/api_op_RegisterInstance.go @@ -15,21 +15,20 @@ import ( // specified stack. We do not recommend using this action to register instances. // The complete registration operation includes two tasks: installing the AWS // OpsWorks Stacks agent on the instance, and registering the instance with the -// stack. RegisterInstance handles only the second step. You should instead use the -// AWS CLI register command, which performs the entire registration operation. For -// more information, see Registering an Instance with an AWS OpsWorks Stacks Stack -// (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html). -// Registered instances have the same requirements as instances that are created by -// using the CreateInstance API. For example, registered instances must be running -// a supported Linux-based operating system, and they must have a supported +// stack. RegisterInstance handles only the second step. You should instead use +// the AWS CLI register command, which performs the entire registration operation. +// For more information, see Registering an Instance with an AWS OpsWorks Stacks +// Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html) +// . Registered instances have the same requirements as instances that are created +// by using the CreateInstance API. For example, registered instances must be +// running a supported Linux-based operating system, and they must have a supported // instance type. For more information about requirements for instances that you -// want to register, see Preparing the Instance -// (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// want to register, see Preparing the Instance (https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceInput, optFns ...func(*Options)) (*RegisterInstanceOutput, error) { if params == nil { params = &RegisterInstanceInput{} diff --git a/service/opsworks/api_op_RegisterRdsDbInstance.go b/service/opsworks/api_op_RegisterRdsDbInstance.go index 6d95385db80..568d207ad5a 100644 --- a/service/opsworks/api_op_RegisterRdsDbInstance.go +++ b/service/opsworks/api_op_RegisterRdsDbInstance.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers an Amazon RDS instance with a stack. Required Permissions: To use this -// action, an IAM user must have a Manage permissions level for the stack, or an -// attached policy that explicitly grants permissions. For more information on user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Registers an Amazon RDS instance with a stack. Required Permissions: To use +// this action, an IAM user must have a Manage permissions level for the stack, or +// an attached policy that explicitly grants permissions. For more information on +// user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RegisterRdsDbInstance(ctx context.Context, params *RegisterRdsDbInstanceInput, optFns ...func(*Options)) (*RegisterRdsDbInstanceOutput, error) { if params == nil { params = &RegisterRdsDbInstanceInput{} diff --git a/service/opsworks/api_op_RegisterVolume.go b/service/opsworks/api_op_RegisterVolume.go index 47e3b1a2bac..b61c45825ea 100644 --- a/service/opsworks/api_op_RegisterVolume.go +++ b/service/opsworks/api_op_RegisterVolume.go @@ -12,13 +12,13 @@ import ( // Registers an Amazon EBS volume with a specified stack. A volume can be // registered with only one stack at a time. If the volume is already registered, -// you must first deregister it by calling DeregisterVolume. For more information, -// see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// you must first deregister it by calling DeregisterVolume . For more information, +// see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) RegisterVolume(ctx context.Context, params *RegisterVolumeInput, optFns ...func(*Options)) (*RegisterVolumeOutput, error) { if params == nil { params = &RegisterVolumeInput{} diff --git a/service/opsworks/api_op_SetLoadBasedAutoScaling.go b/service/opsworks/api_op_SetLoadBasedAutoScaling.go index e11df991b1f..3c6ace05e58 100644 --- a/service/opsworks/api_op_SetLoadBasedAutoScaling.go +++ b/service/opsworks/api_op_SetLoadBasedAutoScaling.go @@ -12,16 +12,15 @@ import ( ) // Specify the load-based auto scaling configuration for a specified layer. For -// more information, see Managing Load with Time-based and Load-based Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html). -// To use load-based auto scaling, you must create a set of load-based auto scaling -// instances. Load-based auto scaling operates only on the instances from that set, -// so you must ensure that you have created enough instances to handle the maximum -// anticipated load. Required Permissions: To use this action, an IAM user must -// have a Manage permissions level for the stack, or an attached policy that -// explicitly grants permissions. For more information on user permissions, see -// Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// more information, see Managing Load with Time-based and Load-based Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html) +// . To use load-based auto scaling, you must create a set of load-based auto +// scaling instances. Load-based auto scaling operates only on the instances from +// that set, so you must ensure that you have created enough instances to handle +// the maximum anticipated load. Required Permissions: To use this action, an IAM +// user must have a Manage permissions level for the stack, or an attached policy +// that explicitly grants permissions. For more information on user permissions, +// see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) SetLoadBasedAutoScaling(ctx context.Context, params *SetLoadBasedAutoScalingInput, optFns ...func(*Options)) (*SetLoadBasedAutoScalingOutput, error) { if params == nil { params = &SetLoadBasedAutoScalingInput{} @@ -44,8 +43,8 @@ type SetLoadBasedAutoScalingInput struct { // This member is required. LayerId *string - // An AutoScalingThresholds object with the downscaling threshold configuration. If - // the load falls below these thresholds for a specified amount of time, AWS + // An AutoScalingThresholds object with the downscaling threshold configuration. + // If the load falls below these thresholds for a specified amount of time, AWS // OpsWorks Stacks stops a specified number of instances. DownScaling *types.AutoScalingThresholds diff --git a/service/opsworks/api_op_SetPermission.go b/service/opsworks/api_op_SetPermission.go index c889512e08a..11f6a045034 100644 --- a/service/opsworks/api_op_SetPermission.go +++ b/service/opsworks/api_op_SetPermission.go @@ -11,13 +11,12 @@ import ( ) // Specifies a user's permissions. For more information, see Security and -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) SetPermission(ctx context.Context, params *SetPermissionInput, optFns ...func(*Options)) (*SetPermissionOutput, error) { if params == nil { params = &SetPermissionInput{} @@ -53,21 +52,14 @@ type SetPermissionInput struct { // The user's permission level, which must be set to one of the following strings. // You cannot set your own permissions level. - // - // * deny - // - // * show - // - // * deploy - // - // * - // manage - // - // * iam_only - // - // For more information about the permissions associated with - // these levels, see Managing User Permissions - // (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). + // - deny + // - show + // - deploy + // - manage + // - iam_only + // For more information about the permissions associated with these levels, see + // Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) + // . Level *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_SetTimeBasedAutoScaling.go b/service/opsworks/api_op_SetTimeBasedAutoScaling.go index 13e5800d4d6..19e443814a1 100644 --- a/service/opsworks/api_op_SetTimeBasedAutoScaling.go +++ b/service/opsworks/api_op_SetTimeBasedAutoScaling.go @@ -12,13 +12,12 @@ import ( ) // Specify the time-based auto scaling configuration for a specified instance. For -// more information, see Managing Load with Time-based and Load-based Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// more information, see Managing Load with Time-based and Load-based Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) SetTimeBasedAutoScaling(ctx context.Context, params *SetTimeBasedAutoScalingInput, optFns ...func(*Options)) (*SetTimeBasedAutoScalingOutput, error) { if params == nil { params = &SetTimeBasedAutoScalingInput{} diff --git a/service/opsworks/api_op_StartInstance.go b/service/opsworks/api_op_StartInstance.go index 850b1ac5544..89ff72c6c1d 100644 --- a/service/opsworks/api_op_StartInstance.go +++ b/service/opsworks/api_op_StartInstance.go @@ -11,13 +11,12 @@ import ( ) // Starts a specified instance. For more information, see Starting, Stopping, and -// Rebooting Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Rebooting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) StartInstance(ctx context.Context, params *StartInstanceInput, optFns ...func(*Options)) (*StartInstanceOutput, error) { if params == nil { params = &StartInstanceInput{} diff --git a/service/opsworks/api_op_StartStack.go b/service/opsworks/api_op_StartStack.go index efa322d6073..dbb9774d2d4 100644 --- a/service/opsworks/api_op_StartStack.go +++ b/service/opsworks/api_op_StartStack.go @@ -13,8 +13,8 @@ import ( // Starts a stack's instances. Required Permissions: To use this action, an IAM // user must have a Manage permissions level for the stack, or an attached policy // that explicitly grants permissions. For more information on user permissions, -// see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) StartStack(ctx context.Context, params *StartStackInput, optFns ...func(*Options)) (*StartStackOutput, error) { if params == nil { params = &StartStackInput{} diff --git a/service/opsworks/api_op_StopInstance.go b/service/opsworks/api_op_StopInstance.go index 377a08f791d..5ff4f38ee14 100644 --- a/service/opsworks/api_op_StopInstance.go +++ b/service/opsworks/api_op_StopInstance.go @@ -13,13 +13,12 @@ import ( // Stops a specified instance. When you stop a standard instance, the data // disappears and must be reinstalled when you restart the instance. You can stop // an Amazon EBS-backed instance without losing data. For more information, see -// Starting, Stopping, and Rebooting Instances -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html). -// Required Permissions: To use this action, an IAM user must have a Manage +// Starting, Stopping, and Rebooting Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html) +// . Required Permissions: To use this action, an IAM user must have a Manage // permissions level for the stack, or an attached policy that explicitly grants // permissions. For more information on user permissions, see Managing User -// Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) StopInstance(ctx context.Context, params *StopInstanceInput, optFns ...func(*Options)) (*StopInstanceOutput, error) { if params == nil { params = &StopInstanceInput{} @@ -43,8 +42,8 @@ type StopInstanceInput struct { InstanceId *string // Specifies whether to force an instance to stop. If the instance's root device - // type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API - // call disassociates the AWS OpsWorks Stacks instance from EC2, and forces + // type is ebs , or EBS-backed, adding the Force parameter to the StopInstances + // API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces // deletion of only the OpsWorks Stacks instance. You must also delete the // formerly-associated instance in EC2 after troubleshooting and replacing the AWS // OpsWorks Stacks instance with a new one. diff --git a/service/opsworks/api_op_StopStack.go b/service/opsworks/api_op_StopStack.go index b15199b2f22..c1d67230a64 100644 --- a/service/opsworks/api_op_StopStack.go +++ b/service/opsworks/api_op_StopStack.go @@ -13,8 +13,8 @@ import ( // Stops a specified stack. Required Permissions: To use this action, an IAM user // must have a Manage permissions level for the stack, or an attached policy that // explicitly grants permissions. For more information on user permissions, see -// Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) StopStack(ctx context.Context, params *StopStackInput, optFns ...func(*Options)) (*StopStackOutput, error) { if params == nil { params = &StopStackInput{} diff --git a/service/opsworks/api_op_TagResource.go b/service/opsworks/api_op_TagResource.go index 604cf975c57..0554d1f37df 100644 --- a/service/opsworks/api_op_TagResource.go +++ b/service/opsworks/api_op_TagResource.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. -// For more information about how tagging works, see Tags -// (https://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html) in the AWS -// OpsWorks User Guide. +// Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks +// Stacks. For more information about how tagging works, see Tags (https://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html) +// in the AWS OpsWorks User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -38,22 +37,15 @@ type TagResourceInput struct { // A map that contains tag keys and tag values that are attached to a stack or // layer. - // - // * The key cannot be empty. - // - // * The key can be a maximum of 127 - // characters, and can contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * The value can be a maximum 255 - // characters, and contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * Leading and trailing white spaces - // are trimmed from both the key and value. - // - // * A maximum of 40 tags is allowed for - // any resource. + // - The key cannot be empty. + // - The key can be a maximum of 127 characters, and can contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - The value can be a maximum 255 characters, and contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - Leading and trailing white spaces are trimmed from both the key and value. + // - A maximum of 40 tags is allowed for any resource. // // This member is required. Tags map[string]string diff --git a/service/opsworks/api_op_UnassignInstance.go b/service/opsworks/api_op_UnassignInstance.go index 8dd814ed900..d6425667eb2 100644 --- a/service/opsworks/api_op_UnassignInstance.go +++ b/service/opsworks/api_op_UnassignInstance.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Unassigns a registered instance from all layers that are using the instance. The -// instance remains in the stack as an unassigned instance, and can be assigned to -// another layer as needed. You cannot use this action with instances that were +// Unassigns a registered instance from all layers that are using the instance. +// The instance remains in the stack as an unassigned instance, and can be assigned +// to another layer as needed. You cannot use this action with instances that were // created with AWS OpsWorks Stacks. Required Permissions: To use this action, an // IAM user must have a Manage permissions level for the stack or an attached // policy that explicitly grants permissions. For more information about user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UnassignInstance(ctx context.Context, params *UnassignInstanceInput, optFns ...func(*Options)) (*UnassignInstanceOutput, error) { if params == nil { params = &UnassignInstanceInput{} diff --git a/service/opsworks/api_op_UnassignVolume.go b/service/opsworks/api_op_UnassignVolume.go index 3b95291b82b..008413a94e0 100644 --- a/service/opsworks/api_op_UnassignVolume.go +++ b/service/opsworks/api_op_UnassignVolume.go @@ -11,12 +11,12 @@ import ( ) // Unassigns an assigned Amazon EBS volume. The volume remains registered with the -// stack. For more information, see Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// stack. For more information, see Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UnassignVolume(ctx context.Context, params *UnassignVolumeInput, optFns ...func(*Options)) (*UnassignVolumeOutput, error) { if params == nil { params = &UnassignVolumeInput{} diff --git a/service/opsworks/api_op_UpdateApp.go b/service/opsworks/api_op_UpdateApp.go index f2e3d1d5707..866a7d81106 100644 --- a/service/opsworks/api_op_UpdateApp.go +++ b/service/opsworks/api_op_UpdateApp.go @@ -14,8 +14,8 @@ import ( // Updates a specified app. Required Permissions: To use this action, an IAM user // must have a Deploy or Manage permissions level for the stack, or an attached // policy that explicitly grants permissions. For more information on user -// permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error) { if params == nil { params = &UpdateAppInput{} @@ -57,13 +57,12 @@ type UpdateAppInput struct { // Whether SSL is enabled for the app. EnableSsl *bool - // An array of EnvironmentVariable objects that specify environment variables to be - // associated with the app. After you deploy the app, these variables are defined - // on the associated app server instances.For more information, see Environment - // Variables - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). - // There is no specific limit on the number of environment variables. However, the - // size of the associated data structure - which includes the variables' names, + // An array of EnvironmentVariable objects that specify environment variables to + // be associated with the app. After you deploy the app, these variables are + // defined on the associated app server instances.For more information, see + // Environment Variables (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) + // . There is no specific limit on the number of environment variables. However, + // the size of the associated data structure - which includes the variables' names, // values, and protected flag values - cannot exceed 20 KB. This limit should // accommodate most if not all use cases. Exceeding it will cause an exception with // the message, "Environment: is too large (maximum is 20 KB)." If you have diff --git a/service/opsworks/api_op_UpdateElasticIp.go b/service/opsworks/api_op_UpdateElasticIp.go index e655c7cc290..0b48bd5d86e 100644 --- a/service/opsworks/api_op_UpdateElasticIp.go +++ b/service/opsworks/api_op_UpdateElasticIp.go @@ -11,12 +11,12 @@ import ( ) // Updates a registered Elastic IP address's name. For more information, see -// Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateElasticIp(ctx context.Context, params *UpdateElasticIpInput, optFns ...func(*Options)) (*UpdateElasticIpOutput, error) { if params == nil { params = &UpdateElasticIpInput{} diff --git a/service/opsworks/api_op_UpdateInstance.go b/service/opsworks/api_op_UpdateInstance.go index 692bd1627b0..3d41292a9a4 100644 --- a/service/opsworks/api_op_UpdateInstance.go +++ b/service/opsworks/api_op_UpdateInstance.go @@ -14,8 +14,8 @@ import ( // Updates a specified instance. Required Permissions: To use this action, an IAM // user must have a Manage permissions level for the stack, or an attached policy // that explicitly grants permissions. For more information on user permissions, -// see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateInstance(ctx context.Context, params *UpdateInstanceInput, optFns ...func(*Options)) (*UpdateInstanceOutput, error) { if params == nil { params = &UpdateInstanceInput{} @@ -38,21 +38,16 @@ type UpdateInstanceInput struct { // This member is required. InstanceId *string - // The default AWS OpsWorks Stacks agent version. You have the following - // options: - // - // * INHERIT - Use the stack's default agent version setting. - // - // * - // version_number - Use the specified agent version. This value overrides the - // stack's default setting. To update the agent version, you must edit the instance - // configuration and specify a new version. AWS OpsWorks Stacks then automatically - // installs that version on the instance. - // - // The default setting is INHERIT. To - // specify an agent version, you must use the complete version number, not the - // abbreviated number shown on the console. For a list of available agent version - // numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. + // The default AWS OpsWorks Stacks agent version. You have the following options: + // - INHERIT - Use the stack's default agent version setting. + // - version_number - Use the specified agent version. This value overrides the + // stack's default setting. To update the agent version, you must edit the instance + // configuration and specify a new version. AWS OpsWorks Stacks then automatically + // installs that version on the instance. + // The default setting is INHERIT . To specify an agent version, you must use the + // complete version number, not the abbreviated number shown on the console. For a + // list of available agent version numbers, call DescribeAgentVersions . + // AgentVersion cannot be set to Chef 12.2. AgentVersion *string // The ID of the AMI that was used to create the instance. The value of this @@ -63,8 +58,8 @@ type UpdateInstanceInput struct { // The instance architecture. Instance types do not necessarily support both // architectures. For a list of the architectures that are supported by the - // different instance types, see Instance Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). + // different instance types, see Instance Families and Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // . Architecture types.Architecture // For load-based or time-based instances, the type. Windows stacks can use only @@ -77,22 +72,21 @@ type UpdateInstanceInput struct { // The instance host name. Hostname *string - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // to run the update_dependencies stack command or by manually running yum (Amazon - // Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the - // default value of true, to ensure that your instances have the latest security - // updates. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . To control when updates are installed, set + // this value to false . You must then update your instances manually by using + // CreateDeployment to run the update_dependencies stack command or by manually + // running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly + // recommend using the default value of true , to ensure that your instances have + // the latest security updates. InstallUpdatesOnBoot *bool - // The instance type, such as t2.micro. For a list of supported instance types, + // The instance type, such as t2.micro . For a list of supported instance types, // open the stack in the console, choose Instances, and choose + Instance. The Size // list contains the currently supported types. For more information, see Instance - // Families and Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). The - // parameter values that you use to specify the various types are in the API Name - // column of the Available Instance Types table. + // Families and Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // . The parameter values that you use to specify the various types are in the API + // Name column of the Available Instance Types table. InstanceType *string // The instance's layer IDs. @@ -100,38 +94,27 @@ type UpdateInstanceInput struct { // The instance's operating system, which must be set to one of the following. You // cannot update an instance that is using a custom AMI. - // - // * A supported Linux - // operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon - // Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, - // Amazon Linux 2015.09, or Amazon Linux 2015.03. - // - // * A supported Ubuntu operating - // system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS. - // - // * - // CentOS Linux 7 - // - // * Red Hat Enterprise Linux 7 - // - // * A supported Windows operating - // system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server - // 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL - // Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web. - // - // For - // more information about supported operating systems, see AWS OpsWorks Stacks - // Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). - // The default option is the current Amazon Linux version. If you set this - // parameter to Custom, you must use the AmiId parameter to specify the custom AMI + // - A supported Linux operating system: An Amazon Linux version, such as Amazon + // Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux + // 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux + // 2015.03 . + // - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu + // 14.04 LTS , or Ubuntu 12.04 LTS . + // - CentOS Linux 7 + // - Red Hat Enterprise Linux 7 + // - A supported Windows operating system, such as Microsoft Windows Server 2012 + // R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , + // Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft + // Windows Server 2012 R2 with SQL Server Web . + // For more information about supported operating systems, see AWS OpsWorks Stacks + // Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . The default option is the current Amazon Linux version. If you set this + // parameter to Custom , you must use the AmiId parameter to specify the custom AMI // that you want to use. For more information about supported operating systems, - // see Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). - // For more information about how to use custom AMIs with OpsWorks, see Using - // Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // You can specify a different Linux operating system for the updated stack, but + // see Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . For more information about how to use custom AMIs with OpsWorks, see Using + // Custom AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . You can specify a different Linux operating system for the updated stack, but // you cannot change from Linux to Windows or Windows to Linux. Os *string diff --git a/service/opsworks/api_op_UpdateLayer.go b/service/opsworks/api_op_UpdateLayer.go index 4f392e38b5d..b992a4a895f 100644 --- a/service/opsworks/api_op_UpdateLayer.go +++ b/service/opsworks/api_op_UpdateLayer.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a specified layer. Required Permissions: To use this action, an IAM user -// must have a Manage permissions level for the stack, or an attached policy that -// explicitly grants permissions. For more information on user permissions, see -// Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Updates a specified layer. Required Permissions: To use this action, an IAM +// user must have a Manage permissions level for the stack, or an attached policy +// that explicitly grants permissions. For more information on user permissions, +// see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateLayer(ctx context.Context, params *UpdateLayerInput, optFns ...func(*Options)) (*UpdateLayerOutput, error) { if params == nil { params = &UpdateLayerInput{} @@ -41,31 +41,30 @@ type UpdateLayerInput struct { // One or more user-defined key/value pairs to be added to the stack attributes. Attributes map[string]string - // Whether to automatically assign an Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // to the layer's instances. For more information, see How to Edit a Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Whether to automatically assign an Elastic IP address (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // to the layer's instances. For more information, see How to Edit a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignElasticIps *bool // For stacks that are running in a VPC, whether to automatically assign a public // IP address to the layer's instances. For more information, see How to Edit a - // Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignPublicIps *bool // Specifies CloudWatch Logs configuration options for the layer. For more - // information, see CloudWatchLogsLogStream. + // information, see CloudWatchLogsLogStream . CloudWatchLogsConfiguration *types.CloudWatchLogsConfiguration // The ARN of an IAM profile to be used for all of the layer's EC2 instances. For - // more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . CustomInstanceProfileArn *string // A JSON-formatted string containing custom stack configuration and deployment // attributes to be installed on the layer's instances. For more information, see - // Using Custom JSON - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html). + // Using Custom JSON (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html) + // . CustomJson *string // A LayerCustomRecipes object that specifies the layer's custom recipes. @@ -77,13 +76,13 @@ type UpdateLayerInput struct { // Whether to disable auto healing for the layer. EnableAutoHealing *bool - // Whether to install operating system and package updates when the instance boots. - // The default value is true. To control when updates are installed, set this value - // to false. You must then update your instances manually by using CreateDeployment - // to run the update_dependencies stack command or manually running yum (Amazon - // Linux) or apt-get (Ubuntu) on the instances. We strongly recommend using the - // default value of true, to ensure that your instances have the latest security - // updates. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . To control when updates are installed, set + // this value to false . You must then update your instances manually by using + // CreateDeployment to run the update_dependencies stack command or manually + // running yum (Amazon Linux) or apt-get (Ubuntu) on the instances. We strongly + // recommend using the default value of true , to ensure that your instances have + // the latest security updates. InstallUpdatesOnBoot *bool // @@ -100,8 +99,7 @@ type UpdateLayerInput struct { // also used as the name for the directory where your app files are installed. It // can have a maximum of 200 characters and must be in the following format: // /\A[a-z0-9\-\_\.]+\Z/. The built-in layers' short names are defined by AWS - // OpsWorks Stacks. For more information, see the Layer Reference - // (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) + // OpsWorks Stacks. For more information, see the Layer Reference (https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) Shortname *string // Whether to use Amazon EBS-optimized instances. diff --git a/service/opsworks/api_op_UpdateMyUserProfile.go b/service/opsworks/api_op_UpdateMyUserProfile.go index a6d22ccf278..39132a58507 100644 --- a/service/opsworks/api_op_UpdateMyUserProfile.go +++ b/service/opsworks/api_op_UpdateMyUserProfile.go @@ -13,8 +13,8 @@ import ( // Updates a user's SSH public key. Required Permissions: To use this action, an // IAM user must have self-management enabled or an attached policy that explicitly // grants permissions. For more information about user permissions, see Managing -// User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateMyUserProfile(ctx context.Context, params *UpdateMyUserProfileInput, optFns ...func(*Options)) (*UpdateMyUserProfileOutput, error) { if params == nil { params = &UpdateMyUserProfileInput{} diff --git a/service/opsworks/api_op_UpdateRdsDbInstance.go b/service/opsworks/api_op_UpdateRdsDbInstance.go index d9e27496faf..49c8e6f95bf 100644 --- a/service/opsworks/api_op_UpdateRdsDbInstance.go +++ b/service/opsworks/api_op_UpdateRdsDbInstance.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an Amazon RDS instance. Required Permissions: To use this action, an IAM -// user must have a Manage permissions level for the stack, or an attached policy -// that explicitly grants permissions. For more information on user permissions, -// see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Updates an Amazon RDS instance. Required Permissions: To use this action, an +// IAM user must have a Manage permissions level for the stack, or an attached +// policy that explicitly grants permissions. For more information on user +// permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateRdsDbInstance(ctx context.Context, params *UpdateRdsDbInstanceInput, optFns ...func(*Options)) (*UpdateRdsDbInstanceOutput, error) { if params == nil { params = &UpdateRdsDbInstanceInput{} diff --git a/service/opsworks/api_op_UpdateStack.go b/service/opsworks/api_op_UpdateStack.go index c4badc4d897..168ec320373 100644 --- a/service/opsworks/api_op_UpdateStack.go +++ b/service/opsworks/api_op_UpdateStack.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a specified stack. Required Permissions: To use this action, an IAM user -// must have a Manage permissions level for the stack, or an attached policy that -// explicitly grants permissions. For more information on user permissions, see -// Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Updates a specified stack. Required Permissions: To use this action, an IAM +// user must have a Manage permissions level for the stack, or an attached policy +// that explicitly grants permissions. For more information on user permissions, +// see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error) { if params == nil { params = &UpdateStackInput{} @@ -38,24 +38,20 @@ type UpdateStackInput struct { // This member is required. StackId *string - // The default AWS OpsWorks Stacks agent version. You have the following - // options: - // - // * Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks - // automatically installs new agent versions on the stack's instances as soon as - // they are available. - // - // * Fixed version - Set this parameter to your preferred - // agent version. To update the agent version, you must edit the stack - // configuration and specify a new version. AWS OpsWorks Stacks then automatically - // installs that version on the stack's instances. - // - // The default setting is LATEST. - // To specify an agent version, you must use the complete version number, not the - // abbreviated number shown on the console. For a list of available agent version - // numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2. - // You can also specify an agent version when you create or update an instance, - // which overrides the stack's default setting. + // The default AWS OpsWorks Stacks agent version. You have the following options: + // - Auto-update - Set this parameter to LATEST . AWS OpsWorks Stacks + // automatically installs new agent versions on the stack's instances as soon as + // they are available. + // - Fixed version - Set this parameter to your preferred agent version. To + // update the agent version, you must edit the stack configuration and specify a + // new version. AWS OpsWorks Stacks then automatically installs that version on the + // stack's instances. + // The default setting is LATEST . To specify an agent version, you must use the + // complete version number, not the abbreviated number shown on the console. For a + // list of available agent version numbers, call DescribeAgentVersions . + // AgentVersion cannot be set to Chef 12.2. You can also specify an agent version + // when you create or update an instance, which overrides the stack's default + // setting. AgentVersion *string // One or more user-defined key-value pairs to be added to the stack attributes. @@ -63,8 +59,8 @@ type UpdateStackInput struct { // A ChefConfiguration object that specifies whether to enable Berkshelf and the // Berkshelf version on Chef 11.10 stacks. For more information, see Create a New - // Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . ChefConfiguration *types.ChefConfiguration // The configuration manager. When you update a stack, we recommend that you use @@ -74,123 +70,94 @@ type UpdateStackInput struct { ConfigurationManager *types.StackConfigurationManager // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + // repository. For more information, see Adding Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) + // . CustomCookbooksSource *types.Source - // A string that contains user-defined, custom JSON. It can be used to override the - // corresponding default stack configuration JSON values or to pass data to + // A string that contains user-defined, custom JSON. It can be used to override + // the corresponding default stack configuration JSON values or to pass data to // recipes. The string should be in the following format: "{\"key1\": \"value1\", // \"key2\": \"value2\",...}" For more information about custom JSON, see Use - // Custom JSON to Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). + // Custom JSON to Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // . CustomJson *string // The stack's default Availability Zone, which must be in the stack's region. For - // more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify - // a value for DefaultSubnetId, the subnet must be in the same zone. For more - // information, see CreateStack. + // more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . If you also specify a value for DefaultSubnetId , the subnet must be in the + // same zone. For more information, see CreateStack . DefaultAvailabilityZone *string - // The ARN of an IAM profile that is the default profile for all of the stack's EC2 - // instances. For more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // The ARN of an IAM profile that is the default profile for all of the stack's + // EC2 instances. For more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . DefaultInstanceProfileArn *string // The stack's operating system, which must be set to one of the following: - // - // * A - // supported Linux operating system: An Amazon Linux version, such as Amazon Linux - // 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, - // Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03. - // - // * A - // supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, - // or Ubuntu 12.04 LTS. - // - // * CentOS Linux 7 - // - // * Red Hat Enterprise Linux 7 - // - // * A - // supported Windows operating system, such as Microsoft Windows Server 2012 R2 - // Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft - // Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server - // 2012 R2 with SQL Server Web. - // - // * A custom AMI: Custom. You specify the custom AMI - // you want to use when you create instances. For more information about how to use - // custom AMIs with OpsWorks, see Using Custom AMIs - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html). - // - // The - // default option is the stack's current operating system. For more information - // about supported operating systems, see AWS OpsWorks Stacks Operating Systems - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html). + // - A supported Linux operating system: An Amazon Linux version, such as Amazon + // Linux 2018.03 , Amazon Linux 2017.09 , Amazon Linux 2017.03 , Amazon Linux + // 2016.09 , Amazon Linux 2016.03 , Amazon Linux 2015.09 , or Amazon Linux + // 2015.03 . + // - A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu + // 14.04 LTS , or Ubuntu 12.04 LTS . + // - CentOS Linux 7 + // - Red Hat Enterprise Linux 7 + // - A supported Windows operating system, such as Microsoft Windows Server 2012 + // R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , + // Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft + // Windows Server 2012 R2 with SQL Server Web . + // - A custom AMI: Custom . You specify the custom AMI you want to use when you + // create instances. For more information about how to use custom AMIs with + // OpsWorks, see Using Custom AMIs (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // . + // The default option is the stack's current operating system. For more + // information about supported operating systems, see AWS OpsWorks Stacks + // Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) + // . DefaultOs *string - // The default root device type. This value is used by default for all instances in - // the stack, but you can override it when you create an instance. For more - // information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // The default root device type. This value is used by default for all instances + // in the stack, but you can override it when you create an instance. For more + // information, see Storage for the Root Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . DefaultRootDeviceType types.RootDeviceType - // A default Amazon EC2 key-pair name. The default value is none. If you specify a + // A default Amazon EC2 key-pair name. The default value is none . If you specify a // key-pair name, AWS OpsWorks Stacks installs the public key on the instance and // you can use the private key with an SSH client to log in to the instance. For - // more information, see Using SSH to Communicate with an Instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) - // and Managing SSH Access - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). - // You can override this setting by specifying a different key pair, or no key - // pair, when you create an instance - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html). + // more information, see Using SSH to Communicate with an Instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) + // and Managing SSH Access (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html) + // . You can override this setting by specifying a different key pair, or no key + // pair, when you create an instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html) + // . DefaultSshKeyName *string // The stack's default VPC subnet ID. This parameter is required if you specify a // value for the VpcId parameter. All instances are launched into this subnet // unless you specify otherwise when you create the instance. If you also specify a - // value for DefaultAvailabilityZone, the subnet must be in that zone. For + // value for DefaultAvailabilityZone , the subnet must be in that zone. For // information on default values and when this parameter is required, see the VpcId // parameter description. DefaultSubnetId *string // The stack's new host name theme, with spaces replaced by underscores. The theme // is used to generate host names for the stack's instances. By default, - // HostnameTheme is set to Layer_Dependent, which creates host names by appending + // HostnameTheme is set to Layer_Dependent , which creates host names by appending // integers to the layer's short name. The other themes are: - // - // * Baked_Goods - // - // * - // Clouds - // - // * Europe_Cities - // - // * Fruits - // - // * Greek_Deities_and_Titans - // - // * - // Legendary_creatures_from_Japan - // - // * Planets_and_Moons - // - // * Roman_Deities - // - // * - // Scottish_Islands - // - // * US_Cities - // - // * Wild_Cats - // - // To obtain a generated host name, - // call GetHostNameSuggestion, which returns a host name based on the current - // theme. + // - Baked_Goods + // - Clouds + // - Europe_Cities + // - Fruits + // - Greek_Deities_and_Titans + // - Legendary_creatures_from_Japan + // - Planets_and_Moons + // - Roman_Deities + // - Scottish_Islands + // - US_Cities + // - Wild_Cats + // To obtain a generated host name, call GetHostNameSuggestion , which returns a + // host name based on the current theme. HostnameTheme *string // The stack's new name. @@ -208,21 +175,17 @@ type UpdateStackInput struct { // UseOpsworksSecurityGroups allows you to provide your own custom security groups // instead of using the built-in groups. UseOpsworksSecurityGroups has the // following settings: - // - // * True - AWS OpsWorks Stacks automatically associates the - // appropriate built-in security group with each layer (default setting). You can - // associate additional security groups with a layer after you create it, but you - // cannot delete the built-in security group. - // - // * False - AWS OpsWorks Stacks does - // not associate built-in security groups with layers. You must create appropriate - // EC2 security groups and associate a security group with each layer that you - // create. However, you can still manually associate a built-in security group with - // a layer on. Custom security groups are required only for those layers that need - // custom settings. - // - // For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // - True - AWS OpsWorks Stacks automatically associates the appropriate + // built-in security group with each layer (default setting). You can associate + // additional security groups with a layer after you create it, but you cannot + // delete the built-in security group. + // - False - AWS OpsWorks Stacks does not associate built-in security groups + // with layers. You must create appropriate EC2 security groups and associate a + // security group with each layer that you create. However, you can still manually + // associate a built-in security group with a layer on. Custom security groups are + // required only for those layers that need custom settings. + // For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . UseOpsworksSecurityGroups *bool noSmithyDocumentSerde diff --git a/service/opsworks/api_op_UpdateUserProfile.go b/service/opsworks/api_op_UpdateUserProfile.go index c8df33ccf68..5db7f0090bb 100644 --- a/service/opsworks/api_op_UpdateUserProfile.go +++ b/service/opsworks/api_op_UpdateUserProfile.go @@ -12,8 +12,8 @@ import ( // Updates a specified user profile. Required Permissions: To use this action, an // IAM user must have an attached policy that explicitly grants permissions. For -// more information about user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// more information about user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateUserProfile(ctx context.Context, params *UpdateUserProfileInput, optFns ...func(*Options)) (*UpdateUserProfileOutput, error) { if params == nil { params = &UpdateUserProfileInput{} @@ -36,19 +36,19 @@ type UpdateUserProfileInput struct { // This member is required. IamUserArn *string - // Whether users can specify their own SSH public key through the My Settings page. - // For more information, see Managing User Permissions - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). + // Whether users can specify their own SSH public key through the My Settings + // page. For more information, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html) + // . AllowSelfManagement *bool // The user's new SSH public key. SshPublicKey *string - // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', - // and '_'. If the specified name includes other punctuation marks, AWS OpsWorks - // Stacks removes them. For example, my.name will be changed to myname. If you do - // not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM - // user name. + // The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], + // '-', and '_'. If the specified name includes other punctuation marks, AWS + // OpsWorks Stacks removes them. For example, my.name will be changed to myname . + // If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from + // the IAM user name. SshUsername *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_UpdateVolume.go b/service/opsworks/api_op_UpdateVolume.go index 1f95ba4a1f3..410e2c8bf6d 100644 --- a/service/opsworks/api_op_UpdateVolume.go +++ b/service/opsworks/api_op_UpdateVolume.go @@ -11,12 +11,12 @@ import ( ) // Updates an Amazon EBS volume's name or mount point. For more information, see -// Resource Management -// (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html). Required -// Permissions: To use this action, an IAM user must have a Manage permissions -// level for the stack, or an attached policy that explicitly grants permissions. -// For more information on user permissions, see Managing User Permissions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html). +// Resource Management (https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html) +// . Required Permissions: To use this action, an IAM user must have a Manage +// permissions level for the stack, or an attached policy that explicitly grants +// permissions. For more information on user permissions, see Managing User +// Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) +// . func (c *Client) UpdateVolume(ctx context.Context, params *UpdateVolumeInput, optFns ...func(*Options)) (*UpdateVolumeOutput, error) { if params == nil { params = &UpdateVolumeInput{} diff --git a/service/opsworks/doc.go b/service/opsworks/doc.go index 29ae0b8ccad..5450eb434cf 100644 --- a/service/opsworks/doc.go +++ b/service/opsworks/doc.go @@ -13,81 +13,38 @@ // API is by using the AWS Command Line Interface (CLI) or by using one of the AWS // SDKs to implement applications in your preferred language. For more information, // see: -// -// * AWS CLI -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) -// -// * AWS -// SDK for Java -// (https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html) -// -// * -// AWS SDK for .NET -// (https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm) -// -// * -// AWS SDK for PHP 2 -// (https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html) -// -// * -// AWS SDK for Ruby (http://docs.aws.amazon.com/sdkforruby/api/) -// -// * AWS SDK for -// Node.js (http://aws.amazon.com/documentation/sdkforjavascript/) -// -// * AWS SDK for -// Python(Boto) (http://docs.pythonboto.org/en/latest/ref/opsworks.html) -// -// Endpoints -// AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must -// connect to one of the following endpoints. Stacks can only be accessed or +// - AWS CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) +// - AWS SDK for Java (https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html) +// - AWS SDK for .NET (https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm) +// - AWS SDK for PHP 2 (https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html) +// - AWS SDK for Ruby (http://docs.aws.amazon.com/sdkforruby/api/) +// - AWS SDK for Node.js (http://aws.amazon.com/documentation/sdkforjavascript/) +// - AWS SDK for Python(Boto) (http://docs.pythonboto.org/en/latest/ref/opsworks.html) +// +// Endpoints AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You +// must connect to one of the following endpoints. Stacks can only be accessed or // managed within the endpoint in which they are created. -// -// * -// opsworks.us-east-1.amazonaws.com -// -// * opsworks.us-east-2.amazonaws.com -// -// * -// opsworks.us-west-1.amazonaws.com -// -// * opsworks.us-west-2.amazonaws.com -// -// * -// opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS -// console) -// -// * opsworks.eu-west-1.amazonaws.com -// -// * -// opsworks.eu-west-2.amazonaws.com -// -// * opsworks.eu-west-3.amazonaws.com -// -// * -// opsworks.eu-central-1.amazonaws.com -// -// * opsworks.ap-northeast-1.amazonaws.com -// -// * -// opsworks.ap-northeast-2.amazonaws.com -// -// * opsworks.ap-south-1.amazonaws.com -// -// * -// opsworks.ap-southeast-1.amazonaws.com -// -// * -// opsworks.ap-southeast-2.amazonaws.com -// -// * opsworks.sa-east-1.amazonaws.com -// -// Chef -// Versions When you call CreateStack, CloneStack, or UpdateStack we recommend you -// use the ConfigurationManager parameter to specify the Chef version. The -// recommended and default value for Linux stacks is currently 12. Windows stacks -// use Chef 12.2. For more information, see Chef Versions -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html). -// You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend +// - opsworks.us-east-1.amazonaws.com +// - opsworks.us-east-2.amazonaws.com +// - opsworks.us-west-1.amazonaws.com +// - opsworks.us-west-2.amazonaws.com +// - opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS +// console) +// - opsworks.eu-west-1.amazonaws.com +// - opsworks.eu-west-2.amazonaws.com +// - opsworks.eu-west-3.amazonaws.com +// - opsworks.eu-central-1.amazonaws.com +// - opsworks.ap-northeast-1.amazonaws.com +// - opsworks.ap-northeast-2.amazonaws.com +// - opsworks.ap-south-1.amazonaws.com +// - opsworks.ap-southeast-1.amazonaws.com +// - opsworks.ap-southeast-2.amazonaws.com +// - opsworks.sa-east-1.amazonaws.com +// +// Chef Versions When you call CreateStack , CloneStack , or UpdateStack we +// recommend you use the ConfigurationManager parameter to specify the Chef +// version. The recommended and default value for Linux stacks is currently 12. +// Windows stacks use Chef 12.2. For more information, see Chef Versions (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html) +// . You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend // migrating your existing Linux stacks to Chef 12 as soon as possible. package opsworks diff --git a/service/opsworks/types/enums.go b/service/opsworks/types/enums.go index 48ed342d629..78a260f0c99 100644 --- a/service/opsworks/types/enums.go +++ b/service/opsworks/types/enums.go @@ -60,9 +60,9 @@ const ( ArchitectureI386 Architecture = "i386" ) -// Values returns all known values for Architecture. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Architecture. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Architecture) Values() []Architecture { return []Architecture{ "x86_64", @@ -341,8 +341,8 @@ const ( DeploymentCommandNameUndeploy DeploymentCommandName = "undeploy" ) -// Values returns all known values for DeploymentCommandName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DeploymentCommandName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DeploymentCommandName) Values() []DeploymentCommandName { return []DeploymentCommandName{ @@ -443,9 +443,9 @@ const ( LayerTypeCustom LayerType = "custom" ) -// Values returns all known values for LayerType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LayerType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LayerType) Values() []LayerType { return []LayerType{ "aws-flow-ruby", diff --git a/service/opsworks/types/types.go b/service/opsworks/types/types.go index a2f7c0d3bc1..64a813763dc 100644 --- a/service/opsworks/types/types.go +++ b/service/opsworks/types/types.go @@ -46,13 +46,12 @@ type App struct { // Whether to enable SSL for the app. EnableSsl *bool - // An array of EnvironmentVariable objects that specify environment variables to be - // associated with the app. After you deploy the app, these variables are defined - // on the associated app server instances. For more information, see Environment - // Variables - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment). - // There is no specific limit on the number of environment variables. However, the - // size of the associated data structure - which includes the variable names, + // An array of EnvironmentVariable objects that specify environment variables to + // be associated with the app. After you deploy the app, these variables are + // defined on the associated app server instances. For more information, see + // Environment Variables (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) + // . There is no specific limit on the number of environment variables. However, + // the size of the associated data structure - which includes the variable names, // values, and protected flag values - cannot exceed 20 KB. This limit should // accommodate most if not all use cases, but if you do exceed it, you will cause // an exception (API) with an "Environment: is too large (maximum is 20 KB)" @@ -85,11 +84,11 @@ type AutoScalingThresholds struct { // Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter // takes a list of up to five alarm names, which are case sensitive and must be in // the same region as the stack. To use custom alarms, you must update your service - // role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks - // update the role for you when you first use this feature or you can edit the role - // manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your - // Behalf - // (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html). + // role to allow cloudwatch:DescribeAlarms . You can either have AWS OpsWorks + // Stacks update the role for you when you first use this feature or you can edit + // the role manually. For more information, see Allowing AWS OpsWorks Stacks to + // Act on Your Behalf (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html) + // . Alarms []string // The CPU utilization threshold, as a percent of the available CPU. A value of -1 @@ -110,8 +109,8 @@ type AutoScalingThresholds struct { InstanceCount *int32 // The load threshold. A value of -1 disables the threshold. For more information - // about how load is computed, see Load (computing) - // (http://en.wikipedia.org/wiki/Load_%28computing%29). + // about how load is computed, see Load (computing) (http://en.wikipedia.org/wiki/Load_%28computing%29) + // . LoadThreshold *float64 // The memory utilization threshold, as a percent of the available memory. A value @@ -125,13 +124,12 @@ type AutoScalingThresholds struct { noSmithyDocumentSerde } -// Describes a block device mapping. This data type maps directly to the Amazon EC2 -// BlockDeviceMapping -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) +// Describes a block device mapping. This data type maps directly to the Amazon +// EC2 BlockDeviceMapping (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) // data type. type BlockDeviceMapping struct { - // The device name that is exposed to the instance, such as /dev/sdh. For the root + // The device name that is exposed to the instance, such as /dev/sdh . For the root // device, you can use the explicit device name or you can set this parameter to // ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name. DeviceName *string @@ -143,8 +141,8 @@ type BlockDeviceMapping struct { // Suppresses the specified device included in the AMI's block device mapping. NoDevice *string - // The virtual device name. For more information, see BlockDeviceMapping - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html). + // The virtual device name. For more information, see BlockDeviceMapping (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) + // . VirtualName *string noSmithyDocumentSerde @@ -176,8 +174,8 @@ type CloudWatchLogsConfiguration struct { // Describes the Amazon CloudWatch logs configuration for a layer. For detailed // information about members of this data type, see the CloudWatch Logs Agent -// Reference -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). +// Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html) +// . type CloudWatchLogsLogStream struct { // Specifies the max number of log events in a batch, up to 10000. The default @@ -189,28 +187,28 @@ type CloudWatchLogsLogStream struct { // all event messages in UTF-8, plus 26 bytes for each log event. BatchSize *int32 - // Specifies the time duration for the batching of log events. The minimum value is - // 5000ms and default value is 5000ms. + // Specifies the time duration for the batching of log events. The minimum value + // is 5000ms and default value is 5000ms. BufferDuration *int32 // Specifies how the time stamp is extracted from logs. For more information, see - // the CloudWatch Logs Agent Reference - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). + // the CloudWatch Logs Agent Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html) + // . DatetimeFormat *string // Specifies the encoding of the log file so that the file can be read correctly. - // The default is utf_8. Encodings supported by Python codecs.decode() can be used - // here. + // The default is utf_8 . Encodings supported by Python codecs.decode() can be + // used here. Encoding CloudWatchLogsEncoding // Specifies log files that you want to push to CloudWatch Logs. File can point to // a specific file or multiple files (by using wild card characters such as - // /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based + // /var/log/system.log* ). Only the latest file is pushed to CloudWatch Logs, based // on file modification time. We recommend that you use wild card characters to - // specify a series of files of the same type, such as access_log.2014-06-01-01, - // access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't - // use a wildcard to match multiple file types, such as access_log_80 and - // access_log_443. To specify multiple, different file types, add another log + // specify a series of files of the same type, such as access_log.2014-06-01-01 , + // access_log.2014-06-01-02 , and so on by using a pattern like access_log.* . + // Don't use a wildcard to match multiple file types, such as access_log_80 and + // access_log_443 . To specify multiple, different file types, add another log // stream entry to the configuration file, so that each log file type is stored in // a different log group. Zipped files are not supported. File *string @@ -269,43 +267,25 @@ type Command struct { LogUrl *string // The command status: - // - // * failed - // - // * successful - // - // * skipped - // - // * pending + // - failed + // - successful + // - skipped + // - pending Status *string // The command type: - // - // * configure - // - // * deploy - // - // * execute_recipes - // - // * - // install_dependencies - // - // * restart - // - // * rollback - // - // * setup - // - // * start - // - // * stop - // - // * - // undeploy - // - // * update_custom_cookbooks - // - // * update_dependencies + // - configure + // - deploy + // - execute_recipes + // - install_dependencies + // - restart + // - rollback + // - setup + // - start + // - stop + // - undeploy + // - update_custom_cookbooks + // - update_dependencies Type *string noSmithyDocumentSerde @@ -320,8 +300,8 @@ type DataSource struct { // The database name. DatabaseName *string - // The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, - // RdsDbInstance, or None. + // The data source's type, AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance + // , RdsDbInstance , or None . Type *string noSmithyDocumentSerde @@ -349,8 +329,8 @@ type Deployment struct { // corresponding default stack configuration attribute values for stack or to pass // data to recipes. The string should be in the following format: "{\"key1\": // \"value1\", \"key2\": \"value2\",...}" For more information on custom JSON, see - // Use Custom JSON to Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). + // Use Custom JSON to Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // . CustomJson *string // The deployment ID. @@ -369,12 +349,9 @@ type Deployment struct { StackId *string // The deployment status: - // - // * running - // - // * successful - // - // * failed + // - running + // - successful + // - failed Status *string noSmithyDocumentSerde @@ -385,44 +362,27 @@ type DeploymentCommand struct { // Specifies the operation. You can specify only one command. For stacks, the // following commands are available: - // - // * execute_recipes: Execute one or more - // recipes. To specify the recipes, set an Args parameter named recipes to the list - // of recipes to be executed. For example, to execute phpapp::appsetup, set Args to - // {"recipes":["phpapp::appsetup"]}. - // - // * install_dependencies: Install the stack's - // dependencies. - // - // * update_custom_cookbooks: Update the stack's custom - // cookbooks. - // - // * update_dependencies: Update the stack's dependencies. - // - // The - // update_dependencies and install_dependencies commands are supported only for - // Linux instances. You can run the commands successfully on Windows instances, but - // they do nothing. For apps, the following commands are available: - // - // * deploy: - // Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. - // Set Args to {"migrate":["true"]} to migrate the database. The default setting is - // {"migrate":["false"]}. - // - // * rollback Roll the app back to the previous version. - // When you update an app, AWS OpsWorks Stacks stores the previous version, up to a - // maximum of five versions. You can use this command to roll an app back as many - // as four versions. - // - // * start: Start the app's web or application server. - // - // * stop: - // Stop the app's web or application server. - // - // * restart: Restart the app's web or - // application server. - // - // * undeploy: Undeploy the app. + // - execute_recipes : Execute one or more recipes. To specify the recipes, set + // an Args parameter named recipes to the list of recipes to be executed. For + // example, to execute phpapp::appsetup , set Args to + // {"recipes":["phpapp::appsetup"]} . + // - install_dependencies : Install the stack's dependencies. + // - update_custom_cookbooks : Update the stack's custom cookbooks. + // - update_dependencies : Update the stack's dependencies. + // The update_dependencies and install_dependencies commands are supported only + // for Linux instances. You can run the commands successfully on Windows instances, + // but they do nothing. For apps, the following commands are available: + // - deploy : Deploy an app. Ruby on Rails apps have an optional Args parameter + // named migrate . Set Args to {"migrate":["true"]} to migrate the database. The + // default setting is {"migrate":["false"]}. + // - rollback Roll the app back to the previous version. When you update an app, + // AWS OpsWorks Stacks stores the previous version, up to a maximum of five + // versions. You can use this command to roll an app back as many as four versions. + // + // - start : Start the app's web or application server. + // - stop : Stop the app's web or application server. + // - restart : Restart the app's web or application server. + // - undeploy : Undeploy the app. // // This member is required. Name DeploymentCommandName @@ -431,27 +391,22 @@ type DeploymentCommand struct { // object with the following format: {"arg_name1" : ["value1", "value2", ...], // "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command // takes two arguments: - // - // * upgrade_os_to - Specifies the desired Amazon Linux - // version for instances whose OS you want to upgrade, such as Amazon Linux - // 2016.09. You must also set the allow_reboot argument to true. - // - // * allow_reboot - - // Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if - // necessary, after installing the updates. This argument can be set to either true - // or false. The default value is false. - // - // For example, to upgrade an instance to - // Amazon Linux 2016.09, set Args to the following. { "upgrade_os_to":["Amazon - // Linux 2016.09"], "allow_reboot":["true"] } + // - upgrade_os_to - Specifies the desired Amazon Linux version for instances + // whose OS you want to upgrade, such as Amazon Linux 2016.09 . You must also set + // the allow_reboot argument to true. + // - allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the + // instances if necessary, after installing the updates. This argument can be set + // to either true or false . The default value is false . + // For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the + // following. { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] + // } Args map[string][]string noSmithyDocumentSerde } // Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 -// EbsBlockDevice -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) +// EbsBlockDevice (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) // data type. type EbsBlockDevice struct { @@ -459,24 +414,24 @@ type EbsBlockDevice struct { DeleteOnTermination *bool // The number of I/O operations per second (IOPS) that the volume supports. For - // more information, see EbsBlockDevice - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html). + // more information, see EbsBlockDevice (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) + // . Iops *int32 // The snapshot ID. SnapshotId *string - // The volume size, in GiB. For more information, see EbsBlockDevice - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html). + // The volume size, in GiB. For more information, see EbsBlockDevice (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) + // . VolumeSize *int32 - // The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS - // (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold - // HDD,and standard for Magnetic volumes. If you specify the io1 volume type, you - // must also specify a value for the Iops attribute. The maximum ratio of - // provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default - // volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume - // size). + // The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned + // IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 + // for Cold HDD,and standard for Magnetic volumes. If you specify the io1 volume + // type, you must also specify a value for the Iops attribute. The maximum ratio + // of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the + // default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x + // (volume size). VolumeType VolumeType noSmithyDocumentSerde @@ -515,8 +470,8 @@ type ElasticIp struct { // The name. Name *string - // The AWS region. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // The AWS region. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . Region *string noSmithyDocumentSerde @@ -531,8 +486,8 @@ type ElasticLoadBalancer struct { // The instance's public DNS name. DnsName *string - // A list of the EC2 instances that the Elastic Load Balancing instance is managing - // traffic for. + // A list of the EC2 instances that the Elastic Load Balancing instance is + // managing traffic for. Ec2InstanceIds []string // The Elastic Load Balancing instance's name. @@ -575,9 +530,9 @@ type EnvironmentVariable struct { Value *string // (Optional) Whether the variable's value will be returned by the DescribeApps - // action. To conceal an environment variable's value, set Secure to true. + // action. To conceal an environment variable's value, set Secure to true . // DescribeApps then returns *****FILTERED***** instead of the actual value. The - // default value for Secure is false. + // default value for Secure is false . Secure *bool noSmithyDocumentSerde @@ -586,13 +541,12 @@ type EnvironmentVariable struct { // Describes an instance. type Instance struct { - // The agent version. This parameter is set to INHERIT if the instance inherits the - // default stack setting or to a a version number for a fixed agent version. + // The agent version. This parameter is set to INHERIT if the instance inherits + // the default stack setting or to a a version number for a fixed agent version. AgentVersion *string // A custom AMI ID to be used to create the instance. For more information, see - // Instances - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) + // Instances (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) AmiId *string // The instance architecture: "i386" or "x86_64". @@ -604,8 +558,8 @@ type Instance struct { // For load-based or time-based instances, the type. AutoScalingType AutoScalingType - // The instance Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // The instance Availability Zone. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . AvailabilityZone *string // An array of BlockDeviceMapping objects that specify the instance's block device @@ -627,37 +581,37 @@ type Instance struct { // For container instances, the instance's ARN. EcsContainerInstanceArn *string - // The instance Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html). + // The instance Elastic IP address (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // . ElasticIp *string // The instance host name. Hostname *string - // For registered instances, the infrastructure class: ec2 or on-premises. + // For registered instances, the infrastructure class: ec2 or on-premises . InfrastructureClass *string - // Whether to install operating system and package updates when the instance boots. - // The default value is true. If this value is set to false, you must then update - // your instances manually by using CreateDeployment to run the update_dependencies - // stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on - // the instances. We strongly recommend using the default value of true, to ensure - // that your instances have the latest security updates. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . If this value is set to false , you must then + // update your instances manually by using CreateDeployment to run the + // update_dependencies stack command or by manually running yum (Amazon Linux) or + // apt-get (Ubuntu) on the instances. We strongly recommend using the default value + // of true , to ensure that your instances have the latest security updates. InstallUpdatesOnBoot *bool // The instance ID. InstanceId *string // The ARN of the instance's IAM profile. For more information about IAM ARNs, see - // Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . InstanceProfileArn *string - // The instance type, such as t2.micro. + // The instance type, such as t2.micro . InstanceType *string // The ID of the last service error. For more information, call - // DescribeServiceErrors. + // DescribeServiceErrors . LastServiceErrorId *string // An array containing the instance layer IDs. @@ -691,8 +645,8 @@ type Instance struct { ReportedOs *ReportedOs // The instance's root device type. For more information, see Storage for the Root - // Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . RootDeviceType RootDeviceType // The root device volume ID. @@ -714,55 +668,38 @@ type Instance struct { StackId *string // The instance status: - // - // * booting - // - // * connection_lost - // - // * online - // - // * pending - // - // * - // rebooting - // - // * requested - // - // * running_setup - // - // * setup_failed - // - // * shutting_down - // - // * - // start_failed - // - // * stop_failed - // - // * stopped - // - // * stopping - // - // * terminated - // - // * terminating + // - booting + // - connection_lost + // - online + // - pending + // - rebooting + // - requested + // - running_setup + // - setup_failed + // - shutting_down + // - start_failed + // - stop_failed + // - stopped + // - stopping + // - terminated + // - terminating Status *string // The instance's subnet ID; applicable only if the stack is running in a VPC. SubnetId *string - // The instance's tenancy option, such as dedicated or host. + // The instance's tenancy option, such as dedicated or host . Tenancy *string - // The instance's virtualization type: paravirtual or hvm. + // The instance's virtualization type: paravirtual or hvm . VirtualizationType VirtualizationType noSmithyDocumentSerde } // Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata -// service. For more information, see Instance Metadata and User Data -// (https://docs.aws.amazon.com/sdkfornet/latest/apidocs/Index.html). +// service. For more information, see Instance Metadata and User Data (https://docs.aws.amazon.com/sdkfornet/latest/apidocs/Index.html) +// . type InstanceIdentity struct { // A JSON document that contains the metadata. @@ -846,22 +783,21 @@ type Layer struct { // The Amazon Resource Number (ARN) of a layer. Arn *string - // The layer attributes. For the HaproxyStatsPassword, MysqlRootPassword, and + // The layer attributes. For the HaproxyStatsPassword , MysqlRootPassword , and // GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** // instead of the actual value For an ECS Cluster layer, AWS OpsWorks Stacks the // EcsClusterArn attribute is set to the cluster's ARN. Attributes map[string]string - // Whether to automatically assign an Elastic IP address - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // to the layer's instances. For more information, see How to Edit a Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Whether to automatically assign an Elastic IP address (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // to the layer's instances. For more information, see How to Edit a Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignElasticIps *bool // For stacks that are running in a VPC, whether to automatically assign a public // IP address to the layer's instances. For more information, see How to Edit a - // Layer - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html). + // Layer (https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) + // . AutoAssignPublicIps *bool // The Amazon CloudWatch Logs configuration settings for the layer. @@ -870,9 +806,9 @@ type Layer struct { // Date when the layer was created. CreatedAt *string - // The ARN of the default IAM profile to be used for the layer's EC2 instances. For - // more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // The ARN of the default IAM profile to be used for the layer's EC2 instances. + // For more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . CustomInstanceProfileArn *string // A JSON formatted string containing the layer's custom stack configuration and @@ -903,12 +839,12 @@ type Layer struct { // Whether auto healing is disabled for the layer. EnableAutoHealing *bool - // Whether to install operating system and package updates when the instance boots. - // The default value is true. If this value is set to false, you must then update - // your instances manually by using CreateDeployment to run the update_dependencies - // stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the - // instances. We strongly recommend using the default value of true, to ensure that - // your instances have the latest security updates. + // Whether to install operating system and package updates when the instance + // boots. The default value is true . If this value is set to false , you must then + // update your instances manually by using CreateDeployment to run the + // update_dependencies stack command or manually running yum (Amazon Linux) or + // apt-get (Ubuntu) on the instances. We strongly recommend using the default value + // of true , to ensure that your instances have the latest security updates. InstallUpdatesOnBoot *bool // The layer ID. @@ -980,10 +916,10 @@ type OperatingSystem struct { // operating system. ConfigurationManagers []OperatingSystemConfigurationManager - // The ID of a supported operating system, such as Amazon Linux 2018.03. + // The ID of a supported operating system, such as Amazon Linux 2018.03 . Id *string - // The name of the operating system, such as Amazon Linux 2018.03. + // The name of the operating system, such as Amazon Linux 2018.03 . Name *string // A short name for the operating system manufacturer. @@ -996,14 +932,14 @@ type OperatingSystem struct { // Indicates that an operating system is not supported for new instances. Supported *bool - // The type of a supported operating system, either Linux or Windows. + // The type of a supported operating system, either Linux or Windows . Type *string noSmithyDocumentSerde } -// A block that contains information about the configuration manager (Chef) and the -// versions of the configuration manager that are supported for an operating +// A block that contains information about the configuration manager (Chef) and +// the versions of the configuration manager that are supported for an operating // system. type OperatingSystemConfigurationManager struct { @@ -1027,26 +963,18 @@ type Permission struct { AllowSudo *bool // The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) - // role. For more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // role. For more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . IamUserArn *string // The user's permission level, which must be the following: - // - // * deny - // - // * show - // - // * - // deploy - // - // * manage - // - // * iam_only - // - // For more information on the permissions associated - // with these levels, see Managing User Permissions - // (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) + // - deny + // - show + // - deploy + // - manage + // - iam_only + // For more information on the permissions associated with these levels, see + // Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) Level *string // A stack ID. @@ -1058,8 +986,8 @@ type Permission struct { // Describes an instance's RAID array. type RaidArray struct { - // The array's Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // The array's Availability Zone. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . AvailabilityZone *string // When the RAID array was created. @@ -1086,7 +1014,7 @@ type RaidArray struct { // The array ID. RaidArrayId *string - // The RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels). + // The RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels) . RaidLevel *int32 // The array's size. @@ -1121,7 +1049,7 @@ type RdsDbInstance struct { // Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS // instance. AWS OpsWorks Stacks attempts to discover the instance only once. If - // this value is set to true, you must deregister the instance, and then register + // this value is set to true , you must deregister the instance, and then register // it again. MissingOnRds *bool @@ -1228,8 +1156,7 @@ type ServiceError struct { type ShutdownEventConfiguration struct { // Whether to enable Elastic Load Balancing connection draining. For more - // information, see Connection Draining - // (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain) + // information, see Connection Draining (https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain) DelayUntilElbConnectionsDrained *bool // The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a @@ -1240,25 +1167,18 @@ type ShutdownEventConfiguration struct { } // Contains the information required to retrieve an app or cookbook from a -// repository. For more information, see Creating Apps -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) -// or Custom Recipes and Cookbooks -// (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). +// repository. For more information, see Creating Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) +// or Custom Recipes and Cookbooks (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) +// . type Source struct { // When included in a request, the parameter depends on the repository type. - // - // * For - // Amazon S3 bundles, set Password to the appropriate IAM secret access key. - // - // * For - // HTTP bundles and Subversion repositories, set Password to the password. - // - // For - // more information on how to safely handle IAM credentials, see - // https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html - // (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html). - // In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the + // - For Amazon S3 bundles, set Password to the appropriate IAM secret access + // key. + // - For HTTP bundles and Subversion repositories, set Password to the password. + // For more information on how to safely handle IAM credentials, see + // https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) + // . In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the // actual value. Password *string @@ -1268,24 +1188,21 @@ type Source struct { // potentially be deployed. Revision *string - // In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns - // *****FILTERED***** instead of the actual value. + // In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks + // returns *****FILTERED***** instead of the actual value. SshKey *string // The repository type. Type SourceType // The source URL. The following is an example of an Amazon S3 source URL: - // https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz. + // https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz . Url *string // This parameter depends on the repository type. - // - // * For Amazon S3 bundles, set - // Username to the appropriate IAM access key ID. - // - // * For HTTP bundles, Git - // repositories, and Subversion repositories, set Username to the user name. + // - For Amazon S3 bundles, set Username to the appropriate IAM access key ID. + // - For HTTP bundles, Git repositories, and Subversion repositories, set + // Username to the user name. Username *string noSmithyDocumentSerde @@ -1314,8 +1231,8 @@ type SslConfiguration struct { // Describes a stack. type Stack struct { - // The agent version. This parameter is set to LATEST for auto-update. or a version - // number for a fixed agent version. + // The agent version. This parameter is set to LATEST for auto-update. or a + // version number for a fixed agent version. AgentVersion *string // The stack's ARN. @@ -1325,8 +1242,8 @@ type Stack struct { Attributes map[string]string // A ChefConfiguration object that specifies whether to enable Berkshelf and the - // Berkshelf version. For more information, see Create a New Stack - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html). + // Berkshelf version. For more information, see Create a New Stack (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) + // . ChefConfiguration *ChefConfiguration // The configuration manager. @@ -1336,10 +1253,9 @@ type Stack struct { CreatedAt *string // Contains the information required to retrieve an app or cookbook from a - // repository. For more information, see Adding Apps - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) - // or Cookbooks and Recipes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html). + // repository. For more information, see Adding Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) + // or Cookbooks and Recipes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) + // . CustomCookbooksSource *Source // A JSON object that contains user-defined attributes to be added to the stack @@ -1347,26 +1263,26 @@ type Stack struct { // corresponding default stack configuration attribute values or to pass data to // recipes. The string should be in the following format: "{\"key1\": \"value1\", // \"key2\": \"value2\",...}" For more information on custom JSON, see Use Custom - // JSON to Modify the Stack Configuration Attributes - // (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html). + // JSON to Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) + // . CustomJson *string // The stack's default Availability Zone. For more information, see Regions and - // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) . DefaultAvailabilityZone *string - // The ARN of an IAM profile that is the default profile for all of the stack's EC2 - // instances. For more information about IAM ARNs, see Using Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html). + // The ARN of an IAM profile that is the default profile for all of the stack's + // EC2 instances. For more information about IAM ARNs, see Using Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) + // . DefaultInstanceProfileArn *string // The stack's default operating system. DefaultOs *string - // The default root device type. This value is used by default for all instances in - // the stack, but you can override it when you create an instance. For more - // information, see Storage for the Root Device - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). + // The default root device type. This value is used by default for all instances + // in the stack, but you can override it when you create an instance. For more + // information, see Storage for the Root Device (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) + // . DefaultRootDeviceType RootDeviceType // A default Amazon EC2 key pair for the stack's instances. You can override this @@ -1383,8 +1299,8 @@ type Stack struct { Name *string // The stack AWS region, such as "ap-northeast-2". For more information about AWS - // regions, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // regions, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . Region *string // The stack AWS Identity and Access Management (IAM) role. @@ -1457,8 +1373,8 @@ type TemporaryCredential struct { // The user name. Username *string - // The length of time (in minutes) that the grant is valid. When the grant expires, - // at the end of this period, the user will no longer be able to use the + // The length of time (in minutes) that the grant is valid. When the grant + // expires, at the end of this period, the user will no longer be able to use the // credentials to log in. If they are logged in at the time, they will be // automatically logged out. ValidForInMinutes *int32 @@ -1481,9 +1397,9 @@ type TimeBasedAutoScalingConfiguration struct { // Describes a user's SSH information. type UserProfile struct { - // Whether users can specify their own SSH public key through the My Settings page. - // For more information, see Managing User Permissions - // (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html). + // Whether users can specify their own SSH public key through the My Settings + // page. For more information, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html) + // . AllowSelfManagement *bool // The user's IAM ARN. @@ -1504,8 +1420,8 @@ type UserProfile struct { // Describes an instance's Amazon EBS volume. type Volume struct { - // The volume Availability Zone. For more information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // The volume Availability Zone. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) + // . AvailabilityZone *string // The device name. @@ -1515,8 +1431,8 @@ type Volume struct { Ec2VolumeId *string // Specifies whether an Amazon EBS volume is encrypted. For more information, see - // Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). + // Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // . Encrypted *bool // The instance ID. @@ -1535,39 +1451,31 @@ type Volume struct { RaidArrayId *string // The AWS region. For more information about AWS regions, see Regions and - // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). + // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) . Region *string // The volume size. Size *int32 - // The value returned by DescribeVolumes - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html). + // The value returned by DescribeVolumes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVolumes.html) + // . Status *string // The volume ID. VolumeId *string - // The volume type. For more information, see Amazon EBS Volume Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html). - // - // * - // standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a - // maximum size of 1024 GiB. - // - // * io1 - Provisioned IOPS (SSD). PIOPS volumes must - // have a minimum size of 4 GiB and a maximum size of 16384 GiB. - // - // * gp2 - General - // Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a - // maximum size of 16384 GiB. - // - // * st1 - Throughput Optimized hard disk drive (HDD). - // Throughput optimized HDD volumes must have a minimum size of 500 GiB and a - // maximum size of 16384 GiB. - // - // * sc1 - Cold HDD. Cold HDD volumes must have a - // minimum size of 500 GiB and a maximum size of 16384 GiB. + // The volume type. For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // . + // - standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and + // a maximum size of 1024 GiB. + // - io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 + // GiB and a maximum size of 16384 GiB. + // - gp2 - General Purpose (SSD). General purpose volumes must have a minimum + // size of 1 GiB and a maximum size of 16384 GiB. + // - st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD + // volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. + // - sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a + // maximum size of 16384 GiB. VolumeType *string noSmithyDocumentSerde @@ -1592,36 +1500,28 @@ type VolumeConfiguration struct { Size *int32 // Specifies whether an Amazon EBS volume is encrypted. For more information, see - // Amazon EBS Encryption - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). + // Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) + // . Encrypted *bool // For PIOPS volumes, the IOPS per disk. Iops *int32 - // The volume RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels). + // The volume RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels) . RaidLevel *int32 - // The volume type. For more information, see Amazon EBS Volume Types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html). - // - // * - // standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a - // maximum size of 1024 GiB. - // - // * io1 - Provisioned IOPS (SSD). PIOPS volumes must - // have a minimum size of 4 GiB and a maximum size of 16384 GiB. - // - // * gp2 - General - // Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a - // maximum size of 16384 GiB. - // - // * st1 - Throughput Optimized hard disk drive (HDD). - // Throughput optimized HDD volumes must have a minimum size of 500 GiB and a - // maximum size of 16384 GiB. - // - // * sc1 - Cold HDD. Cold HDD volumes must have a - // minimum size of 500 GiB and a maximum size of 16384 GiB. + // The volume type. For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) + // . + // - standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and + // a maximum size of 1024 GiB. + // - io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 + // GiB and a maximum size of 16384 GiB. + // - gp2 - General Purpose (SSD). General purpose volumes must have a minimum + // size of 1 GiB and a maximum size of 16384 GiB. + // - st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD + // volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. + // - sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a + // maximum size of 16384 GiB. VolumeType *string noSmithyDocumentSerde @@ -1629,13 +1529,9 @@ type VolumeConfiguration struct { // Describes a time-based instance's auto scaling schedule. The schedule consists // of a set of key-value pairs. -// -// * The key is the time period (a UTC hour) and must -// be an integer from 0 - 23. -// -// * The value indicates whether the instance should be -// online or offline for the specified period, and must be set to "on" or -// "off" +// - The key is the time period (a UTC hour) and must be an integer from 0 - 23. +// - The value indicates whether the instance should be online or offline for +// the specified period, and must be set to "on" or "off" // // The default setting for all time periods is off, so you use the following // parameters primarily to specify the online periods. You don't have to explicitly diff --git a/service/opsworkscm/api_client.go b/service/opsworkscm/api_client.go index 6505adc2f1b..26fe674920b 100644 --- a/service/opsworkscm/api_client.go +++ b/service/opsworkscm/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/opsworkscm/api_op_AssociateNode.go b/service/opsworkscm/api_op_AssociateNode.go index f773a0ea75b..c6f4a8f1aeb 100644 --- a/service/opsworkscm/api_op_AssociateNode.go +++ b/service/opsworkscm/api_op_AssociateNode.go @@ -12,8 +12,8 @@ import ( ) // Associates a new node with the server. For more information about how to -// disassociate a node, see DisassociateNode. On a Chef server: This command is an -// alternative to knife bootstrap. Example (Chef): aws opsworks-cm associate-node +// disassociate a node, see DisassociateNode . On a Chef server: This command is an +// alternative to knife bootstrap . Example (Chef): aws opsworks-cm associate-node // --server-name MyServer --node-name MyManagedNode --engine-attributes // "Name=CHEF_ORGANIZATION,Value=default" // "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" On a Puppet server, this @@ -45,19 +45,13 @@ type AssociateNodeInput struct { // Engine attributes used for associating the node. Attributes accepted in a // AssociateNode request for Chef - // - // * CHEF_ORGANIZATION: The Chef organization with - // which the node is associated. By default only one organization named default can - // exist. - // - // * CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required - // for the chef-client agent to access the Chef API. - // - // Attributes accepted in a - // AssociateNode request for Puppet - // - // * PUPPET_NODE_CSR: A PEM-formatted - // certificate-signing request (CSR) that is created by the node. + // - CHEF_ORGANIZATION : The Chef organization with which the node is associated. + // By default only one organization named default can exist. + // - CHEF_NODE_PUBLIC_KEY : A PEM-formatted public key. This key is required for + // the chef-client agent to access the Chef API. + // Attributes accepted in a AssociateNode request for Puppet + // - PUPPET_NODE_CSR : A PEM-formatted certificate-signing request (CSR) that is + // created by the node. // // This member is required. EngineAttributes []types.EngineAttribute diff --git a/service/opsworkscm/api_op_CreateBackup.go b/service/opsworkscm/api_op_CreateBackup.go index b83e388897d..c14fd4c951a 100644 --- a/service/opsworkscm/api_op_CreateBackup.go +++ b/service/opsworkscm/api_op_CreateBackup.go @@ -13,13 +13,13 @@ import ( // Creates an application-level backup of a server. While the server is in the // BACKING_UP state, the server cannot be changed, and no additional backup can be -// created. Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY +// created. Backups can be created for servers in RUNNING , HEALTHY , and UNHEALTHY // states. By default, you can create a maximum of 50 manual backups. This // operation is asynchronous. A LimitExceededException is thrown when the maximum -// number of manual backups is reached. An InvalidStateException is thrown when the -// server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A -// ResourceNotFoundException is thrown when the server is not found. A -// ValidationException is thrown when parameters of the request are not valid. +// number of manual backups is reached. An InvalidStateException is thrown when +// the server is not in any of the following states: RUNNING, HEALTHY, or +// UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. +// A ValidationException is thrown when parameters of the request are not valid. func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) { if params == nil { params = &CreateBackupInput{} @@ -47,22 +47,16 @@ type CreateBackupInput struct { // A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM // server backup. - // - // * The key cannot be empty. - // - // * The key can be a maximum of 127 - // characters, and can contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * The value can be a maximum 255 - // characters, and contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * Leading and trailing white spaces - // are trimmed from both the key and value. - // - // * A maximum of 50 user-applied tags is - // allowed for tag-supported AWS OpsWorks-CM resources. + // - The key cannot be empty. + // - The key can be a maximum of 127 characters, and can contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - The value can be a maximum 255 characters, and contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - Leading and trailing white spaces are trimmed from both the key and value. + // - A maximum of 50 user-applied tags is allowed for tag-supported AWS + // OpsWorks-CM resources. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_CreateServer.go b/service/opsworkscm/api_op_CreateServer.go index 973a1f9e83f..a0c2be9e1a6 100644 --- a/service/opsworkscm/api_op_CreateServer.go +++ b/service/opsworkscm/api_op_CreateServer.go @@ -13,25 +13,25 @@ import ( // Creates and immedately starts a new server. The server is ready to use when it // is in the HEALTHY state. By default, you can create a maximum of 10 servers. -// This operation is asynchronous. A LimitExceededException is thrown when you have -// created the maximum number of servers (10). A ResourceAlreadyExistsException is -// thrown when a server with the same name already exists in the account. A -// ResourceNotFoundException is thrown when you specify a backup ID that is not -// valid or is for a backup that does not exist. A ValidationException is thrown -// when parameters of the request are not valid. If you do not specify a security -// group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new -// security group. Chef Automate: The default security group opens the Chef server -// to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH -// access. SSH is also open to the world on TCP port 22. Puppet Enterprise: The -// default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and -// 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open -// to the world on TCP port 22. By default, your server is accessible from any IP -// address. We recommend that you update your security group rules to allow access -// from known IP addresses and address ranges only. To edit security group rules, -// open Security Groups in the navigation pane of the EC2 management console. To -// specify your own domain for a server, and provide your own self-signed or -// CA-signed certificate and private key, specify values for CustomDomain, -// CustomCertificate, and CustomPrivateKey. +// This operation is asynchronous. A LimitExceededException is thrown when you +// have created the maximum number of servers (10). A +// ResourceAlreadyExistsException is thrown when a server with the same name +// already exists in the account. A ResourceNotFoundException is thrown when you +// specify a backup ID that is not valid or is for a backup that does not exist. A +// ValidationException is thrown when parameters of the request are not valid. If +// you do not specify a security group by adding the SecurityGroupIds parameter, +// AWS OpsWorks creates a new security group. Chef Automate: The default security +// group opens the Chef server to the world on TCP port 443. If a KeyName is +// present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP +// port 22. Puppet Enterprise: The default security group opens TCP ports 22, 443, +// 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables +// SSH access. SSH is also open to the world on TCP port 22. By default, your +// server is accessible from any IP address. We recommend that you update your +// security group rules to allow access from known IP addresses and address ranges +// only. To edit security group rules, open Security Groups in the navigation pane +// of the EC2 management console. To specify your own domain for a server, and +// provide your own self-signed or CA-signed certificate and private key, specify +// values for CustomDomain , CustomCertificate , and CustomPrivateKey . func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, optFns ...func(*Options)) (*CreateServerOutput, error) { if params == nil { params = &CreateServerInput{} @@ -50,14 +50,14 @@ func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, op type CreateServerInput struct { // The configuration management engine to use. Valid values include ChefAutomate - // and Puppet. + // and Puppet . // // This member is required. Engine *string - // The ARN of the instance profile that your Amazon EC2 instances use. Although the - // AWS OpsWorks console typically creates the instance profile for you, if you are - // using API commands instead, run the service-role-creation.yaml AWS + // The ARN of the instance profile that your Amazon EC2 instances use. Although + // the AWS OpsWorks console typically creates the instance profile for you, if you + // are using API commands instead, run the service-role-creation.yaml AWS // CloudFormation template, located at // https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. // This template creates a CloudFormation stack that includes the instance profile @@ -66,7 +66,7 @@ type CreateServerInput struct { // This member is required. InstanceProfileArn *string - // The Amazon EC2 instance type to use. For example, m5.large. + // The Amazon EC2 instance type to use. For example, m5.large . // // This member is required. InstanceType *string @@ -78,8 +78,8 @@ type CreateServerInput struct { // This member is required. ServerName *string - // The service role that the AWS OpsWorks CM service backend uses to work with your - // account. Although the AWS OpsWorks management console typically creates the + // The service role that the AWS OpsWorks CM service backend uses to work with + // your account. Although the AWS OpsWorks management console typically creates the // service role for you, if you are using the AWS CLI or API commands, run the // service-role-creation.yaml AWS CloudFormation template, located at // https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. @@ -89,8 +89,8 @@ type CreateServerInput struct { // This member is required. ServiceRoleArn *string - // Associate a public IP address with a server that you are launching. Valid values - // are true or false. The default value is true. + // Associate a public IP address with a server that you are launching. Valid + // values are true or false . The default value is true . AssociatePublicIpAddress *bool // If you specify this field, AWS OpsWorks CM creates the server by using the @@ -99,91 +99,74 @@ type CreateServerInput struct { // The number of automated backups that you want to keep. Whenever a new backup is // created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. - // The default value is 1. + // The default value is 1 . BackupRetentionCount *int32 // A PEM-formatted HTTPS certificate. The value can be be a single, self-signed // certificate, or a certificate chain. If you specify a custom certificate, you - // must also specify values for CustomDomain and CustomPrivateKey. The following + // must also specify values for CustomDomain and CustomPrivateKey . The following // are requirements for the CustomCertificate value: - // - // * You can provide either a - // self-signed, custom certificate, or the full certificate chain. - // - // * The - // certificate must be a valid X509 certificate, or a certificate chain in PEM - // format. - // - // * The certificate must be valid at the time of upload. A certificate - // can't be used before its validity period begins (the certificate's NotBefore - // date), or after it expires (the certificate's NotAfter date). - // - // * The - // certificate’s common name or subject alternative names (SANs), if present, must - // match the value of CustomDomain. - // - // * The certificate must match the value of - // CustomPrivateKey. + // - You can provide either a self-signed, custom certificate, or the full + // certificate chain. + // - The certificate must be a valid X509 certificate, or a certificate chain in + // PEM format. + // - The certificate must be valid at the time of upload. A certificate can't be + // used before its validity period begins (the certificate's NotBefore date), or + // after it expires (the certificate's NotAfter date). + // - The certificate’s common name or subject alternative names (SANs), if + // present, must match the value of CustomDomain . + // - The certificate must match the value of CustomPrivateKey . CustomCertificate *string - // An optional public endpoint of a server, such as https://aws.my-company.com. To + // An optional public endpoint of a server, such as https://aws.my-company.com . To // access the server, create a CNAME DNS record in your preferred DNS service that // points the custom domain to the endpoint that is generated when the server is // created (the value of the CreateServer Endpoint attribute). You cannot access - // the server by using the generated Endpoint value if the server is using a custom - // domain. If you specify a custom domain, you must also specify values for - // CustomCertificate and CustomPrivateKey. + // the server by using the generated Endpoint value if the server is using a + // custom domain. If you specify a custom domain, you must also specify values for + // CustomCertificate and CustomPrivateKey . CustomDomain *string // A private key in PEM format for connecting to the server by using HTTPS. The // private key must not be encrypted; it cannot be protected by a password or // passphrase. If you specify a custom private key, you must also specify values - // for CustomDomain and CustomCertificate. + // for CustomDomain and CustomCertificate . CustomPrivateKey *string - // Enable or disable scheduled backups. Valid values are true or false. The default - // value is true. + // Enable or disable scheduled backups. Valid values are true or false . The + // default value is true . DisableAutomatedBackup *bool // Optional engine attributes on a specified server. Attributes accepted in a Chef // createServer request: - // - // * CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public - // key. The corresponding private key is required to access the Chef API. When no - // CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the - // response. - // - // * CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative - // user in the Chef Automate web-based dashboard. The password length is a minimum - // of eight characters, and a maximum of 32. The password can contain letters, - // numbers, and special characters (!/@#$%^&+=_). The password must contain at - // least one lower case letter, one upper case letter, one number, and one special - // character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and - // returned in the response. - // - // Attributes accepted in a Puppet createServer - // request: - // - // * PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a - // password must use ASCII characters. - // - // * PUPPET_R10K_REMOTE: The r10k remote is - // the URL of your control repository (for example, - // ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote - // opens TCP port 8170. - // - // * PUPPET_R10K_PRIVATE_KEY: If you are using a private Git - // repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH - // key. + // - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The + // corresponding private key is required to access the Chef API. When no + // CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the + // response. + // - CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in + // the Chef Automate web-based dashboard. The password length is a minimum of eight + // characters, and a maximum of 32. The password can contain letters, numbers, and + // special characters (!/@#$%^&+=_). The password must contain at least one lower + // case letter, one upper case letter, one number, and one special character. When + // no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the + // response. + // Attributes accepted in a Puppet createServer request: + // - PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a + // password must use ASCII characters. + // - PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository + // (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an + // r10k remote opens TCP port 8170. + // - PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add + // PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key. EngineAttributes []types.EngineAttribute // The engine model of the server. Valid values in this release include Monolithic // for Puppet and Single for Chef. EngineModel *string - // The major release version of the engine that you want to use. For a Chef server, - // the valid value for EngineVersion is currently 2. For a Puppet server, valid - // values are 2019 or 2017. + // The major release version of the engine that you want to use. For a Chef + // server, the valid value for EngineVersion is currently 2 . For a Puppet server, + // valid values are 2019 or 2017 . EngineVersion *string // The Amazon EC2 key pair to set for the instance. This parameter is optional; if @@ -194,31 +177,26 @@ type CreateServerInput struct { // The start time for a one-hour period during which AWS OpsWorks CM backs up // application-level data on your server if automated backups are enabled. Valid // values must be specified in one of the following formats: - // - // * HH:MM for daily - // backups - // - // * DDD:HH:MM for weekly backups - // - // MM must be specified as 00. The - // specified time is in coordinated universal time (UTC). The default value is a - // random, daily start time. Example: 08:00, which represents a daily start time of - // 08:00 UTC. Example: Mon:08:00, which represents a start time of every Monday at - // 08:00 UTC. (8:00 a.m.) + // - HH:MM for daily backups + // - DDD:HH:MM for weekly backups + // MM must be specified as 00 . The specified time is in coordinated universal time + // (UTC). The default value is a random, daily start time. Example: 08:00 , which + // represents a daily start time of 08:00 UTC. Example: Mon:08:00 , which + // represents a start time of every Monday at 08:00 UTC. (8:00 a.m.) PreferredBackupWindow *string // The start time for a one-hour period each week during which AWS OpsWorks CM // performs maintenance on the instance. Valid values must be specified in the - // following format: DDD:HH:MM. MM must be specified as 00. The specified time is + // following format: DDD:HH:MM . MM must be specified as 00 . The specified time is // in coordinated universal time (UTC). The default value is a random one-hour // period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more - // information. Example: Mon:08:00, which represents a start time of every Monday + // information. Example: Mon:08:00 , which represents a start time of every Monday // at 08:00 UTC. (8:00 a.m.) PreferredMaintenanceWindow *string // A list of security group IDs to attach to the Amazon EC2 instance. If you add // this parameter, the specified security groups must be within the VPC that is - // specified by SubnetIds. If you do not specify this parameter, AWS OpsWorks CM + // specified by SubnetIds . If you do not specify this parameter, AWS OpsWorks CM // creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 // (everyone). SecurityGroupIds []string @@ -229,29 +207,22 @@ type CreateServerInput struct { // field is optional. If you do not specify subnet IDs, your EC2 instances are // created in a default subnet that is selected by Amazon EC2. If you specify // subnet IDs, the VPC must have "Auto Assign Public IP" enabled. For more - // information about supported Amazon EC2 platforms, see Supported Platforms - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html). + // information about supported Amazon EC2 platforms, see Supported Platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) + // . SubnetIds []string // A map that contains tag keys and tag values to attach to an AWS OpsWorks for // Chef Automate or AWS OpsWorks for Puppet Enterprise server. - // - // * The key cannot be - // empty. - // - // * The key can be a maximum of 127 characters, and can contain only - // Unicode letters, numbers, or separators, or the following special characters: + - // - = . _ : / @ - // - // * The value can be a maximum 255 characters, and contain only - // Unicode letters, numbers, or separators, or the following special characters: + - // - = . _ : / @ - // - // * Leading and trailing white spaces are trimmed from both the key - // and value. - // - // * A maximum of 50 user-applied tags is allowed for any AWS - // OpsWorks-CM server. + // - The key cannot be empty. + // - The key can be a maximum of 127 characters, and can contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / @ + // - The value can be a maximum 255 characters, and contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / @ + // - Leading and trailing white spaces are trimmed from both the key and value. + // - A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM + // server. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_DeleteBackup.go b/service/opsworkscm/api_op_DeleteBackup.go index 990f6daa84d..87466c7b64e 100644 --- a/service/opsworkscm/api_op_DeleteBackup.go +++ b/service/opsworkscm/api_op_DeleteBackup.go @@ -32,8 +32,8 @@ func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, op type DeleteBackupInput struct { - // The ID of the backup to delete. Run the DescribeBackups command to get a list of - // backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS. + // The ID of the backup to delete. Run the DescribeBackups command to get a list + // of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS . // // This member is required. BackupId *string diff --git a/service/opsworkscm/api_op_DeleteServer.go b/service/opsworkscm/api_op_DeleteServer.go index 7e86e975743..2d3361bd052 100644 --- a/service/opsworkscm/api_op_DeleteServer.go +++ b/service/opsworkscm/api_op_DeleteServer.go @@ -12,7 +12,7 @@ import ( // Deletes the server and the underlying AWS CloudFormation stacks (including the // server's EC2 instance). When you run this command, the server state is updated -// to DELETING. After the server is deleted, it is no longer returned by +// to DELETING . After the server is deleted, it is no longer returned by // DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the // server cannot be deleted. This operation is asynchronous. An // InvalidStateException is thrown when a server deletion is already in progress. A diff --git a/service/opsworkscm/api_op_DescribeEvents.go b/service/opsworkscm/api_op_DescribeEvents.go index 7c0e4fca565..9f6e6b10dfd 100644 --- a/service/opsworkscm/api_op_DescribeEvents.go +++ b/service/opsworkscm/api_op_DescribeEvents.go @@ -49,7 +49,7 @@ type DescribeEventsInput struct { // request to get remaining items. To get remaining results, call DescribeEvents // again, and assign the token from the previous results as the value of the // nextToken parameter. If there are no more results, the response object's - // nextToken parameter value is null. Setting a nextToken value that was not + // nextToken parameter value is null . Setting a nextToken value that was not // returned in your previous results causes an InvalidNextTokenException to occur. NextToken *string @@ -63,7 +63,7 @@ type DescribeEventsOutput struct { // request to get remaining items. To get remaining results, call DescribeEvents // again, and assign the token from the previous results as the value of the // nextToken parameter. If there are no more results, the response object's - // nextToken parameter value is null. Setting a nextToken value that was not + // nextToken parameter value is null . Setting a nextToken value that was not // returned in your previous results causes an InvalidNextTokenException to occur. NextToken *string diff --git a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go index e406c57c10e..17d530d4f54 100644 --- a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go +++ b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go @@ -16,8 +16,8 @@ import ( "time" ) -// Returns the current status of an existing association or disassociation request. -// A ResourceNotFoundException is thrown when no recent association or +// Returns the current status of an existing association or disassociation +// request. A ResourceNotFoundException is thrown when no recent association or // disassociation request with the specified token is found, or when the server // does not exist. A ValidationException is raised when parameters of the request // are not valid. @@ -59,15 +59,9 @@ type DescribeNodeAssociationStatusOutput struct { EngineAttributes []types.EngineAttribute // The status of the association or disassociation request. Possible values: - // - // * - // SUCCESS: The association or disassociation succeeded. - // - // * FAILED: The association - // or disassociation failed. - // - // * IN_PROGRESS: The association or disassociation is - // still in progress. + // - SUCCESS : The association or disassociation succeeded. + // - FAILED : The association or disassociation failed. + // - IN_PROGRESS : The association or disassociation is still in progress. NodeAssociationStatus types.NodeAssociationStatus // Metadata pertaining to the operation's result. @@ -160,9 +154,9 @@ type NodeAssociatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NodeAssociatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NodeAssociatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/opsworkscm/api_op_DescribeServers.go b/service/opsworkscm/api_op_DescribeServers.go index 98ad0c7668d..a73d89823ed 100644 --- a/service/opsworkscm/api_op_DescribeServers.go +++ b/service/opsworkscm/api_op_DescribeServers.go @@ -58,17 +58,14 @@ type DescribeServersOutput struct { // have had at least one successful maintenance run after November 1, 2019. For // Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the // following two responses: - // - // * PUPPET_API_CA_CERT, the PEM-encoded CA certificate - // that is used by the Puppet API over TCP port number 8140. The CA certificate is - // also used to sign node certificates. - // - // * PUPPET_API_CRL, a certificate revocation - // list. The certificate revocation list is for internal maintenance purposes only. - // For more information about the Puppet certificate revocation list, see Man Page: - // puppet certificate_revocation_list - // (https://puppet.com/docs/puppet/5.5/man/certificate_revocation_list.html) in the - // Puppet documentation. + // - PUPPET_API_CA_CERT , the PEM-encoded CA certificate that is used by the + // Puppet API over TCP port number 8140. The CA certificate is also used to sign + // node certificates. + // - PUPPET_API_CRL , a certificate revocation list. The certificate revocation + // list is for internal maintenance purposes only. For more information about the + // Puppet certificate revocation list, see Man Page: puppet + // certificate_revocation_list (https://puppet.com/docs/puppet/5.5/man/certificate_revocation_list.html) + // in the Puppet documentation. Servers []types.Server // Metadata pertaining to the operation's result. diff --git a/service/opsworkscm/api_op_DisassociateNode.go b/service/opsworkscm/api_op_DisassociateNode.go index 4a312a7ca93..9757a801a9b 100644 --- a/service/opsworkscm/api_op_DisassociateNode.go +++ b/service/opsworkscm/api_op_DisassociateNode.go @@ -14,7 +14,7 @@ import ( // Disassociates a node from an AWS OpsWorks CM server, and removes the node from // the server's managed nodes. After a node is disassociated, the node key pair is // no longer valid for accessing the configuration manager's API. For more -// information about how to associate a node, see AssociateNode. A node can can +// information about how to associate a node, see AssociateNode . A node can can // only be disassociated from a server that is in a HEALTHY state. Otherwise, an // InvalidStateException is thrown. A ResourceNotFoundException is thrown when the // server does not exist. A ValidationException is raised when parameters of the @@ -47,11 +47,9 @@ type DisassociateNodeInput struct { ServerName *string // Engine attributes that are used for disassociating the node. No attributes are - // required for Puppet. Attributes required in a DisassociateNode request for - // Chef - // - // * CHEF_ORGANIZATION: The Chef organization with which the node was - // associated. By default only one organization named default can exist. + // required for Puppet. Attributes required in a DisassociateNode request for Chef + // - CHEF_ORGANIZATION : The Chef organization with which the node was + // associated. By default only one organization named default can exist. EngineAttributes []types.EngineAttribute noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_ExportServerEngineAttribute.go b/service/opsworkscm/api_op_ExportServerEngineAttribute.go index 0758d9dad3f..1a7eb91b05f 100644 --- a/service/opsworkscm/api_op_ExportServerEngineAttribute.go +++ b/service/opsworkscm/api_op_ExportServerEngineAttribute.go @@ -36,7 +36,7 @@ func (c *Client) ExportServerEngineAttribute(ctx context.Context, params *Export type ExportServerEngineAttributeInput struct { // The name of the export attribute. Currently, the supported export attribute is - // Userdata. This exports a user data script that includes parameters and values + // Userdata . This exports a user data script that includes parameters and values // provided in the InputAttributes list. // // This member is required. @@ -47,26 +47,21 @@ type ExportServerEngineAttributeInput struct { // This member is required. ServerName *string - // The list of engine attributes. The list type is EngineAttribute. An + // The list of engine attributes. The list type is EngineAttribute . An // EngineAttribute list item is a pair that includes an attribute name and its // value. For the Userdata ExportAttributeName, the following are supported engine // attribute names. - // - // * RunList In Chef, a list of roles or recipes that are run in - // the specified order. In Puppet, this parameter is ignored. - // - // * OrganizationName - // In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the - // organization default. In Puppet, this parameter is ignored. - // - // * NodeEnvironment - // In Chef, a node environment (for example, development, staging, or one-box). In - // Puppet, this parameter is ignored. - // - // * NodeClientVersion In Chef, the version of - // the Chef engine (three numbers separated by dots, such as 13.8.5). If this - // attribute is empty, OpsWorks for Chef Automate uses the most current version. In - // Puppet, this parameter is ignored. + // - RunList In Chef, a list of roles or recipes that are run in the specified + // order. In Puppet, this parameter is ignored. + // - OrganizationName In Chef, an organization name. AWS OpsWorks for Chef + // Automate always creates the organization default . In Puppet, this parameter + // is ignored. + // - NodeEnvironment In Chef, a node environment (for example, development, + // staging, or one-box). In Puppet, this parameter is ignored. + // - NodeClientVersion In Chef, the version of the Chef engine (three numbers + // separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for + // Chef Automate uses the most current version. In Puppet, this parameter is + // ignored. InputAttributes []types.EngineAttribute noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_ListTagsForResource.go b/service/opsworkscm/api_op_ListTagsForResource.go index 9755ca439eb..5c12dcc3ada 100644 --- a/service/opsworkscm/api_op_ListTagsForResource.go +++ b/service/opsworkscm/api_op_ListTagsForResource.go @@ -34,7 +34,8 @@ type ListTagsForResourceInput struct { // The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS // OpsWorks for Puppet Enterprise server for which you want to show applied tags. // For example, - // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. + // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE + // . // // This member is required. ResourceArn *string @@ -50,7 +51,7 @@ type ListTagsForResourceInput struct { // request to get remaining items. To get remaining results, call // ListTagsForResource again, and assign the token from the previous results as the // value of the nextToken parameter. If there are no more results, the response - // object's nextToken parameter value is null. Setting a nextToken value that was + // object's nextToken parameter value is null . Setting a nextToken value that was // not returned in your previous results causes an InvalidNextTokenException to // occur. NextToken *string @@ -136,8 +137,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/opsworkscm/api_op_RestoreServer.go b/service/opsworkscm/api_op_RestoreServer.go index 98335d4b177..9c2d407ae97 100644 --- a/service/opsworkscm/api_op_RestoreServer.go +++ b/service/opsworkscm/api_op_RestoreServer.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, -// UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 +// Restores a backup to a server that is in a CONNECTION_LOST , HEALTHY , RUNNING , +// UNHEALTHY , or TERMINATED state. When you run RestoreServer, the server's EC2 // instance is deleted, and a new EC2 instance is configured. RestoreServer // maintains the existing server endpoint, so configuration management of the // server's client devices (nodes) should continue to work. Restoring from a backup @@ -51,10 +51,10 @@ type RestoreServerInput struct { // This member is required. ServerName *string - // The type of instance to restore. Valid values must be specified in the following - // format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, - // r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer - // uses the instance type from the specified backup. + // The type of instance to restore. Valid values must be specified in the + // following format: ^([cm][34]|t2).* For example, m5.large . Valid values are + // m5.large , r5.xlarge , and r5.2xlarge . If you do not specify this parameter, + // RestoreServer uses the instance type from the specified backup. InstanceType *string // The name of the key pair to set on the new EC2 instance. This can be helpful if diff --git a/service/opsworkscm/api_op_StartMaintenance.go b/service/opsworkscm/api_op_StartMaintenance.go index ed786f97bcc..b822dc63fc5 100644 --- a/service/opsworkscm/api_op_StartMaintenance.go +++ b/service/opsworkscm/api_op_StartMaintenance.go @@ -42,13 +42,12 @@ type StartMaintenanceInput struct { // Engine attributes that are specific to the server on which you want to run // maintenance. Attributes accepted in a StartMaintenance request for Chef - // - // * - // CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef - // Automate 2, add this engine attribute to a StartMaintenance request and set the - // value to true to upgrade the server to Chef Automate 2. For more information, - // see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2 - // (https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html). + // - CHEF_MAJOR_UPGRADE : If a Chef Automate server is eligible for upgrade to + // Chef Automate 2, add this engine attribute to a StartMaintenance request and + // set the value to true to upgrade the server to Chef Automate 2. For more + // information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef + // Automate 2 (https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html) + // . EngineAttributes []types.EngineAttribute noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_TagResource.go b/service/opsworkscm/api_op_TagResource.go index 62333ad3cff..bc482762a30 100644 --- a/service/opsworkscm/api_op_TagResource.go +++ b/service/opsworkscm/api_op_TagResource.go @@ -32,29 +32,24 @@ type TagResourceInput struct { // The Amazon Resource Number (ARN) of a resource to which you want to apply tags. // For example, - // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. + // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE + // . // // This member is required. ResourceArn *string - // A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers - // or backups. - // - // * The key cannot be empty. - // - // * The key can be a maximum of 127 - // characters, and can contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * The value can be a maximum 255 - // characters, and contain only Unicode letters, numbers, or separators, or the - // following special characters: + - = . _ : / - // - // * Leading and trailing white spaces - // are trimmed from both the key and value. - // - // * A maximum of 50 user-applied tags is - // allowed for any AWS OpsWorks-CM server or backup. + // A map that contains tag keys and tag values to attach to AWS OpsWorks-CM + // servers or backups. + // - The key cannot be empty. + // - The key can be a maximum of 127 characters, and can contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - The value can be a maximum 255 characters, and contain only Unicode + // letters, numbers, or separators, or the following special characters: + - = . + // _ : / + // - Leading and trailing white spaces are trimmed from both the key and value. + // - A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server + // or backup. // // This member is required. Tags []types.Tag diff --git a/service/opsworkscm/api_op_UntagResource.go b/service/opsworkscm/api_op_UntagResource.go index a68c554c7da..c77bb866511 100644 --- a/service/opsworkscm/api_op_UntagResource.go +++ b/service/opsworkscm/api_op_UntagResource.go @@ -30,7 +30,8 @@ type UntagResourceInput struct { // The Amazon Resource Number (ARN) of a resource from which you want to remove // tags. For example, - // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE. + // arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE + // . // // This member is required. ResourceArn *string diff --git a/service/opsworkscm/api_op_UpdateServer.go b/service/opsworkscm/api_op_UpdateServer.go index 5389655c269..b0f21a4dd11 100644 --- a/service/opsworkscm/api_op_UpdateServer.go +++ b/service/opsworkscm/api_op_UpdateServer.go @@ -42,13 +42,13 @@ type UpdateServerInput struct { DisableAutomatedBackup *bool // DDD:HH:MM (weekly start time) or HH:MM (daily start time). Time windows always - // use coordinated universal time (UTC). Valid strings for day of week (DDD) are: - // Mon, Tue, Wed, Thr, Fri, Sat, or Sun. + // use coordinated universal time (UTC). Valid strings for day of week ( DDD ) are: + // Mon , Tue , Wed , Thr , Fri , Sat , or Sun . PreferredBackupWindow *string // DDD:HH:MM (weekly start time) or HH:MM (daily start time). Time windows always - // use coordinated universal time (UTC). Valid strings for day of week (DDD) are: - // Mon, Tue, Wed, Thr, Fri, Sat, or Sun. + // use coordinated universal time (UTC). Valid strings for day of week ( DDD ) are: + // Mon , Tue , Wed , Thr , Fri , Sat , or Sun . PreferredMaintenanceWindow *string noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_UpdateServerEngineAttributes.go b/service/opsworkscm/api_op_UpdateServerEngineAttributes.go index e4f0a849d15..0330699024c 100644 --- a/service/opsworkscm/api_op_UpdateServerEngineAttributes.go +++ b/service/opsworkscm/api_op_UpdateServerEngineAttributes.go @@ -13,11 +13,11 @@ import ( // Updates engine-specific attributes on a specified server. The server enters the // MODIFYING state when this operation is in progress. Only one update can occur at -// a time. You can use this command to reset a Chef server's public key -// (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD). -// This operation is asynchronous. This operation can only be called for servers in -// HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A -// ResourceNotFoundException is thrown when the server does not exist. A +// a time. You can use this command to reset a Chef server's public key ( +// CHEF_PIVOTAL_KEY ) or a Puppet server's admin password ( PUPPET_ADMIN_PASSWORD +// ). This operation is asynchronous. This operation can only be called for servers +// in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. +// A ResourceNotFoundException is thrown when the server does not exist. A // ValidationException is raised when parameters of the request are not valid. func (c *Client) UpdateServerEngineAttributes(ctx context.Context, params *UpdateServerEngineAttributesInput, optFns ...func(*Options)) (*UpdateServerEngineAttributesOutput, error) { if params == nil { diff --git a/service/opsworkscm/doc.go b/service/opsworkscm/doc.go index defe76d0fb7..dbaafdcdb95 100644 --- a/service/opsworkscm/doc.go +++ b/service/opsworkscm/doc.go @@ -3,73 +3,46 @@ // Package opsworkscm provides the API client, operations, and parameter types for // AWS OpsWorks CM. // -// AWS OpsWorks CM AWS OpsWorks for configuration management (CM) is a service that -// runs and manages configuration management servers. You can use AWS OpsWorks CM -// to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet -// Enterprise servers, and add or remove nodes for the servers to manage. Glossary -// of terms -// -// * Server: A configuration management server that can be -// highly-available. The configuration management server runs on an Amazon Elastic -// Compute Cloud (EC2) instance, and may use various other AWS services, such as -// Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is -// a generic abstraction over the configuration manager that you want to use, much -// like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you -// create servers, they continue to run until they are deleted. -// -// * Engine: The -// engine is the specific configuration manager that you want to use. Valid values -// in this release include ChefAutomate and Puppet. -// -// * Backup: This is an -// application-level backup of the data that the configuration manager stores. AWS -// OpsWorks CM creates an S3 bucket for backups when you launch the first server. A -// backup maintains a snapshot of a server's configuration-related attributes at -// the time the backup starts. -// -// * Events: Events are always related to a server. -// Events are written during server creation, when health checks run, when backups -// are created, when system maintenance is performed, etc. When you delete a -// server, the server's events are also deleted. -// -// * Account attributes: Every -// account has attributes that are assigned in the AWS OpsWorks CM database. These -// attributes store information about configuration limits (servers, backups, etc.) -// and your customer account. -// -// Endpoints AWS OpsWorks CM supports the following -// endpoints, all HTTPS. You must connect to one of the following endpoints. Your -// servers can only be accessed or managed within the endpoint in which they are -// created. -// -// * opsworks-cm.us-east-1.amazonaws.com -// -// * -// opsworks-cm.us-east-2.amazonaws.com -// -// * opsworks-cm.us-west-1.amazonaws.com -// -// * -// opsworks-cm.us-west-2.amazonaws.com -// -// * -// opsworks-cm.ap-northeast-1.amazonaws.com -// -// * -// opsworks-cm.ap-southeast-1.amazonaws.com -// -// * -// opsworks-cm.ap-southeast-2.amazonaws.com -// -// * -// opsworks-cm.eu-central-1.amazonaws.com -// -// * -// opsworks-cm.eu-west-1.amazonaws.com -// -// For more information, see AWS OpsWorks -// endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html) in the AWS -// General Reference. Throttling limits All API operations allow for five requests -// per second with a burst of 10 requests per second. +// AWS OpsWorks CM AWS OpsWorks for configuration management (CM) is a service +// that runs and manages configuration management servers. You can use AWS OpsWorks +// CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for +// Puppet Enterprise servers, and add or remove nodes for the servers to manage. +// Glossary of terms +// - Server: A configuration management server that can be highly-available. The +// configuration management server runs on an Amazon Elastic Compute Cloud (EC2) +// instance, and may use various other AWS services, such as Amazon Relational +// Database Service (RDS) and Elastic Load Balancing. A server is a generic +// abstraction over the configuration manager that you want to use, much like +// Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you +// create servers, they continue to run until they are deleted. +// - Engine: The engine is the specific configuration manager that you want to +// use. Valid values in this release include ChefAutomate and Puppet . +// - Backup: This is an application-level backup of the data that the +// configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups +// when you launch the first server. A backup maintains a snapshot of a server's +// configuration-related attributes at the time the backup starts. +// - Events: Events are always related to a server. Events are written during +// server creation, when health checks run, when backups are created, when system +// maintenance is performed, etc. When you delete a server, the server's events are +// also deleted. +// - Account attributes: Every account has attributes that are assigned in the +// AWS OpsWorks CM database. These attributes store information about configuration +// limits (servers, backups, etc.) and your customer account. +// +// Endpoints AWS OpsWorks CM supports the following endpoints, all HTTPS. You must +// connect to one of the following endpoints. Your servers can only be accessed or +// managed within the endpoint in which they are created. +// - opsworks-cm.us-east-1.amazonaws.com +// - opsworks-cm.us-east-2.amazonaws.com +// - opsworks-cm.us-west-1.amazonaws.com +// - opsworks-cm.us-west-2.amazonaws.com +// - opsworks-cm.ap-northeast-1.amazonaws.com +// - opsworks-cm.ap-southeast-1.amazonaws.com +// - opsworks-cm.ap-southeast-2.amazonaws.com +// - opsworks-cm.eu-central-1.amazonaws.com +// - opsworks-cm.eu-west-1.amazonaws.com +// +// For more information, see AWS OpsWorks endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html) +// in the AWS General Reference. Throttling limits All API operations allow for +// five requests per second with a burst of 10 requests per second. package opsworkscm diff --git a/service/opsworkscm/types/enums.go b/service/opsworkscm/types/enums.go index b00c05f0954..2e9e9495532 100644 --- a/service/opsworkscm/types/enums.go +++ b/service/opsworkscm/types/enums.go @@ -12,9 +12,9 @@ const ( BackupStatusDeleting BackupStatus = "DELETING" ) -// Values returns all known values for BackupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for BackupStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (BackupStatus) Values() []BackupStatus { return []BackupStatus{ "IN_PROGRESS", @@ -69,8 +69,8 @@ const ( NodeAssociationStatusInProgress NodeAssociationStatus = "IN_PROGRESS" ) -// Values returns all known values for NodeAssociationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NodeAssociationStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NodeAssociationStatus) Values() []NodeAssociationStatus { return []NodeAssociationStatus{ @@ -99,9 +99,9 @@ const ( ServerStatusTerminated ServerStatus = "TERMINATED" ) -// Values returns all known values for ServerStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServerStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ServerStatus) Values() []ServerStatus { return []ServerStatus{ "BACKING_UP", diff --git a/service/opsworkscm/types/types.go b/service/opsworkscm/types/types.go index ce996725adf..eb0ee00d520 100644 --- a/service/opsworkscm/types/types.go +++ b/service/opsworkscm/types/types.go @@ -14,14 +14,10 @@ type AccountAttribute struct { Maximum *int32 // The attribute name. The following are supported attribute names. - // - // * ServerLimit: - // The number of current servers/maximum number of servers allowed. By default, you - // can have a maximum of 10 servers. - // - // * ManualBackupLimit: The number of current - // manual backups/maximum number of backups allowed. By default, you can have a - // maximum of 50 manual backups saved. + // - ServerLimit: The number of current servers/maximum number of servers + // allowed. By default, you can have a maximum of 10 servers. + // - ManualBackupLimit: The number of current manual backups/maximum number of + // backups allowed. By default, you can have a maximum of 50 manual backups saved. Name *string // The current usage, such as the current number of servers that are associated @@ -40,7 +36,7 @@ type Backup struct { // The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS BackupId *string - // The backup type. Valid values are automated or manual. + // The backup type. Valid values are automated or manual . BackupType BackupType // The time stamp when the backup was created in the database. Example: @@ -60,8 +56,8 @@ type Backup struct { // The engine version that is obtained from the server when the backup is created. EngineVersion *string - // The EC2 instance profile ARN that is obtained from the server when the backup is - // created. Because this value is stored, you are not required to provide the + // The EC2 instance profile ARN that is obtained from the server when the backup + // is created. Because this value is stored, you are not required to provide the // InstanceProfileArn again if you restore a backup. InstanceProfileArn *string @@ -150,8 +146,8 @@ type Server struct { // Time stamp of server creation. Example 2016-07-29T13:38:47.520Z CreatedAt *time.Time - // An optional public endpoint of a server, such as https://aws.my-company.com. You - // cannot access the server by using the Endpoint value if the server has a + // An optional public endpoint of a server, such as https://aws.my-company.com . + // You cannot access the server by using the Endpoint value if the server has a // CustomDomain specified. CustomDomain *string @@ -160,40 +156,33 @@ type Server struct { DisableAutomatedBackup *bool // A DNS name that can be used to access the engine. Example: - // myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using + // myserver-asdfghjkl.us-east-1.opsworks.io . You cannot access the server by using // the Endpoint value if the server has a CustomDomain specified. Endpoint *string // The engine type of the server. Valid values in this release include ChefAutomate - // and Puppet. + // and Puppet . Engine *string - // The response of a createServer() request returns the master credential to access - // the server in EngineAttributes. These credentials are not stored by AWS OpsWorks - // CM; they are returned only as part of the result of createServer(). Attributes - // returned in a createServer response for Chef - // - // * CHEF_AUTOMATE_PIVOTAL_KEY: A - // base64-encoded RSA private key that is generated by AWS OpsWorks for Chef - // Automate. This private key is required to access the Chef API. - // - // * - // CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef - // starter kit, which includes a README, a configuration file, and the required RSA - // private key. Save this file, unzip it, and then change to the directory where - // you've unzipped the file contents. From this directory, you can run Knife - // commands. - // + // The response of a createServer() request returns the master credential to + // access the server in EngineAttributes. These credentials are not stored by AWS + // OpsWorks CM; they are returned only as part of the result of createServer(). + // Attributes returned in a createServer response for Chef + // - CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA private key that is + // generated by AWS OpsWorks for Chef Automate. This private key is required to + // access the Chef API. + // - CHEF_STARTER_KIT : A base64-encoded ZIP file. The ZIP file contains a Chef + // starter kit, which includes a README, a configuration file, and the required RSA + // private key. Save this file, unzip it, and then change to the directory where + // you've unzipped the file contents. From this directory, you can run Knife + // commands. // Attributes returned in a createServer response for Puppet - // - // * - // PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet - // starter kit, including a README and a required private key. Save this file, - // unzip it, and then change to the directory where you've unzipped the file - // contents. - // - // * PUPPET_ADMIN_PASSWORD: An administrator password that you can use - // to sign in to the Puppet Enterprise console after the server is online. + // - PUPPET_STARTER_KIT : A base64-encoded ZIP file. The ZIP file contains a + // Puppet starter kit, including a README and a required private key. Save this + // file, unzip it, and then change to the directory where you've unzipped the file + // contents. + // - PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign + // in to the Puppet Enterprise console after the server is online. EngineAttributes []EngineAttribute // The engine model of the server. Valid values in this release include Monolithic @@ -201,20 +190,20 @@ type Server struct { EngineModel *string // The engine version of the server. For a Chef server, the valid value for - // EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017. + // EngineVersion is currently 2 . For a Puppet server, specify either 2019 or 2017 . EngineVersion *string // The instance profile ARN of the server. InstanceProfileArn *string - // The instance type for the server, as specified in the CloudFormation stack. This - // might not be the same instance type that is shown in the EC2 console. + // The instance type for the server, as specified in the CloudFormation stack. + // This might not be the same instance type that is shown in the EC2 console. InstanceType *string // The key pair associated with the server. KeyPair *string - // The status of the most recent server maintenance run. Shows SUCCESS or FAILED. + // The status of the most recent server maintenance run. Shows SUCCESS or FAILED . MaintenanceStatus MaintenanceStatus // The preferred backup period specified for the server. @@ -223,8 +212,9 @@ type Server struct { // The preferred maintenance period specified for the server. PreferredMaintenanceWindow *string - // The security group IDs for the server, as specified in the CloudFormation stack. - // These might not be the same security groups that are shown in the EC2 console. + // The security group IDs for the server, as specified in the CloudFormation + // stack. These might not be the same security groups that are shown in the EC2 + // console. SecurityGroupIds []string // The ARN of the server. @@ -236,9 +226,9 @@ type Server struct { // The service role ARN used to create the server. ServiceRoleArn *string - // The server's status. This field displays the states of actions in progress, such - // as creating, running, or backing up the server, as well as the server's health - // state. + // The server's status. This field displays the states of actions in progress, + // such as creating, running, or backing up the server, as well as the server's + // health state. Status ServerStatus // Depending on the server status, this field has either a human-readable message @@ -277,14 +267,14 @@ type ServerEvent struct { // user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources. type Tag struct { - // A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a + // A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a // maximum of 127 characters, and can contain only Unicode letters, numbers, or // separators, or the following special characters: + - = . _ : / // // This member is required. Key *string - // An optional tag value, such as Production or test-owcm-server. The value can be + // An optional tag value, such as Production or test-owcm-server . The value can be // a maximum of 255 characters, and contain only Unicode letters, numbers, or // separators, or the following special characters: + - = . _ : / // diff --git a/service/organizations/api_client.go b/service/organizations/api_client.go index 04cfc9fa73e..c616e33a1d3 100644 --- a/service/organizations/api_client.go +++ b/service/organizations/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/organizations/api_op_AcceptHandshake.go b/service/organizations/api_op_AcceptHandshake.go index 73044849133..646be3c0452 100644 --- a/service/organizations/api_op_AcceptHandshake.go +++ b/service/organizations/api_op_AcceptHandshake.go @@ -14,31 +14,24 @@ import ( // Sends a response to the originator of a handshake agreeing to the action // proposed by the handshake request. You can only call this operation by the // following principals when they also have the relevant IAM permissions: +// - Invitation to join or Approve all features request handshakes: only a +// principal from the member account. The user who calls the API for an invitation +// to join must have the organizations:AcceptHandshake permission. If you enabled +// all features in the organization, the user must also have the +// iam:CreateServiceLinkedRole permission so that Organizations can create the +// required service-linked role named AWSServiceRoleForOrganizations . For more +// information, see Organizations and Service-Linked Roles (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles) +// in the Organizations User Guide. +// - Enable all features final confirmation handshake: only a principal from the +// management account. For more information about invitations, see Inviting an +// Amazon Web Services account to join your organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html) +// in the Organizations User Guide. For more information about requests to enable +// all features in the organization, see Enabling all features in your +// organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// in the Organizations User Guide. // -// * -// Invitation to join or Approve all features request handshakes: only a principal -// from the member account. The user who calls the API for an invitation to join -// must have the organizations:AcceptHandshake permission. If you enabled all -// features in the organization, the user must also have the -// iam:CreateServiceLinkedRole permission so that Organizations can create the -// required service-linked role named AWSServiceRoleForOrganizations. For more -// information, see Organizations and Service-Linked Roles -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles) -// in the Organizations User Guide. -// -// * Enable all features final confirmation -// handshake: only a principal from the management account. For more information -// about invitations, see Inviting an Amazon Web Services account to join your -// organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html) -// in the Organizations User Guide. For more information about requests to enable -// all features in the organization, see Enabling all features in your organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) -// in the Organizations User Guide. -// -// After you accept a handshake, it continues to -// appear in the results of relevant APIs for only 30 days. After that, it's -// deleted. +// After you accept a handshake, it continues to appear in the results of relevant +// APIs for only 30 days. After that, it's deleted. func (c *Client) AcceptHandshake(ctx context.Context, params *AcceptHandshakeInput, optFns ...func(*Options)) (*AcceptHandshakeOutput, error) { if params == nil { params = &AcceptHandshakeInput{} diff --git a/service/organizations/api_op_AttachPolicy.go b/service/organizations/api_op_AttachPolicy.go index 8428d9d0705..1861205f338 100644 --- a/service/organizations/api_op_AttachPolicy.go +++ b/service/organizations/api_op_AttachPolicy.go @@ -13,25 +13,12 @@ import ( // Attaches a policy to a root, an organizational unit (OU), or an individual // account. How the policy affects accounts depends on the type of policy. Refer to // the Organizations User Guide for information about each policy type: +// - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) +// - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) +// - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) +// - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // -// * -// AISERVICES_OPT_OUT_POLICY -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) -// -// * -// BACKUP_POLICY -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) -// -// * -// SERVICE_CONTROL_POLICY -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) -// -// * -// TAG_POLICY -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) -// -// This -// operation can be called only from the organization's management account. +// This operation can be called only from the organization's management account. func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error) { if params == nil { params = &AttachPolicyInput{} @@ -59,21 +46,16 @@ type AttachPolicyInput struct { PolicyId *string // The unique identifier (ID) of the root, OU, or account that you want to attach - // the policy to. You can get the ID by calling the ListRoots, - // ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern - // (http://wikipedia.org/wiki/regex) for a target ID string requires one of the - // following: - // - // * Root - A string that begins with "r-" followed by from 4 to 32 - // lowercase letters or digits. - // - // * Account - A string that consists of exactly 12 - // digits. - // - // * Organizational unit (OU) - A string that begins with "ou-" followed - // by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is - // in). This string is followed by a second "-" dash and from 8 to 32 additional - // lowercase letters or digits. + // the policy to. You can get the ID by calling the ListRoots , + // ListOrganizationalUnitsForParent , or ListAccounts operations. The regex pattern (http://wikipedia.org/wiki/regex) + // for a target ID string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. TargetId *string diff --git a/service/organizations/api_op_CancelHandshake.go b/service/organizations/api_op_CancelHandshake.go index f38c12dff49..780c78bce73 100644 --- a/service/organizations/api_op_CancelHandshake.go +++ b/service/organizations/api_op_CancelHandshake.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED. -// This operation can be called only from the account that originated the +// Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED +// . This operation can be called only from the account that originated the // handshake. The recipient of the handshake can't cancel it, but can use // DeclineHandshake instead. After a handshake is canceled, the recipient can no // longer respond to that handshake. After you cancel a handshake, it continues to @@ -35,10 +35,10 @@ func (c *Client) CancelHandshake(ctx context.Context, params *CancelHandshakeInp type CancelHandshakeInput struct { - // The unique identifier (ID) of the handshake that you want to cancel. You can get - // the ID from the ListHandshakesForOrganization operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed - // by from 8 to 32 lowercase letters or digits. + // The unique identifier (ID) of the handshake that you want to cancel. You can + // get the ID from the ListHandshakesForOrganization operation. The regex pattern (http://wikipedia.org/wiki/regex) + // for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters + // or digits. // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_CloseAccount.go b/service/organizations/api_op_CloseAccount.go index b565962de53..d9382982e20 100644 --- a/service/organizations/api_op_CloseAccount.go +++ b/service/organizations/api_op_CloseAccount.go @@ -11,51 +11,41 @@ import ( ) // Closes an Amazon Web Services member account within an organization. You can -// close an account when all features are enabled -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html). -// You can't close the management account with this API. This is an asynchronous +// close an account when all features are enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// . You can't close the management account with this API. This is an asynchronous // request that Amazon Web Services performs in the background. Because // CloseAccount operates asynchronously, it can return a successful completion // message even though account closure might still be in progress. You need to wait // a few minutes before the account is fully closed. To check the status of the // request, do one of the following: // -// * Use the AccountId that you sent in the -// CloseAccount request to provide as a parameter to the DescribeAccount operation. -// While the close account request is in progress, Account status will indicate -// PENDING_CLOSURE. When the close account request completes, the status will -// change to SUSPENDED. +// - Use the AccountId that you sent in the CloseAccount request to provide as a +// parameter to the DescribeAccount operation. While the close account request is +// in progress, Account status will indicate PENDING_CLOSURE. When the close +// account request completes, the status will change to SUSPENDED. // -// * Check the CloudTrail log for the CloseAccountResult -// event that gets published after the account closes successfully. For information -// on using CloudTrail with Organizations, see Logging and monitoring in -// Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration) -// in the Organizations User Guide. +// - Check the CloudTrail log for the CloseAccountResult event that gets +// published after the account closes successfully. For information on using +// CloudTrail with Organizations, see Logging and monitoring in Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration) +// in the Organizations User Guide. // -// * You can close only 10% of member accounts, -// between 10 and 200, within a rolling 30 day period. This quota is not bound by a -// calendar month, but starts when you close an account. After you reach this -// limit, you can close additional accounts in the Billing console. For more -// information, see Closing an account -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/close-account.html) -// in the Amazon Web Services Billing and Cost Management User Guide. +// - You can close only 10% of member accounts, between 10 and 200, within a +// rolling 30 day period. This quota is not bound by a calendar month, but starts +// when you close an account. After you reach this limit, you can close additional +// accounts in the Billing console. For more information, see Closing an account (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/close-account.html) +// in the Amazon Web Services Billing and Cost Management User Guide. // -// * To -// reinstate a closed account, contact Amazon Web Services Support within the -// 90-day grace period while the account is in SUSPENDED status. +// - To reinstate a closed account, contact Amazon Web Services Support within +// the 90-day grace period while the account is in SUSPENDED status. // -// * If the Amazon -// Web Services account you attempt to close is linked to an Amazon Web Services -// GovCloud (US) account, the CloseAccount request will close both accounts. To -// learn important pre-closure details, see Closing an Amazon Web Services -// GovCloud (US) account -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/Closing-govcloud-account.html) -// in the Amazon Web Services GovCloud User Guide. +// - If the Amazon Web Services account you attempt to close is linked to an +// Amazon Web Services GovCloud (US) account, the CloseAccount request will close +// both accounts. To learn important pre-closure details, see Closing an Amazon +// Web Services GovCloud (US) account (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/Closing-govcloud-account.html) +// in the Amazon Web Services GovCloud User Guide. // -// For more information about -// closing accounts, see Closing an Amazon Web Services account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) +// For more information about closing accounts, see Closing an Amazon Web Services +// account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) // in the Organizations User Guide. func (c *Client) CloseAccount(ctx context.Context, params *CloseAccountInput, optFns ...func(*Options)) (*CloseAccountOutput, error) { if params == nil { diff --git a/service/organizations/api_op_CreateAccount.go b/service/organizations/api_op_CreateAccount.go index 0072004e64e..5e2c9688a92 100644 --- a/service/organizations/api_op_CreateAccount.go +++ b/service/organizations/api_op_CreateAccount.go @@ -18,23 +18,19 @@ import ( // though account initialization might still be in progress. You might need to wait // a few minutes before you can successfully access the account. To check the // status of the request, do one of the following: +// - Use the Id value of the CreateAccountStatus response element from this +// operation to provide as a parameter to the DescribeCreateAccountStatus +// operation. +// - Check the CloudTrail log for the CreateAccountResult event. For information +// on using CloudTrail with Organizations, see Logging and monitoring in +// Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration) +// in the Organizations User Guide. // -// * Use the Id value of the -// CreateAccountStatus response element from this operation to provide as a -// parameter to the DescribeCreateAccountStatus operation. -// -// * Check the CloudTrail -// log for the CreateAccountResult event. For information on using CloudTrail with -// Organizations, see Logging and monitoring in Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration) -// in the Organizations User Guide. -// -// The user who calls the API to create an -// account must have the organizations:CreateAccount permission. If you enabled all -// features in the organization, Organizations creates the required service-linked -// role named AWSServiceRoleForOrganizations. For more information, see -// Organizations and Service-Linked Roles -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs) +// The user who calls the API to create an account must have the +// organizations:CreateAccount permission. If you enabled all features in the +// organization, Organizations creates the required service-linked role named +// AWSServiceRoleForOrganizations . For more information, see Organizations and +// Service-Linked Roles (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs) // in the Organizations User Guide. If the request includes tags, then the // requester must have the organizations:TagResource permission. Organizations // preconfigures the new member account with a role (named @@ -44,46 +40,37 @@ import ( // and address information for the new account from the organization's management // account. This operation can be called only from the organization's management // account. For more information about creating accounts, see Creating an Amazon -// Web Services account in Your Organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) +// Web Services account in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) // in the Organizations User Guide. +// - When you create an account in an organization using the Organizations +// console, API, or CLI commands, the information required for the account to +// operate as a standalone account, such as a payment method and signing the end +// user license agreement (EULA) is not automatically collected. If you must remove +// an account from your organization later, you can do so only after you provide +// the missing information. Follow the steps at To leave an organization as a +// member account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - If you get an exception that indicates that you exceeded your account +// limits for the organization, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . +// - If you get an exception that indicates that the operation failed because +// your organization is still initializing, wait one hour and then try again. If +// the error persists, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . +// - Using CreateAccount to create multiple temporary accounts isn't recommended. +// You can only close an account from the Billing and Cost Management console, and +// you must be signed in as the root user. For information on the requirements and +// process for closing an account, see Closing an Amazon Web Services account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) +// in the Organizations User Guide. // -// * When you create an account in an -// organization using the Organizations console, API, or CLI commands, the -// information required for the account to operate as a standalone account, such as -// a payment method and signing the end user license agreement (EULA) is not -// automatically collected. If you must remove an account from your organization -// later, you can do so only after you provide the missing information. Follow the -// steps at To leave an organization as a member account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) -// in the Organizations User Guide. -// -// * If you get an exception that indicates that -// you exceeded your account limits for the organization, contact Amazon Web -// Services Support (https://console.aws.amazon.com/support/home#/). -// -// * If you get -// an exception that indicates that the operation failed because your organization -// is still initializing, wait one hour and then try again. If the error persists, -// contact Amazon Web Services Support -// (https://console.aws.amazon.com/support/home#/). -// -// * Using CreateAccount to -// create multiple temporary accounts isn't recommended. You can only close an -// account from the Billing and Cost Management console, and you must be signed in -// as the root user. For information on the requirements and process for closing an -// account, see Closing an Amazon Web Services account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) -// in the Organizations User Guide. -// -// When you create a member account with this -// operation, you can choose whether to create the account with the IAM User and -// Role Access to Billing Information switch enabled. If you enable it, IAM users -// and roles that have appropriate permissions can view billing information for the -// account. If you disable it, only the account root user can access billing -// information. For information about how to disable this switch for an account, -// see Granting Access to Your Billing Information and Tools -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html). +// When you create a member account with this operation, you can choose whether to +// create the account with the IAM User and Role Access to Billing Information +// switch enabled. If you enable it, IAM users and roles that have appropriate +// permissions can view billing information for the account. If you disable it, +// only the account root user can access billing information. For information about +// how to disable this switch for an account, see Granting Access to Your Billing +// Information and Tools (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html) +// . func (c *Client) CreateAccount(ctx context.Context, params *CreateAccountInput, optFns ...func(*Options)) (*CreateAccountOutput, error) { if params == nil { params = &CreateAccountInput{} @@ -110,44 +97,29 @@ type CreateAccountInput struct { // address must not already be associated with another Amazon Web Services account. // You must use a valid email address to complete account creation. The rules for a // valid email address: - // - // * The address must be a minimum of 6 and a maximum of 64 - // characters long. - // - // * All characters must be 7-bit ASCII characters. - // - // * There must - // be one and only one @ symbol, which separates the local name from the domain - // name. - // - // * The local name can't contain any of the following characters: - // whitespace, " ' ( ) < > [ ] : ; , \ | % & - // - // * The local name can't begin with a - // dot (.) - // - // * The domain name can consist of only the characters [a-z],[A-Z],[0-9], - // hyphen (-), or dot (.) - // - // * The domain name can't begin or end with a hyphen (-) - // or dot (.) - // - // * The domain name must contain at least one dot - // - // You can't access - // the root user of the account or remove an account that was created with an - // invalid email address. + // - The address must be a minimum of 6 and a maximum of 64 characters long. + // - All characters must be 7-bit ASCII characters. + // - There must be one and only one @ symbol, which separates the local name + // from the domain name. + // - The local name can't contain any of the following characters: whitespace, " + // ' ( ) < > [ ] : ; , \ | % & + // - The local name can't begin with a dot (.) + // - The domain name can consist of only the characters [a-z],[A-Z],[0-9], + // hyphen (-), or dot (.) + // - The domain name can't begin or end with a hyphen (-) or dot (.) + // - The domain name must contain at least one dot + // You can't access the root user of the account or remove an account that was + // created with an invalid email address. // // This member is required. Email *string - // If set to ALLOW, the new account enables IAM users to access account billing - // information if they have the required permissions. If set to DENY, only the root - // user of the new account can access account billing information. For more - // information, see Activating Access to the Billing and Cost Management Console - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) + // If set to ALLOW , the new account enables IAM users to access account billing + // information if they have the required permissions. If set to DENY , only the + // root user of the new account can access account billing information. For more + // information, see Activating Access to the Billing and Cost Management Console (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) // in the Amazon Web Services Billing and Cost Management User Guide. If you don't - // specify this parameter, the value defaults to ALLOW, and IAM users and roles + // specify this parameter, the value defaults to ALLOW , and IAM users and roles // with the required permissions can access billing information for the new // account. IamUserAccessToBilling types.IAMUserAccessToBilling @@ -157,30 +129,22 @@ type CreateAccountInput struct { // the management account to assume the role, as permitted by the management // account administrator. The role has administrator permissions in the new member // account. If you don't specify this parameter, the role name defaults to - // OrganizationAccountAccessRole. For more information about how to use this role + // OrganizationAccountAccessRole . For more information about how to use this role // to access the member account, see the following links: - // - // * Accessing and - // Administering the Member Accounts in Your Organization - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) - // in the Organizations User Guide - // - // * Steps 2 and 3 in Tutorial: Delegate Access - // Across Amazon Web Services accounts Using IAM Roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) - // in the IAM User Guide - // - // The regex pattern (http://wikipedia.org/wiki/regex) that - // is used to validate this parameter. The pattern can include uppercase letters, - // lowercase letters, digits with no spaces, and any of the following characters: - // =,.@- + // - Accessing and Administering the Member Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) + // in the Organizations User Guide + // - Steps 2 and 3 in Tutorial: Delegate Access Across Amazon Web Services + // accounts Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) + // in the IAM User Guide + // The regex pattern (http://wikipedia.org/wiki/regex) that is used to validate + // this parameter. The pattern can include uppercase letters, lowercase letters, + // digits with no spaces, and any of the following characters: =,.@- RoleName *string // A list of tags that you want to attach to the newly created account. For each // tag in the list, you must specify both a tag key and a value. You can set the - // value to an empty string, but you can't set it to null. For more information - // about tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // value to an empty string, but you can't set it to null . For more information + // about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. If any one of the tags is not valid or if you // exceed the maximum allowed number of tags for an account, then the entire // request fails and the account is not created. @@ -197,8 +161,7 @@ type CreateAccountOutput struct { // CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get // status about the progress of the request at later times. You can also check the // CloudTrail log for the CreateAccountResult event. For more information, see - // Monitoring the Activity in Your Organization - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html) + // Monitoring the Activity in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html) // in the Organizations User Guide. CreateAccountStatus *types.CreateAccountStatus diff --git a/service/organizations/api_op_CreateGovCloudAccount.go b/service/organizations/api_op_CreateGovCloudAccount.go index 15ec9592125..5f97dd005fc 100644 --- a/service/organizations/api_op_CreateGovCloudAccount.go +++ b/service/organizations/api_op_CreateGovCloudAccount.go @@ -12,127 +12,100 @@ import ( ) // This action is available if all of the following are true: +// - You're authorized to create accounts in the Amazon Web Services GovCloud +// (US) Region. For more information on the Amazon Web Services GovCloud (US) +// Region, see the Amazon Web Services GovCloud User Guide. (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html) +// - You already have an account in the Amazon Web Services GovCloud (US) Region +// that is paired with a management account of an organization in the commercial +// Region. +// - You call this action from the management account of your organization in +// the commercial Region. +// - You have the organizations:CreateGovCloudAccount permission. // -// * You're authorized -// to create accounts in the Amazon Web Services GovCloud (US) Region. For more -// information on the Amazon Web Services GovCloud (US) Region, see the Amazon Web -// Services GovCloud User Guide. -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html) -// -// * You -// already have an account in the Amazon Web Services GovCloud (US) Region that is -// paired with a management account of an organization in the commercial Region. -// -// * -// You call this action from the management account of your organization in the -// commercial Region. -// -// * You have the organizations:CreateGovCloudAccount -// permission. -// -// Organizations automatically creates the required service-linked -// role named AWSServiceRoleForOrganizations. For more information, see -// Organizations and Service-Linked Roles -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs) +// Organizations automatically creates the required service-linked role named +// AWSServiceRoleForOrganizations . For more information, see Organizations and +// Service-Linked Roles (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs) // in the Organizations User Guide. Amazon Web Services automatically enables // CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also // do the following: +// - Verify that CloudTrail is enabled to store logs. +// - Create an Amazon S3 bucket for CloudTrail log storage. For more +// information, see Verifying CloudTrail Is Enabled (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html) +// in the Amazon Web Services GovCloud User Guide. // -// * Verify that CloudTrail is enabled to store logs. -// -// * Create -// an Amazon S3 bucket for CloudTrail log storage. For more information, see -// Verifying CloudTrail Is Enabled -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html) -// in the Amazon Web Services GovCloud User Guide. -// -// If the request includes tags, -// then the requester must have the organizations:TagResource permission. The tags -// are attached to the commercial account associated with the GovCloud account, -// rather than the GovCloud account itself. To add tags to the GovCloud account, -// call the TagResource operation in the GovCloud Region after the new GovCloud -// account exists. You call this action from the management account of your -// organization in the commercial Region to create a standalone Amazon Web Services -// account in the Amazon Web Services GovCloud (US) Region. After the account is -// created, the management account of an organization in the Amazon Web Services -// GovCloud (US) Region can invite it to that organization. For more information on -// inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an -// organization, see Organizations -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) -// in the Amazon Web Services GovCloud User Guide. Calling CreateGovCloudAccount is -// an asynchronous request that Amazon Web Services performs in the background. +// If the request includes tags, then the requester must have the +// organizations:TagResource permission. The tags are attached to the commercial +// account associated with the GovCloud account, rather than the GovCloud account +// itself. To add tags to the GovCloud account, call the TagResource operation in +// the GovCloud Region after the new GovCloud account exists. You call this action +// from the management account of your organization in the commercial Region to +// create a standalone Amazon Web Services account in the Amazon Web Services +// GovCloud (US) Region. After the account is created, the management account of an +// organization in the Amazon Web Services GovCloud (US) Region can invite it to +// that organization. For more information on inviting standalone accounts in the +// Amazon Web Services GovCloud (US) to join an organization, see Organizations (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) +// in the Amazon Web Services GovCloud User Guide. Calling CreateGovCloudAccount +// is an asynchronous request that Amazon Web Services performs in the background. // Because CreateGovCloudAccount operates asynchronously, it can return a // successful completion message even though account initialization might still be // in progress. You might need to wait a few minutes before you can successfully -// access the account. To check the status of the request, do one of the -// following: +// access the account. To check the status of the request, do one of the following: // -// * Use the OperationId response element from this operation to -// provide as a parameter to the DescribeCreateAccountStatus operation. +// - Use the OperationId response element from this operation to provide as a +// parameter to the DescribeCreateAccountStatus operation. +// - Check the CloudTrail log for the CreateAccountResult event. For information +// on using CloudTrail with Organizations, see Monitoring the Activity in Your +// Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html) +// in the Organizations User Guide. // -// * Check -// the CloudTrail log for the CreateAccountResult event. For information on using -// CloudTrail with Organizations, see Monitoring the Activity in Your Organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html) -// in the Organizations User Guide. -// -// When you call the CreateGovCloudAccount -// action, you create two accounts: a standalone account in the Amazon Web Services -// GovCloud (US) Region and an associated account in the commercial Region for -// billing and support purposes. The account in the commercial Region is -// automatically a member of the organization whose credentials made the request. -// Both accounts are associated with the same email address. A role is created in -// the new account in the commercial Region that allows the management account in -// the organization in the commercial Region to assume it. An Amazon Web Services -// GovCloud (US) account is then created and associated with the commercial account -// that you just created. A role is also created in the new Amazon Web Services -// GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud -// (US) account that is associated with the management account of the commercial -// organization. For more information and to view a diagram that explains how -// account access works, see Organizations -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) +// When you call the CreateGovCloudAccount action, you create two accounts: a +// standalone account in the Amazon Web Services GovCloud (US) Region and an +// associated account in the commercial Region for billing and support purposes. +// The account in the commercial Region is automatically a member of the +// organization whose credentials made the request. Both accounts are associated +// with the same email address. A role is created in the new account in the +// commercial Region that allows the management account in the organization in the +// commercial Region to assume it. An Amazon Web Services GovCloud (US) account is +// then created and associated with the commercial account that you just created. A +// role is also created in the new Amazon Web Services GovCloud (US) account that +// can be assumed by the Amazon Web Services GovCloud (US) account that is +// associated with the management account of the commercial organization. For more +// information and to view a diagram that explains how account access works, see +// Organizations (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) // in the Amazon Web Services GovCloud User Guide. For more information about // creating accounts, see Creating an Amazon Web Services account in Your -// Organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) -// in the Organizations User Guide. -// -// * When you create an account in an -// organization using the Organizations console, API, or CLI commands, the -// information required for the account to operate as a standalone account is not -// automatically collected. This includes a payment method and signing the end user -// license agreement (EULA). If you must remove an account from your organization -// later, you can do so only after you provide the missing information. Follow the -// steps at To leave an organization as a member account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) // in the Organizations User Guide. +// - When you create an account in an organization using the Organizations +// console, API, or CLI commands, the information required for the account to +// operate as a standalone account is not automatically collected. This includes a +// payment method and signing the end user license agreement (EULA). If you must +// remove an account from your organization later, you can do so only after you +// provide the missing information. Follow the steps at To leave an organization +// as a member account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - If you get an exception that indicates that you exceeded your account +// limits for the organization, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . +// - If you get an exception that indicates that the operation failed because +// your organization is still initializing, wait one hour and then try again. If +// the error persists, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . +// - Using CreateGovCloudAccount to create multiple temporary accounts isn't +// recommended. You can only close an account from the Amazon Web Services Billing +// and Cost Management console, and you must be signed in as the root user. For +// information on the requirements and process for closing an account, see +// Closing an Amazon Web Services account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) +// in the Organizations User Guide. // -// * If you get an exception that indicates that -// you exceeded your account limits for the organization, contact Amazon Web -// Services Support (https://console.aws.amazon.com/support/home#/). -// -// * If you get -// an exception that indicates that the operation failed because your organization -// is still initializing, wait one hour and then try again. If the error persists, -// contact Amazon Web Services Support -// (https://console.aws.amazon.com/support/home#/). -// -// * Using CreateGovCloudAccount -// to create multiple temporary accounts isn't recommended. You can only close an -// account from the Amazon Web Services Billing and Cost Management console, and -// you must be signed in as the root user. For information on the requirements and -// process for closing an account, see Closing an Amazon Web Services account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) -// in the Organizations User Guide. -// -// When you create a member account with this -// operation, you can choose whether to create the account with the IAM User and -// Role Access to Billing Information switch enabled. If you enable it, IAM users -// and roles that have appropriate permissions can view billing information for the -// account. If you disable it, only the account root user can access billing -// information. For information about how to disable this switch for an account, -// see Granting Access to Your Billing Information and Tools -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html). +// When you create a member account with this operation, you can choose whether to +// create the account with the IAM User and Role Access to Billing Information +// switch enabled. If you enable it, IAM users and roles that have appropriate +// permissions can view billing information for the account. If you disable it, +// only the account root user can access billing information. For information about +// how to disable this switch for an account, see Granting Access to Your Billing +// Information and Tools (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html) +// . func (c *Client) CreateGovCloudAccount(ctx context.Context, params *CreateGovCloudAccountInput, optFns ...func(*Options)) (*CreateGovCloudAccountOutput, error) { if params == nil { params = &CreateGovCloudAccountInput{} @@ -161,48 +134,33 @@ type CreateGovCloudAccountInput struct { // the commercial Region. This email address must not already be associated with // another Amazon Web Services account. You must use a valid email address to // complete account creation. The rules for a valid email address: - // - // * The address - // must be a minimum of 6 and a maximum of 64 characters long. - // - // * All characters - // must be 7-bit ASCII characters. - // - // * There must be one and only one @ symbol, - // which separates the local name from the domain name. - // - // * The local name can't - // contain any of the following characters: whitespace, " ' ( ) < > [ ] : ; , \ | % - // & - // - // * The local name can't begin with a dot (.) - // - // * The domain name can consist of - // only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) - // - // * The domain name - // can't begin or end with a hyphen (-) or dot (.) - // - // * The domain name must contain - // at least one dot - // - // You can't access the root user of the account or remove an - // account that was created with an invalid email address. Like all request - // parameters for CreateGovCloudAccount, the request for the email address for the - // Amazon Web Services GovCloud (US) account originates from the commercial Region, - // not from the Amazon Web Services GovCloud (US) Region. + // - The address must be a minimum of 6 and a maximum of 64 characters long. + // - All characters must be 7-bit ASCII characters. + // - There must be one and only one @ symbol, which separates the local name + // from the domain name. + // - The local name can't contain any of the following characters: whitespace, " + // ' ( ) < > [ ] : ; , \ | % & + // - The local name can't begin with a dot (.) + // - The domain name can consist of only the characters [a-z],[A-Z],[0-9], + // hyphen (-), or dot (.) + // - The domain name can't begin or end with a hyphen (-) or dot (.) + // - The domain name must contain at least one dot + // You can't access the root user of the account or remove an account that was + // created with an invalid email address. Like all request parameters for + // CreateGovCloudAccount , the request for the email address for the Amazon Web + // Services GovCloud (US) account originates from the commercial Region, not from + // the Amazon Web Services GovCloud (US) Region. // // This member is required. Email *string - // If set to ALLOW, the new linked account in the commercial Region enables IAM + // If set to ALLOW , the new linked account in the commercial Region enables IAM // users to access account billing information if they have the required - // permissions. If set to DENY, only the root user of the new account can access + // permissions. If set to DENY , only the root user of the new account can access // account billing information. For more information, see Activating Access to the - // Billing and Cost Management Console - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) + // Billing and Cost Management Console (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) // in the Amazon Web Services Billing and Cost Management User Guide. If you don't - // specify this parameter, the value defaults to ALLOW, and IAM users and roles + // specify this parameter, the value defaults to ALLOW , and IAM users and roles // with the required permissions can access billing information for the new // account. IamUserAccessToBilling types.IAMUserAccessToBilling @@ -213,13 +171,11 @@ type CreateGovCloudAccountInput struct { // management account, allowing users in the management account to assume the role, // as permitted by the management account administrator. The role has administrator // permissions in the new member account. If you don't specify this parameter, the - // role name defaults to OrganizationAccountAccessRole. For more information about + // role name defaults to OrganizationAccountAccessRole . For more information about // how to use this role to access the member account, see Accessing and - // Administering the Member Accounts in Your Organization - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) + // Administering the Member Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) // in the Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access - // Across Amazon Web Services accounts Using IAM Roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) + // Across Amazon Web Services accounts Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) // in the IAM User Guide. The regex pattern (http://wikipedia.org/wiki/regex) that // is used to validate this parameter. The pattern can include uppercase letters, // lowercase letters, digits with no spaces, and any of the following characters: @@ -231,9 +187,8 @@ type CreateGovCloudAccountInput struct { // not to the GovCloud account itself. To add tags to the actual GovCloud account, // call the TagResource operation in the GovCloud region after the new GovCloud // account exists. For each tag in the list, you must specify both a tag key and a - // value. You can set the value to an empty string, but you can't set it to null. - // For more information about tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // value. You can set the value to an empty string, but you can't set it to null . + // For more information about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. If any one of the tags is not valid or if you // exceed the maximum allowed number of tags for an account, then the entire // request fails and the account is not created. diff --git a/service/organizations/api_op_CreateOrganization.go b/service/organizations/api_op_CreateOrganization.go index f677eb902de..c308c3cf829 100644 --- a/service/organizations/api_op_CreateOrganization.go +++ b/service/organizations/api_op_CreateOrganization.go @@ -12,17 +12,16 @@ import ( ) // Creates an Amazon Web Services organization. The account whose user is calling -// the CreateOrganization operation automatically becomes the management account -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) +// the CreateOrganization operation automatically becomes the management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // of the new organization. This operation must be called using credentials from // the account that is to become the new organization's management account. The // principal must also have the relevant IAM permissions. By default (or if you set -// the FeatureSet parameter to ALL), the new organization is created with all +// the FeatureSet parameter to ALL ), the new organization is created with all // features enabled and service control policies automatically enabled in the root. // If you instead choose to create the organization supporting only the // consolidated billing features by setting the FeatureSet parameter to -// CONSOLIDATED_BILLING", no policy types are enabled by default, and you can't use -// organization policies +// CONSOLIDATED_BILLING" , no policy types are enabled by default, and you can't +// use organization policies func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error) { if params == nil { params = &CreateOrganizationInput{} @@ -42,20 +41,15 @@ type CreateOrganizationInput struct { // Specifies the feature set supported by the new organization. Each feature set // supports different levels of functionality. - // - // * CONSOLIDATED_BILLING: All member - // accounts have their bills consolidated to and paid by the management account. - // For more information, see Consolidated billing - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only) - // in the Organizations User Guide. The consolidated billing feature subset isn't - // available for organizations in the Amazon Web Services GovCloud (US) Region. - // - // * - // ALL: In addition to all the features supported by the consolidated billing - // feature set, the management account can also apply any policy type to any member - // account in the organization. For more information, see All features - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all) - // in the Organizations User Guide. + // - CONSOLIDATED_BILLING : All member accounts have their bills consolidated to + // and paid by the management account. For more information, see Consolidated + // billing (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only) + // in the Organizations User Guide. The consolidated billing feature subset isn't + // available for organizations in the Amazon Web Services GovCloud (US) Region. + // - ALL : In addition to all the features supported by the consolidated billing + // feature set, the management account can also apply any policy type to any member + // account in the organization. For more information, see All features (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all) + // in the Organizations User Guide. FeatureSet types.OrganizationFeatureSet noSmithyDocumentSerde diff --git a/service/organizations/api_op_CreateOrganizationalUnit.go b/service/organizations/api_op_CreateOrganizationalUnit.go index 513e389cbbd..53594fc43ad 100644 --- a/service/organizations/api_op_CreateOrganizationalUnit.go +++ b/service/organizations/api_op_CreateOrganizationalUnit.go @@ -16,11 +16,10 @@ import ( // policies according to your business requirements. The number of levels deep that // you can nest OUs is dependent upon the policy types enabled for that root. For // service control policies, the limit is five. For more information about OUs, see -// Managing Organizational Units -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) +// Managing Organizational Units (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) // in the Organizations User Guide. If the request includes tags, then the -// requester must have the organizations:TagResource permission. This operation can -// be called only from the organization's management account. +// requester must have the organizations:TagResource permission. This operation +// can be called only from the organization's management account. func (c *Client) CreateOrganizationalUnit(ctx context.Context, params *CreateOrganizationalUnitInput, optFns ...func(*Options)) (*CreateOrganizationalUnitOutput, error) { if params == nil { params = &CreateOrganizationalUnitInput{} @@ -46,24 +45,20 @@ type CreateOrganizationalUnitInput struct { // The unique identifier (ID) of the parent root or OU that you want to create the // new OU in. The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID // string requires one of the following: - // - // * Root - A string that begins with "r-" - // followed by from 4 to 32 lowercase letters or digits. - // - // * Organizational unit - // (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase - // letters or digits (the ID of the root that the OU is in). This string is - // followed by a second "-" dash and from 8 to 32 additional lowercase letters or - // digits. + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. ParentId *string // A list of tags that you want to attach to the newly created OU. For each tag in // the list, you must specify both a tag key and a value. You can set the value to - // an empty string, but you can't set it to null. For more information about - // tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // an empty string, but you can't set it to null . For more information about + // tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. If any one of the tags is not valid or if you // exceed the allowed number of tags for an OU, then the entire request fails and // the OU is not created. diff --git a/service/organizations/api_op_CreatePolicy.go b/service/organizations/api_op_CreatePolicy.go index c7d5e6e53b7..49416930457 100644 --- a/service/organizations/api_op_CreatePolicy.go +++ b/service/organizations/api_op_CreatePolicy.go @@ -13,9 +13,8 @@ import ( // Creates a policy of a specified type that you can attach to a root, an // organizational unit (OU), or an individual Amazon Web Services account. For more -// information about policies and their use, see Managing Organization Policies -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html). -// If the request includes tags, then the requester must have the +// information about policies and their use, see Managing Organization Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html) +// . If the request includes tags, then the requester must have the // organizations:TagResource permission. This operation can be called only from the // organization's management account. func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { @@ -46,39 +45,26 @@ type CreatePolicyInput struct { // This member is required. Description *string - // The friendly name to assign to the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name to assign to the policy. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. // // This member is required. Name *string // The type of policy to create. You can specify one of the following values: - // - // * - // AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // SERVICE_CONTROL_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. Type types.PolicyType - // A list of tags that you want to attach to the newly created policy. For each tag - // in the list, you must specify both a tag key and a value. You can set the value - // to an empty string, but you can't set it to null. For more information about - // tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // A list of tags that you want to attach to the newly created policy. For each + // tag in the list, you must specify both a tag key and a value. You can set the + // value to an empty string, but you can't set it to null . For more information + // about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. If any one of the tags is not valid or if you // exceed the allowed number of tags for a policy, then the entire request fails // and the policy is not created. diff --git a/service/organizations/api_op_DeclineHandshake.go b/service/organizations/api_op_DeclineHandshake.go index c1e065ba1ab..91232d91135 100644 --- a/service/organizations/api_op_DeclineHandshake.go +++ b/service/organizations/api_op_DeclineHandshake.go @@ -36,9 +36,9 @@ func (c *Client) DeclineHandshake(ctx context.Context, params *DeclineHandshakeI type DeclineHandshakeInput struct { // The unique identifier (ID) of the handshake that you want to decline. You can - // get the ID from the ListHandshakesForAccount operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed - // by from 8 to 32 lowercase letters or digits. + // get the ID from the ListHandshakesForAccount operation. The regex pattern (http://wikipedia.org/wiki/regex) + // for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters + // or digits. // // This member is required. HandshakeId *string @@ -49,7 +49,7 @@ type DeclineHandshakeInput struct { type DeclineHandshakeOutput struct { // A structure that contains details about the declined handshake. The state is - // updated to show the value DECLINED. + // updated to show the value DECLINED . Handshake *types.Handshake // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_DeregisterDelegatedAdministrator.go b/service/organizations/api_op_DeregisterDelegatedAdministrator.go index 1b7345202d1..5d4613f5c1f 100644 --- a/service/organizations/api_op_DeregisterDelegatedAdministrator.go +++ b/service/organizations/api_op_DeregisterDelegatedAdministrator.go @@ -18,8 +18,7 @@ import ( // any potential impacts. You can run this action only for Amazon Web Services // services that support this feature. For a current list of services that support // it, see the column Supports Delegated Administrator in the table at Amazon Web -// Services Services that you can use with Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) +// Services Services that you can use with Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) // in the Organizations User Guide. This operation can be called only from the // organization's management account. func (c *Client) DeregisterDelegatedAdministrator(ctx context.Context, params *DeregisterDelegatedAdministratorInput, optFns ...func(*Options)) (*DeregisterDelegatedAdministratorOutput, error) { @@ -39,8 +38,8 @@ func (c *Client) DeregisterDelegatedAdministrator(ctx context.Context, params *D type DeregisterDelegatedAdministratorInput struct { - // The account ID number of the member account in the organization that you want to - // deregister as a delegated administrator. + // The account ID number of the member account in the organization that you want + // to deregister as a delegated administrator. // // This member is required. AccountId *string diff --git a/service/organizations/api_op_DescribeAccount.go b/service/organizations/api_op_DescribeAccount.go index 8fd59a4650d..817c838cdd7 100644 --- a/service/organizations/api_op_DescribeAccount.go +++ b/service/organizations/api_op_DescribeAccount.go @@ -34,9 +34,8 @@ type DescribeAccountInput struct { // The unique identifier (ID) of the Amazon Web Services account that you want // information about. You can get the ID from the ListAccounts or - // ListAccountsForParent operations. The regex pattern - // (http://wikipedia.org/wiki/regex) for an account ID string requires exactly 12 - // digits. + // ListAccountsForParent operations. The regex pattern (http://wikipedia.org/wiki/regex) + // for an account ID string requires exactly 12 digits. // // This member is required. AccountId *string diff --git a/service/organizations/api_op_DescribeEffectivePolicy.go b/service/organizations/api_op_DescribeEffectivePolicy.go index 495f1b75b1c..4995b12fe79 100644 --- a/service/organizations/api_op_DescribeEffectivePolicy.go +++ b/service/organizations/api_op_DescribeEffectivePolicy.go @@ -16,8 +16,7 @@ import ( // specified type that the account inherits, plus any policy of that type that is // directly attached to the account. This operation applies only to policy types // other than service control policies (SCPs). For more information about policy -// inheritance, see How Policy Inheritance Works -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies-inheritance.html) +// inheritance, see How Policy Inheritance Works (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies-inheritance.html) // in the Organizations User Guide. This operation can be called only from the // organization's management account or by a member account that is a delegated // administrator for an Amazon Web Services service. @@ -40,17 +39,9 @@ type DescribeEffectivePolicyInput struct { // The type of policy that you want information about. You can specify one of the // following values: - // - // * AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. PolicyType types.EffectivePolicyType diff --git a/service/organizations/api_op_DescribeHandshake.go b/service/organizations/api_op_DescribeHandshake.go index a2519c5f058..de421ac91e8 100644 --- a/service/organizations/api_op_DescribeHandshake.go +++ b/service/organizations/api_op_DescribeHandshake.go @@ -13,10 +13,10 @@ import ( // Retrieves information about a previously requested handshake. The handshake ID // comes from the response to the original InviteAccountToOrganization operation -// that generated the handshake. You can access handshakes that are ACCEPTED, -// DECLINED, or CANCELED for only 30 days after they change to that state. They're -// then deleted and no longer accessible. This operation can be called from any -// account in the organization. +// that generated the handshake. You can access handshakes that are ACCEPTED , +// DECLINED , or CANCELED for only 30 days after they change to that state. +// They're then deleted and no longer accessible. This operation can be called from +// any account in the organization. func (c *Client) DescribeHandshake(ctx context.Context, params *DescribeHandshakeInput, optFns ...func(*Options)) (*DescribeHandshakeOutput, error) { if params == nil { params = &DescribeHandshakeInput{} @@ -34,11 +34,11 @@ func (c *Client) DescribeHandshake(ctx context.Context, params *DescribeHandshak type DescribeHandshakeInput struct { - // The unique identifier (ID) of the handshake that you want information about. You - // can get the ID from the original call to InviteAccountToOrganization, or from a - // call to ListHandshakesForAccount or ListHandshakesForOrganization. The regex - // pattern (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" - // followed by from 8 to 32 lowercase letters or digits. + // The unique identifier (ID) of the handshake that you want information about. + // You can get the ID from the original call to InviteAccountToOrganization , or + // from a call to ListHandshakesForAccount or ListHandshakesForOrganization . The + // regex pattern (http://wikipedia.org/wiki/regex) for handshake ID string requires + // "h-" followed by from 8 to 32 lowercase letters or digits. // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_DescribeOrganization.go b/service/organizations/api_op_DescribeOrganization.go index 28e21862968..fe55ae8b61c 100644 --- a/service/organizations/api_op_DescribeOrganization.go +++ b/service/organizations/api_op_DescribeOrganization.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the organization that the user's account belongs to. -// This operation can be called from any account in the organization. Even if a +// Retrieves information about the organization that the user's account belongs +// to. This operation can be called from any account in the organization. Even if a // policy type is shown as available in the organization, you can disable it -// separately at the root level with DisablePolicyType. Use ListRoots to see the +// separately at the root level with DisablePolicyType . Use ListRoots to see the // status of policy types for a specified root. func (c *Client) DescribeOrganization(ctx context.Context, params *DescribeOrganizationInput, optFns ...func(*Options)) (*DescribeOrganizationOutput, error) { if params == nil { diff --git a/service/organizations/api_op_DescribePolicy.go b/service/organizations/api_op_DescribePolicy.go index ba8baf073ad..c9b1e2f09ae 100644 --- a/service/organizations/api_op_DescribePolicy.go +++ b/service/organizations/api_op_DescribePolicy.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a policy. This operation can be called only from the -// organization's management account or by a member account that is a delegated +// Retrieves information about a policy. This operation can be called only from +// the organization's management account or by a member account that is a delegated // administrator for an Amazon Web Services service. func (c *Client) DescribePolicy(ctx context.Context, params *DescribePolicyInput, optFns ...func(*Options)) (*DescribePolicyOutput, error) { if params == nil { diff --git a/service/organizations/api_op_DetachPolicy.go b/service/organizations/api_op_DetachPolicy.go index acda0e73b15..2784b247922 100644 --- a/service/organizations/api_op_DetachPolicy.go +++ b/service/organizations/api_op_DetachPolicy.go @@ -17,14 +17,12 @@ import ( // attached. If you want to replace the default FullAWSAccess policy with an SCP // that limits the permissions that can be delegated, you must attach the // replacement SCP before you can remove the default SCP. This is the authorization -// strategy of an "allow list -// (https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist)". -// If you instead attach a second SCP and leave the FullAWSAccess SCP still +// strategy of an " allow list (https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist) +// ". If you instead attach a second SCP and leave the FullAWSAccess SCP still // attached, and specify "Effect": "Deny" in the second SCP to override the // "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), -// you're using the authorization strategy of a "deny list -// (https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist)". -// This operation can be called only from the organization's management account. +// you're using the authorization strategy of a " deny list (https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist) +// ". This operation can be called only from the organization's management account. func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error) { if params == nil { params = &DetachPolicyInput{} @@ -43,30 +41,24 @@ func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, op type DetachPolicyInput struct { // The unique identifier (ID) of the policy you want to detach. You can get the ID - // from the ListPolicies or ListPoliciesForTarget operations. The regex pattern - // (http://wikipedia.org/wiki/regex) for a policy ID string requires "p-" followed - // by from 8 to 128 lowercase or uppercase letters, digits, or the underscore - // character (_). + // from the ListPolicies or ListPoliciesForTarget operations. The regex pattern (http://wikipedia.org/wiki/regex) + // for a policy ID string requires "p-" followed by from 8 to 128 lowercase or + // uppercase letters, digits, or the underscore character (_). // // This member is required. PolicyId *string // The unique identifier (ID) of the root, OU, or account that you want to detach - // the policy from. You can get the ID from the ListRoots, - // ListOrganizationalUnitsForParent, or ListAccounts operations. The regex pattern - // (http://wikipedia.org/wiki/regex) for a target ID string requires one of the - // following: - // - // * Root - A string that begins with "r-" followed by from 4 to 32 - // lowercase letters or digits. - // - // * Account - A string that consists of exactly 12 - // digits. - // - // * Organizational unit (OU) - A string that begins with "ou-" followed - // by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is - // in). This string is followed by a second "-" dash and from 8 to 32 additional - // lowercase letters or digits. + // the policy from. You can get the ID from the ListRoots , + // ListOrganizationalUnitsForParent , or ListAccounts operations. The regex pattern (http://wikipedia.org/wiki/regex) + // for a target ID string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. TargetId *string diff --git a/service/organizations/api_op_DisableAWSServiceAccess.go b/service/organizations/api_op_DisableAWSServiceAccess.go index c3ca506bd7f..0461a340c1d 100644 --- a/service/organizations/api_op_DisableAWSServiceAccess.go +++ b/service/organizations/api_op_DisableAWSServiceAccess.go @@ -11,9 +11,8 @@ import ( ) // Disables the integration of an Amazon Web Services service (the service that is -// specified by ServicePrincipal) with Organizations. When you disable integration, -// the specified service no longer can create a service-linked role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) +// specified by ServicePrincipal ) with Organizations. When you disable +// integration, the specified service no longer can create a service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) // in new accounts in your organization. This means the service can't perform // operations on your behalf on any new accounts in your organization. The service // can still perform operations in older accounts until the service completes its @@ -26,40 +25,34 @@ import ( // For information about how to disable trusted service access to your organization // using the trusted service, see the Learn more link under the Supports Trusted // Access column at Amazon Web Services services that you can use with -// Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html). -// on this page. If you disable access by using this command, it causes the +// Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) +// . on this page. If you disable access by using this command, it causes the // following actions to occur: +// - The service can no longer create a service-linked role in the accounts in +// your organization. This means that the service can't perform operations on your +// behalf on any new accounts in your organization. The service can still perform +// operations in older accounts until the service completes its clean-up from +// Organizations. +// - The service can no longer perform tasks in the member accounts in the +// organization, unless those operations are explicitly permitted by the IAM +// policies that are attached to your roles. This includes any data aggregation +// from the member accounts to the management account, or to a delegated +// administrator account, where relevant. +// - Some services detect this and clean up any remaining data or resources +// related to the integration, while other services stop accessing the organization +// but leave any historical data and configuration in place to support a possible +// re-enabling of the integration. // -// * The service can no longer create a service-linked -// role in the accounts in your organization. This means that the service can't -// perform operations on your behalf on any new accounts in your organization. The -// service can still perform operations in older accounts until the service -// completes its clean-up from Organizations. -// -// * The service can no longer perform -// tasks in the member accounts in the organization, unless those operations are -// explicitly permitted by the IAM policies that are attached to your roles. This -// includes any data aggregation from the member accounts to the management -// account, or to a delegated administrator account, where relevant. -// -// * Some -// services detect this and clean up any remaining data or resources related to the -// integration, while other services stop accessing the organization but leave any -// historical data and configuration in place to support a possible re-enabling of -// the integration. -// -// Using the other service's console or commands to disable the -// integration ensures that the other service is aware that it can clean up any -// resources that are required only for the integration. How the service cleans up -// its resources in the organization's accounts depends on that service. For more -// information, see the documentation for the other Amazon Web Services service. -// After you perform the DisableAWSServiceAccess operation, the specified service -// can no longer perform operations in your organization's accounts For more -// information about integrating other services with Organizations, including the -// list of services that work with Organizations, see Integrating Organizations -// with Other Amazon Web Services Services -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) +// Using the other service's console or commands to disable the integration +// ensures that the other service is aware that it can clean up any resources that +// are required only for the integration. How the service cleans up its resources +// in the organization's accounts depends on that service. For more information, +// see the documentation for the other Amazon Web Services service. After you +// perform the DisableAWSServiceAccess operation, the specified service can no +// longer perform operations in your organization's accounts For more information +// about integrating other services with Organizations, including the list of +// services that work with Organizations, see Integrating Organizations with Other +// Amazon Web Services Services (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) // in the Organizations User Guide. This operation can be called only from the // organization's management account. func (c *Client) DisableAWSServiceAccess(ctx context.Context, params *DisableAWSServiceAccessInput, optFns ...func(*Options)) (*DisableAWSServiceAccessOutput, error) { @@ -79,9 +72,9 @@ func (c *Client) DisableAWSServiceAccess(ctx context.Context, params *DisableAWS type DisableAWSServiceAccessInput struct { - // The service principal name of the Amazon Web Services service for which you want - // to disable integration with your organization. This is typically in the form of - // a URL, such as service-abbreviation.amazonaws.com. + // The service principal name of the Amazon Web Services service for which you + // want to disable integration with your organization. This is typically in the + // form of a URL, such as service-abbreviation.amazonaws.com . // // This member is required. ServicePrincipal *string diff --git a/service/organizations/api_op_DisablePolicyType.go b/service/organizations/api_op_DisablePolicyType.go index ec158ffd078..2f4e39d9487 100644 --- a/service/organizations/api_op_DisablePolicyType.go +++ b/service/organizations/api_op_DisablePolicyType.go @@ -11,20 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables an organizational policy type in a root. A policy of a certain type can -// be attached to entities in a root only if that type is enabled in the root. +// Disables an organizational policy type in a root. A policy of a certain type +// can be attached to entities in a root only if that type is enabled in the root. // After you perform this operation, you no longer can attach policies of the // specified type to that root or to any organizational unit (OU) or account in -// that root. You can undo this by using the EnablePolicyType operation. This is an -// asynchronous request that Amazon Web Services performs in the background. If you -// disable a policy type for a root, it still appears enabled for the organization -// if all features -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// that root. You can undo this by using the EnablePolicyType operation. This is +// an asynchronous request that Amazon Web Services performs in the background. If +// you disable a policy type for a root, it still appears enabled for the +// organization if all features (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) // are enabled for the organization. Amazon Web Services recommends that you first // use ListRoots to see the status of policy types for a specified root, and then // use this operation. This operation can be called only from the organization's // management account. To view the status of available policy types in the -// organization, use DescribeOrganization. +// organization, use DescribeOrganization . func (c *Client) DisablePolicyType(ctx context.Context, params *DisablePolicyTypeInput, optFns ...func(*Options)) (*DisablePolicyTypeOutput, error) { if params == nil { params = &DisablePolicyTypeInput{} @@ -44,29 +43,18 @@ type DisablePolicyTypeInput struct { // The policy type that you want to disable in this root. You can specify one of // the following values: - // - // * AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // SERVICE_CONTROL_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. PolicyType types.PolicyType // The unique identifier (ID) of the root in which you want to disable a policy - // type. You can get the ID from the ListRoots operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by - // from 4 to 32 lowercase letters or digits. + // type. You can get the ID from the ListRoots operation. The regex pattern (http://wikipedia.org/wiki/regex) + // for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or + // digits. // // This member is required. RootId *string diff --git a/service/organizations/api_op_EnableAWSServiceAccess.go b/service/organizations/api_op_EnableAWSServiceAccess.go index c51945ae661..56bf2dc3150 100644 --- a/service/organizations/api_op_EnableAWSServiceAccess.go +++ b/service/organizations/api_op_EnableAWSServiceAccess.go @@ -11,9 +11,8 @@ import ( ) // Enables the integration of an Amazon Web Services service (the service that is -// specified by ServicePrincipal) with Organizations. When you enable integration, -// you allow the specified service to create a service-linked role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) +// specified by ServicePrincipal ) with Organizations. When you enable integration, +// you allow the specified service to create a service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html) // in all the accounts in your organization. This allows the service to perform // operations on your behalf in your organization and its accounts. We recommend // that you enable integration between Organizations and the specified Amazon Web @@ -23,12 +22,11 @@ import ( // those resources in the organization's accounts depends on that service. For more // information, see the documentation for the other Amazon Web Services service. // For more information about enabling services to integrate with Organizations, -// see Integrating Organizations with Other Amazon Web Services Services -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) +// see Integrating Organizations with Other Amazon Web Services Services (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) // in the Organizations User Guide. You can only call this operation from the // organization's management account and only if the organization has enabled all -// features -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html). +// features (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// . func (c *Client) EnableAWSServiceAccess(ctx context.Context, params *EnableAWSServiceAccessInput, optFns ...func(*Options)) (*EnableAWSServiceAccessOutput, error) { if params == nil { params = &EnableAWSServiceAccessInput{} @@ -46,9 +44,9 @@ func (c *Client) EnableAWSServiceAccess(ctx context.Context, params *EnableAWSSe type EnableAWSServiceAccessInput struct { - // The service principal name of the Amazon Web Services service for which you want - // to enable integration with your organization. This is typically in the form of a - // URL, such as service-abbreviation.amazonaws.com. + // The service principal name of the Amazon Web Services service for which you + // want to enable integration with your organization. This is typically in the form + // of a URL, such as service-abbreviation.amazonaws.com . // // This member is required. ServicePrincipal *string diff --git a/service/organizations/api_op_EnableAllFeatures.go b/service/organizations/api_op_EnableAllFeatures.go index c6bce8d3709..f28b0fc4c8c 100644 --- a/service/organizations/api_op_EnableAllFeatures.go +++ b/service/organizations/api_op_EnableAllFeatures.go @@ -16,8 +16,7 @@ import ( // account. Until you enable all features, you have access only to consolidated // billing, and you can't use any of the advanced account administration features // that Organizations supports. For more information, see Enabling All Features in -// Your Organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) // in the Organizations User Guide. This operation is required only for // organizations that were created explicitly with only the consolidated billing // features enabled. Calling this operation sends a handshake to every invited @@ -25,10 +24,10 @@ import ( // additional features enabled only after all administrators in the invited // accounts approve the change by accepting the handshake. After you enable all // features, you can separately enable or disable individual policy types in a root -// using EnablePolicyType and DisablePolicyType. To see the status of policy types -// in a root, use ListRoots. After all invited member accounts accept the +// using EnablePolicyType and DisablePolicyType . To see the status of policy types +// in a root, use ListRoots . After all invited member accounts accept the // handshake, you finalize the feature set change by accepting the handshake that -// contains "Action": "ENABLE_ALL_FEATURES". This completes the change. After you +// contains "Action": "ENABLE_ALL_FEATURES" . This completes the change. After you // enable all features in your organization, the management account in the // organization can apply policies on all member accounts. These policies can // restrict what users and even administrators in those accounts can do. The diff --git a/service/organizations/api_op_EnablePolicyType.go b/service/organizations/api_op_EnablePolicyType.go index b83a6b833d2..42630f11227 100644 --- a/service/organizations/api_op_EnablePolicyType.go +++ b/service/organizations/api_op_EnablePolicyType.go @@ -20,7 +20,7 @@ import ( // operation. This operation can be called only from the organization's management // account. You can enable a policy type in a root only if that policy type is // available in the organization. To view the status of available policy types in -// the organization, use DescribeOrganization. +// the organization, use DescribeOrganization . func (c *Client) EnablePolicyType(ctx context.Context, params *EnablePolicyTypeInput, optFns ...func(*Options)) (*EnablePolicyTypeOutput, error) { if params == nil { params = &EnablePolicyTypeInput{} @@ -40,29 +40,18 @@ type EnablePolicyTypeInput struct { // The policy type that you want to enable. You can specify one of the following // values: - // - // * AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // SERVICE_CONTROL_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. PolicyType types.PolicyType // The unique identifier (ID) of the root in which you want to enable a policy - // type. You can get the ID from the ListRoots operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by - // from 4 to 32 lowercase letters or digits. + // type. You can get the ID from the ListRoots operation. The regex pattern (http://wikipedia.org/wiki/regex) + // for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or + // digits. // // This member is required. RootId *string diff --git a/service/organizations/api_op_InviteAccountToOrganization.go b/service/organizations/api_op_InviteAccountToOrganization.go index c6d80cf45eb..06b878d79c9 100644 --- a/service/organizations/api_op_InviteAccountToOrganization.go +++ b/service/organizations/api_op_InviteAccountToOrganization.go @@ -15,26 +15,23 @@ import ( // account. Organizations sends email on your behalf to the email address that is // associated with the other account's owner. The invitation is implemented as a // Handshake whose details are in the response. +// - You can invite Amazon Web Services accounts only from the same seller as +// the management account. For example, if your organization's management account +// was created by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services +// seller in India, you can invite only other AISPL accounts to your organization. +// You can't combine accounts from AISPL and Amazon Web Services or from any other +// Amazon Web Services seller. For more information, see Consolidated Billing in +// India (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html) +// . +// - If you receive an exception that indicates that you exceeded your account +// limits for the organization or that the operation failed because your +// organization is still initializing, wait one hour and then try again. If the +// error persists after an hour, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . // -// * You can invite Amazon Web -// Services accounts only from the same seller as the management account. For -// example, if your organization's management account was created by Amazon -// Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you -// can invite only other AISPL accounts to your organization. You can't combine -// accounts from AISPL and Amazon Web Services or from any other Amazon Web -// Services seller. For more information, see Consolidated Billing in India -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html). -// -// * -// If you receive an exception that indicates that you exceeded your account limits -// for the organization or that the operation failed because your organization is -// still initializing, wait one hour and then try again. If the error persists -// after an hour, contact Amazon Web Services Support -// (https://console.aws.amazon.com/support/home#/). -// -// If the request includes tags, -// then the requester must have the organizations:TagResource permission. This -// operation can be called only from the organization's management account. +// If the request includes tags, then the requester must have the +// organizations:TagResource permission. This operation can be called only from the +// organization's management account. func (c *Client) InviteAccountToOrganization(ctx context.Context, params *InviteAccountToOrganizationInput, optFns ...func(*Options)) (*InviteAccountToOrganizationOutput, error) { if params == nil { params = &InviteAccountToOrganizationInput{} @@ -56,10 +53,10 @@ type InviteAccountToOrganizationInput struct { // to join your organization. This is a JSON object that contains the following // elements: { "Type": "ACCOUNT", "Id": "< account id number >" } If you use the // CLI, you can submit this as a single string, similar to the following example: - // --target Id=123456789012,Type=ACCOUNT If you specify "Type": "ACCOUNT", you must - // provide the Amazon Web Services account ID number as the Id. If you specify - // "Type": "EMAIL", you must specify the email address that is associated with the - // account. --target Id=diego@example.com,Type=EMAIL + // --target Id=123456789012,Type=ACCOUNT If you specify "Type": "ACCOUNT" , you + // must provide the Amazon Web Services account ID number as the Id . If you + // specify "Type": "EMAIL" , you must specify the email address that is associated + // with the account. --target Id=diego@example.com,Type=EMAIL // // This member is required. Target *types.HandshakeParty @@ -71,8 +68,7 @@ type InviteAccountToOrganizationInput struct { // A list of tags that you want to attach to the account when it becomes a member // of the organization. For each tag in the list, you must specify both a tag key // and a value. You can set the value to an empty string, but you can't set it to - // null. For more information about tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // null . For more information about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. Any tags in the request are checked for // compliance with any applicable tag policies when the request is made. The // request is rejected if the tags in the request don't match the requirements of @@ -89,8 +85,8 @@ type InviteAccountToOrganizationInput struct { type InviteAccountToOrganizationOutput struct { - // A structure that contains details about the handshake that is created to support - // this invitation request. + // A structure that contains details about the handshake that is created to + // support this invitation request. Handshake *types.Handshake // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_LeaveOrganization.go b/service/organizations/api_op_LeaveOrganization.go index 04d6113228a..b0ebf1248b6 100644 --- a/service/organizations/api_op_LeaveOrganization.go +++ b/service/organizations/api_op_LeaveOrganization.go @@ -15,56 +15,39 @@ import ( // account as a user in the management account, use RemoveAccountFromOrganization // instead. This operation can be called only from a member account in the // organization. -// -// * The management account in an organization with all features -// enabled can set service control policies (SCPs) that can restrict what -// administrators of member accounts can do. This includes preventing them from -// successfully calling LeaveOrganization and leaving the organization. -// -// * You can -// leave an organization as a member account only if the account is configured with -// the information required to operate as a standalone account. When you create an -// account in an organization using the Organizations console, API, or CLI -// commands, the information required of standalone accounts is not automatically -// collected. For each account that you want to make standalone, you must perform -// the following steps. If any of the steps are already completed for this account, -// that step doesn't appear. -// -// * Choose a support plan -// -// * Provide and verify the -// required contact information -// -// * Provide a current payment method -// -// Amazon Web -// Services uses the payment method to charge for any billable (not free tier) -// Amazon Web Services activity that occurs while the account isn't attached to an -// organization. Follow the steps at To leave an organization when all required -// account information has not yet been provided -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) -// in the Organizations User Guide. -// -// * The account that you want to leave must not -// be a delegated administrator account for any Amazon Web Services service enabled -// for your organization. If the account is a delegated administrator, you must -// first change the delegated administrator account to another account that is -// remaining in the organization. -// -// * You can leave an organization only after you -// enable IAM user access to billing in your account. For more information, see -// Activating Access to the Billing and Cost Management Console -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) -// in the Amazon Web Services Billing and Cost Management User Guide. -// -// * After the -// account leaves the organization, all tags that were attached to the account -// object in the organization are deleted. Amazon Web Services accounts outside of -// an organization do not support tags. -// -// * A newly created account has a waiting -// period before it can be removed from its organization. If you get an error that -// indicates that a wait period is required, then try again in a few days. +// - The management account in an organization with all features enabled can set +// service control policies (SCPs) that can restrict what administrators of member +// accounts can do. This includes preventing them from successfully calling +// LeaveOrganization and leaving the organization. +// - You can leave an organization as a member account only if the account is +// configured with the information required to operate as a standalone account. +// When you create an account in an organization using the Organizations console, +// API, or CLI commands, the information required of standalone accounts is not +// automatically collected. For each account that you want to make standalone, you +// must perform the following steps. If any of the steps are already completed for +// this account, that step doesn't appear. +// - Choose a support plan +// - Provide and verify the required contact information +// - Provide a current payment method Amazon Web Services uses the payment +// method to charge for any billable (not free tier) Amazon Web Services activity +// that occurs while the account isn't attached to an organization. Follow the +// steps at To leave an organization when all required account information has +// not yet been provided (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - The account that you want to leave must not be a delegated administrator +// account for any Amazon Web Services service enabled for your organization. If +// the account is a delegated administrator, you must first change the delegated +// administrator account to another account that is remaining in the organization. +// - You can leave an organization only after you enable IAM user access to +// billing in your account. For more information, see Activating Access to the +// Billing and Cost Management Console (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) +// in the Amazon Web Services Billing and Cost Management User Guide. +// - After the account leaves the organization, all tags that were attached to +// the account object in the organization are deleted. Amazon Web Services accounts +// outside of an organization do not support tags. +// - A newly created account has a waiting period before it can be removed from +// its organization. If you get an error that indicates that a wait period is +// required, then try again in a few days. func (c *Client) LeaveOrganization(ctx context.Context, params *LeaveOrganizationInput, optFns ...func(*Options)) (*LeaveOrganizationOutput, error) { if params == nil { params = &LeaveOrganizationInput{} diff --git a/service/organizations/api_op_ListAWSServiceAccessForOrganization.go b/service/organizations/api_op_ListAWSServiceAccessForOrganization.go index 4dade3bad38..401e2bd705c 100644 --- a/service/organizations/api_op_ListAWSServiceAccessForOrganization.go +++ b/service/organizations/api_op_ListAWSServiceAccessForOrganization.go @@ -12,14 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the Amazon Web Services services that you enabled to integrate -// with your organization. After a service on this list creates the resources that -// it requires for the integration, it can perform operations on your organization -// and its accounts. For more information about integrating other services with -// Organizations, including the list of services that currently work with -// Organizations, see Integrating Organizations with Other Amazon Web Services -// Services -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) +// Returns a list of the Amazon Web Services services that you enabled to +// integrate with your organization. After a service on this list creates the +// resources that it requires for the integration, it can perform operations on +// your organization and its accounts. For more information about integrating other +// services with Organizations, including the list of services that currently work +// with Organizations, see Integrating Organizations with Other Amazon Web +// Services Services (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) // in the Organizations User Guide. This operation can be called only from the // organization's management account or by a member account that is a delegated // administrator for an Amazon Web Services service. @@ -40,15 +39,15 @@ func (c *Client) ListAWSServiceAccessForOrganization(ctx context.Context, params type ListAWSServiceAccessForOrganizationInput struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -70,7 +69,7 @@ type ListAWSServiceAccessForOrganizationOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -147,18 +146,18 @@ type ListAWSServiceAccessForOrganizationAPIClient interface { var _ ListAWSServiceAccessForOrganizationAPIClient = (*Client)(nil) -// ListAWSServiceAccessForOrganizationPaginatorOptions is the paginator options for -// ListAWSServiceAccessForOrganization +// ListAWSServiceAccessForOrganizationPaginatorOptions is the paginator options +// for ListAWSServiceAccessForOrganization type ListAWSServiceAccessForOrganizationPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListAccounts.go b/service/organizations/api_op_ListAccounts.go index e4f1d5aeb72..c2e1e05278d 100644 --- a/service/organizations/api_op_ListAccounts.go +++ b/service/organizations/api_op_ListAccounts.go @@ -38,15 +38,15 @@ func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, op type ListAccountsInput struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -66,7 +66,7 @@ type ListAccountsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -144,15 +144,15 @@ var _ ListAccountsAPIClient = (*Client)(nil) // ListAccountsPaginatorOptions is the paginator options for ListAccounts type ListAccountsPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListAccountsForParent.go b/service/organizations/api_op_ListAccountsForParent.go index 11905f300c6..78da6b5342b 100644 --- a/service/organizations/api_op_ListAccountsForParent.go +++ b/service/organizations/api_op_ListAccountsForParent.go @@ -12,17 +12,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the accounts in an organization that are contained by the specified target -// root or organizational unit (OU). If you specify the root, you get a list of all -// the accounts that aren't in any OU. If you specify an OU, you get a list of all -// the accounts in only that OU and not in any child OUs. To get a list of all -// accounts in the organization, use the ListAccounts operation. Always check the -// NextToken response parameter for a null value when calling a List* operation. -// These operations can occasionally return an empty set of results even when there -// are more results available. The NextToken response parameter value is null only -// when there are no more results to display. This operation can be called only -// from the organization's management account or by a member account that is a -// delegated administrator for an Amazon Web Services service. +// Lists the accounts in an organization that are contained by the specified +// target root or organizational unit (OU). If you specify the root, you get a list +// of all the accounts that aren't in any OU. If you specify an OU, you get a list +// of all the accounts in only that OU and not in any child OUs. To get a list of +// all accounts in the organization, use the ListAccounts operation. Always check +// the NextToken response parameter for a null value when calling a List* +// operation. These operations can occasionally return an empty set of results even +// when there are more results available. The NextToken response parameter value +// is null only when there are no more results to display. This operation can be +// called only from the organization's management account or by a member account +// that is a delegated administrator for an Amazon Web Services service. func (c *Client) ListAccountsForParent(ctx context.Context, params *ListAccountsForParentInput, optFns ...func(*Options)) (*ListAccountsForParentOutput, error) { if params == nil { params = &ListAccountsForParentInput{} @@ -46,15 +46,15 @@ type ListAccountsForParentInput struct { // This member is required. ParentId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -74,7 +74,7 @@ type ListAccountsForParentOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -157,15 +157,15 @@ var _ ListAccountsForParentAPIClient = (*Client)(nil) // ListAccountsForParentPaginatorOptions is the paginator options for // ListAccountsForParent type ListAccountsForParentPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListChildren.go b/service/organizations/api_op_ListChildren.go index af7444c01a9..93010ff5d55 100644 --- a/service/organizations/api_op_ListChildren.go +++ b/service/organizations/api_op_ListChildren.go @@ -44,29 +44,27 @@ type ListChildrenInput struct { ChildType types.ChildType // The unique identifier (ID) for the parent root or OU whose children you want to - // list. The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID string - // requires one of the following: - // - // * Root - A string that begins with "r-" followed - // by from 4 to 32 lowercase letters or digits. - // - // * Organizational unit (OU) - A - // string that begins with "ou-" followed by from 4 to 32 lowercase letters or - // digits (the ID of the root that the OU is in). This string is followed by a - // second "-" dash and from 8 to 32 additional lowercase letters or digits. + // list. The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID + // string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. ParentId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -86,7 +84,7 @@ type ListChildrenOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -167,15 +165,15 @@ var _ ListChildrenAPIClient = (*Client)(nil) // ListChildrenPaginatorOptions is the paginator options for ListChildren type ListChildrenPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListCreateAccountStatus.go b/service/organizations/api_op_ListCreateAccountStatus.go index 5f4387c1f1f..cb95bee9175 100644 --- a/service/organizations/api_op_ListCreateAccountStatus.go +++ b/service/organizations/api_op_ListCreateAccountStatus.go @@ -16,10 +16,10 @@ import ( // currently being tracked for the organization. Always check the NextToken // response parameter for a null value when calling a List* operation. These // operations can occasionally return an empty set of results even when there are -// more results available. The NextToken response parameter value is null only when -// there are no more results to display. This operation can be called only from the -// organization's management account or by a member account that is a delegated -// administrator for an Amazon Web Services service. +// more results available. The NextToken response parameter value is null only +// when there are no more results to display. This operation can be called only +// from the organization's management account or by a member account that is a +// delegated administrator for an Amazon Web Services service. func (c *Client) ListCreateAccountStatus(ctx context.Context, params *ListCreateAccountStatusInput, optFns ...func(*Options)) (*ListCreateAccountStatusOutput, error) { if params == nil { params = &ListCreateAccountStatusInput{} @@ -37,15 +37,15 @@ func (c *Client) ListCreateAccountStatus(ctx context.Context, params *ListCreate type ListCreateAccountStatusInput struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -63,15 +63,15 @@ type ListCreateAccountStatusInput struct { type ListCreateAccountStatusOutput struct { - // A list of objects with details about the requests. Certain elements, such as the - // accountId number, are present in the output only after the account has been + // A list of objects with details about the requests. Certain elements, such as + // the accountId number, are present in the output only after the account has been // successfully created. CreateAccountStatuses []types.CreateAccountStatus // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -151,15 +151,15 @@ var _ ListCreateAccountStatusAPIClient = (*Client)(nil) // ListCreateAccountStatusPaginatorOptions is the paginator options for // ListCreateAccountStatus type ListCreateAccountStatusPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListDelegatedAdministrators.go b/service/organizations/api_op_ListDelegatedAdministrators.go index eff933c1bee..180509ed34d 100644 --- a/service/organizations/api_op_ListDelegatedAdministrators.go +++ b/service/organizations/api_op_ListDelegatedAdministrators.go @@ -33,15 +33,15 @@ func (c *Client) ListDelegatedAdministrators(ctx context.Context, params *ListDe type ListDelegatedAdministratorsInput struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -67,7 +67,7 @@ type ListDelegatedAdministratorsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -147,15 +147,15 @@ var _ ListDelegatedAdministratorsAPIClient = (*Client)(nil) // ListDelegatedAdministratorsPaginatorOptions is the paginator options for // ListDelegatedAdministrators type ListDelegatedAdministratorsPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListDelegatedServicesForAccount.go b/service/organizations/api_op_ListDelegatedServicesForAccount.go index bf1caf3df68..d03bb67070f 100644 --- a/service/organizations/api_op_ListDelegatedServicesForAccount.go +++ b/service/organizations/api_op_ListDelegatedServicesForAccount.go @@ -38,15 +38,15 @@ type ListDelegatedServicesForAccountInput struct { // This member is required. AccountId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -66,7 +66,7 @@ type ListDelegatedServicesForAccountOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -149,15 +149,15 @@ var _ ListDelegatedServicesForAccountAPIClient = (*Client)(nil) // ListDelegatedServicesForAccountPaginatorOptions is the paginator options for // ListDelegatedServicesForAccount type ListDelegatedServicesForAccountPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListHandshakesForAccount.go b/service/organizations/api_op_ListHandshakesForAccount.go index 331c25a3235..991ea8505f1 100644 --- a/service/organizations/api_op_ListHandshakesForAccount.go +++ b/service/organizations/api_op_ListHandshakesForAccount.go @@ -13,13 +13,13 @@ import ( ) // Lists the current handshakes that are associated with the account of the -// requesting user. Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED +// requesting user. Handshakes that are ACCEPTED , DECLINED , CANCELED , or EXPIRED // appear in the results of this API for only 30 days after changing to that state. // After that, they're deleted and no longer accessible. Always check the NextToken // response parameter for a null value when calling a List* operation. These // operations can occasionally return an empty set of results even when there are -// more results available. The NextToken response parameter value is null only when -// there are no more results to display. This operation can be called from any +// more results available. The NextToken response parameter value is null only +// when there are no more results to display. This operation can be called from any // account in the organization. func (c *Client) ListHandshakesForAccount(ctx context.Context, params *ListHandshakesForAccountInput, optFns ...func(*Options)) (*ListHandshakesForAccountOutput, error) { if params == nil { @@ -40,21 +40,21 @@ type ListHandshakesForAccountInput struct { // Filters the handshakes that you want included in the response. The default is // all types. Use the ActionType element to limit the output to only a specified - // type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. + // type, such as INVITE , ENABLE_ALL_FEATURES , or APPROVE_ALL_FEATURES . // Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate // child handshake for each member account, you can specify ParentHandshakeId to // see only the handshakes that were generated by that parent request. Filter *types.HandshakeFilter - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -75,7 +75,7 @@ type ListHandshakesForAccountOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -155,15 +155,15 @@ var _ ListHandshakesForAccountAPIClient = (*Client)(nil) // ListHandshakesForAccountPaginatorOptions is the paginator options for // ListHandshakesForAccount type ListHandshakesForAccountPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListHandshakesForOrganization.go b/service/organizations/api_op_ListHandshakesForOrganization.go index 14573156aeb..5705853ccf5 100644 --- a/service/organizations/api_op_ListHandshakesForOrganization.go +++ b/service/organizations/api_op_ListHandshakesForOrganization.go @@ -15,15 +15,15 @@ import ( // Lists the handshakes that are associated with the organization that the // requesting user is part of. The ListHandshakesForOrganization operation returns // a list of handshake structures. Each structure contains details and status about -// a handshake. Handshakes that are ACCEPTED, DECLINED, CANCELED, or EXPIRED appear -// in the results of this API for only 30 days after changing to that state. After -// that, they're deleted and no longer accessible. Always check the NextToken +// a handshake. Handshakes that are ACCEPTED , DECLINED , CANCELED , or EXPIRED +// appear in the results of this API for only 30 days after changing to that state. +// After that, they're deleted and no longer accessible. Always check the NextToken // response parameter for a null value when calling a List* operation. These // operations can occasionally return an empty set of results even when there are -// more results available. The NextToken response parameter value is null only when -// there are no more results to display. This operation can be called only from the -// organization's management account or by a member account that is a delegated -// administrator for an Amazon Web Services service. +// more results available. The NextToken response parameter value is null only +// when there are no more results to display. This operation can be called only +// from the organization's management account or by a member account that is a +// delegated administrator for an Amazon Web Services service. func (c *Client) ListHandshakesForOrganization(ctx context.Context, params *ListHandshakesForOrganizationInput, optFns ...func(*Options)) (*ListHandshakesForOrganizationOutput, error) { if params == nil { params = &ListHandshakesForOrganizationInput{} @@ -42,22 +42,22 @@ func (c *Client) ListHandshakesForOrganization(ctx context.Context, params *List type ListHandshakesForOrganizationInput struct { // A filter of the handshakes that you want included in the response. The default - // is all types. Use the ActionType element to limit the output to only a specified - // type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. + // is all types. Use the ActionType element to limit the output to only a + // specified type, such as INVITE , ENABLE-ALL-FEATURES , or APPROVE-ALL-FEATURES . // Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate // child handshake for each member account, you can specify the ParentHandshakeId // to see only the handshakes that were generated by that parent request. Filter *types.HandshakeFilter - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -78,7 +78,7 @@ type ListHandshakesForOrganizationOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -158,15 +158,15 @@ var _ ListHandshakesForOrganizationAPIClient = (*Client)(nil) // ListHandshakesForOrganizationPaginatorOptions is the paginator options for // ListHandshakesForOrganization type ListHandshakesForOrganizationPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListOrganizationalUnitsForParent.go b/service/organizations/api_op_ListOrganizationalUnitsForParent.go index ea9d05898ad..c936cab06a7 100644 --- a/service/organizations/api_op_ListOrganizationalUnitsForParent.go +++ b/service/organizations/api_op_ListOrganizationalUnitsForParent.go @@ -40,27 +40,25 @@ type ListOrganizationalUnitsForParentInput struct { // The unique identifier (ID) of the root or OU whose child OUs you want to list. // The regex pattern (http://wikipedia.org/wiki/regex) for a parent ID string // requires one of the following: - // - // * Root - A string that begins with "r-" followed - // by from 4 to 32 lowercase letters or digits. - // - // * Organizational unit (OU) - A - // string that begins with "ou-" followed by from 4 to 32 lowercase letters or - // digits (the ID of the root that the OU is in). This string is followed by a - // second "-" dash and from 8 to 32 additional lowercase letters or digits. + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. ParentId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -77,7 +75,7 @@ type ListOrganizationalUnitsForParentOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of the OUs in the specified root or parent OU. @@ -163,15 +161,15 @@ var _ ListOrganizationalUnitsForParentAPIClient = (*Client)(nil) // ListOrganizationalUnitsForParentPaginatorOptions is the paginator options for // ListOrganizationalUnitsForParent type ListOrganizationalUnitsForParentPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListParents.go b/service/organizations/api_op_ListParents.go index 5de6859ee97..83624b0ae4a 100644 --- a/service/organizations/api_op_ListParents.go +++ b/service/organizations/api_op_ListParents.go @@ -17,8 +17,8 @@ import ( // enables you to traverse the tree structure that makes up this root. Always check // the NextToken response parameter for a null value when calling a List* // operation. These operations can occasionally return an empty set of results even -// when there are more results available. The NextToken response parameter value is -// null only when there are no more results to display. This operation can be +// when there are more results available. The NextToken response parameter value +// is null only when there are no more results to display. This operation can be // called only from the organization's management account or by a member account // that is a delegated administrator for an Amazon Web Services service. In the // current release, a child can have only a single parent. @@ -39,31 +39,27 @@ func (c *Client) ListParents(ctx context.Context, params *ListParentsInput, optF type ListParentsInput struct { - // The unique identifier (ID) of the OU or account whose parent containers you want - // to list. Don't specify a root. The regex pattern - // (http://wikipedia.org/wiki/regex) for a child ID string requires one of the - // following: - // - // * Account - A string that consists of exactly 12 digits. - // - // * - // Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to - // 32 lowercase letters or digits (the ID of the root that contains the OU). This - // string is followed by a second "-" dash and from 8 to 32 additional lowercase - // letters or digits. + // The unique identifier (ID) of the OU or account whose parent containers you + // want to list. Don't specify a root. The regex pattern (http://wikipedia.org/wiki/regex) + // for a child ID string requires one of the following: + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). + // This string is followed by a second "-" dash and from 8 to 32 additional + // lowercase letters or digits. // // This member is required. ChildId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -80,7 +76,7 @@ type ListParentsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of parents for the specified child account or OU. @@ -164,15 +160,15 @@ var _ ListParentsAPIClient = (*Client)(nil) // ListParentsPaginatorOptions is the paginator options for ListParents type ListParentsPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListPolicies.go b/service/organizations/api_op_ListPolicies.go index 837876bbaa3..b4030c67ded 100644 --- a/service/organizations/api_op_ListPolicies.go +++ b/service/organizations/api_op_ListPolicies.go @@ -39,34 +39,23 @@ type ListPoliciesInput struct { // Specifies the type of policy that you want to include in the response. You must // specify one of the following values: - // - // * AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // SERVICE_CONTROL_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. Filter types.PolicyType - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -83,12 +72,12 @@ type ListPoliciesOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of policies that match the filter criteria in the request. The output // list doesn't include the policy contents. To see the content for a policy, see - // DescribePolicy. + // DescribePolicy . Policies []types.PolicySummary // Metadata pertaining to the operation's result. @@ -169,15 +158,15 @@ var _ ListPoliciesAPIClient = (*Client)(nil) // ListPoliciesPaginatorOptions is the paginator options for ListPolicies type ListPoliciesPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListPoliciesForTarget.go b/service/organizations/api_op_ListPoliciesForTarget.go index 68c6cb40092..5ec069e62d0 100644 --- a/service/organizations/api_op_ListPoliciesForTarget.go +++ b/service/organizations/api_op_ListPoliciesForTarget.go @@ -17,8 +17,8 @@ import ( // want included in the returned list. Always check the NextToken response // parameter for a null value when calling a List* operation. These operations can // occasionally return an empty set of results even when there are more results -// available. The NextToken response parameter value is null only when there are no -// more results to display. This operation can be called only from the +// available. The NextToken response parameter value is null only when there are +// no more results to display. This operation can be called only from the // organization's management account or by a member account that is a delegated // administrator for an Amazon Web Services service. func (c *Client) ListPoliciesForTarget(ctx context.Context, params *ListPoliciesForTargetInput, optFns ...func(*Options)) (*ListPoliciesForTargetOutput, error) { @@ -40,21 +40,10 @@ type ListPoliciesForTargetInput struct { // The type of policy that you want to include in the returned list. You must // specify one of the following values: - // - // * AISERVICES_OPT_OUT_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // - // * - // BACKUP_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) - // - // * - // SERVICE_CONTROL_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) - // - // * - // TAG_POLICY - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) + // - AISERVICES_OPT_OUT_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // - BACKUP_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html) + // - SERVICE_CONTROL_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html) + // - TAG_POLICY (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // // This member is required. Filter types.PolicyType @@ -62,31 +51,26 @@ type ListPoliciesForTargetInput struct { // The unique identifier (ID) of the root, organizational unit, or account whose // policies you want to list. The regex pattern (http://wikipedia.org/wiki/regex) // for a target ID string requires one of the following: - // - // * Root - A string that - // begins with "r-" followed by from 4 to 32 lowercase letters or digits. - // - // * - // Account - A string that consists of exactly 12 digits. - // - // * Organizational unit - // (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase - // letters or digits (the ID of the root that the OU is in). This string is - // followed by a second "-" dash and from 8 to 32 additional lowercase letters or - // digits. + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. TargetId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -103,7 +87,7 @@ type ListPoliciesForTargetOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // The list of policies that match the criteria in the request. @@ -189,15 +173,15 @@ var _ ListPoliciesForTargetAPIClient = (*Client)(nil) // ListPoliciesForTargetPaginatorOptions is the paginator options for // ListPoliciesForTarget type ListPoliciesForTargetPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListRoots.go b/service/organizations/api_op_ListRoots.go index eb794363989..1dded5f7e74 100644 --- a/service/organizations/api_op_ListRoots.go +++ b/service/organizations/api_op_ListRoots.go @@ -23,7 +23,7 @@ import ( // in the organization. When you enable all features, you make policy types // available for use in that organization. Individual policy types can then be // enabled and disabled in a root. To see the availability of a policy type in an -// organization, use DescribeOrganization. +// organization, use DescribeOrganization . func (c *Client) ListRoots(ctx context.Context, params *ListRootsInput, optFns ...func(*Options)) (*ListRootsOutput, error) { if params == nil { params = &ListRootsInput{} @@ -41,15 +41,15 @@ func (c *Client) ListRoots(ctx context.Context, params *ListRootsInput, optFns . type ListRootsInput struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -66,7 +66,7 @@ type ListRootsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of roots that are defined in an organization. @@ -147,15 +147,15 @@ var _ ListRootsAPIClient = (*Client)(nil) // ListRootsPaginatorOptions is the paginator options for ListRoots type ListRootsPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_ListTagsForResource.go b/service/organizations/api_op_ListTagsForResource.go index 8a4815fdf00..cd67d4a2f78 100644 --- a/service/organizations/api_op_ListTagsForResource.go +++ b/service/organizations/api_op_ListTagsForResource.go @@ -14,19 +14,13 @@ import ( // Lists tags that are attached to the specified resource. You can attach tags to // the following resources in Organizations. +// - Amazon Web Services account +// - Organization root +// - Organizational unit (OU) +// - Policy (any type) // -// * Amazon Web Services account -// -// * -// Organization root -// -// * Organizational unit (OU) -// -// * Policy (any type) -// -// This -// operation can be called only from the organization's management account or by a -// member account that is a delegated administrator for an Amazon Web Services +// This operation can be called only from the organization's management account or +// by a member account that is a delegated administrator for an Amazon Web Services // service. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -47,18 +41,12 @@ type ListTagsForResourceInput struct { // The ID of the resource with the tags to list. You can specify any of the // following taggable resources. - // - // * Amazon Web Services account – specify the - // account ID number. - // - // * Organizational unit – specify the OU ID that begins with - // ou- and looks similar to: ou-1a2b-34uvwxyz - // - // * Root – specify the root ID that - // begins with r- and looks similar to: r-1a2b - // - // * Policy – specify the policy ID - // that begins with p- andlooks similar to: p-12abcdefg3 + // - Amazon Web Services account – specify the account ID number. + // - Organizational unit – specify the OU ID that begins with ou- and looks + // similar to: ou-1a2b-34uvwxyz + // - Root – specify the root ID that begins with r- and looks similar to: r-1a2b + // - Policy – specify the policy ID that begins with p- andlooks similar to: + // p-12abcdefg3 // // This member is required. ResourceId *string @@ -77,7 +65,7 @@ type ListTagsForResourceOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // The tags that are assigned to the resource. @@ -152,8 +140,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/organizations/api_op_ListTargetsForPolicy.go b/service/organizations/api_op_ListTargetsForPolicy.go index 6f90822884c..a2c93dbb0b3 100644 --- a/service/organizations/api_op_ListTargetsForPolicy.go +++ b/service/organizations/api_op_ListTargetsForPolicy.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the roots, organizational units (OUs), and accounts that the specified -// policy is attached to. Always check the NextToken response parameter for a null -// value when calling a List* operation. These operations can occasionally return -// an empty set of results even when there are more results available. The -// NextToken response parameter value is null only when there are no more results -// to display. This operation can be called only from the organization's management -// account or by a member account that is a delegated administrator for an Amazon -// Web Services service. +// Lists all the roots, organizational units (OUs), and accounts that the +// specified policy is attached to. Always check the NextToken response parameter +// for a null value when calling a List* operation. These operations can +// occasionally return an empty set of results even when there are more results +// available. The NextToken response parameter value is null only when there are +// no more results to display. This operation can be called only from the +// organization's management account or by a member account that is a delegated +// administrator for an Amazon Web Services service. func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsForPolicyInput, optFns ...func(*Options)) (*ListTargetsForPolicyOutput, error) { if params == nil { params = &ListTargetsForPolicyInput{} @@ -37,23 +37,23 @@ func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsFo type ListTargetsForPolicyInput struct { - // The unique identifier (ID) of the policy whose attachments you want to know. The - // regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string requires - // "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the - // underscore character (_). + // The unique identifier (ID) of the policy whose attachments you want to know. + // The regex pattern (http://wikipedia.org/wiki/regex) for a policy ID string + // requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, + // or the underscore character (_). // // This member is required. PolicyId *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -70,7 +70,7 @@ type ListTargetsForPolicyOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of structures, each of which contains details about one of the entities @@ -157,15 +157,15 @@ var _ ListTargetsForPolicyAPIClient = (*Client)(nil) // ListTargetsForPolicyPaginatorOptions is the paginator options for // ListTargetsForPolicy type ListTargetsForPolicyPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that Organizations might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that Organizations + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/organizations/api_op_MoveAccount.go b/service/organizations/api_op_MoveAccount.go index 6f9da62e94a..c65858e72a2 100644 --- a/service/organizations/api_op_MoveAccount.go +++ b/service/organizations/api_op_MoveAccount.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves an account from its current source parent root or organizational unit (OU) -// to the specified destination parent root or OU. This operation can be called -// only from the organization's management account. +// Moves an account from its current source parent root or organizational unit +// (OU) to the specified destination parent root or OU. This operation can be +// called only from the organization's management account. func (c *Client) MoveAccount(ctx context.Context, params *MoveAccountInput, optFns ...func(*Options)) (*MoveAccountOutput, error) { if params == nil { params = &MoveAccountInput{} @@ -40,31 +40,25 @@ type MoveAccountInput struct { // The unique identifier (ID) of the root or organizational unit that you want to // move the account to. The regex pattern (http://wikipedia.org/wiki/regex) for a // parent ID string requires one of the following: - // - // * Root - A string that begins - // with "r-" followed by from 4 to 32 lowercase letters or digits. - // - // * - // Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to - // 32 lowercase letters or digits (the ID of the root that the OU is in). This - // string is followed by a second "-" dash and from 8 to 32 additional lowercase - // letters or digits. + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. DestinationParentId *string // The unique identifier (ID) of the root or organizational unit that you want to - // move the account from. The regex pattern (http://wikipedia.org/wiki/regex) for a - // parent ID string requires one of the following: - // - // * Root - A string that begins - // with "r-" followed by from 4 to 32 lowercase letters or digits. - // - // * - // Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to - // 32 lowercase letters or digits (the ID of the root that the OU is in). This - // string is followed by a second "-" dash and from 8 to 32 additional lowercase - // letters or digits. + // move the account from. The regex pattern (http://wikipedia.org/wiki/regex) for + // a parent ID string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. SourceParentId *string diff --git a/service/organizations/api_op_PutResourcePolicy.go b/service/organizations/api_op_PutResourcePolicy.go index cc9812400ef..827d263fa8b 100644 --- a/service/organizations/api_op_PutResourcePolicy.go +++ b/service/organizations/api_op_PutResourcePolicy.go @@ -30,20 +30,18 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // If provided, the new content for the resource policy. The text must be correctly - // formatted JSON that complies with the syntax for the resource policy's type. For - // more information, see Service Control Policy Syntax - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) + // If provided, the new content for the resource policy. The text must be + // correctly formatted JSON that complies with the syntax for the resource policy's + // type. For more information, see Service Control Policy Syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) // in the Organizations User Guide. // // This member is required. Content *string - // A list of tags that you want to attach to the newly created resource policy. For - // each tag in the list, you must specify both a tag key and a value. You can set - // the value to an empty string, but you can't set it to null. For more information - // about tagging, see Tagging Organizations resources - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) + // A list of tags that you want to attach to the newly created resource policy. + // For each tag in the list, you must specify both a tag key and a value. You can + // set the value to an empty string, but you can't set it to null . For more + // information about tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) // in the Organizations User Guide. Calls with tags apply to the initial creation // of the resource policy, otherwise an exception is thrown. If any one of the tags // is not valid or if you exceed the allowed number of tags for the resource diff --git a/service/organizations/api_op_RegisterDelegatedAdministrator.go b/service/organizations/api_op_RegisterDelegatedAdministrator.go index 9de25fb9c7b..599d5415f5a 100644 --- a/service/organizations/api_op_RegisterDelegatedAdministrator.go +++ b/service/organizations/api_op_RegisterDelegatedAdministrator.go @@ -10,14 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the specified member account to administer the Organizations features of -// the specified Amazon Web Services service. It grants read-only access to +// Enables the specified member account to administer the Organizations features +// of the specified Amazon Web Services service. It grants read-only access to // Organizations service data. The account still requires IAM permissions to access // and administer the Amazon Web Services service. You can run this action only for // Amazon Web Services services that support this feature. For a current list of // services that support it, see the column Supports Delegated Administrator in the -// table at Amazon Web Services Services that you can use with Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) +// table at Amazon Web Services Services that you can use with Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html) // in the Organizations User Guide. This operation can be called only from the // organization's management account. func (c *Client) RegisterDelegatedAdministrator(ctx context.Context, params *RegisterDelegatedAdministratorInput, optFns ...func(*Options)) (*RegisterDelegatedAdministratorOutput, error) { @@ -37,8 +36,8 @@ func (c *Client) RegisterDelegatedAdministrator(ctx context.Context, params *Reg type RegisterDelegatedAdministratorInput struct { - // The account ID number of the member account in the organization to register as a - // delegated administrator. + // The account ID number of the member account in the organization to register as + // a delegated administrator. // // This member is required. AccountId *string diff --git a/service/organizations/api_op_RemoveAccountFromOrganization.go b/service/organizations/api_op_RemoveAccountFromOrganization.go index c7b788b35d9..00a0f1d2b2b 100644 --- a/service/organizations/api_op_RemoveAccountFromOrganization.go +++ b/service/organizations/api_op_RemoveAccountFromOrganization.go @@ -10,39 +10,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified account from the organization. The removed account becomes -// a standalone account that isn't a member of any organization. It's no longer -// subject to any policies and is responsible for its own bill payments. The +// Removes the specified account from the organization. The removed account +// becomes a standalone account that isn't a member of any organization. It's no +// longer subject to any policies and is responsible for its own bill payments. The // organization's management account is no longer charged for any expenses accrued // by the member account after it's removed from the organization. This operation // can be called only from the organization's management account. Member accounts // can remove themselves with LeaveOrganization instead. -// -// * You can remove an -// account from your organization only if the account is configured with the -// information required to operate as a standalone account. When you create an -// account in an organization using the Organizations console, API, or CLI -// commands, the information required of standalone accounts is not automatically -// collected. For an account that you want to make standalone, you must choose a -// support plan, provide and verify the required contact information, and provide a -// current payment method. Amazon Web Services uses the payment method to charge -// for any billable (not free tier) Amazon Web Services activity that occurs while -// the account isn't attached to an organization. To remove an account that doesn't -// yet have this information, you must sign in as the member account and follow the -// steps at To leave an organization when all required account information has not -// yet been provided -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) -// in the Organizations User Guide. -// -// * The account that you want to leave must not -// be a delegated administrator account for any Amazon Web Services service enabled -// for your organization. If the account is a delegated administrator, you must -// first change the delegated administrator account to another account that is -// remaining in the organization. -// -// * After the account leaves the organization, all -// tags that were attached to the account object in the organization are deleted. -// Amazon Web Services accounts outside of an organization do not support tags. +// - You can remove an account from your organization only if the account is +// configured with the information required to operate as a standalone account. +// When you create an account in an organization using the Organizations console, +// API, or CLI commands, the information required of standalone accounts is not +// automatically collected. For an account that you want to make standalone, you +// must choose a support plan, provide and verify the required contact information, +// and provide a current payment method. Amazon Web Services uses the payment +// method to charge for any billable (not free tier) Amazon Web Services activity +// that occurs while the account isn't attached to an organization. To remove an +// account that doesn't yet have this information, you must sign in as the member +// account and follow the steps at To leave an organization when all required +// account information has not yet been provided (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - The account that you want to leave must not be a delegated administrator +// account for any Amazon Web Services service enabled for your organization. If +// the account is a delegated administrator, you must first change the delegated +// administrator account to another account that is remaining in the organization. +// - After the account leaves the organization, all tags that were attached to +// the account object in the organization are deleted. Amazon Web Services accounts +// outside of an organization do not support tags. func (c *Client) RemoveAccountFromOrganization(ctx context.Context, params *RemoveAccountFromOrganizationInput, optFns ...func(*Options)) (*RemoveAccountFromOrganizationOutput, error) { if params == nil { params = &RemoveAccountFromOrganizationInput{} diff --git a/service/organizations/api_op_TagResource.go b/service/organizations/api_op_TagResource.go index e6375391ccf..bddb6b662da 100644 --- a/service/organizations/api_op_TagResource.go +++ b/service/organizations/api_op_TagResource.go @@ -13,18 +13,12 @@ import ( // Adds one or more tags to the specified resource. Currently, you can attach tags // to the following resources in Organizations. +// - Amazon Web Services account +// - Organization root +// - Organizational unit (OU) +// - Policy (any type) // -// * Amazon Web Services account -// -// * -// Organization root -// -// * Organizational unit (OU) -// -// * Policy (any type) -// -// This -// operation can be called only from the organization's management account. +// This operation can be called only from the organization's management account. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -44,25 +38,19 @@ type TagResourceInput struct { // The ID of the resource to add a tag to. You can specify any of the following // taggable resources. - // - // * Amazon Web Services account – specify the account ID - // number. - // - // * Organizational unit – specify the OU ID that begins with ou- and - // looks similar to: ou-1a2b-34uvwxyz - // - // * Root – specify the root ID that begins - // with r- and looks similar to: r-1a2b - // - // * Policy – specify the policy ID that - // begins with p- andlooks similar to: p-12abcdefg3 + // - Amazon Web Services account – specify the account ID number. + // - Organizational unit – specify the OU ID that begins with ou- and looks + // similar to: ou-1a2b-34uvwxyz + // - Root – specify the root ID that begins with r- and looks similar to: r-1a2b + // - Policy – specify the policy ID that begins with p- andlooks similar to: + // p-12abcdefg3 // // This member is required. ResourceId *string // A list of tags to add to the specified resource. For each tag in the list, you // must specify both a tag key and a value. The value can be an empty string, but - // you can't set it to null. If any one of the tags is not valid or if you exceed + // you can't set it to null . If any one of the tags is not valid or if you exceed // the maximum allowed number of tags for a resource, then the entire request // fails. // diff --git a/service/organizations/api_op_UntagResource.go b/service/organizations/api_op_UntagResource.go index 5ac5269620e..850fbdd65b8 100644 --- a/service/organizations/api_op_UntagResource.go +++ b/service/organizations/api_op_UntagResource.go @@ -12,19 +12,12 @@ import ( // Removes any tags with the specified keys from the specified resource. You can // attach tags to the following resources in Organizations. +// - Amazon Web Services account +// - Organization root +// - Organizational unit (OU) +// - Policy (any type) // -// * Amazon Web Services -// account -// -// * Organization root -// -// * Organizational unit (OU) -// -// * Policy (any -// type) -// -// This operation can be called only from the organization's management -// account. +// This operation can be called only from the organization's management account. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -44,18 +37,12 @@ type UntagResourceInput struct { // The ID of the resource to remove a tag from. You can specify any of the // following taggable resources. - // - // * Amazon Web Services account – specify the - // account ID number. - // - // * Organizational unit – specify the OU ID that begins with - // ou- and looks similar to: ou-1a2b-34uvwxyz - // - // * Root – specify the root ID that - // begins with r- and looks similar to: r-1a2b - // - // * Policy – specify the policy ID - // that begins with p- andlooks similar to: p-12abcdefg3 + // - Amazon Web Services account – specify the account ID number. + // - Organizational unit – specify the OU ID that begins with ou- and looks + // similar to: ou-1a2b-34uvwxyz + // - Root – specify the root ID that begins with r- and looks similar to: r-1a2b + // - Policy – specify the policy ID that begins with p- andlooks similar to: + // p-12abcdefg3 // // This member is required. ResourceId *string diff --git a/service/organizations/api_op_UpdateOrganizationalUnit.go b/service/organizations/api_op_UpdateOrganizationalUnit.go index 1f79f42555a..f3c95270991 100644 --- a/service/organizations/api_op_UpdateOrganizationalUnit.go +++ b/service/organizations/api_op_UpdateOrganizationalUnit.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Renames the specified organizational unit (OU). The ID and ARN don't change. The -// child OUs and accounts remain in place, and any attached policies of the OU +// Renames the specified organizational unit (OU). The ID and ARN don't change. +// The child OUs and accounts remain in place, and any attached policies of the OU // remain attached. This operation can be called only from the organization's // management account. func (c *Client) UpdateOrganizationalUnit(ctx context.Context, params *UpdateOrganizationalUnitInput, optFns ...func(*Options)) (*UpdateOrganizationalUnitOutput, error) { @@ -32,19 +32,19 @@ func (c *Client) UpdateOrganizationalUnit(ctx context.Context, params *UpdateOrg type UpdateOrganizationalUnitInput struct { - // The unique identifier (ID) of the OU that you want to rename. You can get the ID - // from the ListOrganizationalUnitsForParent operation. The regex pattern - // (http://wikipedia.org/wiki/regex) for an organizational unit ID string requires - // "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root - // that contains the OU). This string is followed by a second "-" dash and from 8 - // to 32 additional lowercase letters or digits. + // The unique identifier (ID) of the OU that you want to rename. You can get the + // ID from the ListOrganizationalUnitsForParent operation. The regex pattern (http://wikipedia.org/wiki/regex) + // for an organizational unit ID string requires "ou-" followed by from 4 to 32 + // lowercase letters or digits (the ID of the root that contains the OU). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. // // This member is required. OrganizationalUnitId *string - // The new name that you want to assign to the OU. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The new name that you want to assign to the OU. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string noSmithyDocumentSerde diff --git a/service/organizations/api_op_UpdatePolicy.go b/service/organizations/api_op_UpdatePolicy.go index 1be6d498cbb..cd240f7ac0d 100644 --- a/service/organizations/api_op_UpdatePolicy.go +++ b/service/organizations/api_op_UpdatePolicy.go @@ -42,17 +42,16 @@ type UpdatePolicyInput struct { // If provided, the new content for the policy. The text must be correctly // formatted JSON that complies with the syntax for the policy's type. For more - // information, see Service Control Policy Syntax - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) + // information, see Service Control Policy Syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) // in the Organizations User Guide. Content *string // If provided, the new description for the policy. Description *string - // If provided, the new name for the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // If provided, the new name for the policy. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string noSmithyDocumentSerde diff --git a/service/organizations/doc.go b/service/organizations/doc.go index bad1575dc0a..f4a65d2c648 100644 --- a/service/organizations/doc.go +++ b/service/organizations/doc.go @@ -7,47 +7,38 @@ // Amazon Web Services accounts into an organization and centrally manage your // accounts and their resources. This guide provides descriptions of the // Organizations operations. For more information about using this service, see the -// Organizations User Guide -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html). -// Support and feedback for Organizations We welcome your feedback. Send your -// comments to feedback-awsorganizations@amazon.com -// (mailto:feedback-awsorganizations@amazon.com) or post your feedback and -// questions in the Organizations support forum -// (http://forums.aws.amazon.com/forum.jspa?forumID=219). For more information -// about the Amazon Web Services support forums, see Forums Help -// (http://forums.aws.amazon.com/help.jspa). Endpoint to call When using the CLI or -// the Amazon Web Services SDK For the current release of Organizations, specify -// the us-east-1 region for all Amazon Web Services API and CLI calls made from the -// commercial Amazon Web Services Regions outside of China. If calling from one of -// the Amazon Web Services Regions in China, then specify cn-northwest-1. You can -// do this in the CLI by using these parameters and commands: +// Organizations User Guide (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) +// . Support and feedback for Organizations We welcome your feedback. Send your +// comments to feedback-awsorganizations@amazon.com (mailto:feedback-awsorganizations@amazon.com) +// or post your feedback and questions in the Organizations support forum (http://forums.aws.amazon.com/forum.jspa?forumID=219) +// . For more information about the Amazon Web Services support forums, see Forums +// Help (http://forums.aws.amazon.com/help.jspa) . Endpoint to call When using the +// CLI or the Amazon Web Services SDK For the current release of Organizations, +// specify the us-east-1 region for all Amazon Web Services API and CLI calls made +// from the commercial Amazon Web Services Regions outside of China. If calling +// from one of the Amazon Web Services Regions in China, then specify +// cn-northwest-1 . You can do this in the CLI by using these parameters and +// commands: +// - Use the following parameter with each command to specify both the endpoint +// and its region: --endpoint-url https://organizations.us-east-1.amazonaws.com +// (from commercial Amazon Web Services Regions outside of China) or +// --endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn (from +// Amazon Web Services Regions in China) +// - Use the default endpoint, but configure your default region with this +// command: aws configure set default.region us-east-1 (from commercial Amazon +// Web Services Regions outside of China) or aws configure set default.region +// cn-northwest-1 (from Amazon Web Services Regions in China) +// - Use the following parameter with each command to specify the endpoint: +// --region us-east-1 (from commercial Amazon Web Services Regions outside of +// China) or --region cn-northwest-1 (from Amazon Web Services Regions in China) // -// * Use the following -// parameter with each command to specify both the endpoint and its region: -// --endpoint-url https://organizations.us-east-1.amazonaws.com (from commercial -// Amazon Web Services Regions outside of China) or --endpoint-url -// https://organizations.cn-northwest-1.amazonaws.com.cn (from Amazon Web Services -// Regions in China) -// -// * Use the default endpoint, but configure your default region -// with this command: aws configure set default.region us-east-1 (from commercial -// Amazon Web Services Regions outside of China) or aws configure set -// default.region cn-northwest-1 (from Amazon Web Services Regions in China) -// -// * Use -// the following parameter with each command to specify the endpoint: --region -// us-east-1 (from commercial Amazon Web Services Regions outside of China) or -// --region cn-northwest-1 (from Amazon Web Services Regions in China) -// -// Recording -// API Requests Organizations supports CloudTrail, a service that records Amazon -// Web Services API calls for your Amazon Web Services account and delivers log -// files to an Amazon S3 bucket. By using information collected by CloudTrail, you -// can determine which requests the Organizations service received, who made the -// request and when, and so on. For more about Organizations and its support for -// CloudTrail, see Logging Organizations Events with CloudTrail -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration) +// Recording API Requests Organizations supports CloudTrail, a service that +// records Amazon Web Services API calls for your Amazon Web Services account and +// delivers log files to an Amazon S3 bucket. By using information collected by +// CloudTrail, you can determine which requests the Organizations service received, +// who made the request and when, and so on. For more about Organizations and its +// support for CloudTrail, see Logging Organizations Events with CloudTrail (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration) // in the Organizations User Guide. To learn more about CloudTrail, including how -// to turn it on and find your log files, see the CloudTrail User Guide -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). +// to turn it on and find your log files, see the CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html) +// . package organizations diff --git a/service/organizations/types/enums.go b/service/organizations/types/enums.go index 26dd5f4b404..516d00553ac 100644 --- a/service/organizations/types/enums.go +++ b/service/organizations/types/enums.go @@ -87,9 +87,9 @@ const ( ChildTypeOrganizationalUnit ChildType = "ORGANIZATIONAL_UNIT" ) -// Values returns all known values for ChildType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ChildType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ChildType) Values() []ChildType { return []ChildType{ "ACCOUNT", @@ -280,10 +280,10 @@ const ( HandshakeConstraintViolationExceptionReasonManagementAccountEmailNotVerified HandshakeConstraintViolationExceptionReason = "MANAGEMENT_ACCOUNT_EMAIL_NOT_VERIFIED" ) -// Values returns all known values for HandshakeConstraintViolationExceptionReason. -// Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// Values returns all known values for +// HandshakeConstraintViolationExceptionReason. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this +// slice is not guaranteed to be stable across updates. func (HandshakeConstraintViolationExceptionReason) Values() []HandshakeConstraintViolationExceptionReason { return []HandshakeConstraintViolationExceptionReason{ "ACCOUNT_NUMBER_LIMIT_EXCEEDED", @@ -333,8 +333,8 @@ const ( HandshakeResourceTypeParentHandshake HandshakeResourceType = "PARENT_HANDSHAKE" ) -// Values returns all known values for HandshakeResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for HandshakeResourceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (HandshakeResourceType) Values() []HandshakeResourceType { return []HandshakeResourceType{ diff --git a/service/organizations/types/errors.go b/service/organizations/types/errors.go index f61960c5416..2e4f484ad83 100644 --- a/service/organizations/types/errors.go +++ b/service/organizations/types/errors.go @@ -180,8 +180,7 @@ func (e *AccountNotRegisteredException) ErrorFault() smithy.ErrorFault { return // You can't invite an existing account to your organization until you verify that // you own the email address associated with the management account. For more -// information, see Email Address Verification -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification) +// information, see Email Address Verification (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification) // in the Organizations User Guide. type AccountOwnerNotVerifiedException struct { Message *string @@ -350,177 +349,120 @@ func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.Fault // a reason that contains additional information about the violated limit: Some of // the reasons in the following list might not be applicable to this specific API // or operation. -// -// * ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the -// management account from the organization. You can't remove the management -// account. Instead, after you remove all member accounts, delete the organization -// itself. -// -// * ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to -// remove an account from the organization that doesn't yet have enough information -// to exist as a standalone account. This account requires you to first complete -// phone verification. Follow the steps at Removing a member account from your -// organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master) -// in the Organizations User Guide. -// -// * ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You -// attempted to exceed the number of accounts that you can create in one day. -// -// * -// ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account -// isn't fully active. You must complete the account setup before you create an -// organization. -// -// * ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the -// limit on the number of accounts in an organization. If you need more accounts, -// contact Amazon Web Services Support (https://docs.aws.amazon.com/support/home#/) -// to request an increase in your limit. Or the number of invitations that you -// tried to send would cause you to exceed the limit of accounts in your -// organization. Send fewer invitations or contact Amazon Web Services Support to -// request an increase in the number of accounts. Deleted and closed accounts still -// count toward your limit. If you get this exception when running a command -// immediately after creating the organization, wait one hour and try again. After -// an hour, if the command continues to fail with this error, contact Amazon Web -// Services Support (https://docs.aws.amazon.com/support/home#/). -// -// * -// CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the -// management account of the organization as a delegated administrator for an -// Amazon Web Services service integrated with Organizations. You can designate -// only a member account as a delegated administrator. -// -// * -// CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management account. -// To close the management account for the organization, you must first either -// remove or close all member accounts in the organization. Follow standard account -// closure process using root credentials. -// -// * -// CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an -// account that is registered as a delegated administrator for a service integrated -// with your organization. To complete this operation, you must first deregister -// this account as a delegated administrator. -// -// * CLOSE_ACCOUNT_QUOTA_EXCEEDED: You -// have exceeded close account quota for the past 30 days. -// -// * -// CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of -// accounts that you can close at a time. -// -// * -// CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an -// organization in the specified region, you must enable all features mode. -// -// * -// DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an -// Amazon Web Services account as a delegated administrator for an Amazon Web -// Services service that already has a delegated administrator. To complete this -// operation, you must first deregister any existing delegated administrators for -// this service. -// -// * EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is -// only valid for a limited period of time. You must resubmit the request and -// generate a new verfication code. -// -// * HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted -// to exceed the number of handshakes that you can send in one day. -// -// * -// INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported -// payment method is associated with the account. Amazon Web Services does not -// support cards issued by financial institutions in Russia or Belarus. For more -// information, see Managing your Amazon Web Services payments -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html). -// -// * -// MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this -// organization, you first must migrate the organization's management account to -// the marketplace that corresponds to the management account's address. For -// example, accounts with India addresses must be associated with the AISPL -// marketplace. All accounts in an organization must be associated with the same -// marketplace. -// -// * MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the -// Amazon Web Services /> Regions in China. To create an organization, the master -// must have a valid business license. For more information, contact customer -// support. -// -// * MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you -// must first provide a valid contact address and phone number for the management -// account. Then try the operation again. -// -// * MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: -// To complete this operation, the management account must have an associated -// account in the Amazon Web Services GovCloud (US-West) Region. For more -// information, see Organizations -// (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) -// in the Amazon Web Services GovCloud User Guide. -// -// * -// MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this -// management account, you first must associate a valid payment instrument, such as -// a credit card, with the account. Follow the steps at To leave an organization -// when all required account information has not yet been provided -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) -// in the Organizations User Guide. -// -// * -// MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to -// register more delegated administrators than allowed for the service -// principal. -// -// * MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed -// the number of policies of a certain type that can be attached to an entity at -// one time. -// -// * MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags -// allowed on this resource. -// -// * MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To -// complete this operation with this member account, you first must associate a -// valid payment instrument, such as a credit card, with the account. Follow the -// steps at To leave an organization when all required account information has not -// yet been provided -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) -// in the Organizations User Guide. -// -// * MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: -// You attempted to detach a policy from an entity that would cause the entity to -// have fewer than the minimum number of policies of a certain type required. -// -// * -// ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation -// that requires the organization to be configured to support all features. An -// organization that supports only consolidated billing features can't perform this -// operation. -// -// * OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that -// is too many levels deep. -// -// * OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed -// the number of OUs that you can have in an organization. -// -// * -// POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger -// than the maximum size. -// -// * POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed -// the number of policies that you can have in an organization. -// -// * -// SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator -// before you enabled service access. Call the EnableAWSServiceAccess API first. -// -// * -// TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags -// that are not compliant with the tag policy requirements for this account. -// -// * -// WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a -// waiting period before you can remove it from the organization. If you get an -// error that indicates that a wait period is required, try again in a few days. +// - ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management +// account from the organization. You can't remove the management account. Instead, +// after you remove all member accounts, delete the organization itself. +// - ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an +// account from the organization that doesn't yet have enough information to exist +// as a standalone account. This account requires you to first complete phone +// verification. Follow the steps at Removing a member account from your +// organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master) +// in the Organizations User Guide. +// - ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of +// accounts that you can create in one day. +// - ACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your +// account isn't fully active. You must complete the account setup before you +// create an organization. +// - ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the +// number of accounts in an organization. If you need more accounts, contact +// Amazon Web Services Support (https://docs.aws.amazon.com/support/home#/) to +// request an increase in your limit. Or the number of invitations that you tried +// to send would cause you to exceed the limit of accounts in your organization. +// Send fewer invitations or contact Amazon Web Services Support to request an +// increase in the number of accounts. Deleted and closed accounts still count +// toward your limit. If you get this exception when running a command immediately +// after creating the organization, wait one hour and try again. After an hour, if +// the command continues to fail with this error, contact Amazon Web Services +// Support (https://docs.aws.amazon.com/support/home#/) . +// - CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to +// register the management account of the organization as a delegated administrator +// for an Amazon Web Services service integrated with Organizations. You can +// designate only a member account as a delegated administrator. +// - CANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management +// account. To close the management account for the organization, you must first +// either remove or close all member accounts in the organization. Follow standard +// account closure process using root credentials. +// - CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an +// account that is registered as a delegated administrator for a service integrated +// with your organization. To complete this operation, you must first deregister +// this account as a delegated administrator. +// - CLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the +// past 30 days. +// - CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number +// of accounts that you can close at a time. +// - CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an +// organization in the specified region, you must enable all features mode. +// - DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register +// an Amazon Web Services account as a delegated administrator for an Amazon Web +// Services service that already has a delegated administrator. To complete this +// operation, you must first deregister any existing delegated administrators for +// this service. +// - EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid +// for a limited period of time. You must resubmit the request and generate a new +// verfication code. +// - HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of +// handshakes that you can send in one day. +// - INVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no +// supported payment method is associated with the account. Amazon Web Services +// does not support cards issued by financial institutions in Russia or Belarus. +// For more information, see Managing your Amazon Web Services payments (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html) +// . +// - MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in +// this organization, you first must migrate the organization's management account +// to the marketplace that corresponds to the management account's address. For +// example, accounts with India addresses must be associated with the AISPL +// marketplace. All accounts in an organization must be associated with the same +// marketplace. +// - MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web +// Services /> Regions in China. To create an organization, the master must have a +// valid business license. For more information, contact customer support. +// - MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must +// first provide a valid contact address and phone number for the management +// account. Then try the operation again. +// - MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the +// management account must have an associated account in the Amazon Web Services +// GovCloud (US-West) Region. For more information, see Organizations (https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html) +// in the Amazon Web Services GovCloud User Guide. +// - MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with +// this management account, you first must associate a valid payment instrument, +// such as a credit card, with the account. Follow the steps at To leave an +// organization when all required account information has not yet been provided (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to +// register more delegated administrators than allowed for the service principal. +// - MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the +// number of policies of a certain type that can be attached to an entity at one +// time. +// - MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on +// this resource. +// - MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with +// this member account, you first must associate a valid payment instrument, such +// as a credit card, with the account. Follow the steps at To leave an +// organization when all required account information has not yet been provided (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info) +// in the Organizations User Guide. +// - MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy +// from an entity that would cause the entity to have fewer than the minimum number +// of policies of a certain type required. +// - ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an +// operation that requires the organization to be configured to support all +// features. An organization that supports only consolidated billing features can't +// perform this operation. +// - OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too +// many levels deep. +// - OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that +// you can have in an organization. +// - POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is +// larger than the maximum size. +// - POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of +// policies that you can have in an organization. +// - SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated +// administrator before you enabled service access. Call the +// EnableAWSServiceAccess API first. +// - TAG_POLICY_VIOLATION: You attempted to create or update a resource with +// tags that are not compliant with the tag policy requirements for this account. +// - WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there +// is a waiting period before you can remove it from the organization. If you get +// an error that indicates that a wait period is required, try again in a few days. type ConstraintViolationException struct { Message *string @@ -548,8 +490,8 @@ func (e *ConstraintViolationException) ErrorCode() string { } func (e *ConstraintViolationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// We can't find an create account request with the CreateAccountRequestId that you -// specified. +// We can't find an create account request with the CreateAccountRequestId that +// you specified. type CreateAccountStatusNotFoundException struct { Message *string @@ -775,8 +717,8 @@ func (e *EffectivePolicyNotFoundException) ErrorFault() smithy.ErrorFault { retu // Organizations couldn't perform the operation because your organization hasn't // finished initializing. This can take up to an hour. Try again later. If after -// one hour you continue to receive this error, contact Amazon Web Services Support -// (https://console.aws.amazon.com/support/home#/). +// one hour you continue to receive this error, contact Amazon Web Services Support (https://console.aws.amazon.com/support/home#/) +// . type FinalizingOrganizationException struct { Message *string @@ -832,49 +774,35 @@ func (e *HandshakeAlreadyInStateException) ErrorFault() smithy.ErrorFault { retu // The requested operation would violate the constraint identified in the reason // code. Some of the reasons in the following list might not be applicable to this // specific API or operation: -// -// * ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to -// exceed the limit on the number of accounts in an organization. Note that deleted -// and closed accounts still count toward your limit. If you get this exception -// immediately after creating the organization, wait one hour and try again. If -// after an hour it continues to fail with this error, contact Amazon Web Services -// Support (https://docs.aws.amazon.com/support/home#/). -// -// * -// ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited -// account is already a member of an organization. -// -// * -// HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes -// that you can send in one day. -// -// * INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You -// can't issue new invitations to join an organization while it's in the process of -// enabling all features. You can resume inviting accounts after you finalize the -// process when all accounts have agreed to the change. -// -// * -// ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because -// the organization has already enabled all features. -// -// * -// ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is -// invalid because the organization has already started the process to enable all -// features. -// -// * ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed -// because the account is from a different marketplace than the accounts in the -// organization. For example, accounts with India addresses must be associated with -// the AISPL marketplace. All accounts in an organization must be from the same -// marketplace. -// -// * ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You -// attempted to change the membership of an account too quickly after its previous -// change. -// -// * PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an -// account that doesn't have a payment instrument, such as a credit card, -// associated with it. +// - ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the +// number of accounts in an organization. Note that deleted and closed accounts +// still count toward your limit. If you get this exception immediately after +// creating the organization, wait one hour and try again. If after an hour it +// continues to fail with this error, contact Amazon Web Services Support (https://docs.aws.amazon.com/support/home#/) +// . +// - ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the +// invited account is already a member of an organization. +// - HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of +// handshakes that you can send in one day. +// - INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations +// to join an organization while it's in the process of enabling all features. You +// can resume inviting accounts after you finalize the process when all accounts +// have agreed to the change. +// - ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid +// because the organization has already enabled all features. +// - ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake +// request is invalid because the organization has already started the process to +// enable all features. +// - ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because +// the account is from a different marketplace than the accounts in the +// organization. For example, accounts with India addresses must be associated with +// the AISPL marketplace. All accounts in an organization must be from the same +// marketplace. +// - ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change +// the membership of an account too quickly after its previous change. +// - PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an +// account that doesn't have a payment instrument, such as a credit card, +// associated with it. type HandshakeConstraintViolationException struct { Message *string @@ -964,86 +892,52 @@ func (e *InvalidHandshakeTransitionException) ErrorFault() smithy.ErrorFault { // more of the request parameters. This exception includes a reason that contains // additional information about the violated limit: Some of the reasons in the // following list might not be applicable to this specific API or operation. -// -// * -// DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same -// entity. -// -// * IMMUTABLE_POLICY: You specified a policy that is managed by Amazon -// Web Services and can't be modified. -// -// * INPUT_REQUIRED: You must include a value -// for all required parameters. -// -// * INVALID_EMAIL_ADDRESS_TARGET: You specified an -// invalid email address for the invited account owner. -// -// * INVALID_ENUM: You -// specified an invalid value. -// -// * INVALID_ENUM_POLICY_TYPE: You specified an -// invalid policy type string. -// -// * INVALID_FULL_NAME_TARGET: You specified a full -// name that contains invalid characters. -// -// * INVALID_LIST_MEMBER: You provided a -// list to a parameter that contains at least one invalid value. -// -// * -// INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the -// response to a previous call of the operation. -// -// * INVALID_PARTY_TYPE_TARGET: You -// specified the wrong type of entity (account, organization, or email) as a -// party. -// -// * INVALID_PATTERN: You provided a value that doesn't match the required -// pattern. -// -// * INVALID_PATTERN_TARGET_ID: You specified a policy target ID that -// doesn't match the required pattern. -// -// * INVALID_ROLE_NAME: You provided a role -// name that isn't valid. A role name can't begin with the reserved prefix -// AWSServiceRoleFor. -// -// * INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid -// Amazon Resource Name (ARN) for the organization. -// -// * INVALID_SYNTAX_POLICY_ID: -// You specified an invalid policy ID. -// -// * INVALID_SYSTEM_TAGS_PARAMETER: You -// specified a tag key that is a system tag. You can’t add, edit, or delete system -// tag keys because they're reserved for Amazon Web Services use. System tags don’t -// count against your tags per resource limit. -// -// * MAX_FILTER_LIMIT_EXCEEDED: You -// can specify only one filter parameter for the operation. -// -// * MAX_LENGTH_EXCEEDED: -// You provided a string parameter that is longer than allowed. -// -// * -// MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value -// than allowed. -// -// * MIN_LENGTH_EXCEEDED: You provided a string parameter that is -// shorter than allowed. -// -// * MIN_VALUE_EXCEEDED: You provided a numeric parameter -// that has a smaller value than allowed. -// -// * -// MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between -// entities in the same root. -// -// * TARGET_NOT_SUPPORTED: You can't perform the -// specified operation on that target entity. -// -// * UNRECOGNIZED_SERVICE_PRINCIPAL: -// You specified a service principal that isn't recognized. +// - DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the +// same entity. +// - IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web +// Services and can't be modified. +// - INPUT_REQUIRED: You must include a value for all required parameters. +// - INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for +// the invited account owner. +// - INVALID_ENUM: You specified an invalid value. +// - INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string. +// - INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid +// characters. +// - INVALID_LIST_MEMBER: You provided a list to a parameter that contains at +// least one invalid value. +// - INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the +// response to a previous call of the operation. +// - INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, +// organization, or email) as a party. +// - INVALID_PATTERN: You provided a value that doesn't match the required +// pattern. +// - INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't +// match the required pattern. +// - INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name +// can't begin with the reserved prefix AWSServiceRoleFor . +// - INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource +// Name (ARN) for the organization. +// - INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. +// - INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system +// tag. You can’t add, edit, or delete system tag keys because they're reserved for +// Amazon Web Services use. System tags don’t count against your tags per resource +// limit. +// - MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for +// the operation. +// - MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than +// allowed. +// - MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger +// value than allowed. +// - MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than +// allowed. +// - MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller +// value than allowed. +// - MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only +// between entities in the same root. +// - TARGET_NOT_SUPPORTED: You can't perform the specified operation on that +// target entity. +// - UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that +// isn't recognized. type InvalidInputException struct { Message *string @@ -1073,8 +967,7 @@ func (e *InvalidInputException) ErrorFault() smithy.ErrorFault { return smithy.F // The provided policy document doesn't meet the requirements of the specified // policy type. For example, the syntax might be incorrect. For details about -// service control policy syntax, see Service Control Policy Syntax -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) +// service control policy syntax, see Service Control Policy Syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html) // in the Organizations User Guide. type MalformedPolicyDocumentException struct { Message *string @@ -1377,9 +1270,8 @@ func (e *PolicyTypeAlreadyEnabledException) ErrorFault() smithy.ErrorFault { ret // You can't use the specified policy type with the feature set currently enabled // for this organization. For example, you can enable SCPs only after you enable // all features in the organization. For more information, see Managing -// Organizations Policies -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#enable_policies_on_root)in -// the Organizations User Guide. +// Organizations Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#enable_policies_on_root) +// in the Organizations User Guide. type PolicyTypeNotAvailableForOrganizationException struct { Message *string @@ -1407,11 +1299,10 @@ func (e *PolicyTypeNotAvailableForOrganizationException) ErrorFault() smithy.Err return smithy.FaultClient } -// The specified policy type isn't currently enabled in this root. You can't attach -// policies of the specified type to entities in a root until you enable that type -// in the root. For more information, see Enabling All Features in Your -// Organization -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) +// The specified policy type isn't currently enabled in this root. You can't +// attach policies of the specified type to entities in a root until you enable +// that type in the root. For more information, see Enabling All Features in Your +// Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) // in the Organizations User Guide. type PolicyTypeNotEnabledException struct { Message *string @@ -1572,9 +1463,8 @@ func (e *TargetNotFoundException) ErrorFault() smithy.ErrorFault { return smithy // You have sent too many requests in too short a period of time. The quota helps // protect against denial-of-service attacks. Try again later. For information -// about quotas that affect Organizations, see Quotas for Organizations -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html)in -// the Organizations User Guide. +// about quotas that affect Organizations, see Quotas for Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) +// in the Organizations User Guide. type TooManyRequestsException struct { Message *string diff --git a/service/organizations/types/types.go b/service/organizations/types/types.go index de9edc4748c..0a74c0a4c66 100644 --- a/service/organizations/types/types.go +++ b/service/organizations/types/types.go @@ -7,13 +7,12 @@ import ( "time" ) -// Contains information about an Amazon Web Services account that is a member of an -// organization. +// Contains information about an Amazon Web Services account that is a member of +// an organization. type Account struct { // The Amazon Resource Name (ARN) of the account. For more information about ARNs - // in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string @@ -22,9 +21,8 @@ type Account struct { // characters that represents a standard internet email address. Email *string - // The unique identifier (ID) of the account. The regex pattern - // (http://wikipedia.org/wiki/regex) for an account ID string requires exactly 12 - // digits. + // The unique identifier (ID) of the account. The regex pattern (http://wikipedia.org/wiki/regex) + // for an account ID string requires exactly 12 digits. Id *string // The method by which the account joined the organization. @@ -33,9 +31,9 @@ type Account struct { // The date the account became a part of the organization. JoinedTimestamp *time.Time - // The friendly name of the account. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name of the account. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string // The status of the account in the organization. @@ -47,17 +45,13 @@ type Account struct { // Contains a list of child entities, either OUs or accounts. type Child struct { - // The unique identifier (ID) of this child entity. The regex pattern - // (http://wikipedia.org/wiki/regex) for a child ID string requires one of the - // following: - // - // * Account - A string that consists of exactly 12 digits. - // - // * - // Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to - // 32 lowercase letters or digits (the ID of the root that contains the OU). This - // string is followed by a second "-" dash and from 8 to 32 additional lowercase - // letters or digits. + // The unique identifier (ID) of this child entity. The regex pattern (http://wikipedia.org/wiki/regex) + // for a child ID string requires one of the following: + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). + // This string is followed by a second "-" dash and from 8 to 32 additional + // lowercase letters or digits. Id *string // The type of this child entity. @@ -83,74 +77,52 @@ type CreateAccountStatus struct { CompletedTimestamp *time.Time // If the request failed, a description of the reason for the failure. - // - // * - // ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the - // limit on the number of accounts in your organization. - // - // * - // CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same - // information. - // - // * EMAIL_ALREADY_EXISTS: The account could not be created because - // another Amazon Web Services account with that email address already exists. - // - // * - // FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your - // organization failed to receive business license validation. - // - // * - // GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud - // (US) Region could not be created because this Region already includes an account - // with that email address. - // - // * IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web - // Services account that owns your organization can't complete business license - // validation because it doesn't have valid identity data. - // - // * INVALID_ADDRESS: The - // account could not be created because the address you provided is not valid. - // - // * - // INVALID_EMAIL: The account could not be created because the email address you - // provided is not valid. - // - // * INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services - // account that owns your organization does not have a supported payment method - // associated with the account. Amazon Web Services does not support cards issued - // by financial institutions in Russia or Belarus. For more information, see - // Managing your Amazon Web Services payments - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html). - // - // * - // INTERNAL_FAILURE: The account could not be created because of an internal - // failure. Try again later. If the problem persists, contact Amazon Web Services - // Customer Support. - // - // * MISSING_BUSINESS_VALIDATION: The Amazon Web Services - // account that owns your organization has not received Business Validation. - // - // * - // MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a - // valid payment method, such as a credit card. - // - // * PENDING_BUSINESS_VALIDATION: The - // Amazon Web Services account that owns your organization is still in the process - // of completing business license validation. - // - // * UNKNOWN_BUSINESS_VALIDATION: The - // Amazon Web Services account that owns your organization has an unknown issue - // with business license validation. + // - ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached + // the limit on the number of accounts in your organization. + // - CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the + // same information. + // - EMAIL_ALREADY_EXISTS: The account could not be created because another + // Amazon Web Services account with that email address already exists. + // - FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your + // organization failed to receive business license validation. + // - GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services + // GovCloud (US) Region could not be created because this Region already includes + // an account with that email address. + // - IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that + // owns your organization can't complete business license validation because it + // doesn't have valid identity data. + // - INVALID_ADDRESS: The account could not be created because the address you + // provided is not valid. + // - INVALID_EMAIL: The account could not be created because the email address + // you provided is not valid. + // - INVALID_PAYMENT_INSTRUMENT: The Amazon Web Services account that owns your + // organization does not have a supported payment method associated with the + // account. Amazon Web Services does not support cards issued by financial + // institutions in Russia or Belarus. For more information, see Managing your + // Amazon Web Services payments (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html) + // . + // - INTERNAL_FAILURE: The account could not be created because of an internal + // failure. Try again later. If the problem persists, contact Amazon Web Services + // Customer Support. + // - MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your + // organization has not received Business Validation. + // - MISSING_PAYMENT_INSTRUMENT: You must configure the management account with + // a valid payment method, such as a credit card. + // - PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your + // organization is still in the process of completing business license validation. + // - UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your + // organization has an unknown issue with business license validation. FailureReason CreateAccountFailureReason // If the account was created successfully, the unique identifier (ID) of the new // account in the Amazon Web Services GovCloud (US) Region. GovCloudAccountId *string - // The unique identifier (ID) that references this request. You get this value from - // the response of the initial CreateAccount request to create the account. The - // regex pattern (http://wikipedia.org/wiki/regex) for a create account request ID - // string requires "car-" followed by from 8 to 32 lowercase letters or digits. + // The unique identifier (ID) that references this request. You get this value + // from the response of the initial CreateAccount request to create the account. + // The regex pattern (http://wikipedia.org/wiki/regex) for a create account + // request ID string requires "car-" followed by from 8 to 32 lowercase letters or + // digits. Id *string // The date and time that the request was made for the account creation. @@ -195,16 +167,16 @@ type DelegatedAdministrator struct { noSmithyDocumentSerde } -// Contains information about the Amazon Web Services service for which the account -// is a delegated administrator. +// Contains information about the Amazon Web Services service for which the +// account is a delegated administrator. type DelegatedService struct { // The date that the account became a delegated administrator for this service. DelegationEnabledDate *time.Time - // The name of an Amazon Web Services service that can request an operation for the - // specified service. This is typically in the form of a URL, such as: - // servicename.amazonaws.com. + // The name of an Amazon Web Services service that can request an operation for + // the specified service. This is typically in the form of a URL, such as: + // servicename.amazonaws.com . ServicePrincipal *string noSmithyDocumentSerde @@ -239,44 +211,39 @@ type EnabledServicePrincipal struct { DateEnabled *time.Time // The name of the service principal. This is typically in the form of a URL, such - // as: servicename.amazonaws.com. + // as: servicename.amazonaws.com . ServicePrincipal *string noSmithyDocumentSerde } -// Contains information that must be exchanged to securely establish a relationship -// between two accounts (an originator and a recipient). For example, when a -// management account (the originator) invites another account (the recipient) to -// join its organization, the two accounts exchange information as a series of -// handshake requests and responses. Note: Handshakes that are CANCELED, ACCEPTED, -// DECLINED, or EXPIRED show up in lists for only 30 days after entering that state -// After that they are deleted. +// Contains information that must be exchanged to securely establish a +// relationship between two accounts (an originator and a recipient). For example, +// when a management account (the originator) invites another account (the +// recipient) to join its organization, the two accounts exchange information as a +// series of handshake requests and responses. Note: Handshakes that are CANCELED , +// ACCEPTED , DECLINED , or EXPIRED show up in lists for only 30 days after +// entering that state After that they are deleted. type Handshake struct { // The type of handshake, indicating what action occurs when the recipient accepts // the handshake. The following handshake types are supported: - // - // * INVITE: This type - // of handshake represents a request to join an organization. It is always sent - // from the management account to only non-member accounts. - // - // * ENABLE_ALL_FEATURES: - // This type of handshake represents a request to enable all features in an - // organization. It is always sent from the management account to only invited - // member accounts. Created accounts do not receive this because those accounts - // were created by the organization's management account and approval is - // inferred. - // - // * APPROVE_ALL_FEATURES: This type of handshake is sent from the - // Organizations service when all member accounts have approved the - // ENABLE_ALL_FEATURES invitation. It is sent only to the management account and - // signals the master that it can finalize the process to enable all features. + // - INVITE: This type of handshake represents a request to join an + // organization. It is always sent from the management account to only non-member + // accounts. + // - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable + // all features in an organization. It is always sent from the management account + // to only invited member accounts. Created accounts do not receive this because + // those accounts were created by the organization's management account and + // approval is inferred. + // - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations + // service when all member accounts have approved the ENABLE_ALL_FEATURES + // invitation. It is sent only to the management account and signals the master + // that it can finalize the process to enable all features. Action ActionType // The Amazon Resource Name (ARN) of a handshake. For more information about ARNs - // in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string @@ -286,9 +253,9 @@ type Handshake struct { ExpirationTimestamp *time.Time // The unique identifier (ID) of a handshake. The originating account creates the - // ID when it initiates the handshake. The regex pattern - // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed - // by from 8 to 32 lowercase letters or digits. + // ID when it initiates the handshake. The regex pattern (http://wikipedia.org/wiki/regex) + // for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters + // or digits. Id *string // Information about the two accounts that are participating in the handshake. @@ -303,29 +270,21 @@ type Handshake struct { // The current state of the handshake. Use the state to trace the flow of the // handshake through the process from its creation to its acceptance. The meaning // of each of the valid values is as follows: - // - // * REQUESTED: This handshake was sent - // to multiple recipients (applicable to only some handshake types) and not all - // recipients have responded yet. The request stays in this state until all - // recipients respond. - // - // * OPEN: This handshake was sent to multiple recipients - // (applicable to only some policy types) and all recipients have responded, - // allowing the originator to complete the handshake action. - // - // * CANCELED: This - // handshake is no longer active because it was canceled by the originating - // account. - // - // * ACCEPTED: This handshake is complete because it has been accepted by - // the recipient. - // - // * DECLINED: This handshake is no longer active because it was - // declined by the recipient account. - // - // * EXPIRED: This handshake is no longer - // active because the originator did not receive a response of any kind from the - // recipient before the expiration time (15 days). + // - REQUESTED: This handshake was sent to multiple recipients (applicable to + // only some handshake types) and not all recipients have responded yet. The + // request stays in this state until all recipients respond. + // - OPEN: This handshake was sent to multiple recipients (applicable to only + // some policy types) and all recipients have responded, allowing the originator to + // complete the handshake action. + // - CANCELED: This handshake is no longer active because it was canceled by the + // originating account. + // - ACCEPTED: This handshake is complete because it has been accepted by the + // recipient. + // - DECLINED: This handshake is no longer active because it was declined by the + // recipient account. + // - EXPIRED: This handshake is no longer active because the originator did not + // receive a response of any kind from the recipient before the expiration time (15 + // days). State HandshakeState noSmithyDocumentSerde @@ -334,14 +293,14 @@ type Handshake struct { // Specifies the criteria that are used to select the handshakes for the operation. type HandshakeFilter struct { - // Specifies the type of handshake action. If you specify ActionType, you cannot - // also specify ParentHandshakeId. + // Specifies the type of handshake action. If you specify ActionType , you cannot + // also specify ParentHandshakeId . ActionType ActionType // Specifies the parent handshake. Only used for handshake types that are a child - // of another type. If you specify ParentHandshakeId, you cannot also specify - // ActionType. The regex pattern (http://wikipedia.org/wiki/regex) for handshake ID - // string requires "h-" followed by from 8 to 32 lowercase letters or digits. + // of another type. If you specify ParentHandshakeId , you cannot also specify + // ActionType . The regex pattern (http://wikipedia.org/wiki/regex) for handshake + // ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. ParentHandshakeId *string noSmithyDocumentSerde @@ -350,9 +309,9 @@ type HandshakeFilter struct { // Identifies a participant in a handshake. type HandshakeParty struct { - // The unique identifier (ID) for the party. The regex pattern - // (http://wikipedia.org/wiki/regex) for handshake ID string requires "h-" followed - // by from 8 to 32 lowercase letters or digits. + // The unique identifier (ID) for the party. The regex pattern (http://wikipedia.org/wiki/regex) + // for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters + // or digits. // // This member is required. Id *string @@ -373,25 +332,16 @@ type HandshakeResource struct { // The type of information being passed, specifying how the value is to be // interpreted by the other party: - // - // * ACCOUNT - Specifies an Amazon Web Services - // account ID number. - // - // * ORGANIZATION - Specifies an organization ID number. - // - // * - // EMAIL - Specifies the email address that is associated with the account that - // receives the handshake. - // - // * OWNER_EMAIL - Specifies the email address associated - // with the management account. Included as information about an organization. - // - // * - // OWNER_NAME - Specifies the name associated with the management account. Included - // as information about an organization. - // - // * NOTES - Additional text provided by the - // handshake initiator and intended for the recipient to read. + // - ACCOUNT - Specifies an Amazon Web Services account ID number. + // - ORGANIZATION - Specifies an organization ID number. + // - EMAIL - Specifies the email address that is associated with the account that + // receives the handshake. + // - OWNER_EMAIL - Specifies the email address associated with the management + // account. Included as information about an organization. + // - OWNER_NAME - Specifies the name associated with the management account. + // Included as information about an organization. + // - NOTES - Additional text provided by the handshake initiator and intended for + // the recipient to read. Type HandshakeResourceType // The information that is passed to the other party in the handshake. The format @@ -408,8 +358,7 @@ type HandshakeResource struct { type Organization struct { // The Amazon Resource Name (ARN) of an organization. For more information about - // ARNs in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // ARNs in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string @@ -423,20 +372,18 @@ type Organization struct { // set to "ALL", then all features are enabled and policies can be applied to // accounts in the organization. If set to "CONSOLIDATED_BILLING", then only // consolidated billing functionality is available. For more information, see - // Enabling All Features in Your Organization - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) + // Enabling All Features in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) // in the Organizations User Guide. FeatureSet OrganizationFeatureSet - // The unique identifier (ID) of an organization. The regex pattern - // (http://wikipedia.org/wiki/regex) for an organization ID string requires "o-" - // followed by from 10 to 32 lowercase letters or digits. + // The unique identifier (ID) of an organization. The regex pattern (http://wikipedia.org/wiki/regex) + // for an organization ID string requires "o-" followed by from 10 to 32 lowercase + // letters or digits. Id *string // The Amazon Resource Name (ARN) of the account that is designated as the // management account for the organization. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. MasterAccountArn *string @@ -459,41 +406,37 @@ type Organization struct { type OrganizationalUnit struct { // The Amazon Resource Name (ARN) of this OU. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string - // The unique identifier (ID) associated with this OU. The regex pattern - // (http://wikipedia.org/wiki/regex) for an organizational unit ID string requires - // "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root - // that contains the OU). This string is followed by a second "-" dash and from 8 - // to 32 additional lowercase letters or digits. + // The unique identifier (ID) associated with this OU. The regex pattern (http://wikipedia.org/wiki/regex) + // for an organizational unit ID string requires "ou-" followed by from 4 to 32 + // lowercase letters or digits (the ID of the root that contains the OU). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. Id *string - // The friendly name of this OU. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name of this OU. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string noSmithyDocumentSerde } -// Contains information about either a root or an organizational unit (OU) that can -// contain OUs or accounts in an organization. +// Contains information about either a root or an organizational unit (OU) that +// can contain OUs or accounts in an organization. type Parent struct { - // The unique identifier (ID) of the parent entity. The regex pattern - // (http://wikipedia.org/wiki/regex) for a parent ID string requires one of the - // following: - // - // * Root - A string that begins with "r-" followed by from 4 to 32 - // lowercase letters or digits. - // - // * Organizational unit (OU) - A string that begins - // with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the - // root that the OU is in). This string is followed by a second "-" dash and from 8 - // to 32 additional lowercase letters or digits. + // The unique identifier (ID) of the parent entity. The regex pattern (http://wikipedia.org/wiki/regex) + // for a parent ID string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. Id *string // The type of the parent entity. @@ -517,12 +460,11 @@ type Policy struct { } // Contains information about a policy, but does not include the content. To see -// the content of a policy, see DescribePolicy. +// the content of a policy, see DescribePolicy . type PolicySummary struct { - // The Amazon Resource Name (ARN) of the policy. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // The Amazon Resource Name (ARN) of the policy. For more information about ARNs + // in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string @@ -534,15 +476,14 @@ type PolicySummary struct { // The description of the policy. Description *string - // The unique identifier (ID) of the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) for a policy ID string requires "p-" followed - // by from 8 to 128 lowercase or uppercase letters, digits, or the underscore - // character (_). + // The unique identifier (ID) of the policy. The regex pattern (http://wikipedia.org/wiki/regex) + // for a policy ID string requires "p-" followed by from 8 to 128 lowercase or + // uppercase letters, digits, or the underscore character (_). Id *string - // The friendly name of the policy. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name of the policy. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string // The type of policy. @@ -555,30 +496,24 @@ type PolicySummary struct { type PolicyTargetSummary struct { // The Amazon Resource Name (ARN) of the policy target. For more information about - // ARNs in Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // ARNs in Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string - // The friendly name of the policy target. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name of the policy target. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string - // The unique identifier (ID) of the policy target. The regex pattern - // (http://wikipedia.org/wiki/regex) for a target ID string requires one of the - // following: - // - // * Root - A string that begins with "r-" followed by from 4 to 32 - // lowercase letters or digits. - // - // * Account - A string that consists of exactly 12 - // digits. - // - // * Organizational unit (OU) - A string that begins with "ou-" followed - // by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is - // in). This string is followed by a second "-" dash and from 8 to 32 additional - // lowercase letters or digits. + // The unique identifier (ID) of the policy target. The regex pattern (http://wikipedia.org/wiki/regex) + // for a target ID string requires one of the following: + // - Root - A string that begins with "r-" followed by from 4 to 32 lowercase + // letters or digits. + // - Account - A string that consists of exactly 12 digits. + // - Organizational unit (OU) - A string that begins with "ou-" followed by from + // 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This + // string is followed by a second "-" dash and from 8 to 32 additional lowercase + // letters or digits. TargetId *string // The type of the policy target. @@ -632,25 +567,24 @@ type ResourcePolicySummary struct { type Root struct { // The Amazon Resource Name (ARN) of the root. For more information about ARNs in - // Organizations, see ARN Formats Supported by Organizations - // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) + // Organizations, see ARN Formats Supported by Organizations (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies) // in the Amazon Web Services Service Authorization Reference. Arn *string - // The unique identifier (ID) for the root. The regex pattern - // (http://wikipedia.org/wiki/regex) for a root ID string requires "r-" followed by - // from 4 to 32 lowercase letters or digits. + // The unique identifier (ID) for the root. The regex pattern (http://wikipedia.org/wiki/regex) + // for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or + // digits. Id *string - // The friendly name of the root. The regex pattern - // (http://wikipedia.org/wiki/regex) that is used to validate this parameter is a - // string of any of the characters in the ASCII character range. + // The friendly name of the root. The regex pattern (http://wikipedia.org/wiki/regex) + // that is used to validate this parameter is a string of any of the characters in + // the ASCII character range. Name *string // The types of policies that are currently enabled for the root and therefore can // be attached to the root or to its OUs or accounts. Even if a policy type is // shown as available in the organization, you can separately enable and disable - // them at the root level by using EnablePolicyType and DisablePolicyType. Use + // them at the root level by using EnablePolicyType and DisablePolicyType . Use // DescribeOrganization to see the availability of the policy types in that // organization. PolicyTypes []PolicyTypeSummary @@ -658,17 +592,12 @@ type Root struct { noSmithyDocumentSerde } -// A custom key-value pair associated with a resource within your organization. You -// can attach tags to any of the following organization resources. -// -// * Amazon Web -// Services account -// -// * Organizational unit (OU) -// -// * Organization root -// -// * Policy +// A custom key-value pair associated with a resource within your organization. +// You can attach tags to any of the following organization resources. +// - Amazon Web Services account +// - Organizational unit (OU) +// - Organization root +// - Policy type Tag struct { // The key identifier, or name, of the tag. diff --git a/service/outposts/api_client.go b/service/outposts/api_client.go index 900d2f3210e..492403a88b0 100644 --- a/service/outposts/api_client.go +++ b/service/outposts/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/outposts/api_op_CreateSite.go b/service/outposts/api_op_CreateSite.go index 52587e44220..cf394c0392c 100644 --- a/service/outposts/api_op_CreateSite.go +++ b/service/outposts/api_op_CreateSite.go @@ -46,10 +46,9 @@ type CreateSiteInput struct { // different from the shipping address. OperatingAddress *types.Address - // Information about the physical and logistical details for the rack at this site. - // For more information about hardware requirements for racks, see Network - // readiness checklist - // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) + // Information about the physical and logistical details for the rack at this + // site. For more information about hardware requirements for racks, see Network + // readiness checklist (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) // in the Amazon Web Services Outposts User Guide. RackPhysicalProperties *types.RackPhysicalProperties diff --git a/service/outposts/api_op_GetConnection.go b/service/outposts/api_op_GetConnection.go index 99b8d7ba3f4..d0c484a0171 100644 --- a/service/outposts/api_op_GetConnection.go +++ b/service/outposts/api_op_GetConnection.go @@ -14,12 +14,10 @@ import ( // Amazon Web Services uses this action to install Outpost servers. Gets // information about the specified connection. Use CloudTrail to monitor this // action or Amazon Web Services managed policy for Amazon Web Services Outposts to -// secure it. For more information, see Amazon Web Services managed policies for -// Amazon Web Services Outposts -// (https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) -// and Logging Amazon Web Services Outposts API calls with Amazon Web Services -// CloudTrail -// (https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) +// secure it. For more information, see Amazon Web Services managed policies for +// Amazon Web Services Outposts (https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) +// and Logging Amazon Web Services Outposts API calls with Amazon Web Services +// CloudTrail (https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) // in the Amazon Web Services Outposts User Guide. func (c *Client) GetConnection(ctx context.Context, params *GetConnectionInput, optFns ...func(*Options)) (*GetConnectionOutput, error) { if params == nil { diff --git a/service/outposts/api_op_ListOutposts.go b/service/outposts/api_op_ListOutposts.go index cb6876b73c1..8e0e355055e 100644 --- a/service/outposts/api_op_ListOutposts.go +++ b/service/outposts/api_op_ListOutposts.go @@ -34,10 +34,10 @@ func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, op type ListOutpostsInput struct { - // Filters the results by Availability Zone (for example, us-east-1a). + // Filters the results by Availability Zone (for example, us-east-1a ). AvailabilityZoneFilter []string - // Filters the results by AZ ID (for example, use1-az1). + // Filters the results by AZ ID (for example, use1-az1 ). AvailabilityZoneIdFilter []string // Filters the results by the lifecycle status. diff --git a/service/outposts/api_op_StartConnection.go b/service/outposts/api_op_StartConnection.go index 9b196b41096..8044fddecf0 100644 --- a/service/outposts/api_op_StartConnection.go +++ b/service/outposts/api_op_StartConnection.go @@ -13,12 +13,10 @@ import ( // Amazon Web Services uses this action to install Outpost servers. Starts the // connection required for Outpost server installation. Use CloudTrail to monitor // this action or Amazon Web Services managed policy for Amazon Web Services -// Outposts to secure it. For more information, see Amazon Web Services managed -// policies for Amazon Web Services Outposts -// (https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) -// and Logging Amazon Web Services Outposts API calls with Amazon Web Services -// CloudTrail -// (https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) +// Outposts to secure it. For more information, see Amazon Web Services managed +// policies for Amazon Web Services Outposts (https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html) +// and Logging Amazon Web Services Outposts API calls with Amazon Web Services +// CloudTrail (https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html) // in the Amazon Web Services Outposts User Guide. func (c *Client) StartConnection(ctx context.Context, params *StartConnectionInput, optFns ...func(*Options)) (*StartConnectionOutput, error) { if params == nil { diff --git a/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go b/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go index d202395480d..33feb11bea9 100644 --- a/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go +++ b/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go @@ -13,10 +13,9 @@ import ( // Update the physical and logistical details for a rack at a site. For more // information about hardware requirements for racks, see Network readiness -// checklist -// (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) +// checklist (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) // in the Amazon Web Services Outposts User Guide. To update a rack at a site with -// an order of IN_PROGRESS, you must wait for the order to complete or cancel the +// an order of IN_PROGRESS , you must wait for the order to complete or cancel the // order. func (c *Client) UpdateSiteRackPhysicalProperties(ctx context.Context, params *UpdateSiteRackPhysicalPropertiesInput, optFns ...func(*Options)) (*UpdateSiteRackPhysicalPropertiesOutput, error) { if params == nil { @@ -49,61 +48,32 @@ type UpdateSiteRackPhysicalPropertiesInput struct { // The type of optical standard that you will use to attach the Outpost to your // network. This field is dependent on uplink speed, fiber type, and distance to // the upstream device. For more information about networking requirements for - // racks, see Network - // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) + // racks, see Network (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) // in the Amazon Web Services Outposts User Guide. - // - // * OPTIC_10GBASE_SR: - // 10GBASE-SR - // - // * OPTIC_10GBASE_IR: 10GBASE-IR - // - // * OPTIC_10GBASE_LR: 10GBASE-LR - // - // * - // OPTIC_40GBASE_SR: 40GBASE-SR - // - // * OPTIC_40GBASE_ESR: 40GBASE-ESR - // - // * - // OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L) - // - // * OPTIC_40GBASE_LR4: 40GBASE-LR4 - // - // * - // OPTIC_100GBASE_SR4: 100GBASE-SR4 - // - // * OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4 - // - // * - // OPTIC_100GBASE_LR4: 100GBASE-LR4 - // - // * OPTIC_100G_PSM4_MSA: 100G PSM4 MSA - // - // * - // OPTIC_1000BASE_LX: 1000Base-LX - // - // * OPTIC_1000BASE_SX : 1000Base-SX + // - OPTIC_10GBASE_SR : 10GBASE-SR + // - OPTIC_10GBASE_IR : 10GBASE-IR + // - OPTIC_10GBASE_LR : 10GBASE-LR + // - OPTIC_40GBASE_SR : 40GBASE-SR + // - OPTIC_40GBASE_ESR : 40GBASE-ESR + // - OPTIC_40GBASE_IR4_LR4L : 40GBASE-IR (LR4L) + // - OPTIC_40GBASE_LR4 : 40GBASE-LR4 + // - OPTIC_100GBASE_SR4 : 100GBASE-SR4 + // - OPTIC_100GBASE_CWDM4 : 100GBASE-CWDM4 + // - OPTIC_100GBASE_LR4 : 100GBASE-LR4 + // - OPTIC_100G_PSM4_MSA : 100G PSM4 MSA + // - OPTIC_1000BASE_LX : 1000Base-LX + // - OPTIC_1000BASE_SX : 1000Base-SX OpticalStandard types.OpticalStandard // The power connector that Amazon Web Services should plan to provide for // connections to the hardware. Note the correlation between PowerPhase and - // PowerConnector. - // - // * Single-phase AC feed - // - // * L6-30P – (common in US); 30A; single - // phase - // - // * IEC309 (blue) – P+N+E, 6hr; 32 A; single phase - // - // * Three-phase AC - // feed - // - // * AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase - // - // * AH532P6W (red) – - // 3P+N+E, 6hr; 32A; three phase + // PowerConnector . + // - Single-phase AC feed + // - L6-30P – (common in US); 30A; single phase + // - IEC309 (blue) – P+N+E, 6hr; 32 A; single phase + // - Three-phase AC feed + // - AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase + // - AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase PowerConnector types.PowerConnector // The power draw, in kVA, available at the hardware placement position for the @@ -114,27 +84,18 @@ type UpdateSiteRackPhysicalPropertiesInput struct { PowerFeedDrop types.PowerFeedDrop // The power option that you can provide for hardware. - // - // * Single-phase AC feed: 200 - // V to 277 V, 50 Hz or 60 Hz - // - // * Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 - // Hz + // - Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz + // - Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz PowerPhase types.PowerPhase // Racks come with two Outpost network devices. Depending on the supported uplink // speed at the site, the Outpost network devices provide a variable number of // uplinks. Specify the number of uplinks for each Outpost network device that you // intend to use to connect the rack to your network. Note the correlation between - // UplinkGbps and UplinkCount. - // - // * 1Gbps - Uplinks available: 1, 2, 4, 6, 8 - // - // * - // 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16 - // - // * 40 and 100 Gbps- Uplinks - // available: 1, 2, 4 + // UplinkGbps and UplinkCount . + // - 1Gbps - Uplinks available: 1, 2, 4, 6, 8 + // - 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16 + // - 40 and 100 Gbps- Uplinks available: 1, 2, 4 UplinkCount types.UplinkCount // The uplink speed the rack should support for the connection to the Region. diff --git a/service/outposts/types/enums.go b/service/outposts/types/enums.go index b09d06fa64d..13e9119c3a2 100644 --- a/service/outposts/types/enums.go +++ b/service/outposts/types/enums.go @@ -45,9 +45,9 @@ const ( AssetTypeCompute AssetType = "COMPUTE" ) -// Values returns all known values for AssetType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AssetType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AssetType) Values() []AssetType { return []AssetType{ "COMPUTE", @@ -266,9 +266,9 @@ const ( OrderTypeReplacement OrderType = "REPLACEMENT" ) -// Values returns all known values for OrderType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OrderType) Values() []OrderType { return []OrderType{ "OUTPOST", @@ -346,9 +346,9 @@ const ( PowerDrawKvaPower30Kva PowerDrawKva = "POWER_30_KVA" ) -// Values returns all known values for PowerDrawKva. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PowerDrawKva. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PowerDrawKva) Values() []PowerDrawKva { return []PowerDrawKva{ "POWER_5_KVA", @@ -402,9 +402,9 @@ const ( ResourceTypeOrder ResourceType = "ORDER" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "OUTPOST", @@ -442,8 +442,8 @@ const ( SupportedHardwareTypeServer SupportedHardwareType = "SERVER" ) -// Values returns all known values for SupportedHardwareType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SupportedHardwareType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SupportedHardwareType) Values() []SupportedHardwareType { return []SupportedHardwareType{ diff --git a/service/outposts/types/types.go b/service/outposts/types/types.go index 20aa77a2602..90e94f866c8 100644 --- a/service/outposts/types/types.go +++ b/service/outposts/types/types.go @@ -120,18 +120,14 @@ type ComputeAttributes struct { HostId *string // The state. - // - // * ACTIVE - The asset is available and can provide capacity for new - // compute resources. - // - // * ISOLATED - The asset is undergoing maintenance and can't - // provide capacity for new compute resources. Existing compute resources on the - // asset are not affected. - // - // * RETIRING - The underlying hardware for the asset is - // degraded. Capacity for new compute resources is reduced. Amazon Web Services - // sends notifications for resources that must be stopped before the asset can be - // replaced. + // - ACTIVE - The asset is available and can provide capacity for new compute + // resources. + // - ISOLATED - The asset is undergoing maintenance and can't provide capacity + // for new compute resources. Existing compute resources on the asset are not + // affected. + // - RETIRING - The underlying hardware for the asset is degraded. Capacity for + // new compute resources is reduced. Amazon Web Services sends notifications for + // resources that must be stopped before the asset can be replaced. State ComputeAssetState noSmithyDocumentSerde @@ -267,23 +263,14 @@ type Order struct { PaymentTerm PaymentTerm // The status of the order. - // - // * PREPARING - Order is received and being prepared. - // - // * - // IN_PROGRESS - Order is either being built, shipped, or installed. To get more - // details, see the line item status. - // - // * COMPLETED - Order is complete. - // - // * - // CANCELLED - Order is cancelled. - // - // * ERROR - Customer should contact support. - // - // The - // following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and - // FULFILLED. + // - PREPARING - Order is received and being prepared. + // - IN_PROGRESS - Order is either being built, shipped, or installed. To get + // more details, see the line item status. + // - COMPLETED - Order is complete. + // - CANCELLED - Order is cancelled. + // - ERROR - Customer should contact support. + // The following status are deprecated: RECEIVED , PENDING , PROCESSING , + // INSTALLING , and FULFILLED . Status OrderStatus noSmithyDocumentSerde @@ -311,23 +298,14 @@ type OrderSummary struct { OutpostId *string // The status of the order. - // - // * PREPARING - Order is received and is being - // prepared. - // - // * IN_PROGRESS - Order is either being built, shipped, or installed. - // For more information, see the LineItem status. - // - // * COMPLETED - Order is - // complete. - // - // * CANCELLED - Order is cancelled. - // - // * ERROR - Customer should contact - // support. - // - // The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, - // INSTALLING, and FULFILLED. + // - PREPARING - Order is received and is being prepared. + // - IN_PROGRESS - Order is either being built, shipped, or installed. For more + // information, see the LineItem status. + // - COMPLETED - Order is complete. + // - CANCELLED - Order is cancelled. + // - ERROR - Customer should contact support. + // The following statuses are deprecated: RECEIVED , PENDING , PROCESSING , + // INSTALLING , and FULFILLED . Status OrderStatus noSmithyDocumentSerde @@ -377,8 +355,7 @@ type Outpost struct { // Information about the physical and logistical details for racks at sites. For // more information about hardware requirements for racks, see Network readiness -// checklist -// (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) +// checklist (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) // in the Amazon Web Services Outposts User Guide. type RackPhysicalProperties struct { @@ -392,8 +369,7 @@ type RackPhysicalProperties struct { // The type of optical standard used to attach the Outpost to the network. This // field is dependent on uplink speed, fiber type, and distance to the upstream // device. For more information about networking requirements for racks, see - // Network - // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) + // Network (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) // in the Amazon Web Services Outposts User Guide. OpticalStandard OpticalStandard @@ -448,8 +424,8 @@ type Site struct { // City where the hardware is installed and powered on. OperatingAddressCity *string - // The ISO-3166 two-letter country code where the hardware is installed and powered - // on. + // The ISO-3166 two-letter country code where the hardware is installed and + // powered on. OperatingAddressCountryCode *string // State or region where the hardware is installed and powered on. diff --git a/service/panorama/api_client.go b/service/panorama/api_client.go index 216c99fbdd7..81d85cbd1af 100644 --- a/service/panorama/api_client.go +++ b/service/panorama/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/panorama/api_op_CreateJobForDevices.go b/service/panorama/api_op_CreateJobForDevices.go index 4f89047d776..1e885c4581c 100644 --- a/service/panorama/api_op_CreateJobForDevices.go +++ b/service/panorama/api_op_CreateJobForDevices.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a job to run on a device. A job can update a device's software or reboot -// it. +// Creates a job to run on a device. A job can update a device's software or +// reboot it. func (c *Client) CreateJobForDevices(ctx context.Context, params *CreateJobForDevicesInput, optFns ...func(*Options)) (*CreateJobForDevicesOutput, error) { if params == nil { params = &CreateJobForDevicesInput{} diff --git a/service/panorama/api_op_ListApplicationInstanceDependencies.go b/service/panorama/api_op_ListApplicationInstanceDependencies.go index 161e8e6e096..cc846b1663b 100644 --- a/service/panorama/api_op_ListApplicationInstanceDependencies.go +++ b/service/panorama/api_op_ListApplicationInstanceDependencies.go @@ -35,8 +35,8 @@ type ListApplicationInstanceDependenciesInput struct { // This member is required. ApplicationInstanceId *string - // The maximum number of application instance dependencies to return in one page of - // results. + // The maximum number of application instance dependencies to return in one page + // of results. MaxResults int32 // Specify the pagination token from a previous request to retrieve the next page @@ -131,11 +131,11 @@ type ListApplicationInstanceDependenciesAPIClient interface { var _ ListApplicationInstanceDependenciesAPIClient = (*Client)(nil) -// ListApplicationInstanceDependenciesPaginatorOptions is the paginator options for -// ListApplicationInstanceDependencies +// ListApplicationInstanceDependenciesPaginatorOptions is the paginator options +// for ListApplicationInstanceDependencies type ListApplicationInstanceDependenciesPaginatorOptions struct { - // The maximum number of application instance dependencies to return in one page of - // results. + // The maximum number of application instance dependencies to return in one page + // of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/panorama/doc.go b/service/panorama/doc.go index f3822ad99b8..8ce0f2373e9 100644 --- a/service/panorama/doc.go +++ b/service/panorama/doc.go @@ -4,7 +4,6 @@ // AWS Panorama. // // AWS Panorama Overview This is the AWS Panorama API Reference. For an -// introduction to the service, see What is AWS Panorama? -// (https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html) in the -// AWS Panorama Developer Guide. +// introduction to the service, see What is AWS Panorama? (https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html) +// in the AWS Panorama Developer Guide. package panorama diff --git a/service/panorama/types/enums.go b/service/panorama/types/enums.go index 73b1bdc0d1d..029a6b111f8 100644 --- a/service/panorama/types/enums.go +++ b/service/panorama/types/enums.go @@ -86,9 +86,9 @@ const ( DesiredStateRemoved DesiredState = "REMOVED" ) -// Values returns all known values for DesiredState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DesiredState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DesiredState) Values() []DesiredState { return []DesiredState{ "RUNNING", @@ -221,9 +221,9 @@ const ( DeviceStatusDeleting DeviceStatus = "DELETING" ) -// Values returns all known values for DeviceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeviceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DeviceStatus) Values() []DeviceStatus { return []DeviceStatus{ "AWAITING_PROVISIONING", @@ -339,9 +339,9 @@ const ( NodeCategoryMediaSink NodeCategory = "MEDIA_SINK" ) -// Values returns all known values for NodeCategory. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for NodeCategory. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (NodeCategory) Values() []NodeCategory { return []NodeCategory{ "BUSINESS_LOGIC", @@ -503,9 +503,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -526,9 +526,9 @@ const ( StatusFilterDeploymentFailed StatusFilter = "DEPLOYMENT_FAILED" ) -// Values returns all known values for StatusFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StatusFilter. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StatusFilter) Values() []StatusFilter { return []StatusFilter{ "DEPLOYMENT_SUCCEEDED", @@ -548,9 +548,9 @@ const ( TemplateTypeRtspCameraStream TemplateType = "RTSP_CAMERA_STREAM" ) -// Values returns all known values for TemplateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TemplateType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TemplateType) Values() []TemplateType { return []TemplateType{ "RTSP_CAMERA_STREAM", diff --git a/service/panorama/types/types.go b/service/panorama/types/types.go index 993127693c7..c924df703a1 100644 --- a/service/panorama/types/types.go +++ b/service/panorama/types/types.go @@ -224,7 +224,7 @@ type LatestDeviceJob struct { } // Parameter overrides for an application instance. This is a JSON document that -// has a single key (PayloadData) where the value is an escaped string +// has a single key ( PayloadData ) where the value is an escaped string // representation of the overrides document. // // The following types satisfy this interface: @@ -244,9 +244,9 @@ type ManifestOverridesPayloadMemberPayloadData struct { func (*ManifestOverridesPayloadMemberPayloadData) isManifestOverridesPayload() {} // A application verion's manifest file. This is a JSON document that has a single -// key (PayloadData) where the value is an escaped string representation of the -// application manifest (graph.json). This file is located in the graphs folder in -// your application source. +// key ( PayloadData ) where the value is an escaped string representation of the +// application manifest ( graph.json ). This file is located in the graphs folder +// in your application source. // // The following types satisfy this interface: // @@ -475,8 +475,8 @@ type NodeSignal struct { noSmithyDocumentSerde } -// Network time protocol (NTP) server settings. Use this option to connect to local -// NTP servers instead of pool.ntp.org. +// Network time protocol (NTP) server settings. Use this option to connect to +// local NTP servers instead of pool.ntp.org . type NtpPayload struct { // NTP servers to use, in order of preference. diff --git a/service/personalize/api_client.go b/service/personalize/api_client.go index 3ceab46180a..5fca1e00a28 100644 --- a/service/personalize/api_client.go +++ b/service/personalize/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/personalize/api_op_CreateBatchInferenceJob.go b/service/personalize/api_op_CreateBatchInferenceJob.go index b8c01c12dec..939d3b21ada 100644 --- a/service/personalize/api_op_CreateBatchInferenceJob.go +++ b/service/personalize/api_op_CreateBatchInferenceJob.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a batch inference job. The operation can handle up to 50 million records -// and the input file must be in JSON format. For more information, see Creating a -// batch inference job -// (https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html). +// Creates a batch inference job. The operation can handle up to 50 million +// records and the input file must be in JSON format. For more information, see +// Creating a batch inference job (https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html) +// . func (c *Client) CreateBatchInferenceJob(ctx context.Context, params *CreateBatchInferenceJobInput, optFns ...func(*Options)) (*CreateBatchInferenceJobOutput, error) { if params == nil { params = &CreateBatchInferenceJobInput{} @@ -32,8 +32,8 @@ func (c *Client) CreateBatchInferenceJob(ctx context.Context, params *CreateBatc type CreateBatchInferenceJobInput struct { - // The Amazon S3 path that leads to the input file to base your recommendations on. - // The input material must be in JSON format. + // The Amazon S3 path that leads to the input file to base your recommendations + // on. The input material must be in JSON format. // // This member is required. JobInput *types.BatchInferenceJobInput @@ -64,16 +64,15 @@ type CreateBatchInferenceJobInput struct { BatchInferenceJobConfig *types.BatchInferenceJobConfig // The ARN of the filter to apply to the batch inference job. For more information - // on using filters, see Filtering batch recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html). + // on using filters, see Filtering batch recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html) + // . FilterArn *string // The number of recommendations to retrieve. NumResults *int32 - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the batch inference job. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the batch inference job. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateBatchSegmentJob.go b/service/personalize/api_op_CreateBatchSegmentJob.go index e24de07e24b..cf429ee814f 100644 --- a/service/personalize/api_op_CreateBatchSegmentJob.go +++ b/service/personalize/api_op_CreateBatchSegmentJob.go @@ -13,8 +13,8 @@ import ( // Creates a batch segment job. The operation can handle up to 50 million records // and the input file must be in JSON format. For more information, see Getting -// batch recommendations and user segments -// (https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html). +// batch recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html) +// . func (c *Client) CreateBatchSegmentJob(ctx context.Context, params *CreateBatchSegmentJobInput, optFns ...func(*Options)) (*CreateBatchSegmentJobOutput, error) { if params == nil { params = &CreateBatchSegmentJobInput{} @@ -59,18 +59,17 @@ type CreateBatchSegmentJobInput struct { // This member is required. SolutionVersionArn *string - // The ARN of the filter to apply to the batch segment job. For more information on - // using filters, see Filtering batch recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html). + // The ARN of the filter to apply to the batch segment job. For more information + // on using filters, see Filtering batch recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html) + // . FilterArn *string // The number of predicted users generated by the batch segment job for each line // of input data. NumResults *int32 - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the batch segment job. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the batch segment job. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateCampaign.go b/service/personalize/api_op_CreateCampaign.go index ffa31dace21..9cf226709bb 100644 --- a/service/personalize/api_op_CreateCampaign.go +++ b/service/personalize/api_op_CreateCampaign.go @@ -12,50 +12,32 @@ import ( ) // Creates a campaign that deploys a solution version. When a client calls the -// GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) -// and GetPersonalizedRanking -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) +// GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// and GetPersonalizedRanking (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) // APIs, a campaign is specified in the request. Minimum Provisioned TPS and // Auto-Scaling A transaction is a single GetRecommendations or // GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and -// unit of billing for Amazon Personalize. The minimum provisioned TPS -// (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon +// unit of billing for Amazon Personalize. The minimum provisioned TPS ( +// minProvisionedTPS ) specifies the baseline throughput provisioned by Amazon // Personalize, and thus, the minimum billing charge. If your TPS increases beyond -// minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up -// and down, but never below minProvisionedTPS. There's a short time delay while +// minProvisionedTPS , Amazon Personalize auto-scales the provisioned capacity up +// and down, but never below minProvisionedTPS . There's a short time delay while // the capacity is increased that might cause loss of transactions. The actual TPS // used is calculated as the average requests/second within a 5-minute window. You // pay for maximum of either the minimum provisioned TPS or the actual TPS. We -// recommend starting with a low minProvisionedTPS, track your usage using Amazon -// CloudWatch metrics, and then increase the minProvisionedTPS as necessary. Status -// A campaign can be in one of the following states: +// recommend starting with a low minProvisionedTPS , track your usage using Amazon +// CloudWatch metrics, and then increase the minProvisionedTPS as necessary. +// Status A campaign can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > CREATE -// IN_PROGRESS > ACTIVE -or- CREATE FAILED -// -// * DELETE PENDING > DELETE -// IN_PROGRESS -// -// To get the campaign status, call DescribeCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html). -// Wait until the status of the campaign is ACTIVE before asking the campaign for -// recommendations. Related APIs -// -// * ListCampaigns -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) -// -// * -// DescribeCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) -// -// * -// UpdateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html) -// -// * -// DeleteCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html) +// To get the campaign status, call DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) +// . Wait until the status of the campaign is ACTIVE before asking the campaign +// for recommendations. Related APIs +// - ListCampaigns (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) +// - DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) +// - UpdateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html) +// - DeleteCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html) func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error) { if params == nil { params = &CreateCampaignInput{} @@ -91,9 +73,8 @@ type CreateCampaignInput struct { // second that Amazon Personalize will support. MinProvisionedTPS *int32 - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the campaign. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the campaign. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDataset.go b/service/personalize/api_op_CreateDataset.go index d2f49a29a34..7b80edf81e1 100644 --- a/service/personalize/api_op_CreateDataset.go +++ b/service/personalize/api_op_CreateDataset.go @@ -12,46 +12,24 @@ import ( ) // Creates an empty dataset and adds it to the specified dataset group. Use -// CreateDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) +// CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) // to import your training data to a dataset. There are three types of datasets: +// - Interactions +// - Items +// - Users // -// * -// Interactions +// Each dataset type has an associated schema with required field types. Only the +// Interactions dataset is required in order to train a model (also referred to as +// creating a solution). A dataset can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING > DELETE IN_PROGRESS // -// * Items -// -// * Users -// -// Each dataset type has an associated schema with -// required field types. Only the Interactions dataset is required in order to -// train a model (also referred to as creating a solution). A dataset can be in one -// of the following states: -// -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- -// CREATE FAILED -// -// * DELETE PENDING > DELETE IN_PROGRESS -// -// To get the status of the -// dataset, call DescribeDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html). -// Related APIs -// -// * CreateDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) -// -// * -// ListDatasets -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) -// -// * -// DescribeDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) -// -// * -// DeleteDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) +// To get the status of the dataset, call DescribeDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) +// . Related APIs +// - CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) +// - ListDatasets (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) +// - DescribeDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) +// - DeleteDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -75,13 +53,9 @@ type CreateDatasetInput struct { DatasetGroupArn *string // The type of dataset. One of the following (case insensitive) values: - // - // * - // Interactions - // - // * Items - // - // * Users + // - Interactions + // - Items + // - Users // // This member is required. DatasetType *string @@ -97,9 +71,8 @@ type CreateDatasetInput struct { // This member is required. SchemaArn *string - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the dataset. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the dataset. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetExportJob.go b/service/personalize/api_op_CreateDatasetExportJob.go index 1beb21852c9..acb4e806cf0 100644 --- a/service/personalize/api_op_CreateDatasetExportJob.go +++ b/service/personalize/api_op_CreateDatasetExportJob.go @@ -14,21 +14,16 @@ import ( // Creates a job that exports data from your dataset to an Amazon S3 bucket. To // allow Amazon Personalize to export the training data, you must specify an // service-linked IAM role that gives Amazon Personalize PutObject permissions for -// your Amazon S3 bucket. For information, see Exporting a dataset -// (https://docs.aws.amazon.com/personalize/latest/dg/export-data.html) in the -// Amazon Personalize developer guide. Status A dataset export job can be in one of -// the following states: +// your Amazon S3 bucket. For information, see Exporting a dataset (https://docs.aws.amazon.com/personalize/latest/dg/export-data.html) +// in the Amazon Personalize developer guide. Status A dataset export job can be in +// one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED // -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- -// CREATE FAILED -// -// To get the status of the export job, call -// DescribeDatasetExportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html), -// and specify the Amazon Resource Name (ARN) of the dataset export job. The +// To get the status of the export job, call DescribeDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) +// , and specify the Amazon Resource Name (ARN) of the dataset export job. The // dataset export is complete when the status shows as ACTIVE. If the status shows -// as CREATE FAILED, the response includes a failureReason key, which describes why -// the job failed. +// as CREATE FAILED, the response includes a failureReason key, which describes +// why the job failed. func (c *Client) CreateDatasetExportJob(ctx context.Context, params *CreateDatasetExportJobInput, optFns ...func(*Options)) (*CreateDatasetExportJobOutput, error) { if params == nil { params = &CreateDatasetExportJobInput{} @@ -67,15 +62,14 @@ type CreateDatasetExportJobInput struct { // This member is required. RoleArn *string - // The data to export, based on how you imported the data. You can choose to export - // only BULK data that you imported using a dataset import job, only PUT data that - // you imported incrementally (using the console, PutEvents, PutUsers and PutItems - // operations), or ALL for both types. The default value is PUT. + // The data to export, based on how you imported the data. You can choose to + // export only BULK data that you imported using a dataset import job, only PUT + // data that you imported incrementally (using the console, PutEvents, PutUsers and + // PutItems operations), or ALL for both types. The default value is PUT . IngestionMode types.IngestionMode - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the dataset export job. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the dataset export job. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetGroup.go b/service/personalize/api_op_CreateDatasetGroup.go index f807c3b07cf..8afdfc8d3a1 100644 --- a/service/personalize/api_op_CreateDatasetGroup.go +++ b/service/personalize/api_op_CreateDatasetGroup.go @@ -14,62 +14,36 @@ import ( // Creates an empty dataset group. A dataset group is a container for Amazon // Personalize resources. A dataset group can contain at most three datasets, one // for each type of dataset: +// - Interactions +// - Items +// - Users // -// * Interactions +// A dataset group can be a Domain dataset group, where you specify a domain and +// use pre-configured resources like recommenders, or a Custom dataset group, where +// you use custom resources, such as a solution with a solution version, that you +// deploy with a campaign. If you start with a Domain dataset group, you can still +// add custom resources such as solutions and solution versions trained with +// recipes for custom use cases and deployed with campaigns. A dataset group can be +// in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING // -// * Items +// To get the status of the dataset group, call DescribeDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) +// . If the status shows as CREATE FAILED, the response includes a failureReason +// key, which describes why the creation failed. You must wait until the status of +// the dataset group is ACTIVE before adding a dataset to the group. You can +// specify an Key Management Service (KMS) key to encrypt the datasets in the +// group. If you specify a KMS key, you must also include an Identity and Access +// Management (IAM) role that has permission to access the key. APIs that require a +// dataset group ARN in the request +// - CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// - CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) +// - CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) // -// * Users -// -// A dataset group can -// be a Domain dataset group, where you specify a domain and use pre-configured -// resources like recommenders, or a Custom dataset group, where you use custom -// resources, such as a solution with a solution version, that you deploy with a -// campaign. If you start with a Domain dataset group, you can still add custom -// resources such as solutions and solution versions trained with recipes for -// custom use cases and deployed with campaigns. A dataset group can be in one of -// the following states: -// -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- -// CREATE FAILED -// -// * DELETE PENDING -// -// To get the status of the dataset group, call -// DescribeDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html). -// If the status shows as CREATE FAILED, the response includes a failureReason key, -// which describes why the creation failed. You must wait until the status of the -// dataset group is ACTIVE before adding a dataset to the group. You can specify an -// Key Management Service (KMS) key to encrypt the datasets in the group. If you -// specify a KMS key, you must also include an Identity and Access Management (IAM) -// role that has permission to access the key. APIs that require a dataset group -// ARN in the request -// -// * CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) -// -// * -// CreateEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) -// -// * -// CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) -// -// Related -// APIs -// -// * ListDatasetGroups -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html) -// -// * -// DescribeDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) -// -// * -// DeleteDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html) +// Related APIs +// - ListDatasetGroups (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html) +// - DescribeDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) +// - DeleteDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html) func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGroupInput, optFns ...func(*Options)) (*CreateDatasetGroupOutput, error) { if params == nil { params = &CreateDatasetGroupInput{} @@ -103,14 +77,13 @@ type CreateDatasetGroupInput struct { // encrypt the datasets. KmsKeyArn *string - // The ARN of the Identity and Access Management (IAM) role that has permissions to - // access the Key Management Service (KMS) key. Supplying an IAM role is only valid - // when also specifying a KMS key. + // The ARN of the Identity and Access Management (IAM) role that has permissions + // to access the Key Management Service (KMS) key. Supplying an IAM role is only + // valid when also specifying a KMS key. RoleArn *string - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the dataset group. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the dataset group. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetImportJob.go b/service/personalize/api_op_CreateDatasetImportJob.go index 3e5401991ac..5f8657a4abe 100644 --- a/service/personalize/api_op_CreateDatasetImportJob.go +++ b/service/personalize/api_op_CreateDatasetImportJob.go @@ -16,32 +16,21 @@ import ( // the training data, you must specify an IAM service role that has permission to // read from the data source, as Amazon Personalize makes a copy of your data and // processes it internally. For information on granting access to your Amazon S3 -// bucket, see Giving Amazon Personalize Access to Amazon S3 Resources -// (https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html). -// By default, a dataset import job replaces any existing data in the dataset that -// you imported in bulk. To add new records without replacing existing data, +// bucket, see Giving Amazon Personalize Access to Amazon S3 Resources (https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html) +// . By default, a dataset import job replaces any existing data in the dataset +// that you imported in bulk. To add new records without replacing existing data, // specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation. // Status A dataset import job can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED // -// * CREATE -// PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED -// -// To get the status of -// the import job, call DescribeDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html), -// providing the Amazon Resource Name (ARN) of the dataset import job. The dataset -// import is complete when the status shows as ACTIVE. If the status shows as -// CREATE FAILED, the response includes a failureReason key, which describes why -// the job failed. Importing takes time. You must wait until the status shows as -// ACTIVE before training a model using the dataset. Related APIs -// -// * -// ListDatasetImportJobs -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html) -// -// * -// DescribeDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) +// To get the status of the import job, call DescribeDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) +// , providing the Amazon Resource Name (ARN) of the dataset import job. The +// dataset import is complete when the status shows as ACTIVE. If the status shows +// as CREATE FAILED, the response includes a failureReason key, which describes +// why the job failed. Importing takes time. You must wait until the status shows +// as ACTIVE before training a model using the dataset. Related APIs +// - ListDatasetImportJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html) +// - DescribeDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error) { if params == nil { params = &CreateDatasetImportJobInput{} @@ -81,24 +70,21 @@ type CreateDatasetImportJobInput struct { RoleArn *string // Specify how to add the new records to an existing dataset. The default import - // mode is FULL. If you haven't imported bulk records into the dataset previously, - // you can only specify FULL. - // - // * Specify FULL to overwrite all existing bulk data - // in your dataset. Data you imported individually is not replaced. - // - // * Specify - // INCREMENTAL to append the new records to the existing data in your dataset. - // Amazon Personalize replaces any record with the same ID with the new one. + // mode is FULL . If you haven't imported bulk records into the dataset previously, + // you can only specify FULL . + // - Specify FULL to overwrite all existing bulk data in your dataset. Data you + // imported individually is not replaced. + // - Specify INCREMENTAL to append the new records to the existing data in your + // dataset. Amazon Personalize replaces any record with the same ID with the new + // one. ImportMode types.ImportMode - // If you created a metric attribution, specify whether to publish metrics for this - // import job to Amazon S3 + // If you created a metric attribution, specify whether to publish metrics for + // this import job to Amazon S3 PublishAttributionMetricsToS3 *bool - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the dataset import job. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the dataset import job. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateEventTracker.go b/service/personalize/api_op_CreateEventTracker.go index a3cdebc72cb..f8a73a6daaf 100644 --- a/service/personalize/api_op_CreateEventTracker.go +++ b/service/personalize/api_op_CreateEventTracker.go @@ -12,38 +12,23 @@ import ( ) // Creates an event tracker that you use when adding event data to a specified -// dataset group using the PutEvents -// (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. -// Only one event tracker can be associated with a dataset group. You will get an -// error if you call CreateEventTracker using the same dataset group as an existing -// event tracker. When you create an event tracker, the response includes a -// tracking ID, which you pass as a parameter when you use the PutEvents -// (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) +// dataset group using the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) +// API. Only one event tracker can be associated with a dataset group. You will get +// an error if you call CreateEventTracker using the same dataset group as an +// existing event tracker. When you create an event tracker, the response includes +// a tracking ID, which you pass as a parameter when you use the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) // operation. Amazon Personalize then appends the event data to the Interactions // dataset of the dataset group you specify in your event tracker. The event // tracker can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > CREATE -// IN_PROGRESS > ACTIVE -or- CREATE FAILED -// -// * DELETE PENDING > DELETE -// IN_PROGRESS -// -// To get the status of the event tracker, call DescribeEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html). -// The event tracker must be in the ACTIVE state before using the tracking ID. +// To get the status of the event tracker, call DescribeEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) +// . The event tracker must be in the ACTIVE state before using the tracking ID. // Related APIs -// -// * ListEventTrackers -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html) -// -// * -// DescribeEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) -// -// * -// DeleteEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html) +// - ListEventTrackers (https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html) +// - DescribeEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) +// - DeleteEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html) func (c *Client) CreateEventTracker(ctx context.Context, params *CreateEventTrackerInput, optFns ...func(*Options)) (*CreateEventTrackerOutput, error) { if params == nil { params = &CreateEventTrackerInput{} @@ -72,9 +57,8 @@ type CreateEventTrackerInput struct { // This member is required. Name *string - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the event tracker. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the event tracker. Tags []types.Tag noSmithyDocumentSerde @@ -85,8 +69,8 @@ type CreateEventTrackerOutput struct { // The ARN of the event tracker. EventTrackerArn *string - // The ID of the event tracker. Include this ID in requests to the PutEvents - // (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. + // The ID of the event tracker. Include this ID in requests to the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) + // API. TrackingId *string // Metadata pertaining to the operation's result. diff --git a/service/personalize/api_op_CreateFilter.go b/service/personalize/api_op_CreateFilter.go index 33d11cc34f4..06e686ade63 100644 --- a/service/personalize/api_op_CreateFilter.go +++ b/service/personalize/api_op_CreateFilter.go @@ -12,8 +12,8 @@ import ( ) // Creates a recommendation filter. For more information, see Filtering -// recommendations and user segments -// (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). +// recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) +// . func (c *Client) CreateFilter(ctx context.Context, params *CreateFilterInput, optFns ...func(*Options)) (*CreateFilterOutput, error) { if params == nil { params = &CreateFilterInput{} @@ -38,8 +38,8 @@ type CreateFilterInput struct { // The filter expression defines which items are included or excluded from // recommendations. Filter expression must follow specific format rules. For - // information about filter expression structure and syntax, see Filter expressions - // (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html). + // information about filter expression structure and syntax, see Filter expressions (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html) + // . // // This member is required. FilterExpression *string @@ -49,9 +49,8 @@ type CreateFilterInput struct { // This member is required. Name *string - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the filter. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the filter. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateMetricAttribution.go b/service/personalize/api_op_CreateMetricAttribution.go index 91bdc249f95..0e6701e3501 100644 --- a/service/personalize/api_op_CreateMetricAttribution.go +++ b/service/personalize/api_op_CreateMetricAttribution.go @@ -14,8 +14,8 @@ import ( // Creates a metric attribution. A metric attribution creates reports on the data // that you import into Amazon Personalize. Depending on how you imported the data, // you can view reports in Amazon CloudWatch or Amazon S3. For more information, -// see Measuring impact of recommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +// see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) +// . func (c *Client) CreateMetricAttribution(ctx context.Context, params *CreateMetricAttributionInput, optFns ...func(*Options)) (*CreateMetricAttributionOutput, error) { if params == nil { params = &CreateMetricAttributionInput{} @@ -41,7 +41,7 @@ type CreateMetricAttributionInput struct { // A list of metric attributes for the metric attribution. Each metric attribute // specifies an event type to track and a function. Available functions are SUM() - // or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either + // or SAMPLECOUNT() . For SUM() functions, provide the dataset type (either // Interactions or Items) and column to sum as a parameter. For example // SUM(Items.PRICE). // diff --git a/service/personalize/api_op_CreateRecommender.go b/service/personalize/api_op_CreateRecommender.go index 049592ba85e..17d80528684 100644 --- a/service/personalize/api_op_CreateRecommender.go +++ b/service/personalize/api_op_CreateRecommender.go @@ -13,58 +13,39 @@ import ( // Creates a recommender with the recipe (a Domain dataset group use case) you // specify. You create recommenders for a Domain dataset group and specify the -// recommender's Amazon Resource Name (ARN) when you make a GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// recommender's Amazon Resource Name (ARN) when you make a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // request. Minimum recommendation requests per second When you create a // recommender, you can configure the recommender's minimum recommendation requests -// per second. The minimum recommendation requests per second -// (minRecommendationRequestsPerSecond) specifies the baseline recommendation +// per second. The minimum recommendation requests per second ( +// minRecommendationRequestsPerSecond ) specifies the baseline recommendation // request throughput provisioned by Amazon Personalize. The default -// minRecommendationRequestsPerSecond is 1. A recommendation request is a single +// minRecommendationRequestsPerSecond is 1 . A recommendation request is a single // GetRecommendations operation. Request throughput is measured in requests per // second and Amazon Personalize uses your requests per second to derive your // requests per hour and the price of your recommender usage. If your requests per -// second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize +// second increases beyond minRecommendationRequestsPerSecond , Amazon Personalize // auto-scales the provisioned capacity up and down, but never below -// minRecommendationRequestsPerSecond. There's a short time delay while the +// minRecommendationRequestsPerSecond . There's a short time delay while the // capacity is increased that might cause loss of requests. Your bill is the // greater of either the minimum requests per hour (based on // minRecommendationRequestsPerSecond) or the actual number of requests. The actual // request throughput used is calculated as the average requests/second within a // one-hour window. We recommend starting with the default -// minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch +// minRecommendationRequestsPerSecond , track your usage using Amazon CloudWatch // metrics, and then increase the minRecommendationRequestsPerSecond as necessary. // Status A recommender can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START +// IN_PROGRESS > ACTIVE +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > -// CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED -// -// * STOP PENDING > STOP -// IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE -// -// * DELETE -// PENDING > DELETE IN_PROGRESS -// -// To get the recommender status, call -// DescribeRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html). -// Wait until the status of the recommender is ACTIVE before asking the recommender -// for recommendations. Related APIs -// -// * ListRecommenders -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html) -// -// * -// DescribeRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) -// -// * -// UpdateRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html) -// -// * -// DeleteRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html) +// To get the recommender status, call DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) +// . Wait until the status of the recommender is ACTIVE before asking the +// recommender for recommendations. Related APIs +// - ListRecommenders (https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html) +// - DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) +// - UpdateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html) +// - DeleteRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html) func (c *Client) CreateRecommender(ctx context.Context, params *CreateRecommenderInput, optFns ...func(*Options)) (*CreateRecommenderOutput, error) { if params == nil { params = &CreateRecommenderInput{} @@ -96,8 +77,8 @@ type CreateRecommenderInput struct { // The Amazon Resource Name (ARN) of the recipe that the recommender will use. For // a recommender, a recipe is a Domain dataset group use case. Only Domain dataset // group use cases can be used to create a recommender. For information about use - // cases see Choosing recommender use cases - // (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). + // cases see Choosing recommender use cases (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html) + // . // // This member is required. RecipeArn *string @@ -105,9 +86,8 @@ type CreateRecommenderInput struct { // The configuration details of the recommender. RecommenderConfig *types.RecommenderConfig - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the recommender. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the recommender. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateSchema.go b/service/personalize/api_op_CreateSchema.go index 998f7b9aa73..39765cb1a0d 100644 --- a/service/personalize/api_op_CreateSchema.go +++ b/service/personalize/api_op_CreateSchema.go @@ -16,20 +16,11 @@ import ( // three schema variants. Each schema is associated with a dataset type and has a // set of required field and keywords. If you are creating a schema for a dataset // in a Domain dataset group, you provide the domain of the Domain dataset group. -// You specify a schema when you call CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). -// Related APIs -// -// * ListSchemas -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) -// -// * -// DescribeSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) -// -// * -// DeleteSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) +// You specify a schema when you call CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . Related APIs +// - ListSchemas (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) +// - DescribeSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) +// - DeleteSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error) { if params == nil { params = &CreateSchemaInput{} diff --git a/service/personalize/api_op_CreateSolution.go b/service/personalize/api_op_CreateSolution.go index cce26059fde..b81ffcce9f5 100644 --- a/service/personalize/api_op_CreateSolution.go +++ b/service/personalize/api_op_CreateSolution.go @@ -13,59 +13,40 @@ import ( // Creates the configuration for training a model. A trained model is known as a // solution. After the configuration is created, you train the model (create a -// solution) by calling the CreateSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) -// operation. Every time you call CreateSolutionVersion, a new version of the +// solution) by calling the CreateSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) +// operation. Every time you call CreateSolutionVersion , a new version of the // solution is created. After creating a solution version, you check its accuracy -// by calling GetSolutionMetrics -// (https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html). -// When you are satisfied with the version, you deploy it using CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). The -// campaign provides recommendations to a client through the GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// by calling GetSolutionMetrics (https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html) +// . When you are satisfied with the version, you deploy it using CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . The campaign provides recommendations to a client through the +// GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // API. To train a model, Amazon Personalize requires training data and a recipe. // The training data comes from the dataset group that you provide in the request. // A recipe specifies the training algorithm and a feature transformation. You can // specify one of the predefined recipes provided by Amazon Personalize. -// Alternatively, you can specify performAutoML and Amazon Personalize will analyze -// your data and select the optimum USER_PERSONALIZATION recipe for you. Amazon -// Personalize doesn't support configuring the hpoObjective for solution +// Alternatively, you can specify performAutoML and Amazon Personalize will +// analyze your data and select the optimum USER_PERSONALIZATION recipe for you. +// Amazon Personalize doesn't support configuring the hpoObjective for solution // hyperparameter optimization at this time. Status A solution can be in one of the // following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE -// FAILED -// -// * DELETE PENDING > DELETE IN_PROGRESS -// -// To get the status of the -// solution, call DescribeSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html). -// Wait until the status shows as ACTIVE before calling CreateSolutionVersion. +// To get the status of the solution, call DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) +// . Wait until the status shows as ACTIVE before calling CreateSolutionVersion . // Related APIs // -// * ListSolutions -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) +// - ListSolutions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) // -// * -// CreateSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) +// - CreateSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) // -// * -// DescribeSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) +// - DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) // -// * -// DeleteSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) +// - DeleteSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) // -// * -// ListSolutionVersions -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) +// - ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) // -// * -// DescribeSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) +// - DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) func (c *Client) CreateSolution(ctx context.Context, params *CreateSolutionInput, optFns ...func(*Options)) (*CreateSolutionOutput, error) { if params == nil { params = &CreateSolutionInput{} @@ -96,22 +77,22 @@ type CreateSolutionInput struct { // When your have multiple event types (using an EVENT_TYPE schema field), this // parameter specifies which event type (for example, 'click' or 'like') is used - // for training the model. If you do not provide an eventType, Amazon Personalize + // for training the model. If you do not provide an eventType , Amazon Personalize // will use all interactions for training with equal weight regardless of type. EventType *string - // Whether to perform automated machine learning (AutoML). The default is false. - // For this case, you must specify recipeArn. When set to true, Amazon Personalize - // analyzes your training data and selects the optimal USER_PERSONALIZATION recipe - // and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize - // determines the optimal recipe by running tests with different values for the - // hyperparameters. AutoML lengthens the training process as compared to selecting - // a specific recipe. + // Whether to perform automated machine learning (AutoML). The default is false . + // For this case, you must specify recipeArn . When set to true , Amazon + // Personalize analyzes your training data and selects the optimal + // USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit + // recipeArn . Amazon Personalize determines the optimal recipe by running tests + // with different values for the hyperparameters. AutoML lengthens the training + // process as compared to selecting a specific recipe. PerformAutoML bool // Whether to perform hyperparameter optimization (HPO) on the specified or - // selected recipe. The default is false. When performing AutoML, this parameter is - // always true and you should not set it to false. + // selected recipe. The default is false . When performing AutoML, this parameter + // is always true and you should not set it to false . PerformHPO *bool // The ARN of the recipe to use for model training. Only specified when @@ -124,9 +105,8 @@ type CreateSolutionInput struct { // at this time. SolutionConfig *types.SolutionConfig - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the solution. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the solution. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateSolutionVersion.go b/service/personalize/api_op_CreateSolutionVersion.go index 6f5cdc7cf04..2c596cb6c38 100644 --- a/service/personalize/api_op_CreateSolutionVersion.go +++ b/service/personalize/api_op_CreateSolutionVersion.go @@ -12,54 +12,27 @@ import ( ) // Trains or retrains an active solution in a Custom dataset group. A solution is -// created using the CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) -// operation and must be in the ACTIVE state before calling CreateSolutionVersion. +// created using the CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// operation and must be in the ACTIVE state before calling CreateSolutionVersion . // A new version of the solution is created every time you call this operation. // Status A solution version can be in one of the following states: +// - CREATE PENDING +// - CREATE IN_PROGRESS +// - ACTIVE +// - CREATE FAILED +// - CREATE STOPPING +// - CREATE STOPPED // -// * CREATE -// PENDING -// -// * CREATE IN_PROGRESS -// -// * ACTIVE -// -// * CREATE FAILED -// -// * CREATE STOPPING -// -// * -// CREATE STOPPED -// -// To get the status of the version, call DescribeSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html). -// Wait until the status shows as ACTIVE before calling CreateCampaign. If the +// To get the status of the version, call DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) +// . Wait until the status shows as ACTIVE before calling CreateCampaign . If the // status shows as CREATE FAILED, the response includes a failureReason key, which // describes why the job failed. Related APIs -// -// * ListSolutionVersions -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) -// -// * -// DescribeSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) -// -// * -// ListSolutions -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) -// -// * -// CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) -// -// * -// DescribeSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) -// -// * -// DeleteSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) +// - ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) +// - DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) +// - ListSolutions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) +// - CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// - DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) +// - DeleteSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) func (c *Client) CreateSolutionVersion(ctx context.Context, params *CreateSolutionVersionInput, optFns ...func(*Options)) (*CreateSolutionVersionOutput, error) { if params == nil { params = &CreateSolutionVersionInput{} @@ -86,9 +59,8 @@ type CreateSolutionVersionInput struct { // The name of the solution version. Name *string - // A list of tags - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to - // apply to the solution version. + // A list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // to apply to the solution version. Tags []types.Tag // The scope of training to be performed when creating the solution version. The @@ -96,12 +68,10 @@ type CreateSolutionVersionInput struct { // solution's training data, while the UPDATE option processes only the data that // has changed in comparison to the input solution. Choose UPDATE when you want to // incrementally update your solution version instead of creating an entirely new - // one. The UPDATE option can only be used when you already have an active solution - // version created from the input solution using the FULL option and the input - // solution was trained with the User-Personalization - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) - // recipe or the HRNN-Coldstart - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) + // one. The UPDATE option can only be used when you already have an active + // solution version created from the input solution using the FULL option and the + // input solution was trained with the User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) + // recipe or the HRNN-Coldstart (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) // recipe. TrainingMode types.TrainingMode diff --git a/service/personalize/api_op_DeleteCampaign.go b/service/personalize/api_op_DeleteCampaign.go index 1f7e8acfeed..78c3a832d4d 100644 --- a/service/personalize/api_op_DeleteCampaign.go +++ b/service/personalize/api_op_DeleteCampaign.go @@ -12,10 +12,9 @@ import ( // Removes a campaign by deleting the solution deployment. The solution that the // campaign is based on is not deleted and can be redeployed when needed. A deleted -// campaign can no longer be specified in a GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) -// request. For information on creating campaigns, see CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// campaign can no longer be specified in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// request. For information on creating campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput, optFns ...func(*Options)) (*DeleteCampaignOutput, error) { if params == nil { params = &DeleteCampaignInput{} diff --git a/service/personalize/api_op_DeleteDataset.go b/service/personalize/api_op_DeleteDataset.go index 6f5ecb4d62d..e11e985dbe6 100644 --- a/service/personalize/api_op_DeleteDataset.go +++ b/service/personalize/api_op_DeleteDataset.go @@ -12,8 +12,8 @@ import ( // Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob // or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more -// information on datasets, see CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). +// information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} diff --git a/service/personalize/api_op_DeleteDatasetGroup.go b/service/personalize/api_op_DeleteDatasetGroup.go index 167eb63c4e1..4ebb7fa13c2 100644 --- a/service/personalize/api_op_DeleteDatasetGroup.go +++ b/service/personalize/api_op_DeleteDatasetGroup.go @@ -12,13 +12,9 @@ import ( // Deletes a dataset group. Before you delete a dataset group, you must delete the // following: -// -// * All associated event trackers. -// -// * All associated solutions. -// -// * All -// datasets in the dataset group. +// - All associated event trackers. +// - All associated solutions. +// - All datasets in the dataset group. func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error) { if params == nil { params = &DeleteDatasetGroupInput{} diff --git a/service/personalize/api_op_DeleteEventTracker.go b/service/personalize/api_op_DeleteEventTracker.go index a3b393faf86..48cb946a192 100644 --- a/service/personalize/api_op_DeleteEventTracker.go +++ b/service/personalize/api_op_DeleteEventTracker.go @@ -12,8 +12,8 @@ import ( // Deletes the event tracker. Does not delete the event-interactions dataset from // the associated dataset group. For more information on event trackers, see -// CreateEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html). +// CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) +// . func (c *Client) DeleteEventTracker(ctx context.Context, params *DeleteEventTrackerInput, optFns ...func(*Options)) (*DeleteEventTrackerOutput, error) { if params == nil { params = &DeleteEventTrackerInput{} diff --git a/service/personalize/api_op_DeleteRecommender.go b/service/personalize/api_op_DeleteRecommender.go index 7ee13df8eff..c81d55f6165 100644 --- a/service/personalize/api_op_DeleteRecommender.go +++ b/service/personalize/api_op_DeleteRecommender.go @@ -11,8 +11,7 @@ import ( ) // Deactivates and removes a recommender. A deleted recommender can no longer be -// specified in a GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// specified in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // request. func (c *Client) DeleteRecommender(ctx context.Context, params *DeleteRecommenderInput, optFns ...func(*Options)) (*DeleteRecommenderOutput, error) { if params == nil { diff --git a/service/personalize/api_op_DeleteSchema.go b/service/personalize/api_op_DeleteSchema.go index 16c6060d726..5a7efc7de98 100644 --- a/service/personalize/api_op_DeleteSchema.go +++ b/service/personalize/api_op_DeleteSchema.go @@ -11,8 +11,8 @@ import ( ) // Deletes a schema. Before deleting a schema, you must delete all datasets -// referencing the schema. For more information on schemas, see CreateSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html). +// referencing the schema. For more information on schemas, see CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html) +// . func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error) { if params == nil { params = &DeleteSchemaInput{} diff --git a/service/personalize/api_op_DeleteSolution.go b/service/personalize/api_op_DeleteSolution.go index 0845eb391a5..268a67ae26c 100644 --- a/service/personalize/api_op_DeleteSolution.go +++ b/service/personalize/api_op_DeleteSolution.go @@ -12,12 +12,11 @@ import ( // Deletes all versions of a solution and the Solution object itself. Before // deleting a solution, you must delete all campaigns based on the solution. To -// determine what campaigns are using the solution, call ListCampaigns -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) and -// supply the Amazon Resource Name (ARN) of the solution. You can't delete a +// determine what campaigns are using the solution, call ListCampaigns (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) +// and supply the Amazon Resource Name (ARN) of the solution. You can't delete a // solution if an associated SolutionVersion is in the CREATE PENDING or IN -// PROGRESS state. For more information on solutions, see CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). +// PROGRESS state. For more information on solutions, see CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// . func (c *Client) DeleteSolution(ctx context.Context, params *DeleteSolutionInput, optFns ...func(*Options)) (*DeleteSolutionOutput, error) { if params == nil { params = &DeleteSolutionInput{} diff --git a/service/personalize/api_op_DescribeCampaign.go b/service/personalize/api_op_DescribeCampaign.go index 24cf788ac62..cf224316af8 100644 --- a/service/personalize/api_op_DescribeCampaign.go +++ b/service/personalize/api_op_DescribeCampaign.go @@ -13,16 +13,12 @@ import ( // Describes the given campaign, including its status. A campaign can be in one of // the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- -// CREATE FAILED -// -// * DELETE PENDING > DELETE IN_PROGRESS -// -// When the status is CREATE -// FAILED, the response includes the failureReason key, which describes why. For -// more information on campaigns, see CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// When the status is CREATE FAILED , the response includes the failureReason key, +// which describes why. For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . func (c *Client) DescribeCampaign(ctx context.Context, params *DescribeCampaignInput, optFns ...func(*Options)) (*DescribeCampaignOutput, error) { if params == nil { params = &DescribeCampaignInput{} diff --git a/service/personalize/api_op_DescribeDataset.go b/service/personalize/api_op_DescribeDataset.go index cb16c3c6823..4450d67a16a 100644 --- a/service/personalize/api_op_DescribeDataset.go +++ b/service/personalize/api_op_DescribeDataset.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the given dataset. For more information on datasets, see CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). +// Describes the given dataset. For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} diff --git a/service/personalize/api_op_DescribeDatasetExportJob.go b/service/personalize/api_op_DescribeDatasetExportJob.go index 669cbc189db..73a3137d80b 100644 --- a/service/personalize/api_op_DescribeDatasetExportJob.go +++ b/service/personalize/api_op_DescribeDatasetExportJob.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the dataset export job created by CreateDatasetExportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html), -// including the export job status. +// Describes the dataset export job created by CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html) +// , including the export job status. func (c *Client) DescribeDatasetExportJob(ctx context.Context, params *DescribeDatasetExportJobInput, optFns ...func(*Options)) (*DescribeDatasetExportJobOutput, error) { if params == nil { params = &DescribeDatasetExportJobInput{} @@ -43,15 +42,10 @@ type DescribeDatasetExportJobOutput struct { // Information about the dataset export job, including the status. The status is // one of the following values: - // - // * CREATE PENDING - // - // * CREATE IN_PROGRESS - // - // * - // ACTIVE - // - // * CREATE FAILED + // - CREATE PENDING + // - CREATE IN_PROGRESS + // - ACTIVE + // - CREATE FAILED DatasetExportJob *types.DatasetExportJob // Metadata pertaining to the operation's result. diff --git a/service/personalize/api_op_DescribeDatasetGroup.go b/service/personalize/api_op_DescribeDatasetGroup.go index d50a1b4680c..33193d488d6 100644 --- a/service/personalize/api_op_DescribeDatasetGroup.go +++ b/service/personalize/api_op_DescribeDatasetGroup.go @@ -12,8 +12,8 @@ import ( ) // Describes the given dataset group. For more information on dataset groups, see -// CreateDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). +// CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) +// . func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error) { if params == nil { params = &DescribeDatasetGroupInput{} diff --git a/service/personalize/api_op_DescribeDatasetImportJob.go b/service/personalize/api_op_DescribeDatasetImportJob.go index ad666daf331..637267bc5b4 100644 --- a/service/personalize/api_op_DescribeDatasetImportJob.go +++ b/service/personalize/api_op_DescribeDatasetImportJob.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the dataset import job created by CreateDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html), -// including the import job status. +// Describes the dataset import job created by CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) +// , including the import job status. func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error) { if params == nil { params = &DescribeDatasetImportJobInput{} @@ -43,15 +42,10 @@ type DescribeDatasetImportJobOutput struct { // Information about the dataset import job, including the status. The status is // one of the following values: - // - // * CREATE PENDING - // - // * CREATE IN_PROGRESS - // - // * - // ACTIVE - // - // * CREATE FAILED + // - CREATE PENDING + // - CREATE IN_PROGRESS + // - ACTIVE + // - CREATE FAILED DatasetImportJob *types.DatasetImportJob // Metadata pertaining to the operation's result. diff --git a/service/personalize/api_op_DescribeEventTracker.go b/service/personalize/api_op_DescribeEventTracker.go index 93d2e93cd0a..27bffc5a64e 100644 --- a/service/personalize/api_op_DescribeEventTracker.go +++ b/service/personalize/api_op_DescribeEventTracker.go @@ -13,8 +13,8 @@ import ( // Describes an event tracker. The response includes the trackingId and status of // the event tracker. For more information on event trackers, see -// CreateEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html). +// CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) +// . func (c *Client) DescribeEventTracker(ctx context.Context, params *DescribeEventTrackerInput, optFns ...func(*Options)) (*DescribeEventTrackerOutput, error) { if params == nil { params = &DescribeEventTrackerInput{} diff --git a/service/personalize/api_op_DescribeRecipe.go b/service/personalize/api_op_DescribeRecipe.go index dd82644c780..6f479de28d9 100644 --- a/service/personalize/api_op_DescribeRecipe.go +++ b/service/personalize/api_op_DescribeRecipe.go @@ -12,23 +12,16 @@ import ( ) // Describes a recipe. A recipe contains three items: +// - An algorithm that trains a model. +// - Hyperparameters that govern the training. +// - Feature transformation information for modifying the input data before +// training. // -// * An algorithm that trains a -// model. -// -// * Hyperparameters that govern the training. -// -// * Feature transformation -// information for modifying the input data before training. -// -// Amazon Personalize -// provides a set of predefined recipes. You specify a recipe when you create a -// solution with the CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) API. -// CreateSolution trains a model by using the algorithm in the specified recipe and -// a training dataset. The solution, when deployed as a campaign, can provide -// recommendations using the GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// Amazon Personalize provides a set of predefined recipes. You specify a recipe +// when you create a solution with the CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// API. CreateSolution trains a model by using the algorithm in the specified +// recipe and a training dataset. The solution, when deployed as a campaign, can +// provide recommendations using the GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // API. func (c *Client) DescribeRecipe(ctx context.Context, params *DescribeRecipeInput, optFns ...func(*Options)) (*DescribeRecipeOutput, error) { if params == nil { diff --git a/service/personalize/api_op_DescribeRecommender.go b/service/personalize/api_op_DescribeRecommender.go index d9f0b41a224..d9c38e16751 100644 --- a/service/personalize/api_op_DescribeRecommender.go +++ b/service/personalize/api_op_DescribeRecommender.go @@ -13,20 +13,15 @@ import ( // Describes the given recommender, including its status. A recommender can be in // one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START +// IN_PROGRESS > ACTIVE +// - DELETE PENDING > DELETE IN_PROGRESS // -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -// -or- CREATE FAILED -// -// * STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING -// > START IN_PROGRESS > ACTIVE -// -// * DELETE PENDING > DELETE IN_PROGRESS -// -// When the -// status is CREATE FAILED, the response includes the failureReason key, which -// describes why. The modelMetrics key is null when the recommender is being -// created or deleted. For more information on recommenders, see CreateRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). +// When the status is CREATE FAILED , the response includes the failureReason key, +// which describes why. The modelMetrics key is null when the recommender is being +// created or deleted. For more information on recommenders, see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html) +// . func (c *Client) DescribeRecommender(ctx context.Context, params *DescribeRecommenderInput, optFns ...func(*Options)) (*DescribeRecommenderOutput, error) { if params == nil { params = &DescribeRecommenderInput{} diff --git a/service/personalize/api_op_DescribeSchema.go b/service/personalize/api_op_DescribeSchema.go index 42196f11d42..87f1913623e 100644 --- a/service/personalize/api_op_DescribeSchema.go +++ b/service/personalize/api_op_DescribeSchema.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a schema. For more information on schemas, see CreateSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html). +// Describes a schema. For more information on schemas, see CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html) +// . func (c *Client) DescribeSchema(ctx context.Context, params *DescribeSchemaInput, optFns ...func(*Options)) (*DescribeSchemaOutput, error) { if params == nil { params = &DescribeSchemaInput{} diff --git a/service/personalize/api_op_DescribeSolution.go b/service/personalize/api_op_DescribeSolution.go index 61e2eed20ad..88b5b5da979 100644 --- a/service/personalize/api_op_DescribeSolution.go +++ b/service/personalize/api_op_DescribeSolution.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a solution. For more information on solutions, see CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). +// Describes a solution. For more information on solutions, see CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// . func (c *Client) DescribeSolution(ctx context.Context, params *DescribeSolutionInput, optFns ...func(*Options)) (*DescribeSolutionOutput, error) { if params == nil { params = &DescribeSolutionInput{} diff --git a/service/personalize/api_op_DescribeSolutionVersion.go b/service/personalize/api_op_DescribeSolutionVersion.go index 1a7eb57eeab..84d443bb294 100644 --- a/service/personalize/api_op_DescribeSolutionVersion.go +++ b/service/personalize/api_op_DescribeSolutionVersion.go @@ -12,8 +12,7 @@ import ( ) // Describes a specific version of a solution. For more information on solutions, -// see CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// see CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) func (c *Client) DescribeSolutionVersion(ctx context.Context, params *DescribeSolutionVersionInput, optFns ...func(*Options)) (*DescribeSolutionVersionOutput, error) { if params == nil { params = &DescribeSolutionVersionInput{} diff --git a/service/personalize/api_op_GetSolutionMetrics.go b/service/personalize/api_op_GetSolutionMetrics.go index 36c3084ffa5..ea890a71829 100644 --- a/service/personalize/api_op_GetSolutionMetrics.go +++ b/service/personalize/api_op_GetSolutionMetrics.go @@ -39,8 +39,8 @@ type GetSolutionMetricsInput struct { type GetSolutionMetricsOutput struct { // The metrics for the solution version. For more information, see Evaluating a - // solution version with metrics - // (https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html). + // solution version with metrics (https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html) + // . Metrics map[string]float64 // The same solution version ARN as specified in the request. diff --git a/service/personalize/api_op_ListBatchSegmentJobs.go b/service/personalize/api_op_ListBatchSegmentJobs.go index 34350a1eade..d6eb8698277 100644 --- a/service/personalize/api_op_ListBatchSegmentJobs.go +++ b/service/personalize/api_op_ListBatchSegmentJobs.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of the batch segment jobs that have been performed off of a solution -// version that you specify. +// Gets a list of the batch segment jobs that have been performed off of a +// solution version that you specify. func (c *Client) ListBatchSegmentJobs(ctx context.Context, params *ListBatchSegmentJobsInput, optFns ...func(*Options)) (*ListBatchSegmentJobsOutput, error) { if params == nil { params = &ListBatchSegmentJobsInput{} diff --git a/service/personalize/api_op_ListCampaigns.go b/service/personalize/api_op_ListCampaigns.go index 8402eeb5c28..9804ae0caf5 100644 --- a/service/personalize/api_op_ListCampaigns.go +++ b/service/personalize/api_op_ListCampaigns.go @@ -15,8 +15,8 @@ import ( // Returns a list of campaigns that use the given solution. When a solution is not // specified, all the campaigns associated with the account are listed. The // response provides the properties for each campaign, including the Amazon -// Resource Name (ARN). For more information on campaigns, see CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// Resource Name (ARN). For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, optFns ...func(*Options)) (*ListCampaignsOutput, error) { if params == nil { params = &ListCampaignsInput{} @@ -37,13 +37,12 @@ type ListCampaignsInput struct { // The maximum number of campaigns to return. MaxResults *int32 - // A token returned from the previous call to ListCampaigns - // (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) for - // getting the next set of campaigns (if they exist). + // A token returned from the previous call to ListCampaigns (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) + // for getting the next set of campaigns (if they exist). NextToken *string - // The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a - // solution is not specified, all the campaigns associated with the account are + // The Amazon Resource Name (ARN) of the solution to list the campaigns for. When + // a solution is not specified, all the campaigns associated with the account are // listed. SolutionArn *string diff --git a/service/personalize/api_op_ListDatasetExportJobs.go b/service/personalize/api_op_ListDatasetExportJobs.go index af46ebfd880..49105bccd90 100644 --- a/service/personalize/api_op_ListDatasetExportJobs.go +++ b/service/personalize/api_op_ListDatasetExportJobs.go @@ -12,14 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of dataset export jobs that use the given dataset. When a dataset -// is not specified, all the dataset export jobs associated with the account are -// listed. The response provides the properties for each dataset export job, -// including the Amazon Resource Name (ARN). For more information on dataset export -// jobs, see CreateDatasetExportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html). -// For more information on datasets, see CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). +// Returns a list of dataset export jobs that use the given dataset. When a +// dataset is not specified, all the dataset export jobs associated with the +// account are listed. The response provides the properties for each dataset export +// job, including the Amazon Resource Name (ARN). For more information on dataset +// export jobs, see CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html) +// . For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . func (c *Client) ListDatasetExportJobs(ctx context.Context, params *ListDatasetExportJobsInput, optFns ...func(*Options)) (*ListDatasetExportJobsOutput, error) { if params == nil { params = &ListDatasetExportJobsInput{} @@ -44,8 +43,8 @@ type ListDatasetExportJobsInput struct { // The maximum number of dataset export jobs to return. MaxResults *int32 - // A token returned from the previous call to ListDatasetExportJobs for getting the - // next set of dataset export jobs (if they exist). + // A token returned from the previous call to ListDatasetExportJobs for getting + // the next set of dataset export jobs (if they exist). NextToken *string noSmithyDocumentSerde diff --git a/service/personalize/api_op_ListDatasetGroups.go b/service/personalize/api_op_ListDatasetGroups.go index e5e4664c32e..33c0444d2d6 100644 --- a/service/personalize/api_op_ListDatasetGroups.go +++ b/service/personalize/api_op_ListDatasetGroups.go @@ -14,8 +14,8 @@ import ( // Returns a list of dataset groups. The response provides the properties for each // dataset group, including the Amazon Resource Name (ARN). For more information on -// dataset groups, see CreateDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). +// dataset groups, see CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) +// . func (c *Client) ListDatasetGroups(ctx context.Context, params *ListDatasetGroupsInput, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error) { if params == nil { params = &ListDatasetGroupsInput{} diff --git a/service/personalize/api_op_ListDatasetImportJobs.go b/service/personalize/api_op_ListDatasetImportJobs.go index b02a19dc28b..b8e604102ac 100644 --- a/service/personalize/api_op_ListDatasetImportJobs.go +++ b/service/personalize/api_op_ListDatasetImportJobs.go @@ -12,14 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of dataset import jobs that use the given dataset. When a dataset -// is not specified, all the dataset import jobs associated with the account are -// listed. The response provides the properties for each dataset import job, -// including the Amazon Resource Name (ARN). For more information on dataset import -// jobs, see CreateDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html). -// For more information on datasets, see CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). +// Returns a list of dataset import jobs that use the given dataset. When a +// dataset is not specified, all the dataset import jobs associated with the +// account are listed. The response provides the properties for each dataset import +// job, including the Amazon Resource Name (ARN). For more information on dataset +// import jobs, see CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) +// . For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error) { if params == nil { params = &ListDatasetImportJobsInput{} @@ -44,8 +43,8 @@ type ListDatasetImportJobsInput struct { // The maximum number of dataset import jobs to return. MaxResults *int32 - // A token returned from the previous call to ListDatasetImportJobs for getting the - // next set of dataset import jobs (if they exist). + // A token returned from the previous call to ListDatasetImportJobs for getting + // the next set of dataset import jobs (if they exist). NextToken *string noSmithyDocumentSerde diff --git a/service/personalize/api_op_ListDatasets.go b/service/personalize/api_op_ListDatasets.go index 1e810f44ce9..7cdde0776ac 100644 --- a/service/personalize/api_op_ListDatasets.go +++ b/service/personalize/api_op_ListDatasets.go @@ -14,8 +14,8 @@ import ( // Returns the list of datasets contained in the given dataset group. The response // provides the properties for each dataset, including the Amazon Resource Name -// (ARN). For more information on datasets, see CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). +// (ARN). For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error) { if params == nil { params = &ListDatasetsInput{} @@ -40,8 +40,8 @@ type ListDatasetsInput struct { // The maximum number of datasets to return. MaxResults *int32 - // A token returned from the previous call to ListDatasetImportJobs for getting the - // next set of dataset import jobs (if they exist). + // A token returned from the previous call to ListDatasetImportJobs for getting + // the next set of dataset import jobs (if they exist). NextToken *string noSmithyDocumentSerde diff --git a/service/personalize/api_op_ListEventTrackers.go b/service/personalize/api_op_ListEventTrackers.go index 70acd21c77f..2ec1d6e6cc7 100644 --- a/service/personalize/api_op_ListEventTrackers.go +++ b/service/personalize/api_op_ListEventTrackers.go @@ -15,8 +15,8 @@ import ( // Returns the list of event trackers associated with the account. The response // provides the properties for each event tracker, including the Amazon Resource // Name (ARN) and tracking ID. For more information on event trackers, see -// CreateEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html). +// CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) +// . func (c *Client) ListEventTrackers(ctx context.Context, params *ListEventTrackersInput, optFns ...func(*Options)) (*ListEventTrackersOutput, error) { if params == nil { params = &ListEventTrackersInput{} diff --git a/service/personalize/api_op_ListRecipes.go b/service/personalize/api_op_ListRecipes.go index 4d2370fb35c..5330bd663f2 100644 --- a/service/personalize/api_op_ListRecipes.go +++ b/service/personalize/api_op_ListRecipes.go @@ -43,7 +43,7 @@ type ListRecipesInput struct { // of recipes (if they exist). NextToken *string - // The default is SERVICE. + // The default is SERVICE . RecipeProvider types.RecipeProvider noSmithyDocumentSerde diff --git a/service/personalize/api_op_ListRecommenders.go b/service/personalize/api_op_ListRecommenders.go index 3facce6b6f8..36945ba48d8 100644 --- a/service/personalize/api_op_ListRecommenders.go +++ b/service/personalize/api_op_ListRecommenders.go @@ -16,8 +16,8 @@ import ( // dataset group is not specified, all the recommenders associated with the account // are listed. The response provides the properties for each recommender, including // the Amazon Resource Name (ARN). For more information on recommenders, see -// CreateRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). +// CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html) +// . func (c *Client) ListRecommenders(ctx context.Context, params *ListRecommendersInput, optFns ...func(*Options)) (*ListRecommendersOutput, error) { if params == nil { params = &ListRecommendersInput{} @@ -43,8 +43,8 @@ type ListRecommendersInput struct { // The maximum number of recommenders to return. MaxResults *int32 - // A token returned from the previous call to ListRecommenders for getting the next - // set of recommenders (if they exist). + // A token returned from the previous call to ListRecommenders for getting the + // next set of recommenders (if they exist). NextToken *string noSmithyDocumentSerde diff --git a/service/personalize/api_op_ListSchemas.go b/service/personalize/api_op_ListSchemas.go index a38f7766dee..15e8fa6a695 100644 --- a/service/personalize/api_op_ListSchemas.go +++ b/service/personalize/api_op_ListSchemas.go @@ -14,8 +14,8 @@ import ( // Returns the list of schemas associated with the account. The response provides // the properties for each schema, including the Amazon Resource Name (ARN). For -// more information on schemas, see CreateSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html). +// more information on schemas, see CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html) +// . func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optFns ...func(*Options)) (*ListSchemasOutput, error) { if params == nil { params = &ListSchemasInput{} diff --git a/service/personalize/api_op_ListSolutions.go b/service/personalize/api_op_ListSolutions.go index c70badddc99..413a8cf2dd8 100644 --- a/service/personalize/api_op_ListSolutions.go +++ b/service/personalize/api_op_ListSolutions.go @@ -16,8 +16,8 @@ import ( // group is not specified, all the solutions associated with the account are // listed. The response provides the properties for each solution, including the // Amazon Resource Name (ARN). For more information on solutions, see -// CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). +// CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// . func (c *Client) ListSolutions(ctx context.Context, params *ListSolutionsInput, optFns ...func(*Options)) (*ListSolutionsOutput, error) { if params == nil { params = &ListSolutionsInput{} diff --git a/service/personalize/api_op_ListTagsForResource.go b/service/personalize/api_op_ListTagsForResource.go index e27e56dec91..eac1610773c 100644 --- a/service/personalize/api_op_ListTagsForResource.go +++ b/service/personalize/api_op_ListTagsForResource.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get a list of tags -// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) +// Get a list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) // attached to a resource. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/personalize/api_op_StopSolutionVersionCreation.go b/service/personalize/api_op_StopSolutionVersionCreation.go index af5ff44b25d..9b124e0fda2 100644 --- a/service/personalize/api_op_StopSolutionVersionCreation.go +++ b/service/personalize/api_op_StopSolutionVersionCreation.go @@ -10,18 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops creating a solution version that is in a state of CREATE_PENDING or CREATE -// IN_PROGRESS. Depending on the current state of the solution version, the +// Stops creating a solution version that is in a state of CREATE_PENDING or +// CREATE IN_PROGRESS. Depending on the current state of the solution version, the // solution version state changes as follows: +// - CREATE_PENDING > CREATE_STOPPED or +// - CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED // -// * CREATE_PENDING > CREATE_STOPPED -// or -// -// * CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED -// -// You are billed for -// all of the training completed up until you stop the solution version creation. -// You cannot resume creating a solution version once it has been stopped. +// You are billed for all of the training completed up until you stop the solution +// version creation. You cannot resume creating a solution version once it has been +// stopped. func (c *Client) StopSolutionVersionCreation(ctx context.Context, params *StopSolutionVersionCreationInput, optFns ...func(*Options)) (*StopSolutionVersionCreationOutput, error) { if params == nil { params = &StopSolutionVersionCreationInput{} diff --git a/service/personalize/api_op_TagResource.go b/service/personalize/api_op_TagResource.go index 62f3533ffdf..515dfd7dcc6 100644 --- a/service/personalize/api_op_TagResource.go +++ b/service/personalize/api_op_TagResource.go @@ -35,8 +35,8 @@ type TagResourceInput struct { ResourceArn *string // Tags to apply to the resource. For more information see Tagging Personalize - // resources - // (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html). + // resources (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) + // . // // This member is required. Tags []types.Tag diff --git a/service/personalize/api_op_UntagResource.go b/service/personalize/api_op_UntagResource.go index 77d8c841c5c..8040eea1873 100644 --- a/service/personalize/api_op_UntagResource.go +++ b/service/personalize/api_op_UntagResource.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Remove tags -// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) that -// are attached to a resource. +// Remove tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) +// that are attached to a resource. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/personalize/api_op_UpdateCampaign.go b/service/personalize/api_op_UpdateCampaign.go index cd912be50ef..44d611b4446 100644 --- a/service/personalize/api_op_UpdateCampaign.go +++ b/service/personalize/api_op_UpdateCampaign.go @@ -14,13 +14,12 @@ import ( // Updates a campaign by either deploying a new solution or changing the value of // the campaign's minProvisionedTPS parameter. To update a campaign, the campaign // status must be ACTIVE or CREATE FAILED. Check the campaign status using the -// DescribeCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) +// DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) // operation. You can still get recommendations from a campaign while an update is // in progress. The campaign will use the previous solution version and campaign // configuration to generate recommendations until the latest campaign update -// status is Active. For more information on campaigns, see CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// status is Active . For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput, optFns ...func(*Options)) (*UpdateCampaignOutput, error) { if params == nil { params = &UpdateCampaignInput{} diff --git a/service/personalize/doc.go b/service/personalize/doc.go index e8cb13a2bea..0abcc9235b5 100644 --- a/service/personalize/doc.go +++ b/service/personalize/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package personalize provides the API client, operations, and parameter types for -// Amazon Personalize. +// Package personalize provides the API client, operations, and parameter types +// for Amazon Personalize. // // Amazon Personalize is a machine learning service that makes it easy to add // individualized recommendations to customers. diff --git a/service/personalize/types/enums.go b/service/personalize/types/enums.go index d397628e2c1..5f3d8beaf46 100644 --- a/service/personalize/types/enums.go +++ b/service/personalize/types/enums.go @@ -104,9 +104,9 @@ const ( TrainingModeUpdate TrainingMode = "UPDATE" ) -// Values returns all known values for TrainingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrainingMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TrainingMode) Values() []TrainingMode { return []TrainingMode{ "FULL", diff --git a/service/personalize/types/types.go b/service/personalize/types/types.go index cef84e51a00..40998147c8a 100644 --- a/service/personalize/types/types.go +++ b/service/personalize/types/types.go @@ -60,10 +60,10 @@ type AlgorithmImage struct { noSmithyDocumentSerde } -// When the solution performs AutoML (performAutoML is true in CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), -// Amazon Personalize determines which recipe, from the specified list, optimizes -// the given metric. Amazon Personalize then uses that recipe for the solution. +// When the solution performs AutoML ( performAutoML is true in CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// ), Amazon Personalize determines which recipe, from the specified list, +// optimizes the given metric. Amazon Personalize then uses that recipe for the +// solution. type AutoMLConfig struct { // The metric to optimize. @@ -75,9 +75,8 @@ type AutoMLConfig struct { noSmithyDocumentSerde } -// When the solution performs AutoML (performAutoML is true in CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), -// specifies the recipe that best optimized the specified metric. +// When the solution performs AutoML ( performAutoML is true in CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// ), specifies the recipe that best optimized the specified metric. type AutoMLResult struct { // The Amazon Resource Name (ARN) of the best recipe. @@ -132,14 +131,10 @@ type BatchInferenceJob struct { // The status of the batch inference job. The status is one of the following // values: - // - // * PENDING - // - // * IN PROGRESS - // - // * ACTIVE - // - // * CREATE FAILED + // - PENDING + // - IN PROGRESS + // - ACTIVE + // - CREATE FAILED Status *string noSmithyDocumentSerde @@ -148,11 +143,11 @@ type BatchInferenceJob struct { // The configuration details of a batch inference job. type BatchInferenceJobConfig struct { - // A string to string map specifying the exploration configuration hyperparameters, - // including explorationWeight and explorationItemAgeCutOff, you want to use to - // configure the amount of item exploration Amazon Personalize uses when - // recommending items. See User-Personalization - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html). + // A string to string map specifying the exploration configuration + // hyperparameters, including explorationWeight and explorationItemAgeCutOff , you + // want to use to configure the amount of item exploration Amazon Personalize uses + // when recommending items. See User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) + // . ItemExplorationConfig map[string]string noSmithyDocumentSerde @@ -173,8 +168,8 @@ type BatchInferenceJobInput struct { // The output configuration parameters of a batch inference job. type BatchInferenceJobOutput struct { - // Information on the Amazon S3 bucket in which the batch inference job's output is - // stored. + // Information on the Amazon S3 bucket in which the batch inference job's output + // is stored. // // This member is required. S3DataDestination *S3DataConfig @@ -182,10 +177,8 @@ type BatchInferenceJobOutput struct { noSmithyDocumentSerde } -// A truncated version of the BatchInferenceJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html). -// The ListBatchInferenceJobs -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html) +// A truncated version of the BatchInferenceJob (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html) +// . The ListBatchInferenceJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html) // operation returns a list of batch inference job summaries. type BatchInferenceJobSummary struct { @@ -209,14 +202,10 @@ type BatchInferenceJobSummary struct { // The status of the batch inference job. The status is one of the following // values: - // - // * PENDING - // - // * IN PROGRESS - // - // * ACTIVE - // - // * CREATE FAILED + // - PENDING + // - IN PROGRESS + // - ACTIVE + // - CREATE FAILED Status *string noSmithyDocumentSerde @@ -259,20 +248,15 @@ type BatchSegmentJob struct { // the batch segment job. RoleArn *string - // The Amazon Resource Name (ARN) of the solution version used by the batch segment - // job to generate batch segments. + // The Amazon Resource Name (ARN) of the solution version used by the batch + // segment job to generate batch segments. SolutionVersionArn *string - // The status of the batch segment job. The status is one of the following - // values: - // - // * PENDING - // - // * IN PROGRESS - // - // * ACTIVE - // - // * CREATE FAILED + // The status of the batch segment job. The status is one of the following values: + // - PENDING + // - IN PROGRESS + // - ACTIVE + // - CREATE FAILED Status *string noSmithyDocumentSerde @@ -300,10 +284,8 @@ type BatchSegmentJobOutput struct { noSmithyDocumentSerde } -// A truncated version of the BatchSegmentJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html) -// datatype. ListBatchSegmentJobs -// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) +// A truncated version of the BatchSegmentJob (https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html) +// datatype. ListBatchSegmentJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) // operation returns a list of batch segment job summaries. type BatchSegmentJobSummary struct { @@ -322,28 +304,23 @@ type BatchSegmentJobSummary struct { // The time at which the batch segment job was last updated. LastUpdatedDateTime *time.Time - // The Amazon Resource Name (ARN) of the solution version used by the batch segment - // job to generate batch segments. + // The Amazon Resource Name (ARN) of the solution version used by the batch + // segment job to generate batch segments. SolutionVersionArn *string - // The status of the batch segment job. The status is one of the following - // values: - // - // * PENDING - // - // * IN PROGRESS - // - // * ACTIVE - // - // * CREATE FAILED + // The status of the batch segment job. The status is one of the following values: + // - PENDING + // - IN PROGRESS + // - ACTIVE + // - CREATE FAILED Status *string noSmithyDocumentSerde } // An object that describes the deployment of a solution version. For more -// information on campaigns, see CreateCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). +// information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) +// . type Campaign struct { // The Amazon Resource Name (ARN) of the campaign. @@ -362,8 +339,7 @@ type Campaign struct { LastUpdatedDateTime *time.Time // Provides a summary of the properties of a campaign update. For a complete - // listing, call the DescribeCampaign - // (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) + // listing, call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) // API. LatestCampaignUpdate *CampaignUpdateSummary @@ -378,12 +354,8 @@ type Campaign struct { SolutionVersionArn *string // The status of the campaign. A campaign can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -393,20 +365,18 @@ type Campaign struct { type CampaignConfig struct { // Specifies the exploration configuration hyperparameters, including - // explorationWeight and explorationItemAgeCutOff, you want to use to configure the - // amount of item exploration Amazon Personalize uses when recommending items. + // explorationWeight and explorationItemAgeCutOff , you want to use to configure + // the amount of item exploration Amazon Personalize uses when recommending items. // Provide itemExplorationConfig data only if your solution uses the - // User-Personalization - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) + // User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) // recipe. ItemExplorationConfig map[string]string noSmithyDocumentSerde } -// Provides a summary of the properties of a campaign. For a complete listing, call -// the DescribeCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) +// Provides a summary of the properties of a campaign. For a complete listing, +// call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) // API. type CampaignSummary struct { @@ -426,20 +396,15 @@ type CampaignSummary struct { Name *string // The status of the campaign. A campaign can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde } // Provides a summary of the properties of a campaign update. For a complete -// listing, call the DescribeCampaign -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) +// listing, call the DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) // API. type CampaignUpdateSummary struct { @@ -464,11 +429,8 @@ type CampaignUpdateSummary struct { // The status of the campaign update. A campaign update can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED - // - // * DELETE PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -514,12 +476,9 @@ type Dataset struct { DatasetGroupArn *string // One of the following values: - // - // * Interactions - // - // * Items - // - // * Users + // - Interactions + // - Items + // - Users DatasetType *string // A time stamp that shows when the dataset was updated. @@ -532,24 +491,17 @@ type Dataset struct { SchemaArn *string // The status of the dataset. A dataset can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde } // Describes a job that exports a dataset to an Amazon S3 bucket. For more -// information, see CreateDatasetExportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html). -// A dataset export job can be in one of the following states: -// -// * CREATE PENDING > -// CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// information, see CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html) +// . A dataset export job can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED type DatasetExportJob struct { // The creation date and time (in Unix time) of the dataset export job. @@ -564,10 +516,10 @@ type DatasetExportJob struct { // If a dataset export job fails, provides the reason why. FailureReason *string - // The data to export, based on how you imported the data. You can choose to export - // BULK data that you imported using a dataset import job, PUT data that you - // imported incrementally (using the console, PutEvents, PutUsers and PutItems - // operations), or ALL for both types. The default value is PUT. + // The data to export, based on how you imported the data. You can choose to + // export BULK data that you imported using a dataset import job, PUT data that + // you imported incrementally (using the console, PutEvents, PutUsers and PutItems + // operations), or ALL for both types. The default value is PUT . IngestionMode IngestionMode // The name of the export job. @@ -587,9 +539,7 @@ type DatasetExportJob struct { // The status of the dataset export job. A dataset export job can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde @@ -607,8 +557,7 @@ type DatasetExportJobOutput struct { } // Provides a summary of the properties of a dataset export job. For a complete -// listing, call the DescribeDatasetExportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) +// listing, call the DescribeDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) // API. type DatasetExportJobSummary struct { @@ -630,23 +579,20 @@ type DatasetExportJobSummary struct { // The status of the dataset export job. A dataset export job can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde } // A dataset group is a collection of related datasets (Interactions, User, and -// Item). You create a dataset group by calling CreateDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). -// You then create a dataset and add it to a dataset group by calling CreateDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). The -// dataset group is used to create and train a solution by calling CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). A -// dataset group can contain only one of each type of dataset. You can specify an -// Key Management Service (KMS) key to encrypt the datasets in the group. +// Item). You create a dataset group by calling CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) +// . You then create a dataset and add it to a dataset group by calling +// CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) +// . The dataset group is used to create and train a solution by calling +// CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// . A dataset group can contain only one of each type of dataset. You can specify +// an Key Management Service (KMS) key to encrypt the datasets in the group. type DatasetGroup struct { // The creation date and time (in Unix time) of the dataset group. @@ -676,19 +622,15 @@ type DatasetGroup struct { // The current status of the dataset group. A dataset group can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED - // - // * DELETE PENDING + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING Status *string noSmithyDocumentSerde } -// Provides a summary of the properties of a dataset group. For a complete listing, -// call the DescribeDatasetGroup -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) +// Provides a summary of the properties of a dataset group. For a complete +// listing, call the DescribeDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) // API. type DatasetGroupSummary struct { @@ -712,24 +654,18 @@ type DatasetGroupSummary struct { // The status of the dataset group. A dataset group can be in one of the following // states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * - // DELETE PENDING + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING Status *string noSmithyDocumentSerde } -// Describes a job that imports training data from a data source (Amazon S3 bucket) -// to an Amazon Personalize dataset. For more information, see -// CreateDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html). -// A dataset import job can be in one of the following states: -// -// * CREATE PENDING > -// CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// Describes a job that imports training data from a data source (Amazon S3 +// bucket) to an Amazon Personalize dataset. For more information, see +// CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) +// . A dataset import job can be in one of the following states: +// - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED type DatasetImportJob struct { // The creation date and time (in Unix time) of the dataset import job. @@ -765,17 +701,14 @@ type DatasetImportJob struct { // The status of the dataset import job. A dataset import job can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde } // Provides a summary of the properties of a dataset import job. For a complete -// listing, call the DescribeDatasetImportJob -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) +// listing, call the DescribeDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) // API. type DatasetImportJobSummary struct { @@ -789,8 +722,8 @@ type DatasetImportJobSummary struct { FailureReason *string // The import mode the dataset import job used to update the data in the dataset. - // For more information see Updating existing bulk data - // (https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html). + // For more information see Updating existing bulk data (https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html) + // . ImportMode ImportMode // The name of the dataset import job. @@ -802,17 +735,15 @@ type DatasetImportJobSummary struct { // The status of the dataset import job. A dataset import job can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde } // Describes the schema for a dataset. For more information on schemas, see -// CreateSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html). +// CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html) +// . type DatasetSchema struct { // The date and time (in Unix time) that the schema was created. @@ -837,8 +768,8 @@ type DatasetSchema struct { } // Provides a summary of the properties of a dataset schema. For a complete -// listing, call the DescribeSchema -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) API. +// listing, call the DescribeSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) +// API. type DatasetSchemaSummary struct { // The date and time (in Unix time) that the schema was created. @@ -860,8 +791,7 @@ type DatasetSchemaSummary struct { } // Provides a summary of the properties of a dataset. For a complete listing, call -// the DescribeDataset -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) +// the DescribeDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) // API. type DatasetSummary struct { @@ -872,15 +802,10 @@ type DatasetSummary struct { DatasetArn *string // The dataset type. One of the following values: - // - // * Interactions - // - // * Items - // - // * - // Users - // - // * Event-Interactions + // - Interactions + // - Items + // - Users + // - Event-Interactions DatasetType *string // The date and time (in Unix time) that the dataset was last updated. @@ -890,12 +815,8 @@ type DatasetSummary struct { Name *string // The status of the dataset. A dataset can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -1006,25 +927,21 @@ type EventTracker struct { // The name of the event tracker. Name *string - // The status of the event tracker. An event tracker can be in one of the following - // states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * - // DELETE PENDING > DELETE IN_PROGRESS + // The status of the event tracker. An event tracker can be in one of the + // following states: + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string - // The ID of the event tracker. Include this ID in requests to the PutEvents - // (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. + // The ID of the event tracker. Include this ID in requests to the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) + // API. TrackingId *string noSmithyDocumentSerde } // Provides a summary of the properties of an event tracker. For a complete -// listing, call the DescribeEventTracker -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) +// listing, call the DescribeEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) // API. type EventTrackerSummary struct { @@ -1040,13 +957,10 @@ type EventTrackerSummary struct { // The name of the event tracker. Name *string - // The status of the event tracker. An event tracker can be in one of the following - // states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * - // DELETE PENDING > DELETE IN_PROGRESS + // The status of the event tracker. An event tracker can be in one of the + // following states: + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -1072,11 +986,9 @@ type FeatureTransformation struct { // The name of the feature transformation. Name *string - // The status of the feature transformation. A feature transformation can be in one - // of the following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- - // CREATE FAILED + // The status of the feature transformation. A feature transformation can be in + // one of the following states: + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde @@ -1098,10 +1010,10 @@ type Filter struct { // The ARN of the filter. FilterArn *string - // Specifies the type of item interactions to filter out of recommendation results. - // The filter expression must follow specific format rules. For information about - // filter expression structure and syntax, see Filter expressions - // (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html). + // Specifies the type of item interactions to filter out of recommendation + // results. The filter expression must follow specific format rules. For + // information about filter expression structure and syntax, see Filter expressions (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html) + // . FilterExpression *string // The time at which the filter was last updated. @@ -1169,7 +1081,7 @@ type HPOObjective struct { // A regular expression for finding the metric in the training job logs. MetricRegex *string - // The type of the metric. Valid values are Maximize and Minimize. + // The type of the metric. Valid values are Maximize and Minimize . Type *string noSmithyDocumentSerde @@ -1179,11 +1091,11 @@ type HPOObjective struct { type HPOResourceConfig struct { // The maximum number of training jobs when you create a solution version. The - // maximum value for maxNumberOfTrainingJobs is 40. + // maximum value for maxNumberOfTrainingJobs is 40 . MaxNumberOfTrainingJobs *string - // The maximum number of parallel training jobs when you create a solution version. - // The maximum value for maxParallelTrainingJobs is 10. + // The maximum number of parallel training jobs when you create a solution + // version. The maximum value for maxParallelTrainingJobs is 10 . MaxParallelTrainingJobs *string noSmithyDocumentSerde @@ -1221,8 +1133,8 @@ type IntegerHyperParameterRange struct { } // Contains information on a metric that a metric attribution reports on. For more -// information, see Measuring impact of recommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +// information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) +// . type MetricAttribute struct { // The metric's event type. @@ -1230,7 +1142,7 @@ type MetricAttribute struct { // This member is required. EventType *string - // The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For + // The attribute's expression. Available functions are SUM() or SAMPLECOUNT() . For // SUM() functions, provide the dataset type (either Interactions or Items) and // column to sum as a parameter. For example SUM(Items.PRICE). // @@ -1249,8 +1161,8 @@ type MetricAttribute struct { // Contains information on a metric attribution. A metric attribution creates // reports on the data that you import into Amazon Personalize. Depending on how // you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For -// more information, see Measuring impact of recommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +// more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) +// . type MetricAttribution struct { // The metric attribution's creation date time. @@ -1285,8 +1197,8 @@ type MetricAttributionOutput struct { // The Amazon Resource Name (ARN) of the IAM service role that has permissions to // add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. - // For more information, see Measuring impact of recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). + // For more information, see Measuring impact of recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) + // . // // This member is required. RoleArn *string @@ -1298,8 +1210,8 @@ type MetricAttributionOutput struct { } // Provides a summary of the properties of a metric attribution. For a complete -// listing, call the DescribeMetricAttribution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html). +// listing, call the DescribeMetricAttribution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html) +// . type MetricAttributionSummary struct { // The metric attribution's creation date time. @@ -1325,8 +1237,8 @@ type MetricAttributionSummary struct { // Describes the additional objective for the solution, such as maximizing // streaming minutes or increasing revenue. For more information see Optimizing a -// solution -// (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html). +// solution (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html) +// . type OptimizationObjective struct { // The numerical metadata column in an Items dataset related to the optimization @@ -1342,8 +1254,7 @@ type OptimizationObjective struct { } // Provides information about a recipe. Each recipe provides an algorithm that -// Amazon Personalize uses in model training when you use the CreateSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) +// Amazon Personalize uses in model training when you use the CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) // operation. type Recipe struct { @@ -1370,13 +1281,9 @@ type Recipe struct { RecipeArn *string // One of the following values: - // - // * PERSONALIZED_RANKING - // - // * RELATED_ITEMS - // - // * - // USER_PERSONALIZATION + // - PERSONALIZED_RANKING + // - RELATED_ITEMS + // - USER_PERSONALIZATION RecipeType *string // The status of the recipe. @@ -1386,8 +1293,8 @@ type Recipe struct { } // Provides a summary of the properties of a recipe. For a complete listing, call -// the DescribeRecipe -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html) API. +// the DescribeRecipe (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html) +// API. type RecipeSummary struct { // The date and time (in Unix time) that the recipe was created. @@ -1413,8 +1320,7 @@ type RecipeSummary struct { // Describes a recommendation generator for a Domain dataset group. You create a // recommender in a Domain dataset group for a specific domain use case (domain -// recipe), and specify the recommender in a GetRecommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// recipe), and specify the recommender in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // request. type Recommender struct { @@ -1435,8 +1341,8 @@ type Recommender struct { LatestRecommenderUpdate *RecommenderUpdateSummary // Provides evaluation metrics that help you determine the performance of a - // recommender. For more information, see Evaluating a recommender - // (https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html). + // recommender. For more information, see Evaluating a recommender (https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html) + // . ModelMetrics map[string]float64 // The name of the recommender. @@ -1454,14 +1360,10 @@ type Recommender struct { // The status of the recommender. A recommender can be in one of the following // states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * - // STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > - // ACTIVE - // - // * DELETE PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START + // IN_PROGRESS > ACTIVE + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -1471,8 +1373,8 @@ type Recommender struct { type RecommenderConfig struct { // Specifies the exploration configuration hyperparameters, including - // explorationWeight and explorationItemAgeCutOff, you want to use to configure the - // amount of item exploration Amazon Personalize uses when recommending items. + // explorationWeight and explorationItemAgeCutOff , you want to use to configure + // the amount of item exploration Amazon Personalize uses when recommending items. // Provide itemExplorationConfig data only if your recommenders generate // personalized recommendations for a user (not popular items or similar items). ItemExplorationConfig map[string]string @@ -1512,22 +1414,17 @@ type RecommenderSummary struct { // The status of the recommender. A recommender can be in one of the following // states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * - // STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > - // ACTIVE - // - // * DELETE PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START + // IN_PROGRESS > ACTIVE + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde } // Provides a summary of the properties of a recommender update. For a complete -// listing, call the DescribeRecommender -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) +// listing, call the DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) // API. type RecommenderUpdateSummary struct { @@ -1545,14 +1442,10 @@ type RecommenderUpdateSummary struct { // The status of the recommender update. A recommender can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED - // - // * STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START - // IN_PROGRESS > ACTIVE - // - // * DELETE PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START + // IN_PROGRESS > ACTIVE + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -1588,8 +1481,8 @@ type Solution struct { DatasetGroupArn *string // The event type (for example, 'click' or 'like') that is used for training the - // model. If no eventType is provided, Amazon Personalize uses all interactions for - // training with equal weight regardless of type. + // model. If no eventType is provided, Amazon Personalize uses all interactions + // for training with equal weight regardless of type. EventType *string // The date and time (in Unix time) that the solution was last updated. @@ -1603,12 +1496,12 @@ type Solution struct { // When true, Amazon Personalize performs a search for the best // USER_PERSONALIZATION recipe from the list specified in the solution - // configuration (recipeArn must not be specified). When false (the default), + // configuration ( recipeArn must not be specified). When false (the default), // Amazon Personalize uses recipeArn for training. PerformAutoML bool // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The - // default is false. + // default is false . PerformHPO bool // The ARN of the recipe used to create the solution. @@ -1621,12 +1514,8 @@ type Solution struct { SolutionConfig *SolutionConfig // The status of the solution. A solution can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde @@ -1638,9 +1527,8 @@ type SolutionConfig struct { // Lists the hyperparameter names and ranges. AlgorithmHyperParameters map[string]string - // The AutoMLConfig - // (https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object - // containing a list of recipes to search when AutoML is performed. + // The AutoMLConfig (https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) + // object containing a list of recipes to search when AutoML is performed. AutoMLConfig *AutoMLConfig // Only events with a value greater than or equal to this threshold are used for @@ -1655,16 +1543,15 @@ type SolutionConfig struct { // Describes the additional objective for the solution, such as maximizing // streaming minutes or increasing revenue. For more information see Optimizing a - // solution - // (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html). + // solution (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html) + // . OptimizationObjective *OptimizationObjective noSmithyDocumentSerde } -// Provides a summary of the properties of a solution. For a complete listing, call -// the DescribeSolution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) +// Provides a summary of the properties of a solution. For a complete listing, +// call the DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) // API. type SolutionSummary struct { @@ -1684,20 +1571,15 @@ type SolutionSummary struct { SolutionArn *string // The status of the solution. A solution can be in one of the following states: - // - // * - // CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED - // - // * DELETE - // PENDING > DELETE IN_PROGRESS + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // - DELETE PENDING > DELETE IN_PROGRESS Status *string noSmithyDocumentSerde } -// An object that provides information about a specific version of a Solution -// (https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html) in a -// Custom dataset group. +// An object that provides information about a specific version of a Solution (https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html) +// in a Custom dataset group. type SolutionVersion struct { // The date and time (in Unix time) that this version of the solution was created. @@ -1721,11 +1603,11 @@ type SolutionVersion struct { // When true, Amazon Personalize searches for the most optimal recipe according to // the solution configuration. When false (the default), Amazon Personalize uses - // recipeArn. + // recipeArn . PerformAutoML bool // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The - // default is false. + // default is false . PerformHPO bool // The ARN of the recipe used in the solution. @@ -1742,19 +1624,12 @@ type SolutionVersion struct { // The status of the solution version. A solution version can be in one of the // following states: - // - // * CREATE PENDING - // - // * CREATE IN_PROGRESS - // - // * ACTIVE - // - // * CREATE - // FAILED - // - // * CREATE STOPPING - // - // * CREATE STOPPED + // - CREATE PENDING + // - CREATE IN_PROGRESS + // - ACTIVE + // - CREATE FAILED + // - CREATE STOPPING + // - CREATE STOPPED Status *string // The time used to train the model. You are billed for the time it takes to train @@ -1767,25 +1642,22 @@ type SolutionVersion struct { // solution's training data, while the UPDATE option processes only the data that // has changed in comparison to the input solution. Choose UPDATE when you want to // incrementally update your solution version instead of creating an entirely new - // one. The UPDATE option can only be used when you already have an active solution - // version created from the input solution using the FULL option and the input - // solution was trained with the User-Personalization - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) - // recipe or the HRNN-Coldstart - // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) + // one. The UPDATE option can only be used when you already have an active + // solution version created from the input solution using the FULL option and the + // input solution was trained with the User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) + // recipe or the HRNN-Coldstart (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) // recipe. TrainingMode TrainingMode - // If hyperparameter optimization was performed, contains the hyperparameter values - // of the best performing model. + // If hyperparameter optimization was performed, contains the hyperparameter + // values of the best performing model. TunedHPOParams *TunedHPOParams noSmithyDocumentSerde } // Provides a summary of the properties of a solution version. For a complete -// listing, call the DescribeSolutionVersion -// (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) +// listing, call the DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) // API. type SolutionVersionSummary struct { @@ -1803,9 +1675,7 @@ type SolutionVersionSummary struct { // The status of the solution version. A solution version can be in one of the // following states: - // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE - // FAILED + // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED Status *string noSmithyDocumentSerde @@ -1813,8 +1683,8 @@ type SolutionVersionSummary struct { // The optional metadata that you apply to resources to help you categorize and // organize them. Each tag consists of a key and an optional value, both of which -// you define. For more information see Tagging Personalize resources -// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html). +// you define. For more information see Tagging Personalize resources (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) +// . type Tag struct { // One part of a key-value pair that makes up a tag. A key is a general label that diff --git a/service/personalizeevents/api_client.go b/service/personalizeevents/api_client.go index 9b4ca421fc0..42fe8cc4ce4 100644 --- a/service/personalizeevents/api_client.go +++ b/service/personalizeevents/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/personalizeevents/api_op_PutEvents.go b/service/personalizeevents/api_op_PutEvents.go index b70395df465..bacbde0c811 100644 --- a/service/personalizeevents/api_op_PutEvents.go +++ b/service/personalizeevents/api_op_PutEvents.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Records user interaction event data. For more information see Recording Events -// (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html). +// Records user interaction event data. For more information see Recording Events (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html) +// . func (c *Client) PutEvents(ctx context.Context, params *PutEventsInput, optFns ...func(*Options)) (*PutEventsOutput, error) { if params == nil { params = &PutEventsInput{} @@ -38,15 +38,14 @@ type PutEventsInput struct { // The session ID associated with the user's visit. Your application generates the // sessionId when a user first visits your website or uses your application. Amazon // Personalize uses the sessionId to associate events with the user before they log - // in. For more information, see Recording Events - // (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html). + // in. For more information, see Recording Events (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html) + // . // // This member is required. SessionId *string // The tracking ID for the event. The ID is generated by a call to the - // CreateEventTracker - // (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) + // CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) // API. // // This member is required. diff --git a/service/personalizeevents/api_op_PutItems.go b/service/personalizeevents/api_op_PutItems.go index cd530f2cb6a..bb0611d2c67 100644 --- a/service/personalizeevents/api_op_PutItems.go +++ b/service/personalizeevents/api_op_PutItems.go @@ -12,8 +12,8 @@ import ( ) // Adds one or more items to an Items dataset. For more information see Importing -// Items Incrementally -// (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html). +// Items Incrementally (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html) +// . func (c *Client) PutItems(ctx context.Context, params *PutItemsInput, optFns ...func(*Options)) (*PutItemsOutput, error) { if params == nil { params = &PutItemsInput{} diff --git a/service/personalizeevents/api_op_PutUsers.go b/service/personalizeevents/api_op_PutUsers.go index 63279f10417..d2a93ec7b4f 100644 --- a/service/personalizeevents/api_op_PutUsers.go +++ b/service/personalizeevents/api_op_PutUsers.go @@ -12,8 +12,8 @@ import ( ) // Adds one or more users to a Users dataset. For more information see Importing -// Users Incrementally -// (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html). +// Users Incrementally (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html) +// . func (c *Client) PutUsers(ctx context.Context, params *PutUsersInput, optFns ...func(*Options)) (*PutUsersOutput, error) { if params == nil { params = &PutUsersInput{} diff --git a/service/personalizeevents/doc.go b/service/personalizeevents/doc.go index 468d465c0c9..be2a386a1c6 100644 --- a/service/personalizeevents/doc.go +++ b/service/personalizeevents/doc.go @@ -5,6 +5,6 @@ // // Amazon Personalize can consume real-time user event data, such as stream or // click data, and use it for model training either alone or combined with -// historical data. For more information see Recording Events -// (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html). +// historical data. For more information see Recording Events (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html) +// . package personalizeevents diff --git a/service/personalizeevents/types/types.go b/service/personalizeevents/types/types.go index 27a27c261b0..f0eb6790b56 100644 --- a/service/personalizeevents/types/types.go +++ b/service/personalizeevents/types/types.go @@ -34,10 +34,10 @@ type Event struct { EventValue *float32 // A list of item IDs that represents the sequence of items you have shown the - // user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to - // manually record impressions data for an event. For more information on recording - // impressions data, see Recording impressions data - // (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data). + // user. For example, ["itemId1", "itemId2", "itemId3"] . Provide a list of items + // to manually record impressions data for an event. For more information on + // recording impressions data, see Recording impressions data (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data) + // . Impression []string // The item ID key that corresponds to the ITEM_ID field of the Interactions @@ -46,14 +46,14 @@ type Event struct { // Contains information about the metric attribution associated with an event. For // more information about metric attributions, see Measuring impact of - // recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). + // recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) + // . MetricAttribution *MetricAttribution // A string map of event-specific data that you might choose to record. For - // example, if a user rates a movie on your site, other than movie ID (itemId) and - // rating (eventValue) , you might also send the number of movie ratings made by - // the user. Each item in the map consists of a key-value pair. For example, + // example, if a user rates a movie on your site, other than movie ID ( itemId ) + // and rating ( eventValue ) , you might also send the number of movie ratings made + // by the user. Each item in the map consists of a key-value pair. For example, // {"numberOfRatings": "12"} The keys use camel case names that match the fields in // the Interactions schema. In the above example, the numberOfRatings would match // the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. @@ -61,24 +61,23 @@ type Event struct { // This value conforms to the media type: application/json Properties *string - // The ID of the list of recommendations that contains the item the user interacted - // with. Provide a recommendationId to have Amazon Personalize implicitly record - // the recommendations you show your user as impressions data. Or provide a - // recommendationId if you use a metric attribution to measure the impact of - // recommendations. For more information on recording impressions data, see - // Recording impressions data - // (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data). - // For more information on creating a metric attribution see Measuring impact of - // recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). + // The ID of the list of recommendations that contains the item the user + // interacted with. Provide a recommendationId to have Amazon Personalize + // implicitly record the recommendations you show your user as impressions data. Or + // provide a recommendationId if you use a metric attribution to measure the + // impact of recommendations. For more information on recording impressions data, + // see Recording impressions data (https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data) + // . For more information on creating a metric attribution see Measuring impact of + // recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) + // . RecommendationId *string noSmithyDocumentSerde } // Represents item metadata added to an Items dataset using the PutItems API. For -// more information see Importing Items Incrementally -// (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html). +// more information see Importing Items Incrementally (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html) +// . type Item struct { // The ID associated with the item. @@ -87,12 +86,12 @@ type Item struct { ItemId *string // A string map of item-specific metadata. Each element in the map consists of a - // key-value pair. For example, {"numberOfRatings": "12"}. The keys use camel case + // key-value pair. For example, {"numberOfRatings": "12"} . The keys use camel case // names that match the fields in the schema for the Items dataset. In the previous // example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in // the Items schema. For categorical string data, to include multiple categories - // for a single item, separate each category with a pipe separator (|). For - // example, \"Horror|Action\". + // for a single item, separate each category with a pipe separator ( | ). For + // example, \"Horror|Action\" . // // This value conforms to the media type: application/json Properties *string @@ -102,8 +101,8 @@ type Item struct { // Contains information about a metric attribution associated with an event. For // more information about metric attributions, see Measuring impact of -// recommendations -// (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html). +// recommendations (https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html) +// . type MetricAttribution struct { // The source of the event, such as a third party. @@ -115,8 +114,8 @@ type MetricAttribution struct { } // Represents user metadata added to a Users dataset using the PutUsers API. For -// more information see Importing Users Incrementally -// (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html). +// more information see Importing Users Incrementally (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html) +// . type User struct { // The ID associated with the user. @@ -125,12 +124,12 @@ type User struct { UserId *string // A string map of user-specific metadata. Each element in the map consists of a - // key-value pair. For example, {"numberOfVideosWatched": "45"}. The keys use camel - // case names that match the fields in the schema for the Users dataset. In the - // previous example, the numberOfVideosWatched matches the + // key-value pair. For example, {"numberOfVideosWatched": "45"} . The keys use + // camel case names that match the fields in the schema for the Users dataset. In + // the previous example, the numberOfVideosWatched matches the // 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical // string data, to include multiple categories for a single user, separate each - // category with a pipe separator (|). For example, \"Member|Frequent shopper\". + // category with a pipe separator ( | ). For example, \"Member|Frequent shopper\" . // // This value conforms to the media type: application/json Properties *string diff --git a/service/personalizeruntime/api_client.go b/service/personalizeruntime/api_client.go index c108b7f57ba..7ed05a70af0 100644 --- a/service/personalizeruntime/api_client.go +++ b/service/personalizeruntime/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/personalizeruntime/api_op_GetPersonalizedRanking.go b/service/personalizeruntime/api_op_GetPersonalizedRanking.go index 9ba8dbb9eb4..98113308a55 100644 --- a/service/personalizeruntime/api_op_GetPersonalizedRanking.go +++ b/service/personalizeruntime/api_op_GetPersonalizedRanking.go @@ -38,9 +38,9 @@ type GetPersonalizedRankingInput struct { // This member is required. CampaignArn *string - // A list of items (by itemId) to rank. If an item was not included in the training - // dataset, the item is appended to the end of the reranked list. The maximum is - // 500. + // A list of items (by itemId ) to rank. If an item was not included in the + // training dataset, the item is appended to the end of the reranked list. The + // maximum is 500. // // This member is required. InputList []string @@ -50,27 +50,28 @@ type GetPersonalizedRankingInput struct { // This member is required. UserId *string - // The contextual metadata to use when getting recommendations. Contextual metadata - // includes any interaction information that might be relevant when getting a - // user's recommendations, such as the user's current location or device type. + // The contextual metadata to use when getting recommendations. Contextual + // metadata includes any interaction information that might be relevant when + // getting a user's recommendations, such as the user's current location or device + // type. Context map[string]string // The Amazon Resource Name (ARN) of a filter you created to include items or // exclude items from recommendations for a given user. For more information, see - // Filtering Recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). + // Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) + // . FilterArn *string - // The values to use when filtering recommendations. For each placeholder parameter - // in your filter expression, provide the parameter name (in matching case) as a - // key and the filter value(s) as the corresponding value. Separate multiple values - // for one parameter with a comma. For filter expressions that use an INCLUDE - // element to include items, you must provide values for all parameters that are - // defined in the expression. For filters with expressions that use an EXCLUDE - // element to exclude items, you can omit the filter-values.In this case, Amazon - // Personalize doesn't use that portion of the expression to filter - // recommendations. For more information, see Filtering Recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). + // The values to use when filtering recommendations. For each placeholder + // parameter in your filter expression, provide the parameter name (in matching + // case) as a key and the filter value(s) as the corresponding value. Separate + // multiple values for one parameter with a comma. For filter expressions that use + // an INCLUDE element to include items, you must provide values for all parameters + // that are defined in the expression. For filters with expressions that use an + // EXCLUDE element to exclude items, you can omit the filter-values .In this case, + // Amazon Personalize doesn't use that portion of the expression to filter + // recommendations. For more information, see Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) + // . FilterValues map[string]string noSmithyDocumentSerde diff --git a/service/personalizeruntime/api_op_GetRecommendations.go b/service/personalizeruntime/api_op_GetRecommendations.go index b22c926d1eb..d44eea245de 100644 --- a/service/personalizeruntime/api_op_GetRecommendations.go +++ b/service/personalizeruntime/api_op_GetRecommendations.go @@ -14,19 +14,15 @@ import ( // Returns a list of recommended items. For campaigns, the campaign's Amazon // Resource Name (ARN) is required and the required user and item input depends on // the recipe type used to create the solution backing the campaign as follows: +// - USER_PERSONALIZATION - userId required, itemId not used +// - RELATED_ITEMS - itemId required, userId not used // -// * -// USER_PERSONALIZATION - userId required, itemId not used -// -// * RELATED_ITEMS - -// itemId required, userId not used -// -// Campaigns that are backed by a solution -// created using a recipe of type PERSONALIZED_RANKING use the API. For -// recommenders, the recommender's ARN is required and the required item and user -// input depends on the use case (domain-based recipe) backing the recommender. For -// information on use case requirements see Choosing recommender use cases -// (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). +// Campaigns that are backed by a solution created using a recipe of type +// PERSONALIZED_RANKING use the API. For recommenders, the recommender's ARN is +// required and the required item and user input depends on the use case +// (domain-based recipe) backing the recommender. For information on use case +// requirements see Choosing recommender use cases (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html) +// . func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { if params == nil { params = &GetRecommendationsInput{} @@ -48,27 +44,27 @@ type GetRecommendationsInput struct { // recommendations. CampaignArn *string - // The contextual metadata to use when getting recommendations. Contextual metadata - // includes any interaction information that might be relevant when getting a - // user's recommendations, such as the user's current location or device type. + // The contextual metadata to use when getting recommendations. Contextual + // metadata includes any interaction information that might be relevant when + // getting a user's recommendations, such as the user's current location or device + // type. Context map[string]string // The ARN of the filter to apply to the returned recommendations. For more - // information, see Filtering Recommendations - // (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). When using this - // parameter, be sure the filter resource is ACTIVE. + // information, see Filtering Recommendations (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) + // . When using this parameter, be sure the filter resource is ACTIVE . FilterArn *string - // The values to use when filtering recommendations. For each placeholder parameter - // in your filter expression, provide the parameter name (in matching case) as a - // key and the filter value(s) as the corresponding value. Separate multiple values - // for one parameter with a comma. For filter expressions that use an INCLUDE - // element to include items, you must provide values for all parameters that are - // defined in the expression. For filters with expressions that use an EXCLUDE - // element to exclude items, you can omit the filter-values.In this case, Amazon - // Personalize doesn't use that portion of the expression to filter + // The values to use when filtering recommendations. For each placeholder + // parameter in your filter expression, provide the parameter name (in matching + // case) as a key and the filter value(s) as the corresponding value. Separate + // multiple values for one parameter with a comma. For filter expressions that use + // an INCLUDE element to include items, you must provide values for all parameters + // that are defined in the expression. For filters with expressions that use an + // EXCLUDE element to exclude items, you can omit the filter-values .In this case, + // Amazon Personalize doesn't use that portion of the expression to filter // recommendations. For more information, see Filtering recommendations and user - // segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). + // segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) . FilterValues map[string]string // The item ID to provide recommendations for. Required for RELATED_ITEMS recipe @@ -83,9 +79,9 @@ type GetRecommendationsInput struct { // items. Promotions []types.Promotion - // The Amazon Resource Name (ARN) of the recommender to use to get recommendations. - // Provide a recommender ARN if you created a Domain dataset group with a - // recommender for a domain use case. + // The Amazon Resource Name (ARN) of the recommender to use to get + // recommendations. Provide a recommender ARN if you created a Domain dataset group + // with a recommender for a domain use case. RecommenderArn *string // The user ID to provide recommendations for. Required for USER_PERSONALIZATION diff --git a/service/personalizeruntime/types/types.go b/service/personalizeruntime/types/types.go index 9c69b310617..b997cdd71cd 100644 --- a/service/personalizeruntime/types/types.go +++ b/service/personalizeruntime/types/types.go @@ -6,7 +6,7 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// An object that identifies an item. The and APIs return a list of PredictedItems. +// An object that identifies an item. The and APIs return a list of PredictedItem s. type PredictedItem struct { // The recommended item ID. @@ -15,8 +15,8 @@ type PredictedItem struct { // The name of the promotion that included the predicted item. PromotionName *string - // A numeric representation of the model's certainty that the item will be the next - // user selection. For more information on scoring logic, see how-scores-work. + // A numeric representation of the model's certainty that the item will be the + // next user selection. For more information on scoring logic, see how-scores-work . Score *float64 noSmithyDocumentSerde @@ -28,8 +28,8 @@ type Promotion struct { // The Amazon Resource Name (ARN) of the filter used by the promotion. This filter // defines the criteria for promoted items. For more information, see Promotion - // filters - // (https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters). + // filters (https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters) + // . FilterArn *string // The values to use when promoting items. For each placeholder parameter in your @@ -38,11 +38,11 @@ type Promotion struct { // values for one parameter with a comma. For filter expressions that use an // INCLUDE element to include items, you must provide values for all parameters // that are defined in the expression. For filters with expressions that use an - // EXCLUDE element to exclude items, you can omit the filter-values. In this case, + // EXCLUDE element to exclude items, you can omit the filter-values . In this case, // Amazon Personalize doesn't use that portion of the expression to filter // recommendations. For more information on creating filters, see Filtering - // recommendations and user segments - // (https://docs.aws.amazon.com/personalize/latest/dg/filter.html). + // recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) + // . FilterValues map[string]string // The name of the promotion. diff --git a/service/pi/api_client.go b/service/pi/api_client.go index 7aa0131c07e..e9bc56b9b38 100644 --- a/service/pi/api_client.go +++ b/service/pi/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pi/api_op_DescribeDimensionKeys.go b/service/pi/api_op_DescribeDimensionKeys.go index 300edb6eb36..a3129ff930a 100644 --- a/service/pi/api_op_DescribeDimensionKeys.go +++ b/service/pi/api_op_DescribeDimensionKeys.go @@ -13,9 +13,9 @@ import ( "time" ) -// For a specific time period, retrieve the top N dimension keys for a metric. Each -// response element returns a maximum of 500 bytes. For larger elements, such as -// SQL statements, only the first 500 bytes are returned. +// For a specific time period, retrieve the top N dimension keys for a metric. +// Each response element returns a maximum of 500 bytes. For larger elements, such +// as SQL statements, only the first 500 bytes are returned. func (c *Client) DescribeDimensionKeys(ctx context.Context, params *DescribeDimensionKeysInput, optFns ...func(*Options)) (*DescribeDimensionKeysOutput, error) { if params == nil { params = &DescribeDimensionKeysInput{} @@ -36,7 +36,7 @@ type DescribeDimensionKeysInput struct { // The date and time specifying the end of the requested time series data. The // value specified is exclusive, which means that data points less than (but not // equal to) EndTime are returned. The value for EndTime must be later than the - // value for StartTime. + // value for StartTime . // // This member is required. EndTime *time.Time @@ -53,37 +53,31 @@ type DescribeDimensionKeysInput struct { // An immutable, Amazon Web Services Region-unique identifier for a data source. // Performance Insights gathers metrics from this data source. To use an Amazon RDS // instance as a data source, you specify its DbiResourceId value. For example, - // specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A. + // specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A . // // This member is required. Identifier *string // The name of a Performance Insights metric to be measured. Valid values for // Metric are: - // - // * db.load.avg - A scaled representation of the number of active - // sessions for the database engine. - // - // * db.sampledload.avg - The raw number of - // active sessions for the database engine. - // - // If the number of active sessions is - // less than an internal Performance Insights threshold, db.load.avg and - // db.sampledload.avg are the same value. If the number of active sessions is - // greater than the internal threshold, Performance Insights samples the active - // sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing - // the raw values, and db.sampledload.avg less than db.load.avg. For most use - // cases, you can query db.load.avg only. + // - db.load.avg - A scaled representation of the number of active sessions for + // the database engine. + // - db.sampledload.avg - The raw number of active sessions for the database + // engine. + // If the number of active sessions is less than an internal Performance Insights + // threshold, db.load.avg and db.sampledload.avg are the same value. If the number + // of active sessions is greater than the internal threshold, Performance Insights + // samples the active sessions, with db.load.avg showing the scaled values, + // db.sampledload.avg showing the raw values, and db.sampledload.avg less than + // db.load.avg . For most use cases, you can query db.load.avg only. // // This member is required. Metric *string // The Amazon Web Services service for which Performance Insights will return // metrics. Valid values are as follows: - // - // * RDS - // - // * DOCDB + // - RDS + // - DOCDB // // This member is required. ServiceType types.ServiceType @@ -91,24 +85,21 @@ type DescribeDimensionKeysInput struct { // The date and time specifying the beginning of the requested time series data. // You must specify a StartTime within the past 7 days. The value specified is // inclusive, which means that data points equal to or greater than StartTime are - // returned. The value for StartTime must be earlier than the value for EndTime. + // returned. The value for StartTime must be earlier than the value for EndTime . // // This member is required. StartTime *time.Time // Additional metrics for the top N dimension keys. If the specified dimension - // group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL + // group in the GroupBy parameter is db.sql_tokenized , you can specify per-SQL // metrics to get the values for the top N SQL digests. The response syntax is as - // follows: "AdditionalMetrics" : { "string" : "string" }. + // follows: "AdditionalMetrics" : { "string" : "string" } . AdditionalMetrics []string // One or more filters to apply in the request. Restrictions: - // - // * Any number of - // filters by the same dimension, as specified in the GroupBy or Partition - // parameters. - // - // * A single filter for any other dimension in this dimension group. + // - Any number of filters by the same dimension, as specified in the GroupBy or + // Partition parameters. + // - A single filter for any other dimension in this dimension group. Filter map[string]string // The maximum number of items to return in the response. If more items exist than @@ -118,31 +109,23 @@ type DescribeDimensionKeysInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string - // For each dimension specified in GroupBy, specify a secondary dimension to + // For each dimension specified in GroupBy , specify a secondary dimension to // further subdivide the partition keys in the response. PartitionBy *types.DimensionGroup // The granularity, in seconds, of the data points returned from Performance // Insights. A period can be as short as one second, or as long as one day (86400 // seconds). Valid values are: - // - // * 1 (one second) - // - // * 60 (one minute) - // - // * 300 (five - // minutes) - // - // * 3600 (one hour) - // - // * 86400 (twenty-four hours) - // - // If you don't specify - // PeriodInSeconds, then Performance Insights chooses a value for you, with a goal - // of returning roughly 100-200 data points in the response. + // - 1 (one second) + // - 60 (one minute) + // - 300 (five minutes) + // - 3600 (one hour) + // - 86400 (twenty-four hours) + // If you don't specify PeriodInSeconds , then Performance Insights chooses a value + // for you, with a goal of returning roughly 100-200 data points in the response. PeriodInSeconds *int32 noSmithyDocumentSerde @@ -151,13 +134,13 @@ type DescribeDimensionKeysInput struct { type DescribeDimensionKeysOutput struct { // The end time for the returned dimension keys, after alignment to a granular - // boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than - // or equal to the value of the user-specified Endtime. + // boundary (as specified by PeriodInSeconds ). AlignedEndTime will be greater + // than or equal to the value of the user-specified Endtime . AlignedEndTime *time.Time // The start time for the returned dimension keys, after alignment to a granular - // boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than - // or equal to the value of the user-specified StartTime. + // boundary (as specified by PeriodInSeconds ). AlignedStartTime will be less than + // or equal to the value of the user-specified StartTime . AlignedStartTime *time.Time // The dimension keys that were requested. diff --git a/service/pi/api_op_GetDimensionKeyDetails.go b/service/pi/api_op_GetDimensionKeyDetails.go index c040b3fa1de..88979ac2f40 100644 --- a/service/pi/api_op_GetDimensionKeyDetails.go +++ b/service/pi/api_op_GetDimensionKeyDetails.go @@ -35,23 +35,17 @@ type GetDimensionKeyDetailsInput struct { // The name of the dimension group. Performance Insights searches the specified // group for the dimension group ID. The following group name values are valid: - // - // * - // db.query (Amazon DocumentDB only) - // - // * db.sql (Amazon RDS and Aurora only) + // - db.query (Amazon DocumentDB only) + // - db.sql (Amazon RDS and Aurora only) // // This member is required. Group *string // The ID of the dimension group from which to retrieve dimension details. For - // dimension group db.sql, the group ID is db.sql.id. The following group ID values - // are valid: - // - // * db.sql.id for dimension group db.sql (Aurora and RDS only) - // - // * - // db.query.id for dimension group db.query (DocumentDB only) + // dimension group db.sql , the group ID is db.sql.id . The following group ID + // values are valid: + // - db.sql.id for dimension group db.sql (Aurora and RDS only) + // - db.query.id for dimension group db.query (DocumentDB only) // // This member is required. GroupIdentifier *string @@ -59,13 +53,13 @@ type GetDimensionKeyDetailsInput struct { // The ID for a data source from which to gather dimension data. This ID must be // immutable and unique within an Amazon Web Services Region. When a DB instance is // the data source, specify its DbiResourceId value. For example, specify - // db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // db-ABCDEFGHIJKLMNOPQRSTU1VW2X . // // This member is required. Identifier *string - // The Amazon Web Services service for which Performance Insights returns data. The - // only valid value is RDS. + // The Amazon Web Services service for which Performance Insights returns data. + // The only valid value is RDS . // // This member is required. ServiceType types.ServiceType @@ -74,13 +68,10 @@ type GetDimensionKeyDetailsInput struct { // group. If you don't specify this parameter, Performance Insights returns all // dimension data within the specified dimension group. Specify dimension names for // the following dimension groups: - // - // * db.sql - Specify either the full dimension - // name db.sql.statement or the short dimension name statement (Aurora and RDS - // only). - // - // * db.query - Specify either the full dimension name db.query.statement - // or the short dimension name statement (DocumentDB only). + // - db.sql - Specify either the full dimension name db.sql.statement or the + // short dimension name statement (Aurora and RDS only). + // - db.query - Specify either the full dimension name db.query.statement or the + // short dimension name statement (DocumentDB only). RequestedDimensions []string noSmithyDocumentSerde diff --git a/service/pi/api_op_GetResourceMetadata.go b/service/pi/api_op_GetResourceMetadata.go index 70f0f750a7b..9987e911d95 100644 --- a/service/pi/api_op_GetResourceMetadata.go +++ b/service/pi/api_op_GetResourceMetadata.go @@ -33,7 +33,7 @@ type GetResourceMetadataInput struct { // An immutable identifier for a data source that is unique for an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. To // use a DB instance as a data source, specify its DbiResourceId value. For - // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X . // // This member is required. Identifier *string @@ -55,7 +55,7 @@ type GetResourceMetadataOutput struct { // An immutable identifier for a data source that is unique for an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. To // use a DB instance as a data source, specify its DbiResourceId value. For - // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X . Identifier *string // Metadata pertaining to the operation's result. diff --git a/service/pi/api_op_GetResourceMetrics.go b/service/pi/api_op_GetResourceMetrics.go index 2f172bb7524..b2c3c5b03e8 100644 --- a/service/pi/api_op_GetResourceMetrics.go +++ b/service/pi/api_op_GetResourceMetrics.go @@ -37,8 +37,8 @@ type GetResourceMetricsInput struct { // The date and time specifying the end of the requested time series query range. // The value specified is exclusive. Thus, the command returns data points less - // than (but not equal to) EndTime. The value for EndTime must be later than the - // value for StartTime. + // than (but not equal to) EndTime . The value for EndTime must be later than the + // value for StartTime . // // This member is required. EndTime *time.Time @@ -46,9 +46,9 @@ type GetResourceMetricsInput struct { // An immutable identifier for a data source that is unique for an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. In // the console, the identifier is shown as ResourceID. When you call - // DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB - // instance as a data source, specify its DbiResourceId value. For example, specify - // db-ABCDEFGHIJKLMNOPQRSTU1VW2X. + // DescribeDBInstances , the identifier is returned as DbiResourceId . To use a DB + // instance as a data source, specify its DbiResourceId value. For example, + // specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X . // // This member is required. Identifier *string @@ -62,10 +62,8 @@ type GetResourceMetricsInput struct { // The Amazon Web Services service for which Performance Insights returns metrics. // Valid values are as follows: - // - // * RDS - // - // * DOCDB + // - RDS + // - DOCDB // // This member is required. ServiceType types.ServiceType @@ -74,8 +72,8 @@ type GetResourceMetricsInput struct { // range. You can't specify a StartTime that is earlier than 7 days ago. By // default, Performance Insights has 7 days of retention, but you can extend this // range up to 2 years. The value specified is inclusive. Thus, the command returns - // data points equal to or greater than StartTime. The value for StartTime must be - // earlier than the value for EndTime. + // data points equal to or greater than StartTime . The value for StartTime must + // be earlier than the value for EndTime . // // This member is required. StartTime *time.Time @@ -87,31 +85,24 @@ type GetResourceMetricsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string // The returned timestamp which is the start or end time of the time periods. The - // default value is END_TIME. + // default value is END_TIME . PeriodAlignment types.PeriodAlignment // The granularity, in seconds, of the data points returned from Performance // Insights. A period can be as short as one second, or as long as one day (86400 // seconds). Valid values are: - // - // * 1 (one second) - // - // * 60 (one minute) - // - // * 300 (five - // minutes) - // - // * 3600 (one hour) - // - // * 86400 (twenty-four hours) - // - // If you don't specify - // PeriodInSeconds, then Performance Insights will choose a value for you, with a - // goal of returning roughly 100-200 data points in the response. + // - 1 (one second) + // - 60 (one minute) + // - 300 (five minutes) + // - 3600 (one hour) + // - 86400 (twenty-four hours) + // If you don't specify PeriodInSeconds , then Performance Insights will choose a + // value for you, with a goal of returning roughly 100-200 data points in the + // response. PeriodInSeconds *int32 noSmithyDocumentSerde @@ -120,19 +111,19 @@ type GetResourceMetricsInput struct { type GetResourceMetricsOutput struct { // The end time for the returned metrics, after alignment to a granular boundary - // (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal - // to the value of the user-specified Endtime. + // (as specified by PeriodInSeconds ). AlignedEndTime will be greater than or + // equal to the value of the user-specified Endtime . AlignedEndTime *time.Time // The start time for the returned metrics, after alignment to a granular boundary - // (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal - // to the value of the user-specified StartTime. + // (as specified by PeriodInSeconds ). AlignedStartTime will be less than or equal + // to the value of the user-specified StartTime . AlignedStartTime *time.Time // An immutable identifier for a data source that is unique for an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. In // the console, the identifier is shown as ResourceID. When you call - // DescribeDBInstances, the identifier is returned as DbiResourceId. + // DescribeDBInstances , the identifier is returned as DbiResourceId . Identifier *string // An array of metric results, where each array element contains all of the data @@ -141,7 +132,7 @@ type GetResourceMetricsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/pi/api_op_ListAvailableResourceDimensions.go b/service/pi/api_op_ListAvailableResourceDimensions.go index 2e4b0b4c4d3..c5fd9838127 100644 --- a/service/pi/api_op_ListAvailableResourceDimensions.go +++ b/service/pi/api_op_ListAvailableResourceDimensions.go @@ -33,14 +33,14 @@ type ListAvailableResourceDimensionsInput struct { // An immutable identifier for a data source that is unique within an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. To - // use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. - // For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ. + // use an Amazon RDS DB instance as a data source, specify its DbiResourceId + // value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ . // // This member is required. Identifier *string // The types of metrics for which to retrieve dimensions. Valid values include - // db.load. + // db.load . // // This member is required. Metrics []string @@ -57,7 +57,7 @@ type ListAvailableResourceDimensionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string noSmithyDocumentSerde @@ -70,7 +70,7 @@ type ListAvailableResourceDimensionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/pi/api_op_ListAvailableResourceMetrics.go b/service/pi/api_op_ListAvailableResourceMetrics.go index 00b19ca7633..a1579c85496 100644 --- a/service/pi/api_op_ListAvailableResourceMetrics.go +++ b/service/pi/api_op_ListAvailableResourceMetrics.go @@ -33,25 +33,19 @@ type ListAvailableResourceMetricsInput struct { // An immutable identifier for a data source that is unique within an Amazon Web // Services Region. Performance Insights gathers metrics from this data source. To - // use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. - // For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ. + // use an Amazon RDS DB instance as a data source, specify its DbiResourceId + // value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ . // // This member is required. Identifier *string // The types of metrics to return in the response. Valid values in the array // include the following: - // - // * os (OS counter metrics) - All engines - // - // * db (DB load - // metrics) - All engines except for Amazon DocumentDB - // - // * db.sql.stats (per-SQL - // metrics) - All engines except for Amazon DocumentDB - // - // * db.sql_tokenized.stats - // (per-SQL digest metrics) - All engines except for Amazon DocumentDB + // - os (OS counter metrics) - All engines + // - db (DB load metrics) - All engines except for Amazon DocumentDB + // - db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB + // - db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for + // Amazon DocumentDB // // This member is required. MetricTypes []string @@ -67,7 +61,7 @@ type ListAvailableResourceMetricsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the token, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . NextToken *string noSmithyDocumentSerde diff --git a/service/pi/doc.go b/service/pi/doc.go index 4acf5cee13b..875be7f1fcf 100644 --- a/service/pi/doc.go +++ b/service/pi/doc.go @@ -16,20 +16,13 @@ // provides DB load data for each time point in the queried time range. Each time // point decomposes overall load in relation to the requested dimensions, measured // at that time point. Examples include SQL, Wait event, User, and Host. -// -// * To -// learn more about Performance Insights and Amazon Aurora DB instances, go to the -// Amazon Aurora User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) -// . -// -// * To learn more about Performance Insights and Amazon RDS DB instances, go to -// the Amazon RDS User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) -// . -// -// * To learn more about Performance Insights and Amazon DocumentDB clusters, go -// to the Amazon DocumentDB Developer Guide -// (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) -// . +// - To learn more about Performance Insights and Amazon Aurora DB instances, go +// to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) +// . +// - To learn more about Performance Insights and Amazon RDS DB instances, go to +// the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) +// . +// - To learn more about Performance Insights and Amazon DocumentDB clusters, go +// to the Amazon DocumentDB Developer Guide (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) +// . package pi diff --git a/service/pi/types/enums.go b/service/pi/types/enums.go index ba754c84979..a7dd0eccd15 100644 --- a/service/pi/types/enums.go +++ b/service/pi/types/enums.go @@ -11,9 +11,9 @@ const ( DetailStatusUnavailable DetailStatus = "UNAVAILABLE" ) -// Values returns all known values for DetailStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DetailStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DetailStatus) Values() []DetailStatus { return []DetailStatus{ "AVAILABLE", diff --git a/service/pi/types/types.go b/service/pi/types/types.go index 96ca52558c4..2eb69a2b835 100644 --- a/service/pi/types/types.go +++ b/service/pi/types/types.go @@ -11,12 +11,12 @@ import ( // measurement at a particular point in time. type DataPoint struct { - // The time, in epoch format, associated with a particular Value. + // The time, in epoch format, associated with a particular Value . // // This member is required. Timestamp *time.Time - // The actual value associated with a particular Timestamp. + // The actual value associated with a particular Timestamp . // // This member is required. Value *float64 @@ -35,86 +35,49 @@ type DimensionDetail struct { // A logical grouping of Performance Insights metrics for a related subject area. // For example, the db.sql dimension group consists of the following dimensions: +// - db.sql.id - The hash of a running SQL statement, generated by Performance +// Insights. +// - db.sql.db_id - Either the SQL ID generated by the database engine, or a +// value generated by Performance Insights that begins with pi- . +// - db.sql.statement - The full text of the SQL statement that is running, for +// example, SELECT * FROM employees . +// - db.sql_tokenized.id - The hash of the SQL digest generated by Performance +// Insights. // -// * -// db.sql.id - The hash of a running SQL statement, generated by Performance -// Insights. -// -// * db.sql.db_id - Either the SQL ID generated by the database engine, -// or a value generated by Performance Insights that begins with pi-. -// -// * -// db.sql.statement - The full text of the SQL statement that is running, for -// example, SELECT * FROM employees. -// -// * db.sql_tokenized.id - The hash of the SQL -// digest generated by Performance Insights. -// -// Each response element returns a -// maximum of 500 bytes. For larger elements, such as SQL statements, only the -// first 500 bytes are returned. +// Each response element returns a maximum of 500 bytes. For larger elements, such +// as SQL statements, only the first 500 bytes are returned. type DimensionGroup struct { // The name of the dimension group. Valid values are as follows: - // - // * db - The name - // of the database to which the client is connected. The following values are - // permitted: - // - // * Aurora PostgreSQL - // - // * Amazon RDS PostgreSQL - // - // * Aurora MySQL - // - // * - // Amazon RDS MySQL - // - // * Amazon RDS MariaDB - // - // * Amazon DocumentDB - // - // * db.application - - // The name of the application that is connected to the database. The following - // values are permitted: - // - // * Aurora PostgreSQL - // - // * Amazon RDS PostgreSQL - // - // * Amazon - // DocumentDB - // - // * db.host - The host name of the connected client (all engines). - // - // * - // db.query - The query that is currently running (only Amazon DocumentDB). - // - // * - // db.query_tokenized - The digest query (only Amazon DocumentDB). - // - // * - // db.session_type - The type of the current session (only Aurora PostgreSQL and - // RDS PostgreSQL). - // - // * db.sql - The text of the SQL statement that is currently - // running (all engines except Amazon DocumentDB). - // - // * db.sql_tokenized - The SQL - // digest (all engines except Amazon DocumentDB). - // - // * db.user - The user logged in - // to the database (all engines except Amazon DocumentDB). - // - // * db.wait_event - The - // event for which the database backend is waiting (all engines except Amazon - // DocumentDB). - // - // * db.wait_event_type - The type of event for which the database - // backend is waiting (all engines except Amazon DocumentDB). - // - // * db.wait_state - - // The event for which the database backend is waiting (only Amazon DocumentDB). + // - db - The name of the database to which the client is connected. The + // following values are permitted: + // - Aurora PostgreSQL + // - Amazon RDS PostgreSQL + // - Aurora MySQL + // - Amazon RDS MySQL + // - Amazon RDS MariaDB + // - Amazon DocumentDB + // - db.application - The name of the application that is connected to the + // database. The following values are permitted: + // - Aurora PostgreSQL + // - Amazon RDS PostgreSQL + // - Amazon DocumentDB + // - db.host - The host name of the connected client (all engines). + // - db.query - The query that is currently running (only Amazon DocumentDB). + // - db.query_tokenized - The digest query (only Amazon DocumentDB). + // - db.session_type - The type of the current session (only Aurora PostgreSQL + // and RDS PostgreSQL). + // - db.sql - The text of the SQL statement that is currently running (all + // engines except Amazon DocumentDB). + // - db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB). + // - db.user - The user logged in to the database (all engines except Amazon + // DocumentDB). + // - db.wait_event - The event for which the database backend is waiting (all + // engines except Amazon DocumentDB). + // - db.wait_event_type - The type of event for which the database backend is + // waiting (all engines except Amazon DocumentDB). + // - db.wait_state - The event for which the database backend is waiting (only + // Amazon DocumentDB). // // This member is required. Group *string @@ -123,114 +86,66 @@ type DimensionGroup struct { // present, then it signifies that all of the dimensions in the group were // requested, or are present in the response. Valid values for elements in the // Dimensions array are: - // - // * db.application.name - The name of the application that - // is connected to the database. Valid values are as follows: - // - // * Aurora - // PostgreSQL - // - // * Amazon RDS PostgreSQL - // - // * Amazon DocumentDB - // - // * db.host.id - The - // host ID of the connected client (all engines). - // - // * db.host.name - The host name - // of the connected client (all engines). - // - // * db.name - The name of the database to - // which the client is connected. Valid values are as follows: - // - // * Aurora - // PostgreSQL - // - // * Amazon RDS PostgreSQL - // - // * Aurora MySQL - // - // * Amazon RDS MySQL - // - // * - // Amazon RDS MariaDB - // - // * Amazon DocumentDB - // - // * db.query.id - The query ID generated - // by Performance Insights (only Amazon DocumentDB). - // - // * db.query.db_id - The query - // ID generated by the database (only Amazon DocumentDB). - // - // * db.query.statement - - // The text of the query that is being run (only Amazon DocumentDB). - // - // * - // db.query.tokenized_id - // - // * db.query.tokenized.id - The query digest ID generated - // by Performance Insights (only Amazon DocumentDB). - // - // * db.query.tokenized.db_id - - // The query digest ID generated by Performance Insights (only Amazon - // DocumentDB). - // - // * db.query.tokenized.statement - The text of the query digest - // (only Amazon DocumentDB). - // - // * db.session_type.name - The type of the current - // session (only Amazon DocumentDB). - // - // * db.sql.id - The hash of the full, - // non-tokenized SQL statement generated by Performance Insights (all engines - // except Amazon DocumentDB). - // - // * db.sql.db_id - Either the SQL ID generated by the - // database engine, or a value generated by Performance Insights that begins with - // pi- (all engines except Amazon DocumentDB). - // - // * db.sql.statement - The full text - // of the SQL statement that is running, as in SELECT * FROM employees (all engines - // except Amazon DocumentDB) - // - // * db.sql.tokenized_id - // - // * db.sql_tokenized.id - The - // hash of the SQL digest generated by Performance Insights (all engines except - // Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID - // because Amazon Web Services Support can look at this data to help you - // troubleshoot database issues. - // - // * db.sql_tokenized.db_id - Either the native - // database ID used to refer to the SQL statement, or a synthetic ID such as - // pi-2372568224 that Performance Insights generates if the native database ID - // isn't available (all engines except Amazon DocumentDB). - // - // * - // db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM - // employees WHERE employee_id = ? (all engines except Amazon DocumentDB) - // - // * - // db.user.id - The ID of the user logged in to the database (all engines except - // Amazon DocumentDB). - // - // * db.user.name - The name of the user logged in to the - // database (all engines except Amazon DocumentDB). - // - // * db.wait_event.name - The - // event for which the backend is waiting (all engines except Amazon - // DocumentDB). - // - // * db.wait_event.type - The type of event for which the backend is - // waiting (all engines except Amazon DocumentDB). - // - // * db.wait_event_type.name - The - // name of the event type for which the backend is waiting (all engines except - // Amazon DocumentDB). - // - // * db.wait_state.name - The event for which the backend is - // waiting (only Amazon DocumentDB). + // - db.application.name - The name of the application that is connected to the + // database. Valid values are as follows: + // - Aurora PostgreSQL + // - Amazon RDS PostgreSQL + // - Amazon DocumentDB + // - db.host.id - The host ID of the connected client (all engines). + // - db.host.name - The host name of the connected client (all engines). + // - db.name - The name of the database to which the client is connected. Valid + // values are as follows: + // - Aurora PostgreSQL + // - Amazon RDS PostgreSQL + // - Aurora MySQL + // - Amazon RDS MySQL + // - Amazon RDS MariaDB + // - Amazon DocumentDB + // - db.query.id - The query ID generated by Performance Insights (only Amazon + // DocumentDB). + // - db.query.db_id - The query ID generated by the database (only Amazon + // DocumentDB). + // - db.query.statement - The text of the query that is being run (only Amazon + // DocumentDB). + // - db.query.tokenized_id + // - db.query.tokenized.id - The query digest ID generated by Performance + // Insights (only Amazon DocumentDB). + // - db.query.tokenized.db_id - The query digest ID generated by Performance + // Insights (only Amazon DocumentDB). + // - db.query.tokenized.statement - The text of the query digest (only Amazon + // DocumentDB). + // - db.session_type.name - The type of the current session (only Amazon + // DocumentDB). + // - db.sql.id - The hash of the full, non-tokenized SQL statement generated by + // Performance Insights (all engines except Amazon DocumentDB). + // - db.sql.db_id - Either the SQL ID generated by the database engine, or a + // value generated by Performance Insights that begins with pi- (all engines + // except Amazon DocumentDB). + // - db.sql.statement - The full text of the SQL statement that is running, as in + // SELECT * FROM employees (all engines except Amazon DocumentDB) + // - db.sql.tokenized_id + // - db.sql_tokenized.id - The hash of the SQL digest generated by Performance + // Insights (all engines except Amazon DocumentDB). In the console, + // db.sql_tokenized.id is called the Support ID because Amazon Web Services + // Support can look at this data to help you troubleshoot database issues. + // - db.sql_tokenized.db_id - Either the native database ID used to refer to the + // SQL statement, or a synthetic ID such as pi-2372568224 that Performance + // Insights generates if the native database ID isn't available (all engines except + // Amazon DocumentDB). + // - db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * + // FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB) + // - db.user.id - The ID of the user logged in to the database (all engines + // except Amazon DocumentDB). + // - db.user.name - The name of the user logged in to the database (all engines + // except Amazon DocumentDB). + // - db.wait_event.name - The event for which the backend is waiting (all engines + // except Amazon DocumentDB). + // - db.wait_event.type - The type of event for which the backend is waiting (all + // engines except Amazon DocumentDB). + // - db.wait_event_type.name - The name of the event type for which the backend + // is waiting (all engines except Amazon DocumentDB). + // - db.wait_state.name - The event for which the backend is waiting (only Amazon + // DocumentDB). Dimensions []string // The maximum number of items to fetch for this dimension group. @@ -251,8 +166,8 @@ type DimensionGroupDetail struct { noSmithyDocumentSerde } -// An object that includes the requested dimension key values and aggregated metric -// values within a dimension group. +// An object that includes the requested dimension key values and aggregated +// metric values within a dimension group. type DimensionKeyDescription struct { // A map that contains the value for each additional metric. @@ -275,35 +190,22 @@ type DimensionKeyDetail struct { // The full name of the dimension. The full name includes the group name and key // name. The following values are valid: - // - // * db.query.statement (Amazon - // DocumentDB) - // - // * db.sql.statement (Amazon RDS and Aurora) + // - db.query.statement (Amazon DocumentDB) + // - db.sql.statement (Amazon RDS and Aurora) Dimension *string - // The status of the dimension detail data. Possible values include the - // following: - // - // * AVAILABLE - The dimension detail data is ready to be retrieved. - // - // * - // PROCESSING - The dimension detail data isn't ready to be retrieved because more - // processing time is required. If the requested detail data has the status - // PROCESSING, Performance Insights returns the truncated query. - // - // * UNAVAILABLE - - // The dimension detail data could not be collected successfully. + // The status of the dimension detail data. Possible values include the following: + // - AVAILABLE - The dimension detail data is ready to be retrieved. + // - PROCESSING - The dimension detail data isn't ready to be retrieved because + // more processing time is required. If the requested detail data has the status + // PROCESSING , Performance Insights returns the truncated query. + // - UNAVAILABLE - The dimension detail data could not be collected successfully. Status DetailStatus // The value of the dimension detail data. Depending on the return status, this // value is either the full or truncated SQL query for the following dimensions: - // - // * - // db.query.statement (Amazon DocumentDB) - // - // * db.sql.statement (Amazon RDS and - // Aurora) + // - db.query.statement (Amazon DocumentDB) + // - db.sql.statement (Amazon RDS and Aurora) Value *string noSmithyDocumentSerde @@ -315,23 +217,14 @@ type FeatureMetadata struct { // The status of the feature on the DB instance. Possible values include the // following: - // - // * ENABLED - The feature is enabled on the instance. - // - // * DISABLED - - // The feature is disabled on the instance. - // - // * UNSUPPORTED - The feature isn't - // supported on the instance. - // - // * ENABLED_PENDING_REBOOT - The feature is enabled on - // the instance but requires a reboot to take effect. - // - // * DISABLED_PENDING_REBOOT - - // The feature is disabled on the instance but requires a reboot to take effect. - // - // * - // UNKNOWN - The feature status couldn't be determined. + // - ENABLED - The feature is enabled on the instance. + // - DISABLED - The feature is disabled on the instance. + // - UNSUPPORTED - The feature isn't supported on the instance. + // - ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires + // a reboot to take effect. + // - DISABLED_PENDING_REBOOT - The feature is disabled on the instance but + // requires a reboot to take effect. + // - UNKNOWN - The feature status couldn't be determined. Status FeatureStatus noSmithyDocumentSerde @@ -366,42 +259,32 @@ type MetricKeyDataPoints struct { // A single query to be processed. You must provide the metric to query. If no // other parameters are specified, Performance Insights returns all data points for // the specified metric. Optionally, you can request that the data points be -// aggregated by dimension group (GroupBy), and return only those data points that -// match your criteria (Filter). +// aggregated by dimension group ( GroupBy ), and return only those data points +// that match your criteria ( Filter ). type MetricQuery struct { // The name of a Performance Insights metric to be measured. Valid values for // Metric are: - // - // * db.load.avg - A scaled representation of the number of active - // sessions for the database engine. - // - // * db.sampledload.avg - The raw number of - // active sessions for the database engine. - // - // * The counter metrics listed in - // Performance Insights operating system counters - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) - // in the Amazon Aurora User Guide. - // - // If the number of active sessions is less than - // an internal Performance Insights threshold, db.load.avg and db.sampledload.avg - // are the same value. If the number of active sessions is greater than the - // internal threshold, Performance Insights samples the active sessions, with - // db.load.avg showing the scaled values, db.sampledload.avg showing the raw - // values, and db.sampledload.avg less than db.load.avg. For most use cases, you - // can query db.load.avg only. + // - db.load.avg - A scaled representation of the number of active sessions for + // the database engine. + // - db.sampledload.avg - The raw number of active sessions for the database + // engine. + // - The counter metrics listed in Performance Insights operating system counters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) + // in the Amazon Aurora User Guide. + // If the number of active sessions is less than an internal Performance Insights + // threshold, db.load.avg and db.sampledload.avg are the same value. If the number + // of active sessions is greater than the internal threshold, Performance Insights + // samples the active sessions, with db.load.avg showing the scaled values, + // db.sampledload.avg showing the raw values, and db.sampledload.avg less than + // db.load.avg . For most use cases, you can query db.load.avg only. // // This member is required. Metric *string // One or more filters to apply in the request. Restrictions: - // - // * Any number of - // filters by the same dimension, as specified in the GroupBy parameter. - // - // * A - // single filter for any other dimension in this dimension group. + // - Any number of filters by the same dimension, as specified in the GroupBy + // parameter. + // - A single filter for any other dimension in this dimension group. Filter map[string]string // A specification for how to aggregate the data points from a query result. You @@ -447,25 +330,18 @@ type ResponseResourceMetricKey struct { // The name of a Performance Insights metric to be measured. Valid values for // Metric are: - // - // * db.load.avg - A scaled representation of the number of active - // sessions for the database engine. - // - // * db.sampledload.avg - The raw number of - // active sessions for the database engine. - // - // * The counter metrics listed in - // Performance Insights operating system counters - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) - // in the Amazon Aurora User Guide. - // - // If the number of active sessions is less than - // an internal Performance Insights threshold, db.load.avg and db.sampledload.avg - // are the same value. If the number of active sessions is greater than the - // internal threshold, Performance Insights samples the active sessions, with - // db.load.avg showing the scaled values, db.sampledload.avg showing the raw - // values, and db.sampledload.avg less than db.load.avg. For most use cases, you - // can query db.load.avg only. + // - db.load.avg - A scaled representation of the number of active sessions for + // the database engine. + // - db.sampledload.avg - The raw number of active sessions for the database + // engine. + // - The counter metrics listed in Performance Insights operating system counters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) + // in the Amazon Aurora User Guide. + // If the number of active sessions is less than an internal Performance Insights + // threshold, db.load.avg and db.sampledload.avg are the same value. If the number + // of active sessions is greater than the internal threshold, Performance Insights + // samples the active sessions, with db.load.avg showing the scaled values, + // db.sampledload.avg showing the raw values, and db.sampledload.avg less than + // db.load.avg . For most use cases, you can query db.load.avg only. // // This member is required. Metric *string diff --git a/service/pinpoint/api_client.go b/service/pinpoint/api_client.go index 1ee949d9dbc..56437ffb3b9 100644 --- a/service/pinpoint/api_client.go +++ b/service/pinpoint/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pinpoint/api_op_CreateCampaign.go b/service/pinpoint/api_op_CreateCampaign.go index ac934610387..bcd94c6cef5 100644 --- a/service/pinpoint/api_op_CreateCampaign.go +++ b/service/pinpoint/api_op_CreateCampaign.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new campaign for an application or updates the settings of an existing -// campaign for an application. +// Creates a new campaign for an application or updates the settings of an +// existing campaign for an application. func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error) { if params == nil { params = &CreateCampaignInput{} diff --git a/service/pinpoint/api_op_CreateRecommenderConfiguration.go b/service/pinpoint/api_op_CreateRecommenderConfiguration.go index 547de44d430..0832161f2f3 100644 --- a/service/pinpoint/api_op_CreateRecommenderConfiguration.go +++ b/service/pinpoint/api_op_CreateRecommenderConfiguration.go @@ -40,8 +40,8 @@ type CreateRecommenderConfigurationInput struct { type CreateRecommenderConfigurationOutput struct { - // Provides information about Amazon Pinpoint configuration settings for retrieving - // and processing data from a recommender model. + // Provides information about Amazon Pinpoint configuration settings for + // retrieving and processing data from a recommender model. // // This member is required. RecommenderConfigurationResponse *types.RecommenderConfigurationResponse diff --git a/service/pinpoint/api_op_DeleteEmailTemplate.go b/service/pinpoint/api_op_DeleteEmailTemplate.go index e0319586917..2cd9cef8a6d 100644 --- a/service/pinpoint/api_op_DeleteEmailTemplate.go +++ b/service/pinpoint/api_op_DeleteEmailTemplate.go @@ -46,17 +46,13 @@ type DeleteEmailTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_DeleteEventStream.go b/service/pinpoint/api_op_DeleteEventStream.go index 8e18e7d9463..5812687c2ab 100644 --- a/service/pinpoint/api_op_DeleteEventStream.go +++ b/service/pinpoint/api_op_DeleteEventStream.go @@ -40,8 +40,8 @@ type DeleteEventStreamInput struct { type DeleteEventStreamOutput struct { - // Specifies settings for publishing event data to an Amazon Kinesis data stream or - // an Amazon Kinesis Data Firehose delivery stream. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // This member is required. EventStream *types.EventStream diff --git a/service/pinpoint/api_op_DeleteInAppTemplate.go b/service/pinpoint/api_op_DeleteInAppTemplate.go index ef82ee621c7..ac9a6cfae1d 100644 --- a/service/pinpoint/api_op_DeleteInAppTemplate.go +++ b/service/pinpoint/api_op_DeleteInAppTemplate.go @@ -45,17 +45,13 @@ type DeleteInAppTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_DeletePushTemplate.go b/service/pinpoint/api_op_DeletePushTemplate.go index 324e00a9a63..eb8a9a859e4 100644 --- a/service/pinpoint/api_op_DeletePushTemplate.go +++ b/service/pinpoint/api_op_DeletePushTemplate.go @@ -46,17 +46,13 @@ type DeletePushTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_DeleteRecommenderConfiguration.go b/service/pinpoint/api_op_DeleteRecommenderConfiguration.go index 7f705099415..517ccf1a93a 100644 --- a/service/pinpoint/api_op_DeleteRecommenderConfiguration.go +++ b/service/pinpoint/api_op_DeleteRecommenderConfiguration.go @@ -40,8 +40,8 @@ type DeleteRecommenderConfigurationInput struct { type DeleteRecommenderConfigurationOutput struct { - // Provides information about Amazon Pinpoint configuration settings for retrieving - // and processing data from a recommender model. + // Provides information about Amazon Pinpoint configuration settings for + // retrieving and processing data from a recommender model. // // This member is required. RecommenderConfigurationResponse *types.RecommenderConfigurationResponse diff --git a/service/pinpoint/api_op_DeleteSmsTemplate.go b/service/pinpoint/api_op_DeleteSmsTemplate.go index dd6bbacc98c..4bb66f59617 100644 --- a/service/pinpoint/api_op_DeleteSmsTemplate.go +++ b/service/pinpoint/api_op_DeleteSmsTemplate.go @@ -45,17 +45,13 @@ type DeleteSmsTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_DeleteVoiceTemplate.go b/service/pinpoint/api_op_DeleteVoiceTemplate.go index f00c73d1d03..6d94a0d03fe 100644 --- a/service/pinpoint/api_op_DeleteVoiceTemplate.go +++ b/service/pinpoint/api_op_DeleteVoiceTemplate.go @@ -46,17 +46,13 @@ type DeleteVoiceTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetApnsVoipChannel.go b/service/pinpoint/api_op_GetApnsVoipChannel.go index 471db62dde7..49e5ad13fe7 100644 --- a/service/pinpoint/api_op_GetApnsVoipChannel.go +++ b/service/pinpoint/api_op_GetApnsVoipChannel.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the status and settings of the APNs VoIP channel for -// an application. +// Retrieves information about the status and settings of the APNs VoIP channel +// for an application. func (c *Client) GetApnsVoipChannel(ctx context.Context, params *GetApnsVoipChannelInput, optFns ...func(*Options)) (*GetApnsVoipChannelOutput, error) { if params == nil { params = &GetApnsVoipChannelInput{} diff --git a/service/pinpoint/api_op_GetApplicationDateRangeKpi.go b/service/pinpoint/api_op_GetApplicationDateRangeKpi.go index fa1f9311a86..9c2b264ced7 100644 --- a/service/pinpoint/api_op_GetApplicationDateRangeKpi.go +++ b/service/pinpoint/api_op_GetApplicationDateRangeKpi.go @@ -12,8 +12,8 @@ import ( "time" ) -// Retrieves (queries) pre-aggregated data for a standard metric that applies to an -// application. +// Retrieves (queries) pre-aggregated data for a standard metric that applies to +// an application. func (c *Client) GetApplicationDateRangeKpi(ctx context.Context, params *GetApplicationDateRangeKpiInput, optFns ...func(*Options)) (*GetApplicationDateRangeKpiOutput, error) { if params == nil { params = &GetApplicationDateRangeKpiInput{} @@ -42,8 +42,8 @@ type GetApplicationDateRangeKpiInput struct { // two or more terms, which are comprised of lowercase alphanumeric characters, // separated by a hyphen. Examples are email-open-rate and // successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint - // Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string @@ -63,11 +63,11 @@ type GetApplicationDateRangeKpiInput struct { // This parameter is not supported for application, campaign, and journey metrics. PageSize *string - // The first date and time to retrieve data for, as part of an inclusive date range - // that filters the query results. This value should be in extended ISO 8601 format - // and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for - // 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the - // current day. + // The first date and time to retrieve data for, as part of an inclusive date + // range that filters the query results. This value should be in extended ISO 8601 + // format and use Coordinated Universal Time (UTC), for example: + // 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be + // fewer than 90 days from the current day. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetApplicationSettings.go b/service/pinpoint/api_op_GetApplicationSettings.go index 42c44506fdc..f14f474ed22 100644 --- a/service/pinpoint/api_op_GetApplicationSettings.go +++ b/service/pinpoint/api_op_GetApplicationSettings.go @@ -40,8 +40,8 @@ type GetApplicationSettingsInput struct { type GetApplicationSettingsOutput struct { - // Provides information about an application, including the default settings for an - // application. + // Provides information about an application, including the default settings for + // an application. // // This member is required. ApplicationSettingsResource *types.ApplicationSettingsResource diff --git a/service/pinpoint/api_op_GetCampaignDateRangeKpi.go b/service/pinpoint/api_op_GetCampaignDateRangeKpi.go index 188460dbe43..544711ad49c 100644 --- a/service/pinpoint/api_op_GetCampaignDateRangeKpi.go +++ b/service/pinpoint/api_op_GetCampaignDateRangeKpi.go @@ -47,8 +47,8 @@ type GetCampaignDateRangeKpiInput struct { // two or more terms, which are comprised of lowercase alphanumeric characters, // separated by a hyphen. Examples are email-open-rate and // successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint - // Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string @@ -68,11 +68,11 @@ type GetCampaignDateRangeKpiInput struct { // This parameter is not supported for application, campaign, and journey metrics. PageSize *string - // The first date and time to retrieve data for, as part of an inclusive date range - // that filters the query results. This value should be in extended ISO 8601 format - // and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for - // 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the - // current day. + // The first date and time to retrieve data for, as part of an inclusive date + // range that filters the query results. This value should be in extended ISO 8601 + // format and use Coordinated Universal Time (UTC), for example: + // 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be + // fewer than 90 days from the current day. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetEmailTemplate.go b/service/pinpoint/api_op_GetEmailTemplate.go index 4aeffbc2398..a1cf1b5d473 100644 --- a/service/pinpoint/api_op_GetEmailTemplate.go +++ b/service/pinpoint/api_op_GetEmailTemplate.go @@ -46,17 +46,13 @@ type GetEmailTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetEventStream.go b/service/pinpoint/api_op_GetEventStream.go index a3d6d86b605..0dfccd6328f 100644 --- a/service/pinpoint/api_op_GetEventStream.go +++ b/service/pinpoint/api_op_GetEventStream.go @@ -40,8 +40,8 @@ type GetEventStreamInput struct { type GetEventStreamOutput struct { - // Specifies settings for publishing event data to an Amazon Kinesis data stream or - // an Amazon Kinesis Data Firehose delivery stream. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // This member is required. EventStream *types.EventStream diff --git a/service/pinpoint/api_op_GetExportJob.go b/service/pinpoint/api_op_GetExportJob.go index 603ac0fa17c..bdaea68b9c8 100644 --- a/service/pinpoint/api_op_GetExportJob.go +++ b/service/pinpoint/api_op_GetExportJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the status and settings of a specific export job for -// an application. +// Retrieves information about the status and settings of a specific export job +// for an application. func (c *Client) GetExportJob(ctx context.Context, params *GetExportJobInput, optFns ...func(*Options)) (*GetExportJobOutput, error) { if params == nil { params = &GetExportJobInput{} diff --git a/service/pinpoint/api_op_GetImportJob.go b/service/pinpoint/api_op_GetImportJob.go index 4df58475c9e..f2b30fa9933 100644 --- a/service/pinpoint/api_op_GetImportJob.go +++ b/service/pinpoint/api_op_GetImportJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the status and settings of a specific import job for -// an application. +// Retrieves information about the status and settings of a specific import job +// for an application. func (c *Client) GetImportJob(ctx context.Context, params *GetImportJobInput, optFns ...func(*Options)) (*GetImportJobOutput, error) { if params == nil { params = &GetImportJobInput{} diff --git a/service/pinpoint/api_op_GetInAppTemplate.go b/service/pinpoint/api_op_GetInAppTemplate.go index ba4e2162a87..ccbd824a598 100644 --- a/service/pinpoint/api_op_GetInAppTemplate.go +++ b/service/pinpoint/api_op_GetInAppTemplate.go @@ -46,17 +46,13 @@ type GetInAppTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetJourneyDateRangeKpi.go b/service/pinpoint/api_op_GetJourneyDateRangeKpi.go index 0e5e515b937..79859409957 100644 --- a/service/pinpoint/api_op_GetJourneyDateRangeKpi.go +++ b/service/pinpoint/api_op_GetJourneyDateRangeKpi.go @@ -47,8 +47,8 @@ type GetJourneyDateRangeKpiInput struct { // two or more terms, which are comprised of lowercase alphanumeric characters, // separated by a hyphen. Examples are email-open-rate and // successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint - // Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string @@ -68,11 +68,11 @@ type GetJourneyDateRangeKpiInput struct { // This parameter is not supported for application, campaign, and journey metrics. PageSize *string - // The first date and time to retrieve data for, as part of an inclusive date range - // that filters the query results. This value should be in extended ISO 8601 format - // and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for - // 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the - // current day. + // The first date and time to retrieve data for, as part of an inclusive date + // range that filters the query results. This value should be in extended ISO 8601 + // format and use Coordinated Universal Time (UTC), for example: + // 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be + // fewer than 90 days from the current day. StartTime *time.Time noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetJourneyExecutionActivityMetrics.go b/service/pinpoint/api_op_GetJourneyExecutionActivityMetrics.go index c2be71d571a..ebfefee0531 100644 --- a/service/pinpoint/api_op_GetJourneyExecutionActivityMetrics.go +++ b/service/pinpoint/api_op_GetJourneyExecutionActivityMetrics.go @@ -60,9 +60,9 @@ type GetJourneyExecutionActivityMetricsInput struct { type GetJourneyExecutionActivityMetricsOutput struct { - // Provides the results of a query that retrieved the data for a standard execution - // metric that applies to a journey activity, and provides information about that - // query. + // Provides the results of a query that retrieved the data for a standard + // execution metric that applies to a journey activity, and provides information + // about that query. // // This member is required. JourneyExecutionActivityMetricsResponse *types.JourneyExecutionActivityMetricsResponse diff --git a/service/pinpoint/api_op_GetJourneyExecutionMetrics.go b/service/pinpoint/api_op_GetJourneyExecutionMetrics.go index 7a62733acbf..3c6030e6c25 100644 --- a/service/pinpoint/api_op_GetJourneyExecutionMetrics.go +++ b/service/pinpoint/api_op_GetJourneyExecutionMetrics.go @@ -55,8 +55,9 @@ type GetJourneyExecutionMetricsInput struct { type GetJourneyExecutionMetricsOutput struct { - // Provides the results of a query that retrieved the data for a standard execution - // metric that applies to a journey, and provides information about that query. + // Provides the results of a query that retrieved the data for a standard + // execution metric that applies to a journey, and provides information about that + // query. // // This member is required. JourneyExecutionMetricsResponse *types.JourneyExecutionMetricsResponse diff --git a/service/pinpoint/api_op_GetPushTemplate.go b/service/pinpoint/api_op_GetPushTemplate.go index f7a2ab1f7fd..40af3001b3b 100644 --- a/service/pinpoint/api_op_GetPushTemplate.go +++ b/service/pinpoint/api_op_GetPushTemplate.go @@ -46,17 +46,13 @@ type GetPushTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetRecommenderConfiguration.go b/service/pinpoint/api_op_GetRecommenderConfiguration.go index 4b30c998b69..7337b464f43 100644 --- a/service/pinpoint/api_op_GetRecommenderConfiguration.go +++ b/service/pinpoint/api_op_GetRecommenderConfiguration.go @@ -41,8 +41,8 @@ type GetRecommenderConfigurationInput struct { type GetRecommenderConfigurationOutput struct { - // Provides information about Amazon Pinpoint configuration settings for retrieving - // and processing data from a recommender model. + // Provides information about Amazon Pinpoint configuration settings for + // retrieving and processing data from a recommender model. // // This member is required. RecommenderConfigurationResponse *types.RecommenderConfigurationResponse diff --git a/service/pinpoint/api_op_GetSegment.go b/service/pinpoint/api_op_GetSegment.go index 038a9e318a2..4e1e9311221 100644 --- a/service/pinpoint/api_op_GetSegment.go +++ b/service/pinpoint/api_op_GetSegment.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the configuration, dimension, and other settings for -// a specific segment that's associated with an application. +// Retrieves information about the configuration, dimension, and other settings +// for a specific segment that's associated with an application. func (c *Client) GetSegment(ctx context.Context, params *GetSegmentInput, optFns ...func(*Options)) (*GetSegmentOutput, error) { if params == nil { params = &GetSegmentInput{} diff --git a/service/pinpoint/api_op_GetSegmentVersion.go b/service/pinpoint/api_op_GetSegmentVersion.go index b25f3f02b9a..87166d9ce13 100644 --- a/service/pinpoint/api_op_GetSegmentVersion.go +++ b/service/pinpoint/api_op_GetSegmentVersion.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the configuration, dimension, and other settings for -// a specific version of a segment that's associated with an application. +// Retrieves information about the configuration, dimension, and other settings +// for a specific version of a segment that's associated with an application. func (c *Client) GetSegmentVersion(ctx context.Context, params *GetSegmentVersionInput, optFns ...func(*Options)) (*GetSegmentVersionOutput, error) { if params == nil { params = &GetSegmentVersionInput{} diff --git a/service/pinpoint/api_op_GetSegmentVersions.go b/service/pinpoint/api_op_GetSegmentVersions.go index 5c475ff67b2..f29397e88b8 100644 --- a/service/pinpoint/api_op_GetSegmentVersions.go +++ b/service/pinpoint/api_op_GetSegmentVersions.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the configuration, dimension, and other settings for -// all the versions of a specific segment that's associated with an application. +// Retrieves information about the configuration, dimension, and other settings +// for all the versions of a specific segment that's associated with an +// application. func (c *Client) GetSegmentVersions(ctx context.Context, params *GetSegmentVersionsInput, optFns ...func(*Options)) (*GetSegmentVersionsOutput, error) { if params == nil { params = &GetSegmentVersionsInput{} diff --git a/service/pinpoint/api_op_GetSegments.go b/service/pinpoint/api_op_GetSegments.go index 5cd03999e31..c0993e583fc 100644 --- a/service/pinpoint/api_op_GetSegments.go +++ b/service/pinpoint/api_op_GetSegments.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the configuration, dimension, and other settings for -// all the segments that are associated with an application. +// Retrieves information about the configuration, dimension, and other settings +// for all the segments that are associated with an application. func (c *Client) GetSegments(ctx context.Context, params *GetSegmentsInput, optFns ...func(*Options)) (*GetSegmentsOutput, error) { if params == nil { params = &GetSegmentsInput{} diff --git a/service/pinpoint/api_op_GetSmsTemplate.go b/service/pinpoint/api_op_GetSmsTemplate.go index 58fcb3cabb7..09b20c23155 100644 --- a/service/pinpoint/api_op_GetSmsTemplate.go +++ b/service/pinpoint/api_op_GetSmsTemplate.go @@ -46,17 +46,13 @@ type GetSmsTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_GetVoiceTemplate.go b/service/pinpoint/api_op_GetVoiceTemplate.go index e9dd5be819a..25ad8fa4290 100644 --- a/service/pinpoint/api_op_GetVoiceTemplate.go +++ b/service/pinpoint/api_op_GetVoiceTemplate.go @@ -46,17 +46,13 @@ type GetVoiceTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_ListJourneys.go b/service/pinpoint/api_op_ListJourneys.go index 4faec823e63..1504cef6395 100644 --- a/service/pinpoint/api_op_ListJourneys.go +++ b/service/pinpoint/api_op_ListJourneys.go @@ -49,8 +49,8 @@ type ListJourneysInput struct { type ListJourneysOutput struct { - // Provides information about the status, configuration, and other settings for all - // the journeys that are associated with an application. + // Provides information about the status, configuration, and other settings for + // all the journeys that are associated with an application. // // This member is required. JourneysResponse *types.JourneysResponse diff --git a/service/pinpoint/api_op_ListTemplateVersions.go b/service/pinpoint/api_op_ListTemplateVersions.go index 954f43d69b5..96e5a4665e9 100644 --- a/service/pinpoint/api_op_ListTemplateVersions.go +++ b/service/pinpoint/api_op_ListTemplateVersions.go @@ -37,8 +37,8 @@ type ListTemplateVersionsInput struct { // This member is required. TemplateName *string - // The type of channel that the message template is designed for. Valid values are: - // EMAIL, PUSH, SMS, and VOICE. + // The type of channel that the message template is designed for. Valid values + // are: EMAIL, PUSH, SMS, and VOICE. // // This member is required. TemplateType *string diff --git a/service/pinpoint/api_op_ListTemplates.go b/service/pinpoint/api_op_ListTemplates.go index 4d00a8b1b8f..6891871a733 100644 --- a/service/pinpoint/api_op_ListTemplates.go +++ b/service/pinpoint/api_op_ListTemplates.go @@ -44,9 +44,9 @@ type ListTemplatesInput struct { // whose names begin with the value that you specify. Prefix *string - // The type of message template to include in the results. Valid values are: EMAIL, - // PUSH, SMS, and VOICE. To include all types of templates in the results, don't - // include this parameter in your request. + // The type of message template to include in the results. Valid values are: + // EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, + // don't include this parameter in your request. TemplateType *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_PutEventStream.go b/service/pinpoint/api_op_PutEventStream.go index 7258ae96a42..471f0591937 100644 --- a/service/pinpoint/api_op_PutEventStream.go +++ b/service/pinpoint/api_op_PutEventStream.go @@ -36,8 +36,8 @@ type PutEventStreamInput struct { // This member is required. ApplicationId *string - // 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 + // 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. // // This member is required. @@ -48,8 +48,8 @@ type PutEventStreamInput struct { type PutEventStreamOutput struct { - // Specifies settings for publishing event data to an Amazon Kinesis data stream or - // an Amazon Kinesis Data Firehose delivery stream. + // Specifies settings for publishing event data to an Amazon Kinesis data stream + // or an Amazon Kinesis Data Firehose delivery stream. // // This member is required. EventStream *types.EventStream diff --git a/service/pinpoint/api_op_PutEvents.go b/service/pinpoint/api_op_PutEvents.go index 1c5b6f43cd0..ea4d7143e92 100644 --- a/service/pinpoint/api_op_PutEvents.go +++ b/service/pinpoint/api_op_PutEvents.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new event to record for endpoints, or creates or updates endpoint data -// that existing events are associated with. +// Creates a new event to record for endpoints, or creates or updates endpoint +// data that existing events are associated with. func (c *Client) PutEvents(ctx context.Context, params *PutEventsInput, optFns ...func(*Options)) (*PutEventsOutput, error) { if params == nil { params = &PutEventsInput{} diff --git a/service/pinpoint/api_op_RemoveAttributes.go b/service/pinpoint/api_op_RemoveAttributes.go index 415a297d5dc..792016f030e 100644 --- a/service/pinpoint/api_op_RemoveAttributes.go +++ b/service/pinpoint/api_op_RemoveAttributes.go @@ -37,19 +37,14 @@ type RemoveAttributesInput struct { ApplicationId *string // The type of attribute or attributes to remove. Valid values are: - // - // * - // endpoint-custom-attributes - Custom attributes that describe endpoints, such as - // the date when an associated user opted in or out of receiving communications - // from you through a specific type of channel. - // - // * endpoint-metric-attributes - - // Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as - // the number of app sessions or the number of items left in a cart. - // - // * - // endpoint-user-attributes - Custom attributes that describe users, such as first - // name, last name, and age. + // - endpoint-custom-attributes - Custom attributes that describe endpoints, + // such as the date when an associated user opted in or out of receiving + // communications from you through a specific type of channel. + // - endpoint-metric-attributes - Custom metrics that your app reports to Amazon + // Pinpoint for endpoints, such as the number of app sessions or the number of + // items left in a cart. + // - endpoint-user-attributes - Custom attributes that describe users, such as + // first name, last name, and age. // // This member is required. AttributeType *string diff --git a/service/pinpoint/api_op_UpdateAdmChannel.go b/service/pinpoint/api_op_UpdateAdmChannel.go index cddc26f158d..76217a004fc 100644 --- a/service/pinpoint/api_op_UpdateAdmChannel.go +++ b/service/pinpoint/api_op_UpdateAdmChannel.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the ADM channel for an application or updates the status and settings of -// the ADM channel for an application. +// Enables the ADM channel for an application or updates the status and settings +// of the ADM channel for an application. func (c *Client) UpdateAdmChannel(ctx context.Context, params *UpdateAdmChannelInput, optFns ...func(*Options)) (*UpdateAdmChannelOutput, error) { if params == nil { params = &UpdateAdmChannelInput{} diff --git a/service/pinpoint/api_op_UpdateApplicationSettings.go b/service/pinpoint/api_op_UpdateApplicationSettings.go index 6be78c10e46..1294fd85dad 100644 --- a/service/pinpoint/api_op_UpdateApplicationSettings.go +++ b/service/pinpoint/api_op_UpdateApplicationSettings.go @@ -45,8 +45,8 @@ type UpdateApplicationSettingsInput struct { type UpdateApplicationSettingsOutput struct { - // Provides information about an application, including the default settings for an - // application. + // Provides information about an application, including the default settings for + // an application. // // This member is required. ApplicationSettingsResource *types.ApplicationSettingsResource diff --git a/service/pinpoint/api_op_UpdateBaiduChannel.go b/service/pinpoint/api_op_UpdateBaiduChannel.go index 9d6c057cd2a..c650ce4717a 100644 --- a/service/pinpoint/api_op_UpdateBaiduChannel.go +++ b/service/pinpoint/api_op_UpdateBaiduChannel.go @@ -36,8 +36,8 @@ type UpdateBaiduChannelInput struct { // This member is required. ApplicationId *string - // Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an - // application. + // Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for + // an application. // // This member is required. BaiduChannelRequest *types.BaiduChannelRequest diff --git a/service/pinpoint/api_op_UpdateEmailTemplate.go b/service/pinpoint/api_op_UpdateEmailTemplate.go index 2f2dfa7177c..8e7f863316d 100644 --- a/service/pinpoint/api_op_UpdateEmailTemplate.go +++ b/service/pinpoint/api_op_UpdateEmailTemplate.go @@ -61,17 +61,13 @@ type UpdateEmailTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_UpdateEndpoint.go b/service/pinpoint/api_op_UpdateEndpoint.go index ea766ef5253..44e45d9dd4f 100644 --- a/service/pinpoint/api_op_UpdateEndpoint.go +++ b/service/pinpoint/api_op_UpdateEndpoint.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 for an endpoint. If an update includes one or more -// values for a custom attribute, Amazon Pinpoint replaces (overwrites) any +// 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 for an endpoint. If an update includes one +// or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any // existing values with the new values. func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error) { if params == nil { diff --git a/service/pinpoint/api_op_UpdateGcmChannel.go b/service/pinpoint/api_op_UpdateGcmChannel.go index 26aad061a75..7033ba4b6ef 100644 --- a/service/pinpoint/api_op_UpdateGcmChannel.go +++ b/service/pinpoint/api_op_UpdateGcmChannel.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the GCM channel for an application or updates the status and settings of -// the GCM channel for an application. +// Enables the GCM channel for an application or updates the status and settings +// of the GCM channel for an application. func (c *Client) UpdateGcmChannel(ctx context.Context, params *UpdateGcmChannelInput, optFns ...func(*Options)) (*UpdateGcmChannelOutput, error) { if params == nil { params = &UpdateGcmChannelInput{} diff --git a/service/pinpoint/api_op_UpdateInAppTemplate.go b/service/pinpoint/api_op_UpdateInAppTemplate.go index d0b50ef4085..05b4a32de42 100644 --- a/service/pinpoint/api_op_UpdateInAppTemplate.go +++ b/service/pinpoint/api_op_UpdateInAppTemplate.go @@ -60,17 +60,13 @@ type UpdateInAppTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_UpdatePushTemplate.go b/service/pinpoint/api_op_UpdatePushTemplate.go index c5322b0e9b7..790db780404 100644 --- a/service/pinpoint/api_op_UpdatePushTemplate.go +++ b/service/pinpoint/api_op_UpdatePushTemplate.go @@ -61,17 +61,13 @@ type UpdatePushTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_UpdateRecommenderConfiguration.go b/service/pinpoint/api_op_UpdateRecommenderConfiguration.go index b05dbd3c466..b33b19ac550 100644 --- a/service/pinpoint/api_op_UpdateRecommenderConfiguration.go +++ b/service/pinpoint/api_op_UpdateRecommenderConfiguration.go @@ -46,8 +46,8 @@ type UpdateRecommenderConfigurationInput struct { type UpdateRecommenderConfigurationOutput struct { - // Provides information about Amazon Pinpoint configuration settings for retrieving - // and processing data from a recommender model. + // Provides information about Amazon Pinpoint configuration settings for + // retrieving and processing data from a recommender model. // // This member is required. RecommenderConfigurationResponse *types.RecommenderConfigurationResponse diff --git a/service/pinpoint/api_op_UpdateSmsChannel.go b/service/pinpoint/api_op_UpdateSmsChannel.go index 51e8f71776b..ceb58c45539 100644 --- a/service/pinpoint/api_op_UpdateSmsChannel.go +++ b/service/pinpoint/api_op_UpdateSmsChannel.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the SMS channel for an application or updates the status and settings of -// the SMS channel for an application. +// Enables the SMS channel for an application or updates the status and settings +// of the SMS channel for an application. func (c *Client) UpdateSmsChannel(ctx context.Context, params *UpdateSmsChannelInput, optFns ...func(*Options)) (*UpdateSmsChannelOutput, error) { if params == nil { params = &UpdateSmsChannelInput{} diff --git a/service/pinpoint/api_op_UpdateSmsTemplate.go b/service/pinpoint/api_op_UpdateSmsTemplate.go index c69f15d2e67..e27cb5b3c70 100644 --- a/service/pinpoint/api_op_UpdateSmsTemplate.go +++ b/service/pinpoint/api_op_UpdateSmsTemplate.go @@ -61,17 +61,13 @@ type UpdateSmsTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/api_op_UpdateTemplateActiveVersion.go b/service/pinpoint/api_op_UpdateTemplateActiveVersion.go index b1bc33c29ee..5b15eb629f0 100644 --- a/service/pinpoint/api_op_UpdateTemplateActiveVersion.go +++ b/service/pinpoint/api_op_UpdateTemplateActiveVersion.go @@ -43,8 +43,8 @@ type UpdateTemplateActiveVersionInput struct { // This member is required. TemplateName *string - // The type of channel that the message template is designed for. Valid values are: - // EMAIL, PUSH, SMS, and VOICE. + // The type of channel that the message template is designed for. Valid values + // are: EMAIL, PUSH, SMS, and VOICE. // // This member is required. TemplateType *string diff --git a/service/pinpoint/api_op_UpdateVoiceTemplate.go b/service/pinpoint/api_op_UpdateVoiceTemplate.go index 2b620ecf714..a4581a9818b 100644 --- a/service/pinpoint/api_op_UpdateVoiceTemplate.go +++ b/service/pinpoint/api_op_UpdateVoiceTemplate.go @@ -61,17 +61,13 @@ type UpdateVoiceTemplateInput struct { // the identifier for the latest existing version of the template. This restriction // helps ensure that race conditions don't occur. If you don't specify a value for // this parameter, Amazon Pinpoint does the following: - // - // * For a get operation, - // retrieves information about the active version of the template. - // - // * For an update - // operation, saves the updates to (overwrites) the latest existing version of the - // template, if the create-new-version parameter isn't used or is set to false. - // - // * - // For a delete operation, deletes the template, including all versions of the - // template. + // - For a get operation, retrieves information about the active version of the + // template. + // - For an update operation, saves the updates to (overwrites) the latest + // existing version of the template, if the create-new-version parameter isn't used + // or is set to false. + // - For a delete operation, deletes the template, including all versions of the + // template. Version *string noSmithyDocumentSerde diff --git a/service/pinpoint/types/enums.go b/service/pinpoint/types/enums.go index 70a8b795933..15a2d731da9 100644 --- a/service/pinpoint/types/enums.go +++ b/service/pinpoint/types/enums.go @@ -71,9 +71,9 @@ const ( AlignmentRight Alignment = "RIGHT" ) -// Values returns all known values for Alignment. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Alignment. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Alignment) Values() []Alignment { return []Alignment{ "LEFT", @@ -119,9 +119,9 @@ const ( ButtonActionClose ButtonAction = "CLOSE" ) -// Values returns all known values for ButtonAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ButtonAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ButtonAction) Values() []ButtonAction { return []ButtonAction{ "LINK", @@ -211,9 +211,9 @@ const ( DayOfWeekSunday DayOfWeek = "SUNDAY" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "MONDAY", @@ -343,9 +343,9 @@ const ( FrequencyInAppEvent Frequency = "IN_APP_EVENT" ) -// Values returns all known values for Frequency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Frequency. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Frequency) Values() []Frequency { return []Frequency{ "ONCE", @@ -393,9 +393,9 @@ const ( JobStatusFailed JobStatus = "FAILED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "CREATED", @@ -558,8 +558,8 @@ const ( StatePaused State = "PAUSED" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ @@ -583,9 +583,9 @@ const ( TemplateTypeInapp TemplateType = "INAPP" ) -// Values returns all known values for TemplateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TemplateType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TemplateType) Values() []TemplateType { return []TemplateType{ "EMAIL", diff --git a/service/pinpoint/types/types.go b/service/pinpoint/types/types.go index 636ab8b5bcd..8c41754c663 100644 --- a/service/pinpoint/types/types.go +++ b/service/pinpoint/types/types.go @@ -41,12 +41,12 @@ type Activity struct { // The custom description of the activity. Description *string - // The settings for an email activity. This type of activity sends an email message - // to participants. + // The settings for an email activity. This type of activity sends an email + // message to participants. EMAIL *EmailMessageActivity - // The settings for a holdout activity. This type of activity stops a journey for a - // specified percentage of participants. + // The settings for a holdout activity. This type of activity stops a journey for + // a specified percentage of participants. Holdout *HoldoutActivity // The settings for a multivariate split activity. This type of activity sends @@ -124,8 +124,8 @@ type ActivityResponse struct { // to. TotalEndpointCount int32 - // 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 + // 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 @@ -233,29 +233,24 @@ type ADMMessage struct { // 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. + // - 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 Action // The body of the notification message. Body *string - // 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. + // 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 - // 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 + // 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 @@ -292,9 +287,10 @@ type ADMMessage struct { // view of the push notification. SmallImageIconUrl *string - // 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/. + // 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 // The default message variables to use in the notification message. You can @@ -319,17 +315,12 @@ type AndroidPushNotificationTemplate struct { // The action to occur if a recipient taps a push notification that's based on the // message template. 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. + // - 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 Action // The message body to use in a push notification that's based on the message @@ -390,8 +381,8 @@ type APNSChannelRequest struct { // Specifies whether to enable the APNs channel for the application. Enabled bool - // The private key for the APNs client certificate that you want Amazon Pinpoint to - // use to communicate with APNs. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with APNs. PrivateKey *string // The identifier that's assigned to your Apple developer account team. This @@ -424,8 +415,8 @@ type APNSChannelResponse struct { // The date and time when the APNs channel was enabled. CreationDate *string - // The default authentication method that Amazon Pinpoint uses to authenticate with - // APNs for this channel, key or certificate. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with APNs for this channel, key or certificate. DefaultAuthenticationMethod *string // Specifies whether the APNs channel is enabled for the application. @@ -463,51 +454,35 @@ type APNSChannelResponse struct { type APNSMessage struct { // The type of push notification to send. Valid values are: - // - // * alert - For a - // standard notification that's displayed on recipients' devices and prompts a - // recipient to interact with the notification. - // - // * background - For a silent - // notification that delivers content in the background and isn't displayed on - // recipients' devices. - // - // * complication - For a notification that contains update - // information for an app’s complication timeline. - // - // * fileprovider - For a - // notification that signals changes to a File Provider extension. - // - // * mdm - For a - // notification that tells managed devices to contact the MDM server. - // - // * voip - For - // a notification that provides information about an incoming VoIP call. - // - // Amazon - // Pinpoint specifies this value in the apns-push-type request header when it sends - // the notification message to APNs. If you don't specify a value for this + // - alert - For a standard notification that's displayed on recipients' devices + // and prompts a recipient to interact with the notification. + // - background - For a silent notification that delivers content in the + // background and isn't displayed on recipients' devices. + // - complication - For a notification that contains update information for an + // app’s complication timeline. + // - fileprovider - For a notification that signals changes to a File Provider + // extension. + // - mdm - For a notification that tells managed devices to contact the MDM + // server. + // - voip - For a notification that provides information about an incoming VoIP + // call. + // Amazon Pinpoint specifies this value in the apns-push-type request header when + // it sends the notification message to APNs. If you don't specify a value for this // property, Amazon Pinpoint sets the value to alert or background automatically, // based on the value that you specify for the SilentPush or RawContent property of // the message. For more information about the apns-push-type request header, see - // Sending Notification Requests to APNs - // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) + // Sending Notification Requests to APNs (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) // on the Apple Developer website. APNSPushType *string // 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. + // - 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 Action // The key that indicates whether and how to modify the badge of your app's icon @@ -519,8 +494,8 @@ type APNSMessage struct { // The body of the notification message. Body *string - // 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 + // 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 @@ -531,8 +506,8 @@ type APNSMessage struct { // notification message to APNs. CollapseId *string - // The JSON payload to use for a silent push notification. This payload is added to - // the data.pinpoint.jsonBody object of the notification. + // 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 // The URL of an image or video to display in the push notification. @@ -542,13 +517,11 @@ type APNSMessage struct { // authenticating with APNs, CERTIFICATE or TOKEN. PreferredAuthenticationMethod *string - // 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 + // 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 + // 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, @@ -563,10 +536,8 @@ type APNSMessage struct { // notification, set the value of content-available to 0. If you're sending a // silent (background) notification, set the value of content-available to 1. // Additionally, silent notification payloads can't include the alert, badge, or - // sound keys. For more information, see Generating a Remote Notification - // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification) - // and Pushing Background Updates to Your App - // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) + // sound keys. For more information, see Generating a Remote Notification (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification) + // and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) // on the Apple Developer website. RawContent *string @@ -582,30 +553,28 @@ type APNSMessage struct { // (background) notifications, set the value of content-available to 1. // Additionally, the message payload for a silent notification can't include the // alert, badge, or sound keys. For more information, see Generating a Remote - // Notification - // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification) - // and Pushing Background Updates to Your App - // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) + // Notification (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification) + // and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) // on the Apple Developer website. Apple has indicated that they will throttle // "excessive" background notifications based on current traffic volumes. To // prevent your notifications being throttled, Apple recommends that you send no // more than 3 silent push notifications to each recipient per hour. SilentPush bool - // The key for the sound to play when the recipient receives the push notification. - // The value for 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. + // The key for the sound to play when the recipient receives the push + // notification. The value for 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 // The default message variables to use in the notification message. You can // override these default variables with individual address variables. Substitutions map[string][]string - // 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. + // 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 // The amount of time, in seconds, that APNs should store and attempt to deliver @@ -633,17 +602,12 @@ type APNSPushNotificationTemplate struct { // The action to occur if a recipient taps a push notification that's based on the // message template. 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. + // - 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 Action // The message body to use in push notifications that are based on the message @@ -654,9 +618,9 @@ type APNSPushNotificationTemplate struct { // the message template. MediaUrl *string - // The raw, JSON-formatted string to use as the payload for push notifications that - // are based on the message template. If specified, this value overrides all other - // content for the message template. + // The raw, JSON-formatted string to use as the payload for push notifications + // that are based on the message template. If specified, this value overrides all + // other content for the message template. RawContent *string // The key for the sound to play when the recipient receives a push notification @@ -670,8 +634,8 @@ type APNSPushNotificationTemplate struct { // This title appears above the notification message on a recipient's device. Title *string - // The URL to open in the recipient's default mobile browser, if a recipient taps a - // push notification that's based on the message template and the value of the + // The URL to open in the recipient's default mobile browser, if a recipient taps + // a push notification that's based on the message template and the value of the // Action property is URL. Url *string @@ -698,8 +662,8 @@ type APNSSandboxChannelRequest struct { // Specifies whether to enable the APNs sandbox channel for the application. Enabled bool - // The private key for the APNs client certificate that you want Amazon Pinpoint to - // use to communicate with the APNs sandbox environment. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with the APNs sandbox environment. PrivateKey *string // The identifier that's assigned to your Apple developer account team. This @@ -733,8 +697,8 @@ type APNSSandboxChannelResponse struct { // The date and time when the APNs sandbox channel was enabled. CreationDate *string - // The default authentication method that Amazon Pinpoint uses to authenticate with - // the APNs sandbox environment for this channel, key or certificate. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with the APNs sandbox environment for this channel, key or certificate. DefaultAuthenticationMethod *string // Specifies whether the APNs sandbox channel is enabled for the application. @@ -786,8 +750,8 @@ type APNSVoipChannelRequest struct { // Specifies whether to enable the APNs VoIP channel for the application. Enabled bool - // The private key for the APNs client certificate that you want Amazon Pinpoint to - // use to communicate with APNs. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with APNs. PrivateKey *string // The identifier that's assigned to your Apple developer account team. This @@ -820,8 +784,8 @@ type APNSVoipChannelResponse struct { // The date and time when the APNs VoIP channel was enabled. CreationDate *string - // The default authentication method that Amazon Pinpoint uses to authenticate with - // APNs for this channel, key or certificate. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with APNs for this channel, key or certificate. DefaultAuthenticationMethod *string // Specifies whether the APNs VoIP channel is enabled for the application. @@ -875,8 +839,8 @@ type APNSVoipSandboxChannelRequest struct { // Specifies whether the APNs VoIP sandbox channel is enabled for the application. Enabled bool - // The private key for the APNs client certificate that you want Amazon Pinpoint to - // use to communicate with the APNs sandbox environment. + // The private key for the APNs client certificate that you want Amazon Pinpoint + // to use to communicate with the APNs sandbox environment. PrivateKey *string // The identifier that's assigned to your Apple developer account team. This @@ -910,8 +874,8 @@ type APNSVoipSandboxChannelResponse struct { // The date and time when the APNs VoIP sandbox channel was enabled. CreationDate *string - // The default authentication method that Amazon Pinpoint uses to authenticate with - // the APNs sandbox environment for this channel, key or certificate. + // The default authentication method that Amazon Pinpoint uses to authenticate + // with the APNs sandbox environment for this channel, key or certificate. DefaultAuthenticationMethod *string // Specifies whether the APNs VoIP sandbox channel is enabled for the application. @@ -962,15 +926,15 @@ type ApplicationDateRangeKpiResponse struct { // The name of the metric, also referred to as a key performance indicator (KPI), // that the data was retrieved for. This value describes the associated metric and // consists of two or more terms, which are comprised of lowercase alphanumeric - // characters, separated by a hyphen. For a list of possible values, see the Amazon - // Pinpoint Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // characters, separated by a hyphen. For a list of possible values, see the + // Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string - // An array of objects that contains the results of the query. Each object contains - // the value for the metric and metadata about that value. + // An array of objects that contains the results of the query. Each object + // contains the value for the metric and metadata about that value. // // This member is required. KpiResult *BaseKpiResult @@ -1020,8 +984,8 @@ type ApplicationResponse struct { noSmithyDocumentSerde } -// Provides information about an application, including the default settings for an -// application. +// Provides information about an application, including the default settings for +// an application. type ApplicationSettingsResource struct { // The unique identifier for the application. This identifier is displayed as the @@ -1030,13 +994,13 @@ type ApplicationSettingsResource struct { // This member is required. ApplicationId *string - // The settings for the AWS Lambda function to invoke by default as a code hook for - // campaigns in the application. You can use this hook to customize segments that - // are used by campaigns in the application. + // The settings for the AWS Lambda function to invoke by default as a code hook + // for campaigns in the application. You can use this hook to customize segments + // that are used by campaigns in the application. CampaignHook *CampaignHook - // The date and time, in ISO 8601 format, when the application's settings were last - // modified. + // The date and time, in ISO 8601 format, when the application's settings were + // last modified. LastModifiedDate *string // The default sending limits for campaigns in the application. @@ -1045,22 +1009,16 @@ type ApplicationSettingsResource struct { // The default quiet time for campaigns in the application. Quiet time is a // specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings). - // - // If any of the - // preceding conditions isn't met, the endpoint will receive messages from a - // campaign or journey, even if quiet time is enabled. + // - 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 or journey 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 or journey that has custom quiet time settings). + // If any of the preceding conditions isn't met, the endpoint will receive + // messages from a campaign or journey, even if quiet time is enabled. QuietTime *QuietTime noSmithyDocumentSerde @@ -1091,30 +1049,20 @@ type AttributeDimension struct { Values []string // The type of segment dimension to use. Valid values are: - // - // * INCLUSIVE - endpoints - // that have attributes matching the values are included in the segment. - // - // * - // EXCLUSIVE - endpoints that have attributes matching the values are excluded in - // the segment. - // - // * CONTAINS - endpoints that have attributes' substrings match the - // values are included in the segment. - // - // * BEFORE - endpoints with attributes read - // as ISO_INSTANT datetimes before the value are included in the segment. - // - // * AFTER - // - endpoints with attributes read as ISO_INSTANT datetimes after the value are - // included in the segment. - // - // * ON - endpoints with attributes read as ISO_INSTANT - // dates on the value are included in the segment. Time is ignored in this - // comparison. - // - // * BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes - // between the values are included in the segment. + // - INCLUSIVE - endpoints that have attributes matching the values are included + // in the segment. + // - EXCLUSIVE - endpoints that have attributes matching the values are excluded + // in the segment. + // - CONTAINS - endpoints that have attributes' substrings match the values are + // included in the segment. + // - BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the + // value are included in the segment. + // - AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the + // value are included in the segment. + // - ON - endpoints with attributes read as ISO_INSTANT dates on the value are + // included in the segment. Time is ignored in this comparison. + // - BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between + // the values are included in the segment. AttributeType AttributeType noSmithyDocumentSerde @@ -1131,15 +1079,10 @@ type AttributesResource struct { // The type of attribute or attributes that were removed from the endpoints. Valid // values are: - // - // * endpoint-custom-attributes - Custom attributes that describe - // endpoints. - // - // * endpoint-metric-attributes - Custom metrics that your app reports - // to Amazon Pinpoint for endpoints. - // - // * endpoint-user-attributes - Custom - // attributes that describe users. + // - endpoint-custom-attributes - Custom attributes that describe endpoints. + // - endpoint-metric-attributes - Custom metrics that your app reports to Amazon + // Pinpoint for endpoints. + // - endpoint-user-attributes - Custom attributes that describe users. // // This member is required. AttributeType *string @@ -1151,8 +1094,8 @@ type AttributesResource struct { noSmithyDocumentSerde } -// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an -// application. +// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for +// an application. type BaiduChannelRequest struct { // The API key that you received from the Baidu Cloud Push service to communicate @@ -1201,8 +1144,8 @@ type BaiduChannelResponse struct { // (Not used) This property is retained only for backward compatibility. HasCredential bool - // (Deprecated) An identifier for the Baidu channel. This property is retained only - // for backward compatibility. + // (Deprecated) An identifier for the Baidu channel. This property is retained + // only for backward compatibility. Id *string // Specifies whether the Baidu channel is archived. @@ -1226,24 +1169,19 @@ type BaiduMessage struct { // 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. + // - 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 Action // The body of the notification message. Body *string - // 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 + // 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 @@ -1271,9 +1209,10 @@ type BaiduMessage struct { // view of the push notification. SmallImageIconUrl *string - // 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/. + // 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 // The default message variables to use in the notification message. You can @@ -1299,8 +1238,8 @@ type BaiduMessage struct { // that applies to an application, campaign, or journey. type BaseKpiResult struct { - // An array of objects that provides the results of a query that retrieved the data - // for a standard metric that applies to an application, campaign, or journey. + // An array of objects that provides the results of a query that retrieved the + // data for a standard metric that applies to an application, campaign, or journey. // // This member is required. Rows []ResultRow @@ -1342,15 +1281,15 @@ type CampaignDateRangeKpiResponse struct { // The name of the metric, also referred to as a key performance indicator (KPI), // that the data was retrieved for. This value describes the associated metric and // consists of two or more terms, which are comprised of lowercase alphanumeric - // characters, separated by a hyphen. For a list of possible values, see the Amazon - // Pinpoint Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // characters, separated by a hyphen. For a list of possible values, see the + // Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string - // An array of objects that contains the results of the query. Each object contains - // the value for the metric and metadata about that value. + // An array of objects that contains the results of the query. Each object + // contains the value for the metric and metadata about that value. // // This member is required. KpiResult *BaseKpiResult @@ -1381,8 +1320,8 @@ type CampaignEmailMessage struct { // FromAddress specified for the email channel for the application. FromAddress *string - // The body of the email, in HTML format, for recipients whose email clients render - // HTML content. + // The body of the email, in HTML format, for recipients whose email clients + // render HTML content. HtmlBody *string // The subject line, or title, of the email. @@ -1399,9 +1338,9 @@ type CampaignEventFilter struct { // This member is required. Dimensions *EventDimensions - // 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. + // 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. // // This member is required. FilterType FilterType @@ -1409,8 +1348,8 @@ type CampaignEventFilter struct { noSmithyDocumentSerde } -// Specifies settings for invoking an AWS Lambda function that customizes a segment -// for a campaign. +// Specifies settings for invoking an AWS Lambda function that customizes a +// segment for a campaign. type CampaignHook struct { // The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon @@ -1419,14 +1358,12 @@ type CampaignHook struct { // The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible // values are: - // - // * FILTER - Invoke the function to customize the segment that's used - // by a campaign. - // - // * DELIVERY - (Deprecated) Previously, invoked the function to - // send a campaign through a custom channel. This functionality is not supported - // anymore. To send a campaign through a custom channel, use the - // CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign. + // - FILTER - Invoke the function to customize the segment that's used by a + // campaign. + // - DELIVERY - (Deprecated) Previously, invoked the function to send a campaign + // through a custom channel. This functionality is not supported anymore. To send a + // campaign through a custom channel, use the CustomDeliveryConfiguration and + // CampaignCustomMessage objects of the campaign. Mode Mode // The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over @@ -1454,9 +1391,9 @@ type CampaignInAppMessage struct { noSmithyDocumentSerde } -// For a campaign, specifies limits on the messages that the campaign can send. For -// an application, specifies the default limits for messages that campaigns in the -// application can send. +// For a campaign, specifies limits on the messages that the campaign can send. +// For an application, specifies the default limits for messages that campaigns in +// the application can send. type CampaignLimits struct { // The maximum number of messages that a campaign can send to a single endpoint @@ -1465,9 +1402,9 @@ type CampaignLimits struct { // single endpoint during a 24-hour period. The maximum value is 100. Daily int32 - // 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. + // 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 int32 // The maximum number of messages that a campaign can send each second. For an @@ -1527,8 +1464,8 @@ type CampaignResponse struct { // This member is required. SegmentVersion int32 - // An array of responses, one for each treatment that you defined for the campaign, - // 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 // The delivery configuration settings for sending the campaign through a custom @@ -1546,8 +1483,9 @@ type CampaignResponse struct { // messages from the campaign. HoldoutPercent int32 - // The settings for the AWS Lambda function to use as a code hook for the campaign. - // You can use this hook to customize the segment that's used by the campaign. + // The settings for the AWS Lambda function to use as a code hook for the + // campaign. You can use this hook to customize the segment that's used by the + // campaign. Hook *CampaignHook // Specifies whether the campaign is paused. A paused campaign doesn't run unless @@ -1698,8 +1636,8 @@ type ChannelResponse struct { // an application, including channels that aren't enabled for the application. type ChannelsResponse struct { - // 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. + // 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. // // This member is required. Channels map[string]ChannelResponse @@ -1764,17 +1702,16 @@ type Condition struct { // participants down different paths based on push notification events (such as // Open or Received events), your mobile app has to specify the User ID and // Endpoint ID values. For more information, see Integrating Amazon Pinpoint with -// your application -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) in -// the Amazon Pinpoint Developer Guide. +// your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) +// in the Amazon Pinpoint Developer Guide. type ConditionalSplitActivity struct { // The conditions that define the paths for the activity, and the relationship // between the conditions. Condition *Condition - // The amount of time to wait before determining whether the conditions are met, or - // the date and time when Amazon Pinpoint determines whether the conditions are + // The amount of time to wait before determining whether the conditions are met, + // or the date and time when Amazon Pinpoint determines whether the conditions are // met. EvaluationWaitTime *WaitTime @@ -1840,19 +1777,15 @@ type CreateRecommenderConfigurationShape struct { // name for that attribute. The display name appears in the Attribute finder of the // template editor on the Amazon Pinpoint console. The following restrictions apply // to these names: - // - // * An attribute name must start with a letter or number and it - // can contain up to 50 characters. The characters can be letters, numbers, - // underscores (_), or hyphens (-). Attribute names are case sensitive and must be - // unique. - // - // * An attribute display name must start with a letter or number and it - // can contain up to 25 characters. The characters can be letters, numbers, spaces, - // underscores (_), or hyphens (-). - // - // This object is required if the configuration - // invokes an AWS Lambda function (RecommendationTransformerUri) to process - // recommendation data. Otherwise, don't include this object in your request. + // - An attribute name must start with a letter or number and it can contain up + // to 50 characters. The characters can be letters, numbers, underscores (_), or + // hyphens (-). Attribute names are case sensitive and must be unique. + // - An attribute display name must start with a letter or number and it can + // contain up to 25 characters. The characters can be letters, numbers, spaces, + // underscores (_), or hyphens (-). + // This object is required if the configuration invokes an AWS Lambda function + // (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + // include this object in your request. Attributes map[string]string // A custom description of the configuration for the recommender model. The @@ -1869,17 +1802,14 @@ type CreateRecommenderConfigurationShape struct { // recommender model. This value enables the model to use attribute and event data // that’s specific to a particular endpoint or user in an Amazon Pinpoint // application. Valid values are: - // - // * PINPOINT_ENDPOINT_ID - Associate each user in - // the model with a particular endpoint in Amazon Pinpoint. The data is correlated - // based on endpoint IDs in Amazon Pinpoint. This is the default value. - // - // * - // PINPOINT_USER_ID - Associate each user in the model with a particular user and - // endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon - // Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint - // has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages - // won’t be sent to the user's endpoint. + // - PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular + // endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in + // Amazon Pinpoint. This is the default value. + // - PINPOINT_USER_ID - Associate each user in the model with a particular user + // and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in + // Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon + // Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, + // messages won’t be sent to the user's endpoint. RecommendationProviderIdType *string // The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for @@ -1926,21 +1856,18 @@ type CreateTemplateMessageBody struct { noSmithyDocumentSerde } -// Specifies the delivery configuration settings for sending a campaign or campaign -// treatment through a custom channel. This object is required if you use the -// CampaignCustomMessage object to define the message to send for the campaign or -// campaign treatment. +// Specifies the delivery configuration settings for sending a campaign or +// campaign treatment through a custom channel. This object is required if you use +// the CampaignCustomMessage object to define the message to send for the campaign +// or campaign treatment. type CustomDeliveryConfiguration struct { // The destination to send the campaign or treatment to. This value can be one of // the following: - // - // * The name or Amazon Resource Name (ARN) of an AWS Lambda - // function to invoke to handle delivery of the campaign or treatment. - // - // * The URL - // for a web application or service that supports HTTPS and can receive the - // message. The URL has to be a full URL, including the HTTPS protocol. + // - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke + // to handle delivery of the campaign or treatment. + // - The URL for a web application or service that supports HTTPS and can + // receive the message. The URL has to be a full URL, including the HTTPS protocol. // // This member is required. DeliveryUri *string @@ -1959,18 +1886,15 @@ type CustomMessageActivity struct { // The destination to send the campaign or treatment to. This value can be one of // the following: - // - // * The name or Amazon Resource Name (ARN) of an AWS Lambda - // function to invoke to handle delivery of the campaign or treatment. - // - // * The URL - // for a web application or service that supports HTTPS and can receive the - // message. The URL has to be a full URL, including the HTTPS protocol. + // - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke + // to handle delivery of the campaign or treatment. + // - The URL for a web application or service that supports HTTPS and can + // receive the message. The URL has to be a full URL, including the HTTPS protocol. DeliveryUri *string - // The types of endpoints to send the custom message to. Each valid value maps to a - // type of channel that you can associate with an endpoint by using the ChannelType - // property of an endpoint. + // The types of endpoints to send the custom message to. Each valid value maps to + // a type of channel that you can associate with an endpoint by using the + // ChannelType property of an endpoint. EndpointTypes []EndpointTypesElement // Specifies the message data included in a custom channel message that's sent to @@ -2045,17 +1969,13 @@ type DefaultPushNotificationMessage struct { // 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. + // - 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 Action // The default body of the notification message. @@ -2093,17 +2013,13 @@ type DefaultPushNotificationTemplate struct { // The action to occur if a recipient taps a push notification that's based on the // message template. 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. + // - 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 Action // The message body to use in push notifications that are based on the message @@ -2160,10 +2076,10 @@ type DirectMessageConfiguration struct { // message (DefaultMessage). EmailMessage *EmailMessage - // 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). + // 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 // The default message for the SMS channel. This message overrides the default @@ -2193,8 +2109,7 @@ type EmailChannelRequest struct { // This member is required. Identity *string - // The Amazon SES configuration set - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) + // The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) // that you want to apply to messages that you send through the channel. ConfigurationSet *string @@ -2221,8 +2136,7 @@ type EmailChannelResponse struct { // The unique identifier for the application that the email channel applies to. ApplicationId *string - // The Amazon SES configuration set - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) + // The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) // that's applied to messages that are sent through the channel. ConfigurationSet *string @@ -2239,8 +2153,8 @@ type EmailChannelResponse struct { // (Not used) This property is retained only for backward compatibility. HasCredential bool - // (Deprecated) An identifier for the email channel. This property is retained only - // for backward compatibility. + // (Deprecated) An identifier for the email channel. This property is retained + // only for backward compatibility. Id *string // The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple @@ -2301,12 +2215,12 @@ type EmailMessage struct { noSmithyDocumentSerde } -// Specifies the settings for an email activity in a journey. This type of activity -// sends an email message to participants. +// Specifies the settings for an email activity in a journey. This type of +// activity sends an email message to participants. type EmailMessageActivity struct { - // Specifies the sender address for an email message that's sent to participants in - // the journey. + // Specifies the sender address for an email message that's sent to participants + // in the journey. MessageConfig *JourneyEmailMessage // The unique identifier for the next activity to perform, after the message is @@ -2342,16 +2256,16 @@ type EmailTemplateRequest struct { // variables and values. DefaultSubstitutions *string - // The message body, in HTML format, to use in email messages that are based on the - // message template. We recommend using HTML format for email clients that render - // HTML content. You can include links, formatted text, and more in an HTML + // The message body, in HTML format, to use in email messages that are based on + // the message template. We recommend using HTML format for email clients that + // render HTML content. You can include links, formatted text, and more in an HTML // message. HtmlPart *string - // The unique identifier for the recommender model to use for the message template. - // Amazon Pinpoint uses this value to determine how to retrieve and process data - // from a recommender model when it sends messages that use the template, if the - // template contains message variables for recommendation data. + // The unique identifier for the recommender model to use for the message + // template. Amazon Pinpoint uses this value to determine how to retrieve and + // process data from a recommender model when it sends messages that use the + // template, if the template contains message variables for recommendation data. RecommenderId *string // The subject line, or title, to use in email messages that are based on the @@ -2441,8 +2355,8 @@ type EmailTemplateResponse struct { noSmithyDocumentSerde } -// Specifies an endpoint to create or update and the settings and attributes to set -// or change for the endpoint. +// Specifies an endpoint to create or update and the settings and attributes to +// set or change for the endpoint. type EndpointBatchItem struct { // The destination address for messages or push notifications that you send to the @@ -2524,15 +2438,15 @@ type EndpointBatchRequest struct { noSmithyDocumentSerde } -// Specifies demographic information about an endpoint, such as the applicable time -// zone and platform. +// Specifies demographic information about an endpoint, such as the applicable +// time zone and platform. type EndpointDemographic struct { // The version of the app that's associated with the endpoint. AppVersion *string - // 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. + // 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 // The manufacturer of the endpoint device, such as apple or samsung. @@ -2561,8 +2475,8 @@ type EndpointDemographic struct { // endpoint. type EndpointItemResponse struct { - // The custom message that's returned in the response as a result of processing the - // endpoint data. + // The custom message that's returned in the response as a result of processing + // the endpoint data. Message *string // The status code that's returned in the response as a result of processing the @@ -2603,33 +2517,20 @@ type EndpointLocation struct { type EndpointMessageResult struct { // 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 won't attempt to send the message again. - // - // * 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. + // - 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 won't + // attempt to send the message again. + // - 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. // // This member is required. DeliveryStatus DeliveryStatus @@ -2822,8 +2723,8 @@ type EndpointSendConfiguration struct { // map take precedence over all other variables. Substitutions map[string][]string - // The title or subject line of the message. If specified, this value overrides the - // default message title or subject line. + // The title or subject line of the message. If specified, this value overrides + // the default message title or subject line. TitleOverride *string noSmithyDocumentSerde @@ -2902,8 +2803,8 @@ type Event struct { noSmithyDocumentSerde } -// Specifies the conditions to evaluate for an event that applies to an activity in -// a journey. +// Specifies the conditions to evaluate for an event that applies to an activity +// in a journey. type EventCondition struct { // The dimensions for the event filter to use for the activity. @@ -2929,13 +2830,12 @@ type EventDimensions struct { // activity to be performed. This can be a standard event that Amazon Pinpoint // generates, such as _email.delivered. For campaigns, this can also be a custom // event that's specific to your application. For information about standard - // events, see Streaming Amazon Pinpoint Events - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) + // events, see Streaming Amazon Pinpoint Events (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) // in the Amazon Pinpoint Developer Guide. EventType *SetDimension - // One or more custom metrics that your application reports to Amazon Pinpoint. You - // can use these metrics as selection criteria when you create an event filter. + // One or more custom metrics that your application reports to Amazon Pinpoint. + // You can use these metrics as selection criteria when you create an event filter. Metrics map[string]MetricDimension noSmithyDocumentSerde @@ -2951,8 +2851,8 @@ type EventFilter struct { // This member is required. Dimensions *EventDimensions - // The type of event that causes the campaign to be sent or the journey activity to - // be performed. Valid values are: SYSTEM, sends the campaign or performs the + // The type of event that causes the campaign to be sent or the journey activity + // to be performed. Valid values are: SYSTEM, sends the campaign or performs the // activity when a system event occurs; and, ENDPOINT, sends the campaign or // performs the activity when an endpoint event (Events resource) occurs. // @@ -3031,8 +2931,8 @@ type EventStartCondition struct { noSmithyDocumentSerde } -// Specifies settings for publishing event data to an Amazon Kinesis data stream or -// an Amazon Kinesis Data Firehose delivery stream. +// Specifies settings for publishing event data to an Amazon Kinesis data stream +// or an Amazon Kinesis Data Firehose delivery stream. type EventStream struct { // The unique identifier for the application to publish event data for. @@ -3056,8 +2956,8 @@ type EventStream struct { // This member is required. RoleArn *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 + // (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 @@ -3090,9 +2990,9 @@ type ExportJobRequest struct { // This member is required. S3UrlPrefix *string - // 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. + // 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 // The version of the segment to export endpoint definitions from, if specified. @@ -3101,9 +3001,9 @@ type ExportJobRequest struct { noSmithyDocumentSerde } -// 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 +// 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 { @@ -3122,9 +3022,9 @@ type ExportJobResource struct { // This member is required. S3UrlPrefix *string - // 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. + // 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 // The version of the segment that the endpoint definitions were exported from. @@ -3159,8 +3059,8 @@ type ExportJobResponse struct { // This member is required. Id *string - // 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. + // 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. // // This member is required. JobStatus JobStatus @@ -3224,8 +3124,8 @@ type ExportJobsResponse struct { // Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. type GCMChannelRequest struct { - // The Web API Key, also referred to as an API_KEY or server key, that you received - // from Google to communicate with Google services. + // The Web API Key, also referred to as an API_KEY or server key, that you + // received from Google to communicate with Google services. // // This member is required. ApiKey *string @@ -3242,8 +3142,8 @@ type GCMChannelRequest struct { // (GCM), service. type GCMChannelResponse struct { - // The Web API Key, also referred to as an API_KEY or server key, that you received - // from Google to communicate with Google services. + // The Web API Key, also referred to as an API_KEY or server key, that you + // received from Google to communicate with Google services. // // This member is required. Credential *string @@ -3293,32 +3193,27 @@ type GCMMessage struct { // 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. + // - 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 Action // The body of the notification message. Body *string - // 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 + // 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 - // 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 + // 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 @@ -3334,11 +3229,9 @@ type GCMMessage struct { // 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 + // 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. @@ -3362,17 +3255,18 @@ type GCMMessage struct { // view of the push notification. SmallImageIconUrl *string - // 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/. + // 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 // The default message variables to use in the notification message. You can // override the default variables with individual address variables. Substitutions map[string][]string - // 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 + // 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. @@ -3474,8 +3368,8 @@ type ImportJobRequest struct { // endpoint definitions are imported. DefineSegment bool - // (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 + // (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. @@ -3496,10 +3390,10 @@ type ImportJobRequest struct { noSmithyDocumentSerde } -// 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. +// 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 { // The format of the files that contain the endpoint definitions to import. Valid @@ -3533,8 +3427,8 @@ type ImportJobResource struct { // when the endpoint definitions are imported. DefineSegment bool - // (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 + // (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. @@ -3581,8 +3475,8 @@ type ImportJobResponse struct { // This member is required. Id *string - // 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. + // 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. // // This member is required. JobStatus JobStatus @@ -3644,8 +3538,8 @@ type ImportJobsResponse struct { // Schedule of the campaign. type InAppCampaignSchedule struct { - // The scheduled time after which the in-app message should not be shown. Timestamp - // is in ISO 8601 format. + // The scheduled time after which the in-app message should not be shown. + // Timestamp is in ISO 8601 format. EndDate *string // The event filter the SDK has to use to show the in-app message in the @@ -3718,8 +3612,8 @@ type InAppMessageCampaign struct { // Campaign id of the corresponding campaign. CampaignId *string - // Daily cap which controls the number of times any in-app messages can be shown to - // the endpoint during a day. + // Daily cap which controls the number of times any in-app messages can be shown + // to the endpoint during a day. DailyCap int32 // In-app message content with all fields required for rendering an in-app message. @@ -3731,8 +3625,8 @@ type InAppMessageCampaign struct { // Schedule of the campaign. Schedule *InAppCampaignSchedule - // Session cap which controls the number of times an in-app message can be shown to - // the endpoint during an application session. + // Session cap which controls the number of times an in-app message can be shown + // to the endpoint during an application session. SessionCap int32 // Total cap which controls the number of times an in-app message can be shown to @@ -3935,15 +3829,15 @@ type JourneyDateRangeKpiResponse struct { // The name of the metric, also referred to as a key performance indicator (KPI), // that the data was retrieved for. This value describes the associated metric and // consists of two or more terms, which are comprised of lowercase alphanumeric - // characters, separated by a hyphen. For a list of possible values, see the Amazon - // Pinpoint Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // characters, separated by a hyphen. For a list of possible values, see the + // Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. KpiName *string - // An array of objects that contains the results of the query. Each object contains - // the value for the metric and metadata about that value. + // An array of objects that contains the results of the query. Each object + // contains the value for the metric and metadata about that value. // // This member is required. KpiResult *BaseKpiResult @@ -3962,8 +3856,8 @@ type JourneyDateRangeKpiResponse struct { noSmithyDocumentSerde } -// Specifies the "From" address for an email message that's sent to participants in -// a journey. +// Specifies the "From" address for an email message that's sent to participants +// in a journey. type JourneyEmailMessage struct { // The verified email address to send the email message from. The default address @@ -3973,35 +3867,26 @@ type JourneyEmailMessage struct { noSmithyDocumentSerde } -// Provides the results of a query that retrieved the data for a standard execution -// metric that applies to a journey activity, and provides information about that -// query. +// Provides the results of a query that retrieved the data for a standard +// execution metric that applies to a journey activity, and provides information +// about that query. type JourneyExecutionActivityMetricsResponse struct { // The type of activity that the metric applies to. Possible values are: - // - // * - // CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends - // participants down one of two paths in a journey. - // - // * HOLDOUT - For a holdout - // activity, which is an activity that stops a journey for a specified percentage - // of participants. - // - // * MESSAGE - For an email activity, which is an activity that - // sends an email message to participants. - // - // * MULTI_CONDITIONAL_SPLIT - For a - // multivariate split activity, which is an activity that sends participants down - // one of as many as five paths in a journey. - // - // * RANDOM_SPLIT - For a random split - // activity, which is an activity that sends specified percentages of participants - // down one of as many as five paths in a journey. - // - // * WAIT - For a wait activity, - // which is an activity that waits for a certain amount of time or until a specific - // date and time before moving participants to the next activity in a journey. + // - CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that + // sends participants down one of two paths in a journey. + // - HOLDOUT - For a holdout activity, which is an activity that stops a journey + // for a specified percentage of participants. + // - MESSAGE - For an email activity, which is an activity that sends an email + // message to participants. + // - MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an + // activity that sends participants down one of as many as five paths in a journey. + // - RANDOM_SPLIT - For a random split activity, which is an activity that sends + // specified percentages of participants down one of as many as five paths in a + // journey. + // - WAIT - For a wait activity, which is an activity that waits for a certain + // amount of time or until a specific date and time before moving participants to + // the next activity in a journey. // // This member is required. ActivityType *string @@ -4027,10 +3912,10 @@ type JourneyExecutionActivityMetricsResponse struct { // This member is required. LastEvaluatedTime *string - // A JSON object that contains the results of the query. The results vary depending - // on the type of activity (ActivityType). For information about the structure and - // contents of the results, see the Amazon Pinpoint Developer Guide - // (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). + // A JSON object that contains the results of the query. The results vary + // depending on the type of activity (ActivityType). For information about the + // structure and contents of the results, see the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. Metrics map[string]string @@ -4038,8 +3923,9 @@ type JourneyExecutionActivityMetricsResponse struct { noSmithyDocumentSerde } -// Provides the results of a query that retrieved the data for a standard execution -// metric that applies to a journey, and provides information about that query. +// Provides the results of a query that retrieved the data for a standard +// execution metric that applies to a journey, and provides information about that +// query. type JourneyExecutionMetricsResponse struct { // The unique identifier for the application that the metric applies to. @@ -4059,8 +3945,8 @@ type JourneyExecutionMetricsResponse struct { LastEvaluatedTime *string // A JSON object that contains the results of the query. For information about the - // structure and contents of the results, see the Amazon Pinpoint Developer Guide - // (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html). + // structure and contents of the results, see the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html) + // . // // This member is required. Metrics map[string]string @@ -4068,12 +3954,12 @@ type JourneyExecutionMetricsResponse struct { noSmithyDocumentSerde } -// Specifies limits on the messages that a journey can send and the number of times -// participants can enter a journey. +// Specifies limits on the messages that a journey can send and the number of +// times participants can enter a journey. type JourneyLimits struct { - // The maximum number of messages that the journey can send to a single participant - // during a 24-hour period. The maximum value is 100. + // The maximum number of messages that the journey can send to a single + // participant during a 24-hour period. The maximum value is 100. DailyCap int32 // The maximum number of times that a participant can enter the journey. The @@ -4081,8 +3967,8 @@ type JourneyLimits struct { // number of times, set this value to 0. EndpointReentryCap int32 - // Minimum time that must pass before an endpoint can re-enter a given journey. The - // duration should use an ISO 8601 format, such as PT1H. + // Minimum time that must pass before an endpoint can re-enter a given journey. + // The duration should use an ISO 8601 format, such as PT1H. EndpointReentryInterval *string // The maximum number of messages that the journey can send each second. @@ -4131,8 +4017,8 @@ type JourneyResponse struct { // for an activity and the value is the settings for the activity. Activities map[string]Activity - // The time when journey will stop sending messages. QuietTime should be configured - // first and SendingSchedule should be set to true. + // The time when journey will stop sending messages. QuietTime should be + // configured first and SendingSchedule should be set to true. ClosedDays *ClosedDays // The date, in ISO 8601 format, when the journey was created. @@ -4159,21 +4045,14 @@ type JourneyResponse struct { // The quiet time settings for the journey. Quiet time is a specific time range // when a journey doesn't send messages to participants, if all the following // conditions are met: - // - // * The EndpointDemographic.Timezone property of the endpoint - // for the participant is set to a valid value. - // - // * The current time in the - // participant's time zone is later than or equal to the time specified by the - // QuietTime.Start property for the journey. - // - // * The current time in the - // participant's time zone is earlier than or equal to the time specified by the - // QuietTime.End property for the journey. - // - // If any of the preceding conditions - // isn't met, the participant will receive messages from the journey, even if quiet - // time is enabled. + // - The EndpointDemographic.Timezone property of the endpoint for the + // participant is set to a valid value. + // - The current time in the participant's time zone is later than or equal to + // the time specified by the QuietTime.Start property for the journey. + // - The current time in the participant's time zone is earlier than or equal to + // the time specified by the QuietTime.End property for the journey. + // If any of the preceding conditions isn't met, the participant will receive + // messages from the journey, even if quiet time is enabled. QuietTime *QuietTime // The frequency with which Amazon Pinpoint evaluates segment and event data for @@ -4197,31 +4076,23 @@ type JourneyResponse struct { StartCondition *StartCondition // The current status of the journey. Possible values are: - // - // * DRAFT - The journey - // is being developed and hasn't been published yet. - // - // * ACTIVE - The journey has - // been developed and published. Depending on the journey's schedule, the journey - // may currently be running or scheduled to start running at a later time. If a - // journey's status is ACTIVE, you can't add, change, or remove activities from - // it. - // - // * COMPLETED - The journey has been published and has finished running. All - // participants have entered the journey and no participants are waiting to - // complete the journey or any activities in the journey. - // - // * CANCELLED - The - // journey has been stopped. If a journey's status is CANCELLED, you can't add, - // change, or remove activities or segment settings from the journey. - // - // * CLOSED - - // The journey has been published and has started running. It may have also passed - // its scheduled end time, or passed its scheduled start time and a refresh - // frequency hasn't been specified for it. If a journey's status is CLOSED, you - // can't add participants to it, and no existing participants can enter the journey - // for the first time. However, any existing participants who are currently waiting - // to start an activity may continue the journey. + // - DRAFT - The journey is being developed and hasn't been published yet. + // - ACTIVE - The journey has been developed and published. Depending on the + // journey's schedule, the journey may currently be running or scheduled to start + // running at a later time. If a journey's status is ACTIVE, you can't add, change, + // or remove activities from it. + // - COMPLETED - The journey has been published and has finished running. All + // participants have entered the journey and no participants are waiting to + // complete the journey or any activities in the journey. + // - CANCELLED - The journey has been stopped. If a journey's status is + // CANCELLED, you can't add, change, or remove activities or segment settings from + // the journey. + // - CLOSED - The journey has been published and has started running. It may + // have also passed its scheduled end time, or passed its scheduled start time and + // a refresh frequency hasn't been specified for it. If a journey's status is + // CLOSED, you can't add participants to it, and no existing participants can enter + // the journey for the first time. However, any existing participants who are + // currently waiting to start an activity may continue the journey. State State // This object is not used or supported. @@ -4275,8 +4146,7 @@ type JourneySMSMessage struct { // 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. For more information, see - // Supported Countries and Regions - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) + // Supported Countries and Regions (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) // in the Amazon Pinpoint User Guide. SenderId *string @@ -4287,8 +4157,8 @@ type JourneySMSMessage struct { noSmithyDocumentSerde } -// Provides information about the status, configuration, and other settings for all -// the journeys that are associated with an application. +// Provides information about the status, configuration, and other settings for +// all the journeys that are associated with an application. type JourneysResponse struct { // An array of responses, one for each journey that's associated with the @@ -4349,16 +4219,12 @@ type Message struct { // 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. + // - 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 Action // The body of the notification message. The maximum number of characters is 200. @@ -4404,8 +4270,8 @@ type Message struct { // The title to display above the notification message on a recipient's device. Title *string - // 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. + // 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 noSmithyDocumentSerde @@ -4477,11 +4343,9 @@ type MessageRequest struct { MessageConfiguration *DirectMessageConfiguration // A map of key-value pairs, where each key is an address and each value is an - // AddressConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) + // AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) // object. An address can be a push notification token, a phone number, or an email - // address. You can use an AddressConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) + // address. You can use an AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) // object to tailor the message for an address by specifying settings such as // content overrides and message variables. Addresses map[string]AddressConfiguration @@ -4492,10 +4356,8 @@ type MessageRequest struct { Context map[string]string // A map of key-value pairs, where each key is an endpoint ID and each value is an - // EndpointSendConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) - // object. You can use an EndpointSendConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) + // EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) + // object. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) // object to tailor the message for an endpoint by specifying settings such as // content overrides and message variables. Endpoints map[string]EndpointSendConfiguration @@ -4539,33 +4401,20 @@ type MessageResponse struct { type MessageResult struct { // 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 won't attempt to send the message - // again. - // - // * 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. + // - 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 won't + // attempt to send the message again. + // - 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. // // This member is required. DeliveryStatus DeliveryStatus @@ -4621,15 +4470,14 @@ type MultiConditionalBranch struct { noSmithyDocumentSerde } -// Specifies the settings for a multivariate split activity in a journey. This type -// of activity sends participants down one of as many as five paths (including a -// default Else path) in a journey, based on conditions that you specify. To create -// multivariate split activities that send participants down different paths based -// on push notification events (such as Open or Received events), your mobile app -// has to specify the User ID and Endpoint ID values. For more information, see -// Integrating Amazon Pinpoint with your application -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) in -// the Amazon Pinpoint Developer Guide. +// Specifies the settings for a multivariate split activity in a journey. This +// type of activity sends participants down one of as many as five paths (including +// a default Else path) in a journey, based on conditions that you specify. To +// create multivariate split activities that send participants down different paths +// based on push notification events (such as Open or Received events), your mobile +// app has to specify the User ID and Endpoint ID values. For more information, see +// Integrating Amazon Pinpoint with your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html) +// in the Amazon Pinpoint Developer Guide. type MultiConditionalSplitActivity struct { // The paths for the activity, including the conditions for entering each path and @@ -4677,8 +4525,8 @@ type NumberValidateResponse struct { // number was originally registered. CleansedPhoneNumberE164 *string - // The cleansed phone number, in the format for the location where the phone number - // was originally registered. + // The cleansed phone number, in the format for the location where the phone + // number was originally registered. CleansedPhoneNumberNational *string // The name of the country or region where the phone number was originally @@ -4689,8 +4537,8 @@ type NumberValidateResponse struct { // where the phone number was originally registered. CountryCodeIso2 *string - // The numeric code for the country or region where the phone number was originally - // registered. + // The numeric code for the country or region where the phone number was + // originally registered. CountryCodeNumeric *string // The name of the county where the phone number was originally registered. @@ -4769,8 +4617,8 @@ type OverrideButtonConfiguration struct { noSmithyDocumentSerde } -// Specifies the properties and attributes of an endpoint that's associated with an -// event. +// Specifies the properties and attributes of an endpoint that's associated with +// an event. type PublicEndpoint struct { // The unique identifier for the recipient, such as a device token, email address, @@ -4837,8 +4685,8 @@ type PushMessageActivity struct { // sent. NextActivity *string - // The name of the push notification template to use for the message. If specified, - // this value must match the name of an existing message template. + // The name of the push notification template to use for the message. If + // specified, this value must match the name of an existing message template. TemplateName *string // The unique identifier for the version of the push notification template to use @@ -4890,10 +4738,10 @@ type PushNotificationTemplateRequest struct { // for push notification channels (DefaultPushNotificationTemplate). GCM *AndroidPushNotificationTemplate - // The unique identifier for the recommender model to use for the message template. - // Amazon Pinpoint uses this value to determine how to retrieve and process data - // from a recommender model when it sends messages that use the template, if the - // template contains message variables for recommendation data. + // The unique identifier for the recommender model to use for the message + // template. Amazon Pinpoint uses this value to determine how to retrieve and + // process data from a recommender model when it sends messages that use the + // template, if the template contains message variables for recommendation data. RecommenderId *string // A string-to-string map of key-value pairs that defines the tags to associate @@ -4995,8 +4843,8 @@ type QuietTime struct { // or 14:30 to represent 2:30 PM. End *string - // 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 + // 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 @@ -5036,8 +4884,8 @@ type RandomSplitEntry struct { // Specifies the contents of an email message, represented as a raw MIME message. type RawEmail struct { - // The email message, represented as a raw MIME message. The entire message must be - // base64 encoded. + // The email message, represented as a raw MIME message. The entire message must + // be base64 encoded. Data []byte noSmithyDocumentSerde @@ -5063,8 +4911,8 @@ type RecencyDimension struct { noSmithyDocumentSerde } -// Provides information about Amazon Pinpoint configuration settings for retrieving -// and processing data from a recommender model. +// Provides information about Amazon Pinpoint configuration settings for +// retrieving and processing data from a recommender model. type RecommenderConfigurationResponse struct { // The date, in extended ISO 8601 format, when the configuration was created for @@ -5118,17 +4966,14 @@ type RecommenderConfigurationResponse struct { // recommender model. This value enables the model to use attribute and event data // that’s specific to a particular endpoint or user in an Amazon Pinpoint // application. Possible values are: - // - // * PINPOINT_ENDPOINT_ID - Each user in the - // model is associated with a particular endpoint in Amazon Pinpoint. The data is - // correlated based on endpoint IDs in Amazon Pinpoint. This is the default - // value. - // - // * PINPOINT_USER_ID - Each user in the model is associated with a - // particular user and endpoint in Amazon Pinpoint. The data is correlated based on - // user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition - // in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. - // Otherwise, messages won’t be sent to the user's endpoint. + // - PINPOINT_ENDPOINT_ID - Each user in the model is associated with a + // particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint + // IDs in Amazon Pinpoint. This is the default value. + // - PINPOINT_USER_ID - Each user in the model is associated with a particular + // user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs + // in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon + // Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, + // messages won’t be sent to the user's endpoint. RecommendationProviderIdType *string // The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon @@ -5228,20 +5073,14 @@ type Schedule struct { // 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. + // - 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 // The starting UTC offset for the campaign schedule, if the value of the @@ -5255,8 +5094,8 @@ type Schedule struct { noSmithyDocumentSerde } -// Specifies dimension settings for including or excluding endpoints from a segment -// based on how recently an endpoint was active. +// Specifies dimension settings for including or excluding endpoints from a +// segment based on how recently an endpoint was active. type SegmentBehaviors struct { // The dimension settings that are based on how recently an endpoint was active. @@ -5348,9 +5187,9 @@ type SegmentGroup struct { // is based on all, any, or none of the base segments. SourceType SourceType - // 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. + // 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 Type noSmithyDocumentSerde @@ -5364,8 +5203,8 @@ type SegmentGroupList struct { // segment groups for the segment. Groups []SegmentGroup - // Specifies how to handle multiple segment groups for the segment. For example, if - // the segment includes three segment groups, whether the resulting segment + // 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 Include @@ -5376,8 +5215,8 @@ type SegmentGroupList struct { // is a job that creates a user segment by importing endpoint definitions. type SegmentImportResource struct { - // (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 + // (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. @@ -5405,8 +5244,8 @@ type SegmentImportResource struct { // This member is required. S3Url *string - // The number of endpoint definitions that were imported successfully to create the - // segment. + // The number of endpoint definitions that were imported successfully to create + // the segment. // // This member is required. Size int32 @@ -5469,15 +5308,12 @@ type SegmentResponse struct { Id *string // 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. + // - 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. // // This member is required. SegmentType SegmentType @@ -5589,10 +5425,8 @@ type SendUsersMessageRequest struct { // This member is required. MessageConfiguration *DirectMessageConfiguration - // A map that associates user IDs with EndpointSendConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) - // objects. You can use an EndpointSendConfiguration - // (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) + // A map that associates user IDs with EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) + // objects. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) // object to tailor the message for a user by specifying settings such as content // overrides and message variables. // @@ -5626,9 +5460,9 @@ type SendUsersMessageResponse struct { // The unique identifier that was assigned to the message request. RequestId *string - // 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 + // 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 @@ -5884,10 +5718,10 @@ type SMSTemplateRequest struct { // variables and values. DefaultSubstitutions *string - // The unique identifier for the recommender model to use for the message template. - // Amazon Pinpoint uses this value to determine how to retrieve and process data - // from a recommender model when it sends messages that use the template, if the - // template contains message variables for recommendation data. + // The unique identifier for the recommender model to use for the message + // template. Amazon Pinpoint uses this value to determine how to retrieve and + // process data from a recommender model when it sends messages that use the + // template, if the template contains message variables for recommendation data. RecommenderId *string // A string-to-string map of key-value pairs that defines the tags to associate @@ -6062,8 +5896,8 @@ type TemplateCreateMessageBody struct { noSmithyDocumentSerde } -// Provides information about a message template that's associated with your Amazon -// Pinpoint account. +// Provides information about a message template that's associated with your +// Amazon Pinpoint account. type TemplateResponse struct { // The date, in ISO 8601 format, when the message template was created. @@ -6127,9 +5961,9 @@ type TemplateResponse struct { // your Amazon Pinpoint account. type TemplatesResponse struct { - // An array of responses, one for each message template that's associated with your - // Amazon Pinpoint account and meets any filter criteria that you specified in the - // request. + // An array of responses, one for each message template that's associated with + // your Amazon Pinpoint account and meets any filter criteria that you specified in + // the request. // // This member is required. Item []TemplateResponse @@ -6192,8 +6026,8 @@ type TemplateVersionsResponse struct { // This member is required. Item []TemplateVersionResponse - // The message that's returned from the API for the request to retrieve information - // about all the versions of the message template. + // The message that's returned from the API for the request to retrieve + // information about all the versions of the message template. Message *string // The string to use in a subsequent request to get the next page of results in a @@ -6207,8 +6041,8 @@ type TemplateVersionsResponse struct { noSmithyDocumentSerde } -// 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. +// 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 { // The unique identifier for the treatment. @@ -6288,19 +6122,15 @@ type UpdateRecommenderConfigurationShape struct { // name for that attribute. The display name appears in the Attribute finder of the // template editor on the Amazon Pinpoint console. The following restrictions apply // to these names: - // - // * An attribute name must start with a letter or number and it - // can contain up to 50 characters. The characters can be letters, numbers, - // underscores (_), or hyphens (-). Attribute names are case sensitive and must be - // unique. - // - // * An attribute display name must start with a letter or number and it - // can contain up to 25 characters. The characters can be letters, numbers, spaces, - // underscores (_), or hyphens (-). - // - // This object is required if the configuration - // invokes an AWS Lambda function (RecommendationTransformerUri) to process - // recommendation data. Otherwise, don't include this object in your request. + // - An attribute name must start with a letter or number and it can contain up + // to 50 characters. The characters can be letters, numbers, underscores (_), or + // hyphens (-). Attribute names are case sensitive and must be unique. + // - An attribute display name must start with a letter or number and it can + // contain up to 25 characters. The characters can be letters, numbers, spaces, + // underscores (_), or hyphens (-). + // This object is required if the configuration invokes an AWS Lambda function + // (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + // include this object in your request. Attributes map[string]string // A custom description of the configuration for the recommender model. The @@ -6317,17 +6147,14 @@ type UpdateRecommenderConfigurationShape struct { // recommender model. This value enables the model to use attribute and event data // that’s specific to a particular endpoint or user in an Amazon Pinpoint // application. Valid values are: - // - // * PINPOINT_ENDPOINT_ID - Associate each user in - // the model with a particular endpoint in Amazon Pinpoint. The data is correlated - // based on endpoint IDs in Amazon Pinpoint. This is the default value. - // - // * - // PINPOINT_USER_ID - Associate each user in the model with a particular user and - // endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon - // Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint - // has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages - // won’t be sent to the user's endpoint. + // - PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular + // endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in + // Amazon Pinpoint. This is the default value. + // - PINPOINT_USER_ID - Associate each user in the model with a particular user + // and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in + // Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon + // Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, + // messages won’t be sent to the user's endpoint. RecommendationProviderIdType *string // The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for @@ -6419,8 +6246,8 @@ type VoiceChannelResponse struct { // (Not used) This property is retained only for backward compatibility. HasCredential bool - // (Deprecated) An identifier for the voice channel. This property is retained only - // for backward compatibility. + // (Deprecated) An identifier for the voice channel. This property is retained + // only for backward compatibility. Id *string // Specifies whether the voice channel is archived. @@ -6447,8 +6274,8 @@ type VoiceMessage struct { // The code for the language to use when synthesizing the text of the message // script. For a list of supported languages and the code for each one, see the - // Amazon Polly Developer Guide - // (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) + // . LanguageCode *string // The long code to send the voice message from. This value should be one of the @@ -6462,8 +6289,8 @@ type VoiceMessage struct { Substitutions map[string][]string // The name of the voice to use when delivering the message. For a list of - // supported voices, see the Amazon Polly Developer Guide - // (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // supported voices, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) + // . VoiceId *string noSmithyDocumentSerde @@ -6487,8 +6314,8 @@ type VoiceTemplateRequest struct { // The code for the language to use when synthesizing the text of the script in // messages that are based on the message template. For a list of supported - // languages and the code for each one, see the Amazon Polly Developer Guide - // (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // languages and the code for each one, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) + // . LanguageCode *string // A string-to-string map of key-value pairs that defines the tags to associate @@ -6500,8 +6327,8 @@ type VoiceTemplateRequest struct { TemplateDescription *string // The name of the voice to use when delivering messages that are based on the - // message template. For a list of supported voices, see the Amazon Polly Developer - // Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // message template. For a list of supported voices, see the Amazon Polly + // Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) . VoiceId *string noSmithyDocumentSerde @@ -6547,8 +6374,8 @@ type VoiceTemplateResponse struct { // The code for the language that's used when synthesizing the text of the script // in messages that are based on the message template. For a list of supported - // languages and the code for each one, see the Amazon Polly Developer Guide - // (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // languages and the code for each one, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) + // . LanguageCode *string // A string-to-string map of key-value pairs that identifies the tags that are @@ -6564,9 +6391,9 @@ type VoiceTemplateResponse struct { // parameter in your request. Version *string - // The name of the voice that's used when delivering messages that are based on the - // message template. For a list of supported voices, see the Amazon Polly Developer - // Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). + // The name of the voice that's used when delivering messages that are based on + // the message template. For a list of supported voices, see the Amazon Polly + // Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) . VoiceId *string noSmithyDocumentSerde @@ -6593,9 +6420,9 @@ type WaitActivity struct { // participants to the next activity in a journey. type WaitTime struct { - // The amount of time to wait, as a duration in ISO 8601 format, before determining - // whether the activity's conditions have been met or moving participants to the - // next activity in the journey. + // The amount of time to wait, as a duration in ISO 8601 format, before + // determining whether the activity's conditions have been met or moving + // participants to the next activity in the journey. WaitFor *string // The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether @@ -6609,11 +6436,11 @@ type WaitTime struct { // Specifies the default settings for an application. type WriteApplicationSettingsRequest struct { - // The settings for the AWS Lambda function to invoke by default as a code hook for - // campaigns in the application. You can use this hook to customize segments that - // are used by campaigns in the application. To override these settings and define - // custom settings for a specific campaign, use the CampaignHook object of the - // Campaign resource. + // The settings for the AWS Lambda function to invoke by default as a code hook + // for campaigns in the application. You can use this hook to customize segments + // that are used by campaigns in the application. To override these settings and + // define custom settings for a specific campaign, use the CampaignHook object of + // the Campaign resource. CampaignHook *CampaignHook // Specifies whether to enable application-related alarms in Amazon CloudWatch. @@ -6629,25 +6456,19 @@ type WriteApplicationSettingsRequest struct { // The default quiet time for campaigns in the application. Quiet time is a // specific time range when messages aren't sent 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 or journey 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 or journey that has custom quiet time settings). - // - // If any of the - // preceding conditions isn't met, the endpoint will receive messages from a - // campaign or journey, even if quiet time is enabled. To override the default - // quiet time settings for a specific campaign or journey, use the Campaign - // resource or the Journey resource to define a custom quiet time for the campaign - // or journey. + // - 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 or journey 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 or journey that has custom quiet time settings). + // If any of the preceding conditions isn't met, the endpoint will receive + // messages from a campaign or journey, even if quiet time is enabled. To override + // the default quiet time settings for a specific campaign or journey, use the + // Campaign resource or the Journey resource to define a custom quiet time for the + // campaign or journey. QuietTime *QuietTime noSmithyDocumentSerde @@ -6723,8 +6544,8 @@ type WriteCampaignRequest struct { noSmithyDocumentSerde } -// 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 +// 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 { @@ -6750,9 +6571,9 @@ type WriteEventStream struct { // Specifies the configuration and other settings for a journey. type WriteJourneyRequest struct { - // The name of the journey. A journey name can contain a maximum of 150 characters. - // The characters can be alphanumeric characters or symbols, such as underscores - // (_) or hyphens (-). A journey name can't contain any spaces. + // The name of the journey. A journey name can contain a maximum of 150 + // characters. The characters can be alphanumeric characters or symbols, such as + // underscores (_) or hyphens (-). A journey name can't contain any spaces. // // This member is required. Name *string @@ -6764,8 +6585,8 @@ type WriteJourneyRequest struct { // alphanumeric characters. Activities map[string]Activity - // The time when journey will stop sending messages. QuietTime should be configured - // first and SendingSchedule should be set to true. + // The time when journey will stop sending messages. QuietTime should be + // configured first and SendingSchedule should be set to true. ClosedDays *ClosedDays // The date, in ISO 8601 format, when the journey was created. @@ -6792,21 +6613,14 @@ type WriteJourneyRequest struct { // The quiet time settings for the journey. Quiet time is a specific time range // when a journey doesn't send messages to participants, if all the following // conditions are met: - // - // * The EndpointDemographic.Timezone property of the endpoint - // for the participant is set to a valid value. - // - // * The current time in the - // participant's time zone is later than or equal to the time specified by the - // QuietTime.Start property for the journey. - // - // * The current time in the - // participant's time zone is earlier than or equal to the time specified by the - // QuietTime.End property for the journey. - // - // If any of the preceding conditions - // isn't met, the participant will receive messages from the journey, even if quiet - // time is enabled. + // - The EndpointDemographic.Timezone property of the endpoint for the + // participant is set to a valid value. + // - The current time in the participant's time zone is later than or equal to + // the time specified by the QuietTime.Start property for the journey. + // - The current time in the participant's time zone is earlier than or equal to + // the time specified by the QuietTime.End property for the journey. + // If any of the preceding conditions isn't met, the participant will receive + // messages from the journey, even if quiet time is enabled. QuietTime *QuietTime // The frequency with which Amazon Pinpoint evaluates segment and event data for @@ -6832,18 +6646,14 @@ type WriteJourneyRequest struct { StartCondition *StartCondition // The status of the journey. Valid values are: - // - // * DRAFT - Saves the journey and - // doesn't publish it. - // - // * ACTIVE - Saves and publishes the journey. Depending on - // the journey's schedule, the journey starts running immediately or at the - // scheduled start time. If a journey's status is ACTIVE, you can't add, change, or - // remove activities from it. - // - // PAUSED, CANCELLED, COMPLETED, and CLOSED states are - // not supported in requests to create or update a journey. To cancel, pause, or - // resume a journey, use the Journey State resource. + // - DRAFT - Saves the journey and doesn't publish it. + // - ACTIVE - Saves and publishes the journey. Depending on the journey's + // schedule, the journey starts running immediately or at the scheduled start time. + // If a journey's status is ACTIVE, you can't add, change, or remove activities + // from it. + // PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests + // to create or update a journey. To cancel, pause, or resume a journey, use the + // Journey State resource. State State // Specifies whether endpoints in quiet hours should enter a wait till the end of @@ -6877,8 +6687,8 @@ type WriteSegmentRequest struct { noSmithyDocumentSerde } -// 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. +// 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 { // The allocated percentage of users (segment members) to send the treatment to. diff --git a/service/pinpointemail/api_client.go b/service/pinpointemail/api_client.go index 33ab5ae3680..2f0634288c1 100644 --- a/service/pinpointemail/api_client.go +++ b/service/pinpointemail/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "Pinpoint Email" const ServiceAPIVersion = "2018-07-26" -// Client provides the API client to make operations call for Amazon Pinpoint Email -// Service. +// Client provides the API client to make operations call for Amazon Pinpoint +// Email Service. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pinpointemail/api_op_CreateConfigurationSet.go b/service/pinpointemail/api_op_CreateConfigurationSet.go index 84ca90d0df2..e0b297ff29f 100644 --- a/service/pinpointemail/api_op_CreateConfigurationSet.go +++ b/service/pinpointemail/api_op_CreateConfigurationSet.go @@ -62,8 +62,8 @@ type CreateConfigurationSetInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go b/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go index 5a6276f16fb..20fd3087810 100644 --- a/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go @@ -54,8 +54,8 @@ type CreateConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_CreateDedicatedIpPool.go b/service/pinpointemail/api_op_CreateDedicatedIpPool.go index 431065f9873..0a0680c62bf 100644 --- a/service/pinpointemail/api_op_CreateDedicatedIpPool.go +++ b/service/pinpointemail/api_op_CreateDedicatedIpPool.go @@ -46,8 +46,8 @@ type CreateDedicatedIpPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateDedicatedIpPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go b/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go index c9b2adbfba8..77709aee386 100644 --- a/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go +++ b/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go @@ -69,10 +69,10 @@ type CreateDeliverabilityTestReportInput struct { // Information about the predictive inbox placement test that you created. type CreateDeliverabilityTestReportOutput struct { - // The status of the predictive inbox placement test. If the status is IN_PROGRESS, - // then the predictive inbox placement test is currently running. Predictive inbox - // placement tests are usually complete within 24 hours of creating the test. If - // the status is COMPLETE, then the test is finished, and you can use the + // The status of the predictive inbox placement test. If the status is IN_PROGRESS + // , then the predictive inbox placement test is currently running. Predictive + // inbox placement tests are usually complete within 24 hours of creating the test. + // If the status is COMPLETE , then the test is finished, and you can use the // GetDeliverabilityTestReport to view the results of the test. // // This member is required. diff --git a/service/pinpointemail/api_op_CreateEmailIdentity.go b/service/pinpointemail/api_op_CreateEmailIdentity.go index 68c475e4347..3fb4b2aa37c 100644 --- a/service/pinpointemail/api_op_CreateEmailIdentity.go +++ b/service/pinpointemail/api_op_CreateEmailIdentity.go @@ -70,8 +70,8 @@ type CreateEmailIdentityOutput struct { // Specifies whether or not the identity is verified. In Amazon Pinpoint, you can // only send email from verified email addresses or domains. For more information - // about verifying identities, see the Amazon Pinpoint User Guide - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). + // about verifying identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html) + // . VerifiedForSendingStatus bool // Metadata pertaining to the operation's result. diff --git a/service/pinpointemail/api_op_DeleteConfigurationSet.go b/service/pinpointemail/api_op_DeleteConfigurationSet.go index 7577708c30e..849b558bd33 100644 --- a/service/pinpointemail/api_op_DeleteConfigurationSet.go +++ b/service/pinpointemail/api_op_DeleteConfigurationSet.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an existing configuration set. In Amazon Pinpoint, configuration sets are -// groups of rules that you can apply to the emails you send. You apply a +// Delete an existing configuration set. In Amazon Pinpoint, configuration sets +// are groups of rules that you can apply to the emails you send. You apply a // configuration set to an email by including a reference to the configuration set // in the headers of the email. When you apply a configuration set to an email, all // of the rules in that configuration set are applied to the email. @@ -41,8 +41,8 @@ type DeleteConfigurationSetInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go b/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go index 9796078b8d2..580366e9f0d 100644 --- a/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go @@ -48,8 +48,8 @@ type DeleteConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_DeleteDedicatedIpPool.go b/service/pinpointemail/api_op_DeleteDedicatedIpPool.go index 1d37251cc59..7eaefe8b629 100644 --- a/service/pinpointemail/api_op_DeleteDedicatedIpPool.go +++ b/service/pinpointemail/api_op_DeleteDedicatedIpPool.go @@ -37,8 +37,8 @@ type DeleteDedicatedIpPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteDedicatedIpPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_DeleteEmailIdentity.go b/service/pinpointemail/api_op_DeleteEmailIdentity.go index e9cffe3bedb..7ab16811ef5 100644 --- a/service/pinpointemail/api_op_DeleteEmailIdentity.go +++ b/service/pinpointemail/api_op_DeleteEmailIdentity.go @@ -27,14 +27,14 @@ func (c *Client) DeleteEmailIdentity(ctx context.Context, params *DeleteEmailIde return out, nil } -// A request to delete an existing email identity. When you delete an identity, you -// lose the ability to use Amazon Pinpoint to send email from that identity. You -// can restore your ability to send email by completing the verification process -// for the identity again. +// A request to delete an existing email identity. When you delete an identity, +// you lose the ability to use Amazon Pinpoint to send email from that identity. +// You can restore your ability to send email by completing the verification +// process for the identity again. type DeleteEmailIdentityInput struct { - // The identity (that is, the email address or domain) that you want to delete from - // your Amazon Pinpoint account. + // The identity (that is, the email address or domain) that you want to delete + // from your Amazon Pinpoint account. // // This member is required. EmailIdentity *string @@ -42,8 +42,8 @@ type DeleteEmailIdentityInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteEmailIdentityOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_GetAccount.go b/service/pinpointemail/api_op_GetAccount.go index 29945919562..f68ff357052 100644 --- a/service/pinpointemail/api_op_GetAccount.go +++ b/service/pinpointemail/api_op_GetAccount.go @@ -44,28 +44,25 @@ type GetAccountOutput struct { // The reputation status of your Amazon Pinpoint account. The status can be one of // the following: - // - // * HEALTHY – There are no reputation-related issues that - // currently impact your account. - // - // * PROBATION – We've identified some issues with - // your Amazon Pinpoint account. We're placing your account under review while you - // work on correcting these issues. - // - // * SHUTDOWN – Your account's ability to send - // email is currently paused because of an issue with the email sent from your - // account. When you correct the issue, you can contact us and request that your - // account's ability to send email is resumed. + // - HEALTHY – There are no reputation-related issues that currently impact your + // account. + // - PROBATION – We've identified some issues with your Amazon Pinpoint account. + // We're placing your account under review while you work on correcting these + // issues. + // - SHUTDOWN – Your account's ability to send email is currently paused because + // of an issue with the email sent from your account. When you correct the issue, + // you can contact us and request that your account's ability to send email is + // resumed. EnforcementStatus *string // Indicates whether or not your account has production access in the current AWS - // Region. If the value is false, then your account is in the sandbox. When your + // Region. If the value is false , then your account is in the sandbox. When your // account is in the sandbox, you can only send email to verified identities. // Additionally, the maximum number of emails you can send in a 24-hour period // (your sending quota) is 200, and the maximum number of emails you can send per - // second (your maximum sending rate) is 1. If the value is true, then your account - // has production access. When your account has production access, you can send - // email to any address. The sending quota and maximum sending rate for your + // second (your maximum sending rate) is 1. If the value is true , then your + // account has production access. When your account has production access, you can + // send email to any address. The sending quota and maximum sending rate for your // account vary based on your specific use case. ProductionAccessEnabled bool diff --git a/service/pinpointemail/api_op_GetBlacklistReports.go b/service/pinpointemail/api_op_GetBlacklistReports.go index 03702d06795..4e864546b87 100644 --- a/service/pinpointemail/api_op_GetBlacklistReports.go +++ b/service/pinpointemail/api_op_GetBlacklistReports.go @@ -44,8 +44,8 @@ type GetBlacklistReportsInput struct { // An object that contains information about blacklist events. type GetBlacklistReportsOutput struct { - // An object that contains information about a blacklist that one of your dedicated - // IP addresses appears on. + // An object that contains information about a blacklist that one of your + // dedicated IP addresses appears on. // // This member is required. BlacklistReport map[string][]types.BlacklistEntry diff --git a/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go b/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go index 250d2bdf0e1..9794894338f 100644 --- a/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go +++ b/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go @@ -33,8 +33,8 @@ func (c *Client) GetConfigurationSetEventDestinations(ctx context.Context, param return out, nil } -// A request to obtain information about the event destinations for a configuration -// set. +// A request to obtain information about the event destinations for a +// configuration set. type GetConfigurationSetEventDestinationsInput struct { // The name of the configuration set that contains the event destination. diff --git a/service/pinpointemail/api_op_GetDedicatedIps.go b/service/pinpointemail/api_op_GetDedicatedIps.go index 42df983647a..6b5eaf94313 100644 --- a/service/pinpointemail/api_op_GetDedicatedIps.go +++ b/service/pinpointemail/api_op_GetDedicatedIps.go @@ -36,8 +36,8 @@ type GetDedicatedIpsInput struct { // position of the dedicated IP pool in the list of IP pools. NextToken *string - // The number of results to show in a single call to GetDedicatedIpsRequest. If the - // number of results is larger than the number you specified in this parameter, + // The number of results to show in a single call to GetDedicatedIpsRequest . If + // the number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. PageSize *int32 @@ -56,9 +56,9 @@ type GetDedicatedIpsOutput struct { // Pinpoint account. DedicatedIps []types.DedicatedIp - // A token that indicates that there are additional dedicated IP addresses to list. - // To view additional addresses, issue another request to GetDedicatedIps, passing - // this token in the NextToken parameter. + // A token that indicates that there are additional dedicated IP addresses to + // list. To view additional addresses, issue another request to GetDedicatedIps , + // passing this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -137,8 +137,8 @@ var _ GetDedicatedIpsAPIClient = (*Client)(nil) // GetDedicatedIpsPaginatorOptions is the paginator options for GetDedicatedIps type GetDedicatedIpsPaginatorOptions struct { - // The number of results to show in a single call to GetDedicatedIpsRequest. If the - // number of results is larger than the number you specified in this parameter, + // The number of results to show in a single call to GetDedicatedIpsRequest . If + // the number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. Limit int32 diff --git a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go index 5323a9ce751..b97b1abcce5 100644 --- a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go @@ -19,8 +19,8 @@ import ( // predictive inbox placement tests. When you use the Deliverability dashboard, you // pay a monthly subscription charge, in addition to any other fees that you accrue // by using Amazon Pinpoint. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params *GetDeliverabilityDashboardOptionsInput, optFns ...func(*Options)) (*GetDeliverabilityDashboardOptionsOutput, error) { if params == nil { params = &GetDeliverabilityDashboardOptionsInput{} @@ -43,8 +43,8 @@ func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params * // predictive inbox placement tests. When you use the Deliverability dashboard, you // pay a monthly subscription charge, in addition to any other fees that you accrue // by using Amazon Pinpoint. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . type GetDeliverabilityDashboardOptionsInput struct { noSmithyDocumentSerde } @@ -54,24 +54,24 @@ type GetDeliverabilityDashboardOptionsInput struct { type GetDeliverabilityDashboardOptionsOutput struct { // Specifies whether the Deliverability dashboard is enabled for your Amazon - // Pinpoint account. If this value is true, the dashboard is enabled. + // Pinpoint account. If this value is true , the dashboard is enabled. // // This member is required. DashboardEnabled bool // The current status of your Deliverability dashboard subscription. If this value - // is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of + // is PENDING_EXPIRATION , your subscription is scheduled to expire at the end of // the current calendar month. AccountStatus types.DeliverabilityDashboardAccountStatus - // An array of objects, one for each verified domain that you use to send email and - // currently has an active Deliverability dashboard subscription that isn’t + // An array of objects, one for each verified domain that you use to send email + // and currently has an active Deliverability dashboard subscription that isn’t // scheduled to expire at the end of the current calendar month. ActiveSubscribedDomains []types.DomainDeliverabilityTrackingOption - // An array of objects, one for each verified domain that you use to send email and - // currently has an active Deliverability dashboard subscription that's scheduled - // to expire at the end of the current calendar month. + // An array of objects, one for each verified domain that you use to send email + // and currently has an active Deliverability dashboard subscription that's + // scheduled to expire at the end of the current calendar month. PendingExpirationSubscribedDomains []types.DomainDeliverabilityTrackingOption // The date, in Unix time format, when your current subscription to the diff --git a/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go b/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go index 357b44c9528..c5497f769f8 100644 --- a/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go +++ b/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go @@ -13,7 +13,7 @@ import ( // Retrieve all the deliverability data for a specific campaign. This data is // available for a campaign only if the campaign sent email by using a domain that -// the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// the Deliverability dashboard is enabled for ( PutDeliverabilityDashboardOption // operation). func (c *Client) GetDomainDeliverabilityCampaign(ctx context.Context, params *GetDomainDeliverabilityCampaignInput, optFns ...func(*Options)) (*GetDomainDeliverabilityCampaignOutput, error) { if params == nil { @@ -32,7 +32,7 @@ func (c *Client) GetDomainDeliverabilityCampaign(ctx context.Context, params *Ge // Retrieve all the deliverability data for a specific campaign. This data is // available for a campaign only if the campaign sent email by using a domain that -// the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// the Deliverability dashboard is enabled for ( PutDeliverabilityDashboardOption // operation). type GetDomainDeliverabilityCampaignInput struct { @@ -49,8 +49,8 @@ type GetDomainDeliverabilityCampaignInput struct { // An object that contains all the deliverability data for a specific campaign. // This data is available for a campaign only if the campaign sent email by using a -// domain that the Deliverability dashboard is enabled for -// (PutDeliverabilityDashboardOption operation). +// domain that the Deliverability dashboard is enabled for ( +// PutDeliverabilityDashboardOption operation). type GetDomainDeliverabilityCampaignOutput struct { // An object that contains the deliverability data for the campaign. diff --git a/service/pinpointemail/api_op_GetDomainStatisticsReport.go b/service/pinpointemail/api_op_GetDomainStatisticsReport.go index 17275c2c0e2..a5bae21d91e 100644 --- a/service/pinpointemail/api_op_GetDomainStatisticsReport.go +++ b/service/pinpointemail/api_op_GetDomainStatisticsReport.go @@ -39,7 +39,7 @@ type GetDomainStatisticsReportInput struct { // The last day (in Unix time) that you want to obtain domain deliverability // metrics for. The EndDate that you specify has to be less than or equal to 30 - // days after the StartDate. + // days after the StartDate . // // This member is required. EndDate *time.Time @@ -58,15 +58,15 @@ type GetDomainStatisticsReportInput struct { type GetDomainStatisticsReportOutput struct { // An object that contains deliverability metrics for the domain that you - // specified. This object contains data for each day, starting on the StartDate and - // ending on the EndDate. + // specified. This object contains data for each day, starting on the StartDate + // and ending on the EndDate . // // This member is required. DailyVolumes []types.DailyVolume // An object that contains deliverability metrics for the domain that you // specified. The data in this object is a summary of all of the data that was - // collected from the StartDate to the EndDate. + // collected from the StartDate to the EndDate . // // This member is required. OverallVolume *types.OverallVolume diff --git a/service/pinpointemail/api_op_GetEmailIdentity.go b/service/pinpointemail/api_op_GetEmailIdentity.go index 9689b33a264..8cf3b19ed2a 100644 --- a/service/pinpointemail/api_op_GetEmailIdentity.go +++ b/service/pinpointemail/api_op_GetEmailIdentity.go @@ -48,11 +48,11 @@ type GetEmailIdentityOutput struct { // are required to complete the DKIM verification process. DkimAttributes *types.DkimAttributes - // The feedback forwarding configuration for the identity. If the value is true, + // The feedback forwarding configuration for the identity. If the value is true , // Amazon Pinpoint sends you email notifications when bounce or complaint events // occur. Amazon Pinpoint sends this notification to the address that you specified // in the Return-Path header of the original email. When you set this value to - // false, Amazon Pinpoint sends notifications through other mechanisms, such as by + // false , Amazon Pinpoint sends notifications through other mechanisms, such as by // notifying an Amazon SNS topic or another event destination. You're required to // have a method of tracking bounces and complaints. If you haven't set up another // mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends @@ -63,8 +63,8 @@ type GetEmailIdentityOutput struct { // The email identity type. IdentityType types.IdentityType - // An object that contains information about the Mail-From attributes for the email - // identity. + // An object that contains information about the Mail-From attributes for the + // email identity. MailFromAttributes *types.MailFromAttributes // An array of objects that define the tags (keys and values) that are associated @@ -73,8 +73,8 @@ type GetEmailIdentityOutput struct { // Specifies whether or not the identity is verified. In Amazon Pinpoint, you can // only send email from verified email addresses or domains. For more information - // about verifying identities, see the Amazon Pinpoint User Guide - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). + // about verifying identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html) + // . VerifiedForSendingStatus bool // Metadata pertaining to the operation's result. diff --git a/service/pinpointemail/api_op_ListConfigurationSets.go b/service/pinpointemail/api_op_ListConfigurationSets.go index df155215570..66847bb0d6d 100644 --- a/service/pinpointemail/api_op_ListConfigurationSets.go +++ b/service/pinpointemail/api_op_ListConfigurationSets.go @@ -40,7 +40,7 @@ type ListConfigurationSetsInput struct { // position in the list of configuration sets. NextToken *string - // The number of results to show in a single call to ListConfigurationSets. If the + // The number of results to show in a single call to ListConfigurationSets . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. @@ -59,7 +59,7 @@ type ListConfigurationSetsOutput struct { // A token that indicates that there are additional configuration sets to list. To // view additional configuration sets, issue another request to - // ListConfigurationSets, and pass this token in the NextToken parameter. + // ListConfigurationSets , and pass this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListConfigurationSetsAPIClient = (*Client)(nil) // ListConfigurationSetsPaginatorOptions is the paginator options for // ListConfigurationSets type ListConfigurationSetsPaginatorOptions struct { - // The number of results to show in a single call to ListConfigurationSets. If the + // The number of results to show in a single call to ListConfigurationSets . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. diff --git a/service/pinpointemail/api_op_ListDedicatedIpPools.go b/service/pinpointemail/api_op_ListDedicatedIpPools.go index 237756c9975..4ac76a77863 100644 --- a/service/pinpointemail/api_op_ListDedicatedIpPools.go +++ b/service/pinpointemail/api_op_ListDedicatedIpPools.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all of the dedicated IP pools that exist in your Amazon Pinpoint account in -// the current AWS Region. +// List all of the dedicated IP pools that exist in your Amazon Pinpoint account +// in the current AWS Region. func (c *Client) ListDedicatedIpPools(ctx context.Context, params *ListDedicatedIpPoolsInput, optFns ...func(*Options)) (*ListDedicatedIpPoolsOutput, error) { if params == nil { params = &ListDedicatedIpPoolsInput{} @@ -35,7 +35,7 @@ type ListDedicatedIpPoolsInput struct { // position in the list of dedicated IP pools. NextToken *string - // The number of results to show in a single call to ListDedicatedIpPools. If the + // The number of results to show in a single call to ListDedicatedIpPools . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. @@ -52,8 +52,8 @@ type ListDedicatedIpPoolsOutput struct { DedicatedIpPools []string // A token that indicates that there are additional IP pools to list. To view - // additional IP pools, issue another request to ListDedicatedIpPools, passing this - // token in the NextToken parameter. + // additional IP pools, issue another request to ListDedicatedIpPools , passing + // this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -133,7 +133,7 @@ var _ ListDedicatedIpPoolsAPIClient = (*Client)(nil) // ListDedicatedIpPoolsPaginatorOptions is the paginator options for // ListDedicatedIpPools type ListDedicatedIpPoolsPaginatorOptions struct { - // The number of results to show in a single call to ListDedicatedIpPools. If the + // The number of results to show in a single call to ListDedicatedIpPools . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. diff --git a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go index aad69d3c911..d21775effae 100644 --- a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go +++ b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go @@ -39,8 +39,8 @@ type ListDeliverabilityTestReportsInput struct { // indicate the position in the list of predictive inbox placement tests. NextToken *string - // The number of results to show in a single call to ListDeliverabilityTestReports. - // If the number of results is larger than the number you specified in this + // The number of results to show in a single call to ListDeliverabilityTestReports + // . If the number of results is larger than the number you specified in this // parameter, then the response includes a NextToken element, which you can use to // obtain additional results. The value you specify has to be at least 0, and can // be no more than 1000. @@ -61,7 +61,7 @@ type ListDeliverabilityTestReportsOutput struct { // A token that indicates that there are additional predictive inbox placement // tests to list. To view additional predictive inbox placement tests, issue - // another request to ListDeliverabilityTestReports, and pass this token in the + // another request to ListDeliverabilityTestReports , and pass this token in the // NextToken parameter. NextToken *string @@ -142,8 +142,8 @@ var _ ListDeliverabilityTestReportsAPIClient = (*Client)(nil) // ListDeliverabilityTestReportsPaginatorOptions is the paginator options for // ListDeliverabilityTestReports type ListDeliverabilityTestReportsPaginatorOptions struct { - // The number of results to show in a single call to ListDeliverabilityTestReports. - // If the number of results is larger than the number you specified in this + // The number of results to show in a single call to ListDeliverabilityTestReports + // . If the number of results is larger than the number you specified in this // parameter, then the response includes a NextToken element, which you can use to // obtain additional results. The value you specify has to be at least 0, and can // be no more than 1000. diff --git a/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go b/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go index 5d25389a068..190be07e463 100644 --- a/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go +++ b/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go @@ -15,8 +15,8 @@ import ( // Retrieve deliverability data for all the campaigns that used a specific domain // to send email during a specified time range. This data is available for a domain -// only if you enabled the Deliverability dashboard -// (PutDeliverabilityDashboardOption operation) for the domain. +// only if you enabled the Deliverability dashboard ( +// PutDeliverabilityDashboardOption operation) for the domain. func (c *Client) ListDomainDeliverabilityCampaigns(ctx context.Context, params *ListDomainDeliverabilityCampaignsInput, optFns ...func(*Options)) (*ListDomainDeliverabilityCampaignsOutput, error) { if params == nil { params = &ListDomainDeliverabilityCampaignsInput{} @@ -34,8 +34,8 @@ func (c *Client) ListDomainDeliverabilityCampaigns(ctx context.Context, params * // Retrieve deliverability data for all the campaigns that used a specific domain // to send email during a specified time range. This data is available for a domain -// only if you enabled the Deliverability dashboard -// (PutDeliverabilityDashboardOption operation) for the domain. +// only if you enabled the Deliverability dashboard ( +// PutDeliverabilityDashboardOption operation) for the domain. type ListDomainDeliverabilityCampaignsInput struct { // The last day, in Unix time format, that you want to obtain deliverability data @@ -72,8 +72,8 @@ type ListDomainDeliverabilityCampaignsInput struct { // An array of objects that provide deliverability data for all the campaigns that // used a specific domain to send email during a specified time range. This data is -// available for a domain only if you enabled the Deliverability dashboard -// (PutDeliverabilityDashboardOption operation) for the domain. +// available for a domain only if you enabled the Deliverability dashboard ( +// PutDeliverabilityDashboardOption operation) for the domain. type ListDomainDeliverabilityCampaignsOutput struct { // An array of responses, one for each campaign that used the domain to send email diff --git a/service/pinpointemail/api_op_ListEmailIdentities.go b/service/pinpointemail/api_op_ListEmailIdentities.go index d9b70857e73..8a508293648 100644 --- a/service/pinpointemail/api_op_ListEmailIdentities.go +++ b/service/pinpointemail/api_op_ListEmailIdentities.go @@ -41,7 +41,7 @@ type ListEmailIdentitiesInput struct { // position in the list of identities. NextToken *string - // The number of results to show in a single call to ListEmailIdentities. If the + // The number of results to show in a single call to ListEmailIdentities . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 0, and can be no @@ -61,8 +61,8 @@ type ListEmailIdentitiesOutput struct { EmailIdentities []types.IdentityInfo // A token that indicates that there are additional configuration sets to list. To - // view additional configuration sets, issue another request to - // ListEmailIdentities, and pass this token in the NextToken parameter. + // view additional configuration sets, issue another request to ListEmailIdentities + // , and pass this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -131,8 +131,8 @@ func (c *Client) addOperationListEmailIdentitiesMiddlewares(stack *middleware.St return nil } -// ListEmailIdentitiesAPIClient is a client that implements the ListEmailIdentities -// operation. +// ListEmailIdentitiesAPIClient is a client that implements the +// ListEmailIdentities operation. type ListEmailIdentitiesAPIClient interface { ListEmailIdentities(context.Context, *ListEmailIdentitiesInput, ...func(*Options)) (*ListEmailIdentitiesOutput, error) } @@ -142,7 +142,7 @@ var _ ListEmailIdentitiesAPIClient = (*Client)(nil) // ListEmailIdentitiesPaginatorOptions is the paginator options for // ListEmailIdentities type ListEmailIdentitiesPaginatorOptions struct { - // The number of results to show in a single call to ListEmailIdentities. If the + // The number of results to show in a single call to ListEmailIdentities . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 0, and can be no diff --git a/service/pinpointemail/api_op_ListTagsForResource.go b/service/pinpointemail/api_op_ListTagsForResource.go index 88a40130460..b3bdbdfd4ba 100644 --- a/service/pinpointemail/api_op_ListTagsForResource.go +++ b/service/pinpointemail/api_op_ListTagsForResource.go @@ -45,8 +45,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // An array that lists all the tags that are associated with the resource. Each tag - // consists of a required tag key (Key) and an associated tag value (Value) + // An array that lists all the tags that are associated with the resource. Each + // tag consists of a required tag key ( Key ) and an associated tag value ( Value ) // // This member is required. Tags []types.Tag diff --git a/service/pinpointemail/api_op_PutAccountDedicatedIpWarmupAttributes.go b/service/pinpointemail/api_op_PutAccountDedicatedIpWarmupAttributes.go index 21c60f14060..ef0175a8680 100644 --- a/service/pinpointemail/api_op_PutAccountDedicatedIpWarmupAttributes.go +++ b/service/pinpointemail/api_op_PutAccountDedicatedIpWarmupAttributes.go @@ -38,8 +38,8 @@ type PutAccountDedicatedIpWarmupAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountDedicatedIpWarmupAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutAccountSendingAttributes.go b/service/pinpointemail/api_op_PutAccountSendingAttributes.go index f7796dbf02b..845daa22e6a 100644 --- a/service/pinpointemail/api_op_PutAccountSendingAttributes.go +++ b/service/pinpointemail/api_op_PutAccountSendingAttributes.go @@ -38,8 +38,8 @@ type PutAccountSendingAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountSendingAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutConfigurationSetDeliveryOptions.go b/service/pinpointemail/api_op_PutConfigurationSetDeliveryOptions.go index 3aae7d4d897..81cba66aa81 100644 --- a/service/pinpointemail/api_op_PutConfigurationSetDeliveryOptions.go +++ b/service/pinpointemail/api_op_PutConfigurationSetDeliveryOptions.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate a configuration set with a dedicated IP pool. You can use dedicated IP -// pools to create groups of dedicated IP addresses for sending specific types of -// email. +// Associate a configuration set with a dedicated IP pool. You can use dedicated +// IP pools to create groups of dedicated IP addresses for sending specific types +// of email. func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params *PutConfigurationSetDeliveryOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetDeliveryOptionsOutput, error) { if params == nil { params = &PutConfigurationSetDeliveryOptionsInput{} @@ -32,8 +32,8 @@ func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params // A request to associate a configuration set with a dedicated IP pool. type PutConfigurationSetDeliveryOptionsInput struct { - // The name of the configuration set that you want to associate with a dedicated IP - // pool. + // The name of the configuration set that you want to associate with a dedicated + // IP pool. // // This member is required. ConfigurationSetName *string @@ -43,8 +43,8 @@ type PutConfigurationSetDeliveryOptionsInput struct { SendingPoolName *string // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). If the value is Require, messages are only - // delivered if a TLS connection can be established. If the value is Optional, + // Transport Layer Security (TLS). If the value is Require , messages are only + // delivered if a TLS connection can be established. If the value is Optional , // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy types.TlsPolicy @@ -52,8 +52,8 @@ type PutConfigurationSetDeliveryOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetDeliveryOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutConfigurationSetReputationOptions.go b/service/pinpointemail/api_op_PutConfigurationSetReputationOptions.go index 5cbac6b813d..73ffca12d71 100644 --- a/service/pinpointemail/api_op_PutConfigurationSetReputationOptions.go +++ b/service/pinpointemail/api_op_PutConfigurationSetReputationOptions.go @@ -37,15 +37,15 @@ type PutConfigurationSetReputationOptionsInput struct { // This member is required. ConfigurationSetName *string - // If true, tracking of reputation metrics is enabled for the configuration set. If - // false, tracking of reputation metrics is disabled for the configuration set. + // If true , tracking of reputation metrics is enabled for the configuration set. + // If false , tracking of reputation metrics is disabled for the configuration set. ReputationMetricsEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetReputationOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutConfigurationSetSendingOptions.go b/service/pinpointemail/api_op_PutConfigurationSetSendingOptions.go index ee0b1e5cf0b..8b89f9a18b2 100644 --- a/service/pinpointemail/api_op_PutConfigurationSetSendingOptions.go +++ b/service/pinpointemail/api_op_PutConfigurationSetSendingOptions.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enable or disable email sending for messages that use a particular configuration -// set in a specific AWS Region. +// Enable or disable email sending for messages that use a particular +// configuration set in a specific AWS Region. func (c *Client) PutConfigurationSetSendingOptions(ctx context.Context, params *PutConfigurationSetSendingOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetSendingOptionsOutput, error) { if params == nil { params = &PutConfigurationSetSendingOptionsInput{} @@ -37,15 +37,15 @@ type PutConfigurationSetSendingOptionsInput struct { // This member is required. ConfigurationSetName *string - // If true, email sending is enabled for the configuration set. If false, email + // If true , email sending is enabled for the configuration set. If false , email // sending is disabled for the configuration set. SendingEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetSendingOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutConfigurationSetTrackingOptions.go b/service/pinpointemail/api_op_PutConfigurationSetTrackingOptions.go index 1eada7ae8ce..9c344dd1e6f 100644 --- a/service/pinpointemail/api_op_PutConfigurationSetTrackingOptions.go +++ b/service/pinpointemail/api_op_PutConfigurationSetTrackingOptions.go @@ -43,8 +43,8 @@ type PutConfigurationSetTrackingOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetTrackingOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutDedicatedIpInPool.go b/service/pinpointemail/api_op_PutDedicatedIpInPool.go index 7f7d58ef791..3be3e5127a3 100644 --- a/service/pinpointemail/api_op_PutDedicatedIpInPool.go +++ b/service/pinpointemail/api_op_PutDedicatedIpInPool.go @@ -48,8 +48,8 @@ type PutDedicatedIpInPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutDedicatedIpInPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutDedicatedIpWarmupAttributes.go b/service/pinpointemail/api_op_PutDedicatedIpWarmupAttributes.go index b6e3c87556c..98e4c817bd2 100644 --- a/service/pinpointemail/api_op_PutDedicatedIpWarmupAttributes.go +++ b/service/pinpointemail/api_op_PutDedicatedIpWarmupAttributes.go @@ -43,8 +43,8 @@ type PutDedicatedIpWarmupAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutDedicatedIpWarmupAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go index 67655ea0e95..3e6552d41fa 100644 --- a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go +++ b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go @@ -11,15 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. -// When you enable the Deliverability dashboard, you gain access to reputation, -// deliverability, and other metrics for the domains that you use to send email -// using Amazon Pinpoint. You also gain the ability to perform predictive inbox -// placement tests. When you use the Deliverability dashboard, you pay a monthly -// subscription charge, in addition to any other fees that you accrue by using -// Amazon Pinpoint. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Enable or disable the Deliverability dashboard for your Amazon Pinpoint +// account. When you enable the Deliverability dashboard, you gain access to +// reputation, deliverability, and other metrics for the domains that you use to +// send email using Amazon Pinpoint. You also gain the ability to perform +// predictive inbox placement tests. When you use the Deliverability dashboard, you +// pay a monthly subscription charge, in addition to any other fees that you accrue +// by using Amazon Pinpoint. For more information about the features and cost of a +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *PutDeliverabilityDashboardOptionInput, optFns ...func(*Options)) (*PutDeliverabilityDashboardOptionOutput, error) { if params == nil { params = &PutDeliverabilityDashboardOptionInput{} @@ -35,25 +35,25 @@ func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *P return out, nil } -// Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. -// When you enable the Deliverability dashboard, you gain access to reputation, -// deliverability, and other metrics for the domains that you use to send email -// using Amazon Pinpoint. You also gain the ability to perform predictive inbox -// placement tests. When you use the Deliverability dashboard, you pay a monthly -// subscription charge, in addition to any other fees that you accrue by using -// Amazon Pinpoint. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Enable or disable the Deliverability dashboard for your Amazon Pinpoint +// account. When you enable the Deliverability dashboard, you gain access to +// reputation, deliverability, and other metrics for the domains that you use to +// send email using Amazon Pinpoint. You also gain the ability to perform +// predictive inbox placement tests. When you use the Deliverability dashboard, you +// pay a monthly subscription charge, in addition to any other fees that you accrue +// by using Amazon Pinpoint. For more information about the features and cost of a +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . type PutDeliverabilityDashboardOptionInput struct { // Specifies whether to enable the Deliverability dashboard for your Amazon - // Pinpoint account. To enable the dashboard, set this value to true. + // Pinpoint account. To enable the dashboard, set this value to true . // // This member is required. DashboardEnabled bool - // An array of objects, one for each verified domain that you use to send email and - // enabled the Deliverability dashboard for. + // An array of objects, one for each verified domain that you use to send email + // and enabled the Deliverability dashboard for. SubscribedDomains []types.DomainDeliverabilityTrackingOption noSmithyDocumentSerde diff --git a/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go index fe5b4dd1d9f..d1d0b6e4c4d 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go @@ -26,8 +26,8 @@ func (c *Client) PutEmailIdentityDkimAttributes(ctx context.Context, params *Put return out, nil } -// A request to enable or disable DKIM signing of email that you send from an email -// identity. +// A request to enable or disable DKIM signing of email that you send from an +// email identity. type PutEmailIdentityDkimAttributesInput struct { // The email identity that you want to change the DKIM settings for. @@ -36,16 +36,16 @@ type PutEmailIdentityDkimAttributesInput struct { EmailIdentity *string // Sets the DKIM signing configuration for the identity. When you set this value - // true, then the messages that Amazon Pinpoint sends from the identity are - // DKIM-signed. When you set this value to false, then the messages that Amazon + // true , then the messages that Amazon Pinpoint sends from the identity are + // DKIM-signed. When you set this value to false , then the messages that Amazon // Pinpoint sends from the identity aren't DKIM-signed. SigningEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityDkimAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go index 13f9e9c7ef3..04018421d93 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go @@ -36,8 +36,8 @@ func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params return out, nil } -// A request to set the attributes that control how bounce and complaint events are -// processed. +// A request to set the attributes that control how bounce and complaint events +// are processed. type PutEmailIdentityFeedbackAttributesInput struct { // The email identity that you want to configure bounce and complaint feedback @@ -47,10 +47,10 @@ type PutEmailIdentityFeedbackAttributesInput struct { EmailIdentity *string // Sets the feedback forwarding configuration for the identity. If the value is - // true, Amazon Pinpoint sends you email notifications when bounce or complaint + // true , Amazon Pinpoint sends you email notifications when bounce or complaint // events occur. Amazon Pinpoint sends this notification to the address that you // specified in the Return-Path header of the original email. When you set this - // value to false, Amazon Pinpoint sends notifications through other mechanisms, + // value to false , Amazon Pinpoint sends notifications through other mechanisms, // such as by notifying an Amazon SNS topic or another event destination. You're // required to have a method of tracking bounces and complaints. If you haven't set // up another mechanism for receiving bounce or complaint notifications, Amazon @@ -61,8 +61,8 @@ type PutEmailIdentityFeedbackAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityFeedbackAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go index 3c2a169c984..f04effba3ac 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used to enable or disable the custom Mail-From domain configuration for an email -// identity. +// Used to enable or disable the custom Mail-From domain configuration for an +// email identity. func (c *Client) PutEmailIdentityMailFromAttributes(ctx context.Context, params *PutEmailIdentityMailFromAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityMailFromAttributesOutput, error) { if params == nil { params = &PutEmailIdentityMailFromAttributesInput{} @@ -38,32 +38,27 @@ type PutEmailIdentityMailFromAttributesInput struct { EmailIdentity *string // The action that you want Amazon Pinpoint to take if it can't read the required - // MX record when you send an email. When you set this value to UseDefaultValue, + // MX record when you send an email. When you set this value to UseDefaultValue , // Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this - // value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified + // value to RejectMessage , Amazon Pinpoint returns a MailFromDomainNotVerified // error, and doesn't attempt to deliver the email. These behaviors are taken when - // the custom MAIL FROM domain configuration is in the Pending, Failed, and + // the custom MAIL FROM domain configuration is in the Pending , Failed , and // TemporaryFailure states. BehaviorOnMxFailure types.BehaviorOnMxFailure - // The custom MAIL FROM domain that you want the verified identity to use. The MAIL - // FROM domain must meet the following criteria: - // - // * It has to be a subdomain of the - // verified identity. - // - // * It can't be used to receive email. - // - // * It can't be used in - // a "From" address if the MAIL FROM domain is a destination for feedback - // forwarding emails. + // The custom MAIL FROM domain that you want the verified identity to use. The + // MAIL FROM domain must meet the following criteria: + // - It has to be a subdomain of the verified identity. + // - It can't be used to receive email. + // - It can't be used in a "From" address if the MAIL FROM domain is a + // destination for feedback forwarding emails. MailFromDomain *string noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityMailFromAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/api_op_SendEmail.go b/service/pinpointemail/api_op_SendEmail.go index 209ab8b4735..d4a811ab239 100644 --- a/service/pinpointemail/api_op_SendEmail.go +++ b/service/pinpointemail/api_op_SendEmail.go @@ -13,16 +13,13 @@ import ( // Sends an email message. You can use the Amazon Pinpoint Email API to send two // types of messages: -// -// * Simple – A standard email message. When you create this -// type of message, you specify the sender, the recipient, and the message body, -// and Amazon Pinpoint assembles the message for you. -// -// * Raw – A raw, -// MIME-formatted email message. When you send this type of email, you have to -// specify all of the message headers, as well as the message body. You can use -// this message type to send messages that contain attachments. The message that -// you specify has to be a valid MIME message. +// - Simple – A standard email message. When you create this type of message, +// you specify the sender, the recipient, and the message body, and Amazon Pinpoint +// assembles the message for you. +// - Raw – A raw, MIME-formatted email message. When you send this type of +// email, you have to specify all of the message headers, as well as the message +// body. You can use this message type to send messages that contain attachments. +// The message that you specify has to be a valid MIME message. func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns ...func(*Options)) (*SendEmailOutput, error) { if params == nil { params = &SendEmailInput{} diff --git a/service/pinpointemail/api_op_TagResource.go b/service/pinpointemail/api_op_TagResource.go index b500465bc38..40b369331da 100644 --- a/service/pinpointemail/api_op_TagResource.go +++ b/service/pinpointemail/api_op_TagResource.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add one or more tags (keys and values) to a specified resource. A tag is a label -// that you optionally define and associate with a resource in Amazon Pinpoint. -// Tags can help you categorize and manage resources in different ways, such as by -// purpose, owner, environment, or other criteria. A resource can have as many as -// 50 tags. Each tag consists of a required tag key and an associated tag value, -// both of which you define. A tag key is a general label that acts as a category -// for more specific tag values. A tag value acts as a descriptor within a tag key. +// Add one or more tags (keys and values) to a specified resource. A tag is a +// label that you optionally define and associate with a resource in Amazon +// Pinpoint. Tags can help you categorize and manage resources in different ways, +// such as by purpose, owner, environment, or other criteria. A resource can have +// as many as 50 tags. Each tag consists of a required tag key and an associated +// tag value, both of which you define. A tag key is a general label that acts as a +// category for more specific tag values. A tag value acts as a descriptor within a +// tag key. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -42,8 +43,8 @@ type TagResourceInput struct { ResourceArn *string // A list of the tags that you want to add to the resource. A tag consists of a - // required tag key (Key) and an associated tag value (Value). The maximum length - // of a tag key is 128 characters. The maximum length of a tag value is 256 + // required tag key ( Key ) and an associated tag value ( Value ). The maximum + // length of a tag key is 128 characters. The maximum length of a tag value is 256 // characters. // // This member is required. diff --git a/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go b/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go index 16a43b70016..ceefe5e42a8 100644 --- a/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go @@ -56,8 +56,8 @@ type UpdateConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type UpdateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/pinpointemail/doc.go b/service/pinpointemail/doc.go index 630e965266a..c9b033fe81c 100644 --- a/service/pinpointemail/doc.go +++ b/service/pinpointemail/doc.go @@ -13,27 +13,24 @@ // programmatic access to options that are unique to the email channel and // supplement the options provided by the Amazon Pinpoint API. If you're new to // Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint -// Developer Guide -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). The -// Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures -// that demonstrate how to use Amazon Pinpoint features programmatically and how to -// integrate Amazon Pinpoint functionality into mobile apps and other types of -// applications. The guide also provides information about key topics such as -// Amazon Pinpoint integration with other AWS services and the limits that apply to -// using the service. The Amazon Pinpoint Email API is available in several AWS +// Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html) +// . The Amazon Pinpoint Developer Guide provides tutorials, code samples, and +// procedures that demonstrate how to use Amazon Pinpoint features programmatically +// and how to integrate Amazon Pinpoint functionality into mobile apps and other +// types of applications. The guide also provides information about key topics such +// as Amazon Pinpoint integration with other AWS services and the limits that apply +// to using the service. The Amazon Pinpoint Email API is available in several AWS // Regions and it provides an endpoint for each of these Regions. For a list of all // the Regions and endpoints where the API is currently available, see AWS Service -// Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) in -// the Amazon Web Services General Reference. To learn more about AWS Regions, see -// Managing AWS Regions -// (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon -// Web Services General Reference. In each Region, AWS maintains multiple -// Availability Zones. These Availability Zones are physically isolated from each -// other, but are united by private, low-latency, high-throughput, and highly -// redundant network connections. These Availability Zones enable us to provide -// very high levels of availability and redundancy, while also minimizing latency. -// To learn more about the number of Availability Zones that are available in each -// Region, see AWS Global Infrastructure -// (http://aws.amazon.com/about-aws/global-infrastructure/). +// Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) +// in the Amazon Web Services General Reference. To learn more about AWS Regions, +// see Managing AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) +// in the Amazon Web Services General Reference. In each Region, AWS maintains +// multiple Availability Zones. These Availability Zones are physically isolated +// from each other, but are united by private, low-latency, high-throughput, and +// highly redundant network connections. These Availability Zones enable us to +// provide very high levels of availability and redundancy, while also minimizing +// latency. To learn more about the number of Availability Zones that are available +// in each Region, see AWS Global Infrastructure (http://aws.amazon.com/about-aws/global-infrastructure/) +// . package pinpointemail diff --git a/service/pinpointemail/types/enums.go b/service/pinpointemail/types/enums.go index 44c0e31cc5d..b2c51077367 100644 --- a/service/pinpointemail/types/enums.go +++ b/service/pinpointemail/types/enums.go @@ -49,9 +49,9 @@ const ( DeliverabilityTestStatusCompleted DeliverabilityTestStatus = "COMPLETED" ) -// Values returns all known values for DeliverabilityTestStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeliverabilityTestStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliverabilityTestStatus) Values() []DeliverabilityTestStatus { return []DeliverabilityTestStatus{ "IN_PROGRESS", @@ -117,9 +117,9 @@ const ( EventTypeRenderingFailure EventType = "RENDERING_FAILURE" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "SEND", @@ -142,9 +142,9 @@ const ( IdentityTypeManagedDomain IdentityType = "MANAGED_DOMAIN" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "EMAIL_ADDRESS", @@ -183,9 +183,9 @@ const ( TlsPolicyOptional TlsPolicy = "OPTIONAL" ) -// Values returns all known values for TlsPolicy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TlsPolicy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TlsPolicy) Values() []TlsPolicy { return []TlsPolicy{ "REQUIRE", @@ -201,9 +201,9 @@ const ( WarmupStatusDone WarmupStatus = "DONE" ) -// Values returns all known values for WarmupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WarmupStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WarmupStatus) Values() []WarmupStatus { return []WarmupStatus{ "IN_PROGRESS", diff --git a/service/pinpointemail/types/types.go b/service/pinpointemail/types/types.go index 9b985a2e171..2b7e0c4ac64 100644 --- a/service/pinpointemail/types/types.go +++ b/service/pinpointemail/types/types.go @@ -45,8 +45,8 @@ type Body struct { // metrics. type CloudWatchDestination struct { - // An array of objects that define the dimensions to use when you send email events - // to Amazon CloudWatch. + // An array of objects that define the dimensions to use when you send email + // events to Amazon CloudWatch. // // This member is required. DimensionConfigurations []CloudWatchDimensionConfiguration @@ -58,27 +58,21 @@ type CloudWatchDestination struct { // Pinpoint email events to Amazon CloudWatch. type CloudWatchDimensionConfiguration struct { - // The default value of the dimension that is published to Amazon CloudWatch if you - // don't provide the value of the dimension when you send an email. This value has - // to meet the following criteria: - // - // * It can only contain ASCII letters (a-z, A-Z), - // numbers (0-9), underscores (_), or dashes (-). - // - // * It can contain no more than - // 256 characters. + // The default value of the dimension that is published to Amazon CloudWatch if + // you don't provide the value of the dimension when you send an email. This value + // has to meet the following criteria: + // - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. DefaultDimensionValue *string // The name of an Amazon CloudWatch dimension associated with an email sending // metric. The name has to meet the following criteria: - // - // * It can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * It - // can contain no more than 256 characters. + // - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. DimensionName *string @@ -86,9 +80,9 @@ type CloudWatchDimensionConfiguration struct { // The location where Amazon Pinpoint finds the value of a dimension to publish to // Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you // specify using an X-SES-MESSAGE-TAGS header or a parameter to the - // SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to - // use your own email headers, choose emailHeader. If you want Amazon Pinpoint to - // use link tags, choose linkTags. + // SendEmail/SendRawEmail API, choose messageTag . If you want Amazon Pinpoint to + // use your own email headers, choose emailHeader . If you want Amazon Pinpoint to + // use link tags, choose linkTags . // // This member is required. DimensionValueSource DimensionValueSource @@ -108,7 +102,7 @@ type Content struct { // The character set for the content. Because of the constraints of the SMTP // protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes // characters outside of the ASCII range, you have to specify a character set. For - // example, you could specify UTF-8, ISO-8859-1, or Shift_JIS. + // example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS . Charset *string noSmithyDocumentSerde @@ -149,12 +143,10 @@ type DedicatedIp struct { // The warm-up status of a dedicated IP address. The status can have one of the // following values: - // - // * IN_PROGRESS – The IP address isn't ready to use because the - // dedicated IP warm-up process is ongoing. - // - // * DONE – The dedicated IP warm-up - // process is complete, and the IP address is ready to use. + // - IN_PROGRESS – The IP address isn't ready to use because the dedicated IP + // warm-up process is ongoing. + // - DONE – The dedicated IP warm-up process is complete, and the IP address is + // ready to use. // // This member is required. WarmupStatus WarmupStatus @@ -172,10 +164,10 @@ type DeliverabilityTestReport struct { // time format. CreateDate *time.Time - // The status of the predictive inbox placement test. If the status is IN_PROGRESS, - // then the predictive inbox placement test is currently running. Predictive inbox - // placement tests are usually complete within 24 hours of creating the test. If - // the status is COMPLETE, then the test is finished, and you can use the + // The status of the predictive inbox placement test. If the status is IN_PROGRESS + // , then the predictive inbox placement test is currently running. Predictive + // inbox placement tests are usually complete within 24 hours of creating the test. + // If the status is COMPLETE , then the test is finished, and you can use the // GetDeliverabilityTestReport to view the results of the test. DeliverabilityTestStatus DeliverabilityTestStatus @@ -188,8 +180,8 @@ type DeliverabilityTestReport struct { // A name that helps you identify a predictive inbox placement test report. ReportName *string - // The subject line for an email that you submitted in a predictive inbox placement - // test. + // The subject line for an email that you submitted in a predictive inbox + // placement test. Subject *string noSmithyDocumentSerde @@ -203,8 +195,8 @@ type DeliveryOptions struct { SendingPoolName *string // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). If the value is Require, messages are only - // delivered if a TLS connection can be established. If the value is Optional, + // Transport Layer Security (TLS). If the value is Require , messages are only + // delivered if a TLS connection can be established. If the value is Optional , // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy TlsPolicy @@ -233,33 +225,25 @@ type Destination struct { // identity. type DkimAttributes struct { - // If the value is true, then the messages that Amazon Pinpoint sends from the - // identity are DKIM-signed. If the value is false, then the messages that Amazon + // If the value is true , then the messages that Amazon Pinpoint sends from the + // identity are DKIM-signed. If the value is false , then the messages that Amazon // Pinpoint sends from the identity aren't DKIM-signed. SigningEnabled bool // Describes whether or not Amazon Pinpoint has successfully located the DKIM // records in the DNS records for the domain. The status can be one of the // following: - // - // * PENDING – Amazon Pinpoint hasn't yet located the DKIM records in - // the DNS configuration for the domain, but will continue to attempt to locate - // them. - // - // * SUCCESS – Amazon Pinpoint located the DKIM records in the DNS - // configuration for the domain and determined that they're correct. Amazon - // Pinpoint can now send DKIM-signed email from the identity. - // - // * FAILED – Amazon - // Pinpoint was unable to locate the DKIM records in the DNS settings for the - // domain, and won't continue to search for them. - // - // * TEMPORARY_FAILURE – A - // temporary issue occurred, which prevented Amazon Pinpoint from determining the - // DKIM status for the domain. - // - // * NOT_STARTED – Amazon Pinpoint hasn't yet started - // searching for the DKIM records in the DKIM records for the domain. + // - PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS + // configuration for the domain, but will continue to attempt to locate them. + // - SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration + // for the domain and determined that they're correct. Amazon Pinpoint can now send + // DKIM-signed email from the identity. + // - FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS + // settings for the domain, and won't continue to search for them. + // - TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon + // Pinpoint from determining the DKIM status for the domain. + // - NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM + // records in the DKIM records for the domain. Status DkimStatus // A set of unique strings that you use to create a set of CNAME records that you @@ -274,8 +258,8 @@ type DkimAttributes struct { // An object that contains the deliverability data for a specific campaign. This // data is available for a campaign only if the campaign sent email by using a -// domain that the Deliverability dashboard is enabled for -// (PutDeliverabilityDashboardOption operation). +// domain that the Deliverability dashboard is enabled for ( +// PutDeliverabilityDashboardOption operation). type DomainDeliverabilityCampaign struct { // The unique identifier for the campaign. Amazon Pinpoint automatically generates @@ -292,8 +276,8 @@ type DomainDeliverabilityCampaign struct { // The major email providers who handled the email message. Esps []string - // The first time, in Unix time format, when the email message was delivered to any - // recipient's inbox. This value can help you determine how long it took for a + // The first time, in Unix time format, when the email message was delivered to + // any recipient's inbox. This value can help you determine how long it took for a // campaign to deliver an email message. FirstSeenDateTime *time.Time @@ -352,8 +336,8 @@ type DomainDeliverabilityTrackingOption struct { // the domain. InboxPlacementTrackingOption *InboxPlacementTrackingOption - // The date, in Unix time format, when you enabled the Deliverability dashboard for - // the domain. + // The date, in Unix time format, when you enabled the Deliverability dashboard + // for the domain. SubscriptionStartDate *time.Time noSmithyDocumentSerde @@ -393,30 +377,19 @@ type DomainIspPlacement struct { type EmailContent struct { // The raw email message. The message has to meet the following criteria: - // - // * The - // message has to contain a header and a body, separated by one blank line. - // - // * All - // of the required header fields must be present in the message. - // - // * Each part of a - // multipart MIME message must be formatted properly. - // - // * If you include - // attachments, they must be in a file format that Amazon Pinpoint supports. - // - // * The - // entire message must be Base64 encoded. - // - // * If any of the MIME parts in your - // message contain content that is outside of the 7-bit ASCII character range, you - // should encode that content to ensure that recipients' email clients render the - // message properly. - // - // * The length of any single line of text in the message can't - // exceed 1,000 characters. This restriction is defined in RFC 5321 - // (https://tools.ietf.org/html/rfc5321). + // - The message has to contain a header and a body, separated by one blank + // line. + // - All of the required header fields must be present in the message. + // - Each part of a multipart MIME message must be formatted properly. + // - If you include attachments, they must be in a file format that Amazon + // Pinpoint supports. + // - The entire message must be Base64 encoded. + // - If any of the MIME parts in your message contain content that is outside of + // the 7-bit ASCII character range, you should encode that content to ensure that + // recipients' email clients render the message properly. + // - The length of any single line of text in the message can't exceed 1,000 + // characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321) + // . Raw *RawMessage // The simple email message. The message consists of a subject and a message body. @@ -452,9 +425,9 @@ type EventDestination struct { // metrics. CloudWatchDestination *CloudWatchDestination - // If true, the event destination is enabled. When the event destination is + // If true , the event destination is enabled. When the event destination is // enabled, the specified event types are sent to the destinations in this - // EventDestinationDefinition. If false, the event destination is disabled. When + // EventDestinationDefinition . If false , the event destination is disabled. When // the event destination is disabled, events aren't sent to the specified // destinations. Enabled bool @@ -487,9 +460,9 @@ type EventDestinationDefinition struct { // metrics. CloudWatchDestination *CloudWatchDestination - // If true, the event destination is enabled. When the event destination is + // If true , the event destination is enabled. When the event destination is // enabled, the specified event types are sent to the destinations in this - // EventDestinationDefinition. If false, the event destination is disabled. When + // EventDestinationDefinition . If false , the event destination is disabled. When // the event destination is disabled, events aren't sent to the specified // destinations. Enabled bool @@ -500,7 +473,7 @@ type EventDestinationDefinition struct { KinesisFirehoseDestination *KinesisFirehoseDestination // An array that specifies which events Amazon Pinpoint should send to the - // destinations in this EventDestinationDefinition. + // destinations in this EventDestinationDefinition . MatchingEventTypes []EventType // An object that defines a Amazon Pinpoint destination for email events. You can @@ -522,14 +495,9 @@ type IdentityInfo struct { IdentityName *string // The email identity type. The identity type can be one of the following: - // - // * - // EMAIL_ADDRESS – The identity is an email address. - // - // * DOMAIN – The identity is a - // domain. - // - // * MANAGED_DOMAIN – The identity is a domain that is managed by AWS. + // - EMAIL_ADDRESS – The identity is an email address. + // - DOMAIN – The identity is a domain. + // - MANAGED_DOMAIN – The identity is a domain that is managed by AWS. IdentityType IdentityType // Indicates whether or not you can send email from the identity. In Amazon @@ -544,8 +512,8 @@ type IdentityInfo struct { // An object that contains information about the inbox placement data settings for // a verified domain that’s associated with your AWS account. This data is -// available only if you enabled the Deliverability dashboard for the domain -// (PutDeliverabilityDashboardOption operation). +// available only if you enabled the Deliverability dashboard for the domain ( +// PutDeliverabilityDashboardOption operation). type InboxPlacementTrackingOption struct { // Specifies whether inbox placement data is being tracked for the domain. @@ -594,12 +562,12 @@ type KinesisFirehoseDestination struct { // A list of attributes that are associated with a MAIL FROM domain. type MailFromAttributes struct { - // The action that Amazon Pinpoint to takes if it can't read the required MX record - // for a custom MAIL FROM domain. When you set this value to UseDefaultValue, - // Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this - // value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified + // The action that Amazon Pinpoint to takes if it can't read the required MX + // record for a custom MAIL FROM domain. When you set this value to UseDefaultValue + // , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this + // value to RejectMessage , Amazon Pinpoint returns a MailFromDomainNotVerified // error, and doesn't attempt to deliver the email. These behaviors are taken when - // the custom MAIL FROM domain configuration is in the Pending, Failed, and + // the custom MAIL FROM domain configuration is in the Pending , Failed , and // TemporaryFailure states. // // This member is required. @@ -610,21 +578,14 @@ type MailFromAttributes struct { // This member is required. MailFromDomain *string - // The status of the MAIL FROM domain. This status can have the following - // values: - // - // * PENDING – Amazon Pinpoint hasn't started searching for the MX record - // yet. - // - // * SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL - // FROM domain. - // - // * FAILED – Amazon Pinpoint can't find the required MX record, or - // the record no longer exists. - // - // * TEMPORARY_FAILURE – A temporary issue occurred, - // which prevented Amazon Pinpoint from determining the status of the MAIL FROM - // domain. + // The status of the MAIL FROM domain. This status can have the following values: + // - PENDING – Amazon Pinpoint hasn't started searching for the MX record yet. + // - SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM + // domain. + // - FAILED – Amazon Pinpoint can't find the required MX record, or the record no + // longer exists. + // - TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon + // Pinpoint from determining the status of the MAIL FROM domain. // // This member is required. MailFromDomainStatus MailFromDomainStatus @@ -632,8 +593,8 @@ type MailFromAttributes struct { noSmithyDocumentSerde } -// Represents the email message that you're sending. The Message object consists of -// a subject line and a message body. +// Represents the email message that you're sending. The Message object consists +// of a subject line and a message body. type Message struct { // The body of the message. You can specify an HTML version of the message, a @@ -644,8 +605,8 @@ type Message struct { // The subject line of the email. The subject line can only contain 7-bit ASCII // characters. However, you can specify non-ASCII characters in the subject line by - // using encoded-word syntax, as described in RFC 2047 - // (https://tools.ietf.org/html/rfc2047). + // using encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . // // This member is required. Subject *Content @@ -659,22 +620,18 @@ type MessageTag struct { // The name of the message tag. The message tag name has to meet the following // criteria: - // - // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), - // underscores (_), or dashes (-). - // - // * It can contain no more than 256 characters. + // - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. Name *string // The value of the message tag. The message tag value has to meet the following // criteria: - // - // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), - // underscores (_), or dashes (-). - // - // * It can contain no more than 256 characters. + // - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. Value *string @@ -724,8 +681,8 @@ type PlacementStatistics struct { // predictive inbox placement test. InboxPercentage *float64 - // The percentage of emails that didn't arrive in recipients' inboxes at all during - // the predictive inbox placement test. + // The percentage of emails that didn't arrive in recipients' inboxes at all + // during the predictive inbox placement test. MissingPercentage *float64 // The percentage of emails that arrived in recipients' spam or junk mail folders @@ -743,29 +700,18 @@ type PlacementStatistics struct { type RawMessage struct { // The raw email message. The message has to meet the following criteria: - // - // * The - // message has to contain a header and a body, separated by one blank line. - // - // * All - // of the required header fields must be present in the message. - // - // * Each part of a - // multipart MIME message must be formatted properly. - // - // * Attachments must be in a - // file format that Amazon Pinpoint supports. - // - // * The entire message must be Base64 - // encoded. - // - // * If any of the MIME parts in your message contain content that is - // outside of the 7-bit ASCII character range, you should encode that content to - // ensure that recipients' email clients render the message properly. - // - // * The length - // of any single line of text in the message can't exceed 1,000 characters. This - // restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321). + // - The message has to contain a header and a body, separated by one blank + // line. + // - All of the required header fields must be present in the message. + // - Each part of a multipart MIME message must be formatted properly. + // - Attachments must be in a file format that Amazon Pinpoint supports. + // - The entire message must be Base64 encoded. + // - If any of the MIME parts in your message contain content that is outside of + // the 7-bit ASCII character range, you should encode that content to ensure that + // recipients' email clients render the message properly. + // - The length of any single line of text in the message can't exceed 1,000 + // characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321) + // . // // This member is required. Data []byte @@ -782,18 +728,18 @@ type ReputationOptions struct { // are calculated starting from the date of the fresh start. LastFreshStart *time.Time - // If true, tracking of reputation metrics is enabled for the configuration set. If - // false, tracking of reputation metrics is disabled for the configuration set. + // If true , tracking of reputation metrics is enabled for the configuration set. + // If false , tracking of reputation metrics is disabled for the configuration set. ReputationMetricsEnabled bool noSmithyDocumentSerde } -// Used to enable or disable email sending for messages that use this configuration -// set in the current AWS Region. +// Used to enable or disable email sending for messages that use this +// configuration set in the current AWS Region. type SendingOptions struct { - // If true, email sending is enabled for the configuration set. If false, email + // If true , email sending is enabled for the configuration set. If false , email // sending is disabled for the configuration set. SendingEnabled bool @@ -826,8 +772,8 @@ type SnsDestination struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish // email events to. For more information about Amazon SNS topics, see the Amazon - // SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . // // This member is required. TopicArn *string @@ -846,27 +792,21 @@ type SnsDestination struct { // contain as many as 256 characters. The characters can be Unicode letters, // digits, white space, or one of the following symbols: _ . : / = + -. The // following additional restrictions apply to tags: -// -// * Tag keys and values are case -// sensitive. -// -// * For each associated resource, each tag key must be unique and it -// can have only one value. -// -// * The aws: prefix is reserved for use by AWS; you -// can’t use it in any tag keys or values that you define. In addition, you can't -// edit or remove tag keys or values that use this prefix. Tags that use this -// prefix don’t count against the limit of 50 tags per resource. -// -// * You can -// associate tags with public or shared resources, but the tags are available only -// for your AWS account, not any other accounts that share the resource. In -// addition, the tags are available only for resources that are located in the -// specified AWS Region for your AWS account. +// - Tag keys and values are case sensitive. +// - For each associated resource, each tag key must be unique and it can have +// only one value. +// - The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys +// or values that you define. In addition, you can't edit or remove tag keys or +// values that use this prefix. Tags that use this prefix don’t count against the +// limit of 50 tags per resource. +// - You can associate tags with public or shared resources, but the tags are +// available only for your AWS account, not any other accounts that share the +// resource. In addition, the tags are available only for resources that are +// located in the specified AWS Region for your AWS account. type Tag struct { - // One part of a key-value pair that defines a tag. The maximum length of a tag key - // is 128 characters. The minimum length is 1 character. + // One part of a key-value pair that defines a tag. The maximum length of a tag + // key is 128 characters. The minimum length is 1 character. // // This member is required. Key *string @@ -913,8 +853,8 @@ type TrackingOptions struct { noSmithyDocumentSerde } -// An object that contains information about the amount of email that was delivered -// to recipients. +// An object that contains information about the amount of email that was +// delivered to recipients. type VolumeStatistics struct { // The total number of emails that arrived in recipients' inboxes. diff --git a/service/pinpointsmsvoice/api_client.go b/service/pinpointsmsvoice/api_client.go index 45f12d76487..a6d78e9587f 100644 --- a/service/pinpointsmsvoice/api_client.go +++ b/service/pinpointsmsvoice/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pinpointsmsvoice/api_op_GetConfigurationSetEventDestinations.go b/service/pinpointsmsvoice/api_op_GetConfigurationSetEventDestinations.go index a10fc7864c1..5598d487e44 100644 --- a/service/pinpointsmsvoice/api_op_GetConfigurationSetEventDestinations.go +++ b/service/pinpointsmsvoice/api_op_GetConfigurationSetEventDestinations.go @@ -42,8 +42,8 @@ type GetConfigurationSetEventDestinationsInput struct { // An object that contains information about an event destination. type GetConfigurationSetEventDestinationsOutput struct { - // An array of EventDestination objects. Each EventDestination object includes ARNs - // and other information that define an event destination. + // An array of EventDestination objects. Each EventDestination object includes + // ARNs and other information that define an event destination. EventDestinations []types.EventDestination // Metadata pertaining to the operation's result. diff --git a/service/pinpointsmsvoice/api_op_SendVoiceMessage.go b/service/pinpointsmsvoice/api_op_SendVoiceMessage.go index ad98548a278..3c1ccdbb751 100644 --- a/service/pinpointsmsvoice/api_op_SendVoiceMessage.go +++ b/service/pinpointsmsvoice/api_op_SendVoiceMessage.go @@ -37,16 +37,16 @@ type SendVoiceMessageInput struct { // The name of the configuration set that you want to use to send the message. ConfigurationSetName *string - // An object that contains a voice message and information about the recipient that - // you want to send it to. + // An object that contains a voice message and information about the recipient + // that you want to send it to. Content *types.VoiceMessageContent // The phone number that you want to send the voice message to. DestinationPhoneNumber *string - // The phone number that Amazon Pinpoint should use to send the voice message. This - // isn't necessarily the phone number that appears on recipients' devices when they - // receive the message, because you can specify a CallerId parameter in the + // The phone number that Amazon Pinpoint should use to send the voice message. + // This isn't necessarily the phone number that appears on recipients' devices when + // they receive the message, because you can specify a CallerId parameter in the // request. OriginationPhoneNumber *string diff --git a/service/pinpointsmsvoice/types/enums.go b/service/pinpointsmsvoice/types/enums.go index 71bff24151c..2934295cd91 100644 --- a/service/pinpointsmsvoice/types/enums.go +++ b/service/pinpointsmsvoice/types/enums.go @@ -15,9 +15,9 @@ const ( EventTypeNoAnswer EventType = "NO_ANSWER" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "INITIATED_CALL", diff --git a/service/pinpointsmsvoice/types/types.go b/service/pinpointsmsvoice/types/types.go index 3aad8f4fc81..c4d4947cd36 100644 --- a/service/pinpointsmsvoice/types/types.go +++ b/service/pinpointsmsvoice/types/types.go @@ -21,8 +21,8 @@ type CallInstructionsMessageType struct { // to Amazon CloudWatch Logs. type CloudWatchLogsDestination struct { - // The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) - // role that is able to write event data to an Amazon CloudWatch destination. + // The Amazon Resource Name (ARN) of an Amazon Identity and Access Management + // (IAM) role that is able to write event data to an Amazon CloudWatch destination. IamRoleArn *string // The name of the Amazon CloudWatch Log Group that you want to record events in. @@ -47,8 +47,8 @@ type EventDestination struct { // to Amazon Kinesis Data Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination - // An array of EventDestination objects. Each EventDestination object includes ARNs - // and other information that define an event destination. + // An array of EventDestination objects. Each EventDestination object includes + // ARNs and other information that define an event destination. MatchingEventTypes []EventType // A name that identifies the event destination configuration. @@ -77,8 +77,8 @@ type EventDestinationDefinition struct { // to Amazon Kinesis Data Firehose. KinesisFirehoseDestination *KinesisFirehoseDestination - // An array of EventDestination objects. Each EventDestination object includes ARNs - // and other information that define an event destination. + // An array of EventDestination objects. Each EventDestination object includes + // ARNs and other information that define an event destination. MatchingEventTypes []EventType // An object that contains information about an event destination that sends data @@ -148,8 +148,8 @@ type SSMLMessageType struct { noSmithyDocumentSerde } -// An object that contains a voice message and information about the recipient that -// you want to send it to. +// An object that contains a voice message and information about the recipient +// that you want to send it to. type VoiceMessageContent struct { // An object that defines a message that contains text formatted using Amazon diff --git a/service/pinpointsmsvoicev2/api_client.go b/service/pinpointsmsvoicev2/api_client.go index 8d5c128e0f2..2a0ee2bf38e 100644 --- a/service/pinpointsmsvoicev2/api_client.go +++ b/service/pinpointsmsvoicev2/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go b/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go index f07db0fdcb2..63b7a56f214 100644 --- a/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go +++ b/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go @@ -41,14 +41,14 @@ type AssociateOriginationIdentityInput struct { // The origination identity to use, such as PhoneNumberId, PhoneNumberArn, // SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values - // for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get - // the values for SenderId and SenderIdArn. + // for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to + // get the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string - // The pool to update with the new Identity. This value can be either the PoolId or - // PoolArn, and you can find these values using DescribePools. + // The pool to update with the new Identity. This value can be either the PoolId + // or PoolArn, and you can find these values using DescribePools . // // This member is required. PoolId *string diff --git a/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go b/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go index 1b82413b3b4..50e7b4869b1 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go +++ b/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go @@ -13,10 +13,10 @@ import ( "time" ) -// Creates a new configuration set. After you create the configuration set, you can -// add one or more event destinations to it. A configuration set is a set of rules -// that you apply to the SMS and voice messages that you send. When you send a -// message, you can optionally specify a single configuration set. +// Creates a new configuration set. After you create the configuration set, you +// can add one or more event destinations to it. A configuration set is a set of +// rules that you apply to the SMS and voice messages that you send. When you send +// a message, you can optionally specify a single configuration set. func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error) { if params == nil { params = &CreateConfigurationSetInput{} @@ -44,8 +44,8 @@ type CreateConfigurationSetInput struct { // used for the request to ensure idempotency. ClientToken *string - // An array of key and value pair tags that's associated with the new configuration - // set. + // An array of key and value pair tags that's associated with the new + // configuration set. Tags []types.Tag noSmithyDocumentSerde @@ -59,8 +59,8 @@ type CreateConfigurationSetOutput struct { // The name of the new configuration set. ConfigurationSetName *string - // The time when the configuration set was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the configuration set was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // An array of key and value pair tags that's associated with the configuration diff --git a/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go b/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go index ac6eb6a24fa..2ebd1bc75d2 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go +++ b/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go @@ -13,13 +13,12 @@ import ( "time" ) -// Creates a new opt-out list. If the opt-out list name already exists, an Error is -// returned. An opt-out list is a list of phone numbers that are opted out, meaning -// you can't send SMS or voice messages to them. If end user replies with the -// keyword "STOP," an entry for the phone number is added to the opt-out list. In -// addition to STOP, your recipients can use any supported opt-out keyword, such as -// CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout) +// Creates a new opt-out list. If the opt-out list name already exists, an Error +// is returned. An opt-out list is a list of phone numbers that are opted out, +// meaning you can't send SMS or voice messages to them. If end user replies with +// the keyword "STOP," an entry for the phone number is added to the opt-out list. +// In addition to STOP, your recipients can use any supported opt-out keyword, such +// as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout) // in the Amazon Pinpoint User Guide. func (c *Client) CreateOptOutList(ctx context.Context, params *CreateOptOutListInput, optFns ...func(*Options)) (*CreateOptOutListOutput, error) { if params == nil { @@ -56,8 +55,8 @@ type CreateOptOutListInput struct { type CreateOptOutListOutput struct { - // The time when the pool was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // The Amazon Resource Name (ARN) for the OptOutList. diff --git a/service/pinpointsmsvoicev2/api_op_CreatePool.go b/service/pinpointsmsvoicev2/api_op_CreatePool.go index 8777b8bd7e0..0f2d71385f6 100644 --- a/service/pinpointsmsvoicev2/api_op_CreatePool.go +++ b/service/pinpointsmsvoicev2/api_op_CreatePool.go @@ -53,9 +53,9 @@ type CreatePoolInput struct { MessageType types.MessageType // The origination identity to use such as a PhoneNumberId, PhoneNumberArn, - // SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for - // PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the - // values for SenderId and SenderIdArn. + // SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values + // for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get + // the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string @@ -65,8 +65,8 @@ type CreatePoolInput struct { // used for the request to ensure idempotency. ClientToken *string - // By default this is set to false. When set to true the pool can't be deleted. You - // can change this value using the UpdatePool action. + // By default this is set to false. When set to true the pool can't be deleted. + // You can change this value using the UpdatePool action. DeletionProtectionEnabled *bool // An array of tags (key and value pairs) associated with the pool. @@ -77,8 +77,8 @@ type CreatePoolInput struct { type CreatePoolOutput struct { - // The time when the pool was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // When set to true deletion protection is enabled. By default this is set to @@ -109,14 +109,10 @@ type CreatePoolOutput struct { SharedRoutesEnabled bool // The current status of the pool. - // - // * CREATING: The pool is currently being created - // and isn't yet available for use. - // - // * ACTIVE: The pool is active and available for - // use. - // - // * DELETING: The pool is being deleted. + // - CREATING: The pool is currently being created and isn't yet available for + // use. + // - ACTIVE: The pool is active and available for use. + // - DELETING: The pool is being deleted. Status types.PoolStatus // An array of tags (key and value pairs) associated with the pool. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go b/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go index bf399d90e3f..a061c5f2718 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go @@ -51,8 +51,8 @@ type DeleteConfigurationSetOutput struct { // The name of the deleted configuration set. ConfigurationSetName *string - // The time that the deleted configuration set was created in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time that the deleted configuration set was created in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // The default message type of the configuration set that was deleted. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go b/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go index df135b2f88d..5a392ecdd02 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go @@ -42,8 +42,8 @@ type DeleteOptOutListInput struct { type DeleteOptOutListOutput struct { - // The time when the OptOutList was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the OptOutList was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // The Amazon Resource Name (ARN) of the OptOutList that was removed. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go b/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go index 4c5567ebed2..64451938bb0 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go @@ -59,8 +59,8 @@ type DeleteOptedOutNumberOutput struct { // The phone number that was removed from the OptOutList. OptedOutNumber *string - // The time that the number was removed at, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time that the number was removed at, in UNIX epoch time (https://www.epochconverter.com/) + // format. OptedOutTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/pinpointsmsvoicev2/api_op_DeletePool.go b/service/pinpointsmsvoicev2/api_op_DeletePool.go index b01805e70ea..a3892d211c2 100644 --- a/service/pinpointsmsvoicev2/api_op_DeletePool.go +++ b/service/pinpointsmsvoicev2/api_op_DeletePool.go @@ -45,8 +45,8 @@ type DeletePoolInput struct { type DeletePoolOutput struct { - // The time when the pool was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // The message type that was associated with the deleted pool. @@ -73,14 +73,10 @@ type DeletePoolOutput struct { SharedRoutesEnabled bool // The current status of the pool. - // - // * CREATING: The pool is currently being created - // and isn't yet available for use. - // - // * ACTIVE: The pool is active and available for - // use. - // - // * DELETING: The pool is being deleted. + // - CREATING: The pool is currently being created and isn't yet available for + // use. + // - ACTIVE: The pool is active and available for use. + // - DELETING: The pool is being deleted. Status types.PoolStatus // The Amazon Resource Name (ARN) of the TwoWayChannel. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go index 0c94a2cc7e8..76c5092b953 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go @@ -12,10 +12,9 @@ import ( // Deletes an account-level monthly spending limit override for sending text // messages. Deleting a spend limit override will set the EnforcedLimit to equal -// the MaxLimit, which is controlled by Amazon Web Services. For more information -// on spend limits (quotas) see Amazon Pinpoint quotas -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the -// Amazon Pinpoint Developer Guide. +// the MaxLimit , which is controlled by Amazon Web Services. For more information +// on spend limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) +// in the Amazon Pinpoint Developer Guide. func (c *Client) DeleteTextMessageSpendLimitOverride(ctx context.Context, params *DeleteTextMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteTextMessageSpendLimitOverrideOutput, error) { if params == nil { params = &DeleteTextMessageSpendLimitOverrideInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go index 843a6b38d31..ad057961021 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go @@ -12,10 +12,9 @@ import ( // Deletes an account level monthly spend limit override for sending voice // messages. Deleting a spend limit override sets the EnforcedLimit equal to the -// MaxLimit, which is controlled by Amazon Web Services. For more information on -// spending limits (quotas) see Amazon Pinpoint quotas -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the -// Amazon Pinpoint Developer Guide. +// MaxLimit , which is controlled by Amazon Web Services. For more information on +// spending limits (quotas) see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) +// in the Amazon Pinpoint Developer Guide. func (c *Client) DeleteVoiceMessageSpendLimitOverride(ctx context.Context, params *DeleteVoiceMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteVoiceMessageSpendLimitOverrideOutput, error) { if params == nil { params = &DeleteVoiceMessageSpendLimitOverrideInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go b/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go index d754456d6e9..2caa833aa1c 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go @@ -17,9 +17,8 @@ import ( // toward that quota, and the quota's maximum value. When you establish an Amazon // Web Services account, the account has initial quotas on the maximum number of // configuration sets, opt-out lists, phone numbers, and pools that you can create -// in a given Region. For more information see Amazon Pinpoint quotas -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) in the -// Amazon Pinpoint Developer Guide. +// in a given Region. For more information see Amazon Pinpoint quotas (https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html) +// in the Amazon Pinpoint Developer Guide. func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go b/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go index b11e0bce5ec..83afaf0b6bc 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go @@ -37,9 +37,9 @@ func (c *Client) DescribeKeywords(ctx context.Context, params *DescribeKeywordsI type DescribeKeywordsInput struct { // The origination identity to use such as a PhoneNumberId, PhoneNumberArn, - // SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for - // PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the - // values for SenderId and SenderIdArn. + // SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values + // for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get + // the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string diff --git a/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go b/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go index 3659998b512..9447727f77c 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go @@ -125,8 +125,8 @@ func (c *Client) addOperationDescribeOptOutListsMiddlewares(stack *middleware.St return nil } -// DescribeOptOutListsAPIClient is a client that implements the DescribeOptOutLists -// operation. +// DescribeOptOutListsAPIClient is a client that implements the +// DescribeOptOutLists operation. type DescribeOptOutListsAPIClient interface { DescribeOptOutLists(context.Context, *DescribeOptOutListsInput, ...func(*Options)) (*DescribeOptOutListsOutput, error) } diff --git a/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go b/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go index a4351990c2e..dfd784a8b55 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go @@ -12,12 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the current Amazon Pinpoint monthly spend limits for sending voice and -// text messages. When you establish an Amazon Web Services account, the account -// has initial monthly spend limit in a given Region. For more information on -// increasing your monthly spend limit, see Requesting increases to your monthly -// SMS spending quota for Amazon Pinpoint -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) +// Describes the current Amazon Pinpoint monthly spend limits for sending voice +// and text messages. When you establish an Amazon Web Services account, the +// account has initial monthly spend limit in a given Region. For more information +// on increasing your monthly spend limit, see Requesting increases to your +// monthly SMS spending quota for Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) // in the Amazon Pinpoint User Guide. func (c *Client) DescribeSpendLimits(ctx context.Context, params *DescribeSpendLimitsInput, optFns ...func(*Options)) (*DescribeSpendLimitsOutput, error) { if params == nil { @@ -122,8 +121,8 @@ func (c *Client) addOperationDescribeSpendLimitsMiddlewares(stack *middleware.St return nil } -// DescribeSpendLimitsAPIClient is a client that implements the DescribeSpendLimits -// operation. +// DescribeSpendLimitsAPIClient is a client that implements the +// DescribeSpendLimits operation. type DescribeSpendLimitsAPIClient interface { DescribeSpendLimits(context.Context, *DescribeSpendLimitsInput, ...func(*Options)) (*DescribeSpendLimitsOutput, error) } diff --git a/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go b/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go index 0b7ca4e0b75..289d1e89726 100644 --- a/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go +++ b/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go @@ -38,8 +38,8 @@ type DisassociateOriginationIdentityInput struct { // The origination identity to use such as a PhoneNumberId, PhoneNumberArn, // SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for - // PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for - // SenderId and SenderIdArn. + // PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values + // for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string diff --git a/service/pinpointsmsvoicev2/api_op_PutKeyword.go b/service/pinpointsmsvoicev2/api_op_PutKeyword.go index c8d276b483a..28141fcbba7 100644 --- a/service/pinpointsmsvoicev2/api_op_PutKeyword.go +++ b/service/pinpointsmsvoicev2/api_op_PutKeyword.go @@ -41,14 +41,9 @@ type PutKeywordInput struct { Keyword *string // The message associated with the keyword. - // - // * AUTOMATIC_RESPONSE: A message is - // sent to the recipient. - // - // * OPT_OUT: Keeps the recipient from receiving future - // messages. - // - // * OPT_IN: The recipient wants to receive future messages. + // - AUTOMATIC_RESPONSE: A message is sent to the recipient. + // - OPT_OUT: Keeps the recipient from receiving future messages. + // - OPT_IN: The recipient wants to receive future messages. // // This member is required. KeywordMessage *string diff --git a/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go b/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go index 304cd2ce9b2..aaa2a68566f 100644 --- a/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go +++ b/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go @@ -58,8 +58,8 @@ type PutOptedOutNumberOutput struct { // The phone number that was added to the OptOutList. OptedOutNumber *string - // The time that the phone number was added to the OptOutList, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time that the phone number was added to the OptOutList, in UNIX epoch time (https://www.epochconverter.com/) + // format. OptedOutTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go b/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go index 486869d0eb0..ca689dee156 100644 --- a/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go @@ -44,8 +44,8 @@ type ReleasePhoneNumberInput struct { type ReleasePhoneNumberOutput struct { - // The time when the phone number was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. diff --git a/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go b/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go index b27eeb4a8ec..7119d468983 100644 --- a/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go @@ -14,8 +14,7 @@ import ( ) // Request an origination phone number for use in your account. For more -// information on phone number request see Requesting a number -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html) +// information on phone number request see Requesting a number (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html) // in the Amazon Pinpoint User Guide. func (c *Client) RequestPhoneNumber(ctx context.Context, params *RequestPhoneNumberInput, optFns ...func(*Options)) (*RequestPhoneNumberOutput, error) { if params == nil { @@ -46,8 +45,8 @@ type RequestPhoneNumberInput struct { // This member is required. MessageType types.MessageType - // Indicates if the phone number will be used for text messages, voice messages, or - // both. + // Indicates if the phone number will be used for text messages, voice messages, + // or both. // // This member is required. NumberCapabilities []types.NumberCapability @@ -85,8 +84,8 @@ type RequestPhoneNumberInput struct { type RequestPhoneNumberOutput struct { - // The time when the phone number was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // By default this is set to false. When set to true the phone number can't be diff --git a/service/pinpointsmsvoicev2/api_op_SendTextMessage.go b/service/pinpointsmsvoicev2/api_op_SendTextMessage.go index 18473f8999e..366394d2640 100644 --- a/service/pinpointsmsvoicev2/api_op_SendTextMessage.go +++ b/service/pinpointsmsvoicev2/api_op_SendTextMessage.go @@ -15,8 +15,7 @@ import ( // throughput limits are measured in Message Parts per Second (MPS). Your MPS limit // depends on the destination country of your messages, as well as the type of // phone number (origination number) that you use to send the message. For more -// information, see Message Parts per Second (MPS) limits -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-mps.html) +// information, see Message Parts per Second (MPS) limits (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-mps.html) // in the Amazon Pinpoint User Guide. func (c *Client) SendTextMessage(ctx context.Context, params *SendTextMessageInput, optFns ...func(*Options)) (*SendTextMessageOutput, error) { if params == nil { @@ -44,15 +43,15 @@ type SendTextMessageInput struct { // ConfigurationSetName or ConfigurationSetArn. ConfigurationSetName *string - // You can specify custom data in this field. If you do, that data is logged to the - // event destination. + // You can specify custom data in this field. If you do, that data is logged to + // the event destination. Context map[string]string // This field is used for any country-specific registration requirements. // Currently, this setting is only used when you send messages to recipients in // India using a sender ID. For more information see Special requirements for - // sending SMS messages to recipients in India - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html). + // sending SMS messages to recipients in India (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html) + // . DestinationCountryParameters map[string]string // When set to true, the message is checked and validated, but isn't sent to the diff --git a/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go b/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go index 92df4ed6b79..8f3139c049f 100644 --- a/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go +++ b/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go @@ -36,8 +36,8 @@ type SendVoiceMessageInput struct { // This member is required. DestinationPhoneNumber *string - // The origination identity to use for the voice call. This can be the PhoneNumber, - // PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn. + // The origination identity to use for the voice call. This can be the + // PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn. // // This member is required. OriginationIdentity *string @@ -46,8 +46,8 @@ type SendVoiceMessageInput struct { // ConfigurationSetName or ConfigurationSetArn. ConfigurationSetName *string - // You can specify custom data in this field. If you do, that data is logged to the - // event destination. + // You can specify custom data in this field. If you do, that data is logged to + // the event destination. Context map[string]string // When set to true, the message is checked and validated, but isn't sent to the @@ -61,22 +61,17 @@ type SendVoiceMessageInput struct { MessageBody *string // Specifies if the MessageBody field contains text or speech synthesis markup - // language (SSML) (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). - // - // * - // TEXT: This is the default value. When used the maximum character limit is - // 3000. - // - // * SSML: When used the maximum character limit is 6000 including SSML - // tagging. + // language (SSML) (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) . + // - TEXT: This is the default value. When used the maximum character limit is + // 3000. + // - SSML: When used the maximum character limit is 6000 including SSML tagging. MessageBodyTextType types.VoiceMessageBodyTextType // How long the voice message is valid for. By default this is 72 hours. TimeToLive *int32 - // The voice for the Amazon Polly - // (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) service to use. By - // default this is set to "MATTHEW". + // The voice for the Amazon Polly (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) + // service to use. By default this is set to "MATTHEW". VoiceId types.VoiceId noSmithyDocumentSerde diff --git a/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go b/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go index b6ba538b6d6..2d848b55412 100644 --- a/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go +++ b/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the default message type on a configuration set. Choose the category of SMS -// messages that you plan to send from this account. If you send account-related -// messages or time-sensitive messages such as one-time passcodes, choose -// Transactional. If you plan to send messages that contain marketing material or -// other promotional content, choose Promotional. This setting applies to your -// entire Amazon Web Services account. +// Sets the default message type on a configuration set. Choose the category of +// SMS messages that you plan to send from this account. If you send +// account-related messages or time-sensitive messages such as one-time passcodes, +// choose Transactional. If you plan to send messages that contain marketing +// material or other promotional content, choose Promotional. This setting applies +// to your entire Amazon Web Services account. func (c *Client) SetDefaultMessageType(ctx context.Context, params *SetDefaultMessageTypeInput, optFns ...func(*Options)) (*SetDefaultMessageTypeOutput, error) { if params == nil { params = &SetDefaultMessageTypeInput{} diff --git a/service/pinpointsmsvoicev2/api_op_SetTextMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_SetTextMessageSpendLimitOverride.go index 9e02c4b0bb6..6bd1ca87a61 100644 --- a/service/pinpointsmsvoicev2/api_op_SetTextMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_SetTextMessageSpendLimitOverride.go @@ -11,7 +11,7 @@ import ( ) // Sets an account level monthly spend limit override for sending text messages. -// The requested spend limit must be less than or equal to the MaxLimit, which is +// The requested spend limit must be less than or equal to the MaxLimit , which is // set by Amazon Web Services. func (c *Client) SetTextMessageSpendLimitOverride(ctx context.Context, params *SetTextMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*SetTextMessageSpendLimitOverrideOutput, error) { if params == nil { diff --git a/service/pinpointsmsvoicev2/api_op_SetVoiceMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_SetVoiceMessageSpendLimitOverride.go index 975a4d3a811..e4811413b6c 100644 --- a/service/pinpointsmsvoicev2/api_op_SetVoiceMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_SetVoiceMessageSpendLimitOverride.go @@ -11,7 +11,7 @@ import ( ) // Sets an account level monthly spend limit override for sending voice messages. -// The requested spend limit must be less than or equal to the MaxLimit, which is +// The requested spend limit must be less than or equal to the MaxLimit , which is // set by Amazon Web Services. func (c *Client) SetVoiceMessageSpendLimitOverride(ctx context.Context, params *SetVoiceMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*SetVoiceMessageSpendLimitOverrideOutput, error) { if params == nil { diff --git a/service/pinpointsmsvoicev2/api_op_TagResource.go b/service/pinpointsmsvoicev2/api_op_TagResource.go index 0002f4948b9..b08704d08b5 100644 --- a/service/pinpointsmsvoicev2/api_op_TagResource.go +++ b/service/pinpointsmsvoicev2/api_op_TagResource.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS -// Voice, version 2 resource. When you specify an existing tag key, the value is -// overwritten with the new value. Each resource can have a maximum of 50 tags. +// Adds or overwrites only the specified tags for the specified Amazon Pinpoint +// SMS Voice, version 2 resource. When you specify an existing tag key, the value +// is overwritten with the new value. Each resource can have a maximum of 50 tags. // Each tag consists of a key and an optional value. Tag keys must be unique per -// resource. For more information about tags, see Tagging Amazon Pinpoint -// resources -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) +// resource. For more information about tags, see Tagging Amazon Pinpoint resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) // in the Amazon Pinpoint Developer Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/pinpointsmsvoicev2/api_op_UntagResource.go b/service/pinpointsmsvoicev2/api_op_UntagResource.go index 7bdb85e1d59..ffffa740f53 100644 --- a/service/pinpointsmsvoicev2/api_op_UntagResource.go +++ b/service/pinpointsmsvoicev2/api_op_UntagResource.go @@ -11,8 +11,7 @@ import ( ) // Removes the association of the specified tags from an Amazon Pinpoint SMS Voice -// V2 resource. For more information on tags see Tagging Amazon Pinpoint resources -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) +// V2 resource. For more information on tags see Tagging Amazon Pinpoint resources (https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html) // in the Amazon Pinpoint Developer Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go b/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go index 4642bd46e9a..09f29af967d 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go +++ b/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an existing event destination in a configuration set. You can update the -// IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable -// or disable the event destination. You may want to update an event destination to -// change its matching event types or updating the destination resource ARN. You -// can't change an event destination's type between CloudWatch Logs, Kinesis Data -// Firehose, and Amazon SNS. +// Updates an existing event destination in a configuration set. You can update +// the IAM role ARN for CloudWatch Logs and Kinesis Data Firehose. You can also +// enable or disable the event destination. You may want to update an event +// destination to change its matching event types or updating the destination +// resource ARN. You can't change an event destination's type between CloudWatch +// Logs, Kinesis Data Firehose, and Amazon SNS. func (c *Client) UpdateEventDestination(ctx context.Context, params *UpdateEventDestinationInput, optFns ...func(*Options)) (*UpdateEventDestinationOutput, error) { if params == nil { params = &UpdateEventDestinationInput{} @@ -34,8 +34,8 @@ func (c *Client) UpdateEventDestination(ctx context.Context, params *UpdateEvent type UpdateEventDestinationInput struct { - // The configuration set to update with the new event destination. Valid values for - // this can be the ConfigurationSetName or ConfigurationSetArn. + // The configuration set to update with the new event destination. Valid values + // for this can be the ConfigurationSetName or ConfigurationSetArn. // // This member is required. ConfigurationSetName *string diff --git a/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go b/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go index ecf5879c100..d5bc34e033a 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go @@ -68,8 +68,8 @@ type UpdatePhoneNumberInput struct { type UpdatePhoneNumberOutput struct { - // The time when the phone number was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // When set to true the phone number can't be deleted. diff --git a/service/pinpointsmsvoicev2/api_op_UpdatePool.go b/service/pinpointsmsvoicev2/api_op_UpdatePool.go index c3613d369cc..80c23975fd3 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdatePool.go +++ b/service/pinpointsmsvoicev2/api_op_UpdatePool.go @@ -13,7 +13,7 @@ import ( ) // Updates the configuration of an existing pool. You can update the opt-out list, -// enable or disable two-way messaging, change the TwoWayChannelArn, enable or +// enable or disable two-way messaging, change the TwoWayChannelArn , enable or // disable self-managed opt-outs, enable or disable deletion protection, and enable // or disable shared routes. func (c *Client) UpdatePool(ctx context.Context, params *UpdatePoolInput, optFns ...func(*Options)) (*UpdatePoolOutput, error) { @@ -69,8 +69,8 @@ type UpdatePoolInput struct { type UpdatePoolOutput struct { - // The time when the pool was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. CreatedTimestamp *time.Time // When set to true the pool can't be deleted. diff --git a/service/pinpointsmsvoicev2/doc.go b/service/pinpointsmsvoicev2/doc.go index d9ca9249597..712f7b630b8 100644 --- a/service/pinpointsmsvoicev2/doc.go +++ b/service/pinpointsmsvoicev2/doc.go @@ -11,12 +11,11 @@ // Voice, version 2 API provides programmatic access to options that are unique to // the SMS and voice channels and supplements the resources provided by the Amazon // Pinpoint API. If you're new to Amazon Pinpoint, it's also helpful to review the -// Amazon Pinpoint Developer Guide -// (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). The -// Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures -// that demonstrate how to use Amazon Pinpoint features programmatically and how to -// integrate Amazon Pinpoint functionality into mobile apps and other types of -// applications. The guide also provides key information, such as Amazon Pinpoint -// integration with other Amazon Web Services services, and the quotas that apply -// to use of the service. +// Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html) +// . The Amazon Pinpoint Developer Guide provides tutorials, code samples, and +// procedures that demonstrate how to use Amazon Pinpoint features programmatically +// and how to integrate Amazon Pinpoint functionality into mobile apps and other +// types of applications. The guide also provides key information, such as Amazon +// Pinpoint integration with other Amazon Web Services services, and the quotas +// that apply to use of the service. package pinpointsmsvoicev2 diff --git a/service/pinpointsmsvoicev2/types/enums.go b/service/pinpointsmsvoicev2/types/enums.go index 95b773ac027..361e7919d05 100644 --- a/service/pinpointsmsvoicev2/types/enums.go +++ b/service/pinpointsmsvoicev2/types/enums.go @@ -182,9 +182,9 @@ const ( EventTypeVoiceTtlExpired EventType = "VOICE_TTL_EXPIRED" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "ALL", @@ -298,9 +298,9 @@ const ( NumberStatusDeleted NumberStatus = "DELETED" ) -// Values returns all known values for NumberStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for NumberStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (NumberStatus) Values() []NumberStatus { return []NumberStatus{ "PENDING", @@ -364,8 +364,8 @@ const ( PhoneNumberFilterNameDeletionProtectionEnabled PhoneNumberFilterName = "deletion-protection-enabled" ) -// Values returns all known values for PhoneNumberFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PhoneNumberFilterName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberFilterName) Values() []PhoneNumberFilterName { return []PhoneNumberFilterName{ @@ -457,8 +457,8 @@ const ( RequestableNumberTypeTenDlc RequestableNumberType = "TEN_DLC" ) -// Values returns all known values for RequestableNumberType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RequestableNumberType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RequestableNumberType) Values() []RequestableNumberType { return []RequestableNumberType{ @@ -484,9 +484,9 @@ const ( ResourceTypeRegistration ResourceType = "registration" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "account", @@ -783,9 +783,9 @@ const ( VoiceMessageBodyTextTypeSsml VoiceMessageBodyTextType = "SSML" ) -// Values returns all known values for VoiceMessageBodyTextType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VoiceMessageBodyTextType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceMessageBodyTextType) Values() []VoiceMessageBodyTextType { return []VoiceMessageBodyTextType{ "TEXT", diff --git a/service/pinpointsmsvoicev2/types/types.go b/service/pinpointsmsvoicev2/types/types.go index eac5d5d3aed..01e5481937d 100644 --- a/service/pinpointsmsvoicev2/types/types.go +++ b/service/pinpointsmsvoicev2/types/types.go @@ -48,8 +48,8 @@ type AccountLimit struct { // events. type CloudWatchLogsDestination struct { - // The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) - // role that is able to write event data to an Amazon CloudWatch destination. + // The Amazon Resource Name (ARN) of an Amazon Identity and Access Management + // (IAM) role that is able to write event data to an Amazon CloudWatch destination. // // This member is required. IamRoleArn *string @@ -92,8 +92,8 @@ type ConfigurationSetInformation struct { // This member is required. ConfigurationSetName *string - // The time when the ConfigurationSet was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the ConfigurationSet was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. // // This member is required. CreatedTimestamp *time.Time @@ -237,8 +237,8 @@ type OptedOutNumberInformation struct { // This member is required. OptedOutNumber *string - // The time that the op tout occurred, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time that the op tout occurred, in UNIX epoch time (https://www.epochconverter.com/) + // format. // // This member is required. OptedOutTimestamp *time.Time @@ -249,8 +249,8 @@ type OptedOutNumberInformation struct { // The information for all OptOutList in an Amazon Web Services account. type OptOutListInformation struct { - // The time when the OutOutList was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the OutOutList was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. // // This member is required. CreatedTimestamp *time.Time @@ -276,8 +276,8 @@ type OriginationIdentityMetadata struct { // This member is required. IsoCountryCode *string - // Describes if the origination identity can be used for text messages, voice calls - // or both. + // Describes if the origination identity can be used for text messages, voice + // calls or both. // // This member is required. NumberCapabilities []NumberCapability @@ -314,8 +314,8 @@ type PhoneNumberFilter struct { // The information for a phone number in an Amazon Web Services account. type PhoneNumberInformation struct { - // The time when the phone number was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. // // This member is required. CreatedTimestamp *time.Time @@ -342,8 +342,8 @@ type PhoneNumberInformation struct { // This member is required. MonthlyLeasingPrice *string - // Describes if the origination identity can be used for text messages, voice calls - // or both. + // Describes if the origination identity can be used for text messages, voice + // calls or both. // // This member is required. NumberCapabilities []NumberCapability @@ -368,13 +368,12 @@ type PhoneNumberInformation struct { // This member is required. PhoneNumberArn *string - // When set to false an end recipient sends a message that begins with HELP or STOP - // to one of your dedicated numbers, Amazon Pinpoint automatically replies with a - // customizable message and adds the end recipient to the OptOutList. When set to - // true you're responsible for responding to HELP and STOP requests. You're also - // responsible for tracking and honoring opt-out request. For more information see - // Self-managed opt-outs - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) + // When set to false an end recipient sends a message that begins with HELP or + // STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies + // with a customizable message and adds the end recipient to the OptOutList. When + // set to true you're responsible for responding to HELP and STOP requests. You're + // also responsible for tracking and honoring opt-out request. For more information + // see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) // // This member is required. SelfManagedOptOutsEnabled bool @@ -421,8 +420,8 @@ type PoolFilter struct { // The information for a pool in an Amazon Web Services account. type PoolInformation struct { - // The time when the pool was created, in UNIX epoch time - // (https://www.epochconverter.com/) format. + // The time when the pool was created, in UNIX epoch time (https://www.epochconverter.com/) + // format. // // This member is required. CreatedTimestamp *time.Time @@ -459,18 +458,17 @@ type PoolInformation struct { // with a customizable message and adds the end recipient to the OptOutList. When // set to true you're responsible for responding to HELP and STOP requests. You're // also responsible for tracking and honoring opt-out requests. For more - // information see Self-managed opt-outs - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) + // information see Self-managed opt-outs (https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out) // // This member is required. SelfManagedOptOutsEnabled bool // Allows you to enable shared routes on your pool. By default, this is set to - // False. If you set this value to True, your messages are sent using phone numbers - // or sender IDs (depending on the country) that are shared with other Amazon - // Pinpoint users. In some countries, such as the United States, senders aren't - // allowed to use shared routes and must use a dedicated phone number or short - // code. + // False . If you set this value to True , your messages are sent using phone + // numbers or sender IDs (depending on the country) that are shared with other + // Amazon Pinpoint users. In some countries, such as the United States, senders + // aren't allowed to use shared routes and must use a dedicated phone number or + // short code. // // This member is required. SharedRoutesEnabled bool @@ -480,8 +478,8 @@ type PoolInformation struct { // This member is required. Status PoolStatus - // When set to true you can receive incoming text messages from your end recipients - // using the TwoWayChannelArn. + // When set to true you can receive incoming text messages from your end + // recipients using the TwoWayChannelArn. // // This member is required. TwoWayEnabled bool @@ -511,8 +509,7 @@ type PoolOriginationIdentitiesFilter struct { // The alphanumeric sender ID in a specific country that you want to describe. For // more information on sender IDs see Requesting sender IDs for SMS messaging with -// Amazon Pinpoint -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html) +// Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html) // in the Amazon Pinpoint User Guide. type SenderIdAndCountry struct { @@ -591,16 +588,15 @@ type SnsDestination struct { noSmithyDocumentSerde } -// Describes the current Amazon Pinpoint monthly spend limits for sending voice and -// text messages. For more information on increasing your monthly spend limit, see -// Requesting increases to your monthly SMS spending quota for Amazon Pinpoint -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) +// Describes the current Amazon Pinpoint monthly spend limits for sending voice +// and text messages. For more information on increasing your monthly spend limit, +// see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html) // in the Amazon Pinpoint User Guide. type SpendLimit struct { // The maximum amount of money, in US dollars, that you want to be able to spend // sending messages each month. This value has to be less than or equal to the - // amount in MaxLimit. To use this custom limit, Overridden must be set to true. + // amount in MaxLimit . To use this custom limit, Overridden must be set to true. // // This member is required. EnforcedLimit int64 @@ -616,9 +612,9 @@ type SpendLimit struct { // This member is required. Name SpendLimitName - // When set to True, the value that has been specified in the EnforcedLimit is used - // to determine the maximum amount in US dollars that can be spent to send messages - // each month, in US dollars. + // When set to True , the value that has been specified in the EnforcedLimit is + // used to determine the maximum amount in US dollars that can be spent to send + // messages each month, in US dollars. // // This member is required. Overridden bool diff --git a/service/pipes/api_client.go b/service/pipes/api_client.go index a9e54df9688..f619e6f582f 100644 --- a/service/pipes/api_client.go +++ b/service/pipes/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pipes/api_op_CreatePipe.go b/service/pipes/api_op_CreatePipe.go index d5b57a94f80..c331ce9d700 100644 --- a/service/pipes/api_op_CreatePipe.go +++ b/service/pipes/api_op_CreatePipe.go @@ -89,8 +89,8 @@ type CreatePipeOutput struct { // The state the pipe should be in. DesiredState types.RequestedPipeState - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_DeletePipe.go b/service/pipes/api_op_DeletePipe.go index a03945101b1..f1a75c84829 100644 --- a/service/pipes/api_op_DeletePipe.go +++ b/service/pipes/api_op_DeletePipe.go @@ -13,9 +13,8 @@ import ( ) // Delete an existing pipe. For more information about pipes, see Amazon -// EventBridge Pipes -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the -// Amazon EventBridge User Guide. +// EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) +// in the Amazon EventBridge User Guide. func (c *Client) DeletePipe(ctx context.Context, params *DeletePipeInput, optFns ...func(*Options)) (*DeletePipeOutput, error) { if params == nil { params = &DeletePipeInput{} @@ -55,8 +54,8 @@ type DeletePipeOutput struct { // The state the pipe should be in. DesiredState types.RequestedPipeStateDescribeResponse - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_DescribePipe.go b/service/pipes/api_op_DescribePipe.go index f94dc888df7..bbc8f21f702 100644 --- a/service/pipes/api_op_DescribePipe.go +++ b/service/pipes/api_op_DescribePipe.go @@ -13,9 +13,8 @@ import ( ) // Get the information about an existing pipe. For more information about pipes, -// see Amazon EventBridge Pipes -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the -// Amazon EventBridge User Guide. +// see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) +// in the Amazon EventBridge User Guide. func (c *Client) DescribePipe(ctx context.Context, params *DescribePipeInput, optFns ...func(*Options)) (*DescribePipeOutput, error) { if params == nil { params = &DescribePipeInput{} @@ -64,8 +63,8 @@ type DescribePipeOutput struct { // The parameters required to set up enrichment on your pipe. EnrichmentParameters *types.PipeEnrichmentParameters - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_ListPipes.go b/service/pipes/api_op_ListPipes.go index 2e84d555273..b9eef57a537 100644 --- a/service/pipes/api_op_ListPipes.go +++ b/service/pipes/api_op_ListPipes.go @@ -13,9 +13,8 @@ import ( ) // Get the pipes associated with this account. For more information about pipes, -// see Amazon EventBridge Pipes -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the -// Amazon EventBridge User Guide. +// see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) +// in the Amazon EventBridge User Guide. func (c *Client) ListPipes(ctx context.Context, params *ListPipesInput, optFns ...func(*Options)) (*ListPipesOutput, error) { if params == nil { params = &ListPipesInput{} @@ -42,8 +41,9 @@ type ListPipesInput struct { // The maximum number of pipes to include in the response. Limit *int32 - // A value that will return a subset of the pipes associated with this account. For - // example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name. + // A value that will return a subset of the pipes associated with this account. + // For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the + // name. NamePrefix *string // If nextToken is returned, there are more results available. The value of diff --git a/service/pipes/api_op_StartPipe.go b/service/pipes/api_op_StartPipe.go index 97578b11847..925598b313f 100644 --- a/service/pipes/api_op_StartPipe.go +++ b/service/pipes/api_op_StartPipe.go @@ -52,8 +52,8 @@ type StartPipeOutput struct { // The state the pipe should be in. DesiredState types.RequestedPipeState - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_StopPipe.go b/service/pipes/api_op_StopPipe.go index 97f0786d024..2b1a6086eea 100644 --- a/service/pipes/api_op_StopPipe.go +++ b/service/pipes/api_op_StopPipe.go @@ -52,8 +52,8 @@ type StopPipeOutput struct { // The state the pipe should be in. DesiredState types.RequestedPipeState - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_UpdatePipe.go b/service/pipes/api_op_UpdatePipe.go index aec9baf5d69..ba5509fdbf7 100644 --- a/service/pipes/api_op_UpdatePipe.go +++ b/service/pipes/api_op_UpdatePipe.go @@ -12,15 +12,15 @@ import ( "time" ) -// Update an existing pipe. When you call UpdatePipe, only the fields that are +// Update an existing pipe. When you call UpdatePipe , only the fields that are // included in the request are changed, the rest are unchanged. The exception to // this is if you modify any Amazon Web Services-service specific fields in the -// SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields -// in these objects are updated atomically as one and override existing values. -// This is by design and means that if you don't specify an optional field in one -// of these Parameters objects, that field will be set to its system-default value -// after the update. For more information about pipes, see Amazon EventBridge -// Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) +// SourceParameters , EnrichmentParameters , or TargetParameters objects. The +// fields in these objects are updated atomically as one and override existing +// values. This is by design and means that if you don't specify an optional field +// in one of these Parameters objects, that field will be set to its system-default +// value after the update. For more information about pipes, see Amazon +// EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) // in the Amazon EventBridge User Guide. func (c *Client) UpdatePipe(ctx context.Context, params *UpdatePipeInput, optFns ...func(*Options)) (*UpdatePipeOutput, error) { if params == nil { @@ -87,8 +87,8 @@ type UpdatePipeOutput struct { // The state the pipe should be in. DesiredState types.RequestedPipeState - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/types/enums.go b/service/pipes/types/enums.go index e0ec860d16e..b08052ef2ba 100644 --- a/service/pipes/types/enums.go +++ b/service/pipes/types/enums.go @@ -47,9 +47,10 @@ const ( BatchResourceRequirementTypeVcpu BatchResourceRequirementType = "VCPU" ) -// Values returns all known values for BatchResourceRequirementType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for BatchResourceRequirementType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (BatchResourceRequirementType) Values() []BatchResourceRequirementType { return []BatchResourceRequirementType{ "GPU", @@ -202,9 +203,9 @@ const ( PipeStateStopFailed PipeState = "STOP_FAILED" ) -// Values returns all known values for PipeState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for PipeState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (PipeState) Values() []PipeState { return []PipeState{ "RUNNING", @@ -229,9 +230,9 @@ const ( PipeTargetInvocationTypeFireAndForget PipeTargetInvocationType = "FIRE_AND_FORGET" ) -// Values returns all known values for PipeTargetInvocationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PipeTargetInvocationType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PipeTargetInvocationType) Values() []PipeTargetInvocationType { return []PipeTargetInvocationType{ "REQUEST_RESPONSE", @@ -266,8 +267,8 @@ const ( PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" ) -// Values returns all known values for PlacementStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PlacementStrategyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategyType) Values() []PlacementStrategyType { return []PlacementStrategyType{ diff --git a/service/pipes/types/types.go b/service/pipes/types/types.go index 01ff7a7180e..ef4628470ed 100644 --- a/service/pipes/types/types.go +++ b/service/pipes/types/types.go @@ -12,15 +12,15 @@ import ( // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. + // Specifies the subnets associated with the task. These subnets must all be in + // the same VPC. You can specify as many as 16 subnets. // // This member is required. Subnets []string // Specifies whether the task's elastic network interface receives a public IP - // address. You can specify ENABLED only when LaunchType in EcsParameters is set to - // FARGATE. + // address. You can specify ENABLED only when LaunchType in EcsParameters is set + // to FARGATE . AssignPublicIp AssignPublicIp // Specifies the security groups associated with the task. These security groups @@ -47,14 +47,14 @@ type BatchArrayProperties struct { // The overrides that are sent to a container. type BatchContainerOverrides struct { - // The command to send to the container that overrides the default command from the - // Docker image or the task definition. + // The command to send to the container that overrides the default command from + // the Docker image or the task definition. Command []string // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch, or you can override the // existing environment variables from the Docker image or the task definition. - // Environment variables cannot start with "Batch". This naming convention is + // Environment variables cannot start with " Batch ". This naming convention is // reserved for variables that Batch sets. Environment []BatchEnvironmentVariable @@ -64,8 +64,8 @@ type BatchContainerOverrides struct { InstanceType *string // The type and amount of resources to assign to a container. This overrides the - // settings in the job definition. The supported resources include GPU, MEMORY, and - // VCPU. + // settings in the job definition. The supported resources include GPU , MEMORY , + // and VCPU . ResourceRequirements []BatchResourceRequirement noSmithyDocumentSerde @@ -74,7 +74,7 @@ type BatchContainerOverrides struct { // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch, or you can override the // existing environment variables from the Docker image or the task definition. -// Environment variables cannot start with "Batch". This naming convention is +// Environment variables cannot start with " Batch ". This naming convention is // reserved for variables that Batch sets. type BatchEnvironmentVariable struct { @@ -82,8 +82,8 @@ type BatchEnvironmentVariable struct { // the environment variable. Name *string - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. Value *string noSmithyDocumentSerde @@ -102,11 +102,11 @@ type BatchJobDependency struct { } // The type and amount of a resource to assign to a container. The supported -// resources include GPU, MEMORY, and VCPU. +// resources include GPU , MEMORY , and VCPU . type BatchResourceRequirement struct { // The type of resource to assign to a container. The supported resources include - // GPU, MEMORY, and VCPU. + // GPU , MEMORY , and VCPU . // // This member is required. Type BatchResourceRequirementType @@ -122,51 +122,49 @@ type BatchResourceRequirement struct { // container is terminated. This parameter maps to Memory in the Create a // container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section // of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --memory option to docker run (https://docs.docker.com/engine/reference/run/). + // --memory option to docker run (https://docs.docker.com/engine/reference/run/) . // You must specify at least 4 MiB of memory for a job. This is required but can be // specified in several places for multi-node parallel (MNP) jobs. It must be // specified for each node at least once. This parameter maps to Memory in the - // Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the --memory - // option to docker run (https://docs.docker.com/engine/reference/run/). If you're - // trying to maximize your resource utilization by providing your jobs as much - // memory as possible for a particular instance type, see Memory management - // (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in - // the Batch User Guide. For jobs that are running on Fargate resources, then value - // is the hard limit (in MiB), and must match one of the supported values and the - // VCPU values must be one of the values supported for that memory value. value = - // 512 VCPU = 0.25 value = 1024 VCPU = 0.25 or 0.5 value = 2048 VCPU = 0.25, 0.5, - // or 1 value = 3072 VCPU = 0.5, or 1 value = 4096 VCPU = 0.5, 1, or 2 value = - // 5120, 6144, or 7168 VCPU = 1 or 2 value = 8192 VCPU = 1, 2, 4, or 8 value = - // 9216, 10240, 11264, 12288, 13312, 14336, or 15360 VCPU = 2 or 4 value = 16384 - // VCPU = 2, 4, or 8 value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, - // 26624, 27648, 29696, or 30720 VCPU = 4 value = 20480, 24576, or 28672 VCPU = 4 - // or 8 value = 36864, 45056, 53248, or 61440 VCPU = 8 value = 32768, 40960, 49152, - // or 57344 VCPU = 8 or 16 value = 65536, 73728, 81920, 90112, 98304, 106496, - // 114688, or 122880 VCPU = 16 type="VCPU" The number of vCPUs reserved for the - // container. This parameter maps to CpuShares in the Create a container - // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the - // Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the - // --cpu-shares option to docker run - // (https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to - // 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is - // required but can be specified in several places; it must be specified for each - // node at least once. The default for the Fargate On-Demand vCPU resource count - // quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas - // (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) + // Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) + // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) + // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/) + // . If you're trying to maximize your resource utilization by providing your jobs + // as much memory as possible for a particular instance type, see Memory management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) + // in the Batch User Guide. For jobs that are running on Fargate resources, then + // value is the hard limit (in MiB), and must match one of the supported values and + // the VCPU values must be one of the values supported for that memory value. + // value = 512 VCPU = 0.25 value = 1024 VCPU = 0.25 or 0.5 value = 2048 VCPU = + // 0.25, 0.5, or 1 value = 3072 VCPU = 0.5, or 1 value = 4096 VCPU = 0.5, 1, or 2 + // value = 5120, 6144, or 7168 VCPU = 1 or 2 value = 8192 VCPU = 1, 2, 4, or 8 + // value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 VCPU = 2 or 4 value = + // 16384 VCPU = 2, 4, or 8 value = 17408, 18432, 19456, 21504, 22528, 23552, + // 25600, 26624, 27648, 29696, or 30720 VCPU = 4 value = 20480, 24576, or 28672 + // VCPU = 4 or 8 value = 36864, 45056, 53248, or 61440 VCPU = 8 value = 32768, + // 40960, 49152, or 57344 VCPU = 8 or 16 value = 65536, 73728, 81920, 90112, + // 98304, 106496, 114688, or 122880 VCPU = 16 type="VCPU" The number of vCPUs + // reserved for the container. This parameter maps to CpuShares in the Create a + // container (https://docs.docker.com/engine/api/v1.23/#create-a-container) section + // of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the + // --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/) + // . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must + // specify at least one vCPU. This is required but can be specified in several + // places; it must be specified for each node at least once. The default for the + // Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information + // about Fargate quotas, see Fargate quotas (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) // in the Amazon Web Services General Reference. For jobs that are running on // Fargate resources, then value must match one of the supported values and the // MEMORY values must be one of the values supported for that VCPU value. The // supported values are 0.25, 0.5, 1, 2, 4, 8, and 16 value = 0.25 MEMORY = 512, // 1024, or 2048 value = 0.5 MEMORY = 1024, 2048, 3072, or 4096 value = 1 MEMORY = - // 2048, 3072, 4096, 5120, 6144, 7168, or 8192 value = 2 MEMORY = 4096, 5120, 6144, - // 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 value = 4 - // MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, - // 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, - // 29696, or 30720 value = 8 MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, - // 40960, 45056, 49152, 53248, 57344, or 61440 value = 16 MEMORY = 32768, 40960, - // 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 + // 2048, 3072, 4096, 5120, 6144, 7168, or 8192 value = 2 MEMORY = 4096, 5120, + // 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 value + // = 4 MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, + // 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, + // 28672, 29696, or 30720 value = 8 MEMORY = 16384, 20480, 24576, 28672, 32768, + // 36864, 40960, 45056, 49152, 53248, 57344, or 61440 value = 16 MEMORY = 32768, + // 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or + // 122880 // // This member is required. Value *string @@ -175,9 +173,8 @@ type BatchResourceRequirement struct { } // The retry strategy that's associated with a job. For more information, see -// Automated job retries -// (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the -// Batch User Guide. +// Automated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) +// in the Batch User Guide. type BatchRetryStrategy struct { // The number of times to move a job to the RUNNABLE status. If the value of @@ -189,8 +186,7 @@ type BatchRetryStrategy struct { } // The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) // in the Amazon ECS API Reference. type CapacityProviderStrategyItem struct { @@ -205,9 +201,9 @@ type CapacityProviderStrategyItem struct { // used. Base int32 - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. The weight value is - // taken into consideration after the base value, if defined, is satisfied. + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight value + // is taken into consideration after the base value, if defined, is satisfied. Weight int32 noSmithyDocumentSerde @@ -225,17 +221,17 @@ type DeadLetterConfig struct { } // The overrides that are sent to a container. An empty container override can be -// passed in. An example of an empty container override is {"containerOverrides": [ -// ] }. If a non-empty container override is specified, the name parameter must be -// included. +// passed in. An example of an empty container override is {"containerOverrides": +// [ ] } . If a non-empty container override is specified, the name parameter must +// be included. type EcsContainerOverride struct { - // The command to send to the container that overrides the default command from the - // Docker image or the task definition. You must also specify a container name. + // The command to send to the container that overrides the default command from + // the Docker image or the task definition. You must also specify a container name. Command []string - // The number of cpu units reserved for the container, instead of the default value - // from the task definition. You must also specify a container name. + // The number of cpu units reserved for the container, instead of the default + // value from the task definition. You must also specify a container name. Cpu *int32 // The environment variables to send to the container. You can add new environment @@ -258,8 +254,8 @@ type EcsContainerOverride struct { // default value from the task definition. You must also specify a container name. MemoryReservation *int32 - // The name of the container that receives the override. This parameter is required - // if any override is specified. + // The name of the container that receives the override. This parameter is + // required if any override is specified. Name *string // The type and amount of a resource to assign to a container, instead of the @@ -269,30 +265,25 @@ type EcsContainerOverride struct { noSmithyDocumentSerde } -// A list of files containing the environment variables to pass to a container. You -// can specify up to ten environment files. The file must have a .env file +// A list of files containing the environment variables to pass to a container. +// You can specify up to ten environment files. The file must have a .env file // extension. Each line in an environment file should contain an environment // variable in VARIABLE=VALUE format. Lines beginning with # are treated as // comments and are ignored. For more information about the environment variable -// file syntax, see Declare default environment variables in file -// (https://docs.docker.com/compose/env-file/). If there are environment variables -// specified using the environment parameter in a container definition, they take -// precedence over the variables contained within an environment file. If multiple -// environment files are specified that contain the same variable, they're -// processed from the top down. We recommend that you use unique variable names. -// For more information, see Specifying environment variables -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) +// file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/) +// . If there are environment variables specified using the environment parameter +// in a container definition, they take precedence over the variables contained +// within an environment file. If multiple environment files are specified that +// contain the same variable, they're processed from the top down. We recommend +// that you use unique variable names. For more information, see Specifying +// environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. This parameter is only // supported for tasks hosted on Fargate using the following platform versions: -// -// * -// Linux platform version 1.4.0 or later. -// -// * Windows platform version 1.0.0 or -// later. +// - Linux platform version 1.4.0 or later. +// - Windows platform version 1.0.0 or later. type EcsEnvironmentFile struct { - // The file type to use. The only supported value is s3. + // The file type to use. The only supported value is s3 . // // This member is required. Type EcsEnvironmentFileType @@ -316,18 +307,17 @@ type EcsEnvironmentVariable struct { // the environment variable. Name *string - // The value of the key-value pair. For environment variables, this is the value of - // the environment variable. + // The value of the key-value pair. For environment variables, this is the value + // of the environment variable. Value *string noSmithyDocumentSerde } -// The amount of ephemeral storage to allocate for the task. This parameter is used -// to expand the total amount of ephemeral storage available, beyond the default -// amount, for tasks hosted on Fargate. For more information, see Fargate task -// storage -// (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) +// The amount of ephemeral storage to allocate for the task. This parameter is +// used to expand the total amount of ephemeral storage available, beyond the +// default amount, for tasks hosted on Fargate. For more information, see Fargate +// task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) // in the Amazon ECS User Guide for Fargate. This parameter is only supported for // tasks hosted on Fargate using Linux platform version 1.4.0 or later. This // parameter is not supported for Windows containers on Fargate. @@ -345,9 +335,8 @@ type EcsEphemeralStorage struct { // Details on an Elastic Inference accelerator task override. This parameter is // used to override the Elastic Inference accelerator specified in the task // definition. For more information, see Working with Amazon Elastic Inference on -// Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) in -// the Amazon Elastic Container Service Developer Guide. +// Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) +// in the Amazon Elastic Container Service Developer Guide. type EcsInferenceAcceleratorOverride struct { // The Elastic Inference accelerator device name to override for the task. This @@ -362,21 +351,19 @@ type EcsInferenceAcceleratorOverride struct { // The type and amount of a resource to assign to a container. The supported // resource types are GPUs and Elastic Inference accelerators. For more -// information, see Working with GPUs on Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or -// Working with Amazon Elastic Inference on Amazon ECS -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) +// information, see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) +// or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) // in the Amazon Elastic Container Service Developer Guide type EcsResourceRequirement struct { // The type of resource to assign to a container. The supported values are GPU or - // InferenceAccelerator. + // InferenceAccelerator . // // This member is required. Type EcsResourceRequirementType - // The value for the specified resource type. If the GPU type is used, the value is - // the number of physical GPUs the Amazon ECS container agent reserves for the + // The value for the specified resource type. If the GPU type is used, the value + // is the number of physical GPUs the Amazon ECS container agent reserves for the // container. The number of GPUs that's reserved for all containers in a task can't // exceed the number of available GPUs on the container instance that the task is // launched on. If the InferenceAccelerator type is used, the value matches the @@ -398,18 +385,13 @@ type EcsTaskOverride struct { Cpu *string // The ephemeral storage setting override for the task. This parameter is only - // supported for tasks hosted on Fargate that use the following platform - // versions: - // - // * Linux platform version 1.4.0 or later. - // - // * Windows platform version - // 1.0.0 or later. + // supported for tasks hosted on Fargate that use the following platform versions: + // - Linux platform version 1.4.0 or later. + // - Windows platform version 1.0.0 or later. EphemeralStorage *EcsEphemeralStorage // The Amazon Resource Name (ARN) of the task execution IAM role override for the - // task. For more information, see Amazon ECS task execution IAM role - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) + // task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) // in the Amazon Elastic Container Service Developer Guide. ExecutionRoleArn *string @@ -421,17 +403,15 @@ type EcsTaskOverride struct { // The Amazon Resource Name (ARN) of the IAM role that containers in this task can // assume. All containers in this task are granted the permissions that are - // specified in this role. For more information, see IAM Role for Tasks - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) + // specified in this role. For more information, see IAM Role for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string noSmithyDocumentSerde } -// Filter events using an event pattern. For more information, see Events and Event -// Patterns -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) +// Filter events using an event pattern. For more information, see Events and +// Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. type Filter struct { @@ -442,8 +422,7 @@ type Filter struct { } // The collection of event patterns used to filter events. For more information, -// see Events and Event Patterns -// (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) +// see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. type FilterCriteria struct { @@ -529,8 +508,8 @@ type Pipe struct { // The ARN of the enrichment resource. Enrichment *string - // When the pipe was last updated, in ISO-8601 format - // (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD). + // When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // (YYYY-MM-DDThh:mm:ss.sTZD). LastModifiedTime *time.Time // The name of the pipe. @@ -583,8 +562,8 @@ type PipeEnrichmentParameters struct { // Valid JSON text passed to the enrichment. In this case, nothing from the event // itself is passed to the enrichment. For more information, see The JavaScript - // Object Notation (JSON) Data Interchange Format - // (http://www.rfc-editor.org/rfc/rfc7159.txt). + // Object Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt) + // . InputTemplate *string noSmithyDocumentSerde @@ -689,8 +668,8 @@ type PipeSourceKinesisStreamParameters struct { // The default value is 1. ParallelizationFactor *int32 - // With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, - // in Unix time seconds. + // With StartingPosition set to AT_TIMESTAMP , the time from which to start + // reading, in Unix time seconds. StartingPositionTimestamp *time.Time noSmithyDocumentSerde @@ -732,8 +711,7 @@ type PipeSourceParameters struct { DynamoDBStreamParameters *PipeSourceDynamoDBStreamParameters // The collection of event patterns used to filter events. For more information, - // see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. FilterCriteria *FilterCriteria @@ -809,8 +787,8 @@ type PipeSourceSelfManagedKafkaParameters struct { // (Streams only) The position in a stream from which to start reading. StartingPosition SelfManagedKafkaStartPosition - // This structure specifies the VPC subnets and security groups for the stream, and - // whether a public IP address is to be used. + // This structure specifies the VPC subnets and security groups for the stream, + // and whether a public IP address is to be used. Vpc *SelfManagedKafkaAccessConfigurationVpc noSmithyDocumentSerde @@ -831,9 +809,9 @@ type PipeSourceSqsQueueParameters struct { // The parameters for using an Batch job as a target. type PipeTargetBatchJobParameters struct { - // The job definition used by this job. This value can be one of name, - // name:revision, or the Amazon Resource Name (ARN) for the job definition. If name - // is specified without a revision then the latest active revision is used. + // The job definition used by this job. This value can be one of name , + // name:revision , or the Amazon Resource Name (ARN) for the job definition. If + // name is specified without a revision then the latest active revision is used. // // This member is required. JobDefinition *string @@ -897,20 +875,19 @@ type PipeTargetEcsTaskParameters struct { TaskDefinitionArn *string // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be omitted. - // If no capacityProviderStrategy or launchType is specified, the + // capacityProviderStrategy is specified, the launchType parameter must be + // omitted. If no capacityProviderStrategy or launchType is specified, the // defaultCapacityProviderStrategy for the cluster is used. CapacityProviderStrategy []CapacityProviderStrategyItem // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon Elastic Container Service Developer Guide. EnableECSManagedTags bool - // Whether or not to enable the execute command functionality for the containers in - // this task. If true, this enables execute command functionality on all containers - // in the task. + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. EnableExecuteCommand bool // Specifies an Amazon ECS task group for the task. The maximum length is 255 @@ -920,8 +897,7 @@ type PipeTargetEcsTaskParameters struct { // Specifies the launch type on which your task is running. The launch type that // you specify here must match one of the launch type (compatibilities) of the // target task. The FARGATE value is supported only in the Regions where Fargate - // with Amazon ECS is supported. For more information, see Fargate on Amazon ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) + // with Amazon ECS is supported. For more information, see Fargate on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) // in the Amazon Elastic Container Service Developer Guide. LaunchType LaunchType @@ -936,27 +912,26 @@ type PipeTargetEcsTaskParameters struct { // The overrides that are associated with a task. Overrides *EcsTaskOverride - // An array of placement constraint objects to use for the task. You can specify up - // to 10 constraints per task (including constraints in the task definition and + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition and // those specified at runtime). PlacementConstraints []PlacementConstraint - // The placement strategy objects to use for the task. You can specify a maximum of - // five strategy rules per task. + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. PlacementStrategy []PlacementStrategy - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. This structure is used only if LaunchType - // is FARGATE. For more information about valid platform versions, see Fargate - // Platform Versions - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) + // Specifies the platform version for the task. Specify only the numeric portion + // of the platform version, such as 1.1.0 . This structure is used only if + // LaunchType is FARGATE . For more information about valid platform versions, see + // Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags are not propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // the TagResource API action. + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use the TagResource API action. PropagateTags PropagateTags // The reference ID to use for the task. @@ -964,12 +939,11 @@ type PipeTargetEcsTaskParameters struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you - // define. To learn more, see RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) // in the Amazon ECS API Reference. Tags []Tag - // The number of tasks to create based on TaskDefinition. The default is 1. + // The number of tasks to create based on TaskDefinition . The default is 1. TaskCount *int32 noSmithyDocumentSerde @@ -978,13 +952,13 @@ type PipeTargetEcsTaskParameters struct { // The parameters for using an EventBridge event bus as a target. type PipeTargetEventBridgeEventBusParameters struct { - // A free-form string, with a maximum of 128 characters, used to decide what fields - // to expect in the event detail. + // A free-form string, with a maximum of 128 characters, used to decide what + // fields to expect in the event detail. DetailType *string // The URL subdomain of the endpoint. For example, if the URL for Endpoint is // https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is - // abcde.veo. When using Java, you must include auth-crt on the class path. + // abcde.veo . When using Java, you must include auth-crt on the class path. EndpointId *string // Amazon Web Services resources, identified by Amazon Resource Name (ARN), which @@ -994,10 +968,8 @@ type PipeTargetEventBridgeEventBusParameters struct { // The source of the event. Source *string - // The time stamp of the event, per RFC3339 - // (https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the - // time stamp of the PutEvents - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) + // The time stamp of the event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt) + // . If no time stamp is provided, the time stamp of the PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) // call is used. Time *string @@ -1045,18 +1017,14 @@ type PipeTargetKinesisStreamParameters struct { type PipeTargetLambdaFunctionParameters struct { // Choose from the following options. - // - // * RequestResponse (default) - Invoke the - // function synchronously. Keep the connection open until the function returns a - // response or times out. The API response includes the function response and - // additional data. - // - // * Event - Invoke the function asynchronously. Send events that - // fail multiple times to the function's dead-letter queue (if it's configured). - // The API response only includes a status code. - // - // * DryRun - Validate parameter - // values and verify that the user or role has permission to invoke the function. + // - RequestResponse (default) - Invoke the function synchronously. Keep the + // connection open until the function returns a response or times out. The API + // response includes the function response and additional data. + // - Event - Invoke the function asynchronously. Send events that fail multiple + // times to the function's dead-letter queue (if it's configured). The API response + // only includes a status code. + // - DryRun - Validate parameter values and verify that the user or role has + // permission to invoke the function. InvocationType PipeTargetInvocationType noSmithyDocumentSerde @@ -1083,8 +1051,8 @@ type PipeTargetParameters struct { // Valid JSON text passed to the target. In this case, nothing from the event // itself is passed to the target. For more information, see The JavaScript Object - // Notation (JSON) Data Interchange Format - // (http://www.rfc-editor.org/rfc/rfc7159.txt). + // Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt) + // . InputTemplate *string // The parameters for using a Kinesis stream as a source. @@ -1128,12 +1096,12 @@ type PipeTargetRedshiftDataParameters struct { // credentials. DbUser *string - // The name or ARN of the secret that enables access to the database. Required when - // authenticating using SageMaker. + // The name or ARN of the secret that enables access to the database. Required + // when authenticating using SageMaker. SecretManagerArn *string - // The name of the SQL statement. You can name the SQL statement when you create it - // to identify the query. + // The name of the SQL statement. You can name the SQL statement when you create + // it to identify the query. StatementName *string // Indicates whether to send an event back to EventBridge after the SQL statement @@ -1176,15 +1144,13 @@ type PipeTargetStateMachineParameters struct { } // An object representing a constraint on task placement. To learn more, see Task -// Placement Constraints -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) // in the Amazon Elastic Container Service Developer Guide. type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. You cannot - // specify an expression if the constraint type is distinctInstance. To learn more, - // see Cluster Query Language - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // specify an expression if the constraint type is distinctInstance . To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string @@ -1197,8 +1163,7 @@ type PlacementConstraint struct { } // The task placement strategy for a task or service. To learn more, see Task -// Placement Strategies -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) // in the Amazon Elastic Container Service Service Developer Guide. type PlacementStrategy struct { @@ -1291,8 +1256,8 @@ type SelfManagedKafkaAccessConfigurationCredentialsMemberSaslScram512Auth struct func (*SelfManagedKafkaAccessConfigurationCredentialsMemberSaslScram512Auth) isSelfManagedKafkaAccessConfigurationCredentials() { } -// This structure specifies the VPC subnets and security groups for the stream, and -// whether a public IP address is to be used. +// This structure specifies the VPC subnets and security groups for the stream, +// and whether a public IP address is to be used. type SelfManagedKafkaAccessConfigurationVpc struct { // Specifies the security groups associated with the stream. These security groups @@ -1438,8 +1403,7 @@ type UpdatePipeSourceParameters struct { DynamoDBStreamParameters *UpdatePipeSourceDynamoDBStreamParameters // The collection of event patterns used to filter events. For more information, - // see Events and Event Patterns - // (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) + // see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) // in the Amazon EventBridge User Guide. FilterCriteria *FilterCriteria @@ -1493,8 +1457,8 @@ type UpdatePipeSourceSelfManagedKafkaParameters struct { // The ARN of the Secrets Manager secret used for certification. ServerRootCaCertificate *string - // This structure specifies the VPC subnets and security groups for the stream, and - // whether a public IP address is to be used. + // This structure specifies the VPC subnets and security groups for the stream, + // and whether a public IP address is to be used. Vpc *SelfManagedKafkaAccessConfigurationVpc noSmithyDocumentSerde diff --git a/service/polly/api_client.go b/service/polly/api_client.go index c170d306aa3..3952a9af6df 100644 --- a/service/polly/api_client.go +++ b/service/polly/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/polly/api_op_DeleteLexicon.go b/service/polly/api_op_DeleteLexicon.go index 026079dc0c9..9955d3b2970 100644 --- a/service/polly/api_op_DeleteLexicon.go +++ b/service/polly/api_op_DeleteLexicon.go @@ -13,8 +13,8 @@ import ( // Deletes the specified pronunciation lexicon stored in an Amazon Web Services // Region. A lexicon which has been deleted is not available for speech synthesis, // nor is it possible to retrieve it using either the GetLexicon or ListLexicon -// APIs. For more information, see Managing Lexicons -// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html). +// APIs. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html) +// . func (c *Client) DeleteLexicon(ctx context.Context, params *DeleteLexiconInput, optFns ...func(*Options)) (*DeleteLexiconOutput, error) { if params == nil { params = &DeleteLexiconInput{} diff --git a/service/polly/api_op_DescribeVoices.go b/service/polly/api_op_DescribeVoices.go index 00223ab7ac8..8a2ee24d397 100644 --- a/service/polly/api_op_DescribeVoices.go +++ b/service/polly/api_op_DescribeVoices.go @@ -14,15 +14,15 @@ import ( // Returns the list of voices that are available for use when requesting speech // synthesis. Each voice speaks a specified language, is either male or female, and // is identified by an ID, which is the ASCII version of the voice name. When -// synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice -// you want from the list of voices returned by DescribeVoices. For example, you -// want your news reader application to read news in a specific language, but -// giving a user the option to choose the voice. Using the DescribeVoices operation -// you can provide the user with a list of available voices to select from. You can -// optionally specify a language code to filter the available voices. For example, -// if you specify en-US, the operation returns a list of all available US English -// voices. This operation requires permissions to perform the polly:DescribeVoices -// action. +// synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the +// voice you want from the list of voices returned by DescribeVoices . For example, +// you want your news reader application to read news in a specific language, but +// giving a user the option to choose the voice. Using the DescribeVoices +// operation you can provide the user with a list of available voices to select +// from. You can optionally specify a language code to filter the available voices. +// For example, if you specify en-US , the operation returns a list of all +// available US English voices. This operation requires permissions to perform the +// polly:DescribeVoices action. func (c *Client) DescribeVoices(ctx context.Context, params *DescribeVoicesInput, optFns ...func(*Options)) (*DescribeVoicesOutput, error) { if params == nil { params = &DescribeVoicesInput{} @@ -40,7 +40,7 @@ func (c *Client) DescribeVoices(ctx context.Context, params *DescribeVoicesInput type DescribeVoicesInput struct { - // Specifies the engine (standard or neural) used by Amazon Polly when processing + // Specifies the engine ( standard or neural ) used by Amazon Polly when processing // input text for speech synthesis. Engine types.Engine @@ -48,7 +48,7 @@ type DescribeVoicesInput struct { // specified language as an additional language. For instance, if you request all // languages that use US English (es-US), and there is an Italian voice that speaks // both Italian (it-IT) and US English, that voice will be included if you specify - // yes but not if you specify no. + // yes but not if you specify no . IncludeAdditionalLanguageCodes bool // The language identification tag (ISO 639 code for the language name-ISO 3166 diff --git a/service/polly/api_op_GetLexicon.go b/service/polly/api_op_GetLexicon.go index 4563beba01c..ebdb20dd786 100644 --- a/service/polly/api_op_GetLexicon.go +++ b/service/polly/api_op_GetLexicon.go @@ -12,8 +12,8 @@ import ( ) // Returns the content of the specified pronunciation lexicon stored in an Amazon -// Web Services Region. For more information, see Managing Lexicons -// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html). +// Web Services Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html) +// . func (c *Client) GetLexicon(ctx context.Context, params *GetLexiconInput, optFns ...func(*Options)) (*GetLexiconOutput, error) { if params == nil { params = &GetLexiconInput{} diff --git a/service/polly/api_op_GetSpeechSynthesisTask.go b/service/polly/api_op_GetSpeechSynthesisTask.go index 52a834a6f23..2f8112bdaa1 100644 --- a/service/polly/api_op_GetSpeechSynthesisTask.go +++ b/service/polly/api_op_GetSpeechSynthesisTask.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object -// contains information about the given speech synthesis task, including the status -// of the task, and a link to the S3 bucket containing the output of the task. +// Retrieves a specific SpeechSynthesisTask object based on its TaskID. This +// object contains information about the given speech synthesis task, including the +// status of the task, and a link to the S3 bucket containing the output of the +// task. func (c *Client) GetSpeechSynthesisTask(ctx context.Context, params *GetSpeechSynthesisTaskInput, optFns ...func(*Options)) (*GetSpeechSynthesisTaskOutput, error) { if params == nil { params = &GetSpeechSynthesisTaskInput{} diff --git a/service/polly/api_op_ListLexicons.go b/service/polly/api_op_ListLexicons.go index 832745ddb25..e70555cbce0 100644 --- a/service/polly/api_op_ListLexicons.go +++ b/service/polly/api_op_ListLexicons.go @@ -12,8 +12,8 @@ import ( ) // Returns a list of pronunciation lexicons stored in an Amazon Web Services -// Region. For more information, see Managing Lexicons -// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html). +// Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html) +// . func (c *Client) ListLexicons(ctx context.Context, params *ListLexiconsInput, optFns ...func(*Options)) (*ListLexiconsOutput, error) { if params == nil { params = &ListLexiconsInput{} diff --git a/service/polly/api_op_PutLexicon.go b/service/polly/api_op_PutLexicon.go index a2db0386b2e..504e228650c 100644 --- a/service/polly/api_op_PutLexicon.go +++ b/service/polly/api_op_PutLexicon.go @@ -14,8 +14,8 @@ import ( // with the same name already exists in the region, it is overwritten by the new // lexicon. Lexicon operations have eventual consistency, therefore, it might take // some time before the lexicon is available to the SynthesizeSpeech operation. For -// more information, see Managing Lexicons -// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html). +// more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html) +// . func (c *Client) PutLexicon(ctx context.Context, params *PutLexiconInput, optFns ...func(*Options)) (*PutLexiconOutput, error) { if params == nil { params = &PutLexiconInput{} diff --git a/service/polly/api_op_StartSpeechSynthesisTask.go b/service/polly/api_op_StartSpeechSynthesisTask.go index 6cb10725241..aa6161185a9 100644 --- a/service/polly/api_op_StartSpeechSynthesisTask.go +++ b/service/polly/api_op_StartSpeechSynthesisTask.go @@ -12,10 +12,10 @@ import ( ) // Allows the creation of an asynchronous synthesis task, by starting a new -// SpeechSynthesisTask. This operation requires all the standard information needed -// for speech synthesis, plus the name of an Amazon S3 bucket for the service to -// store the output of the synthesis task and two optional parameters -// (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this +// SpeechSynthesisTask . This operation requires all the standard information +// needed for speech synthesis, plus the name of an Amazon S3 bucket for the +// service to store the output of the synthesis task and two optional parameters ( +// OutputS3KeyPrefix and SnsTopicArn ). Once the synthesis task is created, this // operation will return a SpeechSynthesisTask object, which will include an // identifier of this task as well as the current status. The SpeechSynthesisTask // object is available for 72 hours after starting the asynchronous synthesis task. @@ -58,7 +58,7 @@ type StartSpeechSynthesisTaskInput struct { // This member is required. VoiceId types.VoiceId - // Specifies the engine (standard or neural) for Amazon Polly to use when + // Specifies the engine ( standard or neural ) for Amazon Polly to use when // processing input text for speech synthesis. Using a voice that is not supported // for the engine selected will result in an error. Engine types.Engine @@ -68,10 +68,9 @@ type StartSpeechSynthesisTaskInput struct { // English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language // code is specified, Amazon Polly uses the default language of the bilingual // voice. The default language for any voice is the one returned by the - // DescribeVoices - // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation - // for the LanguageCode parameter. For example, if no language code is specified, - // Aditi will use Indian English rather than Hindi. + // DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) + // operation for the LanguageCode parameter. For example, if no language code is + // specified, Aditi will use Indian English rather than Hindi. LanguageCode types.LanguageCode // List of one or more pronunciation lexicon names you want the service to apply @@ -82,9 +81,9 @@ type StartSpeechSynthesisTaskInput struct { // The Amazon S3 key prefix for the output speech file. OutputS3KeyPrefix *string - // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are - // "8000", "16000", "22050", and "24000". The default value for standard voices is - // "22050". The default value for neural voices is "24000". Valid values for pcm + // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis + // are "8000", "16000", "22050", and "24000". The default value for standard voices + // is "22050". The default value for neural voices is "24000". Valid values for pcm // are "8000" and "16000" The default value is "16000". SampleRate *string diff --git a/service/polly/api_op_SynthesizeSpeech.go b/service/polly/api_op_SynthesizeSpeech.go index ff05c27e675..333590e16c3 100644 --- a/service/polly/api_op_SynthesizeSpeech.go +++ b/service/polly/api_op_SynthesizeSpeech.go @@ -15,8 +15,8 @@ import ( // Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input // must be valid, well-formed SSML. Some alphabets might not be available with all // the voices (for example, Cyrillic might not be read at all by English voices) -// unless phoneme mapping is used. For more information, see How it Works -// (https://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html). +// unless phoneme mapping is used. For more information, see How it Works (https://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html) +// . func (c *Client) SynthesizeSpeech(ctx context.Context, params *SynthesizeSpeechInput, optFns ...func(*Options)) (*SynthesizeSpeechOutput, error) { if params == nil { params = &SynthesizeSpeechInput{} @@ -42,54 +42,52 @@ type SynthesizeSpeechInput struct { // This member is required. OutputFormat types.OutputFormat - // Input text to synthesize. If you specify ssml as the TextType, follow the SSML + // Input text to synthesize. If you specify ssml as the TextType , follow the SSML // format for the input text. // // This member is required. Text *string // Voice ID to use for the synthesis. You can get a list of available voice IDs by - // calling the DescribeVoices - // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation. + // calling the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) + // operation. // // This member is required. VoiceId types.VoiceId - // Specifies the engine (standard or neural) for Amazon Polly to use when + // Specifies the engine ( standard or neural ) for Amazon Polly to use when // processing input text for speech synthesis. For information on Amazon Polly // voices and which voices are available in standard-only, NTTS-only, and both - // standard and NTTS formats, see Available Voices - // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html). NTTS-only voices - // When using NTTS-only voices such as Kevin (en-US), this parameter is required - // and must be set to neural. If the engine is not specified, or is set to - // standard, this will result in an error. Type: String Valid Values: standard | - // neural Required: Yes Standard voices For standard voices, this is not required; - // the engine parameter defaults to standard. If the engine is not specified, or is - // set to standard and an NTTS-only voice is selected, this will result in an - // error. + // standard and NTTS formats, see Available Voices (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html) + // . NTTS-only voices When using NTTS-only voices such as Kevin (en-US), this + // parameter is required and must be set to neural . If the engine is not + // specified, or is set to standard , this will result in an error. Type: String + // Valid Values: standard | neural Required: Yes Standard voices For standard + // voices, this is not required; the engine parameter defaults to standard . If the + // engine is not specified, or is set to standard and an NTTS-only voice is + // selected, this will result in an error. Engine types.Engine - // Optional language code for the Synthesize Speech request. This is only necessary - // if using a bilingual voice, such as Aditi, which can be used for either Indian - // English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language - // code is specified, Amazon Polly uses the default language of the bilingual - // voice. The default language for any voice is the one returned by the - // DescribeVoices - // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation - // for the LanguageCode parameter. For example, if no language code is specified, - // Aditi will use Indian English rather than Hindi. + // Optional language code for the Synthesize Speech request. This is only + // necessary if using a bilingual voice, such as Aditi, which can be used for + // either Indian English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and + // no language code is specified, Amazon Polly uses the default language of the + // bilingual voice. The default language for any voice is the one returned by the + // DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) + // operation for the LanguageCode parameter. For example, if no language code is + // specified, Aditi will use Indian English rather than Hindi. LanguageCode types.LanguageCode // List of one or more pronunciation lexicon names you want the service to apply // during synthesis. Lexicons are applied only if the language of the lexicon is // the same as the language of the voice. For information about storing lexicons, - // see PutLexicon - // (https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html). + // see PutLexicon (https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html) + // . LexiconNames []string - // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are - // "8000", "16000", "22050", and "24000". The default value for standard voices is - // "22050". The default value for neural voices is "24000". Valid values for pcm + // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis + // are "8000", "16000", "22050", and "24000". The default value for standard voices + // is "22050". The default value for neural voices is "24000". Valid values for pcm // are "8000" and "16000" The default value is "16000". SampleRate *string @@ -97,8 +95,8 @@ type SynthesizeSpeechInput struct { SpeechMarkTypes []types.SpeechMarkType // Specifies whether the input text is plain text or SSML. The default value is - // plain text. For more information, see Using SSML - // (https://docs.aws.amazon.com/polly/latest/dg/ssml.html). + // plain text. For more information, see Using SSML (https://docs.aws.amazon.com/polly/latest/dg/ssml.html) + // . TextType types.TextType noSmithyDocumentSerde @@ -111,19 +109,14 @@ type SynthesizeSpeechOutput struct { // Specifies the type audio stream. This should reflect the OutputFormat parameter // in your request. - // - // * If you request mp3 as the OutputFormat, the ContentType - // returned is audio/mpeg. - // - // * If you request ogg_vorbis as the OutputFormat, the - // ContentType returned is audio/ogg. - // - // * If you request pcm as the OutputFormat, - // the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), - // little-endian format. - // - // * If you request json as the OutputFormat, the - // ContentType returned is application/x-json-stream. + // - If you request mp3 as the OutputFormat , the ContentType returned is + // audio/mpeg. + // - If you request ogg_vorbis as the OutputFormat , the ContentType returned is + // audio/ogg. + // - If you request pcm as the OutputFormat , the ContentType returned is + // audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. + // - If you request json as the OutputFormat , the ContentType returned is + // application/x-json-stream. ContentType *string // Number of characters synthesized. diff --git a/service/polly/doc.go b/service/polly/doc.go index c0c11cfb941..ce56a60e122 100644 --- a/service/polly/doc.go +++ b/service/polly/doc.go @@ -3,9 +3,9 @@ // Package polly provides the API client, operations, and parameter types for // Amazon Polly. // -// Amazon Polly is a web service that makes it easy to synthesize speech from text. -// The Amazon Polly service provides API operations for synthesizing high-quality -// speech from plain text and Speech Synthesis Markup Language (SSML), along with -// managing pronunciations lexicons that enable you to get the best results for -// your application domain. +// Amazon Polly is a web service that makes it easy to synthesize speech from +// text. The Amazon Polly service provides API operations for synthesizing +// high-quality speech from plain text and Speech Synthesis Markup Language (SSML), +// along with managing pronunciations lexicons that enable you to get the best +// results for your application domain. package polly diff --git a/service/polly/types/enums.go b/service/polly/types/enums.go index 1f5a5371ea8..e9dd0a9c953 100644 --- a/service/polly/types/enums.go +++ b/service/polly/types/enums.go @@ -80,9 +80,9 @@ const ( LanguageCodeFiFi LanguageCode = "fi-FI" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "arb", @@ -134,9 +134,9 @@ const ( OutputFormatPcm OutputFormat = "pcm" ) -// Values returns all known values for OutputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OutputFormat) Values() []OutputFormat { return []OutputFormat{ "json", diff --git a/service/polly/types/errors.go b/service/polly/types/errors.go index cd775f0be5a..b0b412f13b6 100644 --- a/service/polly/types/errors.go +++ b/service/polly/types/errors.go @@ -35,8 +35,8 @@ func (e *EngineNotSupportedException) ErrorCode() string { } func (e *EngineNotSupportedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is -// spelled correctly, and then try again. +// Amazon Polly can't find the specified lexicon. Verify that the lexicon's name +// is spelled correctly, and then try again. type InvalidLexiconException struct { Message *string @@ -276,10 +276,10 @@ func (e *LanguageNotSupportedException) ErrorCode() string { } func (e *LanguageNotSupportedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Polly can't find the specified lexicon. This could be caused by a lexicon -// that is missing, its name is misspelled or specifying a lexicon that is in a -// different region. Verify that the lexicon exists, is in the region (see -// ListLexicons) and that you spelled its name is spelled correctly. Then try +// Amazon Polly can't find the specified lexicon. This could be caused by a +// lexicon that is missing, its name is misspelled or specifying a lexicon that is +// in a different region. Verify that the lexicon exists, is in the region (see +// ListLexicons ) and that you spelled its name is spelled correctly. Then try // again. type LexiconNotFoundException struct { Message *string @@ -527,7 +527,7 @@ func (e *TextLengthExceededException) ErrorCode() string { func (e *TextLengthExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The alphabet specified by the lexicon is not a supported alphabet. Valid values -// are x-sampa and ipa. +// are x-sampa and ipa . type UnsupportedPlsAlphabetException struct { Message *string @@ -554,8 +554,8 @@ func (e *UnsupportedPlsAlphabetException) ErrorCode() string { func (e *UnsupportedPlsAlphabetException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The language specified in the lexicon is unsupported. For a list of supported -// languages, see Lexicon Attributes -// (https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html). +// languages, see Lexicon Attributes (https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html) +// . type UnsupportedPlsLanguageException struct { Message *string diff --git a/service/polly/types/types.go b/service/polly/types/types.go index 2d0f753242d..6e704194fcc 100644 --- a/service/polly/types/types.go +++ b/service/polly/types/types.go @@ -8,8 +8,8 @@ import ( ) // Provides lexicon name and lexicon content in string format. For more -// information, see Pronunciation Lexicon Specification (PLS) Version 1.0 -// (https://www.w3.org/TR/pronunciation-lexicon/). +// information, see Pronunciation Lexicon Specification (PLS) Version 1.0 (https://www.w3.org/TR/pronunciation-lexicon/) +// . type Lexicon struct { // Lexicon content in string format. The content of a lexicon must be in PLS @@ -22,12 +22,12 @@ type Lexicon struct { noSmithyDocumentSerde } -// Contains metadata describing the lexicon such as the number of lexemes, language -// code, and so on. For more information, see Managing Lexicons -// (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html). +// Contains metadata describing the lexicon such as the number of lexemes, +// language code, and so on. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html) +// . type LexiconAttributes struct { - // Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa. + // Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa . Alphabet *string // Language code that the lexicon applies to. A lexicon with a language code such @@ -68,7 +68,7 @@ type SynthesisTask struct { // Timestamp for the time the synthesis task was started. CreationTime *time.Time - // Specifies the engine (standard or neural) for Amazon Polly to use when + // Specifies the engine ( standard or neural ) for Amazon Polly to use when // processing input text for speech synthesis. Using a voice that is not supported // for the engine selected will result in an error. Engine Engine @@ -77,10 +77,9 @@ type SynthesisTask struct { // bilingual voice, such as Aditi, which can be used for either Indian English // (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is // specified, Amazon Polly uses the default language of the bilingual voice. The - // default language for any voice is the one returned by the DescribeVoices - // (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation - // for the LanguageCode parameter. For example, if no language code is specified, - // Aditi will use Indian English rather than Hindi. + // default language for any voice is the one returned by the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) + // operation for the LanguageCode parameter. For example, if no language code is + // specified, Aditi will use Indian English rather than Hindi. LanguageCode LanguageCode // List of one or more pronunciation lexicon names you want the service to apply @@ -98,9 +97,9 @@ type SynthesisTask struct { // Number of billable characters synthesized. RequestCharacters int32 - // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis are - // "8000", "16000", "22050", and "24000". The default value for standard voices is - // "22050". The default value for neural voices is "24000". Valid values for pcm + // The audio frequency specified in Hz. The valid values for mp3 and ogg_vorbis + // are "8000", "16000", "22050", and "24000". The default value for standard voices + // is "22050". The default value for neural voices is "24000". Valid values for pcm // are "8000" and "16000" The default value is "16000". SampleRate *string @@ -138,14 +137,14 @@ type Voice struct { // its default language. For example, the default language for Aditi is Indian // English (en-IN) because it was first used for that language. Since Aditi is // bilingual and fluent in both Indian English and Hindi, this parameter would show - // the code hi-IN. + // the code hi-IN . AdditionalLanguageCodes []LanguageCode // Gender of the voice. Gender Gender - // Amazon Polly assigned voice ID. This is the ID that you specify when calling the - // SynthesizeSpeech operation. + // Amazon Polly assigned voice ID. This is the ID that you specify when calling + // the SynthesizeSpeech operation. Id VoiceId // Language code of the voice. @@ -158,7 +157,7 @@ type Voice struct { // readable voice name that you might display in your application. Name *string - // Specifies which engines (standard or neural) that are supported by a given + // Specifies which engines ( standard or neural ) that are supported by a given // voice. SupportedEngines []Engine diff --git a/service/pricing/api_client.go b/service/pricing/api_client.go index 4a0d2f1d998..11bca4d10ff 100644 --- a/service/pricing/api_client.go +++ b/service/pricing/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/pricing/api_op_DescribeServices.go b/service/pricing/api_op_DescribeServices.go index 6dc4d0f68f2..3a3b7132afc 100644 --- a/service/pricing/api_op_DescribeServices.go +++ b/service/pricing/api_op_DescribeServices.go @@ -12,12 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the metadata for one service or a list of the metadata for all services. -// Use this without a service code to get the service codes for all services. Use -// it with a service code, such as AmazonEC2, to get information specific to that -// service, such as the attribute names available for that service. For example, -// some of the attribute names available for EC2 are volumeType, maxIopsVolume, -// operation, locationType, and instanceCapacity10xlarge. +// Returns the metadata for one service or a list of the metadata for all +// services. Use this without a service code to get the service codes for all +// services. Use it with a service code, such as AmazonEC2 , to get information +// specific to that service, such as the attribute names available for that +// service. For example, some of the attribute names available for EC2 are +// volumeType , maxIopsVolume , operation , locationType , and +// instanceCapacity10xlarge . func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error) { if params == nil { params = &DescribeServicesInput{} @@ -46,7 +47,7 @@ type DescribeServicesInput struct { NextToken *string // The code for the service whose information you want to retrieve, such as - // AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts + // AmazonEC2 . You can use the ServiceCode to filter the results in a GetProducts // call. To retrieve a list of all services, leave this blank. ServiceCode *string @@ -55,7 +56,7 @@ type DescribeServicesInput struct { type DescribeServicesOutput struct { - // The format version of the response. For example, aws_v1. + // The format version of the response. For example, aws_v1 . FormatVersion *string // The pagination token for the next set of retrievable results. diff --git a/service/pricing/api_op_GetAttributeValues.go b/service/pricing/api_op_GetAttributeValues.go index a2f51e4b7ef..0e203bdab11 100644 --- a/service/pricing/api_op_GetAttributeValues.go +++ b/service/pricing/api_op_GetAttributeValues.go @@ -14,10 +14,9 @@ import ( // Returns a list of attribute values. Attributes are similar to the details in a // Price List API offer file. For a list of available attributes, see Offer File -// Definitions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs) -// in the Billing and Cost Management User Guide -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html). +// Definitions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs) +// in the Billing and Cost Management User Guide (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html) +// . func (c *Client) GetAttributeValues(ctx context.Context, params *GetAttributeValuesInput, optFns ...func(*Options)) (*GetAttributeValuesOutput, error) { if params == nil { params = &GetAttributeValuesInput{} @@ -36,13 +35,13 @@ func (c *Client) GetAttributeValues(ctx context.Context, params *GetAttributeVal type GetAttributeValuesInput struct { // The name of the attribute that you want to retrieve the values for, such as - // volumeType. + // volumeType . // // This member is required. AttributeName *string // The service code for the service whose attributes you want to retrieve. For - // example, if you want the retrieve an EC2 attribute, use AmazonEC2. + // example, if you want the retrieve an EC2 attribute, use AmazonEC2 . // // This member is required. ServiceCode *string @@ -60,7 +59,7 @@ type GetAttributeValuesInput struct { type GetAttributeValuesOutput struct { // The list of values for an attribute. For example, Throughput Optimized HDD and - // Provisioned IOPS are two available values for the AmazonEC2volumeType. + // Provisioned IOPS are two available values for the AmazonEC2 volumeType . AttributeValues []types.AttributeValue // The pagination token that indicates the next set of results to retrieve. diff --git a/service/pricing/api_op_GetPriceListFileUrl.go b/service/pricing/api_op_GetPriceListFileUrl.go index 0fdd9407e8a..23dcc6b8898 100644 --- a/service/pricing/api_op_GetPriceListFileUrl.go +++ b/service/pricing/api_op_GetPriceListFileUrl.go @@ -15,8 +15,7 @@ import ( // of the Amazon Web Services Service Terms (https://aws.amazon.com/service-terms/) // (Section 1.10). This returns the URL that you can retrieve your Price List file // from. This URL is based on the PriceListArn and FileFormat that you retrieve -// from the ListPriceLists -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) +// from the ListPriceLists (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) // response. func (c *Client) GetPriceListFileUrl(ctx context.Context, params *GetPriceListFileUrlInput, optFns ...func(*Options)) (*GetPriceListFileUrlOutput, error) { if params == nil { @@ -36,16 +35,14 @@ func (c *Client) GetPriceListFileUrl(ctx context.Context, params *GetPriceListFi type GetPriceListFileUrlInput struct { // The format that you want to retrieve your Price List files in. The FileFormat - // can be obtained from the ListPriceLists - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) + // can be obtained from the ListPriceLists (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) // response. // // This member is required. FileFormat *string // The unique identifier that maps to where your Price List files are located. - // PriceListArn can be obtained from the ListPriceLists - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) + // PriceListArn can be obtained from the ListPriceLists (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) // response. // // This member is required. diff --git a/service/pricing/api_op_GetProducts.go b/service/pricing/api_op_GetProducts.go index 74571294711..540a575241a 100644 --- a/service/pricing/api_op_GetProducts.go +++ b/service/pricing/api_op_GetProducts.go @@ -60,8 +60,8 @@ type GetProductsOutput struct { // The pagination token that indicates the next set of results to retrieve. NextToken *string - // The list of products that match your filters. The list contains both the product - // metadata and the price information. + // The list of products that match your filters. The list contains both the + // product metadata and the price information. PriceList []string // Metadata pertaining to the operation's result. diff --git a/service/pricing/api_op_ListPriceLists.go b/service/pricing/api_op_ListPriceLists.go index ec40d6a7173..4a928414bc0 100644 --- a/service/pricing/api_op_ListPriceLists.go +++ b/service/pricing/api_op_ListPriceLists.go @@ -17,13 +17,12 @@ import ( // Web Services Price List API is subject to the Beta Service Participation terms // of the Amazon Web Services Service Terms (https://aws.amazon.com/service-terms/) // (Section 1.10). This returns a list of Price List references that the requester -// if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. -// Use without a RegionCode filter to list Price List references from all available -// Amazon Web Services Regions. Use with a RegionCode filter to get the Price List -// reference that's specific to a specific Amazon Web Services Region. You can use -// the PriceListArn from the response to get your preferred Price List files -// through the GetPriceListFileUrl -// (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html) +// if authorized to view, given a ServiceCode , CurrencyCode , and an EffectiveDate +// . Use without a RegionCode filter to list Price List references from all +// available Amazon Web Services Regions. Use with a RegionCode filter to get the +// Price List reference that's specific to a specific Amazon Web Services Region. +// You can use the PriceListArn from the response to get your preferred Price List +// files through the GetPriceListFileUrl (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html) // API. func (c *Client) ListPriceLists(ctx context.Context, params *ListPriceListsInput, optFns ...func(*Options)) (*ListPriceListsOutput, error) { if params == nil { @@ -55,12 +54,11 @@ type ListPriceListsInput struct { // The service code or the Savings Plan service code for the attributes that you // want to retrieve. For example, to get the list of applicable Amazon EC2 price - // lists, use AmazonEC2. For a full list of service codes containing On-Demand and - // Reserved Instance (RI) pricing, use the DescribeServices - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion) - // API. To retrieve the Compute Savings Plan price lists, use ComputeSavingsPlans. + // lists, use AmazonEC2 . For a full list of service codes containing On-Demand and + // Reserved Instance (RI) pricing, use the DescribeServices (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion) + // API. To retrieve the Compute Savings Plan price lists, use ComputeSavingsPlans . // To retrieve Machine Learning Savings Plans price lists, use - // MachineLearningSavingsPlans. + // MachineLearningSavingsPlans . // // This member is required. ServiceCode *string @@ -74,9 +72,8 @@ type ListPriceListsInput struct { // This is used to filter the Price List by Amazon Web Services Region. For // example, to get the price list only for the US East (N. Virginia) Region, use - // us-east-1. If nothing is specified, you retrieve price lists for all applicable - // Regions. The available RegionCode list can be retrieved from GetAttributeValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html) + // us-east-1 . If nothing is specified, you retrieve price lists for all applicable + // Regions. The available RegionCode list can be retrieved from GetAttributeValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html) // API. RegionCode *string diff --git a/service/pricing/doc.go b/service/pricing/doc.go index 427255a0687..2611b2b2167 100644 --- a/service/pricing/doc.go +++ b/service/pricing/doc.go @@ -1,28 +1,24 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package pricing provides the API client, operations, and parameter types for AWS -// Price List Service. +// Package pricing provides the API client, operations, and parameter types for +// AWS Price List Service. // // Amazon Web Services Price List API is a centralized and convenient way to // programmatically query Amazon Web Services for services, products, and pricing // information. The Amazon Web Services Price List uses standardized product -// attributes such as Location, Storage Class, and Operating System, and provides -// prices at the SKU level. You can use the Amazon Web Services Price List to build -// cost control and scenario planning tools, reconcile billing data, forecast -// future spend for budgeting purposes, and provide cost benefit analysis that -// compare your internal workloads with Amazon Web Services. Use GetServices +// attributes such as Location , Storage Class , and Operating System , and +// provides prices at the SKU level. You can use the Amazon Web Services Price List +// to build cost control and scenario planning tools, reconcile billing data, +// forecast future spend for budgeting purposes, and provide cost benefit analysis +// that compare your internal workloads with Amazon Web Services. Use GetServices // without a service code to retrieve the service codes for all AWS services, then // GetServices with a service code to retrieve the attribute names for that // service. After you have the service code and attribute names, you can use // GetAttributeValues to see what values are available for an attribute. With the // service code and an attribute name and value, you can use GetProducts to find -// specific products that you're interested in, such as an AmazonEC2 instance, with -// a Provisioned IOPSvolumeType. Service Endpoint Amazon Web Services Price List -// service API provides the following two endpoints: -// -// * -// https://api.pricing.us-east-1.amazonaws.com -// -// * -// https://api.pricing.ap-south-1.amazonaws.com +// specific products that you're interested in, such as an AmazonEC2 instance, +// with a Provisioned IOPS volumeType . Service Endpoint Amazon Web Services Price +// List service API provides the following two endpoints: +// - https://api.pricing.us-east-1.amazonaws.com +// - https://api.pricing.ap-south-1.amazonaws.com package pricing diff --git a/service/pricing/types/errors.go b/service/pricing/types/errors.go index bdd7a85a8ec..30bf9391a4b 100644 --- a/service/pricing/types/errors.go +++ b/service/pricing/types/errors.go @@ -59,8 +59,8 @@ func (e *ExpiredNextTokenException) ErrorCode() string { } func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An error on the server occurred during the processing of your request. Try again -// later. +// An error on the server occurred during the processing of your request. Try +// again later. type InternalErrorException struct { Message *string diff --git a/service/pricing/types/types.go b/service/pricing/types/types.go index 90499a4ade9..3d358ed62c1 100644 --- a/service/pricing/types/types.go +++ b/service/pricing/types/types.go @@ -6,11 +6,11 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// The values of a given attribute, such as Throughput Optimized HDD or Provisioned -// IOPS for the Amazon EC2volumeType attribute. +// The values of a given attribute, such as Throughput Optimized HDD or +// Provisioned IOPS for the Amazon EC2 volumeType attribute. type AttributeValue struct { - // The specific value of an attributeName. + // The specific value of an attributeName . Value *string noSmithyDocumentSerde @@ -23,14 +23,14 @@ type Filter struct { // the service code to see all products for a specific service, filter by just the // attribute name to see a specific attribute for multiple services, or use both a // service code and an attribute name to retrieve only products that match both - // fields. Valid values include: ServiceCode, and all attribute names For example, + // fields. Valid values include: ServiceCode , and all attribute names For example, // you can filter by the AmazonEC2 service code and the volumeType attribute name // to get the prices for only Amazon EC2 volumes. // // This member is required. Field *string - // The type of filter that you want to use. Valid values are: TERM_MATCH. + // The type of filter that you want to use. Valid values are: TERM_MATCH . // TERM_MATCH returns only products that match both the given filter field and the // given value. // @@ -38,8 +38,8 @@ type Filter struct { Type FilterType // The service code or attribute value that you want to filter by. If you're - // filtering by service code this is the actual service code, such as AmazonEC2. If - // you're filtering by attribute name, this is the attribute value that you want + // filtering by service code this is the actual service code, such as AmazonEC2 . + // If you're filtering by attribute name, this is the attribute value that you want // the returned products to match, such as a Provisioned IOPS volume. // // This member is required. @@ -55,27 +55,24 @@ type Filter struct { // request. type PriceList struct { - // The three alphabetical character ISO-4217 currency code the Price List files are - // denominated in. + // The three alphabetical character ISO-4217 currency code the Price List files + // are denominated in. CurrencyCode *string // The format you want to retrieve your Price List files. The FileFormat can be - // obtained from the ListPriceList - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) + // obtained from the ListPriceList (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) // response. FileFormats []string // The unique identifier that maps to where your Price List files are located. - // PriceListArn can be obtained from the ListPriceList - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) + // PriceListArn can be obtained from the ListPriceList (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html) // response. PriceListArn *string // This is used to filter the Price List by Amazon Web Services Region. For // example, to get the price list only for the US East (N. Virginia) Region, use - // us-east-1. If nothing is specified, you retrieve price lists for all applicable - // Regions. The available RegionCode list can be retrieved from GetAttributeValues - // (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html) + // us-east-1 . If nothing is specified, you retrieve price lists for all applicable + // Regions. The available RegionCode list can be retrieved from GetAttributeValues (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html) // API. RegionCode *string diff --git a/service/privatenetworks/api_client.go b/service/privatenetworks/api_client.go index ab7b0721a36..f7244d9d0db 100644 --- a/service/privatenetworks/api_client.go +++ b/service/privatenetworks/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/privatenetworks/api_op_ActivateDeviceIdentifier.go b/service/privatenetworks/api_op_ActivateDeviceIdentifier.go index 06a59d1c325..8797359e556 100644 --- a/service/privatenetworks/api_op_ActivateDeviceIdentifier.go +++ b/service/privatenetworks/api_op_ActivateDeviceIdentifier.go @@ -35,8 +35,8 @@ type ActivateDeviceIdentifierInput struct { DeviceIdentifierArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_ActivateNetworkSite.go b/service/privatenetworks/api_op_ActivateNetworkSite.go index 5aae667f21c..ae9709a7204 100644 --- a/service/privatenetworks/api_op_ActivateNetworkSite.go +++ b/service/privatenetworks/api_op_ActivateNetworkSite.go @@ -40,8 +40,8 @@ type ActivateNetworkSiteInput struct { ShippingAddress *types.Address // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_ConfigureAccessPoint.go b/service/privatenetworks/api_op_ConfigureAccessPoint.go index 1a980d3355c..459ede8fe5d 100644 --- a/service/privatenetworks/api_op_ConfigureAccessPoint.go +++ b/service/privatenetworks/api_op_ConfigureAccessPoint.go @@ -14,8 +14,7 @@ import ( // Configures the specified network resource. Use this action to specify the // geographic position of the hardware. You must provide Certified Professional // Installer (CPI) credentials in the request so that we can obtain spectrum -// grants. For more information, see Radio units -// (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html) +// grants. For more information, see Radio units (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html) // in the Amazon Web Services Private 5G User Guide. func (c *Client) ConfigureAccessPoint(ctx context.Context, params *ConfigureAccessPointInput, optFns ...func(*Options)) (*ConfigureAccessPointOutput, error) { if params == nil { @@ -43,15 +42,15 @@ type ConfigureAccessPointInput struct { // is certifying the coordinates of the network resource. CpiSecretKey *string - // The CPI user ID of the CPI user who is certifying the coordinates of the network - // resource. + // The CPI user ID of the CPI user who is certifying the coordinates of the + // network resource. CpiUserId *string - // The CPI password associated with the CPI certificate in cpiSecretKey. + // The CPI password associated with the CPI certificate in cpiSecretKey . CpiUserPassword *string - // The CPI user name of the CPI user who is certifying the coordinates of the radio - // unit. + // The CPI user name of the CPI user who is certifying the coordinates of the + // radio unit. CpiUsername *string // The position of the network resource. diff --git a/service/privatenetworks/api_op_CreateNetwork.go b/service/privatenetworks/api_op_CreateNetwork.go index ec821fbb73b..7dfb43ae00e 100644 --- a/service/privatenetworks/api_op_CreateNetwork.go +++ b/service/privatenetworks/api_op_CreateNetwork.go @@ -35,8 +35,8 @@ type CreateNetworkInput struct { NetworkName *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the network. diff --git a/service/privatenetworks/api_op_CreateNetworkSite.go b/service/privatenetworks/api_op_CreateNetworkSite.go index 89c24aed361..f04fedcce38 100644 --- a/service/privatenetworks/api_op_CreateNetworkSite.go +++ b/service/privatenetworks/api_op_CreateNetworkSite.go @@ -48,8 +48,8 @@ type CreateNetworkSiteInput struct { AvailabilityZoneId *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // The description of the site. diff --git a/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go b/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go index eb8fd15e73d..a30eed501cb 100644 --- a/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go +++ b/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go @@ -35,8 +35,8 @@ type DeactivateDeviceIdentifierInput struct { DeviceIdentifierArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_DeleteNetwork.go b/service/privatenetworks/api_op_DeleteNetwork.go index 84654c6d4b3..ab8f5c84a4c 100644 --- a/service/privatenetworks/api_op_DeleteNetwork.go +++ b/service/privatenetworks/api_op_DeleteNetwork.go @@ -12,8 +12,7 @@ import ( ) // Deletes the specified network. You must delete network sites before you delete -// the network. For more information, see DeleteNetworkSite -// (https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html) +// the network. For more information, see DeleteNetworkSite (https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html) // in the API Reference for Amazon Web Services Private 5G. func (c *Client) DeleteNetwork(ctx context.Context, params *DeleteNetworkInput, optFns ...func(*Options)) (*DeleteNetworkOutput, error) { if params == nil { @@ -38,8 +37,8 @@ type DeleteNetworkInput struct { NetworkArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_DeleteNetworkSite.go b/service/privatenetworks/api_op_DeleteNetworkSite.go index fbc94d042cb..304070c53e4 100644 --- a/service/privatenetworks/api_op_DeleteNetworkSite.go +++ b/service/privatenetworks/api_op_DeleteNetworkSite.go @@ -13,8 +13,7 @@ import ( // Deletes the specified network site. Return the hardware after you delete the // network site. You are responsible for minimum charges. For more information, see -// Hardware returns -// (https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html) +// Hardware returns (https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html) // in the Amazon Web Services Private 5G User Guide. func (c *Client) DeleteNetworkSite(ctx context.Context, params *DeleteNetworkSiteInput, optFns ...func(*Options)) (*DeleteNetworkSiteOutput, error) { if params == nil { @@ -39,8 +38,8 @@ type DeleteNetworkSiteInput struct { NetworkSiteArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_ListDeviceIdentifiers.go b/service/privatenetworks/api_op_ListDeviceIdentifiers.go index 2a9e7fec6d8..1cade8f3b0c 100644 --- a/service/privatenetworks/api_op_ListDeviceIdentifiers.go +++ b/service/privatenetworks/api_op_ListDeviceIdentifiers.go @@ -40,18 +40,12 @@ type ListDeviceIdentifiersInput struct { NetworkArn *string // The filters. - // - // * ORDER - The Amazon Resource Name (ARN) of the order. - // - // * STATUS - - // The status (ACTIVE | INACTIVE). - // - // * TRAFFIC_GROUP - The Amazon Resource Name - // (ARN) of the traffic group. - // - // Filter values are case sensitive. If you specify - // multiple values for a filter, the values are joined with an OR, and the request - // returns all results that match any of the specified values. + // - ORDER - The Amazon Resource Name (ARN) of the order. + // - STATUS - The status ( ACTIVE | INACTIVE ). + // - TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group. + // Filter values are case sensitive. If you specify multiple values for a filter, + // the values are joined with an OR , and the request returns all results that + // match any of the specified values. Filters map[string][]string // The maximum number of results to return. diff --git a/service/privatenetworks/api_op_ListNetworkResources.go b/service/privatenetworks/api_op_ListNetworkResources.go index 129c149a112..a265aafa672 100644 --- a/service/privatenetworks/api_op_ListNetworkResources.go +++ b/service/privatenetworks/api_op_ListNetworkResources.go @@ -40,16 +40,12 @@ type ListNetworkResourcesInput struct { NetworkArn *string // The filters. - // - // * ORDER - The Amazon Resource Name (ARN) of the order. - // - // * STATUS - - // The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | - // PROVISIONING | SHIPPED). - // - // Filter values are case sensitive. If you specify - // multiple values for a filter, the values are joined with an OR, and the request - // returns all results that match any of the specified values. + // - ORDER - The Amazon Resource Name (ARN) of the order. + // - STATUS - The status ( AVAILABLE | DELETED | DELETING | PENDING | + // PENDING_RETURN | PROVISIONING | SHIPPED ). + // Filter values are case sensitive. If you specify multiple values for a filter, + // the values are joined with an OR , and the request returns all results that + // match any of the specified values. Filters map[string][]string // The maximum number of results to return. diff --git a/service/privatenetworks/api_op_ListNetworkSites.go b/service/privatenetworks/api_op_ListNetworkSites.go index 732a316af1e..97aea9c8597 100644 --- a/service/privatenetworks/api_op_ListNetworkSites.go +++ b/service/privatenetworks/api_op_ListNetworkSites.go @@ -38,14 +38,11 @@ type ListNetworkSitesInput struct { // The filters. Add filters to your request to return a more specific list of // results. Use filters to match the status of the network sites. - // - // * STATUS - The - // status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING). - // - // Filter - // values are case sensitive. If you specify multiple values for a filter, the - // values are joined with an OR, and the request returns all results that match any - // of the specified values. + // - STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING | + // PROVISIONING ). + // Filter values are case sensitive. If you specify multiple values for a filter, + // the values are joined with an OR , and the request returns all results that + // match any of the specified values. Filters map[string][]string // The maximum number of results to return. diff --git a/service/privatenetworks/api_op_ListNetworks.go b/service/privatenetworks/api_op_ListNetworks.go index 501ba149221..7a9e101000d 100644 --- a/service/privatenetworks/api_op_ListNetworks.go +++ b/service/privatenetworks/api_op_ListNetworks.go @@ -32,13 +32,11 @@ func (c *Client) ListNetworks(ctx context.Context, params *ListNetworksInput, op type ListNetworksInput struct { // The filters. - // - // * STATUS - The status (AVAILABLE | CREATED | DELETED | - // DEPROVISIONING | PROVISIONING). - // - // Filter values are case sensitive. If you - // specify multiple values for a filter, the values are joined with an OR, and the - // request returns all results that match any of the specified values. + // - STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING | + // PROVISIONING ). + // Filter values are case sensitive. If you specify multiple values for a filter, + // the values are joined with an OR , and the request returns all results that + // match any of the specified values. Filters map[string][]string // The maximum number of results to return. diff --git a/service/privatenetworks/api_op_ListOrders.go b/service/privatenetworks/api_op_ListOrders.go index 6f206392716..ce1c645098f 100644 --- a/service/privatenetworks/api_op_ListOrders.go +++ b/service/privatenetworks/api_op_ListOrders.go @@ -40,16 +40,11 @@ type ListOrdersInput struct { NetworkArn *string // The filters. - // - // * NETWORK_SITE - The Amazon Resource Name (ARN) of the network - // site. - // - // * STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | - // UNACKNOWLEDGED). - // - // Filter values are case sensitive. If you specify multiple - // values for a filter, the values are joined with an OR, and the request returns - // all results that match any of the specified values. + // - NETWORK_SITE - The Amazon Resource Name (ARN) of the network site. + // - STATUS - The status ( ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED ). + // Filter values are case sensitive. If you specify multiple values for a filter, + // the values are joined with an OR , and the request returns all results that + // match any of the specified values. Filters map[string][]string // The maximum number of results to return. diff --git a/service/privatenetworks/api_op_StartNetworkResourceUpdate.go b/service/privatenetworks/api_op_StartNetworkResourceUpdate.go index 6594895030b..58e6c033232 100644 --- a/service/privatenetworks/api_op_StartNetworkResourceUpdate.go +++ b/service/privatenetworks/api_op_StartNetworkResourceUpdate.go @@ -13,10 +13,10 @@ import ( // Starts an update of the specified network resource. After you submit a request // to replace or return a network resource, the status of the network resource is -// CREATING_SHIPPING_LABEL. The shipping label is available when the status of the -// network resource is PENDING_RETURN. After the network resource is successfully -// returned, its status is DELETED. For more information, see Return a radio unit -// (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit). +// CREATING_SHIPPING_LABEL . The shipping label is available when the status of the +// network resource is PENDING_RETURN . After the network resource is successfully +// returned, its status is DELETED . For more information, see Return a radio unit (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit) +// . func (c *Client) StartNetworkResourceUpdate(ctx context.Context, params *StartNetworkResourceUpdateInput, optFns ...func(*Options)) (*StartNetworkResourceUpdateOutput, error) { if params == nil { params = &StartNetworkResourceUpdateInput{} @@ -40,14 +40,11 @@ type StartNetworkResourceUpdateInput struct { NetworkResourceArn *string // The update type. - // - // * REPLACE - Submits a request to replace a defective radio - // unit. We provide a shipping label that you can use for the return process and we - // ship a replacement radio unit to you. - // - // * RETURN - Submits a request to replace a - // radio unit that you no longer need. We provide a shipping label that you can use - // for the return process. + // - REPLACE - Submits a request to replace a defective radio unit. We provide a + // shipping label that you can use for the return process and we ship a replacement + // radio unit to you. + // - RETURN - Submits a request to replace a radio unit that you no longer need. + // We provide a shipping label that you can use for the return process. // // This member is required. UpdateType types.UpdateType diff --git a/service/privatenetworks/api_op_UpdateNetworkSite.go b/service/privatenetworks/api_op_UpdateNetworkSite.go index 0f6eb79f7c5..8e690e02144 100644 --- a/service/privatenetworks/api_op_UpdateNetworkSite.go +++ b/service/privatenetworks/api_op_UpdateNetworkSite.go @@ -35,8 +35,8 @@ type UpdateNetworkSiteInput struct { NetworkSiteArn *string // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string // The description. diff --git a/service/privatenetworks/api_op_UpdateNetworkSitePlan.go b/service/privatenetworks/api_op_UpdateNetworkSitePlan.go index 515bbfcc2f1..aee61b5e039 100644 --- a/service/privatenetworks/api_op_UpdateNetworkSitePlan.go +++ b/service/privatenetworks/api_op_UpdateNetworkSitePlan.go @@ -40,8 +40,8 @@ type UpdateNetworkSitePlanInput struct { PendingPlan *types.SitePlan // Unique, case-sensitive identifier that you provide to ensure the idempotency of - // the request. For more information, see How to ensure idempotency - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html). + // the request. For more information, see How to ensure idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) + // . ClientToken *string noSmithyDocumentSerde diff --git a/service/privatenetworks/doc.go b/service/privatenetworks/doc.go index a2031859ab3..46ab841f97f 100644 --- a/service/privatenetworks/doc.go +++ b/service/privatenetworks/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package privatenetworks provides the API client, operations, and parameter types -// for AWS Private 5G. +// Package privatenetworks provides the API client, operations, and parameter +// types for AWS Private 5G. // // Amazon Web Services Private 5G is a managed service that makes it easy to // deploy, operate, and scale your own private mobile network at your on-premises diff --git a/service/privatenetworks/types/enums.go b/service/privatenetworks/types/enums.go index eeb5de49820..576068f9bf9 100644 --- a/service/privatenetworks/types/enums.go +++ b/service/privatenetworks/types/enums.go @@ -104,9 +104,9 @@ const ( HealthStatusUnhealthy HealthStatus = "UNHEALTHY" ) -// Values returns all known values for HealthStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HealthStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HealthStatus) Values() []HealthStatus { return []HealthStatus{ "INITIAL", @@ -183,8 +183,8 @@ const ( NetworkResourceStatusCreatingShippingLabel NetworkResourceStatus = "CREATING_SHIPPING_LABEL" ) -// Values returns all known values for NetworkResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NetworkResourceStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NetworkResourceStatus) Values() []NetworkResourceStatus { return []NetworkResourceStatus{ @@ -223,8 +223,8 @@ const ( NetworkSiteFilterKeysStatus NetworkSiteFilterKeys = "STATUS" ) -// Values returns all known values for NetworkSiteFilterKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for NetworkSiteFilterKeys. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (NetworkSiteFilterKeys) Values() []NetworkSiteFilterKeys { return []NetworkSiteFilterKeys{ diff --git a/service/privatenetworks/types/types.go b/service/privatenetworks/types/types.go index 5c578c329ae..69414739042 100644 --- a/service/privatenetworks/types/types.go +++ b/service/privatenetworks/types/types.go @@ -319,10 +319,10 @@ type ReturnInformation struct { // The shipping address. ShippingAddress *Address - // The URL of the shipping label. The shipping label is available for download only - // if the status of the network resource is PENDING_RETURN. For more information, - // see Return a radio unit - // (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit). + // The URL of the shipping label. The shipping label is available for download + // only if the status of the network resource is PENDING_RETURN . For more + // information, see Return a radio unit (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit) + // . ShippingLabel *string noSmithyDocumentSerde diff --git a/service/proton/api_client.go b/service/proton/api_client.go index 990ebd0e23c..0268e4c2588 100644 --- a/service/proton/api_client.go +++ b/service/proton/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/proton/api_op_AcceptEnvironmentAccountConnection.go b/service/proton/api_op_AcceptEnvironmentAccountConnection.go index d1b4ca00eab..0b422c562ba 100644 --- a/service/proton/api_op_AcceptEnvironmentAccountConnection.go +++ b/service/proton/api_op_AcceptEnvironmentAccountConnection.go @@ -15,8 +15,7 @@ import ( // When the environment account connection request is accepted, Proton can use the // associated IAM role to provision environment infrastructure resources in the // associated environment account. For more information, see Environment account -// connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) AcceptEnvironmentAccountConnection(ctx context.Context, params *AcceptEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*AcceptEnvironmentAccountConnectionOutput, error) { if params == nil { diff --git a/service/proton/api_op_CancelComponentDeployment.go b/service/proton/api_op_CancelComponentDeployment.go index 00d53c09ba3..63b1a3aad5b 100644 --- a/service/proton/api_op_CancelComponentDeployment.go +++ b/service/proton/api_op_CancelComponentDeployment.go @@ -13,9 +13,8 @@ import ( // Attempts to cancel a component deployment (for a component that is in the // IN_PROGRESS deployment status). For more information about components, see -// Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) CancelComponentDeployment(ctx context.Context, params *CancelComponentDeploymentInput, optFns ...func(*Options)) (*CancelComponentDeploymentOutput, error) { if params == nil { params = &CancelComponentDeploymentInput{} diff --git a/service/proton/api_op_CancelEnvironmentDeployment.go b/service/proton/api_op_CancelEnvironmentDeployment.go index a11adf1412f..38f6b2e745d 100644 --- a/service/proton/api_op_CancelEnvironmentDeployment.go +++ b/service/proton/api_op_CancelEnvironmentDeployment.go @@ -12,20 +12,16 @@ import ( ) // Attempts to cancel an environment deployment on an UpdateEnvironment action, if -// the deployment is IN_PROGRESS. For more information, see Update an environment -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html) in the -// Proton User guide. The following list includes potential cancellation +// the deployment is IN_PROGRESS . For more information, see Update an environment (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html) +// in the Proton User guide. The following list includes potential cancellation // scenarios. -// -// * If the cancellation attempt succeeds, the resulting deployment -// state is CANCELLED. -// -// * If the cancellation attempt fails, the resulting -// deployment state is FAILED. -// -// * If the current UpdateEnvironment action succeeds -// before the cancellation attempt starts, the resulting deployment state is -// SUCCEEDED and the cancellation attempt has no effect. +// - If the cancellation attempt succeeds, the resulting deployment state is +// CANCELLED . +// - If the cancellation attempt fails, the resulting deployment state is FAILED +// . +// - If the current UpdateEnvironment action succeeds before the cancellation +// attempt starts, the resulting deployment state is SUCCEEDED and the +// cancellation attempt has no effect. func (c *Client) CancelEnvironmentDeployment(ctx context.Context, params *CancelEnvironmentDeploymentInput, optFns ...func(*Options)) (*CancelEnvironmentDeploymentOutput, error) { if params == nil { params = &CancelEnvironmentDeploymentInput{} diff --git a/service/proton/api_op_CancelServiceInstanceDeployment.go b/service/proton/api_op_CancelServiceInstanceDeployment.go index 4fa2e5604da..c78b7f5e23e 100644 --- a/service/proton/api_op_CancelServiceInstanceDeployment.go +++ b/service/proton/api_op_CancelServiceInstanceDeployment.go @@ -12,21 +12,17 @@ import ( ) // Attempts to cancel a service instance deployment on an UpdateServiceInstance -// action, if the deployment is IN_PROGRESS. For more information, see Update a -// service instance -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html) +// action, if the deployment is IN_PROGRESS . For more information, see Update a +// service instance (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html) // in the Proton User guide. The following list includes potential cancellation // scenarios. -// -// * If the cancellation attempt succeeds, the resulting deployment -// state is CANCELLED. -// -// * If the cancellation attempt fails, the resulting -// deployment state is FAILED. -// -// * If the current UpdateServiceInstance action -// succeeds before the cancellation attempt starts, the resulting deployment state -// is SUCCEEDED and the cancellation attempt has no effect. +// - If the cancellation attempt succeeds, the resulting deployment state is +// CANCELLED . +// - If the cancellation attempt fails, the resulting deployment state is FAILED +// . +// - If the current UpdateServiceInstance action succeeds before the cancellation +// attempt starts, the resulting deployment state is SUCCEEDED and the +// cancellation attempt has no effect. func (c *Client) CancelServiceInstanceDeployment(ctx context.Context, params *CancelServiceInstanceDeploymentInput, optFns ...func(*Options)) (*CancelServiceInstanceDeploymentOutput, error) { if params == nil { params = &CancelServiceInstanceDeploymentInput{} diff --git a/service/proton/api_op_CancelServicePipelineDeployment.go b/service/proton/api_op_CancelServicePipelineDeployment.go index 6b2966f4739..98d79a94a51 100644 --- a/service/proton/api_op_CancelServicePipelineDeployment.go +++ b/service/proton/api_op_CancelServicePipelineDeployment.go @@ -12,21 +12,17 @@ import ( ) // Attempts to cancel a service pipeline deployment on an UpdateServicePipeline -// action, if the deployment is IN_PROGRESS. For more information, see Update a -// service pipeline -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html) +// action, if the deployment is IN_PROGRESS . For more information, see Update a +// service pipeline (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html) // in the Proton User guide. The following list includes potential cancellation // scenarios. -// -// * If the cancellation attempt succeeds, the resulting deployment -// state is CANCELLED. -// -// * If the cancellation attempt fails, the resulting -// deployment state is FAILED. -// -// * If the current UpdateServicePipeline action -// succeeds before the cancellation attempt starts, the resulting deployment state -// is SUCCEEDED and the cancellation attempt has no effect. +// - If the cancellation attempt succeeds, the resulting deployment state is +// CANCELLED . +// - If the cancellation attempt fails, the resulting deployment state is FAILED +// . +// - If the current UpdateServicePipeline action succeeds before the cancellation +// attempt starts, the resulting deployment state is SUCCEEDED and the +// cancellation attempt has no effect. func (c *Client) CancelServicePipelineDeployment(ctx context.Context, params *CancelServicePipelineDeploymentInput, optFns ...func(*Options)) (*CancelServicePipelineDeploymentOutput, error) { if params == nil { params = &CancelServicePipelineDeploymentInput{} diff --git a/service/proton/api_op_CreateComponent.go b/service/proton/api_op_CreateComponent.go index a2428e17e0a..3c3d788700e 100644 --- a/service/proton/api_op_CreateComponent.go +++ b/service/proton/api_op_CreateComponent.go @@ -13,9 +13,8 @@ import ( ) // Create an Proton component. A component is an infrastructure extension for a -// service instance. For more information about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// service instance. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error) { if params == nil { params = &CreateComponentInput{} @@ -47,8 +46,8 @@ type CreateComponentInput struct { // This member is required. Name *string - // A path to the Infrastructure as Code (IaC) file describing infrastructure that a - // custom component provisions. Components support a single IaC file, even if you + // A path to the Infrastructure as Code (IaC) file describing infrastructure that + // a custom component provisions. Components support a single IaC file, even if you // use Terraform as your template language. // // This value conforms to the media type: application/yaml @@ -64,7 +63,7 @@ type CreateComponentInput struct { // The name of the Proton environment that you want to associate this component // with. You must specify this when you don't specify serviceInstanceName and - // serviceName. + // serviceName . EnvironmentName *string // The name of the service instance that you want to attach this component to. If @@ -84,8 +83,8 @@ type CreateComponentInput struct { ServiceSpec *string // An optional list of metadata items that you can associate with the Proton - // component. A tag is a key-value pair. For more information, see Proton resources - // and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // component. A tag is a key-value pair. For more information, see Proton + // resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) // in the Proton User Guide. Tags []types.Tag diff --git a/service/proton/api_op_CreateEnvironment.go b/service/proton/api_op_CreateEnvironment.go index da010c9310c..885e427c8cf 100644 --- a/service/proton/api_op_CreateEnvironment.go +++ b/service/proton/api_op_CreateEnvironment.go @@ -14,19 +14,14 @@ import ( // Deploy a new environment. An Proton environment is created from an environment // template that defines infrastructure and resources that can be shared across // services. You can provision environments using the following methods: +// - Amazon Web Services-managed provisioning: Proton makes direct calls to +// provision your resources. +// - Self-managed provisioning: Proton makes pull requests on your repository to +// provide compiled infrastructure as code (IaC) files that your IaC engine uses to +// provision resources. // -// * Amazon -// Web Services-managed provisioning: Proton makes direct calls to provision your -// resources. -// -// * Self-managed provisioning: Proton makes pull requests on your -// repository to provide compiled infrastructure as code (IaC) files that your IaC -// engine uses to provision resources. -// -// For more information, see Environments -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) and -// Provisioning methods -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) +// For more information, see Environments (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) +// and Provisioning methods (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) // in the Proton User Guide. func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error) { if params == nil { @@ -51,9 +46,8 @@ type CreateEnvironmentInput struct { Name *string // A YAML formatted string that provides inputs as defined in the environment - // template bundle schema file. For more information, see Environments - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) in - // the Proton User Guide. + // template bundle schema file. For more information, see Environments (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) + // in the Proton User Guide. // // This value conforms to the media type: application/yaml // @@ -66,9 +60,8 @@ type CreateEnvironmentInput struct { TemplateMajorVersion *string // The name of the environment template. For more information, see Environment - // Templates - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the - // Proton User Guide. + // Templates (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) + // in the Proton User Guide. // // This member is required. TemplateName *string @@ -76,17 +69,16 @@ type CreateEnvironmentInput struct { // The Amazon Resource Name (ARN) of the IAM service role that allows Proton to // provision infrastructure using CodeBuild-based provisioning on your behalf. To // use CodeBuild-based provisioning for the environment or for any service instance - // running in the environment, specify either the environmentAccountConnectionId or - // codebuildRoleArn parameter. + // running in the environment, specify either the environmentAccountConnectionId + // or codebuildRoleArn parameter. CodebuildRoleArn *string // The Amazon Resource Name (ARN) of the IAM service role that Proton uses when // provisioning directly defined components in this environment. It determines the // scope of infrastructure that a component can provision. You must specify // componentRoleArn to allow directly defined components to be associated with this - // environment. For more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // environment. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // A description of the environment that's being created and deployed. @@ -94,8 +86,7 @@ type CreateEnvironmentInput struct { // The ID of the environment account connection that you provide if you're // provisioning your environment infrastructure resources to an environment - // account. For more information, see Environment account connections - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) + // account. For more information, see Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. To use Amazon Web Services-managed provisioning for // the environment, specify either the environmentAccountConnectionId or // protonServiceRoleArn parameter and omit the provisioningRepository parameter. @@ -110,17 +101,15 @@ type CreateEnvironmentInput struct { // The linked repository that you use to host your rendered infrastructure // templates for self-managed provisioning. A linked repository is a repository - // that has been registered with Proton. For more information, see - // CreateRepository. To use self-managed provisioning for the environment, specify - // this parameter and omit the environmentAccountConnectionId and - // protonServiceRoleArn parameters. + // that has been registered with Proton. For more information, see CreateRepository + // . To use self-managed provisioning for the environment, specify this parameter + // and omit the environmentAccountConnectionId and protonServiceRoleArn parameters. ProvisioningRepository *types.RepositoryBranchInput // An optional list of metadata items that you can associate with the Proton // environment. A tag is a key-value pair. For more information, see Proton - // resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag // The minor version of the environment template. diff --git a/service/proton/api_op_CreateEnvironmentAccountConnection.go b/service/proton/api_op_CreateEnvironmentAccountConnection.go index 0f4c0803766..cea4676da84 100644 --- a/service/proton/api_op_CreateEnvironmentAccountConnection.go +++ b/service/proton/api_op_CreateEnvironmentAccountConnection.go @@ -17,8 +17,7 @@ import ( // account from a management account. An environment account connection is a secure // bi-directional connection between a management account and an environment // account that maintains authorization and permissions. For more information, see -// Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) CreateEnvironmentAccountConnection(ctx context.Context, params *CreateEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*CreateEnvironmentAccountConnectionOutput, error) { if params == nil { @@ -43,11 +42,11 @@ type CreateEnvironmentAccountConnectionInput struct { // This member is required. EnvironmentName *string - // The ID of the management account that accepts or rejects the environment account - // connection. You create and manage the Proton environment in this account. If the - // management account accepts the environment account connection, Proton can use - // the associated IAM role to provision environment infrastructure resources in the - // associated environment account. + // The ID of the management account that accepts or rejects the environment + // account connection. You create and manage the Proton environment in this + // account. If the management account accepts the environment account connection, + // Proton can use the associated IAM role to provision environment infrastructure + // resources in the associated environment account. // // This member is required. ManagementAccountId *string @@ -67,9 +66,8 @@ type CreateEnvironmentAccountConnectionInput struct { // It determines the scope of infrastructure that a component can provision in the // account. You must specify componentRoleArn to allow directly defined components // to be associated with any environments running in this account. For more - // information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // The Amazon Resource Name (ARN) of the IAM service role that's created in the @@ -79,9 +77,8 @@ type CreateEnvironmentAccountConnectionInput struct { // An optional list of metadata items that you can associate with the Proton // environment account connection. A tag is a key-value pair. For more information, - // see Proton resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // see Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateEnvironmentTemplate.go b/service/proton/api_op_CreateEnvironmentTemplate.go index f2c44a9ecd9..2f8b26dc1e2 100644 --- a/service/proton/api_op_CreateEnvironmentTemplate.go +++ b/service/proton/api_op_CreateEnvironmentTemplate.go @@ -11,24 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create an environment template for Proton. For more information, see Environment -// Templates -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the -// Proton User Guide. You can create an environment template in one of the two -// following ways: -// -// * Register and publish a standard environment template that -// instructs Proton to deploy and manage environment infrastructure. -// -// * Register -// and publish a customer managed environment template that connects Proton to your -// existing provisioned infrastructure that you manage. Proton doesn't manage your -// existing provisioned infrastructure. To create an environment template for -// customer provisioned and managed infrastructure, include the provisioning -// parameter and set the value to CUSTOMER_MANAGED. For more information, see -// Register and publish an environment template -// (https://docs.aws.amazon.com/proton/latest/userguide/template-create.html) in -// the Proton User Guide. +// Create an environment template for Proton. For more information, see +// Environment Templates (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) +// in the Proton User Guide. You can create an environment template in one of the +// two following ways: +// - Register and publish a standard environment template that instructs Proton +// to deploy and manage environment infrastructure. +// - Register and publish a customer managed environment template that connects +// Proton to your existing provisioned infrastructure that you manage. Proton +// doesn't manage your existing provisioned infrastructure. To create an +// environment template for customer provisioned and managed infrastructure, +// include the provisioning parameter and set the value to CUSTOMER_MANAGED . For +// more information, see Register and publish an environment template (https://docs.aws.amazon.com/proton/latest/userguide/template-create.html) +// in the Proton User Guide. func (c *Client) CreateEnvironmentTemplate(ctx context.Context, params *CreateEnvironmentTemplateInput, optFns ...func(*Options)) (*CreateEnvironmentTemplateOutput, error) { if params == nil { params = &CreateEnvironmentTemplateInput{} @@ -66,9 +61,8 @@ type CreateEnvironmentTemplateInput struct { // An optional list of metadata items that you can associate with the Proton // environment template. A tag is a key-value pair. For more information, see - // Proton resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateEnvironmentTemplateVersion.go b/service/proton/api_op_CreateEnvironmentTemplateVersion.go index 41bd9f9bb35..5af8729b28a 100644 --- a/service/proton/api_op_CreateEnvironmentTemplateVersion.go +++ b/service/proton/api_op_CreateEnvironmentTemplateVersion.go @@ -51,16 +51,15 @@ type CreateEnvironmentTemplateVersionInput struct { // A description of the new version of an environment template. Description *string - // To create a new minor version of the environment template, include major - // Version. To create a new major and minor version of the environment template, - // exclude major Version. + // To create a new minor version of the environment template, include major Version + // . To create a new major and minor version of the environment template, exclude + // major Version . MajorVersion *string // An optional list of metadata items that you can associate with the Proton // environment template version. A tag is a key-value pair. For more information, - // see Proton resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // see Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateRepository.go b/service/proton/api_op_CreateRepository.go index 7e0bdec3cfa..f2e6552b8e7 100644 --- a/service/proton/api_op_CreateRepository.go +++ b/service/proton/api_op_CreateRepository.go @@ -16,14 +16,10 @@ import ( // from it (template sync). You can share a linked repository across multiple // resources (like environments using self-managed provisioning, or synced // templates). When you create a repository link, Proton creates a service-linked -// role -// (https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html) -// for you. For more information, see Self-managed provisioning -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self), -// Template bundles -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles), -// and Template sync configurations -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) +// role (https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html) +// for you. For more information, see Self-managed provisioning (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) +// , Template bundles (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles) +// , and Template sync configurations (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) // in the Proton User Guide. func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { @@ -43,15 +39,14 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI type CreateRepositoryInput struct { // The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects - // Proton to your repository provider account. For more information, see Setting up - // for Proton - // (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html) + // Proton to your repository provider account. For more information, see Setting + // up for Proton (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html) // in the Proton User Guide. // // This member is required. ConnectionArn *string - // The repository name (for example, myrepos/myrepo). + // The repository name (for example, myrepos/myrepo ). // // This member is required. Name *string @@ -67,9 +62,8 @@ type CreateRepositoryInput struct { // An optional list of metadata items that you can associate with the Proton // repository. A tag is a key-value pair. For more information, see Proton - // resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateService.go b/service/proton/api_op_CreateService.go index 00a10568f05..bdec211205c 100644 --- a/service/proton/api_op_CreateService.go +++ b/service/proton/api_op_CreateService.go @@ -13,9 +13,8 @@ import ( // Create an Proton service. An Proton service is an instantiation of a service // template and often includes several service instances and pipeline. For more -// information, see Services -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html) in the -// Proton User Guide. +// information, see Services (https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html) +// in the Proton User Guide. func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -41,9 +40,8 @@ type CreateServiceInput struct { // A link to a spec file that provides inputs as defined in the service template // bundle schema file. The spec file is in YAML format. Don’t include pipeline // inputs in the spec if your service template doesn’t include a service pipeline. - // For more information, see Create a service - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html) in the - // Proton User Guide. + // For more information, see Create a service (https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html) + // in the Proton User Guide. // // This value conforms to the media type: application/yaml // @@ -69,8 +67,7 @@ type CreateServiceInput struct { Description *string // The Amazon Resource Name (ARN) of the repository connection. For more - // information, see Setting up an AWS CodeStar connection - // (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol) + // information, see Setting up an AWS CodeStar connection (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol) // in the Proton User Guide. Don't include this parameter if your service template // doesn't include a service pipeline. RepositoryConnectionArn *string diff --git a/service/proton/api_op_CreateServiceInstance.go b/service/proton/api_op_CreateServiceInstance.go index 1bdcb1d9399..4a37c68ceb1 100644 --- a/service/proton/api_op_CreateServiceInstance.go +++ b/service/proton/api_op_CreateServiceInstance.go @@ -52,16 +52,15 @@ type CreateServiceInstanceInput struct { // An optional list of metadata items that you can associate with the Proton // service instance. A tag is a key-value pair. For more information, see Proton - // resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag // To create a new major and minor version of the service template, exclude major - // Version. + // Version . TemplateMajorVersion *string - // To create a new minor version of the service template, include a major Version. + // To create a new minor version of the service template, include a major Version . TemplateMinorVersion *string noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateServiceTemplate.go b/service/proton/api_op_CreateServiceTemplate.go index 60184595a6d..469a1cf202d 100644 --- a/service/proton/api_op_CreateServiceTemplate.go +++ b/service/proton/api_op_CreateServiceTemplate.go @@ -17,9 +17,8 @@ import ( // service template includes a service pipeline definition, they provide a link to // their source code repository. Proton then deploys and manages the infrastructure // defined by the selected service template. For more information, see Proton -// templates -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) in the -// Proton User Guide. +// templates (https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html) +// in the Proton User Guide. func (c *Client) CreateServiceTemplate(ctx context.Context, params *CreateServiceTemplateInput, optFns ...func(*Options)) (*CreateServiceTemplateOutput, error) { if params == nil { params = &CreateServiceTemplateInput{} @@ -54,16 +53,14 @@ type CreateServiceTemplateInput struct { // By default, Proton provides a service pipeline for your service. When this // parameter is included, it indicates that an Proton service pipeline isn't // provided for your service. After it's included, it can't be changed. For more - // information, see Template bundles - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles) + // information, see Template bundles (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles) // in the Proton User Guide. PipelineProvisioning types.Provisioning // An optional list of metadata items that you can associate with the Proton // service template. A tag is a key-value pair. For more information, see Proton - // resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateServiceTemplateVersion.go b/service/proton/api_op_CreateServiceTemplateVersion.go index c880a346cc5..bec350f5acc 100644 --- a/service/proton/api_op_CreateServiceTemplateVersion.go +++ b/service/proton/api_op_CreateServiceTemplateVersion.go @@ -58,23 +58,21 @@ type CreateServiceTemplateVersionInput struct { // A description of the new version of a service template. Description *string - // To create a new minor version of the service template, include a major Version. + // To create a new minor version of the service template, include a major Version . // To create a new major and minor version of the service template, exclude major - // Version. + // Version . MajorVersion *string // An array of supported component sources. Components with supported sources can // be attached to service instances based on this service template version. For - // more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. SupportedComponentSources []types.ServiceTemplateSupportedComponentSourceType // An optional list of metadata items that you can associate with the Proton // service template version. A tag is a key-value pair. For more information, see - // Proton resources and tagging - // (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the - // Proton User Guide. + // Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) + // in the Proton User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateTemplateSyncConfig.go b/service/proton/api_op_CreateTemplateSyncConfig.go index 8399720085f..9a0c807d140 100644 --- a/service/proton/api_op_CreateTemplateSyncConfig.go +++ b/service/proton/api_op_CreateTemplateSyncConfig.go @@ -13,12 +13,11 @@ import ( // Set up a template to create new template versions automatically by tracking a // linked repository. A linked repository is a repository that has been registered -// with Proton. For more information, see CreateRepository. When a commit is pushed -// to your linked repository, Proton checks for changes to your repository template -// bundles. If it detects a template bundle change, a new major or minor version of -// its template is created, if the version doesn’t already exist. For more -// information, see Template sync configurations -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) +// with Proton. For more information, see CreateRepository . When a commit is +// pushed to your linked repository, Proton checks for changes to your repository +// template bundles. If it detects a template bundle change, a new major or minor +// version of its template is created, if the version doesn’t already exist. For +// more information, see Template sync configurations (https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html) // in the Proton User Guide. func (c *Client) CreateTemplateSyncConfig(ctx context.Context, params *CreateTemplateSyncConfigInput, optFns ...func(*Options)) (*CreateTemplateSyncConfigOutput, error) { if params == nil { @@ -42,7 +41,7 @@ type CreateTemplateSyncConfigInput struct { // This member is required. Branch *string - // The repository name (for example, myrepos/myrepo). + // The repository name (for example, myrepos/myrepo ). // // This member is required. RepositoryName *string @@ -62,8 +61,8 @@ type CreateTemplateSyncConfigInput struct { // This member is required. TemplateType types.TemplateType - // A repository subdirectory path to your template bundle directory. When included, - // Proton limits the template bundle search to this repository directory. + // A repository subdirectory path to your template bundle directory. When + // included, Proton limits the template bundle search to this repository directory. Subdirectory *string noSmithyDocumentSerde diff --git a/service/proton/api_op_DeleteComponent.go b/service/proton/api_op_DeleteComponent.go index 49fac790395..42c482d571d 100644 --- a/service/proton/api_op_DeleteComponent.go +++ b/service/proton/api_op_DeleteComponent.go @@ -12,9 +12,8 @@ import ( ) // Delete an Proton component resource. For more information about components, see -// Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) DeleteComponent(ctx context.Context, params *DeleteComponentInput, optFns ...func(*Options)) (*DeleteComponentOutput, error) { if params == nil { params = &DeleteComponentInput{} diff --git a/service/proton/api_op_DeleteEnvironmentAccountConnection.go b/service/proton/api_op_DeleteEnvironmentAccountConnection.go index 1a74dfc878d..40c1ae80a57 100644 --- a/service/proton/api_op_DeleteEnvironmentAccountConnection.go +++ b/service/proton/api_op_DeleteEnvironmentAccountConnection.go @@ -17,8 +17,7 @@ import ( // environment account connection is accepted for the environment account and // associated environment. You're responsible for cleaning up provisioned resources // that remain without an environment connection. For more information, see -// Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) DeleteEnvironmentAccountConnection(ctx context.Context, params *DeleteEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*DeleteEnvironmentAccountConnectionOutput, error) { if params == nil { diff --git a/service/proton/api_op_DeleteEnvironmentTemplate.go b/service/proton/api_op_DeleteEnvironmentTemplate.go index 58f3f335ed6..6fd81ea9075 100644 --- a/service/proton/api_op_DeleteEnvironmentTemplate.go +++ b/service/proton/api_op_DeleteEnvironmentTemplate.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// If no other major or minor versions of an environment template exist, delete the -// environment template. +// If no other major or minor versions of an environment template exist, delete +// the environment template. func (c *Client) DeleteEnvironmentTemplate(ctx context.Context, params *DeleteEnvironmentTemplateInput, optFns ...func(*Options)) (*DeleteEnvironmentTemplateOutput, error) { if params == nil { params = &DeleteEnvironmentTemplateInput{} diff --git a/service/proton/api_op_DeleteEnvironmentTemplateVersion.go b/service/proton/api_op_DeleteEnvironmentTemplateVersion.go index 5b9fae7c403..668c0c5470e 100644 --- a/service/proton/api_op_DeleteEnvironmentTemplateVersion.go +++ b/service/proton/api_op_DeleteEnvironmentTemplateVersion.go @@ -16,10 +16,10 @@ import ( // the Recommended version of the environment template if no other major versions // or minor versions of the environment template exist. A major version of an // environment template is a version that's not backward compatible. Delete a minor -// version of an environment template if it isn't the Recommended version. Delete a -// Recommended minor version of the environment template if no other minor versions -// of the environment template exist. A minor version of an environment template is -// a version that's backward compatible. +// version of an environment template if it isn't the Recommended version. Delete +// a Recommended minor version of the environment template if no other minor +// versions of the environment template exist. A minor version of an environment +// template is a version that's backward compatible. func (c *Client) DeleteEnvironmentTemplateVersion(ctx context.Context, params *DeleteEnvironmentTemplateVersionInput, optFns ...func(*Options)) (*DeleteEnvironmentTemplateVersionOutput, error) { if params == nil { params = &DeleteEnvironmentTemplateVersionInput{} diff --git a/service/proton/api_op_DeleteService.go b/service/proton/api_op_DeleteService.go index d7ad95042f5..35fdeb760e7 100644 --- a/service/proton/api_op_DeleteService.go +++ b/service/proton/api_op_DeleteService.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a service, with its instances and pipeline. You can't delete a service if -// it has any service instances that have components attached to them. For more -// information about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// Delete a service, with its instances and pipeline. You can't delete a service +// if it has any service instances that have components attached to them. For more +// information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error) { if params == nil { params = &DeleteServiceInput{} diff --git a/service/proton/api_op_DeleteServiceTemplateVersion.go b/service/proton/api_op_DeleteServiceTemplateVersion.go index 2ae569eb213..a475683aba4 100644 --- a/service/proton/api_op_DeleteServiceTemplateVersion.go +++ b/service/proton/api_op_DeleteServiceTemplateVersion.go @@ -16,10 +16,10 @@ import ( // Recommended version of the service template if no other major versions or minor // versions of the service template exist. A major version of a service template is // a version that isn't backwards compatible. Delete a minor version of a service -// template if it's not the Recommended version. Delete a Recommended minor version -// of the service template if no other minor versions of the service template -// exist. A minor version of a service template is a version that's backwards -// compatible. +// template if it's not the Recommended version. Delete a Recommended minor +// version of the service template if no other minor versions of the service +// template exist. A minor version of a service template is a version that's +// backwards compatible. func (c *Client) DeleteServiceTemplateVersion(ctx context.Context, params *DeleteServiceTemplateVersionInput, optFns ...func(*Options)) (*DeleteServiceTemplateVersionOutput, error) { if params == nil { params = &DeleteServiceTemplateVersionInput{} diff --git a/service/proton/api_op_GetComponent.go b/service/proton/api_op_GetComponent.go index 763baae6051..aa2e06c8232 100644 --- a/service/proton/api_op_GetComponent.go +++ b/service/proton/api_op_GetComponent.go @@ -18,9 +18,8 @@ import ( ) // Get detailed data for a component. For more information about components, see -// Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error) { if params == nil { params = &GetComponentInput{} @@ -140,8 +139,8 @@ type ComponentDeployedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ComponentDeployedWaiter will use default max delay of 4999 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ComponentDeployedWaiter will use default max delay of 4999 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -190,10 +189,10 @@ func (w *ComponentDeployedWaiter) Wait(ctx context.Context, params *GetComponent return err } -// WaitForOutput calls the waiter function for ComponentDeployed waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for ComponentDeployed waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *ComponentDeployedWaiter) WaitForOutput(ctx context.Context, params *GetComponentInput, maxWaitDur time.Duration, optFns ...func(*ComponentDeployedWaiterOptions)) (*GetComponentOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -317,9 +316,9 @@ type ComponentDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ComponentDeletedWaiter will use default max delay of 4999 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ComponentDeletedWaiter will use default max delay of 4999 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/proton/api_op_GetEnvironment.go b/service/proton/api_op_GetEnvironment.go index ac34dcfc17a..400472cd44e 100644 --- a/service/proton/api_op_GetEnvironment.go +++ b/service/proton/api_op_GetEnvironment.go @@ -140,9 +140,10 @@ type EnvironmentDeployedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EnvironmentDeployedWaiter will use default max delay of 4999 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EnvironmentDeployedWaiter will use default max delay of 4999 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -182,9 +183,9 @@ func NewEnvironmentDeployedWaiter(client GetEnvironmentAPIClient, optFns ...func } } -// Wait calls the waiter function for EnvironmentDeployed waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for EnvironmentDeployed waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *EnvironmentDeployedWaiter) Wait(ctx context.Context, params *GetEnvironmentInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentDeployedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/proton/api_op_GetEnvironmentAccountConnection.go b/service/proton/api_op_GetEnvironmentAccountConnection.go index e2b1ae7a9f1..12a53d216f1 100644 --- a/service/proton/api_op_GetEnvironmentAccountConnection.go +++ b/service/proton/api_op_GetEnvironmentAccountConnection.go @@ -12,8 +12,7 @@ import ( ) // In an environment account, get the detailed data for an environment account -// connection. For more information, see Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// connection. For more information, see Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) GetEnvironmentAccountConnection(ctx context.Context, params *GetEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*GetEnvironmentAccountConnectionOutput, error) { if params == nil { diff --git a/service/proton/api_op_GetEnvironmentTemplateVersion.go b/service/proton/api_op_GetEnvironmentTemplateVersion.go index 8a5b20c0550..2a3abe62aaf 100644 --- a/service/proton/api_op_GetEnvironmentTemplateVersion.go +++ b/service/proton/api_op_GetEnvironmentTemplateVersion.go @@ -34,18 +34,18 @@ func (c *Client) GetEnvironmentTemplateVersion(ctx context.Context, params *GetE type GetEnvironmentTemplateVersionInput struct { - // To get environment template major version detail data, include major Version. + // To get environment template major version detail data, include major Version . // // This member is required. MajorVersion *string - // To get environment template minor version detail data, include minorVersion. + // To get environment template minor version detail data, include minorVersion . // // This member is required. MinorVersion *string - // The name of the environment template a version of which you want to get detailed - // data for. + // The name of the environment template a version of which you want to get + // detailed data for. // // This member is required. TemplateName *string @@ -152,10 +152,10 @@ type EnvironmentTemplateVersionRegisteredWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EnvironmentTemplateVersionRegisteredWaiter will use default max delay - // of 300 seconds. Note that MaxDelay must resolve to value greater than or equal - // to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EnvironmentTemplateVersionRegisteredWaiter will use default max + // delay of 300 seconds. Note that MaxDelay must resolve to value greater than or + // equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -205,10 +205,10 @@ func (w *EnvironmentTemplateVersionRegisteredWaiter) Wait(ctx context.Context, p return err } -// WaitForOutput calls the waiter function for EnvironmentTemplateVersionRegistered -// waiter and returns the output of the successful operation. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// WaitForOutput calls the waiter function for +// EnvironmentTemplateVersionRegistered waiter and returns the output of the +// successful operation. The maxWaitDur is the maximum wait duration the waiter +// will wait. The maxWaitDur is required and must be greater than zero. func (w *EnvironmentTemplateVersionRegisteredWaiter) WaitForOutput(ctx context.Context, params *GetEnvironmentTemplateVersionInput, maxWaitDur time.Duration, optFns ...func(*EnvironmentTemplateVersionRegisteredWaiterOptions)) (*GetEnvironmentTemplateVersionOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/proton/api_op_GetRepository.go b/service/proton/api_op_GetRepository.go index 1d932388fef..a93fb5c2df7 100644 --- a/service/proton/api_op_GetRepository.go +++ b/service/proton/api_op_GetRepository.go @@ -29,7 +29,7 @@ func (c *Client) GetRepository(ctx context.Context, params *GetRepositoryInput, type GetRepositoryInput struct { - // The repository name, for example myrepos/myrepo. + // The repository name, for example myrepos/myrepo . // // This member is required. Name *string diff --git a/service/proton/api_op_GetRepositorySyncStatus.go b/service/proton/api_op_GetRepositorySyncStatus.go index 9af91f59aac..0be6b1f21ea 100644 --- a/service/proton/api_op_GetRepositorySyncStatus.go +++ b/service/proton/api_op_GetRepositorySyncStatus.go @@ -16,8 +16,7 @@ import ( // the Proton Repository resource (or any other Proton resource). Therefore, tags // on an Proton Repository resource have no effect on this action. Specifically, // you can't use these tags to control access to this action using Attribute-based -// access control (ABAC). For more information about ABAC, see ABAC -// (https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags) +// access control (ABAC). For more information about ABAC, see ABAC (https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags) // in the Proton User Guide. func (c *Client) GetRepositorySyncStatus(ctx context.Context, params *GetRepositorySyncStatusInput, optFns ...func(*Options)) (*GetRepositorySyncStatusOutput, error) { if params == nil { diff --git a/service/proton/api_op_GetResourcesSummary.go b/service/proton/api_op_GetResourcesSummary.go index 7b0f2a6d18e..74e1f04395b 100644 --- a/service/proton/api_op_GetResourcesSummary.go +++ b/service/proton/api_op_GetResourcesSummary.go @@ -19,11 +19,10 @@ import ( // behind a template major version, or behind a template minor version), the total // number of resources, and the number of resources that are in a failed state, // grouped by resource type. Components, environments, and service templates return -// less information - see the components, environments, and serviceTemplates field -// descriptions. For context, the action also returns the total number of each type -// of Proton template in the Amazon Web Services account. For more information, see -// Proton dashboard -// (https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html) +// less information - see the components , environments , and serviceTemplates +// field descriptions. For context, the action also returns the total number of +// each type of Proton template in the Amazon Web Services account. For more +// information, see Proton dashboard (https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html) // in the Proton User Guide. func (c *Client) GetResourcesSummary(ctx context.Context, params *GetResourcesSummaryInput, optFns ...func(*Options)) (*GetResourcesSummaryOutput, error) { if params == nil { diff --git a/service/proton/api_op_GetService.go b/service/proton/api_op_GetService.go index 0f77eca2087..cb61c7a9d64 100644 --- a/service/proton/api_op_GetService.go +++ b/service/proton/api_op_GetService.go @@ -137,9 +137,9 @@ type ServiceCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServiceCreatedWaiter will use default max delay of 4999 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServiceCreatedWaiter will use default max delay of 4999 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -348,9 +348,9 @@ type ServiceUpdatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServiceUpdatedWaiter will use default max delay of 4999 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServiceUpdatedWaiter will use default max delay of 4999 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -576,9 +576,9 @@ type ServiceDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServiceDeletedWaiter will use default max delay of 4999 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServiceDeletedWaiter will use default max delay of 4999 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -744,8 +744,8 @@ type ServicePipelineDeployedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServicePipelineDeployedWaiter will use default max delay of 3600 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServicePipelineDeployedWaiter will use default max delay of 3600 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/proton/api_op_GetServiceInstance.go b/service/proton/api_op_GetServiceInstance.go index 24246ec5b39..5377961fbd0 100644 --- a/service/proton/api_op_GetServiceInstance.go +++ b/service/proton/api_op_GetServiceInstance.go @@ -16,8 +16,8 @@ import ( "time" ) -// Get detailed data for a service instance. A service instance is an instantiation -// of service template and it runs in a specific environment. +// Get detailed data for a service instance. A service instance is an +// instantiation of service template and it runs in a specific environment. func (c *Client) GetServiceInstance(ctx context.Context, params *GetServiceInstanceInput, optFns ...func(*Options)) (*GetServiceInstanceOutput, error) { if params == nil { params = &GetServiceInstanceInput{} @@ -146,8 +146,8 @@ type ServiceInstanceDeployedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServiceInstanceDeployedWaiter will use default max delay of 4999 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServiceInstanceDeployedWaiter will use default max delay of 4999 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/proton/api_op_GetServiceTemplateVersion.go b/service/proton/api_op_GetServiceTemplateVersion.go index 3c8e4b45de2..1756abae126 100644 --- a/service/proton/api_op_GetServiceTemplateVersion.go +++ b/service/proton/api_op_GetServiceTemplateVersion.go @@ -34,12 +34,12 @@ func (c *Client) GetServiceTemplateVersion(ctx context.Context, params *GetServi type GetServiceTemplateVersionInput struct { - // To get service template major version detail data, include major Version. + // To get service template major version detail data, include major Version . // // This member is required. MajorVersion *string - // To get service template minor version detail data, include minorVersion. + // To get service template minor version detail data, include minorVersion . // // This member is required. MinorVersion *string @@ -152,10 +152,10 @@ type ServiceTemplateVersionRegisteredWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServiceTemplateVersionRegisteredWaiter will use default max delay of - // 300 seconds. Note that MaxDelay must resolve to value greater than or equal to - // the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServiceTemplateVersionRegisteredWaiter will use default max delay + // of 300 seconds. Note that MaxDelay must resolve to value greater than or equal + // to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/proton/api_op_ListComponentOutputs.go b/service/proton/api_op_ListComponentOutputs.go index 927d99a5ea1..7e71b1714c0 100644 --- a/service/proton/api_op_ListComponentOutputs.go +++ b/service/proton/api_op_ListComponentOutputs.go @@ -13,9 +13,8 @@ import ( ) // Get a list of component Infrastructure as Code (IaC) outputs. For more -// information about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) ListComponentOutputs(ctx context.Context, params *ListComponentOutputsInput, optFns ...func(*Options)) (*ListComponentOutputsOutput, error) { if params == nil { params = &ListComponentOutputsInput{} diff --git a/service/proton/api_op_ListComponentProvisionedResources.go b/service/proton/api_op_ListComponentProvisionedResources.go index 575e2e5c2b8..580426321d7 100644 --- a/service/proton/api_op_ListComponentProvisionedResources.go +++ b/service/proton/api_op_ListComponentProvisionedResources.go @@ -13,9 +13,8 @@ import ( ) // List provisioned resources for a component with details. For more information -// about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) ListComponentProvisionedResources(ctx context.Context, params *ListComponentProvisionedResourcesInput, optFns ...func(*Options)) (*ListComponentProvisionedResourcesOutput, error) { if params == nil { params = &ListComponentProvisionedResourcesInput{} diff --git a/service/proton/api_op_ListComponents.go b/service/proton/api_op_ListComponents.go index 873aa8f67e0..9c0876cab27 100644 --- a/service/proton/api_op_ListComponents.go +++ b/service/proton/api_op_ListComponents.go @@ -14,9 +14,8 @@ import ( // List components with summary data. You can filter the result list by // environment, service, or a single service instance. For more information about -// components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error) { if params == nil { params = &ListComponentsInput{} diff --git a/service/proton/api_op_ListEnvironmentAccountConnections.go b/service/proton/api_op_ListEnvironmentAccountConnections.go index fdf36b93410..8f3dad1fa40 100644 --- a/service/proton/api_op_ListEnvironmentAccountConnections.go +++ b/service/proton/api_op_ListEnvironmentAccountConnections.go @@ -13,8 +13,7 @@ import ( ) // View a list of environment account connections. For more information, see -// Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) ListEnvironmentAccountConnections(ctx context.Context, params *ListEnvironmentAccountConnectionsInput, optFns ...func(*Options)) (*ListEnvironmentAccountConnectionsOutput, error) { if params == nil { diff --git a/service/proton/api_op_ListEnvironmentProvisionedResources.go b/service/proton/api_op_ListEnvironmentProvisionedResources.go index cc80959a975..b3b6313ac2c 100644 --- a/service/proton/api_op_ListEnvironmentProvisionedResources.go +++ b/service/proton/api_op_ListEnvironmentProvisionedResources.go @@ -35,9 +35,9 @@ type ListEnvironmentProvisionedResourcesInput struct { // This member is required. EnvironmentName *string - // A token that indicates the location of the next environment provisioned resource - // in the array of environment provisioned resources, after the list of environment - // provisioned resources that was previously requested. + // A token that indicates the location of the next environment provisioned + // resource in the array of environment provisioned resources, after the list of + // environment provisioned resources that was previously requested. NextToken *string noSmithyDocumentSerde @@ -50,9 +50,9 @@ type ListEnvironmentProvisionedResourcesOutput struct { // This member is required. ProvisionedResources []types.ProvisionedResource - // A token that indicates the location of the next environment provisioned resource - // in the array of provisioned resources, after the current requested list of - // environment provisioned resources. + // A token that indicates the location of the next environment provisioned + // resource in the array of provisioned resources, after the current requested list + // of environment provisioned resources. NextToken *string // Metadata pertaining to the operation's result. @@ -132,8 +132,8 @@ type ListEnvironmentProvisionedResourcesAPIClient interface { var _ ListEnvironmentProvisionedResourcesAPIClient = (*Client)(nil) -// ListEnvironmentProvisionedResourcesPaginatorOptions is the paginator options for -// ListEnvironmentProvisionedResources +// ListEnvironmentProvisionedResourcesPaginatorOptions is the paginator options +// for ListEnvironmentProvisionedResources type ListEnvironmentProvisionedResourcesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. diff --git a/service/proton/api_op_ListEnvironmentTemplateVersions.go b/service/proton/api_op_ListEnvironmentTemplateVersions.go index f85d8fbd210..cd25b96020e 100644 --- a/service/proton/api_op_ListEnvironmentTemplateVersions.go +++ b/service/proton/api_op_ListEnvironmentTemplateVersions.go @@ -36,8 +36,8 @@ type ListEnvironmentTemplateVersionsInput struct { TemplateName *string // To view a list of minor of versions under a major version of an environment - // template, include major Version. To view a list of major versions of an - // environment template, exclude major Version. + // template, include major Version . To view a list of major versions of an + // environment template, exclude major Version . MajorVersion *string // The maximum number of major or minor versions of an environment template to diff --git a/service/proton/api_op_ListRepositorySyncDefinitions.go b/service/proton/api_op_ListRepositorySyncDefinitions.go index 9d74dbff7ce..7db08c10957 100644 --- a/service/proton/api_op_ListRepositorySyncDefinitions.go +++ b/service/proton/api_op_ListRepositorySyncDefinitions.go @@ -40,7 +40,7 @@ type ListRepositorySyncDefinitionsInput struct { // This member is required. RepositoryProvider types.RepositoryProvider - // The sync type. The only supported value is TEMPLATE_SYNC. + // The sync type. The only supported value is TEMPLATE_SYNC . // // This member is required. SyncType types.SyncType diff --git a/service/proton/api_op_ListServiceInstanceProvisionedResources.go b/service/proton/api_op_ListServiceInstanceProvisionedResources.go index 1f154b5fd0b..c823b29c539 100644 --- a/service/proton/api_op_ListServiceInstanceProvisionedResources.go +++ b/service/proton/api_op_ListServiceInstanceProvisionedResources.go @@ -129,16 +129,16 @@ func (c *Client) addOperationListServiceInstanceProvisionedResourcesMiddlewares( return nil } -// ListServiceInstanceProvisionedResourcesAPIClient is a client that implements the -// ListServiceInstanceProvisionedResources operation. +// ListServiceInstanceProvisionedResourcesAPIClient is a client that implements +// the ListServiceInstanceProvisionedResources operation. type ListServiceInstanceProvisionedResourcesAPIClient interface { ListServiceInstanceProvisionedResources(context.Context, *ListServiceInstanceProvisionedResourcesInput, ...func(*Options)) (*ListServiceInstanceProvisionedResourcesOutput, error) } var _ ListServiceInstanceProvisionedResourcesAPIClient = (*Client)(nil) -// ListServiceInstanceProvisionedResourcesPaginatorOptions is the paginator options -// for ListServiceInstanceProvisionedResources +// ListServiceInstanceProvisionedResourcesPaginatorOptions is the paginator +// options for ListServiceInstanceProvisionedResources type ListServiceInstanceProvisionedResourcesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. diff --git a/service/proton/api_op_ListServiceInstances.go b/service/proton/api_op_ListServiceInstances.go index c738a3ac83e..aba58a4d51f 100644 --- a/service/proton/api_op_ListServiceInstances.go +++ b/service/proton/api_op_ListServiceInstances.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List service instances with summary data. This action lists service instances of -// all services in the Amazon Web Services account. +// List service instances with summary data. This action lists service instances +// of all services in the Amazon Web Services account. func (c *Client) ListServiceInstances(ctx context.Context, params *ListServiceInstancesInput, optFns ...func(*Options)) (*ListServiceInstancesOutput, error) { if params == nil { params = &ListServiceInstancesInput{} @@ -46,7 +46,7 @@ type ListServiceInstancesInput struct { ServiceName *string // The field that the result list is sorted by. When you choose to sort by - // serviceName, service instances within each service are sorted by service + // serviceName , service instances within each service are sorted by service // instance name. Default: serviceName SortBy types.ListServiceInstancesSortBy @@ -63,8 +63,8 @@ type ListServiceInstancesOutput struct { // This member is required. ServiceInstances []types.ServiceInstanceSummary - // A token that indicates the location of the next service instance in the array of - // service instances, after the current requested list of service instances. + // A token that indicates the location of the next service instance in the array + // of service instances, after the current requested list of service instances. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/proton/api_op_ListServicePipelineProvisionedResources.go b/service/proton/api_op_ListServicePipelineProvisionedResources.go index 2c2b14b8b69..a0fe6ff86ab 100644 --- a/service/proton/api_op_ListServicePipelineProvisionedResources.go +++ b/service/proton/api_op_ListServicePipelineProvisionedResources.go @@ -124,16 +124,16 @@ func (c *Client) addOperationListServicePipelineProvisionedResourcesMiddlewares( return nil } -// ListServicePipelineProvisionedResourcesAPIClient is a client that implements the -// ListServicePipelineProvisionedResources operation. +// ListServicePipelineProvisionedResourcesAPIClient is a client that implements +// the ListServicePipelineProvisionedResources operation. type ListServicePipelineProvisionedResourcesAPIClient interface { ListServicePipelineProvisionedResources(context.Context, *ListServicePipelineProvisionedResourcesInput, ...func(*Options)) (*ListServicePipelineProvisionedResourcesOutput, error) } var _ ListServicePipelineProvisionedResourcesAPIClient = (*Client)(nil) -// ListServicePipelineProvisionedResourcesPaginatorOptions is the paginator options -// for ListServicePipelineProvisionedResources +// ListServicePipelineProvisionedResourcesPaginatorOptions is the paginator +// options for ListServicePipelineProvisionedResources type ListServicePipelineProvisionedResourcesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. diff --git a/service/proton/api_op_ListServiceTemplateVersions.go b/service/proton/api_op_ListServiceTemplateVersions.go index f7b604ee0cf..af3fb7ecd65 100644 --- a/service/proton/api_op_ListServiceTemplateVersions.go +++ b/service/proton/api_op_ListServiceTemplateVersions.go @@ -35,9 +35,9 @@ type ListServiceTemplateVersionsInput struct { // This member is required. TemplateName *string - // To view a list of minor of versions under a major version of a service template, - // include major Version. To view a list of major versions of a service template, - // exclude major Version. + // To view a list of minor of versions under a major version of a service + // template, include major Version . To view a list of major versions of a service + // template, exclude major Version . MajorVersion *string // The maximum number of major or minor versions of a service template to list. diff --git a/service/proton/api_op_ListServiceTemplates.go b/service/proton/api_op_ListServiceTemplates.go index 331460ffa59..44fb4db6bdb 100644 --- a/service/proton/api_op_ListServiceTemplates.go +++ b/service/proton/api_op_ListServiceTemplates.go @@ -33,8 +33,8 @@ type ListServiceTemplatesInput struct { // The maximum number of service templates to list. MaxResults *int32 - // A token that indicates the location of the next service template in the array of - // service templates, after the list of service templates previously requested. + // A token that indicates the location of the next service template in the array + // of service templates, after the list of service templates previously requested. NextToken *string noSmithyDocumentSerde @@ -47,8 +47,8 @@ type ListServiceTemplatesOutput struct { // This member is required. Templates []types.ServiceTemplateSummary - // A token that indicates the location of the next service template in the array of - // service templates, after the current requested list of service templates. + // A token that indicates the location of the next service template in the array + // of service templates, after the current requested list of service templates. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/proton/api_op_ListTagsForResource.go b/service/proton/api_op_ListTagsForResource.go index f5261337135..6c528e0b6ae 100644 --- a/service/proton/api_op_ListTagsForResource.go +++ b/service/proton/api_op_ListTagsForResource.go @@ -12,9 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List tags for a resource. For more information, see Proton resources and tagging -// (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the -// Proton User Guide. +// List tags for a resource. For more information, see Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) +// in the Proton User Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -127,8 +126,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/proton/api_op_NotifyResourceDeploymentStatusChange.go b/service/proton/api_op_NotifyResourceDeploymentStatusChange.go index db1013f38ec..17d0084fa3e 100644 --- a/service/proton/api_op_NotifyResourceDeploymentStatusChange.go +++ b/service/proton/api_op_NotifyResourceDeploymentStatusChange.go @@ -12,8 +12,7 @@ import ( ) // Notify Proton of status changes to a provisioned resource when you use -// self-managed provisioning. For more information, see Self-managed provisioning -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) +// self-managed provisioning. For more information, see Self-managed provisioning (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) // in the Proton User Guide. func (c *Client) NotifyResourceDeploymentStatusChange(ctx context.Context, params *NotifyResourceDeploymentStatusChangeInput, optFns ...func(*Options)) (*NotifyResourceDeploymentStatusChangeOutput, error) { if params == nil { diff --git a/service/proton/api_op_RejectEnvironmentAccountConnection.go b/service/proton/api_op_RejectEnvironmentAccountConnection.go index 8a2b4f5af0f..31e5ff29b19 100644 --- a/service/proton/api_op_RejectEnvironmentAccountConnection.go +++ b/service/proton/api_op_RejectEnvironmentAccountConnection.go @@ -15,8 +15,7 @@ import ( // environment account. After you reject an environment account connection request, // you can't accept or use the rejected environment account connection. You can’t // reject an environment account connection that's connected to an environment. For -// more information, see Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// more information, see Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) RejectEnvironmentAccountConnection(ctx context.Context, params *RejectEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*RejectEnvironmentAccountConnectionOutput, error) { if params == nil { diff --git a/service/proton/api_op_TagResource.go b/service/proton/api_op_TagResource.go index 3395fde4b4f..b3ec0a1aeb4 100644 --- a/service/proton/api_op_TagResource.go +++ b/service/proton/api_op_TagResource.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tag a resource. A tag is a key-value pair of metadata that you associate with an -// Proton resource. For more information, see Proton resources and tagging -// (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) in the -// Proton User Guide. +// Tag a resource. A tag is a key-value pair of metadata that you associate with +// an Proton resource. For more information, see Proton resources and tagging (https://docs.aws.amazon.com/proton/latest/userguide/resources.html) +// in the Proton User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/proton/api_op_UpdateAccountSettings.go b/service/proton/api_op_UpdateAccountSettings.go index 1038688a321..22eb312e9b1 100644 --- a/service/proton/api_op_UpdateAccountSettings.go +++ b/service/proton/api_op_UpdateAccountSettings.go @@ -43,9 +43,9 @@ type UpdateAccountSettingsInput struct { // A linked repository for pipeline provisioning. Specify it if you have // environments configured for self-managed provisioning with services that include // pipelines. A linked repository is a repository that has been registered with - // Proton. For more information, see CreateRepository. To remove a previously - // configured repository, set deletePipelineProvisioningRepository to true, and - // don't set pipelineProvisioningRepository. + // Proton. For more information, see CreateRepository . To remove a previously + // configured repository, set deletePipelineProvisioningRepository to true , and + // don't set pipelineProvisioningRepository . PipelineProvisioningRepository *types.RepositoryBranchInput // The Amazon Resource Name (ARN) of the service role you want to use for diff --git a/service/proton/api_op_UpdateComponent.go b/service/proton/api_op_UpdateComponent.go index 41cf037e417..3fcea9286b8 100644 --- a/service/proton/api_op_UpdateComponent.go +++ b/service/proton/api_op_UpdateComponent.go @@ -15,9 +15,9 @@ import ( // Update a component. There are a few modes for updating a component. The // deploymentType field defines the mode. You can't update a component while its // deployment status, or the deployment status of a service instance attached to -// it, is IN_PROGRESS. For more information about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// it, is IN_PROGRESS . For more information about components, see Proton +// components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) UpdateComponent(ctx context.Context, params *UpdateComponentInput, optFns ...func(*Options)) (*UpdateComponentOutput, error) { if params == nil { params = &UpdateComponentInput{} @@ -39,7 +39,7 @@ type UpdateComponentInput struct { // NONE In this mode, a deployment doesn't occur. Only the requested metadata // parameters are updated. You can only specify description in this mode. // CURRENT_VERSION In this mode, the component is deployed and updated with the new - // serviceSpec, templateSource, and/or type that you provide. Only requested + // serviceSpec , templateSource , and/or type that you provide. Only requested // parameters are updated. // // This member is required. @@ -76,8 +76,8 @@ type UpdateComponentInput struct { // This value conforms to the media type: application/yaml ServiceSpec *string - // A path to the Infrastructure as Code (IaC) file describing infrastructure that a - // custom component provisions. Components support a single IaC file, even if you + // A path to the Infrastructure as Code (IaC) file describing infrastructure that + // a custom component provisions. Components support a single IaC file, even if you // use Terraform as your template language. // // This value conforms to the media type: application/yaml diff --git a/service/proton/api_op_UpdateEnvironment.go b/service/proton/api_op_UpdateEnvironment.go index 82c3e034ef1..19c976ed147 100644 --- a/service/proton/api_op_UpdateEnvironment.go +++ b/service/proton/api_op_UpdateEnvironment.go @@ -24,20 +24,18 @@ import ( // with an environment connection. You can update either the // environmentAccountConnectionId or protonServiceRoleArn parameter and value. You // can’t update both. If the environment was configured for Amazon Web -// Services-managed provisioning, omit the provisioningRepository parameter. If the -// environment was configured for self-managed provisioning, specify the +// Services-managed provisioning, omit the provisioningRepository parameter. If +// the environment was configured for self-managed provisioning, specify the // provisioningRepository parameter and omit the protonServiceRoleArn and // environmentAccountConnectionId parameters. For more information, see -// Environments -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) and -// Provisioning methods -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) +// Environments (https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) +// and Provisioning methods (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) // in the Proton User Guide. There are four modes for updating an environment. The // deploymentType field defines the mode. NONE In this mode, a deployment doesn't // occur. Only the requested metadata parameters are updated. CURRENT_VERSION In // this mode, the environment is deployed and updated with the new spec that you // provide. Only requested parameters are updated. Don’t include minor or major -// version parameters when you use this deployment-type. MINOR_VERSION In this +// version parameters when you use this deployment-type . MINOR_VERSION In this // mode, the environment is deployed and updated with the published, recommended // (latest) minor version of the current major version in use, by default. You can // also specify a different minor version of the current major version in use. @@ -67,7 +65,7 @@ type UpdateEnvironmentInput struct { // requested metadata parameters are updated. CURRENT_VERSION In this mode, the // environment is deployed and updated with the new spec that you provide. Only // requested parameters are updated. Don’t include major or minor version - // parameters when you use this deployment-type. MINOR_VERSION In this mode, the + // parameters when you use this deployment-type . MINOR_VERSION In this mode, the // environment is deployed and updated with the published, recommended (latest) // minor version of the current major version in use, by default. You can also // specify a different minor version of the current major version in use. @@ -93,9 +91,8 @@ type UpdateEnvironmentInput struct { // scope of infrastructure that a component can provision. The environment must // have a componentRoleArn to allow directly defined components to be associated // with the environment. For more information about components, see Proton - // components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // A description of the environment update. @@ -113,8 +110,8 @@ type UpdateEnvironmentInput struct { // The linked repository that you use to host your rendered infrastructure // templates for self-managed provisioning. A linked repository is a repository - // that has been registered with Proton. For more information, see - // CreateRepository. + // that has been registered with Proton. For more information, see CreateRepository + // . ProvisioningRepository *types.RepositoryBranchInput // The formatted specification that defines the update. diff --git a/service/proton/api_op_UpdateEnvironmentAccountConnection.go b/service/proton/api_op_UpdateEnvironmentAccountConnection.go index 17ccf2a9122..4c4f65f413a 100644 --- a/service/proton/api_op_UpdateEnvironmentAccountConnection.go +++ b/service/proton/api_op_UpdateEnvironmentAccountConnection.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// In an environment account, update an environment account connection to use a new -// IAM role. For more information, see Environment account connections -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) +// In an environment account, update an environment account connection to use a +// new IAM role. For more information, see Environment account connections (https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html) // in the Proton User guide. func (c *Client) UpdateEnvironmentAccountConnection(ctx context.Context, params *UpdateEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*UpdateEnvironmentAccountConnectionOutput, error) { if params == nil { @@ -47,9 +46,8 @@ type UpdateEnvironmentAccountConnectionInput struct { // It determines the scope of infrastructure that a component can provision in the // account. The environment account connection must have a componentRoleArn to // allow directly defined components to be associated with any environments running - // in the account. For more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // in the account. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // The Amazon Resource Name (ARN) of the IAM service role that's associated with diff --git a/service/proton/api_op_UpdateEnvironmentTemplateVersion.go b/service/proton/api_op_UpdateEnvironmentTemplateVersion.go index 567aaa0d42a..fcd22d64144 100644 --- a/service/proton/api_op_UpdateEnvironmentTemplateVersion.go +++ b/service/proton/api_op_UpdateEnvironmentTemplateVersion.go @@ -29,12 +29,12 @@ func (c *Client) UpdateEnvironmentTemplateVersion(ctx context.Context, params *U type UpdateEnvironmentTemplateVersionInput struct { - // To update a major version of an environment template, include major Version. + // To update a major version of an environment template, include major Version . // // This member is required. MajorVersion *string - // To update a minor version of an environment template, include minorVersion. + // To update a minor version of an environment template, include minorVersion . // // This member is required. MinorVersion *string diff --git a/service/proton/api_op_UpdateService.go b/service/proton/api_op_UpdateService.go index 75f672207cb..88e0d9204f4 100644 --- a/service/proton/api_op_UpdateService.go +++ b/service/proton/api_op_UpdateService.go @@ -16,9 +16,8 @@ import ( // API. They can only be deleted. Use the description parameter to modify the // description. Edit the spec parameter to add or delete instances. You can't // delete a service instance (remove it from the spec) if it has an attached -// component. For more information about components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// component. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { if params == nil { params = &UpdateServiceInput{} @@ -44,10 +43,10 @@ type UpdateServiceInput struct { // The edited service description. Description *string - // Lists the service instances to add and the existing service instances to remain. - // Omit the existing service instances to delete from the list. Don't include edits - // to the existing service instances or pipeline. For more information, see Edit a - // service (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html) + // Lists the service instances to add and the existing service instances to + // remain. Omit the existing service instances to delete from the list. Don't + // include edits to the existing service instances or pipeline. For more + // information, see Edit a service (https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html) // in the Proton User Guide. // // This value conforms to the media type: application/yaml diff --git a/service/proton/api_op_UpdateServiceInstance.go b/service/proton/api_op_UpdateServiceInstance.go index 3d6d4a82564..654e2b335fc 100644 --- a/service/proton/api_op_UpdateServiceInstance.go +++ b/service/proton/api_op_UpdateServiceInstance.go @@ -15,10 +15,9 @@ import ( // Update a service instance. There are a few modes for updating a service // instance. The deploymentType field defines the mode. You can't update a service // instance while its deployment status, or the deployment status of a component -// attached to it, is IN_PROGRESS. For more information about components, see -// Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// attached to it, is IN_PROGRESS . For more information about components, see +// Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. func (c *Client) UpdateServiceInstance(ctx context.Context, params *UpdateServiceInstanceInput, optFns ...func(*Options)) (*UpdateServiceInstanceOutput, error) { if params == nil { params = &UpdateServiceInstanceInput{} diff --git a/service/proton/api_op_UpdateServicePipeline.go b/service/proton/api_op_UpdateServicePipeline.go index f51edbc9af4..2f72170c045 100644 --- a/service/proton/api_op_UpdateServicePipeline.go +++ b/service/proton/api_op_UpdateServicePipeline.go @@ -16,7 +16,7 @@ import ( // deployment doesn't occur. Only the requested metadata parameters are updated. // CURRENT_VERSION In this mode, the service pipeline is deployed and updated with // the new spec that you provide. Only requested parameters are updated. Don’t -// include major or minor version parameters when you use this deployment-type. +// include major or minor version parameters when you use this deployment-type . // MINOR_VERSION In this mode, the service pipeline is deployed and updated with // the published, recommended (latest) minor version of the current major version // in use, by default. You can specify a different minor version of the current @@ -46,14 +46,14 @@ type UpdateServicePipelineInput struct { // occur. Only the requested metadata parameters are updated. CURRENT_VERSION In // this mode, the service pipeline is deployed and updated with the new spec that // you provide. Only requested parameters are updated. Don’t include major or minor - // version parameters when you use this deployment-type. MINOR_VERSION In this + // version parameters when you use this deployment-type . MINOR_VERSION In this // mode, the service pipeline is deployed and updated with the published, // recommended (latest) minor version of the current major version in use, by // default. You can specify a different minor version of the current major version - // in use. MAJOR_VERSION In this mode, the service pipeline is deployed and updated - // with the published, recommended (latest) major and minor version of the current - // template, by default. You can specify a different major version that's higher - // than the major version in use and a minor version. + // in use. MAJOR_VERSION In this mode, the service pipeline is deployed and + // updated with the published, recommended (latest) major and minor version of the + // current template, by default. You can specify a different major version that's + // higher than the major version in use and a minor version. // // This member is required. DeploymentType types.DeploymentUpdateType diff --git a/service/proton/api_op_UpdateServiceTemplateVersion.go b/service/proton/api_op_UpdateServiceTemplateVersion.go index 38500516fb3..956148600c2 100644 --- a/service/proton/api_op_UpdateServiceTemplateVersion.go +++ b/service/proton/api_op_UpdateServiceTemplateVersion.go @@ -29,12 +29,12 @@ func (c *Client) UpdateServiceTemplateVersion(ctx context.Context, params *Updat type UpdateServiceTemplateVersionInput struct { - // To update a major version of a service template, include major Version. + // To update a major version of a service template, include major Version . // // This member is required. MajorVersion *string - // To update a minor version of a service template, include minorVersion. + // To update a minor version of a service template, include minorVersion . // // This member is required. MinorVersion *string @@ -59,9 +59,8 @@ type UpdateServiceTemplateVersionInput struct { // be attached to service instances based on this service template version. A // change to supportedComponentSources doesn't impact existing component // attachments to instances based on this template version. A change only affects - // later associations. For more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // later associations. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. SupportedComponentSources []types.ServiceTemplateSupportedComponentSourceType noSmithyDocumentSerde diff --git a/service/proton/api_op_UpdateTemplateSyncConfig.go b/service/proton/api_op_UpdateTemplateSyncConfig.go index dfbb5bc4566..38a5317bc29 100644 --- a/service/proton/api_op_UpdateTemplateSyncConfig.go +++ b/service/proton/api_op_UpdateTemplateSyncConfig.go @@ -12,9 +12,9 @@ import ( ) // Update template sync configuration parameters, except for the templateName and -// templateType. Repository details (branch, name, and provider) should be of a +// templateType . Repository details (branch, name, and provider) should be of a // linked repository. A linked repository is a repository that has been registered -// with Proton. For more information, see CreateRepository. +// with Proton. For more information, see CreateRepository . func (c *Client) UpdateTemplateSyncConfig(ctx context.Context, params *UpdateTemplateSyncConfigInput, optFns ...func(*Options)) (*UpdateTemplateSyncConfigOutput, error) { if params == nil { params = &UpdateTemplateSyncConfigInput{} @@ -37,7 +37,7 @@ type UpdateTemplateSyncConfigInput struct { // This member is required. Branch *string - // The repository name (for example, myrepos/myrepo). + // The repository name (for example, myrepos/myrepo ). // // This member is required. RepositoryName *string diff --git a/service/proton/doc.go b/service/proton/doc.go index 4cddeb7b5dd..8aebab631cd 100644 --- a/service/proton/doc.go +++ b/service/proton/doc.go @@ -4,112 +4,87 @@ // Proton. // // This is the Proton Service API Reference. It provides descriptions, syntax and -// usage examples for each of the actions -// (https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html) and -// data types -// (https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html) for the -// Proton service. The documentation for each action shows the Query API request -// parameters and the XML response. Alternatively, you can use the Amazon Web -// Services CLI to access an API. For more information, see the Amazon Web Services -// Command Line Interface User Guide -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). The -// Proton service is a two-pronged automation framework. Administrators create -// service templates to provide standardized infrastructure and deployment tooling -// for serverless and container based applications. Developers, in turn, select -// from the available service templates to automate their application or service -// deployments. Because administrators define the infrastructure and tooling that -// Proton deploys and manages, they need permissions to use all of the listed API -// operations. When developers select a specific infrastructure and tooling set, -// Proton deploys their applications. To monitor their applications that are -// running on Proton, developers need permissions to the service create, list, -// update and delete API operations and the service instance list and update API -// operations. To learn more about Proton, see the Proton User Guide -// (https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html). Ensuring -// Idempotency When you make a mutating API request, the request typically returns -// a result before the asynchronous workflows of the operation are complete. -// Operations might also time out or encounter other server issues before they're -// complete, even if the request already returned a result. This might make it -// difficult to determine whether the request succeeded. Moreover, you might need -// to retry the request multiple times to ensure that the operation completes -// successfully. However, if the original request and the subsequent retries are -// successful, the operation occurs multiple times. This means that you might -// create more resources than you intended. Idempotency ensures that an API request -// action completes no more than one time. With an idempotent request, if the -// original request action completes successfully, any subsequent retries complete -// successfully without performing any further actions. However, the result might -// contain updated information, such as the current creation status. The following -// lists of APIs are grouped according to methods that ensure idempotency. -// Idempotent create APIs with a client token The API actions in this list support -// idempotency with the use of a client token. The corresponding Amazon Web -// Services CLI commands also support idempotency using a client token. A client -// token is a unique, case-sensitive string of up to 64 ASCII characters. To make -// an idempotent API request using one of these actions, specify a client token in -// the request. We recommend that you don't reuse the same client token for other -// API requests. If you don’t provide a client token for these APIs, a default -// client token is automatically provided by SDKs. Given a request action that has -// succeeded: If you retry the request using the same client token and the same -// parameters, the retry succeeds without performing any further actions other than -// returning the original resource detail data in the response. If you retry the -// request using the same client token, but one or more of the parameters are +// usage examples for each of the actions (https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html) +// and data types (https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html) +// for the Proton service. The documentation for each action shows the Query API +// request parameters and the XML response. Alternatively, you can use the Amazon +// Web Services CLI to access an API. For more information, see the Amazon Web +// Services Command Line Interface User Guide (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) +// . The Proton service is a two-pronged automation framework. Administrators +// create service templates to provide standardized infrastructure and deployment +// tooling for serverless and container based applications. Developers, in turn, +// select from the available service templates to automate their application or +// service deployments. Because administrators define the infrastructure and +// tooling that Proton deploys and manages, they need permissions to use all of the +// listed API operations. When developers select a specific infrastructure and +// tooling set, Proton deploys their applications. To monitor their applications +// that are running on Proton, developers need permissions to the service create, +// list, update and delete API operations and the service instance list and update +// API operations. To learn more about Proton, see the Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html) +// . Ensuring Idempotency When you make a mutating API request, the request +// typically returns a result before the asynchronous workflows of the operation +// are complete. Operations might also time out or encounter other server issues +// before they're complete, even if the request already returned a result. This +// might make it difficult to determine whether the request succeeded. Moreover, +// you might need to retry the request multiple times to ensure that the operation +// completes successfully. However, if the original request and the subsequent +// retries are successful, the operation occurs multiple times. This means that you +// might create more resources than you intended. Idempotency ensures that an API +// request action completes no more than one time. With an idempotent request, if +// the original request action completes successfully, any subsequent retries +// complete successfully without performing any further actions. However, the +// result might contain updated information, such as the current creation status. +// The following lists of APIs are grouped according to methods that ensure +// idempotency. Idempotent create APIs with a client token The API actions in this +// list support idempotency with the use of a client token. The corresponding +// Amazon Web Services CLI commands also support idempotency using a client token. +// A client token is a unique, case-sensitive string of up to 64 ASCII characters. +// To make an idempotent API request using one of these actions, specify a client +// token in the request. We recommend that you don't reuse the same client token +// for other API requests. If you don’t provide a client token for these APIs, a +// default client token is automatically provided by SDKs. Given a request action +// that has succeeded: If you retry the request using the same client token and the +// same parameters, the retry succeeds without performing any further actions other +// than returning the original resource detail data in the response. If you retry +// the request using the same client token, but one or more of the parameters are // different, the retry throws a ValidationException with an // IdempotentParameterMismatch error. Client tokens expire eight hours after a // request is made. If you retry the request with the expired token, a new resource // is created. If the original resource is deleted and you retry the request, a new // resource is created. Idempotent create APIs with a client token: -// -// * -// CreateEnvironmentTemplateVersion -// -// * CreateServiceTemplateVersion -// -// * -// CreateEnvironmentAccountConnection -// -// Idempotent create APIs Given a request -// action that has succeeded: If you retry the request with an API from this group, -// and the original resource hasn't been modified, the retry succeeds without -// performing any further actions other than returning the original resource detail -// data in the response. If the original resource has been modified, the retry -// throws a ConflictException. If you retry with different input parameters, the -// retry throws a ValidationException with an IdempotentParameterMismatch error. -// Idempotent create APIs: -// -// * CreateEnvironmentTemplate -// -// * CreateServiceTemplate -// -// * -// CreateEnvironment -// -// * CreateService -// -// Idempotent delete APIs Given a request -// action that has succeeded: When you retry the request with an API from this -// group and the resource was deleted, its metadata is returned in the response. If -// you retry and the resource doesn't exist, the response is empty. In both cases, -// the retry succeeds. Idempotent delete APIs: -// -// * DeleteEnvironmentTemplate -// -// * -// DeleteEnvironmentTemplateVersion -// -// * DeleteServiceTemplate -// -// * -// DeleteServiceTemplateVersion -// -// * DeleteEnvironmentAccountConnection -// -// Asynchronous -// idempotent delete APIs Given a request action that has succeeded: If you retry -// the request with an API from this group, if the original request delete -// operation status is DELETE_IN_PROGRESS, the retry returns the resource detail -// data in the response without performing any further actions. If the original -// request delete operation is complete, a retry returns an empty response. -// Asynchronous idempotent delete APIs: -// -// * DeleteEnvironment -// -// * DeleteService +// - CreateEnvironmentTemplateVersion +// - CreateServiceTemplateVersion +// - CreateEnvironmentAccountConnection +// +// Idempotent create APIs Given a request action that has succeeded: If you retry +// the request with an API from this group, and the original resource hasn't been +// modified, the retry succeeds without performing any further actions other than +// returning the original resource detail data in the response. If the original +// resource has been modified, the retry throws a ConflictException . If you retry +// with different input parameters, the retry throws a ValidationException with an +// IdempotentParameterMismatch error. Idempotent create APIs: +// - CreateEnvironmentTemplate +// - CreateServiceTemplate +// - CreateEnvironment +// - CreateService +// +// Idempotent delete APIs Given a request action that has succeeded: When you +// retry the request with an API from this group and the resource was deleted, its +// metadata is returned in the response. If you retry and the resource doesn't +// exist, the response is empty. In both cases, the retry succeeds. Idempotent +// delete APIs: +// - DeleteEnvironmentTemplate +// - DeleteEnvironmentTemplateVersion +// - DeleteServiceTemplate +// - DeleteServiceTemplateVersion +// - DeleteEnvironmentAccountConnection +// +// Asynchronous idempotent delete APIs Given a request action that has succeeded: +// If you retry the request with an API from this group, if the original request +// delete operation status is DELETE_IN_PROGRESS , the retry returns the resource +// detail data in the response without performing any further actions. If the +// original request delete operation is complete, a retry returns an empty +// response. Asynchronous idempotent delete APIs: +// - DeleteEnvironment +// - DeleteService package proton diff --git a/service/proton/types/enums.go b/service/proton/types/enums.go index 42a62152017..b34a9ce4c89 100644 --- a/service/proton/types/enums.go +++ b/service/proton/types/enums.go @@ -163,9 +163,10 @@ const ( ListServiceInstancesFilterByCreatedAtAfter ListServiceInstancesFilterBy = "createdAtAfter" ) -// Values returns all known values for ListServiceInstancesFilterBy. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListServiceInstancesFilterBy. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ListServiceInstancesFilterBy) Values() []ListServiceInstancesFilterBy { return []ListServiceInstancesFilterBy{ "name", @@ -234,9 +235,9 @@ const ( ProvisioningCustomerManaged Provisioning = "CUSTOMER_MANAGED" ) -// Values returns all known values for Provisioning. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Provisioning. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Provisioning) Values() []Provisioning { return []Provisioning{ "CUSTOMER_MANAGED", @@ -302,9 +303,9 @@ const ( ResourceDeploymentStatusSucceeded ResourceDeploymentStatus = "SUCCEEDED" ) -// Values returns all known values for ResourceDeploymentStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceDeploymentStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceDeploymentStatus) Values() []ResourceDeploymentStatus { return []ResourceDeploymentStatus{ "IN_PROGRESS", @@ -388,10 +389,10 @@ const ( ServiceTemplateSupportedComponentSourceTypeDirectlyDefined ServiceTemplateSupportedComponentSourceType = "DIRECTLY_DEFINED" ) -// Values returns all known values for ServiceTemplateSupportedComponentSourceType. -// Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// Values returns all known values for +// ServiceTemplateSupportedComponentSourceType. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this +// slice is not guaranteed to be stable across updates. func (ServiceTemplateSupportedComponentSourceType) Values() []ServiceTemplateSupportedComponentSourceType { return []ServiceTemplateSupportedComponentSourceType{ "DIRECTLY_DEFINED", @@ -406,9 +407,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -444,9 +445,9 @@ const ( TemplateTypeService TemplateType = "SERVICE" ) -// Values returns all known values for TemplateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TemplateType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TemplateType) Values() []TemplateType { return []TemplateType{ "ENVIRONMENT", @@ -464,8 +465,8 @@ const ( TemplateVersionStatusPublished TemplateVersionStatus = "PUBLISHED" ) -// Values returns all known values for TemplateVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TemplateVersionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TemplateVersionStatus) Values() []TemplateVersionStatus { return []TemplateVersionStatus{ diff --git a/service/proton/types/errors.go b/service/proton/types/errors.go index d7229be0901..7d869e089dd 100644 --- a/service/proton/types/errors.go +++ b/service/proton/types/errors.go @@ -111,9 +111,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A quota was exceeded. For more information, see Proton Quotas -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) in the -// Proton User Guide. +// A quota was exceeded. For more information, see Proton Quotas (https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html) +// in the Proton User Guide. type ServiceQuotaExceededException struct { Message *string diff --git a/service/proton/types/types.go b/service/proton/types/types.go index 529d23963d2..25550802ce3 100644 --- a/service/proton/types/types.go +++ b/service/proton/types/types.go @@ -19,7 +19,7 @@ type AccountSettings struct { // The linked repository for pipeline provisioning. Required if you have // environments configured for self-managed provisioning with services that include // pipelines. A linked repository is a repository that has been registered with - // Proton. For more information, see CreateRepository. + // Proton. For more information, see CreateRepository . PipelineProvisioningRepository *RepositoryBranch // The Amazon Resource Name (ARN) of the service role you want to use for @@ -63,9 +63,8 @@ type CompatibleEnvironmentTemplateInput struct { } // Detailed data of an Proton component resource. For more information about -// components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. type Component struct { // The Amazon Resource Name (ARN) of the component. @@ -121,8 +120,8 @@ type Component struct { // when a component is attached to a service instance. ServiceName *string - // The service spec that the component uses to access service inputs. Provided when - // a component is attached to a service instance. + // The service spec that the component uses to access service inputs. Provided + // when a component is attached to a service instance. // // This value conforms to the media type: application/yaml ServiceSpec *string @@ -131,9 +130,8 @@ type Component struct { } // Summary data of an Proton component resource. For more information about -// components, see Proton components -// (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the -// Proton User Guide. +// components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) +// in the Proton User Guide. type ComponentSummary struct { // The Amazon Resource Name (ARN) of the component. @@ -189,19 +187,20 @@ type ComponentSummary struct { // Summary counts of each Proton resource type. type CountsSummary struct { - // The total number of components in the Amazon Web Services account. The semantics - // of the components field are different from the semantics of results for other - // infrastructure-provisioning resources. That's because at this time components - // don't have associated templates, therefore they don't have the concept of - // staleness. The components object will only contain total and failed members. + // The total number of components in the Amazon Web Services account. The + // semantics of the components field are different from the semantics of results + // for other infrastructure-provisioning resources. That's because at this time + // components don't have associated templates, therefore they don't have the + // concept of staleness. The components object will only contain total and failed + // members. Components *ResourceCountsSummary // The total number of environment templates in the Amazon Web Services account. // The environmentTemplates object will only contain total members. EnvironmentTemplates *ResourceCountsSummary - // The staleness counts for Proton environments in the Amazon Web Services account. - // The environments object will only contain total members. + // The staleness counts for Proton environments in the Amazon Web Services + // account. The environments object will only contain total members. Environments *ResourceCountsSummary // The staleness counts for Proton pipelines in the Amazon Web Services account. @@ -279,9 +278,8 @@ type Environment struct { // scope of infrastructure that a component can provision. The environment must // have a componentRoleArn to allow directly defined components to be associated // with the environment. For more information about components, see Proton - // components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // An environment deployment status message. @@ -308,8 +306,8 @@ type Environment struct { // The linked repository that you use to host your rendered infrastructure // templates for self-managed provisioning. A linked repository is a repository - // that has been registered with Proton. For more information, see CreateRepository - // (https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html). + // that has been registered with Proton. For more information, see CreateRepository (https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html) + // . ProvisioningRepository *RepositoryBranch // The environment spec. @@ -380,9 +378,8 @@ type EnvironmentAccountConnection struct { // It determines the scope of infrastructure that a component can provision in the // account. The environment account connection must have a componentRoleArn to // allow directly defined components to be associated with any environments running - // in the account. For more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // in the account. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string noSmithyDocumentSerde @@ -444,9 +441,8 @@ type EnvironmentAccountConnectionSummary struct { // It determines the scope of infrastructure that a component can provision in the // account. The environment account connection must have a componentRoleArn to // allow directly defined components to be associated with any environments running - // in the account. For more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // in the account. For more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string noSmithyDocumentSerde @@ -506,9 +502,8 @@ type EnvironmentSummary struct { // scope of infrastructure that a component can provision. The environment must // have a componentRoleArn to allow directly defined components to be associated // with the environment. For more information about components, see Proton - // components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. ComponentRoleArn *string // An environment deployment status message. @@ -747,10 +742,10 @@ type ListServiceInstancesFilter struct { // The name of a filtering criterion. Key ListServiceInstancesFilterBy - // A value to filter by. With the date/time keys (*At{Before,After}), the value is - // a valid RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339.html) string + // A value to filter by. With the date/time keys ( *At{Before,After} ), the value + // is a valid RFC 3339 (https://datatracker.ietf.org/doc/html/rfc3339.html) string // with no UTC offset and with an optional fractional precision (for example, - // 1985-04-12T23:20:50.52Z). + // 1985-04-12T23:20:50.52Z ). Value *string noSmithyDocumentSerde @@ -779,8 +774,7 @@ type ProvisionedResource struct { // The resource provisioning engine. At this time, CLOUDFORMATION can be used for // Amazon Web Services-managed provisioning, and TERRAFORM can be used for - // self-managed provisioning. For more information, see Self-managed provisioning - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) + // self-managed provisioning. For more information, see Self-managed provisioning (https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self) // in the Proton User Guide. ProvisioningEngine ProvisionedResourceEngine @@ -874,8 +868,8 @@ type RepositorySummary struct { // This member is required. Arn *string - // The Amazon Resource Name (ARN) of the of your connection that connects Proton to - // your repository. + // The Amazon Resource Name (ARN) of the of your connection that connects Proton + // to your repository. // // This member is required. ConnectionArn *string @@ -984,8 +978,8 @@ type ResourceCountsSummary struct { // failed to deploy. Failed *int32 - // The number of resources of this type in the Amazon Web Services account that are - // up-to-date with their template. + // The number of resources of this type in the Amazon Web Services account that + // are up-to-date with their template. UpToDate *int32 noSmithyDocumentSerde @@ -1150,8 +1144,7 @@ type Service struct { Pipeline *ServicePipeline // The Amazon Resource Name (ARN) of the repository connection. For more - // information, see Setting up an AWS CodeStar connection - // (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol) + // information, see Setting up an AWS CodeStar connection (https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol) // in the Proton User Guide. RepositoryConnectionArn *string @@ -1494,7 +1487,7 @@ type ServiceTemplate struct { // data. EncryptionKey *string - // If pipelineProvisioning is true, a service pipeline is included in the service + // If pipelineProvisioning is true , a service pipeline is included in the service // template. Otherwise, a service pipeline isn't included in the service template. PipelineProvisioning Provisioning @@ -1533,7 +1526,7 @@ type ServiceTemplateSummary struct { // The service template name as displayed in the developer interface. DisplayName *string - // If pipelineProvisioning is true, a service pipeline is included in the service + // If pipelineProvisioning is true , a service pipeline is included in the service // template, otherwise a service pipeline isn't included in the service template. PipelineProvisioning Provisioning @@ -1604,9 +1597,8 @@ type ServiceTemplateVersion struct { // An array of supported component sources. Components with supported sources can // be attached to service instances based on this service template version. For - // more information about components, see Proton components - // (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the - // Proton User Guide. + // more information about components, see Proton components (https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) + // in the Proton User Guide. SupportedComponentSources []ServiceTemplateSupportedComponentSourceType noSmithyDocumentSerde @@ -1743,7 +1735,7 @@ type TemplateSyncConfig struct { // This member is required. Branch *string - // The repository name (for example, myrepos/myrepo). + // The repository name (for example, myrepos/myrepo ). // // This member is required. RepositoryName *string diff --git a/service/qldb/api_client.go b/service/qldb/api_client.go index 86c47478eb5..4a0faa2e6a9 100644 --- a/service/qldb/api_client.go +++ b/service/qldb/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/qldb/api_op_CancelJournalKinesisStream.go b/service/qldb/api_op_CancelJournalKinesisStream.go index a7e4384d7b3..6fb81c69c35 100644 --- a/service/qldb/api_op_CancelJournalKinesisStream.go +++ b/service/qldb/api_op_CancelJournalKinesisStream.go @@ -11,7 +11,7 @@ import ( ) // Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its -// current status must be ACTIVE. You can't restart a stream after you cancel it. +// current status must be ACTIVE . You can't restart a stream after you cancel it. // Canceled QLDB stream resources are subject to a 7-day retention period, so they // are automatically deleted after this limit expires. func (c *Client) CancelJournalKinesisStream(ctx context.Context, params *CancelJournalKinesisStreamInput, optFns ...func(*Options)) (*CancelJournalKinesisStreamOutput, error) { diff --git a/service/qldb/api_op_CreateLedger.go b/service/qldb/api_op_CreateLedger.go index ff1c0792c7f..02fc9fbfd7f 100644 --- a/service/qldb/api_op_CreateLedger.go +++ b/service/qldb/api_op_CreateLedger.go @@ -32,8 +32,7 @@ type CreateLedgerInput struct { // The name of the ledger that you want to create. The name must be unique among // all of the ledgers in your Amazon Web Services account in the current Region. - // Naming constraints for ledger names are defined in Quotas in Amazon QLDB - // (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) + // Naming constraints for ledger names are defined in Quotas in Amazon QLDB (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) // in the Amazon QLDB Developer Guide. // // This member is required. @@ -41,78 +40,55 @@ type CreateLedgerInput struct { // The permissions mode to assign to the ledger that you want to create. This // parameter can have one of the following values: - // - // * ALLOW_ALL: A legacy - // permissions mode that enables access control with API-level granularity for - // ledgers. This mode allows users who have the SendCommand API permission for this - // ledger to run all PartiQL commands (hence, ALLOW_ALL) on any tables in the - // specified ledger. This mode disregards any table-level or command-level IAM - // permissions policies that you create for the ledger. - // - // * STANDARD: (Recommended) - // A permissions mode that enables access control with finer granularity for - // ledgers, tables, and PartiQL commands. By default, this mode denies all user - // requests to run any PartiQL commands on any tables in this ledger. To allow - // PartiQL commands to run, you must create IAM permissions policies for specific - // table resources and PartiQL actions, in addition to the SendCommand API - // permission for the ledger. For information, see Getting started with the - // standard permissions mode - // (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) - // in the Amazon QLDB Developer Guide. - // - // We strongly recommend using the STANDARD - // permissions mode to maximize the security of your ledger data. + // - ALLOW_ALL : A legacy permissions mode that enables access control with + // API-level granularity for ledgers. This mode allows users who have the + // SendCommand API permission for this ledger to run all PartiQL commands (hence, + // ALLOW_ALL ) on any tables in the specified ledger. This mode disregards any + // table-level or command-level IAM permissions policies that you create for the + // ledger. + // - STANDARD : (Recommended) A permissions mode that enables access control with + // finer granularity for ledgers, tables, and PartiQL commands. By default, this + // mode denies all user requests to run any PartiQL commands on any tables in this + // ledger. To allow PartiQL commands to run, you must create IAM permissions + // policies for specific table resources and PartiQL actions, in addition to the + // SendCommand API permission for the ledger. For information, see Getting + // started with the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) + // in the Amazon QLDB Developer Guide. + // We strongly recommend using the STANDARD permissions mode to maximize the + // security of your ledger data. // // This member is required. PermissionsMode types.PermissionsMode // The flag that prevents a ledger from being deleted by any user. If not provided - // on ledger creation, this feature is enabled (true) by default. If deletion + // on ledger creation, this feature is enabled ( true ) by default. If deletion // protection is enabled, you must first disable it before you can delete the - // ledger. You can disable it by calling the UpdateLedger operation to set the flag - // to false. + // ledger. You can disable it by calling the UpdateLedger operation to set the + // flag to false . DeletionProtection *bool - // The key in Key Management Service (KMS) to use for encryption of data at rest in - // the ledger. For more information, see Encryption at rest - // (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) + // The key in Key Management Service (KMS) to use for encryption of data at rest + // in the ledger. For more information, see Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) // in the Amazon QLDB Developer Guide. Use one of the following options to specify // this parameter: - // - // * AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed - // by Amazon Web Services on your behalf. - // - // * Undefined: By default, use an Amazon - // Web Services owned KMS key. - // - // * A valid symmetric customer managed KMS key: Use - // the specified KMS key in your account that you create, own, and manage. Amazon - // QLDB does not support asymmetric keys. For more information, see Using symmetric - // and asymmetric keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // - AWS_OWNED_KMS_KEY : Use an KMS key that is owned and managed by Amazon Web + // Services on your behalf. + // - Undefined: By default, use an Amazon Web Services owned KMS key. + // - A valid symmetric customer managed KMS key: Use the specified KMS key in + // your account that you create, own, and manage. Amazon QLDB does not support + // asymmetric keys. For more information, see Using symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // in the Key Management Service Developer Guide. + // To specify a customer managed KMS key, you can use its key ID, Amazon Resource + // Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with + // "alias/" . To specify a key in a different Amazon Web Services account, you must + // use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // For more information, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) // in the Key Management Service Developer Guide. - // - // To specify a customer managed - // KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or - // alias ARN. When using an alias name, prefix it with "alias/". To specify a key - // in a different Amazon Web Services account, you must use the key ARN or alias - // ARN. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // For more information, see - // Key identifiers (KeyId) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in - // the Key Management Service Developer Guide. KmsKey *string // The key-value pairs to add as tags to the ledger that you want to create. Tag @@ -133,10 +109,10 @@ type CreateLedgerOutput struct { CreationDateTime *time.Time // The flag that prevents a ledger from being deleted by any user. If not provided - // on ledger creation, this feature is enabled (true) by default. If deletion + // on ledger creation, this feature is enabled ( true ) by default. If deletion // protection is enabled, you must first disable it before you can delete the - // ledger. You can disable it by calling the UpdateLedger operation to set the flag - // to false. + // ledger. You can disable it by calling the UpdateLedger operation to set the + // flag to false . DeletionProtection *bool // The ARN of the customer managed KMS key that the ledger uses for encryption at diff --git a/service/qldb/api_op_DeleteLedger.go b/service/qldb/api_op_DeleteLedger.go index 2d8a1f50d57..a0ea9f6b43b 100644 --- a/service/qldb/api_op_DeleteLedger.go +++ b/service/qldb/api_op_DeleteLedger.go @@ -13,7 +13,7 @@ import ( // Deletes a ledger and all of its contents. This action is irreversible. If // deletion protection is enabled, you must first disable it before you can delete // the ledger. You can disable it by calling the UpdateLedger operation to set the -// flag to false. +// flag to false . func (c *Client) DeleteLedger(ctx context.Context, params *DeleteLedgerInput, optFns ...func(*Options)) (*DeleteLedgerOutput, error) { if params == nil { params = &DeleteLedgerInput{} diff --git a/service/qldb/api_op_DescribeJournalKinesisStream.go b/service/qldb/api_op_DescribeJournalKinesisStream.go index 1382591c531..585a8758031 100644 --- a/service/qldb/api_op_DescribeJournalKinesisStream.go +++ b/service/qldb/api_op_DescribeJournalKinesisStream.go @@ -15,8 +15,7 @@ import ( // output includes the Amazon Resource Name (ARN), stream name, current status, // creation time, and the parameters of the original stream creation request. This // action does not return any expired journal streams. For more information, see -// Expiration for terminal streams -// (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) +// Expiration for terminal streams (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) // in the Amazon QLDB Developer Guide. func (c *Client) DescribeJournalKinesisStream(ctx context.Context, params *DescribeJournalKinesisStreamInput, optFns ...func(*Options)) (*DescribeJournalKinesisStreamOutput, error) { if params == nil { diff --git a/service/qldb/api_op_DescribeJournalS3Export.go b/service/qldb/api_op_DescribeJournalS3Export.go index 98bce4a5554..58872c87e40 100644 --- a/service/qldb/api_op_DescribeJournalS3Export.go +++ b/service/qldb/api_op_DescribeJournalS3Export.go @@ -14,11 +14,10 @@ import ( // Returns information about a journal export job, including the ledger name, // export ID, creation time, current status, and the parameters of the original // export creation request. This action does not return any expired export jobs. -// For more information, see Export job expiration -// (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) +// For more information, see Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) // in the Amazon QLDB Developer Guide. If the export job with the given ExportId -// doesn't exist, then throws ResourceNotFoundException. If the ledger with the -// given Name doesn't exist, then throws ResourceNotFoundException. +// doesn't exist, then throws ResourceNotFoundException . If the ledger with the +// given Name doesn't exist, then throws ResourceNotFoundException . func (c *Client) DescribeJournalS3Export(ctx context.Context, params *DescribeJournalS3ExportInput, optFns ...func(*Options)) (*DescribeJournalS3ExportOutput, error) { if params == nil { params = &DescribeJournalS3ExportInput{} diff --git a/service/qldb/api_op_DescribeLedger.go b/service/qldb/api_op_DescribeLedger.go index a8e3c5e8421..6fae6712fd6 100644 --- a/service/qldb/api_op_DescribeLedger.go +++ b/service/qldb/api_op_DescribeLedger.go @@ -50,10 +50,10 @@ type DescribeLedgerOutput struct { CreationDateTime *time.Time // The flag that prevents a ledger from being deleted by any user. If not provided - // on ledger creation, this feature is enabled (true) by default. If deletion + // on ledger creation, this feature is enabled ( true ) by default. If deletion // protection is enabled, you must first disable it before you can delete the - // ledger. You can disable it by calling the UpdateLedger operation to set the flag - // to false. + // ledger. You can disable it by calling the UpdateLedger operation to set the + // flag to false . DeletionProtection *bool // Information about the encryption of data at rest in the ledger. This includes diff --git a/service/qldb/api_op_ExportJournalToS3.go b/service/qldb/api_op_ExportJournalToS3.go index 43444fb2f69..81a7a980361 100644 --- a/service/qldb/api_op_ExportJournalToS3.go +++ b/service/qldb/api_op_ExportJournalToS3.go @@ -20,11 +20,11 @@ import ( // newline. You can use this format to easily integrate JSON exports with analytics // tools such as Glue and Amazon Athena because these services can parse // newline-delimited JSON automatically. For more information about the format, see -// JSON Lines (https://jsonlines.org/). If the ledger with the given Name doesn't -// exist, then throws ResourceNotFoundException. If the ledger with the given Name -// is in CREATING status, then throws ResourcePreconditionNotMetException. You can +// JSON Lines (https://jsonlines.org/) . If the ledger with the given Name doesn't +// exist, then throws ResourceNotFoundException . If the ledger with the given Name +// is in CREATING status, then throws ResourcePreconditionNotMetException . You can // initiate up to two concurrent journal export requests for each ledger. Beyond -// this limit, journal export requests throw LimitExceededException. +// this limit, journal export requests throw LimitExceededException . func (c *Client) ExportJournalToS3(ctx context.Context, params *ExportJournalToS3Input, optFns ...func(*Options)) (*ExportJournalToS3Output, error) { if params == nil { params = &ExportJournalToS3Input{} @@ -42,20 +42,20 @@ func (c *Client) ExportJournalToS3(ctx context.Context, params *ExportJournalToS type ExportJournalToS3Input struct { - // The exclusive end date and time for the range of journal contents to export. The - // ExclusiveEndTime must be in ISO 8601 date and time format and in Universal - // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The ExclusiveEndTime + // The exclusive end date and time for the range of journal contents to export. + // The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal + // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z . The ExclusiveEndTime // must be less than or equal to the current UTC date and time. // // This member is required. ExclusiveEndTime *time.Time // The inclusive start date and time for the range of journal contents to export. - // The InclusiveStartTime must be in ISO 8601 date and time format and in Universal - // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The - // InclusiveStartTime must be before ExclusiveEndTime. If you provide an - // InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB - // defaults it to the ledger's CreationDateTime. + // The InclusiveStartTime must be in ISO 8601 date and time format and in + // Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z . The + // InclusiveStartTime must be before ExclusiveEndTime . If you provide an + // InclusiveStartTime that is before the ledger's CreationDateTime , Amazon QLDB + // defaults it to the ledger's CreationDateTime . // // This member is required. InclusiveStartTime *time.Time @@ -67,17 +67,12 @@ type ExportJournalToS3Input struct { // The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for // a journal export job to do the following: - // - // * Write objects into your Amazon - // Simple Storage Service (Amazon S3) bucket. - // - // * (Optional) Use your customer - // managed key in Key Management Service (KMS) for server-side encryption of your - // exported data. - // - // To pass a role to QLDB when requesting a journal export, you - // must have permissions to perform the iam:PassRole action on the IAM role - // resource. This is required for all journal export requests. + // - Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. + // - (Optional) Use your customer managed key in Key Management Service (KMS) + // for server-side encryption of your exported data. + // To pass a role to QLDB when requesting a journal export, you must have + // permissions to perform the iam:PassRole action on the IAM role resource. This + // is required for all journal export requests. // // This member is required. RoleArn *string @@ -99,7 +94,7 @@ type ExportJournalToS3Output struct { // The UUID (represented in Base62-encoded text) that QLDB assigns to each journal // export job. To describe your export request and check the status of the job, you - // can use ExportId to call DescribeJournalS3Export. + // can use ExportId to call DescribeJournalS3Export . // // This member is required. ExportId *string diff --git a/service/qldb/api_op_GetBlock.go b/service/qldb/api_op_GetBlock.go index 897e2fbbdf4..0e4b84bd6fc 100644 --- a/service/qldb/api_op_GetBlock.go +++ b/service/qldb/api_op_GetBlock.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a block object at a specified address in a journal. Also returns a proof -// of the specified block for verification if DigestTipAddress is provided. For -// information about the data contents in a block, see Journal contents -// (https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html) +// Returns a block object at a specified address in a journal. Also returns a +// proof of the specified block for verification if DigestTipAddress is provided. +// For information about the data contents in a block, see Journal contents (https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html) // in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is -// in DELETING status, then throws ResourceNotFoundException. If the specified -// ledger is in CREATING status, then throws ResourcePreconditionNotMetException. +// in DELETING status, then throws ResourceNotFoundException . If the specified +// ledger is in CREATING status, then throws ResourcePreconditionNotMetException . // If no block exists with the specified address, then throws -// InvalidParameterException. +// InvalidParameterException . func (c *Client) GetBlock(ctx context.Context, params *GetBlockInput, optFns ...func(*Options)) (*GetBlockOutput, error) { if params == nil { params = &GetBlockInput{} @@ -38,8 +37,8 @@ func (c *Client) GetBlock(ctx context.Context, params *GetBlockInput, optFns ... type GetBlockInput struct { // The location of the block that you want to request. An address is an Amazon Ion - // structure that has two fields: strandId and sequenceNo. For example: - // {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}. + // structure that has two fields: strandId and sequenceNo . For example: + // {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14} . // // This member is required. BlockAddress *types.ValueHolder @@ -49,9 +48,9 @@ type GetBlockInput struct { // This member is required. Name *string - // The latest block location covered by the digest for which to request a proof. An - // address is an Amazon Ion structure that has two fields: strandId and sequenceNo. - // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}. + // The latest block location covered by the digest for which to request a proof. + // An address is an Amazon Ion structure that has two fields: strandId and + // sequenceNo . For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} . DigestTipAddress *types.ValueHolder noSmithyDocumentSerde diff --git a/service/qldb/api_op_GetDigest.go b/service/qldb/api_op_GetDigest.go index 2cfa8e68ea8..033ab68f2f8 100644 --- a/service/qldb/api_op_GetDigest.go +++ b/service/qldb/api_op_GetDigest.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the digest of a ledger at the latest committed block in the journal. The -// response includes a 256-bit hash value and a block address. +// Returns the digest of a ledger at the latest committed block in the journal. +// The response includes a 256-bit hash value and a block address. func (c *Client) GetDigest(ctx context.Context, params *GetDigestInput, optFns ...func(*Options)) (*GetDigestOutput, error) { if params == nil { params = &GetDigestInput{} @@ -46,7 +46,7 @@ type GetDigestOutput struct { Digest []byte // The latest block location covered by the digest that you requested. An address - // is an Amazon Ion structure that has two fields: strandId and sequenceNo. + // is an Amazon Ion structure that has two fields: strandId and sequenceNo . // // This member is required. DigestTipAddress *types.ValueHolder diff --git a/service/qldb/api_op_GetRevision.go b/service/qldb/api_op_GetRevision.go index e8094687428..f193389aa1c 100644 --- a/service/qldb/api_op_GetRevision.go +++ b/service/qldb/api_op_GetRevision.go @@ -32,8 +32,8 @@ func (c *Client) GetRevision(ctx context.Context, params *GetRevisionInput, optF type GetRevisionInput struct { // The block location of the document revision to be verified. An address is an - // Amazon Ion structure that has two fields: strandId and sequenceNo. For example: - // {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}. + // Amazon Ion structure that has two fields: strandId and sequenceNo . For example: + // {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14} . // // This member is required. BlockAddress *types.ValueHolder @@ -48,9 +48,9 @@ type GetRevisionInput struct { // This member is required. Name *string - // The latest block location covered by the digest for which to request a proof. An - // address is an Amazon Ion structure that has two fields: strandId and sequenceNo. - // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}. + // The latest block location covered by the digest for which to request a proof. + // An address is an Amazon Ion structure that has two fields: strandId and + // sequenceNo . For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} . DigestTipAddress *types.ValueHolder noSmithyDocumentSerde @@ -63,9 +63,10 @@ type GetRevisionOutput struct { // This member is required. Revision *types.ValueHolder - // The proof object in Amazon Ion format returned by a GetRevision request. A proof - // contains the list of hash values that are required to recalculate the specified - // digest using a Merkle tree, starting with the specified document revision. + // The proof object in Amazon Ion format returned by a GetRevision request. A + // proof contains the list of hash values that are required to recalculate the + // specified digest using a Merkle tree, starting with the specified document + // revision. Proof *types.ValueHolder // Metadata pertaining to the operation's result. diff --git a/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go b/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go index f386e49a28b..9e5f801e046 100644 --- a/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go +++ b/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go @@ -14,10 +14,9 @@ import ( // Returns an array of all Amazon QLDB journal stream descriptors for a given // ledger. The output of each stream descriptor includes the same details that are -// returned by DescribeJournalKinesisStream. This action does not return any +// returned by DescribeJournalKinesisStream . This action does not return any // expired journal streams. For more information, see Expiration for terminal -// streams -// (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) +// streams (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) // in the Amazon QLDB Developer Guide. This action returns a maximum of MaxResults // items. It is paginated so that you can retrieve all the items by calling // ListJournalKinesisStreamsForLedger multiple times. @@ -50,8 +49,7 @@ type ListJournalKinesisStreamsForLedgerInput struct { // A pagination token, indicating that you want to retrieve the next page of // results. If you received a value for NextToken in the response from a previous - // ListJournalKinesisStreamsForLedger call, you should use that value as input - // here. + // ListJournalKinesisStreamsForLedger call, you should use that value as input here. NextToken *string noSmithyDocumentSerde @@ -59,12 +57,11 @@ type ListJournalKinesisStreamsForLedgerInput struct { type ListJournalKinesisStreamsForLedgerOutput struct { - // * If NextToken is empty, the last page of results has been processed and there - // are no more results to be retrieved. - // - // * If NextToken is not empty, more results - // are available. To retrieve the next page of results, use the value of NextToken - // in a subsequent ListJournalKinesisStreamsForLedger call. + // - If NextToken is empty, the last page of results has been processed and there + // are no more results to be retrieved. + // - If NextToken is not empty, more results are available. To retrieve the next + // page of results, use the value of NextToken in a subsequent + // ListJournalKinesisStreamsForLedger call. NextToken *string // The array of QLDB journal stream descriptors that are associated with the given diff --git a/service/qldb/api_op_ListJournalS3Exports.go b/service/qldb/api_op_ListJournalS3Exports.go index c3056797c42..ed60e275370 100644 --- a/service/qldb/api_op_ListJournalS3Exports.go +++ b/service/qldb/api_op_ListJournalS3Exports.go @@ -14,11 +14,10 @@ import ( // Returns an array of journal export job descriptions for all ledgers that are // associated with the current Amazon Web Services account and Region. This action -// returns a maximum of MaxResults items, and is paginated so that you can retrieve -// all the items by calling ListJournalS3Exports multiple times. This action does -// not return any expired export jobs. For more information, see Export job -// expiration -// (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) +// returns a maximum of MaxResults items, and is paginated so that you can +// retrieve all the items by calling ListJournalS3Exports multiple times. This +// action does not return any expired export jobs. For more information, see +// Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) // in the Amazon QLDB Developer Guide. func (c *Client) ListJournalS3Exports(ctx context.Context, params *ListJournalS3ExportsInput, optFns ...func(*Options)) (*ListJournalS3ExportsOutput, error) { if params == nil { @@ -51,16 +50,15 @@ type ListJournalS3ExportsInput struct { type ListJournalS3ExportsOutput struct { - // The array of journal export job descriptions for all ledgers that are associated - // with the current Amazon Web Services account and Region. + // The array of journal export job descriptions for all ledgers that are + // associated with the current Amazon Web Services account and Region. JournalS3Exports []types.JournalS3ExportDescription - // * If NextToken is empty, then the last page of results has been processed and - // there are no more results to be retrieved. - // - // * If NextToken is not empty, then - // there are more results available. To retrieve the next page of results, use the - // value of NextToken in a subsequent ListJournalS3Exports call. + // - If NextToken is empty, then the last page of results has been processed and + // there are no more results to be retrieved. + // - If NextToken is not empty, then there are more results available. To + // retrieve the next page of results, use the value of NextToken in a subsequent + // ListJournalS3Exports call. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/qldb/api_op_ListJournalS3ExportsForLedger.go b/service/qldb/api_op_ListJournalS3ExportsForLedger.go index 8e886936460..47c11995fc2 100644 --- a/service/qldb/api_op_ListJournalS3ExportsForLedger.go +++ b/service/qldb/api_op_ListJournalS3ExportsForLedger.go @@ -12,12 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array of journal export job descriptions for a specified ledger. This -// action returns a maximum of MaxResults items, and is paginated so that you can -// retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. -// This action does not return any expired export jobs. For more information, see -// Export job expiration -// (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) +// Returns an array of journal export job descriptions for a specified ledger. +// This action returns a maximum of MaxResults items, and is paginated so that you +// can retrieve all the items by calling ListJournalS3ExportsForLedger multiple +// times. This action does not return any expired export jobs. For more +// information, see Export job expiration (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) // in the Amazon QLDB Developer Guide. func (c *Client) ListJournalS3ExportsForLedger(ctx context.Context, params *ListJournalS3ExportsForLedgerInput, optFns ...func(*Options)) (*ListJournalS3ExportsForLedgerOutput, error) { if params == nil { @@ -48,8 +47,7 @@ type ListJournalS3ExportsForLedgerInput struct { // A pagination token, indicating that you want to retrieve the next page of // results. If you received a value for NextToken in the response from a previous - // ListJournalS3ExportsForLedger call, then you should use that value as input - // here. + // ListJournalS3ExportsForLedger call, then you should use that value as input here. NextToken *string noSmithyDocumentSerde @@ -61,12 +59,11 @@ type ListJournalS3ExportsForLedgerOutput struct { // specified ledger. JournalS3Exports []types.JournalS3ExportDescription - // * If NextToken is empty, then the last page of results has been processed and - // there are no more results to be retrieved. - // - // * If NextToken is not empty, then - // there are more results available. To retrieve the next page of results, use the - // value of NextToken in a subsequent ListJournalS3ExportsForLedger call. + // - If NextToken is empty, then the last page of results has been processed and + // there are no more results to be retrieved. + // - If NextToken is not empty, then there are more results available. To + // retrieve the next page of results, use the value of NextToken in a subsequent + // ListJournalS3ExportsForLedger call. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/qldb/api_op_ListLedgers.go b/service/qldb/api_op_ListLedgers.go index 96c2e75b9d7..81136880e0d 100644 --- a/service/qldb/api_op_ListLedgers.go +++ b/service/qldb/api_op_ListLedgers.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array of ledger summaries that are associated with the current Amazon -// Web Services account and Region. This action returns a maximum of 100 items and -// is paginated so that you can retrieve all the items by calling ListLedgers -// multiple times. +// Returns an array of ledger summaries that are associated with the current +// Amazon Web Services account and Region. This action returns a maximum of 100 +// items and is paginated so that you can retrieve all the items by calling +// ListLedgers multiple times. func (c *Client) ListLedgers(ctx context.Context, params *ListLedgersInput, optFns ...func(*Options)) (*ListLedgersOutput, error) { if params == nil { params = &ListLedgersInput{} @@ -52,14 +52,11 @@ type ListLedgersOutput struct { Ledgers []types.LedgerSummary // A pagination token, indicating whether there are more results available: - // - // * If - // NextToken is empty, then the last page of results has been processed and there - // are no more results to be retrieved. - // - // * If NextToken is not empty, then there - // are more results available. To retrieve the next page of results, use the value - // of NextToken in a subsequent ListLedgers call. + // - If NextToken is empty, then the last page of results has been processed and + // there are no more results to be retrieved. + // - If NextToken is not empty, then there are more results available. To + // retrieve the next page of results, use the value of NextToken in a subsequent + // ListLedgers call. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/qldb/api_op_StreamJournalToKinesis.go b/service/qldb/api_op_StreamJournalToKinesis.go index 73b91cb0c46..6a4d44d52c4 100644 --- a/service/qldb/api_op_StreamJournalToKinesis.go +++ b/service/qldb/api_op_StreamJournalToKinesis.go @@ -34,10 +34,11 @@ type StreamJournalToKinesisInput struct { // The inclusive start date and time from which to start streaming journal data. // This parameter must be in ISO 8601 date and time format and in Universal - // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The - // InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime. + // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z . The + // InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime . // If you provide an InclusiveStartTime that is before the ledger's - // CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime. + // CreationDateTime , QLDB effectively defaults it to the ledger's CreationDateTime + // . // // This member is required. InclusiveStartTime *time.Time @@ -65,8 +66,7 @@ type StreamJournalToKinesisInput struct { // The name that you want to assign to the QLDB journal stream. User-defined names // can help identify and indicate the purpose of a stream. Your stream name must be // unique among other active streams for a given ledger. Stream names have the same - // naming constraints as ledger names, as defined in Quotas in Amazon QLDB - // (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) + // naming constraints as ledger names, as defined in Quotas in Amazon QLDB (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) // in the Amazon QLDB Developer Guide. // // This member is required. @@ -75,7 +75,7 @@ type StreamJournalToKinesisInput struct { // The exclusive date and time that specifies when the stream ends. If you don't // define this parameter, the stream runs indefinitely until you cancel it. The // ExclusiveEndTime must be in ISO 8601 date and time format and in Universal - // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. + // Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z . ExclusiveEndTime *time.Time // The key-value pairs to add as tags to the stream that you want to create. Tag diff --git a/service/qldb/api_op_UpdateLedger.go b/service/qldb/api_op_UpdateLedger.go index 90e91b3d6a1..a294650daac 100644 --- a/service/qldb/api_op_UpdateLedger.go +++ b/service/qldb/api_op_UpdateLedger.go @@ -36,52 +36,34 @@ type UpdateLedgerInput struct { Name *string // The flag that prevents a ledger from being deleted by any user. If not provided - // on ledger creation, this feature is enabled (true) by default. If deletion + // on ledger creation, this feature is enabled ( true ) by default. If deletion // protection is enabled, you must first disable it before you can delete the - // ledger. You can disable it by calling the UpdateLedger operation to set the flag - // to false. + // ledger. You can disable it by calling the UpdateLedger operation to set the + // flag to false . DeletionProtection *bool - // The key in Key Management Service (KMS) to use for encryption of data at rest in - // the ledger. For more information, see Encryption at rest - // (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) + // The key in Key Management Service (KMS) to use for encryption of data at rest + // in the ledger. For more information, see Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) // in the Amazon QLDB Developer Guide. Use one of the following options to specify // this parameter: - // - // * AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed - // by Amazon Web Services on your behalf. - // - // * Undefined: Make no changes to the KMS - // key of the ledger. - // - // * A valid symmetric customer managed KMS key: Use the - // specified KMS key in your account that you create, own, and manage. Amazon QLDB - // does not support asymmetric keys. For more information, see Using symmetric and - // asymmetric keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // - AWS_OWNED_KMS_KEY : Use an KMS key that is owned and managed by Amazon Web + // Services on your behalf. + // - Undefined: Make no changes to the KMS key of the ledger. + // - A valid symmetric customer managed KMS key: Use the specified KMS key in + // your account that you create, own, and manage. Amazon QLDB does not support + // asymmetric keys. For more information, see Using symmetric and asymmetric keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // in the Key Management Service Developer Guide. + // To specify a customer managed KMS key, you can use its key ID, Amazon Resource + // Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with + // "alias/" . To specify a key in a different Amazon Web Services account, you must + // use the key ARN or alias ARN. For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + // For more information, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) // in the Key Management Service Developer Guide. - // - // To specify a customer managed - // KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or - // alias ARN. When using an alias name, prefix it with "alias/". To specify a key - // in a different Amazon Web Services account, you must use the key ARN or alias - // ARN. For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - // - // For more information, see - // Key identifiers (KeyId) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in - // the Key Management Service Developer Guide. KmsKey *string noSmithyDocumentSerde @@ -98,10 +80,10 @@ type UpdateLedgerOutput struct { CreationDateTime *time.Time // The flag that prevents a ledger from being deleted by any user. If not provided - // on ledger creation, this feature is enabled (true) by default. If deletion + // on ledger creation, this feature is enabled ( true ) by default. If deletion // protection is enabled, you must first disable it before you can delete the - // ledger. You can disable it by calling the UpdateLedger operation to set the flag - // to false. + // ledger. You can disable it by calling the UpdateLedger operation to set the + // flag to false . DeletionProtection *bool // Information about the encryption of data at rest in the ledger. This includes diff --git a/service/qldb/api_op_UpdateLedgerPermissionsMode.go b/service/qldb/api_op_UpdateLedgerPermissionsMode.go index a055e902cf6..f140b16c89e 100644 --- a/service/qldb/api_op_UpdateLedgerPermissionsMode.go +++ b/service/qldb/api_op_UpdateLedgerPermissionsMode.go @@ -14,8 +14,7 @@ import ( // Updates the permissions mode of a ledger. Before you switch to the STANDARD // permissions mode, you must first create all required IAM policies and table tags // to avoid disruption to your users. To learn more, see Migrating to the standard -// permissions mode -// (https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating) +// permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating) // in the Amazon QLDB Developer Guide. func (c *Client) UpdateLedgerPermissionsMode(ctx context.Context, params *UpdateLedgerPermissionsModeInput, optFns ...func(*Options)) (*UpdateLedgerPermissionsModeOutput, error) { if params == nil { @@ -39,28 +38,24 @@ type UpdateLedgerPermissionsModeInput struct { // This member is required. Name *string - // The permissions mode to assign to the ledger. This parameter can have one of the - // following values: - // - // * ALLOW_ALL: A legacy permissions mode that enables access - // control with API-level granularity for ledgers. This mode allows users who have - // the SendCommand API permission for this ledger to run all PartiQL commands - // (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards - // any table-level or command-level IAM permissions policies that you create for - // the ledger. - // - // * STANDARD: (Recommended) A permissions mode that enables access - // control with finer granularity for ledgers, tables, and PartiQL commands. By - // default, this mode denies all user requests to run any PartiQL commands on any - // tables in this ledger. To allow PartiQL commands to run, you must create IAM - // permissions policies for specific table resources and PartiQL actions, in - // addition to the SendCommand API permission for the ledger. For information, see - // Getting started with the standard permissions mode - // (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) - // in the Amazon QLDB Developer Guide. - // - // We strongly recommend using the STANDARD - // permissions mode to maximize the security of your ledger data. + // The permissions mode to assign to the ledger. This parameter can have one of + // the following values: + // - ALLOW_ALL : A legacy permissions mode that enables access control with + // API-level granularity for ledgers. This mode allows users who have the + // SendCommand API permission for this ledger to run all PartiQL commands (hence, + // ALLOW_ALL ) on any tables in the specified ledger. This mode disregards any + // table-level or command-level IAM permissions policies that you create for the + // ledger. + // - STANDARD : (Recommended) A permissions mode that enables access control with + // finer granularity for ledgers, tables, and PartiQL commands. By default, this + // mode denies all user requests to run any PartiQL commands on any tables in this + // ledger. To allow PartiQL commands to run, you must create IAM permissions + // policies for specific table resources and PartiQL actions, in addition to the + // SendCommand API permission for the ledger. For information, see Getting + // started with the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) + // in the Amazon QLDB Developer Guide. + // We strongly recommend using the STANDARD permissions mode to maximize the + // security of your ledger data. // // This member is required. PermissionsMode types.PermissionsMode diff --git a/service/qldb/doc.go b/service/qldb/doc.go index 50d360b12c4..2f3d65cc4a1 100644 --- a/service/qldb/doc.go +++ b/service/qldb/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package qldb provides the API client, operations, and parameter types for Amazon -// QLDB. +// Package qldb provides the API client, operations, and parameter types for +// Amazon QLDB. // // The control plane for Amazon QLDB package qldb diff --git a/service/qldb/types/enums.go b/service/qldb/types/enums.go index 141a9b34f20..0a097327e64 100644 --- a/service/qldb/types/enums.go +++ b/service/qldb/types/enums.go @@ -49,9 +49,9 @@ const ( ExportStatusCancelled ExportStatus = "CANCELLED" ) -// Values returns all known values for ExportStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExportStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExportStatus) Values() []ExportStatus { return []ExportStatus{ "IN_PROGRESS", @@ -91,9 +91,9 @@ const ( OutputFormatJson OutputFormat = "JSON" ) -// Values returns all known values for OutputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OutputFormat) Values() []OutputFormat { return []OutputFormat{ "ION_BINARY", @@ -151,9 +151,9 @@ const ( StreamStatusImpaired StreamStatus = "IMPAIRED" ) -// Values returns all known values for StreamStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StreamStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StreamStatus) Values() []StreamStatus { return []StreamStatus{ "ACTIVE", diff --git a/service/qldb/types/types.go b/service/qldb/types/types.go index 08c075da2e2..cc1d1adc661 100644 --- a/service/qldb/types/types.go +++ b/service/qldb/types/types.go @@ -53,7 +53,7 @@ type JournalKinesisStreamDescription struct { CreationTime *time.Time // The error message that describes the reason that a stream has a status of - // IMPAIRED or FAILED. This is not applicable to streams that have other status + // IMPAIRED or FAILED . This is not applicable to streams that have other status // values. ErrorCause ErrorCause @@ -78,9 +78,9 @@ type JournalS3ExportDescription struct { // This member is required. ExclusiveEndTime *time.Time - // The date and time, in epoch time format, when the export job was created. (Epoch - // time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 - // UTC.) + // The date and time, in epoch time format, when the export job was created. + // (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, + // 1970 UTC.) // // This member is required. ExportCreationTime *time.Time @@ -103,19 +103,15 @@ type JournalS3ExportDescription struct { // The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for // a journal export job to do the following: - // - // * Write objects into your Amazon - // Simple Storage Service (Amazon S3) bucket. - // - // * (Optional) Use your customer - // managed key in Key Management Service (KMS) for server-side encryption of your - // exported data. + // - Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. + // - (Optional) Use your customer managed key in Key Management Service (KMS) + // for server-side encryption of your exported data. // // This member is required. RoleArn *string - // The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal - // export job writes the journal contents. + // The Amazon Simple Storage Service (Amazon S3) bucket location in which a + // journal export job writes the journal contents. // // This member is required. S3ExportConfiguration *S3ExportConfiguration @@ -131,8 +127,8 @@ type JournalS3ExportDescription struct { noSmithyDocumentSerde } -// The configuration settings of the Amazon Kinesis Data Streams destination for an -// Amazon QLDB journal stream. +// The configuration settings of the Amazon Kinesis Data Streams destination for +// an Amazon QLDB journal stream. type KinesisConfiguration struct { // The Amazon Resource Name (ARN) of the Kinesis Data Streams resource. @@ -144,10 +140,8 @@ type KinesisConfiguration struct { // record, increasing the number of records sent per API call. This option is // enabled by default. Record aggregation has important implications for processing // records and requires de-aggregation in your stream consumer. To learn more, see - // KPL Key Concepts - // (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and - // Consumer De-aggregation - // (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) + // KPL Key Concepts (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) + // and Consumer De-aggregation (https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) // in the Amazon Kinesis Data Streams Developer Guide. AggregationEnabled *bool @@ -157,31 +151,26 @@ type KinesisConfiguration struct { // Information about the encryption of data at rest in an Amazon QLDB ledger. This // includes the current status, the key in Key Management Service (KMS), and when // the key became inaccessible (in the case of an error). For more information, see -// Encryption at rest -// (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) +// Encryption at rest (https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) // in the Amazon QLDB Developer Guide. type LedgerEncryptionDescription struct { // The current state of encryption at rest for the ledger. This can be one of the // following values: - // - // * ENABLED: Encryption is fully enabled using the specified - // key. - // - // * UPDATING: The ledger is actively processing the specified key change. - // Key changes in QLDB are asynchronous. The ledger is fully accessible without any - // performance impact while the key change is being processed. The amount of time - // it takes to update a key varies depending on the ledger size. - // - // * - // KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, - // and the ledger is impaired. Either the key was disabled or deleted, or the - // grants on the key were revoked. When a ledger is impaired, it is not accessible - // and does not accept any read or write requests. An impaired ledger automatically - // returns to an active state after you restore the grants on the key, or re-enable - // the key that was disabled. However, deleting a customer managed KMS key is - // irreversible. After a key is deleted, you can no longer access the ledgers that - // are protected with that key, and the data becomes unrecoverable permanently. + // - ENABLED : Encryption is fully enabled using the specified key. + // - UPDATING : The ledger is actively processing the specified key change. Key + // changes in QLDB are asynchronous. The ledger is fully accessible without any + // performance impact while the key change is being processed. The amount of time + // it takes to update a key varies depending on the ledger size. + // - KMS_KEY_INACCESSIBLE : The specified customer managed KMS key is not + // accessible, and the ledger is impaired. Either the key was disabled or deleted, + // or the grants on the key were revoked. When a ledger is impaired, it is not + // accessible and does not accept any read or write requests. An impaired ledger + // automatically returns to an active state after you restore the grants on the + // key, or re-enable the key that was disabled. However, deleting a customer + // managed KMS key is irreversible. After a key is deleted, you can no longer + // access the ledgers that are protected with that key, and the data becomes + // unrecoverable permanently. // // This member is required. EncryptionStatus EncryptionStatus @@ -223,32 +212,31 @@ type LedgerSummary struct { // an Amazon Simple Storage Service (Amazon S3) bucket. type S3EncryptionConfiguration struct { - // The Amazon S3 object encryption type. To learn more about server-side encryption - // options in Amazon S3, see Protecting Data Using Server-Side Encryption - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in - // the Amazon S3 Developer Guide. + // The Amazon S3 object encryption type. To learn more about server-side + // encryption options in Amazon S3, see Protecting Data Using Server-Side + // Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) + // in the Amazon S3 Developer Guide. // // This member is required. ObjectEncryptionType S3ObjectEncryptionType // The Amazon Resource Name (ARN) of a symmetric key in Key Management Service // (KMS). Amazon S3 does not support asymmetric KMS keys. You must provide a - // KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType. KmsKeyArn is not - // required if you specify SSE_S3 as the ObjectEncryptionType. + // KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType . KmsKeyArn is not + // required if you specify SSE_S3 as the ObjectEncryptionType . KmsKeyArn *string noSmithyDocumentSerde } -// The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal -// export job writes the journal contents. +// The Amazon Simple Storage Service (Amazon S3) bucket location in which a +// journal export job writes the journal contents. type S3ExportConfiguration struct { // The Amazon S3 bucket name in which a journal export job writes the journal // contents. The bucket name must comply with the Amazon S3 bucket naming - // conventions. For more information, see Bucket Restrictions and Limitations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) in the - // Amazon S3 Developer Guide. + // conventions. For more information, see Bucket Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) + // in the Amazon S3 Developer Guide. // // This member is required. Bucket *string @@ -261,16 +249,12 @@ type S3ExportConfiguration struct { // The prefix for the Amazon S3 bucket in which a journal export job writes the // journal contents. The prefix must comply with Amazon S3 key naming rules and - // restrictions. For more information, see Object Key and Metadata - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) in the - // Amazon S3 Developer Guide. The following are examples of valid Prefix values: - // - // * - // JournalExports-ForMyLedger/Testing/ - // - // * JournalExports - // - // * My:Tests/ + // restrictions. For more information, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) + // in the Amazon S3 Developer Guide. The following are examples of valid Prefix + // values: + // - JournalExports-ForMyLedger/Testing/ + // - JournalExports + // - My:Tests/ // // This member is required. Prefix *string diff --git a/service/qldbsession/api_client.go b/service/qldbsession/api_client.go index 3ee495cbc9d..1ad5a24d561 100644 --- a/service/qldbsession/api_client.go +++ b/service/qldbsession/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/qldbsession/api_op_SendCommand.go b/service/qldbsession/api_op_SendCommand.go index b26de7e2c49..7b8d77f6a0c 100644 --- a/service/qldbsession/api_op_SendCommand.go +++ b/service/qldbsession/api_op_SendCommand.go @@ -14,20 +14,16 @@ import ( // Sends a command to an Amazon QLDB ledger. Instead of interacting directly with // this API, we recommend using the QLDB driver or the QLDB shell to execute data // transactions on a ledger. -// -// * If you are working with an AWS SDK, use the QLDB -// driver. The driver provides a high-level abstraction layer above this QLDB -// Session data plane and manages SendCommand API calls for you. For information -// and a list of supported programming languages, see Getting started with the -// driver -// (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) -// in the Amazon QLDB Developer Guide. -// -// * If you are working with the AWS Command -// Line Interface (AWS CLI), use the QLDB shell. The shell is a command line -// interface that uses the QLDB driver to interact with a ledger. For information, -// see Accessing Amazon QLDB using the QLDB shell -// (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). +// - If you are working with an AWS SDK, use the QLDB driver. The driver +// provides a high-level abstraction layer above this QLDB Session data plane and +// manages SendCommand API calls for you. For information and a list of supported +// programming languages, see Getting started with the driver (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) +// in the Amazon QLDB Developer Guide. +// - If you are working with the AWS Command Line Interface (AWS CLI), use the +// QLDB shell. The shell is a command line interface that uses the QLDB driver to +// interact with a ledger. For information, see Accessing Amazon QLDB using the +// QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html) +// . func (c *Client) SendCommand(ctx context.Context, params *SendCommandInput, optFns ...func(*Options)) (*SendCommandOutput, error) { if params == nil { params = &SendCommandInput{} @@ -60,10 +56,10 @@ type SendCommandInput struct { // Command to fetch a page. FetchPage *types.FetchPageRequest - // Specifies the session token for the current command. A session token is constant - // throughout the life of the session. To obtain a session token, run the - // StartSession command. This SessionToken is required for every subsequent command - // that is issued during the current session. + // Specifies the session token for the current command. A session token is + // constant throughout the life of the session. To obtain a session token, run the + // StartSession command. This SessionToken is required for every subsequent + // command that is issued during the current session. SessionToken *string // Command to start a new session. A session token is obtained as part of the diff --git a/service/qldbsession/doc.go b/service/qldbsession/doc.go index f9bd5b879b1..e0bc10391ef 100644 --- a/service/qldbsession/doc.go +++ b/service/qldbsession/doc.go @@ -1,23 +1,19 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package qldbsession provides the API client, operations, and parameter types for -// Amazon QLDB Session. +// Package qldbsession provides the API client, operations, and parameter types +// for Amazon QLDB Session. // -// The transactional data APIs for Amazon QLDB Instead of interacting directly with -// this API, we recommend using the QLDB driver or the QLDB shell to execute data -// transactions on a ledger. -// -// * If you are working with an AWS SDK, use the QLDB -// driver. The driver provides a high-level abstraction layer above this QLDB -// Session data plane and manages SendCommand API calls for you. For information -// and a list of supported programming languages, see Getting started with the -// driver -// (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) -// in the Amazon QLDB Developer Guide. -// -// * If you are working with the AWS Command -// Line Interface (AWS CLI), use the QLDB shell. The shell is a command line -// interface that uses the QLDB driver to interact with a ledger. For information, -// see Accessing Amazon QLDB using the QLDB shell -// (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). +// The transactional data APIs for Amazon QLDB Instead of interacting directly +// with this API, we recommend using the QLDB driver or the QLDB shell to execute +// data transactions on a ledger. +// - If you are working with an AWS SDK, use the QLDB driver. The driver +// provides a high-level abstraction layer above this QLDB Session data plane and +// manages SendCommand API calls for you. For information and a list of supported +// programming languages, see Getting started with the driver (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) +// in the Amazon QLDB Developer Guide. +// - If you are working with the AWS Command Line Interface (AWS CLI), use the +// QLDB shell. The shell is a command line interface that uses the QLDB driver to +// interact with a ledger. For information, see Accessing Amazon QLDB using the +// QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html) +// . package qldbsession diff --git a/service/qldbsession/types/errors.go b/service/qldbsession/types/errors.go index 93287376524..98e1beef35e 100644 --- a/service/qldbsession/types/errors.go +++ b/service/qldbsession/types/errors.go @@ -116,8 +116,8 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Returned when a transaction cannot be written to the journal due to a failure in -// the verification phase of optimistic concurrency control (OCC). +// Returned when a transaction cannot be written to the journal due to a failure +// in the verification phase of optimistic concurrency control (OCC). type OccConflictException struct { Message *string diff --git a/service/qldbsession/types/types.go b/service/qldbsession/types/types.go index 98d1e839f71..41e49211bc5 100644 --- a/service/qldbsession/types/types.go +++ b/service/qldbsession/types/types.go @@ -204,9 +204,9 @@ type StartTransactionResult struct { noSmithyDocumentSerde } -// Contains server-side performance information for a command. Amazon QLDB captures -// timing information between the times when it receives the request and when it -// sends the corresponding response. +// Contains server-side performance information for a command. Amazon QLDB +// captures timing information between the times when it receives the request and +// when it sends the corresponding response. type TimingInformation struct { // The amount of time that QLDB spent on processing the command, measured in diff --git a/service/quicksight/api_client.go b/service/quicksight/api_client.go index 4bb80ab0cd1..dfce2817ff3 100644 --- a/service/quicksight/api_client.go +++ b/service/quicksight/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/quicksight/api_op_CreateAccountCustomization.go b/service/quicksight/api_op_CreateAccountCustomization.go index 1282e5016f1..f8595c8aaa3 100644 --- a/service/quicksight/api_op_CreateAccountCustomization.go +++ b/service/quicksight/api_op_CreateAccountCustomization.go @@ -15,22 +15,19 @@ import ( // Region. Currently, you can add a custom default theme by using the // CreateAccountCustomization or UpdateAccountCustomization API operation. To // further customize Amazon QuickSight by removing Amazon QuickSight sample assets -// and videos for all new users, see Customizing Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) +// and videos for all new users, see Customizing Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) // in the Amazon QuickSight User Guide. You can create customizations for your // Amazon Web Services account or, if you specify a namespace, for a QuickSight // namespace instead. Customizations that apply to a namespace always override // customizations that apply to an Amazon Web Services account. To find out which -// customizations apply, use the DescribeAccountCustomization API operation. Before -// you use the CreateAccountCustomization API operation to add a theme as the -// namespace default, make sure that you first share the theme with the namespace. -// If you don't share it with the namespace, the theme isn't visible to your users -// even if you make it the default theme. To check if the theme is shared, view the -// current permissions by using the DescribeThemePermissions -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html) +// customizations apply, use the DescribeAccountCustomization API operation. +// Before you use the CreateAccountCustomization API operation to add a theme as +// the namespace default, make sure that you first share the theme with the +// namespace. If you don't share it with the namespace, the theme isn't visible to +// your users even if you make it the default theme. To check if the theme is +// shared, view the current permissions by using the DescribeThemePermissions (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html) // API operation. To share the theme, grant permissions by using the -// UpdateThemePermissions -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) +// UpdateThemePermissions (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) // API operation. func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, optFns ...func(*Options)) (*CreateAccountCustomizationOutput, error) { if params == nil { @@ -53,10 +50,10 @@ type CreateAccountCustomizationInput struct { // Services Region. You can add these to an Amazon Web Services account and a // QuickSight namespace. For example, you can add a default theme by setting // AccountCustomization to the midnight theme: "AccountCustomization": { - // "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a + // "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" } . Or, you can add a // custom theme by specifying "AccountCustomization": { "DefaultTheme": // "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" - // }. + // } . // // This member is required. AccountCustomization *types.AccountCustomization diff --git a/service/quicksight/api_op_CreateAccountSubscription.go b/service/quicksight/api_op_CreateAccountSubscription.go index aaf1f181b88..cadbb6cfbd9 100644 --- a/service/quicksight/api_op_CreateAccountSubscription.go +++ b/service/quicksight/api_op_CreateAccountSubscription.go @@ -17,25 +17,21 @@ import ( // South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. Before you // use this operation, make sure that you can connect to an existing Amazon Web // Services account. If you don't have an Amazon Web Services account, see Sign up -// for Amazon Web Services -// (https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html) +// for Amazon Web Services (https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html) // in the Amazon QuickSight User Guide. The person who signs up for Amazon // QuickSight needs to have the correct Identity and Access Management (IAM) -// permissions. For more information, see IAM Policy Examples for Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html) in -// the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe -// and CreateAccountSubscription actions, make sure that both actions are set to -// Allow. If either action is set to Deny, the Deny action prevails and your API -// call fails. You can't pass an existing IAM role to access other Amazon Web -// Services services using this API operation. To pass your existing IAM role to -// Amazon QuickSight, see Passing IAM roles to Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role) +// permissions. For more information, see IAM Policy Examples for Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html) +// in the Amazon QuickSight User Guide. If your IAM policy includes both the +// Subscribe and CreateAccountSubscription actions, make sure that both actions +// are set to Allow . If either action is set to Deny , the Deny action prevails +// and your API call fails. You can't pass an existing IAM role to access other +// Amazon Web Services services using this API operation. To pass your existing IAM +// role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role) // in the Amazon QuickSight User Guide. You can't set default resource access on // the new account from the Amazon QuickSight API. Instead, add default resource // access from the Amazon QuickSight console. For more information about setting // default resource access to Amazon Web Services services, see Setting default -// resource access to Amazon Web Services services -// (https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html) +// resource access to Amazon Web Services services (https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html) // in the Amazon QuickSight User Guide. func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, optFns ...func(*Options)) (*CreateAccountSubscriptionOutput, error) { if params == nil { @@ -62,8 +58,8 @@ type CreateAccountSubscriptionInput struct { AccountName *string // The method that you want to use to authenticate your Amazon QuickSight account. - // Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, - // and ACTIVE_DIRECTORY. If you choose ACTIVE_DIRECTORY, provide an + // Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT , IAM_ONLY + // , and ACTIVE_DIRECTORY . If you choose ACTIVE_DIRECTORY , provide an // ActiveDirectoryName and an AdminGroup associated with your Active Directory. // // This member is required. @@ -76,17 +72,12 @@ type CreateAccountSubscriptionInput struct { AwsAccountId *string // The edition of Amazon QuickSight that you want your account to have. Currently, - // you can choose from ENTERPRISE or ENTERPRISE_AND_Q. If you choose - // ENTERPRISE_AND_Q, the following parameters are required: - // - // * FirstName - // - // * - // LastName - // - // * EmailAddress - // - // * ContactNumber + // you can choose from ENTERPRISE or ENTERPRISE_AND_Q . If you choose + // ENTERPRISE_AND_Q , the following parameters are required: + // - FirstName + // - LastName + // - EmailAddress + // - ContactNumber // // This member is required. Edition types.Edition @@ -97,22 +88,20 @@ type CreateAccountSubscriptionInput struct { // This member is required. NotificationEmail *string - // The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is - // the selected authentication method of the new Amazon QuickSight account. + // The name of your Active Directory. This field is required if ACTIVE_DIRECTORY + // is the selected authentication method of the new Amazon QuickSight account. ActiveDirectoryName *string - // The admin group associated with your Active Directory. This field is required if - // ACTIVE_DIRECTORY is the selected authentication method of the new Amazon + // The admin group associated with your Active Directory. This field is required + // if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon // QuickSight account. For more information about using Active Directory in Amazon - // QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition - // (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) + // QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) // in the Amazon QuickSight User Guide. AdminGroup []string // The author group associated with your Active Directory. For more information // about using Active Directory in Amazon QuickSight, see Using Active Directory - // with Amazon QuickSight Enterprise Edition - // (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) + // with Amazon QuickSight Enterprise Edition (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) // in the Amazon QuickSight User Guide. AuthorGroup []string @@ -142,13 +131,12 @@ type CreateAccountSubscriptionInput struct { // The reader group associated with your Active Direcrtory. For more information // about using Active Directory in Amazon QuickSight, see Using Active Directory - // with Amazon QuickSight Enterprise Edition - // (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) + // with Amazon QuickSight Enterprise Edition (https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html) // in the Amazon QuickSight User Guide. ReaderGroup []string - // The realm of the Active Directory that is associated with your Amazon QuickSight - // account. This field is required if ACTIVE_DIRECTORY is the selected + // The realm of the Active Directory that is associated with your Amazon + // QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected // authentication method of the new Amazon QuickSight account. Realm *string diff --git a/service/quicksight/api_op_CreateAnalysis.go b/service/quicksight/api_op_CreateAnalysis.go index d2e47f9abb4..02df65ea933 100644 --- a/service/quicksight/api_op_CreateAnalysis.go +++ b/service/quicksight/api_op_CreateAnalysis.go @@ -12,7 +12,7 @@ import ( ) // Creates an analysis in Amazon QuickSight. Analyses can be created either from a -// template or from an AnalysisDefinition. +// template or from an AnalysisDefinition . func (c *Client) CreateAnalysis(ctx context.Context, params *CreateAnalysisInput, optFns ...func(*Options)) (*CreateAnalysisOutput, error) { if params == nil { params = &CreateAnalysisInput{} @@ -30,8 +30,8 @@ func (c *Client) CreateAnalysis(ctx context.Context, params *CreateAnalysisInput type CreateAnalysisInput struct { - // The ID for the analysis that you're creating. This ID displays in the URL of the - // analysis. + // The ID for the analysis that you're creating. This ID displays in the URL of + // the analysis. // // This member is required. AnalysisId *string @@ -41,15 +41,15 @@ type CreateAnalysisInput struct { // This member is required. AwsAccountId *string - // A descriptive name for the analysis that you're creating. This name displays for - // the analysis in the Amazon QuickSight console. + // A descriptive name for the analysis that you're creating. This name displays + // for the analysis in the Amazon QuickSight console. // // This member is required. Name *string - // The definition of an analysis. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must - // be provided in order for the request to be valid. + // The definition of an analysis. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition + // must be provided in order for the request to be valid. Definition *types.AnalysisDefinition // The parameter names and override values that you want to use. An analysis can @@ -60,7 +60,7 @@ type CreateAnalysisInput struct { // an analysis. You can use the Permissions structure to grant permissions by // providing a list of Identity and Access Management (IAM) action information for // each principal listed by Amazon Resource Name (ARN). To specify no permissions, - // omit Permissions. + // omit Permissions . Permissions []types.ResourcePermission // A source entity to use for the analysis that you're creating. This metadata diff --git a/service/quicksight/api_op_CreateDashboard.go b/service/quicksight/api_op_CreateDashboard.go index 7fdde79dd8d..047cf582e1a 100644 --- a/service/quicksight/api_op_CreateDashboard.go +++ b/service/quicksight/api_op_CreateDashboard.go @@ -12,8 +12,7 @@ import ( ) // Creates a dashboard from either a template or directly with a -// DashboardDefinition. To first create a template, see the CreateTemplate -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) +// DashboardDefinition . To first create a template, see the CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) // API operation. A dashboard is an entity in Amazon QuickSight that identifies // Amazon QuickSight reports, created from analyses. You can share Amazon // QuickSight dashboards. With the right permissions, you can create scheduled @@ -54,25 +53,20 @@ type CreateDashboardInput struct { Name *string // Options for publishing the dashboard when you create it: - // - // * AvailabilityStatus - // for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When - // this is set to DISABLED, Amazon QuickSight disables the left filter pane on the - // published dashboard, which can be used for ad hoc (one-time) filtering. This - // option is ENABLED by default. - // - // * AvailabilityStatus for ExportToCSVOption - This - // status can be either ENABLED or DISABLED. The visual option to export data to - // .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED - // by default. - // - // * VisibilityState for SheetControlsOption - This visibility state - // can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default. + // - AvailabilityStatus for AdHocFilteringOption - This status can be either + // ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight + // disables the left filter pane on the published dashboard, which can be used for + // ad hoc (one-time) filtering. This option is ENABLED by default. + // - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED + // or DISABLED . The visual option to export data to .CSV format isn't enabled + // when this is set to DISABLED . This option is ENABLED by default. + // - VisibilityState for SheetControlsOption - This visibility state can be + // either COLLAPSED or EXPANDED . This option is COLLAPSED by default. DashboardPublishOptions *types.DashboardPublishOptions - // The definition of a dashboard. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must - // be provided in order for the request to be valid. + // The definition of a dashboard. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition + // must be provided in order for the request to be valid. Definition *types.DashboardVersionDefinition // The parameters for the creation of the dashboard, which you want to use to @@ -86,18 +80,17 @@ type CreateDashboardInput struct { Permissions []types.ResourcePermission // The entity that you are using as a source when you create the dashboard. In - // SourceEntity, you specify the type of object you're using as source. You can + // SourceEntity , you specify the type of object you're using as source. You can // only create a dashboard from a template, so you use a SourceTemplate entity. If // you need to create a dashboard from an analysis, first convert the analysis to a - // template by using the CreateTemplate - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) - // API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the - // source template. The SourceTemplateARN can contain any Amazon Web Services + // template by using the CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) + // API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of + // the source template. The SourceTemplate ARN can contain any Amazon Web Services // account and any Amazon QuickSight-supported Amazon Web Services Region. Use the // DataSetReferences entity within SourceTemplate to list the replacement datasets // for the placeholders listed in the original. The schema in each dataset must - // match its placeholder. Either a SourceEntity or a Definition must be provided in - // order for the request to be valid. + // match its placeholder. Either a SourceEntity or a Definition must be provided + // in order for the request to be valid. SourceEntity *types.DashboardSourceEntity // Contains a map of the key-value pairs for the resource tag or tags assigned to @@ -133,8 +126,8 @@ type CreateDashboardOutput struct { // The HTTP status of the request. Status int32 - // The ARN of the dashboard, including the version number of the first version that - // is created. + // The ARN of the dashboard, including the version number of the first version + // that is created. VersionArn *string // Metadata pertaining to the operation's result. diff --git a/service/quicksight/api_op_CreateDataSet.go b/service/quicksight/api_op_CreateDataSet.go index 9a2cb6d3a18..14579154ce3 100644 --- a/service/quicksight/api_op_CreateDataSet.go +++ b/service/quicksight/api_op_CreateDataSet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a dataset. This operation doesn't support datasets that include uploaded -// files as a source. +// Creates a dataset. This operation doesn't support datasets that include +// uploaded files as a source. func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error) { if params == nil { params = &CreateDataSetInput{} @@ -60,8 +60,8 @@ type CreateDataSetInput struct { // Currently, only geospatial hierarchy is supported. ColumnGroups []types.ColumnGroup - // A set of one or more definitions of a ColumnLevelPermissionRule - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). + // A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html) + // . ColumnLevelPermissionRules []types.ColumnLevelPermissionRule // The usage configuration to apply to child datasets that reference this dataset @@ -97,12 +97,12 @@ type CreateDataSetOutput struct { // The Amazon Resource Name (ARN) of the dataset. Arn *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. DataSetId *string - // The ARN for the ingestion, which is triggered as a result of dataset creation if - // the import mode is SPICE. + // The ARN for the ingestion, which is triggered as a result of dataset creation + // if the import mode is SPICE. IngestionArn *string // The ID of the ingestion, which is triggered as a result of dataset creation if diff --git a/service/quicksight/api_op_CreateDataSource.go b/service/quicksight/api_op_CreateDataSource.go index 89adbd665bb..e040f9bfe43 100644 --- a/service/quicksight/api_op_CreateDataSource.go +++ b/service/quicksight/api_op_CreateDataSource.go @@ -46,7 +46,7 @@ type CreateDataSourceInput struct { Name *string // The type of the data source. To return a list of all data sources, use - // ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service. + // ListDataSources . Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service. // // This member is required. Type types.DataSourceType diff --git a/service/quicksight/api_op_CreateFolder.go b/service/quicksight/api_op_CreateFolder.go index dc565388cee..473514ee208 100644 --- a/service/quicksight/api_op_CreateFolder.go +++ b/service/quicksight/api_op_CreateFolder.go @@ -39,7 +39,7 @@ type CreateFolderInput struct { // This member is required. FolderId *string - // The type of folder. By default, folderType is SHARED. + // The type of folder. By default, folderType is SHARED . FolderType types.FolderType // The name of the folder. @@ -50,7 +50,7 @@ type CreateFolderInput struct { ParentFolderArn *string // A structure that describes the principals and the resource-level permissions of - // a folder. To specify no permissions, omit Permissions. + // a folder. To specify no permissions, omit Permissions . Permissions []types.ResourcePermission // Tags for the folder. diff --git a/service/quicksight/api_op_CreateFolderMembership.go b/service/quicksight/api_op_CreateFolderMembership.go index 1259615908b..4a62938267b 100644 --- a/service/quicksight/api_op_CreateFolderMembership.go +++ b/service/quicksight/api_op_CreateFolderMembership.go @@ -44,7 +44,7 @@ type CreateFolderMembershipInput struct { // This member is required. MemberId *string - // The type of the member, including DASHBOARD, ANALYSIS, and DATASET. + // The type of the member, including DASHBOARD , ANALYSIS , and DATASET . // // This member is required. MemberType types.MemberType diff --git a/service/quicksight/api_op_CreateIAMPolicyAssignment.go b/service/quicksight/api_op_CreateIAMPolicyAssignment.go index 486fc4c4469..f78b17b0e8a 100644 --- a/service/quicksight/api_op_CreateIAMPolicyAssignment.go +++ b/service/quicksight/api_op_CreateIAMPolicyAssignment.go @@ -40,22 +40,17 @@ type CreateIAMPolicyAssignmentInput struct { AssignmentName *string // The status of the assignment. Possible values are as follows: - // - // * ENABLED - - // Anything specified in this assignment is used when creating the data source. - // - // * - // DISABLED - This assignment isn't used when creating the data source. - // - // * DRAFT - - // This assignment is an unfinished draft and isn't used when creating the data - // source. + // - ENABLED - Anything specified in this assignment is used when creating the + // data source. + // - DISABLED - This assignment isn't used when creating the data source. + // - DRAFT - This assignment is an unfinished draft and isn't used when creating + // the data source. // // This member is required. AssignmentStatus types.AssignmentStatus - // The ID of the Amazon Web Services account where you want to assign an IAM policy - // to Amazon QuickSight users or groups. + // The ID of the Amazon Web Services account where you want to assign an IAM + // policy to Amazon QuickSight users or groups. // // This member is required. AwsAccountId *string @@ -86,16 +81,11 @@ type CreateIAMPolicyAssignmentOutput struct { AssignmentName *string // The status of the assignment. Possible values are as follows: - // - // * ENABLED - - // Anything specified in this assignment is used when creating the data source. - // - // * - // DISABLED - This assignment isn't used when creating the data source. - // - // * DRAFT - - // This assignment is an unfinished draft and isn't used when creating the data - // source. + // - ENABLED - Anything specified in this assignment is used when creating the + // data source. + // - DISABLED - This assignment isn't used when creating the data source. + // - DRAFT - This assignment is an unfinished draft and isn't used when creating + // the data source. AssignmentStatus types.AssignmentStatus // The Amazon QuickSight users, groups, or both that the IAM policy is assigned to. diff --git a/service/quicksight/api_op_CreateIngestion.go b/service/quicksight/api_op_CreateIngestion.go index ef679a19911..4e9c4ad20c4 100644 --- a/service/quicksight/api_op_CreateIngestion.go +++ b/service/quicksight/api_op_CreateIngestion.go @@ -11,14 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates and starts a new SPICE ingestion for a dataset. You can manually refresh -// datasets in an Enterprise edition account 32 times in a 24-hour period. You can -// manually refresh datasets in a Standard edition account 8 times in a 24-hour -// period. Each 24-hour period is measured starting 24 hours before the current -// date and time. Any ingestions operating on tagged datasets inherit the same tags -// automatically for use in access control. For an example, see How do I create an -// IAM policy to control access to Amazon EC2 resources using tags? -// (http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/) +// Creates and starts a new SPICE ingestion for a dataset. You can manually +// refresh datasets in an Enterprise edition account 32 times in a 24-hour period. +// You can manually refresh datasets in a Standard edition account 8 times in a +// 24-hour period. Each 24-hour period is measured starting 24 hours before the +// current date and time. Any ingestions operating on tagged datasets inherit the +// same tags automatically for use in access control. For an example, see How do I +// create an IAM policy to control access to Amazon EC2 resources using tags? (http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/) // in the Amazon Web Services Knowledge Center. Tags are visible on the tagged // dataset, but not on the ingestion resource. func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error) { diff --git a/service/quicksight/api_op_CreateNamespace.go b/service/quicksight/api_op_CreateNamespace.go index 92f5b406578..daa30981a4f 100644 --- a/service/quicksight/api_op_CreateNamespace.go +++ b/service/quicksight/api_op_CreateNamespace.go @@ -44,7 +44,7 @@ type CreateNamespaceInput struct { AwsAccountId *string // Specifies the type of your user identity directory. Currently, this supports - // users with an identity type of QUICKSIGHT. + // users with an identity type of QUICKSIGHT . // // This member is required. IdentityStore types.IdentityStore @@ -65,19 +65,19 @@ type CreateNamespaceOutput struct { // The ARN of the Amazon QuickSight namespace you created. Arn *string - // The Amazon Web Services Region; that you want to use for the free SPICE capacity - // for the new namespace. This is set to the region that you run CreateNamespace - // in. + // The Amazon Web Services Region; that you want to use for the free SPICE + // capacity for the new namespace. This is set to the region that you run + // CreateNamespace in. CapacityRegion *string // The status of the creation of the namespace. This is an asynchronous process. A - // status of CREATED means that your namespace is ready to use. If an error occurs, - // it indicates if the process is retryable or non-retryable. In the case of a - // non-retryable error, refer to the error message for follow-up tasks. + // status of CREATED means that your namespace is ready to use. If an error + // occurs, it indicates if the process is retryable or non-retryable . In the case + // of a non-retryable error, refer to the error message for follow-up tasks. CreationStatus types.NamespaceStatus // Specifies the type of your user identity directory. Currently, this supports - // users with an identity type of QUICKSIGHT. + // users with an identity type of QUICKSIGHT . IdentityStore types.IdentityStore // The name of the new namespace that you created. diff --git a/service/quicksight/api_op_CreateTemplate.go b/service/quicksight/api_op_CreateTemplate.go index 9f4165749da..62b9cd5e320 100644 --- a/service/quicksight/api_op_CreateTemplate.go +++ b/service/quicksight/api_op_CreateTemplate.go @@ -62,12 +62,12 @@ type CreateTemplateInput struct { Permissions []types.ResourcePermission // The entity that you are using as a source when you create the template. In - // SourceEntity, you specify the type of object you're using as source: + // SourceEntity , you specify the type of object you're using as source: // SourceTemplate for a template or SourceAnalysis for an analysis. Both of these - // require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of - // the source template. For SourceAnalysis, specify the ARN of the source analysis. - // The SourceTemplate ARN can contain any Amazon Web Services account and any - // Amazon QuickSight-supported Amazon Web Services Region. Use the + // require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of + // the source template. For SourceAnalysis , specify the ARN of the source + // analysis. The SourceTemplate ARN can contain any Amazon Web Services account + // and any Amazon QuickSight-supported Amazon Web Services Region. Use the // DataSetReferences entity within SourceTemplate or SourceAnalysis to list the // replacement datasets for the placeholders listed in the original. The schema in // each dataset must match its placeholder. Either a SourceEntity or a Definition diff --git a/service/quicksight/api_op_CreateTemplateAlias.go b/service/quicksight/api_op_CreateTemplateAlias.go index 8989504cc20..490e6f42e21 100644 --- a/service/quicksight/api_op_CreateTemplateAlias.go +++ b/service/quicksight/api_op_CreateTemplateAlias.go @@ -29,9 +29,9 @@ func (c *Client) CreateTemplateAlias(ctx context.Context, params *CreateTemplate type CreateTemplateAliasInput struct { - // The name that you want to give to the template alias that you're creating. Don't - // start the alias name with the $ character. Alias names that start with $ are - // reserved by Amazon QuickSight. + // The name that you want to give to the template alias that you're creating. + // Don't start the alias name with the $ character. Alias names that start with $ + // are reserved by Amazon QuickSight. // // This member is required. AliasName *string diff --git a/service/quicksight/api_op_CreateTheme.go b/service/quicksight/api_op_CreateTheme.go index 746eee38c81..864c9dbe1dd 100644 --- a/service/quicksight/api_op_CreateTheme.go +++ b/service/quicksight/api_op_CreateTheme.go @@ -13,8 +13,7 @@ import ( // Creates a theme. A theme is set of configuration options for color and layout. // Themes apply to analyses and dashboards. For more information, see Using Themes -// in Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) +// in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) // in the Amazon QuickSight User Guide. func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error) { if params == nil { @@ -68,9 +67,9 @@ type CreateThemeInput struct { // to the resource. Tags []types.Tag - // A description of the first version of the theme that you're creating. Every time - // UpdateTheme is called, a new version is created. Each version of the theme has a - // description of the version in the VersionDescription field. + // A description of the first version of the theme that you're creating. Every + // time UpdateTheme is called, a new version is created. Each version of the theme + // has a description of the version in the VersionDescription field. VersionDescription *string noSmithyDocumentSerde diff --git a/service/quicksight/api_op_CreateThemeAlias.go b/service/quicksight/api_op_CreateThemeAlias.go index 40febb804b0..733da6921f1 100644 --- a/service/quicksight/api_op_CreateThemeAlias.go +++ b/service/quicksight/api_op_CreateThemeAlias.go @@ -30,7 +30,7 @@ func (c *Client) CreateThemeAlias(ctx context.Context, params *CreateThemeAliasI type CreateThemeAliasInput struct { // The name that you want to give to the theme alias that you are creating. The - // alias name can't begin with a $. Alias names that start with $ are reserved by + // alias name can't begin with a $ . Alias names that start with $ are reserved by // Amazon QuickSight. // // This member is required. diff --git a/service/quicksight/api_op_DeleteAccountSubscription.go b/service/quicksight/api_op_DeleteAccountSubscription.go index a3b90e51b21..3ed5b3f3c82 100644 --- a/service/quicksight/api_op_DeleteAccountSubscription.go +++ b/service/quicksight/api_op_DeleteAccountSubscription.go @@ -12,10 +12,10 @@ import ( // Use the DeleteAccountSubscription operation to delete an Amazon QuickSight // account. This operation will result in an error message if you have configured -// your account termination protection settings to True. To change this setting and -// delete your account, call the UpdateAccountSettings API and set the value of the -// TerminationProtectionEnabled parameter to False, then make another call to the -// DeleteAccountSubscription API. +// your account termination protection settings to True . To change this setting +// and delete your account, call the UpdateAccountSettings API and set the value +// of the TerminationProtectionEnabled parameter to False , then make another call +// to the DeleteAccountSubscription API. func (c *Client) DeleteAccountSubscription(ctx context.Context, params *DeleteAccountSubscriptionInput, optFns ...func(*Options)) (*DeleteAccountSubscriptionOutput, error) { if params == nil { params = &DeleteAccountSubscriptionInput{} diff --git a/service/quicksight/api_op_DeleteAnalysis.go b/service/quicksight/api_op_DeleteAnalysis.go index 95d55430fb2..5e9b758e830 100644 --- a/service/quicksight/api_op_DeleteAnalysis.go +++ b/service/quicksight/api_op_DeleteAnalysis.go @@ -50,13 +50,13 @@ type DeleteAnalysisInput struct { // This member is required. AwsAccountId *string - // This option defaults to the value NoForceDeleteWithoutRecovery. To immediately + // This option defaults to the value NoForceDeleteWithoutRecovery . To immediately // delete the analysis, add the ForceDeleteWithoutRecovery option. You can't // restore an analysis after it's deleted. ForceDeleteWithoutRecovery bool - // A value that specifies the number of days that Amazon QuickSight waits before it - // deletes the analysis. You can't use this parameter with the + // A value that specifies the number of days that Amazon QuickSight waits before + // it deletes the analysis. You can't use this parameter with the // ForceDeleteWithoutRecovery option in the same API call. The default value is 30. RecoveryWindowInDays *int64 diff --git a/service/quicksight/api_op_DeleteDashboard.go b/service/quicksight/api_op_DeleteDashboard.go index 1fbc38f27d2..1f36db7908b 100644 --- a/service/quicksight/api_op_DeleteDashboard.go +++ b/service/quicksight/api_op_DeleteDashboard.go @@ -39,8 +39,8 @@ type DeleteDashboardInput struct { // This member is required. DashboardId *string - // The version number of the dashboard. If the version number property is provided, - // only the specified version of the dashboard is deleted. + // The version number of the dashboard. If the version number property is + // provided, only the specified version of the dashboard is deleted. VersionNumber *int64 noSmithyDocumentSerde diff --git a/service/quicksight/api_op_DeleteDataSet.go b/service/quicksight/api_op_DeleteDataSet.go index 15c1fdf13c9..9c559518962 100644 --- a/service/quicksight/api_op_DeleteDataSet.go +++ b/service/quicksight/api_op_DeleteDataSet.go @@ -33,8 +33,8 @@ type DeleteDataSetInput struct { // This member is required. AwsAccountId *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. // // This member is required. DataSetId *string @@ -47,8 +47,8 @@ type DeleteDataSetOutput struct { // The Amazon Resource Name (ARN) of the dataset. Arn *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. DataSetId *string // The Amazon Web Services request ID for this operation. diff --git a/service/quicksight/api_op_DeleteDataSource.go b/service/quicksight/api_op_DeleteDataSource.go index 276880c82af..664a08ff3f6 100644 --- a/service/quicksight/api_op_DeleteDataSource.go +++ b/service/quicksight/api_op_DeleteDataSource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the data source permanently. This operation breaks all the datasets that -// reference the deleted data source. +// Deletes the data source permanently. This operation breaks all the datasets +// that reference the deleted data source. func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error) { if params == nil { params = &DeleteDataSourceInput{} diff --git a/service/quicksight/api_op_DeleteFolderMembership.go b/service/quicksight/api_op_DeleteFolderMembership.go index ba7edcdb1a7..6c76b0e85e7 100644 --- a/service/quicksight/api_op_DeleteFolderMembership.go +++ b/service/quicksight/api_op_DeleteFolderMembership.go @@ -45,7 +45,7 @@ type DeleteFolderMembershipInput struct { // This member is required. MemberId *string - // The type of the member, including DASHBOARD, ANALYSIS, and DATASET + // The type of the member, including DASHBOARD , ANALYSIS , and DATASET // // This member is required. MemberType types.MemberType diff --git a/service/quicksight/api_op_DeleteTemplate.go b/service/quicksight/api_op_DeleteTemplate.go index 9a9d463cfc5..e31fe80e952 100644 --- a/service/quicksight/api_op_DeleteTemplate.go +++ b/service/quicksight/api_op_DeleteTemplate.go @@ -28,8 +28,8 @@ func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput type DeleteTemplateInput struct { - // The ID of the Amazon Web Services account that contains the template that you're - // deleting. + // The ID of the Amazon Web Services account that contains the template that + // you're deleting. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_DeleteUser.go b/service/quicksight/api_op_DeleteUser.go index 314e37081a9..7d1a28973c0 100644 --- a/service/quicksight/api_op_DeleteUser.go +++ b/service/quicksight/api_op_DeleteUser.go @@ -37,7 +37,7 @@ type DeleteUserInput struct { // This member is required. AwsAccountId *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string diff --git a/service/quicksight/api_op_DeleteUserByPrincipalId.go b/service/quicksight/api_op_DeleteUserByPrincipalId.go index 3e025687a5b..e8f51bda4fd 100644 --- a/service/quicksight/api_op_DeleteUserByPrincipalId.go +++ b/service/quicksight/api_op_DeleteUserByPrincipalId.go @@ -35,7 +35,7 @@ type DeleteUserByPrincipalIdInput struct { // This member is required. AwsAccountId *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string diff --git a/service/quicksight/api_op_DescribeAccountCustomization.go b/service/quicksight/api_op_DescribeAccountCustomization.go index 2e57cf33ebe..9aada3bf3ed 100644 --- a/service/quicksight/api_op_DescribeAccountCustomization.go +++ b/service/quicksight/api_op_DescribeAccountCustomization.go @@ -17,53 +17,41 @@ import ( // this API operation with the Resolved flag included. To determine what // customizations display when you run this command, it can help to visualize the // relationship of the entities involved. -// -// * Amazon Web Services account - The -// Amazon Web Services account exists at the top of the hierarchy. It has the -// potential to use all of the Amazon Web Services Regions and Amazon Web Services -// Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web -// Services Region to use as your home Region. That's where your free SPICE -// capacity is located. You can use Amazon QuickSight in any supported Amazon Web -// Services Region. -// -// * Amazon Web Services Region - In each Amazon Web Services -// Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight -// acts as a separate instance of the same service. If you have a user directory, -// it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, -// these users have access to Amazon QuickSight in any Amazon Web Services Region, -// unless they are constrained to a namespace. To run the command in a different -// Amazon Web Services Region, you change your Region settings. If you're using the -// CLI, you can use one of the following options: -// -// * Use command line options -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html). -// -// * -// Use named profiles -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). -// -// * -// Run aws configure to change your default Amazon Web Services Region. Use Enter -// to key the same settings for your keys. For more information, see Configuring -// the CLI -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). -// -// * -// Namespace - A QuickSight namespace is a partition that contains users and assets -// (data sources, datasets, dashboards, and so on). To access assets that are in a -// specific namespace, users and groups must also be part of the same namespace. -// People who share a namespace are completely isolated from users and assets in -// other namespaces, even if they are in the same Amazon Web Services account and -// Amazon Web Services Region. -// -// * Applied customizations - Within an Amazon Web -// Services Region, a set of Amazon QuickSight customizations can apply to an -// Amazon Web Services account or to a namespace. Settings that you apply to a -// namespace override settings that you apply to an Amazon Web Services account. -// All settings are isolated to a single Amazon Web Services Region. To apply them -// in other Amazon Web Services Regions, run the CreateAccountCustomization command -// in each Amazon Web Services Region where you want to apply the same -// customizations. +// - Amazon Web Services account - The Amazon Web Services account exists at the +// top of the hierarchy. It has the potential to use all of the Amazon Web Services +// Regions and Amazon Web Services Services. When you subscribe to Amazon +// QuickSight, you choose one Amazon Web Services Region to use as your home +// Region. That's where your free SPICE capacity is located. You can use Amazon +// QuickSight in any supported Amazon Web Services Region. +// - Amazon Web Services Region - In each Amazon Web Services Region where you +// sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate +// instance of the same service. If you have a user directory, it resides in +// us-east-1, which is the US East (N. Virginia). Generally speaking, these users +// have access to Amazon QuickSight in any Amazon Web Services Region, unless they +// are constrained to a namespace. To run the command in a different Amazon Web +// Services Region, you change your Region settings. If you're using the CLI, you +// can use one of the following options: +// - Use command line options (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html) +// . +// - Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) +// . +// - Run aws configure to change your default Amazon Web Services Region. Use +// Enter to key the same settings for your keys. For more information, see +// Configuring the CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) +// . +// - Namespace - A QuickSight namespace is a partition that contains users and +// assets (data sources, datasets, dashboards, and so on). To access assets that +// are in a specific namespace, users and groups must also be part of the same +// namespace. People who share a namespace are completely isolated from users and +// assets in other namespaces, even if they are in the same Amazon Web Services +// account and Amazon Web Services Region. +// - Applied customizations - Within an Amazon Web Services Region, a set of +// Amazon QuickSight customizations can apply to an Amazon Web Services account or +// to a namespace. Settings that you apply to a namespace override settings that +// you apply to an Amazon Web Services account. All settings are isolated to a +// single Amazon Web Services Region. To apply them in other Amazon Web Services +// Regions, run the CreateAccountCustomization command in each Amazon Web +// Services Region where you want to apply the same customizations. func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error) { if params == nil { params = &DescribeAccountCustomizationInput{} @@ -94,8 +82,8 @@ type DescribeAccountCustomizationInput struct { // The Resolved flag works with the other parameters to determine which view of // Amazon QuickSight customizations is returned. You can add this flag to your // command to use the same view that Amazon QuickSight uses to identify which - // customizations to apply to the console. Omit this flag, or set it to - // no-resolved, to reveal customizations that are configured at different levels. + // customizations to apply to the console. Omit this flag, or set it to no-resolved + // , to reveal customizations that are configured at different levels. Resolved bool noSmithyDocumentSerde diff --git a/service/quicksight/api_op_DescribeAccountSubscription.go b/service/quicksight/api_op_DescribeAccountSubscription.go index 76c884ae8c4..96490dd68ec 100644 --- a/service/quicksight/api_op_DescribeAccountSubscription.go +++ b/service/quicksight/api_op_DescribeAccountSubscription.go @@ -44,20 +44,12 @@ type DescribeAccountSubscriptionInput struct { type DescribeAccountSubscriptionOutput struct { // A structure that contains the following elements: - // - // * Your Amazon QuickSight - // account name. - // - // * The edition of Amazon QuickSight that your account is using. - // - // * - // The notification email address that is associated with the Amazon QuickSight - // account. - // - // * The authentication type of the Amazon QuickSight account. - // - // * The - // status of the Amazon QuickSight account's subscription. + // - Your Amazon QuickSight account name. + // - The edition of Amazon QuickSight that your account is using. + // - The notification email address that is associated with the Amazon + // QuickSight account. + // - The authentication type of the Amazon QuickSight account. + // - The status of the Amazon QuickSight account's subscription. AccountInfo *types.AccountInfo // The Amazon Web Services request ID for this operation. diff --git a/service/quicksight/api_op_DescribeAnalysisDefinition.go b/service/quicksight/api_op_DescribeAnalysisDefinition.go index 54d9d3721e0..3e3d0ac4392 100644 --- a/service/quicksight/api_op_DescribeAnalysisDefinition.go +++ b/service/quicksight/api_op_DescribeAnalysisDefinition.go @@ -14,8 +14,7 @@ import ( // Provides a detailed description of the definition of an analysis. If you do not // need to know details about the content of an Analysis, for instance if you are // trying to check the status of a recently created or updated Analysis, use the -// DescribeAnalysis -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html) +// DescribeAnalysis (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html) // instead. func (c *Client) DescribeAnalysisDefinition(ctx context.Context, params *DescribeAnalysisDefinitionInput, optFns ...func(*Options)) (*DescribeAnalysisDefinitionOutput, error) { if params == nil { @@ -54,8 +53,8 @@ type DescribeAnalysisDefinitionOutput struct { // The ID of the analysis described. AnalysisId *string - // The definition of an analysis. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. + // The definition of an analysis. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Definition *types.AnalysisDefinition // Errors associated with the analysis. @@ -68,22 +67,13 @@ type DescribeAnalysisDefinitionOutput struct { RequestId *string // Status associated with the analysis. - // - // * CREATION_IN_PROGRESS - // - // * - // CREATION_SUCCESSFUL - // - // * CREATION_FAILED - // - // * UPDATE_IN_PROGRESS - // - // * - // UPDATE_SUCCESSFUL - // - // * UPDATE_FAILED - // - // * DELETED + // - CREATION_IN_PROGRESS + // - CREATION_SUCCESSFUL + // - CREATION_FAILED + // - UPDATE_IN_PROGRESS + // - UPDATE_SUCCESSFUL + // - UPDATE_FAILED + // - DELETED ResourceStatus types.ResourceStatus // The HTTP status of the request. diff --git a/service/quicksight/api_op_DescribeDashboardDefinition.go b/service/quicksight/api_op_DescribeDashboardDefinition.go index 6eddb0b582b..59112aa5b6f 100644 --- a/service/quicksight/api_op_DescribeDashboardDefinition.go +++ b/service/quicksight/api_op_DescribeDashboardDefinition.go @@ -14,8 +14,7 @@ import ( // Provides a detailed description of the definition of a dashboard. If you do not // need to know details about the content of a dashboard, for instance if you are // trying to check the status of a recently created or updated dashboard, use the -// DescribeDashboard -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html) +// DescribeDashboard (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html) // instead. func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, optFns ...func(*Options)) (*DescribeDashboardDefinitionOutput, error) { if params == nil { @@ -61,24 +60,19 @@ type DescribeDashboardDefinitionOutput struct { DashboardId *string // Options for publishing the dashboard: - // - // * AvailabilityStatus for - // AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this - // is set to DISABLED, Amazon QuickSight disables the left filter pane on the - // published dashboard, which can be used for ad hoc (one-time) filtering. This - // option is ENABLED by default. - // - // * AvailabilityStatus for ExportToCSVOption - This - // status can be either ENABLED or DISABLED. The visual option to export data to - // .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED - // by default. - // - // * VisibilityState for SheetControlsOption - This visibility state - // can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default. + // - AvailabilityStatus for AdHocFilteringOption - This status can be either + // ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight + // disables the left filter pane on the published dashboard, which can be used for + // ad hoc (one-time) filtering. This option is ENABLED by default. + // - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED + // or DISABLED . The visual option to export data to .CSV format isn't enabled + // when this is set to DISABLED . This option is ENABLED by default. + // - VisibilityState for SheetControlsOption - This visibility state can be + // either COLLAPSED or EXPANDED . This option is COLLAPSED by default. DashboardPublishOptions *types.DashboardPublishOptions - // The definition of a dashboard. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. + // The definition of a dashboard. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Definition *types.DashboardVersionDefinition // Errors associated with this dashboard version. @@ -91,22 +85,13 @@ type DescribeDashboardDefinitionOutput struct { RequestId *string // Status associated with the dashboard version. - // - // * CREATION_IN_PROGRESS - // - // * - // CREATION_SUCCESSFUL - // - // * CREATION_FAILED - // - // * UPDATE_IN_PROGRESS - // - // * - // UPDATE_SUCCESSFUL - // - // * UPDATE_FAILED - // - // * DELETED + // - CREATION_IN_PROGRESS + // - CREATION_SUCCESSFUL + // - CREATION_FAILED + // - UPDATE_IN_PROGRESS + // - UPDATE_SUCCESSFUL + // - UPDATE_FAILED + // - DELETED ResourceStatus types.ResourceStatus // The HTTP status of the request. diff --git a/service/quicksight/api_op_DescribeDashboardPermissions.go b/service/quicksight/api_op_DescribeDashboardPermissions.go index fb138e3f483..6fa6c509a2e 100644 --- a/service/quicksight/api_op_DescribeDashboardPermissions.go +++ b/service/quicksight/api_op_DescribeDashboardPermissions.go @@ -54,8 +54,8 @@ type DescribeDashboardPermissionsOutput struct { // A structure that contains the configuration of a shareable link that grants // access to the dashboard. Your users can use the link to view and interact with // the dashboard, if the dashboard has been shared with them. For more information - // about sharing dashboards, see Sharing Dashboards - // (https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html). + // about sharing dashboards, see Sharing Dashboards (https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html) + // . LinkSharingConfiguration *types.LinkSharingConfiguration // A structure that contains the permissions for the dashboard. diff --git a/service/quicksight/api_op_DescribeDataSet.go b/service/quicksight/api_op_DescribeDataSet.go index 409626a85d5..50741a570a3 100644 --- a/service/quicksight/api_op_DescribeDataSet.go +++ b/service/quicksight/api_op_DescribeDataSet.go @@ -35,8 +35,8 @@ type DescribeDataSetInput struct { // This member is required. AwsAccountId *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. // // This member is required. DataSetId *string diff --git a/service/quicksight/api_op_DescribeDataSetPermissions.go b/service/quicksight/api_op_DescribeDataSetPermissions.go index 11a0f8106b7..d3d60f35ae6 100644 --- a/service/quicksight/api_op_DescribeDataSetPermissions.go +++ b/service/quicksight/api_op_DescribeDataSetPermissions.go @@ -12,7 +12,7 @@ import ( ) // Describes the permissions on a dataset. The permissions resource is -// arn:aws:quicksight:region:aws-account-id:dataset/data-set-id. +// arn:aws:quicksight:region:aws-account-id:dataset/data-set-id . func (c *Client) DescribeDataSetPermissions(ctx context.Context, params *DescribeDataSetPermissionsInput, optFns ...func(*Options)) (*DescribeDataSetPermissionsOutput, error) { if params == nil { params = &DescribeDataSetPermissionsInput{} @@ -35,8 +35,8 @@ type DescribeDataSetPermissionsInput struct { // This member is required. AwsAccountId *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. // // This member is required. DataSetId *string @@ -49,8 +49,8 @@ type DescribeDataSetPermissionsOutput struct { // The Amazon Resource Name (ARN) of the dataset. DataSetArn *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. DataSetId *string // A list of resource permissions on the dataset. diff --git a/service/quicksight/api_op_DescribeTemplate.go b/service/quicksight/api_op_DescribeTemplate.go index 9585a790c34..819f3a562de 100644 --- a/service/quicksight/api_op_DescribeTemplate.go +++ b/service/quicksight/api_op_DescribeTemplate.go @@ -29,8 +29,8 @@ func (c *Client) DescribeTemplate(ctx context.Context, params *DescribeTemplateI type DescribeTemplateInput struct { - // The ID of the Amazon Web Services account that contains the template that you're - // describing. + // The ID of the Amazon Web Services account that contains the template that + // you're describing. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_DescribeTemplateAlias.go b/service/quicksight/api_op_DescribeTemplateAlias.go index dece3c3dd2c..2130e719163 100644 --- a/service/quicksight/api_op_DescribeTemplateAlias.go +++ b/service/quicksight/api_op_DescribeTemplateAlias.go @@ -29,10 +29,10 @@ func (c *Client) DescribeTemplateAlias(ctx context.Context, params *DescribeTemp type DescribeTemplateAliasInput struct { - // The name of the template alias that you want to describe. If you name a specific - // alias, you describe the version that the alias points to. You can specify the - // latest version of the template by providing the keyword $LATEST in the AliasName - // parameter. The keyword $PUBLISHED doesn't apply to templates. + // The name of the template alias that you want to describe. If you name a + // specific alias, you describe the version that the alias points to. You can + // specify the latest version of the template by providing the keyword $LATEST in + // the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates. // // This member is required. AliasName *string diff --git a/service/quicksight/api_op_DescribeTemplateDefinition.go b/service/quicksight/api_op_DescribeTemplateDefinition.go index c390e57820a..e5401265259 100644 --- a/service/quicksight/api_op_DescribeTemplateDefinition.go +++ b/service/quicksight/api_op_DescribeTemplateDefinition.go @@ -14,8 +14,7 @@ import ( // Provides a detailed description of the definition of a template. If you do not // need to know details about the content of a template, for instance if you are // trying to check the status of a recently created or updated template, use the -// DescribeTemplate -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html) +// DescribeTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html) // instead. func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, optFns ...func(*Options)) (*DescribeTemplateDefinitionOutput, error) { if params == nil { @@ -73,22 +72,13 @@ type DescribeTemplateDefinitionOutput struct { RequestId *string // Status associated with the template. - // - // * CREATION_IN_PROGRESS - // - // * - // CREATION_SUCCESSFUL - // - // * CREATION_FAILED - // - // * UPDATE_IN_PROGRESS - // - // * - // UPDATE_SUCCESSFUL - // - // * UPDATE_FAILED - // - // * DELETED + // - CREATION_IN_PROGRESS + // - CREATION_SUCCESSFUL + // - CREATION_FAILED + // - UPDATE_IN_PROGRESS + // - UPDATE_SUCCESSFUL + // - UPDATE_FAILED + // - DELETED ResourceStatus types.ResourceStatus // The HTTP status of the request. diff --git a/service/quicksight/api_op_DescribeTemplatePermissions.go b/service/quicksight/api_op_DescribeTemplatePermissions.go index a68de3b38d3..7f93d1e6c52 100644 --- a/service/quicksight/api_op_DescribeTemplatePermissions.go +++ b/service/quicksight/api_op_DescribeTemplatePermissions.go @@ -29,8 +29,8 @@ func (c *Client) DescribeTemplatePermissions(ctx context.Context, params *Descri type DescribeTemplatePermissionsInput struct { - // The ID of the Amazon Web Services account that contains the template that you're - // describing. + // The ID of the Amazon Web Services account that contains the template that + // you're describing. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_DescribeUser.go b/service/quicksight/api_op_DescribeUser.go index a8b1fa93918..64469785c88 100644 --- a/service/quicksight/api_op_DescribeUser.go +++ b/service/quicksight/api_op_DescribeUser.go @@ -36,7 +36,7 @@ type DescribeUserInput struct { // This member is required. AwsAccountId *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string diff --git a/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go b/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go index 5678b328f2b..0ae497e3d42 100644 --- a/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go +++ b/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go @@ -15,28 +15,20 @@ import ( // or visual in your website, without having to register any reader users. Before // you use this action, make sure that you have configured the dashboards and // permissions. The following rules apply to the generated URL: +// - It contains a temporary bearer token. It is valid for 5 minutes after it is +// generated. Once redeemed within this period, it cannot be re-used again. +// - The URL validity period should not be confused with the actual session +// lifetime that can be customized using the SessionLifetimeInMinutes (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes) +// parameter. The resulting user session is valid for 15 minutes (minimum) to 10 +// hours (maximum). The default session duration is 10 hours. +// - You are charged only when the URL is used or there is interaction with +// Amazon QuickSight. // -// * It contains a -// temporary bearer token. It is valid for 5 minutes after it is generated. Once -// redeemed within this period, it cannot be re-used again. -// -// * The URL validity -// period should not be confused with the actual session lifetime that can be -// customized using the SessionLifetimeInMinutes -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes) -// parameter. The resulting user session is valid for 15 minutes (minimum) to 10 -// hours (maximum). The default session duration is 10 hours. -// -// * You are charged -// only when the URL is used or there is interaction with Amazon QuickSight. -// -// For -// more information, see Embedded Analytics -// (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) in -// the Amazon QuickSight User Guide. For more information about the high-level +// For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) +// in the Amazon QuickSight User Guide. For more information about the high-level // steps for embedding and for an interactive demo of the ways you can customize -// embedding, visit the Amazon QuickSight Developer Portal -// (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). +// embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html) +// . func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *GenerateEmbedUrlForAnonymousUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForAnonymousUserOutput, error) { if params == nil { params = &GenerateEmbedUrlForAnonymousUserInput{} @@ -74,8 +66,8 @@ type GenerateEmbedUrlForAnonymousUserInput struct { // This member is required. ExperienceConfiguration *types.AnonymousUserEmbeddingExperienceConfiguration - // The Amazon QuickSight namespace that the anonymous user virtually belongs to. If - // you are not using an Amazon QuickSight custom namespace, set this to default. + // The Amazon QuickSight namespace that the anonymous user virtually belongs to. + // If you are not using an Amazon QuickSight custom namespace, set this to default . // // This member is required. Namespace *string @@ -85,8 +77,8 @@ type GenerateEmbedUrlForAnonymousUserInput struct { // that are configured in the Manage QuickSight menu in the Amazon QuickSight // console. Instead, it allows only the domains that you include in this parameter. // You can list up to three domains or subdomains in each API call. To include all - // subdomains under a specific domain to the allow list, use *. For example, - // https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com. + // subdomains under a specific domain to the allow list, use * . For example, + // https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com . AllowedDomains []string // How many minutes the session is valid. The session lifetime must be in [15-600] @@ -97,10 +89,9 @@ type GenerateEmbedUrlForAnonymousUserInput struct { // make sure that you have configured the relevant datasets using the // DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be // used to provide row-level security. These are not the tags used for the Amazon - // Web Services resource tagging feature. For more information, see Using Row-Level - // Security (RLS) with Tags - // (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html)in - // the Amazon QuickSight User Guide. + // Web Services resource tagging feature. For more information, see Using + // Row-Level Security (RLS) with Tags (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html) + // in the Amazon QuickSight User Guide. SessionTags []types.SessionTag noSmithyDocumentSerde diff --git a/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go b/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go index 348c75ef25c..42d7c1f0065 100644 --- a/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go +++ b/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go @@ -11,33 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates an embed URL that you can use to embed an Amazon QuickSight experience -// in your website. This action can be used for any type of user registered in an -// Amazon QuickSight account. Before you use this action, make sure that you have -// configured the relevant Amazon QuickSight resource and permissions. The -// following rules apply to the generated URL: +// Generates an embed URL that you can use to embed an Amazon QuickSight +// experience in your website. This action can be used for any type of user +// registered in an Amazon QuickSight account. Before you use this action, make +// sure that you have configured the relevant Amazon QuickSight resource and +// permissions. The following rules apply to the generated URL: +// - It contains a temporary bearer token. It is valid for 5 minutes after it is +// generated. Once redeemed within this period, it cannot be re-used again. +// - The URL validity period should not be confused with the actual session +// lifetime that can be customized using the SessionLifetimeInMinutes (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes) +// parameter. The resulting user session is valid for 15 minutes (minimum) to 10 +// hours (maximum). The default session duration is 10 hours. +// - You are charged only when the URL is used or there is interaction with +// Amazon QuickSight. // -// * It contains a temporary bearer -// token. It is valid for 5 minutes after it is generated. Once redeemed within -// this period, it cannot be re-used again. -// -// * The URL validity period should not -// be confused with the actual session lifetime that can be customized using the -// SessionLifetimeInMinutes -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes) -// parameter. The resulting user session is valid for 15 minutes (minimum) to 10 -// hours (maximum). The default session duration is 10 hours. -// -// * You are charged -// only when the URL is used or there is interaction with Amazon QuickSight. -// -// For -// more information, see Embedded Analytics -// (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) in -// the Amazon QuickSight User Guide. For more information about the high-level +// For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) +// in the Amazon QuickSight User Guide. For more information about the high-level // steps for embedding and for an interactive demo of the ways you can customize -// embedding, visit the Amazon QuickSight Developer Portal -// (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). +// embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html) +// . func (c *Client) GenerateEmbedUrlForRegisteredUser(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForRegisteredUserOutput, error) { if params == nil { params = &GenerateEmbedUrlForRegisteredUserInput{} @@ -78,8 +70,8 @@ type GenerateEmbedUrlForRegisteredUserInput struct { // that are configured in the Manage QuickSight menu in the Amazon QuickSight // console. Instead, it allows only the domains that you include in this parameter. // You can list up to three domains or subdomains in each API call. To include all - // subdomains under a specific domain to the allow list, use *. For example, - // https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com. + // subdomains under a specific domain to the allow list, use * . For example, + // https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com . AllowedDomains []string // How many minutes the session is valid. The session lifetime must be in [15-600] diff --git a/service/quicksight/api_op_GetDashboardEmbedUrl.go b/service/quicksight/api_op_GetDashboardEmbedUrl.go index e0b895818c7..4d983b98ee6 100644 --- a/service/quicksight/api_op_GetDashboardEmbedUrl.go +++ b/service/quicksight/api_op_GetDashboardEmbedUrl.go @@ -17,29 +17,20 @@ import ( // dashboards and permissions. Currently, you can use GetDashboardEmbedURL only // from the server, not from the user's browser. The following rules apply to the // generated URL: +// - They must be used together. +// - They can be used one time only. +// - They are valid for 5 minutes after you run this command. +// - You are charged only when the URL is used or there is interaction with +// Amazon QuickSight. +// - The resulting user session is valid for 15 minutes (default) up to 10 hours +// (maximum). You can use the optional SessionLifetimeInMinutes parameter to +// customize session duration. // -// * They must be used together. -// -// * They can be used one time -// only. -// -// * They are valid for 5 minutes after you run this command. -// -// * You are -// charged only when the URL is used or there is interaction with Amazon -// QuickSight. -// -// * The resulting user session is valid for 15 minutes (default) up -// to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes -// parameter to customize session duration. -// -// For more information, see Embedding -// Analytics Using GetDashboardEmbedUrl -// (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html) +// For more information, see Embedding Analytics Using GetDashboardEmbedUrl (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html) // in the Amazon QuickSight User Guide. For more information about the high-level // steps for embedding and for an interactive demo of the ways you can customize -// embedding, visit the Amazon QuickSight Developer Portal -// (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). +// embedding, visit the Amazon QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html) +// . func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error) { if params == nil { params = &GetDashboardEmbedUrlInput{} @@ -63,8 +54,8 @@ type GetDashboardEmbedUrlInput struct { // This member is required. AwsAccountId *string - // The ID for the dashboard, also added to the Identity and Access Management (IAM) - // policy. + // The ID for the dashboard, also added to the Identity and Access Management + // (IAM) policy. // // This member is required. DashboardId *string @@ -77,12 +68,12 @@ type GetDashboardEmbedUrlInput struct { // A list of one or more dashboard IDs that you want anonymous users to have // tempporary access to. Currently, the IdentityType parameter must be set to // ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM - // users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 - // dash_id3 identity-type ANONYMOUS", the session can access all three dashboards. + // users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 + // dash_id3 identity-type ANONYMOUS ", the session can access all three dashboards. AdditionalDashboardIds []string - // The Amazon QuickSight namespace that contains the dashboard IDs in this request. - // If you're not using a custom namespace, set Namespace = default. + // The Amazon QuickSight namespace that contains the dashboard IDs in this + // request. If you're not using a custom namespace, set Namespace = default . Namespace *string // Remove the reset button on the embedded dashboard. The default is FALSE, which @@ -96,10 +87,10 @@ type GetDashboardEmbedUrlInput struct { // Adds persistence of state for the user session in an embedded dashboard. // Persistence applies to the sheet and the parameter settings. These are control // settings that the dashboard subscriber (Amazon QuickSight reader) chooses while - // viewing the dashboard. If this is set to TRUE, the settings are the same when + // viewing the dashboard. If this is set to TRUE , the settings are the same when // the subscriber reopens the same dashboard URL. The state is stored in Amazon // QuickSight, not in a browser cookie. If this is set to FALSE, the state of the - // user session is not persisted. The default is FALSE. + // user session is not persisted. The default is FALSE . StatePersistenceEnabled bool // Remove the undo/redo button on the embedded dashboard. The default is FALSE, @@ -109,18 +100,12 @@ type GetDashboardEmbedUrlInput struct { // The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT // identity type. You can use this for any Amazon QuickSight users in your account // (readers, authors, or admins) authenticated as one of the following: - // - // * Active - // Directory (AD) users or group members - // - // * Invited nonfederated users - // - // * IAM users - // and IAM role-based sessions authenticated through Federated Single Sign-On using - // SAML, OpenID Connect, or IAM federation. - // - // Omit this parameter for users in the - // third group – IAM users and IAM role-based sessions. + // - Active Directory (AD) users or group members + // - Invited nonfederated users + // - IAM users and IAM role-based sessions authenticated through Federated + // Single Sign-On using SAML, OpenID Connect, or IAM federation. + // Omit this parameter for users in the third group – IAM users and IAM role-based + // sessions. UserArn *string noSmithyDocumentSerde diff --git a/service/quicksight/api_op_GetSessionEmbedUrl.go b/service/quicksight/api_op_GetSessionEmbedUrl.go index ebb68712319..8b524f75209 100644 --- a/service/quicksight/api_op_GetSessionEmbedUrl.go +++ b/service/quicksight/api_op_GetSessionEmbedUrl.go @@ -16,20 +16,13 @@ import ( // sources, datasets, analyses, and dashboards. The users who access an embedded // Amazon QuickSight console need belong to the author or admin security cohort. If // you want to restrict permissions to some of these features, add a custom -// permissions profile to the user with the UpdateUser -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) -// API operation. Use RegisterUser -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) +// permissions profile to the user with the UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) +// API operation. Use RegisterUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) // API operation to add a new user with a custom permission profile attached. For // more information, see the following sections in the Amazon QuickSight User // Guide: -// -// * Embedding Analytics -// (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) -// -// * -// Customizing Access to the Amazon QuickSight Console -// (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) +// - Embedding Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) +// - Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error) { if params == nil { params = &GetSessionEmbedUrlInput{} @@ -55,22 +48,14 @@ type GetSessionEmbedUrlInput struct { // The URL you use to access the embedded session. The entry point URL is // constrained to the following paths: - // - // * /start - // - // * /start/analyses - // - // * - // /start/dashboards - // - // * /start/favorites - // - // * /dashboards/DashboardId - where - // DashboardId is the actual ID key from the Amazon QuickSight console URL of the - // dashboard - // - // * /analyses/AnalysisId - where AnalysisId is the actual ID key from - // the Amazon QuickSight console URL of the analysis + // - /start + // - /start/analyses + // - /start/dashboards + // - /start/favorites + // - /dashboards/DashboardId - where DashboardId is the actual ID key from the + // Amazon QuickSight console URL of the dashboard + // - /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon + // QuickSight console URL of the analysis EntryPoint *string // How many minutes the session is valid. The session lifetime must be 15-600 @@ -81,18 +66,12 @@ type GetSessionEmbedUrlInput struct { // identity type. You can use this for any type of Amazon QuickSight users in your // account (readers, authors, or admins). They need to be authenticated as one of // the following: - // - // * Active Directory (AD) users or group members - // - // * Invited - // nonfederated users - // - // * IAM users and IAM role-based sessions authenticated - // through Federated Single Sign-On using SAML, OpenID Connect, or IAM - // federation - // - // Omit this parameter for users in the third group, IAM users and IAM - // role-based sessions. + // - Active Directory (AD) users or group members + // - Invited nonfederated users + // - IAM users and IAM role-based sessions authenticated through Federated + // Single Sign-On using SAML, OpenID Connect, or IAM federation + // Omit this parameter for users in the third group, IAM users and IAM role-based + // sessions. UserArn *string noSmithyDocumentSerde @@ -102,8 +81,8 @@ type GetSessionEmbedUrlOutput struct { // A single-use URL that you can put into your server-side web page to embed your // Amazon QuickSight session. This URL is valid for 5 minutes. The API operation - // provides the URL with an auth_code value that enables one (and only one) sign-on - // to a user session that is valid for 10 hours. + // provides the URL with an auth_code value that enables one (and only one) + // sign-on to a user session that is valid for 10 hours. EmbedUrl *string // The Amazon Web Services request ID for this operation. diff --git a/service/quicksight/api_op_ListAnalyses.go b/service/quicksight/api_op_ListAnalyses.go index fe400a3dad6..84cf2a4b5d4 100644 --- a/service/quicksight/api_op_ListAnalyses.go +++ b/service/quicksight/api_op_ListAnalyses.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services -// account. +// Lists Amazon QuickSight analyses that exist in the specified Amazon Web +// Services account. func (c *Client) ListAnalyses(ctx context.Context, params *ListAnalysesInput, optFns ...func(*Options)) (*ListAnalysesOutput, error) { if params == nil { params = &ListAnalysesInput{} diff --git a/service/quicksight/api_op_ListDataSets.go b/service/quicksight/api_op_ListDataSets.go index ea3a8f2ba1f..2a4275e4734 100644 --- a/service/quicksight/api_op_ListDataSets.go +++ b/service/quicksight/api_op_ListDataSets.go @@ -14,7 +14,7 @@ import ( // Lists all of the datasets belonging to the current Amazon Web Services account // in an Amazon Web Services Region. The permissions resource is -// arn:aws:quicksight:region:aws-account-id:dataset/*. +// arn:aws:quicksight:region:aws-account-id:dataset/* . func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error) { if params == nil { params = &ListDataSetsInput{} diff --git a/service/quicksight/api_op_ListFolderMembers.go b/service/quicksight/api_op_ListFolderMembers.go index 760e6cc2541..e51a8f4c7e6 100644 --- a/service/quicksight/api_op_ListFolderMembers.go +++ b/service/quicksight/api_op_ListFolderMembers.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder. +// List all assets ( DASHBOARD , ANALYSIS , and DATASET ) in a folder. func (c *Client) ListFolderMembers(ctx context.Context, params *ListFolderMembersInput, optFns ...func(*Options)) (*ListFolderMembersOutput, error) { if params == nil { params = &ListFolderMembersInput{} diff --git a/service/quicksight/api_op_ListFolders.go b/service/quicksight/api_op_ListFolders.go index e8e13742930..6ce6180d094 100644 --- a/service/quicksight/api_op_ListFolders.go +++ b/service/quicksight/api_op_ListFolders.go @@ -45,8 +45,8 @@ type ListFoldersInput struct { type ListFoldersOutput struct { - // A structure that contains all of the folders in the Amazon Web Services account. - // This structure provides basic information about the folders. + // A structure that contains all of the folders in the Amazon Web Services + // account. This structure provides basic information about the folders. FolderSummaryList []types.FolderSummary // The token for the next set of results, or null if there are no more results. diff --git a/service/quicksight/api_op_ListIAMPolicyAssignmentsForUser.go b/service/quicksight/api_op_ListIAMPolicyAssignmentsForUser.go index a7aaaf28bcd..44d86211ce4 100644 --- a/service/quicksight/api_op_ListIAMPolicyAssignmentsForUser.go +++ b/service/quicksight/api_op_ListIAMPolicyAssignmentsForUser.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) -// for the IAM policies assigned to the specified user and group or groups that the -// user belongs to. +// Lists all the IAM policy assignments, including the Amazon Resource Names +// (ARNs) for the IAM policies assigned to the specified user and group or groups +// that the user belongs to. func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error) { if params == nil { params = &ListIAMPolicyAssignmentsForUserInput{} diff --git a/service/quicksight/api_op_ListNamespaces.go b/service/quicksight/api_op_ListNamespaces.go index d39a1bcb24a..29539a98276 100644 --- a/service/quicksight/api_op_ListNamespaces.go +++ b/service/quicksight/api_op_ListNamespaces.go @@ -41,8 +41,8 @@ type ListNamespacesInput struct { MaxResults *int32 // A unique pagination token that can be used in a subsequent request. You will - // receive a pagination token in the response body of a previous ListNameSpaces API - // call if there is more data that can be returned. To receive the data, make + // receive a pagination token in the response body of a previous ListNameSpaces + // API call if there is more data that can be returned. To receive the data, make // another ListNamespaces API call with the returned token to retrieve the next // page of data. Each token is valid for 24 hours. If you try to make a // ListNamespaces API call with an expired token, you will receive a HTTP 400 diff --git a/service/quicksight/api_op_ListTemplateAliases.go b/service/quicksight/api_op_ListTemplateAliases.go index a11d59f4d71..5a9036e115c 100644 --- a/service/quicksight/api_op_ListTemplateAliases.go +++ b/service/quicksight/api_op_ListTemplateAliases.go @@ -133,8 +133,8 @@ func (c *Client) addOperationListTemplateAliasesMiddlewares(stack *middleware.St return nil } -// ListTemplateAliasesAPIClient is a client that implements the ListTemplateAliases -// operation. +// ListTemplateAliasesAPIClient is a client that implements the +// ListTemplateAliases operation. type ListTemplateAliasesAPIClient interface { ListTemplateAliases(context.Context, *ListTemplateAliasesInput, ...func(*Options)) (*ListTemplateAliasesOutput, error) } diff --git a/service/quicksight/api_op_ListThemes.go b/service/quicksight/api_op_ListThemes.go index ad369b15141..543e2988240 100644 --- a/service/quicksight/api_op_ListThemes.go +++ b/service/quicksight/api_op_ListThemes.go @@ -42,16 +42,10 @@ type ListThemesInput struct { // The token for the next set of results, or null if there are no more results. NextToken *string - // The type of themes that you want to list. Valid options include the - // following: - // - // * ALL (default)- Display all existing themes. - // - // * CUSTOM - Display - // only the themes created by people using Amazon QuickSight. - // - // * QUICKSIGHT - - // Display only the starting themes defined by Amazon QuickSight. + // The type of themes that you want to list. Valid options include the following: + // - ALL (default) - Display all existing themes. + // - CUSTOM - Display only the themes created by people using Amazon QuickSight. + // - QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight. Type types.ThemeType noSmithyDocumentSerde diff --git a/service/quicksight/api_op_ListUserGroups.go b/service/quicksight/api_op_ListUserGroups.go index b12728a741e..dffeaa47573 100644 --- a/service/quicksight/api_op_ListUserGroups.go +++ b/service/quicksight/api_op_ListUserGroups.go @@ -37,7 +37,7 @@ type ListUserGroupsInput struct { // This member is required. AwsAccountId *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string diff --git a/service/quicksight/api_op_ListUsers.go b/service/quicksight/api_op_ListUsers.go index 12981841c3b..60c8034a8b9 100644 --- a/service/quicksight/api_op_ListUsers.go +++ b/service/quicksight/api_op_ListUsers.go @@ -36,7 +36,7 @@ type ListUsersInput struct { // This member is required. AwsAccountId *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string diff --git a/service/quicksight/api_op_RegisterUser.go b/service/quicksight/api_op_RegisterUser.go index af9aefdbe17..a835a8bfddc 100644 --- a/service/quicksight/api_op_RegisterUser.go +++ b/service/quicksight/api_op_RegisterUser.go @@ -11,16 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon QuickSight user whose identity is associated with the Identity -// and Access Management (IAM) identity or role specified in the request. When you -// register a new user from the Amazon QuickSight API, Amazon QuickSight generates -// a registration URL. The user accesses this registration URL to create their -// account. Amazon QuickSight doesn't send a registration email to users who are -// registered from the Amazon QuickSight API. If you want new users to receive a -// registration email, then add those users in the Amazon QuickSight console. For +// Creates an Amazon QuickSight user whose identity is associated with the +// Identity and Access Management (IAM) identity or role specified in the request. +// When you register a new user from the Amazon QuickSight API, Amazon QuickSight +// generates a registration URL. The user accesses this registration URL to create +// their account. Amazon QuickSight doesn't send a registration email to users who +// are registered from the Amazon QuickSight API. If you want new users to receive +// a registration email, then add those users in the Amazon QuickSight console. For // more information on registering a new user in the Amazon QuickSight console, see -// Inviting users to access Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users). +// Inviting users to access Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users) +// . func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error) { if params == nil { params = &RegisterUserInput{} @@ -52,37 +52,27 @@ type RegisterUserInput struct { // Amazon QuickSight supports several ways of managing the identity of users. This // parameter accepts two values: - // - // * IAM: A user whose identity maps to an existing - // IAM user or role. - // - // * QUICKSIGHT: A user whose identity is owned and managed - // internally by Amazon QuickSight. + // - IAM : A user whose identity maps to an existing IAM user or role. + // - QUICKSIGHT : A user whose identity is owned and managed internally by Amazon + // QuickSight. // // This member is required. IdentityType types.IdentityType - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string // The Amazon QuickSight role for the user. The user role can be one of the // following: - // - // * READER: A user who has read-only access to dashboards. - // - // * AUTHOR: - // A user who can create data sources, datasets, analyses, and dashboards. - // - // * - // ADMIN: A user who is an author, who can also manage Amazon QuickSight - // settings. - // - // * RESTRICTED_READER: This role isn't currently available for use. - // - // * - // RESTRICTED_AUTHOR: This role isn't currently available for use. + // - READER : A user who has read-only access to dashboards. + // - AUTHOR : A user who can create data sources, datasets, analyses, and + // dashboards. + // - ADMIN : A user who is an author, who can also manage Amazon QuickSight + // settings. + // - RESTRICTED_READER : This role isn't currently available for use. + // - RESTRICTED_AUTHOR : This role isn't currently available for use. // // This member is required. UserRole types.UserRole @@ -90,26 +80,17 @@ type RegisterUserInput struct { // The URL of the custom OpenID Connect (OIDC) provider that provides identity to // let a user federate into Amazon QuickSight with an associated Identity and // Access Management(IAM) role. This parameter should only be used when - // ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC. + // ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC . CustomFederationProviderUrl *string // (Enterprise edition only) The name of the custom permissions profile that you // want to assign to this user. Customized permissions allows you to control a // user's access by restricting access the following operations: - // - // * Create and - // update data sources - // - // * Create and update datasets - // - // * Create and update email - // reports - // - // * Subscribe to email reports - // - // To add custom permissions to an existing - // user, use UpdateUser - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) + // - Create and update data sources + // - Create and update datasets + // - Create and update email reports + // - Subscribe to email reports + // To add custom permissions to an existing user, use UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) // instead. A set of custom permissions includes any combination of these // restrictions. Currently, you need to create the profile names for custom // permission sets by using the Amazon QuickSight console. Then, you use the @@ -125,15 +106,13 @@ type RegisterUserInput struct { // user federate into Amazon QuickSight with an associated Identity and Access // Management(IAM) role. The type of supported external login provider can be one // of the following. - // - // * COGNITO: Amazon Cognito. The provider URL is - // cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t - // use the "CustomFederationProviderUrl" parameter which is only needed when the - // external provider is custom. - // - // * CUSTOM_OIDC: Custom OpenID Connect (OIDC) - // provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl - // parameter to provide the custom OIDC provider URL. + // - COGNITO : Amazon Cognito. The provider URL is + // cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t + // use the "CustomFederationProviderUrl" parameter which is only needed when the + // external provider is custom. + // - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing + // CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the + // custom OIDC provider URL. ExternalLoginFederationProviderType *string // The identity ID for a user in the external login provider. @@ -142,14 +121,13 @@ type RegisterUserInput struct { // The ARN of the IAM user or role that you are registering with Amazon QuickSight. IamArn *string - // You need to use this parameter only when you register one or more users using an - // assumed IAM role. You don't need to provide the session name for other + // You need to use this parameter only when you register one or more users using + // an assumed IAM role. You don't need to provide the session name for other // scenarios, for example when you are registering an IAM user or an Amazon // QuickSight user. You can register multiple users using the same IAM role if each // user has a different session name. For more information on assuming IAM roles, - // see assume-role - // (https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html) in the - // CLI Reference. + // see assume-role (https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html) + // in the CLI Reference. SessionName *string // The Amazon QuickSight user name that you want to create for the user you are @@ -170,8 +148,8 @@ type RegisterUserOutput struct { // The user's user name. User *types.User - // The URL the user visits to complete registration and provide a password. This is - // returned only for users with an identity type of QUICKSIGHT. + // The URL the user visits to complete registration and provide a password. This + // is returned only for users with an identity type of QUICKSIGHT . UserInvitationUrl *string // Metadata pertaining to the operation's result. diff --git a/service/quicksight/api_op_SearchAnalyses.go b/service/quicksight/api_op_SearchAnalyses.go index 701d12f2dba..be00d2025dc 100644 --- a/service/quicksight/api_op_SearchAnalyses.go +++ b/service/quicksight/api_op_SearchAnalyses.go @@ -32,8 +32,8 @@ func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput type SearchAnalysesInput struct { - // The ID of the Amazon Web Services account that contains the analyses that you're - // searching for. + // The ID of the Amazon Web Services account that contains the analyses that + // you're searching for. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_SearchDashboards.go b/service/quicksight/api_op_SearchDashboards.go index 1f9a6b10314..c83eb0b463a 100644 --- a/service/quicksight/api_op_SearchDashboards.go +++ b/service/quicksight/api_op_SearchDashboards.go @@ -38,8 +38,8 @@ type SearchDashboardsInput struct { // This member is required. AwsAccountId *string - // The filters to apply to the search. Currently, you can search only by user name, - // for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": + // The filters to apply to the search. Currently, you can search only by user + // name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": // "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" // } ] // diff --git a/service/quicksight/api_op_SearchDataSources.go b/service/quicksight/api_op_SearchDataSources.go index 845ba404bb3..3e1ce2a6d5c 100644 --- a/service/quicksight/api_op_SearchDataSources.go +++ b/service/quicksight/api_op_SearchDataSources.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use the SearchDataSources operation to search for data sources that belong to an -// account. +// Use the SearchDataSources operation to search for data sources that belong to +// an account. func (c *Client) SearchDataSources(ctx context.Context, params *SearchDataSourcesInput, optFns ...func(*Options)) (*SearchDataSourcesOutput, error) { if params == nil { params = &SearchDataSourcesInput{} diff --git a/service/quicksight/api_op_SearchFolders.go b/service/quicksight/api_op_SearchFolders.go index e2e7fe99fae..8191fc30e13 100644 --- a/service/quicksight/api_op_SearchFolders.go +++ b/service/quicksight/api_op_SearchFolders.go @@ -34,9 +34,10 @@ type SearchFoldersInput struct { // This member is required. AwsAccountId *string - // The filters to apply to the search. Currently, you can search only by the parent - // folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": - // "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]. + // The filters to apply to the search. Currently, you can search only by the + // parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", + // "Operator": "StringEquals", "Value": + // "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] . // // This member is required. Filters []types.FolderSearchFilter @@ -52,8 +53,8 @@ type SearchFoldersInput struct { type SearchFoldersOutput struct { - // A structure that contains all of the folders in the Amazon Web Services account. - // This structure provides basic information about the folders. + // A structure that contains all of the folders in the Amazon Web Services + // account. This structure provides basic information about the folders. FolderSummaryList []types.FolderSummary // The token for the next set of results, or null if there are no more results. diff --git a/service/quicksight/api_op_SearchGroups.go b/service/quicksight/api_op_SearchGroups.go index 79bb27ac5ac..1fc0538d282 100644 --- a/service/quicksight/api_op_SearchGroups.go +++ b/service/quicksight/api_op_SearchGroups.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use the SearchGroups operation to search groups in a specified Amazon QuickSight -// namespace using the supplied filters. +// Use the SearchGroups operation to search groups in a specified Amazon +// QuickSight namespace using the supplied filters. func (c *Client) SearchGroups(ctx context.Context, params *SearchGroupsInput, optFns ...func(*Options)) (*SearchGroupsOutput, error) { if params == nil { params = &SearchGroupsInput{} @@ -58,8 +58,8 @@ type SearchGroupsInput struct { type SearchGroupsOutput struct { - // A list of groups in a specified namespace that match the filters you set in your - // SearchGroups request. + // A list of groups in a specified namespace that match the filters you set in + // your SearchGroups request. GroupList []types.Group // A pagination token that can be used in a subsequent request. diff --git a/service/quicksight/api_op_TagResource.go b/service/quicksight/api_op_TagResource.go index bc7c5fa4bb2..cfa17f6aed4 100644 --- a/service/quicksight/api_op_TagResource.go +++ b/service/quicksight/api_op_TagResource.go @@ -23,14 +23,12 @@ import ( // tagging on data set, data source, dashboard, and template. Tagging for Amazon // QuickSight works in a similar way to tagging for other Amazon Web Services // services, except for the following: -// -// * You can't use tags to track costs for -// Amazon QuickSight. This isn't possible because you can't tag the resources that -// Amazon QuickSight costs are based on, for example Amazon QuickSight storage -// capacity (SPICE), number of users, type of users, and usage metrics. -// -// * Amazon -// QuickSight doesn't currently support the tag editor for Resource Groups. +// - You can't use tags to track costs for Amazon QuickSight. This isn't +// possible because you can't tag the resources that Amazon QuickSight costs are +// based on, for example Amazon QuickSight storage capacity (SPICE), number of +// users, type of users, and usage metrics. +// - Amazon QuickSight doesn't currently support the tag editor for Resource +// Groups. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/quicksight/api_op_UpdateAccountCustomization.go b/service/quicksight/api_op_UpdateAccountCustomization.go index 18c015f26b9..7d440d237ae 100644 --- a/service/quicksight/api_op_UpdateAccountCustomization.go +++ b/service/quicksight/api_op_UpdateAccountCustomization.go @@ -59,8 +59,8 @@ type UpdateAccountCustomizationOutput struct { // Services Region. AccountCustomization *types.AccountCustomization - // The Amazon Resource Name (ARN) for the updated customization for this Amazon Web - // Services account. + // The Amazon Resource Name (ARN) for the updated customization for this Amazon + // Web Services account. Arn *string // The ID for the Amazon Web Services account that you want to update Amazon diff --git a/service/quicksight/api_op_UpdateAccountSettings.go b/service/quicksight/api_op_UpdateAccountSettings.go index af088c26b52..c3504d35283 100644 --- a/service/quicksight/api_op_UpdateAccountSettings.go +++ b/service/quicksight/api_op_UpdateAccountSettings.go @@ -35,7 +35,7 @@ type UpdateAccountSettingsInput struct { AwsAccountId *string // The default namespace for this Amazon Web Services account. Currently, the - // default is default. IAM users that register for the first time with Amazon + // default is default . IAM users that register for the first time with Amazon // QuickSight provide an email address that becomes associated with the default // namespace. // diff --git a/service/quicksight/api_op_UpdateAnalysis.go b/service/quicksight/api_op_UpdateAnalysis.go index 201c6776249..d77526d9206 100644 --- a/service/quicksight/api_op_UpdateAnalysis.go +++ b/service/quicksight/api_op_UpdateAnalysis.go @@ -29,26 +29,26 @@ func (c *Client) UpdateAnalysis(ctx context.Context, params *UpdateAnalysisInput type UpdateAnalysisInput struct { - // The ID for the analysis that you're updating. This ID displays in the URL of the - // analysis. + // The ID for the analysis that you're updating. This ID displays in the URL of + // the analysis. // // This member is required. AnalysisId *string - // The ID of the Amazon Web Services account that contains the analysis that you're - // updating. + // The ID of the Amazon Web Services account that contains the analysis that + // you're updating. // // This member is required. AwsAccountId *string - // A descriptive name for the analysis that you're updating. This name displays for - // the analysis in the Amazon QuickSight console. + // A descriptive name for the analysis that you're updating. This name displays + // for the analysis in the Amazon QuickSight console. // // This member is required. Name *string - // The definition of an analysis. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. + // The definition of an analysis. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Definition *types.AnalysisDefinition // The parameter names and override values that you want to use. An analysis can diff --git a/service/quicksight/api_op_UpdateAnalysisPermissions.go b/service/quicksight/api_op_UpdateAnalysisPermissions.go index dc6629e2507..a248743720c 100644 --- a/service/quicksight/api_op_UpdateAnalysisPermissions.go +++ b/service/quicksight/api_op_UpdateAnalysisPermissions.go @@ -46,8 +46,8 @@ type UpdateAnalysisPermissionsInput struct { // to. GrantPermissions []types.ResourcePermission - // A structure that describes the permissions to remove and the principal to remove - // them from. + // A structure that describes the permissions to remove and the principal to + // remove them from. RevokePermissions []types.ResourcePermission noSmithyDocumentSerde diff --git a/service/quicksight/api_op_UpdateDashboard.go b/service/quicksight/api_op_UpdateDashboard.go index 31b7f3d3d64..514025943a3 100644 --- a/service/quicksight/api_op_UpdateDashboard.go +++ b/service/quicksight/api_op_UpdateDashboard.go @@ -14,8 +14,7 @@ import ( // Updates a dashboard in an Amazon Web Services account. Updating a Dashboard // creates a new dashboard version but does not immediately publish the new // version. You can update the published version of a dashboard by using the -// UpdateDashboardPublishedVersion -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) +// UpdateDashboardPublishedVersion (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) // API operation. func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error) { if params == nil { @@ -51,24 +50,19 @@ type UpdateDashboardInput struct { Name *string // Options for publishing the dashboard when you create it: - // - // * AvailabilityStatus - // for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When - // this is set to DISABLED, Amazon QuickSight disables the left filter pane on the - // published dashboard, which can be used for ad hoc (one-time) filtering. This - // option is ENABLED by default. - // - // * AvailabilityStatus for ExportToCSVOption - This - // status can be either ENABLED or DISABLED. The visual option to export data to - // .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED - // by default. - // - // * VisibilityState for SheetControlsOption - This visibility state - // can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default. + // - AvailabilityStatus for AdHocFilteringOption - This status can be either + // ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight + // disables the left filter pane on the published dashboard, which can be used for + // ad hoc (one-time) filtering. This option is ENABLED by default. + // - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED + // or DISABLED . The visual option to export data to .CSV format isn't enabled + // when this is set to DISABLED . This option is ENABLED by default. + // - VisibilityState for SheetControlsOption - This visibility state can be + // either COLLAPSED or EXPANDED . This option is COLLAPSED by default. DashboardPublishOptions *types.DashboardPublishOptions - // The definition of a dashboard. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. + // The definition of a dashboard. A definition is the data model of all features + // in a Dashboard, Template, or Analysis. Definition *types.DashboardVersionDefinition // A structure that contains the parameters of the dashboard. These are parameter @@ -77,13 +71,12 @@ type UpdateDashboardInput struct { Parameters *types.Parameters // The entity that you are using as a source when you update the dashboard. In - // SourceEntity, you specify the type of object you're using as source. You can + // SourceEntity , you specify the type of object you're using as source. You can // only update a dashboard from a template, so you use a SourceTemplate entity. If // you need to update a dashboard from an analysis, first convert the analysis to a - // template by using the CreateTemplate - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) - // API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the - // source template. The SourceTemplate ARN can contain any Amazon Web Services + // template by using the CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) + // API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of + // the source template. The SourceTemplate ARN can contain any Amazon Web Services // account and any Amazon QuickSight-supported Amazon Web Services Region. Use the // DataSetReferences entity within SourceTemplate to list the replacement datasets // for the placeholders listed in the original. The schema in each dataset must diff --git a/service/quicksight/api_op_UpdateDataSet.go b/service/quicksight/api_op_UpdateDataSet.go index 8a9dc98c46a..b36675342cb 100644 --- a/service/quicksight/api_op_UpdateDataSet.go +++ b/service/quicksight/api_op_UpdateDataSet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a dataset. This operation doesn't support datasets that include uploaded -// files as a source. Partial updates are not supported by this operation. +// Updates a dataset. This operation doesn't support datasets that include +// uploaded files as a source. Partial updates are not supported by this operation. func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error) { if params == nil { params = &UpdateDataSetInput{} @@ -35,8 +35,8 @@ type UpdateDataSetInput struct { // This member is required. AwsAccountId *string - // The ID for the dataset that you want to update. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to update. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. // // This member is required. DataSetId *string @@ -60,8 +60,8 @@ type UpdateDataSetInput struct { // Currently, only geospatial hierarchy is supported. ColumnGroups []types.ColumnGroup - // A set of one or more definitions of a ColumnLevelPermissionRule - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). + // A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html) + // . ColumnLevelPermissionRules []types.ColumnLevelPermissionRule // The usage configuration to apply to child datasets that reference this dataset @@ -90,12 +90,12 @@ type UpdateDataSetOutput struct { // The Amazon Resource Name (ARN) of the dataset. Arn *string - // The ID for the dataset that you want to create. This ID is unique per Amazon Web - // Services Region for each Amazon Web Services account. + // The ID for the dataset that you want to create. This ID is unique per Amazon + // Web Services Region for each Amazon Web Services account. DataSetId *string - // The ARN for the ingestion, which is triggered as a result of dataset creation if - // the import mode is SPICE. + // The ARN for the ingestion, which is triggered as a result of dataset creation + // if the import mode is SPICE. IngestionArn *string // The ID of the ingestion, which is triggered as a result of dataset creation if diff --git a/service/quicksight/api_op_UpdateDataSetPermissions.go b/service/quicksight/api_op_UpdateDataSetPermissions.go index 46928c4dbfc..dca0de171c7 100644 --- a/service/quicksight/api_op_UpdateDataSetPermissions.go +++ b/service/quicksight/api_op_UpdateDataSetPermissions.go @@ -12,7 +12,7 @@ import ( ) // Updates the permissions on a dataset. The permissions resource is -// arn:aws:quicksight:region:aws-account-id:dataset/data-set-id. +// arn:aws:quicksight:region:aws-account-id:dataset/data-set-id . func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, optFns ...func(*Options)) (*UpdateDataSetPermissionsOutput, error) { if params == nil { params = &UpdateDataSetPermissionsInput{} diff --git a/service/quicksight/api_op_UpdateIAMPolicyAssignment.go b/service/quicksight/api_op_UpdateIAMPolicyAssignment.go index cc64eff85fc..4b48e700cd7 100644 --- a/service/quicksight/api_op_UpdateIAMPolicyAssignment.go +++ b/service/quicksight/api_op_UpdateIAMPolicyAssignment.go @@ -13,7 +13,7 @@ import ( // Updates an existing IAM policy assignment. This operation updates only the // optional parameter or parameters that are specified in the request. This -// overwrites all of the users included in Identities. +// overwrites all of the users included in Identities . func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*UpdateIAMPolicyAssignmentOutput, error) { if params == nil { params = &UpdateIAMPolicyAssignmentInput{} @@ -49,16 +49,11 @@ type UpdateIAMPolicyAssignmentInput struct { Namespace *string // The status of the assignment. Possible values are as follows: - // - // * ENABLED - - // Anything specified in this assignment is used when creating the data source. - // - // * - // DISABLED - This assignment isn't used when creating the data source. - // - // * DRAFT - - // This assignment is an unfinished draft and isn't used when creating the data - // source. + // - ENABLED - Anything specified in this assignment is used when creating the + // data source. + // - DISABLED - This assignment isn't used when creating the data source. + // - DRAFT - This assignment is an unfinished draft and isn't used when creating + // the data source. AssignmentStatus types.AssignmentStatus // The Amazon QuickSight users, groups, or both that you want to assign the policy @@ -81,16 +76,11 @@ type UpdateIAMPolicyAssignmentOutput struct { AssignmentName *string // The status of the assignment. Possible values are as follows: - // - // * ENABLED - - // Anything specified in this assignment is used when creating the data source. - // - // * - // DISABLED - This assignment isn't used when creating the data source. - // - // * DRAFT - - // This assignment is an unfinished draft and isn't used when creating the data - // source. + // - ENABLED - Anything specified in this assignment is used when creating the + // data source. + // - DISABLED - This assignment isn't used when creating the data source. + // - DRAFT - This assignment is an unfinished draft and isn't used when creating + // the data source. AssignmentStatus types.AssignmentStatus // The Amazon QuickSight users, groups, or both that the IAM policy is assigned to. diff --git a/service/quicksight/api_op_UpdateIpRestriction.go b/service/quicksight/api_op_UpdateIpRestriction.go index b40d7e155bd..38dba183765 100644 --- a/service/quicksight/api_op_UpdateIpRestriction.go +++ b/service/quicksight/api_op_UpdateIpRestriction.go @@ -11,8 +11,8 @@ import ( ) // Updates the content and status of IP rules. To use this operation, you need to -// provide the entire map of rules. You can use the DescribeIpRestriction operation -// to get the current rule map. +// provide the entire map of rules. You can use the DescribeIpRestriction +// operation to get the current rule map. func (c *Client) UpdateIpRestriction(ctx context.Context, params *UpdateIpRestrictionInput, optFns ...func(*Options)) (*UpdateIpRestrictionOutput, error) { if params == nil { params = &UpdateIpRestrictionInput{} diff --git a/service/quicksight/api_op_UpdatePublicSharingSettings.go b/service/quicksight/api_op_UpdatePublicSharingSettings.go index f3102ba7893..bb11f4bdb02 100644 --- a/service/quicksight/api_op_UpdatePublicSharingSettings.go +++ b/service/quicksight/api_op_UpdatePublicSharingSettings.go @@ -16,8 +16,7 @@ import ( // turn on public sharing on your account, make sure to give public sharing // permissions to an administrative user in the Identity and Access Management // (IAM) console. For more information on using IAM with Amazon QuickSight, see -// Using Amazon QuickSight with IAM -// (https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html) +// Using Amazon QuickSight with IAM (https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html) // in the Amazon QuickSight User Guide. func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, optFns ...func(*Options)) (*UpdatePublicSharingSettingsOutput, error) { if params == nil { @@ -42,8 +41,8 @@ type UpdatePublicSharingSettingsInput struct { // This member is required. AwsAccountId *string - // A Boolean value that indicates whether public sharing is turned on for an Amazon - // QuickSight account. + // A Boolean value that indicates whether public sharing is turned on for an + // Amazon QuickSight account. PublicSharingEnabled bool noSmithyDocumentSerde diff --git a/service/quicksight/api_op_UpdateTemplate.go b/service/quicksight/api_op_UpdateTemplate.go index cdd796a000d..3c5168f659d 100644 --- a/service/quicksight/api_op_UpdateTemplate.go +++ b/service/quicksight/api_op_UpdateTemplate.go @@ -30,8 +30,8 @@ func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput type UpdateTemplateInput struct { - // The ID of the Amazon Web Services account that contains the template that you're - // updating. + // The ID of the Amazon Web Services account that contains the template that + // you're updating. // // This member is required. AwsAccountId *string @@ -49,19 +49,19 @@ type UpdateTemplateInput struct { Name *string // The entity that you are using as a source when you update the template. In - // SourceEntity, you specify the type of object you're using as source: + // SourceEntity , you specify the type of object you're using as source: // SourceTemplate for a template or SourceAnalysis for an analysis. Both of these - // require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of - // the source template. For SourceAnalysis, specify the ARN of the source analysis. - // The SourceTemplate ARN can contain any Amazon Web Services account and any - // Amazon QuickSight-supported Amazon Web Services Region;. Use the + // require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of + // the source template. For SourceAnalysis , specify the ARN of the source + // analysis. The SourceTemplate ARN can contain any Amazon Web Services account + // and any Amazon QuickSight-supported Amazon Web Services Region;. Use the // DataSetReferences entity within SourceTemplate or SourceAnalysis to list the // replacement datasets for the placeholders listed in the original. The schema in // each dataset must match its placeholder. SourceEntity *types.TemplateSourceEntity // A description of the current template version that is being updated. Every time - // you call UpdateTemplate, you create a new version of the template. Each version + // you call UpdateTemplate , you create a new version of the template. Each version // of the template maintains a description of the version in the VersionDescription // field. VersionDescription *string diff --git a/service/quicksight/api_op_UpdateTemplateAlias.go b/service/quicksight/api_op_UpdateTemplateAlias.go index 23f497ddb0c..e0bdd44ba8d 100644 --- a/service/quicksight/api_op_UpdateTemplateAlias.go +++ b/service/quicksight/api_op_UpdateTemplateAlias.go @@ -29,9 +29,9 @@ func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplate type UpdateTemplateAliasInput struct { - // The alias of the template that you want to update. If you name a specific alias, - // you update the version that the alias points to. You can specify the latest - // version of the template by providing the keyword $LATEST in the AliasName + // The alias of the template that you want to update. If you name a specific + // alias, you update the version that the alias points to. You can specify the + // latest version of the template by providing the keyword $LATEST in the AliasName // parameter. The keyword $PUBLISHED doesn't apply to templates. // // This member is required. diff --git a/service/quicksight/api_op_UpdateTheme.go b/service/quicksight/api_op_UpdateTheme.go index fd6b0ada5c8..38b130a2091 100644 --- a/service/quicksight/api_op_UpdateTheme.go +++ b/service/quicksight/api_op_UpdateTheme.go @@ -52,9 +52,9 @@ type UpdateThemeInput struct { // The name for the theme. Name *string - // A description of the theme version that you're updating Every time that you call - // UpdateTheme, you create a new version of the theme. Each version of the theme - // maintains a description of the version in VersionDescription. + // A description of the theme version that you're updating Every time that you + // call UpdateTheme , you create a new version of the theme. Each version of the + // theme maintains a description of the version in VersionDescription . VersionDescription *string noSmithyDocumentSerde diff --git a/service/quicksight/api_op_UpdateThemePermissions.go b/service/quicksight/api_op_UpdateThemePermissions.go index 335552aec43..5c8c254b24d 100644 --- a/service/quicksight/api_op_UpdateThemePermissions.go +++ b/service/quicksight/api_op_UpdateThemePermissions.go @@ -11,55 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the resource permissions for a theme. Permissions apply to the action to -// grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme -// permissions apply in groupings. Valid groupings include the following for the -// three levels of permissions, which are user, owner, or no permissions: -// -// * -// User -// -// * "quicksight:DescribeTheme" -// -// * "quicksight:DescribeThemeAlias" -// -// * -// "quicksight:ListThemeAliases" -// -// * "quicksight:ListThemeVersions" -// -// * Owner -// -// * -// "quicksight:DescribeTheme" -// -// * "quicksight:DescribeThemeAlias" -// -// * -// "quicksight:ListThemeAliases" -// -// * "quicksight:ListThemeVersions" -// -// * -// "quicksight:DeleteTheme" -// -// * "quicksight:UpdateTheme" -// -// * -// "quicksight:CreateThemeAlias" -// -// * "quicksight:DeleteThemeAlias" -// -// * -// "quicksight:UpdateThemeAlias" -// -// * "quicksight:UpdateThemePermissions" -// -// * -// "quicksight:DescribeThemePermissions" -// -// * To specify no permissions, omit the -// permissions list. +// Updates the resource permissions for a theme. Permissions apply to the action +// to grant or revoke permissions on, for example "quicksight:DescribeTheme" . +// Theme permissions apply in groupings. Valid groupings include the following for +// the three levels of permissions, which are user, owner, or no permissions: +// - User +// - "quicksight:DescribeTheme" +// - "quicksight:DescribeThemeAlias" +// - "quicksight:ListThemeAliases" +// - "quicksight:ListThemeVersions" +// - Owner +// - "quicksight:DescribeTheme" +// - "quicksight:DescribeThemeAlias" +// - "quicksight:ListThemeAliases" +// - "quicksight:ListThemeVersions" +// - "quicksight:DeleteTheme" +// - "quicksight:UpdateTheme" +// - "quicksight:CreateThemeAlias" +// - "quicksight:DeleteThemeAlias" +// - "quicksight:UpdateThemeAlias" +// - "quicksight:UpdateThemePermissions" +// - "quicksight:DescribeThemePermissions" +// - To specify no permissions, omit the permissions list. func (c *Client) UpdateThemePermissions(ctx context.Context, params *UpdateThemePermissionsInput, optFns ...func(*Options)) (*UpdateThemePermissionsOutput, error) { if params == nil { params = &UpdateThemePermissionsInput{} diff --git a/service/quicksight/api_op_UpdateUser.go b/service/quicksight/api_op_UpdateUser.go index a938bb2f6c0..e0609f5f020 100644 --- a/service/quicksight/api_op_UpdateUser.go +++ b/service/quicksight/api_op_UpdateUser.go @@ -41,25 +41,20 @@ type UpdateUserInput struct { // This member is required. Email *string - // The namespace. Currently, you should set this to default. + // The namespace. Currently, you should set this to default . // // This member is required. Namespace *string // The Amazon QuickSight role of the user. The role can be one of the following // default security cohorts: - // - // * READER: A user who has read-only access to - // dashboards. - // - // * AUTHOR: A user who can create data sources, datasets, analyses, - // and dashboards. - // - // * ADMIN: A user who is an author, who can also manage Amazon - // QuickSight settings. - // - // The name of the Amazon QuickSight role is invisible to the - // user except for the console screens dealing with permissions. + // - READER : A user who has read-only access to dashboards. + // - AUTHOR : A user who can create data sources, datasets, analyses, and + // dashboards. + // - ADMIN : A user who is an author, who can also manage Amazon QuickSight + // settings. + // The name of the Amazon QuickSight role is invisible to the user except for the + // console screens dealing with permissions. // // This member is required. Role types.UserRole @@ -72,52 +67,41 @@ type UpdateUserInput struct { // The URL of the custom OpenID Connect (OIDC) provider that provides identity to // let a user federate into Amazon QuickSight with an associated Identity and // Access Management(IAM) role. This parameter should only be used when - // ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC. + // ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC . CustomFederationProviderUrl *string // (Enterprise edition only) The name of the custom permissions profile that you // want to assign to this user. Customized permissions allows you to control a // user's access by restricting access the following operations: - // - // * Create and - // update data sources - // - // * Create and update datasets - // - // * Create and update email - // reports - // - // * Subscribe to email reports - // - // A set of custom permissions includes any - // combination of these restrictions. Currently, you need to create the profile - // names for custom permission sets by using the Amazon QuickSight console. Then, - // you use the RegisterUser API operation to assign the named set of permissions to - // a Amazon QuickSight user. Amazon QuickSight custom permissions are applied - // through IAM policies. Therefore, they override the permissions typically granted - // by assigning Amazon QuickSight users to one of the default security cohorts in - // Amazon QuickSight (admin, author, reader). This feature is available only to - // Amazon QuickSight Enterprise edition subscriptions. + // - Create and update data sources + // - Create and update datasets + // - Create and update email reports + // - Subscribe to email reports + // A set of custom permissions includes any combination of these restrictions. + // Currently, you need to create the profile names for custom permission sets by + // using the Amazon QuickSight console. Then, you use the RegisterUser API + // operation to assign the named set of permissions to a Amazon QuickSight user. + // Amazon QuickSight custom permissions are applied through IAM policies. + // Therefore, they override the permissions typically granted by assigning Amazon + // QuickSight users to one of the default security cohorts in Amazon QuickSight + // (admin, author, reader). This feature is available only to Amazon QuickSight + // Enterprise edition subscriptions. CustomPermissionsName *string // The type of supported external login provider that provides identity to let a // user federate into Amazon QuickSight with an associated Identity and Access // Management(IAM) role. The type of supported external login provider can be one // of the following. - // - // * COGNITO: Amazon Cognito. The provider URL is - // cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t - // use the "CustomFederationProviderUrl" parameter which is only needed when the - // external provider is custom. - // - // * CUSTOM_OIDC: Custom OpenID Connect (OIDC) - // provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl - // parameter to provide the custom OIDC provider URL. - // - // * NONE: This clears all the - // previously saved external login information for a user. Use the DescribeUser - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) - // API operation to check the external login information. + // - COGNITO : Amazon Cognito. The provider URL is + // cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t + // use the "CustomFederationProviderUrl" parameter which is only needed when the + // external provider is custom. + // - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing + // CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the + // custom OIDC provider URL. + // - NONE : This clears all the previously saved external login information for a + // user. Use the DescribeUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) + // API operation to check the external login information. ExternalLoginFederationProviderType *string // The identity ID for a user in the external login provider. diff --git a/service/quicksight/doc.go b/service/quicksight/doc.go index 48ffdd9439c..f96e55eefe6 100644 --- a/service/quicksight/doc.go +++ b/service/quicksight/doc.go @@ -3,9 +3,9 @@ // Package quicksight provides the API client, operations, and parameter types for // Amazon QuickSight. // -// Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless -// business intelligence service for the Amazon Web Services Cloud that makes it -// easy to extend data and insights to every user in your organization. This API -// reference contains documentation for a programming interface that you can use to -// manage Amazon QuickSight. +// Amazon QuickSight API Reference Amazon QuickSight is a fully managed, +// serverless business intelligence service for the Amazon Web Services Cloud that +// makes it easy to extend data and insights to every user in your organization. +// This API reference contains documentation for a programming interface that you +// can use to manage Amazon QuickSight. package quicksight diff --git a/service/quicksight/types/enums.go b/service/quicksight/types/enums.go index 9482e944967..c52aa78bb26 100644 --- a/service/quicksight/types/enums.go +++ b/service/quicksight/types/enums.go @@ -71,9 +71,9 @@ const ( AnchorOptionNow AnchorOption = "NOW" ) -// Values returns all known values for AnchorOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AnchorOption. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AnchorOption) Values() []AnchorOption { return []AnchorOption{ "NOW", @@ -90,9 +90,9 @@ const ( ArcThicknessWhole ArcThickness = "WHOLE" ) -// Values returns all known values for ArcThickness. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ArcThickness. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ArcThickness) Values() []ArcThickness { return []ArcThickness{ "SMALL", @@ -423,9 +423,9 @@ const ( ConditionalFormattingIconDisplayOptionIconOnly ConditionalFormattingIconDisplayOption = "ICON_ONLY" ) -// Values returns all known values for ConditionalFormattingIconDisplayOption. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for ConditionalFormattingIconDisplayOption. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (ConditionalFormattingIconDisplayOption) Values() []ConditionalFormattingIconDisplayOption { return []ConditionalFormattingIconDisplayOption{ @@ -498,9 +498,9 @@ const ( CustomContentImageScalingConfigurationScaleToVisual CustomContentImageScalingConfiguration = "SCALE_TO_VISUAL" ) -// Values returns all known values for CustomContentImageScalingConfiguration. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for CustomContentImageScalingConfiguration. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (CustomContentImageScalingConfiguration) Values() []CustomContentImageScalingConfiguration { return []CustomContentImageScalingConfiguration{ @@ -594,9 +594,9 @@ const ( DashboardFilterAttributeDashboardName DashboardFilterAttribute = "DASHBOARD_NAME" ) -// Values returns all known values for DashboardFilterAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DashboardFilterAttribute. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DashboardFilterAttribute) Values() []DashboardFilterAttribute { return []DashboardFilterAttribute{ "QUICKSIGHT_USER", @@ -888,9 +888,9 @@ const ( DayOfWeekSaturday DayOfWeek = "SATURDAY" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "SUNDAY", @@ -932,8 +932,8 @@ const ( EmbeddingIdentityTypeAnonymous EmbeddingIdentityType = "ANONYMOUS" ) -// Values returns all known values for EmbeddingIdentityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for EmbeddingIdentityType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (EmbeddingIdentityType) Values() []EmbeddingIdentityType { return []EmbeddingIdentityType{ @@ -958,8 +958,8 @@ const ( ExceptionResourceTypeIngestion ExceptionResourceType = "INGESTION" ) -// Values returns all known values for ExceptionResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ExceptionResourceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ExceptionResourceType) Values() []ExceptionResourceType { return []ExceptionResourceType{ @@ -1070,8 +1070,8 @@ const ( FolderFilterAttributeFolderName FolderFilterAttribute = "FOLDER_NAME" ) -// Values returns all known values for FolderFilterAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FolderFilterAttribute. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FolderFilterAttribute) Values() []FolderFilterAttribute { return []FolderFilterAttribute{ @@ -1127,9 +1127,9 @@ const ( FontStyleItalic FontStyle = "ITALIC" ) -// Values returns all known values for FontStyle. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for FontStyle. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (FontStyle) Values() []FontStyle { return []FontStyle{ "NORMAL", @@ -1206,8 +1206,8 @@ const ( GeoSpatialCountryCodeUs GeoSpatialCountryCode = "US" ) -// Values returns all known values for GeoSpatialCountryCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for GeoSpatialCountryCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (GeoSpatialCountryCode) Values() []GeoSpatialCountryCode { return []GeoSpatialCountryCode{ @@ -1251,9 +1251,10 @@ const ( GeospatialSelectedPointStyleCluster GeospatialSelectedPointStyle = "CLUSTER" ) -// Values returns all known values for GeospatialSelectedPointStyle. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for GeospatialSelectedPointStyle. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (GeospatialSelectedPointStyle) Values() []GeospatialSelectedPointStyle { return []GeospatialSelectedPointStyle{ "POINT", @@ -1423,9 +1424,9 @@ const ( IdentityTypeQuicksight IdentityType = "QUICKSIGHT" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "IAM", @@ -1946,9 +1947,9 @@ const ( NegativeValueDisplayModeNegative NegativeValueDisplayMode = "NEGATIVE" ) -// Values returns all known values for NegativeValueDisplayMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NegativeValueDisplayMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (NegativeValueDisplayMode) Values() []NegativeValueDisplayMode { return []NegativeValueDisplayMode{ "POSITIVE", @@ -1990,9 +1991,10 @@ const ( NumericEqualityMatchOperatorDoesNotEqual NumericEqualityMatchOperator = "DOES_NOT_EQUAL" ) -// Values returns all known values for NumericEqualityMatchOperator. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for NumericEqualityMatchOperator. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (NumericEqualityMatchOperator) Values() []NumericEqualityMatchOperator { return []NumericEqualityMatchOperator{ "EQUALS", @@ -2110,9 +2112,9 @@ const ( PaperSizeJisB5 PaperSize = "JIS_B5" ) -// Values returns all known values for PaperSize. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for PaperSize. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (PaperSize) Values() []PaperSize { return []PaperSize{ "US_LETTER", @@ -2293,9 +2295,9 @@ const ( ReferenceLinePatternTypeDotted ReferenceLinePatternType = "DOTTED" ) -// Values returns all known values for ReferenceLinePatternType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReferenceLinePatternType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceLinePatternType) Values() []ReferenceLinePatternType { return []ReferenceLinePatternType{ "SOLID", @@ -2405,9 +2407,9 @@ const ( ResizeOptionResponsive ResizeOption = "RESPONSIVE" ) -// Values returns all known values for ResizeOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResizeOption. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResizeOption) Values() []ResizeOption { return []ResizeOption{ "FIXED", @@ -2470,9 +2472,9 @@ const ( RowLevelPermissionPolicyDenyAccess RowLevelPermissionPolicy = "DENY_ACCESS" ) -// Values returns all known values for RowLevelPermissionPolicy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RowLevelPermissionPolicy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RowLevelPermissionPolicy) Values() []RowLevelPermissionPolicy { return []RowLevelPermissionPolicy{ "GRANT_ACCESS", @@ -2505,8 +2507,8 @@ const ( SelectAllValueOptionsAllValues SelectAllValueOptions = "ALL_VALUES" ) -// Values returns all known values for SelectAllValueOptions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SelectAllValueOptions. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SelectAllValueOptions) Values() []SelectAllValueOptions { return []SelectAllValueOptions{ @@ -2740,8 +2742,8 @@ const ( TableFieldIconSetTypeLink TableFieldIconSetType = "LINK" ) -// Values returns all known values for TableFieldIconSetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TableFieldIconSetType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TableFieldIconSetType) Values() []TableFieldIconSetType { return []TableFieldIconSetType{ @@ -2902,9 +2904,9 @@ const ( ThemeTypeAll ThemeType = "ALL" ) -// Values returns all known values for ThemeType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ThemeType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ThemeType) Values() []ThemeType { return []ThemeType{ "QUICKSIGHT", @@ -2971,9 +2973,9 @@ const ( TopBottomComputationTypeBottom TopBottomComputationType = "BOTTOM" ) -// Values returns all known values for TopBottomComputationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TopBottomComputationType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TopBottomComputationType) Values() []TopBottomComputationType { return []TopBottomComputationType{ "TOP", @@ -3070,8 +3072,8 @@ const ( VerticalTextAlignmentBottom VerticalTextAlignment = "BOTTOM" ) -// Values returns all known values for VerticalTextAlignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VerticalTextAlignment. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VerticalTextAlignment) Values() []VerticalTextAlignment { return []VerticalTextAlignment{ @@ -3125,9 +3127,9 @@ const ( WidgetStatusDisabled WidgetStatus = "DISABLED" ) -// Values returns all known values for WidgetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WidgetStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WidgetStatus) Values() []WidgetStatus { return []WidgetStatus{ "ENABLED", @@ -3179,9 +3181,9 @@ const ( WordCloudWordOrientationHorizontalAndVertical WordCloudWordOrientation = "HORIZONTAL_AND_VERTICAL" ) -// Values returns all known values for WordCloudWordOrientation. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for WordCloudWordOrientation. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (WordCloudWordOrientation) Values() []WordCloudWordOrientation { return []WordCloudWordOrientation{ "HORIZONTAL", diff --git a/service/quicksight/types/errors.go b/service/quicksight/types/errors.go index 4f92db76804..f427d14b4d6 100644 --- a/service/quicksight/types/errors.go +++ b/service/quicksight/types/errors.go @@ -126,7 +126,7 @@ func (e *DomainNotWhitelistedException) ErrorCode() string { func (e *DomainNotWhitelistedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The identity type specified isn't supported. Supported identity types include -// IAM and QUICKSIGHT. +// IAM and QUICKSIGHT . type IdentityTypeNotSupportedException struct { Message *string @@ -326,7 +326,7 @@ func (e *PreconditionNotMetException) ErrorFault() smithy.ErrorFault { return sm // The user with the provided name isn't found. This error can happen in any // operation that requires finding a user based on a provided user name, such as -// DeleteUser, DescribeUser, and so on. +// DeleteUser , DescribeUser , and so on. type QuickSightUserNotFoundException struct { Message *string @@ -505,8 +505,7 @@ func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.Fau // account. Before you can use embedding for anonymous users, a QuickSight // administrator needs to add capacity pricing to Amazon QuickSight. You can do // this on the Manage Amazon QuickSight page. After capacity pricing is added, you -// can use the GetDashboardEmbedUrl -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html) +// can use the GetDashboardEmbedUrl (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html) // API operation with the --identity-type ANONYMOUS option. type UnsupportedPricingPlanException struct { Message *string diff --git a/service/quicksight/types/types.go b/service/quicksight/types/types.go index 8c14ea11b01..04f010a1133 100644 --- a/service/quicksight/types/types.go +++ b/service/quicksight/types/types.go @@ -21,20 +21,12 @@ type AccountCustomization struct { } // A structure that contains the following account information elements: -// -// * Your -// Amazon QuickSight account name. -// -// * The edition of Amazon QuickSight that your -// account is using. -// -// * The notification email address that is associated with the -// Amazon QuickSight account. -// -// * The authentication type of the Amazon QuickSight -// account. -// -// * The status of the Amazon QuickSight account's subscription. +// - Your Amazon QuickSight account name. +// - The edition of Amazon QuickSight that your account is using. +// - The notification email address that is associated with the Amazon +// QuickSight account. +// - The authentication type of the Amazon QuickSight account. +// - The status of the Amazon QuickSight account's subscription. type AccountInfo struct { // The account name that you provided for the Amazon QuickSight subscription in @@ -71,17 +63,17 @@ type AccountSettings struct { // The default Amazon QuickSight namespace for your Amazon Web Services account. DefaultNamespace *string - // The edition of Amazon QuickSight that you're currently subscribed to: Enterprise - // edition or Standard edition. + // The edition of Amazon QuickSight that you're currently subscribed to: + // Enterprise edition or Standard edition. Edition Edition // The main notification email for your Amazon QuickSight subscription. NotificationEmail *string - // A Boolean value that indicates whether public sharing is turned on for an Amazon - // QuickSight account. For more information about turning on public sharing, see - // UpdatePublicSharingSettings - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html). + // A Boolean value that indicates whether public sharing is turned on for an + // Amazon QuickSight account. For more information about turning on public sharing, + // see UpdatePublicSharingSettings (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html) + // . PublicSharingEnabled bool // A boolean value that determines whether or not an Amazon QuickSight account can @@ -114,32 +106,21 @@ type AdHocFilteringOption struct { noSmithyDocumentSerde } -// An aggregation function aggregates values from a dimension or measure. This is a -// union type structure. For this structure to be valid, only one of the attributes -// can be defined. +// An aggregation function aggregates values from a dimension or measure. This is +// a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type AggregationFunction struct { // Aggregation for categorical values. - // - // * COUNT: Aggregate by the total number of - // values, including duplicates. - // - // * DISTINCT_COUNT: Aggregate by the total number - // of distinct values. + // - COUNT : Aggregate by the total number of values, including duplicates. + // - DISTINCT_COUNT : Aggregate by the total number of distinct values. CategoricalAggregationFunction CategoricalAggregationFunction // Aggregation for date values. - // - // * COUNT: Aggregate by the total number of values, - // including duplicates. - // - // * DISTINCT_COUNT: Aggregate by the total number of - // distinct values. - // - // * MIN: Select the smallest date value. - // - // * MAX: Select the - // largest date value. + // - COUNT : Aggregate by the total number of values, including duplicates. + // - DISTINCT_COUNT : Aggregate by the total number of distinct values. + // - MIN : Select the smallest date value. + // - MAX : Select the largest date value. DateAggregationFunction DateAggregationFunction // Aggregation for numerical values. @@ -151,7 +132,7 @@ type AggregationFunction struct { // The configuration options to sort aggregated values. type AggregationSortConfiguration struct { - // The function that aggregates the values in Column. + // The function that aggregates the values in Column . // // This member is required. AggregationFunction *AggregationFunction @@ -162,11 +143,8 @@ type AggregationSortConfiguration struct { Column *ColumnIdentifier // The sort direction of values. - // - // * ASC: Sort in ascending order. - // - // * DESC: Sort in - // descending order. + // - ASC : Sort in ascending order. + // - DESC : Sort in descending order. // // This member is required. SortDirection SortDirection @@ -264,15 +242,13 @@ type AnalysisDefinition struct { ColumnConfigurations []ColumnConfiguration // Filter definitions for an analysis. For more information, see Filtering Data in - // Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the - // Amazon QuickSight User Guide. + // Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) + // in the Amazon QuickSight User Guide. FilterGroups []FilterGroup // An array of parameter declarations for an analysis. Parameters are named // variables that can transfer a value for use by an action or an object. For more - // information, see Parameters in Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) + // information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) // in the Amazon QuickSight User Guide. ParameterDeclarations []ParameterDeclaration @@ -302,52 +278,42 @@ type AnalysisError struct { type AnalysisSearchFilter struct { // The name of the value that you want to use as a filter, for example "Name": - // "QUICKSIGHT_OWNER". Valid values are defined as follows: - // - // * - // QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses - // with that ARN listed as one of the analysis' owners or viewers are returned. - // Implicit permissions from folders or groups are considered. - // - // * QUICKSIGHT_OWNER: - // Provide an ARN of a user or group, and any analyses with that ARN listed as one - // of the owners of the analyses are returned. Implicit permissions from folders or - // groups are considered. - // - // * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user - // or group, and any analyses with that ARN listed as the only owner of the - // analysis are returned. Implicit permissions from folders or groups are not - // considered. - // - // * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and - // any analyses with that ARN listed as one of the owners of the analyses are - // returned. Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // analyses with that ARN listed as one of the owners or viewers of the analyses - // are returned. Implicit permissions from folders or groups are not considered. - // - // * - // ANALYSIS_NAME: Any analyses whose names have a substring match to this value - // will be returned. + // "QUICKSIGHT_OWNER" . Valid values are defined as follows: + // - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any + // analyses with that ARN listed as one of the analysis' owners or viewers are + // returned. Implicit permissions from folders or groups are considered. + // - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any analyses with + // that ARN listed as one of the owners of the analyses are returned. Implicit + // permissions from folders or groups are considered. + // - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any + // analyses with that ARN listed as the only owner of the analysis are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any + // analyses with that ARN listed as one of the owners of the analyses are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and + // any analyses with that ARN listed as one of the owners or viewers of the + // analyses are returned. Implicit permissions from folders or groups are not + // considered. + // - ANALYSIS_NAME : Any analyses whose names have a substring match to this + // value will be returned. Name AnalysisFilterAttribute // The comparison operator that you want to use as a filter, for example - // "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If - // you set the operator value to "StringEquals", you need to provide an ownership - // related filter in the "NAME" field and the arn of the user or group whose - // folders you want to search in the "Value" field. For example, + // "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" . + // If you set the operator value to "StringEquals" , you need to provide an + // ownership related filter in the "NAME" field and the arn of the user or group + // whose folders you want to search in the "Value" field. For example, // "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to - // "StringLike", you need to provide the name of the folders you are searching for. - // For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". - // The "StringLike" operator only supports the NAME value ANALYSIS_NAME. + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value + // to "StringLike" , you need to provide the name of the folders you are searching + // for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": + // "Test" . The "StringLike" operator only supports the NAME value ANALYSIS_NAME . Operator FilterOperator - // The value of the named item, in this case QUICKSIGHT_USER, that you want to use - // as a filter, for example "Value". An example is - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". + // The value of the named item, in this case QUICKSIGHT_USER , that you want to use + // as a filter, for example "Value" . An example is + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . Value *string noSmithyDocumentSerde @@ -407,8 +373,7 @@ type AnalysisSummary struct { type AnchorDateConfiguration struct { // The options for the date configuration. Choose one of the options below: - // - // * NOW + // - NOW AnchorOption AnchorOption // The name of the parameter that is used for the anchor date configuration. @@ -424,7 +389,7 @@ type AnonymousUserDashboardEmbeddingConfiguration struct { // is included in the output URL. When the URL in response is accessed, Amazon // QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this // dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, - // the request will fail with InvalidParameterValueException. + // the request will fail with InvalidParameterValueException . // // This member is required. InitialDashboardId *string @@ -432,15 +397,15 @@ type AnonymousUserDashboardEmbeddingConfiguration struct { noSmithyDocumentSerde } -// The experience that you are embedding. You can use this object to generate a url -// that embeds a visual into your application. +// The experience that you are embedding. You can use this object to generate a +// url that embeds a visual into your application. type AnonymousUserDashboardVisualEmbeddingConfiguration struct { // The visual ID for the visual that you want the user to see. This ID is included // in the output URL. When the URL in response is accessed, Amazon QuickSight // renders this visual. The Amazon Resource Name (ARN) of the dashboard that the // visual belongs to must be included in the AuthorizedResourceArns parameter. - // Otherwise, the request will fail with InvalidParameterValueException. + // Otherwise, the request will fail with InvalidParameterValueException . // // This member is required. InitialDashboardVisualId *DashboardVisualId @@ -472,7 +437,7 @@ type AnonymousUserQSearchBarEmbeddingConfiguration struct { // accessed, Amazon QuickSight renders the Q search bar with this topic // pre-selected. The Amazon Resource Name (ARN) of this Q topic must be included in // the AuthorizedResourceArns parameter. Otherwise, the request will fail with - // InvalidParameterValueException. + // InvalidParameterValueException . // // This member is required. InitialTopicId *string @@ -480,10 +445,10 @@ type AnonymousUserQSearchBarEmbeddingConfiguration struct { noSmithyDocumentSerde } -// The arc axis configuration of a GaugeChartVisual. +// The arc axis configuration of a GaugeChartVisual . type ArcAxisConfiguration struct { - // The arc axis range of a GaugeChartVisual. + // The arc axis range of a GaugeChartVisual . Range *ArcAxisDisplayRange // The reserved range of the arc axis. @@ -492,7 +457,7 @@ type ArcAxisConfiguration struct { noSmithyDocumentSerde } -// The arc axis range of a GaugeChartVisual. +// The arc axis range of a GaugeChartVisual . type ArcAxisDisplayRange struct { // The maximum value of the arc axis range. @@ -504,22 +469,22 @@ type ArcAxisDisplayRange struct { noSmithyDocumentSerde } -// The arc configuration of a GaugeChartVisual. +// The arc configuration of a GaugeChartVisual . type ArcConfiguration struct { - // The option that determines the arc angle of a GaugeChartVisual. + // The option that determines the arc angle of a GaugeChartVisual . ArcAngle *float64 - // The options that determine the arc thickness of a GaugeChartVisual. + // The options that determine the arc thickness of a GaugeChartVisual . ArcThickness ArcThicknessOptions noSmithyDocumentSerde } -// The options that determine the arc thickness of a GaugeChartVisual. +// The options that determine the arc thickness of a GaugeChartVisual . type ArcOptions struct { - // The arc thickness of a GaugeChartVisual. + // The arc thickness of a GaugeChartVisual . ArcThickness ArcThickness noSmithyDocumentSerde @@ -528,11 +493,11 @@ type ArcOptions struct { // Parameters for Amazon Athena. type AthenaParameters struct { - // Use the RoleArn structure to override an account-wide role for a specific Athena - // data source. For example, say an account administrator has turned off all Athena - // access with an account-wide role. The administrator can then use RoleArn to - // bypass the account-wide role and allow Athena access for the single Athena data - // source that is specified in the structure, even if the account-wide role + // Use the RoleArn structure to override an account-wide role for a specific + // Athena data source. For example, say an account administrator has turned off all + // Athena access with an account-wide role. The administrator can then use RoleArn + // to bypass the account-wide role and allow Athena access for the single Athena + // data source that is specified in the structure, even if the account-wide role // forbidding Athena access is still active. RoleArn *string @@ -595,8 +560,8 @@ type AwsIotAnalyticsParameters struct { noSmithyDocumentSerde } -// The data options for an axis. This is a union type structure. For this structure -// to be valid, only one of the attributes can be defined. +// The data options for an axis. This is a union type structure. For this +// structure to be valid, only one of the attributes can be defined. type AxisDataOptions struct { // The options for an axis with a date field. @@ -650,8 +615,9 @@ type AxisDisplayOptions struct { noSmithyDocumentSerde } -// The range setup of a numeric axis display range. This is a union type structure. -// For this structure to be valid, only one of the attributes can be defined. +// The range setup of a numeric axis display range. This is a union type +// structure. For this structure to be valid, only one of the attributes can be +// defined. type AxisDisplayRange struct { // The data-driven setup of an axis display range. @@ -663,8 +629,8 @@ type AxisDisplayRange struct { noSmithyDocumentSerde } -// The label options for a chart axis. You must specify the field that the label is -// targeted to. +// The label options for a chart axis. You must specify the field that the label +// is targeted to. type AxisLabelOptions struct { // The options that indicate which field the label belongs to. @@ -761,7 +727,7 @@ type BarChartAggregatedFieldWells struct { noSmithyDocumentSerde } -// The configuration of a BarChartVisual. +// The configuration of a BarChartVisual . type BarChartConfiguration struct { // Determines the arrangement of the bars. The orientation and arrangement of bars @@ -792,16 +758,14 @@ type BarChartConfiguration struct { // The legend display setup of the visual. Legend *LegendOptions - // The orientation of the bars in a bar chart visual. There are two valid values in - // this structure: - // - // * HORIZONTAL: Used for charts that have horizontal bars. - // Visuals that use this value are horizontal bar charts, horizontal stacked bar - // charts, and horizontal stacked 100% bar charts. - // - // * VERTICAL: Used for charts - // that have vertical bars. Visuals that use this value are vertical bar charts, - // vertical stacked bar charts, and vertical stacked 100% bar charts. + // The orientation of the bars in a bar chart visual. There are two valid values + // in this structure: + // - HORIZONTAL : Used for charts that have horizontal bars. Visuals that use + // this value are horizontal bar charts, horizontal stacked bar charts, and + // horizontal stacked 100% bar charts. + // - VERTICAL : Used for charts that have vertical bars. Visuals that use this + // value are vertical bar charts, vertical stacked bar charts, and vertical stacked + // 100% bar charts. Orientation BarChartOrientation // The reference line setup of the visual. @@ -810,7 +774,7 @@ type BarChartConfiguration struct { // The small multiples setup for the visual. SmallMultiplesOptions *SmallMultiplesOptions - // The sort configuration of a BarChartVisual. + // The sort configuration of a BarChartVisual . SortConfiguration *BarChartSortConfiguration // The tooltip display setup of the visual. @@ -830,7 +794,7 @@ type BarChartConfiguration struct { noSmithyDocumentSerde } -// The field wells of a BarChartVisual. This is a union type structure. For this +// The field wells of a BarChartVisual . This is a union type structure. For this // structure to be valid, only one of the attributes can be defined. type BarChartFieldWells struct { @@ -864,27 +828,18 @@ type BarChartSortConfiguration struct { noSmithyDocumentSerde } -// A bar chart. The BarChartVisual structure describes a visual that is a member of -// the bar chart family. The following charts can be described using this +// A bar chart. The BarChartVisual structure describes a visual that is a member +// of the bar chart family. The following charts can be described using this // structure: +// - Horizontal bar chart +// - Vertical bar chart +// - Horizontal stacked bar chart +// - Vertical stacked bar chart +// - Horizontal stacked 100% bar chart +// - Vertical stacked 100% bar chart // -// * Horizontal bar chart -// -// * Vertical bar chart -// -// * Horizontal stacked -// bar chart -// -// * Vertical stacked bar chart -// -// * Horizontal stacked 100% bar chart -// -// * -// Vertical stacked 100% bar chart -// -// For more information, see Using bar charts -// (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the -// Amazon QuickSight User Guide. +// For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) +// in the Amazon QuickSight User Guide. type BarChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -987,7 +942,7 @@ type BoxPlotAggregatedFieldWells struct { noSmithyDocumentSerde } -// The configuration of a BoxPlotVisual. +// The configuration of a BoxPlotVisual . type BoxPlotChartConfiguration struct { // The box plot chart options for a box plot visual @@ -1018,7 +973,7 @@ type BoxPlotChartConfiguration struct { // The reference line setup of the visual. ReferenceLines []ReferenceLine - // The sort configuration of a BoxPlotVisual. + // The sort configuration of a BoxPlotVisual . SortConfiguration *BoxPlotSortConfiguration // The tooltip display setup of the visual. @@ -1030,7 +985,7 @@ type BoxPlotChartConfiguration struct { noSmithyDocumentSerde } -// The field wells of a BoxPlotVisual. This is a union type structure. For this +// The field wells of a BoxPlotVisual . This is a union type structure. For this // structure to be valid, only one of the attributes can be defined. type BoxPlotFieldWells struct { @@ -1055,7 +1010,7 @@ type BoxPlotOptions struct { noSmithyDocumentSerde } -// The sort configuration of a BoxPlotVisual. +// The sort configuration of a BoxPlotVisual . type BoxPlotSortConfiguration struct { // The sort configuration of a group by fields. @@ -1076,9 +1031,8 @@ type BoxPlotStyleOptions struct { noSmithyDocumentSerde } -// A box plot. For more information, see Using box plots -// (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the -// Amazon QuickSight User Guide. +// A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) +// in the Amazon QuickSight User Guide. type BoxPlotVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -1166,25 +1120,25 @@ type CalculatedMeasureField struct { noSmithyDocumentSerde } -// The values that are displayed in a control can be configured to only show values -// that are valid based on what's selected in other controls. +// The values that are displayed in a control can be configured to only show +// values that are valid based on what's selected in other controls. type CascadingControlConfiguration struct { - // A list of source controls that determine the values that are used in the current - // control. + // A list of source controls that determine the values that are used in the + // current control. SourceControls []CascadingControlSource noSmithyDocumentSerde } -// The source controls that are used in a CascadingControlConfiguration. +// The source controls that are used in a CascadingControlConfiguration . type CascadingControlSource struct { // The column identifier that determines which column to look up for the source // sheet control. ColumnToMatch *ColumnIdentifier - // The source sheet control ID of a CascadingControlSource. + // The source sheet control ID of a CascadingControlSource . SourceSheetControlId *string noSmithyDocumentSerde @@ -1203,8 +1157,8 @@ type CastColumnTypeOperation struct { // This member is required. NewColumnType ColumnDataType - // When casting a column from string to datetime type, you can supply a string in a - // format supported by Amazon QuickSight to denote the source data format. + // When casting a column from string to datetime type, you can supply a string in + // a format supported by Amazon QuickSight to denote the source data format. Format *string noSmithyDocumentSerde @@ -1213,7 +1167,7 @@ type CastColumnTypeOperation struct { // The dimension type field with categorical type columns.. type CategoricalDimensionField struct { - // The column that is used in the CategoricalDimensionField. + // The column that is used in the CategoricalDimensionField . // // This member is required. Column *ColumnIdentifier @@ -1235,7 +1189,7 @@ type CategoricalDimensionField struct { // The measure type field with categorical type columns. type CategoricalMeasureField struct { - // The column that is used in the CategoricalMeasureField. + // The column that is used in the CategoricalMeasureField . // // This member is required. Column *ColumnIdentifier @@ -1272,8 +1226,7 @@ type CategoryDrillDownFilter struct { } // A CategoryFilter filters text values. For more information, see Adding text -// filters -// (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) +// filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) // in the Amazon QuickSight User Guide. type CategoryFilter struct { @@ -1282,13 +1235,13 @@ type CategoryFilter struct { // This member is required. Column *ColumnIdentifier - // The configuration for a CategoryFilter. + // The configuration for a CategoryFilter . // // This member is required. Configuration *CategoryFilterConfiguration - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string @@ -1296,8 +1249,8 @@ type CategoryFilter struct { noSmithyDocumentSerde } -// The configuration for a CategoryFilter. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The configuration for a CategoryFilter . This is a union type structure. For +// this structure to be valid, only one of the attributes can be defined. type CategoryFilterConfiguration struct { // A custom filter that filters based on a single value. This filter can be @@ -1326,10 +1279,8 @@ type ChartAxisLabelOptions struct { // The visibility of an axis label on a chart. Choose one of the following // options: - // - // * VISIBLE: Shows the axis. - // - // * HIDDEN: Hides the axis. + // - VISIBLE : Shows the axis. + // - HIDDEN : Hides the axis. Visibility Visibility noSmithyDocumentSerde @@ -1514,8 +1465,7 @@ type ColumnSort struct { noSmithyDocumentSerde } -// A tag for a column in a TagColumnOperation -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html) +// A tag for a column in a TagColumnOperation (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html) // structure. This is a variant type structure. For this structure to be valid, // only one of the attributes can be non-null. type ColumnTag struct { @@ -1567,7 +1517,7 @@ type ComboChartAggregatedFieldWells struct { noSmithyDocumentSerde } -// The configuration of a ComboChartVisual. +// The configuration of a ComboChartVisual . type ComboChartConfiguration struct { // The options that determine if visual data labels are displayed. The data label @@ -1576,14 +1526,10 @@ type ComboChartConfiguration struct { // Determines the bar arrangement in a combo chart. The following are valid values // in this structure: - // - // * CLUSTERED: For clustered bar combo charts. - // - // * STACKED: For - // stacked bar combo charts. - // - // * STACKED_PERCENT: Do not use. If you use this value, - // the operation returns a validation error. + // - CLUSTERED : For clustered bar combo charts. + // - STACKED : For stacked bar combo charts. + // - STACKED_PERCENT : Do not use. If you use this value, the operation returns a + // validation error. BarsArrangement BarsArrangement // The category axis of a combo chart. @@ -1626,7 +1572,7 @@ type ComboChartConfiguration struct { // combo chart's secondary y-axis(line) field well. SecondaryYAxisLabelOptions *ChartAxisLabelOptions - // The sort configuration of a ComboChartVisual. + // The sort configuration of a ComboChartVisual . SortConfiguration *ComboChartSortConfiguration // The legend display setup of the visual. @@ -1649,7 +1595,7 @@ type ComboChartFieldWells struct { noSmithyDocumentSerde } -// The sort configuration of a ComboChartVisual. +// The sort configuration of a ComboChartVisual . type ComboChartSortConfiguration struct { // The item limit configuration for the category field well of a combo chart. @@ -1668,9 +1614,8 @@ type ComboChartSortConfiguration struct { } // A combo chart. The ComboChartVisual includes stacked bar combo charts and -// clustered bar combo charts For more information, see Using combo charts -// (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the -// Amazon QuickSight User Guide. +// clustered bar combo charts For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) +// in the Amazon QuickSight User Guide. type ComboChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -1705,20 +1650,16 @@ type ComparisonConfiguration struct { ComparisonFormat *ComparisonFormatConfiguration // The method of the comparison. Choose from the following options: - // - // * - // DIFFERENCE - // - // * PERCENT_DIFFERENCE - // - // * PERCENT + // - DIFFERENCE + // - PERCENT_DIFFERENCE + // - PERCENT ComparisonMethod ComparisonMethod noSmithyDocumentSerde } -// The format of the comparison. This is a union type structure. For this structure -// to be valid, only one of the attributes can be defined. +// The format of the comparison. This is a union type structure. For this +// structure to be valid, only one of the attributes can be defined. type ComparisonFormatConfiguration struct { // The number display format. @@ -1883,7 +1824,7 @@ type ConditionalFormattingSolidColor struct { type ContributionAnalysisDefault struct { // The dimensions columns that are used in the contribution analysis, usually a - // list of ColumnIdentifiers. + // list of ColumnIdentifiers . // // This member is required. ContributorDimensions []ColumnIdentifier @@ -2007,21 +1948,16 @@ type CustomActionSetParametersOperation struct { // The URL operation that opens a link to another webpage. type CustomActionURLOperation struct { - // The target of the CustomActionURLOperation. Valid values are defined as + // The target of the CustomActionURLOperation . Valid values are defined as // follows: - // - // * NEW_TAB: Opens the target URL in a new browser tab. - // - // * NEW_WINDOW: - // Opens the target URL in a new browser window. - // - // * SAME_TAB: Opens the target URL - // in the same browser tab. + // - NEW_TAB : Opens the target URL in a new browser tab. + // - NEW_WINDOW : Opens the target URL in a new browser window. + // - SAME_TAB : Opens the target URL in the same browser tab. // // This member is required. URLTarget URLTargetConfiguration - // THe URL link of the CustomActionURLOperation. + // THe URL link of the CustomActionURLOperation . // // This member is required. URLTemplate *string @@ -2029,7 +1965,7 @@ type CustomActionURLOperation struct { noSmithyDocumentSerde } -// The configuration of a CustomContentVisual. +// The configuration of a CustomContentVisual . type CustomContentConfiguration struct { // The content type of the custom content visual. You can use this to have the @@ -2041,20 +1977,19 @@ type CustomContentConfiguration struct { ContentUrl *string // The sizing options for the size of the custom content visual. This structure is - // required when the ContentType of the visual is 'IMAGE'. + // required when the ContentType of the visual is 'IMAGE' . ImageScaling CustomContentImageScalingConfiguration noSmithyDocumentSerde } // A visual that contains custom content. For more information, see Using custom -// visual content -// (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) +// visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) // in the Amazon QuickSight User Guide. type CustomContentVisual struct { - // The dataset that is used to create the custom content visual. You can't create a - // visual without a dataset. + // The dataset that is used to create the custom content visual. You can't create + // a visual without a dataset. // // This member is required. DataSetIdentifier *string @@ -2069,7 +2004,7 @@ type CustomContentVisual struct { // The list of custom actions that are configured for a visual. Actions []VisualCustomAction - // The configuration of a CustomContentVisual. + // The configuration of a CustomContentVisual . ChartConfiguration *CustomContentConfiguration // The subtitle that is displayed on the visual. @@ -2091,31 +2026,23 @@ type CustomFilterConfiguration struct { MatchOperator CategoryFilterMatchOperator // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption // The category value for the filter. This field is mutually exclusive to - // ParameterName. + // ParameterName . CategoryValue *string // The parameter whose value should be used for the filter value. This field is - // mutually exclusive to CategoryValue. + // mutually exclusive to CategoryValue . ParameterName *string // Select all of the values. Null is not the assigned value of select all. - // - // * - // FILTER_ALL_VALUES + // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions noSmithyDocumentSerde @@ -2130,15 +2057,9 @@ type CustomFilterListConfiguration struct { MatchOperator CategoryFilterMatchOperator // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption @@ -2147,9 +2068,7 @@ type CustomFilterListConfiguration struct { CategoryValues []string // Select all of the values. Null is not the assigned value of select all. - // - // * - // FILTER_ALL_VALUES + // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions noSmithyDocumentSerde @@ -2210,7 +2129,7 @@ type CustomSql struct { } // The configuration of custom values for the destination parameter in -// DestinationParameterValueConfiguration. +// DestinationParameterValueConfiguration . type CustomValuesConfiguration struct { // The customized parameter values. This is a union type structure. For this @@ -2302,8 +2221,8 @@ type DashboardPublishOptions struct { // The visual publish options of a visual in a dashboard. // - // Deprecated: VisualPublishOptions property will reach its end of standard support - // in a future release. To perform this action, use ExportWithHiddenFields. + // Deprecated: VisualPublishOptions property will reach its end of standard + // support in a future release. To perform this action, use ExportWithHiddenFields. VisualPublishOptions *DashboardVisualPublishOptions noSmithyDocumentSerde @@ -2313,55 +2232,44 @@ type DashboardPublishOptions struct { type DashboardSearchFilter struct { // The comparison operator that you want to use as a filter, for example - // "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If - // you set the operator value to "StringEquals", you need to provide an ownership - // related filter in the "NAME" field and the arn of the user or group whose - // folders you want to search in the "Value" field. For example, + // "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" . + // If you set the operator value to "StringEquals" , you need to provide an + // ownership related filter in the "NAME" field and the arn of the user or group + // whose folders you want to search in the "Value" field. For example, // "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to - // "StringLike", you need to provide the name of the folders you are searching for. - // For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". - // The "StringLike" operator only supports the NAME value DASHBOARD_NAME. + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value + // to "StringLike" , you need to provide the name of the folders you are searching + // for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": + // "Test" . The "StringLike" operator only supports the NAME value DASHBOARD_NAME . // // This member is required. Operator FilterOperator // The name of the value that you want to use as a filter, for example, "Name": - // "QUICKSIGHT_OWNER". Valid values are defined as follows: - // - // * - // QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // dashboards with that ARN listed as one of the dashboards's owners or viewers are - // returned. Implicit permissions from folders or groups are considered. - // - // * - // QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with - // that ARN listed as one of the owners of the dashboards are returned. Implicit - // permissions from folders or groups are considered. - // - // * - // DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any - // dashboards with that ARN listed as the only owner of the dashboard are returned. - // Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards - // with that ARN listed as one of the owners of the dashboards are returned. - // Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // dashboards with that ARN listed as one of the owners or viewers of the - // dashboards are returned. Implicit permissions from folders or groups are not - // considered. - // - // * DASHBOARD_NAME: Any dashboards whose names have a substring match - // to this value will be returned. + // "QUICKSIGHT_OWNER" . Valid values are defined as follows: + // - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any + // dashboards with that ARN listed as one of the dashboards's owners or viewers are + // returned. Implicit permissions from folders or groups are considered. + // - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any dashboards + // with that ARN listed as one of the owners of the dashboards are returned. + // Implicit permissions from folders or groups are considered. + // - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any + // dashboards with that ARN listed as the only owner of the dashboard are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any + // dashboards with that ARN listed as one of the owners of the dashboards are + // returned. Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and + // any dashboards with that ARN listed as one of the owners or viewers of the + // dashboards are returned. Implicit permissions from folders or groups are not + // considered. + // - DASHBOARD_NAME : Any dashboards whose names have a substring match to this + // value will be returned. Name DashboardFilterAttribute - // The value of the named item, in this case QUICKSIGHT_USER, that you want to use + // The value of the named item, in this case QUICKSIGHT_USER , that you want to use // as a filter, for example, "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . Value *string noSmithyDocumentSerde @@ -2478,16 +2386,14 @@ type DashboardVersionDefinition struct { // dashboard. ColumnConfigurations []ColumnConfiguration - // The filter definitions for a dashboard. For more information, see Filtering Data - // in Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the - // Amazon QuickSight User Guide. + // The filter definitions for a dashboard. For more information, see Filtering + // Data in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) + // in the Amazon QuickSight User Guide. FilterGroups []FilterGroup // The parameter declarations for a dashboard. Parameters are named variables that // can transfer a value for use by an action or an object. For more information, - // see Parameters in Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) + // see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) // in the Amazon QuickSight User Guide. ParameterDeclarations []ParameterDeclaration @@ -2522,20 +2428,14 @@ type DashboardVersionSummary struct { } // A structure that contains the following elements: +// - The DashboardId of the dashboard that has the visual that you want to embed. +// - The SheetId of the sheet that has the visual that you want to embed. +// - The VisualId of the visual that you want to embed. // -// * The DashboardId of the -// dashboard that has the visual that you want to embed. -// -// * The SheetId of the -// sheet that has the visual that you want to embed. -// -// * The VisualId of the visual -// that you want to embed. -// -// The DashboardId, SheetId, and VisualId can be found in -// the IDs for developers section of the Embed visual pane of the visual's -// on-visual menu of the Amazon QuickSight console. You can also get the -// DashboardId with a ListDashboards API operation. +// The DashboardId , SheetId , and VisualId can be found in the IDs for developers +// section of the Embed visual pane of the visual's on-visual menu of the Amazon +// QuickSight console. You can also get the DashboardId with a ListDashboards API +// operation. type DashboardVisualId struct { // The ID of the dashboard that has the visual that you want to embed. The @@ -2622,9 +2522,9 @@ type DataColor struct { noSmithyDocumentSerde } -// The theme colors that are used for data colors in charts. The colors description -// is a hexadecimal color code that consists of six alphanumerical characters, -// prefixed with #, for example #37BFF5. +// The theme colors that are used for data colors in charts. The colors +// description is a hexadecimal color code that consists of six alphanumerical +// characters, prefixed with # , for example #37BFF5. type DataColorPalette struct { // The hexadecimal codes for the colors. @@ -2821,8 +2721,8 @@ type DataSet struct { // Currently, only geospatial hierarchy is supported. ColumnGroups []ColumnGroup - // A set of one or more definitions of a ColumnLevelPermissionRule - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). + // A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html) + // . ColumnLevelPermissionRules []ColumnLevelPermissionRule // The amount of SPICE capacity used by this dataset. This is 0 if the dataset @@ -2942,56 +2842,45 @@ type DataSetSchema struct { type DataSetSearchFilter struct { // The name of the value that you want to use as a filter, for example, "Name": - // "QUICKSIGHT_OWNER". Valid values are defined as follows: - // - // * - // QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets - // with that ARN listed as one of the dataset owners or viewers are returned. - // Implicit permissions from folders or groups are considered. - // - // * QUICKSIGHT_OWNER: - // Provide an ARN of a user or group, and any datasets with that ARN listed as one - // of the owners of the dataset are returned. Implicit permissions from folders or - // groups are considered. - // - // * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user - // or group, and any datasets with that ARN listed as the only owner of the dataset - // are returned. Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets - // with that ARN listed as one of the owners if the dataset are returned. Implicit - // permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // datasets with that ARN listed as one of the owners or viewers of the dataset are - // returned. Implicit permissions from folders or groups are not considered. - // - // * - // DATASET_NAME: Any datasets whose names have a substring match to this value will - // be returned. + // "QUICKSIGHT_OWNER" . Valid values are defined as follows: + // - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any + // datasets with that ARN listed as one of the dataset owners or viewers are + // returned. Implicit permissions from folders or groups are considered. + // - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with + // that ARN listed as one of the owners of the dataset are returned. Implicit + // permissions from folders or groups are considered. + // - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any + // datasets with that ARN listed as the only owner of the dataset are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any + // datasets with that ARN listed as one of the owners if the dataset are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and + // any datasets with that ARN listed as one of the owners or viewers of the dataset + // are returned. Implicit permissions from folders or groups are not considered. + // - DATASET_NAME : Any datasets whose names have a substring match to this value + // will be returned. // // This member is required. Name DataSetFilterAttribute // The comparison operator that you want to use as a filter, for example - // "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If - // you set the operator value to "StringEquals", you need to provide an ownership - // related filter in the "NAME" field and the arn of the user or group whose - // datasets you want to search in the "Value" field. For example, + // "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" . + // If you set the operator value to "StringEquals" , you need to provide an + // ownership related filter in the "NAME" field and the arn of the user or group + // whose datasets you want to search in the "Value" field. For example, // "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": - // "arn:aws:quicksight:us-east- 1:1:user/default/UserName1". If you set the value - // to "StringLike", you need to provide the name of the datasets you are searching + // "arn:aws:quicksight:us-east- 1:1:user/default/UserName1" . If you set the value + // to "StringLike" , you need to provide the name of the datasets you are searching // for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": - // "Test". The "StringLike" operator only supports the NAME value DATASET_NAME. + // "Test" . The "StringLike" operator only supports the NAME value DATASET_NAME . // // This member is required. Operator FilterOperator - // The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use - // as a filter, for example, "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". + // The value of the named item, in this case QUICKSIGHT_OWNER , that you want to + // use as a filter, for example, "Value": + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . // // This member is required. Value *string @@ -3057,8 +2946,8 @@ type DataSource struct { // that's in the request with the structures in the AlternateDataSourceParameters // allow list. If the structures are an exact match, the request is allowed to use // the credentials from this existing data source. If the - // AlternateDataSourceParameters list is null, the Credentials originally used with - // this DataSourceParameters are automatically allowed. + // AlternateDataSourceParameters list is null, the Credentials originally used + // with this DataSourceParameters are automatically allowed. AlternateDataSourceParameters []DataSourceParameters // The Amazon Resource Name (ARN) of the data source. @@ -3071,9 +2960,9 @@ type DataSource struct { // each Amazon Web Services account. DataSourceId *string - // The parameters that Amazon QuickSight uses to connect to your underlying source. - // This is a variant type structure. For this structure to be valid, only one of - // the attributes can be non-null. + // The parameters that Amazon QuickSight uses to connect to your underlying + // source. This is a variant type structure. For this structure to be valid, only + // one of the attributes can be non-null. DataSourceParameters DataSourceParameters // Error information from the last update or the creation of the data source. @@ -3108,8 +2997,8 @@ type DataSource struct { noSmithyDocumentSerde } -// Data source credentials. This is a variant type structure. For this structure to -// be valid, only one of the attributes can be non-null. +// Data source credentials. This is a variant type structure. For this structure +// to be valid, only one of the attributes can be non-null. type DataSourceCredentials struct { // The Amazon Resource Name (ARN) of a data source that has the credential pair @@ -3118,8 +3007,8 @@ type DataSourceCredentials struct { // DataSourceCredentials structure. CopySourceArn *string - // Credential pair. For more information, see CredentialPair - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html). + // Credential pair. For more information, see CredentialPair (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) + // . CredentialPair *CredentialPair // The Amazon Resource Name (ARN) of the secret associated with the data source in @@ -3385,47 +3274,41 @@ func (*DataSourceParametersMemberTwitterParameters) isDataSourceParameters() {} type DataSourceSearchFilter struct { // The name of the value that you want to use as a filter, for example, "Name": - // "DIRECT_QUICKSIGHT_OWNER". Valid values are defined as follows: - // - // * - // DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // data sources with that ARN listed as one of the owners or viewers of the data - // sources are returned. Implicit permissions from folders or groups are not - // considered. - // - // * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and - // any data sources with that ARN listed as one of the owners if the data source - // are returned. Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data - // sources with that ARN listed as the only owner of the data source are returned. - // Implicit permissions from folders or groups are not considered. - // - // * - // DATASOURCE_NAME: Any data sources whose names have a substring match to the - // provided value are returned. + // "DIRECT_QUICKSIGHT_OWNER" . Valid values are defined as follows: + // - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and + // any data sources with that ARN listed as one of the owners or viewers of the + // data sources are returned. Implicit permissions from folders or groups are not + // considered. + // - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any data + // sources with that ARN listed as one of the owners if the data source are + // returned. Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any + // data sources with that ARN listed as the only owner of the data source are + // returned. Implicit permissions from folders or groups are not considered. + // - DATASOURCE_NAME : Any data sources whose names have a substring match to the + // provided value are returned. // // This member is required. Name DataSourceFilterAttribute // The comparison operator that you want to use as a filter, for example - // "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If - // you set the operator value to "StringEquals", you need to provide an ownership - // related filter in the "NAME" field and the arn of the user or group whose data - // sources you want to search in the "Value" field. For example, + // "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" . + // If you set the operator value to "StringEquals" , you need to provide an + // ownership related filter in the "NAME" field and the arn of the user or group + // whose data sources you want to search in the "Value" field. For example, // "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to - // "StringLike", you need to provide the name of the data sources you are searching - // for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": - // "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME. + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value + // to "StringLike" , you need to provide the name of the data sources you are + // searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", + // "Value": "Test" . The "StringLike" operator only supports the NAME value + // DATASOURCE_NAME . // // This member is required. Operator FilterOperator - // The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want + // The value of the named item, for example DIRECT_QUICKSIGHT_OWNER , that you want // to use as a filter, for example, "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . // // This member is required. Value *string @@ -3471,7 +3354,7 @@ type DateAxisOptions struct { // The dimension type field with date type columns. type DateDimensionField struct { - // The column that is used in the DateDimensionField. + // The column that is used in the DateDimensionField . // // This member is required. Column *ColumnIdentifier @@ -3481,27 +3364,17 @@ type DateDimensionField struct { // This member is required. FieldId *string - // The date granularity of the DateDimensionField. Choose one of the following + // The date granularity of the DateDimensionField . Choose one of the following // options: - // - // * YEAR - // - // * QUARTER - // - // * MONTH - // - // * WEEK - // - // * DAY - // - // * HOUR - // - // * MINUTE - // - // * - // SECOND - // - // * MILLISECOND + // - YEAR + // - QUARTER + // - MONTH + // - WEEK + // - DAY + // - HOUR + // - MINUTE + // - SECOND + // - MILLISECOND DateGranularity TimeGranularity // The format configuration of the field. @@ -3516,7 +3389,7 @@ type DateDimensionField struct { // The measure type field with date type columns. type DateMeasureField struct { - // The column that is used in the DateMeasureField. + // The column that is used in the DateMeasureField . // // This member is required. Column *ColumnIdentifier @@ -3535,18 +3408,18 @@ type DateMeasureField struct { noSmithyDocumentSerde } -// The default values of the DateTimeParameterDeclaration. +// The default values of the DateTimeParameterDeclaration . type DateTimeDefaultValues struct { - // The dynamic value of the DataTimeDefaultValues. Different defaults are displayed - // according to users, groups, and values mapping. + // The dynamic value of the DataTimeDefaultValues . Different defaults are + // displayed according to users, groups, and values mapping. DynamicValue *DynamicDefaultValue - // The rolling date of the DataTimeDefaultValues. The date is determined from the + // The rolling date of the DataTimeDefaultValues . The date is determined from the // dataset based on input expression. RollingDate *RollingDateConfiguration - // The static values of the DataTimeDefaultValues. + // The static values of the DataTimeDefaultValues . StaticValues []time.Time noSmithyDocumentSerde @@ -3605,8 +3478,8 @@ type DateTimeParameterDeclaration struct { // This member is required. Name *string - // The default values of a parameter. If the parameter is a single-value parameter, - // a maximum of one default value can be provided. + // The default values of a parameter. If the parameter is a single-value + // parameter, a maximum of one default value can be provided. DefaultValues *DateTimeDefaultValues // The level of time precision that is used to aggregate DateTime values. @@ -3638,25 +3511,22 @@ type DateTimeValueWhenUnsetConfiguration struct { // A custom value that's used when the value of a parameter isn't set. CustomValue *time.Time - // The built-in options for default values. The value can be one of the - // following: - // - // * RECOMMENDED: The recommended value. - // - // * NULL: The NULL value. + // The built-in options for default values. The value can be one of the following: + // - RECOMMENDED : The recommended value. + // - NULL : The NULL value. ValueWhenUnsetOption ValueWhenUnsetOption noSmithyDocumentSerde } -// The default values of the DecimalParameterDeclaration. +// The default values of the DecimalParameterDeclaration . type DecimalDefaultValues struct { - // The dynamic value of the DecimalDefaultValues. Different defaults are displayed + // The dynamic value of the DecimalDefaultValues . Different defaults are displayed // according to users, groups, and values mapping. DynamicValue *DynamicDefaultValue - // The static values of the DecimalDefaultValues. + // The static values of the DecimalDefaultValues . StaticValues []float64 noSmithyDocumentSerde @@ -3686,14 +3556,14 @@ type DecimalParameterDeclaration struct { // This member is required. Name *string - // The value type determines whether the parameter is a single-value or multi-value - // parameter. + // The value type determines whether the parameter is a single-value or + // multi-value parameter. // // This member is required. ParameterValueType ParameterValueType - // The default values of a parameter. If the parameter is a single-value parameter, - // a maximum of one default value can be provided. + // The default values of a parameter. If the parameter is a single-value + // parameter, a maximum of one default value can be provided. DefaultValues *DecimalDefaultValues // The configuration that defines the default value of a Decimal parameter when a @@ -3721,12 +3591,9 @@ type DecimalValueWhenUnsetConfiguration struct { // A custom value that's used when the value of a parameter isn't set. CustomValue *float64 - // The built-in options for default values. The value can be one of the - // following: - // - // * RECOMMENDED: The recommended value. - // - // * NULL: The NULL value. + // The built-in options for default values. The value can be one of the following: + // - RECOMMENDED : The recommended value. + // - NULL : The NULL value. ValueWhenUnsetOption ValueWhenUnsetOption noSmithyDocumentSerde @@ -3815,7 +3682,7 @@ type DefaultSectionBasedLayoutConfiguration struct { type DestinationParameterValueConfiguration struct { // The configuration of custom values for destination parameter in - // DestinationParameterValueConfiguration. + // DestinationParameterValueConfiguration . CustomValuesConfiguration *CustomValuesConfiguration // The configuration that selects all options. @@ -3845,12 +3712,12 @@ type DimensionField struct { noSmithyDocumentSerde } -// The label options of the label that is displayed in the center of a donut chart. -// This option isn't available for pie charts. +// The label options of the label that is displayed in the center of a donut +// chart. This option isn't available for pie charts. type DonutCenterOptions struct { // Determines the visibility of the label in a donut chart. In the Amazon - // QuickSight console, this option is called 'Show total'. + // QuickSight console, this option is called 'Show total' . LabelVisibility Visibility noSmithyDocumentSerde @@ -3859,21 +3726,15 @@ type DonutCenterOptions struct { // The options for configuring a donut chart or pie chart. type DonutOptions struct { - // The option for define the arc of the chart shape. Valid values are as - // follows: - // - // * WHOLE - A pie chart - // - // * SMALL- A small-sized donut chart - // - // * MEDIUM- A - // medium-sized donut chart - // - // * LARGE- A large-sized donut chart + // The option for define the arc of the chart shape. Valid values are as follows: + // - WHOLE - A pie chart + // - SMALL - A small-sized donut chart + // - MEDIUM - A medium-sized donut chart + // - LARGE - A large-sized donut chart ArcOptions *ArcOptions - // The label options of the label that is displayed in the center of a donut chart. - // This option isn't available for pie charts. + // The label options of the label that is displayed in the center of a donut + // chart. This option isn't available for pie charts. DonutCenterOptions *DonutCenterOptions noSmithyDocumentSerde @@ -3888,8 +3749,8 @@ type DrillDownFilter struct { // columns. CategoryFilter *CategoryDrillDownFilter - // The numeric equality type drill down filter. This filter is used for number type - // columns. + // The numeric equality type drill down filter. This filter is used for number + // type columns. NumericEqualityFilter *NumericEqualityDrillDownFilter // The time range drill down filter. This filter is used for date time columns. @@ -3989,7 +3850,7 @@ type ExasolParameters struct { noSmithyDocumentSerde } -// The exclude period of TimeRangeFilter or RelativeDatesFilter. +// The exclude period of TimeRangeFilter or RelativeDatesFilter . type ExcludePeriodConfiguration struct { // The amount or number of the exclude period. @@ -4003,11 +3864,8 @@ type ExcludePeriodConfiguration struct { Granularity TimeGranularity // The status of the exclude period. Choose from the following options: - // - // * - // ENABLED - // - // * DISABLED + // - ENABLED + // - DISABLED Status WidgetStatus noSmithyDocumentSerde @@ -4063,19 +3921,15 @@ type ExportWithHiddenFieldsOption struct { // The setup for the detailed tooltip. type FieldBasedTooltip struct { - // The visibility of Show aggregations. + // The visibility of Show aggregations . AggregationVisibility Visibility // The fields configuration in the tooltip. TooltipFields []TooltipItem // The type for the >tooltip title. Choose one of the following options: - // - // * NONE: - // Doesn't use the primary value as the title. - // - // * PRIMARY_VALUE: Uses primary value - // as the title. + // - NONE : Doesn't use the primary value as the title. + // - PRIMARY_VALUE : Uses primary value as the title. TooltipTitleType TooltipTitleType noSmithyDocumentSerde @@ -4129,11 +3983,8 @@ type FieldSeriesItem struct { type FieldSort struct { // The sort direction. Choose one of the following options: - // - // * ASC: Ascending - // - // * - // DESC: Descending + // - ASC : Ascending + // - DESC : Descending // // This member is required. Direction SortDirection @@ -4189,10 +4040,10 @@ type FilledMapAggregatedFieldWells struct { noSmithyDocumentSerde } -// The conditional formatting of a FilledMapVisual. +// The conditional formatting of a FilledMapVisual . type FilledMapConditionalFormatting struct { - // Conditional formatting options of a FilledMapVisual. + // Conditional formatting options of a FilledMapVisual . // // This member is required. ConditionalFormattingOptions []FilledMapConditionalFormattingOption @@ -4200,7 +4051,7 @@ type FilledMapConditionalFormatting struct { noSmithyDocumentSerde } -// Conditional formatting options of a FilledMapVisual. +// Conditional formatting options of a FilledMapVisual . type FilledMapConditionalFormattingOption struct { // The conditional formatting that determines the shape of the filled map. @@ -4211,7 +4062,7 @@ type FilledMapConditionalFormattingOption struct { noSmithyDocumentSerde } -// The configuration for a FilledMapVisual. +// The configuration for a FilledMapVisual . type FilledMapConfiguration struct { // The field wells of the visual. @@ -4223,7 +4074,7 @@ type FilledMapConfiguration struct { // The map style options of the filled map visual. MapStyleOptions *GeospatialMapStyleOptions - // The sort configuration of a FilledMapVisual. + // The sort configuration of a FilledMapVisual . SortConfiguration *FilledMapSortConfiguration // The tooltip display setup of the visual. @@ -4235,7 +4086,7 @@ type FilledMapConfiguration struct { noSmithyDocumentSerde } -// The field wells of a FilledMapVisual. This is a union type structure. For this +// The field wells of a FilledMapVisual . This is a union type structure. For this // structure to be valid, only one of the attributes can be defined. type FilledMapFieldWells struct { @@ -4260,7 +4111,7 @@ type FilledMapShapeConditionalFormatting struct { noSmithyDocumentSerde } -// The sort configuration of a FilledMapVisual. +// The sort configuration of a FilledMapVisual . type FilledMapSortConfiguration struct { // The sort configuration of the location fields. @@ -4269,9 +4120,8 @@ type FilledMapSortConfiguration struct { noSmithyDocumentSerde } -// A filled map. For more information, see Creating filled maps -// (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the -// Amazon QuickSight User Guide. +// A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) +// in the Amazon QuickSight User Guide. type FilledMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -4290,7 +4140,7 @@ type FilledMapVisual struct { // The column hierarchy that is used during drill-downs and drill-ups. ColumnHierarchies []ColumnHierarchy - // The conditional formatting of a FilledMapVisual. + // The conditional formatting of a FilledMapVisual . ConditionalFormatting *FilledMapConditionalFormatting // The subtitle that is displayed on the visual. @@ -4302,14 +4152,13 @@ type FilledMapVisual struct { noSmithyDocumentSerde } -// With a Filter, you can remove portions of data from a particular visual or view. -// This is a union type structure. For this structure to be valid, only one of the -// attributes can be defined. +// With a Filter , you can remove portions of data from a particular visual or +// view. This is a union type structure. For this structure to be valid, only one +// of the attributes can be defined. type Filter struct { // A CategoryFilter filters text values. For more information, see Adding text - // filters - // (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) + // filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) // in the Amazon QuickSight User Guide. CategoryFilter *CategoryFilter @@ -4324,8 +4173,8 @@ type Filter struct { // A RelativeDatesFilter filters date values that are relative to a given date. RelativeDatesFilter *RelativeDatesFilter - // A TimeEqualityFilter filters date-time values that equal or do not equal a given - // date/time value. + // A TimeEqualityFilter filters date-time values that equal or do not equal a + // given date/time value. TimeEqualityFilter *TimeEqualityFilter // A TimeRangeFilter filters date-time values that are either inside or outside a @@ -4350,8 +4199,8 @@ type FilterControl struct { // single value. Dropdown *FilterDropDownControl - // A control to display a list of buttons or boxes. This is used to select either a - // single value or multiple values. + // A control to display a list of buttons or boxes. This is used to select either + // a single value or multiple values. List *FilterListControl // A control from a date filter that is used to specify the relative date. @@ -4373,17 +4222,17 @@ type FilterControl struct { // A control from a date filter that is used to specify date and time. type FilterDateTimePickerControl struct { - // The ID of the FilterDateTimePickerControl. + // The ID of the FilterDateTimePickerControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterDateTimePickerControl. + // The source filter ID of the FilterDateTimePickerControl . // // This member is required. SourceFilterId *string - // The title of the FilterDateTimePickerControl. + // The title of the FilterDateTimePickerControl . // // This member is required. Title *string @@ -4391,13 +4240,10 @@ type FilterDateTimePickerControl struct { // The display options of a control. DisplayOptions *DateTimePickerControlDisplayOptions - // The date time picker type of a FilterDateTimePickerControl. Choose one of the + // The date time picker type of a FilterDateTimePickerControl . Choose one of the // following options: - // - // * SINGLE_VALUED: The filter condition is a fixed date. - // - // * - // DATE_RANGE: The filter condition is a date time range. + // - SINGLE_VALUED : The filter condition is a fixed date. + // - DATE_RANGE : The filter condition is a date time range. Type SheetControlDateTimePickerType noSmithyDocumentSerde @@ -4407,56 +4253,49 @@ type FilterDateTimePickerControl struct { // single value. type FilterDropDownControl struct { - // The ID of the FilterDropDownControl. + // The ID of the FilterDropDownControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterDropDownControl. + // The source filter ID of the FilterDropDownControl . // // This member is required. SourceFilterId *string - // The title of the FilterDropDownControl. + // The title of the FilterDropDownControl . // // This member is required. Title *string - // The values that are displayed in a control can be configured to only show values - // that are valid based on what's selected in other controls. + // The values that are displayed in a control can be configured to only show + // values that are valid based on what's selected in other controls. CascadingControlConfiguration *CascadingControlConfiguration - // The display options of the FilterDropDownControl. + // The display options of the FilterDropDownControl . DisplayOptions *DropDownControlDisplayOptions // A list of selectable values that are used in a control. SelectableValues *FilterSelectableValues - // The type of the FilterDropDownControl. Choose one of the following options: - // - // * - // MULTI_SELECT: The user can select multiple entries from a dropdown menu. - // - // * - // SINGLE_SELECT: The user can select a single entry from a dropdown menu. + // The type of the FilterDropDownControl . Choose one of the following options: + // - MULTI_SELECT : The user can select multiple entries from a dropdown menu. + // - SINGLE_SELECT : The user can select a single entry from a dropdown menu. Type SheetControlListType noSmithyDocumentSerde } -// A grouping of individual filters. Filter groups are applied to the same group of -// visuals. For more information, see Adding filter conditions (group filters) with -// AND and OR operators -// (https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) +// A grouping of individual filters. Filter groups are applied to the same group +// of visuals. For more information, see Adding filter conditions (group filters) +// with AND and OR operators (https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) // in the Amazon QuickSight User Guide. type FilterGroup struct { - // The filter new feature which can apply filter group to all data sets. Choose one - // of the following options: - // - // * ALL_DATASETS - // - // * SINGLE_DATASET + // The filter new feature which can apply filter group to all data sets. Choose + // one of the following options: + // - ALL_DATASETS + // - SINGLE_DATASET // // This member is required. CrossDataset CrossDatasetTypes @@ -4467,19 +4306,19 @@ type FilterGroup struct { // This member is required. FilterGroupId *string - // The list of filters that are present in a FilterGroup. + // The list of filters that are present in a FilterGroup . // // This member is required. Filters []Filter - // The configuration that specifies what scope to apply to a FilterGroup. This is a - // union type structure. For this structure to be valid, only one of the attributes - // can be defined. + // The configuration that specifies what scope to apply to a FilterGroup . This is + // a union type structure. For this structure to be valid, only one of the + // attributes can be defined. // // This member is required. ScopeConfiguration *FilterScopeConfiguration - // The status of the FilterGroup. + // The status of the FilterGroup . Status WidgetStatus noSmithyDocumentSerde @@ -4497,35 +4336,33 @@ type FilterListConfiguration struct { CategoryValues []string // Select all of the values. Null is not the assigned value of select all. - // - // * - // FILTER_ALL_VALUES + // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions noSmithyDocumentSerde } -// A control to display a list of buttons or boxes. This is used to select either a -// single value or multiple values. +// A control to display a list of buttons or boxes. This is used to select either +// a single value or multiple values. type FilterListControl struct { - // The ID of the FilterListControl. + // The ID of the FilterListControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterListControl. + // The source filter ID of the FilterListControl . // // This member is required. SourceFilterId *string - // The title of the FilterListControl. + // The title of the FilterListControl . // // This member is required. Title *string - // The values that are displayed in a control can be configured to only show values - // that are valid based on what's selected in other controls. + // The values that are displayed in a control can be configured to only show + // values that are valid based on what's selected in other controls. CascadingControlConfiguration *CascadingControlConfiguration // The display options of a control. @@ -4534,13 +4371,9 @@ type FilterListControl struct { // A list of selectable values that are used in a control. SelectableValues *FilterSelectableValues - // The type of FilterListControl. Choose one of the following options: - // - // * - // MULTI_SELECT: The user can select multiple entries from the list. - // - // * - // SINGLE_SELECT: The user can select a single entry from the list. + // The type of FilterListControl . Choose one of the following options: + // - MULTI_SELECT : The user can select multiple entries from the list. + // - SINGLE_SELECT : The user can select a single entry from the list. Type SheetControlListType noSmithyDocumentSerde @@ -4558,19 +4391,17 @@ type FilterOperation struct { noSmithyDocumentSerde } -// The configuration of selected fields in theCustomActionFilterOperation. This is -// a union type structure. For this structure to be valid, only one of the +// The configuration of selected fields in the CustomActionFilterOperation . This +// is a union type structure. For this structure to be valid, only one of the // attributes can be defined. type FilterOperationSelectedFieldsConfiguration struct { // A structure that contains the options that choose which fields are filtered in - // the CustomActionFilterOperation. Valid values are defined as follows: - // - // * - // ALL_FIELDS: Applies the filter operation to all fields. + // the CustomActionFilterOperation . Valid values are defined as follows: + // - ALL_FIELDS : Applies the filter operation to all fields. SelectedFieldOptions SelectedFieldOptions - // Chooses the fields that are filtered in CustomActionFilterOperation. + // Chooses the fields that are filtered in CustomActionFilterOperation . SelectedFields []string noSmithyDocumentSerde @@ -4590,17 +4421,17 @@ type FilterOperationTargetVisualsConfiguration struct { // A control from a date filter that is used to specify the relative date. type FilterRelativeDateTimeControl struct { - // The ID of the FilterTextAreaControl. + // The ID of the FilterTextAreaControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterTextAreaControl. + // The source filter ID of the FilterTextAreaControl . // // This member is required. SourceFilterId *string - // The title of the FilterTextAreaControl. + // The title of the FilterTextAreaControl . // // This member is required. Title *string @@ -4611,7 +4442,7 @@ type FilterRelativeDateTimeControl struct { noSmithyDocumentSerde } -// The scope configuration for a FilterGroup. This is a union type structure. For +// The scope configuration for a FilterGroup . This is a union type structure. For // this structure to be valid, only one of the attributes can be defined. type FilterScopeConfiguration struct { @@ -4624,7 +4455,7 @@ type FilterScopeConfiguration struct { // A list of selectable values that are used in a control. type FilterSelectableValues struct { - // The values that are used in the FilterSelectableValues. + // The values that are used in the FilterSelectableValues . Values []string noSmithyDocumentSerde @@ -4634,7 +4465,7 @@ type FilterSelectableValues struct { // sliding the toggle. type FilterSliderControl struct { - // The ID of the FilterSliderControl. + // The ID of the FilterSliderControl . // // This member is required. FilterControlId *string @@ -4649,7 +4480,7 @@ type FilterSliderControl struct { // This member is required. MinimumValue float64 - // The source filter ID of the FilterSliderControl. + // The source filter ID of the FilterSliderControl . // // This member is required. SourceFilterId *string @@ -4659,7 +4490,7 @@ type FilterSliderControl struct { // This member is required. StepSize float64 - // The title of the FilterSliderControl. + // The title of the FilterSliderControl . // // This member is required. Title *string @@ -4667,13 +4498,9 @@ type FilterSliderControl struct { // The display options of a control. DisplayOptions *SliderControlDisplayOptions - // The type of FilterSliderControl. Choose one of the following options: - // - // * - // SINGLE_POINT: Filter against(equals) a single data point. - // - // * RANGE: Filter data - // that is in a specified range. + // The type of FilterSliderControl . Choose one of the following options: + // - SINGLE_POINT : Filter against(equals) a single data point. + // - RANGE : Filter data that is in a specified range. Type SheetControlSliderType noSmithyDocumentSerde @@ -4682,17 +4509,17 @@ type FilterSliderControl struct { // A control to display a text box that is used to enter multiple entries. type FilterTextAreaControl struct { - // The ID of the FilterTextAreaControl. + // The ID of the FilterTextAreaControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterTextAreaControl. + // The source filter ID of the FilterTextAreaControl . // // This member is required. SourceFilterId *string - // The title of the FilterTextAreaControl. + // The title of the FilterTextAreaControl . // // This member is required. Title *string @@ -4709,17 +4536,17 @@ type FilterTextAreaControl struct { // A control to display a text box that is used to enter a single entry. type FilterTextFieldControl struct { - // The ID of the FilterTextFieldControl. + // The ID of the FilterTextFieldControl . // // This member is required. FilterControlId *string - // The source filter ID of the FilterTextFieldControl. + // The source filter ID of the FilterTextFieldControl . // // This member is required. SourceFilterId *string - // The title of the FilterTextFieldControl. + // The title of the FilterTextFieldControl . // // This member is required. Title *string @@ -4774,57 +4601,44 @@ type FolderMember struct { type FolderSearchFilter struct { // The name of a value that you want to use in the filter. For example, "Name": - // "QUICKSIGHT_OWNER". Valid values are defined as follows: - // - // * - // QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders - // with that ARN listed as one of the folder's owners or viewers are returned. - // Implicit permissions from folders or groups are considered. - // - // * QUICKSIGHT_OWNER: - // Provide an ARN of a user or group, and any folders with that ARN listed as one - // of the owners of the folders are returned. Implicit permissions from folders or - // groups are considered. - // - // * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user - // or group, and any folders with that ARN listed as the only owner of the folder - // are returned. Implicit permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with - // that ARN listed as one of the owners of the folders are returned. Implicit - // permissions from folders or groups are not considered. - // - // * - // DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any - // folders with that ARN listed as one of the owners or viewers of the folders are - // returned. Implicit permissions from folders or groups are not considered. - // - // * - // FOLDER_NAME: Any folders whose names have a substring match to this value will - // be returned. - // - // * PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders - // that are directly under that parent folder are returned. If you choose to use - // this option and leave the value blank, all root-level folders in the account are - // returned. + // "QUICKSIGHT_OWNER" . Valid values are defined as follows: + // - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any + // folders with that ARN listed as one of the folder's owners or viewers are + // returned. Implicit permissions from folders or groups are considered. + // - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with + // that ARN listed as one of the owners of the folders are returned. Implicit + // permissions from folders or groups are considered. + // - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any + // folders with that ARN listed as the only owner of the folder are returned. + // Implicit permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders + // with that ARN listed as one of the owners of the folders are returned. Implicit + // permissions from folders or groups are not considered. + // - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and + // any folders with that ARN listed as one of the owners or viewers of the folders + // are returned. Implicit permissions from folders or groups are not considered. + // - FOLDER_NAME : Any folders whose names have a substring match to this value + // will be returned. + // - PARENT_FOLDER_ARN : Provide an ARN of a folder, and any folders that are + // directly under that parent folder are returned. If you choose to use this option + // and leave the value blank, all root-level folders in the account are returned. Name FolderFilterAttribute // The comparison operator that you want to use as a filter, for example - // "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If - // you set the operator value to "StringEquals", you need to provide an ownership - // related filter in the "NAME" field and the arn of the user or group whose - // folders you want to search in the "Value" field. For example, + // "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" . + // If you set the operator value to "StringEquals" , you need to provide an + // ownership related filter in the "NAME" field and the arn of the user or group + // whose folders you want to search in the "Value" field. For example, // "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": - // "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to - // "StringLike", you need to provide the name of the folders you are searching for. - // For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". - // The "StringLike" operator only supports the NAME value FOLDER_NAME. + // "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value + // to "StringLike" , you need to provide the name of the folders you are searching + // for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": + // "Test" . The "StringLike" operator only supports the NAME value FOLDER_NAME . Operator FilterOperator - // The value of the named item (in this example, PARENT_FOLDER_ARN), that you want + // The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want // to use as a filter. For example, "Value": - // "arn:aws:quicksight:us-east-1:1:folder/folderId". + // "arn:aws:quicksight:us-east-1:1:folder/folderId" . Value *string noSmithyDocumentSerde @@ -4935,10 +4749,8 @@ type ForecastComputation struct { // The seasonality setup of a forecast computation. Choose one of the following // options: - // - // * AUTOMATIC - // - // * CUSTOM: Checks the custom seasonality value. + // - AUTOMATIC + // - CUSTOM : Checks the custom seasonality value. Seasonality ForecastComputationSeasonality // The upper boundary setup of a forecast computation. @@ -5114,7 +4926,7 @@ type FreeFormSectionLayoutConfiguration struct { noSmithyDocumentSerde } -// The field well configuration of a FunnelChartVisual. +// The field well configuration of a FunnelChartVisual . type FunnelChartAggregatedFieldWells struct { // The category field wells of a funnel chart. Values are grouped by category @@ -5128,28 +4940,28 @@ type FunnelChartAggregatedFieldWells struct { noSmithyDocumentSerde } -// The configuration of a FunnelChartVisual. +// The configuration of a FunnelChartVisual . type FunnelChartConfiguration struct { - // The label options of the categories that are displayed in a FunnelChartVisual. + // The label options of the categories that are displayed in a FunnelChartVisual . CategoryLabelOptions *ChartAxisLabelOptions // The options that determine the presentation of the data labels. DataLabelOptions *FunnelChartDataLabelOptions - // The field well configuration of a FunnelChartVisual. + // The field well configuration of a FunnelChartVisual . FieldWells *FunnelChartFieldWells - // The sort configuration of a FunnelChartVisual. + // The sort configuration of a FunnelChartVisual . SortConfiguration *FunnelChartSortConfiguration - // The tooltip configuration of a FunnelChartVisual. + // The tooltip configuration of a FunnelChartVisual . Tooltip *TooltipOptions - // The label options for the values that are displayed in a FunnelChartVisual. + // The label options for the values that are displayed in a FunnelChartVisual . ValueLabelOptions *ChartAxisLabelOptions - // The visual palette configuration of a FunnelChartVisual. + // The visual palette configuration of a FunnelChartVisual . VisualPalette *VisualPalette noSmithyDocumentSerde @@ -5184,18 +4996,18 @@ type FunnelChartDataLabelOptions struct { noSmithyDocumentSerde } -// The field well configuration of a FunnelChartVisual. This is a union type +// The field well configuration of a FunnelChartVisual . This is a union type // structure. For this structure to be valid, only one of the attributes can be // defined. type FunnelChartFieldWells struct { - // The field well configuration of a FunnelChartVisual. + // The field well configuration of a FunnelChartVisual . FunnelChartAggregatedFieldWells *FunnelChartAggregatedFieldWells noSmithyDocumentSerde } -// The sort configuration of a FunnelChartVisual. +// The sort configuration of a FunnelChartVisual . type FunnelChartSortConfiguration struct { // The limit on the number of categories displayed. @@ -5207,8 +5019,7 @@ type FunnelChartSortConfiguration struct { noSmithyDocumentSerde } -// A funnel chart. For more information, see Using funnel charts -// (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) +// A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) // in the Amazon QuickSight User Guide. type FunnelChartVisual struct { @@ -5222,7 +5033,7 @@ type FunnelChartVisual struct { // The list of custom actions that are configured for a visual. Actions []VisualCustomAction - // The configuration of a FunnelChartVisual. + // The configuration of a FunnelChartVisual . ChartConfiguration *FunnelChartConfiguration // The column hierarchy that is used during drill-downs and drill-ups. @@ -5237,7 +5048,7 @@ type FunnelChartVisual struct { noSmithyDocumentSerde } -// The options that determine the presentation of the arc of a GaugeChartVisual. +// The options that determine the presentation of the arc of a GaugeChartVisual . type GaugeChartArcConditionalFormatting struct { // The conditional formatting of the arc foreground color. @@ -5246,70 +5057,70 @@ type GaugeChartArcConditionalFormatting struct { noSmithyDocumentSerde } -// The conditional formatting of a GaugeChartVisual. +// The conditional formatting of a GaugeChartVisual . type GaugeChartConditionalFormatting struct { - // Conditional formatting options of a GaugeChartVisual. + // Conditional formatting options of a GaugeChartVisual . ConditionalFormattingOptions []GaugeChartConditionalFormattingOption noSmithyDocumentSerde } -// Conditional formatting options of a GaugeChartVisual. +// Conditional formatting options of a GaugeChartVisual . type GaugeChartConditionalFormattingOption struct { - // The options that determine the presentation of the arc of a GaugeChartVisual. + // The options that determine the presentation of the arc of a GaugeChartVisual . Arc *GaugeChartArcConditionalFormatting - // The conditional formatting for the primary value of a GaugeChartVisual. + // The conditional formatting for the primary value of a GaugeChartVisual . PrimaryValue *GaugeChartPrimaryValueConditionalFormatting noSmithyDocumentSerde } -// The configuration of a GaugeChartVisual. +// The configuration of a GaugeChartVisual . type GaugeChartConfiguration struct { - // The data label configuration of a GaugeChartVisual. + // The data label configuration of a GaugeChartVisual . DataLabels *DataLabelOptions - // The field well configuration of a GaugeChartVisual. + // The field well configuration of a GaugeChartVisual . FieldWells *GaugeChartFieldWells - // The options that determine the presentation of the GaugeChartVisual. + // The options that determine the presentation of the GaugeChartVisual . GaugeChartOptions *GaugeChartOptions - // The tooltip configuration of a GaugeChartVisual. + // The tooltip configuration of a GaugeChartVisual . TooltipOptions *TooltipOptions - // The visual palette configuration of a GaugeChartVisual. + // The visual palette configuration of a GaugeChartVisual . VisualPalette *VisualPalette noSmithyDocumentSerde } -// The field well configuration of a GaugeChartVisual. +// The field well configuration of a GaugeChartVisual . type GaugeChartFieldWells struct { - // The target value field wells of a GaugeChartVisual. + // The target value field wells of a GaugeChartVisual . TargetValues []MeasureField - // The value field wells of a GaugeChartVisual. + // The value field wells of a GaugeChartVisual . Values []MeasureField noSmithyDocumentSerde } -// The options that determine the presentation of the GaugeChartVisual. +// The options that determine the presentation of the GaugeChartVisual . type GaugeChartOptions struct { - // The arc configuration of a GaugeChartVisual. + // The arc configuration of a GaugeChartVisual . Arc *ArcConfiguration - // The arc axis configuration of a GaugeChartVisual. + // The arc axis configuration of a GaugeChartVisual . ArcAxis *ArcAxisConfiguration - // The comparison configuration of a GaugeChartVisual. + // The comparison configuration of a GaugeChartVisual . Comparison *ComparisonConfiguration // The options that determine the primary value display type. @@ -5321,7 +5132,7 @@ type GaugeChartOptions struct { noSmithyDocumentSerde } -// The conditional formatting for the primary value of a GaugeChartVisual. +// The conditional formatting for the primary value of a GaugeChartVisual . type GaugeChartPrimaryValueConditionalFormatting struct { // The conditional formatting of the primary value icon. @@ -5333,9 +5144,8 @@ type GaugeChartPrimaryValueConditionalFormatting struct { noSmithyDocumentSerde } -// A gauge chart. For more information, see Using gauge charts -// (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the -// Amazon QuickSight User Guide. +// A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) +// in the Amazon QuickSight User Guide. type GaugeChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -5348,10 +5158,10 @@ type GaugeChartVisual struct { // The list of custom actions that are configured for a visual. Actions []VisualCustomAction - // The configuration of a GaugeChartVisual. + // The configuration of a GaugeChartVisual . ChartConfiguration *GaugeChartConfiguration - // The conditional formatting of a GaugeChartVisual. + // The conditional formatting of a GaugeChartVisual . ConditionalFormatting *GaugeChartConditionalFormatting // The subtitle that is displayed on the visual. @@ -5414,8 +5224,8 @@ type GeospatialMapAggregatedFieldWells struct { // The color field wells of a geospatial map. Colors []DimensionField - // The geospatial field wells of a geospatial map. Values are grouped by geospatial - // fields. + // The geospatial field wells of a geospatial map. Values are grouped by + // geospatial fields. Geospatial []DimensionField // The size field wells of a geospatial map. Values are aggregated based on @@ -5425,7 +5235,7 @@ type GeospatialMapAggregatedFieldWells struct { noSmithyDocumentSerde } -// The configuration of a GeospatialMapVisual. +// The configuration of a GeospatialMapVisual . type GeospatialMapConfiguration struct { // The field wells of the visual. @@ -5452,7 +5262,7 @@ type GeospatialMapConfiguration struct { noSmithyDocumentSerde } -// The field wells of a GeospatialMapVisual. This is a union type structure. For +// The field wells of a GeospatialMapVisual . This is a union type structure. For // this structure to be valid, only one of the attributes can be defined. type GeospatialMapFieldWells struct { @@ -5572,8 +5382,8 @@ type GridLayoutCanvasSizeOptions struct { noSmithyDocumentSerde } -// The configuration for a grid layout. Also called a tiled layout. Visuals snap to -// a grid with standard spacing and alignment. Dashboards are displayed as +// The configuration for a grid layout. Also called a tiled layout. Visuals snap +// to a grid with standard spacing and alignment. Dashboards are displayed as // designed, with options to fit to screen or view at actual size. type GridLayoutConfiguration struct { @@ -5624,14 +5434,10 @@ type GridLayoutElement struct { type GridLayoutScreenCanvasSizeOptions struct { // This value determines the layout behavior when the viewport is resized. - // - // * - // FIXED: A fixed width will be used when optimizing the layout. In the Amazon - // QuickSight console, this option is called Classic. - // - // * RESPONSIVE: The width of - // the canvas will be responsive and optimized to the view port. In the Amazon - // QuickSight console, this option is called Tiled. + // - FIXED : A fixed width will be used when optimizing the layout. In the Amazon + // QuickSight console, this option is called Classic . + // - RESPONSIVE : The width of the canvas will be responsive and optimized to the + // view port. In the Amazon QuickSight console, this option is called Tiled . // // This member is required. ResizeOption ResizeOption @@ -5678,18 +5484,18 @@ type GroupMember struct { type GroupSearchFilter struct { // The name of the value that you want to use as a filter, for example "Name": - // "GROUP_NAME". Currently, the only supported name is GROUP_NAME. + // "GROUP_NAME" . Currently, the only supported name is GROUP_NAME . // // This member is required. Name GroupFilterAttribute // The comparison operator that you want to use as a filter, for example - // "Operator": "StartsWith". Currently, the only supported operator is StartsWith. + // "Operator": "StartsWith" . Currently, the only supported operator is StartsWith . // // This member is required. Operator GroupFilterOperator - // The value of the named item, in this case GROUP_NAME, that you want to use as a + // The value of the named item, in this case GROUP_NAME , that you want to use as a // filter. // // This member is required. @@ -5785,7 +5591,7 @@ type HeatMapConfiguration struct { // The legend display setup of the visual. Legend *LegendOptions - // The label options of the row that is displayed in a heat map. + // The label options of the row that is displayed in a heat map . RowLabelOptions *ChartAxisLabelOptions // The sort configuration of a heat map. @@ -5826,9 +5632,8 @@ type HeatMapSortConfiguration struct { noSmithyDocumentSerde } -// A heat map. For more information, see Using heat maps -// (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the Amazon -// QuickSight User Guide. +// A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) +// in the Amazon QuickSight User Guide. type HeatMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -5860,7 +5665,7 @@ type HeatMapVisual struct { type HistogramAggregatedFieldWells struct { // The value field wells of a histogram. Values are aggregated by COUNT or - // DISTINCT_COUNT. + // DISTINCT_COUNT . Values []MeasureField noSmithyDocumentSerde @@ -5884,7 +5689,7 @@ type HistogramBinOptions struct { noSmithyDocumentSerde } -// The configuration for a HistogramVisual. +// The configuration for a HistogramVisual . type HistogramConfiguration struct { // The options that determine the presentation of histogram bins. @@ -5923,9 +5728,8 @@ type HistogramFieldWells struct { noSmithyDocumentSerde } -// A histogram. For more information, see Using histograms -// (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in -// the Amazon QuickSight User Guide. +// A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) +// in the Amazon QuickSight User Guide. type HistogramVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -5938,7 +5742,7 @@ type HistogramVisual struct { // The list of custom actions that are configured for a visual. Actions []VisualCustomAction - // The configuration for a HistogramVisual. + // The configuration for a HistogramVisual . ChartConfiguration *HistogramConfiguration // The subtitle that is displayed on the visual. @@ -6070,8 +5874,7 @@ type InsightConfiguration struct { noSmithyDocumentSerde } -// An insight visual. For more information, see Working with insights -// (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) +// An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) // in the Amazon QuickSight User Guide. type InsightVisual struct { @@ -6102,14 +5905,14 @@ type InsightVisual struct { noSmithyDocumentSerde } -// The default values of the IntegerParameterDeclaration. +// The default values of the IntegerParameterDeclaration . type IntegerDefaultValues struct { - // The dynamic value of the IntegerDefaultValues. Different defaults are displayed + // The dynamic value of the IntegerDefaultValues . Different defaults are displayed // according to users, groups, and values mapping. DynamicValue *DynamicDefaultValue - // The static values of the IntegerDefaultValues. + // The static values of the IntegerDefaultValues . StaticValues []int64 noSmithyDocumentSerde @@ -6139,14 +5942,14 @@ type IntegerParameterDeclaration struct { // This member is required. Name *string - // The value type determines whether the parameter is a single-value or multi-value - // parameter. + // The value type determines whether the parameter is a single-value or + // multi-value parameter. // // This member is required. ParameterValueType ParameterValueType - // The default values of a parameter. If the parameter is a single-value parameter, - // a maximum of one default value can be provided. + // The default values of a parameter. If the parameter is a single-value + // parameter, a maximum of one default value can be provided. DefaultValues *IntegerDefaultValues // A parameter declaration for the Integer data type. @@ -6163,12 +5966,9 @@ type IntegerValueWhenUnsetConfiguration struct { // A custom value that's used when the value of a parameter isn't set. CustomValue *int64 - // The built-in options for default values. The value can be one of the - // following: - // - // * RECOMMENDED: The recommended value. - // - // * NULL: The NULL value. + // The built-in options for default values. The value can be one of the following: + // - RECOMMENDED : The recommended value. + // - NULL : The NULL value. ValueWhenUnsetOption ValueWhenUnsetOption noSmithyDocumentSerde @@ -6177,16 +5977,13 @@ type IntegerValueWhenUnsetConfiguration struct { // The limit configuration of the visual display for an axis. type ItemsLimitConfiguration struct { - // The limit on how many items of a field are showed in the chart. For example, the - // number of slices that are displayed in a pie chart. + // The limit on how many items of a field are showed in the chart. For example, + // the number of slices that are displayed in a pie chart. ItemsLimit *int64 // The Show other of an axis in the chart. Choose one of the following options: - // - // * - // INCLUDE - // - // * EXCLUDE + // - INCLUDE + // - EXCLUDE OtherCategories OtherCategories noSmithyDocumentSerde @@ -6355,9 +6152,8 @@ type KPISortConfiguration struct { noSmithyDocumentSerde } -// A key performance indicator (KPI). For more information, see Using KPIs -// (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the Amazon -// QuickSight User Guide. +// A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) +// in the Amazon QuickSight User Guide. type KPIVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -6403,11 +6199,10 @@ type LabelOptions struct { noSmithyDocumentSerde } -// A Layout defines the placement of elements within a sheet. For more information, -// see Types of layout -// (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the -// Amazon QuickSight User Guide. This is a union type structure. For this structure -// to be valid, only one of the attributes can be defined. +// A Layout defines the placement of elements within a sheet. For more +// information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) +// in the Amazon QuickSight User Guide. This is a union type structure. For this +// structure to be valid, only one of the attributes can be defined. type Layout struct { // The configuration that determines what the type of layout for a sheet. @@ -6431,7 +6226,7 @@ type LayoutConfiguration struct { // a grid with standard spacing and alignment. Dashboards are displayed as // designed, with options to fit to screen or view at actual size. A grid layout // can be configured to behave in one of two ways when the viewport is resized: - // FIXED or RESPONSIVE. + // FIXED or RESPONSIVE . GridLayout *GridLayoutConfiguration // A section based layout organizes visuals into multiple sections and has @@ -6449,15 +6244,10 @@ type LegendOptions struct { Height *string // The positions for the legend. Choose one of the following options: - // - // * AUTO - // - // * - // RIGHT - // - // * BOTTOM - // - // * LEFT + // - AUTO + // - RIGHT + // - BOTTOM + // - LEFT Position LegendPosition // The custom title for the legend. @@ -6502,7 +6292,7 @@ type LineChartConfiguration struct { DataLabels *DataLabelOptions // The options that determine the default presentation of all line series in - // LineChartVisual. + // LineChartVisual . DefaultSeriesSettings *LineChartDefaultSeriesSettings // The field well configuration of a line chart. @@ -6557,7 +6347,7 @@ type LineChartConfiguration struct { } // The options that determine the default presentation of all line series in -// LineChartVisual. +// LineChartVisual . type LineChartDefaultSeriesSettings struct { // The axis to which you are binding all line series to. @@ -6581,27 +6371,19 @@ type LineChartFieldWells struct { noSmithyDocumentSerde } -// Line styles options for a line series in LineChartVisual. +// Line styles options for a line series in LineChartVisual . type LineChartLineStyleSettings struct { // Interpolation style for line series. - // - // * LINEAR: Show as default, linear - // style. - // - // * SMOOTH: Show as a smooth curve. - // - // * STEPPED: Show steps in line. + // - LINEAR : Show as default, linear style. + // - SMOOTH : Show as a smooth curve. + // - STEPPED : Show steps in line. LineInterpolation LineInterpolation // Line style for line series. - // - // * SOLID: Show as a solid line. - // - // * DOTTED: Show as a - // dotted line. - // - // * DASHED: Show as a dashed line. + // - SOLID : Show as a solid line. + // - DOTTED : Show as a dotted line. + // - DASHED : Show as a dashed line. LineStyle LineChartLineStyle // Configuration option that determines whether to show the line for the series. @@ -6613,26 +6395,18 @@ type LineChartLineStyleSettings struct { noSmithyDocumentSerde } -// Marker styles options for a line series in LineChartVisual. +// Marker styles options for a line series in LineChartVisual . type LineChartMarkerStyleSettings struct { // Color of marker in the series. MarkerColor *string // Shape option for markers in the series. - // - // * CIRCLE: Show marker as a circle. - // - // * - // TRIANGLE: Show marker as a triangle. - // - // * SQUARE: Show marker as a square. - // - // * - // DIAMOND: Show marker as a diamond. - // - // * ROUNDED_SQUARE: Show marker as a rounded - // square. + // - CIRCLE : Show marker as a circle. + // - TRIANGLE : Show marker as a triangle. + // - SQUARE : Show marker as a square. + // - DIAMOND : Show marker as a diamond. + // - ROUNDED_SQUARE : Show marker as a rounded square. MarkerShape LineChartMarkerShape // Size of marker in the series. @@ -6647,10 +6421,10 @@ type LineChartMarkerStyleSettings struct { // The options that determine the presentation of a line series in the visual type LineChartSeriesSettings struct { - // Line styles options for a line series in LineChartVisual. + // Line styles options for a line series in LineChartVisual . LineStyleSettings *LineChartLineStyleSettings - // Marker styles options for a line series in LineChartVisual. + // Marker styles options for a line series in LineChartVisual . MarkerStyleSettings *LineChartMarkerStyleSettings noSmithyDocumentSerde @@ -6677,9 +6451,8 @@ type LineChartSortConfiguration struct { noSmithyDocumentSerde } -// A line chart. For more information, see Using line charts -// (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the -// Amazon QuickSight User Guide. +// A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) +// in the Amazon QuickSight User Guide. type LineChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -6766,13 +6539,13 @@ type ListControlSelectAllOptions struct { // The configuration of loading animation in free-form layout. type LoadingAnimation struct { - // The visibility configuration of LoadingAnimation. + // The visibility configuration of LoadingAnimation . Visibility Visibility noSmithyDocumentSerde } -// The navigation configuration for CustomActionNavigationOperation. +// The navigation configuration for CustomActionNavigationOperation . type LocalNavigationConfiguration struct { // The sheet that is targeted for navigation in the same analysis. @@ -6783,10 +6556,10 @@ type LocalNavigationConfiguration struct { noSmithyDocumentSerde } -// A logical table is a unit that joins and that data transformations operate on. A -// logical table has a source, which can be either a physical table or result of a -// join. When a logical table points to a physical table, the logical table acts as -// a mutable copy of that physical table through transform operations. +// A logical table is a unit that joins and that data transformations operate on. +// A logical table has a source, which can be either a physical table or result of +// a join. When a logical table points to a physical table, the logical table acts +// as a mutable copy of that physical table through transform operations. type LogicalTable struct { // A display name for the logical table. @@ -6849,8 +6622,8 @@ type LookbackWindow struct { // This member is required. Size int64 - // The size unit that is used for the lookback window column. Valid values for this - // structure are HOUR, DAY, and WEEK. + // The size unit that is used for the lookback window column. Valid values for + // this structure are HOUR , DAY , and WEEK . // // This member is required. SizeUnit LookbackWindowSizeUnit @@ -6927,11 +6700,8 @@ type MaximumMinimumComputation struct { Time *DimensionField // The type of computation. Choose one of the following options: - // - // * MAXIMUM: A - // maximum computation. - // - // * MINIMUM: A minimum computation. + // - MAXIMUM: A maximum computation. + // - MINIMUM: A minimum computation. // // This member is required. Type MaximumMinimumComputationType @@ -7017,16 +6787,12 @@ type MinimumLabelType struct { // rendering of a line chart. type MissingDataConfiguration struct { - // The treatment option that determines how missing data should be rendered. Choose - // from the following options: - // - // * INTERPOLATE: Interpolate missing values between - // the prior and the next known value. - // - // * SHOW_AS_ZERO: Show missing values as the - // value 0. - // - // * SHOW_AS_BLANK: Display a blank space when rendering missing data. + // The treatment option that determines how missing data should be rendered. + // Choose from the following options: + // - INTERPOLATE : Interpolate missing values between the prior and the next + // known value. + // - SHOW_AS_ZERO : Show missing values as the value 0 . + // - SHOW_AS_BLANK : Display a blank space when rendering missing data. TreatmentOption MissingDataTreatmentOption noSmithyDocumentSerde @@ -7154,36 +6920,17 @@ type NumericalAggregationFunction struct { PercentileAggregation *PercentileAggregation // Built-in aggregation functions for numerical values. - // - // * SUM: The sum of a - // dimension or measure. - // - // * AVERAGE: The average of a dimension or measure. - // - // * MIN: - // The minimum value of a dimension or measure. - // - // * MAX: The maximum value of a - // dimension or measure. - // - // * COUNT: The count of a dimension or measure. - // - // * - // DISTINCT_COUNT: The count of distinct values in a dimension or measure. - // - // * VAR: - // The variance of a dimension or measure. - // - // * VARP: The partitioned variance of a - // dimension or measure. - // - // * STDEV: The standard deviation of a dimension or - // measure. - // - // * STDEVP: The partitioned standard deviation of a dimension or - // measure. - // - // * MEDIAN: The median value of a dimension or measure. + // - SUM : The sum of a dimension or measure. + // - AVERAGE : The average of a dimension or measure. + // - MIN : The minimum value of a dimension or measure. + // - MAX : The maximum value of a dimension or measure. + // - COUNT : The count of a dimension or measure. + // - DISTINCT_COUNT : The count of distinct values in a dimension or measure. + // - VAR : The variance of a dimension or measure. + // - VARP : The partitioned variance of a dimension or measure. + // - STDEV : The standard deviation of a dimension or measure. + // - STDEVP : The partitioned standard deviation of a dimension or measure. + // - MEDIAN : The median value of a dimension or measure. SimpleNumericalAggregation SimpleNumericalAggregationFunction noSmithyDocumentSerde @@ -7192,7 +6939,7 @@ type NumericalAggregationFunction struct { // The dimension type field with numerical type columns. type NumericalDimensionField struct { - // The column that is used in the NumericalDimensionField. + // The column that is used in the NumericalDimensionField . // // This member is required. Column *ColumnIdentifier @@ -7214,7 +6961,7 @@ type NumericalDimensionField struct { // The measure type field with numerical type columns. type NumericalMeasureField struct { - // The column that is used in the NumericalMeasureField. + // The column that is used in the NumericalMeasureField . // // This member is required. Column *ColumnIdentifier @@ -7269,8 +7016,8 @@ type NumericEqualityFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string @@ -7281,15 +7028,9 @@ type NumericEqualityFilter struct { MatchOperator NumericEqualityMatchOperator // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption @@ -7301,9 +7042,7 @@ type NumericEqualityFilter struct { ParameterName *string // Select all of the values. Null is not the assigned value of select all. - // - // * - // FILTER_ALL_VALUES + // - FILTER_ALL_VALUES SelectAllOptions NumericFilterSelectAllOptions // The input value. @@ -7337,22 +7076,16 @@ type NumericRangeFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption @@ -7375,9 +7108,7 @@ type NumericRangeFilter struct { RangeMinimum *NumericRangeFilterValue // Select all of the values. Null is not the assigned value of select all. - // - // * - // FILTER_ALL_VALUES + // - FILTER_ALL_VALUES SelectAllOptions NumericFilterSelectAllOptions noSmithyDocumentSerde @@ -7521,8 +7252,8 @@ type ParameterControl struct { // single value. Dropdown *ParameterDropDownControl - // A control to display a list with buttons or boxes that are used to select either - // a single value or multiple values. + // A control to display a list with buttons or boxes that are used to select + // either a single value or multiple values. List *ParameterListControl // A control to display a horizontal toggle bar. This is used to change a value by @@ -7541,17 +7272,17 @@ type ParameterControl struct { // A control from a date parameter that specifies date and time. type ParameterDateTimePickerControl struct { - // The ID of the ParameterDateTimePickerControl. + // The ID of the ParameterDateTimePickerControl . // // This member is required. ParameterControlId *string - // The name of the ParameterDateTimePickerControl. + // The name of the ParameterDateTimePickerControl . // // This member is required. SourceParameterName *string - // The title of the ParameterDateTimePickerControl. + // The title of the ParameterDateTimePickerControl . // // This member is required. Title *string @@ -7563,8 +7294,7 @@ type ParameterDateTimePickerControl struct { } // The declaration definition of a parameter. For more information, see Parameters -// in Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) +// in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) // in the Amazon QuickSight User Guide. This is a union type structure. For this // structure to be valid, only one of the attributes can be defined. type ParameterDeclaration struct { @@ -7588,23 +7318,23 @@ type ParameterDeclaration struct { // single value. type ParameterDropDownControl struct { - // The ID of the ParameterDropDownControl. + // The ID of the ParameterDropDownControl . // // This member is required. ParameterControlId *string - // The source parameter name of the ParameterDropDownControl. + // The source parameter name of the ParameterDropDownControl . // // This member is required. SourceParameterName *string - // The title of the ParameterDropDownControl. + // The title of the ParameterDropDownControl . // // This member is required. Title *string - // The values that are displayed in a control can be configured to only show values - // that are valid based on what's selected in other controls. + // The values that are displayed in a control can be configured to only show + // values that are valid based on what's selected in other controls. CascadingControlConfiguration *CascadingControlConfiguration // The display options of a control. @@ -7613,33 +7343,33 @@ type ParameterDropDownControl struct { // A list of selectable values that are used in a control. SelectableValues *ParameterSelectableValues - // The type parameter name of the ParameterDropDownControl. + // The type parameter name of the ParameterDropDownControl . Type SheetControlListType noSmithyDocumentSerde } -// A control to display a list with buttons or boxes that are used to select either -// a single value or multiple values. +// A control to display a list with buttons or boxes that are used to select +// either a single value or multiple values. type ParameterListControl struct { - // The ID of the ParameterListControl. + // The ID of the ParameterListControl . // // This member is required. ParameterControlId *string - // The source parameter name of the ParameterListControl. + // The source parameter name of the ParameterListControl . // // This member is required. SourceParameterName *string - // The title of the ParameterListControl. + // The title of the ParameterListControl . // // This member is required. Title *string - // The values that are displayed in a control can be configured to only show values - // that are valid based on what's selected in other controls. + // The values that are displayed in a control can be configured to only show + // values that are valid based on what's selected in other controls. CascadingControlConfiguration *CascadingControlConfiguration // The display options of a control. @@ -7648,7 +7378,7 @@ type ParameterListControl struct { // A list of selectable values that are used in a control. SelectableValues *ParameterSelectableValues - // The type of ParameterListControl. + // The type of ParameterListControl . Type SheetControlListType noSmithyDocumentSerde @@ -7678,7 +7408,7 @@ type ParameterSelectableValues struct { // The column identifier that fetches values from the data set. LinkToDataSetColumn *ColumnIdentifier - // The values that are used in ParameterSelectableValues. + // The values that are used in ParameterSelectableValues . Values []string noSmithyDocumentSerde @@ -7698,12 +7428,12 @@ type ParameterSliderControl struct { // This member is required. MinimumValue float64 - // The ID of the ParameterSliderControl. + // The ID of the ParameterSliderControl . // // This member is required. ParameterControlId *string - // The source parameter name of the ParameterSliderControl. + // The source parameter name of the ParameterSliderControl . // // This member is required. SourceParameterName *string @@ -7713,7 +7443,7 @@ type ParameterSliderControl struct { // This member is required. StepSize float64 - // The title of the ParameterSliderControl. + // The title of the ParameterSliderControl . // // This member is required. Title *string @@ -7727,17 +7457,17 @@ type ParameterSliderControl struct { // A control to display a text box that is used to enter multiple entries. type ParameterTextAreaControl struct { - // The ID of the ParameterTextAreaControl. + // The ID of the ParameterTextAreaControl . // // This member is required. ParameterControlId *string - // The source parameter name of the ParameterTextAreaControl. + // The source parameter name of the ParameterTextAreaControl . // // This member is required. SourceParameterName *string - // The title of the ParameterTextAreaControl. + // The title of the ParameterTextAreaControl . // // This member is required. Title *string @@ -7754,17 +7484,17 @@ type ParameterTextAreaControl struct { // A control to display a text box that is used to enter a single entry. type ParameterTextFieldControl struct { - // The ID of the ParameterTextFieldControl. + // The ID of the ParameterTextFieldControl . // // This member is required. ParameterControlId *string - // The source parameter name of the ParameterTextFieldControl. + // The source parameter name of the ParameterTextFieldControl . // // This member is required. SourceParameterName *string - // The title of the ParameterTextFieldControl. + // The title of the ParameterTextFieldControl . // // This member is required. Title *string @@ -7802,8 +7532,8 @@ type PercentageDisplayFormatConfiguration struct { // An aggregation based on the percentile of values in a dimension or measure. type PercentileAggregation struct { - // The percentile value. This value can be any numeric constant 0–100. A percentile - // value of 50 computes the median value of the measure. + // The percentile value. This value can be any numeric constant 0–100. A + // percentile value of 50 computes the median value of the measure. PercentileValue *float64 noSmithyDocumentSerde @@ -7861,10 +7591,8 @@ type PeriodToDateComputation struct { // The time granularity setup of period to date computation. Choose from the // following options: - // - // * YEAR: Year to date. - // - // * MONTH: Month to date. + // - YEAR: Year to date. + // - MONTH: Month to date. PeriodTimeGranularity TimeGranularity // The value field that is used in a computation. @@ -7873,9 +7601,9 @@ type PeriodToDateComputation struct { noSmithyDocumentSerde } -// A view of a data source that contains information about the shape of the data in -// the underlying source. This is a variant type structure. For this structure to -// be valid, only one of the attributes can be non-null. +// A view of a data source that contains information about the shape of the data +// in the underlying source. This is a variant type structure. For this structure +// to be valid, only one of the attributes can be non-null. // // The following types satisfy this interface: // @@ -7968,8 +7696,8 @@ type PieChartConfiguration struct { noSmithyDocumentSerde } -// The field well configuration of a pie chart. This is a union type structure. For -// this structure to be valid, only one of the attributes can be defined. +// The field well configuration of a pie chart. This is a union type structure. +// For this structure to be valid, only one of the attributes can be defined. type PieChartFieldWells struct { // The field well configuration of a pie chart. @@ -7999,13 +7727,10 @@ type PieChartSortConfiguration struct { // A pie or donut chart. The PieChartVisual structure describes a visual that is a // member of the pie chart family. The following charts can be described by using // this structure: +// - Pie charts +// - Donut charts // -// * Pie charts -// -// * Donut charts -// -// For more information, see Using -// pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) +// For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) // in the Amazon QuickSight User Guide. For more information, see Using donut // charts (https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in // the Amazon QuickSight User Guide. @@ -8061,8 +7786,8 @@ type PivotTableAggregatedFieldWells struct { // The rows field well for a pivot table. Values are grouped by rows fields. Rows []DimensionField - // The values field well for a pivot table. Values are aggregated based on rows and - // columns fields. + // The values field well for a pivot table. Values are aggregated based on rows + // and columns fields. Values []MeasureField noSmithyDocumentSerde @@ -8085,16 +7810,16 @@ type PivotTableCellConditionalFormatting struct { noSmithyDocumentSerde } -// The conditional formatting for a PivotTableVisual. +// The conditional formatting for a PivotTableVisual . type PivotTableConditionalFormatting struct { - // Conditional formatting options for a PivotTableVisual. + // Conditional formatting options for a PivotTableVisual . ConditionalFormattingOptions []PivotTableConditionalFormattingOption noSmithyDocumentSerde } -// Conditional formatting options for a PivotTableVisual. +// Conditional formatting options for a PivotTableVisual . type PivotTableConditionalFormattingOption struct { // The cell conditional formatting option for a pivot table. @@ -8113,7 +7838,7 @@ type PivotTableConditionalFormattingScope struct { noSmithyDocumentSerde } -// The configuration for a PivotTableVisual. +// The configuration for a PivotTableVisual . type PivotTableConfiguration struct { // The field options for a pivot table visual. @@ -8125,7 +7850,7 @@ type PivotTableConfiguration struct { // The paginated report options for a pivot table visual. PaginatedReportOptions *PivotTablePaginatedReportOptions - // The sort configuration for a PivotTableVisual. + // The sort configuration for a PivotTableVisual . SortConfiguration *PivotTableSortConfiguration // The table options for a pivot table visual. @@ -8205,9 +7930,9 @@ type PivotTableOptions struct { // The table cell style of cells. CellStyle *TableCellStyle - // The visibility setting of a pivot table's collapsed row dimension fields. If the - // value of this structure is HIDDEN, all collapsed columns in a pivot table are - // automatically hidden. The default value is VISIBLE. + // The visibility setting of a pivot table's collapsed row dimension fields. If + // the value of this structure is HIDDEN , all collapsed columns in a pivot table + // are automatically hidden. The default value is VISIBLE . CollapsedRowDimensionsVisibility Visibility // The table cell style of the column header. @@ -8265,7 +7990,7 @@ type PivotTableSortBy struct { noSmithyDocumentSerde } -// The sort configuration for a PivotTableVisual. +// The sort configuration for a PivotTableVisual . type PivotTableSortConfiguration struct { // The field sort options for a pivot table sort configuration. @@ -8292,9 +8017,8 @@ type PivotTableTotalOptions struct { noSmithyDocumentSerde } -// A pivot table. For more information, see Using pivot tables -// (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the -// Amazon QuickSight User Guide. +// A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) +// in the Amazon QuickSight User Guide. type PivotTableVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -8310,7 +8034,7 @@ type PivotTableVisual struct { // The configuration settings of the visual. ChartConfiguration *PivotTableConfiguration - // The conditional formatting for a PivotTableVisual. + // The conditional formatting for a PivotTableVisual . ConditionalFormatting *PivotTableConditionalFormatting // The subtitle that is displayed on the visual. @@ -8322,7 +8046,7 @@ type PivotTableVisual struct { noSmithyDocumentSerde } -// The optional configuration of totals cells in a PivotTableVisual. +// The optional configuration of totals cells in a PivotTableVisual . type PivotTotalOptions struct { // The custom label string for the total cells. @@ -8436,8 +8160,8 @@ type ProjectOperation struct { // Information about a queued dataset SPICE ingestion. type QueueInfo struct { - // The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing - // ingestion to complete. + // The ID of the ongoing ingestion. The queued ingestion is waiting for the + // ongoing ingestion to complete. // // This member is required. QueuedIngestion *string @@ -8450,7 +8174,7 @@ type QueueInfo struct { noSmithyDocumentSerde } -// The aggregated field well configuration of a RadarChartVisual. +// The aggregated field well configuration of a RadarChartVisual . type RadarChartAggregatedFieldWells struct { // The aggregated field well categories of a radar chart. @@ -8474,7 +8198,7 @@ type RadarChartAreaStyleSettings struct { noSmithyDocumentSerde } -// The configuration of a RadarChartVisual. +// The configuration of a RadarChartVisual . type RadarChartConfiguration struct { // Determines the visibility of the colors of alternatign bands in a radar chart. @@ -8501,7 +8225,7 @@ type RadarChartConfiguration struct { // The color label options of a radar chart. ColorLabelOptions *ChartAxisLabelOptions - // The field well configuration of a RadarChartVisual. + // The field well configuration of a RadarChartVisual . FieldWells *RadarChartFieldWells // The legend display setup of the visual. @@ -8510,7 +8234,7 @@ type RadarChartConfiguration struct { // The shape of the radar chart. Shape RadarChartShape - // The sort configuration of a RadarChartVisual. + // The sort configuration of a RadarChartVisual . SortConfiguration *RadarChartSortConfiguration // The start angle of a radar chart's axis. @@ -8540,7 +8264,7 @@ type RadarChartSeriesSettings struct { noSmithyDocumentSerde } -// The sort configuration of a RadarChartVisual. +// The sort configuration of a RadarChartVisual . type RadarChartSortConfiguration struct { // The category items limit for a radar chart. @@ -8611,9 +8335,9 @@ type RdsParameters struct { noSmithyDocumentSerde } -// The parameters for Amazon Redshift. The ClusterId field can be blank if Host and -// Port are both set. The Host and Port fields can be blank if the ClusterId field -// is set. +// The parameters for Amazon Redshift. The ClusterId field can be blank if Host +// and Port are both set. The Host and Port fields can be blank if the ClusterId +// field is set. type RedshiftParameters struct { // Database. @@ -8645,11 +8369,8 @@ type ReferenceLine struct { LabelConfiguration *ReferenceLineLabelConfiguration // The status of the reference line. Choose one of the following options: - // - // * - // ENABLE - // - // * DISABLE + // - ENABLE + // - DISABLE Status WidgetStatus // The style configuration of the reference line. @@ -8658,7 +8379,7 @@ type ReferenceLine struct { noSmithyDocumentSerde } -// The configuration for a custom label on a ReferenceLine. +// The configuration for a custom label on a ReferenceLine . type ReferenceLineCustomLabelConfiguration struct { // The string text of the custom label. @@ -8674,10 +8395,8 @@ type ReferenceLineDataConfiguration struct { // The axis binding type of the reference line. Choose one of the following // options: - // - // * PrimaryY - // - // * SecondaryY + // - PrimaryY + // - SecondaryY AxisBinding AxisBinding // The dynamic configuration of the reference line data configuration. @@ -8724,23 +8443,18 @@ type ReferenceLineLabelConfiguration struct { // The horizontal position configuration of the label in a reference line. Choose // one of the following options: - // - // * LEFT - // - // * CENTER - // - // * RIGHT + // - LEFT + // - CENTER + // - RIGHT HorizontalPosition ReferenceLineLabelHorizontalPosition // The value label configuration of the label in a reference line. ValueLabelConfiguration *ReferenceLineValueLabelConfiguration - // The vertical position configuration of the label in a reference line. Choose one - // of the following options: - // - // * ABOVE - // - // * BELOW + // The vertical position configuration of the label in a reference line. Choose + // one of the following options: + // - ABOVE + // - BELOW VerticalPosition ReferenceLineLabelVerticalPosition noSmithyDocumentSerde @@ -8764,13 +8478,9 @@ type ReferenceLineStyleConfiguration struct { Color *string // The pattern type of the line style. Choose one of the following options: - // - // * - // SOLID - // - // * DASHED - // - // * DOTTED + // - SOLID + // - DASHED + // - DOTTED Pattern ReferenceLinePatternType noSmithyDocumentSerde @@ -8782,12 +8492,9 @@ type ReferenceLineValueLabelConfiguration struct { // The format configuration of the value label. FormatConfiguration *NumericFormatConfiguration - // The relative position of the value label. Choose one of the following - // options: - // - // * BEFORE_CUSTOM_LABEL - // - // * AFTER_CUSTOM_LABEL + // The relative position of the value label. Choose one of the following options: + // - BEFORE_CUSTOM_LABEL + // - AFTER_CUSTOM_LABEL RelativePosition ReferenceLineValueLabelRelativePosition noSmithyDocumentSerde @@ -8808,26 +8515,17 @@ type RefreshConfiguration struct { type RefreshFrequency struct { // The interval between scheduled refreshes. Valid values are as follows: - // - // * - // MINUTE15: The dataset refreshes every 15 minutes. This value is only supported - // for incremental refreshes. This interval can only be used for one schedule per - // dataset. - // - // * MINUTE30:The dataset refreshes every 30 minutes. This value is only - // supported for incremental refreshes. This interval can only be used for one - // schedule per dataset. - // - // * HOURLY: The dataset refreshes every hour. This interval - // can only be used for one schedule per dataset. - // - // * DAILY: The dataset refreshes - // every day. - // - // * WEEKLY: The dataset refreshes every week. - // - // * MONTHLY: The dataset - // refreshes every month. + // - MINUTE15 : The dataset refreshes every 15 minutes. This value is only + // supported for incremental refreshes. This interval can only be used for one + // schedule per dataset. + // - MINUTE30 :The dataset refreshes every 30 minutes. This value is only + // supported for incremental refreshes. This interval can only be used for one + // schedule per dataset. + // - HOURLY : The dataset refreshes every hour. This interval can only be used + // for one schedule per dataset. + // - DAILY : The dataset refreshes every day. + // - WEEKLY : The dataset refreshes every week. + // - MONTHLY : The dataset refreshes every month. // // This member is required. Interval RefreshInterval @@ -8841,7 +8539,7 @@ type RefreshFrequency struct { TimeOfTheDay *string // The timezone that you want the refresh schedule to use. The timezone ID must - // match a corresponding ID found on java.util.time.getAvailableIDs(). + // match a corresponding ID found on java.util.time.getAvailableIDs() . Timezone *string noSmithyDocumentSerde @@ -8851,16 +8549,11 @@ type RefreshFrequency struct { type RefreshSchedule struct { // The type of refresh that a datset undergoes. Valid values are as follows: - // - // * - // FULL_REFRESH: A complete refresh of a dataset. - // - // * INCREMENTAL_REFRESH: A partial - // refresh of some rows of a dataset, based on the time window specified. - // - // For more - // information on full and incremental refreshes, see Refreshing SPICE data - // (https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) + // - FULL_REFRESH : A complete refresh of a dataset. + // - INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on + // the time window specified. + // For more information on full and incremental refreshes, see Refreshing SPICE + // data (https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html) // in the Amazon QuickSight User Guide. // // This member is required. @@ -8922,15 +8615,15 @@ type RegisteredUserDashboardFeatureConfigurations struct { noSmithyDocumentSerde } -// The experience that you are embedding. You can use this object to generate a url -// that embeds a visual into your application. +// The experience that you are embedding. You can use this object to generate a +// url that embeds a visual into your application. type RegisteredUserDashboardVisualEmbeddingConfiguration struct { // The visual ID for the visual that you want the user to embed. This ID is // included in the output URL. When the URL in response is accessed, Amazon // QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard // that the visual belongs to must be included in the AuthorizedResourceArns - // parameter. Otherwise, the request will fail with InvalidParameterValueException. + // parameter. Otherwise, the request will fail with InvalidParameterValueException . // // This member is required. InitialDashboardVisualId *DashboardVisualId @@ -8941,7 +8634,7 @@ type RegisteredUserDashboardVisualEmbeddingConfiguration struct { // The type of experience you want to embed. For registered users, you can embed // Amazon QuickSight dashboards or the Amazon QuickSight console. Exactly one of // the experience configurations is required. You can choose Dashboard or -// QuickSightConsole. You cannot choose more than one experience configuration. +// QuickSightConsole . You cannot choose more than one experience configuration. type RegisteredUserEmbeddingExperienceConfiguration struct { // The configuration details for providing a dashboard embedding experience. @@ -8951,43 +8644,31 @@ type RegisteredUserEmbeddingExperienceConfiguration struct { DashboardVisual *RegisteredUserDashboardVisualEmbeddingConfiguration // The configuration details for embedding the Q search bar. For more information - // about embedding the Q search bar, see Embedding Overview - // (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in - // the Amazon QuickSight User Guide. + // about embedding the Q search bar, see Embedding Overview (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) + // in the Amazon QuickSight User Guide. QSearchBar *RegisteredUserQSearchBarEmbeddingConfiguration - // The configuration details for providing each Amazon QuickSight console embedding - // experience. This can be used along with custom permissions to restrict access to - // certain features. For more information, see Customizing Access to the Amazon - // QuickSight Console - // (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) - // in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html) + // The configuration details for providing each Amazon QuickSight console + // embedding experience. This can be used along with custom permissions to restrict + // access to certain features. For more information, see Customizing Access to the + // Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) + // in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html) // where you want to provide an authoring portal that allows users to create data // sources, datasets, analyses, and dashboards. The users who accesses an embedded // Amazon QuickSight console needs to belong to the author or admin security // cohort. If you want to restrict permissions to some of these features, add a - // custom permissions profile to the user with the UpdateUser - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) - // API operation. Use the RegisterUser - // (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) + // custom permissions profile to the user with the UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) + // API operation. Use the RegisterUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) // API operation to add a new user with a custom permission profile attached. For // more information, see the following sections in the Amazon QuickSight User // Guide: - // - // * Embedding the Full Functionality of the Amazon QuickSight Console for - // Authenticated Users - // (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html) - // - // * - // Customizing Access to the Amazon QuickSight Console - // (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) - // - // For - // more information about the high-level steps for embedding and for an interactive - // demo of the ways you can customize embedding, visit the Amazon QuickSight - // Developer Portal - // (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). + // - Embedding the Full Functionality of the Amazon QuickSight Console for + // Authenticated Users (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html) + // - Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) + // For more information about the high-level steps for embedding and for an + // interactive demo of the ways you can customize embedding, visit the Amazon + // QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html) + // . QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration noSmithyDocumentSerde @@ -9014,24 +8695,16 @@ type RegisteredUserQuickSightConsoleEmbeddingConfiguration struct { // The embedding configuration of an embedded Amazon QuickSight console. FeatureConfigurations *RegisteredUserConsoleFeatureConfigurations - // The initial URL path for the Amazon QuickSight console. InitialPath is required. - // The entry point URL is constrained to the following paths: - // - // * /start - // - // * - // /start/analyses - // - // * /start/dashboards - // - // * /start/favorites - // - // * - // /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon - // QuickSight console URL of the dashboard. - // - // * /analyses/AnalysisId. AnalysisId is - // the actual ID key from the Amazon QuickSight console URL of the analysis. + // The initial URL path for the Amazon QuickSight console. InitialPath is + // required. The entry point URL is constrained to the following paths: + // - /start + // - /start/analyses + // - /start/dashboards + // - /start/favorites + // - /dashboards/DashboardId . DashboardId is the actual ID key from the Amazon + // QuickSight console URL of the dashboard. + // - /analyses/AnalysisId . AnalysisId is the actual ID key from the Amazon + // QuickSight console URL of the analysis. InitialPath *string noSmithyDocumentSerde @@ -9077,38 +8750,26 @@ type RelativeDatesFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption // The range date type of the filter. Choose one of the options below: - // - // * - // PREVIOUS - // - // * THIS - // - // * LAST - // - // * NOW - // - // * NEXT + // - PREVIOUS + // - THIS + // - LAST + // - NOW + // - NEXT // // This member is required. RelativeDateType RelativeDateType @@ -9171,18 +8832,13 @@ type ResourcePermission struct { // The Amazon Resource Name (ARN) of the principal. This can be one of the // following: - // - // * The ARN of an Amazon QuickSight user or group associated with a - // data source or dataset. (This is common.) - // - // * The ARN of an Amazon QuickSight - // user, group, or namespace associated with an analysis, dashboard, template, or - // theme. (This is common.) - // - // * The ARN of an Amazon Web Services account root: This - // is an IAM ARN rather than a QuickSight ARN. Use this option only to share - // resources (templates) across Amazon Web Services accounts. (This is less - // common.) + // - The ARN of an Amazon QuickSight user or group associated with a data source + // or dataset. (This is common.) + // - The ARN of an Amazon QuickSight user, group, or namespace associated with + // an analysis, dashboard, template, or theme. (This is common.) + // - The ARN of an Amazon Web Services account root: This is an IAM ARN rather + // than a QuickSight ARN. Use this option only to share resources (templates) + // across Amazon Web Services accounts. (This is less common.) // // This member is required. Principal *string @@ -9233,8 +8889,7 @@ type RowInfo struct { // Information about a dataset that contains permissions for row-level security // (RLS). The permissions dataset maps fields to users or groups. For more -// information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset -// (https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) +// information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset (https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) // in the Amazon QuickSight User Guide. The option to deny permissions by setting // PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets. type RowLevelPermissionDataSet struct { @@ -9251,16 +8906,16 @@ type RowLevelPermissionDataSet struct { PermissionPolicy RowLevelPermissionPolicy // The user or group rules associated with the dataset that contains permissions - // for RLS. By default, FormatVersion is VERSION_1. When FormatVersion is - // VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, - // UserARN and GroupARN are required, and Namespace must not exist. + // for RLS. By default, FormatVersion is VERSION_1 . When FormatVersion is + // VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 + // , UserARN and GroupARN are required, and Namespace must not exist. FormatVersion RowLevelPermissionFormatVersion // The namespace associated with the dataset that contains permissions for RLS. Namespace *string // The status of the row-level security permission dataset. If enabled, the status - // is ENABLED. If disabled, the status is DISABLED. + // is ENABLED . If disabled, the status is DISABLED . Status Status noSmithyDocumentSerde @@ -9275,8 +8930,8 @@ type RowLevelPermissionTagConfiguration struct { // This member is required. TagRules []RowLevelPermissionTagRule - // The status of row-level security tags. If enabled, the status is ENABLED. If - // disabled, the status is DISABLED. + // The status of row-level security tags. If enabled, the status is ENABLED . If + // disabled, the status is DISABLED . Status Status // A list of tag configuration rules to apply to a dataset. All tag configurations @@ -9353,16 +9008,14 @@ type S3Source struct { noSmithyDocumentSerde } -// The configuration of the same-sheet target visuals that you want to be filtered. -// This is a union type structure. For this structure to be valid, only one of the -// attributes can be defined. +// The configuration of the same-sheet target visuals that you want to be +// filtered. This is a union type structure. For this structure to be valid, only +// one of the attributes can be defined. type SameSheetTargetVisualConfiguration struct { // The options that choose the target visual in the same sheet. Valid values are // defined as follows: - // - // * ALL_VISUALS: Applies the filter operation to all visuals - // in the same sheet. + // - ALL_VISUALS : Applies the filter operation to all visuals in the same sheet. TargetVisualOptions TargetVisualOptions // A list of the target visual IDs that are located in the same sheet of the @@ -9427,9 +9080,8 @@ type SankeyDiagramSortConfiguration struct { noSmithyDocumentSerde } -// A sankey diagram. For more information, see Using Sankey diagrams -// (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the -// Amazon QuickSight User Guide. +// A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) +// in the Amazon QuickSight User Guide. type SankeyDiagramVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -9513,14 +9165,14 @@ type ScatterPlotConfiguration struct { // For this structure to be valid, only one of the attributes can be defined. type ScatterPlotFieldWells struct { - // The aggregated field wells of a scatter plot. Scatter plots that have a field in - // the category (group/color) field will have aggregated field wells. The x and + // The aggregated field wells of a scatter plot. Scatter plots that have a field + // in the category (group/color) field will have aggregated field wells. The x and // y-axes of these scatter plots are aggregated by category. ScatterPlotCategoricallyAggregatedFieldWells *ScatterPlotCategoricallyAggregatedFieldWells - // The unaggregated field wells of a scatter plot. Scatter plots without a category - // field well have unaggregated field wells. The x and y-axes of these scatter - // plots are unaggregated. + // The unaggregated field wells of a scatter plot. Scatter plots without a + // category field well have unaggregated field wells. The x and y-axes of these + // scatter plots are unaggregated. ScatterPlotUnaggregatedFieldWells *ScatterPlotUnaggregatedFieldWells noSmithyDocumentSerde @@ -9543,9 +9195,8 @@ type ScatterPlotUnaggregatedFieldWells struct { noSmithyDocumentSerde } -// A scatter plot. For more information, see Using scatter plots -// (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the -// Amazon QuickSight User Guide. +// A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) +// in the Amazon QuickSight User Guide. type ScatterPlotVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -9660,10 +9311,8 @@ type SectionBasedLayoutPaperCanvasSizeOptions struct { // The paper orientation that is used to define canvas dimensions. Choose one of // the following options: - // - // * PORTRAIT - // - // * LANDSCAPE + // - PORTRAIT + // - LANDSCAPE PaperOrientation PaperOrientation // The paper size that is used to define canvas dimensions. @@ -9762,7 +9411,7 @@ type SessionTag struct { // The configuration of adding parameters in action. type SetParameterValueConfiguration struct { - // The destination parameter name of the SetParameterValueConfiguration. + // The destination parameter name of the SetParameterValueConfiguration . // // This member is required. DestinationParameterName *string @@ -9849,27 +9498,21 @@ type SheetDefinition struct { SheetId *string // The layout content type of the sheet. Choose one of the following options: - // - // * - // PAGINATED: Creates a sheet for a paginated report. - // - // * INTERACTIVE: Creates a - // sheet for an interactive dashboard. + // - PAGINATED : Creates a sheet for a paginated report. + // - INTERACTIVE : Creates a sheet for an interactive dashboard. ContentType SheetContentType // A description of the sheet. Description *string // The list of filter controls that are on a sheet. For more information, see - // Adding filter controls to analysis sheets - // (https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the - // Amazon QuickSight User Guide. + // Adding filter controls to analysis sheets (https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) + // in the Amazon QuickSight User Guide. FilterControls []FilterControl - // Layouts define how the components of a sheet are arranged. For more information, - // see Types of layout - // (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the - // Amazon QuickSight User Guide. + // Layouts define how the components of a sheet are arranged. For more + // information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) + // in the Amazon QuickSight User Guide. Layouts []Layout // The name of the sheet. This name is displayed on the sheet's tab in the Amazon @@ -9877,9 +9520,8 @@ type SheetDefinition struct { Name *string // The list of parameter controls that are on a sheet. For more information, see - // Using a Control with a Parameter in Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in - // the Amazon QuickSight User Guide. + // Using a Control with a Parameter in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) + // in the Amazon QuickSight User Guide. ParameterControls []ParameterControl // The control layouts of the sheet. @@ -9891,8 +9533,8 @@ type SheetDefinition struct { // The title of the sheet. Title *string - // A list of the visuals that are on a sheet. Visual placement is determined by the - // layout of the sheet. + // A list of the visuals that are on a sheet. Visual placement is determined by + // the layout of the sheet. Visuals []Visual noSmithyDocumentSerde @@ -9901,12 +9543,10 @@ type SheetDefinition struct { // The override configuration of the rendering rules of a sheet. type SheetElementConfigurationOverrides struct { - // Determines whether or not the overrides are visible. Choose one of the following - // options: - // - // * VISIBLE - // - // * HIDDEN + // Determines whether or not the overrides are visible. Choose one of the + // following options: + // - VISIBLE + // - HIDDEN Visibility Visibility noSmithyDocumentSerde @@ -9969,11 +9609,8 @@ type SheetTextBox struct { type SheetVisualScopingConfiguration struct { // The scope of the applied entities. Choose one of the following options: - // - // * - // ALL_VISUALS - // - // * SELECTED_VISUALS + // - ALL_VISUALS + // - SELECTED_VISUALS // // This member is required. Scope FilterVisualScope @@ -10009,7 +9646,8 @@ type SignupResponse struct { AccountName *string // The type of Active Directory that is being used to authenticate the Amazon - // QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD. + // QuickSight account. Valid values are SIMPLE_AD , AD_CONNECTOR , and MICROSOFT_AD + // . DirectoryType *string // A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication @@ -10045,12 +9683,12 @@ type SliderControlDisplayOptions struct { type SmallMultiplesOptions struct { // Sets the maximum number of visible columns to display in the grid of small - // multiples panels. The default is Auto, which automatically adjusts the columns + // multiples panels. The default is Auto , which automatically adjusts the columns // in the grid to fit the overall layout and size of the given chart. MaxVisibleColumns *int64 // Sets the maximum number of visible rows to display in the grid of small - // multiples panels. The default value is Auto, which automatically adjusts the + // multiples panels. The default value is Auto , which automatically adjusts the // rows in the grid to fit the overall layout and size of the given chart. MaxVisibleRows *int64 @@ -10158,14 +9796,14 @@ type StatePersistenceConfigurations struct { noSmithyDocumentSerde } -// The default values of the StringParameterDeclaration. +// The default values of the StringParameterDeclaration . type StringDefaultValues struct { - // The dynamic value of the StringDefaultValues. Different defaults displayed + // The dynamic value of the StringDefaultValues . Different defaults displayed // according to users, groups, and values mapping. DynamicValue *DynamicDefaultValue - // The static values of the DecimalDefaultValues. + // The static values of the DecimalDefaultValues . StaticValues []string noSmithyDocumentSerde @@ -10207,14 +9845,14 @@ type StringParameterDeclaration struct { // This member is required. Name *string - // The value type determines whether the parameter is a single-value or multi-value - // parameter. + // The value type determines whether the parameter is a single-value or + // multi-value parameter. // // This member is required. ParameterValueType ParameterValueType - // The default values of a parameter. If the parameter is a single-value parameter, - // a maximum of one default value can be provided. + // The default values of a parameter. If the parameter is a single-value + // parameter, a maximum of one default value can be provided. DefaultValues *StringDefaultValues // The configuration that defines the default value of a String parameter when a @@ -10231,12 +9869,9 @@ type StringValueWhenUnsetConfiguration struct { // A custom value that's used when the value of a parameter isn't set. CustomValue *string - // The built-in options for default values. The value can be one of the - // following: - // - // * RECOMMENDED: The recommended value. - // - // * NULL: The NULL value. + // The built-in options for default values. The value can be one of the following: + // - RECOMMENDED : The recommended value. + // - NULL : The NULL value. ValueWhenUnsetOption ValueWhenUnsetOption noSmithyDocumentSerde @@ -10276,8 +9911,8 @@ type TableAggregatedFieldWells struct { // fields. GroupBy []DimensionField - // The values field well for a pivot table. Values are aggregated based on group by - // fields. + // The values field well for a pivot table. Values are aggregated based on group + // by fields. Values []MeasureField noSmithyDocumentSerde @@ -10352,16 +9987,16 @@ type TableCellStyle struct { noSmithyDocumentSerde } -// The conditional formatting for a PivotTableVisual. +// The conditional formatting for a PivotTableVisual . type TableConditionalFormatting struct { - // Conditional formatting options for a PivotTableVisual. + // Conditional formatting options for a PivotTableVisual . ConditionalFormattingOptions []TableConditionalFormattingOption noSmithyDocumentSerde } -// Conditional formatting options for a PivotTableVisual. +// Conditional formatting options for a PivotTableVisual . type TableConditionalFormattingOption struct { // The cell conditional formatting option for a table. @@ -10373,7 +10008,7 @@ type TableConditionalFormattingOption struct { noSmithyDocumentSerde } -// The configuration for a TableVisual. +// The configuration for a TableVisual . type TableConfiguration struct { // The field options for a table visual. @@ -10385,7 +10020,7 @@ type TableConfiguration struct { // The paginated report options for a table visual. PaginatedReportOptions *TablePaginatedReportOptions - // The sort configuration for a TableVisual. + // The sort configuration for a TableVisual . SortConfiguration *TableSortConfiguration // A collection of inline visualizations to display within a chart. @@ -10566,8 +10201,8 @@ type TablePaginatedReportOptions struct { // The conditional formatting of a table row. type TableRowConditionalFormatting struct { - // The conditional formatting color (solid, gradient) of the background for a table - // row. + // The conditional formatting color (solid, gradient) of the background for a + // table row. BackgroundColor *ConditionalFormattingColor // The conditional formatting color (solid, gradient) of the text for a table row. @@ -10600,7 +10235,7 @@ type TableSideBorderOptions struct { noSmithyDocumentSerde } -// The sort configuration for a TableVisual. +// The sort configuration for a TableVisual . type TableSortConfiguration struct { // The pagination configuration (page size, page number) for the table. @@ -10622,9 +10257,8 @@ type TableUnaggregatedFieldWells struct { noSmithyDocumentSerde } -// A table visual. For more information, see Using tables as visuals -// (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the Amazon -// QuickSight User Guide. +// A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) +// in the Amazon QuickSight User Guide. type TableVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -10640,7 +10274,7 @@ type TableVisual struct { // The configuration settings of the visual. ChartConfiguration *TableConfiguration - // The conditional formatting for a PivotTableVisual. + // The conditional formatting for a PivotTableVisual . ConditionalFormatting *TableConditionalFormatting // The subtitle that is displayed on the visual. @@ -10677,8 +10311,8 @@ type TagColumnOperation struct { // This member is required. ColumnName *string - // The dataset column tag, currently only used for geospatial type tagging. This is - // not tags for the Amazon Web Services tagging feature. + // The dataset column tag, currently only used for geospatial type tagging. This + // is not tags for the Amazon Web Services tagging feature. // // This member is required. Tags []ColumnTag @@ -10840,22 +10474,13 @@ type TemplateVersion struct { SourceEntityArn *string // The status that is associated with the template. - // - // * CREATION_IN_PROGRESS - // - // * - // CREATION_SUCCESSFUL - // - // * CREATION_FAILED - // - // * UPDATE_IN_PROGRESS - // - // * - // UPDATE_SUCCESSFUL - // - // * UPDATE_FAILED - // - // * DELETED + // - CREATION_IN_PROGRESS + // - CREATION_SUCCESSFUL + // - CREATION_FAILED + // - UPDATE_IN_PROGRESS + // - UPDATE_SUCCESSFUL + // - UPDATE_FAILED + // - DELETED Status ResourceStatus // The ARN of the theme associated with this version of the template. @@ -10882,19 +10507,17 @@ type TemplateVersionDefinition struct { // An array of calculated field definitions for the template. CalculatedFields []CalculatedField - // An array of template-level column configurations. Column configurations are used - // to set default formatting for a column that's used throughout a template. + // An array of template-level column configurations. Column configurations are + // used to set default formatting for a column that's used throughout a template. ColumnConfigurations []ColumnConfiguration - // Filter definitions for a template. For more information, see Filtering Data - // (https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html) + // Filter definitions for a template. For more information, see Filtering Data (https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html) // in the Amazon QuickSight User Guide. FilterGroups []FilterGroup // An array of parameter declarations for a template. Parameters are named // variables that can transfer a value for use by an action or an object. For more - // information, see Parameters in Amazon QuickSight - // (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) + // information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) // in the Amazon QuickSight User Guide. ParameterDeclarations []ParameterDeclaration @@ -11013,7 +10636,7 @@ type Theme struct { ThemeId *string // The type of theme, based on how it was created. Valid values include: QUICKSIGHT - // and CUSTOM. + // and CUSTOM . Type ThemeType // A version of a theme. @@ -11100,8 +10723,8 @@ type ThemeVersion struct { // The Amazon Resource Name (ARN) of the resource. Arn *string - // The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. - // All themes initially inherit from a default Amazon QuickSight theme. + // The Amazon QuickSight-defined ID of the theme that a custom theme inherits + // from. All themes initially inherit from a default Amazon QuickSight theme. BaseThemeId *string // The theme configuration, which contains all the theme display properties. @@ -11196,11 +10819,8 @@ type TimeBasedForecastProperties struct { // The seasonality setup of a forecast computation. Choose one of the following // options: - // - // * NULL: The input is set to NULL. - // - // * NON_NULL: The input is set to a - // custom value. + // - NULL : The input is set to NULL . + // - NON_NULL : The input is set to a custom value. Seasonality *int32 // The upper boundary setup of a forecast computation. @@ -11217,21 +10837,21 @@ type TimeEqualityFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string // The parameter whose value should be used for the filter value. This field is - // mutually exclusive to Value. + // mutually exclusive to Value . ParameterName *string // The level of time precision that is used to aggregate DateTime values. TimeGranularity TimeGranularity // The value of a TimeEquality filter. This field is mutually exclusive to - // ParameterName. + // ParameterName . Value *time.Time noSmithyDocumentSerde @@ -11271,22 +10891,16 @@ type TimeRangeFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string // This option determines how null values should be treated when filtering data. - // - // * - // ALL_VALUES: Include null values in filtered results. - // - // * NULLS_ONLY: Only include - // null values in filtered results. - // - // * NON_NULLS_ONLY: Exclude null values from - // filtered results. + // - ALL_VALUES : Include null values in filtered results. + // - NULLS_ONLY : Only include null values in filtered results. + // - NON_NULLS_ONLY : Exclude null values from filtered results. // // This member is required. NullOption FilterNullOption @@ -11351,11 +10965,8 @@ type TooltipOptions struct { FieldBasedTooltip *FieldBasedTooltip // The selected type for the tooltip. Choose one of the following options: - // - // * - // BASIC: A basic tooltip. - // - // * DETAILED: A detailed tooltip. + // - BASIC : A basic tooltip. + // - DETAILED : A detailed tooltip. SelectedTooltipType SelectedTooltipType // Determines whether or not the tooltip is visible. @@ -11377,8 +10988,8 @@ type TopBottomFilter struct { // This member is required. Column *ColumnIdentifier - // An identifier that uniquely identifies a filter within a dashboard, analysis, or - // template. + // An identifier that uniquely identifies a filter within a dashboard, analysis, + // or template. // // This member is required. FilterId *string @@ -11414,11 +11025,8 @@ type TopBottomMoversComputation struct { Time *DimensionField // The computation type. Choose from the following options: - // - // * TOP: Top movers - // computation. - // - // * BOTTOM: Bottom movers computation. + // - TOP: Top movers computation. + // - BOTTOM: Bottom movers computation. // // This member is required. Type TopBottomComputationType @@ -11452,11 +11060,8 @@ type TopBottomRankedComputation struct { ComputationId *string // The computation type. Choose one of the following options: - // - // * TOP: A top ranked - // computation. - // - // * BOTTOM: A bottom ranked computation. + // - TOP: A top ranked computation. + // - BOTTOM: A bottom ranked computation. // // This member is required. Type TopBottomComputationType @@ -11635,8 +11240,8 @@ type TreeMapConfiguration struct { // The legend display setup of the visual. Legend *LegendOptions - // The label options (label text, label visibility) of the sizes that are displayed - // in a tree map. + // The label options (label text, label visibility) of the sizes that are + // displayed in a tree map. SizeLabelOptions *ChartAxisLabelOptions // The sort configuration of a tree map. @@ -11670,9 +11275,8 @@ type TreeMapSortConfiguration struct { noSmithyDocumentSerde } -// A tree map. For more information, see Using tree maps -// (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the Amazon -// QuickSight User Guide. +// A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) +// in the Amazon QuickSight User Guide. type TreeMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -11736,38 +11340,37 @@ type Typography struct { // The theme colors that apply to UI and to charts, excluding data colors. The // colors description is a hexadecimal color code that consists of six -// alphanumerical characters, prefixed with #, for example #37BFF5. For more -// information, see Using Themes in Amazon QuickSight -// (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) +// alphanumerical characters, prefixed with # , for example #37BFF5. For more +// information, see Using Themes in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) // in the Amazon QuickSight User Guide. type UIColorPalette struct { // This color is that applies to selected states and buttons. Accent *string - // The foreground color that applies to any text or other elements that appear over - // the accent color. + // The foreground color that applies to any text or other elements that appear + // over the accent color. AccentForeground *string // The color that applies to error messages. Danger *string - // The foreground color that applies to any text or other elements that appear over - // the error color. + // The foreground color that applies to any text or other elements that appear + // over the error color. DangerForeground *string // The color that applies to the names of fields that are identified as dimensions. Dimension *string - // The foreground color that applies to any text or other elements that appear over - // the dimension color. + // The foreground color that applies to any text or other elements that appear + // over the dimension color. DimensionForeground *string // The color that applies to the names of fields that are identified as measures. Measure *string - // The foreground color that applies to any text or other elements that appear over - // the measure color. + // The foreground color that applies to any text or other elements that appear + // over the measure color. MeasureForeground *string // The background color that applies to visuals and other high emphasis UI. @@ -11789,15 +11392,15 @@ type UIColorPalette struct { // successful download. Success *string - // The foreground color that applies to any text or other elements that appear over - // the success color. + // The foreground color that applies to any text or other elements that appear + // over the success color. SuccessForeground *string // This color that applies to warning and informational messages. Warning *string - // The foreground color that applies to any text or other elements that appear over - // the warning color. + // The foreground color that applies to any text or other elements that appear + // over the warning color. WarningForeground *string noSmithyDocumentSerde @@ -11806,7 +11409,7 @@ type UIColorPalette struct { // The unaggregated field for a table. type UnaggregatedField struct { - // The column that is used in the UnaggregatedField. + // The column that is used in the UnaggregatedField . // // This member is required. Column *ColumnIdentifier @@ -11898,12 +11501,9 @@ type User struct { // The type of supported external login provider that provides identity to let the // user federate into Amazon QuickSight with an associated IAM role. The type can // be one of the following. - // - // * COGNITO: Amazon Cognito. The provider URL is - // cognito-identity.amazonaws.com. - // - // * CUSTOM_OIDC: Custom OpenID Connect (OIDC) - // provider. + // - COGNITO : Amazon Cognito. The provider URL is + // cognito-identity.amazonaws.com. + // - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. ExternalLoginFederationProviderType *string // The URL of the external login provider. @@ -11920,20 +11520,13 @@ type User struct { // The Amazon QuickSight role for the user. The user role can be one of the // following:. - // - // * READER: A user who has read-only access to dashboards. - // - // * AUTHOR: - // A user who can create data sources, datasets, analyses, and dashboards. - // - // * - // ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight - // settings. - // - // * RESTRICTED_READER: This role isn't currently available for use. - // - // * - // RESTRICTED_AUTHOR: This role isn't currently available for use. + // - READER : A user who has read-only access to dashboards. + // - AUTHOR : A user who can create data sources, datasets, analyses, and + // dashboards. + // - ADMIN : A user who is an author, who can also manage Amazon Amazon + // QuickSight settings. + // - RESTRICTED_READER : This role isn't currently available for use. + // - RESTRICTED_AUTHOR : This role isn't currently available for use. Role UserRole // The user's user name. This value is required if you are registering a user that @@ -11959,43 +11552,36 @@ type VisibleRangeOptions struct { // can be defined. type Visual struct { - // A bar chart. For more information, see Using bar charts - // (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the - // Amazon QuickSight User Guide. + // A bar chart. For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) + // in the Amazon QuickSight User Guide. BarChartVisual *BarChartVisual - // A box plot. For more information, see Using box plots - // (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the - // Amazon QuickSight User Guide. + // A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) + // in the Amazon QuickSight User Guide. BoxPlotVisual *BoxPlotVisual - // A combo chart. For more information, see Using combo charts - // (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the - // Amazon QuickSight User Guide. + // A combo chart. For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) + // in the Amazon QuickSight User Guide. ComboChartVisual *ComboChartVisual // A visual that contains custom content. For more information, see Using custom - // visual content - // (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) + // visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) // in the Amazon QuickSight User Guide. CustomContentVisual *CustomContentVisual // An empty visual. EmptyVisual *EmptyVisual - // A filled map. For more information, see Creating filled maps - // (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the - // Amazon QuickSight User Guide. + // A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) + // in the Amazon QuickSight User Guide. FilledMapVisual *FilledMapVisual - // A funnel chart. For more information, see Using funnel charts - // (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) + // A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) // in the Amazon QuickSight User Guide. FunnelChartVisual *FunnelChartVisual - // A gauge chart. For more information, see Using gauge charts - // (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the - // Amazon QuickSight User Guide. + // A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) + // in the Amazon QuickSight User Guide. GaugeChartVisual *GaugeChartVisual // A geospatial map or a points on map visual. For more information, see Creating @@ -12003,74 +11589,60 @@ type Visual struct { // in the Amazon QuickSight User Guide. GeospatialMapVisual *GeospatialMapVisual - // A heat map. For more information, see Using heat maps - // (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the Amazon - // QuickSight User Guide. + // A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) + // in the Amazon QuickSight User Guide. HeatMapVisual *HeatMapVisual - // A histogram. For more information, see Using histograms - // (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in - // the Amazon QuickSight User Guide. + // A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) + // in the Amazon QuickSight User Guide. HistogramVisual *HistogramVisual - // An insight visual. For more information, see Working with insights - // (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) + // An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) // in the Amazon QuickSight User Guide. InsightVisual *InsightVisual - // A key performance indicator (KPI). For more information, see Using KPIs - // (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the Amazon - // QuickSight User Guide. + // A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) + // in the Amazon QuickSight User Guide. KPIVisual *KPIVisual - // A line chart. For more information, see Using line charts - // (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the - // Amazon QuickSight User Guide. + // A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) + // in the Amazon QuickSight User Guide. LineChartVisual *LineChartVisual - // A pie or donut chart. For more information, see Using pie charts - // (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the - // Amazon QuickSight User Guide. + // A pie or donut chart. For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) + // in the Amazon QuickSight User Guide. PieChartVisual *PieChartVisual - // A pivot table. For more information, see Using pivot tables - // (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the - // Amazon QuickSight User Guide. + // A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) + // in the Amazon QuickSight User Guide. PivotTableVisual *PivotTableVisual - // A radar chart visual. For more information, see Using radar charts - // (https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the - // Amazon QuickSight User Guide. + // A radar chart visual. For more information, see Using radar charts (https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) + // in the Amazon QuickSight User Guide. RadarChartVisual *RadarChartVisual - // A sankey diagram. For more information, see Using Sankey diagrams - // (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the - // Amazon QuickSight User Guide. + // A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) + // in the Amazon QuickSight User Guide. SankeyDiagramVisual *SankeyDiagramVisual - // A scatter plot. For more information, see Using scatter plots - // (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the - // Amazon QuickSight User Guide. + // A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) + // in the Amazon QuickSight User Guide. ScatterPlotVisual *ScatterPlotVisual - // A table visual. For more information, see Using tables as visuals - // (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the Amazon - // QuickSight User Guide. + // A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) + // in the Amazon QuickSight User Guide. TableVisual *TableVisual - // A tree map. For more information, see Using tree maps - // (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the Amazon - // QuickSight User Guide. + // A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) + // in the Amazon QuickSight User Guide. TreeMapVisual *TreeMapVisual - // A waterfall chart. For more information, see Using waterfall charts - // (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the - // Amazon QuickSight User Guide. + // A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) + // in the Amazon QuickSight User Guide. WaterfallVisual *WaterfallVisual - // A word cloud. For more information, see Using word clouds - // (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the - // Amazon QuickSight User Guide. + // A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) + // in the Amazon QuickSight User Guide. WordCloudVisual *WordCloudVisual noSmithyDocumentSerde @@ -12088,35 +11660,32 @@ type VisualAxisSortOption struct { // A custom action defined on a visual. type VisualCustomAction struct { - // A list of VisualCustomActionOperations. This is a union type structure. For this - // structure to be valid, only one of the attributes can be defined. + // A list of VisualCustomActionOperations . This is a union type structure. For + // this structure to be valid, only one of the attributes can be defined. // // This member is required. ActionOperations []VisualCustomActionOperation - // The ID of the VisualCustomAction. + // The ID of the VisualCustomAction . // // This member is required. CustomActionId *string - // The name of the VisualCustomAction. + // The name of the VisualCustomAction . // // This member is required. Name *string - // The trigger of the VisualCustomAction. Valid values are defined as follows: - // - // * - // DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data - // point. - // - // * DATA_POINT_MENU: Initiates a custom action by right pointer click from - // the menu. + // The trigger of the VisualCustomAction . Valid values are defined as follows: + // - DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a + // data point. + // - DATA_POINT_MENU : Initiates a custom action by right pointer click from the + // menu. // // This member is required. Trigger VisualCustomActionTrigger - // The status of the VisualCustomAction. + // The status of the VisualCustomAction . Status WidgetStatus noSmithyDocumentSerde @@ -12281,9 +11850,8 @@ type WaterfallChartSortConfiguration struct { noSmithyDocumentSerde } -// A waterfall chart. For more information, see Using waterfall charts -// (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the -// Amazon QuickSight User Guide. +// A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) +// in the Amazon QuickSight User Guide. type WaterfallVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -12380,8 +11948,8 @@ type WordCloudChartConfiguration struct { noSmithyDocumentSerde } -// The field wells of a word cloud visual. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The field wells of a word cloud visual. This is a union type structure. For +// this structure to be valid, only one of the attributes can be defined. type WordCloudFieldWells struct { // The aggregated field wells of a word cloud. @@ -12403,8 +11971,8 @@ type WordCloudOptions struct { // cloud. WordCasing WordCloudWordCasing - // The word orientation options (horizontal, horizontal_and_vertical) for the words - // in a word cloud. + // The word orientation options (horizontal, horizontal_and_vertical) for the + // words in a word cloud. WordOrientation WordCloudWordOrientation // The word padding options (none, small, medium, large) for the words in a word @@ -12429,9 +11997,8 @@ type WordCloudSortConfiguration struct { noSmithyDocumentSerde } -// A word cloud. For more information, see Using word clouds -// (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the -// Amazon QuickSight User Guide. +// A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) +// in the Amazon QuickSight User Guide. type WordCloudVisual struct { // The unique identifier of a visual. This identifier must be unique within the diff --git a/service/ram/api_client.go b/service/ram/api_client.go index e00cbd68179..bcaa5af1595 100644 --- a/service/ram/api_client.go +++ b/service/ram/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ram/api_op_AcceptResourceShareInvitation.go b/service/ram/api_op_AcceptResourceShareInvitation.go index 7a9c0a3b29e..a7020c87bf0 100644 --- a/service/ram/api_op_AcceptResourceShareInvitation.go +++ b/service/ram/api_op_AcceptResourceShareInvitation.go @@ -32,9 +32,8 @@ func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *Acce type AcceptResourceShareInvitationInput struct { - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the invitation that you want to accept. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the invitation that you want to accept. // // This member is required. ResourceShareInvitationArn *string @@ -43,9 +42,9 @@ type AcceptResourceShareInvitationInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_AssociateResourceShare.go b/service/ram/api_op_AssociateResourceShare.go index 8fdb21cf475..75a9e8c66ac 100644 --- a/service/ram/api_op_AssociateResourceShare.go +++ b/service/ram/api_op_AssociateResourceShare.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified list of principals and list of resources to a resource share. -// Principals that already have access to this resource share immediately receive -// access to the added resources. Newly added principals immediately receive access -// to the resources shared in this resource share. +// Adds the specified list of principals and list of resources to a resource +// share. Principals that already have access to this resource share immediately +// receive access to the added resources. Newly added principals immediately +// receive access to the resources shared in this resource share. func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error) { if params == nil { params = &AssociateResourceShareInput{} @@ -32,9 +32,8 @@ func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateRe type AssociateResourceShareInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share that you want to add principals or resources to. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share that you want to add principals or resources to. // // This member is required. ResourceShareArn *string @@ -43,46 +42,32 @@ type AssociateResourceShareInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string // Specifies a list of principals to whom you want to the resource share. This can // be null if you want to add only resources. What the principals can do with the // resources in the share is determined by the RAM permissions that you associate - // with the resource share. See AssociateResourceSharePermission. You can include + // with the resource share. See AssociateResourceSharePermission . You can include // the following values: - // - // * An Amazon Web Services account ID, for example: - // 123456789012 - // - // * An Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an organization in Organizations, for example: - // organizations::123456789012:organization/o-exampleorgid - // - // * An ARN of an - // organizational unit (OU) in Organizations, for example: - // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 - // - // * - // An ARN of an IAM role, for example: iam::123456789012:role/rolename - // - // * An ARN of - // an IAM user, for example: iam::123456789012user/username - // - // Not all resource types - // can be shared with IAM roles and users. For more information, see Sharing with - // IAM roles and users - // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) + // - An Amazon Web Services account ID, for example: 123456789012 + // - An Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an organization in Organizations, for example: + // organizations::123456789012:organization/o-exampleorgid + // - An ARN of an organizational unit (OU) in Organizations, for example: + // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 + // - An ARN of an IAM role, for example: iam::123456789012:role/rolename + // - An ARN of an IAM user, for example: iam::123456789012user/username + // Not all resource types can be shared with IAM roles and users. For more + // information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. Principals []string - // Specifies a list of Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resources that you want to share. This can be null if you want to add only - // principals. + // Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resources that you want to share. This can be null if you want to add + // only principals. ResourceArns []string noSmithyDocumentSerde diff --git a/service/ram/api_op_AssociateResourceSharePermission.go b/service/ram/api_op_AssociateResourceSharePermission.go index 79fe5573ea6..9677114dec2 100644 --- a/service/ram/api_op_AssociateResourceSharePermission.go +++ b/service/ram/api_op_AssociateResourceSharePermission.go @@ -31,10 +31,9 @@ func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *A type AssociateResourceSharePermissionInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the RAM permission to associate with the resource share. To find the ARN for a - // permission, use either the ListPermissions operation or go to the Permissions + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the RAM permission to associate with the resource share. To find the ARN for + // a permission, use either the ListPermissions operation or go to the Permissions // library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM // console and then choose the name of the permission. The ARN is displayed on the // detail page. @@ -42,9 +41,8 @@ type AssociateResourceSharePermissionInput struct { // This member is required. PermissionArn *string - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share to which you want to add or replace permissions. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share to which you want to add or replace permissions. // // This member is required. ResourceShareArn *string @@ -53,9 +51,9 @@ type AssociateResourceSharePermissionInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string // Specifies the version of the RAM permission to associate with the resource @@ -64,10 +62,10 @@ type AssociateResourceSharePermissionInput struct { // discover the available versions of a permission. PermissionVersion *int32 - // Specifies whether the specified permission should replace or add to the existing - // permission associated with the resource share. Use true to replace the current - // permissions. Use false to add the permission to the current permission. The - // default value is false. A resource share can have only one permission per + // Specifies whether the specified permission should replace or add to the + // existing permission associated with the resource share. Use true to replace the + // current permissions. Use false to add the permission to the current permission. + // The default value is false . A resource share can have only one permission per // resource type. If a resource share already has a permission for the specified // resource type and you don't set replace to true then the operation returns an // error. This helps prevent accidental overwriting of a permission. diff --git a/service/ram/api_op_CreateResourceShare.go b/service/ram/api_op_CreateResourceShare.go index fd99d2faf2f..b3417496af0 100644 --- a/service/ram/api_op_CreateResourceShare.go +++ b/service/ram/api_op_CreateResourceShare.go @@ -12,10 +12,9 @@ import ( ) // Creates a resource share. You can provide a list of the Amazon Resource Names -// (ARNs) -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for -// the resources that you want to share, a list of principals you want to share the -// resources with, and the permissions to grant those principals. Sharing a +// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// for the resources that you want to share, a list of principals you want to share +// the resources with, and the permissions to grant those principals. Sharing a // resource makes it available for use by principals outside of the Amazon Web // Services account that created the resource. Sharing doesn't change any // permissions or quotas that apply to the resource in the account that created it. @@ -42,54 +41,40 @@ type CreateResourceShareInput struct { Name *string // Specifies whether principals outside your organization in Organizations can be - // associated with a resource share. A value of true lets you share with individual - // Amazon Web Services accounts that are not in your organization. A value of false - // only has meaning if your account is a member of an Amazon Web Services - // Organization. The default value is true. + // associated with a resource share. A value of true lets you share with + // individual Amazon Web Services accounts that are not in your organization. A + // value of false only has meaning if your account is a member of an Amazon Web + // Services Organization. The default value is true . AllowExternalPrincipals *bool // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string - // Specifies the Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the RAM permission to associate with the resource share. If you do not specify - // an ARN for the permission, RAM automatically attaches the default version of the - // permission for each resource type. You can associate only one permission with - // each resource type included in the resource share. + // Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the RAM permission to associate with the resource share. If you do not + // specify an ARN for the permission, RAM automatically attaches the default + // version of the permission for each resource type. You can associate only one + // permission with each resource type included in the resource share. PermissionArns []string - // Specifies a list of one or more principals to associate with the resource share. - // You can include the following values: - // - // * An Amazon Web Services account ID, for - // example: 123456789012 - // - // * An Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an organization in Organizations, for example: - // organizations::123456789012:organization/o-exampleorgid - // - // * An ARN of an - // organizational unit (OU) in Organizations, for example: - // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 - // - // * - // An ARN of an IAM role, for example: iam::123456789012:role/rolename - // - // * An ARN of - // an IAM user, for example: iam::123456789012user/username - // - // Not all resource types - // can be shared with IAM roles and users. For more information, see Sharing with - // IAM roles and users - // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) + // Specifies a list of one or more principals to associate with the resource + // share. You can include the following values: + // - An Amazon Web Services account ID, for example: 123456789012 + // - An Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an organization in Organizations, for example: + // organizations::123456789012:organization/o-exampleorgid + // - An ARN of an organizational unit (OU) in Organizations, for example: + // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 + // - An ARN of an IAM role, for example: iam::123456789012:role/rolename + // - An ARN of an IAM user, for example: iam::123456789012user/username + // Not all resource types can be shared with IAM roles and users. For more + // information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. Principals []string diff --git a/service/ram/api_op_DeleteResourceShare.go b/service/ram/api_op_DeleteResourceShare.go index dabc40c856a..d0050047e48 100644 --- a/service/ram/api_op_DeleteResourceShare.go +++ b/service/ram/api_op_DeleteResourceShare.go @@ -30,9 +30,8 @@ func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResource type DeleteResourceShareInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share to delete. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share to delete. // // This member is required. ResourceShareArn *string @@ -41,9 +40,9 @@ type DeleteResourceShareInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_DisassociateResourceShare.go b/service/ram/api_op_DisassociateResourceShare.go index 4d8b695f994..5e5f153917f 100644 --- a/service/ram/api_op_DisassociateResourceShare.go +++ b/service/ram/api_op_DisassociateResourceShare.go @@ -30,9 +30,8 @@ func (c *Client) DisassociateResourceShare(ctx context.Context, params *Disassoc type DisassociateResourceShareInput struct { - // Specifies Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share that you want to remove resources from. + // Specifies Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share that you want to remove resources from. // // This member is required. ResourceShareArn *string @@ -41,45 +40,30 @@ type DisassociateResourceShareInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string // Specifies a list of one or more principals that no longer are to have access to // the resources in this resource share. You can include the following values: - // - // * - // An Amazon Web Services account ID, for example: 123456789012 - // - // * An Amazon - // Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an organization in Organizations, for example: - // organizations::123456789012:organization/o-exampleorgid - // - // * An ARN of an - // organizational unit (OU) in Organizations, for example: - // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 - // - // * - // An ARN of an IAM role, for example: iam::123456789012:role/rolename - // - // * An ARN of - // an IAM user, for example: iam::123456789012user/username - // - // Not all resource types - // can be shared with IAM roles and users. For more information, see Sharing with - // IAM roles and users - // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) + // - An Amazon Web Services account ID, for example: 123456789012 + // - An Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an organization in Organizations, for example: + // organizations::123456789012:organization/o-exampleorgid + // - An ARN of an organizational unit (OU) in Organizations, for example: + // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 + // - An ARN of an IAM role, for example: iam::123456789012:role/rolename + // - An ARN of an IAM user, for example: iam::123456789012user/username + // Not all resource types can be shared with IAM roles and users. For more + // information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. Principals []string - // Specifies a list of Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) for - // one or more resources that you want to remove from the resource share. After the - // operation runs, these resources are no longer shared with principals outside of - // the Amazon Web Services account that created the resources. + // Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // for one or more resources that you want to remove from the resource share. After + // the operation runs, these resources are no longer shared with principals outside + // of the Amazon Web Services account that created the resources. ResourceArns []string noSmithyDocumentSerde diff --git a/service/ram/api_op_DisassociateResourceSharePermission.go b/service/ram/api_op_DisassociateResourceSharePermission.go index 7c0a46eca19..414dbe9539c 100644 --- a/service/ram/api_op_DisassociateResourceSharePermission.go +++ b/service/ram/api_op_DisassociateResourceSharePermission.go @@ -31,17 +31,15 @@ func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params type DisassociateResourceSharePermissionInput struct { - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the permission to disassociate from the resource share. Changes to permissions - // take effect immediately. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the permission to disassociate from the resource share. Changes to + // permissions take effect immediately. // // This member is required. PermissionArn *string - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share from which you want to disassociate a permission. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share from which you want to disassociate a permission. // // This member is required. ResourceShareArn *string @@ -50,9 +48,9 @@ type DisassociateResourceSharePermissionInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_EnableSharingWithAwsOrganization.go b/service/ram/api_op_EnableSharingWithAwsOrganization.go index 100824572e8..5c94f39506c 100644 --- a/service/ram/api_op_EnableSharingWithAwsOrganization.go +++ b/service/ram/api_op_EnableSharingWithAwsOrganization.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables resource sharing within your organization in Organizations. Calling this -// operation enables RAM to retrieve information about the organization and its -// structure. This lets you share resources with all of the accounts in an +// Enables resource sharing within your organization in Organizations. Calling +// this operation enables RAM to retrieve information about the organization and +// its structure. This lets you share resources with all of the accounts in an // organization by specifying the organization's ID, or all of the accounts in an // organizational unit (OU) by specifying the OU's ID. Until you enable sharing // within the organization, you can specify only individual Amazon Web Services diff --git a/service/ram/api_op_GetPermission.go b/service/ram/api_op_GetPermission.go index 5d92a4517b0..be6c7a654e2 100644 --- a/service/ram/api_op_GetPermission.go +++ b/service/ram/api_op_GetPermission.go @@ -29,9 +29,8 @@ func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, type GetPermissionInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the permission whose contents you want to retrieve. To find the ARN for a + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the permission whose contents you want to retrieve. To find the ARN for a // permission, use either the ListPermissions operation or go to the Permissions // library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM // console and then choose the name of the permission. The ARN is displayed on the diff --git a/service/ram/api_op_GetResourcePolicies.go b/service/ram/api_op_GetResourcePolicies.go index 8dde2475b81..19236c82a07 100644 --- a/service/ram/api_op_GetResourcePolicies.go +++ b/service/ram/api_op_GetResourcePolicies.go @@ -30,16 +30,15 @@ func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePol type GetResourcePoliciesInput struct { - // Specifies the Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resources whose policies you want to retrieve. + // Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resources whose policies you want to retrieve. // // This member is required. ResourceArns []string - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -65,7 +64,7 @@ type GetResourcePoliciesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -141,8 +140,8 @@ func (c *Client) addOperationGetResourcePoliciesMiddlewares(stack *middleware.St return nil } -// GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies -// operation. +// GetResourcePoliciesAPIClient is a client that implements the +// GetResourcePolicies operation. type GetResourcePoliciesAPIClient interface { GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error) } @@ -152,9 +151,9 @@ var _ GetResourcePoliciesAPIClient = (*Client)(nil) // GetResourcePoliciesPaginatorOptions is the paginator options for // GetResourcePolicies type GetResourcePoliciesPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_GetResourceShareAssociations.go b/service/ram/api_op_GetResourceShareAssociations.go index b89ffb899df..a4c28ce5a8b 100644 --- a/service/ram/api_op_GetResourceShareAssociations.go +++ b/service/ram/api_op_GetResourceShareAssociations.go @@ -31,14 +31,12 @@ func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetRe type GetResourceShareAssociationsInput struct { - // Specifies whether you want to retrieve the associations that involve a specified - // resource or principal. - // - // * PRINCIPAL – list the principals that are associated - // with the specified resource share. - // - // * RESOURCE – list the resources that are - // associated with the specified resource share. + // Specifies whether you want to retrieve the associations that involve a + // specified resource or principal. + // - PRINCIPAL – list the principals that are associated with the specified + // resource share. + // - RESOURCE – list the resources that are associated with the specified + // resource share. // // This member is required. AssociationType types.ResourceShareAssociationType @@ -46,9 +44,9 @@ type GetResourceShareAssociationsInput struct { // Specifies that you want to retrieve only associations with this status. AssociationStatus types.ResourceShareAssociationStatus - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -65,21 +63,18 @@ type GetResourceShareAssociationsInput struct { // Specifies the ID of the principal whose resource shares you want to retrieve. // This can be an Amazon Web Services account ID, an organization ID, an - // organizational unit ID, or the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an individual IAM user or role. You cannot specify this parameter if the - // association type is RESOURCE. + // organizational unit ID, or the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an individual IAM user or role. You cannot specify this parameter if the + // association type is RESOURCE . Principal *string - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource whose resource shares you want to retrieve. You cannot specify this - // parameter if the association type is PRINCIPAL. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource whose resource shares you want to retrieve. You cannot specify + // this parameter if the association type is PRINCIPAL . ResourceArn *string - // Specifies a list of Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share whose associations you want to retrieve. + // Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share whose associations you want to retrieve. ResourceShareArns []string noSmithyDocumentSerde @@ -90,7 +85,7 @@ type GetResourceShareAssociationsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -177,9 +172,9 @@ var _ GetResourceShareAssociationsAPIClient = (*Client)(nil) // GetResourceShareAssociationsPaginatorOptions is the paginator options for // GetResourceShareAssociations type GetResourceShareAssociationsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_GetResourceShareInvitations.go b/service/ram/api_op_GetResourceShareInvitations.go index fe5953188ab..54cc79510ce 100644 --- a/service/ram/api_op_GetResourceShareInvitations.go +++ b/service/ram/api_op_GetResourceShareInvitations.go @@ -30,9 +30,9 @@ func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetRes type GetResourceShareInvitationsInput struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -48,13 +48,11 @@ type GetResourceShareInvitationsInput struct { NextToken *string // Specifies that you want details about invitations only for the resource shares - // described by this list of Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // described by this list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) ResourceShareArns []string - // Specifies the Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share invitations you want information about. + // Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share invitations you want information about. ResourceShareInvitationArns []string noSmithyDocumentSerde @@ -65,7 +63,7 @@ type GetResourceShareInvitationsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -149,9 +147,9 @@ var _ GetResourceShareInvitationsAPIClient = (*Client)(nil) // GetResourceShareInvitationsPaginatorOptions is the paginator options for // GetResourceShareInvitations type GetResourceShareInvitationsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_GetResourceShares.go b/service/ram/api_op_GetResourceShares.go index 20d4b115f4f..75594831aa4 100644 --- a/service/ram/api_op_GetResourceShares.go +++ b/service/ram/api_op_GetResourceShares.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details about the resource shares that you own or that are shared with -// you. +// Retrieves details about the resource shares that you own or that are shared +// with you. func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error) { if params == nil { params = &GetResourceSharesInput{} @@ -33,19 +33,15 @@ type GetResourceSharesInput struct { // Specifies that you want to retrieve details of only those resource shares that // match the following: - // - // * SELF – resource shares that your account shares with - // other accounts - // - // * OTHER-ACCOUNTS – resource shares that other accounts share - // with your account + // - SELF – resource shares that your account shares with other accounts + // - OTHER-ACCOUNTS – resource shares that other accounts share with your account // // This member is required. ResourceOwner types.ResourceOwner - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -65,13 +61,12 @@ type GetResourceSharesInput struct { NextToken *string // Specifies that you want to retrieve details of only those resource shares that - // use the RAM permission with this Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // use the RAM permission with this Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . PermissionArn *string - // Specifies the Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // individual resource shares that you want information about. + // Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of individual resource shares that you want information about. ResourceShareArns []string // Specifies that you want to retrieve details of only those resource shares that @@ -90,7 +85,7 @@ type GetResourceSharesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -176,9 +171,9 @@ var _ GetResourceSharesAPIClient = (*Client)(nil) // GetResourceSharesPaginatorOptions is the paginator options for GetResourceShares type GetResourceSharesPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListPendingInvitationResources.go b/service/ram/api_op_ListPendingInvitationResources.go index f16c0a6f68f..95759637c07 100644 --- a/service/ram/api_op_ListPendingInvitationResources.go +++ b/service/ram/api_op_ListPendingInvitationResources.go @@ -13,7 +13,7 @@ import ( ) // Lists the resources in a resource share that is shared with you but for which -// the invitation is still PENDING. That means that you haven't accepted or +// the invitation is still PENDING . That means that you haven't accepted or // rejected the invitation and the invitation hasn't expired. func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error) { if params == nil { @@ -32,17 +32,16 @@ func (c *Client) ListPendingInvitationResources(ctx context.Context, params *Lis type ListPendingInvitationResourcesInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the invitation. You can use GetResourceShareInvitations to find the ARN of the - // invitation. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the invitation. You can use GetResourceShareInvitations to find the ARN of + // the invitation. // // This member is required. ResourceShareInvitationArn *string - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -59,17 +58,11 @@ type ListPendingInvitationResourcesInput struct { // Specifies that you want the results to include only resources that have the // specified scope. - // - // * ALL – the results include both global and regional resources - // or resource types. - // - // * GLOBAL – the results include only global resources or - // resource types. - // - // * REGIONAL – the results include only regional resources or - // resource types. - // - // The default value is ALL. + // - ALL – the results include both global and regional resources or resource + // types. + // - GLOBAL – the results include only global resources or resource types. + // - REGIONAL – the results include only regional resources or resource types. + // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter noSmithyDocumentSerde @@ -80,7 +73,7 @@ type ListPendingInvitationResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -168,9 +161,9 @@ var _ ListPendingInvitationResourcesAPIClient = (*Client)(nil) // ListPendingInvitationResourcesPaginatorOptions is the paginator options for // ListPendingInvitationResources type ListPendingInvitationResourcesPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListPermissionVersions.go b/service/ram/api_op_ListPermissionVersions.go index 25cdf705b77..f1b2c18068a 100644 --- a/service/ram/api_op_ListPermissionVersions.go +++ b/service/ram/api_op_ListPermissionVersions.go @@ -30,18 +30,17 @@ func (c *Client) ListPermissionVersions(ctx context.Context, params *ListPermiss type ListPermissionVersionsInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the RAM permission whose versions you want to list. You can use the - // permissionVersion parameter on the AssociateResourceSharePermission operation to - // specify a non-default version to attach. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the RAM permission whose versions you want to list. You can use the + // permissionVersion parameter on the AssociateResourceSharePermission operation + // to specify a non-default version to attach. // // This member is required. PermissionArn *string - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -64,7 +63,7 @@ type ListPermissionVersionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -151,9 +150,9 @@ var _ ListPermissionVersionsAPIClient = (*Client)(nil) // ListPermissionVersionsPaginatorOptions is the paginator options for // ListPermissionVersions type ListPermissionVersionsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListPermissions.go b/service/ram/api_op_ListPermissions.go index 87377f4d05f..bdb6e7974c9 100644 --- a/service/ram/api_op_ListPermissions.go +++ b/service/ram/api_op_ListPermissions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of available RAM permissions that you can use for the supported -// resource types. +// Retrieves a list of available RAM permissions that you can use for the +// supported resource types. func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) { if params == nil { params = &ListPermissionsInput{} @@ -31,9 +31,9 @@ func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInp type ListPermissionsInput struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -50,7 +50,7 @@ type ListPermissionsInput struct { // Specifies that you want to list permissions for only the specified resource // type. For example, to list only permissions that apply to EC2 subnets, specify - // ec2:Subnet. You can use the ListResourceTypes operation to get the specific + // ec2:Subnet . You can use the ListResourceTypes operation to get the specific // string required. ResourceType *string @@ -62,7 +62,7 @@ type ListPermissionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -145,9 +145,9 @@ var _ ListPermissionsAPIClient = (*Client)(nil) // ListPermissionsPaginatorOptions is the paginator options for ListPermissions type ListPermissionsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListPrincipals.go b/service/ram/api_op_ListPrincipals.go index 0859121e04b..62a284284b4 100644 --- a/service/ram/api_op_ListPrincipals.go +++ b/service/ram/api_op_ListPrincipals.go @@ -33,18 +33,15 @@ type ListPrincipalsInput struct { // Specifies that you want to list information for only resource shares that match // the following: - // - // * SELF – principals that your account is sharing resources - // with - // - // * OTHER-ACCOUNTS – principals that are sharing resources with your account + // - SELF – principals that your account is sharing resources with + // - OTHER-ACCOUNTS – principals that are sharing resources with your account // // This member is required. ResourceOwner types.ResourceOwner - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -61,40 +58,27 @@ type ListPrincipalsInput struct { // Specifies that you want to list information for only the listed principals. You // can include the following values: - // - // * An Amazon Web Services account ID, for - // example: 123456789012 - // - // * An Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an organization in Organizations, for example: - // organizations::123456789012:organization/o-exampleorgid - // - // * An ARN of an - // organizational unit (OU) in Organizations, for example: - // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 - // - // * - // An ARN of an IAM role, for example: iam::123456789012:role/rolename - // - // * An ARN of - // an IAM user, for example: iam::123456789012user/username - // - // Not all resource types - // can be shared with IAM roles and users. For more information, see Sharing with - // IAM roles and users - // (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) + // - An Amazon Web Services account ID, for example: 123456789012 + // - An Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an organization in Organizations, for example: + // organizations::123456789012:organization/o-exampleorgid + // - An ARN of an organizational unit (OU) in Organizations, for example: + // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 + // - An ARN of an IAM role, for example: iam::123456789012:role/rolename + // - An ARN of an IAM user, for example: iam::123456789012user/username + // Not all resource types can be shared with IAM roles and users. For more + // information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types) // in the Resource Access Manager User Guide. Principals []string // Specifies that you want to list principal information for the resource share - // with the specified Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // with the specified Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . ResourceArn *string // Specifies that you want to list information for only principals associated with - // the resource shares specified by a list the Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // the resource shares specified by a list the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . ResourceShareArns []string // Specifies that you want to list information for only principals associated with @@ -110,7 +94,7 @@ type ListPrincipalsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -196,9 +180,9 @@ var _ ListPrincipalsAPIClient = (*Client)(nil) // ListPrincipalsPaginatorOptions is the paginator options for ListPrincipals type ListPrincipalsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListResourceSharePermissions.go b/service/ram/api_op_ListResourceSharePermissions.go index b1f99a2d403..167b6645ddf 100644 --- a/service/ram/api_op_ListResourceSharePermissions.go +++ b/service/ram/api_op_ListResourceSharePermissions.go @@ -30,16 +30,15 @@ func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListR type ListResourceSharePermissionsInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share for which you want to retrieve the associated permissions. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share for which you want to retrieve the associated permissions. // // This member is required. ResourceShareArn *string - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -62,7 +61,7 @@ type ListResourceSharePermissionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -150,9 +149,9 @@ var _ ListResourceSharePermissionsAPIClient = (*Client)(nil) // ListResourceSharePermissionsPaginatorOptions is the paginator options for // ListResourceSharePermissions type ListResourceSharePermissionsPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListResourceTypes.go b/service/ram/api_op_ListResourceTypes.go index 0cd46cc3600..0d48e821c80 100644 --- a/service/ram/api_op_ListResourceTypes.go +++ b/service/ram/api_op_ListResourceTypes.go @@ -30,9 +30,9 @@ func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceType type ListResourceTypesInput struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -49,17 +49,11 @@ type ListResourceTypesInput struct { // Specifies that you want the results to include only resources that have the // specified scope. - // - // * ALL – the results include both global and regional resources - // or resource types. - // - // * GLOBAL – the results include only global resources or - // resource types. - // - // * REGIONAL – the results include only regional resources or - // resource types. - // - // The default value is ALL. + // - ALL – the results include both global and regional resources or resource + // types. + // - GLOBAL – the results include only global resources or resource types. + // - REGIONAL – the results include only regional resources or resource types. + // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter noSmithyDocumentSerde @@ -70,7 +64,7 @@ type ListResourceTypesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -154,9 +148,9 @@ var _ ListResourceTypesAPIClient = (*Client)(nil) // ListResourceTypesPaginatorOptions is the paginator options for ListResourceTypes type ListResourceTypesPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_ListResources.go b/service/ram/api_op_ListResources.go index 406cbc79293..4d04134a97d 100644 --- a/service/ram/api_op_ListResources.go +++ b/service/ram/api_op_ListResources.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the resources that you added to a resource share or the resources that are -// shared with you. +// Lists the resources that you added to a resource share or the resources that +// are shared with you. func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error) { if params == nil { params = &ListResourcesInput{} @@ -33,18 +33,15 @@ type ListResourcesInput struct { // Specifies that you want to list only the resource shares that match the // following: - // - // * SELF – resources that your account shares with other accounts - // - // * - // OTHER-ACCOUNTS – resources that other accounts share with your account + // - SELF – resources that your account shares with other accounts + // - OTHER-ACCOUNTS – resources that other accounts share with your account // // This member is required. ResourceOwner types.ResourceOwner - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service @@ -64,28 +61,22 @@ type ListResourcesInput struct { Principal *string // Specifies that you want to list only the resource shares that include resources - // with the specified Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // with the specified Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . ResourceArns []string // Specifies that you want the results to include only resources that have the // specified scope. - // - // * ALL – the results include both global and regional resources - // or resource types. - // - // * GLOBAL – the results include only global resources or - // resource types. - // - // * REGIONAL – the results include only regional resources or - // resource types. - // - // The default value is ALL. + // - ALL – the results include both global and regional resources or resource + // types. + // - GLOBAL – the results include only global resources or resource types. + // - REGIONAL – the results include only regional resources or resource types. + // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter - // Specifies that you want to list only resources in the resource shares identified - // by the specified Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + // Specifies that you want to list only resources in the resource shares + // identified by the specified Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . ResourceShareArns []string // Specifies that you want to list only the resource shares that include resources @@ -101,7 +92,7 @@ type ListResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. This + // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string @@ -186,9 +177,9 @@ var _ ListResourcesAPIClient = (*Client)(nil) // ListResourcesPaginatorOptions is the paginator options for ListResources type ListResourcesPaginatorOptions struct { - // Specifies the total number of results that you want included on each page of the - // response. If you do not include this parameter, it defaults to a value that is - // specific to the operation. If additional items exist beyond the number you + // Specifies the total number of results that you want included on each page of + // the response. If you do not include this parameter, it defaults to a value that + // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service diff --git a/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go b/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go index c871ae7a0d1..ce56bdc5ac3 100644 --- a/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go +++ b/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go @@ -34,9 +34,8 @@ func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, para type PromoteResourceShareCreatedFromPolicyInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share to promote. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share to promote. // // This member is required. ResourceShareArn *string diff --git a/service/ram/api_op_RejectResourceShareInvitation.go b/service/ram/api_op_RejectResourceShareInvitation.go index feaa15466fa..67a5b5d51f6 100644 --- a/service/ram/api_op_RejectResourceShareInvitation.go +++ b/service/ram/api_op_RejectResourceShareInvitation.go @@ -30,9 +30,8 @@ func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *Reje type RejectResourceShareInvitationInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the invitation that you want to reject. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the invitation that you want to reject. // // This member is required. ResourceShareInvitationArn *string @@ -41,9 +40,9 @@ type RejectResourceShareInvitationInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_TagResource.go b/service/ram/api_op_TagResource.go index 596a1c03de5..fbbedca909e 100644 --- a/service/ram/api_op_TagResource.go +++ b/service/ram/api_op_TagResource.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified tag keys and values to the specified resource share. The tags -// are attached only to the resource share, not to the resources that are in the -// resource share. +// Adds the specified tag keys and values to the specified resource share. The +// tags are attached only to the resource share, not to the resources that are in +// the resource share. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -31,9 +31,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share that you want to add tags to. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share that you want to add tags to. // // This member is required. ResourceShareArn *string diff --git a/service/ram/api_op_UntagResource.go b/service/ram/api_op_UntagResource.go index 1580f514d4c..1dbfd4b2b8c 100644 --- a/service/ram/api_op_UntagResource.go +++ b/service/ram/api_op_UntagResource.go @@ -28,10 +28,9 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share that you want to remove tags from. The tags are removed from - // the resource share, not the resources in the resource share. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share that you want to remove tags from. The tags are removed + // from the resource share, not the resources in the resource share. // // This member is required. ResourceShareArn *string diff --git a/service/ram/api_op_UpdateResourceShare.go b/service/ram/api_op_UpdateResourceShare.go index 24dd6060eb9..8e826704e2b 100644 --- a/service/ram/api_op_UpdateResourceShare.go +++ b/service/ram/api_op_UpdateResourceShare.go @@ -29,9 +29,8 @@ func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResource type UpdateResourceShareInput struct { - // Specifies the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share that you want to modify. + // Specifies the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share that you want to modify. // // This member is required. ResourceShareArn *string @@ -44,9 +43,9 @@ type UpdateResourceShareInput struct { // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for - // all other parameters. We recommend that you use a UUID type of value. - // (https://wikipedia.org/wiki/Universally_unique_identifier). If you don't provide - // this value, then Amazon Web Services generates a random one for you. + // all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier) + // . If you don't provide this value, then Amazon Web Services generates a random + // one for you. ClientToken *string // If specified, the new name that you want to attach to the resource share. diff --git a/service/ram/doc.go b/service/ram/doc.go index 9c0d39a2f26..c9bce89b18e 100644 --- a/service/ram/doc.go +++ b/service/ram/doc.go @@ -12,10 +12,6 @@ // organization or organizational units (OUs). For supported resource types, you // can also share resources with individual Identity and Access Management (IAM) // roles an users. To learn more about RAM, see the following resources: -// -// * -// Resource Access Manager product page (http://aws.amazon.com/ram) -// -// * Resource -// Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/) +// - Resource Access Manager product page (http://aws.amazon.com/ram) +// - Resource Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/) package ram diff --git a/service/ram/types/enums.go b/service/ram/types/enums.go index 2acd69bd3fb..d0206b0d350 100644 --- a/service/ram/types/enums.go +++ b/service/ram/types/enums.go @@ -91,9 +91,10 @@ const ( ResourceShareAssociationTypeResource ResourceShareAssociationType = "RESOURCE" ) -// Values returns all known values for ResourceShareAssociationType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceShareAssociationType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ResourceShareAssociationType) Values() []ResourceShareAssociationType { return []ResourceShareAssociationType{ "PRINCIPAL", diff --git a/service/ram/types/errors.go b/service/ram/types/errors.go index 76125ffe793..e3a9906b642 100644 --- a/service/ram/types/errors.go +++ b/service/ram/types/errors.go @@ -541,8 +541,8 @@ func (e *TagPolicyViolationException) ErrorCode() string { } func (e *TagPolicyViolationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You exceeded the rate at which you are allowed to perform this operation. Please -// try again later. +// You exceeded the rate at which you are allowed to perform this operation. +// Please try again later. type ThrottlingException struct { Message *string diff --git a/service/ram/types/types.go b/service/ram/types/types.go index 217b537347e..6649f5b03df 100644 --- a/service/ram/types/types.go +++ b/service/ram/types/types.go @@ -23,9 +23,8 @@ type Principal struct { // The date and time when the association was last updated. LastUpdatedTime *time.Time - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // a resource share the principal is associated with. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of a resource share the principal is associated with. ResourceShareArn *string noSmithyDocumentSerde @@ -34,9 +33,8 @@ type Principal struct { // Describes a resource associated with a resource share in RAM. type Resource struct { - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource. Arn *string // The date and time when the resource was associated with the resource share. @@ -45,25 +43,19 @@ type Resource struct { // The date an time when the association was last updated. LastUpdatedTime *time.Time - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource group. This value is available only if the resource is part of a + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource group. This value is available only if the resource is part of a // resource group. ResourceGroupArn *string // Specifies the scope of visibility of this resource: - // - // * REGIONAL – The resource - // can be accessed only by using requests that target the Amazon Web Services - // Region in which the resource exists. - // - // * GLOBAL – The resource can be accessed - // from any Amazon Web Services Region. + // - REGIONAL – The resource can be accessed only by using requests that target + // the Amazon Web Services Region in which the resource exists. + // - GLOBAL – The resource can be accessed from any Amazon Web Services Region. ResourceRegionScope ResourceRegionScope - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share this resource is associated with. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share this resource is associated with. ResourceShareArn *string // The current status of the resource. @@ -72,7 +64,7 @@ type Resource struct { // A message about the status of the resource. StatusMessage *string - // The resource type. This takes the form of: service-code:resource-code + // The resource type. This takes the form of: service-code : resource-code Type *string noSmithyDocumentSerde @@ -89,22 +81,17 @@ type ResourceShare struct { CreationTime *time.Time // Indicates how the resource share was created. Possible values include: - // - // * - // CREATED_FROM_POLICY - Indicates that the resource share was created from an - // Identity and Access Management (IAM) resource-based permission policy attached - // to the resource. This type of resource share is visible only to the Amazon Web - // Services account that created it. You can't modify it in RAM unless you promote - // it. For more information, see PromoteResourceShareCreatedFromPolicy. - // - // * - // PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. - // For more information, see PromoteResourceShareCreatedFromPolicy. - // - // * STANDARD - - // Indicates that the resource share was created in RAM using the console or APIs. - // These resource shares are visible to all principals you share the resource share - // with. You can modify these resource shares in RAM using the console or APIs. + // - CREATED_FROM_POLICY - Indicates that the resource share was created from an + // Identity and Access Management (IAM) resource-based permission policy attached + // to the resource. This type of resource share is visible only to the Amazon Web + // Services account that created it. You can't modify it in RAM unless you promote + // it. For more information, see PromoteResourceShareCreatedFromPolicy . + // - PROMOTING_TO_STANDARD - The resource share is in the process of being + // promoted. For more information, see PromoteResourceShareCreatedFromPolicy . + // - STANDARD - Indicates that the resource share was created in RAM using the + // console or APIs. These resource shares are visible to all principals you share + // the resource share with. You can modify these resource shares in RAM using the + // console or APIs. FeatureSet ResourceShareFeatureSet // The date and time when the resource share was last updated. @@ -116,9 +103,8 @@ type ResourceShare struct { // The ID of the Amazon Web Services account that owns the resource share. OwningAccountId *string - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share ResourceShareArn *string // The current status of the resource share. @@ -138,27 +124,15 @@ type ResourceShare struct { type ResourceShareAssociation struct { // The associated entity. This can be either of the following: - // - // * For a resource - // association, this is the Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource. - // - // * For principal associations, this is one of the following: - // - // * - // The ID of an Amazon Web Services account - // - // * The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an organization in Organizations - // - // * The ARN of an organizational unit (OU) in - // Organizations - // - // * The ARN of an IAM role - // - // * The ARN of an IAM user + // - For a resource association, this is the Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource. + // - For principal associations, this is one of the following: + // - The ID of an Amazon Web Services account + // - The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an organization in Organizations + // - The ARN of an organizational unit (OU) in Organizations + // - The ARN of an IAM role + // - The ARN of an IAM user AssociatedEntity *string // The type of entity included in this association. @@ -174,9 +148,8 @@ type ResourceShareAssociation struct { // The date and time when the association was last updated. LastUpdatedTime *time.Time - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share. ResourceShareArn *string // The name of the resource share. @@ -201,25 +174,22 @@ type ResourceShareInvitation struct { // The ID of the Amazon Web Services account that received the invitation. ReceiverAccountId *string - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the IAM user or role that received the invitation. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the IAM user or role that received the invitation. ReceiverArn *string - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource share + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource share ResourceShareArn *string // To view the resources associated with a pending resource share invitation, use - // ListPendingInvitationResources. + // ListPendingInvitationResources . // // Deprecated: This member has been deprecated. Use ListPendingInvitationResources. ResourceShareAssociations []ResourceShareAssociation - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the invitation. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the invitation. ResourceShareInvitationArn *string // The name of the resource share. @@ -237,20 +207,19 @@ type ResourceShareInvitation struct { // Information about an RAM permission. type ResourceSharePermissionDetail struct { - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // this RAM permission. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of this RAM permission. Arn *string // The date and time when the permission was created. CreationTime *time.Time - // Specifies whether the version of the permission represented in this structure is - // the default version for this permission. + // Specifies whether the version of the permission represented in this structure + // is the default version for this permission. DefaultVersion *bool - // Specifies whether the version of the permission represented in this structure is - // the default version for all resources of this resource type. + // Specifies whether the version of the permission represented in this structure + // is the default version for all resources of this resource type. IsResourceTypeDefault *bool // The date and time when the permission was last updated. @@ -259,9 +228,9 @@ type ResourceSharePermissionDetail struct { // The name of this permission. Name *string - // The permission's effect and actions in JSON format. The effect indicates whether - // the specified actions are allowed or denied. The actions list the operations to - // which the principal is granted or denied access. + // The permission's effect and actions in JSON format. The effect indicates + // whether the specified actions are allowed or denied. The actions list the + // operations to which the principal is granted or denied access. Permission *string // The resource type to which this permission applies. @@ -273,24 +242,23 @@ type ResourceSharePermissionDetail struct { noSmithyDocumentSerde } -// Information about an RAM permission that is associated with a resource share and -// any of its resources of a specified type. +// Information about an RAM permission that is associated with a resource share +// and any of its resources of a specified type. type ResourceSharePermissionSummary struct { - // The Amazon Resoure Name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the permission you want information about. + // The Amazon Resoure Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the permission you want information about. Arn *string // The date and time when the permission was created. CreationTime *time.Time - // Specifies whether the version of the permission represented in this structure is - // the default version for this permission. + // Specifies whether the version of the permission represented in this structure + // is the default version for this permission. DefaultVersion *bool - // Specifies whether the version of the permission represented in this structure is - // the default version for all resources of this resource type. + // Specifies whether the version of the permission represented in this structure + // is the default version for all resources of this resource type. IsResourceTypeDefault *bool // The date and time when the permission was last updated. @@ -316,13 +284,9 @@ type ResourceSharePermissionSummary struct { type ServiceNameAndResourceType struct { // Specifies the scope of visibility of resources of this type: - // - // * REGIONAL – The - // resource can be accessed only by using requests that target the Amazon Web - // Services Region in which the resource exists. - // - // * GLOBAL – The resource can be - // accessed from any Amazon Web Services Region. + // - REGIONAL – The resource can be accessed only by using requests that target + // the Amazon Web Services Region in which the resource exists. + // - GLOBAL – The resource can be accessed from any Amazon Web Services Region. ResourceRegionScope ResourceRegionScope // The type of the resource. @@ -338,11 +302,9 @@ type ServiceNameAndResourceType struct { // A structure containing a tag. A tag is metadata that you can attach to your // resources to help organize and categorize them. You can also use them to help // you secure your resources. For more information, see Controlling access to -// Amazon Web Services resources using tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). For more -// information about tags, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference Guide. +// Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html) +// . For more information about tags, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference Guide. type Tag struct { // The key, or name, attached to the tag. Every tag must have a key. Key names are diff --git a/service/rbin/api_client.go b/service/rbin/api_client.go index ca887512514..fa8a2aa646c 100644 --- a/service/rbin/api_client.go +++ b/service/rbin/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rbin/api_op_CreateRule.go b/service/rbin/api_op_CreateRule.go index 0b6cf09be2f..936b1354587 100644 --- a/service/rbin/api_op_CreateRule.go +++ b/service/rbin/api_op_CreateRule.go @@ -12,8 +12,7 @@ import ( ) // Creates a Recycle Bin retention rule. For more information, see Create Recycle -// Bin retention rules -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule) +// Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { @@ -34,13 +33,13 @@ type CreateRuleInput struct { // The resource type to be retained by the retention rule. Currently, only Amazon // EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify - // EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE. + // EBS_SNAPSHOT . To retain EBS-backed AMIs, specify EC2_IMAGE . // // This member is required. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. // // This member is required. RetentionPeriod *types.RetentionPeriod @@ -51,9 +50,9 @@ type CreateRuleInput struct { // Information about the retention rule lock configuration. LockConfiguration *types.LockConfiguration - // Specifies the resource tags to use to identify resources that are to be retained - // by a tag-level retention rule. For tag-level retention rules, only deleted - // resources, of the specified resource type, that have one or more of the + // Specifies the resource tags to use to identify resources that are to be + // retained by a tag-level retention rule. For tag-level retention rules, only + // deleted resources, of the specified resource type, that have one or more of the // specified tag key and value pairs are retained. If a resource is deleted, but it // does not have any of the specified tag key and value pairs, it is immediately // deleted without being retained by the retention rule. You can add the same tag @@ -82,32 +81,26 @@ type CreateRuleOutput struct { LockConfiguration *types.LockConfiguration // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState types.LockState - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag // The resource type retained by the retention rule. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod // The state of the retention rule. Only retention rules that are in the available diff --git a/service/rbin/api_op_DeleteRule.go b/service/rbin/api_op_DeleteRule.go index e6524823a2a..68077178db4 100644 --- a/service/rbin/api_op_DeleteRule.go +++ b/service/rbin/api_op_DeleteRule.go @@ -11,8 +11,7 @@ import ( ) // Deletes a Recycle Bin retention rule. For more information, see Delete Recycle -// Bin retention rules -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule) +// Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { diff --git a/service/rbin/api_op_GetRule.go b/service/rbin/api_op_GetRule.go index 27c91947513..20c568f5509 100644 --- a/service/rbin/api_op_GetRule.go +++ b/service/rbin/api_op_GetRule.go @@ -55,32 +55,26 @@ type GetRuleOutput struct { LockEndTime *time.Time // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState types.LockState - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag // The resource type retained by the retention rule. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod // The state of the retention rule. Only retention rules that are in the available diff --git a/service/rbin/api_op_ListRules.go b/service/rbin/api_op_ListRules.go index 81e4f7421b5..5cc5d6adfbc 100644 --- a/service/rbin/api_op_ListRules.go +++ b/service/rbin/api_op_ListRules.go @@ -33,8 +33,8 @@ type ListRulesInput struct { // The resource type retained by the retention rule. Only retention rules that // retain the specified resource type are listed. Currently, only Amazon EBS // snapshots and EBS-backed AMIs are supported. To list retention rules that retain - // snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed - // AMIs, specify EC2_IMAGE. + // snapshots, specify EBS_SNAPSHOT . To list retention rules that retain EBS-backed + // AMIs, specify EC2_IMAGE . // // This member is required. ResourceType types.ResourceType @@ -50,8 +50,8 @@ type ListRulesInput struct { // The token for the next page of results. NextToken *string - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/rbin/api_op_LockRule.go b/service/rbin/api_op_LockRule.go index adf4ede69a5..8769f696974 100644 --- a/service/rbin/api_op_LockRule.go +++ b/service/rbin/api_op_LockRule.go @@ -54,32 +54,26 @@ type LockRuleOutput struct { LockConfiguration *types.LockConfiguration // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState types.LockState - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag // The resource type retained by the retention rule. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod // The state of the retention rule. Only retention rules that are in the available diff --git a/service/rbin/api_op_UnlockRule.go b/service/rbin/api_op_UnlockRule.go index bd527ea5a3b..b8d66f216c6 100644 --- a/service/rbin/api_op_UnlockRule.go +++ b/service/rbin/api_op_UnlockRule.go @@ -12,8 +12,8 @@ import ( "time" ) -// Unlocks a retention rule. After a retention rule is unlocked, it can be modified -// or deleted only after the unlock delay period expires. +// Unlocks a retention rule. After a retention rule is unlocked, it can be +// modified or deleted only after the unlock delay period expires. func (c *Client) UnlockRule(ctx context.Context, params *UnlockRuleInput, optFns ...func(*Options)) (*UnlockRuleOutput, error) { if params == nil { params = &UnlockRuleInput{} @@ -56,32 +56,26 @@ type UnlockRuleOutput struct { LockEndTime *time.Time // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState types.LockState - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag // The resource type retained by the retention rule. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod // The state of the retention rule. Only retention rules that are in the available diff --git a/service/rbin/api_op_UpdateRule.go b/service/rbin/api_op_UpdateRule.go index 9edf4560f2a..b36b1597cef 100644 --- a/service/rbin/api_op_UpdateRule.go +++ b/service/rbin/api_op_UpdateRule.go @@ -15,8 +15,7 @@ import ( // Updates an existing Recycle Bin retention rule. You can update a retention // rule's description, resource tags, and retention period at any time after // creation. You can't update a retention rule's resource type after creation. For -// more information, see Update Recycle Bin retention rules -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule) +// more information, see Update Recycle Bin retention rules (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule) // in the Amazon Elastic Compute Cloud User Guide. func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { @@ -43,9 +42,9 @@ type UpdateRuleInput struct { // The retention rule description. Description *string - // Specifies the resource tags to use to identify resources that are to be retained - // by a tag-level retention rule. For tag-level retention rules, only deleted - // resources, of the specified resource type, that have one or more of the + // Specifies the resource tags to use to identify resources that are to be + // retained by a tag-level retention rule. For tag-level retention rules, only + // deleted resources, of the specified resource type, that have one or more of the // specified tag key and value pairs are retained. If a resource is deleted, but it // does not have any of the specified tag key and value pairs, it is immediately // deleted without being retained by the retention rule. You can add the same tag @@ -60,8 +59,8 @@ type UpdateRuleInput struct { // resource type after creation. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod noSmithyDocumentSerde @@ -81,32 +80,26 @@ type UpdateRuleOutput struct { LockEndTime *time.Time // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState types.LockState - // Information about the resource tags used to identify resources that are retained - // by the retention rule. + // Information about the resource tags used to identify resources that are + // retained by the retention rule. ResourceTags []types.ResourceTag // The resource type retained by the retention rule. ResourceType types.ResourceType - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *types.RetentionPeriod // The state of the retention rule. Only retention rules that are in the available diff --git a/service/rbin/doc.go b/service/rbin/doc.go index 663ea54cd1d..b58baec4bd8 100644 --- a/service/rbin/doc.go +++ b/service/rbin/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package rbin provides the API client, operations, and parameter types for Amazon -// Recycle Bin. +// Package rbin provides the API client, operations, and parameter types for +// Amazon Recycle Bin. // // This is the Recycle Bin API Reference. This documentation provides descriptions // and syntax for each of the actions and data types in Recycle Bin. Recycle Bin is @@ -14,7 +14,6 @@ // way you use any other resource of that type in your account. If the retention // period expires and the resource is not restored, the resource is permanently // deleted from the Recycle Bin and is no longer available for recovery. For more -// information about Recycle Bin, see Recycle Bin -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html) +// information about Recycle Bin, see Recycle Bin (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html) // in the Amazon Elastic Compute Cloud User Guide. package rbin diff --git a/service/rbin/types/enums.go b/service/rbin/types/enums.go index dc9d850b2b1..c90806ad665 100644 --- a/service/rbin/types/enums.go +++ b/service/rbin/types/enums.go @@ -27,9 +27,9 @@ const ( LockStateUnlocked LockState = "unlocked" ) -// Values returns all known values for LockState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LockState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LockState) Values() []LockState { return []LockState{ "locked", @@ -63,9 +63,9 @@ const ( ResourceTypeEc2Image ResourceType = "EC2_IMAGE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "EBS_SNAPSHOT", diff --git a/service/rbin/types/types.go b/service/rbin/types/types.go index 2f298acb1df..21cc7c20a4a 100644 --- a/service/rbin/types/types.go +++ b/service/rbin/types/types.go @@ -17,8 +17,8 @@ type LockConfiguration struct { noSmithyDocumentSerde } -// Information about the resource tags used to identify resources that are retained -// by the retention rule. +// Information about the resource tags used to identify resources that are +// retained by the retention rule. type ResourceTag struct { // The tag key. @@ -32,8 +32,8 @@ type ResourceTag struct { noSmithyDocumentSerde } -// Information about the retention period for which the retention rule is to retain -// resources. +// Information about the retention period for which the retention rule is to +// retain resources. type RetentionPeriod struct { // The unit of time in which the retention period is measured. Currently, only DAYS @@ -42,8 +42,8 @@ type RetentionPeriod struct { // This member is required. RetentionPeriodUnit RetentionPeriodUnit - // The period value for which the retention rule is to retain resources. The period - // is measured using the unit specified for RetentionPeriodUnit. + // The period value for which the retention rule is to retain resources. The + // period is measured using the unit specified for RetentionPeriodUnit. // // This member is required. RetentionPeriodValue *int32 @@ -61,25 +61,19 @@ type RuleSummary struct { Identifier *string // The lock state for the retention rule. - // - // * locked - The retention rule is locked - // and can't be modified or deleted. - // - // * pending_unlock - The retention rule has - // been unlocked but it is still within the unlock delay period. The retention rule - // can be modified or deleted only after the unlock delay period has expired. - // - // * - // unlocked - The retention rule is unlocked and it can be modified or deleted by - // any user with the required permissions. - // - // * null - The retention rule has never - // been locked. Once a retention rule has been locked, it can transition between - // the locked and unlocked states only; it can never transition back to null. + // - locked - The retention rule is locked and can't be modified or deleted. + // - pending_unlock - The retention rule has been unlocked but it is still within + // the unlock delay period. The retention rule can be modified or deleted only + // after the unlock delay period has expired. + // - unlocked - The retention rule is unlocked and it can be modified or deleted + // by any user with the required permissions. + // - null - The retention rule has never been locked. Once a retention rule has + // been locked, it can transition between the locked and unlocked states only; it + // can never transition back to null . LockState LockState - // Information about the retention period for which the retention rule is to retain - // resources. + // Information about the retention period for which the retention rule is to + // retain resources. RetentionPeriod *RetentionPeriod noSmithyDocumentSerde diff --git a/service/rds/api_client.go b/service/rds/api_client.go index 85773dafbba..f4ef3fe8d2f 100644 --- a/service/rds/api_client.go +++ b/service/rds/api_client.go @@ -117,7 +117,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rds/api_op_AddRoleToDBCluster.go b/service/rds/api_op_AddRoleToDBCluster.go index c49a4883cde..9b3ff5aa4d6 100644 --- a/service/rds/api_op_AddRoleToDBCluster.go +++ b/service/rds/api_op_AddRoleToDBCluster.go @@ -34,13 +34,14 @@ type AddRoleToDBClusterInput struct { DBClusterIdentifier *string // The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB - // cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. + // cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole . // // This member is required. RoleArn *string - // The name of the feature for the DB cluster that the IAM role is to be associated - // with. For information about supported feature names, see DBEngineVersion. + // The name of the feature for the DB cluster that the IAM role is to be + // associated with. For information about supported feature names, see + // DBEngineVersion . FeatureName *string noSmithyDocumentSerde diff --git a/service/rds/api_op_AddRoleToDBInstance.go b/service/rds/api_op_AddRoleToDBInstance.go index 9d0cef2eae1..cf629abc3c7 100644 --- a/service/rds/api_op_AddRoleToDBInstance.go +++ b/service/rds/api_op_AddRoleToDBInstance.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates an Amazon Web Services Identity and Access Management (IAM) role with -// a DB instance. To add a role to a DB instance, the status of the DB instance -// must be available. This command doesn't apply to RDS Custom. +// Associates an Amazon Web Services Identity and Access Management (IAM) role +// with a DB instance. To add a role to a DB instance, the status of the DB +// instance must be available . This command doesn't apply to RDS Custom. func (c *Client) AddRoleToDBInstance(ctx context.Context, params *AddRoleToDBInstanceInput, optFns ...func(*Options)) (*AddRoleToDBInstanceOutput, error) { if params == nil { params = &AddRoleToDBInstanceInput{} @@ -37,13 +37,13 @@ type AddRoleToDBInstanceInput struct { // The name of the feature for the DB instance that the IAM role is to be // associated with. For information about supported feature names, see - // DBEngineVersion. + // DBEngineVersion . // // This member is required. FeatureName *string // The Amazon Resource Name (ARN) of the IAM role to associate with the DB - // instance, for example arn:aws:iam::123456789012:role/AccessRole. + // instance, for example arn:aws:iam::123456789012:role/AccessRole . // // This member is required. RoleArn *string diff --git a/service/rds/api_op_AddSourceIdentifierToSubscription.go b/service/rds/api_op_AddSourceIdentifierToSubscription.go index 2bb90197b00..27d58ac7132 100644 --- a/service/rds/api_op_AddSourceIdentifierToSubscription.go +++ b/service/rds/api_op_AddSourceIdentifierToSubscription.go @@ -30,28 +30,19 @@ func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params * type AddSourceIdentifierToSubscriptionInput struct { // The identifier of the event source to be added. Constraints: - // - // * If the source - // type is a DB instance, a DBInstanceIdentifier value must be supplied. - // - // * If the - // source type is a DB cluster, a DBClusterIdentifier value must be supplied. - // - // * If - // the source type is a DB parameter group, a DBParameterGroupName value must be - // supplied. - // - // * If the source type is a DB security group, a DBSecurityGroupName - // value must be supplied. - // - // * If the source type is a DB snapshot, a - // DBSnapshotIdentifier value must be supplied. - // - // * If the source type is a DB - // cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. - // - // * If - // the source type is an RDS Proxy, a DBProxyName value must be supplied. + // - If the source type is a DB instance, a DBInstanceIdentifier value must be + // supplied. + // - If the source type is a DB cluster, a DBClusterIdentifier value must be + // supplied. + // - If the source type is a DB parameter group, a DBParameterGroupName value + // must be supplied. + // - If the source type is a DB security group, a DBSecurityGroupName value must + // be supplied. + // - If the source type is a DB snapshot, a DBSnapshotIdentifier value must be + // supplied. + // - If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier + // value must be supplied. + // - If the source type is an RDS Proxy, a DBProxyName value must be supplied. // // This member is required. SourceIdentifier *string diff --git a/service/rds/api_op_AddTagsToResource.go b/service/rds/api_op_AddTagsToResource.go index 2582f617e0c..1cfb72d0304 100644 --- a/service/rds/api_op_AddTagsToResource.go +++ b/service/rds/api_op_AddTagsToResource.go @@ -14,8 +14,8 @@ import ( // Adds metadata tags to an Amazon RDS resource. These tags can also be used with // cost allocation reporting to track cost associated with Amazon RDS resources, or // used in a Condition statement in an IAM policy for Amazon RDS. For an overview -// on tagging Amazon RDS resources, see Tagging Amazon RDS Resources -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html). +// on tagging Amazon RDS resources, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) +// . func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -34,9 +34,9 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { // The Amazon RDS resource that the tags are added to. This value is an Amazon - // Resource Name (ARN). For information about creating an ARN, see Constructing an - // RDS Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). + // Resource Name (ARN). For information about creating an ARN, see Constructing an + // RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // . // // This member is required. ResourceName *string diff --git a/service/rds/api_op_ApplyPendingMaintenanceAction.go b/service/rds/api_op_ApplyPendingMaintenanceAction.go index 41242cf774b..c255b93a3a5 100644 --- a/service/rds/api_op_ApplyPendingMaintenanceAction.go +++ b/service/rds/api_op_ApplyPendingMaintenanceAction.go @@ -31,30 +31,25 @@ func (c *Client) ApplyPendingMaintenanceAction(ctx context.Context, params *Appl type ApplyPendingMaintenanceActionInput struct { // The pending maintenance action to apply to this resource. Valid values: - // system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation + // system-update , db-upgrade , hardware-maintenance , ca-certificate-rotation // // This member is required. ApplyAction *string // A value that specifies the type of opt-in request, or undoes an opt-in request. // An opt-in request of type immediate can't be undone. Valid values: - // - // * immediate - // - Apply the maintenance action immediately. - // - // * next-maintenance - Apply the - // maintenance action during the next maintenance window for the resource. - // - // * - // undo-opt-in - Cancel any existing next-maintenance opt-in requests. + // - immediate - Apply the maintenance action immediately. + // - next-maintenance - Apply the maintenance action during the next maintenance + // window for the resource. + // - undo-opt-in - Cancel any existing next-maintenance opt-in requests. // // This member is required. OptInType *string // The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance - // action applies to. For information about creating an ARN, see Constructing an - // RDS Amazon Resource Name (ARN) - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). + // action applies to. For information about creating an ARN, see Constructing an + // RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // . // // This member is required. ResourceIdentifier *string diff --git a/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go b/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go index 4cd3cbebbbf..9ab5462f978 100644 --- a/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go +++ b/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go @@ -21,17 +21,13 @@ import ( // ingress from an EC2 security group in one Amazon Web Services Region to an // Amazon RDS DB instance in another. You can't authorize ingress from a VPC // security group in one VPC to an Amazon RDS DB instance in another. For an -// overview of CIDR ranges, go to the Wikipedia Tutorial -// (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). EC2-Classic was -// retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, -// we recommend that you migrate as soon as possible. For more information, see -// Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How -// to Prepare -// (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), -// and Moving a DB instance not in a VPC into a VPC -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) +// overview of CIDR ranges, go to the Wikipedia Tutorial (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . EC2-Classic was retired on August 15, 2022. If you haven't migrated from +// EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For +// more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – +// Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) +// , and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) // in the Amazon RDS User Guide. func (c *Client) AuthorizeDBSecurityGroupIngress(ctx context.Context, params *AuthorizeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeDBSecurityGroupIngressOutput, error) { if params == nil { @@ -80,8 +76,8 @@ type AuthorizeDBSecurityGroupIngressInput struct { type AuthorizeDBSecurityGroupIngressOutput struct { - // Contains the details for an Amazon RDS DB security group. This data type is used - // as a response element in the DescribeDBSecurityGroups action. + // Contains the details for an Amazon RDS DB security group. This data type is + // used as a response element in the DescribeDBSecurityGroups action. DBSecurityGroup *types.DBSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_BacktrackDBCluster.go b/service/rds/api_op_BacktrackDBCluster.go index 83752fcbd71..6299b32815e 100644 --- a/service/rds/api_op_BacktrackDBCluster.go +++ b/service/rds/api_op_BacktrackDBCluster.go @@ -12,8 +12,7 @@ import ( ) // Backtracks a DB cluster to a specific time, without creating a new DB cluster. -// For more information on backtracking, see Backtracking an Aurora DB Cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html) +// For more information on backtracking, see Backtracking an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html) // in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB // clusters. func (c *Client) BacktrackDBCluster(ctx context.Context, params *BacktrackDBClusterInput, optFns ...func(*Options)) (*BacktrackDBClusterOutput, error) { @@ -34,35 +33,23 @@ func (c *Client) BacktrackDBCluster(ctx context.Context, params *BacktrackDBClus type BacktrackDBClusterInput struct { // The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 - // format. For more information about ISO 8601, see the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) If the specified time isn't a consistent - // time for the DB cluster, Aurora automatically chooses the nearest possible - // consistent time for the DB cluster. Constraints: - // - // * Must contain a valid ISO - // 8601 timestamp. - // - // * Can't contain a timestamp set in the future. - // - // Example: - // 2017-07-08T18:00Z + // format. For more information about ISO 8601, see the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) + // If the specified time isn't a consistent time for the DB cluster, Aurora + // automatically chooses the nearest possible consistent time for the DB cluster. + // Constraints: + // - Must contain a valid ISO 8601 timestamp. + // - Can't contain a timestamp set in the future. + // Example: 2017-07-08T18:00Z // // This member is required. BacktrackTo *time.Time - // The DB cluster identifier of the DB cluster to be backtracked. This parameter is - // stored as a lowercase string. Constraints: - // - // * Must contain from 1 to 63 - // alphanumeric characters or hyphens. - // - // * First character must be a letter. - // - // * - // Can't end with a hyphen or contain two consecutive hyphens. - // - // Example: - // my-cluster1 + // The DB cluster identifier of the DB cluster to be backtracked. This parameter + // is stored as a lowercase string. Constraints: + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string @@ -100,20 +87,15 @@ type BacktrackDBClusterOutput struct { // key that identifies a DB cluster. DBClusterIdentifier *string - // The status of the backtrack. This property returns one of the following - // values: - // - // * applying - The backtrack is currently being applied to or rolled back - // from the DB cluster. - // - // * completed - The backtrack has successfully been applied - // to or rolled back from the DB cluster. - // - // * failed - An error occurred while the - // backtrack was applied to or rolled back from the DB cluster. - // - // * pending - The - // backtrack is currently pending application to or rollback from the DB cluster. + // The status of the backtrack. This property returns one of the following values: + // - applying - The backtrack is currently being applied to or rolled back from + // the DB cluster. + // - completed - The backtrack has successfully been applied to or rolled back + // from the DB cluster. + // - failed - An error occurred while the backtrack was applied to or rolled back + // from the DB cluster. + // - pending - The backtrack is currently pending application to or rollback from + // the DB cluster. Status *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CancelExportTask.go b/service/rds/api_op_CancelExportTask.go index 2eb9bdf1c61..9743df84c6a 100644 --- a/service/rds/api_op_CancelExportTask.go +++ b/service/rds/api_op_CancelExportTask.go @@ -44,22 +44,15 @@ type CancelExportTaskInput struct { // type is used as a response element in the DescribeExportTasks action. type CancelExportTaskOutput struct { - // The data exported from the snapshot or cluster. Valid values are the - // following: + // The data exported from the snapshot or cluster. Valid values are the following: + // - database - Export all the data from a specified database. + // - database.table table-name - Export a table of the snapshot or cluster. This + // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + // - database.schema schema-name - Export a database schema of the snapshot or + // cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. // - // * database - Export all the data from a specified database. - // - // * - // database.table table-name - Export a table of the snapshot or cluster. This - // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. - // - // * - // database.schema schema-name - Export a database schema of the snapshot or - // cluster. This format is valid only for RDS for PostgreSQL and Aurora - // PostgreSQL. - // - // * database.schema.table table-name - Export a table of the database - // schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + // - database.schema.table table-name - Export a table of the database schema. + // This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. ExportOnly []string // A unique identifier for the snapshot or cluster export task. This ID isn't an @@ -97,21 +90,13 @@ type CancelExportTaskOutput struct { // The type of source for the export. SourceType types.ExportSourceType - // The progress status of the export task. The status can be one of the - // following: - // - // * CANCELED - // - // * CANCELING - // - // * COMPLETE - // - // * FAILED - // - // * IN_PROGRESS - // - // * - // STARTING + // The progress status of the export task. The status can be one of the following: + // - CANCELED + // - CANCELING + // - COMPLETE + // - FAILED + // - IN_PROGRESS + // - STARTING Status *string // The time that the snapshot or cluster export task ended. diff --git a/service/rds/api_op_CopyDBClusterParameterGroup.go b/service/rds/api_op_CopyDBClusterParameterGroup.go index 2fbaf73b521..e5bbe7b2402 100644 --- a/service/rds/api_op_CopyDBClusterParameterGroup.go +++ b/service/rds/api_op_CopyDBClusterParameterGroup.go @@ -29,14 +29,11 @@ func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDB type CopyDBClusterParameterGroupInput struct { - // The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter - // group. For information about creating an ARN, see Constructing an ARN for - // Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // The identifier or Amazon Resource Name (ARN) for the source DB cluster + // parameter group. For information about creating an ARN, see Constructing an ARN + // for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) // in the Amazon Aurora User Guide. Constraints: - // - // * Must specify a valid DB cluster - // parameter group. + // - Must specify a valid DB cluster parameter group. // // This member is required. SourceDBClusterParameterGroupIdentifier *string @@ -47,26 +44,17 @@ type CopyDBClusterParameterGroupInput struct { TargetDBClusterParameterGroupDescription *string // The identifier for the copied DB cluster parameter group. Constraints: - // - // * Can't - // be null, empty, or blank - // - // * Must contain from 1 to 255 letters, numbers, or - // hyphens - // - // * First character must be a letter - // - // * Can't end with a hyphen or - // contain two consecutive hyphens - // + // - Can't be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-cluster-param-group1 // // This member is required. TargetDBClusterParameterGroupIdentifier *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde @@ -74,8 +62,9 @@ type CopyDBClusterParameterGroupInput struct { type CopyDBClusterParameterGroupOutput struct { - // Contains the details of an Amazon RDS DB cluster parameter group. This data type - // is used as a response element in the DescribeDBClusterParameterGroups action. + // Contains the details of an Amazon RDS DB cluster parameter group. This data + // type is used as a response element in the DescribeDBClusterParameterGroups + // action. DBClusterParameterGroup *types.DBClusterParameterGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CopyDBClusterSnapshot.go b/service/rds/api_op_CopyDBClusterSnapshot.go index bce3ce588e2..9ec2f8fe4df 100644 --- a/service/rds/api_op_CopyDBClusterSnapshot.go +++ b/service/rds/api_op_CopyDBClusterSnapshot.go @@ -14,41 +14,32 @@ import ( ) // Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared -// manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon -// Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted -// DB cluster snapshot from another Amazon Web Services Region. In that case, the -// Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is -// the destination Amazon Web Services Region for the encrypted DB cluster snapshot -// to be copied to. To copy an encrypted DB cluster snapshot from another Amazon -// Web Services Region, you must provide the following values: +// manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the +// Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an +// encrypted DB cluster snapshot from another Amazon Web Services Region. In that +// case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot +// operation is the destination Amazon Web Services Region for the encrypted DB +// cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from +// another Amazon Web Services Region, you must provide the following values: +// - KmsKeyId - The Amazon Web Services Key Management System (Amazon Web +// Services KMS) key identifier for the key to use to encrypt the copy of the DB +// cluster snapshot in the destination Amazon Web Services Region. +// - TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the +// DB cluster snapshot in the destination Amazon Web Services Region. +// - SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for +// the encrypted DB cluster snapshot to be copied. This identifier must be in the +// ARN format for the source Amazon Web Services Region and is the same value as +// the SourceDBClusterSnapshotIdentifier in the presigned URL. // -// * KmsKeyId - The -// Amazon Web Services Key Management System (Amazon Web Services KMS) key -// identifier for the key to use to encrypt the copy of the DB cluster snapshot in -// the destination Amazon Web Services Region. -// -// * TargetDBClusterSnapshotIdentifier -// - The identifier for the new copy of the DB cluster snapshot in the destination -// Amazon Web Services Region. -// -// * SourceDBClusterSnapshotIdentifier - The DB -// cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. -// This identifier must be in the ARN format for the source Amazon Web Services -// Region and is the same value as the SourceDBClusterSnapshotIdentifier in the -// presigned URL. -// -// To cancel the copy operation once it is in progress, delete the -// target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while -// that DB cluster snapshot is in "copying" status. For more information on copying +// To cancel the copy operation once it is in progress, delete the target DB +// cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB +// cluster snapshot is in "copying" status. For more information on copying // encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region -// to another, see Copying a Snapshot -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html) +// to another, see Copying a Snapshot (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html) // in the Amazon Aurora User Guide. For more information on Amazon Aurora DB -// clusters, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) { if params == nil { @@ -70,20 +61,13 @@ type CopyDBClusterSnapshotInput struct { // The identifier of the DB cluster snapshot to copy. This parameter isn't // case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one // Amazon Web Services Region to another. Constraints: - // - // * Must specify a valid - // system snapshot in the "available" state. - // - // * If the source snapshot is in the - // same Amazon Web Services Region as the copy, specify a valid DB snapshot - // identifier. - // - // * If the source snapshot is in a different Amazon Web Services - // Region than the copy, specify a valid DB cluster snapshot ARN. For more - // information, go to Copying Snapshots Across Amazon Web Services Regions - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions) - // in the Amazon Aurora User Guide. - // + // - Must specify a valid system snapshot in the "available" state. + // - If the source snapshot is in the same Amazon Web Services Region as the + // copy, specify a valid DB snapshot identifier. + // - If the source snapshot is in a different Amazon Web Services Region than + // the copy, specify a valid DB cluster snapshot ARN. For more information, go to + // Copying Snapshots Across Amazon Web Services Regions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions) + // in the Amazon Aurora User Guide. // Example: my-cluster-snapshot1 // // This member is required. @@ -91,17 +75,10 @@ type CopyDBClusterSnapshotInput struct { // The identifier of the new DB cluster snapshot to create from the source DB // cluster snapshot. This parameter isn't case-sensitive. Constraints: - // - // * Must - // contain from 1 to 63 letters, numbers, or hyphens. - // - // * First character must be a - // letter. - // - // * Can't end with a hyphen or contain two consecutive hyphens. - // - // Example: - // my-cluster-snapshot2 + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Example: my-cluster-snapshot2 // // This member is required. TargetDBClusterSnapshotIdentifier *string @@ -110,28 +87,28 @@ type CopyDBClusterSnapshotInput struct { // snapshot to the target DB cluster snapshot. By default, tags are not copied. CopyTags *bool - // The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. - // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or - // alias name for the Amazon Web Services KMS key. If you copy an encrypted DB - // cluster snapshot from your Amazon Web Services account, you can specify a value - // for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a - // value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with - // the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB - // cluster snapshot that is shared from another Amazon Web Services account, then - // you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot - // to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web - // Services KMS key identifier you want to use to encrypt the copy of the DB - // cluster snapshot in the destination Amazon Web Services Region. KMS keys are - // specific to the Amazon Web Services Region that they are created in, and you - // can't use KMS keys from one Amazon Web Services Region in another Amazon Web - // Services Region. If you copy an unencrypted DB cluster snapshot and specify a - // value for the KmsKeyId parameter, an error is returned. + // The Amazon Web Services KMS key identifier for an encrypted DB cluster + // snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, + // alias ARN, or alias name for the Amazon Web Services KMS key. If you copy an + // encrypted DB cluster snapshot from your Amazon Web Services account, you can + // specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you + // don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is + // encrypted with the same KMS key as the source DB cluster snapshot. If you copy + // an encrypted DB cluster snapshot that is shared from another Amazon Web Services + // account, then you must specify a value for KmsKeyId . To copy an encrypted DB + // cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId + // to the Amazon Web Services KMS key identifier you want to use to encrypt the + // copy of the DB cluster snapshot in the destination Amazon Web Services Region. + // KMS keys are specific to the Amazon Web Services Region that they are created + // in, and you can't use KMS keys from one Amazon Web Services Region in another + // Amazon Web Services Region. If you copy an unencrypted DB cluster snapshot and + // specify a value for the KmsKeyId parameter, an error is returned. KmsKeyId *string - // When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud - // (US) Region to another, the URL that contains a Signature Version 4 signed - // request for the CopyDBClusterSnapshot API operation in the Amazon Web Services - // Region that contains the source DB cluster snapshot to copy. Use the + // When you are copying a DB cluster snapshot from one Amazon Web Services + // GovCloud (US) Region to another, the URL that contains a Signature Version 4 + // signed request for the CopyDBClusterSnapshot API operation in the Amazon Web + // Services Region that contains the source DB cluster snapshot to copy. Use the // PreSignedUrl parameter when copying an encrypted DB cluster snapshot from // another Amazon Web Services Region. Don't specify PreSignedUrl when copying an // encrypted DB cluster snapshot in the same Amazon Web Services Region. This @@ -140,33 +117,26 @@ type CopyDBClusterSnapshotInput struct { // for the CopyDBClusterSnapshot API operation that can run in the source Amazon // Web Services Region that contains the encrypted DB cluster snapshot to copy. The // presigned URL request must contain the following parameter values: - // - // * KmsKeyId - - // The KMS key identifier for the KMS key to use to encrypt the copy of the DB - // cluster snapshot in the destination Amazon Web Services Region. This is the same - // identifier for both the CopyDBClusterSnapshot operation that is called in the - // destination Amazon Web Services Region, and the operation contained in the - // presigned URL. - // - // * DestinationRegion - The name of the Amazon Web Services Region - // that the DB cluster snapshot is to be created in. - // - // * - // SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the - // encrypted DB cluster snapshot to be copied. This identifier must be in the - // Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For - // example, if you are copying an encrypted DB cluster snapshot from the us-west-2 - // Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks - // like the following example: - // arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. - // - // To - // learn how to generate a Signature Version 4 signed request, see Authenticating - // Requests: Using Query Parameters (Amazon Web Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // and Signature Version 4 Signing Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If you - // are using an Amazon Web Services SDK tool or the CLI, you can specify + // - KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy + // of the DB cluster snapshot in the destination Amazon Web Services Region. This + // is the same identifier for both the CopyDBClusterSnapshot operation that is + // called in the destination Amazon Web Services Region, and the operation + // contained in the presigned URL. + // - DestinationRegion - The name of the Amazon Web Services Region that the DB + // cluster snapshot is to be created in. + // - SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for + // the encrypted DB cluster snapshot to be copied. This identifier must be in the + // Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For + // example, if you are copying an encrypted DB cluster snapshot from the us-west-2 + // Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks + // like the following example: + // arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 + // . + // To learn how to generate a Signature Version 4 signed request, see + // Authenticating Requests: Using Query Parameters (Amazon Web Services Signature + // Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . If you are using an Amazon Web Services SDK tool or the CLI, you can specify // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl // manually. Specifying SourceRegion autogenerates a presigned URL that is a valid // request for the operation that can run in the source Amazon Web Services Region. @@ -176,13 +146,12 @@ type CopyDBClusterSnapshotInput struct { // region, if the PresignURL member is empty set. SourceRegion *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/rds/api_op_CopyDBParameterGroup.go b/service/rds/api_op_CopyDBParameterGroup.go index 66b313857d8..e3237375027 100644 --- a/service/rds/api_op_CopyDBParameterGroup.go +++ b/service/rds/api_op_CopyDBParameterGroup.go @@ -30,12 +30,9 @@ func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParamet type CopyDBParameterGroupInput struct { // The identifier or ARN for the source DB parameter group. For information about - // creating an ARN, see Constructing an ARN for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // creating an ARN, see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) // in the Amazon RDS User Guide. Constraints: - // - // * Must specify a valid DB parameter - // group. + // - Must specify a valid DB parameter group. // // This member is required. SourceDBParameterGroupIdentifier *string @@ -46,26 +43,17 @@ type CopyDBParameterGroupInput struct { TargetDBParameterGroupDescription *string // The identifier for the copied DB parameter group. Constraints: - // - // * Can't be null, - // empty, or blank - // - // * Must contain from 1 to 255 letters, numbers, or hyphens - // - // * - // First character must be a letter - // - // * Can't end with a hyphen or contain two - // consecutive hyphens - // + // - Can't be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-db-parameter-group // // This member is required. TargetDBParameterGroupIdentifier *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde @@ -73,8 +61,8 @@ type CopyDBParameterGroupInput struct { type CopyDBParameterGroupOutput struct { - // Contains the details of an Amazon RDS DB parameter group. This data type is used - // as a response element in the DescribeDBParameterGroups action. + // Contains the details of an Amazon RDS DB parameter group. This data type is + // used as a response element in the DescribeDBParameterGroups action. DBParameterGroup *types.DBParameterGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CopyDBSnapshot.go b/service/rds/api_op_CopyDBSnapshot.go index 67097e9d44d..8238614a202 100644 --- a/service/rds/api_op_CopyDBSnapshot.go +++ b/service/rds/api_op_CopyDBSnapshot.go @@ -18,8 +18,7 @@ import ( // another. In that case, the Amazon Web Services Region where you call the // CopyDBSnapshot operation is the destination Amazon Web Services Region for the // DB snapshot copy. This command doesn't apply to RDS Custom. For more information -// about copying snapshots, see Copying a DB Snapshot -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot) +// about copying snapshots, see Copying a DB Snapshot (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot) // in the Amazon RDS User Guide. func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*Options)) (*CopyDBSnapshotOutput, error) { if params == nil { @@ -38,20 +37,17 @@ func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput type CopyDBSnapshotInput struct { - // The identifier for the source DB snapshot. If the source snapshot is in the same - // Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. - // For example, you might specify rds:mysql-instance1-snapshot-20130805. If the - // source snapshot is in a different Amazon Web Services Region than the copy, - // specify a valid DB snapshot ARN. For example, you might specify - // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. + // The identifier for the source DB snapshot. If the source snapshot is in the + // same Amazon Web Services Region as the copy, specify a valid DB snapshot + // identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805 + // . If the source snapshot is in a different Amazon Web Services Region than the + // copy, specify a valid DB snapshot ARN. For example, you might specify + // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 . // If you are copying from a shared manual DB snapshot, this parameter must be the // Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an // encrypted snapshot this parameter must be in the ARN format for the source // Amazon Web Services Region. Constraints: - // - // * Must specify a valid system snapshot - // in the "available" state. - // + // - Must specify a valid system snapshot in the "available" state. // Example: rds:mydb-2012-04-02-00-01 Example: // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 // @@ -59,18 +55,10 @@ type CopyDBSnapshotInput struct { SourceDBSnapshotIdentifier *string // The identifier for the copy of the snapshot. Constraints: - // - // * Can't be null, - // empty, or blank - // - // * Must contain from 1 to 255 letters, numbers, or hyphens - // - // * - // First character must be a letter - // - // * Can't end with a hyphen or contain two - // consecutive hyphens - // + // - Can't be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-db-snapshot // // This member is required. @@ -108,8 +96,7 @@ type CopyDBSnapshotInput struct { // another, and your DB instance uses a nondefault option group. If your source DB // instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, // you must specify this option when copying across Amazon Web Services Regions. - // For more information, see Option group considerations - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options) + // For more information, see Option group considerations (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options) // in the Amazon RDS User Guide. OptionGroupName *string @@ -125,40 +112,33 @@ type CopyDBSnapshotInput struct { // the CopyDBClusterSnapshot API operation that can run in the source Amazon Web // Services Region that contains the encrypted DB cluster snapshot to copy. The // presigned URL request must contain the following parameter values: - // - // * - // DestinationRegion - The Amazon Web Services Region that the encrypted DB - // snapshot is copied to. This Amazon Web Services Region is the same one where the - // CopyDBSnapshot operation is called that contains this presigned URL. For - // example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web - // Services Region to the us-east-1 Amazon Web Services Region, then you call the - // CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide - // a presigned URL that contains a call to the CopyDBSnapshot operation in the - // us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in - // the presigned URL must be set to the us-east-1 Amazon Web Services Region. - // - // * - // KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of - // the DB snapshot in the destination Amazon Web Services Region. This is the same - // identifier for both the CopyDBSnapshot operation that is called in the - // destination Amazon Web Services Region, and the operation contained in the - // presigned URL. - // - // * SourceDBSnapshotIdentifier - The DB snapshot identifier for - // the encrypted snapshot to be copied. This identifier must be in the Amazon - // Resource Name (ARN) format for the source Amazon Web Services Region. For - // example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon - // Web Services Region, then your SourceDBSnapshotIdentifier looks like the - // following example: - // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. - // - // To - // learn how to generate a Signature Version 4 signed request, see Authenticating - // Requests: Using Query Parameters (Amazon Web Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // and Signature Version 4 Signing Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If you - // are using an Amazon Web Services SDK tool or the CLI, you can specify + // - DestinationRegion - The Amazon Web Services Region that the encrypted DB + // snapshot is copied to. This Amazon Web Services Region is the same one where the + // CopyDBSnapshot operation is called that contains this presigned URL. For + // example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web + // Services Region to the us-east-1 Amazon Web Services Region, then you call the + // CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and + // provide a presigned URL that contains a call to the CopyDBSnapshot operation + // in the us-west-2 Amazon Web Services Region. For this example, the + // DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web + // Services Region. + // - KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy + // of the DB snapshot in the destination Amazon Web Services Region. This is the + // same identifier for both the CopyDBSnapshot operation that is called in the + // destination Amazon Web Services Region, and the operation contained in the + // presigned URL. + // - SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted + // snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) + // format for the source Amazon Web Services Region. For example, if you are + // copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, + // then your SourceDBSnapshotIdentifier looks like the following example: + // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 + // . + // To learn how to generate a Signature Version 4 signed request, see + // Authenticating Requests: Using Query Parameters (Amazon Web Services Signature + // Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . If you are using an Amazon Web Services SDK tool or the CLI, you can specify // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl // manually. Specifying SourceRegion autogenerates a presigned URL that is a valid // request for the operation that can run in the source Amazon Web Services Region. @@ -168,17 +148,16 @@ type CopyDBSnapshotInput struct { // region, if the PresignURL member is empty set. SourceRegion *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // The external custom Availability Zone (CAZ) identifier for the target CAZ. - // Example: rds-caz-aiqhTgQv. + // Example: rds-caz-aiqhTgQv . TargetCustomAvailabilityZone *string - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde diff --git a/service/rds/api_op_CopyOptionGroup.go b/service/rds/api_op_CopyOptionGroup.go index 2f526c5a1ef..377ac868d77 100644 --- a/service/rds/api_op_CopyOptionGroup.go +++ b/service/rds/api_op_CopyOptionGroup.go @@ -30,9 +30,7 @@ func (c *Client) CopyOptionGroup(ctx context.Context, params *CopyOptionGroupInp type CopyOptionGroupInput struct { // The identifier for the source option group. Constraints: - // - // * Must specify a valid - // option group. + // - Must specify a valid option group. // // This member is required. SourceOptionGroupIdentifier *string @@ -43,26 +41,17 @@ type CopyOptionGroupInput struct { TargetOptionGroupDescription *string // The identifier for the copied option group. Constraints: - // - // * Can't be null, - // empty, or blank - // - // * Must contain from 1 to 255 letters, numbers, or hyphens - // - // * - // First character must be a letter - // - // * Can't end with a hyphen or contain two - // consecutive hyphens - // + // - Can't be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-option-group // // This member is required. TargetOptionGroupIdentifier *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_CreateBlueGreenDeployment.go b/service/rds/api_op_CreateBlueGreenDeployment.go index be0d8bfffe8..9c1eff2be56 100644 --- a/service/rds/api_op_CreateBlueGreenDeployment.go +++ b/service/rds/api_op_CreateBlueGreenDeployment.go @@ -22,11 +22,9 @@ import ( // You can thoroughly test changes in the green environment. When ready, you can // switch over the environments to promote the green environment to be the new // production environment. The switchover typically takes under a minute. For more -// information, see Using Amazon RDS Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// information, see Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBlueGreenDeploymentInput, optFns ...func(*Options)) (*CreateBlueGreenDeploymentOutput, error) { if params == nil { @@ -46,10 +44,8 @@ func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBl type CreateBlueGreenDeploymentInput struct { // The name of the blue/green deployment. Constraints: - // - // * Can't be the same as an - // existing blue/green deployment name in the same account and Amazon Web Services - // Region. + // - Can't be the same as an existing blue/green deployment name in the same + // account and Amazon Web Services Region. // // This member is required. BlueGreenDeploymentName *string @@ -71,9 +67,9 @@ type CreateBlueGreenDeploymentInput struct { // group that is different from the one associated with the source DB cluster. TargetDBClusterParameterGroupName *string - // The DB parameter group associated with the DB instance in the green environment. - // To test parameter changes, specify a DB parameter group that is different from - // the one associated with the source DB instance. + // The DB parameter group associated with the DB instance in the green + // environment. To test parameter changes, specify a DB parameter group that is + // different from the one associated with the source DB instance. TargetDBParameterGroupName *string // The engine version of the database in the green environment. Specify the engine @@ -86,11 +82,9 @@ type CreateBlueGreenDeploymentInput struct { type CreateBlueGreenDeploymentOutput struct { // Contains the details about a blue/green deployment. For more information, see - // Using Amazon RDS Blue/Green Deployments for database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) - // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for - // database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) + // Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) + // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for + // database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. BlueGreenDeployment *types.BlueGreenDeployment diff --git a/service/rds/api_op_CreateCustomDBEngineVersion.go b/service/rds/api_op_CreateCustomDBEngineVersion.go index 7ba50cb5bbd..9008f054514 100644 --- a/service/rds/api_op_CreateCustomDBEngineVersion.go +++ b/service/rds/api_op_CreateCustomDBEngineVersion.go @@ -31,13 +31,13 @@ func (c *Client) CreateCustomDBEngineVersion(ctx context.Context, params *Create type CreateCustomDBEngineVersionInput struct { // The database engine to use for your custom engine version (CEV). The only - // supported value is custom-oracle-ee. + // supported value is custom-oracle-ee . // // This member is required. Engine *string // The name of your CEV. The name format is 19.customized_string. For example, a - // valid CEV name is 19.my_cev1. This setting is required for RDS Custom for + // valid CEV name is 19.my_cev1 . This setting is required for RDS Custom for // Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion // is unique per customer per Region. // @@ -45,11 +45,11 @@ type CreateCustomDBEngineVersionInput struct { EngineVersion *string // The name of an Amazon S3 bucket that contains database installation files for - // your CEV. For example, a valid bucket name is my-custom-installation-files. + // your CEV. For example, a valid bucket name is my-custom-installation-files . DatabaseInstallationFilesS3BucketName *string // The Amazon S3 directory that contains the database installation files for your - // CEV. For example, a valid bucket name is 123456789012/cev1. If this setting + // CEV. For example, a valid bucket name is 123456789012/cev1 . If this setting // isn't specified, no prefix is assumed. DatabaseInstallationFilesS3Prefix *string @@ -65,8 +65,7 @@ type CreateCustomDBEngineVersionInput struct { // you have an existing symmetric encryption KMS key in your account, you can use // it with RDS Custom. No further action is necessary. If you don't already have a // symmetric encryption KMS key in your account, follow the instructions in - // Creating a symmetric encryption KMS key - // (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) + // Creating a symmetric encryption KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) // in the Amazon Web Services Key Management Service Developer Guide. You can // choose the same symmetric encryption key when you create a CEV and a DB // instance, or choose different keys. @@ -76,27 +75,25 @@ type CreateCustomDBEngineVersionInput struct { // files stored in Amazon S3. Specify the name/value pairs in a file or a quoted // string. RDS Custom applies the patches in the order in which they are listed. // The following JSON fields are valid: MediaImportTemplateVersion Version of the - // CEV manifest. The date is in the format YYYY-MM-DD. + // CEV manifest. The date is in the format YYYY-MM-DD . // databaseInstallationFileNames Ordered list of installation files for the CEV. // opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. // psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The // patches that are not in the list of PSU and RU patches. Amazon RDS applies these // patches after applying the PSU and RU patches. For more information, see - // Creating the CEV manifest - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) + // Creating the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) // in the Amazon RDS User Guide. Manifest *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type CreateCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. @@ -106,8 +103,7 @@ type CreateCustomDBEngineVersionOutput struct { // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. - // For more information, see JSON fields in the CEV manifest - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) + // For more information, see JSON fields in the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) // in the Amazon RDS User Guide. CustomDBEngineVersionManifest *string @@ -158,15 +154,13 @@ type CreateCustomDBEngineVersionOutput struct { // The major engine version of the CEV. MajorEngineVersion *string - // The status of the DB engine version, either available or deprecated. + // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. SupportedCACertificateIdentifiers []string @@ -177,13 +171,13 @@ type CreateCustomDBEngineVersionOutput struct { // A list of the supported DB engine modes. SupportedEngineModes []string - // A list of features supported by the DB engine. The supported features vary by DB - // engine and DB engine version. To determine the supported features for a specific - // DB engine and DB engine version using the CLI, use the following command: aws - // rds describe-db-engine-versions --engine --engine-version For example, to - // determine the supported features for RDS for PostgreSQL version 13.3 using the - // CLI, use the following command: aws rds describe-db-engine-versions --engine - // postgres --engine-version 13.3 The supported features are listed under + // A list of features supported by the DB engine. The supported features vary by + // DB engine and DB engine version. To determine the supported features for a + // specific DB engine and DB engine version using the CLI, use the following + // command: aws rds describe-db-engine-versions --engine --engine-version For + // example, to determine the supported features for RDS for PostgreSQL version 13.3 + // using the CLI, use the following command: aws rds describe-db-engine-versions + // --engine postgres --engine-version 13.3 The supported features are listed under // SupportedFeatureNames in the output. SupportedFeatureNames []string @@ -211,16 +205,15 @@ type CreateCustomDBEngineVersionOutput struct { // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs bool - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // A value that indicates whether you can use Aurora parallel query with a + // specific DB engine version. SupportsParallelQuery bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. diff --git a/service/rds/api_op_CreateDBCluster.go b/service/rds/api_op_CreateDBCluster.go index 255342fd687..51a14e23438 100644 --- a/service/rds/api_op_CreateDBCluster.go +++ b/service/rds/api_op_CreateDBCluster.go @@ -15,20 +15,17 @@ import ( // Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an // Aurora DB cluster, the request creates an empty cluster. You must explicitly -// create the writer instance for your DB cluster using the CreateDBInstance -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) +// create the writer instance for your DB cluster using the CreateDBInstance (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) // operation. If you create a Multi-AZ DB cluster, the request creates a writer and // two reader DB instances for you, each in a different Availability Zone. You can // use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB // cluster as a read replica of another DB cluster or Amazon RDS for MySQL or // PostgreSQL DB instance. For more information about Amazon Aurora, see What is -// Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. You can also use the // ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read // replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more -// information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error) { if params == nil { @@ -49,34 +46,20 @@ type CreateDBClusterInput struct { // The DB cluster identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. - // - // Example: my-cluster1 Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Example: my-cluster1 Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. DBClusterIdentifier *string // The name of the database engine to be used for this DB cluster. Valid Values: - // - // * - // aurora-mysql - // - // * aurora-postgresql - // - // * mysql - // - // * postgres - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - aurora-mysql + // - aurora-postgresql + // - mysql + // - postgres + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. Engine *string @@ -93,60 +76,49 @@ type CreateDBClusterInput struct { // A list of Availability Zones (AZs) where DB instances in the DB cluster can be // created. For information on Amazon Web Services Regions and Availability Zones, - // see Choosing the Regions and Availability Zones - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) + // see Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only AvailabilityZones []string - // The target backtrack window, in seconds. To disable backtracking, set this value - // to 0. Default: 0 Constraints: - // - // * If specified, this value must be set to a - // number from 0 to 259,200 (72 hours). - // + // The target backtrack window, in seconds. To disable backtracking, set this + // value to 0. Default: 0 Constraints: + // - If specified, this value must be set to a number from 0 to 259,200 (72 + // hours). // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 // The number of days for which automated backups are retained. Default: 1 // Constraints: - // - // * Must be a value from 1 to 35 - // - // Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // - Must be a value from 1 to 35 + // Valid for: Aurora DB clusters and Multi-AZ DB clusters BackupRetentionPeriod *int32 // A value that indicates that the DB cluster should be associated with the // specified CharacterSet. Valid for: Aurora DB clusters only CharacterSetName *string - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // A value that indicates whether to copy all tags from the DB cluster to + // snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora + // DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool // The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, // for example db.m6gd.xlarge. Not all DB instance classes are available in all // Amazon Web Services Regions, or for all database engines. For the full list of - // DB instance classes and availability for your engine, see DB instance class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // DB instance classes and availability for your engine, see DB instance class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB // cluster. Valid for: Multi-AZ DB clusters only DBClusterInstanceClass *string - // The name of the DB cluster parameter group to associate with this DB cluster. If - // you do not specify a value, then the default DB cluster parameter group for the - // specified DB engine and version is used. Constraints: - // - // * If supplied, must match - // the name of an existing DB cluster parameter group. - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // The name of the DB cluster parameter group to associate with this DB cluster. + // If you do not specify a value, then the default DB cluster parameter group for + // the specified DB engine and version is used. Constraints: + // - If supplied, must match the name of an existing DB cluster parameter group. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string - // A DB subnet group to associate with this DB cluster. This setting is required to - // create a Multi-AZ DB cluster. Constraints: Must match the name of an existing + // A DB subnet group to associate with this DB cluster. This setting is required + // to create a Multi-AZ DB cluster. Constraints: Must match the name of an existing // DBSubnetGroup. Must not be default. Example: mydbsubnetgroup Valid for: Aurora // DB clusters and Multi-AZ DB clusters DBSubnetGroupName *string @@ -165,11 +137,10 @@ type CreateDBClusterInput struct { // clusters DeletionProtection *bool - // The Active Directory directory ID to create the DB cluster in. For Amazon Aurora - // DB clusters, Amazon RDS can use Kerberos authentication to authenticate users - // that connect to the DB cluster. For more information, see Kerberos - // authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) + // The Active Directory directory ID to create the DB cluster in. For Amazon + // Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate + // users that connect to the DB cluster. For more information, see Kerberos + // authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only Domain *string @@ -179,22 +150,20 @@ type CreateDBClusterInput struct { // The list of log types that need to be enabled for exporting to CloudWatch Logs. // The values in the list depend on the DB engine being used. RDS for MySQL - // Possible values are error, general, and slowquery. RDS for PostgreSQL Possible - // values are postgresql and upgrade. Aurora MySQL Possible values are audit, - // error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. - // For more information about exporting CloudWatch Logs for Amazon RDS, see - // Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Possible values are error , general , and slowquery . RDS for PostgreSQL + // Possible values are postgresql and upgrade . Aurora MySQL Possible values are + // audit , error , general , and slowquery . Aurora PostgreSQL Possible value is + // postgresql . For more information about exporting CloudWatch Logs for Amazon + // RDS, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. For more information about exporting CloudWatch - // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters EnableCloudwatchLogsExports []string // A value that indicates whether to enable this DB cluster to forward write - // operations to the primary cluster of an Aurora global database (GlobalCluster). - // By default, write operations are not allowed on Aurora DB clusters that are + // operations to the primary cluster of an Aurora global database ( GlobalCluster + // ). By default, write operations are not allowed on Aurora DB clusters that are // secondary clusters in an Aurora global database. You can set this value only on // Aurora DB clusters that are members of an Aurora global database. With this // parameter enabled, a secondary cluster can forward writes to the current primary @@ -209,47 +178,30 @@ type CreateDBClusterInput struct { // enabled, the HTTP endpoint provides a connectionless web service API for running // SQL queries on the Aurora Serverless v1 DB cluster. You can also query your // database from inside the RDS console with the query editor. For more - // information, see Using the Data API for Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in - // the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableHttpEndpoint *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool // A value that indicates whether to turn on Performance Insights for the DB - // cluster. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // cluster. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only EnablePerformanceInsights *bool - // The DB engine mode of the DB cluster, either provisioned or serverless. The + // The DB engine mode of the DB cluster, either provisioned or serverless . The // serverless engine mode only applies for Aurora Serverless v1 DB clusters. // Limitations and requirements apply to some DB engine modes. For more // information, see the following sections in the Amazon Aurora User Guide: - // - // * - // Limitations of Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) - // - // * - // Requirements for Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) - // - // * - // Limitations of parallel query - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) - // - // * - // Limitations of Aurora global databases - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) - // - // Valid - // for: Aurora DB clusters only + // - Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) + // - Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) + // - Limitations of parallel query (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) + // - Limitations of Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) + // Valid for: Aurora DB clusters only EngineMode *string // The version number of the database engine to use. To list all of the available @@ -267,16 +219,12 @@ type CreateDBClusterInput struct { // for RDS for PostgreSQL, use the following command: aws rds // describe-db-engine-versions --engine postgres --query // "DBEngineVersions[].EngineVersion" Aurora MySQL For information, see Database - // engine updates for Amazon Aurora MySQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) + // engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) // in the Amazon Aurora User Guide. Aurora PostgreSQL For information, see Amazon - // Aurora PostgreSQL releases and engine versions - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) - // in the Amazon Aurora User Guide. MySQL For information, see Amazon RDS for MySQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) + // Aurora PostgreSQL releases and engine versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) + // in the Amazon Aurora User Guide. MySQL For information, see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) // in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for - // PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) + // PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) // in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters EngineVersion *string @@ -287,8 +235,7 @@ type CreateDBClusterInput struct { // The amount of Provisioned IOPS (input/output operations per second) to be // initially allocated for each DB instance in the Multi-AZ DB cluster. For - // information about valid IOPS values, see Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // information about valid IOPS values, see Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB // cluster. Constraints: Must be a multiple between .5 and 50 of the storage amount // for the DB cluster. Valid for: Multi-AZ DB clusters only @@ -298,50 +245,36 @@ type CreateDBClusterInput struct { // Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or // alias name for the KMS key. To use a KMS key in a different Amazon Web Services // account, specify the key ARN or alias ARN. When a KMS key isn't specified in - // KmsKeyId: - // - // * If ReplicationSourceIdentifier identifies an encrypted source, then - // Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon - // RDS will use your default KMS key. - // - // * If the StorageEncrypted parameter is - // enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will - // use your default KMS key. - // - // There is a default KMS key for your Amazon Web - // Services account. Your Amazon Web Services account has a different default KMS - // key for each Amazon Web Services Region. If you create a read replica of an - // encrypted DB cluster in another Amazon Web Services Region, you must set - // KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web - // Services Region. This KMS key is used to encrypt the read replica in that Amazon - // Web Services Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters + // KmsKeyId : + // - If ReplicationSourceIdentifier identifies an encrypted source, then Amazon + // RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will + // use your default KMS key. + // - If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier + // isn't specified, then Amazon RDS will use your default KMS key. + // There is a default KMS key for your Amazon Web Services account. Your Amazon + // Web Services account has a different default KMS key for each Amazon Web + // Services Region. If you create a read replica of an encrypted DB cluster in + // another Amazon Web Services Region, you must set KmsKeyId to a KMS key + // identifier that is valid in the destination Amazon Web Services Region. This KMS + // key is used to encrypt the read replica in that Amazon Web Services Region. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Web Services Secrets Manager. For more information, see Password management + // with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) + // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. Constraints: - // - // * Can't manage the master user - // password with Amazon Web Services Secrets Manager if MasterUserPassword is - // specified. - // + // - Can't manage the master user password with Amazon Web Services Secrets + // Manager if MasterUserPassword is specified. // Valid for: Aurora DB clusters and Multi-AZ DB clusters ManageMasterUserPassword *bool // The password for the master database user. This password can contain any // printable ASCII character except "/", """, or "@". Constraints: - // - // * Must contain - // from 8 to 41 characters. - // - // * Can't be specified if ManageMasterUserPassword is - // turned on. - // + // - Must contain from 8 to 41 characters. + // - Can't be specified if ManageMasterUserPassword is turned on. // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUserPassword *string @@ -351,7 +284,7 @@ type CreateDBClusterInput struct { // Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key // identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To // use a KMS key in a different Amazon Web Services account, specify the key ARN or - // alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the + // alias ARN. If you don't specify MasterUserSecretKmsKeyId , then the // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a // different Amazon Web Services account, then you can't use the aws/secretsmanager // KMS key to encrypt the secret, and you must use a customer managed KMS key. @@ -361,17 +294,10 @@ type CreateDBClusterInput struct { MasterUserSecretKmsKeyId *string // The name of the master user for the DB cluster. Constraints: - // - // * Must be 1 to 16 - // letters or numbers. - // - // * First character must be a letter. - // - // * Can't be a reserved - // word for the chosen database engine. - // - // Valid for: Aurora DB clusters and Multi-AZ - // DB clusters + // - Must be 1 to 16 letters or numbers. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUsername *string // The interval, in seconds, between points when Enhanced Monitoring metrics are @@ -383,24 +309,19 @@ type CreateDBClusterInput struct { // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send // Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is - // arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring - // role, see Setting up and enabling Enhanced Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only + // arn:aws:iam:123456789012:role/emaccess . For information on creating a + // monitoring role, see Setting up and enabling Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only MonitoringRoleArn *string // The network type of the DB cluster. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only NetworkType *string @@ -412,78 +333,59 @@ type CreateDBClusterInput struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you don't specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. - // Valid for: Multi-AZ DB clusters only + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. Valid for: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. Valid for: Multi-AZ DB clusters only + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. Valid for: Multi-AZ DB clusters only PerformanceInsightsRetentionPeriod *int32 - // The port number on which the instances in the DB cluster accept connections. RDS - // for MySQL and Aurora MySQL Default: 3306 Valid values: 1150-65535 RDS for + // The port number on which the instances in the DB cluster accept connections. + // RDS for MySQL and Aurora MySQL Default: 3306 Valid values: 1150-65535 RDS for // PostgreSQL and Aurora PostgreSQL Default: 5432 Valid values: 1150-65535 Valid // for: Aurora DB clusters and Multi-AZ DB clusters Port *int32 - // When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) - // Region to another, an URL that contains a Signature Version 4 signed request for - // the CreateDBCluster operation to be called in the source Amazon Web Services - // Region where the DB cluster is replicated from. Specify PreSignedUrl only when - // you are performing cross-Region replication from an encrypted DB cluster. The - // presigned URL must be a valid request for the CreateDBCluster API operation that - // can run in the source Amazon Web Services Region that contains the encrypted DB - // cluster to copy. The presigned URL request must contain the following parameter - // values: - // - // * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt - // the copy of the DB cluster in the destination Amazon Web Services Region. This - // should refer to the same KMS key for both the CreateDBCluster operation that is - // called in the destination Amazon Web Services Region, and the operation - // contained in the presigned URL. - // - // * DestinationRegion - The name of the Amazon - // Web Services Region that Aurora read replica will be created in. - // - // * - // ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB - // cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) - // format for the source Amazon Web Services Region. For example, if you are - // copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, - // then your ReplicationSourceIdentifier would look like Example: - // arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. - // - // To learn how to - // generate a Signature Version 4 signed request, see Authenticating Requests: - // Using Query Parameters (Amazon Web Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // and Signature Version 4 Signing Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If you - // are using an Amazon Web Services SDK tool or the CLI, you can specify + // When you are replicating a DB cluster from one Amazon Web Services GovCloud + // (US) Region to another, an URL that contains a Signature Version 4 signed + // request for the CreateDBCluster operation to be called in the source Amazon Web + // Services Region where the DB cluster is replicated from. Specify PreSignedUrl + // only when you are performing cross-Region replication from an encrypted DB + // cluster. The presigned URL must be a valid request for the CreateDBCluster API + // operation that can run in the source Amazon Web Services Region that contains + // the encrypted DB cluster to copy. The presigned URL request must contain the + // following parameter values: + // - KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy + // of the DB cluster in the destination Amazon Web Services Region. This should + // refer to the same KMS key for both the CreateDBCluster operation that is + // called in the destination Amazon Web Services Region, and the operation + // contained in the presigned URL. + // - DestinationRegion - The name of the Amazon Web Services Region that Aurora + // read replica will be created in. + // - ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB + // cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) + // format for the source Amazon Web Services Region. For example, if you are + // copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, + // then your ReplicationSourceIdentifier would look like Example: + // arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1 . + // To learn how to generate a Signature Version 4 signed request, see + // Authenticating Requests: Using Query Parameters (Amazon Web Services Signature + // Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . If you are using an Amazon Web Services SDK tool or the CLI, you can specify // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl // manually. Specifying SourceRegion autogenerates a presigned URL that is a valid // request for the operation that can run in the source Amazon Web Services Region. @@ -493,21 +395,12 @@ type CreateDBClusterInput struct { // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. To view the time blocks available, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) + // Web Services Region. To view the time blocks available, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) // in the Amazon Aurora User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 - // minutes. - // + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. // Valid for: Aurora DB clusters and Multi-AZ DB clusters PreferredBackupWindow *string @@ -515,8 +408,7 @@ type CreateDBClusterInput struct { // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon // Web Services Region, occurring on a random day of the week. To see the time - // blocks available, see Adjusting the Preferred DB Cluster Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) + // blocks available, see Adjusting the Preferred DB Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) // in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and // Multi-AZ DB clusters @@ -533,26 +425,17 @@ type CreateDBClusterInput struct { // private IP address. Default: The default behavior varies depending on whether // DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and // PubliclyAccessible isn't specified, the following applies: - // - // * If the default VPC - // in the target Region doesn’t have an internet gateway attached to it, the DB - // cluster is private. - // - // * If the default VPC in the target Region has an internet - // gateway attached to it, the DB cluster is public. - // - // If DBSubnetGroupName is - // specified, and PubliclyAccessible isn't specified, the following applies: - // - // * If - // the subnets are part of a VPC that doesn’t have an internet gateway attached to - // it, the DB cluster is private. - // - // * If the subnets are part of a VPC that has an - // internet gateway attached to it, the DB cluster is public. - // - // Valid for: Multi-AZ - // DB clusters only + // - If the default VPC in the target Region doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the default VPC in the target Region has an internet gateway attached to + // it, the DB cluster is public. + // If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the + // following applies: + // - If the subnets are part of a VPC that doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the subnets are part of a VPC that has an internet gateway attached to + // it, the DB cluster is public. + // Valid for: Multi-AZ DB clusters only PubliclyAccessible *bool // The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this @@ -565,8 +448,7 @@ type CreateDBClusterInput struct { ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For - // more information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration @@ -574,13 +456,13 @@ type CreateDBClusterInput struct { // region, if the PresignURL member is empty set. SourceRegion *string - // A value that indicates whether the DB cluster is encrypted. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // A value that indicates whether the DB cluster is encrypted. Valid for: Aurora + // DB clusters and Multi-AZ DB clusters StorageEncrypted *bool - // Specifies the storage type to be associated with the DB cluster. This setting is - // required to create a Multi-AZ DB cluster. Valid values: io1 When specified, a - // value for the Iops parameter is required. Default: io1 Valid for: Multi-AZ DB + // Specifies the storage type to be associated with the DB cluster. This setting + // is required to create a Multi-AZ DB cluster. Valid values: io1 When specified, + // a value for the Iops parameter is required. Default: io1 Valid for: Multi-AZ DB // clusters only StorageType *string @@ -592,8 +474,8 @@ type CreateDBClusterInput struct { // Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde @@ -603,19 +485,17 @@ type CreateDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_CreateDBClusterEndpoint.go b/service/rds/api_op_CreateDBClusterEndpoint.go index 0b44ba2beb9..899fe6203d2 100644 --- a/service/rds/api_op_CreateDBClusterEndpoint.go +++ b/service/rds/api_op_CreateDBClusterEndpoint.go @@ -42,7 +42,7 @@ type CreateDBClusterEndpointInput struct { // This member is required. DBClusterIdentifier *string - // The type of the endpoint, one of: READER, WRITER, ANY. + // The type of the endpoint, one of: READER , WRITER , ANY . // // This member is required. EndpointType *string @@ -64,21 +64,16 @@ type CreateDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Aurora DB cluster. This data type is used as a response element in the following // actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type CreateDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -99,7 +94,7 @@ type CreateDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -110,8 +105,8 @@ type CreateDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that can't be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that can't be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/rds/api_op_CreateDBClusterParameterGroup.go b/service/rds/api_op_CreateDBClusterParameterGroup.go index 07d53fb2cd9..fee93d32200 100644 --- a/service/rds/api_op_CreateDBClusterParameterGroup.go +++ b/service/rds/api_op_CreateDBClusterParameterGroup.go @@ -16,11 +16,11 @@ import ( // group is initially created with the default parameters for the database engine // used by instances in the DB cluster. To provide custom values for any of the // parameters, you must modify the group after creating it using -// ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, -// you need to associate it with your DB cluster using ModifyDBCluster. When you -// associate a new DB cluster parameter group with a running Aurora DB cluster, -// reboot the DB instances in the DB cluster without failover for the new DB -// cluster parameter group and associated settings to take effect. When you +// ModifyDBClusterParameterGroup . Once you've created a DB cluster parameter +// group, you need to associate it with your DB cluster using ModifyDBCluster . +// When you associate a new DB cluster parameter group with a running Aurora DB +// cluster, reboot the DB instances in the DB cluster without failover for the new +// DB cluster parameter group and associated settings to take effect. When you // associate a new DB cluster parameter group with a running Multi-AZ DB cluster, // reboot the DB cluster without failover for the new DB cluster parameter group // and associated settings to take effect. After you create a DB cluster parameter @@ -30,15 +30,13 @@ import ( // parameter group is used as the default for a new DB cluster. This is especially // important for parameters that are critical when creating the default database // for a DB cluster, such as the character set for the default database defined by -// the character_set_database parameter. You can use the Parameter Groups option of -// the Amazon RDS console (https://console.aws.amazon.com/rds/) or the +// the character_set_database parameter. You can use the Parameter Groups option +// of the Amazon RDS console (https://console.aws.amazon.com/rds/) or the // DescribeDBClusterParameters operation to verify that your DB cluster parameter // group has been created or modified. For more information on Amazon Aurora, see -// What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { @@ -58,12 +56,8 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea type CreateDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must not match the - // name of an existing DB cluster parameter group. - // - // This value is stored as a - // lowercase string. + // - Must not match the name of an existing DB cluster parameter group. + // This value is stored as a lowercase string. // // This member is required. DBClusterParameterGroupName *string @@ -72,28 +66,20 @@ type CreateDBClusterParameterGroupInput struct { // associated with one and only one DB cluster parameter group family, and can be // applied only to a DB cluster running a database engine and engine version // compatible with that DB cluster parameter group family. Aurora MySQL Example: - // aurora5.6, aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: - // aurora-postgresql9.6 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: - // postgres12 To list all of the available parameter group families for a DB + // aurora5.6 , aurora-mysql5.7 , aurora-mysql8.0 Aurora PostgreSQL Example: + // aurora-postgresql9.6 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL + // Example: postgres12 To list all of the available parameter group families for a + // DB engine, use the following command: aws rds describe-db-engine-versions + // --query "DBEngineVersions[].DBParameterGroupFamily" --engine For example, to + // list all of the available parameter group families for the Aurora PostgreSQL DB // engine, use the following command: aws rds describe-db-engine-versions --query - // "DBEngineVersions[].DBParameterGroupFamily" --engine For example, to list all - // of the available parameter group families for the Aurora PostgreSQL DB engine, - // use the following command: aws rds describe-db-engine-versions --query // "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The // output contains duplicates. The following are the valid DB engine values: - // - // * - // aurora (for MySQL 5.6-compatible Aurora) - // - // * aurora-mysql (for MySQL - // 5.7-compatible and MySQL 8.0-compatible Aurora) - // - // * aurora-postgresql - // - // * mysql - // - // * - // postgres + // - aurora (for MySQL 5.6-compatible Aurora) + // - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) + // - aurora-postgresql + // - mysql + // - postgres // // This member is required. DBParameterGroupFamily *string @@ -111,8 +97,9 @@ type CreateDBClusterParameterGroupInput struct { type CreateDBClusterParameterGroupOutput struct { - // Contains the details of an Amazon RDS DB cluster parameter group. This data type - // is used as a response element in the DescribeDBClusterParameterGroups action. + // Contains the details of an Amazon RDS DB cluster parameter group. This data + // type is used as a response element in the DescribeDBClusterParameterGroups + // action. DBClusterParameterGroup *types.DBClusterParameterGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBClusterSnapshot.go b/service/rds/api_op_CreateDBClusterSnapshot.go index 040955545eb..92e305383f5 100644 --- a/service/rds/api_op_CreateDBClusterSnapshot.go +++ b/service/rds/api_op_CreateDBClusterSnapshot.go @@ -12,11 +12,9 @@ import ( ) // Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see -// What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBClusterSnapshotInput, optFns ...func(*Options)) (*CreateDBClusterSnapshotOutput, error) { if params == nil { @@ -37,10 +35,7 @@ type CreateDBClusterSnapshotInput struct { // The identifier of the DB cluster to create a snapshot for. This parameter isn't // case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. - // + // - Must match the identifier of an existing DBCluster. // Example: my-cluster1 // // This member is required. @@ -48,15 +43,9 @@ type CreateDBClusterSnapshotInput struct { // The identifier of the DB cluster snapshot. This parameter is stored as a // lowercase string. Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or - // hyphens. - // - // * First character must be a letter. - // - // * Can't end with a hyphen or - // contain two consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. // Example: my-cluster1-snapshot1 // // This member is required. diff --git a/service/rds/api_op_CreateDBInstance.go b/service/rds/api_op_CreateDBInstance.go index 11e353c79a2..f0b4fa38fbd 100644 --- a/service/rds/api_op_CreateDBInstance.go +++ b/service/rds/api_op_CreateDBInstance.go @@ -14,12 +14,10 @@ import ( // Creates a new DB instance. The new DB instance can be an RDS DB instance, or it // can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can // call this operation multiple times to add more than one DB instance to the -// cluster. For more information about creating an RDS DB instance, see Creating -// an Amazon RDS DB instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) +// cluster. For more information about creating an RDS DB instance, see Creating +// an Amazon RDS DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) // in the Amazon RDS User Guide. For more information about creating a DB instance -// in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) +// in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) // in the Amazon Aurora User Guide. func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceInput, optFns ...func(*Options)) (*CreateDBInstanceOutput, error) { if params == nil { @@ -38,13 +36,11 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI type CreateDBInstanceInput struct { - // The compute and memory capacity of the DB instance, for example db.m5.large. Not - // all DB instance classes are available in all Amazon Web Services Regions, or for - // all database engines. For the full list of DB instance classes, and availability - // for your engine, see DB instance classes - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - // in the Amazon RDS User Guide or Aurora DB instance classes - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) + // The compute and memory capacity of the DB instance, for example db.m5.large. + // Not all DB instance classes are available in all Amazon Web Services Regions, or + // for all database engines. For the full list of DB instance classes, and + // availability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) // in the Amazon Aurora User Guide. // // This member is required. @@ -52,69 +48,36 @@ type CreateDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance // // This member is required. DBInstanceIdentifier *string - // The name of the database engine to be used for this instance. Not every database - // engine is available for every Amazon Web Services Region. Valid Values: - // - // * - // aurora (for MySQL 5.6-compatible Aurora) - // - // * aurora-mysql (for MySQL - // 5.7-compatible and MySQL 8.0-compatible Aurora) - // - // * aurora-postgresql - // - // * - // custom-oracle-ee (for RDS Custom for Oracle DB instances) - // - // * - // custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) - // - // * - // custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) - // - // * - // custom-sqlserver-se (for RDS Custom for SQL Server DB instances) - // - // * - // custom-sqlserver-web (for RDS Custom for SQL Server DB instances) - // - // * mariadb - // - // * - // mysql - // - // * oracle-ee - // - // * oracle-ee-cdb - // - // * oracle-se2 - // - // * oracle-se2-cdb - // - // * - // postgres - // - // * sqlserver-ee - // - // * sqlserver-se - // - // * sqlserver-ex - // - // * sqlserver-web + // The name of the database engine to be used for this instance. Not every + // database engine is available for every Amazon Web Services Region. Valid Values: + // + // - aurora (for MySQL 5.6-compatible Aurora) + // - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) + // - aurora-postgresql + // - custom-oracle-ee (for RDS Custom for Oracle DB instances) + // - custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) + // - custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) + // - custom-sqlserver-se (for RDS Custom for SQL Server DB instances) + // - custom-sqlserver-web (for RDS Custom for SQL Server DB instances) + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web // // This member is required. Engine *string @@ -124,103 +87,57 @@ type CreateDBInstanceInput struct { // as the amount of data in your database increases, though you are only charged // for the space that you use in an Aurora cluster volume. Amazon RDS Custom // Constraints to the amount of storage for each storage type are the following: - // - // * - // General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 - // for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. - // - // * Provisioned - // IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for - // Oracle, 16384 for RDS Custom for SQL Server. - // - // MySQL Constraints to the amount of - // storage for each storage type are the following: - // - // * General Purpose (SSD) - // storage (gp2, gp3): Must be an integer from 20 to 65536. - // - // * Provisioned IOPS - // storage (io1): Must be an integer from 100 to 65536. - // - // * Magnetic storage - // (standard): Must be an integer from 5 to 3072. - // - // MariaDB Constraints to the - // amount of storage for each storage type are the following: - // - // * General Purpose - // (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536. - // - // * Provisioned - // IOPS storage (io1): Must be an integer from 100 to 65536. - // - // * Magnetic storage - // (standard): Must be an integer from 5 to 3072. - // - // PostgreSQL Constraints to the - // amount of storage for each storage type are the following: - // - // * General Purpose - // (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536. - // - // * Provisioned - // IOPS storage (io1): Must be an integer from 100 to 65536. - // - // * Magnetic storage - // (standard): Must be an integer from 5 to 3072. - // - // Oracle Constraints to the amount - // of storage for each storage type are the following: - // - // * General Purpose (SSD) - // storage (gp2, gp3): Must be an integer from 20 to 65536. - // - // * Provisioned IOPS - // storage (io1): Must be an integer from 100 to 65536. - // - // * Magnetic storage - // (standard): Must be an integer from 10 to 3072. - // - // SQL Server Constraints to the - // amount of storage for each storage type are the following: - // - // * General Purpose - // (SSD) storage (gp2, gp3): - // - // * Enterprise and Standard editions: Must be an - // integer from 20 to 16384. - // - // * Web and Express editions: Must be an integer from - // 20 to 16384. - // - // * Provisioned IOPS storage (io1): - // - // * Enterprise and Standard - // editions: Must be an integer from 100 to 16384. - // - // * Web and Express editions: - // Must be an integer from 100 to 16384. - // - // * Magnetic storage (standard): - // - // * - // Enterprise and Standard editions: Must be an integer from 20 to 1024. - // - // * Web and - // Express editions: Must be an integer from 20 to 1024. + // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to + // 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. + // - Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS + // Custom for Oracle, 16384 for RDS Custom for SQL Server. + // MySQL Constraints to the amount of storage for each storage type are the + // following: + // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to + // 65536. + // - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // MariaDB Constraints to the amount of storage for each storage type are the + // following: + // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to + // 65536. + // - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // PostgreSQL Constraints to the amount of storage for each storage type are the + // following: + // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to + // 65536. + // - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // Oracle Constraints to the amount of storage for each storage type are the + // following: + // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to + // 65536. + // - Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // - Magnetic storage (standard): Must be an integer from 10 to 3072. + // SQL Server Constraints to the amount of storage for each storage type are the + // following: + // - General Purpose (SSD) storage (gp2, gp3): + // - Enterprise and Standard editions: Must be an integer from 20 to 16384. + // - Web and Express editions: Must be an integer from 20 to 16384. + // - Provisioned IOPS storage (io1): + // - Enterprise and Standard editions: Must be an integer from 100 to 16384. + // - Web and Express editions: Must be an integer from 100 to 16384. + // - Magnetic storage (standard): + // - Enterprise and Standard editions: Must be an integer from 20 to 1024. + // - Web and Express editions: Must be an integer from 20 to 1024. AllocatedStorage *int32 // A value that indicates whether minor engine upgrades are applied automatically // to the DB instance during the maintenance window. By default, minor engine // upgrades are applied automatically. If you create an RDS Custom DB instance, you - // must set AutoMinorVersionUpgrade to false. + // must set AutoMinorVersionUpgrade to false . AutoMinorVersionUpgrade *bool // The Availability Zone (AZ) where the database will be created. For information // on Amazon Web Services Regions and Availability Zones, see Regions and - // Availability Zones - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). - // Amazon Aurora Each Aurora DB cluster hosts copies of its storage in three + // Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) + // . Amazon Aurora Each Aurora DB cluster hosts copies of its storage in three // separate Availability Zones. Specify one of these Availability Zones. Aurora // automatically chooses an appropriate Availability Zone if you don't specify one. // Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web @@ -234,63 +151,49 @@ type CreateDBInstanceInput struct { // parameter to a positive number enables backups. Setting this parameter to 0 // disables automated backups. Amazon Aurora Not applicable. The retention period // for automated backups is managed by the DB cluster. Default: 1 Constraints: - // - // * - // Must be a value from 0 to 35 - // - // * Can't be set to 0 if the DB instance is a source - // to read replicas - // - // * Can't be set to 0 for an RDS Custom for Oracle DB instance + // - Must be a value from 0 to 35 + // - Can't be set to 0 if the DB instance is a source to read replicas + // - Can't be set to 0 for an RDS Custom for Oracle DB instance BackupRetentionPeriod *int32 // Specifies where automated backups and manual snapshots are stored. Possible // values are outposts (Amazon Web Services Outposts) and region (Amazon Web - // Services Region). The default is region. For more information, see Working with - // Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. + // Services Region). The default is region . For more information, see Working + // with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. BackupTarget *string // Specifies the CA certificate identifier to use for the DB instance’s server // certificate. This setting doesn't apply to RDS Custom. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string // For supported engines, this value indicates that the DB instance should be - // associated with the specified CharacterSet. This setting doesn't apply to RDS + // associated with the specified CharacterSet . This setting doesn't apply to RDS // Custom. However, if you need to change the character set, you can change it on // the database itself. Amazon Aurora Not applicable. The character set is managed - // by the DB cluster. For more information, see CreateDBCluster. + // by the DB cluster. For more information, see CreateDBCluster . CharacterSetName *string - // A value that indicates whether to copy tags from the DB instance to snapshots of - // the DB instance. By default, tags are not copied. Amazon Aurora Not applicable. - // Copying tags to snapshots is managed by the DB cluster. Setting this value for - // an Aurora DB instance has no effect on the DB cluster setting. + // A value that indicates whether to copy tags from the DB instance to snapshots + // of the DB instance. By default, tags are not copied. Amazon Aurora Not + // applicable. Copying tags to snapshots is managed by the DB cluster. Setting this + // value for an Aurora DB instance has no effect on the DB cluster setting. CopyTagsToSnapshot *bool // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. The instance profile must meet the following // requirements: - // - // * The profile must exist in your account. - // - // * The profile must - // have an IAM role that Amazon EC2 has permissions to assume. - // - // * The instance - // profile name and the associated IAM role name must start with the prefix - // AWSRDSCustom. - // - // For the list of permissions required for the IAM role, see - // Configure IAM and your VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) + // - The profile must exist in your account. + // - The profile must have an IAM role that Amazon EC2 has permissions to + // assume. + // - The instance profile name and the associated IAM role name must start with + // the prefix AWSRDSCustom . + // For the list of permissions required for the IAM role, see Configure IAM and + // your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. This setting is required for RDS Custom. CustomIamInstanceProfile *string @@ -302,100 +205,58 @@ type CreateDBInstanceInput struct { // MySQL The name of the database to create when the DB instance is created. If // this parameter isn't specified, no database is created in the DB instance. // Constraints: - // - // * Must contain 1 to 64 letters or numbers. - // - // * Must begin with a - // letter. Subsequent characters can be letters, underscores, or digits (0-9). - // - // * - // Can't be a word reserved by the specified database engine - // - // MariaDB The name of - // the database to create when the DB instance is created. If this parameter isn't - // specified, no database is created in the DB instance. Constraints: - // - // * Must - // contain 1 to 64 letters or numbers. - // - // * Must begin with a letter. Subsequent - // characters can be letters, underscores, or digits (0-9). - // - // * Can't be a word - // reserved by the specified database engine - // - // PostgreSQL The name of the database - // to create when the DB instance is created. If this parameter isn't specified, a - // database named postgres is created in the DB instance. Constraints: - // - // * Must - // contain 1 to 63 letters, numbers, or underscores. - // - // * Must begin with a letter. - // Subsequent characters can be letters, underscores, or digits (0-9). - // - // * Can't be - // a word reserved by the specified database engine - // - // Oracle The Oracle System ID - // (SID) of the created DB instance. If you specify null, the default value ORCL is - // used. You can't specify the string NULL, or any other reserved word, for DBName. - // Default: ORCL Constraints: - // - // * Can't be longer than 8 characters - // - // Amazon RDS - // Custom for Oracle The Oracle System ID (SID) of the created RDS Custom DB - // instance. If you don't specify a value, the default value is ORCL. Default: ORCL + // - Must contain 1 to 64 letters or numbers. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0-9). + // - Can't be a word reserved by the specified database engine + // MariaDB The name of the database to create when the DB instance is created. If + // this parameter isn't specified, no database is created in the DB instance. // Constraints: - // - // * It must contain 1 to 8 alphanumeric characters. - // - // * It must - // contain a letter. - // - // * It can't be a word reserved by the database engine. - // - // Amazon - // RDS Custom for SQL Server Not applicable. Must be null. SQL Server Not + // - Must contain 1 to 64 letters or numbers. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0-9). + // - Can't be a word reserved by the specified database engine + // PostgreSQL The name of the database to create when the DB instance is created. + // If this parameter isn't specified, a database named postgres is created in the + // DB instance. Constraints: + // - Must contain 1 to 63 letters, numbers, or underscores. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0-9). + // - Can't be a word reserved by the specified database engine + // Oracle The Oracle System ID (SID) of the created DB instance. If you specify + // null , the default value ORCL is used. You can't specify the string NULL, or + // any other reserved word, for DBName . Default: ORCL Constraints: + // - Can't be longer than 8 characters + // Amazon RDS Custom for Oracle The Oracle System ID (SID) of the created RDS + // Custom DB instance. If you don't specify a value, the default value is ORCL . + // Default: ORCL Constraints: + // - It must contain 1 to 8 alphanumeric characters. + // - It must contain a letter. + // - It can't be a word reserved by the database engine. + // Amazon RDS Custom for SQL Server Not applicable. Must be null. SQL Server Not // applicable. Must be null. Amazon Aurora MySQL The name of the database to create // when the primary DB instance of the Aurora MySQL DB cluster is created. If this // parameter isn't specified for an Aurora MySQL DB cluster, no database is created // in the DB cluster. Constraints: - // - // * It must contain 1 to 64 alphanumeric - // characters. - // - // * It can't be a word reserved by the database engine. - // - // Amazon - // Aurora PostgreSQL The name of the database to create when the primary DB + // - It must contain 1 to 64 alphanumeric characters. + // - It can't be a word reserved by the database engine. + // Amazon Aurora PostgreSQL The name of the database to create when the primary DB // instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't // specified for an Aurora PostgreSQL DB cluster, a database named postgres is // created in the DB cluster. Constraints: - // - // * It must contain 1 to 63 alphanumeric - // characters. - // - // * It must begin with a letter. Subsequent characters can be - // letters, underscores, or digits (0 to 9). - // - // * It can't be a word reserved by the - // database engine. + // - It must contain 1 to 63 alphanumeric characters. + // - It must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0 to 9). + // - It can't be a word reserved by the database engine. DBName *string - // The name of the DB parameter group to associate with this DB instance. If you do - // not specify a value, then the default DB parameter group for the specified DB + // The name of the DB parameter group to associate with this DB instance. If you + // do not specify a value, then the default DB parameter group for the specified DB // engine and version is used. This setting doesn't apply to RDS Custom. // Constraints: - // - // * It must be 1 to 255 letters, numbers, or hyphens. - // - // * The first - // character must be a letter. - // - // * It can't end with a hyphen or contain two - // consecutive hyphens. + // - It must be 1 to 255 letters, numbers, or hyphens. + // - The first character must be a letter. + // - It can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *string // A list of DB security groups to associate with this DB instance. This setting @@ -410,20 +271,17 @@ type CreateDBInstanceInput struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). - // Amazon Aurora Not applicable. You can enable or disable deletion protection for - // the DB cluster. For more information, see CreateDBCluster. DB instances in a DB - // cluster can be deleted even when deletion protection is enabled for the DB + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . Amazon Aurora Not applicable. You can enable or disable deletion protection + // for the DB cluster. For more information, see CreateDBCluster . DB instances in + // a DB cluster can be deleted even when deletion protection is enabled for the DB // cluster. DeletionProtection *bool // The Active Directory directory ID to create the DB instance in. Currently, only // MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created - // in an Active Directory Domain. For more information, see Kerberos - // Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // in an Active Directory Domain. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Amazon // Aurora Not applicable. The domain is managed by the DB cluster. Domain *string @@ -435,14 +293,14 @@ type CreateDBInstanceInput struct { // The list of log types that need to be enabled for exporting to CloudWatch Logs. // The values in the list depend on the DB engine. For more information, see - // Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. Amazon Aurora Not applicable. CloudWatch Logs // exports are managed by the DB cluster. RDS Custom Not applicable. MariaDB - // Possible values are audit, error, general, and slowquery. Microsoft SQL Server - // Possible values are agent and error. MySQL Possible values are audit, error, - // general, and slowquery. Oracle Possible values are alert, audit, listener, - // trace, and oemagent. PostgreSQL Possible values are postgresql and upgrade. + // Possible values are audit , error , general , and slowquery . Microsoft SQL + // Server Possible values are agent and error . MySQL Possible values are audit , + // error , general , and slowquery . Oracle Possible values are alert , audit , + // listener , trace , and oemagent . PostgreSQL Possible values are postgresql and + // upgrade . EnableCloudwatchLogsExports []string // A value that indicates whether to enable a customer-owned IP address (CoIP) for @@ -451,27 +309,23 @@ type CreateDBInstanceInput struct { // use cases, a CoIP can provide lower latency for connections to the DB instance // from outside of its virtual private cloud (VPC) on your local network. For more // information about RDS on Outposts, see Working with Amazon RDS on Amazon Web - // Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication for MySQL - // and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication + // for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Amazon // Aurora Not applicable. Mapping Amazon Web Services IAM accounts to database // accounts is managed by the DB cluster. EnableIAMDatabaseAuthentication *bool // A value that indicates whether to enable Performance Insights for the DB - // instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnablePerformanceInsights *bool @@ -484,35 +338,27 @@ type CreateDBInstanceInput struct { // cluster. Amazon RDS Custom for Oracle A custom engine version (CEV) that you // have previously created. This setting is required for RDS Custom for Oracle. The // CEV name has the following format: 19.customized_string. A valid CEV name is - // 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB - // instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) + // 19.my_cev1 . For more information, see Creating an RDS Custom for Oracle DB + // instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) // in the Amazon RDS User Guide. Amazon RDS Custom for SQL Server See RDS Custom - // for SQL Server general requirements - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html) - // in the Amazon RDS User Guide. MariaDB For information, see MariaDB on Amazon RDS - // Versions - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) + // for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html) + // in the Amazon RDS User Guide. MariaDB For information, see MariaDB on Amazon + // RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) // in the Amazon RDS User Guide. Microsoft SQL Server For information, see - // Microsoft SQL Server Versions on Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) + // Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) // in the Amazon RDS User Guide. MySQL For information, see MySQL on Amazon RDS - // Versions - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) - // in the Amazon RDS User Guide. Oracle For information, see Oracle Database Engine - // Release Notes - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) + // Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) + // in the Amazon RDS User Guide. Oracle For information, see Oracle Database + // Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) // in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for - // PostgreSQL versions and extensions - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) + // PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) // in the Amazon RDS User Guide. EngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to be // initially allocated for the DB instance. For information about valid IOPS - // values, see Amazon RDS DB instance storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in - // the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and + // values, see Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) + // in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and // PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage // amount for the DB instance. For SQL Server DB instances, must be a multiple // between 1 and 50 of the storage amount for the DB instance. Amazon Aurora Not @@ -524,31 +370,28 @@ type CreateDBInstanceInput struct { // alias name for the KMS key. To use a KMS key in a different Amazon Web Services // account, specify the key ARN or alias ARN. Amazon Aurora Not applicable. The // Amazon Web Services KMS key identifier is managed by the DB cluster. For more - // information, see CreateDBCluster. If StorageEncrypted is enabled, and you do not - // specify a value for the KmsKeyId parameter, then Amazon RDS uses your default - // KMS key. There is a default KMS key for your Amazon Web Services account. Your - // Amazon Web Services account has a different default KMS key for each Amazon Web - // Services Region. Amazon RDS Custom A KMS key is required for RDS Custom - // instances. For most RDS engines, if you leave this parameter empty while - // enabling StorageEncrypted, the engine uses the default KMS key. However, RDS + // information, see CreateDBCluster . If StorageEncrypted is enabled, and you do + // not specify a value for the KmsKeyId parameter, then Amazon RDS uses your + // default KMS key. There is a default KMS key for your Amazon Web Services + // account. Your Amazon Web Services account has a different default KMS key for + // each Amazon Web Services Region. Amazon RDS Custom A KMS key is required for RDS + // Custom instances. For most RDS engines, if you leave this parameter empty while + // enabling StorageEncrypted , the engine uses the default KMS key. However, RDS // Custom doesn't use the default key when this parameter is empty. You must // explicitly specify a key. KmsKeyId *string - // License model information for this DB instance. Valid values: license-included | - // bring-your-own-license | general-public-license This setting doesn't apply to + // License model information for this DB instance. Valid values: license-included + // | bring-your-own-license | general-public-license This setting doesn't apply to // RDS Custom. Amazon Aurora Not applicable. LicenseModel *string // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Web Services Secrets Manager. For more information, see Password management + // with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: - // - // * Can't manage the master user - // password with Amazon Web Services Secrets Manager if MasterUserPassword is - // specified. + // - Can't manage the master user password with Amazon Web Services Secrets + // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool // The password for the master user. The password can include any printable ASCII @@ -567,7 +410,7 @@ type CreateDBInstanceInput struct { // Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS // key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. // To use a KMS key in a different Amazon Web Services account, specify the key ARN - // or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the + // or alias ARN. If you don't specify MasterUserSecretKmsKeyId , then the // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a // different Amazon Web Services account, then you can't use the aws/secretsmanager // KMS key to encrypt the secret, and you must use a customer managed KMS key. @@ -578,24 +421,16 @@ type CreateDBInstanceInput struct { // The name for the master user. Amazon Aurora Not applicable. The name for the // master user is managed by the DB cluster. Amazon RDS Constraints: - // - // * - // Required. - // - // * Must be 1 to 16 letters, numbers, or underscores. - // - // * First - // character must be a letter. - // - // * Can't be a reserved word for the chosen database - // engine. + // - Required. + // - Must be 1 to 16 letters, numbers, or underscores. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. MasterUsername *string // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale // the storage of the DB instance. For more information about this setting, - // including limitations that apply to it, see Managing capacity automatically - // with Amazon RDS storage autoscaling - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) + // including limitations that apply to it, see Managing capacity automatically + // with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Amazon // Aurora Not applicable. Storage is managed by the DB cluster. MaxAllocatedStorage *int32 @@ -607,14 +442,13 @@ type CreateDBInstanceInput struct { // apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to - // Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For - // information on creating a monitoring role, see Setting Up and Enabling Enhanced - // Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to - // RDS Custom. + // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics + // to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . + // For information on creating a monitoring role, see Setting Up and Enabling + // Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, then you must supply a MonitoringRoleArn value. This setting doesn't + // apply to RDS Custom. MonitoringRoleArn *string // A value that indicates whether the DB instance is a Multi-AZ deployment. You @@ -628,16 +462,12 @@ type CreateDBInstanceInput struct { NcharCharacterSetName *string // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string @@ -652,70 +482,51 @@ type CreateDBInstanceInput struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you do not specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. - // This setting doesn't apply to RDS Custom. + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. This setting doesn't apply to RDS Custom. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. This setting doesn't apply to RDS Custom. + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. This setting doesn't apply to RDS Custom. PerformanceInsightsRetentionPeriod *int32 // The port number on which the database accepts connections. MySQL Default: 3306 // Valid values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid values: - // 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid values: 1150-65535 Type: - // Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 - // Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and - // 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535 Type: Integer + // 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid values: 1150-65535 + // Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: + // 1433 Valid values: 1150-65535 except 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , + // and 49152-49156 . Amazon Aurora Default: 3306 Valid values: 1150-65535 Type: + // Integer Port *int32 // The daily time range during which automated backups are created if automated - // backups are enabled, using the BackupRetentionPeriod parameter. The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. For more information, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) + // backups are enabled, using the BackupRetentionPeriod parameter. The default is + // a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Web Services Region. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range // for creating automated backups is managed by the DB cluster. Constraints: - // - // * - // Must be in the format hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time - // (UTC). - // - // * Must not conflict with the preferred maintenance window. - // - // * Must be at - // least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance). - // Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at + // The time range each week during which system maintenance can occur, in + // Universal Coordinated Time (UTC). For more information, see Amazon RDS + // Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // . Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at // random from an 8-hour block of time for each Amazon Web Services Region, // occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, // Sun. Constraints: Minimum 30-minute window. @@ -728,8 +539,7 @@ type CreateDBInstanceInput struct { // A value that specifies the order in which an Aurora Replica is promoted to the // primary instance after a failure of the existing primary instance. For more - // information, see Fault Tolerance for an Aurora DB Cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. // Default: 1 Valid Values: 0 - 15 PromotionTier *int32 @@ -745,39 +555,32 @@ type CreateDBInstanceInput struct { // to a private IP address. Default: The default behavior varies depending on // whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, // and PubliclyAccessible isn't specified, the following applies: - // - // * If the default - // VPC in the target Region doesn’t have an internet gateway attached to it, the DB - // instance is private. - // - // * If the default VPC in the target Region has an internet - // gateway attached to it, the DB instance is public. - // - // If DBSubnetGroupName is - // specified, and PubliclyAccessible isn't specified, the following applies: - // - // * If - // the subnets are part of a VPC that doesn’t have an internet gateway attached to - // it, the DB instance is private. - // - // * If the subnets are part of a VPC that has an - // internet gateway attached to it, the DB instance is public. + // - If the default VPC in the target Region doesn’t have an internet gateway + // attached to it, the DB instance is private. + // - If the default VPC in the target Region has an internet gateway attached to + // it, the DB instance is public. + // If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the + // following applies: + // - If the subnets are part of a VPC that doesn’t have an internet gateway + // attached to it, the DB instance is private. + // - If the subnets are part of a VPC that has an internet gateway attached to + // it, the DB instance is public. PubliclyAccessible *bool // A value that indicates whether the DB instance is encrypted. By default, it // isn't encrypted. For RDS Custom instances, either set this parameter to true or - // leave it unset. If you set this parameter to false, RDS reports an error. Amazon - // Aurora Not applicable. The encryption for DB instances is managed by the DB - // cluster. + // leave it unset. If you set this parameter to false , RDS reports an error. + // Amazon Aurora Not applicable. The encryption for DB instances is managed by the + // DB cluster. StorageEncrypted *bool - // Specifies the storage throughput value for the DB instance. This setting applies - // only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon - // Aurora. + // Specifies the storage throughput value for the DB instance. This setting + // applies only to the gp3 storage type. This setting doesn't apply to RDS Custom + // or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. Valid values: - // gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a + // gp2 | gp3 | io1 | standard If you specify io1 or gp3 , you must also include a // value for the Iops parameter. Default: io1 if the Iops parameter is specified, // otherwise gp2 Amazon Aurora Not applicable. Storage is managed by the DB // cluster. @@ -791,13 +594,13 @@ type CreateDBInstanceInput struct { // applicable. TdeCredentialArn *string - // The password for the given ARN from the key store in order to access the device. - // This setting doesn't apply to RDS Custom. + // The password for the given ARN from the key store in order to access the + // device. This setting doesn't apply to RDS Custom. TdeCredentialPassword *string - // The time zone of the DB instance. The time zone parameter is currently supported - // only by Microsoft SQL Server - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). + // The time zone of the DB instance. The time zone parameter is currently + // supported only by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) + // . Timezone *string // A list of Amazon EC2 VPC security groups to associate with this DB instance. @@ -812,11 +615,11 @@ type CreateDBInstanceInput struct { type CreateDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBInstanceReadReplica.go b/service/rds/api_op_CreateDBInstanceReadReplica.go index 35f376b6810..3188b80e4f8 100644 --- a/service/rds/api_op_CreateDBInstanceReadReplica.go +++ b/service/rds/api_op_CreateDBInstanceReadReplica.go @@ -17,16 +17,14 @@ import ( // instance or Multi-AZ DB cluster. You can create a read replica for a DB instance // running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read // replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more -// information, see Working with read replicas -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) and -// Migrating from a Multi-AZ DB cluster to a DB instance using a read replica -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica) +// information, see Working with read replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) +// and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica) // in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. Call -// the CreateDBInstance operation to create a DB instance for an Aurora DB cluster. -// All read replica DB instances are created with backups disabled. All other -// attributes (including DB security groups and DB parameter groups) are inherited -// from the source DB instance or cluster, except as specified. Your source DB -// instance or cluster must have backup retention enabled. +// the CreateDBInstance operation to create a DB instance for an Aurora DB +// cluster. All read replica DB instances are created with backups disabled. All +// other attributes (including DB security groups and DB parameter groups) are +// inherited from the source DB instance or cluster, except as specified. Your +// source DB instance or cluster must have backup retention enabled. func (c *Client) CreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, optFns ...func(*Options)) (*CreateDBInstanceReadReplicaOutput, error) { if params == nil { params = &CreateDBInstanceReadReplicaInput{} @@ -51,10 +49,10 @@ type CreateDBInstanceReadReplicaInput struct { // This member is required. DBInstanceIdentifier *string - // The amount of storage (in gibibytes) to allocate initially for the read replica. - // Follow the allocation rules specified in CreateDBInstance. Be sure to allocate - // enough storage for your read replica so that the create operation can succeed. - // You can also allocate additional storage for future growth. + // The amount of storage (in gibibytes) to allocate initially for the read + // replica. Follow the allocation rules specified in CreateDBInstance . Be sure to + // allocate enough storage for your read replica so that the create operation can + // succeed. You can also allocate additional storage for future growth. AllocatedStorage *int32 // A value that indicates whether minor engine upgrades are applied automatically @@ -74,83 +72,59 @@ type CreateDBInstanceReadReplicaInput struct { // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. The instance profile must meet the following // requirements: - // - // * The profile must exist in your account. - // - // * The profile must - // have an IAM role that Amazon EC2 has permissions to assume. - // - // * The instance - // profile name and the associated IAM role name must start with the prefix - // AWSRDSCustom. - // - // For the list of permissions required for the IAM role, see - // Configure IAM and your VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) + // - The profile must exist in your account. + // - The profile must have an IAM role that Amazon EC2 has permissions to + // assume. + // - The instance profile name and the associated IAM role name must start with + // the prefix AWSRDSCustom . + // For the list of permissions required for the IAM role, see Configure IAM and + // your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. This setting is required for RDS Custom. CustomIamInstanceProfile *string // The compute and memory capacity of the read replica, for example db.m4.large. // Not all DB instance classes are available in all Amazon Web Services Regions, or // for all database engines. For the full list of DB instance classes, and - // availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Default: Inherits from the source DB instance. DBInstanceClass *string - // The name of the DB parameter group to associate with this DB instance. If you do - // not specify a value for DBParameterGroupName, then Amazon RDS uses the + // The name of the DB parameter group to associate with this DB instance. If you + // do not specify a value for DBParameterGroupName , then Amazon RDS uses the // DBParameterGroup of source DB instance for a same Region read replica, or the // default DBParameterGroup for the specified DB engine for a cross-Region read // replica. Specifying a parameter group for this operation is only supported for - // MySQL and Oracle DB instances. It isn't supported for RDS Custom. - // Constraints: - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * First - // character must be a letter - // - // * Can't end with a hyphen or contain two consecutive - // hyphens + // MySQL and Oracle DB instances. It isn't supported for RDS Custom. Constraints: + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens DBParameterGroupName *string // Specifies a DB subnet group for the DB instance. The new DB instance is created // in the VPC associated with the DB subnet group. If no DB subnet group is // specified, then the new DB instance isn't created in a VPC. Constraints: - // - // * If - // supplied, must match the name of an existing DBSubnetGroup. - // - // * The specified DB - // subnet group must be in the same Amazon Web Services Region in which the - // operation is running. - // - // * All read replicas in one Amazon Web Services Region - // that are created from the same source DB instance must either:> - // - // * Specify DB - // subnet groups from the same VPC. All these read replicas are created in the same - // VPC. - // - // * Not specify a DB subnet group. All these read replicas are created - // outside of any VPC. - // + // - If supplied, must match the name of an existing DBSubnetGroup. + // - The specified DB subnet group must be in the same Amazon Web Services + // Region in which the operation is running. + // - All read replicas in one Amazon Web Services Region that are created from + // the same source DB instance must either:> + // - Specify DB subnet groups from the same VPC. All these read replicas are + // created in the same VPC. + // - Not specify a DB subnet group. All these read replicas are created outside + // of any VPC. // Example: mydbsubnetgroup DBSubnetGroupName *string // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection *bool // The Active Directory directory ID to create the DB instance in. Currently, only // MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created - // in an Active Directory Domain. For more information, see Kerberos - // Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // in an Active Directory Domain. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Domain *string @@ -160,8 +134,7 @@ type CreateDBInstanceReadReplicaInput struct { // The list of logs that the new DB instance is to export to CloudWatch Logs. The // values in the list depend on the DB engine being used. For more information, see - // Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableCloudwatchLogsExports []string @@ -171,25 +144,21 @@ type CreateDBInstanceReadReplicaInput struct { // use cases, a CoIP can provide lower latency for connections to the read replica // from outside of its virtual private cloud (VPC) on your local network. For more // information about RDS on Outposts, see Working with Amazon RDS on Amazon Web - // Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information about IAM database authentication, see IAM - // Database Authentication for MySQL and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information about IAM database authentication, + // see IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableIAMDatabaseAuthentication *bool // A value that indicates whether to enable Performance Insights for the read - // replica. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // replica. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnablePerformanceInsights *bool @@ -215,9 +184,8 @@ type CreateDBInstanceReadReplicaInput struct { // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale // the storage of the DB instance. For more information about this setting, - // including limitations that apply to it, see Managing capacity automatically - // with Amazon RDS storage autoscaling - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) + // including limitations that apply to it, see Managing capacity automatically + // with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. MaxAllocatedStorage *int32 @@ -228,35 +196,30 @@ type CreateDBInstanceReadReplicaInput struct { // doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to - // Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For - // information on creating a monitoring role, go to To create an IAM role for - // Amazon RDS Enhanced Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to - // RDS Custom. + // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics + // to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . + // For information on creating a monitoring role, go to To create an IAM role for + // Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, then you must supply a MonitoringRoleArn value. This setting doesn't + // apply to RDS Custom. MonitoringRoleArn *string - // A value that indicates whether the read replica is in a Multi-AZ deployment. You - // can create a read replica as a Multi-AZ DB instance. RDS creates a standby of - // your replica in another Availability Zone for failover support for the replica. - // Creating your read replica as a Multi-AZ DB instance is independent of whether - // the source is a Multi-AZ DB instance or a Multi-AZ DB cluster. This setting - // doesn't apply to RDS Custom. + // A value that indicates whether the read replica is in a Multi-AZ deployment. + // You can create a read replica as a Multi-AZ DB instance. RDS creates a standby + // of your replica in another Availability Zone for failover support for the + // replica. Creating your read replica as a Multi-AZ DB instance is independent of + // whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster. This + // setting doesn't apply to RDS Custom. MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for read replica. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for read replica. + // A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 + // protocols ( DUAL ). For more information, see Working with a DB instance in a + // VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string @@ -269,36 +232,24 @@ type CreateDBInstanceReadReplicaInput struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you do not specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. - // This setting doesn't apply to RDS Custom. + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. This setting doesn't apply to RDS Custom. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. This setting doesn't apply to RDS Custom. + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. This setting doesn't apply to RDS Custom. PerformanceInsightsRetentionPeriod *int32 // The port number that the DB instance uses for connections. Default: Inherits @@ -321,41 +272,33 @@ type CreateDBInstanceReadReplicaInput struct { // CreateDBInstanceReadReplica API operation that can run in the source Amazon Web // Services Region that contains the encrypted source DB instance. The presigned // URL request must contain the following parameter values: - // - // * DestinationRegion - - // The Amazon Web Services Region that the encrypted read replica is created in. - // This Amazon Web Services Region is the same one where the - // CreateDBInstanceReadReplica operation is called that contains this presigned - // URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon - // Web Services Region, from a source DB instance in the us-east-2 Amazon Web - // Services Region, then you call the CreateDBInstanceReadReplica operation in the - // us-east-1 Amazon Web Services Region and provide a presigned URL that contains a - // call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web - // Services Region. For this example, the DestinationRegion in the presigned URL - // must be set to the us-east-1 Amazon Web Services Region. - // - // * KmsKeyId - The KMS - // key identifier for the key to use to encrypt the read replica in the destination - // Amazon Web Services Region. This is the same identifier for both the - // CreateDBInstanceReadReplica operation that is called in the destination Amazon - // Web Services Region, and the operation contained in the presigned URL. - // - // * - // SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB - // instance to be replicated. This identifier must be in the Amazon Resource Name - // (ARN) format for the source Amazon Web Services Region. For example, if you are - // creating an encrypted read replica from a DB instance in the us-west-2 Amazon - // Web Services Region, then your SourceDBInstanceIdentifier looks like the - // following example: - // arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. - // - // To learn - // how to generate a Signature Version 4 signed request, see Authenticating - // Requests: Using Query Parameters (Amazon Web Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // and Signature Version 4 Signing Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If you - // are using an Amazon Web Services SDK tool or the CLI, you can specify + // - DestinationRegion - The Amazon Web Services Region that the encrypted read + // replica is created in. This Amazon Web Services Region is the same one where the + // CreateDBInstanceReadReplica operation is called that contains this presigned + // URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon + // Web Services Region, from a source DB instance in the us-east-2 Amazon Web + // Services Region, then you call the CreateDBInstanceReadReplica operation in + // the us-east-1 Amazon Web Services Region and provide a presigned URL that + // contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 + // Amazon Web Services Region. For this example, the DestinationRegion in the + // presigned URL must be set to the us-east-1 Amazon Web Services Region. + // - KmsKeyId - The KMS key identifier for the key to use to encrypt the read + // replica in the destination Amazon Web Services Region. This is the same + // identifier for both the CreateDBInstanceReadReplica operation that is called + // in the destination Amazon Web Services Region, and the operation contained in + // the presigned URL. + // - SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB + // instance to be replicated. This identifier must be in the Amazon Resource Name + // (ARN) format for the source Amazon Web Services Region. For example, if you are + // creating an encrypted read replica from a DB instance in the us-west-2 Amazon + // Web Services Region, then your SourceDBInstanceIdentifier looks like the + // following example: + // arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115 . + // To learn how to generate a Signature Version 4 signed request, see + // Authenticating Requests: Using Query Parameters (Amazon Web Services Signature + // Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . If you are using an Amazon Web Services SDK tool or the CLI, you can specify // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl // manually. Specifying SourceRegion autogenerates a presigned URL that is a valid // request for the operation that can run in the source Amazon Web Services Region. @@ -376,7 +319,7 @@ type CreateDBInstanceReadReplicaInput struct { // group it uses. That public access isn't permitted if the security group assigned // to the DB cluster doesn't permit it. When the DB instance isn't publicly // accessible, it is an internal DB instance with a DNS name that resolves to a - // private IP address. For more information, see CreateDBInstance. + // private IP address. For more information, see CreateDBInstance . PubliclyAccessible *bool // The open mode of the replica database: mounted or read-only. This parameter is @@ -387,65 +330,45 @@ type CreateDBInstanceReadReplicaInput struct { // user connections, a mounted replica can't serve a read-only workload. You can // create a combination of mounted and read-only DB replicas for the same primary // DB instance. For more information, see Working with Oracle Read Replicas for - // Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) + // Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) // in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter - // and set it to mounted. The value won't be set by default. After replica + // and set it to mounted . The value won't be set by default. After replica // creation, you can manage the open mode manually. ReplicaMode types.ReplicaMode // The identifier of the Multi-AZ DB cluster that will act as the source for the // read replica. Each DB cluster can have up to 15 read replicas. Constraints: - // - // * - // Must be the identifier of an existing Multi-AZ DB cluster. - // - // * Can't be specified - // if the SourceDBInstanceIdentifier parameter is also specified. - // - // * The specified - // DB cluster must have automatic backups enabled, that is, its backup retention - // period must be greater than 0. - // - // * The source DB cluster must be in the same - // Amazon Web Services Region as the read replica. Cross-Region replication isn't - // supported. + // - Must be the identifier of an existing Multi-AZ DB cluster. + // - Can't be specified if the SourceDBInstanceIdentifier parameter is also + // specified. + // - The specified DB cluster must have automatic backups enabled, that is, its + // backup retention period must be greater than 0. + // - The source DB cluster must be in the same Amazon Web Services Region as the + // read replica. Cross-Region replication isn't supported. SourceDBClusterIdentifier *string // The identifier of the DB instance that will act as the source for the read // replica. Each DB instance can have up to 15 read replicas, with the exception of // Oracle and SQL Server, which can have up to five. Constraints: - // - // * Must be the - // identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB - // instance. - // - // * Can't be specified if the SourceDBClusterIdentifier parameter is - // also specified. - // - // * For the limitations of Oracle read replicas, see Version and - // licensing considerations for RDS for Oracle replicas - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses) - // in the Amazon RDS User Guide. - // - // * For the limitations of SQL Server read - // replicas, see Read replica limitations with SQL Server - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations) - // in the Amazon RDS User Guide. - // - // * The specified DB instance must have automatic - // backups enabled, that is, its backup retention period must be greater than 0. - // - // * - // If the source DB instance is in the same Amazon Web Services Region as the read - // replica, specify a valid DB instance identifier. - // - // * If the source DB instance is - // in a different Amazon Web Services Region from the read replica, specify a valid - // DB instance ARN. For more information, see Constructing an ARN for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) - // in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, - // which don't support cross-Region replicas. + // - Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, + // or SQL Server DB instance. + // - Can't be specified if the SourceDBClusterIdentifier parameter is also + // specified. + // - For the limitations of Oracle read replicas, see Version and licensing + // considerations for RDS for Oracle replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses) + // in the Amazon RDS User Guide. + // - For the limitations of SQL Server read replicas, see Read replica + // limitations with SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations) + // in the Amazon RDS User Guide. + // - The specified DB instance must have automatic backups enabled, that is, its + // backup retention period must be greater than 0. + // - If the source DB instance is in the same Amazon Web Services Region as the + // read replica, specify a valid DB instance identifier. + // - If the source DB instance is in a different Amazon Web Services Region from + // the read replica, specify a valid DB instance ARN. For more information, see + // Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, + // which don't support cross-Region replicas. SourceDBInstanceIdentifier *string // The AWS region the resource is in. The presigned URL will be created with this @@ -456,19 +379,18 @@ type CreateDBInstanceReadReplicaInput struct { // doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 - // Specifies the storage type to be associated with the read replica. Valid values: - // gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a - // value for the Iops parameter. Default: io1 if the Iops parameter is specified, - // otherwise gp2 + // Specifies the storage type to be associated with the read replica. Valid + // values: gp2 | gp3 | io1 | standard If you specify io1 or gp3 , you must also + // include a value for the Iops parameter. Default: io1 if the Iops parameter is + // specified, otherwise gp2 StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. This setting doesn't apply to RDS Custom. + // A value that indicates whether the DB instance class of the DB instance uses + // its default processor features. This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to associate with the read replica. @@ -476,8 +398,8 @@ type CreateDBInstanceReadReplicaInput struct { // group for the DB subnet group's VPC. VpcSecurityGroupIds []string - // Used by the SDK's PresignURL autofill customization to specify the region the of - // the client's request. + // Used by the SDK's PresignURL autofill customization to specify the region the + // of the client's request. destinationRegion *string noSmithyDocumentSerde @@ -486,11 +408,11 @@ type CreateDBInstanceReadReplicaInput struct { type CreateDBInstanceReadReplicaOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBParameterGroup.go b/service/rds/api_op_CreateDBParameterGroup.go index 274453d7d2c..f8348e84df5 100644 --- a/service/rds/api_op_CreateDBParameterGroup.go +++ b/service/rds/api_op_CreateDBParameterGroup.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB parameter group. A DB parameter group is initially created with -// the default parameters for the database engine used by the DB instance. To +// Creates a new DB parameter group. A DB parameter group is initially created +// with the default parameters for the database engine used by the DB instance. To // provide custom values for any of the parameters, you must modify the group after -// creating it using ModifyDBParameterGroup. Once you've created a DB parameter -// group, you need to associate it with your DB instance using ModifyDBInstance. +// creating it using ModifyDBParameterGroup . Once you've created a DB parameter +// group, you need to associate it with your DB instance using ModifyDBInstance . // When you associate a new DB parameter group with a running DB instance, you need // to reboot the DB instance without failover for the new DB parameter group and // associated settings to take effect. This command doesn't apply to RDS Custom. @@ -26,9 +26,9 @@ import ( // especially important for parameters that are critical when creating the default // database for a DB instance, such as the character set for the default database // defined by the character_set_database parameter. You can use the Parameter -// Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or -// the DescribeDBParameters command to verify that your DB parameter group has been -// created or modified. +// Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) +// or the DescribeDBParameters command to verify that your DB parameter group has +// been created or modified. func (c *Client) CreateDBParameterGroup(ctx context.Context, params *CreateDBParameterGroupInput, optFns ...func(*Options)) (*CreateDBParameterGroupOutput, error) { if params == nil { params = &CreateDBParameterGroupInput{} @@ -51,59 +51,34 @@ type CreateDBParameterGroupInput struct { // instance running a database engine and engine version compatible with that DB // parameter group family. To list all of the available parameter group families // for a DB engine, use the following command: aws rds describe-db-engine-versions - // --query "DBEngineVersions[].DBParameterGroupFamily" --engine For example, to + // --query "DBEngineVersions[].DBParameterGroupFamily" --engine For example, to // list all of the available parameter group families for the MySQL DB engine, use // the following command: aws rds describe-db-engine-versions --query // "DBEngineVersions[].DBParameterGroupFamily" --engine mysql The output contains // duplicates. The following are the valid DB engine values: - // - // * aurora (for MySQL - // 5.6-compatible Aurora) - // - // * aurora-mysql (for MySQL 5.7-compatible and MySQL - // 8.0-compatible Aurora) - // - // * aurora-postgresql - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * - // oracle-ee-cdb - // - // * oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * - // sqlserver-se - // - // * sqlserver-ex - // - // * sqlserver-web + // - aurora (for MySQL 5.6-compatible Aurora) + // - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) + // - aurora-postgresql + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web // // This member is required. DBParameterGroupFamily *string // The name of the DB parameter group. Constraints: - // - // * Must be 1 to 255 letters, - // numbers, or hyphens. - // - // * First character must be a letter - // - // * Can't end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. // // This member is required. DBParameterGroupName *string @@ -121,8 +96,8 @@ type CreateDBParameterGroupInput struct { type CreateDBParameterGroupOutput struct { - // Contains the details of an Amazon RDS DB parameter group. This data type is used - // as a response element in the DescribeDBParameterGroups action. + // Contains the details of an Amazon RDS DB parameter group. This data type is + // used as a response element in the DescribeDBParameterGroups action. DBParameterGroup *types.DBParameterGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBProxy.go b/service/rds/api_op_CreateDBProxy.go index 8df879f0944..0fd5cbc1953 100644 --- a/service/rds/api_op_CreateDBProxy.go +++ b/service/rds/api_op_CreateDBProxy.go @@ -45,9 +45,9 @@ type CreateDBProxyInput struct { // The kinds of databases that the proxy can connect to. This value determines // which database network protocol the proxy recognizes when it interprets network // traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for - // MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL - // databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify - // SQLSERVER. + // MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL + // databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify + // SQLSERVER . // // This member is required. EngineFamily types.EngineFamily diff --git a/service/rds/api_op_CreateDBProxyEndpoint.go b/service/rds/api_op_CreateDBProxyEndpoint.go index 51994b89c0b..1a165ebea70 100644 --- a/service/rds/api_op_CreateDBProxyEndpoint.go +++ b/service/rds/api_op_CreateDBProxyEndpoint.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a DBProxyEndpoint. Only applies to proxies that are associated with +// Creates a DBProxyEndpoint . Only applies to proxies that are associated with // Aurora DB clusters. You can use DB proxy endpoints to specify read/write or // read-only access to the DB cluster. You can also use DB proxy endpoints to // access a DB proxy through a different VPC than the proxy's default VPC. @@ -48,14 +48,13 @@ type CreateDBProxyEndpointInput struct { // This member is required. VpcSubnetIds []string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // A value that indicates whether the DB proxy endpoint can be used for read/write - // or read-only operations. The default is READ_WRITE. The only role that proxies - // for RDS for Microsoft SQL Server support is READ_WRITE. + // or read-only operations. The default is READ_WRITE . The only role that proxies + // for RDS for Microsoft SQL Server support is READ_WRITE . TargetRole types.DBProxyEndpointTargetRole // The VPC security group IDs for the DB proxy endpoint that you create. You can diff --git a/service/rds/api_op_CreateDBSecurityGroup.go b/service/rds/api_op_CreateDBSecurityGroup.go index b8e05e955b7..ddc10149ea3 100644 --- a/service/rds/api_op_CreateDBSecurityGroup.go +++ b/service/rds/api_op_CreateDBSecurityGroup.go @@ -15,13 +15,10 @@ import ( // instance. A DB security group controls access to EC2-Classic DB instances that // are not in a VPC. EC2-Classic was retired on August 15, 2022. If you haven't // migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as -// possible. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How -// to Prepare -// (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), -// and Moving a DB instance not in a VPC into a VPC -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) +// possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – +// Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) +// , and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) // in the Amazon RDS User Guide. func (c *Client) CreateDBSecurityGroup(ctx context.Context, params *CreateDBSecurityGroupInput, optFns ...func(*Options)) (*CreateDBSecurityGroupOutput, error) { if params == nil { @@ -47,17 +44,10 @@ type CreateDBSecurityGroupInput struct { // The name for the DB security group. This value is stored as a lowercase string. // Constraints: - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * First - // character must be a letter - // - // * Can't end with a hyphen or contain two consecutive - // hyphens - // - // * Must not be "Default" - // + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // - Must not be "Default" // Example: mysecuritygroup // // This member is required. @@ -71,8 +61,8 @@ type CreateDBSecurityGroupInput struct { type CreateDBSecurityGroupOutput struct { - // Contains the details for an Amazon RDS DB security group. This data type is used - // as a response element in the DescribeDBSecurityGroups action. + // Contains the details for an Amazon RDS DB security group. This data type is + // used as a response element in the DescribeDBSecurityGroups action. DBSecurityGroup *types.DBSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBSnapshot.go b/service/rds/api_op_CreateDBSnapshot.go index be30c2c3ebb..bdfe7f350cc 100644 --- a/service/rds/api_op_CreateDBSnapshot.go +++ b/service/rds/api_op_CreateDBSnapshot.go @@ -32,33 +32,23 @@ type CreateDBSnapshotInput struct { // The identifier of the DB instance that you want to create the snapshot of. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string // The identifier for the DB snapshot. Constraints: - // - // * Can't be null, empty, or - // blank - // - // * Must contain from 1 to 255 letters, numbers, or hyphens - // - // * First - // character must be a letter - // - // * Can't end with a hyphen or contain two consecutive - // hyphens - // + // - Can't be null, empty, or blank + // - Must contain from 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-snapshot-id // // This member is required. DBSnapshotIdentifier *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_CreateDBSubnetGroup.go b/service/rds/api_op_CreateDBSubnetGroup.go index 61507fda4fc..d0a8f302a51 100644 --- a/service/rds/api_op_CreateDBSubnetGroup.go +++ b/service/rds/api_op_CreateDBSubnetGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB subnet group. DB subnet groups must contain at least one subnet -// in at least two AZs in the Amazon Web Services Region. +// Creates a new DB subnet group. DB subnet groups must contain at least one +// subnet in at least two AZs in the Amazon Web Services Region. func (c *Client) CreateDBSubnetGroup(ctx context.Context, params *CreateDBSubnetGroupInput, optFns ...func(*Options)) (*CreateDBSubnetGroupOutput, error) { if params == nil { params = &CreateDBSubnetGroupInput{} @@ -37,15 +37,10 @@ type CreateDBSubnetGroupInput struct { // The name for the DB subnet group. This value is stored as a lowercase string. // Constraints: - // - // * Must contain no more than 255 letters, numbers, periods, - // underscores, spaces, or hyphens. - // - // * Must not be default. - // - // * First character must - // be a letter. - // + // - Must contain no more than 255 letters, numbers, periods, underscores, + // spaces, or hyphens. + // - Must not be default. + // - First character must be a letter. // Example: mydbsubnetgroup // // This member is required. @@ -64,8 +59,8 @@ type CreateDBSubnetGroupInput struct { type CreateDBSubnetGroupOutput struct { - // Contains the details of an Amazon RDS DB subnet group. This data type is used as - // a response element in the DescribeDBSubnetGroups action. + // Contains the details of an Amazon RDS DB subnet group. This data type is used + // as a response element in the DescribeDBSubnetGroups action. DBSubnetGroup *types.DBSubnetGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateEventSubscription.go b/service/rds/api_op_CreateEventSubscription.go index ded748c0185..ae6657d7cb3 100644 --- a/service/rds/api_op_CreateEventSubscription.go +++ b/service/rds/api_op_CreateEventSubscription.go @@ -15,23 +15,21 @@ import ( // Amazon Resource Name (ARN) created by either the RDS console, the SNS console, // or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS // and subscribe to the topic. The ARN is displayed in the SNS console. You can -// specify the type of source (SourceType) that you want to be notified of and -// provide a list of RDS sources (SourceIds) that triggers the events. You can also -// provide a list of event categories (EventCategories) for events that you want to -// be notified of. For example, you can specify SourceType = db-instance, SourceIds -// = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If -// you specify both the SourceType and SourceIds, such as SourceType = db-instance -// and SourceIds = myDBInstance1, you are notified of all the db-instance events -// for the specified source. If you specify a SourceType but do not specify -// SourceIds, you receive notice of the events for that source type for all your -// RDS sources. If you don't specify either the SourceType or the SourceIds, you -// are notified of events generated from all RDS sources belonging to your customer -// account. For more information about subscribing to an event for RDS DB engines, -// see Subscribing to Amazon RDS event notification -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Subscribing.html) +// specify the type of source ( SourceType ) that you want to be notified of and +// provide a list of RDS sources ( SourceIds ) that triggers the events. You can +// also provide a list of event categories ( EventCategories ) for events that you +// want to be notified of. For example, you can specify SourceType = db-instance , +// SourceIds = mydbinstance1 , mydbinstance2 and EventCategories = Availability , +// Backup . If you specify both the SourceType and SourceIds , such as SourceType +// = db-instance and SourceIds = myDBInstance1 , you are notified of all the +// db-instance events for the specified source. If you specify a SourceType but do +// not specify SourceIds , you receive notice of the events for that source type +// for all your RDS sources. If you don't specify either the SourceType or the +// SourceIds , you are notified of events generated from all RDS sources belonging +// to your customer account. For more information about subscribing to an event for +// RDS DB engines, see Subscribing to Amazon RDS event notification (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Subscribing.html) // in the Amazon RDS User Guide. For more information about subscribing to an event -// for Aurora DB engines, see Subscribing to Amazon RDS event notification -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Subscribing.html) +// for Aurora DB engines, see Subscribing to Amazon RDS event notification (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Subscribing.html) // in the Amazon Aurora User Guide. func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { @@ -67,58 +65,44 @@ type CreateEventSubscriptionInput struct { // active. Enabled *bool - // A list of event categories for a particular source type (SourceType) that you + // A list of event categories for a particular source type ( SourceType ) that you // want to subscribe to. You can see a list of the categories for a given source // type in the "Amazon RDS event categories and event messages" section of the - // Amazon RDS User Guide - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) - // or the Amazon Aurora User Guide - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). - // You can also see this list by using the DescribeEventCategories operation. + // Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) + // or the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html) + // . You can also see this list by using the DescribeEventCategories operation. EventCategories []string // The list of identifiers of the event sources for which events are returned. If // not specified, then all sources are included in the response. An identifier must // begin with a letter and must contain only ASCII letters, digits, and hyphens. It // can't end with a hyphen or contain two consecutive hyphens. Constraints: - // - // * If - // SourceIds are supplied, SourceType must also be provided. - // - // * If the source type - // is a DB instance, a DBInstanceIdentifier value must be supplied. - // - // * If the - // source type is a DB cluster, a DBClusterIdentifier value must be supplied. - // - // * If - // the source type is a DB parameter group, a DBParameterGroupName value must be - // supplied. - // - // * If the source type is a DB security group, a DBSecurityGroupName - // value must be supplied. - // - // * If the source type is a DB snapshot, a - // DBSnapshotIdentifier value must be supplied. - // - // * If the source type is a DB - // cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. - // - // * If - // the source type is an RDS Proxy, a DBProxyName value must be supplied. + // - If SourceIds are supplied, SourceType must also be provided. + // - If the source type is a DB instance, a DBInstanceIdentifier value must be + // supplied. + // - If the source type is a DB cluster, a DBClusterIdentifier value must be + // supplied. + // - If the source type is a DB parameter group, a DBParameterGroupName value + // must be supplied. + // - If the source type is a DB security group, a DBSecurityGroupName value must + // be supplied. + // - If the source type is a DB snapshot, a DBSnapshotIdentifier value must be + // supplied. + // - If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier + // value must be supplied. + // - If the source type is an RDS Proxy, a DBProxyName value must be supplied. SourceIds []string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by a DB instance, you set this parameter to - // db-instance. For RDS Proxy events, specify db-proxy. If this value isn't + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by a DB instance, you set this parameter to + // db-instance . For RDS Proxy events, specify db-proxy . If this value isn't // specified, all events are returned. Valid values: db-instance | db-cluster | // db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | // db-proxy SourceType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_CreateGlobalCluster.go b/service/rds/api_op_CreateGlobalCluster.go index 1ca44fddce7..b3cf6b79a62 100644 --- a/service/rds/api_op_CreateGlobalCluster.go +++ b/service/rds/api_op_CreateGlobalCluster.go @@ -42,8 +42,8 @@ type CreateGlobalClusterInput struct { // cluster you are creating. DatabaseName *string - // The deletion protection setting for the new global database. The global database - // can't be deleted when deletion protection is enabled. + // The deletion protection setting for the new global database. The global + // database can't be deleted when deletion protection is enabled. DeletionProtection *bool // The name of the database engine to be used for this DB cluster. diff --git a/service/rds/api_op_CreateOptionGroup.go b/service/rds/api_op_CreateOptionGroup.go index 76a55febb4c..c1606687140 100644 --- a/service/rds/api_op_CreateOptionGroup.go +++ b/service/rds/api_op_CreateOptionGroup.go @@ -32,30 +32,17 @@ type CreateOptionGroupInput struct { // Specifies the name of the engine that this option group should be associated // with. Valid Values: - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * oracle-ee-cdb - // - // * - // oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * sqlserver-se - // - // * - // sqlserver-ex - // - // * sqlserver-web + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web // // This member is required. EngineName *string @@ -72,15 +59,9 @@ type CreateOptionGroupInput struct { OptionGroupDescription *string // Specifies the name of the option group to be created. Constraints: - // - // * Must be 1 - // to 255 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * Can't - // end with a hyphen or contain two consecutive hyphens - // + // - Must be 1 to 255 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: myoptiongroup // // This member is required. diff --git a/service/rds/api_op_DeleteBlueGreenDeployment.go b/service/rds/api_op_DeleteBlueGreenDeployment.go index e40d4e818d0..82f1ad5eab6 100644 --- a/service/rds/api_op_DeleteBlueGreenDeployment.go +++ b/service/rds/api_op_DeleteBlueGreenDeployment.go @@ -12,11 +12,9 @@ import ( ) // Deletes a blue/green deployment. For more information, see Using Amazon RDS -// Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. func (c *Client) DeleteBlueGreenDeployment(ctx context.Context, params *DeleteBlueGreenDeploymentInput, optFns ...func(*Options)) (*DeleteBlueGreenDeploymentOutput, error) { if params == nil { @@ -37,17 +35,14 @@ type DeleteBlueGreenDeploymentInput struct { // The blue/green deployment identifier of the deployment to be deleted. This // parameter isn't case-sensitive. Constraints: - // - // * Must match an existing - // blue/green deployment identifier. + // - Must match an existing blue/green deployment identifier. // // This member is required. BlueGreenDeploymentIdentifier *string - // A value that indicates whether to delete the resources in the green environment. - // You can't specify this option if the blue/green deployment status - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html) - // is SWITCHOVER_COMPLETED. + // A value that indicates whether to delete the resources in the green + // environment. You can't specify this option if the blue/green deployment status (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html) + // is SWITCHOVER_COMPLETED . DeleteTarget *bool noSmithyDocumentSerde @@ -56,11 +51,9 @@ type DeleteBlueGreenDeploymentInput struct { type DeleteBlueGreenDeploymentOutput struct { // Contains the details about a blue/green deployment. For more information, see - // Using Amazon RDS Blue/Green Deployments for database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) - // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for - // database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) + // Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) + // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for + // database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. BlueGreenDeployment *types.BlueGreenDeployment diff --git a/service/rds/api_op_DeleteCustomDBEngineVersion.go b/service/rds/api_op_DeleteCustomDBEngineVersion.go index 927eca869b4..65505ef8e47 100644 --- a/service/rds/api_op_DeleteCustomDBEngineVersion.go +++ b/service/rds/api_op_DeleteCustomDBEngineVersion.go @@ -14,23 +14,18 @@ import ( // Deletes a custom engine version. To run this command, make sure you meet the // following prerequisites: +// - The CEV must not be the default for RDS Custom. If it is, change the +// default before running this command. +// - The CEV must not be associated with an RDS Custom DB instance, RDS Custom +// instance snapshot, or automated backup of your RDS Custom instance. // -// * The CEV must not be the default for RDS Custom. If -// it is, change the default before running this command. -// -// * The CEV must not be -// associated with an RDS Custom DB instance, RDS Custom instance snapshot, or -// automated backup of your RDS Custom instance. -// -// Typically, deletion takes a few -// minutes. The MediaImport service that imports files from Amazon S3 to create -// CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data -// logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion -// event aren't logged. However, you might see calls from the API gateway that -// accesses your Amazon S3 bucket. These calls originate from the MediaImport -// service for the DeleteCustomDbEngineVersion event. For more information, see -// Deleting a CEV -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete) +// Typically, deletion takes a few minutes. The MediaImport service that imports +// files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services +// CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to +// the DeleteCustomDbEngineVersion event aren't logged. However, you might see +// calls from the API gateway that accesses your Amazon S3 bucket. These calls +// originate from the MediaImport service for the DeleteCustomDbEngineVersion +// event. For more information, see Deleting a CEV (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete) // in the Amazon RDS User Guide. func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *DeleteCustomDBEngineVersionInput, optFns ...func(*Options)) (*DeleteCustomDBEngineVersionOutput, error) { if params == nil { @@ -50,7 +45,7 @@ func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *Delete type DeleteCustomDBEngineVersionInput struct { // The database engine. The only supported engines are custom-oracle-ee and - // custom-oracle-ee-cdb. + // custom-oracle-ee-cdb . // // This member is required. Engine *string @@ -66,7 +61,7 @@ type DeleteCustomDBEngineVersionInput struct { } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type DeleteCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. @@ -76,8 +71,7 @@ type DeleteCustomDBEngineVersionOutput struct { // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. - // For more information, see JSON fields in the CEV manifest - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) + // For more information, see JSON fields in the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) // in the Amazon RDS User Guide. CustomDBEngineVersionManifest *string @@ -128,15 +122,13 @@ type DeleteCustomDBEngineVersionOutput struct { // The major engine version of the CEV. MajorEngineVersion *string - // The status of the DB engine version, either available or deprecated. + // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. SupportedCACertificateIdentifiers []string @@ -147,13 +139,13 @@ type DeleteCustomDBEngineVersionOutput struct { // A list of the supported DB engine modes. SupportedEngineModes []string - // A list of features supported by the DB engine. The supported features vary by DB - // engine and DB engine version. To determine the supported features for a specific - // DB engine and DB engine version using the CLI, use the following command: aws - // rds describe-db-engine-versions --engine --engine-version For example, to - // determine the supported features for RDS for PostgreSQL version 13.3 using the - // CLI, use the following command: aws rds describe-db-engine-versions --engine - // postgres --engine-version 13.3 The supported features are listed under + // A list of features supported by the DB engine. The supported features vary by + // DB engine and DB engine version. To determine the supported features for a + // specific DB engine and DB engine version using the CLI, use the following + // command: aws rds describe-db-engine-versions --engine --engine-version For + // example, to determine the supported features for RDS for PostgreSQL version 13.3 + // using the CLI, use the following command: aws rds describe-db-engine-versions + // --engine postgres --engine-version 13.3 The supported features are listed under // SupportedFeatureNames in the output. SupportedFeatureNames []string @@ -181,16 +173,15 @@ type DeleteCustomDBEngineVersionOutput struct { // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs bool - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // A value that indicates whether you can use Aurora parallel query with a + // specific DB engine version. SupportsParallelQuery bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. diff --git a/service/rds/api_op_DeleteDBCluster.go b/service/rds/api_op_DeleteDBCluster.go index e96563eee4b..69d6e6f22bd 100644 --- a/service/rds/api_op_DeleteDBCluster.go +++ b/service/rds/api_op_DeleteDBCluster.go @@ -11,16 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeleteDBCluster action deletes a previously provisioned DB cluster. When you -// delete a DB cluster, all automated backups for that DB cluster are deleted and -// can't be recovered. Manual DB cluster snapshots of the specified DB cluster are -// not deleted. If you're deleting a Multi-AZ DB cluster with read replicas, all -// cluster members are terminated and read replicas are promoted to standalone -// instances. For more information on Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// The DeleteDBCluster action deletes a previously provisioned DB cluster. When +// you delete a DB cluster, all automated backups for that DB cluster are deleted +// and can't be recovered. Manual DB cluster snapshots of the specified DB cluster +// are not deleted. If you're deleting a Multi-AZ DB cluster with read replicas, +// all cluster members are terminated and read replicas are promoted to standalone +// instances. For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInput, optFns ...func(*Options)) (*DeleteDBClusterOutput, error) { if params == nil { @@ -39,10 +37,9 @@ func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInp type DeleteDBClusterInput struct { - // The DB cluster identifier for the DB cluster to be deleted. This parameter isn't - // case-sensitive. Constraints: - // - // * Must match an existing DBClusterIdentifier. + // The DB cluster identifier for the DB cluster to be deleted. This parameter + // isn't case-sensitive. Constraints: + // - Must match an existing DBClusterIdentifier. // // This member is required. DBClusterIdentifier *string @@ -51,14 +48,9 @@ type DeleteDBClusterInput struct { // SkipFinalSnapshot is disabled. Specifying this parameter and also skipping the // creation of a final DB cluster snapshot with the SkipFinalShapshot parameter // results in an error. Constraints: - // - // * Must be 1 to 255 letters, numbers, or - // hyphens. - // - // * First character must be a letter - // - // * Can't end with a hyphen or - // contain two consecutive hyphens + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens FinalDBSnapshotIdentifier *string // A value that indicates whether to skip the creation of a final DB cluster @@ -76,19 +68,17 @@ type DeleteDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_DeleteDBClusterEndpoint.go b/service/rds/api_op_DeleteDBClusterEndpoint.go index ee0104c801e..99c18b3d319 100644 --- a/service/rds/api_op_DeleteDBClusterEndpoint.go +++ b/service/rds/api_op_DeleteDBClusterEndpoint.go @@ -41,21 +41,16 @@ type DeleteDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Aurora DB cluster. This data type is used as a response element in the following // actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type DeleteDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -76,7 +71,7 @@ type DeleteDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -87,8 +82,8 @@ type DeleteDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that can't be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that can't be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/rds/api_op_DeleteDBClusterParameterGroup.go b/service/rds/api_op_DeleteDBClusterParameterGroup.go index 36aa0556780..f82a6a8818f 100644 --- a/service/rds/api_op_DeleteDBClusterParameterGroup.go +++ b/service/rds/api_op_DeleteDBClusterParameterGroup.go @@ -12,11 +12,9 @@ import ( // Deletes a specified DB cluster parameter group. The DB cluster parameter group // to be deleted can't be associated with any DB clusters. For more information on -// Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *DeleteDBClusterParameterGroupInput, optFns ...func(*Options)) (*DeleteDBClusterParameterGroupOutput, error) { if params == nil { @@ -36,14 +34,9 @@ func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *Dele type DeleteDBClusterParameterGroupInput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be the name of - // an existing DB cluster parameter group. - // - // * You can't delete a default DB cluster - // parameter group. - // - // * Can't be associated with any DB clusters. + // - Must be the name of an existing DB cluster parameter group. + // - You can't delete a default DB cluster parameter group. + // - Can't be associated with any DB clusters. // // This member is required. DBClusterParameterGroupName *string diff --git a/service/rds/api_op_DeleteDBClusterSnapshot.go b/service/rds/api_op_DeleteDBClusterSnapshot.go index 162035ec292..bc7a78231d0 100644 --- a/service/rds/api_op_DeleteDBClusterSnapshot.go +++ b/service/rds/api_op_DeleteDBClusterSnapshot.go @@ -13,12 +13,9 @@ import ( // Deletes a DB cluster snapshot. If the snapshot is being copied, the copy // operation is terminated. The DB cluster snapshot must be in the available state -// to be deleted. For more information on Amazon Aurora, see What is Amazon -// Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, optFns ...func(*Options)) (*DeleteDBClusterSnapshotOutput, error) { if params == nil { diff --git a/service/rds/api_op_DeleteDBInstance.go b/service/rds/api_op_DeleteDBInstance.go index eb7502558ef..a4f5ea656ba 100644 --- a/service/rds/api_op_DeleteDBInstance.go +++ b/service/rds/api_op_DeleteDBInstance.go @@ -18,22 +18,18 @@ import ( // of the Amazon RDS DB instance is deleting until the DB snapshot is created. The // API action DescribeDBInstance is used to monitor the status of this operation. // The action can't be canceled or reverted once submitted. When a DB instance is -// in a failure state and has a status of failed, incompatible-restore, or -// incompatible-network, you can only delete it when you skip creation of the final -// snapshot with the SkipFinalSnapshot parameter. If the specified DB instance is -// part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of -// the following conditions are true: +// in a failure state and has a status of failed , incompatible-restore , or +// incompatible-network , you can only delete it when you skip creation of the +// final snapshot with the SkipFinalSnapshot parameter. If the specified DB +// instance is part of an Amazon Aurora DB cluster, you can't delete the DB +// instance if both of the following conditions are true: +// - The DB cluster is a read replica of another Amazon Aurora DB cluster. +// - The DB instance is the only instance in the DB cluster. // -// * The DB cluster is a read replica of -// another Amazon Aurora DB cluster. -// -// * The DB instance is the only instance in the -// DB cluster. -// -// To delete a DB instance in this case, first call the -// PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no -// longer a read replica. After the promotion completes, then call the -// DeleteDBInstance API action to delete the final instance in the DB cluster. +// To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster +// API action to promote the DB cluster so it's no longer a read replica. After the +// promotion completes, then call the DeleteDBInstance API action to delete the +// final instance in the DB cluster. func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error) { if params == nil { params = &DeleteDBInstanceInput{} @@ -53,32 +49,24 @@ type DeleteDBInstanceInput struct { // The DB instance identifier for the DB instance to be deleted. This parameter // isn't case-sensitive. Constraints: - // - // * Must match the name of an existing DB - // instance. + // - Must match the name of an existing DB instance. // // This member is required. DBInstanceIdentifier *string - // A value that indicates whether to remove automated backups immediately after the - // DB instance is deleted. This parameter isn't case-sensitive. The default is to - // remove automated backups immediately after the DB instance is deleted. + // A value that indicates whether to remove automated backups immediately after + // the DB instance is deleted. This parameter isn't case-sensitive. The default is + // to remove automated backups immediately after the DB instance is deleted. DeleteAutomatedBackups *bool // The DBSnapshotIdentifier of the new DBSnapshot created when the // SkipFinalSnapshot parameter is disabled. If you enable this parameter and also // enable SkipFinalShapshot, the command results in an error. This setting doesn't // apply to RDS Custom. Constraints: - // - // * Must be 1 to 255 letters or numbers. - // - // * - // First character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. - // - // * Can't be specified when deleting a read replica. + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // - Can't be specified when deleting a read replica. FinalDBSnapshotIdentifier *string // A value that indicates whether to skip the creation of a final DB snapshot @@ -87,10 +75,10 @@ type DeleteDBInstanceInput struct { // before the DB instance is deleted. By default, skip isn't enabled, and the DB // snapshot is created. If you don't enable this parameter, you must specify the // FinalDBSnapshotIdentifier parameter. When a DB instance is in a failure state - // and has a status of failed, incompatible-restore, or incompatible-network, RDS - // can delete the instance only if you enable this parameter. If you delete a read - // replica or an RDS Custom instance, you must enable this setting. This setting is - // required for RDS Custom. + // and has a status of failed , incompatible-restore , or incompatible-network , + // RDS can delete the instance only if you enable this parameter. If you delete a + // read replica or an RDS Custom instance, you must enable this setting. This + // setting is required for RDS Custom. SkipFinalSnapshot bool noSmithyDocumentSerde @@ -99,11 +87,11 @@ type DeleteDBInstanceInput struct { type DeleteDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go b/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go index d8371cb0150..1c1cefffb38 100644 --- a/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go +++ b/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go @@ -32,7 +32,7 @@ func (c *Client) DeleteDBInstanceAutomatedBackup(ctx context.Context, params *De type DeleteDBInstanceAutomatedBackupInput struct { // The Amazon Resource Name (ARN) of the automated backups to delete, for example, - // arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. + // arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . // This setting doesn't apply to RDS Custom. DBInstanceAutomatedBackupsArn *string @@ -45,9 +45,9 @@ type DeleteDBInstanceAutomatedBackupInput struct { type DeleteDBInstanceAutomatedBackupOutput struct { - // An automated backup of a DB instance. It consists of system backups, transaction - // logs, and the database instance properties that existed at the time you deleted - // the source instance. + // An automated backup of a DB instance. It consists of system backups, + // transaction logs, and the database instance properties that existed at the time + // you deleted the source instance. DBInstanceAutomatedBackup *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DeleteDBParameterGroup.go b/service/rds/api_op_DeleteDBParameterGroup.go index f10dcfa9ef6..62b9b00e7b1 100644 --- a/service/rds/api_op_DeleteDBParameterGroup.go +++ b/service/rds/api_op_DeleteDBParameterGroup.go @@ -30,14 +30,9 @@ func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBPar type DeleteDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * Must be the name of an - // existing DB parameter group - // - // * You can't delete a default DB parameter group - // - // * - // Can't be associated with any DB instances + // - Must be the name of an existing DB parameter group + // - You can't delete a default DB parameter group + // - Can't be associated with any DB instances // // This member is required. DBParameterGroupName *string diff --git a/service/rds/api_op_DeleteDBProxyEndpoint.go b/service/rds/api_op_DeleteDBProxyEndpoint.go index 2b25a1bcd78..5f79e1905df 100644 --- a/service/rds/api_op_DeleteDBProxyEndpoint.go +++ b/service/rds/api_op_DeleteDBProxyEndpoint.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy +// Deletes a DBProxyEndpoint . Doing so removes the ability to access the DB proxy // using the endpoint that you defined. The endpoint that you delete might have // provided capabilities such as read/write or read-only operations, or using a // different VPC than the DB proxy's default VPC. diff --git a/service/rds/api_op_DeleteDBSecurityGroup.go b/service/rds/api_op_DeleteDBSecurityGroup.go index fbc79be52fe..236c30050c0 100644 --- a/service/rds/api_op_DeleteDBSecurityGroup.go +++ b/service/rds/api_op_DeleteDBSecurityGroup.go @@ -13,13 +13,10 @@ import ( // Deletes a DB security group. The specified DB security group must not be // associated with any DB instances. EC2-Classic was retired on August 15, 2022. If // you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as -// soon as possible. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How -// to Prepare -// (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), -// and Moving a DB instance not in a VPC into a VPC -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) +// soon as possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – +// Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) +// , and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) // in the Amazon RDS User Guide. func (c *Client) DeleteDBSecurityGroup(ctx context.Context, params *DeleteDBSecurityGroupInput, optFns ...func(*Options)) (*DeleteDBSecurityGroupOutput, error) { if params == nil { @@ -40,16 +37,10 @@ type DeleteDBSecurityGroupInput struct { // The name of the DB security group to delete. You can't delete the default DB // security group. Constraints: - // - // * Must be 1 to 255 letters, numbers, or - // hyphens. - // - // * First character must be a letter - // - // * Can't end with a hyphen or - // contain two consecutive hyphens - // - // * Must not be "Default" + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // - Must not be "Default" // // This member is required. DBSecurityGroupName *string diff --git a/service/rds/api_op_DeregisterDBProxyTargets.go b/service/rds/api_op_DeregisterDBProxyTargets.go index f6cfb835692..b5c535ff53f 100644 --- a/service/rds/api_op_DeregisterDBProxyTargets.go +++ b/service/rds/api_op_DeregisterDBProxyTargets.go @@ -11,7 +11,7 @@ import ( ) // Remove the association between one or more DBProxyTarget data structures and a -// DBProxyTargetGroup. +// DBProxyTargetGroup . func (c *Client) DeregisterDBProxyTargets(ctx context.Context, params *DeregisterDBProxyTargetsInput, optFns ...func(*Options)) (*DeregisterDBProxyTargetsOutput, error) { if params == nil { params = &DeregisterDBProxyTargetsInput{} @@ -29,7 +29,7 @@ func (c *Client) DeregisterDBProxyTargets(ctx context.Context, params *Deregiste type DeregisterDBProxyTargetsInput struct { - // The identifier of the DBProxy that is associated with the DBProxyTargetGroup. + // The identifier of the DBProxy that is associated with the DBProxyTargetGroup . // // This member is required. DBProxyName *string @@ -40,7 +40,7 @@ type DeregisterDBProxyTargetsInput struct { // One or more DB instance identifiers. DBInstanceIdentifiers []string - // The identifier of the DBProxyTargetGroup. + // The identifier of the DBProxyTargetGroup . TargetGroupName *string noSmithyDocumentSerde diff --git a/service/rds/api_op_DescribeAccountAttributes.go b/service/rds/api_op_DescribeAccountAttributes.go index d950fb295d3..25746c4892f 100644 --- a/service/rds/api_op_DescribeAccountAttributes.go +++ b/service/rds/api_op_DescribeAccountAttributes.go @@ -37,8 +37,8 @@ type DescribeAccountAttributesInput struct { // Data returned by the DescribeAccountAttributes action. type DescribeAccountAttributesOutput struct { - // A list of AccountQuota objects. Within this list, each quota has a name, a count - // of usage toward the quota maximum, and a maximum value for the quota. + // A list of AccountQuota objects. Within this list, each quota has a name, a + // count of usage toward the quota maximum, and a maximum value for the quota. AccountQuotas []types.AccountQuota // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeBlueGreenDeployments.go b/service/rds/api_op_DescribeBlueGreenDeployments.go index d8c9f696d56..f8cffd1ae48 100644 --- a/service/rds/api_op_DescribeBlueGreenDeployments.go +++ b/service/rds/api_op_DescribeBlueGreenDeployments.go @@ -13,11 +13,9 @@ import ( ) // Returns information about blue/green deployments. For more information, see -// Using Amazon RDS Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. func (c *Client) DescribeBlueGreenDeployments(ctx context.Context, params *DescribeBlueGreenDeploymentsInput, optFns ...func(*Options)) (*DescribeBlueGreenDeploymentsOutput, error) { if params == nil { @@ -39,36 +37,28 @@ type DescribeBlueGreenDeploymentsInput struct { // The blue/green deployment identifier. If this parameter is specified, // information from only the specific blue/green deployment is returned. This // parameter isn't case-sensitive. Constraints: - // - // * If supplied, must match an - // existing blue/green deployment identifier. + // - If supplied, must match an existing blue/green deployment identifier. BlueGreenDeploymentIdentifier *string // A filter that specifies one or more blue/green deployments to describe. // Supported filters: - // - // * blue-green-deployment-identifier - Accepts - // system-generated identifiers for blue/green deployments. The results list only - // includes information about the blue/green deployments with the specified - // identifiers. - // - // * blue-green-deployment-name - Accepts user-supplied names for - // blue/green deployments. The results list only includes information about the - // blue/green deployments with the specified names. - // - // * source - Accepts source - // databases for a blue/green deployment. The results list only includes - // information about the blue/green deployments with the specified source - // databases. - // - // * target - Accepts target databases for a blue/green deployment. The - // results list only includes information about the blue/green deployments with the - // specified target databases. + // - blue-green-deployment-identifier - Accepts system-generated identifiers for + // blue/green deployments. The results list only includes information about the + // blue/green deployments with the specified identifiers. + // - blue-green-deployment-name - Accepts user-supplied names for blue/green + // deployments. The results list only includes information about the blue/green + // deployments with the specified names. + // - source - Accepts source databases for a blue/green deployment. The results + // list only includes information about the blue/green deployments with the + // specified source databases. + // - target - Accepts target databases for a blue/green deployment. The results + // list only includes information about the blue/green deployments with the + // specified target databases. Filters []types.Filter // An optional pagination token provided by a previous DescribeBlueGreenDeployments // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/rds/api_op_DescribeCertificates.go b/service/rds/api_op_DescribeCertificates.go index 7649e59f281..b53293d4e2a 100644 --- a/service/rds/api_op_DescribeCertificates.go +++ b/service/rds/api_op_DescribeCertificates.go @@ -14,11 +14,9 @@ import ( // Lists the set of CA certificates provided by Amazon RDS for this Amazon Web // Services account. For more information, see Using SSL/TLS to encrypt a -// connection to a DB instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) -// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB -// cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) +// connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) +// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB +// cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCertificatesInput, optFns ...func(*Options)) (*DescribeCertificatesOutput, error) { if params == nil { @@ -40,9 +38,7 @@ type DescribeCertificatesInput struct { // The user-supplied certificate identifier. If this parameter is specified, // information for only the identified certificate is returned. This parameter // isn't case-sensitive. Constraints: - // - // * Must match an existing - // CertificateIdentifier. + // - Must match an existing CertificateIdentifier. CertificateIdentifier *string // This parameter isn't currently supported. @@ -50,7 +46,7 @@ type DescribeCertificatesInput struct { // An optional pagination token provided by a previous DescribeCertificates // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/rds/api_op_DescribeDBClusterBacktracks.go b/service/rds/api_op_DescribeDBClusterBacktracks.go index e928b45f74c..49e7112de4e 100644 --- a/service/rds/api_op_DescribeDBClusterBacktracks.go +++ b/service/rds/api_op_DescribeDBClusterBacktracks.go @@ -13,8 +13,7 @@ import ( ) // Returns information about backtracks for a DB cluster. For more information on -// Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB // clusters. func (c *Client) DescribeDBClusterBacktracks(ctx context.Context, params *DescribeDBClusterBacktracksInput, optFns ...func(*Options)) (*DescribeDBClusterBacktracksOutput, error) { @@ -36,58 +35,38 @@ type DescribeDBClusterBacktracksInput struct { // The DB cluster identifier of the DB cluster to be described. This parameter is // stored as a lowercase string. Constraints: - // - // * Must contain from 1 to 63 - // alphanumeric characters or hyphens. - // - // * First character must be a letter. - // - // * - // Can't end with a hyphen or contain two consecutive hyphens. - // - // Example: - // my-cluster1 + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string // If specified, this value is the backtrack identifier of the backtrack to be // described. Constraints: - // - // * Must contain a valid universally unique identifier - // (UUID). For more information about UUIDs, see A Universally Unique Identifier - // (UUID) URN Namespace (http://www.ietf.org/rfc/rfc4122.txt). - // - // Example: - // 123e4567-e89b-12d3-a456-426655440000 + // - Must contain a valid universally unique identifier (UUID). For more + // information about UUIDs, see A Universally Unique Identifier (UUID) URN + // Namespace (http://www.ietf.org/rfc/rfc4122.txt) . + // Example: 123e4567-e89b-12d3-a456-426655440000 BacktrackIdentifier *string // A filter that specifies one or more DB clusters to describe. Supported filters // include the following: - // - // * db-cluster-backtrack-id - Accepts backtrack - // identifiers. The results list includes information about only the backtracks - // identified by these identifiers. - // - // * db-cluster-backtrack-status - Accepts any of - // the following backtrack status values: - // - // * applying - // - // * completed - // - // * failed - // - // * - // pending - // - // The results list includes information about only the backtracks - // identified by these values. + // - db-cluster-backtrack-id - Accepts backtrack identifiers. The results list + // includes information about only the backtracks identified by these identifiers. + // - db-cluster-backtrack-status - Accepts any of the following backtrack status + // values: + // - applying + // - completed + // - failed + // - pending The results list includes information about only the backtracks + // identified by these values. Filters []types.Filter // An optional pagination token provided by a previous DescribeDBClusterBacktracks // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/rds/api_op_DescribeDBClusterEndpoints.go b/service/rds/api_op_DescribeDBClusterEndpoints.go index 1c75435a6a8..26dd2110a01 100644 --- a/service/rds/api_op_DescribeDBClusterEndpoints.go +++ b/service/rds/api_op_DescribeDBClusterEndpoints.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about endpoints for an Amazon Aurora DB cluster. This action -// only applies to Aurora DB clusters. +// Returns information about endpoints for an Amazon Aurora DB cluster. This +// action only applies to Aurora DB clusters. func (c *Client) DescribeDBClusterEndpoints(ctx context.Context, params *DescribeDBClusterEndpointsInput, optFns ...func(*Options)) (*DescribeDBClusterEndpointsOutput, error) { if params == nil { params = &DescribeDBClusterEndpointsInput{} @@ -41,18 +41,18 @@ type DescribeDBClusterEndpointsInput struct { // A set of name-value pairs that define which endpoints to include in the output. // The filters are specified as name-value pairs, in the format - // Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: - // db-cluster-endpoint-type, db-cluster-endpoint-custom-type, - // db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the - // db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. - // Values for the db-cluster-endpoint-custom-type filter can be one or more of: - // reader, any. Values for the db-cluster-endpoint-status filter can be one or more - // of: available, creating, deleting, inactive, modifying. + // Name=endpoint_type,Values=endpoint_type1,endpoint_type2,... . Name can be one + // of: db-cluster-endpoint-type , db-cluster-endpoint-custom-type , + // db-cluster-endpoint-id , db-cluster-endpoint-status . Values for the + // db-cluster-endpoint-type filter can be one or more of: reader , writer , custom + // . Values for the db-cluster-endpoint-custom-type filter can be one or more of: + // reader , any . Values for the db-cluster-endpoint-status filter can be one or + // more of: available , creating , deleting , inactive , modifying . Filters []types.Filter // An optional pagination token provided by a previous DescribeDBClusterEndpoints // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -72,7 +72,7 @@ type DescribeDBClusterEndpointsOutput struct { // An optional pagination token provided by a previous DescribeDBClusterEndpoints // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBClusterParameterGroups.go b/service/rds/api_op_DescribeDBClusterParameterGroups.go index 29af610bc02..4c33a9c8fb3 100644 --- a/service/rds/api_op_DescribeDBClusterParameterGroups.go +++ b/service/rds/api_op_DescribeDBClusterParameterGroups.go @@ -15,11 +15,9 @@ import ( // Returns a list of DBClusterParameterGroup descriptions. If a // DBClusterParameterGroupName parameter is specified, the list will contain only // the description of the specified DB cluster parameter group. For more -// information on Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *DescribeDBClusterParameterGroupsInput, optFns ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error) { if params == nil { @@ -40,9 +38,7 @@ type DescribeDBClusterParameterGroupsInput struct { // The name of a specific DB cluster parameter group to return details for. // Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string // This parameter isn't currently supported. @@ -51,7 +47,7 @@ type DescribeDBClusterParameterGroupsInput struct { // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -71,7 +67,7 @@ type DescribeDBClusterParameterGroupsOutput struct { // An optional pagination token provided by a previous // DescribeDBClusterParameterGroups request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBClusterParameters.go b/service/rds/api_op_DescribeDBClusterParameters.go index ade95ba5150..5c6e8b45dcf 100644 --- a/service/rds/api_op_DescribeDBClusterParameters.go +++ b/service/rds/api_op_DescribeDBClusterParameters.go @@ -12,12 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the detailed parameter list for a particular DB cluster parameter group. -// For more information on Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// Returns the detailed parameter list for a particular DB cluster parameter +// group. For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *DescribeDBClusterParametersInput, optFns ...func(*Options)) (*DescribeDBClusterParametersOutput, error) { if params == nil { @@ -38,9 +36,7 @@ type DescribeDBClusterParametersInput struct { // The name of a specific DB cluster parameter group to return parameter details // for. Constraints: - // - // * If supplied, must match the name of an existing - // DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. // // This member is required. DBClusterParameterGroupName *string @@ -50,7 +46,7 @@ type DescribeDBClusterParametersInput struct { // An optional pagination token provided by a previous DescribeDBClusterParameters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -60,7 +56,7 @@ type DescribeDBClusterParametersInput struct { MaxRecords *int32 // A value that indicates to return only parameters for a specific source. - // Parameter sources can be engine, service, or customer. + // Parameter sources can be engine , service , or customer . Source *string noSmithyDocumentSerde @@ -72,7 +68,7 @@ type DescribeDBClusterParametersOutput struct { // An optional pagination token provided by a previous DescribeDBClusterParameters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Provides a list of parameters for the DB cluster parameter group. diff --git a/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go b/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go index f12d66331b1..da8fdb1f8b7 100644 --- a/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of DB cluster snapshot attribute names and values for a manual DB -// cluster snapshot. When sharing snapshots with other Amazon Web Services +// Returns a list of DB cluster snapshot attribute names and values for a manual +// DB cluster snapshot. When sharing snapshots with other Amazon Web Services // accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and // a list of IDs for the Amazon Web Services accounts that are authorized to copy // or restore the manual DB cluster snapshot. If all is included in the list of diff --git a/service/rds/api_op_DescribeDBClusterSnapshots.go b/service/rds/api_op_DescribeDBClusterSnapshots.go index ec0b0237c17..96a56d78c2c 100644 --- a/service/rds/api_op_DescribeDBClusterSnapshots.go +++ b/service/rds/api_op_DescribeDBClusterSnapshots.go @@ -19,12 +19,10 @@ import ( ) // Returns information about DB cluster snapshots. This API action supports -// pagination. For more information on Amazon Aurora DB clusters, see What is -// Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// pagination. For more information on Amazon Aurora DB clusters, see What is +// Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) DescribeDBClusterSnapshots(ctx context.Context, params *DescribeDBClusterSnapshotsInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotsOutput, error) { if params == nil { @@ -46,35 +44,24 @@ type DescribeDBClusterSnapshotsInput struct { // The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This // parameter can't be used in conjunction with the DBClusterSnapshotIdentifier // parameter. This parameter isn't case-sensitive. Constraints: - // - // * If supplied, - // must match the identifier of an existing DBCluster. + // - If supplied, must match the identifier of an existing DBCluster. DBClusterIdentifier *string // A specific DB cluster snapshot identifier to describe. This parameter can't be - // used in conjunction with the DBClusterIdentifier parameter. This value is stored - // as a lowercase string. Constraints: - // - // * If supplied, must match the identifier of - // an existing DBClusterSnapshot. - // - // * If this identifier is for an automated - // snapshot, the SnapshotType parameter must also be specified. + // used in conjunction with the DBClusterIdentifier parameter. This value is + // stored as a lowercase string. Constraints: + // - If supplied, must match the identifier of an existing DBClusterSnapshot. + // - If this identifier is for an automated snapshot, the SnapshotType parameter + // must also be specified. DBClusterSnapshotIdentifier *string // A filter that specifies one or more DB cluster snapshots to describe. Supported // filters: - // - // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon - // Resource Names (ARNs). - // - // * db-cluster-snapshot-id - Accepts DB cluster snapshot - // identifiers. - // - // * snapshot-type - Accepts types of DB cluster snapshots. - // - // * engine - // - Accepts names of database engines. + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). + // - db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. + // - snapshot-type - Accepts types of DB cluster snapshots. + // - engine - Accepts names of database engines. Filters []types.Filter // A value that indicates whether to include manual DB cluster snapshots that are @@ -94,7 +81,7 @@ type DescribeDBClusterSnapshotsInput struct { // An optional pagination token provided by a previous DescribeDBClusterSnapshots // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -105,29 +92,21 @@ type DescribeDBClusterSnapshotsInput struct { // The type of DB cluster snapshots to be returned. You can specify one of the // following values: - // - // * automated - Return all DB cluster snapshots that have been - // automatically taken by Amazon RDS for my Amazon Web Services account. - // - // * manual - // - Return all DB cluster snapshots that have been taken by my Amazon Web Services - // account. - // - // * shared - Return all manual DB cluster snapshots that have been - // shared to my Amazon Web Services account. - // - // * public - Return all DB cluster - // snapshots that have been marked as public. - // - // If you don't specify a SnapshotType - // value, then both automated and manual DB cluster snapshots are returned. You can - // include shared DB cluster snapshots with these results by enabling the - // IncludeShared parameter. You can include public DB cluster snapshots with these - // results by enabling the IncludePublic parameter. The IncludeShared and - // IncludePublic parameters don't apply for SnapshotType values of manual or - // automated. The IncludePublic parameter doesn't apply when SnapshotType is set to - // shared. The IncludeShared parameter doesn't apply when SnapshotType is set to - // public. + // - automated - Return all DB cluster snapshots that have been automatically + // taken by Amazon RDS for my Amazon Web Services account. + // - manual - Return all DB cluster snapshots that have been taken by my Amazon + // Web Services account. + // - shared - Return all manual DB cluster snapshots that have been shared to my + // Amazon Web Services account. + // - public - Return all DB cluster snapshots that have been marked as public. + // If you don't specify a SnapshotType value, then both automated and manual DB + // cluster snapshots are returned. You can include shared DB cluster snapshots with + // these results by enabling the IncludeShared parameter. You can include public + // DB cluster snapshots with these results by enabling the IncludePublic + // parameter. The IncludeShared and IncludePublic parameters don't apply for + // SnapshotType values of manual or automated . The IncludePublic parameter + // doesn't apply when SnapshotType is set to shared . The IncludeShared parameter + // doesn't apply when SnapshotType is set to public . SnapshotType *string noSmithyDocumentSerde @@ -142,7 +121,7 @@ type DescribeDBClusterSnapshotsOutput struct { // An optional pagination token provided by a previous DescribeDBClusterSnapshots // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -324,8 +303,8 @@ type DBClusterSnapshotAvailableWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBClusterSnapshotAvailableWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBClusterSnapshotAvailableWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -623,8 +602,8 @@ type DBClusterSnapshotDeletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBClusterSnapshotDeletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBClusterSnapshotDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/rds/api_op_DescribeDBClusters.go b/service/rds/api_op_DescribeDBClusters.go index f9479c64ac7..2a010939362 100644 --- a/service/rds/api_op_DescribeDBClusters.go +++ b/service/rds/api_op_DescribeDBClusters.go @@ -20,11 +20,9 @@ import ( // Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. // This API supports pagination. For more information on Amazon Aurora DB clusters, -// see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. This operation can also return information for // Amazon Neptune DB instances and Amazon DocumentDB instances. func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClustersInput, optFns ...func(*Options)) (*DescribeDBClustersOutput, error) { @@ -44,36 +42,26 @@ func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClust type DescribeDBClustersInput struct { - // The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the - // DB cluster. If this parameter is specified, information from only the specific - // DB cluster is returned. This parameter isn't case-sensitive. Constraints: - // - // * If - // supplied, must match an existing DBClusterIdentifier. + // The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of + // the DB cluster. If this parameter is specified, information from only the + // specific DB cluster is returned. This parameter isn't case-sensitive. + // Constraints: + // - If supplied, must match an existing DBClusterIdentifier. DBClusterIdentifier *string - // A filter that specifies one or more DB clusters to describe. Supported - // filters: - // - // * clone-group-id - Accepts clone group identifiers. The results list - // only includes information about the DB clusters associated with these clone - // groups. - // - // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon - // Resource Names (ARNs). The results list only includes information about the DB - // clusters identified by these ARNs. - // - // * db-cluster-resource-id - Accepts DB - // cluster resource identifiers. The results list will only include information - // about the DB clusters identified by these DB cluster resource identifiers. - // - // * - // domain - Accepts Active Directory directory IDs. The results list only includes - // information about the DB clusters associated with these domains. - // - // * engine - - // Accepts engine names. The results list only includes information about the DB - // clusters for these engines. + // A filter that specifies one or more DB clusters to describe. Supported filters: + // - clone-group-id - Accepts clone group identifiers. The results list only + // includes information about the DB clusters associated with these clone groups. + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list only includes information about the DB + // clusters identified by these ARNs. + // - db-cluster-resource-id - Accepts DB cluster resource identifiers. The + // results list will only include information about the DB clusters identified by + // these DB cluster resource identifiers. + // - domain - Accepts Active Directory directory IDs. The results list only + // includes information about the DB clusters associated with these domains. + // - engine - Accepts engine names. The results list only includes information + // about the DB clusters for these engines. Filters []types.Filter // Optional Boolean parameter that specifies whether the output includes @@ -82,7 +70,7 @@ type DescribeDBClustersInput struct { // An optional pagination token provided by a previous DescribeDBClusters request. // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -279,8 +267,8 @@ type DBClusterAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBClusterAvailableWaiter will use default max delay of 120 seconds. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBClusterAvailableWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -574,9 +562,9 @@ type DBClusterDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBClusterDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBClusterDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/rds/api_op_DescribeDBEngineVersions.go b/service/rds/api_op_DescribeDBEngineVersions.go index d207c28f28f..4923b2f4a8e 100644 --- a/service/rds/api_op_DescribeDBEngineVersions.go +++ b/service/rds/api_op_DescribeDBEngineVersions.go @@ -32,8 +32,7 @@ type DescribeDBEngineVersionsInput struct { // The name of a specific DB parameter group family to return details for. // Constraints: - // - // * If supplied, must match an existing DBParameterGroupFamily. + // - If supplied, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string // A value that indicates whether only the default version of the specified engine @@ -41,36 +40,19 @@ type DescribeDBEngineVersionsInput struct { DefaultOnly bool // The database engine to return. Valid Values: - // - // * aurora-mysql (for MySQL - // 5.7-compatible and MySQL 8.0-compatible Aurora) - // - // * aurora-postgresql - // - // * - // mariadb - // - // * mysql - // - // * oracle-ee - // - // * oracle-ee-cdb - // - // * oracle-se2 - // - // * - // oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * sqlserver-se - // - // * sqlserver-ex - // - // * - // sqlserver-web + // - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) + // - aurora-postgresql + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web Engine *string // The database engine version to return. Example: 5.1.49 @@ -78,41 +60,26 @@ type DescribeDBEngineVersionsInput struct { // A filter that specifies one or more DB engine versions to describe. Supported // filters: - // - // * db-parameter-group-family - Accepts parameter groups family names. - // The results list only includes information about the DB engine versions for - // these parameter group families. - // - // * engine - Accepts engine names. The results - // list only includes information about the DB engine versions for these - // engines. - // - // * engine-mode - Accepts DB engine modes. The results list only - // includes information about the DB engine versions for these engine modes. Valid - // DB engine modes are the following: - // - // * global - // - // * multimaster - // - // * parallelquery - // - // * - // provisioned - // - // * serverless - // - // * engine-version - Accepts engine versions. The - // results list only includes information about the DB engine versions for these - // engine versions. - // - // * status - Accepts engine version statuses. The results list - // only includes information about the DB engine versions for these statuses. Valid - // statuses are the following: - // - // * available - // - // * deprecated + // - db-parameter-group-family - Accepts parameter groups family names. The + // results list only includes information about the DB engine versions for these + // parameter group families. + // - engine - Accepts engine names. The results list only includes information + // about the DB engine versions for these engines. + // - engine-mode - Accepts DB engine modes. The results list only includes + // information about the DB engine versions for these engine modes. Valid DB engine + // modes are the following: + // - global + // - multimaster + // - parallelquery + // - provisioned + // - serverless + // - engine-version - Accepts engine versions. The results list only includes + // information about the DB engine versions for these engine versions. + // - status - Accepts engine version statuses. The results list only includes + // information about the DB engine versions for these statuses. Valid statuses are + // the following: + // - available + // - deprecated Filters []types.Filter // A value that indicates whether to include engine versions that aren't available @@ -121,23 +88,23 @@ type DescribeDBEngineVersionsInput struct { // A value that indicates whether to list the supported character sets for each // engine version. If this parameter is enabled and the requested engine supports - // the CharacterSetName parameter for CreateDBInstance, the response includes a + // the CharacterSetName parameter for CreateDBInstance , the response includes a // list of supported character sets for each engine version. For RDS Custom, the // default is not to list supported character sets. If you set - // ListSupportedCharacterSets to true, RDS Custom returns no results. + // ListSupportedCharacterSets to true , RDS Custom returns no results. ListSupportedCharacterSets *bool // A value that indicates whether to list the supported time zones for each engine // version. If this parameter is enabled and the requested engine supports the - // TimeZone parameter for CreateDBInstance, the response includes a list of + // TimeZone parameter for CreateDBInstance , the response includes a list of // supported time zones for each engine version. For RDS Custom, the default is not - // to list supported time zones. If you set ListSupportedTimezones to true, RDS + // to list supported time zones. If you set ListSupportedTimezones to true , RDS // Custom returns no results. ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more than the @@ -158,7 +125,7 @@ type DescribeDBEngineVersionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go b/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go index d3dbd40d8e2..972bb718a54 100644 --- a/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go +++ b/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go @@ -35,8 +35,9 @@ func (c *Client) DescribeDBInstanceAutomatedBackups(ctx context.Context, params // Parameter input for DescribeDBInstanceAutomatedBackups. type DescribeDBInstanceAutomatedBackupsInput struct { - // The Amazon Resource Name (ARN) of the replicated automated backups, for example, - // arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. + // The Amazon Resource Name (ARN) of the replicated automated backups, for + // example, + // arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . // This setting doesn't apply to RDS Custom. DBInstanceAutomatedBackupsArn *string @@ -52,34 +53,25 @@ type DescribeDBInstanceAutomatedBackupsInput struct { // A filter that specifies which resources to return based on status. Supported // filters are the following: - // - // * status - // - // * active - automated backups for current - // instances - // - // * retained - automated backups for deleted instances and after backup - // replication is stopped - // - // * creating - automated backups that are waiting for the - // first automated snapshot to be available - // - // * db-instance-id - Accepts DB instance - // identifiers and Amazon Resource Names (ARNs). The results list includes only - // information about the DB instance automated backups identified by these ARNs. - // - // * - // dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names - // (ARNs). The results list includes only information about the DB instance - // resources identified by these ARNs. - // - // Returns all resources by default. The - // status for each resource is specified in the response. + // - status + // - active - automated backups for current instances + // - retained - automated backups for deleted instances and after backup + // replication is stopped + // - creating - automated backups that are waiting for the first automated + // snapshot to be available + // - db-instance-id - Accepts DB instance identifiers and Amazon Resource Names + // (ARNs). The results list includes only information about the DB instance + // automated backups identified by these ARNs. + // - dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names + // (ARNs). The results list includes only information about the DB instance + // resources identified by these ARNs. + // Returns all resources by default. The status for each resource is specified in + // the response. Filters []types.Filter // The pagination token provided in the previous request. If this parameter is - // specified the response includes only records beyond the marker, up to - // MaxRecords. + // specified the response includes only records beyond the marker, up to MaxRecords + // . Marker *string // The maximum number of records to include in the response. If more records exist @@ -99,7 +91,7 @@ type DescribeDBInstanceAutomatedBackupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBInstances.go b/service/rds/api_op_DescribeDBInstances.go index 5de86fc644e..512f7331824 100644 --- a/service/rds/api_op_DescribeDBInstances.go +++ b/service/rds/api_op_DescribeDBInstances.go @@ -42,39 +42,29 @@ type DescribeDBInstancesInput struct { // The user-supplied instance identifier or the Amazon Resource Name (ARN) of the // DB instance. If this parameter is specified, information from only the specific // DB instance is returned. This parameter isn't case-sensitive. Constraints: - // - // * If - // supplied, must match the identifier of an existing DBInstance. + // - If supplied, must match the identifier of an existing DBInstance. DBInstanceIdentifier *string // A filter that specifies one or more DB instances to describe. Supported // filters: - // - // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon - // Resource Names (ARNs). The results list only includes information about the DB - // instances associated with the DB clusters identified by these ARNs. - // - // * - // db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource - // Names (ARNs). The results list only includes information about the DB instances - // identified by these ARNs. - // - // * dbi-resource-id - Accepts DB instance resource - // identifiers. The results list will only include information about the DB - // instances identified by these DB instance resource identifiers. - // - // * domain - - // Accepts Active Directory directory IDs. The results list only includes - // information about the DB instances associated with these domains. - // - // * engine - - // Accepts engine names. The results list only includes information about the DB - // instances for these engines. + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list only includes information about the DB + // instances associated with the DB clusters identified by these ARNs. + // - db-instance-id - Accepts DB instance identifiers and DB instance Amazon + // Resource Names (ARNs). The results list only includes information about the DB + // instances identified by these ARNs. + // - dbi-resource-id - Accepts DB instance resource identifiers. The results list + // will only include information about the DB instances identified by these DB + // instance resource identifiers. + // - domain - Accepts Active Directory directory IDs. The results list only + // includes information about the DB instances associated with these domains. + // - engine - Accepts engine names. The results list only includes information + // about the DB instances for these engines. Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBInstances request. - // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // An optional pagination token provided by a previous DescribeDBInstances + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -167,8 +157,8 @@ func (c *Client) addOperationDescribeDBInstancesMiddlewares(stack *middleware.St return nil } -// DescribeDBInstancesAPIClient is a client that implements the DescribeDBInstances -// operation. +// DescribeDBInstancesAPIClient is a client that implements the +// DescribeDBInstances operation. type DescribeDBInstancesAPIClient interface { DescribeDBInstances(context.Context, *DescribeDBInstancesInput, ...func(*Options)) (*DescribeDBInstancesOutput, error) } @@ -275,9 +265,10 @@ type DBInstanceAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -317,9 +308,9 @@ func NewDBInstanceAvailableWaiter(client DescribeDBInstancesAPIClient, optFns .. } } -// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for DBInstanceAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *DBInstanceAvailableWaiter) Wait(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -570,9 +561,9 @@ type DBInstanceDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBInstanceDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -620,10 +611,10 @@ func (w *DBInstanceDeletedWaiter) Wait(ctx context.Context, params *DescribeDBIn return err } -// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for DBInstanceDeleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *DBInstanceDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBInstancesInput, maxWaitDur time.Duration, optFns ...func(*DBInstanceDeletedWaiterOptions)) (*DescribeDBInstancesOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/rds/api_op_DescribeDBLogFiles.go b/service/rds/api_op_DescribeDBLogFiles.go index 7c5234815e0..7b85c8a98a4 100644 --- a/service/rds/api_op_DescribeDBLogFiles.go +++ b/service/rds/api_op_DescribeDBLogFiles.go @@ -33,9 +33,7 @@ type DescribeDBLogFilesInput struct { // The customer-assigned name of the DB instance that contains the log files you // want to list. Constraints: - // - // * Must match the identifier of an existing - // DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string @@ -67,7 +65,7 @@ type DescribeDBLogFilesInput struct { noSmithyDocumentSerde } -// The response from a call to DescribeDBLogFiles. +// The response from a call to DescribeDBLogFiles . type DescribeDBLogFilesOutput struct { // The DB log files returned. diff --git a/service/rds/api_op_DescribeDBParameterGroups.go b/service/rds/api_op_DescribeDBParameterGroups.go index ab9882630c3..9fbda02981f 100644 --- a/service/rds/api_op_DescribeDBParameterGroups.go +++ b/service/rds/api_op_DescribeDBParameterGroups.go @@ -33,9 +33,7 @@ func (c *Client) DescribeDBParameterGroups(ctx context.Context, params *Describe type DescribeDBParameterGroupsInput struct { // The name of a specific DB parameter group to return details for. Constraints: - // - // * - // If supplied, must match the name of an existing DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBParameterGroupName *string // This parameter isn't currently supported. @@ -43,7 +41,7 @@ type DescribeDBParameterGroupsInput struct { // An optional pagination token provided by a previous DescribeDBParameterGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -64,7 +62,7 @@ type DescribeDBParameterGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBParameters.go b/service/rds/api_op_DescribeDBParameters.go index b3421dd65de..f1f504cc586 100644 --- a/service/rds/api_op_DescribeDBParameters.go +++ b/service/rds/api_op_DescribeDBParameters.go @@ -31,9 +31,7 @@ func (c *Client) DescribeDBParameters(ctx context.Context, params *DescribeDBPar type DescribeDBParametersInput struct { // The name of a specific DB parameter group to return details for. Constraints: - // - // * - // If supplied, must match the name of an existing DBParameterGroup. + // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. DBParameterGroupName *string @@ -43,7 +41,7 @@ type DescribeDBParametersInput struct { // An optional pagination token provided by a previous DescribeDBParameters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -65,7 +63,7 @@ type DescribeDBParametersOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A list of Parameter values. diff --git a/service/rds/api_op_DescribeDBProxies.go b/service/rds/api_op_DescribeDBProxies.go index ee16ad16f38..31d479ceb6d 100644 --- a/service/rds/api_op_DescribeDBProxies.go +++ b/service/rds/api_op_DescribeDBProxies.go @@ -39,7 +39,7 @@ type DescribeDBProxiesInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -58,7 +58,7 @@ type DescribeDBProxiesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBProxyEndpoints.go b/service/rds/api_op_DescribeDBProxyEndpoints.go index 316b9e3f9da..2cef53a4113 100644 --- a/service/rds/api_op_DescribeDBProxyEndpoints.go +++ b/service/rds/api_op_DescribeDBProxyEndpoints.go @@ -45,7 +45,7 @@ type DescribeDBProxyEndpointsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -64,7 +64,7 @@ type DescribeDBProxyEndpointsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBProxyTargetGroups.go b/service/rds/api_op_DescribeDBProxyTargetGroups.go index 1d705fbe17d..f2760ff00b7 100644 --- a/service/rds/api_op_DescribeDBProxyTargetGroups.go +++ b/service/rds/api_op_DescribeDBProxyTargetGroups.go @@ -41,7 +41,7 @@ type DescribeDBProxyTargetGroupsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -60,7 +60,7 @@ type DescribeDBProxyTargetGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // An arbitrary number of DBProxyTargetGroup objects, containing details of the diff --git a/service/rds/api_op_DescribeDBProxyTargets.go b/service/rds/api_op_DescribeDBProxyTargets.go index da6cdf5e927..64ac04c08dd 100644 --- a/service/rds/api_op_DescribeDBProxyTargets.go +++ b/service/rds/api_op_DescribeDBProxyTargets.go @@ -40,7 +40,7 @@ type DescribeDBProxyTargetsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -59,7 +59,7 @@ type DescribeDBProxyTargetsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // An arbitrary number of DBProxyTarget objects, containing details of the diff --git a/service/rds/api_op_DescribeDBSecurityGroups.go b/service/rds/api_op_DescribeDBSecurityGroups.go index cb444a2c811..4d9436d9dd9 100644 --- a/service/rds/api_op_DescribeDBSecurityGroups.go +++ b/service/rds/api_op_DescribeDBSecurityGroups.go @@ -16,13 +16,10 @@ import ( // specified, the list will contain only the descriptions of the specified DB // security group. EC2-Classic was retired on August 15, 2022. If you haven't // migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as -// possible. For more information, see Migrate from EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How -// to Prepare -// (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), -// and Moving a DB instance not in a VPC into a VPC -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) +// possible. For more information, see Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – +// Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) +// , and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) // in the Amazon RDS User Guide. func (c *Client) DescribeDBSecurityGroups(ctx context.Context, params *DescribeDBSecurityGroupsInput, optFns ...func(*Options)) (*DescribeDBSecurityGroupsOutput, error) { if params == nil { @@ -49,7 +46,7 @@ type DescribeDBSecurityGroupsInput struct { // An optional pagination token provided by a previous DescribeDBSecurityGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -70,7 +67,7 @@ type DescribeDBSecurityGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBSnapshotAttributes.go b/service/rds/api_op_DescribeDBSnapshotAttributes.go index 215606666d0..1717a4da46c 100644 --- a/service/rds/api_op_DescribeDBSnapshotAttributes.go +++ b/service/rds/api_op_DescribeDBSnapshotAttributes.go @@ -13,8 +13,8 @@ import ( // Returns a list of DB snapshot attribute names and values for a manual DB // snapshot. When sharing snapshots with other Amazon Web Services accounts, -// DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for -// the Amazon Web Services accounts that are authorized to copy or restore the +// DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs +// for the Amazon Web Services accounts that are authorized to copy or restore the // manual DB snapshot. If all is included in the list of values for the restore // attribute, then the manual DB snapshot is public and can be copied or restored // by all Amazon Web Services accounts. To add or remove access for an Amazon Web diff --git a/service/rds/api_op_DescribeDBSnapshots.go b/service/rds/api_op_DescribeDBSnapshots.go index 1de68abb50f..515f17b5f00 100644 --- a/service/rds/api_op_DescribeDBSnapshots.go +++ b/service/rds/api_op_DescribeDBSnapshots.go @@ -39,19 +39,14 @@ type DescribeDBSnapshotsInput struct { // The ID of the DB instance to retrieve the list of DB snapshots for. This // parameter isn't case-sensitive. Constraints: - // - // * If supplied, must match the - // identifier of an existing DBInstance. + // - If supplied, must match the identifier of an existing DBInstance. DBInstanceIdentifier *string // A specific DB snapshot identifier to describe. This value is stored as a // lowercase string. Constraints: - // - // * If supplied, must match the identifier of an - // existing DBSnapshot. - // - // * If this identifier is for an automated snapshot, the - // SnapshotType parameter must also be specified. + // - If supplied, must match the identifier of an existing DBSnapshot. + // - If this identifier is for an automated snapshot, the SnapshotType parameter + // must also be specified. DBSnapshotIdentifier *string // A specific DB resource ID to describe. @@ -59,20 +54,12 @@ type DescribeDBSnapshotsInput struct { // A filter that specifies one or more DB snapshots to describe. Supported // filters: - // - // * db-instance-id - Accepts DB instance identifiers and DB instance - // Amazon Resource Names (ARNs). - // - // * db-snapshot-id - Accepts DB snapshot - // identifiers. - // - // * dbi-resource-id - Accepts identifiers of source DB instances. - // - // * - // snapshot-type - Accepts types of DB snapshots. - // - // * engine - Accepts names of - // database engines. + // - db-instance-id - Accepts DB instance identifiers and DB instance Amazon + // Resource Names (ARNs). + // - db-snapshot-id - Accepts DB snapshot identifiers. + // - dbi-resource-id - Accepts identifiers of source DB instances. + // - snapshot-type - Accepts types of DB snapshots. + // - engine - Accepts names of database engines. Filters []types.Filter // A value that indicates whether to include manual DB cluster snapshots that are @@ -90,9 +77,9 @@ type DescribeDBSnapshotsInput struct { // ModifyDBSnapshotAttribute API action. This setting doesn't apply to RDS Custom. IncludeShared bool - // An optional pagination token provided by a previous DescribeDBSnapshots request. - // If this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // An optional pagination token provided by a previous DescribeDBSnapshots + // request. If this parameter is specified, the response includes only records + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -103,35 +90,26 @@ type DescribeDBSnapshotsInput struct { // The type of snapshots to be returned. You can specify one of the following // values: - // - // * automated - Return all DB snapshots that have been automatically - // taken by Amazon RDS for my Amazon Web Services account. - // - // * manual - Return all - // DB snapshots that have been taken by my Amazon Web Services account. - // - // * shared - - // Return all manual DB snapshots that have been shared to my Amazon Web Services - // account. - // - // * public - Return all DB snapshots that have been marked as public. - // - // * - // awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup - // service. For information about Amazon Web Services Backup, see the Amazon Web - // Services Backup Developer Guide. - // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html) The - // awsbackup type does not apply to Aurora. - // - // If you don't specify a SnapshotType - // value, then both automated and manual snapshots are returned. Shared and public - // DB snapshots are not included in the returned results by default. You can - // include shared snapshots with these results by enabling the IncludeShared - // parameter. You can include public snapshots with these results by enabling the - // IncludePublic parameter. The IncludeShared and IncludePublic parameters don't - // apply for SnapshotType values of manual or automated. The IncludePublic - // parameter doesn't apply when SnapshotType is set to shared. The IncludeShared - // parameter doesn't apply when SnapshotType is set to public. + // - automated - Return all DB snapshots that have been automatically taken by + // Amazon RDS for my Amazon Web Services account. + // - manual - Return all DB snapshots that have been taken by my Amazon Web + // Services account. + // - shared - Return all manual DB snapshots that have been shared to my Amazon + // Web Services account. + // - public - Return all DB snapshots that have been marked as public. + // - awsbackup - Return the DB snapshots managed by the Amazon Web Services + // Backup service. For information about Amazon Web Services Backup, see the + // Amazon Web Services Backup Developer Guide. (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html) + // The awsbackup type does not apply to Aurora. + // If you don't specify a SnapshotType value, then both automated and manual + // snapshots are returned. Shared and public DB snapshots are not included in the + // returned results by default. You can include shared snapshots with these results + // by enabling the IncludeShared parameter. You can include public snapshots with + // these results by enabling the IncludePublic parameter. The IncludeShared and + // IncludePublic parameters don't apply for SnapshotType values of manual or + // automated . The IncludePublic parameter doesn't apply when SnapshotType is set + // to shared . The IncludeShared parameter doesn't apply when SnapshotType is set + // to public . SnapshotType *string noSmithyDocumentSerde @@ -146,7 +124,7 @@ type DescribeDBSnapshotsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. @@ -218,8 +196,8 @@ func (c *Client) addOperationDescribeDBSnapshotsMiddlewares(stack *middleware.St return nil } -// DescribeDBSnapshotsAPIClient is a client that implements the DescribeDBSnapshots -// operation. +// DescribeDBSnapshotsAPIClient is a client that implements the +// DescribeDBSnapshots operation. type DescribeDBSnapshotsAPIClient interface { DescribeDBSnapshots(context.Context, *DescribeDBSnapshotsInput, ...func(*Options)) (*DescribeDBSnapshotsOutput, error) } @@ -326,9 +304,10 @@ type DBSnapshotAvailableWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBSnapshotAvailableWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBSnapshotAvailableWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -368,9 +347,9 @@ func NewDBSnapshotAvailableWaiter(client DescribeDBSnapshotsAPIClient, optFns .. } } -// Wait calls the waiter function for DBSnapshotAvailable waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for DBSnapshotAvailable waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *DBSnapshotAvailableWaiter) Wait(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotAvailableWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -621,9 +600,9 @@ type DBSnapshotDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, DBSnapshotDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, DBSnapshotDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -671,10 +650,10 @@ func (w *DBSnapshotDeletedWaiter) Wait(ctx context.Context, params *DescribeDBSn return err } -// WaitForOutput calls the waiter function for DBSnapshotDeleted waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for DBSnapshotDeleted waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *DBSnapshotDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeDBSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*DBSnapshotDeletedWaiterOptions)) (*DescribeDBSnapshotsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/rds/api_op_DescribeDBSubnetGroups.go b/service/rds/api_op_DescribeDBSubnetGroups.go index 8009844f086..2ae5b4bee87 100644 --- a/service/rds/api_op_DescribeDBSubnetGroups.go +++ b/service/rds/api_op_DescribeDBSubnetGroups.go @@ -14,8 +14,8 @@ import ( // Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is // specified, the list will contain only the descriptions of the specified -// DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial -// (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). +// DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . func (c *Client) DescribeDBSubnetGroups(ctx context.Context, params *DescribeDBSubnetGroupsInput, optFns ...func(*Options)) (*DescribeDBSubnetGroupsOutput, error) { if params == nil { params = &DescribeDBSubnetGroupsInput{} @@ -41,7 +41,7 @@ type DescribeDBSubnetGroupsInput struct { // An optional pagination token provided by a previous DescribeDBSubnetGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -62,7 +62,7 @@ type DescribeDBSubnetGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeEngineDefaultClusterParameters.go b/service/rds/api_op_DescribeEngineDefaultClusterParameters.go index 4e8218b3313..2c1a6d7dc80 100644 --- a/service/rds/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/rds/api_op_DescribeEngineDefaultClusterParameters.go @@ -12,9 +12,8 @@ import ( ) // Returns the default engine and system parameter information for the cluster -// database engine. For more information on Amazon Aurora, see What is Amazon -// Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// database engine. For more information on Amazon Aurora, see What is Amazon +// Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. func (c *Client) DescribeEngineDefaultClusterParameters(ctx context.Context, params *DescribeEngineDefaultClusterParametersInput, optFns ...func(*Options)) (*DescribeEngineDefaultClusterParametersOutput, error) { if params == nil { @@ -45,7 +44,7 @@ type DescribeEngineDefaultClusterParametersInput struct { // An optional pagination token provided by a previous // DescribeEngineDefaultClusterParameters request. If this parameter is specified, // the response includes only records beyond the marker, up to the value specified - // by MaxRecords. + // by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/rds/api_op_DescribeEngineDefaultParameters.go b/service/rds/api_op_DescribeEngineDefaultParameters.go index 08353bebd29..76cce1fdc42 100644 --- a/service/rds/api_op_DescribeEngineDefaultParameters.go +++ b/service/rds/api_op_DescribeEngineDefaultParameters.go @@ -32,114 +32,53 @@ func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *De type DescribeEngineDefaultParametersInput struct { // The name of the DB parameter group family. Valid Values: - // - // * aurora5.6 - // - // * - // aurora-mysql5.7 - // - // * aurora-mysql8.0 - // - // * aurora-postgresql10 - // - // * - // aurora-postgresql11 - // - // * aurora-postgresql12 - // - // * aurora-postgresql13 - // - // * - // aurora-postgresql14 - // - // * custom-oracle-ee-19 - // - // * mariadb10.2 - // - // * mariadb10.3 - // - // * - // mariadb10.4 - // - // * mariadb10.5 - // - // * mariadb10.6 - // - // * mysql5.7 - // - // * mysql8.0 - // - // * - // oracle-ee-19 - // - // * oracle-ee-cdb-19 - // - // * oracle-ee-cdb-21 - // - // * oracle-se2-19 - // - // * - // oracle-se2-cdb-19 - // - // * oracle-se2-cdb-21 - // - // * postgres10 - // - // * postgres11 - // - // * - // postgres12 - // - // * postgres13 - // - // * postgres14 - // - // * sqlserver-ee-11.0 - // - // * - // sqlserver-ee-12.0 - // - // * sqlserver-ee-13.0 - // - // * sqlserver-ee-14.0 - // - // * - // sqlserver-ee-15.0 - // - // * sqlserver-ex-11.0 - // - // * sqlserver-ex-12.0 - // - // * - // sqlserver-ex-13.0 - // - // * sqlserver-ex-14.0 - // - // * sqlserver-ex-15.0 - // - // * - // sqlserver-se-11.0 - // - // * sqlserver-se-12.0 - // - // * sqlserver-se-13.0 - // - // * - // sqlserver-se-14.0 - // - // * sqlserver-se-15.0 - // - // * sqlserver-web-11.0 - // - // * - // sqlserver-web-12.0 - // - // * sqlserver-web-13.0 - // - // * sqlserver-web-14.0 - // - // * - // sqlserver-web-15.0 + // - aurora5.6 + // - aurora-mysql5.7 + // - aurora-mysql8.0 + // - aurora-postgresql10 + // - aurora-postgresql11 + // - aurora-postgresql12 + // - aurora-postgresql13 + // - aurora-postgresql14 + // - custom-oracle-ee-19 + // - mariadb10.2 + // - mariadb10.3 + // - mariadb10.4 + // - mariadb10.5 + // - mariadb10.6 + // - mysql5.7 + // - mysql8.0 + // - oracle-ee-19 + // - oracle-ee-cdb-19 + // - oracle-ee-cdb-21 + // - oracle-se2-19 + // - oracle-se2-cdb-19 + // - oracle-se2-cdb-21 + // - postgres10 + // - postgres11 + // - postgres12 + // - postgres13 + // - postgres14 + // - sqlserver-ee-11.0 + // - sqlserver-ee-12.0 + // - sqlserver-ee-13.0 + // - sqlserver-ee-14.0 + // - sqlserver-ee-15.0 + // - sqlserver-ex-11.0 + // - sqlserver-ex-12.0 + // - sqlserver-ex-13.0 + // - sqlserver-ex-14.0 + // - sqlserver-ex-15.0 + // - sqlserver-se-11.0 + // - sqlserver-se-12.0 + // - sqlserver-se-13.0 + // - sqlserver-se-14.0 + // - sqlserver-se-15.0 + // - sqlserver-web-11.0 + // - sqlserver-web-12.0 + // - sqlserver-web-13.0 + // - sqlserver-web-14.0 + // - sqlserver-web-15.0 // // This member is required. DBParameterGroupFamily *string @@ -150,7 +89,7 @@ type DescribeEngineDefaultParametersInput struct { // An optional pagination token provided by a previous // DescribeEngineDefaultParameters request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist diff --git a/service/rds/api_op_DescribeEventCategories.go b/service/rds/api_op_DescribeEventCategories.go index e9a277f8283..dab35d176ad 100644 --- a/service/rds/api_op_DescribeEventCategories.go +++ b/service/rds/api_op_DescribeEventCategories.go @@ -13,10 +13,9 @@ import ( // Displays a list of categories for all event source types, or, if specified, for // a specified source type. You can also see this list in the "Amazon RDS event -// categories and event messages" section of the Amazon RDS User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) -// or the Amazon Aurora User Guide -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). +// categories and event messages" section of the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) +// or the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html) +// . func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, optFns ...func(*Options)) (*DescribeEventCategoriesOutput, error) { if params == nil { params = &DescribeEventCategoriesInput{} @@ -38,7 +37,7 @@ type DescribeEventCategoriesInput struct { Filters []types.Filter // The type of source that is generating the events. For RDS Proxy events, specify - // db-proxy. Valid values: db-instance | db-cluster | db-parameter-group | + // db-proxy . Valid values: db-instance | db-cluster | db-parameter-group | // db-security-group | db-snapshot | db-cluster-snapshot | db-proxy SourceType *string diff --git a/service/rds/api_op_DescribeEventSubscriptions.go b/service/rds/api_op_DescribeEventSubscriptions.go index 4e03de96e40..6d4398e0a0c 100644 --- a/service/rds/api_op_DescribeEventSubscriptions.go +++ b/service/rds/api_op_DescribeEventSubscriptions.go @@ -13,9 +13,9 @@ import ( ) // Lists all the subscription descriptions for a customer account. The description -// for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, -// SourceType, SourceID, CreationTime, and Status. If you specify a -// SubscriptionName, lists the description for that subscription. +// for a subscription includes SubscriptionName , SNSTopicARN , CustomerID , +// SourceType , SourceID , CreationTime , and Status . If you specify a +// SubscriptionName , lists the description for that subscription. func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error) { if params == nil { params = &DescribeEventSubscriptionsInput{} @@ -63,7 +63,7 @@ type DescribeEventSubscriptionsOutput struct { // An optional pagination token provided by a previous // DescribeOrderableDBInstanceOptions request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeEvents.go b/service/rds/api_op_DescribeEvents.go index 314ad8d31ba..ba857ad4125 100644 --- a/service/rds/api_op_DescribeEvents.go +++ b/service/rds/api_op_DescribeEvents.go @@ -18,10 +18,8 @@ import ( // past 14 days. Events specific to a particular DB instance, DB cluster, DB // parameter group, DB security group, DB snapshot, DB cluster snapshot group, or // RDS Proxy can be obtained by providing the name as a parameter. For more -// information on working with events, see Monitoring Amazon RDS events -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html) -// in the Amazon RDS User Guide and Monitoring Amazon Aurora events -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html) +// information on working with events, see Monitoring Amazon RDS events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html) +// in the Amazon RDS User Guide and Monitoring Amazon Aurora events (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html) // in the Amazon Aurora User Guide. By default, RDS returns events that were // generated in the past hour. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { @@ -44,9 +42,9 @@ type DescribeEventsInput struct { // The number of minutes to retrieve events for. Default: 60 Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z EndTime *time.Time // A list of event categories that trigger notifications for a event notification @@ -58,7 +56,7 @@ type DescribeEventsInput struct { // An optional pagination token provided by a previous DescribeEvents request. If // this parameter is specified, the response includes only records beyond the - // marker, up to the value specified by MaxRecords. + // marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -69,43 +67,30 @@ type DescribeEventsInput struct { // The identifier of the event source for which events are returned. If not // specified, then all sources are included in the response. Constraints: - // - // * If - // SourceIdentifier is supplied, SourceType must also be provided. - // - // * If the source - // type is a DB instance, a DBInstanceIdentifier value must be supplied. - // - // * If the - // source type is a DB cluster, a DBClusterIdentifier value must be supplied. - // - // * If - // the source type is a DB parameter group, a DBParameterGroupName value must be - // supplied. - // - // * If the source type is a DB security group, a DBSecurityGroupName - // value must be supplied. - // - // * If the source type is a DB snapshot, a - // DBSnapshotIdentifier value must be supplied. - // - // * If the source type is a DB - // cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. - // - // * If - // the source type is an RDS Proxy, a DBProxyName value must be supplied. - // - // * Can't - // end with a hyphen or contain two consecutive hyphens. + // - If SourceIdentifier is supplied, SourceType must also be provided. + // - If the source type is a DB instance, a DBInstanceIdentifier value must be + // supplied. + // - If the source type is a DB cluster, a DBClusterIdentifier value must be + // supplied. + // - If the source type is a DB parameter group, a DBParameterGroupName value + // must be supplied. + // - If the source type is a DB security group, a DBSecurityGroupName value must + // be supplied. + // - If the source type is a DB snapshot, a DBSnapshotIdentifier value must be + // supplied. + // - If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier + // value must be supplied. + // - If the source type is an RDS Proxy, a DBProxyName value must be supplied. + // - Can't end with a hyphen or contain two consecutive hyphens. SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z StartTime *time.Time noSmithyDocumentSerde @@ -119,7 +104,7 @@ type DescribeEventsOutput struct { // An optional pagination token provided by a previous Events request. If this // parameter is specified, the response includes only records beyond the marker, up - // to the value specified by MaxRecords. + // to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeExportTasks.go b/service/rds/api_op_DescribeExportTasks.go index 7e37e456c2f..291644707e4 100644 --- a/service/rds/api_op_DescribeExportTasks.go +++ b/service/rds/api_op_DescribeExportTasks.go @@ -34,40 +34,28 @@ type DescribeExportTasksInput struct { // The identifier of the snapshot or cluster export task to be described. ExportTaskIdentifier *string - // Filters specify one or more snapshot or cluster exports to describe. The filters - // are specified as name-value pairs that define what to include in the output. - // Filter names and values are case-sensitive. Supported filters include the - // following: - // - // * export-task-identifier - An identifier for the snapshot or cluster - // export task. - // - // * s3-bucket - The Amazon S3 bucket the data is exported to. - // - // * - // source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported - // to Amazon S3. - // - // * status - The status of the export task. Must be lowercase. - // Valid statuses are the following: - // - // * canceled - // - // * canceling - // - // * complete - // - // * - // failed - // - // * in_progress - // - // * starting + // Filters specify one or more snapshot or cluster exports to describe. The + // filters are specified as name-value pairs that define what to include in the + // output. Filter names and values are case-sensitive. Supported filters include + // the following: + // - export-task-identifier - An identifier for the snapshot or cluster export + // task. + // - s3-bucket - The Amazon S3 bucket the data is exported to. + // - source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster + // exported to Amazon S3. + // - status - The status of the export task. Must be lowercase. Valid statuses + // are the following: + // - canceled + // - canceling + // - complete + // - failed + // - in_progress + // - starting Filters []types.Filter - // An optional pagination token provided by a previous DescribeExportTasks request. - // If you specify this parameter, the response includes only records beyond the - // marker, up to the value specified by the MaxRecords parameter. + // An optional pagination token provided by a previous DescribeExportTasks + // request. If you specify this parameter, the response includes only records + // beyond the marker, up to the value specified by the MaxRecords parameter. Marker *string // The maximum number of records to include in the response. If more records exist @@ -93,7 +81,7 @@ type DescribeExportTasksOutput struct { // A pagination token that can be used in a later DescribeExportTasks request. A // marker is used for pagination to identify the location to begin output for the - // next response of DescribeExportTasks. + // next response of DescribeExportTasks . Marker *string // Metadata pertaining to the operation's result. @@ -165,8 +153,8 @@ func (c *Client) addOperationDescribeExportTasksMiddlewares(stack *middleware.St return nil } -// DescribeExportTasksAPIClient is a client that implements the DescribeExportTasks -// operation. +// DescribeExportTasksAPIClient is a client that implements the +// DescribeExportTasks operation. type DescribeExportTasksAPIClient interface { DescribeExportTasks(context.Context, *DescribeExportTasksInput, ...func(*Options)) (*DescribeExportTasksOutput, error) } diff --git a/service/rds/api_op_DescribeGlobalClusters.go b/service/rds/api_op_DescribeGlobalClusters.go index a4ec41c4bab..56f4e53e68d 100644 --- a/service/rds/api_op_DescribeGlobalClusters.go +++ b/service/rds/api_op_DescribeGlobalClusters.go @@ -13,8 +13,7 @@ import ( ) // Returns information about Aurora global database clusters. This API supports -// pagination. For more information on Amazon Aurora, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// pagination. For more information on Amazon Aurora, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlobalClustersInput, optFns ...func(*Options)) (*DescribeGlobalClustersOutput, error) { if params == nil { @@ -39,14 +38,12 @@ type DescribeGlobalClustersInput struct { // The user-supplied DB cluster identifier. If this parameter is specified, // information from only the specific DB cluster is returned. This parameter isn't // case-sensitive. Constraints: - // - // * If supplied, must match an existing - // DBClusterIdentifier. + // - If supplied, must match an existing DBClusterIdentifier. GlobalClusterIdentifier *string // An optional pagination token provided by a previous DescribeGlobalClusters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -65,7 +62,7 @@ type DescribeGlobalClustersOutput struct { // An optional pagination token provided by a previous DescribeGlobalClusters // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeOptionGroupOptions.go b/service/rds/api_op_DescribeOptionGroupOptions.go index 50bb0bfa7af..361343d7699 100644 --- a/service/rds/api_op_DescribeOptionGroupOptions.go +++ b/service/rds/api_op_DescribeOptionGroupOptions.go @@ -30,32 +30,19 @@ func (c *Client) DescribeOptionGroupOptions(ctx context.Context, params *Describ type DescribeOptionGroupOptionsInput struct { - // A required parameter. Options available for the given engine name are described. - // Valid Values: - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * oracle-ee-cdb - // - // * oracle-se2 - // - // * - // oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * sqlserver-se - // - // * sqlserver-ex - // - // * - // sqlserver-web + // A required parameter. Options available for the given engine name are + // described. Valid Values: + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web // // This member is required. EngineName *string @@ -69,7 +56,7 @@ type DescribeOptionGroupOptionsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -85,7 +72,7 @@ type DescribeOptionGroupOptionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // List of available option group options. diff --git a/service/rds/api_op_DescribeOptionGroups.go b/service/rds/api_op_DescribeOptionGroups.go index e0f49927b2e..cbd91cf4000 100644 --- a/service/rds/api_op_DescribeOptionGroups.go +++ b/service/rds/api_op_DescribeOptionGroups.go @@ -32,30 +32,17 @@ type DescribeOptionGroupsInput struct { // Filters the list of option groups to only include groups associated with a // specific database engine. Valid Values: - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * - // oracle-ee-cdb - // - // * oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * - // sqlserver-se - // - // * sqlserver-ex - // - // * sqlserver-web + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web EngineName *string // This parameter isn't currently supported. @@ -68,7 +55,7 @@ type DescribeOptionGroupsInput struct { // An optional pagination token provided by a previous DescribeOptionGroups // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -89,7 +76,7 @@ type DescribeOptionGroupsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // List of option groups. diff --git a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go index c888d2a5f66..e71ec5da5b0 100644 --- a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go @@ -32,44 +32,27 @@ func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params type DescribeOrderableDBInstanceOptionsInput struct { // The name of the engine to retrieve DB instance options for. Valid Values: - // - // * - // aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) - // - // * - // aurora-postgresql - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * oracle-ee-cdb - // - // * - // oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * sqlserver-se - // - // * - // sqlserver-ex - // - // * sqlserver-web + // - aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora) + // - aurora-postgresql + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web // // This member is required. Engine *string - // The Availability Zone group associated with a Local Zone. Specify this parameter - // to retrieve available offerings for the Local Zones in the group. Omit this - // parameter to show the available offerings in the specified Amazon Web Services - // Region. This setting doesn't apply to RDS Custom. + // The Availability Zone group associated with a Local Zone. Specify this + // parameter to retrieve available offerings for the Local Zones in the group. Omit + // this parameter to show the available offerings in the specified Amazon Web + // Services Region. This setting doesn't apply to RDS Custom. AvailabilityZoneGroup *string // The DB instance class filter value. Specify this parameter to show only the @@ -91,7 +74,7 @@ type DescribeOrderableDBInstanceOptionsInput struct { // An optional pagination token provided by a previous // DescribeOrderableDBInstanceOptions request. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by - // MaxRecords. + // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -100,9 +83,9 @@ type DescribeOrderableDBInstanceOptionsInput struct { // Default: 100 Constraints: Minimum 20, maximum 10000. MaxRecords *int32 - // A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom - // supports only VPC offerings. RDS Custom supports only VPC offerings. If you - // describe non-VPC offerings for RDS Custom, the output shows VPC offerings. + // A value that indicates whether to show only VPC or non-VPC offerings. RDS + // Custom supports only VPC offerings. RDS Custom supports only VPC offerings. If + // you describe non-VPC offerings for RDS Custom, the output shows VPC offerings. Vpc *bool noSmithyDocumentSerde @@ -114,7 +97,7 @@ type DescribeOrderableDBInstanceOptionsOutput struct { // An optional pagination token provided by a previous OrderableDBInstanceOptions // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // An OrderableDBInstanceOption structure containing information about orderable diff --git a/service/rds/api_op_DescribePendingMaintenanceActions.go b/service/rds/api_op_DescribePendingMaintenanceActions.go index e48bf3996d6..18f7f30a18e 100644 --- a/service/rds/api_op_DescribePendingMaintenanceActions.go +++ b/service/rds/api_op_DescribePendingMaintenanceActions.go @@ -33,21 +33,18 @@ type DescribePendingMaintenanceActionsInput struct { // A filter that specifies one or more resources to return pending maintenance // actions for. Supported filters: - // - // * db-cluster-id - Accepts DB cluster - // identifiers and DB cluster Amazon Resource Names (ARNs). The results list only - // includes pending maintenance actions for the DB clusters identified by these - // ARNs. - // - // * db-instance-id - Accepts DB instance identifiers and DB instance ARNs. - // The results list only includes pending maintenance actions for the DB instances - // identified by these ARNs. + // - db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon + // Resource Names (ARNs). The results list only includes pending maintenance + // actions for the DB clusters identified by these ARNs. + // - db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The + // results list only includes pending maintenance actions for the DB instances + // identified by these ARNs. Filters []types.Filter // An optional pagination token provided by a previous // DescribePendingMaintenanceActions request. If this parameter is specified, the // response includes only records beyond the marker, up to a number of records - // specified by MaxRecords. + // specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -68,7 +65,7 @@ type DescribePendingMaintenanceActionsOutput struct { // An optional pagination token provided by a previous // DescribePendingMaintenanceActions request. If this parameter is specified, the // response includes only records beyond the marker, up to a number of records - // specified by MaxRecords. + // specified by MaxRecords . Marker *string // A list of the pending maintenance actions for the resource. diff --git a/service/rds/api_op_DescribeReservedDBInstances.go b/service/rds/api_op_DescribeReservedDBInstances.go index 655ea1fafca..e0e52d4baa0 100644 --- a/service/rds/api_op_DescribeReservedDBInstances.go +++ b/service/rds/api_op_DescribeReservedDBInstances.go @@ -35,9 +35,9 @@ type DescribeReservedDBInstancesInput struct { // reservations matching the specified DB instances class. DBInstanceClass *string - // The duration filter value, specified in years or seconds. Specify this parameter - // to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | - // 94608000 + // The duration filter value, specified in years or seconds. Specify this + // parameter to show only reservations for this duration. Valid Values: 1 | 3 | + // 31536000 | 94608000 Duration *string // This parameter isn't currently supported. @@ -50,7 +50,7 @@ type DescribeReservedDBInstancesInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more than the @@ -64,16 +64,16 @@ type DescribeReservedDBInstancesInput struct { MultiAZ *bool // The offering type filter value. Specify this parameter to show only the - // available offerings matching the specified offering type. Valid Values: "Partial - // Upfront" | "All Upfront" | "No Upfront" + // available offerings matching the specified offering type. Valid Values: + // "Partial Upfront" | "All Upfront" | "No Upfront" OfferingType *string // The product description filter value. Specify this parameter to show only those // reservations matching the specified product description. ProductDescription *string - // The reserved DB instance identifier filter value. Specify this parameter to show - // only the reservation that matches the specified reservation ID. + // The reserved DB instance identifier filter value. Specify this parameter to + // show only the reservation that matches the specified reservation ID. ReservedDBInstanceId *string // The offering identifier filter value. Specify this parameter to show only @@ -89,7 +89,7 @@ type DescribeReservedDBInstancesOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A list of reserved DB instances. diff --git a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go index 311bea8e35b..bc7e29d8bb8 100644 --- a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go +++ b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go @@ -44,7 +44,7 @@ type DescribeReservedDBInstancesOfferingsInput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more than the @@ -58,8 +58,8 @@ type DescribeReservedDBInstancesOfferingsInput struct { MultiAZ *bool // The offering type filter value. Specify this parameter to show only the - // available offerings matching the specified offering type. Valid Values: "Partial - // Upfront" | "All Upfront" | "No Upfront" + // available offerings matching the specified offering type. Valid Values: + // "Partial Upfront" | "All Upfront" | "No Upfront" OfferingType *string // Product description filter value. Specify this parameter to show only the @@ -81,7 +81,7 @@ type DescribeReservedDBInstancesOfferingsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A list of reserved DB instance offerings. diff --git a/service/rds/api_op_DescribeSourceRegions.go b/service/rds/api_op_DescribeSourceRegions.go index be3c7700a3f..a4c12074d58 100644 --- a/service/rds/api_op_DescribeSourceRegions.go +++ b/service/rds/api_op_DescribeSourceRegions.go @@ -18,8 +18,7 @@ import ( // cross-Region features are supported between other Regions and your current // Region. This operation supports pagination. To return information about the // Regions that are enabled for your account, or all Regions, use the EC2 operation -// DescribeRegions. For more information, see DescribeRegions -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html) +// DescribeRegions . For more information, see DescribeRegions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html) // in the Amazon EC2 API Reference. func (c *Client) DescribeSourceRegions(ctx context.Context, params *DescribeSourceRegionsInput, optFns ...func(*Options)) (*DescribeSourceRegionsOutput, error) { if params == nil { @@ -43,7 +42,7 @@ type DescribeSourceRegionsInput struct { // An optional pagination token provided by a previous DescribeSourceRegions // request. If this parameter is specified, the response includes only records - // beyond the marker, up to the value specified by MaxRecords. + // beyond the marker, up to the value specified by MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist @@ -52,10 +51,9 @@ type DescribeSourceRegionsInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // The source Amazon Web Services Region name. For example, us-east-1. + // The source Amazon Web Services Region name. For example, us-east-1 . // Constraints: - // - // * Must specify a valid Amazon Web Services Region name. + // - Must specify a valid Amazon Web Services Region name. RegionName *string noSmithyDocumentSerde @@ -67,7 +65,7 @@ type DescribeSourceRegionsOutput struct { // An optional pagination token provided by a previous request. If this parameter // is specified, the response includes only records beyond the marker, up to the - // value specified by MaxRecords. + // value specified by MaxRecords . Marker *string // A list of SourceRegion instances that contains each source Amazon Web Services diff --git a/service/rds/api_op_DescribeValidDBInstanceModifications.go b/service/rds/api_op_DescribeValidDBInstanceModifications.go index 16cd3354614..886a3e3c94c 100644 --- a/service/rds/api_op_DescribeValidDBInstanceModifications.go +++ b/service/rds/api_op_DescribeValidDBInstanceModifications.go @@ -13,7 +13,7 @@ import ( // You can call DescribeValidDBInstanceModifications to learn what modifications // you can make to your DB instance. You can use this information when you call -// ModifyDBInstance. This command doesn't apply to RDS Custom. +// ModifyDBInstance . This command doesn't apply to RDS Custom. func (c *Client) DescribeValidDBInstanceModifications(ctx context.Context, params *DescribeValidDBInstanceModificationsInput, optFns ...func(*Options)) (*DescribeValidDBInstanceModificationsOutput, error) { if params == nil { params = &DescribeValidDBInstanceModificationsInput{} @@ -44,7 +44,7 @@ type DescribeValidDBInstanceModificationsOutput struct { // Information about valid modifications that you can make to your DB instance. // Contains the result of a successful call to the // DescribeValidDBInstanceModifications action. You can use this information when - // you call ModifyDBInstance. + // you call ModifyDBInstance . ValidDBInstanceModificationsMessage *types.ValidDBInstanceModificationsMessage // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DownloadDBLogFilePortion.go b/service/rds/api_op_DownloadDBLogFilePortion.go index 44feb8e8767..dcd643c1385 100644 --- a/service/rds/api_op_DownloadDBLogFilePortion.go +++ b/service/rds/api_op_DownloadDBLogFilePortion.go @@ -32,9 +32,7 @@ type DownloadDBLogFilePortionInput struct { // The customer-assigned name of the DB instance that contains the log files you // want to list. Constraints: - // - // * Must match the identifier of an existing - // DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string @@ -54,30 +52,24 @@ type DownloadDBLogFilePortionInput struct { // NumberOfLines parameter is specified, then the block of lines returned can be // from the beginning or the end of the log file, depending on the value of the // Marker parameter. - // - // * If neither Marker or NumberOfLines are specified, the - // entire log file is returned up to a maximum of 10000 lines, starting with the - // most recent log entries first. - // - // * If NumberOfLines is specified and Marker isn't - // specified, then the most recent lines from the end of the log file are - // returned. - // - // * If Marker is specified as "0", then the specified number of lines - // from the beginning of the log file are returned. - // - // * You can download the log - // file in blocks of lines by specifying the size of the block using the - // NumberOfLines parameter, and by specifying a value of "0" for the Marker - // parameter in your first request. Include the Marker value returned in the - // response as the Marker value for the next request, continuing until the - // AdditionalDataPending response element returns false. + // - If neither Marker or NumberOfLines are specified, the entire log file is + // returned up to a maximum of 10000 lines, starting with the most recent log + // entries first. + // - If NumberOfLines is specified and Marker isn't specified, then the most + // recent lines from the end of the log file are returned. + // - If Marker is specified as "0", then the specified number of lines from the + // beginning of the log file are returned. + // - You can download the log file in blocks of lines by specifying the size of + // the block using the NumberOfLines parameter, and by specifying a value of "0" + // for the Marker parameter in your first request. Include the Marker value + // returned in the response as the Marker value for the next request, continuing + // until the AdditionalDataPending response element returns false. NumberOfLines int32 noSmithyDocumentSerde } -// This data type is used as a response element to DownloadDBLogFilePortion. +// This data type is used as a response element to DownloadDBLogFilePortion . type DownloadDBLogFilePortionOutput struct { // Boolean value that if true, indicates there is more data to be downloaded. @@ -174,24 +166,18 @@ type DownloadDBLogFilePortionPaginatorOptions struct { // NumberOfLines parameter is specified, then the block of lines returned can be // from the beginning or the end of the log file, depending on the value of the // Marker parameter. - // - // * If neither Marker or NumberOfLines are specified, the - // entire log file is returned up to a maximum of 10000 lines, starting with the - // most recent log entries first. - // - // * If NumberOfLines is specified and Marker isn't - // specified, then the most recent lines from the end of the log file are - // returned. - // - // * If Marker is specified as "0", then the specified number of lines - // from the beginning of the log file are returned. - // - // * You can download the log - // file in blocks of lines by specifying the size of the block using the - // NumberOfLines parameter, and by specifying a value of "0" for the Marker - // parameter in your first request. Include the Marker value returned in the - // response as the Marker value for the next request, continuing until the - // AdditionalDataPending response element returns false. + // - If neither Marker or NumberOfLines are specified, the entire log file is + // returned up to a maximum of 10000 lines, starting with the most recent log + // entries first. + // - If NumberOfLines is specified and Marker isn't specified, then the most + // recent lines from the end of the log file are returned. + // - If Marker is specified as "0", then the specified number of lines from the + // beginning of the log file are returned. + // - You can download the log file in blocks of lines by specifying the size of + // the block using the NumberOfLines parameter, and by specifying a value of "0" + // for the Marker parameter in your first request. Include the Marker value + // returned in the response as the Marker value for the next request, continuing + // until the AdditionalDataPending response element returns false. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_FailoverDBCluster.go b/service/rds/api_op_FailoverDBCluster.go index 8bdb1dbd3c3..012a3759ec5 100644 --- a/service/rds/api_op_FailoverDBCluster.go +++ b/service/rds/api_op_FailoverDBCluster.go @@ -23,11 +23,9 @@ import ( // testing, you can force a failover. Because each instance in a DB cluster has its // own endpoint address, make sure to clean up and re-establish any existing // connections that use those endpoint addresses when the failover is complete. For -// more information on Amazon Aurora DB clusters, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// more information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error) { if params == nil { @@ -48,16 +46,14 @@ type FailoverDBClusterInput struct { // A DB cluster identifier to force a failover for. This parameter isn't // case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // DBCluster. + // - Must match the identifier of an existing DBCluster. // // This member is required. DBClusterIdentifier *string // The name of the DB instance to promote to the primary DB instance. Specify the // DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in - // the DB cluster, for example mydbcluster-replica1. This setting isn't supported + // the DB cluster, for example mydbcluster-replica1 . This setting isn't supported // for RDS for MySQL Multi-AZ DB clusters. TargetDBInstanceIdentifier *string @@ -68,19 +64,17 @@ type FailoverDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_FailoverGlobalCluster.go b/service/rds/api_op_FailoverGlobalCluster.go index daa438ffd41..78b71d7b5ed 100644 --- a/service/rds/api_op_FailoverGlobalCluster.go +++ b/service/rds/api_op_FailoverGlobalCluster.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates the failover process for an Aurora global database (GlobalCluster). A -// failover for an Aurora global database promotes one of secondary read-only DB +// Initiates the failover process for an Aurora global database ( GlobalCluster ). +// A failover for an Aurora global database promotes one of secondary read-only DB // clusters to be the primary DB cluster and demotes the primary DB cluster to // being a secondary (read-only) DB cluster. In other words, the role of the // current primary DB cluster and the selected (target) DB cluster are switched. // The selected secondary DB cluster assumes full read/write capabilities for the // Aurora global database. For more information about failing over an Amazon Aurora -// global database, see Managed planned failover for Amazon Aurora global databases -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover) +// global database, see Managed planned failover for Amazon Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover) // in the Amazon Aurora User Guide. This action applies to GlobalCluster (Aurora // global databases) only. Use this action only on healthy Aurora global databases // with running Aurora DB clusters and no Region-wide outages, to test disaster @@ -41,21 +40,20 @@ func (c *Client) FailoverGlobalCluster(ctx context.Context, params *FailoverGlob type FailoverGlobalClusterInput struct { - // Identifier of the Aurora global database (GlobalCluster) that should be failed + // Identifier of the Aurora global database ( GlobalCluster ) that should be failed // over. The identifier is the unique key assigned by the user when the Aurora // global database was created. In other words, it's the name of the Aurora global // database that you want to fail over. Constraints: - // - // * Must match the identifier - // of an existing GlobalCluster (Aurora global database). + // - Must match the identifier of an existing GlobalCluster (Aurora global + // database). // // This member is required. GlobalClusterIdentifier *string // Identifier of the secondary Aurora DB cluster that you want to promote to - // primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource - // Name (ARN) for the identifier so that Aurora can locate the cluster in its - // Amazon Web Services Region. + // primary for the Aurora global database ( GlobalCluster .) Use the Amazon + // Resource Name (ARN) for the identifier so that Aurora can locate the cluster in + // its Amazon Web Services Region. // // This member is required. TargetDbClusterIdentifier *string diff --git a/service/rds/api_op_ListTagsForResource.go b/service/rds/api_op_ListTagsForResource.go index d1c100b6558..794f2097b4a 100644 --- a/service/rds/api_op_ListTagsForResource.go +++ b/service/rds/api_op_ListTagsForResource.go @@ -12,8 +12,7 @@ import ( ) // Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon -// RDS resource, see Tagging Amazon RDS Resources -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) +// RDS resource, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) // in the Amazon RDS User Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -32,10 +31,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon RDS resource with tags to be listed. This value is an Amazon Resource - // Name (ARN). For information about creating an ARN, see Constructing an ARN for - // Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // The Amazon RDS resource with tags to be listed. This value is an Amazon + // Resource Name (ARN). For information about creating an ARN, see Constructing an + // ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) // in the Amazon RDS User Guide. // // This member is required. diff --git a/service/rds/api_op_ModifyActivityStream.go b/service/rds/api_op_ModifyActivityStream.go index 5fbe5ec6a67..9d5fd107d63 100644 --- a/service/rds/api_op_ModifyActivityStream.go +++ b/service/rds/api_op_ModifyActivityStream.go @@ -15,9 +15,8 @@ import ( // (default) or unlocked. A locked policy is read-only, whereas an unlocked policy // is read/write. If your activity stream is started and locked, you can unlock it, // customize your audit policy, and then lock your activity stream. Restarting the -// activity stream isn't required. For more information, see Modifying a database -// activity stream -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html) +// activity stream isn't required. For more information, see Modifying a database +// activity stream (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html) // in the Amazon RDS User Guide. This operation is supported for RDS for Oracle and // Microsoft SQL Server. func (c *Client) ModifyActivityStream(ctx context.Context, params *ModifyActivityStreamInput, optFns ...func(*Options)) (*ModifyActivityStreamOutput, error) { @@ -43,7 +42,7 @@ type ModifyActivityStreamInput struct { AuditPolicyState types.AuditPolicyState // The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB - // instance. For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db. + // instance. For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db . ResourceArn *string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyCertificates.go b/service/rds/api_op_ModifyCertificates.go index 693b81df262..df795d5c6e7 100644 --- a/service/rds/api_op_ModifyCertificates.go +++ b/service/rds/api_op_ModifyCertificates.go @@ -18,24 +18,18 @@ import ( // provided by RDS. You can also use this operation to remove the override, so that // new DB instances use the default certificate provided by RDS. You might need to // override the default certificate in the following situations: +// - You already migrated your applications to support the latest certificate +// authority (CA) certificate, but the new CA certificate is not yet the RDS +// default CA certificate for the specified Amazon Web Services Region. +// - RDS has already moved to a new default CA certificate for the specified +// Amazon Web Services Region, but you are still in the process of supporting the +// new CA certificate. In this case, you temporarily need additional time to finish +// your application changes. // -// * You already -// migrated your applications to support the latest certificate authority (CA) -// certificate, but the new CA certificate is not yet the RDS default CA -// certificate for the specified Amazon Web Services Region. -// -// * RDS has already -// moved to a new default CA certificate for the specified Amazon Web Services -// Region, but you are still in the process of supporting the new CA certificate. -// In this case, you temporarily need additional time to finish your application -// changes. -// -// For more information about rotating your SSL/TLS certificate for RDS -// DB engines, see Rotating Your SSL/TLS Certificate -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) +// For more information about rotating your SSL/TLS certificate for RDS DB +// engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) // in the Amazon RDS User Guide. For more information about rotating your SSL/TLS -// certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) +// certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) // in the Amazon Aurora User Guide. func (c *Client) ModifyCertificates(ctx context.Context, params *ModifyCertificatesInput, optFns ...func(*Options)) (*ModifyCertificatesOutput, error) { if params == nil { @@ -70,11 +64,9 @@ type ModifyCertificatesInput struct { type ModifyCertificatesOutput struct { // A CA certificate for an Amazon Web Services account. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. Certificate *types.Certificate diff --git a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go index bd56553c3b1..4105cdd300b 100644 --- a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go +++ b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go @@ -18,13 +18,11 @@ import ( // sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the // DB cluster based on the cooldown period for scaling up and the cooldown period // for scaling down. For more information about Aurora Serverless v1, see Using -// Amazon Aurora Serverless v1 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) -// in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with -// the default TimeoutAction, connections that prevent Aurora Serverless v1 from -// finding a scaling point might be dropped. For more information about scaling -// points, see Autoscaling for Aurora Serverless v1 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) +// Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) +// in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity +// with the default TimeoutAction , connections that prevent Aurora Serverless v1 +// from finding a scaling point might be dropped. For more information about +// scaling points, see Autoscaling for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) // in the Amazon Aurora User Guide. This action only applies to Aurora Serverless // v1 DB clusters. func (c *Client) ModifyCurrentDBClusterCapacity(ctx context.Context, params *ModifyCurrentDBClusterCapacityInput, optFns ...func(*Options)) (*ModifyCurrentDBClusterCapacityOutput, error) { @@ -46,21 +44,17 @@ type ModifyCurrentDBClusterCapacityInput struct { // The DB cluster identifier for the cluster being modified. This parameter isn't // case-sensitive. Constraints: - // - // * Must match the identifier of an existing DB - // cluster. + // - Must match the identifier of an existing DB cluster. // // This member is required. DBClusterIdentifier *string // The DB cluster capacity. When you change the capacity of a paused Aurora // Serverless v1 DB cluster, it automatically resumes. Constraints: - // - // * For Aurora - // MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - // - // * For - // Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. + // - For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , + // 128 , and 256 . + // - For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , + // 192 , and 384 . Capacity *int32 // The amount of time, in seconds, that Aurora Serverless v1 tries to find a @@ -69,7 +63,7 @@ type ModifyCurrentDBClusterCapacityInput struct { SecondsBeforeTimeout *int32 // The action to take when the timeout is reached, either ForceApplyCapacityChange - // or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the + // or RollbackCapacityChange . ForceApplyCapacityChange , the default, sets the // capacity to the specified value as soon as possible. RollbackCapacityChange // ignores the capacity change if a scaling point isn't found in the timeout // period. @@ -93,8 +87,8 @@ type ModifyCurrentDBClusterCapacityOutput struct { // The number of seconds before a call to ModifyCurrentDBClusterCapacity times out. SecondsBeforeTimeout *int32 - // The timeout action of a call to ModifyCurrentDBClusterCapacity, either - // ForceApplyCapacityChange or RollbackCapacityChange. + // The timeout action of a call to ModifyCurrentDBClusterCapacity , either + // ForceApplyCapacityChange or RollbackCapacityChange . TimeoutAction *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyCustomDBEngineVersion.go b/service/rds/api_op_ModifyCustomDBEngineVersion.go index 630d3b84004..91104e0e2ed 100644 --- a/service/rds/api_op_ModifyCustomDBEngineVersion.go +++ b/service/rds/api_op_ModifyCustomDBEngineVersion.go @@ -13,14 +13,13 @@ import ( ) // Modifies the status of a custom engine version (CEV). You can find CEVs to -// modify by calling DescribeDBEngineVersions. The MediaImport service that imports -// files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services -// CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to -// the ModifyCustomDbEngineVersion event aren't logged. However, you might see -// calls from the API gateway that accesses your Amazon S3 bucket. These calls -// originate from the MediaImport service for the ModifyCustomDbEngineVersion -// event. For more information, see Modifying CEV status -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify) +// modify by calling DescribeDBEngineVersions . The MediaImport service that +// imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web +// Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, +// calls to the ModifyCustomDbEngineVersion event aren't logged. However, you +// might see calls from the API gateway that accesses your Amazon S3 bucket. These +// calls originate from the MediaImport service for the ModifyCustomDbEngineVersion +// event. For more information, see Modifying CEV status (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify) // in the Amazon RDS User Guide. func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *ModifyCustomDBEngineVersionInput, optFns ...func(*Options)) (*ModifyCustomDBEngineVersionOutput, error) { if params == nil { @@ -40,14 +39,15 @@ func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *Modify type ModifyCustomDBEngineVersionInput struct { // The DB engine. The only supported values are custom-oracle-ee and - // custom-oracle-ee-cdb. + // custom-oracle-ee-cdb . // // This member is required. Engine *string - // The custom engine version (CEV) that you want to modify. This option is required - // for RDS Custom for Oracle, but optional for Amazon RDS. The combination of - // Engine and EngineVersion is unique per customer per Amazon Web Services Region. + // The custom engine version (CEV) that you want to modify. This option is + // required for RDS Custom for Oracle, but optional for Amazon RDS. The combination + // of Engine and EngineVersion is unique per customer per Amazon Web Services + // Region. // // This member is required. EngineVersion *string @@ -61,9 +61,9 @@ type ModifyCustomDBEngineVersionInput struct { // CEV. You can't patch or create new instances with this CEV. You can change any // status to any status. A typical reason to change status is to prevent the // accidental use of a CEV, or to make a deprecated CEV eligible for use again. For - // example, you might change the status of your CEV from available to inactive, and - // from inactive back to available. To change the availability status of the CEV, - // it must not currently be in use by an RDS Custom instance, snapshot, or + // example, you might change the status of your CEV from available to inactive , + // and from inactive back to available . To change the availability status of the + // CEV, it must not currently be in use by an RDS Custom instance, snapshot, or // automated backup. Status types.CustomEngineVersionStatus @@ -71,7 +71,7 @@ type ModifyCustomDBEngineVersionInput struct { } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type ModifyCustomDBEngineVersionOutput struct { // The creation time of the DB engine version. @@ -81,8 +81,7 @@ type ModifyCustomDBEngineVersionOutput struct { // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. - // For more information, see JSON fields in the CEV manifest - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) + // For more information, see JSON fields in the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) // in the Amazon RDS User Guide. CustomDBEngineVersionManifest *string @@ -133,15 +132,13 @@ type ModifyCustomDBEngineVersionOutput struct { // The major engine version of the CEV. MajorEngineVersion *string - // The status of the DB engine version, either available or deprecated. + // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. SupportedCACertificateIdentifiers []string @@ -152,13 +149,13 @@ type ModifyCustomDBEngineVersionOutput struct { // A list of the supported DB engine modes. SupportedEngineModes []string - // A list of features supported by the DB engine. The supported features vary by DB - // engine and DB engine version. To determine the supported features for a specific - // DB engine and DB engine version using the CLI, use the following command: aws - // rds describe-db-engine-versions --engine --engine-version For example, to - // determine the supported features for RDS for PostgreSQL version 13.3 using the - // CLI, use the following command: aws rds describe-db-engine-versions --engine - // postgres --engine-version 13.3 The supported features are listed under + // A list of features supported by the DB engine. The supported features vary by + // DB engine and DB engine version. To determine the supported features for a + // specific DB engine and DB engine version using the CLI, use the following + // command: aws rds describe-db-engine-versions --engine --engine-version For + // example, to determine the supported features for RDS for PostgreSQL version 13.3 + // using the CLI, use the following command: aws rds describe-db-engine-versions + // --engine postgres --engine-version 13.3 The supported features are listed under // SupportedFeatureNames in the output. SupportedFeatureNames []string @@ -186,16 +183,15 @@ type ModifyCustomDBEngineVersionOutput struct { // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs bool - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // A value that indicates whether you can use Aurora parallel query with a + // specific DB engine version. SupportsParallelQuery bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []types.Tag // A list of engine versions that this database engine version can be upgraded to. diff --git a/service/rds/api_op_ModifyDBCluster.go b/service/rds/api_op_ModifyDBCluster.go index f7863ba7ac7..bfff5b7f0b9 100644 --- a/service/rds/api_op_ModifyDBCluster.go +++ b/service/rds/api_op_ModifyDBCluster.go @@ -14,11 +14,9 @@ import ( // Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. // You can change one or more settings by specifying these parameters and the new // values in the request. For more information on Amazon Aurora DB clusters, see -// What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error) { if params == nil { @@ -54,10 +52,10 @@ type ModifyDBClusterInput struct { // current version. Valid for: Aurora DB clusters only AllowMajorVersionUpgrade bool - // A value that indicates whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the DB cluster. If this parameter is - // disabled, changes to the DB cluster are applied during the next maintenance + // A value that indicates whether the modifications in this request and any + // pending modifications are asynchronously applied as soon as possible, regardless + // of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter + // is disabled, changes to the DB cluster are applied during the next maintenance // window. Most modifications can be applied immediately or during the next // scheduled maintenance window. Some modifications, such as turning on deletion // protection and changing the master password, are applied immediately—regardless @@ -70,55 +68,47 @@ type ModifyDBClusterInput struct { // upgrades are applied automatically. Valid for: Multi-AZ DB clusters only AutoMinorVersionUpgrade *bool - // The target backtrack window, in seconds. To disable backtracking, set this value - // to 0. Default: 0 Constraints: - // - // * If specified, this value must be set to a - // number from 0 to 259,200 (72 hours). - // + // The target backtrack window, in seconds. To disable backtracking, set this + // value to 0. Default: 0 Constraints: + // - If specified, this value must be set to a number from 0 to 259,200 (72 + // hours). // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 // The number of days for which automated backups are retained. Specify a minimum // value of 1. Default: 1 Constraints: - // - // * Must be a value from 1 to 35 - // - // Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // - Must be a value from 1 to 35 + // Valid for: Aurora DB clusters and Multi-AZ DB clusters BackupRetentionPeriod *int32 // The configuration setting for the log types to be enabled for export to // CloudWatch Logs for a specific DB cluster. The values in the list depend on the - // DB engine being used. RDS for MySQL Possible values are error, general, and - // slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora - // MySQL Possible values are audit, error, general, and slowquery. Aurora - // PostgreSQL Possible value is postgresql. For more information about exporting - // CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon - // CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // DB engine being used. RDS for MySQL Possible values are error , general , and + // slowquery . RDS for PostgreSQL Possible values are postgresql and upgrade . + // Aurora MySQL Possible values are audit , error , general , and slowquery . + // Aurora PostgreSQL Possible value is postgresql . For more information about + // exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to + // Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. For more information about exporting CloudWatch - // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // A value that indicates whether to copy all tags from the DB cluster to + // snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora + // DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool // The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, // for example db.m6gd.xlarge. Not all DB instance classes are available in all // Amazon Web Services Regions, or for all database engines. For the full list of - // DB instance classes and availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // DB instance classes and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only DBClusterInstanceClass *string - // The name of the DB cluster parameter group to use for the DB cluster. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // The name of the DB cluster parameter group to use for the DB cluster. Valid + // for: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string // The name of the DB parameter group to apply to all instances of the DB cluster. @@ -126,16 +116,11 @@ type ModifyDBClusterInput struct { // parameter, the DB cluster isn't rebooted automatically. Also, parameter changes // are applied immediately rather than during the next maintenance window. Default: // The existing name setting Constraints: - // - // * The DB parameter group must be in the - // same DB parameter group family as this DB cluster. - // - // * The - // DBInstanceParameterGroupName parameter is valid in combination with the - // AllowMajorVersionUpgrade parameter for a major version upgrade only. - // - // Valid for: - // Aurora DB clusters only + // - The DB parameter group must be in the same DB parameter group family as + // this DB cluster. + // - The DBInstanceParameterGroupName parameter is valid in combination with the + // AllowMajorVersionUpgrade parameter for a major version upgrade only. + // Valid for: Aurora DB clusters only DBInstanceParameterGroupName *string // A value that indicates whether the DB cluster has deletion protection enabled. @@ -146,8 +131,7 @@ type ModifyDBClusterInput struct { // The Active Directory directory ID to move the DB cluster to. Specify none to // remove the cluster from its current domain. The domain must be created prior to - // this operation. For more information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) + // this operation. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only Domain *string @@ -156,8 +140,8 @@ type ModifyDBClusterInput struct { DomainIAMRoleName *string // A value that indicates whether to enable this DB cluster to forward write - // operations to the primary cluster of an Aurora global database (GlobalCluster). - // By default, write operations are not allowed on Aurora DB clusters that are + // operations to the primary cluster of an Aurora global database ( GlobalCluster + // ). By default, write operations are not allowed on Aurora DB clusters that are // secondary clusters in an Aurora global database. You can set this value only on // Aurora DB clusters that are members of an Aurora global database. With this // parameter enabled, a secondary cluster can forward writes to the current primary @@ -172,27 +156,24 @@ type ModifyDBClusterInput struct { // enabled, the HTTP endpoint provides a connectionless web service API for running // SQL queries on the Aurora Serverless v1 DB cluster. You can also query your // database from inside the RDS console with the query editor. For more - // information, see Using the Data API for Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in - // the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableHttpEndpoint *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool // A value that indicates whether to turn on Performance Insights for the DB - // cluster. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // cluster. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only EnablePerformanceInsights *bool - // The version number of the database engine to which you want to upgrade. Changing - // this parameter results in an outage. The change is applied during the next - // maintenance window unless ApplyImmediately is enabled. If the cluster that + // The version number of the database engine to which you want to upgrade. + // Changing this parameter results in an outage. The change is applied during the + // next maintenance window unless ApplyImmediately is enabled. If the cluster that // you're modifying has one or more read replicas, all replicas must be running an // engine version that's the same or later than the version you specify. To list // all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) @@ -216,8 +197,7 @@ type ModifyDBClusterInput struct { // The amount of Provisioned IOPS (input/output operations per second) to be // initially allocated for each DB instance in the Multi-AZ DB cluster. For - // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 // of the storage amount for the DB cluster. Valid for: Multi-AZ DB clusters only Iops *int32 @@ -225,57 +205,46 @@ type ModifyDBClusterInput struct { // A value that indicates whether to manage the master user password with Amazon // Web Services Secrets Manager. If the DB cluster doesn't manage the master user // password with Amazon Web Services Secrets Manager, you can turn on this - // management. In this case, you can't specify MasterUserPassword. If the DB + // management. In this case, you can't specify MasterUserPassword . If the DB // cluster already manages the master user password with Amazon Web Services // Secrets Manager, and you specify that the master user password is not managed // with Amazon Web Services Secrets Manager, then you must specify - // MasterUserPassword. In this case, RDS deletes the secret and uses the new - // password for the master user specified by MasterUserPassword. For more - // information, see Password management with Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // MasterUserPassword . In this case, RDS deletes the secret and uses the new + // password for the master user specified by MasterUserPassword . For more + // information, see Password management with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) + // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters ManageMasterUserPassword *bool // The new password for the master database user. This password can contain any // printable ASCII character except "/", """, or "@". Constraints: - // - // * Must contain - // from 8 to 41 characters. - // - // * Can't be specified if ManageMasterUserPassword is - // turned on. - // + // - Must contain from 8 to 41 characters. + // - Can't be specified if ManageMasterUserPassword is turned on. // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. This // setting is valid only if both of the following conditions are met: - // - // * The DB - // cluster doesn't manage the master user password in Amazon Web Services Secrets - // Manager. If the DB cluster already manages the master user password in Amazon - // Web Services Secrets Manager, you can't change the KMS key that is used to - // encrypt the secret. - // - // * You are turning on ManageMasterUserPassword to manage the - // master user password in Amazon Web Services Secrets Manager. If you are turning - // on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the - // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a - // different Amazon Web Services account, then you can't use the aws/secretsmanager - // KMS key to encrypt the secret, and you must use a customer managed KMS key. - // - // The - // Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or - // alias name for the KMS key. To use a KMS key in a different Amazon Web Services - // account, specify the key ARN or alias ARN. There is a default KMS key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default KMS key for each Amazon Web Services Region. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - The DB cluster doesn't manage the master user password in Amazon Web + // Services Secrets Manager. If the DB cluster already manages the master user + // password in Amazon Web Services Secrets Manager, you can't change the KMS key + // that is used to encrypt the secret. + // - You are turning on ManageMasterUserPassword to manage the master user + // password in Amazon Web Services Secrets Manager. If you are turning on + // ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId , then the + // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in + // a different Amazon Web Services account, then you can't use the + // aws/secretsmanager KMS key to encrypt the secret, and you must use a customer + // managed KMS key. + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. To use a KMS key in a different Amazon Web + // Services account, specify the key ARN or alias ARN. There is a default KMS key + // for your Amazon Web Services account. Your Amazon Web Services account has a + // different default KMS key for each Amazon Web Services Region. Valid for: Aurora + // DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string // The interval, in seconds, between points when Enhanced Monitoring metrics are @@ -287,40 +256,28 @@ type ModifyDBClusterInput struct { // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send // Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is - // arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring - // role, see To create an IAM role for Amazon RDS Enhanced Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only + // arn:aws:iam:123456789012:role/emaccess . For information on creating a + // monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only MonitoringRoleArn *string // The network type of the DB cluster. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only NetworkType *string // The new DB cluster identifier for the DB cluster when renaming a DB cluster. // This value is stored as a lowercase string. Constraints: - // - // * Must contain from 1 - // to 63 letters, numbers, or hyphens - // - // * The first character must be a letter - // - // * - // Can't end with a hyphen or contain two consecutive hyphens - // - // Example: my-cluster2 - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - The first character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // Example: my-cluster2 Valid for: Aurora DB clusters and Multi-AZ DB clusters NewDBClusterIdentifier *string // A value that indicates that the DB cluster should be associated with the @@ -331,61 +288,40 @@ type ModifyDBClusterInput struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you don't specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. - // Valid for: Multi-AZ DB clusters only + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. Valid for: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. Valid for: Multi-AZ DB clusters only + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. Valid for: Multi-AZ DB clusters only PerformanceInsightsRetentionPeriod *int32 // The port number on which the DB cluster accepts connections. Constraints: Value - // must be 1150-65535 Default: The same port as the original DB cluster. Valid for: - // Aurora DB clusters only + // must be 1150-65535 Default: The same port as the original DB cluster. Valid + // for: Aurora DB clusters only Port *int32 // The daily time range during which automated backups are created if automated - // backups are enabled, using the BackupRetentionPeriod parameter. The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. To view the time blocks available, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) + // backups are enabled, using the BackupRetentionPeriod parameter. The default is + // a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Web Services Region. To view the time blocks available, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) // in the Amazon Aurora User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 - // minutes. - // + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. // Valid for: Aurora DB clusters and Multi-AZ DB clusters PreferredBackupWindow *string @@ -393,8 +329,7 @@ type ModifyDBClusterInput struct { // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon // Web Services Region, occurring on a random day of the week. To see the time - // blocks available, see Adjusting the Preferred DB Cluster Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) + // blocks available, see Adjusting the Preferred DB Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) // in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and // Multi-AZ DB clusters @@ -404,28 +339,23 @@ type ModifyDBClusterInput struct { // Services Secrets Manager for the master user password. This setting is valid // only if the master user password is managed by RDS in Amazon Web Services // Secrets Manager for the DB cluster. The secret value contains the updated - // password. For more information, see Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // password. For more information, see Password management with Amazon Web + // Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) + // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. Constraints: - // - // * You must apply the change - // immediately when rotating the master user password. - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - You must apply the change immediately when rotating the master user + // password. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters RotateMasterUserPassword *bool - // The scaling properties of the DB cluster. You can only modify scaling properties - // for DB clusters in serverless DB engine mode. Valid for: Aurora DB clusters only + // The scaling properties of the DB cluster. You can only modify scaling + // properties for DB clusters in serverless DB engine mode. Valid for: Aurora DB + // clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For - // more information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration @@ -445,19 +375,17 @@ type ModifyDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_ModifyDBClusterEndpoint.go b/service/rds/api_op_ModifyDBClusterEndpoint.go index 44a684dce6e..74c8187fd39 100644 --- a/service/rds/api_op_ModifyDBClusterEndpoint.go +++ b/service/rds/api_op_ModifyDBClusterEndpoint.go @@ -35,7 +35,7 @@ type ModifyDBClusterEndpointInput struct { // This member is required. DBClusterEndpointIdentifier *string - // The type of the endpoint. One of: READER, WRITER, ANY. + // The type of the endpoint. One of: READER , WRITER , ANY . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -52,21 +52,16 @@ type ModifyDBClusterEndpointInput struct { // This data type represents the information you need to connect to an Amazon // Aurora DB cluster. This data type is used as a response element in the following // actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type ModifyDBClusterEndpointOutput struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -87,7 +82,7 @@ type ModifyDBClusterEndpointOutput struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -98,8 +93,8 @@ type ModifyDBClusterEndpointOutput struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that can't be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that can't be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string diff --git a/service/rds/api_op_ModifyDBClusterParameterGroup.go b/service/rds/api_op_ModifyDBClusterParameterGroup.go index 0e3ecd2810a..0f3088e431c 100644 --- a/service/rds/api_op_ModifyDBClusterParameterGroup.go +++ b/service/rds/api_op_ModifyDBClusterParameterGroup.go @@ -11,29 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group. To modify more than one -// parameter, submit a list of the following: ParameterName, ParameterValue, and -// ApplyMethod. A maximum of 20 parameters can be modified in a single request. -// After you create a DB cluster parameter group, you should wait at least 5 -// minutes before creating your first DB cluster that uses that DB cluster +// Modifies the parameters of a DB cluster parameter group. To modify more than +// one parameter, submit a list of the following: ParameterName , ParameterValue , +// and ApplyMethod . A maximum of 20 parameters can be modified in a single +// request. After you create a DB cluster parameter group, you should wait at least +// 5 minutes before creating your first DB cluster that uses that DB cluster // parameter group as the default parameter group. This allows Amazon RDS to fully // complete the create action before the parameter group is used as the default for // a new DB cluster. This is especially important for parameters that are critical // when creating the default database for a DB cluster, such as the character set // for the default database defined by the character_set_database parameter. You -// can use the Parameter Groups option of the Amazon RDS console -// (https://console.aws.amazon.com/rds/) or the DescribeDBClusterParameters -// operation to verify that your DB cluster parameter group has been created or -// modified. If the modified DB cluster parameter group is used by an Aurora -// Serverless v1 cluster, Aurora applies the update immediately. The cluster -// restart might interrupt your workload. In that case, your application must -// reopen any connections and retry any transactions that were active when the -// parameter changes took effect. For more information on Amazon Aurora DB -// clusters, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// can use the Parameter Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) +// or the DescribeDBClusterParameters operation to verify that your DB cluster +// parameter group has been created or modified. If the modified DB cluster +// parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the +// update immediately. The cluster restart might interrupt your workload. In that +// case, your application must reopen any connections and retry any transactions +// that were active when the parameter changes took effect. For more information on +// Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyDBClusterParameterGroupOutput, error) { if params == nil { @@ -61,9 +58,9 @@ type ModifyDBClusterParameterGroupInput struct { // (for the application method): immediate | pending-reboot You can use the // immediate value with dynamic parameters only. You can use the pending-reboot // value for both dynamic and static parameters. When the application method is - // immediate, changes to dynamic parameters are applied immediately to the DB + // immediate , changes to dynamic parameters are applied immediately to the DB // clusters associated with the parameter group. When the application method is - // pending-reboot, changes to dynamic and static parameters are applied after a + // pending-reboot , changes to dynamic and static parameters are applied after a // reboot without failover to the DB clusters associated with the parameter group. // // This member is required. @@ -75,17 +72,10 @@ type ModifyDBClusterParameterGroupInput struct { type ModifyDBClusterParameterGroupOutput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be 1 to 255 - // letters or numbers. - // - // * First character must be a letter - // - // * Can't end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go b/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go index 9e0e0b7df9c..a7d8eff7492 100644 --- a/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go @@ -17,14 +17,14 @@ import ( // ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts // that are authorized to restore the manual DB cluster snapshot. Use the value all // to make the manual DB cluster snapshot public, which means that it can be copied -// or restored by all Amazon Web Services accounts. Don't add the all value for any -// manual DB cluster snapshots that contain private information that you don't want -// available to all Amazon Web Services accounts. If a manual DB cluster snapshot -// is encrypted, it can be shared, but only by specifying a list of authorized -// Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all -// as a value for that parameter in this case. To view which Amazon Web Services -// accounts have access to copy or restore a manual DB cluster snapshot, or whether -// a manual DB cluster snapshot is public or private, use the +// or restored by all Amazon Web Services accounts. Don't add the all value for +// any manual DB cluster snapshots that contain private information that you don't +// want available to all Amazon Web Services accounts. If a manual DB cluster +// snapshot is encrypted, it can be shared, but only by specifying a list of +// authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You +// can't use all as a value for that parameter in this case. To view which Amazon +// Web Services accounts have access to copy or restore a manual DB cluster +// snapshot, or whether a manual DB cluster snapshot is public or private, use the // DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as // values for the restore attribute. func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBClusterSnapshotAttributeOutput, error) { @@ -44,10 +44,10 @@ func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *M type ModifyDBClusterSnapshotAttributeInput struct { - // The name of the DB cluster snapshot attribute to modify. To manage authorization - // for other Amazon Web Services accounts to copy or restore a manual DB cluster - // snapshot, set this value to restore. To view the list of attributes available to - // modify, use the DescribeDBClusterSnapshotAttributes API operation. + // The name of the DB cluster snapshot attribute to modify. To manage + // authorization for other Amazon Web Services accounts to copy or restore a manual + // DB cluster snapshot, set this value to restore . To view the list of attributes + // available to modify, use the DescribeDBClusterSnapshotAttributes API operation. // // This member is required. AttributeName *string @@ -58,7 +58,7 @@ type ModifyDBClusterSnapshotAttributeInput struct { DBClusterSnapshotIdentifier *string // A list of DB cluster snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other Amazon Web Services accounts to copy or + // AttributeName . To authorize other Amazon Web Services accounts to copy or // restore a manual DB cluster snapshot, set this list to include one or more // Amazon Web Services account IDs, or all to make the manual DB cluster snapshot // restorable by any Amazon Web Services account. Do not add the all value for any @@ -67,13 +67,13 @@ type ModifyDBClusterSnapshotAttributeInput struct { ValuesToAdd []string // A list of DB cluster snapshot attributes to remove from the attribute specified - // by AttributeName. To remove authorization for other Amazon Web Services accounts - // to copy or restore a manual DB cluster snapshot, set this list to include one or - // more Amazon Web Services account identifiers, or all to remove authorization for - // any Amazon Web Services account to copy or restore the DB cluster snapshot. If - // you specify all, an Amazon Web Services account whose account ID is explicitly - // added to the restore attribute can still copy or restore a manual DB cluster - // snapshot. + // by AttributeName . To remove authorization for other Amazon Web Services + // accounts to copy or restore a manual DB cluster snapshot, set this list to + // include one or more Amazon Web Services account identifiers, or all to remove + // authorization for any Amazon Web Services account to copy or restore the DB + // cluster snapshot. If you specify all , an Amazon Web Services account whose + // account ID is explicitly added to the restore attribute can still copy or + // restore a manual DB cluster snapshot. ValuesToRemove []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBInstance.go b/service/rds/api_op_ModifyDBInstance.go index fec36f58251..392fc621473 100644 --- a/service/rds/api_op_ModifyDBInstance.go +++ b/service/rds/api_op_ModifyDBInstance.go @@ -14,7 +14,7 @@ import ( // Modifies settings for a DB instance. You can change one or more database // configuration parameters by specifying these parameters and the new values in // the request. To learn what modifications you can make to your DB instance, call -// DescribeValidDBInstanceModifications before you call ModifyDBInstance. +// DescribeValidDBInstanceModifications before you call ModifyDBInstance . func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error) { if params == nil { params = &ModifyDBInstanceInput{} @@ -34,8 +34,7 @@ type ModifyDBInstanceInput struct { // The DB instance identifier. This value is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string @@ -45,25 +44,24 @@ type ModifyDBInstanceInput struct { // 10% greater than the current value. Values that are not at least 10% greater // than the existing value are rounded up so that they are 10% greater than the // current value. For the valid values for allocated storage for each engine, see - // CreateDBInstance. + // CreateDBInstance . AllocatedStorage *int32 - // A value that indicates whether major version upgrades are allowed. Changing this - // parameter doesn't result in an outage and the change is asynchronously applied - // as soon as possible. This setting doesn't apply to RDS Custom. Constraints: - // Major version upgrades must be allowed when specifying a value for the - // EngineVersion parameter that is a different major version than the DB instance's - // current version. + // A value that indicates whether major version upgrades are allowed. Changing + // this parameter doesn't result in an outage and the change is asynchronously + // applied as soon as possible. This setting doesn't apply to RDS Custom. + // Constraints: Major version upgrades must be allowed when specifying a value for + // the EngineVersion parameter that is a different major version than the DB + // instance's current version. AllowMajorVersionUpgrade bool - // A value that indicates whether the modifications in this request and any pending - // modifications are asynchronously applied as soon as possible, regardless of the - // PreferredMaintenanceWindow setting for the DB instance. By default, this + // A value that indicates whether the modifications in this request and any + // pending modifications are asynchronously applied as soon as possible, regardless + // of the PreferredMaintenanceWindow setting for the DB instance. By default, this // parameter is disabled. If this parameter is disabled, changes to the DB instance // are applied during the next maintenance window. Some parameter changes can cause - // an outage and are applied on the next call to RebootDBInstance, or the next - // failure reboot. Review the table of parameters in Modifying a DB Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) + // an outage and are applied on the next call to RebootDBInstance , or the next + // failure reboot. Review the table of parameters in Modifying a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) // in the Amazon RDS User Guide to see the impact of enabling or disabling // ApplyImmediately for each modified parameter and to determine when the changes // are applied. @@ -72,25 +70,18 @@ type ModifyDBInstanceInput struct { // A value that indicates whether minor version upgrades are applied automatically // to the DB instance during the maintenance window. An outage occurs when all the // following conditions are met: - // - // * The automatic upgrade is enabled for the - // maintenance window. - // - // * A newer minor version is available. - // - // * RDS has enabled - // automatic patching for the engine version. - // - // If any of the preceding conditions - // isn't met, RDS applies the change as soon as possible and doesn't cause an - // outage. For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. - // Otherwise, the operation returns an error. + // - The automatic upgrade is enabled for the maintenance window. + // - A newer minor version is available. + // - RDS has enabled automatic patching for the engine version. + // If any of the preceding conditions isn't met, RDS applies the change as soon as + // possible and doesn't cause an outage. For an RDS Custom DB instance, set + // AutoMinorVersionUpgrade to false . Otherwise, the operation returns an error. AutoMinorVersionUpgrade *bool - // The automation mode of the RDS Custom DB instance: full or all paused. If full, - // the DB instance automates monitoring and instance recovery. If all paused, the - // instance pauses automation for the duration set by - // ResumeFullAutomationModeMinutes. + // The automation mode of the RDS Custom DB instance: full or all paused . If full + // , the DB instance automates monitoring and instance recovery. If all paused , + // the instance pauses automation for the duration set by + // ResumeFullAutomationModeMinutes . AutomationMode types.AutomationMode // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services @@ -102,53 +93,42 @@ type ModifyDBInstanceInput struct { // backups. Enabling and disabling backups can result in a brief I/O suspension // that lasts from a few seconds to a few minutes, depending on the size and class // of your DB instance. These changes are applied during the next maintenance - // window unless the ApplyImmediately parameter is enabled for this request. If you - // change the parameter from one non-zero value to another non-zero value, the + // window unless the ApplyImmediately parameter is enabled for this request. If + // you change the parameter from one non-zero value to another non-zero value, the // change is asynchronously applied as soon as possible. Amazon Aurora Not // applicable. The retention period for automated backups is managed by the DB - // cluster. For more information, see ModifyDBCluster. Default: Uses existing + // cluster. For more information, see ModifyDBCluster . Default: Uses existing // setting Constraints: - // - // * It must be a value from 0 to 35. It can't be set to 0 if - // the DB instance is a source to read replicas. It can't be set to 0 for an RDS - // Custom for Oracle DB instance. - // - // * It can be specified for a MySQL read replica - // only if the source is running MySQL 5.6 or later. - // - // * It can be specified for a - // PostgreSQL read replica only if the source is running PostgreSQL 9.3.5. + // - It must be a value from 0 to 35. It can't be set to 0 if the DB instance is + // a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB + // instance. + // - It can be specified for a MySQL read replica only if the source is running + // MySQL 5.6 or later. + // - It can be specified for a PostgreSQL read replica only if the source is + // running PostgreSQL 9.3.5. BackupRetentionPeriod *int32 // Specifies the CA certificate identifier to use for the DB instance’s server // certificate. This setting doesn't apply to RDS Custom. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string - // A value that indicates whether the DB instance is restarted when you rotate your - // SSL/TLS certificate. By default, the DB instance is restarted when you rotate - // your SSL/TLS certificate. The certificate is not updated until the DB instance - // is restarted. Set this parameter only if you are not using SSL/TLS to connect to - // the DB instance. If you are using SSL/TLS to connect to the DB instance, follow - // the appropriate instructions for your DB engine to rotate your SSL/TLS - // certificate: - // - // * For more information about rotating your SSL/TLS certificate for - // RDS DB engines, see Rotating Your SSL/TLS Certificate. - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) - // in the Amazon RDS User Guide. - // - // * For more information about rotating your - // SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS - // Certificate - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) - // in the Amazon Aurora User Guide. - // + // A value that indicates whether the DB instance is restarted when you rotate + // your SSL/TLS certificate. By default, the DB instance is restarted when you + // rotate your SSL/TLS certificate. The certificate is not updated until the DB + // instance is restarted. Set this parameter only if you are not using SSL/TLS to + // connect to the DB instance. If you are using SSL/TLS to connect to the DB + // instance, follow the appropriate instructions for your DB engine to rotate your + // SSL/TLS certificate: + // - For more information about rotating your SSL/TLS certificate for RDS DB + // engines, see Rotating Your SSL/TLS Certificate. (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) + // in the Amazon RDS User Guide. + // - For more information about rotating your SSL/TLS certificate for Aurora DB + // engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) + // in the Amazon Aurora User Guide. // This setting doesn't apply to RDS Custom. CertificateRotationRestart *bool @@ -163,22 +143,18 @@ type ModifyDBInstanceInput struct { // snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not // applicable. Copying tags to snapshots is managed by the DB cluster. Setting this // value for an Aurora DB instance has no effect on the DB cluster setting. For - // more information, see ModifyDBCluster. + // more information, see ModifyDBCluster . CopyTagsToSnapshot *bool - // The new compute and memory capacity of the DB instance, for example db.m4.large. - // Not all DB instance classes are available in all Amazon Web Services Regions, or - // for all database engines. For the full list of DB instance classes, and - // availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - // in the Amazon RDS User Guide or Aurora DB instance classes - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) + // The new compute and memory capacity of the DB instance, for example + // db.m4.large. Not all DB instance classes are available in all Amazon Web + // Services Regions, or for all database engines. For the full list of DB instance + // classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) // in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support - // for RDS Custom for Oracle - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.instances) - // and DB instance class support for RDS Custom for SQL Server - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.instancesMS). - // If you modify the DB instance class, an outage occurs during the change. The + // for RDS Custom for Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.instances) + // and DB instance class support for RDS Custom for SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html#custom-reqs-limits.instancesMS) + // . If you modify the DB instance class, an outage occurs during the change. The // change is applied during the next maintenance window, unless you specify // ApplyImmediately in your request. Default: Uses existing setting DBInstanceClass *string @@ -202,44 +178,40 @@ type ModifyDBInstanceInput struct { // parameter. This setting doesn't apply to RDS Custom. MySQL Default: 3306 Valid // values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL // Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid - // values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except - // 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: + // values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234 + // , 1434 , 3260 , 3343 , 3389 , 47001 , and 49152-49156 . Amazon Aurora Default: // 3306 Valid values: 1150-65535 DBPortNumber *int32 // A list of DB security groups to authorize on this DB instance. Changing this // setting doesn't result in an outage and the change is asynchronously applied as // soon as possible. This setting doesn't apply to RDS Custom. Constraints: - // - // * If - // supplied, must match existing DBSecurityGroups. + // - If supplied, must match existing DBSecurityGroups. DBSecurityGroups []string // The new DB subnet group for the DB instance. You can use this parameter to move // your DB instance to a different VPC. If your DB instance isn't in a VPC, you can // also use this parameter to move your DB instance into a VPC. For more - // information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC) + // information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC) // in the Amazon RDS User Guide. Changing the subnet group causes an outage during // the change. The change is applied during the next maintenance window, unless you - // enable ApplyImmediately. This parameter doesn't apply to RDS Custom. + // enable ApplyImmediately . This parameter doesn't apply to RDS Custom. // Constraints: If supplied, must match the name of an existing DBSubnetGroup. // Example: mydbsubnetgroup DBSubnetGroupName *string // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection *bool // The Active Directory directory ID to move the DB instance to. Specify none to // remove the instance from its current domain. You must create the domain before // this operation. Currently, you can create only MySQL, Microsoft SQL Server, // Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more - // information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Domain *string @@ -253,90 +225,84 @@ type ModifyDBInstanceInput struct { // use cases, a CoIP can provide lower latency for connections to the DB instance // from outside of its virtual private cloud (VPC) on your local network. For more // information about RDS on Outposts, see Working with Amazon RDS on Amazon Web - // Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web - // Services IAM accounts to database accounts is managed by the DB cluster. For - // more information about IAM database authentication, see IAM Database - // Authentication for MySQL and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping + // Amazon Web Services IAM accounts to database accounts is managed by the DB + // cluster. For more information about IAM database authentication, see IAM + // Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableIAMDatabaseAuthentication *bool // A value that indicates whether to enable Performance Insights for the DB - // instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnablePerformanceInsights *bool - // The version number of the database engine to upgrade to. Changing this parameter - // results in an outage and the change is applied during the next maintenance - // window unless the ApplyImmediately parameter is enabled for this request. For - // major version upgrades, if a nondefault DB parameter group is currently in use, - // a new DB parameter group in the DB parameter group family for the new engine - // version must be specified. The new DB parameter group can be the default for - // that DB parameter group family. If you specify only a major version, Amazon RDS - // will update the DB instance to the default minor version if the current minor - // version is lower. For information about valid engine versions, see - // CreateDBInstance, or call DescribeDBEngineVersions. If the instance that you're - // modifying is acting as a read replica, the engine version that you specify must - // be the same or later than the version that the source DB instance or cluster is - // running. In RDS Custom for Oracle, this parameter is supported for read replicas - // only if they are in the PATCH_DB_FAILURE lifecycle. + // The version number of the database engine to upgrade to. Changing this + // parameter results in an outage and the change is applied during the next + // maintenance window unless the ApplyImmediately parameter is enabled for this + // request. For major version upgrades, if a nondefault DB parameter group is + // currently in use, a new DB parameter group in the DB parameter group family for + // the new engine version must be specified. The new DB parameter group can be the + // default for that DB parameter group family. If you specify only a major version, + // Amazon RDS will update the DB instance to the default minor version if the + // current minor version is lower. For information about valid engine versions, see + // CreateDBInstance , or call DescribeDBEngineVersions . If the instance that + // you're modifying is acting as a read replica, the engine version that you + // specify must be the same or later than the version that the source DB instance + // or cluster is running. In RDS Custom for Oracle, this parameter is supported for + // read replicas only if they are in the PATCH_DB_FAILURE lifecycle. EngineVersion *string - // The new Provisioned IOPS (I/O operations per second) value for the RDS instance. - // Changing this setting doesn't result in an outage and the change is applied - // during the next maintenance window unless the ApplyImmediately parameter is - // enabled for this request. If you are migrating from Provisioned IOPS to standard - // storage, set this value to 0. The DB instance will require a reboot for the - // change in storage type to take effect. If you choose to migrate your DB instance - // from using standard storage to using Provisioned IOPS, or from using Provisioned - // IOPS to using standard storage, the process can take time. The duration of the - // migration depends on several factors such as database load, storage size, - // storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if - // any), and the number of prior scale storage operations. Typical migration times - // are under 24 hours, but the process can take up to several days in some cases. - // During the migration, the DB instance is available for use, but might experience - // performance degradation. While the migration takes place, nightly backups for - // the instance are suspended. No other Amazon RDS operations can take place for - // the instance, including modifying the instance, rebooting the instance, deleting - // the instance, creating a read replica for the instance, and creating a DB - // snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, and - // PostgreSQL, the value supplied must be at least 10% greater than the current + // The new Provisioned IOPS (I/O operations per second) value for the RDS + // instance. Changing this setting doesn't result in an outage and the change is + // applied during the next maintenance window unless the ApplyImmediately + // parameter is enabled for this request. If you are migrating from Provisioned + // IOPS to standard storage, set this value to 0. The DB instance will require a + // reboot for the change in storage type to take effect. If you choose to migrate + // your DB instance from using standard storage to using Provisioned IOPS, or from + // using Provisioned IOPS to using standard storage, the process can take time. The + // duration of the migration depends on several factors such as database load, + // storage size, storage type (standard or Provisioned IOPS), amount of IOPS + // provisioned (if any), and the number of prior scale storage operations. Typical + // migration times are under 24 hours, but the process can take up to several days + // in some cases. During the migration, the DB instance is available for use, but + // might experience performance degradation. While the migration takes place, + // nightly backups for the instance are suspended. No other Amazon RDS operations + // can take place for the instance, including modifying the instance, rebooting the + // instance, deleting the instance, creating a read replica for the instance, and + // creating a DB snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, + // and PostgreSQL, the value supplied must be at least 10% greater than the current // value. Values that are not at least 10% greater than the existing value are // rounded up so that they are 10% greater than the current value. Default: Uses // existing setting Iops *int32 - // The license model for the DB instance. This setting doesn't apply to RDS Custom. - // Valid values: license-included | bring-your-own-license | general-public-license + // The license model for the DB instance. This setting doesn't apply to RDS + // Custom. Valid values: license-included | bring-your-own-license | + // general-public-license LicenseModel *string // A value that indicates whether to manage the master user password with Amazon // Web Services Secrets Manager. If the DB cluster doesn't manage the master user // password with Amazon Web Services Secrets Manager, you can turn on this - // management. In this case, you can't specify MasterUserPassword. If the DB + // management. In this case, you can't specify MasterUserPassword . If the DB // cluster already manages the master user password with Amazon Web Services // Secrets Manager, and you specify that the master user password is not managed // with Amazon Web Services Secrets Manager, then you must specify - // MasterUserPassword. In this case, RDS deletes the secret and uses the new - // password for the master user specified by MasterUserPassword. For more - // information, see Password management with Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // MasterUserPassword . In this case, RDS deletes the secret and uses the new + // password for the master user specified by MasterUserPassword . For more + // information, see Password management with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: - // - // * Can't manage the master user - // password with Amazon Web Services Secrets Manager if MasterUserPassword is - // specified. + // - Can't manage the master user password with Amazon Web Services Secrets + // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool // The new password for the master user. The password can include any printable @@ -346,7 +312,7 @@ type ModifyDBInstanceInput struct { // MasterUserPassword element exists in the PendingModifiedValues element of the // operation response. This setting doesn't apply to RDS Custom. Amazon Aurora Not // applicable. The password for the master user is managed by the DB cluster. For - // more information, see ModifyDBCluster. Default: Uses existing setting + // more information, see ModifyDBCluster . Default: Uses existing setting // Constraints: Can't be specified if ManageMasterUserPassword is turned on. // MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server // Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must @@ -360,50 +326,45 @@ type ModifyDBInstanceInput struct { // The Amazon Web Services KMS key identifier to encrypt a secret that is // automatically generated and managed in Amazon Web Services Secrets Manager. This // setting is valid only if both of the following conditions are met: - // - // * The DB - // instance doesn't manage the master user password in Amazon Web Services Secrets - // Manager. If the DB instance already manages the master user password in Amazon - // Web Services Secrets Manager, you can't change the KMS key used to encrypt the - // secret. - // - // * You are turning on ManageMasterUserPassword to manage the master user - // password in Amazon Web Services Secrets Manager. If you are turning on - // ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the - // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a - // different Amazon Web Services account, then you can't use the aws/secretsmanager - // KMS key to encrypt the secret, and you must use a customer managed KMS key. - // - // The - // Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or - // alias name for the KMS key. To use a KMS key in a different Amazon Web Services - // account, specify the key ARN or alias ARN. There is a default KMS key for your - // Amazon Web Services account. Your Amazon Web Services account has a different - // default KMS key for each Amazon Web Services Region. + // - The DB instance doesn't manage the master user password in Amazon Web + // Services Secrets Manager. If the DB instance already manages the master user + // password in Amazon Web Services Secrets Manager, you can't change the KMS key + // used to encrypt the secret. + // - You are turning on ManageMasterUserPassword to manage the master user + // password in Amazon Web Services Secrets Manager. If you are turning on + // ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId , then the + // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in + // a different Amazon Web Services account, then you can't use the + // aws/secretsmanager KMS key to encrypt the secret, and you must use a customer + // managed KMS key. + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. To use a KMS key in a different Amazon Web + // Services account, specify the key ARN or alias ARN. There is a default KMS key + // for your Amazon Web Services account. Your Amazon Web Services account has a + // different default KMS key for each Amazon Web Services Region. MasterUserSecretKmsKeyId *string // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale // the storage of the DB instance. For more information about this setting, - // including limitations that apply to it, see Managing capacity automatically - // with Amazon RDS storage autoscaling - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) + // including limitations that apply to it, see Managing capacity automatically + // with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. MaxAllocatedStorage *int32 // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0, which is the default. If MonitoringRoleArn is specified, set - // MonitoringInterval to a value other than 0. This setting doesn't apply to RDS - // Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60 + // metrics, specify 0, which is the default. If MonitoringRoleArn is specified, + // set MonitoringInterval to a value other than 0. This setting doesn't apply to + // RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to - // Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For - // information on creating a monitoring role, see To create an IAM role for Amazon - // RDS Enhanced Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom. + // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics + // to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . + // For information on creating a monitoring role, see To create an IAM role for + // Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, supply a MonitoringRoleArn value. This setting doesn't apply to RDS + // Custom. MonitoringRoleArn *string // A value that indicates whether the DB instance is a Multi-AZ deployment. @@ -413,34 +374,23 @@ type ModifyDBInstanceInput struct { MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string // The new DB instance identifier for the DB instance when renaming a DB instance. // When you change the DB instance identifier, an instance reboot occurs - // immediately if you enable ApplyImmediately, or will occur during the next + // immediately if you enable ApplyImmediately , or will occur during the next // maintenance window if you disable Apply Immediately. This value is stored as a // lowercase string. This setting doesn't apply to RDS Custom. Constraints: - // - // * Must - // contain from 1 to 63 letters, numbers, or hyphens. - // - // * The first character must - // be a letter. - // - // * Can't end with a hyphen or contain two consecutive - // hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - The first character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance NewDBInstanceIdentifier *string @@ -459,36 +409,24 @@ type ModifyDBInstanceInput struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you do not specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. - // This setting doesn't apply to RDS Custom. + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. This setting doesn't apply to RDS Custom. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. This setting doesn't apply to RDS Custom. + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. This setting doesn't apply to RDS Custom. PerformanceInsightsRetentionPeriod *int32 // The daily time range during which automated backups are created if automated @@ -496,21 +434,14 @@ type ModifyDBInstanceInput struct { // Changing this parameter doesn't result in an outage and the change is // asynchronously applied as soon as possible. The default is a 30-minute window // selected at random from an 8-hour block of time for each Amazon Web Services - // Region. For more information, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) + // Region. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range // for creating automated backups is managed by the DB cluster. For more - // information, see ModifyDBCluster. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi - // - // * Must be in Universal Time Coordinated (UTC) - // - // * Must not - // conflict with the preferred maintenance window - // - // * Must be at least 30 minutes + // information, see ModifyDBCluster . Constraints: + // - Must be in the format hh24:mi-hh24:mi + // - Must be in Universal Time Coordinated (UTC) + // - Must not conflict with the preferred maintenance window + // - Must be at least 30 minutes PreferredBackupWindow *string // The weekly time range (in UTC) during which system maintenance can occur, which @@ -521,8 +452,7 @@ type ModifyDBInstanceInput struct { // parameter will cause a reboot of the DB instance. If moving this window to the // current time, there must be at least 30 minutes between the current time and end // of the window to ensure pending changes are applied. For more information, see - // Amazon RDS Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) // in the Amazon RDS User Guide. Default: Uses existing setting Format: // ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun // Constraints: Must be at least 30 minutes @@ -534,8 +464,7 @@ type ModifyDBInstanceInput struct { // A value that specifies the order in which an Aurora Replica is promoted to the // primary instance after a failure of the existing primary instance. For more - // information, see Fault Tolerance for an Aurora DB Cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. // Default: 1 Valid Values: 0 - 15 PromotionTier *int32 @@ -562,72 +491,67 @@ type ModifyDBInstanceInput struct { // doesn't use Active Data Guard to transmit information to the mounted replica. // Because it doesn't accept user connections, a mounted replica can't serve a // read-only workload. For more information, see Working with Oracle Read Replicas - // for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) + // for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. ReplicaMode types.ReplicaMode // The number of minutes to pause the automation. When the time period ends, RDS // Custom resumes full automation. The minimum value is 60 (default). The maximum - // value is 1,440. + // value is 1,440 . ResumeFullAutomationModeMinutes *int32 // A value that indicates whether to rotate the secret managed by Amazon Web // Services Secrets Manager for the master user password. This setting is valid // only if the master user password is managed by RDS in Amazon Web Services // Secrets Manager for the DB cluster. The secret value contains the updated - // password. For more information, see Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // password. For more information, see Password management with Amazon Web + // Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: - // - // * You must apply the change - // immediately when rotating the master user password. + // - You must apply the change immediately when rotating the master user + // password. RotateMasterUserPassword *bool - // Specifies the storage throughput value for the DB instance. This setting applies - // only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon - // Aurora. + // Specifies the storage throughput value for the DB instance. This setting + // applies only to the gp3 storage type. This setting doesn't apply to RDS Custom + // or Amazon Aurora. StorageThroughput *int32 - // Specifies the storage type to be associated with the DB instance. If you specify - // Provisioned IOPS (io1), you must also include a value for the Iops parameter. If - // you choose to migrate your DB instance from using standard storage to using - // Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the - // process can take time. The duration of the migration depends on several factors - // such as database load, storage size, storage type (standard or Provisioned - // IOPS), amount of IOPS provisioned (if any), and the number of prior scale - // storage operations. Typical migration times are under 24 hours, but the process - // can take up to several days in some cases. During the migration, the DB instance - // is available for use, but might experience performance degradation. While the - // migration takes place, nightly backups for the instance are suspended. No other - // Amazon RDS operations can take place for the instance, including modifying the - // instance, rebooting the instance, deleting the instance, creating a read replica - // for the instance, and creating a DB snapshot of the instance. Valid values: gp2 - // | gp3 | io1 | standard Default: io1 if the Iops parameter is specified, - // otherwise gp2 + // Specifies the storage type to be associated with the DB instance. If you + // specify Provisioned IOPS ( io1 ), you must also include a value for the Iops + // parameter. If you choose to migrate your DB instance from using standard storage + // to using Provisioned IOPS, or from using Provisioned IOPS to using standard + // storage, the process can take time. The duration of the migration depends on + // several factors such as database load, storage size, storage type (standard or + // Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior + // scale storage operations. Typical migration times are under 24 hours, but the + // process can take up to several days in some cases. During the migration, the DB + // instance is available for use, but might experience performance degradation. + // While the migration takes place, nightly backups for the instance are suspended. + // No other Amazon RDS operations can take place for the instance, including + // modifying the instance, rebooting the instance, deleting the instance, creating + // a read replica for the instance, and creating a DB snapshot of the instance. + // Valid values: gp2 | gp3 | io1 | standard Default: io1 if the Iops parameter is + // specified, otherwise gp2 StorageType *string // The ARN from the key store with which to associate the instance for TDE // encryption. This setting doesn't apply to RDS Custom. TdeCredentialArn *string - // The password for the given ARN from the key store in order to access the device. - // This setting doesn't apply to RDS Custom. + // The password for the given ARN from the key store in order to access the + // device. This setting doesn't apply to RDS Custom. TdeCredentialPassword *string - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. This setting doesn't apply to RDS Custom. + // A value that indicates whether the DB instance class of the DB instance uses + // its default processor features. This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to authorize on this DB instance. This // change is asynchronously applied as soon as possible. This setting doesn't apply // to RDS Custom. Amazon Aurora Not applicable. The associated list of EC2 VPC // security groups is managed by the DB cluster. For more information, see - // ModifyDBCluster. Constraints: - // - // * If supplied, must match existing - // VpcSecurityGroupIds. + // ModifyDBCluster . Constraints: + // - If supplied, must match existing VpcSecurityGroupIds. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -636,11 +560,11 @@ type ModifyDBInstanceInput struct { type ModifyDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBParameterGroup.go b/service/rds/api_op_ModifyDBParameterGroup.go index dd8fe8f6a1d..78a93f8aa94 100644 --- a/service/rds/api_op_ModifyDBParameterGroup.go +++ b/service/rds/api_op_ModifyDBParameterGroup.go @@ -12,8 +12,8 @@ import ( ) // Modifies the parameters of a DB parameter group. To modify more than one -// parameter, submit a list of the following: ParameterName, ParameterValue, and -// ApplyMethod. A maximum of 20 parameters can be modified in a single request. +// parameter, submit a list of the following: ParameterName , ParameterValue , and +// ApplyMethod . A maximum of 20 parameters can be modified in a single request. // After you modify a DB parameter group, you should wait at least 5 minutes before // creating your first DB instance that uses that DB parameter group as the default // parameter group. This allows Amazon RDS to fully complete the modify action @@ -21,9 +21,9 @@ import ( // especially important for parameters that are critical when creating the default // database for a DB instance, such as the character set for the default database // defined by the character_set_database parameter. You can use the Parameter -// Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) or -// the DescribeDBParameters command to verify that your DB parameter group has been -// created or modified. +// Groups option of the Amazon RDS console (https://console.aws.amazon.com/rds/) +// or the DescribeDBParameters command to verify that your DB parameter group has +// been created or modified. func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBParameterGroupInput, optFns ...func(*Options)) (*ModifyDBParameterGroupOutput, error) { if params == nil { params = &ModifyDBParameterGroupInput{} @@ -42,9 +42,7 @@ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBPar type ModifyDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * If supplied, must match the - // name of an existing DBParameterGroup. + // - If supplied, must match the name of an existing DBParameterGroup . // // This member is required. DBParameterGroupName *string @@ -55,15 +53,14 @@ type ModifyDBParameterGroupInput struct { // be modified in a single request. Valid Values (for the application method): // immediate | pending-reboot You can use the immediate value with dynamic // parameters only. You can use the pending-reboot value for both dynamic and - // static parameters. When the application method is immediate, changes to dynamic + // static parameters. When the application method is immediate , changes to dynamic // parameters are applied immediately to the DB instances associated with the - // parameter group. When the application method is pending-reboot, changes to + // parameter group. When the application method is pending-reboot , changes to // dynamic and static parameters are applied after a reboot without failover to the // DB instances associated with the parameter group. You can't use pending-reboot - // with dynamic parameters on RDS for SQL Server DB instances. Use immediate. For + // with dynamic parameters on RDS for SQL Server DB instances. Use immediate . For // more information on modifying DB parameters, see Working with DB parameter - // groups - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) + // groups (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) // in the Amazon RDS User Guide. // // This member is required. diff --git a/service/rds/api_op_ModifyDBProxy.go b/service/rds/api_op_ModifyDBProxy.go index b23aa232c49..3293619f901 100644 --- a/service/rds/api_op_ModifyDBProxy.go +++ b/service/rds/api_op_ModifyDBProxy.go @@ -34,7 +34,7 @@ type ModifyDBProxyInput struct { // This member is required. DBProxyName *string - // The new authentication settings for the DBProxy. + // The new authentication settings for the DBProxy . Auth []types.UserAuthConfig // Whether the proxy includes detailed information about SQL statements in its @@ -51,21 +51,21 @@ type ModifyDBProxyInput struct { // timeout limit for the associated database. IdleClientTimeout *int32 - // The new identifier for the DBProxy. An identifier must begin with a letter and + // The new identifier for the DBProxy . An identifier must begin with a letter and // must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen // or contain two consecutive hyphens. NewDBProxyName *string - // Whether Transport Layer Security (TLS) encryption is required for connections to - // the proxy. By enabling this setting, you can enforce encrypted TLS connections - // to the proxy, even if the associated database doesn't use TLS. + // Whether Transport Layer Security (TLS) encryption is required for connections + // to the proxy. By enabling this setting, you can enforce encrypted TLS + // connections to the proxy, even if the associated database doesn't use TLS. RequireTLS *bool // The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access // secrets in Amazon Web Services Secrets Manager. RoleArn *string - // The new list of security groups for the DBProxy. + // The new list of security groups for the DBProxy . SecurityGroups []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBProxyEndpoint.go b/service/rds/api_op_ModifyDBProxyEndpoint.go index 264619d5688..7868bd531a4 100644 --- a/service/rds/api_op_ModifyDBProxyEndpoint.go +++ b/service/rds/api_op_ModifyDBProxyEndpoint.go @@ -35,14 +35,14 @@ type ModifyDBProxyEndpointInput struct { // This member is required. DBProxyEndpointName *string - // The new identifier for the DBProxyEndpoint. An identifier must begin with a + // The new identifier for the DBProxyEndpoint . An identifier must begin with a // letter and must contain only ASCII letters, digits, and hyphens; it can't end // with a hyphen or contain two consecutive hyphens. NewDBProxyEndpointName *string - // The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint - // uses a different VPC than the original proxy, you also specify a different set - // of security group IDs than for the original proxy. + // The VPC security group IDs for the DB proxy endpoint. When the DB proxy + // endpoint uses a different VPC than the original proxy, you also specify a + // different set of security group IDs than for the original proxy. VpcSecurityGroupIds []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBProxyTargetGroup.go b/service/rds/api_op_ModifyDBProxyTargetGroup.go index 91e5ce6655d..3ba15f6595e 100644 --- a/service/rds/api_op_ModifyDBProxyTargetGroup.go +++ b/service/rds/api_op_ModifyDBProxyTargetGroup.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the properties of a DBProxyTargetGroup. +// Modifies the properties of a DBProxyTargetGroup . func (c *Client) ModifyDBProxyTargetGroup(ctx context.Context, params *ModifyDBProxyTargetGroupInput, optFns ...func(*Options)) (*ModifyDBProxyTargetGroupOutput, error) { if params == nil { params = &ModifyDBProxyTargetGroupInput{} @@ -39,11 +39,11 @@ type ModifyDBProxyTargetGroupInput struct { // This member is required. TargetGroupName *string - // The settings that determine the size and behavior of the connection pool for the - // target group. + // The settings that determine the size and behavior of the connection pool for + // the target group. ConnectionPoolConfig *types.ConnectionPoolConfiguration - // The new name for the modified DBProxyTarget. An identifier must begin with a + // The new name for the modified DBProxyTarget . An identifier must begin with a // letter and must contain only ASCII letters, digits, and hyphens; it can't end // with a hyphen or contain two consecutive hyphens. NewName *string @@ -53,7 +53,7 @@ type ModifyDBProxyTargetGroupInput struct { type ModifyDBProxyTargetGroupOutput struct { - // The settings of the modified DBProxyTarget. + // The settings of the modified DBProxyTarget . DBProxyTargetGroup *types.DBProxyTargetGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBSnapshot.go b/service/rds/api_op_ModifyDBSnapshot.go index 18d7cf40720..f46fc91bf68 100644 --- a/service/rds/api_op_ModifyDBSnapshot.go +++ b/service/rds/api_op_ModifyDBSnapshot.go @@ -37,33 +37,23 @@ type ModifyDBSnapshotInput struct { // This member is required. DBSnapshotIdentifier *string - // The engine version to upgrade the DB snapshot to. The following are the database - // engines and engine versions that are available when you upgrade a DB snapshot. - // MySQL - // - // * 5.5.46 (supported for 5.1 DB snapshots) - // + // The engine version to upgrade the DB snapshot to. The following are the + // database engines and engine versions that are available when you upgrade a DB + // snapshot. MySQL + // - 5.5.46 (supported for 5.1 DB snapshots) // Oracle - // - // * 12.1.0.2.v8 - // (supported for 12.1.0.1 DB snapshots) - // - // * 11.2.0.4.v12 (supported for 11.2.0.2 DB - // snapshots) - // - // * 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) - // - // PostgreSQL For - // the list of engine versions that are available for upgrading a DB snapshot, see - // Upgrading the PostgreSQL DB Engine for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion). + // - 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) + // - 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) + // - 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) + // PostgreSQL For the list of engine versions that are available for upgrading a + // DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion) + // . EngineVersion *string - // The option group to identify with the upgraded DB snapshot. You can specify this - // parameter when you upgrade an Oracle DB snapshot. The same option group + // The option group to identify with the upgraded DB snapshot. You can specify + // this parameter when you upgrade an Oracle DB snapshot. The same option group // considerations apply when upgrading a DB snapshot as when upgrading a DB - // instance. For more information, see Option group considerations - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG) + // instance. For more information, see Option group considerations (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG) // in the Amazon RDS User Guide. OptionGroupName *string diff --git a/service/rds/api_op_ModifyDBSnapshotAttribute.go b/service/rds/api_op_ModifyDBSnapshotAttribute.go index b746008caaa..d5393e795b6 100644 --- a/service/rds/api_op_ModifyDBSnapshotAttribute.go +++ b/service/rds/api_op_ModifyDBSnapshotAttribute.go @@ -13,19 +13,19 @@ import ( // Adds an attribute and values to, or removes an attribute and values from, a // manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services -// accounts, specify restore as the AttributeName and use the ValuesToAdd parameter -// to add a list of IDs of the Amazon Web Services accounts that are authorized to -// restore the manual DB snapshot. Uses the value all to make the manual DB -// snapshot public, which means it can be copied or restored by all Amazon Web -// Services accounts. Don't add the all value for any manual DB snapshots that -// contain private information that you don't want available to all Amazon Web -// Services accounts. If the manual DB snapshot is encrypted, it can be shared, but -// only by specifying a list of authorized Amazon Web Services account IDs for the -// ValuesToAdd parameter. You can't use all as a value for that parameter in this -// case. To view which Amazon Web Services accounts have access to copy or restore -// a manual DB snapshot, or whether a manual DB snapshot public or private, use the -// DescribeDBSnapshotAttributes API operation. The accounts are returned as values -// for the restore attribute. +// accounts, specify restore as the AttributeName and use the ValuesToAdd +// parameter to add a list of IDs of the Amazon Web Services accounts that are +// authorized to restore the manual DB snapshot. Uses the value all to make the +// manual DB snapshot public, which means it can be copied or restored by all +// Amazon Web Services accounts. Don't add the all value for any manual DB +// snapshots that contain private information that you don't want available to all +// Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be +// shared, but only by specifying a list of authorized Amazon Web Services account +// IDs for the ValuesToAdd parameter. You can't use all as a value for that +// parameter in this case. To view which Amazon Web Services accounts have access +// to copy or restore a manual DB snapshot, or whether a manual DB snapshot public +// or private, use the DescribeDBSnapshotAttributes API operation. The accounts +// are returned as values for the restore attribute. func (c *Client) ModifyDBSnapshotAttribute(ctx context.Context, params *ModifyDBSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBSnapshotAttributeOutput, error) { if params == nil { params = &ModifyDBSnapshotAttributeInput{} @@ -45,7 +45,7 @@ type ModifyDBSnapshotAttributeInput struct { // The name of the DB snapshot attribute to modify. To manage authorization for // other Amazon Web Services accounts to copy or restore a manual DB snapshot, set - // this value to restore. To view the list of attributes available to modify, use + // this value to restore . To view the list of attributes available to modify, use // the DescribeDBSnapshotAttributes API operation. // // This member is required. @@ -57,7 +57,7 @@ type ModifyDBSnapshotAttributeInput struct { DBSnapshotIdentifier *string // A list of DB snapshot attributes to add to the attribute specified by - // AttributeName. To authorize other Amazon Web Services accounts to copy or + // AttributeName . To authorize other Amazon Web Services accounts to copy or // restore a manual snapshot, set this list to include one or more Amazon Web // Services account IDs, or all to make the manual DB snapshot restorable by any // Amazon Web Services account. Do not add the all value for any manual DB @@ -66,12 +66,12 @@ type ModifyDBSnapshotAttributeInput struct { ValuesToAdd []string // A list of DB snapshot attributes to remove from the attribute specified by - // AttributeName. To remove authorization for other Amazon Web Services accounts to - // copy or restore a manual snapshot, set this list to include one or more Amazon - // Web Services account identifiers, or all to remove authorization for any Amazon - // Web Services account to copy or restore the DB snapshot. If you specify all, an - // Amazon Web Services account whose account ID is explicitly added to the restore - // attribute can still copy or restore the manual DB snapshot. + // AttributeName . To remove authorization for other Amazon Web Services accounts + // to copy or restore a manual snapshot, set this list to include one or more + // Amazon Web Services account identifiers, or all to remove authorization for any + // Amazon Web Services account to copy or restore the DB snapshot. If you specify + // all , an Amazon Web Services account whose account ID is explicitly added to the + // restore attribute can still copy or restore the manual DB snapshot. ValuesToRemove []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBSubnetGroup.go b/service/rds/api_op_ModifyDBSubnetGroup.go index ae1163f958c..0116ff41048 100644 --- a/service/rds/api_op_ModifyDBSubnetGroup.go +++ b/service/rds/api_op_ModifyDBSubnetGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an existing DB subnet group. DB subnet groups must contain at least one -// subnet in at least two AZs in the Amazon Web Services Region. +// Modifies an existing DB subnet group. DB subnet groups must contain at least +// one subnet in at least two AZs in the Amazon Web Services Region. func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnetGroupInput, optFns ...func(*Options)) (*ModifyDBSubnetGroupOutput, error) { if params == nil { params = &ModifyDBSubnetGroupInput{} @@ -50,8 +50,8 @@ type ModifyDBSubnetGroupInput struct { type ModifyDBSubnetGroupOutput struct { - // Contains the details of an Amazon RDS DB subnet group. This data type is used as - // a response element in the DescribeDBSubnetGroups action. + // Contains the details of an Amazon RDS DB subnet group. This data type is used + // as a response element in the DescribeDBSubnetGroups action. DBSubnetGroup *types.DBSubnetGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyEventSubscription.go b/service/rds/api_op_ModifyEventSubscription.go index 697833d6817..712f3a9d759 100644 --- a/service/rds/api_op_ModifyEventSubscription.go +++ b/service/rds/api_op_ModifyEventSubscription.go @@ -15,9 +15,8 @@ import ( // source identifiers using this call. To change source identifiers for a // subscription, use the AddSourceIdentifierToSubscription and // RemoveSourceIdentifierFromSubscription calls. You can see a list of the event -// categories for a given source type (SourceType) in Events -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the -// Amazon RDS User Guide or by using the DescribeEventCategories operation. +// categories for a given source type ( SourceType ) in Events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) +// in the Amazon RDS User Guide or by using the DescribeEventCategories operation. func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEventSubscriptionInput, optFns ...func(*Options)) (*ModifyEventSubscriptionOutput, error) { if params == nil { params = &ModifyEventSubscriptionInput{} @@ -43,7 +42,7 @@ type ModifyEventSubscriptionInput struct { // A value that indicates whether to activate the subscription. Enabled *bool - // A list of event categories for a source type (SourceType) that you want to + // A list of event categories for a source type ( SourceType ) that you want to // subscribe to. You can see a list of the categories for a given source type in // Events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) // in the Amazon RDS User Guide or by using the DescribeEventCategories operation. @@ -53,9 +52,9 @@ type ModifyEventSubscriptionInput struct { // The ARN is created by Amazon SNS when you create a topic and subscribe to it. SnsTopicArn *string - // The type of source that is generating the events. For example, if you want to be - // notified of events generated by a DB instance, you would set this parameter to - // db-instance. For RDS Proxy events, specify db-proxy. If this value isn't + // The type of source that is generating the events. For example, if you want to + // be notified of events generated by a DB instance, you would set this parameter + // to db-instance. For RDS Proxy events, specify db-proxy . If this value isn't // specified, all events are returned. Valid values: db-instance | db-cluster | // db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | // db-proxy diff --git a/service/rds/api_op_ModifyGlobalCluster.go b/service/rds/api_op_ModifyGlobalCluster.go index 8e1d4c12695..72bc73e3165 100644 --- a/service/rds/api_op_ModifyGlobalCluster.go +++ b/service/rds/api_op_ModifyGlobalCluster.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modify a setting for an Amazon Aurora global cluster. You can change one or more -// database configuration parameters by specifying these parameters and the new -// values in the request. For more information on Amazon Aurora, see What is -// Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// Modify a setting for an Amazon Aurora global cluster. You can change one or +// more database configuration parameters by specifying these parameters and the +// new values in the request. For more information on Amazon Aurora, see What is +// Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalClusterInput, optFns ...func(*Options)) (*ModifyGlobalClusterOutput, error) { if params == nil { @@ -47,9 +46,9 @@ type ModifyGlobalClusterInput struct { // global database cluster can't be deleted when deletion protection is enabled. DeletionProtection *bool - // The version number of the database engine to which you want to upgrade. Changing - // this parameter results in an outage. The change is applied during the next - // maintenance window unless ApplyImmediately is enabled. To list all of the + // The version number of the database engine to which you want to upgrade. + // Changing this parameter results in an outage. The change is applied during the + // next maintenance window unless ApplyImmediately is enabled. To list all of the // available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the // following command: aws rds describe-db-engine-versions --engine aurora --query // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' To list all of the @@ -57,30 +56,22 @@ type ModifyGlobalClusterInput struct { // 8.0-compatible Aurora), use the following command: aws rds // describe-db-engine-versions --engine aurora-mysql --query // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' To list all of the - // available engine versions for aurora-postgresql, use the following command: aws - // rds describe-db-engine-versions --engine aurora-postgresql --query + // available engine versions for aurora-postgresql , use the following command: + // aws rds describe-db-engine-versions --engine aurora-postgresql --query // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' EngineVersion *string // The DB cluster identifier for the global cluster being modified. This parameter // isn't case-sensitive. Constraints: - // - // * Must match the identifier of an existing - // global database cluster. + // - Must match the identifier of an existing global database cluster. GlobalClusterIdentifier *string // The new cluster identifier for the global database cluster when modifying a // global database cluster. This value is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens - // - // * The - // first character must be a letter - // - // * Can't end with a hyphen or contain two - // consecutive hyphens - // + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - The first character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-cluster2 NewGlobalClusterIdentifier *string diff --git a/service/rds/api_op_PromoteReadReplica.go b/service/rds/api_op_PromoteReadReplica.go index 9c427283fb8..c6ff15080eb 100644 --- a/service/rds/api_op_PromoteReadReplica.go +++ b/service/rds/api_op_PromoteReadReplica.go @@ -12,18 +12,15 @@ import ( ) // Promotes a read replica DB instance to a standalone DB instance. -// -// * Backup -// duration is a function of the amount of changes to the database since the -// previous backup. If you plan to promote a read replica to a standalone instance, -// we recommend that you enable backups and complete at least one backup prior to -// promotion. In addition, a read replica cannot be promoted to a standalone -// instance when it is in the backing-up status. If you have enabled backups on -// your read replica, configure the automated backup window so that daily backups -// do not interfere with read replica promotion. -// -// * This command doesn't apply to -// Aurora MySQL, Aurora PostgreSQL, or RDS Custom. +// - Backup duration is a function of the amount of changes to the database +// since the previous backup. If you plan to promote a read replica to a standalone +// instance, we recommend that you enable backups and complete at least one backup +// prior to promotion. In addition, a read replica cannot be promoted to a +// standalone instance when it is in the backing-up status. If you have enabled +// backups on your read replica, configure the automated backup window so that +// daily backups do not interfere with read replica promotion. +// - This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS +// Custom. func (c *Client) PromoteReadReplica(ctx context.Context, params *PromoteReadReplicaInput, optFns ...func(*Options)) (*PromoteReadReplicaOutput, error) { if params == nil { params = &PromoteReadReplicaInput{} @@ -43,10 +40,7 @@ type PromoteReadReplicaInput struct { // The DB instance identifier. This value is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing read replica DB - // instance. - // + // - Must match the identifier of an existing read replica DB instance. // Example: mydbinstance // // This member is required. @@ -55,30 +49,20 @@ type PromoteReadReplicaInput struct { // The number of days for which automated backups are retained. Setting this // parameter to a positive number enables backups. Setting this parameter to 0 // disables automated backups. Default: 1 Constraints: - // - // * Must be a value from 0 to - // 35. - // - // * Can't be set to 0 if the DB instance is a source to read replicas. + // - Must be a value from 0 to 35. + // - Can't be set to 0 if the DB instance is a source to read replicas. BackupRetentionPeriod *int32 // The daily time range during which automated backups are created if automated - // backups are enabled, using the BackupRetentionPeriod parameter. The default is a - // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. To see the time blocks available, see Adjusting the - // Preferred Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) + // backups are enabled, using the BackupRetentionPeriod parameter. The default is + // a 30-minute window selected at random from an 8-hour block of time for each + // Amazon Web Services Region. To see the time blocks available, see Adjusting the + // Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) // in the Amazon RDS User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string noSmithyDocumentSerde @@ -87,11 +71,11 @@ type PromoteReadReplicaInput struct { type PromoteReadReplicaOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_PromoteReadReplicaDBCluster.go b/service/rds/api_op_PromoteReadReplicaDBCluster.go index 18686fcceee..66e1098c130 100644 --- a/service/rds/api_op_PromoteReadReplicaDBCluster.go +++ b/service/rds/api_op_PromoteReadReplicaDBCluster.go @@ -31,10 +31,7 @@ type PromoteReadReplicaDBClusterInput struct { // The identifier of the DB cluster read replica to promote. This parameter isn't // case-sensitive. Constraints: - // - // * Must match the identifier of an existing DB - // cluster read replica. - // + // - Must match the identifier of an existing DB cluster read replica. // Example: my-cluster-replica1 // // This member is required. @@ -47,19 +44,17 @@ type PromoteReadReplicaDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_PurchaseReservedDBInstancesOffering.go b/service/rds/api_op_PurchaseReservedDBInstancesOffering.go index 7dabeff7bc6..e4b84757e2d 100644 --- a/service/rds/api_op_PurchaseReservedDBInstancesOffering.go +++ b/service/rds/api_op_PurchaseReservedDBInstancesOffering.go @@ -42,9 +42,8 @@ type PurchaseReservedDBInstancesOfferingInput struct { // myreservationID ReservedDBInstanceId *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_RebootDBCluster.go b/service/rds/api_op_RebootDBCluster.go index 833d7bac40e..40f01ea8b67 100644 --- a/service/rds/api_op_RebootDBCluster.go +++ b/service/rds/api_op_RebootDBCluster.go @@ -17,9 +17,8 @@ import ( // changes to take effect. Rebooting a DB cluster restarts the database engine // service. Rebooting a DB cluster results in a momentary outage, during which the // DB cluster status is set to rebooting. Use this operation only for a non-Aurora -// Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see Multi-AZ -// DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see Multi-AZ +// DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) RebootDBCluster(ctx context.Context, params *RebootDBClusterInput, optFns ...func(*Options)) (*RebootDBClusterOutput, error) { if params == nil { @@ -40,8 +39,7 @@ type RebootDBClusterInput struct { // The DB cluster identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBCluster. + // - Must match the identifier of an existing DBCluster. // // This member is required. DBClusterIdentifier *string @@ -53,19 +51,17 @@ type RebootDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_RebootDBInstance.go b/service/rds/api_op_RebootDBInstance.go index bf5f1749310..e39e3e5106f 100644 --- a/service/rds/api_op_RebootDBInstance.go +++ b/service/rds/api_op_RebootDBInstance.go @@ -17,8 +17,7 @@ import ( // changes to take effect. Rebooting a DB instance restarts the database engine // service. Rebooting a DB instance results in a momentary outage, during which the // DB instance status is set to rebooting. For more information about rebooting, -// see Rebooting a DB Instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html) +// see Rebooting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html) // in the Amazon RDS User Guide. This command doesn't apply to RDS Custom. If your // DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with // the RebootDBCluster operation. @@ -41,8 +40,7 @@ type RebootDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must match the identifier of an existing DBInstance. + // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string @@ -58,11 +56,11 @@ type RebootDBInstanceInput struct { type RebootDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RegisterDBProxyTargets.go b/service/rds/api_op_RegisterDBProxyTargets.go index 8696b37cf91..7891e386d36 100644 --- a/service/rds/api_op_RegisterDBProxyTargets.go +++ b/service/rds/api_op_RegisterDBProxyTargets.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup. +// Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup . func (c *Client) RegisterDBProxyTargets(ctx context.Context, params *RegisterDBProxyTargetsInput, optFns ...func(*Options)) (*RegisterDBProxyTargetsOutput, error) { if params == nil { params = &RegisterDBProxyTargetsInput{} @@ -29,7 +29,7 @@ func (c *Client) RegisterDBProxyTargets(ctx context.Context, params *RegisterDBP type RegisterDBProxyTargetsInput struct { - // The identifier of the DBProxy that is associated with the DBProxyTargetGroup. + // The identifier of the DBProxy that is associated with the DBProxyTargetGroup . // // This member is required. DBProxyName *string @@ -40,7 +40,7 @@ type RegisterDBProxyTargetsInput struct { // One or more DB instance identifiers. DBInstanceIdentifiers []string - // The identifier of the DBProxyTargetGroup. + // The identifier of the DBProxyTargetGroup . TargetGroupName *string noSmithyDocumentSerde diff --git a/service/rds/api_op_RemoveFromGlobalCluster.go b/service/rds/api_op_RemoveFromGlobalCluster.go index 0f2d54bc601..7685ad8e1b0 100644 --- a/service/rds/api_op_RemoveFromGlobalCluster.go +++ b/service/rds/api_op_RemoveFromGlobalCluster.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches an Aurora secondary cluster from an Aurora global database cluster. The -// cluster becomes a standalone cluster with read-write capability instead of being -// read-only and receiving data from a primary cluster in a different Region. This -// action only applies to Aurora DB clusters. +// Detaches an Aurora secondary cluster from an Aurora global database cluster. +// The cluster becomes a standalone cluster with read-write capability instead of +// being read-only and receiving data from a primary cluster in a different Region. +// This action only applies to Aurora DB clusters. func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFromGlobalClusterInput, optFns ...func(*Options)) (*RemoveFromGlobalClusterOutput, error) { if params == nil { params = &RemoveFromGlobalClusterInput{} diff --git a/service/rds/api_op_RemoveRoleFromDBCluster.go b/service/rds/api_op_RemoveRoleFromDBCluster.go index 7b0a2809048..c810c2dd239 100644 --- a/service/rds/api_op_RemoveRoleFromDBCluster.go +++ b/service/rds/api_op_RemoveRoleFromDBCluster.go @@ -12,11 +12,9 @@ import ( // Removes the asssociation of an Amazon Web Services Identity and Access // Management (IAM) role from a DB cluster. For more information on Amazon Aurora -// DB clusters, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) RemoveRoleFromDBCluster(ctx context.Context, params *RemoveRoleFromDBClusterInput, optFns ...func(*Options)) (*RemoveRoleFromDBClusterOutput, error) { if params == nil { @@ -41,14 +39,14 @@ type RemoveRoleFromDBClusterInput struct { DBClusterIdentifier *string // The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora - // DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole. + // DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole . // // This member is required. RoleArn *string // The name of the feature for the DB cluster that the IAM role is to be // disassociated from. For information about supported feature names, see - // DBEngineVersion. + // DBEngineVersion . FeatureName *string noSmithyDocumentSerde diff --git a/service/rds/api_op_RemoveRoleFromDBInstance.go b/service/rds/api_op_RemoveRoleFromDBInstance.go index 4b70e42e53e..5aed2316ef7 100644 --- a/service/rds/api_op_RemoveRoleFromDBInstance.go +++ b/service/rds/api_op_RemoveRoleFromDBInstance.go @@ -36,13 +36,13 @@ type RemoveRoleFromDBInstanceInput struct { // The name of the feature for the DB instance that the IAM role is to be // disassociated from. For information about supported feature names, see - // DBEngineVersion. + // DBEngineVersion . // // This member is required. FeatureName *string // The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB - // instance, for example, arn:aws:iam::123456789012:role/AccessRole. + // instance, for example, arn:aws:iam::123456789012:role/AccessRole . // // This member is required. RoleArn *string diff --git a/service/rds/api_op_RemoveTagsFromResource.go b/service/rds/api_op_RemoveTagsFromResource.go index a27e28cdff3..3ed7a319626 100644 --- a/service/rds/api_op_RemoveTagsFromResource.go +++ b/service/rds/api_op_RemoveTagsFromResource.go @@ -10,9 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes metadata tags from an Amazon RDS resource. For an overview on tagging an -// Amazon RDS resource, see Tagging Amazon RDS Resources -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) +// Removes metadata tags from an Amazon RDS resource. For an overview on tagging +// an Amazon RDS resource, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html) // in the Amazon RDS User Guide. func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { @@ -32,9 +31,8 @@ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsF type RemoveTagsFromResourceInput struct { // The Amazon RDS resource that the tags are removed from. This value is an Amazon - // Resource Name (ARN). For information about creating an ARN, see Constructing an - // ARN for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) + // Resource Name (ARN). For information about creating an ARN, see Constructing an + // ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) // in the Amazon RDS User Guide. // // This member is required. diff --git a/service/rds/api_op_ResetDBClusterParameterGroup.go b/service/rds/api_op_ResetDBClusterParameterGroup.go index d77d1549b33..c4e14b2b17c 100644 --- a/service/rds/api_op_ResetDBClusterParameterGroup.go +++ b/service/rds/api_op_ResetDBClusterParameterGroup.go @@ -11,20 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group to the default value. To -// reset specific parameters submit a list of the following: ParameterName and -// ApplyMethod. To reset the entire DB cluster parameter group, specify the +// Modifies the parameters of a DB cluster parameter group to the default value. +// To reset specific parameters submit a list of the following: ParameterName and +// ApplyMethod . To reset the entire DB cluster parameter group, specify the // DBClusterParameterGroupName and ResetAllParameters parameters. When resetting // the entire group, dynamic parameters are updated immediately and static // parameters are set to pending-reboot to take effect on the next DB instance -// restart or RebootDBInstance request. You must call RebootDBInstance for every DB -// instance in your DB cluster that you want the updated static parameter to apply -// to. For more information on Amazon Aurora DB clusters, see What is Amazon -// Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// restart or RebootDBInstance request. You must call RebootDBInstance for every +// DB instance in your DB cluster that you want the updated static parameter to +// apply to. For more information on Amazon Aurora DB clusters, see What is Amazon +// Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, optFns ...func(*Options)) (*ResetDBClusterParameterGroupOutput, error) { if params == nil { @@ -49,8 +47,8 @@ type ResetDBClusterParameterGroupInput struct { DBClusterParameterGroupName *string // A list of parameter names in the DB cluster parameter group to reset to the - // default values. You can't use this parameter if the ResetAllParameters parameter - // is enabled. + // default values. You can't use this parameter if the ResetAllParameters + // parameter is enabled. Parameters []types.Parameter // A value that indicates whether to reset all parameters in the DB cluster @@ -64,17 +62,10 @@ type ResetDBClusterParameterGroupInput struct { type ResetDBClusterParameterGroupOutput struct { // The name of the DB cluster parameter group. Constraints: - // - // * Must be 1 to 255 - // letters or numbers. - // - // * First character must be a letter - // - // * Can't end with a - // hyphen or contain two consecutive hyphens - // - // This value is stored as a lowercase - // string. + // - Must be 1 to 255 letters or numbers. + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // This value is stored as a lowercase string. DBClusterParameterGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ResetDBParameterGroup.go b/service/rds/api_op_ResetDBParameterGroup.go index f485eeb0085..b332e45bd8d 100644 --- a/service/rds/api_op_ResetDBParameterGroup.go +++ b/service/rds/api_op_ResetDBParameterGroup.go @@ -13,7 +13,7 @@ import ( // Modifies the parameters of a DB parameter group to the engine/system default // value. To reset specific parameters, provide a list of the following: -// ParameterName and ApplyMethod. To reset the entire DB parameter group, specify +// ParameterName and ApplyMethod . To reset the entire DB parameter group, specify // the DBParameterGroup name and ResetAllParameters parameters. When resetting the // entire group, dynamic parameters are updated immediately and static parameters // are set to pending-reboot to take effect on the next DB instance restart or @@ -36,29 +36,27 @@ func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParam type ResetDBParameterGroupInput struct { // The name of the DB parameter group. Constraints: - // - // * Must match the name of an - // existing DBParameterGroup. + // - Must match the name of an existing DBParameterGroup . // // This member is required. DBParameterGroupName *string // To reset the entire DB parameter group, specify the DBParameterGroup name and // ResetAllParameters parameters. To reset specific parameters, provide a list of - // the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be - // modified in a single request. MySQL Valid Values (for Apply method): immediate | - // pending-reboot You can use the immediate value with dynamic parameters only. You - // can use the pending-reboot value for both dynamic and static parameters, and - // changes are applied when DB instance reboots. MariaDB Valid Values (for Apply - // method): immediate | pending-reboot You can use the immediate value with dynamic - // parameters only. You can use the pending-reboot value for both dynamic and - // static parameters, and changes are applied when DB instance reboots. Oracle + // the following: ParameterName and ApplyMethod . A maximum of 20 parameters can be + // modified in a single request. MySQL Valid Values (for Apply method): immediate + // | pending-reboot You can use the immediate value with dynamic parameters only. + // You can use the pending-reboot value for both dynamic and static parameters, + // and changes are applied when DB instance reboots. MariaDB Valid Values (for + // Apply method): immediate | pending-reboot You can use the immediate value with + // dynamic parameters only. You can use the pending-reboot value for both dynamic + // and static parameters, and changes are applied when DB instance reboots. Oracle // Valid Values (for Apply method): pending-reboot Parameters []types.Parameter - // A value that indicates whether to reset all parameters in the DB parameter group - // to default values. By default, all parameters in the DB parameter group are - // reset to default values. + // A value that indicates whether to reset all parameters in the DB parameter + // group to default values. By default, all parameters in the DB parameter group + // are reset to default values. ResetAllParameters bool noSmithyDocumentSerde diff --git a/service/rds/api_op_RestoreDBClusterFromS3.go b/service/rds/api_op_RestoreDBClusterFromS3.go index 9cbf6d7818c..aa98a81e0b3 100644 --- a/service/rds/api_op_RestoreDBClusterFromS3.go +++ b/service/rds/api_op_RestoreDBClusterFromS3.go @@ -14,16 +14,14 @@ import ( // Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 // bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the // data must be created using the Percona XtraBackup utility as described in -// Migrating Data from MySQL by Using an Amazon S3 Bucket -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3) +// Migrating Data from MySQL by Using an Amazon S3 Bucket (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3) // in the Amazon Aurora User Guide. This action only restores the DB cluster, not // the DB instances for that DB cluster. You must invoke the CreateDBInstance // action to create DB instances for the restored DB cluster, specifying the -// identifier of the restored DB cluster in DBClusterIdentifier. You can create DB +// identifier of the restored DB cluster in DBClusterIdentifier . You can create DB // instances only after the RestoreDBClusterFromS3 action has completed and the DB -// cluster is available. For more information on Amazon Aurora, see What is Amazon -// Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// cluster is available. For more information on Amazon Aurora, see What is Amazon +// Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. // The source DB engine must be MySQL. func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBClusterFromS3Input, optFns ...func(*Options)) (*RestoreDBClusterFromS3Output, error) { @@ -45,17 +43,10 @@ type RestoreDBClusterFromS3Input struct { // The name of the DB cluster to create from the source data in the Amazon S3 // bucket. This parameter isn't case-sensitive. Constraints: - // - // * Must contain from 1 - // to 63 letters, numbers, or hyphens. - // - // * First character must be a letter. - // - // * - // Can't end with a hyphen or contain two consecutive hyphens. - // - // Example: - // my-cluster1 + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string @@ -67,14 +58,9 @@ type RestoreDBClusterFromS3Input struct { Engine *string // The name of the master user for the restored DB cluster. Constraints: - // - // * Must be - // 1 to 16 letters or numbers. - // - // * First character must be a letter. - // - // * Can't be a - // reserved word for the chosen database engine. + // - Must be 1 to 16 letters or numbers. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. // // This member is required. MasterUsername *string @@ -99,7 +85,7 @@ type RestoreDBClusterFromS3Input struct { SourceEngine *string // The version of the database that the backup files were created from. MySQL - // versions 5.5, 5.6, and 5.7 are supported. Example: 5.6.40, 5.7.28 + // versions 5.5, 5.6, and 5.7 are supported. Example: 5.6.40 , 5.7.28 // // This member is required. SourceEngineVersion *string @@ -108,19 +94,16 @@ type RestoreDBClusterFromS3Input struct { // can be created. AvailabilityZones []string - // The target backtrack window, in seconds. To disable backtracking, set this value - // to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. + // The target backtrack window, in seconds. To disable backtracking, set this + // value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. // Default: 0 Constraints: - // - // * If specified, this value must be set to a number from - // 0 to 259,200 (72 hours). + // - If specified, this value must be set to a number from 0 to 259,200 (72 + // hours). BacktrackWindow *int64 // The number of days for which automated backups of the restored DB cluster are // retained. You must specify a minimum value of 1. Default: 1 Constraints: - // - // * Must - // be a value from 1 to 35 + // - Must be a value from 1 to 35 BackupRetentionPeriod *int32 // A value that indicates that the restored DB cluster should be associated with @@ -133,9 +116,7 @@ type RestoreDBClusterFromS3Input struct { // The name of the DB cluster parameter group to associate with the restored DB // cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: - // - // * - // If supplied, must match the name of an existing DBClusterParameterGroup. + // - If supplied, must match the name of an existing DBClusterParameterGroup. DBClusterParameterGroupName *string // A DB subnet group to associate with the restored DB cluster. Constraints: If @@ -154,8 +135,7 @@ type RestoreDBClusterFromS3Input struct { // Specify the Active Directory directory ID to restore the DB cluster in. The // domain must be created prior to this operation. For Amazon Aurora DB clusters, // Amazon RDS can use Kerberos Authentication to authenticate users that connect to - // the DB cluster. For more information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) + // the DB cluster. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. Domain *string @@ -165,25 +145,23 @@ type RestoreDBClusterFromS3Input struct { // The list of logs that the restored DB cluster is to export to CloudWatch Logs. // The values in the list depend on the DB engine being used. Aurora MySQL Possible - // values are audit, error, general, and slowquery. For more information about + // values are audit , error , general , and slowquery . For more information about // exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to - // Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. EnableIAMDatabaseAuthentication *bool // The version number of the database engine to use. To list all of the available // engine versions for aurora-mysql (MySQL 5.7-compatible and MySQL 8.0-compatible - // Aurora), use the following command: aws rds describe-db-engine-versions --engine - // aurora-mysql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Examples: - // 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0 + // Aurora), use the following command: aws rds describe-db-engine-versions + // --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" Aurora MySQL + // Examples: 5.7.mysql_aurora.2.07.1 , 8.0.mysql_aurora.3.02.0 EngineVersion *string // The Amazon Web Services KMS key identifier for an encrypted DB cluster. The @@ -197,27 +175,19 @@ type RestoreDBClusterFromS3Input struct { KmsKeyId *string // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Web Services Secrets Manager. For more information, see Password management + // with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) + // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. Constraints: - // - // * Can't manage the master user - // password with Amazon Web Services Secrets Manager if MasterUserPassword is - // specified. + // - Can't manage the master user password with Amazon Web Services Secrets + // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool // The password for the master database user. This password can contain any // printable ASCII character except "/", """, or "@". Constraints: - // - // * Must contain - // from 8 to 41 characters. - // - // * Can't be specified if ManageMasterUserPassword is - // turned on. + // - Must contain from 8 to 41 characters. + // - Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is @@ -226,7 +196,7 @@ type RestoreDBClusterFromS3Input struct { // Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key // identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To // use a KMS key in a different Amazon Web Services account, specify the key ARN or - // alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the + // alias ARN. If you don't specify MasterUserSecretKmsKeyId , then the // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a // different Amazon Web Services account, then you can't use the aws/secretsmanager // KMS key to encrypt the secret, and you must use a customer managed KMS key. @@ -236,16 +206,12 @@ type RestoreDBClusterFromS3Input struct { MasterUserSecretKmsKeyId *string // The network type of the DB cluster. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. NetworkType *string @@ -262,27 +228,19 @@ type RestoreDBClusterFromS3Input struct { // The daily time range during which automated backups are created if automated // backups are enabled using the BackupRetentionPeriod parameter. The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon - // Web Services Region. To view the time blocks available, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) + // Web Services Region. To view the time blocks available, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) // in the Amazon Aurora User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a // 30-minute window selected at random from an 8-hour block of time for each Amazon // Web Services Region, occurring on a random day of the week. To see the time - // blocks available, see Adjusting the Preferred Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) + // blocks available, see Adjusting the Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) // in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. // Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string @@ -294,17 +252,15 @@ type RestoreDBClusterFromS3Input struct { S3Prefix *string // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For - // more information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // A value that indicates whether the restored DB cluster is encrypted. StorageEncrypted *bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // A list of EC2 VPC security groups to associate with the restored DB cluster. @@ -317,19 +273,17 @@ type RestoreDBClusterFromS3Output struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_RestoreDBClusterFromSnapshot.go b/service/rds/api_op_RestoreDBClusterFromSnapshot.go index bafa1d58fcb..fdfcb1dbd8b 100644 --- a/service/rds/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/rds/api_op_RestoreDBClusterFromSnapshot.go @@ -17,14 +17,12 @@ import ( // default security group. This action only restores the DB cluster, not the DB // instances for that DB cluster. You must invoke the CreateDBInstance action to // create DB instances for the restored DB cluster, specifying the identifier of -// the restored DB cluster in DBClusterIdentifier. You can create DB instances only -// after the RestoreDBClusterFromSnapshot action has completed and the DB cluster -// is available. For more information on Amazon Aurora DB clusters, see What is -// Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// the restored DB cluster in DBClusterIdentifier . You can create DB instances +// only after the RestoreDBClusterFromSnapshot action has completed and the DB +// cluster is available. For more information on Amazon Aurora DB clusters, see +// What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) { if params == nil { @@ -45,17 +43,10 @@ type RestoreDBClusterFromSnapshotInput struct { // The name of the DB cluster to create from the DB snapshot or DB cluster // snapshot. This parameter isn't case-sensitive. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * - // Can't end with a hyphen or contain two consecutive hyphens - // - // Example: - // my-snapshot-id Valid for: Aurora DB clusters and Multi-AZ DB clusters + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // Example: my-snapshot-id Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. DBClusterIdentifier *string @@ -71,26 +62,21 @@ type RestoreDBClusterFromSnapshotInput struct { // can use either the name or the Amazon Resource Name (ARN) to specify a DB // cluster snapshot. However, you can use only the ARN to specify a DB snapshot. // Constraints: - // - // * Must match the identifier of an existing Snapshot. - // - // Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // - Must match the identifier of an existing Snapshot. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. SnapshotIdentifier *string - // Provides the list of Availability Zones (AZs) where instances in the restored DB - // cluster can be created. Valid for: Aurora DB clusters only + // Provides the list of Availability Zones (AZs) where instances in the restored + // DB cluster can be created. Valid for: Aurora DB clusters only AvailabilityZones []string - // The target backtrack window, in seconds. To disable backtracking, set this value - // to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. + // The target backtrack window, in seconds. To disable backtracking, set this + // value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. // Default: 0 Constraints: - // - // * If specified, this value must be set to a number from - // 0 to 259,200 (72 hours). - // + // - If specified, this value must be set to a number from 0 to 259,200 (72 + // hours). // Valid for: Aurora DB clusters only BacktrackWindow *int64 @@ -103,28 +89,19 @@ type RestoreDBClusterFromSnapshotInput struct { // cluster, for example db.m6gd.xlarge. Not all DB instance classes are available // in all Amazon Web Services Regions, or for all database engines. For the full // list of DB instance classes, and availability for your engine, see DB Instance - // Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only DBClusterInstanceClass *string - // The name of the DB cluster parameter group to associate with this DB cluster. If - // this argument is omitted, the default DB cluster parameter group for the + // The name of the DB cluster parameter group to associate with this DB cluster. + // If this argument is omitted, the default DB cluster parameter group for the // specified engine is used. Constraints: - // - // * If supplied, must match the name of an - // existing default DB cluster parameter group. - // - // * Must be 1 to 255 letters, - // numbers, or hyphens. - // - // * First character must be a letter. - // - // * Can't end with a - // hyphen or contain two consecutive hyphens. - // - // Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // - If supplied, must match the name of an existing default DB cluster + // parameter group. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string // The name of the DB subnet group to use for the new DB cluster. Constraints: If @@ -132,8 +109,8 @@ type RestoreDBClusterFromSnapshotInput struct { // mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters DBSubnetGroupName *string - // The database name for the restored DB cluster. Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // The database name for the restored DB cluster. Valid for: Aurora DB clusters + // and Multi-AZ DB clusters DatabaseName *string // A value that indicates whether the DB cluster has deletion protection enabled. @@ -145,8 +122,7 @@ type RestoreDBClusterFromSnapshotInput struct { // Specify the Active Directory directory ID to restore the DB cluster in. The // domain must be created prior to this operation. Currently, only MySQL, Microsoft // SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active - // Directory Domain. For more information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // Directory Domain. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. Valid for: Aurora DB clusters only Domain *string @@ -156,31 +132,27 @@ type RestoreDBClusterFromSnapshotInput struct { // The list of logs that the restored DB cluster is to export to Amazon CloudWatch // Logs. The values in the list depend on the DB engine being used. RDS for MySQL - // Possible values are error, general, and slowquery. RDS for PostgreSQL Possible - // values are postgresql and upgrade. Aurora MySQL Possible values are audit, - // error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. - // For more information about exporting CloudWatch Logs for Amazon RDS, see - // Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Possible values are error , general , and slowquery . RDS for PostgreSQL + // Possible values are postgresql and upgrade . Aurora MySQL Possible values are + // audit , error , general , and slowquery . Aurora PostgreSQL Possible value is + // postgresql . For more information about exporting CloudWatch Logs for Amazon + // RDS, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. For more information about exporting CloudWatch - // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters EnableCloudwatchLogsExports []string - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool - // The DB engine mode of the DB cluster, either provisioned, serverless, - // parallelquery, global, or multimaster. For more information, see - // CreateDBCluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). - // Valid for: Aurora DB clusters only + // The DB engine mode of the DB cluster, either provisioned , serverless , + // parallelquery , global , or multimaster . For more information, see + // CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) + // . Valid for: Aurora DB clusters only EngineMode *string // The version of the database engine to use for the new DB cluster. If you don't @@ -198,69 +170,55 @@ type RestoreDBClusterFromSnapshotInput struct { // for RDS for PostgreSQL, use the following command: aws rds // describe-db-engine-versions --engine postgres --query // "DBEngineVersions[].EngineVersion" Aurora MySQL See Database engine updates for - // Amazon Aurora MySQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) + // Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) // in the Amazon Aurora User Guide. Aurora PostgreSQL See Amazon Aurora PostgreSQL - // releases and engine versions - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) - // in the Amazon Aurora User Guide. MySQL See Amazon RDS for MySQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) + // releases and engine versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) + // in the Amazon Aurora User Guide. MySQL See Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) // in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions - // and extensions - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) + // and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) // in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters EngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to be // initially allocated for each DB instance in the Multi-AZ DB cluster. For - // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 // of the storage amount for the DB instance. Valid for: Aurora DB clusters and // Multi-AZ DB clusters Iops *int32 - // The Amazon Web Services KMS key identifier to use when restoring an encrypted DB - // cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS - // key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. - // To use a KMS key in a different Amazon Web Services account, specify the key ARN - // or alias ARN. When you don't specify a value for the KmsKeyId parameter, then - // the following occurs: - // - // * If the DB snapshot or DB cluster snapshot in - // SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using - // the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - // - // * - // If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, - // then the restored DB cluster isn't encrypted. - // - // Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // The Amazon Web Services KMS key identifier to use when restoring an encrypted + // DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services + // KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS + // key. To use a KMS key in a different Amazon Web Services account, specify the + // key ARN or alias ARN. When you don't specify a value for the KmsKeyId + // parameter, then the following occurs: + // - If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is + // encrypted, then the restored DB cluster is encrypted using the KMS key that was + // used to encrypt the DB snapshot or DB cluster snapshot. + // - If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't + // encrypted, then the restored DB cluster isn't encrypted. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string // The network type of the DB cluster. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only NetworkType *string - // The name of the option group to use for the restored DB cluster. DB clusters are - // associated with a default option group that can't be modified. + // The name of the option group to use for the restored DB cluster. DB clusters + // are associated with a default option group that can't be modified. OptionGroupName *string // The port number on which the new DB cluster accepts connections. Constraints: - // This value must be 1150-65535 Default: The same port as the original DB cluster. - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // This value must be 1150-65535 Default: The same port as the original DB + // cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters Port *int32 // A value that indicates whether the DB cluster is publicly accessible. When the @@ -274,26 +232,17 @@ type RestoreDBClusterFromSnapshotInput struct { // private IP address. Default: The default behavior varies depending on whether // DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and // PubliclyAccessible isn't specified, the following applies: - // - // * If the default VPC - // in the target Region doesn’t have an internet gateway attached to it, the DB - // cluster is private. - // - // * If the default VPC in the target Region has an internet - // gateway attached to it, the DB cluster is public. - // - // If DBSubnetGroupName is - // specified, and PubliclyAccessible isn't specified, the following applies: - // - // * If - // the subnets are part of a VPC that doesn’t have an internet gateway attached to - // it, the DB cluster is private. - // - // * If the subnets are part of a VPC that has an - // internet gateway attached to it, the DB cluster is public. - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - If the default VPC in the target Region doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the default VPC in the target Region has an internet gateway attached to + // it, the DB cluster is public. + // If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the + // following applies: + // - If the subnets are part of a VPC that doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the subnets are part of a VPC that has an internet gateway attached to + // it, the DB cluster is public. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters PubliclyAccessible *bool // For DB clusters in serverless DB engine mode, the scaling properties of the DB @@ -301,8 +250,7 @@ type RestoreDBClusterFromSnapshotInput struct { ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For - // more information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration @@ -316,8 +264,8 @@ type RestoreDBClusterFromSnapshotInput struct { // clusters and Multi-AZ DB clusters Tags []types.Tag - // A list of VPC security groups that the new DB cluster will belong to. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // A list of VPC security groups that the new DB cluster will belong to. Valid + // for: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -327,19 +275,17 @@ type RestoreDBClusterFromSnapshotOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_RestoreDBClusterToPointInTime.go b/service/rds/api_op_RestoreDBClusterToPointInTime.go index d67fd95de13..5fb78a3000c 100644 --- a/service/rds/api_op_RestoreDBClusterToPointInTime.go +++ b/service/rds/api_op_RestoreDBClusterToPointInTime.go @@ -20,14 +20,12 @@ import ( // restores the DB cluster, not the DB instances for that DB cluster. You must // invoke the CreateDBInstance action to create DB instances for the restored DB // cluster, specifying the identifier of the restored DB cluster in -// DBClusterIdentifier. You can create DB instances only after the +// DBClusterIdentifier . You can create DB instances only after the // RestoreDBClusterToPointInTime action has completed and the DB cluster is -// available. For more information on Amazon Aurora DB clusters, see What is -// Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// available. For more information on Amazon Aurora DB clusters, see What is +// Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ DB cluster deployments -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error) { if params == nil { @@ -47,38 +45,25 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest type RestoreDBClusterToPointInTimeInput struct { // The name of the new DB cluster to be created. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * - // Can't end with a hyphen or contain two consecutive hyphens - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. DBClusterIdentifier *string // The identifier of the source DB cluster from which to restore. Constraints: - // - // * - // Must match the identifier of an existing DBCluster. - // - // Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // - Must match the identifier of an existing DBCluster. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. SourceDBClusterIdentifier *string - // The target backtrack window, in seconds. To disable backtracking, set this value - // to 0. Default: 0 Constraints: - // - // * If specified, this value must be set to a - // number from 0 to 259,200 (72 hours). - // + // The target backtrack window, in seconds. To disable backtracking, set this + // value to 0. Default: 0 Constraints: + // - If specified, this value must be set to a number from 0 to 259,200 (72 + // hours). // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 @@ -91,28 +76,18 @@ type RestoreDBClusterToPointInTimeInput struct { // cluster, for example db.m6gd.xlarge. Not all DB instance classes are available // in all Amazon Web Services Regions, or for all database engines. For the full // list of DB instance classes, and availability for your engine, see DB instance - // class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only DBClusterInstanceClass *string - // The name of the DB cluster parameter group to associate with this DB cluster. If - // this argument is omitted, the default DB cluster parameter group for the + // The name of the DB cluster parameter group to associate with this DB cluster. + // If this argument is omitted, the default DB cluster parameter group for the // specified engine is used. Constraints: - // - // * If supplied, must match the name of an - // existing DB cluster parameter group. - // - // * Must be 1 to 255 letters, numbers, or - // hyphens. - // - // * First character must be a letter. - // - // * Can't end with a hyphen or - // contain two consecutive hyphens. - // - // Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // - If supplied, must match the name of an existing DB cluster parameter group. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string // The DB subnet group name to use for the new DB cluster. Constraints: If @@ -129,8 +104,7 @@ type RestoreDBClusterToPointInTimeInput struct { // Specify the Active Directory directory ID to restore the DB cluster in. The // domain must be created prior to this operation. For Amazon Aurora DB clusters, // Amazon RDS can use Kerberos Authentication to authenticate users that connect to - // the DB cluster. For more information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) + // the DB cluster. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only Domain *string @@ -140,75 +114,63 @@ type RestoreDBClusterToPointInTimeInput struct { // The list of logs that the restored DB cluster is to export to CloudWatch Logs. // The values in the list depend on the DB engine being used. RDS for MySQL - // Possible values are error, general, and slowquery. RDS for PostgreSQL Possible - // values are postgresql and upgrade. Aurora MySQL Possible values are audit, - // error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. - // For more information about exporting CloudWatch Logs for Amazon RDS, see - // Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Possible values are error , general , and slowquery . RDS for PostgreSQL + // Possible values are postgresql and upgrade . Aurora MySQL Possible values are + // audit , error , general , and slowquery . Aurora PostgreSQL Possible value is + // postgresql . For more information about exporting CloudWatch Logs for Amazon + // RDS, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. For more information about exporting CloudWatch - // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB // clusters EnableCloudwatchLogsExports []string - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information, see IAM Database Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool - // The engine mode of the new cluster. Specify provisioned or serverless, depending - // on the type of the cluster you are creating. You can create an Aurora Serverless - // v1 clone from a provisioned cluster, or a provisioned clone from an Aurora - // Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 + // The engine mode of the new cluster. Specify provisioned or serverless , + // depending on the type of the cluster you are creating. You can create an Aurora + // Serverless v1 clone from a provisioned cluster, or a provisioned clone from an + // Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 // cluster, the original cluster must be an Aurora Serverless v1 cluster or an // encrypted provisioned cluster. Valid for: Aurora DB clusters only EngineMode *string // The amount of Provisioned IOPS (input/output operations per second) to be // initially allocated for each DB instance in the Multi-AZ DB cluster. For - // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // information about valid IOPS values, see Amazon RDS Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50 // of the storage amount for the DB instance. Valid for: Multi-AZ DB clusters only Iops *int32 - // The Amazon Web Services KMS key identifier to use when restoring an encrypted DB - // cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier - // is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS - // key in a different Amazon Web Services account, specify the key ARN or alias - // ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a - // KMS key that is different from the KMS key used to encrypt the source DB + // The Amazon Web Services KMS key identifier to use when restoring an encrypted + // DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key + // identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To + // use a KMS key in a different Amazon Web Services account, specify the key ARN or + // alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster + // with a KMS key that is different from the KMS key used to encrypt the source DB // cluster. The new DB cluster is encrypted with the KMS key identified by the // KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, // then the following occurs: - // - // * If the DB cluster is encrypted, then the restored - // DB cluster is encrypted using the KMS key that was used to encrypt the source DB - // cluster. - // - // * If the DB cluster isn't encrypted, then the restored DB cluster - // isn't encrypted. - // - // If DBClusterIdentifier refers to a DB cluster that isn't - // encrypted, then the restore request is rejected. Valid for: Aurora DB clusters - // and Multi-AZ DB clusters + // - If the DB cluster is encrypted, then the restored DB cluster is encrypted + // using the KMS key that was used to encrypt the source DB cluster. + // - If the DB cluster isn't encrypted, then the restored DB cluster isn't + // encrypted. + // If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the + // restore request is rejected. Valid for: Aurora DB clusters and Multi-AZ DB + // clusters KmsKeyId *string // The network type of the DB cluster. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only NetworkType *string @@ -217,7 +179,7 @@ type RestoreDBClusterToPointInTimeInput struct { OptionGroupName *string // The port number on which the new DB cluster accepts connections. Constraints: A - // value from 1150-65535. Default: The default port for the engine. Valid for: + // value from 1150-65535 . Default: The default port for the engine. Valid for: // Aurora DB clusters and Multi-AZ DB clusters Port *int32 @@ -232,60 +194,39 @@ type RestoreDBClusterToPointInTimeInput struct { // private IP address. Default: The default behavior varies depending on whether // DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and // PubliclyAccessible isn't specified, the following applies: - // - // * If the default VPC - // in the target Region doesn’t have an internet gateway attached to it, the DB - // cluster is private. - // - // * If the default VPC in the target Region has an internet - // gateway attached to it, the DB cluster is public. - // - // If DBSubnetGroupName is - // specified, and PubliclyAccessible isn't specified, the following applies: - // - // * If - // the subnets are part of a VPC that doesn’t have an internet gateway attached to - // it, the DB cluster is private. - // - // * If the subnets are part of a VPC that has an - // internet gateway attached to it, the DB cluster is public. - // - // Valid for: Multi-AZ - // DB clusters only + // - If the default VPC in the target Region doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the default VPC in the target Region has an internet gateway attached to + // it, the DB cluster is public. + // If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the + // following applies: + // - If the subnets are part of a VPC that doesn’t have an internet gateway + // attached to it, the DB cluster is private. + // - If the subnets are part of a VPC that has an internet gateway attached to + // it, the DB cluster is public. + // Valid for: Multi-AZ DB clusters only PubliclyAccessible *bool // The date and time to restore the DB cluster to. Valid Values: Value must be a // time in Universal Coordinated Time (UTC) format Constraints: - // - // * Must be before - // the latest restorable time for the DB instance - // - // * Must be specified if - // UseLatestRestorableTime parameter isn't provided - // - // * Can't be specified if the - // UseLatestRestorableTime parameter is enabled - // - // * Can't be specified if the - // RestoreType parameter is copy-on-write - // - // Example: 2015-03-07T23:45:00Z Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // - Must be before the latest restorable time for the DB instance + // - Must be specified if UseLatestRestorableTime parameter isn't provided + // - Can't be specified if the UseLatestRestorableTime parameter is enabled + // - Can't be specified if the RestoreType parameter is copy-on-write + // Example: 2015-03-07T23:45:00Z Valid for: Aurora DB clusters and Multi-AZ DB + // clusters RestoreToTime *time.Time // The type of restore to be performed. You can specify one of the following // values: - // - // * full-copy - The new DB cluster is restored as a full copy of the - // source DB cluster. - // - // * copy-on-write - The new DB cluster is restored as a clone - // of the source DB cluster. - // - // Constraints: You can't specify copy-on-write if the - // engine version of the source DB cluster is earlier than 1.11. If you don't - // specify a RestoreType value, then the new DB cluster is restored as a full copy - // of the source DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters + // - full-copy - The new DB cluster is restored as a full copy of the source DB + // cluster. + // - copy-on-write - The new DB cluster is restored as a clone of the source DB + // cluster. + // Constraints: You can't specify copy-on-write if the engine version of the + // source DB cluster is earlier than 1.11. If you don't specify a RestoreType + // value, then the new DB cluster is restored as a full copy of the source DB + // cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters RestoreType *string // For DB clusters in serverless DB engine mode, the scaling properties of the DB @@ -293,8 +234,7 @@ type RestoreDBClusterToPointInTimeInput struct { ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For - // more information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration @@ -303,9 +243,8 @@ type RestoreDBClusterToPointInTimeInput struct { // parameter is required. Default: io1 Valid for: Multi-AZ DB clusters only StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // A value that indicates whether to restore the DB cluster to the latest @@ -325,19 +264,17 @@ type RestoreDBClusterToPointInTimeOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go index 72ba581c9f0..18db5364a4b 100644 --- a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go +++ b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go @@ -27,7 +27,7 @@ import ( // instance created from the snapshot. If you are restoring from a shared manual DB // snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. // This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, -// use RestoreDBClusterFromSnapshot. +// use RestoreDBClusterFromSnapshot . func (c *Client) RestoreDBInstanceFromDBSnapshot(ctx context.Context, params *RestoreDBInstanceFromDBSnapshotInput, optFns ...func(*Options)) (*RestoreDBInstanceFromDBSnapshotOutput, error) { if params == nil { params = &RestoreDBInstanceFromDBSnapshotInput{} @@ -47,15 +47,9 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Name of the DB instance to create from the DB snapshot. This parameter isn't // case-sensitive. Constraints: - // - // * Must contain from 1 to 63 numbers, letters, or - // hyphens - // - // * First character must be a letter - // - // * Can't end with a hyphen or - // contain two consecutive hyphens - // + // - Must contain from 1 to 63 numbers, letters, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // Example: my-snapshot-id // // This member is required. @@ -80,73 +74,52 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Specifies where automated backups and manual snapshots are stored for the // restored DB instance. Possible values are outposts (Amazon Web Services - // Outposts) and region (Amazon Web Services Region). The default is region. For - // more information, see Working with Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. + // Outposts) and region (Amazon Web Services Region). The default is region . For + // more information, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. BackupTarget *string - // A value that indicates whether to copy all tags from the restored DB instance to - // snapshots of the DB instance. In most cases, tags aren't copied by default. + // A value that indicates whether to copy all tags from the restored DB instance + // to snapshots of the DB instance. In most cases, tags aren't copied by default. // However, when you restore a DB instance from a DB snapshot, RDS checks whether // you specify new tags. If yes, the new tags are added to the restored DB // instance. If there are no new tags, RDS looks for the tags from the source DB // instance for the DB snapshot, and then adds those tags to the restored DB - // instance. For more information, see Copying tags to DB instance snapshots - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags) + // instance. For more information, see Copying tags to DB instance snapshots (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags) // in the Amazon RDS User Guide. CopyTagsToSnapshot *bool // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. The instance profile must meet the following // requirements: - // - // * The profile must exist in your account. - // - // * The profile must - // have an IAM role that Amazon EC2 has permissions to assume. - // - // * The instance - // profile name and the associated IAM role name must start with the prefix - // AWSRDSCustom. - // - // For the list of permissions required for the IAM role, see - // Configure IAM and your VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) + // - The profile must exist in your account. + // - The profile must have an IAM role that Amazon EC2 has permissions to + // assume. + // - The instance profile name and the associated IAM role name must start with + // the prefix AWSRDSCustom . + // For the list of permissions required for the IAM role, see Configure IAM and + // your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. This setting is required for RDS Custom. CustomIamInstanceProfile *string // The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore - // from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster - // deployments - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster + // deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. Constraints: - // - // * Must match the identifier of an - // existing Multi-AZ DB cluster snapshot. - // - // * Can't be specified when - // DBSnapshotIdentifier is specified. - // - // * Must be specified when - // DBSnapshotIdentifier isn't specified. - // - // * If you are restoring from a shared - // manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the - // ARN of the shared snapshot. - // - // * Can't be the identifier of an Aurora DB cluster - // snapshot. - // - // * Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB - // cluster snapshot. + // - Must match the identifier of an existing Multi-AZ DB cluster snapshot. + // - Can't be specified when DBSnapshotIdentifier is specified. + // - Must be specified when DBSnapshotIdentifier isn't specified. + // - If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the + // DBClusterSnapshotIdentifier must be the ARN of the shared snapshot. + // - Can't be the identifier of an Aurora DB cluster snapshot. + // - Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster + // snapshot. DBClusterSnapshotIdentifier *string // The compute and memory capacity of the Amazon RDS DB instance, for example // db.m4.large. Not all DB instance classes are available in all Amazon Web // Services Regions, or for all database engines. For the full list of DB instance - // classes, and availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original // DB instance. DBInstanceClass *string @@ -157,36 +130,21 @@ type RestoreDBInstanceFromDBSnapshotInput struct { DBName *string // The name of the DB parameter group to associate with this DB instance. If you - // don't specify a value for DBParameterGroupName, then RDS uses the default + // don't specify a value for DBParameterGroupName , then RDS uses the default // DBParameterGroup for the specified DB engine. This setting doesn't apply to RDS // Custom. Constraints: - // - // * If supplied, must match the name of an existing - // DBParameterGroup. - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. + // - If supplied, must match the name of an existing DBParameterGroup. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *string // The identifier for the DB snapshot to restore from. Constraints: - // - // * Must match - // the identifier of an existing DBSnapshot. - // - // * Can't be specified when - // DBClusterSnapshotIdentifier is specified. - // - // * Must be specified when - // DBClusterSnapshotIdentifier isn't specified. - // - // * If you are restoring from a - // shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the - // shared DB snapshot. + // - Must match the identifier of an existing DBSnapshot. + // - Can't be specified when DBClusterSnapshotIdentifier is specified. + // - Must be specified when DBClusterSnapshotIdentifier isn't specified. + // - If you are restoring from a shared manual DB snapshot, the + // DBSnapshotIdentifier must be the ARN of the shared DB snapshot. DBSnapshotIdentifier *string // The DB subnet group name to use for the new instance. Constraints: If supplied, @@ -195,16 +153,15 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection *bool // Specify the Active Directory directory ID to restore the DB instance in. The // domain/ must be created prior to this operation. Currently, you can create only // MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active - // Directory Domain. For more information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // Directory Domain. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Domain *string @@ -214,8 +171,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // The list of logs that the restored DB instance is to export to CloudWatch Logs. // The values in the list depend on the DB engine being used. For more information, - // see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableCloudwatchLogsExports []string @@ -225,19 +181,16 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // use cases, a CoIP can provide lower latency for connections to the DB instance // from outside of its virtual private cloud (VPC) on your local network. This // setting doesn't apply to RDS Custom. For more information about RDS on Outposts, - // see Working with Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // is disabled. For more information about IAM database authentication, see IAM - // Database Authentication for MySQL and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping is disabled. For more information about IAM database authentication, see + // IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableIAMDatabaseAuthentication *bool @@ -245,30 +198,17 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // RDS Custom. Default: The same as source Constraint: Must be compatible with the // engine of the source. For example, you can restore a MariaDB 10.1 DB instance // from a MySQL 5.6 snapshot. Valid Values: - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * - // oracle-ee-cdb - // - // * oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * - // sqlserver-se - // - // * sqlserver-ex - // - // * sqlserver-web + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web Engine *string // Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O @@ -277,8 +217,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // converted to a non-PIOPS instance. The conversion takes additional time, though // your DB instance is available for connections before the conversion starts. The // provisioned IOPS value must follow the requirements for your database engine. - // For more information, see Amazon RDS Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // For more information, see Amazon RDS Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000. Iops *int32 @@ -293,16 +232,12 @@ type RestoreDBInstanceFromDBSnapshotInput struct { MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string @@ -329,34 +264,33 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // security group it uses. That public access is not permitted if the security // group assigned to the DB instance doesn't permit it. When the DB instance isn't // publicly accessible, it is an internal DB instance with a DNS name that resolves - // to a private IP address. For more information, see CreateDBInstance. + // to a private IP address. For more information, see CreateDBInstance . PubliclyAccessible *bool - // Specifies the storage throughput value for the DB instance. This setting doesn't - // apply to RDS Custom or Amazon Aurora. + // Specifies the storage throughput value for the DB instance. This setting + // doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. Valid values: - // gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a + // gp2 | gp3 | io1 | standard If you specify io1 or gp3 , you must also include a // value for the Iops parameter. Default: io1 if the Iops parameter is specified, // otherwise gp2 StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // The ARN from the key store with which to associate the instance for TDE // encryption. This setting doesn't apply to RDS Custom. TdeCredentialArn *string - // The password for the given ARN from the key store in order to access the device. - // This setting doesn't apply to RDS Custom. + // The password for the given ARN from the key store in order to access the + // device. This setting doesn't apply to RDS Custom. TdeCredentialPassword *string - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. This setting doesn't apply to RDS Custom. + // A value that indicates whether the DB instance class of the DB instance uses + // its default processor features. This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // A list of EC2 VPC security groups to associate with this DB instance. Default: @@ -369,11 +303,11 @@ type RestoreDBInstanceFromDBSnapshotInput struct { type RestoreDBInstanceFromDBSnapshotOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RestoreDBInstanceFromS3.go b/service/rds/api_op_RestoreDBInstanceFromS3.go index 81fcc087885..7c1190dd826 100644 --- a/service/rds/api_op_RestoreDBInstanceFromS3.go +++ b/service/rds/api_op_RestoreDBInstanceFromS3.go @@ -15,8 +15,7 @@ import ( // databases by using backup files. You can create a backup of your on-premises // database, store it on Amazon Simple Storage Service (Amazon S3), and then // restore the backup file onto a new Amazon RDS DB instance running MySQL. For -// more information, see Importing Data into an Amazon RDS MySQL DB Instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html) +// more information, see Importing Data into an Amazon RDS MySQL DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html) // in the Amazon RDS User Guide. This command doesn't apply to RDS Custom. func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBInstanceFromS3Input, optFns ...func(*Options)) (*RestoreDBInstanceFromS3Output, error) { if params == nil { @@ -35,11 +34,10 @@ func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBI type RestoreDBInstanceFromS3Input struct { - // The compute and memory capacity of the DB instance, for example db.m4.large. Not - // all DB instance classes are available in all Amazon Web Services Regions, or for - // all database engines. For the full list of DB instance classes, and availability - // for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // The compute and memory capacity of the DB instance, for example db.m4.large. + // Not all DB instance classes are available in all Amazon Web Services Regions, or + // for all database engines. For the full list of DB instance classes, and + // availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the // db.t2.micro DB instance class. // @@ -48,15 +46,9 @@ type RestoreDBInstanceFromS3Input struct { // The DB instance identifier. This parameter is stored as a lowercase string. // Constraints: - // - // * Must contain from 1 to 63 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. - // + // - Must contain from 1 to 63 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. // Example: mydbinstance // // This member is required. @@ -73,8 +65,8 @@ type RestoreDBInstanceFromS3Input struct { // This member is required. S3BucketName *string - // An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon - // RDS to access your Amazon S3 bucket. + // An Amazon Web Services Identity and Access Management (IAM) role to allow + // Amazon RDS to access your Amazon S3 bucket. // // This member is required. S3IngestionRoleArn *string @@ -91,7 +83,7 @@ type RestoreDBInstanceFromS3Input struct { SourceEngineVersion *string // The amount of storage (in gibibytes) to allocate initially for the DB instance. - // Follow the allocation rules specified in CreateDBInstance. Be sure to allocate + // Follow the allocation rules specified in CreateDBInstance . Be sure to allocate // enough storage for your new DB instance so that the restore operation can // succeed. You can also allocate additional storage for future growth. AllocatedStorage *int32 @@ -102,9 +94,8 @@ type RestoreDBInstanceFromS3Input struct { AutoMinorVersionUpgrade *bool // The Availability Zone that the DB instance is created in. For information about - // Amazon Web Services Regions and Availability Zones, see Regions and Availability - // Zones - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) + // Amazon Web Services Regions and Availability Zones, see Regions and + // Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) // in the Amazon RDS User Guide. Default: A random, system-chosen Availability Zone // in the endpoint's Amazon Web Services Region. Example: us-east-1d Constraint: // The AvailabilityZone parameter can't be specified if the DB instance is a @@ -114,7 +105,7 @@ type RestoreDBInstanceFromS3Input struct { // The number of days for which automated backups are retained. Setting this // parameter to a positive number enables backups. For more information, see - // CreateDBInstance. + // CreateDBInstance . BackupRetentionPeriod *int32 // A value that indicates whether to copy all tags from the DB instance to @@ -122,12 +113,12 @@ type RestoreDBInstanceFromS3Input struct { CopyTagsToSnapshot *bool // The name of the database to create when the DB instance is created. Follow the - // naming rules specified in CreateDBInstance. + // naming rules specified in CreateDBInstance . DBName *string - // The name of the DB parameter group to associate with this DB instance. If you do - // not specify a value for DBParameterGroupName, then the default DBParameterGroup - // for the specified DB engine is used. + // The name of the DB parameter group to associate with this DB instance. If you + // do not specify a value for DBParameterGroupName , then the default + // DBParameterGroup for the specified DB engine is used. DBParameterGroupName *string // A list of DB security groups to associate with this DB instance. Default: The @@ -140,41 +131,37 @@ type RestoreDBInstanceFromS3Input struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection *bool // The list of logs that the restored DB instance is to export to CloudWatch Logs. // The values in the list depend on the DB engine being used. For more information, - // see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. EnableCloudwatchLogsExports []string - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. For more information about IAM database authentication, see IAM - // Database Authentication for MySQL and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. For more information about IAM database authentication, + // see IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. EnableIAMDatabaseAuthentication *bool // A value that indicates whether to enable Performance Insights for the DB - // instance. For more information, see Using Amazon Performance Insights - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. EnablePerformanceInsights *bool // The version number of the database engine to use. Choose the latest minor // version of your database engine. For information about engine versions, see - // CreateDBInstance, or call DescribeDBEngineVersions. + // CreateDBInstance , or call DescribeDBEngineVersions . EngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to allocate // initially for the DB instance. For information about valid IOPS values, see - // Amazon RDS Provisioned IOPS storage - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) + // Amazon RDS Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. Iops *int32 @@ -188,18 +175,15 @@ type RestoreDBInstanceFromS3Input struct { // KMS key for each Amazon Web Services Region. KmsKeyId *string - // The license model for this DB instance. Use general-public-license. + // The license model for this DB instance. Use general-public-license . LicenseModel *string // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Web Services Secrets Manager. For more information, see Password management + // with Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: - // - // * Can't manage the master user - // password with Amazon Web Services Secrets Manager if MasterUserPassword is - // specified. + // - Can't manage the master user password with Amazon Web Services Secrets + // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool // The password for the master user. The password can include any printable ASCII @@ -217,7 +201,7 @@ type RestoreDBInstanceFromS3Input struct { // Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS // key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. // To use a KMS key in a different Amazon Web Services account, specify the key ARN - // or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the + // or alias ARN. If you don't specify MasterUserSecretKmsKeyId , then the // aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a // different Amazon Web Services account, then you can't use the aws/secretsmanager // KMS key to encrypt the secret, and you must use a customer managed KMS key. @@ -227,21 +211,15 @@ type RestoreDBInstanceFromS3Input struct { MasterUserSecretKmsKeyId *string // The name for the master user. Constraints: - // - // * Must be 1 to 16 letters or - // numbers. - // - // * First character must be a letter. - // - // * Can't be a reserved word for - // the chosen database engine. + // - Must be 1 to 16 letters or numbers. + // - First character must be a letter. + // - Can't be a reserved word for the chosen database engine. MasterUsername *string // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale // the storage of the DB instance. For more information about this setting, - // including limitations that apply to it, see Managing capacity automatically - // with Amazon RDS storage autoscaling - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) + // including limitations that apply to it, see Managing capacity automatically + // with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. MaxAllocatedStorage *int32 @@ -252,13 +230,12 @@ type RestoreDBInstanceFromS3Input struct { // 60 Default: 0 MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to - // Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For - // information on creating a monitoring role, see Setting Up and Enabling Enhanced - // Monitoring - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) - // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than - // 0, then you must supply a MonitoringRoleArn value. + // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics + // to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . + // For information on creating a monitoring role, see Setting Up and Enabling + // Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) + // in the Amazon RDS User Guide. If MonitoringInterval is set to a value other + // than 0, then you must supply a MonitoringRoleArn value. MonitoringRoleArn *string // A value that indicates whether the DB instance is a Multi-AZ deployment. If the @@ -267,16 +244,12 @@ type RestoreDBInstanceFromS3Input struct { MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string @@ -287,74 +260,48 @@ type RestoreDBInstanceFromS3Input struct { // The Amazon Web Services KMS key identifier for encryption of Performance // Insights data. The Amazon Web Services KMS key identifier is the key ARN, key // ID, alias ARN, or alias name for the KMS key. If you do not specify a value for - // PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is - // a default KMS key for your Amazon Web Services account. Your Amazon Web Services - // account has a different default KMS key for each Amazon Web Services Region. + // PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There + // is a default KMS key for your Amazon Web Services account. Your Amazon Web + // Services account has a different default KMS key for each Amazon Web Services + // Region. PerformanceInsightsKMSKeyId *string // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // If you - // specify a retention period such as 94, which isn't a valid value, RDS issues an - // error. + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // If you specify a retention period such as 94, which isn't a valid value, RDS + // issues an error. PerformanceInsightsRetentionPeriod *int32 // The port number on which the database accepts connections. Type: Integer Valid - // Values: 1150-65535 Default: 3306 + // Values: 1150 - 65535 Default: 3306 Port *int32 // The time range each day during which automated backups are created if automated - // backups are enabled. For more information, see Backup window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) + // backups are enabled. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // in the Amazon RDS User Guide. Constraints: - // - // * Must be in the format - // hh24:mi-hh24:mi. - // - // * Must be in Universal Coordinated Time (UTC). - // - // * Must not - // conflict with the preferred maintenance window. - // - // * Must be at least 30 minutes. + // - Must be in the format hh24:mi-hh24:mi . + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred maintenance window. + // - Must be at least 30 minutes. PreferredBackupWindow *string - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // The time range each week during which system maintenance can occur, in + // Universal Coordinated Time (UTC). For more information, see Amazon RDS + // Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) // in the Amazon RDS User Guide. Constraints: - // - // * Must be in the format - // ddd:hh24:mi-ddd:hh24:mi. - // - // * Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. - // - // * - // Must be in Universal Coordinated Time (UTC). - // - // * Must not conflict with the - // preferred backup window. - // - // * Must be at least 30 minutes. + // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . + // - Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // - Must be in Universal Coordinated Time (UTC). + // - Must not conflict with the preferred backup window. + // - Must be at least 30 minutes. PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance @@ -369,7 +316,7 @@ type RestoreDBInstanceFromS3Input struct { // security group it uses. That public access is not permitted if the security // group assigned to the DB instance doesn't permit it. When the DB instance isn't // publicly accessible, it is an internal DB instance with a DNS name that resolves - // to a private IP address. For more information, see CreateDBInstance. + // to a private IP address. For more information, see CreateDBInstance . PubliclyAccessible *bool // The prefix of your Amazon S3 bucket. @@ -378,24 +325,23 @@ type RestoreDBInstanceFromS3Input struct { // A value that indicates whether the new DB instance is encrypted or not. StorageEncrypted *bool - // Specifies the storage throughput value for the DB instance. This setting doesn't - // apply to RDS Custom or Amazon Aurora. + // Specifies the storage throughput value for the DB instance. This setting + // doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. Valid values: - // gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a + // gp2 | gp3 | io1 | standard If you specify io1 or gp3 , you must also include a // value for the Iops parameter. Default: io1 if the Iops parameter is specified; // otherwise gp2 StorageType *string // A list of tags to associate with this DB instance. For more information, see - // Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. + // A value that indicates whether the DB instance class of the DB instance uses + // its default processor features. UseDefaultProcessorFeatures *bool // A list of VPC security groups to associate with this DB instance. @@ -407,11 +353,11 @@ type RestoreDBInstanceFromS3Input struct { type RestoreDBInstanceFromS3Output struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RestoreDBInstanceToPointInTime.go b/service/rds/api_op_RestoreDBInstanceToPointInTime.go index 6377bb53441..4ac1376ff4b 100644 --- a/service/rds/api_op_RestoreDBInstanceToPointInTime.go +++ b/service/rds/api_op_RestoreDBInstanceToPointInTime.go @@ -22,7 +22,7 @@ import ( // except when the instance is a SQL Server instance that has an option group that // is associated with mirroring; in this case, the instance becomes a mirrored // deployment and not a single-AZ deployment. This command doesn't apply to Aurora -// MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime. +// MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime . func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *RestoreDBInstanceToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBInstanceToPointInTimeOutput, error) { if params == nil { params = &RestoreDBInstanceToPointInTimeInput{} @@ -41,20 +41,15 @@ func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *Res type RestoreDBInstanceToPointInTimeInput struct { // The name of the new DB instance to be created. Constraints: - // - // * Must contain from - // 1 to 63 letters, numbers, or hyphens - // - // * First character must be a letter - // - // * - // Can't end with a hyphen or contain two consecutive hyphens + // - Must contain from 1 to 63 letters, numbers, or hyphens + // - First character must be a letter + // - Can't end with a hyphen or contain two consecutive hyphens // // This member is required. TargetDBInstanceIdentifier *string // The amount of storage (in gibibytes) to allocate initially for the DB instance. - // Follow the allocation rules specified in CreateDBInstance. Be sure to allocate + // Follow the allocation rules specified in CreateDBInstance . Be sure to allocate // enough storage for your new DB instance so that the restore operation can // succeed. You can also allocate additional storage for future growth. AllocatedStorage *int32 @@ -72,40 +67,32 @@ type RestoreDBInstanceToPointInTimeInput struct { // Specifies where automated backups and manual snapshots are stored for the // restored DB instance. Possible values are outposts (Amazon Web Services - // Outposts) and region (Amazon Web Services Region). The default is region. For - // more information, see Working with Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. + // Outposts) and region (Amazon Web Services Region). The default is region . For + // more information, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. BackupTarget *string - // A value that indicates whether to copy all tags from the restored DB instance to - // snapshots of the DB instance. By default, tags are not copied. + // A value that indicates whether to copy all tags from the restored DB instance + // to snapshots of the DB instance. By default, tags are not copied. CopyTagsToSnapshot *bool // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. The instance profile must meet the following // requirements: - // - // * The profile must exist in your account. - // - // * The profile must - // have an IAM role that Amazon EC2 has permissions to assume. - // - // * The instance - // profile name and the associated IAM role name must start with the prefix - // AWSRDSCustom. - // - // For the list of permissions required for the IAM role, see - // Configure IAM and your VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) + // - The profile must exist in your account. + // - The profile must have an IAM role that Amazon EC2 has permissions to + // assume. + // - The instance profile name and the associated IAM role name must start with + // the prefix AWSRDSCustom . + // For the list of permissions required for the IAM role, see Configure IAM and + // your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. This setting is required for RDS Custom. CustomIamInstanceProfile *string // The compute and memory capacity of the Amazon RDS DB instance, for example // db.m4.large. Not all DB instance classes are available in all Amazon Web // Services Regions, or for all database engines. For the full list of DB instance - // classes, and availability for your engine, see DB Instance Class - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original // DB instance. DBInstanceClass *string @@ -114,21 +101,14 @@ type RestoreDBInstanceToPointInTimeInput struct { // for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom. DBName *string - // The name of the DB parameter group to associate with this DB instance. If you do - // not specify a value for DBParameterGroupName, then the default DBParameterGroup - // for the specified DB engine is used. This setting doesn't apply to RDS Custom. - // Constraints: - // - // * If supplied, must match the name of an existing - // DBParameterGroup. - // - // * Must be 1 to 255 letters, numbers, or hyphens. - // - // * First - // character must be a letter. - // - // * Can't end with a hyphen or contain two - // consecutive hyphens. + // The name of the DB parameter group to associate with this DB instance. If you + // do not specify a value for DBParameterGroupName , then the default + // DBParameterGroup for the specified DB engine is used. This setting doesn't apply + // to RDS Custom. Constraints: + // - If supplied, must match the name of an existing DBParameterGroup. + // - Must be 1 to 255 letters, numbers, or hyphens. + // - First character must be a letter. + // - Can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *string // The DB subnet group name to use for the new instance. Constraints: If supplied, @@ -137,17 +117,16 @@ type RestoreDBInstanceToPointInTimeInput struct { // A value that indicates whether the DB instance has deletion protection enabled. // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // deletion protection isn't enabled. For more information, see Deleting a DB + // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection *bool // Specify the Active Directory directory ID to restore the DB instance in. Create // the domain before running this command. Currently, you can create only the // MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active // Directory Domain. This setting doesn't apply to RDS Custom. For more - // information, see Kerberos Authentication - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) + // information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. Domain *string @@ -157,8 +136,7 @@ type RestoreDBInstanceToPointInTimeInput struct { // The list of logs that the restored DB instance is to export to CloudWatch Logs. // The values in the list depend on the DB engine being used. For more information, - // see Publishing Database Logs to Amazon CloudWatch Logs - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. EnableCloudwatchLogsExports []string @@ -168,50 +146,34 @@ type RestoreDBInstanceToPointInTimeInput struct { // use cases, a CoIP can provide lower latency for connections to the DB instance // from outside of its virtual private cloud (VPC) on your local network. This // setting doesn't apply to RDS Custom. For more information about RDS on Outposts, - // see Working with Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. This setting doesn't apply to RDS Custom. For more information - // about IAM database authentication, see IAM Database Authentication for MySQL - // and PostgreSQL - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) + // A value that indicates whether to enable mapping of Amazon Web Services + // Identity and Access Management (IAM) accounts to database accounts. By default, + // mapping isn't enabled. This setting doesn't apply to RDS Custom. For more + // information about IAM database authentication, see IAM Database Authentication + // for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. EnableIAMDatabaseAuthentication *bool // The database engine to use for the new instance. This setting doesn't apply to // RDS Custom. Default: The same as source Constraint: Must be compatible with the // engine of the source Valid Values: - // - // * mariadb - // - // * mysql - // - // * oracle-ee - // - // * - // oracle-ee-cdb - // - // * oracle-se2 - // - // * oracle-se2-cdb - // - // * postgres - // - // * sqlserver-ee - // - // * - // sqlserver-se - // - // * sqlserver-ex - // - // * sqlserver-web + // - mariadb + // - mysql + // - oracle-ee + // - oracle-ee-cdb + // - oracle-se2 + // - oracle-se2-cdb + // - postgres + // - sqlserver-ee + // - sqlserver-se + // - sqlserver-ex + // - sqlserver-web Engine *string // The amount of Provisioned IOPS (input/output operations per second) to be @@ -227,9 +189,8 @@ type RestoreDBInstanceToPointInTimeInput struct { // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale // the storage of the DB instance. For more information about this setting, - // including limitations that apply to it, see Managing capacity automatically - // with Amazon RDS storage autoscaling - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) + // including limitations that apply to it, see Managing capacity automatically + // with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. MaxAllocatedStorage *int32 @@ -239,16 +200,12 @@ type RestoreDBInstanceToPointInTimeInput struct { MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. NetworkType *string @@ -275,61 +232,53 @@ type RestoreDBInstanceToPointInTimeInput struct { // group it uses. That public access isn't permitted if the security group assigned // to the DB cluster doesn't permit it. When the DB instance isn't publicly // accessible, it is an internal DB instance with a DNS name that resolves to a - // private IP address. For more information, see CreateDBInstance. + // private IP address. For more information, see CreateDBInstance . PubliclyAccessible *bool // The date and time to restore from. Valid Values: Value must be a time in // Universal Coordinated Time (UTC) format Constraints: - // - // * Must be before the - // latest restorable time for the DB instance - // - // * Can't be specified if the - // UseLatestRestorableTime parameter is enabled - // + // - Must be before the latest restorable time for the DB instance + // - Can't be specified if the UseLatestRestorableTime parameter is enabled // Example: 2009-09-07T23:45:00Z RestoreTime *time.Time - // The Amazon Resource Name (ARN) of the replicated automated backups from which to - // restore, for example, - // arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. + // The Amazon Resource Name (ARN) of the replicated automated backups from which + // to restore, for example, + // arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . // This setting doesn't apply to RDS Custom. SourceDBInstanceAutomatedBackupsArn *string // The identifier of the source DB instance from which to restore. Constraints: - // - // * - // Must match the identifier of an existing DB instance. + // - Must match the identifier of an existing DB instance. SourceDBInstanceIdentifier *string // The resource ID of the source DB instance from which to restore. SourceDbiResourceId *string - // Specifies the storage throughput value for the DB instance. This setting doesn't - // apply to RDS Custom or Amazon Aurora. + // Specifies the storage throughput value for the DB instance. This setting + // doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 // Specifies the storage type to be associated with the DB instance. Valid values: - // gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a + // gp2 | gp3 | io1 | standard If you specify io1 or gp3 , you must also include a // value for the Iops parameter. Default: io1 if the Iops parameter is specified, // otherwise gp2 StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. Tags []types.Tag // The ARN from the key store with which to associate the instance for TDE // encryption. This setting doesn't apply to RDS Custom. TdeCredentialArn *string - // The password for the given ARN from the key store in order to access the device. - // This setting doesn't apply to RDS Custom. + // The password for the given ARN from the key store in order to access the + // device. This setting doesn't apply to RDS Custom. TdeCredentialPassword *string - // A value that indicates whether the DB instance class of the DB instance uses its - // default processor features. This setting doesn't apply to RDS Custom. + // A value that indicates whether the DB instance class of the DB instance uses + // its default processor features. This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // A value that indicates whether the DB instance is restored from the latest @@ -347,11 +296,11 @@ type RestoreDBInstanceToPointInTimeInput struct { type RestoreDBInstanceToPointInTimeOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RevokeDBSecurityGroupIngress.go b/service/rds/api_op_RevokeDBSecurityGroupIngress.go index 52e1959692b..3dfbc9ef920 100644 --- a/service/rds/api_op_RevokeDBSecurityGroupIngress.go +++ b/service/rds/api_op_RevokeDBSecurityGroupIngress.go @@ -17,13 +17,10 @@ import ( // EC2SecurityGroupName or EC2SecurityGroupId). EC2-Classic was retired on August // 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that // you migrate as soon as possible. For more information, see Migrate from -// EC2-Classic to a VPC -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the -// Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How -// to Prepare -// (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/), -// and Moving a DB instance not in a VPC into a VPC -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) +// EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) +// in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – +// Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) +// , and Moving a DB instance not in a VPC into a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) // in the Amazon RDS User Guide. func (c *Client) RevokeDBSecurityGroupIngress(ctx context.Context, params *RevokeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeDBSecurityGroupIngressOutput, error) { if params == nil { @@ -48,7 +45,7 @@ type RevokeDBSecurityGroupIngressInput struct { DBSecurityGroupName *string // The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is - // specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId + // specified, EC2SecurityGroupName , EC2SecurityGroupId and EC2SecurityGroupOwnerId // can't be provided. CIDRIP *string @@ -74,8 +71,8 @@ type RevokeDBSecurityGroupIngressInput struct { type RevokeDBSecurityGroupIngressOutput struct { - // Contains the details for an Amazon RDS DB security group. This data type is used - // as a response element in the DescribeDBSecurityGroups action. + // Contains the details for an Amazon RDS DB security group. This data type is + // used as a response element in the DescribeDBSecurityGroups action. DBSecurityGroup *types.DBSecurityGroup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StartActivityStream.go b/service/rds/api_op_StartActivityStream.go index 7330bc14704..ddd5092a3a8 100644 --- a/service/rds/api_op_StartActivityStream.go +++ b/service/rds/api_op_StartActivityStream.go @@ -12,11 +12,9 @@ import ( ) // Starts a database activity stream to monitor activity on the database. For more -// information, see Monitoring Amazon Aurora with Database Activity Streams -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) -// in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity -// Streams -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) +// information, see Monitoring Amazon Aurora with Database Activity Streams (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) +// in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity +// Streams (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) // in the Amazon RDS User Guide. func (c *Client) StartActivityStream(ctx context.Context, params *StartActivityStreamInput, optFns ...func(*Options)) (*StartActivityStreamOutput, error) { if params == nil { @@ -50,7 +48,7 @@ type StartActivityStreamInput struct { Mode types.ActivityStreamMode // The Amazon Resource Name (ARN) of the DB cluster, for example, - // arn:aws:rds:us-east-1:12345667890:cluster:das-cluster. + // arn:aws:rds:us-east-1:12345667890:cluster:das-cluster . // // This member is required. ResourceArn *string diff --git a/service/rds/api_op_StartDBCluster.go b/service/rds/api_op_StartDBCluster.go index dea5989b94c..6c622763c6a 100644 --- a/service/rds/api_op_StartDBCluster.go +++ b/service/rds/api_op_StartDBCluster.go @@ -13,8 +13,7 @@ import ( // Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web // Services console, the stop-db-cluster CLI command, or the StopDBCluster action. -// For more information, see Stopping and Starting an Aurora Cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) +// For more information, see Stopping and Starting an Aurora Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) // in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. func (c *Client) StartDBCluster(ctx context.Context, params *StartDBClusterInput, optFns ...func(*Options)) (*StartDBClusterOutput, error) { if params == nil { @@ -46,19 +45,17 @@ type StartDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_StartDBInstance.go b/service/rds/api_op_StartDBInstance.go index acbc4200b45..227e118fe3e 100644 --- a/service/rds/api_op_StartDBInstance.go +++ b/service/rds/api_op_StartDBInstance.go @@ -13,9 +13,8 @@ import ( // Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services // console, the stop-db-instance CLI command, or the StopDBInstance action. For -// more information, see Starting an Amazon RDS DB instance That Was Previously -// Stopped -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html) +// more information, see Starting an Amazon RDS DB instance That Was Previously +// Stopped (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html) // in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora // MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster // instead. @@ -47,11 +46,11 @@ type StartDBInstanceInput struct { type StartDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go b/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go index 26cdf698b40..b3497ae732d 100644 --- a/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go +++ b/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go @@ -13,8 +13,7 @@ import ( // Enables replication of automated backups to a different Amazon Web Services // Region. This command doesn't apply to RDS Custom. For more information, see -// Replicating Automated Backups to Another Amazon Web Services Region -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) +// Replicating Automated Backups to Another Amazon Web Services Region (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) // in the Amazon RDS User Guide. func (c *Client) StartDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StartDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StartDBInstanceAutomatedBackupsReplicationOutput, error) { if params == nil { @@ -34,8 +33,8 @@ func (c *Client) StartDBInstanceAutomatedBackupsReplication(ctx context.Context, type StartDBInstanceAutomatedBackupsReplicationInput struct { // The Amazon Resource Name (ARN) of the source DB instance for the replicated - // automated backups, for example, - // arn:aws:rds:us-west-2:123456789012:db:mydatabase. + // automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase + // . // // This member is required. SourceDBInstanceArn *string @@ -46,23 +45,21 @@ type StartDBInstanceAutomatedBackupsReplicationInput struct { // The Amazon Web Services KMS key identifier for encryption of the replicated // automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS // encryption key in the destination Amazon Web Services Region, for example, - // arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE. + // arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE . KmsKeyId *string - // In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature - // Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication - // operation to call in the Amazon Web Services Region of the source DB instance. - // The presigned URL must be a valid request for the - // StartDBInstanceAutomatedBackupsReplication API operation that can run in the - // Amazon Web Services Region that contains the source DB instance. This setting - // applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other - // Amazon Web Services Regions. To learn how to generate a Signature Version 4 - // signed request, see Authenticating Requests: Using Query Parameters (Amazon Web - // Services Signature Version 4) - // (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) - // and Signature Version 4 Signing Process - // (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). If you - // are using an Amazon Web Services SDK tool or the CLI, you can specify + // In an Amazon Web Services GovCloud (US) Region, an URL that contains a + // Signature Version 4 signed request for the + // StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web + // Services Region of the source DB instance. The presigned URL must be a valid + // request for the StartDBInstanceAutomatedBackupsReplication API operation that + // can run in the Amazon Web Services Region that contains the source DB instance. + // This setting applies only to Amazon Web Services GovCloud (US) Regions. It's + // ignored in other Amazon Web Services Regions. To learn how to generate a + // Signature Version 4 signed request, see Authenticating Requests: Using Query + // Parameters (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) + // and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) + // . If you are using an Amazon Web Services SDK tool or the CLI, you can specify // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl // manually. Specifying SourceRegion autogenerates a presigned URL that is a valid // request for the operation that can run in the source Amazon Web Services Region. @@ -73,9 +70,9 @@ type StartDBInstanceAutomatedBackupsReplicationInput struct { type StartDBInstanceAutomatedBackupsReplicationOutput struct { - // An automated backup of a DB instance. It consists of system backups, transaction - // logs, and the database instance properties that existed at the time you deleted - // the source instance. + // An automated backup of a DB instance. It consists of system backups, + // transaction logs, and the database instance properties that existed at the time + // you deleted the source instance. DBInstanceAutomatedBackup *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StartExportTask.go b/service/rds/api_op_StartExportTask.go index 63f148e4420..2e5edfeca06 100644 --- a/service/rds/api_op_StartExportTask.go +++ b/service/rds/api_op_StartExportTask.go @@ -16,13 +16,10 @@ import ( // IAM role must have access to the S3 bucket. You can't export snapshot data from // RDS Custom DB instances. You can't export cluster data from Multi-AZ DB // clusters. For more information on exporting DB snapshot data, see Exporting DB -// snapshot data to Amazon S3 -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html) -// in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html) +// snapshot data to Amazon S3 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html) +// in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html) // in the Amazon Aurora User Guide. For more information on exporting DB cluster -// data, see Exporting DB cluster data to Amazon S3 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html) +// data, see Exporting DB cluster data to Amazon S3 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html) // in the Amazon Aurora User Guide. func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInput, optFns ...func(*Options)) (*StartExportTaskOutput, error) { if params == nil { @@ -51,56 +48,34 @@ type StartExportTaskInput struct { // exporting a snapshot or cluster. In the IAM policy attached to your IAM role, // include the following required actions to allow the transfer of files from // Amazon RDS or Amazon Aurora to an S3 bucket: - // - // * s3:PutObject* - // - // * - // s3:GetObject* - // - // * s3:ListBucket - // - // * s3:DeleteObject* - // - // * s3:GetBucketLocation - // - // In - // the policy, include the resources to identify the S3 bucket and objects in the - // bucket. The following list of resources shows the Amazon Resource Name (ARN) + // - s3:PutObject* + // - s3:GetObject* + // - s3:ListBucket + // - s3:DeleteObject* + // - s3:GetBucketLocation + // In the policy, include the resources to identify the S3 bucket and objects in + // the bucket. The following list of resources shows the Amazon Resource Name (ARN) // format for accessing S3: - // - // * arn:aws:s3:::your-s3-bucket - // - // * - // arn:aws:s3:::your-s3-bucket/* + // - arn:aws:s3:::your-s3-bucket + // - arn:aws:s3:::your-s3-bucket/* // // This member is required. IamRoleArn *string - // The ID of the Amazon Web Services KMS key to use to encrypt the data exported to - // Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, + // The ID of the Amazon Web Services KMS key to use to encrypt the data exported + // to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, // alias ARN, or alias name for the KMS key. The caller of this operation must be // authorized to run the following operations. These can be set in the Amazon Web // Services KMS key policy: - // - // * kms:Encrypt - // - // * kms:Decrypt - // - // * kms:GenerateDataKey - // - // * - // kms:GenerateDataKeyWithoutPlaintext - // - // * kms:ReEncryptFrom - // - // * kms:ReEncryptTo - // - // * - // kms:CreateGrant - // - // * kms:DescribeKey - // - // * kms:RetireGrant + // - kms:Encrypt + // - kms:Decrypt + // - kms:GenerateDataKey + // - kms:GenerateDataKeyWithoutPlaintext + // - kms:ReEncryptFrom + // - kms:ReEncryptTo + // - kms:CreateGrant + // - kms:DescribeKey + // - kms:RetireGrant // // This member is required. KmsKeyId *string @@ -118,21 +93,14 @@ type StartExportTaskInput struct { // The data to be exported from the snapshot or cluster. If this parameter is not // provided, all of the data is exported. Valid values are the following: - // - // * - // database - Export all the data from a specified database. - // - // * database.table - // table-name - Export a table of the snapshot or cluster. This format is valid - // only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. - // - // * database.schema - // schema-name - Export a database schema of the snapshot or cluster. This format - // is valid only for RDS for PostgreSQL and Aurora PostgreSQL. - // - // * - // database.schema.table table-name - Export a table of the database schema. This - // format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + // - database - Export all the data from a specified database. + // - database.table table-name - Export a table of the snapshot or cluster. This + // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + // - database.schema schema-name - Export a database schema of the snapshot or + // cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + // + // - database.schema.table table-name - Export a table of the database schema. + // This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. ExportOnly []string // The Amazon S3 bucket prefix to use as the file name and path of the exported @@ -146,22 +114,15 @@ type StartExportTaskInput struct { // type is used as a response element in the DescribeExportTasks action. type StartExportTaskOutput struct { - // The data exported from the snapshot or cluster. Valid values are the - // following: - // - // * database - Export all the data from a specified database. - // - // * - // database.table table-name - Export a table of the snapshot or cluster. This - // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + // The data exported from the snapshot or cluster. Valid values are the following: + // - database - Export all the data from a specified database. + // - database.table table-name - Export a table of the snapshot or cluster. This + // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + // - database.schema schema-name - Export a database schema of the snapshot or + // cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. // - // * - // database.schema schema-name - Export a database schema of the snapshot or - // cluster. This format is valid only for RDS for PostgreSQL and Aurora - // PostgreSQL. - // - // * database.schema.table table-name - Export a table of the database - // schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + // - database.schema.table table-name - Export a table of the database schema. + // This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. ExportOnly []string // A unique identifier for the snapshot or cluster export task. This ID isn't an @@ -199,21 +160,13 @@ type StartExportTaskOutput struct { // The type of source for the export. SourceType types.ExportSourceType - // The progress status of the export task. The status can be one of the - // following: - // - // * CANCELED - // - // * CANCELING - // - // * COMPLETE - // - // * FAILED - // - // * IN_PROGRESS - // - // * - // STARTING + // The progress status of the export task. The status can be one of the following: + // - CANCELED + // - CANCELING + // - COMPLETE + // - FAILED + // - IN_PROGRESS + // - STARTING Status *string // The time that the snapshot or cluster export task ended. diff --git a/service/rds/api_op_StopActivityStream.go b/service/rds/api_op_StopActivityStream.go index 79c0f289273..fc2bc741b81 100644 --- a/service/rds/api_op_StopActivityStream.go +++ b/service/rds/api_op_StopActivityStream.go @@ -13,12 +13,10 @@ import ( // Stops a database activity stream that was started using the Amazon Web Services // console, the start-activity-stream CLI command, or the StartActivityStream -// action. For more information, see Monitoring Amazon Aurora with Database -// Activity Streams -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) -// in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity -// Streams -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) +// action. For more information, see Monitoring Amazon Aurora with Database +// Activity Streams (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) +// in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity +// Streams (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html) // in the Amazon RDS User Guide. func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStreamInput, optFns ...func(*Options)) (*StopActivityStreamOutput, error) { if params == nil { @@ -38,7 +36,7 @@ func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStr type StopActivityStreamInput struct { // The Amazon Resource Name (ARN) of the DB cluster for the database activity - // stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster. + // stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster . // // This member is required. ResourceArn *string diff --git a/service/rds/api_op_StopDBCluster.go b/service/rds/api_op_StopDBCluster.go index 1322170e642..6b322f97702 100644 --- a/service/rds/api_op_StopDBCluster.go +++ b/service/rds/api_op_StopDBCluster.go @@ -14,8 +14,7 @@ import ( // Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains // the DB cluster's metadata, including its endpoints and DB parameter groups. // Aurora also retains the transaction logs so you can do a point-in-time restore -// if necessary. For more information, see Stopping and Starting an Aurora Cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) +// if necessary. For more information, see Stopping and Starting an Aurora Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html) // in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error) { if params == nil { @@ -47,19 +46,17 @@ type StopDBClusterOutput struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the - // operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, - // FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, - // RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, - // RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ - // DB cluster, this data type is used as a response element in the operations - // CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, - // ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and - // RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB - // clusters, see What is Amazon Aurora? - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , + // RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , + // RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a + // Multi-AZ DB cluster, this data type is used as a response element in the + // operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , + // FailoverDBCluster , ModifyDBCluster , RebootDBCluster , + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more + // information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, - // see Multi-AZ deployments with two readable standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. DBCluster *types.DBCluster diff --git a/service/rds/api_op_StopDBInstance.go b/service/rds/api_op_StopDBInstance.go index b8609b04b04..bef0a656af8 100644 --- a/service/rds/api_op_StopDBInstance.go +++ b/service/rds/api_op_StopDBInstance.go @@ -11,12 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains -// the DB instance's metadata, including its endpoint, DB parameter group, and -// option group membership. Amazon RDS also retains the transaction logs so you can -// do a point-in-time restore if necessary. For more information, see Stopping an -// Amazon RDS DB Instance Temporarily -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html) +// Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS +// retains the DB instance's metadata, including its endpoint, DB parameter group, +// and option group membership. Amazon RDS also retains the transaction logs so you +// can do a point-in-time restore if necessary. For more information, see Stopping +// an Amazon RDS DB Instance Temporarily (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html) // in the Amazon RDS User Guide. This command doesn't apply to RDS Custom, Aurora // MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead. func (c *Client) StopDBInstance(ctx context.Context, params *StopDBInstanceInput, optFns ...func(*Options)) (*StopDBInstanceOutput, error) { @@ -51,11 +50,11 @@ type StopDBInstanceInput struct { type StopDBInstanceOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go b/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go index a166dbdeeea..7261692dab9 100644 --- a/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go +++ b/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops automated backup replication for a DB instance. This command doesn't apply -// to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see -// Replicating Automated Backups to Another Amazon Web Services Region -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) +// Stops automated backup replication for a DB instance. This command doesn't +// apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, +// see Replicating Automated Backups to Another Amazon Web Services Region (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) // in the Amazon RDS User Guide. func (c *Client) StopDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StopDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StopDBInstanceAutomatedBackupsReplicationOutput, error) { if params == nil { @@ -35,7 +34,7 @@ type StopDBInstanceAutomatedBackupsReplicationInput struct { // The Amazon Resource Name (ARN) of the source DB instance for which to stop // replicating automate backups, for example, - // arn:aws:rds:us-west-2:123456789012:db:mydatabase. + // arn:aws:rds:us-west-2:123456789012:db:mydatabase . // // This member is required. SourceDBInstanceArn *string @@ -45,9 +44,9 @@ type StopDBInstanceAutomatedBackupsReplicationInput struct { type StopDBInstanceAutomatedBackupsReplicationOutput struct { - // An automated backup of a DB instance. It consists of system backups, transaction - // logs, and the database instance properties that existed at the time you deleted - // the source instance. + // An automated backup of a DB instance. It consists of system backups, + // transaction logs, and the database instance properties that existed at the time + // you deleted the source instance. DBInstanceAutomatedBackup *types.DBInstanceAutomatedBackup // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_SwitchoverBlueGreenDeployment.go b/service/rds/api_op_SwitchoverBlueGreenDeployment.go index 8a943e58120..b637eefb37e 100644 --- a/service/rds/api_op_SwitchoverBlueGreenDeployment.go +++ b/service/rds/api_op_SwitchoverBlueGreenDeployment.go @@ -15,11 +15,9 @@ import ( // traffic is routed to the databases in the blue environment. After you switch // over, production traffic is routed to the databases in the green environment. // For more information, see Using Amazon RDS Blue/Green Deployments for database -// updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *SwitchoverBlueGreenDeploymentInput, optFns ...func(*Options)) (*SwitchoverBlueGreenDeploymentOutput, error) { if params == nil { @@ -39,9 +37,7 @@ func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *Swit type SwitchoverBlueGreenDeploymentInput struct { // The blue/green deployment identifier. Constraints: - // - // * Must match an existing - // blue/green deployment identifier. + // - Must match an existing blue/green deployment identifier. // // This member is required. BlueGreenDeploymentIdentifier *string @@ -57,11 +53,9 @@ type SwitchoverBlueGreenDeploymentInput struct { type SwitchoverBlueGreenDeploymentOutput struct { // Contains the details about a blue/green deployment. For more information, see - // Using Amazon RDS Blue/Green Deployments for database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) - // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for - // database updates - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) + // Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) + // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for + // database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. BlueGreenDeployment *types.BlueGreenDeployment diff --git a/service/rds/api_op_SwitchoverReadReplica.go b/service/rds/api_op_SwitchoverReadReplica.go index 28b471505d1..2db5d71d11b 100644 --- a/service/rds/api_op_SwitchoverReadReplica.go +++ b/service/rds/api_op_SwitchoverReadReplica.go @@ -31,11 +31,9 @@ func (c *Client) SwitchoverReadReplica(ctx context.Context, params *SwitchoverRe type SwitchoverReadReplicaInput struct { - // The DB instance identifier of the current standby database. This value is stored - // as a lowercase string. Constraints: - // - // * Must match the identifier of an existing - // Oracle read replica DB instance. + // The DB instance identifier of the current standby database. This value is + // stored as a lowercase string. Constraints: + // - Must match the identifier of an existing Oracle read replica DB instance. // // This member is required. DBInstanceIdentifier *string @@ -46,11 +44,11 @@ type SwitchoverReadReplicaInput struct { type SwitchoverReadReplicaOutput struct { // Contains the details of an Amazon RDS DB instance. This data type is used as a - // response element in the operations CreateDBInstance, - // CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, - // ModifyDBInstance, PromoteReadReplica, RebootDBInstance, - // RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, - // RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. + // response element in the operations CreateDBInstance , + // CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , + // ModifyDBInstance , PromoteReadReplica , RebootDBInstance , + // RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , + // RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . DBInstance *types.DBInstance // Metadata pertaining to the operation's result. diff --git a/service/rds/doc.go b/service/rds/doc.go index ca3171d3c7c..ad275488399 100644 --- a/service/rds/doc.go +++ b/service/rds/doc.go @@ -25,31 +25,18 @@ // command is applied immediately, on the next instance reboot, or during the // maintenance window. The reference structure is as follows, and we list following // some related topics from the user guide. Amazon RDS API Reference -// -// * For the -// alphabetical list of API actions, see API Actions -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html). -// -// * -// For the alphabetical list of data types, see Data Types -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html). -// -// * -// For a list of common query parameters, see Common Parameters -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html). -// -// * -// For descriptions of the error codes, see Common Errors -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html). -// -// Amazon -// RDS User Guide -// -// * For a summary of the Amazon RDS interfaces, see Available RDS -// Interfaces -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces). -// -// * -// For more information about how to use the Query API, see Using the Query API -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html). +// - For the alphabetical list of API actions, see API Actions (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html) +// . +// - For the alphabetical list of data types, see Data Types (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html) +// . +// - For a list of common query parameters, see Common Parameters (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html) +// . +// - For descriptions of the error codes, see Common Errors (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html) +// . +// +// Amazon RDS User Guide +// - For a summary of the Amazon RDS interfaces, see Available RDS Interfaces (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces) +// . +// - For more information about how to use the Query API, see Using the Query API (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html) +// . package rds diff --git a/service/rds/types/enums.go b/service/rds/types/enums.go index 378a0aa8c7a..69de9ed1dc9 100644 --- a/service/rds/types/enums.go +++ b/service/rds/types/enums.go @@ -188,8 +188,8 @@ const ( DBProxyEndpointStatusDeleting DBProxyEndpointStatus = "deleting" ) -// Values returns all known values for DBProxyEndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DBProxyEndpointStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DBProxyEndpointStatus) Values() []DBProxyEndpointStatus { return []DBProxyEndpointStatus{ @@ -261,9 +261,9 @@ const ( EngineFamilySqlserver EngineFamily = "SQLSERVER" ) -// Values returns all known values for EngineFamily. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EngineFamily. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EngineFamily) Values() []EngineFamily { return []EngineFamily{ "MYSQL", @@ -475,8 +475,8 @@ const ( WriteForwardingStatusUnknown WriteForwardingStatus = "unknown" ) -// Values returns all known values for WriteForwardingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for WriteForwardingStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (WriteForwardingStatus) Values() []WriteForwardingStatus { return []WriteForwardingStatus{ diff --git a/service/rds/types/errors.go b/service/rds/types/errors.go index c0a5132c114..23a7883a191 100644 --- a/service/rds/types/errors.go +++ b/service/rds/types/errors.go @@ -34,9 +34,9 @@ func (e *AuthorizationAlreadyExistsFault) ErrorCode() string { } func (e *AuthorizationAlreadyExistsFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified CIDR IP range or Amazon EC2 security group might not be authorized -// for the specified DB security group. Or, RDS might not be authorized to perform -// necessary actions using IAM on your behalf. +// The specified CIDR IP range or Amazon EC2 security group might not be +// authorized for the specified DB security group. Or, RDS might not be authorized +// to perform necessary actions using IAM on your behalf. type AuthorizationNotFoundFault struct { Message *string @@ -549,8 +549,8 @@ func (e *DBClusterQuotaExceededFault) ErrorCode() string { } func (e *DBClusterQuotaExceededFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified IAM role Amazon Resource Name (ARN) is already associated with the -// specified DB cluster. +// The specified IAM role Amazon Resource Name (ARN) is already associated with +// the specified DB cluster. type DBClusterRoleAlreadyExistsFault struct { Message *string @@ -984,8 +984,8 @@ func (e *DBParameterGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified proxy name must be unique for all proxies owned by your Amazon Web -// Services account in the specified Amazon Web Services Region. +// The specified proxy name must be unique for all proxies owned by your Amazon +// Web Services account in the specified Amazon Web Services Region. type DBProxyAlreadyExistsFault struct { Message *string @@ -1308,8 +1308,8 @@ func (e *DBSecurityGroupNotSupportedFault) ErrorCode() string { } func (e *DBSecurityGroupNotSupportedFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request would result in the user exceeding the allowed number of DB security -// groups. +// The request would result in the user exceeding the allowed number of DB +// security groups. type DBSecurityGroupQuotaExceededFault struct { Message *string @@ -1869,9 +1869,9 @@ func (e *InstanceQuotaExceededFault) ErrorCode() string { } func (e *InstanceQuotaExceededFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested operation can't be performed because there aren't enough available -// IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove -// IP address that aren't required from the subnets. +// The requested operation can't be performed because there aren't enough +// available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC +// or remove IP address that aren't required from the subnets. type InsufficientAvailableIPsInSubnetFault struct { Message *string @@ -2044,7 +2044,7 @@ func (e *InvalidCustomDBEngineVersionStateFault) ErrorFault() smithy.ErrorFault } // Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity -// values are 2, 4, 8, 16, 32, 64, 128, and 256. +// values are 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 . type InvalidDBClusterCapacityFault struct { Message *string @@ -2070,8 +2070,8 @@ func (e *InvalidDBClusterCapacityFault) ErrorCode() string { } func (e *InvalidDBClusterCapacityFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested operation can't be performed on the endpoint while the endpoint is -// in this state. +// The requested operation can't be performed on the endpoint while the endpoint +// is in this state. type InvalidDBClusterEndpointStateFault struct { Message *string @@ -2635,8 +2635,8 @@ func (e *InvalidS3BucketFault) ErrorCode() string { } func (e *InvalidS3BucketFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested subnet is invalid, or multiple subnets were requested that are not -// all in a common VPC. +// The requested subnet is invalid, or multiple subnets were requested that are +// not all in a common VPC. type InvalidSubnet struct { Message *string @@ -2716,7 +2716,7 @@ func (e *KMSKeyNotAccessibleFault) ErrorCode() string { func (e *KMSKeyNotAccessibleFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The network type is invalid for the DB instance. Valid nework type values are -// IPV4 and DUAL. +// IPV4 and DUAL . type NetworkTypeNotSupported struct { Message *string diff --git a/service/rds/types/types.go b/service/rds/types/types.go index c2b5720eb12..b7dbc6a00e8 100644 --- a/service/rds/types/types.go +++ b/service/rds/types/types.go @@ -9,93 +9,63 @@ import ( // Describes a quota for an Amazon Web Services account. The following are account // quotas: +// - AllocatedStorage - The total allocated storage per account, in GiB. The used +// value is the total allocated storage in the account, in GiB. +// - AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB +// security group. The used value is the highest number of ingress rules in a DB +// security group in the account. Other DB security groups in the account might +// have a lower number of ingress rules. +// - CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. +// The used value is the highest number of custom endpoints in a DB clusters in the +// account. Other DB clusters in the account might have a lower number of custom +// endpoints. +// - DBClusterParameterGroups - The number of DB cluster parameter groups per +// account, excluding default parameter groups. The used value is the count of +// nondefault DB cluster parameter groups in the account. +// - DBClusterRoles - The number of associated Amazon Web Services Identity and +// Access Management (IAM) roles per DB cluster. The used value is the highest +// number of associated IAM roles for a DB cluster in the account. Other DB +// clusters in the account might have a lower number of associated IAM roles. +// - DBClusters - The number of DB clusters per account. The used value is the +// count of DB clusters in the account. +// - DBInstanceRoles - The number of associated IAM roles per DB instance. The +// used value is the highest number of associated IAM roles for a DB instance in +// the account. Other DB instances in the account might have a lower number of +// associated IAM roles. +// - DBInstances - The number of DB instances per account. The used value is the +// count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora +// DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to +// this quota. +// - DBParameterGroups - The number of DB parameter groups per account, excluding +// default parameter groups. The used value is the count of nondefault DB parameter +// groups in the account. +// - DBSecurityGroups - The number of DB security groups (not VPC security +// groups) per account, excluding the default security group. The used value is the +// count of nondefault DB security groups in the account. +// - DBSubnetGroups - The number of DB subnet groups per account. The used value +// is the count of the DB subnet groups in the account. +// - EventSubscriptions - The number of event subscriptions per account. The used +// value is the count of the event subscriptions in the account. +// - ManualClusterSnapshots - The number of manual DB cluster snapshots per +// account. The used value is the count of the manual DB cluster snapshots in the +// account. +// - ManualSnapshots - The number of manual DB instance snapshots per account. +// The used value is the count of the manual DB instance snapshots in the account. +// - OptionGroups - The number of DB option groups per account, excluding default +// option groups. The used value is the count of nondefault DB option groups in the +// account. +// - ReadReplicasPerMaster - The number of read replicas per DB instance. The +// used value is the highest number of read replicas for a DB instance in the +// account. Other DB instances in the account might have a lower number of read +// replicas. +// - ReservedDBInstances - The number of reserved DB instances per account. The +// used value is the count of the active reserved DB instances in the account. +// - SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The +// used value is highest number of subnets for a DB subnet group in the account. +// Other DB subnet groups in the account might have a lower number of subnets. // -// * AllocatedStorage - The total allocated storage per account, in GiB. -// The used value is the total allocated storage in the account, in GiB. -// -// * -// AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security -// group. The used value is the highest number of ingress rules in a DB security -// group in the account. Other DB security groups in the account might have a lower -// number of ingress rules. -// -// * CustomEndpointsPerDBCluster - The number of custom -// endpoints per DB cluster. The used value is the highest number of custom -// endpoints in a DB clusters in the account. Other DB clusters in the account -// might have a lower number of custom endpoints. -// -// * DBClusterParameterGroups - The -// number of DB cluster parameter groups per account, excluding default parameter -// groups. The used value is the count of nondefault DB cluster parameter groups in -// the account. -// -// * DBClusterRoles - The number of associated Amazon Web Services -// Identity and Access Management (IAM) roles per DB cluster. The used value is the -// highest number of associated IAM roles for a DB cluster in the account. Other DB -// clusters in the account might have a lower number of associated IAM roles. -// -// * -// DBClusters - The number of DB clusters per account. The used value is the count -// of DB clusters in the account. -// -// * DBInstanceRoles - The number of associated IAM -// roles per DB instance. The used value is the highest number of associated IAM -// roles for a DB instance in the account. Other DB instances in the account might -// have a lower number of associated IAM roles. -// -// * DBInstances - The number of DB -// instances per account. The used value is the count of the DB instances in the -// account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune -// instances, and Amazon DocumentDB instances apply to this quota. -// -// * -// DBParameterGroups - The number of DB parameter groups per account, excluding -// default parameter groups. The used value is the count of nondefault DB parameter -// groups in the account. -// -// * DBSecurityGroups - The number of DB security groups -// (not VPC security groups) per account, excluding the default security group. The -// used value is the count of nondefault DB security groups in the account. -// -// * -// DBSubnetGroups - The number of DB subnet groups per account. The used value is -// the count of the DB subnet groups in the account. -// -// * EventSubscriptions - The -// number of event subscriptions per account. The used value is the count of the -// event subscriptions in the account. -// -// * ManualClusterSnapshots - The number of -// manual DB cluster snapshots per account. The used value is the count of the -// manual DB cluster snapshots in the account. -// -// * ManualSnapshots - The number of -// manual DB instance snapshots per account. The used value is the count of the -// manual DB instance snapshots in the account. -// -// * OptionGroups - The number of DB -// option groups per account, excluding default option groups. The used value is -// the count of nondefault DB option groups in the account. -// -// * -// ReadReplicasPerMaster - The number of read replicas per DB instance. The used -// value is the highest number of read replicas for a DB instance in the account. -// Other DB instances in the account might have a lower number of read replicas. -// -// * -// ReservedDBInstances - The number of reserved DB instances per account. The used -// value is the count of the active reserved DB instances in the account. -// -// * -// SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used -// value is highest number of subnets for a DB subnet group in the account. Other -// DB subnet groups in the account might have a lower number of subnets. -// -// For more -// information, see Quotas for Amazon RDS -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) in the -// Amazon RDS User Guide and Quotas for Amazon Aurora -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) +// For more information, see Quotas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) +// in the Amazon RDS User Guide and Quotas for Amazon Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) // in the Amazon Aurora User Guide. type AccountQuota struct { @@ -123,8 +93,7 @@ type AvailabilityZone struct { // Contains the available processor feature information for the DB instance class // of a DB instance. For more information, see Configuring the Processor of the DB -// Instance Class -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) +// Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) // in the Amazon RDS User Guide. type AvailableProcessorFeature struct { @@ -134,18 +103,16 @@ type AvailableProcessorFeature struct { // The default value for the processor feature of the DB instance class. DefaultValue *string - // The name of the processor feature. Valid names are coreCount and threadsPerCore. + // The name of the processor feature. Valid names are coreCount and threadsPerCore . Name *string noSmithyDocumentSerde } // Contains the details about a blue/green deployment. For more information, see -// Using Amazon RDS Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. type BlueGreenDeployment struct { @@ -163,33 +130,21 @@ type BlueGreenDeployment struct { // Coordinated Time (UTC). DeleteTime *time.Time - // The source database for the blue/green deployment. Before switchover, the source - // database is the production database in the blue environment. + // The source database for the blue/green deployment. Before switchover, the + // source database is the production database in the blue environment. Source *string // The status of the blue/green deployment. Values: - // - // * PROVISIONING - Resources are - // being created in the green environment. - // - // * AVAILABLE - Resources are available - // in the green environment. - // - // * SWITCHOVER_IN_PROGRESS - The deployment is being - // switched from the blue environment to the green environment. - // - // * - // SWITCHOVER_COMPLETED - Switchover from the blue environment to the green - // environment is complete. - // - // * INVALID_CONFIGURATION - Resources in the green - // environment are invalid, so switchover isn't possible. - // - // * SWITCHOVER_FAILED - - // Switchover was attempted but failed. - // - // * DELETING - The blue/green deployment is - // being deleted. + // - PROVISIONING - Resources are being created in the green environment. + // - AVAILABLE - Resources are available in the green environment. + // - SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue + // environment to the green environment. + // - SWITCHOVER_COMPLETED - Switchover from the blue environment to the green + // environment is complete. + // - INVALID_CONFIGURATION - Resources in the green environment are invalid, so + // switchover isn't possible. + // - SWITCHOVER_FAILED - Switchover was attempted but failed. + // - DELETING - The blue/green deployment is being deleted. Status *string // Additional information about the status of the blue/green deployment. @@ -198,13 +153,12 @@ type BlueGreenDeployment struct { // The details about each source and target resource in the blue/green deployment. SwitchoverDetails []SwitchoverDetail - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag - // The target database for the blue/green deployment. Before switchover, the target - // database is the clone database in the green environment. + // The target database for the blue/green deployment. Before switchover, the + // target database is the clone database in the green environment. Target *string // Either tasks to be performed or tasks that have been completed on the target @@ -215,11 +169,9 @@ type BlueGreenDeployment struct { } // Contains the details about a task for a blue/green deployment. For more -// information, see Using Amazon RDS Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) -// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// information, see Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. type BlueGreenDeploymentTask struct { @@ -227,28 +179,19 @@ type BlueGreenDeploymentTask struct { Name *string // The status of the blue/green deployment task. Values: - // - // * PENDING - The resources - // are being prepared for deployment. - // - // * IN_PROGRESS - The resource is being - // deployed. - // - // * COMPLETED - The resource has been deployed. - // - // * FAILED - Deployment - // of the resource failed. + // - PENDING - The resources are being prepared for deployment. + // - IN_PROGRESS - The resource is being deployed. + // - COMPLETED - The resource has been deployed. + // - FAILED - Deployment of the resource failed. Status *string noSmithyDocumentSerde } // A CA certificate for an Amazon Web Services account. For more information, see -// Using SSL/TLS to encrypt a connection to a DB instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) -// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB -// cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) +// Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) +// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB +// cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. type Certificate struct { @@ -281,11 +224,9 @@ type Certificate struct { } // Returns the details of the DB instance’s server certificate. For more -// information, see Using SSL/TLS to encrypt a connection to a DB instance -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) -// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB -// cluster -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) +// information, see Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) +// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB +// cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. type CertificateDetails struct { @@ -300,7 +241,7 @@ type CertificateDetails struct { } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type CharacterSet struct { // The description of the character set. @@ -313,16 +254,14 @@ type CharacterSet struct { } // The configuration setting for the log types to be enabled for export to -// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and -// DisableLogTypes arrays determine which logs will be exported (or not exported) -// to CloudWatch Logs. The values within these arrays depend on the DB engine being -// used. For more information about exporting CloudWatch Logs for Amazon RDS DB -// instances, see Publishing Database Logs to Amazon CloudWatch Logs -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) +// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes +// and DisableLogTypes arrays determine which logs will be exported (or not +// exported) to CloudWatch Logs. The values within these arrays depend on the DB +// engine being used. For more information about exporting CloudWatch Logs for +// Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. For more information about exporting CloudWatch // Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon -// CloudWatch Logs -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) +// CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. type CloudwatchLogsExportConfiguration struct { @@ -357,8 +296,8 @@ type ClusterPendingModifiedValues struct { // Access Management (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool - // The Provisioned IOPS (I/O operations per second) value. This setting is only for - // non-Aurora Multi-AZ DB clusters. + // The Provisioned IOPS (I/O operations per second) value. This setting is only + // for non-Aurora Multi-AZ DB clusters. Iops *int32 // The master credentials for the DB cluster. @@ -371,8 +310,8 @@ type ClusterPendingModifiedValues struct { noSmithyDocumentSerde } -// Specifies the settings that control the size and behavior of the connection pool -// associated with a DBProxyTargetGroup. +// Specifies the settings that control the size and behavior of the connection +// pool associated with a DBProxyTargetGroup . type ConnectionPoolConfiguration struct { // The number of seconds for a proxy to wait for a connection to become available @@ -382,17 +321,17 @@ type ConnectionPoolConfiguration struct { ConnectionBorrowTimeout *int32 // One or more SQL statements for the proxy to run when opening each new database - // connection. Typically used with SET statements to make sure that each connection - // has identical settings such as time zone and character set. For multiple - // statements, use semicolons as the separator. You can also include multiple - // variables in a single SET statement, such as SET x=1, y=2. Default: no + // connection. Typically used with SET statements to make sure that each + // connection has identical settings such as time zone and character set. For + // multiple statements, use semicolons as the separator. You can also include + // multiple variables in a single SET statement, such as SET x=1, y=2 . Default: no // initialization query InitQuery *string // The maximum size of the connection pool for each target in a target group. The - // value is expressed as a percentage of the max_connections setting for the RDS DB - // instance or Aurora DB cluster used by the target group. If you specify - // MaxIdleConnectionsPercent, then you must also include a value for this + // value is expressed as a percentage of the max_connections setting for the RDS + // DB instance or Aurora DB cluster used by the target group. If you specify + // MaxIdleConnectionsPercent , then you must also include a value for this // parameter. Default: 10 for RDS for Microsoft SQL Server, and 100 for all other // engines Constraints: Must be between 1 and 100. MaxConnectionsPercent *int32 @@ -403,12 +342,12 @@ type ConnectionPoolConfiguration struct { // With a high value, the proxy leaves a high percentage of idle database // connections open. A low value causes the proxy to close more idle connections // and return them to the database. If you specify this parameter, then you must - // also include a value for MaxConnectionsPercent. Default: The default value is - // half of the value of MaxConnectionsPercent. For example, if + // also include a value for MaxConnectionsPercent . Default: The default value is + // half of the value of MaxConnectionsPercent . For example, if // MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent // is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL // Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default - // is 50. Constraints: Must be between 0 and the value of MaxConnectionsPercent. + // is 50. Constraints: Must be between 0 and the value of MaxConnectionsPercent . MaxIdleConnectionsPercent *int32 // Each item in the list represents a class of SQL operations that normally cause @@ -421,7 +360,7 @@ type ConnectionPoolConfiguration struct { } // Displays the settings that control the size and behavior of the connection pool -// associated with a DBProxyTarget. +// associated with a DBProxyTarget . type ConnectionPoolConfigurationInfo struct { // The number of seconds for a proxy to wait for a connection to become available @@ -430,16 +369,16 @@ type ConnectionPoolConfigurationInfo struct { ConnectionBorrowTimeout int32 // One or more SQL statements for the proxy to run when opening each new database - // connection. Typically used with SET statements to make sure that each connection - // has identical settings such as time zone and character set. This setting is - // empty by default. For multiple statements, use semicolons as the separator. You - // can also include multiple variables in a single SET statement, such as SET x=1, - // y=2. + // connection. Typically used with SET statements to make sure that each + // connection has identical settings such as time zone and character set. This + // setting is empty by default. For multiple statements, use semicolons as the + // separator. You can also include multiple variables in a single SET statement, + // such as SET x=1, y=2 . InitQuery *string // The maximum size of the connection pool for each target in a target group. The - // value is expressed as a percentage of the max_connections setting for the RDS DB - // instance or Aurora DB cluster used by the target group. + // value is expressed as a percentage of the max_connections setting for the RDS + // DB instance or Aurora DB cluster used by the target group. MaxConnectionsPercent int32 // Controls how actively the proxy closes idle database connections in the @@ -455,7 +394,7 @@ type ConnectionPoolConfigurationInfo struct { // underlying database connection. Including an item in the list exempts that class // of SQL operations from the pinning behavior. This setting is only supported for // MySQL engine family databases. Currently, the only allowed value is - // EXCLUDE_VARIABLE_SETS. + // EXCLUDE_VARIABLE_SETS . SessionPinningFilters []string noSmithyDocumentSerde @@ -475,19 +414,17 @@ type CustomDBEngineVersionAMI struct { // Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For // an Amazon Aurora DB cluster, this data type is used as a response element in the -// operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, -// FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, -// RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, -// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ -// DB cluster, this data type is used as a response element in the operations -// CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, -// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and -// RestoreDBClusterToPointInTime. For more information on Amazon Aurora DB -// clusters, see What is Amazon Aurora? -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , +// FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , +// RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , +// RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster . For a +// Multi-AZ DB cluster, this data type is used as a response element in the +// operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , +// FailoverDBCluster , ModifyDBCluster , RebootDBCluster , +// RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . For more +// information on Amazon Aurora DB clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, -// see Multi-AZ deployments with two readable standby DB instances -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) +// see Multi-AZ deployments with two readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. type DBCluster struct { @@ -534,8 +471,8 @@ type DBCluster struct { // The number of change records stored for Backtrack. BacktrackConsumedChangeRecords *int64 - // The target backtrack window, in seconds. If this value is set to 0, backtracking - // is disabled for the DB cluster. Otherwise, backtracking is enabled. + // The target backtrack window, in seconds. If this value is set to 0, + // backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. BacktrackWindow *int64 // Specifies the number of days for which automatic DB snapshots are retained. @@ -543,8 +480,7 @@ type DBCluster struct { // The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 // (zero) when the cluster is paused. For more information about Aurora Serverless - // v1, see Using Amazon Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) + // v1, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. Capacity *int32 @@ -563,8 +499,8 @@ type DBCluster struct { // cluster. CopyTagsToSnapshot *bool - // Specifies whether the DB cluster is a clone of a DB cluster owned by a different - // Amazon Web Services account. + // Specifies whether the DB cluster is a clone of a DB cluster owned by a + // different Amazon Web Services account. CrossAccountClone *bool // Identifies all custom endpoints associated with the cluster. @@ -623,8 +559,7 @@ type DBCluster struct { // A list of log types that this DB cluster is configured to export to CloudWatch // Logs. Log types vary by DB engine. For information about the log types for each - // DB engine, see Amazon RDS Database Log Files - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) + // DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) // in the Amazon Aurora User Guide. EnabledCloudwatchLogsExports []string @@ -634,10 +569,10 @@ type DBCluster struct { // The name of the database engine to be used for this DB cluster. Engine *string - // The DB engine mode of the DB cluster, either provisioned, serverless, - // parallelquery, global, or multimaster. For more information, see - // CreateDBCluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). + // The DB engine mode of the DB cluster, either provisioned , serverless , + // parallelquery , global , or multimaster . For more information, see + // CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) + // . EngineMode *string // Indicates the database engine version. @@ -661,17 +596,16 @@ type DBCluster struct { // cluster is enabled. When enabled, the HTTP endpoint provides a connectionless // web service API for running SQL queries on the Aurora Serverless v1 DB cluster. // You can also query your database from inside the RDS console with the query - // editor. For more information, see Using the Data API for Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in - // the Amazon Aurora User Guide. + // editor. For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. HttpEndpointEnabled *bool // A value that indicates whether the mapping of Amazon Web Services Identity and // Access Management (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool - // The Provisioned IOPS (I/O operations per second) value. This setting is only for - // non-Aurora Multi-AZ DB clusters. + // The Provisioned IOPS (I/O operations per second) value. This setting is only + // for non-Aurora Multi-AZ DB clusters. Iops *int32 // If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for @@ -679,17 +613,15 @@ type DBCluster struct { // ARN, key ID, alias ARN, or alias name for the KMS key. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // Contains the secret managed by RDS in Amazon Web Services Secrets Manager for // the master user password. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services - // Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) + // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. MasterUserSecret *MasterUserSecret @@ -701,8 +633,8 @@ type DBCluster struct { // clusters. MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to - // Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB + // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics + // to Amazon CloudWatch Logs. This setting is only for non-Aurora Multi-AZ DB // clusters. MonitoringRoleArn *string @@ -710,16 +642,12 @@ type DBCluster struct { MultiAZ *bool // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB cluster. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the + // IPv6 protocols ( DUAL ). For more information, see Working with a DB instance + // in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. This setting is only for Aurora DB clusters. NetworkType *string @@ -731,8 +659,8 @@ type DBCluster struct { // Specifies the progress of the operation as a percentage. PercentProgress *string - // True if Performance Insights is enabled for the DB cluster, and otherwise false. - // This setting is only for non-Aurora Multi-AZ DB clusters. + // True if Performance Insights is enabled for the DB cluster, and otherwise + // false. This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsEnabled *bool // The Amazon Web Services KMS key identifier for encryption of Performance @@ -743,49 +671,37 @@ type DBCluster struct { // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 - // - // This - // setting is only for non-Aurora Multi-AZ DB clusters. + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 + // This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsRetentionPeriod *int32 // Specifies the port that the database engine is listening on. Port *int32 // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in // Universal Coordinated Time (UTC). PreferredMaintenanceWindow *string - // Specifies the accessibility options for the DB instance. When the DB instance is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the + // Specifies the accessibility options for the DB instance. When the DB instance + // is publicly accessible, its Domain Name System (DNS) endpoint resolves to the // private IP address from within the DB instance's virtual private cloud (VPC). It // resolves to the public IP address from outside of the DB instance's VPC. Access // to the DB instance is ultimately controlled by the security group it uses. That // public access is not permitted if the security group assigned to the DB instance // doesn't permit it. When the DB instance isn't publicly accessible, it is an // internal DB instance with a DNS name that resolves to a private IP address. For - // more information, see CreateDBInstance. This setting is only for non-Aurora + // more information, see CreateDBInstance . This setting is only for non-Aurora // Multi-AZ DB clusters. PubliclyAccessible *bool @@ -808,15 +724,13 @@ type DBCluster struct { // replica. ReplicationSourceIdentifier *string - // Shows the scaling configuration for an Aurora DB cluster in serverless DB engine - // mode. For more information, see Using Amazon Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) + // Shows the scaling configuration for an Aurora DB cluster in serverless DB + // engine mode. For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. ScalingConfigurationInfo *ScalingConfigurationInfo - // Shows the scaling configuration for an Aurora Serverless v2 DB cluster. For more - // information, see Using Amazon Aurora Serverless v2 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) + // Shows the scaling configuration for an Aurora Serverless v2 DB cluster. For + // more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo @@ -830,9 +744,8 @@ type DBCluster struct { // non-Aurora Multi-AZ DB clusters. StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag // Provides a list of VPC security groups that the DB cluster belongs to. @@ -861,20 +774,15 @@ type DBClusterBacktrack struct { // key that identifies a DB cluster. DBClusterIdentifier *string - // The status of the backtrack. This property returns one of the following - // values: - // - // * applying - The backtrack is currently being applied to or rolled back - // from the DB cluster. - // - // * completed - The backtrack has successfully been applied - // to or rolled back from the DB cluster. - // - // * failed - An error occurred while the - // backtrack was applied to or rolled back from the DB cluster. - // - // * pending - The - // backtrack is currently pending application to or rollback from the DB cluster. + // The status of the backtrack. This property returns one of the following values: + // - applying - The backtrack is currently being applied to or rolled back from + // the DB cluster. + // - completed - The backtrack has successfully been applied to or rolled back + // from the DB cluster. + // - failed - An error occurred while the backtrack was applied to or rolled back + // from the DB cluster. + // - pending - The backtrack is currently pending application to or rollback from + // the DB cluster. Status *string noSmithyDocumentSerde @@ -883,21 +791,16 @@ type DBClusterBacktrack struct { // This data type represents the information you need to connect to an Amazon // Aurora DB cluster. This data type is used as a response element in the following // actions: +// - CreateDBClusterEndpoint +// - DescribeDBClusterEndpoints +// - ModifyDBClusterEndpoint +// - DeleteDBClusterEndpoint // -// * CreateDBClusterEndpoint -// -// * DescribeDBClusterEndpoints -// -// * -// ModifyDBClusterEndpoint -// -// * DeleteDBClusterEndpoint -// -// For the data structure that -// represents Amazon RDS DB instance endpoints, see Endpoint. +// For the data structure that represents Amazon RDS DB instance endpoints, see +// Endpoint . type DBClusterEndpoint struct { - // The type associated with a custom endpoint. One of: READER, WRITER, ANY. + // The type associated with a custom endpoint. One of: READER , WRITER , ANY . CustomEndpointType *string // The Amazon Resource Name (ARN) for the endpoint. @@ -918,7 +821,7 @@ type DBClusterEndpoint struct { // The DNS address of the endpoint. Endpoint *string - // The type of the endpoint. One of: READER, WRITER, CUSTOM. + // The type of the endpoint. One of: READER , WRITER , CUSTOM . EndpointType *string // List of DB instance identifiers that aren't part of the custom endpoint group. @@ -929,8 +832,8 @@ type DBClusterEndpoint struct { // List of DB instance identifiers that are part of the custom endpoint group. StaticMembers []string - // The current status of the endpoint. One of: creating, available, deleting, - // inactive, modifying. The inactive state applies to an endpoint that can't be + // The current status of the endpoint. One of: creating , available , deleting , + // inactive , modifying . The inactive state applies to an endpoint that can't be // used for a certain kind of cluster, such as a writer endpoint for a read-only // secondary cluster in a global database. Status *string @@ -941,8 +844,8 @@ type DBClusterEndpoint struct { // Contains information about an instance that is part of a DB cluster. type DBClusterMember struct { - // Specifies the status of the DB cluster parameter group for this member of the DB - // cluster. + // Specifies the status of the DB cluster parameter group for this member of the + // DB cluster. DBClusterParameterGroupStatus *string // Specifies the instance identifier for this member of the DB cluster. @@ -954,8 +857,7 @@ type DBClusterMember struct { // A value that specifies the order in which an Aurora Replica is promoted to the // primary instance after a failure of the existing primary instance. For more - // information, see Fault Tolerance for an Aurora DB Cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. PromotionTier *int32 @@ -974,8 +876,9 @@ type DBClusterOptionGroupStatus struct { noSmithyDocumentSerde } -// Contains the details of an Amazon RDS DB cluster parameter group. This data type -// is used as a response element in the DescribeDBClusterParameterGroups action. +// Contains the details of an Amazon RDS DB cluster parameter group. This data +// type is used as a response element in the DescribeDBClusterParameterGroups +// action. type DBClusterParameterGroup struct { // The Amazon Resource Name (ARN) for the DB cluster parameter group. @@ -1000,7 +903,7 @@ type DBClusterRole struct { // The name of the feature associated with the Amazon Web Services Identity and // Access Management (IAM) role. For information about supported feature names, see - // DBEngineVersion. + // DBEngineVersion . FeatureName *string // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB @@ -1009,17 +912,12 @@ type DBClusterRole struct { // Describes the state of association between the IAM role and the DB cluster. The // Status property returns one of the following values: - // - // * ACTIVE - the IAM role - // ARN is associated with the DB cluster and can be used to access other Amazon Web - // Services on your behalf. - // - // * PENDING - the IAM role ARN is being associated with - // the DB cluster. - // - // * INVALID - the IAM role ARN is associated with the DB cluster, - // but the DB cluster is unable to assume the IAM role in order to access other - // Amazon Web Services on your behalf. + // - ACTIVE - the IAM role ARN is associated with the DB cluster and can be used + // to access other Amazon Web Services on your behalf. + // - PENDING - the IAM role ARN is being associated with the DB cluster. + // - INVALID - the IAM role ARN is associated with the DB cluster, but the DB + // cluster is unable to assume the IAM role in order to access other Amazon Web + // Services on your behalf. Status *string noSmithyDocumentSerde @@ -1098,20 +996,16 @@ type DBClusterSnapshot struct { // Specifies the status of this DB cluster snapshot. Valid statuses are the // following: - // - // * available - // - // * copying - // - // * creating + // - available + // - copying + // - creating Status *string // Specifies whether the DB cluster snapshot is encrypted. StorageEncrypted bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag // Provides the VPC ID associated with the DB cluster snapshot. @@ -1133,7 +1027,7 @@ type DBClusterSnapshotAttribute struct { AttributeName *string // The value(s) for the manual DB cluster snapshot attribute. If the AttributeName - // field is set to restore, then this element returns a list of IDs of the Amazon + // field is set to restore , then this element returns a list of IDs of the Amazon // Web Services accounts that are authorized to copy or restore the manual DB // cluster snapshot. If a value of all is in the list, then the manual DB cluster // snapshot is public and available for any Amazon Web Services account to copy or @@ -1160,7 +1054,7 @@ type DBClusterSnapshotAttributesResult struct { } // This data type is used as a response element in the action -// DescribeDBEngineVersions. +// DescribeDBEngineVersions . type DBEngineVersion struct { // The creation time of the DB engine version. @@ -1170,8 +1064,7 @@ type DBEngineVersion struct { // uses to create a custom engine version (CEV). RDS Custom applies the patches in // the order in which they're listed in the manifest. You can set the Oracle home, // Oracle base, and UNIX/Linux user and group using the installation parameters. - // For more information, see JSON fields in the CEV manifest - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) + // For more information, see JSON fields in the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields) // in the Amazon RDS User Guide. CustomDBEngineVersionManifest *string @@ -1222,15 +1115,13 @@ type DBEngineVersion struct { // The major engine version of the CEV. MajorEngineVersion *string - // The status of the DB engine version, either available or deprecated. + // The status of the DB engine version, either available or deprecated . Status *string // A list of the supported CA certificate identifiers. For more information, see - // Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. SupportedCACertificateIdentifiers []string @@ -1241,13 +1132,13 @@ type DBEngineVersion struct { // A list of the supported DB engine modes. SupportedEngineModes []string - // A list of features supported by the DB engine. The supported features vary by DB - // engine and DB engine version. To determine the supported features for a specific - // DB engine and DB engine version using the CLI, use the following command: aws - // rds describe-db-engine-versions --engine --engine-version For example, to - // determine the supported features for RDS for PostgreSQL version 13.3 using the - // CLI, use the following command: aws rds describe-db-engine-versions --engine - // postgres --engine-version 13.3 The supported features are listed under + // A list of features supported by the DB engine. The supported features vary by + // DB engine and DB engine version. To determine the supported features for a + // specific DB engine and DB engine version using the CLI, use the following + // command: aws rds describe-db-engine-versions --engine --engine-version For + // example, to determine the supported features for RDS for PostgreSQL version 13.3 + // using the CLI, use the following command: aws rds describe-db-engine-versions + // --engine postgres --engine-version 13.3 The supported features are listed under // SupportedFeatureNames in the output. SupportedFeatureNames []string @@ -1275,16 +1166,15 @@ type DBEngineVersion struct { // types specified by ExportableLogTypes to CloudWatch Logs. SupportsLogExportsToCloudwatchLogs bool - // A value that indicates whether you can use Aurora parallel query with a specific - // DB engine version. + // A value that indicates whether you can use Aurora parallel query with a + // specific DB engine version. SupportsParallelQuery bool // Indicates whether the database engine version supports read replicas. SupportsReadReplica bool - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag // A list of engine versions that this database engine version can be upgraded to. @@ -1294,11 +1184,11 @@ type DBEngineVersion struct { } // Contains the details of an Amazon RDS DB instance. This data type is used as a -// response element in the operations CreateDBInstance, -// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, -// ModifyDBInstance, PromoteReadReplica, RebootDBInstance, -// RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, -// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance. +// response element in the operations CreateDBInstance , +// CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , +// ModifyDBInstance , PromoteReadReplica , RebootDBInstance , +// RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , +// RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance . type DBInstance struct { // Indicates whether engine-native audit fields are included in the database @@ -1338,10 +1228,10 @@ type DBInstance struct { // The time when a stopped DB instance is restarted automatically. AutomaticRestartTime *time.Time - // The automation mode of the RDS Custom DB instance: full or all paused. If full, - // the DB instance automates monitoring and instance recovery. If all paused, the - // instance pauses automation for the duration set by - // --resume-full-automation-mode-minutes. + // The automation mode of the RDS Custom DB instance: full or all paused . If full + // , the DB instance automates monitoring and instance recovery. If all paused , + // the instance pauses automation for the duration set by + // --resume-full-automation-mode-minutes . AutomationMode AutomationMode // Specifies the name of the Availability Zone the DB instance is located in. @@ -1358,12 +1248,10 @@ type DBInstance struct { // Services Outposts or the Amazon Web Services Region. BackupTarget *string - // The identifier of the CA certificate for this DB instance. For more information, - // see Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // The identifier of the CA certificate for this DB instance. For more + // information, see Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string @@ -1377,25 +1265,19 @@ type DBInstance struct { // Specifies whether tags are copied from the DB instance to snapshots of the DB // instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by // the DB cluster. Setting this value for an Aurora DB instance has no effect on - // the DB cluster setting. For more information, see DBCluster. + // the DB cluster setting. For more information, see DBCluster . CopyTagsToSnapshot bool // The instance profile associated with the underlying Amazon EC2 instance of an // RDS Custom DB instance. The instance profile must meet the following // requirements: - // - // * The profile must exist in your account. - // - // * The profile must - // have an IAM role that Amazon EC2 has permissions to assume. - // - // * The instance - // profile name and the associated IAM role name must start with the prefix - // AWSRDSCustom. - // - // For the list of permissions required for the IAM role, see - // Configure IAM and your VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) + // - The profile must exist in your account. + // - The profile must have an IAM role that Amazon EC2 has permissions to + // assume. + // - The instance profile name and the associated IAM role name must start with + // the prefix AWSRDSCustom . + // For the list of permissions required for the IAM role, see Configure IAM and + // your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. CustomIamInstanceProfile *string @@ -1405,11 +1287,9 @@ type DBInstance struct { // cases, a CoIP can provide lower latency for connections to the DB instance from // outside of its virtual private cloud (VPC) on your local network. For more // information about RDS on Outposts, see Working with Amazon RDS on Amazon Web - // Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned - // IP addresses - // (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) + // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. For more information about CoIPs, see + // Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) // in the Amazon Web Services Outposts User Guide. CustomerOwnedIpEnabled *bool @@ -1431,8 +1311,7 @@ type DBInstance struct { DBInstanceIdentifier *string // Specifies the current state of this database. For information about DB instance - // statuses, see Viewing DB instance status - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) + // statuses, see Viewing DB instance status (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) // in the Amazon RDS User Guide. DBInstanceStatus *string @@ -1456,23 +1335,23 @@ type DBInstance struct { // including the name, description, and subnets in the subnet group. DBSubnetGroup *DBSubnetGroup - // The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID - // is also the name of the CDB. This setting is valid for RDS Custom only. + // The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle + // SID is also the name of the CDB. This setting is valid for RDS Custom only. DBSystemId *string // Specifies the port that the DB instance listens on. If the DB instance is part // of a DB cluster, this can be a different port than the DB cluster port. DbInstancePort int32 - // The Amazon Web Services Region-unique, immutable identifier for the DB instance. - // This identifier is found in Amazon Web Services CloudTrail log entries whenever - // the Amazon Web Services KMS key for the DB instance is accessed. + // The Amazon Web Services Region-unique, immutable identifier for the DB + // instance. This identifier is found in Amazon Web Services CloudTrail log entries + // whenever the Amazon Web Services KMS key for the DB instance is accessed. DbiResourceId *string - // Indicates if the DB instance has deletion protection enabled. The database can't - // be deleted when deletion protection is enabled. For more information, see - // Deleting a DB Instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance has deletion protection enabled. The database + // can't be deleted when deletion protection is enabled. For more information, see + // Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) + // . DeletionProtection bool // The Active Directory Domain membership records associated with the DB instance. @@ -1480,13 +1359,12 @@ type DBInstance struct { // A list of log types that this DB instance is configured to export to CloudWatch // Logs. Log types vary by DB engine. For information about the log types for each - // DB engine, see Amazon RDS Database Log Files - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in - // the Amazon RDS User Guide. + // DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) + // in the Amazon RDS User Guide. EnabledCloudwatchLogsExports []string - // Specifies the connection endpoint. The endpoint might not be shown for instances - // whose status is creating. + // Specifies the connection endpoint. The endpoint might not be shown for + // instances whose status is creating . Endpoint *Endpoint // The name of the database engine to be used for this DB instance. @@ -1502,15 +1380,10 @@ type DBInstance struct { // True if mapping of Amazon Web Services Identity and Access Management (IAM) // accounts to database accounts is enabled, and otherwise false. IAM database // authentication can be enabled for the following database engines - // - // * For MySQL - // 5.6, minor version 5.6.34 or higher - // - // * For MySQL 5.7, minor version 5.7.16 or - // higher - // - // * Aurora 5.6 or higher. To enable IAM database authentication for - // Aurora, see DBCluster Type. + // - For MySQL 5.6, minor version 5.6.34 or higher + // - For MySQL 5.7, minor version 5.7.16 or higher + // - Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see + // DBCluster Type. IAMDatabaseAuthenticationEnabled bool // Provides the date and time the DB instance was created. @@ -1524,8 +1397,8 @@ type DBInstance struct { // ARN, key ID, alias ARN, or alias name for the KMS key. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. LatestRestorableTime *time.Time // License model information for this DB instance. This setting doesn't apply to @@ -1537,8 +1410,7 @@ type DBInstance struct { // Contains the secret managed by RDS in Amazon Web Services Secrets Manager for // the master user password. For more information, see Password management with - // Amazon Web Services Secrets Manager - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. MasterUserSecret *MasterUserSecret @@ -1553,8 +1425,8 @@ type DBInstance struct { // collected for the DB instance. MonitoringInterval *int32 - // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to - // Amazon CloudWatch Logs. + // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics + // to Amazon CloudWatch Logs. MonitoringRoleArn *string // Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't @@ -1567,27 +1439,22 @@ type DBInstance struct { NcharCharacterSetName *string // The network type of the DB instance. Valid values: - // - // * IPV4 - // - // * DUAL - // - // The network - // type is determined by the DBSubnetGroup specified for the DB instance. A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) - // in the Amazon RDS User Guide and Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // The network type is determined by the DBSubnetGroup specified for the DB + // instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and + // the IPv6 protocols ( DUAL ). For more information, see Working with a DB + // instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // in the Amazon RDS User Guide and Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. NetworkType *string // Provides the list of option group memberships for this DB instance. OptionGroupMemberships []OptionGroupMembership - // A value that specifies that changes to the DB instance are pending. This element - // is only included when changes are pending. Specific changes are identified by - // subelements. + // A value that specifies that changes to the DB instance are pending. This + // element is only included when changes are pending. Specific changes are + // identified by subelements. PendingModifiedValues *PendingModifiedValues // True if Performance Insights is enabled for the DB instance, and otherwise @@ -1601,28 +1468,18 @@ type DBInstance struct { // The number of days to retain Performance Insights data. The default is 7 days. // The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of - // months from 1-23 - // - // * 731 - // + // - 7 + // - month * 31, where month is a number of months from 1-23 + // - 731 // For example, the following values are valid: - // - // * 93 (3 - // months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 + // - 93 (3 months * 31) + // - 341 (11 months * 31) + // - 589 (19 months * 31) + // - 731 PerformanceInsightsRetentionPeriod *int32 // Specifies the daily time range during which automated backups are created if - // automated backups are enabled, as determined by the BackupRetentionPeriod. + // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string // Specifies the weekly time range during which system maintenance can occur, in @@ -1635,8 +1492,7 @@ type DBInstance struct { // A value that specifies the order in which an Aurora Replica is promoted to the // primary instance after a failure of the existing primary instance. For more - // information, see Fault Tolerance for an Aurora DB Cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. PromotionTier *int32 @@ -1648,7 +1504,7 @@ type DBInstance struct { // public access isn't permitted if the security group assigned to the DB cluster // doesn't permit it. When the DB instance isn't publicly accessible, it is an // internal DB instance with a DNS name that resolves to a private IP address. For - // more information, see CreateDBInstance. + // more information, see CreateDBInstance . PubliclyAccessible bool // Contains one or more identifiers of Aurora DB clusters to which the RDS DB @@ -1671,9 +1527,8 @@ type DBInstance struct { // replica. ReadReplicaSourceDBInstanceIdentifier *string - // The open mode of an Oracle read replica. The default is open-read-only. For more - // information, see Working with Oracle Read Replicas for Amazon RDS - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) + // The open mode of an Oracle read replica. The default is open-read-only . For + // more information, see Working with Oracle Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) // in the Amazon RDS User Guide. This attribute is only supported in RDS for // Oracle. ReplicaMode ReplicaMode @@ -1701,9 +1556,8 @@ type DBInstance struct { // Specifies the storage type associated with the DB instance. StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag // The ARN from the key store with which the instance is associated for TDE @@ -1721,9 +1575,9 @@ type DBInstance struct { noSmithyDocumentSerde } -// An automated backup of a DB instance. It consists of system backups, transaction -// logs, and the database instance properties that existed at the time you deleted -// the source instance. +// An automated backup of a DB instance. It consists of system backups, +// transaction logs, and the database instance properties that existed at the time +// you deleted the source instance. type DBInstanceAutomatedBackup struct { // Specifies the allocated storage size in gibibytes (GiB). @@ -1731,8 +1585,8 @@ type DBInstanceAutomatedBackup struct { // The Availability Zone that the automated backup was created in. For information // on Amazon Web Services Regions and Availability Zones, see Regions and - // Availability Zones - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + // Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) + // . AvailabilityZone *string // The retention period for the automated backups. @@ -1805,15 +1659,10 @@ type DBInstanceAutomatedBackup struct { RestoreWindow *RestoreWindow // Provides a list of status information for an automated backup: - // - // * active - - // automated backups for current instances - // - // * retained - automated backups for - // deleted instances - // - // * creating - automated backups that are waiting for the first - // automated snapshot to be available. + // - active - automated backups for current instances + // - retained - automated backups for deleted instances + // - creating - automated backups that are waiting for the first automated + // snapshot to be available. Status *string // Specifies the storage throughput for the automated backup. @@ -1822,8 +1671,8 @@ type DBInstanceAutomatedBackup struct { // Specifies the storage type associated with the automated backup. StorageType *string - // The ARN from the key store with which the automated backup is associated for TDE - // encryption. + // The ARN from the key store with which the automated backup is associated for + // TDE encryption. TdeCredentialArn *string // The time zone of the automated backup. In most cases, the Timezone element is @@ -1854,26 +1703,21 @@ type DBInstanceRole struct { // The name of the feature associated with the Amazon Web Services Identity and // Access Management (IAM) role. For information about supported feature names, see - // DBEngineVersion. + // DBEngineVersion . FeatureName *string // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB // instance. RoleArn *string - // Describes the state of association between the IAM role and the DB instance. The - // Status property returns one of the following values: - // - // * ACTIVE - the IAM role - // ARN is associated with the DB instance and can be used to access other Amazon - // Web Services services on your behalf. - // - // * PENDING - the IAM role ARN is being - // associated with the DB instance. - // - // * INVALID - the IAM role ARN is associated - // with the DB instance, but the DB instance is unable to assume the IAM role in - // order to access other Amazon Web Services services on your behalf. + // Describes the state of association between the IAM role and the DB instance. + // The Status property returns one of the following values: + // - ACTIVE - the IAM role ARN is associated with the DB instance and can be used + // to access other Amazon Web Services services on your behalf. + // - PENDING - the IAM role ARN is being associated with the DB instance. + // - INVALID - the IAM role ARN is associated with the DB instance, but the DB + // instance is unable to assume the IAM role in order to access other Amazon Web + // Services services on your behalf. Status *string noSmithyDocumentSerde @@ -1901,8 +1745,8 @@ type DBInstanceStatusInfo struct { noSmithyDocumentSerde } -// Contains the details of an Amazon RDS DB parameter group. This data type is used -// as a response element in the DescribeDBParameterGroups action. +// Contains the details of an Amazon RDS DB parameter group. This data type is +// used as a response element in the DescribeDBParameterGroups action. type DBParameterGroup struct { // The Amazon Resource Name (ARN) for the DB parameter group. @@ -1923,20 +1767,12 @@ type DBParameterGroup struct { // The status of the DB parameter group. This data type is used as a response // element in the following actions: -// -// * CreateDBInstance -// -// * -// CreateDBInstanceReadReplica -// -// * DeleteDBInstance -// -// * ModifyDBInstance -// -// * -// RebootDBInstance -// -// * RestoreDBInstanceFromDBSnapshot +// - CreateDBInstance +// - CreateDBInstanceReadReplica +// - DeleteDBInstance +// - ModifyDBInstance +// - RebootDBInstance +// - RestoreDBInstanceFromDBSnapshot type DBParameterGroupStatus struct { // The name of the DB parameter group. @@ -1948,12 +1784,12 @@ type DBParameterGroupStatus struct { noSmithyDocumentSerde } -// The data structure representing a proxy managed by the RDS Proxy. This data type -// is used as a response element in the DescribeDBProxies action. +// The data structure representing a proxy managed by the RDS Proxy. This data +// type is used as a response element in the DescribeDBProxies action. type DBProxy struct { - // One or more data structures specifying the authorization mechanism to connect to - // the associated RDS DB instance or Aurora DB cluster. + // One or more data structures specifying the authorization mechanism to connect + // to the associated RDS DB instance or Aurora DB cluster. Auth []UserAuthConfigInfo // The date and time when the proxy was first created. @@ -2000,9 +1836,9 @@ type DBProxy struct { // Amazon Secrets Manager. RoleArn *string - // The current status of this proxy. A status of available means the proxy is ready - // to handle requests. Other values indicate that you must wait for the proxy to be - // ready, or take some action to resolve an issue. + // The current status of this proxy. A status of available means the proxy is + // ready to handle requests. Other values indicate that you must wait for the proxy + // to be ready, or take some action to resolve an issue. Status DBProxyStatus // The date and time when the proxy was last updated. @@ -2086,8 +1922,8 @@ type DBProxyTarget struct { // Aurora DB cluster. Port int32 - // The identifier representing the target. It can be the instance identifier for an - // RDS DB instance, or the cluster identifier for an Aurora DB cluster. + // The identifier representing the target. It can be the instance identifier for + // an RDS DB instance, or the cluster identifier for an Aurora DB cluster. RdsResourceId *string // A value that indicates whether the target of the proxy can be used for @@ -2117,8 +1953,8 @@ type DBProxyTarget struct { // in the DescribeDBProxyTargetGroups action. type DBProxyTargetGroup struct { - // The settings that determine the size and behavior of the connection pool for the - // target group. + // The settings that determine the size and behavior of the connection pool for + // the target group. ConnectionPoolConfig *ConnectionPoolConfigurationInfo // The date and time when the target group was first created. @@ -2129,7 +1965,7 @@ type DBProxyTargetGroup struct { // Whether this target group is the first one used for connection requests by the // associated proxy. Because each proxy is currently associated with a single - // target group, currently this setting is always true. + // target group, currently this setting is always true . IsDefault bool // The current status of this target group. A status of available means the target @@ -2152,8 +1988,8 @@ type DBProxyTargetGroup struct { noSmithyDocumentSerde } -// Contains the details for an Amazon RDS DB security group. This data type is used -// as a response element in the DescribeDBSecurityGroups action. +// Contains the details for an Amazon RDS DB security group. This data type is +// used as a response element in the DescribeDBSecurityGroups action. type DBSecurityGroup struct { // The Amazon Resource Name (ARN) for the DB security group. @@ -2182,16 +2018,10 @@ type DBSecurityGroup struct { } // This data type is used as a response element in the following actions: -// -// * -// ModifyDBInstance -// -// * RebootDBInstance -// -// * RestoreDBInstanceFromDBSnapshot -// -// * -// RestoreDBInstanceToPointInTime +// - ModifyDBInstance +// - RebootDBInstance +// - RestoreDBInstanceFromDBSnapshot +// - RestoreDBInstanceToPointInTime type DBSecurityGroupMembership struct { // The name of the DB security group. @@ -2282,9 +2112,9 @@ type DBSnapshot struct { // Changes for the copy when the snapshot is copied. SnapshotCreateTime *time.Time - // The timestamp of the most recent transaction applied to the database that you're - // backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most - // recent transaction in the restored DB instance. In contrast, + // The timestamp of the most recent transaction applied to the database that + // you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the + // most recent transaction in the restored DB instance. In contrast, // originalSnapshotCreateTime specifies the system time that the snapshot // completed. If you back up a read replica, you can determine the replica lag by // comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if @@ -2292,15 +2122,15 @@ type DBSnapshot struct { // the replica lag is two hours. SnapshotDatabaseTime *time.Time - // Specifies where manual snapshots are stored: Amazon Web Services Outposts or the - // Amazon Web Services Region. + // Specifies where manual snapshots are stored: Amazon Web Services Outposts or + // the Amazon Web Services Region. SnapshotTarget *string // Provides the type of the DB snapshot. SnapshotType *string - // The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. - // It only has a value in the case of a cross-account or cross-Region copy. + // The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied + // from. It only has a value in the case of a cross-account or cross-Region copy. SourceDBSnapshotIdentifier *string // The Amazon Web Services Region that the DB snapshot was created in or copied @@ -2316,9 +2146,8 @@ type DBSnapshot struct { // Specifies the storage type associated with DB snapshot. StorageType *string - // A list of tags. For more information, see Tagging Amazon RDS Resources - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in - // the Amazon RDS User Guide. + // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) + // in the Amazon RDS User Guide. TagList []Tag // The ARN from the key store with which to associate the instance for TDE @@ -2342,14 +2171,14 @@ type DBSnapshot struct { // ModifyDBSnapshotAttribute API. type DBSnapshotAttribute struct { - // The name of the manual DB snapshot attribute. The attribute named restore refers - // to the list of Amazon Web Services accounts that have permission to copy or - // restore the manual DB cluster snapshot. For more information, see the + // The name of the manual DB snapshot attribute. The attribute named restore + // refers to the list of Amazon Web Services accounts that have permission to copy + // or restore the manual DB cluster snapshot. For more information, see the // ModifyDBSnapshotAttribute API action. AttributeName *string // The value or values for the manual DB snapshot attribute. If the AttributeName - // field is set to restore, then this element returns a list of IDs of the Amazon + // field is set to restore , then this element returns a list of IDs of the Amazon // Web Services accounts that are authorized to copy or restore the manual DB // snapshot. If a value of all is in the list, then the manual DB snapshot is // public and available for any Amazon Web Services account to copy or restore. @@ -2373,8 +2202,8 @@ type DBSnapshotAttributesResult struct { noSmithyDocumentSerde } -// Contains the details of an Amazon RDS DB subnet group. This data type is used as -// a response element in the DescribeDBSubnetGroups action. +// Contains the details of an Amazon RDS DB subnet group. This data type is used +// as a response element in the DescribeDBSubnetGroups action. type DBSubnetGroup struct { // The Amazon Resource Name (ARN) for the DB subnet group. @@ -2393,15 +2222,11 @@ type DBSubnetGroup struct { Subnets []Subnet // The network type of the DB subnet group. Valid values: - // - // * IPV4 - // - // * DUAL - // - // A - // DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 - // protocols (DUAL). For more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // - IPV4 + // - DUAL + // A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 + // protocols ( DUAL ). For more information, see Working with a DB instance in a + // VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. SupportedNetworkTypes []string @@ -2411,7 +2236,7 @@ type DBSubnetGroup struct { noSmithyDocumentSerde } -// This data type is used as a response element to DescribeDBLogFiles. +// This data type is used as a response element to DescribeDBLogFiles . type DescribeDBLogFilesDetails struct { // A POSIX timestamp when the last log entry was written. @@ -2460,14 +2285,9 @@ type DoubleRange struct { } // This data type is used as a response element in the following actions: -// -// * -// AuthorizeDBSecurityGroupIngress -// -// * DescribeDBSecurityGroups -// -// * -// RevokeDBSecurityGroupIngress +// - AuthorizeDBSecurityGroupIngress +// - DescribeDBSecurityGroups +// - RevokeDBSecurityGroupIngress type EC2SecurityGroup struct { // Specifies the id of the EC2 security group. @@ -2490,16 +2310,12 @@ type EC2SecurityGroup struct { // This data type represents the information you need to connect to an Amazon RDS // DB instance. This data type is used as a response element in the following // actions: +// - CreateDBInstance +// - DescribeDBInstances +// - DeleteDBInstance // -// * CreateDBInstance -// -// * DescribeDBInstances -// -// * DeleteDBInstance -// -// For the -// data structure that represents Amazon Aurora DB cluster endpoints, see -// DBClusterEndpoint. +// For the data structure that represents Amazon Aurora DB cluster endpoints, see +// DBClusterEndpoint . type Endpoint struct { // Specifies the DNS address of the DB instance. @@ -2533,8 +2349,7 @@ type EngineDefaults struct { noSmithyDocumentSerde } -// This data type is used as a response element in the DescribeEvents -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) +// This data type is used as a response element in the DescribeEvents (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html) // action. type Event struct { @@ -2559,8 +2374,7 @@ type Event struct { noSmithyDocumentSerde } -// Contains the results of a successful invocation of the DescribeEventCategories -// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html) +// Contains the results of a successful invocation of the DescribeEventCategories (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html) // operation. type EventCategoriesMap struct { @@ -2620,22 +2434,15 @@ type EventSubscription struct { // type is used as a response element in the DescribeExportTasks action. type ExportTask struct { - // The data exported from the snapshot or cluster. Valid values are the - // following: - // - // * database - Export all the data from a specified database. - // - // * - // database.table table-name - Export a table of the snapshot or cluster. This - // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. - // - // * - // database.schema schema-name - Export a database schema of the snapshot or - // cluster. This format is valid only for RDS for PostgreSQL and Aurora - // PostgreSQL. + // The data exported from the snapshot or cluster. Valid values are the following: + // - database - Export all the data from a specified database. + // - database.table table-name - Export a table of the snapshot or cluster. This + // format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. + // - database.schema schema-name - Export a database schema of the snapshot or + // cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. // - // * database.schema.table table-name - Export a table of the database - // schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. + // - database.schema.table table-name - Export a table of the database schema. + // This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. ExportOnly []string // A unique identifier for the snapshot or cluster export task. This ID isn't an @@ -2673,21 +2480,13 @@ type ExportTask struct { // The type of source for the export. SourceType ExportSourceType - // The progress status of the export task. The status can be one of the - // following: - // - // * CANCELED - // - // * CANCELING - // - // * COMPLETE - // - // * FAILED - // - // * IN_PROGRESS - // - // * - // STARTING + // The progress status of the export task. The status can be one of the following: + // - CANCELED + // - CANCELING + // - COMPLETE + // - FAILED + // - IN_PROGRESS + // - STARTING Status *string // The time that the snapshot or cluster export task ended. @@ -2706,7 +2505,7 @@ type ExportTask struct { } // Contains the state of scheduled or in-process failover operations on an Aurora -// global database (GlobalCluster). This Data type is empty unless a failover +// global database ( GlobalCluster ). This Data type is empty unless a failover // operation is scheduled or is currently underway on the Aurora global database. type FailoverState struct { @@ -2714,23 +2513,18 @@ type FailoverState struct { // demoted, and which is associated with this state. FromDbClusterArn *string - // The current status of the Aurora global database (GlobalCluster). Possible + // The current status of the Aurora global database ( GlobalCluster ). Possible // values are as follows: - // - // * pending – A request to fail over the Aurora global - // database (GlobalCluster) has been received by the service. The GlobalCluster's - // primary DB cluster and the specified secondary DB cluster are being verified - // before the failover process can start. - // - // * failing-over – This status covers the - // range of Aurora internal operations that take place during the failover process, - // such as demoting the primary Aurora DB cluster, promoting the secondary Aurora - // DB, and synchronizing replicas. - // - // * cancelling – The request to fail over the - // Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB - // cluster and the selected secondary Aurora DB cluster are returning to their - // previous states. + // - pending – A request to fail over the Aurora global database ( GlobalCluster + // ) has been received by the service. The GlobalCluster 's primary DB cluster + // and the specified secondary DB cluster are being verified before the failover + // process can start. + // - failing-over – This status covers the range of Aurora internal operations + // that take place during the failover process, such as demoting the primary Aurora + // DB cluster, promoting the secondary Aurora DB, and synchronizing replicas. + // - cancelling – The request to fail over the Aurora global database ( + // GlobalCluster ) was cancelled and the primary Aurora DB cluster and the + // selected secondary Aurora DB cluster are returning to their previous states. Status FailoverStatus // The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being @@ -2745,18 +2539,11 @@ type FailoverState struct { // resources by specific criteria, such as IDs. The filters supported by a describe // operation are documented with the describe operation. Currently, wildcards are // not supported in filters. The following actions can be filtered: -// -// * -// DescribeDBClusterBacktracks -// -// * DescribeDBClusterEndpoints -// -// * -// DescribeDBClusters -// -// * DescribeDBInstances -// -// * DescribePendingMaintenanceActions +// - DescribeDBClusterBacktracks +// - DescribeDBClusterEndpoints +// - DescribeDBClusters +// - DescribeDBInstances +// - DescribePendingMaintenanceActions type Filter struct { // The name of the filter. Filter names are case-sensitive. @@ -2790,7 +2577,7 @@ type GlobalCluster struct { // A data object containing all properties for the current state of an in-process // or pending failover process for this Aurora global database. This object is // empty unless the FailoverGlobalCluster API operation has been called on this - // Aurora global database (GlobalCluster). + // Aurora global database ( GlobalCluster ). FailoverState *FailoverState // The Amazon Resource Name (ARN) for the global database cluster. @@ -2847,8 +2634,8 @@ type IPRange struct { // Specifies the IP range. CIDRIP *string - // Specifies the status of the IP range. Status can be "authorizing", "authorized", - // "revoking", and "revoked". + // Specifies the status of the IP range. Status can be "authorizing", + // "authorized", "revoking", and "revoked". Status *string noSmithyDocumentSerde @@ -2856,11 +2643,9 @@ type IPRange struct { // Contains the secret managed by RDS in Amazon Web Services Secrets Manager for // the master user password. For more information, see Password management with -// Amazon Web Services Secrets Manager -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) +// Amazon Web Services Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services -// Secrets Manager -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) +// Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. type MasterUserSecret struct { @@ -2871,23 +2656,16 @@ type MasterUserSecret struct { SecretArn *string // The status of the secret. The possible status values include the following: - // - // * - // creating - The secret is being created. - // - // * active - The secret is available for - // normal use and rotation. - // - // * rotating - The secret is being rotated. - // - // * impaired - // - The secret can be used to access database credentials, but it can't be - // rotated. A secret might have this status if, for example, permissions are - // changed so that RDS can no longer access either the secret or the KMS key for - // the secret. When a secret has this status, you can correct the condition that - // caused the status. Alternatively, modify the DB instance to turn off automatic - // management of database credentials, and then modify the DB instance again to - // turn on automatic management of database credentials. + // - creating - The secret is being created. + // - active - The secret is available for normal use and rotation. + // - rotating - The secret is being rotated. + // - impaired - The secret can be used to access database credentials, but it + // can't be rotated. A secret might have this status if, for example, permissions + // are changed so that RDS can no longer access either the secret or the KMS key + // for the secret. When a secret has this status, you can correct the condition + // that caused the status. Alternatively, modify the DB instance to turn off + // automatic management of database credentials, and then modify the DB instance + // again to turn on automatic management of database credentials. SecretStatus *string noSmithyDocumentSerde @@ -3002,11 +2780,11 @@ type OptionGroup struct { // Specifies the name of the option group from which this option group is copied. SourceOptionGroup *string - // If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If - // AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this - // option group can be applied to both VPC and non-VPC instances. If this field - // contains a value, then this option group can only be applied to instances that - // are in the VPC indicated by this field. + // If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If + // AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then + // this option group can be applied to both VPC and non-VPC instances. If this + // field contains a value, then this option group can only be applied to instances + // that are in the VPC indicated by this field. VpcId *string noSmithyDocumentSerde @@ -3019,8 +2797,8 @@ type OptionGroupMembership struct { OptionGroupName *string // The status of the DB instance's option group membership. Valid values are: - // in-sync, pending-apply, pending-removal, pending-maintenance-apply, - // pending-maintenance-removal, applying, removing, and failed. + // in-sync , pending-apply , pending-removal , pending-maintenance-apply , + // pending-maintenance-removal , applying , removing , and failed . Status *string noSmithyDocumentSerde @@ -3236,9 +3014,8 @@ type OrderableDBInstanceOption struct { MultiAZCapable bool // Whether a DB instance supports RDS on Outposts. For more information about RDS - // on Outposts, see Amazon RDS on Amazon Web Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. + // on Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. OutpostCapable bool // Indicates whether a DB instance can have a read replica. @@ -3248,7 +3025,7 @@ type OrderableDBInstanceOption struct { StorageType *string // The list of supported modes for Database Activity Streams. Aurora PostgreSQL - // returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] + // returns the value [sync, async] . Aurora MySQL and RDS for Oracle return [async] // only. If Database Activity Streams isn't supported, the return value is an empty // list. SupportedActivityStreamModes []string @@ -3256,22 +3033,20 @@ type OrderableDBInstanceOption struct { // A list of the supported DB engine modes. SupportedEngineModes []string - // The network types supported by the DB instance (IPV4 or DUAL). A DB instance can - // support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For - // more information, see Working with a DB instance in a VPC - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // The network types supported by the DB instance ( IPV4 or DUAL ). A DB instance + // can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL ). + // For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. SupportedNetworkTypes []string // Whether DB instances can be configured as a Multi-AZ DB cluster. For more - // information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable - // standby DB instances - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) + // information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable + // standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. SupportsClusters bool - // Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 - // to 60 seconds. + // Indicates whether a DB instance supports Enhanced Monitoring at intervals from + // 1 to 60 seconds. SupportsEnhancedMonitoring bool // A value that indicates whether you can use Aurora global databases with a @@ -3290,8 +3065,8 @@ type OrderableDBInstanceOption struct { // True if a DB instance supports Performance Insights, otherwise false. SupportsPerformanceInsights bool - // Whether Amazon RDS can automatically scale storage for DB instances that use the - // specified DB instance class. + // Whether Amazon RDS can automatically scale storage for DB instances that use + // the specified DB instance class. SupportsStorageAutoscaling *bool // Indicates whether a DB instance supports encrypted storage. @@ -3307,9 +3082,8 @@ type OrderableDBInstanceOption struct { } // A data type that represents an Outpost. For more information about RDS on -// Outposts, see Amazon RDS on Amazon Web Services Outposts -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in -// the Amazon RDS User Guide. +// Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) +// in the Amazon RDS User Guide. type Outpost struct { // The Amazon Resource Name (ARN) of the Outpost. @@ -3338,7 +3112,7 @@ type Parameter struct { // Provides a description of the parameter. Description *string - // Indicates whether (true) or not (false) the parameter can be modified. Some + // Indicates whether ( true ) or not ( false ) the parameter can be modified. Some // parameters have security or operational implications that prevent them from // being changed. IsModifiable bool @@ -3379,9 +3153,9 @@ type PendingCloudwatchLogsExports struct { // Provides information about a pending maintenance action for a resource. type PendingMaintenanceAction struct { - // The type of pending maintenance action that is available for the resource. Valid - // actions are system-update, db-upgrade, hardware-maintenance, and - // ca-certificate-rotation. + // The type of pending maintenance action that is available for the resource. + // Valid actions are system-update , db-upgrade , hardware-maintenance , and + // ca-certificate-rotation . Action *string // The date of the maintenance window when the action is applied. The maintenance @@ -3391,18 +3165,18 @@ type PendingMaintenanceAction struct { // The effective date when the pending maintenance action is applied to the // resource. This date takes into account opt-in requests received from the - // ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the - // ForcedApplyDate. This value is blank if an opt-in request has not been received - // and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. + // ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the + // ForcedApplyDate . This value is blank if an opt-in request has not been received + // and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate . CurrentApplyDate *time.Time // A description providing more detail about the maintenance action. Description *string - // The date when the maintenance action is automatically applied. On this date, the - // maintenance action is applied to the resource as soon as possible, regardless of - // the maintenance window for the resource. There might be a delay of one or more - // days from this date before the maintenance action is applied. + // The date when the maintenance action is automatically applied. On this date, + // the maintenance action is applied to the resource as soon as possible, + // regardless of the maintenance window for the resource. There might be a delay of + // one or more days from this date before the maintenance action is applied. ForcedApplyDate *time.Time // Indicates the type of opt-in request that has been received for the resource. @@ -3418,21 +3192,19 @@ type PendingModifiedValues struct { // The allocated storage size for the DB instance specified in gibibytes (GiB). AllocatedStorage *int32 - // The automation mode of the RDS Custom DB instance: full or all-paused. If full, - // the DB instance automates monitoring and instance recovery. If all-paused, the - // instance pauses automation for the duration set by - // --resume-full-automation-mode-minutes. + // The automation mode of the RDS Custom DB instance: full or all-paused . If full + // , the DB instance automates monitoring and instance recovery. If all-paused , + // the instance pauses automation for the duration set by + // --resume-full-automation-mode-minutes . AutomationMode AutomationMode // The number of days for which automated backups are retained. BackupRetentionPeriod *int32 // The identifier of the CA certificate for the DB instance. For more information, - // see Using SSL/TLS to encrypt a connection to a DB instance - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) - // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB - // cluster - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) + // see Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) + // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB + // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string @@ -3491,57 +3263,37 @@ type PendingModifiedValues struct { noSmithyDocumentSerde } -// Contains the processor features of a DB instance class. To specify the number of -// CPU cores, use the coreCount feature name for the Name parameter. To specify the -// number of threads per core, use the threadsPerCore feature name for the Name +// Contains the processor features of a DB instance class. To specify the number +// of CPU cores, use the coreCount feature name for the Name parameter. To specify +// the number of threads per core, use the threadsPerCore feature name for the Name // parameter. You can set the processor features of the DB instance class for a DB // instance when you call one of the following actions: +// - CreateDBInstance +// - ModifyDBInstance +// - RestoreDBInstanceFromDBSnapshot +// - RestoreDBInstanceFromS3 +// - RestoreDBInstanceToPointInTime // -// * CreateDBInstance +// You can view the valid processor values for a particular instance class by +// calling the DescribeOrderableDBInstanceOptions action and specifying the +// instance class for the DBInstanceClass parameter. In addition, you can use the +// following actions for DB instance class processor information: +// - DescribeDBInstances +// - DescribeDBSnapshots +// - DescribeValidDBInstanceModifications // -// * -// ModifyDBInstance +// If you call DescribeDBInstances , ProcessorFeature returns non-null values only +// if the following conditions are met: +// - You are accessing an Oracle DB instance. +// - Your Oracle DB instance class supports configuring the number of CPU cores +// and threads per core. +// - The current number CPU cores and threads is set to a non-default value. // -// * RestoreDBInstanceFromDBSnapshot -// -// * -// RestoreDBInstanceFromS3 -// -// * RestoreDBInstanceToPointInTime -// -// You can view the -// valid processor values for a particular instance class by calling the -// DescribeOrderableDBInstanceOptions action and specifying the instance class for -// the DBInstanceClass parameter. In addition, you can use the following actions -// for DB instance class processor information: -// -// * DescribeDBInstances -// -// * -// DescribeDBSnapshots -// -// * DescribeValidDBInstanceModifications -// -// If you call -// DescribeDBInstances, ProcessorFeature returns non-null values only if the -// following conditions are met: -// -// * You are accessing an Oracle DB instance. -// -// * -// Your Oracle DB instance class supports configuring the number of CPU cores and -// threads per core. -// -// * The current number CPU cores and threads is set to a -// non-default value. -// -// For more information, see Configuring the Processor of the -// DB Instance Class -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) +// For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) // in the Amazon RDS User Guide. type ProcessorFeature struct { - // The name of the processor feature. Valid names are coreCount and threadsPerCore. + // The name of the processor feature. Valid names are coreCount and threadsPerCore . Name *string // The value of a processor feature name. @@ -3701,8 +3453,7 @@ type RestoreWindow struct { } // Contains the scaling configuration of an Aurora Serverless v1 DB cluster. For -// more information, see Using Amazon Aurora Serverless v1 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) +// more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. type ScalingConfiguration struct { @@ -3714,15 +3465,17 @@ type ScalingConfiguration struct { AutoPause *bool // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For - // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and - // 384. The maximum capacity must be greater than or equal to the minimum capacity. + // Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and + // 256 . For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 + // , 192 , and 384 . The maximum capacity must be greater than or equal to the + // minimum capacity. MaxCapacity *int32 // The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For - // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and - // 384. The minimum capacity must be less than or equal to the maximum capacity. + // Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and + // 256 . For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 + // , 192 , and 384 . The minimum capacity must be less than or equal to the maximum + // capacity. MinCapacity *int32 // The amount of time, in seconds, that Aurora Serverless v1 tries to find a @@ -3735,22 +3488,20 @@ type ScalingConfiguration struct { SecondsUntilAutoPause *int32 // The action to take when the timeout is reached, either ForceApplyCapacityChange - // or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the - // specified value as soon as possible. RollbackCapacityChange, the default, + // or RollbackCapacityChange . ForceApplyCapacityChange sets the capacity to the + // specified value as soon as possible. RollbackCapacityChange , the default, // ignores the capacity change if a scaling point isn't found in the timeout - // period. If you specify ForceApplyCapacityChange, connections that prevent Aurora - // Serverless v1 from finding a scaling point might be dropped. For more - // information, see Autoscaling for Aurora Serverless v1 - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) + // period. If you specify ForceApplyCapacityChange , connections that prevent + // Aurora Serverless v1 from finding a scaling point might be dropped. For more + // information, see Autoscaling for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) // in the Amazon Aurora User Guide. TimeoutAction *string noSmithyDocumentSerde } -// Shows the scaling configuration for an Aurora DB cluster in serverless DB engine -// mode. For more information, see Using Amazon Aurora Serverless v1 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) +// Shows the scaling configuration for an Aurora DB cluster in serverless DB +// engine mode. For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. type ScalingConfigurationInfo struct { @@ -3776,7 +3527,7 @@ type ScalingConfigurationInfo struct { // The action that occurs when Aurora times out while attempting to change the // capacity of an Aurora Serverless v1 cluster. The value is either - // ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, + // ForceApplyCapacityChange or RollbackCapacityChange . ForceApplyCapacityChange , // the default, sets the capacity to the specified value as soon as possible. // RollbackCapacityChange ignores the capacity change if a scaling point isn't // found in the timeout period. @@ -3786,8 +3537,7 @@ type ScalingConfigurationInfo struct { } // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For -// more information, see Using Amazon Aurora Serverless v2 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) +// more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. type ServerlessV2ScalingConfiguration struct { @@ -3806,9 +3556,8 @@ type ServerlessV2ScalingConfiguration struct { noSmithyDocumentSerde } -// Shows the scaling configuration for an Aurora Serverless v2 DB cluster. For more -// information, see Using Amazon Aurora Serverless v2 -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) +// Shows the scaling configuration for an Aurora Serverless v2 DB cluster. For +// more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. type ServerlessV2ScalingConfigurationInfo struct { @@ -3860,9 +3609,8 @@ type Subnet struct { // If the subnet is associated with an Outpost, this value specifies the Outpost. // For more information about RDS on Outposts, see Amazon RDS on Amazon Web - // Services Outposts - // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in - // the Amazon RDS User Guide. + // Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // in the Amazon RDS User Guide. SubnetOutpost *Outpost // The status of the subnet. @@ -3872,11 +3620,9 @@ type Subnet struct { } // Contains the details about a blue/green deployment. For more information, see -// Using Amazon RDS Blue/Green Deployments for database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) +// Using Amazon RDS Blue/Green Deployments for database updates (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html) // in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for -// database updates -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) +// database updates (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html) // in the Amazon Aurora User Guide. type SwitchoverDetail struct { @@ -3884,26 +3630,13 @@ type SwitchoverDetail struct { SourceMember *string // The switchover status of a resource in a blue/green deployment. Values: - // - // * - // PROVISIONING - The resource is being prepared to switch over. - // - // * AVAILABLE - The - // resource is ready to switch over. - // - // * SWITCHOVER_IN_PROGRESS - The resource is - // being switched over. - // - // * SWITCHOVER_COMPLETED - The resource has been switched - // over. - // - // * SWITCHOVER_FAILED - The resource attempted to switch over but - // failed. - // - // * MISSING_SOURCE - The source resource has been deleted. - // - // * - // MISSING_TARGET - The target resource has been deleted. + // - PROVISIONING - The resource is being prepared to switch over. + // - AVAILABLE - The resource is ready to switch over. + // - SWITCHOVER_IN_PROGRESS - The resource is being switched over. + // - SWITCHOVER_COMPLETED - The resource has been switched over. + // - SWITCHOVER_FAILED - The resource attempted to switch over but failed. + // - MISSING_SOURCE - The source resource has been deleted. + // - MISSING_TARGET - The target resource has been deleted. Status *string // The Amazon Resource Name (ARN) of a resource in the green environment. @@ -3913,22 +3646,21 @@ type SwitchoverDetail struct { } // Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For -// more information, see Tagging Amazon RDS Resources -// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in -// the Amazon RDS User Guide. +// more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) +// in the Amazon RDS User Guide. type Tag struct { // A key is the required name of the tag. The string value can be from 1 to 128 - // Unicode characters in length and can't be prefixed with aws: or rds:. The string - // can only contain only the set of Unicode letters, digits, white-space, '_', '.', - // ':', '/', '=', '+', '-', '@' (Java regex: + // Unicode characters in length and can't be prefixed with aws: or rds: . The + // string can only contain only the set of Unicode letters, digits, white-space, + // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: // "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). Key *string // A value is the optional value of the tag. The string value can be from 1 to 256 - // Unicode characters in length and can't be prefixed with aws: or rds:. The string - // can only contain only the set of Unicode letters, digits, white-space, '_', '.', - // ':', '/', '=', '+', '-', '@' (Java regex: + // Unicode characters in length and can't be prefixed with aws: or rds: . The + // string can only contain only the set of Unicode letters, digits, white-space, + // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: // "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). Value *string @@ -3938,7 +3670,7 @@ type Tag struct { // Information about the connection health of an RDS Proxy target. type TargetHealth struct { - // A description of the health of the RDS Proxy target. If the State is AVAILABLE, + // A description of the health of the RDS Proxy target. If the State is AVAILABLE , // a description is not included. Description *string @@ -3953,9 +3685,9 @@ type TargetHealth struct { noSmithyDocumentSerde } -// A time zone associated with a DBInstance or a DBSnapshot. This data type is an -// element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and -// the DescribeDBEngineVersions actions. +// A time zone associated with a DBInstance or a DBSnapshot . This data type is an +// element in the response to the DescribeDBInstances , the DescribeDBSnapshots , +// and the DescribeDBEngineVersions actions. type Timezone struct { // The name of the time zone. @@ -3995,8 +3727,8 @@ type UpgradeTarget struct { // target engine version. SupportsGlobalDatabases *bool - // A value that indicates whether you can use Aurora parallel query with the target - // engine version. + // A value that indicates whether you can use Aurora parallel query with the + // target engine version. SupportsParallelQuery *bool noSmithyDocumentSerde @@ -4006,8 +3738,8 @@ type UpgradeTarget struct { // database user. type UserAuthConfig struct { - // The type of authentication that the proxy uses for connections from the proxy to - // the underlying database. + // The type of authentication that the proxy uses for connections from the proxy + // to the underlying database. AuthScheme AuthScheme // The type of authentication the proxy uses for connections from clients. @@ -4037,8 +3769,8 @@ type UserAuthConfig struct { // database user. type UserAuthConfigInfo struct { - // The type of authentication that the proxy uses for connections from the proxy to - // the underlying database. + // The type of authentication that the proxy uses for connections from the proxy + // to the underlying database. AuthScheme AuthScheme // The type of authentication the proxy uses for connections from clients. @@ -4067,7 +3799,7 @@ type UserAuthConfigInfo struct { // Information about valid modifications that you can make to your DB instance. // Contains the result of a successful call to the // DescribeValidDBInstanceModifications action. You can use this information when -// you call ModifyDBInstance. +// you call ModifyDBInstance . type ValidDBInstanceModificationsMessage struct { // Valid storage options for your DB instance. @@ -4118,7 +3850,7 @@ type ValidStorageOptions struct { type VpcSecurityGroupMembership struct { // The membership status of the VPC security group. Currently, the only valid - // status is active. + // status is active . Status *string // The name of the VPC security group. diff --git a/service/rdsdata/api_client.go b/service/rdsdata/api_client.go index 4c94b5e3949..61d521e58f2 100644 --- a/service/rdsdata/api_client.go +++ b/service/rdsdata/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rdsdata/api_op_BatchExecuteStatement.go b/service/rdsdata/api_op_BatchExecuteStatement.go index 787438d6c9a..439d71fd38c 100644 --- a/service/rdsdata/api_op_BatchExecuteStatement.go +++ b/service/rdsdata/api_op_BatchExecuteStatement.go @@ -15,12 +15,12 @@ import ( // insert operations for multiple records using a DML statement with different // parameter sets. Bulk operations can provide a significant performance // improvement over individual insert and update operations. If a call isn't part -// of a transaction because it doesn't include the transactionID parameter, changes -// that result from the call are committed automatically. There isn't a fixed upper -// limit on the number of parameter sets. However, the maximum size of the HTTP -// request submitted through the Data API is 4 MiB. If the request exceeds this -// limit, the Data API returns an error and doesn't process the request. This 4-MiB -// limit includes the size of the HTTP headers and the JSON notation in the +// of a transaction because it doesn't include the transactionID parameter, +// changes that result from the call are committed automatically. There isn't a +// fixed upper limit on the number of parameter sets. However, the maximum size of +// the HTTP request submitted through the Data API is 4 MiB. If the request exceeds +// this limit, the Data API returns an error and doesn't process the request. This +// 4-MiB limit includes the size of the HTTP headers and the JSON notation in the // request. Thus, the number of parameter sets that you can include depends on a // combination of factors, such as the size of the SQL statement and the size of // each parameter set. The response size limit is 1 MiB. If the call returns more @@ -51,8 +51,8 @@ type BatchExecuteStatementInput struct { // The ARN of the secret that enables access to the DB cluster. Enter the database // user name and password for the credentials in the secret. For information about - // creating the secret, see Create a database secret - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html). + // creating the secret, see Create a database secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html) + // . // // This member is required. SecretArn *string @@ -66,16 +66,12 @@ type BatchExecuteStatementInput struct { // The name of the database. Database *string - // The parameter set for the batch operation. The SQL statement is executed as many - // times as the number of parameter sets provided. To execute a SQL statement with - // no parameters, use one of the following options: - // - // * Specify one or more empty - // parameter sets. - // - // * Use the ExecuteStatement operation instead of the - // BatchExecuteStatement operation. - // + // The parameter set for the batch operation. The SQL statement is executed as + // many times as the number of parameter sets provided. To execute a SQL statement + // with no parameters, use one of the following options: + // - Specify one or more empty parameter sets. + // - Use the ExecuteStatement operation instead of the BatchExecuteStatement + // operation. // Array parameters are not supported. ParameterSets [][]types.SqlParameter diff --git a/service/rdsdata/api_op_ExecuteSql.go b/service/rdsdata/api_op_ExecuteSql.go index 239aac3cc5e..c37d537d9fb 100644 --- a/service/rdsdata/api_op_ExecuteSql.go +++ b/service/rdsdata/api_op_ExecuteSql.go @@ -37,8 +37,8 @@ type ExecuteSqlInput struct { // The Amazon Resource Name (ARN) of the secret that enables access to the DB // cluster. Enter the database user name and password for the credentials in the - // secret. For information about creating the secret, see Create a database secret - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html). + // secret. For information about creating the secret, see Create a database secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html) + // . // // This member is required. AwsSecretStoreArn *string diff --git a/service/rdsdata/api_op_ExecuteStatement.go b/service/rdsdata/api_op_ExecuteStatement.go index 5f567a43673..f2d86090bb6 100644 --- a/service/rdsdata/api_op_ExecuteStatement.go +++ b/service/rdsdata/api_op_ExecuteStatement.go @@ -12,8 +12,8 @@ import ( ) // Runs a SQL statement against a database. If a call isn't part of a transaction -// because it doesn't include the transactionID parameter, changes that result from -// the call are committed automatically. If the binary response data from the +// because it doesn't include the transactionID parameter, changes that result +// from the call are committed automatically. If the binary response data from the // database is more than 1 MB, the call is terminated. func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error) { if params == nil { @@ -41,8 +41,8 @@ type ExecuteStatementInput struct { // The ARN of the secret that enables access to the DB cluster. Enter the database // user name and password for the credentials in the secret. For information about - // creating the secret, see Create a database secret - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html). + // creating the secret, see Create a database secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html) + // . // // This member is required. SecretArn *string @@ -62,13 +62,12 @@ type ExecuteStatementInput struct { // The name of the database. Database *string - // A value that indicates whether to format the result set as a single JSON string. - // This parameter only applies to SELECT statements and is ignored for other types - // of statements. Allowed values are NONE and JSON. The default value is NONE. The - // result is returned in the formattedRecords field. For usage information about - // the JSON format for result sets, see Using the Data API - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in - // the Amazon Aurora User Guide. + // A value that indicates whether to format the result set as a single JSON + // string. This parameter only applies to SELECT statements and is ignored for + // other types of statements. Allowed values are NONE and JSON . The default value + // is NONE . The result is returned in the formattedRecords field. For usage + // information about the JSON format for result sets, see Using the Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. FormatRecordsAs types.RecordsFormatType // A value that indicates whether to include metadata in the results. @@ -98,20 +97,20 @@ type ExecuteStatementInput struct { type ExecuteStatementOutput struct { // Metadata for the columns included in the results. This field is blank if the - // formatRecordsAs parameter is set to JSON. + // formatRecordsAs parameter is set to JSON . ColumnMetadata []types.ColumnMetadata // A string value that represents the result set of a SELECT statement in JSON // format. This value is only present when the formatRecordsAs parameter is set to - // JSON. The size limit for this field is currently 10 MB. If the JSON-formatted + // JSON . The size limit for this field is currently 10 MB. If the JSON-formatted // string representing the result set requires more than 10 MB, the call returns an // error. FormattedRecords *string - // Values for fields generated during a DML request. The generatedFields data isn't - // supported by Aurora PostgreSQL. To get the values of generated fields, use the - // RETURNING clause. For more information, see Returning Data From Modified Rows - // (https://www.postgresql.org/docs/10/dml-returning.html) in the PostgreSQL + // Values for fields generated during a DML request. The generatedFields data + // isn't supported by Aurora PostgreSQL. To get the values of generated fields, use + // the RETURNING clause. For more information, see Returning Data From Modified + // Rows (https://www.postgresql.org/docs/10/dml-returning.html) in the PostgreSQL // documentation. GeneratedFields []types.Field @@ -119,7 +118,7 @@ type ExecuteStatementOutput struct { NumberOfRecordsUpdated int64 // The records returned by the SQL statement. This field is blank if the - // formatRecordsAs parameter is set to JSON. + // formatRecordsAs parameter is set to JSON . Records [][]types.Field // Metadata pertaining to the operation's result. diff --git a/service/rdsdata/api_op_RollbackTransaction.go b/service/rdsdata/api_op_RollbackTransaction.go index 36baf625908..fd0bc793bfd 100644 --- a/service/rdsdata/api_op_RollbackTransaction.go +++ b/service/rdsdata/api_op_RollbackTransaction.go @@ -27,8 +27,8 @@ func (c *Client) RollbackTransaction(ctx context.Context, params *RollbackTransa return out, nil } -// The request parameters represent the input of a request to perform a rollback of -// a transaction. +// The request parameters represent the input of a request to perform a rollback +// of a transaction. type RollbackTransactionInput struct { // The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. @@ -49,8 +49,8 @@ type RollbackTransactionInput struct { noSmithyDocumentSerde } -// The response elements represent the output of a request to perform a rollback of -// a transaction. +// The response elements represent the output of a request to perform a rollback +// of a transaction. type RollbackTransactionOutput struct { // The status of the rollback operation. diff --git a/service/rdsdata/doc.go b/service/rdsdata/doc.go index b77b762dd1d..7d1c28aa9f5 100644 --- a/service/rdsdata/doc.go +++ b/service/rdsdata/doc.go @@ -1,13 +1,12 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package rdsdata provides the API client, operations, and parameter types for AWS -// RDS DataService. +// Package rdsdata provides the API client, operations, and parameter types for +// AWS RDS DataService. // // Amazon RDS Data Service Amazon RDS provides an HTTP endpoint to run SQL // statements on an Amazon Aurora Serverless v1 DB cluster. To run these // statements, you work with the Data Service API. The Data Service API isn't // supported on Amazon Aurora Serverless v2 DB clusters. For more information about -// the Data Service API, see Using the Data API -// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in -// the Amazon Aurora User Guide. +// the Data Service API, see Using the Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) +// in the Amazon Aurora User Guide. package rdsdata diff --git a/service/rdsdata/types/errors.go b/service/rdsdata/types/errors.go index b3b9215bfef..e46d71870f2 100644 --- a/service/rdsdata/types/errors.go +++ b/service/rdsdata/types/errors.go @@ -111,7 +111,7 @@ func (e *InternalServerErrorException) ErrorCode() string { } func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The resourceArn, secretArn, or transactionId value can't be found. +// The resourceArn , secretArn , or transactionId value can't be found. type NotFoundException struct { Message *string diff --git a/service/rdsdata/types/types.go b/service/rdsdata/types/types.go index 73ae963eb20..f488a76ef05 100644 --- a/service/rdsdata/types/types.go +++ b/service/rdsdata/types/types.go @@ -231,7 +231,7 @@ type ResultSetMetadata struct { type ResultSetOptions struct { // A value that indicates how a field of DECIMAL type is represented in the - // response. The value of STRING, the default, specifies that it is converted to a + // response. The value of STRING , the default, specifies that it is converted to a // String value. The value of DOUBLE_OR_LONG specifies that it is converted to a // Long value if its scale is 0, or to a Double value otherwise. Conversion to // Double or Long can result in roundoff errors due to precision loss. We recommend @@ -239,7 +239,7 @@ type ResultSetOptions struct { DecimalReturnType DecimalReturnType // A value that indicates how a field of LONG type is represented. Allowed values - // are LONG and STRING. The default is LONG. Specify STRING if the length or + // are LONG and STRING . The default is LONG . Specify STRING if the length or // precision of numeric values might cause truncation or rounding errors. LongReturnType LongReturnType @@ -254,28 +254,19 @@ type SqlParameter struct { // A hint that specifies the correct object type for data type mapping. Possible // values are as follows: - // - // * DATE - The corresponding String parameter value is - // sent as an object of DATE type to the database. The accepted format is - // YYYY-MM-DD. - // - // * DECIMAL - The corresponding String parameter value is sent as an - // object of DECIMAL type to the database. - // - // * JSON - The corresponding String - // parameter value is sent as an object of JSON type to the database. - // - // * TIME - The - // corresponding String parameter value is sent as an object of TIME type to the - // database. The accepted format is HH:MM:SS[.FFF]. - // - // * TIMESTAMP - The - // corresponding String parameter value is sent as an object of TIMESTAMP type to - // the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF]. - // - // * UUID - The - // corresponding String parameter value is sent as an object of UUID type to the - // database. + // - DATE - The corresponding String parameter value is sent as an object of DATE + // type to the database. The accepted format is YYYY-MM-DD . + // - DECIMAL - The corresponding String parameter value is sent as an object of + // DECIMAL type to the database. + // - JSON - The corresponding String parameter value is sent as an object of JSON + // type to the database. + // - TIME - The corresponding String parameter value is sent as an object of TIME + // type to the database. The accepted format is HH:MM:SS[.FFF] . + // - TIMESTAMP - The corresponding String parameter value is sent as an object of + // TIMESTAMP type to the database. The accepted format is YYYY-MM-DD + // HH:MM:SS[.FFF] . + // - UUID - The corresponding String parameter value is sent as an object of UUID + // type to the database. TypeHint TypeHint // The value of the parameter. diff --git a/service/redshift/api_client.go b/service/redshift/api_client.go index 044cf420b5a..4c1a6d06e7f 100644 --- a/service/redshift/api_client.go +++ b/service/redshift/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/redshift/api_op_AssociateDataShareConsumer.go b/service/redshift/api_op_AssociateDataShareConsumer.go index db3c7819af2..7aaef3a3e47 100644 --- a/service/redshift/api_op_AssociateDataShareConsumer.go +++ b/service/redshift/api_op_AssociateDataShareConsumer.go @@ -31,8 +31,8 @@ func (c *Client) AssociateDataShareConsumer(ctx context.Context, params *Associa type AssociateDataShareConsumerInput struct { - // The Amazon Resource Name (ARN) of the datashare that the consumer is to use with - // the account or the namespace. + // The Amazon Resource Name (ARN) of the datashare that the consumer is to use + // with the account or the namespace. // // This member is required. DataShareArn *string diff --git a/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go b/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go index 095e40e1541..86ee2eec753 100644 --- a/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go +++ b/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go @@ -20,12 +20,11 @@ import ( // EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group // and Amazon Redshift cluster must be in the same Amazon Web Services Region. If // you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview -// of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing -// (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). You must also -// associate the security group with a cluster so that clients running on these IP -// addresses or the EC2 instance are authorized to connect to the cluster. For -// information about managing security groups, go to Working with Security Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) +// of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . You must also associate the security group with a cluster so that clients +// running on these IP addresses or the EC2 instance are authorized to connect to +// the cluster. For information about managing security groups, go to Working with +// Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) AuthorizeClusterSecurityGroupIngress(ctx context.Context, params *AuthorizeClusterSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeClusterSecurityGroupIngressOutput, error) { if params == nil { diff --git a/service/redshift/api_op_AuthorizeSnapshotAccess.go b/service/redshift/api_op_AuthorizeSnapshotAccess.go index 5cd97cc7f89..d472d1788d4 100644 --- a/service/redshift/api_op_AuthorizeSnapshotAccess.go +++ b/service/redshift/api_op_AuthorizeSnapshotAccess.go @@ -13,8 +13,7 @@ import ( // Authorizes the specified Amazon Web Services account to restore the specified // snapshot. For more information about working with snapshots, go to Amazon -// Redshift Snapshots -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) +// Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) AuthorizeSnapshotAccess(ctx context.Context, params *AuthorizeSnapshotAccessInput, optFns ...func(*Options)) (*AuthorizeSnapshotAccessOutput, error) { if params == nil { diff --git a/service/redshift/api_op_CancelResize.go b/service/redshift/api_op_CancelResize.go index 430eeaf9a97..8bb0668cec0 100644 --- a/service/redshift/api_op_CancelResize.go +++ b/service/redshift/api_op_CancelResize.go @@ -28,8 +28,8 @@ func (c *Client) CancelResize(ctx context.Context, params *CancelResizeInput, op type CancelResizeInput struct { - // The unique identifier for the cluster that you want to cancel a resize operation - // for. + // The unique identifier for the cluster that you want to cancel a resize + // operation for. // // This member is required. ClusterIdentifier *string @@ -67,8 +67,8 @@ type CancelResizeOutput struct { // table names. ImportTablesInProgress []string - // The names of tables that have not been yet imported. Valid Values: List of table - // names + // The names of tables that have not been yet imported. Valid Values: List of + // table names ImportTablesNotStarted []string // An optional string to provide additional details about the resize action. @@ -81,7 +81,7 @@ type CancelResizeOutput struct { // estimated total amount of data before resize). ProgressInMegaBytes *int64 - // An enum with possible values of ClassicResize and ElasticResize. These values + // An enum with possible values of ClassicResize and ElasticResize . These values // describe the type of resize operation being performed. ResizeType *string @@ -94,7 +94,7 @@ type CancelResizeOutput struct { TargetClusterType *string // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None. + // values are KMS and None . TargetEncryptionType *string // The node type that the cluster will have after the resize operation is complete. diff --git a/service/redshift/api_op_CopyClusterSnapshot.go b/service/redshift/api_op_CopyClusterSnapshot.go index 3873fa07b3a..e09f67eebd3 100644 --- a/service/redshift/api_op_CopyClusterSnapshot.go +++ b/service/redshift/api_op_CopyClusterSnapshot.go @@ -18,8 +18,7 @@ import ( // snapshot expires, Amazon Redshift automatically deletes it. If you want to keep // an automated snapshot for a longer period, you can make a manual copy of the // snapshot. Manual snapshots are retained until you delete them. For more -// information about working with snapshots, go to Amazon Redshift Snapshots -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) +// information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CopyClusterSnapshot(ctx context.Context, params *CopyClusterSnapshotInput, optFns ...func(*Options)) (*CopyClusterSnapshotOutput, error) { if params == nil { @@ -39,28 +38,19 @@ func (c *Client) CopyClusterSnapshot(ctx context.Context, params *CopyClusterSna type CopyClusterSnapshotInput struct { // The identifier for the source snapshot. Constraints: - // - // * Must be the identifier - // for a valid automated snapshot whose state is available. + // - Must be the identifier for a valid automated snapshot whose state is + // available . // // This member is required. SourceSnapshotIdentifier *string // The identifier given to the new manual snapshot. Constraints: - // - // * Cannot be null, - // empty, or blank. - // - // * Must contain from 1 to 255 alphanumeric characters or - // hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // - // * Must be unique for the Amazon Web Services - // account that is making the request. + // - Cannot be null, empty, or blank. + // - Must contain from 1 to 255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique for the Amazon Web Services account that is making the + // request. // // This member is required. TargetSnapshotIdentifier *string @@ -74,8 +64,7 @@ type CopyClusterSnapshotInput struct { // parameter is required if your IAM user or role has a policy containing a // snapshot resource element that specifies anything other than * for the cluster // name. Constraints: - // - // * Must be the identifier for a valid cluster. + // - Must be the identifier for a valid cluster. SourceSnapshotClusterIdentifier *string noSmithyDocumentSerde diff --git a/service/redshift/api_op_CreateCluster.go b/service/redshift/api_op_CreateCluster.go index 98b26c70fa9..e5f86bac542 100644 --- a/service/redshift/api_op_CreateCluster.go +++ b/service/redshift/api_op_CreateCluster.go @@ -15,9 +15,8 @@ import ( // Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The // cluster subnet group identifies the subnets of your VPC that Amazon Redshift // uses when creating the cluster. For more information about managing clusters, go -// to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -38,21 +37,11 @@ type CreateClusterInput struct { // A unique identifier for the cluster. You use this identifier to refer to the // cluster for any subsequent cluster operations such as deleting or modifying. The // identifier also appears in the Amazon Redshift console. Constraints: - // - // * Must - // contain from 1 to 63 alphanumeric characters or hyphens. - // - // * Alphabetic - // characters must be lowercase. - // - // * First character must be a letter. - // - // * Cannot end - // with a hyphen or contain two consecutive hyphens. - // - // * Must be unique for all - // clusters within an Amazon Web Services account. - // + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - Alphabetic characters must be lowercase. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique for all clusters within an Amazon Web Services account. // Example: myexamplecluster // // This member is required. @@ -60,48 +49,33 @@ type CreateClusterInput struct { // The password associated with the admin user for the cluster that is being // created. Constraints: - // - // * Must be between 8 and 64 characters in length. - // - // * Must - // contain at least one uppercase letter. - // - // * Must contain at least one lowercase - // letter. - // - // * Must contain one number. - // - // * Can be any printable ASCII character - // (ASCII code 33-126) except ' (single quote), " (double quote), \, /, or @. + // - Must be between 8 and 64 characters in length. + // - Must contain at least one uppercase letter. + // - Must contain at least one lowercase letter. + // - Must contain one number. + // - Can be any printable ASCII character (ASCII code 33-126) except ' (single + // quote), " (double quote), \ , / , or @ . // // This member is required. MasterUserPassword *string // The user name associated with the admin user for the cluster that is being // created. Constraints: - // - // * Must be 1 - 128 alphanumeric characters or hyphens. The - // user name can't be PUBLIC. - // - // * Must contain only lowercase letters, numbers, - // underscore, plus sign, period (dot), at symbol (@), or hyphen. - // - // * The first - // character must be a letter. - // - // * Must not contain a colon (:) or a slash (/). - // - // * - // Cannot be a reserved word. A list of reserved words can be found in Reserved - // Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the - // Amazon Redshift Database Developer Guide. + // - Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be + // PUBLIC . + // - Must contain only lowercase letters, numbers, underscore, plus sign, period + // (dot), at symbol (@), or hyphen. + // - The first character must be a letter. + // - Must not contain a colon (:) or a slash (/). + // - Cannot be a reserved word. A list of reserved words can be found in + // Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. // // This member is required. MasterUsername *string // The node type to be provisioned for the cluster. For information about node - // types, go to Working with Clusters - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) + // types, go to Working with Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) // in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | // ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | // ra3.4xlarge | ra3.16xlarge @@ -112,21 +86,21 @@ type CreateClusterInput struct { // Reserved. AdditionalInfo *string - // If true, major version upgrades can be applied during the maintenance window to + // If true , major version upgrades can be applied during the maintenance window to // the Amazon Redshift engine that is running on the cluster. When a new major // version of the Amazon Redshift engine is released, you can request that the // service automatically apply upgrades during the maintenance window to the Amazon // Redshift engine that is running on your cluster. Default: true AllowVersionUpgrade *bool - // This parameter is retired. It does not set the AQUA configuration status. Amazon - // Redshift automatically determines whether to use AQUA (Advanced Query + // This parameter is retired. It does not set the AQUA configuration status. + // Amazon Redshift automatically determines whether to use AQUA (Advanced Query // Accelerator). AquaConfigurationStatus types.AquaConfigurationStatus // The number of days that automated snapshots are retained. If the value is 0, // automated snapshots are disabled. Even if automated snapshots are disabled, you - // can still create manual snapshots when you want with CreateClusterSnapshot. You + // can still create manual snapshots when you want with CreateClusterSnapshot . You // can't disable automated snapshots for RA3 node types. Set the automated // retention period from 1-35 days. Default: 1 Constraints: Must be a value from 0 // to 35. @@ -145,19 +119,13 @@ type CreateClusterInput struct { // Availability Zones after the cluster is created. AvailabilityZoneRelocation *bool - // The name of the parameter group to be associated with this cluster. Default: The - // default Amazon Redshift cluster parameter group. For information about the - // default parameter group, go to Working with Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // The name of the parameter group to be associated with this cluster. Default: + // The default Amazon Redshift cluster parameter group. For information about the + // default parameter group, go to Working with Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // Constraints: - // - // * Must be 1 to 255 alphanumeric characters or hyphens. - // - // * First - // character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. + // - Must be 1 to 255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. ClusterParameterGroupName *string // A list of security groups to be associated with this cluster. Default: The @@ -170,15 +138,9 @@ type CreateClusterInput struct { ClusterSubnetGroupName *string // The type of the cluster. When cluster type is specified as - // - // * single-node, the - // NumberOfNodes parameter is not required. - // - // * multi-node, the NumberOfNodes - // parameter is required. - // - // Valid Values: multi-node | single-node Default: - // multi-node + // - single-node , the NumberOfNodes parameter is not required. + // - multi-node , the NumberOfNodes parameter is required. + // Valid Values: multi-node | single-node Default: multi-node ClusterType *string // The version of the Amazon Redshift engine software that you want to deploy on @@ -189,20 +151,13 @@ type CreateClusterInput struct { // The name of the first database to be created when the cluster is created. To // create additional databases after the cluster is created, connect to the cluster // with a SQL client and use SQL commands to create a database. For more - // information, go to Create a Database - // (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the - // Amazon Redshift Database Developer Guide. Default: dev Constraints: - // - // * Must - // contain 1 to 64 alphanumeric characters. - // - // * Must contain only lowercase - // letters. - // - // * Cannot be a word that is reserved by the service. A list of reserved - // words can be found in Reserved Words - // (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the - // Amazon Redshift Database Developer Guide. + // information, go to Create a Database (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) + // in the Amazon Redshift Database Developer Guide. Default: dev Constraints: + // - Must contain 1 to 64 alphanumeric characters. + // - Must contain only lowercase letters. + // - Cannot be a word that is reserved by the service. A list of reserved words + // can be found in Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. DBName *string // The Amazon Resource Name (ARN) for the IAM role that was set as default for the @@ -213,20 +168,18 @@ type CreateClusterInput struct { // provisioned in EC2-VPC and publicly-accessible through an Internet gateway. // Don't specify the Elastic IP address for a publicly accessible cluster with // availability zone relocation turned on. For more information about provisioning - // clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) + // clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) // in the Amazon Redshift Cluster Management Guide. ElasticIp *string - // If true, the data in the cluster is encrypted at rest. Default: false + // If true , the data in the cluster is encrypted at rest. Default: false Encrypted *bool - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -241,8 +194,7 @@ type CreateClusterInput struct { // cluster to access other Amazon Web Services services. You must supply the IAM // roles in their Amazon Resource Name (ARN) format. The maximum number of IAM // roles that you can associate is subject to a quota. For more information, go to - // Quotas and limits - // (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) + // Quotas and limits (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. IamRoles []string @@ -265,9 +217,8 @@ type CreateClusterInput struct { ManualSnapshotRetentionPeriod *int32 // The number of compute nodes in the cluster. This parameter is required when the - // ClusterType parameter is specified as multi-node. For information about - // determining how many nodes you need, go to Working with Clusters - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) + // ClusterType parameter is specified as multi-node . For information about + // determining how many nodes you need, go to Working with Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) // in the Amazon Redshift Cluster Management Guide. If you don't specify this // parameter, you get a single-node cluster. When requesting a multi-node cluster, // you must specify the number of nodes that you want in the cluster. Default: 1 @@ -284,13 +235,12 @@ type CreateClusterInput struct { // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at // random from an 8-hour block of time per region, occurring on a random day of the // week. For more information about the time blocks for each region, see - // Maintenance Windows - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) + // Maintenance Windows (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | // Fri | Sat | Sun Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string - // If true, the cluster can be accessed from a public network. + // If true , the cluster can be accessed from a public network. PubliclyAccessible *bool // A unique identifier for the snapshot schedule. diff --git a/service/redshift/api_op_CreateClusterParameterGroup.go b/service/redshift/api_op_CreateClusterParameterGroup.go index 8b4b4465728..840454ee0d0 100644 --- a/service/redshift/api_op_CreateClusterParameterGroup.go +++ b/service/redshift/api_op_CreateClusterParameterGroup.go @@ -14,11 +14,10 @@ import ( // Creates an Amazon Redshift parameter group. Creating parameter groups is // independent of creating clusters. You can associate a cluster with a parameter // group when you create the cluster. You can also associate an existing cluster -// with a parameter group after the cluster is created by using ModifyCluster. +// with a parameter group after the cluster is created by using ModifyCluster . // Parameters in the parameter group define specific behavior that applies to the // databases you create on the cluster. For more information about parameters and -// parameter groups, go to Amazon Redshift Parameter Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) +// parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateClusterParameterGroup(ctx context.Context, params *CreateClusterParameterGroupInput, optFns ...func(*Options)) (*CreateClusterParameterGroupOutput, error) { if params == nil { @@ -42,33 +41,25 @@ type CreateClusterParameterGroupInput struct { // This member is required. Description *string - // The Amazon Redshift engine version to which the cluster parameter group applies. - // The cluster engine version determines the set of parameters. To get a list of - // valid parameter group family names, you can call DescribeClusterParameterGroups. - // By default, Amazon Redshift returns a list of all the parameter groups that are - // owned by your Amazon Web Services account, including the default parameter - // groups for each Amazon Redshift engine version. The parameter group family names - // associated with the default parameter groups provide you the valid values. For - // example, a valid family name is "redshift-1.0". + // The Amazon Redshift engine version to which the cluster parameter group + // applies. The cluster engine version determines the set of parameters. To get a + // list of valid parameter group family names, you can call + // DescribeClusterParameterGroups . By default, Amazon Redshift returns a list of + // all the parameter groups that are owned by your Amazon Web Services account, + // including the default parameter groups for each Amazon Redshift engine version. + // The parameter group family names associated with the default parameter groups + // provide you the valid values. For example, a valid family name is + // "redshift-1.0". // // This member is required. ParameterGroupFamily *string // The name of the cluster parameter group. Constraints: - // - // * Must be 1 to 255 - // alphanumeric characters or hyphens - // - // * First character must be a letter. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. - // - // * Must be unique - // withing your Amazon Web Services account. - // - // This value is stored as a lower-case - // string. + // - Must be 1 to 255 alphanumeric characters or hyphens + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique withing your Amazon Web Services account. + // This value is stored as a lower-case string. // // This member is required. ParameterGroupName *string diff --git a/service/redshift/api_op_CreateClusterSecurityGroup.go b/service/redshift/api_op_CreateClusterSecurityGroup.go index 0c7171f9e42..5186c93357e 100644 --- a/service/redshift/api_op_CreateClusterSecurityGroup.go +++ b/service/redshift/api_op_CreateClusterSecurityGroup.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon Redshift security group. You use security groups to control -// access to non-VPC clusters. For information about managing security groups, go -// to Amazon Redshift Cluster Security Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) +// Creates a new Amazon Redshift security group. You use security groups to +// control access to non-VPC clusters. For information about managing security +// groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateClusterSecurityGroup(ctx context.Context, params *CreateClusterSecurityGroupInput, optFns ...func(*Options)) (*CreateClusterSecurityGroupOutput, error) { if params == nil { @@ -33,19 +32,13 @@ func (c *Client) CreateClusterSecurityGroup(ctx context.Context, params *CreateC type CreateClusterSecurityGroupInput struct { - // The name for the security group. Amazon Redshift stores the value as a lowercase - // string. Constraints: - // - // * Must contain no more than 255 alphanumeric characters or - // hyphens. - // - // * Must not be "Default". - // - // * Must be unique for all security groups - // that are created by your Amazon Web Services account. - // - // Example: - // examplesecuritygroup + // The name for the security group. Amazon Redshift stores the value as a + // lowercase string. Constraints: + // - Must contain no more than 255 alphanumeric characters or hyphens. + // - Must not be "Default". + // - Must be unique for all security groups that are created by your Amazon Web + // Services account. + // Example: examplesecuritygroup // // This member is required. ClusterSecurityGroupName *string diff --git a/service/redshift/api_op_CreateClusterSnapshot.go b/service/redshift/api_op_CreateClusterSnapshot.go index a025d2aa6aa..89006a9dc76 100644 --- a/service/redshift/api_op_CreateClusterSnapshot.go +++ b/service/redshift/api_op_CreateClusterSnapshot.go @@ -12,9 +12,8 @@ import ( ) // Creates a manual snapshot of the specified cluster. The cluster must be in the -// available state. For more information about working with snapshots, go to Amazon -// Redshift Snapshots -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) +// available state. For more information about working with snapshots, go to +// Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateClusterSnapshot(ctx context.Context, params *CreateClusterSnapshotInput, optFns ...func(*Options)) (*CreateClusterSnapshotOutput, error) { if params == nil { @@ -41,17 +40,10 @@ type CreateClusterSnapshotInput struct { // A unique identifier for the snapshot that you are requesting. This identifier // must be unique for all snapshots within the Amazon Web Services account. // Constraints: - // - // * Cannot be null, empty, or blank - // - // * Must contain from 1 to 255 - // alphanumeric characters or hyphens - // - // * First character must be a letter - // - // * Cannot - // end with a hyphen or contain two consecutive hyphens - // + // - Cannot be null, empty, or blank + // - Must contain from 1 to 255 alphanumeric characters or hyphens + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens // Example: my-snapshot-id // // This member is required. diff --git a/service/redshift/api_op_CreateClusterSubnetGroup.go b/service/redshift/api_op_CreateClusterSubnetGroup.go index 534571ebc08..ca8479854ae 100644 --- a/service/redshift/api_op_CreateClusterSubnetGroup.go +++ b/service/redshift/api_op_CreateClusterSubnetGroup.go @@ -14,8 +14,7 @@ import ( // Creates a new Amazon Redshift subnet group. You must provide a list of one or // more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when // creating Amazon Redshift subnet group. For information about subnet groups, go -// to Amazon Redshift Cluster Subnet Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html) +// to Amazon Redshift Cluster Subnet Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateClusterSubnetGroup(ctx context.Context, params *CreateClusterSubnetGroupInput, optFns ...func(*Options)) (*CreateClusterSubnetGroupOutput, error) { if params == nil { @@ -36,15 +35,10 @@ type CreateClusterSubnetGroupInput struct { // The name for the subnet group. Amazon Redshift stores the value as a lowercase // string. Constraints: - // - // * Must contain no more than 255 alphanumeric characters or - // hyphens. - // - // * Must not be "Default". - // - // * Must be unique for all subnet groups that - // are created by your Amazon Web Services account. - // + // - Must contain no more than 255 alphanumeric characters or hyphens. + // - Must not be "Default". + // - Must be unique for all subnet groups that are created by your Amazon Web + // Services account. // Example: examplesubnetgroup // // This member is required. diff --git a/service/redshift/api_op_CreateEndpointAccess.go b/service/redshift/api_op_CreateEndpointAccess.go index f94a8b5d021..d54c5fc8f87 100644 --- a/service/redshift/api_op_CreateEndpointAccess.go +++ b/service/redshift/api_op_CreateEndpointAccess.go @@ -85,8 +85,8 @@ type CreateEndpointAccessOutput struct { // The subnet group name where Amazon Redshift chooses to deploy the endpoint. SubnetGroupName *string - // The connection endpoint for connecting to an Amazon Redshift cluster through the - // proxy. + // The connection endpoint for connecting to an Amazon Redshift cluster through + // the proxy. VpcEndpoint *types.VpcEndpoint // The security groups associated with the endpoint. diff --git a/service/redshift/api_op_CreateEventSubscription.go b/service/redshift/api_op_CreateEventSubscription.go index 01242c05263..0213c7e7313 100644 --- a/service/redshift/api_op_CreateEventSubscription.go +++ b/service/redshift/api_op_CreateEventSubscription.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Redshift event notification subscription. This action requires -// an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the -// Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To +// Creates an Amazon Redshift event notification subscription. This action +// requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either +// the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To // obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and // subscribe to the topic. The ARN is displayed in the SNS console. You can specify // the source type, and lists of Amazon Redshift source IDs, event categories, and @@ -55,17 +55,10 @@ type CreateEventSubscriptionInput struct { SnsTopicArn *string // The name of the event subscription to be created. Constraints: - // - // * Cannot be - // null, empty, or blank. - // - // * Must contain from 1 to 255 alphanumeric characters or - // hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. + // - Cannot be null, empty, or blank. + // - Must contain from 1 to 255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. SubscriptionName *string diff --git a/service/redshift/api_op_CreateHsmClientCertificate.go b/service/redshift/api_op_CreateHsmClientCertificate.go index d66912229f4..3bea60a4c37 100644 --- a/service/redshift/api_op_CreateHsmClientCertificate.go +++ b/service/redshift/api_op_CreateHsmClientCertificate.go @@ -17,8 +17,7 @@ import ( // store in the HSM. In addition to creating the HSM certificate, you must create // an Amazon Redshift HSM configuration that provides a cluster the information // needed to store and use encryption keys in the HSM. For more information, go to -// Hardware Security Modules -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM) +// Hardware Security Modules (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateHsmClientCertificate(ctx context.Context, params *CreateHsmClientCertificateInput, optFns ...func(*Options)) (*CreateHsmClientCertificateOutput, error) { if params == nil { @@ -37,8 +36,8 @@ func (c *Client) CreateHsmClientCertificate(ctx context.Context, params *CreateH type CreateHsmClientCertificateInput struct { - // The identifier to be assigned to the new HSM client certificate that the cluster - // will use to connect to the HSM to use the database encryption keys. + // The identifier to be assigned to the new HSM client certificate that the + // cluster will use to connect to the HSM to use the database encryption keys. // // This member is required. HsmClientCertificateIdentifier *string diff --git a/service/redshift/api_op_CreateHsmConfiguration.go b/service/redshift/api_op_CreateHsmConfiguration.go index d35570f196f..06d4f5c6789 100644 --- a/service/redshift/api_op_CreateHsmConfiguration.go +++ b/service/redshift/api_op_CreateHsmConfiguration.go @@ -11,15 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an HSM configuration that contains the information required by an Amazon -// Redshift cluster to store and use database encryption keys in a Hardware +// Creates an HSM configuration that contains the information required by an +// Amazon Redshift cluster to store and use database encryption keys in a Hardware // Security Module (HSM). After creating the HSM configuration, you can specify it // as a parameter when creating a cluster. The cluster will then store its // encryption keys in the HSM. In addition to creating an HSM configuration, you -// must also create an HSM client certificate. For more information, go to Hardware -// Security Modules -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html) in the -// Amazon Redshift Cluster Management Guide. +// must also create an HSM client certificate. For more information, go to +// Hardware Security Modules (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateHsmConfiguration(ctx context.Context, params *CreateHsmConfigurationInput, optFns ...func(*Options)) (*CreateHsmConfigurationOutput, error) { if params == nil { params = &CreateHsmConfigurationInput{} diff --git a/service/redshift/api_op_CreateScheduledAction.go b/service/redshift/api_op_CreateScheduledAction.go index f629ad6688e..de1764a3422 100644 --- a/service/redshift/api_op_CreateScheduledAction.go +++ b/service/redshift/api_op_CreateScheduledAction.go @@ -12,9 +12,9 @@ import ( "time" ) -// Creates a scheduled action. A scheduled action contains a schedule and an Amazon -// Redshift API action. For example, you can create a schedule of when to run the -// ResizeCluster API operation. +// Creates a scheduled action. A scheduled action contains a schedule and an +// Amazon Redshift API action. For example, you can create a schedule of when to +// run the ResizeCluster API operation. func (c *Client) CreateScheduledAction(ctx context.Context, params *CreateScheduledActionInput, optFns ...func(*Options)) (*CreateScheduledActionOutput, error) { if params == nil { params = &CreateScheduledActionInput{} @@ -32,38 +32,38 @@ func (c *Client) CreateScheduledAction(ctx context.Context, params *CreateSchedu type CreateScheduledActionInput struct { - // The IAM role to assume to run the target action. For more information about this - // parameter, see ScheduledAction. + // The IAM role to assume to run the target action. For more information about + // this parameter, see ScheduledAction . // // This member is required. IamRole *string // The schedule in at( ) or cron( ) format. For more information about this - // parameter, see ScheduledAction. + // parameter, see ScheduledAction . // // This member is required. Schedule *string - // The name of the scheduled action. The name must be unique within an account. For - // more information about this parameter, see ScheduledAction. + // The name of the scheduled action. The name must be unique within an account. + // For more information about this parameter, see ScheduledAction . // // This member is required. ScheduledActionName *string - // A JSON format string of the Amazon Redshift API operation with input parameters. - // For more information about this parameter, see ScheduledAction. + // A JSON format string of the Amazon Redshift API operation with input + // parameters. For more information about this parameter, see ScheduledAction . // // This member is required. TargetAction *types.ScheduledActionType // If true, the schedule is enabled. If false, the scheduled action does not // trigger. For more information about state of the scheduled action, see - // ScheduledAction. + // ScheduledAction . Enable *bool // The end time in UTC of the scheduled action. After this time, the scheduled // action does not trigger. For more information about this parameter, see - // ScheduledAction. + // ScheduledAction . EndTime *time.Time // The description of the scheduled action. @@ -71,7 +71,7 @@ type CreateScheduledActionInput struct { // The start time in UTC of the scheduled action. Before this time, the scheduled // action does not trigger. For more information about this parameter, see - // ScheduledAction. + // ScheduledAction . StartTime *time.Time noSmithyDocumentSerde @@ -79,7 +79,7 @@ type CreateScheduledActionInput struct { // Describes a scheduled action. You can use a scheduled action to trigger some // Amazon Redshift API operations on a schedule. For information about which API -// operations can be scheduled, see ScheduledActionType. +// operations can be scheduled, see ScheduledActionType . type CreateScheduledActionOutput struct { // The end time in UTC when the schedule is no longer active. After this time, the @@ -91,8 +91,7 @@ type CreateScheduledActionOutput struct { // This IAM role must allow the Amazon Redshift scheduler (Principal // scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more // information about the IAM role to use with the Amazon Redshift scheduler, see - // Using Identity-Based Policies for Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) + // Using Identity-Based Policies for Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) // in the Amazon Redshift Cluster Management Guide. IamRole *string @@ -101,11 +100,10 @@ type CreateScheduledActionOutput struct { // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of - // at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, - // "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours - // Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For - // more information, see Cron Expressions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) + // at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, " + // at(2016-03-04T17:27:00) ". Format of cron expressions is " cron(Minutes Hours + // Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ". + // For more information, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) // in the Amazon CloudWatch Events User Guide. Schedule *string @@ -119,11 +117,13 @@ type CreateScheduledActionOutput struct { // scheduled action does not trigger. StartTime *time.Time - // The state of the scheduled action. For example, DISABLED. + // The state of the scheduled action. For example, DISABLED . State types.ScheduledActionState - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + // A JSON format string of the Amazon Redshift API operation with input + // parameters. " + // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} + // ". TargetAction *types.ScheduledActionType // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_CreateSnapshotCopyGrant.go b/service/redshift/api_op_CreateSnapshotCopyGrant.go index 9d6ef454562..0226c6272a4 100644 --- a/service/redshift/api_op_CreateSnapshotCopyGrant.go +++ b/service/redshift/api_op_CreateSnapshotCopyGrant.go @@ -14,8 +14,7 @@ import ( // Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted // symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a // destination region. For more information about managing snapshot copy grants, go -// to Amazon Redshift Database Encryption -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) +// to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) CreateSnapshotCopyGrant(ctx context.Context, params *CreateSnapshotCopyGrantInput, optFns ...func(*Options)) (*CreateSnapshotCopyGrantOutput, error) { if params == nil { @@ -37,20 +36,11 @@ type CreateSnapshotCopyGrantInput struct { // The name of the snapshot copy grant. This name must be unique in the region for // the Amazon Web Services account. Constraints: - // - // * Must contain from 1 to 63 - // alphanumeric characters or hyphens. - // - // * Alphabetic characters must be - // lowercase. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // - // * Must be unique for all clusters within an - // Amazon Web Services account. + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - Alphabetic characters must be lowercase. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique for all clusters within an Amazon Web Services account. // // This member is required. SnapshotCopyGrantName *string @@ -67,11 +57,10 @@ type CreateSnapshotCopyGrantInput struct { type CreateSnapshotCopyGrantOutput struct { - // The snapshot copy grant that grants Amazon Redshift permission to encrypt copied - // snapshots with the specified encrypted symmetric key from Amazon Web Services - // KMS in the destination region. For more information about managing snapshot copy - // grants, go to Amazon Redshift Database Encryption - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) + // The snapshot copy grant that grants Amazon Redshift permission to encrypt + // copied snapshots with the specified encrypted symmetric key from Amazon Web + // Services KMS in the destination region. For more information about managing + // snapshot copy grants, go to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) // in the Amazon Redshift Cluster Management Guide. SnapshotCopyGrant *types.SnapshotCopyGrant diff --git a/service/redshift/api_op_CreateTags.go b/service/redshift/api_op_CreateTags.go index ebe320acfea..4c827d7afc4 100644 --- a/service/redshift/api_op_CreateTags.go +++ b/service/redshift/api_op_CreateTags.go @@ -34,17 +34,17 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns type CreateTagsInput struct { // The Amazon Resource Name (ARN) to which you want to add the tag or tags. For - // example, arn:aws:redshift:us-east-2:123456789:cluster:t1. + // example, arn:aws:redshift:us-east-2:123456789:cluster:t1 . // // This member is required. ResourceName *string // One or more name/value pairs to add as tags to the specified resource. Each tag // name is passed in with the parameter Key and the corresponding value is passed - // in with the parameter Value. The Key and Value parameters are separated by a + // in with the parameter Value . The Key and Value parameters are separated by a // comma (,). Separate multiple tags with a space. For example, --tags // "Key"="owner","Value"="admin" "Key"="environment","Value"="test" - // "Key"="version","Value"="1.0". + // "Key"="version","Value"="1.0" . // // This member is required. Tags []types.Tag diff --git a/service/redshift/api_op_CreateUsageLimit.go b/service/redshift/api_op_CreateUsageLimit.go index cd569b0b8ef..ffeec2cb3e2 100644 --- a/service/redshift/api_op_CreateUsageLimit.go +++ b/service/redshift/api_op_CreateUsageLimit.go @@ -47,20 +47,20 @@ type CreateUsageLimitInput struct { FeatureType types.UsageLimitFeatureType // The type of limit. Depending on the feature type, this can be based on a time - // duration or data size. If FeatureType is spectrum, then LimitType must be - // data-scanned. If FeatureType is concurrency-scaling, then LimitType must be - // time. If FeatureType is cross-region-datasharing, then LimitType must be - // data-scanned. + // duration or data size. If FeatureType is spectrum , then LimitType must be + // data-scanned . If FeatureType is concurrency-scaling , then LimitType must be + // time . If FeatureType is cross-region-datasharing , then LimitType must be + // data-scanned . // // This member is required. LimitType types.UsageLimitLimitType // The action that Amazon Redshift takes when the limit is reached. The default is - // log. For more information about this parameter, see UsageLimit. + // log. For more information about this parameter, see UsageLimit . BreachAction types.UsageLimitBreachAction // The time period that the amount applies to. A weekly period begins on Sunday. - // The default is monthly. + // The default is monthly . Period types.UsageLimitPeriod // A list of tag instances. @@ -76,16 +76,11 @@ type CreateUsageLimitOutput struct { // amount is in terabytes (TB). Amount int64 - // The action that Amazon Redshift takes when the limit is reached. Possible values - // are: - // - // * log - To log an event in a system table. The default is log. - // - // * - // emit-metric - To emit CloudWatch metrics. - // - // * disable - To disable the feature - // until the next usage period begins. + // The action that Amazon Redshift takes when the limit is reached. Possible + // values are: + // - log - To log an event in a system table. The default is log. + // - emit-metric - To emit CloudWatch metrics. + // - disable - To disable the feature until the next usage period begins. BreachAction types.UsageLimitBreachAction // The identifier of the cluster with a usage limit. @@ -99,7 +94,7 @@ type CreateUsageLimitOutput struct { LimitType types.UsageLimitLimitType // The time period that the amount applies to. A weekly period begins on Sunday. - // The default is monthly. + // The default is monthly . Period types.UsageLimitPeriod // A list of tag instances. diff --git a/service/redshift/api_op_DeleteCluster.go b/service/redshift/api_op_DeleteCluster.go index a3b7886f440..30bf2e29303 100644 --- a/service/redshift/api_op_DeleteCluster.go +++ b/service/redshift/api_op_DeleteCluster.go @@ -15,17 +15,15 @@ import ( // created. A successful response from the web service indicates that the request // was received correctly. Use DescribeClusters to monitor the status of the // deletion. The delete operation cannot be canceled or reverted once submitted. -// For more information about managing clusters, go to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. If you want to shut down the +// For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. If you want to shut down the // cluster and retain it for future use, set SkipFinalClusterSnapshot to false and // specify a name for FinalClusterSnapshotIdentifier. You can later restore this // snapshot to resume using the cluster. If a final cluster snapshot is requested, // the status of the cluster will be "final-snapshot" while the snapshot is being // taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. -// For more information about managing clusters, go to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error) { if params == nil { params = &DeleteClusterInput{} @@ -44,32 +42,20 @@ func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, type DeleteClusterInput struct { // The identifier of the cluster to be deleted. Constraints: - // - // * Must contain - // lowercase characters. - // - // * Must contain from 1 to 63 alphanumeric characters or - // hyphens. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. + // - Must contain lowercase characters. + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. // // This member is required. ClusterIdentifier *string // The identifier of the final snapshot that is to be created immediately before // deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot - // must be false. Constraints: - // - // * Must be 1 to 255 alphanumeric characters. - // - // * - // First character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. + // must be false . Constraints: + // - Must be 1 to 255 alphanumeric characters. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. FinalClusterSnapshotIdentifier *string // The number of days that a manual snapshot is retained. If the value is -1, the @@ -78,10 +64,10 @@ type DeleteClusterInput struct { FinalClusterSnapshotRetentionPeriod *int32 // Determines whether a final snapshot of the cluster is created before Amazon - // Redshift deletes the cluster. If true, a final cluster snapshot is not created. - // If false, a final cluster snapshot is created before the cluster is deleted. The - // FinalClusterSnapshotIdentifier parameter must be specified if - // SkipFinalClusterSnapshot is false. Default: false + // Redshift deletes the cluster. If true , a final cluster snapshot is not created. + // If false , a final cluster snapshot is created before the cluster is deleted. + // The FinalClusterSnapshotIdentifier parameter must be specified if + // SkipFinalClusterSnapshot is false . Default: false SkipFinalClusterSnapshot bool noSmithyDocumentSerde diff --git a/service/redshift/api_op_DeleteClusterParameterGroup.go b/service/redshift/api_op_DeleteClusterParameterGroup.go index aae874743c1..9f15711e978 100644 --- a/service/redshift/api_op_DeleteClusterParameterGroup.go +++ b/service/redshift/api_op_DeleteClusterParameterGroup.go @@ -30,12 +30,8 @@ func (c *Client) DeleteClusterParameterGroup(ctx context.Context, params *Delete type DeleteClusterParameterGroupInput struct { // The name of the parameter group to be deleted. Constraints: - // - // * Must be the name - // of an existing cluster parameter group. - // - // * Cannot delete a default cluster - // parameter group. + // - Must be the name of an existing cluster parameter group. + // - Cannot delete a default cluster parameter group. // // This member is required. ParameterGroupName *string diff --git a/service/redshift/api_op_DeleteClusterSecurityGroup.go b/service/redshift/api_op_DeleteClusterSecurityGroup.go index e3c14e93532..396d8f411a1 100644 --- a/service/redshift/api_op_DeleteClusterSecurityGroup.go +++ b/service/redshift/api_op_DeleteClusterSecurityGroup.go @@ -13,8 +13,7 @@ import ( // Deletes an Amazon Redshift security group. You cannot delete a security group // that is associated with any clusters. You cannot delete the default security // group. For information about managing security groups, go to Amazon Redshift -// Cluster Security Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) +// Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) DeleteClusterSecurityGroup(ctx context.Context, params *DeleteClusterSecurityGroupInput, optFns ...func(*Options)) (*DeleteClusterSecurityGroupOutput, error) { if params == nil { diff --git a/service/redshift/api_op_DeleteClusterSnapshot.go b/service/redshift/api_op_DeleteClusterSnapshot.go index 2114b43b00a..e8cf1ab09ca 100644 --- a/service/redshift/api_op_DeleteClusterSnapshot.go +++ b/service/redshift/api_op_DeleteClusterSnapshot.go @@ -35,9 +35,9 @@ func (c *Client) DeleteClusterSnapshot(ctx context.Context, params *DeleteCluste type DeleteClusterSnapshotInput struct { - // The unique identifier of the manual snapshot to be deleted. Constraints: Must be - // the name of an existing snapshot that is in the available, failed, or cancelled - // state. + // The unique identifier of the manual snapshot to be deleted. Constraints: Must + // be the name of an existing snapshot that is in the available , failed , or + // cancelled state. // // This member is required. SnapshotIdentifier *string diff --git a/service/redshift/api_op_DeleteEndpointAccess.go b/service/redshift/api_op_DeleteEndpointAccess.go index a1dbfdad1d7..b8fbecd8b2f 100644 --- a/service/redshift/api_op_DeleteEndpointAccess.go +++ b/service/redshift/api_op_DeleteEndpointAccess.go @@ -65,8 +65,8 @@ type DeleteEndpointAccessOutput struct { // The subnet group name where Amazon Redshift chooses to deploy the endpoint. SubnetGroupName *string - // The connection endpoint for connecting to an Amazon Redshift cluster through the - // proxy. + // The connection endpoint for connecting to an Amazon Redshift cluster through + // the proxy. VpcEndpoint *types.VpcEndpoint // The security groups associated with the endpoint. diff --git a/service/redshift/api_op_DeletePartner.go b/service/redshift/api_op_DeletePartner.go index e39790ded14..f1a7ca1f7d2 100644 --- a/service/redshift/api_op_DeletePartner.go +++ b/service/redshift/api_op_DeletePartner.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a partner integration from a cluster. Data can still flow to the cluster -// until the integration is deleted at the partner's website. +// Deletes a partner integration from a cluster. Data can still flow to the +// cluster until the integration is deleted at the partner's website. func (c *Client) DeletePartner(ctx context.Context, params *DeletePartnerInput, optFns ...func(*Options)) (*DeletePartnerOutput, error) { if params == nil { params = &DeletePartnerInput{} diff --git a/service/redshift/api_op_DeleteTags.go b/service/redshift/api_op_DeleteTags.go index 5b8c937b5d2..0308d3bca78 100644 --- a/service/redshift/api_op_DeleteTags.go +++ b/service/redshift/api_op_DeleteTags.go @@ -31,7 +31,7 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { // The Amazon Resource Name (ARN) from which you want to remove the tag or tags. - // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1. + // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1 . // // This member is required. ResourceName *string diff --git a/service/redshift/api_op_DescribeClusterDbRevisions.go b/service/redshift/api_op_DescribeClusterDbRevisions.go index b94a54699ec..250a22f0159 100644 --- a/service/redshift/api_op_DescribeClusterDbRevisions.go +++ b/service/redshift/api_op_DescribeClusterDbRevisions.go @@ -37,11 +37,11 @@ type DescribeClusterDbRevisionsInput struct { // An optional parameter that specifies the starting point for returning a set of // response records. When the results of a DescribeClusterDbRevisions request - // exceed the value specified in MaxRecords, Amazon Redshift returns a value in the - // marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the marker parameter and retrying the - // request. Constraints: You can specify either the ClusterIdentifier parameter, or - // the marker parameter, but not both. + // exceed the value specified in MaxRecords , Amazon Redshift returns a value in + // the marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the marker parameter and + // retrying the request. Constraints: You can specify either the ClusterIdentifier + // parameter, or the marker parameter, but not both. Marker *string // The maximum number of response records to return in each call. If the number of diff --git a/service/redshift/api_op_DescribeClusterParameterGroups.go b/service/redshift/api_op_DescribeClusterParameterGroups.go index c957fa574e0..d153a01c068 100644 --- a/service/redshift/api_op_DescribeClusterParameterGroups.go +++ b/service/redshift/api_op_DescribeClusterParameterGroups.go @@ -17,8 +17,7 @@ import ( // response includes the parameter group name, description, and parameter group // family name. You can optionally specify a name to retrieve the description of a // specific parameter group. For more information about parameters and parameter -// groups, go to Amazon Redshift Parameter Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) +// groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. If you specify both tag keys // and tag values in the same request, Amazon Redshift returns all parameter groups // that match any combination of the specified keys and values. For example, if you @@ -45,8 +44,8 @@ type DescribeClusterParameterGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterParameterGroups request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -65,7 +64,7 @@ type DescribeClusterParameterGroupsInput struct { // A tag key or keys for which you want to return all matching cluster parameter // groups that are associated with the specified key or keys. For example, suppose // that you have parameter groups that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon + // environment . If you specify both of these tag keys in the request, Amazon // Redshift returns a response with the parameter groups that have either or both // of these tag keys associated with them. TagKeys []string @@ -73,7 +72,7 @@ type DescribeClusterParameterGroupsInput struct { // A tag value or values for which you want to return all matching cluster // parameter groups that are associated with the specified tag value or values. For // example, suppose that you have parameter groups that are tagged with values - // called admin and test. If you specify both of these tag values in the request, + // called admin and test . If you specify both of these tag values in the request, // Amazon Redshift returns a response with the parameter groups that have either or // both of these tag values associated with them. TagValues []string diff --git a/service/redshift/api_op_DescribeClusterParameters.go b/service/redshift/api_op_DescribeClusterParameters.go index f55481bc494..fba8c2a9fb0 100644 --- a/service/redshift/api_op_DescribeClusterParameters.go +++ b/service/redshift/api_op_DescribeClusterParameters.go @@ -17,10 +17,9 @@ import ( // such as parameter name, description, data type, value, whether the parameter // value is modifiable, and so on. You can specify source filter to retrieve // parameters of only specific type. For example, to retrieve parameters that were -// modified by a user action such as from ModifyClusterParameterGroup, you can +// modified by a user action such as from ModifyClusterParameterGroup , you can // specify source equal to user. For more information about parameters and -// parameter groups, go to Amazon Redshift Parameter Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) +// parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeClusterParameters(ctx context.Context, params *DescribeClusterParametersInput, optFns ...func(*Options)) (*DescribeClusterParametersOutput, error) { if params == nil { @@ -45,11 +44,11 @@ type DescribeClusterParametersInput struct { ParameterGroupName *string // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeClusterParameters request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the - // Marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying the - // request. + // response records. When the results of a DescribeClusterParameters request + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string // The maximum number of response records to return in each call. If the number of @@ -60,9 +59,9 @@ type DescribeClusterParametersInput struct { MaxRecords *int32 // The parameter types to return. Specify user to show parameters that are - // different form the default. Similarly, specify engine-default to show parameters - // that are the same as the default parameter group. Default: All parameter types - // returned. Valid Values: user | engine-default + // different form the default. Similarly, specify engine-default to show + // parameters that are the same as the default parameter group. Default: All + // parameter types returned. Valid Values: user | engine-default Source *string noSmithyDocumentSerde @@ -78,8 +77,8 @@ type DescribeClusterParametersOutput struct { // records have been retrieved for the request. Marker *string - // A list of Parameter instances. Each instance lists the parameters of one cluster - // parameter group. + // A list of Parameter instances. Each instance lists the parameters of one + // cluster parameter group. Parameters []types.Parameter // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_DescribeClusterSecurityGroups.go b/service/redshift/api_op_DescribeClusterSecurityGroups.go index 1253db5f5f9..d26175cec62 100644 --- a/service/redshift/api_op_DescribeClusterSecurityGroups.go +++ b/service/redshift/api_op_DescribeClusterSecurityGroups.go @@ -15,8 +15,7 @@ import ( // Returns information about Amazon Redshift security groups. If the name of a // security group is specified, the response will contain only information about // only that security group. For information about managing security groups, go to -// Amazon Redshift Cluster Security Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) +// Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) // in the Amazon Redshift Cluster Management Guide. If you specify both tag keys // and tag values in the same request, Amazon Redshift returns all security groups // that match any combination of the specified keys and values. For example, if you @@ -48,8 +47,8 @@ type DescribeClusterSecurityGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSecurityGroups request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Constraints: You must specify either the // ClusterSecurityGroupName parameter or the Marker parameter, but not both. @@ -65,17 +64,17 @@ type DescribeClusterSecurityGroupsInput struct { // A tag key or keys for which you want to return all matching cluster security // groups that are associated with the specified key or keys. For example, suppose // that you have security groups that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon + // environment . If you specify both of these tag keys in the request, Amazon // Redshift returns a response with the security groups that have either or both of // these tag keys associated with them. TagKeys []string - // A tag value or values for which you want to return all matching cluster security - // groups that are associated with the specified tag value or values. For example, - // suppose that you have security groups that are tagged with values called admin - // and test. If you specify both of these tag values in the request, Amazon - // Redshift returns a response with the security groups that have either or both of - // these tag values associated with them. + // A tag value or values for which you want to return all matching cluster + // security groups that are associated with the specified tag value or values. For + // example, suppose that you have security groups that are tagged with values + // called admin and test . If you specify both of these tag values in the request, + // Amazon Redshift returns a response with the security groups that have either or + // both of these tag values associated with them. TagValues []string noSmithyDocumentSerde diff --git a/service/redshift/api_op_DescribeClusterSnapshots.go b/service/redshift/api_op_DescribeClusterSnapshots.go index 0d07db8a28e..1c1ba780d9c 100644 --- a/service/redshift/api_op_DescribeClusterSnapshots.go +++ b/service/redshift/api_op_DescribeClusterSnapshots.go @@ -23,11 +23,12 @@ import ( // specify both tag keys and tag values in the same request, Amazon Redshift // returns all snapshots that match any combination of the specified keys and // values. For example, if you have owner and environment for tag keys, and admin -// and test for tag values, all snapshots that have any combination of those values -// are returned. Only snapshots that you own are returned in the response; shared -// snapshots are not returned with the tag key and tag value request parameters. If -// both tag keys and values are omitted from the request, snapshots are returned -// regardless of whether they have tag keys or values associated with them. +// and test for tag values, all snapshots that have any combination of those +// values are returned. Only snapshots that you own are returned in the response; +// shared snapshots are not returned with the tag key and tag value request +// parameters. If both tag keys and values are omitted from the request, snapshots +// are returned regardless of whether they have tag keys or values associated with +// them. func (c *Client) DescribeClusterSnapshots(ctx context.Context, params *DescribeClusterSnapshotsInput, optFns ...func(*Options)) (*DescribeClusterSnapshotsOutput, error) { if params == nil { params = &DescribeClusterSnapshotsInput{} @@ -45,24 +46,17 @@ func (c *Client) DescribeClusterSnapshots(ctx context.Context, params *DescribeC type DescribeClusterSnapshotsInput struct { - // A value that indicates whether to return snapshots only for an existing cluster. - // You can perform table-level restore only by using a snapshot of an existing - // cluster, that is, a cluster that has not been deleted. Values for this parameter - // work as follows: - // - // * If ClusterExists is set to true, ClusterIdentifier is - // required. - // - // * If ClusterExists is set to false and ClusterIdentifier isn't - // specified, all snapshots associated with deleted clusters (orphaned snapshots) - // are returned. - // - // * If ClusterExists is set to false and ClusterIdentifier is - // specified for a deleted cluster, snapshots associated with that cluster are - // returned. - // - // * If ClusterExists is set to false and ClusterIdentifier is specified - // for an existing cluster, no snapshots are returned. + // A value that indicates whether to return snapshots only for an existing + // cluster. You can perform table-level restore only by using a snapshot of an + // existing cluster, that is, a cluster that has not been deleted. Values for this + // parameter work as follows: + // - If ClusterExists is set to true , ClusterIdentifier is required. + // - If ClusterExists is set to false and ClusterIdentifier isn't specified, all + // snapshots associated with deleted clusters (orphaned snapshots) are returned. + // - If ClusterExists is set to false and ClusterIdentifier is specified for a + // deleted cluster, snapshots associated with that cluster are returned. + // - If ClusterExists is set to false and ClusterIdentifier is specified for an + // existing cluster, no snapshots are returned. ClusterExists *bool // The identifier of the cluster which generated the requested snapshots. @@ -70,13 +64,13 @@ type DescribeClusterSnapshotsInput struct { // A time value that requests only snapshots created at or before the specified // time. The time value is specified in ISO 8601 format. For more information about - // ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2012-07-16T18:00:00Z + // ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) + // Example: 2012-07-16T18:00:00Z EndTime *time.Time // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSnapshots request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the + // the value specified in MaxRecords , Amazon Web Services returns a value in the // Marker field of the response. You can retrieve the next set of response records // by providing the returned marker value in the Marker parameter and retrying the // request. @@ -109,15 +103,15 @@ type DescribeClusterSnapshotsInput struct { // SortingEntities []types.SnapshotSortingEntity - // A value that requests only snapshots created at or after the specified time. The - // time value is specified in ISO 8601 format. For more information about ISO 8601, - // go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) + // A value that requests only snapshots created at or after the specified time. + // The time value is specified in ISO 8601 format. For more information about ISO + // 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601) // Example: 2012-07-16T18:00:00Z StartTime *time.Time // A tag key or keys for which you want to return all matching cluster snapshots // that are associated with the specified key or keys. For example, suppose that - // you have snapshots that are tagged with keys called owner and environment. If + // you have snapshots that are tagged with keys called owner and environment . If // you specify both of these tag keys in the request, Amazon Redshift returns a // response with the snapshots that have either or both of these tag keys // associated with them. @@ -126,7 +120,7 @@ type DescribeClusterSnapshotsInput struct { // A tag value or values for which you want to return all matching cluster // snapshots that are associated with the specified tag value or values. For // example, suppose that you have snapshots that are tagged with values called - // admin and test. If you specify both of these tag values in the request, Amazon + // admin and test . If you specify both of these tag values in the request, Amazon // Redshift returns a response with the snapshots that have either or both of these // tag values associated with them. TagValues []string @@ -325,9 +319,9 @@ type SnapshotAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SnapshotAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SnapshotAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -375,10 +369,10 @@ func (w *SnapshotAvailableWaiter) Wait(ctx context.Context, params *DescribeClus return err } -// WaitForOutput calls the waiter function for SnapshotAvailable waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for SnapshotAvailable waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *SnapshotAvailableWaiter) WaitForOutput(ctx context.Context, params *DescribeClusterSnapshotsInput, maxWaitDur time.Duration, optFns ...func(*SnapshotAvailableWaiterOptions)) (*DescribeClusterSnapshotsOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/redshift/api_op_DescribeClusterSubnetGroups.go b/service/redshift/api_op_DescribeClusterSubnetGroups.go index 3f48ecc1206..47592a78e4b 100644 --- a/service/redshift/api_op_DescribeClusterSubnetGroups.go +++ b/service/redshift/api_op_DescribeClusterSubnetGroups.go @@ -44,8 +44,8 @@ type DescribeClusterSubnetGroupsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterSubnetGroups request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -60,17 +60,17 @@ type DescribeClusterSubnetGroupsInput struct { // A tag key or keys for which you want to return all matching cluster subnet // groups that are associated with the specified key or keys. For example, suppose // that you have subnet groups that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon + // environment . If you specify both of these tag keys in the request, Amazon // Redshift returns a response with the subnet groups that have either or both of // these tag keys associated with them. TagKeys []string // A tag value or values for which you want to return all matching cluster subnet // groups that are associated with the specified tag value or values. For example, - // suppose that you have subnet groups that are tagged with values called admin and - // test. If you specify both of these tag values in the request, Amazon Redshift - // returns a response with the subnet groups that have either or both of these tag - // values associated with them. + // suppose that you have subnet groups that are tagged with values called admin + // and test . If you specify both of these tag values in the request, Amazon + // Redshift returns a response with the subnet groups that have either or both of + // these tag values associated with them. TagValues []string noSmithyDocumentSerde diff --git a/service/redshift/api_op_DescribeClusterTracks.go b/service/redshift/api_op_DescribeClusterTracks.go index 2b552f96ad8..eda0df491bf 100644 --- a/service/redshift/api_op_DescribeClusterTracks.go +++ b/service/redshift/api_op_DescribeClusterTracks.go @@ -34,10 +34,10 @@ type DescribeClusterTracksInput struct { MaintenanceTrackName *string // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeClusterTracks request exceed the - // value specified in MaxRecords, Amazon Redshift returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // response records. When the results of a DescribeClusterTracks request exceed + // the value specified in MaxRecords , Amazon Redshift returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Marker *string diff --git a/service/redshift/api_op_DescribeClusterVersions.go b/service/redshift/api_op_DescribeClusterVersions.go index f8bc849de43..f821296e771 100644 --- a/service/redshift/api_op_DescribeClusterVersions.go +++ b/service/redshift/api_op_DescribeClusterVersions.go @@ -15,9 +15,8 @@ import ( // Returns descriptions of the available Amazon Redshift cluster versions. You can // call this operation even before creating any clusters to learn more about the // Amazon Redshift versions. For more information about managing clusters, go to -// Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeClusterVersions(ctx context.Context, params *DescribeClusterVersionsInput, optFns ...func(*Options)) (*DescribeClusterVersionsOutput, error) { if params == nil { params = &DescribeClusterVersionsInput{} @@ -37,13 +36,9 @@ type DescribeClusterVersionsInput struct { // The name of a specific cluster parameter group family to return details for. // Constraints: - // - // * Must be 1 to 255 alphanumeric characters - // - // * First character must - // be a letter - // - // * Cannot end with a hyphen or contain two consecutive hyphens + // - Must be 1 to 255 alphanumeric characters + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens ClusterParameterGroupFamily *string // The specific cluster version to return. Example: 1.0 @@ -51,7 +46,7 @@ type DescribeClusterVersionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusterVersions request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the + // the value specified in MaxRecords , Amazon Web Services returns a value in the // Marker field of the response. You can retrieve the next set of response records // by providing the returned marker value in the Marker parameter and retrying the // request. diff --git a/service/redshift/api_op_DescribeClusters.go b/service/redshift/api_op_DescribeClusters.go index aaa79b34a06..d44c4c3498c 100644 --- a/service/redshift/api_op_DescribeClusters.go +++ b/service/redshift/api_op_DescribeClusters.go @@ -18,18 +18,17 @@ import ( "time" ) -// Returns properties of provisioned clusters including general cluster properties, -// cluster database properties, maintenance and backup properties, and security and -// access properties. This operation supports pagination. For more information -// about managing clusters, go to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. If you specify both tag keys and -// tag values in the same request, Amazon Redshift returns all clusters that match -// any combination of the specified keys and values. For example, if you have owner -// and environment for tag keys, and admin and test for tag values, all clusters -// that have any combination of those values are returned. If both tag keys and -// values are omitted from the request, clusters are returned regardless of whether -// they have tag keys or values associated with them. +// Returns properties of provisioned clusters including general cluster +// properties, cluster database properties, maintenance and backup properties, and +// security and access properties. This operation supports pagination. For more +// information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. If you specify both tag keys +// and tag values in the same request, Amazon Redshift returns all clusters that +// match any combination of the specified keys and values. For example, if you have +// owner and environment for tag keys, and admin and test for tag values, all +// clusters that have any combination of those values are returned. If both tag +// keys and values are omitted from the request, clusters are returned regardless +// of whether they have tag keys or values associated with them. func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error) { if params == nil { params = &DescribeClustersInput{} @@ -54,9 +53,9 @@ type DescribeClustersInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeClusters request exceed the - // value specified in MaxRecords, Amazon Web Services returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // value specified in MaxRecords , Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Constraints: You can specify either the ClusterIdentifier parameter or // the Marker parameter, but not both. Marker *string @@ -70,14 +69,14 @@ type DescribeClustersInput struct { // A tag key or keys for which you want to return all matching clusters that are // associated with the specified key or keys. For example, suppose that you have - // clusters that are tagged with keys called owner and environment. If you specify + // clusters that are tagged with keys called owner and environment . If you specify // both of these tag keys in the request, Amazon Redshift returns a response with // the clusters that have either or both of these tag keys associated with them. TagKeys []string // A tag value or values for which you want to return all matching clusters that // are associated with the specified tag value or values. For example, suppose that - // you have clusters that are tagged with values called admin and test. If you + // you have clusters that are tagged with values called admin and test . If you // specify both of these tag values in the request, Amazon Redshift returns a // response with the clusters that have either or both of these tag values // associated with them. @@ -272,9 +271,9 @@ type ClusterAvailableWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterAvailableWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterAvailableWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -483,9 +482,9 @@ type ClusterDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -686,9 +685,9 @@ type ClusterRestoredWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterRestoredWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterRestoredWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -728,9 +727,9 @@ func NewClusterRestoredWaiter(client DescribeClustersAPIClient, optFns ...func(* } } -// Wait calls the waiter function for ClusterRestored waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for ClusterRestored waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *ClusterRestoredWaiter) Wait(ctx context.Context, params *DescribeClustersInput, maxWaitDur time.Duration, optFns ...func(*ClusterRestoredWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/redshift/api_op_DescribeDataShares.go b/service/redshift/api_op_DescribeDataShares.go index ed299009b12..b704d22ceb0 100644 --- a/service/redshift/api_op_DescribeDataShares.go +++ b/service/redshift/api_op_DescribeDataShares.go @@ -36,9 +36,9 @@ type DescribeDataSharesInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataShares request exceed the - // value specified in MaxRecords, Amazon Web Services returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // value specified in MaxRecords , Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Marker *string @@ -58,9 +58,9 @@ type DescribeDataSharesOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataShares request exceed the - // value specified in MaxRecords, Amazon Web Services returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // value specified in MaxRecords , Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Marker *string diff --git a/service/redshift/api_op_DescribeDataSharesForConsumer.go b/service/redshift/api_op_DescribeDataSharesForConsumer.go index eda661c8e6f..df726a1c0f5 100644 --- a/service/redshift/api_op_DescribeDataSharesForConsumer.go +++ b/service/redshift/api_op_DescribeDataSharesForConsumer.go @@ -37,8 +37,8 @@ type DescribeDataSharesForConsumerInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataSharesForConsumer request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -64,8 +64,8 @@ type DescribeDataSharesForConsumerOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataSharesForConsumer request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string diff --git a/service/redshift/api_op_DescribeDataSharesForProducer.go b/service/redshift/api_op_DescribeDataSharesForProducer.go index b65fa82ccac..8fd7872195d 100644 --- a/service/redshift/api_op_DescribeDataSharesForProducer.go +++ b/service/redshift/api_op_DescribeDataSharesForProducer.go @@ -33,8 +33,8 @@ type DescribeDataSharesForProducerInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataSharesForProducer request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -49,8 +49,8 @@ type DescribeDataSharesForProducerInput struct { // datashares. ProducerArn *string - // An identifier giving the status of a datashare in the producer. If this field is - // specified, Amazon Redshift returns the list of datashares that have the + // An identifier giving the status of a datashare in the producer. If this field + // is specified, Amazon Redshift returns the list of datashares that have the // specified status. Status types.DataShareStatusForProducer @@ -64,8 +64,8 @@ type DescribeDataSharesForProducerOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeDataSharesForProducer request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string diff --git a/service/redshift/api_op_DescribeDefaultClusterParameters.go b/service/redshift/api_op_DescribeDefaultClusterParameters.go index 0591fd03bcc..9ad163c199d 100644 --- a/service/redshift/api_op_DescribeDefaultClusterParameters.go +++ b/service/redshift/api_op_DescribeDefaultClusterParameters.go @@ -14,8 +14,7 @@ import ( // Returns a list of parameter settings for the specified parameter group family. // For more information about parameters and parameter groups, go to Amazon -// Redshift Parameter Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) +// Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeDefaultClusterParameters(ctx context.Context, params *DescribeDefaultClusterParametersInput, optFns ...func(*Options)) (*DescribeDefaultClusterParametersOutput, error) { if params == nil { @@ -40,11 +39,11 @@ type DescribeDefaultClusterParametersInput struct { ParameterGroupFamily *string // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeDefaultClusterParameters request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeDefaultClusterParameters + // request exceed the value specified in MaxRecords , Amazon Web Services returns a + // value in the Marker field of the response. You can retrieve the next set of + // response records by providing the returned marker value in the Marker parameter + // and retrying the request. Marker *string // The maximum number of response records to return in each call. If the number of diff --git a/service/redshift/api_op_DescribeEventCategories.go b/service/redshift/api_op_DescribeEventCategories.go index ac00d7fddd5..4e5d74a2e0f 100644 --- a/service/redshift/api_op_DescribeEventCategories.go +++ b/service/redshift/api_op_DescribeEventCategories.go @@ -13,8 +13,8 @@ import ( // Displays a list of event categories for all event source types, or for a // specified source type. For a list of the event categories and source types, go -// to Amazon Redshift Event Notifications -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html). +// to Amazon Redshift Event Notifications (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html) +// . func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, optFns ...func(*Options)) (*DescribeEventCategoriesOutput, error) { if params == nil { params = &DescribeEventCategoriesInput{} diff --git a/service/redshift/api_op_DescribeEventSubscriptions.go b/service/redshift/api_op_DescribeEventSubscriptions.go index 7e873185b6d..8a00ca68bdb 100644 --- a/service/redshift/api_op_DescribeEventSubscriptions.go +++ b/service/redshift/api_op_DescribeEventSubscriptions.go @@ -41,8 +41,8 @@ type DescribeEventSubscriptionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeEventSubscriptions request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -60,7 +60,7 @@ type DescribeEventSubscriptionsInput struct { // A tag key or keys for which you want to return all matching event notification // subscriptions that are associated with the specified key or keys. For example, // suppose that you have subscriptions that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon + // environment . If you specify both of these tag keys in the request, Amazon // Redshift returns a response with the subscriptions that have either or both of // these tag keys associated with them. TagKeys []string @@ -68,7 +68,7 @@ type DescribeEventSubscriptionsInput struct { // A tag value or values for which you want to return all matching event // notification subscriptions that are associated with the specified tag value or // values. For example, suppose that you have subscriptions that are tagged with - // values called admin and test. If you specify both of these tag values in the + // values called admin and test . If you specify both of these tag values in the // request, Amazon Redshift returns a response with the subscriptions that have // either or both of these tag values associated with them. TagValues []string diff --git a/service/redshift/api_op_DescribeEvents.go b/service/redshift/api_op_DescribeEvents.go index 0d1334c3489..8b1b8c59f74 100644 --- a/service/redshift/api_op_DescribeEvents.go +++ b/service/redshift/api_op_DescribeEvents.go @@ -40,16 +40,17 @@ type DescribeEventsInput struct { // Default: 60 Duration *int32 - // The end of the time interval for which to retrieve events, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The end of the time interval for which to retrieve events, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z EndTime *time.Time // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeEvents request exceed the value - // specified in MaxRecords, Amazon Web Services returns a value in the Marker field - // of the response. You can retrieve the next set of response records by providing - // the returned marker value in the Marker parameter and retrying the request. + // specified in MaxRecords , Amazon Web Services returns a value in the Marker + // field of the response. You can retrieve the next set of response records by + // providing the returned marker value in the Marker parameter and retrying the + // request. Marker *string // The maximum number of response records to return in each call. If the number of @@ -61,42 +62,30 @@ type DescribeEventsInput struct { // The identifier of the event source for which events will be returned. If this // parameter is not specified, then all sources are included in the response. - // Constraints: If SourceIdentifier is supplied, SourceType must also be - // provided. - // - // * Specify a cluster identifier when SourceType is cluster. - // - // * Specify - // a cluster security group name when SourceType is cluster-security-group. - // - // * - // Specify a cluster parameter group name when SourceType is - // cluster-parameter-group. - // - // * Specify a cluster snapshot identifier when - // SourceType is cluster-snapshot. + // Constraints: If SourceIdentifier is supplied, SourceType must also be provided. + // - Specify a cluster identifier when SourceType is cluster . + // - Specify a cluster security group name when SourceType is + // cluster-security-group . + // - Specify a cluster parameter group name when SourceType is + // cluster-parameter-group . + // - Specify a cluster snapshot identifier when SourceType is cluster-snapshot . SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. Constraints: If SourceType is supplied, SourceIdentifier must also // be provided. - // - // * Specify cluster when SourceIdentifier is a cluster - // identifier. - // - // * Specify cluster-security-group when SourceIdentifier is a cluster - // security group name. - // - // * Specify cluster-parameter-group when SourceIdentifier is - // a cluster parameter group name. - // - // * Specify cluster-snapshot when - // SourceIdentifier is a cluster snapshot identifier. + // - Specify cluster when SourceIdentifier is a cluster identifier. + // - Specify cluster-security-group when SourceIdentifier is a cluster security + // group name. + // - Specify cluster-parameter-group when SourceIdentifier is a cluster parameter + // group name. + // - Specify cluster-snapshot when SourceIdentifier is a cluster snapshot + // identifier. SourceType types.SourceType - // The beginning of the time interval to retrieve events for, specified in ISO 8601 - // format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. - // (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z + // The beginning of the time interval to retrieve events for, specified in ISO + // 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia + // page. (http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z StartTime *time.Time noSmithyDocumentSerde diff --git a/service/redshift/api_op_DescribeHsmClientCertificates.go b/service/redshift/api_op_DescribeHsmClientCertificates.go index 627b66034fa..70cb479745e 100644 --- a/service/redshift/api_op_DescribeHsmClientCertificates.go +++ b/service/redshift/api_op_DescribeHsmClientCertificates.go @@ -46,8 +46,8 @@ type DescribeHsmClientCertificatesInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeHsmClientCertificates request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string @@ -62,7 +62,7 @@ type DescribeHsmClientCertificatesInput struct { // A tag key or keys for which you want to return all matching HSM client // certificates that are associated with the specified key or keys. For example, // suppose that you have HSM client certificates that are tagged with keys called - // owner and environment. If you specify both of these tag keys in the request, + // owner and environment . If you specify both of these tag keys in the request, // Amazon Redshift returns a response with the HSM client certificates that have // either or both of these tag keys associated with them. TagKeys []string @@ -70,7 +70,7 @@ type DescribeHsmClientCertificatesInput struct { // A tag value or values for which you want to return all matching HSM client // certificates that are associated with the specified tag value or values. For // example, suppose that you have HSM client certificates that are tagged with - // values called admin and test. If you specify both of these tag values in the + // values called admin and test . If you specify both of these tag values in the // request, Amazon Redshift returns a response with the HSM client certificates // that have either or both of these tag values associated with them. TagValues []string @@ -80,8 +80,9 @@ type DescribeHsmClientCertificatesInput struct { type DescribeHsmClientCertificatesOutput struct { - // A list of the identifiers for one or more HSM client certificates used by Amazon - // Redshift clusters to store and retrieve database encryption keys in an HSM. + // A list of the identifiers for one or more HSM client certificates used by + // Amazon Redshift clusters to store and retrieve database encryption keys in an + // HSM. HsmClientCertificates []types.HsmClientCertificate // A value that indicates the starting point for the next set of response records diff --git a/service/redshift/api_op_DescribeHsmConfigurations.go b/service/redshift/api_op_DescribeHsmConfigurations.go index 70f3b3890ad..68734f0bfec 100644 --- a/service/redshift/api_op_DescribeHsmConfigurations.go +++ b/service/redshift/api_op_DescribeHsmConfigurations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the specified Amazon Redshift HSM configuration. If no -// configuration ID is specified, returns information about all the HSM +// Returns information about the specified Amazon Redshift HSM configuration. If +// no configuration ID is specified, returns information about all the HSM // configurations owned by your Amazon Web Services account. If you specify both // tag keys and tag values in the same request, Amazon Redshift returns all HSM // connections that match any combination of the specified keys and values. For @@ -45,11 +45,11 @@ type DescribeHsmConfigurationsInput struct { HsmConfigurationIdentifier *string // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeHsmConfigurations request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the - // Marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying the - // request. + // response records. When the results of a DescribeHsmConfigurations request + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Marker *string // The maximum number of response records to return in each call. If the number of @@ -62,7 +62,7 @@ type DescribeHsmConfigurationsInput struct { // A tag key or keys for which you want to return all matching HSM configurations // that are associated with the specified key or keys. For example, suppose that // you have HSM configurations that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon + // environment . If you specify both of these tag keys in the request, Amazon // Redshift returns a response with the HSM configurations that have either or both // of these tag keys associated with them. TagKeys []string @@ -70,7 +70,7 @@ type DescribeHsmConfigurationsInput struct { // A tag value or values for which you want to return all matching HSM // configurations that are associated with the specified tag value or values. For // example, suppose that you have HSM configurations that are tagged with values - // called admin and test. If you specify both of these tag values in the request, + // called admin and test . If you specify both of these tag values in the request, // Amazon Redshift returns a response with the HSM configurations that have either // or both of these tag values associated with them. TagValues []string diff --git a/service/redshift/api_op_DescribeLoggingStatus.go b/service/redshift/api_op_DescribeLoggingStatus.go index 1bfb40cb6ec..2a5bec538db 100644 --- a/service/redshift/api_op_DescribeLoggingStatus.go +++ b/service/redshift/api_op_DescribeLoggingStatus.go @@ -12,8 +12,8 @@ import ( "time" ) -// Describes whether information, such as queries and connection attempts, is being -// logged for the specified Amazon Redshift cluster. +// Describes whether information, such as queries and connection attempts, is +// being logged for the specified Amazon Redshift cluster. func (c *Client) DescribeLoggingStatus(ctx context.Context, params *DescribeLoggingStatusInput, optFns ...func(*Options)) (*DescribeLoggingStatusOutput, error) { if params == nil { params = &DescribeLoggingStatusInput{} @@ -55,11 +55,11 @@ type DescribeLoggingStatusOutput struct { // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time - // The log destination type. An enum with possible values of s3 and cloudwatch. + // The log destination type. An enum with possible values of s3 and cloudwatch . LogDestinationType types.LogDestinationType - // The collection of exported log types. Possible values are connectionlog, - // useractivitylog, and userlog. + // The collection of exported log types. Possible values are connectionlog , + // useractivitylog , and userlog . LogExports []string // true if logging is on, false if logging is off. diff --git a/service/redshift/api_op_DescribeNodeConfigurationOptions.go b/service/redshift/api_op_DescribeNodeConfigurationOptions.go index 34d1b11f7a4..39be47d8ef6 100644 --- a/service/redshift/api_op_DescribeNodeConfigurationOptions.go +++ b/service/redshift/api_op_DescribeNodeConfigurationOptions.go @@ -47,11 +47,11 @@ type DescribeNodeConfigurationOptionsInput struct { Filters []types.NodeConfigurationOptionsFilter // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeNodeConfigurationOptions request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeNodeConfigurationOptions + // request exceed the value specified in MaxRecords , Amazon Web Services returns a + // value in the Marker field of the response. You can retrieve the next set of + // response records by providing the returned marker value in the Marker parameter + // and retrying the request. Marker *string // The maximum number of response records to return in each call. If the number of @@ -61,8 +61,9 @@ type DescribeNodeConfigurationOptionsInput struct { // Constraints: minimum 100, maximum 500. MaxRecords *int32 - // The Amazon Web Services account used to create or copy the snapshot. Required if - // you are restoring a snapshot you do not own, optional if you own the snapshot. + // The Amazon Web Services account used to create or copy the snapshot. Required + // if you are restoring a snapshot you do not own, optional if you own the + // snapshot. OwnerAccount *string // The Amazon Resource Name (ARN) of the snapshot associated with the message to diff --git a/service/redshift/api_op_DescribeOrderableClusterOptions.go b/service/redshift/api_op_DescribeOrderableClusterOptions.go index 503b0928c04..60da1ba0edf 100644 --- a/service/redshift/api_op_DescribeOrderableClusterOptions.go +++ b/service/redshift/api_op_DescribeOrderableClusterOptions.go @@ -12,16 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of orderable cluster options. Before you create a new cluster you -// can use this operation to find what options are available, such as the EC2 +// Returns a list of orderable cluster options. Before you create a new cluster +// you can use this operation to find what options are available, such as the EC2 // Availability Zones (AZ) in the specific Amazon Web Services Region that you can // specify, and the node types you can request. The node types differ by available // storage, memory, CPU and price. With the cost involved you might want to obtain // a list of cluster options in the specific region and specify values when // creating a cluster. For more information about managing clusters, go to Amazon -// Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeOrderableClusterOptions(ctx context.Context, params *DescribeOrderableClusterOptionsInput, optFns ...func(*Options)) (*DescribeOrderableClusterOptionsOutput, error) { if params == nil { params = &DescribeOrderableClusterOptionsInput{} @@ -41,13 +40,13 @@ type DescribeOrderableClusterOptionsInput struct { // The version filter value. Specify this parameter to show only the available // offerings matching the specified version. Default: All versions. Constraints: - // Must be one of the version returned from DescribeClusterVersions. + // Must be one of the version returned from DescribeClusterVersions . ClusterVersion *string // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeOrderableClusterOptions request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string diff --git a/service/redshift/api_op_DescribeReservedNodeExchangeStatus.go b/service/redshift/api_op_DescribeReservedNodeExchangeStatus.go index ffc1ae46909..26df945a0b5 100644 --- a/service/redshift/api_op_DescribeReservedNodeExchangeStatus.go +++ b/service/redshift/api_op_DescribeReservedNodeExchangeStatus.go @@ -60,8 +60,8 @@ type DescribeReservedNodeExchangeStatusOutput struct { // request. Marker *string - // The details of the reserved-node exchange request, including the status, request - // time, source reserved-node identifier, and additional details. + // The details of the reserved-node exchange request, including the status, + // request time, source reserved-node identifier, and additional details. ReservedNodeExchangeStatusDetails []types.ReservedNodeExchangeStatus // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_DescribeReservedNodeOfferings.go b/service/redshift/api_op_DescribeReservedNodeOfferings.go index 7cf4232e68e..50766f72cdc 100644 --- a/service/redshift/api_op_DescribeReservedNodeOfferings.go +++ b/service/redshift/api_op_DescribeReservedNodeOfferings.go @@ -19,8 +19,7 @@ import ( // purchase. You then use the unique offering ID in you call to // PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon // Redshift cluster. For more information about reserved node offerings, go to -// Purchasing Reserved Nodes -// (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) +// Purchasing Reserved Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeReservedNodeOfferings(ctx context.Context, params *DescribeReservedNodeOfferingsInput, optFns ...func(*Options)) (*DescribeReservedNodeOfferingsOutput, error) { if params == nil { @@ -41,8 +40,8 @@ type DescribeReservedNodeOfferingsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeReservedNodeOfferings request - // exceed the value specified in MaxRecords, Amazon Web Services returns a value in - // the Marker field of the response. You can retrieve the next set of response + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response // records by providing the returned marker value in the Marker parameter and // retrying the request. Marker *string diff --git a/service/redshift/api_op_DescribeReservedNodes.go b/service/redshift/api_op_DescribeReservedNodes.go index 2f5e3619a71..5709cd5fe03 100644 --- a/service/redshift/api_op_DescribeReservedNodes.go +++ b/service/redshift/api_op_DescribeReservedNodes.go @@ -31,10 +31,10 @@ func (c *Client) DescribeReservedNodes(ctx context.Context, params *DescribeRese type DescribeReservedNodesInput struct { // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeReservedNodes request exceed the - // value specified in MaxRecords, Amazon Web Services returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // response records. When the results of a DescribeReservedNodes request exceed + // the value specified in MaxRecords , Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Marker *string diff --git a/service/redshift/api_op_DescribeResize.go b/service/redshift/api_op_DescribeResize.go index 70890eb19fd..1f4b00f4013 100644 --- a/service/redshift/api_op_DescribeResize.go +++ b/service/redshift/api_op_DescribeResize.go @@ -11,11 +11,11 @@ import ( ) // Returns information about the last resize operation for the specified cluster. -// If no resize operation has ever been initiated for the specified cluster, a HTTP -// 404 error is returned. If a resize operation was initiated and completed, the -// status of the resize remains as SUCCEEDED until the next resize. A resize -// operation can be requested using ModifyCluster and specifying a different number -// or type of nodes for the cluster. +// If no resize operation has ever been initiated for the specified cluster, a +// HTTP 404 error is returned. If a resize operation was initiated and completed, +// the status of the resize remains as SUCCEEDED until the next resize. A resize +// operation can be requested using ModifyCluster and specifying a different +// number or type of nodes for the cluster. func (c *Client) DescribeResize(ctx context.Context, params *DescribeResizeInput, optFns ...func(*Options)) (*DescribeResizeOutput, error) { if params == nil { params = &DescribeResizeInput{} @@ -73,8 +73,8 @@ type DescribeResizeOutput struct { // table names. ImportTablesInProgress []string - // The names of tables that have not been yet imported. Valid Values: List of table - // names + // The names of tables that have not been yet imported. Valid Values: List of + // table names ImportTablesNotStarted []string // An optional string to provide additional details about the resize action. @@ -87,7 +87,7 @@ type DescribeResizeOutput struct { // estimated total amount of data before resize). ProgressInMegaBytes *int64 - // An enum with possible values of ClassicResize and ElasticResize. These values + // An enum with possible values of ClassicResize and ElasticResize . These values // describe the type of resize operation being performed. ResizeType *string @@ -100,7 +100,7 @@ type DescribeResizeOutput struct { TargetClusterType *string // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None. + // values are KMS and None . TargetEncryptionType *string // The node type that the cluster will have after the resize operation is complete. diff --git a/service/redshift/api_op_DescribeScheduledActions.go b/service/redshift/api_op_DescribeScheduledActions.go index f773b710ed8..7cfbe62e6fe 100644 --- a/service/redshift/api_op_DescribeScheduledActions.go +++ b/service/redshift/api_op_DescribeScheduledActions.go @@ -44,7 +44,7 @@ type DescribeScheduledActionsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the + // the value specified in MaxRecords , Amazon Web Services returns a value in the // Marker field of the response. You can retrieve the next set of response records // by providing the returned marker value in the Marker parameter and retrying the // request. @@ -74,7 +74,7 @@ type DescribeScheduledActionsOutput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeScheduledActions request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the + // the value specified in MaxRecords , Amazon Web Services returns a value in the // Marker field of the response. You can retrieve the next set of response records // by providing the returned marker value in the Marker parameter and retrying the // request. diff --git a/service/redshift/api_op_DescribeSnapshotCopyGrants.go b/service/redshift/api_op_DescribeSnapshotCopyGrants.go index b660f2cee4c..bed824bc111 100644 --- a/service/redshift/api_op_DescribeSnapshotCopyGrants.go +++ b/service/redshift/api_op_DescribeSnapshotCopyGrants.go @@ -14,8 +14,7 @@ import ( // Returns a list of snapshot copy grants owned by the Amazon Web Services account // in the destination region. For more information about managing snapshot copy -// grants, go to Amazon Redshift Database Encryption -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) +// grants, go to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) DescribeSnapshotCopyGrants(ctx context.Context, params *DescribeSnapshotCopyGrantsInput, optFns ...func(*Options)) (*DescribeSnapshotCopyGrantsOutput, error) { if params == nil { @@ -36,12 +35,12 @@ func (c *Client) DescribeSnapshotCopyGrants(ctx context.Context, params *Describ type DescribeSnapshotCopyGrantsInput struct { // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeSnapshotCopyGrant request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the - // Marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying the - // request. Constraints: You can specify either the SnapshotCopyGrantName parameter - // or the Marker parameter, but not both. + // response records. When the results of a DescribeSnapshotCopyGrant request + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Constraints: You can specify either the + // SnapshotCopyGrantName parameter or the Marker parameter, but not both. Marker *string // The maximum number of response records to return in each call. If the number of @@ -56,14 +55,14 @@ type DescribeSnapshotCopyGrantsInput struct { // A tag key or keys for which you want to return all matching resources that are // associated with the specified key or keys. For example, suppose that you have - // resources tagged with keys called owner and environment. If you specify both of + // resources tagged with keys called owner and environment . If you specify both of // these tag keys in the request, Amazon Redshift returns a response with all // resources that have either or both of these tag keys associated with them. TagKeys []string // A tag value or values for which you want to return all matching resources that // are associated with the specified value or values. For example, suppose that you - // have resources tagged with values called admin and test. If you specify both of + // have resources tagged with values called admin and test . If you specify both of // these tag values in the request, Amazon Redshift returns a response with all // resources that have either or both of these tag values associated with them. TagValues []string @@ -74,12 +73,12 @@ type DescribeSnapshotCopyGrantsInput struct { type DescribeSnapshotCopyGrantsOutput struct { // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeSnapshotCopyGrant request exceed - // the value specified in MaxRecords, Amazon Web Services returns a value in the - // Marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the Marker parameter and retrying the - // request. Constraints: You can specify either the SnapshotCopyGrantName parameter - // or the Marker parameter, but not both. + // response records. When the results of a DescribeSnapshotCopyGrant request + // exceed the value specified in MaxRecords , Amazon Web Services returns a value + // in the Marker field of the response. You can retrieve the next set of response + // records by providing the returned marker value in the Marker parameter and + // retrying the request. Constraints: You can specify either the + // SnapshotCopyGrantName parameter or the Marker parameter, but not both. Marker *string // The list of SnapshotCopyGrant objects. diff --git a/service/redshift/api_op_DescribeTableRestoreStatus.go b/service/redshift/api_op_DescribeTableRestoreStatus.go index a1109a88d32..68c05a6eba1 100644 --- a/service/redshift/api_op_DescribeTableRestoreStatus.go +++ b/service/redshift/api_op_DescribeTableRestoreStatus.go @@ -17,7 +17,7 @@ import ( // TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the // status of all table restore requests ordered by the date and time of the request // in ascending order. Otherwise DescribeTableRestoreStatus returns the status of -// the table specified by TableRestoreRequestId. +// the table specified by TableRestoreRequestId . func (c *Client) DescribeTableRestoreStatus(ctx context.Context, params *DescribeTableRestoreStatusInput, optFns ...func(*Options)) (*DescribeTableRestoreStatusOutput, error) { if params == nil { params = &DescribeTableRestoreStatusInput{} diff --git a/service/redshift/api_op_DescribeTags.go b/service/redshift/api_op_DescribeTags.go index 4ada4ff6937..688ab8c0acb 100644 --- a/service/redshift/api_op_DescribeTags.go +++ b/service/redshift/api_op_DescribeTags.go @@ -15,24 +15,21 @@ import ( // Returns a list of tags. You can return tags from a specific resource by // specifying an ARN, or you can return all tags for a given type of resource, such // as clusters, snapshots, and so on. The following are limitations for -// DescribeTags: +// DescribeTags : +// - You cannot specify an ARN and a resource-type value together in the same +// request. +// - You cannot use the MaxRecords and Marker parameters together with the ARN +// parameter. +// - The MaxRecords parameter can be a range from 10 to 50 results to return in a +// request. // -// * You cannot specify an ARN and a resource-type value together in -// the same request. -// -// * You cannot use the MaxRecords and Marker parameters -// together with the ARN parameter. -// -// * The MaxRecords parameter can be a range from -// 10 to 50 results to return in a request. -// -// If you specify both tag keys and tag -// values in the same request, Amazon Redshift returns all resources that match any -// combination of the specified keys and values. For example, if you have owner and -// environment for tag keys, and admin and test for tag values, all resources that -// have any combination of those values are returned. If both tag keys and values -// are omitted from the request, resources are returned regardless of whether they -// have tag keys or values associated with them. +// If you specify both tag keys and tag values in the same request, Amazon +// Redshift returns all resources that match any combination of the specified keys +// and values. For example, if you have owner and environment for tag keys, and +// admin and test for tag values, all resources that have any combination of those +// values are returned. If both tag keys and values are omitted from the request, +// resources are returned regardless of whether they have tag keys or values +// associated with them. func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { params = &DescribeTagsInput{} @@ -64,51 +61,37 @@ type DescribeTagsInput struct { MaxRecords *int32 // The Amazon Resource Name (ARN) for which you want to describe the tag or tags. - // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1. + // For example, arn:aws:redshift:us-east-2:123456789:cluster:t1 . ResourceName *string // The type of resource with which you want to view tags. Valid resource types // are: - // - // * Cluster - // - // * CIDR/IP - // - // * EC2 security group - // - // * Snapshot - // - // * Cluster security - // group - // - // * Subnet group - // - // * HSM connection - // - // * HSM certificate - // - // * Parameter group - // - // * - // Snapshot copy grant - // - // For more information about Amazon Redshift resource types - // and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, - // Resources, and Principals - // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) + // - Cluster + // - CIDR/IP + // - EC2 security group + // - Snapshot + // - Cluster security group + // - Subnet group + // - HSM connection + // - HSM certificate + // - Parameter group + // - Snapshot copy grant + // For more information about Amazon Redshift resource types and constructing + // ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and + // Principals (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) // in the Amazon Redshift Cluster Management Guide. ResourceType *string // A tag key or keys for which you want to return all matching resources that are // associated with the specified key or keys. For example, suppose that you have - // resources tagged with keys called owner and environment. If you specify both of + // resources tagged with keys called owner and environment . If you specify both of // these tag keys in the request, Amazon Redshift returns a response with all // resources that have either or both of these tag keys associated with them. TagKeys []string // A tag value or values for which you want to return all matching resources that // are associated with the specified value or values. For example, suppose that you - // have resources tagged with values called admin and test. If you specify both of + // have resources tagged with values called admin and test . If you specify both of // these tag values in the request, Amazon Redshift returns a response with all // resources that have either or both of these tag values associated with them. TagValues []string diff --git a/service/redshift/api_op_DescribeUsageLimits.go b/service/redshift/api_op_DescribeUsageLimits.go index fda51d6047d..b3671e10b48 100644 --- a/service/redshift/api_op_DescribeUsageLimits.go +++ b/service/redshift/api_op_DescribeUsageLimits.go @@ -15,20 +15,15 @@ import ( // Shows usage limits on a cluster. Results are filtered based on the combination // of input usage limit identifier, cluster identifier, and feature type // parameters: -// -// * If usage limit identifier, cluster identifier, and feature type -// are not provided, then all usage limit objects for the current account in the -// current region are returned. -// -// * If usage limit identifier is provided, then the -// corresponding usage limit object is returned. -// -// * If cluster identifier is -// provided, then all usage limit objects for the specified cluster are -// returned. -// -// * If cluster identifier and feature type are provided, then all usage -// limit objects for the combination of cluster and feature are returned. +// - If usage limit identifier, cluster identifier, and feature type are not +// provided, then all usage limit objects for the current account in the current +// region are returned. +// - If usage limit identifier is provided, then the corresponding usage limit +// object is returned. +// - If cluster identifier is provided, then all usage limit objects for the +// specified cluster are returned. +// - If cluster identifier and feature type are provided, then all usage limit +// objects for the combination of cluster and feature are returned. func (c *Client) DescribeUsageLimits(ctx context.Context, params *DescribeUsageLimitsInput, optFns ...func(*Options)) (*DescribeUsageLimitsOutput, error) { if params == nil { params = &DescribeUsageLimitsInput{} @@ -54,9 +49,9 @@ type DescribeUsageLimitsInput struct { // An optional parameter that specifies the starting point to return a set of // response records. When the results of a DescribeUsageLimits request exceed the - // value specified in MaxRecords, Amazon Web Services returns a value in the Marker - // field of the response. You can retrieve the next set of response records by - // providing the returned marker value in the Marker parameter and retrying the + // value specified in MaxRecords , Amazon Web Services returns a value in the + // Marker field of the response. You can retrieve the next set of response records + // by providing the returned marker value in the Marker parameter and retrying the // request. Marker *string @@ -69,16 +64,16 @@ type DescribeUsageLimitsInput struct { // A tag key or keys for which you want to return all matching usage limit objects // that are associated with the specified key or keys. For example, suppose that - // you have parameter groups that are tagged with keys called owner and - // environment. If you specify both of these tag keys in the request, Amazon - // Redshift returns a response with the usage limit objects have either or both of - // these tag keys associated with them. + // you have parameter groups that are tagged with keys called owner and environment + // . If you specify both of these tag keys in the request, Amazon Redshift returns + // a response with the usage limit objects have either or both of these tag keys + // associated with them. TagKeys []string // A tag value or values for which you want to return all matching usage limit // objects that are associated with the specified tag value or values. For example, // suppose that you have parameter groups that are tagged with values called admin - // and test. If you specify both of these tag values in the request, Amazon + // and test . If you specify both of these tag values in the request, Amazon // Redshift returns a response with the usage limit objects that have either or // both of these tag values associated with them. TagValues []string @@ -167,8 +162,8 @@ func (c *Client) addOperationDescribeUsageLimitsMiddlewares(stack *middleware.St return nil } -// DescribeUsageLimitsAPIClient is a client that implements the DescribeUsageLimits -// operation. +// DescribeUsageLimitsAPIClient is a client that implements the +// DescribeUsageLimits operation. type DescribeUsageLimitsAPIClient interface { DescribeUsageLimits(context.Context, *DescribeUsageLimitsInput, ...func(*Options)) (*DescribeUsageLimitsOutput, error) } diff --git a/service/redshift/api_op_DisableLogging.go b/service/redshift/api_op_DisableLogging.go index c4fbcfea351..63746f42a80 100644 --- a/service/redshift/api_op_DisableLogging.go +++ b/service/redshift/api_op_DisableLogging.go @@ -55,11 +55,11 @@ type DisableLoggingOutput struct { // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time - // The log destination type. An enum with possible values of s3 and cloudwatch. + // The log destination type. An enum with possible values of s3 and cloudwatch . LogDestinationType types.LogDestinationType - // The collection of exported log types. Possible values are connectionlog, - // useractivitylog, and userlog. + // The collection of exported log types. Possible values are connectionlog , + // useractivitylog , and userlog . LogExports []string // true if logging is on, false if logging is off. diff --git a/service/redshift/api_op_DisassociateDataShareConsumer.go b/service/redshift/api_op_DisassociateDataShareConsumer.go index 05bd74badcd..0a797a2a640 100644 --- a/service/redshift/api_op_DisassociateDataShareConsumer.go +++ b/service/redshift/api_op_DisassociateDataShareConsumer.go @@ -43,8 +43,8 @@ type DisassociateDataShareConsumerInput struct { // the existing and future namespaces in the specified Amazon Web Services Region. ConsumerRegion *string - // A value that specifies whether association for the datashare is removed from the - // entire account. + // A value that specifies whether association for the datashare is removed from + // the entire account. DisassociateEntireAccount *bool noSmithyDocumentSerde diff --git a/service/redshift/api_op_EnableLogging.go b/service/redshift/api_op_EnableLogging.go index 0f20561bb28..ea2a367a3cb 100644 --- a/service/redshift/api_op_EnableLogging.go +++ b/service/redshift/api_op_EnableLogging.go @@ -39,38 +39,26 @@ type EnableLoggingInput struct { // The name of an existing S3 bucket where the log files are to be stored. // Constraints: - // - // * Must be in the same region as the cluster - // - // * The cluster must - // have read bucket and put object permissions + // - Must be in the same region as the cluster + // - The cluster must have read bucket and put object permissions BucketName *string - // The log destination type. An enum with possible values of s3 and cloudwatch. + // The log destination type. An enum with possible values of s3 and cloudwatch . LogDestinationType types.LogDestinationType - // The collection of exported log types. Possible values are connectionlog, - // useractivitylog, and userlog. + // The collection of exported log types. Possible values are connectionlog , + // useractivitylog , and userlog . LogExports []string // The prefix applied to the log file names. Constraints: - // - // * Cannot exceed 512 - // characters - // - // * Cannot contain spaces( ), double quotes ("), single quotes ('), a - // backslash (\), or control characters. The hexadecimal codes for invalid - // characters are: - // - // * x00 to x20 - // - // * x22 - // - // * x27 - // - // * x5c - // - // * x7f or larger + // - Cannot exceed 512 characters + // - Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash + // (\), or control characters. The hexadecimal codes for invalid characters are: + // - x00 to x20 + // - x22 + // - x27 + // - x5c + // - x7f or larger S3KeyPrefix *string noSmithyDocumentSerde @@ -91,11 +79,11 @@ type EnableLoggingOutput struct { // The last time that logs were delivered. LastSuccessfulDeliveryTime *time.Time - // The log destination type. An enum with possible values of s3 and cloudwatch. + // The log destination type. An enum with possible values of s3 and cloudwatch . LogDestinationType types.LogDestinationType - // The collection of exported log types. Possible values are connectionlog, - // useractivitylog, and userlog. + // The collection of exported log types. Possible values are connectionlog , + // useractivitylog , and userlog . LogExports []string // true if logging is on, false if logging is off. diff --git a/service/redshift/api_op_EnableSnapshotCopy.go b/service/redshift/api_op_EnableSnapshotCopy.go index ba12ee33850..53a897f3dec 100644 --- a/service/redshift/api_op_EnableSnapshotCopy.go +++ b/service/redshift/api_op_EnableSnapshotCopy.go @@ -30,18 +30,17 @@ func (c *Client) EnableSnapshotCopy(ctx context.Context, params *EnableSnapshotC type EnableSnapshotCopyInput struct { - // The unique identifier of the source cluster to copy snapshots from. Constraints: - // Must be the valid name of an existing cluster that does not already have - // cross-region snapshot copy enabled. + // The unique identifier of the source cluster to copy snapshots from. + // Constraints: Must be the valid name of an existing cluster that does not already + // have cross-region snapshot copy enabled. // // This member is required. ClusterIdentifier *string // The destination Amazon Web Services Region that you want to copy snapshots to. // Constraints: Must be the name of a valid Amazon Web Services Region. For more - // information, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region) in - // the Amazon Web Services General Reference. + // information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region) + // in the Amazon Web Services General Reference. // // This member is required. DestinationRegion *string @@ -52,9 +51,9 @@ type EnableSnapshotCopyInput struct { // value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 - // The number of days to retain automated snapshots in the destination region after - // they are copied from the source region. Default: 7. Constraints: Must be at - // least 1 and no more than 35. + // The number of days to retain automated snapshots in the destination region + // after they are copied from the source region. Default: 7. Constraints: Must be + // at least 1 and no more than 35. RetentionPeriod *int32 // The name of the snapshot copy grant to use when snapshots of an Amazon Web diff --git a/service/redshift/api_op_GetClusterCredentials.go b/service/redshift/api_op_GetClusterCredentials.go index f7cad264ee1..0d6c11f496f 100644 --- a/service/redshift/api_op_GetClusterCredentials.go +++ b/service/redshift/api_op_GetClusterCredentials.go @@ -11,27 +11,25 @@ import ( "time" ) -// Returns a database user name and temporary password with temporary authorization -// to log on to an Amazon Redshift database. The action returns the database user -// name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. -// You can optionally specify one or more database user groups that the user will -// join at log on. By default, the temporary credentials expire in 900 seconds. You -// can optionally specify a duration between 900 seconds (15 minutes) and 3600 -// seconds (60 minutes). For more information, see Using IAM Authentication to -// Generate Database User Credentials -// (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html) +// Returns a database user name and temporary password with temporary +// authorization to log on to an Amazon Redshift database. The action returns the +// database user name prefixed with IAM: if AutoCreate is False or IAMA: if +// AutoCreate is True . You can optionally specify one or more database user groups +// that the user will join at log on. By default, the temporary credentials expire +// in 900 seconds. You can optionally specify a duration between 900 seconds (15 +// minutes) and 3600 seconds (60 minutes). For more information, see Using IAM +// Authentication to Generate Database User Credentials (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html) // in the Amazon Redshift Cluster Management Guide. The Identity and Access // Management (IAM) user or role that runs GetClusterCredentials must have an IAM // policy attached that allows access to all necessary actions and resources. For // more information about permissions, see Resource Policies for -// GetClusterCredentials -// (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources) +// GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources) // in the Amazon Redshift Cluster Management Guide. If the DbGroups parameter is // specified, the IAM policy must allow the redshift:JoinGroup action with access -// to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, -// then the policy must include the redshift:CreateClusterUser permission. If the -// DbName parameter is specified, the IAM policy must allow access to the resource -// dbname for the specified database name. +// to the listed dbgroups . In addition, if the AutoCreate parameter is set to True +// , then the policy must include the redshift:CreateClusterUser permission. If +// the DbName parameter is specified, the IAM policy must allow access to the +// resource dbname for the specified database name. func (c *Client) GetClusterCredentials(ctx context.Context, params *GetClusterCredentialsInput, optFns ...func(*Options)) (*GetClusterCredentialsOutput, error) { if params == nil { params = &GetClusterCredentialsInput{} @@ -58,30 +56,21 @@ type GetClusterCredentialsInput struct { // The name of a database user. If a user name matching DbUser exists in the // database, the temporary user credentials have the same permissions as the - // existing user. If DbUser doesn't exist in the database and Autocreate is True, a - // new user is created using the value for DbUser with PUBLIC permissions. If a + // existing user. If DbUser doesn't exist in the database and Autocreate is True , + // a new user is created using the value for DbUser with PUBLIC permissions. If a // database user matching the value for DbUser doesn't exist and Autocreate is - // False, then the command succeeds but the connection attempt will fail because - // the user doesn't exist in the database. For more information, see CREATE USER - // (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) in the - // Amazon Redshift Database Developer Guide. Constraints: - // - // * Must be 1 to 64 - // alphanumeric characters or hyphens. The user name can't be PUBLIC. - // - // * Must - // contain uppercase or lowercase letters, numbers, underscore, plus sign, period - // (dot), at symbol (@), or hyphen. - // - // * First character must be a letter. - // - // * Must - // not contain a colon ( : ) or slash ( / ). - // - // * Cannot be a reserved word. A list - // of reserved words can be found in Reserved Words - // (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon - // Redshift Database Developer Guide. + // False , then the command succeeds but the connection attempt will fail because + // the user doesn't exist in the database. For more information, see CREATE USER (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) + // in the Amazon Redshift Database Developer Guide. Constraints: + // - Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be + // PUBLIC . + // - Must contain uppercase or lowercase letters, numbers, underscore, plus + // sign, period (dot), at symbol (@), or hyphen. + // - First character must be a letter. + // - Must not contain a colon ( : ) or slash ( / ). + // - Cannot be a reserved word. A list of reserved words can be found in + // Reserved Words (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. // // This member is required. DbUser *string @@ -94,47 +83,30 @@ type GetClusterCredentialsInput struct { // will join for the current session, in addition to any group memberships for an // existing user. If not specified, a new user is added only to PUBLIC. Database // group name constraints - // - // * Must be 1 to 64 alphanumeric characters or hyphens - // - // * - // Must contain only lowercase letters, numbers, underscore, plus sign, period - // (dot), at symbol (@), or hyphen. - // - // * First character must be a letter. - // - // * Must - // not contain a colon ( : ) or slash ( / ). - // - // * Cannot be a reserved word. A list - // of reserved words can be found in Reserved Words - // (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon - // Redshift Database Developer Guide. + // - Must be 1 to 64 alphanumeric characters or hyphens + // - Must contain only lowercase letters, numbers, underscore, plus sign, period + // (dot), at symbol (@), or hyphen. + // - First character must be a letter. + // - Must not contain a colon ( : ) or slash ( / ). + // - Cannot be a reserved word. A list of reserved words can be found in + // Reserved Words (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. DbGroups []string // The name of a database that DbUser is authorized to log on to. If DbName is not // specified, DbUser can log on to any existing database. Constraints: - // - // * Must be 1 - // to 64 alphanumeric characters or hyphens - // - // * Must contain uppercase or lowercase - // letters, numbers, underscore, plus sign, period (dot), at symbol (@), or - // hyphen. - // - // * First character must be a letter. - // - // * Must not contain a colon ( : ) - // or slash ( / ). - // - // * Cannot be a reserved word. A list of reserved words can be - // found in Reserved Words - // (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon - // Redshift Database Developer Guide. + // - Must be 1 to 64 alphanumeric characters or hyphens + // - Must contain uppercase or lowercase letters, numbers, underscore, plus + // sign, period (dot), at symbol (@), or hyphen. + // - First character must be a letter. + // - Must not contain a colon ( : ) or slash ( / ). + // - Cannot be a reserved word. A list of reserved words can be found in + // Reserved Words (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. DbName *string - // The number of seconds until the returned temporary password expires. Constraint: - // minimum 900, maximum 3600. Default: 900 + // The number of seconds until the returned temporary password expires. + // Constraint: minimum 900, maximum 3600. Default: 900 DurationSeconds *int32 noSmithyDocumentSerde @@ -145,13 +117,13 @@ type GetClusterCredentialsInput struct { type GetClusterCredentialsOutput struct { // A temporary password that authorizes the user name returned by DbUser to log on - // to the database DbName. + // to the database DbName . DbPassword *string // A database user name that is authorized to log on to the database DbName using - // the password DbPassword. If the specified DbUser exists in the database, the new - // user name has the same database permissions as the the user named in DbUser. By - // default, the user is added to PUBLIC. If the DbGroups parameter is specifed, + // the password DbPassword . If the specified DbUser exists in the database, the + // new user name has the same database permissions as the the user named in DbUser. + // By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, // DbUser is added to the listed groups for any sessions created using these // credentials. DbUser *string diff --git a/service/redshift/api_op_GetClusterCredentialsWithIAM.go b/service/redshift/api_op_GetClusterCredentialsWithIAM.go index 156f92c1b63..d7dfa553ee8 100644 --- a/service/redshift/api_op_GetClusterCredentialsWithIAM.go +++ b/service/redshift/api_op_GetClusterCredentialsWithIAM.go @@ -11,16 +11,15 @@ import ( "time" ) -// Returns a database user name and temporary password with temporary authorization -// to log in to an Amazon Redshift database. The database user is mapped 1:1 to the -// source Identity and Access Management (IAM) identity. For more information about -// IAM identities, see IAM Identities (users, user groups, and roles) -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html) in the Amazon Web -// Services Identity and Access Management User Guide. The Identity and Access +// Returns a database user name and temporary password with temporary +// authorization to log in to an Amazon Redshift database. The database user is +// mapped 1:1 to the source Identity and Access Management (IAM) identity. For more +// information about IAM identities, see IAM Identities (users, user groups, and +// roles) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html) in the Amazon +// Web Services Identity and Access Management User Guide. The Identity and Access // Management (IAM) identity that runs this operation must have an IAM policy // attached that allows access to all necessary actions and resources. For more -// information about permissions, see Using identity-based policies (IAM policies) -// (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) +// information about permissions, see Using identity-based policies (IAM policies) (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) GetClusterCredentialsWithIAM(ctx context.Context, params *GetClusterCredentialsWithIAMInput, optFns ...func(*Options)) (*GetClusterCredentialsWithIAMOutput, error) { if params == nil { diff --git a/service/redshift/api_op_GetReservedNodeExchangeConfigurationOptions.go b/service/redshift/api_op_GetReservedNodeExchangeConfigurationOptions.go index 7fff397ecd4..40e5f057837 100644 --- a/service/redshift/api_op_GetReservedNodeExchangeConfigurationOptions.go +++ b/service/redshift/api_op_GetReservedNodeExchangeConfigurationOptions.go @@ -45,9 +45,9 @@ type GetReservedNodeExchangeConfigurationOptionsInput struct { // An optional pagination token provided by a previous // GetReservedNodeExchangeConfigurationOptions request. If this parameter is // specified, the response includes only records beyond the marker, up to the value - // specified by the MaxRecords parameter. You can retrieve the next set of response - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // specified by the MaxRecords parameter. You can retrieve the next set of + // response records by providing the returned marker value in the Marker parameter + // and retrying the request. Marker *string // The maximum number of response records to return in each call. If the number of @@ -143,8 +143,8 @@ func (c *Client) addOperationGetReservedNodeExchangeConfigurationOptionsMiddlewa return nil } -// GetReservedNodeExchangeConfigurationOptionsAPIClient is a client that implements -// the GetReservedNodeExchangeConfigurationOptions operation. +// GetReservedNodeExchangeConfigurationOptionsAPIClient is a client that +// implements the GetReservedNodeExchangeConfigurationOptions operation. type GetReservedNodeExchangeConfigurationOptionsAPIClient interface { GetReservedNodeExchangeConfigurationOptions(context.Context, *GetReservedNodeExchangeConfigurationOptionsInput, ...func(*Options)) (*GetReservedNodeExchangeConfigurationOptionsOutput, error) } diff --git a/service/redshift/api_op_GetReservedNodeExchangeOfferings.go b/service/redshift/api_op_GetReservedNodeExchangeOfferings.go index 3cd8f46b818..f79083566ab 100644 --- a/service/redshift/api_op_GetReservedNodeExchangeOfferings.go +++ b/service/redshift/api_op_GetReservedNodeExchangeOfferings.go @@ -50,11 +50,11 @@ type GetReservedNodeExchangeOfferingsInput struct { type GetReservedNodeExchangeOfferingsOutput struct { // An optional parameter that specifies the starting point for returning a set of - // response records. When the results of a GetReservedNodeExchangeOfferings request - // exceed the value specified in MaxRecords, Amazon Redshift returns a value in the - // marker field of the response. You can retrieve the next set of response records - // by providing the returned marker value in the marker parameter and retrying the - // request. + // response records. When the results of a GetReservedNodeExchangeOfferings + // request exceed the value specified in MaxRecords, Amazon Redshift returns a + // value in the marker field of the response. You can retrieve the next set of + // response records by providing the returned marker value in the marker parameter + // and retrying the request. Marker *string // Returns an array of ReservedNodeOffering objects. diff --git a/service/redshift/api_op_ModifyAuthenticationProfile.go b/service/redshift/api_op_ModifyAuthenticationProfile.go index 419f59fd5e0..bf27b76c766 100644 --- a/service/redshift/api_op_ModifyAuthenticationProfile.go +++ b/service/redshift/api_op_ModifyAuthenticationProfile.go @@ -28,8 +28,8 @@ func (c *Client) ModifyAuthenticationProfile(ctx context.Context, params *Modify type ModifyAuthenticationProfileInput struct { - // The new content of the authentication profile in JSON format. The maximum length - // of the JSON string is determined by a quota for your account. + // The new content of the authentication profile in JSON format. The maximum + // length of the JSON string is determined by a quota for your account. // // This member is required. AuthenticationProfileContent *string diff --git a/service/redshift/api_op_ModifyCluster.go b/service/redshift/api_op_ModifyCluster.go index f05cba4523b..35c29593572 100644 --- a/service/redshift/api_op_ModifyCluster.go +++ b/service/redshift/api_op_ModifyCluster.go @@ -18,9 +18,8 @@ import ( // change the admin user password. Resetting a cluster password or modifying the // security groups associated with a cluster do not need a reboot. However, // modifying a parameter group requires a reboot for parameters to take effect. For -// more information about managing clusters, go to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) ModifyCluster(ctx context.Context, params *ModifyClusterInput, optFns ...func(*Options)) (*ModifyClusterOutput, error) { if params == nil { params = &ModifyClusterInput{} @@ -43,13 +42,13 @@ type ModifyClusterInput struct { // This member is required. ClusterIdentifier *string - // If true, major version upgrades will be applied automatically to the cluster + // If true , major version upgrades will be applied automatically to the cluster // during the maintenance window. Default: false AllowVersionUpgrade *bool // The number of days that automated snapshots are retained. If the value is 0, // automated snapshots are disabled. Even if automated snapshots are disabled, you - // can still create manual snapshots when you want with CreateClusterSnapshot. If + // can still create manual snapshots when you want with CreateClusterSnapshot . If // you decrease the automated snapshot retention period from its current value, // existing automated snapshots that fall outside of the new retention period will // be immediately deleted. You can't disable automated snapshots for RA3 node @@ -65,9 +64,9 @@ type ModifyClusterInput struct { // Availability Zones after the cluster modification is complete. AvailabilityZoneRelocation *bool - // The name of the cluster parameter group to apply to this cluster. This change is - // applied only after the cluster is rebooted. To reboot a cluster use - // RebootCluster. Default: Uses existing setting. Constraints: The cluster + // The name of the cluster parameter group to apply to this cluster. This change + // is applied only after the cluster is rebooted. To reboot a cluster use + // RebootCluster . Default: Uses existing setting. Constraints: The cluster // parameter group must be in the same parameter group family that matches the // cluster version. ClusterParameterGroupName *string @@ -76,22 +75,17 @@ type ModifyClusterInput struct { // is asynchronously applied as soon as possible. Security groups currently // associated with the cluster, and not in the list of groups to apply, will be // revoked from the cluster. Constraints: - // - // * Must be 1 to 255 alphanumeric - // characters or hyphens - // - // * First character must be a letter - // - // * Cannot end with a - // hyphen or contain two consecutive hyphens + // - Must be 1 to 255 alphanumeric characters or hyphens + // - First character must be a letter + // - Cannot end with a hyphen or contain two consecutive hyphens ClusterSecurityGroups []string - // The new cluster type. When you submit your cluster resize request, your existing - // cluster goes into a read-only mode. After Amazon Redshift provisions a new - // cluster based on your resize requirements, there will be outage for a period + // The new cluster type. When you submit your cluster resize request, your + // existing cluster goes into a read-only mode. After Amazon Redshift provisions a + // new cluster based on your resize requirements, there will be outage for a period // while the old cluster is deleted and your connection is switched to the new - // cluster. You can use DescribeResize to track the progress of the resize request. - // Valid Values: multi-node | single-node + // cluster. You can use DescribeResize to track the progress of the resize + // request. Valid Values: multi-node | single-node ClusterType *string // The new version number of the Amazon Redshift engine to upgrade to. For major @@ -99,31 +93,29 @@ type ModifyClusterInput struct { // a new cluster parameter group in the cluster parameter group family for the new // version must be specified. The new cluster parameter group can be the default // for that cluster parameter group family. For more information about parameters - // and parameter groups, go to Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. Example: 1.0 ClusterVersion *string // The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be // provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For // more information about provisioning clusters in EC2-VPC, go to Supported - // Platforms to Launch Your Cluster - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) + // Platforms to Launch Your Cluster (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) // in the Amazon Redshift Cluster Management Guide. ElasticIp *string - // Indicates whether the cluster is encrypted. If the value is encrypted (true) and - // you provide a value for the KmsKeyId parameter, we encrypt the cluster with the - // provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default - // key. If the value is not encrypted (false), then the cluster is decrypted. + // Indicates whether the cluster is encrypted. If the value is encrypted (true) + // and you provide a value for the KmsKeyId parameter, we encrypt the cluster with + // the provided KmsKeyId . If you don't provide a KmsKeyId , we encrypt with the + // default key. If the value is not encrypted (false), then the cluster is + // decrypted. Encrypted *bool - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -138,19 +130,19 @@ type ModifyClusterInput struct { // use to encrypt data in the cluster. KmsKeyId *string - // The name for the maintenance track that you want to assign for the cluster. This - // name change is asynchronous. The new track name stays in the + // The name for the maintenance track that you want to assign for the cluster. + // This name change is asynchronous. The new track name stays in the // PendingModifiedValues for the cluster until the next maintenance window. When // the maintenance track changes, the cluster is switched to the latest cluster // release available for the maintenance track. At this point, the maintenance // track name is applied. MaintenanceTrackName *string - // The default for number of days that a newly created manual snapshot is retained. - // If the value is -1, the manual snapshot is retained indefinitely. This value - // doesn't retroactively change the retention periods of existing manual snapshots. - // The value must be either -1 or an integer between 1 and 3,653. The default value - // is -1. + // The default for number of days that a newly created manual snapshot is + // retained. If the value is -1, the manual snapshot is retained indefinitely. This + // value doesn't retroactively change the retention periods of existing manual + // snapshots. The value must be either -1 or an integer between 1 and 3,653. The + // default value is -1. ManualSnapshotRetentionPeriod *int32 // The new password for the cluster admin user. This change is asynchronously @@ -160,55 +152,36 @@ type ModifyClusterInput struct { // the password, so this operation provides a way to regain access to the admin // user for a cluster if the password is lost. Default: Uses existing setting. // Constraints: - // - // * Must be between 8 and 64 characters in length. - // - // * Must contain - // at least one uppercase letter. - // - // * Must contain at least one lowercase letter. - // - // * - // Must contain one number. - // - // * Can be any printable ASCII character (ASCII code - // 33-126) except ' (single quote), " (double quote), \, /, or @. + // - Must be between 8 and 64 characters in length. + // - Must contain at least one uppercase letter. + // - Must contain at least one lowercase letter. + // - Must contain one number. + // - Can be any printable ASCII character (ASCII code 33-126) except ' (single + // quote), " (double quote), \ , / , or @ . MasterUserPassword *string // The new identifier for the cluster. Constraints: - // - // * Must contain from 1 to 63 - // alphanumeric characters or hyphens. - // - // * Alphabetic characters must be - // lowercase. - // - // * First character must be a letter. - // - // * Cannot end with a hyphen or - // contain two consecutive hyphens. - // - // * Must be unique for all clusters within an - // Amazon Web Services account. - // + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - Alphabetic characters must be lowercase. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique for all clusters within an Amazon Web Services account. // Example: examplecluster NewClusterIdentifier *string // The new node type of the cluster. If you specify a new node type, you must also // specify the number of nodes parameter. For more information about resizing - // clusters, go to Resizing Clusters in Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) in - // the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | + // clusters, go to Resizing Clusters in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) + // in the Amazon Redshift Cluster Management Guide. Valid Values: ds2.xlarge | // ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | // ra3.4xlarge | ra3.16xlarge NodeType *string // The new number of nodes of the cluster. If you specify a new number of nodes, // you must also specify the node type parameter. For more information about - // resizing clusters, go to Resizing Clusters in Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) in - // the Amazon Redshift Cluster Management Guide. Valid Values: Integer greater than - // 0. + // resizing clusters, go to Resizing Clusters in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html) + // in the Amazon Redshift Cluster Management Guide. Valid Values: Integer greater + // than 0 . NumberOfNodes *int32 // The option to change the port of an Amazon Redshift cluster. @@ -220,11 +193,11 @@ type ModifyClusterInput struct { // maintenance window indicates the current time, there must be at least 120 // minutes between the current time and end of the window in order to ensure that // pending changes are applied. Default: Uses existing setting. Format: - // ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00. Valid Days: Mon | Tue + // ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00 . Valid Days: Mon | Tue // | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. PreferredMaintenanceWindow *string - // If true, the cluster can be accessed from a public network. Only clusters in + // If true , the cluster can be accessed from a public network. Only clusters in // VPCs can be set to be publicly available. PubliclyAccessible *bool diff --git a/service/redshift/api_op_ModifyClusterIamRoles.go b/service/redshift/api_op_ModifyClusterIamRoles.go index df930afcef7..b9a11c51608 100644 --- a/service/redshift/api_op_ModifyClusterIamRoles.go +++ b/service/redshift/api_op_ModifyClusterIamRoles.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the list of Identity and Access Management (IAM) roles that can be used -// by the cluster to access other Amazon Web Services services. The maximum number -// of IAM roles that you can associate is subject to a quota. For more information, -// go to Quotas and limits -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Modifies the list of Identity and Access Management (IAM) roles that can be +// used by the cluster to access other Amazon Web Services services. The maximum +// number of IAM roles that you can associate is subject to a quota. For more +// information, go to Quotas and limits (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) ModifyClusterIamRoles(ctx context.Context, params *ModifyClusterIamRolesInput, optFns ...func(*Options)) (*ModifyClusterIamRolesOutput, error) { if params == nil { @@ -40,8 +39,8 @@ type ModifyClusterIamRolesInput struct { // This member is required. ClusterIdentifier *string - // Zero or more IAM roles to associate with the cluster. The roles must be in their - // Amazon Resource Name (ARN) format. + // Zero or more IAM roles to associate with the cluster. The roles must be in + // their Amazon Resource Name (ARN) format. AddIamRoles []string // The Amazon Resource Name (ARN) for the IAM role that was set as default for the diff --git a/service/redshift/api_op_ModifyClusterParameterGroup.go b/service/redshift/api_op_ModifyClusterParameterGroup.go index 8abb170affe..d8a39aa5a89 100644 --- a/service/redshift/api_op_ModifyClusterParameterGroup.go +++ b/service/redshift/api_op_ModifyClusterParameterGroup.go @@ -13,8 +13,7 @@ import ( // Modifies the parameters of a parameter group. For the parameters parameter, it // can't contain ASCII characters. For more information about parameters and -// parameter groups, go to Amazon Redshift Parameter Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) +// parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) ModifyClusterParameterGroup(ctx context.Context, params *ModifyClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyClusterParameterGroupOutput, error) { if params == nil { diff --git a/service/redshift/api_op_ModifyClusterSnapshotSchedule.go b/service/redshift/api_op_ModifyClusterSnapshotSchedule.go index 722b81eb6a2..065edf2c743 100644 --- a/service/redshift/api_op_ModifyClusterSnapshotSchedule.go +++ b/service/redshift/api_op_ModifyClusterSnapshotSchedule.go @@ -33,8 +33,8 @@ type ModifyClusterSnapshotScheduleInput struct { // This member is required. ClusterIdentifier *string - // A boolean to indicate whether to remove the assoiciation between the cluster and - // the schedule. + // A boolean to indicate whether to remove the assoiciation between the cluster + // and the schedule. DisassociateSchedule *bool // A unique alphanumeric identifier for the schedule that you want to associate diff --git a/service/redshift/api_op_ModifyEndpointAccess.go b/service/redshift/api_op_ModifyEndpointAccess.go index dde2f9bf41a..030b9b2191d 100644 --- a/service/redshift/api_op_ModifyEndpointAccess.go +++ b/service/redshift/api_op_ModifyEndpointAccess.go @@ -69,8 +69,8 @@ type ModifyEndpointAccessOutput struct { // The subnet group name where Amazon Redshift chooses to deploy the endpoint. SubnetGroupName *string - // The connection endpoint for connecting to an Amazon Redshift cluster through the - // proxy. + // The connection endpoint for connecting to an Amazon Redshift cluster through + // the proxy. VpcEndpoint *types.VpcEndpoint // The security groups associated with the endpoint. diff --git a/service/redshift/api_op_ModifyScheduledAction.go b/service/redshift/api_op_ModifyScheduledAction.go index 94f16a0886f..6c16b93f468 100644 --- a/service/redshift/api_op_ModifyScheduledAction.go +++ b/service/redshift/api_op_ModifyScheduledAction.go @@ -35,31 +35,31 @@ type ModifyScheduledActionInput struct { // This member is required. ScheduledActionName *string - // A modified enable flag of the scheduled action. If true, the scheduled action is - // active. If false, the scheduled action is disabled. + // A modified enable flag of the scheduled action. If true, the scheduled action + // is active. If false, the scheduled action is disabled. Enable *bool // A modified end time of the scheduled action. For more information about this - // parameter, see ScheduledAction. + // parameter, see ScheduledAction . EndTime *time.Time // A different IAM role to assume to run the target action. For more information - // about this parameter, see ScheduledAction. + // about this parameter, see ScheduledAction . IamRole *string // A modified schedule in either at( ) or cron( ) format. For more information - // about this parameter, see ScheduledAction. + // about this parameter, see ScheduledAction . Schedule *string // A modified description of the scheduled action. ScheduledActionDescription *string // A modified start time of the scheduled action. For more information about this - // parameter, see ScheduledAction. + // parameter, see ScheduledAction . StartTime *time.Time // A modified JSON format of the scheduled action. For more information about this - // parameter, see ScheduledAction. + // parameter, see ScheduledAction . TargetAction *types.ScheduledActionType noSmithyDocumentSerde @@ -67,7 +67,7 @@ type ModifyScheduledActionInput struct { // Describes a scheduled action. You can use a scheduled action to trigger some // Amazon Redshift API operations on a schedule. For information about which API -// operations can be scheduled, see ScheduledActionType. +// operations can be scheduled, see ScheduledActionType . type ModifyScheduledActionOutput struct { // The end time in UTC when the schedule is no longer active. After this time, the @@ -79,8 +79,7 @@ type ModifyScheduledActionOutput struct { // This IAM role must allow the Amazon Redshift scheduler (Principal // scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more // information about the IAM role to use with the Amazon Redshift scheduler, see - // Using Identity-Based Policies for Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) + // Using Identity-Based Policies for Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) // in the Amazon Redshift Cluster Management Guide. IamRole *string @@ -89,11 +88,10 @@ type ModifyScheduledActionOutput struct { // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of - // at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, - // "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours - // Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For - // more information, see Cron Expressions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) + // at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, " + // at(2016-03-04T17:27:00) ". Format of cron expressions is " cron(Minutes Hours + // Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ". + // For more information, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) // in the Amazon CloudWatch Events User Guide. Schedule *string @@ -107,11 +105,13 @@ type ModifyScheduledActionOutput struct { // scheduled action does not trigger. StartTime *time.Time - // The state of the scheduled action. For example, DISABLED. + // The state of the scheduled action. For example, DISABLED . State types.ScheduledActionState - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + // A JSON format string of the Amazon Redshift API operation with input + // parameters. " + // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} + // ". TargetAction *types.ScheduledActionType // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_ModifySnapshotSchedule.go b/service/redshift/api_op_ModifySnapshotSchedule.go index 09da2b4e4c9..f6ebb80c3d8 100644 --- a/service/redshift/api_op_ModifySnapshotSchedule.go +++ b/service/redshift/api_op_ModifySnapshotSchedule.go @@ -12,8 +12,8 @@ import ( "time" ) -// Modifies a snapshot schedule. Any schedule associated with a cluster is modified -// asynchronously. +// Modifies a snapshot schedule. Any schedule associated with a cluster is +// modified asynchronously. func (c *Client) ModifySnapshotSchedule(ctx context.Context, params *ModifySnapshotScheduleInput, optFns ...func(*Options)) (*ModifySnapshotScheduleOutput, error) { if params == nil { params = &ModifySnapshotScheduleInput{} diff --git a/service/redshift/api_op_ModifyUsageLimit.go b/service/redshift/api_op_ModifyUsageLimit.go index 54ad6057074..3c3ae69a7e5 100644 --- a/service/redshift/api_op_ModifyUsageLimit.go +++ b/service/redshift/api_op_ModifyUsageLimit.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies a usage limit in a cluster. You can't modify the feature type or period -// of a usage limit. +// Modifies a usage limit in a cluster. You can't modify the feature type or +// period of a usage limit. func (c *Client) ModifyUsageLimit(ctx context.Context, params *ModifyUsageLimitInput, optFns ...func(*Options)) (*ModifyUsageLimitOutput, error) { if params == nil { params = &ModifyUsageLimitInput{} @@ -35,11 +35,11 @@ type ModifyUsageLimitInput struct { // This member is required. UsageLimitId *string - // The new limit amount. For more information about this parameter, see UsageLimit. + // The new limit amount. For more information about this parameter, see UsageLimit . Amount *int64 // The new action that Amazon Redshift takes when the limit is reached. For more - // information about this parameter, see UsageLimit. + // information about this parameter, see UsageLimit . BreachAction types.UsageLimitBreachAction noSmithyDocumentSerde @@ -52,16 +52,11 @@ type ModifyUsageLimitOutput struct { // amount is in terabytes (TB). Amount int64 - // The action that Amazon Redshift takes when the limit is reached. Possible values - // are: - // - // * log - To log an event in a system table. The default is log. - // - // * - // emit-metric - To emit CloudWatch metrics. - // - // * disable - To disable the feature - // until the next usage period begins. + // The action that Amazon Redshift takes when the limit is reached. Possible + // values are: + // - log - To log an event in a system table. The default is log. + // - emit-metric - To emit CloudWatch metrics. + // - disable - To disable the feature until the next usage period begins. BreachAction types.UsageLimitBreachAction // The identifier of the cluster with a usage limit. @@ -75,7 +70,7 @@ type ModifyUsageLimitOutput struct { LimitType types.UsageLimitLimitType // The time period that the amount applies to. A weekly period begins on Sunday. - // The default is monthly. + // The default is monthly . Period types.UsageLimitPeriod // A list of tag instances. diff --git a/service/redshift/api_op_PurchaseReservedNodeOffering.go b/service/redshift/api_op_PurchaseReservedNodeOffering.go index 02d355ed92e..2336df0d217 100644 --- a/service/redshift/api_op_PurchaseReservedNodeOffering.go +++ b/service/redshift/api_op_PurchaseReservedNodeOffering.go @@ -16,8 +16,7 @@ import ( // can call the DescribeReservedNodeOfferings API to obtain the available reserved // node offerings. You can call this API by providing a specific reserved node // offering and the number of nodes you want to reserve. For more information about -// reserved node offerings, go to Purchasing Reserved Nodes -// (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) +// reserved node offerings, go to Purchasing Reserved Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) PurchaseReservedNodeOffering(ctx context.Context, params *PurchaseReservedNodeOfferingInput, optFns ...func(*Options)) (*PurchaseReservedNodeOfferingOutput, error) { if params == nil { @@ -49,8 +48,8 @@ type PurchaseReservedNodeOfferingInput struct { type PurchaseReservedNodeOfferingOutput struct { - // Describes a reserved node. You can call the DescribeReservedNodeOfferings API to - // obtain the available reserved node offerings. + // Describes a reserved node. You can call the DescribeReservedNodeOfferings API + // to obtain the available reserved node offerings. ReservedNode *types.ReservedNode // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_RebootCluster.go b/service/redshift/api_op_RebootCluster.go index 2e363f65d05..2b0933b2dbb 100644 --- a/service/redshift/api_op_RebootCluster.go +++ b/service/redshift/api_op_RebootCluster.go @@ -13,11 +13,10 @@ import ( // Reboots a cluster. This action is taken as soon as possible. It results in a // momentary outage to the cluster, during which the cluster status is set to -// rebooting. A cluster event is created when the reboot is completed. Any pending -// cluster modifications (see ModifyCluster) are applied at this reboot. For more -// information about managing clusters, go to Amazon Redshift Clusters -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in -// the Amazon Redshift Cluster Management Guide. +// rebooting . A cluster event is created when the reboot is completed. Any pending +// cluster modifications (see ModifyCluster ) are applied at this reboot. For more +// information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) +// in the Amazon Redshift Cluster Management Guide. func (c *Client) RebootCluster(ctx context.Context, params *RebootClusterInput, optFns ...func(*Options)) (*RebootClusterOutput, error) { if params == nil { params = &RebootClusterInput{} diff --git a/service/redshift/api_op_ResetClusterParameterGroup.go b/service/redshift/api_op_ResetClusterParameterGroup.go index ec8e0766d6d..9fa5fac43d0 100644 --- a/service/redshift/api_op_ResetClusterParameterGroup.go +++ b/service/redshift/api_op_ResetClusterParameterGroup.go @@ -37,12 +37,12 @@ type ResetClusterParameterGroupInput struct { // This member is required. ParameterGroupName *string - // An array of names of parameters to be reset. If ResetAllParameters option is not - // used, then at least one parameter name must be supplied. Constraints: A maximum - // of 20 parameters can be reset in a single request. + // An array of names of parameters to be reset. If ResetAllParameters option is + // not used, then at least one parameter name must be supplied. Constraints: A + // maximum of 20 parameters can be reset in a single request. Parameters []types.Parameter - // If true, all parameters in the specified parameter group will be reset to their + // If true , all parameters in the specified parameter group will be reset to their // default values. Default: true ResetAllParameters bool diff --git a/service/redshift/api_op_ResizeCluster.go b/service/redshift/api_op_ResizeCluster.go index bbb7a131cd3..a9913da8608 100644 --- a/service/redshift/api_op_ResizeCluster.go +++ b/service/redshift/api_op_ResizeCluster.go @@ -16,32 +16,17 @@ import ( // method. With an elastic resize, your cluster is available for read and write // operations more quickly than with the classic resize method. Elastic resize // operations have the following restrictions: -// -// * You can only resize clusters of -// the following types: -// -// * dc1.large (if your cluster is in a VPC) -// -// * dc1.8xlarge -// (if your cluster is in a VPC) -// -// * dc2.large -// -// * dc2.8xlarge -// -// * ds2.xlarge -// -// * -// ds2.8xlarge -// -// * ra3.xlplus -// -// * ra3.4xlarge -// -// * ra3.16xlarge -// -// * The type of nodes -// that you add must match the node type for the cluster. +// - You can only resize clusters of the following types: +// - dc1.large (if your cluster is in a VPC) +// - dc1.8xlarge (if your cluster is in a VPC) +// - dc2.large +// - dc2.8xlarge +// - ds2.xlarge +// - ds2.8xlarge +// - ra3.xlplus +// - ra3.4xlarge +// - ra3.16xlarge +// - The type of nodes that you add must match the node type for the cluster. func (c *Client) ResizeCluster(ctx context.Context, params *ResizeClusterInput, optFns ...func(*Options)) (*ResizeClusterOutput, error) { if params == nil { params = &ResizeClusterInput{} @@ -57,8 +42,8 @@ func (c *Client) ResizeCluster(ctx context.Context, params *ResizeClusterInput, return out, nil } -// Describes a resize cluster operation. For example, a scheduled action to run the -// ResizeCluster API operation. +// Describes a resize cluster operation. For example, a scheduled action to run +// the ResizeCluster API operation. type ResizeClusterInput struct { // The unique identifier for the cluster to resize. @@ -67,7 +52,7 @@ type ResizeClusterInput struct { ClusterIdentifier *string // A boolean value indicating whether the resize operation is using the classic - // resize process. If you don't provide this parameter or set the value to false, + // resize process. If you don't provide this parameter or set the value to false , // the resize type is elastic. Classic *bool @@ -78,8 +63,8 @@ type ResizeClusterInput struct { // current node type is used. NodeType *string - // The new number of nodes for the cluster. If not specified, the cluster's current - // number of nodes is used. + // The new number of nodes for the cluster. If not specified, the cluster's + // current number of nodes is used. NumberOfNodes *int32 // The identifier of the reserved node. diff --git a/service/redshift/api_op_RestoreFromClusterSnapshot.go b/service/redshift/api_op_RestoreFromClusterSnapshot.go index d9a16d20bf5..ebf390a8fe3 100644 --- a/service/redshift/api_op_RestoreFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreFromClusterSnapshot.go @@ -20,8 +20,7 @@ import ( // a DS node type, you can also choose to change to another DS node type of the // same size during restore. If you restore a cluster into a VPC, you must provide // a cluster subnet group where you want the cluster restored. For more information -// about working with snapshots, go to Amazon Redshift Snapshots -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) +// about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) RestoreFromClusterSnapshot(ctx context.Context, params *RestoreFromClusterSnapshotInput, optFns ...func(*Options)) (*RestoreFromClusterSnapshotOutput, error) { if params == nil { @@ -42,19 +41,11 @@ type RestoreFromClusterSnapshotInput struct { // The identifier of the cluster that will be created from restoring the snapshot. // Constraints: - // - // * Must contain from 1 to 63 alphanumeric characters or hyphens. - // - // * - // Alphabetic characters must be lowercase. - // - // * First character must be a letter. - // - // * - // Cannot end with a hyphen or contain two consecutive hyphens. - // - // * Must be unique - // for all clusters within an Amazon Web Services account. + // - Must contain from 1 to 63 alphanumeric characters or hyphens. + // - Alphabetic characters must be lowercase. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. + // - Must be unique for all clusters within an Amazon Web Services account. // // This member is required. ClusterIdentifier *string @@ -62,18 +53,18 @@ type RestoreFromClusterSnapshotInput struct { // Reserved. AdditionalInfo *string - // If true, major version upgrades can be applied during the maintenance window to + // If true , major version upgrades can be applied during the maintenance window to // the Amazon Redshift engine that is running on the cluster. Default: true AllowVersionUpgrade *bool - // This parameter is retired. It does not set the AQUA configuration status. Amazon - // Redshift automatically determines whether to use AQUA (Advanced Query + // This parameter is retired. It does not set the AQUA configuration status. + // Amazon Redshift automatically determines whether to use AQUA (Advanced Query // Accelerator). AquaConfigurationStatus types.AquaConfigurationStatus // The number of days that automated snapshots are retained. If the value is 0, // automated snapshots are disabled. Even if automated snapshots are disabled, you - // can still create manual snapshots when you want with CreateClusterSnapshot. You + // can still create manual snapshots when you want with CreateClusterSnapshot . You // can't disable automated snapshots for RA3 node types. Set the automated // retention period from 1-35 days. Default: The value selected for the cluster // from which the snapshot was taken. Constraints: Must be a value from 0 to 35. @@ -87,19 +78,13 @@ type RestoreFromClusterSnapshotInput struct { // Availability Zones after the cluster is restored. AvailabilityZoneRelocation *bool - // The name of the parameter group to be associated with this cluster. Default: The - // default Amazon Redshift cluster parameter group. For information about the - // default parameter group, go to Working with Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html). - // Constraints: - // - // * Must be 1 to 255 alphanumeric characters or hyphens. - // - // * First - // character must be a letter. - // - // * Cannot end with a hyphen or contain two - // consecutive hyphens. + // The name of the parameter group to be associated with this cluster. Default: + // The default Amazon Redshift cluster parameter group. For information about the + // default parameter group, go to Working with Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // . Constraints: + // - Must be 1 to 255 alphanumeric characters or hyphens. + // - First character must be a letter. + // - Cannot end with a hyphen or contain two consecutive hyphens. ClusterParameterGroupName *string // A list of security groups to be associated with this cluster. Default: The @@ -126,12 +111,11 @@ type RestoreFromClusterSnapshotInput struct { // with Key Management Service (KMS) and a customer managed key. Encrypted *bool - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -146,25 +130,25 @@ type RestoreFromClusterSnapshotInput struct { // cluster to access other Amazon Web Services services. You must supply the IAM // roles in their Amazon Resource Name (ARN) format. The maximum number of IAM // roles that you can associate is subject to a quota. For more information, go to - // Quotas and limits - // (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) + // Quotas and limits (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. IamRoles []string - // The Key Management Service (KMS) key ID of the encryption key that encrypts data - // in the cluster restored from a shared snapshot. You can also provide the key ID - // when you restore from an unencrypted snapshot to an encrypted cluster in the - // same account. Additionally, you can specify a new KMS key ID when you restore - // from an encrypted snapshot in the same account in order to change it. In that - // case, the restored cluster is encrypted with the new KMS key ID. + // The Key Management Service (KMS) key ID of the encryption key that encrypts + // data in the cluster restored from a shared snapshot. You can also provide the + // key ID when you restore from an unencrypted snapshot to an encrypted cluster in + // the same account. Additionally, you can specify a new KMS key ID when you + // restore from an encrypted snapshot in the same account in order to change it. In + // that case, the restored cluster is encrypted with the new KMS key ID. KmsKeyId *string // The name of the maintenance track for the restored cluster. When you take a - // snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The - // snapshot might be on a different track than the cluster that was the source for - // the snapshot. For example, suppose that you take a snapshot of a cluster that is - // on the current track and then change the cluster to be on the trailing track. In - // this case, the snapshot and the source cluster are on different tracks. + // snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. + // The snapshot might be on a different track than the cluster that was the source + // for the snapshot. For example, suppose that you take a snapshot of a cluster + // that is on the current track and then change the cluster to be on the trailing + // track. In this case, the snapshot and the source cluster are on different + // tracks. MaintenanceTrackName *string // The default number of days to retain a manual snapshot. If the value is -1, the @@ -182,39 +166,38 @@ type RestoreFromClusterSnapshotInput struct { // only restore a dc1.large instance type into another dc1.large instance type or // dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First // restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more - // information about node types, see About Clusters and Nodes - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes) + // information about node types, see About Clusters and Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes) // in the Amazon Redshift Cluster Management Guide. NodeType *string // The number of nodes specified when provisioning the restored cluster. NumberOfNodes *int32 - // The Amazon Web Services account used to create or copy the snapshot. Required if - // you are restoring a snapshot you do not own, optional if you own the snapshot. + // The Amazon Web Services account used to create or copy the snapshot. Required + // if you are restoring a snapshot you do not own, optional if you own the + // snapshot. OwnerAccount *string - // The port number on which the cluster accepts connections. Default: The same port - // as the original cluster. Constraints: Must be between 1115 and 65535. + // The port number on which the cluster accepts connections. Default: The same + // port as the original cluster. Constraints: Must be between 1115 and 65535 . Port *int32 // The weekly time range (in UTC) during which automated cluster maintenance can // occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the // cluster from which the snapshot was taken. For more information about the time - // blocks for each region, see Maintenance Windows - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) + // blocks for each region, see Maintenance Windows (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | // Fri | Sat | Sun Constraints: Minimum 30-minute window. PreferredMaintenanceWindow *string - // If true, the cluster can be accessed from a public network. + // If true , the cluster can be accessed from a public network. PubliclyAccessible *bool // The identifier of the target reserved node offering. ReservedNodeId *string // The Amazon Resource Name (ARN) of the snapshot associated with the message to - // restore from a cluster. You must specify this parameter or snapshotIdentifier, + // restore from a cluster. You must specify this parameter or snapshotIdentifier , // but not both. SnapshotArn *string @@ -224,7 +207,7 @@ type RestoreFromClusterSnapshotInput struct { SnapshotClusterIdentifier *string // The name of the snapshot from which to create the new cluster. This parameter - // isn't case sensitive. You must specify this parameter or snapshotArn, but not + // isn't case sensitive. You must specify this parameter or snapshotArn , but not // both. Example: my-snapshot-id SnapshotIdentifier *string diff --git a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go index 55c387d06bb..21637134094 100644 --- a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go @@ -18,12 +18,12 @@ import ( // That is, you cannot overwrite an existing table in a cluster with a restored // table. If you want to replace your original table with a new, restored table, // then rename or drop your original table before you call -// RestoreTableFromClusterSnapshot. When you have renamed your original table, then -// you can pass the original name of the table as the NewTableName parameter value -// in the call to RestoreTableFromClusterSnapshot. This way, you can replace the -// original table with the table created from the snapshot. You can't use this -// operation to restore tables with interleaved sort keys -// (https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved). +// RestoreTableFromClusterSnapshot . When you have renamed your original table, +// then you can pass the original name of the table as the NewTableName parameter +// value in the call to RestoreTableFromClusterSnapshot . This way, you can replace +// the original table with the table created from the snapshot. You can't use this +// operation to restore tables with interleaved sort keys (https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved) +// . func (c *Client) RestoreTableFromClusterSnapshot(ctx context.Context, params *RestoreTableFromClusterSnapshotInput, optFns ...func(*Options)) (*RestoreTableFromClusterSnapshotOutput, error) { if params == nil { params = &RestoreTableFromClusterSnapshotInput{} @@ -69,12 +69,12 @@ type RestoreTableFromClusterSnapshotInput struct { SourceTableName *string // Indicates whether name identifiers for database, schema, and table are case - // sensitive. If true, the names are case sensitive. If false (default), the names - // are not case sensitive. + // sensitive. If true , the names are case sensitive. If false (default), the + // names are not case sensitive. EnableCaseSensitiveIdentifier *bool - // The name of the source schema that contains the table to restore from. If you do - // not specify a SourceSchemaName value, the default is public. + // The name of the source schema that contains the table to restore from. If you + // do not specify a SourceSchemaName value, the default is public . SourceSchemaName *string // The name of the database to restore the table to. diff --git a/service/redshift/api_op_ResumeCluster.go b/service/redshift/api_op_ResumeCluster.go index 9866208c6fd..dc1a74df0a2 100644 --- a/service/redshift/api_op_ResumeCluster.go +++ b/service/redshift/api_op_ResumeCluster.go @@ -27,8 +27,8 @@ func (c *Client) ResumeCluster(ctx context.Context, params *ResumeClusterInput, return out, nil } -// Describes a resume cluster operation. For example, a scheduled action to run the -// ResumeCluster API operation. +// Describes a resume cluster operation. For example, a scheduled action to run +// the ResumeCluster API operation. type ResumeClusterInput struct { // The identifier of the cluster to be resumed. diff --git a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go index 575b247fd38..9aed5bf6faa 100644 --- a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go +++ b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go @@ -13,9 +13,8 @@ import ( // Revokes an ingress rule in an Amazon Redshift security group for a previously // authorized IP range or Amazon EC2 security group. To add an ingress rule, see -// AuthorizeClusterSecurityGroupIngress. For information about managing security -// groups, go to Amazon Redshift Cluster Security Groups -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) +// AuthorizeClusterSecurityGroupIngress . For information about managing security +// groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) RevokeClusterSecurityGroupIngress(ctx context.Context, params *RevokeClusterSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeClusterSecurityGroupIngressOutput, error) { if params == nil { @@ -45,8 +44,8 @@ type RevokeClusterSecurityGroupIngressInput struct { CIDRIP *string // The name of the EC2 Security Group whose access is to be revoked. If - // EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided - // and CIDRIP cannot be provided. + // EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be + // provided and CIDRIP cannot be provided. EC2SecurityGroupName *string // The Amazon Web Services account number of the owner of the security group diff --git a/service/redshift/api_op_RevokeSnapshotAccess.go b/service/redshift/api_op_RevokeSnapshotAccess.go index f9ffbed4dff..3a90a4bb3cf 100644 --- a/service/redshift/api_op_RevokeSnapshotAccess.go +++ b/service/redshift/api_op_RevokeSnapshotAccess.go @@ -14,8 +14,7 @@ import ( // Removes the ability of the specified Amazon Web Services account to restore the // specified snapshot. If the account is currently restoring the snapshot, the // restore will run to completion. For more information about working with -// snapshots, go to Amazon Redshift Snapshots -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) +// snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) // in the Amazon Redshift Cluster Management Guide. func (c *Client) RevokeSnapshotAccess(ctx context.Context, params *RevokeSnapshotAccessInput, optFns ...func(*Options)) (*RevokeSnapshotAccessOutput, error) { if params == nil { @@ -34,8 +33,8 @@ func (c *Client) RevokeSnapshotAccess(ctx context.Context, params *RevokeSnapsho type RevokeSnapshotAccessInput struct { - // The identifier of the Amazon Web Services account that can no longer restore the - // specified snapshot. + // The identifier of the Amazon Web Services account that can no longer restore + // the specified snapshot. // // This member is required. AccountWithRestoreAccess *string diff --git a/service/redshift/api_op_RotateEncryptionKey.go b/service/redshift/api_op_RotateEncryptionKey.go index 7243ce7d240..2d4d1dd55e7 100644 --- a/service/redshift/api_op_RotateEncryptionKey.go +++ b/service/redshift/api_op_RotateEncryptionKey.go @@ -29,8 +29,9 @@ func (c *Client) RotateEncryptionKey(ctx context.Context, params *RotateEncrypti type RotateEncryptionKeyInput struct { - // The unique identifier of the cluster that you want to rotate the encryption keys - // for. Constraints: Must be the name of valid cluster that has encryption enabled. + // The unique identifier of the cluster that you want to rotate the encryption + // keys for. Constraints: Must be the name of valid cluster that has encryption + // enabled. // // This member is required. ClusterIdentifier *string diff --git a/service/redshift/doc.go b/service/redshift/doc.go index b511b6cbee4..4ccb74f0423 100644 --- a/service/redshift/doc.go +++ b/service/redshift/doc.go @@ -11,17 +11,14 @@ // applied. In this reference, the parameter descriptions indicate whether a change // is applied immediately, on the next instance reboot, or during the next // maintenance window. For a summary of the Amazon Redshift cluster management -// interfaces, go to Using the Amazon Redshift Management Interfaces -// (https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html). Amazon -// Redshift manages all the work of setting up, operating, and scaling a data -// warehouse: provisioning capacity, monitoring and backing up the cluster, and -// applying patches and upgrades to the Amazon Redshift engine. You can focus on -// using your data to acquire new insights for your business and customers. If you -// are a first-time user of Amazon Redshift, we recommend that you begin by reading -// the Amazon Redshift Getting Started Guide -// (https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html). If you -// are a database developer, the Amazon Redshift Database Developer Guide -// (https://docs.aws.amazon.com/redshift/latest/dg/welcome.html) explains how to -// design, build, query, and maintain the databases that make up your data -// warehouse. +// interfaces, go to Using the Amazon Redshift Management Interfaces (https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html) +// . Amazon Redshift manages all the work of setting up, operating, and scaling a +// data warehouse: provisioning capacity, monitoring and backing up the cluster, +// and applying patches and upgrades to the Amazon Redshift engine. You can focus +// on using your data to acquire new insights for your business and customers. If +// you are a first-time user of Amazon Redshift, we recommend that you begin by +// reading the Amazon Redshift Getting Started Guide (https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html) +// . If you are a database developer, the Amazon Redshift Database Developer Guide (https://docs.aws.amazon.com/redshift/latest/dg/welcome.html) +// explains how to design, build, query, and maintain the databases that make up +// your data warehouse. package redshift diff --git a/service/redshift/types/enums.go b/service/redshift/types/enums.go index aef65627c0c..81aaca5648c 100644 --- a/service/redshift/types/enums.go +++ b/service/redshift/types/enums.go @@ -220,9 +220,9 @@ const ( OperatorTypeBetween OperatorType = "between" ) -// Values returns all known values for OperatorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OperatorType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OperatorType) Values() []OperatorType { return []OperatorType{ "eq", @@ -263,9 +263,9 @@ const ( PartnerIntegrationStatusConnectionFailure PartnerIntegrationStatus = "ConnectionFailure" ) -// Values returns all known values for PartnerIntegrationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PartnerIntegrationStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PartnerIntegrationStatus) Values() []PartnerIntegrationStatus { return []PartnerIntegrationStatus{ "Active", @@ -329,9 +329,9 @@ const ( ReservedNodeOfferingTypeUpgradable ReservedNodeOfferingType = "Upgradable" ) -// Values returns all known values for ReservedNodeOfferingType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReservedNodeOfferingType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservedNodeOfferingType) Values() []ReservedNodeOfferingType { return []ReservedNodeOfferingType{ "Regular", @@ -530,8 +530,8 @@ const ( UsageLimitFeatureTypeCrossRegionDatasharing UsageLimitFeatureType = "cross-region-datasharing" ) -// Values returns all known values for UsageLimitFeatureType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for UsageLimitFeatureType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitFeatureType) Values() []UsageLimitFeatureType { return []UsageLimitFeatureType{ diff --git a/service/redshift/types/errors.go b/service/redshift/types/errors.go index 4a3c6e364a3..72a1cb365eb 100644 --- a/service/redshift/types/errors.go +++ b/service/redshift/types/errors.go @@ -445,8 +445,7 @@ func (e *ClusterParameterGroupNotFoundFault) ErrorFault() smithy.ErrorFault { // The request would result in the user exceeding the allowed number of cluster // parameter groups. For information about increasing your quota, go to Limits in -// Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ClusterParameterGroupQuotaExceededFault struct { Message *string @@ -477,8 +476,7 @@ func (e *ClusterParameterGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault // The request would exceed the allowed number of cluster instances for this // account. For information about increasing your quota, go to Limits in Amazon -// Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ClusterQuotaExceededFault struct { Message *string @@ -562,8 +560,7 @@ func (e *ClusterSecurityGroupNotFoundFault) ErrorFault() smithy.ErrorFault { ret // The request would result in the user exceeding the allowed number of cluster // security groups. For information about increasing your quota, go to Limits in -// Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ClusterSecurityGroupQuotaExceededFault struct { Message *string @@ -729,8 +726,7 @@ func (e *ClusterSubnetGroupNotFoundFault) ErrorFault() smithy.ErrorFault { retur // The request would result in user exceeding the allowed number of cluster subnet // groups. For information about increasing your quota, go to Limits in Amazon -// Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ClusterSubnetGroupQuotaExceededFault struct { Message *string @@ -760,9 +756,8 @@ func (e *ClusterSubnetGroupQuotaExceededFault) ErrorFault() smithy.ErrorFault { } // The request would result in user exceeding the allowed number of subnets in a -// cluster subnet groups. For information about increasing your quota, go to Limits -// in Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// cluster subnet groups. For information about increasing your quota, go to +// Limits in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ClusterSubnetQuotaExceededFault struct { Message *string @@ -1067,8 +1062,7 @@ func (e *EndpointsPerClusterLimitExceededFault) ErrorFault() smithy.ErrorFault { // The request would exceed the allowed number of event subscriptions for this // account. For information about increasing your quota, go to Limits in Amazon -// Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type EventSubscriptionQuotaExceededFault struct { Message *string @@ -1154,8 +1148,7 @@ func (e *HsmClientCertificateNotFoundFault) ErrorCode() string { func (e *HsmClientCertificateNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The quota for HSM client certificates has been reached. For information about -// increasing your quota, go to Limits in Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// increasing your quota, go to Limits in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type HsmClientCertificateQuotaExceededFault struct { Message *string @@ -1240,8 +1233,7 @@ func (e *HsmConfigurationNotFoundFault) ErrorCode() string { func (e *HsmConfigurationNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The quota for HSM configurations has been reached. For information about -// increasing your quota, go to Limits in Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// increasing your quota, go to Limits in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type HsmConfigurationQuotaExceededFault struct { Message *string @@ -1351,8 +1343,8 @@ func (e *InsufficientClusterCapacityFault) ErrorCode() string { } func (e *InsufficientClusterCapacityFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The cluster does not have read bucket or put object permissions on the S3 bucket -// specified when enabling logging. +// The cluster does not have read bucket or put object permissions on the S3 +// bucket specified when enabling logging. type InsufficientS3BucketPolicyFault struct { Message *string @@ -1464,7 +1456,7 @@ func (e *InvalidClusterParameterGroupStateFault) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// The state of the cluster security group is not available. +// The state of the cluster security group is not available . type InvalidClusterSecurityGroupStateFault struct { Message *string @@ -1760,8 +1752,8 @@ func (e *InvalidHsmClientCertificateStateFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified HSM configuration is not in the available state, or it is still in -// use by one or more Amazon Redshift clusters. +// The specified HSM configuration is not in the available state, or it is still +// in use by one or more Amazon Redshift clusters. type InvalidHsmConfigurationStateFault struct { Message *string @@ -1894,9 +1886,8 @@ func (e *InvalidRetentionPeriodFault) ErrorCode() string { func (e *InvalidRetentionPeriodFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The S3 bucket name is invalid. For more information about naming rules, go to -// Bucket Restrictions and Limitations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) in the -// Amazon Simple Storage Service (S3) Developer Guide. +// Bucket Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) +// in the Amazon Simple Storage Service (S3) Developer Guide. type InvalidS3BucketNameFault struct { Message *string @@ -2084,7 +2075,7 @@ func (e *InvalidSubscriptionStateFault) ErrorCode() string { } func (e *InvalidSubscriptionStateFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The value specified for the sourceDatabaseName, sourceSchemaName, or +// The value specified for the sourceDatabaseName , sourceSchemaName , or // sourceTableName parameter, or a combination of these, doesn't exist in the // snapshot. type InvalidTableRestoreArgumentFault struct { @@ -2245,8 +2236,7 @@ func (e *NumberOfNodesPerClusterLimitExceededFault) ErrorFault() smithy.ErrorFau } // The operation would exceed the number of nodes allotted to the account. For -// information about increasing your quota, go to Limits in Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// information about increasing your quota, go to Limits in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type NumberOfNodesQuotaExceededFault struct { Message *string @@ -2430,8 +2420,7 @@ func (e *ReservedNodeOfferingNotFoundFault) ErrorCode() string { func (e *ReservedNodeOfferingNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Request would exceed the user's compute node quota. For information about -// increasing your quota, go to Limits in Amazon Redshift -// (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) +// increasing your quota, go to Limits in Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html) // in the Amazon Redshift Cluster Management Guide. type ReservedNodeQuotaExceededFault struct { Message *string @@ -2778,8 +2767,8 @@ func (e *SnapshotCopyGrantNotFoundFault) ErrorCode() string { } func (e *SnapshotCopyGrantNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Amazon Web Services account has exceeded the maximum number of snapshot copy -// grants in this region. +// The Amazon Web Services account has exceeded the maximum number of snapshot +// copy grants in this region. type SnapshotCopyGrantQuotaExceededFault struct { Message *string @@ -3076,8 +3065,8 @@ func (e *SubscriptionAlreadyExistFault) ErrorCode() string { } func (e *SubscriptionAlreadyExistFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The value specified for the event category was not one of the allowed values, or -// it specified a category that does not apply to the specified source type. The +// The value specified for the event category was not one of the allowed values, +// or it specified a category that does not apply to the specified source type. The // allowed values are Configuration, Management, Monitoring, and Security. type SubscriptionCategoryNotFoundFault struct { Message *string @@ -3157,8 +3146,8 @@ func (e *SubscriptionNotFoundFault) ErrorCode() string { } func (e *SubscriptionNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The value specified for the event severity was not one of the allowed values, or -// it specified a severity that does not apply to the specified source type. The +// The value specified for the event severity was not one of the allowed values, +// or it specified a severity that does not apply to the specified source type. The // allowed values are ERROR and INFO. type SubscriptionSeverityNotFoundFault struct { Message *string diff --git a/service/redshift/types/types.go b/service/redshift/types/types.go index 3fe5394a29b..a2443a7f718 100644 --- a/service/redshift/types/types.go +++ b/service/redshift/types/types.go @@ -22,9 +22,9 @@ type AccountAttribute struct { // Describes an Amazon Web Services account authorized to restore a snapshot. type AccountWithRestoreAccess struct { - // The identifier of an Amazon Web Services support account authorized to restore a - // snapshot. For Amazon Web Services Support, the identifier is - // amazon-redshift-support. + // The identifier of an Amazon Web Services support account authorized to restore + // a snapshot. For Amazon Web Services Support, the identifier is + // amazon-redshift-support . AccountAlias *string // The identifier of an Amazon Web Services account authorized to restore a @@ -34,8 +34,8 @@ type AccountWithRestoreAccess struct { noSmithyDocumentSerde } -// The operation that uses this structure is retired. Amazon Redshift automatically -// determines whether to use AQUA (Advanced Query Accelerator). +// The operation that uses this structure is retired. Amazon Redshift +// automatically determines whether to use AQUA (Advanced Query Accelerator). type AquaConfiguration struct { // This field is retired. Amazon Redshift automatically determines whether to use @@ -86,7 +86,7 @@ type AvailabilityZone struct { // Describes a cluster. type Cluster struct { - // A boolean value that, if true, indicates that major version upgrades will be + // A boolean value that, if true , indicates that major version upgrades will be // applied automatically to the cluster during the maintenance window. AllowVersionUpgrade bool @@ -105,20 +105,13 @@ type Cluster struct { // 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. + // - 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 // The date and time that the cluster was created. @@ -133,8 +126,8 @@ type Cluster struct { // The nodes in the cluster. ClusterNodes []ClusterNode - // The list of cluster parameter groups that are associated with this cluster. Each - // parameter group in the list is returned with its status. + // The list of cluster parameter groups that are associated with this cluster. + // Each parameter group in the list is returned with its status. ClusterParameterGroups []ClusterParameterGroupStatus // The public key for the cluster. @@ -156,56 +149,30 @@ type Cluster struct { ClusterSnapshotCopyStatus *ClusterSnapshotCopyStatus // The current state of the cluster. Possible values are the following: - // - // * - // available - // - // * available, prep-for-resize - // - // * available, resize-cleanup - // - // * - // cancelling-resize - // - // * creating - // - // * deleting - // - // * final-snapshot - // - // * - // hardware-failure - // - // * incompatible-hsm - // - // * incompatible-network - // - // * - // incompatible-parameters - // - // * incompatible-restore - // - // * modifying - // - // * paused - // - // * - // rebooting - // - // * renaming - // - // * resizing - // - // * rotating-keys - // - // * storage-full - // - // * - // updating-hsm + // - available + // - available, prep-for-resize + // - available, resize-cleanup + // - cancelling-resize + // - creating + // - deleting + // - final-snapshot + // - hardware-failure + // - incompatible-hsm + // - incompatible-network + // - incompatible-parameters + // - incompatible-restore + // - modifying + // - paused + // - rebooting + // - renaming + // - resizing + // - rotating-keys + // - storage-full + // - updating-hsm ClusterStatus *string - // The name of the subnet group that is associated with the cluster. This parameter - // is valid only when the cluster is in a VPC. + // The name of the subnet group that is associated with the cluster. This + // parameter is valid only when the cluster is in a VPC. ClusterSubnetGroupName *string // The version ID of the Amazon Redshift engine that is running on the cluster. @@ -213,7 +180,7 @@ type Cluster struct { // The name of the initial database that was created when the cluster was created. // This same name is returned for the life of the cluster. If an initial database - // was not specified, a database named devdev was created by default. + // was not specified, a database named dev dev was created by default. DBName *string // @@ -232,19 +199,18 @@ type Cluster struct { // method. ElasticResizeNumberOfNodeOptions *string - // A boolean value that, if true, indicates that data in the cluster is encrypted + // A boolean value that, if true , indicates that data in the cluster is encrypted // at rest. Encrypted bool // The connection endpoint. Endpoint *Endpoint - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting bool // The date and time when the next snapshot is expected to be taken for clusters @@ -253,12 +219,8 @@ type Cluster struct { // The status of next expected snapshot for clusters having a valid snapshot // schedule and backups enabled. Possible values are the following: - // - // * OnTrack - - // The next snapshot is expected to be taken on time. - // - // * Pending - The next - // snapshot is pending to be taken. + // - OnTrack - The next snapshot is expected to be taken on time. + // - Pending - The next snapshot is pending to be taken. ExpectedNextSnapshotScheduleTimeStatus *string // A value that reports whether the Amazon Redshift cluster has finished applying @@ -310,8 +272,8 @@ type Cluster struct { // maintenance can occur. PreferredMaintenanceWindow *string - // A boolean value that, if true, indicates that the cluster can be accessed from a - // public network. + // A boolean value that, if true , indicates that the cluster can be accessed from + // a public network. PubliclyAccessible bool // The status of the reserved-node exchange request. Statuses include in-progress @@ -319,11 +281,9 @@ type Cluster struct { ReservedNodeExchangeStatus *ReservedNodeExchangeStatus // Returns the following: - // - // * AllowCancelResize: a boolean value indicating if the - // resize operation can be cancelled. - // - // * ResizeType: Returns ClassicResize + // - AllowCancelResize: a boolean value indicating if the resize operation can + // be cancelled. + // - ResizeType: Returns ClassicResize ResizeInfo *ResizeInfo // A value that describes the status of a cluster restore action. This parameter @@ -364,7 +324,7 @@ type ClusterAssociatedToSchedule struct { noSmithyDocumentSerde } -// Describes a ClusterDbRevision. +// Describes a ClusterDbRevision . type ClusterDbRevision struct { // The unique identifier of the cluster. @@ -389,19 +349,14 @@ type ClusterIamRole struct { // A value that describes the status of the IAM role's association with an Amazon // Redshift cluster. The following are possible statuses and descriptions. - // - // * - // in-sync: The role is available for use by the cluster. - // - // * adding: The role is in - // the process of being associated with the cluster. - // - // * removing: The role is in - // the process of being disassociated with the cluster. + // - in-sync : The role is available for use by the cluster. + // - adding : The role is in the process of being associated with the cluster. + // - removing : The role is in the process of being disassociated with the + // cluster. ApplyStatus *string // The Amazon Resource Name (ARN) of the IAM role, for example, - // arn:aws:iam::123456789012:role/RedshiftCopyUnload. + // arn:aws:iam::123456789012:role/RedshiftCopyUnload . IamRoleArn *string noSmithyDocumentSerde @@ -428,8 +383,8 @@ type ClusterParameterGroup struct { // The description of the parameter group. Description *string - // The name of the cluster parameter group family that this cluster parameter group - // is compatible with. + // The name of the cluster parameter group family that this cluster parameter + // group is compatible with. ParameterGroupFamily *string // The name of the cluster parameter group. @@ -445,8 +400,7 @@ type ClusterParameterGroup struct { type ClusterParameterGroupStatus struct { // The list of parameter statuses. For more information about parameters and - // parameter groups, go to Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. ClusterParameterStatusList []ClusterParameterStatus @@ -465,32 +419,21 @@ type ClusterParameterStatus struct { // The error that prevented the parameter from being applied to the database. ParameterApplyErrorDescription *string - // The status of the parameter that indicates whether the parameter is in sync with - // the database, waiting for a cluster reboot, or encountered an error when being - // applied. The following are possible statuses and descriptions. - // - // * in-sync: The - // parameter value is in sync with the database. - // - // * pending-reboot: The parameter - // value will be applied after the cluster reboots. - // - // * applying: The parameter - // value is being applied to the database. - // - // * invalid-parameter: Cannot apply the - // parameter value because it has an invalid value or syntax. - // - // * apply-deferred: - // The parameter contains static property changes. The changes are deferred until - // the cluster reboots. - // - // * apply-error: Cannot connect to the cluster. The - // parameter change will be applied after the cluster reboots. - // - // * unknown-error: - // Cannot apply the parameter change right now. The change will be applied after - // the cluster reboots. + // The status of the parameter that indicates whether the parameter is in sync + // with the database, waiting for a cluster reboot, or encountered an error when + // being applied. The following are possible statuses and descriptions. + // - in-sync : The parameter value is in sync with the database. + // - pending-reboot : The parameter value will be applied after the cluster + // reboots. + // - applying : The parameter value is being applied to the database. + // - invalid-parameter : Cannot apply the parameter value because it has an + // invalid value or syntax. + // - apply-deferred : The parameter contains static property changes. The changes + // are deferred until the cluster reboots. + // - apply-error : Cannot connect to the cluster. The parameter change will be + // applied after the cluster reboots. + // - unknown-error : Cannot apply the parameter change right now. The change will + // be applied after the cluster reboots. ParameterApplyStatus *string // The name of the parameter. @@ -567,8 +510,8 @@ type ClusterSubnetGroup struct { // The description of the cluster subnet group. Description *string - // The status of the cluster subnet group. Possible values are Complete, Incomplete - // and Invalid. + // The status of the cluster subnet group. Possible values are Complete , + // Incomplete and Invalid . SubnetGroupStatus *string // A list of the VPC Subnet elements. @@ -631,8 +574,8 @@ type DataShareAssociation struct { // datashare. ConsumerIdentifier *string - // The Amazon Web Services Region of the consumer accounts that have an association - // with a producer datashare. + // The Amazon Web Services Region of the consumer accounts that have an + // association with a producer datashare. ConsumerRegion *string // The creation date of the datashare that is associated. @@ -647,8 +590,8 @@ type DataShareAssociation struct { noSmithyDocumentSerde } -// Describes the status of a cluster while it is in the process of resizing with an -// incremental resize. +// Describes the status of a cluster while it is in the process of resizing with +// an incremental resize. type DataTransferProgress struct { // Describes the data transfer rate in MB's per second. @@ -664,7 +607,7 @@ type DataTransferProgress struct { EstimatedTimeToCompletionInSeconds *int64 // Describes the status of the cluster. While the transfer is in progress the - // status is transferringdata. + // status is transferringdata . Status *string // Describes the total amount of data to be transfered in megabytes. @@ -710,9 +653,9 @@ type DeferredMaintenanceWindow struct { type DeleteClusterSnapshotMessage struct { - // The unique identifier of the manual snapshot to be deleted. Constraints: Must be - // the name of an existing snapshot that is in the available, failed, or cancelled - // state. + // The unique identifier of the manual snapshot to be deleted. Constraints: Must + // be the name of an existing snapshot that is in the available , failed , or + // cancelled state. // // This member is required. SnapshotIdentifier *string @@ -799,8 +742,8 @@ type EndpointAccess struct { // The subnet group name where Amazon Redshift chooses to deploy the endpoint. SubnetGroupName *string - // The connection endpoint for connecting to an Amazon Redshift cluster through the - // proxy. + // The connection endpoint for connecting to an Amazon Redshift cluster through + // the proxy. VpcEndpoint *VpcEndpoint // The security groups associated with the endpoint. @@ -917,8 +860,9 @@ type EventSubscription struct { // that the subscription is enabled. Enabled bool - // The list of Amazon Redshift event categories specified in the event notification - // subscription. Values: Configuration, Management, Monitoring, Security, Pending + // The list of Amazon Redshift event categories specified in the event + // notification subscription. Values: Configuration, Management, Monitoring, + // Security, Pending EventCategoriesList []string // The event severity specified in the Amazon Redshift event notification @@ -938,16 +882,11 @@ type EventSubscription struct { // cluster-security-group, or scheduled-action. SourceType *string - // The status of the Amazon Redshift event notification subscription. - // Constraints: - // - // * Can be one of the following: active | no-permission | - // topic-not-exist - // - // * The status "no-permission" indicates that Amazon Redshift no - // longer has permission to post to the Amazon SNS topic. The status - // "topic-not-exist" indicates that the topic was deleted after the subscription - // was created. + // The status of the Amazon Redshift event notification subscription. Constraints: + // - Can be one of the following: active | no-permission | topic-not-exist + // - The status "no-permission" indicates that Amazon Redshift no longer has + // permission to post to the Amazon SNS topic. The status "topic-not-exist" + // indicates that the topic was deleted after the subscription was created. Status *string // The date and time the Amazon Redshift event notification subscription was @@ -1036,16 +975,16 @@ type IPRange struct { } // Defines a maintenance track that determines which Amazon Redshift version to -// apply during a maintenance window. If the value for MaintenanceTrack is current, -// the cluster is updated to the most recently certified maintenance release. If -// the value is trailing, the cluster is updated to the previously certified +// apply during a maintenance window. If the value for MaintenanceTrack is current +// , the cluster is updated to the most recently certified maintenance release. If +// the value is trailing , the cluster is updated to the previously certified // maintenance release. type MaintenanceTrack struct { // The version number for the cluster release. DatabaseVersion *string - // The name of the maintenance track. Possible values are current and trailing. + // The name of the maintenance track. Possible values are current and trailing . MaintenanceTrackName *string // An array of UpdateTarget objects to update with the maintenance track. @@ -1116,7 +1055,7 @@ type OrderableClusterOption struct { // A list of availability zones for the orderable cluster. AvailabilityZones []AvailabilityZone - // The cluster type, for example multi-node. + // The cluster type, for example multi-node . ClusterType *string // The version of the orderable cluster. @@ -1137,8 +1076,7 @@ type Parameter struct { // Specifies how to apply the WLM configuration parameter. Some properties can be // applied dynamically, while other properties require that any associated clusters // be rebooted for the configuration changes to be applied. For more information - // about parameters and parameter groups, go to Amazon Redshift Parameter Groups - // (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) + // about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) // in the Amazon Redshift Cluster Management Guide. ApplyType ParameterApplyType @@ -1148,7 +1086,7 @@ type Parameter struct { // A description of the parameter. Description *string - // If true, the parameter can be modified. Some parameters have security or + // If true , the parameter can be modified. Some parameters have security or // operational implications that prevent them from being changed. IsModifiable bool @@ -1158,8 +1096,8 @@ type Parameter struct { // The name of the parameter. ParameterName *string - // The value of the parameter. If ParameterName is wlm_json_configuration, then the - // maximum size of ParameterValue is 8000 characters. + // The value of the parameter. If ParameterName is wlm_json_configuration , then + // the maximum size of ParameterValue is 8000 characters. ParameterValue *string // The source of the parameter value, such as "engine-default" or "user". @@ -1224,12 +1162,11 @@ type PendingModifiedValues struct { // The encryption type for a cluster. Possible values are: KMS and None. EncryptionType *string - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting *bool // The name of the maintenance track that the cluster will change to during the @@ -1265,8 +1202,8 @@ type RecurringCharge struct { noSmithyDocumentSerde } -// Describes a reserved node. You can call the DescribeReservedNodeOfferings API to -// obtain the available reserved node offerings. +// Describes a reserved node. You can call the DescribeReservedNodeOfferings API +// to obtain the available reserved node offerings. type ReservedNode struct { // The currency code for the reserved cluster. @@ -1305,21 +1242,13 @@ type ReservedNode struct { StartTime *time.Time // The state of the reserved compute node. Possible Values: - // - // * pending-payment-This - // reserved node has recently been purchased, and the sale has been approved, but - // payment has not yet been confirmed. - // - // * active-This reserved node is owned by the - // caller and is available for use. - // - // * payment-failed-Payment failed for the - // purchase attempt. - // - // * retired-The reserved node is no longer available. - // - // * - // exchanging-The owner is exchanging the reserved node for another reserved node. + // - pending-payment-This reserved node has recently been purchased, and the + // sale has been approved, but payment has not yet been confirmed. + // - active-This reserved node is owned by the caller and is available for use. + // - payment-failed-Payment failed for the purchase attempt. + // - retired-The reserved node is no longer available. + // - exchanging-The owner is exchanging the reserved node for another reserved + // node. State *string // The hourly rate Amazon Redshift charges you for this reserved node. @@ -1332,8 +1261,8 @@ type ReservedNode struct { // reserved node, the price for a node, the node's state, and other details. type ReservedNodeConfigurationOption struct { - // Describes a reserved node. You can call the DescribeReservedNodeOfferings API to - // obtain the available reserved node offerings. + // Describes a reserved node. You can call the DescribeReservedNodeOfferings API + // to obtain the available reserved node offerings. SourceReservedNode *ReservedNode // The target reserved-node count. @@ -1412,15 +1341,15 @@ type ReservedNodeOffering struct { // ReservedNodeOfferingType ReservedNodeOfferingType - // The rate you are charged for each hour the cluster that is using the offering is - // running. + // The rate you are charged for each hour the cluster that is using the offering + // is running. UsagePrice float64 noSmithyDocumentSerde } -// Describes a resize cluster operation. For example, a scheduled action to run the -// ResizeCluster API operation. +// Describes a resize cluster operation. For example, a scheduled action to run +// the ResizeCluster API operation. type ResizeClusterMessage struct { // The unique identifier for the cluster to resize. @@ -1429,7 +1358,7 @@ type ResizeClusterMessage struct { ClusterIdentifier *string // A boolean value indicating whether the resize operation is using the classic - // resize process. If you don't provide this parameter or set the value to false, + // resize process. If you don't provide this parameter or set the value to false , // the resize type is elastic. Classic *bool @@ -1440,8 +1369,8 @@ type ResizeClusterMessage struct { // current node type is used. NodeType *string - // The new number of nodes for the cluster. If not specified, the cluster's current - // number of nodes is used. + // The new number of nodes for the cluster. If not specified, the cluster's + // current number of nodes is used. NumberOfNodes *int32 // The identifier of the reserved node. @@ -1459,7 +1388,7 @@ type ResizeInfo struct { // A boolean value indicating if the resize operation can be cancelled. AllowCancelResize bool - // Returns the value ClassicResize. + // Returns the value ClassicResize . ResizeType *string noSmithyDocumentSerde @@ -1499,8 +1428,8 @@ type RestoreStatus struct { noSmithyDocumentSerde } -// Describes a resume cluster operation. For example, a scheduled action to run the -// ResumeCluster API operation. +// Describes a resume cluster operation. For example, a scheduled action to run +// the ResumeCluster API operation. type ResumeClusterMessage struct { // The identifier of the cluster to be resumed. @@ -1511,18 +1440,18 @@ type ResumeClusterMessage struct { noSmithyDocumentSerde } -// Describes a RevisionTarget. +// Describes a RevisionTarget . type RevisionTarget struct { // A unique string that identifies the version to update the cluster to. You can - // use this value in ModifyClusterDbRevision. + // use this value in ModifyClusterDbRevision . DatabaseRevision *string // The date on which the database revision was released. DatabaseRevisionReleaseDate *time.Time // A string that describes the changes and features that will be applied to the - // cluster when it is updated to the corresponding ClusterDbRevision. + // cluster when it is updated to the corresponding ClusterDbRevision . Description *string noSmithyDocumentSerde @@ -1530,7 +1459,7 @@ type RevisionTarget struct { // Describes a scheduled action. You can use a scheduled action to trigger some // Amazon Redshift API operations on a schedule. For information about which API -// operations can be scheduled, see ScheduledActionType. +// operations can be scheduled, see ScheduledActionType . type ScheduledAction struct { // The end time in UTC when the schedule is no longer active. After this time, the @@ -1542,8 +1471,7 @@ type ScheduledAction struct { // This IAM role must allow the Amazon Redshift scheduler (Principal // scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more // information about the IAM role to use with the Amazon Redshift scheduler, see - // Using Identity-Based Policies for Amazon Redshift - // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) + // Using Identity-Based Policies for Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) // in the Amazon Redshift Cluster Management Guide. IamRole *string @@ -1552,11 +1480,10 @@ type ScheduledAction struct { // The schedule for a one-time (at format) or recurring (cron format) scheduled // action. Schedule invocations must be separated by at least one hour. Format of - // at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, - // "at(2016-03-04T17:27:00)". Format of cron expressions is "cron(Minutes Hours - // Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For - // more information, see Cron Expressions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) + // at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, " + // at(2016-03-04T17:27:00) ". Format of cron expressions is " cron(Minutes Hours + // Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ". + // For more information, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) // in the Amazon CloudWatch Events User Guide. Schedule *string @@ -1570,11 +1497,13 @@ type ScheduledAction struct { // scheduled action does not trigger. StartTime *time.Time - // The state of the scheduled action. For example, DISABLED. + // The state of the scheduled action. For example, DISABLED . State ScheduledActionState - // A JSON format string of the Amazon Redshift API operation with input parameters. - // "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}". + // A JSON format string of the Amazon Redshift API operation with input + // parameters. " + // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} + // ". TargetAction *ScheduledActionType noSmithyDocumentSerde @@ -1588,8 +1517,8 @@ type ScheduledActionFilter struct { // This member is required. Name ScheduledActionFilterName - // List of values. Compare if the value (of type defined by Name) equals an item in - // the list of scheduled actions. + // List of values. Compare if the value (of type defined by Name ) equals an item + // in the list of scheduled actions. // // This member is required. Values []string @@ -1649,7 +1578,7 @@ type Snapshot struct { // amount of time it took a completed backup to finish. ElapsedTimeInSeconds int64 - // If true, the data in the snapshot is encrypted at rest. + // If true , the data in the snapshot is encrypted at rest. Encrypted bool // A boolean that indicates whether the snapshot data is encrypted using the HSM @@ -1661,12 +1590,11 @@ type Snapshot struct { // 1.0.15503. EngineFullVersion *string - // An option that specifies whether to create the cluster with enhanced VPC routing - // enabled. To create a cluster that uses enhanced VPC routing, the cluster must be - // in a VPC. For more information, see Enhanced VPC Routing - // (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in - // the Amazon Redshift Cluster Management Guide. If this option is true, enhanced - // VPC routing is enabled. Default: false + // An option that specifies whether to create the cluster with enhanced VPC + // routing enabled. To create a cluster that uses enhanced VPC routing, the cluster + // must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) + // in the Amazon Redshift Cluster Management Guide. If this option is true , + // enhanced VPC routing is enabled. Default: false EnhancedVpcRouting bool // The estimate of the time remaining before the snapshot backup will complete. @@ -1697,8 +1625,8 @@ type Snapshot struct { // The number of nodes in the cluster. NumberOfNodes int32 - // For manual snapshots, the Amazon Web Services account used to create or copy the - // snapshot. For automatic snapshots, the owner of the cluster. The owner can + // For manual snapshots, the Amazon Web Services account used to create or copy + // the snapshot. For automatic snapshots, the owner of the cluster. The owner can // perform all snapshot actions, such as sharing a manual snapshot. OwnerAccount *string @@ -1725,17 +1653,11 @@ type Snapshot struct { // The source region from which the snapshot was copied. SourceRegion *string - // The snapshot status. The value of the status depends on the API operation - // used: - // - // * CreateClusterSnapshot and CopyClusterSnapshot returns status as - // "creating". - // - // * DescribeClusterSnapshots returns status as "creating", - // "available", "final snapshot", or "failed". - // - // * DeleteClusterSnapshot returns - // status as "deleted". + // The snapshot status. The value of the status depends on the API operation used: + // - CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating". + // - DescribeClusterSnapshots returns status as "creating", "available", "final + // snapshot", or "failed". + // - DeleteClusterSnapshot returns status as "deleted". Status *string // The list of tags for the cluster snapshot. @@ -1752,11 +1674,10 @@ type Snapshot struct { noSmithyDocumentSerde } -// The snapshot copy grant that grants Amazon Redshift permission to encrypt copied -// snapshots with the specified encrypted symmetric key from Amazon Web Services -// KMS in the destination region. For more information about managing snapshot copy -// grants, go to Amazon Redshift Database Encryption -// (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) +// The snapshot copy grant that grants Amazon Redshift permission to encrypt +// copied snapshots with the specified encrypted symmetric key from Amazon Web +// Services KMS in the destination region. For more information about managing +// snapshot copy grants, go to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) // in the Amazon Redshift Cluster Management Guide. type SnapshotCopyGrant struct { @@ -1875,7 +1796,7 @@ type TableRestoreStatus struct { ClusterIdentifier *string // A description of the status of the table restore request. Status values include - // SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. + // SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS . Message *string // The name of the table to create as a result of the table restore request. @@ -1901,7 +1822,7 @@ type TableRestoreStatus struct { SourceTableName *string // A value that describes the current state of the table restore request. Valid - // Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS + // Values: SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS Status TableRestoreStatusType // The unique identifier for the table restore request. @@ -1935,36 +1856,22 @@ type Tag struct { type TaggedResource struct { // The Amazon Resource Name (ARN) with which the tag is associated, for example: - // arn:aws:redshift:us-east-2:123456789:cluster:t1. + // arn:aws:redshift:us-east-2:123456789:cluster:t1 . ResourceName *string // The type of resource with which the tag is associated. Valid resource types // are: - // - // * Cluster - // - // * CIDR/IP - // - // * EC2 security group - // - // * Snapshot - // - // * Cluster security - // group - // - // * Subnet group - // - // * HSM connection - // - // * HSM certificate - // - // * Parameter - // group - // - // For more information about Amazon Redshift resource types and - // constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name - // (ARN) - // (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) + // - Cluster + // - CIDR/IP + // - EC2 security group + // - Snapshot + // - Cluster security group + // - Subnet group + // - HSM connection + // - HSM certificate + // - Parameter group + // For more information about Amazon Redshift resource types and constructing + // ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) // in the Amazon Redshift Cluster Management Guide. ResourceType *string @@ -1996,16 +1903,11 @@ type UsageLimit struct { // amount is in terabytes (TB). Amount int64 - // The action that Amazon Redshift takes when the limit is reached. Possible values - // are: - // - // * log - To log an event in a system table. The default is log. - // - // * - // emit-metric - To emit CloudWatch metrics. - // - // * disable - To disable the feature - // until the next usage period begins. + // The action that Amazon Redshift takes when the limit is reached. Possible + // values are: + // - log - To log an event in a system table. The default is log. + // - emit-metric - To emit CloudWatch metrics. + // - disable - To disable the feature until the next usage period begins. BreachAction UsageLimitBreachAction // The identifier of the cluster with a usage limit. @@ -2019,7 +1921,7 @@ type UsageLimit struct { LimitType UsageLimitLimitType // The time period that the amount applies to. A weekly period begins on Sunday. - // The default is monthly. + // The default is monthly . Period UsageLimitPeriod // A list of tag instances. @@ -2031,16 +1933,16 @@ type UsageLimit struct { noSmithyDocumentSerde } -// The connection endpoint for connecting to an Amazon Redshift cluster through the -// proxy. +// The connection endpoint for connecting to an Amazon Redshift cluster through +// the proxy. type VpcEndpoint struct { // One or more network interfaces of the endpoint. Also known as an interface // endpoint. NetworkInterfaces []NetworkInterface - // The connection endpoint ID for connecting an Amazon Redshift cluster through the - // proxy. + // The connection endpoint ID for connecting an Amazon Redshift cluster through + // the proxy. VpcEndpointId *string // The VPC identifier that the endpoint is associated. diff --git a/service/redshiftdata/api_client.go b/service/redshiftdata/api_client.go index 66ff47bdf05..0b87025e18a 100644 --- a/service/redshiftdata/api_client.go +++ b/service/redshiftdata/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/redshiftdata/api_op_BatchExecuteStatement.go b/service/redshiftdata/api_op_BatchExecuteStatement.go index 9c06637e7c8..f9476253572 100644 --- a/service/redshiftdata/api_op_BatchExecuteStatement.go +++ b/service/redshiftdata/api_op_BatchExecuteStatement.go @@ -15,42 +15,32 @@ import ( // Runs one or more SQL statements, which can be data manipulation language (DML) // or data definition language (DDL). Depending on the authorization method, use // one of the following combinations of request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - -// when connecting to a cluster, provide the secret-arn of a secret stored in -// Secrets Manager which has username and password. The specified secret contains -// credentials to connect to the database you specify. When you are connecting to a -// cluster, you also supply the database name, If you provide a cluster identifier -// (dbClusterIdentifier), it must match the cluster identifier stored in the -// secret. When you are connecting to a serverless workgroup, you also supply the -// database name. -// -// * Temporary credentials - when connecting to your data -// warehouse, choose one of the following options: -// -// * When connecting to a -// serverless workgroup, specify the workgroup name and database name. The database -// user name is derived from the IAM identity. For example, -// arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, -// permission to call the redshift-serverless:GetCredentials operation is -// required. -// -// * When connecting to a cluster as an IAM identity, specify the -// cluster identifier and the database name. The database user name is derived from -// the IAM identity. For example, arn:iam::123456789012:user:foo has the database -// user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) { if params == nil { params = &BatchExecuteStatementInput{} @@ -132,14 +122,14 @@ type BatchExecuteStatementOutput struct { // The identifier of the SQL statement whose results are to be fetched. This value // is a universally unique identifier (UUID) generated by Amazon Redshift Data API. - // This identifier is returned by BatchExecuteStatment. + // This identifier is returned by BatchExecuteStatment . Id *string // The name or ARN of the secret that enables access to the database. SecretArn *string - // The serverless workgroup name or Amazon Resource Name (ARN). This element is not - // returned when connecting to a provisioned cluster. + // The serverless workgroup name or Amazon Resource Name (ARN). This element is + // not returned when connecting to a provisioned cluster. WorkgroupName *string // Metadata pertaining to the operation's result. diff --git a/service/redshiftdata/api_op_CancelStatement.go b/service/redshiftdata/api_op_CancelStatement.go index 5cb8103b936..ec704e996dc 100644 --- a/service/redshiftdata/api_op_CancelStatement.go +++ b/service/redshiftdata/api_op_CancelStatement.go @@ -11,10 +11,9 @@ import ( ) // Cancels a running query. To be canceled, a query must be running. For more -// information about the Amazon Redshift Data API and CLI usage examples, see Using -// the Amazon Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// information about the Amazon Redshift Data API and CLI usage examples, see +// Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) CancelStatement(ctx context.Context, params *CancelStatementInput, optFns ...func(*Options)) (*CancelStatementOutput, error) { if params == nil { params = &CancelStatementInput{} @@ -34,7 +33,7 @@ type CancelStatementInput struct { // The identifier of the SQL statement to cancel. This value is a universally // unique identifier (UUID) generated by Amazon Redshift Data API. This identifier - // is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements. + // is returned by BatchExecuteStatment , ExecuteStatment , and ListStatements . // // This member is required. Id *string diff --git a/service/redshiftdata/api_op_DescribeStatement.go b/service/redshiftdata/api_op_DescribeStatement.go index 6272b0eb21a..049e26ac318 100644 --- a/service/redshiftdata/api_op_DescribeStatement.go +++ b/service/redshiftdata/api_op_DescribeStatement.go @@ -16,9 +16,8 @@ import ( // Amazon Redshift Data API. The information includes when the query started, when // it finished, the query status, the number of rows returned, and the SQL // statement. For more information about the Amazon Redshift Data API and CLI usage -// examples, see Using the Amazon Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// examples, see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) DescribeStatement(ctx context.Context, params *DescribeStatementInput, optFns ...func(*Options)) (*DescribeStatementOutput, error) { if params == nil { params = &DescribeStatementInput{} @@ -41,7 +40,7 @@ type DescribeStatementInput struct { // indicates the number of the SQL statement. For example, // d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the // second SQL statement of a batch query. This identifier is returned by - // BatchExecuteStatment, ExecuteStatement, and ListStatements. + // BatchExecuteStatment , ExecuteStatement , and ListStatements . // // This member is required. Id *string @@ -109,24 +108,14 @@ type DescribeStatementOutput struct { // The status of the SQL statement being described. Status values are defined as // follows: - // - // * ABORTED - The query run was stopped by the user. - // - // * ALL - A status - // value that includes all query statuses. This value can be used to filter - // results. - // - // * FAILED - The query run failed. - // - // * FINISHED - The query has finished - // running. - // - // * PICKED - The query has been chosen to be run. - // - // * STARTED - The query - // run has started. - // - // * SUBMITTED - The query was submitted, but not yet processed. + // - ABORTED - The query run was stopped by the user. + // - ALL - A status value that includes all query statuses. This value can be + // used to filter results. + // - FAILED - The query run failed. + // - FINISHED - The query has finished running. + // - PICKED - The query has been chosen to be run. + // - STARTED - The query run has started. + // - SUBMITTED - The query was submitted, but not yet processed. Status types.StatusString // The SQL statements from a multiple statement run. diff --git a/service/redshiftdata/api_op_DescribeTable.go b/service/redshiftdata/api_op_DescribeTable.go index 08f80cf47c2..6bc644df9b3 100644 --- a/service/redshiftdata/api_op_DescribeTable.go +++ b/service/redshiftdata/api_op_DescribeTable.go @@ -16,41 +16,32 @@ import ( // The information includes its columns. A token is returned to page through the // column list. Depending on the authorization method, use one of the following // combinations of request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - when connecting to a -// cluster, provide the secret-arn of a secret stored in Secrets Manager which has -// username and password. The specified secret contains credentials to connect to -// the database you specify. When you are connecting to a cluster, you also supply -// the database name, If you provide a cluster identifier (dbClusterIdentifier), it -// must match the cluster identifier stored in the secret. When you are connecting -// to a serverless workgroup, you also supply the database name. -// -// * Temporary -// credentials - when connecting to your data warehouse, choose one of the -// following options: -// -// * When connecting to a serverless workgroup, specify the -// workgroup name and database name. The database user name is derived from the IAM -// identity. For example, arn:iam::123456789012:user:foo has the database user name -// IAM:foo. Also, permission to call the redshift-serverless:GetCredentials -// operation is required. -// -// * When connecting to a cluster as an IAM identity, -// specify the cluster identifier and the database name. The database user name is -// derived from the IAM identity. For example, arn:iam::123456789012:user:foo has -// the database user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error) { if params == nil { params = &DescribeTableInput{} diff --git a/service/redshiftdata/api_op_ExecuteStatement.go b/service/redshiftdata/api_op_ExecuteStatement.go index 8fba27abf50..954058ac95d 100644 --- a/service/redshiftdata/api_op_ExecuteStatement.go +++ b/service/redshiftdata/api_op_ExecuteStatement.go @@ -17,41 +17,32 @@ import ( // definition language (DDL). This statement must be a single SQL statement. // Depending on the authorization method, use one of the following combinations of // request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - when connecting to a cluster, provide -// the secret-arn of a secret stored in Secrets Manager which has username and -// password. The specified secret contains credentials to connect to the database -// you specify. When you are connecting to a cluster, you also supply the database -// name, If you provide a cluster identifier (dbClusterIdentifier), it must match -// the cluster identifier stored in the secret. When you are connecting to a -// serverless workgroup, you also supply the database name. -// -// * Temporary -// credentials - when connecting to your data warehouse, choose one of the -// following options: -// -// * When connecting to a serverless workgroup, specify the -// workgroup name and database name. The database user name is derived from the IAM -// identity. For example, arn:iam::123456789012:user:foo has the database user name -// IAM:foo. Also, permission to call the redshift-serverless:GetCredentials -// operation is required. -// -// * When connecting to a cluster as an IAM identity, -// specify the cluster identifier and the database name. The database user name is -// derived from the IAM identity. For example, arn:iam::123456789012:user:foo has -// the database user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error) { if params == nil { params = &ExecuteStatementInput{} @@ -99,8 +90,8 @@ type ExecuteStatementInput struct { // parameter is required when authenticating using Secrets Manager. SecretArn *string - // The name of the SQL statement. You can name the SQL statement when you create it - // to identify the query. + // The name of the SQL statement. You can name the SQL statement when you create + // it to identify the query. StatementName *string // A value that indicates whether to send an event to the Amazon EventBridge event @@ -137,8 +128,8 @@ type ExecuteStatementOutput struct { // The name or ARN of the secret that enables access to the database. SecretArn *string - // The serverless workgroup name or Amazon Resource Name (ARN). This element is not - // returned when connecting to a provisioned cluster. + // The serverless workgroup name or Amazon Resource Name (ARN). This element is + // not returned when connecting to a provisioned cluster. WorkgroupName *string // Metadata pertaining to the operation's result. diff --git a/service/redshiftdata/api_op_GetStatementResult.go b/service/redshiftdata/api_op_GetStatementResult.go index 154e78c2feb..64ef938f0ec 100644 --- a/service/redshiftdata/api_op_GetStatementResult.go +++ b/service/redshiftdata/api_op_GetStatementResult.go @@ -14,9 +14,8 @@ import ( // Fetches the temporarily cached result of an SQL statement. A token is returned // to page through the statement results. For more information about the Amazon -// Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) GetStatementResult(ctx context.Context, params *GetStatementResultInput, optFns ...func(*Options)) (*GetStatementResultOutput, error) { if params == nil { params = &GetStatementResultInput{} @@ -39,7 +38,7 @@ type GetStatementResultInput struct { // A suffix indicates then number of the SQL statement. For example, // d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the // second SQL statement of a batch query. This identifier is returned by - // BatchExecuteStatment, ExecuteStatment, and ListStatements. + // BatchExecuteStatment , ExecuteStatment , and ListStatements . // // This member is required. Id *string diff --git a/service/redshiftdata/api_op_ListDatabases.go b/service/redshiftdata/api_op_ListDatabases.go index 708ef263be5..7218e14d355 100644 --- a/service/redshiftdata/api_op_ListDatabases.go +++ b/service/redshiftdata/api_op_ListDatabases.go @@ -14,41 +14,32 @@ import ( // List the databases in a cluster. A token is returned to page through the // database list. Depending on the authorization method, use one of the following // combinations of request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - when connecting to a -// cluster, provide the secret-arn of a secret stored in Secrets Manager which has -// username and password. The specified secret contains credentials to connect to -// the database you specify. When you are connecting to a cluster, you also supply -// the database name, If you provide a cluster identifier (dbClusterIdentifier), it -// must match the cluster identifier stored in the secret. When you are connecting -// to a serverless workgroup, you also supply the database name. -// -// * Temporary -// credentials - when connecting to your data warehouse, choose one of the -// following options: -// -// * When connecting to a serverless workgroup, specify the -// workgroup name and database name. The database user name is derived from the IAM -// identity. For example, arn:iam::123456789012:user:foo has the database user name -// IAM:foo. Also, permission to call the redshift-serverless:GetCredentials -// operation is required. -// -// * When connecting to a cluster as an IAM identity, -// specify the cluster identifier and the database name. The database user name is -// derived from the IAM identity. For example, arn:iam::123456789012:user:foo has -// the database user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error) { if params == nil { params = &ListDatabasesInput{} diff --git a/service/redshiftdata/api_op_ListSchemas.go b/service/redshiftdata/api_op_ListSchemas.go index ae9dde958c2..336e99ea05a 100644 --- a/service/redshiftdata/api_op_ListSchemas.go +++ b/service/redshiftdata/api_op_ListSchemas.go @@ -14,41 +14,32 @@ import ( // Lists the schemas in a database. A token is returned to page through the schema // list. Depending on the authorization method, use one of the following // combinations of request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - when connecting to a -// cluster, provide the secret-arn of a secret stored in Secrets Manager which has -// username and password. The specified secret contains credentials to connect to -// the database you specify. When you are connecting to a cluster, you also supply -// the database name, If you provide a cluster identifier (dbClusterIdentifier), it -// must match the cluster identifier stored in the secret. When you are connecting -// to a serverless workgroup, you also supply the database name. -// -// * Temporary -// credentials - when connecting to your data warehouse, choose one of the -// following options: -// -// * When connecting to a serverless workgroup, specify the -// workgroup name and database name. The database user name is derived from the IAM -// identity. For example, arn:iam::123456789012:user:foo has the database user name -// IAM:foo. Also, permission to call the redshift-serverless:GetCredentials -// operation is required. -// -// * When connecting to a cluster as an IAM identity, -// specify the cluster identifier and the database name. The database user name is -// derived from the IAM identity. For example, arn:iam::123456789012:user:foo has -// the database user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optFns ...func(*Options)) (*ListSchemasOutput, error) { if params == nil { params = &ListSchemasInput{} diff --git a/service/redshiftdata/api_op_ListStatements.go b/service/redshiftdata/api_op_ListStatements.go index e58ecd21d20..f3c6bbf7631 100644 --- a/service/redshiftdata/api_op_ListStatements.go +++ b/service/redshiftdata/api_op_ListStatements.go @@ -56,30 +56,19 @@ type ListStatementsInput struct { // ExecuteStatement to identify the query. You can list multiple statements by // providing a prefix that matches the beginning of the statement name. For // example, to list myStatement1, myStatement2, myStatement3, and so on, then - // provide the a value of myStatement. Data API does a case-sensitive match of SQL + // provide the a value of myStatement . Data API does a case-sensitive match of SQL // statement names to the prefix value you provide. StatementName *string - // The status of the SQL statement to list. Status values are defined as - // follows: - // - // * ABORTED - The query run was stopped by the user. - // - // * ALL - A status - // value that includes all query statuses. This value can be used to filter - // results. - // - // * FAILED - The query run failed. - // - // * FINISHED - The query has finished - // running. - // - // * PICKED - The query has been chosen to be run. - // - // * STARTED - The query - // run has started. - // - // * SUBMITTED - The query was submitted, but not yet processed. + // The status of the SQL statement to list. Status values are defined as follows: + // - ABORTED - The query run was stopped by the user. + // - ALL - A status value that includes all query statuses. This value can be + // used to filter results. + // - FAILED - The query run failed. + // - FINISHED - The query has finished running. + // - PICKED - The query has been chosen to be run. + // - STARTED - The query run has started. + // - SUBMITTED - The query was submitted, but not yet processed. Status types.StatusString noSmithyDocumentSerde diff --git a/service/redshiftdata/api_op_ListTables.go b/service/redshiftdata/api_op_ListTables.go index 455beb1a038..52aa5169463 100644 --- a/service/redshiftdata/api_op_ListTables.go +++ b/service/redshiftdata/api_op_ListTables.go @@ -16,42 +16,32 @@ import ( // specified, then all tables in the database are returned. A token is returned to // page through the table list. Depending on the authorization method, use one of // the following combinations of request parameters: +// - Secrets Manager - when connecting to a cluster, provide the secret-arn of a +// secret stored in Secrets Manager which has username and password . The +// specified secret contains credentials to connect to the database you specify. +// When you are connecting to a cluster, you also supply the database name, If you +// provide a cluster identifier ( dbClusterIdentifier ), it must match the +// cluster identifier stored in the secret. When you are connecting to a serverless +// workgroup, you also supply the database name. +// - Temporary credentials - when connecting to your data warehouse, choose one +// of the following options: +// - When connecting to a serverless workgroup, specify the workgroup name and +// database name. The database user name is derived from the IAM identity. For +// example, arn:iam::123456789012:user:foo has the database user name IAM:foo . +// Also, permission to call the redshift-serverless:GetCredentials operation is +// required. +// - When connecting to a cluster as an IAM identity, specify the cluster +// identifier and the database name. The database user name is derived from the IAM +// identity. For example, arn:iam::123456789012:user:foo has the database user +// name IAM:foo . Also, permission to call the +// redshift:GetClusterCredentialsWithIAM operation is required. +// - When connecting to a cluster as a database user, specify the cluster +// identifier, the database name, and the database user name. Also, permission to +// call the redshift:GetClusterCredentials operation is required. // -// * Secrets Manager - when -// connecting to a cluster, provide the secret-arn of a secret stored in Secrets -// Manager which has username and password. The specified secret contains -// credentials to connect to the database you specify. When you are connecting to a -// cluster, you also supply the database name, If you provide a cluster identifier -// (dbClusterIdentifier), it must match the cluster identifier stored in the -// secret. When you are connecting to a serverless workgroup, you also supply the -// database name. -// -// * Temporary credentials - when connecting to your data -// warehouse, choose one of the following options: -// -// * When connecting to a -// serverless workgroup, specify the workgroup name and database name. The database -// user name is derived from the IAM identity. For example, -// arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, -// permission to call the redshift-serverless:GetCredentials operation is -// required. -// -// * When connecting to a cluster as an IAM identity, specify the -// cluster identifier and the database name. The database user name is derived from -// the IAM identity. For example, arn:iam::123456789012:user:foo has the database -// user name IAM:foo. Also, permission to call the -// redshift:GetClusterCredentialsWithIAM operation is required. -// -// * When connecting -// to a cluster as a database user, specify the cluster identifier, the database -// name, and the database user name. Also, permission to call the -// redshift:GetClusterCredentials operation is required. -// -// For more information -// about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon -// Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error) { if params == nil { params = &ListTablesInput{} @@ -115,7 +105,7 @@ type ListTablesInput struct { // A pattern to filter results by table name. Within a table pattern, "%" means // match any substring of 0 or more characters and "_" means match any one // character. Only table name entries matching the search pattern are returned. If - // TablePattern is not specified, then all tables that match SchemaPatternare + // TablePattern is not specified, then all tables that match SchemaPattern are // returned. If neither SchemaPattern or TablePattern are specified, then all // tables are returned. TablePattern *string diff --git a/service/redshiftdata/doc.go b/service/redshiftdata/doc.go index 5c10c9a7eef..f8e24602ebc 100644 --- a/service/redshiftdata/doc.go +++ b/service/redshiftdata/doc.go @@ -6,7 +6,6 @@ // You can use the Amazon Redshift Data API to run queries on Amazon Redshift // tables. You can run SQL statements, which are committed if the statement // succeeds. For more information about the Amazon Redshift Data API and CLI usage -// examples, see Using the Amazon Redshift Data API -// (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) in the Amazon -// Redshift Management Guide. +// examples, see Using the Amazon Redshift Data API (https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html) +// in the Amazon Redshift Management Guide. package redshiftdata diff --git a/service/redshiftdata/types/enums.go b/service/redshiftdata/types/enums.go index b944abd8c42..de5c372c870 100644 --- a/service/redshiftdata/types/enums.go +++ b/service/redshiftdata/types/enums.go @@ -14,8 +14,8 @@ const ( StatementStatusStringFailed StatementStatusString = "FAILED" ) -// Values returns all known values for StatementStatusString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StatementStatusString. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StatementStatusString) Values() []StatementStatusString { return []StatementStatusString{ @@ -41,9 +41,9 @@ const ( StatusStringAll StatusString = "ALL" ) -// Values returns all known values for StatusString. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StatusString. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StatusString) Values() []StatusString { return []StatusString{ "SUBMITTED", diff --git a/service/redshiftdata/types/types.go b/service/redshiftdata/types/types.go index 14dbcc0d2c3..9df5fc91636 100644 --- a/service/redshiftdata/types/types.go +++ b/service/redshiftdata/types/types.go @@ -129,9 +129,8 @@ type SqlParameter struct { Name *string // The value of the parameter. Amazon Redshift implicitly converts to the proper - // data type. For more information, see Data types - // (https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html) in - // the Amazon Redshift Database Developer Guide. + // data type. For more information, see Data types (https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html) + // in the Amazon Redshift Database Developer Guide. // // This member is required. Value *string @@ -160,8 +159,8 @@ type StatementData struct { // The SQL statement. QueryString *string - // One or more SQL statements. Each query string in the array corresponds to one of - // the queries in a batch query request. + // One or more SQL statements. Each query string in the array corresponds to one + // of the queries in a batch query request. QueryStrings []string // The name or Amazon Resource Name (ARN) of the secret that enables access to the @@ -241,8 +240,8 @@ type TableMember struct { // The schema containing the table. Schema *string - // The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL - // TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. + // The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, + // GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. Type *string noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_client.go b/service/redshiftserverless/api_client.go index c28d3297496..51cb33d8ca2 100644 --- a/service/redshiftserverless/api_client.go +++ b/service/redshiftserverless/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go b/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go index 2978c3d8441..5a84c5cf53f 100644 --- a/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go +++ b/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go @@ -12,8 +12,8 @@ import ( ) // Converts a recovery point to a snapshot. For more information about recovery -// points and snapshots, see Working with snapshots and recovery points -// (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html). +// points and snapshots, see Working with snapshots and recovery points (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html) +// . func (c *Client) ConvertRecoveryPointToSnapshot(ctx context.Context, params *ConvertRecoveryPointToSnapshotInput, optFns ...func(*Options)) (*ConvertRecoveryPointToSnapshotOutput, error) { if params == nil { params = &ConvertRecoveryPointToSnapshotInput{} @@ -44,8 +44,7 @@ type ConvertRecoveryPointToSnapshotInput struct { // How long to retain the snapshot. RetentionPeriod *int32 - // An array of Tag objects - // (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) + // An array of Tag objects (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) // to associate with the created snapshot. Tags []types.Tag diff --git a/service/redshiftserverless/api_op_CreateNamespace.go b/service/redshiftserverless/api_op_CreateNamespace.go index d7bc3870452..543648f3bc7 100644 --- a/service/redshiftserverless/api_op_CreateNamespace.go +++ b/service/redshiftserverless/api_op_CreateNamespace.go @@ -56,8 +56,8 @@ type CreateNamespaceInput struct { // your data. KmsKeyId *string - // The types of logs the namespace can export. Available export types are userlog, - // connectionlog, and useractivitylog. + // The types of logs the namespace can export. Available export types are userlog , + // connectionlog , and useractivitylog . LogExports []types.LogExport // A list of tag instances. diff --git a/service/redshiftserverless/api_op_CreateSnapshot.go b/service/redshiftserverless/api_op_CreateSnapshot.go index 167f189bb33..bec4a5356a7 100644 --- a/service/redshiftserverless/api_op_CreateSnapshot.go +++ b/service/redshiftserverless/api_op_CreateSnapshot.go @@ -12,8 +12,8 @@ import ( ) // Creates a snapshot of all databases in a namespace. For more information about -// snapshots, see Working with snapshots and recovery points -// (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html). +// snapshots, see Working with snapshots and recovery points (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html) +// . func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} @@ -44,8 +44,7 @@ type CreateSnapshotInput struct { // How long to retain the created snapshot. RetentionPeriod *int32 - // An array of Tag objects - // (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) + // An array of Tag objects (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) // to associate with the snapshot. Tags []types.Tag diff --git a/service/redshiftserverless/api_op_CreateUsageLimit.go b/service/redshiftserverless/api_op_CreateUsageLimit.go index b1b8b9a5eed..920ef832f23 100644 --- a/service/redshiftserverless/api_op_CreateUsageLimit.go +++ b/service/redshiftserverless/api_op_CreateUsageLimit.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a usage limit for a specified Amazon Redshift Serverless usage type. The -// usage limit is identified by the returned usage limit identifier. +// Creates a usage limit for a specified Amazon Redshift Serverless usage type. +// The usage limit is identified by the returned usage limit identifier. func (c *Client) CreateUsageLimit(ctx context.Context, params *CreateUsageLimitInput, optFns ...func(*Options)) (*CreateUsageLimitOutput, error) { if params == nil { params = &CreateUsageLimitInput{} diff --git a/service/redshiftserverless/api_op_CreateWorkgroup.go b/service/redshiftserverless/api_op_CreateWorkgroup.go index a0e8b129fdc..e857b3a6cab 100644 --- a/service/redshiftserverless/api_op_CreateWorkgroup.go +++ b/service/redshiftserverless/api_op_CreateWorkgroup.go @@ -44,17 +44,17 @@ type CreateWorkgroupInput struct { BaseCapacity *int32 // An array of parameters to set for advanced control over a database. The options - // are auto_mv, datestyle, enable_case_sensitivity_identifier, - // enable_user_activity_logging, query_group, search_path, and query monitoring + // are auto_mv , datestyle , enable_case_sensitivity_identifier , + // enable_user_activity_logging , query_group , search_path , and query monitoring // metrics that let you define performance boundaries. For more information about - // query monitoring rules and available metrics, see Query monitoring metrics for - // Amazon Redshift Serverless - // (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless). + // query monitoring rules and available metrics, see Query monitoring metrics for + // Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) + // . ConfigParameters []types.ConfigParameter - // The value that specifies whether to turn on enhanced virtual private cloud (VPC) - // routing, which forces Amazon Redshift Serverless to route traffic through your - // VPC instead of over the internet. + // The value that specifies whether to turn on enhanced virtual private cloud + // (VPC) routing, which forces Amazon Redshift Serverless to route traffic through + // your VPC instead of over the internet. EnhancedVpcRouting *bool // The custom port to use when connecting to a workgroup. Valid port ranges are diff --git a/service/redshiftserverless/api_op_GetCredentials.go b/service/redshiftserverless/api_op_GetCredentials.go index ebb15f3bcca..4f31f0a0e77 100644 --- a/service/redshiftserverless/api_op_GetCredentials.go +++ b/service/redshiftserverless/api_op_GetCredentials.go @@ -11,14 +11,14 @@ import ( "time" ) -// Returns a database user name and temporary password with temporary authorization -// to log in to Amazon Redshift Serverless. By default, the temporary credentials -// expire in 900 seconds. You can optionally specify a duration between 900 seconds -// (15 minutes) and 3600 seconds (60 minutes). The Identity and Access Management -// (IAM) user or role that runs GetCredentials must have an IAM policy attached -// that allows access to all necessary actions and resources. If the DbName -// parameter is specified, the IAM policy must allow access to the resource dbname -// for the specified database name. +// Returns a database user name and temporary password with temporary +// authorization to log in to Amazon Redshift Serverless. By default, the temporary +// credentials expire in 900 seconds. You can optionally specify a duration between +// 900 seconds (15 minutes) and 3600 seconds (60 minutes). The Identity and Access +// Management (IAM) user or role that runs GetCredentials must have an IAM policy +// attached that allows access to all necessary actions and resources. If the +// DbName parameter is specified, the IAM policy must allow access to the resource +// dbname for the specified database name. func (c *Client) GetCredentials(ctx context.Context, params *GetCredentialsInput, optFns ...func(*Options)) (*GetCredentialsOutput, error) { if params == nil { params = &GetCredentialsInput{} @@ -43,26 +43,18 @@ type GetCredentialsInput struct { // The name of the database to get temporary authorization to log on to. // Constraints: - // - // * Must be 1 to 64 alphanumeric characters or hyphens. - // - // * Must - // contain only uppercase or lowercase letters, numbers, underscore, plus sign, - // period (dot), at symbol (@), or hyphen. - // - // * The first character must be a - // letter. - // - // * Must not contain a colon ( : ) or slash ( / ). - // - // * Cannot be a - // reserved word. A list of reserved words can be found in Reserved Words - // (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the - // Amazon Redshift Database Developer Guide + // - Must be 1 to 64 alphanumeric characters or hyphens. + // - Must contain only uppercase or lowercase letters, numbers, underscore, plus + // sign, period (dot), at symbol (@), or hyphen. + // - The first character must be a letter. + // - Must not contain a colon ( : ) or slash ( / ). + // - Cannot be a reserved word. A list of reserved words can be found in + // Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide DbName *string - // The number of seconds until the returned temporary password expires. The minimum - // is 900 seconds, and the maximum is 3600 seconds. + // The number of seconds until the returned temporary password expires. The + // minimum is 900 seconds, and the maximum is 3600 seconds. DurationSeconds *int32 noSmithyDocumentSerde @@ -71,13 +63,13 @@ type GetCredentialsInput struct { type GetCredentialsOutput struct { // A temporary password that authorizes the user name returned by DbUser to log on - // to the database DbName. + // to the database DbName . DbPassword *string // A database user name that is authorized to log on to the database DbName using - // the password DbPassword. If the specified DbUser exists in the database, the new - // user name has the same database privileges as the the user named in DbUser. By - // default, the user is added to PUBLIC. + // the password DbPassword . If the specified DbUser exists in the database, the + // new user name has the same database privileges as the the user named in DbUser . + // By default, the user is added to PUBLIC. DbUser *string // The date and time the password in DbPassword expires. diff --git a/service/redshiftserverless/api_op_ListEndpointAccess.go b/service/redshiftserverless/api_op_ListEndpointAccess.go index e320ca38b74..a39dc890bc0 100644 --- a/service/redshiftserverless/api_op_ListEndpointAccess.go +++ b/service/redshiftserverless/api_op_ListEndpointAccess.go @@ -34,9 +34,9 @@ type ListEndpointAccessInput struct { // You can use nextToken to display the next page of results. MaxResults *int32 - // If your initial ListEndpointAccess operation returns a nextToken, you can - // include the returned nextToken in following ListEndpointAccess operations, which - // returns results in the next page. + // If your initial ListEndpointAccess operation returns a nextToken , you can + // include the returned nextToken in following ListEndpointAccess operations, + // which returns results in the next page. NextToken *string // The unique identifier of the virtual private cloud with access to Amazon diff --git a/service/redshiftserverless/api_op_ListNamespaces.go b/service/redshiftserverless/api_op_ListNamespaces.go index 856d1c6cba4..2145dc84f30 100644 --- a/service/redshiftserverless/api_op_ListNamespaces.go +++ b/service/redshiftserverless/api_op_ListNamespaces.go @@ -34,7 +34,7 @@ type ListNamespacesInput struct { // You can use nextToken to display the next page of results. MaxResults *int32 - // If your initial ListNamespaces operation returns a nextToken, you can include + // If your initial ListNamespaces operation returns a nextToken , you can include // the returned nextToken in following ListNamespaces operations, which returns // results in the next page. NextToken *string diff --git a/service/redshiftserverless/api_op_ListRecoveryPoints.go b/service/redshiftserverless/api_op_ListRecoveryPoints.go index 06c3ab48c91..ec30f85b6f7 100644 --- a/service/redshiftserverless/api_op_ListRecoveryPoints.go +++ b/service/redshiftserverless/api_op_ListRecoveryPoints.go @@ -45,9 +45,9 @@ type ListRecoveryPointsInput struct { // The name of the namespace to list recovery points for. NamespaceName *string - // If your initial ListRecoveryPoints operation returns a nextToken, you can - // include the returned nextToken in following ListRecoveryPoints operations, which - // returns results in the next page. + // If your initial ListRecoveryPoints operation returns a nextToken , you can + // include the returned nextToken in following ListRecoveryPoints operations, + // which returns results in the next page. NextToken *string // The time when the recovery point's creation was initiated. diff --git a/service/redshiftserverless/api_op_ListTableRestoreStatus.go b/service/redshiftserverless/api_op_ListTableRestoreStatus.go index c8bccce0078..83ccb41feea 100644 --- a/service/redshiftserverless/api_op_ListTableRestoreStatus.go +++ b/service/redshiftserverless/api_op_ListTableRestoreStatus.go @@ -52,7 +52,7 @@ type ListTableRestoreStatusInput struct { type ListTableRestoreStatusOutput struct { - // If your initial ListTableRestoreStatus operation returns a nextToken, you can + // If your initial ListTableRestoreStatus operation returns a nextToken , you can // include the returned nextToken in following ListTableRestoreStatus operations. // This will returns results on the next page. NextToken *string diff --git a/service/redshiftserverless/api_op_ListUsageLimits.go b/service/redshiftserverless/api_op_ListUsageLimits.go index 0ed674d1314..41fab38d6b0 100644 --- a/service/redshiftserverless/api_op_ListUsageLimits.go +++ b/service/redshiftserverless/api_op_ListUsageLimits.go @@ -34,7 +34,7 @@ type ListUsageLimitsInput struct { // You can use nextToken to get the next page of results. The default is 100. MaxResults *int32 - // If your initial ListUsageLimits operation returns a nextToken, you can include + // If your initial ListUsageLimits operation returns a nextToken , you can include // the returned nextToken in following ListUsageLimits operations, which returns // results in the next page. NextToken *string diff --git a/service/redshiftserverless/api_op_ListWorkgroups.go b/service/redshiftserverless/api_op_ListWorkgroups.go index abaa82c22c0..eca2f7fb71a 100644 --- a/service/redshiftserverless/api_op_ListWorkgroups.go +++ b/service/redshiftserverless/api_op_ListWorkgroups.go @@ -34,7 +34,7 @@ type ListWorkgroupsInput struct { // You can use nextToken to display the next page of results. MaxResults *int32 - // If your initial ListWorkgroups operation returns a nextToken, you can include + // If your initial ListWorkgroups operation returns a nextToken , you can include // the returned nextToken in following ListNamespaces operations, which returns // results in the next page. NextToken *string diff --git a/service/redshiftserverless/api_op_RestoreFromSnapshot.go b/service/redshiftserverless/api_op_RestoreFromSnapshot.go index 8b62426a8e3..a8fde848454 100644 --- a/service/redshiftserverless/api_op_RestoreFromSnapshot.go +++ b/service/redshiftserverless/api_op_RestoreFromSnapshot.go @@ -44,12 +44,12 @@ type RestoreFromSnapshotInput struct { // The Amazon Resource Name (ARN) of the snapshot to restore from. Required if // restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be - // specified at the same time as snapshotName. The format of the ARN is + // specified at the same time as snapshotName . The format of the ARN is // arn:aws:redshift:::snapshot:/. SnapshotArn *string - // The name of the snapshot to restore from. Must not be specified at the same time - // as snapshotArn. + // The name of the snapshot to restore from. Must not be specified at the same + // time as snapshotArn . SnapshotName *string noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go b/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go index ada9d7a1bf5..01c43076965 100644 --- a/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go +++ b/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go @@ -12,8 +12,8 @@ import ( ) // Restores a table from a snapshot to your Amazon Redshift Serverless instance. -// You can't use this operation to restore tables with interleaved sort keys -// (https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved). +// You can't use this operation to restore tables with interleaved sort keys (https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved) +// . func (c *Client) RestoreTableFromSnapshot(ctx context.Context, params *RestoreTableFromSnapshotInput, optFns ...func(*Options)) (*RestoreTableFromSnapshotOutput, error) { if params == nil { params = &RestoreTableFromSnapshotInput{} diff --git a/service/redshiftserverless/api_op_UpdateNamespace.go b/service/redshiftserverless/api_op_UpdateNamespace.go index e5bb802c4ce..49b38b8441f 100644 --- a/service/redshiftserverless/api_op_UpdateNamespace.go +++ b/service/redshiftserverless/api_op_UpdateNamespace.go @@ -13,8 +13,8 @@ import ( // Updates a namespace with the specified settings. Unless required, you can't // update multiple parameters in one request. For example, you must specify both -// adminUsername and adminUserPassword to update either field, but you can't update -// both kmsKeyId and logExports in a single request. +// adminUsername and adminUserPassword to update either field, but you can't +// update both kmsKeyId and logExports in a single request. func (c *Client) UpdateNamespace(ctx context.Context, params *UpdateNamespaceInput, optFns ...func(*Options)) (*UpdateNamespaceOutput, error) { if params == nil { params = &UpdateNamespaceInput{} @@ -39,27 +39,27 @@ type UpdateNamespaceInput struct { NamespaceName *string // The password of the administrator for the first database created in the - // namespace. This parameter must be updated together with adminUsername. + // namespace. This parameter must be updated together with adminUsername . AdminUserPassword *string // The username of the administrator for the first database created in the - // namespace. This parameter must be updated together with adminUserPassword. + // namespace. This parameter must be updated together with adminUserPassword . AdminUsername *string // The Amazon Resource Name (ARN) of the IAM role to set as a default in the - // namespace. This parameter must be updated together with iamRoles. + // namespace. This parameter must be updated together with iamRoles . DefaultIamRoleArn *string // A list of IAM roles to associate with the namespace. This parameter must be - // updated together with defaultIamRoleArn. + // updated together with defaultIamRoleArn . IamRoles []string // The ID of the Amazon Web Services Key Management Service key used to encrypt // your data. KmsKeyId *string - // The types of logs the namespace can export. The export types are userlog, - // connectionlog, and useractivitylog. + // The types of logs the namespace can export. The export types are userlog , + // connectionlog , and useractivitylog . LogExports []types.LogExport noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_op_UpdateUsageLimit.go b/service/redshiftserverless/api_op_UpdateUsageLimit.go index fb094eb35ae..8dd9d152cc4 100644 --- a/service/redshiftserverless/api_op_UpdateUsageLimit.go +++ b/service/redshiftserverless/api_op_UpdateUsageLimit.go @@ -35,10 +35,10 @@ type UpdateUsageLimitInput struct { // This member is required. UsageLimitId *string - // The new limit amount. If time-based, this amount is in Redshift Processing Units - // (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data - // transferred between Regions in cross-account sharing. The value must be a - // positive number. + // The new limit amount. If time-based, this amount is in Redshift Processing + // Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) + // of data transferred between Regions in cross-account sharing. The value must be + // a positive number. Amount *int64 // The new action that Amazon Redshift Serverless takes when the limit is reached. diff --git a/service/redshiftserverless/api_op_UpdateWorkgroup.go b/service/redshiftserverless/api_op_UpdateWorkgroup.go index ebe4e77b291..ee3f25fed3d 100644 --- a/service/redshiftserverless/api_op_UpdateWorkgroup.go +++ b/service/redshiftserverless/api_op_UpdateWorkgroup.go @@ -41,17 +41,17 @@ type UpdateWorkgroupInput struct { BaseCapacity *int32 // An array of parameters to set for advanced control over a database. The options - // are auto_mv, datestyle, enable_case_sensitivity_identifier, - // enable_user_activity_logging, query_group, search_path, and query monitoring + // are auto_mv , datestyle , enable_case_sensitivity_identifier , + // enable_user_activity_logging , query_group , search_path , and query monitoring // metrics that let you define performance boundaries. For more information about - // query monitoring rules and available metrics, see Query monitoring metrics for - // Amazon Redshift Serverless - // (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless). + // query monitoring rules and available metrics, see Query monitoring metrics for + // Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) + // . ConfigParameters []types.ConfigParameter - // The value that specifies whether to turn on enhanced virtual private cloud (VPC) - // routing, which forces Amazon Redshift Serverless to route traffic through your - // VPC. + // The value that specifies whether to turn on enhanced virtual private cloud + // (VPC) routing, which forces Amazon Redshift Serverless to route traffic through + // your VPC. EnhancedVpcRouting *bool // The custom port to use when connecting to a workgroup. Valid port ranges are diff --git a/service/redshiftserverless/doc.go b/service/redshiftserverless/doc.go index 41eb0374e0e..fe864e69b59 100644 --- a/service/redshiftserverless/doc.go +++ b/service/redshiftserverless/doc.go @@ -12,6 +12,6 @@ // for even the most demanding and volatile workloads. Amazon Redshift Serverless // lets you focus on using your data to acquire new insights for your business and // customers. To learn more about Amazon Redshift Serverless, see What is Amazon -// Redshift Serverless -// (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-whatis.html). +// Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-whatis.html) +// . package redshiftserverless diff --git a/service/redshiftserverless/types/enums.go b/service/redshiftserverless/types/enums.go index 472c4aacc85..0eb1b497e16 100644 --- a/service/redshiftserverless/types/enums.go +++ b/service/redshiftserverless/types/enums.go @@ -11,9 +11,9 @@ const ( LogExportConnectionLog LogExport = "connectionlog" ) -// Values returns all known values for LogExport. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for LogExport. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (LogExport) Values() []LogExport { return []LogExport{ "useractivitylog", diff --git a/service/redshiftserverless/types/types.go b/service/redshiftserverless/types/types.go index 9b9cbfa16e3..f35d051c68b 100644 --- a/service/redshiftserverless/types/types.go +++ b/service/redshiftserverless/types/types.go @@ -11,12 +11,12 @@ import ( // Serverless. type ConfigParameter struct { - // The key of the parameter. The options are auto_mv, datestyle, - // enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, - // search_path, and query monitoring metrics that let you define performance + // The key of the parameter. The options are auto_mv , datestyle , + // enable_case_sensitivity_identifier , enable_user_activity_logging , query_group + // , search_path , and query monitoring metrics that let you define performance // boundaries. For more information about query monitoring rules and available - // metrics, see Query monitoring metrics for Amazon Redshift Serverless - // (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless). + // metrics, see Query monitoring metrics for Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) + // . ParameterKey *string // The value of the parameter to set. @@ -102,8 +102,8 @@ type Namespace struct { // your data. KmsKeyId *string - // The types of logs the namespace can export. Available export types are User log, - // Connection log, and User activity log. + // The types of logs the namespace can export. Available export types are User + // log, Connection log, and User activity log. LogExports []LogExport // The Amazon Resource Name (ARN) associated with a namespace. @@ -114,9 +114,8 @@ type Namespace struct { // The name of the namespace. Must be between 3-64 alphanumeric characters in // lowercase, and it cannot be a reserved word. A list of reserved words can be - // found in Reserved Words - // (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the - // Amazon Redshift Database Developer Guide. + // found in Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) + // in the Amazon Redshift Database Developer Guide. NamespaceName *string // The status of the namespace. @@ -148,8 +147,8 @@ type NetworkInterface struct { // created every 30 minutes and kept for 24 hours. type RecoveryPoint struct { - // The Amazon Resource Name (ARN) of the namespace the recovery point is associated - // with. + // The Amazon Resource Name (ARN) of the namespace the recovery point is + // associated with. NamespaceArn *string // The name of the namespace the recovery point is associated with. @@ -255,7 +254,7 @@ type Snapshot struct { type TableRestoreStatus struct { // A description of the status of the table restore request. Status values include - // SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. + // SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS . Message *string // The namespace of the table being restored from. @@ -284,7 +283,7 @@ type TableRestoreStatus struct { SourceTableName *string // A value that describes the current state of the table restore request. Possible - // values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS. + // values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS . Status *string // The ID of the RestoreTableFromSnapshot request. @@ -352,8 +351,8 @@ type UsageLimit struct { noSmithyDocumentSerde } -// The connection endpoint for connecting to Amazon Redshift Serverless through the -// proxy. +// The connection endpoint for connecting to Amazon Redshift Serverless through +// the proxy. type VpcEndpoint struct { // One or more network interfaces of the endpoint. Also known as an interface @@ -389,12 +388,12 @@ type Workgroup struct { BaseCapacity *int32 // An array of parameters to set for advanced control over a database. The options - // are auto_mv, datestyle, enable_case_sensitivity_identifier, - // enable_user_activity_logging, query_group, , search_path, and query monitoring - // metrics that let you define performance boundaries. For more information about - // query monitoring rules and available metrics, see Query monitoring metrics for - // Amazon Redshift Serverless - // (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless). + // are auto_mv , datestyle , enable_case_sensitivity_identifier , + // enable_user_activity_logging , query_group , , search_path , and query + // monitoring metrics that let you define performance boundaries. For more + // information about query monitoring rules and available metrics, see Query + // monitoring metrics for Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) + // . ConfigParameters []ConfigParameter // The creation date of the workgroup. diff --git a/service/rekognition/api_client.go b/service/rekognition/api_client.go index 41058328540..c9d410d73c6 100644 --- a/service/rekognition/api_client.go +++ b/service/rekognition/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rekognition/api_op_CompareFaces.go b/service/rekognition/api_op_CompareFaces.go index c5ff49cdd38..7ddb220061e 100644 --- a/service/rekognition/api_op_CompareFaces.go +++ b/service/rekognition/api_op_CompareFaces.go @@ -40,10 +40,10 @@ import ( // box of the face and confidence value. The QualityFilter input parameter allows // you to filter out detected faces that don’t meet a required quality bar. The // quality bar is based on a variety of common use cases. Use QualityFilter to set -// the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter -// detected faces, specify NONE. The default value is NONE. If the image doesn't -// contain Exif metadata, CompareFaces returns orientation information for the -// source and target images. Use these values to display the images with the +// the quality bar by specifying LOW , MEDIUM , or HIGH . If you do not want to +// filter detected faces, specify NONE . The default value is NONE . If the image +// doesn't contain Exif metadata, CompareFaces returns orientation information for +// the source and target images. Use these values to display the images with the // correct image orientation. If no faces are detected in the source or target // images, CompareFaces returns an InvalidParameterException error. This is a // stateless API operation. That is, data returned by this operation doesn't @@ -76,29 +76,29 @@ type CompareFacesInput struct { // This member is required. SourceImage *types.Image - // The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI - // to call Amazon Rekognition operations, passing base64-encoded image bytes is not - // supported. If you are using an AWS SDK to call Amazon Rekognition, you might not - // need to base64-encode image bytes passed using the Bytes field. For more + // The target image as base64-encoded bytes or an S3 object. If you use the AWS + // CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is + // not supported. If you are using an AWS SDK to call Amazon Rekognition, you might + // not need to base64-encode image bytes passed using the Bytes field. For more // information, see Images in the Amazon Rekognition developer guide. // // This member is required. TargetImage *types.Image - // A filter that specifies a quality bar for how much filtering is done to identify - // faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition - // chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes - // all faces that don’t meet the chosen quality bar. The quality bar is based on a - // variety of common use cases. Low-quality detections can occur for a number of - // reasons. Some examples are an object that's misidentified as a face, a face - // that's too blurry, or a face with a pose that's too extreme to use. If you - // specify NONE, no filtering is performed. The default value is NONE. To use - // quality filtering, the collection you are using must be associated with version - // 3 of the face model or higher. + // A filter that specifies a quality bar for how much filtering is done to + // identify faces. Filtered faces aren't compared. If you specify AUTO , Amazon + // Rekognition chooses the quality bar. If you specify LOW , MEDIUM , or HIGH , + // filtering removes all faces that don’t meet the chosen quality bar. The quality + // bar is based on a variety of common use cases. Low-quality detections can occur + // for a number of reasons. Some examples are an object that's misidentified as a + // face, a face that's too blurry, or a face with a pose that's too extreme to use. + // If you specify NONE , no filtering is performed. The default value is NONE . To + // use quality filtering, the collection you are using must be associated with + // version 3 of the face model or higher. QualityFilter types.QualityFilter - // The minimum level of confidence in the face matches that a match must meet to be - // included in the FaceMatches array. + // The minimum level of confidence in the face matches that a match must meet to + // be included in the FaceMatches array. SimilarityThreshold *float32 noSmithyDocumentSerde @@ -115,8 +115,8 @@ type CompareFacesOutput struct { // The face in the source image that was used for comparison. SourceImageFace *types.ComparedSourceImageFace - // The value of SourceImageOrientationCorrection is always null. If the input image - // is in .jpeg format, it might contain exchangeable image file format (Exif) + // The value of SourceImageOrientationCorrection is always null. If the input + // image is in .jpeg format, it might contain exchangeable image file format (Exif) // metadata that includes the image's orientation. Amazon Rekognition uses this // orientation information to perform image correction. The bounding box // coordinates are translated to represent object locations after the orientation @@ -128,8 +128,8 @@ type CompareFacesOutput struct { // rotated. SourceImageOrientationCorrection types.OrientationCorrection - // The value of TargetImageOrientationCorrection is always null. If the input image - // is in .jpeg format, it might contain exchangeable image file format (Exif) + // The value of TargetImageOrientationCorrection is always null. If the input + // image is in .jpeg format, it might contain exchangeable image file format (Exif) // metadata that includes the image's orientation. Amazon Rekognition uses this // orientation information to perform image correction. The bounding box // coordinates are translated to represent object locations after the orientation diff --git a/service/rekognition/api_op_CopyProjectVersion.go b/service/rekognition/api_op_CopyProjectVersion.go index 936423bdbe2..1a9cbf22d21 100644 --- a/service/rekognition/api_op_CopyProjectVersion.go +++ b/service/rekognition/api_op_CopyProjectVersion.go @@ -16,8 +16,8 @@ import ( // different AWS accounts but must be in the same AWS Region. You can't copy a // model to another AWS service. To copy a model version to a different AWS // account, you need to create a resource-based policy known as a project policy. -// You attach the project policy to the source project by calling PutProjectPolicy. -// The project policy gives permission to copy the model version from a trusting +// You attach the project policy to the source project by calling PutProjectPolicy +// . The project policy gives permission to copy the model version from a trusting // AWS account to a trusted account. For more information creating and attaching a // project policy, see Attaching a project policy (SDK) in the Amazon Rekognition // Custom Labels Developer Guide. If you are copying a model version to a project @@ -26,7 +26,7 @@ import ( // already exist. Copying a model version takes a while to complete. To get the // current status, call DescribeProjectVersions and check the value of Status in // the ProjectVersionDescription object. The copy operation has finished when the -// value of Status is COPYING_COMPLETED. +// value of Status is COPYING_COMPLETED . func (c *Client) CopyProjectVersion(ctx context.Context, params *CopyProjectVersionInput, optFns ...func(*Options)) (*CopyProjectVersionOutput, error) { if params == nil { params = &CopyProjectVersionInput{} @@ -50,8 +50,8 @@ type CopyProjectVersionInput struct { // This member is required. DestinationProjectArn *string - // The S3 bucket and folder location where the training output for the source model - // version is placed. + // The S3 bucket and folder location where the training output for the source + // model version is placed. // // This member is required. OutputConfig *types.OutputConfig @@ -75,22 +75,15 @@ type CopyProjectVersionInput struct { // The identifier for your AWS Key Management Service key (AWS KMS key). You can // supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, // an alias for your KMS key, or an alias ARN. The key is used to encrypt training - // results and manifest files written to the output Amazon S3 bucket - // (OutputConfig). If you choose to use your own KMS key, you need the following - // permissions on the KMS key. - // - // * kms:CreateGrant - // - // * kms:DescribeKey - // - // * - // kms:GenerateDataKey - // - // * kms:Decrypt - // - // If you don't specify a value for KmsKeyId, - // images copied into the service are encrypted using a key that AWS owns and - // manages. + // results and manifest files written to the output Amazon S3 bucket ( OutputConfig + // ). If you choose to use your own KMS key, you need the following permissions on + // the KMS key. + // - kms:CreateGrant + // - kms:DescribeKey + // - kms:GenerateDataKey + // - kms:Decrypt + // If you don't specify a value for KmsKeyId , images copied into the service are + // encrypted using a key that AWS owns and manages. KmsKeyId *string // The key-value tags to assign to the model version. diff --git a/service/rekognition/api_op_CreateCollection.go b/service/rekognition/api_op_CreateCollection.go index afc5efa9514..556cdda3fd3 100644 --- a/service/rekognition/api_op_CreateCollection.go +++ b/service/rekognition/api_op_CreateCollection.go @@ -10,16 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a collection in an AWS Region. You can add faces to the collection using -// the IndexFaces operation. For example, you might create collections, one for -// each of your application users. A user can then index faces using the IndexFaces -// operation and persist results in a specific collection. Then, a user can search -// the collection for faces in the user-specific container. When you create a -// collection, it is associated with the latest version of the face model version. -// Collection names are case-sensitive. This operation requires permissions to -// perform the rekognition:CreateCollection action. If you want to tag your -// collection, you also require permission to perform the rekognition:TagResource -// operation. +// Creates a collection in an AWS Region. You can add faces to the collection +// using the IndexFaces operation. For example, you might create collections, one +// for each of your application users. A user can then index faces using the +// IndexFaces operation and persist results in a specific collection. Then, a user +// can search the collection for faces in the user-specific container. When you +// create a collection, it is associated with the latest version of the face model +// version. Collection names are case-sensitive. This operation requires +// permissions to perform the rekognition:CreateCollection action. If you want to +// tag your collection, you also require permission to perform the +// rekognition:TagResource operation. func (c *Client) CreateCollection(ctx context.Context, params *CreateCollectionInput, optFns ...func(*Options)) (*CreateCollectionOutput, error) { if params == nil { params = &CreateCollectionInput{} diff --git a/service/rekognition/api_op_CreateDataset.go b/service/rekognition/api_op_CreateDataset.go index 0c9ce02621d..f9e3c9a6332 100644 --- a/service/rekognition/api_op_CreateDataset.go +++ b/service/rekognition/api_op_CreateDataset.go @@ -11,19 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset -// by using an Amazon Sagemaker format manifest file or by copying an existing -// Amazon Rekognition Custom Labels dataset. To create a training dataset for a -// project, specify train for the value of DatasetType. To create the test dataset -// for a project, specify test for the value of DatasetType. The response from -// CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a -// dataset takes a while to complete. Use DescribeDataset to check the current +// Creates a new Amazon Rekognition Custom Labels dataset. You can create a +// dataset by using an Amazon Sagemaker format manifest file or by copying an +// existing Amazon Rekognition Custom Labels dataset. To create a training dataset +// for a project, specify train for the value of DatasetType . To create the test +// dataset for a project, specify test for the value of DatasetType . The response +// from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating +// a dataset takes a while to complete. Use DescribeDataset to check the current // status. The dataset created successfully if the value of Status is -// CREATE_COMPLETE. To check if any non-terminal errors occurred, call -// ListDatasetEntries and check for the presence of errors lists in the JSON Lines. -// Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). -// Currently, you can't access the terminal error information. For more -// information, see Creating dataset in the Amazon Rekognition Custom Labels +// CREATE_COMPLETE . To check if any non-terminal errors occurred, call +// ListDatasetEntries and check for the presence of errors lists in the JSON +// Lines. Dataset creation fails if a terminal error occurs ( Status = +// CREATE_FAILED ). Currently, you can't access the terminal error information. For +// more information, see Creating dataset in the Amazon Rekognition Custom Labels // Developer Guide. This operation requires permissions to perform the // rekognition:CreateDataset action. If you want to copy an existing dataset, you // also require permission to perform the rekognition:ListDatasetEntries action. @@ -56,11 +56,11 @@ type CreateDatasetInput struct { // This member is required. ProjectArn *string - // The source files for the dataset. You can specify the ARN of an existing dataset - // or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest - // file. If you don't specify datasetSource, an empty dataset is created. To add - // labeled images to the dataset, You can use the console or call - // UpdateDatasetEntries. + // The source files for the dataset. You can specify the ARN of an existing + // dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format + // manifest file. If you don't specify datasetSource , an empty dataset is created. + // To add labeled images to the dataset, You can use the console or call + // UpdateDatasetEntries . DatasetSource *types.DatasetSource noSmithyDocumentSerde diff --git a/service/rekognition/api_op_CreateProjectVersion.go b/service/rekognition/api_op_CreateProjectVersion.go index 48ccf7642c3..214285ecb04 100644 --- a/service/rekognition/api_op_CreateProjectVersion.go +++ b/service/rekognition/api_op_CreateProjectVersion.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new version of a model and begins training. Models are managed as part -// of an Amazon Rekognition Custom Labels project. The response from +// Creates a new version of a model and begins training. Models are managed as +// part of an Amazon Rekognition Custom Labels project. The response from // CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the // model. Training uses the training and test datasets associated with the project. // For more information, see Creating training and test dataset in the Amazon @@ -25,14 +25,14 @@ import ( // project without associated datasets, we recommend that you use the manifest // files to create training and test datasets for the project. Training takes a // while to complete. You can get the current status by calling -// DescribeProjectVersions. Training completed successfully if the value of the -// Status field is TRAINING_COMPLETED. If training fails, see Debugging a failed +// DescribeProjectVersions . Training completed successfully if the value of the +// Status field is TRAINING_COMPLETED . If training fails, see Debugging a failed // model training in the Amazon Rekognition Custom Labels developer guide. Once // training has successfully completed, call DescribeProjectVersions to get the // training results and evaluate the model. For more information, see Improving a // trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom // Labels developers guide. After evaluating the model, you start the model by -// calling StartProjectVersion. This operation requires permissions to perform the +// calling StartProjectVersion . This operation requires permissions to perform the // rekognition:CreateProjectVersion action. func (c *Client) CreateProjectVersion(ctx context.Context, params *CreateProjectVersionInput, optFns ...func(*Options)) (*CreateProjectVersionOutput, error) { if params == nil { @@ -74,34 +74,27 @@ type CreateProjectVersionInput struct { // an alias for your KMS key, or an alias ARN. The key is used to encrypt training // and test images copied into the service for model training. Your source images // are unaffected. The key is also used to encrypt training results and manifest - // files written to the output Amazon S3 bucket (OutputConfig). If you choose to + // files written to the output Amazon S3 bucket ( OutputConfig ). If you choose to // use your own KMS key, you need the following permissions on the KMS key. - // - // * - // kms:CreateGrant - // - // * kms:DescribeKey - // - // * kms:GenerateDataKey - // - // * kms:Decrypt - // - // If you - // don't specify a value for KmsKeyId, images copied into the service are encrypted - // using a key that AWS owns and manages. + // - kms:CreateGrant + // - kms:DescribeKey + // - kms:GenerateDataKey + // - kms:Decrypt + // If you don't specify a value for KmsKeyId , images copied into the service are + // encrypted using a key that AWS owns and manages. KmsKeyId *string // A set of tags (key-value pairs) that you want to attach to the model. Tags map[string]string // Specifies an external manifest that the service uses to test the model. If you - // specify TestingData you must also specify TrainingData. The project must not + // specify TestingData you must also specify TrainingData . The project must not // have any associated datasets. TestingData *types.TestingData - // Specifies an external manifest that the services uses to train the model. If you - // specify TrainingData you must also specify TestingData. The project must not - // have any associated datasets. + // Specifies an external manifest that the services uses to train the model. If + // you specify TrainingData you must also specify TestingData . The project must + // not have any associated datasets. TrainingData *types.TrainingData noSmithyDocumentSerde @@ -109,8 +102,8 @@ type CreateProjectVersionInput struct { type CreateProjectVersionOutput struct { - // The ARN of the model version that was created. Use DescribeProjectVersion to get - // the current status of the training operation. + // The ARN of the model version that was created. Use DescribeProjectVersion to + // get the current status of the training operation. ProjectVersionArn *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_CreateStreamProcessor.go b/service/rekognition/api_op_CreateStreamProcessor.go index c8bf0e25d3e..77058b430d1 100644 --- a/service/rekognition/api_op_CreateStreamProcessor.go +++ b/service/rekognition/api_op_CreateStreamProcessor.go @@ -16,32 +16,28 @@ import ( // Video is a consumer of live video from Amazon Kinesis Video Streams. There are // two different settings for stream processors in Amazon Rekognition: detecting // faces and detecting labels. +// - If you are creating a stream processor for detecting faces, you provide as +// input a Kinesis video stream ( Input ) and a Kinesis data stream ( Output ) +// stream. You also specify the face recognition criteria in Settings . For +// example, the collection containing faces that you want to recognize. After you +// have finished analyzing a streaming video, use StopStreamProcessor to stop +// processing. +// - If you are creating a stream processor to detect labels, you provide as +// input a Kinesis video stream ( Input ), Amazon S3 bucket information ( Output +// ), and an Amazon SNS topic ARN ( NotificationChannel ). You can also provide a +// KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what +// you want to detect in ConnectedHomeSettings , such as people, packages and +// people, or pets, people, and packages. You can also specify where in the frame +// you want Amazon Rekognition to monitor with RegionsOfInterest . When you run +// the StartStreamProcessor operation on a label detection stream processor, you +// input start and stop information to determine the length of the processing time. // -// * If you are creating a stream processor for -// detecting faces, you provide as input a Kinesis video stream (Input) and a -// Kinesis data stream (Output) stream. You also specify the face recognition -// criteria in Settings. For example, the collection containing faces that you want -// to recognize. After you have finished analyzing a streaming video, use -// StopStreamProcessor to stop processing. -// -// * If you are creating a stream -// processor to detect labels, you provide as input a Kinesis video stream (Input), -// Amazon S3 bucket information (Output), and an Amazon SNS topic ARN -// (NotificationChannel). You can also provide a KMS key ID to encrypt the data -// sent to your Amazon S3 bucket. You specify what you want to detect in -// ConnectedHomeSettings, such as people, packages and people, or pets, people, and -// packages. You can also specify where in the frame you want Amazon Rekognition to -// monitor with RegionsOfInterest. When you run the StartStreamProcessor operation -// on a label detection stream processor, you input start and stop information to -// determine the length of the processing time. -// -// Use Name to assign an identifier -// for the stream processor. You use Name to manage the stream processor. For -// example, you can start processing the source video by calling -// StartStreamProcessor with the Name field. This operation requires permissions to -// perform the rekognition:CreateStreamProcessor action. If you want to tag your -// stream processor, you also require permission to perform the -// rekognition:TagResource operation. +// Use Name to assign an identifier for the stream processor. You use Name to +// manage the stream processor. For example, you can start processing the source +// video by calling StartStreamProcessor with the Name field. This operation +// requires permissions to perform the rekognition:CreateStreamProcessor action. +// If you want to tag your stream processor, you also require permission to perform +// the rekognition:TagResource operation. func (c *Client) CreateStreamProcessor(ctx context.Context, params *CreateStreamProcessorInput, optFns ...func(*Options)) (*CreateStreamProcessorOutput, error) { if params == nil { params = &CreateStreamProcessorInput{} @@ -59,16 +55,16 @@ func (c *Client) CreateStreamProcessor(ctx context.Context, params *CreateStream type CreateStreamProcessorInput struct { - // Kinesis video stream stream that provides the source streaming video. If you are - // using the AWS CLI, the parameter name is StreamProcessorInput. This is required - // for both face search and label detection stream processors. + // Kinesis video stream stream that provides the source streaming video. If you + // are using the AWS CLI, the parameter name is StreamProcessorInput . This is + // required for both face search and label detection stream processors. // // This member is required. Input *types.StreamProcessorInput - // An identifier you assign to the stream processor. You can use Name to manage the - // stream processor. For example, you can get the current status of the stream - // processor by calling DescribeStreamProcessor. Name is idempotent. This is + // An identifier you assign to the stream processor. You can use Name to manage + // the stream processor. For example, you can get the current status of the stream + // processor by calling DescribeStreamProcessor . Name is idempotent. This is // required for both face search and label detection stream processors. // // This member is required. @@ -76,7 +72,7 @@ type CreateStreamProcessorInput struct { // Kinesis data stream stream or Amazon S3 bucket location to which Amazon // Rekognition Video puts the analysis results. If you are using the AWS CLI, the - // parameter name is StreamProcessorOutput. This must be a S3Destination of an + // parameter name is StreamProcessorOutput . This must be a S3Destination of an // Amazon S3 bucket that you own for a label detection stream processor or a // Kinesis data stream ARN for a face search stream processor. // @@ -105,13 +101,13 @@ type CreateStreamProcessorInput struct { // individual streams. DataSharingPreference *types.StreamProcessorDataSharingPreference - // The identifier for your AWS Key Management Service key (AWS KMS key). This is an - // optional parameter for label detection stream processors and should not be used - // to create a face search stream processor. You can supply the Amazon Resource - // Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, - // or an alias ARN. The key is used to encrypt results and data published to your - // Amazon S3 bucket, which includes image frames and hero images. Your source - // images are unaffected. + // The identifier for your AWS Key Management Service key (AWS KMS key). This is + // an optional parameter for label detection stream processors and should not be + // used to create a face search stream processor. You can supply the Amazon + // Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your + // KMS key, or an alias ARN. The key is used to encrypt results and data published + // to your Amazon S3 bucket, which includes image frames and hero images. Your + // source images are unaffected. KmsKeyId *string // The Amazon Simple Notification Service topic to which Amazon Rekognition @@ -125,11 +121,11 @@ type CreateStreamProcessorInput struct { // processing session is complete. NotificationChannel *types.StreamProcessorNotificationChannel - // Specifies locations in the frames where Amazon Rekognition checks for objects or - // people. You can specify up to 10 regions of interest, and each region has either - // a polygon or a bounding box. This is an optional parameter for label detection - // stream processors and should not be used to create a face search stream - // processor. + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. You can specify up to 10 regions of interest, and each region has + // either a polygon or a bounding box. This is an optional parameter for label + // detection stream processors and should not be used to create a face search + // stream processor. RegionsOfInterest []types.RegionOfInterest // A set of tags (key-value pairs) that you want to attach to the stream processor. diff --git a/service/rekognition/api_op_DeleteCollection.go b/service/rekognition/api_op_DeleteCollection.go index 8902fdf5059..76a8272219e 100644 --- a/service/rekognition/api_op_DeleteCollection.go +++ b/service/rekognition/api_op_DeleteCollection.go @@ -11,10 +11,9 @@ import ( ) // Deletes the specified collection. Note that this operation removes all faces in -// the collection. For an example, see Deleting a collection -// (https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html). -// This operation requires permissions to perform the rekognition:DeleteCollection -// action. +// the collection. For an example, see Deleting a collection (https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html) +// . This operation requires permissions to perform the +// rekognition:DeleteCollection action. func (c *Client) DeleteCollection(ctx context.Context, params *DeleteCollectionInput, optFns ...func(*Options)) (*DeleteCollectionOutput, error) { if params == nil { params = &DeleteCollectionInput{} diff --git a/service/rekognition/api_op_DeleteDataset.go b/service/rekognition/api_op_DeleteDataset.go index ac858b63cc5..a9e789943fc 100644 --- a/service/rekognition/api_op_DeleteDataset.go +++ b/service/rekognition/api_op_DeleteDataset.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset -// might take while. Use DescribeDataset to check the current status. The dataset -// is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to -// access the dataset after it is deleted, you get a ResourceNotFoundException -// exception. You can't delete a dataset while it is creating (Status = -// CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS). -// This operation requires permissions to perform the rekognition:DeleteDataset -// action. +// Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a +// dataset might take while. Use DescribeDataset to check the current status. The +// dataset is still deleting if the value of Status is DELETE_IN_PROGRESS . If you +// try to access the dataset after it is deleted, you get a +// ResourceNotFoundException exception. You can't delete a dataset while it is +// creating ( Status = CREATE_IN_PROGRESS ) or if the dataset is updating ( Status +// = UPDATE_IN_PROGRESS ). This operation requires permissions to perform the +// rekognition:DeleteDataset action. func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} diff --git a/service/rekognition/api_op_DeleteProject.go b/service/rekognition/api_op_DeleteProject.go index 0718f610856..d4667a59b6f 100644 --- a/service/rekognition/api_op_DeleteProject.go +++ b/service/rekognition/api_op_DeleteProject.go @@ -13,8 +13,8 @@ import ( // Deletes an Amazon Rekognition Custom Labels project. To delete a project you // must first delete all models associated with the project. To delete a model, see -// DeleteProjectVersion. DeleteProject is an asynchronous operation. To check if -// the project is deleted, call DescribeProjects. The project is deleted when the +// DeleteProjectVersion . DeleteProject is an asynchronous operation. To check if +// the project is deleted, call DescribeProjects . The project is deleted when the // project no longer appears in the response. Be aware that deleting a given // project will also delete any ProjectPolicies associated with that project. This // operation requires permissions to perform the rekognition:DeleteProject action. diff --git a/service/rekognition/api_op_DeleteProjectPolicy.go b/service/rekognition/api_op_DeleteProjectPolicy.go index db207ce63f6..509e32673c7 100644 --- a/service/rekognition/api_op_DeleteProjectPolicy.go +++ b/service/rekognition/api_op_DeleteProjectPolicy.go @@ -11,8 +11,8 @@ import ( ) // Deletes an existing project policy. To get a list of project policies attached -// to a project, call ListProjectPolicies. To attach a project policy to a project, -// call PutProjectPolicy. +// to a project, call ListProjectPolicies . To attach a project policy to a +// project, call PutProjectPolicy . func (c *Client) DeleteProjectPolicy(ctx context.Context, params *DeleteProjectPolicyInput, optFns ...func(*Options)) (*DeleteProjectPolicyOutput, error) { if params == nil { params = &DeleteProjectPolicyInput{} diff --git a/service/rekognition/api_op_DeleteProjectVersion.go b/service/rekognition/api_op_DeleteProjectVersion.go index 709408e8241..753c0b63afd 100644 --- a/service/rekognition/api_op_DeleteProjectVersion.go +++ b/service/rekognition/api_op_DeleteProjectVersion.go @@ -13,8 +13,8 @@ import ( // Deletes an Amazon Rekognition Custom Labels model. You can't delete a model if // it is running or if it is training. To check the status of a model, use the -// Status field returned from DescribeProjectVersions. To stop a running model call -// StopProjectVersion. If the model is training, wait until it finishes. This +// Status field returned from DescribeProjectVersions . To stop a running model +// call StopProjectVersion . If the model is training, wait until it finishes. This // operation requires permissions to perform the rekognition:DeleteProjectVersion // action. func (c *Client) DeleteProjectVersion(ctx context.Context, params *DeleteProjectVersionInput, optFns ...func(*Options)) (*DeleteProjectVersionOutput, error) { diff --git a/service/rekognition/api_op_DeleteStreamProcessor.go b/service/rekognition/api_op_DeleteStreamProcessor.go index 0ee681ecc1b..35ed0324b83 100644 --- a/service/rekognition/api_op_DeleteStreamProcessor.go +++ b/service/rekognition/api_op_DeleteStreamProcessor.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the stream processor identified by Name. You assign the value for Name -// when you create the stream processor with CreateStreamProcessor. You might not +// Deletes the stream processor identified by Name . You assign the value for Name +// when you create the stream processor with CreateStreamProcessor . You might not // be able to use the same name for a stream processor for a few seconds after -// calling DeleteStreamProcessor. +// calling DeleteStreamProcessor . func (c *Client) DeleteStreamProcessor(ctx context.Context, params *DeleteStreamProcessorInput, optFns ...func(*Options)) (*DeleteStreamProcessorOutput, error) { if params == nil { params = &DeleteStreamProcessorInput{} diff --git a/service/rekognition/api_op_DescribeCollection.go b/service/rekognition/api_op_DescribeCollection.go index 935979dd0ab..f7beb5588ea 100644 --- a/service/rekognition/api_op_DescribeCollection.go +++ b/service/rekognition/api_op_DescribeCollection.go @@ -52,7 +52,7 @@ type DescribeCollectionOutput struct { CreationTimestamp *time.Time // The number of faces that are indexed into the collection. To index faces into a - // collection, use IndexFaces. + // collection, use IndexFaces . FaceCount *int64 // The version of the face model that's used by the collection for face detection. diff --git a/service/rekognition/api_op_DescribeProjectVersions.go b/service/rekognition/api_op_DescribeProjectVersions.go index 721ef09253d..7cc153d02b2 100644 --- a/service/rekognition/api_op_DescribeProjectVersions.go +++ b/service/rekognition/api_op_DescribeProjectVersions.go @@ -17,7 +17,7 @@ import ( ) // Lists and describes the versions of a model in an Amazon Rekognition Custom -// Labels project. You can specify up to 10 model versions in ProjectVersionArns. +// Labels project. You can specify up to 10 model versions in ProjectVersionArns . // If you don't specify a value, descriptions for all model versions in the project // are returned. This operation requires permissions to perform the // rekognition:DescribeProjectVersions action. @@ -59,7 +59,8 @@ type DescribeProjectVersionsInput struct { // descriptions are returned. A version name is part of a model (ProjectVersion) // ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the // following ARN. - // arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123. + // arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123 + // . VersionNames []string noSmithyDocumentSerde @@ -253,9 +254,10 @@ type ProjectVersionRunningWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ProjectVersionRunningWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ProjectVersionRunningWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -454,10 +456,10 @@ type ProjectVersionTrainingCompletedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ProjectVersionTrainingCompletedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ProjectVersionTrainingCompletedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/rekognition/api_op_DescribeStreamProcessor.go b/service/rekognition/api_op_DescribeStreamProcessor.go index f84b612ac6f..e36c919713a 100644 --- a/service/rekognition/api_op_DescribeStreamProcessor.go +++ b/service/rekognition/api_op_DescribeStreamProcessor.go @@ -12,7 +12,7 @@ import ( "time" ) -// Provides information about a stream processor created by CreateStreamProcessor. +// Provides information about a stream processor created by CreateStreamProcessor . // You can get information about the input and output streams, the input parameters // for the face recognition being performed, and the current status of the stream // processor. @@ -55,8 +55,8 @@ type DescribeStreamProcessorOutput struct { // Kinesis video stream that provides the source streaming video. Input *types.StreamProcessorInput - // The identifier for your AWS Key Management Service key (AWS KMS key). This is an - // optional parameter for label detection stream processors. + // The identifier for your AWS Key Management Service key (AWS KMS key). This is + // an optional parameter for label detection stream processors. KmsKeyId *string // The time, in Unix format, the stream processor was last updated. For example, @@ -81,8 +81,8 @@ type DescribeStreamProcessorOutput struct { // Kinesis data stream to which Amazon Rekognition Video puts the analysis results. Output *types.StreamProcessorOutput - // Specifies locations in the frames where Amazon Rekognition checks for objects or - // people. This is an optional parameter for label detection stream processors. + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. This is an optional parameter for label detection stream processors. RegionsOfInterest []types.RegionOfInterest // ARN of the IAM role that allows access to the stream processor. diff --git a/service/rekognition/api_op_DetectCustomLabels.go b/service/rekognition/api_op_DetectCustomLabels.go index f2d7f67f29a..0bfbad6dd46 100644 --- a/service/rekognition/api_op_DetectCustomLabels.go +++ b/service/rekognition/api_op_DetectCustomLabels.go @@ -17,22 +17,22 @@ import ( // image bytes or as a reference to an image in an Amazon S3 bucket. If you use the // AWS CLI to call Amazon Rekognition operations, passing image bytes is not // supported. The image must be either a PNG or JPEG formatted file. For each -// object that the model version detects on an image, the API returns a -// (CustomLabel) object in an array (CustomLabels). Each CustomLabel object -// provides the label name (Name), the level of confidence that the image contains -// the object (Confidence), and object location information, if it exists, for the -// label on the image (Geometry). To filter labels that are returned, specify a -// value for MinConfidence. DetectCustomLabelsLabels only returns labels with a -// confidence that's higher than the specified value. The value of MinConfidence -// maps to the assumed threshold values created during training. For more -// information, see Assumed threshold in the Amazon Rekognition Custom Labels -// Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed -// threshold as a floating point value between 0-1. The range of MinConfidence -// normalizes the threshold value to a percentage value (0-100). Confidence -// responses from DetectCustomLabels are also returned as a percentage. You can use -// MinConfidence to change the precision and recall or your model. For more -// information, see Analyzing an image in the Amazon Rekognition Custom Labels -// Developer Guide. If you don't specify a value for MinConfidence, +// object that the model version detects on an image, the API returns a ( +// CustomLabel ) object in an array ( CustomLabels ). Each CustomLabel object +// provides the label name ( Name ), the level of confidence that the image +// contains the object ( Confidence ), and object location information, if it +// exists, for the label on the image ( Geometry ). To filter labels that are +// returned, specify a value for MinConfidence . DetectCustomLabelsLabels only +// returns labels with a confidence that's higher than the specified value. The +// value of MinConfidence maps to the assumed threshold values created during +// training. For more information, see Assumed threshold in the Amazon Rekognition +// Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics +// expresses an assumed threshold as a floating point value between 0-1. The range +// of MinConfidence normalizes the threshold value to a percentage value (0-100). +// Confidence responses from DetectCustomLabels are also returned as a percentage. +// You can use MinConfidence to change the precision and recall or your model. For +// more information, see Analyzing an image in the Amazon Rekognition Custom Labels +// Developer Guide. If you don't specify a value for MinConfidence , // DetectCustomLabels returns labels based on the assumed threshold of each label. // This is a stateless API operation. That is, the operation does not persist any // data. This operation requires permissions to perform the @@ -56,22 +56,22 @@ func (c *Client) DetectCustomLabels(ctx context.Context, params *DetectCustomLab type DetectCustomLabelsInput struct { // Provides the input image either as bytes or an S3 object. You pass image bytes - // to an Amazon Rekognition API operation by using the Bytes property. For example, - // you would use the Bytes property to pass an image loaded from a local file - // system. Image bytes passed by using the Bytes property must be base64-encoded. - // Your code may not need to encode image bytes if you are using an AWS SDK to call - // Amazon Rekognition API operations. For more information, see Analyzing an Image - // Loaded from a Local File System in the Amazon Rekognition Developer Guide. You - // pass images stored in an S3 bucket to an Amazon Rekognition API operation by - // using the S3Object property. Images stored in an S3 bucket do not need to be - // base64-encoded. The region for the S3 bucket containing the S3 object must match - // the region you use for Amazon Rekognition operations. If you use the AWS CLI to - // call Amazon Rekognition operations, passing image bytes using the Bytes property - // is not supported. You must first upload the image to an Amazon S3 bucket and - // then call the operation using the S3Object property. For Amazon Rekognition to - // process an S3 object, the user must have permission to access the S3 object. For - // more information, see How Amazon Rekognition works with IAM in the Amazon - // Rekognition Developer Guide. + // to an Amazon Rekognition API operation by using the Bytes property. For + // example, you would use the Bytes property to pass an image loaded from a local + // file system. Image bytes passed by using the Bytes property must be + // base64-encoded. Your code may not need to encode image bytes if you are using an + // AWS SDK to call Amazon Rekognition API operations. For more information, see + // Analyzing an Image Loaded from a Local File System in the Amazon Rekognition + // Developer Guide. You pass images stored in an S3 bucket to an Amazon Rekognition + // API operation by using the S3Object property. Images stored in an S3 bucket do + // not need to be base64-encoded. The region for the S3 bucket containing the S3 + // object must match the region you use for Amazon Rekognition operations. If you + // use the AWS CLI to call Amazon Rekognition operations, passing image bytes using + // the Bytes property is not supported. You must first upload the image to an + // Amazon S3 bucket and then call the operation using the S3Object property. For + // Amazon Rekognition to process an S3 object, the user must have permission to + // access the S3 object. For more information, see How Amazon Rekognition works + // with IAM in the Amazon Rekognition Developer Guide. // // This member is required. Image *types.Image @@ -90,7 +90,7 @@ type DetectCustomLabelsInput struct { // DetectCustomLabels doesn't return any labels with a confidence value that's // lower than this specified value. If you specify a value of 0, DetectCustomLabels // returns all labels, regardless of the assumed threshold applied to each label. - // If you don't specify a value for MinConfidence, DetectCustomLabels returns + // If you don't specify a value for MinConfidence , DetectCustomLabels returns // labels based on the assumed threshold of each label. MinConfidence *float32 diff --git a/service/rekognition/api_op_DetectFaces.go b/service/rekognition/api_op_DetectFaces.go index a6e1ae63a87..e126b684887 100644 --- a/service/rekognition/api_op_DetectFaces.go +++ b/service/rekognition/api_op_DetectFaces.go @@ -11,20 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detects faces within an image that is provided as input. DetectFaces detects the -// 100 largest faces in the image. For each face detected, the operation returns -// face details. These details include a bounding box of the face, a confidence -// value (that the bounding box contains a face), and a fixed set of attributes -// such as facial landmarks (for example, coordinates of eye and mouth), presence -// of beard, sunglasses, and so on. The face-detection algorithm is most effective -// on frontal faces. For non-frontal or obscured faces, the algorithm might not -// detect the faces or might detect faces with lower confidence. You pass the input -// image either as base64-encoded image bytes or as a reference to an image in an -// Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, -// passing image bytes is not supported. The image must be either a PNG or JPEG -// formatted file. This is a stateless API operation. That is, the operation does -// not persist any data. This operation requires permissions to perform the -// rekognition:DetectFaces action. +// Detects faces within an image that is provided as input. DetectFaces detects +// the 100 largest faces in the image. For each face detected, the operation +// returns face details. These details include a bounding box of the face, a +// confidence value (that the bounding box contains a face), and a fixed set of +// attributes such as facial landmarks (for example, coordinates of eye and mouth), +// presence of beard, sunglasses, and so on. The face-detection algorithm is most +// effective on frontal faces. For non-frontal or obscured faces, the algorithm +// might not detect the faces or might detect faces with lower confidence. You pass +// the input image either as base64-encoded image bytes or as a reference to an +// image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition +// operations, passing image bytes is not supported. The image must be either a PNG +// or JPEG formatted file. This is a stateless API operation. That is, the +// operation does not persist any data. This operation requires permissions to +// perform the rekognition:DetectFaces action. func (c *Client) DetectFaces(ctx context.Context, params *DetectFacesInput, optFns ...func(*Options)) (*DetectFacesOutput, error) { if params == nil { params = &DetectFacesInput{} @@ -53,12 +53,12 @@ type DetectFacesInput struct { // An array of facial attributes you want to be returned. This can be the default // list of attributes or all attributes. If you don't specify a value for - // Attributes or if you specify ["DEFAULT"], the API returns the following subset - // of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If - // you provide ["ALL"], all facial attributes are returned, but the operation takes - // longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a - // logical AND operator to determine which attributes to return (in this case, all - // attributes). + // Attributes or if you specify ["DEFAULT"] , the API returns the following subset + // of facial attributes: BoundingBox , Confidence , Pose , Quality , and Landmarks + // . If you provide ["ALL"] , all facial attributes are returned, but the operation + // takes longer to complete. If you provide both, ["ALL", "DEFAULT"] , the service + // uses a logical AND operator to determine which attributes to return (in this + // case, all attributes). Attributes []types.Attribute noSmithyDocumentSerde diff --git a/service/rekognition/api_op_DetectLabels.go b/service/rekognition/api_op_DetectLabels.go index a9d6a5915e1..eb01757483a 100644 --- a/service/rekognition/api_op_DetectLabels.go +++ b/service/rekognition/api_op_DetectLabels.go @@ -28,83 +28,63 @@ import ( // You can filter with sets of individual labels or with label categories. You can // specify inclusive filters, exclusive filters, or a combination of inclusive and // exclusive filters. For more information on filtering see Detecting Labels in an -// Image -// (https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html). -// You can specify MinConfidence to control the confidence threshold for the labels -// returned. The default is 55%. You can also add the MaxLabels parameter to limit -// the number of labels returned. The default and upper limit is 1000 labels. -// Response Elements For each object, scene, and concept the API returns one or -// more labels. The API returns the following types of information regarding +// Image (https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html) +// . You can specify MinConfidence to control the confidence threshold for the +// labels returned. The default is 55%. You can also add the MaxLabels parameter +// to limit the number of labels returned. The default and upper limit is 1000 +// labels. Response Elements For each object, scene, and concept the API returns +// one or more labels. The API returns the following types of information regarding // labels: -// -// * Name - The name of the detected label. -// -// * Confidence - The level of -// confidence in the label assigned to a detected object. -// -// * Parents - The ancestor -// labels for a detected label. DetectLabels returns a hierarchical taxonomy of -// detected labels. For example, a detected car might be assigned the label car. -// The label car has two parent labels: Vehicle (its parent) and Transportation -// (its grandparent). The response includes the all ancestors for a label, where -// every ancestor is a unique label. In the previous example, Car, Vehicle, and -// Transportation are returned as unique labels in the response. -// -// * Aliases - -// Possible Aliases for the label. -// -// * Categories - The label categories that the -// detected label belongs to. -// -// * BoundingBox — Bounding boxes are described for all -// instances of detected common object labels, returned in an array of Instance -// objects. An Instance object contains a BoundingBox object, describing the -// location of the label on the input image. It also includes the confidence for -// the accuracy of the detected bounding box. -// -// The API returns the following -// information regarding the image, as part of the ImageProperties structure: -// -// * -// Quality - Information about the Sharpness, Brightness, and Contrast of the input -// image, scored between 0 to 100. Image quality is returned for the entire image, -// as well as the background and the foreground. -// -// * Dominant Color - An array of -// the dominant colors in the image. -// -// * Foreground - Information about the -// sharpness, brightness, and dominant colors of the input image’s foreground. -// -// * -// Background - Information about the sharpness, brightness, and dominant colors of -// the input image’s background. -// -// The list of returned labels will include at least -// one label for every detected object, along with information about that label. In -// the following example, suppose the input image has a lighthouse, the sea, and a -// rock. The response includes all three labels, one for each object, as well as -// the confidence in the label: {Name: lighthouse, Confidence: 98.4629} -// -// {Name: -// -// rock,Confidence: 79.2097} -// -// {Name: sea,Confidence: 75.061} The list of labels can -// include multiple labels for the same object. For example, if the input image -// shows a flower (for example, a tulip), the operation might return the following -// three labels. {Name: flower,Confidence: 99.0562} -// -// {Name: plant,Confidence: -// -// 99.0562} -// -// {Name: tulip,Confidence: 99.0562} In this example, the detection -// algorithm more precisely identifies the flower as a tulip. If the object -// detected is a person, the operation doesn't provide the same facial details that -// the DetectFaces operation provides. This is a stateless API operation. That is, -// the operation does not persist any data. This operation requires permissions to -// perform the rekognition:DetectLabels action. +// - Name - The name of the detected label. +// - Confidence - The level of confidence in the label assigned to a detected +// object. +// - Parents - The ancestor labels for a detected label. DetectLabels returns a +// hierarchical taxonomy of detected labels. For example, a detected car might be +// assigned the label car. The label car has two parent labels: Vehicle (its +// parent) and Transportation (its grandparent). The response includes the all +// ancestors for a label, where every ancestor is a unique label. In the previous +// example, Car, Vehicle, and Transportation are returned as unique labels in the +// response. +// - Aliases - Possible Aliases for the label. +// - Categories - The label categories that the detected label belongs to. +// - BoundingBox — Bounding boxes are described for all instances of detected +// common object labels, returned in an array of Instance objects. An Instance +// object contains a BoundingBox object, describing the location of the label on +// the input image. It also includes the confidence for the accuracy of the +// detected bounding box. +// +// The API returns the following information regarding the image, as part of the +// ImageProperties structure: +// - Quality - Information about the Sharpness, Brightness, and Contrast of the +// input image, scored between 0 to 100. Image quality is returned for the entire +// image, as well as the background and the foreground. +// - Dominant Color - An array of the dominant colors in the image. +// - Foreground - Information about the sharpness, brightness, and dominant +// colors of the input image’s foreground. +// - Background - Information about the sharpness, brightness, and dominant +// colors of the input image’s background. +// +// The list of returned labels will include at least one label for every detected +// object, along with information about that label. In the following example, +// suppose the input image has a lighthouse, the sea, and a rock. The response +// includes all three labels, one for each object, as well as the confidence in the +// label: {Name: lighthouse, Confidence: 98.4629} +// +// {Name: rock,Confidence: 79.2097} +// +// {Name: sea,Confidence: 75.061} The list of labels can include multiple labels +// for the same object. For example, if the input image shows a flower (for +// example, a tulip), the operation might return the following three labels. +// {Name: flower,Confidence: 99.0562} +// +// {Name: plant,Confidence: 99.0562} +// +// {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more +// precisely identifies the flower as a tulip. If the object detected is a person, +// the operation doesn't provide the same facial details that the DetectFaces +// operation provides. This is a stateless API operation. That is, the operation +// does not persist any data. This operation requires permissions to perform the +// rekognition:DetectLabels action. func (c *Client) DetectLabels(ctx context.Context, params *DetectLabelsInput, optFns ...func(*Options)) (*DetectLabelsOutput, error) { if params == nil { params = &DetectLabelsInput{} diff --git a/service/rekognition/api_op_DetectModerationLabels.go b/service/rekognition/api_op_DetectModerationLabels.go index 37519fb6046..1df0ab6e9af 100644 --- a/service/rekognition/api_op_DetectModerationLabels.go +++ b/service/rekognition/api_op_DetectModerationLabels.go @@ -47,13 +47,13 @@ type DetectModerationLabelsInput struct { // This member is required. Image *types.Image - // Sets up the configuration for human evaluation, including the FlowDefinition the - // image will be sent to. + // Sets up the configuration for human evaluation, including the FlowDefinition + // the image will be sent to. HumanLoopConfig *types.HumanLoopConfig // Specifies the minimum confidence level for the labels to return. Amazon // Rekognition doesn't return any labels with a confidence level lower than this - // specified value. If you don't specify MinConfidence, the operation returns + // specified value. If you don't specify MinConfidence , the operation returns // labels with confidence values greater than or equal to 50 percent. MinConfidence *float32 @@ -65,8 +65,8 @@ type DetectModerationLabelsOutput struct { // Shows the results of the human in the loop evaluation. HumanLoopActivationOutput *types.HumanLoopActivationOutput - // Array of detected Moderation labels and the time, in milliseconds from the start - // of the video, they were detected. + // Array of detected Moderation labels and the time, in milliseconds from the + // start of the video, they were detected. ModerationLabels []types.ModerationLabel // Version number of the moderation detection model that was used to detect unsafe diff --git a/service/rekognition/api_op_DetectProtectiveEquipment.go b/service/rekognition/api_op_DetectProtectiveEquipment.go index 29000547667..9744c9a2542 100644 --- a/service/rekognition/api_op_DetectProtectiveEquipment.go +++ b/service/rekognition/api_op_DetectProtectiveEquipment.go @@ -11,40 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detects Personal Protective Equipment (PPE) worn by people detected in an image. -// Amazon Rekognition can detect the following types of PPE. +// Detects Personal Protective Equipment (PPE) worn by people detected in an +// image. Amazon Rekognition can detect the following types of PPE. +// - Face cover +// - Hand cover +// - Head cover // -// * Face cover +// You pass the input image as base64-encoded image bytes or as a reference to an +// image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted +// file. DetectProtectiveEquipment detects PPE worn by up to 15 persons detected +// in an image. For each person detected in the image the API returns an array of +// body parts (face, head, left-hand, right-hand). For each body part, an array of +// detected items of PPE is returned, including an indicator of whether or not the +// PPE covers the body part. The API returns the confidence it has in each +// detection (person, PPE, body part and body part coverage). It also returns a +// bounding box ( BoundingBox ) for each detected person and each detected item of +// PPE. You can optionally request a summary of detected PPE items with the +// SummarizationAttributes input parameter. The summary provides the following +// information. +// - The persons detected as wearing all of the types of PPE that you specify. +// - The persons detected as not wearing all of the types PPE that you specify. +// - The persons detected where PPE adornment could not be determined. // -// * Hand -// cover -// -// * Head cover -// -// You pass the input image as base64-encoded image bytes or -// as a reference to an image in an Amazon S3 bucket. The image must be either a -// PNG or JPG formatted file. DetectProtectiveEquipment detects PPE worn by up to -// 15 persons detected in an image. For each person detected in the image the API -// returns an array of body parts (face, head, left-hand, right-hand). For each -// body part, an array of detected items of PPE is returned, including an indicator -// of whether or not the PPE covers the body part. The API returns the confidence -// it has in each detection (person, PPE, body part and body part coverage). It -// also returns a bounding box (BoundingBox) for each detected person and each -// detected item of PPE. You can optionally request a summary of detected PPE items -// with the SummarizationAttributes input parameter. The summary provides the -// following information. -// -// * The persons detected as wearing all of the types of -// PPE that you specify. -// -// * The persons detected as not wearing all of the types -// PPE that you specify. -// -// * The persons detected where PPE adornment could not be -// determined. -// -// This is a stateless API operation. That is, the operation does not -// persist any data. This operation requires permissions to perform the +// This is a stateless API operation. That is, the operation does not persist any +// data. This operation requires permissions to perform the // rekognition:DetectProtectiveEquipment action. func (c *Client) DetectProtectiveEquipment(ctx context.Context, params *DetectProtectiveEquipmentInput, optFns ...func(*Options)) (*DetectProtectiveEquipmentOutput, error) { if params == nil { diff --git a/service/rekognition/api_op_DetectText.go b/service/rekognition/api_op_DetectText.go index 542d3226be1..78b4cf5d870 100644 --- a/service/rekognition/api_op_DetectText.go +++ b/service/rekognition/api_op_DetectText.go @@ -11,19 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detects text in the input image and converts it into machine-readable text. Pass -// the input image as base64-encoded image bytes or as a reference to an image in -// an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition +// Detects text in the input image and converts it into machine-readable text. +// Pass the input image as base64-encoded image bytes or as a reference to an image +// in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition // operations, you must pass it as a reference to an image in an Amazon S3 bucket. // For the AWS CLI, passing image bytes is not supported. The image must be either // a .png or .jpeg formatted file. The DetectText operation returns text in an -// array of TextDetection elements, TextDetections. Each TextDetection element +// array of TextDetection elements, TextDetections . Each TextDetection element // provides information about a single word or line of text that was detected in // the image. A word is one or more script characters that are not separated by -// spaces. DetectText can detect up to 100 words in an image. A line is a string of -// equally spaced words. A line isn't necessarily a complete sentence. For example, -// a driver's license number is detected as a line. A line ends when there is no -// aligned text after it. Also, a line ends when there is a large gap between +// spaces. DetectText can detect up to 100 words in an image. A line is a string +// of equally spaced words. A line isn't necessarily a complete sentence. For +// example, a driver's license number is detected as a line. A line ends when there +// is no aligned text after it. Also, a line ends when there is a large gap between // words, relative to the length of the words. This means, depending on the gap // between words, Amazon Rekognition may detect multiple lines in text aligned in // the same direction. Periods don't represent the end of a line. If a sentence diff --git a/service/rekognition/api_op_DistributeDatasetEntries.go b/service/rekognition/api_op_DistributeDatasetEntries.go index 05542b26368..ea1b9b44a99 100644 --- a/service/rekognition/api_op_DistributeDatasetEntries.go +++ b/service/rekognition/api_op_DistributeDatasetEntries.go @@ -18,11 +18,11 @@ import ( // training dataset and test dataset. The training dataset must contain the images // that you want to split. The test dataset must be empty. The datasets must belong // to the same project. To create training and test datasets for a project, call -// CreateDataset. Distributing a dataset takes a while to complete. To check the -// status call DescribeDataset. The operation is complete when the Status field for -// the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset -// split fails, the value of Status is UPDATE_FAILED. This operation requires -// permissions to perform the rekognition:DistributeDatasetEntries action. +// CreateDataset . Distributing a dataset takes a while to complete. To check the +// status call DescribeDataset . The operation is complete when the Status field +// for the training dataset and the test dataset is UPDATE_COMPLETE . If the +// dataset split fails, the value of Status is UPDATE_FAILED . This operation +// requires permissions to perform the rekognition:DistributeDatasetEntries action. func (c *Client) DistributeDatasetEntries(ctx context.Context, params *DistributeDatasetEntriesInput, optFns ...func(*Options)) (*DistributeDatasetEntriesOutput, error) { if params == nil { params = &DistributeDatasetEntriesInput{} diff --git a/service/rekognition/api_op_GetCelebrityInfo.go b/service/rekognition/api_op_GetCelebrityInfo.go index b1606360539..83ae8e620d5 100644 --- a/service/rekognition/api_op_GetCelebrityInfo.go +++ b/service/rekognition/api_op_GetCelebrityInfo.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the name and additional information about a celebrity based on their Amazon -// Rekognition ID. The additional information is returned as an array of URLs. If -// there is no additional information about the celebrity, this list is empty. For -// more information, see Getting information about a celebrity in the Amazon -// Rekognition Developer Guide. This operation requires permissions to perform the -// rekognition:GetCelebrityInfo action. +// Gets the name and additional information about a celebrity based on their +// Amazon Rekognition ID. The additional information is returned as an array of +// URLs. If there is no additional information about the celebrity, this list is +// empty. For more information, see Getting information about a celebrity in the +// Amazon Rekognition Developer Guide. This operation requires permissions to +// perform the rekognition:GetCelebrityInfo action. func (c *Client) GetCelebrityInfo(ctx context.Context, params *GetCelebrityInfoInput, optFns ...func(*Options)) (*GetCelebrityInfoOutput, error) { if params == nil { params = &GetCelebrityInfoInput{} diff --git a/service/rekognition/api_op_GetCelebrityRecognition.go b/service/rekognition/api_op_GetCelebrityRecognition.go index ecd3483e82e..49a62cf5ca5 100644 --- a/service/rekognition/api_op_GetCelebrityRecognition.go +++ b/service/rekognition/api_op_GetCelebrityRecognition.go @@ -13,24 +13,24 @@ import ( ) // Gets the celebrity recognition results for a Amazon Rekognition Video analysis -// started by StartCelebrityRecognition. Celebrity recognition in a video is an +// started by StartCelebrityRecognition . Celebrity recognition in a video is an // asynchronous operation. Analysis is started by a call to -// StartCelebrityRecognition which returns a job identifier (JobId). When the +// StartCelebrityRecognition which returns a job identifier ( JobId ). When the // celebrity recognition operation finishes, Amazon Rekognition Video publishes a // completion status to the Amazon Simple Notification Service topic registered in -// the initial call to StartCelebrityRecognition. To get the results of the +// the initial call to StartCelebrityRecognition . To get the results of the // celebrity recognition analysis, first check that the status value published to -// the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass -// the job identifier (JobId) from the initial call to StartCelebrityDetection. For -// more information, see Working With Stored Videos in the Amazon Rekognition +// the Amazon SNS topic is SUCCEEDED . If so, call GetCelebrityDetection and pass +// the job identifier ( JobId ) from the initial call to StartCelebrityDetection . +// For more information, see Working With Stored Videos in the Amazon Rekognition // Developer Guide. GetCelebrityRecognition returns detected celebrities and the -// time(s) they are detected in an array (Celebrities) of CelebrityRecognition -// objects. Each CelebrityRecognition contains information about the celebrity in a -// CelebrityDetail object and the time, Timestamp, the celebrity was detected. This -// CelebrityDetail object stores information about the detected celebrity's face -// attributes, a face bounding box, known gender, the celebrity's name, and a +// time(s) they are detected in an array ( Celebrities ) of CelebrityRecognition +// objects. Each CelebrityRecognition contains information about the celebrity in +// a CelebrityDetail object and the time, Timestamp , the celebrity was detected. +// This CelebrityDetail object stores information about the detected celebrity's +// face attributes, a face bounding box, known gender, the celebrity's name, and a // confidence estimate. GetCelebrityRecognition only returns the default facial -// attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The +// attributes ( BoundingBox , Confidence , Landmarks , Pose , and Quality ). The // BoundingBox field only applies to the detected face instance. The other facial // attributes listed in the Face object of the following response syntax are not // returned. For more information, see FaceDetail in the Amazon Rekognition @@ -42,11 +42,11 @@ import ( // get them later by calling GetCelebrityInfo with the celebrity identifer. No // information is returned for faces not recognized as celebrities. Use MaxResults // parameter to limit the number of labels returned. If there are more results than -// specified in MaxResults, the value of NextToken in the operation response +// specified in MaxResults , the value of NextToken in the operation response // contains a pagination token for getting the next set of results. To get the next // page of results, call GetCelebrityDetection and populate the NextToken request // parameter with the token value returned from the previous call to -// GetCelebrityRecognition. +// GetCelebrityRecognition . func (c *Client) GetCelebrityRecognition(ctx context.Context, params *GetCelebrityRecognitionInput, optFns ...func(*Options)) (*GetCelebrityRecognitionOutput, error) { if params == nil { params = &GetCelebrityRecognitionInput{} @@ -65,7 +65,7 @@ func (c *Client) GetCelebrityRecognition(ctx context.Context, params *GetCelebri type GetCelebrityRecognitionInput struct { // Job identifier for the required celebrity recognition analysis. You can get the - // job identifer from a call to StartCelebrityRecognition. + // job identifer from a call to StartCelebrityRecognition . // // This member is required. JobId *string @@ -81,9 +81,9 @@ type GetCelebrityRecognitionInput struct { // celebrities. NextToken *string - // Sort to use for celebrities returned in Celebrities field. Specify ID to sort by - // the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity - // was recognized. + // Sort to use for celebrities returned in Celebrities field. Specify ID to sort + // by the celebrity identifier, specify TIMESTAMP to sort by the time the + // celebrity was recognized. SortBy types.CelebrityRecognitionSortBy noSmithyDocumentSerde diff --git a/service/rekognition/api_op_GetContentModeration.go b/service/rekognition/api_op_GetContentModeration.go index ea1e9c10f74..05752366f6d 100644 --- a/service/rekognition/api_op_GetContentModeration.go +++ b/service/rekognition/api_op_GetContentModeration.go @@ -13,33 +13,33 @@ import ( ) // Gets the inappropriate, unwanted, or offensive content analysis results for a -// Amazon Rekognition Video analysis started by StartContentModeration. For a list +// Amazon Rekognition Video analysis started by StartContentModeration . For a list // of moderation labels in Amazon Rekognition, see Using the image and video -// moderation APIs -// (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api). -// Amazon Rekognition Video inappropriate or offensive content detection in a +// moderation APIs (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api) +// . Amazon Rekognition Video inappropriate or offensive content detection in a // stored video is an asynchronous operation. You start analysis by calling -// StartContentModeration which returns a job identifier (JobId). When analysis +// StartContentModeration which returns a job identifier ( JobId ). When analysis // finishes, Amazon Rekognition Video publishes a completion status to the Amazon // Simple Notification Service topic registered in the initial call to -// StartContentModeration. To get the results of the content analysis, first check -// that the status value published to the Amazon SNS topic is SUCCEEDED. If so, -// call GetContentModeration and pass the job identifier (JobId) from the initial -// call to StartContentModeration. For more information, see Working with Stored +// StartContentModeration . To get the results of the content analysis, first check +// that the status value published to the Amazon SNS topic is SUCCEEDED . If so, +// call GetContentModeration and pass the job identifier ( JobId ) from the initial +// call to StartContentModeration . For more information, see Working with Stored // Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns // detected inappropriate, unwanted, or offensive content moderation labels, and -// the time they are detected, in an array, ModerationLabels, of +// the time they are detected, in an array, ModerationLabels , of // ContentModerationDetection objects. By default, the moderated labels are // returned sorted by time, in milliseconds from the start of the video. You can // also sort them by moderated label by specifying NAME for the SortBy input // parameter. Since video analysis can return a large number of results, use the // MaxResults parameter to limit the number of labels returned in a single call to -// GetContentModeration. If there are more results than specified in MaxResults, -// the value of NextToken in the operation response contains a pagination token for -// getting the next set of results. To get the next page of results, call -// GetContentModeration and populate the NextToken request parameter with the value -// of NextToken returned from the previous call to GetContentModeration. For more -// information, see moderating content in the Amazon Rekognition Developer Guide. +// GetContentModeration . If there are more results than specified in MaxResults , +// the value of NextToken in the operation response contains a pagination token +// for getting the next set of results. To get the next page of results, call +// GetContentModeration and populate the NextToken request parameter with the +// value of NextToken returned from the previous call to GetContentModeration . For +// more information, see moderating content in the Amazon Rekognition Developer +// Guide. func (c *Client) GetContentModeration(ctx context.Context, params *GetContentModerationInput, optFns ...func(*Options)) (*GetContentModerationOutput, error) { if params == nil { params = &GetContentModerationInput{} @@ -58,7 +58,7 @@ func (c *Client) GetContentModeration(ctx context.Context, params *GetContentMod type GetContentModerationInput struct { // The identifier for the inappropriate, unwanted, or offensive content moderation - // job. Use JobId to identify the job in a subsequent call to GetContentModeration. + // job. Use JobId to identify the job in a subsequent call to GetContentModeration . // // This member is required. JobId *string @@ -78,7 +78,7 @@ type GetContentModerationInput struct { // to sort array elements by the time labels are detected. Use NAME to // alphabetically group elements for a label together. Within each label group, the // array element are sorted by detection confidence. The default sort is by - // TIMESTAMP. + // TIMESTAMP . SortBy types.ContentModerationSortBy noSmithyDocumentSerde @@ -89,8 +89,8 @@ type GetContentModerationOutput struct { // The current status of the content moderation analysis job. JobStatus types.VideoJobStatus - // The detected inappropriate, unwanted, or offensive content moderation labels and - // the time(s) they were detected. + // The detected inappropriate, unwanted, or offensive content moderation labels + // and the time(s) they were detected. ModerationLabels []types.ContentModerationDetection // Version number of the moderation detection model that was used to detect @@ -106,7 +106,7 @@ type GetContentModerationOutput struct { StatusMessage *string // Information about a video that Amazon Rekognition analyzed. Videometadata is - // returned in every page of paginated responses from GetContentModeration. + // returned in every page of paginated responses from GetContentModeration . VideoMetadata *types.VideoMetadata // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_GetFaceDetection.go b/service/rekognition/api_op_GetFaceDetection.go index 146fb5aadac..59f2dd686d6 100644 --- a/service/rekognition/api_op_GetFaceDetection.go +++ b/service/rekognition/api_op_GetFaceDetection.go @@ -13,21 +13,22 @@ import ( ) // Gets face detection results for a Amazon Rekognition Video analysis started by -// StartFaceDetection. Face detection with Amazon Rekognition Video is an +// StartFaceDetection . Face detection with Amazon Rekognition Video is an // asynchronous operation. You start face detection by calling StartFaceDetection -// which returns a job identifier (JobId). When the face detection operation +// which returns a job identifier ( JobId ). When the face detection operation // finishes, Amazon Rekognition Video publishes a completion status to the Amazon // Simple Notification Service topic registered in the initial call to -// StartFaceDetection. To get the results of the face detection operation, first -// check that the status value published to the Amazon SNS topic is SUCCEEDED. If -// so, call GetFaceDetection and pass the job identifier (JobId) from the initial -// call to StartFaceDetection. GetFaceDetection returns an array of detected faces -// (Faces) sorted by the time the faces were detected. Use MaxResults parameter to -// limit the number of labels returned. If there are more results than specified in -// MaxResults, the value of NextToken in the operation response contains a -// pagination token for getting the next set of results. To get the next page of -// results, call GetFaceDetection and populate the NextToken request parameter with -// the token value returned from the previous call to GetFaceDetection. +// StartFaceDetection . To get the results of the face detection operation, first +// check that the status value published to the Amazon SNS topic is SUCCEEDED . If +// so, call GetFaceDetection and pass the job identifier ( JobId ) from the initial +// call to StartFaceDetection . GetFaceDetection returns an array of detected +// faces ( Faces ) sorted by the time the faces were detected. Use MaxResults +// parameter to limit the number of labels returned. If there are more results than +// specified in MaxResults , the value of NextToken in the operation response +// contains a pagination token for getting the next set of results. To get the next +// page of results, call GetFaceDetection and populate the NextToken request +// parameter with the token value returned from the previous call to +// GetFaceDetection . func (c *Client) GetFaceDetection(ctx context.Context, params *GetFaceDetectionInput, optFns ...func(*Options)) (*GetFaceDetectionOutput, error) { if params == nil { params = &GetFaceDetectionInput{} @@ -46,7 +47,7 @@ func (c *Client) GetFaceDetection(ctx context.Context, params *GetFaceDetectionI type GetFaceDetectionInput struct { // Unique identifier for the face detection job. The JobId is returned from - // StartFaceDetection. + // StartFaceDetection . // // This member is required. JobId *string @@ -66,16 +67,16 @@ type GetFaceDetectionInput struct { type GetFaceDetectionOutput struct { - // An array of faces detected in the video. Each element contains a detected face's - // details and the time, in milliseconds from the start of the video, the face was - // detected. + // An array of faces detected in the video. Each element contains a detected + // face's details and the time, in milliseconds from the start of the video, the + // face was detected. Faces []types.FaceDetection // The current status of the face detection job. JobStatus types.VideoJobStatus - // If the response is truncated, Amazon Rekognition returns this token that you can - // use in the subsequent request to retrieve the next set of faces. + // If the response is truncated, Amazon Rekognition returns this token that you + // can use in the subsequent request to retrieve the next set of faces. NextToken *string // If the job fails, StatusMessage provides a descriptive error message. diff --git a/service/rekognition/api_op_GetFaceSearch.go b/service/rekognition/api_op_GetFaceSearch.go index 38eaa8ac9e0..2976e6a2d53 100644 --- a/service/rekognition/api_op_GetFaceSearch.go +++ b/service/rekognition/api_op_GetFaceSearch.go @@ -12,28 +12,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the face search results for Amazon Rekognition Video face search started by -// StartFaceSearch. The search returns faces in a collection that match the faces -// of persons detected in a video. It also includes the time(s) that faces are -// matched in the video. Face search in a video is an asynchronous operation. You -// start face search by calling to StartFaceSearch which returns a job identifier -// (JobId). When the search operation finishes, Amazon Rekognition Video publishes -// a completion status to the Amazon Simple Notification Service topic registered -// in the initial call to StartFaceSearch. To get the search results, first check -// that the status value published to the Amazon SNS topic is SUCCEEDED. If so, -// call GetFaceSearch and pass the job identifier (JobId) from the initial call to -// StartFaceSearch. For more information, see Searching Faces in a Collection in -// the Amazon Rekognition Developer Guide. The search results are retured in an -// array, Persons, of PersonMatch objects. EachPersonMatch element contains details -// about the matching faces in the input collection, person information (facial -// attributes, bounding boxes, and person identifer) for the matched person, and -// the time the person was matched in the video. GetFaceSearch only returns the -// default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and -// Quality). The other facial attributes listed in the Face object of the following -// response syntax are not returned. For more information, see FaceDetail in the -// Amazon Rekognition Developer Guide. By default, the Persons array is sorted by -// the time, in milliseconds from the start of the video, persons are matched. You -// can also sort by persons by specifying INDEX for the SORTBY input parameter. +// Gets the face search results for Amazon Rekognition Video face search started +// by StartFaceSearch . The search returns faces in a collection that match the +// faces of persons detected in a video. It also includes the time(s) that faces +// are matched in the video. Face search in a video is an asynchronous operation. +// You start face search by calling to StartFaceSearch which returns a job +// identifier ( JobId ). When the search operation finishes, Amazon Rekognition +// Video publishes a completion status to the Amazon Simple Notification Service +// topic registered in the initial call to StartFaceSearch . To get the search +// results, first check that the status value published to the Amazon SNS topic is +// SUCCEEDED . If so, call GetFaceSearch and pass the job identifier ( JobId ) from +// the initial call to StartFaceSearch . For more information, see Searching Faces +// in a Collection in the Amazon Rekognition Developer Guide. The search results +// are retured in an array, Persons , of PersonMatch objects. Each PersonMatch +// element contains details about the matching faces in the input collection, +// person information (facial attributes, bounding boxes, and person identifer) for +// the matched person, and the time the person was matched in the video. +// GetFaceSearch only returns the default facial attributes ( BoundingBox , +// Confidence , Landmarks , Pose , and Quality ). The other facial attributes +// listed in the Face object of the following response syntax are not returned. +// For more information, see FaceDetail in the Amazon Rekognition Developer Guide. +// By default, the Persons array is sorted by the time, in milliseconds from the +// start of the video, persons are matched. You can also sort by persons by +// specifying INDEX for the SORTBY input parameter. func (c *Client) GetFaceSearch(ctx context.Context, params *GetFaceSearchInput, optFns ...func(*Options)) (*GetFaceSearchOutput, error) { if params == nil { params = &GetFaceSearchInput{} @@ -52,7 +53,7 @@ func (c *Client) GetFaceSearch(ctx context.Context, params *GetFaceSearchInput, type GetFaceSearchInput struct { // The job identifer for the search request. You get the job identifier from an - // initial call to StartFaceSearch. + // initial call to StartFaceSearch . // // This member is required. JobId *string @@ -62,9 +63,10 @@ type GetFaceSearchInput struct { // results is returned. The default value is 1000. MaxResults *int32 - // If the previous response was incomplete (because there is more search results to - // retrieve), Amazon Rekognition Video returns a pagination token in the response. - // You can use this pagination token to retrieve the next set of search results. + // If the previous response was incomplete (because there is more search results + // to retrieve), Amazon Rekognition Video returns a pagination token in the + // response. You can use this pagination token to retrieve the next set of search + // results. NextToken *string // Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by @@ -84,12 +86,12 @@ type GetFaceSearchOutput struct { // results. NextToken *string - // An array of persons, PersonMatch, in the video whose face(s) match the face(s) + // An array of persons, PersonMatch , in the video whose face(s) match the face(s) // in an Amazon Rekognition collection. It also includes time information for when // persons are matched in the video. You specify the input collection in an initial - // call to StartFaceSearch. Each Persons element includes a time the person was - // matched, face match details (FaceMatches) for matching faces in the collection, - // and person information (Person) for the matched person. + // call to StartFaceSearch . Each Persons element includes a time the person was + // matched, face match details ( FaceMatches ) for matching faces in the + // collection, and person information ( Person ) for the matched person. Persons []types.PersonMatch // If the job fails, StatusMessage provides a descriptive error message. diff --git a/service/rekognition/api_op_GetLabelDetection.go b/service/rekognition/api_op_GetLabelDetection.go index eb3eb689aaf..5d46cc9aa04 100644 --- a/service/rekognition/api_op_GetLabelDetection.go +++ b/service/rekognition/api_op_GetLabelDetection.go @@ -13,66 +13,55 @@ import ( ) // Gets the label detection results of a Amazon Rekognition Video analysis started -// by StartLabelDetection. The label detection operation is started by a call to -// StartLabelDetection which returns a job identifier (JobId). When the label +// by StartLabelDetection . The label detection operation is started by a call to +// StartLabelDetection which returns a job identifier ( JobId ). When the label // detection operation finishes, Amazon Rekognition publishes a completion status // to the Amazon Simple Notification Service topic registered in the initial call -// to StartlabelDetection. To get the results of the label detection operation, -// first check that the status value published to the Amazon SNS topic is -// SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) -// from the initial call to StartLabelDetection. GetLabelDetection returns an array -// of detected labels (Labels) sorted by the time the labels were detected. You can +// to StartlabelDetection . To get the results of the label detection operation, +// first check that the status value published to the Amazon SNS topic is SUCCEEDED +// . If so, call GetLabelDetection and pass the job identifier ( JobId ) from the +// initial call to StartLabelDetection . GetLabelDetection returns an array of +// detected labels ( Labels ) sorted by the time the labels were detected. You can // also sort by the label name by specifying NAME for the SortBy input parameter. // If there is no NAME specified, the default sort is by timestamp. You can select -// how results are aggregated by using the AggregateBy input parameter. The default -// aggregation method is TIMESTAMPS. You can also aggregate by SEGMENTS, which -// aggregates all instances of labels detected in a given segment. The returned -// Labels array may include the following attributes: +// how results are aggregated by using the AggregateBy input parameter. The +// default aggregation method is TIMESTAMPS . You can also aggregate by SEGMENTS , +// which aggregates all instances of labels detected in a given segment. The +// returned Labels array may include the following attributes: +// - Name - The name of the detected label. +// - Confidence - The level of confidence in the label assigned to a detected +// object. +// - Parents - The ancestor labels for a detected label. GetLabelDetection +// returns a hierarchical taxonomy of detected labels. For example, a detected car +// might be assigned the label car. The label car has two parent labels: Vehicle +// (its parent) and Transportation (its grandparent). The response includes the all +// ancestors for a label, where every ancestor is a unique label. In the previous +// example, Car, Vehicle, and Transportation are returned as unique labels in the +// response. +// - Aliases - Possible Aliases for the label. +// - Categories - The label categories that the detected label belongs to. +// - BoundingBox — Bounding boxes are described for all instances of detected +// common object labels, returned in an array of Instance objects. An Instance +// object contains a BoundingBox object, describing the location of the label on +// the input image. It also includes the confidence for the accuracy of the +// detected bounding box. +// - Timestamp - Time, in milliseconds from the start of the video, that the +// label was detected. For aggregation by SEGMENTS , the StartTimestampMillis , +// EndTimestampMillis , and DurationMillis structures are what define a segment. +// Although the “Timestamp” structure is still returned with each label, its value +// is set to be the same as StartTimestampMillis . // -// * Name - The name of the -// detected label. -// -// * Confidence - The level of confidence in the label assigned to -// a detected object. -// -// * Parents - The ancestor labels for a detected label. -// GetLabelDetection returns a hierarchical taxonomy of detected labels. For -// example, a detected car might be assigned the label car. The label car has two -// parent labels: Vehicle (its parent) and Transportation (its grandparent). The -// response includes the all ancestors for a label, where every ancestor is a -// unique label. In the previous example, Car, Vehicle, and Transportation are -// returned as unique labels in the response. -// -// * Aliases - Possible Aliases for the -// label. -// -// * Categories - The label categories that the detected label belongs -// to. -// -// * BoundingBox — Bounding boxes are described for all instances of detected -// common object labels, returned in an array of Instance objects. An Instance -// object contains a BoundingBox object, describing the location of the label on -// the input image. It also includes the confidence for the accuracy of the -// detected bounding box. -// -// * Timestamp - Time, in milliseconds from the start of -// the video, that the label was detected. For aggregation by SEGMENTS, the -// StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what -// define a segment. Although the “Timestamp” structure is still returned with each -// label, its value is set to be the same as StartTimestampMillis. -// -// Timestamp and -// Bounding box information are returned for detected Instances, only if -// aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS, information about -// detected instances isn’t returned. The version of the label model used for the -// detection is also returned. Note DominantColors isn't returned for Instances, -// although it is shown as part of the response in the sample seen below. Use -// MaxResults parameter to limit the number of labels returned. If there are more -// results than specified in MaxResults, the value of NextToken in the operation -// response contains a pagination token for getting the next set of results. To get -// the next page of results, call GetlabelDetection and populate the NextToken -// request parameter with the token value returned from the previous call to -// GetLabelDetection. +// Timestamp and Bounding box information are returned for detected Instances, +// only if aggregation is done by TIMESTAMPS . If aggregating by SEGMENTS , +// information about detected instances isn’t returned. The version of the label +// model used for the detection is also returned. Note DominantColors isn't +// returned for Instances , although it is shown as part of the response in the +// sample seen below. Use MaxResults parameter to limit the number of labels +// returned. If there are more results than specified in MaxResults , the value of +// NextToken in the operation response contains a pagination token for getting the +// next set of results. To get the next page of results, call GetlabelDetection +// and populate the NextToken request parameter with the token value returned from +// the previous call to GetLabelDetection . func (c *Client) GetLabelDetection(ctx context.Context, params *GetLabelDetectionInput, optFns ...func(*Options)) (*GetLabelDetectionOutput, error) { if params == nil { params = &GetLabelDetectionInput{} @@ -91,7 +80,7 @@ func (c *Client) GetLabelDetection(ctx context.Context, params *GetLabelDetectio type GetLabelDetectionInput struct { // Job identifier for the label detection operation for which you want results - // returned. You get the job identifer from an initial call to StartlabelDetection. + // returned. You get the job identifer from an initial call to StartlabelDetection . // // This member is required. JobId *string @@ -113,7 +102,7 @@ type GetLabelDetectionInput struct { // Sort to use for elements in the Labels array. Use TIMESTAMP to sort array // elements by the time labels are detected. Use NAME to alphabetically group // elements for a label together. Within each label group, the array element are - // sorted by detection confidence. The default sort is by TIMESTAMP. + // sorted by detection confidence. The default sort is by TIMESTAMP . SortBy types.LabelDetectionSortBy noSmithyDocumentSerde diff --git a/service/rekognition/api_op_GetPersonTracking.go b/service/rekognition/api_op_GetPersonTracking.go index 6ca33f7dc2a..2ae99dcaffd 100644 --- a/service/rekognition/api_op_GetPersonTracking.go +++ b/service/rekognition/api_op_GetPersonTracking.go @@ -12,28 +12,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the path tracking results of a Amazon Rekognition Video analysis started by -// StartPersonTracking. The person path tracking operation is started by a call to -// StartPersonTracking which returns a job identifier (JobId). When the operation -// finishes, Amazon Rekognition Video publishes a completion status to the Amazon -// Simple Notification Service topic registered in the initial call to -// StartPersonTracking. To get the results of the person path tracking operation, -// first check that the status value published to the Amazon SNS topic is -// SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) -// from the initial call to StartPersonTracking. GetPersonTracking returns an -// array, Persons, of tracked persons and the time(s) their paths were tracked in -// the video. GetPersonTracking only returns the default facial attributes -// (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial -// attributes listed in the Face object of the following response syntax are not -// returned. For more information, see FaceDetail in the Amazon Rekognition -// Developer Guide. By default, the array is sorted by the time(s) a person's path -// is tracked in the video. You can sort by tracked persons by specifying INDEX for -// the SortBy input parameter. Use the MaxResults parameter to limit the number of -// items returned. If there are more results than specified in MaxResults, the -// value of NextToken in the operation response contains a pagination token for -// getting the next set of results. To get the next page of results, call -// GetPersonTracking and populate the NextToken request parameter with the token -// value returned from the previous call to GetPersonTracking. +// Gets the path tracking results of a Amazon Rekognition Video analysis started +// by StartPersonTracking . The person path tracking operation is started by a call +// to StartPersonTracking which returns a job identifier ( JobId ). When the +// operation finishes, Amazon Rekognition Video publishes a completion status to +// the Amazon Simple Notification Service topic registered in the initial call to +// StartPersonTracking . To get the results of the person path tracking operation, +// first check that the status value published to the Amazon SNS topic is SUCCEEDED +// . If so, call GetPersonTracking and pass the job identifier ( JobId ) from the +// initial call to StartPersonTracking . GetPersonTracking returns an array, +// Persons , of tracked persons and the time(s) their paths were tracked in the +// video. GetPersonTracking only returns the default facial attributes ( BoundingBox +// , Confidence , Landmarks , Pose , and Quality ). The other facial attributes +// listed in the Face object of the following response syntax are not returned. +// For more information, see FaceDetail in the Amazon Rekognition Developer Guide. +// By default, the array is sorted by the time(s) a person's path is tracked in the +// video. You can sort by tracked persons by specifying INDEX for the SortBy input +// parameter. Use the MaxResults parameter to limit the number of items returned. +// If there are more results than specified in MaxResults , the value of NextToken +// in the operation response contains a pagination token for getting the next set +// of results. To get the next page of results, call GetPersonTracking and +// populate the NextToken request parameter with the token value returned from the +// previous call to GetPersonTracking . func (c *Client) GetPersonTracking(ctx context.Context, params *GetPersonTrackingInput, optFns ...func(*Options)) (*GetPersonTrackingOutput, error) { if params == nil { params = &GetPersonTrackingInput{} @@ -52,7 +52,7 @@ func (c *Client) GetPersonTracking(ctx context.Context, params *GetPersonTrackin type GetPersonTrackingInput struct { // The identifier for a job that tracks persons in a video. You get the JobId from - // a call to StartPersonTracking. + // a call to StartPersonTracking . // // This member is required. JobId *string @@ -69,8 +69,8 @@ type GetPersonTrackingInput struct { // Sort to use for elements in the Persons array. Use TIMESTAMP to sort array // elements by the time persons are detected. Use INDEX to sort by the tracked - // persons. If you sort by INDEX, the array elements for each person are sorted by - // detection confidence. The default sort is by TIMESTAMP. + // persons. If you sort by INDEX , the array elements for each person are sorted by + // detection confidence. The default sort is by TIMESTAMP . SortBy types.PersonTrackingSortBy noSmithyDocumentSerde diff --git a/service/rekognition/api_op_GetSegmentDetection.go b/service/rekognition/api_op_GetSegmentDetection.go index 835b17c50b9..567576a2510 100644 --- a/service/rekognition/api_op_GetSegmentDetection.go +++ b/service/rekognition/api_op_GetSegmentDetection.go @@ -13,29 +13,29 @@ import ( ) // Gets the segment detection results of a Amazon Rekognition Video analysis -// started by StartSegmentDetection. Segment detection with Amazon Rekognition +// started by StartSegmentDetection . Segment detection with Amazon Rekognition // Video is an asynchronous operation. You start segment detection by calling -// StartSegmentDetection which returns a job identifier (JobId). When the segment +// StartSegmentDetection which returns a job identifier ( JobId ). When the segment // detection operation finishes, Amazon Rekognition publishes a completion status // to the Amazon Simple Notification Service topic registered in the initial call -// to StartSegmentDetection. To get the results of the segment detection operation, -// first check that the status value published to the Amazon SNS topic is -// SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) -// from the initial call of StartSegmentDetection. GetSegmentDetection returns -// detected segments in an array (Segments) of SegmentDetection objects. Segments -// is sorted by the segment types specified in the SegmentTypes input parameter of -// StartSegmentDetection. Each element of the array includes the detected segment, -// the precentage confidence in the acuracy of the detected segment, the type of -// the segment, and the frame in which the segment was detected. Use -// SelectedSegmentTypes to find out the type of segment detection requested in the -// call to StartSegmentDetection. Use the MaxResults parameter to limit the number -// of segment detections returned. If there are more results than specified in -// MaxResults, the value of NextToken in the operation response contains a -// pagination token for getting the next set of results. To get the next page of -// results, call GetSegmentDetection and populate the NextToken request parameter -// with the token value returned from the previous call to GetSegmentDetection. For -// more information, see Detecting video segments in stored video in the Amazon -// Rekognition Developer Guide. +// to StartSegmentDetection . To get the results of the segment detection +// operation, first check that the status value published to the Amazon SNS topic +// is SUCCEEDED . if so, call GetSegmentDetection and pass the job identifier ( +// JobId ) from the initial call of StartSegmentDetection . GetSegmentDetection +// returns detected segments in an array ( Segments ) of SegmentDetection objects. +// Segments is sorted by the segment types specified in the SegmentTypes input +// parameter of StartSegmentDetection . Each element of the array includes the +// detected segment, the precentage confidence in the acuracy of the detected +// segment, the type of the segment, and the frame in which the segment was +// detected. Use SelectedSegmentTypes to find out the type of segment detection +// requested in the call to StartSegmentDetection . Use the MaxResults parameter +// to limit the number of segment detections returned. If there are more results +// than specified in MaxResults , the value of NextToken in the operation response +// contains a pagination token for getting the next set of results. To get the next +// page of results, call GetSegmentDetection and populate the NextToken request +// parameter with the token value returned from the previous call to +// GetSegmentDetection . For more information, see Detecting video segments in +// stored video in the Amazon Rekognition Developer Guide. func (c *Client) GetSegmentDetection(ctx context.Context, params *GetSegmentDetectionInput, optFns ...func(*Options)) (*GetSegmentDetectionOutput, error) { if params == nil { params = &GetSegmentDetectionInput{} @@ -55,7 +55,7 @@ type GetSegmentDetectionInput struct { // Job identifier for the text detection operation for which you want results // returned. You get the job identifer from an initial call to - // StartSegmentDetection. + // StartSegmentDetection . // // This member is required. JobId *string @@ -77,7 +77,7 @@ type GetSegmentDetectionOutput struct { // object contains metadata for a single audio stream. Audio information in an // AudioMetadata objects includes the audio codec, the number of audio channels, // the duration of the audio stream, and the sample rate. Audio metadata is - // returned in each page of information returned by GetSegmentDetection. + // returned in each page of information returned by GetSegmentDetection . AudioMetadata []types.AudioMetadata // Current status of the segment detection job. @@ -90,12 +90,12 @@ type GetSegmentDetectionOutput struct { // An array of segments detected in a video. The array is sorted by the segment // types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of - // StartSegmentDetection. Within each segment type the array is sorted by timestamp - // values. + // StartSegmentDetection . Within each segment type the array is sorted by + // timestamp values. Segments []types.SegmentDetection // An array containing the segment types requested in the call to - // StartSegmentDetection. + // StartSegmentDetection . SelectedSegmentTypes []types.SegmentTypeInfo // If the job fails, StatusMessage provides a descriptive error message. @@ -105,7 +105,7 @@ type GetSegmentDetectionOutput struct { // array. The object contains information about the video stream in the input file // that Amazon Rekognition Video chose to analyze. The VideoMetadata object // includes the video codec, video format and other information. Video metadata is - // returned in each page of information returned by GetSegmentDetection. + // returned in each page of information returned by GetSegmentDetection . VideoMetadata []types.VideoMetadata // Metadata pertaining to the operation's result. @@ -177,8 +177,8 @@ func (c *Client) addOperationGetSegmentDetectionMiddlewares(stack *middleware.St return nil } -// GetSegmentDetectionAPIClient is a client that implements the GetSegmentDetection -// operation. +// GetSegmentDetectionAPIClient is a client that implements the +// GetSegmentDetection operation. type GetSegmentDetectionAPIClient interface { GetSegmentDetection(context.Context, *GetSegmentDetectionInput, ...func(*Options)) (*GetSegmentDetectionOutput, error) } diff --git a/service/rekognition/api_op_GetTextDetection.go b/service/rekognition/api_op_GetTextDetection.go index 449f66d710b..3122d478618 100644 --- a/service/rekognition/api_op_GetTextDetection.go +++ b/service/rekognition/api_op_GetTextDetection.go @@ -13,25 +13,25 @@ import ( ) // Gets the text detection results of a Amazon Rekognition Video analysis started -// by StartTextDetection. Text detection with Amazon Rekognition Video is an +// by StartTextDetection . Text detection with Amazon Rekognition Video is an // asynchronous operation. You start text detection by calling StartTextDetection -// which returns a job identifier (JobId) When the text detection operation +// which returns a job identifier ( JobId ) When the text detection operation // finishes, Amazon Rekognition publishes a completion status to the Amazon Simple -// Notification Service topic registered in the initial call to StartTextDetection. -// To get the results of the text detection operation, first check that the status -// value published to the Amazon SNS topic is SUCCEEDED. if so, call -// GetTextDetection and pass the job identifier (JobId) from the initial call of -// StartLabelDetection. GetTextDetection returns an array of detected text -// (TextDetections) sorted by the time the text was detected, up to 50 words per +// Notification Service topic registered in the initial call to StartTextDetection +// . To get the results of the text detection operation, first check that the +// status value published to the Amazon SNS topic is SUCCEEDED . if so, call +// GetTextDetection and pass the job identifier ( JobId ) from the initial call of +// StartLabelDetection . GetTextDetection returns an array of detected text ( +// TextDetections ) sorted by the time the text was detected, up to 50 words per // frame of video. Each element of the array includes the detected text, the // precentage confidence in the acuracy of the detected text, the time the text was // detected, bounding box information for where the text was located, and unique // identifiers for words and their lines. Use MaxResults parameter to limit the // number of text detections returned. If there are more results than specified in -// MaxResults, the value of NextToken in the operation response contains a +// MaxResults , the value of NextToken in the operation response contains a // pagination token for getting the next set of results. To get the next page of -// results, call GetTextDetection and populate the NextToken request parameter with -// the token value returned from the previous call to GetTextDetection. +// results, call GetTextDetection and populate the NextToken request parameter +// with the token value returned from the previous call to GetTextDetection . func (c *Client) GetTextDetection(ctx context.Context, params *GetTextDetectionInput, optFns ...func(*Options)) (*GetTextDetectionOutput, error) { if params == nil { params = &GetTextDetectionInput{} @@ -50,7 +50,7 @@ func (c *Client) GetTextDetection(ctx context.Context, params *GetTextDetectionI type GetTextDetectionInput struct { // Job identifier for the text detection operation for which you want results - // returned. You get the job identifer from an initial call to StartTextDetection. + // returned. You get the job identifer from an initial call to StartTextDetection . // // This member is required. JobId *string @@ -79,9 +79,9 @@ type GetTextDetectionOutput struct { // If the job fails, StatusMessage provides a descriptive error message. StatusMessage *string - // An array of text detected in the video. Each element contains the detected text, - // the time in milliseconds from the start of the video that the text was detected, - // and where it was detected on the screen. + // An array of text detected in the video. Each element contains the detected + // text, the time in milliseconds from the start of the video that the text was + // detected, and where it was detected on the screen. TextDetections []types.TextDetectionResult // Version number of the text detection model that was used to detect text. diff --git a/service/rekognition/api_op_IndexFaces.go b/service/rekognition/api_op_IndexFaces.go index cf7e3b3dd20..dfb56fad8c9 100644 --- a/service/rekognition/api_op_IndexFaces.go +++ b/service/rekognition/api_op_IndexFaces.go @@ -19,15 +19,15 @@ import ( // it performs face match and search operations using the SearchFaces and // SearchFacesByImage operations. For more information, see Adding faces to a // collection in the Amazon Rekognition Developer Guide. To get the number of faces -// in a collection, call DescribeCollection. If you're using version 1.0 of the +// in a collection, call DescribeCollection . If you're using version 1.0 of the // face detection model, IndexFaces indexes the 15 largest faces in the input // image. Later versions of the face detection model index the 100 largest faces in // the input image. If you're using version 4 or later of the face model, image // orientation information is not returned in the OrientationCorrection field. To // determine which version of the model you're using, call DescribeCollection and // supply the collection ID. You can also get the model version from the value of -// FaceModelVersion in the response from IndexFaces For more information, see Model -// Versioning in the Amazon Rekognition Developer Guide. If you provide the +// FaceModelVersion in the response from IndexFaces For more information, see +// Model Versioning in the Amazon Rekognition Developer Guide. If you provide the // optional ExternalImageId for the input image you provided, Amazon Rekognition // associates this ID with all faces that it detects. When you call the ListFaces // operation, the response returns the external ID. You can use this external image @@ -39,57 +39,41 @@ import ( // QualityFilter input parameter allows you to filter out detected faces that don’t // meet a required quality bar. The quality bar is based on a variety of common use // cases. By default, IndexFaces chooses the quality bar that's used to filter -// faces. You can also explicitly choose the quality bar. Use QualityFilter, to set -// the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter -// detected faces, specify NONE. To use quality filtering, you need a collection -// associated with version 3 of the face model or higher. To get the version of the -// face model associated with a collection, call DescribeCollection. Information -// about faces detected in an image, but not indexed, is returned in an array of -// UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such -// as: +// faces. You can also explicitly choose the quality bar. Use QualityFilter , to +// set the quality bar by specifying LOW , MEDIUM , or HIGH . If you do not want to +// filter detected faces, specify NONE . To use quality filtering, you need a +// collection associated with version 3 of the face model or higher. To get the +// version of the face model associated with a collection, call DescribeCollection +// . Information about faces detected in an image, but not indexed, is returned in +// an array of UnindexedFace objects, UnindexedFaces . Faces aren't indexed for +// reasons such as: +// - The number of faces detected exceeds the value of the MaxFaces request +// parameter. +// - The face is too small compared to the image dimensions. +// - The face is too blurry. +// - The image is too dark. +// - The face has an extreme pose. +// - The face doesn’t have enough detail to be suitable for face search. // -// * The number of faces detected exceeds the value of the MaxFaces request -// parameter. +// In response, the IndexFaces operation returns an array of metadata for all +// detected faces, FaceRecords . This includes: +// - The bounding box, BoundingBox , of the detected face. +// - A confidence value, Confidence , which indicates the confidence that the +// bounding box contains a face. +// - A face ID, FaceId , assigned by the service for each face that's detected +// and stored. +// - An image ID, ImageId , assigned by the service for the input image. // -// * The face is too small compared to the image dimensions. -// -// * The -// face is too blurry. -// -// * The image is too dark. -// -// * The face has an extreme -// pose. -// -// * The face doesn’t have enough detail to be suitable for face search. -// -// In -// response, the IndexFaces operation returns an array of metadata for all detected -// faces, FaceRecords. This includes: -// -// * The bounding box, BoundingBox, of the -// detected face. -// -// * A confidence value, Confidence, which indicates the confidence -// that the bounding box contains a face. -// -// * A face ID, FaceId, assigned by the -// service for each face that's detected and stored. -// -// * An image ID, ImageId, -// assigned by the service for the input image. -// -// If you request all facial -// attributes (by using the detectionAttributes parameter), Amazon Rekognition -// returns detailed facial attributes, such as facial landmarks (for example, -// location of eye and mouth) and other facial attributes. If you provide the same -// image, specify the same collection, and use the same external ID in the -// IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. -// The input image is passed either as base64-encoded image bytes, or as a -// reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call -// Amazon Rekognition operations, passing image bytes isn't supported. The image -// must be formatted as a PNG or JPEG file. This operation requires permissions to -// perform the rekognition:IndexFaces action. +// If you request all facial attributes (by using the detectionAttributes +// parameter), Amazon Rekognition returns detailed facial attributes, such as +// facial landmarks (for example, location of eye and mouth) and other facial +// attributes. If you provide the same image, specify the same collection, and use +// the same external ID in the IndexFaces operation, Amazon Rekognition doesn't +// save duplicate face metadata. The input image is passed either as base64-encoded +// image bytes, or as a reference to an image in an Amazon S3 bucket. If you use +// the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't +// supported. The image must be formatted as a PNG or JPEG file. This operation +// requires permissions to perform the rekognition:IndexFaces action. func (c *Client) IndexFaces(ctx context.Context, params *IndexFacesInput, optFns ...func(*Options)) (*IndexFacesOutput, error) { if params == nil { params = &IndexFacesInput{} @@ -124,40 +108,40 @@ type IndexFacesInput struct { // An array of facial attributes that you want to be returned. This can be the // default list of attributes or all attributes. If you don't specify a value for - // Attributes or if you specify ["DEFAULT"], the API returns the following subset - // of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If - // you provide ["ALL"], all facial attributes are returned, but the operation takes - // longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a - // logical AND operator to determine which attributes to return (in this case, all - // attributes). + // Attributes or if you specify ["DEFAULT"] , the API returns the following subset + // of facial attributes: BoundingBox , Confidence , Pose , Quality , and Landmarks + // . If you provide ["ALL"] , all facial attributes are returned, but the operation + // takes longer to complete. If you provide both, ["ALL", "DEFAULT"] , the service + // uses a logical AND operator to determine which attributes to return (in this + // case, all attributes). DetectionAttributes []types.Attribute // The ID you want to assign to all the faces detected in the image. ExternalImageId *string - // The maximum number of faces to index. The value of MaxFaces must be greater than - // or equal to 1. IndexFaces returns no more than 100 detected faces in an image, - // even if you specify a larger value for MaxFaces. If IndexFaces detects more - // faces than the value of MaxFaces, the faces with the lowest quality are filtered - // out first. If there are still more faces than the value of MaxFaces, the faces - // with the smallest bounding boxes are filtered out (up to the number that's - // needed to satisfy the value of MaxFaces). Information about the unindexed faces - // is available in the UnindexedFaces array. The faces that are returned by - // IndexFaces are sorted by the largest face bounding box size to the smallest - // size, in descending order. MaxFaces can be used with a collection associated - // with any version of the face model. + // The maximum number of faces to index. The value of MaxFaces must be greater + // than or equal to 1. IndexFaces returns no more than 100 detected faces in an + // image, even if you specify a larger value for MaxFaces . If IndexFaces detects + // more faces than the value of MaxFaces , the faces with the lowest quality are + // filtered out first. If there are still more faces than the value of MaxFaces , + // the faces with the smallest bounding boxes are filtered out (up to the number + // that's needed to satisfy the value of MaxFaces ). Information about the + // unindexed faces is available in the UnindexedFaces array. The faces that are + // returned by IndexFaces are sorted by the largest face bounding box size to the + // smallest size, in descending order. MaxFaces can be used with a collection + // associated with any version of the face model. MaxFaces *int32 - // A filter that specifies a quality bar for how much filtering is done to identify - // faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition - // chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes - // all faces that don’t meet the chosen quality bar. The default value is AUTO. The - // quality bar is based on a variety of common use cases. Low-quality detections - // can occur for a number of reasons. Some examples are an object that's - // misidentified as a face, a face that's too blurry, or a face with a pose that's - // too extreme to use. If you specify NONE, no filtering is performed. To use - // quality filtering, the collection you are using must be associated with version - // 3 of the face model or higher. + // A filter that specifies a quality bar for how much filtering is done to + // identify faces. Filtered faces aren't indexed. If you specify AUTO , Amazon + // Rekognition chooses the quality bar. If you specify LOW , MEDIUM , or HIGH , + // filtering removes all faces that don’t meet the chosen quality bar. The default + // value is AUTO . The quality bar is based on a variety of common use cases. + // Low-quality detections can occur for a number of reasons. Some examples are an + // object that's misidentified as a face, a face that's too blurry, or a face with + // a pose that's too extreme to use. If you specify NONE , no filtering is + // performed. To use quality filtering, the collection you are using must be + // associated with version 3 of the face model or higher. QualityFilter types.QualityFilter noSmithyDocumentSerde @@ -166,7 +150,7 @@ type IndexFacesInput struct { type IndexFacesOutput struct { // The version number of the face detection model that's associated with the input - // collection (CollectionId). + // collection ( CollectionId ). FaceModelVersion *string // An array of faces detected and added to the collection. For more information, @@ -177,31 +161,26 @@ type IndexFacesOutput struct { // version 3.0, the value of OrientationCorrection is always null and no // orientation information is returned. If your collection is associated with a // face detection model that's version 3.0 or earlier, the following applies: - // - // * If - // the input image is in .jpeg format, it might contain exchangeable image file - // format (Exif) metadata that includes the image's orientation. Amazon Rekognition - // uses this orientation information to perform image correction - the bounding box - // coordinates are translated to represent object locations after the orientation - // information in the Exif metadata is used to correct the image orientation. - // Images in .png format don't contain Exif metadata. The value of - // OrientationCorrection is null. - // - // * If the image doesn't contain orientation - // information in its Exif metadata, Amazon Rekognition returns an estimated - // orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition - // doesn’t perform image correction for images. The bounding box coordinates aren't - // translated and represent the object locations before the image is - // rotated. - // - // Bounding box information is returned in the FaceRecords array. You can - // get the version of the face detection model by calling DescribeCollection. + // - If the input image is in .jpeg format, it might contain exchangeable image + // file format (Exif) metadata that includes the image's orientation. Amazon + // Rekognition uses this orientation information to perform image correction - the + // bounding box coordinates are translated to represent object locations after the + // orientation information in the Exif metadata is used to correct the image + // orientation. Images in .png format don't contain Exif metadata. The value of + // OrientationCorrection is null. + // - If the image doesn't contain orientation information in its Exif metadata, + // Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, + // ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for + // images. The bounding box coordinates aren't translated and represent the object + // locations before the image is rotated. + // Bounding box information is returned in the FaceRecords array. You can get the + // version of the face detection model by calling DescribeCollection . OrientationCorrection types.OrientationCorrection // An array of faces that were detected in the image but weren't indexed. They // weren't indexed because the quality filter identified them as low quality, or - // the MaxFaces request parameter filtered them out. To use the quality filter, you - // specify the QualityFilter request parameter. + // the MaxFaces request parameter filtered them out. To use the quality filter, + // you specify the QualityFilter request parameter. UnindexedFaces []types.UnindexedFace // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_ListCollections.go b/service/rekognition/api_op_ListCollections.go index 85facd98182..5fb163591f6 100644 --- a/service/rekognition/api_op_ListCollections.go +++ b/service/rekognition/api_op_ListCollections.go @@ -12,10 +12,10 @@ import ( ) // Returns list of collection IDs in your account. If the result is truncated, the -// response also provides a NextToken that you can use in the subsequent request to -// fetch the next set of collection IDs. For an example, see Listing collections in -// the Amazon Rekognition Developer Guide. This operation requires permissions to -// perform the rekognition:ListCollections action. +// response also provides a NextToken that you can use in the subsequent request +// to fetch the next set of collection IDs. For an example, see Listing collections +// in the Amazon Rekognition Developer Guide. This operation requires permissions +// to perform the rekognition:ListCollections action. func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInput, optFns ...func(*Options)) (*ListCollectionsOutput, error) { if params == nil { params = &ListCollectionsInput{} @@ -48,9 +48,9 @@ type ListCollectionsOutput struct { CollectionIds []string // Version numbers of the face detection models associated with the collections in - // the array CollectionIds. For example, the value of FaceModelVersions[2] is the + // the array CollectionIds . For example, the value of FaceModelVersions[2] is the // version number for the face detection model used by the collection in - // CollectionId[2]. + // CollectionId[2] . FaceModelVersions []string // If the result is truncated, the response provides a NextToken that you can use diff --git a/service/rekognition/api_op_ListDatasetEntries.go b/service/rekognition/api_op_ListDatasetEntries.go index 3301ab32468..420c67123d7 100644 --- a/service/rekognition/api_op_ListDatasetEntries.go +++ b/service/rekognition/api_op_ListDatasetEntries.go @@ -14,9 +14,8 @@ import ( // Lists the entries (images) within a dataset. An entry is a JSON Line that // contains the information for a single image, including the image location, // assigned labels, and object location bounding boxes. For more information, see -// Creating a manifest file -// (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html). -// JSON Lines in the response include information about non-terminal errors found +// Creating a manifest file (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html) +// . JSON Lines in the response include information about non-terminal errors found // in the dataset. Non terminal errors are reported in errors lists within each // JSON Line. The same information is reported in the training and testing // validation result manifests that Amazon Rekognition Custom Labels creates during @@ -50,14 +49,14 @@ type ListDatasetEntriesInput struct { // if one or more of the labels in ContainsLabels exist in the entry. ContainsLabels []string - // Specifies an error filter for the response. Specify True to only include entries - // that have errors. + // Specifies an error filter for the response. Specify True to only include + // entries that have errors. HasErrors *bool // Specify true to get only the JSON Lines where the image is labeled. Specify // false to get only the JSON Lines where the image isn't labeled. If you don't - // specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled - // images. + // specify Labeled , ListDatasetEntries returns JSON Lines for labeled and + // unlabeled images. Labeled *bool // The maximum number of results to return per paginated call. The largest value @@ -71,10 +70,10 @@ type ListDatasetEntriesInput struct { NextToken *string // If specified, ListDatasetEntries only returns JSON Lines where the value of - // SourceRefContains is part of the source-ref field. The source-ref field contains - // the Amazon S3 location of the image. You can use SouceRefContains for tasks such - // as getting the JSON Line for a single image, or gettting JSON Lines for all - // images within a specific folder. + // SourceRefContains is part of the source-ref field. The source-ref field + // contains the Amazon S3 location of the image. You can use SouceRefContains for + // tasks such as getting the JSON Line for a single image, or gettting JSON Lines + // for all images within a specific folder. SourceRefContains *string noSmithyDocumentSerde diff --git a/service/rekognition/api_op_ListDatasetLabels.go b/service/rekognition/api_op_ListDatasetLabels.go index 519067d2106..523758460f0 100644 --- a/service/rekognition/api_op_ListDatasetLabels.go +++ b/service/rekognition/api_op_ListDatasetLabels.go @@ -13,9 +13,8 @@ import ( ) // Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to -// describe images. For more information, see Labeling images -// (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html). -// Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to +// describe images. For more information, see Labeling images (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html) +// . Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to // describe images. For more information, see Labeling images in the Amazon // Rekognition Custom Labels Developer Guide. func (c *Client) ListDatasetLabels(ctx context.Context, params *ListDatasetLabelsInput, optFns ...func(*Options)) (*ListDatasetLabelsOutput, error) { diff --git a/service/rekognition/api_op_ListFaces.go b/service/rekognition/api_op_ListFaces.go index 260f4eb28b0..eaac2ef5724 100644 --- a/service/rekognition/api_op_ListFaces.go +++ b/service/rekognition/api_op_ListFaces.go @@ -53,14 +53,14 @@ type ListFacesInput struct { type ListFacesOutput struct { // Version number of the face detection model associated with the input collection - // (CollectionId). + // ( CollectionId ). FaceModelVersion *string // An array of Face objects. Faces []types.Face - // If the response is truncated, Amazon Rekognition returns this token that you can - // use in the subsequent request to retrieve the next set of faces. + // If the response is truncated, Amazon Rekognition returns this token that you + // can use in the subsequent request to retrieve the next set of faces. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_ListProjectPolicies.go b/service/rekognition/api_op_ListProjectPolicies.go index 690d573741f..ab47a90a4a8 100644 --- a/service/rekognition/api_op_ListProjectPolicies.go +++ b/service/rekognition/api_op_ListProjectPolicies.go @@ -13,8 +13,8 @@ import ( ) // Gets a list of the project policies attached to a project. To attach a project -// policy to a project, call PutProjectPolicy. To remove a project policy from a -// project, call DeleteProjectPolicy. +// policy to a project, call PutProjectPolicy . To remove a project policy from a +// project, call DeleteProjectPolicy . func (c *Client) ListProjectPolicies(ctx context.Context, params *ListProjectPoliciesInput, optFns ...func(*Options)) (*ListProjectPoliciesOutput, error) { if params == nil { params = &ListProjectPoliciesInput{} @@ -52,8 +52,8 @@ type ListProjectPoliciesInput struct { type ListProjectPoliciesOutput struct { - // If the response is truncated, Amazon Rekognition returns this token that you can - // use in the subsequent request to retrieve the next set of project policies. + // If the response is truncated, Amazon Rekognition returns this token that you + // can use in the subsequent request to retrieve the next set of project policies. NextToken *string // A list of project policies attached to the project. @@ -128,8 +128,8 @@ func (c *Client) addOperationListProjectPoliciesMiddlewares(stack *middleware.St return nil } -// ListProjectPoliciesAPIClient is a client that implements the ListProjectPolicies -// operation. +// ListProjectPoliciesAPIClient is a client that implements the +// ListProjectPolicies operation. type ListProjectPoliciesAPIClient interface { ListProjectPolicies(context.Context, *ListProjectPoliciesInput, ...func(*Options)) (*ListProjectPoliciesOutput, error) } diff --git a/service/rekognition/api_op_ListStreamProcessors.go b/service/rekognition/api_op_ListStreamProcessors.go index 7fab2e27b20..8084aea5fa0 100644 --- a/service/rekognition/api_op_ListStreamProcessors.go +++ b/service/rekognition/api_op_ListStreamProcessors.go @@ -13,7 +13,7 @@ import ( ) // Gets a list of stream processors that you have created with -// CreateStreamProcessor. +// CreateStreamProcessor . func (c *Client) ListStreamProcessors(ctx context.Context, params *ListStreamProcessorsInput, optFns ...func(*Options)) (*ListStreamProcessorsOutput, error) { if params == nil { params = &ListStreamProcessorsInput{} diff --git a/service/rekognition/api_op_ListTagsForResource.go b/service/rekognition/api_op_ListTagsForResource.go index 3f1b8d31032..f8a3e74d0b9 100644 --- a/service/rekognition/api_op_ListTagsForResource.go +++ b/service/rekognition/api_op_ListTagsForResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of tags in an Amazon Rekognition collection, stream processor, or -// Custom Labels model. This operation requires permissions to perform the +// Returns a list of tags in an Amazon Rekognition collection, stream processor, +// or Custom Labels model. This operation requires permissions to perform the // rekognition:ListTagsForResource action. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/rekognition/api_op_PutProjectPolicy.go b/service/rekognition/api_op_PutProjectPolicy.go index 1c6f60ae942..29c130376b6 100644 --- a/service/rekognition/api_op_PutProjectPolicy.go +++ b/service/rekognition/api_op_PutProjectPolicy.go @@ -19,9 +19,9 @@ import ( // The response from PutProjectPolicy is a revision ID for the project policy. You // can attach multiple project policies to a project. You can also update an // existing project policy by specifying the policy revision ID of the existing -// policy. To remove a project policy from a project, call DeleteProjectPolicy. To -// get a list of project policies attached to a project, call ListProjectPolicies. -// You copy a model version by calling CopyProjectVersion. +// policy. To remove a project policy from a project, call DeleteProjectPolicy . To +// get a list of project policies attached to a project, call ListProjectPolicies . +// You copy a model version by calling CopyProjectVersion . func (c *Client) PutProjectPolicy(ctx context.Context, params *PutProjectPolicyInput, optFns ...func(*Options)) (*PutProjectPolicyOutput, error) { if params == nil { params = &PutProjectPolicyInput{} @@ -42,8 +42,8 @@ type PutProjectPolicyInput struct { // A resource policy to add to the model. The policy is a JSON structure that // contains one or more statements that define the policy. The policy must follow // the IAM syntax. For more information about the contents of a JSON policy - // document, see IAM JSON policy reference - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html). + // document, see IAM JSON policy reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) + // . // // This member is required. PolicyDocument *string diff --git a/service/rekognition/api_op_RecognizeCelebrities.go b/service/rekognition/api_op_RecognizeCelebrities.go index a4751d45df6..dc65332bea3 100644 --- a/service/rekognition/api_op_RecognizeCelebrities.go +++ b/service/rekognition/api_op_RecognizeCelebrities.go @@ -24,7 +24,7 @@ import ( // information about which images a celebrity has been recognized in. Your // application must store this information and use the Celebrity ID property as a // unique identifier for the celebrity. If you don't store the celebrity name or -// additional information URLs returned by RecognizeCelebrities, you will need the +// additional information URLs returned by RecognizeCelebrities , you will need the // ID to identify the celebrity in a call to the GetCelebrityInfo operation. You // pass the input image either as base64-encoded image bytes or as a reference to // an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon @@ -63,10 +63,10 @@ type RecognizeCelebritiesInput struct { type RecognizeCelebritiesOutput struct { - // Details about each celebrity found in the image. Amazon Rekognition can detect a - // maximum of 64 celebrities in an image. Each celebrity object includes the - // following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality, - // Smile, Id, KnownGender, MatchConfidence, Name, Urls. + // Details about each celebrity found in the image. Amazon Rekognition can detect + // a maximum of 64 celebrities in an image. Each celebrity object includes the + // following attributes: Face , Confidence , Emotions , Landmarks , Pose , Quality + // , Smile , Id , KnownGender , MatchConfidence , Name , Urls . CelebrityFaces []types.Celebrity // Support for estimating image orientation using the the OrientationCorrection diff --git a/service/rekognition/api_op_SearchFaces.go b/service/rekognition/api_op_SearchFaces.go index e4a52c49346..265ea85d004 100644 --- a/service/rekognition/api_op_SearchFaces.go +++ b/service/rekognition/api_op_SearchFaces.go @@ -15,13 +15,13 @@ import ( // face belongs to. You get a face ID when you add a face to the collection using // the IndexFaces operation. The operation compares the features of the input face // with faces in the specified collection. You can also search faces without -// indexing faces by using the SearchFacesByImage operation. The operation response -// returns an array of faces that match, ordered by similarity score with the -// highest similarity first. More specifically, it is an array of metadata for each -// face match that is found. Along with the metadata, the response also includes a -// confidence value for each face match, indicating the confidence that the -// specific face matches the input face. For an example, see Searching for a face -// using its face ID in the Amazon Rekognition Developer Guide. This operation +// indexing faces by using the SearchFacesByImage operation. The operation +// response returns an array of faces that match, ordered by similarity score with +// the highest similarity first. More specifically, it is an array of metadata for +// each face match that is found. Along with the metadata, the response also +// includes a confidence value for each face match, indicating the confidence that +// the specific face matches the input face. For an example, see Searching for a +// face using its face ID in the Amazon Rekognition Developer Guide. This operation // requires permissions to perform the rekognition:SearchFaces action. func (c *Client) SearchFaces(ctx context.Context, params *SearchFacesInput, optFns ...func(*Options)) (*SearchFacesOutput, error) { if params == nil { @@ -69,7 +69,7 @@ type SearchFacesOutput struct { FaceMatches []types.FaceMatch // Version number of the face detection model associated with the input collection - // (CollectionId). + // ( CollectionId ). FaceModelVersion *string // ID of the face that was searched for matches in a collection. diff --git a/service/rekognition/api_op_SearchFacesByImage.go b/service/rekognition/api_op_SearchFacesByImage.go index 314a6537861..1e4251da789 100644 --- a/service/rekognition/api_op_SearchFacesByImage.go +++ b/service/rekognition/api_op_SearchFacesByImage.go @@ -15,9 +15,9 @@ import ( // searches the specified collection for matching faces. The operation compares the // features of the input face with faces in the specified collection. To search for // all faces in an input image, you might first call the IndexFaces operation, and -// then use the face IDs returned in subsequent calls to the SearchFaces operation. -// You can also call the DetectFaces operation and use the bounding boxes in the -// response to make face crops, which then you can pass in to the +// then use the face IDs returned in subsequent calls to the SearchFaces +// operation. You can also call the DetectFaces operation and use the bounding +// boxes in the response to make face crops, which then you can pass in to the // SearchFacesByImage operation. You pass the input image either as base64-encoded // image bytes or as a reference to an image in an Amazon S3 bucket. If you use the // AWS CLI to call Amazon Rekognition operations, passing image bytes is not @@ -34,11 +34,11 @@ import ( // The QualityFilter input parameter allows you to filter out detected faces that // don’t meet a required quality bar. The quality bar is based on a variety of // common use cases. Use QualityFilter to set the quality bar for filtering by -// specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, -// specify NONE. The default value is NONE. To use quality filtering, you need a +// specifying LOW , MEDIUM , or HIGH . If you do not want to filter detected faces, +// specify NONE . The default value is NONE . To use quality filtering, you need a // collection associated with version 3 of the face model or higher. To get the -// version of the face model associated with a collection, call DescribeCollection. -// This operation requires permissions to perform the +// version of the face model associated with a collection, call DescribeCollection +// . This operation requires permissions to perform the // rekognition:SearchFacesByImage action. func (c *Client) SearchFacesByImage(ctx context.Context, params *SearchFacesByImageInput, optFns ...func(*Options)) (*SearchFacesByImageOutput, error) { if params == nil { @@ -80,16 +80,16 @@ type SearchFacesByImageInput struct { // faces with the highest confidence in the match. MaxFaces *int32 - // A filter that specifies a quality bar for how much filtering is done to identify - // faces. Filtered faces aren't searched for in the collection. If you specify - // AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or - // HIGH, filtering removes all faces that don’t meet the chosen quality bar. The - // quality bar is based on a variety of common use cases. Low-quality detections - // can occur for a number of reasons. Some examples are an object that's - // misidentified as a face, a face that's too blurry, or a face with a pose that's - // too extreme to use. If you specify NONE, no filtering is performed. The default - // value is NONE. To use quality filtering, the collection you are using must be - // associated with version 3 of the face model or higher. + // A filter that specifies a quality bar for how much filtering is done to + // identify faces. Filtered faces aren't searched for in the collection. If you + // specify AUTO , Amazon Rekognition chooses the quality bar. If you specify LOW , + // MEDIUM , or HIGH , filtering removes all faces that don’t meet the chosen + // quality bar. The quality bar is based on a variety of common use cases. + // Low-quality detections can occur for a number of reasons. Some examples are an + // object that's misidentified as a face, a face that's too blurry, or a face with + // a pose that's too extreme to use. If you specify NONE , no filtering is + // performed. The default value is NONE . To use quality filtering, the collection + // you are using must be associated with version 3 of the face model or higher. QualityFilter types.QualityFilter noSmithyDocumentSerde @@ -102,14 +102,14 @@ type SearchFacesByImageOutput struct { FaceMatches []types.FaceMatch // Version number of the face detection model associated with the input collection - // (CollectionId). + // ( CollectionId ). FaceModelVersion *string - // The bounding box around the face in the input image that Amazon Rekognition used - // for the search. + // The bounding box around the face in the input image that Amazon Rekognition + // used for the search. SearchedFaceBoundingBox *types.BoundingBox - // The level of confidence that the searchedFaceBoundingBox, contains a face. + // The level of confidence that the searchedFaceBoundingBox , contains a face. SearchedFaceConfidence *float32 // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartCelebrityRecognition.go b/service/rekognition/api_op_StartCelebrityRecognition.go index 450c4d93fe6..662b06d5b7a 100644 --- a/service/rekognition/api_op_StartCelebrityRecognition.go +++ b/service/rekognition/api_op_StartCelebrityRecognition.go @@ -14,14 +14,14 @@ import ( // Starts asynchronous recognition of celebrities in a stored video. Amazon // Rekognition Video can detect celebrities in a video must be stored in an Amazon // S3 bucket. Use Video to specify the bucket name and the filename of the video. -// StartCelebrityRecognition returns a job identifier (JobId) which you use to get -// the results of the analysis. When celebrity recognition analysis is finished, -// Amazon Rekognition Video publishes a completion status to the Amazon Simple -// Notification Service topic that you specify in NotificationChannel. To get the -// results of the celebrity recognition analysis, first check that the status value -// published to the Amazon SNS topic is SUCCEEDED. If so, call -// GetCelebrityRecognition and pass the job identifier (JobId) from the initial -// call to StartCelebrityRecognition. For more information, see Recognizing +// StartCelebrityRecognition returns a job identifier ( JobId ) which you use to +// get the results of the analysis. When celebrity recognition analysis is +// finished, Amazon Rekognition Video publishes a completion status to the Amazon +// Simple Notification Service topic that you specify in NotificationChannel . To +// get the results of the celebrity recognition analysis, first check that the +// status value published to the Amazon SNS topic is SUCCEEDED . If so, call +// GetCelebrityRecognition and pass the job identifier ( JobId ) from the initial +// call to StartCelebrityRecognition . For more information, see Recognizing // celebrities in the Amazon Rekognition Developer Guide. func (c *Client) StartCelebrityRecognition(ctx context.Context, params *StartCelebrityRecognitionInput, optFns ...func(*Options)) (*StartCelebrityRecognitionOutput, error) { if params == nil { @@ -69,8 +69,8 @@ type StartCelebrityRecognitionInput struct { type StartCelebrityRecognitionOutput struct { - // The identifier for the celebrity recognition analysis job. Use JobId to identify - // the job in a subsequent call to GetCelebrityRecognition. + // The identifier for the celebrity recognition analysis job. Use JobId to + // identify the job in a subsequent call to GetCelebrityRecognition . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartContentModeration.go b/service/rekognition/api_op_StartContentModeration.go index 5196f3848d1..df5dac8f919 100644 --- a/service/rekognition/api_op_StartContentModeration.go +++ b/service/rekognition/api_op_StartContentModeration.go @@ -13,18 +13,18 @@ import ( // Starts asynchronous detection of inappropriate, unwanted, or offensive content // in a stored video. For a list of moderation labels in Amazon Rekognition, see -// Using the image and video moderation APIs -// (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api). -// Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 -// bucket. Use Video to specify the bucket name and the filename of the video. -// StartContentModeration returns a job identifier (JobId) which you use to get the -// results of the analysis. When content analysis is finished, Amazon Rekognition -// Video publishes a completion status to the Amazon Simple Notification Service -// topic that you specify in NotificationChannel. To get the results of the content -// analysis, first check that the status value published to the Amazon SNS topic is -// SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) -// from the initial call to StartContentModeration. For more information, see -// Moderating content in the Amazon Rekognition Developer Guide. +// Using the image and video moderation APIs (https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api) +// . Amazon Rekognition Video can moderate content in a video stored in an Amazon +// S3 bucket. Use Video to specify the bucket name and the filename of the video. +// StartContentModeration returns a job identifier ( JobId ) which you use to get +// the results of the analysis. When content analysis is finished, Amazon +// Rekognition Video publishes a completion status to the Amazon Simple +// Notification Service topic that you specify in NotificationChannel . To get the +// results of the content analysis, first check that the status value published to +// the Amazon SNS topic is SUCCEEDED . If so, call GetContentModeration and pass +// the job identifier ( JobId ) from the initial call to StartContentModeration . +// For more information, see Moderating content in the Amazon Rekognition Developer +// Guide. func (c *Client) StartContentModeration(ctx context.Context, params *StartContentModerationInput, optFns ...func(*Options)) (*StartContentModerationOutput, error) { if params == nil { params = &StartContentModerationInput{} @@ -65,7 +65,7 @@ type StartContentModerationInput struct { // Rekognition is that the moderated content is correctly identified. 0 is the // lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't // return any moderated content labels with a confidence level lower than this - // specified value. If you don't specify MinConfidence, GetContentModeration + // specified value. If you don't specify MinConfidence , GetContentModeration // returns labels with confidence values greater than or equal to 50 percent. MinConfidence *float32 @@ -81,7 +81,7 @@ type StartContentModerationInput struct { type StartContentModerationOutput struct { // The identifier for the content analysis job. Use JobId to identify the job in a - // subsequent call to GetContentModeration. + // subsequent call to GetContentModeration . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartFaceDetection.go b/service/rekognition/api_op_StartFaceDetection.go index 47467e17c56..29efa5a7a1c 100644 --- a/service/rekognition/api_op_StartFaceDetection.go +++ b/service/rekognition/api_op_StartFaceDetection.go @@ -14,14 +14,14 @@ import ( // Starts asynchronous detection of faces in a stored video. Amazon Rekognition // Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to // specify the bucket name and the filename of the video. StartFaceDetection -// returns a job identifier (JobId) that you use to get the results of the +// returns a job identifier ( JobId ) that you use to get the results of the // operation. When face detection is finished, Amazon Rekognition Video publishes a // completion status to the Amazon Simple Notification Service topic that you -// specify in NotificationChannel. To get the results of the face detection +// specify in NotificationChannel . To get the results of the face detection // operation, first check that the status value published to the Amazon SNS topic -// is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) -// from the initial call to StartFaceDetection. For more information, see Detecting -// faces in a stored video in the Amazon Rekognition Developer Guide. +// is SUCCEEDED . If so, call GetFaceDetection and pass the job identifier ( JobId +// ) from the initial call to StartFaceDetection . For more information, see +// Detecting faces in a stored video in the Amazon Rekognition Developer Guide. func (c *Client) StartFaceDetection(ctx context.Context, params *StartFaceDetectionInput, optFns ...func(*Options)) (*StartFaceDetectionOutput, error) { if params == nil { params = &StartFaceDetectionInput{} @@ -74,7 +74,7 @@ type StartFaceDetectionInput struct { type StartFaceDetectionOutput struct { // The identifier for the face detection job. Use JobId to identify the job in a - // subsequent call to GetFaceDetection. + // subsequent call to GetFaceDetection . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartFaceSearch.go b/service/rekognition/api_op_StartFaceSearch.go index 9d04bf335c2..d4c00d2c0d7 100644 --- a/service/rekognition/api_op_StartFaceSearch.go +++ b/service/rekognition/api_op_StartFaceSearch.go @@ -11,18 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts the asynchronous search for faces in a collection that match the faces of -// persons detected in a stored video. The video must be stored in an Amazon S3 +// Starts the asynchronous search for faces in a collection that match the faces +// of persons detected in a stored video. The video must be stored in an Amazon S3 // bucket. Use Video to specify the bucket name and the filename of the video. -// StartFaceSearch returns a job identifier (JobId) which you use to get the search -// results once the search has completed. When searching is finished, Amazon +// StartFaceSearch returns a job identifier ( JobId ) which you use to get the +// search results once the search has completed. When searching is finished, Amazon // Rekognition Video publishes a completion status to the Amazon Simple -// Notification Service topic that you specify in NotificationChannel. To get the +// Notification Service topic that you specify in NotificationChannel . To get the // search results, first check that the status value published to the Amazon SNS -// topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier -// (JobId) from the initial call to StartFaceSearch. For more information, see -// Searching stored videos for faces -// (https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html). +// topic is SUCCEEDED . If so, call GetFaceSearch and pass the job identifier ( +// JobId ) from the initial call to StartFaceSearch . For more information, see +// Searching stored videos for faces (https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html) +// . func (c *Client) StartFaceSearch(ctx context.Context, params *StartFaceSearchInput, optFns ...func(*Options)) (*StartFaceSearchOutput, error) { if params == nil { params = &StartFaceSearchInput{} @@ -78,8 +78,8 @@ type StartFaceSearchInput struct { type StartFaceSearchOutput struct { - // The identifier for the search job. Use JobId to identify the job in a subsequent - // call to GetFaceSearch. + // The identifier for the search job. Use JobId to identify the job in a + // subsequent call to GetFaceSearch . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartLabelDetection.go b/service/rekognition/api_op_StartLabelDetection.go index b121507b853..82f27577955 100644 --- a/service/rekognition/api_op_StartLabelDetection.go +++ b/service/rekognition/api_op_StartLabelDetection.go @@ -17,22 +17,21 @@ import ( // graduation, and birthday party; concepts like landscape, evening, and nature; // and activities like a person getting out of a car or a person skiing. The video // must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and -// the filename of the video. StartLabelDetection returns a job identifier (JobId) -// which you use to get the results of the operation. When label detection is +// the filename of the video. StartLabelDetection returns a job identifier ( JobId +// ) which you use to get the results of the operation. When label detection is // finished, Amazon Rekognition Video publishes a completion status to the Amazon -// Simple Notification Service topic that you specify in NotificationChannel. To +// Simple Notification Service topic that you specify in NotificationChannel . To // get the results of the label detection operation, first check that the status -// value published to the Amazon SNS topic is SUCCEEDED. If so, call -// GetLabelDetection and pass the job identifier (JobId) from the initial call to -// StartLabelDetection. Optional Parameters StartLabelDetection has the +// value published to the Amazon SNS topic is SUCCEEDED . If so, call +// GetLabelDetection and pass the job identifier ( JobId ) from the initial call to +// StartLabelDetection . Optional Parameters StartLabelDetection has the // GENERAL_LABELS Feature applied by default. This feature allows you to provide // filtering criteria to the Settings parameter. You can filter with sets of // individual labels or with label categories. You can specify inclusive filters, // exclusive filters, or a combination of inclusive and exclusive filters. For more -// information on filtering, see Detecting labels in a video -// (https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html). -// You can specify MinConfidence to control the confidence threshold for the labels -// returned. The default is 50. +// information on filtering, see Detecting labels in a video (https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html) +// . You can specify MinConfidence to control the confidence threshold for the +// labels returned. The default is 50. func (c *Client) StartLabelDetection(ctx context.Context, params *StartLabelDetectionInput, optFns ...func(*Options)) (*StartLabelDetectionOutput, error) { if params == nil { params = &StartLabelDetectionInput{} @@ -62,8 +61,8 @@ type StartLabelDetectionInput struct { // than once. ClientRequestToken *string - // The features to return after video analysis. You can specify that GENERAL_LABELS - // are returned. + // The features to return after video analysis. You can specify that + // GENERAL_LABELS are returned. Features []types.LabelDetectionFeatureName // An identifier you specify that's returned in the completion notification that's @@ -77,7 +76,7 @@ type StartLabelDetectionInput struct { // Rekognition is that a label is correctly identified.0 is the lowest confidence. // 100 is the highest confidence. Amazon Rekognition Video doesn't return any // labels with a confidence level lower than this specified value. If you don't - // specify MinConfidence, the operation returns labels and bounding boxes (if + // specify MinConfidence , the operation returns labels and bounding boxes (if // detected) with confidence values greater than or equal to 50 percent. MinConfidence *float32 @@ -87,9 +86,9 @@ type StartLabelDetectionInput struct { // AmazonRekognitionServiceRole permissions policy. NotificationChannel *types.NotificationChannel - // The settings for a StartLabelDetection request.Contains the specified parameters - // for the label detection request of an asynchronous label analysis operation. - // Settings can include filters for GENERAL_LABELS. + // The settings for a StartLabelDetection request.Contains the specified + // parameters for the label detection request of an asynchronous label analysis + // operation. Settings can include filters for GENERAL_LABELS. Settings *types.LabelDetectionSettings noSmithyDocumentSerde @@ -98,7 +97,7 @@ type StartLabelDetectionInput struct { type StartLabelDetectionOutput struct { // The identifier for the label detection job. Use JobId to identify the job in a - // subsequent call to GetLabelDetection. + // subsequent call to GetLabelDetection . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartPersonTracking.go b/service/rekognition/api_op_StartPersonTracking.go index 0e427364826..2f3b0f1517f 100644 --- a/service/rekognition/api_op_StartPersonTracking.go +++ b/service/rekognition/api_op_StartPersonTracking.go @@ -14,13 +14,13 @@ import ( // Starts the asynchronous tracking of a person's path in a stored video. Amazon // Rekognition Video can track the path of people in a video stored in an Amazon S3 // bucket. Use Video to specify the bucket name and the filename of the video. -// StartPersonTracking returns a job identifier (JobId) which you use to get the +// StartPersonTracking returns a job identifier ( JobId ) which you use to get the // results of the operation. When label detection is finished, Amazon Rekognition // publishes a completion status to the Amazon Simple Notification Service topic -// that you specify in NotificationChannel. To get the results of the person +// that you specify in NotificationChannel . To get the results of the person // detection operation, first check that the status value published to the Amazon -// SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job -// identifier (JobId) from the initial call to StartPersonTracking. +// SNS topic is SUCCEEDED . If so, call GetPersonTracking and pass the job +// identifier ( JobId ) from the initial call to StartPersonTracking . func (c *Client) StartPersonTracking(ctx context.Context, params *StartPersonTrackingInput, optFns ...func(*Options)) (*StartPersonTrackingOutput, error) { if params == nil { params = &StartPersonTrackingInput{} @@ -68,7 +68,7 @@ type StartPersonTrackingInput struct { type StartPersonTrackingOutput struct { // The identifier for the person detection job. Use JobId to identify the job in a - // subsequent call to GetPersonTracking. + // subsequent call to GetPersonTracking . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartProjectVersion.go b/service/rekognition/api_op_StartProjectVersion.go index 9df8a466e61..d2a8ae24fbd 100644 --- a/service/rekognition/api_op_StartProjectVersion.go +++ b/service/rekognition/api_op_StartProjectVersion.go @@ -12,13 +12,13 @@ import ( ) // Starts the running of the version of a model. Starting a model takes a while to -// complete. To check the current state of the model, use DescribeProjectVersions. +// complete. To check the current state of the model, use DescribeProjectVersions . // Once the model is running, you can detect custom labels in new images by calling -// DetectCustomLabels. You are charged for the amount of time that the model is -// running. To stop a running model, call StopProjectVersion. For more information, -// see Running a trained Amazon Rekognition Custom Labels model in the Amazon -// Rekognition Custom Labels Guide. This operation requires permissions to perform -// the rekognition:StartProjectVersion action. +// DetectCustomLabels . You are charged for the amount of time that the model is +// running. To stop a running model, call StopProjectVersion . For more +// information, see Running a trained Amazon Rekognition Custom Labels model in the +// Amazon Rekognition Custom Labels Guide. This operation requires permissions to +// perform the rekognition:StartProjectVersion action. func (c *Client) StartProjectVersion(ctx context.Context, params *StartProjectVersionInput, optFns ...func(*Options)) (*StartProjectVersionOutput, error) { if params == nil { params = &StartProjectVersionInput{} @@ -36,12 +36,12 @@ func (c *Client) StartProjectVersion(ctx context.Context, params *StartProjectVe type StartProjectVersionInput struct { - // The minimum number of inference units to use. A single inference unit represents - // 1 hour of processing. For information about the number of transactions per - // second (TPS) that an inference unit can support, see Running a trained Amazon - // Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide. - // Use a higher number to increase the TPS throughput of your model. You are - // charged for the number of inference units that you use. + // The minimum number of inference units to use. A single inference unit + // represents 1 hour of processing. For information about the number of + // transactions per second (TPS) that an inference unit can support, see Running a + // trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom + // Labels Guide. Use a higher number to increase the TPS throughput of your model. + // You are charged for the number of inference units that you use. // // This member is required. MinInferenceUnits *int32 diff --git a/service/rekognition/api_op_StartSegmentDetection.go b/service/rekognition/api_op_StartSegmentDetection.go index 0c76a9f0c2e..5765836d5a5 100644 --- a/service/rekognition/api_op_StartSegmentDetection.go +++ b/service/rekognition/api_op_StartSegmentDetection.go @@ -14,19 +14,19 @@ import ( // Starts asynchronous detection of segment detection in a stored video. Amazon // Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. // Use Video to specify the bucket name and the filename of the video. -// StartSegmentDetection returns a job identifier (JobId) which you use to get the -// results of the operation. When segment detection is finished, Amazon Rekognition -// Video publishes a completion status to the Amazon Simple Notification Service -// topic that you specify in NotificationChannel. You can use the Filters -// (StartSegmentDetectionFilters) input parameter to specify the minimum detection -// confidence returned in the response. Within Filters, use ShotFilter -// (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter -// (StartTechnicalCueDetectionFilter) to filter technical cues. To get the results -// of the segment detection operation, first check that the status value published -// to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass -// the job identifier (JobId) from the initial call to StartSegmentDetection. For -// more information, see Detecting video segments in stored video in the Amazon -// Rekognition Developer Guide. +// StartSegmentDetection returns a job identifier ( JobId ) which you use to get +// the results of the operation. When segment detection is finished, Amazon +// Rekognition Video publishes a completion status to the Amazon Simple +// Notification Service topic that you specify in NotificationChannel . You can use +// the Filters ( StartSegmentDetectionFilters ) input parameter to specify the +// minimum detection confidence returned in the response. Within Filters , use +// ShotFilter ( StartShotDetectionFilter ) to filter detected shots. Use +// TechnicalCueFilter ( StartTechnicalCueDetectionFilter ) to filter technical +// cues. To get the results of the segment detection operation, first check that +// the status value published to the Amazon SNS topic is SUCCEEDED . if so, call +// GetSegmentDetection and pass the job identifier ( JobId ) from the initial call +// to StartSegmentDetection . For more information, see Detecting video segments in +// stored video in the Amazon Rekognition Developer Guide. func (c *Client) StartSegmentDetection(ctx context.Context, params *StartSegmentDetectionInput, optFns ...func(*Options)) (*StartSegmentDetectionOutput, error) { if params == nil { params = &StartSegmentDetectionInput{} @@ -44,8 +44,8 @@ func (c *Client) StartSegmentDetection(ctx context.Context, params *StartSegment type StartSegmentDetectionInput struct { - // An array of segment types to detect in the video. Valid values are TECHNICAL_CUE - // and SHOT. + // An array of segment types to detect in the video. Valid values are + // TECHNICAL_CUE and SHOT. // // This member is required. SegmentTypes []types.SegmentType @@ -85,7 +85,7 @@ type StartSegmentDetectionInput struct { type StartSegmentDetectionOutput struct { // Unique identifier for the segment detection job. The JobId is returned from - // StartSegmentDetection. + // StartSegmentDetection . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartStreamProcessor.go b/service/rekognition/api_op_StartStreamProcessor.go index 7d043512ba6..4599b326d73 100644 --- a/service/rekognition/api_op_StartStreamProcessor.go +++ b/service/rekognition/api_op_StartStreamProcessor.go @@ -12,9 +12,9 @@ import ( ) // Starts processing a stream processor. You create a stream processor by calling -// CreateStreamProcessor. To tell StartStreamProcessor which stream processor to +// CreateStreamProcessor . To tell StartStreamProcessor which stream processor to // start, use the value of the Name field specified in the call to -// CreateStreamProcessor. If you are using a label detection stream processor to +// CreateStreamProcessor . If you are using a label detection stream processor to // detect labels, you need to provide a Start selector and a Stop selector to // determine the length of the stream processing time. func (c *Client) StartStreamProcessor(ctx context.Context, params *StartStreamProcessorInput, optFns ...func(*Options)) (*StartStreamProcessorOutput, error) { @@ -42,9 +42,8 @@ type StartStreamProcessorInput struct { // Specifies the starting point in the Kinesis stream to start processing. You can // use the producer timestamp or the fragment number. If you use the producer // timestamp, you must put the time in milliseconds. For more information about - // fragment numbers, see Fragment - // (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html). - // This is a required parameter for label detection stream processors and should + // fragment numbers, see Fragment (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html) + // . This is a required parameter for label detection stream processors and should // not be used to start a face search stream processor. StartSelector *types.StreamProcessingStartSelector diff --git a/service/rekognition/api_op_StartTextDetection.go b/service/rekognition/api_op_StartTextDetection.go index 63e08904329..8b69a1d245f 100644 --- a/service/rekognition/api_op_StartTextDetection.go +++ b/service/rekognition/api_op_StartTextDetection.go @@ -14,13 +14,13 @@ import ( // Starts asynchronous detection of text in a stored video. Amazon Rekognition // Video can detect text in a video stored in an Amazon S3 bucket. Use Video to // specify the bucket name and the filename of the video. StartTextDetection -// returns a job identifier (JobId) which you use to get the results of the +// returns a job identifier ( JobId ) which you use to get the results of the // operation. When text detection is finished, Amazon Rekognition Video publishes a // completion status to the Amazon Simple Notification Service topic that you -// specify in NotificationChannel. To get the results of the text detection +// specify in NotificationChannel . To get the results of the text detection // operation, first check that the status value published to the Amazon SNS topic -// is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) -// from the initial call to StartTextDetection. +// is SUCCEEDED . if so, call GetTextDetection and pass the job identifier ( JobId +// ) from the initial call to StartTextDetection . func (c *Client) StartTextDetection(ctx context.Context, params *StartTextDetectionInput, optFns ...func(*Options)) (*StartTextDetectionOutput, error) { if params == nil { params = &StartTextDetectionInput{} @@ -62,12 +62,12 @@ type StartTextDetectionInput struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the completion status of a video analysis operation. For more - // information, see Calling Amazon Rekognition Video operations - // (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html). Note that - // the Amazon SNS topic must have a topic name that begins with AmazonRekognition - // if you are using the AmazonRekognitionServiceRole permissions policy to access - // the topic. For more information, see Giving access to multiple Amazon SNS topics - // (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). + // information, see Calling Amazon Rekognition Video operations (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html) + // . Note that the Amazon SNS topic must have a topic name that begins with + // AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions + // policy to access the topic. For more information, see Giving access to multiple + // Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics) + // . NotificationChannel *types.NotificationChannel noSmithyDocumentSerde @@ -76,7 +76,7 @@ type StartTextDetectionInput struct { type StartTextDetectionOutput struct { // Identifier for the text detection job. Use JobId to identify the job in a - // subsequent call to GetTextDetection. + // subsequent call to GetTextDetection . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StopProjectVersion.go b/service/rekognition/api_op_StopProjectVersion.go index d155db52cf0..7afd1e46cf4 100644 --- a/service/rekognition/api_op_StopProjectVersion.go +++ b/service/rekognition/api_op_StopProjectVersion.go @@ -12,7 +12,7 @@ import ( ) // Stops a running model. The operation might take a while to complete. To check -// the current status, call DescribeProjectVersions. +// the current status, call DescribeProjectVersions . func (c *Client) StopProjectVersion(ctx context.Context, params *StopProjectVersionInput, optFns ...func(*Options)) (*StopProjectVersionOutput, error) { if params == nil { params = &StopProjectVersionInput{} diff --git a/service/rekognition/api_op_StopStreamProcessor.go b/service/rekognition/api_op_StopStreamProcessor.go index 3e56d451a35..44a123b0e58 100644 --- a/service/rekognition/api_op_StopStreamProcessor.go +++ b/service/rekognition/api_op_StopStreamProcessor.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a running stream processor that was created by CreateStreamProcessor. +// Stops a running stream processor that was created by CreateStreamProcessor . func (c *Client) StopStreamProcessor(ctx context.Context, params *StopStreamProcessorInput, optFns ...func(*Options)) (*StopStreamProcessorOutput, error) { if params == nil { params = &StopStreamProcessorInput{} @@ -28,7 +28,7 @@ func (c *Client) StopStreamProcessor(ctx context.Context, params *StopStreamProc type StopStreamProcessorInput struct { - // The name of a stream processor created by CreateStreamProcessor. + // The name of a stream processor created by CreateStreamProcessor . // // This member is required. Name *string diff --git a/service/rekognition/api_op_TagResource.go b/service/rekognition/api_op_TagResource.go index ac42553af5f..e0b7633975b 100644 --- a/service/rekognition/api_op_TagResource.go +++ b/service/rekognition/api_op_TagResource.go @@ -12,8 +12,9 @@ import ( // Adds one or more key-value tags to an Amazon Rekognition collection, stream // processor, or Custom Labels model. For more information, see Tagging AWS -// Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). This -// operation requires permissions to perform the rekognition:TagResource action. +// Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) . +// This operation requires permissions to perform the rekognition:TagResource +// action. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/rekognition/api_op_UpdateDatasetEntries.go b/service/rekognition/api_op_UpdateDatasetEntries.go index 77e0e5f6e1c..d3352831c7c 100644 --- a/service/rekognition/api_op_UpdateDatasetEntries.go +++ b/service/rekognition/api_op_UpdateDatasetEntries.go @@ -20,14 +20,14 @@ import ( // image in the dataset is updated. If source-ref field doesn't reference an // existing image, the image is added as a new image to the dataset. You specify // the changes that you want to make in the Changes input parameter. There isn't a -// limit to the number JSON Lines that you can change, but the size of Changes must -// be less than 5MB. UpdateDatasetEntries returns immediatly, but the dataset +// limit to the number JSON Lines that you can change, but the size of Changes +// must be less than 5MB. UpdateDatasetEntries returns immediatly, but the dataset // update might take a while to complete. Use DescribeDataset to check the current // status. The dataset updated successfully if the value of Status is -// UPDATE_COMPLETE. To check if any non-terminal errors occured, call -// ListDatasetEntries and check for the presence of errors lists in the JSON Lines. -// Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). -// Currently, you can't access the terminal error information from the Amazon +// UPDATE_COMPLETE . To check if any non-terminal errors occured, call +// ListDatasetEntries and check for the presence of errors lists in the JSON +// Lines. Dataset update fails if a terminal error occurs ( Status = UPDATE_FAILED +// ). Currently, you can't access the terminal error information from the Amazon // Rekognition Custom Labels SDK. This operation requires permissions to perform // the rekognition:UpdateDatasetEntries action. func (c *Client) UpdateDatasetEntries(ctx context.Context, params *UpdateDatasetEntriesInput, optFns ...func(*Options)) (*UpdateDatasetEntriesOutput, error) { diff --git a/service/rekognition/api_op_UpdateStreamProcessor.go b/service/rekognition/api_op_UpdateStreamProcessor.go index d9c0d1cb163..1b774ae4c1f 100644 --- a/service/rekognition/api_op_UpdateStreamProcessor.go +++ b/service/rekognition/api_op_UpdateStreamProcessor.go @@ -44,8 +44,8 @@ type UpdateStreamProcessorInput struct { // A list of parameters you want to delete from the stream processor. ParametersToDelete []types.StreamProcessorParameterToDelete - // Specifies locations in the frames where Amazon Rekognition checks for objects or - // people. This is an optional parameter for label detection stream processors. + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. This is an optional parameter for label detection stream processors. RegionsOfInterestForUpdate []types.RegionOfInterest // The stream processor settings that you want to update. Label detection settings diff --git a/service/rekognition/doc.go b/service/rekognition/doc.go index d1b05d2b5d9..ea1842c553e 100644 --- a/service/rekognition/doc.go +++ b/service/rekognition/doc.go @@ -1,261 +1,78 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package rekognition provides the API client, operations, and parameter types for -// Amazon Rekognition. -// -// This is the API Reference for Amazon Rekognition Image -// (https://docs.aws.amazon.com/rekognition/latest/dg/images.html), Amazon -// Rekognition Custom Labels -// (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html), -// Amazon Rekognition Stored Video -// (https://docs.aws.amazon.com/rekognition/latest/dg/video.html), Amazon -// Rekognition Streaming Video -// (https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html). It -// provides descriptions of actions, data types, common parameters, and common +// Package rekognition provides the API client, operations, and parameter types +// for Amazon Rekognition. +// +// This is the API Reference for Amazon Rekognition Image (https://docs.aws.amazon.com/rekognition/latest/dg/images.html) +// , Amazon Rekognition Custom Labels (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html) +// , Amazon Rekognition Stored Video (https://docs.aws.amazon.com/rekognition/latest/dg/video.html) +// , Amazon Rekognition Streaming Video (https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html) +// . It provides descriptions of actions, data types, common parameters, and common // errors. Amazon Rekognition Image -// -// * CompareFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html) -// -// * -// CreateCollection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html) -// -// * -// DeleteCollection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html) -// -// * -// DeleteFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html) -// -// * -// DescribeCollection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html) -// -// * -// DetectFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html) -// -// * -// DetectLabels -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html) -// -// * -// DetectModerationLabels -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html) -// -// * -// DetectProtectiveEquipment -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html) -// -// * -// DetectText -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html) -// -// * -// GetCelebrityInfo -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html) -// -// * -// IndexFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html) -// -// * -// ListCollections -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html) -// -// * -// ListFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html) -// -// * -// RecognizeCelebrities -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html) -// -// * -// SearchFaces -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html) -// -// * -// SearchFacesByImage -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html) -// -// Amazon -// Rekognition Custom Labels -// -// * CopyProjectVersion -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html) -// -// * -// CreateDataset -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html) -// -// * -// CreateProject -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html) -// -// * -// CreateProjectVersion -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html) -// -// * -// DeleteDataset -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html) -// -// * -// DeleteProject -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html) -// -// * -// DeleteProjectPolicy -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html) -// -// * -// DeleteProjectVersion -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html) -// -// * -// DescribeDataset -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html) -// -// * -// DescribeProjects -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html) -// -// * -// DescribeProjectVersions -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html) -// -// * -// DetectCustomLabels -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html) -// -// * -// DistributeDatasetEntries -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html) -// -// * -// ListDatasetEntries -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html) -// -// * -// ListDatasetLabels -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html) -// -// * -// ListProjectPolicies -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html) -// -// * -// PutProjectPolicy -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html) -// -// * -// StartProjectVersion -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html) -// -// * -// StopProjectVersion -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html) -// -// * -// UpdateDatasetEntries -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html) -// -// Amazon -// Rekognition Video Stored Video -// -// * GetCelebrityRecognition -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html) -// -// * -// GetContentModeration -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html) -// -// * -// GetFaceDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html) -// -// * -// GetFaceSearch -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html) -// -// * -// GetLabelDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html) -// -// * -// GetPersonTracking -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html) -// -// * -// GetSegmentDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html) -// -// * -// GetTextDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html) -// -// * -// StartCelebrityRecognition -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html) -// -// * -// StartContentModeration -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html) -// -// * -// StartFaceDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html) -// -// * -// StartFaceSearch -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html) -// -// * -// StartLabelDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html) -// -// * -// StartPersonTracking -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html) -// -// * -// StartSegmentDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html) -// -// * -// StartTextDetection -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html) -// -// Amazon -// Rekognition Video Streaming Video -// -// * CreateStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html) -// -// * -// DeleteStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html) -// -// * -// DescribeStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html) -// -// * -// ListStreamProcessors -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html) -// -// * -// StartStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html) -// -// * -// StopStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html) -// -// * -// UpdateStreamProcessor -// (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html) +// - CompareFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html) +// - CreateCollection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html) +// - DeleteCollection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html) +// - DeleteFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html) +// - DescribeCollection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html) +// - DetectFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html) +// - DetectLabels (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html) +// - DetectModerationLabels (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html) +// - DetectProtectiveEquipment (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html) +// - DetectText (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html) +// - GetCelebrityInfo (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html) +// - IndexFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html) +// - ListCollections (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html) +// - ListFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html) +// - RecognizeCelebrities (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html) +// - SearchFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html) +// - SearchFacesByImage (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html) +// +// Amazon Rekognition Custom Labels +// - CopyProjectVersion (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html) +// - CreateDataset (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html) +// - CreateProject (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html) +// - CreateProjectVersion (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html) +// - DeleteDataset (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html) +// - DeleteProject (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html) +// - DeleteProjectPolicy (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html) +// - DeleteProjectVersion (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html) +// - DescribeDataset (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html) +// - DescribeProjects (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html) +// - DescribeProjectVersions (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html) +// - DetectCustomLabels (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html) +// - DistributeDatasetEntries (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html) +// - ListDatasetEntries (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html) +// - ListDatasetLabels (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html) +// - ListProjectPolicies (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html) +// - PutProjectPolicy (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html) +// - StartProjectVersion (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html) +// - StopProjectVersion (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html) +// - UpdateDatasetEntries (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html) +// +// Amazon Rekognition Video Stored Video +// - GetCelebrityRecognition (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html) +// - GetContentModeration (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html) +// - GetFaceDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html) +// - GetFaceSearch (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html) +// - GetLabelDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html) +// - GetPersonTracking (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html) +// - GetSegmentDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html) +// - GetTextDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html) +// - StartCelebrityRecognition (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html) +// - StartContentModeration (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html) +// - StartFaceDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html) +// - StartFaceSearch (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html) +// - StartLabelDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html) +// - StartPersonTracking (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html) +// - StartSegmentDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html) +// - StartTextDetection (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html) +// +// Amazon Rekognition Video Streaming Video +// - CreateStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html) +// - DeleteStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html) +// - DescribeStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html) +// - ListStreamProcessors (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html) +// - StartStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html) +// - StopStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html) +// - UpdateStreamProcessor (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html) package rekognition diff --git a/service/rekognition/types/enums.go b/service/rekognition/types/enums.go index 354112e1c30..918b0f9732e 100644 --- a/service/rekognition/types/enums.go +++ b/service/rekognition/types/enums.go @@ -10,9 +10,9 @@ const ( AttributeAll Attribute = "ALL" ) -// Values returns all known values for Attribute. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Attribute. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Attribute) Values() []Attribute { return []Attribute{ "DEFAULT", @@ -133,9 +133,9 @@ const ( DatasetStatusMessageCodeClientError DatasetStatusMessageCode = "CLIENT_ERROR" ) -// Values returns all known values for DatasetStatusMessageCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DatasetStatusMessageCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatusMessageCode) Values() []DatasetStatusMessageCode { return []DatasetStatusMessageCode{ "SUCCESS", @@ -376,9 +376,9 @@ const ( LandmarkTypeUpperJawlineRight LandmarkType = "upperJawlineRight" ) -// Values returns all known values for LandmarkType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LandmarkType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LandmarkType) Values() []LandmarkType { return []LandmarkType{ "eyeLeft", @@ -424,8 +424,8 @@ const ( OrientationCorrectionRotate270 OrientationCorrection = "ROTATE_270" ) -// Values returns all known values for OrientationCorrection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OrientationCorrection. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OrientationCorrection) Values() []OrientationCorrection { return []OrientationCorrection{ @@ -633,8 +633,8 @@ const ( StreamProcessorStatusUpdating StreamProcessorStatus = "UPDATING" ) -// Values returns all known values for StreamProcessorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StreamProcessorStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StreamProcessorStatus) Values() []StreamProcessorStatus { return []StreamProcessorStatus{ @@ -683,9 +683,9 @@ const ( TextTypesWord TextTypes = "WORD" ) -// Values returns all known values for TextTypes. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TextTypes. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TextTypes) Values() []TextTypes { return []TextTypes{ "LINE", diff --git a/service/rekognition/types/errors.go b/service/rekognition/types/errors.go index 574736ea55e..faa634f0d07 100644 --- a/service/rekognition/types/errors.go +++ b/service/rekognition/types/errors.go @@ -310,10 +310,10 @@ func (e *InvalidS3ObjectException) ErrorCode() string { func (e *InvalidS3ObjectException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An Amazon Rekognition service limit was exceeded. For example, if you start too -// many Amazon Rekognition Video jobs concurrently, calls to start operations -// (StartLabelDetection, for example) will raise a LimitExceededException exception -// (HTTP status code: 400) until the number of concurrently running jobs is below -// the Amazon Rekognition service limit. +// many Amazon Rekognition Video jobs concurrently, calls to start operations ( +// StartLabelDetection , for example) will raise a LimitExceededException +// exception (HTTP status code: 400) until the number of concurrently running jobs +// is below the Amazon Rekognition service limit. type LimitExceededException struct { Message *string diff --git a/service/rekognition/types/types.go b/service/rekognition/types/types.go index 97798ad2a7c..a0578f54fd2 100644 --- a/service/rekognition/types/types.go +++ b/service/rekognition/types/types.go @@ -23,9 +23,9 @@ type AgeRange struct { noSmithyDocumentSerde } -// Assets are the images that you use to train and evaluate a model version. Assets -// can also contain validation information that you use to debug a failed model -// training. +// Assets are the images that you use to train and evaluate a model version. +// Assets can also contain validation information that you use to debug a failed +// model training. type Asset struct { // The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest @@ -36,8 +36,8 @@ type Asset struct { } // Metadata information about an audio stream. An array of AudioMetadata objects -// for the audio streams found in a stored video is returned by -// GetSegmentDetection. +// for the audio streams found in a stored video is returned by GetSegmentDetection +// . type AudioMetadata struct { // The audio codec used to encode or decode the audio stream. @@ -72,7 +72,7 @@ type Beard struct { // black levels and pixel coverage of black pixels in a frame. As videos can come // from multiple sources, formats, and time periods, they may contain different // standards and varying noise levels for black frames that need to be accounted -// for. For more information, see StartSegmentDetection. +// for. For more information, see StartSegmentDetection . type BlackFrame struct { // A threshold used to determine the maximum luminance value for a pixel to be @@ -97,21 +97,22 @@ type BlackFrame struct { noSmithyDocumentSerde } -// Identifies the bounding box around the label, face, text, object of interest, or -// personal protective equipment. The left (x-coordinate) and top (y-coordinate) -// are coordinates representing the top and left sides of the bounding box. Note -// that the upper-left corner of the image is the origin (0,0). The top and left -// values returned are ratios of the overall image size. For example, if the input -// image is 700x200 pixels, and the top-left coordinate of the bounding box is -// 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of -// 0.25 (50/200). The width and height values represent the dimensions of the -// bounding box as a ratio of the overall image dimension. For example, if the -// input image is 700x200 pixels, and the bounding box width is 70 pixels, the -// width returned is 0.1. The bounding box coordinates can have negative values. -// For example, if Amazon Rekognition is able to detect a face that is at the image -// edge and is only partially visible, the service can return coordinates that are -// outside the image bounds and, depending on the image edge, you might get -// negative values or values greater than 1 for the left or top values. +// Identifies the bounding box around the label, face, text, object of interest, +// or personal protective equipment. The left (x-coordinate) and top +// (y-coordinate) are coordinates representing the top and left sides of the +// bounding box. Note that the upper-left corner of the image is the origin (0,0). +// The top and left values returned are ratios of the overall image size. For +// example, if the input image is 700x200 pixels, and the top-left coordinate of +// the bounding box is 350x50 pixels, the API returns a left value of 0.5 +// (350/700) and a top value of 0.25 (50/200). The width and height values +// represent the dimensions of the bounding box as a ratio of the overall image +// dimension. For example, if the input image is 700x200 pixels, and the bounding +// box width is 70 pixels, the width returned is 0.1. The bounding box coordinates +// can have negative values. For example, if Amazon Rekognition is able to detect a +// face that is at the image edge and is only partially visible, the service can +// return coordinates that are outside the image bounds and, depending on the image +// edge, you might get negative values or values greater than 1 for the left or top +// values. type BoundingBox struct { // Height of the bounding box as a ratio of the overall image height. @@ -203,7 +204,7 @@ type CelebrityRecognition struct { } // Provides face metadata for target image faces that are analyzed by CompareFaces -// and RecognizeCelebrities. +// and RecognizeCelebrities . type ComparedFace struct { // Bounding box of the face. @@ -249,9 +250,9 @@ type ComparedSourceImageFace struct { } // Provides information about a face in a target image that matches the source -// image face analyzed by CompareFaces. The Face property contains the bounding box -// of the face in the target image. The Similarity property is the confidence that -// the source image face matches the face in the bounding box. +// image face analyzed by CompareFaces . The Face property contains the bounding +// box of the face in the target image. The Similarity property is the confidence +// that the source image face matches the face in the bounding box. type CompareFacesMatch struct { // Provides face metadata (bounding box and confidence that the bounding box @@ -265,7 +266,7 @@ type CompareFacesMatch struct { } // Label detection settings to use on a streaming video. Defining the settings is -// required in the request parameter for CreateStreamProcessor. Including this +// required in the request parameter for CreateStreamProcessor . Including this // setting in the CreateStreamProcessor request enables you to use the stream // processor for label detection. You can then select what you want the stream // processor to detect, such as people or pets. When the stream processor has @@ -320,10 +321,10 @@ type ContentModerationDetection struct { } // Information about an item of Personal Protective Equipment covering a -// corresponding body part. For more information, see DetectProtectiveEquipment. +// corresponding body part. For more information, see DetectProtectiveEquipment . type CoversBodyPart struct { - // The confidence that Amazon Rekognition has in the value of Value. + // The confidence that Amazon Rekognition has in the value of Value . Confidence *float32 // True if the PPE covers the corresponding body part, otherwise false. @@ -332,7 +333,7 @@ type CoversBodyPart struct { noSmithyDocumentSerde } -// A custom label detected in an image by a call to DetectCustomLabels. +// A custom label detected in an image by a call to DetectCustomLabels . type CustomLabel struct { // The confidence that the model has in the detection of the custom label. The @@ -359,8 +360,8 @@ type DatasetChanges struct { // A Base64-encoded binary data object containing one or JSON lines that either // update the dataset or are additions to the dataset. You change a dataset by - // calling UpdateDatasetEntries. If you are using an AWS SDK to call - // UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the + // calling UpdateDatasetEntries . If you are using an AWS SDK to call + // UpdateDatasetEntries , you don't need to encode Changes as the SDK encodes the // data for you. For example JSON lines, see Image-Level labels in manifest files // and and Object localization in manifest files in the Amazon Rekognition Custom // Labels Developer Guide. @@ -371,8 +372,8 @@ type DatasetChanges struct { noSmithyDocumentSerde } -// A description for a dataset. For more information, see DescribeDataset. The -// status fields Status, StatusMessage, and StatusMessageCode reflect the last +// A description for a dataset. For more information, see DescribeDataset . The +// status fields Status , StatusMessage , and StatusMessageCode reflect the last // operation on the dataset. type DatasetDescription struct { @@ -399,7 +400,7 @@ type DatasetDescription struct { noSmithyDocumentSerde } -// Describes a dataset label. For more information, see ListDatasetLabels. +// Describes a dataset label. For more information, see ListDatasetLabels . type DatasetLabelDescription struct { // The name of the label. @@ -412,7 +413,7 @@ type DatasetLabelDescription struct { } // Statistics about a label used in a dataset. For more information, see -// DatasetLabelDescription. +// DatasetLabelDescription . type DatasetLabelStats struct { // The total number of images that have the label assigned to a bounding box. @@ -425,7 +426,7 @@ type DatasetLabelStats struct { } // Summary information for an Amazon Rekognition Custom Labels dataset. For more -// information, see ProjectDescription. +// information, see ProjectDescription . type DatasetMetadata struct { // The Unix timestamp for the date and time that the dataset was created. @@ -455,10 +456,10 @@ type DatasetMetadata struct { // use an Amazon Sagemaker format manifest file, specify the S3 bucket location in // the GroundTruthManifest field. The S3 bucket must be in your AWS account. To // create a copy of an existing dataset, specify the Amazon Resource Name (ARN) of -// an existing dataset in DatasetArn. You need to specify a value for DatasetArn or -// GroundTruthManifest, but not both. if you supply both values, or if you don't -// specify any values, an InvalidParameterException exception occurs. For more -// information, see CreateDataset. +// an existing dataset in DatasetArn . You need to specify a value for DatasetArn +// or GroundTruthManifest , but not both. if you supply both values, or if you +// don't specify any values, an InvalidParameterException exception occurs. For +// more information, see CreateDataset . type DatasetSource struct { // The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy. @@ -471,7 +472,7 @@ type DatasetSource struct { noSmithyDocumentSerde } -// Provides statistics about a dataset. For more information, see DescribeDataset. +// Provides statistics about a dataset. For more information, see DescribeDataset . type DatasetStats struct { // The total number of entries that contain at least one error. @@ -539,8 +540,9 @@ type DetectLabelsImageForeground struct { noSmithyDocumentSerde } -// Information about the quality and dominant colors of an input image. Quality and -// color information is returned for the entire image, foreground, and background. +// Information about the quality and dominant colors of an input image. Quality +// and color information is returned for the entire image, foreground, and +// background. type DetectLabelsImageProperties struct { // Information about the properties of an image’s background, including the @@ -576,8 +578,8 @@ type DetectLabelsImagePropertiesSettings struct { noSmithyDocumentSerde } -// The quality of an image provided for label detection, with regard to brightness, -// sharpness, and contrast. +// The quality of an image provided for label detection, with regard to +// brightness, sharpness, and contrast. type DetectLabelsImageQuality struct { // The brightness of an image provided for label detection. @@ -625,7 +627,7 @@ type DetectTextFilters struct { } // A training dataset or a test dataset used in a dataset distribution operation. -// For more information, see DistributeDatasetEntries. +// For more information, see DistributeDatasetEntries . type DistributeDataset struct { // The Amazon Resource Name (ARN) of the dataset that you want to use. @@ -680,13 +682,13 @@ type Emotion struct { } // Information about an item of Personal Protective Equipment (PPE) detected by -// DetectProtectiveEquipment. For more information, see DetectProtectiveEquipment. +// DetectProtectiveEquipment . For more information, see DetectProtectiveEquipment . type EquipmentDetection struct { // A bounding box surrounding the item of detected PPE. BoundingBox *BoundingBox - // The confidence that Amazon Rekognition has that the bounding box (BoundingBox) + // The confidence that Amazon Rekognition has that the bounding box ( BoundingBox ) // contains an item of PPE. Confidence *float32 @@ -702,8 +704,8 @@ type EquipmentDetection struct { // The evaluation results for the training of a model. type EvaluationResult struct { - // The F1 score for the evaluation of all labels. The F1 score metric evaluates the - // overall precision and recall performance of the model as a single value. A + // The F1 score for the evaluation of all labels. The F1 score metric evaluates + // the overall precision and recall performance of the model as a single value. A // higher value indicates better precision and recall performance. A lower score // indicates that precision, recall, or both are performing poorly. F1Score *float32 @@ -727,8 +729,8 @@ type Eyeglasses struct { noSmithyDocumentSerde } -// Indicates whether or not the eyes on the face are open, and the confidence level -// in the determination. +// Indicates whether or not the eyes on the face are open, and the confidence +// level in the determination. type EyeOpen struct { // Level of confidence in the determination. @@ -740,8 +742,8 @@ type EyeOpen struct { noSmithyDocumentSerde } -// Describes the face properties such as the bounding box, face ID, image ID of the -// input image, and external image ID that you assigned. +// Describes the face properties such as the bounding box, face ID, image ID of +// the input image, and external image ID that you assigned. type Face struct { // Bounding box of the face. @@ -760,8 +762,8 @@ type Face struct { // Unique identifier that Amazon Rekognition assigns to the input image. ImageId *string - // The version of the face detect and storage model that was used when indexing the - // face vector. + // The version of the face detect and storage model that was used when indexing + // the face vector. IndexFacesModelVersion *string noSmithyDocumentSerde @@ -769,25 +771,21 @@ type Face struct { // Structure containing attributes of the face that the algorithm detected. A // FaceDetail object contains either the default facial attributes or all facial -// attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, -// and Quality. GetFaceDetection is the only Amazon Rekognition Video stored video -// operation that can return a FaceDetail object with all attributes. To specify -// which attributes to return, use the FaceAttributes input parameter for -// StartFaceDetection. The following Amazon Rekognition Video operations return -// only the default attributes. The corresponding Start operations don't have a -// FaceAttributes input parameter: -// -// * GetCelebrityRecognition -// -// * -// GetPersonTracking -// -// * GetFaceSearch +// attributes. The default attributes are BoundingBox , Confidence , Landmarks , +// Pose , and Quality . GetFaceDetection is the only Amazon Rekognition Video +// stored video operation that can return a FaceDetail object with all attributes. +// To specify which attributes to return, use the FaceAttributes input parameter +// for StartFaceDetection . The following Amazon Rekognition Video operations +// return only the default attributes. The corresponding Start operations don't +// have a FaceAttributes input parameter: +// - GetCelebrityRecognition +// - GetPersonTracking +// - GetFaceSearch // -// The Amazon Rekognition Image DetectFaces and -// IndexFaces operations can return all facial attributes. To specify which -// attributes to return, use the Attributes input parameter for DetectFaces. For -// IndexFaces, use the DetectAttributes input parameter. +// The Amazon Rekognition Image DetectFaces and IndexFaces operations can return +// all facial attributes. To specify which attributes to return, use the Attributes +// input parameter for DetectFaces . For IndexFaces , use the DetectAttributes +// input parameter. type FaceDetail struct { // The estimated age range, in years, for the face. Low represents the lowest @@ -816,8 +814,8 @@ type FaceDetail struct { // level in the determination. Eyeglasses *Eyeglasses - // Indicates whether or not the eyes on the face are open, and the confidence level - // in the determination. + // Indicates whether or not the eyes on the face are open, and the confidence + // level in the determination. EyesOpen *EyeOpen // The predicted gender of a detected face. @@ -826,8 +824,8 @@ type FaceDetail struct { // Indicates the location of landmarks on the face. Default attribute. Landmarks []Landmark - // Indicates whether or not the mouth on the face is open, and the confidence level - // in the determination. + // Indicates whether or not the mouth on the face is open, and the confidence + // level in the determination. MouthOpen *MouthOpen // Indicates whether or not the face has a mustache, and the confidence level in @@ -871,8 +869,8 @@ type FaceDetection struct { // match of this face with the input face. type FaceMatch struct { - // Describes the face properties such as the bounding box, face ID, image ID of the - // source image, and external image ID that you assigned. + // Describes the face properties such as the bounding box, face ID, image ID of + // the source image, and external image ID that you assigned. Face *Face // Confidence in the match of this face with the input face. @@ -885,8 +883,8 @@ type FaceMatch struct { // facial attributes that are detected but aren't stored in the database. type FaceRecord struct { - // Describes the face properties such as the bounding box, face ID, image ID of the - // input image, and external image ID that you assigned. + // Describes the face properties such as the bounding box, face ID, image ID of + // the input image, and external image ID that you assigned. Face *Face // Structure containing attributes of the face that the algorithm detected. @@ -898,7 +896,7 @@ type FaceRecord struct { // Input face recognition parameters for an Amazon Rekognition stream processor. // Includes the collection to use for face recognition and the face attributes to // detect. Defining the settings is required in the request parameter for -// CreateStreamProcessor. +// CreateStreamProcessor . type FaceSearchSettings struct { // The ID of a collection that contains faces that you want to search for. @@ -956,8 +954,8 @@ type GeneralLabelsSettings struct { noSmithyDocumentSerde } -// Information about where an object (DetectCustomLabels) or text (DetectText) is -// located on an image. +// Information about where an object ( DetectCustomLabels ) or text ( DetectText ) +// is located on an image. type Geometry struct { // An axis-aligned coarse representation of the detected item's location on the @@ -1008,8 +1006,7 @@ type HumanLoopActivationOutput struct { type HumanLoopConfig struct { // The Amazon Resource Name (ARN) of the flow definition. You can create a flow - // definition by using the Amazon Sagemaker CreateFlowDefinition - // (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html) + // definition by using the Amazon Sagemaker CreateFlowDefinition (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html) // Operation. // // This member is required. @@ -1038,22 +1035,22 @@ type HumanLoopDataAttributes struct { } // Provides the input image either as bytes or an S3 object. You pass image bytes -// to an Amazon Rekognition API operation by using the Bytes property. For example, -// you would use the Bytes property to pass an image loaded from a local file -// system. Image bytes passed by using the Bytes property must be base64-encoded. -// Your code may not need to encode image bytes if you are using an AWS SDK to call -// Amazon Rekognition API operations. For more information, see Analyzing an Image -// Loaded from a Local File System in the Amazon Rekognition Developer Guide. You -// pass images stored in an S3 bucket to an Amazon Rekognition API operation by -// using the S3Object property. Images stored in an S3 bucket do not need to be -// base64-encoded. The region for the S3 bucket containing the S3 object must match -// the region you use for Amazon Rekognition operations. If you use the AWS CLI to -// call Amazon Rekognition operations, passing image bytes using the Bytes property -// is not supported. You must first upload the image to an Amazon S3 bucket and -// then call the operation using the S3Object property. For Amazon Rekognition to -// process an S3 object, the user must have permission to access the S3 object. For -// more information, see How Amazon Rekognition works with IAM in the Amazon -// Rekognition Developer Guide. +// to an Amazon Rekognition API operation by using the Bytes property. For +// example, you would use the Bytes property to pass an image loaded from a local +// file system. Image bytes passed by using the Bytes property must be +// base64-encoded. Your code may not need to encode image bytes if you are using an +// AWS SDK to call Amazon Rekognition API operations. For more information, see +// Analyzing an Image Loaded from a Local File System in the Amazon Rekognition +// Developer Guide. You pass images stored in an S3 bucket to an Amazon Rekognition +// API operation by using the S3Object property. Images stored in an S3 bucket do +// not need to be base64-encoded. The region for the S3 bucket containing the S3 +// object must match the region you use for Amazon Rekognition operations. If you +// use the AWS CLI to call Amazon Rekognition operations, passing image bytes using +// the Bytes property is not supported. You must first upload the image to an +// Amazon S3 bucket and then call the operation using the S3Object property. For +// Amazon Rekognition to process an S3 object, the user must have permission to +// access the S3 object. For more information, see How Amazon Rekognition works +// with IAM in the Amazon Rekognition Developer Guide. type Image struct { // Blob of image bytes up to 5 MBs. @@ -1068,8 +1065,8 @@ type Image struct { // Identifies face image brightness and sharpness. type ImageQuality struct { - // Value representing brightness of the face. The service returns a value between 0 - // and 100 (inclusive). A higher value indicates a brighter face image. + // Value representing brightness of the face. The service returns a value between + // 0 and 100 (inclusive). A higher value indicates a brighter face image. Brightness *float32 // Value representing sharpness of the face. The service returns a value between 0 @@ -1079,8 +1076,8 @@ type ImageQuality struct { noSmithyDocumentSerde } -// An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by -// Amazon Rekognition Video (GetLabelDetection). +// An instance of a label returned by Amazon Rekognition Image ( DetectLabels ) or +// by Amazon Rekognition Video ( GetLabelDetection ). type Instance struct { // The position of the label instance on the image. @@ -1121,8 +1118,8 @@ type KinesisVideoStream struct { // use the producer timestamp or the fragment number. One of either producer // timestamp or fragment number is required. If you use the producer timestamp, you // must put the time in milliseconds. For more information about fragment numbers, -// see Fragment -// (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html). +// see Fragment (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html) +// . type KinesisVideoStreamStartSelector struct { // The unique identifier of the fragment. This value monotonically increases based @@ -1206,8 +1203,8 @@ type LabelDetection struct { // Details about the detected label. Label *Label - // The time in milliseconds defining the start of the timeline segment containing a - // continuously detected label. + // The time in milliseconds defining the start of the timeline segment containing + // a continuously detected label. StartTimestampMillis *int64 // Time, in milliseconds from the start of the video, that the label was detected. @@ -1236,10 +1233,10 @@ type Landmark struct { // Type of landmark. Type LandmarkType - // The x-coordinate of the landmark expressed as a ratio of the width of the image. - // The x-coordinate is measured from the left-side of the image. For example, if - // the image is 700 pixels wide and the x-coordinate of the landmark is at 350 - // pixels, this value is 0.5. + // The x-coordinate of the landmark expressed as a ratio of the width of the + // image. The x-coordinate is measured from the left-side of the image. For + // example, if the image is 700 pixels wide and the x-coordinate of the landmark is + // at 350 pixels, this value is 0.5. X *float32 // The y-coordinate of the landmark expressed as a ratio of the height of the @@ -1259,22 +1256,22 @@ type ModerationLabel struct { // Specifies the confidence that Amazon Rekognition has that the label has been // correctly identified. If you don't specify the MinConfidence parameter in the - // call to DetectModerationLabels, the operation returns labels with a confidence + // call to DetectModerationLabels , the operation returns labels with a confidence // value greater than or equal to 50 percent. Confidence *float32 // The label name for the type of unsafe content detected in the image. Name *string - // The name for the parent label. Labels at the top level of the hierarchy have the - // parent label "". + // The name for the parent label. Labels at the top level of the hierarchy have + // the parent label "" . ParentName *string noSmithyDocumentSerde } -// Indicates whether or not the mouth on the face is open, and the confidence level -// in the determination. +// Indicates whether or not the mouth on the face is open, and the confidence +// level in the determination. type MouthOpen struct { // Level of confidence in the determination. @@ -1301,12 +1298,12 @@ type Mustache struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the completion status of a video analysis operation. For more -// information, see Calling Amazon Rekognition Video operations -// (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html). Note that -// the Amazon SNS topic must have a topic name that begins with AmazonRekognition -// if you are using the AmazonRekognitionServiceRole permissions policy to access -// the topic. For more information, see Giving access to multiple Amazon SNS topics -// (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). +// information, see Calling Amazon Rekognition Video operations (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html) +// . Note that the Amazon SNS topic must have a topic name that begins with +// AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions +// policy to access the topic. For more information, see Giving access to multiple +// Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics) +// . type NotificationChannel struct { // The ARN of an IAM role that gives Amazon Rekognition publishing permissions to @@ -1379,11 +1376,11 @@ type PersonDetection struct { noSmithyDocumentSerde } -// Information about a person whose face matches a face(s) in an Amazon Rekognition -// collection. Includes information about the faces in the Amazon Rekognition -// collection (FaceMatch), information about the person (PersonDetail), and the -// time stamp for when the person was detected in a video. An array of PersonMatch -// objects is returned by GetFaceSearch. +// Information about a person whose face matches a face(s) in an Amazon +// Rekognition collection. Includes information about the faces in the Amazon +// Rekognition collection ( FaceMatch ), information about the person ( PersonDetail +// ), and the time stamp for when the person was detected in a video. An array of +// PersonMatch objects is returned by GetFaceSearch . type PersonMatch struct { // Information about the faces in the input collection that match the face of a @@ -1404,16 +1401,15 @@ type PersonMatch struct { // values are ratios of the overall image size or video resolution. For example, if // an input image is 700x200 and the values are X=0.5 and Y=0.25, then the point is // at the (350,50) pixel coordinate on the image. An array of Point objects makes -// up a Polygon. A Polygon is returned by DetectText and by -// DetectCustomLabelsPolygon represents a fine-grained polygon around a detected -// item. For more information, see Geometry in the Amazon Rekognition Developer -// Guide. +// up a Polygon . A Polygon is returned by DetectText and by DetectCustomLabels +// Polygon represents a fine-grained polygon around a detected item. For more +// information, see Geometry in the Amazon Rekognition Developer Guide. type Point struct { - // The value of the X coordinate for a point on a Polygon. + // The value of the X coordinate for a point on a Polygon . X *float32 - // The value of the Y coordinate for a point on a Polygon. + // The value of the Y coordinate for a point on a Polygon . Y *float32 noSmithyDocumentSerde @@ -1435,7 +1431,7 @@ type Pose struct { } // A description of an Amazon Rekognition Custom Labels project. For more -// information, see DescribeProjects. +// information, see DescribeProjects . type ProjectDescription struct { // The Unix timestamp for the date and time that the project was created. @@ -1453,7 +1449,7 @@ type ProjectDescription struct { noSmithyDocumentSerde } -// Describes a project policy in the response from ListProjectPolicies. +// Describes a project policy in the response from ListProjectPolicies . type ProjectPolicy struct { // The Unix datetime for the creation of the project policy. @@ -1493,8 +1489,8 @@ type ProjectVersionDescription struct { // successful. EvaluationResult *EvaluationResult - // The identifer for the AWS Key Management Service key (AWS KMS key) that was used - // to encrypt the model during training. + // The identifer for the AWS Key Management Service key (AWS KMS key) that was + // used to encrypt the model during training. KmsKeyId *string // The location of the summary manifest. The summary manifest provides aggregate @@ -1502,11 +1498,11 @@ type ProjectVersionDescription struct { ManifestSummary *GroundTruthManifest // The maximum number of inference units Amazon Rekognition Custom Labels uses to - // auto-scale the model. For more information, see StartProjectVersion. + // auto-scale the model. For more information, see StartProjectVersion . MaxInferenceUnits *int32 // The minimum number of inference units used by the model. For more information, - // see StartProjectVersion. + // see StartProjectVersion . MinInferenceUnits *int32 // The location where training results are saved. @@ -1539,7 +1535,7 @@ type ProjectVersionDescription struct { // Information about a body part detected by DetectProtectiveEquipment that // contains PPE. An array of ProtectiveEquipmentBodyPart objects is returned for -// each person detected by DetectProtectiveEquipment. +// each person detected by DetectProtectiveEquipment . type ProtectiveEquipmentBodyPart struct { // The confidence that Amazon Rekognition has in the detection accuracy of the @@ -1555,13 +1551,13 @@ type ProtectiveEquipmentBodyPart struct { noSmithyDocumentSerde } -// A person detected by a call to DetectProtectiveEquipment. The API returns all +// A person detected by a call to DetectProtectiveEquipment . The API returns all // persons detected in the input image in an array of ProtectiveEquipmentPerson // objects. type ProtectiveEquipmentPerson struct { - // An array of body parts detected on a person's body (including body parts without - // PPE). + // An array of body parts detected on a person's body (including body parts + // without PPE). BodyParts []ProtectiveEquipmentBodyPart // A bounding box around the detected person. @@ -1572,21 +1568,21 @@ type ProtectiveEquipmentPerson struct { Confidence *float32 // The identifier for the detected person. The identifier is only unique for a - // single call to DetectProtectiveEquipment. + // single call to DetectProtectiveEquipment . Id *int32 noSmithyDocumentSerde } -// Specifies summary attributes to return from a call to DetectProtectiveEquipment. -// You can specify which types of PPE to summarize. You can also specify a minimum -// confidence value for detections. Summary information is returned in the Summary -// (ProtectiveEquipmentSummary) field of the response from -// DetectProtectiveEquipment. The summary includes which persons in an image were +// Specifies summary attributes to return from a call to DetectProtectiveEquipment +// . You can specify which types of PPE to summarize. You can also specify a +// minimum confidence value for detections. Summary information is returned in the +// Summary ( ProtectiveEquipmentSummary ) field of the response from +// DetectProtectiveEquipment . The summary includes which persons in an image were // detected wearing the requested types of person protective equipment (PPE), which // persons were detected as not wearing PPE, and the persons in which a // determination could not be made. For more information, see -// ProtectiveEquipmentSummary. +// ProtectiveEquipmentSummary . type ProtectiveEquipmentSummarizationAttributes struct { // The minimum confidence level for which you want summary information. The @@ -1603,8 +1599,8 @@ type ProtectiveEquipmentSummarizationAttributes struct { // An array of personal protective equipment types for which you want summary // information. If a person is detected wearing a required requipment type, the - // person's ID is added to the PersonsWithRequiredEquipment array field returned in - // ProtectiveEquipmentSummary by DetectProtectiveEquipment. + // person's ID is added to the PersonsWithRequiredEquipment array field returned + // in ProtectiveEquipmentSummary by DetectProtectiveEquipment . // // This member is required. RequiredEquipmentTypes []ProtectiveEquipmentType @@ -1613,20 +1609,20 @@ type ProtectiveEquipmentSummarizationAttributes struct { } // Summary information for required items of personal protective equipment (PPE) -// detected on persons by a call to DetectProtectiveEquipment. You specify the -// required type of PPE in the SummarizationAttributes -// (ProtectiveEquipmentSummarizationAttributes) input parameter. The summary +// detected on persons by a call to DetectProtectiveEquipment . You specify the +// required type of PPE in the SummarizationAttributes ( +// ProtectiveEquipmentSummarizationAttributes ) input parameter. The summary // includes which persons were detected wearing the required personal protective -// equipment (PersonsWithRequiredEquipment), which persons were detected as not -// wearing the required PPE (PersonsWithoutRequiredEquipment), and the persons in -// which a determination could not be made (PersonsIndeterminate). To get a total +// equipment ( PersonsWithRequiredEquipment ), which persons were detected as not +// wearing the required PPE ( PersonsWithoutRequiredEquipment ), and the persons in +// which a determination could not be made ( PersonsIndeterminate ). To get a total // for each category, use the size of the field array. For example, to find out how // many people were detected as wearing the specified PPE, use the size of the // PersonsWithRequiredEquipment array. If you want to find out more about a person, -// such as the location (BoundingBox) of the person on the image, use the person ID -// in each array element. Each person ID matches the ID field of a +// such as the location ( BoundingBox ) of the person on the image, use the person +// ID in each array element. Each person ID matches the ID field of a // ProtectiveEquipmentPerson object returned in the Persons array by -// DetectProtectiveEquipment. +// DetectProtectiveEquipment . type ProtectiveEquipmentSummary struct { // An array of IDs for persons where it was not possible to determine if they are @@ -1646,9 +1642,9 @@ type ProtectiveEquipmentSummary struct { } // Specifies a location within the frame that Rekognition checks for objects of -// interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set -// a region of the screen. A word, face, or label is included in the region if it -// is more than half in that region. If there is more than one region, the word, +// interest such as text, labels, or faces. It uses a BoundingBox or Polygon to +// set a region of the screen. A word, face, or label is included in the region if +// it is more than half in that region. If there is more than one region, the word, // face, or label is compared with all regions of the screen. Any object of // interest that is more than half in a region is kept in the results. type RegionOfInterest struct { @@ -1663,19 +1659,20 @@ type RegionOfInterest struct { noSmithyDocumentSerde } -// The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed -// inference results of a video analysis operation. These results include the name -// of the stream processor resource, the session ID of the stream processing -// session, and labeled timestamps and bounding boxes for detected labels. +// The Amazon S3 bucket location to which Amazon Rekognition publishes the +// detailed inference results of a video analysis operation. These results include +// the name of the stream processor resource, the session ID of the stream +// processing session, and labeled timestamps and bounding boxes for detected +// labels. type S3Destination struct { // The name of the Amazon S3 bucket you want to associate with the streaming video // project. You must be the owner of the Amazon S3 bucket. Bucket *string - // The prefix value of the location within the bucket that you want the information - // to be published to. For more information, see Using prefixes - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html). + // The prefix value of the location within the bucket that you want the + // information to be published to. For more information, see Using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) + // . KeyPrefix *string noSmithyDocumentSerde @@ -1702,7 +1699,7 @@ type S3Object struct { // A technical cue or shot detection segment detected in a video. An array of // SegmentDetection objects containing all segments detected in a stored video is -// returned by GetSegmentDetection. +// returned by GetSegmentDetection . type SegmentDetection struct { // The duration of a video segment, expressed in frames. @@ -1735,8 +1732,8 @@ type SegmentDetection struct { // starts with 0. StartFrameNumber *int64 - // The frame-accurate SMPTE timecode, from the start of a video, for the start of a - // detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop + // The frame-accurate SMPTE timecode, from the start of a video, for the start of + // a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop // frame-rates). StartTimecodeSMPTE *string @@ -1748,15 +1745,15 @@ type SegmentDetection struct { // If the segment is a technical cue, contains information about the technical cue. TechnicalCueSegment *TechnicalCueSegment - // The type of the segment. Valid values are TECHNICAL_CUE and SHOT. + // The type of the segment. Valid values are TECHNICAL_CUE and SHOT . Type SegmentType noSmithyDocumentSerde } // Information about the type of a segment requested in a call to -// StartSegmentDetection. An array of SegmentTypeInfo objects is returned by the -// response from GetSegmentDetection. +// StartSegmentDetection . An array of SegmentTypeInfo objects is returned by the +// response from GetSegmentDetection . type SegmentTypeInfo struct { // The version of the model used to detect segments. @@ -1769,11 +1766,11 @@ type SegmentTypeInfo struct { } // Information about a shot detection segment detected in a video. For more -// information, see SegmentDetection. +// information, see SegmentDetection . type ShotSegment struct { - // The confidence that Amazon Rekognition Video has in the accuracy of the detected - // segment. + // The confidence that Amazon Rekognition Video has in the accuracy of the + // detected segment. Confidence *float32 // An Identifier for a shot detection segment detected in a video. @@ -1796,7 +1793,7 @@ type Smile struct { } // Filters applied to the technical cue or shot detection segments. For more -// information, see StartSegmentDetection. +// information, see StartSegmentDetection . type StartSegmentDetectionFilters struct { // Filters that are specific to shot detections. @@ -1808,8 +1805,8 @@ type StartSegmentDetectionFilters struct { noSmithyDocumentSerde } -// Filters for the shot detection segments returned by GetSegmentDetection. For -// more information, see StartSegmentDetectionFilters. +// Filters for the shot detection segments returned by GetSegmentDetection . For +// more information, see StartSegmentDetectionFilters . type StartShotDetectionFilter struct { // Specifies the minimum confidence that Amazon Rekognition Video must have in @@ -1817,15 +1814,15 @@ type StartShotDetectionFilter struct { // Rekognition is that a segment is correctly identified. 0 is the lowest // confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't // return any segments with a confidence level lower than this specified value. If - // you don't specify MinSegmentConfidence, the GetSegmentDetection returns segments - // with confidence values greater than or equal to 50 percent. + // you don't specify MinSegmentConfidence , the GetSegmentDetection returns + // segments with confidence values greater than or equal to 50 percent. MinSegmentConfidence *float32 noSmithyDocumentSerde } -// Filters for the technical segments returned by GetSegmentDetection. For more -// information, see StartSegmentDetectionFilters. +// Filters for the technical segments returned by GetSegmentDetection . For more +// information, see StartSegmentDetectionFilters . type StartTechnicalCueDetectionFilter struct { // A filter that allows you to control the black frame detection by specifying the @@ -1839,7 +1836,7 @@ type StartTechnicalCueDetectionFilter struct { // Rekognition is that a segment is correctly identified. 0 is the lowest // confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't // return any segments with a confidence level lower than this specified value. If - // you don't specify MinSegmentConfidence, GetSegmentDetection returns segments + // you don't specify MinSegmentConfidence , GetSegmentDetection returns segments // with confidence values greater than or equal to 50 percent. MinSegmentConfidence *float32 @@ -1852,8 +1849,8 @@ type StartTechnicalCueDetectionFilter struct { // screen to look for text in. type StartTextDetectionFilters struct { - // Filter focusing on a certain area of the frame. Uses a BoundingBox object to set - // the region of the screen. + // Filter focusing on a certain area of the frame. Uses a BoundingBox object to + // set the region of the screen. RegionsOfInterest []RegionOfInterest // Filters focusing on qualities of the text, such as confidence or size. @@ -1866,8 +1863,8 @@ type StartTextDetectionFilters struct { // not be used to start a face search stream processor. type StreamProcessingStartSelector struct { - // Specifies the starting point in the stream to start processing. This can be done - // with a producer timestamp or a fragment number in a Kinesis stream. + // Specifies the starting point in the stream to start processing. This can be + // done with a producer timestamp or a fragment number in a Kinesis stream. KVSStreamStartSelector *KinesisVideoStreamStartSelector noSmithyDocumentSerde @@ -1885,7 +1882,7 @@ type StreamProcessingStopSelector struct { } // An object that recognizes faces or labels in a streaming video. An Amazon -// Rekognition stream processor is created by a call to CreateStreamProcessor. The +// Rekognition stream processor is created by a call to CreateStreamProcessor . The // request parameters for CreateStreamProcessor describe the Kinesis video stream // source for the streaming video, face recognition parameters, and where to stream // the analysis resullts. @@ -1954,8 +1951,8 @@ type StreamProcessorOutput struct { // processor streams the analysis results. KinesisDataStream *KinesisDataStream - // The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed - // inference results of a video analysis operation. + // The Amazon S3 bucket location to which Amazon Rekognition publishes the + // detailed inference results of a video analysis operation. S3Destination *S3Destination noSmithyDocumentSerde @@ -1967,7 +1964,7 @@ type StreamProcessorOutput struct { type StreamProcessorSettings struct { // Label detection settings to use on a streaming video. Defining the settings is - // required in the request parameter for CreateStreamProcessor. Including this + // required in the request parameter for CreateStreamProcessor . Including this // setting in the CreateStreamProcessor request enables you to use the stream // processor for label detection. You can then select what you want the stream // processor to detect, such as people or pets. When the stream processor has @@ -1996,7 +1993,7 @@ type StreamProcessorSettingsForUpdate struct { // The S3 bucket that contains the training summary. The training summary includes // aggregated evaluation metrics for the entire testing dataset and metrics for // each individual label. You get the training summary S3 bucket location by -// calling DescribeProjectVersions. +// calling DescribeProjectVersions . type Summary struct { // Provides the S3 bucket name and object name. The region for the S3 bucket @@ -2023,11 +2020,11 @@ type Sunglasses struct { } // Information about a technical cue segment. For more information, see -// SegmentDetection. +// SegmentDetection . type TechnicalCueSegment struct { - // The confidence that Amazon Rekognition Video has in the accuracy of the detected - // segment. + // The confidence that Amazon Rekognition Video has in the accuracy of the + // detected segment. Confidence *float32 // The type of the technical cue. @@ -2053,8 +2050,8 @@ type TestingData struct { noSmithyDocumentSerde } -// Sagemaker Groundtruth format manifest files for the input, output and validation -// datasets that are used and created during testing. +// Sagemaker Groundtruth format manifest files for the input, output and +// validation datasets that are used and created during testing. type TestingDataResult struct { // The testing dataset that was supplied for training. @@ -2071,12 +2068,12 @@ type TestingDataResult struct { noSmithyDocumentSerde } -// Information about a word or line of text detected by DetectText. The +// Information about a word or line of text detected by DetectText . The // DetectedText field contains the text that Amazon Rekognition detected in the -// image. Every word and line has an identifier (Id). Each word belongs to a line -// and has a parent identifier (ParentId) that identifies the line of text in which -// the word appears. The word Id is also an index for the word within a line of -// words. For more information, see Detecting text in the Amazon Rekognition +// image. Every word and line has an identifier ( Id ). Each word belongs to a line +// and has a parent identifier ( ParentId ) that identifies the line of text in +// which the word appears. The word Id is also an index for the word within a line +// of words. For more information, see Detecting text in the Amazon Rekognition // Developer Guide. type TextDetection struct { @@ -2092,12 +2089,12 @@ type TextDetection struct { // spatial information. Geometry *Geometry - // The identifier for the detected text. The identifier is only unique for a single - // call to DetectText. + // The identifier for the detected text. The identifier is only unique for a + // single call to DetectText . Id *int32 - // The Parent identifier for the detected text identified by the value of ID. If - // the type of detected text is LINE, the value of ParentId is Null. + // The Parent identifier for the detected text identified by the value of ID . If + // the type of detected text is LINE , the value of ParentId is Null . ParentId *int32 // The type of text that was detected. @@ -2115,8 +2112,8 @@ type TextDetectionResult struct { TextDetection *TextDetection // The time, in milliseconds from the start of the video, that the text was - // detected. Note that Timestamp is not guaranteed to be accurate to the individual - // frame where the text first appears. + // detected. Note that Timestamp is not guaranteed to be accurate to the + // individual frame where the text first appears. Timestamp int64 noSmithyDocumentSerde @@ -2132,8 +2129,8 @@ type TrainingData struct { noSmithyDocumentSerde } -// Sagemaker Groundtruth format manifest files for the input, output and validation -// datasets that are used and created during testing. +// Sagemaker Groundtruth format manifest files for the input, output and +// validation datasets that are used and created during testing. type TrainingDataResult struct { // The training assets that you supplied for training. @@ -2154,30 +2151,19 @@ type TrainingDataResult struct { // attribute to determine why a face wasn't indexed. type UnindexedFace struct { - // The structure that contains attributes of a face that IndexFacesdetected, but + // The structure that contains attributes of a face that IndexFaces detected, but // didn't index. FaceDetail *FaceDetail // An array of reasons that specify why a face wasn't indexed. - // - // * EXTREME_POSE - - // The face is at a pose that can't be detected. For example, the head is turned - // too far away from the camera. - // - // * EXCEEDS_MAX_FACES - The number of faces - // detected is already higher than that specified by the MaxFaces input parameter - // for IndexFaces. - // - // * LOW_BRIGHTNESS - The image is too dark. - // - // * LOW_SHARPNESS - - // The image is too blurry. - // - // * LOW_CONFIDENCE - The face was detected with a low - // confidence. - // - // * SMALL_BOUNDING_BOX - The bounding box around the face is too - // small. + // - EXTREME_POSE - The face is at a pose that can't be detected. For example, + // the head is turned too far away from the camera. + // - EXCEEDS_MAX_FACES - The number of faces detected is already higher than + // that specified by the MaxFaces input parameter for IndexFaces . + // - LOW_BRIGHTNESS - The image is too dark. + // - LOW_SHARPNESS - The image is too blurry. + // - LOW_CONFIDENCE - The face was detected with a low confidence. + // - SMALL_BOUNDING_BOX - The bounding box around the face is too small. Reasons []Reason noSmithyDocumentSerde @@ -2187,10 +2173,10 @@ type UnindexedFace struct { // training job. The validation data includes error information for individual JSON // Lines in the dataset. For more information, see Debugging a Failed Model // Training in the Amazon Rekognition Custom Labels Developer Guide. You get the -// ValidationData object for the training dataset (TrainingDataResult) and the test -// dataset (TestingDataResult) by calling DescribeProjectVersions. The assets array -// contains a single Asset object. The GroundTruthManifest field of the Asset -// object contains the S3 bucket location of the validation data. +// ValidationData object for the training dataset ( TrainingDataResult ) and the +// test dataset ( TestingDataResult ) by calling DescribeProjectVersions . The +// assets array contains a single Asset object. The GroundTruthManifest field of +// the Asset object contains the S3 bucket location of the validation data. type ValidationData struct { // The assets that comprise the validation data. @@ -2218,8 +2204,8 @@ type VideoMetadata struct { // Type of compression used in the analyzed video. Codec *string - // A description of the range of luminance values in a video, either LIMITED (16 to - // 235) or FULL (0 to 255). + // A description of the range of luminance values in a video, either LIMITED (16 + // to 235) or FULL (0 to 255). ColorRange VideoColorRange // Length of the video in milliseconds. diff --git a/service/resiliencehub/api_client.go b/service/resiliencehub/api_client.go index b6edce13290..1a5d9414dab 100644 --- a/service/resiliencehub/api_client.go +++ b/service/resiliencehub/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go b/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go index 1565b2c38a9..a42f4ced8b5 100644 --- a/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the resource mapping for the draft application version. You can also update -// an existing resource mapping to a new physical resource. +// Adds the resource mapping for the draft application version. You can also +// update an existing resource mapping to a new physical resource. func (c *Client) AddDraftAppVersionResourceMappings(ctx context.Context, params *AddDraftAppVersionResourceMappingsInput, optFns ...func(*Options)) (*AddDraftAppVersionResourceMappingsOutput, error) { if params == nil { params = &AddDraftAppVersionResourceMappingsInput{} @@ -30,11 +30,10 @@ func (c *Client) AddDraftAppVersionResourceMappings(ctx context.Context, params type AddDraftAppVersionResourceMappingsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -42,8 +41,8 @@ type AddDraftAppVersionResourceMappingsInput struct { // Mappings used to map logical resources from the template to physical resources. // You can use the mapping type CFN_STACK if the application template uses a // logical stack name. Or you can map individual resources by using the mapping - // type RESOURCE. We recommend using the mapping type CFN_STACK if the application - // is backed by a CloudFormation stack. + // type RESOURCE . We recommend using the mapping type CFN_STACK if the + // application is backed by a CloudFormation stack. // // This member is required. ResourceMappings []types.ResourceMapping @@ -53,11 +52,10 @@ type AddDraftAppVersionResourceMappingsInput struct { type AddDraftAppVersionResourceMappingsOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -70,8 +68,8 @@ type AddDraftAppVersionResourceMappingsOutput struct { // Mappings used to map logical resources from the template to physical resources. // You can use the mapping type CFN_STACK if the application template uses a // logical stack name. Or you can map individual resources by using the mapping - // type RESOURCE. We recommend using the mapping type CFN_STACK if the application - // is backed by a CloudFormation stack. + // type RESOURCE . We recommend using the mapping type CFN_STACK if the + // application is backed by a CloudFormation stack. // // This member is required. ResourceMappings []types.ResourceMapping diff --git a/service/resiliencehub/api_op_CreateApp.go b/service/resiliencehub/api_op_CreateApp.go index e29baacf516..27abbad56e3 100644 --- a/service/resiliencehub/api_op_CreateApp.go +++ b/service/resiliencehub/api_op_CreateApp.go @@ -47,23 +47,22 @@ type CreateAppInput struct { // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule types.AppAssessmentScheduleType - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // The optional description for an app. Description *string - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. PolicyArn *string - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_CreateAppVersionAppComponent.go b/service/resiliencehub/api_op_CreateAppVersionAppComponent.go index 2b897603770..242efb57771 100644 --- a/service/resiliencehub/api_op_CreateAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_CreateAppVersionAppComponent.go @@ -33,11 +33,10 @@ func (c *Client) CreateAppVersionAppComponent(ctx context.Context, params *Creat type CreateAppVersionAppComponentInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -48,8 +47,8 @@ type CreateAppVersionAppComponentInput struct { Name *string // The type of Application Component. For more information about the types of - // Application Component, see Grouping resources in an AppComponent - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html). + // Application Component, see Grouping resources in an AppComponent (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html) + // . // // This member is required. Type *string @@ -58,9 +57,9 @@ type CreateAppVersionAppComponentInput struct { // Components. AdditionalInfo map[string][]string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // The identifier of the Application Component. @@ -71,11 +70,10 @@ type CreateAppVersionAppComponentInput struct { type CreateAppVersionAppComponentOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_CreateAppVersionResource.go b/service/resiliencehub/api_op_CreateAppVersionResource.go index 0c76ca2c4b6..5138a99a22a 100644 --- a/service/resiliencehub/api_op_CreateAppVersionResource.go +++ b/service/resiliencehub/api_op_CreateAppVersionResource.go @@ -15,17 +15,12 @@ import ( // Adds a resource to the Resilience Hub application and assigns it to the // specified Application Components. If you specify a new Application Component, // Resilience Hub will automatically create the Application Component. -// -// * This -// action has no effect outside Resilience Hub. -// -// * This API updates the Resilience -// Hub application draft version. To use this resource for running resiliency -// assessments, you must publish the Resilience Hub application using the -// PublishAppVersion API. -// -// * To update application version with new -// physicalResourceID, you must call ResolveAppVersionResources API. +// - This action has no effect outside Resilience Hub. +// - This API updates the Resilience Hub application draft version. To use this +// resource for running resiliency assessments, you must publish the Resilience Hub +// application using the PublishAppVersion API. +// - To update application version with new physicalResourceID , you must call +// ResolveAppVersionResources API. func (c *Client) CreateAppVersionResource(ctx context.Context, params *CreateAppVersionResourceInput, optFns ...func(*Options)) (*CreateAppVersionResourceOutput, error) { if params == nil { params = &CreateAppVersionResourceInput{} @@ -43,11 +38,10 @@ func (c *Client) CreateAppVersionResource(ctx context.Context, params *CreateApp type CreateAppVersionResourceInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -88,9 +82,9 @@ type CreateAppVersionResourceInput struct { // The Amazon Web Services region that owns the physical resource. AwsRegion *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string noSmithyDocumentSerde @@ -98,11 +92,10 @@ type CreateAppVersionResourceInput struct { type CreateAppVersionResourceOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_CreateRecommendationTemplate.go b/service/resiliencehub/api_op_CreateRecommendationTemplate.go index ec293ea1e3e..b25e991b592 100644 --- a/service/resiliencehub/api_op_CreateRecommendationTemplate.go +++ b/service/resiliencehub/api_op_CreateRecommendationTemplate.go @@ -31,10 +31,9 @@ func (c *Client) CreateRecommendationTemplate(ctx context.Context, params *Creat type CreateRecommendationTemplateInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string @@ -47,9 +46,9 @@ type CreateRecommendationTemplateInput struct { // The name of the Amazon S3 bucket that will contain the recommendation template. BucketName *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // The format for the recommendation template. CfnJson The template is @@ -64,8 +63,8 @@ type CreateRecommendationTemplateInput struct { // SopRecommendation template. Test The template is a TestRecommendation template. RecommendationTypes []types.RenderRecommendationType - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_CreateResiliencyPolicy.go b/service/resiliencehub/api_op_CreateResiliencyPolicy.go index 6f70337fea8..ed449e3512c 100644 --- a/service/resiliencehub/api_op_CreateResiliencyPolicy.go +++ b/service/resiliencehub/api_op_CreateResiliencyPolicy.go @@ -41,15 +41,15 @@ type CreateResiliencyPolicyInput struct { // This member is required. PolicyName *string - // The tier for this resiliency policy, ranging from the highest severity - // (MissionCritical) to lowest (NonCritical). + // The tier for this resiliency policy, ranging from the highest severity ( + // MissionCritical ) to lowest ( NonCritical ). // // This member is required. Tier types.ResiliencyPolicyTier - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // Specifies a high-level geographical location constraint for where your @@ -59,8 +59,8 @@ type CreateResiliencyPolicyInput struct { // The description for the policy. PolicyDescription *string - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_DeleteApp.go b/service/resiliencehub/api_op_DeleteApp.go index f6584b48c83..272c36586b7 100644 --- a/service/resiliencehub/api_op_DeleteApp.go +++ b/service/resiliencehub/api_op_DeleteApp.go @@ -30,18 +30,17 @@ func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns . type DeleteAppInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // A boolean option to force the deletion of an Resilience Hub application. @@ -52,11 +51,10 @@ type DeleteAppInput struct { type DeleteAppOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteAppAssessment.go b/service/resiliencehub/api_op_DeleteAppAssessment.go index 5c1a031e534..f818fd147c3 100644 --- a/service/resiliencehub/api_op_DeleteAppAssessment.go +++ b/service/resiliencehub/api_op_DeleteAppAssessment.go @@ -32,17 +32,16 @@ func (c *Client) DeleteAppAssessment(ctx context.Context, params *DeleteAppAsses type DeleteAppAssessmentInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string noSmithyDocumentSerde @@ -51,10 +50,9 @@ type DeleteAppAssessmentInput struct { type DeleteAppAssessmentOutput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_DeleteAppInputSource.go b/service/resiliencehub/api_op_DeleteAppInputSource.go index 2fe347948ef..46bd72ab08a 100644 --- a/service/resiliencehub/api_op_DeleteAppInputSource.go +++ b/service/resiliencehub/api_op_DeleteAppInputSource.go @@ -31,29 +31,27 @@ func (c *Client) DeleteAppInputSource(ctx context.Context, params *DeleteAppInpu type DeleteAppInputSourceInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string - // The namespace on your Amazon Elastic Kubernetes Service cluster that you want to - // delete from the Resilience Hub application. + // The namespace on your Amazon Elastic Kubernetes Service cluster that you want + // to delete from the Resilience Hub application. EksSourceClusterNamespace *types.EksSourceClusterNamespace // The Amazon Resource Name (ARN) of the imported resource you want to remove from - // the Resilience Hub application. For more information about ARNs, see Amazon - // Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // the Resilience Hub application. For more information about ARNs, see Amazon + // Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. SourceArn *string // The imported Terraform s3 state file you want to remove from the Resilience Hub @@ -65,11 +63,10 @@ type DeleteAppInputSourceInput struct { type DeleteAppInputSourceOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The name of the input source from where the application resource is imported diff --git a/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go b/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go index 0b9ffc2c445..fe01af4de69 100644 --- a/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go @@ -13,14 +13,11 @@ import ( ) // Deletes an Application Component from the Resilience Hub application. -// -// * This -// API updates the Resilience Hub application draft version. To use this -// Application Component for running assessments, you must publish the Resilience -// Hub application using the PublishAppVersion API. -// -// * You will not be able to -// delete an Application Component if it has resources associated with it. +// - This API updates the Resilience Hub application draft version. To use this +// Application Component for running assessments, you must publish the Resilience +// Hub application using the PublishAppVersion API. +// - You will not be able to delete an Application Component if it has resources +// associated with it. func (c *Client) DeleteAppVersionAppComponent(ctx context.Context, params *DeleteAppVersionAppComponentInput, optFns ...func(*Options)) (*DeleteAppVersionAppComponentOutput, error) { if params == nil { params = &DeleteAppVersionAppComponentInput{} @@ -38,11 +35,10 @@ func (c *Client) DeleteAppVersionAppComponent(ctx context.Context, params *Delet type DeleteAppVersionAppComponentInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -52,9 +48,9 @@ type DeleteAppVersionAppComponentInput struct { // This member is required. Id *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string noSmithyDocumentSerde @@ -62,11 +58,10 @@ type DeleteAppVersionAppComponentInput struct { type DeleteAppVersionAppComponentOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteAppVersionResource.go b/service/resiliencehub/api_op_DeleteAppVersionResource.go index 90fcf267490..869ae09c978 100644 --- a/service/resiliencehub/api_op_DeleteAppVersionResource.go +++ b/service/resiliencehub/api_op_DeleteAppVersionResource.go @@ -13,17 +13,12 @@ import ( ) // Deletes a resource from the Resilience Hub application. -// -// * You can only delete a -// manually added resource. To exclude non-manually added resources, use the -// UpdateAppVersionResource API. -// -// * This action has no effect outside Resilience -// Hub. -// -// * This API updates the Resilience Hub application draft version. To use -// this resource for running resiliency assessments, you must publish the -// Resilience Hub application using the PublishAppVersion API. +// - You can only delete a manually added resource. To exclude non-manually +// added resources, use the UpdateAppVersionResource API. +// - This action has no effect outside Resilience Hub. +// - This API updates the Resilience Hub application draft version. To use this +// resource for running resiliency assessments, you must publish the Resilience Hub +// application using the PublishAppVersion API. func (c *Client) DeleteAppVersionResource(ctx context.Context, params *DeleteAppVersionResourceInput, optFns ...func(*Options)) (*DeleteAppVersionResourceOutput, error) { if params == nil { params = &DeleteAppVersionResourceInput{} @@ -41,11 +36,10 @@ func (c *Client) DeleteAppVersionResource(ctx context.Context, params *DeleteApp type DeleteAppVersionResourceInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -56,9 +50,9 @@ type DeleteAppVersionResourceInput struct { // The Amazon Web Services region that owns the physical resource. AwsRegion *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string // The logical identifier of the resource. @@ -75,11 +69,10 @@ type DeleteAppVersionResourceInput struct { type DeleteAppVersionResourceOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteRecommendationTemplate.go b/service/resiliencehub/api_op_DeleteRecommendationTemplate.go index 49f6a7f85e7..f7748fdfb84 100644 --- a/service/resiliencehub/api_op_DeleteRecommendationTemplate.go +++ b/service/resiliencehub/api_op_DeleteRecommendationTemplate.go @@ -36,9 +36,9 @@ type DeleteRecommendationTemplateInput struct { // This member is required. RecommendationTemplateArn *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_DeleteResiliencyPolicy.go b/service/resiliencehub/api_op_DeleteResiliencyPolicy.go index 33f323dda3e..4b9d4f18510 100644 --- a/service/resiliencehub/api_op_DeleteResiliencyPolicy.go +++ b/service/resiliencehub/api_op_DeleteResiliencyPolicy.go @@ -29,18 +29,17 @@ func (c *Client) DeleteResiliencyPolicy(ctx context.Context, params *DeleteResil type DeleteResiliencyPolicyInput struct { - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. PolicyArn *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string noSmithyDocumentSerde @@ -48,11 +47,10 @@ type DeleteResiliencyPolicyInput struct { type DeleteResiliencyPolicyOutput struct { - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. PolicyArn *string diff --git a/service/resiliencehub/api_op_DescribeApp.go b/service/resiliencehub/api_op_DescribeApp.go index 9a961a5f71a..0f33c48d079 100644 --- a/service/resiliencehub/api_op_DescribeApp.go +++ b/service/resiliencehub/api_op_DescribeApp.go @@ -29,11 +29,10 @@ func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optF type DescribeAppInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppAssessment.go b/service/resiliencehub/api_op_DescribeAppAssessment.go index 94a3217694b..66ae41fff56 100644 --- a/service/resiliencehub/api_op_DescribeAppAssessment.go +++ b/service/resiliencehub/api_op_DescribeAppAssessment.go @@ -30,10 +30,9 @@ func (c *Client) DescribeAppAssessment(ctx context.Context, params *DescribeAppA type DescribeAppAssessmentInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersion.go b/service/resiliencehub/api_op_DescribeAppVersion.go index b9fea50d1ed..66ead78701e 100644 --- a/service/resiliencehub/api_op_DescribeAppVersion.go +++ b/service/resiliencehub/api_op_DescribeAppVersion.go @@ -28,11 +28,10 @@ func (c *Client) DescribeAppVersion(ctx context.Context, params *DescribeAppVers type DescribeAppVersionInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,11 +46,10 @@ type DescribeAppVersionInput struct { type DescribeAppVersionOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -63,9 +61,8 @@ type DescribeAppVersionOutput struct { // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter supports only failover region and account. + // using an API call, see Configure the application configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter supports only failover region and account. AdditionalInfo map[string][]string // Metadata pertaining to the operation's result. diff --git a/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go b/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go index f189c2c2a17..83e4b6e404e 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go @@ -29,11 +29,10 @@ func (c *Client) DescribeAppVersionAppComponent(ctx context.Context, params *Des type DescribeAppVersionAppComponentInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -53,11 +52,10 @@ type DescribeAppVersionAppComponentInput struct { type DescribeAppVersionAppComponentOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionResource.go b/service/resiliencehub/api_op_DescribeAppVersionResource.go index 46de9edf5e7..31ae46e2363 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionResource.go +++ b/service/resiliencehub/api_op_DescribeAppVersionResource.go @@ -13,14 +13,10 @@ import ( // Describes a resource of the Resilience Hub application. This API accepts only // one of the following parameters to descibe the resource: -// -// * resourceName -// -// * -// logicalResourceId -// -// * physicalResourceId (Along with physicalResourceId, you can -// also provide awsAccountId, and awsRegion) +// - resourceName +// - logicalResourceId +// - physicalResourceId (Along with physicalResourceId , you can also provide +// awsAccountId , and awsRegion ) func (c *Client) DescribeAppVersionResource(ctx context.Context, params *DescribeAppVersionResourceInput, optFns ...func(*Options)) (*DescribeAppVersionResourceOutput, error) { if params == nil { params = &DescribeAppVersionResourceInput{} @@ -38,11 +34,10 @@ func (c *Client) DescribeAppVersionResource(ctx context.Context, params *Describ type DescribeAppVersionResourceInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -72,11 +67,10 @@ type DescribeAppVersionResourceInput struct { type DescribeAppVersionResourceOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go b/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go index b020fb59b43..96496a0c18f 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go +++ b/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go @@ -31,11 +31,10 @@ func (c *Client) DescribeAppVersionResourcesResolutionStatus(ctx context.Context type DescribeAppVersionResourcesResolutionStatusInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -53,11 +52,10 @@ type DescribeAppVersionResourcesResolutionStatusInput struct { type DescribeAppVersionResourcesResolutionStatusOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionTemplate.go b/service/resiliencehub/api_op_DescribeAppVersionTemplate.go index 1e4c07b89b8..7e68c5c9f0e 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionTemplate.go +++ b/service/resiliencehub/api_op_DescribeAppVersionTemplate.go @@ -28,11 +28,10 @@ func (c *Client) DescribeAppVersionTemplate(ctx context.Context, params *Describ type DescribeAppVersionTemplateInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,11 +46,10 @@ type DescribeAppVersionTemplateInput struct { type DescribeAppVersionTemplateOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -60,122 +58,74 @@ type DescribeAppVersionTemplateOutput struct { // learn more about the appTemplateBody template, see the sample template provided // in the Examples section. The appTemplateBody JSON string has the following // structure: - // - // * resources The list of logical resources that must be included in - // the Resilience Hub application. Type: Array Don't add the resources that you - // want to exclude. Each resources array item includes the following fields: - // - // * - // logicalResourceId The logical identifier of the resource. Type: Object Each - // logicalResourceId object includes the following fields: - // - // * identifier The - // identifier of the resource. Type: String - // - // * logicalStackName The name of the - // CloudFormation stack this resource belongs to. Type: String - // - // * resourceGroupName - // The name of the resource group this resource belongs to. Type: String - // - // * - // terraformSourceName The name of the Terraform S3 state file this resource - // belongs to. Type: String - // - // * eksSourceName The name of the Amazon Elastic - // Kubernetes Service cluster and namespace this resource belongs to. This - // parameter accepts values in "eks-cluster/namespace" format. Type: String - // - // * type - // The type of resource. Type: string - // - // * name The name of the resource. Type: - // String - // - // * additionalInfo Additional configuration parameters for an Resilience - // Hub application. If you want to implement additionalInfo through the Resilience - // Hub console rather than using an API call, see Configure the application - // configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" - // - // * - // appComponents The list of Application Components that this resource belongs to. - // If an Application Component is not part of the Resilience Hub application, it - // will be added. Type: Array Each appComponents array item includes the following - // fields: - // - // * name The name of the Application Component. Type: String - // - // * type The - // type of Application Component. For more information about the types of - // Application Component, see Grouping resources in an AppComponent - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html). - // Type: String - // - // * resourceNames The list of included resources that are assigned - // to the Application Component. Type: Array of strings - // - // * additionalInfo - // Additional configuration parameters for an Resilience Hub application. If you - // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" - // - // * - // excludedResources The list of logical resource identifiers to be excluded from - // the application. Type: Array Don't add the resources that you want to include. - // Each excludedResources array item includes the following fields: - // - // * - // logicalResourceIds The logical identifier of the resource. Type: Object You can - // configure only one of the following fields: - // - // * logicalStackName - // - // * - // resourceGroupName - // - // * terraformSourceName - // - // * eksSourceName - // - // Each - // logicalResourceIds object includes the following fields: - // - // * identifier The - // identifier of the resource. Type: String - // - // * logicalStackName The name of the - // CloudFormation stack this resource belongs to. Type: String - // - // * resourceGroupName - // The name of the resource group this resource belongs to. Type: String - // - // * - // terraformSourceName The name of the Terraform S3 state file this resource - // belongs to. Type: String - // - // * eksSourceName The name of the Amazon Elastic - // Kubernetes Service cluster and namespace this resource belongs to. This - // parameter accepts values in "eks-cluster/namespace" format. Type: String - // - // * - // version The Resilience Hub application version. - // - // * additionalInfo Additional - // configuration parameters for an Resilience Hub application. If you want to - // implement additionalInfo through the Resilience Hub console rather than using an - // API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - resources The list of logical resources that must be included in the + // Resilience Hub application. Type: Array Don't add the resources that you want to + // exclude. Each resources array item includes the following fields: + // - logicalResourceId The logical identifier of the resource. Type: Object Each + // logicalResourceId object includes the following fields: + // - identifier The identifier of the resource. Type: String + // - logicalStackName The name of the CloudFormation stack this resource belongs + // to. Type: String + // - resourceGroupName The name of the resource group this resource belongs to. + // Type: String + // - terraformSourceName The name of the Terraform S3 state file this resource + // belongs to. Type: String + // - eksSourceName The name of the Amazon Elastic Kubernetes Service cluster and + // namespace this resource belongs to. This parameter accepts values in + // "eks-cluster/namespace" format. Type: String + // - type The type of resource. Type: string + // - name The name of the resource. Type: String + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - appComponents The list of Application Components that this resource belongs + // to. If an Application Component is not part of the Resilience Hub application, + // it will be added. Type: Array Each appComponents array item includes the + // following fields: + // - name The name of the Application Component. Type: String + // - type The type of Application Component. For more information about the types + // of Application Component, see Grouping resources in an AppComponent (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html) + // . Type: String + // - resourceNames The list of included resources that are assigned to the + // Application Component. Type: Array of strings + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - excludedResources The list of logical resource identifiers to be excluded + // from the application. Type: Array Don't add the resources that you want to + // include. Each excludedResources array item includes the following fields: + // - logicalResourceIds The logical identifier of the resource. Type: Object You + // can configure only one of the following fields: + // - logicalStackName + // - resourceGroupName + // - terraformSourceName + // - eksSourceName Each logicalResourceIds object includes the following fields: + // - identifier The identifier of the resource. Type: String + // - logicalStackName The name of the CloudFormation stack this resource belongs + // to. Type: String + // - resourceGroupName The name of the resource group this resource belongs to. + // Type: String + // - terraformSourceName The name of the Terraform S3 state file this resource + // belongs to. Type: String + // - eksSourceName The name of the Amazon Elastic Kubernetes Service cluster and + // namespace this resource belongs to. This parameter accepts values in + // "eks-cluster/namespace" format. Type: String + // - version The Resilience Hub application version. + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" // // This member is required. AppTemplateBody *string diff --git a/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go b/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go index c5be29ecc04..b98942465a2 100644 --- a/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go +++ b/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go @@ -13,7 +13,7 @@ import ( ) // Describes the status of importing resources to an application version. If you -// get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must +// get a 404 error with ResourceImportStatusNotFoundAppMetadataException , you must // call importResourcesToDraftAppVersion after creating the application and before // calling describeDraftAppVersionResourcesImportStatus to obtain the status. func (c *Client) DescribeDraftAppVersionResourcesImportStatus(ctx context.Context, params *DescribeDraftAppVersionResourcesImportStatusInput, optFns ...func(*Options)) (*DescribeDraftAppVersionResourcesImportStatusOutput, error) { @@ -33,11 +33,10 @@ func (c *Client) DescribeDraftAppVersionResourcesImportStatus(ctx context.Contex type DescribeDraftAppVersionResourcesImportStatusInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,11 +46,10 @@ type DescribeDraftAppVersionResourcesImportStatusInput struct { type DescribeDraftAppVersionResourcesImportStatusOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeResiliencyPolicy.go b/service/resiliencehub/api_op_DescribeResiliencyPolicy.go index bfb8b072c84..4e2be0129c1 100644 --- a/service/resiliencehub/api_op_DescribeResiliencyPolicy.go +++ b/service/resiliencehub/api_op_DescribeResiliencyPolicy.go @@ -31,11 +31,10 @@ func (c *Client) DescribeResiliencyPolicy(ctx context.Context, params *DescribeR type DescribeResiliencyPolicyInput struct { - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. PolicyArn *string diff --git a/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go b/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go index 8b377b81692..6801315bba5 100644 --- a/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go +++ b/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go @@ -14,8 +14,8 @@ import ( // Imports resources to Resilience Hub application draft version from different // input sources. For more information about the input sources supported by // Resilience Hub, see Discover the structure and describe your Resilience Hub -// application -// (https://docs.aws.amazon.com/resilience-hub/latest/userguide/discover-structure.html). +// application (https://docs.aws.amazon.com/resilience-hub/latest/userguide/discover-structure.html) +// . func (c *Client) ImportResourcesToDraftAppVersion(ctx context.Context, params *ImportResourcesToDraftAppVersionInput, optFns ...func(*Options)) (*ImportResourcesToDraftAppVersionOutput, error) { if params == nil { params = &ImportResourcesToDraftAppVersionInput{} @@ -33,17 +33,16 @@ func (c *Client) ImportResourcesToDraftAppVersion(ctx context.Context, params *I type ImportResourcesToDraftAppVersionInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string - // The input sources of the Amazon Elastic Kubernetes Service resources you need to - // import. + // The input sources of the Amazon Elastic Kubernetes Service resources you need + // to import. EksSources []types.EksSource // The import strategy you would like to set to import resources into Resilience @@ -61,11 +60,10 @@ type ImportResourcesToDraftAppVersionInput struct { type ImportResourcesToDraftAppVersionOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAlarmRecommendations.go b/service/resiliencehub/api_op_ListAlarmRecommendations.go index 97c45636f28..529037c352a 100644 --- a/service/resiliencehub/api_op_ListAlarmRecommendations.go +++ b/service/resiliencehub/api_op_ListAlarmRecommendations.go @@ -31,17 +31,16 @@ func (c *Client) ListAlarmRecommendations(ctx context.Context, params *ListAlarm type ListAlarmRecommendationsInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -144,8 +143,8 @@ var _ ListAlarmRecommendationsAPIClient = (*Client)(nil) // ListAlarmRecommendations type ListAlarmRecommendationsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppAssessments.go b/service/resiliencehub/api_op_ListAppAssessments.go index 117c593cdbb..89e4b0b24d3 100644 --- a/service/resiliencehub/api_op_ListAppAssessments.go +++ b/service/resiliencehub/api_op_ListAppAssessments.go @@ -31,11 +31,10 @@ func (c *Client) ListAppAssessments(ctx context.Context, params *ListAppAssessme type ListAppAssessmentsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The name for the assessment. @@ -48,19 +47,19 @@ type ListAppAssessmentsInput struct { ComplianceStatus types.ComplianceStatus // Specifies the entity that invoked a specific assessment, either a User or the - // System. + // System . Invoker types.AssessmentInvoker // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // The default is to sort by ascending startTime. To sort by descending startTime, - // set reverseOrder to true. + // set reverseOrder to true . ReverseOrder *bool noSmithyDocumentSerde @@ -156,8 +155,8 @@ var _ ListAppAssessmentsAPIClient = (*Client)(nil) // ListAppAssessments type ListAppAssessmentsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppComponentCompliances.go b/service/resiliencehub/api_op_ListAppComponentCompliances.go index 0f581b05df6..449f0ca423d 100644 --- a/service/resiliencehub/api_op_ListAppComponentCompliances.go +++ b/service/resiliencehub/api_op_ListAppComponentCompliances.go @@ -31,17 +31,16 @@ func (c *Client) ListAppComponentCompliances(ctx context.Context, params *ListAp type ListAppComponentCompliancesInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -143,8 +142,8 @@ var _ ListAppComponentCompliancesAPIClient = (*Client)(nil) // ListAppComponentCompliances type ListAppComponentCompliancesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppComponentRecommendations.go b/service/resiliencehub/api_op_ListAppComponentRecommendations.go index 9eb2eb810ea..7eaa1270723 100644 --- a/service/resiliencehub/api_op_ListAppComponentRecommendations.go +++ b/service/resiliencehub/api_op_ListAppComponentRecommendations.go @@ -31,17 +31,16 @@ func (c *Client) ListAppComponentRecommendations(ctx context.Context, params *Li type ListAppComponentRecommendationsInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -143,8 +142,8 @@ var _ ListAppComponentRecommendationsAPIClient = (*Client)(nil) // ListAppComponentRecommendations type ListAppComponentRecommendationsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppInputSources.go b/service/resiliencehub/api_op_ListAppInputSources.go index 07ee5756a25..c076a387e64 100644 --- a/service/resiliencehub/api_op_ListAppInputSources.go +++ b/service/resiliencehub/api_op_ListAppInputSources.go @@ -14,8 +14,8 @@ import ( // Lists all the input sources of the Resilience Hub application. For more // information about the input sources supported by Resilience Hub, see Discover -// the structure and describe your Resilience Hub application -// (https://docs.aws.amazon.com/resilience-hub/latest/userguide/discover-structure.html). +// the structure and describe your Resilience Hub application (https://docs.aws.amazon.com/resilience-hub/latest/userguide/discover-structure.html) +// . func (c *Client) ListAppInputSources(ctx context.Context, params *ListAppInputSourcesInput, optFns ...func(*Options)) (*ListAppInputSourcesOutput, error) { if params == nil { params = &ListAppInputSourcesInput{} @@ -33,11 +33,10 @@ func (c *Client) ListAppInputSources(ctx context.Context, params *ListAppInputSo type ListAppInputSourcesInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -135,8 +134,8 @@ func (c *Client) addOperationListAppInputSourcesMiddlewares(stack *middleware.St return nil } -// ListAppInputSourcesAPIClient is a client that implements the ListAppInputSources -// operation. +// ListAppInputSourcesAPIClient is a client that implements the +// ListAppInputSources operation. type ListAppInputSourcesAPIClient interface { ListAppInputSources(context.Context, *ListAppInputSourcesInput, ...func(*Options)) (*ListAppInputSourcesOutput, error) } diff --git a/service/resiliencehub/api_op_ListAppVersionAppComponents.go b/service/resiliencehub/api_op_ListAppVersionAppComponents.go index 333118f85b7..3f11d5ab450 100644 --- a/service/resiliencehub/api_op_ListAppVersionAppComponents.go +++ b/service/resiliencehub/api_op_ListAppVersionAppComponents.go @@ -30,11 +30,10 @@ func (c *Client) ListAppVersionAppComponents(ctx context.Context, params *ListAp type ListAppVersionAppComponentsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -56,11 +55,10 @@ type ListAppVersionAppComponentsInput struct { type ListAppVersionAppComponentsOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAppVersionResourceMappings.go b/service/resiliencehub/api_op_ListAppVersionResourceMappings.go index 8b11ce81a73..0253689f107 100644 --- a/service/resiliencehub/api_op_ListAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_ListAppVersionResourceMappings.go @@ -32,11 +32,10 @@ func (c *Client) ListAppVersionResourceMappings(ctx context.Context, params *Lis type ListAppVersionResourceMappingsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,8 +46,8 @@ type ListAppVersionResourceMappingsInput struct { AppVersion *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -62,8 +61,8 @@ type ListAppVersionResourceMappingsOutput struct { // Mappings used to map logical resources from the template to physical resources. // You can use the mapping type CFN_STACK if the application template uses a // logical stack name. Or you can map individual resources by using the mapping - // type RESOURCE. We recommend using the mapping type CFN_STACK if the application - // is backed by a CloudFormation stack. + // type RESOURCE . We recommend using the mapping type CFN_STACK if the + // application is backed by a CloudFormation stack. // // This member is required. ResourceMappings []types.ResourceMapping @@ -152,8 +151,8 @@ var _ ListAppVersionResourceMappingsAPIClient = (*Client)(nil) // ListAppVersionResourceMappings type ListAppVersionResourceMappingsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppVersionResources.go b/service/resiliencehub/api_op_ListAppVersionResources.go index 2974d765c79..f3f25247628 100644 --- a/service/resiliencehub/api_op_ListAppVersionResources.go +++ b/service/resiliencehub/api_op_ListAppVersionResources.go @@ -30,11 +30,10 @@ func (c *Client) ListAppVersionResources(ctx context.Context, params *ListAppVer type ListAppVersionResourcesInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -45,8 +44,8 @@ type ListAppVersionResourcesInput struct { AppVersion *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -154,8 +153,8 @@ var _ ListAppVersionResourcesAPIClient = (*Client)(nil) // ListAppVersionResources type ListAppVersionResourcesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListAppVersions.go b/service/resiliencehub/api_op_ListAppVersions.go index 5bfb375fd0c..e5114305b77 100644 --- a/service/resiliencehub/api_op_ListAppVersions.go +++ b/service/resiliencehub/api_op_ListAppVersions.go @@ -30,18 +30,17 @@ func (c *Client) ListAppVersions(ctx context.Context, params *ListAppVersionsInp type ListAppVersionsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -140,8 +139,8 @@ var _ ListAppVersionsAPIClient = (*Client)(nil) // ListAppVersionsPaginatorOptions is the paginator options for ListAppVersions type ListAppVersionsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListApps.go b/service/resiliencehub/api_op_ListApps.go index 057dab49a2b..e6042635443 100644 --- a/service/resiliencehub/api_op_ListApps.go +++ b/service/resiliencehub/api_op_ListApps.go @@ -34,16 +34,15 @@ func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ... type ListAppsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // The name for the one of the listed applications. @@ -141,8 +140,8 @@ var _ ListAppsAPIClient = (*Client)(nil) // ListAppsPaginatorOptions is the paginator options for ListApps type ListAppsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListRecommendationTemplates.go b/service/resiliencehub/api_op_ListRecommendationTemplates.go index bbf9cee884c..61ec17d0049 100644 --- a/service/resiliencehub/api_op_ListRecommendationTemplates.go +++ b/service/resiliencehub/api_op_ListRecommendationTemplates.go @@ -31,17 +31,16 @@ func (c *Client) ListRecommendationTemplates(ctx context.Context, params *ListRe type ListRecommendationTemplatesInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // The name for one of the listed recommendation templates. @@ -54,7 +53,7 @@ type ListRecommendationTemplatesInput struct { RecommendationTemplateArn *string // The default is to sort by ascending startTime. To sort by descending startTime, - // set reverseOrder to true. + // set reverseOrder to true . ReverseOrder *bool // The status of the action. @@ -152,8 +151,8 @@ var _ ListRecommendationTemplatesAPIClient = (*Client)(nil) // ListRecommendationTemplates type ListRecommendationTemplatesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListResiliencyPolicies.go b/service/resiliencehub/api_op_ListResiliencyPolicies.go index a55be8d7c07..15238e19df6 100644 --- a/service/resiliencehub/api_op_ListResiliencyPolicies.go +++ b/service/resiliencehub/api_op_ListResiliencyPolicies.go @@ -31,8 +31,8 @@ func (c *Client) ListResiliencyPolicies(ctx context.Context, params *ListResilie type ListResiliencyPoliciesInput struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -132,8 +132,8 @@ var _ ListResiliencyPoliciesAPIClient = (*Client)(nil) // ListResiliencyPolicies type ListResiliencyPoliciesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListSopRecommendations.go b/service/resiliencehub/api_op_ListSopRecommendations.go index 19fcbbdf845..2c8ef7e5fcf 100644 --- a/service/resiliencehub/api_op_ListSopRecommendations.go +++ b/service/resiliencehub/api_op_ListSopRecommendations.go @@ -32,17 +32,16 @@ func (c *Client) ListSopRecommendations(ctx context.Context, params *ListSopReco type ListSopRecommendationsInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -143,8 +142,8 @@ var _ ListSopRecommendationsAPIClient = (*Client)(nil) // ListSopRecommendations type ListSopRecommendationsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListSuggestedResiliencyPolicies.go b/service/resiliencehub/api_op_ListSuggestedResiliencyPolicies.go index e3b3e268860..a420d2ecb71 100644 --- a/service/resiliencehub/api_op_ListSuggestedResiliencyPolicies.go +++ b/service/resiliencehub/api_op_ListSuggestedResiliencyPolicies.go @@ -31,8 +31,8 @@ func (c *Client) ListSuggestedResiliencyPolicies(ctx context.Context, params *Li type ListSuggestedResiliencyPoliciesInput struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -129,8 +129,8 @@ var _ ListSuggestedResiliencyPoliciesAPIClient = (*Client)(nil) // ListSuggestedResiliencyPolicies type ListSuggestedResiliencyPoliciesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListTagsForResource.go b/service/resiliencehub/api_op_ListTagsForResource.go index 62fb43212ba..5e84c6fa121 100644 --- a/service/resiliencehub/api_op_ListTagsForResource.go +++ b/service/resiliencehub/api_op_ListTagsForResource.go @@ -39,8 +39,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/resiliencehub/api_op_ListTestRecommendations.go b/service/resiliencehub/api_op_ListTestRecommendations.go index e1a74c35053..8813b245b17 100644 --- a/service/resiliencehub/api_op_ListTestRecommendations.go +++ b/service/resiliencehub/api_op_ListTestRecommendations.go @@ -31,17 +31,16 @@ func (c *Client) ListTestRecommendations(ctx context.Context, params *ListTestRe type ListTestRecommendationsInput struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -141,8 +140,8 @@ var _ ListTestRecommendationsAPIClient = (*Client)(nil) // ListTestRecommendations type ListTestRecommendationsPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go b/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go index 89ae9c169bd..656e118d4f9 100644 --- a/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go +++ b/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go @@ -32,11 +32,10 @@ func (c *Client) ListUnsupportedAppVersionResources(ctx context.Context, params type ListUnsupportedAppVersionResourcesInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,8 +46,8 @@ type ListUnsupportedAppVersionResourcesInput struct { AppVersion *string // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. @@ -156,8 +155,8 @@ var _ ListUnsupportedAppVersionResourcesAPIClient = (*Client)(nil) // ListUnsupportedAppVersionResources type ListUnsupportedAppVersionResourcesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist - // than the specified MaxResults value, a token is included in the response so that - // the remaining results can be retrieved. + // than the specified MaxResults value, a token is included in the response so + // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resiliencehub/api_op_PublishAppVersion.go b/service/resiliencehub/api_op_PublishAppVersion.go index 650885c19b1..302928939cd 100644 --- a/service/resiliencehub/api_op_PublishAppVersion.go +++ b/service/resiliencehub/api_op_PublishAppVersion.go @@ -28,11 +28,10 @@ func (c *Client) PublishAppVersion(ctx context.Context, params *PublishAppVersio type PublishAppVersionInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -42,11 +41,10 @@ type PublishAppVersionInput struct { type PublishAppVersionOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go b/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go index b2c586e246f..264327beb2f 100644 --- a/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go +++ b/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go @@ -29,11 +29,10 @@ func (c *Client) PutDraftAppVersionTemplate(ctx context.Context, params *PutDraf type PutDraftAppVersionTemplateInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -42,122 +41,74 @@ type PutDraftAppVersionTemplateInput struct { // learn more about the appTemplateBody template, see the sample template provided // in the Examples section. The appTemplateBody JSON string has the following // structure: - // - // * resources The list of logical resources that must be included in - // the Resilience Hub application. Type: Array Don't add the resources that you - // want to exclude. Each resources array item includes the following fields: - // - // * - // logicalResourceId The logical identifier of the resource. Type: Object Each - // logicalResourceId object includes the following fields: - // - // * identifier The - // identifier of the resource. Type: String - // - // * logicalStackName The name of the - // CloudFormation stack this resource belongs to. Type: String - // - // * resourceGroupName - // The name of the resource group this resource belongs to. Type: String - // - // * - // terraformSourceName The name of the Terraform S3 state file this resource - // belongs to. Type: String - // - // * eksSourceName The name of the Amazon Elastic - // Kubernetes Service cluster and namespace this resource belongs to. This - // parameter accepts values in "eks-cluster/namespace" format. Type: String - // - // * type - // The type of resource. Type: string - // - // * name The name of the resource. Type: - // String - // - // * additionalInfo Additional configuration parameters for an Resilience - // Hub application. If you want to implement additionalInfo through the Resilience - // Hub console rather than using an API call, see Configure the application - // configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" - // - // * - // appComponents The list of Application Components that this resource belongs to. - // If an Application Component is not part of the Resilience Hub application, it - // will be added. Type: Array Each appComponents array item includes the following - // fields: - // - // * name The name of the Application Component. Type: String - // - // * type The - // type of Application Component. For more information about the types of - // Application Component, see Grouping resources in an AppComponent - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html). - // Type: String - // - // * resourceNames The list of included resources that are assigned - // to the Application Component. Type: Array of strings - // - // * additionalInfo - // Additional configuration parameters for an Resilience Hub application. If you - // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" - // - // * - // excludedResources The list of logical resource identifiers to be excluded from - // the application. Type: Array Don't add the resources that you want to include. - // Each excludedResources array item includes the following fields: - // - // * - // logicalResourceIds The logical identifier of the resource. Type: Object You can - // configure only one of the following fields: - // - // * logicalStackName - // - // * - // resourceGroupName - // - // * terraformSourceName - // - // * eksSourceName - // - // Each - // logicalResourceIds object includes the following fields: - // - // * identifier The - // identifier of the resource. Type: String - // - // * logicalStackName The name of the - // CloudFormation stack this resource belongs to. Type: String - // - // * resourceGroupName - // The name of the resource group this resource belongs to. Type: String - // - // * - // terraformSourceName The name of the Terraform S3 state file this resource - // belongs to. Type: String - // - // * eksSourceName The name of the Amazon Elastic - // Kubernetes Service cluster and namespace this resource belongs to. This - // parameter accepts values in "eks-cluster/namespace" format. Type: String - // - // * - // version The Resilience Hub application version. - // - // * additionalInfo Additional - // configuration parameters for an Resilience Hub application. If you want to - // implement additionalInfo through the Resilience Hub console rather than using an - // API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of - // only one failover region and one associated account. Key: "failover-regions" - // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - resources The list of logical resources that must be included in the + // Resilience Hub application. Type: Array Don't add the resources that you want to + // exclude. Each resources array item includes the following fields: + // - logicalResourceId The logical identifier of the resource. Type: Object Each + // logicalResourceId object includes the following fields: + // - identifier The identifier of the resource. Type: String + // - logicalStackName The name of the CloudFormation stack this resource belongs + // to. Type: String + // - resourceGroupName The name of the resource group this resource belongs to. + // Type: String + // - terraformSourceName The name of the Terraform S3 state file this resource + // belongs to. Type: String + // - eksSourceName The name of the Amazon Elastic Kubernetes Service cluster and + // namespace this resource belongs to. This parameter accepts values in + // "eks-cluster/namespace" format. Type: String + // - type The type of resource. Type: string + // - name The name of the resource. Type: String + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - appComponents The list of Application Components that this resource belongs + // to. If an Application Component is not part of the Resilience Hub application, + // it will be added. Type: Array Each appComponents array item includes the + // following fields: + // - name The name of the Application Component. Type: String + // - type The type of Application Component. For more information about the types + // of Application Component, see Grouping resources in an AppComponent (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html) + // . Type: String + // - resourceNames The list of included resources that are assigned to the + // Application Component. Type: Array of strings + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" + // - excludedResources The list of logical resource identifiers to be excluded + // from the application. Type: Array Don't add the resources that you want to + // include. Each excludedResources array item includes the following fields: + // - logicalResourceIds The logical identifier of the resource. Type: Object You + // can configure only one of the following fields: + // - logicalStackName + // - resourceGroupName + // - terraformSourceName + // - eksSourceName Each logicalResourceIds object includes the following fields: + // - identifier The identifier of the resource. Type: String + // - logicalStackName The name of the CloudFormation stack this resource belongs + // to. Type: String + // - resourceGroupName The name of the resource group this resource belongs to. + // Type: String + // - terraformSourceName The name of the Terraform S3 state file this resource + // belongs to. Type: String + // - eksSourceName The name of the Amazon Elastic Kubernetes Service cluster and + // namespace this resource belongs to. This parameter accepts values in + // "eks-cluster/namespace" format. Type: String + // - version The Resilience Hub application version. + // - additionalInfo Additional configuration parameters for an Resilience Hub + // application. If you want to implement additionalInfo through the Resilience + // Hub console rather than using an API call, see Configure the application + // configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of + // only one failover region and one associated account. Key: "failover-regions" + // Value: "[{"region":"", "accounts":[{"id":""}]}]" // // This member is required. AppTemplateBody *string @@ -167,11 +118,10 @@ type PutDraftAppVersionTemplateInput struct { type PutDraftAppVersionTemplateOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The version of the application. diff --git a/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go b/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go index 413a78101cb..4a91753ca87 100644 --- a/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go @@ -28,11 +28,10 @@ func (c *Client) RemoveDraftAppVersionResourceMappings(ctx context.Context, para type RemoveDraftAppVersionResourceMappingsInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -65,11 +64,10 @@ type RemoveDraftAppVersionResourceMappingsInput struct { type RemoveDraftAppVersionResourceMappingsOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The version of the application. diff --git a/service/resiliencehub/api_op_ResolveAppVersionResources.go b/service/resiliencehub/api_op_ResolveAppVersionResources.go index e6132cef400..108bf9d9de9 100644 --- a/service/resiliencehub/api_op_ResolveAppVersionResources.go +++ b/service/resiliencehub/api_op_ResolveAppVersionResources.go @@ -29,11 +29,10 @@ func (c *Client) ResolveAppVersionResources(ctx context.Context, params *Resolve type ResolveAppVersionResourcesInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -48,11 +47,10 @@ type ResolveAppVersionResourcesInput struct { type ResolveAppVersionResourcesOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_StartAppAssessment.go b/service/resiliencehub/api_op_StartAppAssessment.go index 33b658cd168..69b3ad0cdf7 100644 --- a/service/resiliencehub/api_op_StartAppAssessment.go +++ b/service/resiliencehub/api_op_StartAppAssessment.go @@ -30,11 +30,10 @@ func (c *Client) StartAppAssessment(ctx context.Context, params *StartAppAssessm type StartAppAssessmentInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -49,13 +48,13 @@ type StartAppAssessmentInput struct { // This member is required. AssessmentName *string - // Used for an idempotency token. A client token is a unique, case-sensitive string - // of up to 64 ASCII characters. You should not reuse the same client token for - // other API requests. + // Used for an idempotency token. A client token is a unique, case-sensitive + // string of up to 64 ASCII characters. You should not reuse the same client token + // for other API requests. ClientToken *string - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_UpdateApp.go b/service/resiliencehub/api_op_UpdateApp.go index 3ced151afd4..16f58f27ca1 100644 --- a/service/resiliencehub/api_op_UpdateApp.go +++ b/service/resiliencehub/api_op_UpdateApp.go @@ -29,11 +29,10 @@ func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns . type UpdateAppInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -47,11 +46,10 @@ type UpdateAppInput struct { // The optional description for an app. Description *string - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. PolicyArn *string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_UpdateAppVersion.go b/service/resiliencehub/api_op_UpdateAppVersion.go index a96690f6b39..7384c6fd3b2 100644 --- a/service/resiliencehub/api_op_UpdateAppVersion.go +++ b/service/resiliencehub/api_op_UpdateAppVersion.go @@ -31,20 +31,18 @@ func (c *Client) UpdateAppVersion(ctx context.Context, params *UpdateAppVersionI type UpdateAppVersionInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of + // using an API call, see Configure the application configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. Key: "failover-regions" // Value: "[{"region":"", "accounts":[{"id":""}]}]" AdditionalInfo map[string][]string @@ -54,11 +52,10 @@ type UpdateAppVersionInput struct { type UpdateAppVersionOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -70,9 +67,8 @@ type UpdateAppVersionOutput struct { // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter supports only failover region and account. + // using an API call, see Configure the application configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter supports only failover region and account. AdditionalInfo map[string][]string // Metadata pertaining to the operation's result. diff --git a/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go b/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go index 12ff13a01a9..3cc3b302b6a 100644 --- a/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go @@ -32,11 +32,10 @@ func (c *Client) UpdateAppVersionAppComponent(ctx context.Context, params *Updat type UpdateAppVersionAppComponentInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -54,8 +53,8 @@ type UpdateAppVersionAppComponentInput struct { Name *string // The type of Application Component. For more information about the types of - // Application Component, see Grouping resources in an AppComponent - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html). + // Application Component, see Grouping resources in an AppComponent (https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html) + // . Type *string noSmithyDocumentSerde @@ -63,11 +62,10 @@ type UpdateAppVersionAppComponentInput struct { type UpdateAppVersionAppComponentOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_UpdateAppVersionResource.go b/service/resiliencehub/api_op_UpdateAppVersionResource.go index ecf72ed7cf1..1de2d169831 100644 --- a/service/resiliencehub/api_op_UpdateAppVersionResource.go +++ b/service/resiliencehub/api_op_UpdateAppVersionResource.go @@ -12,17 +12,12 @@ import ( ) // Updates the resource details in the Resilience Hub application. -// -// * This action -// has no effect outside Resilience Hub. -// -// * This API updates the Resilience Hub -// application draft version. To use this resource for running resiliency -// assessments, you must publish the Resilience Hub application using the -// PublishAppVersion API. -// -// * To update application version with new -// physicalResourceID, you must call ResolveAppVersionResources API. +// - This action has no effect outside Resilience Hub. +// - This API updates the Resilience Hub application draft version. To use this +// resource for running resiliency assessments, you must publish the Resilience Hub +// application using the PublishAppVersion API. +// - To update application version with new physicalResourceID , you must call +// ResolveAppVersionResources API. func (c *Client) UpdateAppVersionResource(ctx context.Context, params *UpdateAppVersionResourceInput, optFns ...func(*Options)) (*UpdateAppVersionResourceOutput, error) { if params == nil { params = &UpdateAppVersionResourceInput{} @@ -40,11 +35,10 @@ func (c *Client) UpdateAppVersionResource(ctx context.Context, params *UpdateApp type UpdateAppVersionResourceInput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -84,11 +78,10 @@ type UpdateAppVersionResourceInput struct { type UpdateAppVersionResourceOutput struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_UpdateResiliencyPolicy.go b/service/resiliencehub/api_op_UpdateResiliencyPolicy.go index 2390c90f735..a5d851186e7 100644 --- a/service/resiliencehub/api_op_UpdateResiliencyPolicy.go +++ b/service/resiliencehub/api_op_UpdateResiliencyPolicy.go @@ -29,11 +29,10 @@ func (c *Client) UpdateResiliencyPolicy(ctx context.Context, params *UpdateResil type UpdateResiliencyPolicyInput struct { - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. PolicyArn *string @@ -52,8 +51,8 @@ type UpdateResiliencyPolicyInput struct { // The name of the policy PolicyName *string - // The tier for this resiliency policy, ranging from the highest severity - // (MissionCritical) to lowest (NonCritical). + // The tier for this resiliency policy, ranging from the highest severity ( + // MissionCritical ) to lowest ( NonCritical ). Tier types.ResiliencyPolicyTier noSmithyDocumentSerde diff --git a/service/resiliencehub/types/enums.go b/service/resiliencehub/types/enums.go index a17e16a999a..959ad1bd8ad 100644 --- a/service/resiliencehub/types/enums.go +++ b/service/resiliencehub/types/enums.go @@ -13,9 +13,9 @@ const ( AlarmTypeEvent AlarmType = "Event" ) -// Values returns all known values for AlarmType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AlarmType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AlarmType) Values() []AlarmType { return []AlarmType{ "Metric", @@ -328,9 +328,10 @@ const ( RecommendationTemplateStatusSuccess RecommendationTemplateStatus = "Success" ) -// Values returns all known values for RecommendationTemplateStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecommendationTemplateStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RecommendationTemplateStatus) Values() []RecommendationTemplateStatus { return []RecommendationTemplateStatus{ "Pending", @@ -349,9 +350,9 @@ const ( RenderRecommendationTypeTest RenderRecommendationType = "Test" ) -// Values returns all known values for RenderRecommendationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RenderRecommendationType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RenderRecommendationType) Values() []RenderRecommendationType { return []RenderRecommendationType{ "Alarm", @@ -394,9 +395,9 @@ const ( ResourceImportStatusTypeSuccess ResourceImportStatusType = "Success" ) -// Values returns all known values for ResourceImportStatusType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceImportStatusType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceImportStatusType) Values() []ResourceImportStatusType { return []ResourceImportStatusType{ "Pending", @@ -460,9 +461,10 @@ const ( ResourceResolutionStatusTypeSuccess ResourceResolutionStatusType = "Success" ) -// Values returns all known values for ResourceResolutionStatusType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceResolutionStatusType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ResourceResolutionStatusType) Values() []ResourceResolutionStatusType { return []ResourceResolutionStatusType{ "Pending", diff --git a/service/resiliencehub/types/errors.go b/service/resiliencehub/types/errors.go index 0fbb1ee73f7..cae4b9e2ca6 100644 --- a/service/resiliencehub/types/errors.go +++ b/service/resiliencehub/types/errors.go @@ -151,8 +151,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception occurs when you have exceeded the limit on the number of requests -// per second. +// This exception occurs when you have exceeded the limit on the number of +// requests per second. type ThrottlingException struct { Message *string diff --git a/service/resiliencehub/types/types.go b/service/resiliencehub/types/types.go index 6b5fea2ff68..fcfca234368 100644 --- a/service/resiliencehub/types/types.go +++ b/service/resiliencehub/types/types.go @@ -48,11 +48,10 @@ type AlarmRecommendation struct { // Defines an Resilience Hub application. type App struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -82,11 +81,10 @@ type App struct { // The timestamp for the most recent resiliency score evaluation. LastResiliencyScoreEvaluationTime *time.Time - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. PolicyArn *string // The current resiliency score for the application. @@ -95,8 +93,8 @@ type App struct { // The status of the application. Status AppStatusType - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde @@ -106,10 +104,9 @@ type App struct { type AppAssessment struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string @@ -124,11 +121,10 @@ type AppAssessment struct { // This member is required. Invoker AssessmentInvoker - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The version of the application. @@ -165,8 +161,8 @@ type AppAssessment struct { // The starting time for the action. StartTime *time.Time - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string noSmithyDocumentSerde @@ -176,10 +172,9 @@ type AppAssessment struct { type AppAssessmentSummary struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string @@ -189,11 +184,10 @@ type AppAssessmentSummary struct { // This member is required. AssessmentStatus AssessmentStatus - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The version of the application. @@ -241,9 +235,8 @@ type AppComponent struct { // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of + // using an API call, see Configure the application configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. Key: "failover-regions" // Value: "[{"region":"", "accounts":[{"id":""}]}]" AdditionalInfo map[string][]string @@ -294,9 +287,8 @@ type AppInputSource struct { ResourceCount int32 // The Amazon Resource Name (ARN) of the input source. For more information about - // ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. SourceArn *string // The name of the input source. @@ -311,11 +303,10 @@ type AppInputSource struct { // Defines an application summary. type AppSummary struct { - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AppArn *string @@ -359,9 +350,9 @@ type AppVersionSummary struct { noSmithyDocumentSerde } -// Defines recommendations for an Resilience Hub Application Component, returned as -// an object. This object contains component names, configuration recommendations, -// and recommendation statuses. +// Defines recommendations for an Resilience Hub Application Component, returned +// as an object. This object contains component names, configuration +// recommendations, and recommendation statuses. type ComponentRecommendation struct { // The name of the Application Component. @@ -434,7 +425,7 @@ type Cost struct { // This member is required. Amount float64 - // The cost currency, for example USD. + // The cost currency, for example USD . // // This member is required. Currency *string @@ -488,11 +479,11 @@ type DisruptionCompliance struct { // The input source of the Amazon Elastic Kubernetes Service cluster. type EksSource struct { - // The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. - // The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service + // cluster. The format for this ARN is: arn: aws :eks: region : account-id :cluster/ + // cluster-name . For more information about ARNs, see Amazon Resource Names + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. EksClusterArn *string @@ -510,11 +501,11 @@ type EksSource struct { // Kubernetes Service cluster. type EksSourceClusterNamespace struct { - // The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. - // The format for this ARN is: arn:aws:eks:region:account-id:cluster/cluster-name. - // For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service + // cluster. The format for this ARN is: arn: aws :eks: region : account-id :cluster/ + // cluster-name . For more information about ARNs, see Amazon Resource Names + // (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. EksClusterArn *string @@ -591,9 +582,8 @@ type PhysicalResource struct { // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than - // using an API call, see Configure the application configuration parameters - // (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html). - // Currently, this parameter accepts a key-value mapping (in a string format) of + // using an API call, see Configure the application configuration parameters (https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html) + // . Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. Key: "failover-regions" // Value: "[{"region":"", "accounts":[{"id":""}]}]" AdditionalInfo map[string][]string @@ -683,10 +673,9 @@ type RecommendationItem struct { type RecommendationTemplate struct { // The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: - // arn:partition:resiliencehub:region:account:app-assessment/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // arn: partition :resiliencehub: region : account :app-assessment/ app-id . For + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. // // This member is required. AssessmentArn *string @@ -719,11 +708,10 @@ type RecommendationTemplate struct { // This member is required. Status RecommendationTemplateStatus - // The Amazon Resource Name (ARN) of the Resilience Hub application. The format for - // this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the Resilience Hub application. The format + // for this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. AppArn *string // The end time for the action. @@ -741,8 +729,8 @@ type RecommendationTemplate struct { // The start time for the action. StartTime *time.Time - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // The file location of the template. @@ -767,11 +755,10 @@ type ResiliencyPolicy struct { // The resiliency policy. Policy map[string]FailurePolicy - // The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN - // is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the AWS General Reference guide. + // The Amazon Resource Name (ARN) of the resiliency policy. The format for this + // ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ + // policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the AWS General Reference guide. PolicyArn *string // The description for the policy. @@ -780,19 +767,19 @@ type ResiliencyPolicy struct { // The name of the policy PolicyName *string - // The tags assigned to the resource. A tag is a label that you assign to an Amazon - // Web Services resource. Each tag consists of a key/value pair. + // The tags assigned to the resource. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key/value pair. Tags map[string]string - // The tier for this resiliency policy, ranging from the highest severity - // (MissionCritical) to lowest (NonCritical). + // The tier for this resiliency policy, ranging from the highest severity ( + // MissionCritical ) to lowest ( NonCritical ). Tier ResiliencyPolicyTier noSmithyDocumentSerde } -// The overall resiliency score, returned as an object that includes the disruption -// score and outage score. +// The overall resiliency score, returned as an object that includes the +// disruption score and outage score. type ResiliencyScore struct { // The disruption score for a valid key. @@ -838,8 +825,8 @@ type ResourceErrorsDetails struct { // Defines a resource mapping. type ResourceMapping struct { - // Specifies the type of resource mapping. AppRegistryApp The resource is mapped to - // another application. The name of the application is contained in the + // Specifies the type of resource mapping. AppRegistryApp The resource is mapped + // to another application. The name of the application is contained in the // appRegistryAppName property. CfnStack The resource is mapped to a CloudFormation // stack. The name of the CloudFormation stack is contained in the logicalStackName // property. Resource The resource is mapped to another resource. The name of the diff --git a/service/resourceexplorer2/api_client.go b/service/resourceexplorer2/api_client.go index e818d650f6c..3af132a76e0 100644 --- a/service/resourceexplorer2/api_client.go +++ b/service/resourceexplorer2/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/resourceexplorer2/api_op_AssociateDefaultView.go b/service/resourceexplorer2/api_op_AssociateDefaultView.go index 758323a7220..b73bed5f91d 100644 --- a/service/resourceexplorer2/api_op_AssociateDefaultView.go +++ b/service/resourceexplorer2/api_op_AssociateDefaultView.go @@ -34,10 +34,9 @@ func (c *Client) AssociateDefaultView(ctx context.Context, params *AssociateDefa type AssociateDefaultViewInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view to set as the default for the Amazon Web Services Region and Amazon Web - // Services account in which you call this operation. The specified view must + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view to set as the default for the Amazon Web Services Region and Amazon + // Web Services account in which you call this operation. The specified view must // already exist in the called Region. // // This member is required. @@ -48,9 +47,8 @@ type AssociateDefaultViewInput struct { type AssociateDefaultViewOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that the operation set as the default for queries made in the Amazon + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that the operation set as the default for queries made in the Amazon // Web Services Region and Amazon Web Services account in which you called this // operation. ViewArn *string diff --git a/service/resourceexplorer2/api_op_BatchGetView.go b/service/resourceexplorer2/api_op_BatchGetView.go index 07847e5277a..c2bbcf6acb0 100644 --- a/service/resourceexplorer2/api_op_BatchGetView.go +++ b/service/resourceexplorer2/api_op_BatchGetView.go @@ -29,8 +29,7 @@ func (c *Client) BatchGetView(ctx context.Context, params *BatchGetViewInput, op type BatchGetViewInput struct { - // A list of Amazon resource names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // A list of Amazon resource names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // that identify the views you want details for. ViewArns []string diff --git a/service/resourceexplorer2/api_op_CreateIndex.go b/service/resourceexplorer2/api_op_CreateIndex.go index 15eaaabf2cd..59c206a233d 100644 --- a/service/resourceexplorer2/api_op_CreateIndex.go +++ b/service/resourceexplorer2/api_op_CreateIndex.go @@ -13,46 +13,39 @@ import ( "time" ) -// Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region -// in which you called this operation by creating an index. Resource Explorer -// begins discovering the resources in this Region and stores the details about the -// resources in the index so that they can be queried by using the Search +// Turns on Amazon Web Services Resource Explorer in the Amazon Web Services +// Region in which you called this operation by creating an index. Resource +// Explorer begins discovering the resources in this Region and stores the details +// about the resources in the index so that they can be queried by using the Search // operation. You can create only one index in a Region. This operation creates // only a local index. To promote the local index in one Amazon Web Services Region // into the aggregator index for the Amazon Web Services account, use the // UpdateIndexType operation. For more information, see Turning on cross-Region -// search by creating an aggregator index -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) +// search by creating an aggregator index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) // in the Amazon Web Services Resource Explorer User Guide. For more details about // what happens when you turn on Resource Explorer in an Amazon Web Services // Region, see Turn on Resource Explorer to index your resources in an Amazon Web -// Services Region -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html) +// Services Region (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html) // in the Amazon Web Services Resource Explorer User Guide. If this is the first // Amazon Web Services Region in which you've created an index for Resource -// Explorer, then this operation also creates a service-linked role -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html) +// Explorer, then this operation also creates a service-linked role (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html) // in your Amazon Web Services account that allows Resource Explorer to enumerate // your resources to populate the index. -// -// * Action: resource-explorer-2:CreateIndex -// Resource: The ARN of the index (as it will exist after the operation completes) -// in the Amazon Web Services Region and account in which you're trying to create -// the index. Use the wildcard character (*) at the end of the string to match the -// eventual UUID. For example, the following Resource element restricts the role or -// user to creating an index in only the us-east-2 Region of the specified account. -// "Resource": "arn:aws:resource-explorer-2:us-west-2::index/*" -// Alternatively, you can use "Resource": "*" to allow the role or user to create -// an index in any Region. -// -// * Action: iam:CreateServiceLinkedRole Resource: No -// specific resource (*). This permission is required only the first time you -// create an index to turn on Resource Explorer in the account. Resource Explorer -// uses this to create the service-linked role needed to index the resources in -// your account -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html). -// Resource Explorer uses the same service-linked role for all additional indexes -// you create afterwards. +// - Action: resource-explorer-2:CreateIndex Resource: The ARN of the index (as +// it will exist after the operation completes) in the Amazon Web Services Region +// and account in which you're trying to create the index. Use the wildcard +// character ( * ) at the end of the string to match the eventual UUID. For +// example, the following Resource element restricts the role or user to creating +// an index in only the us-east-2 Region of the specified account. "Resource": +// "arn:aws:resource-explorer-2:us-west-2::index/*" Alternatively, +// you can use "Resource": "*" to allow the role or user to create an index in +// any Region. +// - Action: iam:CreateServiceLinkedRole Resource: No specific resource (*). This +// permission is required only the first time you create an index to turn on +// Resource Explorer in the account. Resource Explorer uses this to create the +// service-linked role needed to index the resources in your account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html) +// . Resource Explorer uses the same service-linked role for all additional indexes +// you create afterwards. func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { params = &CreateIndexInput{} @@ -72,9 +65,8 @@ type CreateIndexInput struct { // This value helps ensure idempotency. Resource Explorer uses this value to // prevent the accidental creation of duplicate versions. We recommend that you - // generate a UUID-type value - // (https://wikipedia.org/wiki/Universally_unique_identifier) to ensure the - // uniqueness of your views. + // generate a UUID-type value (https://wikipedia.org/wiki/Universally_unique_identifier) + // to ensure the uniqueness of your views. ClientToken *string // The specified tags are attached only to the index created in this Amazon Web @@ -87,18 +79,18 @@ type CreateIndexInput struct { type CreateIndexOutput struct { - // The ARN of the new local index for the Region. You can reference this ARN in IAM - // permission policies to authorize the following operations: DeleteIndex | + // The ARN of the new local index for the Region. You can reference this ARN in + // IAM permission policies to authorize the following operations: DeleteIndex | // GetIndex | UpdateIndexType | CreateView Arn *string // The date and timestamp when the index was created. CreatedAt *time.Time - // Indicates the current state of the index. You can check for changes to the state - // for asynchronous operations by calling the GetIndex operation. The state can - // remain in the CREATING or UPDATING state for several hours as Resource Explorer - // discovers the information about your resources and populates the index. + // Indicates the current state of the index. You can check for changes to the + // state for asynchronous operations by calling the GetIndex operation. The state + // can remain in the CREATING or UPDATING state for several hours as Resource + // Explorer discovers the information about your resources and populates the index. State types.IndexState // Metadata pertaining to the operation's result. diff --git a/service/resourceexplorer2/api_op_CreateView.go b/service/resourceexplorer2/api_op_CreateView.go index 23ab08b63e7..9b1963e1cd3 100644 --- a/service/resourceexplorer2/api_op_CreateView.go +++ b/service/resourceexplorer2/api_op_CreateView.go @@ -14,14 +14,12 @@ import ( // Creates a view that users can query by using the Search operation. Results from // queries that you make using this view include only resources that match the -// view's Filters. For more information about Amazon Web Services Resource Explorer -// views, see Managing views -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html) +// view's Filters . For more information about Amazon Web Services Resource +// Explorer views, see Managing views (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html) // in the Amazon Web Services Resource Explorer User Guide. Only the principals // with an IAM identity-based policy that grants Allow to the Search action on a -// Resource with the Amazon resource name (ARN) -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of -// this view can Search using views you create with this operation. +// Resource with the Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// of this view can Search using views you create with this operation. func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns ...func(*Options)) (*CreateViewOutput, error) { if params == nil { params = &CreateViewInput{} @@ -49,26 +47,22 @@ type CreateViewInput struct { // This value helps ensure idempotency. Resource Explorer uses this value to // prevent the accidental creation of duplicate versions. We recommend that you - // generate a UUID-type value - // (https://wikipedia.org/wiki/Universally_unique_identifier) to ensure the - // uniqueness of your views. + // generate a UUID-type value (https://wikipedia.org/wiki/Universally_unique_identifier) + // to ensure the uniqueness of your views. ClientToken *string // An array of strings that specify which resources are included in the results of // queries made using this view. When you use this view in a Search operation, the // filter string is combined with the search's QueryString parameter using a // logical AND operator. For information about the supported syntax, see Search - // query reference for Resource Explorer - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) + // query reference for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) // in the Amazon Web Services Resource Explorer User Guide. This query string in - // the context of this operation supports only filter prefixes - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) - // with optional operators - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators). - // It doesn't support free-form text. For example, the string region:us* + // the context of this operation supports only filter prefixes (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) + // with optional operators (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) + // . It doesn't support free-form text. For example, the string region:us* // service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web // Services Region that begins with the letters us and is not tagged with a key - // Stage that has the value prod. + // Stage that has the value prod . Filters *types.SearchFilter // Specifies optional fields that you want included in search results from this diff --git a/service/resourceexplorer2/api_op_DeleteIndex.go b/service/resourceexplorer2/api_op_DeleteIndex.go index cee6220792c..fbd57e0da05 100644 --- a/service/resourceexplorer2/api_op_DeleteIndex.go +++ b/service/resourceexplorer2/api_op_DeleteIndex.go @@ -17,11 +17,12 @@ import ( // Explorer stops discovering and indexing resources in that Region. Resource // Explorer also deletes all views in that Region. These actions occur as // asynchronous background tasks. You can check to see when the actions are -// complete by using the GetIndex operation and checking the Status response value. -// If the index you delete is the aggregator index for the Amazon Web Services -// account, you must wait 24 hours before you can promote another local index to be -// the aggregator index for the account. Users can't perform account-wide searches -// using Resource Explorer until another aggregator index is configured. +// complete by using the GetIndex operation and checking the Status response +// value. If the index you delete is the aggregator index for the Amazon Web +// Services account, you must wait 24 hours before you can promote another local +// index to be the aggregator index for the account. Users can't perform +// account-wide searches using Resource Explorer until another aggregator index is +// configured. func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optFns ...func(*Options)) (*DeleteIndexOutput, error) { if params == nil { params = &DeleteIndexInput{} @@ -39,9 +40,8 @@ func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optF type DeleteIndexInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index that you want to delete. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index that you want to delete. // // This member is required. Arn *string @@ -51,10 +51,9 @@ type DeleteIndexInput struct { type DeleteIndexOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index that you successfully started the deletion process. This operation is - // asynchronous. To check its status, call the GetIndex operation. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index that you successfully started the deletion process. This operation + // is asynchronous. To check its status, call the GetIndex operation. Arn *string // The date and time when you last updated this index. diff --git a/service/resourceexplorer2/api_op_DeleteView.go b/service/resourceexplorer2/api_op_DeleteView.go index fc2f8267560..6fd529a039e 100644 --- a/service/resourceexplorer2/api_op_DeleteView.go +++ b/service/resourceexplorer2/api_op_DeleteView.go @@ -31,9 +31,8 @@ func (c *Client) DeleteView(ctx context.Context, params *DeleteViewInput, optFns type DeleteViewInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that you want to delete. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that you want to delete. // // This member is required. ViewArn *string @@ -43,9 +42,8 @@ type DeleteViewInput struct { type DeleteViewOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that you successfully deleted. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that you successfully deleted. ViewArn *string // Metadata pertaining to the operation's result. diff --git a/service/resourceexplorer2/api_op_DisassociateDefaultView.go b/service/resourceexplorer2/api_op_DisassociateDefaultView.go index bc1f79accff..33109328ffc 100644 --- a/service/resourceexplorer2/api_op_DisassociateDefaultView.go +++ b/service/resourceexplorer2/api_op_DisassociateDefaultView.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// After you call this operation, the affected Amazon Web Services Region no longer -// has a default view. All Search operations in that Region must explicitly specify -// a view or the operation fails. You can configure a new default by calling the -// AssociateDefaultView operation. If an Amazon Web Services Region doesn't have a -// default view configured, then users must explicitly specify a view with every -// Search operation performed in that Region. +// After you call this operation, the affected Amazon Web Services Region no +// longer has a default view. All Search operations in that Region must explicitly +// specify a view or the operation fails. You can configure a new default by +// calling the AssociateDefaultView operation. If an Amazon Web Services Region +// doesn't have a default view configured, then users must explicitly specify a +// view with every Search operation performed in that Region. func (c *Client) DisassociateDefaultView(ctx context.Context, params *DisassociateDefaultViewInput, optFns ...func(*Options)) (*DisassociateDefaultViewOutput, error) { if params == nil { params = &DisassociateDefaultViewInput{} diff --git a/service/resourceexplorer2/api_op_GetDefaultView.go b/service/resourceexplorer2/api_op_GetDefaultView.go index c5b212b40b6..972f69bec01 100644 --- a/service/resourceexplorer2/api_op_GetDefaultView.go +++ b/service/resourceexplorer2/api_op_GetDefaultView.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the Amazon Resource Name (ARN) of the view that is the default for the -// Amazon Web Services Region in which you call this operation. You can then call -// GetView to retrieve the details of that view. +// Retrieves the Amazon Resource Name (ARN) of the view that is the default for +// the Amazon Web Services Region in which you call this operation. You can then +// call GetView to retrieve the details of that view. func (c *Client) GetDefaultView(ctx context.Context, params *GetDefaultViewInput, optFns ...func(*Options)) (*GetDefaultViewOutput, error) { if params == nil { params = &GetDefaultViewInput{} @@ -34,10 +34,9 @@ type GetDefaultViewInput struct { type GetDefaultViewOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that is the current default for the Amazon Web Services Region in which - // you called this operation. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that is the current default for the Amazon Web Services Region in + // which you called this operation. ViewArn *string // Metadata pertaining to the operation's result. diff --git a/service/resourceexplorer2/api_op_GetIndex.go b/service/resourceexplorer2/api_op_GetIndex.go index be0c2e158e8..633b3a6c3c8 100644 --- a/service/resourceexplorer2/api_op_GetIndex.go +++ b/service/resourceexplorer2/api_op_GetIndex.go @@ -35,9 +35,8 @@ type GetIndexInput struct { type GetIndexOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index. Arn *string // The date and time when the index was originally created. @@ -46,12 +45,12 @@ type GetIndexOutput struct { // The date and time when the index was last updated. LastUpdatedAt *time.Time - // This response value is present only if this index is Type=AGGREGATOR. A list of + // This response value is present only if this index is Type=AGGREGATOR . A list of // the Amazon Web Services Regions that replicate their content to the index in // this Region. ReplicatingFrom []string - // This response value is present only if this index is Type=LOCAL. The Amazon Web + // This response value is present only if this index is Type=LOCAL . The Amazon Web // Services Region that contains the aggregator index, if one exists. If an // aggregator index does exist then the Region in which you called this operation // replicates its index information to the Region specified in this response value. @@ -63,10 +62,10 @@ type GetIndexOutput struct { // Tag key and value pairs that are attached to the index. Tags map[string]string - // The type of the index in this Region. For information about the aggregator index - // and how it differs from a local index, see Turning on cross-Region search by - // creating an aggregator index - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html). + // The type of the index in this Region. For information about the aggregator + // index and how it differs from a local index, see Turning on cross-Region search + // by creating an aggregator index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) + // . Type types.IndexType // Metadata pertaining to the operation's result. diff --git a/service/resourceexplorer2/api_op_GetView.go b/service/resourceexplorer2/api_op_GetView.go index e1f93389422..59247b45e00 100644 --- a/service/resourceexplorer2/api_op_GetView.go +++ b/service/resourceexplorer2/api_op_GetView.go @@ -29,9 +29,8 @@ func (c *Client) GetView(ctx context.Context, params *GetViewInput, optFns ...fu type GetViewInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that you want information about. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that you want information about. // // This member is required. ViewArn *string diff --git a/service/resourceexplorer2/api_op_ListIndexes.go b/service/resourceexplorer2/api_op_ListIndexes.go index e84f252e392..f78349f7b2f 100644 --- a/service/resourceexplorer2/api_op_ListIndexes.go +++ b/service/resourceexplorer2/api_op_ListIndexes.go @@ -36,9 +36,9 @@ type ListIndexesInput struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 @@ -54,7 +54,7 @@ type ListIndexesInput struct { Regions []string // If specified, limits the output to only indexes of the specified Type, either - // LOCAL or AGGREGATOR. Use this option to discover the aggregator index for your + // LOCAL or AGGREGATOR . Use this option to discover the aggregator index for your // account. Type types.IndexType @@ -69,7 +69,7 @@ type ListIndexesOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -151,9 +151,9 @@ type ListIndexesPaginatorOptions struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 diff --git a/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go b/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go index d208b4c7d76..574d0b25dac 100644 --- a/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go +++ b/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go @@ -35,9 +35,9 @@ type ListSupportedResourceTypesInput struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 @@ -56,7 +56,7 @@ type ListSupportedResourceTypesOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // The list of resource types supported by Resource Explorer. @@ -143,9 +143,9 @@ type ListSupportedResourceTypesPaginatorOptions struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 diff --git a/service/resourceexplorer2/api_op_ListTagsForResource.go b/service/resourceexplorer2/api_op_ListTagsForResource.go index 45e5624e6f9..da0f179a79d 100644 --- a/service/resourceexplorer2/api_op_ListTagsForResource.go +++ b/service/resourceexplorer2/api_op_ListTagsForResource.go @@ -28,9 +28,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view or index that you want to attach tags to. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view or index that you want to attach tags to. // // This member is required. ResourceArn *string diff --git a/service/resourceexplorer2/api_op_ListViews.go b/service/resourceexplorer2/api_op_ListViews.go index 39331d316ec..3ab60fcbf33 100644 --- a/service/resourceexplorer2/api_op_ListViews.go +++ b/service/resourceexplorer2/api_op_ListViews.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Amazon resource names (ARNs) -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of -// the views available in the Amazon Web Services Region in which you call this +// Lists the Amazon resource names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// of the views available in the Amazon Web Services Region in which you call this // operation. Always check the NextToken response parameter for a null value when // calling a paginated operation. These operations can occasionally return an empty // set of results even when there are more results available. The NextToken @@ -39,9 +38,9 @@ type ListViewsInput struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 @@ -60,7 +59,7 @@ type ListViewsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // The list of views available in the Amazon Web Services Region in which you @@ -146,9 +145,9 @@ type ListViewsPaginatorOptions struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 diff --git a/service/resourceexplorer2/api_op_Search.go b/service/resourceexplorer2/api_op_Search.go index 4c1b5f68869..f7bbefd53e1 100644 --- a/service/resourceexplorer2/api_op_Search.go +++ b/service/resourceexplorer2/api_op_Search.go @@ -17,14 +17,13 @@ import ( // a view. If you don't explicitly specify a view, then Amazon Web Services // Resource Explorer uses the default view for the Amazon Web Services Region in // which you call this operation. The results are the logical intersection of the -// results that match both the QueryString parameter supplied to this operation and -// the SearchFilter parameter attached to the view. For the complete syntax +// results that match both the QueryString parameter supplied to this operation +// and the SearchFilter parameter attached to the view. For the complete syntax // supported by the QueryString parameter, see Search query syntax reference for -// Resource Explorer -// (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html). -// If your search results are empty, or are missing results that you think should -// be there, see Troubleshooting Resource Explorer search -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html). +// Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html) +// . If your search results are empty, or are missing results that you think should +// be there, see Troubleshooting Resource Explorer search (https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html) +// . func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error) { if params == nil { params = &SearchInput{} @@ -44,9 +43,8 @@ type SearchInput struct { // A string that includes keywords and filters that specify the resources that you // want to include in the results. For the complete syntax supported by the - // QueryString parameter, see Search query syntax reference for Resource Explorer - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html). - // The search is completely case insensitive. You can specify an empty string to + // QueryString parameter, see Search query syntax reference for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) + // . The search is completely case insensitive. You can specify an empty string to // return all results up to the limit of 1,000 total results. The operation can // return only the first 1,000 results. If the resource you want is not included, // then use a different value for QueryString to refine the results. @@ -58,9 +56,9 @@ type SearchInput struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 @@ -71,13 +69,12 @@ type SearchInput struct { // response to indicate where the output should continue from. NextToken *string - // Specifies the Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view to use for the query. If you don't specify a value for this parameter, - // then the operation automatically uses the default view for the Amazon Web - // Services Region in which you called this operation. If the Region either doesn't - // have a default view or if you don't have permission to use the default view, - // then the operation fails with a 401 Unauthorized exception. + // Specifies the Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view to use for the query. If you don't specify a value for this + // parameter, then the operation automatically uses the default view for the Amazon + // Web Services Region in which you called this operation. If the Region either + // doesn't have a default view or if you don't have permission to use the default + // view, then the operation fails with a 401 Unauthorized exception. ViewArn *string noSmithyDocumentSerde @@ -91,15 +88,14 @@ type SearchOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // The list of structures that describe the resources that match the query. Resources []types.Resource - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that this operation used to perform the search. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that this operation used to perform the search. ViewArn *string // Metadata pertaining to the operation's result. @@ -184,9 +180,9 @@ type SearchPaginatorOptions struct { // response. If you do not include this parameter, it defaults to a value // appropriate to the operation. If additional items exist beyond those included in // the current response, the NextToken response element is present and has a value - // (is not null). Include that value as the NextToken request parameter in the next - // call to the operation to get the next part of the results. An API operation can - // return fewer results than the maximum even when there are more results + // (is not null). Include that value as the NextToken request parameter in the + // next call to the operation to get the next part of the results. An API operation + // can return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 diff --git a/service/resourceexplorer2/api_op_TagResource.go b/service/resourceexplorer2/api_op_TagResource.go index b9c8b8cea58..d736578f6c5 100644 --- a/service/resourceexplorer2/api_op_TagResource.go +++ b/service/resourceexplorer2/api_op_TagResource.go @@ -29,8 +29,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the view or index that you want to attach tags - // to. + // The Amazon Resource Name (ARN) of the view or index that you want to attach + // tags to. // // This member is required. ResourceArn *string diff --git a/service/resourceexplorer2/api_op_UntagResource.go b/service/resourceexplorer2/api_op_UntagResource.go index 48a68e0c42d..bed3a924031 100644 --- a/service/resourceexplorer2/api_op_UntagResource.go +++ b/service/resourceexplorer2/api_op_UntagResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more tag key and value pairs from an Amazon Web Services Resource -// Explorer view or index. +// Removes one or more tag key and value pairs from an Amazon Web Services +// Resource Explorer view or index. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -29,8 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the view or index that you want to remove tags - // from. + // The Amazon Resource Name (ARN) of the view or index that you want to remove + // tags from. // // This member is required. ResourceArn *string diff --git a/service/resourceexplorer2/api_op_UpdateIndexType.go b/service/resourceexplorer2/api_op_UpdateIndexType.go index e5b5bf30ef4..9f9cab4d350 100644 --- a/service/resourceexplorer2/api_op_UpdateIndexType.go +++ b/service/resourceexplorer2/api_op_UpdateIndexType.go @@ -15,46 +15,42 @@ import ( // Changes the type of the index from one of the following types to the other. For // more information about indexes and the role they perform in Amazon Web Services // Resource Explorer, see Turning on cross-Region search by creating an aggregator -// index -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) +// index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) // in the Amazon Web Services Resource Explorer User Guide. -// -// * AGGREGATOR index -// type The index contains information about resources from all Amazon Web Services -// Regions in the Amazon Web Services account in which you've created a Resource -// Explorer index. Resource information from all other Regions is replicated to -// this Region's index. When you change the index type to AGGREGATOR, Resource -// Explorer turns on replication of all discovered resource information from the -// other Amazon Web Services Regions in your account to this index. You can then, -// from this Region only, perform resource search queries that span all Amazon Web -// Services Regions in the Amazon Web Services account. Turning on replication from -// all other Regions is performed by asynchronous background tasks. You can check -// the status of the asynchronous tasks by using the GetIndex operation. When the -// asynchronous tasks complete, the Status response of that operation changes from -// UPDATING to ACTIVE. After that, you can start to see results from other Amazon -// Web Services Regions in query results. However, it can take several hours for -// replication from all other Regions to complete. You can have only one aggregator -// index per Amazon Web Services account. Before you can promote a different index -// to be the aggregator index for the account, you must first demote the existing -// aggregator index to type LOCAL. -// -// * LOCAL index type The index contains -// information about resources in only the Amazon Web Services Region in which the -// index exists. If an aggregator index in another Region exists, then information -// in this local index is replicated to the aggregator index. When you change the -// index type to LOCAL, Resource Explorer turns off the replication of resource -// information from all other Amazon Web Services Regions in the Amazon Web -// Services account to this Region. The aggregator index remains in the UPDATING -// state until all replication with other Regions successfully stops. You can check -// the status of the asynchronous task by using the GetIndex operation. When -// Resource Explorer successfully stops all replication with other Regions, the -// Status response of that operation changes from UPDATING to ACTIVE. Separately, -// the resource information from other Regions that was previously stored in the -// index is deleted within 30 days by another background task. Until that -// asynchronous task completes, some results from other Regions can continue to -// appear in search results. After you demote an aggregator index to a local index, -// you must wait 24 hours before you can promote another index to be the new -// aggregator index for the account. +// - AGGREGATOR index type The index contains information about resources from +// all Amazon Web Services Regions in the Amazon Web Services account in which +// you've created a Resource Explorer index. Resource information from all other +// Regions is replicated to this Region's index. When you change the index type to +// AGGREGATOR , Resource Explorer turns on replication of all discovered resource +// information from the other Amazon Web Services Regions in your account to this +// index. You can then, from this Region only, perform resource search queries that +// span all Amazon Web Services Regions in the Amazon Web Services account. Turning +// on replication from all other Regions is performed by asynchronous background +// tasks. You can check the status of the asynchronous tasks by using the +// GetIndex operation. When the asynchronous tasks complete, the Status response +// of that operation changes from UPDATING to ACTIVE . After that, you can start +// to see results from other Amazon Web Services Regions in query results. However, +// it can take several hours for replication from all other Regions to complete. +// You can have only one aggregator index per Amazon Web Services account. Before +// you can promote a different index to be the aggregator index for the account, +// you must first demote the existing aggregator index to type LOCAL . +// - LOCAL index type The index contains information about resources in only the +// Amazon Web Services Region in which the index exists. If an aggregator index in +// another Region exists, then information in this local index is replicated to the +// aggregator index. When you change the index type to LOCAL , Resource Explorer +// turns off the replication of resource information from all other Amazon Web +// Services Regions in the Amazon Web Services account to this Region. The +// aggregator index remains in the UPDATING state until all replication with +// other Regions successfully stops. You can check the status of the asynchronous +// task by using the GetIndex operation. When Resource Explorer successfully +// stops all replication with other Regions, the Status response of that +// operation changes from UPDATING to ACTIVE . Separately, the resource +// information from other Regions that was previously stored in the index is +// deleted within 30 days by another background task. Until that asynchronous task +// completes, some results from other Regions can continue to appear in search +// results. After you demote an aggregator index to a local index, you must wait 24 +// hours before you can promote another index to be the new aggregator index for +// the account. func (c *Client) UpdateIndexType(ctx context.Context, params *UpdateIndexTypeInput, optFns ...func(*Options)) (*UpdateIndexTypeOutput, error) { if params == nil { params = &UpdateIndexTypeInput{} @@ -72,16 +68,14 @@ func (c *Client) UpdateIndexType(ctx context.Context, params *UpdateIndexTypeInp type UpdateIndexTypeInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index that you want to update. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index that you want to update. // // This member is required. Arn *string - // The type of the index. To understand the difference between LOCAL and - // AGGREGATOR, see Turning on cross-Region search - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) + // The type of the index. To understand the difference between LOCAL and AGGREGATOR + // , see Turning on cross-Region search (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) // in the Amazon Web Services Resource Explorer User Guide. // // This member is required. @@ -92,9 +86,8 @@ type UpdateIndexTypeInput struct { type UpdateIndexTypeOutput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index that you updated. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index that you updated. Arn *string // The date and timestamp when the index was last updated. diff --git a/service/resourceexplorer2/api_op_UpdateView.go b/service/resourceexplorer2/api_op_UpdateView.go index 22eb9ce994a..cba53090a6f 100644 --- a/service/resourceexplorer2/api_op_UpdateView.go +++ b/service/resourceexplorer2/api_op_UpdateView.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies some of the details of a view. You can change the filter string and the -// list of included properties. You can't change the name of the view. +// Modifies some of the details of a view. You can change the filter string and +// the list of included properties. You can't change the name of the view. func (c *Client) UpdateView(ctx context.Context, params *UpdateViewInput, optFns ...func(*Options)) (*UpdateViewOutput, error) { if params == nil { params = &UpdateViewInput{} @@ -30,9 +30,8 @@ func (c *Client) UpdateView(ctx context.Context, params *UpdateViewInput, optFns type UpdateViewInput struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view that you want to modify. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view that you want to modify. // // This member is required. ViewArn *string @@ -41,17 +40,14 @@ type UpdateViewInput struct { // queries made using this view. When you use this view in a Search operation, the // filter string is combined with the search's QueryString parameter using a // logical AND operator. For information about the supported syntax, see Search - // query reference for Resource Explorer - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) + // query reference for Resource Explorer (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) // in the Amazon Web Services Resource Explorer User Guide. This query string in - // the context of this operation supports only filter prefixes - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) - // with optional operators - // (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators). - // It doesn't support free-form text. For example, the string region:us* + // the context of this operation supports only filter prefixes (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) + // with optional operators (https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) + // . It doesn't support free-form text. For example, the string region:us* // service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web // Services Region that begins with the letters us and is not tagged with a key - // Stage that has the value prod. + // Stage that has the value prod . Filters *types.SearchFilter // Specifies optional fields that you want included in search results from this diff --git a/service/resourceexplorer2/doc.go b/service/resourceexplorer2/doc.go index 4218d7811ce..adce473916d 100644 --- a/service/resourceexplorer2/doc.go +++ b/service/resourceexplorer2/doc.go @@ -13,22 +13,19 @@ // which you turn the service on, to simplify your cross-Region workloads. Resource // Explorer scans the resources in each of the Amazon Web Services Regions in your // Amazon Web Services account in which you turn on Resource Explorer. Resource -// Explorer creates and maintains an index -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-index) +// Explorer creates and maintains an index (https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-index) // in each Region, with the details of that Region's resources. You can search -// across all of the indexed Regions in your account -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) +// across all of the indexed Regions in your account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) // by designating one of your Amazon Web Services Regions to contain the aggregator // index for the account. When you promote a local index in a Region to become the -// aggregator index for the account -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region-turn-on.html), -// Resource Explorer automatically replicates the index information from all local -// indexes in the other Regions to the aggregator index. Therefore, the Region with -// the aggregator index has a copy of all resource information for all Regions in -// the account where you turned on Resource Explorer. As a result, views in the -// aggregator index Region include resources from all of the indexed Regions in -// your account. For more information about Amazon Web Services Resource Explorer, -// including how to enable and configure the service, see the Amazon Web Services -// Resource Explorer User Guide -// (https://docs.aws.amazon.com/resource-explorer/latest/userguide/). +// aggregator index for the account (https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region-turn-on.html) +// , Resource Explorer automatically replicates the index information from all +// local indexes in the other Regions to the aggregator index. Therefore, the +// Region with the aggregator index has a copy of all resource information for all +// Regions in the account where you turned on Resource Explorer. As a result, views +// in the aggregator index Region include resources from all of the indexed Regions +// in your account. For more information about Amazon Web Services Resource +// Explorer, including how to enable and configure the service, see the Amazon Web +// Services Resource Explorer User Guide (https://docs.aws.amazon.com/resource-explorer/latest/userguide/) +// . package resourceexplorer2 diff --git a/service/resourceexplorer2/document/document.go b/service/resourceexplorer2/document/document.go index ab3da0f65d1..b6f06cb9d7c 100644 --- a/service/resourceexplorer2/document/document.go +++ b/service/resourceexplorer2/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/resourceexplorer2/types/enums.go b/service/resourceexplorer2/types/enums.go index 25bc10acaef..c39dd5232ab 100644 --- a/service/resourceexplorer2/types/enums.go +++ b/service/resourceexplorer2/types/enums.go @@ -41,9 +41,9 @@ const ( IndexTypeAggregator IndexType = "AGGREGATOR" ) -// Values returns all known values for IndexType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for IndexType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (IndexType) Values() []IndexType { return []IndexType{ "LOCAL", diff --git a/service/resourceexplorer2/types/errors.go b/service/resourceexplorer2/types/errors.go index bcefaf2ff40..706bd8e77ed 100644 --- a/service/resourceexplorer2/types/errors.go +++ b/service/resourceexplorer2/types/errors.go @@ -34,8 +34,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request failed because either you specified parameters that didn’t match the -// original request, or you attempted to create a view with a name that already +// The request failed because either you specified parameters that didn’t match +// the original request, or you attempted to create a view with a name that already // exists in this Amazon Web Services Region. type ConflictException struct { Message *string @@ -146,8 +146,8 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request failed because you exceeded a rate limit for this operation. For -// more information, see Quotas for Resource Explorer -// (https://docs.aws.amazon.com/arexug/mainline/quotas.html). +// more information, see Quotas for Resource Explorer (https://docs.aws.amazon.com/arexug/mainline/quotas.html) +// . type ThrottlingException struct { Message *string diff --git a/service/resourceexplorer2/types/types.go b/service/resourceexplorer2/types/types.go index b3e5a699497..5590ab5c1ae 100644 --- a/service/resourceexplorer2/types/types.go +++ b/service/resourceexplorer2/types/types.go @@ -17,9 +17,8 @@ type BatchGetViewError struct { // This member is required. ErrorMessage *string - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view for which Resource Explorer failed to retrieve details. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view for which Resource Explorer failed to retrieve details. // // This member is required. ViewArn *string @@ -27,15 +26,14 @@ type BatchGetViewError struct { noSmithyDocumentSerde } -// Information about an additional property that describes a resource, that you can -// optionally include in the view. This lets you view that property in search +// Information about an additional property that describes a resource, that you +// can optionally include in the view. This lets you view that property in search // results, and filter your search results based on the value of the property. type IncludedProperty struct { // The name of the property that is included in this view. You can specify the // following property names for this field: - // - // * Tags + // - Tags // // This member is required. Name *string @@ -43,50 +41,45 @@ type IncludedProperty struct { noSmithyDocumentSerde } -// An index is the data store used by Amazon Web Services Resource Explorer to hold -// information about your Amazon Web Services resources that the service discovers. -// Creating an index in an Amazon Web Services Region turns on Resource Explorer -// and lets it discover your resources. By default, an index is local, meaning that -// it contains information about resources in only the same Region as the index. -// However, you can promote the index of one Region in the account by calling -// UpdateIndexType to convert it into an aggregator index. The aggregator index -// receives a replicated copy of the index information from all other Regions where -// Resource Explorer is turned on. This allows search operations in that Region to -// return results from all Regions in the account. +// An index is the data store used by Amazon Web Services Resource Explorer to +// hold information about your Amazon Web Services resources that the service +// discovers. Creating an index in an Amazon Web Services Region turns on Resource +// Explorer and lets it discover your resources. By default, an index is local, +// meaning that it contains information about resources in only the same Region as +// the index. However, you can promote the index of one Region in the account by +// calling UpdateIndexType to convert it into an aggregator index. The aggregator +// index receives a replicated copy of the index information from all other Regions +// where Resource Explorer is turned on. This allows search operations in that +// Region to return results from all Regions in the account. type Index struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the index. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the index. Arn *string // The Amazon Web Services Region in which the index exists. Region *string // The type of index. It can be one of the following values: - // - // * LOCAL – The index - // contains information about resources from only the same Amazon Web Services - // Region. - // - // * AGGREGATOR – Resource Explorer replicates copies of the indexed - // information about resources in all other Amazon Web Services Regions to the - // aggregator index. This lets search results in the Region with the aggregator - // index to include resources from all Regions in the account where Resource - // Explorer is turned on. + // - LOCAL – The index contains information about resources from only the same + // Amazon Web Services Region. + // - AGGREGATOR – Resource Explorer replicates copies of the indexed information + // about resources in all other Amazon Web Services Regions to the aggregator + // index. This lets search results in the Region with the aggregator index to + // include resources from all Regions in the account where Resource Explorer is + // turned on. Type IndexType noSmithyDocumentSerde } -// A resource in Amazon Web Services that Amazon Web Services Resource Explorer has -// discovered, and for which it has stored information in the index of the Amazon -// Web Services Region that contains the resource. +// A resource in Amazon Web Services that Amazon Web Services Resource Explorer +// has discovered, and for which it has stored information in the index of the +// Amazon Web Services Region that contains the resource. type Resource struct { - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the resource. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the resource. Arn *string // The date and time that Resource Explorer last queried this resource and updated @@ -122,12 +115,10 @@ type ResourceCount struct { // Indicates whether the TotalResources value represents an exhaustive count of // search results. - // - // * If True, it indicates that the search was exhaustive. Every - // resource that matches the query was counted. - // - // * If False, then the search - // reached the limit of 1,000 matching results, and stopped counting. + // - If True , it indicates that the search was exhaustive. Every resource that + // matches the query was counted. + // - If False , then the search reached the limit of 1,000 matching results, and + // stopped counting. Complete *bool // The number of resources that match the search query. This value can't exceed @@ -160,10 +151,10 @@ type ResourceProperty struct { // set. type SearchFilter struct { - // The string that contains the search keywords, prefixes, and operators to control - // the results that can be returned by a Search operation. For more details, see - // Search query syntax - // (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html). + // The string that contains the search keywords, prefixes, and operators to + // control the results that can be returned by a Search operation. For more + // details, see Search query syntax (https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html) + // . // // This member is required. FilterString *string @@ -201,8 +192,8 @@ type ValidationExceptionField struct { noSmithyDocumentSerde } -// A view is a structure that defines a set of filters that provide a view into the -// information in the Amazon Web Services Resource Explorer index. The filters +// A view is a structure that defines a set of filters that provide a view into +// the information in the Amazon Web Services Resource Explorer index. The filters // specify which information from the index is visible to the users of the view. // For example, you can specify filters that include only resources that are tagged // with the key "ENV" and the value "DEVELOPMENT" in the results returned by this @@ -210,8 +201,8 @@ type ValidationExceptionField struct { // tagged with "ENV" and "PRODUCTION". type View struct { - // An array of SearchFilter objects that specify which resources can be included in - // the results of queries made using this view. + // An array of SearchFilter objects that specify which resources can be included + // in the results of queries made using this view. Filters *SearchFilter // A structure that contains additional information about the view. @@ -223,18 +214,16 @@ type View struct { // The Amazon Web Services account that owns this view. Owner *string - // An Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // an Amazon Web Services account, an organization, or an organizational unit (OU) - // that specifies whether this view includes resources from only the specified + // An Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of an Amazon Web Services account, an organization, or an organizational unit + // (OU) that specifies whether this view includes resources from only the specified // Amazon Web Services account, all accounts in the specified organization, or all // accounts in the specified OU. If not specified, the value defaults to the Amazon // Web Services account used to call this operation. Scope *string - // The Amazon resource name (ARN) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of - // the view. + // The Amazon resource name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // of the view. ViewArn *string noSmithyDocumentSerde diff --git a/service/resourcegroups/api_client.go b/service/resourcegroups/api_client.go index a0d1b322607..40949ab05e4 100644 --- a/service/resourcegroups/api_client.go +++ b/service/resourcegroups/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/resourcegroups/api_op_CreateGroup.go b/service/resourcegroups/api_op_CreateGroup.go index 6c4914aef13..2e91e8b4ebb 100644 --- a/service/resourcegroups/api_op_CreateGroup.go +++ b/service/resourcegroups/api_op_CreateGroup.go @@ -13,16 +13,14 @@ import ( // Creates a resource group with the specified name and description. You can // optionally include either a resource query or a service configuration. For more -// information about constructing a resource query, see Build queries and groups in -// Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html) in -// the Resource Groups User Guide. For more information about service-linked groups -// and service configurations, see Service configurations for Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). Minimum -// permissions To run this command, you must have the following permissions: -// -// * -// resource-groups:CreateGroup +// information about constructing a resource query, see Build queries and groups +// in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html) +// in the Resource Groups User Guide. For more information about service-linked +// groups and service configurations, see Service configurations for Resource +// Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) . +// Minimum permissions To run this command, you must have the following +// permissions: +// - resource-groups:CreateGroup func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -40,12 +38,12 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { - // The name of the group, which is the identifier of the group in other operations. - // You can't change the name of a resource group after you create it. A resource - // group name can consist of letters, numbers, hyphens, periods, and underscores. - // The name cannot start with AWS or aws; these are reserved. A resource group name - // must be unique within each Amazon Web Services Region in your Amazon Web - // Services account. + // The name of the group, which is the identifier of the group in other + // operations. You can't change the name of a resource group after you create it. A + // resource group name can consist of letters, numbers, hyphens, periods, and + // underscores. The name cannot start with AWS or aws ; these are reserved. A + // resource group name must be unique within each Amazon Web Services Region in + // your Amazon Web Services account. // // This member is required. Name *string @@ -54,9 +52,9 @@ type CreateGroupInput struct { // service and specifies how the service can interact with the resources in the // group. A configuration is an array of GroupConfigurationItem elements. For // details about the syntax of service configurations, see Service configurations - // for Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). A resource - // group can contain either a Configuration or a ResourceQuery, but not both. + // for Resource Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) + // . A resource group can contain either a Configuration or a ResourceQuery , but + // not both. Configuration []types.GroupConfigurationItem // The description of the resource group. Descriptions can consist of letters, @@ -64,11 +62,10 @@ type CreateGroupInput struct { Description *string // The resource query that determines which Amazon Web Services resources are - // members of this group. For more information about resource queries, see Create a - // tag-based group in Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). - // A resource group can contain either a ResourceQuery or a Configuration, but not - // both. + // members of this group. For more information about resource queries, see Create + // a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag) + // . A resource group can contain either a ResourceQuery or a Configuration , but + // not both. ResourceQuery *types.ResourceQuery // The tags to add to the group. A tag is key-value pair string. @@ -84,12 +81,12 @@ type CreateGroupOutput struct { // The service configuration associated with the resource group. For details about // the syntax of a service configuration, see Service configurations for Resource - // Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). + // Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) . GroupConfiguration *types.GroupConfiguration // The resource query associated with the group. For more information about - // resource queries, see Create a tag-based group in Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). + // resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag) + // . ResourceQuery *types.ResourceQuery // The tags associated with the group. diff --git a/service/resourcegroups/api_op_DeleteGroup.go b/service/resourcegroups/api_op_DeleteGroup.go index d88c5da020a..ccf93ed1dfb 100644 --- a/service/resourcegroups/api_op_DeleteGroup.go +++ b/service/resourcegroups/api_op_DeleteGroup.go @@ -15,8 +15,7 @@ import ( // any resources that are members of the group; it only deletes the group // structure. Minimum permissions To run this command, you must have the following // permissions: -// -// * resource-groups:DeleteGroup +// - resource-groups:DeleteGroup func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { params = &DeleteGroupInput{} diff --git a/service/resourcegroups/api_op_GetGroup.go b/service/resourcegroups/api_op_GetGroup.go index 805cea964db..d01119d3279 100644 --- a/service/resourcegroups/api_op_GetGroup.go +++ b/service/resourcegroups/api_op_GetGroup.go @@ -11,11 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a specified resource group. Minimum permissions To run -// this command, you must have the following permissions: -// -// * -// resource-groups:GetGroup +// Returns information about a specified resource group. Minimum permissions To +// run this command, you must have the following permissions: +// - resource-groups:GetGroup func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error) { if params == nil { params = &GetGroupInput{} @@ -46,9 +44,9 @@ type GetGroupInput struct { type GetGroupOutput struct { - // A structure that contains the metadata details for the specified resource group. - // Use GetGroupQuery and GetGroupConfiguration to get those additional details of - // the resource group. + // A structure that contains the metadata details for the specified resource + // group. Use GetGroupQuery and GetGroupConfiguration to get those additional + // details of the resource group. Group *types.Group // Metadata pertaining to the operation's result. diff --git a/service/resourcegroups/api_op_GetGroupConfiguration.go b/service/resourcegroups/api_op_GetGroupConfiguration.go index 619e036eb3d..9646332cc7c 100644 --- a/service/resourcegroups/api_op_GetGroupConfiguration.go +++ b/service/resourcegroups/api_op_GetGroupConfiguration.go @@ -13,12 +13,10 @@ import ( // Retrieves the service configuration associated with the specified resource // group. For details about the service configuration syntax, see Service -// configurations for Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). Minimum -// permissions To run this command, you must have the following permissions: -// -// * -// resource-groups:GetGroupConfiguration +// configurations for Resource Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) +// . Minimum permissions To run this command, you must have the following +// permissions: +// - resource-groups:GetGroupConfiguration func (c *Client) GetGroupConfiguration(ctx context.Context, params *GetGroupConfigurationInput, optFns ...func(*Options)) (*GetGroupConfigurationOutput, error) { if params == nil { params = &GetGroupConfigurationInput{} @@ -45,10 +43,10 @@ type GetGroupConfigurationInput struct { type GetGroupConfigurationOutput struct { - // A structure that describes the service configuration attached with the specified - // group. For details about the service configuration syntax, see Service - // configurations for Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). + // A structure that describes the service configuration attached with the + // specified group. For details about the service configuration syntax, see + // Service configurations for Resource Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) + // . GroupConfiguration *types.GroupConfiguration // Metadata pertaining to the operation's result. diff --git a/service/resourcegroups/api_op_GetGroupQuery.go b/service/resourcegroups/api_op_GetGroupQuery.go index 2fc5c5a863b..347cce7da4a 100644 --- a/service/resourcegroups/api_op_GetGroupQuery.go +++ b/service/resourcegroups/api_op_GetGroupQuery.go @@ -13,12 +13,10 @@ import ( // Retrieves the resource query associated with the specified resource group. For // more information about resource queries, see Create a tag-based group in -// Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). -// Minimum permissions To run this command, you must have the following +// Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag) +// . Minimum permissions To run this command, you must have the following // permissions: -// -// * resource-groups:GetGroupQuery +// - resource-groups:GetGroupQuery func (c *Client) GetGroupQuery(ctx context.Context, params *GetGroupQueryInput, optFns ...func(*Options)) (*GetGroupQueryOutput, error) { if params == nil { params = &GetGroupQueryInput{} @@ -50,8 +48,8 @@ type GetGroupQueryInput struct { type GetGroupQueryOutput struct { // The resource query associated with the specified group. For more information - // about resource queries, see Create a tag-based group in Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). + // about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag) + // . GroupQuery *types.GroupQuery // Metadata pertaining to the operation's result. diff --git a/service/resourcegroups/api_op_GetTags.go b/service/resourcegroups/api_op_GetTags.go index cde80a5c98c..62e39563d7c 100644 --- a/service/resourcegroups/api_op_GetTags.go +++ b/service/resourcegroups/api_op_GetTags.go @@ -13,8 +13,7 @@ import ( // Returns a list of tags that are associated with a resource group, specified by // an ARN. Minimum permissions To run this command, you must have the following // permissions: -// -// * resource-groups:GetTags +// - resource-groups:GetTags func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...func(*Options)) (*GetTagsOutput, error) { if params == nil { params = &GetTagsInput{} diff --git a/service/resourcegroups/api_op_GroupResources.go b/service/resourcegroups/api_op_GroupResources.go index e0d14872b50..a0301348afe 100644 --- a/service/resourcegroups/api_op_GroupResources.go +++ b/service/resourcegroups/api_op_GroupResources.go @@ -13,18 +13,13 @@ import ( // Adds the specified resources to the specified group. You can use this operation // with only resource groups that are configured with the following types: +// - AWS::EC2::HostManagement +// - AWS::EC2::CapacityReservationPool // -// * -// AWS::EC2::HostManagement -// -// * AWS::EC2::CapacityReservationPool -// -// Other resource -// group type and resource types aren't currently supported by this operation. -// Minimum permissions To run this command, you must have the following +// Other resource group type and resource types aren't currently supported by this +// operation. Minimum permissions To run this command, you must have the following // permissions: -// -// * resource-groups:GroupResources +// - resource-groups:GroupResources func (c *Client) GroupResources(ctx context.Context, params *GroupResourcesInput, optFns ...func(*Options)) (*GroupResourcesOutput, error) { if params == nil { params = &GroupResourcesInput{} @@ -62,9 +57,9 @@ type GroupResourcesOutput struct { // A list of ARNs of any resources that this operation is still in the process // adding to the group. These pending additions continue asynchronously. You can - // check the status of pending additions by using the ListGroupResources operation, - // and checking the Resources array in the response and the Status field of each - // object in that array. + // check the status of pending additions by using the ListGroupResources + // operation, and checking the Resources array in the response and the Status + // field of each object in that array. Pending []types.PendingResource // A list of ARNs of the resources that this operation successfully added to the diff --git a/service/resourcegroups/api_op_ListGroupResources.go b/service/resourcegroups/api_op_ListGroupResources.go index c6aa47899e6..210ff0f69f2 100644 --- a/service/resourcegroups/api_op_ListGroupResources.go +++ b/service/resourcegroups/api_op_ListGroupResources.go @@ -12,19 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of ARNs of the resources that are members of a specified resource -// group. Minimum permissions To run this command, you must have the following -// permissions: -// -// * resource-groups:ListGroupResources -// -// * -// cloudformation:DescribeStacks -// -// * cloudformation:ListStackResources -// -// * -// tag:GetResources +// Returns a list of ARNs of the resources that are members of a specified +// resource group. Minimum permissions To run this command, you must have the +// following permissions: +// - resource-groups:ListGroupResources +// - cloudformation:DescribeStacks +// - cloudformation:ListStackResources +// - tag:GetResources func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResourcesInput, optFns ...func(*Options)) (*ListGroupResourcesOutput, error) { if params == nil { params = &ListGroupResourcesInput{} @@ -45,24 +39,22 @@ type ListGroupResourcesInput struct { // Filters, formatted as ResourceFilter objects, that you want to apply to a // ListGroupResources operation. Filters the results to include only those of the // specified resource types. - // - // * resource-type - Filter resources by their type. - // Specify up to five resource types in the format AWS::ServiceCode::ResourceType. - // For example, AWS::EC2::Instance, or AWS::S3::Bucket. - // - // When you specify a - // resource-type filter for ListGroupResources, Resource Groups validates your - // filter resource types against the types that are defined in the query associated - // with the group. For example, if a group contains only S3 buckets because its - // query specifies only that resource type, but your resource-type filter includes - // EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this - // case, a ListGroupResources request returns a BadRequestException error with a - // message similar to the following: The resource types specified as filters in the - // request are not valid. The error includes a list of resource types that failed - // the validation because they are not part of the query associated with the group. - // This validation doesn't occur when the group query specifies AWS::AllSupported, - // because a group based on such a query can contain any of the allowed resource - // types for the query type (tag-based or Amazon CloudFront stack-based queries). + // - resource-type - Filter resources by their type. Specify up to five resource + // types in the format AWS::ServiceCode::ResourceType . For example, + // AWS::EC2::Instance , or AWS::S3::Bucket . + // When you specify a resource-type filter for ListGroupResources , Resource Groups + // validates your filter resource types against the types that are defined in the + // query associated with the group. For example, if a group contains only S3 + // buckets because its query specifies only that resource type, but your + // resource-type filter includes EC2 instances, AWS Resource Groups does not filter + // for EC2 instances. In this case, a ListGroupResources request returns a + // BadRequestException error with a message similar to the following: The resource + // types specified as filters in the request are not valid. The error includes a + // list of resource types that failed the validation because they are not part of + // the query associated with the group. This validation doesn't occur when the + // group query specifies AWS::AllSupported , because a group based on such a query + // can contain any of the allowed resource types for the query type (tag-based or + // Amazon CloudFront stack-based queries). Filters []types.ResourceFilter // The name or the ARN of the resource group @@ -73,15 +65,15 @@ type ListGroupResourcesInput struct { // Deprecated: This field is deprecated, use Group instead. GroupName *string - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -98,12 +90,12 @@ type ListGroupResourcesOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of QueryError objects. Each error is an object that contains ErrorCode // and Message structures. Possible values for ErrorCode are - // CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING. + // CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING . QueryErrors []types.QueryError // Deprecated - don't use this parameter. Use the Resources response field instead. @@ -195,15 +187,15 @@ var _ ListGroupResourcesAPIClient = (*Client)(nil) // ListGroupResourcesPaginatorOptions is the paginator options for // ListGroupResources type ListGroupResourcesPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourcegroups/api_op_ListGroups.go b/service/resourcegroups/api_op_ListGroups.go index 8b64c907b91..bf6133ce6f1 100644 --- a/service/resourcegroups/api_op_ListGroups.go +++ b/service/resourcegroups/api_op_ListGroups.go @@ -14,9 +14,7 @@ import ( // Returns a list of existing Resource Groups in your account. Minimum permissions // To run this command, you must have the following permissions: -// -// * -// resource-groups:ListGroups +// - resource-groups:ListGroups func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} @@ -36,31 +34,26 @@ type ListGroupsInput struct { // Filters, formatted as GroupFilter objects, that you want to apply to a // ListGroups operation. - // - // * resource-type - Filter the results to include only - // those of the specified resource types. Specify up to five resource types in the - // format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or - // AWS::S3::Bucket. - // - // * configuration-type - Filter the results to include only - // those groups that have the specified configuration types attached. The current - // supported values are: - // - // * AWS::EC2::CapacityReservationPool - // - // * - // AWS::EC2::HostManagement + // - resource-type - Filter the results to include only those of the specified + // resource types. Specify up to five resource types in the format + // AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance , or + // AWS::S3::Bucket . + // - configuration-type - Filter the results to include only those groups that + // have the specified configuration types attached. The current supported values + // are: + // - AWS::EC2::CapacityReservationPool + // - AWS::EC2::HostManagement Filters []types.GroupFilter - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -75,7 +68,7 @@ type ListGroupsInput struct { type ListGroupsOutput struct { // A list of GroupIdentifier objects. Each identifier is an object that contains - // both the Name and the GroupArn. + // both the Name and the GroupArn . GroupIdentifiers []types.GroupIdentifier // Deprecated - don't use this field. Use the GroupIdentifiers response field @@ -87,7 +80,7 @@ type ListGroupsOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // Metadata pertaining to the operation's result. @@ -168,15 +161,15 @@ var _ ListGroupsAPIClient = (*Client)(nil) // ListGroupsPaginatorOptions is the paginator options for ListGroups type ListGroupsPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourcegroups/api_op_PutGroupConfiguration.go b/service/resourcegroups/api_op_PutGroupConfiguration.go index b14735e88c8..2e91e230e14 100644 --- a/service/resourcegroups/api_op_PutGroupConfiguration.go +++ b/service/resourcegroups/api_op_PutGroupConfiguration.go @@ -15,8 +15,7 @@ import ( // asynchronously, and can take time to complete. You can use GetGroupConfiguration // to check the status of the update. Minimum permissions To run this command, you // must have the following permissions: -// -// * resource-groups:PutGroupConfiguration +// - resource-groups:PutGroupConfiguration func (c *Client) PutGroupConfiguration(ctx context.Context, params *PutGroupConfigurationInput, optFns ...func(*Options)) (*PutGroupConfigurationOutput, error) { if params == nil { params = &PutGroupConfigurationInput{} @@ -37,10 +36,10 @@ type PutGroupConfigurationInput struct { // The new configuration to associate with the specified group. A configuration // associates the resource group with an Amazon Web Services service and specifies // how the service can interact with the resources in the group. A configuration is - // an array of GroupConfigurationItem elements. For information about the syntax of - // a service configuration, see Service configurations for Resource Groups - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). A resource - // group can contain either a Configuration or a ResourceQuery, but not both. + // an array of GroupConfigurationItem elements. For information about the syntax + // of a service configuration, see Service configurations for Resource Groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) + // . A resource group can contain either a Configuration or a ResourceQuery , but + // not both. Configuration []types.GroupConfigurationItem // The name or ARN of the resource group with the configuration that you want to diff --git a/service/resourcegroups/api_op_SearchResources.go b/service/resourcegroups/api_op_SearchResources.go index 832adfd9525..86cfcaa7958 100644 --- a/service/resourcegroups/api_op_SearchResources.go +++ b/service/resourcegroups/api_op_SearchResources.go @@ -16,16 +16,10 @@ import ( // specified query. The query uses the same format as a resource query in a // CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this // command, you must have the following permissions: -// -// * -// resource-groups:SearchResources -// -// * cloudformation:DescribeStacks -// -// * -// cloudformation:ListStackResources -// -// * tag:GetResources +// - resource-groups:SearchResources +// - cloudformation:DescribeStacks +// - cloudformation:ListStackResources +// - tag:GetResources func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInput, optFns ...func(*Options)) (*SearchResourcesOutput, error) { if params == nil { params = &SearchResourcesInput{} @@ -44,20 +38,20 @@ func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInp type SearchResourcesInput struct { // The search query, using the same formats that are supported for resource group - // definition. For more information, see CreateGroup. + // definition. For more information, see CreateGroup . // // This member is required. ResourceQuery *types.ResourceQuery - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. MaxResults *int32 // The parameter for receiving additional results if you receive a NextToken @@ -74,16 +68,13 @@ type SearchResourcesOutput struct { // If present, indicates that more output is available than is included in the // current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should - // repeat this until the NextToken response element comes back as null. + // repeat this until the NextToken response element comes back as null . NextToken *string // A list of QueryError objects. Each error is an object that contains ErrorCode - // and Message structures. Possible values for ErrorCode: - // - // * - // CLOUDFORMATION_STACK_INACTIVE - // - // * CLOUDFORMATION_STACK_NOT_EXISTING + // and Message structures. Possible values for ErrorCode : + // - CLOUDFORMATION_STACK_INACTIVE + // - CLOUDFORMATION_STACK_NOT_EXISTING QueryErrors []types.QueryError // The ARNs and resource types of resources that are members of the group that you @@ -169,15 +160,15 @@ var _ SearchResourcesAPIClient = (*Client)(nil) // SearchResourcesPaginatorOptions is the paginator options for SearchResources type SearchResourcesPaginatorOptions struct { - // The total number of results that you want included on each page of the response. - // If you do not include this parameter, it defaults to a value that is specific to - // the operation. If additional items exist beyond the maximum you specify, the - // NextToken response element is present and has a value (is not null). Include - // that value as the NextToken request parameter in the next call to the operation - // to get the next part of the results. Note that the service might return fewer - // results than the maximum even when there are more results available. You should - // check NextToken after every operation to ensure that you receive all of the - // results. + // The total number of results that you want included on each page of the + // response. If you do not include this parameter, it defaults to a value that is + // specific to the operation. If additional items exist beyond the maximum you + // specify, the NextToken response element is present and has a value (is not + // null). Include that value as the NextToken request parameter in the next call + // to the operation to get the next part of the results. Note that the service + // might return fewer results than the maximum even when there are more results + // available. You should check NextToken after every operation to ensure that you + // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourcegroups/api_op_Tag.go b/service/resourcegroups/api_op_Tag.go index c850e171461..1d4d7761be3 100644 --- a/service/resourcegroups/api_op_Tag.go +++ b/service/resourcegroups/api_op_Tag.go @@ -17,8 +17,7 @@ import ( // billing and administration services. Tags are not intended to be used for // private or sensitive data. Minimum permissions To run this command, you must // have the following permissions: -// -// * resource-groups:Tag +// - resource-groups:Tag func (c *Client) Tag(ctx context.Context, params *TagInput, optFns ...func(*Options)) (*TagOutput, error) { if params == nil { params = &TagInput{} @@ -41,8 +40,8 @@ type TagInput struct { // This member is required. Arn *string - // The tags to add to the specified resource group. A tag is a string-to-string map - // of key-value pairs. + // The tags to add to the specified resource group. A tag is a string-to-string + // map of key-value pairs. // // This member is required. Tags map[string]string diff --git a/service/resourcegroups/api_op_UngroupResources.go b/service/resourcegroups/api_op_UngroupResources.go index bfa0be8b1a8..26686e057fc 100644 --- a/service/resourcegroups/api_op_UngroupResources.go +++ b/service/resourcegroups/api_op_UngroupResources.go @@ -16,9 +16,7 @@ import ( // It doesn't work with any resource groups that are automatically populated by // tag-based or CloudFormation stack-based queries. Minimum permissions To run this // command, you must have the following permissions: -// -// * -// resource-groups:UngroupResources +// - resource-groups:UngroupResources func (c *Client) UngroupResources(ctx context.Context, params *UngroupResourcesInput, optFns ...func(*Options)) (*UngroupResourcesOutput, error) { if params == nil { params = &UngroupResourcesInput{} diff --git a/service/resourcegroups/api_op_Untag.go b/service/resourcegroups/api_op_Untag.go index d87f2fdeb9c..7b1f9cc22af 100644 --- a/service/resourcegroups/api_op_Untag.go +++ b/service/resourcegroups/api_op_Untag.go @@ -12,8 +12,7 @@ import ( // Deletes tags from a specified resource group. Minimum permissions To run this // command, you must have the following permissions: -// -// * resource-groups:Untag +// - resource-groups:Untag func (c *Client) Untag(ctx context.Context, params *UntagInput, optFns ...func(*Options)) (*UntagOutput, error) { if params == nil { params = &UntagInput{} diff --git a/service/resourcegroups/api_op_UpdateAccountSettings.go b/service/resourcegroups/api_op_UpdateAccountSettings.go index 749b677d6a4..187e32e47d3 100644 --- a/service/resourcegroups/api_op_UpdateAccountSettings.go +++ b/service/resourcegroups/api_op_UpdateAccountSettings.go @@ -12,9 +12,9 @@ import ( ) // Turns on or turns off optional features in Resource Groups. The preceding -// example shows that the request to turn on group lifecycle events is IN_PROGRESS. -// You can call the GetAccountSettings operation to check for completion by looking -// for GroupLifecycleEventsStatus to change to ACTIVE. +// example shows that the request to turn on group lifecycle events is IN_PROGRESS +// . You can call the GetAccountSettings operation to check for completion by +// looking for GroupLifecycleEventsStatus to change to ACTIVE . func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) { if params == nil { params = &UpdateAccountSettingsInput{} @@ -32,9 +32,8 @@ func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccoun type UpdateAccountSettingsInput struct { - // Specifies whether you want to turn group lifecycle events - // (https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html) on or - // off. + // Specifies whether you want to turn group lifecycle events (https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html) + // on or off. GroupLifecycleEventsDesiredStatus types.GroupLifecycleEventsDesiredStatus noSmithyDocumentSerde diff --git a/service/resourcegroups/api_op_UpdateGroup.go b/service/resourcegroups/api_op_UpdateGroup.go index c54ed26661d..f76b9f0fea9 100644 --- a/service/resourcegroups/api_op_UpdateGroup.go +++ b/service/resourcegroups/api_op_UpdateGroup.go @@ -14,8 +14,7 @@ import ( // Updates the description for an existing group. You cannot update the name of a // resource group. Minimum permissions To run this command, you must have the // following permissions: -// -// * resource-groups:UpdateGroup +// - resource-groups:UpdateGroup func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) { if params == nil { params = &UpdateGroupInput{} diff --git a/service/resourcegroups/api_op_UpdateGroupQuery.go b/service/resourcegroups/api_op_UpdateGroupQuery.go index b561172938f..d1894ae616a 100644 --- a/service/resourcegroups/api_op_UpdateGroupQuery.go +++ b/service/resourcegroups/api_op_UpdateGroupQuery.go @@ -12,12 +12,10 @@ import ( ) // Updates the resource query of a group. For more information about resource -// queries, see Create a tag-based group in Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). -// Minimum permissions To run this command, you must have the following +// queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag) +// . Minimum permissions To run this command, you must have the following // permissions: -// -// * resource-groups:UpdateGroupQuery +// - resource-groups:UpdateGroupQuery func (c *Client) UpdateGroupQuery(ctx context.Context, params *UpdateGroupQueryInput, optFns ...func(*Options)) (*UpdateGroupQueryOutput, error) { if params == nil { params = &UpdateGroupQueryInput{} @@ -36,8 +34,8 @@ func (c *Client) UpdateGroupQuery(ctx context.Context, params *UpdateGroupQueryI type UpdateGroupQueryInput struct { // The resource query to determine which Amazon Web Services resources are members - // of this resource group. A resource group can contain either a Configuration or a - // ResourceQuery, but not both. + // of this resource group. A resource group can contain either a Configuration or + // a ResourceQuery , but not both. // // This member is required. ResourceQuery *types.ResourceQuery diff --git a/service/resourcegroups/doc.go b/service/resourcegroups/doc.go index 13622f94c6e..40cbebe4cbf 100644 --- a/service/resourcegroups/doc.go +++ b/service/resourcegroups/doc.go @@ -18,22 +18,14 @@ // resources. To create a resource group, build a resource query, and specify tags // that identify the criteria that members of the group have in common. Tags are // key-value pairs. For more information about Resource Groups, see the Resource -// Groups User Guide -// (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html). Resource Groups -// uses a REST-compliant API that you can use to perform the following types of -// operations. -// -// * Create, Read, Update, and Delete (CRUD) operations on resource -// groups and resource query entities -// -// * Applying, editing, and removing tags from -// resource groups -// -// * Resolving resource group member ARNs so they can be returned -// as search results -// -// * Getting data about resources that are members of a group -// -// * -// Searching Amazon Web Services resources based on a resource query +// Groups User Guide (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html) +// . Resource Groups uses a REST-compliant API that you can use to perform the +// following types of operations. +// - Create, Read, Update, and Delete (CRUD) operations on resource groups and +// resource query entities +// - Applying, editing, and removing tags from resource groups +// - Resolving resource group member ARNs so they can be returned as search +// results +// - Getting data about resources that are members of a group +// - Searching Amazon Web Services resources based on a resource query package resourcegroups diff --git a/service/resourcegroups/types/enums.go b/service/resourcegroups/types/enums.go index 59a6f9c3aec..e4bde48a720 100644 --- a/service/resourcegroups/types/enums.go +++ b/service/resourcegroups/types/enums.go @@ -11,9 +11,9 @@ const ( GroupConfigurationStatusUpdateFailed GroupConfigurationStatus = "UPDATE_FAILED" ) -// Values returns all known values for GroupConfigurationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for GroupConfigurationStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupConfigurationStatus) Values() []GroupConfigurationStatus { return []GroupConfigurationStatus{ "UPDATING", @@ -48,8 +48,8 @@ const ( GroupLifecycleEventsDesiredStatusInactive GroupLifecycleEventsDesiredStatus = "INACTIVE" ) -// Values returns all known values for GroupLifecycleEventsDesiredStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for GroupLifecycleEventsDesiredStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (GroupLifecycleEventsDesiredStatus) Values() []GroupLifecycleEventsDesiredStatus { @@ -109,9 +109,9 @@ const ( QueryTypeCloudformationStack10 QueryType = "CLOUDFORMATION_STACK_1_0" ) -// Values returns all known values for QueryType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for QueryType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (QueryType) Values() []QueryType { return []QueryType{ "TAG_FILTERS_1_0", diff --git a/service/resourcegroups/types/types.go b/service/resourcegroups/types/types.go index a377ceeed0b..79d569af802 100644 --- a/service/resourcegroups/types/types.go +++ b/service/resourcegroups/types/types.go @@ -40,16 +40,14 @@ type FailedResource struct { // A resource group that contains Amazon Web Services resources. You can assign // resources to the group by associating either of the following elements with the // group: -// -// * ResourceQuery - Use a resource query to specify a set of tag keys and -// values. All resources in the same Amazon Web Services Region and Amazon Web -// Services account that have those keys with the same values are included in the -// group. You can add a resource query when you create the group, or later by using -// the PutGroupConfiguration operation. -// -// * GroupConfiguration - Use a service -// configuration to associate the group with an Amazon Web Services service. The -// configuration specifies which resource types can be included in the group. +// - ResourceQuery - Use a resource query to specify a set of tag keys and +// values. All resources in the same Amazon Web Services Region and Amazon Web +// Services account that have those keys with the same values are included in the +// group. You can add a resource query when you create the group, or later by using +// the PutGroupConfiguration operation. +// - GroupConfiguration - Use a service configuration to associate the group with +// an Amazon Web Services service. The configuration specifies which resource types +// can be included in the group. type Group struct { // The ARN of the resource group. @@ -69,12 +67,12 @@ type Group struct { } // A service configuration associated with a resource group. The configuration -// options are determined by the Amazon Web Services service that defines the Type, -// and specifies which resources can be included in the group. You can add a -// service configuration when you create the group by using CreateGroup, or later +// options are determined by the Amazon Web Services service that defines the Type +// , and specifies which resources can be included in the group. You can add a +// service configuration when you create the group by using CreateGroup , or later // by using the PutGroupConfiguration operation. For details about group service -// configuration syntax, see Service configurations for resource groups -// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). +// configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) +// . type GroupConfiguration struct { // The configuration currently associated with the group and in effect. @@ -83,8 +81,8 @@ type GroupConfiguration struct { // If present, the reason why a request to update the group configuration failed. FailureReason *string - // If present, the new configuration that is in the process of being applied to the - // group. + // If present, the new configuration that is in the process of being applied to + // the group. ProposedConfiguration []GroupConfigurationItem // The current status of an attempt to update the group configuration. @@ -95,44 +93,44 @@ type GroupConfiguration struct { // An item in a group configuration. A group service configuration can have one or // more items. For details about group service configuration syntax, see Service -// configurations for resource groups -// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). +// configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) +// . type GroupConfigurationItem struct { // Specifies the type of group configuration item. Each item must have a unique - // value for type. For the list of types that you can specify for a configuration - // item, see Supported resource types and parameters - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types). + // value for type . For the list of types that you can specify for a configuration + // item, see Supported resource types and parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) + // . // // This member is required. Type *string // A collection of parameters for this group configuration item. For the list of // parameters that you can use with each configuration item type, see Supported - // resource types and parameters - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types). + // resource types and parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) + // . Parameters []GroupConfigurationParameter noSmithyDocumentSerde } // A parameter for a group configuration item. For details about group service -// configuration syntax, see Service configurations for resource groups -// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). +// configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) +// . type GroupConfigurationParameter struct { // The name of the group configuration parameter. For the list of parameters that // you can use with each configuration item type, see Supported resource types and - // parameters - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types). + // parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) + // . // // This member is required. Name *string // The value or values to be used for the specified parameter. For the list of // values you can use with each parameter, see Supported resource types and - // parameters - // (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types). + // parameters (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types) + // . Values []string noSmithyDocumentSerde @@ -168,8 +166,8 @@ type GroupIdentifier struct { noSmithyDocumentSerde } -// A mapping of a query attached to a resource group that determines the Amazon Web -// Services resources that are members of the group. +// A mapping of a query attached to a resource group that determines the Amazon +// Web Services resources that are members of the group. type GroupQuery struct { // The name of the resource group that is associated with the specified resource @@ -194,17 +192,17 @@ type ListGroupResourcesItem struct { // A structure that contains the ARN of a resource and its resource type. Identifier *ResourceIdentifier - // A structure that contains the status of this resource's membership in the group. - // This field is present in the response only if the group is of type - // AWS::EC2::HostManagement. + // A structure that contains the status of this resource's membership in the + // group. This field is present in the response only if the group is of type + // AWS::EC2::HostManagement . Status *ResourceStatus noSmithyDocumentSerde } -// A structure that identifies a resource that is currently pending addition to the -// group as a member. Adding a resource to a resource group happens asynchronously -// as a background task and this one isn't completed yet. +// A structure that identifies a resource that is currently pending addition to +// the group as a member. Adding a resource to a resource group happens +// asynchronously as a background task and this one isn't completed yet. type PendingResource struct { // The Amazon resource name (ARN) of the resource that's in a pending state. @@ -226,15 +224,15 @@ type QueryError struct { // A message that explains the ErrorCode value. Messages might state that the // specified CloudFront stack does not exist (or no longer exists). For - // CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFront - // stack has a status that is not (or no longer) active, such as CREATE_FAILED. + // CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFront + // stack has a status that is not (or no longer) active, such as CREATE_FAILED . Message *string noSmithyDocumentSerde } -// A filter name and value pair that is used to obtain more specific results from a -// list of resources. +// A filter name and value pair that is used to obtain more specific results from +// a list of resources. type ResourceFilter struct { // The name of the filter. Filter names are case-sensitive. @@ -257,7 +255,7 @@ type ResourceIdentifier struct { // The ARN of a resource. ResourceArn *string - // The resource type of a resource, such as AWS::EC2::Instance. + // The resource type of a resource, such as AWS::EC2::Instance . ResourceType *string noSmithyDocumentSerde @@ -267,104 +265,75 @@ type ResourceIdentifier struct { // ResourceQuery specifies both a query Type and a Query string as JSON string // objects. See the examples section for example JSON strings. For more information // about creating a resource group with a resource query, see Build queries and -// groups in Resource Groups -// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html) in -// the Resource Groups User Guide When you combine all of the elements together +// groups in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html) +// in the Resource Groups User Guide When you combine all of the elements together // into a single string, any double quotes that are embedded inside another double // quote pair must be escaped by preceding the embedded double quote with a -// backslash character (\). For example, a complete ResourceQuery parameter must be -// formatted like the following CLI parameter example: --resource-query +// backslash character (\). For example, a complete ResourceQuery parameter must +// be formatted like the following CLI parameter example: --resource-query // '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}' // In the preceding example, all of the double quote characters in the value part // of the Query element must be escaped because the value itself is surrounded by -// double quotes. For more information, see Quoting strings -// (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) +// double quotes. For more information, see Quoting strings (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) // in the Command Line Interface User Guide. For the complete list of resource -// types that you can use in the array value for ResourceTypeFilters, see Resources -// you can use with Resource Groups and Tag Editor -// (https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html) in -// the Resource Groups User Guide. For example: +// types that you can use in the array value for ResourceTypeFilters , see +// Resources you can use with Resource Groups and Tag Editor (https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html) +// in the Resource Groups User Guide. For example: // "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"] type ResourceQuery struct { - // The query that defines a group or a search. The contents depends on the value of - // the Type element. - // - // * ResourceTypeFilters – Applies to all ResourceQuery objects - // of either Type. This element contains one of the following two items: - // - // * The - // value AWS::AllSupported. This causes the ResourceQuery to match resources of any - // resource type that also match the query. - // - // * A list (a JSON array) of resource - // type identifiers that limit the query to only resources of the specified types. - // For the complete list of resource types that you can use in the array value for - // ResourceTypeFilters, see Resources you can use with Resource Groups and Tag - // Editor - // (https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html) in - // the Resource Groups User Guide. - // - // Example: "ResourceTypeFilters": - // ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", - // "AWS::S3::Bucket"] - // - // * TagFilters – applicable only if Type = TAG_FILTERS_1_0. - // The Query contains a JSON string that represents a collection of simple tag - // filters. The JSON string uses a syntax similar to the GetResources - // (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) - // operation, but uses only the ResourceTypeFilters - // (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters) - // and TagFilters - // (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters) - // fields. If you specify more than one tag key, only resources that match all tag - // keys, and at least one value of each specified tag key, are returned in your - // query. If you specify more than one value for a tag key, a resource matches the - // filter if it has a tag key value that matches any of the specified values. For - // example, consider the following sample query for resources that have two tags, - // Stage and Version, with two values each: - // [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource - // query could include the following. - // - // * An Amazon EC2 instance that has the - // following two tags: {"Stage":"Deploy"}, and {"Version":"2"} - // - // * An S3 bucket that - // has the following two tags: {"Stage":"Test"}, and {"Version":"1"} - // - // The resource - // query results would not include the following items in the results, however. - // - // * - // An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}. The - // instance does not have all of the tag keys specified in the filter, so it is - // excluded from the results. - // - // * An RDS database that has the following two tags: - // {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, - // but none of those keys has an associated value that matches at least one of the - // specified values in the filter. - // - // Example: "TagFilters": [ { "Key": "Stage", - // "Values": [ "Gamma", "Beta" ] } - // - // * StackIdentifier – applicable only if Type = - // CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource - // Name (ARN) of the CloudFormation stack whose resources you want included in the - // group. + // The query that defines a group or a search. The contents depends on the value + // of the Type element. + // - ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . + // This element contains one of the following two items: + // - The value AWS::AllSupported . This causes the ResourceQuery to match + // resources of any resource type that also match the query. + // - A list (a JSON array) of resource type identifiers that limit the query to + // only resources of the specified types. For the complete list of resource types + // that you can use in the array value for ResourceTypeFilters , see Resources + // you can use with Resource Groups and Tag Editor (https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html) + // in the Resource Groups User Guide. Example: "ResourceTypeFilters": + // ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", + // "AWS::S3::Bucket"] + // - TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains + // a JSON string that represents a collection of simple tag filters. The JSON + // string uses a syntax similar to the GetResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) + // operation, but uses only the ResourceTypeFilters (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters) + // and TagFilters (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters) + // fields. If you specify more than one tag key, only resources that match all tag + // keys, and at least one value of each specified tag key, are returned in your + // query. If you specify more than one value for a tag key, a resource matches the + // filter if it has a tag key value that matches any of the specified values. For + // example, consider the following sample query for resources that have two tags, + // Stage and Version , with two values each: + // [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this + // resource query could include the following. + // - An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"} , + // and {"Version":"2"} + // - An S3 bucket that has the following two tags: {"Stage":"Test"} , and + // {"Version":"1"} The resource query results would not include the following + // items in the results, however. + // - An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"} . + // The instance does not have all of the tag keys specified in the filter, so it is + // excluded from the results. + // - An RDS database that has the following two tags: {"Stage":"Archived"} and + // {"Version":"4"} The database has all of the tag keys, but none of those keys + // has an associated value that matches at least one of the specified values in the + // filter. Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", + // "Beta" ] } + // - StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The + // value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation + // stack whose resources you want included in the group. // // This member is required. Query *string // The type of the query to perform. This can have one of two values: - // - // * - // CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the - // members of an CloudFormation stack. The Query contains a StackIdentifier element - // with an ARN for a CloudFormation stack. - // - // * TAG_FILTERS_1_0: Specifies that you - // want the group to include resource that have tags that match the query. + // - CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the + // members of an CloudFormation stack. The Query contains a StackIdentifier + // element with an ARN for a CloudFormation stack. + // - TAG_FILTERS_1_0: Specifies that you want the group to include resource that + // have tags that match the query. // // This member is required. Type QueryType @@ -374,8 +343,8 @@ type ResourceQuery struct { // A structure that identifies the current group membership status for a resource. // Adding a resource to a resource group is performed asynchronously as a -// background task. A PENDING status indicates, for this resource, that the process -// isn't completed yet. +// background task. A PENDING status indicates, for this resource, that the +// process isn't completed yet. type ResourceStatus struct { // The current status. diff --git a/service/resourcegroupstaggingapi/api_client.go b/service/resourcegroupstaggingapi/api_client.go index a7570526213..9b4464de0f3 100644 --- a/service/resourcegroupstaggingapi/api_client.go +++ b/service/resourcegroupstaggingapi/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go index 0dca975b88c..1ee2445f5d5 100644 --- a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go +++ b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go @@ -45,18 +45,12 @@ type DescribeReportCreationOutput struct { // Reports the status of the operation. The operation status can be one of the // following: - // - // * RUNNING - Report creation is in progress. - // - // * SUCCEEDED - Report - // creation is complete. You can open the report from the Amazon S3 bucket that you - // specified when you ran StartReportCreation. - // - // * FAILED - Report creation timed - // out or the Amazon S3 bucket is not accessible. - // - // * NO REPORT - No report was - // generated in the last 90 days. + // - RUNNING - Report creation is in progress. + // - SUCCEEDED - Report creation is complete. You can open the report from the + // Amazon S3 bucket that you specified when you ran StartReportCreation . + // - FAILED - Report creation timed out or the Amazon S3 bucket is not + // accessible. + // - NO REPORT - No report was generated in the last 90 days. Status *string // Metadata pertaining to the operation's result. diff --git a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go index 84f863a4a56..80f6ec752df 100644 --- a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go +++ b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go @@ -13,8 +13,7 @@ import ( ) // Returns a table that shows counts of resources that are noncompliant with their -// tag policies. For more information on tag policies, see Tag Policies -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) +// tag policies. For more information on tag policies, see Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) // in the Organizations User Guide. You can call this operation only from the // organization's management account and from the us-east-1 Region. This operation // supports pagination, where the response can be sent in multiple pages. You @@ -40,14 +39,15 @@ func (c *Client) GetComplianceSummary(ctx context.Context, params *GetCompliance type GetComplianceSummaryInput struct { - // Specifies a list of attributes to group the counts of noncompliant resources by. - // If supplied, the counts are sorted by those attributes. + // Specifies a list of attributes to group the counts of noncompliant resources + // by. If supplied, the counts are sorted by those attributes. GroupBy []types.GroupByAttribute - // Specifies the maximum number of results to be returned in each page. A query can - // return fewer than this maximum, even if there are more results still to return. - // You should always check the PaginationToken response value to see if there are - // more results. You can specify a minimum of 1 and a maximum value of 100. + // Specifies the maximum number of results to be returned in each page. A query + // can return fewer than this maximum, even if there are more results still to + // return. You should always check the PaginationToken response value to see if + // there are more results. You can specify a minimum of 1 and a maximum value of + // 100. MaxResults *int32 // Specifies a PaginationToken response value from a previous request to indicate @@ -62,30 +62,23 @@ type GetComplianceSummaryInput struct { // Specifies that you want the response to include information for only resources // of the specified types. The format of each resource type is - // service[:resourceType]. For example, specifying a resource type of ec2 returns + // service[:resourceType] . For example, specifying a resource type of ec2 returns // all Amazon EC2 resources (which includes EC2 instances). Specifying a resource // type of ec2:instance returns only EC2 instances. The string for each service // name and resource type is the same as that embedded in a resource's Amazon - // Resource Name (ARN). Consult the Amazon Web Services General Reference - // (https://docs.aws.amazon.com/general/latest/gr/) for the following: - // - // * For a - // list of service name strings, see Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces). - // - // * - // For resource type strings, see Example ARNs - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax). - // - // * - // For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web - // Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - // - // You - // can specify multiple resource types by using a comma separated array. The array - // can include up to 100 items. Note that the length constraint requirement applies - // to each resource type filter. + // Resource Name (ARN). Consult the Amazon Web Services General Reference (https://docs.aws.amazon.com/general/latest/gr/) + // for the following: + // - For a list of service name strings, see Amazon Web Services Service + // Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) + // . + // - For resource type strings, see Example ARNs (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax) + // . + // - For more information about ARNs, see Amazon Resource Names (ARNs) and + // Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // . + // You can specify multiple resource types by using a comma separated array. The + // array can include up to 100 items. Note that the length constraint requirement + // applies to each resource type filter. ResourceTypeFilters []string // Specifies that you want the response to include information for only resources @@ -94,9 +87,9 @@ type GetComplianceSummaryInput struct { // specified tag keys. TagKeyFilters []string - // Specifies target identifiers (usually, specific account IDs) to limit the output - // by. If you use this parameter, the count of returned noncompliant resources - // includes only resources with the specified target IDs. + // Specifies target identifiers (usually, specific account IDs) to limit the + // output by. If you use this parameter, the count of returned noncompliant + // resources includes only resources with the specified target IDs. TargetIdFilters []string noSmithyDocumentSerde @@ -189,10 +182,11 @@ var _ GetComplianceSummaryAPIClient = (*Client)(nil) // GetComplianceSummaryPaginatorOptions is the paginator options for // GetComplianceSummary type GetComplianceSummaryPaginatorOptions struct { - // Specifies the maximum number of results to be returned in each page. A query can - // return fewer than this maximum, even if there are more results still to return. - // You should always check the PaginationToken response value to see if there are - // more results. You can specify a minimum of 1 and a maximum value of 100. + // Specifies the maximum number of results to be returned in each page. A query + // can return fewer than this maximum, even if there are more results still to + // return. You should always check the PaginationToken response value to see if + // there are more results. You can specify a minimum of 1 and a maximum value of + // 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourcegroupstaggingapi/api_op_GetResources.go b/service/resourcegroupstaggingapi/api_op_GetResources.go index af56d4d7396..e94d530dd3e 100644 --- a/service/resourcegroupstaggingapi/api_op_GetResources.go +++ b/service/resourcegroupstaggingapi/api_op_GetResources.go @@ -15,23 +15,18 @@ import ( // Returns all the tagged or previously tagged resources that are located in the // specified Amazon Web Services Region for the account. Depending on what // information you want returned, you can also specify the following: +// - Filters that specify what tags and resource types you want returned. The +// response includes all tags that are associated with the requested resources. +// - Information about compliance with the account's effective tag policy. For +// more information on tag policies, see Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) +// in the Organizations User Guide. // -// * Filters -// that specify what tags and resource types you want returned. The response -// includes all tags that are associated with the requested resources. -// -// * -// Information about compliance with the account's effective tag policy. For more -// information on tag policies, see Tag Policies -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) -// in the Organizations User Guide. -// -// This operation supports pagination, where the -// response can be sent in multiple pages. You should check the PaginationToken -// response parameter to determine if there are additional results available to -// return. Repeat the query, passing the PaginationToken response parameter value -// as an input to the next request until you recieve a null value. A null value for -// PaginationToken indicates that there are no more results waiting to be returned. +// This operation supports pagination, where the response can be sent in multiple +// pages. You should check the PaginationToken response parameter to determine if +// there are additional results available to return. Repeat the query, passing the +// PaginationToken response parameter value as an input to the next request until +// you recieve a null value. A null value for PaginationToken indicates that there +// are no more results waiting to be returned. func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, optFns ...func(*Options)) (*GetResourcesOutput, error) { if params == nil { params = &GetResourcesInput{} @@ -50,14 +45,14 @@ func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, op type GetResourcesInput struct { // Specifies whether to exclude resources that are compliant with the tag policy. - // Set this to true if you are interested in retrieving information on noncompliant - // resources only. You can use this parameter only if the IncludeComplianceDetails - // parameter is also set to true. + // Set this to true if you are interested in retrieving information on + // noncompliant resources only. You can use this parameter only if the + // IncludeComplianceDetails parameter is also set to true . ExcludeCompliantResources *bool - // Specifies whether to include details regarding the compliance with the effective - // tag policy. Set this to true to determine whether resources are compliant with - // the tag policy and to get details. + // Specifies whether to include details regarding the compliance with the + // effective tag policy. Set this to true to determine whether resources are + // compliant with the tag policy and to get details. IncludeComplianceDetails *bool // Specifies a PaginationToken response value from a previous request to indicate @@ -66,37 +61,36 @@ type GetResourcesInput struct { PaginationToken *string // Specifies a list of ARNs of resources for which you want to retrieve tag data. - // You can't specify both this parameter and any of the pagination parameters - // (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you - // specify both, you get an Invalid Parameter exception. If a resource specified by - // this parameter doesn't exist, it doesn't generate an error; it simply isn't + // You can't specify both this parameter and any of the pagination parameters ( + // ResourcesPerPage , TagsPerPage , PaginationToken ) in the same request. If you + // specify both, you get an Invalid Parameter exception. If a resource specified + // by this parameter doesn't exist, it doesn't generate an error; it simply isn't // included in the response. An ARN (Amazon Resource Name) uniquely identifies a // resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web - // Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. ResourceARNList []string // Specifies the resource types that you want included in the response. The format - // of each resource type is service[:resourceType]. For example, specifying a + // of each resource type is service[:resourceType] . For example, specifying a // resource type of ec2 returns all Amazon EC2 resources (which includes EC2 // instances). Specifying a resource type of ec2:instance returns only EC2 // instances. The string for each service name and resource type is the same as // that embedded in a resource's Amazon Resource Name (ARN). For the list of // services whose resources you can use in this parameter, see Services that - // support the Resource Groups Tagging API - // (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html). - // You can specify multiple resource types by using an array. The array can include - // up to 100 items. Note that the length constraint requirement applies to each - // resource type filter. For example, the following string would limit the response - // to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource: - // ec2:instance,s3:bucket,auditmanager + // support the Resource Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html) + // . You can specify multiple resource types by using an array. The array can + // include up to 100 items. Note that the length constraint requirement applies to + // each resource type filter. For example, the following string would limit the + // response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager + // resource: ec2:instance,s3:bucket,auditmanager ResourceTypeFilters []string - // Specifies the maximum number of results to be returned in each page. A query can - // return fewer than this maximum, even if there are more results still to return. - // You should always check the PaginationToken response value to see if there are - // more results. You can specify a minimum of 1 and a maximum value of 100. + // Specifies the maximum number of results to be returned in each page. A query + // can return fewer than this maximum, even if there are more results still to + // return. You should always check the PaginationToken response value to see if + // there are more results. You can specify a minimum of 1 and a maximum value of + // 100. ResourcesPerPage *int32 // Specifies a list of TagFilters (keys and values) to restrict the output to only @@ -104,55 +98,41 @@ type GetResourcesInput struct { // specified values. Each TagFilter must contain a key with values optional. A // request can include up to 50 keys, and each key can include up to 20 values. // Note the following when deciding how to use TagFilters: - // - // * If you don't specify - // a TagFilter, the response includes all resources that are currently tagged or - // ever had a tag. Resources that currently don't have tags are shown with an empty - // tag set, like this: "Tags": []. - // - // * If you specify more than one filter in a - // single request, the response returns only those resources that satisfy all - // filters. - // - // * If you specify a filter that contains more than one value for a key, - // the response returns resources that match any of the specified values for that - // key. - // - // * If you don't specify a value for a key, the response returns all - // resources that are tagged with that key, with any or no value. For example, for - // the following filters: filter1= {keyA,{value1}}, - // filter2={keyB,{value2,value3,value4}}, filter3= {keyC}: - // - // * - // GetResources({filter1}) returns resources tagged with key1=value1 - // - // * - // GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 - // or key2=value4 - // - // * GetResources({filter3}) returns resources tagged with any tag - // with the key key3, and with any or no value - // - // * - // GetResources({filter1,filter2,filter3}) returns resources tagged with - // (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or - // no value) + // - If you don't specify a TagFilter , the response includes all resources that + // are currently tagged or ever had a tag. Resources that currently don't have tags + // are shown with an empty tag set, like this: "Tags": [] . + // - If you specify more than one filter in a single request, the response + // returns only those resources that satisfy all filters. + // - If you specify a filter that contains more than one value for a key, the + // response returns resources that match any of the specified values for that key. + // - If you don't specify a value for a key, the response returns all resources + // that are tagged with that key, with any or no value. For example, for the + // following filters: filter1= {keyA,{value1}} , + // filter2={keyB,{value2,value3,value4}} , filter3= {keyC} : + // - GetResources({filter1}) returns resources tagged with key1=value1 + // - GetResources({filter2}) returns resources tagged with key2=value2 or + // key2=value3 or key2=value4 + // - GetResources({filter3}) returns resources tagged with any tag with the key + // key3 , and with any or no value + // - GetResources({filter1,filter2,filter3}) returns resources tagged with + // (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or + // no value) TagFilters []types.TagFilter - // Amazon Web Services recommends using ResourcesPerPage instead of this parameter. - // A limit that restricts the number of tags (key and value pairs) returned by - // GetResources in paginated output. A resource with no tags is counted as having - // one tag (one key and value pair). GetResources does not split a resource and its - // associated tags across pages. If the specified TagsPerPage would cause such a - // break, a PaginationToken is returned in place of the affected resource and its - // tags. Use that token in another request to get the remaining data. For example, - // if you specify a TagsPerPage of 100 and the account has 22 resources with 10 - // tags each (meaning that each resource has 10 key and value pairs), the output - // will consist of three pages. The first page displays the first 10 resources, - // each with its 10 tags. The second page displays the next 10 resources, each with - // its 10 tags. The third page displays the remaining 2 resources, each with its 10 - // tags. You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 - // items. + // Amazon Web Services recommends using ResourcesPerPage instead of this + // parameter. A limit that restricts the number of tags (key and value pairs) + // returned by GetResources in paginated output. A resource with no tags is + // counted as having one tag (one key and value pair). GetResources does not split + // a resource and its associated tags across pages. If the specified TagsPerPage + // would cause such a break, a PaginationToken is returned in place of the + // affected resource and its tags. Use that token in another request to get the + // remaining data. For example, if you specify a TagsPerPage of 100 and the + // account has 22 resources with 10 tags each (meaning that each resource has 10 + // key and value pairs), the output will consist of three pages. The first page + // displays the first 10 resources, each with its 10 tags. The second page displays + // the next 10 resources, each with its 10 tags. The third page displays the + // remaining 2 resources, each with its 10 tags. You can set TagsPerPage to a + // minimum of 100 items up to a maximum of 500 items. TagsPerPage *int32 noSmithyDocumentSerde @@ -243,10 +223,11 @@ var _ GetResourcesAPIClient = (*Client)(nil) // GetResourcesPaginatorOptions is the paginator options for GetResources type GetResourcesPaginatorOptions struct { - // Specifies the maximum number of results to be returned in each page. A query can - // return fewer than this maximum, even if there are more results still to return. - // You should always check the PaginationToken response value to see if there are - // more results. You can specify a minimum of 1 and a maximum value of 100. + // Specifies the maximum number of results to be returned in each page. A query + // can return fewer than this maximum, even if there are more results still to + // return. You should always check the PaginationToken response value to see if + // there are more results. You can specify a minimum of 1 and a maximum value of + // 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourcegroupstaggingapi/api_op_GetTagKeys.go b/service/resourcegroupstaggingapi/api_op_GetTagKeys.go index ee55df4f207..b9fbe9008d5 100644 --- a/service/resourcegroupstaggingapi/api_op_GetTagKeys.go +++ b/service/resourcegroupstaggingapi/api_op_GetTagKeys.go @@ -16,8 +16,9 @@ import ( // response can be sent in multiple pages. You should check the PaginationToken // response parameter to determine if there are additional results available to // return. Repeat the query, passing the PaginationToken response parameter value -// as an input to the next request until you recieve a null value. A null value for -// PaginationToken indicates that there are no more results waiting to be returned. +// as an input to the next request until you recieve a null value. A null value +// for PaginationToken indicates that there are no more results waiting to be +// returned. func (c *Client) GetTagKeys(ctx context.Context, params *GetTagKeysInput, optFns ...func(*Options)) (*GetTagKeysOutput, error) { if params == nil { params = &GetTagKeysInput{} diff --git a/service/resourcegroupstaggingapi/api_op_TagResources.go b/service/resourcegroupstaggingapi/api_op_TagResources.go index 982ff5b946c..377dd905ca4 100644 --- a/service/resourcegroupstaggingapi/api_op_TagResources.go +++ b/service/resourcegroupstaggingapi/api_op_TagResources.go @@ -12,43 +12,31 @@ import ( ) // Applies one or more tags to the specified resources. Note the following: +// - Not all resources can have tags. For a list of services with resources that +// support tagging using this operation, see Services that support the Resource +// Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html) +// . If the resource doesn't yet support this operation, the resource's service +// might support tagging using its own API operations. For more information, refer +// to the documentation for that service. +// - Each resource can have up to 50 tags. For other limits, see Tag Naming and +// Usage Conventions (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) +// in the Amazon Web Services General Reference. +// - You can only tag resources that are located in the specified Amazon Web +// Services Region for the Amazon Web Services account. +// - To add tags to a resource, you need the necessary permissions for the +// service that the resource belongs to as well as permissions for adding tags. For +// more information, see the documentation for each service. // -// * Not -// all resources can have tags. For a list of services with resources that support -// tagging using this operation, see Services that support the Resource Groups -// Tagging API -// (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html). -// If the resource doesn't yet support this operation, the resource's service might -// support tagging using its own API operations. For more information, refer to the -// documentation for that service. -// -// * Each resource can have up to 50 tags. For -// other limits, see Tag Naming and Usage Conventions -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) -// in the Amazon Web Services General Reference. -// -// * You can only tag resources that -// are located in the specified Amazon Web Services Region for the Amazon Web -// Services account. -// -// * To add tags to a resource, you need the necessary -// permissions for the service that the resource belongs to as well as permissions -// for adding tags. For more information, see the documentation for each -// service. -// -// Do not store personally identifiable information (PII) or other -// confidential or sensitive information in tags. We use tags to provide you with -// billing and administration services. Tags are not intended to be used for -// private or sensitive data. Minimum permissions In addition to the -// tag:TagResources permission required by this operation, you must also have the -// tagging permission defined by the service that created the resource. For -// example, to tag an Amazon EC2 instance using the TagResources operation, you -// must have both of the following permissions: -// -// * tag:TagResource -// -// * -// ec2:CreateTags +// Do not store personally identifiable information (PII) or other confidential or +// sensitive information in tags. We use tags to provide you with billing and +// administration services. Tags are not intended to be used for private or +// sensitive data. Minimum permissions In addition to the tag:TagResources +// permission required by this operation, you must also have the tagging permission +// defined by the service that created the resource. For example, to tag an Amazon +// EC2 instance using the TagResources operation, you must have both of the +// following permissions: +// - tag:TagResource +// - ec2:CreateTags func (c *Client) TagResources(ctx context.Context, params *TagResourcesInput, optFns ...func(*Options)) (*TagResourcesOutput, error) { if params == nil { params = &TagResourcesInput{} @@ -68,9 +56,8 @@ type TagResourcesInput struct { // Specifies the list of ARNs of the resources that you want to apply tags to. An // ARN (Amazon Resource Name) uniquely identifies a resource. For more information, - // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceARNList []string diff --git a/service/resourcegroupstaggingapi/api_op_UntagResources.go b/service/resourcegroupstaggingapi/api_op_UntagResources.go index 0ce1d7b3947..782afb7d060 100644 --- a/service/resourcegroupstaggingapi/api_op_UntagResources.go +++ b/service/resourcegroupstaggingapi/api_op_UntagResources.go @@ -15,26 +15,20 @@ import ( // key, the action removes both that key and its associated value. The operation // succeeds even if you attempt to remove tags from a resource that were already // removed. Note the following: +// - To remove tags from a resource, you need the necessary permissions for the +// service that the resource belongs to as well as permissions for removing tags. +// For more information, see the documentation for the service whose resource you +// want to untag. +// - You can only tag resources that are located in the specified Amazon Web +// Services Region for the calling Amazon Web Services account. // -// * To remove tags from a resource, you need the -// necessary permissions for the service that the resource belongs to as well as -// permissions for removing tags. For more information, see the documentation for -// the service whose resource you want to untag. -// -// * You can only tag resources that -// are located in the specified Amazon Web Services Region for the calling Amazon -// Web Services account. -// -// Minimum permissions In addition to the tag:UntagResources -// permission required by this operation, you must also have the remove tags -// permission defined by the service that created the resource. For example, to -// remove the tags from an Amazon EC2 instance using the UntagResources operation, -// you must have both of the following permissions: -// -// * tag:UntagResource -// -// * -// ec2:DeleteTags +// Minimum permissions In addition to the tag:UntagResources permission required +// by this operation, you must also have the remove tags permission defined by the +// service that created the resource. For example, to remove the tags from an +// Amazon EC2 instance using the UntagResources operation, you must have both of +// the following permissions: +// - tag:UntagResource +// - ec2:DeleteTags func (c *Client) UntagResources(ctx context.Context, params *UntagResourcesInput, optFns ...func(*Options)) (*UntagResourcesOutput, error) { if params == nil { params = &UntagResourcesInput{} @@ -54,9 +48,8 @@ type UntagResourcesInput struct { // Specifies a list of ARNs of the resources that you want to remove tags from. An // ARN (Amazon Resource Name) uniquely identifies a resource. For more information, - // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceARNList []string diff --git a/service/resourcegroupstaggingapi/types/enums.go b/service/resourcegroupstaggingapi/types/enums.go index 19fd7a5cf61..5ae5dfdac41 100644 --- a/service/resourcegroupstaggingapi/types/enums.go +++ b/service/resourcegroupstaggingapi/types/enums.go @@ -10,9 +10,9 @@ const ( ErrorCodeInvalidParameterException ErrorCode = "InvalidParameterException" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "InternalServiceException", @@ -49,9 +49,9 @@ const ( TargetIdTypeRoot TargetIdType = "ROOT" ) -// Values returns all known values for TargetIdType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetIdType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetIdType) Values() []TargetIdType { return []TargetIdType{ "ACCOUNT", diff --git a/service/resourcegroupstaggingapi/types/errors.go b/service/resourcegroupstaggingapi/types/errors.go index 48e8b29c28d..e53cad8aa8b 100644 --- a/service/resourcegroupstaggingapi/types/errors.go +++ b/service/resourcegroupstaggingapi/types/errors.go @@ -37,20 +37,15 @@ func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault { retur // The request was denied because performing this operation violates a constraint. // Some of the reasons in the following list might not apply to this specific // operation. -// -// * You must meet the prerequisites for using tag policies. For -// information, see Prerequisites and Permissions for Using Tag Policies -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html) -// in the Organizations User Guide. -// -// * You must enable the tag policies service -// principal (tagpolicies.tag.amazonaws.com) to integrate with Organizations For -// information, see EnableAWSServiceAccess -// (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html). -// -// * -// You must have a tag policy attached to the organization root, an OU, or an -// account. +// - You must meet the prerequisites for using tag policies. For information, +// see Prerequisites and Permissions for Using Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html) +// in the Organizations User Guide. +// - You must enable the tag policies service principal ( +// tagpolicies.tag.amazonaws.com ) to integrate with Organizations For +// information, see EnableAWSServiceAccess (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html) +// . +// - You must have a tag policy attached to the organization root, an OU, or an +// account. type ConstraintViolationException struct { Message *string @@ -104,23 +99,14 @@ func (e *InternalServiceException) ErrorCode() string { func (e *InternalServiceException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // This error indicates one of the following: -// -// * A parameter is missing. -// -// * A -// malformed string was supplied for the request parameter. -// -// * An out-of-range -// value was supplied for the request parameter. -// -// * The target ID is invalid, -// unsupported, or doesn't exist. -// -// * You can't access the Amazon S3 bucket for -// report storage. For more information, see Additional Requirements for -// Organization-wide Tag Compliance Reports -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) -// in the Organizations User Guide. +// - A parameter is missing. +// - A malformed string was supplied for the request parameter. +// - An out-of-range value was supplied for the request parameter. +// - The target ID is invalid, unsupported, or doesn't exist. +// - You can't access the Amazon S3 bucket for report storage. For more +// information, see Additional Requirements for Organization-wide Tag Compliance +// Reports (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report) +// in the Organizations User Guide. type InvalidParameterException struct { Message *string diff --git a/service/resourcegroupstaggingapi/types/types.go b/service/resourcegroupstaggingapi/types/types.go index c1222b9e1ca..cb3b81aa3ae 100644 --- a/service/resourcegroupstaggingapi/types/types.go +++ b/service/resourcegroupstaggingapi/types/types.go @@ -29,31 +29,25 @@ type ComplianceDetails struct { // Services service that hosts the resource that the ARN key represents. The // following are common error codes that you might receive from other Amazon Web // Services services: +// - InternalServiceException – This can mean that the Resource Groups Tagging +// API didn't receive a response from another Amazon Web Services service. It can +// also mean that the resource type in the request is not supported by the Resource +// Groups Tagging API. In these cases, it's safe to retry the request and then call +// GetResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) +// to verify the changes. +// - AccessDeniedException – This can mean that you need permission to call the +// tagging operations in the Amazon Web Services service that contains the +// resource. For example, to use the Resource Groups Tagging API to tag a Amazon +// CloudWatch alarm resource, you need permission to call both TagResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html) +// and TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) +// in the CloudWatch API. // -// * InternalServiceException – This can mean that the Resource -// Groups Tagging API didn't receive a response from another Amazon Web Services -// service. It can also mean that the resource type in the request is not supported -// by the Resource Groups Tagging API. In these cases, it's safe to retry the -// request and then call GetResources -// (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html) -// to verify the changes. -// -// * AccessDeniedException – This can mean that you need -// permission to call the tagging operations in the Amazon Web Services service -// that contains the resource. For example, to use the Resource Groups Tagging API -// to tag a Amazon CloudWatch alarm resource, you need permission to call both -// TagResources -// (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html) -// and TagResource -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) -// in the CloudWatch API. -// -// For more information on errors that are generated from -// other Amazon Web Services services, see the documentation for that service. +// For more information on errors that are generated from other Amazon Web +// Services services, see the documentation for that service. type FailureInfo struct { - // The code of the common error. Valid values include InternalServiceException, - // InvalidParameterException, and any valid error code returned by the Amazon Web + // The code of the common error. Valid values include InternalServiceException , + // InvalidParameterException , and any valid error code returned by the Amazon Web // Services service that hosts the resource that you want to tag. ErrorCode ErrorCode @@ -99,8 +93,7 @@ type Summary struct { ResourceType *string // The account identifier or the root identifier of the organization. If you don't - // know the root ID, you can call the Organizations ListRoots - // (https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html) + // know the root ID, you can call the Organizations ListRoots (https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html) // API. TargetId *string diff --git a/service/robomaker/api_client.go b/service/robomaker/api_client.go index 416ac9ee576..718fd56623a 100644 --- a/service/robomaker/api_client.go +++ b/service/robomaker/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/robomaker/api_op_CancelDeploymentJob.go b/service/robomaker/api_op_CancelDeploymentJob.go index c45b893287f..1d7a5c71898 100644 --- a/service/robomaker/api_op_CancelDeploymentJob.go +++ b/service/robomaker/api_op_CancelDeploymentJob.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels the specified deployment job. This API will no longer be supported as of -// May 2, 2022. Use it to remove resources that were created for Deployment +// Cancels the specified deployment job. This API will no longer be supported as +// of May 2, 2022. Use it to remove resources that were created for Deployment // Service. // // Deprecated: Support for the AWS RoboMaker application deployment feature has diff --git a/service/robomaker/api_op_CreateDeploymentJob.go b/service/robomaker/api_op_CreateDeploymentJob.go index 69247137f98..f21bd0668f6 100644 --- a/service/robomaker/api_op_CreateDeploymentJob.go +++ b/service/robomaker/api_op_CreateDeploymentJob.go @@ -13,13 +13,12 @@ import ( "time" ) -// Deploys a specific version of a robot application to robots in a fleet. This API -// is no longer supported and will throw an error if used. The robot application -// must have a numbered applicationVersion for consistency reasons. To create a new -// version, use CreateRobotApplicationVersion or see Creating a Robot Application -// Version -// (https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html). -// After 90 days, deployment jobs expire and will be deleted. They will no longer +// Deploys a specific version of a robot application to robots in a fleet. This +// API is no longer supported and will throw an error if used. The robot +// application must have a numbered applicationVersion for consistency reasons. To +// create a new version, use CreateRobotApplicationVersion or see Creating a Robot +// Application Version (https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html) +// . After 90 days, deployment jobs expire and will be deleted. They will no longer // be accessible. // // Deprecated: AWS RoboMaker is unable to process this request as the support for @@ -84,9 +83,8 @@ type CreateDeploymentJobOutput struct { // The failure code of the simulation job if it failed: BadPermissionError AWS // Greengrass requires a service-level role permission to access other services. - // The role must include the AWSGreengrassResourceAccessRolePolicy managed policy - // (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor). - // ExtractingBundleFailure The robot application could not be extracted from the + // The role must include the AWSGreengrassResourceAccessRolePolicy managed policy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor) + // . ExtractingBundleFailure The robot application could not be extracted from the // bundle. FailureThresholdBreached The percentage of robots that could not be // updated exceeded the percentage set for the deployment. // GreengrassDeploymentFailed The robot application could not be deployed to the diff --git a/service/robomaker/api_op_CreateRobotApplicationVersion.go b/service/robomaker/api_op_CreateRobotApplicationVersion.go index 1945fd2a8a7..5df1ddad341 100644 --- a/service/robomaker/api_op_CreateRobotApplicationVersion.go +++ b/service/robomaker/api_op_CreateRobotApplicationVersion.go @@ -35,8 +35,8 @@ type CreateRobotApplicationVersionInput struct { // This member is required. Application *string - // The current revision id for the robot application. If you provide a value and it - // matches the latest revision ID, a new version will be created. + // The current revision id for the robot application. If you provide a value and + // it matches the latest revision ID, a new version will be created. CurrentRevisionId *string // A SHA256 identifier for the Docker image that you use for your robot diff --git a/service/robomaker/api_op_CreateSimulationApplicationVersion.go b/service/robomaker/api_op_CreateSimulationApplicationVersion.go index 6e6de6e7083..6d1350b3542 100644 --- a/service/robomaker/api_op_CreateSimulationApplicationVersion.go +++ b/service/robomaker/api_op_CreateSimulationApplicationVersion.go @@ -43,8 +43,8 @@ type CreateSimulationApplicationVersionInput struct { // simulation application. ImageDigest *string - // The Amazon S3 eTag identifier for the zip file bundle that you use to create the - // simulation application. + // The Amazon S3 eTag identifier for the zip file bundle that you use to create + // the simulation application. S3Etags []string noSmithyDocumentSerde diff --git a/service/robomaker/api_op_CreateSimulationJob.go b/service/robomaker/api_op_CreateSimulationJob.go index d0bb785cc2c..19e3cc57731 100644 --- a/service/robomaker/api_op_CreateSimulationJob.go +++ b/service/robomaker/api_op_CreateSimulationJob.go @@ -40,8 +40,8 @@ type CreateSimulationJobInput struct { IamRole *string // The maximum simulation job duration in seconds (up to 14 days or 1,209,600 - // seconds. When maxJobDurationInSeconds is reached, the simulation job will status - // will transition to Completed. + // seconds. When maxJobDurationInSeconds is reached, the simulation job will + // status will transition to Completed . // // This member is required. MaxJobDurationInSeconds int64 @@ -54,7 +54,7 @@ type CreateSimulationJobInput struct { Compute *types.Compute // Specify data sources to mount read-only files from S3 into your simulation. - // These files are available under /opt/robomaker/datasources/data_source_name. + // These files are available under /opt/robomaker/datasources/data_source_name . // There is a limit of 100 files and a combined size of 25GB for all // DataSourceConfig objects. DataSources []types.DataSourceConfig diff --git a/service/robomaker/api_op_CreateWorldExportJob.go b/service/robomaker/api_op_CreateWorldExportJob.go index 0098ee4dd1a..ef9f87d8b86 100644 --- a/service/robomaker/api_op_CreateWorldExportJob.go +++ b/service/robomaker/api_op_CreateWorldExportJob.go @@ -79,8 +79,8 @@ type CreateWorldExportJobOutput struct { // the request is not valid. AllWorldGenerationFailed All of the worlds in the // world generation job failed. This can happen if your worldCount is greater than // 50 or less than 1. For more information about troubleshooting WorldForge, see - // Troubleshooting Simulation WorldForge - // (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting-worldforge.html). + // Troubleshooting Simulation WorldForge (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting-worldforge.html) + // . FailureCode types.WorldExportJobErrorCode // The IAM role that the world export process uses to access the Amazon S3 bucket diff --git a/service/robomaker/api_op_DeregisterRobot.go b/service/robomaker/api_op_DeregisterRobot.go index 44196935f0b..cbd670ce2c5 100644 --- a/service/robomaker/api_op_DeregisterRobot.go +++ b/service/robomaker/api_op_DeregisterRobot.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregisters a robot. This API will no longer be supported as of May 2, 2022. Use -// it to remove resources that were created for Deployment Service. +// Deregisters a robot. This API will no longer be supported as of May 2, 2022. +// Use it to remove resources that were created for Deployment Service. // // Deprecated: Support for the AWS RoboMaker application deployment feature has // ended. For additional information, see diff --git a/service/robomaker/api_op_DescribeSimulationJob.go b/service/robomaker/api_op_DescribeSimulationJob.go index 0528a1d62ef..ccb9818399b 100644 --- a/service/robomaker/api_op_DescribeSimulationJob.go +++ b/service/robomaker/api_op_DescribeSimulationJob.go @@ -75,8 +75,8 @@ type DescribeSimulationJobOutput struct { FailureCode types.SimulationJobErrorCode // Details about why the simulation job failed. For more information about - // troubleshooting, see Troubleshooting - // (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html). + // troubleshooting, see Troubleshooting (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html) + // . FailureReason *string // The IAM role that allows the simulation instance to call the AWS APIs that are diff --git a/service/robomaker/api_op_DescribeSimulationJobBatch.go b/service/robomaker/api_op_DescribeSimulationJobBatch.go index 66405338a35..fe75b895103 100644 --- a/service/robomaker/api_op_DescribeSimulationJobBatch.go +++ b/service/robomaker/api_op_DescribeSimulationJobBatch.go @@ -78,18 +78,18 @@ type DescribeSimulationJobBatchOutput struct { // The status of the batch. Pending The simulation job batch request is pending. // InProgress The simulation job batch is in progress. Failed The simulation job // batch failed. One or more simulation job requests could not be completed due to - // an internal failure (like InternalServiceError). See failureCode and + // an internal failure (like InternalServiceError ). See failureCode and // failureReason for more information. Completed The simulation batch job // completed. A batch is complete when (1) there are no pending simulation job // requests in the batch and none of the failed simulation job requests are due to // InternalServiceError and (2) when all created simulation jobs have reached a - // terminal state (for example, Completed or Failed). Canceled The simulation batch - // job was cancelled. Canceling The simulation batch job is being cancelled. + // terminal state (for example, Completed or Failed ). Canceled The simulation + // batch job was cancelled. Canceling The simulation batch job is being cancelled. // Completing The simulation batch job is completing. TimingOut The simulation job // batch is timing out. If a batch timing out, and there are pending requests that - // were failing due to an internal failure (like InternalServiceError), the batch - // status will be Failed. If there are no such failing request, the batch status - // will be TimedOut. TimedOut The simulation batch job timed out. + // were failing due to an internal failure (like InternalServiceError ), the batch + // status will be Failed . If there are no such failing request, the batch status + // will be TimedOut . TimedOut The simulation batch job timed out. Status types.SimulationJobBatchStatus // A map that contains tag keys and tag values that are attached to the simulation diff --git a/service/robomaker/api_op_DescribeWorldGenerationJob.go b/service/robomaker/api_op_DescribeWorldGenerationJob.go index 87249b8aee2..784670e2786 100644 --- a/service/robomaker/api_op_DescribeWorldGenerationJob.go +++ b/service/robomaker/api_op_DescribeWorldGenerationJob.go @@ -65,9 +65,9 @@ type DescribeWorldGenerationJobOutput struct { // Summary information about finished worlds. FinishedWorldsSummary *types.FinishedWorldsSummary - // The status of the world generation job: Pending The world generation job request - // is pending. Running The world generation job is running. Completed The world - // generation job completed. Failed The world generation job failed. See + // The status of the world generation job: Pending The world generation job + // request is pending. Running The world generation job is running. Completed The + // world generation job completed. Failed The world generation job failed. See // failureCode for more information. PartialFailed Some worlds did not generate. // Canceled The world generation job was cancelled. Canceling The world generation // job is being cancelled. diff --git a/service/robomaker/api_op_ListDeploymentJobs.go b/service/robomaker/api_op_ListDeploymentJobs.go index bfe7fcc21a1..ba3c3c80c07 100644 --- a/service/robomaker/api_op_ListDeploymentJobs.go +++ b/service/robomaker/api_op_ListDeploymentJobs.go @@ -41,22 +41,22 @@ type ListDeploymentJobsInput struct { // supported. When filtering, you must use the complete value of the filtered item. // You can use up to three filters, but they must be for the same named item. For // example, if you are looking for items with the status InProgress or the status - // Pending. + // Pending . Filters []types.Filter // When this parameter is used, ListDeploymentJobs only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListDeploymentJobs request - // with the returned nextToken value. This value can be between 1 and 200. If this - // parameter is not used, then ListDeploymentJobs returns up to 200 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListDeploymentJobs + // request with the returned nextToken value. This value can be between 1 and 200. + // If this parameter is not used, then ListDeploymentJobs returns up to 200 + // results and a nextToken value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListDeploymentJobs again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string noSmithyDocumentSerde @@ -70,8 +70,8 @@ type ListDeploymentJobsOutput struct { // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListDeploymentJobs again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. @@ -153,10 +153,10 @@ var _ ListDeploymentJobsAPIClient = (*Client)(nil) type ListDeploymentJobsPaginatorOptions struct { // When this parameter is used, ListDeploymentJobs only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListDeploymentJobs request - // with the returned nextToken value. This value can be between 1 and 200. If this - // parameter is not used, then ListDeploymentJobs returns up to 200 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListDeploymentJobs + // request with the returned nextToken value. This value can be between 1 and 200. + // If this parameter is not used, then ListDeploymentJobs returns up to 200 + // results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListFleets.go b/service/robomaker/api_op_ListFleets.go index 4cb51183070..1f51560ca5a 100644 --- a/service/robomaker/api_op_ListFleets.go +++ b/service/robomaker/api_op_ListFleets.go @@ -44,9 +44,9 @@ type ListFleetsInput struct { // When this parameter is used, ListFleets only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListFleets request with the - // returned nextToken value. This value can be between 1 and 200. If this parameter - // is not used, then ListFleets returns up to 200 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 200. If this + // parameter is not used, then ListFleets returns up to 200 results and a nextToken + // value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, @@ -151,9 +151,9 @@ type ListFleetsPaginatorOptions struct { // When this parameter is used, ListFleets only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListFleets request with the - // returned nextToken value. This value can be between 1 and 200. If this parameter - // is not used, then ListFleets returns up to 200 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 200. If this + // parameter is not used, then ListFleets returns up to 200 results and a nextToken + // value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListRobots.go b/service/robomaker/api_op_ListRobots.go index c03c293e4fa..67d655f8e67 100644 --- a/service/robomaker/api_op_ListRobots.go +++ b/service/robomaker/api_op_ListRobots.go @@ -40,15 +40,15 @@ type ListRobotsInput struct { // supported. When filtering, you must use the complete value of the filtered item. // You can use up to three filters, but they must be for the same named item. For // example, if you are looking for items with the status Registered or the status - // Available. + // Available . Filters []types.Filter // When this parameter is used, ListRobots only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListRobots request with the - // returned nextToken value. This value can be between 1 and 200. If this parameter - // is not used, then ListRobots returns up to 200 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 200. If this + // parameter is not used, then ListRobots returns up to 200 results and a nextToken + // value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, @@ -151,9 +151,9 @@ type ListRobotsPaginatorOptions struct { // When this parameter is used, ListRobots only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListRobots request with the - // returned nextToken value. This value can be between 1 and 200. If this parameter - // is not used, then ListRobots returns up to 200 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 200. If this + // parameter is not used, then ListRobots returns up to 200 results and a nextToken + // value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListSimulationApplications.go b/service/robomaker/api_op_ListSimulationApplications.go index 2e84ea2abb2..aba0a81cbf0 100644 --- a/service/robomaker/api_op_ListSimulationApplications.go +++ b/service/robomaker/api_op_ListSimulationApplications.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of simulation applications. You can optionally provide filters to -// retrieve specific simulation applications. +// Returns a list of simulation applications. You can optionally provide filters +// to retrieve specific simulation applications. func (c *Client) ListSimulationApplications(ctx context.Context, params *ListSimulationApplicationsInput, optFns ...func(*Options)) (*ListSimulationApplicationsOutput, error) { if params == nil { params = &ListSimulationApplicationsInput{} @@ -39,8 +39,8 @@ type ListSimulationApplicationsInput struct { // When this parameter is used, ListSimulationApplications only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another - // ListSimulationApplications request with the returned nextToken value. This value - // can be between 1 and 100. If this parameter is not used, then + // ListSimulationApplications request with the returned nextToken value. This + // value can be between 1 and 100. If this parameter is not used, then // ListSimulationApplications returns up to 100 results and a nextToken value if // applicable. MaxResults *int32 @@ -151,8 +151,8 @@ type ListSimulationApplicationsPaginatorOptions struct { // When this parameter is used, ListSimulationApplications only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another - // ListSimulationApplications request with the returned nextToken value. This value - // can be between 1 and 100. If this parameter is not used, then + // ListSimulationApplications request with the returned nextToken value. This + // value can be between 1 and 100. If this parameter is not used, then // ListSimulationApplications returns up to 100 results and a nextToken value if // applicable. Limit int32 diff --git a/service/robomaker/api_op_ListSimulationJobs.go b/service/robomaker/api_op_ListSimulationJobs.go index fb1503bd467..66b881810a8 100644 --- a/service/robomaker/api_op_ListSimulationJobs.go +++ b/service/robomaker/api_op_ListSimulationJobs.go @@ -35,22 +35,22 @@ type ListSimulationJobsInput struct { // simulationApplicationName and robotApplicationName are supported. When // filtering, you must use the complete value of the filtered item. You can use up // to three filters, but they must be for the same named item. For example, if you - // are looking for items with the status Preparing or the status Running. + // are looking for items with the status Preparing or the status Running . Filters []types.Filter // When this parameter is used, ListSimulationJobs only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListSimulationJobs request - // with the returned nextToken value. This value can be between 1 and 1000. If this - // parameter is not used, then ListSimulationJobs returns up to 1000 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListSimulationJobs + // request with the returned nextToken value. This value can be between 1 and + // 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 + // results and a nextToken value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListSimulationJobs again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string noSmithyDocumentSerde @@ -66,8 +66,8 @@ type ListSimulationJobsOutput struct { // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListSimulationJobs again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string // Metadata pertaining to the operation's result. @@ -149,10 +149,10 @@ var _ ListSimulationJobsAPIClient = (*Client)(nil) type ListSimulationJobsPaginatorOptions struct { // When this parameter is used, ListSimulationJobs only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListSimulationJobs request - // with the returned nextToken value. This value can be between 1 and 1000. If this - // parameter is not used, then ListSimulationJobs returns up to 1000 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListSimulationJobs + // request with the returned nextToken value. This value can be between 1 and + // 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 + // results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListWorldExportJobs.go b/service/robomaker/api_op_ListWorldExportJobs.go index 7c1128c3cde..d6751ae7721 100644 --- a/service/robomaker/api_op_ListWorldExportJobs.go +++ b/service/robomaker/api_op_ListWorldExportJobs.go @@ -30,22 +30,22 @@ func (c *Client) ListWorldExportJobs(ctx context.Context, params *ListWorldExpor type ListWorldExportJobsInput struct { - // Optional filters to limit results. You can use generationJobId and templateId. + // Optional filters to limit results. You can use generationJobId and templateId . Filters []types.Filter - // When this parameter is used, ListWorldExportJobs only returns maxResults results - // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListWorldExportJobs - // request with the returned nextToken value. This value can be between 1 and 100. - // If this parameter is not used, then ListWorldExportJobs returns up to 100 - // results and a nextToken value if applicable. + // When this parameter is used, ListWorldExportJobs only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another + // ListWorldExportJobs request with the returned nextToken value. This value can + // be between 1 and 100. If this parameter is not used, then ListWorldExportJobs + // returns up to 100 results and a nextToken value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve - // the next set of results, call ListWorldExportJobs again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the next set of results, call ListWorldExportJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string noSmithyDocumentSerde @@ -131,8 +131,8 @@ func (c *Client) addOperationListWorldExportJobsMiddlewares(stack *middleware.St return nil } -// ListWorldExportJobsAPIClient is a client that implements the ListWorldExportJobs -// operation. +// ListWorldExportJobsAPIClient is a client that implements the +// ListWorldExportJobs operation. type ListWorldExportJobsAPIClient interface { ListWorldExportJobs(context.Context, *ListWorldExportJobsInput, ...func(*Options)) (*ListWorldExportJobsOutput, error) } @@ -142,12 +142,12 @@ var _ ListWorldExportJobsAPIClient = (*Client)(nil) // ListWorldExportJobsPaginatorOptions is the paginator options for // ListWorldExportJobs type ListWorldExportJobsPaginatorOptions struct { - // When this parameter is used, ListWorldExportJobs only returns maxResults results - // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListWorldExportJobs - // request with the returned nextToken value. This value can be between 1 and 100. - // If this parameter is not used, then ListWorldExportJobs returns up to 100 - // results and a nextToken value if applicable. + // When this parameter is used, ListWorldExportJobs only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another + // ListWorldExportJobs request with the returned nextToken value. This value can + // be between 1 and 100. If this parameter is not used, then ListWorldExportJobs + // returns up to 100 results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListWorldGenerationJobs.go b/service/robomaker/api_op_ListWorldGenerationJobs.go index 93d2df65d1d..45717187dd9 100644 --- a/service/robomaker/api_op_ListWorldGenerationJobs.go +++ b/service/robomaker/api_op_ListWorldGenerationJobs.go @@ -30,15 +30,16 @@ func (c *Client) ListWorldGenerationJobs(ctx context.Context, params *ListWorldG type ListWorldGenerationJobsInput struct { - // Optional filters to limit results. You can use status and templateId. + // Optional filters to limit results. You can use status and templateId . Filters []types.Filter // When this parameter is used, ListWorldGeneratorJobs only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another - // ListWorldGeneratorJobs request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs - // returns up to 100 results and a nextToken value if applicable. + // ListWorldGeneratorJobs request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter is not used, then + // ListWorldGeneratorJobs returns up to 100 results and a nextToken value if + // applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, @@ -147,9 +148,10 @@ type ListWorldGenerationJobsPaginatorOptions struct { // When this parameter is used, ListWorldGeneratorJobs only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another - // ListWorldGeneratorJobs request with the returned nextToken value. This value can - // be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs - // returns up to 100 results and a nextToken value if applicable. + // ListWorldGeneratorJobs request with the returned nextToken value. This value + // can be between 1 and 100. If this parameter is not used, then + // ListWorldGeneratorJobs returns up to 100 results and a nextToken value if + // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListWorldTemplates.go b/service/robomaker/api_op_ListWorldTemplates.go index eb7e8dd3066..8107715e279 100644 --- a/service/robomaker/api_op_ListWorldTemplates.go +++ b/service/robomaker/api_op_ListWorldTemplates.go @@ -32,17 +32,17 @@ type ListWorldTemplatesInput struct { // When this parameter is used, ListWorldTemplates only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListWorldTemplates request - // with the returned nextToken value. This value can be between 1 and 100. If this - // parameter is not used, then ListWorldTemplates returns up to 100 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListWorldTemplates + // request with the returned nextToken value. This value can be between 1 and 100. + // If this parameter is not used, then ListWorldTemplates returns up to 100 + // results and a nextToken value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListWorldTemplates again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string noSmithyDocumentSerde @@ -53,8 +53,8 @@ type ListWorldTemplatesOutput struct { // If the previous paginated request did not return all of the remaining results, // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListWorldTemplates again and assign that token to - // the request object's nextToken parameter. If there are no remaining results, the - // previous response object's NextToken parameter is set to null. + // the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string // Summary information for templates. @@ -139,10 +139,10 @@ var _ ListWorldTemplatesAPIClient = (*Client)(nil) type ListWorldTemplatesPaginatorOptions struct { // When this parameter is used, ListWorldTemplates only returns maxResults results // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListWorldTemplates request - // with the returned nextToken value. This value can be between 1 and 100. If this - // parameter is not used, then ListWorldTemplates returns up to 100 results and a - // nextToken value if applicable. + // of the initial request can be seen by sending another ListWorldTemplates + // request with the returned nextToken value. This value can be between 1 and 100. + // If this parameter is not used, then ListWorldTemplates returns up to 100 + // results and a nextToken value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_ListWorlds.go b/service/robomaker/api_op_ListWorlds.go index 391d327390d..87365d2bd4e 100644 --- a/service/robomaker/api_op_ListWorlds.go +++ b/service/robomaker/api_op_ListWorlds.go @@ -30,15 +30,15 @@ func (c *Client) ListWorlds(ctx context.Context, params *ListWorldsInput, optFns type ListWorldsInput struct { - // Optional filters to limit results. You can use status. + // Optional filters to limit results. You can use status . Filters []types.Filter // When this parameter is used, ListWorlds only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListWorlds request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // is not used, then ListWorlds returns up to 100 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 100. If this + // parameter is not used, then ListWorlds returns up to 100 results and a nextToken + // value if applicable. MaxResults *int32 // If the previous paginated request did not return all of the remaining results, @@ -141,9 +141,9 @@ type ListWorldsPaginatorOptions struct { // When this parameter is used, ListWorlds only returns maxResults results in a // single page along with a nextToken response element. The remaining results of // the initial request can be seen by sending another ListWorlds request with the - // returned nextToken value. This value can be between 1 and 100. If this parameter - // is not used, then ListWorlds returns up to 100 results and a nextToken value if - // applicable. + // returned nextToken value. This value can be between 1 and 100. If this + // parameter is not used, then ListWorlds returns up to 100 results and a nextToken + // value if applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/robomaker/api_op_StartSimulationJobBatch.go b/service/robomaker/api_op_StartSimulationJobBatch.go index 64aae872933..105d321d43b 100644 --- a/service/robomaker/api_op_StartSimulationJobBatch.go +++ b/service/robomaker/api_op_StartSimulationJobBatch.go @@ -84,21 +84,21 @@ type StartSimulationJobBatchOutput struct { // created into simulation jobs. PendingRequests []types.SimulationJobRequest - // The status of the simulation job batch. Pending The simulation job batch request - // is pending. InProgress The simulation job batch is in progress. Failed The - // simulation job batch failed. One or more simulation job requests could not be - // completed due to an internal failure (like InternalServiceError). See + // The status of the simulation job batch. Pending The simulation job batch + // request is pending. InProgress The simulation job batch is in progress. Failed + // The simulation job batch failed. One or more simulation job requests could not + // be completed due to an internal failure (like InternalServiceError ). See // failureCode and failureReason for more information. Completed The simulation // batch job completed. A batch is complete when (1) there are no pending // simulation job requests in the batch and none of the failed simulation job // requests are due to InternalServiceError and (2) when all created simulation - // jobs have reached a terminal state (for example, Completed or Failed). Canceled + // jobs have reached a terminal state (for example, Completed or Failed ). Canceled // The simulation batch job was cancelled. Canceling The simulation batch job is // being cancelled. Completing The simulation batch job is completing. TimingOut // The simulation job batch is timing out. If a batch timing out, and there are // pending requests that were failing due to an internal failure (like - // InternalServiceError), the batch status will be Failed. If there are no such - // failing request, the batch status will be TimedOut. TimedOut The simulation + // InternalServiceError ), the batch status will be Failed . If there are no such + // failing request, the batch status will be TimedOut . TimedOut The simulation // batch job timed out. Status types.SimulationJobBatchStatus diff --git a/service/robomaker/api_op_TagResource.go b/service/robomaker/api_op_TagResource.go index 2e64e93220d..e264b092279 100644 --- a/service/robomaker/api_op_TagResource.go +++ b/service/robomaker/api_op_TagResource.go @@ -13,8 +13,7 @@ import ( // Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key // and a tag value. Tag keys and tag values are both required, but tag values can // be empty strings. For information about the rules that apply to tag keys and tag -// values, see User-Defined Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// values, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) // in the AWS Billing and Cost Management User Guide. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/robomaker/api_op_UntagResource.go b/service/robomaker/api_op_UntagResource.go index aa00f48fe6b..66054c13f35 100644 --- a/service/robomaker/api_op_UntagResource.go +++ b/service/robomaker/api_op_UntagResource.go @@ -12,8 +12,8 @@ import ( // Removes the specified tags from the specified AWS RoboMaker resource. To remove // a tag, specify the tag key. To change the tag value of an existing tag key, use -// TagResource -// (https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html). +// TagResource (https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/robomaker/types/enums.go b/service/robomaker/types/enums.go index b4fa8b35682..e9abc0b2a81 100644 --- a/service/robomaker/types/enums.go +++ b/service/robomaker/types/enums.go @@ -11,9 +11,9 @@ const ( ArchitectureArmhf Architecture = "ARMHF" ) -// Values returns all known values for Architecture. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Architecture. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Architecture) Values() []Architecture { return []Architecture{ "X86_64", @@ -156,9 +156,9 @@ const ( ExitBehaviorRestart ExitBehavior = "RESTART" ) -// Values returns all known values for ExitBehavior. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExitBehavior. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ExitBehavior) Values() []ExitBehavior { return []ExitBehavior{ "FAIL", @@ -330,9 +330,9 @@ const ( SimulationJobBatchStatusTimedOut SimulationJobBatchStatus = "TimedOut" ) -// Values returns all known values for SimulationJobBatchStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SimulationJobBatchStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationJobBatchStatus) Values() []SimulationJobBatchStatus { return []SimulationJobBatchStatus{ "Pending", @@ -586,9 +586,9 @@ const ( WorldGenerationJobStatusCanceled WorldGenerationJobStatus = "Canceled" ) -// Values returns all known values for WorldGenerationJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for WorldGenerationJobStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (WorldGenerationJobStatus) Values() []WorldGenerationJobStatus { return []WorldGenerationJobStatus{ "Pending", diff --git a/service/robomaker/types/errors.go b/service/robomaker/types/errors.go index b8147f571b5..4e64c1369f6 100644 --- a/service/robomaker/types/errors.go +++ b/service/robomaker/types/errors.go @@ -33,9 +33,9 @@ func (e *ConcurrentDeploymentException) ErrorCode() string { } func (e *ConcurrentDeploymentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request uses the same client token as a previous, but non-identical request. -// Do not reuse a client token with different requests, unless the requests are -// identical. +// The request uses the same client token as a previous, but non-identical +// request. Do not reuse a client token with different requests, unless the +// requests are identical. type IdempotentParameterMismatchException struct { Message *string diff --git a/service/robomaker/types/types.go b/service/robomaker/types/types.go index 26e708ee551..210680159b1 100644 --- a/service/robomaker/types/types.go +++ b/service/robomaker/types/types.go @@ -11,17 +11,17 @@ import ( type BatchPolicy struct { // The number of active simulation jobs create as part of the batch that can be in - // an active state at the same time. Active states include: Pending,Preparing, - // Running, Restarting, RunningFailed and Terminating. All other states are + // an active state at the same time. Active states include: Pending , Preparing , + // Running , Restarting , RunningFailed and Terminating . All other states are // terminal states. MaxConcurrency *int32 // The amount of time, in seconds, to wait for the batch to complete. If a batch // times out, and there are pending requests that were failing due to an internal - // failure (like InternalServiceError), they will be moved to the failed list and - // the batch status will be Failed. If the pending requests were failing for any + // failure (like InternalServiceError ), they will be moved to the failed list and + // the batch status will be Failed . If the pending requests were failing for any // other reason, the failed pending requests will be moved to the failed list and - // the batch status will be TimedOut. + // the batch status will be TimedOut . TimeoutInSeconds *int64 noSmithyDocumentSerde @@ -69,12 +69,13 @@ type ComputeResponse struct { type DataSource struct { // The location where your files are mounted in the container image. If you've - // specified the type of the data source as an Archive, you must provide an Amazon + // specified the type of the data source as an Archive , you must provide an Amazon // S3 object key to your archive. The object key must point to either a .zip or - // .tar.gz file. If you've specified the type of the data source as a Prefix, you + // .tar.gz file. If you've specified the type of the data source as a Prefix , you // provide the Amazon S3 prefix that points to the files that you are using for - // your data source. If you've specified the type of the data source as a File, you - // provide the Amazon S3 path to the file that you're using as your data source. + // your data source. If you've specified the type of the data source as a File , + // you provide the Amazon S3 path to the file that you're using as your data + // source. Destination *string // The name of the data source. @@ -89,7 +90,7 @@ type DataSource struct { // The data type for the data source that you're using for your container image or // simulation job. You can use this field to specify whether your data source is an // Archive, an Amazon S3 prefix, or a file. If you don't specify a field, the - // default value is File. + // default value is File . Type DataSourceType noSmithyDocumentSerde @@ -114,18 +115,19 @@ type DataSourceConfig struct { S3Keys []string // The location where your files are mounted in the container image. If you've - // specified the type of the data source as an Archive, you must provide an Amazon + // specified the type of the data source as an Archive , you must provide an Amazon // S3 object key to your archive. The object key must point to either a .zip or - // .tar.gz file. If you've specified the type of the data source as a Prefix, you + // .tar.gz file. If you've specified the type of the data source as a Prefix , you // provide the Amazon S3 prefix that points to the files that you are using for - // your data source. If you've specified the type of the data source as a File, you - // provide the Amazon S3 path to the file that you're using as your data source. + // your data source. If you've specified the type of the data source as a File , + // you provide the Amazon S3 path to the file that you're using as your data + // source. Destination *string // The data type for the data source that you're using for your container image or // simulation job. You can use this field to specify whether your data source is an // Archive, an Amazon S3 prefix, or a file. If you don't specify a field, the - // default value is File. + // default value is File . Type DataSourceType noSmithyDocumentSerde @@ -323,9 +325,9 @@ type Fleet struct { // Information about a launch configuration. type LaunchConfig struct { - // If you've specified General as the value for your RobotSoftwareSuite, you can + // If you've specified General as the value for your RobotSoftwareSuite , you can // use this field to specify a list of commands for your container image. If you've - // specified SimulationRuntime as the value for your SimulationSoftwareSuite, you + // specified SimulationRuntime as the value for your SimulationSoftwareSuite , you // can use this field to specify a list of commands for your container image. Command []string @@ -342,7 +344,7 @@ type LaunchConfig struct { PortForwardingConfig *PortForwardingConfig // Boolean indicating whether a streaming session will be configured for the - // application. If True, AWS RoboMaker will configure a connection so you can + // application. If True , AWS RoboMaker will configure a connection so you can // interact with your application as it is running in the simulation. You must // configure and launch the component. It must have a graphical user interface. StreamUI bool @@ -512,9 +514,9 @@ type RobotApplicationConfig struct { // The upload configurations for the robot application. UploadConfigurations []UploadConfiguration - // A Boolean indicating whether to use default robot application tools. The default - // tools are rviz, rqt, terminal and rosbag record. The default is False. This API - // is no longer supported and will throw an error if used. + // A Boolean indicating whether to use default robot application tools. The + // default tools are rviz, rqt, terminal and rosbag record. The default is False . + // This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For // additional information, see @@ -524,7 +526,7 @@ type RobotApplicationConfig struct { // A Boolean indicating whether to use default upload configurations. By default, // .ros and .gazebo files are uploaded when the application terminates and all ROS // topics will be recorded. If you set this value, you must specify an - // outputLocation. This API is no longer supported and will throw an error if used. + // outputLocation . This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For // additional information, see @@ -649,7 +651,7 @@ type SimulationApplicationConfig struct { UploadConfigurations []UploadConfiguration // A Boolean indicating whether to use default simulation application tools. The - // default tools are rviz, rqt, terminal and rosbag record. The default is False. + // default tools are rviz, rqt, terminal and rosbag record. The default is False . // This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For @@ -660,7 +662,7 @@ type SimulationApplicationConfig struct { // A Boolean indicating whether to use default upload configurations. By default, // .ros and .gazebo files are uploaded when the application terminates and all ROS // topics will be recorded. If you set this value, you must specify an - // outputLocation. This API is no longer supported and will throw an error if used. + // outputLocation . This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For // additional information, see @@ -798,21 +800,21 @@ type SimulationJobBatchSummary struct { // The number of pending simulation job requests. PendingRequestCount int32 - // The status of the simulation job batch. Pending The simulation job batch request - // is pending. InProgress The simulation job batch is in progress. Failed The - // simulation job batch failed. One or more simulation job requests could not be - // completed due to an internal failure (like InternalServiceError). See + // The status of the simulation job batch. Pending The simulation job batch + // request is pending. InProgress The simulation job batch is in progress. Failed + // The simulation job batch failed. One or more simulation job requests could not + // be completed due to an internal failure (like InternalServiceError ). See // failureCode and failureReason for more information. Completed The simulation // batch job completed. A batch is complete when (1) there are no pending // simulation job requests in the batch and none of the failed simulation job // requests are due to InternalServiceError and (2) when all created simulation - // jobs have reached a terminal state (for example, Completed or Failed). Canceled + // jobs have reached a terminal state (for example, Completed or Failed ). Canceled // The simulation batch job was cancelled. Canceling The simulation batch job is // being cancelled. Completing The simulation batch job is completing. TimingOut // The simulation job batch is timing out. If a batch timing out, and there are // pending requests that were failing due to an internal failure (like - // InternalServiceError), the batch status will be Failed. If there are no such - // failing request, the batch status will be TimedOut. TimedOut The simulation + // InternalServiceError ), the batch status will be Failed . If there are no such + // failing request, the batch status will be TimedOut . TimedOut The simulation // batch job timed out. Status SimulationJobBatchStatus @@ -832,7 +834,7 @@ type SimulationJobRequest struct { Compute *Compute // Specify data sources to mount read-only files from S3 into your simulation. - // These files are available under /opt/robomaker/datasources/data_source_name. + // These files are available under /opt/robomaker/datasources/data_source_name . // There is a limit of 100 files and a combined size of 25GB for all // DataSourceConfig objects. DataSources []DataSourceConfig @@ -924,7 +926,7 @@ type Source struct { // The taget processor architecture for the application. Architecture Architecture - // A hash of the object specified by s3Bucket and s3Key. + // A hash of the object specified by s3Bucket and s3Key . Etag *string // The s3 bucket name. @@ -1001,19 +1003,19 @@ type Tool struct { // This member is required. Name *string - // Exit behavior determines what happens when your tool quits running. RESTART will - // cause your tool to be restarted. FAIL will cause your job to exit. The default - // is RESTART. + // Exit behavior determines what happens when your tool quits running. RESTART + // will cause your tool to be restarted. FAIL will cause your job to exit. The + // default is RESTART . ExitBehavior ExitBehavior - // Boolean indicating whether logs will be recorded in CloudWatch for the tool. The - // default is False. + // Boolean indicating whether logs will be recorded in CloudWatch for the tool. + // The default is False . StreamOutputToCloudWatch *bool // Boolean indicating whether a streaming session will be configured for the tool. - // If True, AWS RoboMaker will configure a connection so you can interact with the + // If True , AWS RoboMaker will configure a connection so you can interact with the // tool as it is running in the simulation. It must have a graphical user - // interface. The default is False. + // interface. The default is False . StreamUI *bool noSmithyDocumentSerde @@ -1026,8 +1028,8 @@ type UploadConfiguration struct { // A prefix that specifies where files will be uploaded in Amazon S3. It is // appended to the simulation output location to determine the final path. For // example, if your simulation output location is s3://my-bucket and your upload - // configuration name is robot-test, your files will be uploaded to - // s3://my-bucket///robot-test. + // configuration name is robot-test , your files will be uploaded to + // s3://my-bucket///robot-test . // // This member is required. Name *string @@ -1035,8 +1037,8 @@ type UploadConfiguration struct { // Specifies the path of the file(s) to upload. Standard Unix glob matching rules // are accepted, with the addition of ** as a super asterisk. For example, // specifying /var/log/**.log causes all .log files in the /var/log directory tree - // to be collected. For more examples, see Glob Library - // (https://github.com/gobwas/glob). + // to be collected. For more examples, see Glob Library (https://github.com/gobwas/glob) + // . // // This member is required. Path *string @@ -1105,9 +1107,9 @@ type WorldConfig struct { // The number of worlds that will be created. You can configure the number of // unique floorplans and the number of unique interiors for each floor plan. For // example, if you want 1 world with 20 unique interiors, you set floorplanCount = -// 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds -// (floorplanCount * interiorCountPerFloorplan). If you set floorplanCount = 4 and -// interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor +// 1 and interiorCountPerFloorplan = 20 . This will result in 20 worlds ( +// floorplanCount * interiorCountPerFloorplan) . If you set floorplanCount = 4 and +// interiorCountPerFloorplan = 5 , there will be 20 worlds with 5 unique floor // plans. type WorldCount struct { @@ -1160,8 +1162,8 @@ type WorldFailure struct { // The number of failed worlds. FailureCount int32 - // The sample reason why the world failed. World errors are aggregated. A sample is - // used as the sampleFailureReason. + // The sample reason why the world failed. World errors are aggregated. A sample + // is used as the sampleFailureReason . SampleFailureReason *string noSmithyDocumentSerde diff --git a/service/rolesanywhere/api_client.go b/service/rolesanywhere/api_client.go index 7c3bce0960c..c9f436ab688 100644 --- a/service/rolesanywhere/api_client.go +++ b/service/rolesanywhere/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rolesanywhere/api_op_CreateProfile.go b/service/rolesanywhere/api_op_CreateProfile.go index 0b978d97b16..1c3b2845651 100644 --- a/service/rolesanywhere/api_op_CreateProfile.go +++ b/service/rolesanywhere/api_op_CreateProfile.go @@ -14,7 +14,7 @@ import ( // Creates a profile. A profile is configuration resource to list the roles that // RolesAnywhere service is trusted to assume. In addition, by applying a profile // you can intersect permissions with IAM managed policies. Required permissions: -// rolesanywhere:CreateProfile. +// rolesanywhere:CreateProfile . func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error) { if params == nil { params = &CreateProfileInput{} @@ -37,8 +37,7 @@ type CreateProfileInput struct { // This member is required. Name *string - // A list of IAM roles that this profile can assume in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // A list of IAM roles that this profile can assume in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. // // This member is required. @@ -53,8 +52,7 @@ type CreateProfileInput struct { // A list of managed policy ARNs that apply to the vended session credentials. ManagedPolicyArns []string - // Specifies whether instance properties are required in CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // Specifies whether instance properties are required in CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // requests with this profile. RequireInstanceProperties *bool diff --git a/service/rolesanywhere/api_op_CreateTrustAnchor.go b/service/rolesanywhere/api_op_CreateTrustAnchor.go index d715dded940..679c397a1c9 100644 --- a/service/rolesanywhere/api_op_CreateTrustAnchor.go +++ b/service/rolesanywhere/api_op_CreateTrustAnchor.go @@ -17,7 +17,7 @@ import ( // Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. // Your AWS workloads can authenticate with the trust anchor using certificates // issued by the trusted Certificate Authority (CA) in exchange for temporary AWS -// credentials. Required permissions: rolesanywhere:CreateTrustAnchor. +// credentials. Required permissions: rolesanywhere:CreateTrustAnchor . func (c *Client) CreateTrustAnchor(ctx context.Context, params *CreateTrustAnchorInput, optFns ...func(*Options)) (*CreateTrustAnchorOutput, error) { if params == nil { params = &CreateTrustAnchorInput{} diff --git a/service/rolesanywhere/api_op_DeleteCrl.go b/service/rolesanywhere/api_op_DeleteCrl.go index b5ce3983036..fde77c95b3f 100644 --- a/service/rolesanywhere/api_op_DeleteCrl.go +++ b/service/rolesanywhere/api_op_DeleteCrl.go @@ -12,7 +12,7 @@ import ( ) // Deletes a certificate revocation list (CRL). Required permissions: -// rolesanywhere:DeleteCrl. +// rolesanywhere:DeleteCrl . func (c *Client) DeleteCrl(ctx context.Context, params *DeleteCrlInput, optFns ...func(*Options)) (*DeleteCrlOutput, error) { if params == nil { params = &DeleteCrlInput{} diff --git a/service/rolesanywhere/api_op_DeleteProfile.go b/service/rolesanywhere/api_op_DeleteProfile.go index 4d3fda4e657..664692752c3 100644 --- a/service/rolesanywhere/api_op_DeleteProfile.go +++ b/service/rolesanywhere/api_op_DeleteProfile.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a profile. Required permissions: rolesanywhere:DeleteProfile. +// Deletes a profile. Required permissions: rolesanywhere:DeleteProfile . func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error) { if params == nil { params = &DeleteProfileInput{} diff --git a/service/rolesanywhere/api_op_DeleteTrustAnchor.go b/service/rolesanywhere/api_op_DeleteTrustAnchor.go index 88ad1e435ed..7552c92abba 100644 --- a/service/rolesanywhere/api_op_DeleteTrustAnchor.go +++ b/service/rolesanywhere/api_op_DeleteTrustAnchor.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor. +// Deletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor . func (c *Client) DeleteTrustAnchor(ctx context.Context, params *DeleteTrustAnchorInput, optFns ...func(*Options)) (*DeleteTrustAnchorOutput, error) { if params == nil { params = &DeleteTrustAnchorInput{} diff --git a/service/rolesanywhere/api_op_DisableCrl.go b/service/rolesanywhere/api_op_DisableCrl.go index 89532032177..709b5dda788 100644 --- a/service/rolesanywhere/api_op_DisableCrl.go +++ b/service/rolesanywhere/api_op_DisableCrl.go @@ -12,7 +12,7 @@ import ( ) // Disables a certificate revocation list (CRL). Required permissions: -// rolesanywhere:DisableCrl. +// rolesanywhere:DisableCrl . func (c *Client) DisableCrl(ctx context.Context, params *DisableCrlInput, optFns ...func(*Options)) (*DisableCrlOutput, error) { if params == nil { params = &DisableCrlInput{} diff --git a/service/rolesanywhere/api_op_DisableProfile.go b/service/rolesanywhere/api_op_DisableProfile.go index 70f890c4081..cca9dbcdc5b 100644 --- a/service/rolesanywhere/api_op_DisableProfile.go +++ b/service/rolesanywhere/api_op_DisableProfile.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables a profile. When disabled, CreateSession -// (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) +// Disables a profile. When disabled, CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // requests with this profile fail. Required permissions: -// rolesanywhere:DisableProfile. +// rolesanywhere:DisableProfile . func (c *Client) DisableProfile(ctx context.Context, params *DisableProfileInput, optFns ...func(*Options)) (*DisableProfileOutput, error) { if params == nil { params = &DisableProfileInput{} diff --git a/service/rolesanywhere/api_op_DisableTrustAnchor.go b/service/rolesanywhere/api_op_DisableTrustAnchor.go index e53b6662cd3..1bdd9f04509 100644 --- a/service/rolesanywhere/api_op_DisableTrustAnchor.go +++ b/service/rolesanywhere/api_op_DisableTrustAnchor.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables a trust anchor. When disabled, CreateSession -// (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) +// Disables a trust anchor. When disabled, CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // requests specifying this trust anchor are unauthorized. Required permissions: -// rolesanywhere:DisableTrustAnchor. +// rolesanywhere:DisableTrustAnchor . func (c *Client) DisableTrustAnchor(ctx context.Context, params *DisableTrustAnchorInput, optFns ...func(*Options)) (*DisableTrustAnchorOutput, error) { if params == nil { params = &DisableTrustAnchorInput{} diff --git a/service/rolesanywhere/api_op_EnableCrl.go b/service/rolesanywhere/api_op_EnableCrl.go index f061c478c72..198ff286352 100644 --- a/service/rolesanywhere/api_op_EnableCrl.go +++ b/service/rolesanywhere/api_op_EnableCrl.go @@ -13,7 +13,7 @@ import ( // Enables a certificate revocation list (CRL). When enabled, certificates stored // in the CRL are unauthorized to receive session credentials. Required -// permissions: rolesanywhere:EnableCrl. +// permissions: rolesanywhere:EnableCrl . func (c *Client) EnableCrl(ctx context.Context, params *EnableCrlInput, optFns ...func(*Options)) (*EnableCrlOutput, error) { if params == nil { params = &EnableCrlInput{} diff --git a/service/rolesanywhere/api_op_EnableProfile.go b/service/rolesanywhere/api_op_EnableProfile.go index dc7e98ba5a9..7a33518acf1 100644 --- a/service/rolesanywhere/api_op_EnableProfile.go +++ b/service/rolesanywhere/api_op_EnableProfile.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the roles in a profile to receive session credentials in CreateSession -// (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html). -// Required permissions: rolesanywhere:EnableProfile. +// Enables the roles in a profile to receive session credentials in CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) +// . Required permissions: rolesanywhere:EnableProfile . func (c *Client) EnableProfile(ctx context.Context, params *EnableProfileInput, optFns ...func(*Options)) (*EnableProfileOutput, error) { if params == nil { params = &EnableProfileInput{} diff --git a/service/rolesanywhere/api_op_EnableTrustAnchor.go b/service/rolesanywhere/api_op_EnableTrustAnchor.go index 6e9acbeb848..d6a37143a45 100644 --- a/service/rolesanywhere/api_op_EnableTrustAnchor.go +++ b/service/rolesanywhere/api_op_EnableTrustAnchor.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables a trust anchor. When enabled, certificates in the trust anchor chain are -// authorized for trust validation. Required permissions: -// rolesanywhere:EnableTrustAnchor. +// Enables a trust anchor. When enabled, certificates in the trust anchor chain +// are authorized for trust validation. Required permissions: +// rolesanywhere:EnableTrustAnchor . func (c *Client) EnableTrustAnchor(ctx context.Context, params *EnableTrustAnchorInput, optFns ...func(*Options)) (*EnableTrustAnchorOutput, error) { if params == nil { params = &EnableTrustAnchorInput{} diff --git a/service/rolesanywhere/api_op_GetCrl.go b/service/rolesanywhere/api_op_GetCrl.go index 22bc6f759d5..0bd557219d3 100644 --- a/service/rolesanywhere/api_op_GetCrl.go +++ b/service/rolesanywhere/api_op_GetCrl.go @@ -12,7 +12,7 @@ import ( ) // Gets a certificate revocation list (CRL). Required permissions: -// rolesanywhere:GetCrl. +// rolesanywhere:GetCrl . func (c *Client) GetCrl(ctx context.Context, params *GetCrlInput, optFns ...func(*Options)) (*GetCrlOutput, error) { if params == nil { params = &GetCrlInput{} diff --git a/service/rolesanywhere/api_op_GetProfile.go b/service/rolesanywhere/api_op_GetProfile.go index 3ac57c9dd4f..c64478de369 100644 --- a/service/rolesanywhere/api_op_GetProfile.go +++ b/service/rolesanywhere/api_op_GetProfile.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a profile. Required permissions: rolesanywhere:GetProfile. +// Gets a profile. Required permissions: rolesanywhere:GetProfile . func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error) { if params == nil { params = &GetProfileInput{} diff --git a/service/rolesanywhere/api_op_GetSubject.go b/service/rolesanywhere/api_op_GetSubject.go index 7efe3522f87..e01c7a3b82e 100644 --- a/service/rolesanywhere/api_op_GetSubject.go +++ b/service/rolesanywhere/api_op_GetSubject.go @@ -15,7 +15,7 @@ import ( // attempts by CreateSession. The Subject resources stores audit information such // as status of the last authentication attempt, the certificate data used in the // attempt, and the last time the associated identity attempted authentication. -// Required permissions: rolesanywhere:GetSubject. +// Required permissions: rolesanywhere:GetSubject . func (c *Client) GetSubject(ctx context.Context, params *GetSubjectInput, optFns ...func(*Options)) (*GetSubjectOutput, error) { if params == nil { params = &GetSubjectInput{} diff --git a/service/rolesanywhere/api_op_GetTrustAnchor.go b/service/rolesanywhere/api_op_GetTrustAnchor.go index 173f1adc330..d1a84f78a87 100644 --- a/service/rolesanywhere/api_op_GetTrustAnchor.go +++ b/service/rolesanywhere/api_op_GetTrustAnchor.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor. +// Gets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor . func (c *Client) GetTrustAnchor(ctx context.Context, params *GetTrustAnchorInput, optFns ...func(*Options)) (*GetTrustAnchorOutput, error) { if params == nil { params = &GetTrustAnchorInput{} diff --git a/service/rolesanywhere/api_op_ImportCrl.go b/service/rolesanywhere/api_op_ImportCrl.go index 36935e58055..470b7d8ece6 100644 --- a/service/rolesanywhere/api_op_ImportCrl.go +++ b/service/rolesanywhere/api_op_ImportCrl.go @@ -14,7 +14,7 @@ import ( // Imports the certificate revocation list (CRL). CRl is a list of certificates // that have been revoked by the issuing certificate Authority (CA). IAM Roles // Anywhere validates against the crl list before issuing credentials. Required -// permissions: rolesanywhere:ImportCrl. +// permissions: rolesanywhere:ImportCrl . func (c *Client) ImportCrl(ctx context.Context, params *ImportCrlInput, optFns ...func(*Options)) (*ImportCrlOutput, error) { if params == nil { params = &ImportCrlInput{} diff --git a/service/rolesanywhere/api_op_ListCrls.go b/service/rolesanywhere/api_op_ListCrls.go index d1c7966991f..bc55a884b3c 100644 --- a/service/rolesanywhere/api_op_ListCrls.go +++ b/service/rolesanywhere/api_op_ListCrls.go @@ -13,7 +13,7 @@ import ( ) // Lists all Crls in the authenticated account and Amazon Web Services Region. -// Required permissions: rolesanywhere:ListCrls. +// Required permissions: rolesanywhere:ListCrls . func (c *Client) ListCrls(ctx context.Context, params *ListCrlsInput, optFns ...func(*Options)) (*ListCrlsOutput, error) { if params == nil { params = &ListCrlsInput{} diff --git a/service/rolesanywhere/api_op_ListProfiles.go b/service/rolesanywhere/api_op_ListProfiles.go index dff51c1c905..4b967e47b9b 100644 --- a/service/rolesanywhere/api_op_ListProfiles.go +++ b/service/rolesanywhere/api_op_ListProfiles.go @@ -13,7 +13,7 @@ import ( ) // Lists all profiles in the authenticated account and Amazon Web Services Region. -// Required permissions: rolesanywhere:ListProfiles. +// Required permissions: rolesanywhere:ListProfiles . func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error) { if params == nil { params = &ListProfilesInput{} diff --git a/service/rolesanywhere/api_op_ListSubjects.go b/service/rolesanywhere/api_op_ListSubjects.go index 7db9fa36419..99f04cbcfc4 100644 --- a/service/rolesanywhere/api_op_ListSubjects.go +++ b/service/rolesanywhere/api_op_ListSubjects.go @@ -13,7 +13,7 @@ import ( ) // Lists the subjects in the authenticated account and Amazon Web Services Region. -// Required permissions: rolesanywhere:ListSubjects. +// Required permissions: rolesanywhere:ListSubjects . func (c *Client) ListSubjects(ctx context.Context, params *ListSubjectsInput, optFns ...func(*Options)) (*ListSubjectsOutput, error) { if params == nil { params = &ListSubjectsInput{} diff --git a/service/rolesanywhere/api_op_ListTagsForResource.go b/service/rolesanywhere/api_op_ListTagsForResource.go index 2a0260d1b42..62ed45fc28f 100644 --- a/service/rolesanywhere/api_op_ListTagsForResource.go +++ b/service/rolesanywhere/api_op_ListTagsForResource.go @@ -12,7 +12,7 @@ import ( ) // Lists the tags attached to the resource. Required permissions: -// rolesanywhere:ListTagsForResource. +// rolesanywhere:ListTagsForResource . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/rolesanywhere/api_op_ListTrustAnchors.go b/service/rolesanywhere/api_op_ListTrustAnchors.go index 4d91f9d38f4..9e2c448b571 100644 --- a/service/rolesanywhere/api_op_ListTrustAnchors.go +++ b/service/rolesanywhere/api_op_ListTrustAnchors.go @@ -13,7 +13,7 @@ import ( ) // Lists the trust anchors in the authenticated account and Amazon Web Services -// Region. Required permissions: rolesanywhere:ListTrustAnchors. +// Region. Required permissions: rolesanywhere:ListTrustAnchors . func (c *Client) ListTrustAnchors(ctx context.Context, params *ListTrustAnchorsInput, optFns ...func(*Options)) (*ListTrustAnchorsOutput, error) { if params == nil { params = &ListTrustAnchorsInput{} diff --git a/service/rolesanywhere/api_op_TagResource.go b/service/rolesanywhere/api_op_TagResource.go index 3717c7c22e3..2eea3259dcd 100644 --- a/service/rolesanywhere/api_op_TagResource.go +++ b/service/rolesanywhere/api_op_TagResource.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches tags to a resource. Required permissions: rolesanywhere:TagResource. +// Attaches tags to a resource. Required permissions: rolesanywhere:TagResource . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/rolesanywhere/api_op_UntagResource.go b/service/rolesanywhere/api_op_UntagResource.go index 3ae1caa751f..0b27a54721f 100644 --- a/service/rolesanywhere/api_op_UntagResource.go +++ b/service/rolesanywhere/api_op_UntagResource.go @@ -11,7 +11,7 @@ import ( ) // Removes tags from the resource. Required permissions: -// rolesanywhere:UntagResource. +// rolesanywhere:UntagResource . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/rolesanywhere/api_op_UpdateCrl.go b/service/rolesanywhere/api_op_UpdateCrl.go index e513c7e13bb..f4470237066 100644 --- a/service/rolesanywhere/api_op_UpdateCrl.go +++ b/service/rolesanywhere/api_op_UpdateCrl.go @@ -14,7 +14,7 @@ import ( // Updates the certificate revocation list (CRL). CRl is a list of certificates // that have been revoked by the issuing certificate Authority (CA). IAM Roles // Anywhere validates against the crl list before issuing credentials. Required -// permissions: rolesanywhere:UpdateCrl. +// permissions: rolesanywhere:UpdateCrl . func (c *Client) UpdateCrl(ctx context.Context, params *UpdateCrlInput, optFns ...func(*Options)) (*UpdateCrlOutput, error) { if params == nil { params = &UpdateCrlInput{} diff --git a/service/rolesanywhere/api_op_UpdateProfile.go b/service/rolesanywhere/api_op_UpdateProfile.go index 0d101bca994..3d6091c3819 100644 --- a/service/rolesanywhere/api_op_UpdateProfile.go +++ b/service/rolesanywhere/api_op_UpdateProfile.go @@ -14,7 +14,7 @@ import ( // Updates the profile. A profile is configuration resource to list the roles that // RolesAnywhere service is trusted to assume. In addition, by applying a profile // you can scope-down permissions with IAM managed policies. Required permissions: -// rolesanywhere:UpdateProfile. +// rolesanywhere:UpdateProfile . func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, optFns ...func(*Options)) (*UpdateProfileOutput, error) { if params == nil { params = &UpdateProfileInput{} @@ -46,8 +46,7 @@ type UpdateProfileInput struct { // The name of the profile. Name *string - // A list of IAM roles that this profile can assume in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // A list of IAM roles that this profile can assume in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. RoleArns []string diff --git a/service/rolesanywhere/api_op_UpdateTrustAnchor.go b/service/rolesanywhere/api_op_UpdateTrustAnchor.go index 89a0ee246f6..c7291a49dd9 100644 --- a/service/rolesanywhere/api_op_UpdateTrustAnchor.go +++ b/service/rolesanywhere/api_op_UpdateTrustAnchor.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the trust anchor.You establish trust between IAM Roles Anywhere and your -// certificate authority (CA) by configuring a trust anchor. A Trust Anchor is +// Updates the trust anchor.You establish trust between IAM Roles Anywhere and +// your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is // defined either as a reference to a AWS Certificate Manager Private Certificate // Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. // Your AWS workloads can authenticate with the trust anchor using certificates // issued by the trusted Certificate Authority (CA) in exchange for temporary AWS -// credentials. Required permissions: rolesanywhere:UpdateTrustAnchor. +// credentials. Required permissions: rolesanywhere:UpdateTrustAnchor . func (c *Client) UpdateTrustAnchor(ctx context.Context, params *UpdateTrustAnchorInput, optFns ...func(*Options)) (*UpdateTrustAnchorOutput, error) { if params == nil { params = &UpdateTrustAnchorInput{} diff --git a/service/rolesanywhere/doc.go b/service/rolesanywhere/doc.go index 381e7446b63..b329178ae79 100644 --- a/service/rolesanywhere/doc.go +++ b/service/rolesanywhere/doc.go @@ -3,9 +3,9 @@ // Package rolesanywhere provides the API client, operations, and parameter types // for IAM Roles Anywhere. // -// AWS Identity and Access Management Roles Anywhere provides a secure way for your -// workloads such as servers, containers, and applications running outside of AWS -// to obtain Temporary AWS credentials. Your workloads can use the same IAM +// AWS Identity and Access Management Roles Anywhere provides a secure way for +// your workloads such as servers, containers, and applications running outside of +// AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM // policies and roles that you have configured with native AWS applications to // access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage // long term credentials for workloads running outside of AWS. To use IAM Roles diff --git a/service/rolesanywhere/types/types.go b/service/rolesanywhere/types/types.go index 859323bb43c..f52f2a345a9 100644 --- a/service/rolesanywhere/types/types.go +++ b/service/rolesanywhere/types/types.go @@ -7,15 +7,14 @@ import ( "time" ) -// A record of a presented X509 credential to CreateSession -// (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html). +// A record of a presented X509 credential to CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) +// . type CredentialSummary struct { // Indicates whether the credential is enabled. Enabled *bool - // Indicates whether the CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // Indicates whether the CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation was successful. Failed *bool @@ -23,8 +22,7 @@ type CredentialSummary struct { // end-entity certificate. Issuer *string - // The ISO-8601 time stamp of when the certificate was last used in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // The ISO-8601 time stamp of when the certificate was last used in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. SeenAt *time.Time @@ -75,16 +73,14 @@ type CrlDetail struct { // instance. type InstanceProperty struct { - // Indicates whether the CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // Indicates whether the CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation was successful. Failed *bool // A list of instanceProperty objects. Properties map[string]string - // The ISO-8601 time stamp of when the certificate was last used in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // The ISO-8601 time stamp of when the certificate was last used in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. SeenAt *time.Time @@ -118,13 +114,11 @@ type ProfileDetail struct { // The unique identifier of the profile. ProfileId *string - // Specifies whether instance properties are required in CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // Specifies whether instance properties are required in CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // requests with this profile. RequireInstanceProperties *bool - // A list of IAM roles that this profile can assume in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // A list of IAM roles that this profile can assume in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. RoleArns []string @@ -161,9 +155,8 @@ type SourceData interface { } // The root certificate of the Certificate Manager Private Certificate Authority -// specified by this ARN is used in trust validation for CreateSession -// (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) -// operations. Included for trust anchors of type AWS_ACM_PCA. +// specified by this ARN is used in trust validation for CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) +// operations. Included for trust anchors of type AWS_ACM_PCA . type SourceDataMemberAcmPcaArn struct { Value string @@ -173,7 +166,7 @@ type SourceDataMemberAcmPcaArn struct { func (*SourceDataMemberAcmPcaArn) isSourceData() {} // The PEM-encoded data for the certificate anchor. Included for trust anchors of -// type CERTIFICATE_BUNDLE. +// type CERTIFICATE_BUNDLE . type SourceDataMemberX509CertificateData struct { Value string @@ -198,8 +191,8 @@ type SubjectDetail struct { // The specified instance properties associated with the request. InstanceProperties []InstanceProperty - // The ISO-8601 timestamp of the last time this Subject requested temporary session - // credentials. + // The ISO-8601 timestamp of the last time this Subject requested temporary + // session credentials. LastSeenAt *time.Time // The ARN of the resource. @@ -222,16 +215,14 @@ type SubjectDetail struct { type SubjectSummary struct { // The ISO-8601 time stamp of when the certificate was first used in a - // CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. CreatedAt *time.Time // The enabled status of the Subject. Enabled *bool - // The ISO-8601 time stamp of when the certificate was last used in a CreateSession - // (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) + // The ISO-8601 time stamp of when the certificate was last used in a CreateSession (https://docs.aws.amazon.com/rolesanywhere/latest/APIReference/API_CreateSession.html) // operation. LastSeenAt *time.Time diff --git a/service/route53/api_client.go b/service/route53/api_client.go index 8219dea2ddd..28543a1ace7 100644 --- a/service/route53/api_client.go +++ b/service/route53/api_client.go @@ -116,7 +116,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53/api_op_ActivateKeySigningKey.go b/service/route53/api_op_ActivateKeySigningKey.go index 71546da6349..5c81512a692 100644 --- a/service/route53/api_op_ActivateKeySigningKey.go +++ b/service/route53/api_op_ActivateKeySigningKey.go @@ -12,7 +12,7 @@ import ( ) // Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. -// This operation changes the KSK status to ACTIVE. +// This operation changes the KSK status to ACTIVE . func (c *Client) ActivateKeySigningKey(ctx context.Context, params *ActivateKeySigningKeyInput, optFns ...func(*Options)) (*ActivateKeySigningKeyOutput, error) { if params == nil { params = &ActivateKeySigningKeyInput{} diff --git a/service/route53/api_op_AssociateVPCWithHostedZone.go b/service/route53/api_op_AssociateVPCWithHostedZone.go index a8dc3691ad2..f735f84970a 100644 --- a/service/route53/api_op_AssociateVPCWithHostedZone.go +++ b/service/route53/api_op_AssociateVPCWithHostedZone.go @@ -11,29 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates an Amazon VPC with a private hosted zone. To perform the association, -// the VPC and the private hosted zone must already exist. You can't convert a -// public hosted zone into a private hosted zone. If you want to associate a VPC -// that was created by using one Amazon Web Services account with a private hosted -// zone that was created by using a different account, the Amazon Web Services -// account that created the private hosted zone must first submit a +// Associates an Amazon VPC with a private hosted zone. To perform the +// association, the VPC and the private hosted zone must already exist. You can't +// convert a public hosted zone into a private hosted zone. If you want to +// associate a VPC that was created by using one Amazon Web Services account with a +// private hosted zone that was created by using a different account, the Amazon +// Web Services account that created the private hosted zone must first submit a // CreateVPCAssociationAuthorization request. Then the account that created the VPC // must submit an AssociateVPCWithHostedZone request. When granting access, the // hosted zone and the Amazon VPC must belong to the same partition. A partition is // a group of Amazon Web Services Regions. Each Amazon Web Services account is // scoped to one partition. The following are the supported partitions: +// - aws - Amazon Web Services Regions +// - aws-cn - China Regions +// - aws-us-gov - Amazon Web Services GovCloud (US) Region // -// * aws - -// Amazon Web Services Regions -// -// * aws-cn - China Regions -// -// * aws-us-gov - Amazon Web -// Services GovCloud (US) Region -// -// For more information, see Access Management -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the Amazon Web Services General Reference. +// For more information, see Access Management (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the Amazon Web Services General Reference. func (c *Client) AssociateVPCWithHostedZone(ctx context.Context, params *AssociateVPCWithHostedZoneInput, optFns ...func(*Options)) (*AssociateVPCWithHostedZoneOutput, error) { if params == nil { params = &AssociateVPCWithHostedZoneInput{} @@ -53,9 +47,9 @@ func (c *Client) AssociateVPCWithHostedZone(ctx context.Context, params *Associa // with a private hosted zone. type AssociateVPCWithHostedZoneInput struct { - // The ID of the private hosted zone that you want to associate an Amazon VPC with. - // Note that you can't associate a VPC with a hosted zone that doesn't have an - // existing VPC association. + // The ID of the private hosted zone that you want to associate an Amazon VPC + // with. Note that you can't associate a VPC with a hosted zone that doesn't have + // an existing VPC association. // // This member is required. HostedZoneId *string diff --git a/service/route53/api_op_ChangeCidrCollection.go b/service/route53/api_op_ChangeCidrCollection.go index 5de7b063082..b0fc95bb038 100644 --- a/service/route53/api_op_ChangeCidrCollection.go +++ b/service/route53/api_op_ChangeCidrCollection.go @@ -19,12 +19,8 @@ import ( // included in the request is 1000. As a result, big updates require multiple API // calls. PUT and DELETE_IF_EXISTS Use ChangeCidrCollection to perform the // following actions: -// -// * PUT: Create a CIDR block within the specified -// collection. -// -// * DELETE_IF_EXISTS: Delete an existing CIDR block from the -// collection. +// - PUT : Create a CIDR block within the specified collection. +// - DELETE_IF_EXISTS : Delete an existing CIDR block from the collection. func (c *Client) ChangeCidrCollection(ctx context.Context, params *ChangeCidrCollectionInput, optFns ...func(*Options)) (*ChangeCidrCollectionOutput, error) { if params == nil { params = &ChangeCidrCollectionInput{} @@ -52,20 +48,18 @@ type ChangeCidrCollectionInput struct { // This member is required. Id *string - // A sequential counter that Amazon Route 53 sets to 1 when you create a collection - // and increments it by 1 each time you update the collection. We recommend that - // you use ListCidrCollection to get the current value of CollectionVersion for the - // collection that you want to update, and then include that value with the change - // request. This prevents Route 53 from overwriting an intervening update: - // - // * If - // the value in the request matches the value of CollectionVersion in the - // collection, Route 53 updates the collection. - // - // * If the value of - // CollectionVersion in the collection is greater than the value in the request, - // the collection was changed after you got the version number. Route 53 does not - // update the collection, and it returns a CidrCollectionVersionMismatch error. + // A sequential counter that Amazon Route 53 sets to 1 when you create a + // collection and increments it by 1 each time you update the collection. We + // recommend that you use ListCidrCollection to get the current value of + // CollectionVersion for the collection that you want to update, and then include + // that value with the change request. This prevents Route 53 from overwriting an + // intervening update: + // - If the value in the request matches the value of CollectionVersion in the + // collection, Route 53 updates the collection. + // - If the value of CollectionVersion in the collection is greater than the + // value in the request, the collection was changed after you got the version + // number. Route 53 does not update the collection, and it returns a + // CidrCollectionVersionMismatch error. CollectionVersion *int64 noSmithyDocumentSerde @@ -73,7 +67,7 @@ type ChangeCidrCollectionInput struct { type ChangeCidrCollectionOutput struct { - // The ID that is returned by ChangeCidrCollection. You can use it as input to + // The ID that is returned by ChangeCidrCollection . You can use it as input to // GetChange to see if a CIDR collection change has propagated or not. // // This member is required. diff --git a/service/route53/api_op_ChangeResourceRecordSets.go b/service/route53/api_op_ChangeResourceRecordSets.go index 8259985a02b..0f0c740f1b1 100644 --- a/service/route53/api_op_ChangeResourceRecordSets.go +++ b/service/route53/api_op_ChangeResourceRecordSets.go @@ -12,65 +12,58 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates, changes, or deletes a resource record set, which contains authoritative -// DNS information for a specified domain name or subdomain name. For example, you -// can use ChangeResourceRecordSets to create a resource record set that routes -// traffic for test.example.com to a web server that has an IP address of -// 192.0.2.44. Deleting Resource Record Sets To delete a resource record set, you -// must specify all the same values that you specified when you created it. Change -// Batches and Transactional Changes The request body must include a document with -// a ChangeResourceRecordSetsRequest element. The request body contains a list of -// change items, known as a change batch. Change batches are considered -// transactional changes. Route 53 validates the changes in the request and then -// either makes all or none of the changes in the change batch request. This -// ensures that DNS routing isn't adversely affected by partial changes to the +// Creates, changes, or deletes a resource record set, which contains +// authoritative DNS information for a specified domain name or subdomain name. For +// example, you can use ChangeResourceRecordSets to create a resource record set +// that routes traffic for test.example.com to a web server that has an IP address +// of 192.0.2.44. Deleting Resource Record Sets To delete a resource record set, +// you must specify all the same values that you specified when you created it. +// Change Batches and Transactional Changes The request body must include a +// document with a ChangeResourceRecordSetsRequest element. The request body +// contains a list of change items, known as a change batch. Change batches are +// considered transactional changes. Route 53 validates the changes in the request +// and then either makes all or none of the changes in the change batch request. +// This ensures that DNS routing isn't adversely affected by partial changes to the // resource record sets in a hosted zone. For example, suppose a change batch // request contains two changes: it deletes the CNAME resource record set for // www.example.com and creates an alias resource record set for www.example.com. If // validation for both records succeeds, Route 53 deletes the first resource record // set and creates the second resource record set in a single operation. If -// validation for either the DELETE or the CREATE action fails, then the request is -// canceled, and the original CNAME record continues to exist. If you try to delete -// the same resource record set more than once in a single change batch, Route 53 -// returns an InvalidChangeBatch error. Traffic Flow To create resource record sets -// for complex routing configurations, use either the traffic flow visual editor in -// the Route 53 console or the API actions for traffic policies and traffic policy -// instances. Save the configuration as a traffic policy, then associate the -// traffic policy with one or more domain names (such as example.com) or subdomain -// names (such as www.example.com), in the same hosted zone or in multiple hosted -// zones. You can roll back the updates if the new configuration isn't performing -// as expected. For more information, see Using Traffic Flow to Route DNS Traffic -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html) in -// the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use +// validation for either the DELETE or the CREATE action fails, then the request +// is canceled, and the original CNAME record continues to exist. If you try to +// delete the same resource record set more than once in a single change batch, +// Route 53 returns an InvalidChangeBatch error. Traffic Flow To create resource +// record sets for complex routing configurations, use either the traffic flow +// visual editor in the Route 53 console or the API actions for traffic policies +// and traffic policy instances. Save the configuration as a traffic policy, then +// associate the traffic policy with one or more domain names (such as example.com) +// or subdomain names (such as www.example.com), in the same hosted zone or in +// multiple hosted zones. You can roll back the updates if the new configuration +// isn't performing as expected. For more information, see Using Traffic Flow to +// Route DNS Traffic (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html) +// in the Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use // ChangeResourceRecordsSetsRequest to perform the following actions: +// - CREATE : Creates a resource record set that has the specified values. +// - DELETE : Deletes an existing resource record set that has the specified +// values. +// - UPSERT : If a resource set exists Route 53 updates it with the values in the +// request. // -// * CREATE: -// Creates a resource record set that has the specified values. -// -// * DELETE: Deletes -// an existing resource record set that has the specified values. -// -// * UPSERT: If a -// resource set exists Route 53 updates it with the values in the -// request. -// -// Syntaxes for Creating, Updating, and Deleting Resource Record Sets The -// syntax for a request depends on the type of resource record set that you want to +// Syntaxes for Creating, Updating, and Deleting Resource Record Sets The syntax +// for a request depends on the type of resource record set that you want to // create, delete, or update, such as weighted, alias, or failover. The XML // elements in your request must appear in the order listed in the syntax. For an // example for each type of resource record set, see "Examples." Don't refer to the // syntax in the "Parameter Syntax" section, which includes all of the elements for // every kind of resource record set that you can create, delete, or update by -// using ChangeResourceRecordSets. Change Propagation to Route 53 DNS Servers When +// using ChangeResourceRecordSets . Change Propagation to Route 53 DNS Servers When // you submit a ChangeResourceRecordSets request, Route 53 propagates your changes // to all of the Route 53 authoritative DNS servers. While your changes are -// propagating, GetChange returns a status of PENDING. When propagation is -// complete, GetChange returns a status of INSYNC. Changes generally propagate to -// all Route 53 name servers within 60 seconds. For more information, see GetChange -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html). -// Limits on ChangeResourceRecordSets Requests For information about the limits on -// a ChangeResourceRecordSets request, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// propagating, GetChange returns a status of PENDING . When propagation is +// complete, GetChange returns a status of INSYNC . Changes generally propagate to +// all Route 53 name servers within 60 seconds. For more information, see GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) +// . Limits on ChangeResourceRecordSets Requests For information about the limits +// on a ChangeResourceRecordSets request, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) // in the Amazon Route 53 Developer Guide. func (c *Client) ChangeResourceRecordSets(ctx context.Context, params *ChangeResourceRecordSetsInput, optFns ...func(*Options)) (*ChangeResourceRecordSetsOutput, error) { if params == nil { @@ -107,9 +100,8 @@ type ChangeResourceRecordSetsInput struct { // A complex type containing the response for the request. type ChangeResourceRecordSetsOutput struct { - // A complex type that contains information about changes made to your hosted zone. - // This element contains an ID that you use when performing a GetChange - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) + // A complex type that contains information about changes made to your hosted + // zone. This element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) // action to get detailed information about the change. // // This member is required. diff --git a/service/route53/api_op_ChangeTagsForResource.go b/service/route53/api_op_ChangeTagsForResource.go index 5f86c484646..20fac6b744f 100644 --- a/service/route53/api_op_ChangeTagsForResource.go +++ b/service/route53/api_op_ChangeTagsForResource.go @@ -12,8 +12,7 @@ import ( ) // Adds, edits, or deletes tags for a health check or a hosted zone. For -// information about using tags for cost allocation, see Using Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// information about using tags for cost allocation, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management User Guide. func (c *Client) ChangeTagsForResource(ctx context.Context, params *ChangeTagsForResourceInput, optFns ...func(*Options)) (*ChangeTagsForResourceOutput, error) { if params == nil { @@ -40,11 +39,8 @@ type ChangeTagsForResourceInput struct { ResourceId *string // The type of the resource. - // - // * The resource type for health checks is - // healthcheck. - // - // * The resource type for hosted zones is hostedzone. + // - The resource type for health checks is healthcheck . + // - The resource type for hosted zones is hostedzone . // // This member is required. ResourceType types.TagResourceType @@ -54,8 +50,8 @@ type ChangeTagsForResourceInput struct { // Value for. You can add a maximum of 10 tags to a health check or a hosted zone. AddTags []types.Tag - // A complex type that contains a list of the tags that you want to delete from the - // specified health check or hosted zone. You can specify up to 10 keys. + // A complex type that contains a list of the tags that you want to delete from + // the specified health check or hosted zone. You can specify up to 10 keys. RemoveTagKeys []string noSmithyDocumentSerde diff --git a/service/route53/api_op_CreateCidrCollection.go b/service/route53/api_op_CreateCidrCollection.go index 7610c306976..92e8872f35b 100644 --- a/service/route53/api_op_CreateCidrCollection.go +++ b/service/route53/api_op_CreateCidrCollection.go @@ -36,8 +36,8 @@ type CreateCidrCollectionInput struct { // This member is required. CallerReference *string - // A unique identifier for the account that can be used to reference the collection - // from other API calls. + // A unique identifier for the account that can be used to reference the + // collection from other API calls. // // This member is required. Name *string diff --git a/service/route53/api_op_CreateHealthCheck.go b/service/route53/api_op_CreateHealthCheck.go index 71bd5095a4c..d1453f0dcb0 100644 --- a/service/route53/api_op_CreateHealthCheck.go +++ b/service/route53/api_op_CreateHealthCheck.go @@ -12,34 +12,28 @@ import ( ) // Creates a new health check. For information about adding health checks to -// resource record sets, see HealthCheckId -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId) -// in ChangeResourceRecordSets -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html). -// ELB Load Balancers If you're registering EC2 instances with an Elastic Load +// resource record sets, see HealthCheckId (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId) +// in ChangeResourceRecordSets (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) +// . ELB Load Balancers If you're registering EC2 instances with an Elastic Load // Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for // the EC2 instances. When you register an EC2 instance with a load balancer, you // configure settings for an ELB health check, which performs a similar function to // a Route 53 health check. Private Hosted Zones You can associate health checks -// with failover resource record sets in a private hosted zone. Note the -// following: +// with failover resource record sets in a private hosted zone. Note the following: // -// * Route 53 health checkers are outside the VPC. To check the health -// of an endpoint within a VPC by IP address, you must assign a public IP address -// to the instance in the VPC. -// -// * You can configure a health checker to check the -// health of an external resource that the instance relies on, such as a database -// server. -// -// * You can create a CloudWatch metric, associate an alarm with the -// metric, and then create a health check that is based on the state of the alarm. -// For example, you might create a CloudWatch metric that checks the status of the -// Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create -// a health check that is based on the state of the alarm. For information about -// creating CloudWatch metrics and alarms by using the CloudWatch console, see the -// Amazon CloudWatch User Guide -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html). +// - Route 53 health checkers are outside the VPC. To check the health of an +// endpoint within a VPC by IP address, you must assign a public IP address to the +// instance in the VPC. +// - You can configure a health checker to check the health of an external +// resource that the instance relies on, such as a database server. +// - You can create a CloudWatch metric, associate an alarm with the metric, and +// then create a health check that is based on the state of the alarm. For example, +// you might create a CloudWatch metric that checks the status of the Amazon EC2 +// StatusCheckFailed metric, add an alarm to the metric, and then create a health +// check that is based on the state of the alarm. For information about creating +// CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon +// CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html) +// . func (c *Client) CreateHealthCheck(ctx context.Context, params *CreateHealthCheckInput, optFns ...func(*Options)) (*CreateHealthCheckOutput, error) { if params == nil { params = &CreateHealthCheckInput{} @@ -61,24 +55,19 @@ type CreateHealthCheckInput struct { // A unique string that identifies the request and that allows you to retry a // failed CreateHealthCheck request without the risk of creating two identical // health checks: - // - // * If you send a CreateHealthCheck request with the same - // CallerReference and settings as a previous request, and if the health check - // doesn't exist, Amazon Route 53 creates the health check. If the health check - // does exist, Route 53 returns the settings for the existing health check. - // - // * If - // you send a CreateHealthCheck request with the same CallerReference as a deleted - // health check, regardless of the settings, Route 53 returns a - // HealthCheckAlreadyExists error. - // - // * If you send a CreateHealthCheck request with - // the same CallerReference as an existing health check but with different - // settings, Route 53 returns a HealthCheckAlreadyExists error. - // - // * If you send a - // CreateHealthCheck request with a unique CallerReference but settings identical - // to an existing health check, Route 53 creates the health check. + // - If you send a CreateHealthCheck request with the same CallerReference and + // settings as a previous request, and if the health check doesn't exist, Amazon + // Route 53 creates the health check. If the health check does exist, Route 53 + // returns the settings for the existing health check. + // - If you send a CreateHealthCheck request with the same CallerReference as a + // deleted health check, regardless of the settings, Route 53 returns a + // HealthCheckAlreadyExists error. + // - If you send a CreateHealthCheck request with the same CallerReference as an + // existing health check but with different settings, Route 53 returns a + // HealthCheckAlreadyExists error. + // - If you send a CreateHealthCheck request with a unique CallerReference but + // settings identical to an existing health check, Route 53 creates the health + // check. // // This member is required. CallerReference *string diff --git a/service/route53/api_op_CreateHostedZone.go b/service/route53/api_op_CreateHostedZone.go index 8d009aff69a..9a4bfb27f4c 100644 --- a/service/route53/api_op_CreateHostedZone.go +++ b/service/route53/api_op_CreateHostedZone.go @@ -19,51 +19,36 @@ import ( // Virtual Private Clouds (Amazon VPCs). You can't convert a public hosted zone to // a private hosted zone or vice versa. Instead, you must create a new hosted zone // with the same name and create new resource record sets. For more information -// about charges for hosted zones, see Amazon Route 53 Pricing -// (http://aws.amazon.com/route53/pricing/). Note the following: +// about charges for hosted zones, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) +// . Note the following: +// - You can't create a hosted zone for a top-level domain (TLD) such as .com. +// - For public hosted zones, Route 53 automatically creates a default SOA +// record and four NS records for the zone. For more information about SOA and NS +// records, see NS and SOA Records that Route 53 Creates for a Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html) +// in the Amazon Route 53 Developer Guide. If you want to use the same name servers +// for multiple public hosted zones, you can optionally associate a reusable +// delegation set with the hosted zone. See the DelegationSetId element. +// - If your domain is registered with a registrar other than Route 53, you must +// update the name servers with your registrar to make Route 53 the DNS service for +// the domain. For more information, see Migrating DNS Service for an Existing +// Domain to Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) +// in the Amazon Route 53 Developer Guide. // -// * You can't -// create a hosted zone for a top-level domain (TLD) such as .com. +// When you submit a CreateHostedZone request, the initial status of the hosted +// zone is PENDING . For public hosted zones, this means that the NS and SOA +// records are not yet available on all Route 53 DNS servers. When the NS and SOA +// records are available, the status of the zone changes to INSYNC . The +// CreateHostedZone request requires the caller to have an ec2:DescribeVpcs +// permission. When creating private hosted zones, the Amazon VPC must belong to +// the same partition where the hosted zone is created. A partition is a group of +// Amazon Web Services Regions. Each Amazon Web Services account is scoped to one +// partition. The following are the supported partitions: +// - aws - Amazon Web Services Regions +// - aws-cn - China Regions +// - aws-us-gov - Amazon Web Services GovCloud (US) Region // -// * For public -// hosted zones, Route 53 automatically creates a default SOA record and four NS -// records for the zone. For more information about SOA and NS records, see NS and -// SOA Records that Route 53 Creates for a Hosted Zone -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html) -// in the Amazon Route 53 Developer Guide. If you want to use the same name servers -// for multiple public hosted zones, you can optionally associate a reusable -// delegation set with the hosted zone. See the DelegationSetId element. -// -// * If your -// domain is registered with a registrar other than Route 53, you must update the -// name servers with your registrar to make Route 53 the DNS service for the -// domain. For more information, see Migrating DNS Service for an Existing Domain -// to Amazon Route 53 -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in -// the Amazon Route 53 Developer Guide. -// -// When you submit a CreateHostedZone -// request, the initial status of the hosted zone is PENDING. For public hosted -// zones, this means that the NS and SOA records are not yet available on all Route -// 53 DNS servers. When the NS and SOA records are available, the status of the -// zone changes to INSYNC. The CreateHostedZone request requires the caller to have -// an ec2:DescribeVpcs permission. When creating private hosted zones, the Amazon -// VPC must belong to the same partition where the hosted zone is created. A -// partition is a group of Amazon Web Services Regions. Each Amazon Web Services -// account is scoped to one partition. The following are the supported -// partitions: -// -// * aws - Amazon Web Services Regions -// -// * aws-cn - China Regions -// -// * -// aws-us-gov - Amazon Web Services GovCloud (US) Region -// -// For more information, see -// Access Management -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the Amazon Web Services General Reference. +// For more information, see Access Management (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the Amazon Web Services General Reference. func (c *Client) CreateHostedZone(ctx context.Context, params *CreateHostedZoneInput, optFns ...func(*Options)) (*CreateHostedZoneOutput, error) { if params == nil { params = &CreateHostedZoneInput{} @@ -79,15 +64,15 @@ func (c *Client) CreateHostedZone(ctx context.Context, params *CreateHostedZoneI return out, nil } -// A complex type that contains information about the request to create a public or -// private hosted zone. +// A complex type that contains information about the request to create a public +// or private hosted zone. type CreateHostedZoneInput struct { // A unique string that identifies the request and that allows failed // CreateHostedZone requests to be retried without the risk of executing the // operation twice. You must use a unique CallerReference string every time you - // submit a CreateHostedZone request. CallerReference can be any unique string, for - // example, a date/time stamp. + // submit a CreateHostedZone request. CallerReference can be any unique string, + // for example, a date/time stamp. // // This member is required. CallerReference *string @@ -99,37 +84,31 @@ type CreateHostedZoneInput struct { // identical. If you're creating a public hosted zone, this is the name you have // registered with your DNS registrar. If your domain name is registered with a // registrar other than Route 53, change the name servers for your domain to the - // set of NameServers that CreateHostedZone returns in DelegationSet. + // set of NameServers that CreateHostedZone returns in DelegationSet . // // This member is required. Name *string - // If you want to associate a reusable delegation set with this hosted zone, the ID - // that Amazon Route 53 assigned to the reusable delegation set when you created + // If you want to associate a reusable delegation set with this hosted zone, the + // ID that Amazon Route 53 assigned to the reusable delegation set when you created // it. For more information about reusable delegation sets, see - // CreateReusableDelegationSet - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html). + // CreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html) + // . DelegationSetId *string // (Optional) A complex type that contains the following optional values: - // - // * For - // public and private hosted zones, an optional comment - // - // * For private hosted - // zones, an optional PrivateZone element - // - // If you don't specify a comment or the - // PrivateZone element, omit HostedZoneConfig and the other elements. + // - For public and private hosted zones, an optional comment + // - For private hosted zones, an optional PrivateZone element + // If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig + // and the other elements. HostedZoneConfig *types.HostedZoneConfig // (Private hosted zones only) A complex type that contains information about the // Amazon VPC that you're associating with this hosted zone. You can specify only // one Amazon VPC when you create a private hosted zone. If you are associating a - // VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion are - // also required. To associate additional Amazon VPCs with the hosted zone, use - // AssociateVPCWithHostedZone - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html) + // VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion + // are also required. To associate additional Amazon VPCs with the hosted zone, use + // AssociateVPCWithHostedZone (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html) // after you create a hosted zone. VPC *types.VPC @@ -159,8 +138,8 @@ type CreateHostedZoneOutput struct { // This member is required. Location *string - // A complex type that contains information about an Amazon VPC that you associated - // with this hosted zone. + // A complex type that contains information about an Amazon VPC that you + // associated with this hosted zone. VPC *types.VPC // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_CreateKeySigningKey.go b/service/route53/api_op_CreateKeySigningKey.go index 819db8a2183..55045d39108 100644 --- a/service/route53/api_op_CreateKeySigningKey.go +++ b/service/route53/api_op_CreateKeySigningKey.go @@ -47,23 +47,15 @@ type CreateKeySigningKeyInput struct { // configure the customer managed customer managed key as follows: Status Enabled // Key spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must // give permission for the following actions: - // - // * DescribeKey - // - // * GetPublicKey - // - // * - // Sign - // - // The key policy must also include the Amazon Route 53 service in the - // principal for your account. Specify the following: - // - // * "Service": - // "dnssec-route53.amazonaws.com" - // - // For more information about working with a - // customer managed key in KMS, see Key Management Service concepts - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). + // - DescribeKey + // - GetPublicKey + // - Sign + // The key policy must also include the Amazon Route 53 service in the principal + // for your account. Specify the following: + // - "Service": "dnssec-route53.amazonaws.com" + // For more information about working with a customer managed key in KMS, see Key + // Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) + // . // // This member is required. KeyManagementServiceArn *string @@ -75,8 +67,8 @@ type CreateKeySigningKeyInput struct { // This member is required. Name *string - // A string specifying the initial status of the key-signing key (KSK). You can set - // the value to ACTIVE or INACTIVE. + // A string specifying the initial status of the key-signing key (KSK). You can + // set the value to ACTIVE or INACTIVE . // // This member is required. Status *string diff --git a/service/route53/api_op_CreateQueryLoggingConfig.go b/service/route53/api_op_CreateQueryLoggingConfig.go index 47e33fa3daa..14e830d7e12 100644 --- a/service/route53/api_op_CreateQueryLoggingConfig.go +++ b/service/route53/api_op_CreateQueryLoggingConfig.go @@ -16,108 +16,79 @@ import ( // CloudWatch Logs log group. DNS query logs contain information about the queries // that Route 53 receives for a specified public hosted zone, such as the // following: -// -// * Route 53 edge location that responded to the DNS query -// -// * Domain -// or subdomain that was requested -// -// * DNS record type, such as A or AAAA -// -// * DNS -// response code, such as NoError or ServFail -// -// Log Group and Resource Policy Before -// you create a query logging configuration, perform the following operations. If -// you create a query logging configuration using the Route 53 console, Route 53 -// performs these operations automatically. -// -// * Create a CloudWatch Logs log group, -// and make note of the ARN, which you specify when you create a query logging -// configuration. Note the following: -// -// * You must create the log group in the -// us-east-1 region. -// -// * You must use the same Amazon Web Services account to create -// the log group and the hosted zone that you want to configure query logging -// for. -// -// * When you create log groups for query logging, we recommend that you use -// a consistent prefix, for example: /aws/route53/hosted zone name In the next -// step, you'll create a resource policy, which controls access to one or more log -// groups and the associated Amazon Web Services resources, such as Route 53 hosted -// zones. There's a limit on the number of resource policies that you can create, -// so we recommend that you use a consistent prefix so you can use the same -// resource policy for all the log groups that you create for query logging. -// -// * -// Create a CloudWatch Logs resource policy, and give it the permissions that Route -// 53 needs to create log streams and to send query logs to log streams. For the -// value of Resource, specify the ARN for the log group that you created in the -// previous step. To use the same resource policy for all the CloudWatch Logs log -// groups that you created for query logging configurations, replace the hosted -// zone name with *, for example: -// arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the -// confused deputy problem, a security issue where an entity without a permission -// for an action can coerce a more-privileged entity to perform it, you can -// optionally limit the permissions that a service has to a resource in a -// resource-based policy by supplying the following values: -// -// * For aws:SourceArn, -// supply the hosted zone ARN used in creating the query logging configuration. For -// example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. -// -// * For -// aws:SourceAccount, supply the account ID for the account that creates the query -// logging configuration. For example, aws:SourceAccount:111111111111. -// -// For more -// information, see The confused deputy problem -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) in the -// Amazon Web Services IAM User Guide. You can't use the CloudWatch console to -// create or edit a resource policy. You must use the CloudWatch API, one of the -// Amazon Web Services SDKs, or the CLI. -// -// Log Streams and Edge Locations When Route -// 53 finishes creating the configuration for DNS query logging, it does the -// following: -// -// * Creates a log stream for an edge location the first time that the -// edge location responds to DNS queries for the specified hosted zone. That log -// stream is used to log all queries that Route 53 responds to for that edge -// location. -// -// * Begins to send query logs to the applicable log stream. -// -// The name -// of each log stream is in the following format: hosted zone ID/edge location -// code The edge location code is a three-letter code and an arbitrarily assigned -// number, for example, DFW3. The three-letter code typically corresponds with the -// International Air Transport Association airport code for an airport near the -// edge location. (These abbreviations might change in the future.) For a list of -// edge locations, see "The Route 53 Global Network" on the Route 53 Product -// Details (http://aws.amazon.com/route53/details/) page. Queries That Are Logged -// Query logs contain only the queries that DNS resolvers forward to Route 53. If a -// DNS resolver has already cached the response to a query (such as the IP address -// for a load balancer for example.com), the resolver will continue to return the -// cached response. It doesn't forward another query to Route 53 until the TTL for -// the corresponding resource record set expires. Depending on how many DNS queries -// are submitted for a resource record set, and depending on the TTL for that -// resource record set, query logs might contain information about only one query -// out of every several thousand queries that are submitted to DNS. For more -// information about how DNS works, see Routing Internet Traffic to Your Website or -// Web Application -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) +// - Route 53 edge location that responded to the DNS query +// - Domain or subdomain that was requested +// - DNS record type, such as A or AAAA +// - DNS response code, such as NoError or ServFail +// +// Log Group and Resource Policy Before you create a query logging configuration, +// perform the following operations. If you create a query logging configuration +// using the Route 53 console, Route 53 performs these operations automatically. +// - Create a CloudWatch Logs log group, and make note of the ARN, which you +// specify when you create a query logging configuration. Note the following: +// - You must create the log group in the us-east-1 region. +// - You must use the same Amazon Web Services account to create the log group +// and the hosted zone that you want to configure query logging for. +// - When you create log groups for query logging, we recommend that you use a +// consistent prefix, for example: /aws/route53/hosted zone name In the next +// step, you'll create a resource policy, which controls access to one or more log +// groups and the associated Amazon Web Services resources, such as Route 53 hosted +// zones. There's a limit on the number of resource policies that you can create, +// so we recommend that you use a consistent prefix so you can use the same +// resource policy for all the log groups that you create for query logging. +// - Create a CloudWatch Logs resource policy, and give it the permissions that +// Route 53 needs to create log streams and to send query logs to log streams. For +// the value of Resource , specify the ARN for the log group that you created in +// the previous step. To use the same resource policy for all the CloudWatch Logs +// log groups that you created for query logging configurations, replace the hosted +// zone name with * , for example: +// arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the +// confused deputy problem, a security issue where an entity without a permission +// for an action can coerce a more-privileged entity to perform it, you can +// optionally limit the permissions that a service has to a resource in a +// resource-based policy by supplying the following values: +// - For aws:SourceArn , supply the hosted zone ARN used in creating the query +// logging configuration. For example, aws:SourceArn: +// arn:aws:route53:::hostedzone/hosted zone ID . +// - For aws:SourceAccount , supply the account ID for the account that creates +// the query logging configuration. For example, aws:SourceAccount:111111111111 . +// For more information, see The confused deputy problem (https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) +// in the Amazon Web Services IAM User Guide. You can't use the CloudWatch console +// to create or edit a resource policy. You must use the CloudWatch API, one of the +// Amazon Web Services SDKs, or the CLI. +// +// Log Streams and Edge Locations When Route 53 finishes creating the +// configuration for DNS query logging, it does the following: +// - Creates a log stream for an edge location the first time that the edge +// location responds to DNS queries for the specified hosted zone. That log stream +// is used to log all queries that Route 53 responds to for that edge location. +// - Begins to send query logs to the applicable log stream. +// +// The name of each log stream is in the following format: hosted zone ID/edge +// location code The edge location code is a three-letter code and an arbitrarily +// assigned number, for example, DFW3. The three-letter code typically corresponds +// with the International Air Transport Association airport code for an airport +// near the edge location. (These abbreviations might change in the future.) For a +// list of edge locations, see "The Route 53 Global Network" on the Route 53 +// Product Details (http://aws.amazon.com/route53/details/) page. Queries That Are +// Logged Query logs contain only the queries that DNS resolvers forward to Route +// 53. If a DNS resolver has already cached the response to a query (such as the IP +// address for a load balancer for example.com), the resolver will continue to +// return the cached response. It doesn't forward another query to Route 53 until +// the TTL for the corresponding resource record set expires. Depending on how many +// DNS queries are submitted for a resource record set, and depending on the TTL +// for that resource record set, query logs might contain information about only +// one query out of every several thousand queries that are submitted to DNS. For +// more information about how DNS works, see Routing Internet Traffic to Your +// Website or Web Application (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) // in the Amazon Route 53 Developer Guide. Log File Format For a list of the values -// in each query log and the format of each value, see Logging DNS Queries -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in -// the Amazon Route 53 Developer Guide. Pricing For information about charges for -// query logs, see Amazon CloudWatch Pricing -// (http://aws.amazon.com/cloudwatch/pricing/). How to Stop Logging If you want -// Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging -// configuration. For more information, see DeleteQueryLoggingConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html). +// in each query log and the format of each value, see Logging DNS Queries (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) +// in the Amazon Route 53 Developer Guide. Pricing For information about charges +// for query logs, see Amazon CloudWatch Pricing (http://aws.amazon.com/cloudwatch/pricing/) +// . How to Stop Logging If you want Route 53 to stop sending query logs to +// CloudWatch Logs, delete the query logging configuration. For more information, +// see DeleteQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html) +// . func (c *Client) CreateQueryLoggingConfig(ctx context.Context, params *CreateQueryLoggingConfigInput, optFns ...func(*Options)) (*CreateQueryLoggingConfigOutput, error) { if params == nil { params = &CreateQueryLoggingConfigInput{} @@ -138,10 +109,8 @@ type CreateQueryLoggingConfigInput struct { // The Amazon Resource Name (ARN) for the log group that you want to Amazon Route // 53 to send query logs to. This is the format of the ARN: // arn:aws:logs:region:account-id:log-group:log_group_name To get the ARN for a log - // group, you can use the CloudWatch console, the DescribeLogGroups - // (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html) - // API action, the describe-log-groups - // (https://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html) + // group, you can use the CloudWatch console, the DescribeLogGroups (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html) + // API action, the describe-log-groups (https://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html) // command, or the applicable command in one of the Amazon Web Services SDKs. // // This member is required. @@ -163,9 +132,9 @@ type CreateQueryLoggingConfigOutput struct { // This member is required. Location *string - // A complex type that contains the ID for a query logging configuration, the ID of - // the hosted zone that you want to log queries for, and the ARN for the log group - // that you want Amazon Route 53 to send query logs to. + // A complex type that contains the ID for a query logging configuration, the ID + // of the hosted zone that you want to log queries for, and the ARN for the log + // group that you want Amazon Route 53 to send query logs to. // // This member is required. QueryLoggingConfig *types.QueryLoggingConfig diff --git a/service/route53/api_op_CreateReusableDelegationSet.go b/service/route53/api_op_CreateReusableDelegationSet.go index 5f02166d08d..0b41380666f 100644 --- a/service/route53/api_op_CreateReusableDelegationSet.go +++ b/service/route53/api_op_CreateReusableDelegationSet.go @@ -18,47 +18,31 @@ import ( // the CreateReusableDelegationSet request. You can't associate a reusable // delegation set with a private hosted zone. For information about using a // reusable delegation set to configure white label name servers, see Configuring -// White Label Name Servers -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/white-label-name-servers.html). -// The process for migrating existing hosted zones to use a reusable delegation set -// is comparable to the process for configuring white label name servers. You need -// to perform the following steps: +// White Label Name Servers (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/white-label-name-servers.html) +// . The process for migrating existing hosted zones to use a reusable delegation +// set is comparable to the process for configuring white label name servers. You +// need to perform the following steps: +// - Create a reusable delegation set. +// - Recreate hosted zones, and reduce the TTL to 60 seconds or less. +// - Recreate resource record sets in the new hosted zones. +// - Change the registrar's name servers to use the name servers for the new +// hosted zones. +// - Monitor traffic for the website or application. +// - Change TTLs back to their original values. // -// * Create a reusable delegation set. -// -// * Recreate -// hosted zones, and reduce the TTL to 60 seconds or less. -// -// * Recreate resource -// record sets in the new hosted zones. -// -// * Change the registrar's name servers to -// use the name servers for the new hosted zones. -// -// * Monitor traffic for the -// website or application. -// -// * Change TTLs back to their original values. -// -// If you -// want to migrate existing hosted zones to use a reusable delegation set, the -// existing hosted zones can't use any of the name servers that are assigned to the -// reusable delegation set. If one or more hosted zones do use one or more name +// If you want to migrate existing hosted zones to use a reusable delegation set, +// the existing hosted zones can't use any of the name servers that are assigned to +// the reusable delegation set. If one or more hosted zones do use one or more name // servers that are assigned to the reusable delegation set, you can do one of the // following: -// -// * For small numbers of hosted zones—up to a few hundred—it's -// relatively easy to create reusable delegation sets until you get one that has -// four name servers that don't overlap with any of the name servers in your hosted -// zones. -// -// * For larger numbers of hosted zones, the easiest solution is to use -// more than one reusable delegation set. -// -// * For larger numbers of hosted zones, -// you can also migrate hosted zones that have overlapping name servers to hosted -// zones that don't have overlapping name servers, then migrate the hosted zones -// again to use the reusable delegation set. +// - For small numbers of hosted zones—up to a few hundred—it's relatively easy +// to create reusable delegation sets until you get one that has four name servers +// that don't overlap with any of the name servers in your hosted zones. +// - For larger numbers of hosted zones, the easiest solution is to use more +// than one reusable delegation set. +// - For larger numbers of hosted zones, you can also migrate hosted zones that +// have overlapping name servers to hosted zones that don't have overlapping name +// servers, then migrate the hosted zones again to use the reusable delegation set. func (c *Client) CreateReusableDelegationSet(ctx context.Context, params *CreateReusableDelegationSetInput, optFns ...func(*Options)) (*CreateReusableDelegationSetOutput, error) { if params == nil { params = &CreateReusableDelegationSetInput{} @@ -76,11 +60,11 @@ func (c *Client) CreateReusableDelegationSet(ctx context.Context, params *Create type CreateReusableDelegationSetInput struct { - // A unique string that identifies the request, and that allows you to retry failed - // CreateReusableDelegationSet requests without the risk of executing the operation - // twice. You must use a unique CallerReference string every time you submit a - // CreateReusableDelegationSet request. CallerReference can be any unique string, - // for example a date/time stamp. + // A unique string that identifies the request, and that allows you to retry + // failed CreateReusableDelegationSet requests without the risk of executing the + // operation twice. You must use a unique CallerReference string every time you + // submit a CreateReusableDelegationSet request. CallerReference can be any unique + // string, for example a date/time stamp. // // This member is required. CallerReference *string diff --git a/service/route53/api_op_CreateTrafficPolicy.go b/service/route53/api_op_CreateTrafficPolicy.go index 2ed676c816a..73a858820ca 100644 --- a/service/route53/api_op_CreateTrafficPolicy.go +++ b/service/route53/api_op_CreateTrafficPolicy.go @@ -34,8 +34,8 @@ func (c *Client) CreateTrafficPolicy(ctx context.Context, params *CreateTrafficP type CreateTrafficPolicyInput struct { // The definition of this traffic policy in JSON format. For more information, see - // Traffic Policy Document Format - // (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html). + // Traffic Policy Document Format (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html) + // . // // This member is required. Document *string diff --git a/service/route53/api_op_CreateTrafficPolicyInstance.go b/service/route53/api_op_CreateTrafficPolicyInstance.go index b5e37122bdb..81e36bbcf21 100644 --- a/service/route53/api_op_CreateTrafficPolicyInstance.go +++ b/service/route53/api_op_CreateTrafficPolicyInstance.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates resource record sets in a specified hosted zone based on the settings in -// a specified traffic policy version. In addition, CreateTrafficPolicyInstance +// Creates resource record sets in a specified hosted zone based on the settings +// in a specified traffic policy version. In addition, CreateTrafficPolicyInstance // associates the resource record sets with a specified domain name (such as // example.com) or subdomain name (such as www.example.com). Amazon Route 53 // responds to DNS queries for the domain or subdomain name by using the resource @@ -32,8 +32,8 @@ func (c *Client) CreateTrafficPolicyInstance(ctx context.Context, params *Create return out, nil } -// A complex type that contains information about the resource record sets that you -// want to create based on a specified traffic policy. +// A complex type that contains information about the resource record sets that +// you want to create based on a specified traffic policy. type CreateTrafficPolicyInstanceInput struct { // The ID of the hosted zone that you want Amazon Route 53 to create resource @@ -55,14 +55,14 @@ type CreateTrafficPolicyInstanceInput struct { // This member is required. TTL *int64 - // The ID of the traffic policy that you want to use to create resource record sets - // in the specified hosted zone. + // The ID of the traffic policy that you want to use to create resource record + // sets in the specified hosted zone. // // This member is required. TrafficPolicyId *string - // The version of the traffic policy that you want to use to create resource record - // sets in the specified hosted zone. + // The version of the traffic policy that you want to use to create resource + // record sets in the specified hosted zone. // // This member is required. TrafficPolicyVersion *int32 diff --git a/service/route53/api_op_CreateTrafficPolicyVersion.go b/service/route53/api_op_CreateTrafficPolicyVersion.go index 67cc83d033d..cc2fb28b15e 100644 --- a/service/route53/api_op_CreateTrafficPolicyVersion.go +++ b/service/route53/api_op_CreateTrafficPolicyVersion.go @@ -40,8 +40,8 @@ type CreateTrafficPolicyVersionInput struct { // The definition of this version of the traffic policy, in JSON format. You // specified the JSON in the CreateTrafficPolicyVersion request. For more - // information about the JSON format, see CreateTrafficPolicy - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html). + // information about the JSON format, see CreateTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html) + // . // // This member is required. Document *string diff --git a/service/route53/api_op_DeactivateKeySigningKey.go b/service/route53/api_op_DeactivateKeySigningKey.go index c9e4536c544..e4aab8c87ce 100644 --- a/service/route53/api_op_DeactivateKeySigningKey.go +++ b/service/route53/api_op_DeactivateKeySigningKey.go @@ -12,7 +12,7 @@ import ( ) // Deactivates a key-signing key (KSK) so that it will not be used for signing by -// DNSSEC. This operation changes the KSK status to INACTIVE. +// DNSSEC. This operation changes the KSK status to INACTIVE . func (c *Client) DeactivateKeySigningKey(ctx context.Context, params *DeactivateKeySigningKeyInput, optFns ...func(*Options)) (*DeactivateKeySigningKeyOutput, error) { if params == nil { params = &DeactivateKeySigningKeyInput{} diff --git a/service/route53/api_op_DeleteHealthCheck.go b/service/route53/api_op_DeleteHealthCheck.go index e1f85c3e174..f9178c84631 100644 --- a/service/route53/api_op_DeleteHealthCheck.go +++ b/service/route53/api_op_DeleteHealthCheck.go @@ -16,8 +16,7 @@ import ( // resource record sets, the future status of the health check can't be predicted // and may change. This will affect the routing of DNS queries for your DNS // failover configuration. For more information, see Replacing and Deleting Health -// Checks -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html#health-checks-deleting.html) +// Checks (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html#health-checks-deleting.html) // in the Amazon Route 53 Developer Guide. If you're using Cloud Map and you // configured Cloud Map to create a Route 53 health check when you register an // instance, you can't use the Route 53 DeleteHealthCheck command to delete the diff --git a/service/route53/api_op_DeleteHostedZone.go b/service/route53/api_op_DeleteHostedZone.go index 2f128ebcec6..4a868300af9 100644 --- a/service/route53/api_op_DeleteHostedZone.go +++ b/service/route53/api_op_DeleteHostedZone.go @@ -13,8 +13,7 @@ import ( // Deletes a hosted zone. If the hosted zone was created by another service, such // as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another -// Service -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html#delete-public-hosted-zone-created-by-another-service) +// Service (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html#delete-public-hosted-zone-created-by-another-service) // in the Amazon Route 53 Developer Guide for information about how to delete it. // (The process is the same for public and private hosted zones that were created // by another service.) If you want to keep your domain registration but you want @@ -30,8 +29,7 @@ import ( // charge for the hosted zone, you can transfer DNS service for the domain to a // free DNS service. When you transfer DNS service, you have to update the name // servers for the domain registration. If the domain is registered with Route 53, -// see UpdateDomainNameservers -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainNameservers.html) +// see UpdateDomainNameservers (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainNameservers.html) // for information about how to replace Route 53 name servers with name servers for // the new DNS service. If the domain is registered with another registrar, use the // method provided by the registrar to update name servers for the domain @@ -41,16 +39,11 @@ import ( // record sets, you must delete them before you can delete the hosted zone. If you // try to delete a hosted zone that contains other resource record sets, the // request fails, and Route 53 returns a HostedZoneNotEmpty error. For information -// about deleting records from your hosted zone, see ChangeResourceRecordSets -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html). -// To verify that the hosted zone has been deleted, do one of the following: -// -// * Use -// the GetHostedZone action to request information about the hosted zone. -// -// * Use -// the ListHostedZones action to get a list of the hosted zones associated with the -// current Amazon Web Services account. +// about deleting records from your hosted zone, see ChangeResourceRecordSets (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) +// . To verify that the hosted zone has been deleted, do one of the following: +// - Use the GetHostedZone action to request information about the hosted zone. +// - Use the ListHostedZones action to get a list of the hosted zones associated +// with the current Amazon Web Services account. func (c *Client) DeleteHostedZone(ctx context.Context, params *DeleteHostedZoneInput, optFns ...func(*Options)) (*DeleteHostedZoneOutput, error) { if params == nil { params = &DeleteHostedZoneInput{} diff --git a/service/route53/api_op_DeleteKeySigningKey.go b/service/route53/api_op_DeleteKeySigningKey.go index 0e44d27d11e..8db002dd2b9 100644 --- a/service/route53/api_op_DeleteKeySigningKey.go +++ b/service/route53/api_op_DeleteKeySigningKey.go @@ -14,11 +14,9 @@ import ( // Deletes a key-signing key (KSK). Before you can delete a KSK, you must // deactivate it. The KSK must be deactivated before you can delete it regardless // of whether the hosted zone is enabled for DNSSEC signing. You can use -// DeactivateKeySigningKey -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeactivateKeySigningKey.html) -// to deactivate the key before you delete it. Use GetDNSSEC -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetDNSSEC.html) to -// verify that the KSK is in an INACTIVE status. +// DeactivateKeySigningKey (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeactivateKeySigningKey.html) +// to deactivate the key before you delete it. Use GetDNSSEC (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetDNSSEC.html) +// to verify that the KSK is in an INACTIVE status. func (c *Client) DeleteKeySigningKey(ctx context.Context, params *DeleteKeySigningKeyInput, optFns ...func(*Options)) (*DeleteKeySigningKeyOutput, error) { if params == nil { params = &DeleteKeySigningKeyInput{} diff --git a/service/route53/api_op_DeleteQueryLoggingConfig.go b/service/route53/api_op_DeleteQueryLoggingConfig.go index 58fc18fee80..4c973f060e8 100644 --- a/service/route53/api_op_DeleteQueryLoggingConfig.go +++ b/service/route53/api_op_DeleteQueryLoggingConfig.go @@ -13,8 +13,8 @@ import ( // Deletes a configuration for DNS query logging. If you delete a configuration, // Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't // delete any logs that are already in CloudWatch Logs. For more information about -// DNS query logs, see CreateQueryLoggingConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html). +// DNS query logs, see CreateQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html) +// . func (c *Client) DeleteQueryLoggingConfig(ctx context.Context, params *DeleteQueryLoggingConfigInput, optFns ...func(*Options)) (*DeleteQueryLoggingConfigOutput, error) { if params == nil { params = &DeleteQueryLoggingConfigInput{} diff --git a/service/route53/api_op_DeleteReusableDelegationSet.go b/service/route53/api_op_DeleteReusableDelegationSet.go index f05692cb4fc..75eb066714e 100644 --- a/service/route53/api_op_DeleteReusableDelegationSet.go +++ b/service/route53/api_op_DeleteReusableDelegationSet.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a reusable delegation set. You can delete a reusable delegation set only -// if it isn't associated with any hosted zones. To verify that the reusable +// Deletes a reusable delegation set. You can delete a reusable delegation set +// only if it isn't associated with any hosted zones. To verify that the reusable // delegation set is not associated with any hosted zones, submit a -// GetReusableDelegationSet -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSet.html) +// GetReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSet.html) // request and specify the ID of the reusable delegation set that you want to // delete. func (c *Client) DeleteReusableDelegationSet(ctx context.Context, params *DeleteReusableDelegationSetInput, optFns ...func(*Options)) (*DeleteReusableDelegationSetOutput, error) { diff --git a/service/route53/api_op_DeleteTrafficPolicy.go b/service/route53/api_op_DeleteTrafficPolicy.go index 550eb5463f9..6abff56e754 100644 --- a/service/route53/api_op_DeleteTrafficPolicy.go +++ b/service/route53/api_op_DeleteTrafficPolicy.go @@ -10,21 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a traffic policy. When you delete a traffic policy, Route 53 sets a flag -// on the policy to indicate that it has been deleted. However, Route 53 never +// Deletes a traffic policy. When you delete a traffic policy, Route 53 sets a +// flag on the policy to indicate that it has been deleted. However, Route 53 never // fully deletes the traffic policy. Note the following: -// -// * Deleted traffic -// policies aren't listed if you run ListTrafficPolicies -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListTrafficPolicies.html). -// -// * -// There's no way to get a list of deleted policies. -// -// * If you retain the ID of the -// policy, you can get information about the policy, including the traffic policy -// document, by running GetTrafficPolicy -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html). +// - Deleted traffic policies aren't listed if you run ListTrafficPolicies (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListTrafficPolicies.html) +// . +// - There's no way to get a list of deleted policies. +// - If you retain the ID of the policy, you can get information about the +// policy, including the traffic policy document, by running GetTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html) +// . func (c *Client) DeleteTrafficPolicy(ctx context.Context, params *DeleteTrafficPolicyInput, optFns ...func(*Options)) (*DeleteTrafficPolicyOutput, error) { if params == nil { params = &DeleteTrafficPolicyInput{} diff --git a/service/route53/api_op_DeleteTrafficPolicyInstance.go b/service/route53/api_op_DeleteTrafficPolicyInstance.go index 5c49d851f57..1761ec67802 100644 --- a/service/route53/api_op_DeleteTrafficPolicyInstance.go +++ b/service/route53/api_op_DeleteTrafficPolicyInstance.go @@ -31,9 +31,9 @@ func (c *Client) DeleteTrafficPolicyInstance(ctx context.Context, params *Delete // A request to delete a specified traffic policy instance. type DeleteTrafficPolicyInstanceInput struct { - // The ID of the traffic policy instance that you want to delete. When you delete a - // traffic policy instance, Amazon Route 53 also deletes all of the resource record - // sets that were created when you created the traffic policy instance. + // The ID of the traffic policy instance that you want to delete. When you delete + // a traffic policy instance, Amazon Route 53 also deletes all of the resource + // record sets that were created when you created the traffic policy instance. // // This member is required. Id *string diff --git a/service/route53/api_op_DeleteVPCAssociationAuthorization.go b/service/route53/api_op_DeleteVPCAssociationAuthorization.go index 81c8a0673a0..21917307176 100644 --- a/service/route53/api_op_DeleteVPCAssociationAuthorization.go +++ b/service/route53/api_op_DeleteVPCAssociationAuthorization.go @@ -19,7 +19,7 @@ import ( // with the Amazon Route 53 hosted zone in the future. If the VPC is already // associated with the hosted zone, DeleteVPCAssociationAuthorization won't // disassociate the VPC from the hosted zone. If you want to delete an existing -// association, use DisassociateVPCFromHostedZone. +// association, use DisassociateVPCFromHostedZone . func (c *Client) DeleteVPCAssociationAuthorization(ctx context.Context, params *DeleteVPCAssociationAuthorizationInput, optFns ...func(*Options)) (*DeleteVPCAssociationAuthorizationOutput, error) { if params == nil { params = &DeleteVPCAssociationAuthorizationInput{} diff --git a/service/route53/api_op_DisassociateVPCFromHostedZone.go b/service/route53/api_op_DisassociateVPCFromHostedZone.go index bbe7fdad48a..2199b21ea55 100644 --- a/service/route53/api_op_DisassociateVPCFromHostedZone.go +++ b/service/route53/api_op_DisassociateVPCFromHostedZone.go @@ -14,43 +14,32 @@ import ( // Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route // 53 private hosted zone. Note the following: // -// * You can't disassociate the last -// Amazon VPC from a private hosted zone. +// - You can't disassociate the last Amazon VPC from a private hosted zone. // -// * You can't convert a private hosted -// zone into a public hosted zone. +// - You can't convert a private hosted zone into a public hosted zone. // -// * You can submit a -// DisassociateVPCFromHostedZone request using either the account that created the -// hosted zone or the account that created the Amazon VPC. +// - You can submit a DisassociateVPCFromHostedZone request using either the +// account that created the hosted zone or the account that created the Amazon VPC. // -// * Some services, such -// as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create -// hosted zones and associate VPCs with the hosted zones. A service can create a -// hosted zone using your account or using its own account. You can disassociate a -// VPC from a hosted zone only if the service created the hosted zone using your -// account. When you run DisassociateVPCFromHostedZone -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html), -// if the hosted zone has a value for OwningAccount, you can use -// DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, -// you can't use DisassociateVPCFromHostedZone. +// - Some services, such as Cloud Map and Amazon Elastic File System (Amazon +// EFS) automatically create hosted zones and associate VPCs with the hosted zones. +// A service can create a hosted zone using your account or using its own account. +// You can disassociate a VPC from a hosted zone only if the service created the +// hosted zone using your account. When you run DisassociateVPCFromHostedZone (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html) +// , if the hosted zone has a value for OwningAccount , you can use +// DisassociateVPCFromHostedZone . If the hosted zone has a value for +// OwningService , you can't use DisassociateVPCFromHostedZone . // -// When revoking access, the hosted -// zone and the Amazon VPC must belong to the same partition. A partition is a -// group of Amazon Web Services Regions. Each Amazon Web Services account is scoped -// to one partition. The following are the supported partitions: +// When revoking access, the hosted zone and the Amazon VPC must belong to the +// same partition. A partition is a group of Amazon Web Services Regions. Each +// Amazon Web Services account is scoped to one partition. The following are the +// supported partitions: +// - aws - Amazon Web Services Regions +// - aws-cn - China Regions +// - aws-us-gov - Amazon Web Services GovCloud (US) Region // -// * aws - Amazon -// Web Services Regions -// -// * aws-cn - China Regions -// -// * aws-us-gov - Amazon Web -// Services GovCloud (US) Region -// -// For more information, see Access Management -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the Amazon Web Services General Reference. +// For more information, see Access Management (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the Amazon Web Services General Reference. func (c *Client) DisassociateVPCFromHostedZone(ctx context.Context, params *DisassociateVPCFromHostedZoneInput, optFns ...func(*Options)) (*DisassociateVPCFromHostedZoneOutput, error) { if params == nil { params = &DisassociateVPCFromHostedZoneInput{} diff --git a/service/route53/api_op_GetAccountLimit.go b/service/route53/api_op_GetAccountLimit.go index d50c71ac534..39a21fc8c9c 100644 --- a/service/route53/api_op_GetAccountLimit.go +++ b/service/route53/api_op_GetAccountLimit.go @@ -13,15 +13,12 @@ import ( // Gets the specified limit for the current account, for example, the maximum // number of health checks that you can create using the account. For the default -// limit, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) -// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case -// (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53). -// You can also view account limits in Amazon Web Services Trusted Advisor. Sign in -// to the Amazon Web Services Management Console and open the Trusted Advisor -// console at https://console.aws.amazon.com/trustedadvisor/ -// (https://console.aws.amazon.com/trustedadvisor). Then choose Service limits in -// the navigation pane. +// limit, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53) +// . You can also view account limits in Amazon Web Services Trusted Advisor. Sign +// in to the Amazon Web Services Management Console and open the Trusted Advisor +// console at https://console.aws.amazon.com/trustedadvisor/ (https://console.aws.amazon.com/trustedadvisor) +// . Then choose Service limits in the navigation pane. func (c *Client) GetAccountLimit(ctx context.Context, params *GetAccountLimitInput, optFns ...func(*Options)) (*GetAccountLimitOutput, error) { if params == nil { params = &GetAccountLimitInput{} @@ -42,26 +39,18 @@ func (c *Client) GetAccountLimit(ctx context.Context, params *GetAccountLimitInp type GetAccountLimitInput struct { // The limit that you want to get. Valid values include the following: - // - // * - // MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can - // create using the current account. - // - // * MAX_HOSTED_ZONES_BY_OWNER: The maximum - // number of hosted zones that you can create using the current account. - // - // * - // MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation - // sets that you can create using the current account. - // - // * - // MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you - // can create using the current account. - // - // * MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: - // The maximum number of traffic policy instances that you can create using the - // current account. (Traffic policy instances are referred to as traffic flow - // policy records in the Amazon Route 53 console.) + // - MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you + // can create using the current account. + // - MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can + // create using the current account. + // - MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable + // delegation sets that you can create using the current account. + // - MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that + // you can create using the current account. + // - MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy + // instances that you can create using the current account. (Traffic policy + // instances are referred to as traffic flow policy records in the Amazon Route 53 + // console.) // // This member is required. Type types.AccountLimitType diff --git a/service/route53/api_op_GetChange.go b/service/route53/api_op_GetChange.go index a0f1dfa7034..fa770cc5bae 100644 --- a/service/route53/api_op_GetChange.go +++ b/service/route53/api_op_GetChange.go @@ -18,13 +18,11 @@ import ( // Returns the current status of a change batch request. The status is one of the // following values: -// -// * PENDING indicates that the changes in this request have not -// propagated to all Amazon Route 53 DNS servers. This is the initial status of all -// change batch requests. -// -// * INSYNC indicates that the changes have propagated to -// all Route 53 DNS servers. +// - PENDING indicates that the changes in this request have not propagated to +// all Amazon Route 53 DNS servers. This is the initial status of all change batch +// requests. +// - INSYNC indicates that the changes have propagated to all Route 53 DNS +// servers. func (c *Client) GetChange(ctx context.Context, params *GetChangeInput, optFns ...func(*Options)) (*GetChangeOutput, error) { if params == nil { params = &GetChangeInput{} @@ -43,9 +41,9 @@ func (c *Client) GetChange(ctx context.Context, params *GetChangeInput, optFns . // The input for a GetChange request. type GetChangeInput struct { - // The ID of the change batch request. The value that you specify here is the value - // that ChangeResourceRecordSets returned in the Id element when you submitted the - // request. + // The ID of the change batch request. The value that you specify here is the + // value that ChangeResourceRecordSets returned in the Id element when you + // submitted the request. // // This member is required. Id *string @@ -154,8 +152,8 @@ type ResourceRecordSetsChangedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ResourceRecordSetsChangedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ResourceRecordSetsChangedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -206,10 +204,10 @@ func (w *ResourceRecordSetsChangedWaiter) Wait(ctx context.Context, params *GetC return err } -// WaitForOutput calls the waiter function for ResourceRecordSetsChanged waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for ResourceRecordSetsChanged waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *ResourceRecordSetsChangedWaiter) WaitForOutput(ctx context.Context, params *GetChangeInput, maxWaitDur time.Duration, optFns ...func(*ResourceRecordSetsChangedWaiterOptions)) (*GetChangeOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/route53/api_op_GetCheckerIpRanges.go b/service/route53/api_op_GetCheckerIpRanges.go index 1f9c9c30328..aafb215367c 100644 --- a/service/route53/api_op_GetCheckerIpRanges.go +++ b/service/route53/api_op_GetCheckerIpRanges.go @@ -14,8 +14,7 @@ import ( // information that is already available to the public. GetCheckerIpRanges still // works, but we recommend that you download ip-ranges.json, which includes IP // address ranges for all Amazon Web Services services. For more information, see -// IP Address Ranges of Amazon Route 53 Servers -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html) +// IP Address Ranges of Amazon Route 53 Servers (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html) // in the Amazon Route 53 Developer Guide. func (c *Client) GetCheckerIpRanges(ctx context.Context, params *GetCheckerIpRangesInput, optFns ...func(*Options)) (*GetCheckerIpRangesOutput, error) { if params == nil { diff --git a/service/route53/api_op_GetGeoLocation.go b/service/route53/api_op_GetGeoLocation.go index fed5cdd1a37..d7cd1971b5c 100644 --- a/service/route53/api_op_GetGeoLocation.go +++ b/service/route53/api_op_GetGeoLocation.go @@ -20,8 +20,9 @@ import ( // Use the following syntax to determine whether a country is supported for // geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code // Use the following syntax to determine whether a subdivision of a country is -// supported for geolocation: GET /2013-04-01/geolocation?countrycode=two-character -// country code&subdivisioncode=subdivision code +// supported for geolocation: GET +// /2013-04-01/geolocation?countrycode=two-character country +// code&subdivisioncode=subdivision code func (c *Client) GetGeoLocation(ctx context.Context, params *GetGeoLocationInput, optFns ...func(*Options)) (*GetGeoLocationOutput, error) { if params == nil { params = &GetGeoLocationInput{} @@ -43,34 +44,24 @@ type GetGeoLocationInput struct { // For geolocation resource record sets, a two-letter abbreviation that identifies // a continent. Amazon Route 53 supports the following continent codes: - // - // * AF: - // Africa - // - // * AN: Antarctica - // - // * AS: Asia - // - // * EU: Europe - // - // * OC: Oceania - // - // * NA: North - // America - // - // * SA: South America + // - AF: Africa + // - AN: Antarctica + // - AS: Asia + // - EU: Europe + // - OC: Oceania + // - NA: North America + // - SA: South America ContinentCode *string // Amazon Route 53 uses the two-letter country codes that are specified in ISO - // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // standard 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) . CountryCode *string // The code for the subdivision, such as a particular state within the United // States. For a list of US state abbreviations, see Appendix B: Two–Letter State // and Possession Abbreviations (https://pe.usps.com/text/pub28/28apb.htm) on the // United States Postal Service website. For a list of all supported subdivision - // codes, use the ListGeoLocations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html) + // codes, use the ListGeoLocations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html) // API. SubdivisionCode *string diff --git a/service/route53/api_op_GetHealthCheckLastFailureReason.go b/service/route53/api_op_GetHealthCheckLastFailureReason.go index 55bdb6edbde..d154a046000 100644 --- a/service/route53/api_op_GetHealthCheckLastFailureReason.go +++ b/service/route53/api_op_GetHealthCheckLastFailureReason.go @@ -30,11 +30,11 @@ func (c *Client) GetHealthCheckLastFailureReason(ctx context.Context, params *Ge // A request for the reason that a health check failed most recently. type GetHealthCheckLastFailureReasonInput struct { - // The ID for the health check for which you want the last failure reason. When you - // created the health check, CreateHealthCheck returned the ID in the response, in - // the HealthCheckId element. If you want to get the last failure reason for a - // calculated health check, you must use the Amazon Route 53 console or the - // CloudWatch console. You can't use GetHealthCheckLastFailureReason for a + // The ID for the health check for which you want the last failure reason. When + // you created the health check, CreateHealthCheck returned the ID in the + // response, in the HealthCheckId element. If you want to get the last failure + // reason for a calculated health check, you must use the Amazon Route 53 console + // or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a // calculated health check. // // This member is required. diff --git a/service/route53/api_op_GetHealthCheckStatus.go b/service/route53/api_op_GetHealthCheckStatus.go index 3b66233ef3c..a25da127fee 100644 --- a/service/route53/api_op_GetHealthCheckStatus.go +++ b/service/route53/api_op_GetHealthCheckStatus.go @@ -48,8 +48,8 @@ type GetHealthCheckStatusInput struct { // A complex type that contains the response to a GetHealthCheck request. type GetHealthCheckStatusOutput struct { - // A list that contains one HealthCheckObservation element for each Amazon Route 53 - // health checker that is reporting a status about the health check endpoint. + // A list that contains one HealthCheckObservation element for each Amazon Route + // 53 health checker that is reporting a status about the health check endpoint. // // This member is required. HealthCheckObservations []types.HealthCheckObservation diff --git a/service/route53/api_op_GetHostedZone.go b/service/route53/api_op_GetHostedZone.go index ccd2ca61f3c..7b7e0871d6a 100644 --- a/service/route53/api_op_GetHostedZone.go +++ b/service/route53/api_op_GetHostedZone.go @@ -52,8 +52,8 @@ type GetHostedZoneOutput struct { // hosted zone. DelegationSet *types.DelegationSet - // A complex type that contains information about the VPCs that are associated with - // the specified hosted zone. + // A complex type that contains information about the VPCs that are associated + // with the specified hosted zone. VPCs []types.VPC // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_GetHostedZoneCount.go b/service/route53/api_op_GetHostedZoneCount.go index 1af1a2823f1..f307955d1c8 100644 --- a/service/route53/api_op_GetHostedZoneCount.go +++ b/service/route53/api_op_GetHostedZoneCount.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the number of hosted zones that are associated with the current Amazon -// Web Services account. +// Retrieves the number of hosted zones that are associated with the current +// Amazon Web Services account. func (c *Client) GetHostedZoneCount(ctx context.Context, params *GetHostedZoneCountInput, optFns ...func(*Options)) (*GetHostedZoneCountOutput, error) { if params == nil { params = &GetHostedZoneCountInput{} @@ -36,8 +36,8 @@ type GetHostedZoneCountInput struct { // A complex type that contains the response to a GetHostedZoneCount request. type GetHostedZoneCountOutput struct { - // The total number of public and private hosted zones that are associated with the - // current Amazon Web Services account. + // The total number of public and private hosted zones that are associated with + // the current Amazon Web Services account. // // This member is required. HostedZoneCount *int64 diff --git a/service/route53/api_op_GetHostedZoneLimit.go b/service/route53/api_op_GetHostedZoneLimit.go index 157efd0aa4e..04876fa954f 100644 --- a/service/route53/api_op_GetHostedZoneLimit.go +++ b/service/route53/api_op_GetHostedZoneLimit.go @@ -13,10 +13,9 @@ import ( // Gets the specified limit for a specified hosted zone, for example, the maximum // number of records that you can create in the hosted zone. For the default limit, -// see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) -// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case -// (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53). +// see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53) +// . func (c *Client) GetHostedZoneLimit(ctx context.Context, params *GetHostedZoneLimitInput, optFns ...func(*Options)) (*GetHostedZoneLimitOutput, error) { if params == nil { params = &GetHostedZoneLimitInput{} @@ -42,13 +41,10 @@ type GetHostedZoneLimitInput struct { HostedZoneId *string // The limit that you want to get. Valid values include the following: - // - // * - // MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the - // specified hosted zone. - // - // * MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of - // Amazon VPCs that you can associate with the specified private hosted zone. + // - MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in + // the specified hosted zone. + // - MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can + // associate with the specified private hosted zone. // // This member is required. Type types.HostedZoneLimitType diff --git a/service/route53/api_op_GetQueryLoggingConfig.go b/service/route53/api_op_GetQueryLoggingConfig.go index ac0bf2dea30..4f1c3b0ebf4 100644 --- a/service/route53/api_op_GetQueryLoggingConfig.go +++ b/service/route53/api_op_GetQueryLoggingConfig.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a specified configuration for DNS query logging. For more -// information about DNS query logs, see CreateQueryLoggingConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html) -// and Logging DNS Queries -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html). +// Gets information about a specified configuration for DNS query logging. For +// more information about DNS query logs, see CreateQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html) +// and Logging DNS Queries (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) +// . func (c *Client) GetQueryLoggingConfig(ctx context.Context, params *GetQueryLoggingConfigInput, optFns ...func(*Options)) (*GetQueryLoggingConfigOutput, error) { if params == nil { params = &GetQueryLoggingConfigInput{} @@ -45,8 +44,7 @@ type GetQueryLoggingConfigInput struct { type GetQueryLoggingConfigOutput struct { // A complex type that contains information about the query logging configuration - // that you specified in a GetQueryLoggingConfig - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetQueryLoggingConfig.html) + // that you specified in a GetQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetQueryLoggingConfig.html) // request. // // This member is required. diff --git a/service/route53/api_op_GetReusableDelegationSetLimit.go b/service/route53/api_op_GetReusableDelegationSetLimit.go index 5497f1fc886..46cadc19003 100644 --- a/service/route53/api_op_GetReusableDelegationSetLimit.go +++ b/service/route53/api_op_GetReusableDelegationSetLimit.go @@ -12,10 +12,9 @@ import ( ) // Gets the maximum number of hosted zones that you can associate with the -// specified reusable delegation set. For the default limit, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) -// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case -// (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53). +// specified reusable delegation set. For the default limit, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// in the Amazon Route 53 Developer Guide. To request a higher limit, open a case (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53) +// . func (c *Client) GetReusableDelegationSetLimit(ctx context.Context, params *GetReusableDelegationSetLimitInput, optFns ...func(*Options)) (*GetReusableDelegationSetLimitOutput, error) { if params == nil { params = &GetReusableDelegationSetLimitInput{} @@ -40,8 +39,8 @@ type GetReusableDelegationSetLimitInput struct { // This member is required. DelegationSetId *string - // Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted - // zones that you can associate with the specified reusable delegation set. + // Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of + // hosted zones that you can associate with the specified reusable delegation set. // // This member is required. Type types.ReusableDelegationSetLimitType diff --git a/service/route53/api_op_GetTrafficPolicy.go b/service/route53/api_op_GetTrafficPolicy.go index c6ef6a54d68..eb009b5ece8 100644 --- a/service/route53/api_op_GetTrafficPolicy.go +++ b/service/route53/api_op_GetTrafficPolicy.go @@ -12,9 +12,9 @@ import ( ) // Gets information about a specific traffic policy version. For information about -// how of deleting a traffic policy affects the response from GetTrafficPolicy, see -// DeleteTrafficPolicy -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html). +// how of deleting a traffic policy affects the response from GetTrafficPolicy , +// see DeleteTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html) +// . func (c *Client) GetTrafficPolicy(ctx context.Context, params *GetTrafficPolicyInput, optFns ...func(*Options)) (*GetTrafficPolicyOutput, error) { if params == nil { params = &GetTrafficPolicyInput{} diff --git a/service/route53/api_op_GetTrafficPolicyInstance.go b/service/route53/api_op_GetTrafficPolicyInstance.go index 8869cb194f4..d943cb0657f 100644 --- a/service/route53/api_op_GetTrafficPolicyInstance.go +++ b/service/route53/api_op_GetTrafficPolicyInstance.go @@ -12,8 +12,8 @@ import ( ) // Gets information about a specified traffic policy instance. After you submit a -// CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a -// brief delay while Amazon Route 53 creates the resource record sets that are +// CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's +// a brief delay while Amazon Route 53 creates the resource record sets that are // specified in the traffic policy definition. For more information, see the State // response element. In the Route 53 console, traffic policy instances are known as // policy records. diff --git a/service/route53/api_op_GetTrafficPolicyInstanceCount.go b/service/route53/api_op_GetTrafficPolicyInstanceCount.go index c137ffbc973..10ac33013c1 100644 --- a/service/route53/api_op_GetTrafficPolicyInstanceCount.go +++ b/service/route53/api_op_GetTrafficPolicyInstanceCount.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the number of traffic policy instances that are associated with the current -// Amazon Web Services account. +// Gets the number of traffic policy instances that are associated with the +// current Amazon Web Services account. func (c *Client) GetTrafficPolicyInstanceCount(ctx context.Context, params *GetTrafficPolicyInstanceCountInput, optFns ...func(*Options)) (*GetTrafficPolicyInstanceCountOutput, error) { if params == nil { params = &GetTrafficPolicyInstanceCountInput{} diff --git a/service/route53/api_op_ListCidrBlocks.go b/service/route53/api_op_ListCidrBlocks.go index d025e8eacaf..aa73a6bd860 100644 --- a/service/route53/api_op_ListCidrBlocks.go +++ b/service/route53/api_op_ListCidrBlocks.go @@ -41,8 +41,8 @@ type ListCidrBlocksInput struct { // Maximum number of results you want returned. MaxResults *int32 - // An opaque pagination token to indicate where the service is to begin enumerating - // results. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. NextToken *string noSmithyDocumentSerde @@ -53,9 +53,9 @@ type ListCidrBlocksOutput struct { // A complex type that contains information about the CIDR blocks. CidrBlocks []types.CidrBlockSummary - // An opaque pagination token to indicate where the service is to begin enumerating - // results. If no value is provided, the listing of results starts from the - // beginning. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. If no value is provided, the listing of results starts from + // the beginning. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_ListCidrCollections.go b/service/route53/api_op_ListCidrCollections.go index b6f9a97e508..e6d620cd5db 100644 --- a/service/route53/api_op_ListCidrCollections.go +++ b/service/route53/api_op_ListCidrCollections.go @@ -34,9 +34,9 @@ type ListCidrCollectionsInput struct { // The maximum number of CIDR collections to return in the response. MaxResults *int32 - // An opaque pagination token to indicate where the service is to begin enumerating - // results. If no value is provided, the listing of results starts from the - // beginning. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. If no value is provided, the listing of results starts from + // the beginning. NextToken *string noSmithyDocumentSerde @@ -47,9 +47,9 @@ type ListCidrCollectionsOutput struct { // A complex type with information about the CIDR collection. CidrCollections []types.CollectionSummary - // An opaque pagination token to indicate where the service is to begin enumerating - // results. If no value is provided, the listing of results starts from the - // beginning. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. If no value is provided, the listing of results starts from + // the beginning. NextToken *string // Metadata pertaining to the operation's result. @@ -118,8 +118,8 @@ func (c *Client) addOperationListCidrCollectionsMiddlewares(stack *middleware.St return nil } -// ListCidrCollectionsAPIClient is a client that implements the ListCidrCollections -// operation. +// ListCidrCollectionsAPIClient is a client that implements the +// ListCidrCollections operation. type ListCidrCollectionsAPIClient interface { ListCidrCollections(context.Context, *ListCidrCollectionsInput, ...func(*Options)) (*ListCidrCollectionsOutput, error) } diff --git a/service/route53/api_op_ListCidrLocations.go b/service/route53/api_op_ListCidrLocations.go index 7cea7382c26..d7d7da4cffb 100644 --- a/service/route53/api_op_ListCidrLocations.go +++ b/service/route53/api_op_ListCidrLocations.go @@ -39,9 +39,9 @@ type ListCidrLocationsInput struct { // The maximum number of CIDR collection locations to return in the response. MaxResults *int32 - // An opaque pagination token to indicate where the service is to begin enumerating - // results. If no value is provided, the listing of results starts from the - // beginning. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. If no value is provided, the listing of results starts from + // the beginning. NextToken *string noSmithyDocumentSerde @@ -52,9 +52,9 @@ type ListCidrLocationsOutput struct { // A complex type that contains information about the list of CIDR locations. CidrLocations []types.LocationSummary - // An opaque pagination token to indicate where the service is to begin enumerating - // results. If no value is provided, the listing of results starts from the - // beginning. + // An opaque pagination token to indicate where the service is to begin + // enumerating results. If no value is provided, the listing of results starts from + // the beginning. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_ListGeoLocations.go b/service/route53/api_op_ListGeoLocations.go index 3dac271cb21..e5b71b417de 100644 --- a/service/route53/api_op_ListGeoLocations.go +++ b/service/route53/api_op_ListGeoLocations.go @@ -17,8 +17,7 @@ import ( // are listed in alphabetical order immediately after the corresponding country. // Route 53 does not perform authorization for this API because it retrieves // information that is already available to the public. For a list of supported -// geolocation codes, see the GeoLocation -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html) +// geolocation codes, see the GeoLocation (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html) // data type. func (c *Client) ListGeoLocations(ctx context.Context, params *ListGeoLocationsInput, optFns ...func(*Options)) (*ListGeoLocationsOutput, error) { if params == nil { @@ -41,7 +40,7 @@ type ListGeoLocationsInput struct { // (Optional) The maximum number of geolocations to be included in the response // body for this request. If more than maxitems geolocations remain to be listed, - // then the value of the IsTruncated element in the response is true. + // then the value of the IsTruncated element in the response is true . MaxItems *int32 // The code for the continent with which you want to start listing locations that @@ -55,17 +54,17 @@ type ListGeoLocationsInput struct { // The code for the country with which you want to start listing locations that // Amazon Route 53 supports for geolocation. If Route 53 has already returned a - // page or more of results, if IsTruncated is true, and if NextCountryCode from the - // previous response has a value, enter that value in startcountrycode to return - // the next page of results. + // page or more of results, if IsTruncated is true , and if NextCountryCode from + // the previous response has a value, enter that value in startcountrycode to + // return the next page of results. StartCountryCode *string - // The code for the state of the United States with which you want to start listing - // locations that Amazon Route 53 supports for geolocation. If Route 53 has already - // returned a page or more of results, if IsTruncated is true, and if + // The code for the state of the United States with which you want to start + // listing locations that Amazon Route 53 supports for geolocation. If Route 53 has + // already returned a page or more of results, if IsTruncated is true , and if // NextSubdivisionCode from the previous response has a value, enter that value in // startsubdivisioncode to return the next page of results. To list subdivisions - // (U.S. states), you must include both startcountrycode and startsubdivisioncode. + // (U.S. states), you must include both startcountrycode and startsubdivisioncode . StartSubdivisionCode *string noSmithyDocumentSerde @@ -80,11 +79,11 @@ type ListGeoLocationsOutput struct { // This member is required. GeoLocationDetailsList []types.GeoLocationDetails - // A value that indicates whether more locations remain to be listed after the last - // location in this response. If so, the value of IsTruncated is true. To get more - // values, submit another request and include the values of NextContinentCode, - // NextCountryCode, and NextSubdivisionCode in the startcontinentcode, - // startcountrycode, and startsubdivisioncode, as applicable. + // A value that indicates whether more locations remain to be listed after the + // last location in this response. If so, the value of IsTruncated is true . To get + // more values, submit another request and include the values of NextContinentCode + // , NextCountryCode , and NextSubdivisionCode in the startcontinentcode , + // startcountrycode , and startsubdivisioncode , as applicable. // // This member is required. IsTruncated bool @@ -94,17 +93,17 @@ type ListGeoLocationsOutput struct { // This member is required. MaxItems *int32 - // If IsTruncated is true, you can make a follow-up request to display more + // If IsTruncated is true , you can make a follow-up request to display more // locations. Enter the value of NextContinentCode in the startcontinentcode // parameter in another ListGeoLocations request. NextContinentCode *string - // If IsTruncated is true, you can make a follow-up request to display more + // If IsTruncated is true , you can make a follow-up request to display more // locations. Enter the value of NextCountryCode in the startcountrycode parameter // in another ListGeoLocations request. NextCountryCode *string - // If IsTruncated is true, you can make a follow-up request to display more + // If IsTruncated is true , you can make a follow-up request to display more // locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode // parameter in another ListGeoLocations request. NextSubdivisionCode *string diff --git a/service/route53/api_op_ListHealthChecks.go b/service/route53/api_op_ListHealthChecks.go index 95fc11043f3..89f655f6dee 100644 --- a/service/route53/api_op_ListHealthChecks.go +++ b/service/route53/api_op_ListHealthChecks.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieve a list of the health checks that are associated with the current Amazon -// Web Services account. +// Retrieve a list of the health checks that are associated with the current +// Amazon Web Services account. func (c *Client) ListHealthChecks(ctx context.Context, params *ListHealthChecksInput, optFns ...func(*Options)) (*ListHealthChecksOutput, error) { if params == nil { params = &ListHealthChecksInput{} @@ -33,18 +33,18 @@ func (c *Client) ListHealthChecks(ctx context.Context, params *ListHealthChecksI // current Amazon Web Services account. type ListHealthChecksInput struct { - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // health checks. To get another group, submit another ListHealthChecks request. - // For the value of marker, specify the value of NextMarker from the previous + // For the value of marker , specify the value of NextMarker from the previous // response, which is the ID of the first health check that Amazon Route 53 will // return if you submit another request. If the value of IsTruncated in the - // previous response was false, there are no more health checks to get. + // previous response was false , there are no more health checks to get. Marker *string // The maximum number of health checks that you want ListHealthChecks to return in // response to the current request. Amazon Route 53 returns a maximum of 100 items. - // If you set MaxItems to a value greater than 100, Route 53 returns only the first - // 100 health checks. + // If you set MaxItems to a value greater than 100, Route 53 returns only the + // first 100 health checks. MaxItems *int32 noSmithyDocumentSerde @@ -67,7 +67,7 @@ type ListHealthChecksOutput struct { // This member is required. IsTruncated bool - // For the second and subsequent calls to ListHealthChecks, Marker is the value + // For the second and subsequent calls to ListHealthChecks , Marker is the value // that you specified for the marker parameter in the previous request. // // This member is required. @@ -79,7 +79,7 @@ type ListHealthChecksOutput struct { // This member is required. MaxItems *int32 - // If IsTruncated is true, the value of NextMarker identifies the first health + // If IsTruncated is true , the value of NextMarker identifies the first health // check that Amazon Route 53 returns if you submit another ListHealthChecks // request and specify the value of NextMarker in the marker parameter. NextMarker *string @@ -162,8 +162,8 @@ var _ ListHealthChecksAPIClient = (*Client)(nil) type ListHealthChecksPaginatorOptions struct { // The maximum number of health checks that you want ListHealthChecks to return in // response to the current request. Amazon Route 53 returns a maximum of 100 items. - // If you set MaxItems to a value greater than 100, Route 53 returns only the first - // 100 health checks. + // If you set MaxItems to a value greater than 100, Route 53 returns only the + // first 100 health checks. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53/api_op_ListHostedZones.go b/service/route53/api_op_ListHostedZones.go index dcff1efe392..df03194735a 100644 --- a/service/route53/api_op_ListHostedZones.go +++ b/service/route53/api_op_ListHostedZones.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of the public and private hosted zones that are associated with -// the current Amazon Web Services account. The response includes a HostedZones -// child element for each hosted zone. Amazon Route 53 returns a maximum of 100 -// items in each response. If you have a lot of hosted zones, you can use the -// maxitems parameter to list them in groups of up to 100. +// Retrieves a list of the public and private hosted zones that are associated +// with the current Amazon Web Services account. The response includes a +// HostedZones child element for each hosted zone. Amazon Route 53 returns a +// maximum of 100 items in each response. If you have a lot of hosted zones, you +// can use the maxitems parameter to list them in groups of up to 100. func (c *Client) ListHostedZones(ctx context.Context, params *ListHostedZonesInput, optFns ...func(*Options)) (*ListHostedZonesOutput, error) { if params == nil { params = &ListHostedZonesInput{} @@ -41,18 +41,18 @@ type ListHostedZonesInput struct { // reusable delegation set. DelegationSetId *string - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // hosted zones. To get more hosted zones, submit another ListHostedZones request. - // For the value of marker, specify the value of NextMarker from the previous + // For the value of marker , specify the value of NextMarker from the previous // response, which is the ID of the first hosted zone that Amazon Route 53 will // return if you submit another request. If the value of IsTruncated in the - // previous response was false, there are no more hosted zones to get. + // previous response was false , there are no more hosted zones to get. Marker *string // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to - // return. If you have more than maxitems hosted zones, the value of IsTruncated in - // the response is true, and the value of NextMarker is the hosted zone ID of the - // first hosted zone that Route 53 will return if you submit another request. + // return. If you have more than maxitems hosted zones, the value of IsTruncated + // in the response is true , and the value of NextMarker is the hosted zone ID of + // the first hosted zone that Route 53 will return if you submit another request. MaxItems *int32 noSmithyDocumentSerde @@ -73,9 +73,9 @@ type ListHostedZonesOutput struct { // This member is required. IsTruncated bool - // For the second and subsequent calls to ListHostedZones, Marker is the value that - // you specified for the marker parameter in the request that produced the current - // response. + // For the second and subsequent calls to ListHostedZones , Marker is the value + // that you specified for the marker parameter in the request that produced the + // current response. // // This member is required. Marker *string @@ -86,10 +86,10 @@ type ListHostedZonesOutput struct { // This member is required. MaxItems *int32 - // If IsTruncated is true, the value of NextMarker identifies the first hosted zone - // in the next group of hosted zones. Submit another ListHostedZones request, and - // specify the value of NextMarker from the response in the marker parameter. This - // element is present only if IsTruncated is true. + // If IsTruncated is true , the value of NextMarker identifies the first hosted + // zone in the next group of hosted zones. Submit another ListHostedZones request, + // and specify the value of NextMarker from the response in the marker parameter. + // This element is present only if IsTruncated is true . NextMarker *string // Metadata pertaining to the operation's result. @@ -172,9 +172,9 @@ var _ ListHostedZonesAPIClient = (*Client)(nil) // ListHostedZonesPaginatorOptions is the paginator options for ListHostedZones type ListHostedZonesPaginatorOptions struct { // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to - // return. If you have more than maxitems hosted zones, the value of IsTruncated in - // the response is true, and the value of NextMarker is the hosted zone ID of the - // first hosted zone that Route 53 will return if you submit another request. + // return. If you have more than maxitems hosted zones, the value of IsTruncated + // in the response is true , and the value of NextMarker is the hosted zone ID of + // the first hosted zone that Route 53 will return if you submit another request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53/api_op_ListHostedZonesByName.go b/service/route53/api_op_ListHostedZonesByName.go index 10b62576e26..15898bf8d24 100644 --- a/service/route53/api_op_ListHostedZonesByName.go +++ b/service/route53/api_op_ListHostedZonesByName.go @@ -12,45 +12,39 @@ import ( ) // Retrieves a list of your hosted zones in lexicographic order. The response -// includes a HostedZones child element for each hosted zone created by the current -// Amazon Web Services account. ListHostedZonesByName sorts hosted zones by name -// with the labels reversed. For example: com.example.www. Note the trailing dot, -// which can change the sort order in some circumstances. If the domain name -// includes escape characters or Punycode, ListHostedZonesByName alphabetizes the -// domain name using the escaped or Punycoded value, which is the format that -// Amazon Route 53 saves in its database. For example, to create a hosted zone for -// exämple.com, you specify ex\344mple.com for the domain name. +// includes a HostedZones child element for each hosted zone created by the +// current Amazon Web Services account. ListHostedZonesByName sorts hosted zones +// by name with the labels reversed. For example: com.example.www. Note the +// trailing dot, which can change the sort order in some circumstances. If the +// domain name includes escape characters or Punycode, ListHostedZonesByName +// alphabetizes the domain name using the escaped or Punycoded value, which is the +// format that Amazon Route 53 saves in its database. For example, to create a +// hosted zone for exämple.com, you specify ex\344mple.com for the domain name. // ListHostedZonesByName alphabetizes it as: com.ex\344mple. The labels are // reversed and alphabetized using the escaped value. For more information about // valid domain name formats, including internationalized domain names, see DNS -// Domain Name Format -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) +// Domain Name Format (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) // in the Amazon Route 53 Developer Guide. Route 53 returns up to 100 items in each // response. If you have a lot of hosted zones, use the MaxItems parameter to list // them in groups of up to 100. The response includes values that help navigate // from one group of MaxItems hosted zones to the next: -// -// * The DNSName and -// HostedZoneId elements in the response contain the values, if any, specified for -// the dnsname and hostedzoneid parameters in the request that produced the current -// response. -// -// * The MaxItems element in the response contains the value, if any, -// that you specified for the maxitems parameter in the request that produced the -// current response. -// -// * If the value of IsTruncated in the response is true, there -// are more hosted zones associated with the current Amazon Web Services account. -// If IsTruncated is false, this response includes the last hosted zone that is -// associated with the current account. The NextDNSName element and -// NextHostedZoneId elements are omitted from the response. -// -// * The NextDNSName and -// NextHostedZoneId elements in the response contain the domain name and the hosted -// zone ID of the next hosted zone that is associated with the current Amazon Web -// Services account. If you want to list more hosted zones, make another call to -// ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId -// in the dnsname and hostedzoneid parameters, respectively. +// - The DNSName and HostedZoneId elements in the response contain the values, if +// any, specified for the dnsname and hostedzoneid parameters in the request that +// produced the current response. +// - The MaxItems element in the response contains the value, if any, that you +// specified for the maxitems parameter in the request that produced the current +// response. +// - If the value of IsTruncated in the response is true, there are more hosted +// zones associated with the current Amazon Web Services account. If IsTruncated +// is false, this response includes the last hosted zone that is associated with +// the current account. The NextDNSName element and NextHostedZoneId elements are +// omitted from the response. +// - The NextDNSName and NextHostedZoneId elements in the response contain the +// domain name and the hosted zone ID of the next hosted zone that is associated +// with the current Amazon Web Services account. If you want to list more hosted +// zones, make another call to ListHostedZonesByName , and specify the value of +// NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, +// respectively. func (c *Client) ListHostedZonesByName(ctx context.Context, params *ListHostedZonesByNameInput, optFns ...func(*Options)) (*ListHostedZonesByNameOutput, error) { if params == nil { params = &ListHostedZonesByNameInput{} @@ -66,25 +60,25 @@ func (c *Client) ListHostedZonesByName(ctx context.Context, params *ListHostedZo return out, nil } -// Retrieves a list of the public and private hosted zones that are associated with -// the current Amazon Web Services account in ASCII order by domain name. +// Retrieves a list of the public and private hosted zones that are associated +// with the current Amazon Web Services account in ASCII order by domain name. type ListHostedZonesByNameInput struct { - // (Optional) For your first request to ListHostedZonesByName, include the dnsname + // (Optional) For your first request to ListHostedZonesByName , include the dnsname // parameter only if you want to specify the name of the first hosted zone in the // response. If you don't include the dnsname parameter, Amazon Route 53 returns // all of the hosted zones that were created by the current Amazon Web Services // account, in ASCII order. For subsequent requests, include both dnsname and - // hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the - // previous response. + // hostedzoneid parameters. For dnsname , specify the value of NextDNSName from + // the previous response. DNSName *string - // (Optional) For your first request to ListHostedZonesByName, do not include the - // hostedzoneid parameter. If you have more hosted zones than the value of - // maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To - // get the next group of maxitems hosted zones, submit another request to + // (Optional) For your first request to ListHostedZonesByName , do not include the + // hostedzoneid parameter. If you have more hosted zones than the value of maxitems + // , ListHostedZonesByName returns only the first maxitems hosted zones. To get + // the next group of maxitems hosted zones, submit another request to // ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For - // the value of hostedzoneid, specify the value of the NextHostedZoneId element + // the value of hostedzoneid , specify the value of the NextHostedZoneId element // from the previous response. HostedZoneId *string @@ -108,8 +102,8 @@ type ListHostedZonesByNameOutput struct { // A flag that indicates whether there are more hosted zones to be listed. If the // response was truncated, you can get the next group of maxitems hosted zones by - // calling ListHostedZonesByName again and specifying the values of NextDNSName and - // NextHostedZoneId elements in the dnsname and hostedzoneid parameters. + // calling ListHostedZonesByName again and specifying the values of NextDNSName + // and NextHostedZoneId elements in the dnsname and hostedzoneid parameters. // // This member is required. IsTruncated bool @@ -120,7 +114,7 @@ type ListHostedZonesByNameOutput struct { // This member is required. MaxItems *int32 - // For the second and subsequent calls to ListHostedZonesByName, DNSName is the + // For the second and subsequent calls to ListHostedZonesByName , DNSName is the // value that you specified for the dnsname parameter in the request that produced // the current response. DNSName *string @@ -128,18 +122,18 @@ type ListHostedZonesByNameOutput struct { // The ID that Amazon Route 53 assigned to the hosted zone when you created it. HostedZoneId *string - // If IsTruncated is true, the value of NextDNSName is the name of the first hosted - // zone in the next group of maxitems hosted zones. Call ListHostedZonesByName - // again and specify the value of NextDNSName and NextHostedZoneId in the dnsname - // and hostedzoneid parameters, respectively. This element is present only if - // IsTruncated is true. + // If IsTruncated is true, the value of NextDNSName is the name of the first + // hosted zone in the next group of maxitems hosted zones. Call + // ListHostedZonesByName again and specify the value of NextDNSName and + // NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This + // element is present only if IsTruncated is true . NextDNSName *string - // If IsTruncated is true, the value of NextHostedZoneId identifies the first + // If IsTruncated is true , the value of NextHostedZoneId identifies the first // hosted zone in the next group of maxitems hosted zones. Call // ListHostedZonesByName again and specify the value of NextDNSName and // NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. This - // element is present only if IsTruncated is true. + // element is present only if IsTruncated is true . NextHostedZoneId *string // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_ListHostedZonesByVPC.go b/service/route53/api_op_ListHostedZonesByVPC.go index fefdc3c7195..4591d91a0e5 100644 --- a/service/route53/api_op_ListHostedZonesByVPC.go +++ b/service/route53/api_op_ListHostedZonesByVPC.go @@ -15,34 +15,24 @@ import ( // regardless of which Amazon Web Services account or Amazon Web Services service // owns the hosted zones. The HostedZoneOwner structure in the response contains // one of the following values: +// - An OwningAccount element, which contains the account number of either the +// current Amazon Web Services account or another Amazon Web Services account. Some +// services, such as Cloud Map, create hosted zones using the current account. +// - An OwningService element, which identifies the Amazon Web Services service +// that created and owns the hosted zone. For example, if a hosted zone was created +// by Amazon Elastic File System (Amazon EFS), the value of Owner is +// efs.amazonaws.com . // -// * An OwningAccount element, which contains the -// account number of either the current Amazon Web Services account or another -// Amazon Web Services account. Some services, such as Cloud Map, create hosted -// zones using the current account. +// When listing private hosted zones, the hosted zone and the Amazon VPC must +// belong to the same partition where the hosted zones were created. A partition is +// a group of Amazon Web Services Regions. Each Amazon Web Services account is +// scoped to one partition. The following are the supported partitions: +// - aws - Amazon Web Services Regions +// - aws-cn - China Regions +// - aws-us-gov - Amazon Web Services GovCloud (US) Region // -// * An OwningService element, which identifies -// the Amazon Web Services service that created and owns the hosted zone. For -// example, if a hosted zone was created by Amazon Elastic File System (Amazon -// EFS), the value of Owner is efs.amazonaws.com. -// -// When listing private hosted -// zones, the hosted zone and the Amazon VPC must belong to the same partition -// where the hosted zones were created. A partition is a group of Amazon Web -// Services Regions. Each Amazon Web Services account is scoped to one partition. -// The following are the supported partitions: -// -// * aws - Amazon Web Services -// Regions -// -// * aws-cn - China Regions -// -// * aws-us-gov - Amazon Web Services GovCloud -// (US) Region -// -// For more information, see Access Management -// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in -// the Amazon Web Services General Reference. +// For more information, see Access Management (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) +// in the Amazon Web Services General Reference. func (c *Client) ListHostedZonesByVPC(ctx context.Context, params *ListHostedZonesByVPCInput, optFns ...func(*Options)) (*ListHostedZonesByVPCOutput, error) { if params == nil { params = &ListHostedZonesByVPCInput{} @@ -67,22 +57,22 @@ type ListHostedZonesByVPCInput struct { // This member is required. VPCId *string - // For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region + // For the Amazon VPC that you specified for VPCId , the Amazon Web Services Region // that you created the VPC in. // // This member is required. VPCRegion types.VPCRegion // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to - // return. If the specified VPC is associated with more than MaxItems hosted zones, - // the response includes a NextToken element. NextToken contains an encrypted token - // that identifies the first hosted zone that Route 53 will return if you submit - // another request. + // return. If the specified VPC is associated with more than MaxItems hosted + // zones, the response includes a NextToken element. NextToken contains an + // encrypted token that identifies the first hosted zone that Route 53 will return + // if you submit another request. MaxItems *int32 // If the previous response included a NextToken element, the specified VPC is // associated with more hosted zones. To get more hosted zones, submit another - // ListHostedZonesByVPC request. For the value of NextToken, specify the value of + // ListHostedZonesByVPC request. For the value of NextToken , specify the value of // NextToken from the previous response. If the previous response didn't include a // NextToken element, there are no more hosted zones to get. NextToken *string @@ -92,9 +82,10 @@ type ListHostedZonesByVPCInput struct { type ListHostedZonesByVPCOutput struct { - // A list that contains one HostedZoneSummary element for each hosted zone that the - // specified Amazon VPC is associated with. Each HostedZoneSummary element contains - // the hosted zone name and ID, and information about who owns the hosted zone. + // A list that contains one HostedZoneSummary element for each hosted zone that + // the specified Amazon VPC is associated with. Each HostedZoneSummary element + // contains the hosted zone name and ID, and information about who owns the hosted + // zone. // // This member is required. HostedZoneSummaries []types.HostedZoneSummary diff --git a/service/route53/api_op_ListQueryLoggingConfigs.go b/service/route53/api_op_ListQueryLoggingConfigs.go index 33c1b7b9802..8575ad357ed 100644 --- a/service/route53/api_op_ListQueryLoggingConfigs.go +++ b/service/route53/api_op_ListQueryLoggingConfigs.go @@ -15,12 +15,10 @@ import ( // Lists the configurations for DNS query logging that are associated with the // current Amazon Web Services account or the configuration that is associated with // a specified hosted zone. For more information about DNS query logs, see -// CreateQueryLoggingConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html). -// Additional information, including the format of DNS query logs, appears in -// Logging DNS Queries -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) in -// the Amazon Route 53 Developer Guide. +// CreateQueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html) +// . Additional information, including the format of DNS query logs, appears in +// Logging DNS Queries (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html) +// in the Amazon Route 53 Developer Guide. func (c *Client) ListQueryLoggingConfigs(ctx context.Context, params *ListQueryLoggingConfigsInput, optFns ...func(*Options)) (*ListQueryLoggingConfigsOutput, error) { if params == nil { params = &ListQueryLoggingConfigsInput{} @@ -39,7 +37,7 @@ func (c *Client) ListQueryLoggingConfigs(ctx context.Context, params *ListQueryL type ListQueryLoggingConfigsInput struct { // (Optional) If you want to list the query logging configuration that is - // associated with a hosted zone, specify the ID in HostedZoneId. If you don't + // associated with a hosted zone, specify the ID in HostedZoneId . If you don't // specify a hosted zone ID, ListQueryLoggingConfigs returns all of the // configurations that are associated with the current Amazon Web Services account. HostedZoneId *string @@ -47,10 +45,9 @@ type ListQueryLoggingConfigsInput struct { // (Optional) The maximum number of query logging configurations that you want // Amazon Route 53 to return in response to the current request. If the current // Amazon Web Services account has more than MaxResults configurations, use the - // value of NextToken - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax) + // value of NextToken (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax) // in the response to get the next page of results. If you don't specify a value - // for MaxResults, Route 53 returns up to 100 configurations. + // for MaxResults , Route 53 returns up to 100 configurations. MaxResults *int32 // (Optional) If the current Amazon Web Services account has more than MaxResults @@ -65,8 +62,7 @@ type ListQueryLoggingConfigsInput struct { type ListQueryLoggingConfigsOutput struct { - // An array that contains one QueryLoggingConfig - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_QueryLoggingConfig.html) + // An array that contains one QueryLoggingConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_QueryLoggingConfig.html) // element for each configuration for DNS query logging that is associated with the // current Amazon Web Services account. // @@ -77,8 +73,7 @@ type ListQueryLoggingConfigsOutput struct { // associated with the current Amazon Web Services account, NextToken doesn't // appear in the response. If a response doesn't include the last of the // configurations, you can get more configurations by submitting another - // ListQueryLoggingConfigs - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html) + // ListQueryLoggingConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html) // request. Get the value of NextToken that Amazon Route 53 returned in the // previous response and include it in NextToken in the next request. NextToken *string @@ -166,10 +161,9 @@ type ListQueryLoggingConfigsPaginatorOptions struct { // (Optional) The maximum number of query logging configurations that you want // Amazon Route 53 to return in response to the current request. If the current // Amazon Web Services account has more than MaxResults configurations, use the - // value of NextToken - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax) + // value of NextToken (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax) // in the response to get the next page of results. If you don't specify a value - // for MaxResults, Route 53 returns up to 100 configurations. + // for MaxResults , Route 53 returns up to 100 configurations. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53/api_op_ListResourceRecordSets.go b/service/route53/api_op_ListResourceRecordSets.go index f3d642fc56d..06df3d52f16 100644 --- a/service/route53/api_op_ListResourceRecordSets.go +++ b/service/route53/api_op_ListResourceRecordSets.go @@ -17,31 +17,31 @@ import ( // order ListResourceRecordSets sorts results first by DNS name with the labels // reversed, for example: com.example.www. Note the trailing dot, which can change // the sort order when the record name contains characters that appear before . -// (decimal 46) in the ASCII table. These characters include the following: ! " # $ -// % & ' ( ) * + , - When multiple records have the same DNS name, +// (decimal 46) in the ASCII table. These characters include the following: ! " # +// $ % & ' ( ) * + , - When multiple records have the same DNS name, // ListResourceRecordSets sorts results by the record type. Specifying where to // start listing records You can use the name and type elements to specify the // resource record set that the list begins with: If you do not specify Name or // Type The results begin with the first resource record set that the hosted zone // contains. If you specify Name but not Type The results begin with the first -// resource record set in the list whose name is greater than or equal to Name. If -// you specify Type but not Name Amazon Route 53 returns the InvalidInput error. If -// you specify both Name and Type The results begin with the first resource record -// set in the list whose name is greater than or equal to Name, and whose type is -// greater than or equal to Type. Resource record sets that are PENDING This action -// returns the most current version of the records. This includes records that are -// PENDING, and that are not yet available on all Route 53 DNS servers. Changing -// resource record sets To ensure that you get an accurate listing of the resource -// record sets for a hosted zone at a point in time, do not submit a -// ChangeResourceRecordSets request while you're paging through the results of a -// ListResourceRecordSets request. If you do, some pages may display results -// without the latest changes while other pages display results with the latest -// changes. Displaying the next page of results If a ListResourceRecordSets command -// returns more than one page of results, the value of IsTruncated is true. To -// display the next page of results, get the values of NextRecordName, -// NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit -// another ListResourceRecordSets request, and specify those values for -// StartRecordName, StartRecordType, and StartRecordIdentifier. +// resource record set in the list whose name is greater than or equal to Name . If +// you specify Type but not Name Amazon Route 53 returns the InvalidInput error. +// If you specify both Name and Type The results begin with the first resource +// record set in the list whose name is greater than or equal to Name , and whose +// type is greater than or equal to Type . Resource record sets that are PENDING +// This action returns the most current version of the records. This includes +// records that are PENDING , and that are not yet available on all Route 53 DNS +// servers. Changing resource record sets To ensure that you get an accurate +// listing of the resource record sets for a hosted zone at a point in time, do not +// submit a ChangeResourceRecordSets request while you're paging through the +// results of a ListResourceRecordSets request. If you do, some pages may display +// results without the latest changes while other pages display results with the +// latest changes. Displaying the next page of results If a ListResourceRecordSets +// command returns more than one page of results, the value of IsTruncated is true +// . To display the next page of results, get the values of NextRecordName , +// NextRecordType , and NextRecordIdentifier (if any) from the response. Then +// submit another ListResourceRecordSets request, and specify those values for +// StartRecordName , StartRecordType , and StartRecordIdentifier . func (c *Client) ListResourceRecordSets(ctx context.Context, params *ListResourceRecordSetsInput, optFns ...func(*Options)) (*ListResourceRecordSetsOutput, error) { if params == nil { params = &ListResourceRecordSetsInput{} @@ -70,7 +70,7 @@ type ListResourceRecordSetsInput struct { // (Optional) The maximum number of resource records sets to include in the // response body for this request. If the response includes more than maxitems // resource record sets, the value of the IsTruncated element in the response is - // true, and the values of the NextRecordName and NextRecordType elements in the + // true , and the values of the NextRecordName and NextRecordType elements in the // response identify the first resource record set in the next group of maxitems // resource record sets. MaxItems *int32 @@ -83,36 +83,24 @@ type ListResourceRecordSetsInput struct { // The first name in the lexicographic ordering of resource record sets that you // want to list. If the specified record name doesn't exist, the results begin with - // the first resource record set that has a name greater than the value of name. + // the first resource record set that has a name greater than the value of name . StartRecordName *string // The type of resource record set to begin the record listing from. Valid values - // for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | - // SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover + // for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR + // | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover // resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | // TXT Values for alias resource record sets: - // - // * API Gateway custom regional API or - // edge-optimized API: A - // - // * CloudFront distribution: A or AAAA - // - // * Elastic Beanstalk - // environment that has a regionalized subdomain: A - // - // * Elastic Load Balancing load - // balancer: A | AAAA - // - // * S3 bucket: A - // - // * VPC interface VPC endpoint: A - // - // * Another - // resource record set in this hosted zone: The type of the resource record set - // that the alias references. - // - // Constraint: Specifying type without specifying name - // returns an InvalidInput error. + // - API Gateway custom regional API or edge-optimized API: A + // - CloudFront distribution: A or AAAA + // - Elastic Beanstalk environment that has a regionalized subdomain: A + // - Elastic Load Balancing load balancer: A | AAAA + // - S3 bucket: A + // - VPC interface VPC endpoint: A + // - Another resource record set in this hosted zone: The type of the resource + // record set that the alias references. + // Constraint: Specifying type without specifying name returns an InvalidInput + // error. StartRecordType types.RRType noSmithyDocumentSerde @@ -139,10 +127,9 @@ type ListResourceRecordSetsOutput struct { ResourceRecordSets []types.ResourceRecordSet // Resource record sets that have a routing policy other than simple: If results - // were truncated for a given DNS name and type, the value of SetIdentifier for the - // next resource record set that has the current DNS name and type. For information - // about routing policies, see Choosing a Routing Policy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) + // were truncated for a given DNS name and type, the value of SetIdentifier for + // the next resource record set that has the current DNS name and type. For + // information about routing policies, see Choosing a Routing Policy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) // in the Amazon Route 53 Developer Guide. NextRecordIdentifier *string diff --git a/service/route53/api_op_ListReusableDelegationSets.go b/service/route53/api_op_ListReusableDelegationSets.go index 772645b8c42..683c401eb7d 100644 --- a/service/route53/api_op_ListReusableDelegationSets.go +++ b/service/route53/api_op_ListReusableDelegationSets.go @@ -28,16 +28,16 @@ func (c *Client) ListReusableDelegationSets(ctx context.Context, params *ListReu return out, nil } -// A request to get a list of the reusable delegation sets that are associated with -// the current Amazon Web Services account. +// A request to get a list of the reusable delegation sets that are associated +// with the current Amazon Web Services account. type ListReusableDelegationSetsInput struct { - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // reusable delegation sets. To get another group, submit another - // ListReusableDelegationSets request. For the value of marker, specify the value + // ListReusableDelegationSets request. For the value of marker , specify the value // of NextMarker from the previous response, which is the ID of the first reusable // delegation set that Amazon Route 53 will return if you submit another request. - // If the value of IsTruncated in the previous response was false, there are no + // If the value of IsTruncated in the previous response was false , there are no // more reusable delegation sets to get. Marker *string @@ -49,8 +49,8 @@ type ListReusableDelegationSetsInput struct { noSmithyDocumentSerde } -// A complex type that contains information about the reusable delegation sets that -// are associated with the current Amazon Web Services account. +// A complex type that contains information about the reusable delegation sets +// that are associated with the current Amazon Web Services account. type ListReusableDelegationSetsOutput struct { // A complex type that contains one DelegationSet element for each reusable @@ -65,9 +65,9 @@ type ListReusableDelegationSetsOutput struct { // This member is required. IsTruncated bool - // For the second and subsequent calls to ListReusableDelegationSets, Marker is the - // value that you specified for the marker parameter in the request that produced - // the current response. + // For the second and subsequent calls to ListReusableDelegationSets , Marker is + // the value that you specified for the marker parameter in the request that + // produced the current response. // // This member is required. Marker *string @@ -78,7 +78,7 @@ type ListReusableDelegationSetsOutput struct { // This member is required. MaxItems *int32 - // If IsTruncated is true, the value of NextMarker identifies the next reusable + // If IsTruncated is true , the value of NextMarker identifies the next reusable // delegation set that Amazon Route 53 will return if you submit another // ListReusableDelegationSets request and specify the value of NextMarker in the // marker parameter. diff --git a/service/route53/api_op_ListTagsForResource.go b/service/route53/api_op_ListTagsForResource.go index b93946ca5e6..1f56f55148f 100644 --- a/service/route53/api_op_ListTagsForResource.go +++ b/service/route53/api_op_ListTagsForResource.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists tags for one health check or hosted zone. For information about using tags -// for cost allocation, see Using Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// Lists tags for one health check or hosted zone. For information about using +// tags for cost allocation, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management User Guide. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { @@ -40,11 +39,8 @@ type ListTagsForResourceInput struct { ResourceId *string // The type of the resource. - // - // * The resource type for health checks is - // healthcheck. - // - // * The resource type for hosted zones is hostedzone. + // - The resource type for health checks is healthcheck . + // - The resource type for hosted zones is hostedzone . // // This member is required. ResourceType types.TagResourceType @@ -52,8 +48,8 @@ type ListTagsForResourceInput struct { noSmithyDocumentSerde } -// A complex type that contains information about the health checks or hosted zones -// for which you want to list tags. +// A complex type that contains information about the health checks or hosted +// zones for which you want to list tags. type ListTagsForResourceOutput struct { // A ResourceTagSet containing tags associated with the specified resource. diff --git a/service/route53/api_op_ListTagsForResources.go b/service/route53/api_op_ListTagsForResources.go index 13109083b13..6a992ad741d 100644 --- a/service/route53/api_op_ListTagsForResources.go +++ b/service/route53/api_op_ListTagsForResources.go @@ -12,8 +12,7 @@ import ( ) // Lists tags for up to 10 health checks or hosted zones. For information about -// using tags for cost allocation, see Using Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// using tags for cost allocation, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Billing and Cost Management User Guide. func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForResourcesInput, optFns ...func(*Options)) (*ListTagsForResourcesOutput, error) { if params == nil { @@ -30,8 +29,8 @@ func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForRe return out, nil } -// A complex type that contains information about the health checks or hosted zones -// for which you want to list tags. +// A complex type that contains information about the health checks or hosted +// zones for which you want to list tags. type ListTagsForResourcesInput struct { // A complex type that contains the ResourceId element for each resource for which @@ -41,11 +40,8 @@ type ListTagsForResourcesInput struct { ResourceIds []string // The type of the resources. - // - // * The resource type for health checks is - // healthcheck. - // - // * The resource type for hosted zones is hostedzone. + // - The resource type for health checks is healthcheck . + // - The resource type for hosted zones is hostedzone . // // This member is required. ResourceType types.TagResourceType @@ -56,7 +52,7 @@ type ListTagsForResourcesInput struct { // A complex type containing tags for the specified resources. type ListTagsForResourcesOutput struct { - // A list of ResourceTagSets containing tags associated with the specified + // A list of ResourceTagSet s containing tags associated with the specified // resources. // // This member is required. diff --git a/service/route53/api_op_ListTrafficPolicies.go b/service/route53/api_op_ListTrafficPolicies.go index c2ab7dddbd8..b09a7a783ce 100644 --- a/service/route53/api_op_ListTrafficPolicies.go +++ b/service/route53/api_op_ListTrafficPolicies.go @@ -14,9 +14,9 @@ import ( // Gets information about the latest version for every traffic policy that is // associated with the current Amazon Web Services account. Policies are listed in // the order that they were created in. For information about how of deleting a -// traffic policy affects the response from ListTrafficPolicies, see -// DeleteTrafficPolicy -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html). +// traffic policy affects the response from ListTrafficPolicies , see +// DeleteTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicy.html) +// . func (c *Client) ListTrafficPolicies(ctx context.Context, params *ListTrafficPoliciesInput, optFns ...func(*Options)) (*ListTrafficPoliciesOutput, error) { if params == nil { params = &ListTrafficPoliciesInput{} @@ -39,16 +39,16 @@ type ListTrafficPoliciesInput struct { // (Optional) The maximum number of traffic policies that you want Amazon Route 53 // to return in response to this request. If you have more than MaxItems traffic - // policies, the value of IsTruncated in the response is true, and the value of + // policies, the value of IsTruncated in the response is true , and the value of // TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will // return if you submit another request. MaxItems *int32 - // (Conditional) For your first request to ListTrafficPolicies, don't include the + // (Conditional) For your first request to ListTrafficPolicies , don't include the // TrafficPolicyIdMarker parameter. If you have more traffic policies than the - // value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic + // value of MaxItems , ListTrafficPolicies returns only the first MaxItems traffic // policies. To get the next group of policies, submit another request to - // ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value + // ListTrafficPolicies . For the value of TrafficPolicyIdMarker , specify the value // of TrafficPolicyIdMarker that was returned in the previous response. TrafficPolicyIdMarker *string @@ -72,7 +72,7 @@ type ListTrafficPoliciesOutput struct { // This member is required. MaxItems *int32 - // If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the + // If the value of IsTruncated is true , TrafficPolicyIdMarker is the ID of the // first traffic policy in the next group of MaxItems traffic policies. // // This member is required. diff --git a/service/route53/api_op_ListTrafficPolicyInstances.go b/service/route53/api_op_ListTrafficPolicyInstances.go index cf48de03c20..b3498e39e96 100644 --- a/service/route53/api_op_ListTrafficPolicyInstances.go +++ b/service/route53/api_op_ListTrafficPolicyInstances.go @@ -34,44 +34,44 @@ func (c *Client) ListTrafficPolicyInstances(ctx context.Context, params *ListTra return out, nil } -// A request to get information about the traffic policy instances that you created -// by using the current Amazon Web Services account. +// A request to get information about the traffic policy instances that you +// created by using the current Amazon Web Services account. type ListTrafficPolicyInstancesInput struct { - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the - // value of HostedZoneIdMarker from the previous response, which is the hosted zone - // ID of the first traffic policy instance in the next group of traffic policy - // instances. If the value of IsTruncated in the previous response was false, there - // are no more traffic policy instances to get. + // ListTrafficPolicyInstances request. For the value of HostedZoneId , specify the + // value of HostedZoneIdMarker from the previous response, which is the hosted + // zone ID of the first traffic policy instance in the next group of traffic policy + // instances. If the value of IsTruncated in the previous response was false , + // there are no more traffic policy instances to get. HostedZoneIdMarker *string // The maximum number of traffic policy instances that you want Amazon Route 53 to // return in response to a ListTrafficPolicyInstances request. If you have more // than MaxItems traffic policy instances, the value of the IsTruncated element in - // the response is true, and the values of HostedZoneIdMarker, - // TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent + // the response is true , and the values of HostedZoneIdMarker , + // TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker represent // the first traffic policy instance in the next group of MaxItems traffic policy // instances. MaxItems *int32 - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, - // specify the value of TrafficPolicyInstanceNameMarker from the previous response, - // which is the name of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename , + // specify the value of TrafficPolicyInstanceNameMarker from the previous + // response, which is the name of the first traffic policy instance in the next + // group of traffic policy instances. If the value of IsTruncated in the previous + // response was false , there are no more traffic policy instances to get. TrafficPolicyInstanceNameMarker *string - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, - // specify the value of TrafficPolicyInstanceTypeMarker from the previous response, - // which is the type of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype , + // specify the value of TrafficPolicyInstanceTypeMarker from the previous + // response, which is the type of the first traffic policy instance in the next + // group of traffic policy instances. If the value of IsTruncated in the previous + // response was false , there are no more traffic policy instances to get. TrafficPolicyInstanceTypeMarker types.RRType noSmithyDocumentSerde @@ -83,7 +83,7 @@ type ListTrafficPolicyInstancesOutput struct { // A flag that indicates whether there are more traffic policy instances to be // listed. If the response was truncated, you can get more traffic policy instances // by calling ListTrafficPolicyInstances again and specifying the values of the - // HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and + // HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and // TrafficPolicyInstanceTypeMarker in the corresponding request parameters. // // This member is required. @@ -101,17 +101,17 @@ type ListTrafficPolicyInstancesOutput struct { // This member is required. TrafficPolicyInstances []types.TrafficPolicyInstance - // If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the + // If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the // first traffic policy instance that Route 53 will return if you submit another // ListTrafficPolicyInstances request. HostedZoneIdMarker *string - // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first - // traffic policy instance that Route 53 will return if you submit another + // If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the + // first traffic policy instance that Route 53 will return if you submit another // ListTrafficPolicyInstances request. TrafficPolicyInstanceNameMarker *string - // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the + // If IsTruncated is true , TrafficPolicyInstanceTypeMarker is the DNS type of the // resource record sets that are associated with the first traffic policy instance // that Amazon Route 53 will return if you submit another // ListTrafficPolicyInstances request. diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go index 287f8a49bff..6b675f6d136 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go @@ -45,28 +45,28 @@ type ListTrafficPolicyInstancesByHostedZoneInput struct { // The maximum number of traffic policy instances to be included in the response // body for this request. If you have more than MaxItems traffic policy instances, - // the value of the IsTruncated element in the response is true, and the values of - // HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and + // the value of the IsTruncated element in the response is true , and the values of + // HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and // TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that // Amazon Route 53 will return if you submit another request. MaxItems *int32 // If the value of IsTruncated in the previous response is true, you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, - // specify the value of TrafficPolicyInstanceNameMarker from the previous response, - // which is the name of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename , + // specify the value of TrafficPolicyInstanceNameMarker from the previous + // response, which is the name of the first traffic policy instance in the next + // group of traffic policy instances. If the value of IsTruncated in the previous + // response was false , there are no more traffic policy instances to get. TrafficPolicyInstanceNameMarker *string // If the value of IsTruncated in the previous response is true, you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, - // specify the value of TrafficPolicyInstanceTypeMarker from the previous response, - // which is the type of the first traffic policy instance in the next group of - // traffic policy instances. If the value of IsTruncated in the previous response - // was false, there are no more traffic policy instances to get. + // ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype , + // specify the value of TrafficPolicyInstanceTypeMarker from the previous + // response, which is the type of the first traffic policy instance in the next + // group of traffic policy instances. If the value of IsTruncated in the previous + // response was false , there are no more traffic policy instances to get. TrafficPolicyInstanceTypeMarker types.RRType noSmithyDocumentSerde @@ -78,8 +78,8 @@ type ListTrafficPolicyInstancesByHostedZoneOutput struct { // A flag that indicates whether there are more traffic policy instances to be // listed. If the response was truncated, you can get the next group of traffic // policy instances by submitting another ListTrafficPolicyInstancesByHostedZone - // request and specifying the values of HostedZoneIdMarker, - // TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the + // request and specifying the values of HostedZoneIdMarker , + // TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker in the // corresponding request parameters. // // This member is required. @@ -98,8 +98,8 @@ type ListTrafficPolicyInstancesByHostedZoneOutput struct { // This member is required. TrafficPolicyInstances []types.TrafficPolicyInstance - // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first - // traffic policy instance in the next group of traffic policy instances. + // If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the + // first traffic policy instance in the next group of traffic policy instances. TrafficPolicyInstanceNameMarker *string // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go index a8d2bddb078..2bfe3c2dd1f 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go @@ -46,45 +46,45 @@ type ListTrafficPolicyInstancesByPolicyInput struct { // The version of the traffic policy for which you want to list traffic policy // instances. The version must be associated with the traffic policy that is - // specified by TrafficPolicyId. + // specified by TrafficPolicyId . // // This member is required. TrafficPolicyVersion *int32 - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another - // ListTrafficPolicyInstancesByPolicy request. For the value of hostedzoneid, - // specify the value of HostedZoneIdMarker from the previous response, which is the - // hosted zone ID of the first traffic policy instance that Amazon Route 53 will - // return if you submit another request. If the value of IsTruncated in the - // previous response was false, there are no more traffic policy instances to get. + // ListTrafficPolicyInstancesByPolicy request. For the value of hostedzoneid , + // specify the value of HostedZoneIdMarker from the previous response, which is + // the hosted zone ID of the first traffic policy instance that Amazon Route 53 + // will return if you submit another request. If the value of IsTruncated in the + // previous response was false , there are no more traffic policy instances to get. HostedZoneIdMarker *string // The maximum number of traffic policy instances to be included in the response // body for this request. If you have more than MaxItems traffic policy instances, - // the value of the IsTruncated element in the response is true, and the values of - // HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and + // the value of the IsTruncated element in the response is true , and the values of + // HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and // TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that // Amazon Route 53 will return if you submit another request. MaxItems *int32 - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another // ListTrafficPolicyInstancesByPolicy request. For the value of - // trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker + // trafficpolicyinstancename , specify the value of TrafficPolicyInstanceNameMarker // from the previous response, which is the name of the first traffic policy // instance that Amazon Route 53 will return if you submit another request. If the - // value of IsTruncated in the previous response was false, there are no more + // value of IsTruncated in the previous response was false , there are no more // traffic policy instances to get. TrafficPolicyInstanceNameMarker *string - // If the value of IsTruncated in the previous response was true, you have more + // If the value of IsTruncated in the previous response was true , you have more // traffic policy instances. To get more traffic policy instances, submit another // ListTrafficPolicyInstancesByPolicy request. For the value of - // trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker + // trafficpolicyinstancetype , specify the value of TrafficPolicyInstanceTypeMarker // from the previous response, which is the name of the first traffic policy // instance that Amazon Route 53 will return if you submit another request. If the - // value of IsTruncated in the previous response was false, there are no more + // value of IsTruncated in the previous response was false , there are no more // traffic policy instances to get. TrafficPolicyInstanceTypeMarker types.RRType @@ -97,9 +97,9 @@ type ListTrafficPolicyInstancesByPolicyOutput struct { // A flag that indicates whether there are more traffic policy instances to be // listed. If the response was truncated, you can get the next group of traffic // policy instances by calling ListTrafficPolicyInstancesByPolicy again and - // specifying the values of the HostedZoneIdMarker, - // TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in - // the corresponding request parameters. + // specifying the values of the HostedZoneIdMarker , + // TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker elements + // in the corresponding request parameters. // // This member is required. IsTruncated bool @@ -116,15 +116,16 @@ type ListTrafficPolicyInstancesByPolicyOutput struct { // This member is required. TrafficPolicyInstances []types.TrafficPolicyInstance - // If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the + // If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the // first traffic policy instance in the next group of traffic policy instances. HostedZoneIdMarker *string - // If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first - // traffic policy instance in the next group of MaxItems traffic policy instances. + // If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the + // first traffic policy instance in the next group of MaxItems traffic policy + // instances. TrafficPolicyInstanceNameMarker *string - // If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the + // If IsTruncated is true , TrafficPolicyInstanceTypeMarker is the DNS type of the // resource record sets that are associated with the first traffic policy instance // in the next group of MaxItems traffic policy instances. TrafficPolicyInstanceTypeMarker types.RRType diff --git a/service/route53/api_op_ListTrafficPolicyVersions.go b/service/route53/api_op_ListTrafficPolicyVersions.go index 169d3ea11de..562b18ffba9 100644 --- a/service/route53/api_op_ListTrafficPolicyVersions.go +++ b/service/route53/api_op_ListTrafficPolicyVersions.go @@ -12,7 +12,7 @@ import ( ) // Gets information about all of the versions for a specified traffic policy. -// Traffic policy versions are listed in numerical order by VersionNumber. +// Traffic policy versions are listed in numerical order by VersionNumber . func (c *Client) ListTrafficPolicyVersions(ctx context.Context, params *ListTrafficPolicyVersionsInput, optFns ...func(*Options)) (*ListTrafficPolicyVersionsOutput, error) { if params == nil { params = &ListTrafficPolicyVersionsInput{} @@ -41,15 +41,15 @@ type ListTrafficPolicyVersionsInput struct { // The maximum number of traffic policy versions that you want Amazon Route 53 to // include in the response body for this request. If the specified traffic policy // has more than MaxItems versions, the value of IsTruncated in the response is - // true, and the value of the TrafficPolicyVersionMarker element is the ID of the + // true , and the value of the TrafficPolicyVersionMarker element is the ID of the // first version that Route 53 will return if you submit another request. MaxItems *int32 - // For your first request to ListTrafficPolicyVersions, don't include the + // For your first request to ListTrafficPolicyVersions , don't include the // TrafficPolicyVersionMarker parameter. If you have more traffic policy versions - // than the value of MaxItems, ListTrafficPolicyVersions returns only the first + // than the value of MaxItems , ListTrafficPolicyVersions returns only the first // group of MaxItems versions. To get more traffic policy versions, submit another - // ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, + // ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker , // specify the value of TrafficPolicyVersionMarker in the previous response. TrafficPolicyVersionMarker *string @@ -61,8 +61,8 @@ type ListTrafficPolicyVersionsOutput struct { // A flag that indicates whether there are more traffic policies to be listed. If // the response was truncated, you can get the next group of traffic policies by - // submitting another ListTrafficPolicyVersions request and specifying the value of - // NextMarker in the marker parameter. + // submitting another ListTrafficPolicyVersions request and specifying the value + // of NextMarker in the marker parameter. // // This member is required. IsTruncated bool @@ -79,11 +79,11 @@ type ListTrafficPolicyVersionsOutput struct { // This member is required. TrafficPolicies []types.TrafficPolicy - // If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the + // If IsTruncated is true , the value of TrafficPolicyVersionMarker identifies the // first traffic policy that Amazon Route 53 will return if you submit another // request. Call ListTrafficPolicyVersions again and specify the value of // TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter. - // This element is present only if IsTruncated is true. + // This element is present only if IsTruncated is true . // // This member is required. TrafficPolicyVersionMarker *string diff --git a/service/route53/api_op_ListVPCAssociationAuthorizations.go b/service/route53/api_op_ListVPCAssociationAuthorizations.go index 1be8a25aa13..ce7df2c6a73 100644 --- a/service/route53/api_op_ListVPCAssociationAuthorizations.go +++ b/service/route53/api_op_ListVPCAssociationAuthorizations.go @@ -13,9 +13,9 @@ import ( // Gets a list of the VPCs that were created by other accounts and that can be // associated with a specified hosted zone because you've submitted one or more -// CreateVPCAssociationAuthorization requests. The response includes a VPCs element -// with a VPC child element for each VPC that can be associated with the hosted -// zone. +// CreateVPCAssociationAuthorization requests. The response includes a VPCs +// element with a VPC child element for each VPC that can be associated with the +// hosted zone. func (c *Client) ListVPCAssociationAuthorizations(ctx context.Context, params *ListVPCAssociationAuthorizationsInput, optFns ...func(*Options)) (*ListVPCAssociationAuthorizationsOutput, error) { if params == nil { params = &ListVPCAssociationAuthorizationsInput{} @@ -42,8 +42,8 @@ type ListVPCAssociationAuthorizationsInput struct { HostedZoneId *string // Optional: An integer that specifies the maximum number of VPCs that you want - // Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 - // returns up to 50 VPCs per page. + // Amazon Route 53 to return. If you don't specify a value for MaxResults , Route + // 53 returns up to 50 VPCs per page. MaxResults *int32 // Optional: If a response includes a NextToken element, there are more VPCs that diff --git a/service/route53/api_op_TestDNSAnswer.go b/service/route53/api_op_TestDNSAnswer.go index ef6121dee9b..e10d80e5ba0 100644 --- a/service/route53/api_op_TestDNSAnswer.go +++ b/service/route53/api_op_TestDNSAnswer.go @@ -53,27 +53,24 @@ type TestDNSAnswerInput struct { // If the resolver that you specified for resolverip supports EDNS0, specify the // IPv4 or IPv6 address of a client in the applicable location, for example, - // 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334. + // 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334 . EDNS0ClientSubnetIP *string - // If you specify an IP address for edns0clientsubnetip, you can optionally specify - // the number of bits of the IP address that you want the checking tool to include - // in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip - // and 24 for edns0clientsubnetmask, the checking tool will simulate a request from - // 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for - // IPv6 addresses. The range of valid values depends on whether edns0clientsubnetip - // is an IPv4 or an IPv6 address: - // - // * IPv4: Specify a value between 0 and 32 - // - // * - // IPv6: Specify a value between 0 and 128 + // If you specify an IP address for edns0clientsubnetip , you can optionally + // specify the number of bits of the IP address that you want the checking tool to + // include in the DNS query. For example, if you specify 192.0.2.44 for + // edns0clientsubnetip and 24 for edns0clientsubnetmask , the checking tool will + // simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 + // addresses and 64 bits for IPv6 addresses. The range of valid values depends on + // whether edns0clientsubnetip is an IPv4 or an IPv6 address: + // - IPv4: Specify a value between 0 and 32 + // - IPv6: Specify a value between 0 and 128 EDNS0ClientSubnetMask *string // If you want to simulate a request from a specific DNS resolver, specify the IP // address for that resolver. If you omit this value, TestDnsAnswer uses the IP // address of a DNS resolver in the Amazon Web Services US East (N. Virginia) - // Region (us-east-1). + // Region ( us-east-1 ). ResolverIP *string noSmithyDocumentSerde @@ -88,7 +85,7 @@ type TestDNSAnswerOutput struct { Nameserver *string // The protocol that Amazon Route 53 used to respond to the request, either UDP or - // TCP. + // TCP . // // This member is required. Protocol *string @@ -110,10 +107,9 @@ type TestDNSAnswerOutput struct { RecordType types.RRType // A code that indicates whether the request is valid or not. The most common - // response code is NOERROR, meaning that the request is valid. If the response is + // response code is NOERROR , meaning that the request is valid. If the response is // not valid, Amazon Route 53 returns a response code that describes the error. For - // a list of possible response codes, see DNS RCODES - // (http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6) + // a list of possible response codes, see DNS RCODES (http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6) // on the IANA website. // // This member is required. diff --git a/service/route53/api_op_UpdateHealthCheck.go b/service/route53/api_op_UpdateHealthCheck.go index e0603c5e5b6..9dd4c974577 100644 --- a/service/route53/api_op_UpdateHealthCheck.go +++ b/service/route53/api_op_UpdateHealthCheck.go @@ -13,8 +13,7 @@ import ( // Updates an existing health check. Note that some values can't be updated. For // more information about updating health checks, see Creating, Updating, and -// Deleting Health Checks -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html) +// Deleting Health Checks (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html) // in the Amazon Route 53 Developer Guide. func (c *Client) UpdateHealthCheck(ctx context.Context, params *UpdateHealthCheckInput, optFns ...func(*Options)) (*UpdateHealthCheckOutput, error) { if params == nil { @@ -53,26 +52,19 @@ type UpdateHealthCheckInput struct { // Stops Route 53 from performing health checks. When you disable a health check, // here's what happens: - // - // * Health checks that check the health of endpoints: Route - // 53 stops submitting requests to your application, server, or other resource. - // - // * - // Calculated health checks: Route 53 stops aggregating the status of the - // referenced health checks. - // - // * Health checks that monitor CloudWatch alarms: Route - // 53 stops monitoring the corresponding CloudWatch metrics. - // - // After you disable a - // health check, Route 53 considers the status of the health check to always be - // healthy. If you configured DNS failover, Route 53 continues to route traffic to - // the corresponding resources. If you want to stop routing traffic to a resource, - // change the value of Inverted - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted). - // Charges for a health check still apply when the health check is disabled. For - // more information, see Amazon Route 53 Pricing - // (http://aws.amazon.com/route53/pricing/). + // - Health checks that check the health of endpoints: Route 53 stops submitting + // requests to your application, server, or other resource. + // - Calculated health checks: Route 53 stops aggregating the status of the + // referenced health checks. + // - Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the + // corresponding CloudWatch metrics. + // After you disable a health check, Route 53 considers the status of the health + // check to always be healthy. If you configured DNS failover, Route 53 continues + // to route traffic to the corresponding resources. If you want to stop routing + // traffic to a resource, change the value of Inverted (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted) + // . Charges for a health check still apply when the health check is disabled. For + // more information, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) + // . Disabled *bool // Specify whether you want Amazon Route 53 to send the value of @@ -80,76 +72,69 @@ type UpdateHealthCheckInput struct { // negotiation. This allows the endpoint to respond to HTTPS health check requests // with the applicable SSL/TLS certificate. Some endpoints require that HTTPS // requests include the host name in the client_hello message. If you don't enable - // SNI, the status of the health check will be SSL alert handshake_failure. A + // SNI, the status of the health check will be SSL alert handshake_failure . A // health check can also have that status for other reasons. If SNI is enabled and // you're still getting the error, check the SSL/TLS configuration on your endpoint // and confirm that your certificate is valid. The SSL/TLS certificate on your // endpoint includes a domain name in the Common Name field and possibly several // more in the Subject Alternative Names field. One of the domain names in the - // certificate should match the value that you specify for - // FullyQualifiedDomainName. If the endpoint responds to the client_hello message - // with a certificate that does not include the domain name that you specified in - // FullyQualifiedDomainName, a health checker will retry the handshake. In the - // second attempt, the health checker will omit FullyQualifiedDomainName from the - // client_hello message. + // certificate should match the value that you specify for FullyQualifiedDomainName + // . If the endpoint responds to the client_hello message with a certificate that + // does not include the domain name that you specified in FullyQualifiedDomainName + // , a health checker will retry the handshake. In the second attempt, the health + // checker will omit FullyQualifiedDomainName from the client_hello message. EnableSNI *bool // The number of consecutive health checks that an endpoint must pass or fail for // Amazon Route 53 to change the current status of the endpoint from unhealthy to // healthy or vice versa. For more information, see How Amazon Route 53 Determines - // Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Amazon Route 53 Developer Guide. If you don't specify a value for - // FailureThreshold, the default value is three health checks. + // FailureThreshold , the default value is three health checks. FailureThreshold *int32 - // Amazon Route 53 behavior depends on whether you specify a value for IPAddress. - // If a health check already has a value for IPAddress, you can change the value. + // Amazon Route 53 behavior depends on whether you specify a value for IPAddress . + // If a health check already has a value for IPAddress , you can change the value. // However, you can't update an existing health check to add or remove the value of - // IPAddress. If you specify a value for IPAddress: Route 53 sends health check + // IPAddress . If you specify a value for IPAddress : Route 53 sends health check // requests to the specified IPv4 or IPv6 address and passes the value of // FullyQualifiedDomainName in the Host header for all health checks except TCP // health checks. This is typically the fully qualified DNS name of the endpoint on // which you want Route 53 to perform health checks. When Route 53 checks the // health of an endpoint, here is how it constructs the Host header: - // - // * If you - // specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 - // passes the value of FullyQualifiedDomainName to the endpoint in the Host - // header. - // - // * If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH - // for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint - // in the Host header. - // - // * If you specify another value for Port and any value - // except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the - // endpoint in the Host header. - // - // If you don't specify a value for - // FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the - // Host header in each of the above cases. If you don't specify a value for - // IPAddress: If you don't specify a value for IPAddress, Route 53 sends a DNS - // request to the domain that you specify in FullyQualifiedDomainName at the - // interval you specify in RequestInterval. Using an IPv4 address that is returned - // by DNS, Route 53 then checks the health of the endpoint. If you don't specify a - // value for IPAddress, Route 53 uses only IPv4 to send health checks to the - // endpoint. If there's no resource record set with a type of A for the name that - // you specify for FullyQualifiedDomainName, the health check fails with a "DNS - // resolution failed" error. If you want to check the health of weighted, latency, - // or failover resource record sets and you choose to specify the endpoint only by - // FullyQualifiedDomainName, we recommend that you create a separate health check - // for each endpoint. For example, create a health check for each HTTP server that - // is serving content for www.example.com. For the value of - // FullyQualifiedDomainName, specify the domain name of the server (such as - // us-east-2-www.example.com), not the name of the resource record sets + // - If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , + // Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the + // Host header. + // - If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type + // , Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the + // Host header. + // - If you specify another value for Port and any value except TCP for Type , + // Route 53 passes FullyQualifiedDomainName : Port to the endpoint in the Host + // header. + // If you don't specify a value for FullyQualifiedDomainName , Route 53 substitutes + // the value of IPAddress in the Host header in each of the above cases. If you + // don't specify a value for IPAddress : If you don't specify a value for IPAddress + // , Route 53 sends a DNS request to the domain that you specify in + // FullyQualifiedDomainName at the interval you specify in RequestInterval . Using + // an IPv4 address that is returned by DNS, Route 53 then checks the health of the + // endpoint. If you don't specify a value for IPAddress , Route 53 uses only IPv4 + // to send health checks to the endpoint. If there's no resource record set with a + // type of A for the name that you specify for FullyQualifiedDomainName , the + // health check fails with a "DNS resolution failed" error. If you want to check + // the health of weighted, latency, or failover resource record sets and you choose + // to specify the endpoint only by FullyQualifiedDomainName , we recommend that you + // create a separate health check for each endpoint. For example, create a health + // check for each HTTP server that is serving content for www.example.com. For the + // value of FullyQualifiedDomainName , specify the domain name of the server (such + // as us-east-2-www.example.com ), not the name of the resource record sets // (www.example.com). In this configuration, if the value of // FullyQualifiedDomainName matches the name of the resource record sets and you // then associate the health check with those resource record sets, health check - // results will be unpredictable. In addition, if the value of Type is HTTP, HTTPS, - // HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of - // FullyQualifiedDomainName in the Host header, as it does when you specify a value - // for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header. + // results will be unpredictable. In addition, if the value of Type is HTTP , HTTPS + // , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Route 53 passes the value of + // FullyQualifiedDomainName in the Host header, as it does when you specify a + // value for IPAddress . If the value of Type is TCP , Route 53 doesn't pass a Host + // header. FullyQualifiedDomainName *string // A sequential counter that Amazon Route 53 sets to 1 when you create a health @@ -158,106 +143,75 @@ type UpdateHealthCheckInput struct { // value of HealthCheckVersion for the health check that you want to update, and // that you include that value in your UpdateHealthCheck request. This prevents // Route 53 from overwriting an intervening update: - // - // * If the value in the - // UpdateHealthCheck request matches the value of HealthCheckVersion in the health - // check, Route 53 updates the health check with the new settings. - // - // * If the value - // of HealthCheckVersion in the health check is greater, the health check was - // changed after you got the version number. Route 53 does not update the health - // check, and it returns a HealthCheckVersionMismatch error. + // - If the value in the UpdateHealthCheck request matches the value of + // HealthCheckVersion in the health check, Route 53 updates the health check with + // the new settings. + // - If the value of HealthCheckVersion in the health check is greater, the + // health check was changed after you got the version number. Route 53 does not + // update the health check, and it returns a HealthCheckVersionMismatch error. HealthCheckVersion *int64 // The number of child health checks that are associated with a CALCULATED health - // that Amazon Route 53 must consider healthy for the CALCULATED health check to be - // considered healthy. To specify the child health checks that you want to + // that Amazon Route 53 must consider healthy for the CALCULATED health check to + // be considered healthy. To specify the child health checks that you want to // associate with a CALCULATED health check, use the ChildHealthChecks and // ChildHealthCheck elements. Note the following: - // - // * If you specify a number - // greater than the number of child health checks, Route 53 always considers this - // health check to be unhealthy. - // - // * If you specify 0, Route 53 always considers - // this health check to be healthy. + // - If you specify a number greater than the number of child health checks, + // Route 53 always considers this health check to be unhealthy. + // - If you specify 0 , Route 53 always considers this health check to be + // healthy. HealthThreshold *int32 // The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to - // perform health checks on. If you don't specify a value for IPAddress, Route 53 + // perform health checks on. If you don't specify a value for IPAddress , Route 53 // sends a DNS request to resolve the domain name that you specify in - // FullyQualifiedDomainName at the interval that you specify in RequestInterval. + // FullyQualifiedDomainName at the interval that you specify in RequestInterval . // Using an IP address that is returned by DNS, Route 53 then checks the health of - // the endpoint. Use one of the following formats for the value of IPAddress: - // - // * - // IPv4 address: four values between 0 and 255, separated by periods (.), for - // example, 192.0.2.44. - // - // * IPv6 address: eight groups of four hexadecimal values, - // separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. - // You can also shorten IPv6 addresses as described in RFC 5952, for example, - // 2001:db8:85a3::abcd:1:2345. - // - // If the endpoint is an EC2 instance, we recommend - // that you create an Elastic IP address, associate it with your EC2 instance, and - // specify the Elastic IP address for IPAddress. This ensures that the IP address - // of your instance never changes. For more information, see the applicable - // documentation: - // - // * Linux: Elastic IP Addresses (EIP) - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) - // in the Amazon EC2 User Guide for Linux Instances - // - // * Windows: Elastic IP - // Addresses (EIP) - // (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html) - // in the Amazon EC2 User Guide for Windows Instances - // - // If a health check already - // has a value for IPAddress, you can change the value. However, you can't update - // an existing health check to add or remove the value of IPAddress. For more - // information, see FullyQualifiedDomainName - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName). - // Constraints: Route 53 can't check the health of endpoints for which the IP + // the endpoint. Use one of the following formats for the value of IPAddress : + // - IPv4 address: four values between 0 and 255, separated by periods (.), for + // example, 192.0.2.44 . + // - IPv6 address: eight groups of four hexadecimal values, separated by colons + // (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also + // shorten IPv6 addresses as described in RFC 5952, for example, + // 2001:db8:85a3::abcd:1:2345 . + // If the endpoint is an EC2 instance, we recommend that you create an Elastic IP + // address, associate it with your EC2 instance, and specify the Elastic IP address + // for IPAddress . This ensures that the IP address of your instance never changes. + // For more information, see the applicable documentation: + // - Linux: Elastic IP Addresses (EIP) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) + // in the Amazon EC2 User Guide for Linux Instances + // - Windows: Elastic IP Addresses (EIP) (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html) + // in the Amazon EC2 User Guide for Windows Instances + // If a health check already has a value for IPAddress , you can change the value. + // However, you can't update an existing health check to add or remove the value of + // IPAddress . For more information, see FullyQualifiedDomainName (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName) + // . Constraints: Route 53 can't check the health of endpoints for which the IP // address is in local, private, non-routable, or multicast ranges. For more // information about IP addresses for which you can't create health checks, see the // following documents: - // - // * RFC 5735, Special Use IPv4 Addresses - // (https://tools.ietf.org/html/rfc5735) - // - // * RFC 6598, IANA-Reserved IPv4 Prefix for - // Shared Address Space (https://tools.ietf.org/html/rfc6598) - // - // * RFC 5156, - // Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) + // - RFC 5735, Special Use IPv4 Addresses (https://tools.ietf.org/html/rfc5735) + // - RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space (https://tools.ietf.org/html/rfc6598) + // - RFC 5156, Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) IPAddress *string // When CloudWatch has insufficient data about the metric to determine the alarm - // state, the status that you want Amazon Route 53 to assign to the health - // check: - // - // * Healthy: Route 53 considers the health check to be healthy. - // - // * - // Unhealthy: Route 53 considers the health check to be unhealthy. - // - // * - // LastKnownStatus: By default, Route 53 uses the status of the health check from - // the last time CloudWatch had sufficient data to determine the alarm state. For - // new health checks that have no last known status, the status for the health - // check is healthy. + // state, the status that you want Amazon Route 53 to assign to the health check: + // - Healthy : Route 53 considers the health check to be healthy. + // - Unhealthy : Route 53 considers the health check to be unhealthy. + // - LastKnownStatus : By default, Route 53 uses the status of the health check + // from the last time CloudWatch had sufficient data to determine the alarm state. + // For new health checks that have no last known status, the status for the health + // check is healthy. InsufficientDataHealthStatus types.InsufficientDataHealthStatus - // Specify whether you want Amazon Route 53 to invert the status of a health check, - // for example, to consider a health check unhealthy when it otherwise would be - // considered healthy. + // Specify whether you want Amazon Route 53 to invert the status of a health + // check, for example, to consider a health check unhealthy when it otherwise would + // be considered healthy. Inverted *bool // The port on the endpoint that you want Amazon Route 53 to perform health checks // on. Don't specify a value for Port when you specify a value for Type of - // CLOUDWATCH_METRIC or CALCULATED. + // CLOUDWATCH_METRIC or CALCULATED . Port *int32 // A complex type that contains one Region element for each region that you want @@ -267,35 +221,25 @@ type UpdateHealthCheckInput struct { // A complex type that contains one ResettableElementName element for each element // that you want to reset to the default value. Valid values for // ResettableElementName include the following: - // - // * ChildHealthChecks: Amazon Route - // 53 resets ChildHealthChecks - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ChildHealthChecks) - // to null. - // - // * FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName). - // to null. - // - // * Regions: Route 53 resets the Regions - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions) - // list to the default set of regions. - // - // * ResourcePath: Route 53 resets - // ResourcePath - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ResourcePath) - // to null. + // - ChildHealthChecks : Amazon Route 53 resets ChildHealthChecks (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ChildHealthChecks) + // to null. + // - FullyQualifiedDomainName : Route 53 resets FullyQualifiedDomainName (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName) + // . to null. + // - Regions : Route 53 resets the Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions) + // list to the default set of regions. + // - ResourcePath : Route 53 resets ResourcePath (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ResourcePath) + // to null. ResetElements []types.ResettableElementName - // The path that you want Amazon Route 53 to request when performing health checks. - // The path can be any value for which your endpoint will return an HTTP status - // code of 2xx or 3xx when the endpoint is healthy, for example the file + // The path that you want Amazon Route 53 to request when performing health + // checks. The path can be any value for which your endpoint will return an HTTP + // status code of 2xx or 3xx when the endpoint is healthy, for example the file // /docs/route53-health-check.html. You can also include query string parameters, - // for example, /welcome.html?language=jp&login=y. Specify this value only if you + // for example, /welcome.html?language=jp&login=y . Specify this value only if you // want to change it. ResourcePath *string - // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you + // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH , the string that you // want Amazon Route 53 to search for in the response body from the specified // resource. If the string appears in the response body, Route 53 considers the // resource healthy. (You can't change the value of Type when you update a health diff --git a/service/route53/api_op_UpdateHostedZoneComment.go b/service/route53/api_op_UpdateHostedZoneComment.go index 8038624e6eb..aeacd0905e0 100644 --- a/service/route53/api_op_UpdateHostedZoneComment.go +++ b/service/route53/api_op_UpdateHostedZoneComment.go @@ -35,7 +35,7 @@ type UpdateHostedZoneCommentInput struct { // This member is required. Id *string - // The new comment for the hosted zone. If you don't specify a value for Comment, + // The new comment for the hosted zone. If you don't specify a value for Comment , // Amazon Route 53 deletes the existing value of the Comment element, if any. Comment *string diff --git a/service/route53/api_op_UpdateTrafficPolicyInstance.go b/service/route53/api_op_UpdateTrafficPolicyInstance.go index e33711d31c8..aca9cb652e6 100644 --- a/service/route53/api_op_UpdateTrafficPolicyInstance.go +++ b/service/route53/api_op_UpdateTrafficPolicyInstance.go @@ -17,19 +17,14 @@ import ( // the root resource record set name (such as example.com) while it replaces one // group of resource record sets with another. Route 53 performs the following // operations: -// -// * Route 53 creates a new group of resource record sets based on the -// specified traffic policy. This is true regardless of how significant the -// differences are between the existing resource record sets and the new resource -// record sets. -// -// * When all of the new resource record sets have been created, -// Route 53 starts to respond to DNS queries for the root resource record set name -// (such as example.com) by using the new resource record sets. -// -// * Route 53 deletes -// the old group of resource record sets that are associated with the root resource -// record set name. +// - Route 53 creates a new group of resource record sets based on the specified +// traffic policy. This is true regardless of how significant the differences are +// between the existing resource record sets and the new resource record sets. +// - When all of the new resource record sets have been created, Route 53 starts +// to respond to DNS queries for the root resource record set name (such as +// example.com) by using the new resource record sets. +// - Route 53 deletes the old group of resource record sets that are associated +// with the root resource record set name. func (c *Client) UpdateTrafficPolicyInstance(ctx context.Context, params *UpdateTrafficPolicyInstanceInput, optFns ...func(*Options)) (*UpdateTrafficPolicyInstanceOutput, error) { if params == nil { params = &UpdateTrafficPolicyInstanceInput{} @@ -45,8 +40,8 @@ func (c *Client) UpdateTrafficPolicyInstance(ctx context.Context, params *Update return out, nil } -// A complex type that contains information about the resource record sets that you -// want to update based on a specified traffic policy instance. +// A complex type that contains information about the resource record sets that +// you want to update based on a specified traffic policy instance. type UpdateTrafficPolicyInstanceInput struct { // The ID of the traffic policy instance that you want to update. @@ -66,8 +61,8 @@ type UpdateTrafficPolicyInstanceInput struct { // This member is required. TrafficPolicyId *string - // The version of the traffic policy that you want Amazon Route 53 to use to update - // resource record sets for the specified traffic policy instance. + // The version of the traffic policy that you want Amazon Route 53 to use to + // update resource record sets for the specified traffic policy instance. // // This member is required. TrafficPolicyVersion *int32 diff --git a/service/route53/doc.go b/service/route53/doc.go index 82ea541cc6c..d36233e4535 100644 --- a/service/route53/doc.go +++ b/service/route53/doc.go @@ -5,18 +5,14 @@ // // Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web // service. You can use Route 53 to: -// -// * Register domain names. For more -// information, see How domain registration works -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html). -// -// * -// Route internet traffic to the resources for your domain For more information, -// see How internet traffic is routed to your website or web application -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html). -// -// * -// Check the health of your resources. For more information, see How Route 53 -// checks the health of your resources -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html). +// - Register domain names. For more information, see How domain registration +// works (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html) +// . +// - Route internet traffic to the resources for your domain For more +// information, see How internet traffic is routed to your website or web +// application (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html) +// . +// - Check the health of your resources. For more information, see How Route 53 +// checks the health of your resources (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html) +// . package route53 diff --git a/service/route53/types/enums.go b/service/route53/types/enums.go index 77f0ab96071..cc3464d7a75 100644 --- a/service/route53/types/enums.go +++ b/service/route53/types/enums.go @@ -35,9 +35,9 @@ const ( ChangeActionUpsert ChangeAction = "UPSERT" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "CREATE", @@ -54,9 +54,9 @@ const ( ChangeStatusInsync ChangeStatus = "INSYNC" ) -// Values returns all known values for ChangeStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeStatus) Values() []ChangeStatus { return []ChangeStatus{ "PENDING", @@ -273,9 +273,10 @@ const ( InsufficientDataHealthStatusLastKnownStatus InsufficientDataHealthStatus = "LastKnownStatus" ) -// Values returns all known values for InsufficientDataHealthStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InsufficientDataHealthStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (InsufficientDataHealthStatus) Values() []InsufficientDataHealthStatus { return []InsufficientDataHealthStatus{ "Healthy", @@ -294,8 +295,8 @@ const ( ResettableElementNameChildHealthChecks ResettableElementName = "ChildHealthChecks" ) -// Values returns all known values for ResettableElementName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ResettableElementName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ResettableElementName) Values() []ResettableElementName { return []ResettableElementName{ @@ -464,9 +465,9 @@ const ( StatisticMinimum Statistic = "Minimum" ) -// Values returns all known values for Statistic. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Statistic. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Statistic) Values() []Statistic { return []Statistic{ "Average", @@ -534,9 +535,9 @@ const ( VPCRegionApSoutheast4 VPCRegion = "ap-southeast-4" ) -// Values returns all known values for VPCRegion. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for VPCRegion. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (VPCRegion) Values() []VPCRegion { return []VPCRegion{ "us-east-1", diff --git a/service/route53/types/errors.go b/service/route53/types/errors.go index 8ae91df46a7..1bb6aa02748 100644 --- a/service/route53/types/errors.go +++ b/service/route53/types/errors.go @@ -33,8 +33,8 @@ func (e *CidrBlockInUseException) ErrorCode() string { } func (e *CidrBlockInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A CIDR collection with this name and a different caller reference already exists -// in this account. +// A CIDR collection with this name and a different caller reference already +// exists in this account. type CidrCollectionAlreadyExistsException struct { Message *string @@ -145,24 +145,18 @@ func (e *ConcurrentModification) ErrorCode() string { func (e *ConcurrentModification) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The cause of this error depends on the operation that you're performing: -// -// * -// Create a public hosted zone: Two hosted zones that have the same name or that -// have a parent/child relationship (example.com and test.example.com) can't have -// any common name servers. You tried to create a hosted zone that has the same -// name as an existing hosted zone or that's the parent or child of an existing -// hosted zone, and you specified a delegation set that shares one or more name -// servers with the existing hosted zone. For more information, see -// CreateReusableDelegationSet -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html). -// -// * -// Create a private hosted zone: A hosted zone with the specified name already -// exists and is already associated with the Amazon VPC that you specified. -// -// * -// Associate VPCs with a private hosted zone: The VPC that you specified is already -// associated with another hosted zone that has the same name. +// - Create a public hosted zone: Two hosted zones that have the same name or +// that have a parent/child relationship (example.com and test.example.com) can't +// have any common name servers. You tried to create a hosted zone that has the +// same name as an existing hosted zone or that's the parent or child of an +// existing hosted zone, and you specified a delegation set that shares one or more +// name servers with the existing hosted zone. For more information, see +// CreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html) +// . +// - Create a private hosted zone: A hosted zone with the specified name already +// exists and is already associated with the Amazon VPC that you specified. +// - Associate VPCs with a private hosted zone: The VPC that you specified is +// already associated with another hosted zone that has the same name. type ConflictingDomainExists struct { Message *string @@ -191,7 +185,7 @@ func (e *ConflictingDomainExists) ErrorFault() smithy.ErrorFault { return smithy // You tried to update a traffic policy instance by using a traffic policy version // that has a different DNS type than the current type for the instance. You // specified the type in the JSON document in the CreateTrafficPolicy or -// CreateTrafficPolicyVersionrequest. +// CreateTrafficPolicyVersion request. type ConflictingTypes struct { Message *string @@ -381,14 +375,11 @@ func (e *DNSSECNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultCli // The health check you're attempting to create already exists. Amazon Route 53 // returns this error when you submit a request that has the following values: -// -// * -// The same value for CallerReference as an existing health check, and one or more -// values that differ from the existing health check that has the same caller -// reference. -// -// * The same value for CallerReference as a health check that you -// created and later deleted, regardless of the other settings in the request. +// - The same value for CallerReference as an existing health check, and one or +// more values that differ from the existing health check that has the same caller +// reference. +// - The same value for CallerReference as a health check that you created and +// later deleted, regardless of the other settings in the request. type HealthCheckAlreadyExists struct { Message *string @@ -469,7 +460,7 @@ func (e *HealthCheckVersionMismatch) ErrorFault() smithy.ErrorFault { return smi // The hosted zone you're trying to create already exists. Amazon Route 53 returns // this error when a hosted zone has already been created with the specified -// CallerReference. +// CallerReference . type HostedZoneAlreadyExists struct { Message *string @@ -629,25 +620,17 @@ func (e *IncompatibleVersion) ErrorFault() smithy.ErrorFault { return smithy.Fau // Amazon Route 53 doesn't have the permissions required to create log streams and // send query logs to log streams. Possible causes include the following: -// -// * There -// is no resource policy that specifies the log group ARN in the value for -// Resource. -// -// * The resource policy that includes the log group ARN in the value -// for Resource doesn't have the necessary permissions. -// -// * The resource policy -// hasn't finished propagating yet. -// -// * The Key management service (KMS) key you -// specified doesn’t exist or it can’t be used with the log group associated with -// query log. Update or provide a resource policy to grant permissions for the KMS -// key. -// -// * The Key management service (KMS) key you specified is marked as disabled -// for the log group associated with query log. Update or provide a resource policy -// to grant permissions for the KMS key. +// - There is no resource policy that specifies the log group ARN in the value +// for Resource . +// - The resource policy that includes the log group ARN in the value for +// Resource doesn't have the necessary permissions. +// - The resource policy hasn't finished propagating yet. +// - The Key management service (KMS) key you specified doesn’t exist or it +// can’t be used with the log group associated with query log. Update or provide a +// resource policy to grant permissions for the KMS key. +// - The Key management service (KMS) key you specified is marked as disabled +// for the log group associated with query log. Update or provide a resource policy +// to grant permissions for the KMS key. type InsufficientCloudWatchLogsResourcePolicy struct { Message *string @@ -809,7 +792,7 @@ func (e *InvalidKeySigningKeyName) ErrorCode() string { func (e *InvalidKeySigningKeyName) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The key-signing key (KSK) status isn't valid or another KSK has the status -// INTERNAL_FAILURE. +// INTERNAL_FAILURE . type InvalidKeySigningKeyStatus struct { Message *string @@ -890,7 +873,7 @@ func (e *InvalidPaginationToken) ErrorCode() string { func (e *InvalidPaginationToken) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Your hosted zone status isn't valid for this operation. In the hosted zone, -// change the status to enable DNSSEC or disable DNSSEC. +// change the status to enable DNSSEC or disable DNSSEC . type InvalidSigningStatus struct { Message *string @@ -1266,9 +1249,8 @@ func (e *NoSuchDelegationSet) ErrorCode() string { } func (e *NoSuchDelegationSet) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Amazon Route 53 doesn't support the specified geographic location. For a list of -// supported geolocation codes, see the GeoLocation -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html) +// Amazon Route 53 doesn't support the specified geographic location. For a list +// of supported geolocation codes, see the GeoLocation (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html) // data type. type NoSuchGeoLocation struct { Message *string @@ -1480,7 +1462,7 @@ func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault { return smithy. // If Amazon Route 53 can't process a request before the next request arrives, it // will reject subsequent requests for the same hosted zone and return an HTTP 400 -// error (Bad request). If Route 53 returns this error repeatedly for the same +// error ( Bad request ). If Route 53 returns this error repeatedly for the same // request, we recommend that you wait, in intervals of increasing duration, before // you try the request again. type PriorRequestNotComplete struct { @@ -1590,16 +1572,14 @@ func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.Fau // This health check can't be created because the current account has reached the // limit on the number of active health checks. For information about default -// limits, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// limits, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) // in the Amazon Route 53 Developer Guide. For information about how to get the -// current limit for an account, see GetAccountLimit -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html). -// To request a higher limit, create a case (http://aws.amazon.com/route53-request) +// current limit for an account, see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html) +// . To request a higher limit, create a case (http://aws.amazon.com/route53-request) // with the Amazon Web Services Support Center. You have reached the maximum number // of active health checks for an Amazon Web Services account. To request a higher -// limit, create a case (http://aws.amazon.com/route53-request) with the Amazon Web -// Services Support Center. +// limit, create a case (http://aws.amazon.com/route53-request) with the Amazon +// Web Services Support Center. type TooManyHealthChecks struct { Message *string @@ -1625,18 +1605,15 @@ func (e *TooManyHealthChecks) ErrorCode() string { } func (e *TooManyHealthChecks) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This operation can't be completed either because the current account has reached -// the limit on the number of hosted zones or because you've reached the limit on -// the number of hosted zones that can be associated with a reusable delegation -// set. For information about default limits, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// This operation can't be completed either because the current account has +// reached the limit on the number of hosted zones or because you've reached the +// limit on the number of hosted zones that can be associated with a reusable +// delegation set. For information about default limits, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) // in the Amazon Route 53 Developer Guide. To get the current limit on hosted zones -// that can be created by an account, see GetAccountLimit -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html). -// To get the current limit on hosted zones that can be associated with a reusable -// delegation set, see GetReusableDelegationSetLimit -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html). -// To request a higher limit, create a case (http://aws.amazon.com/route53-request) +// that can be created by an account, see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html) +// . To get the current limit on hosted zones that can be associated with a +// reusable delegation set, see GetReusableDelegationSetLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html) +// . To request a higher limit, create a case (http://aws.amazon.com/route53-request) // with the Amazon Web Services Support Center. type TooManyHostedZones struct { Message *string @@ -1690,14 +1667,12 @@ func (e *TooManyKeySigningKeys) ErrorCode() string { } func (e *TooManyKeySigningKeys) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This traffic policy can't be created because the current account has reached the -// limit on the number of traffic policies. For information about default limits, -// see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// This traffic policy can't be created because the current account has reached +// the limit on the number of traffic policies. For information about default +// limits, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) // in the Amazon Route 53 Developer Guide. To get the current limit for an account, -// see GetAccountLimit -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html). -// To request a higher limit, create a case (http://aws.amazon.com/route53-request) +// see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html) +// . To request a higher limit, create a case (http://aws.amazon.com/route53-request) // with the Amazon Web Services Support Center. type TooManyTrafficPolicies struct { Message *string @@ -1726,12 +1701,10 @@ func (e *TooManyTrafficPolicies) ErrorFault() smithy.ErrorFault { return smithy. // This traffic policy instance can't be created because the current account has // reached the limit on the number of traffic policy instances. For information -// about default limits, see Limits -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) +// about default limits, see Limits (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html) // in the Amazon Route 53 Developer Guide. For information about how to get the -// current limit for an account, see GetAccountLimit -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html). -// To request a higher limit, create a case (http://aws.amazon.com/route53-request) +// current limit for an account, see GetAccountLimit (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html) +// . To request a higher limit, create a case (http://aws.amazon.com/route53-request) // with the Amazon Web Services Support Center. type TooManyTrafficPolicyInstances struct { Message *string @@ -1758,13 +1731,11 @@ func (e *TooManyTrafficPolicyInstances) ErrorCode() string { } func (e *TooManyTrafficPolicyInstances) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This traffic policy version can't be created because you've reached the limit of -// 1000 on the number of versions that you can create for the current traffic -// policy. To create more traffic policy versions, you can use GetTrafficPolicy -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html) +// This traffic policy version can't be created because you've reached the limit +// of 1000 on the number of versions that you can create for the current traffic +// policy. To create more traffic policy versions, you can use GetTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html) // to get the traffic policy document for a specified traffic policy version, and -// then use CreateTrafficPolicy -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html) +// then use CreateTrafficPolicy (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html) // to create a new traffic policy using the traffic policy document. type TooManyTrafficPolicyVersionsForCurrentPolicy struct { Message *string @@ -1879,8 +1850,8 @@ func (e *TrafficPolicyInstanceAlreadyExists) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// One or more traffic policy instances were created by using the specified traffic -// policy. +// One or more traffic policy instances were created by using the specified +// traffic policy. type TrafficPolicyInUse struct { Message *string diff --git a/service/route53/types/types.go b/service/route53/types/types.go index f2c0fad8097..16e1d95cc60 100644 --- a/service/route53/types/types.go +++ b/service/route53/types/types.go @@ -7,37 +7,29 @@ import ( "time" ) -// A complex type that contains the type of limit that you specified in the request -// and the current value for that limit. +// A complex type that contains the type of limit that you specified in the +// request and the current value for that limit. type AccountLimit struct { // The limit that you requested. Valid values include the following: - // - // * - // MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can - // create using the current account. - // - // * MAX_HOSTED_ZONES_BY_OWNER: The maximum - // number of hosted zones that you can create using the current account. - // - // * - // MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation - // sets that you can create using the current account. - // - // * - // MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you - // can create using the current account. - // - // * MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: - // The maximum number of traffic policy instances that you can create using the - // current account. (Traffic policy instances are referred to as traffic flow - // policy records in the Amazon Route 53 console.) + // - MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you + // can create using the current account. + // - MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can + // create using the current account. + // - MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable + // delegation sets that you can create using the current account. + // - MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that + // you can create using the current account. + // - MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy + // instances that you can create using the current account. (Traffic policy + // instances are referred to as traffic flow policy records in the Amazon Route 53 + // console.) // // This member is required. Type AccountLimitType - // The current value for the limit that is specified by Type - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type). + // The current value for the limit that is specified by Type (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type) + // . // // This member is required. Value int64 @@ -53,15 +45,11 @@ type AlarmIdentifier struct { // The name of the CloudWatch alarm that you want Amazon Route 53 health checkers // to use to determine whether this health check is healthy. Route 53 supports // CloudWatch alarms with the following features: - // - // * Standard-resolution metrics. - // High-resolution metrics aren't supported. For more information, see - // High-Resolution Metrics - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) - // in the Amazon CloudWatch User Guide. - // - // * Statistics: Average, Minimum, Maximum, - // Sum, and SampleCount. Extended statistics aren't supported. + // - Standard-resolution metrics. High-resolution metrics aren't supported. For + // more information, see High-Resolution Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) + // in the Amazon CloudWatch User Guide. + // - Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended + // statistics aren't supported. // // This member is required. Name *string @@ -69,9 +57,8 @@ type AlarmIdentifier struct { // For the CloudWatch alarm that you want Route 53 health checkers to use to // determine whether this health check is healthy, the region that the alarm was // created in. For the current list of CloudWatch regions, see Amazon CloudWatch - // endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the Amazon Web - // Services General Reference. + // endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/cw_region.html) + // in the Amazon Web Services General Reference. // // This member is required. Region CloudWatchRegion @@ -83,43 +70,33 @@ type AlarmIdentifier struct { // resource, such as a CloudFront distribution or an Amazon S3 bucket, that you // want to route traffic to. When creating resource record sets for a private // hosted zone, note the following: -// -// * For information about creating failover -// resource record sets in a private hosted zone, see Configuring Failover in a -// Private Hosted Zone -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html). +// - For information about creating failover resource record sets in a private +// hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) +// . type AliasTarget struct { - // Alias resource record sets only: The value that you specify depends on where you - // want to route queries: Amazon API Gateway custom regional APIs and + // Alias resource record sets only: The value that you specify depends on where + // you want to route queries: Amazon API Gateway custom regional APIs and // edge-optimized APIs Specify the applicable domain name for your API. You can get - // the applicable value using the CLI command get-domain-names - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html): - // - // * - // For regional APIs, specify the value of regionalDomainName. - // - // * For - // edge-optimized APIs, specify the value of distributionDomainName. This is the - // name of the associated CloudFront distribution, such as - // da1b2c3d4e5.cloudfront.net. - // - // The name of the record that you're creating must - // match a custom domain name for your API, such as api.example.com. Amazon Virtual - // Private Cloud interface VPC endpoint Enter the API endpoint for the interface - // endpoint, such as - // vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. - // For edge-optimized APIs, this is the domain name for the corresponding + // the applicable value using the CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) + // : + // - For regional APIs, specify the value of regionalDomainName . + // - For edge-optimized APIs, specify the value of distributionDomainName . This + // is the name of the associated CloudFront distribution, such as + // da1b2c3d4e5.cloudfront.net . + // The name of the record that you're creating must match a custom domain name for + // your API, such as api.example.com . Amazon Virtual Private Cloud interface VPC + // endpoint Enter the API endpoint for the interface endpoint, such as + // vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com + // . For edge-optimized APIs, this is the domain name for the corresponding // CloudFront distribution. You can get the value of DnsName using the CLI command - // describe-vpc-endpoints - // (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html). - // CloudFront distribution Specify the domain name that CloudFront assigned when + // describe-vpc-endpoints (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) + // . CloudFront distribution Specify the domain name that CloudFront assigned when // you created your distribution. Your CloudFront distribution must include an // alternate domain name that matches the name of the resource record set. For // example, if the name of the resource record set is acme.example.com, your // CloudFront distribution must include acme.example.com as one of the alternate - // domain names. For more information, see Using Alternate Domain Names (CNAMEs) - // (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) + // domain names. For more information, see Using Alternate Domain Names (CNAMEs) (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html) // in the Amazon CloudFront Developer Guide. You can't create a resource record set // in a private hosted zone to route traffic to a CloudFront distribution. For // failover alias records, you can't specify a CloudFront distribution for both the @@ -141,85 +118,49 @@ type AliasTarget struct { // Beanstalk environments that have regionalized subdomains, specify the CNAME // attribute for the environment. You can use the following methods to get the // value of the CNAME attribute: - // - // * Amazon Web Services Management Console: For - // information about how to get the value by using the console, see Using Custom - // Domains with Elastic Beanstalk - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) in - // the Elastic Beanstalk Developer Guide. - // - // * Elastic Beanstalk API: Use the - // DescribeEnvironments action to get the value of the CNAME attribute. For more - // information, see DescribeEnvironments - // (https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) - // in the Elastic Beanstalk API Reference. - // - // * CLI: Use the describe-environments - // command to get the value of the CNAME attribute. For more information, see - // describe-environments - // (https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) - // in the CLI Command Reference. - // - // ELB load balancer Specify the DNS name that is - // associated with the load balancer. Get the DNS name by using the Amazon Web - // Services Management Console, the ELB API, or the CLI. - // - // * Amazon Web Services - // Management Console: Go to the EC2 page, choose Load Balancers in the navigation - // pane, choose the load balancer, choose the Description tab, and get the value of - // the DNS name field. If you're routing traffic to a Classic Load Balancer, get - // the value that begins with dualstack. If you're routing traffic to another type - // of load balancer, get the value that applies to the record type, A or AAAA. - // - // * - // Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of - // DNSName. For more information, see the applicable guide: - // - // * Classic Load - // Balancers: DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) - // - // * - // Application and Network Load Balancers: DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) - // - // * - // CLI: Use describe-load-balancers to get the value of DNSName. For more - // information, see the applicable guide: - // - // * Classic Load Balancers: - // describe-load-balancers - // (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) - // - // * - // Application and Network Load Balancers: describe-load-balancers - // (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) - // - // Global - // Accelerator accelerator Specify the DNS name for your accelerator: - // - // * Global - // Accelerator API: To get the DNS name, use DescribeAccelerator - // (https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html). - // - // * - // CLI: To get the DNS name, use describe-accelerator - // (https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html). - // - // Amazon - // S3 bucket that is configured as a static website Specify the domain name of the - // Amazon S3 website endpoint that you created the bucket in, for example, - // s3-website.us-east-2.amazonaws.com. For more information about valid values, see - // the table Amazon S3 Website Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) + // - Amazon Web Services Management Console: For information about how to get + // the value by using the console, see Using Custom Domains with Elastic + // Beanstalk (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html) + // in the Elastic Beanstalk Developer Guide. + // - Elastic Beanstalk API: Use the DescribeEnvironments action to get the value + // of the CNAME attribute. For more information, see DescribeEnvironments (https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html) + // in the Elastic Beanstalk API Reference. + // - CLI: Use the describe-environments command to get the value of the CNAME + // attribute. For more information, see describe-environments (https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html) + // in the CLI Command Reference. + // ELB load balancer Specify the DNS name that is associated with the load + // balancer. Get the DNS name by using the Amazon Web Services Management Console, + // the ELB API, or the CLI. + // - Amazon Web Services Management Console: Go to the EC2 page, choose Load + // Balancers in the navigation pane, choose the load balancer, choose the + // Description tab, and get the value of the DNS name field. If you're routing + // traffic to a Classic Load Balancer, get the value that begins with dualstack. If + // you're routing traffic to another type of load balancer, get the value that + // applies to the record type, A or AAAA. + // - Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of + // DNSName . For more information, see the applicable guide: + // - Classic Load Balancers: DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) + // - Application and Network Load Balancers: DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // - CLI: Use describe-load-balancers to get the value of DNSName . For more + // information, see the applicable guide: + // - Classic Load Balancers: describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) + // - Application and Network Load Balancers: describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) + // Global Accelerator accelerator Specify the DNS name for your accelerator: + // - Global Accelerator API: To get the DNS name, use DescribeAccelerator (https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html) + // . + // - CLI: To get the DNS name, use describe-accelerator (https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html) + // . + // Amazon S3 bucket that is configured as a static website Specify the domain name + // of the Amazon S3 website endpoint that you created the bucket in, for example, + // s3-website.us-east-2.amazonaws.com . For more information about valid values, + // see the table Amazon S3 Website Endpoints (https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) // in the Amazon Web Services General Reference. For more information about using - // S3 buckets for websites, see Getting Started with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) + // S3 buckets for websites, see Getting Started with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html) // in the Amazon Route 53 Developer Guide. Another Route 53 resource record set // Specify the value of the Name element for a resource record set in the current // hosted zone. If you're creating an alias record that has the same name as the // hosted zone (known as the zone apex), you can't specify the domain name for a - // record for which the value of Type is CNAME. This is because the alias record + // record for which the value of Type is CNAME . This is because the alias record // must have the same type as the record that you're routing traffic to, and // creating a CNAME record for the zone apex isn't supported even for an alias // record. @@ -228,60 +169,49 @@ type AliasTarget struct { DNSName *string // Applies only to alias, failover alias, geolocation alias, latency alias, and - // weighted alias resource record sets: When EvaluateTargetHealth is true, an alias - // resource record set inherits the health of the referenced Amazon Web Services - // resource, such as an ELB load balancer or another resource record set in the - // hosted zone. Note the following: CloudFront distributions You can't set - // EvaluateTargetHealth to true when the alias target is a CloudFront distribution. - // Elastic Beanstalk environments that have regionalized subdomains If you specify - // an Elastic Beanstalk environment in DNSName and the environment contains an ELB - // load balancer, Elastic Load Balancing routes queries only to the healthy Amazon - // EC2 instances that are registered with the load balancer. (An environment - // automatically contains an ELB load balancer if it includes more than one Amazon - // EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 - // instances are healthy or the load balancer itself is unhealthy, Route 53 routes - // queries to other available resources that are healthy, if any. If the + // weighted alias resource record sets: When EvaluateTargetHealth is true , an + // alias resource record set inherits the health of the referenced Amazon Web + // Services resource, such as an ELB load balancer or another resource record set + // in the hosted zone. Note the following: CloudFront distributions You can't set + // EvaluateTargetHealth to true when the alias target is a CloudFront + // distribution. Elastic Beanstalk environments that have regionalized subdomains + // If you specify an Elastic Beanstalk environment in DNSName and the environment + // contains an ELB load balancer, Elastic Load Balancing routes queries only to the + // healthy Amazon EC2 instances that are registered with the load balancer. (An + // environment automatically contains an ELB load balancer if it includes more than + // one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no + // Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route + // 53 routes queries to other available resources that are healthy, if any. If the // environment contains a single Amazon EC2 instance, there are no special // requirements. ELB load balancers Health checking behavior depends on the type of // load balancer: - // - // * Classic Load Balancers: If you specify an ELB Classic Load - // Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy - // Amazon EC2 instances that are registered with the load balancer. If you set - // EvaluateTargetHealth to true and either no EC2 instances are healthy or the load - // balancer itself is unhealthy, Route 53 routes queries to other resources. - // - // * - // Application and Network Load Balancers: If you specify an ELB Application or - // Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes - // queries to the load balancer based on the health of the target groups that are - // associated with the load balancer: - // - // * For an Application or Network Load - // Balancer to be considered healthy, every target group that contains targets must - // contain at least one healthy target. If any target group contains only unhealthy - // targets, the load balancer is considered unhealthy, and Route 53 routes queries - // to other resources. - // - // * A target group that has no registered targets is - // considered unhealthy. - // - // When you create a load balancer, you configure settings - // for Elastic Load Balancing health checks; they're not Route 53 health checks, - // but they perform a similar function. Do not create Route 53 health checks for - // the EC2 instances that you register with an ELB load balancer. S3 buckets There - // are no special requirements for setting EvaluateTargetHealth to true when the - // alias target is an S3 bucket. Other records in the same hosted zone If the - // Amazon Web Services resource that you specify in DNSName is a record or a group - // of records (for example, a group of weighted records) but is not another alias - // record, we recommend that you associate a health check with all of the records - // in the alias target. For more information, see What Happens When You Omit Health - // Checks? - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) + // - Classic Load Balancers: If you specify an ELB Classic Load Balancer in + // DNSName , Elastic Load Balancing routes queries only to the healthy Amazon EC2 + // instances that are registered with the load balancer. If you set + // EvaluateTargetHealth to true and either no EC2 instances are healthy or the + // load balancer itself is unhealthy, Route 53 routes queries to other resources. + // - Application and Network Load Balancers: If you specify an ELB Application + // or Network Load Balancer and you set EvaluateTargetHealth to true , Route 53 + // routes queries to the load balancer based on the health of the target groups + // that are associated with the load balancer: + // - For an Application or Network Load Balancer to be considered healthy, every + // target group that contains targets must contain at least one healthy target. If + // any target group contains only unhealthy targets, the load balancer is + // considered unhealthy, and Route 53 routes queries to other resources. + // - A target group that has no registered targets is considered unhealthy. + // When you create a load balancer, you configure settings for Elastic Load + // Balancing health checks; they're not Route 53 health checks, but they perform a + // similar function. Do not create Route 53 health checks for the EC2 instances + // that you register with an ELB load balancer. S3 buckets There are no special + // requirements for setting EvaluateTargetHealth to true when the alias target is + // an S3 bucket. Other records in the same hosted zone If the Amazon Web Services + // resource that you specify in DNSName is a record or a group of records (for + // example, a group of weighted records) but is not another alias record, we + // recommend that you associate a health check with all of the records in the alias + // target. For more information, see What Happens When You Omit Health Checks? (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) // in the Amazon Route 53 Developer Guide. For more information and examples, see - // Amazon Route 53 Health Checks and DNS Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in - // the Amazon Route 53 Developer Guide. + // Amazon Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) + // in the Amazon Route 53 Developer Guide. // // This member is required. EvaluateTargetHealth bool @@ -289,72 +219,45 @@ type AliasTarget struct { // Alias resource records sets only: The value used depends on where you want to // route traffic: Amazon API Gateway custom regional APIs and edge-optimized APIs // Specify the hosted zone ID for your API. You can get the applicable value using - // the CLI command get-domain-names - // (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html): - // - // * - // For regional APIs, specify the value of regionalHostedZoneId. - // - // * For - // edge-optimized APIs, specify the value of distributionHostedZoneId. - // - // Amazon - // Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID for your - // interface endpoint. You can get the value of HostedZoneId using the CLI command - // describe-vpc-endpoints - // (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html). - // CloudFront distribution Specify Z2FDTNDATAQYW2. Alias resource record sets for - // CloudFront can't be created in a private zone. Elastic Beanstalk environment + // the CLI command get-domain-names (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html) + // : + // - For regional APIs, specify the value of regionalHostedZoneId . + // - For edge-optimized APIs, specify the value of distributionHostedZoneId . + // Amazon Virtual Private Cloud interface VPC endpoint Specify the hosted zone ID + // for your interface endpoint. You can get the value of HostedZoneId using the + // CLI command describe-vpc-endpoints (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html) + // . CloudFront distribution Specify Z2FDTNDATAQYW2 . Alias resource record sets + // for CloudFront can't be created in a private zone. Elastic Beanstalk environment // Specify the hosted zone ID for the region that you created the environment in. // The environment must have a regionalized subdomain. For a list of regions and - // the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the the - // Amazon Web Services General Reference. ELB load balancer Specify the value of - // the hosted zone ID for the load balancer. Use the following methods to get the - // hosted zone ID: - // - // * Elastic Load Balancing endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/elb.html) topic in the Amazon Web - // Services General Reference: Use the value that corresponds with the region that - // you created your load balancer in. Note that there are separate columns for - // Application and Classic Load Balancers and for Network Load Balancers. - // - // * Amazon - // Web Services Management Console: Go to the Amazon EC2 page, choose Load - // Balancers in the navigation pane, select the load balancer, and get the value of - // the Hosted zone field on the Description tab. - // - // * Elastic Load Balancing API: Use - // DescribeLoadBalancers to get the applicable value. For more information, see the - // applicable guide: - // - // * Classic Load Balancers: Use DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) - // to get the value of CanonicalHostedZoneNameId. - // - // * Application and Network Load - // Balancers: Use DescribeLoadBalancers - // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) - // to get the value of CanonicalHostedZoneId. - // - // * CLI: Use describe-load-balancers - // to get the applicable value. For more information, see the applicable guide: - // - // * - // Classic Load Balancers: Use describe-load-balancers - // (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) - // to get the value of CanonicalHostedZoneNameId. - // - // * Application and Network Load - // Balancers: Use describe-load-balancers - // (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) - // to get the value of CanonicalHostedZoneId. - // - // Global Accelerator accelerator - // Specify Z2BJ6XQ5FK7U4H. An Amazon S3 bucket configured as a static website - // Specify the hosted zone ID for the region that you created the bucket in. For - // more information about valid values, see the table Amazon S3 Website Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) + // the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) + // in the the Amazon Web Services General Reference. ELB load balancer Specify the + // value of the hosted zone ID for the load balancer. Use the following methods to + // get the hosted zone ID: + // - Elastic Load Balancing endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/elb.html) + // topic in the Amazon Web Services General Reference: Use the value that + // corresponds with the region that you created your load balancer in. Note that + // there are separate columns for Application and Classic Load Balancers and for + // Network Load Balancers. + // - Amazon Web Services Management Console: Go to the Amazon EC2 page, choose + // Load Balancers in the navigation pane, select the load balancer, and get the + // value of the Hosted zone field on the Description tab. + // - Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable + // value. For more information, see the applicable guide: + // - Classic Load Balancers: Use DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) + // to get the value of CanonicalHostedZoneNameId . + // - Application and Network Load Balancers: Use DescribeLoadBalancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) + // to get the value of CanonicalHostedZoneId . + // - CLI: Use describe-load-balancers to get the applicable value. For more + // information, see the applicable guide: + // - Classic Load Balancers: Use describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) + // to get the value of CanonicalHostedZoneNameId . + // - Application and Network Load Balancers: Use describe-load-balancers (http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) + // to get the value of CanonicalHostedZoneId . + // Global Accelerator accelerator Specify Z2BJ6XQ5FK7U4H . An Amazon S3 bucket + // configured as a static website Specify the hosted zone ID for the region that + // you created the bucket in. For more information about valid values, see the + // table Amazon S3 Website Endpoints (https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) // in the Amazon Web Services General Reference. Another Route 53 resource record // set in your hosted zone Specify the hosted zone ID of your hosted zone. (An // alias resource record set can't reference a resource record set in a different @@ -370,22 +273,17 @@ type AliasTarget struct { type Change struct { // The action to perform: - // - // * CREATE: Creates a resource record set that has the - // specified values. - // - // * DELETE: Deletes a existing resource record set. To delete - // the resource record set that is associated with a traffic policy instance, use - // DeleteTrafficPolicyInstance - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicyInstance.html). - // Amazon Route 53 will delete the resource record set automatically. If you delete - // the resource record set by using ChangeResourceRecordSets, Route 53 doesn't - // automatically delete the traffic policy instance, and you'll continue to be - // charged for it even though it's no longer in use. - // - // * UPSERT: If a resource - // record set doesn't already exist, Route 53 creates it. If a resource record set - // does exist, Route 53 updates it with the values in the request. + // - CREATE : Creates a resource record set that has the specified values. + // - DELETE : Deletes a existing resource record set. To delete the resource + // record set that is associated with a traffic policy instance, use + // DeleteTrafficPolicyInstance (https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicyInstance.html) + // . Amazon Route 53 will delete the resource record set automatically. If you + // delete the resource record set by using ChangeResourceRecordSets , Route 53 + // doesn't automatically delete the traffic policy instance, and you'll continue to + // be charged for it even though it's no longer in use. + // - UPSERT : If a resource record set doesn't already exist, Route 53 creates + // it. If a resource record set does exist, Route 53 updates it with the values in + // the request. // // This member is required. Action ChangeAction @@ -416,8 +314,7 @@ type ChangeBatch struct { // hosted zone. type ChangeInfo struct { - // This element contains an ID that you use when performing a GetChange - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) + // This element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html) // action to get detailed information about the change. // // This member is required. @@ -429,10 +326,9 @@ type ChangeInfo struct { // This member is required. Status ChangeStatus - // The date and time that the change request was submitted in ISO 8601 format - // (https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time (UTC). - // For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at - // 17:48:16.751 UTC. + // The date and time that the change request was submitted in ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601) + // and Coordinated Universal Time (UTC). For example, the value + // 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. // // This member is required. SubmittedAt *time.Time @@ -458,8 +354,8 @@ type CidrBlockSummary struct { // A complex type that identifies a CIDR collection. type CidrCollection struct { - // The ARN of the collection. Can be used to reference the collection in IAM policy - // or in another Amazon Web Services account. + // The ARN of the collection. Can be used to reference the collection in IAM + // policy or in another Amazon Web Services account. Arn *string // The unique ID of the CIDR collection. @@ -537,15 +433,14 @@ type CloudWatchAlarmConfiguration struct { MetricName *string // The namespace of the metric that the alarm is associated with. For more - // information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) + // information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) // in the Amazon CloudWatch User Guide. // // This member is required. Namespace *string - // For the metric that the CloudWatch alarm is associated with, the duration of one - // evaluation period in seconds. + // For the metric that the CloudWatch alarm is associated with, the duration of + // one evaluation period in seconds. // // This member is required. Period *int32 @@ -562,18 +457,16 @@ type CloudWatchAlarmConfiguration struct { // This member is required. Threshold *float64 - // For the metric that the CloudWatch alarm is associated with, a complex type that - // contains information about the dimensions for the metric. For information, see - // Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) + // For the metric that the CloudWatch alarm is associated with, a complex type + // that contains information about the dimensions for the metric. For information, + // see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) // in the Amazon CloudWatch User Guide. Dimensions []Dimension noSmithyDocumentSerde } -// A complex type that is an entry in an CidrCollection -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CidrCollection.html) +// A complex type that is an entry in an CidrCollection (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CidrCollection.html) // array. type CollectionSummary struct { @@ -614,8 +507,8 @@ type DelegationSet struct { noSmithyDocumentSerde } -// For the metric that the CloudWatch alarm is associated with, a complex type that -// contains information about one dimension. +// For the metric that the CloudWatch alarm is associated with, a complex type +// that contains information about one dimension. type Dimension struct { // For the metric that the CloudWatch alarm is associated with, the name of one @@ -636,10 +529,10 @@ type Dimension struct { // A string repesenting the status of DNSSEC signing. type DNSSECStatus struct { - // A string that represents the current hosted zone signing status. Status can have - // one of the following values: SIGNING DNSSEC signing is enabled for the hosted - // zone. NOT_SIGNING DNSSEC signing is not enabled for the hosted zone. DELETING - // DNSSEC signing is in the process of being removed for the hosted zone. + // A string that represents the current hosted zone signing status. Status can + // have one of the following values: SIGNING DNSSEC signing is enabled for the + // hosted zone. NOT_SIGNING DNSSEC signing is not enabled for the hosted zone. + // DELETING DNSSEC signing is in the process of being removed for the hosted zone. // ACTION_NEEDED There is a problem with signing in the hosted zone that requires // you to take action to resolve. For example, the customer managed key might have // been deleted, or the permissions for the customer managed key might have been @@ -650,8 +543,8 @@ type DNSSECStatus struct { ServeSignature *string // The status message provided for the following DNSSEC signing status: - // INTERNAL_FAILURE. The status message includes information about what the problem - // might be and steps that you can take to correct the issue. + // INTERNAL_FAILURE . The status message includes information about what the + // problem might be and steps that you can take to correct the issue. StatusMessage *string noSmithyDocumentSerde @@ -662,38 +555,28 @@ type GeoLocation struct { // The two-letter code for the continent. Amazon Route 53 supports the following // continent codes: - // - // * AF: Africa - // - // * AN: Antarctica - // - // * AS: Asia - // - // * EU: Europe - // - // * - // OC: Oceania - // - // * NA: North America - // - // * SA: South America - // - // Constraint: Specifying - // ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput - // error. + // - AF: Africa + // - AN: Antarctica + // - AS: Asia + // - EU: Europe + // - OC: Oceania + // - NA: North America + // - SA: South America + // Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode + // returns an InvalidInput error. ContinentCode *string // For geolocation resource record sets, the two-letter code for a country. Amazon // Route 53 uses the two-letter country codes that are specified in ISO standard - // 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) . CountryCode *string // For geolocation resource record sets, the two-letter code for a state of the - // United States. Route 53 doesn't support any other values for SubdivisionCode. + // United States. Route 53 doesn't support any other values for SubdivisionCode . // For a list of state abbreviations, see Appendix B: Two–Letter State and // Possession Abbreviations (https://pe.usps.com/text/pub28/28apb.htm) on the - // United States Postal Service website. If you specify subdivisioncode, you must - // also specify US for CountryCode. + // United States Postal Service website. If you specify subdivisioncode , you must + // also specify US for CountryCode . SubdivisionCode *string noSmithyDocumentSerde @@ -719,13 +602,12 @@ type GeoLocationDetails struct { // States. For a list of US state abbreviations, see Appendix B: Two–Letter State // and Possession Abbreviations (https://pe.usps.com/text/pub28/28apb.htm) on the // United States Postal Service website. For a list of all supported subdivision - // codes, use the ListGeoLocations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html) + // codes, use the ListGeoLocations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html) // API. SubdivisionCode *string - // The full name of the subdivision. Route 53 currently supports only states in the - // United States. + // The full name of the subdivision. Route 53 currently supports only states in + // the United States. SubdivisionName *string noSmithyDocumentSerde @@ -745,8 +627,8 @@ type HealthCheck struct { // This member is required. HealthCheckConfig *HealthCheckConfig - // The version of the health check. You can optionally pass this value in a call to - // UpdateHealthCheck to prevent overwriting another change to the health check. + // The version of the health check. You can optionally pass this value in a call + // to UpdateHealthCheck to prevent overwriting another change to the health check. // // This member is required. HealthCheckVersion *int64 @@ -762,9 +644,9 @@ type HealthCheck struct { // Route 53 is monitoring for this health check. CloudWatchAlarmConfiguration *CloudWatchAlarmConfiguration - // If the health check was created by another service, the service that created the - // health check. When a health check is created by another service, you can't edit - // or delete it using Amazon Route 53. + // If the health check was created by another service, the service that created + // the health check. When a health check is created by another service, you can't + // edit or delete it using Amazon Route 53. LinkedService *LinkedService noSmithyDocumentSerde @@ -777,50 +659,35 @@ type HealthCheckConfig struct { // Route 53 determines whether an endpoint is healthy. You can't change the value // of Type after you create a health check. You can create the following types of // health checks: - // - // * HTTP: Route 53 tries to establish a TCP connection. If - // successful, Route 53 submits an HTTP request and waits for an HTTP status code - // of 200 or greater and less than 400. - // - // * HTTPS: Route 53 tries to establish a TCP - // connection. If successful, Route 53 submits an HTTPS request and waits for an - // HTTP status code of 200 or greater and less than 400. If you specify HTTPS for - // the value of Type, the endpoint must support TLS v1.0 or later. - // - // * - // HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, - // Route 53 submits an HTTP request and searches the first 5,120 bytes of the - // response body for the string that you specify in SearchString. - // - // * - // HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, - // Route 53 submits an HTTPS request and searches the first 5,120 bytes of the - // response body for the string that you specify in SearchString. - // - // * TCP: Route 53 - // tries to establish a TCP connection. - // - // * CLOUDWATCH_METRIC: The health check is - // associated with a CloudWatch alarm. If the state of the alarm is OK, the health - // check is considered healthy. If the state is ALARM, the health check is - // considered unhealthy. If CloudWatch doesn't have sufficient data to determine - // whether the state is OK or ALARM, the health check status depends on the setting - // for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus. - // - // * - // CALCULATED: For health checks that monitor the status of other health checks, - // Route 53 adds up the number of health checks that Route 53 health checkers - // consider to be healthy and compares that number with the value of - // HealthThreshold. - // - // * RECOVERY_CONTROL: The health check is assocated with a - // Route53 Application Recovery Controller routing control. If the routing control - // state is ON, the health check is considered healthy. If the state is OFF, the - // health check is considered unhealthy. - // - // For more information, see How Route 53 - // Determines Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // - HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 + // submits an HTTP request and waits for an HTTP status code of 200 or greater and + // less than 400. + // - HTTPS: Route 53 tries to establish a TCP connection. If successful, Route + // 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater + // and less than 400. If you specify HTTPS for the value of Type , the endpoint + // must support TLS v1.0 or later. + // - HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If + // successful, Route 53 submits an HTTP request and searches the first 5,120 bytes + // of the response body for the string that you specify in SearchString . + // - HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If + // successful, Route 53 submits an HTTPS request and searches the first 5,120 + // bytes of the response body for the string that you specify in SearchString . + // - TCP: Route 53 tries to establish a TCP connection. + // - CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. + // If the state of the alarm is OK , the health check is considered healthy. If + // the state is ALARM , the health check is considered unhealthy. If CloudWatch + // doesn't have sufficient data to determine whether the state is OK or ALARM , + // the health check status depends on the setting for + // InsufficientDataHealthStatus : Healthy , Unhealthy , or LastKnownStatus . + // - CALCULATED: For health checks that monitor the status of other health + // checks, Route 53 adds up the number of health checks that Route 53 health + // checkers consider to be healthy and compares that number with the value of + // HealthThreshold . + // - RECOVERY_CONTROL: The health check is assocated with a Route53 Application + // Recovery Controller routing control. If the routing control state is ON , the + // health check is considered healthy. If the state is OFF , the health check is + // considered unhealthy. + // For more information, see How Route 53 Determines Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Amazon Route 53 Developer Guide. // // This member is required. @@ -838,26 +705,19 @@ type HealthCheckConfig struct { // Stops Route 53 from performing health checks. When you disable a health check, // here's what happens: - // - // * Health checks that check the health of endpoints: Route - // 53 stops submitting requests to your application, server, or other resource. - // - // * - // Calculated health checks: Route 53 stops aggregating the status of the - // referenced health checks. - // - // * Health checks that monitor CloudWatch alarms: Route - // 53 stops monitoring the corresponding CloudWatch metrics. - // - // After you disable a - // health check, Route 53 considers the status of the health check to always be - // healthy. If you configured DNS failover, Route 53 continues to route traffic to - // the corresponding resources. If you want to stop routing traffic to a resource, - // change the value of Inverted - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted). - // Charges for a health check still apply when the health check is disabled. For - // more information, see Amazon Route 53 Pricing - // (http://aws.amazon.com/route53/pricing/). + // - Health checks that check the health of endpoints: Route 53 stops submitting + // requests to your application, server, or other resource. + // - Calculated health checks: Route 53 stops aggregating the status of the + // referenced health checks. + // - Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the + // corresponding CloudWatch metrics. + // After you disable a health check, Route 53 considers the status of the health + // check to always be healthy. If you configured DNS failover, Route 53 continues + // to route traffic to the corresponding resources. If you want to stop routing + // traffic to a resource, change the value of Inverted (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted) + // . Charges for a health check still apply when the health check is disabled. For + // more information, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) + // . Disabled *bool // Specify whether you want Amazon Route 53 to send the value of @@ -865,150 +725,119 @@ type HealthCheckConfig struct { // negotiation. This allows the endpoint to respond to HTTPS health check requests // with the applicable SSL/TLS certificate. Some endpoints require that HTTPS // requests include the host name in the client_hello message. If you don't enable - // SNI, the status of the health check will be SSL alert handshake_failure. A + // SNI, the status of the health check will be SSL alert handshake_failure . A // health check can also have that status for other reasons. If SNI is enabled and // you're still getting the error, check the SSL/TLS configuration on your endpoint // and confirm that your certificate is valid. The SSL/TLS certificate on your // endpoint includes a domain name in the Common Name field and possibly several // more in the Subject Alternative Names field. One of the domain names in the - // certificate should match the value that you specify for - // FullyQualifiedDomainName. If the endpoint responds to the client_hello message - // with a certificate that does not include the domain name that you specified in - // FullyQualifiedDomainName, a health checker will retry the handshake. In the - // second attempt, the health checker will omit FullyQualifiedDomainName from the - // client_hello message. + // certificate should match the value that you specify for FullyQualifiedDomainName + // . If the endpoint responds to the client_hello message with a certificate that + // does not include the domain name that you specified in FullyQualifiedDomainName + // , a health checker will retry the handshake. In the second attempt, the health + // checker will omit FullyQualifiedDomainName from the client_hello message. EnableSNI *bool // The number of consecutive health checks that an endpoint must pass or fail for // Amazon Route 53 to change the current status of the endpoint from unhealthy to // healthy or vice versa. For more information, see How Amazon Route 53 Determines - // Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Amazon Route 53 Developer Guide. If you don't specify a value for - // FailureThreshold, the default value is three health checks. + // FailureThreshold , the default value is three health checks. FailureThreshold *int32 - // Amazon Route 53 behavior depends on whether you specify a value for IPAddress. - // If you specify a value for IPAddress: Amazon Route 53 sends health check + // Amazon Route 53 behavior depends on whether you specify a value for IPAddress . + // If you specify a value for IPAddress : Amazon Route 53 sends health check // requests to the specified IPv4 or IPv6 address and passes the value of // FullyQualifiedDomainName in the Host header for all health checks except TCP // health checks. This is typically the fully qualified DNS name of the endpoint on // which you want Route 53 to perform health checks. When Route 53 checks the // health of an endpoint, here is how it constructs the Host header: - // - // * If you - // specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 - // passes the value of FullyQualifiedDomainName to the endpoint in the Host - // header. - // - // * If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH - // for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint - // in the Host header. - // - // * If you specify another value for Port and any value - // except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the - // endpoint in the Host header. - // - // If you don't specify a value for - // FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the - // Host header in each of the preceding cases. If you don't specify a value for - // IPAddress: Route 53 sends a DNS request to the domain that you specify for - // FullyQualifiedDomainName at the interval that you specify for RequestInterval. - // Using an IPv4 address that DNS returns, Route 53 then checks the health of the - // endpoint. If you don't specify a value for IPAddress, Route 53 uses only IPv4 to - // send health checks to the endpoint. If there's no resource record set with a - // type of A for the name that you specify for FullyQualifiedDomainName, the health - // check fails with a "DNS resolution failed" error. If you want to check the - // health of weighted, latency, or failover resource record sets and you choose to - // specify the endpoint only by FullyQualifiedDomainName, we recommend that you - // create a separate health check for each endpoint. For example, create a health - // check for each HTTP server that is serving content for www.example.com. For the - // value of FullyQualifiedDomainName, specify the domain name of the server (such - // as us-east-2-www.example.com), not the name of the resource record sets + // - If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type , + // Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the + // Host header. + // - If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type + // , Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the + // Host header. + // - If you specify another value for Port and any value except TCP for Type , + // Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host + // header. + // If you don't specify a value for FullyQualifiedDomainName , Route 53 substitutes + // the value of IPAddress in the Host header in each of the preceding cases. If + // you don't specify a value for IPAddress : Route 53 sends a DNS request to the + // domain that you specify for FullyQualifiedDomainName at the interval that you + // specify for RequestInterval . Using an IPv4 address that DNS returns, Route 53 + // then checks the health of the endpoint. If you don't specify a value for + // IPAddress , Route 53 uses only IPv4 to send health checks to the endpoint. If + // there's no resource record set with a type of A for the name that you specify + // for FullyQualifiedDomainName , the health check fails with a "DNS resolution + // failed" error. If you want to check the health of weighted, latency, or failover + // resource record sets and you choose to specify the endpoint only by + // FullyQualifiedDomainName , we recommend that you create a separate health check + // for each endpoint. For example, create a health check for each HTTP server that + // is serving content for www.example.com. For the value of + // FullyQualifiedDomainName , specify the domain name of the server (such as + // us-east-2-www.example.com), not the name of the resource record sets // (www.example.com). In this configuration, if you create a health check for which // the value of FullyQualifiedDomainName matches the name of the resource record // sets and you then associate the health check with those resource record sets, // health check results will be unpredictable. In addition, if the value that you - // specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 - // passes the value of FullyQualifiedDomainName in the Host header, as it does when - // you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't - // pass a Host header. + // specify for Type is HTTP , HTTPS , HTTP_STR_MATCH , or HTTPS_STR_MATCH , Route + // 53 passes the value of FullyQualifiedDomainName in the Host header, as it does + // when you specify a value for IPAddress . If the value of Type is TCP , Route 53 + // doesn't pass a Host header. FullyQualifiedDomainName *string // The number of child health checks that are associated with a CALCULATED health - // check that Amazon Route 53 must consider healthy for the CALCULATED health check - // to be considered healthy. To specify the child health checks that you want to - // associate with a CALCULATED health check, use the ChildHealthChecks - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) + // check that Amazon Route 53 must consider healthy for the CALCULATED health + // check to be considered healthy. To specify the child health checks that you want + // to associate with a CALCULATED health check, use the ChildHealthChecks (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) // element. Note the following: - // - // * If you specify a number greater than the number - // of child health checks, Route 53 always considers this health check to be - // unhealthy. - // - // * If you specify 0, Route 53 always considers this health check to - // be healthy. + // - If you specify a number greater than the number of child health checks, + // Route 53 always considers this health check to be unhealthy. + // - If you specify 0 , Route 53 always considers this health check to be + // healthy. HealthThreshold *int32 // The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to - // perform health checks on. If you don't specify a value for IPAddress, Route 53 + // perform health checks on. If you don't specify a value for IPAddress , Route 53 // sends a DNS request to resolve the domain name that you specify in - // FullyQualifiedDomainName at the interval that you specify in RequestInterval. + // FullyQualifiedDomainName at the interval that you specify in RequestInterval . // Using an IP address returned by DNS, Route 53 then checks the health of the - // endpoint. Use one of the following formats for the value of IPAddress: - // - // * IPv4 - // address: four values between 0 and 255, separated by periods (.), for example, - // 192.0.2.44. - // - // * IPv6 address: eight groups of four hexadecimal values, separated - // by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can - // also shorten IPv6 addresses as described in RFC 5952, for example, - // 2001:db8:85a3::abcd:1:2345. - // - // If the endpoint is an EC2 instance, we recommend - // that you create an Elastic IP address, associate it with your EC2 instance, and - // specify the Elastic IP address for IPAddress. This ensures that the IP address - // of your instance will never change. For more information, see - // FullyQualifiedDomainName - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName). - // Constraints: Route 53 can't check the health of endpoints for which the IP + // endpoint. Use one of the following formats for the value of IPAddress : + // - IPv4 address: four values between 0 and 255, separated by periods (.), for + // example, 192.0.2.44 . + // - IPv6 address: eight groups of four hexadecimal values, separated by colons + // (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 . You can also + // shorten IPv6 addresses as described in RFC 5952, for example, + // 2001:db8:85a3::abcd:1:2345 . + // If the endpoint is an EC2 instance, we recommend that you create an Elastic IP + // address, associate it with your EC2 instance, and specify the Elastic IP address + // for IPAddress . This ensures that the IP address of your instance will never + // change. For more information, see FullyQualifiedDomainName (https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName) + // . Constraints: Route 53 can't check the health of endpoints for which the IP // address is in local, private, non-routable, or multicast ranges. For more // information about IP addresses for which you can't create health checks, see the // following documents: - // - // * RFC 5735, Special Use IPv4 Addresses - // (https://tools.ietf.org/html/rfc5735) - // - // * RFC 6598, IANA-Reserved IPv4 Prefix for - // Shared Address Space (https://tools.ietf.org/html/rfc6598) - // - // * RFC 5156, - // Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) - // - // When the value - // of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress. + // - RFC 5735, Special Use IPv4 Addresses (https://tools.ietf.org/html/rfc5735) + // - RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space (https://tools.ietf.org/html/rfc6598) + // - RFC 5156, Special-Use IPv6 Addresses (https://tools.ietf.org/html/rfc5156) + // When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress . IPAddress *string // When CloudWatch has insufficient data about the metric to determine the alarm - // state, the status that you want Amazon Route 53 to assign to the health - // check: - // - // * Healthy: Route 53 considers the health check to be healthy. - // - // * - // Unhealthy: Route 53 considers the health check to be unhealthy. - // - // * - // LastKnownStatus: Route 53 uses the status of the health check from the last time - // that CloudWatch had sufficient data to determine the alarm state. For new health - // checks that have no last known status, the default status for the health check - // is healthy. + // state, the status that you want Amazon Route 53 to assign to the health check: + // - Healthy : Route 53 considers the health check to be healthy. + // - Unhealthy : Route 53 considers the health check to be unhealthy. + // - LastKnownStatus : Route 53 uses the status of the health check from the last + // time that CloudWatch had sufficient data to determine the alarm state. For new + // health checks that have no last known status, the default status for the health + // check is healthy. InsufficientDataHealthStatus InsufficientDataHealthStatus - // Specify whether you want Amazon Route 53 to invert the status of a health check, - // for example, to consider a health check unhealthy when it otherwise would be - // considered healthy. + // Specify whether you want Amazon Route 53 to invert the status of a health + // check, for example, to consider a health check unhealthy when it otherwise would + // be considered healthy. Inverted *bool // Specify whether you want Amazon Route 53 to measure the latency between health @@ -1020,7 +849,7 @@ type HealthCheckConfig struct { // The port on the endpoint that you want Amazon Route 53 to perform health checks // on. Don't specify a value for Port when you specify a value for Type of - // CLOUDWATCH_METRIC or CALCULATED. + // CLOUDWATCH_METRIC or CALCULATED . Port *int32 // A complex type that contains one Region element for each region from which you @@ -1033,31 +862,31 @@ type HealthCheckConfig struct { // three regions with four different regions). Regions []HealthCheckRegion - // The number of seconds between the time that Amazon Route 53 gets a response from - // your endpoint and the time that it sends the next health check request. Each - // Route 53 health checker makes requests at this interval. You can't change the - // value of RequestInterval after you create a health check. If you don't specify a - // value for RequestInterval, the default value is 30 seconds. + // The number of seconds between the time that Amazon Route 53 gets a response + // from your endpoint and the time that it sends the next health check request. + // Each Route 53 health checker makes requests at this interval. You can't change + // the value of RequestInterval after you create a health check. If you don't + // specify a value for RequestInterval , the default value is 30 seconds. RequestInterval *int32 // The path, if any, that you want Amazon Route 53 to request when performing // health checks. The path can be any value for which your endpoint will return an // HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the // file /docs/route53-health-check.html. You can also include query string - // parameters, for example, /welcome.html?language=jp&login=y. + // parameters, for example, /welcome.html?language=jp&login=y . ResourcePath *string // The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller // routing control. For more information about Route 53 Application Recovery - // Controller, see Route 53 Application Recovery Controller Developer Guide. - // (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html). + // Controller, see Route 53 Application Recovery Controller Developer Guide. (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html) + // . RoutingControlArn *string - // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you + // If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH , the string that you // want Amazon Route 53 to search for in the response body from the specified // resource. If the string appears in the response body, Route 53 considers the - // resource healthy. Route 53 considers case when searching for SearchString in the - // response body. + // resource healthy. Route 53 considers case when searching for SearchString in + // the response body. SearchString *string noSmithyDocumentSerde @@ -1068,11 +897,11 @@ type HealthCheckConfig struct { type HealthCheckObservation struct { // The IP address of the Amazon Route 53 health checker that provided the failure - // reason in StatusReport. + // reason in StatusReport . IPAddress *string // The region of the Amazon Route 53 health checker that provided the status in - // StatusReport. + // StatusReport . Region HealthCheckRegion // A complex type that contains the last failure reason as reported by one Amazon @@ -1098,9 +927,9 @@ type HostedZone struct { // The name of the domain. For public hosted zones, this is the name that you have // registered with your DNS registrar. For information about how to specify - // characters other than a-z, 0-9, and - (hyphen) and how to specify - // internationalized domain names, see CreateHostedZone - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html). + // characters other than a-z , 0-9 , and - (hyphen) and how to specify + // internationalized domain names, see CreateHostedZone (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) + // . // // This member is required. Name *string @@ -1135,23 +964,20 @@ type HostedZoneConfig struct { noSmithyDocumentSerde } -// A complex type that contains the type of limit that you specified in the request -// and the current value for that limit. +// A complex type that contains the type of limit that you specified in the +// request and the current value for that limit. type HostedZoneLimit struct { // The limit that you requested. Valid values include the following: - // - // * - // MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the - // specified hosted zone. - // - // * MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of - // Amazon VPCs that you can associate with the specified private hosted zone. + // - MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in + // the specified hosted zone. + // - MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can + // associate with the specified private hosted zone. // // This member is required. Type HostedZoneLimitType - // The current value for the limit that is specified by Type. + // The current value for the limit that is specified by Type . // // This member is required. Value int64 @@ -1161,21 +987,21 @@ type HostedZoneLimit struct { // A complex type that identifies a hosted zone that a specified Amazon VPC is // associated with and the owner of the hosted zone. If there is a value for -// OwningAccount, there is no value for OwningService, and vice versa. +// OwningAccount , there is no value for OwningService , and vice versa. type HostedZoneOwner struct { - // If the hosted zone was created by an Amazon Web Services account, or was created - // by an Amazon Web Services service that creates hosted zones using the current - // account, OwningAccount contains the account ID of that account. For example, - // when you use Cloud Map to create a hosted zone, Cloud Map creates the hosted - // zone using the current Amazon Web Services account. + // If the hosted zone was created by an Amazon Web Services account, or was + // created by an Amazon Web Services service that creates hosted zones using the + // current account, OwningAccount contains the account ID of that account. For + // example, when you use Cloud Map to create a hosted zone, Cloud Map creates the + // hosted zone using the current Amazon Web Services account. OwningAccount *string // If an Amazon Web Services service uses its own account to create a hosted zone - // and associate the specified VPC with that hosted zone, OwningService contains an - // abbreviation that identifies the service. For example, if Amazon Elastic File + // and associate the specified VPC with that hosted zone, OwningService contains + // an abbreviation that identifies the service. For example, if Amazon Elastic File // System (Amazon EFS) created a hosted zone and associated a VPC with the hosted - // zone, the value of OwningService is efs.amazonaws.com. + // zone, the value of OwningService is efs.amazonaws.com . OwningService *string noSmithyDocumentSerde @@ -1183,8 +1009,9 @@ type HostedZoneOwner struct { // In the response to a ListHostedZonesByVPC request, the HostedZoneSummaries // element contains one HostedZoneSummary element for each hosted zone that the -// specified Amazon VPC is associated with. Each HostedZoneSummary element contains -// the hosted zone name and ID, and information about who owns the hosted zone. +// specified Amazon VPC is associated with. Each HostedZoneSummary element +// contains the hosted zone name and ID, and information about who owns the hosted +// zone. type HostedZoneSummary struct { // The Route 53 hosted zone ID of a private hosted zone that the specified VPC is @@ -1193,7 +1020,7 @@ type HostedZoneSummary struct { // This member is required. HostedZoneId *string - // The name of the private hosted zone, such as example.com. + // The name of the private hosted zone, such as example.com . // // This member is required. Name *string @@ -1225,18 +1052,19 @@ type KeySigningKey struct { DSRecord *string // A string used to represent the delegation signer digest algorithm. This value - // must follow the guidelines provided by RFC-8624 Section 3.3 - // (https://tools.ietf.org/html/rfc8624#section-3.3). + // must follow the guidelines provided by RFC-8624 Section 3.3 (https://tools.ietf.org/html/rfc8624#section-3.3) + // . DigestAlgorithmMnemonic *string // An integer used to represent the delegation signer digest algorithm. This value - // must follow the guidelines provided by RFC-8624 Section 3.3 - // (https://tools.ietf.org/html/rfc8624#section-3.3). + // must follow the guidelines provided by RFC-8624 Section 3.3 (https://tools.ietf.org/html/rfc8624#section-3.3) + // . DigestAlgorithmType int32 - // A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used - // to publish the public key that resolvers can use to verify DNSSEC signatures - // that are used to secure certain kinds of information provided by the DNS system. + // A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are + // used to publish the public key that resolvers can use to verify DNSSEC + // signatures that are used to secure certain kinds of information provided by the + // DNS system. DigestValue *string // An integer that specifies how the key is used. For key-signing key (KSK), this @@ -1244,8 +1072,8 @@ type KeySigningKey struct { Flag int32 // An integer used to identify the DNSSEC record for the domain name. The process - // used to calculate the value is described in RFC-4034 Appendix B - // (https://tools.ietf.org/rfc/rfc4034.txt). + // used to calculate the value is described in RFC-4034 Appendix B (https://tools.ietf.org/rfc/rfc4034.txt) + // . KeyTag int32 // The Amazon resource name (ARN) used to identify the customer managed key in Key @@ -1253,23 +1081,15 @@ type KeySigningKey struct { // (KSK) in a single hosted zone. You must configure the customer managed key as // follows: Status Enabled Key spec ECC_NIST_P256 Key usage Sign and verify Key // policy The key policy must give permission for the following actions: - // - // * - // DescribeKey - // - // * GetPublicKey - // - // * Sign - // - // The key policy must also include the Amazon - // Route 53 service in the principal for your account. Specify the following: - // - // * - // "Service": "dnssec-route53.amazonaws.com" - // - // For more information about working - // with the customer managed key in KMS, see Key Management Service concepts - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). + // - DescribeKey + // - GetPublicKey + // - Sign + // The key policy must also include the Amazon Route 53 service in the principal + // for your account. Specify the following: + // - "Service": "dnssec-route53.amazonaws.com" + // For more information about working with the customer managed key in KMS, see + // Key Management Service concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) + // . KmsArn *string // The last time that the key-signing key (KSK) was changed. @@ -1281,17 +1101,17 @@ type KeySigningKey struct { Name *string // The public key, represented as a Base64 encoding, as required by RFC-4034 Page - // 5 (https://tools.ietf.org/rfc/rfc4034.txt). + // 5 (https://tools.ietf.org/rfc/rfc4034.txt) . PublicKey *string // A string used to represent the signing algorithm. This value must follow the - // guidelines provided by RFC-8624 Section 3.1 - // (https://tools.ietf.org/html/rfc8624#section-3.1). + // guidelines provided by RFC-8624 Section 3.1 (https://tools.ietf.org/html/rfc8624#section-3.1) + // . SigningAlgorithmMnemonic *string // An integer used to represent the signing algorithm. This value must follow the - // guidelines provided by RFC-8624 Section 3.1 - // (https://tools.ietf.org/html/rfc8624#section-3.1). + // guidelines provided by RFC-8624 Section 3.1 (https://tools.ietf.org/html/rfc8624#section-3.1) + // . SigningAlgorithmType int32 // A string that represents the current key-signing key (KSK) status. Status can @@ -1307,8 +1127,9 @@ type KeySigningKey struct { Status *string // The status message provided for the following key-signing key (KSK) statuses: - // ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about - // what the problem might be and steps that you can take to correct the issue. + // ACTION_NEEDED or INTERNAL_FAILURE . The status message includes information + // about what the problem might be and steps that you can take to correct the + // issue. StatusMessage *string noSmithyDocumentSerde @@ -1366,17 +1187,16 @@ type QueryLoggingConfig struct { } // Information specific to the resource record. If you're creating an alias -// resource record set, omit ResourceRecord. +// resource record set, omit ResourceRecord . type ResourceRecord struct { - // The current or new DNS record value, not to exceed 4,000 characters. In the case - // of a DELETE action, if the current value does not match the actual value, an - // error is returned. For descriptions about how to format Value for different - // record types, see Supported DNS Resource Record Types - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) + // The current or new DNS record value, not to exceed 4,000 characters. In the + // case of a DELETE action, if the current value does not match the actual value, + // an error is returned. For descriptions about how to format Value for different + // record types, see Supported DNS Resource Record Types (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) // in the Amazon Route 53 Developer Guide. You can specify more than one value for - // all record types except CNAME and SOA. If you're creating an alias resource - // record set, omit Value. + // all record types except CNAME and SOA . If you're creating an alias resource + // record set, omit Value . // // This member is required. Value *string @@ -1390,84 +1210,64 @@ type ResourceRecordSet struct { // For ChangeResourceRecordSets requests, the name of the record that you want to // create, update, or delete. For ListResourceRecordSets responses, the name of a // record in the specified hosted zone. ChangeResourceRecordSets Only Enter a fully - // qualified domain name, for example, www.example.com. You can optionally include + // qualified domain name, for example, www.example.com . You can optionally include // a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the // domain name that you specify is fully qualified. This means that Route 53 treats // www.example.com (without a trailing dot) and www.example.com. (with a trailing // dot) as identical. For information about how to specify characters other than - // a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see - // DNS Domain Name Format - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) + // a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, + // see DNS Domain Name Format (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) // in the Amazon Route 53 Developer Guide. You can use the asterisk (*) wildcard to - // replace the leftmost label in a domain name, for example, *.example.com. Note + // replace the leftmost label in a domain name, for example, *.example.com . Note // the following: - // - // * The * must replace the entire label. For example, you can't - // specify *prod.example.com or prod*.example.com. - // - // * The * can't replace any of - // the middle labels, for example, marketing.*.example.com. - // - // * If you include * in - // any position other than the leftmost label in a domain name, DNS treats it as an - // * character (ASCII 42), not as a wildcard. You can't use the * wildcard for - // resource records sets that have a type of NS. - // - // You can use the * wildcard as the - // leftmost label in a domain name, for example, *.example.com. You can't use an * - // for one of the middle labels, for example, marketing.*.example.com. In addition, - // the * must replace the entire label; for example, you can't specify - // prod*.example.com. + // - The * must replace the entire label. For example, you can't specify + // *prod.example.com or prod*.example.com . + // - The * can't replace any of the middle labels, for example, + // marketing.*.example.com. + // - If you include * in any position other than the leftmost label in a domain + // name, DNS treats it as an * character (ASCII 42), not as a wildcard. You can't + // use the * wildcard for resource records sets that have a type of NS. + // You can use the * wildcard as the leftmost label in a domain name, for example, + // *.example.com . You can't use an * for one of the middle labels, for example, + // marketing.*.example.com . In addition, the * must replace the entire label; for + // example, you can't specify prod*.example.com . // // This member is required. Name *string // The DNS record type. For information about different record types and how data - // is encoded for them, see Supported DNS Resource Record Types - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) + // is encoded for them, see Supported DNS Resource Record Types (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) // in the Amazon Route 53 Developer Guide. Valid values for basic resource record - // sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT - // Values for weighted, latency, geolocation, and failover resource record sets: A - // | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group - // of weighted, latency, geolocation, or failover resource record sets, specify the - // same value for all of the resource record sets in the group. Valid values for - // multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV - // | TXT SPF records were formerly used to verify the identity of the sender of - // email messages. However, we no longer recommend that you create resource record - // sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) - // for Authorizing Use of Domains in Email, Version 1, has been updated to say, - // "...[I]ts existence and mechanism defined in [RFC4408] have led to some - // interoperability issues. Accordingly, its use is no longer appropriate for SPF - // version 1; implementations are not to use it." In RFC 7208, see section 14.1, - // The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1). - // Values for alias resource record sets: - // - // * Amazon API Gateway custom regional - // APIs and edge-optimized APIs: A - // - // * CloudFront distributions: A If IPv6 is - // enabled for the distribution, create two resource record sets to route traffic - // to your distribution, one with a value of A and one with a value of AAAA. - // - // * - // Amazon API Gateway environment that has a regionalized subdomain: A - // - // * ELB load - // balancers: A | AAAA - // - // * Amazon S3 buckets: A - // - // * Amazon Virtual Private Cloud - // interface VPC endpoints A - // - // * Another resource record set in this hosted zone: - // Specify the type of the resource record set that you're creating the alias for. - // All values are supported except NS and SOA. If you're creating an alias record - // that has the same name as the hosted zone (known as the zone apex), you can't - // route traffic to a record for which the value of Type is CNAME. This is because - // the alias record must have the same type as the record you're routing traffic - // to, and creating a CNAME record for the zone apex isn't supported even for an - // alias record. + // sets: A | AAAA | CAA | CNAME | DS | MX | NAPTR | NS | PTR | SOA | SPF | SRV | + // TXT Values for weighted, latency, geolocation, and failover resource record + // sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT . When + // creating a group of weighted, latency, geolocation, or failover resource record + // sets, specify the same value for all of the resource record sets in the group. + // Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR + // | PTR | SPF | SRV | TXT SPF records were formerly used to verify the identity + // of the sender of email messages. However, we no longer recommend that you create + // resource record sets for which the value of Type is SPF . RFC 7208, Sender + // Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has + // been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have + // led to some interoperability issues. Accordingly, its use is no longer + // appropriate for SPF version 1; implementations are not to use it." In RFC 7208, + // see section 14.1, The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1) + // . Values for alias resource record sets: + // - Amazon API Gateway custom regional APIs and edge-optimized APIs: A + // - CloudFront distributions: A If IPv6 is enabled for the distribution, create + // two resource record sets to route traffic to your distribution, one with a value + // of A and one with a value of AAAA . + // - Amazon API Gateway environment that has a regionalized subdomain: A + // - ELB load balancers: A | AAAA + // - Amazon S3 buckets: A + // - Amazon Virtual Private Cloud interface VPC endpoints A + // - Another resource record set in this hosted zone: Specify the type of the + // resource record set that you're creating the alias for. All values are supported + // except NS and SOA . If you're creating an alias record that has the same name + // as the hosted zone (known as the zone apex), you can't route traffic to a record + // for which the value of Type is CNAME . This is because the alias record must + // have the same type as the record you're routing traffic to, and creating a CNAME + // record for the zone apex isn't supported even for an alias record. // // This member is required. Type RRType @@ -1476,15 +1276,11 @@ type ResourceRecordSet struct { // resource, such as a CloudFront distribution or an Amazon S3 bucket, that you // want to route traffic to. If you're creating resource records sets for a private // hosted zone, note the following: - // - // * You can't create an alias resource record - // set in a private hosted zone to route traffic to a CloudFront distribution. - // - // * - // For information about creating failover resource record sets in a private hosted - // zone, see Configuring Failover in a Private Hosted Zone - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) - // in the Amazon Route 53 Developer Guide. + // - You can't create an alias resource record set in a private hosted zone to + // route traffic to a CloudFront distribution. + // - For information about creating failover resource record sets in a private + // hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) + // in the Amazon Route 53 Developer Guide. AliasTarget *AliasTarget // The object that is specified in resource record set object when you are linking @@ -1495,53 +1291,39 @@ type ResourceRecordSet struct { // Failover resource record sets only: To configure failover, you add the Failover // element to two resource record sets. For one resource record set, you specify - // PRIMARY as the value for Failover; for the other resource record set, you - // specify SECONDARY. In addition, you include the HealthCheckId element and + // PRIMARY as the value for Failover ; for the other resource record set, you + // specify SECONDARY . In addition, you include the HealthCheckId element and // specify the health check that you want Amazon Route 53 to perform for each // resource record set. Except where noted, the following failover behaviors assume - // that you have included the HealthCheckId element in both resource record - // sets: - // - // * When the primary resource record set is healthy, Route 53 responds to - // DNS queries with the applicable value from the primary resource record set - // regardless of the health of the secondary resource record set. - // - // * When the - // primary resource record set is unhealthy and the secondary resource record set - // is healthy, Route 53 responds to DNS queries with the applicable value from the - // secondary resource record set. - // - // * When the secondary resource record set is - // unhealthy, Route 53 responds to DNS queries with the applicable value from the - // primary resource record set regardless of the health of the primary resource - // record set. - // - // * If you omit the HealthCheckId element for the secondary resource - // record set, and if the primary resource record set is unhealthy, Route 53 always - // responds to DNS queries with the applicable value from the secondary resource - // record set. This is true regardless of the health of the associated - // endpoint. - // - // You can't create non-failover resource record sets that have the same - // values for the Name and Type elements as failover resource record sets. For - // failover alias resource record sets, you must also include the - // EvaluateTargetHealth element and set the value to true. For more information - // about configuring failover for Route 53, see the following topics in the Amazon - // Route 53 Developer Guide: - // - // * Route 53 Health Checks and DNS Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) - // - // * - // Configuring Failover in a Private Hosted Zone - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) + // that you have included the HealthCheckId element in both resource record sets: + // - When the primary resource record set is healthy, Route 53 responds to DNS + // queries with the applicable value from the primary resource record set + // regardless of the health of the secondary resource record set. + // - When the primary resource record set is unhealthy and the secondary + // resource record set is healthy, Route 53 responds to DNS queries with the + // applicable value from the secondary resource record set. + // - When the secondary resource record set is unhealthy, Route 53 responds to + // DNS queries with the applicable value from the primary resource record set + // regardless of the health of the primary resource record set. + // - If you omit the HealthCheckId element for the secondary resource record set, + // and if the primary resource record set is unhealthy, Route 53 always responds to + // DNS queries with the applicable value from the secondary resource record set. + // This is true regardless of the health of the associated endpoint. + // You can't create non-failover resource record sets that have the same values + // for the Name and Type elements as failover resource record sets. For failover + // alias resource record sets, you must also include the EvaluateTargetHealth + // element and set the value to true. For more information about configuring + // failover for Route 53, see the following topics in the Amazon Route 53 Developer + // Guide: + // - Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) + // - Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) Failover ResourceRecordSetFailover // Geolocation resource record sets only: A complex type that lets you control how // Amazon Route 53 responds to DNS queries based on the geographic origin of the // query. For example, if you want all queries from Africa to be routed to a web - // server with an IP address of 192.0.2.111, create a resource record set with a - // Type of A and a ContinentCode of AF. Although creating geolocation and + // server with an IP address of 192.0.2.111 , create a resource record set with a + // Type of A and a ContinentCode of AF . Although creating geolocation and // geolocation alias resource record sets in a private hosted zone is allowed, it's // not supported. If you create separate resource record sets for overlapping // geographic regions (for example, one resource record set for a continent and one @@ -1551,18 +1333,19 @@ type ResourceRecordSet struct { // You can't create two geolocation resource record sets that specify the same // geographic location. The value * in the CountryCode element matches all // geographic locations that aren't specified in other geolocation resource record - // sets that have the same values for the Name and Type elements. Geolocation works - // by mapping IP addresses to locations. However, some IP addresses aren't mapped - // to geographic locations, so even if you create geolocation resource record sets - // that cover all seven continents, Route 53 will receive some DNS queries from - // locations that it can't identify. We recommend that you create a resource record - // set for which the value of CountryCode is *. Two groups of queries are routed to - // the resource that you specify in this record: queries that come from locations - // for which you haven't created geolocation resource record sets and queries from - // IP addresses that aren't mapped to a location. If you don't create a * resource - // record set, Route 53 returns a "no answer" response for queries from those - // locations. You can't create non-geolocation resource record sets that have the - // same values for the Name and Type elements as geolocation resource record sets. + // sets that have the same values for the Name and Type elements. Geolocation + // works by mapping IP addresses to locations. However, some IP addresses aren't + // mapped to geographic locations, so even if you create geolocation resource + // record sets that cover all seven continents, Route 53 will receive some DNS + // queries from locations that it can't identify. We recommend that you create a + // resource record set for which the value of CountryCode is * . Two groups of + // queries are routed to the resource that you specify in this record: queries that + // come from locations for which you haven't created geolocation resource record + // sets and queries from IP addresses that aren't mapped to a location. If you + // don't create a * resource record set, Route 53 returns a "no answer" response + // for queries from those locations. You can't create non-geolocation resource + // record sets that have the same values for the Name and Type elements as + // geolocation resource record sets. GeoLocation *GeoLocation // If you want Amazon Route 53 to return this resource record set in response to a @@ -1570,214 +1353,154 @@ type ResourceRecordSet struct { // HealthCheckId element and specify the ID of the applicable health check. Route // 53 determines whether a resource record set is healthy based on one of the // following: - // - // * By periodically sending a request to the endpoint that is - // specified in the health check - // - // * By aggregating the status of a specified group - // of health checks (calculated health checks) - // - // * By determining the current state - // of a CloudWatch alarm (CloudWatch metric health checks) - // - // Route 53 doesn't check - // the health of the endpoint that is specified in the resource record set, for - // example, the endpoint specified by the IP address in the Value element. When you - // add a HealthCheckId element to a resource record set, Route 53 checks the health - // of the endpoint that you specified in the health check. For more information, - // see the following topics in the Amazon Route 53 Developer Guide: - // - // * How Amazon - // Route 53 Determines Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) - // - // * - // Route 53 Health Checks and DNS Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) - // - // * - // Configuring Failover in a Private Hosted Zone - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) - // - // When - // to Specify HealthCheckId Specifying a value for HealthCheckId is useful only - // when Route 53 is choosing between two or more resource record sets to respond to - // a DNS query, and you want Route 53 to base the choice in part on the status of a - // health check. Configuring health checks makes sense only in the following - // configurations: - // - // * Non-alias resource record sets: You're checking the health of - // a group of non-alias resource record sets that have the same routing policy, - // name, and type (such as multiple weighted records named www.example.com with a - // type of A) and you specify health check IDs for all the resource record sets. If - // the health check status for a resource record set is healthy, Route 53 includes - // the record among the records that it responds to DNS queries with. If the health - // check status for a resource record set is unhealthy, Route 53 stops responding - // to DNS queries using the value for that resource record set. If the health check - // status for all resource record sets in the group is unhealthy, Route 53 - // considers all resource record sets in the group healthy and responds to DNS - // queries accordingly. - // - // * Alias resource record sets: You specify the following - // settings: - // - // * You set EvaluateTargetHealth to true for an alias resource record - // set in a group of resource record sets that have the same routing policy, name, - // and type (such as multiple weighted records named www.example.com with a type of - // A). - // - // * You configure the alias resource record set to route traffic to a - // non-alias resource record set in the same hosted zone. - // - // * You specify a health - // check ID for the non-alias resource record set. - // - // If the health check status is - // healthy, Route 53 considers the alias resource record set to be healthy and - // includes the alias record among the records that it responds to DNS queries - // with. If the health check status is unhealthy, Route 53 stops responding to DNS - // queries using the alias resource record set. The alias resource record set can - // also route traffic to a group of non-alias resource record sets that have the - // same routing policy, name, and type. In that configuration, associate health - // checks with all of the resource record sets in the group of non-alias resource - // record sets. - // - // Geolocation Routing For geolocation resource record sets, if an - // endpoint is unhealthy, Route 53 looks for a resource record set for the larger, - // associated geographic region. For example, suppose you have resource record sets - // for a state in the United States, for the entire United States, for North - // America, and a resource record set that has * for CountryCode is *, which - // applies to all locations. If the endpoint for the state resource record set is - // unhealthy, Route 53 checks for healthy resource record sets in the following - // order until it finds a resource record set for which the endpoint is healthy: - // - // * - // The United States - // - // * North America - // - // * The default resource record - // set - // + // - By periodically sending a request to the endpoint that is specified in the + // health check + // - By aggregating the status of a specified group of health checks (calculated + // health checks) + // - By determining the current state of a CloudWatch alarm (CloudWatch metric + // health checks) + // Route 53 doesn't check the health of the endpoint that is specified in the + // resource record set, for example, the endpoint specified by the IP address in + // the Value element. When you add a HealthCheckId element to a resource record + // set, Route 53 checks the health of the endpoint that you specified in the health + // check. For more information, see the following topics in the Amazon Route 53 + // Developer Guide: + // - How Amazon Route 53 Determines Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // - Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) + // - Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) + // When to Specify HealthCheckId Specifying a value for HealthCheckId is useful + // only when Route 53 is choosing between two or more resource record sets to + // respond to a DNS query, and you want Route 53 to base the choice in part on the + // status of a health check. Configuring health checks makes sense only in the + // following configurations: + // - Non-alias resource record sets: You're checking the health of a group of + // non-alias resource record sets that have the same routing policy, name, and type + // (such as multiple weighted records named www.example.com with a type of A) and + // you specify health check IDs for all the resource record sets. If the health + // check status for a resource record set is healthy, Route 53 includes the record + // among the records that it responds to DNS queries with. If the health check + // status for a resource record set is unhealthy, Route 53 stops responding to DNS + // queries using the value for that resource record set. If the health check status + // for all resource record sets in the group is unhealthy, Route 53 considers all + // resource record sets in the group healthy and responds to DNS queries + // accordingly. + // - Alias resource record sets: You specify the following settings: + // - You set EvaluateTargetHealth to true for an alias resource record set in a + // group of resource record sets that have the same routing policy, name, and type + // (such as multiple weighted records named www.example.com with a type of A). + // - You configure the alias resource record set to route traffic to a non-alias + // resource record set in the same hosted zone. + // - You specify a health check ID for the non-alias resource record set. If the + // health check status is healthy, Route 53 considers the alias resource record set + // to be healthy and includes the alias record among the records that it responds + // to DNS queries with. If the health check status is unhealthy, Route 53 stops + // responding to DNS queries using the alias resource record set. The alias + // resource record set can also route traffic to a group of non-alias resource + // record sets that have the same routing policy, name, and type. In that + // configuration, associate health checks with all of the resource record sets in + // the group of non-alias resource record sets. + // Geolocation Routing For geolocation resource record sets, if an endpoint is + // unhealthy, Route 53 looks for a resource record set for the larger, associated + // geographic region. For example, suppose you have resource record sets for a + // state in the United States, for the entire United States, for North America, and + // a resource record set that has * for CountryCode is * , which applies to all + // locations. If the endpoint for the state resource record set is unhealthy, Route + // 53 checks for healthy resource record sets in the following order until it finds + // a resource record set for which the endpoint is healthy: + // - The United States + // - North America + // - The default resource record set // Specifying the Health Check Endpoint by Domain Name If your health checks // specify the endpoint only by domain name, we recommend that you create a // separate health check for each endpoint. For example, create a health check for - // each HTTP server that is serving content for www.example.com. For the value of - // FullyQualifiedDomainName, specify the domain name of the server (such as - // us-east-2-www.example.com), not the name of the resource record sets - // (www.example.com). Health check results will be unpredictable if you do the + // each HTTP server that is serving content for www.example.com . For the value of + // FullyQualifiedDomainName , specify the domain name of the server (such as + // us-east-2-www.example.com ), not the name of the resource record sets ( + // www.example.com ). Health check results will be unpredictable if you do the // following: - // - // * Create a health check that has the same value for - // FullyQualifiedDomainName as the name of a resource record set. - // - // * Associate that - // health check with the resource record set. + // - Create a health check that has the same value for FullyQualifiedDomainName + // as the name of a resource record set. + // - Associate that health check with the resource record set. HealthCheckId *string // Multivalue answer resource record sets only: To route traffic approximately // randomly to multiple resources, such as web servers, create one multivalue - // answer record for each resource and specify true for MultiValueAnswer. Note the + // answer record for each resource and specify true for MultiValueAnswer . Note the // following: - // - // * If you associate a health check with a multivalue answer resource - // record set, Amazon Route 53 responds to DNS queries with the corresponding IP - // address only when the health check is healthy. - // - // * If you don't associate a - // health check with a multivalue answer record, Route 53 always considers the - // record to be healthy. - // - // * Route 53 responds to DNS queries with up to eight - // healthy records; if you have eight or fewer healthy records, Route 53 responds - // to all DNS queries with all the healthy records. - // - // * If you have more than eight - // healthy records, Route 53 responds to different DNS resolvers with different - // combinations of healthy records. - // - // * When all records are unhealthy, Route 53 - // responds to DNS queries with up to eight unhealthy records. - // - // * If a resource - // becomes unavailable after a resolver caches a response, client software - // typically tries another of the IP addresses in the response. - // - // You can't create - // multivalue answer alias records. + // - If you associate a health check with a multivalue answer resource record + // set, Amazon Route 53 responds to DNS queries with the corresponding IP address + // only when the health check is healthy. + // - If you don't associate a health check with a multivalue answer record, + // Route 53 always considers the record to be healthy. + // - Route 53 responds to DNS queries with up to eight healthy records; if you + // have eight or fewer healthy records, Route 53 responds to all DNS queries with + // all the healthy records. + // - If you have more than eight healthy records, Route 53 responds to different + // DNS resolvers with different combinations of healthy records. + // - When all records are unhealthy, Route 53 responds to DNS queries with up to + // eight unhealthy records. + // - If a resource becomes unavailable after a resolver caches a response, + // client software typically tries another of the IP addresses in the response. + // You can't create multivalue answer alias records. MultiValueAnswer *bool - // Latency-based resource record sets only: The Amazon EC2 Region where you created - // the resource that this resource record set refers to. The resource typically is - // an Amazon Web Services resource, such as an EC2 instance or an ELB load - // balancer, and is referred to by an IP address or a DNS domain name, depending on - // the record type. When Amazon Route 53 receives a DNS query for a domain name and - // type for which you have created latency resource record sets, Route 53 selects - // the latency resource record set that has the lowest latency between the end user - // and the associated Amazon EC2 Region. Route 53 then returns the value that is - // associated with the selected resource record set. Note the following: - // - // * You can - // only specify one ResourceRecord per latency resource record set. - // - // * You can only - // create one latency resource record set for each Amazon EC2 Region. - // - // * You aren't - // required to create latency resource record sets for all Amazon EC2 Regions. - // Route 53 will choose the region with the best latency from among the regions - // that you create latency resource record sets for. - // - // * You can't create - // non-latency resource record sets that have the same values for the Name and Type - // elements as latency resource record sets. + // Latency-based resource record sets only: The Amazon EC2 Region where you + // created the resource that this resource record set refers to. The resource + // typically is an Amazon Web Services resource, such as an EC2 instance or an ELB + // load balancer, and is referred to by an IP address or a DNS domain name, + // depending on the record type. When Amazon Route 53 receives a DNS query for a + // domain name and type for which you have created latency resource record sets, + // Route 53 selects the latency resource record set that has the lowest latency + // between the end user and the associated Amazon EC2 Region. Route 53 then returns + // the value that is associated with the selected resource record set. Note the + // following: + // - You can only specify one ResourceRecord per latency resource record set. + // - You can only create one latency resource record set for each Amazon EC2 + // Region. + // - You aren't required to create latency resource record sets for all Amazon + // EC2 Regions. Route 53 will choose the region with the best latency from among + // the regions that you create latency resource record sets for. + // - You can't create non-latency resource record sets that have the same values + // for the Name and Type elements as latency resource record sets. Region ResourceRecordSetRegion // Information about the resource records to act upon. If you're creating an alias - // resource record set, omit ResourceRecords. + // resource record set, omit ResourceRecords . ResourceRecords []ResourceRecord - // Resource record sets that have a routing policy other than simple: An identifier - // that differentiates among multiple resource record sets that have the same - // combination of name and type, such as multiple weighted resource record sets - // named acme.example.com that have a type of A. In a group of resource record sets - // that have the same name and type, the value of SetIdentifier must be unique for - // each resource record set. For information about routing policies, see Choosing a - // Routing Policy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) + // Resource record sets that have a routing policy other than simple: An + // identifier that differentiates among multiple resource record sets that have the + // same combination of name and type, such as multiple weighted resource record + // sets named acme.example.com that have a type of A. In a group of resource record + // sets that have the same name and type, the value of SetIdentifier must be + // unique for each resource record set. For information about routing policies, see + // Choosing a Routing Policy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) // in the Amazon Route 53 Developer Guide. SetIdentifier *string // The resource record cache time to live (TTL), in seconds. Note the following: - // - // * - // If you're creating or updating an alias resource record set, omit TTL. Amazon - // Route 53 uses the value of TTL for the alias target. - // - // * If you're associating - // this resource record set with a health check (if you're adding a HealthCheckId - // element), we recommend that you specify a TTL of 60 seconds or less so clients - // respond quickly to changes in health status. - // - // * All of the resource record sets - // in a group of weighted resource record sets must have the same value for TTL. - // - // * - // If a group of weighted resource record sets includes one or more weighted alias - // resource record sets for which the alias target is an ELB load balancer, we - // recommend that you specify a TTL of 60 seconds for all of the non-alias weighted - // resource record sets that have the same name and type. Values other than 60 - // seconds (the TTL for load balancers) will change the effect of the values that - // you specify for Weight. + // - If you're creating or updating an alias resource record set, omit TTL . + // Amazon Route 53 uses the value of TTL for the alias target. + // - If you're associating this resource record set with a health check (if + // you're adding a HealthCheckId element), we recommend that you specify a TTL of + // 60 seconds or less so clients respond quickly to changes in health status. + // - All of the resource record sets in a group of weighted resource record sets + // must have the same value for TTL . + // - If a group of weighted resource record sets includes one or more weighted + // alias resource record sets for which the alias target is an ELB load balancer, + // we recommend that you specify a TTL of 60 seconds for all of the non-alias + // weighted resource record sets that have the same name and type. Values other + // than 60 seconds (the TTL for load balancers) will change the effect of the + // values that you specify for Weight . TTL *int64 - // When you create a traffic policy instance, Amazon Route 53 automatically creates - // a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy - // instance that Route 53 created this resource record set for. To delete the - // resource record set that is associated with a traffic policy instance, use - // DeleteTrafficPolicyInstance. Route 53 will delete the resource record set + // When you create a traffic policy instance, Amazon Route 53 automatically + // creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic + // policy instance that Route 53 created this resource record set for. To delete + // the resource record set that is associated with a traffic policy instance, use + // DeleteTrafficPolicyInstance . Route 53 will delete the resource record set // automatically. If you delete the resource record set by using - // ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic + // ChangeResourceRecordSets , Route 53 doesn't automatically delete the traffic // policy instance, and you'll continue to be charged for it even though it's no // longer in use. TrafficPolicyInstanceId *string @@ -1789,31 +1512,23 @@ type ResourceRecordSet struct { // that have the same combination of DNS name and type. Route 53 then responds to // queries based on the ratio of a resource's weight to the total. Note the // following: - // - // * You must specify a value for the Weight element for every weighted - // resource record set. - // - // * You can only specify one ResourceRecord per weighted - // resource record set. - // - // * You can't create latency, failover, or geolocation - // resource record sets that have the same values for the Name and Type elements as - // weighted resource record sets. - // - // * You can create a maximum of 100 weighted - // resource record sets that have the same values for the Name and Type - // elements. - // - // * For weighted (but not weighted alias) resource record sets, if you - // set Weight to 0 for a resource record set, Route 53 never responds to queries - // with the applicable value for that resource record set. However, if you set - // Weight to 0 for all resource record sets that have the same combination of DNS - // name and type, traffic is routed to all resources with equal probability. The - // effect of setting Weight to 0 is different when you associate health checks with - // weighted resource record sets. For more information, see Options for Configuring - // Route 53 Active-Active and Active-Passive Failover - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) - // in the Amazon Route 53 Developer Guide. + // - You must specify a value for the Weight element for every weighted resource + // record set. + // - You can only specify one ResourceRecord per weighted resource record set. + // - You can't create latency, failover, or geolocation resource record sets + // that have the same values for the Name and Type elements as weighted resource + // record sets. + // - You can create a maximum of 100 weighted resource record sets that have the + // same values for the Name and Type elements. + // - For weighted (but not weighted alias) resource record sets, if you set + // Weight to 0 for a resource record set, Route 53 never responds to queries with + // the applicable value for that resource record set. However, if you set Weight + // to 0 for all resource record sets that have the same combination of DNS name + // and type, traffic is routed to all resources with equal probability. The effect + // of setting Weight to 0 is different when you associate health checks with + // weighted resource record sets. For more information, see Options for + // Configuring Route 53 Active-Active and Active-Passive Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html) + // in the Amazon Route 53 Developer Guide. Weight *int64 noSmithyDocumentSerde @@ -1826,11 +1541,8 @@ type ResourceTagSet struct { ResourceId *string // The type of the resource. - // - // * The resource type for health checks is - // healthcheck. - // - // * The resource type for hosted zones is hostedzone. + // - The resource type for health checks is healthcheck . + // - The resource type for hosted zones is hostedzone . ResourceType TagResourceType // The tags associated with the specified resource. @@ -1839,11 +1551,11 @@ type ResourceTagSet struct { noSmithyDocumentSerde } -// A complex type that contains the type of limit that you specified in the request -// and the current value for that limit. +// A complex type that contains the type of limit that you specified in the +// request and the current value for that limit. type ReusableDelegationSetLimit struct { - // The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum + // The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET , the maximum // number of hosted zones that you can associate with the specified reusable // delegation set. // @@ -1862,10 +1574,10 @@ type ReusableDelegationSetLimit struct { // reports and the time of the health check. type StatusReport struct { - // The date and time that the health checker performed the health check in ISO 8601 - // format (https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time - // (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 - // at 17:48:16.751 UTC. + // The date and time that the health checker performed the health check in ISO + // 8601 format (https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal + // Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March + // 27, 2017 at 17:48:16.751 UTC. CheckedTime *time.Time // A description of the status of the health check endpoint as reported by one of @@ -1880,30 +1592,20 @@ type StatusReport struct { type Tag struct { // The value of Key depends on the operation that you want to perform: - // - // * Add a tag - // to a health check or hosted zone: Key is the name that you want to give the new - // tag. - // - // * Edit a tag: Key is the name of the tag that you want to change the Value - // for. - // - // * Delete a key: Key is the name of the tag you want to remove. - // - // * Give a - // name to a health check: Edit the default Name tag. In the Amazon Route 53 - // console, the list of your health checks includes a Name column that lets you see - // the name that you've given to each health check. + // - Add a tag to a health check or hosted zone: Key is the name that you want to + // give the new tag. + // - Edit a tag: Key is the name of the tag that you want to change the Value + // for. + // - Delete a key: Key is the name of the tag you want to remove. + // - Give a name to a health check: Edit the default Name tag. In the Amazon + // Route 53 console, the list of your health checks includes a Name column that + // lets you see the name that you've given to each health check. Key *string // The value of Value depends on the operation that you want to perform: - // - // * Add a - // tag to a health check or hosted zone: Value is the value that you want to give - // the new tag. - // - // * Edit a tag: Value is the new value that you want to assign the - // tag. + // - Add a tag to a health check or hosted zone: Value is the value that you want + // to give the new tag. + // - Edit a tag: Value is the new value that you want to assign the tag. Value *string noSmithyDocumentSerde @@ -1912,10 +1614,10 @@ type Tag struct { // A complex type that contains settings for a traffic policy. type TrafficPolicy struct { - // The definition of a traffic policy in JSON format. You specify the JSON document - // to use for a new traffic policy in the CreateTrafficPolicy request. For more - // information about the JSON format, see Traffic Policy Document Format - // (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html). + // The definition of a traffic policy in JSON format. You specify the JSON + // document to use for a new traffic policy in the CreateTrafficPolicy request. + // For more information about the JSON format, see Traffic Policy Document Format (https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html) + // . // // This member is required. Document *string @@ -1961,7 +1663,7 @@ type TrafficPolicyInstance struct { // This member is required. Id *string - // If State is Failed, an explanation of the reason for the failure. If State is + // If State is Failed , an explanation of the reason for the failure. If State is // another value, Message is empty. // // This member is required. @@ -1977,22 +1679,22 @@ type TrafficPolicyInstance struct { // The value of State is one of the following values: Applied Amazon Route 53 has // finished creating resource record sets, and changes have propagated to all Route // 53 edge locations. Creating Route 53 is creating the resource record sets. Use - // GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request - // completed successfully. Failed Route 53 wasn't able to create or update the - // resource record sets. When the value of State is Failed, see Message for an - // explanation of what caused the request to fail. + // GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance + // request completed successfully. Failed Route 53 wasn't able to create or update + // the resource record sets. When the value of State is Failed , see Message for + // an explanation of what caused the request to fail. // // This member is required. State *string - // The TTL that Amazon Route 53 assigned to all of the resource record sets that it - // created in the specified hosted zone. + // The TTL that Amazon Route 53 assigned to all of the resource record sets that + // it created in the specified hosted zone. // // This member is required. TTL *int64 - // The ID of the traffic policy that Amazon Route 53 used to create resource record - // sets in the specified hosted zone. + // The ID of the traffic policy that Amazon Route 53 used to create resource + // record sets in the specified hosted zone. // // This member is required. TrafficPolicyId *string @@ -2012,8 +1714,8 @@ type TrafficPolicyInstance struct { noSmithyDocumentSerde } -// A complex type that contains information about the latest version of one traffic -// policy that is associated with the current Amazon Web Services account. +// A complex type that contains information about the latest version of one +// traffic policy that is associated with the current Amazon Web Services account. type TrafficPolicySummary struct { // The ID that Amazon Route 53 assigned to the traffic policy when you created it. @@ -2048,8 +1750,7 @@ type TrafficPolicySummary struct { // (Private hosted zones only) A complex type that contains information about an // Amazon VPC. If you associate a private hosted zone with an Amazon VPC when you -// make a CreateHostedZone -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) +// make a CreateHostedZone (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) // request, the following parameters are also required. type VPC struct { diff --git a/service/route53domains/api_client.go b/service/route53domains/api_client.go index 30c6b6e488f..e5bc1c3a4ae 100644 --- a/service/route53domains/api_client.go +++ b/service/route53domains/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go b/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go index e8d5d4cf8ed..3fbf147dcf5 100644 --- a/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go +++ b/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go @@ -10,22 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Accepts the transfer of a domain from another Amazon Web Services account to the -// currentAmazon Web Services account. You initiate a transfer between Amazon Web -// Services accounts using TransferDomainToAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html). -// If you use the CLI command at accept-domain-transfer-from-another-aws-account -// (https://docs.aws.amazon.com/cli/latest/reference/route53domains/accept-domain-transfer-from-another-aws-account.html), -// use JSON format as input instead of text because otherwise CLI will throw an +// Accepts the transfer of a domain from another Amazon Web Services account to +// the currentAmazon Web Services account. You initiate a transfer between Amazon +// Web Services accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) +// . If you use the CLI command at accept-domain-transfer-from-another-aws-account (https://docs.aws.amazon.com/cli/latest/reference/route53domains/accept-domain-transfer-from-another-aws-account.html) +// , use JSON format as input instead of text because otherwise CLI will throw an // error from domain transfer input that includes single quotes. Use either -// ListOperations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) -// or GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) -// to determine whether the operation succeeded. GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// ListOperations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) +// or GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// to determine whether the operation succeeded. GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // provides additional information, for example, Domain Transfer from Aws Account -// 111122223333 has been cancelled. +// 111122223333 has been cancelled . func (c *Client) AcceptDomainTransferFromAnotherAwsAccount(ctx context.Context, params *AcceptDomainTransferFromAnotherAwsAccountInput, optFns ...func(*Options)) (*AcceptDomainTransferFromAnotherAwsAccountOutput, error) { if params == nil { params = &AcceptDomainTransferFromAnotherAwsAccountInput{} @@ -46,15 +41,13 @@ func (c *Client) AcceptDomainTransferFromAnotherAwsAccount(ctx context.Context, type AcceptDomainTransferFromAnotherAwsAccountInput struct { // The name of the domain that was specified when another Amazon Web Services - // account submitted a TransferDomainToAnotherAwsAccount - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) + // account submitted a TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) // request. // // This member is required. DomainName *string - // The password that was returned by the TransferDomainToAnotherAwsAccount - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) + // The password that was returned by the TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) // request. // // This member is required. @@ -68,8 +61,8 @@ type AcceptDomainTransferFromAnotherAwsAccountInput struct { type AcceptDomainTransferFromAnotherAwsAccountOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_AssociateDelegationSignerToDomain.go b/service/route53domains/api_op_AssociateDelegationSignerToDomain.go index 78fb4dde7bc..7752ef1bdd5 100644 --- a/service/route53domains/api_op_AssociateDelegationSignerToDomain.go +++ b/service/route53domains/api_op_AssociateDelegationSignerToDomain.go @@ -16,8 +16,7 @@ import ( // your DNS records. This action may render your domain name unavailable on the // internet if the steps are completed in the wrong order, or with incorrect // timing. For more information about DNSSEC signing, see Configuring DNSSEC -// signing -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec.html) +// signing (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec.html) // in the Route 53 developer guide. func (c *Client) AssociateDelegationSignerToDomain(ctx context.Context, params *AssociateDelegationSignerToDomainInput, optFns ...func(*Options)) (*AssociateDelegationSignerToDomainOutput, error) { if params == nil { @@ -53,8 +52,8 @@ type AssociateDelegationSignerToDomainInput struct { type AssociateDelegationSignerToDomainOutput struct { // The identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go b/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go index 75a4dd40a1c..3796c6febb1 100644 --- a/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go +++ b/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go @@ -10,21 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels the transfer of a domain from the current Amazon Web Services account to -// another Amazon Web Services account. You initiate a transfer betweenAmazon Web -// Services accounts using TransferDomainToAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html). -// You must cancel the transfer before the other Amazon Web Services account -// accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html). -// Use either ListOperations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) -// or GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) -// to determine whether the operation succeeded. GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// Cancels the transfer of a domain from the current Amazon Web Services account +// to another Amazon Web Services account. You initiate a transfer betweenAmazon +// Web Services accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) +// . You must cancel the transfer before the other Amazon Web Services account +// accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html) +// . Use either ListOperations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) +// or GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// to determine whether the operation succeeded. GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // provides additional information, for example, Domain Transfer from Aws Account -// 111122223333 has been cancelled. +// 111122223333 has been cancelled . func (c *Client) CancelDomainTransferToAnotherAwsAccount(ctx context.Context, params *CancelDomainTransferToAnotherAwsAccountInput, optFns ...func(*Options)) (*CancelDomainTransferToAnotherAwsAccountOutput, error) { if params == nil { params = &CancelDomainTransferToAnotherAwsAccountInput{} diff --git a/service/route53domains/api_op_CheckDomainAvailability.go b/service/route53domains/api_op_CheckDomainAvailability.go index 577cece774a..f334ebad2a7 100644 --- a/service/route53domains/api_op_CheckDomainAvailability.go +++ b/service/route53domains/api_op_CheckDomainAvailability.go @@ -34,29 +34,19 @@ type CheckDomainAvailabilityInput struct { // The name of the domain that you want to get availability for. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of - // supported TLDs, see Domains that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // supported TLDs, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. The domain name can contain only the // following characters: - // - // * Letters a through z. Domain names are not case - // sensitive. - // - // * Numbers 0 through 9. - // - // * Hyphen (-). You can't specify a hyphen at - // the beginning or end of a label. - // - // * Period (.) to separate the labels in the - // name, such as the . in example.com. - // - // Internationalized domain names are not - // supported for some top-level domains. To determine whether the TLD that you want - // to use supports internationalized domain names, see Domains that You Can - // Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html). - // For more information, see Formatting Internationalized Domain Names - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns). + // - Letters a through z. Domain names are not case sensitive. + // - Numbers 0 through 9. + // - Hyphen (-). You can't specify a hyphen at the beginning or end of a label. + // - Period (.) to separate the labels in the name, such as the . in example.com + // . + // Internationalized domain names are not supported for some top-level domains. To + // determine whether the TLD that you want to use supports internationalized domain + // names, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // . For more information, see Formatting Internationalized Domain Names (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns) + // . // // This member is required. DomainName *string @@ -71,7 +61,7 @@ type CheckDomainAvailabilityInput struct { type CheckDomainAvailabilityOutput struct { // Whether the domain name is available for registering. You can register only - // domains designated as AVAILABLE. Valid values: AVAILABLE The domain name is + // domains designated as AVAILABLE . Valid values: AVAILABLE The domain name is // available. AVAILABLE_RESERVED The domain name is reserved under specific // conditions. AVAILABLE_PREORDER The domain name is available and can be // preordered. DONT_KNOW The TLD registry didn't reply with a definitive answer diff --git a/service/route53domains/api_op_CheckDomainTransferability.go b/service/route53domains/api_op_CheckDomainTransferability.go index da37b1d2f36..4bfb7d585f1 100644 --- a/service/route53domains/api_op_CheckDomainTransferability.go +++ b/service/route53domains/api_op_CheckDomainTransferability.go @@ -32,21 +32,14 @@ type CheckDomainTransferabilityInput struct { // The name of the domain that you want to transfer to Route 53. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of - // supported TLDs, see Domains that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // supported TLDs, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. The domain name can contain only the // following characters: - // - // * Letters a through z. Domain names are not case - // sensitive. - // - // * Numbers 0 through 9. - // - // * Hyphen (-). You can't specify a hyphen at - // the beginning or end of a label. - // - // * Period (.) to separate the labels in the - // name, such as the . in example.com. + // - Letters a through z. Domain names are not case sensitive. + // - Numbers 0 through 9. + // - Hyphen (-). You can't specify a hyphen at the beginning or end of a label. + // - Period (.) to separate the labels in the name, such as the . in example.com + // . // // This member is required. DomainName *string diff --git a/service/route53domains/api_op_DeleteDomain.go b/service/route53domains/api_op_DeleteDomain.go index 1b576f84c3a..79e47d92834 100644 --- a/service/route53domains/api_op_DeleteDomain.go +++ b/service/route53domains/api_op_DeleteDomain.go @@ -11,22 +11,19 @@ import ( ) // This operation deletes the specified domain. This action is permanent. For more -// information, see Deleting a domain name registration -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-delete.html). -// To transfer the domain registration to another registrar, use the transfer +// information, see Deleting a domain name registration (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-delete.html) +// . To transfer the domain registration to another registrar, use the transfer // process that’s provided by the registrar to which you want to transfer the // registration. Otherwise, the following apply: // -// * You can’t get a refund for the -// cost of a deleted domain registration. +// - You can’t get a refund for the cost of a deleted domain registration. // -// * The registry for the top-level domain -// might hold the domain name for a brief time before releasing it for other users -// to register (varies by registry). +// - The registry for the top-level domain might hold the domain name for a +// brief time before releasing it for other users to register (varies by registry). // -// * When the registration has been deleted, -// we'll send you a confirmation to the registrant contact. The email will come -// from noreply@domainnameverification.net or noreply@registrar.amazon.com. +// - When the registration has been deleted, we'll send you a confirmation to +// the registrant contact. The email will come from +// noreply@domainnameverification.net or noreply@registrar.amazon.com . func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} @@ -55,8 +52,8 @@ type DeleteDomainInput struct { type DeleteDomainOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_DisableDomainTransferLock.go b/service/route53domains/api_op_DisableDomainTransferLock.go index 9bdbd66016b..7a61a93f4d4 100644 --- a/service/route53domains/api_op_DisableDomainTransferLock.go +++ b/service/route53domains/api_op_DisableDomainTransferLock.go @@ -46,8 +46,8 @@ type DisableDomainTransferLockInput struct { type DisableDomainTransferLockOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go b/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go index 6ebb1ce4835..280513fbfe4 100644 --- a/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go +++ b/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go @@ -34,9 +34,10 @@ type DisassociateDelegationSignerFromDomainInput struct { // This member is required. DomainName *string - // An internal identification number assigned to each DS record after it’s created. - // You can retrieve it as part of DNSSEC information returned by GetDomainDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetDomainDetail.html). + // An internal identification number assigned to each DS record after it’s + // created. You can retrieve it as part of DNSSEC information returned by + // GetDomainDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetDomainDetail.html) + // . // // This member is required. Id *string @@ -47,8 +48,8 @@ type DisassociateDelegationSignerFromDomainInput struct { type DisassociateDelegationSignerFromDomainOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_EnableDomainAutoRenew.go b/service/route53domains/api_op_EnableDomainAutoRenew.go index 34c826d4590..dfc95705098 100644 --- a/service/route53domains/api_op_EnableDomainAutoRenew.go +++ b/service/route53domains/api_op_EnableDomainAutoRenew.go @@ -14,8 +14,7 @@ import ( // domain before the domain registration expires. The cost of renewing your domain // registration is billed to your Amazon Web Services account. The period during // which you can renew a domain name varies by TLD. For a list of TLDs and their -// renewal policies, see Domains That You Can Register with Amazon Route 53 -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) +// renewal policies, see Domains That You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before // the end of the renewal period so we can complete processing before the deadline. func (c *Client) EnableDomainAutoRenew(ctx context.Context, params *EnableDomainAutoRenewInput, optFns ...func(*Options)) (*EnableDomainAutoRenewOutput, error) { diff --git a/service/route53domains/api_op_EnableDomainTransferLock.go b/service/route53domains/api_op_EnableDomainTransferLock.go index b36931d84eb..33b535fe8db 100644 --- a/service/route53domains/api_op_EnableDomainTransferLock.go +++ b/service/route53domains/api_op_EnableDomainTransferLock.go @@ -44,8 +44,8 @@ type EnableDomainTransferLockInput struct { // The EnableDomainTransferLock response includes the following elements. type EnableDomainTransferLockOutput struct { - // Identifier for tracking the progress of the request. To use this ID to query the - // operation status, use GetOperationDetail. + // Identifier for tracking the progress of the request. To use this ID to query + // the operation status, use GetOperationDetail. OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_GetContactReachabilityStatus.go b/service/route53domains/api_op_GetContactReachabilityStatus.go index 3a0e97f1a43..67f24447769 100644 --- a/service/route53domains/api_op_GetContactReachabilityStatus.go +++ b/service/route53domains/api_op_GetContactReachabilityStatus.go @@ -32,8 +32,8 @@ func (c *Client) GetContactReachabilityStatus(ctx context.Context, params *GetCo type GetContactReachabilityStatusInput struct { - // The name of the domain for which you want to know whether the registrant contact - // has confirmed that the email address is valid. + // The name of the domain for which you want to know whether the registrant + // contact has confirmed that the email address is valid. DomainName *string noSmithyDocumentSerde diff --git a/service/route53domains/api_op_GetDomainDetail.go b/service/route53domains/api_op_GetDomainDetail.go index b69184f93de..b0f30e4fffb 100644 --- a/service/route53domains/api_op_GetDomainDetail.go +++ b/service/route53domains/api_op_GetDomainDetail.go @@ -56,9 +56,9 @@ type GetDomainDetailOutput struct { AdminContact *types.ContactDetail // Specifies whether contact information is concealed from WHOIS queries. If the - // value is true, WHOIS ("who is") queries return contact information either for + // value is true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If the value is false, WHOIS queries + // associate, Gandi (for all other TLDs). If the value is false , WHOIS queries // return the information that you entered for the admin contact. AdminPrivacy *bool @@ -89,9 +89,9 @@ type GetDomainDetailOutput struct { RegistrantContact *types.ContactDetail // Specifies whether contact information is concealed from WHOIS queries. If the - // value is true, WHOIS ("who is") queries return contact information either for + // value is true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If the value is false, WHOIS queries + // associate, Gandi (for all other TLDs). If the value is false , WHOIS queries // return the information that you entered for the registrant contact (domain // owner). RegistrantPrivacy *bool @@ -99,7 +99,7 @@ type GetDomainDetailOutput struct { // Name of the registrar of the domain as identified in the registry. Domains with // a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains // are registered by our registrar associate, Gandi. The value for domains that are - // registered by Gandi is "GANDI SAS". + // registered by Gandi is "GANDI SAS" . RegistrarName *string // Web address of the registrar. @@ -108,8 +108,8 @@ type GetDomainDetailOutput struct { // Reserved for future use. RegistryDomainId *string - // Reseller of the domain. Domains registered or transferred using Route 53 domains - // will have "Amazon" as the reseller. + // Reseller of the domain. Domains registered or transferred using Route 53 + // domains will have "Amazon" as the reseller. Reseller *string // An array of domain name status codes, also known as Extensible Provisioning @@ -119,18 +119,18 @@ type GetDomainDetailOutput struct { // registering a domain name, transferring a domain name to another registrar, // renewing the registration for a domain name, and so on. All registrars use this // same set of status codes. For a current list of domain name status codes and an - // explanation of what each code means, go to the ICANN website - // (https://www.icann.org/) and search for epp status codes. (Search on the ICANN - // website; web searches sometimes return an old version of the document.) + // explanation of what each code means, go to the ICANN website (https://www.icann.org/) + // and search for epp status codes . (Search on the ICANN website; web searches + // sometimes return an old version of the document.) StatusList []string // Provides details about the domain technical contact. TechContact *types.ContactDetail // Specifies whether contact information is concealed from WHOIS queries. If the - // value is true, WHOIS ("who is") queries return contact information either for + // value is true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If the value is false, WHOIS queries + // associate, Gandi (for all other TLDs). If the value is false , WHOIS queries // return the information that you entered for the technical contact. TechPrivacy *bool @@ -138,8 +138,8 @@ type GetDomainDetailOutput struct { // The date and time is in Unix time format and Coordinated Universal time (UTC). UpdatedDate *time.Time - // The fully qualified name of the WHOIS server that can answer the WHOIS query for - // the domain. + // The fully qualified name of the WHOIS server that can answer the WHOIS query + // for the domain. WhoIsServer *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_GetDomainSuggestions.go b/service/route53domains/api_op_GetDomainSuggestions.go index 6687992a75e..bbfbf542d23 100644 --- a/service/route53domains/api_op_GetDomainSuggestions.go +++ b/service/route53domains/api_op_GetDomainSuggestions.go @@ -32,41 +32,32 @@ type GetDomainSuggestionsInput struct { // A domain name that you want to use as the basis for a list of possible domain // names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 // supports. For a list of supported TLDs, see Domains that You Can Register with - // Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. The domain name can contain only the // following characters: - // - // * Letters a through z. Domain names are not case - // sensitive. - // - // * Numbers 0 through 9. - // - // * Hyphen (-). You can't specify a hyphen at - // the beginning or end of a label. - // - // * Period (.) to separate the labels in the - // name, such as the . in example.com. - // - // Internationalized domain names are not - // supported for some top-level domains. To determine whether the TLD that you want - // to use supports internationalized domain names, see Domains that You Can - // Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html). + // - Letters a through z. Domain names are not case sensitive. + // - Numbers 0 through 9. + // - Hyphen (-). You can't specify a hyphen at the beginning or end of a label. + // - Period (.) to separate the labels in the name, such as the . in example.com + // . + // Internationalized domain names are not supported for some top-level domains. To + // determine whether the TLD that you want to use supports internationalized domain + // names, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // . // // This member is required. DomainName *string - // If OnlyAvailable is true, Route 53 returns only domain names that are available. - // If OnlyAvailable is false, Route 53 returns domain names without checking - // whether they're available to be registered. To determine whether the domain is - // available, you can call checkDomainAvailability for each suggestion. + // If OnlyAvailable is true , Route 53 returns only domain names that are + // available. If OnlyAvailable is false , Route 53 returns domain names without + // checking whether they're available to be registered. To determine whether the + // domain is available, you can call checkDomainAvailability for each suggestion. // // This member is required. OnlyAvailable *bool - // The number of suggested domain names that you want Route 53 to return. Specify a - // value between 1 and 50. + // The number of suggested domain names that you want Route 53 to return. Specify + // a value between 1 and 50. // // This member is required. SuggestionCount int32 diff --git a/service/route53domains/api_op_GetOperationDetail.go b/service/route53domains/api_op_GetOperationDetail.go index 31bddeccbca..4bb7613508a 100644 --- a/service/route53domains/api_op_GetOperationDetail.go +++ b/service/route53domains/api_op_GetOperationDetail.go @@ -28,8 +28,7 @@ func (c *Client) GetOperationDetail(ctx context.Context, params *GetOperationDet return out, nil } -// The GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// The GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // request includes the following element. type GetOperationDetailInput struct { @@ -62,24 +61,17 @@ type GetOperationDetailOutput struct { // Lists any outstanding operations that require customer action. Valid values // are: - // - // * PENDING_ACCEPTANCE: The operation is waiting for acceptance from the - // account that is receiving the domain. - // - // * PENDING_CUSTOMER_ACTION: The operation - // is waiting for customer action, for example, returning an email. - // - // * - // PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. - // For more information, see ResendOperationAuthorization - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html). - // - // * - // PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to - // validate. - // - // * PENDING_SUPPORT_CASE: The operation includes a support case and is - // waiting for its resolution. + // - PENDING_ACCEPTANCE : The operation is waiting for acceptance from the + // account that is receiving the domain. + // - PENDING_CUSTOMER_ACTION : The operation is waiting for customer action, for + // example, returning an email. + // - PENDING_AUTHORIZATION : The operation is waiting for the form of + // authorization. For more information, see ResendOperationAuthorization (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html) + // . + // - PENDING_PAYMENT_VERIFICATION : The operation is waiting for the payment + // method to validate. + // - PENDING_SUPPORT_CASE : The operation includes a support case and is waiting + // for its resolution. StatusFlag types.StatusFlag // The date when the request was submitted. diff --git a/service/route53domains/api_op_ListDomains.go b/service/route53domains/api_op_ListDomains.go index 5bb7f95f73e..a3ecf9f0183 100644 --- a/service/route53domains/api_op_ListDomains.go +++ b/service/route53domains/api_op_ListDomains.go @@ -39,18 +39,18 @@ type ListDomainsInput struct { // For an initial request for a list of domains, omit this element. If the number // of domains that are associated with the current Amazon Web Services account is - // greater than the value that you specified for MaxItems, you can use Marker to + // greater than the value that you specified for MaxItems , you can use Marker to // return additional domains. Get the value of NextPageMarker from the previous // response, and submit another request that includes the value of NextPageMarker - // in the Marker element. Constraints: The marker must match the value specified in - // the previous request. + // in the Marker element. Constraints: The marker must match the value specified + // in the previous request. Marker *string // Number of domains to be returned. Default: 20 MaxItems *int32 - // A complex type that contains information about the requested ordering of domains - // in the returned list. + // A complex type that contains information about the requested ordering of + // domains in the returned list. SortCondition *types.SortCondition noSmithyDocumentSerde @@ -62,8 +62,9 @@ type ListDomainsOutput struct { // A list of domains. Domains []types.DomainSummary - // If there are more domains than you specified for MaxItems in the request, submit - // another request and include the value of NextPageMarker in the value of Marker. + // If there are more domains than you specified for MaxItems in the request, + // submit another request and include the value of NextPageMarker in the value of + // Marker . NextPageMarker *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_ListOperations.go b/service/route53domains/api_op_ListOperations.go index 3200e01cf21..f341b7cd3bd 100644 --- a/service/route53domains/api_op_ListOperations.go +++ b/service/route53domains/api_op_ListOperations.go @@ -36,9 +36,10 @@ type ListOperationsInput struct { // For an initial request for a list of operations, omit this element. If the // number of operations that are not yet complete is greater than the value that - // you specified for MaxItems, you can use Marker to return additional operations. - // Get the value of NextPageMarker from the previous response, and submit another - // request that includes the value of NextPageMarker in the Marker element. + // you specified for MaxItems , you can use Marker to return additional + // operations. Get the value of NextPageMarker from the previous response, and + // submit another request that includes the value of NextPageMarker in the Marker + // element. Marker *string // Number of domains to be returned. Default: 20 @@ -69,7 +70,7 @@ type ListOperationsOutput struct { // If there are more operations than you specified for MaxItems in the request, // submit another request and include the value of NextPageMarker in the value of - // Marker. + // Marker . NextPageMarker *string // Lists summaries of the operations. diff --git a/service/route53domains/api_op_ListPrices.go b/service/route53domains/api_op_ListPrices.go index 872be5c77ab..216e3d64e35 100644 --- a/service/route53domains/api_op_ListPrices.go +++ b/service/route53domains/api_op_ListPrices.go @@ -12,19 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the following prices for either all the TLDs supported by Route 53, or the -// specified TLD: -// -// * Registration -// -// * Transfer -// -// * Owner change -// -// * Domain renewal -// -// * -// Domain restoration +// Lists the following prices for either all the TLDs supported by Route 53, or +// the specified TLD: +// - Registration +// - Transfer +// - Owner change +// - Domain renewal +// - Domain restoration func (c *Client) ListPrices(ctx context.Context, params *ListPricesInput, optFns ...func(*Options)) (*ListPricesOutput, error) { if params == nil { params = &ListPricesInput{} @@ -42,20 +36,20 @@ func (c *Client) ListPrices(ctx context.Context, params *ListPricesInput, optFns type ListPricesInput struct { - // For an initial request for a list of prices, omit this element. If the number of - // prices that are not yet complete is greater than the value that you specified - // for MaxItems, you can use Marker to return additional prices. Get the value of + // For an initial request for a list of prices, omit this element. If the number + // of prices that are not yet complete is greater than the value that you specified + // for MaxItems , you can use Marker to return additional prices. Get the value of // NextPageMarker from the previous response, and submit another request that // includes the value of NextPageMarker in the Marker element. Used only for all - // TLDs. If you specify a TLD, don't specify a Marker. + // TLDs. If you specify a TLD, don't specify a Marker . Marker *string // Number of Prices to be returned. Used only for all TLDs. If you specify a TLD, - // don't specify a MaxItems. + // don't specify a MaxItems . MaxItems *int32 - // The TLD for which you want to receive the pricing information. For example. - // .net. If a Tld value is not provided, a list of prices for all TLDs supported by + // The TLD for which you want to receive the pricing information. For example. .net + // . If a Tld value is not provided, a list of prices for all TLDs supported by // Route 53 is returned. Tld *string @@ -65,8 +59,8 @@ type ListPricesInput struct { type ListPricesOutput struct { // If there are more prices than you specified for MaxItems in the request, submit - // another request and include the value of NextPageMarker in the value of Marker. - // Used only for all TLDs. If you specify a TLD, don't specify a NextPageMarker. + // another request and include the value of NextPageMarker in the value of Marker . + // Used only for all TLDs. If you specify a TLD, don't specify a NextPageMarker . NextPageMarker *string // A complex type that includes all the pricing information. If you specify a TLD, @@ -149,7 +143,7 @@ var _ ListPricesAPIClient = (*Client)(nil) // ListPricesPaginatorOptions is the paginator options for ListPrices type ListPricesPaginatorOptions struct { // Number of Prices to be returned. Used only for all TLDs. If you specify a TLD, - // don't specify a MaxItems. + // don't specify a MaxItems . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53domains/api_op_PushDomain.go b/service/route53domains/api_op_PushDomain.go index b0124475e8a..7607c191c1d 100644 --- a/service/route53domains/api_op_PushDomain.go +++ b/service/route53domains/api_op_PushDomain.go @@ -12,9 +12,8 @@ import ( // Moves a domain from Amazon Web Services to another registrar. Supported // actions: -// -// * Changes the IPS tags of a .uk domain, and pushes it to transit. -// Transit means that the domain is ready to be transferred to another registrar. +// - Changes the IPS tags of a .uk domain, and pushes it to transit. Transit +// means that the domain is ready to be transferred to another registrar. func (c *Client) PushDomain(ctx context.Context, params *PushDomainInput, optFns ...func(*Options)) (*PushDomainOutput, error) { if params == nil { params = &PushDomainInput{} diff --git a/service/route53domains/api_op_RegisterDomain.go b/service/route53domains/api_op_RegisterDomain.go index 5c94b649989..8ef8c5160a9 100644 --- a/service/route53domains/api_op_RegisterDomain.go +++ b/service/route53domains/api_op_RegisterDomain.go @@ -17,31 +17,28 @@ import ( // requires extra parameters. When you register a domain, Amazon Route 53 does the // following: // -// * Creates a Route 53 hosted zone that has the same name as the -// domain. Route 53 assigns four name servers to your hosted zone and automatically -// updates your domain registration with the names of these name servers. +// - Creates a Route 53 hosted zone that has the same name as the domain. Route +// 53 assigns four name servers to your hosted zone and automatically updates your +// domain registration with the names of these name servers. // -// * -// Enables auto renew, so your domain registration will renew automatically each -// year. We'll notify you in advance of the renewal date so you can choose whether -// to renew the registration. +// - Enables auto renew, so your domain registration will renew automatically +// each year. We'll notify you in advance of the renewal date so you can choose +// whether to renew the registration. // -// * Optionally enables privacy protection, so WHOIS -// queries return contact information either for Amazon Registrar (for .com, .net, -// and .org domains) or for our registrar associate, Gandi (for all other TLDs). If -// you don't enable privacy protection, WHOIS queries return the information that -// you entered for the administrative, registrant, and technical contacts. You must -// specify the same privacy setting for the administrative, registrant, and -// technical contacts. +// - Optionally enables privacy protection, so WHOIS queries return contact +// information either for Amazon Registrar (for .com, .net, and .org domains) or +// for our registrar associate, Gandi (for all other TLDs). If you don't enable +// privacy protection, WHOIS queries return the information that you entered for +// the administrative, registrant, and technical contacts. You must specify the +// same privacy setting for the administrative, registrant, and technical contacts. // -// * If registration is successful, returns an operation ID -// that you can use to track the progress and completion of the action. If the -// request is not completed successfully, the domain registrant is notified by -// email. +// - If registration is successful, returns an operation ID that you can use to +// track the progress and completion of the action. If the request is not completed +// successfully, the domain registrant is notified by email. // -// * Charges your Amazon Web Services account an amount based on the -// top-level domain. For more information, see Amazon Route 53 Pricing -// (http://aws.amazon.com/route53/pricing/). +// - Charges your Amazon Web Services account an amount based on the top-level +// domain. For more information, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) +// . func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput, optFns ...func(*Options)) (*RegisterDomainOutput, error) { if params == nil { params = &RegisterDomainInput{} @@ -60,38 +57,28 @@ func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput // The RegisterDomain request includes the following elements. type RegisterDomainInput struct { - // Provides detailed contact information. For information about the values that you - // specify for each element, see ContactDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). + // Provides detailed contact information. For information about the values that + // you specify for each element, see ContactDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html) + // . // // This member is required. AdminContact *types.ContactDetail // The domain name that you want to register. The top-level domain (TLD), such as // .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see - // Domains that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. The domain name can contain only the // following characters: - // - // * Letters a through z. Domain names are not case - // sensitive. - // - // * Numbers 0 through 9. - // - // * Hyphen (-). You can't specify a hyphen at - // the beginning or end of a label. - // - // * Period (.) to separate the labels in the - // name, such as the . in example.com. - // - // Internationalized domain names are not - // supported for some top-level domains. To determine whether the TLD that you want - // to use supports internationalized domain names, see Domains that You Can - // Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html). - // For more information, see Formatting Internationalized Domain Names - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns). + // - Letters a through z. Domain names are not case sensitive. + // - Numbers 0 through 9. + // - Hyphen (-). You can't specify a hyphen at the beginning or end of a label. + // - Period (.) to separate the labels in the name, such as the . in example.com + // . + // Internationalized domain names are not supported for some top-level domains. To + // determine whether the TLD that you want to use supports internationalized domain + // names, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // . For more information, see Formatting Internationalized Domain Names (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns) + // . // // This member is required. DomainName *string @@ -99,29 +86,28 @@ type RegisterDomainInput struct { // The number of years that you want to register the domain for. Domains are // registered for a minimum of one year. The maximum period depends on the // top-level domain. For the range of valid values for your domain, see Domains - // that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. Default: 1 // // This member is required. DurationInYears *int32 - // Provides detailed contact information. For information about the values that you - // specify for each element, see ContactDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). + // Provides detailed contact information. For information about the values that + // you specify for each element, see ContactDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html) + // . // // This member is required. RegistrantContact *types.ContactDetail - // Provides detailed contact information. For information about the values that you - // specify for each element, see ContactDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html). + // Provides detailed contact information. For information about the values that + // you specify for each element, see ContactDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html) + // . // // This member is required. TechContact *types.ContactDetail - // Indicates whether the domain will be automatically renewed (true) or not - // (false). Auto renewal only takes effect after the account is charged. Default: + // Indicates whether the domain will be automatically renewed ( true ) or not ( + // false ). Auto renewal only takes effect after the account is charged. Default: // true AutoRenew *bool @@ -129,27 +115,27 @@ type RegisterDomainInput struct { IdnLangCode *string // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the admin contact. You must specify // the same privacy setting for the administrative, registrant, and technical // contacts. Default: true PrivacyProtectAdminContact *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the registrant contact (the domain // owner). You must specify the same privacy setting for the administrative, // registrant, and technical contacts. Default: true PrivacyProtectRegistrantContact *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the technical contact. You must // specify the same privacy setting for the administrative, registrant, and // technical contacts. Default: true @@ -162,8 +148,8 @@ type RegisterDomainInput struct { type RegisterDomainOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go b/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go index ecc63af2262..41847b0ac65 100644 --- a/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go +++ b/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go @@ -10,18 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Rejects the transfer of a domain from another Amazon Web Services account to the -// current Amazon Web Services account. You initiate a transfer betweenAmazon Web -// Services accounts using TransferDomainToAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html). -// Use either ListOperations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) -// or GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) -// to determine whether the operation succeeded. GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// Rejects the transfer of a domain from another Amazon Web Services account to +// the current Amazon Web Services account. You initiate a transfer betweenAmazon +// Web Services accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) +// . Use either ListOperations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) +// or GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// to determine whether the operation succeeded. GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // provides additional information, for example, Domain Transfer from Aws Account -// 111122223333 has been cancelled. +// 111122223333 has been cancelled . func (c *Client) RejectDomainTransferFromAnotherAwsAccount(ctx context.Context, params *RejectDomainTransferFromAnotherAwsAccountInput, optFns ...func(*Options)) (*RejectDomainTransferFromAnotherAwsAccountOutput, error) { if params == nil { params = &RejectDomainTransferFromAnotherAwsAccountInput{} @@ -42,8 +38,7 @@ func (c *Client) RejectDomainTransferFromAnotherAwsAccount(ctx context.Context, type RejectDomainTransferFromAnotherAwsAccountInput struct { // The name of the domain that was specified when another Amazon Web Services - // account submitted a TransferDomainToAnotherAwsAccount - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) + // account submitted a TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) // request. // // This member is required. diff --git a/service/route53domains/api_op_RenewDomain.go b/service/route53domains/api_op_RenewDomain.go index e4e30bce574..8fe08023a97 100644 --- a/service/route53domains/api_op_RenewDomain.go +++ b/service/route53domains/api_op_RenewDomain.go @@ -15,9 +15,8 @@ import ( // that you renew your domain several weeks before the expiration date. Some TLD // registries delete domains before the expiration date if you haven't renewed far // enough in advance. For more information about renewing domain registration, see -// Renewing Registration for a Domain -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html) in -// the Amazon Route 53 Developer Guide. +// Renewing Registration for a Domain (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html) +// in the Amazon Route 53 Developer Guide. func (c *Client) RenewDomain(ctx context.Context, params *RenewDomainInput, optFns ...func(*Options)) (*RenewDomainOutput, error) { if params == nil { params = &RenewDomainInput{} @@ -48,10 +47,9 @@ type RenewDomainInput struct { // This member is required. DomainName *string - // The number of years that you want to renew the domain for. The maximum number of - // years depends on the top-level domain. For the range of valid values for your - // domain, see Domains that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // The number of years that you want to renew the domain for. The maximum number + // of years depends on the top-level domain. For the range of valid values for your + // domain, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. Default: 1 DurationInYears *int32 @@ -61,8 +59,8 @@ type RenewDomainInput struct { type RenewDomainOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_TransferDomain.go b/service/route53domains/api_op_TransferDomain.go index 68dd900f84c..1dabd53f1c0 100644 --- a/service/route53domains/api_op_TransferDomain.go +++ b/service/route53domains/api_op_TransferDomain.go @@ -16,37 +16,29 @@ import ( // .net, and .org domains) or with our registrar associate, Gandi (for all other // TLDs). For more information about transferring domains, see the following // topics: +// - For transfer requirements, a detailed procedure, and information about +// viewing the status of a domain that you're transferring to Route 53, see +// Transferring Registration for a Domain to Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html) +// in the Amazon Route 53 Developer Guide. +// - For information about how to transfer a domain from one Amazon Web Services +// account to another, see TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html) +// . +// - For information about how to transfer a domain to another domain registrar, +// see Transferring a Domain from Amazon Route 53 to Another Registrar (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html) +// in the Amazon Route 53 Developer Guide. // -// * For transfer requirements, a detailed procedure, and information -// about viewing the status of a domain that you're transferring to Route 53, see -// Transferring Registration for a Domain to Amazon Route 53 -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html) -// in the Amazon Route 53 Developer Guide. -// -// * For information about how to transfer -// a domain from one Amazon Web Services account to another, see -// TransferDomainToAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html). -// -// * -// For information about how to transfer a domain to another domain registrar, see -// Transferring a Domain from Amazon Route 53 to Another Registrar -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html) -// in the Amazon Route 53 Developer Guide. -// -// If the registrar for your domain is -// also the DNS service provider for the domain, we highly recommend that you -// transfer your DNS service to Route 53 or to another DNS service provider before -// you transfer your registration. Some registrars provide free DNS service when -// you purchase a domain registration. When you transfer the registration, the -// previous registrar will not renew your domain registration and could end your -// DNS service at any time. If the registrar for your domain is also the DNS -// service provider for the domain and you don't transfer DNS service to another -// provider, your website, email, and the web applications associated with the -// domain might become unavailable. If the transfer is successful, this method -// returns an operation ID that you can use to track the progress and completion of -// the action. If the transfer doesn't complete successfully, the domain registrant -// will be notified by email. +// If the registrar for your domain is also the DNS service provider for the +// domain, we highly recommend that you transfer your DNS service to Route 53 or to +// another DNS service provider before you transfer your registration. Some +// registrars provide free DNS service when you purchase a domain registration. +// When you transfer the registration, the previous registrar will not renew your +// domain registration and could end your DNS service at any time. If the registrar +// for your domain is also the DNS service provider for the domain and you don't +// transfer DNS service to another provider, your website, email, and the web +// applications associated with the domain might become unavailable. If the +// transfer is successful, this method returns an operation ID that you can use to +// track the progress and completion of the action. If the transfer doesn't +// complete successfully, the domain registrant will be notified by email. func (c *Client) TransferDomain(ctx context.Context, params *TransferDomainInput, optFns ...func(*Options)) (*TransferDomainOutput, error) { if params == nil { params = &TransferDomainInput{} @@ -72,21 +64,14 @@ type TransferDomainInput struct { // The name of the domain that you want to transfer to Route 53. The top-level // domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of - // supported TLDs, see Domains that You Can Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // supported TLDs, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) // in the Amazon Route 53 Developer Guide. The domain name can contain only the // following characters: - // - // * Letters a through z. Domain names are not case - // sensitive. - // - // * Numbers 0 through 9. - // - // * Hyphen (-). You can't specify a hyphen at - // the beginning or end of a label. - // - // * Period (.) to separate the labels in the - // name, such as the . in example.com. + // - Letters a through z. Domain names are not case sensitive. + // - Numbers 0 through 9. + // - Hyphen (-). You can't specify a hyphen at the beginning or end of a label. + // - Period (.) to separate the labels in the name, such as the . in example.com + // . // // This member is required. DomainName *string @@ -124,27 +109,27 @@ type TransferDomainInput struct { Nameservers []types.Nameserver // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the admin contact. You must specify // the same privacy setting for the administrative, registrant, and technical // contacts. Default: true PrivacyProtectAdminContact *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the registrant contact (domain // owner). You must specify the same privacy setting for the administrative, // registrant, and technical contacts. Default: true PrivacyProtectRegistrantContact *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the technical contact. You must // specify the same privacy setting for the administrative, registrant, and // technical contacts. Default: true @@ -157,8 +142,8 @@ type TransferDomainInput struct { type TransferDomainOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go b/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go index 02fa04abd8e..3b06d4ede6a 100644 --- a/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go +++ b/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go @@ -12,39 +12,28 @@ import ( // Transfers a domain from the current Amazon Web Services account to another // Amazon Web Services account. Note the following: +// - The Amazon Web Services account that you're transferring the domain to must +// accept the transfer. If the other account doesn't accept the transfer within 3 +// days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html) +// . +// - You can cancel the transfer before the other account accepts it. See +// CancelDomainTransferToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html) +// . +// - The other account can reject the transfer. See +// RejectDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html) +// . // -// * The Amazon Web Services -// account that you're transferring the domain to must accept the transfer. If the -// other account doesn't accept the transfer within 3 days, we cancel the transfer. -// See AcceptDomainTransferFromAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html). -// -// * -// You can cancel the transfer before the other account accepts it. See -// CancelDomainTransferToAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html). -// -// * -// The other account can reject the transfer. See -// RejectDomainTransferFromAnotherAwsAccount -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html). -// -// When -// you transfer a domain from one Amazon Web Services account to another, Route 53 -// doesn't transfer the hosted zone that is associated with the domain. DNS -// resolution isn't affected if the domain and the hosted zone are owned by +// When you transfer a domain from one Amazon Web Services account to another, +// Route 53 doesn't transfer the hosted zone that is associated with the domain. +// DNS resolution isn't affected if the domain and the hosted zone are owned by // separate accounts, so transferring the hosted zone is optional. For information // about transferring the hosted zone to another Amazon Web Services account, see -// Migrating a Hosted Zone to a Different Amazon Web Services Account -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html) -// in the Amazon Route 53 Developer Guide. Use either ListOperations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) -// or GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) -// to determine whether the operation succeeded. GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// Migrating a Hosted Zone to a Different Amazon Web Services Account (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html) +// in the Amazon Route 53 Developer Guide. Use either ListOperations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) +// or GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// to determine whether the operation succeeded. GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // provides additional information, for example, Domain Transfer from Aws Account -// 111122223333 has been cancelled. +// 111122223333 has been cancelled . func (c *Client) TransferDomainToAnotherAwsAccount(ctx context.Context, params *TransferDomainToAnotherAwsAccountInput, optFns ...func(*Options)) (*TransferDomainToAnotherAwsAccountOutput, error) { if params == nil { params = &TransferDomainToAnotherAwsAccountInput{} @@ -64,7 +53,7 @@ func (c *Client) TransferDomainToAnotherAwsAccount(ctx context.Context, params * type TransferDomainToAnotherAwsAccountInput struct { // The account ID of the Amazon Web Services account that you want to transfer the - // domain to, for example, 111122223333. + // domain to, for example, 111122223333 . // // This member is required. AccountId *string @@ -82,14 +71,13 @@ type TransferDomainToAnotherAwsAccountInput struct { type TransferDomainToAnotherAwsAccountOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // To finish transferring a domain to another Amazon Web Services account, the // account that the domain is being transferred to must submit an - // AcceptDomainTransferFromAnotherAwsAccount - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html) + // AcceptDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html) // request. The request must include the value of the Password element that was // returned in the TransferDomainToAnotherAwsAccount response. Password *string diff --git a/service/route53domains/api_op_UpdateDomainContact.go b/service/route53domains/api_op_UpdateDomainContact.go index d233b3a9b38..1afea27c3b6 100644 --- a/service/route53domains/api_op_UpdateDomainContact.go +++ b/service/route53domains/api_op_UpdateDomainContact.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation updates the contact information for a particular domain. You must -// specify information for at least one contact: registrant, administrator, or +// This operation updates the contact information for a particular domain. You +// must specify information for at least one contact: registrant, administrator, or // technical. If the update is successful, this method returns an operation ID that // you can use to track the progress and completion of the operation. If the // request is not completed successfully, the domain registrant will be notified by @@ -59,8 +59,8 @@ type UpdateDomainContactInput struct { type UpdateDomainContactOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_UpdateDomainContactPrivacy.go b/service/route53domains/api_op_UpdateDomainContactPrivacy.go index e6909e9d9fe..04bdddeb3fa 100644 --- a/service/route53domains/api_op_UpdateDomainContactPrivacy.go +++ b/service/route53domains/api_op_UpdateDomainContactPrivacy.go @@ -18,8 +18,7 @@ import ( // registrant, and technical contacts. This operation affects only the contact // information for the specified contact type (administrative, registrant, or // technical). If the request succeeds, Amazon Route 53 returns an operation ID -// that you can use with GetOperationDetail -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) +// that you can use with GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) // to track the progress and completion of the action. If the request doesn't // complete successfully, the domain registrant will be notified by email. By // disabling the privacy service via API, you consent to the publication of the @@ -29,8 +28,8 @@ import ( // privacy protection using either UpdateDomainContactPrivacy or the Route 53 // console. Enabling privacy protection removes the contact information provided // for this domain from the WHOIS database. For more information on our privacy -// practices, see https://aws.amazon.com/privacy/ -// (https://aws.amazon.com/privacy/). +// practices, see https://aws.amazon.com/privacy/ (https://aws.amazon.com/privacy/) +// . func (c *Client) UpdateDomainContactPrivacy(ctx context.Context, params *UpdateDomainContactPrivacyInput, optFns ...func(*Options)) (*UpdateDomainContactPrivacyOutput, error) { if params == nil { params = &UpdateDomainContactPrivacyInput{} @@ -55,27 +54,27 @@ type UpdateDomainContactPrivacyInput struct { DomainName *string // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the admin contact. You must specify // the same privacy setting for the administrative, registrant, and technical // contacts. AdminPrivacy *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the registrant contact (domain // owner). You must specify the same privacy setting for the administrative, // registrant, and technical contacts. RegistrantPrivacy *bool // Whether you want to conceal contact information from WHOIS queries. If you - // specify true, WHOIS ("who is") queries return contact information either for + // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar (for .com, .net, and .org domains) or for our registrar - // associate, Gandi (for all other TLDs). If you specify false, WHOIS queries + // associate, Gandi (for all other TLDs). If you specify false , WHOIS queries // return the information that you entered for the technical contact. You must // specify the same privacy setting for the administrative, registrant, and // technical contacts. @@ -87,8 +86,8 @@ type UpdateDomainContactPrivacyInput struct { // The UpdateDomainContactPrivacy response includes the following element. type UpdateDomainContactPrivacyOutput struct { - // Identifier for tracking the progress of the request. To use this ID to query the - // operation status, use GetOperationDetail. + // Identifier for tracking the progress of the request. To use this ID to query + // the operation status, use GetOperationDetail. OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_UpdateDomainNameservers.go b/service/route53domains/api_op_UpdateDomainNameservers.go index d389b123714..d830ebefc4b 100644 --- a/service/route53domains/api_op_UpdateDomainNameservers.go +++ b/service/route53domains/api_op_UpdateDomainNameservers.go @@ -62,8 +62,8 @@ type UpdateDomainNameserversInput struct { type UpdateDomainNameserversOutput struct { // Identifier for tracking the progress of the request. To query the operation - // status, use GetOperationDetail - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html). + // status, use GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_UpdateTagsForDomain.go b/service/route53domains/api_op_UpdateTagsForDomain.go index 9a071d235af..85c0035937e 100644 --- a/service/route53domains/api_op_UpdateTagsForDomain.go +++ b/service/route53domains/api_op_UpdateTagsForDomain.go @@ -37,8 +37,8 @@ type UpdateTagsForDomainInput struct { // This member is required. DomainName *string - // A list of the tag keys and values that you want to add or update. If you specify - // a key that already exists, the corresponding value will be replaced. + // A list of the tag keys and values that you want to add or update. If you + // specify a key that already exists, the corresponding value will be replaced. TagsToUpdate []types.Tag noSmithyDocumentSerde diff --git a/service/route53domains/api_op_ViewBilling.go b/service/route53domains/api_op_ViewBilling.go index 15ef7f11b10..20f6064f4d0 100644 --- a/service/route53domains/api_op_ViewBilling.go +++ b/service/route53domains/api_op_ViewBilling.go @@ -41,11 +41,11 @@ type ViewBillingInput struct { // For an initial request for a list of billing records, omit this element. If the // number of billing records that are associated with the current Amazon Web // Services account during the specified period is greater than the value that you - // specified for MaxItems, you can use Marker to return additional billing records. - // Get the value of NextPageMarker from the previous response, and submit another - // request that includes the value of NextPageMarker in the Marker element. - // Constraints: The marker must match the value of NextPageMarker that was returned - // in the previous response. + // specified for MaxItems , you can use Marker to return additional billing + // records. Get the value of NextPageMarker from the previous response, and submit + // another request that includes the value of NextPageMarker in the Marker + // element. Constraints: The marker must match the value of NextPageMarker that + // was returned in the previous response. Marker *string // The number of billing records to be returned. Default: 20 @@ -67,7 +67,7 @@ type ViewBillingOutput struct { // If there are more billing records than you specified for MaxItems in the // request, submit another request and include the value of NextPageMarker in the - // value of Marker. + // value of Marker . NextPageMarker *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/types/enums.go b/service/route53domains/types/enums.go index 43be3d590ca..f02c31efaee 100644 --- a/service/route53domains/types/enums.go +++ b/service/route53domains/types/enums.go @@ -656,9 +656,9 @@ const ( ListDomainsAttributeNameExpiry ListDomainsAttributeName = "Expiry" ) -// Values returns all known values for ListDomainsAttributeName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListDomainsAttributeName. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ListDomainsAttributeName) Values() []ListDomainsAttributeName { return []ListDomainsAttributeName{ "DomainName", @@ -805,9 +805,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", @@ -851,9 +851,9 @@ const ( TransferablePremiumDomain Transferable = "PREMIUM_DOMAIN" ) -// Values returns all known values for Transferable. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for Transferable. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (Transferable) Values() []Transferable { return []Transferable{ "TRANSFERABLE", diff --git a/service/route53domains/types/errors.go b/service/route53domains/types/errors.go index ad1d3dc413e..a09543d13c9 100644 --- a/service/route53domains/types/errors.go +++ b/service/route53domains/types/errors.go @@ -87,10 +87,10 @@ func (e *DuplicateRequest) ErrorCode() string { } func (e *DuplicateRequest) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested item is not acceptable. For example, for APIs that accept a domain -// name, the request might specify a domain name that doesn't belong to the account -// that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the -// password might be invalid. +// The requested item is not acceptable. For example, for APIs that accept a +// domain name, the request might specify a domain name that doesn't belong to the +// account that submitted the request. For +// AcceptDomainTransferFromAnotherAwsAccount , the password might be invalid. type InvalidInput struct { Message *string diff --git a/service/route53domains/types/types.go b/service/route53domains/types/types.go index 2a7023c9301..d256429a28e 100644 --- a/service/route53domains/types/types.go +++ b/service/route53domains/types/types.go @@ -16,8 +16,7 @@ type BillingRecord struct { // The name of the domain that the billing record applies to. If the domain name // contains characters other than a-z, 0-9, and - (hyphen), such as an // internationalized domain name, then this value is in Punycode. For more - // information, see DNS Domain Name Format - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) + // information, see DNS Domain Name Format (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) // in the Amazon Route 53 Developer Guide. DomainName *string @@ -27,8 +26,8 @@ type BillingRecord struct { // The operation that you were charged for. Operation OperationType - // The price that you were charged for the operation, in US dollars. Example value: - // 12.0 + // The price that you were charged for the operation, in US dollars. Example + // value: 12.0 Price float64 noSmithyDocumentSerde @@ -37,7 +36,7 @@ type BillingRecord struct { // Customer's consent for the owner change request. type Consent struct { - // Currency for the MaxPrice. + // Currency for the MaxPrice . // // This member is required. Currency *string @@ -64,19 +63,14 @@ type ContactDetail struct { // Indicates whether the contact is a person, company, association, or public // organization. Note the following: - // - // * If you specify a value other than PERSON, - // you must also specify a value for OrganizationName. - // - // * For some TLDs, the - // privacy protection available depends on the value that you specify for Contact - // Type. For the privacy protection settings for your TLD, see Domains that You Can - // Register with Amazon Route 53 - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) - // in the Amazon Route 53 Developer Guide - // - // * For .es domains, the value of - // ContactType must be PERSON for all three contacts. + // - If you specify a value other than PERSON , you must also specify a value for + // OrganizationName . + // - For some TLDs, the privacy protection available depends on the value that + // you specify for Contact Type . For the privacy protection settings for your + // TLD, see Domains that You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) + // in the Amazon Route 53 Developer Guide + // - For .es domains, the value of ContactType must be PERSON for all three + // contacts. ContactType ContactType // Code for the country of the contact's address. @@ -90,7 +84,7 @@ type ContactDetail struct { // Fax number of the contact. Constraints: Phone number must be specified in the // format "+[country dialing code].[number including any area code]". For example, - // a US phone number might appear as "+1.1234567890". + // a US phone number might appear as "+1.1234567890" . Fax *string // First name of contact. @@ -99,12 +93,12 @@ type ContactDetail struct { // Last name of contact. LastName *string - // Name of the organization for contact types other than PERSON. + // Name of the organization for contact types other than PERSON . OrganizationName *string // The phone number of the contact. Constraints: Phone number must be specified in // the format "+[country dialing code].[number including any area code>]". For - // example, a US phone number might appear as "+1.1234567890". + // example, a US phone number might appear as "+1.1234567890" . PhoneNumber *string // The state or province of the contact's city. @@ -117,17 +111,15 @@ type ContactDetail struct { } // Information about the DNSSEC key. You get this from your DNS provider and then -// give it to Route 53 (by using AssociateDelegationSignerToDomain -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html)) -// to pass it to the registry to establish the chain of trust. +// give it to Route 53 (by using AssociateDelegationSignerToDomain (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html) +// ) to pass it to the registry to establish the chain of trust. type DnssecKey struct { - // The number of the public key’s cryptographic algorithm according to an IANA - // (https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xml) + // The number of the public key’s cryptographic algorithm according to an IANA (https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xml) // assignment. If Route 53 is your DNS service, set this to 13. For more // information about enabling DNSSEC signing, see Enabling DNSSEC signing and - // establishing a chain of trust - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec-enable-signing.html). + // establishing a chain of trust (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec-enable-signing.html) + // . Algorithm *int32 // The delegation signer digest. Digest is calculated from the public key provided @@ -136,9 +128,8 @@ type DnssecKey struct { Digest *string // The number of the DS digest algorithm according to an IANA assignment. For more - // information, see IANA - // (https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml) for DNSSEC - // Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms. + // information, see IANA (https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml) + // for DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms. DigestType *int32 // Defines the type of key. It can be either a KSK (key-signing-key, value 257) or @@ -148,8 +139,8 @@ type DnssecKey struct { // record. If you have ZSK keys only – use ZSK to create a DS record. Flags *int32 - // An ID assigned to each DS record created by AssociateDelegationSignerToDomain - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html). + // An ID assigned to each DS record created by AssociateDelegationSignerToDomain (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html) + // . Id *string // A numeric identification of the DNSKEY record referred to by this DS record. @@ -163,8 +154,8 @@ type DnssecKey struct { } // Information about a delegation signer (DS) record that was created in the -// registry by AssociateDelegationSignerToDomain -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html). +// registry by AssociateDelegationSignerToDomain (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html) +// . type DnssecSigningAttributes struct { // Algorithm which was used to generate the digest from the public key. @@ -212,7 +203,7 @@ type DomainPrice struct { type DomainSuggestion struct { // Whether the domain name is available for registering. You can register only the - // domains that are designated as AVAILABLE. Valid values: AVAILABLE The domain + // domains that are designated as AVAILABLE . Valid values: AVAILABLE The domain // name is available. AVAILABLE_RESERVED The domain name is reserved under specific // conditions. AVAILABLE_PREORDER The domain name is available and can be // preordered. DONT_KNOW The TLD registry didn't reply with a definitive answer @@ -241,8 +232,8 @@ type DomainSummary struct { // The name of the domain that the summary information applies to. DomainName *string - // Expiration date of the domain in Unix time format and Coordinated Universal Time - // (UTC). + // Expiration date of the domain in Unix time format and Coordinated Universal + // Time (UTC). Expiry *time.Time // Indicates whether a domain is locked from unauthorized transfer to another @@ -257,7 +248,7 @@ type DomainSummary struct { type DomainTransferability struct { // Whether the domain name can be transferred to Route 53. You can transfer only - // domains that have a value of TRANSFERABLE or Transferable. Valid values: + // domains that have a value of TRANSFERABLE or Transferable . Valid values: // TRANSFERABLE The domain name can be transferred to Route 53. UNTRANSFERRABLE The // domain name can't be transferred to Route 53. DONT_KNOW Reserved for future use. // DOMAIN_IN_OWN_ACCOUNT The domain already exists in the current Amazon Web @@ -271,433 +262,191 @@ type DomainTransferability struct { // ExtraParam includes the following elements. type ExtraParam struct { - // The name of an additional parameter that is required by a top-level domain. Here - // are the top-level domains that require additional parameters and the names of - // the parameters that they require: .com.au and .net.au - // - // * AU_ID_NUMBER - // - // * - // AU_ID_TYPE Valid values include the following: - // - // * ABN (Australian business - // number) - // - // * ACN (Australian company number) - // - // * TM (Trademark number) - // + // The name of an additional parameter that is required by a top-level domain. + // Here are the top-level domains that require additional parameters and the names + // of the parameters that they require: .com.au and .net.au + // - AU_ID_NUMBER + // - AU_ID_TYPE Valid values include the following: + // - ABN (Australian business number) + // - ACN (Australian company number) + // - TM (Trademark number) // .ca - // - // * - // BRAND_NUMBER - // - // * CA_BUSINESS_ENTITY_TYPE Valid values include the following: - // - // * - // BANK (Bank) - // - // * COMMERCIAL_COMPANY (Commercial company) - // - // * COMPANY (Company) - // - // * - // COOPERATION (Cooperation) - // - // * COOPERATIVE (Cooperative) - // - // * COOPRIX (Cooprix) - // - // * - // CORP (Corporation) - // - // * CREDIT_UNION (Credit union) - // - // * FOMIA (Federation of mutual - // insurance associations) - // - // * INC (Incorporated) - // - // * LTD (Limited) - // - // * LTEE - // (Limitée) - // - // * LLC (Limited liability corporation) - // - // * LLP (Limited liability - // partnership) - // - // * LTE (Lte.) - // - // * MBA (Mutual benefit association) - // - // * MIC (Mutual - // insurance company) - // - // * NFP (Not-for-profit corporation) - // - // * SA (S.A.) - // - // * - // SAVINGS_COMPANY (Savings company) - // - // * SAVINGS_UNION (Savings union) - // - // * SARL - // (Société à responsabilité limitée) - // - // * TRUST (Trust) - // - // * ULC (Unlimited liability - // corporation) - // - // * CA_LEGAL_TYPE When ContactType is PERSON, valid values include - // the following: - // - // * ABO (Aboriginal Peoples indigenous to Canada) - // - // * CCT (Canadian - // citizen) - // - // * LGR (Legal Representative of a Canadian Citizen or Permanent - // Resident) - // - // * RES (Permanent resident of Canada) - // - // When ContactType is a value - // other than PERSON, valid values include the following: - // - // * ASS (Canadian - // unincorporated association) - // - // * CCO (Canadian corporation) - // - // * EDU (Canadian - // educational institution) - // - // * GOV (Government or government entity in Canada) - // - // * - // HOP (Canadian Hospital) - // - // * INB (Indian Band recognized by the Indian Act of - // Canada) - // - // * LAM (Canadian Library, Archive, or Museum) - // - // * MAJ (Her/His Majesty - // the Queen/King) - // - // * OMK (Official mark registered in Canada) - // - // * PLT (Canadian - // Political Party) - // - // * PRT (Partnership Registered in Canada) - // - // * TDM (Trademark - // registered in Canada) - // - // * TRD (Canadian Trade Union) - // - // * TRS (Trust established in - // Canada) - // + // - BRAND_NUMBER + // - CA_BUSINESS_ENTITY_TYPE Valid values include the following: + // - BANK (Bank) + // - COMMERCIAL_COMPANY (Commercial company) + // - COMPANY (Company) + // - COOPERATION (Cooperation) + // - COOPERATIVE (Cooperative) + // - COOPRIX (Cooprix) + // - CORP (Corporation) + // - CREDIT_UNION (Credit union) + // - FOMIA (Federation of mutual insurance associations) + // - INC (Incorporated) + // - LTD (Limited) + // - LTEE (Limitée) + // - LLC (Limited liability corporation) + // - LLP (Limited liability partnership) + // - LTE (Lte.) + // - MBA (Mutual benefit association) + // - MIC (Mutual insurance company) + // - NFP (Not-for-profit corporation) + // - SA (S.A.) + // - SAVINGS_COMPANY (Savings company) + // - SAVINGS_UNION (Savings union) + // - SARL (Société à responsabilité limitée) + // - TRUST (Trust) + // - ULC (Unlimited liability corporation) + // - CA_LEGAL_TYPE When ContactType is PERSON , valid values include the + // following: + // - ABO (Aboriginal Peoples indigenous to Canada) + // - CCT (Canadian citizen) + // - LGR (Legal Representative of a Canadian Citizen or Permanent Resident) + // - RES (Permanent resident of Canada) When ContactType is a value other than + // PERSON , valid values include the following: + // - ASS (Canadian unincorporated association) + // - CCO (Canadian corporation) + // - EDU (Canadian educational institution) + // - GOV (Government or government entity in Canada) + // - HOP (Canadian Hospital) + // - INB (Indian Band recognized by the Indian Act of Canada) + // - LAM (Canadian Library, Archive, or Museum) + // - MAJ (Her/His Majesty the Queen/King) + // - OMK (Official mark registered in Canada) + // - PLT (Canadian Political Party) + // - PRT (Partnership Registered in Canada) + // - TDM (Trademark registered in Canada) + // - TRD (Canadian Trade Union) + // - TRS (Trust established in Canada) // .es - // - // * ES_IDENTIFICATION The value of ES_IDENTIFICATION depends on the - // following values: - // - // * The value of ES_LEGAL_FORM - // - // * The value of - // ES_IDENTIFICATION_TYPE - // - // If ES_LEGAL_FORM is any value other than INDIVIDUAL: - // - // * - // Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal]) - // - // * - // Example: B12345678 - // - // If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify - // for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE: - // - // * If - // ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts): - // - // * Specify 8 - // numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de - // Identificación Fiscal]) - // - // * Example: 12345678M - // - // * If ES_IDENTIFICATION_TYPE is - // NIE (for foreigners with legal residence): - // - // * Specify 1 letter + 7 numbers + 1 - // letter ( NIE [Número de Identidad de Extranjero]) - // - // * Example: Y1234567X - // - // * If - // ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain): - // - // * Specify a - // passport number, drivers license number, or national identity card number - // - // * - // ES_IDENTIFICATION_TYPE Valid values include the following: - // - // * DNI_AND_NIF (For - // Spanish contacts) - // - // * NIE (For foreigners with legal residence) - // - // * OTHER (For - // contacts outside of Spain) - // - // * ES_LEGAL_FORM Valid values include the - // following: - // - // * ASSOCIATION - // - // * CENTRAL_GOVERNMENT_BODY - // - // * CIVIL_SOCIETY - // - // * - // COMMUNITY_OF_OWNERS - // - // * COMMUNITY_PROPERTY - // - // * CONSULATE - // - // * COOPERATIVE - // - // * - // DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL - // - // * ECONOMIC_INTEREST_GROUP - // - // * - // EMBASSY - // - // * ENTITY_MANAGING_NATURAL_AREAS - // - // * FARM_PARTNERSHIP - // - // * FOUNDATION - // - // * - // GENERAL_AND_LIMITED_PARTNERSHIP - // - // * GENERAL_PARTNERSHIP - // - // * INDIVIDUAL - // - // * - // LIMITED_COMPANY - // - // * LOCAL_AUTHORITY - // - // * LOCAL_PUBLIC_ENTITY - // - // * - // MUTUAL_INSURANCE_COMPANY - // - // * NATIONAL_PUBLIC_ENTITY - // - // * - // ORDER_OR_RELIGIOUS_INSTITUTION - // - // * OTHERS (Only for contacts outside of Spain) - // - // * - // POLITICAL_PARTY - // - // * PROFESSIONAL_ASSOCIATION - // - // * PUBLIC_LAW_ASSOCIATION - // - // * - // PUBLIC_LIMITED_COMPANY - // - // * REGIONAL_GOVERNMENT_BODY - // - // * REGIONAL_PUBLIC_ENTITY - // - // * - // SAVINGS_BANK - // - // * SPANISH_OFFICE - // - // * SPORTS_ASSOCIATION - // - // * SPORTS_FEDERATION - // - // * - // SPORTS_LIMITED_COMPANY - // - // * TEMPORARY_ALLIANCE_OF_ENTERPRISES - // - // * TRADE_UNION - // - // * - // WORKER_OWNED_COMPANY - // - // * WORKER_OWNED_LIMITED_COMPANY - // + // - ES_IDENTIFICATION The value of ES_IDENTIFICATION depends on the following + // values: + // - The value of ES_LEGAL_FORM + // - The value of ES_IDENTIFICATION_TYPE If ES_LEGAL_FORM is any value other than + // INDIVIDUAL : + // - Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal]) + // - Example: B12345678 If ES_LEGAL_FORM is INDIVIDUAL , the value that you + // specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE : + // - If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts): + // - Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF + // [Número de Identificación Fiscal]) + // - Example: 12345678M + // - If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence): + // - Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de + // Extranjero]) + // - Example: Y1234567X + // - If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain): + // - Specify a passport number, drivers license number, or national identity + // card number + // - ES_IDENTIFICATION_TYPE Valid values include the following: + // - DNI_AND_NIF (For Spanish contacts) + // - NIE (For foreigners with legal residence) + // - OTHER (For contacts outside of Spain) + // - ES_LEGAL_FORM Valid values include the following: + // - ASSOCIATION + // - CENTRAL_GOVERNMENT_BODY + // - CIVIL_SOCIETY + // - COMMUNITY_OF_OWNERS + // - COMMUNITY_PROPERTY + // - CONSULATE + // - COOPERATIVE + // - DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL + // - ECONOMIC_INTEREST_GROUP + // - EMBASSY + // - ENTITY_MANAGING_NATURAL_AREAS + // - FARM_PARTNERSHIP + // - FOUNDATION + // - GENERAL_AND_LIMITED_PARTNERSHIP + // - GENERAL_PARTNERSHIP + // - INDIVIDUAL + // - LIMITED_COMPANY + // - LOCAL_AUTHORITY + // - LOCAL_PUBLIC_ENTITY + // - MUTUAL_INSURANCE_COMPANY + // - NATIONAL_PUBLIC_ENTITY + // - ORDER_OR_RELIGIOUS_INSTITUTION + // - OTHERS (Only for contacts outside of Spain) + // - POLITICAL_PARTY + // - PROFESSIONAL_ASSOCIATION + // - PUBLIC_LAW_ASSOCIATION + // - PUBLIC_LIMITED_COMPANY + // - REGIONAL_GOVERNMENT_BODY + // - REGIONAL_PUBLIC_ENTITY + // - SAVINGS_BANK + // - SPANISH_OFFICE + // - SPORTS_ASSOCIATION + // - SPORTS_FEDERATION + // - SPORTS_LIMITED_COMPANY + // - TEMPORARY_ALLIANCE_OF_ENTERPRISES + // - TRADE_UNION + // - WORKER_OWNED_COMPANY + // - WORKER_OWNED_LIMITED_COMPANY // .eu - // - // * - // EU_COUNTRY_OF_CITIZENSHIP - // + // - EU_COUNTRY_OF_CITIZENSHIP // .fi - // - // * BIRTH_DATE_IN_YYYY_MM_DD - // - // * - // FI_BUSINESS_NUMBER - // - // * FI_ID_NUMBER - // - // * FI_NATIONALITY Valid values include the - // following: - // - // * FINNISH - // - // * NOT_FINNISH - // - // * FI_ORGANIZATION_TYPE Valid values - // include the following: - // - // * COMPANY - // - // * CORPORATION - // - // * GOVERNMENT - // - // * INSTITUTION - // - // * - // POLITICAL_PARTY - // - // * PUBLIC_COMMUNITY - // - // * TOWNSHIP - // + // - BIRTH_DATE_IN_YYYY_MM_DD + // - FI_BUSINESS_NUMBER + // - FI_ID_NUMBER + // - FI_NATIONALITY Valid values include the following: + // - FINNISH + // - NOT_FINNISH + // - FI_ORGANIZATION_TYPE Valid values include the following: + // - COMPANY + // - CORPORATION + // - GOVERNMENT + // - INSTITUTION + // - POLITICAL_PARTY + // - PUBLIC_COMMUNITY + // - TOWNSHIP // .fr - // - // * BIRTH_CITY - // - // * - // BIRTH_COUNTRY - // - // * BIRTH_DATE_IN_YYYY_MM_DD - // - // * BIRTH_DEPARTMENT: Specify the INSEE - // code that corresponds with the department where the contact was born. If the - // contact was born somewhere other than France or its overseas departments, - // specify 99. For more information, including a list of departments and the - // corresponding INSEE numbers, see the Wikipedia entry Departments of France - // (https://en.wikipedia.org/wiki/Departments_of_France). - // - // * BRAND_NUMBER - // + // - BIRTH_CITY + // - BIRTH_COUNTRY + // - BIRTH_DATE_IN_YYYY_MM_DD + // - BIRTH_DEPARTMENT : Specify the INSEE code that corresponds with the + // department where the contact was born. If the contact was born somewhere other + // than France or its overseas departments, specify 99 . For more information, + // including a list of departments and the corresponding INSEE numbers, see the + // Wikipedia entry Departments of France (https://en.wikipedia.org/wiki/Departments_of_France) + // . + // - BRAND_NUMBER // .it - // - // * - // IT_NATIONALITY - // - // * IT_PIN - // - // * IT_REGISTRANT_ENTITY_TYPE Valid values include the - // following: - // - // * FOREIGNERS - // - // * FREELANCE_WORKERS (Freelance workers and - // professionals) - // - // * ITALIAN_COMPANIES (Italian companies and one-person - // companies) - // - // * NON_PROFIT_ORGANIZATIONS - // - // * OTHER_SUBJECTS - // - // * - // PUBLIC_ORGANIZATIONS - // + // - IT_NATIONALITY + // - IT_PIN + // - IT_REGISTRANT_ENTITY_TYPE Valid values include the following: + // - FOREIGNERS + // - FREELANCE_WORKERS (Freelance workers and professionals) + // - ITALIAN_COMPANIES (Italian companies and one-person companies) + // - NON_PROFIT_ORGANIZATIONS + // - OTHER_SUBJECTS + // - PUBLIC_ORGANIZATIONS // .ru - // - // * BIRTH_DATE_IN_YYYY_MM_DD - // - // * - // RU_PASSPORT_DATA - // + // - BIRTH_DATE_IN_YYYY_MM_DD + // - RU_PASSPORT_DATA // .se - // - // * BIRTH_COUNTRY - // - // * SE_ID_NUMBER - // + // - BIRTH_COUNTRY + // - SE_ID_NUMBER // .sg - // - // * - // SG_ID_NUMBER - // + // - SG_ID_NUMBER // .uk, .co.uk, .me.uk, and .org.uk - // - // * UK_CONTACT_TYPE Valid values - // include the following: - // - // * CRC (UK Corporation by Royal Charter) - // - // * FCORP (Non-UK - // Corporation) - // - // * FIND (Non-UK Individual, representing self) - // - // * FOTHER (Non-UK - // Entity that does not fit into any other category) - // - // * GOV (UK Government Body) - // - // * - // IND (UK Individual (representing self)) - // - // * IP (UK Industrial/Provident - // Registered Company) - // - // * LLP (UK Limited Liability Partnership) - // - // * LTD (UK Limited - // Company) - // - // * OTHER (UK Entity that does not fit into any other category) - // - // * PLC - // (UK Public Limited Company) - // - // * PTNR (UK Partnership) - // - // * RCHAR (UK Registered - // Charity) - // - // * SCH (UK School) - // - // * STAT (UK Statutory Body) - // - // * STRA (UK Sole - // Trader) - // - // * UK_COMPANY_NUMBER - // - // In addition, many TLDs require a VAT_NUMBER. + // - UK_CONTACT_TYPE Valid values include the following: + // - CRC (UK Corporation by Royal Charter) + // - FCORP (Non-UK Corporation) + // - FIND (Non-UK Individual, representing self) + // - FOTHER (Non-UK Entity that does not fit into any other category) + // - GOV (UK Government Body) + // - IND (UK Individual (representing self)) + // - IP (UK Industrial/Provident Registered Company) + // - LLP (UK Limited Liability Partnership) + // - LTD (UK Limited Company) + // - OTHER (UK Entity that does not fit into any other category) + // - PLC (UK Public Limited Company) + // - PTNR (UK Partnership) + // - RCHAR (UK Registered Charity) + // - SCH (UK School) + // - STAT (UK Statutory Body) + // - STRA (UK Sole Trader) + // - UK_COMPANY_NUMBER + // In addition, many TLDs require a VAT_NUMBER . // // This member is required. Name ExtraParamName @@ -710,8 +459,8 @@ type ExtraParam struct { noSmithyDocumentSerde } -// Information for the filtering of a list of domains returned by ListDomains -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html). +// Information for the filtering of a list of domains returned by ListDomains (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html) +// . type FilterCondition struct { // Name of the field which should be used for filtering the list of domains. @@ -720,13 +469,9 @@ type FilterCondition struct { Name ListDomainsAttributeName // The operator values for filtering domain names. The values can be: - // - // * LE: Less - // than, or equal to - // - // * GE: Greater than, or equal to - // - // * BEGINS_WITH: Begins with + // - LE : Less than, or equal to + // - GE : Greater than, or equal to + // - BEGINS_WITH : Begins with // // This member is required. Operator Operator @@ -749,10 +494,10 @@ type Nameserver struct { // This member is required. Name *string - // Glue IP address of a name server entry. Glue IP addresses are required only when - // the name of the name server is a subdomain of the domain. For example, if your - // domain is example.com and the name server for the domain is ns.example.com, you - // need to specify the IP address for ns.example.com. Constraints: The list can + // Glue IP address of a name server entry. Glue IP addresses are required only + // when the name of the name server is a subdomain of the domain. For example, if + // your domain is example.com and the name server for the domain is ns.example.com, + // you need to specify the IP address for ns.example.com. Constraints: The list can // contain only one IPv4 and one IPv6 address. GlueIps []string @@ -778,27 +523,19 @@ type OperationSummary struct { // The current status of the requested operation in the system. Status OperationStatus - // Automatically checks whether there are no outstanding operations on domains that - // need customer attention. Valid values are: - // - // * PENDING_ACCEPTANCE: The operation - // is waiting for acceptance from the account that is receiving the domain. - // - // * - // PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for - // example, returning an email. - // - // * PENDING_AUTHORIZATION: The operation is waiting - // for the form of authorization. For more information, see - // ResendOperationAuthorization - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html). - // - // * - // PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to - // validate. - // - // * PENDING_SUPPORT_CASE: The operation includes a support case and is - // waiting for its resolution. + // Automatically checks whether there are no outstanding operations on domains + // that need customer attention. Valid values are: + // - PENDING_ACCEPTANCE : The operation is waiting for acceptance from the + // account that is receiving the domain. + // - PENDING_CUSTOMER_ACTION : The operation is waiting for customer action, for + // example, returning an email. + // - PENDING_AUTHORIZATION : The operation is waiting for the form of + // authorization. For more information, see ResendOperationAuthorization (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html) + // . + // - PENDING_PAYMENT_VERIFICATION : The operation is waiting for the payment + // method to validate. + // - PENDING_SUPPORT_CASE : The operation includes a support case and is waiting + // for its resolution. StatusFlag StatusFlag // The date when the request was submitted. @@ -831,8 +568,7 @@ type SortCondition struct { // Field to be used for sorting the list of domains. It can be either the name or // the expiration for a domain. Note that if filterCondition is used in the same - // ListDomains - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html) + // ListDomains (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html) // call, the field used for sorting has to be the same as the field used for // filtering. // diff --git a/service/route53recoverycluster/api_client.go b/service/route53recoverycluster/api_client.go index b924058c916..b2038aba237 100644 --- a/service/route53recoverycluster/api_client.go +++ b/service/route53recoverycluster/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53recoverycluster/api_op_GetRoutingControlState.go b/service/route53recoverycluster/api_op_GetRoutingControlState.go index 21dd4345b1d..114f26dab73 100644 --- a/service/route53recoverycluster/api_op_GetRoutingControlState.go +++ b/service/route53recoverycluster/api_op_GetRoutingControlState.go @@ -11,32 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get the state for a routing control. A routing control is a simple on/off switch -// that you can use to route traffic to cells. When a routing control state is On, -// traffic flows to a cell. When the state is Off, traffic does not flow. Before -// you can create a routing control, you must first create a cluster, and then host -// the control in a control panel on the cluster. For more information, see Create -// routing control structures -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) +// Get the state for a routing control. A routing control is a simple on/off +// switch that you can use to route traffic to cells. When a routing control state +// is On, traffic flows to a cell. When the state is Off, traffic does not flow. +// Before you can create a routing control, you must first create a cluster, and +// then host the control in a control panel on the cluster. For more information, +// see Create routing control structures (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. You // access one of the endpoints for the cluster to get or update the routing control // state to redirect traffic for your application. You must specify Regional // endpoints when you work with API cluster operations to get or update routing // control states in Route 53 ARC. To see a code example for getting a routing // control state, including accessing Regional cluster endpoints in sequence, see -// API examples -// (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. Learn // more about working with routing controls in the following topics in the Amazon // Route 53 Application Recovery Controller Developer Guide: -// -// * Viewing and -// updating routing control states -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) -// -// * -// Working with routing controls in Route 53 ARC -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) +// - Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// - Working with routing controls in Route 53 ARC (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) func (c *Client) GetRoutingControlState(ctx context.Context, params *GetRoutingControlStateInput, optFns ...func(*Options)) (*GetRoutingControlStateOutput, error) { if params == nil { params = &GetRoutingControlStateInput{} diff --git a/service/route53recoverycluster/api_op_ListRoutingControls.go b/service/route53recoverycluster/api_op_ListRoutingControls.go index f5246de357f..8e1ef7e024f 100644 --- a/service/route53recoverycluster/api_op_ListRoutingControls.go +++ b/service/route53recoverycluster/api_op_ListRoutingControls.go @@ -21,8 +21,7 @@ import ( // routing control state is On, traffic flows to a cell. When the state is Off, // traffic does not flow. Before you can create a routing control, you must first // create a cluster, and then host the control in a control panel on the cluster. -// For more information, see Create routing control structures -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) +// For more information, see Create routing control structures (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. You // access one of the endpoints for the cluster to get or update the routing control // state to redirect traffic for your application. You must specify Regional @@ -30,13 +29,8 @@ import ( // list routing controls in Route 53 ARC. Learn more about working with routing // controls in the following topics in the Amazon Route 53 Application Recovery // Controller Developer Guide: -// -// * Viewing and updating routing control states -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) -// -// * -// Working with routing controls in Route 53 ARC -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) +// - Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// - Working with routing controls in Route 53 ARC (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) func (c *Client) ListRoutingControls(ctx context.Context, params *ListRoutingControlsInput, optFns ...func(*Options)) (*ListRoutingControlsOutput, error) { if params == nil { params = &ListRoutingControlsInput{} @@ -146,8 +140,8 @@ func (c *Client) addOperationListRoutingControlsMiddlewares(stack *middleware.St return nil } -// ListRoutingControlsAPIClient is a client that implements the ListRoutingControls -// operation. +// ListRoutingControlsAPIClient is a client that implements the +// ListRoutingControls operation. type ListRoutingControlsAPIClient interface { ListRoutingControls(context.Context, *ListRoutingControlsInput, ...func(*Options)) (*ListRoutingControlsOutput, error) } diff --git a/service/route53recoverycluster/api_op_UpdateRoutingControlState.go b/service/route53recoverycluster/api_op_UpdateRoutingControlState.go index 06856ab7240..ab3a675aa63 100644 --- a/service/route53recoverycluster/api_op_UpdateRoutingControlState.go +++ b/service/route53recoverycluster/api_op_UpdateRoutingControlState.go @@ -22,25 +22,17 @@ import ( // might be unexpectedly preventing you from updating a routing control state to // reroute traffic. In a "break glass" scenario like this, you can override one or // more safety rules to change a routing control state and fail over your -// application. The SafetyRulesToOverride property enables you override one or more -// safety rules and update routing control states. For more information, see -// Override safety rules to reroute traffic -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) +// application. The SafetyRulesToOverride property enables you override one or +// more safety rules and update routing control states. For more information, see +// Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. You must // specify Regional endpoints when you work with API cluster operations to get or // update routing control states in Route 53 ARC. To see a code example for getting // a routing control state, including accessing Regional cluster endpoints in -// sequence, see API examples -// (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. -// -// * -// Viewing and updating routing control states -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) -// -// * -// Working with routing controls overall -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) +// - Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// - Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) func (c *Client) UpdateRoutingControlState(ctx context.Context, params *UpdateRoutingControlStateInput, optFns ...func(*Options)) (*UpdateRoutingControlStateOutput, error) { if params == nil { params = &UpdateRoutingControlStateInput{} @@ -72,8 +64,7 @@ type UpdateRoutingControlStateInput struct { // The Amazon Resource Names (ARNs) for the safety rules that you want to override // when you're updating the state of a routing control. You can override one safety // rule or multiple safety rules by including one or more ARNs, separated by - // commas. For more information, see Override safety rules to reroute traffic - // (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) + // commas. For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. SafetyRulesToOverride []string diff --git a/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go b/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go index 3d284bd2f6e..a0d8fc76ce3 100644 --- a/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go +++ b/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go @@ -22,25 +22,17 @@ import ( // be unexpectedly preventing you from updating a routing control state to reroute // traffic. In a "break glass" scenario like this, you can override one or more // safety rules to change a routing control state and fail over your application. -// The SafetyRulesToOverride property enables you override one or more safety rules -// and update routing control states. For more information, see Override safety -// rules to reroute traffic -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) +// The SafetyRulesToOverride property enables you override one or more safety +// rules and update routing control states. For more information, see Override +// safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. You must // specify Regional endpoints when you work with API cluster operations to get or // update routing control states in Route 53 ARC. To see a code example for getting // a routing control state, including accessing Regional cluster endpoints in -// sequence, see API examples -// (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. -// -// * -// Viewing and updating routing control states -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) -// -// * -// Working with routing controls overall -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) +// - Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// - Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) func (c *Client) UpdateRoutingControlStates(ctx context.Context, params *UpdateRoutingControlStatesInput, optFns ...func(*Options)) (*UpdateRoutingControlStatesOutput, error) { if params == nil { params = &UpdateRoutingControlStatesInput{} @@ -66,8 +58,7 @@ type UpdateRoutingControlStatesInput struct { // The Amazon Resource Names (ARNs) for the safety rules that you want to override // when you're updating routing control states. You can override one safety rule or // multiple safety rules by including one or more ARNs, separated by commas. For - // more information, see Override safety rules to reroute traffic - // (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) + // more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. SafetyRulesToOverride []string diff --git a/service/route53recoverycluster/doc.go b/service/route53recoverycluster/doc.go index c73756f7053..f69c7508e5a 100644 --- a/service/route53recoverycluster/doc.go +++ b/service/route53recoverycluster/doc.go @@ -3,21 +3,21 @@ // Package route53recoverycluster provides the API client, operations, and // parameter types for Route53 Recovery Cluster. // -// Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon -// Route 53 Application Recovery Controller. With Route 53 ARC, you can use routing -// control with extreme reliability to recover applications by rerouting traffic -// across Availability Zones or Amazon Web Services Regions. Routing controls are -// simple on/off switches hosted on a highly available cluster in Route 53 ARC. A -// cluster provides a set of five redundant Regional endpoints against which you -// can run API calls to get or update the state of routing controls. To implement -// failover, you set one routing control On and another one Off, to reroute traffic -// from one Availability Zone or Amazon Web Services Region to another. Be aware -// that you must specify a Regional endpoint for a cluster when you work with API -// cluster operations to get or update routing control states in Route 53 ARC. In -// addition, you must specify the US West (Oregon) Region for Route 53 ARC API -// calls. For example, use the parameter --region us-west-2 with AWS CLI commands. -// For more information, see Get and update routing control states using the API -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html) +// Welcome to the Routing Control (Recovery Cluster) API Reference Guide for +// Amazon Route 53 Application Recovery Controller. With Route 53 ARC, you can use +// routing control with extreme reliability to recover applications by rerouting +// traffic across Availability Zones or Amazon Web Services Regions. Routing +// controls are simple on/off switches hosted on a highly available cluster in +// Route 53 ARC. A cluster provides a set of five redundant Regional endpoints +// against which you can run API calls to get or update the state of routing +// controls. To implement failover, you set one routing control On and another one +// Off, to reroute traffic from one Availability Zone or Amazon Web Services Region +// to another. Be aware that you must specify a Regional endpoint for a cluster +// when you work with API cluster operations to get or update routing control +// states in Route 53 ARC. In addition, you must specify the US West (Oregon) +// Region for Route 53 ARC API calls. For example, use the parameter --region +// us-west-2 with AWS CLI commands. For more information, see Get and update +// routing control states using the API (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. This API // guide includes information about the API operations for how to get and update // routing control states in Route 53 ARC. To work with routing control in Route 53 @@ -25,29 +25,22 @@ // and routing controls) using the recovery cluster configuration API. For more // information about working with routing control in Route 53 ARC, see the // following: -// -// * Create clusters, control panels, and routing controls by using API -// operations. For more information, see the Recovery Control Configuration API -// Reference Guide for Amazon Route 53 Application Recovery Controller -// (https://docs.aws.amazon.com/recovery-cluster/latest/api/). -// -// * Learn about the -// components in recovery control, including clusters, routing controls, and -// control panels, and how to work with Route 53 ARC in the Amazon Web Services -// console. For more information, see Recovery control components -// (https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing) -// in the Amazon Route 53 Application Recovery Controller Developer Guide. -// -// * Route -// 53 ARC also provides readiness checks that continually audit resources to help -// make sure that your applications are scaled and ready to handle failover -// traffic. For more information about the related API operations, see the Recovery -// Readiness API Reference Guide for Amazon Route 53 Application Recovery -// Controller (https://docs.aws.amazon.com/recovery-readiness/latest/api/). -// -// * For -// more information about creating resilient applications and preparing for -// recovery readiness with Route 53 ARC, see the Amazon Route 53 Application -// Recovery Controller Developer Guide -// (https://docs.aws.amazon.com/r53recovery/latest/dg/). +// - Create clusters, control panels, and routing controls by using API +// operations. For more information, see the Recovery Control Configuration API +// Reference Guide for Amazon Route 53 Application Recovery Controller (https://docs.aws.amazon.com/recovery-cluster/latest/api/) +// . +// - Learn about the components in recovery control, including clusters, routing +// controls, and control panels, and how to work with Route 53 ARC in the Amazon +// Web Services console. For more information, see Recovery control components (https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// - Route 53 ARC also provides readiness checks that continually audit +// resources to help make sure that your applications are scaled and ready to +// handle failover traffic. For more information about the related API operations, +// see the Recovery Readiness API Reference Guide for Amazon Route 53 +// Application Recovery Controller (https://docs.aws.amazon.com/recovery-readiness/latest/api/) +// . +// - For more information about creating resilient applications and preparing +// for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application +// Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/) +// . package route53recoverycluster diff --git a/service/route53recoverycluster/types/types.go b/service/route53recoverycluster/types/types.go index 993777f7bd9..bacde7d9d53 100644 --- a/service/route53recoverycluster/types/types.go +++ b/service/route53recoverycluster/types/types.go @@ -11,8 +11,8 @@ import ( // When the state is Off, traffic does not flow. type RoutingControl struct { - // The Amazon Resource Name (ARN) of the control panel where the routing control is - // located. + // The Amazon Resource Name (ARN) of the control panel where the routing control + // is located. ControlPanelArn *string // The name of the control panel where the routing control is located. diff --git a/service/route53recoverycontrolconfig/api_client.go b/service/route53recoverycontrolconfig/api_client.go index d1259cf0873..a396d67c10e 100644 --- a/service/route53recoverycontrolconfig/api_client.go +++ b/service/route53recoverycontrolconfig/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53recoverycontrolconfig/api_op_CreateCluster.go b/service/route53recoverycontrolconfig/api_op_CreateCluster.go index 3a96dda834e..bb3af2ddd65 100644 --- a/service/route53recoverycontrolconfig/api_op_CreateCluster.go +++ b/service/route53recoverycontrolconfig/api_op_CreateCluster.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new cluster. A cluster is a set of redundant Regional endpoints against -// which you can run API calls to update or get the state of one or more routing -// controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an -// array of the five cluster endpoints (one for each supported Amazon Web Services -// Region) that you can use with API calls to the cluster data plane. +// Create a new cluster. A cluster is a set of redundant Regional endpoints +// against which you can run API calls to update or get the state of one or more +// routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), +// and an array of the five cluster endpoints (one for each supported Amazon Web +// Services Region) that you can use with API calls to the cluster data plane. func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} diff --git a/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go b/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go index de22e12d8c6..8d0e0e32c70 100644 --- a/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go +++ b/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go @@ -23,8 +23,7 @@ import ( // Gating rule: A gating rule lets you configure a gating routing control as an // overall "on/off" switch for a group of routing controls. Or, you can configure // more complex gating scenarios, for example by configuring multiple gating -// routing controls. For more information, see Safety rules -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html) +// routing controls. For more information, see Safety rules (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html) // in the Amazon Route 53 Application Recovery Controller Developer Guide. func (c *Client) CreateSafetyRule(ctx context.Context, params *CreateSafetyRuleInput, optFns ...func(*Options)) (*CreateSafetyRuleOutput, error) { if params == nil { diff --git a/service/route53recoverycontrolconfig/api_op_DescribeCluster.go b/service/route53recoverycontrolconfig/api_op_DescribeCluster.go index 93f825b0ebe..4e287c63d8f 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeCluster.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeCluster.go @@ -139,9 +139,9 @@ type ClusterCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterCreatedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterCreatedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -323,9 +323,9 @@ type ClusterDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ClusterDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go b/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go index 9785b642394..ce16b2a3f73 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go @@ -139,9 +139,10 @@ type ControlPanelCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ControlPanelCreatedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ControlPanelCreatedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -181,9 +182,9 @@ func NewControlPanelCreatedWaiter(client DescribeControlPanelAPIClient, optFns . } } -// Wait calls the waiter function for ControlPanelCreated waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ControlPanelCreated waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ControlPanelCreatedWaiter) Wait(ctx context.Context, params *DescribeControlPanelInput, maxWaitDur time.Duration, optFns ...func(*ControlPanelCreatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -324,9 +325,10 @@ type ControlPanelDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ControlPanelDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ControlPanelDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -366,9 +368,9 @@ func NewControlPanelDeletedWaiter(client DescribeControlPanelAPIClient, optFns . } } -// Wait calls the waiter function for ControlPanelDeleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ControlPanelDeleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ControlPanelDeletedWaiter) Wait(ctx context.Context, params *DescribeControlPanelInput, maxWaitDur time.Duration, optFns ...func(*ControlPanelDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go b/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go index 9a2f28d55f9..390b45ba555 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go @@ -143,9 +143,10 @@ type RoutingControlCreatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RoutingControlCreatedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RoutingControlCreatedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -328,9 +329,10 @@ type RoutingControlDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, RoutingControlDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, RoutingControlDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/route53recoverycontrolconfig/api_op_ListAssociatedRoute53HealthChecks.go b/service/route53recoverycontrolconfig/api_op_ListAssociatedRoute53HealthChecks.go index f11a05457fd..439ffddf673 100644 --- a/service/route53recoverycontrolconfig/api_op_ListAssociatedRoute53HealthChecks.go +++ b/service/route53recoverycontrolconfig/api_op_ListAssociatedRoute53HealthChecks.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array of all Amazon Route 53 health checks associated with a specific -// routing control. +// Returns an array of all Amazon Route 53 health checks associated with a +// specific routing control. func (c *Client) ListAssociatedRoute53HealthChecks(ctx context.Context, params *ListAssociatedRoute53HealthChecksInput, optFns ...func(*Options)) (*ListAssociatedRoute53HealthChecksOutput, error) { if params == nil { params = &ListAssociatedRoute53HealthChecksInput{} diff --git a/service/route53recoverycontrolconfig/api_op_ListRoutingControls.go b/service/route53recoverycontrolconfig/api_op_ListRoutingControls.go index 70b6527a23b..c9ec45727ad 100644 --- a/service/route53recoverycontrolconfig/api_op_ListRoutingControls.go +++ b/service/route53recoverycontrolconfig/api_op_ListRoutingControls.go @@ -124,8 +124,8 @@ func (c *Client) addOperationListRoutingControlsMiddlewares(stack *middleware.St return nil } -// ListRoutingControlsAPIClient is a client that implements the ListRoutingControls -// operation. +// ListRoutingControlsAPIClient is a client that implements the +// ListRoutingControls operation. type ListRoutingControlsAPIClient interface { ListRoutingControls(context.Context, *ListRoutingControlsInput, ...func(*Options)) (*ListRoutingControlsOutput, error) } diff --git a/service/route53recoverycontrolconfig/api_op_ListSafetyRules.go b/service/route53recoverycontrolconfig/api_op_ListSafetyRules.go index 9de1361a0eb..0a6024d0450 100644 --- a/service/route53recoverycontrolconfig/api_op_ListSafetyRules.go +++ b/service/route53recoverycontrolconfig/api_op_ListSafetyRules.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the safety rules (the assertion rules and gating rules) that you've defined -// for the routing controls in a control panel. +// List the safety rules (the assertion rules and gating rules) that you've +// defined for the routing controls in a control panel. func (c *Client) ListSafetyRules(ctx context.Context, params *ListSafetyRulesInput, optFns ...func(*Options)) (*ListSafetyRulesOutput, error) { if params == nil { params = &ListSafetyRulesInput{} diff --git a/service/route53recoverycontrolconfig/api_op_UpdateSafetyRule.go b/service/route53recoverycontrolconfig/api_op_UpdateSafetyRule.go index 9b7b0690ed7..e6f6b8bcdae 100644 --- a/service/route53recoverycontrolconfig/api_op_UpdateSafetyRule.go +++ b/service/route53recoverycontrolconfig/api_op_UpdateSafetyRule.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a safety rule (an assertion rule or gating rule). You can only update the -// name and the waiting period for a safety rule. To make other updates, delete the -// safety rule and create a new one. +// Update a safety rule (an assertion rule or gating rule). You can only update +// the name and the waiting period for a safety rule. To make other updates, delete +// the safety rule and create a new one. func (c *Client) UpdateSafetyRule(ctx context.Context, params *UpdateSafetyRuleInput, optFns ...func(*Options)) (*UpdateSafetyRuleOutput, error) { if params == nil { params = &UpdateSafetyRuleInput{} diff --git a/service/route53recoverycontrolconfig/types/errors.go b/service/route53recoverycontrolconfig/types/errors.go index 661c4f91a3c..3c25a6ede9a 100644 --- a/service/route53recoverycontrolconfig/types/errors.go +++ b/service/route53recoverycontrolconfig/types/errors.go @@ -85,8 +85,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// 404 response - MalformedQueryString. The query string contains a syntax error or -// resource not found. +// 404 response - MalformedQueryString. The query string contains a syntax error +// or resource not found. type ResourceNotFoundException struct { Message *string diff --git a/service/route53recoverycontrolconfig/types/types.go b/service/route53recoverycontrolconfig/types/types.go index dbfe15113fe..95782275c5b 100644 --- a/service/route53recoverycontrolconfig/types/types.go +++ b/service/route53recoverycontrolconfig/types/types.go @@ -54,9 +54,9 @@ type AssertionRule struct { // This member is required. Status Status - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -64,13 +64,13 @@ type AssertionRule struct { noSmithyDocumentSerde } -// An update to an assertion rule. You can update the name or the evaluation period -// (wait period). If you don't specify one of the items to update, the item is -// unchanged. +// An update to an assertion rule. You can update the name or the evaluation +// period (wait period). If you don't specify one of the items to update, the item +// is unchanged. type AssertionRuleUpdate struct { - // The name of the assertion rule. You can use any non-white space character in the - // name. + // The name of the assertion rule. You can use any non-white space character in + // the name. // // This member is required. Name *string @@ -80,9 +80,9 @@ type AssertionRuleUpdate struct { // This member is required. SafetyRuleArn *string - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -190,8 +190,8 @@ type GatingRule struct { // This member is required. Name *string - // The criteria that you set for gating routing controls that designate how many of - // the routing control states must be ON to allow you to update target routing + // The criteria that you set for gating routing controls that designate how many + // of the routing control states must be ON to allow you to update target routing // control states. // // This member is required. @@ -218,9 +218,9 @@ type GatingRule struct { // This member is required. TargetControls []string - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -243,9 +243,9 @@ type GatingRuleUpdate struct { // This member is required. SafetyRuleArn *string - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -269,8 +269,8 @@ type NewAssertionRule struct { // This member is required. ControlPanelArn *string - // The name of the assertion rule. You can use any non-white space character in the - // name. + // The name of the assertion rule. You can use any non-white space character in + // the name. // // This member is required. Name *string @@ -285,9 +285,9 @@ type NewAssertionRule struct { // This member is required. RuleConfig *RuleConfig - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -333,9 +333,9 @@ type NewGatingRule struct { // This member is required. TargetControls []string - // An evaluation period, in milliseconds (ms), during which any request against the - // target routing controls will fail. This helps prevent "flapping" of state. The - // wait period is 5000 ms by default, but you can choose a custom value. + // An evaluation period, in milliseconds (ms), during which any request against + // the target routing controls will fail. This helps prevent "flapping" of state. + // The wait period is 5000 ms by default, but you can choose a custom value. // // This member is required. WaitPeriodMs int32 @@ -389,9 +389,9 @@ type Rule struct { noSmithyDocumentSerde } -// The rule configuration for an assertion rule. That is, the criteria that you set -// for specific assertion controls (routing controls) that specify how many control -// states must be ON after a transaction completes. +// The rule configuration for an assertion rule. That is, the criteria that you +// set for specific assertion controls (routing controls) that specify how many +// control states must be ON after a transaction completes. type RuleConfig struct { // Logical negation of the rule. If the rule would usually evaluate true, it's @@ -400,8 +400,8 @@ type RuleConfig struct { // This member is required. Inverted bool - // The value of N, when you specify an ATLEAST rule type. That is, Threshold is the - // number of controls that must be set when you specify an ATLEAST type. + // The value of N, when you specify an ATLEAST rule type. That is, Threshold is + // the number of controls that must be set when you specify an ATLEAST type. // // This member is required. Threshold int32 diff --git a/service/route53recoveryreadiness/api_client.go b/service/route53recoveryreadiness/api_client.go index 49cf2cef8c0..50a4da8f0b8 100644 --- a/service/route53recoveryreadiness/api_client.go +++ b/service/route53recoveryreadiness/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53recoveryreadiness/api_op_CreateCell.go b/service/route53recoveryreadiness/api_op_CreateCell.go index 83ef03c58f8..d09fa3a0103 100644 --- a/service/route53recoveryreadiness/api_op_CreateCell.go +++ b/service/route53recoveryreadiness/api_op_CreateCell.go @@ -55,8 +55,9 @@ type CreateCellOutput struct { // A list of cell ARNs. Cells []string - // The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) - // or a recovery group ARN. This is a list but currently can have only one element. + // The readiness scope for the cell, which can be a cell Amazon Resource Name + // (ARN) or a recovery group ARN. This is a list but currently can have only one + // element. ParentReadinessScopes []string // Tags on the resources. diff --git a/service/route53recoveryreadiness/api_op_CreateCrossAccountAuthorization.go b/service/route53recoveryreadiness/api_op_CreateCrossAccountAuthorization.go index ad378aad99f..5508d0ea2ff 100644 --- a/service/route53recoveryreadiness/api_op_CreateCrossAccountAuthorization.go +++ b/service/route53recoveryreadiness/api_op_CreateCrossAccountAuthorization.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a cross-account readiness authorization. This lets you authorize another -// account to work with Route 53 Application Recovery Controller, for example, to -// check the readiness status of resources in a separate account. +// Creates a cross-account readiness authorization. This lets you authorize +// another account to work with Route 53 Application Recovery Controller, for +// example, to check the readiness status of resources in a separate account. func (c *Client) CreateCrossAccountAuthorization(ctx context.Context, params *CreateCrossAccountAuthorizationInput, optFns ...func(*Options)) (*CreateCrossAccountAuthorizationOutput, error) { if params == nil { params = &CreateCrossAccountAuthorizationInput{} diff --git a/service/route53recoveryreadiness/api_op_GetCell.go b/service/route53recoveryreadiness/api_op_GetCell.go index 613ad72546c..27addd8fa57 100644 --- a/service/route53recoveryreadiness/api_op_GetCell.go +++ b/service/route53recoveryreadiness/api_op_GetCell.go @@ -49,8 +49,9 @@ type GetCellOutput struct { // A list of cell ARNs. Cells []string - // The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) - // or a recovery group ARN. This is a list but currently can have only one element. + // The readiness scope for the cell, which can be a cell Amazon Resource Name + // (ARN) or a recovery group ARN. This is a list but currently can have only one + // element. ParentReadinessScopes []string // Tags on the resources. diff --git a/service/route53recoveryreadiness/api_op_ListReadinessChecks.go b/service/route53recoveryreadiness/api_op_ListReadinessChecks.go index 5b7e3dd6f01..befbc9997c2 100644 --- a/service/route53recoveryreadiness/api_op_ListReadinessChecks.go +++ b/service/route53recoveryreadiness/api_op_ListReadinessChecks.go @@ -113,8 +113,8 @@ func (c *Client) addOperationListReadinessChecksMiddlewares(stack *middleware.St return nil } -// ListReadinessChecksAPIClient is a client that implements the ListReadinessChecks -// operation. +// ListReadinessChecksAPIClient is a client that implements the +// ListReadinessChecks operation. type ListReadinessChecksAPIClient interface { ListReadinessChecks(context.Context, *ListReadinessChecksInput, ...func(*Options)) (*ListReadinessChecksOutput, error) } diff --git a/service/route53recoveryreadiness/api_op_UpdateCell.go b/service/route53recoveryreadiness/api_op_UpdateCell.go index e619615c63a..5584d087a92 100644 --- a/service/route53recoveryreadiness/api_op_UpdateCell.go +++ b/service/route53recoveryreadiness/api_op_UpdateCell.go @@ -54,8 +54,9 @@ type UpdateCellOutput struct { // A list of cell ARNs. Cells []string - // The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) - // or a recovery group ARN. This is a list but currently can have only one element. + // The readiness scope for the cell, which can be a cell Amazon Resource Name + // (ARN) or a recovery group ARN. This is a list but currently can have only one + // element. ParentReadinessScopes []string // Tags on the resources. diff --git a/service/route53recoveryreadiness/types/enums.go b/service/route53recoveryreadiness/types/enums.go index 4dfbb8e0c52..f80f23cd6b3 100644 --- a/service/route53recoveryreadiness/types/enums.go +++ b/service/route53recoveryreadiness/types/enums.go @@ -12,9 +12,9 @@ const ( ReadinessNotAuthorized Readiness = "NOT_AUTHORIZED" ) -// Values returns all known values for Readiness. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Readiness. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Readiness) Values() []Readiness { return []Readiness{ "READY", diff --git a/service/route53recoveryreadiness/types/types.go b/service/route53recoveryreadiness/types/types.go index b59379ee6d5..e48d372d632 100644 --- a/service/route53recoveryreadiness/types/types.go +++ b/service/route53recoveryreadiness/types/types.go @@ -25,8 +25,9 @@ type CellOutput struct { // This member is required. Cells []string - // The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) - // or a recovery group ARN. This is a list but currently can have only one element. + // The readiness scope for the cell, which can be a cell Amazon Resource Name + // (ARN) or a recovery group ARN. This is a list but currently can have only one + // element. // // This member is required. ParentReadinessScopes []string @@ -44,8 +45,8 @@ type DNSTargetResource struct { // application. DomainName *string - // The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the - // provided name of the target resource. + // The hosted zone Amazon Resource Name (ARN) that contains the DNS record with + // the provided name of the target resource. HostedZoneArn *string // The Route 53 record set ID that uniquely identifies a DNS record, given a name diff --git a/service/route53resolver/api_client.go b/service/route53resolver/api_client.go index f66697966e0..c28db435969 100644 --- a/service/route53resolver/api_client.go +++ b/service/route53resolver/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/route53resolver/api_op_AssociateFirewallRuleGroup.go b/service/route53resolver/api_op_AssociateFirewallRuleGroup.go index 49f36f16f82..c024ed687b5 100644 --- a/service/route53resolver/api_op_AssociateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_AssociateFirewallRuleGroup.go @@ -31,8 +31,8 @@ func (c *Client) AssociateFirewallRuleGroup(ctx context.Context, params *Associa type AssociateFirewallRuleGroupInput struct { // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of running the operation twice. CreatorRequestId can - // be any unique string, for example, a date/time stamp. + // be retried without the risk of running the operation twice. CreatorRequestId + // can be any unique string, for example, a date/time stamp. // // This member is required. CreatorRequestId *string @@ -66,11 +66,11 @@ type AssociateFirewallRuleGroupInput struct { // If enabled, this setting disallows modification or removal of the association, // to help prevent against accidentally altering DNS firewall protections. When you - // create the association, the default setting is DISABLED. + // create the association, the default setting is DISABLED . MutationProtection types.MutationProtectionStatus - // A list of the tag keys and values that you want to associate with the rule group - // association. + // A list of the tag keys and values that you want to associate with the rule + // group association. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go b/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go index d2041d5f976..61e18b1220c 100644 --- a/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go +++ b/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to -// add more than one IP address, submit one AssociateResolverEndpointIpAddress +// Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want +// to add more than one IP address, submit one AssociateResolverEndpointIpAddress // request for each IP address. To remove an IP address from an endpoint, see -// DisassociateResolverEndpointIpAddress -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverEndpointIpAddress.html). +// DisassociateResolverEndpointIpAddress (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverEndpointIpAddress.html) +// . func (c *Client) AssociateResolverEndpointIpAddress(ctx context.Context, params *AssociateResolverEndpointIpAddressInput, optFns ...func(*Options)) (*AssociateResolverEndpointIpAddressOutput, error) { if params == nil { params = &AssociateResolverEndpointIpAddressInput{} diff --git a/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go b/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go index d567a30799a..7249a5515f6 100644 --- a/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go @@ -14,11 +14,11 @@ import ( // Associates an Amazon VPC with a specified query logging configuration. Route 53 // Resolver logs DNS queries that originate in all of the Amazon VPCs that are // associated with a specified query logging configuration. To associate more than -// one VPC with a configuration, submit one AssociateResolverQueryLogConfig request -// for each VPC. The VPCs that you associate with a query logging configuration -// must be in the same Region as the configuration. To remove a VPC from a query -// logging configuration, see DisassociateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html). +// one VPC with a configuration, submit one AssociateResolverQueryLogConfig +// request for each VPC. The VPCs that you associate with a query logging +// configuration must be in the same Region as the configuration. To remove a VPC +// from a query logging configuration, see DisassociateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html) +// . func (c *Client) AssociateResolverQueryLogConfig(ctx context.Context, params *AssociateResolverQueryLogConfigInput, optFns ...func(*Options)) (*AssociateResolverQueryLogConfigOutput, error) { if params == nil { params = &AssociateResolverQueryLogConfigInput{} diff --git a/service/route53resolver/api_op_AssociateResolverRule.go b/service/route53resolver/api_op_AssociateResolverRule.go index 4051c1606b6..9adcf5d9ced 100644 --- a/service/route53resolver/api_op_AssociateResolverRule.go +++ b/service/route53resolver/api_op_AssociateResolverRule.go @@ -15,8 +15,8 @@ import ( // Resolver forwards all DNS queries for the domain name that is specified in the // rule and that originate in the VPC. The queries are forwarded to the IP // addresses for the DNS resolvers that are specified in the rule. For more -// information about rules, see CreateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html). +// information about rules, see CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html) +// . func (c *Client) AssociateResolverRule(ctx context.Context, params *AssociateResolverRuleInput, optFns ...func(*Options)) (*AssociateResolverRuleOutput, error) { if params == nil { params = &AssociateResolverRuleInput{} @@ -34,9 +34,9 @@ func (c *Client) AssociateResolverRule(ctx context.Context, params *AssociateRes type AssociateResolverRuleInput struct { - // The ID of the Resolver rule that you want to associate with the VPC. To list the - // existing Resolver rules, use ListResolverRules - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html). + // The ID of the Resolver rule that you want to associate with the VPC. To list + // the existing Resolver rules, use ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) + // . // // This member is required. ResolverRuleId *string @@ -55,8 +55,8 @@ type AssociateResolverRuleInput struct { type AssociateResolverRuleOutput struct { - // Information about the AssociateResolverRule request, including the status of the - // request. + // Information about the AssociateResolverRule request, including the status of + // the request. ResolverRuleAssociation *types.ResolverRuleAssociation // Metadata pertaining to the operation's result. diff --git a/service/route53resolver/api_op_CreateFirewallDomainList.go b/service/route53resolver/api_op_CreateFirewallDomainList.go index 90c4332a5af..60ca84d43de 100644 --- a/service/route53resolver/api_op_CreateFirewallDomainList.go +++ b/service/route53resolver/api_op_CreateFirewallDomainList.go @@ -13,8 +13,8 @@ import ( ) // Creates an empty firewall domain list for use in DNS Firewall rules. You can -// populate the domains for the new list with a file, using ImportFirewallDomains, -// or with domain strings, using UpdateFirewallDomains. +// populate the domains for the new list with a file, using ImportFirewallDomains , +// or with domain strings, using UpdateFirewallDomains . func (c *Client) CreateFirewallDomainList(ctx context.Context, params *CreateFirewallDomainListInput, optFns ...func(*Options)) (*CreateFirewallDomainListOutput, error) { if params == nil { params = &CreateFirewallDomainListInput{} diff --git a/service/route53resolver/api_op_CreateFirewallRule.go b/service/route53resolver/api_op_CreateFirewallRule.go index 9728e968676..2940f729c7a 100644 --- a/service/route53resolver/api_op_CreateFirewallRule.go +++ b/service/route53resolver/api_op_CreateFirewallRule.go @@ -33,15 +33,10 @@ type CreateFirewallRuleInput struct { // The action that DNS Firewall should take on a DNS query when it matches one of // the domains in the rule's domain list: - // - // * ALLOW - Permit the request to go - // through. - // - // * ALERT - Permit the request and send metrics and logs to Cloud - // Watch. - // - // * BLOCK - Disallow the request. This option requires additional details - // in the rule's BlockResponse. + // - ALLOW - Permit the request to go through. + // - ALERT - Permit the request and send metrics and logs to Cloud Watch. + // - BLOCK - Disallow the request. This option requires additional details in the + // rule's BlockResponse . // // This member is required. Action types.Action @@ -80,37 +75,31 @@ type CreateFirewallRuleInput struct { Priority *int32 // The DNS record's type. This determines the format of the record value that you - // provided in BlockOverrideDomain. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse - // setting is OVERRIDE. + // provided in BlockOverrideDomain . Used for the rule action BLOCK with a + // BlockResponse setting of OVERRIDE . This setting is required if the + // BlockResponse setting is OVERRIDE . BlockOverrideDnsType types.BlockOverrideDnsType // The custom DNS record to send back in response to the query. Used for the rule - // action BLOCK with a BlockResponse setting of OVERRIDE. This setting is required - // if the BlockResponse setting is OVERRIDE. + // action BLOCK with a BlockResponse setting of OVERRIDE . This setting is required + // if the BlockResponse setting is OVERRIDE . BlockOverrideDomain *string // The recommended amount of time, in seconds, for the DNS resolver or web browser // to cache the provided override record. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse - // setting is OVERRIDE. + // BlockResponse setting of OVERRIDE . This setting is required if the + // BlockResponse setting is OVERRIDE . BlockOverrideTtl *int32 // The way that you want DNS Firewall to block the request, used with the rule - // action setting BLOCK. - // - // * NODATA - Respond indicating that the query was - // successful, but no response is available for it. - // - // * NXDOMAIN - Respond - // indicating that the domain name that's in the query doesn't exist. - // - // * OVERRIDE - - // Provide a custom override in the response. This option requires custom handling - // details in the rule's BlockOverride* settings. - // - // This setting is required if the - // rule action setting is BLOCK. + // action setting BLOCK . + // - NODATA - Respond indicating that the query was successful, but no response + // is available for it. + // - NXDOMAIN - Respond indicating that the domain name that's in the query + // doesn't exist. + // - OVERRIDE - Provide a custom override in the response. This option requires + // custom handling details in the rule's BlockOverride* settings. + // This setting is required if the rule action setting is BLOCK . BlockResponse types.BlockResponse noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_CreateFirewallRuleGroup.go b/service/route53resolver/api_op_CreateFirewallRuleGroup.go index 7b18cc35780..9c75fda6771 100644 --- a/service/route53resolver/api_op_CreateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_CreateFirewallRuleGroup.go @@ -13,7 +13,7 @@ import ( ) // Creates an empty DNS Firewall rule group for filtering DNS network traffic in a -// VPC. You can add rules to the new rule group by calling CreateFirewallRule. +// VPC. You can add rules to the new rule group by calling CreateFirewallRule . func (c *Client) CreateFirewallRuleGroup(ctx context.Context, params *CreateFirewallRuleGroupInput, optFns ...func(*Options)) (*CreateFirewallRuleGroupOutput, error) { if params == nil { params = &CreateFirewallRuleGroupInput{} @@ -31,9 +31,9 @@ func (c *Client) CreateFirewallRuleGroup(ctx context.Context, params *CreateFire type CreateFirewallRuleGroupInput struct { - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. // // This member is required. CreatorRequestId *string diff --git a/service/route53resolver/api_op_CreateResolverEndpoint.go b/service/route53resolver/api_op_CreateResolverEndpoint.go index d9dc3a56df4..22b480fed2a 100644 --- a/service/route53resolver/api_op_CreateResolverEndpoint.go +++ b/service/route53resolver/api_op_CreateResolverEndpoint.go @@ -13,12 +13,10 @@ import ( // Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound // and outbound: -// -// * An inbound Resolver endpoint forwards DNS queries to the DNS -// service for a VPC from your network. -// -// * An outbound Resolver endpoint forwards -// DNS queries from the DNS service for a VPC to your network. +// - An inbound Resolver endpoint forwards DNS queries to the DNS service for a +// VPC from your network. +// - An outbound Resolver endpoint forwards DNS queries from the DNS service for +// a VPC to your network. func (c *Client) CreateResolverEndpoint(ctx context.Context, params *CreateResolverEndpointInput, optFns ...func(*Options)) (*CreateResolverEndpointOutput, error) { if params == nil { params = &CreateResolverEndpointInput{} @@ -37,19 +35,17 @@ func (c *Client) CreateResolverEndpoint(ctx context.Context, params *CreateResol type CreateResolverEndpointInput struct { // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of running the operation twice. CreatorRequestId can - // be any unique string, for example, a date/time stamp. + // be retried without the risk of running the operation twice. CreatorRequestId + // can be any unique string, for example, a date/time stamp. // // This member is required. CreatorRequestId *string // Specify the applicable value: - // - // * INBOUND: Resolver forwards DNS queries to the - // DNS service for a VPC from your network - // - // * OUTBOUND: Resolver forwards DNS - // queries from the DNS service for a VPC to your network + // - INBOUND : Resolver forwards DNS queries to the DNS service for a VPC from + // your network + // - OUTBOUND : Resolver forwards DNS queries from the DNS service for a VPC to + // your network // // This member is required. Direction types.ResolverEndpointDirection diff --git a/service/route53resolver/api_op_CreateResolverQueryLogConfig.go b/service/route53resolver/api_op_CreateResolverQueryLogConfig.go index 36eee20ff7b..eb7b63d6581 100644 --- a/service/route53resolver/api_op_CreateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_CreateResolverQueryLogConfig.go @@ -16,10 +16,9 @@ import ( // Resolver to save DNS query logs that originate in your VPCs. Resolver can log // queries only for VPCs that are in the same Region as the query logging // configuration. To specify which VPCs you want to log queries for, you use -// AssociateResolverQueryLogConfig. For more information, see -// AssociateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html). -// You can optionally use Resource Access Manager (RAM) to share a query logging +// AssociateResolverQueryLogConfig . For more information, see +// AssociateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html) +// . You can optionally use Resource Access Manager (RAM) to share a query logging // configuration with other Amazon Web Services accounts. The other accounts can // then associate VPCs with the configuration. The query logs that Resolver creates // for a configuration include all DNS queries that originate in all VPCs that are @@ -42,8 +41,8 @@ func (c *Client) CreateResolverQueryLogConfig(ctx context.Context, params *Creat type CreateResolverQueryLogConfigInput struct { // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of running the operation twice. CreatorRequestId can - // be any unique string, for example, a date/time stamp. + // be retried without the risk of running the operation twice. CreatorRequestId + // can be any unique string, for example, a date/time stamp. // // This member is required. CreatorRequestId *string @@ -51,18 +50,12 @@ type CreateResolverQueryLogConfigInput struct { // The ARN of the resource that you want Resolver to send query logs. You can send // query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data // Firehose delivery stream. Examples of valid values include the following: - // - // * S3 - // bucket: arn:aws:s3:::examplebucket You can optionally append a file prefix to - // the end of the ARN. arn:aws:s3:::examplebucket/development/ - // - // * CloudWatch Logs - // log group: - // arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:* - // - // * - // Kinesis Data Firehose delivery stream: - // arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name + // - S3 bucket: arn:aws:s3:::examplebucket You can optionally append a file + // prefix to the end of the ARN. arn:aws:s3:::examplebucket/development/ + // - CloudWatch Logs log group: + // arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:* + // - Kinesis Data Firehose delivery stream: + // arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name // // This member is required. DestinationArn *string @@ -81,8 +74,8 @@ type CreateResolverQueryLogConfigInput struct { type CreateResolverQueryLogConfigOutput struct { - // Information about the CreateResolverQueryLogConfig request, including the status - // of the request. + // Information about the CreateResolverQueryLogConfig request, including the + // status of the request. ResolverQueryLogConfig *types.ResolverQueryLogConfig // Metadata pertaining to the operation's result. diff --git a/service/route53resolver/api_op_CreateResolverRule.go b/service/route53resolver/api_op_CreateResolverRule.go index a444a5317a4..4afe98fc4fa 100644 --- a/service/route53resolver/api_op_CreateResolverRule.go +++ b/service/route53resolver/api_op_CreateResolverRule.go @@ -32,14 +32,14 @@ func (c *Client) CreateResolverRule(ctx context.Context, params *CreateResolverR type CreateResolverRuleInput struct { // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of running the operation twice. CreatorRequestId can - // be any unique string, for example, a date/time stamp. + // be retried without the risk of running the operation twice. CreatorRequestId + // can be any unique string, for example, a date/time stamp. // // This member is required. CreatorRequestId *string // DNS queries for this domain name are forwarded to the IP addresses that you - // specify in TargetIps. If a query matches multiple Resolver rules (example.com + // specify in TargetIps . If a query matches multiple Resolver rules (example.com // and www.example.com), outbound DNS queries are routed using the Resolver rule // that contains the most specific domain name (www.example.com). // @@ -47,13 +47,13 @@ type CreateResolverRuleInput struct { DomainName *string // When you want to forward DNS queries for specified domain name to resolvers on - // your network, specify FORWARD. When you have a forwarding rule to forward DNS + // your network, specify FORWARD . When you have a forwarding rule to forward DNS // queries for a domain to your network and you want Resolver to process queries - // for a subdomain of that domain, specify SYSTEM. For example, to forward DNS + // for a subdomain of that domain, specify SYSTEM . For example, to forward DNS // queries for example.com to resolvers on your network, you create a rule and - // specify FORWARD for RuleType. To then have Resolver process queries for - // apex.example.com, you create a rule and specify SYSTEM for RuleType. Currently, - // only Resolver can create rules that have a value of RECURSIVE for RuleType. + // specify FORWARD for RuleType . To then have Resolver process queries for + // apex.example.com, you create a rule and specify SYSTEM for RuleType . Currently, + // only Resolver can create rules that have a value of RECURSIVE for RuleType . // // This member is required. RuleType types.RuleTypeOption @@ -63,7 +63,7 @@ type CreateResolverRuleInput struct { Name *string // The ID of the outbound Resolver endpoint that you want to use to route DNS - // queries to the IP addresses that you specify in TargetIps. + // queries to the IP addresses that you specify in TargetIps . ResolverEndpointId *string // A list of the tag keys and values that you want to associate with the endpoint. @@ -71,7 +71,7 @@ type CreateResolverRuleInput struct { // The IPs that you want Resolver to forward DNS queries to. You can specify only // IPv4 addresses. Separate IP addresses with a space. TargetIps is available only - // when the value of Rule type is FORWARD. + // when the value of Rule type is FORWARD . TargetIps []types.TargetAddress noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_DeleteResolverEndpoint.go b/service/route53resolver/api_op_DeleteResolverEndpoint.go index 4bc9b8d9d7b..22655be468c 100644 --- a/service/route53resolver/api_op_DeleteResolverEndpoint.go +++ b/service/route53resolver/api_op_DeleteResolverEndpoint.go @@ -13,13 +13,9 @@ import ( // Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends // on whether it's an inbound or an outbound Resolver endpoint: -// -// * Inbound: DNS -// queries from your network are no longer routed to the DNS service for the -// specified VPC. -// -// * Outbound: DNS queries from a VPC are no longer routed to your -// network. +// - Inbound: DNS queries from your network are no longer routed to the DNS +// service for the specified VPC. +// - Outbound: DNS queries from a VPC are no longer routed to your network. func (c *Client) DeleteResolverEndpoint(ctx context.Context, params *DeleteResolverEndpointInput, optFns ...func(*Options)) (*DeleteResolverEndpointOutput, error) { if params == nil { params = &DeleteResolverEndpointInput{} diff --git a/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go b/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go index c13d9e56916..a5453f446eb 100644 --- a/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go @@ -11,20 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a query logging configuration. When you delete a configuration, Resolver -// stops logging DNS queries for all of the Amazon VPCs that are associated with -// the configuration. This also applies if the query logging configuration is -// shared with other Amazon Web Services accounts, and the other accounts have -// associated VPCs with the shared configuration. Before you can delete a query -// logging configuration, you must first disassociate all VPCs from the -// configuration. See DisassociateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html). -// If you used Resource Access Manager (RAM) to share a query logging configuration -// with other accounts, you must stop sharing the configuration before you can -// delete a configuration. The accounts that you shared the configuration with can -// first disassociate VPCs that they associated with the configuration, but that's -// not necessary. If you stop sharing the configuration, those VPCs are -// automatically disassociated from the configuration. +// Deletes a query logging configuration. When you delete a configuration, +// Resolver stops logging DNS queries for all of the Amazon VPCs that are +// associated with the configuration. This also applies if the query logging +// configuration is shared with other Amazon Web Services accounts, and the other +// accounts have associated VPCs with the shared configuration. Before you can +// delete a query logging configuration, you must first disassociate all VPCs from +// the configuration. See DisassociateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html) +// . If you used Resource Access Manager (RAM) to share a query logging +// configuration with other accounts, you must stop sharing the configuration +// before you can delete a configuration. The accounts that you shared the +// configuration with can first disassociate VPCs that they associated with the +// configuration, but that's not necessary. If you stop sharing the configuration, +// those VPCs are automatically disassociated from the configuration. func (c *Client) DeleteResolverQueryLogConfig(ctx context.Context, params *DeleteResolverQueryLogConfigInput, optFns ...func(*Options)) (*DeleteResolverQueryLogConfigOutput, error) { if params == nil { params = &DeleteResolverQueryLogConfigInput{} diff --git a/service/route53resolver/api_op_DeleteResolverRule.go b/service/route53resolver/api_op_DeleteResolverRule.go index ae730ba940b..a75af6c0315 100644 --- a/service/route53resolver/api_op_DeleteResolverRule.go +++ b/service/route53resolver/api_op_DeleteResolverRule.go @@ -13,8 +13,8 @@ import ( // Deletes a Resolver rule. Before you can delete a Resolver rule, you must // disassociate it from all the VPCs that you associated the Resolver rule with. -// For more information, see DisassociateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html). +// For more information, see DisassociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html) +// . func (c *Client) DeleteResolverRule(ctx context.Context, params *DeleteResolverRuleInput, optFns ...func(*Options)) (*DeleteResolverRuleOutput, error) { if params == nil { params = &DeleteResolverRuleInput{} diff --git a/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go b/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go index f0822e6b5a9..100df8a98c1 100644 --- a/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go @@ -30,7 +30,7 @@ func (c *Client) DisassociateFirewallRuleGroup(ctx context.Context, params *Disa type DisassociateFirewallRuleGroupInput struct { - // The identifier of the FirewallRuleGroupAssociation. + // The identifier of the FirewallRuleGroupAssociation . // // This member is required. FirewallRuleGroupAssociationId *string diff --git a/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go b/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go index 9e3a5ad8a7c..6ec641dcc64 100644 --- a/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go +++ b/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go @@ -14,8 +14,8 @@ import ( // Removes IP addresses from an inbound or an outbound Resolver endpoint. If you // want to remove more than one IP address, submit one // DisassociateResolverEndpointIpAddress request for each IP address. To add an IP -// address to an endpoint, see AssociateResolverEndpointIpAddress -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverEndpointIpAddress.html). +// address to an endpoint, see AssociateResolverEndpointIpAddress (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverEndpointIpAddress.html) +// . func (c *Client) DisassociateResolverEndpointIpAddress(ctx context.Context, params *DisassociateResolverEndpointIpAddressInput, optFns ...func(*Options)) (*DisassociateResolverEndpointIpAddressOutput, error) { if params == nil { params = &DisassociateResolverEndpointIpAddressInput{} diff --git a/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go b/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go index aaa768d40dd..1ed655d115a 100644 --- a/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go @@ -16,12 +16,9 @@ import ( // configuration. If you used Resource Access Manager (RAM) to share a query // logging configuration with other accounts, VPCs can be disassociated from the // configuration in the following ways: -// -// * The accounts that you shared the -// configuration with can disassociate VPCs from the configuration. -// -// * You can stop -// sharing the configuration. +// - The accounts that you shared the configuration with can disassociate VPCs +// from the configuration. +// - You can stop sharing the configuration. func (c *Client) DisassociateResolverQueryLogConfig(ctx context.Context, params *DisassociateResolverQueryLogConfigInput, optFns ...func(*Options)) (*DisassociateResolverQueryLogConfigOutput, error) { if params == nil { params = &DisassociateResolverQueryLogConfigInput{} diff --git a/service/route53resolver/api_op_GetFirewallConfig.go b/service/route53resolver/api_op_GetFirewallConfig.go index 83ee7b5cf18..0f80bfbf2af 100644 --- a/service/route53resolver/api_op_GetFirewallConfig.go +++ b/service/route53resolver/api_op_GetFirewallConfig.go @@ -40,8 +40,8 @@ type GetFirewallConfigInput struct { type GetFirewallConfigOutput struct { - // Configuration of the firewall behavior provided by DNS Firewall for a single VPC - // from AmazonVPC. + // Configuration of the firewall behavior provided by DNS Firewall for a single + // VPC from AmazonVPC. FirewallConfig *types.FirewallConfig // Metadata pertaining to the operation's result. diff --git a/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go b/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go index dea7c452a78..b514f11a919 100644 --- a/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go +++ b/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go @@ -31,7 +31,7 @@ func (c *Client) GetFirewallRuleGroupAssociation(ctx context.Context, params *Ge type GetFirewallRuleGroupAssociationInput struct { - // The identifier of the FirewallRuleGroupAssociation. + // The identifier of the FirewallRuleGroupAssociation . // // This member is required. FirewallRuleGroupAssociationId *string diff --git a/service/route53resolver/api_op_GetResolverQueryLogConfig.go b/service/route53resolver/api_op_GetResolverQueryLogConfig.go index dc80c1f2729..af8a9d24907 100644 --- a/service/route53resolver/api_op_GetResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_GetResolverQueryLogConfig.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a specified Resolver query logging configuration, such as -// the number of VPCs that the configuration is logging queries for and the +// Gets information about a specified Resolver query logging configuration, such +// as the number of VPCs that the configuration is logging queries for and the // location that logs are sent to. func (c *Client) GetResolverQueryLogConfig(ctx context.Context, params *GetResolverQueryLogConfigInput, optFns ...func(*Options)) (*GetResolverQueryLogConfigOutput, error) { if params == nil { @@ -42,8 +42,8 @@ type GetResolverQueryLogConfigInput struct { type GetResolverQueryLogConfigOutput struct { - // Information about the Resolver query logging configuration that you specified in - // a GetQueryLogConfig request. + // Information about the Resolver query logging configuration that you specified + // in a GetQueryLogConfig request. ResolverQueryLogConfig *types.ResolverQueryLogConfig // Metadata pertaining to the operation's result. diff --git a/service/route53resolver/api_op_GetResolverRuleAssociation.go b/service/route53resolver/api_op_GetResolverRuleAssociation.go index b7dcb81f6a7..26ce38251a2 100644 --- a/service/route53resolver/api_op_GetResolverRuleAssociation.go +++ b/service/route53resolver/api_op_GetResolverRuleAssociation.go @@ -12,8 +12,8 @@ import ( ) // Gets information about an association between a specified Resolver rule and a -// VPC. You associate a Resolver rule and a VPC using AssociateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html). +// VPC. You associate a Resolver rule and a VPC using AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html) +// . func (c *Client) GetResolverRuleAssociation(ctx context.Context, params *GetResolverRuleAssociationInput, optFns ...func(*Options)) (*GetResolverRuleAssociationOutput, error) { if params == nil { params = &GetResolverRuleAssociationInput{} diff --git a/service/route53resolver/api_op_GetResolverRulePolicy.go b/service/route53resolver/api_op_GetResolverRulePolicy.go index 3195834b7a4..b4d32d2a9e1 100644 --- a/service/route53resolver/api_op_GetResolverRulePolicy.go +++ b/service/route53resolver/api_op_GetResolverRulePolicy.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the Resolver rule policy for a specified rule. A Resolver -// rule policy includes the rule that you want to share with another account, the -// account that you want to share the rule with, and the Resolver operations that -// you want to allow the account to use. +// Gets information about the Resolver rule policy for a specified rule. A +// Resolver rule policy includes the rule that you want to share with another +// account, the account that you want to share the rule with, and the Resolver +// operations that you want to allow the account to use. func (c *Client) GetResolverRulePolicy(ctx context.Context, params *GetResolverRulePolicyInput, optFns ...func(*Options)) (*GetResolverRulePolicyOutput, error) { if params == nil { params = &GetResolverRulePolicyInput{} diff --git a/service/route53resolver/api_op_ImportFirewallDomains.go b/service/route53resolver/api_op_ImportFirewallDomains.go index 9b29130c16b..d21a8e7c03e 100644 --- a/service/route53resolver/api_op_ImportFirewallDomains.go +++ b/service/route53resolver/api_op_ImportFirewallDomains.go @@ -14,15 +14,10 @@ import ( // Imports domain names from a file into a domain list, for use in a DNS firewall // rule group. Each domain specification in your domain list must satisfy the // following requirements: -// -// * It can optionally start with * (asterisk). -// -// * With -// the exception of the optional starting asterisk, it must only contain the -// following characters: A-Z, a-z, 0-9, - (hyphen). -// -// * It must be from 1-255 -// characters in length. +// - It can optionally start with * (asterisk). +// - With the exception of the optional starting asterisk, it must only contain +// the following characters: A-Z , a-z , 0-9 , - (hyphen). +// - It must be from 1-255 characters in length. func (c *Client) ImportFirewallDomains(ctx context.Context, params *ImportFirewallDomainsInput, optFns ...func(*Options)) (*ImportFirewallDomainsOutput, error) { if params == nil { params = &ImportFirewallDomainsInput{} @@ -54,7 +49,7 @@ type ImportFirewallDomainsInput struct { FirewallDomainListId *string // What you want DNS Firewall to do with the domains that are listed in the file. - // This must be set to REPLACE, which updates the domain list to exactly match the + // This must be set to REPLACE , which updates the domain list to exactly match the // list in the file. // // This member is required. diff --git a/service/route53resolver/api_op_ListFirewallConfigs.go b/service/route53resolver/api_op_ListFirewallConfigs.go index b29c7ce5568..5ea0dbb6403 100644 --- a/service/route53resolver/api_op_ListFirewallConfigs.go +++ b/service/route53resolver/api_op_ListFirewallConfigs.go @@ -15,7 +15,7 @@ import ( // Retrieves the firewall configurations that you have defined. DNS Firewall uses // the configurations to manage firewall behavior for your VPCs. A single call // might return only a partial list of the configurations. For information, see -// MaxResults. +// MaxResults . func (c *Client) ListFirewallConfigs(ctx context.Context, params *ListFirewallConfigsInput, optFns ...func(*Options)) (*ListFirewallConfigsOutput, error) { if params == nil { params = &ListFirewallConfigsInput{} @@ -33,15 +33,16 @@ func (c *Client) ListFirewallConfigs(ctx context.Context, params *ListFirewallCo type ListFirewallConfigsInput struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -55,9 +56,9 @@ type ListFirewallConfigsOutput struct { // from Amazon Virtual Private Cloud (Amazon VPC). FirewallConfigs []types.FirewallConfig - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -126,8 +127,8 @@ func (c *Client) addOperationListFirewallConfigsMiddlewares(stack *middleware.St return nil } -// ListFirewallConfigsAPIClient is a client that implements the ListFirewallConfigs -// operation. +// ListFirewallConfigsAPIClient is a client that implements the +// ListFirewallConfigs operation. type ListFirewallConfigsAPIClient interface { ListFirewallConfigs(context.Context, *ListFirewallConfigsInput, ...func(*Options)) (*ListFirewallConfigsOutput, error) } @@ -137,10 +138,11 @@ var _ ListFirewallConfigsAPIClient = (*Client)(nil) // ListFirewallConfigsPaginatorOptions is the paginator options for // ListFirewallConfigs type ListFirewallConfigsPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListFirewallDomainLists.go b/service/route53resolver/api_op_ListFirewallDomainLists.go index e8fc04ad30e..e66832b7793 100644 --- a/service/route53resolver/api_op_ListFirewallDomainLists.go +++ b/service/route53resolver/api_op_ListFirewallDomainLists.go @@ -14,8 +14,8 @@ import ( // Retrieves the firewall domain lists that you have defined. For each firewall // domain list, you can retrieve the domains that are defined for a list by calling -// ListFirewallDomains. A single call to this list operation might return only a -// partial list of the domain lists. For information, see MaxResults. +// ListFirewallDomains . A single call to this list operation might return only a +// partial list of the domain lists. For information, see MaxResults . func (c *Client) ListFirewallDomainLists(ctx context.Context, params *ListFirewallDomainListsInput, optFns ...func(*Options)) (*ListFirewallDomainListsOutput, error) { if params == nil { params = &ListFirewallDomainListsInput{} @@ -33,15 +33,16 @@ func (c *Client) ListFirewallDomainLists(ctx context.Context, params *ListFirewa type ListFirewallDomainListsInput struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -52,12 +53,12 @@ type ListFirewallDomainListsInput struct { type ListFirewallDomainListsOutput struct { // A list of the domain lists that you have defined. This might be a partial list - // of the domain lists that you've defined. For information, see MaxResults. + // of the domain lists that you've defined. For information, see MaxResults . FirewallDomainLists []types.FirewallDomainListMetadata - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -137,10 +138,11 @@ var _ ListFirewallDomainListsAPIClient = (*Client)(nil) // ListFirewallDomainListsPaginatorOptions is the paginator options for // ListFirewallDomainLists type ListFirewallDomainListsPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListFirewallDomains.go b/service/route53resolver/api_op_ListFirewallDomains.go index f7ef3ef2ef8..7bc56b91dc0 100644 --- a/service/route53resolver/api_op_ListFirewallDomains.go +++ b/service/route53resolver/api_op_ListFirewallDomains.go @@ -13,7 +13,7 @@ import ( // Retrieves the domains that you have defined for the specified firewall domain // list. A single call might return only a partial list of the domains. For -// information, see MaxResults. +// information, see MaxResults . func (c *Client) ListFirewallDomains(ctx context.Context, params *ListFirewallDomainsInput, optFns ...func(*Options)) (*ListFirewallDomainsOutput, error) { if params == nil { params = &ListFirewallDomainsInput{} @@ -36,15 +36,16 @@ type ListFirewallDomainsInput struct { // This member is required. FirewallDomainListId *string - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -56,12 +57,12 @@ type ListFirewallDomainsOutput struct { // A list of the domains in the firewall domain list. This might be a partial list // of the domains that you've defined in the domain list. For information, see - // MaxResults. + // MaxResults . Domains []string - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -133,8 +134,8 @@ func (c *Client) addOperationListFirewallDomainsMiddlewares(stack *middleware.St return nil } -// ListFirewallDomainsAPIClient is a client that implements the ListFirewallDomains -// operation. +// ListFirewallDomainsAPIClient is a client that implements the +// ListFirewallDomains operation. type ListFirewallDomainsAPIClient interface { ListFirewallDomains(context.Context, *ListFirewallDomainsInput, ...func(*Options)) (*ListFirewallDomainsOutput, error) } @@ -144,10 +145,11 @@ var _ ListFirewallDomainsAPIClient = (*Client)(nil) // ListFirewallDomainsPaginatorOptions is the paginator options for // ListFirewallDomains type ListFirewallDomainsPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go b/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go index bf753e33102..05b33fb07df 100644 --- a/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go +++ b/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go @@ -15,7 +15,7 @@ import ( // Retrieves the firewall rule group associations that you have defined. Each // association enables DNS filtering for a VPC with one rule group. A single call // might return only a partial list of the associations. For information, see -// MaxResults. +// MaxResults . func (c *Client) ListFirewallRuleGroupAssociations(ctx context.Context, params *ListFirewallRuleGroupAssociationsInput, optFns ...func(*Options)) (*ListFirewallRuleGroupAssociationsOutput, error) { if params == nil { params = &ListFirewallRuleGroupAssociationsInput{} @@ -37,15 +37,16 @@ type ListFirewallRuleGroupAssociationsInput struct { // associations for. Leave this blank to retrieve associations for any rule group. FirewallRuleGroupId *string - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -60,8 +61,8 @@ type ListFirewallRuleGroupAssociationsInput struct { // regardless of status. Status types.FirewallRuleGroupAssociationStatus - // The unique identifier of the VPC that you want to retrieve the associations for. - // Leave this blank to retrieve associations for any VPC. + // The unique identifier of the VPC that you want to retrieve the associations + // for. Leave this blank to retrieve associations for any VPC. VpcId *string noSmithyDocumentSerde @@ -69,13 +70,13 @@ type ListFirewallRuleGroupAssociationsInput struct { type ListFirewallRuleGroupAssociationsOutput struct { - // A list of your firewall rule group associations. This might be a partial list of - // the associations that you have defined. For information, see MaxResults. + // A list of your firewall rule group associations. This might be a partial list + // of the associations that you have defined. For information, see MaxResults . FirewallRuleGroupAssociations []types.FirewallRuleGroupAssociation - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -155,10 +156,11 @@ var _ ListFirewallRuleGroupAssociationsAPIClient = (*Client)(nil) // ListFirewallRuleGroupAssociationsPaginatorOptions is the paginator options for // ListFirewallRuleGroupAssociations type ListFirewallRuleGroupAssociationsPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListFirewallRuleGroups.go b/service/route53resolver/api_op_ListFirewallRuleGroups.go index e8de8677b7f..f62af2967d6 100644 --- a/service/route53resolver/api_op_ListFirewallRuleGroups.go +++ b/service/route53resolver/api_op_ListFirewallRuleGroups.go @@ -14,7 +14,7 @@ import ( // Retrieves the minimal high-level information for the rule groups that you have // defined. A single call might return only a partial list of the rule groups. For -// information, see MaxResults. +// information, see MaxResults . func (c *Client) ListFirewallRuleGroups(ctx context.Context, params *ListFirewallRuleGroupsInput, optFns ...func(*Options)) (*ListFirewallRuleGroupsOutput, error) { if params == nil { params = &ListFirewallRuleGroupsInput{} @@ -32,15 +32,16 @@ func (c *Client) ListFirewallRuleGroups(ctx context.Context, params *ListFirewal type ListFirewallRuleGroupsInput struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -51,12 +52,12 @@ type ListFirewallRuleGroupsInput struct { type ListFirewallRuleGroupsOutput struct { // A list of your firewall rule groups. This might be a partial list of the rule - // groups that you have defined. For information, see MaxResults. + // groups that you have defined. For information, see MaxResults . FirewallRuleGroups []types.FirewallRuleGroupMetadata - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -136,10 +137,11 @@ var _ ListFirewallRuleGroupsAPIClient = (*Client)(nil) // ListFirewallRuleGroupsPaginatorOptions is the paginator options for // ListFirewallRuleGroups type ListFirewallRuleGroupsPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListFirewallRules.go b/service/route53resolver/api_op_ListFirewallRules.go index 890e5bef05f..c84f9402710 100644 --- a/service/route53resolver/api_op_ListFirewallRules.go +++ b/service/route53resolver/api_op_ListFirewallRules.go @@ -15,7 +15,7 @@ import ( // Retrieves the firewall rules that you have defined for the specified firewall // rule group. DNS Firewall uses the rules in a rule group to filter DNS network // traffic for a VPC. A single call might return only a partial list of the rules. -// For information, see MaxResults. +// For information, see MaxResults . func (c *Client) ListFirewallRules(ctx context.Context, params *ListFirewallRulesInput, optFns ...func(*Options)) (*ListFirewallRulesOutput, error) { if params == nil { params = &ListFirewallRulesInput{} @@ -42,26 +42,22 @@ type ListFirewallRulesInput struct { // Optional additional filter for the rules to retrieve. The action that DNS // Firewall should take on a DNS query when it matches one of the domains in the // rule's domain list: - // - // * ALLOW - Permit the request to go through. - // - // * ALERT - - // Permit the request to go through but send an alert to the logs. - // - // * BLOCK - - // Disallow the request. If this is specified, additional handling details are - // provided in the rule's BlockResponse setting. + // - ALLOW - Permit the request to go through. + // - ALERT - Permit the request to go through but send an alert to the logs. + // - BLOCK - Disallow the request. If this is specified, additional handling + // details are provided in the rule's BlockResponse setting. Action types.Action - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. MaxResults *int32 // For the first call to this list request, omit this value. When you request a // list of objects, Resolver returns at most the number of objects specified in - // MaxResults. If more objects are available for retrieval, Resolver returns a + // MaxResults . If more objects are available for retrieval, Resolver returns a // NextToken value in the response. To retrieve the next batch of objects, use the // token that was returned for the prior request in your next request. NextToken *string @@ -78,12 +74,12 @@ type ListFirewallRulesInput struct { type ListFirewallRulesOutput struct { // A list of the rules that you have defined. This might be a partial list of the - // firewall rules that you've defined. For information, see MaxResults. + // firewall rules that you've defined. For information, see MaxResults . FirewallRules []types.FirewallRule - // If objects are still available for retrieval, Resolver returns this token in the - // response. To retrieve the next batch of objects, provide this token in your next - // request. + // If objects are still available for retrieval, Resolver returns this token in + // the response. To retrieve the next batch of objects, provide this token in your + // next request. NextToken *string // Metadata pertaining to the operation's result. @@ -165,10 +161,11 @@ var _ ListFirewallRulesAPIClient = (*Client)(nil) // ListFirewallRulesPaginatorOptions is the paginator options for ListFirewallRules type ListFirewallRulesPaginatorOptions struct { - // The maximum number of objects that you want Resolver to return for this request. - // If more objects are available, in the response, Resolver provides a NextToken - // value that you can use in a subsequent call to get the next batch of objects. If - // you don't specify a value for MaxResults, Resolver returns up to 100 objects. + // The maximum number of objects that you want Resolver to return for this + // request. If more objects are available, in the response, Resolver provides a + // NextToken value that you can use in a subsequent call to get the next batch of + // objects. If you don't specify a value for MaxResults , Resolver returns up to + // 100 objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverConfigs.go b/service/route53resolver/api_op_ListResolverConfigs.go index 7e42b2fadfc..ec0c30e9609 100644 --- a/service/route53resolver/api_op_ListResolverConfigs.go +++ b/service/route53resolver/api_op_ListResolverConfigs.go @@ -33,12 +33,12 @@ type ListResolverConfigsInput struct { // The maximum number of Resolver configurations that you want to return in the // response to a ListResolverConfigs request. If you don't specify a value for - // MaxResults, up to 100 Resolver configurations are returned. + // MaxResults , up to 100 Resolver configurations are returned. MaxResults *int32 // (Optional) If the current Amazon Web Services account has more than MaxResults - // Resolver configurations, use NextToken to get the second and subsequent pages of - // results. For the first ListResolverConfigs request, omit this value. For the + // Resolver configurations, use NextToken to get the second and subsequent pages + // of results. For the first ListResolverConfigs request, omit this value. For the // second and subsequent requests, get the value of NextToken from the previous // response and specify that value for NextToken in the request. NextToken *string @@ -127,8 +127,8 @@ func (c *Client) addOperationListResolverConfigsMiddlewares(stack *middleware.St return nil } -// ListResolverConfigsAPIClient is a client that implements the ListResolverConfigs -// operation. +// ListResolverConfigsAPIClient is a client that implements the +// ListResolverConfigs operation. type ListResolverConfigsAPIClient interface { ListResolverConfigs(context.Context, *ListResolverConfigsInput, ...func(*Options)) (*ListResolverConfigsOutput, error) } @@ -140,7 +140,7 @@ var _ ListResolverConfigsAPIClient = (*Client)(nil) type ListResolverConfigsPaginatorOptions struct { // The maximum number of Resolver configurations that you want to return in the // response to a ListResolverConfigs request. If you don't specify a value for - // MaxResults, up to 100 Resolver configurations are returned. + // MaxResults , up to 100 Resolver configurations are returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverDnssecConfigs.go b/service/route53resolver/api_op_ListResolverDnssecConfigs.go index f4cb7ead8af..3961b437b8f 100644 --- a/service/route53resolver/api_op_ListResolverDnssecConfigs.go +++ b/service/route53resolver/api_op_ListResolverDnssecConfigs.go @@ -36,14 +36,14 @@ type ListResolverDnssecConfigsInput struct { // Optional: An integer that specifies the maximum number of DNSSEC configuration // results that you want Amazon Route 53 to return. If you don't specify a value - // for MaxResults, Route 53 returns up to 100 configuration per page. + // for MaxResults , Route 53 returns up to 100 configuration per page. MaxResults *int32 // (Optional) If the current Amazon Web Services account has more than MaxResults // DNSSEC configurations, use NextToken to get the second and subsequent pages of // results. For the first ListResolverDnssecConfigs request, omit this value. For - // the second and subsequent requests, get the value of NextToken from the previous - // response and specify that value for NextToken in the request. + // the second and subsequent requests, get the value of NextToken from the + // previous response and specify that value for NextToken in the request. NextToken *string noSmithyDocumentSerde @@ -51,17 +51,16 @@ type ListResolverDnssecConfigsInput struct { type ListResolverDnssecConfigsOutput struct { - // If a response includes the last of the DNSSEC configurations that are associated - // with the current Amazon Web Services account, NextToken doesn't appear in the - // response. If a response doesn't include the last of the configurations, you can - // get more configurations by submitting another ListResolverDnssecConfigs - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListResolverDnssecConfigs.html) + // If a response includes the last of the DNSSEC configurations that are + // associated with the current Amazon Web Services account, NextToken doesn't + // appear in the response. If a response doesn't include the last of the + // configurations, you can get more configurations by submitting another + // ListResolverDnssecConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListResolverDnssecConfigs.html) // request. Get the value of NextToken that Amazon Route 53 returned in the // previous response and include it in NextToken in the next request. NextToken *string - // An array that contains one ResolverDnssecConfig - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResolverDnssecConfig.html) + // An array that contains one ResolverDnssecConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResolverDnssecConfig.html) // element for each configuration for DNSSEC validation that is associated with the // current Amazon Web Services account. ResolverDnssecConfigs []types.ResolverDnssecConfig @@ -145,7 +144,7 @@ var _ ListResolverDnssecConfigsAPIClient = (*Client)(nil) type ListResolverDnssecConfigsPaginatorOptions struct { // Optional: An integer that specifies the maximum number of DNSSEC configuration // results that you want Amazon Route 53 to return. If you don't specify a value - // for MaxResults, Route 53 returns up to 100 configuration per page. + // for MaxResults , Route 53 returns up to 100 configuration per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go index 9124131c9b6..deed11c0452 100644 --- a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go +++ b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go @@ -37,7 +37,7 @@ type ListResolverEndpointIpAddressesInput struct { // The maximum number of IP addresses that you want to return in the response to a // ListResolverEndpointIpAddresses request. If you don't specify a value for - // MaxResults, Resolver returns up to 100 IP addresses. + // MaxResults , Resolver returns up to 100 IP addresses. MaxResults *int32 // For the first ListResolverEndpointIpAddresses request, omit this value. If the @@ -62,8 +62,8 @@ type ListResolverEndpointIpAddressesOutput struct { // If the specified endpoint has more than MaxResults IP addresses, you can submit // another ListResolverEndpointIpAddresses request to get the next group of IP - // addresses. In the next request, specify the value of NextToken from the previous - // response. + // addresses. In the next request, specify the value of NextToken from the + // previous response. NextToken *string // Metadata pertaining to the operation's result. @@ -148,7 +148,7 @@ var _ ListResolverEndpointIpAddressesAPIClient = (*Client)(nil) type ListResolverEndpointIpAddressesPaginatorOptions struct { // The maximum number of IP addresses that you want to return in the response to a // ListResolverEndpointIpAddresses request. If you don't specify a value for - // MaxResults, Resolver returns up to 100 IP addresses. + // MaxResults , Resolver returns up to 100 IP addresses. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverEndpoints.go b/service/route53resolver/api_op_ListResolverEndpoints.go index 7cda39f688a..37dbcbd203c 100644 --- a/service/route53resolver/api_op_ListResolverEndpoints.go +++ b/service/route53resolver/api_op_ListResolverEndpoints.go @@ -34,12 +34,12 @@ type ListResolverEndpointsInput struct { // An optional specification to return a subset of Resolver endpoints, such as all // inbound Resolver endpoints. If you submit a second or subsequent // ListResolverEndpoints request and specify the NextToken parameter, you must use - // the same values for Filters, if any, as in the previous request. + // the same values for Filters , if any, as in the previous request. Filters []types.Filter - // The maximum number of Resolver endpoints that you want to return in the response - // to a ListResolverEndpoints request. If you don't specify a value for MaxResults, - // Resolver returns up to 100 Resolver endpoints. + // The maximum number of Resolver endpoints that you want to return in the + // response to a ListResolverEndpoints request. If you don't specify a value for + // MaxResults , Resolver returns up to 100 Resolver endpoints. MaxResults *int32 // For the first ListResolverEndpoints request, omit this value. If you have more @@ -57,8 +57,8 @@ type ListResolverEndpointsOutput struct { MaxResults *int32 // If more than MaxResults IP addresses match the specified criteria, you can - // submit another ListResolverEndpoint request to get the next group of results. In - // the next request, specify the value of NextToken from the previous response. + // submit another ListResolverEndpoint request to get the next group of results. + // In the next request, specify the value of NextToken from the previous response. NextToken *string // The Resolver endpoints that were created by using the current Amazon Web @@ -142,9 +142,9 @@ var _ ListResolverEndpointsAPIClient = (*Client)(nil) // ListResolverEndpointsPaginatorOptions is the paginator options for // ListResolverEndpoints type ListResolverEndpointsPaginatorOptions struct { - // The maximum number of Resolver endpoints that you want to return in the response - // to a ListResolverEndpoints request. If you don't specify a value for MaxResults, - // Resolver returns up to 100 Resolver endpoints. + // The maximum number of Resolver endpoints that you want to return in the + // response to a ListResolverEndpoints request. If you don't specify a value for + // MaxResults , Resolver returns up to 100 Resolver endpoints. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go b/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go index 44c647dbcf3..2a25c49fbcb 100644 --- a/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go +++ b/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go @@ -32,82 +32,59 @@ func (c *Client) ListResolverQueryLogConfigAssociations(ctx context.Context, par type ListResolverQueryLogConfigAssociationsInput struct { // An optional specification to return a subset of query logging associations. If - // you submit a second or subsequent ListResolverQueryLogConfigAssociations request - // and specify the NextToken parameter, you must use the same values for Filters, - // if any, as in the previous request. + // you submit a second or subsequent ListResolverQueryLogConfigAssociations + // request and specify the NextToken parameter, you must use the same values for + // Filters , if any, as in the previous request. Filters []types.Filter // The maximum number of query logging associations that you want to return in the // response to a ListResolverQueryLogConfigAssociations request. If you don't - // specify a value for MaxResults, Resolver returns up to 100 query logging + // specify a value for MaxResults , Resolver returns up to 100 query logging // associations. MaxResults *int32 // For the first ListResolverQueryLogConfigAssociations request, omit this value. // If there are more than MaxResults query logging associations that match the - // values that you specify for Filters, you can submit another + // values that you specify for Filters , you can submit another // ListResolverQueryLogConfigAssociations request to get the next group of // associations. In the next request, specify the value of NextToken from the // previous response. NextToken *string - // The element that you want Resolver to sort query logging associations by. If you - // submit a second or subsequent ListResolverQueryLogConfigAssociations request and - // specify the NextToken parameter, you must use the same value for SortBy, if any, - // as in the previous request. Valid values include the following elements: - // - // * - // CreationTime: The ID of the query logging association. - // - // * Error: If the value of - // Status is FAILED, the value of Error indicates the cause: - // - // * - // DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 - // bucket) was deleted. - // - // * ACCESS_DENIED: Permissions don't allow sending logs to - // the destination. - // - // If Status is a value other than FAILED, ERROR is null. - // - // * Id: - // The ID of the query logging association - // - // * ResolverQueryLogConfigId: The ID of - // the query logging configuration - // - // * ResourceId: The ID of the VPC that is - // associated with the query logging configuration - // - // * Status: The current status of - // the configuration. Valid values include the following: - // - // * CREATING: Resolver is - // creating an association between an Amazon VPC and a query logging - // configuration. - // - // * CREATED: The association between an Amazon VPC and a query - // logging configuration was successfully created. Resolver is logging queries that - // originate in the specified VPC. - // - // * DELETING: Resolver is deleting this query - // logging association. - // - // * FAILED: Resolver either couldn't create or couldn't - // delete the query logging association. Here are two common causes: - // - // * The - // specified destination (for example, an Amazon S3 bucket) was deleted. - // - // * - // Permissions don't allow sending logs to the destination. + // The element that you want Resolver to sort query logging associations by. If + // you submit a second or subsequent ListResolverQueryLogConfigAssociations + // request and specify the NextToken parameter, you must use the same value for + // SortBy , if any, as in the previous request. Valid values include the following + // elements: + // - CreationTime : The ID of the query logging association. + // - Error : If the value of Status is FAILED , the value of Error indicates the + // cause: + // - DESTINATION_NOT_FOUND : The specified destination (for example, an Amazon S3 + // bucket) was deleted. + // - ACCESS_DENIED : Permissions don't allow sending logs to the destination. If + // Status is a value other than FAILED , ERROR is null. + // - Id : The ID of the query logging association + // - ResolverQueryLogConfigId : The ID of the query logging configuration + // - ResourceId : The ID of the VPC that is associated with the query logging + // configuration + // - Status : The current status of the configuration. Valid values include the + // following: + // - CREATING : Resolver is creating an association between an Amazon VPC and a + // query logging configuration. + // - CREATED : The association between an Amazon VPC and a query logging + // configuration was successfully created. Resolver is logging queries that + // originate in the specified VPC. + // - DELETING : Resolver is deleting this query logging association. + // - FAILED : Resolver either couldn't create or couldn't delete the query + // logging association. Here are two common causes: + // - The specified destination (for example, an Amazon S3 bucket) was deleted. + // - Permissions don't allow sending logs to the destination. SortBy *string - // If you specified a value for SortBy, the order that you want query logging - // associations to be listed in, ASCENDING or DESCENDING. If you submit a second or - // subsequent ListResolverQueryLogConfigAssociations request and specify the - // NextToken parameter, you must use the same value for SortOrder, if any, as in + // If you specified a value for SortBy , the order that you want query logging + // associations to be listed in, ASCENDING or DESCENDING . If you submit a second + // or subsequent ListResolverQueryLogConfigAssociations request and specify the + // NextToken parameter, you must use the same value for SortOrder , if any, as in // the previous request. SortOrder types.SortOrder @@ -123,7 +100,7 @@ type ListResolverQueryLogConfigAssociationsOutput struct { NextToken *string // A list that contains one ResolverQueryLogConfigAssociations element for each - // query logging association that matches the values that you specified for Filter. + // query logging association that matches the values that you specified for Filter . ResolverQueryLogConfigAssociations []types.ResolverQueryLogConfigAssociation // The total number of query logging associations that were created by the current @@ -136,7 +113,7 @@ type ListResolverQueryLogConfigAssociationsOutput struct { // account in the specified Region and that match the filters that were specified // in the ListResolverQueryLogConfigAssociations request. For the total number of // associations that were created by the current account in the specified Region, - // see TotalCount. + // see TotalCount . TotalFilteredCount int32 // Metadata pertaining to the operation's result. @@ -218,7 +195,7 @@ var _ ListResolverQueryLogConfigAssociationsAPIClient = (*Client)(nil) type ListResolverQueryLogConfigAssociationsPaginatorOptions struct { // The maximum number of query logging associations that you want to return in the // response to a ListResolverQueryLogConfigAssociations request. If you don't - // specify a value for MaxResults, Resolver returns up to 100 query logging + // specify a value for MaxResults , Resolver returns up to 100 query logging // associations. Limit int32 diff --git a/service/route53resolver/api_op_ListResolverQueryLogConfigs.go b/service/route53resolver/api_op_ListResolverQueryLogConfigs.go index 93e1f64a27e..84cc1e49b60 100644 --- a/service/route53resolver/api_op_ListResolverQueryLogConfigs.go +++ b/service/route53resolver/api_op_ListResolverQueryLogConfigs.go @@ -32,86 +32,60 @@ func (c *Client) ListResolverQueryLogConfigs(ctx context.Context, params *ListRe type ListResolverQueryLogConfigsInput struct { - // An optional specification to return a subset of query logging configurations. If - // you submit a second or subsequent ListResolverQueryLogConfigs request and - // specify the NextToken parameter, you must use the same values for Filters, if + // An optional specification to return a subset of query logging configurations. + // If you submit a second or subsequent ListResolverQueryLogConfigs request and + // specify the NextToken parameter, you must use the same values for Filters , if // any, as in the previous request. Filters []types.Filter // The maximum number of query logging configurations that you want to return in // the response to a ListResolverQueryLogConfigs request. If you don't specify a - // value for MaxResults, Resolver returns up to 100 query logging configurations. + // value for MaxResults , Resolver returns up to 100 query logging configurations. MaxResults *int32 - // For the first ListResolverQueryLogConfigs request, omit this value. If there are - // more than MaxResults query logging configurations that match the values that you - // specify for Filters, you can submit another ListResolverQueryLogConfigs request - // to get the next group of configurations. In the next request, specify the value - // of NextToken from the previous response. + // For the first ListResolverQueryLogConfigs request, omit this value. If there + // are more than MaxResults query logging configurations that match the values + // that you specify for Filters , you can submit another + // ListResolverQueryLogConfigs request to get the next group of configurations. In + // the next request, specify the value of NextToken from the previous response. NextToken *string // The element that you want Resolver to sort query logging configurations by. If // you submit a second or subsequent ListResolverQueryLogConfigs request and - // specify the NextToken parameter, you must use the same value for SortBy, if any, - // as in the previous request. Valid values include the following elements: - // - // * Arn: - // The ARN of the query logging configuration - // - // * AssociationCount: The number of - // VPCs that are associated with the specified configuration - // - // * CreationTime: The - // date and time that Resolver returned when the configuration was created - // - // * - // CreatorRequestId: The value that was specified for CreatorRequestId when the - // configuration was created - // - // * DestinationArn: The location that logs are sent - // to - // - // * Id: The ID of the configuration - // - // * Name: The name of the configuration - // - // * - // OwnerId: The Amazon Web Services account number of the account that created the - // configuration - // - // * ShareStatus: Whether the configuration is shared with other - // Amazon Web Services accounts or shared with the current account by another - // Amazon Web Services account. Sharing is configured through Resource Access - // Manager (RAM). - // - // * Status: The current status of the configuration. Valid values - // include the following: - // - // * CREATING: Resolver is creating the query logging - // configuration. - // - // * CREATED: The query logging configuration was successfully - // created. Resolver is logging queries that originate in the specified VPC. - // - // * - // DELETING: Resolver is deleting this query logging configuration. - // - // * FAILED: - // Resolver either couldn't create or couldn't delete the query logging - // configuration. Here are two common causes: - // - // * The specified destination (for - // example, an Amazon S3 bucket) was deleted. - // - // * Permissions don't allow sending - // logs to the destination. + // specify the NextToken parameter, you must use the same value for SortBy , if + // any, as in the previous request. Valid values include the following elements: + // - Arn : The ARN of the query logging configuration + // - AssociationCount : The number of VPCs that are associated with the specified + // configuration + // - CreationTime : The date and time that Resolver returned when the + // configuration was created + // - CreatorRequestId : The value that was specified for CreatorRequestId when + // the configuration was created + // - DestinationArn : The location that logs are sent to + // - Id : The ID of the configuration + // - Name : The name of the configuration + // - OwnerId : The Amazon Web Services account number of the account that created + // the configuration + // - ShareStatus : Whether the configuration is shared with other Amazon Web + // Services accounts or shared with the current account by another Amazon Web + // Services account. Sharing is configured through Resource Access Manager (RAM). + // - Status : The current status of the configuration. Valid values include the + // following: + // - CREATING : Resolver is creating the query logging configuration. + // - CREATED : The query logging configuration was successfully created. Resolver + // is logging queries that originate in the specified VPC. + // - DELETING : Resolver is deleting this query logging configuration. + // - FAILED : Resolver either couldn't create or couldn't delete the query + // logging configuration. Here are two common causes: + // - The specified destination (for example, an Amazon S3 bucket) was deleted. + // - Permissions don't allow sending logs to the destination. SortBy *string - // If you specified a value for SortBy, the order that you want query logging - // configurations to be listed in, ASCENDING or DESCENDING. If you submit a second + // If you specified a value for SortBy , the order that you want query logging + // configurations to be listed in, ASCENDING or DESCENDING . If you submit a second // or subsequent ListResolverQueryLogConfigs request and specify the NextToken - // parameter, you must use the same value for SortOrder, if any, as in the previous - // request. + // parameter, you must use the same value for SortOrder , if any, as in the + // previous request. SortOrder types.SortOrder noSmithyDocumentSerde @@ -126,7 +100,7 @@ type ListResolverQueryLogConfigsOutput struct { NextToken *string // A list that contains one ResolverQueryLogConfig element for each query logging - // configuration that matches the values that you specified for Filter. + // configuration that matches the values that you specified for Filter . ResolverQueryLogConfigs []types.ResolverQueryLogConfig // The total number of query logging configurations that were created by the @@ -140,7 +114,7 @@ type ListResolverQueryLogConfigsOutput struct { // current account in the specified Region and that match the filters that were // specified in the ListResolverQueryLogConfigs request. For the total number of // query logging configurations that were created by the current account in the - // specified Region, see TotalCount. + // specified Region, see TotalCount . TotalFilteredCount int32 // Metadata pertaining to the operation's result. @@ -222,7 +196,7 @@ var _ ListResolverQueryLogConfigsAPIClient = (*Client)(nil) type ListResolverQueryLogConfigsPaginatorOptions struct { // The maximum number of query logging configurations that you want to return in // the response to a ListResolverQueryLogConfigs request. If you don't specify a - // value for MaxResults, Resolver returns up to 100 query logging configurations. + // value for MaxResults , Resolver returns up to 100 query logging configurations. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverRuleAssociations.go b/service/route53resolver/api_op_ListResolverRuleAssociations.go index b856fa1e851..872de72ac8d 100644 --- a/service/route53resolver/api_op_ListResolverRuleAssociations.go +++ b/service/route53resolver/api_op_ListResolverRuleAssociations.go @@ -31,16 +31,16 @@ func (c *Client) ListResolverRuleAssociations(ctx context.Context, params *ListR type ListResolverRuleAssociationsInput struct { - // An optional specification to return a subset of Resolver rules, such as Resolver - // rules that are associated with the same VPC ID. If you submit a second or - // subsequent ListResolverRuleAssociations request and specify the NextToken - // parameter, you must use the same values for Filters, if any, as in the previous + // An optional specification to return a subset of Resolver rules, such as + // Resolver rules that are associated with the same VPC ID. If you submit a second + // or subsequent ListResolverRuleAssociations request and specify the NextToken + // parameter, you must use the same values for Filters , if any, as in the previous // request. Filters []types.Filter // The maximum number of rule associations that you want to return in the response // to a ListResolverRuleAssociations request. If you don't specify a value for - // MaxResults, Resolver returns up to 100 rule associations. + // MaxResults , Resolver returns up to 100 rule associations. MaxResults *int32 // For the first ListResolverRuleAssociation request, omit this value. If you have @@ -147,7 +147,7 @@ var _ ListResolverRuleAssociationsAPIClient = (*Client)(nil) type ListResolverRuleAssociationsPaginatorOptions struct { // The maximum number of rule associations that you want to return in the response // to a ListResolverRuleAssociations request. If you don't specify a value for - // MaxResults, Resolver returns up to 100 rule associations. + // MaxResults , Resolver returns up to 100 rule associations. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53resolver/api_op_ListResolverRules.go b/service/route53resolver/api_op_ListResolverRules.go index d0318808668..6804637515a 100644 --- a/service/route53resolver/api_op_ListResolverRules.go +++ b/service/route53resolver/api_op_ListResolverRules.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Resolver rules that were created using the current Amazon Web Services -// account. +// Lists the Resolver rules that were created using the current Amazon Web +// Services account. func (c *Client) ListResolverRules(ctx context.Context, params *ListResolverRulesInput, optFns ...func(*Options)) (*ListResolverRulesOutput, error) { if params == nil { params = &ListResolverRulesInput{} @@ -34,12 +34,12 @@ type ListResolverRulesInput struct { // An optional specification to return a subset of Resolver rules, such as all // Resolver rules that are associated with the same Resolver endpoint. If you // submit a second or subsequent ListResolverRules request and specify the - // NextToken parameter, you must use the same values for Filters, if any, as in the - // previous request. + // NextToken parameter, you must use the same values for Filters , if any, as in + // the previous request. Filters []types.Filter // The maximum number of Resolver rules that you want to return in the response to - // a ListResolverRules request. If you don't specify a value for MaxResults, + // a ListResolverRules request. If you don't specify a value for MaxResults , // Resolver returns up to 100 Resolver rules. MaxResults *int32 @@ -143,7 +143,7 @@ var _ ListResolverRulesAPIClient = (*Client)(nil) // ListResolverRulesPaginatorOptions is the paginator options for ListResolverRules type ListResolverRulesPaginatorOptions struct { // The maximum number of Resolver rules that you want to return in the response to - // a ListResolverRules request. If you don't specify a value for MaxResults, + // a ListResolverRules request. If you don't specify a value for MaxResults , // Resolver returns up to 100 Resolver rules. Limit int32 diff --git a/service/route53resolver/api_op_ListTagsForResource.go b/service/route53resolver/api_op_ListTagsForResource.go index 3ce25fda3a6..549755d9876 100644 --- a/service/route53resolver/api_op_ListTagsForResource.go +++ b/service/route53resolver/api_op_ListTagsForResource.go @@ -36,7 +36,7 @@ type ListTagsForResourceInput struct { ResourceArn *string // The maximum number of tags that you want to return in the response to a - // ListTagsForResource request. If you don't specify a value for MaxResults, + // ListTagsForResource request. If you don't specify a value for MaxResults , // Resolver returns up to 100 tags. MaxResults *int32 @@ -129,8 +129,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } @@ -141,7 +141,7 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) // ListTagsForResource type ListTagsForResourcePaginatorOptions struct { // The maximum number of tags that you want to return in the response to a - // ListTagsForResource request. If you don't specify a value for MaxResults, + // ListTagsForResource request. If you don't specify a value for MaxResults , // Resolver returns up to 100 tags. Limit int32 diff --git a/service/route53resolver/api_op_PutFirewallRuleGroupPolicy.go b/service/route53resolver/api_op_PutFirewallRuleGroupPolicy.go index 676bb00fb1c..a9773fdde51 100644 --- a/service/route53resolver/api_op_PutFirewallRuleGroupPolicy.go +++ b/service/route53resolver/api_op_PutFirewallRuleGroupPolicy.go @@ -35,8 +35,8 @@ type PutFirewallRuleGroupPolicyInput struct { // This member is required. Arn *string - // The Identity and Access Management (Amazon Web Services IAM) policy to attach to - // the rule group. + // The Identity and Access Management (Amazon Web Services IAM) policy to attach + // to the rule group. // // This member is required. FirewallRuleGroupPolicy *string diff --git a/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go b/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go index d3416c0452b..8cbc685e8d1 100644 --- a/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go +++ b/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go @@ -40,22 +40,13 @@ type PutResolverQueryLogConfigPolicyInput struct { // configurations that you want to share with another Amazon Web Services account // and the operations that you want the account to be able to perform. You can // specify the following operations in the Actions section of the statement: - // - // * - // route53resolver:AssociateResolverQueryLogConfig - // - // * - // route53resolver:DisassociateResolverQueryLogConfig - // - // * - // route53resolver:ListResolverQueryLogConfigAssociations - // - // * - // route53resolver:ListResolverQueryLogConfigs - // - // In the Resource section of the - // statement, you specify the ARNs for the query logging configurations that you - // want to share with the account that you specified in Arn. + // - route53resolver:AssociateResolverQueryLogConfig + // - route53resolver:DisassociateResolverQueryLogConfig + // - route53resolver:ListResolverQueryLogConfigAssociations + // - route53resolver:ListResolverQueryLogConfigs + // In the Resource section of the statement, you specify the ARNs for the query + // logging configurations that you want to share with the account that you + // specified in Arn . // // This member is required. ResolverQueryLogConfigPolicy *string diff --git a/service/route53resolver/api_op_PutResolverRulePolicy.go b/service/route53resolver/api_op_PutResolverRulePolicy.go index 8f4a30e9bbe..8da4a3e8536 100644 --- a/service/route53resolver/api_op_PutResolverRulePolicy.go +++ b/service/route53resolver/api_op_PutResolverRulePolicy.go @@ -36,27 +36,18 @@ type PutResolverRulePolicyInput struct { // This member is required. Arn *string - // An Identity and Access Management policy statement that lists the rules that you - // want to share with another Amazon Web Services account and the operations that - // you want the account to be able to perform. You can specify the following + // An Identity and Access Management policy statement that lists the rules that + // you want to share with another Amazon Web Services account and the operations + // that you want the account to be able to perform. You can specify the following // operations in the Action section of the statement: - // - // * - // route53resolver:GetResolverRule - // - // * route53resolver:AssociateResolverRule - // - // * - // route53resolver:DisassociateResolverRule - // - // * route53resolver:ListResolverRules - // - // * - // route53resolver:ListResolverRuleAssociations - // - // In the Resource section of the - // statement, specify the ARN for the rule that you want to share with another - // account. Specify the same ARN that you specified in Arn. + // - route53resolver:GetResolverRule + // - route53resolver:AssociateResolverRule + // - route53resolver:DisassociateResolverRule + // - route53resolver:ListResolverRules + // - route53resolver:ListResolverRuleAssociations + // In the Resource section of the statement, specify the ARN for the rule that you + // want to share with another account. Specify the same ARN that you specified in + // Arn . // // This member is required. ResolverRulePolicy *string diff --git a/service/route53resolver/api_op_TagResource.go b/service/route53resolver/api_op_TagResource.go index e4048862464..7cc0bc2d38b 100644 --- a/service/route53resolver/api_op_TagResource.go +++ b/service/route53resolver/api_op_TagResource.go @@ -29,32 +29,14 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) for the resource that you want to add tags to. To - // get the ARN for a resource, use the applicable Get or List command: - // - // * - // GetResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) - // - // * - // GetResolverRule - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html) - // - // * - // GetResolverRuleAssociation - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html) - // - // * - // ListResolverEndpoints - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) - // - // * - // ListResolverRuleAssociations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) - // - // * - // ListResolverRules - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) + // The Amazon Resource Name (ARN) for the resource that you want to add tags to. + // To get the ARN for a resource, use the applicable Get or List command: + // - GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) + // - GetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html) + // - GetResolverRuleAssociation (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html) + // - ListResolverEndpoints (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) + // - ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) + // - ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) // // This member is required. ResourceArn *string diff --git a/service/route53resolver/api_op_UntagResource.go b/service/route53resolver/api_op_UntagResource.go index 0c39da155fe..eb5c2ee3a0c 100644 --- a/service/route53resolver/api_op_UntagResource.go +++ b/service/route53resolver/api_op_UntagResource.go @@ -30,30 +30,12 @@ type UntagResourceInput struct { // The Amazon Resource Name (ARN) for the resource that you want to remove tags // from. To get the ARN for a resource, use the applicable Get or List command: - // - // * - // GetResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) - // - // * - // GetResolverRule - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html) - // - // * - // GetResolverRuleAssociation - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html) - // - // * - // ListResolverEndpoints - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) - // - // * - // ListResolverRuleAssociations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) - // - // * - // ListResolverRules - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) + // - GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) + // - GetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html) + // - GetResolverRuleAssociation (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html) + // - ListResolverEndpoints (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) + // - ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) + // - ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) // // This member is required. ResourceArn *string diff --git a/service/route53resolver/api_op_UpdateFirewallConfig.go b/service/route53resolver/api_op_UpdateFirewallConfig.go index ca2dadcd3e1..bdd2729cf25 100644 --- a/service/route53resolver/api_op_UpdateFirewallConfig.go +++ b/service/route53resolver/api_op_UpdateFirewallConfig.go @@ -32,19 +32,14 @@ type UpdateFirewallConfigInput struct { // Determines how Route 53 Resolver handles queries during failures, for example // when all traffic that is sent to DNS Firewall fails to receive a reply. - // - // * By - // default, fail open is disabled, which means the failure mode is closed. This - // approach favors security over availability. DNS Firewall blocks queries that it - // is unable to evaluate properly. - // - // * If you enable this option, the failure mode - // is open. This approach favors availability over security. DNS Firewall allows - // queries to proceed if it is unable to properly evaluate them. - // - // This behavior is - // only enforced for VPCs that have at least one DNS Firewall rule group - // association. + // - By default, fail open is disabled, which means the failure mode is closed. + // This approach favors security over availability. DNS Firewall blocks queries + // that it is unable to evaluate properly. + // - If you enable this option, the failure mode is open. This approach favors + // availability over security. DNS Firewall allows queries to proceed if it is + // unable to properly evaluate them. + // This behavior is only enforced for VPCs that have at least one DNS Firewall + // rule group association. // // This member is required. FirewallFailOpen types.FirewallFailOpenStatus diff --git a/service/route53resolver/api_op_UpdateFirewallDomains.go b/service/route53resolver/api_op_UpdateFirewallDomains.go index 08337985e05..2c750f9cafc 100644 --- a/service/route53resolver/api_op_UpdateFirewallDomains.go +++ b/service/route53resolver/api_op_UpdateFirewallDomains.go @@ -32,15 +32,10 @@ type UpdateFirewallDomainsInput struct { // A list of domains to use in the update operation. There is a limit of 1000 // domains per request. Each domain specification in your domain list must satisfy // the following requirements: - // - // * It can optionally start with * (asterisk). - // - // * - // With the exception of the optional starting asterisk, it must only contain the - // following characters: A-Z, a-z, 0-9, - (hyphen). - // - // * It must be from 1-255 - // characters in length. + // - It can optionally start with * (asterisk). + // - With the exception of the optional starting asterisk, it must only contain + // the following characters: A-Z , a-z , 0-9 , - (hyphen). + // - It must be from 1-255 characters in length. // // This member is required. Domains []string @@ -51,15 +46,11 @@ type UpdateFirewallDomainsInput struct { FirewallDomainListId *string // What you want DNS Firewall to do with the domains that you are providing: - // - // * ADD - // - Add the domains to the ones that are already in the domain list. - // - // * REMOVE - - // Search the domain list for the domains and remove them from the list. - // - // * REPLACE - // - Update the domain list to exactly match the list that you are providing. + // - ADD - Add the domains to the ones that are already in the domain list. + // - REMOVE - Search the domain list for the domains and remove them from the + // list. + // - REPLACE - Update the domain list to exactly match the list that you are + // providing. // // This member is required. Operation types.FirewallDomainUpdateOperation diff --git a/service/route53resolver/api_op_UpdateFirewallRule.go b/service/route53resolver/api_op_UpdateFirewallRule.go index d1bd8821a02..e48cfa6792f 100644 --- a/service/route53resolver/api_op_UpdateFirewallRule.go +++ b/service/route53resolver/api_op_UpdateFirewallRule.go @@ -41,43 +41,34 @@ type UpdateFirewallRuleInput struct { // The action that DNS Firewall should take on a DNS query when it matches one of // the domains in the rule's domain list: - // - // * ALLOW - Permit the request to go - // through. - // - // * ALERT - Permit the request to go through but send an alert to the - // logs. - // - // * BLOCK - Disallow the request. This option requires additional details - // in the rule's BlockResponse. + // - ALLOW - Permit the request to go through. + // - ALERT - Permit the request to go through but send an alert to the logs. + // - BLOCK - Disallow the request. This option requires additional details in the + // rule's BlockResponse . Action types.Action // The DNS record's type. This determines the format of the record value that you - // provided in BlockOverrideDomain. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. + // provided in BlockOverrideDomain . Used for the rule action BLOCK with a + // BlockResponse setting of OVERRIDE . BlockOverrideDnsType types.BlockOverrideDnsType // The custom DNS record to send back in response to the query. Used for the rule - // action BLOCK with a BlockResponse setting of OVERRIDE. + // action BLOCK with a BlockResponse setting of OVERRIDE . BlockOverrideDomain *string // The recommended amount of time, in seconds, for the DNS resolver or web browser // to cache the provided override record. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. + // BlockResponse setting of OVERRIDE . BlockOverrideTtl *int32 // The way that you want DNS Firewall to block the request. Used for the rule - // action setting BLOCK. - // - // * NODATA - Respond indicating that the query was - // successful, but no response is available for it. - // - // * NXDOMAIN - Respond - // indicating that the domain name that's in the query doesn't exist. - // - // * OVERRIDE - - // Provide a custom override in the response. This option requires custom handling - // details in the rule's BlockOverride* settings. + // action setting BLOCK . + // - NODATA - Respond indicating that the query was successful, but no response + // is available for it. + // - NXDOMAIN - Respond indicating that the domain name that's in the query + // doesn't exist. + // - OVERRIDE - Provide a custom override in the response. This option requires + // custom handling details in the rule's BlockOverride* settings. BlockResponse types.BlockResponse // The name of the rule. diff --git a/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go b/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go index 441ede2a6af..e1e5e4c400b 100644 --- a/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go +++ b/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go @@ -30,7 +30,7 @@ func (c *Client) UpdateFirewallRuleGroupAssociation(ctx context.Context, params type UpdateFirewallRuleGroupAssociationInput struct { - // The identifier of the FirewallRuleGroupAssociation. + // The identifier of the FirewallRuleGroupAssociation . // // This member is required. FirewallRuleGroupAssociationId *string diff --git a/service/route53resolver/api_op_UpdateResolverConfig.go b/service/route53resolver/api_op_UpdateResolverConfig.go index eaf6a0fbd9c..01d6d7af8cc 100644 --- a/service/route53resolver/api_op_UpdateResolverConfig.go +++ b/service/route53resolver/api_op_UpdateResolverConfig.go @@ -32,22 +32,19 @@ type UpdateResolverConfigInput struct { // Indicates whether or not the Resolver will create autodefined rules for reverse // DNS lookups. This is enabled by default. Disabling this option will also affect - // EC2-Classic instances using ClassicLink. For more information, see ClassicLink - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in - // the Amazon EC2 guide. We are retiring EC2-Classic on August 15, 2022. We + // EC2-Classic instances using ClassicLink. For more information, see ClassicLink (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) + // in the Amazon EC2 guide. We are retiring EC2-Classic on August 15, 2022. We // recommend that you migrate from EC2-Classic to a VPC. For more information, see - // Migrate from EC2-Classic to a VPC - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the - // Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to - // Prepare - // (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/). - // It can take some time for the status change to be completed. + // Migrate from EC2-Classic to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) + // in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – + // Here’s How to Prepare (http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/) + // . It can take some time for the status change to be completed. // // This member is required. AutodefinedReverseFlag types.AutodefinedReverseFlag - // Resource ID of the Amazon VPC that you want to update the Resolver configuration - // for. + // Resource ID of the Amazon VPC that you want to update the Resolver + // configuration for. // // This member is required. ResourceId *string diff --git a/service/route53resolver/api_op_UpdateResolverDnssecConfig.go b/service/route53resolver/api_op_UpdateResolverDnssecConfig.go index c50c8a0494a..f87a7901675 100644 --- a/service/route53resolver/api_op_UpdateResolverDnssecConfig.go +++ b/service/route53resolver/api_op_UpdateResolverDnssecConfig.go @@ -37,7 +37,7 @@ type UpdateResolverDnssecConfigInput struct { ResourceId *string // The new value that you are specifying for DNSSEC validation for the VPC. The - // value can be ENABLE or DISABLE. Be aware that it can take time for a validation + // value can be ENABLE or DISABLE . Be aware that it can take time for a validation // status change to be completed. // // This member is required. diff --git a/service/route53resolver/doc.go b/service/route53resolver/doc.go index 6e05b4a4b88..8861692b5c3 100644 --- a/service/route53resolver/doc.go +++ b/service/route53resolver/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package route53resolver provides the API client, operations, and parameter types -// for Amazon Route 53 Resolver. +// Package route53resolver provides the API client, operations, and parameter +// types for Amazon Route 53 Resolver. // // When you create a VPC using Amazon VPC, you automatically get DNS resolution // within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries @@ -13,9 +13,8 @@ // resolvers on your network can forward DNS queries to Resolver in a specified // VPC. This allows your DNS resolvers to easily resolve domain names for Amazon // Web Services resources such as EC2 instances or records in a Route 53 private -// hosted zone. For more information, see How DNS Resolvers on Your Network Forward -// DNS Queries to Route 53 Resolver -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-network-to-vpc) +// hosted zone. For more information, see How DNS Resolvers on Your Network +// Forward DNS Queries to Route 53 Resolver (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-network-to-vpc) // in the Amazon Route 53 Developer Guide. Conditionally forward queries from a VPC // to resolvers on your network You can configure Resolver to forward queries that // it receives from EC2 instances in your VPCs to DNS resolvers on your network. To @@ -26,8 +25,7 @@ // acme.example.com), Resolver chooses the rule with the most specific match // (acme.example.com) and forwards the query to the IP addresses that you specified // in that rule. For more information, see How Route 53 Resolver Forwards DNS -// Queries from Your VPCs to Your Network -// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-vpc-to-network) +// Queries from Your VPCs to Your Network (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-vpc-to-network) // in the Amazon Route 53 Developer Guide. Like Amazon VPC, Resolver is Regional. // In each Region where you have VPCs, you can choose whether to forward queries // from your VPCs to your network (outbound queries), from your network to your diff --git a/service/route53resolver/types/enums.go b/service/route53resolver/types/enums.go index 98a7e1ec95c..d01e25cf0e5 100644 --- a/service/route53resolver/types/enums.go +++ b/service/route53resolver/types/enums.go @@ -106,9 +106,9 @@ const ( FirewallDomainListStatusUpdating FirewallDomainListStatus = "UPDATING" ) -// Values returns all known values for FirewallDomainListStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for FirewallDomainListStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallDomainListStatus) Values() []FirewallDomainListStatus { return []FirewallDomainListStatus{ "COMPLETE", @@ -245,9 +245,9 @@ const ( MutationProtectionStatusDisabled MutationProtectionStatus = "DISABLED" ) -// Values returns all known values for MutationProtectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MutationProtectionStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (MutationProtectionStatus) Values() []MutationProtectionStatus { return []MutationProtectionStatus{ "ENABLED", @@ -383,9 +383,9 @@ const ( ResolverQueryLogConfigAssociationErrorInternalServiceError ResolverQueryLogConfigAssociationError = "INTERNAL_SERVICE_ERROR" ) -// Values returns all known values for ResolverQueryLogConfigAssociationError. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for ResolverQueryLogConfigAssociationError. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (ResolverQueryLogConfigAssociationError) Values() []ResolverQueryLogConfigAssociationError { return []ResolverQueryLogConfigAssociationError{ @@ -431,9 +431,10 @@ const ( ResolverQueryLogConfigStatusFailed ResolverQueryLogConfigStatus = "FAILED" ) -// Values returns all known values for ResolverQueryLogConfigStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResolverQueryLogConfigStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ResolverQueryLogConfigStatus) Values() []ResolverQueryLogConfigStatus { return []ResolverQueryLogConfigStatus{ "CREATING", @@ -538,9 +539,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", diff --git a/service/route53resolver/types/errors.go b/service/route53resolver/types/errors.go index fc2d6fe5564..60ade633887 100644 --- a/service/route53resolver/types/errors.go +++ b/service/route53resolver/types/errors.go @@ -412,7 +412,7 @@ func (e *UnknownResourceException) ErrorCode() string { } func (e *UnknownResourceException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have provided an invalid command. Supported values are ADD, REMOVE, or +// You have provided an invalid command. Supported values are ADD , REMOVE , or // REPLACE a domain. type ValidationException struct { Message *string diff --git a/service/route53resolver/types/types.go b/service/route53resolver/types/types.go index a3cd48e80a2..d9c775e0b95 100644 --- a/service/route53resolver/types/types.go +++ b/service/route53resolver/types/types.go @@ -6,223 +6,145 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// For Resolver list operations (ListResolverEndpoints -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html), -// ListResolverRules -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html), -// ListResolverRuleAssociations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html), -// ListResolverQueryLogConfigs -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html), -// ListResolverQueryLogConfigAssociations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html)), -// and ListResolverDnssecConfigs -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverDnssecConfigs.html)), -// an optional specification to return a subset of objects. To filter objects, such -// as Resolver endpoints or Resolver rules, you specify Name and Values. For -// example, to list only inbound Resolver endpoints, specify Direction for Name and -// specify INBOUND for Values. +// For Resolver list operations ( ListResolverEndpoints (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) +// , ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) +// , ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) +// , ListResolverQueryLogConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html) +// , ListResolverQueryLogConfigAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html) +// ), and ListResolverDnssecConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverDnssecConfigs.html) +// ), an optional specification to return a subset of objects. To filter objects, +// such as Resolver endpoints or Resolver rules, you specify Name and Values . For +// example, to list only inbound Resolver endpoints, specify Direction for Name +// and specify INBOUND for Values . type Filter struct { // The name of the parameter that you want to use to filter objects. The valid // values for Name depend on the action that you're including the filter in, - // ListResolverEndpoints - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html), - // ListResolverRules - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html), - // ListResolverRuleAssociations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html), - // ListResolverQueryLogConfigs - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html), - // or ListResolverQueryLogConfigAssociations - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html). - // In early versions of Resolver, values for Name were listed as uppercase, with + // ListResolverEndpoints (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html) + // , ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) + // , ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) + // , ListResolverQueryLogConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html) + // , or ListResolverQueryLogConfigAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html) + // . In early versions of Resolver, values for Name were listed as uppercase, with // underscore (_) delimiters. For example, CreatorRequestId was originally listed - // as CREATOR_REQUEST_ID. Uppercase values for Name are still supported. + // as CREATOR_REQUEST_ID . Uppercase values for Name are still supported. // ListResolverEndpoints Valid values for Name include the following: - // - // * - // CreatorRequestId: The value that you specified when you created the Resolver - // endpoint. - // - // * Direction: Whether you want to return inbound or outbound Resolver - // endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for - // Values. - // - // * HostVPCId: The ID of the VPC that inbound DNS queries pass through on - // the way from your network to your VPCs in a region, or the VPC that outbound - // queries pass through on the way from your VPCs to your network. In a - // CreateResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) - // request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) - // request, the VPC ID for a Resolver endpoint is returned in the HostVPCId - // element. - // - // * IpAddressCount: The number of IP addresses that you have associated - // with the Resolver endpoint. - // - // * Name: The name of the Resolver endpoint. - // - // * - // SecurityGroupIds: The IDs of the VPC security groups that you specified when you - // created the Resolver endpoint. - // - // * Status: The status of the Resolver endpoint. - // If you specify Status for Name, specify one of the following status codes for - // Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or - // DELETING. For more information, see Status in ResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverEndpoint.html). - // - // ListResolverRules - // Valid values for Name include the following: - // - // * CreatorRequestId: The value that - // you specified when you created the Resolver rule. - // - // * DomainName: The domain name - // for which Resolver is forwarding DNS queries to your network. In the value that - // you specify for Values, include a trailing dot (.) after the domain name. For - // example, if the domain name is example.com, specify the following value. Note - // the "." after com: example.com. - // - // * Name: The name of the Resolver rule. - // - // * - // ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is - // associated with. You can filter on the Resolver endpoint only for rules that - // have a value of FORWARD for RuleType. - // - // * Status: The status of the Resolver - // rule. If you specify Status for Name, specify one of the following status codes - // for Values: COMPLETE, DELETING, UPDATING, or FAILED. - // - // * Type: The type of the - // Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for - // Values. - // - // ListResolverRuleAssociations Valid values for Name include the - // following: - // - // * Name: The name of the Resolver rule association. - // - // * - // ResolverRuleId: The ID of the Resolver rule that is associated with one or more - // VPCs. - // - // * Status: The status of the Resolver rule association. If you specify - // Status for Name, specify one of the following status codes for Values: CREATING, - // COMPLETE, DELETING, or FAILED. - // - // * VPCId: The ID of the VPC that the Resolver - // rule is associated with. - // - // ListResolverQueryLogConfigs Valid values for Name - // include the following: - // - // * Arn: The ARN for the query logging configuration. - // - // * - // AssociationCount: The number of VPCs that are associated with the query logging - // configuration. - // - // * CreationTime: The date and time that the query logging - // configuration was created, in Unix time format and Coordinated Universal Time - // (UTC). - // - // * CreatorRequestId: A unique string that identifies the request that - // created the query logging configuration. - // - // * Destination: The Amazon Web Services - // service that you want to forward query logs to. Valid values include the + // - CreatorRequestId : The value that you specified when you created the + // Resolver endpoint. + // - Direction : Whether you want to return inbound or outbound Resolver + // endpoints. If you specify DIRECTION for Name , specify INBOUND or OUTBOUND for + // Values . + // - HostVPCId : The ID of the VPC that inbound DNS queries pass through on the + // way from your network to your VPCs in a region, or the VPC that outbound queries + // pass through on the way from your VPCs to your network. In a + // CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) + // request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) + // request, the VPC ID for a Resolver endpoint is returned in the HostVPCId + // element. + // - IpAddressCount : The number of IP addresses that you have associated with + // the Resolver endpoint. + // - Name : The name of the Resolver endpoint. + // - SecurityGroupIds : The IDs of the VPC security groups that you specified + // when you created the Resolver endpoint. + // - Status : The status of the Resolver endpoint. If you specify Status for Name + // , specify one of the following status codes for Values : CREATING , + // OPERATIONAL , UPDATING , AUTO_RECOVERING , ACTION_NEEDED , or DELETING . For + // more information, see Status in ResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverEndpoint.html) + // . + // ListResolverRules Valid values for Name include the following: + // - CreatorRequestId : The value that you specified when you created the + // Resolver rule. + // - DomainName : The domain name for which Resolver is forwarding DNS queries to + // your network. In the value that you specify for Values , include a trailing + // dot (.) after the domain name. For example, if the domain name is example.com, + // specify the following value. Note the "." after com : example.com. + // - Name : The name of the Resolver rule. + // - ResolverEndpointId : The ID of the Resolver endpoint that the Resolver rule + // is associated with. You can filter on the Resolver endpoint only for rules that + // have a value of FORWARD for RuleType . + // - Status : The status of the Resolver rule. If you specify Status for Name , + // specify one of the following status codes for Values : COMPLETE , DELETING , + // UPDATING , or FAILED . + // - Type : The type of the Resolver rule. If you specify TYPE for Name , specify + // FORWARD or SYSTEM for Values . + // ListResolverRuleAssociations Valid values for Name include the following: + // - Name : The name of the Resolver rule association. + // - ResolverRuleId : The ID of the Resolver rule that is associated with one or + // more VPCs. + // - Status : The status of the Resolver rule association. If you specify Status + // for Name , specify one of the following status codes for Values : CREATING , + // COMPLETE , DELETING , or FAILED . + // - VPCId : The ID of the VPC that the Resolver rule is associated with. + // ListResolverQueryLogConfigs Valid values for Name include the following: + // - Arn : The ARN for the query logging configuration. + // - AssociationCount : The number of VPCs that are associated with the query + // logging configuration. + // - CreationTime : The date and time that the query logging configuration was + // created, in Unix time format and Coordinated Universal Time (UTC). + // - CreatorRequestId : A unique string that identifies the request that created + // the query logging configuration. + // - Destination : The Amazon Web Services service that you want to forward query + // logs to. Valid values include the following: + // - S3 + // - CloudWatchLogs + // - KinesisFirehose + // - DestinationArn : The ARN of the location that Resolver is sending query logs + // to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or + // a Kinesis Data Firehose delivery stream. + // - Id : The ID of the query logging configuration + // - Name : The name of the query logging configuration + // - OwnerId : The Amazon Web Services account ID for the account that created + // the query logging configuration. + // - ShareStatus : An indication of whether the query logging configuration is + // shared with other Amazon Web Services accounts, or was shared with the current + // account by another Amazon Web Services account. Valid values include: + // NOT_SHARED , SHARED_WITH_ME , or SHARED_BY_ME . + // - Status : The status of the query logging configuration. If you specify + // Status for Name , specify the applicable status code for Values : CREATING , + // CREATED , DELETING , or FAILED . For more information, see Status (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfig.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfig-Status) + // . + // ListResolverQueryLogConfigAssociations Valid values for Name include the // following: - // - // * S3 - // - // * CloudWatchLogs - // - // * KinesisFirehose - // - // * DestinationArn: The ARN - // of the location that Resolver is sending query logs to. This value can be the - // ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose - // delivery stream. - // - // * Id: The ID of the query logging configuration - // - // * Name: The - // name of the query logging configuration - // - // * OwnerId: The Amazon Web Services - // account ID for the account that created the query logging configuration. - // - // * - // ShareStatus: An indication of whether the query logging configuration is shared - // with other Amazon Web Services accounts, or was shared with the current account - // by another Amazon Web Services account. Valid values include: NOT_SHARED, - // SHARED_WITH_ME, or SHARED_BY_ME. - // - // * Status: The status of the query logging - // configuration. If you specify Status for Name, specify the applicable status - // code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, - // see Status - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfig.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfig-Status). - // - // ListResolverQueryLogConfigAssociations - // Valid values for Name include the following: - // - // * CreationTime: The date and time - // that the VPC was associated with the query logging configuration, in Unix time - // format and Coordinated Universal Time (UTC). - // - // * Error: If the value of Status is - // FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED. - // - // * Id: The ID - // of the query logging association. - // - // * ResolverQueryLogConfigId: The ID of the - // query logging configuration that a VPC is associated with. - // - // * ResourceId: The ID - // of the Amazon VPC that is associated with the query logging configuration. - // - // * - // Status: The status of the query logging association. If you specify Status for - // Name, specify the applicable status code for Values: CREATING, CREATED, - // DELETING, or FAILED. For more information, see Status - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfigAssociation.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfigAssociation-Status). + // - CreationTime : The date and time that the VPC was associated with the query + // logging configuration, in Unix time format and Coordinated Universal Time (UTC). + // + // - Error : If the value of Status is FAILED , specify the cause: + // DESTINATION_NOT_FOUND or ACCESS_DENIED . + // - Id : The ID of the query logging association. + // - ResolverQueryLogConfigId : The ID of the query logging configuration that a + // VPC is associated with. + // - ResourceId : The ID of the Amazon VPC that is associated with the query + // logging configuration. + // - Status : The status of the query logging association. If you specify Status + // for Name , specify the applicable status code for Values : CREATING , CREATED + // , DELETING , or FAILED . For more information, see Status (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfigAssociation.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfigAssociation-Status) + // . Name *string - // When you're using a List operation and you want the operation to return a subset - // of objects, such as Resolver endpoints or Resolver rules, the value of the - // parameter that you want to use to filter objects. For example, to list only + // When you're using a List operation and you want the operation to return a + // subset of objects, such as Resolver endpoints or Resolver rules, the value of + // the parameter that you want to use to filter objects. For example, to list only // inbound Resolver endpoints, specify Direction for Name and specify INBOUND for - // Values. + // Values . Values []string noSmithyDocumentSerde } -// Configuration of the firewall behavior provided by DNS Firewall for a single VPC -// from Amazon Virtual Private Cloud (Amazon VPC). +// Configuration of the firewall behavior provided by DNS Firewall for a single +// VPC from Amazon Virtual Private Cloud (Amazon VPC). type FirewallConfig struct { // Determines how DNS Firewall operates during failures, for example when all // traffic that is sent to DNS Firewall fails to receive a reply. - // - // * By default, - // fail open is disabled, which means the failure mode is closed. This approach - // favors security over availability. DNS Firewall returns a failure error when it - // is unable to properly evaluate a query. - // - // * If you enable this option, the - // failure mode is open. This approach favors availability over security. DNS - // Firewall allows queries to proceed if it is unable to properly evaluate - // them. - // - // This behavior is only enforced for VPCs that have at least one DNS - // Firewall rule group association. + // - By default, fail open is disabled, which means the failure mode is closed. + // This approach favors security over availability. DNS Firewall returns a failure + // error when it is unable to properly evaluate a query. + // - If you enable this option, the failure mode is open. This approach favors + // availability over security. DNS Firewall allows queries to proceed if it is + // unable to properly evaluate them. + // This behavior is only enforced for VPCs that have at least one DNS Firewall + // rule group association. FirewallFailOpen FirewallFailOpenStatus // The ID of the firewall configuration. @@ -239,8 +161,8 @@ type FirewallConfig struct { } // High-level information about a list of firewall domains for use in a -// FirewallRule. This is returned by GetFirewallDomainList. To retrieve the domains -// that are defined for this domain list, call ListFirewallDomains. +// FirewallRule . This is returned by GetFirewallDomainList . To retrieve the +// domains that are defined for this domain list, call ListFirewallDomains . type FirewallDomainList struct { // The Amazon Resource Name (ARN) of the firewall domain list. @@ -250,9 +172,9 @@ type FirewallDomainList struct { // Coordinated Universal Time (UTC). CreationTime *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. CreatorRequestId *string // The number of domain names that are specified in the domain list. @@ -263,7 +185,7 @@ type FirewallDomainList struct { // The owner of the list, used only for lists that are not managed by you. For // example, the managed domain list AWSManagedDomainsMalwareDomainList has the - // managed owner name Route 53 Resolver DNS Firewall. + // managed owner name Route 53 Resolver DNS Firewall . ManagedOwnerName *string // The date and time that the domain list was last modified, in Unix time format @@ -285,15 +207,15 @@ type FirewallDomainList struct { // Minimal high-level information for a firewall domain list. The action // ListFirewallDomainLists returns an array of these objects. To retrieve full // information for a firewall domain list, call GetFirewallDomainList and -// ListFirewallDomains. +// ListFirewallDomains . type FirewallDomainListMetadata struct { // The Amazon Resource Name (ARN) of the firewall domain list metadata. Arn *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. CreatorRequestId *string // The ID of the domain list. @@ -301,7 +223,7 @@ type FirewallDomainListMetadata struct { // The owner of the list, used only for lists that are not managed by you. For // example, the managed domain list AWSManagedDomainsMalwareDomainList has the - // managed owner name Route 53 Resolver DNS Firewall. + // managed owner name Route 53 Resolver DNS Firewall . ManagedOwnerName *string // The name of the domain list. @@ -315,52 +237,43 @@ type FirewallRule struct { // The action that DNS Firewall should take on a DNS query when it matches one of // the domains in the rule's domain list: - // - // * ALLOW - Permit the request to go - // through. - // - // * ALERT - Permit the request to go through but send an alert to the - // logs. - // - // * BLOCK - Disallow the request. If this is specified, additional handling - // details are provided in the rule's BlockResponse setting. + // - ALLOW - Permit the request to go through. + // - ALERT - Permit the request to go through but send an alert to the logs. + // - BLOCK - Disallow the request. If this is specified, additional handling + // details are provided in the rule's BlockResponse setting. Action Action // The DNS record's type. This determines the format of the record value that you - // provided in BlockOverrideDomain. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. + // provided in BlockOverrideDomain . Used for the rule action BLOCK with a + // BlockResponse setting of OVERRIDE . BlockOverrideDnsType BlockOverrideDnsType // The custom DNS record to send back in response to the query. Used for the rule - // action BLOCK with a BlockResponse setting of OVERRIDE. + // action BLOCK with a BlockResponse setting of OVERRIDE . BlockOverrideDomain *string // The recommended amount of time, in seconds, for the DNS resolver or web browser // to cache the provided override record. Used for the rule action BLOCK with a - // BlockResponse setting of OVERRIDE. + // BlockResponse setting of OVERRIDE . BlockOverrideTtl *int32 // The way that you want DNS Firewall to block the request. Used for the rule - // action setting BLOCK. - // - // * NODATA - Respond indicating that the query was - // successful, but no response is available for it. - // - // * NXDOMAIN - Respond - // indicating that the domain name that's in the query doesn't exist. - // - // * OVERRIDE - - // Provide a custom override in the response. This option requires custom handling - // details in the rule's BlockOverride* settings. + // action setting BLOCK . + // - NODATA - Respond indicating that the query was successful, but no response + // is available for it. + // - NXDOMAIN - Respond indicating that the domain name that's in the query + // doesn't exist. + // - OVERRIDE - Provide a custom override in the response. This option requires + // custom handling details in the rule's BlockOverride* settings. BlockResponse BlockResponse - // The date and time that the rule was created, in Unix time format and Coordinated - // Universal Time (UTC). + // The date and time that the rule was created, in Unix time format and + // Coordinated Universal Time (UTC). CreationTime *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of executing the operation twice. This can be - // any unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of executing the operation twice. This + // can be any unique string, for example, a timestamp. CreatorRequestId *string // The ID of the domain list that's used in the rule. @@ -376,8 +289,8 @@ type FirewallRule struct { // The name of the rule. Name *string - // The priority of the rule in the rule group. This value must be unique within the - // rule group. DNS Firewall processes the rules in a rule group by order of + // The priority of the rule in the rule group. This value must be unique within + // the rule group. DNS Firewall processes the rules in a rule group by order of // priority, starting from the lowest setting. Priority *int32 @@ -386,7 +299,7 @@ type FirewallRule struct { // High-level information for a firewall rule group. A firewall rule group is a // collection of rules that DNS Firewall uses to filter DNS network traffic for a -// VPC. To retrieve the rules for the rule group, call ListFirewallRules. +// VPC. To retrieve the rules for the rule group, call ListFirewallRules . type FirewallRuleGroup struct { // The ARN (Amazon Resource Name) of the rule group. @@ -396,16 +309,16 @@ type FirewallRuleGroup struct { // Coordinated Universal Time (UTC). CreationTime *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. CreatorRequestId *string // The ID of the rule group. Id *string - // The date and time that the rule group was last modified, in Unix time format and - // Coordinated Universal Time (UTC). + // The date and time that the rule group was last modified, in Unix time format + // and Coordinated Universal Time (UTC). ModificationTime *string // The name of the rule group. @@ -419,9 +332,9 @@ type FirewallRuleGroup struct { // The number of rules in the rule group. RuleCount *int32 - // Whether the rule group is shared with other Amazon Web Services accounts, or was - // shared with the current account by another Amazon Web Services account. Sharing - // is configured through Resource Access Manager (RAM). + // Whether the rule group is shared with other Amazon Web Services accounts, or + // was shared with the current account by another Amazon Web Services account. + // Sharing is configured through Resource Access Manager (RAM). ShareStatus ShareStatus // The status of the domain list. @@ -444,9 +357,9 @@ type FirewallRuleGroupAssociation struct { // Coordinated Universal Time (UTC). CreationTime *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. CreatorRequestId *string // The unique identifier of the firewall rule group. @@ -455,9 +368,9 @@ type FirewallRuleGroupAssociation struct { // The identifier for the association. Id *string - // The owner of the association, used only for associations that are not managed by - // you. If you use Firewall Manager to manage your DNS Firewalls, then this reports - // Firewall Manager as the managed owner. + // The owner of the association, used only for associations that are not managed + // by you. If you use Firewall Manager to manage your DNS Firewalls, then this + // reports Firewall Manager as the managed owner. ManagedOwnerName *string // The date and time that the association was last modified, in Unix time format @@ -491,15 +404,15 @@ type FirewallRuleGroupAssociation struct { // Minimal high-level information for a firewall rule group. The action // ListFirewallRuleGroups returns an array of these objects. To retrieve full // information for a firewall rule group, call GetFirewallRuleGroup and -// ListFirewallRules. +// ListFirewallRules . type FirewallRuleGroupMetadata struct { // The ARN (Amazon Resource Name) of the rule group. Arn *string - // A unique string defined by you to identify the request. This allows you to retry - // failed requests without the risk of running the operation twice. This can be any - // unique string, for example, a timestamp. + // A unique string defined by you to identify the request. This allows you to + // retry failed requests without the risk of running the operation twice. This can + // be any unique string, for example, a timestamp. CreatorRequestId *string // The ID of the rule group. @@ -513,16 +426,15 @@ type FirewallRuleGroupMetadata struct { // shared the rule group with you. OwnerId *string - // Whether the rule group is shared with other Amazon Web Services accounts, or was - // shared with the current account by another Amazon Web Services account. Sharing - // is configured through Resource Access Manager (RAM). + // Whether the rule group is shared with other Amazon Web Services accounts, or + // was shared with the current account by another Amazon Web Services account. + // Sharing is configured through Resource Access Manager (RAM). ShareStatus ShareStatus noSmithyDocumentSerde } -// In a CreateResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) +// In a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) // request, the IP address that DNS queries originate from (for outbound endpoints) // or that you forward DNS queries to (for inbound endpoints). IpAddressRequest // also includes the ID of the subnet that contains the IP address. @@ -542,8 +454,7 @@ type IpAddressRequest struct { noSmithyDocumentSerde } -// In the response to a GetResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) +// In the response to a GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) // request, information about the IP addresses that the Resolver endpoint uses for // DNS queries. type IpAddressResponse struct { @@ -561,8 +472,8 @@ type IpAddressResponse struct { // One IPv6 address that the Resolver endpoint uses for DNS queries. Ipv6 *string - // The date and time that the IP address was last modified, in Unix time format and - // Coordinated Universal Time (UTC). + // The date and time that the IP address was last modified, in Unix time format + // and Coordinated Universal Time (UTC). ModificationTime *string // A status code that gives the current status of the request. @@ -577,8 +488,7 @@ type IpAddressResponse struct { noSmithyDocumentSerde } -// In an UpdateResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) +// In an UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) // request, information about an IP address to update. type IpAddressUpdate struct { @@ -586,16 +496,16 @@ type IpAddressUpdate struct { Ip *string // Only when removing an IP address from a Resolver endpoint: The ID of the IP - // address that you want to remove. To get this ID, use GetResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html). + // address that you want to remove. To get this ID, use GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) + // . IpId *string // The new IPv6 address. Ipv6 *string // The ID of the subnet that includes the IP address that you want to update. To - // get this ID, use GetResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html). + // get this ID, use GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) + // . SubnetId *string noSmithyDocumentSerde @@ -608,18 +518,12 @@ type ResolverConfig struct { // The status of whether or not the Resolver will create autodefined rules for // reverse DNS lookups. This is enabled by default. The status can be one of // following: - // - // * ENABLING: Autodefined rules for reverse DNS lookups are being - // enabled but are not complete. - // - // * ENABLED: Autodefined rules for reverse DNS - // lookups are enabled. - // - // * DISABLING: Autodefined rules for reverse DNS lookups are - // being disabled but are not complete. - // - // * DISABLED: Autodefined rules for reverse - // DNS lookups are disabled. + // - ENABLING: Autodefined rules for reverse DNS lookups are being enabled but + // are not complete. + // - ENABLED: Autodefined rules for reverse DNS lookups are enabled. + // - DISABLING: Autodefined rules for reverse DNS lookups are being disabled but + // are not complete. + // - DISABLED: Autodefined rules for reverse DNS lookups are disabled. AutodefinedReverse ResolverAutodefinedReverseStatus // ID for the Resolver configuration. @@ -652,31 +556,20 @@ type ResolverDnssecConfig struct { // The validation status for a DNSSEC configuration. The status can be one of the // following: - // - // * ENABLING: DNSSEC validation is being enabled but is not - // complete. - // - // * ENABLED: DNSSEC validation is enabled. - // - // * DISABLING: DNSSEC - // validation is being disabled but is not complete. - // - // * DISABLED DNSSEC validation - // is disabled. + // - ENABLING: DNSSEC validation is being enabled but is not complete. + // - ENABLED: DNSSEC validation is enabled. + // - DISABLING: DNSSEC validation is being disabled but is not complete. + // - DISABLED DNSSEC validation is disabled. ValidationStatus ResolverDNSSECValidationStatus noSmithyDocumentSerde } -// In the response to a CreateResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html), -// DeleteResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html), -// GetResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html), -// Updates the name, or ResolverEndpointType for an endpoint, or -// UpdateResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) +// In the response to a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) +// , DeleteResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html) +// , GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html) +// , Updates the name, or ResolverEndpointType for an endpoint, or +// UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) // request, a complex type that contains settings for an existing inbound or // outbound Resolver endpoint. type ResolverEndpoint struct { @@ -693,13 +586,9 @@ type ResolverEndpoint struct { // running the operation twice. CreatorRequestId *string - // Indicates whether the Resolver endpoint allows inbound or outbound DNS - // queries: - // - // * INBOUND: allows DNS queries to your VPC from your network - // - // * - // OUTBOUND: allows DNS queries from your VPC to your network + // Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: + // - INBOUND : allows DNS queries to your VPC from your network + // - OUTBOUND : allows DNS queries from your VPC to your network Direction ResolverEndpointDirection // The ID of the VPC that you want to create the Resolver endpoint in. @@ -716,8 +605,7 @@ type ResolverEndpoint struct { ModificationTime *string // The name that you assigned to the Resolver endpoint when you submitted a - // CreateResolverEndpoint - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) + // CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) // request. Name *string @@ -733,42 +621,31 @@ type ResolverEndpoint struct { // A code that specifies the current status of the Resolver endpoint. Valid values // include the following: - // - // * CREATING: Resolver is creating and configuring one or - // more Amazon VPC network interfaces for this endpoint. - // - // * OPERATIONAL: The Amazon - // VPC network interfaces for this endpoint are correctly configured and able to - // pass inbound or outbound DNS queries between your network and Resolver. - // - // * - // UPDATING: Resolver is associating or disassociating one or more network - // interfaces with this endpoint. - // - // * AUTO_RECOVERING: Resolver is trying to recover - // one or more of the network interfaces that are associated with this endpoint. - // During the recovery process, the endpoint functions with limited capacity - // because of the limit on the number of DNS queries per IP address (per network - // interface). For the current limit, see Limits on Route 53 Resolver - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver). - // - // * - // ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically - // recover it. To resolve the problem, we recommend that you check each IP address - // that you associated with the endpoint. For each IP address that isn't available, - // add another IP address and then delete the IP address that isn't available. (An - // endpoint must always include at least two IP addresses.) A status of - // ACTION_NEEDED can have a variety of causes. Here are two common causes: - // - // * One - // or more of the network interfaces that are associated with the endpoint were - // deleted using Amazon VPC. - // - // * The network interface couldn't be created for some - // reason that's outside the control of Resolver. - // - // * DELETING: Resolver is deleting - // this endpoint and the associated network interfaces. + // - CREATING : Resolver is creating and configuring one or more Amazon VPC + // network interfaces for this endpoint. + // - OPERATIONAL : The Amazon VPC network interfaces for this endpoint are + // correctly configured and able to pass inbound or outbound DNS queries between + // your network and Resolver. + // - UPDATING : Resolver is associating or disassociating one or more network + // interfaces with this endpoint. + // - AUTO_RECOVERING : Resolver is trying to recover one or more of the network + // interfaces that are associated with this endpoint. During the recovery process, + // the endpoint functions with limited capacity because of the limit on the number + // of DNS queries per IP address (per network interface). For the current limit, + // see Limits on Route 53 Resolver (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver) + // . + // - ACTION_NEEDED : This endpoint is unhealthy, and Resolver can't automatically + // recover it. To resolve the problem, we recommend that you check each IP address + // that you associated with the endpoint. For each IP address that isn't available, + // add another IP address and then delete the IP address that isn't available. (An + // endpoint must always include at least two IP addresses.) A status of + // ACTION_NEEDED can have a variety of causes. Here are two common causes: + // - One or more of the network interfaces that are associated with the endpoint + // were deleted using Amazon VPC. + // - The network interface couldn't be created for some reason that's outside + // the control of Resolver. + // - DELETING : Resolver is deleting this endpoint and the associated network + // interfaces. Status ResolverEndpointStatus // A detailed description of the status of the Resolver endpoint. @@ -777,14 +654,10 @@ type ResolverEndpoint struct { noSmithyDocumentSerde } -// In the response to a CreateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverQueryLogConfig.html), -// DeleteResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverQueryLogConfig.html), -// GetResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfig.html), -// or ListResolverQueryLogConfigs -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html) +// In the response to a CreateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverQueryLogConfig.html) +// , DeleteResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverQueryLogConfig.html) +// , GetResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfig.html) +// , or ListResolverQueryLogConfigs (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html) // request, a complex type that contains settings for one query logging // configuration. type ResolverQueryLogConfig struct { @@ -795,13 +668,13 @@ type ResolverQueryLogConfig struct { // The number of VPCs that are associated with the query logging configuration. AssociationCount int32 - // The date and time that the query logging configuration was created, in Unix time - // format and Coordinated Universal Time (UTC). + // The date and time that the query logging configuration was created, in Unix + // time format and Coordinated Universal Time (UTC). CreationTime *string // A unique string that identifies the request that created the query logging - // configuration. The CreatorRequestId allows failed requests to be retried without - // the risk of running the operation twice. + // configuration. The CreatorRequestId allows failed requests to be retried + // without the risk of running the operation twice. CreatorRequestId *string // The ARN of the resource that you want Resolver to send query logs: an Amazon S3 @@ -826,39 +699,24 @@ type ResolverQueryLogConfig struct { // The status of the specified query logging configuration. Valid values include // the following: - // - // * CREATING: Resolver is creating the query logging - // configuration. - // - // * CREATED: The query logging configuration was successfully - // created. Resolver is logging queries that originate in the specified VPC. - // - // * - // DELETING: Resolver is deleting this query logging configuration. - // - // * FAILED: - // Resolver can't deliver logs to the location that is specified in the query - // logging configuration. Here are two common causes: - // - // * The specified destination - // (for example, an Amazon S3 bucket) was deleted. - // - // * Permissions don't allow - // sending logs to the destination. + // - CREATING : Resolver is creating the query logging configuration. + // - CREATED : The query logging configuration was successfully created. Resolver + // is logging queries that originate in the specified VPC. + // - DELETING : Resolver is deleting this query logging configuration. + // - FAILED : Resolver can't deliver logs to the location that is specified in + // the query logging configuration. Here are two common causes: + // - The specified destination (for example, an Amazon S3 bucket) was deleted. + // - Permissions don't allow sending logs to the destination. Status ResolverQueryLogConfigStatus noSmithyDocumentSerde } -// In the response to an AssociateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html), -// DisassociateResolverQueryLogConfig -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html), -// GetResolverQueryLogConfigAssociation -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfigAssociation.html), -// or ListResolverQueryLogConfigAssociations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html), -// request, a complex type that contains settings for a specified association +// In the response to an AssociateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html) +// , DisassociateResolverQueryLogConfig (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html) +// , GetResolverQueryLogConfigAssociation (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfigAssociation.html) +// , or ListResolverQueryLogConfigAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html) +// , request, a complex type that contains settings for a specified association // between an Amazon VPC and a query logging configuration. type ResolverQueryLogConfigAssociation struct { @@ -866,17 +724,11 @@ type ResolverQueryLogConfigAssociation struct { // configuration, in Unix time format and Coordinated Universal Time (UTC). CreationTime *string - // If the value of Status is FAILED, the value of Error indicates the cause: - // - // * - // DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 - // bucket) was deleted. - // - // * ACCESS_DENIED: Permissions don't allow sending logs to - // the destination. - // - // If the value of Status is a value other than FAILED, Error is - // null. + // If the value of Status is FAILED , the value of Error indicates the cause: + // - DESTINATION_NOT_FOUND : The specified destination (for example, an Amazon S3 + // bucket) was deleted. + // - ACCESS_DENIED : Permissions don't allow sending logs to the destination. + // If the value of Status is a value other than FAILED , Error is null. Error ResolverQueryLogConfigAssociationError // Contains additional information about the error. If the value or Error is null, @@ -895,19 +747,14 @@ type ResolverQueryLogConfigAssociation struct { // The status of the specified query logging association. Valid values include the // following: - // - // * CREATING: Resolver is creating an association between an Amazon - // VPC and a query logging configuration. - // - // * CREATED: The association between an - // Amazon VPC and a query logging configuration was successfully created. Resolver - // is logging queries that originate in the specified VPC. - // - // * DELETING: Resolver is - // deleting this query logging association. - // - // * FAILED: Resolver either couldn't - // create or couldn't delete the query logging association. + // - CREATING : Resolver is creating an association between an Amazon VPC and a + // query logging configuration. + // - CREATED : The association between an Amazon VPC and a query logging + // configuration was successfully created. Resolver is logging queries that + // originate in the specified VPC. + // - DELETING : Resolver is deleting this query logging association. + // - FAILED : Resolver either couldn't create or couldn't delete the query + // logging association. Status ResolverQueryLogConfigAssociationStatus noSmithyDocumentSerde @@ -915,20 +762,15 @@ type ResolverQueryLogConfigAssociation struct { // For queries that originate in your VPC, detailed information about a Resolver // rule, which specifies how to route DNS queries out of the VPC. The ResolverRule -// parameter appears in the response to a CreateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html), -// DeleteResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html), -// GetResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html), -// ListResolverRules -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html), -// or UpdateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html) +// parameter appears in the response to a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html) +// , DeleteResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html) +// , GetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html) +// , ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html) +// , or UpdateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html) // request. type ResolverRule struct { - // The ARN (Amazon Resource Name) for the Resolver rule specified by Id. + // The ARN (Amazon Resource Name) for the Resolver rule specified by Id . Arn *string // The date and time that the Resolver rule was created, in Unix time format and @@ -941,7 +783,7 @@ type ResolverRule struct { CreatorRequestId *string // DNS queries for this domain name are forwarded to the IP addresses that are - // specified in TargetIps. If a query matches multiple Resolver rules (example.com + // specified in TargetIps . If a query matches multiple Resolver rules (example.com // and www.example.com), the query is routed using the Resolver rule that contains // the most specific domain name (www.example.com). DomainName *string @@ -965,13 +807,13 @@ type ResolverRule struct { ResolverEndpointId *string // When you want to forward DNS queries for specified domain name to resolvers on - // your network, specify FORWARD. When you have a forwarding rule to forward DNS + // your network, specify FORWARD . When you have a forwarding rule to forward DNS // queries for a domain to your network and you want Resolver to process queries - // for a subdomain of that domain, specify SYSTEM. For example, to forward DNS + // for a subdomain of that domain, specify SYSTEM . For example, to forward DNS // queries for example.com to resolvers on your network, you create a rule and - // specify FORWARD for RuleType. To then have Resolver process queries for - // apex.example.com, you create a rule and specify SYSTEM for RuleType. Currently, - // only Resolver can create rules that have a value of RECURSIVE for RuleType. + // specify FORWARD for RuleType . To then have Resolver process queries for + // apex.example.com, you create a rule and specify SYSTEM for RuleType . Currently, + // only Resolver can create rules that have a value of RECURSIVE for RuleType . RuleType RuleTypeOption // Whether the rule is shared and, if so, whether the current account is sharing @@ -993,20 +835,16 @@ type ResolverRule struct { noSmithyDocumentSerde } -// In the response to an AssociateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html), -// DisassociateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html), -// or ListResolverRuleAssociations -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) +// In the response to an AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html) +// , DisassociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html) +// , or ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html) // request, provides information about an association between a Resolver rule and a // VPC. The association determines which DNS queries that originate in the VPC are // forwarded to your network. type ResolverRuleAssociation struct { // The ID of the association between a Resolver rule and a VPC. Resolver assigns - // this value when you submit an AssociateResolverRule - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html) + // this value when you submit an AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html) // request. Id *string @@ -1014,7 +852,7 @@ type ResolverRuleAssociation struct { Name *string // The ID of the Resolver rule that you associated with the VPC that is specified - // by VPCId. + // by VPCId . ResolverRuleId *string // A code that specifies the current status of the association between a Resolver @@ -1031,8 +869,7 @@ type ResolverRuleAssociation struct { noSmithyDocumentSerde } -// In an UpdateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html) +// In an UpdateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html) // request, information about the changes that you want to make. type ResolverRuleConfig struct { @@ -1041,7 +878,7 @@ type ResolverRuleConfig struct { Name *string // The ID of the new outbound Resolver endpoint that you want to use to route DNS - // queries to the IP addresses that you specify in TargetIps. + // queries to the IP addresses that you specify in TargetIps . ResolverEndpointId *string // For DNS queries that originate in your VPC, the new IP addresses that you want @@ -1052,17 +889,17 @@ type ResolverRuleConfig struct { } // One tag that you want to add to the specified resource. A tag consists of a Key -// (a name for the tag) and a Value. +// (a name for the tag) and a Value . type Tag struct { // The name for the tag. For example, if you want to associate Resolver resources // with the account IDs of your customers for billing purposes, the value of Key - // might be account-id. + // might be account-id . // // This member is required. Key *string - // The value for the tag. For example, if Key is account-id, then Value might be + // The value for the tag. For example, if Key is account-id , then Value might be // the ID of the customer account that you're creating the resource for. // // This member is required. @@ -1071,8 +908,7 @@ type Tag struct { noSmithyDocumentSerde } -// In a CreateResolverRule -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html) +// In a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html) // request, an array of the IPs that you want to forward DNS queries to. type TargetAddress struct { @@ -1089,11 +925,11 @@ type TargetAddress struct { } // Provides information about the IP address type in response to -// UpdateResolverEndpoint -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html). +// UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) +// . type UpdateIpAddress struct { - // The ID of the IP address, specified by the ResolverEndpointId. + // The ID of the IP address, specified by the ResolverEndpointId . // // This member is required. IpId *string diff --git a/service/rum/api_client.go b/service/rum/api_client.go index 35a46c4581b..0ecc223595a 100644 --- a/service/rum/api_client.go +++ b/service/rum/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/rum/api_op_BatchCreateRumMetricDefinitions.go b/service/rum/api_op_BatchCreateRumMetricDefinitions.go index 7c593092dcd..9764ab87678 100644 --- a/service/rum/api_op_BatchCreateRumMetricDefinitions.go +++ b/service/rum/api_op_BatchCreateRumMetricDefinitions.go @@ -11,46 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Specifies the extended metrics and custom metrics that you want a CloudWatch RUM -// app monitor to send to a destination. Valid destinations include CloudWatch and -// Evidently. By default, RUM app monitors send some metrics to CloudWatch. These -// default metrics are listed in CloudWatch metrics that you can collect with -// CloudWatch RUM -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html). -// In addition to these default metrics, you can choose to send extended metrics or -// custom metrics or both. +// Specifies the extended metrics and custom metrics that you want a CloudWatch +// RUM app monitor to send to a destination. Valid destinations include CloudWatch +// and Evidently. By default, RUM app monitors send some metrics to CloudWatch. +// These default metrics are listed in CloudWatch metrics that you can collect +// with CloudWatch RUM (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html) +// . In addition to these default metrics, you can choose to send extended metrics +// or custom metrics or both. +// - Extended metrics enable you to send metrics with additional dimensions not +// included in the default metrics. You can also send extended metrics to Evidently +// as well as CloudWatch. The valid dimension names for the additional dimensions +// for extended metrics are BrowserName , CountryCode , DeviceType , FileType , +// OSName , and PageId . For more information, see Extended metrics that you can +// send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html) +// . +// - Custom metrics are metrics that you define. You can send custom metrics to +// CloudWatch or to CloudWatch Evidently or to both. With custom metrics, you can +// use any metric name and namespace, and to derive the metrics you can use any +// custom events, built-in events, custom attributes, or default attributes. You +// can't send custom metrics to the AWS/RUM namespace. You must send custom +// metrics to a custom namespace that you define. The namespace that you use can't +// start with AWS/ . CloudWatch RUM prepends RUM/CustomMetrics/ to the custom +// namespace that you define, so the final namespace for your metrics in CloudWatch +// is RUM/CustomMetrics/your-custom-namespace . // -// * Extended metrics enable you to send metrics with -// additional dimensions not included in the default metrics. You can also send -// extended metrics to Evidently as well as CloudWatch. The valid dimension names -// for the additional dimensions for extended metrics are BrowserName, CountryCode, -// DeviceType, FileType, OSName, and PageId. For more information, see Extended -// metrics that you can send to CloudWatch and CloudWatch Evidently -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html). -// -// * -// Custom metrics are metrics that you define. You can send custom metrics to -// CloudWatch or to CloudWatch Evidently or to both. With custom metrics, you can -// use any metric name and namespace, and to derive the metrics you can use any -// custom events, built-in events, custom attributes, or default attributes. You -// can't send custom metrics to the AWS/RUM namespace. You must send custom metrics -// to a custom namespace that you define. The namespace that you use can't start -// with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace -// that you define, so the final namespace for your metrics in CloudWatch is -// RUM/CustomMetrics/your-custom-namespace . -// -// The maximum number of metric -// definitions that you can specify in one BatchCreateRumMetricDefinitions -// operation is 200. The maximum number of metric definitions that one destination -// can contain is 2000. Extended metrics sent to CloudWatch and RUM custom metrics -// are charged as CloudWatch custom metrics. Each combination of additional -// dimension name and dimension value counts as a custom metric. For more -// information, see Amazon CloudWatch Pricing -// (https://aws.amazon.com/cloudwatch/pricing/). You must have already created a -// destination for the metrics before you send them. For more information, see -// PutRumMetricsDestination -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html). -// If some metric definitions specified in a BatchCreateRumMetricDefinitions +// The maximum number of metric definitions that you can specify in one +// BatchCreateRumMetricDefinitions operation is 200. The maximum number of metric +// definitions that one destination can contain is 2000. Extended metrics sent to +// CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each +// combination of additional dimension name and dimension value counts as a custom +// metric. For more information, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/) +// . You must have already created a destination for the metrics before you send +// them. For more information, see PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html) +// . If some metric definitions specified in a BatchCreateRumMetricDefinitions // operations are not valid, those metric definitions fail and return errors, but // all valid metric definitions in the same operation still succeed. func (c *Client) BatchCreateRumMetricDefinitions(ctx context.Context, params *BatchCreateRumMetricDefinitionsInput, optFns ...func(*Options)) (*BatchCreateRumMetricDefinitionsOutput, error) { @@ -76,7 +69,7 @@ type BatchCreateRumMetricDefinitionsInput struct { AppMonitorName *string // The destination to send the metrics to. Valid values are CloudWatch and - // Evidently. If you specify Evidently, you must also specify the ARN of the + // Evidently . If you specify Evidently , you must also specify the ARN of the // CloudWatchEvidently experiment that will receive the metrics and an IAM role // that has permission to write to the experiment. // @@ -88,12 +81,12 @@ type BatchCreateRumMetricDefinitionsInput struct { // This member is required. MetricDefinitions []types.MetricDefinitionRequest - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of the + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of the // Evidently experiment that is to receive the metrics. You must have already // defined this experiment as a valid destination. For more information, see - // PutRumMetricsDestination - // (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html). + // PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html) + // . DestinationArn *string noSmithyDocumentSerde diff --git a/service/rum/api_op_BatchDeleteRumMetricDefinitions.go b/service/rum/api_op_BatchDeleteRumMetricDefinitions.go index b5f8e41afe0..8d562eb2816 100644 --- a/service/rum/api_op_BatchDeleteRumMetricDefinitions.go +++ b/service/rum/api_op_BatchDeleteRumMetricDefinitions.go @@ -40,7 +40,7 @@ type BatchDeleteRumMetricDefinitionsInput struct { AppMonitorName *string // Defines the destination where you want to stop sending the specified metrics. - // Valid values are CloudWatch and Evidently. If you specify Evidently, you must + // Valid values are CloudWatch and Evidently . If you specify Evidently , you must // also specify the ARN of the CloudWatchEvidently experiment that is to be the // destination and an IAM role that has permission to write to the experiment. // @@ -52,8 +52,8 @@ type BatchDeleteRumMetricDefinitionsInput struct { // This member is required. MetricDefinitionIds []string - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of the + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of the // Evidently experiment that was receiving the metrics that are being deleted. DestinationArn *string diff --git a/service/rum/api_op_BatchGetRumMetricDefinitions.go b/service/rum/api_op_BatchGetRumMetricDefinitions.go index 6ec7b83009b..4e97e47adcc 100644 --- a/service/rum/api_op_BatchGetRumMetricDefinitions.go +++ b/service/rum/api_op_BatchGetRumMetricDefinitions.go @@ -37,18 +37,18 @@ type BatchGetRumMetricDefinitionsInput struct { AppMonitorName *string // The type of destination that you want to view metrics for. Valid values are - // CloudWatch and Evidently. + // CloudWatch and Evidently . // // This member is required. Destination types.MetricDestination - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of the + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of the // Evidently experiment that corresponds to the destination. DestinationArn *string - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. To retrieve the remaining results, make + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. To retrieve the remaining results, make // another call with the returned NextToken value. MaxResults *int32 @@ -149,8 +149,8 @@ var _ BatchGetRumMetricDefinitionsAPIClient = (*Client)(nil) // BatchGetRumMetricDefinitionsPaginatorOptions is the paginator options for // BatchGetRumMetricDefinitions type BatchGetRumMetricDefinitionsPaginatorOptions struct { - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. To retrieve the remaining results, make + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. To retrieve the remaining results, make // another call with the returned NextToken value. Limit int32 diff --git a/service/rum/api_op_CreateAppMonitor.go b/service/rum/api_op_CreateAppMonitor.go index f7e4ec15f72..5a6304b99fd 100644 --- a/service/rum/api_op_CreateAppMonitor.go +++ b/service/rum/api_op_CreateAppMonitor.go @@ -15,12 +15,10 @@ import ( // your application and sends that data to RUM. The data includes performance and // reliability information such as page load time, client-side errors, and user // behavior. You use this operation only to create a new app monitor. To update an -// existing app monitor, use UpdateAppMonitor -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_UpdateAppMonitor.html) +// existing app monitor, use UpdateAppMonitor (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_UpdateAppMonitor.html) // instead. After you create an app monitor, sign in to the CloudWatch RUM console // to get the JavaScript code snippet to add to your web application. For more -// information, see How do I find a code snippet that I've already generated? -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html) +// information, see How do I find a code snippet that I've already generated? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html) func (c *Client) CreateAppMonitor(ctx context.Context, params *CreateAppMonitorInput, optFns ...func(*Options)) (*CreateAppMonitorOutput, error) { if params == nil { params = &CreateAppMonitorInput{} @@ -38,8 +36,8 @@ func (c *Client) CreateAppMonitor(ctx context.Context, params *CreateAppMonitorI type CreateAppMonitorInput struct { - // The top-level internet domain name for which your application has administrative - // authority. + // The top-level internet domain name for which your application has + // administrative authority. // // This member is required. Domain *string @@ -49,38 +47,38 @@ type CreateAppMonitorInput struct { // This member is required. Name *string - // A structure that contains much of the configuration data for the app monitor. If - // you are using Amazon Cognito for authorization, you must include this structure - // in your request, and it must include the ID of the Amazon Cognito identity pool - // to use for authorization. If you don't include AppMonitorConfiguration, you must - // set up your own authorization method. For more information, see Authorize your - // application to send data to Amazon Web Services - // (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html). - // If you omit this argument, the sample rate used for RUM is set to 10% of the + // A structure that contains much of the configuration data for the app monitor. + // If you are using Amazon Cognito for authorization, you must include this + // structure in your request, and it must include the ID of the Amazon Cognito + // identity pool to use for authorization. If you don't include + // AppMonitorConfiguration , you must set up your own authorization method. For + // more information, see Authorize your application to send data to Amazon Web + // Services (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html) + // . If you omit this argument, the sample rate used for RUM is set to 10% of the // user sessions. AppMonitorConfiguration *types.AppMonitorConfiguration // Specifies whether this app monitor allows the web client to define and send - // custom events. If you omit this parameter, custom events are DISABLED. For more - // information about custom events, see Send custom events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html). + // custom events. If you omit this parameter, custom events are DISABLED . For more + // information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html) + // . CustomEvents *types.CustomEvents // Data collected by RUM is kept by RUM for 30 days and then deleted. This // parameter specifies whether RUM sends a copy of this telemetry data to Amazon // CloudWatch Logs in your account. This enables you to keep the telemetry data for // more than 30 days, but it does incur Amazon CloudWatch Logs charges. If you omit - // this parameter, the default is false. + // this parameter, the default is false . CwLogEnabled *bool - // Assigns one or more tags (key-value pairs) to the app monitor. Tags can help you - // organize and categorize your resources. You can also use them to scope user + // Assigns one or more tags (key-value pairs) to the app monitor. Tags can help + // you organize and categorize your resources. You can also use them to scope user // permissions by granting a user permission to access or change only resources // with certain tag values. Tags don't have any semantic meaning to Amazon Web // Services and are interpreted strictly as strings of characters. You can // associate as many as 50 tags with an app monitor. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags map[string]string noSmithyDocumentSerde diff --git a/service/rum/api_op_DeleteRumMetricsDestination.go b/service/rum/api_op_DeleteRumMetricsDestination.go index 652466c0546..5b6e7d7914a 100644 --- a/service/rum/api_op_DeleteRumMetricsDestination.go +++ b/service/rum/api_op_DeleteRumMetricsDestination.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a destination for CloudWatch RUM extended metrics, so that the specified -// app monitor stops sending extended metrics to that destination. +// Deletes a destination for CloudWatch RUM extended metrics, so that the +// specified app monitor stops sending extended metrics to that destination. func (c *Client) DeleteRumMetricsDestination(ctx context.Context, params *DeleteRumMetricsDestinationInput, optFns ...func(*Options)) (*DeleteRumMetricsDestinationOutput, error) { if params == nil { params = &DeleteRumMetricsDestinationInput{} @@ -36,13 +36,13 @@ type DeleteRumMetricsDestinationInput struct { // This member is required. AppMonitorName *string - // The type of destination to delete. Valid values are CloudWatch and Evidently. + // The type of destination to delete. Valid values are CloudWatch and Evidently . // // This member is required. Destination types.MetricDestination - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of the + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of the // Evidently experiment that corresponds to the destination to delete. DestinationArn *string diff --git a/service/rum/api_op_ListAppMonitors.go b/service/rum/api_op_ListAppMonitors.go index 8bcd9fbe02e..e78c081676e 100644 --- a/service/rum/api_op_ListAppMonitors.go +++ b/service/rum/api_op_ListAppMonitors.go @@ -30,8 +30,8 @@ func (c *Client) ListAppMonitors(ctx context.Context, params *ListAppMonitorsInp type ListAppMonitorsInput struct { - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. MaxResults *int32 // Use the token returned by the previous operation to request the next page of @@ -126,8 +126,8 @@ var _ ListAppMonitorsAPIClient = (*Client)(nil) // ListAppMonitorsPaginatorOptions is the paginator options for ListAppMonitors type ListAppMonitorsPaginatorOptions struct { - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rum/api_op_ListRumMetricsDestinations.go b/service/rum/api_op_ListRumMetricsDestinations.go index 8615b71bba9..effa86409d5 100644 --- a/service/rum/api_op_ListRumMetricsDestinations.go +++ b/service/rum/api_op_ListRumMetricsDestinations.go @@ -14,8 +14,8 @@ import ( // Returns a list of destinations that you have created to receive RUM extended // metrics, for the specified app monitor. For more information about extended -// metrics, see AddRumMetrics -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html). +// metrics, see AddRumMetrics (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html) +// . func (c *Client) ListRumMetricsDestinations(ctx context.Context, params *ListRumMetricsDestinationsInput, optFns ...func(*Options)) (*ListRumMetricsDestinationsOutput, error) { if params == nil { params = &ListRumMetricsDestinationsInput{} @@ -39,8 +39,8 @@ type ListRumMetricsDestinationsInput struct { // This member is required. AppMonitorName *string - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. To retrieve the remaining results, make + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. To retrieve the remaining results, make // another call with the returned NextToken value. MaxResults *int32 @@ -53,8 +53,8 @@ type ListRumMetricsDestinationsInput struct { type ListRumMetricsDestinationsOutput struct { - // The list of CloudWatch RUM extended metrics destinations associated with the app - // monitor that you specified. + // The list of CloudWatch RUM extended metrics destinations associated with the + // app monitor that you specified. Destinations []types.MetricDestinationSummary // A token that you can use in a subsequent operation to retrieve the next set of @@ -141,8 +141,8 @@ var _ ListRumMetricsDestinationsAPIClient = (*Client)(nil) // ListRumMetricsDestinationsPaginatorOptions is the paginator options for // ListRumMetricsDestinations type ListRumMetricsDestinationsPaginatorOptions struct { - // The maximum number of results to return in one operation. The default is 50. The - // maximum that you can specify is 100. To retrieve the remaining results, make + // The maximum number of results to return in one operation. The default is 50. + // The maximum that you can specify is 100. To retrieve the remaining results, make // another call with the returned NextToken value. Limit int32 diff --git a/service/rum/api_op_PutRumMetricsDestination.go b/service/rum/api_op_PutRumMetricsDestination.go index 36413f57372..837e56bcff1 100644 --- a/service/rum/api_op_PutRumMetricsDestination.go +++ b/service/rum/api_op_PutRumMetricsDestination.go @@ -14,8 +14,8 @@ import ( // Creates or updates a destination to receive extended metrics from CloudWatch // RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently // experiment. For more information about extended metrics, see -// BatchCreateRumMetricDefinitions -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html). +// BatchCreateRumMetricDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html) +// . func (c *Client) PutRumMetricsDestination(ctx context.Context, params *PutRumMetricsDestinationInput, optFns ...func(*Options)) (*PutRumMetricsDestinationOutput, error) { if params == nil { params = &PutRumMetricsDestinationInput{} @@ -39,19 +39,19 @@ type PutRumMetricsDestinationInput struct { AppMonitorName *string // Defines the destination to send the metrics to. Valid values are CloudWatch and - // Evidently. If you specify Evidently, you must also specify the ARN of the + // Evidently . If you specify Evidently , you must also specify the ARN of the // CloudWatchEvidently experiment that is to be the destination and an IAM role // that has permission to write to the experiment. // // This member is required. Destination types.MetricDestination - // Use this parameter only if Destination is Evidently. This parameter specifies + // Use this parameter only if Destination is Evidently . This parameter specifies // the ARN of the Evidently experiment that will receive the extended metrics. DestinationArn *string - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of an + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of an // IAM role that RUM will assume to write to the Evidently experiment that you are // sending metrics to. This role must have permission to write to that experiment. IamRoleArn *string diff --git a/service/rum/api_op_TagResource.go b/service/rum/api_op_TagResource.go index d841f7b8dde..8b2226001a3 100644 --- a/service/rum/api_op_TagResource.go +++ b/service/rum/api_op_TagResource.go @@ -21,8 +21,8 @@ import ( // associated with the alarm. If you specify a tag key that is already associated // with the resource, the new tag value that you specify replaces the previous // value for that tag. You can associate as many as 50 tags with a resource. For -// more information, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). +// more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/rum/api_op_UpdateAppMonitor.go b/service/rum/api_op_UpdateAppMonitor.go index f48bb9a5da6..8f837b19216 100644 --- a/service/rum/api_op_UpdateAppMonitor.go +++ b/service/rum/api_op_UpdateAppMonitor.go @@ -15,14 +15,11 @@ import ( // operation, only the parts of the app monitor configuration that you specify in // this operation are changed. For any parameters that you omit, the existing // values are kept. You can't use this operation to change the tags of an existing -// app monitor. To change the tags of an existing app monitor, use TagResource -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html). -// To create a new app monitor, use CreateAppMonitor -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html). -// After you update an app monitor, sign in to the CloudWatch RUM console to get +// app monitor. To change the tags of an existing app monitor, use TagResource (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html) +// . To create a new app monitor, use CreateAppMonitor (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html) +// . After you update an app monitor, sign in to the CloudWatch RUM console to get // the updated JavaScript code snippet to add to your web application. For more -// information, see How do I find a code snippet that I've already generated? -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html) +// information, see How do I find a code snippet that I've already generated? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html) func (c *Client) UpdateAppMonitor(ctx context.Context, params *UpdateAppMonitorInput, optFns ...func(*Options)) (*UpdateAppMonitorOutput, error) { if params == nil { params = &UpdateAppMonitorInput{} @@ -45,19 +42,20 @@ type UpdateAppMonitorInput struct { // This member is required. Name *string - // A structure that contains much of the configuration data for the app monitor. If - // you are using Amazon Cognito for authorization, you must include this structure - // in your request, and it must include the ID of the Amazon Cognito identity pool - // to use for authorization. If you don't include AppMonitorConfiguration, you must - // set up your own authorization method. For more information, see Authorize your - // application to send data to Amazon Web Services - // (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html). + // A structure that contains much of the configuration data for the app monitor. + // If you are using Amazon Cognito for authorization, you must include this + // structure in your request, and it must include the ID of the Amazon Cognito + // identity pool to use for authorization. If you don't include + // AppMonitorConfiguration , you must set up your own authorization method. For + // more information, see Authorize your application to send data to Amazon Web + // Services (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html) + // . AppMonitorConfiguration *types.AppMonitorConfiguration // Specifies whether this app monitor allows the web client to define and send - // custom events. The default is for custom events to be DISABLED. For more - // information about custom events, see Send custom events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html). + // custom events. The default is for custom events to be DISABLED . For more + // information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html) + // . CustomEvents *types.CustomEvents // Data collected by RUM is kept by RUM for 30 days and then deleted. This @@ -66,8 +64,8 @@ type UpdateAppMonitorInput struct { // more than 30 days, but it does incur Amazon CloudWatch Logs charges. CwLogEnabled *bool - // The top-level internet domain name for which your application has administrative - // authority. + // The top-level internet domain name for which your application has + // administrative authority. Domain *string noSmithyDocumentSerde diff --git a/service/rum/api_op_UpdateRumMetricDefinition.go b/service/rum/api_op_UpdateRumMetricDefinition.go index 11a86b1ec08..3069e0b0df4 100644 --- a/service/rum/api_op_UpdateRumMetricDefinition.go +++ b/service/rum/api_op_UpdateRumMetricDefinition.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies one existing metric definition for CloudWatch RUM extended metrics. For -// more information about extended metrics, see BatchCreateRumMetricsDefinitions -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html). +// Modifies one existing metric definition for CloudWatch RUM extended metrics. +// For more information about extended metrics, see +// BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html) +// . func (c *Client) UpdateRumMetricDefinition(ctx context.Context, params *UpdateRumMetricDefinitionInput, optFns ...func(*Options)) (*UpdateRumMetricDefinitionOutput, error) { if params == nil { params = &UpdateRumMetricDefinitionInput{} @@ -37,7 +38,7 @@ type UpdateRumMetricDefinitionInput struct { AppMonitorName *string // The destination to send the metrics to. Valid values are CloudWatch and - // Evidently. If you specify Evidently, you must also specify the ARN of the + // Evidently . If you specify Evidently , you must also specify the ARN of the // CloudWatchEvidently experiment that will receive the metrics and an IAM role // that has permission to write to the experiment. // @@ -55,12 +56,12 @@ type UpdateRumMetricDefinitionInput struct { // This member is required. MetricDefinitionId *string - // This parameter is required if Destination is Evidently. If Destination is - // CloudWatch, do not use this parameter. This parameter specifies the ARN of the + // This parameter is required if Destination is Evidently . If Destination is + // CloudWatch , do not use this parameter. This parameter specifies the ARN of the // Evidently experiment that is to receive the metrics. You must have already // defined this experiment as a valid destination. For more information, see - // PutRumMetricsDestination - // (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html). + // PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html) + // . DestinationArn *string noSmithyDocumentSerde diff --git a/service/rum/types/enums.go b/service/rum/types/enums.go index 9add291edf4..56fc5b0676a 100644 --- a/service/rum/types/enums.go +++ b/service/rum/types/enums.go @@ -47,9 +47,9 @@ const ( StateEnumActive StateEnum = "ACTIVE" ) -// Values returns all known values for StateEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for StateEnum. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (StateEnum) Values() []StateEnum { return []StateEnum{ "CREATED", @@ -70,9 +70,9 @@ const ( TelemetryHttp Telemetry = "http" ) -// Values returns all known values for Telemetry. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Telemetry. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Telemetry) Values() []Telemetry { return []Telemetry{ "errors", diff --git a/service/rum/types/types.go b/service/rum/types/types.go index 5b6ed670cf9..4e648d4e18a 100644 --- a/service/rum/types/types.go +++ b/service/rum/types/types.go @@ -19,16 +19,16 @@ type AppMonitor struct { Created *string // Specifies whether this app monitor allows the web client to define and send - // custom events. For more information about custom events, see Send custom events - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html). + // custom events. For more information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html) + // . CustomEvents *CustomEvents // A structure that contains information about whether this app monitor stores a // copy of the telemetry data that RUM collects using CloudWatch Logs. DataStorage *DataStorage - // The top-level internet domain name for which your application has administrative - // authority. + // The top-level internet domain name for which your application has + // administrative authority. Domain *string // The unique ID of this app monitor. @@ -53,19 +53,18 @@ type AppMonitor struct { // This structure contains much of the configuration data for the app monitor. type AppMonitorConfiguration struct { - // If you set this to true, the RUM web client sets two cookies, a session cookie + // If you set this to true , the RUM web client sets two cookies, a session cookie // and a user cookie. The cookies allow the RUM web client to collect data relating // to the number of users an application has and the behavior of the application // across a sequence of events. Cookies are stored in the top-level domain of the // current page. AllowCookies *bool - // If you set this to true, RUM enables X-Ray tracing for the user sessions that + // If you set this to true , RUM enables X-Ray tracing for the user sessions that // RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also // records an X-Ray segment for allowed HTTP requests. You can see traces and // segments from these user sessions in the X-Ray console and the CloudWatch - // ServiceLens console. For more information, see What is X-Ray? - // (https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) + // ServiceLens console. For more information, see What is X-Ray? (https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) EnableXRay *bool // A list of URLs in your website or application to exclude from RUM data @@ -81,8 +80,8 @@ type AppMonitorConfiguration struct { // pool that is used to authorize the sending of data to RUM. GuestRoleArn *string - // The ID of the Amazon Cognito identity pool that is used to authorize the sending - // of data to RUM. + // The ID of the Amazon Cognito identity pool that is used to authorize the + // sending of data to RUM. IdentityPoolId *string // If this app monitor is to collect data from only certain pages in your @@ -100,16 +99,13 @@ type AppMonitorConfiguration struct { // An array that lists the types of telemetry data that this app monitor is to // collect. - // - // * errors indicates that RUM collects data about unhandled JavaScript - // errors raised by your application. - // - // * performance indicates that RUM collects - // performance data about how your application and its resources are loaded and - // rendered. This includes Core Web Vitals. - // - // * http indicates that RUM collects - // data about HTTP errors thrown by your application. + // - errors indicates that RUM collects data about unhandled JavaScript errors + // raised by your application. + // - performance indicates that RUM collects performance data about how your + // application and its resources are loaded and rendered. This includes Core Web + // Vitals. + // - http indicates that RUM collects data about HTTP errors thrown by your + // application. Telemetries []Telemetry noSmithyDocumentSerde @@ -152,8 +148,7 @@ type AppMonitorSummary struct { noSmithyDocumentSerde } -// A structure that defines one error caused by a BatchCreateRumMetricsDefinitions -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html) +// A structure that defines one error caused by a BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html) // operation. type BatchCreateRumMetricDefinitionsError struct { @@ -175,8 +170,7 @@ type BatchCreateRumMetricDefinitionsError struct { noSmithyDocumentSerde } -// A structure that defines one error caused by a BatchCreateRumMetricsDefinitions -// (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html) +// A structure that defines one error caused by a BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html) // operation. type BatchDeleteRumMetricDefinitionsError struct { @@ -202,7 +196,7 @@ type BatchDeleteRumMetricDefinitionsError struct { type CustomEvents struct { // Specifies whether this app monitor allows the web client to define and send - // custom events. The default is for custom events to be DISABLED. + // custom events. The default is for custom events to be DISABLED . Status CustomEventsStatus noSmithyDocumentSerde @@ -213,8 +207,8 @@ type CustomEvents struct { // structure also contains the name of the log group. type CwLog struct { - // Indicated whether the app monitor stores copies of the data that RUM collects in - // CloudWatch Logs. + // Indicated whether the app monitor stores copies of the data that RUM collects + // in CloudWatch Logs. CwLogEnabled *bool // The name of the log group where the copies are stored. @@ -236,9 +230,9 @@ type DataStorage struct { } // A structure that displays the definition of one extended metric that RUM sends -// to CloudWatch or CloudWatch Evidently. For more information, see Additional -// metrics that you can send to CloudWatch and CloudWatch Evidently -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html). +// to CloudWatch or CloudWatch Evidently. For more information, see Additional +// metrics that you can send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html) +// . type MetricDefinition struct { // The ID of this metric definition. @@ -251,16 +245,16 @@ type MetricDefinition struct { // This member is required. Name *string - // This field is a map of field paths to dimension names. It defines the dimensions - // to associate with this metric in CloudWatch The value of this field is used only - // if the metric destination is CloudWatch. If the metric destination is Evidently, - // the value of DimensionKeys is ignored. + // This field is a map of field paths to dimension names. It defines the + // dimensions to associate with this metric in CloudWatch The value of this field + // is used only if the metric destination is CloudWatch . If the metric destination + // is Evidently , the value of DimensionKeys is ignored. DimensionKeys map[string]string // The pattern that defines the metric. RUM checks events that happen in a user's // session against the pattern, and events that match the pattern are sent to the // metric destination. If the metrics destination is CloudWatch and the event also - // matches a value in DimensionKeys, then the metric is published with the + // matches a value in DimensionKeys , then the metric is published with the // specified dimensions. EventPattern *string @@ -268,8 +262,8 @@ type MetricDefinition struct { // this field displays the metric namespace that the custom metric is published to. Namespace *string - // Use this field only if you are sending this metric to CloudWatch. It defines the - // CloudWatch metric unit that this metric is measured in. + // Use this field only if you are sending this metric to CloudWatch. It defines + // the CloudWatch metric unit that this metric is measured in. UnitLabel *string // The field within the event object that the metric value is sourced from. @@ -280,198 +274,115 @@ type MetricDefinition struct { // Use this structure to define one extended metric or custom metric that RUM will // send to CloudWatch or CloudWatch Evidently. For more information, see -// Additional metrics that you can send to CloudWatch and CloudWatch Evidently -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html). -// This structure is validated differently for extended metrics and custom metrics. -// For extended metrics that are sent to the AWS/RUM namespace, the following -// validations apply: -// -// * The Namespace parameter must be omitted or set to -// AWS/RUM. -// -// * Only certain combinations of values for Name, ValueKey, and -// EventPattern are valid. In addition to what is displayed in the list below, the -// EventPattern can also include information used by the DimensionKeys field. -// -// * If -// Name is PerformanceNavigationDuration, then ValueKeymust be -// event_details.duration and the EventPattern must include -// {"event_type":["com.amazon.rum.performance_navigation_event"]} -// -// * If Name is -// PerformanceResourceDuration, then ValueKeymust be event_details.duration and the -// EventPattern must include -// {"event_type":["com.amazon.rum.performance_resource_event"]} -// -// * If Name is -// NavigationSatisfiedTransaction, then ValueKeymust be null and the EventPattern -// must include { "event_type": ["com.amazon.rum.performance_navigation_event"], -// "event_details": { "duration": [{ "numeric": [">",2000] }] } } -// -// * If Name is -// NavigationToleratedTransaction, then ValueKeymust be null and the EventPattern -// must include { "event_type": ["com.amazon.rum.performance_navigation_event"], -// "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } } -// -// * If -// Name is NavigationFrustratedTransaction, then ValueKeymust be null and the -// EventPattern must include { "event_type": -// ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": -// [{ "numeric": [">=",8000] }] } } -// -// * If Name is WebVitalsCumulativeLayoutShift, -// then ValueKeymust be event_details.value and the EventPattern must include -// {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]} -// -// * If Name is -// WebVitalsFirstInputDelay, then ValueKeymust be event_details.value and the -// EventPattern must include -// {"event_type":["com.amazon.rum.first_input_delay_event"]} -// -// * If Name is -// WebVitalsLargestContentfulPaint, then ValueKeymust be event_details.value and -// the EventPattern must include -// {"event_type":["com.amazon.rum.largest_contentful_paint_event"]} -// -// * If Name is -// JsErrorCount, then ValueKeymust be null and the EventPattern must include -// {"event_type":["com.amazon.rum.js_error_event"]} -// -// * If Name is HttpErrorCount, -// then ValueKeymust be null and the EventPattern must include -// {"event_type":["com.amazon.rum.http_event"]} -// -// * If Name is SessionCount, then -// ValueKeymust be null and the EventPattern must include -// {"event_type":["com.amazon.rum.session_start_event"]} -// -// For custom metrics, the -// following validation rules apply: -// -// * The namespace can't be omitted and can't be -// AWS/RUM. You can use the AWS/RUM namespace only for extended metrics. -// -// * All -// dimensions listed in the DimensionKeys field must be present in the value of -// EventPattern. -// -// * The values that you specify for ValueKey, EventPattern, and -// DimensionKeys must be fields in RUM events, so all first-level keys in these -// fields must be one of the keys in the list later in this section. -// -// * If you set -// a value for EventPattern, it must be a JSON object. -// -// * For every non-empty -// event_details, there must be a non-empty event_type. -// -// * If EventPattern contains -// an event_details field, it must also contain an event_type. For every built-in -// event_type that you use, you must use a value for event_details that corresponds -// to that event_type. For information about event details that correspond to event -// types, see RUM event details -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails). -// -// * -// In EventPattern, any JSON array must contain only one value. -// -// Valid key values -// for first-level keys in the ValueKey, EventPattern, and DimensionKeys fields: -// -// * -// account_id -// -// * application_Id -// -// * application_version -// -// * application_name -// -// * -// batch_id -// -// * event_details -// -// * event_id -// -// * event_interaction -// -// * event_timestamp -// -// * -// event_type -// -// * event_version -// -// * log_stream -// -// * metadata -// -// * sessionId -// -// * -// user_details -// -// * userId +// Additional metrics that you can send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html) +// . This structure is validated differently for extended metrics and custom +// metrics. For extended metrics that are sent to the AWS/RUM namespace, the +// following validations apply: +// - The Namespace parameter must be omitted or set to AWS/RUM . +// - Only certain combinations of values for Name , ValueKey , and EventPattern +// are valid. In addition to what is displayed in the list below, the +// EventPattern can also include information used by the DimensionKeys field. +// - If Name is PerformanceNavigationDuration , then ValueKey must be +// event_details.duration and the EventPattern must include +// {"event_type":["com.amazon.rum.performance_navigation_event"]} +// - If Name is PerformanceResourceDuration , then ValueKey must be +// event_details.duration and the EventPattern must include +// {"event_type":["com.amazon.rum.performance_resource_event"]} +// - If Name is NavigationSatisfiedTransaction , then ValueKey must be null and +// the EventPattern must include { "event_type": +// ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": +// [{ "numeric": [">",2000] }] } } +// - If Name is NavigationToleratedTransaction , then ValueKey must be null and +// the EventPattern must include { "event_type": +// ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": +// [{ "numeric": [">=",2000,"<"8000] }] } } +// - If Name is NavigationFrustratedTransaction , then ValueKey must be null and +// the EventPattern must include { "event_type": +// ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": +// [{ "numeric": [">=",8000] }] } } +// - If Name is WebVitalsCumulativeLayoutShift , then ValueKey must be +// event_details.value and the EventPattern must include +// {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]} +// - If Name is WebVitalsFirstInputDelay , then ValueKey must be +// event_details.value and the EventPattern must include +// {"event_type":["com.amazon.rum.first_input_delay_event"]} +// - If Name is WebVitalsLargestContentfulPaint , then ValueKey must be +// event_details.value and the EventPattern must include +// {"event_type":["com.amazon.rum.largest_contentful_paint_event"]} +// - If Name is JsErrorCount , then ValueKey must be null and the EventPattern +// must include {"event_type":["com.amazon.rum.js_error_event"]} +// - If Name is HttpErrorCount , then ValueKey must be null and the EventPattern +// must include {"event_type":["com.amazon.rum.http_event"]} +// - If Name is SessionCount , then ValueKey must be null and the EventPattern +// must include {"event_type":["com.amazon.rum.session_start_event"]} +// +// For custom metrics, the following validation rules apply: +// - The namespace can't be omitted and can't be AWS/RUM . You can use the +// AWS/RUM namespace only for extended metrics. +// - All dimensions listed in the DimensionKeys field must be present in the +// value of EventPattern . +// - The values that you specify for ValueKey , EventPattern , and DimensionKeys +// must be fields in RUM events, so all first-level keys in these fields must be +// one of the keys in the list later in this section. +// - If you set a value for EventPattern , it must be a JSON object. +// - For every non-empty event_details , there must be a non-empty event_type . +// - If EventPattern contains an event_details field, it must also contain an +// event_type . For every built-in event_type that you use, you must use a value +// for event_details that corresponds to that event_type . For information about +// event details that correspond to event types, see RUM event details (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails) +// . +// - In EventPattern , any JSON array must contain only one value. +// +// Valid key values for first-level keys in the ValueKey , EventPattern , and +// DimensionKeys fields: +// - account_id +// - application_Id +// - application_version +// - application_name +// - batch_id +// - event_details +// - event_id +// - event_interaction +// - event_timestamp +// - event_type +// - event_version +// - log_stream +// - metadata +// - sessionId +// - user_details +// - userId type MetricDefinitionRequest struct { // The name for the metric that is defined in this structure. For custom metrics, // you can specify any name that you like. For extended metrics, valid values are // the following: - // - // * PerformanceNavigationDuration - // - // * - // PerformanceResourceDuration - // - // * NavigationSatisfiedTransaction - // - // * - // NavigationToleratedTransaction - // - // * NavigationFrustratedTransaction - // - // * - // WebVitalsCumulativeLayoutShift - // - // * WebVitalsFirstInputDelay - // - // * - // WebVitalsLargestContentfulPaint - // - // * JsErrorCount - // - // * HttpErrorCount - // - // * - // SessionCount + // - PerformanceNavigationDuration + // - PerformanceResourceDuration + // - NavigationSatisfiedTransaction + // - NavigationToleratedTransaction + // - NavigationFrustratedTransaction + // - WebVitalsCumulativeLayoutShift + // - WebVitalsFirstInputDelay + // - WebVitalsLargestContentfulPaint + // - JsErrorCount + // - HttpErrorCount + // - SessionCount // // This member is required. Name *string - // Use this field only if you are sending the metric to CloudWatch. This field is a - // map of field paths to dimension names. It defines the dimensions to associate + // Use this field only if you are sending the metric to CloudWatch. This field is + // a map of field paths to dimension names. It defines the dimensions to associate // with this metric in CloudWatch. For extended metrics, valid values for the // entries in this field are the following: - // - // * "metadata.pageId": "PageId" - // - // * - // "metadata.browserName": "BrowserName" - // - // * "metadata.deviceType": "DeviceType" - // - // * - // "metadata.osName": "OSName" - // - // * "metadata.countryCode": "CountryCode" - // - // * - // "event_details.fileType": "FileType" - // - // For both extended metrics and custom - // metrics, all dimensions listed in this field must also be included in - // EventPattern. + // - "metadata.pageId": "PageId" + // - "metadata.browserName": "BrowserName" + // - "metadata.deviceType": "DeviceType" + // - "metadata.osName": "OSName" + // - "metadata.countryCode": "CountryCode" + // - "event_details.fileType": "FileType" + // For both extended metrics and custom metrics, all dimensions listed in this + // field must also be included in EventPattern . DimensionKeys map[string]string // The pattern that defines the metric, specified as a JSON object. RUM checks @@ -479,23 +390,16 @@ type MetricDefinitionRequest struct { // match the pattern are sent to the metric destination. When you define extended // metrics, the metric definition is not valid if EventPattern is omitted. Example // event patterns: - // - // * '{ "event_type": ["com.amazon.rum.js_error_event"], - // "metadata": { "browserName": [ "Chrome", "Safari" ], } }' - // - // * '{ "event_type": - // ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ - // "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", - // 2000 ] }] } }' - // - // * '{ "event_type": - // ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ - // "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": - // [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }' - // - // If the metrics destination' is - // CloudWatch and the event also matches a value in DimensionKeys, then the metric - // is published with the specified dimensions. + // - '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { + // "browserName": [ "Chrome", "Safari" ], } }' + // - '{ "event_type": ["com.amazon.rum.performance_navigation_event"], + // "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { + // "duration": [{ "numeric": [ "<", 2000 ] }] } }' + // - '{ "event_type": ["com.amazon.rum.performance_navigation_event"], + // "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, + // "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }' + // If the metrics destination' is CloudWatch and the event also matches a value in + // DimensionKeys , then the metric is published with the specified dimensions. EventPattern *string // If this structure is for a custom metric instead of an extended metrics, use @@ -522,14 +426,14 @@ type MetricDefinitionRequest struct { // sends extended metrics to. type MetricDestinationSummary struct { - // Specifies whether the destination is CloudWatch or Evidently. + // Specifies whether the destination is CloudWatch or Evidently . Destination MetricDestination - // If the destination is Evidently, this specifies the ARN of the Evidently + // If the destination is Evidently , this specifies the ARN of the Evidently // experiment that receives the metrics. DestinationArn *string - // This field appears only when the destination is Evidently. It specifies the ARN + // This field appears only when the destination is Evidently . It specifies the ARN // of the IAM role that is used to write to the Evidently experiment that receives // the metrics. IamRoleArn *string @@ -539,12 +443,12 @@ type MetricDestinationSummary struct { // A structure that defines a key and values that you can use to filter the // results. The only performance events that are returned are those that have -// values matching the ones that you specify in one of your QueryFilter structures. -// For example, you could specify Browser as the Name and specify Chrome,Firefox as -// the Values to return events generated only from those browsers. Specifying -// Invert as the Name works as a "not equal to" filter. For example, specify Invert -// as the Name and specify Chrome as the value to return all events except events -// from user sessions with the Chrome browser. +// values matching the ones that you specify in one of your QueryFilter +// structures. For example, you could specify Browser as the Name and specify +// Chrome,Firefox as the Values to return events generated only from those +// browsers. Specifying Invert as the Name works as a "not equal to" filter. For +// example, specify Invert as the Name and specify Chrome as the value to return +// all events except events from user sessions with the Chrome browser. type QueryFilter struct { // The name of a key to search for. The filter returns only the events that match @@ -579,8 +483,8 @@ type RumEvent struct { // This member is required. Timestamp *time.Time - // The JSON schema that denotes the type of event this is, such as a page load or a - // new session. + // The JSON schema that denotes the type of event this is, such as a page load or + // a new session. // // This member is required. Type *string @@ -603,8 +507,8 @@ type TimeRange struct { // This member is required. After int64 - // The end of the time range to retrieve performance events from. If you omit this, - // the time range extends to the time that this operation is performed. + // The end of the time range to retrieve performance events from. If you omit + // this, the time range extends to the time that this operation is performed. Before int64 noSmithyDocumentSerde diff --git a/service/s3/api_client.go b/service/s3/api_client.go index e462917a707..8ed26201644 100644 --- a/service/s3/api_client.go +++ b/service/s3/api_client.go @@ -32,8 +32,8 @@ import ( const ServiceID = "S3" const ServiceAPIVersion = "2006-03-01" -// Client provides the API client to make operations call for Amazon Simple Storage -// Service. +// Client provides the API client to make operations call for Amazon Simple +// Storage Service. type Client struct { options Options } @@ -135,7 +135,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment @@ -159,8 +159,8 @@ type Options struct { UseDualstack bool // Allows you to enable the client to use path-style addressing, i.e., - // https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual - // hosted bucket addressing when possible(https://BUCKET.s3.amazonaws.com/KEY). + // https://s3.amazonaws.com/BUCKET/KEY . By default, the S3 client will use virtual + // hosted bucket addressing when possible( https://BUCKET.s3.amazonaws.com/KEY ). UsePathStyle bool // Signature Version 4a (SigV4a) Signer @@ -539,8 +539,8 @@ func add100Continue(stack *middleware.Stack, options Options) error { return s3shared.Add100Continue(stack, options.ContinueHeaderThresholdBytes) } -// ComputedInputChecksumsMetadata provides information about the algorithms used to -// compute the checksum(s) of the input payload. +// ComputedInputChecksumsMetadata provides information about the algorithms used +// to compute the checksum(s) of the input payload. type ComputedInputChecksumsMetadata struct { // ComputedChecksums is a map of algorithm name to checksum value of the computed // input payload's checksums. @@ -560,8 +560,8 @@ func GetComputedInputChecksumsMetadata(m middleware.Metadata) (ComputedInputChec } -// ChecksumValidationMetadata contains metadata such as the checksum algorithm used -// for data integrity validation. +// ChecksumValidationMetadata contains metadata such as the checksum algorithm +// used for data integrity validation. type ChecksumValidationMetadata struct { // AlgorithmsUsed is the set of the checksum algorithms used to validate the // response payload. The response payload must be completely read in order for the @@ -570,10 +570,10 @@ type ChecksumValidationMetadata struct { AlgorithmsUsed []string } -// GetChecksumValidationMetadata returns the set of algorithms that will be used to -// validate the response payload with. The response payload must be completely read -// in order for the checksum validation to be performed. An error is returned by -// the operation output's response io.ReadCloser if the computed checksums are +// GetChecksumValidationMetadata returns the set of algorithms that will be used +// to validate the response payload with. The response payload must be completely +// read in order for the checksum validation to be performed. An error is returned +// by the operation output's response io.ReadCloser if the computed checksums are // invalid. Returns false if no checksum algorithm used metadata was found. func GetChecksumValidationMetadata(m middleware.Metadata) (ChecksumValidationMetadata, bool) { values, ok := internalChecksum.GetOutputValidationAlgorithmsUsed(m) @@ -600,8 +600,8 @@ func disableAcceptEncodingGzip(stack *middleware.Stack) error { return acceptencodingcust.AddAcceptEncodingGzip(stack, acceptencodingcust.AddAcceptEncodingGzipOptions{}) } -// ResponseError provides the HTTP centric error type wrapping the underlying error -// with the HTTP response value and the deserialized RequestID. +// ResponseError provides the HTTP centric error type wrapping the underlying +// error with the HTTP response value and the deserialized RequestID. type ResponseError interface { error @@ -611,8 +611,8 @@ type ResponseError interface { var _ ResponseError = (*s3shared.ResponseError)(nil) -// GetHostIDMetadata retrieves the host id from middleware metadata returns host id -// as string along with a boolean indicating presence of hostId on middleware +// GetHostIDMetadata retrieves the host id from middleware metadata returns host +// id as string along with a boolean indicating presence of hostId on middleware // metadata. func GetHostIDMetadata(metadata middleware.Metadata) (string, bool) { return s3shared.GetHostIDMetadata(metadata) diff --git a/service/s3/api_op_AbortMultipartUpload.go b/service/s3/api_op_AbortMultipartUpload.go index 5825cdbb8f8..0e51d4acebb 100644 --- a/service/s3/api_op_AbortMultipartUpload.go +++ b/service/s3/api_op_AbortMultipartUpload.go @@ -19,32 +19,16 @@ import ( // result, it might be necessary to abort a given multipart upload multiple times // in order to completely free all storage consumed by all parts. To verify that // all parts have been removed, so you don't get charged for the part storage, you -// should call the ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) action and -// ensure that the parts list is empty. For information about permissions required -// to use the multipart upload, see Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The -// following operations are related to AbortMultipartUpload: -// -// * -// CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// should call the ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// action and ensure that the parts list is empty. For information about +// permissions required to use the multipart upload, see Multipart Upload and +// Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// . The following operations are related to AbortMultipartUpload : +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipartUploadInput, optFns ...func(*Options)) (*AbortMultipartUploadOutput, error) { if params == nil { params = &AbortMultipartUploadInput{} @@ -68,17 +52,15 @@ type AbortMultipartUploadInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -101,8 +83,7 @@ type AbortMultipartUploadInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_CompleteMultipartUpload.go b/service/s3/api_op_CompleteMultipartUpload.go index 8ff31909850..f8e9956e91c 100644 --- a/service/s3/api_op_CompleteMultipartUpload.go +++ b/service/s3/api_op_CompleteMultipartUpload.go @@ -13,10 +13,9 @@ import ( ) // Completes a multipart upload by assembling previously uploaded parts. You first -// initiate the multipart upload and then upload all parts using the UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) operation. -// After successfully uploading all relevant parts of an upload, you call this -// action to complete the upload. Upon receiving this request, Amazon S3 +// initiate the multipart upload and then upload all parts using the UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// operation. After successfully uploading all relevant parts of an upload, you +// call this action to complete the upload. Upon receiving this request, Amazon S3 // concatenates all the parts in ascending order by part number to create a new // object. In the Complete Multipart Upload request, you must provide the parts // list. You must ensure that the parts list is complete. This action concatenates @@ -36,74 +35,38 @@ import ( // persists, the SDKs throws an exception (or, for the SDKs that don't use // exceptions, they return the error). Note that if CompleteMultipartUpload fails, // applications should be prepared to retry the failed requests. For more -// information, see Amazon S3 Error Best Practices -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html). You -// cannot use Content-Type: application/x-www-form-urlencoded with Complete +// information, see Amazon S3 Error Best Practices (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html) +// . You cannot use Content-Type: application/x-www-form-urlencoded with Complete // Multipart Upload requests. Also, if you do not provide a Content-Type header, // CompleteMultipartUpload returns a 200 OK response. For more information about -// multipart uploads, see Uploading Objects Using Multipart Upload -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For -// information about permissions required to use the multipart upload API, see -// Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). -// CompleteMultipartUpload has the following special errors: +// multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) +// . For information about permissions required to use the multipart upload API, +// see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// . CompleteMultipartUpload has the following special errors: +// - Error code: EntityTooSmall +// - Description: Your proposed upload is smaller than the minimum allowed +// object size. Each part must be at least 5 MB in size, except the last part. +// - 400 Bad Request +// - Error code: InvalidPart +// - Description: One or more of the specified parts could not be found. The +// part might not have been uploaded, or the specified entity tag might not have +// matched the part's entity tag. +// - 400 Bad Request +// - Error code: InvalidPartOrder +// - Description: The list of parts was not in ascending order. The parts list +// must be specified in order by part number. +// - 400 Bad Request +// - Error code: NoSuchUpload +// - Description: The specified multipart upload does not exist. The upload ID +// might be invalid, or the multipart upload might have been aborted or completed. +// - 404 Not Found // -// * Error code: -// EntityTooSmall -// -// * Description: Your proposed upload is smaller than the minimum -// allowed object size. Each part must be at least 5 MB in size, except the last -// part. -// -// * 400 Bad Request -// -// * Error code: InvalidPart -// -// * Description: One or more -// of the specified parts could not be found. The part might not have been -// uploaded, or the specified entity tag might not have matched the part's entity -// tag. -// -// * 400 Bad Request -// -// * Error code: InvalidPartOrder -// -// * Description: The list -// of parts was not in ascending order. The parts list must be specified in order -// by part number. -// -// * 400 Bad Request -// -// * Error code: NoSuchUpload -// -// * Description: -// The specified multipart upload does not exist. The upload ID might be invalid, -// or the multipart upload might have been aborted or completed. -// -// * 404 Not -// Found -// -// The following operations are related to CompleteMultipartUpload: -// -// * -// CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// The following operations are related to CompleteMultipartUpload : +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error) { if params == nil { params = &CompleteMultipartUploadInput{} @@ -127,17 +90,15 @@ type CompleteMultipartUploadInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -155,32 +116,28 @@ type CompleteMultipartUploadInput struct { // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32C *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA1 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -195,29 +152,25 @@ type CompleteMultipartUploadInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer // The server-side encryption (SSE) algorithm used to encrypt the object. This // parameter is needed only when the object was created using a checksum algorithm. - // For more information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // For more information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerAlgorithm *string // The server-side encryption (SSE) customer managed key. This parameter is needed // only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKey *string // The MD5 server-side encryption (SSE) customer managed key. This parameter is // needed only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKeyMD5 *string @@ -233,17 +186,15 @@ type CompleteMultipartUploadOutput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. Bucket *string // Indicates whether the multipart upload uses an S3 Bucket Key for server-side @@ -253,32 +204,28 @@ type CompleteMultipartUploadOutput struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -288,13 +235,12 @@ type CompleteMultipartUploadOutput struct { // data. If the entity tag is not an MD5 digest of the object data, it will contain // one or more nonhexadecimal characters and/or will consist of less than 32 or // more than 32 hexadecimal digits. For more information about how the entity tag - // is calculated, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // is calculated, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ETag *string - // If the object expiration is configured, this will contain the expiration date - // (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded. + // If the object expiration is configured, this will contain the expiration date ( + // expiry-date ) and rule ID ( rule-id ). The value of rule-id is URL-encoded. Expiration *string // The object key of the newly created object. @@ -313,11 +259,11 @@ type CompleteMultipartUploadOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption - // Version ID of the newly created object, in case the bucket has versioning turned - // on. + // Version ID of the newly created object, in case the bucket has versioning + // turned on. VersionId *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_CopyObject.go b/service/s3/api_op_CopyObject.go index dc10efb7929..b80be013548 100644 --- a/service/s3/api_op_CopyObject.go +++ b/service/s3/api_op_CopyObject.go @@ -18,88 +18,68 @@ import ( // up to 5 GB in size in a single atomic action using this API. However, to copy an // object greater than 5 GB, you must use the multipart upload Upload Part - Copy // (UploadPartCopy) API. For more information, see Copy Object Using the REST -// Multipart Upload API -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html). -// All copy requests must be authenticated. Additionally, you must have read access -// to the source object and write access to the destination bucket. For more -// information, see REST Authentication -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). Both -// the Region that you want to copy the object from and the Region that you want to -// copy the object to must be enabled for your account. A copy request might return -// an error when Amazon S3 receives the copy request or while Amazon S3 is copying -// the files. If the error occurs before the copy action starts, you receive a -// standard Amazon S3 error. If the error occurs during the copy operation, the -// error response is embedded in the 200 OK response. This means that a 200 OK -// response can contain either a success or an error. If you call the S3 API -// directly, make sure to design your application to parse the contents of the -// response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs -// handle this condition. The SDKs detect the embedded error and apply error -// handling per your configuration settings (including automatically retrying the -// request as appropriate). If the condition persists, the SDKs throws an exception -// (or, for the SDKs that don't use exceptions, they return the error). If the copy -// is successful, you receive a response with information about the copied object. -// If the request is an HTTP 1.1 request, the response is chunk encoded. If it were -// not, it would not contain the content-length, and you would need to read the -// entire body. The copy request charge is based on the storage class and Region -// that you specify for the destination object. For pricing information, see Amazon -// S3 pricing (http://aws.amazon.com/s3/pricing/). Amazon S3 transfer acceleration -// does not support cross-Region copies. If you request a cross-Region copy using a -// transfer acceleration endpoint, you get a 400 Bad Request error. For more -// information, see Transfer Acceleration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). -// Metadata When copying an object, you can preserve all metadata (default) or +// Multipart Upload API (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html) +// . All copy requests must be authenticated. Additionally, you must have read +// access to the source object and write access to the destination bucket. For more +// information, see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) +// . Both the Region that you want to copy the object from and the Region that you +// want to copy the object to must be enabled for your account. A copy request +// might return an error when Amazon S3 receives the copy request or while Amazon +// S3 is copying the files. If the error occurs before the copy action starts, you +// receive a standard Amazon S3 error. If the error occurs during the copy +// operation, the error response is embedded in the 200 OK response. This means +// that a 200 OK response can contain either a success or an error. If you call +// the S3 API directly, make sure to design your application to parse the contents +// of the response and handle it appropriately. If you use Amazon Web Services +// SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply +// error handling per your configuration settings (including automatically retrying +// the request as appropriate). If the condition persists, the SDKs throws an +// exception (or, for the SDKs that don't use exceptions, they return the error). +// If the copy is successful, you receive a response with information about the +// copied object. If the request is an HTTP 1.1 request, the response is chunk +// encoded. If it were not, it would not contain the content-length, and you would +// need to read the entire body. The copy request charge is based on the storage +// class and Region that you specify for the destination object. For pricing +// information, see Amazon S3 pricing (http://aws.amazon.com/s3/pricing/) . Amazon +// S3 transfer acceleration does not support cross-Region copies. If you request a +// cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad +// Request error. For more information, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) +// . Metadata When copying an object, you can preserve all metadata (default) or // specify new metadata. However, the ACL is not preserved and is set to private // for the user making the request. To override the default ACL setting, specify a -// new ACL when generating a copy request. For more information, see Using ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To -// specify whether you want the object metadata copied from the source object or -// replaced with metadata provided in the request, you can optionally add the +// new ACL when generating a copy request. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) +// . To specify whether you want the object metadata copied from the source object +// or replaced with metadata provided in the request, you can optionally add the // x-amz-metadata-directive header. When you grant permissions, you can use the // s3:x-amz-metadata-directive condition key to enforce certain metadata behavior // when objects are uploaded. For more information, see Specifying Conditions in a -// Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) in -// the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition -// keys, see Actions, Resources, and Condition Keys for Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html). -// x-amz-website-redirect-location is unique to each object and must be specified -// in the request headers to copy the value. x-amz-copy-source-if Headers To only -// copy an object under certain conditions, such as whether the Etag matches or -// whether the object was modified before or after a specified date, use the -// following request parameters: +// Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) +// in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition +// keys, see Actions, Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) +// . x-amz-website-redirect-location is unique to each object and must be +// specified in the request headers to copy the value. x-amz-copy-source-if Headers +// To only copy an object under certain conditions, such as whether the Etag +// matches or whether the object was modified before or after a specified date, use +// the following request parameters: +// - x-amz-copy-source-if-match +// - x-amz-copy-source-if-none-match +// - x-amz-copy-source-if-unmodified-since +// - x-amz-copy-source-if-modified-since // -// * x-amz-copy-source-if-match +// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since +// headers are present in the request and evaluate as follows, Amazon S3 returns +// 200 OK and copies the data: +// - x-amz-copy-source-if-match condition evaluates to true +// - x-amz-copy-source-if-unmodified-since condition evaluates to false // -// * -// x-amz-copy-source-if-none-match +// If both the x-amz-copy-source-if-none-match and +// x-amz-copy-source-if-modified-since headers are present in the request and +// evaluate as follows, Amazon S3 returns the 412 Precondition Failed response +// code: +// - x-amz-copy-source-if-none-match condition evaluates to false +// - x-amz-copy-source-if-modified-since condition evaluates to true // -// * x-amz-copy-source-if-unmodified-since -// -// * -// x-amz-copy-source-if-modified-since -// -// If both the x-amz-copy-source-if-match and -// x-amz-copy-source-if-unmodified-since headers are present in the request and -// evaluate as follows, Amazon S3 returns 200 OK and copies the data: -// -// * -// x-amz-copy-source-if-match condition evaluates to true -// -// * -// x-amz-copy-source-if-unmodified-since condition evaluates to false -// -// If both the -// x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers -// are present in the request and evaluate as follows, Amazon S3 returns the 412 -// Precondition Failed response code: -// -// * x-amz-copy-source-if-none-match condition -// evaluates to false -// -// * x-amz-copy-source-if-modified-since condition evaluates to -// true -// -// All headers with the x-amz- prefix, including x-amz-copy-source, must be +// All headers with the x-amz- prefix, including x-amz-copy-source , must be // signed. Server-side encryption Amazon S3 automatically encrypts all new objects // that are copied to an S3 bucket. When copying an object, if you don't specify // encryption information in your copy request, the encryption setting of the @@ -121,29 +101,24 @@ import ( // object for the copy is stored in Amazon S3 using SSE-C, you must provide the // necessary encryption information in your request so that Amazon S3 can decrypt // the object for copying. For more information about server-side encryption, see -// Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). If -// a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. -// For more information, see Amazon S3 Bucket Keys -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the Amazon -// S3 User Guide. Access Control List (ACL)-Specific Request Headers When copying -// an object, you can optionally use headers to grant ACL-based permissions. By -// default, all objects are private. Only the owner has full access control. When -// adding a new object, you can grant permissions to individual Amazon Web Services -// accounts or to predefined groups defined by Amazon S3. These permissions are -// then added to the ACL on the object. For more information, see Access Control -// List (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing -// ACLs Using the REST API -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). If -// the bucket that you're copying objects to uses the bucket owner enforced setting -// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. -// Buckets that use this setting only accept PUT requests that don't specify an ACL -// or PUT requests that specify bucket owner full control ACLs, such as the -// bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed -// in the XML format. For more information, see Controlling ownership of objects -// and disabling ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// . If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the +// object. For more information, see Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) +// in the Amazon S3 User Guide. Access Control List (ACL)-Specific Request Headers +// When copying an object, you can optionally use headers to grant ACL-based +// permissions. By default, all objects are private. Only the owner has full access +// control. When adding a new object, you can grant permissions to individual +// Amazon Web Services accounts or to predefined groups defined by Amazon S3. These +// permissions are then added to the ACL on the object. For more information, see +// Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html) +// . If the bucket that you're copying objects to uses the bucket owner enforced +// setting for S3 Object Ownership, ACLs are disabled and no longer affect +// permissions. Buckets that use this setting only accept PUT requests that don't +// specify an ACL or PUT requests that specify bucket owner full control ACLs, such +// as the bucket-owner-full-control canned ACL or an equivalent form of this ACL +// expressed in the XML format. For more information, see Controlling ownership of +// objects and disabling ACLs (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced // setting for Object Ownership, all objects written to the bucket by any account // will be owned by the bucket owner. Checksums When copying an object, if it has a @@ -152,33 +127,25 @@ import ( // to use with the x-amz-checksum-algorithm header. Storage Class Options You can // use the CopyObject action to change the storage class of an object that is // already stored in Amazon S3 using the StorageClass parameter. For more -// information, see Storage Classes -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in -// the Amazon S3 User Guide. Versioning By default, x-amz-copy-source identifies -// the current version of an object to copy. If the current version is a delete -// marker, Amazon S3 behaves as if the object was deleted. To copy a different -// version, use the versionId subresource. If you enable versioning on the target -// bucket, Amazon S3 generates a unique version ID for the object being copied. -// This version ID is different from the version ID of the source object. Amazon S3 -// returns the version ID of the copied object in the x-amz-version-id response -// header in the response. If you do not enable versioning or suspend it on the -// target bucket, the version ID that Amazon S3 generates is always null. If the -// source object's storage class is GLACIER, you must restore a copy of this object -// before you can use it as a source object for the copy operation. For more -// information, see RestoreObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). The -// following operations are related to CopyObject: +// information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) +// in the Amazon S3 User Guide. Versioning By default, x-amz-copy-source +// identifies the current version of an object to copy. If the current version is a +// delete marker, Amazon S3 behaves as if the object was deleted. To copy a +// different version, use the versionId subresource. If you enable versioning on +// the target bucket, Amazon S3 generates a unique version ID for the object being +// copied. This version ID is different from the version ID of the source object. +// Amazon S3 returns the version ID of the copied object in the x-amz-version-id +// response header in the response. If you do not enable versioning or suspend it +// on the target bucket, the version ID that Amazon S3 generates is always null. If +// the source object's storage class is GLACIER, you must restore a copy of this +// object before you can use it as a source object for the copy operation. For more +// information, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) +// . The following operations are related to CopyObject : +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// For more -// information, see Copying Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html). +// For more information, see Copying Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html) +// . func (c *Client) CopyObject(ctx context.Context, params *CopyObjectInput, optFns ...func(*Options)) (*CopyObjectOutput, error) { if params == nil { params = &CopyObjectInput{} @@ -196,58 +163,53 @@ func (c *Client) CopyObject(ctx context.Context, params *CopyObjectInput, optFns type CopyObjectInput struct { - // The name of the destination bucket. When using this action with an access point, - // you must direct requests to the access point hostname. The access point hostname - // takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - // When using this action with an access point through the Amazon Web Services - // SDKs, you provide the access point ARN in place of the bucket name. For more - // information about access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // The name of the destination bucket. When using this action with an access + // point, you must direct requests to the access point hostname. The access point + // hostname takes the form + // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this + // action with an access point through the Amazon Web Services SDKs, you provide + // the access point ARN in place of the bucket name. For more information about + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string - // Specifies the source object for the copy operation. You specify the value in one - // of two formats, depending on whether you want to access the source object - // through an access point - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html): - // - // * - // For objects not accessed through an access point, specify the name of the source - // bucket and the key of the source object, separated by a slash (/). For example, - // to copy the object reports/january.pdf from the bucket awsexamplebucket, use - // awsexamplebucket/reports/january.pdf. The value must be URL-encoded. - // - // * For - // objects accessed through access points, specify the Amazon Resource Name (ARN) - // of the object as accessed through the access point, in the format - // arn:aws:s3:::accesspoint//object/. For example, to copy the object - // reports/january.pdf through access point my-access-point owned by account - // 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. - // The value must be URL encoded. Amazon S3 supports copy operations using access - // points only when the source and destination buckets are in the same Amazon Web - // Services Region. Alternatively, for objects accessed through Amazon S3 on - // Outposts, specify the ARN of the object as accessed in the format - // arn:aws:s3-outposts:::outpost//object/. For example, to copy the object - // reports/january.pdf through outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. - // The value must be URL-encoded. - // - // To copy a specific version of an object, append - // ?versionId= to the value (for example, - // awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - // If you don't specify a version ID, Amazon S3 copies the latest version of the + // Specifies the source object for the copy operation. You specify the value in + // one of two formats, depending on whether you want to access the source object + // through an access point (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) + // : + // - For objects not accessed through an access point, specify the name of the + // source bucket and the key of the source object, separated by a slash (/). For + // example, to copy the object reports/january.pdf from the bucket + // awsexamplebucket , use awsexamplebucket/reports/january.pdf . The value must + // be URL-encoded. + // - For objects accessed through access points, specify the Amazon Resource + // Name (ARN) of the object as accessed through the access point, in the format + // arn:aws:s3:::accesspoint//object/ . For example, to copy the object + // reports/january.pdf through access point my-access-point owned by account + // 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf + // . The value must be URL encoded. Amazon S3 supports copy operations using access + // points only when the source and destination buckets are in the same Amazon Web + // Services Region. Alternatively, for objects accessed through Amazon S3 on + // Outposts, specify the ARN of the object as accessed in the format + // arn:aws:s3-outposts:::outpost//object/ . For example, to copy the object + // reports/january.pdf through outpost my-outpost owned by account 123456789012 + // in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf + // . The value must be URL-encoded. + // To copy a specific version of an object, append ?versionId= to the value (for + // example, + // awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893 + // ). If you don't specify a version ID, Amazon S3 copies the latest version of the // source object. // // This member is required. @@ -258,8 +220,8 @@ type CopyObjectInput struct { // This member is required. Key *string - // The canned ACL to apply to the object. This action is not supported by Amazon S3 - // on Outposts. + // The canned ACL to apply to the object. This action is not supported by Amazon + // S3 on Outposts. ACL types.ObjectCannedACL // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption @@ -272,9 +234,8 @@ type CopyObjectInput struct { // Specifies caching behavior along the request/reply chain. CacheControl *string - // Indicates the algorithm you want Amazon S3 to use to create the checksum for the - // object. For more information, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Indicates the algorithm you want Amazon S3 to use to create the checksum for + // the object. For more information, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumAlgorithm types.ChecksumAlgorithm @@ -339,8 +300,8 @@ type CopyObjectInput struct { // supported by Amazon S3 on Outposts. GrantRead *string - // Allows grantee to read the object ACL. This action is not supported by Amazon S3 - // on Outposts. + // Allows grantee to read the object ACL. This action is not supported by Amazon + // S3 on Outposts. GrantReadACP *string // Allows grantee to write the ACL for the applicable object. This action is not @@ -350,8 +311,8 @@ type CopyObjectInput struct { // A map of metadata to store with the object in S3. Metadata map[string]string - // Specifies whether the metadata is copied from the source object or replaced with - // metadata provided in the request. + // Specifies whether the metadata is copied from the source object or replaced + // with metadata provided in the request. MetadataDirective types.MetadataDirective // Specifies whether you want to apply a legal hold to the copied object. @@ -366,8 +327,7 @@ type CopyObjectInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -396,26 +356,24 @@ type CopyObjectInput struct { // GET and PUT requests for an object protected by Amazon Web Services KMS will // fail if not made via SSL or using SigV4. For information about configuring using // any of the officially supported Amazon Web Services SDKs and Amazon Web Services - // CLI, see Specifying the Signature Version in Request Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + // CLI, see Specifying the Signature Version in Request Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) // in the Amazon S3 User Guide. SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // By default, Amazon S3 uses the STANDARD Storage Class to store newly created // objects. The STANDARD storage class provides high durability and high // availability. Depending on performance needs, you can specify a different // Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For - // more information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in - // the Amazon S3 User Guide. + // more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // in the Amazon S3 User Guide. StorageClass types.StorageClass // The tag-set for the object destination object this value must be used in - // conjunction with the TaggingDirective. The tag-set must be encoded as URL Query + // conjunction with the TaggingDirective . The tag-set must be encoded as URL Query // parameters. Tagging *string @@ -452,13 +410,14 @@ type CopyObjectOutput struct { // request. RequestCharged types.RequestCharged - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the Amazon Web Services KMS Encryption Context to use for @@ -472,7 +431,7 @@ type CopyObjectOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Version ID of the newly created copy. @@ -571,8 +530,9 @@ func newServiceMetadataMiddleware_opCopyObject(region string) *awsmiddleware.Reg } } -// getCopyObjectBucketMember returns a pointer to string denoting a provided bucket -// member valueand a boolean indicating if the input has a modeled bucket name, +// getCopyObjectBucketMember returns a pointer to string denoting a provided +// bucket member valueand a boolean indicating if the input has a modeled bucket +// name, func getCopyObjectBucketMember(input interface{}) (*string, bool) { in := input.(*CopyObjectInput) if in.Bucket == nil { diff --git a/service/s3/api_op_CreateBucket.go b/service/s3/api_op_CreateBucket.go index 27322a2c656..b620f4b9e0c 100644 --- a/service/s3/api_op_CreateBucket.go +++ b/service/s3/api_op_CreateBucket.go @@ -16,121 +16,81 @@ import ( // and have a valid Amazon Web Services Access Key ID to authenticate requests. // Anonymous requests are never allowed to create buckets. By creating the bucket, // you become the bucket owner. Not every string is an acceptable bucket name. For -// information about bucket naming restrictions, see Bucket naming rules -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). -// If you want to create an Amazon S3 on Outposts bucket, see Create Bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html). -// By default, the bucket is created in the US East (N. Virginia) Region. You can +// information about bucket naming restrictions, see Bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) +// . If you want to create an Amazon S3 on Outposts bucket, see Create Bucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) +// . By default, the bucket is created in the US East (N. Virginia) Region. You can // optionally specify a Region in the request body. You might choose a Region to // optimize latency, minimize costs, or address regulatory requirements. For // example, if you reside in Europe, you will probably find it advantageous to // create buckets in the Europe (Ireland) Region. For more information, see -// Accessing a bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro). -// If you send your create bucket request to the s3.amazonaws.com endpoint, the +// Accessing a bucket (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) +// . If you send your create bucket request to the s3.amazonaws.com endpoint, the // request goes to the us-east-1 Region. Accordingly, the signature calculations in // Signature Version 4 must use us-east-1 as the Region, even if the location // constraint in the request specifies another Region where the bucket is to be // created. If you create a bucket in a Region other than US East (N. Virginia), // your application must be able to handle 307 redirect. For more information, see -// Virtual hosting of buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html). Access -// control lists (ACLs) When creating a bucket using this operation, you can -// optionally configure the bucket ACL to specify the accounts or groups that +// Virtual hosting of buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html) +// . Access control lists (ACLs) When creating a bucket using this operation, you +// can optionally configure the bucket ACL to specify the accounts or groups that // should be granted specific permissions on the bucket. If your CreateBucket // request sets bucket owner enforced for S3 Object Ownership and specifies a // bucket ACL that provides access to an external Amazon Web Services account, your // request fails with a 400 error and returns the // InvalidBucketAclWithObjectOwnership error code. For more information, see -// Controlling object ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// Controlling object ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. There are two ways to grant the appropriate // permissions using the request headers. +// - Specify a canned ACL using the x-amz-acl request header. Amazon S3 supports +// a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined +// set of grantees and permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) +// . +// - Specify access permissions explicitly using the x-amz-grant-read , +// x-amz-grant-write , x-amz-grant-read-acp , x-amz-grant-write-acp , and +// x-amz-grant-full-control headers. These headers map to the set of permissions +// Amazon S3 supports in an ACL. For more information, see Access control list +// (ACL) overview (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html) +// . You specify each grantee as a type=value pair, where the type is one of the +// following: +// - id – if the value specified is the canonical user ID of an Amazon Web +// Services account +// - uri – if you are granting permissions to a predefined group +// - emailAddress – if the value specified is the email address of an Amazon Web +// Services account Using email addresses to specify a grantee is only supported in +// the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. For example, the following +// x-amz-grant-read header grants the Amazon Web Services accounts identified by +// account IDs permissions to read object data and its metadata: +// x-amz-grant-read: id="11112222333", id="444455556666" // -// * Specify a canned ACL using the -// x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as -// canned ACLs. Each canned ACL has a predefined set of grantees and permissions. -// For more information, see Canned ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). +// You can use either a canned ACL or specify access permissions explicitly. You +// cannot do both. Permissions In addition to s3:CreateBucket , the following +// permissions are required when your CreateBucket includes specific headers: +// - ACLs - If your CreateBucket request specifies ACL permissions and the ACL is +// public-read, public-read-write, authenticated-read, or if you specify access +// permissions explicitly through any other ACL, both s3:CreateBucket and +// s3:PutBucketAcl permissions are needed. If the ACL the CreateBucket request is +// private or doesn't specify any ACLs, only s3:CreateBucket permission is +// needed. +// - Object Lock - If ObjectLockEnabledForBucket is set to true in your +// CreateBucket request, s3:PutBucketObjectLockConfiguration and +// s3:PutBucketVersioning permissions are required. +// - S3 Object Ownership - If your CreateBucket request includes the the +// x-amz-object-ownership header, s3:PutBucketOwnershipControls permission is +// required. // -// * -// Specify access permissions explicitly using the x-amz-grant-read, -// x-amz-grant-write, x-amz-grant-read-acp, x-amz-grant-write-acp, and -// x-amz-grant-full-control headers. These headers map to the set of permissions -// Amazon S3 supports in an ACL. For more information, see Access control list -// (ACL) overview -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html). You -// specify each grantee as a type=value pair, where the type is one of the -// following: -// -// * id – if the value specified is the canonical user ID of an Amazon -// Web Services account -// -// * uri – if you are granting permissions to a predefined -// group -// -// * emailAddress – if the value specified is the email address of an Amazon -// Web Services account Using email addresses to specify a grantee is only -// supported in the following Amazon Web Services Regions: -// -// * US East (N. -// Virginia) -// -// * US West (N. California) -// -// * US West (Oregon) -// -// * Asia Pacific -// (Singapore) -// -// * Asia Pacific (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe -// (Ireland) -// -// * South America (São Paulo) -// -// For a list of all the Amazon S3 -// supported Regions and endpoints, see Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// For example, the following -// x-amz-grant-read header grants the Amazon Web Services accounts identified by -// account IDs permissions to read object data and its metadata: x-amz-grant-read: -// id="11112222333", id="444455556666" -// -// You can use either a canned ACL or specify -// access permissions explicitly. You cannot do both. Permissions In addition to -// s3:CreateBucket, the following permissions are required when your CreateBucket -// includes specific headers: -// -// * ACLs - If your CreateBucket request specifies ACL -// permissions and the ACL is public-read, public-read-write, authenticated-read, -// or if you specify access permissions explicitly through any other ACL, both -// s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the -// CreateBucket request is private or doesn't specify any ACLs, only -// s3:CreateBucket permission is needed. -// -// * Object Lock - If -// ObjectLockEnabledForBucket is set to true in your CreateBucket request, -// s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are -// required. -// -// * S3 Object Ownership - If your CreateBucket request includes the the -// x-amz-object-ownership header, s3:PutBucketOwnershipControls permission is -// required. -// -// The following operations are related to CreateBucket: -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// The following operations are related to CreateBucket : +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { params = &CreateBucketInput{} diff --git a/service/s3/api_op_CreateMultipartUpload.go b/service/s3/api_op_CreateMultipartUpload.go index c971649ce1f..ef8fc296d23 100644 --- a/service/s3/api_op_CreateMultipartUpload.go +++ b/service/s3/api_op_CreateMultipartUpload.go @@ -16,29 +16,25 @@ import ( // This action initiates a multipart upload and returns an upload ID. This upload // ID is used to associate all of the parts in the specific multipart upload. You // specify this upload ID in each of your subsequent upload part requests (see -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)). You also -// include this upload ID in the final request to either complete or abort the -// multipart upload request. For more information about multipart uploads, see -// Multipart Upload Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). If you have -// configured a lifecycle rule to abort incomplete multipart uploads, the upload -// must complete within the number of days specified in the bucket lifecycle -// configuration. Otherwise, the incomplete multipart upload becomes eligible for -// an abort action and Amazon S3 aborts the multipart upload. For more information, -// see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). -// For information about the permissions required to use the multipart upload API, -// see Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). For -// request signing, multipart upload is just a series of regular requests. You -// initiate a multipart upload, send one or more requests to upload parts, and then -// complete the multipart upload process. You sign each request individually. There -// is nothing special about signing multipart upload requests. For more information -// about signing, see Authenticating Requests (Amazon Web Services Signature -// Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html). -// After you initiate a multipart upload and upload one or more parts, to stop +// UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// ). You also include this upload ID in the final request to either complete or +// abort the multipart upload request. For more information about multipart +// uploads, see Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) +// . If you have configured a lifecycle rule to abort incomplete multipart uploads, +// the upload must complete within the number of days specified in the bucket +// lifecycle configuration. Otherwise, the incomplete multipart upload becomes +// eligible for an abort action and Amazon S3 aborts the multipart upload. For more +// information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle +// Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) +// . For information about the permissions required to use the multipart upload +// API, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// . For request signing, multipart upload is just a series of regular requests. +// You initiate a multipart upload, send one or more requests to upload parts, and +// then complete the multipart upload process. You sign each request individually. +// There is nothing special about signing multipart upload requests. For more +// information about signing, see Authenticating Requests (Amazon Web Services +// Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// . After you initiate a multipart upload and upload one or more parts, to stop // being charged for storing the uploaded parts, you must either complete or abort // the multipart upload. Amazon S3 frees up the space used to store the parts and // stop charging you for storing them only after you either complete or abort a @@ -60,199 +56,123 @@ import ( // customer-provided key. If the encryption setting in your request is different // from the default encryption configuration of the destination bucket, the // encryption setting in your request takes precedence. If you choose to provide -// your own encryption key, the request headers you provide in UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) and -// UploadPartCopy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) +// your own encryption key, the request headers you provide in UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// and UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) // requests must match the headers you used in the request to initiate the upload -// by using CreateMultipartUpload. you can request that Amazon S3 save the uploaded -// parts encrypted with server-side encryption with an Amazon S3 managed key -// (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided -// encryption key (SSE-C). To perform a multipart upload with encryption by using -// an Amazon Web Services KMS key, the requester must have permission to the -// kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are -// required because Amazon S3 must decrypt and read data from the encrypted file -// parts before it completes the multipart upload. For more information, see -// Multipart upload API and permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions) -// and Protecting data using server-side encryption with Amazon Web Services KMS -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) +// by using CreateMultipartUpload . you can request that Amazon S3 save the +// uploaded parts encrypted with server-side encryption with an Amazon S3 managed +// key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a +// customer-provided encryption key (SSE-C). To perform a multipart upload with +// encryption by using an Amazon Web Services KMS key, the requester must have +// permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. +// These permissions are required because Amazon S3 must decrypt and read data from +// the encrypted file parts before it completes the multipart upload. For more +// information, see Multipart upload API and permissions (https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions) +// and Protecting data using server-side encryption with Amazon Web Services KMS (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) // in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user // or role is in the same Amazon Web Services account as the KMS key, then you must // have these permissions on the key policy. If your IAM user or role belongs to a // different account than the key, then you must have the permissions on both the // key policy and your IAM user or role. For more information, see Protecting Data -// Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). -// Access Permissions When copying an object, you can optionally specify the +// Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// . Access Permissions When copying an object, you can optionally specify the // accounts or groups that should be granted specific permissions on the new -// object. There are two ways to grant the permissions using the request -// headers: -// -// * Specify a canned ACL with the x-amz-acl request header. For more -// information, see Canned ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). -// -// * -// Specify access permissions explicitly with the x-amz-grant-read, -// x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control -// headers. These parameters map to the set of permissions that Amazon S3 supports -// in an ACL. For more information, see Access Control List (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). -// -// You can -// use either a canned ACL or specify access permissions explicitly. You cannot do -// both. Server-Side- Encryption-Specific Request Headers Amazon S3 encrypts data -// by using server-side encryption with an Amazon S3 managed key (SSE-S3) by -// default. Server-side encryption is for data encryption at rest. Amazon S3 -// encrypts your data as it writes it to disks in its data centers and decrypts it -// when you access it. You can request that Amazon S3 encrypts data at rest by -// using server-side encryption with other key options. The option you use depends -// on whether you want to use KMS keys (SSE-KMS) or provide your own encryption -// keys (SSE-C). -// -// * Use KMS keys (SSE-KMS) that include the Amazon Web Services -// managed key (aws/s3) and KMS customer managed keys stored in Key Management -// Service (KMS) – If you want Amazon Web Services to manage the keys used to -// encrypt data, specify the following headers in the request. -// -// * -// x-amz-server-side-encryption -// -// * x-amz-server-side-encryption-aws-kms-key-id -// -// * -// x-amz-server-side-encryption-context -// -// If you specify -// x-amz-server-side-encryption:aws:kms, but don't provide -// x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web -// Services managed key (aws/s3 key) in KMS to protect the data. All GET and PUT -// requests for an object protected by KMS fail if you don't make them by using -// Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version -// 4. For more information about server-side encryption with KMS keys (SSE-KMS), -// see Protecting Data Using Server-Side Encryption with KMS keys -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html). -// -// * -// Use customer-provided encryption keys (SSE-C) – If you want to manage your own -// encryption keys, provide all the following headers in the request. -// -// * -// x-amz-server-side-encryption-customer-algorithm -// -// * -// x-amz-server-side-encryption-customer-key -// -// * -// x-amz-server-side-encryption-customer-key-MD5 -// -// For more information about -// server-side encryption with customer-provided encryption keys (SSE-C), see -// Protecting data using server-side encryption with customer-provided encryption -// keys (SSE-C) -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html). -// -// Access-Control-List -// (ACL)-Specific Request Headers You also can use the following access -// control–related headers with this operation. By default, all objects are -// private. Only the owner has full access control. When adding a new object, you -// can grant permissions to individual Amazon Web Services accounts or to -// predefined groups defined by Amazon S3. These permissions are then added to the -// access control list (ACL) on the object. For more information, see Using ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). With -// this operation, you can grant access permissions using one of the following two -// methods: -// -// * Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of -// predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of -// grantees and permissions. For more information, see Canned ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). -// -// * -// Specify access permissions explicitly — To explicitly grant access permissions -// to specific Amazon Web Services accounts or groups, use the following headers. -// Each header maps to specific permissions that Amazon S3 supports in an ACL. For -// more information, see Access Control List (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). In the -// header, you specify a list of grantees who get the specific permission. To grant -// permissions explicitly, use: -// -// * x-amz-grant-read -// -// * x-amz-grant-write -// -// * -// x-amz-grant-read-acp -// -// * x-amz-grant-write-acp -// -// * x-amz-grant-full-control -// -// You -// specify each grantee as a type=value pair, where the type is one of the -// following: -// -// * id – if the value specified is the canonical user ID of an Amazon -// Web Services account -// -// * uri – if you are granting permissions to a predefined -// group -// -// * emailAddress – if the value specified is the email address of an Amazon -// Web Services account Using email addresses to specify a grantee is only -// supported in the following Amazon Web Services Regions: -// -// * US East (N. -// Virginia) -// -// * US West (N. California) -// -// * US West (Oregon) -// -// * Asia Pacific -// (Singapore) -// -// * Asia Pacific (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe -// (Ireland) -// -// * South America (São Paulo) -// -// For a list of all the Amazon S3 -// supported Regions and endpoints, see Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// For example, the following -// x-amz-grant-read header grants the Amazon Web Services accounts identified by -// account IDs permissions to read object data and its metadata: x-amz-grant-read: -// id="11112222333", id="444455556666" -// -// The following operations are related to -// CreateMultipartUpload: -// -// * UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// object. There are two ways to grant the permissions using the request headers: +// - Specify a canned ACL with the x-amz-acl request header. For more +// information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) +// . +// - Specify access permissions explicitly with the x-amz-grant-read , +// x-amz-grant-read-acp , x-amz-grant-write-acp , and x-amz-grant-full-control +// headers. These parameters map to the set of permissions that Amazon S3 supports +// in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// . +// +// You can use either a canned ACL or specify access permissions explicitly. You +// cannot do both. Server-Side- Encryption-Specific Request Headers Amazon S3 +// encrypts data by using server-side encryption with an Amazon S3 managed key +// (SSE-S3) by default. Server-side encryption is for data encryption at rest. +// Amazon S3 encrypts your data as it writes it to disks in its data centers and +// decrypts it when you access it. You can request that Amazon S3 encrypts data at +// rest by using server-side encryption with other key options. The option you use +// depends on whether you want to use KMS keys (SSE-KMS) or provide your own +// encryption keys (SSE-C). +// - Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key ( +// aws/s3 ) and KMS customer managed keys stored in Key Management Service (KMS) +// – If you want Amazon Web Services to manage the keys used to encrypt data, +// specify the following headers in the request. +// - x-amz-server-side-encryption +// - x-amz-server-side-encryption-aws-kms-key-id +// - x-amz-server-side-encryption-context If you specify +// x-amz-server-side-encryption:aws:kms , but don't provide +// x-amz-server-side-encryption-aws-kms-key-id , Amazon S3 uses the Amazon Web +// Services managed key ( aws/s3 key) in KMS to protect the data. All GET and PUT +// requests for an object protected by KMS fail if you don't make them by using +// Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version +// 4. For more information about server-side encryption with KMS keys (SSE-KMS), +// see Protecting Data Using Server-Side Encryption with KMS keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) +// . +// - Use customer-provided encryption keys (SSE-C) – If you want to manage your +// own encryption keys, provide all the following headers in the request. +// - x-amz-server-side-encryption-customer-algorithm +// - x-amz-server-side-encryption-customer-key +// - x-amz-server-side-encryption-customer-key-MD5 For more information about +// server-side encryption with customer-provided encryption keys (SSE-C), see +// Protecting data using server-side encryption with customer-provided encryption +// keys (SSE-C) (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html) +// . +// +// Access-Control-List (ACL)-Specific Request Headers You also can use the +// following access control–related headers with this operation. By default, all +// objects are private. Only the owner has full access control. When adding a new +// object, you can grant permissions to individual Amazon Web Services accounts or +// to predefined groups defined by Amazon S3. These permissions are then added to +// the access control list (ACL) on the object. For more information, see Using +// ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) . +// With this operation, you can grant access permissions using one of the following +// two methods: +// - Specify a canned ACL ( x-amz-acl ) — Amazon S3 supports a set of predefined +// ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and +// permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) +// . +// - Specify access permissions explicitly — To explicitly grant access +// permissions to specific Amazon Web Services accounts or groups, use the +// following headers. Each header maps to specific permissions that Amazon S3 +// supports in an ACL. For more information, see Access Control List (ACL) +// Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) . +// In the header, you specify a list of grantees who get the specific permission. +// To grant permissions explicitly, use: +// - x-amz-grant-read +// - x-amz-grant-write +// - x-amz-grant-read-acp +// - x-amz-grant-write-acp +// - x-amz-grant-full-control You specify each grantee as a type=value pair, +// where the type is one of the following: +// - id – if the value specified is the canonical user ID of an Amazon Web +// Services account +// - uri – if you are granting permissions to a predefined group +// - emailAddress – if the value specified is the email address of an Amazon Web +// Services account Using email addresses to specify a grantee is only supported in +// the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. For example, the following +// x-amz-grant-read header grants the Amazon Web Services accounts identified by +// account IDs permissions to read object data and its metadata: +// x-amz-grant-read: id="11112222333", id="444455556666" +// +// The following operations are related to CreateMultipartUpload : +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) CreateMultipartUpload(ctx context.Context, params *CreateMultipartUploadInput, optFns ...func(*Options)) (*CreateMultipartUploadOutput, error) { if params == nil { params = &CreateMultipartUploadInput{} @@ -276,17 +196,15 @@ type CreateMultipartUploadInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -296,8 +214,8 @@ type CreateMultipartUploadInput struct { // This member is required. Key *string - // The canned ACL to apply to the object. This action is not supported by Amazon S3 - // on Outposts. + // The canned ACL to apply to the object. This action is not supported by Amazon + // S3 on Outposts. ACL types.ObjectCannedACL // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption @@ -310,9 +228,8 @@ type CreateMultipartUploadInput struct { // Specifies caching behavior along the request/reply chain. CacheControl *string - // Indicates the algorithm you want Amazon S3 to use to create the checksum for the - // object. For more information, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Indicates the algorithm you want Amazon S3 to use to create the checksum for + // the object. For more information, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumAlgorithm types.ChecksumAlgorithm @@ -346,8 +263,8 @@ type CreateMultipartUploadInput struct { // supported by Amazon S3 on Outposts. GrantRead *string - // Allows grantee to read the object ACL. This action is not supported by Amazon S3 - // on Outposts. + // Allows grantee to read the object ACL. This action is not supported by Amazon + // S3 on Outposts. GrantReadACP *string // Allows grantee to write the ACL for the applicable object. This action is not @@ -369,8 +286,7 @@ type CreateMultipartUploadInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -400,22 +316,20 @@ type CreateMultipartUploadInput struct { // Web Services KMS will fail if not made via SSL or using SigV4. For information // about configuring using any of the officially supported Amazon Web Services SDKs // and Amazon Web Services CLI, see Specifying the Signature Version in Request - // Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) + // Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) // in the Amazon S3 User Guide. SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // By default, Amazon S3 uses the STANDARD Storage Class to store newly created // objects. The STANDARD storage class provides high durability and high // availability. Depending on performance needs, you can specify a different // Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For - // more information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in - // the Amazon S3 User Guide. + // more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // in the Amazon S3 User Guide. StorageClass types.StorageClass // The tag-set for the object. The tag-set must be encoded as URL Query parameters. @@ -431,15 +345,14 @@ type CreateMultipartUploadInput struct { type CreateMultipartUploadOutput struct { - // If the bucket has a lifecycle rule configured with an action to abort incomplete - // multipart uploads and the prefix in the lifecycle rule matches the object name - // in the request, the response includes this header. The header indicates when the - // initiated multipart upload becomes eligible for an abort operation. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). - // The response also includes the x-amz-abort-rule-id header that provides the ID - // of the lifecycle configuration rule that defines this action. + // If the bucket has a lifecycle rule configured with an action to abort + // incomplete multipart uploads and the prefix in the lifecycle rule matches the + // object name in the request, the response includes this header. The header + // indicates when the initiated multipart upload becomes eligible for an abort + // operation. For more information, see Aborting Incomplete Multipart Uploads + // Using a Bucket Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + // . The response also includes the x-amz-abort-rule-id header that provides the + // ID of the lifecycle configuration rule that defines this action. AbortDate *time.Time // This header is returned along with the x-amz-abort-date header. It identifies @@ -454,17 +367,15 @@ type CreateMultipartUploadOutput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. Bucket *string // Indicates whether the multipart upload uses an S3 Bucket Key for server-side @@ -481,13 +392,14 @@ type CreateMultipartUploadOutput struct { // request. RequestCharged types.RequestCharged - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the Amazon Web Services KMS Encryption Context to use for @@ -501,7 +413,7 @@ type CreateMultipartUploadOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // ID for the initiated multipart upload. diff --git a/service/s3/api_op_DeleteBucket.go b/service/s3/api_op_DeleteBucket.go index 6bfb43c224c..a54a5d2a4c0 100644 --- a/service/s3/api_op_DeleteBucket.go +++ b/service/s3/api_op_DeleteBucket.go @@ -14,13 +14,8 @@ import ( // Deletes the S3 bucket. All objects (including all object versions and delete // markers) in the bucket must be deleted before the bucket itself can be deleted. // Related Resources -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) { if params == nil { params = &DeleteBucketInput{} diff --git a/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go b/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go index e016d976302..a8eeb014a80 100644 --- a/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go @@ -13,29 +13,17 @@ import ( // Deletes an analytics configuration for the bucket (specified by the analytics // configuration ID). To use this operation, you must have permissions to perform -// the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by -// default. The bucket owner can grant this permission to others. For more +// the s3:PutAnalyticsConfiguration action. The bucket owner has this permission +// by default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – -// Storage Class Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). -// The following operations are related to DeleteBucketAnalyticsConfiguration: -// -// * -// GetBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) -// -// * -// ListBucketAnalyticsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) -// -// * -// PutBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about the Amazon S3 analytics feature, see Amazon S3 +// Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) +// . The following operations are related to DeleteBucketAnalyticsConfiguration : +// - GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) +// - ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) +// - PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) func (c *Client) DeleteBucketAnalyticsConfiguration(ctx context.Context, params *DeleteBucketAnalyticsConfigurationInput, optFns ...func(*Options)) (*DeleteBucketAnalyticsConfigurationOutput, error) { if params == nil { params = &DeleteBucketAnalyticsConfigurationInput{} diff --git a/service/s3/api_op_DeleteBucketCors.go b/service/s3/api_op_DeleteBucketCors.go index 79045abe2d0..64592383226 100644 --- a/service/s3/api_op_DeleteBucketCors.go +++ b/service/s3/api_op_DeleteBucketCors.go @@ -14,16 +14,10 @@ import ( // Deletes the cors configuration information set for the bucket. To use this // operation, you must have permission to perform the s3:PutBucketCORS action. The // bucket owner has this permission by default and can grant this permission to -// others. For information about cors, see Enabling Cross-Origin Resource Sharing -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3 -// User Guide. Related Resources: -// -// * PutBucketCors -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) -// -// * -// RESTOPTIONSobject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) +// others. For information about cors , see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) +// in the Amazon S3 User Guide. Related Resources: +// - PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) +// - RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) func (c *Client) DeleteBucketCors(ctx context.Context, params *DeleteBucketCorsInput, optFns ...func(*Options)) (*DeleteBucketCorsOutput, error) { if params == nil { params = &DeleteBucketCorsInput{} diff --git a/service/s3/api_op_DeleteBucketEncryption.go b/service/s3/api_op_DeleteBucketEncryption.go index 9f5084dc320..4570b61e179 100644 --- a/service/s3/api_op_DeleteBucketEncryption.go +++ b/service/s3/api_op_DeleteBucketEncryption.go @@ -14,24 +14,16 @@ import ( // This implementation of the DELETE action resets the default encryption for the // bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For // information about the bucket default encryption feature, see Amazon S3 Bucket -// Default Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the -// Amazon S3 User Guide. To use this operation, you must have permissions to +// Default Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) +// in the Amazon S3 User Guide. To use this operation, you must have permissions to // perform the s3:PutEncryptionConfiguration action. The bucket owner has this // permission by default. The bucket owner can grant this permission to others. For // more information about permissions, see Permissions Related to Bucket -// Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. Related Resources -// -// * PutBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) -// -// * -// GetBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) +// - PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) +// - GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) func (c *Client) DeleteBucketEncryption(ctx context.Context, params *DeleteBucketEncryptionInput, optFns ...func(*Options)) (*DeleteBucketEncryptionOutput, error) { if params == nil { params = &DeleteBucketEncryptionInput{} diff --git a/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go b/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go index 139dd78a05b..db578c5a33a 100644 --- a/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go @@ -24,21 +24,11 @@ import ( // monitored and not eligible for auto-tiering. Smaller objects can be stored, but // they are always charged at the Frequent Access tier rates in the S3 // Intelligent-Tiering storage class. For more information, see Storage class for -// automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). -// Operations related to DeleteBucketIntelligentTieringConfiguration include: -// -// * -// GetBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) -// -// * -// PutBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) -// -// * -// ListBucketIntelligentTieringConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) +// automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) +// . Operations related to DeleteBucketIntelligentTieringConfiguration include: +// - GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) +// - PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) +// - ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) func (c *Client) DeleteBucketIntelligentTieringConfiguration(ctx context.Context, params *DeleteBucketIntelligentTieringConfigurationInput, optFns ...func(*Options)) (*DeleteBucketIntelligentTieringConfigurationOutput, error) { if params == nil { params = &DeleteBucketIntelligentTieringConfigurationInput{} diff --git a/service/s3/api_op_DeleteBucketInventoryConfiguration.go b/service/s3/api_op_DeleteBucketInventoryConfiguration.go index 32fe81f12e0..0107973e522 100644 --- a/service/s3/api_op_DeleteBucketInventoryConfiguration.go +++ b/service/s3/api_op_DeleteBucketInventoryConfiguration.go @@ -16,25 +16,13 @@ import ( // s3:PutInventoryConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about the Amazon S3 inventory feature, see Amazon S3 Inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). -// Operations related to DeleteBucketInventoryConfiguration include: -// -// * -// GetBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) -// -// * -// PutBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) -// -// * -// ListBucketInventoryConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) +// . Operations related to DeleteBucketInventoryConfiguration include: +// - GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) +// - PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) +// - ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) func (c *Client) DeleteBucketInventoryConfiguration(ctx context.Context, params *DeleteBucketInventoryConfigurationInput, optFns ...func(*Options)) (*DeleteBucketInventoryConfigurationOutput, error) { if params == nil { params = &DeleteBucketInventoryConfigurationInput{} diff --git a/service/s3/api_op_DeleteBucketLifecycle.go b/service/s3/api_op_DeleteBucketLifecycle.go index c110bfb440d..d738b380e0f 100644 --- a/service/s3/api_op_DeleteBucketLifecycle.go +++ b/service/s3/api_op_DeleteBucketLifecycle.go @@ -11,25 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes -// all the lifecycle configuration rules in the lifecycle subresource associated -// with the bucket. Your objects never expire, and Amazon S3 no longer +// Deletes the lifecycle configuration from the specified bucket. Amazon S3 +// removes all the lifecycle configuration rules in the lifecycle subresource +// associated with the bucket. Your objects never expire, and Amazon S3 no longer // automatically deletes any objects on the basis of rules contained in the deleted // lifecycle configuration. To use this operation, you must have permission to // perform the s3:PutLifecycleConfiguration action. By default, the bucket owner // has this permission and the bucket owner can grant this permission to others. // There is usually some time lag before lifecycle configuration deletion is fully // propagated to all the Amazon S3 systems. For more information about the object -// expiration, see Elements to Describe Lifecycle Actions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions). -// Related actions include: -// -// * PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) +// expiration, see Elements to Describe Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions) +// . Related actions include: +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) func (c *Client) DeleteBucketLifecycle(ctx context.Context, params *DeleteBucketLifecycleInput, optFns ...func(*Options)) (*DeleteBucketLifecycleOutput, error) { if params == nil { params = &DeleteBucketLifecycleInput{} diff --git a/service/s3/api_op_DeleteBucketMetricsConfiguration.go b/service/s3/api_op_DeleteBucketMetricsConfiguration.go index 54bfa8cb86b..81b9d191fe3 100644 --- a/service/s3/api_op_DeleteBucketMetricsConfiguration.go +++ b/service/s3/api_op_DeleteBucketMetricsConfiguration.go @@ -17,30 +17,15 @@ import ( // permissions to perform the s3:PutMetricsConfiguration action. The bucket owner // has this permission by default. The bucket owner can grant this permission to // others. For more information about permissions, see Permissions Related to -// Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about CloudWatch request metrics for Amazon S3, see Monitoring -// Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). -// The following operations are related to DeleteBucketMetricsConfiguration: -// -// * -// GetBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) -// -// * -// PutBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) -// -// * -// ListBucketMetricsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) -// -// * -// Monitoring Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about CloudWatch request metrics for Amazon S3, see +// Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// . The following operations are related to DeleteBucketMetricsConfiguration : +// - GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) +// - PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) +// - ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) +// - Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) func (c *Client) DeleteBucketMetricsConfiguration(ctx context.Context, params *DeleteBucketMetricsConfigurationInput, optFns ...func(*Options)) (*DeleteBucketMetricsConfigurationOutput, error) { if params == nil { params = &DeleteBucketMetricsConfigurationInput{} diff --git a/service/s3/api_op_DeleteBucketOwnershipControls.go b/service/s3/api_op_DeleteBucketOwnershipControls.go index 6186db5e194..fa8af884780 100644 --- a/service/s3/api_op_DeleteBucketOwnershipControls.go +++ b/service/s3/api_op_DeleteBucketOwnershipControls.go @@ -13,16 +13,11 @@ import ( // Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you // must have the s3:PutBucketOwnershipControls permission. For more information -// about Amazon S3 permissions, see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). -// For information about Amazon S3 Object Ownership, see Using Object Ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html). -// The following operations are related to DeleteBucketOwnershipControls: -// -// * -// GetBucketOwnershipControls -// -// * PutBucketOwnershipControls +// about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . For information about Amazon S3 Object Ownership, see Using Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html) +// . The following operations are related to DeleteBucketOwnershipControls : +// - GetBucketOwnershipControls +// - PutBucketOwnershipControls func (c *Client) DeleteBucketOwnershipControls(ctx context.Context, params *DeleteBucketOwnershipControlsInput, optFns ...func(*Options)) (*DeleteBucketOwnershipControlsOutput, error) { if params == nil { params = &DeleteBucketOwnershipControlsInput{} diff --git a/service/s3/api_op_DeleteBucketPolicy.go b/service/s3/api_op_DeleteBucketPolicy.go index 618d9bedebe..159715851b8 100644 --- a/service/s3/api_op_DeleteBucketPolicy.go +++ b/service/s3/api_op_DeleteBucketPolicy.go @@ -23,16 +23,10 @@ import ( // Services account that owns a bucket can always use this operation, even if the // policy explicitly denies the root user the ability to perform this action. For // more information about bucket policies, see Using Bucket Policies and -// UserPolicies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The -// following operations are related to DeleteBucketPolicy -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// UserPolicies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . The following operations are related to DeleteBucketPolicy +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error) { if params == nil { params = &DeleteBucketPolicyInput{} diff --git a/service/s3/api_op_DeleteBucketReplication.go b/service/s3/api_op_DeleteBucketReplication.go index ad2d772d477..776c288d5c6 100644 --- a/service/s3/api_op_DeleteBucketReplication.go +++ b/service/s3/api_op_DeleteBucketReplication.go @@ -15,22 +15,14 @@ import ( // you must have permissions to perform the s3:PutReplicationConfiguration action. // The bucket owner has these permissions by default and can grant it to others. // For more information about permissions, see Permissions Related to Bucket -// Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// It can take a while for the deletion of a replication configuration to fully -// propagate. For information about replication configuration, see Replication -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon -// S3 User Guide. The following operations are related to -// DeleteBucketReplication: -// -// * PutBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) -// -// * -// GetBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . It can take a while for the deletion of a replication configuration to fully +// propagate. For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) +// in the Amazon S3 User Guide. The following operations are related to +// DeleteBucketReplication : +// - PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) +// - GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) func (c *Client) DeleteBucketReplication(ctx context.Context, params *DeleteBucketReplicationInput, optFns ...func(*Options)) (*DeleteBucketReplicationOutput, error) { if params == nil { params = &DeleteBucketReplicationInput{} diff --git a/service/s3/api_op_DeleteBucketTagging.go b/service/s3/api_op_DeleteBucketTagging.go index 063f0bc5977..6aac497e9b8 100644 --- a/service/s3/api_op_DeleteBucketTagging.go +++ b/service/s3/api_op_DeleteBucketTagging.go @@ -14,14 +14,9 @@ import ( // Deletes the tags from the bucket. To use this operation, you must have // permission to perform the s3:PutBucketTagging action. By default, the bucket // owner has this permission and can grant this permission to others. The following -// operations are related to DeleteBucketTagging: -// -// * GetBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) -// -// * -// PutBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) +// operations are related to DeleteBucketTagging : +// - GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) +// - PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) func (c *Client) DeleteBucketTagging(ctx context.Context, params *DeleteBucketTaggingInput, optFns ...func(*Options)) (*DeleteBucketTaggingOutput, error) { if params == nil { params = &DeleteBucketTaggingInput{} diff --git a/service/s3/api_op_DeleteBucketWebsite.go b/service/s3/api_op_DeleteBucketWebsite.go index 7eb72b86a22..1c528079a51 100644 --- a/service/s3/api_op_DeleteBucketWebsite.go +++ b/service/s3/api_op_DeleteBucketWebsite.go @@ -21,16 +21,10 @@ import ( // bucket owners can grant other users permission to delete the website // configuration by writing a bucket policy granting them the // S3:DeleteBucketWebsite permission. For more information about hosting websites, -// see Hosting Websites on Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). The -// following operations are related to DeleteBucketWebsite: -// -// * GetBucketWebsite -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html) -// -// * -// PutBucketWebsite -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) +// see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) +// . The following operations are related to DeleteBucketWebsite : +// - GetBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html) +// - PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) func (c *Client) DeleteBucketWebsite(ctx context.Context, params *DeleteBucketWebsiteInput, optFns ...func(*Options)) (*DeleteBucketWebsiteOutput, error) { if params == nil { params = &DeleteBucketWebsiteInput{} diff --git a/service/s3/api_op_DeleteObject.go b/service/s3/api_op_DeleteObject.go index 5c421af11aa..77552248076 100644 --- a/service/s3/api_op_DeleteObject.go +++ b/service/s3/api_op_DeleteObject.go @@ -18,24 +18,19 @@ import ( // command was successful. To remove a specific version, you must use the version // Id subresource. Using this subresource permanently deletes the version. If the // object deleted is a delete marker, Amazon S3 sets the response header, -// x-amz-delete-marker, to true. If the object you want to delete is in a bucket +// x-amz-delete-marker , to true. If the object you want to delete is in a bucket // where the bucket versioning configuration is MFA Delete enabled, you must // include the x-amz-mfa request header in the DELETE versionId request. Requests // that include x-amz-mfa must use HTTPS. For more information about MFA Delete, -// see Using MFA Delete -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html). To see -// sample requests that use versioning, see Sample Request -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete). -// You can delete objects by explicitly calling DELETE Object or configure its -// lifecycle (PutBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)) -// to enable Amazon S3 to remove them for you. If you want to block users or +// see Using MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html) +// . To see sample requests that use versioning, see Sample Request (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete) +// . You can delete objects by explicitly calling DELETE Object or configure its +// lifecycle ( PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) +// ) to enable Amazon S3 to remove them for you. If you want to block users or // accounts from removing or deleting objects from your bucket, you must deny them -// the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration -// actions. The following action is related to DeleteObject: -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// the s3:DeleteObject , s3:DeleteObjectVersion , and s3:PutLifeCycleConfiguration +// actions. The following action is related to DeleteObject : +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error) { if params == nil { params = &DeleteObjectInput{} @@ -53,23 +48,21 @@ func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, op type DeleteObjectInput struct { - // The bucket name of the bucket containing the object. When using this action with - // an access point, you must direct requests to the access point hostname. The + // The bucket name of the bucket containing the object. When using this action + // with an access point, you must direct requests to the access point hostname. The // access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -89,16 +82,16 @@ type DeleteObjectInput struct { // (access denied). ExpectedBucketOwner *string - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. Required to permanently - // delete a versioned object if versioning is configured with MFA delete enabled. + // The concatenation of the authentication device's serial number, a space, and + // the value that is displayed on your authentication device. Required to + // permanently delete a versioned object if versioning is configured with MFA + // delete enabled. MFA *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_DeleteObjectTagging.go b/service/s3/api_op_DeleteObjectTagging.go index 64877b5b3d2..74e1c12b7b5 100644 --- a/service/s3/api_op_DeleteObjectTagging.go +++ b/service/s3/api_op_DeleteObjectTagging.go @@ -11,21 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the entire tag set from the specified object. For more information about -// managing object tags, see Object Tagging -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). To use -// this operation, you must have permission to perform the s3:DeleteObjectTagging -// action. To delete tags of a specific object version, add the versionId query -// parameter in the request. You will need permission for the +// Removes the entire tag set from the specified object. For more information +// about managing object tags, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html) +// . To use this operation, you must have permission to perform the +// s3:DeleteObjectTagging action. To delete tags of a specific object version, add +// the versionId query parameter in the request. You will need permission for the // s3:DeleteObjectVersionTagging action. The following operations are related to -// DeleteObjectTagging: -// -// * PutObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) -// -// * -// GetObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) +// DeleteObjectTagging : +// - PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) +// - GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) func (c *Client) DeleteObjectTagging(ctx context.Context, params *DeleteObjectTaggingInput, optFns ...func(*Options)) (*DeleteObjectTaggingOutput, error) { if params == nil { params = &DeleteObjectTaggingInput{} @@ -43,23 +37,21 @@ func (c *Client) DeleteObjectTagging(ctx context.Context, params *DeleteObjectTa type DeleteObjectTaggingInput struct { - // The bucket name containing the objects from which to remove the tags. When using - // this action with an access point, you must direct requests to the access point - // hostname. The access point hostname takes the form + // The bucket name containing the objects from which to remove the tags. When + // using this action with an access point, you must direct requests to the access + // point hostname. The access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string diff --git a/service/s3/api_op_DeleteObjects.go b/service/s3/api_op_DeleteObjects.go index fb0e4bdce09..9e63422334f 100644 --- a/service/s3/api_op_DeleteObjects.go +++ b/service/s3/api_op_DeleteObjects.go @@ -33,31 +33,16 @@ import ( // even if there are non-versioned objects you are trying to delete. If you provide // an invalid token, whether there are versioned keys in the request or not, the // entire Multi-Object Delete request will fail. For information about MFA Delete, -// see MFA Delete -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete). -// Finally, the Content-MD5 header is required for all Multi-Object Delete +// see MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete) +// . Finally, the Content-MD5 header is required for all Multi-Object Delete // requests. Amazon S3 uses the header value to ensure that your request body has // not been altered in transit. The following operations are related to -// DeleteObjects: -// -// * CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// DeleteObjects : +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) func (c *Client) DeleteObjects(ctx context.Context, params *DeleteObjectsInput, optFns ...func(*Options)) (*DeleteObjectsOutput, error) { if params == nil { params = &DeleteObjectsInput{} @@ -75,23 +60,21 @@ func (c *Client) DeleteObjects(ctx context.Context, params *DeleteObjectsInput, type DeleteObjectsInput struct { - // The bucket name containing the objects to delete. When using this action with an - // access point, you must direct requests to the access point hostname. The access - // point hostname takes the form + // The bucket name containing the objects to delete. When using this action with + // an access point, you must direct requests to the access point hostname. The + // access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -110,9 +93,8 @@ type DeleteObjectsInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. This checksum algorithm must // be the same for all parts and it match the checksum value supplied in the @@ -124,16 +106,16 @@ type DeleteObjectsInput struct { // (access denied). ExpectedBucketOwner *string - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. Required to permanently - // delete a versioned object if versioning is configured with MFA delete enabled. + // The concatenation of the authentication device's serial number, a space, and + // the value that is displayed on your authentication device. Required to + // permanently delete a versioned object if versioning is configured with MFA + // delete enabled. MFA *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -247,8 +229,8 @@ func newServiceMetadataMiddleware_opDeleteObjects(region string) *awsmiddleware. } } -// getDeleteObjectsRequestAlgorithmMember gets the request checksum algorithm value -// provided as input. +// getDeleteObjectsRequestAlgorithmMember gets the request checksum algorithm +// value provided as input. func getDeleteObjectsRequestAlgorithmMember(input interface{}) (string, bool) { in := input.(*DeleteObjectsInput) if len(in.ChecksumAlgorithm) == 0 { diff --git a/service/s3/api_op_DeletePublicAccessBlock.go b/service/s3/api_op_DeletePublicAccessBlock.go index 3defd538c74..d8126d6c7e1 100644 --- a/service/s3/api_op_DeletePublicAccessBlock.go +++ b/service/s3/api_op_DeletePublicAccessBlock.go @@ -11,30 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this -// operation, you must have the s3:PutBucketPublicAccessBlock permission. For more -// information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// The following operations are related to DeletePublicAccessBlock: -// -// * Using Amazon -// S3 Block Public Access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) -// -// * -// GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) -// -// * -// PutPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) -// -// * -// GetBucketPolicyStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) +// Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use +// this operation, you must have the s3:PutBucketPublicAccessBlock permission. For +// more information about permissions, see Permissions Related to Bucket +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . The following operations are related to DeletePublicAccessBlock : +// - Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) +// - PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) +// - GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) func (c *Client) DeletePublicAccessBlock(ctx context.Context, params *DeletePublicAccessBlockInput, optFns ...func(*Options)) (*DeletePublicAccessBlockOutput, error) { if params == nil { params = &DeletePublicAccessBlockInput{} diff --git a/service/s3/api_op_GetBucketAccelerateConfiguration.go b/service/s3/api_op_GetBucketAccelerateConfiguration.go index d1690f3ea4f..3fd9764576d 100644 --- a/service/s3/api_op_GetBucketAccelerateConfiguration.go +++ b/service/s3/api_op_GetBucketAccelerateConfiguration.go @@ -14,28 +14,22 @@ import ( // This implementation of the GET action uses the accelerate subresource to return // the Transfer Acceleration state of a bucket, which is either Enabled or -// Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that +// Suspended . Amazon S3 Transfer Acceleration is a bucket-level feature that // enables you to perform faster data transfers to and from Amazon S3. To use this // operation, you must have permission to perform the s3:GetAccelerateConfiguration // action. The bucket owner has this permission by default. The bucket owner can // grant this permission to others. For more information about permissions, see -// Permissions Related to Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. You set the Transfer Acceleration state of an // existing bucket to Enabled or Suspended by using the -// PutBucketAccelerateConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) +// PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) // operation. A GET accelerate request does not return a state value for a bucket // that has no transfer acceleration state. A bucket has no Transfer Acceleration // state if a state has never been set on the bucket. For more information about -// transfer acceleration, see Transfer Acceleration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in -// the Amazon S3 User Guide. Related Resources -// -// * PutBucketAccelerateConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) +// transfer acceleration, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) +// in the Amazon S3 User Guide. Related Resources +// - PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) func (c *Client) GetBucketAccelerateConfiguration(ctx context.Context, params *GetBucketAccelerateConfigurationInput, optFns ...func(*Options)) (*GetBucketAccelerateConfigurationOutput, error) { if params == nil { params = &GetBucketAccelerateConfigurationInput{} diff --git a/service/s3/api_op_GetBucketAcl.go b/service/s3/api_op_GetBucketAcl.go index 2064c614da4..7918dbf2f67 100644 --- a/service/s3/api_op_GetBucketAcl.go +++ b/service/s3/api_op_GetBucketAcl.go @@ -21,12 +21,9 @@ import ( // the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs // are still supported and return the bucket-owner-full-control ACL with the owner // being the account that created the bucket. For more information, see -// Controlling object ownership and disabling ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// Controlling object ownership and disabling ACLs (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. Related Resources -// -// * ListObjects -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) +// - ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) func (c *Client) GetBucketAcl(ctx context.Context, params *GetBucketAclInput, optFns ...func(*Options)) (*GetBucketAclOutput, error) { if params == nil { params = &GetBucketAclInput{} diff --git a/service/s3/api_op_GetBucketAnalyticsConfiguration.go b/service/s3/api_op_GetBucketAnalyticsConfiguration.go index bf2c3be6726..909121a1bcd 100644 --- a/service/s3/api_op_GetBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_GetBucketAnalyticsConfiguration.go @@ -17,26 +17,14 @@ import ( // operation, you must have permissions to perform the s3:GetAnalyticsConfiguration // action. The bucket owner has this permission by default. The bucket owner can // grant this permission to others. For more information about permissions, see -// Permissions Related to Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. For information about Amazon S3 analytics feature, -// see Amazon S3 Analytics – Storage Class Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) +// see Amazon S3 Analytics – Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) // in the Amazon S3 User Guide. Related Resources -// -// * -// DeleteBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) -// -// * -// ListBucketAnalyticsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) -// -// * -// PutBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) +// - DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) +// - ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) +// - PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) func (c *Client) GetBucketAnalyticsConfiguration(ctx context.Context, params *GetBucketAnalyticsConfigurationInput, optFns ...func(*Options)) (*GetBucketAnalyticsConfigurationOutput, error) { if params == nil { params = &GetBucketAnalyticsConfigurationInput{} diff --git a/service/s3/api_op_GetBucketCors.go b/service/s3/api_op_GetBucketCors.go index b6004fdbbcc..32c753b090a 100644 --- a/service/s3/api_op_GetBucketCors.go +++ b/service/s3/api_op_GetBucketCors.go @@ -17,16 +17,10 @@ import ( // s3:GetBucketCORS action. By default, the bucket owner has this permission and // can grant it to others. To use this API against an access point, provide the // alias of the access point in place of the bucket name. For more information -// about CORS, see Enabling Cross-Origin Resource Sharing -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). The following -// operations are related to GetBucketCors: -// -// * PutBucketCors -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) -// -// * -// DeleteBucketCors -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) +// about CORS, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) +// . The following operations are related to GetBucketCors : +// - PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) +// - DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) func (c *Client) GetBucketCors(ctx context.Context, params *GetBucketCorsInput, optFns ...func(*Options)) (*GetBucketCorsOutput, error) { if params == nil { params = &GetBucketCorsInput{} diff --git a/service/s3/api_op_GetBucketEncryption.go b/service/s3/api_op_GetBucketEncryption.go index 526faa8c25b..50ff039a7be 100644 --- a/service/s3/api_op_GetBucketEncryption.go +++ b/service/s3/api_op_GetBucketEncryption.go @@ -16,25 +16,16 @@ import ( // default, all buckets have a default encryption configuration that uses // server-side encryption with Amazon S3 managed keys (SSE-S3). For information // about the bucket default encryption feature, see Amazon S3 Bucket Default -// Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the -// Amazon S3 User Guide. To use this operation, you must have permission to perform -// the s3:GetEncryptionConfiguration action. The bucket owner has this permission -// by default. The bucket owner can grant this permission to others. For more -// information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// The following operations are related to GetBucketEncryption: -// -// * -// PutBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) -// -// * -// DeleteBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) +// Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) +// in the Amazon S3 User Guide. To use this operation, you must have permission to +// perform the s3:GetEncryptionConfiguration action. The bucket owner has this +// permission by default. The bucket owner can grant this permission to others. For +// more information about permissions, see Permissions Related to Bucket +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . The following operations are related to GetBucketEncryption : +// - PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) +// - DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) func (c *Client) GetBucketEncryption(ctx context.Context, params *GetBucketEncryptionInput, optFns ...func(*Options)) (*GetBucketEncryptionOutput, error) { if params == nil { params = &GetBucketEncryptionInput{} diff --git a/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go b/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go index 70bbb9dfbaa..2737d9ffab1 100644 --- a/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go @@ -25,21 +25,11 @@ import ( // monitored and not eligible for auto-tiering. Smaller objects can be stored, but // they are always charged at the Frequent Access tier rates in the S3 // Intelligent-Tiering storage class. For more information, see Storage class for -// automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). -// Operations related to GetBucketIntelligentTieringConfiguration include: -// -// * -// DeleteBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) -// -// * -// PutBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) -// -// * -// ListBucketIntelligentTieringConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) +// automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) +// . Operations related to GetBucketIntelligentTieringConfiguration include: +// - DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) +// - PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) +// - ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) func (c *Client) GetBucketIntelligentTieringConfiguration(ctx context.Context, params *GetBucketIntelligentTieringConfigurationInput, optFns ...func(*Options)) (*GetBucketIntelligentTieringConfigurationOutput, error) { if params == nil { params = &GetBucketIntelligentTieringConfigurationInput{} diff --git a/service/s3/api_op_GetBucketInventoryConfiguration.go b/service/s3/api_op_GetBucketInventoryConfiguration.go index f35a4606c8f..4bf55db8e53 100644 --- a/service/s3/api_op_GetBucketInventoryConfiguration.go +++ b/service/s3/api_op_GetBucketInventoryConfiguration.go @@ -14,27 +14,15 @@ import ( // Returns an inventory configuration (identified by the inventory configuration // ID) from the bucket. To use this operation, you must have permissions to perform -// the s3:GetInventoryConfiguration action. The bucket owner has this permission by -// default and can grant this permission to others. For more information about -// permissions, see Permissions Related to Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about the Amazon S3 inventory feature, see Amazon S3 Inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). The -// following operations are related to GetBucketInventoryConfiguration: -// -// * -// DeleteBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) -// -// * -// ListBucketInventoryConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) -// -// * -// PutBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) +// the s3:GetInventoryConfiguration action. The bucket owner has this permission +// by default and can grant this permission to others. For more information about +// permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) +// . The following operations are related to GetBucketInventoryConfiguration : +// - DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) +// - ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) +// - PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) func (c *Client) GetBucketInventoryConfiguration(ctx context.Context, params *GetBucketInventoryConfigurationInput, optFns ...func(*Options)) (*GetBucketInventoryConfigurationOutput, error) { if params == nil { params = &GetBucketInventoryConfigurationInput{} diff --git a/service/s3/api_op_GetBucketLifecycleConfiguration.go b/service/s3/api_op_GetBucketLifecycleConfiguration.go index 5d72d2ebc49..b55845e2970 100644 --- a/service/s3/api_op_GetBucketLifecycleConfiguration.go +++ b/service/s3/api_op_GetBucketLifecycleConfiguration.go @@ -12,51 +12,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Bucket lifecycle configuration now supports specifying a lifecycle rule using an -// object key name prefix, one or more object tags, or a combination of both. +// Bucket lifecycle configuration now supports specifying a lifecycle rule using +// an object key name prefix, one or more object tags, or a combination of both. // Accordingly, this section describes the latest API. The response describes the // new filter element that you can use to specify a filter to select a subset of // objects to which the rule applies. If you are using a previous version of the // lifecycle configuration, it still works. For the earlier action, see -// GetBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html). -// Returns the lifecycle configuration information set on the bucket. For -// information about lifecycle configuration, see Object Lifecycle Management -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). To -// use this operation, you must have permission to perform the +// GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) +// . Returns the lifecycle configuration information set on the bucket. For +// information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// . To use this operation, you must have permission to perform the // s3:GetLifecycleConfiguration action. The bucket owner has this permission, by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// GetBucketLifecycleConfiguration has the following special error: +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . GetBucketLifecycleConfiguration has the following special error: +// - Error code: NoSuchLifecycleConfiguration +// - Description: The lifecycle configuration does not exist. +// - HTTP Status Code: 404 Not Found +// - SOAP Fault Code Prefix: Client // -// * Error code: -// NoSuchLifecycleConfiguration -// -// * Description: The lifecycle configuration does -// not exist. -// -// * HTTP Status Code: 404 Not Found -// -// * SOAP Fault Code Prefix: -// Client -// -// The following operations are related to -// GetBucketLifecycleConfiguration: -// -// * GetBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) -// -// * -// PutBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) -// -// * -// DeleteBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) +// The following operations are related to GetBucketLifecycleConfiguration : +// - GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) +// - PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) +// - DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*GetBucketLifecycleConfigurationOutput, error) { if params == nil { params = &GetBucketLifecycleConfigurationInput{} diff --git a/service/s3/api_op_GetBucketLocation.go b/service/s3/api_op_GetBucketLocation.go index 38f287beffd..491837bb564 100644 --- a/service/s3/api_op_GetBucketLocation.go +++ b/service/s3/api_op_GetBucketLocation.go @@ -21,22 +21,15 @@ import ( // Returns the Region the bucket resides in. You set the bucket's Region using the // LocationConstraint request parameter in a CreateBucket request. For more -// information, see CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). To use -// this implementation of the operation, you must be the bucket owner. To use this -// API against an access point, provide the alias of the access point in place of -// the bucket name. For requests made using Amazon Web Services Signature Version 4 -// (SigV4), we recommend that you use HeadBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) to return -// the bucket Region instead of GetBucketLocation. The following operations are -// related to GetBucketLocation: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// information, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// . To use this implementation of the operation, you must be the bucket owner. To +// use this API against an access point, provide the alias of the access point in +// place of the bucket name. For requests made using Amazon Web Services Signature +// Version 4 (SigV4), we recommend that you use HeadBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) +// to return the bucket Region instead of GetBucketLocation. The following +// operations are related to GetBucketLocation : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) func (c *Client) GetBucketLocation(ctx context.Context, params *GetBucketLocationInput, optFns ...func(*Options)) (*GetBucketLocationOutput, error) { if params == nil { params = &GetBucketLocationInput{} @@ -70,9 +63,8 @@ type GetBucketLocationInput struct { type GetBucketLocationOutput struct { // Specifies the Region where the bucket resides. For a list of all the Amazon S3 - // supported location constraints by Region, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region). Buckets in - // Region us-east-1 have a LocationConstraint of null. + // supported location constraints by Region, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) + // . Buckets in Region us-east-1 have a LocationConstraint of null . LocationConstraint types.BucketLocationConstraint // Metadata pertaining to the operation's result. @@ -224,9 +216,9 @@ func newServiceMetadataMiddleware_opGetBucketLocation(region string) *awsmiddlew } } -// getGetBucketLocationBucketMember returns a pointer to string denoting a provided -// bucket member valueand a boolean indicating if the input has a modeled bucket -// name, +// getGetBucketLocationBucketMember returns a pointer to string denoting a +// provided bucket member valueand a boolean indicating if the input has a modeled +// bucket name, func getGetBucketLocationBucketMember(input interface{}) (*string, bool) { in := input.(*GetBucketLocationInput) if in.Bucket == nil { diff --git a/service/s3/api_op_GetBucketLogging.go b/service/s3/api_op_GetBucketLogging.go index 0a1c6389547..896894501b9 100644 --- a/service/s3/api_op_GetBucketLogging.go +++ b/service/s3/api_op_GetBucketLogging.go @@ -13,15 +13,10 @@ import ( ) // Returns the logging status of a bucket and the permissions users have to view -// and modify that status. The following operations are related to -// GetBucketLogging: -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// PutBucketLogging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html) +// and modify that status. The following operations are related to GetBucketLogging +// : +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - PutBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html) func (c *Client) GetBucketLogging(ctx context.Context, params *GetBucketLoggingInput, optFns ...func(*Options)) (*GetBucketLoggingOutput, error) { if params == nil { params = &GetBucketLoggingInput{} @@ -54,10 +49,9 @@ type GetBucketLoggingInput struct { type GetBucketLoggingOutput struct { - // Describes where logs are stored and the prefix that Amazon S3 assigns to all log - // object keys for a bucket. For more information, see PUT Bucket logging - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in - // the Amazon S3 API Reference. + // Describes where logs are stored and the prefix that Amazon S3 assigns to all + // log object keys for a bucket. For more information, see PUT Bucket logging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) + // in the Amazon S3 API Reference. LoggingEnabled *types.LoggingEnabled // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetBucketMetricsConfiguration.go b/service/s3/api_op_GetBucketMetricsConfiguration.go index c1883a434a1..d7117d3793c 100644 --- a/service/s3/api_op_GetBucketMetricsConfiguration.go +++ b/service/s3/api_op_GetBucketMetricsConfiguration.go @@ -18,30 +18,15 @@ import ( // s3:GetMetricsConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about CloudWatch request metrics for Amazon S3, see Monitoring -// Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). -// The following operations are related to GetBucketMetricsConfiguration: -// -// * -// PutBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) -// -// * -// DeleteBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) -// -// * -// ListBucketMetricsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) -// -// * -// Monitoring Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about CloudWatch request metrics for Amazon S3, see +// Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// . The following operations are related to GetBucketMetricsConfiguration : +// - PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) +// - DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) +// - ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) +// - Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) func (c *Client) GetBucketMetricsConfiguration(ctx context.Context, params *GetBucketMetricsConfigurationInput, optFns ...func(*Options)) (*GetBucketMetricsConfigurationOutput, error) { if params == nil { params = &GetBucketMetricsConfigurationInput{} diff --git a/service/s3/api_op_GetBucketNotificationConfiguration.go b/service/s3/api_op_GetBucketNotificationConfiguration.go index c2e1df60c71..929c19400b0 100644 --- a/service/s3/api_op_GetBucketNotificationConfiguration.go +++ b/service/s3/api_op_GetBucketNotificationConfiguration.go @@ -20,14 +20,10 @@ import ( // s3:GetBucketNotification permission. To use this API against an access point, // provide the alias of the access point in place of the bucket name. For more // information about setting and reading the notification configuration on a -// bucket, see Setting Up Notification of Bucket Events -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). For -// more information about bucket policies, see Using Bucket Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The -// following action is related to GetBucketNotification: -// -// * PutBucketNotification -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html) +// bucket, see Setting Up Notification of Bucket Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) +// . For more information about bucket policies, see Using Bucket Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . The following action is related to GetBucketNotification : +// - PutBucketNotification (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html) func (c *Client) GetBucketNotificationConfiguration(ctx context.Context, params *GetBucketNotificationConfigurationInput, optFns ...func(*Options)) (*GetBucketNotificationConfigurationOutput, error) { if params == nil { params = &GetBucketNotificationConfigurationInput{} @@ -58,8 +54,8 @@ type GetBucketNotificationConfigurationInput struct { noSmithyDocumentSerde } -// A container for specifying the notification configuration of the bucket. If this -// element is empty, notifications are turned off for the bucket. +// A container for specifying the notification configuration of the bucket. If +// this element is empty, notifications are turned off for the bucket. type GetBucketNotificationConfigurationOutput struct { // Enables delivery of events to Amazon EventBridge. @@ -69,12 +65,12 @@ type GetBucketNotificationConfigurationOutput struct { // them. LambdaFunctionConfigurations []types.LambdaFunctionConfiguration - // The Amazon Simple Queue Service queues to publish messages to and the events for - // which to publish messages. + // The Amazon Simple Queue Service queues to publish messages to and the events + // for which to publish messages. QueueConfigurations []types.QueueConfiguration - // The topic to which notifications are sent and the events for which notifications - // are generated. + // The topic to which notifications are sent and the events for which + // notifications are generated. TopicConfigurations []types.TopicConfiguration // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetBucketOwnershipControls.go b/service/s3/api_op_GetBucketOwnershipControls.go index 571c9566cec..ef0a9225da3 100644 --- a/service/s3/api_op_GetBucketOwnershipControls.go +++ b/service/s3/api_op_GetBucketOwnershipControls.go @@ -14,16 +14,11 @@ import ( // Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you // must have the s3:GetBucketOwnershipControls permission. For more information -// about Amazon S3 permissions, see Specifying permissions in a policy -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html). -// For information about Amazon S3 Object Ownership, see Using Object Ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html). -// The following operations are related to GetBucketOwnershipControls: -// -// * -// PutBucketOwnershipControls -// -// * DeleteBucketOwnershipControls +// about Amazon S3 permissions, see Specifying permissions in a policy (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html) +// . For information about Amazon S3 Object Ownership, see Using Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// . The following operations are related to GetBucketOwnershipControls : +// - PutBucketOwnershipControls +// - DeleteBucketOwnershipControls func (c *Client) GetBucketOwnershipControls(ctx context.Context, params *GetBucketOwnershipControlsInput, optFns ...func(*Options)) (*GetBucketOwnershipControlsOutput, error) { if params == nil { params = &GetBucketOwnershipControlsInput{} @@ -150,9 +145,9 @@ func newServiceMetadataMiddleware_opGetBucketOwnershipControls(region string) *a } } -// getGetBucketOwnershipControlsBucketMember returns a pointer to string denoting a -// provided bucket member valueand a boolean indicating if the input has a modeled -// bucket name, +// getGetBucketOwnershipControlsBucketMember returns a pointer to string denoting +// a provided bucket member valueand a boolean indicating if the input has a +// modeled bucket name, func getGetBucketOwnershipControlsBucketMember(input interface{}) (*string, bool) { in := input.(*GetBucketOwnershipControlsInput) if in.Bucket == nil { diff --git a/service/s3/api_op_GetBucketPolicy.go b/service/s3/api_op_GetBucketPolicy.go index 5a7df8f3e0f..d2a26441c32 100644 --- a/service/s3/api_op_GetBucketPolicy.go +++ b/service/s3/api_op_GetBucketPolicy.go @@ -23,12 +23,9 @@ import ( // the policy explicitly denies the root user the ability to perform this action. // To use this API against an access point, provide the alias of the access point // in place of the bucket name. For more information about bucket policies, see -// Using Bucket Policies and User Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The -// following action is related to GetBucketPolicy: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . The following action is related to GetBucketPolicy : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error) { if params == nil { params = &GetBucketPolicyInput{} diff --git a/service/s3/api_op_GetBucketPolicyStatus.go b/service/s3/api_op_GetBucketPolicyStatus.go index 570f60faa9a..bc62e8f2806 100644 --- a/service/s3/api_op_GetBucketPolicyStatus.go +++ b/service/s3/api_op_GetBucketPolicyStatus.go @@ -15,28 +15,14 @@ import ( // Retrieves the policy status for an Amazon S3 bucket, indicating whether the // bucket is public. In order to use this operation, you must have the // s3:GetBucketPolicyStatus permission. For more information about Amazon S3 -// permissions, see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). -// For more information about when Amazon S3 considers a bucket public, see The -// Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). -// The following operations are related to GetBucketPolicyStatus: -// -// * Using Amazon -// S3 Block Public Access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) -// -// * -// GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) -// -// * -// PutPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) -// -// * -// DeletePublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) +// permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . For more information about when Amazon S3 considers a bucket public, see The +// Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// . The following operations are related to GetBucketPolicyStatus : +// - Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) +// - PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) +// - DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) func (c *Client) GetBucketPolicyStatus(ctx context.Context, params *GetBucketPolicyStatusInput, optFns ...func(*Options)) (*GetBucketPolicyStatusOutput, error) { if params == nil { params = &GetBucketPolicyStatusInput{} diff --git a/service/s3/api_op_GetBucketReplication.go b/service/s3/api_op_GetBucketReplication.go index 5d7f3115b8d..f856c0deebb 100644 --- a/service/s3/api_op_GetBucketReplication.go +++ b/service/s3/api_op_GetBucketReplication.go @@ -15,26 +15,17 @@ import ( // Returns the replication configuration of a bucket. It can take a while to // propagate the put or delete a replication configuration to all Amazon S3 // systems. Therefore, a get request soon after put or delete can return a wrong -// result. For information about replication configuration, see Replication -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon -// S3 User Guide. This action requires permissions for the +// result. For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) +// in the Amazon S3 User Guide. This action requires permissions for the // s3:GetReplicationConfiguration action. For more information about permissions, -// see Using Bucket Policies and User Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). If -// you include the Filter element in a replication configuration, you must also -// include the DeleteMarkerReplication and Priority elements. The response also -// returns those elements. For information about GetBucketReplication errors, see -// List of replication-related error codes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) -// The following operations are related to GetBucketReplication: -// -// * -// PutBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) -// -// * -// DeleteBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) +// see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . If you include the Filter element in a replication configuration, you must +// also include the DeleteMarkerReplication and Priority elements. The response +// also returns those elements. For information about GetBucketReplication errors, +// see List of replication-related error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) +// The following operations are related to GetBucketReplication : +// - PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) +// - DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) func (c *Client) GetBucketReplication(ctx context.Context, params *GetBucketReplicationInput, optFns ...func(*Options)) (*GetBucketReplicationOutput, error) { if params == nil { params = &GetBucketReplicationInput{} diff --git a/service/s3/api_op_GetBucketRequestPayment.go b/service/s3/api_op_GetBucketRequestPayment.go index 45f985b95a5..ac5b249edb2 100644 --- a/service/s3/api_op_GetBucketRequestPayment.go +++ b/service/s3/api_op_GetBucketRequestPayment.go @@ -13,13 +13,10 @@ import ( ) // Returns the request payment configuration of a bucket. To use this version of -// the operation, you must be the bucket owner. For more information, see Requester -// Pays Buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The -// following operations are related to GetBucketRequestPayment: -// -// * ListObjects -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) +// the operation, you must be the bucket owner. For more information, see +// Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) +// . The following operations are related to GetBucketRequestPayment : +// - ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) func (c *Client) GetBucketRequestPayment(ctx context.Context, params *GetBucketRequestPaymentInput, optFns ...func(*Options)) (*GetBucketRequestPaymentOutput, error) { if params == nil { params = &GetBucketRequestPaymentInput{} diff --git a/service/s3/api_op_GetBucketTagging.go b/service/s3/api_op_GetBucketTagging.go index 816d1b3e7b7..f8bb900e0b3 100644 --- a/service/s3/api_op_GetBucketTagging.go +++ b/service/s3/api_op_GetBucketTagging.go @@ -16,21 +16,12 @@ import ( // have permission to perform the s3:GetBucketTagging action. By default, the // bucket owner has this permission and can grant this permission to others. // GetBucketTagging has the following special error: +// - Error code: NoSuchTagSet +// - Description: There is no tag set associated with the bucket. // -// * Error code: NoSuchTagSet -// -// * -// Description: There is no tag set associated with the bucket. -// -// The following -// operations are related to GetBucketTagging: -// -// * PutBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) -// -// * -// DeleteBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) +// The following operations are related to GetBucketTagging : +// - PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) +// - DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingInput, optFns ...func(*Options)) (*GetBucketTaggingOutput, error) { if params == nil { params = &GetBucketTaggingInput{} diff --git a/service/s3/api_op_GetBucketVersioning.go b/service/s3/api_op_GetBucketVersioning.go index 3657bd1ca4d..f95e2711af0 100644 --- a/service/s3/api_op_GetBucketVersioning.go +++ b/service/s3/api_op_GetBucketVersioning.go @@ -14,21 +14,12 @@ import ( // Returns the versioning state of a bucket. To retrieve the versioning state of a // bucket, you must be the bucket owner. This implementation also returns the MFA -// Delete status of the versioning state. If the MFA Delete status is enabled, the +// Delete status of the versioning state. If the MFA Delete status is enabled , the // bucket owner must use an authentication device to change the versioning state of -// the bucket. The following operations are related to GetBucketVersioning: -// -// * -// GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// the bucket. The following operations are related to GetBucketVersioning : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) GetBucketVersioning(ctx context.Context, params *GetBucketVersioningInput, optFns ...func(*Options)) (*GetBucketVersioningOutput, error) { if params == nil { params = &GetBucketVersioningInput{} diff --git a/service/s3/api_op_GetBucketWebsite.go b/service/s3/api_op_GetBucketWebsite.go index aa866b30187..795e0ac95a8 100644 --- a/service/s3/api_op_GetBucketWebsite.go +++ b/service/s3/api_op_GetBucketWebsite.go @@ -14,20 +14,14 @@ import ( // Returns the website configuration for a bucket. To host website on Amazon S3, // you can configure a bucket as website by adding a website configuration. For -// more information about hosting websites, see Hosting Websites on Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This GET -// action requires the S3:GetBucketWebsite permission. By default, only the bucket -// owner can read the bucket website configuration. However, bucket owners can -// allow other users to read the website configuration by writing a bucket policy -// granting them the S3:GetBucketWebsite permission. The following operations are -// related to DeleteBucketWebsite: -// -// * DeleteBucketWebsite -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) -// -// * -// PutBucketWebsite -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) +// more information about hosting websites, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) +// . This GET action requires the S3:GetBucketWebsite permission. By default, only +// the bucket owner can read the bucket website configuration. However, bucket +// owners can allow other users to read the website configuration by writing a +// bucket policy granting them the S3:GetBucketWebsite permission. The following +// operations are related to DeleteBucketWebsite : +// - DeleteBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) +// - PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) func (c *Client) GetBucketWebsite(ctx context.Context, params *GetBucketWebsiteInput, optFns ...func(*Options)) (*GetBucketWebsiteOutput, error) { if params == nil { params = &GetBucketWebsiteInput{} @@ -63,7 +57,7 @@ type GetBucketWebsiteOutput struct { // The object key name of the website error document to use for 4XX class errors. ErrorDocument *types.ErrorDocument - // The name of the index document for the website (for example index.html). + // The name of the index document for the website (for example index.html ). IndexDocument *types.IndexDocument // Specifies the redirect behavior of all requests to a website endpoint of an diff --git a/service/s3/api_op_GetObject.go b/service/s3/api_op_GetObject.go index 9647cbd5bc2..f2b73874571 100644 --- a/service/s3/api_op_GetObject.go +++ b/service/s3/api_op_GetObject.go @@ -15,88 +15,66 @@ import ( "time" ) -// Retrieves objects from Amazon S3. To use GET, you must have READ access to the +// Retrieves objects from Amazon S3. To use GET , you must have READ access to the // object. If you grant READ access to the anonymous user, you can return the // object without using an authorization header. An Amazon S3 bucket has no // directory hierarchy such as you would find in a typical computer file system. // You can, however, create a logical hierarchy by using object key names that -// imply a folder structure. For example, instead of naming an object sample.jpg, -// you can name it photos/2006/February/sample.jpg. To get an object from such a +// imply a folder structure. For example, instead of naming an object sample.jpg , +// you can name it photos/2006/February/sample.jpg . To get an object from such a // logical hierarchy, specify the full key name for the object in the GET // operation. For a virtual hosted-style request example, if you have the object -// photos/2006/February/sample.jpg, specify the resource as -// /photos/2006/February/sample.jpg. For a path-style request example, if you have -// the object photos/2006/February/sample.jpg in the bucket named examplebucket, -// specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more -// information about request types, see HTTP Host Header Bucket Specification -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket). -// For more information about returning the ACL of an object, see GetObjectAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html). If the -// object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive -// storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep -// Archive tiers, before you can retrieve the object you must first restore a copy -// using RestoreObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). -// Otherwise, this action returns an InvalidObjectState error. For information -// about restoring archived objects, see Restoring Archived Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html). -// Encryption request headers, like x-amz-server-side-encryption, should not be +// photos/2006/February/sample.jpg , specify the resource as +// /photos/2006/February/sample.jpg . For a path-style request example, if you have +// the object photos/2006/February/sample.jpg in the bucket named examplebucket , +// specify the resource as /examplebucket/photos/2006/February/sample.jpg . For +// more information about request types, see HTTP Host Header Bucket Specification (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket) +// . For more information about returning the ACL of an object, see GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) +// . If the object you are retrieving is stored in the S3 Glacier or S3 Glacier +// Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 +// Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you +// must first restore a copy using RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) +// . Otherwise, this action returns an InvalidObjectState error. For information +// about restoring archived objects, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) +// . Encryption request headers, like x-amz-server-side-encryption , should not be // sent for GET requests if your object uses server-side encryption with KMS keys // (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys // (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 // BadRequest error. If you encrypt an object by using server-side encryption with // customer-provided encryption keys (SSE-C) when you store the object in Amazon // S3, then when you GET the object, you must use the following headers: +// - x-amz-server-side-encryption-customer-algorithm +// - x-amz-server-side-encryption-customer-key +// - x-amz-server-side-encryption-customer-key-MD5 // -// * -// x-amz-server-side-encryption-customer-algorithm -// -// * -// x-amz-server-side-encryption-customer-key -// -// * -// x-amz-server-side-encryption-customer-key-MD5 -// -// For more information about SSE-C, -// see Server-Side Encryption (Using Customer-Provided Encryption Keys) -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). -// Assuming you have the relevant permission to read object tags, the response also -// returns the x-amz-tagging-count header that provides the count of number of tags -// associated with the object. You can use GetObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) to -// retrieve the tag set associated with an object. Permissions You need the +// For more information about SSE-C, see Server-Side Encryption (Using +// Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) +// . Assuming you have the relevant permission to read object tags, the response +// also returns the x-amz-tagging-count header that provides the count of number +// of tags associated with the object. You can use GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) +// to retrieve the tag set associated with an object. Permissions You need the // relevant read object (or version) permission for this operation. For more -// information, see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If -// the object you request does not exist, the error Amazon S3 returns depends on -// whether you also have the s3:ListBucket permission. -// -// * If you have the -// s3:ListBucket permission on the bucket, Amazon S3 will return an HTTP status -// code 404 ("no such key") error. +// information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . If the object you request does not exist, the error Amazon S3 returns depends +// on whether you also have the s3:ListBucket permission. +// - If you have the s3:ListBucket permission on the bucket, Amazon S3 will +// return an HTTP status code 404 ("no such key") error. +// - If you don’t have the s3:ListBucket permission, Amazon S3 will return an +// HTTP status code 403 ("access denied") error. // -// * If you don’t have the s3:ListBucket -// permission, Amazon S3 will return an HTTP status code 403 ("access denied") -// error. +// Versioning By default, the GET action returns the current version of an object. +// To return a different version, use the versionId subresource. +// - If you supply a versionId , you need the s3:GetObjectVersion permission to +// access a specific version of an object. If you request a specific version, you +// do not need to have the s3:GetObject permission. If you request the current +// version without a specific version ID, only s3:GetObject permission is +// required. s3:GetObjectVersion permission won't be required. +// - If the current version of the object is a delete marker, Amazon S3 behaves +// as if the object was deleted and includes x-amz-delete-marker: true in the +// response. // -// Versioning By default, the GET action returns the current version of an -// object. To return a different version, use the versionId subresource. -// -// * If you -// supply a versionId, you need the s3:GetObjectVersion permission to access a -// specific version of an object. If you request a specific version, you do not -// need to have the s3:GetObject permission. If you request the current version -// without a specific version ID, only s3:GetObject permission is required. -// s3:GetObjectVersion permission won't be required. -// -// * If the current version of -// the object is a delete marker, Amazon S3 behaves as if the object was deleted -// and includes x-amz-delete-marker: true in the response. -// -// For more information -// about versioning, see PutBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html). -// Overriding Response Header Values There are times when you want to override +// For more information about versioning, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html) +// . Overriding Response Header Values There are times when you want to override // certain response header values in a GET response. For example, you might // override the Content-Disposition response header value in your GET request. You // can override values for a set of response headers using the following query @@ -104,44 +82,30 @@ import ( // that is, when status code 200 OK is returned. The set of headers you can // override using these parameters is a subset of the headers that Amazon S3 // accepts when you create an object. The response headers that you can override -// for the GET response are Content-Type, Content-Language, Expires, Cache-Control, -// Content-Disposition, and Content-Encoding. To override these header values in -// the GET response, you use the following request parameters. You must sign the -// request, either using an Authorization header or a presigned URL, when using -// these parameters. They cannot be used with an unsigned (anonymous) request. -// -// * -// response-content-type +// for the GET response are Content-Type , Content-Language , Expires , +// Cache-Control , Content-Disposition , and Content-Encoding . To override these +// header values in the GET response, you use the following request parameters. You +// must sign the request, either using an Authorization header or a presigned URL, +// when using these parameters. They cannot be used with an unsigned (anonymous) +// request. +// - response-content-type +// - response-content-language +// - response-expires +// - response-cache-control +// - response-content-disposition +// - response-content-encoding // -// * response-content-language -// -// * response-expires -// -// * -// response-cache-control -// -// * response-content-disposition -// -// * -// response-content-encoding -// -// Additional Considerations about Request Headers If -// both of the If-Match and If-Unmodified-Since headers are present in the request -// as follows: If-Match condition evaluates to true, and; If-Unmodified-Since -// condition evaluates to false; then, S3 returns 200 OK and the data requested. If -// both of the If-None-Match and If-Modified-Since headers are present in the -// request as follows: If-None-Match condition evaluates to false, and; -// If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified -// response code. For more information about conditional requests, see RFC 7232 -// (https://tools.ietf.org/html/rfc7232). The following operations are related to -// GetObject: -// -// * ListBuckets -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) -// -// * -// GetObjectAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) +// Additional Considerations about Request Headers If both of the If-Match and +// If-Unmodified-Since headers are present in the request as follows: If-Match +// condition evaluates to true , and; If-Unmodified-Since condition evaluates to +// false ; then, S3 returns 200 OK and the data requested. If both of the +// If-None-Match and If-Modified-Since headers are present in the request as +// follows: If-None-Match condition evaluates to false , and; If-Modified-Since +// condition evaluates to true ; then, S3 returns 304 Not Modified response code. +// For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) +// . The following operations are related to GetObject : +// - ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) +// - GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error) { if params == nil { params = &GetObjectInput{} @@ -165,19 +129,17 @@ type GetObjectInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When using an Object Lambda access point the // hostname takes the form // AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. When you use // this action with Amazon S3 on Outposts, you must direct requests to the S3 on // Outposts hostname. The S3 on Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -216,17 +178,16 @@ type GetObjectInput struct { // Useful for downloading just a part of an object. PartNumber int32 - // Downloads the specified range bytes of an object. For more information about the - // HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range - // (https://www.rfc-editor.org/rfc/rfc9110.html#name-range). Amazon S3 doesn't - // support retrieving multiple ranges of data per GET request. + // Downloads the specified range bytes of an object. For more information about + // the HTTP Range header, see + // https://www.rfc-editor.org/rfc/rfc9110.html#name-range (https://www.rfc-editor.org/rfc/rfc9110.html#name-range) + // . Amazon S3 doesn't support retrieving multiple ranges of data per GET request. Range *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -252,11 +213,11 @@ type GetObjectInput struct { // AES256). SSECustomerAlgorithm *string - // Specifies the customer-provided encryption key for Amazon S3 used to encrypt the - // data. This value is used to decrypt the object when recovering it and must match - // the one used when storing the data. The key must be appropriate for use with the - // algorithm specified in the x-amz-server-side-encryption-customer-algorithm - // header. + // Specifies the customer-provided encryption key for Amazon S3 used to encrypt + // the data. This value is used to decrypt the object when recovering it and must + // match the one used when storing the data. The key must be appropriate for use + // with the algorithm specified in the + // x-amz-server-side-encryption-customer-algorithm header. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. @@ -288,32 +249,28 @@ type GetObjectOutput struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -394,13 +351,14 @@ type GetObjectOutput struct { // restored object copy. Restore *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the ID of the Amazon Web Services Key Management Service @@ -409,7 +367,7 @@ type GetObjectOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Provides storage class information of the object. Amazon S3 returns this header diff --git a/service/s3/api_op_GetObjectAcl.go b/service/s3/api_op_GetObjectAcl.go index 709e62ff755..2786c0cbc87 100644 --- a/service/s3/api_op_GetObjectAcl.go +++ b/service/s3/api_op_GetObjectAcl.go @@ -13,34 +13,22 @@ import ( ) // Returns the access control list (ACL) of an object. To use this operation, you -// must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more -// information, see Mapping of ACL permissions and access policy permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping) +// must have s3:GetObjectAcl permissions or READ_ACP access to the object. For +// more information, see Mapping of ACL permissions and access policy permissions (https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping) // in the Amazon S3 User Guide This action is not supported by Amazon S3 on // Outposts. Versioning By default, GET returns ACL information about the current // version of an object. To return ACL information about a different version, use // the versionId subresource. If your bucket uses the bucket owner enforced setting // for S3 Object Ownership, requests to read ACLs are still supported and return // the bucket-owner-full-control ACL with the owner being the account that created -// the bucket. For more information, see Controlling object ownership and -// disabling ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// the bucket. For more information, see Controlling object ownership and +// disabling ACLs (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. The following operations are related to -// GetObjectAcl: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) -// -// * -// PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// GetObjectAcl : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) func (c *Client) GetObjectAcl(ctx context.Context, params *GetObjectAclInput, optFns ...func(*Options)) (*GetObjectAclOutput, error) { if params == nil { params = &GetObjectAclInput{} @@ -64,8 +52,7 @@ type GetObjectAclInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -84,8 +71,7 @@ type GetObjectAclInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_GetObjectAttributes.go b/service/s3/api_op_GetObjectAttributes.go index 7743abc0fb0..eb5d1cee8d3 100644 --- a/service/s3/api_op_GetObjectAttributes.go +++ b/service/s3/api_op_GetObjectAttributes.go @@ -15,111 +15,64 @@ import ( // Retrieves all the metadata from an object without returning the object itself. // This action is useful if you're interested only in an object's metadata. To use -// GetObjectAttributes, you must have READ access to the object. -// GetObjectAttributes combines the functionality of HeadObject and ListParts. All +// GetObjectAttributes , you must have READ access to the object. +// GetObjectAttributes combines the functionality of HeadObject and ListParts . All // of the data returned with each of those individual calls can be returned with a -// single call to GetObjectAttributes. If you encrypt an object by using +// single call to GetObjectAttributes . If you encrypt an object by using // server-side encryption with customer-provided encryption keys (SSE-C) when you // store the object in Amazon S3, then when you retrieve the metadata from the // object, you must use the following headers: +// - x-amz-server-side-encryption-customer-algorithm +// - x-amz-server-side-encryption-customer-key +// - x-amz-server-side-encryption-customer-key-MD5 // -// * -// x-amz-server-side-encryption-customer-algorithm -// -// * -// x-amz-server-side-encryption-customer-key -// -// * -// x-amz-server-side-encryption-customer-key-MD5 -// -// For more information about SSE-C, -// see Server-Side Encryption (Using Customer-Provided Encryption Keys) -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) +// For more information about SSE-C, see Server-Side Encryption (Using +// Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. +// - Encryption request headers, such as x-amz-server-side-encryption , should +// not be sent for GET requests if your object uses server-side encryption with +// Amazon Web Services KMS keys stored in Amazon Web Services Key Management +// Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys +// (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 +// Bad Request error. +// - The last modified property in this case is the creation date of the object. // -// * Encryption request headers, such as -// x-amz-server-side-encryption, should not be sent for GET requests if your object -// uses server-side encryption with Amazon Web Services KMS keys stored in Amazon -// Web Services Key Management Service (SSE-KMS) or server-side encryption with -// Amazon S3 managed keys (SSE-S3). If your object does use these types of keys, -// you'll get an HTTP 400 Bad Request error. -// -// * The last modified property in this -// case is the creation date of the object. -// -// Consider the following when using -// request headers: -// -// * If both of the If-Match and If-Unmodified-Since headers are -// present in the request as follows, then Amazon S3 returns the HTTP status code -// 200 OK and the data requested: -// -// * If-Match condition evaluates to true. -// -// * -// If-Unmodified-Since condition evaluates to false. -// -// * If both of the -// If-None-Match and If-Modified-Since headers are present in the request as -// follows, then Amazon S3 returns the HTTP status code 304 Not Modified: -// -// * -// If-None-Match condition evaluates to false. -// -// * If-Modified-Since condition -// evaluates to true. +// Consider the following when using request headers: +// - If both of the If-Match and If-Unmodified-Since headers are present in the +// request as follows, then Amazon S3 returns the HTTP status code 200 OK and the +// data requested: +// - If-Match condition evaluates to true . +// - If-Unmodified-Since condition evaluates to false . +// - If both of the If-None-Match and If-Modified-Since headers are present in +// the request as follows, then Amazon S3 returns the HTTP status code 304 Not +// Modified : +// - If-None-Match condition evaluates to false . +// - If-Modified-Since condition evaluates to true . // -// For more information about conditional requests, see RFC -// 7232 (https://tools.ietf.org/html/rfc7232). Permissions The permissions that you -// need to use this operation depend on whether the bucket is versioned. If the -// bucket is versioned, you need both the s3:GetObjectVersion and -// s3:GetObjectVersionAttributes permissions for this operation. If the bucket is -// not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. -// For more information, see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) in -// the Amazon S3 User Guide. If the object that you request does not exist, the +// For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) +// . Permissions The permissions that you need to use this operation depend on +// whether the bucket is versioned. If the bucket is versioned, you need both the +// s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this +// operation. If the bucket is not versioned, you need the s3:GetObject and +// s3:GetObjectAttributes permissions. For more information, see Specifying +// Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// in the Amazon S3 User Guide. If the object that you request does not exist, the // error Amazon S3 returns depends on whether you also have the s3:ListBucket // permission. +// - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an +// HTTP status code 404 Not Found ("no such key") error. +// - If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP +// status code 403 Forbidden ("access denied") error. // -// * If you have the s3:ListBucket permission on the bucket, Amazon S3 -// returns an HTTP status code 404 Not Found ("no such key") error. -// -// * If you don't -// have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 -// Forbidden ("access denied") error. -// -// The following actions are related to -// GetObjectAttributes: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// GetObjectAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) -// -// * -// GetObjectLegalHold -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html) -// -// * -// GetObjectLockConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html) -// -// * -// GetObjectRetention -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html) -// -// * -// GetObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) -// -// * -// HeadObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html) -// -// * -// ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// The following actions are related to GetObjectAttributes : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) +// - GetObjectLegalHold (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html) +// - GetObjectLockConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html) +// - GetObjectRetention (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html) +// - GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) +// - HeadObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) func (c *Client) GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error) { if params == nil { params = &GetObjectAttributesInput{} @@ -143,17 +96,15 @@ type GetObjectAttributesInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -163,8 +114,8 @@ type GetObjectAttributesInput struct { // This member is required. Key *string - // An XML header that specifies the fields at the root level that you want returned - // in the response. Fields that you do not specify are not returned. + // An XML header that specifies the fields at the root level that you want + // returned in the response. Fields that you do not specify are not returned. // // This member is required. ObjectAttributes []types.ObjectAttributes @@ -177,15 +128,14 @@ type GetObjectAttributesInput struct { // Sets the maximum number of parts to return. MaxParts int32 - // Specifies the part after which listing should begin. Only parts with higher part - // numbers will be listed. + // Specifies the part after which listing should begin. Only parts with higher + // part numbers will be listed. PartNumberMarker *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -215,8 +165,8 @@ type GetObjectAttributesOutput struct { // The checksum or digest of the object. Checksum *types.Checksum - // Specifies whether the object retrieved was (true) or was not (false) a delete - // marker. If false, this response header does not appear in the response. + // Specifies whether the object retrieved was ( true ) or was not ( false ) a + // delete marker. If false , this response header does not appear in the response. DeleteMarker bool // An ETag is an opaque identifier assigned by a web server to a specific version @@ -238,8 +188,8 @@ type GetObjectAttributesOutput struct { // Provides the storage class information of the object. Amazon S3 returns this // header for all objects except for S3 Standard storage class objects. For more - // information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). + // information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // . StorageClass types.StorageClass // The version ID of the object. diff --git a/service/s3/api_op_GetObjectLegalHold.go b/service/s3/api_op_GetObjectLegalHold.go index a2446ac32c9..5f277277ada 100644 --- a/service/s3/api_op_GetObjectLegalHold.go +++ b/service/s3/api_op_GetObjectLegalHold.go @@ -13,12 +13,10 @@ import ( ) // Gets an object's current legal hold status. For more information, see Locking -// Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This -// action is not supported by Amazon S3 on Outposts. The following action is -// related to GetObjectLegalHold: -// -// * GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) . +// This action is not supported by Amazon S3 on Outposts. The following action is +// related to GetObjectLegalHold : +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) func (c *Client) GetObjectLegalHold(ctx context.Context, params *GetObjectLegalHoldInput, optFns ...func(*Options)) (*GetObjectLegalHoldOutput, error) { if params == nil { params = &GetObjectLegalHoldInput{} @@ -42,8 +40,7 @@ type GetObjectLegalHoldInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -62,8 +59,7 @@ type GetObjectLegalHoldInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_GetObjectLockConfiguration.go b/service/s3/api_op_GetObjectLockConfiguration.go index 91793c13385..2890acec1fa 100644 --- a/service/s3/api_op_GetObjectLockConfiguration.go +++ b/service/s3/api_op_GetObjectLockConfiguration.go @@ -14,13 +14,9 @@ import ( // Gets the Object Lock configuration for a bucket. The rule specified in the // Object Lock configuration will be applied by default to every new object placed -// in the specified bucket. For more information, see Locking Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). The -// following action is related to GetObjectLockConfiguration: -// -// * -// GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// in the specified bucket. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) +// . The following action is related to GetObjectLockConfiguration : +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) func (c *Client) GetObjectLockConfiguration(ctx context.Context, params *GetObjectLockConfigurationInput, optFns ...func(*Options)) (*GetObjectLockConfigurationOutput, error) { if params == nil { params = &GetObjectLockConfigurationInput{} @@ -38,14 +34,13 @@ func (c *Client) GetObjectLockConfiguration(ctx context.Context, params *GetObje type GetObjectLockConfigurationInput struct { - // The bucket whose Object Lock configuration you want to retrieve. When using this - // action with an access point, you must direct requests to the access point + // The bucket whose Object Lock configuration you want to retrieve. When using + // this action with an access point, you must direct requests to the access point // hostname. The access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -154,9 +149,9 @@ func newServiceMetadataMiddleware_opGetObjectLockConfiguration(region string) *a } } -// getGetObjectLockConfigurationBucketMember returns a pointer to string denoting a -// provided bucket member valueand a boolean indicating if the input has a modeled -// bucket name, +// getGetObjectLockConfigurationBucketMember returns a pointer to string denoting +// a provided bucket member valueand a boolean indicating if the input has a +// modeled bucket name, func getGetObjectLockConfigurationBucketMember(input interface{}) (*string, bool) { in := input.(*GetObjectLockConfigurationInput) if in.Bucket == nil { diff --git a/service/s3/api_op_GetObjectRetention.go b/service/s3/api_op_GetObjectRetention.go index 33fc04897a3..f254f6dc12e 100644 --- a/service/s3/api_op_GetObjectRetention.go +++ b/service/s3/api_op_GetObjectRetention.go @@ -13,12 +13,10 @@ import ( ) // Retrieves an object's retention settings. For more information, see Locking -// Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This -// action is not supported by Amazon S3 on Outposts. The following action is -// related to GetObjectRetention: -// -// * GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) . +// This action is not supported by Amazon S3 on Outposts. The following action is +// related to GetObjectRetention : +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) func (c *Client) GetObjectRetention(ctx context.Context, params *GetObjectRetentionInput, optFns ...func(*Options)) (*GetObjectRetentionOutput, error) { if params == nil { params = &GetObjectRetentionInput{} @@ -42,8 +40,7 @@ type GetObjectRetentionInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -62,8 +59,7 @@ type GetObjectRetentionInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_GetObjectTagging.go b/service/s3/api_op_GetObjectTagging.go index 7786affd220..cadd2245670 100644 --- a/service/s3/api_op_GetObjectTagging.go +++ b/service/s3/api_op_GetObjectTagging.go @@ -14,26 +14,17 @@ import ( // Returns the tag-set of an object. You send the GET request against the tagging // subresource associated with the object. To use this operation, you must have -// permission to perform the s3:GetObjectTagging action. By default, the GET action -// returns information about current version of an object. For a versioned bucket, -// you can have multiple versions of an object in your bucket. To retrieve tags of -// any other version, use the versionId query parameter. You also need permission -// for the s3:GetObjectVersionTagging action. By default, the bucket owner has this -// permission and can grant this permission to others. For information about the -// Amazon S3 object tagging feature, see Object Tagging -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). The -// following actions are related to GetObjectTagging: -// -// * DeleteObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) -// -// * -// GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) -// -// * -// PutObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) +// permission to perform the s3:GetObjectTagging action. By default, the GET +// action returns information about current version of an object. For a versioned +// bucket, you can have multiple versions of an object in your bucket. To retrieve +// tags of any other version, use the versionId query parameter. You also need +// permission for the s3:GetObjectVersionTagging action. By default, the bucket +// owner has this permission and can grant this permission to others. For +// information about the Amazon S3 object tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html) +// . The following actions are related to GetObjectTagging : +// - DeleteObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// - PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) func (c *Client) GetObjectTagging(ctx context.Context, params *GetObjectTaggingInput, optFns ...func(*Options)) (*GetObjectTaggingOutput, error) { if params == nil { params = &GetObjectTaggingInput{} @@ -57,17 +48,15 @@ type GetObjectTaggingInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -85,8 +74,7 @@ type GetObjectTaggingInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_GetObjectTorrent.go b/service/s3/api_op_GetObjectTorrent.go index a63f4606593..17ef063dd43 100644 --- a/service/s3/api_op_GetObjectTorrent.go +++ b/service/s3/api_op_GetObjectTorrent.go @@ -18,10 +18,8 @@ import ( // less than 5 GB in size, and that are not encrypted using server-side encryption // with a customer-provided encryption key. To use GET, you must have READ access // to the object. This action is not supported by Amazon S3 on Outposts. The -// following action is related to GetObjectTorrent: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// following action is related to GetObjectTorrent : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) func (c *Client) GetObjectTorrent(ctx context.Context, params *GetObjectTorrentInput, optFns ...func(*Options)) (*GetObjectTorrentOutput, error) { if params == nil { params = &GetObjectTorrentInput{} @@ -57,8 +55,7 @@ type GetObjectTorrentInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_GetPublicAccessBlock.go b/service/s3/api_op_GetPublicAccessBlock.go index eb42c7d275a..2c19ef51878 100644 --- a/service/s3/api_op_GetPublicAccessBlock.go +++ b/service/s3/api_op_GetPublicAccessBlock.go @@ -15,33 +15,19 @@ import ( // Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use // this operation, you must have the s3:GetBucketPublicAccessBlock permission. For // more information about Amazon S3 permissions, see Specifying Permissions in a -// Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). -// When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an -// object, it checks the PublicAccessBlock configuration for both the bucket (or -// the bucket that contains the object) and the bucket owner's account. If the +// Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or +// an object, it checks the PublicAccessBlock configuration for both the bucket +// (or the bucket that contains the object) and the bucket owner's account. If the // PublicAccessBlock settings are different between the bucket and the account, // Amazon S3 uses the most restrictive combination of the bucket-level and // account-level settings. For more information about when Amazon S3 considers a -// bucket or an object public, see The Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). -// The following operations are related to GetPublicAccessBlock: -// -// * Using Amazon S3 -// Block Public Access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) -// -// * -// PutPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) -// -// * -// GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) -// -// * -// DeletePublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) +// bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// . The following operations are related to GetPublicAccessBlock : +// - Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// - PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) +// - DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) func (c *Client) GetPublicAccessBlock(ctx context.Context, params *GetPublicAccessBlockInput, optFns ...func(*Options)) (*GetPublicAccessBlockOutput, error) { if params == nil { params = &GetPublicAccessBlockInput{} diff --git a/service/s3/api_op_HeadBucket.go b/service/s3/api_op_HeadBucket.go index 9214bb87375..7477354a036 100644 --- a/service/s3/api_op_HeadBucket.go +++ b/service/s3/api_op_HeadBucket.go @@ -17,27 +17,25 @@ import ( "time" ) -// This action is useful to determine if a bucket exists and you have permission to -// access it. The action returns a 200 OK if the bucket exists and you have +// This action is useful to determine if a bucket exists and you have permission +// to access it. The action returns a 200 OK if the bucket exists and you have // permission to access it. If the bucket does not exist or you do not have -// permission to access it, the HEAD request returns a generic 400 Bad Request, 403 -// Forbidden or 404 Not Found code. A message body is not included, so you cannot -// determine the exception beyond these error codes. To use this operation, you -// must have permissions to perform the s3:ListBucket action. The bucket owner has -// this permission by default and can grant this permission to others. For more +// permission to access it, the HEAD request returns a generic 400 Bad Request , +// 403 Forbidden or 404 Not Found code. A message body is not included, so you +// cannot determine the exception beyond these error codes. To use this operation, +// you must have permissions to perform the s3:ListBucket action. The bucket owner +// has this permission by default and can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// To use this API against an access point, you must provide the alias of the +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . To use this API against an access point, you must provide the alias of the // access point in place of the bucket name or specify the access point ARN. When // using the access point ARN, you must direct requests to the access point // hostname. The access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the // Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For -// more information see, Using access points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html). +// more information see, Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) +// . func (c *Client) HeadBucket(ctx context.Context, params *HeadBucketInput, optFns ...func(*Options)) (*HeadBucketOutput, error) { if params == nil { params = &HeadBucketInput{} @@ -60,17 +58,15 @@ type HeadBucketInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -185,9 +181,9 @@ type BucketExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BucketExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BucketExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -338,9 +334,9 @@ type BucketNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, BucketNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, BucketNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -380,9 +376,9 @@ func NewBucketNotExistsWaiter(client HeadBucketAPIClient, optFns ...func(*Bucket } } -// Wait calls the waiter function for BucketNotExists waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for BucketNotExists waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *BucketNotExistsWaiter) Wait(ctx context.Context, params *HeadBucketInput, maxWaitDur time.Duration, optFns ...func(*BucketNotExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -484,8 +480,9 @@ func newServiceMetadataMiddleware_opHeadBucket(region string) *awsmiddleware.Reg } } -// getHeadBucketBucketMember returns a pointer to string denoting a provided bucket -// member valueand a boolean indicating if the input has a modeled bucket name, +// getHeadBucketBucketMember returns a pointer to string denoting a provided +// bucket member valueand a boolean indicating if the input has a modeled bucket +// name, func getHeadBucketBucketMember(input interface{}) (*string, bool) { in := input.(*HeadBucketInput) if in.Bucket == nil { diff --git a/service/s3/api_op_HeadObject.go b/service/s3/api_op_HeadObject.go index a9dd06b8e40..87430d01d6f 100644 --- a/service/s3/api_op_HeadObject.go +++ b/service/s3/api_op_HeadObject.go @@ -23,88 +23,53 @@ import ( // To use HEAD, you must have READ access to the object. A HEAD request has the // same options as a GET action on an object. The response is identical to the GET // response except that there is no response body. Because of this, if the HEAD -// request generates an error, it returns a generic 400 Bad Request, 403 Forbidden -// or 404 Not Found code. It is not possible to retrieve the exact exception beyond -// these error codes. If you encrypt an object by using server-side encryption with -// customer-provided encryption keys (SSE-C) when you store the object in Amazon -// S3, then when you retrieve the metadata from the object, you must use the -// following headers: +// request generates an error, it returns a generic 400 Bad Request , 403 Forbidden +// or 404 Not Found code. It is not possible to retrieve the exact exception +// beyond these error codes. If you encrypt an object by using server-side +// encryption with customer-provided encryption keys (SSE-C) when you store the +// object in Amazon S3, then when you retrieve the metadata from the object, you +// must use the following headers: +// - x-amz-server-side-encryption-customer-algorithm +// - x-amz-server-side-encryption-customer-key +// - x-amz-server-side-encryption-customer-key-MD5 // -// * x-amz-server-side-encryption-customer-algorithm +// For more information about SSE-C, see Server-Side Encryption (Using +// Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) +// . +// - Encryption request headers, like x-amz-server-side-encryption , should not +// be sent for GET requests if your object uses server-side encryption with KMS +// keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys +// (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 +// BadRequest error. +// - The last modified property in this case is the creation date of the object. // -// * -// x-amz-server-side-encryption-customer-key +// Request headers are limited to 8 KB in size. For more information, see Common +// Request Headers (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html) +// . Consider the following when using request headers: +// - Consideration 1 – If both of the If-Match and If-Unmodified-Since headers +// are present in the request as follows: +// - If-Match condition evaluates to true , and; +// - If-Unmodified-Since condition evaluates to false ; Then Amazon S3 returns +// 200 OK and the data requested. +// - Consideration 2 – If both of the If-None-Match and If-Modified-Since headers +// are present in the request as follows: +// - If-None-Match condition evaluates to false , and; +// - If-Modified-Since condition evaluates to true ; Then Amazon S3 returns the +// 304 Not Modified response code. // -// * -// x-amz-server-side-encryption-customer-key-MD5 +// For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) +// . Permissions You need the relevant read object (or version) permission for this +// operation. For more information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . If the object you request does not exist, the error Amazon S3 returns depends +// on whether you also have the s3:ListBucket permission. +// - If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an +// HTTP status code 404 ("no such key") error. +// - If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP +// status code 403 ("access denied") error. // -// For more information about SSE-C, -// see Server-Side Encryption (Using Customer-Provided Encryption Keys) -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). -// -// * -// Encryption request headers, like x-amz-server-side-encryption, should not be -// sent for GET requests if your object uses server-side encryption with KMS keys -// (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys -// (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 -// BadRequest error. -// -// * The last modified property in this case is the creation -// date of the object. -// -// Request headers are limited to 8 KB in size. For more -// information, see Common Request Headers -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html). -// Consider the following when using request headers: -// -// * Consideration 1 – If both -// of the If-Match and If-Unmodified-Since headers are present in the request as -// follows: -// -// * If-Match condition evaluates to true, and; -// -// * If-Unmodified-Since -// condition evaluates to false; -// -// Then Amazon S3 returns 200 OK and the data -// requested. -// -// * Consideration 2 – If both of the If-None-Match and -// If-Modified-Since headers are present in the request as follows: -// -// * -// If-None-Match condition evaluates to false, and; -// -// * If-Modified-Since condition -// evaluates to true; -// -// Then Amazon S3 returns the 304 Not Modified response -// code. -// -// For more information about conditional requests, see RFC 7232 -// (https://tools.ietf.org/html/rfc7232). Permissions You need the relevant read -// object (or version) permission for this operation. For more information, see -// Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If -// the object you request does not exist, the error Amazon S3 returns depends on -// whether you also have the s3:ListBucket permission. -// -// * If you have the -// s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code -// 404 ("no such key") error. -// -// * If you don’t have the s3:ListBucket permission, -// Amazon S3 returns an HTTP status code 403 ("access denied") error. -// -// The -// following actions are related to HeadObject: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// The following actions are related to HeadObject : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) func (c *Client) HeadObject(ctx context.Context, params *HeadObjectInput, optFns ...func(*Options)) (*HeadObjectOutput, error) { if params == nil { params = &HeadObjectInput{} @@ -128,17 +93,15 @@ type HeadObjectInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -181,16 +144,15 @@ type HeadObjectInput struct { // object. PartNumber int32 - // HeadObject returns only the metadata for an object. If the Range is satisfiable, - // only the ContentLength is affected in the response. If the Range is not - // satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error. + // HeadObject returns only the metadata for an object. If the Range is + // satisfiable, only the ContentLength is affected in the response. If the Range + // is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error. Range *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -234,32 +196,28 @@ type HeadObjectOutput struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -311,17 +269,17 @@ type HeadObjectOutput struct { // can create metadata whose values are not legal HTTP headers. MissingMeta int32 - // Specifies whether a legal hold is in effect for this object. This header is only - // returned if the requester has the s3:GetObjectLegalHold permission. This header - // is not returned if the specified version of this object has never had a legal - // hold applied. For more information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + // Specifies whether a legal hold is in effect for this object. This header is + // only returned if the requester has the s3:GetObjectLegalHold permission. This + // header is not returned if the specified version of this object has never had a + // legal hold applied. For more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) + // . ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus // The Object Lock mode, if any, that's in effect for this object. This header is // only returned if the requester has the s3:GetObjectRetention permission. For - // more information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + // more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) + // . ObjectLockMode types.ObjectLockMode // The date and time when the Object Lock retention period expires. This header is @@ -335,36 +293,30 @@ type HeadObjectOutput struct { // Amazon S3 can return this header if your request involves a bucket that is // either a source or a destination in a replication rule. In replication, you have // a source bucket on which you configure replication and destination bucket or - // buckets where Amazon S3 stores object replicas. When you request an object - // (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will + // buckets where Amazon S3 stores object replicas. When you request an object ( + // GetObject ) or object metadata ( HeadObject ) from these buckets, Amazon S3 will // return the x-amz-replication-status header in the response as follows: - // - // * If - // requesting an object from the source bucket, Amazon S3 will return the - // x-amz-replication-status header if the object in your request is eligible for - // replication. For example, suppose that in your replication configuration, you - // specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key - // prefix TaxDocs. Any objects you upload with this key name prefix, for example - // TaxDocs/document1.pdf, are eligible for replication. For any object request with - // this key name prefix, Amazon S3 will return the x-amz-replication-status header - // with value PENDING, COMPLETED or FAILED indicating object replication status. - // - // * - // If requesting an object from a destination bucket, Amazon S3 will return the - // x-amz-replication-status header with value REPLICA if the object in your request - // is a replica that Amazon S3 created and there is no replica modification - // replication in progress. - // - // * When replicating objects to multiple destination - // buckets, the x-amz-replication-status header acts differently. The header of the - // source object will only return a value of COMPLETED when replication is - // successful to all destinations. The header will remain at value PENDING until - // replication has completed for all destinations. If one or more destinations - // fails replication the header will return FAILED. - // - // For more information, see - // Replication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). + // - If requesting an object from the source bucket, Amazon S3 will return the + // x-amz-replication-status header if the object in your request is eligible for + // replication. For example, suppose that in your replication configuration, you + // specify object prefix TaxDocs requesting Amazon S3 to replicate objects with + // key prefix TaxDocs . Any objects you upload with this key name prefix, for + // example TaxDocs/document1.pdf , are eligible for replication. For any object + // request with this key name prefix, Amazon S3 will return the + // x-amz-replication-status header with value PENDING, COMPLETED or FAILED + // indicating object replication status. + // - If requesting an object from a destination bucket, Amazon S3 will return + // the x-amz-replication-status header with value REPLICA if the object in your + // request is a replica that Amazon S3 created and there is no replica modification + // replication in progress. + // - When replicating objects to multiple destination buckets, the + // x-amz-replication-status header acts differently. The header of the source + // object will only return a value of COMPLETED when replication is successful to + // all destinations. The header will remain at value PENDING until replication has + // completed for all destinations. If one or more destinations fails replication + // the header will return FAILED. + // For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // . ReplicationStatus types.ReplicationStatus // If present, indicates that the requester was successfully charged for the @@ -373,24 +325,24 @@ type HeadObjectOutput struct { // If the object is an archived object (an object whose storage class is GLACIER), // the response includes this header if either the archive restoration is in - // progress (see RestoreObject - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) or an - // archive copy is already restored. If an archive copy is already restored, the - // header value indicates when Amazon S3 is scheduled to delete the object copy. - // For example: x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec - // 2012 00:00:00 GMT" If the object restoration is in progress, the header returns - // the value ongoing-request="true". For more information about archiving objects, - // see Transitioning Objects: General Considerations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations). + // progress (see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) + // or an archive copy is already restored. If an archive copy is already restored, + // the header value indicates when Amazon S3 is scheduled to delete the object + // copy. For example: x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 + // Dec 2012 00:00:00 GMT" If the object restoration is in progress, the header + // returns the value ongoing-request="true" . For more information about archiving + // objects, see Transitioning Objects: General Considerations (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations) + // . Restore *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the ID of the Amazon Web Services Key Management Service @@ -399,13 +351,13 @@ type HeadObjectOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Provides storage class information of the object. Amazon S3 returns this header // for all objects except for S3 Standard storage class objects. For more - // information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). + // information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // . StorageClass types.StorageClass // Version of the object. @@ -517,9 +469,9 @@ type ObjectExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ObjectExistsWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ObjectExistsWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -675,9 +627,9 @@ type ObjectNotExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ObjectNotExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ObjectNotExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -717,9 +669,9 @@ func NewObjectNotExistsWaiter(client HeadObjectAPIClient, optFns ...func(*Object } } -// Wait calls the waiter function for ObjectNotExists waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for ObjectNotExists waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *ObjectNotExistsWaiter) Wait(ctx context.Context, params *HeadObjectInput, maxWaitDur time.Duration, optFns ...func(*ObjectNotExistsWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -826,8 +778,9 @@ func newServiceMetadataMiddleware_opHeadObject(region string) *awsmiddleware.Reg } } -// getHeadObjectBucketMember returns a pointer to string denoting a provided bucket -// member valueand a boolean indicating if the input has a modeled bucket name, +// getHeadObjectBucketMember returns a pointer to string denoting a provided +// bucket member valueand a boolean indicating if the input has a modeled bucket +// name, func getHeadObjectBucketMember(input interface{}) (*string, bool) { in := input.(*HeadObjectInput) if in.Bucket == nil { diff --git a/service/s3/api_op_ListBucketAnalyticsConfigurations.go b/service/s3/api_op_ListBucketAnalyticsConfigurations.go index 0a0373f2904..b501358750c 100644 --- a/service/s3/api_op_ListBucketAnalyticsConfigurations.go +++ b/service/s3/api_op_ListBucketAnalyticsConfigurations.go @@ -17,33 +17,21 @@ import ( // does not return more than 100 configurations at a time. You should always check // the IsTruncated element in the response. If there are no more configurations to // list, IsTruncated is set to false. If there are more configurations to list, -// IsTruncated is set to true, and there will be a value in NextContinuationToken. +// IsTruncated is set to true, and there will be a value in NextContinuationToken . // You use the NextContinuationToken value to continue the pagination of the list // by passing the value in continuation-token in the request to GET the next page. // To use this operation, you must have permissions to perform the // s3:GetAnalyticsConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about Amazon S3 analytics feature, see Amazon S3 Analytics – -// Storage Class Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). -// The following operations are related to ListBucketAnalyticsConfigurations: -// -// * -// GetBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) -// -// * -// DeleteBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) -// -// * -// PutBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about Amazon S3 analytics feature, see Amazon S3 Analytics – +// Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) +// . The following operations are related to ListBucketAnalyticsConfigurations : +// - GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) +// - DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) +// - PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) func (c *Client) ListBucketAnalyticsConfigurations(ctx context.Context, params *ListBucketAnalyticsConfigurationsInput, optFns ...func(*Options)) (*ListBucketAnalyticsConfigurationsOutput, error) { if params == nil { params = &ListBucketAnalyticsConfigurationsInput{} @@ -94,7 +82,7 @@ type ListBucketAnalyticsConfigurationsOutput struct { // NextContinuationToken is sent when isTruncated is true, which indicates that // there are more analytics configurations to list. The next request must include - // this NextContinuationToken. The token is obfuscated and is not a usable value. + // this NextContinuationToken . The token is obfuscated and is not a usable value. NextContinuationToken *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go b/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go index 972a69c99fc..07c4ca9fe83 100644 --- a/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go +++ b/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the S3 Intelligent-Tiering configuration from the specified bucket. The S3 -// Intelligent-Tiering storage class is designed to optimize storage costs by +// Lists the S3 Intelligent-Tiering configuration from the specified bucket. The +// S3 Intelligent-Tiering storage class is designed to optimize storage costs by // automatically moving data to the most cost-effective storage access tier, // without performance impact or operational overhead. S3 Intelligent-Tiering // delivers automatic cost savings in three low latency and high throughput access @@ -25,21 +25,11 @@ import ( // monitored and not eligible for auto-tiering. Smaller objects can be stored, but // they are always charged at the Frequent Access tier rates in the S3 // Intelligent-Tiering storage class. For more information, see Storage class for -// automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). -// Operations related to ListBucketIntelligentTieringConfigurations include: -// -// * -// DeleteBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) -// -// * -// PutBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) -// -// * -// GetBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) +// automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) +// . Operations related to ListBucketIntelligentTieringConfigurations include: +// - DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) +// - PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) +// - GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) func (c *Client) ListBucketIntelligentTieringConfigurations(ctx context.Context, params *ListBucketIntelligentTieringConfigurationsInput, optFns ...func(*Options)) (*ListBucketIntelligentTieringConfigurationsOutput, error) { if params == nil { params = &ListBucketIntelligentTieringConfigurationsInput{} diff --git a/service/s3/api_op_ListBucketInventoryConfigurations.go b/service/s3/api_op_ListBucketInventoryConfigurations.go index e6c8c79a84a..c533f215383 100644 --- a/service/s3/api_op_ListBucketInventoryConfigurations.go +++ b/service/s3/api_op_ListBucketInventoryConfigurations.go @@ -17,32 +17,20 @@ import ( // and does not return more than 100 configurations at a time. Always check the // IsTruncated element in the response. If there are no more configurations to // list, IsTruncated is set to false. If there are more configurations to list, -// IsTruncated is set to true, and there is a value in NextContinuationToken. You +// IsTruncated is set to true, and there is a value in NextContinuationToken . You // use the NextContinuationToken value to continue the pagination of the list by // passing the value in continuation-token in the request to GET the next page. To // use this operation, you must have permissions to perform the // s3:GetInventoryConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about the Amazon S3 inventory feature, see Amazon S3 Inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) The -// following operations are related to ListBucketInventoryConfigurations: -// -// * -// GetBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) -// -// * -// DeleteBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) -// -// * -// PutBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) +// The following operations are related to ListBucketInventoryConfigurations : +// - GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) +// - DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) +// - PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) func (c *Client) ListBucketInventoryConfigurations(ctx context.Context, params *ListBucketInventoryConfigurationsInput, optFns ...func(*Options)) (*ListBucketInventoryConfigurationsOutput, error) { if params == nil { params = &ListBucketInventoryConfigurationsInput{} @@ -88,9 +76,9 @@ type ListBucketInventoryConfigurationsOutput struct { // The list of inventory configurations for a bucket. InventoryConfigurationList []types.InventoryConfiguration - // Tells whether the returned list of inventory configurations is complete. A value - // of true indicates that the list is not complete and the NextContinuationToken is - // provided for a subsequent request. + // Tells whether the returned list of inventory configurations is complete. A + // value of true indicates that the list is not complete and the + // NextContinuationToken is provided for a subsequent request. IsTruncated bool // The marker used to continue this inventory configuration listing. Use the diff --git a/service/s3/api_op_ListBucketMetricsConfigurations.go b/service/s3/api_op_ListBucketMetricsConfigurations.go index 50b207af615..aa6e0814c21 100644 --- a/service/s3/api_op_ListBucketMetricsConfigurations.go +++ b/service/s3/api_op_ListBucketMetricsConfigurations.go @@ -16,35 +16,23 @@ import ( // only for the request metrics of the bucket and do not provide information on // daily storage metrics. You can have up to 1,000 configurations per bucket. This // action supports list pagination and does not return more than 100 configurations -// at a time. Always check the IsTruncated element in the response. If there are no -// more configurations to list, IsTruncated is set to false. If there are more +// at a time. Always check the IsTruncated element in the response. If there are +// no more configurations to list, IsTruncated is set to false. If there are more // configurations to list, IsTruncated is set to true, and there is a value in -// NextContinuationToken. You use the NextContinuationToken value to continue the -// pagination of the list by passing the value in continuation-token in the request -// to GET the next page. To use this operation, you must have permissions to -// perform the s3:GetMetricsConfiguration action. The bucket owner has this +// NextContinuationToken . You use the NextContinuationToken value to continue the +// pagination of the list by passing the value in continuation-token in the +// request to GET the next page. To use this operation, you must have permissions +// to perform the s3:GetMetricsConfiguration action. The bucket owner has this // permission by default. The bucket owner can grant this permission to others. For // more information about permissions, see Permissions Related to Bucket -// Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For more information about metrics configurations and CloudWatch request -// metrics, see Monitoring Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). -// The following operations are related to ListBucketMetricsConfigurations: -// -// * -// PutBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) -// -// * -// GetBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) -// -// * -// DeleteBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For more information about metrics configurations and CloudWatch request +// metrics, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// . The following operations are related to ListBucketMetricsConfigurations : +// - PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) +// - GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) +// - DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) func (c *Client) ListBucketMetricsConfigurations(ctx context.Context, params *ListBucketMetricsConfigurationsInput, optFns ...func(*Options)) (*ListBucketMetricsConfigurationsOutput, error) { if params == nil { params = &ListBucketMetricsConfigurationsInput{} diff --git a/service/s3/api_op_ListBuckets.go b/service/s3/api_op_ListBuckets.go index 2c90f4e38e6..9638d4326ca 100644 --- a/service/s3/api_op_ListBuckets.go +++ b/service/s3/api_op_ListBuckets.go @@ -14,9 +14,9 @@ import ( // Returns a list of all buckets owned by the authenticated sender of the request. // To use this operation, you must have the s3:ListAllMyBuckets permission. For -// information about Amazon S3 buckets, see Creating, configuring, and working with -// Amazon S3 buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html). +// information about Amazon S3 buckets, see Creating, configuring, and working +// with Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) +// . func (c *Client) ListBuckets(ctx context.Context, params *ListBucketsInput, optFns ...func(*Options)) (*ListBucketsOutput, error) { if params == nil { params = &ListBucketsInput{} diff --git a/service/s3/api_op_ListMultipartUploads.go b/service/s3/api_op_ListMultipartUploads.go index 31f97fdc14e..45f876f7acb 100644 --- a/service/s3/api_op_ListMultipartUploads.go +++ b/service/s3/api_op_ListMultipartUploads.go @@ -12,46 +12,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action lists in-progress multipart uploads. An in-progress multipart upload -// is a multipart upload that has been initiated using the Initiate Multipart -// Upload request, but has not yet been completed or aborted. This action returns -// at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the -// maximum number of uploads a response can include, which is also the default -// value. You can further limit the number of uploads in a response by specifying -// the max-uploads parameter in the response. If additional multipart uploads -// satisfy the list criteria, the response will contain an IsTruncated element with -// the value true. To list the additional multipart uploads, use the key-marker and -// upload-id-marker request parameters. In the response, the uploads are sorted by -// key. If your application has initiated more than one multipart upload using the -// same object key, then uploads in the response are first sorted by key. -// Additionally, uploads are sorted in ascending order within each key by the -// upload initiation time. For more information on multipart uploads, see Uploading -// Objects Using Multipart Upload -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For -// information on permissions required to use the multipart upload API, see -// Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The -// following operations are related to ListMultipartUploads: -// -// * -// CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// This action lists in-progress multipart uploads. An in-progress multipart +// upload is a multipart upload that has been initiated using the Initiate +// Multipart Upload request, but has not yet been completed or aborted. This action +// returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads +// is the maximum number of uploads a response can include, which is also the +// default value. You can further limit the number of uploads in a response by +// specifying the max-uploads parameter in the response. If additional multipart +// uploads satisfy the list criteria, the response will contain an IsTruncated +// element with the value true. To list the additional multipart uploads, use the +// key-marker and upload-id-marker request parameters. In the response, the +// uploads are sorted by key. If your application has initiated more than one +// multipart upload using the same object key, then uploads in the response are +// first sorted by key. Additionally, uploads are sorted in ascending order within +// each key by the upload initiation time. For more information on multipart +// uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) +// . For information on permissions required to use the multipart upload API, see +// Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// . The following operations are related to ListMultipartUploads : +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error) { if params == nil { params = &ListMultipartUploadsInput{} @@ -75,24 +58,22 @@ type ListMultipartUploadsInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string // Character you use to group keys. All keys that contain the same string between // the prefix, if specified, and the first occurrence of the delimiter after the - // prefix are grouped under a single result element, CommonPrefixes. If you don't + // prefix are grouped under a single result element, CommonPrefixes . If you don't // specify the prefix parameter, then the substring starts at the beginning of the // key. The keys that are grouped under CommonPrefixes result element are not // returned elsewhere in the response. @@ -112,11 +93,12 @@ type ListMultipartUploadsInput struct { ExpectedBucketOwner *string // Together with upload-id-marker, this parameter specifies the multipart upload - // after which listing should begin. If upload-id-marker is not specified, only the - // keys lexicographically greater than the specified key-marker will be included in - // the list. If upload-id-marker is specified, any multipart uploads for a key - // equal to the key-marker might also be included, provided those multipart uploads - // have upload IDs lexicographically greater than the specified upload-id-marker. + // after which listing should begin. If upload-id-marker is not specified, only + // the keys lexicographically greater than the specified key-marker will be + // included in the list. If upload-id-marker is specified, any multipart uploads + // for a key equal to the key-marker might also be included, provided those + // multipart uploads have upload IDs lexicographically greater than the specified + // upload-id-marker . KeyMarker *string // Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the @@ -134,7 +116,7 @@ type ListMultipartUploadsInput struct { // should begin. If key-marker is not specified, the upload-id-marker parameter is // ignored. Otherwise, any multipart uploads for a key equal to the key-marker // might be included in the list only if they have an upload ID lexicographically - // greater than the specified upload-id-marker. + // greater than the specified upload-id-marker . UploadIdMarker *string noSmithyDocumentSerde @@ -146,9 +128,9 @@ type ListMultipartUploadsOutput struct { // return the access point ARN or access point alias if used. Bucket *string - // If you specify a delimiter in the request, then the result returns each distinct - // key prefix containing the delimiter in a CommonPrefixes element. The distinct - // key prefixes are returned in the Prefix child element. + // If you specify a delimiter in the request, then the result returns each + // distinct key prefix containing the delimiter in a CommonPrefixes element. The + // distinct key prefixes are returned in the Prefix child element. CommonPrefixes []types.CommonPrefix // Contains the delimiter you specified in the request. If you don't specify a @@ -158,7 +140,7 @@ type ListMultipartUploadsOutput struct { // Encoding type used by Amazon S3 to encode object keys in the response. If you // specify encoding-type request parameter, Amazon S3 includes this element in the // response, and returns encoded key name values in the following response - // elements: Delimiter, KeyMarker, Prefix, NextKeyMarker, Key. + // elements: Delimiter , KeyMarker , Prefix , NextKeyMarker , Key . EncodingType types.EncodingType // Indicates whether the returned list of multipart uploads is truncated. A value diff --git a/service/s3/api_op_ListObjectVersions.go b/service/s3/api_op_ListObjectVersions.go index f2d2b9fa951..5b5609d4c14 100644 --- a/service/s3/api_op_ListObjectVersions.go +++ b/service/s3/api_op_ListObjectVersions.go @@ -12,30 +12,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns metadata about all versions of the objects in a bucket. You can also use -// request parameters as selection criteria to return metadata about a subset of -// all the object versions. To use this operation, you must have permissions to -// perform the s3:ListBucketVersions action. Be aware of the name difference. A 200 -// OK response can contain valid or invalid XML. Make sure to design your +// Returns metadata about all versions of the objects in a bucket. You can also +// use request parameters as selection criteria to return metadata about a subset +// of all the object versions. To use this operation, you must have permissions to +// perform the s3:ListBucketVersions action. Be aware of the name difference. A +// 200 OK response can contain valid or invalid XML. Make sure to design your // application to parse the contents of the response and handle it appropriately. // To use this operation, you must have READ access to the bucket. This action is // not supported by Amazon S3 on Outposts. The following operations are related to -// ListObjectVersions: -// -// * ListObjectsV2 -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) -// -// * -// GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// ListObjectVersions : +// - ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) ListObjectVersions(ctx context.Context, params *ListObjectVersionsInput, optFns ...func(*Options)) (*ListObjectVersionsOutput, error) { if params == nil { params = &ListObjectVersionsInput{} @@ -58,11 +47,11 @@ type ListObjectVersionsInput struct { // This member is required. Bucket *string - // A delimiter is a character that you specify to group keys. All keys that contain - // the same string between the prefix and the first occurrence of the delimiter are - // grouped under a single result element in CommonPrefixes. These groups are - // counted as one result against the max-keys limitation. These keys are not - // returned elsewhere in the response. + // A delimiter is a character that you specify to group keys. All keys that + // contain the same string between the prefix and the first occurrence of the + // delimiter are grouped under a single result element in CommonPrefixes. These + // groups are counted as one result against the max-keys limitation. These keys are + // not returned elsewhere in the response. Delimiter *string // Requests Amazon S3 to encode the object keys in the response and specifies the @@ -113,14 +102,14 @@ type ListObjectVersionsOutput struct { // The delimiter grouping the included keys. A delimiter is a character that you // specify to group keys. All keys that contain the same string between the prefix // and the first occurrence of the delimiter are grouped under a single result - // element in CommonPrefixes. These groups are counted as one result against the + // element in CommonPrefixes . These groups are counted as one result against the // max-keys limitation. These keys are not returned elsewhere in the response. Delimiter *string // Encoding type used by Amazon S3 to encode object key names in the XML response. // If you specify encoding-type request parameter, Amazon S3 includes this element // in the response, and returns encoded key name values in the following response - // elements: KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter. + // elements: KeyMarker, NextKeyMarker, Prefix, Key , and Delimiter . EncodingType types.EncodingType // A flag that indicates whether Amazon S3 returned all of the results that @@ -139,12 +128,12 @@ type ListObjectVersionsOutput struct { // The bucket name. Name *string - // When the number of responses exceeds the value of MaxKeys, NextKeyMarker + // When the number of responses exceeds the value of MaxKeys , NextKeyMarker // specifies the first key not returned that satisfies the search criteria. Use // this value for the key-marker request parameter in a subsequent request. NextKeyMarker *string - // When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker + // When the number of responses exceeds the value of MaxKeys , NextVersionIdMarker // specifies the first object version not returned that satisfies the search // criteria. Use this value for the version-id-marker request parameter in a // subsequent request. diff --git a/service/s3/api_op_ListObjects.go b/service/s3/api_op_ListObjects.go index 7fadd42d4a1..4b4c6f0ea61 100644 --- a/service/s3/api_op_ListObjects.go +++ b/service/s3/api_op_ListObjects.go @@ -17,30 +17,14 @@ import ( // bucket. A 200 OK response can contain valid or invalid XML. Be sure to design // your application to parse the contents of the response and handle it // appropriately. This action has been revised. We recommend that you use the newer -// version, ListObjectsV2 -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), when -// developing applications. For backward compatibility, Amazon S3 continues to -// support ListObjects. The following operations are related to ListObjects: -// -// * -// ListObjectsV2 -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) -// -// * -// GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// ListBuckets -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) +// version, ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) +// , when developing applications. For backward compatibility, Amazon S3 continues +// to support ListObjects . The following operations are related to ListObjects : +// - ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) func (c *Client) ListObjects(ctx context.Context, params *ListObjectsInput, optFns ...func(*Options)) (*ListObjectsOutput, error) { if params == nil { params = &ListObjectsInput{} @@ -64,17 +48,15 @@ type ListObjectsInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -145,8 +127,8 @@ type ListObjectsOutput struct { // satisfied the search criteria. IsTruncated bool - // Indicates where in the bucket listing begins. Marker is included in the response - // if it was sent with the request. + // Indicates where in the bucket listing begins. Marker is included in the + // response if it was sent with the request. Marker *string // The maximum number of keys returned in the response body. diff --git a/service/s3/api_op_ListObjectsV2.go b/service/s3/api_op_ListObjectsV2.go index 3a9bc1b6ce2..9d2d9f59148 100644 --- a/service/s3/api_op_ListObjectsV2.go +++ b/service/s3/api_op_ListObjectsV2.go @@ -19,35 +19,23 @@ import ( // Make sure to design your application to parse the contents of the response and // handle it appropriately. Objects are returned sorted in an ascending order of // the respective key names in the list. For more information about listing -// objects, see Listing object keys programmatically -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html) +// objects, see Listing object keys programmatically (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html) // To use this operation, you must have READ access to the bucket. To use this // action in an Identity and Access Management (IAM) policy, you must have // permissions to perform the s3:ListBucket action. The bucket owner has this // permission by default and can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// This section describes the latest revision of this action. We recommend that you -// use this revised API for application development. For backward compatibility, -// Amazon S3 continues to support the prior version of this API, ListObjects -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html). To get a -// list of your buckets, see ListBuckets -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html). The -// following operations are related to ListObjectsV2: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . This section describes the latest revision of this action. We recommend that +// you use this revised API for application development. For backward +// compatibility, Amazon S3 continues to support the prior version of this API, +// ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) +// . To get a list of your buckets, see ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) +// . The following operations are related to ListObjectsV2 : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) func (c *Client) ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, optFns ...func(*Options)) (*ListObjectsV2Output, error) { if params == nil { params = &ListObjectsV2Input{} @@ -70,17 +58,15 @@ type ListObjectsV2Input struct { // the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When // using this action with an access point through the Amazon Web Services SDKs, you // provide the access point ARN in place of the bucket name. For more information - // about access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // about access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -100,8 +86,8 @@ type ListObjectsV2Input struct { // (access denied). ExpectedBucketOwner *string - // The owner field is not present in listV2 by default, if you want to return owner - // field with each key in the result then set the fetch owner field to true. + // The owner field is not present in listV2 by default, if you want to return + // owner field with each key in the result then set the fetch owner field to true. FetchOwner bool // Sets the maximum number of keys returned in the response. By default the action @@ -130,11 +116,11 @@ type ListObjectsV2Output struct { // return when calculating the number of returns. A response can contain // CommonPrefixes only if you specify a delimiter. CommonPrefixes contains all (if // there are any) keys between Prefix and the next occurrence of the string - // specified by a delimiter. CommonPrefixes lists keys that act like subdirectories - // in the directory specified by Prefix. For example, if the prefix is notes/ and - // the delimiter is a slash (/) as in notes/summer/july, the common prefix is - // notes/summer/. All of the keys that roll up into a common prefix count as a - // single return when calculating the number of returns. + // specified by a delimiter. CommonPrefixes lists keys that act like + // subdirectories in the directory specified by Prefix . For example, if the prefix + // is notes/ and the delimiter is a slash ( / ) as in notes/summer/july , the + // common prefix is notes/summer/ . All of the keys that roll up into a common + // prefix count as a single return when calculating the number of returns. CommonPrefixes []types.CommonPrefix // Metadata about each object returned. @@ -153,7 +139,7 @@ type ListObjectsV2Output struct { // Encoding type used by Amazon S3 to encode object key names in the XML response. // If you specify the encoding-type request parameter, Amazon S3 includes this // element in the response, and returns encoded key name values in the following - // response elements: Delimiter, Prefix, Key, and StartAfter. + // response elements: Delimiter, Prefix, Key, and StartAfter . EncodingType types.EncodingType // Set to false if all of the results were returned. Set to true if more keys are @@ -162,8 +148,8 @@ type ListObjectsV2Output struct { IsTruncated bool // KeyCount is the number of keys returned with this request. KeyCount will always - // be less than or equal to the MaxKeys field. Say you ask for 50 keys, your result - // will include 50 keys or fewer. + // be less than or equal to the MaxKeys field. Say you ask for 50 keys, your + // result will include 50 keys or fewer. KeyCount int32 // Sets the maximum number of keys returned in the response. By default the action @@ -176,22 +162,20 @@ type ListObjectsV2Output struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. Name *string // NextContinuationToken is sent when isTruncated is true, which means there are // more keys in the bucket that can be listed. The next list requests to Amazon S3 - // can be continued with this NextContinuationToken. NextContinuationToken is + // can be continued with this NextContinuationToken . NextContinuationToken is // obfuscated and is not a real key NextContinuationToken *string diff --git a/service/s3/api_op_ListParts.go b/service/s3/api_op_ListParts.go index 90ac3651005..1d1fae9354d 100644 --- a/service/s3/api_op_ListParts.go +++ b/service/s3/api_op_ListParts.go @@ -16,46 +16,26 @@ import ( // Lists the parts that have been uploaded for a specific multipart upload. This // operation must include the upload ID, which you obtain by sending the initiate -// multipart upload request (see CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)). -// This request returns a maximum of 1,000 uploaded parts. The default number of +// multipart upload request (see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// ). This request returns a maximum of 1,000 uploaded parts. The default number of // parts returned is 1,000 parts. You can restrict the number of parts returned by -// specifying the max-parts request parameter. If your multipart upload consists of -// more than 1,000 parts, the response returns an IsTruncated field with the value -// of true, and a NextPartNumberMarker element. In subsequent ListParts requests -// you can include the part-number-marker query string parameter and set its value -// to the NextPartNumberMarker field value from the previous response. If the -// upload was created using a checksum algorithm, you will need to have permission -// to the kms:Decrypt action for the request to succeed. For more information on -// multipart uploads, see Uploading Objects Using Multipart Upload -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For -// information on permissions required to use the multipart upload API, see -// Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The -// following operations are related to ListParts: -// -// * CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) -// -// * -// GetObjectAttributes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// specifying the max-parts request parameter. If your multipart upload consists +// of more than 1,000 parts, the response returns an IsTruncated field with the +// value of true, and a NextPartNumberMarker element. In subsequent ListParts +// requests you can include the part-number-marker query string parameter and set +// its value to the NextPartNumberMarker field value from the previous response. +// If the upload was created using a checksum algorithm, you will need to have +// permission to the kms:Decrypt action for the request to succeed. For more +// information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) +// . For information on permissions required to use the multipart upload API, see +// Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// . The following operations are related to ListParts : +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error) { if params == nil { params = &ListPartsInput{} @@ -79,17 +59,15 @@ type ListPartsInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -112,36 +90,32 @@ type ListPartsInput struct { // Sets the maximum number of parts to return. MaxParts int32 - // Specifies the part after which listing should begin. Only parts with higher part - // numbers will be listed. + // Specifies the part after which listing should begin. Only parts with higher + // part numbers will be listed. PartNumberMarker *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer // The server-side encryption (SSE) algorithm used to encrypt the object. This // parameter is needed only when the object was created using a checksum algorithm. - // For more information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // For more information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerAlgorithm *string // The server-side encryption (SSE) customer managed key. This parameter is needed // only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKey *string // The MD5 server-side encryption (SSE) customer managed key. This parameter is // needed only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKeyMD5 *string @@ -150,15 +124,14 @@ type ListPartsInput struct { type ListPartsOutput struct { - // If the bucket has a lifecycle rule configured with an action to abort incomplete - // multipart uploads and the prefix in the lifecycle rule matches the object name - // in the request, then the response includes this header indicating when the - // initiated multipart upload will become eligible for abort operation. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). - // The response will also include the x-amz-abort-rule-id header that will provide - // the ID of the lifecycle configuration rule that defines this action. + // If the bucket has a lifecycle rule configured with an action to abort + // incomplete multipart uploads and the prefix in the lifecycle rule matches the + // object name in the request, then the response includes this header indicating + // when the initiated multipart upload will become eligible for abort operation. + // For more information, see Aborting Incomplete Multipart Uploads Using a Bucket + // Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + // . The response will also include the x-amz-abort-rule-id header that will + // provide the ID of the lifecycle configuration rule that defines this action. AbortDate *time.Time // This header is returned along with the x-amz-abort-date header. It identifies @@ -195,9 +168,9 @@ type ListPartsOutput struct { // subsequent request. NextPartNumberMarker *string - // Container element that identifies the object owner, after the object is created. - // If multipart upload is initiated by an IAM user, this element provides the - // parent account ID and display name. + // Container element that identifies the object owner, after the object is + // created. If multipart upload is initiated by an IAM user, this element provides + // the parent account ID and display name. Owner *types.Owner // When a list is truncated, this element specifies the last part in the list, as @@ -205,8 +178,8 @@ type ListPartsOutput struct { // subsequent request. PartNumberMarker *string - // Container for elements related to a particular part. A response can contain zero - // or more Part elements. + // Container for elements related to a particular part. A response can contain + // zero or more Part elements. Parts []types.Part // If present, indicates that the requester was successfully charged for the diff --git a/service/s3/api_op_PutBucketAccelerateConfiguration.go b/service/s3/api_op_PutBucketAccelerateConfiguration.go index 7875798f255..6a0bbf7a265 100644 --- a/service/s3/api_op_PutBucketAccelerateConfiguration.go +++ b/service/s3/api_op_PutBucketAccelerateConfiguration.go @@ -19,37 +19,23 @@ import ( // perform the s3:PutAccelerateConfiguration action. The bucket owner has this // permission by default. The bucket owner can grant this permission to others. For // more information about permissions, see Permissions Related to Bucket -// Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// The Transfer Acceleration state of a bucket can be set to one of the following +// Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . The Transfer Acceleration state of a bucket can be set to one of the following // two values: +// - Enabled – Enables accelerated data transfers to the bucket. +// - Suspended – Disables accelerated data transfers to the bucket. // -// * Enabled – Enables accelerated data transfers to the bucket. -// -// * -// Suspended – Disables accelerated data transfers to the bucket. -// -// The -// GetBucketAccelerateConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) +// The GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) // action returns the transfer acceleration state of a bucket. After setting the // Transfer Acceleration state of a bucket to Enabled, it might take up to thirty // minutes before the data transfer rates to the bucket increase. The name of the // bucket used for Transfer Acceleration must be DNS-compliant and must not contain // periods ("."). For more information about transfer acceleration, see Transfer -// Acceleration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). -// The following operations are related to PutBucketAccelerateConfiguration: -// -// * -// GetBucketAccelerateConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) +// . The following operations are related to PutBucketAccelerateConfiguration : +// - GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) func (c *Client) PutBucketAccelerateConfiguration(ctx context.Context, params *PutBucketAccelerateConfigurationInput, optFns ...func(*Options)) (*PutBucketAccelerateConfigurationOutput, error) { if params == nil { params = &PutBucketAccelerateConfigurationInput{} @@ -81,9 +67,8 @@ type PutBucketAccelerateConfigurationInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/s3/api_op_PutBucketAcl.go b/service/s3/api_op_PutBucketAcl.go index 4cd032d3433..08e7d46ace2 100644 --- a/service/s3/api_op_PutBucketAcl.go +++ b/service/s3/api_op_PutBucketAcl.go @@ -13,147 +13,88 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the permissions on an existing bucket using access control lists (ACL). For -// more information, see Using ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To set -// the ACL of a bucket, you must have WRITE_ACP permission. You can use one of the -// following two ways to set a bucket's permissions: -// -// * Specify the ACL in the -// request body -// -// * Specify permissions using request headers -// -// You cannot specify -// access permission using both the body and the request headers. Depending on your -// application needs, you may choose to set the ACL on a bucket using either the -// request body or the headers. For example, if you have an existing application -// that updates a bucket ACL using the request body, then you can continue to use -// that approach. If your bucket uses the bucket owner enforced setting for S3 -// Object Ownership, ACLs are disabled and no longer affect permissions. You must -// use policies to grant access to your bucket and the objects in it. Requests to -// set ACLs or update ACLs fail and return the AccessControlListNotSupported error -// code. Requests to read ACLs are still supported. For more information, see -// Controlling object ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// Sets the permissions on an existing bucket using access control lists (ACL). +// For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) +// . To set the ACL of a bucket, you must have WRITE_ACP permission. You can use +// one of the following two ways to set a bucket's permissions: +// - Specify the ACL in the request body +// - Specify permissions using request headers +// +// You cannot specify access permission using both the body and the request +// headers. Depending on your application needs, you may choose to set the ACL on a +// bucket using either the request body or the headers. For example, if you have an +// existing application that updates a bucket ACL using the request body, then you +// can continue to use that approach. If your bucket uses the bucket owner enforced +// setting for S3 Object Ownership, ACLs are disabled and no longer affect +// permissions. You must use policies to grant access to your bucket and the +// objects in it. Requests to set ACLs or update ACLs fail and return the +// AccessControlListNotSupported error code. Requests to read ACLs are still +// supported. For more information, see Controlling object ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. Access Permissions You can set access permissions // using one of the following methods: -// -// * Specify a canned ACL with the x-amz-acl -// request header. Amazon S3 supports a set of predefined ACLs, known as canned -// ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify -// the canned ACL name as the value of x-amz-acl. If you use this header, you -// cannot use other access control-specific headers in your request. For more -// information, see Canned ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). -// -// * -// Specify access permissions explicitly with the x-amz-grant-read, -// x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control -// headers. When using these headers, you specify explicit access permissions and -// grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the -// permission. If you use these ACL-specific headers, you cannot use the x-amz-acl -// header to set a canned ACL. These parameters map to the set of permissions that -// Amazon S3 supports in an ACL. For more information, see Access Control List -// (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify -// each grantee as a type=value pair, where the type is one of the following: -// -// * id -// – if the value specified is the canonical user ID of an Amazon Web Services -// account -// -// * uri – if you are granting permissions to a predefined group -// -// * -// emailAddress – if the value specified is the email address of an Amazon Web -// Services account Using email addresses to specify a grantee is only supported in -// the following Amazon Web Services Regions: -// -// * US East (N. Virginia) -// -// * US West -// (N. California) -// -// * US West (Oregon) -// -// * Asia Pacific (Singapore) -// -// * Asia Pacific -// (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe (Ireland) -// -// * South America (São -// Paulo) -// -// For a list of all the Amazon S3 supported Regions and endpoints, see -// Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// For example, the following -// x-amz-grant-write header grants create, overwrite, and delete objects permission -// to LogDelivery group predefined by Amazon S3 and two Amazon Web Services -// accounts identified by their email addresses. x-amz-grant-write: -// uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", -// id="555566667777" -// -// You can use either a canned ACL or specify access permissions -// explicitly. You cannot do both. Grantee Values You can specify the person -// (grantee) to whom you're assigning access rights (using request elements) in the -// following ways: -// -// * By the person's ID: <>ID<><>GranteesEmail<> DisplayName is -// optional and ignored in the request -// -// * By URI: -// <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> -// -// * By Email -// address: <>Grantees@email.com<>& The grantee is resolved to the CanonicalUser -// and, in a response to a GET Object acl request, appears as the CanonicalUser. -// Using email addresses to specify a grantee is only supported in the following -// Amazon Web Services Regions: -// -// * US East (N. Virginia) -// -// * US West (N. -// California) -// -// * US West (Oregon) -// -// * Asia Pacific (Singapore) -// -// * Asia Pacific -// (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe (Ireland) -// -// * South America (São -// Paulo) -// -// For a list of all the Amazon S3 supported Regions and endpoints, see -// Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// # Related Resources -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) -// -// * -// GetObjectAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) +// - Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a +// set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined +// set of grantees and permissions. Specify the canned ACL name as the value of +// x-amz-acl . If you use this header, you cannot use other access +// control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) +// . +// - Specify access permissions explicitly with the x-amz-grant-read , +// x-amz-grant-read-acp , x-amz-grant-write-acp , and x-amz-grant-full-control +// headers. When using these headers, you specify explicit access permissions and +// grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the +// permission. If you use these ACL-specific headers, you cannot use the +// x-amz-acl header to set a canned ACL. These parameters map to the set of +// permissions that Amazon S3 supports in an ACL. For more information, see +// Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// . You specify each grantee as a type=value pair, where the type is one of the +// following: +// - id – if the value specified is the canonical user ID of an Amazon Web +// Services account +// - uri – if you are granting permissions to a predefined group +// - emailAddress – if the value specified is the email address of an Amazon Web +// Services account Using email addresses to specify a grantee is only supported in +// the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. For example, the following +// x-amz-grant-write header grants create, overwrite, and delete objects +// permission to LogDelivery group predefined by Amazon S3 and two Amazon Web +// Services accounts identified by their email addresses. x-amz-grant-write: +// uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", +// id="555566667777" +// +// You can use either a canned ACL or specify access permissions explicitly. You +// cannot do both. Grantee Values You can specify the person (grantee) to whom +// you're assigning access rights (using request elements) in the following ways: +// - By the person's ID: <>ID<><>GranteesEmail<> DisplayName is optional and +// ignored in the request +// - By URI: <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> +// - By Email address: <>Grantees@email.com<>& The grantee is resolved to the +// CanonicalUser and, in a response to a GET Object acl request, appears as the +// CanonicalUser. Using email addresses to specify a grantee is only supported in +// the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. +// +// Related Resources +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// - GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) func (c *Client) PutBucketAcl(ctx context.Context, params *PutBucketAclInput, optFns ...func(*Options)) (*PutBucketAclOutput, error) { if params == nil { params = &PutBucketAclInput{} @@ -186,19 +127,17 @@ type PutBucketAclInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. This header must be used as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, go to RFC 1864. - // (http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. This header must be used as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, go to RFC 1864. (http://www.ietf.org/rfc/rfc1864.txt) + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a diff --git a/service/s3/api_op_PutBucketAnalyticsConfiguration.go b/service/s3/api_op_PutBucketAnalyticsConfiguration.go index da70d547ee3..68e3f7291c4 100644 --- a/service/s3/api_op_PutBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_PutBucketAnalyticsConfiguration.go @@ -22,60 +22,35 @@ import ( // to a destination bucket in a different account. However, the destination bucket // must be in the same Region as the bucket that you are making the PUT analytics // configuration to. For more information, see Amazon S3 Analytics – Storage Class -// Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). -// You must create a bucket policy on the destination bucket where the exported +// Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) +// . You must create a bucket policy on the destination bucket where the exported // file is written to grant permissions to Amazon S3 to write objects to the // bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory -// and Storage Class Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9). -// To use this operation, you must have permissions to perform the +// and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9) +// . To use this operation, you must have permissions to perform the // s3:PutAnalyticsConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// Special Errors +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . Special Errors +// - HTTP Error: HTTP 400 Bad Request +// - Code: InvalidArgument +// - Cause: Invalid argument. +// - HTTP Error: HTTP 400 Bad Request +// - Code: TooManyConfigurations +// - Cause: You are attempting to create a new configuration but have already +// reached the 1,000-configuration limit. +// - HTTP Error: HTTP 403 Forbidden +// - Code: AccessDenied +// - Cause: You are not the owner of the specified bucket, or you do not have +// the s3:PutAnalyticsConfiguration bucket permission to set the configuration on +// the bucket. // -// * HTTP Error: HTTP 400 Bad Request -// -// * Code: InvalidArgument -// -// * -// Cause: Invalid argument. -// -// * HTTP Error: HTTP 400 Bad Request -// -// * Code: -// TooManyConfigurations -// -// * Cause: You are attempting to create a new configuration -// but have already reached the 1,000-configuration limit. -// -// * HTTP Error: HTTP 403 -// Forbidden -// -// * Code: AccessDenied -// -// * Cause: You are not the owner of the specified -// bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to -// set the configuration on the bucket. -// -// # Related Resources -// -// * -// GetBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) -// -// * -// DeleteBucketAnalyticsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) -// -// * -// ListBucketAnalyticsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) +// Related Resources +// - GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) +// - DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) +// - ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) func (c *Client) PutBucketAnalyticsConfiguration(ctx context.Context, params *PutBucketAnalyticsConfigurationInput, optFns ...func(*Options)) (*PutBucketAnalyticsConfigurationOutput, error) { if params == nil { params = &PutBucketAnalyticsConfigurationInput{} diff --git a/service/s3/api_op_PutBucketCors.go b/service/s3/api_op_PutBucketCors.go index 55a67f18826..201222ff8f0 100644 --- a/service/s3/api_op_PutBucketCors.go +++ b/service/s3/api_op_PutBucketCors.go @@ -13,48 +13,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the cors configuration for your bucket. If the configuration exists, Amazon -// S3 replaces it. To use this operation, you must be allowed to perform the +// Sets the cors configuration for your bucket. If the configuration exists, +// Amazon S3 replaces it. To use this operation, you must be allowed to perform the // s3:PutBucketCORS action. By default, the bucket owner has this permission and // can grant it to others. You set this configuration on a bucket so that the // bucket can service cross-origin requests. For example, you might want to enable -// a request whose origin is http://www.example.com to access your Amazon S3 bucket -// at my.example.bucket.com by using the browser's XMLHttpRequest capability. To -// enable cross-origin resource sharing (CORS) on a bucket, you add the cors -// subresource to the bucket. The cors subresource is an XML document in which you -// configure rules that identify origins and the HTTP methods that can be executed -// on your bucket. The document is limited to 64 KB in size. When Amazon S3 -// receives a cross-origin request (or a pre-flight OPTIONS request) against a +// a request whose origin is http://www.example.com to access your Amazon S3 +// bucket at my.example.bucket.com by using the browser's XMLHttpRequest +// capability. To enable cross-origin resource sharing (CORS) on a bucket, you add +// the cors subresource to the bucket. The cors subresource is an XML document in +// which you configure rules that identify origins and the HTTP methods that can be +// executed on your bucket. The document is limited to 64 KB in size. When Amazon +// S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a // bucket, it evaluates the cors configuration on the bucket and uses the first // CORSRule rule that matches the incoming browser request to enable a cross-origin // request. For a rule to match, the following conditions must be met: +// - The request's Origin header must match AllowedOrigin elements. +// - The request method (for example, GET, PUT, HEAD, and so on) or the +// Access-Control-Request-Method header in case of a pre-flight OPTIONS request +// must be one of the AllowedMethod elements. +// - Every header specified in the Access-Control-Request-Headers request header +// of a pre-flight request must match an AllowedHeader element. // -// * The -// request's Origin header must match AllowedOrigin elements. -// -// * The request method -// (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method -// header in case of a pre-flight OPTIONS request must be one of the AllowedMethod -// elements. -// -// * Every header specified in the Access-Control-Request-Headers -// request header of a pre-flight request must match an AllowedHeader element. -// -// For -// more information about CORS, go to Enabling Cross-Origin Resource Sharing -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3 -// User Guide. Related Resources -// -// * GetBucketCors -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html) -// -// * -// DeleteBucketCors -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) -// -// * -// RESTOPTIONSobject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) +// For more information about CORS, go to Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) +// in the Amazon S3 User Guide. Related Resources +// - GetBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html) +// - DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) +// - RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) func (c *Client) PutBucketCors(ctx context.Context, params *PutBucketCorsInput, optFns ...func(*Options)) (*PutBucketCorsOutput, error) { if params == nil { params = &PutBucketCorsInput{} @@ -72,15 +57,14 @@ func (c *Client) PutBucketCors(ctx context.Context, params *PutBucketCorsInput, type PutBucketCorsInput struct { - // Specifies the bucket impacted by the corsconfiguration. + // Specifies the bucket impacted by the cors configuration. // // This member is required. Bucket *string // Describes the cross-origin access configuration for objects in an Amazon S3 - // bucket. For more information, see Enabling Cross-Origin Resource Sharing - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3 - // User Guide. + // bucket. For more information, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) + // in the Amazon S3 User Guide. // // This member is required. CORSConfiguration *types.CORSConfiguration @@ -89,19 +73,17 @@ type PutBucketCorsInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. This header must be used as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, go to RFC 1864. - // (http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. This header must be used as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, go to RFC 1864. (http://www.ietf.org/rfc/rfc1864.txt) + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a @@ -206,8 +188,8 @@ func newServiceMetadataMiddleware_opPutBucketCors(region string) *awsmiddleware. } } -// getPutBucketCorsRequestAlgorithmMember gets the request checksum algorithm value -// provided as input. +// getPutBucketCorsRequestAlgorithmMember gets the request checksum algorithm +// value provided as input. func getPutBucketCorsRequestAlgorithmMember(input interface{}) (string, bool) { in := input.(*PutBucketCorsInput) if len(in.ChecksumAlgorithm) == 0 { diff --git a/service/s3/api_op_PutBucketEncryption.go b/service/s3/api_op_PutBucketEncryption.go index 02c6f8e2787..db30e008cbb 100644 --- a/service/s3/api_op_PutBucketEncryption.go +++ b/service/s3/api_op_PutBucketEncryption.go @@ -20,30 +20,21 @@ import ( // bucket by using server-side encryption with an Amazon Web Services KMS key // (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption // by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information -// about bucket default encryption, see Amazon S3 bucket default encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the -// Amazon S3 User Guide. For more information about S3 Bucket Keys, see Amazon S3 -// Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in -// the Amazon S3 User Guide. This action requires Amazon Web Services Signature -// Version 4. For more information, see Authenticating Requests (Amazon Web -// Services Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html). -// To use this operation, you must have permissions to perform the +// about bucket default encryption, see Amazon S3 bucket default encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) +// in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see +// Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) +// in the Amazon S3 User Guide. This action requires Amazon Web Services Signature +// Version 4. For more information, see Authenticating Requests (Amazon Web +// Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// . To use this operation, you must have permissions to perform the // s3:PutEncryptionConfiguration action. The bucket owner has this permission by // default. The bucket owner can grant this permission to others. For more // information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. Related Resources -// -// * GetBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) -// -// * -// DeleteBucketEncryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) +// - GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) +// - DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) func (c *Client) PutBucketEncryption(ctx context.Context, params *PutBucketEncryptionInput, optFns ...func(*Options)) (*PutBucketEncryptionOutput, error) { if params == nil { params = &PutBucketEncryptionInput{} @@ -67,9 +58,8 @@ type PutBucketEncryptionInput struct { // (SSE-S3). You can optionally configure default encryption for a bucket by using // server-side encryption with an Amazon Web Services KMS key (SSE-KMS) or a // customer-provided key (SSE-C). For information about the bucket default - // encryption feature, see Amazon S3 Bucket Default Encryption - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the - // Amazon S3 User Guide. + // encryption feature, see Amazon S3 Bucket Default Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -83,9 +73,8 @@ type PutBucketEncryptionInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -198,8 +187,8 @@ func newServiceMetadataMiddleware_opPutBucketEncryption(region string) *awsmiddl } } -// getPutBucketEncryptionRequestAlgorithmMember gets the request checksum algorithm -// value provided as input. +// getPutBucketEncryptionRequestAlgorithmMember gets the request checksum +// algorithm value provided as input. func getPutBucketEncryptionRequestAlgorithmMember(input interface{}) (string, bool) { in := input.(*PutBucketEncryptionInput) if len(in.ChecksumAlgorithm) == 0 { diff --git a/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go b/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go index edf5d178be1..efd8c1c2290 100644 --- a/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go @@ -26,51 +26,27 @@ import ( // monitored and not eligible for auto-tiering. Smaller objects can be stored, but // they are always charged at the Frequent Access tier rates in the S3 // Intelligent-Tiering storage class. For more information, see Storage class for -// automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). -// Operations related to PutBucketIntelligentTieringConfiguration include: +// automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) +// . Operations related to PutBucketIntelligentTieringConfiguration include: +// - DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) +// - GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) +// - ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) // -// * -// DeleteBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) -// -// * -// GetBucketIntelligentTieringConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) -// -// * -// ListBucketIntelligentTieringConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) -// -// You -// only need S3 Intelligent-Tiering enabled on a bucket if you want to +// You only need S3 Intelligent-Tiering enabled on a bucket if you want to // automatically move objects stored in the S3 Intelligent-Tiering storage class to // the Archive Access or Deep Archive Access tier. Special Errors -// -// * HTTP 400 Bad -// Request Error -// -// * Code: InvalidArgument -// -// * Cause: Invalid Argument -// -// * HTTP 400 -// Bad Request Error -// -// * Code: TooManyConfigurations -// -// * Cause: You are attempting to -// create a new configuration but have already reached the 1,000-configuration -// limit. -// -// * HTTP 403 Forbidden Error -// -// * Code: AccessDenied -// -// * Cause: You are not -// the owner of the specified bucket, or you do not have the -// s3:PutIntelligentTieringConfiguration bucket permission to set the configuration -// on the bucket. +// - HTTP 400 Bad Request Error +// - Code: InvalidArgument +// - Cause: Invalid Argument +// - HTTP 400 Bad Request Error +// - Code: TooManyConfigurations +// - Cause: You are attempting to create a new configuration but have already +// reached the 1,000-configuration limit. +// - HTTP 403 Forbidden Error +// - Code: AccessDenied +// - Cause: You are not the owner of the specified bucket, or you do not have +// the s3:PutIntelligentTieringConfiguration bucket permission to set the +// configuration on the bucket. func (c *Client) PutBucketIntelligentTieringConfiguration(ctx context.Context, params *PutBucketIntelligentTieringConfigurationInput, optFns ...func(*Options)) (*PutBucketIntelligentTieringConfigurationOutput, error) { if params == nil { params = &PutBucketIntelligentTieringConfigurationInput{} diff --git a/service/s3/api_op_PutBucketInventoryConfiguration.go b/service/s3/api_op_PutBucketInventoryConfiguration.go index 11fe26d50a1..6152de860af 100644 --- a/service/s3/api_op_PutBucketInventoryConfiguration.go +++ b/service/s3/api_op_PutBucketInventoryConfiguration.go @@ -24,71 +24,43 @@ import ( // to be stored, and whether to generate the inventory daily or weekly. You can // also configure what object metadata to include and whether to inventory all // object versions or only current versions. For more information, see Amazon S3 -// Inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) in the -// Amazon S3 User Guide. You must create a bucket policy on the destination bucket -// to grant permissions to Amazon S3 to write objects to the bucket in the defined -// location. For an example policy, see Granting Permissions for Amazon S3 -// Inventory and Storage Class Analysis -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9). -// Permissions To use this operation, you must have permission to perform the +// Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) +// in the Amazon S3 User Guide. You must create a bucket policy on the destination +// bucket to grant permissions to Amazon S3 to write objects to the bucket in the +// defined location. For an example policy, see Granting Permissions for Amazon S3 +// Inventory and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9) +// . Permissions To use this operation, you must have permission to perform the // s3:PutInventoryConfiguration action. The bucket owner has this permission by // default and can grant this permission to others. The -// s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html) +// s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html) // report that includes all object metadata fields available and to specify the // destination bucket to store the inventory. A user with read access to objects in // the destination bucket can also access all object metadata fields that are // available in the inventory report. To restrict access to an inventory report, -// see Restricting access to an Amazon S3 Inventory report -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10) +// see Restricting access to an Amazon S3 Inventory report (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10) // in the Amazon S3 User Guide. For more information about the metadata fields -// available in S3 Inventory, see Amazon S3 Inventory lists -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents) +// available in S3 Inventory, see Amazon S3 Inventory lists (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents) // in the Amazon S3 User Guide. For more information about permissions, see -// Permissions related to bucket subresource operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Identity and access management in Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// Permissions related to bucket subresource operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Identity and access management in Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. Special Errors +// - HTTP 400 Bad Request Error +// - Code: InvalidArgument +// - Cause: Invalid Argument +// - HTTP 400 Bad Request Error +// - Code: TooManyConfigurations +// - Cause: You are attempting to create a new configuration but have already +// reached the 1,000-configuration limit. +// - HTTP 403 Forbidden Error +// - Code: AccessDenied +// - Cause: You are not the owner of the specified bucket, or you do not have +// the s3:PutInventoryConfiguration bucket permission to set the configuration on +// the bucket. // -// * HTTP 400 Bad Request Error -// -// * -// Code: InvalidArgument -// -// * Cause: Invalid Argument -// -// * HTTP 400 Bad Request -// Error -// -// * Code: TooManyConfigurations -// -// * Cause: You are attempting to create a -// new configuration but have already reached the 1,000-configuration limit. -// -// * -// HTTP 403 Forbidden Error -// -// * Code: AccessDenied -// -// * Cause: You are not the owner -// of the specified bucket, or you do not have the s3:PutInventoryConfiguration -// bucket permission to set the configuration on the bucket. -// -// # Related Resources -// -// * -// GetBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) -// -// * -// DeleteBucketInventoryConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) -// -// * -// ListBucketInventoryConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) +// Related Resources +// - GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) +// - DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) +// - ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) func (c *Client) PutBucketInventoryConfiguration(ctx context.Context, params *PutBucketInventoryConfigurationInput, optFns ...func(*Options)) (*PutBucketInventoryConfigurationOutput, error) { if params == nil { params = &PutBucketInventoryConfigurationInput{} diff --git a/service/s3/api_op_PutBucketLifecycleConfiguration.go b/service/s3/api_op_PutBucketLifecycleConfiguration.go index ca79b24e966..f641d9b923b 100644 --- a/service/s3/api_op_PutBucketLifecycleConfiguration.go +++ b/service/s3/api_op_PutBucketLifecycleConfiguration.go @@ -17,73 +17,52 @@ import ( // lifecycle configuration. Keep in mind that this will overwrite an existing // lifecycle configuration, so if you want to retain any configuration details, // they must be included in the new lifecycle configuration. For information about -// lifecycle configuration, see Managing your storage lifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html). -// Bucket lifecycle configuration now supports specifying a lifecycle rule using an -// object key name prefix, one or more object tags, or a combination of both. +// lifecycle configuration, see Managing your storage lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) +// . Bucket lifecycle configuration now supports specifying a lifecycle rule using +// an object key name prefix, one or more object tags, or a combination of both. // Accordingly, this section describes the latest API. The previous version of the // API supported filtering based only on an object key name prefix, which is // supported for backward compatibility. For the related API description, see -// PutBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html). -// Rules You specify the lifecycle configuration in your request body. The +// PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) +// . Rules You specify the lifecycle configuration in your request body. The // lifecycle configuration is specified as XML consisting of one or more rules. An // Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not // adjustable. Each rule consists of the following: // -// * Filter identifying a subset -// of objects to which the rule applies. The filter can be based on a key name -// prefix, object tags, or a combination of both. +// - Filter identifying a subset of objects to which the rule applies. The +// filter can be based on a key name prefix, object tags, or a combination of both. // -// * Status whether the rule is in -// effect. +// - Status whether the rule is in effect. // -// * One or more lifecycle transition and expiration actions that you want -// Amazon S3 to perform on the objects identified by the filter. If the state of -// your bucket is versioning-enabled or versioning-suspended, you can have many -// versions of the same object (one current version and zero or more noncurrent -// versions). Amazon S3 provides predefined actions that you can specify for -// current and noncurrent object versions. +// - One or more lifecycle transition and expiration actions that you want +// Amazon S3 to perform on the objects identified by the filter. If the state of +// your bucket is versioning-enabled or versioning-suspended, you can have many +// versions of the same object (one current version and zero or more noncurrent +// versions). Amazon S3 provides predefined actions that you can specify for +// current and noncurrent object versions. // -// For more information, see Object -// Lifecycle Management -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) and -// Lifecycle Configuration Elements -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html). -// Permissions By default, all Amazon S3 resources are private, including buckets, -// objects, and related subresources (for example, lifecycle configuration and -// website configuration). Only the resource owner (that is, the Amazon Web +// For more information, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// and Lifecycle Configuration Elements (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html) +// . Permissions By default, all Amazon S3 resources are private, including +// buckets, objects, and related subresources (for example, lifecycle configuration +// and website configuration). Only the resource owner (that is, the Amazon Web // Services account that created it) can access the resource. The resource owner // can optionally grant access permissions to others by writing an access policy. -// For this operation, a user must get the s3:PutLifecycleConfiguration permission. -// You can also explicitly deny permissions. Explicit deny also supersedes any -// other permissions. If you want to block users or accounts from removing or -// deleting objects from your bucket, you must deny them permissions for the -// following actions: +// For this operation, a user must get the s3:PutLifecycleConfiguration +// permission. You can also explicitly deny permissions. Explicit deny also +// supersedes any other permissions. If you want to block users or accounts from +// removing or deleting objects from your bucket, you must deny them permissions +// for the following actions: +// - s3:DeleteObject +// - s3:DeleteObjectVersion +// - s3:PutLifecycleConfiguration // -// * s3:DeleteObject -// -// * s3:DeleteObjectVersion -// -// * -// s3:PutLifecycleConfiguration -// -// For more information about permissions, see -// Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// The following are related to PutBucketLifecycleConfiguration: -// -// * Examples of -// Lifecycle Configuration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) -// -// * -// DeleteBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) +// For more information about permissions, see Managing Access Permissions to Your +// Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . The following are related to PutBucketLifecycleConfiguration : +// - Examples of Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) +// - DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*PutBucketLifecycleConfigurationOutput, error) { if params == nil { params = &PutBucketLifecycleConfigurationInput{} @@ -110,9 +89,8 @@ type PutBucketLifecycleConfigurationInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/s3/api_op_PutBucketLogging.go b/service/s3/api_op_PutBucketLogging.go index 0f3ea6d33c2..39b1eee2d59 100644 --- a/service/s3/api_op_PutBucketLogging.go +++ b/service/s3/api_op_PutBucketLogging.go @@ -23,49 +23,29 @@ import ( // the bucket owner enforced setting for S3 Object Ownership, you can't use the // Grantee request element to grant access to others. Permissions can only be // granted using policies. For more information, see Permissions for server access -// log delivery -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) +// log delivery (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) // in the Amazon S3 User Guide. Grantee Values You can specify the person (grantee) // to whom you're assigning access rights (using request elements) in the following // ways: +// - By the person's ID: <>ID<><>GranteesEmail<> DisplayName is optional and +// ignored in the request. +// - By Email address: <>Grantees@email.com<> The grantee is resolved to the +// CanonicalUser and, in a response to a GET Object acl request, appears as the +// CanonicalUser. +// - By URI: <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> // -// * By the person's ID: <>ID<><>GranteesEmail<> DisplayName is optional -// and ignored in the request. -// -// * By Email address: <>Grantees@email.com<> The -// grantee is resolved to the CanonicalUser and, in a response to a GET Object acl -// request, appears as the CanonicalUser. -// -// * By URI: -// <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> -// -// To enable -// logging, you use LoggingEnabled and its children request elements. To disable -// logging, you use an empty BucketLoggingStatus request element: For more -// information about server access logging, see Server Access Logging -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html) in the -// Amazon S3 User Guide. For more information about creating a bucket, see -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). For -// more information about returning the logging status of a bucket, see -// GetBucketLogging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html). The -// following operations are related to PutBucketLogging: -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// GetBucketLogging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html) +// To enable logging, you use LoggingEnabled and its children request elements. To +// disable logging, you use an empty BucketLoggingStatus request element: For more +// information about server access logging, see Server Access Logging (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html) +// in the Amazon S3 User Guide. For more information about creating a bucket, see +// CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// . For more information about returning the logging status of a bucket, see +// GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html) +// . The following operations are related to PutBucketLogging : +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html) func (c *Client) PutBucketLogging(ctx context.Context, params *PutBucketLoggingInput, optFns ...func(*Options)) (*PutBucketLoggingOutput, error) { if params == nil { params = &PutBucketLoggingInput{} @@ -97,9 +77,8 @@ type PutBucketLoggingInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/s3/api_op_PutBucketMetricsConfiguration.go b/service/s3/api_op_PutBucketMetricsConfiguration.go index 4b989185aff..ed5603b8dca 100644 --- a/service/s3/api_op_PutBucketMetricsConfiguration.go +++ b/service/s3/api_op_PutBucketMetricsConfiguration.go @@ -12,45 +12,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets a metrics configuration (specified by the metrics configuration ID) for the -// bucket. You can have up to 1,000 metrics configurations per bucket. If you're -// updating an existing metrics configuration, note that this is a full replacement -// of the existing metrics configuration. If you don't include the elements you -// want to keep, they are erased. To use this operation, you must have permissions -// to perform the s3:PutMetricsConfiguration action. The bucket owner has this -// permission by default. The bucket owner can grant this permission to others. For -// more information about permissions, see Permissions Related to Bucket -// Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// For information about CloudWatch request metrics for Amazon S3, see Monitoring -// Metrics with Amazon CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). -// The following operations are related to PutBucketMetricsConfiguration: +// Sets a metrics configuration (specified by the metrics configuration ID) for +// the bucket. You can have up to 1,000 metrics configurations per bucket. If +// you're updating an existing metrics configuration, note that this is a full +// replacement of the existing metrics configuration. If you don't include the +// elements you want to keep, they are erased. To use this operation, you must have +// permissions to perform the s3:PutMetricsConfiguration action. The bucket owner +// has this permission by default. The bucket owner can grant this permission to +// others. For more information about permissions, see Permissions Related to +// Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . For information about CloudWatch request metrics for Amazon S3, see +// Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) +// . The following operations are related to PutBucketMetricsConfiguration : +// - DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) +// - GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) +// - ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) // -// * -// DeleteBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) -// -// * -// GetBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) -// -// * -// ListBucketMetricsConfigurations -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) -// -// GetBucketLifecycle -// has the following special error: -// -// * Error code: TooManyConfigurations -// -// * -// Description: You are attempting to create a new configuration but have already -// reached the 1,000-configuration limit. -// -// * HTTP Status Code: HTTP 400 Bad Request +// GetBucketLifecycle has the following special error: +// - Error code: TooManyConfigurations +// - Description: You are attempting to create a new configuration but have +// already reached the 1,000-configuration limit. +// - HTTP Status Code: HTTP 400 Bad Request func (c *Client) PutBucketMetricsConfiguration(ctx context.Context, params *PutBucketMetricsConfigurationInput, optFns ...func(*Options)) (*PutBucketMetricsConfigurationOutput, error) { if params == nil { params = &PutBucketMetricsConfigurationInput{} diff --git a/service/s3/api_op_PutBucketNotificationConfiguration.go b/service/s3/api_op_PutBucketNotificationConfiguration.go index 8e771d6bc95..140eb69e861 100644 --- a/service/s3/api_op_PutBucketNotificationConfiguration.go +++ b/service/s3/api_op_PutBucketNotificationConfiguration.go @@ -13,30 +13,27 @@ import ( ) // Enables notifications of specified events for a bucket. For more information -// about event notifications, see Configuring Event Notifications -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). Using -// this API, you can replace an existing notification configuration. The +// about event notifications, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) +// . Using this API, you can replace an existing notification configuration. The // configuration is an XML file that defines the event types that you want Amazon // S3 to publish and the destination where you want Amazon S3 to publish an event // notification when it detects an event of the specified type. By default, your // bucket has no event notifications configured. That is, the notification -// configuration will be an empty NotificationConfiguration. This action replaces -// the existing notification configuration with the configuration you include in -// the request body. After Amazon S3 receives this request, it first verifies that -// any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue -// Service (Amazon SQS) destination exists, and that the bucket owner has -// permission to publish to it by sending a test notification. In the case of +// configuration will be an empty NotificationConfiguration . This action +// replaces the existing notification configuration with the configuration you +// include in the request body. After Amazon S3 receives this request, it first +// verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon +// Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner +// has permission to publish to it by sending a test notification. In the case of // Lambda destinations, Amazon S3 verifies that the Lambda function permissions // grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For -// more information, see Configuring Notifications for Amazon S3 Events -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). You -// can disable notifications by adding the empty NotificationConfiguration element. -// For more information about the number of event notification configurations that -// you can create per bucket, see Amazon S3 service quotas -// (https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3) in Amazon Web -// Services General Reference. By default, only the bucket owner can configure -// notifications on a bucket. However, bucket owners can use a bucket policy to -// grant permission to other users to set this configuration with +// more information, see Configuring Notifications for Amazon S3 Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) +// . You can disable notifications by adding the empty NotificationConfiguration +// element. For more information about the number of event notification +// configurations that you can create per bucket, see Amazon S3 service quotas (https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3) +// in Amazon Web Services General Reference. By default, only the bucket owner can +// configure notifications on a bucket. However, bucket owners can use a bucket +// policy to grant permission to other users to set this configuration with // s3:PutBucketNotification permission. The PUT notification is an atomic // operation. For example, suppose your notification configuration includes SNS // topic, SQS queue, and Lambda function configurations. When you send a PUT @@ -47,10 +44,8 @@ import ( // s3:ReducedRedundancyLostObject event type, the response will also include the // x-amz-sns-test-message-id header containing the message ID of the test // notification sent to the topic. The following action is related to -// PutBucketNotificationConfiguration: -// -// * GetBucketNotificationConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) +// PutBucketNotificationConfiguration : +// - GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) func (c *Client) PutBucketNotificationConfiguration(ctx context.Context, params *PutBucketNotificationConfigurationInput, optFns ...func(*Options)) (*PutBucketNotificationConfigurationOutput, error) { if params == nil { params = &PutBucketNotificationConfigurationInput{} @@ -73,8 +68,8 @@ type PutBucketNotificationConfigurationInput struct { // This member is required. Bucket *string - // A container for specifying the notification configuration of the bucket. If this - // element is empty, notifications are turned off for the bucket. + // A container for specifying the notification configuration of the bucket. If + // this element is empty, notifications are turned off for the bucket. // // This member is required. NotificationConfiguration *types.NotificationConfiguration diff --git a/service/s3/api_op_PutBucketOwnershipControls.go b/service/s3/api_op_PutBucketOwnershipControls.go index 83210cac46b..0666c67ea28 100644 --- a/service/s3/api_op_PutBucketOwnershipControls.go +++ b/service/s3/api_op_PutBucketOwnershipControls.go @@ -15,16 +15,11 @@ import ( // Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this // operation, you must have the s3:PutBucketOwnershipControls permission. For more -// information about Amazon S3 permissions, see Specifying permissions in a policy -// (https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html). -// For information about Amazon S3 Object Ownership, see Using object ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html). -// The following operations are related to PutBucketOwnershipControls: -// -// * -// GetBucketOwnershipControls -// -// * DeleteBucketOwnershipControls +// information about Amazon S3 permissions, see Specifying permissions in a policy (https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html) +// . For information about Amazon S3 Object Ownership, see Using object ownership (https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html) +// . The following operations are related to PutBucketOwnershipControls : +// - GetBucketOwnershipControls +// - DeleteBucketOwnershipControls func (c *Client) PutBucketOwnershipControls(ctx context.Context, params *PutBucketOwnershipControlsInput, optFns ...func(*Options)) (*PutBucketOwnershipControlsOutput, error) { if params == nil { params = &PutBucketOwnershipControlsInput{} @@ -170,9 +165,9 @@ func addPutBucketOwnershipControlsInputChecksumMiddlewares(stack *middleware.Sta }) } -// getPutBucketOwnershipControlsBucketMember returns a pointer to string denoting a -// provided bucket member valueand a boolean indicating if the input has a modeled -// bucket name, +// getPutBucketOwnershipControlsBucketMember returns a pointer to string denoting +// a provided bucket member valueand a boolean indicating if the input has a +// modeled bucket name, func getPutBucketOwnershipControlsBucketMember(input interface{}) (*string, bool) { in := input.(*PutBucketOwnershipControlsInput) if in.Bucket == nil { diff --git a/service/s3/api_op_PutBucketPolicy.go b/service/s3/api_op_PutBucketPolicy.go index 8860d3b560d..e92dcb7d380 100644 --- a/service/s3/api_op_PutBucketPolicy.go +++ b/service/s3/api_op_PutBucketPolicy.go @@ -17,22 +17,16 @@ import ( // identity other than the root user of the Amazon Web Services account that owns // the bucket, the calling identity must have the PutBucketPolicy permissions on // the specified bucket and belong to the bucket owner's account in order to use -// this operation. If you don't have PutBucketPolicy permissions, Amazon S3 returns -// a 403 Access Denied error. If you have the correct permissions, but you're not -// using an identity that belongs to the bucket owner's account, Amazon S3 returns -// a 405 Method Not Allowed error. As a security precaution, the root user of the -// Amazon Web Services account that owns a bucket can always use this operation, -// even if the policy explicitly denies the root user the ability to perform this -// action. For more information, see Bucket policy examples -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html). -// The following operations are related to PutBucketPolicy: -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// this operation. If you don't have PutBucketPolicy permissions, Amazon S3 +// returns a 403 Access Denied error. If you have the correct permissions, but +// you're not using an identity that belongs to the bucket owner's account, Amazon +// S3 returns a 405 Method Not Allowed error. As a security precaution, the root +// user of the Amazon Web Services account that owns a bucket can always use this +// operation, even if the policy explicitly denies the root user the ability to +// perform this action. For more information, see Bucket policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) +// . The following operations are related to PutBucketPolicy : +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error) { if params == nil { params = &PutBucketPolicyInput{} @@ -64,9 +58,8 @@ type PutBucketPolicyInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/s3/api_op_PutBucketReplication.go b/service/s3/api_op_PutBucketReplication.go index 2213373f30b..5be9f9e1d40 100644 --- a/service/s3/api_op_PutBucketReplication.go +++ b/service/s3/api_op_PutBucketReplication.go @@ -14,57 +14,44 @@ import ( ) // Creates a replication configuration or replaces an existing one. For more -// information, see Replication -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon -// S3 User Guide. Specify the replication configuration in the request body. In the -// replication configuration, you provide the name of the destination bucket or -// buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon -// S3 can assume to replicate objects on your behalf, and other relevant -// information. A replication configuration must include at least one rule, and can -// contain a maximum of 1,000. Each rule identifies a subset of objects to -// replicate by filtering the objects in the source bucket. To choose additional -// subsets of objects to replicate, add a rule for each subset. To specify a subset -// of the objects in the source bucket to apply a replication rule to, add the -// Filter element as a child of the Rule element. You can filter objects based on -// an object key prefix, one or more object tags, or both. When you add the Filter -// element in the configuration, you must also add the following elements: -// DeleteMarkerReplication, Status, and Priority. If you are using an earlier -// version of the replication configuration, Amazon S3 handles replication of -// delete markers differently. For more information, see Backward Compatibility -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). -// For information about enabling versioning on a bucket, see Using Versioning -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). Handling -// Replication of Encrypted Objects By default, Amazon S3 doesn't replicate objects -// that are stored at rest using server-side encryption with KMS keys. To replicate -// Amazon Web Services KMS-encrypted objects, add the following: -// SourceSelectionCriteria, SseKmsEncryptedObjects, Status, -// EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication -// configuration, see Replicating Objects Created with SSE Using KMS keys -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html). -// For information on PutBucketReplication errors, see List of replication-related -// error codes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) +// information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) +// in the Amazon S3 User Guide. Specify the replication configuration in the +// request body. In the replication configuration, you provide the name of the +// destination bucket or buckets where you want Amazon S3 to replicate objects, the +// IAM role that Amazon S3 can assume to replicate objects on your behalf, and +// other relevant information. A replication configuration must include at least +// one rule, and can contain a maximum of 1,000. Each rule identifies a subset of +// objects to replicate by filtering the objects in the source bucket. To choose +// additional subsets of objects to replicate, add a rule for each subset. To +// specify a subset of the objects in the source bucket to apply a replication rule +// to, add the Filter element as a child of the Rule element. You can filter +// objects based on an object key prefix, one or more object tags, or both. When +// you add the Filter element in the configuration, you must also add the following +// elements: DeleteMarkerReplication , Status , and Priority . If you are using an +// earlier version of the replication configuration, Amazon S3 handles replication +// of delete markers differently. For more information, see Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations) +// . For information about enabling versioning on a bucket, see Using Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) +// . Handling Replication of Encrypted Objects By default, Amazon S3 doesn't +// replicate objects that are stored at rest using server-side encryption with KMS +// keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: +// SourceSelectionCriteria , SseKmsEncryptedObjects , Status , +// EncryptionConfiguration , and ReplicaKmsKeyID . For information about +// replication configuration, see Replicating Objects Created with SSE Using KMS +// keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html) +// . For information on PutBucketReplication errors, see List of +// replication-related error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) // Permissions To create a PutBucketReplication request, you must have // s3:PutReplicationConfiguration permissions for the bucket. By default, a // resource owner, in this case the Amazon Web Services account that created the // bucket, can perform this operation. The resource owner can also grant others // permissions to perform the operation. For more information about permissions, -// see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) and -// Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// To perform this operation, the user or role performing the action must have the -// iam:PassRole -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) -// permission. The following operations are related to PutBucketReplication: -// -// * -// GetBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) -// -// * -// DeleteBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) +// see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . To perform this operation, the user or role performing the action must have +// the iam:PassRole (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) +// permission. The following operations are related to PutBucketReplication : +// - GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) +// - DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) func (c *Client) PutBucketReplication(ctx context.Context, params *PutBucketReplicationInput, optFns ...func(*Options)) (*PutBucketReplicationOutput, error) { if params == nil { params = &PutBucketReplicationInput{} @@ -97,19 +84,17 @@ type PutBucketReplicationInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, see RFC 1864 (http://www.ietf.org/rfc/rfc1864.txt) + // . For requests made using the Amazon Web Services Command Line Interface (CLI) + // or Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a diff --git a/service/s3/api_op_PutBucketRequestPayment.go b/service/s3/api_op_PutBucketRequestPayment.go index c89d97becee..48ba5d089b4 100644 --- a/service/s3/api_op_PutBucketRequestPayment.go +++ b/service/s3/api_op_PutBucketRequestPayment.go @@ -16,16 +16,10 @@ import ( // Sets the request payment configuration for a bucket. By default, the bucket // owner pays for downloads from the bucket. This configuration parameter enables // the bucket owner (only) to specify that the person requesting the download will -// be charged for the download. For more information, see Requester Pays Buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The -// following operations are related to PutBucketRequestPayment: -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// GetBucketRequestPayment -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html) +// be charged for the download. For more information, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) +// . The following operations are related to PutBucketRequestPayment : +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - GetBucketRequestPayment (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html) func (c *Client) PutBucketRequestPayment(ctx context.Context, params *PutBucketRequestPaymentInput, optFns ...func(*Options)) (*PutBucketRequestPaymentOutput, error) { if params == nil { params = &PutBucketRequestPaymentInput{} @@ -57,19 +51,17 @@ type PutBucketRequestPaymentInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, see RFC 1864 (http://www.ietf.org/rfc/rfc1864.txt) + // . For requests made using the Amazon Web Services Command Line Interface (CLI) + // or Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a diff --git a/service/s3/api_op_PutBucketTagging.go b/service/s3/api_op_PutBucketTagging.go index f410107737c..f7f881ae6cd 100644 --- a/service/s3/api_op_PutBucketTagging.go +++ b/service/s3/api_op_PutBucketTagging.go @@ -20,57 +20,34 @@ import ( // with the same tag key values. For example, you can tag several resources with a // specific application name, and then organize your billing information to see the // total cost of that application across several services. For more information, -// see Cost Allocation and Tagging -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) -// and Using Cost Allocation in Amazon S3 Bucket Tags -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html). When -// this operation sets the tags for a bucket, it will overwrite any current tags -// the bucket already has. You cannot use this operation to add tags to an existing -// list of tags. To use this operation, you must have permissions to perform the -// s3:PutBucketTagging action. The bucket owner has this permission by default and -// can grant this permission to others. For more information about permissions, see -// Permissions Related to Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// PutBucketTagging has the following special errors: +// see Cost Allocation and Tagging (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// and Using Cost Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html) +// . When this operation sets the tags for a bucket, it will overwrite any current +// tags the bucket already has. You cannot use this operation to add tags to an +// existing list of tags. To use this operation, you must have permissions to +// perform the s3:PutBucketTagging action. The bucket owner has this permission by +// default and can grant this permission to others. For more information about +// permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . PutBucketTagging has the following special errors: +// - Error code: InvalidTagError +// - Description: The tag provided was not a valid tag. This error can occur if +// the tag did not pass input validation. For information about tag restrictions, +// see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// and Amazon Web Services-Generated Cost Allocation Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html) +// . +// - Error code: MalformedXMLError +// - Description: The XML provided does not match the schema. +// - Error code: OperationAbortedError +// - Description: A conflicting conditional action is currently in progress +// against this resource. Please try again. +// - Error code: InternalError +// - Description: The service was unable to apply the provided tag to the +// bucket. // -// * Error code: -// InvalidTagError -// -// * Description: The tag provided was not a valid tag. This error -// can occur if the tag did not pass input validation. For information about tag -// restrictions, see User-Defined Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) -// and Amazon Web Services-Generated Cost Allocation Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html). -// -// * -// Error code: MalformedXMLError -// -// * Description: The XML provided does not match -// the schema. -// -// * Error code: OperationAbortedError -// -// * Description: A conflicting -// conditional action is currently in progress against this resource. Please try -// again. -// -// * Error code: InternalError -// -// * Description: The service was unable to -// apply the provided tag to the bucket. -// -// The following operations are related to -// PutBucketTagging: -// -// * GetBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) -// -// * -// DeleteBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) +// The following operations are related to PutBucketTagging : +// - GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) +// - DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error) { if params == nil { params = &PutBucketTaggingInput{} @@ -102,19 +79,17 @@ type PutBucketTaggingInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, see RFC 1864 (http://www.ietf.org/rfc/rfc1864.txt) + // . For requests made using the Amazon Web Services Command Line Interface (CLI) + // or Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a diff --git a/service/s3/api_op_PutBucketVersioning.go b/service/s3/api_op_PutBucketVersioning.go index 6d7943e6f66..8306b172ed2 100644 --- a/service/s3/api_op_PutBucketVersioning.go +++ b/service/s3/api_op_PutBucketVersioning.go @@ -18,32 +18,22 @@ import ( // objects in the bucket. All objects added to the bucket receive a unique version // ID. Suspended—Disables versioning for the objects in the bucket. All objects // added to the bucket receive the version ID null. If the versioning state has -// never been set on a bucket, it has no versioning state; a GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// never been set on a bucket, it has no versioning state; a GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) // request does not return a versioning state value. In order to enable MFA Delete, // you must be the bucket owner. If you are the bucket owner and want to enable MFA // Delete in the bucket versioning configuration, you must include the x-amz-mfa -// request header and the Status and the MfaDelete request elements in a request to -// set the versioning state of the bucket. If you have an object expiration +// request header and the Status and the MfaDelete request elements in a request +// to set the versioning state of the bucket. If you have an object expiration // lifecycle policy in your non-versioned bucket and you want to maintain the same // permanent delete behavior when you enable versioning, you must add a noncurrent // expiration policy. The noncurrent expiration lifecycle policy will manage the // deletes of the noncurrent object versions in the version-enabled bucket. (A // version-enabled bucket maintains one current and zero or more noncurrent object -// versions.) For more information, see Lifecycle and Versioning -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config). -// Related Resources -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) -// -// * -// GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// versions.) For more information, see Lifecycle and Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config) +// . Related Resources +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// - GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) func (c *Client) PutBucketVersioning(ctx context.Context, params *PutBucketVersioningInput, optFns ...func(*Options)) (*PutBucketVersioningOutput, error) { if params == nil { params = &PutBucketVersioningInput{} @@ -75,19 +65,17 @@ type PutBucketVersioningInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm // >The base64-encoded 128-bit MD5 digest of the data. You must use this header as // a message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // transit. For more information, see RFC 1864 (http://www.ietf.org/rfc/rfc1864.txt) + // . For requests made using the Amazon Web Services Command Line Interface (CLI) + // or Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a @@ -95,8 +83,8 @@ type PutBucketVersioningInput struct { // (access denied). ExpectedBucketOwner *string - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. + // The concatenation of the authentication device's serial number, a space, and + // the value that is displayed on your authentication device. MFA *string noSmithyDocumentSerde @@ -196,8 +184,8 @@ func newServiceMetadataMiddleware_opPutBucketVersioning(region string) *awsmiddl } } -// getPutBucketVersioningRequestAlgorithmMember gets the request checksum algorithm -// value provided as input. +// getPutBucketVersioningRequestAlgorithmMember gets the request checksum +// algorithm value provided as input. func getPutBucketVersioningRequestAlgorithmMember(input interface{}) (string, bool) { in := input.(*PutBucketVersioningInput) if len(in.ChecksumAlgorithm) == 0 { diff --git a/service/s3/api_op_PutBucketWebsite.go b/service/s3/api_op_PutBucketWebsite.go index 11cb4a35593..70ac7d22c07 100644 --- a/service/s3/api_op_PutBucketWebsite.go +++ b/service/s3/api_op_PutBucketWebsite.go @@ -17,73 +17,45 @@ import ( // subresource. To configure a bucket as a website, you can add this subresource on // the bucket with website configuration information such as the file name of the // index document and any redirect rules. For more information, see Hosting -// Websites on Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This PUT -// action requires the S3:PutBucketWebsite permission. By default, only the bucket -// owner can configure the website attached to a bucket; however, bucket owners can -// allow other users to set the website configuration by writing a bucket policy -// that grants them the S3:PutBucketWebsite permission. To redirect all website -// requests sent to the bucket's website endpoint, you add a website configuration -// with the following elements. Because all requests are sent to another website, -// you don't need to provide index document name for the bucket. -// -// * -// WebsiteConfiguration -// -// * RedirectAllRequestsTo -// -// * HostName -// -// * Protocol -// -// If you -// want granular control over redirects, you can use the following elements to add -// routing rules that describe conditions for redirecting requests and information -// about the redirect destination. In this case, the website configuration must -// provide an index document for the bucket, because some requests might not be -// redirected. -// -// * WebsiteConfiguration -// -// * IndexDocument -// -// * Suffix -// -// * -// ErrorDocument -// -// * Key -// -// * RoutingRules -// -// * RoutingRule -// -// * Condition -// -// * -// HttpErrorCodeReturnedEquals -// -// * KeyPrefixEquals -// -// * Redirect -// -// * Protocol -// -// * -// HostName -// -// * ReplaceKeyPrefixWith -// -// * ReplaceKeyWith -// -// * HttpRedirectCode -// -// Amazon -// S3 has a limitation of 50 routing rules per website configuration. If you -// require more than 50 routing rules, you can use object redirect. For more -// information, see Configuring an Object Redirect -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in -// the Amazon S3 User Guide. +// Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) +// . This PUT action requires the S3:PutBucketWebsite permission. By default, only +// the bucket owner can configure the website attached to a bucket; however, bucket +// owners can allow other users to set the website configuration by writing a +// bucket policy that grants them the S3:PutBucketWebsite permission. To redirect +// all website requests sent to the bucket's website endpoint, you add a website +// configuration with the following elements. Because all requests are sent to +// another website, you don't need to provide index document name for the bucket. +// - WebsiteConfiguration +// - RedirectAllRequestsTo +// - HostName +// - Protocol +// +// If you want granular control over redirects, you can use the following elements +// to add routing rules that describe conditions for redirecting requests and +// information about the redirect destination. In this case, the website +// configuration must provide an index document for the bucket, because some +// requests might not be redirected. +// - WebsiteConfiguration +// - IndexDocument +// - Suffix +// - ErrorDocument +// - Key +// - RoutingRules +// - RoutingRule +// - Condition +// - HttpErrorCodeReturnedEquals +// - KeyPrefixEquals +// - Redirect +// - Protocol +// - HostName +// - ReplaceKeyPrefixWith +// - ReplaceKeyWith +// - HttpRedirectCode +// +// Amazon S3 has a limitation of 50 routing rules per website configuration. If +// you require more than 50 routing rules, you can use object redirect. For more +// information, see Configuring an Object Redirect (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) +// in the Amazon S3 User Guide. func (c *Client) PutBucketWebsite(ctx context.Context, params *PutBucketWebsiteInput, optFns ...func(*Options)) (*PutBucketWebsiteOutput, error) { if params == nil { params = &PutBucketWebsiteInput{} @@ -115,19 +87,17 @@ type PutBucketWebsiteInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. You must use this header as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, see RFC 1864 - // (http://www.ietf.org/rfc/rfc1864.txt). For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. You must use this header as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, see RFC 1864 (http://www.ietf.org/rfc/rfc1864.txt) + // . For requests made using the Amazon Web Services Command Line Interface (CLI) + // or Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a diff --git a/service/s3/api_op_PutObject.go b/service/s3/api_op_PutObject.go index ff037df7515..a59d1b22b1c 100644 --- a/service/s3/api_op_PutObject.go +++ b/service/s3/api_op_PutObject.go @@ -24,86 +24,64 @@ import ( // values. Amazon S3 is a distributed system. If it receives multiple write // requests for the same object simultaneously, it overwrites all but the last // object written. To prevent objects from being deleted or overwritten, you can -// use Amazon S3 Object Lock -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html). To -// ensure that data is not corrupted traversing the network, use the Content-MD5 -// header. When you use this header, Amazon S3 checks the object against the -// provided MD5 value and, if they do not match, returns an error. Additionally, -// you can calculate the MD5 while putting an object to Amazon S3 and compare the -// returned ETag to the calculated MD5 value. +// use Amazon S3 Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html) +// . To ensure that data is not corrupted traversing the network, use the +// Content-MD5 header. When you use this header, Amazon S3 checks the object +// against the provided MD5 value and, if they do not match, returns an error. +// Additionally, you can calculate the MD5 while putting an object to Amazon S3 and +// compare the returned ETag to the calculated MD5 value. +// - To successfully complete the PutObject request, you must have the +// s3:PutObject in your IAM permissions. +// - To successfully change the objects acl of your PutObject request, you must +// have the s3:PutObjectAcl in your IAM permissions. +// - To successfully set the tag-set with your PutObject request, you must have +// the s3:PutObjectTagging in your IAM permissions. +// - The Content-MD5 header is required for any request to upload an object with +// a retention period configured using Amazon S3 Object Lock. For more information +// about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) +// in the Amazon S3 User Guide. // -// * To successfully complete the -// PutObject request, you must have the s3:PutObject in your IAM permissions. -// -// * To -// successfully change the objects acl of your PutObject request, you must have the -// s3:PutObjectAcl in your IAM permissions. -// -// * To successfully set the tag-set with -// your PutObject request, you must have the s3:PutObjectTagging in your IAM -// permissions. -// -// * The Content-MD5 header is required for any request to upload an -// object with a retention period configured using Amazon S3 Object Lock. For more -// information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in -// the Amazon S3 User Guide. -// -// You have three mutually exclusive options to protect -// data using server-side encryption in Amazon S3, depending on how you choose to -// manage the encryption keys. Specifically, the encryption key options are Amazon -// S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and -// customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side -// encryption by using Amazon S3 managed keys (SSE-S3) by default. You can -// optionally tell Amazon S3 to encrypt data at by rest using server-side -// encryption with other key options. For more information, see Using Server-Side -// Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html). -// When adding a new object, you can use headers to grant ACL-based permissions to -// individual Amazon Web Services accounts or to predefined groups defined by +// You have three mutually exclusive options to protect data using server-side +// encryption in Amazon S3, depending on how you choose to manage the encryption +// keys. Specifically, the encryption key options are Amazon S3 managed keys +// (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and customer-provided keys +// (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 +// managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt +// data at by rest using server-side encryption with other key options. For more +// information, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) +// . When adding a new object, you can use headers to grant ACL-based permissions +// to individual Amazon Web Services accounts or to predefined groups defined by // Amazon S3. These permissions are then added to the ACL on the object. By // default, all objects are private. Only the owner has full access control. For -// more information, see Access Control List (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing -// ACLs Using the REST API -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). If -// the bucket that you're uploading objects to uses the bucket owner enforced +// more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html) +// . If the bucket that you're uploading objects to uses the bucket owner enforced // setting for S3 Object Ownership, ACLs are disabled and no longer affect // permissions. Buckets that use this setting only accept PUT requests that don't // specify an ACL or PUT requests that specify bucket owner full control ACLs, such // as the bucket-owner-full-control canned ACL or an equivalent form of this ACL // expressed in the XML format. PUT requests that contain other ACLs (for example, // custom grants to certain Amazon Web Services accounts) fail and return a 400 -// error with the error code AccessControlListNotSupported. For more information, -// see Controlling ownership of objects and disabling ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// error with the error code AccessControlListNotSupported . For more information, +// see Controlling ownership of objects and disabling ACLs (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced // setting for Object Ownership, all objects written to the bucket by any account // will be owned by the bucket owner. By default, Amazon S3 uses the STANDARD // Storage Class to store newly created objects. The STANDARD storage class // provides high durability and high availability. Depending on performance needs, // you can specify a different Storage Class. Amazon S3 on Outposts only uses the -// OUTPOSTS Storage Class. For more information, see Storage Classes -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in -// the Amazon S3 User Guide. If you enable versioning for a bucket, Amazon S3 +// OUTPOSTS Storage Class. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) +// in the Amazon S3 User Guide. If you enable versioning for a bucket, Amazon S3 // automatically generates a unique version ID for the object being stored. Amazon // S3 returns this ID in the response. When you enable versioning for a bucket, if // Amazon S3 receives multiple write requests for the same object simultaneously, // it stores all of the objects. For more information about versioning, see Adding -// Objects to Versioning Enabled Buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html). -// For information about returning the versioning state of a bucket, see -// GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html). -// For more information about related Amazon S3 APIs, see the following: -// -// * -// CopyObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// Objects to Versioning Enabled Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html) +// . For information about returning the versioning state of a bucket, see +// GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// . For more information about related Amazon S3 APIs, see the following: +// - CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error) { if params == nil { params = &PutObjectInput{} @@ -127,17 +105,15 @@ type PutObjectInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -147,9 +123,8 @@ type PutObjectInput struct { // This member is required. Key *string - // The canned ACL to apply to the object. For more information, see Canned ACL - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). - // This action is not supported by Amazon S3 on Outposts. + // The canned ACL to apply to the object. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) + // . This action is not supported by Amazon S3 on Outposts. ACL types.ObjectCannedACL // Object data. @@ -163,17 +138,16 @@ type PutObjectInput struct { BucketKeyEnabled bool // Can be used to specify caching behavior along the request/reply chain. For more - // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 - // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). + // information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) + // . CacheControl *string // Indicates the algorithm used to create the checksum for the object when using // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -181,45 +155,41 @@ type PutObjectInput struct { // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32C *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA1 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA256 *string // Specifies presentational information for the object. For more information, see - // https://www.rfc-editor.org/rfc/rfc6266#section-4 - // (https://www.rfc-editor.org/rfc/rfc6266#section-4). + // https://www.rfc-editor.org/rfc/rfc6266#section-4 (https://www.rfc-editor.org/rfc/rfc6266#section-4) + // . ContentDisposition *string // Specifies what content encodings have been applied to the object and thus what // decoding mechanisms must be applied to obtain the media-type referenced by the // Content-Type header field. For more information, see - // https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding - // (https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding). + // https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding (https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding) + // . ContentEncoding *string // The language the content is in. @@ -227,8 +197,8 @@ type PutObjectInput struct { // Size of the body in bytes. This parameter is useful when the size of the body // cannot be determined automatically. For more information, see - // https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length - // (https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length). + // https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length (https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length) + // . ContentLength int64 // The base64-encoded 128-bit MD5 digest of the message (without the headers) @@ -236,13 +206,13 @@ type PutObjectInput struct { // verify that the data is the same data that was originally sent. Although it is // optional, we recommend using the Content-MD5 mechanism as an end-to-end // integrity check. For more information about REST request authentication, see - // REST Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). + // REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) + // . ContentMD5 *string // A standard MIME type describing the format of the contents. For more - // information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type - // (https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type). + // information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type (https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type) + // . ContentType *string // The account ID of the expected bucket owner. If the bucket is owned by a @@ -251,8 +221,8 @@ type PutObjectInput struct { ExpectedBucketOwner *string // The date and time at which the object is no longer cacheable. For more - // information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3 - // (https://www.rfc-editor.org/rfc/rfc7234#section-5.3). + // information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3 (https://www.rfc-editor.org/rfc/rfc7234#section-5.3) + // . Expires *time.Time // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This @@ -263,8 +233,8 @@ type PutObjectInput struct { // supported by Amazon S3 on Outposts. GrantRead *string - // Allows grantee to read the object ACL. This action is not supported by Amazon S3 - // on Outposts. + // Allows grantee to read the object ACL. This action is not supported by Amazon + // S3 on Outposts. GrantReadACP *string // Allows grantee to write the ACL for the applicable object. This action is not @@ -275,8 +245,8 @@ type PutObjectInput struct { Metadata map[string]string // Specifies whether a legal hold will be applied to this object. For more - // information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + // information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) + // . ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus // The Object Lock mode that you want to apply to this object. @@ -289,8 +259,7 @@ type PutObjectInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -317,46 +286,43 @@ type PutObjectInput struct { // GetObject or CopyObject operations on this object. SSEKMSEncryptionContext *string - // If x-amz-server-side-encryption has a valid value of aws:kms, this header + // If x-amz-server-side-encryption has a valid value of aws:kms , this header // specifies the ID of the Amazon Web Services Key Management Service (Amazon Web // Services KMS) symmetric encryption customer managed key that was used for the - // object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide - // x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web + // object. If you specify x-amz-server-side-encryption:aws:kms , but do not provide + // x-amz-server-side-encryption-aws-kms-key-id , Amazon S3 uses the Amazon Web // Services managed key to protect the data. If the KMS key does not exist in the // same account issuing the command, you must use the full ARN and not just the ID. SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // By default, Amazon S3 uses the STANDARD Storage Class to store newly created // objects. The STANDARD storage class provides high durability and high // availability. Depending on performance needs, you can specify a different // Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For - // more information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in - // the Amazon S3 User Guide. + // more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // in the Amazon S3 User Guide. StorageClass types.StorageClass - // The tag-set for the object. The tag-set must be encoded as URL Query parameters. - // (For example, "Key1=Value1") + // The tag-set for the object. The tag-set must be encoded as URL Query + // parameters. (For example, "Key1=Value1") Tagging *string // If the bucket is configured as a website, redirects requests for this object to // another object in the same bucket or to an external URL. Amazon S3 stores the // value of this header in the object metadata. For information about object - // metadata, see Object Key and Metadata - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html). In the - // following example, the request header sets the redirect to an object + // metadata, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) + // . In the following example, the request header sets the redirect to an object // (anotherPage.html) in the same bucket: x-amz-website-redirect-location: // /anotherPage.html In the following example, the request header sets the object // redirect to another website: x-amz-website-redirect-location: // http://www.example.com/ For more information about website hosting in Amazon S3, - // see Hosting Websites on Amazon S3 - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) and How to - // Configure Website Page Redirects - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). + // see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) + // and How to Configure Website Page Redirects (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) + // . WebsiteRedirectLocation *string noSmithyDocumentSerde @@ -371,32 +337,28 @@ type PutObjectOutput struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -404,9 +366,8 @@ type PutObjectOutput struct { ETag *string // If the expiration is configured for the object (see - // PutBucketLifecycleConfiguration - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), - // the response includes this header. It includes the expiry-date and rule-id + // PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) + // ), the response includes this header. It includes the expiry-date and rule-id // key-value pairs that provide information about object expiration. The value of // the rule-id is URL-encoded. Expiration *string @@ -415,13 +376,14 @@ type PutObjectOutput struct { // request. RequestCharged types.RequestCharged - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the Amazon Web Services KMS Encryption Context to use for @@ -431,14 +393,14 @@ type PutObjectOutput struct { // for future GetObject or CopyObject operations on this object. SSEKMSEncryptionContext *string - // If x-amz-server-side-encryption is has a valid value of aws:kms, this header + // If x-amz-server-side-encryption is has a valid value of aws:kms , this header // specifies the ID of the Amazon Web Services Key Management Service (Amazon Web // Services KMS) symmetric encryption customer managed key that was used for the // object. SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Version of the object. diff --git a/service/s3/api_op_PutObjectAcl.go b/service/s3/api_op_PutObjectAcl.go index e93a34f63fa..7a5bf17c381 100644 --- a/service/s3/api_op_PutObjectAcl.go +++ b/service/s3/api_op_PutObjectAcl.go @@ -16,137 +16,83 @@ import ( // Uses the acl subresource to set the access control list (ACL) permissions for a // new or existing object in an S3 bucket. You must have WRITE_ACP permission to // set the ACL of an object. For more information, see What permissions can I -// grant? -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions) +// grant? (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions) // in the Amazon S3 User Guide. This action is not supported by Amazon S3 on // Outposts. Depending on your application needs, you can choose to set the ACL on // an object using either the request body or the headers. For example, if you have // an existing application that updates a bucket ACL using the request body, you -// can continue to use that approach. For more information, see Access Control List -// (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the -// Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for -// S3 Object Ownership, ACLs are disabled and no longer affect permissions. You -// must use policies to grant access to your bucket and the objects in it. Requests -// to set ACLs or update ACLs fail and return the AccessControlListNotSupported -// error code. Requests to read ACLs are still supported. For more information, see -// Controlling object ownership -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) +// can continue to use that approach. For more information, see Access Control +// List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced +// setting for S3 Object Ownership, ACLs are disabled and no longer affect +// permissions. You must use policies to grant access to your bucket and the +// objects in it. Requests to set ACLs or update ACLs fail and return the +// AccessControlListNotSupported error code. Requests to read ACLs are still +// supported. For more information, see Controlling object ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) // in the Amazon S3 User Guide. Access Permissions You can set access permissions // using one of the following methods: +// - Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a +// set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined +// set of grantees and permissions. Specify the canned ACL name as the value of +// x-amz-ac l. If you use this header, you cannot use other access +// control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) +// . +// - Specify access permissions explicitly with the x-amz-grant-read , +// x-amz-grant-read-acp , x-amz-grant-write-acp , and x-amz-grant-full-control +// headers. When using these headers, you specify explicit access permissions and +// grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the +// permission. If you use these ACL-specific headers, you cannot use x-amz-acl +// header to set a canned ACL. These parameters map to the set of permissions that +// Amazon S3 supports in an ACL. For more information, see Access Control List +// (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) +// . You specify each grantee as a type=value pair, where the type is one of the +// following: +// - id – if the value specified is the canonical user ID of an Amazon Web +// Services account +// - uri – if you are granting permissions to a predefined group +// - emailAddress – if the value specified is the email address of an Amazon Web +// Services account Using email addresses to specify a grantee is only supported in +// the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. For example, the following +// x-amz-grant-read header grants list objects permission to the two Amazon Web +// Services accounts identified by their email addresses. x-amz-grant-read: +// emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" // -// * Specify a canned ACL with the x-amz-acl -// request header. Amazon S3 supports a set of predefined ACLs, known as canned -// ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify -// the canned ACL name as the value of x-amz-acl. If you use this header, you -// cannot use other access control-specific headers in your request. For more -// information, see Canned ACL -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). +// You can use either a canned ACL or specify access permissions explicitly. You +// cannot do both. Grantee Values You can specify the person (grantee) to whom +// you're assigning access rights (using request elements) in the following ways: +// - By the person's ID: <>ID<><>GranteesEmail<> DisplayName is optional and +// ignored in the request. +// - By URI: <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> +// - By Email address: <>Grantees@email.com<>lt;/Grantee> The grantee is resolved +// to the CanonicalUser and, in a response to a GET Object acl request, appears as +// the CanonicalUser. Using email addresses to specify a grantee is only supported +// in the following Amazon Web Services Regions: +// - US East (N. Virginia) +// - US West (N. California) +// - US West (Oregon) +// - Asia Pacific (Singapore) +// - Asia Pacific (Sydney) +// - Asia Pacific (Tokyo) +// - Europe (Ireland) +// - South America (São Paulo) For a list of all the Amazon S3 supported Regions +// and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) +// in the Amazon Web Services General Reference. // -// * -// Specify access permissions explicitly with the x-amz-grant-read, -// x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control -// headers. When using these headers, you specify explicit access permissions and -// grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the -// permission. If you use these ACL-specific headers, you cannot use x-amz-acl -// header to set a canned ACL. These parameters map to the set of permissions that -// Amazon S3 supports in an ACL. For more information, see Access Control List -// (ACL) Overview -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify -// each grantee as a type=value pair, where the type is one of the following: -// -// * id -// – if the value specified is the canonical user ID of an Amazon Web Services -// account -// -// * uri – if you are granting permissions to a predefined group -// -// * -// emailAddress – if the value specified is the email address of an Amazon Web -// Services account Using email addresses to specify a grantee is only supported in -// the following Amazon Web Services Regions: -// -// * US East (N. Virginia) -// -// * US West -// (N. California) -// -// * US West (Oregon) -// -// * Asia Pacific (Singapore) -// -// * Asia Pacific -// (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe (Ireland) -// -// * South America (São -// Paulo) -// -// For a list of all the Amazon S3 supported Regions and endpoints, see -// Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// For example, the following -// x-amz-grant-read header grants list objects permission to the two Amazon Web -// Services accounts identified by their email addresses. x-amz-grant-read: -// emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" -// -// You can use either -// a canned ACL or specify access permissions explicitly. You cannot do both. -// Grantee Values You can specify the person (grantee) to whom you're assigning -// access rights (using request elements) in the following ways: -// -// * By the person's -// ID: <>ID<><>GranteesEmail<> DisplayName is optional and ignored in the -// request. -// -// * By URI: -// <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> -// -// * By Email -// address: <>Grantees@email.com<>lt;/Grantee> The grantee is resolved to the -// CanonicalUser and, in a response to a GET Object acl request, appears as the -// CanonicalUser. Using email addresses to specify a grantee is only supported in -// the following Amazon Web Services Regions: -// -// * US East (N. Virginia) -// -// * US West -// (N. California) -// -// * US West (Oregon) -// -// * Asia Pacific (Singapore) -// -// * Asia Pacific -// (Sydney) -// -// * Asia Pacific (Tokyo) -// -// * Europe (Ireland) -// -// * South America (São -// Paulo) -// -// For a list of all the Amazon S3 supported Regions and endpoints, see -// Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the -// Amazon Web Services General Reference. -// -// Versioning The ACL of an object is set -// at the object version level. By default, PUT sets the ACL of the current version -// of an object. To set the ACL of a different version, use the versionId -// subresource. Related Resources -// -// * CopyObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) -// -// * -// GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// Versioning The ACL of an object is set at the object version level. By default, +// PUT sets the ACL of the current version of an object. To set the ACL of a +// different version, use the versionId subresource. Related Resources +// - CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) func (c *Client) PutObjectAcl(ctx context.Context, params *PutObjectAclInput, optFns ...func(*Options)) (*PutObjectAclOutput, error) { if params == nil { params = &PutObjectAclInput{} @@ -170,8 +116,7 @@ type PutObjectAclInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -183,23 +128,21 @@ type PutObjectAclInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Key *string - // The canned ACL to apply to the object. For more information, see Canned ACL - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). + // The canned ACL to apply to the object. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) + // . ACL types.ObjectCannedACL // Contains the elements that set the ACL permissions for an object per grantee. @@ -209,19 +152,17 @@ type PutObjectAclInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm - // The base64-encoded 128-bit MD5 digest of the data. This header must be used as a - // message integrity check to verify that the request body was not corrupted in - // transit. For more information, go to RFC 1864.> - // (http://www.ietf.org/rfc/rfc1864.txt) For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The base64-encoded 128-bit MD5 digest of the data. This header must be used as + // a message integrity check to verify that the request body was not corrupted in + // transit. For more information, go to RFC 1864.> (http://www.ietf.org/rfc/rfc1864.txt) + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. ContentMD5 *string // The account ID of the expected bucket owner. If the bucket is owned by a @@ -237,8 +178,8 @@ type PutObjectAclInput struct { // by Amazon S3 on Outposts. GrantRead *string - // Allows grantee to read the bucket ACL. This action is not supported by Amazon S3 - // on Outposts. + // Allows grantee to read the bucket ACL. This action is not supported by Amazon + // S3 on Outposts. GrantReadACP *string // Allows grantee to create new objects in the bucket. For the bucket and object @@ -253,8 +194,7 @@ type PutObjectAclInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_PutObjectLegalHold.go b/service/s3/api_op_PutObjectLegalHold.go index b8004b59844..7f77f8a9308 100644 --- a/service/s3/api_op_PutObjectLegalHold.go +++ b/service/s3/api_op_PutObjectLegalHold.go @@ -14,9 +14,8 @@ import ( ) // Applies a legal hold configuration to the specified object. For more -// information, see Locking Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action -// is not supported by Amazon S3 on Outposts. +// information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) +// . This action is not supported by Amazon S3 on Outposts. func (c *Client) PutObjectLegalHold(ctx context.Context, params *PutObjectLegalHoldInput, optFns ...func(*Options)) (*PutObjectLegalHoldOutput, error) { if params == nil { params = &PutObjectLegalHoldInput{} @@ -40,8 +39,7 @@ type PutObjectLegalHoldInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -56,9 +54,8 @@ type PutObjectLegalHoldInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -80,8 +77,7 @@ type PutObjectLegalHoldInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_PutObjectLockConfiguration.go b/service/s3/api_op_PutObjectLockConfiguration.go index 9740967a754..e7ed138c758 100644 --- a/service/s3/api_op_PutObjectLockConfiguration.go +++ b/service/s3/api_op_PutObjectLockConfiguration.go @@ -15,19 +15,13 @@ import ( // Places an Object Lock configuration on the specified bucket. The rule specified // in the Object Lock configuration will be applied by default to every new object -// placed in the specified bucket. For more information, see Locking Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). -// -// * The -// DefaultRetention settings require both a mode and a period. -// -// * The -// DefaultRetention period can be either Days or Years but you must select one. You -// cannot specify Days and Years at the same time. -// -// * You can only enable Object -// Lock for new buckets. If you want to turn on Object Lock for an existing bucket, -// contact Amazon Web Services Support. +// placed in the specified bucket. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) +// . +// - The DefaultRetention settings require both a mode and a period. +// - The DefaultRetention period can be either Days or Years but you must select +// one. You cannot specify Days and Years at the same time. +// - You can only enable Object Lock for new buckets. If you want to turn on +// Object Lock for an existing bucket, contact Amazon Web Services Support. func (c *Client) PutObjectLockConfiguration(ctx context.Context, params *PutObjectLockConfigurationInput, optFns ...func(*Options)) (*PutObjectLockConfigurationOutput, error) { if params == nil { params = &PutObjectLockConfigurationInput{} @@ -54,9 +48,8 @@ type PutObjectLockConfigurationInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -77,8 +70,7 @@ type PutObjectLockConfigurationInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -207,9 +199,9 @@ func addPutObjectLockConfigurationInputChecksumMiddlewares(stack *middleware.Sta }) } -// getPutObjectLockConfigurationBucketMember returns a pointer to string denoting a -// provided bucket member valueand a boolean indicating if the input has a modeled -// bucket name, +// getPutObjectLockConfigurationBucketMember returns a pointer to string denoting +// a provided bucket member valueand a boolean indicating if the input has a +// modeled bucket name, func getPutObjectLockConfigurationBucketMember(input interface{}) (*string, bool) { in := input.(*PutObjectLockConfigurationInput) if in.Bucket == nil { diff --git a/service/s3/api_op_PutObjectRetention.go b/service/s3/api_op_PutObjectRetention.go index c4918f3cbca..8e3e6ceccad 100644 --- a/service/s3/api_op_PutObjectRetention.go +++ b/service/s3/api_op_PutObjectRetention.go @@ -13,13 +13,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Places an Object Retention configuration on an object. For more information, see -// Locking Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). Users or -// accounts require the s3:PutObjectRetention permission in order to place an -// Object Retention configuration on objects. Bypassing a Governance Retention -// configuration requires the s3:BypassGovernanceRetention permission. This action -// is not supported by Amazon S3 on Outposts. +// Places an Object Retention configuration on an object. For more information, +// see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) +// . Users or accounts require the s3:PutObjectRetention permission in order to +// place an Object Retention configuration on objects. Bypassing a Governance +// Retention configuration requires the s3:BypassGovernanceRetention permission. +// This action is not supported by Amazon S3 on Outposts. func (c *Client) PutObjectRetention(ctx context.Context, params *PutObjectRetentionInput, optFns ...func(*Options)) (*PutObjectRetentionOutput, error) { if params == nil { params = &PutObjectRetentionInput{} @@ -37,14 +36,13 @@ func (c *Client) PutObjectRetention(ctx context.Context, params *PutObjectRetent type PutObjectRetentionInput struct { - // The bucket name that contains the object you want to apply this Object Retention - // configuration to. When using this action with an access point, you must direct - // requests to the access point hostname. The access point hostname takes the form - // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this - // action with an access point through the Amazon Web Services SDKs, you provide - // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // The bucket name that contains the object you want to apply this Object + // Retention configuration to. When using this action with an access point, you + // must direct requests to the access point hostname. The access point hostname + // takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. + // When using this action with an access point through the Amazon Web Services + // SDKs, you provide the access point ARN in place of the bucket name. For more + // information about access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. // // This member is required. @@ -63,9 +61,8 @@ type PutObjectRetentionInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -83,8 +80,7 @@ type PutObjectRetentionInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_PutObjectTagging.go b/service/s3/api_op_PutObjectTagging.go index 6a638e676c6..5a671012f9f 100644 --- a/service/s3/api_op_PutObjectTagging.go +++ b/service/s3/api_op_PutObjectTagging.go @@ -13,56 +13,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the supplied tag-set to an object that already exists in a bucket. A tag is -// a key-value pair. You can associate tags with an object by sending a PUT request -// against the tagging subresource that is associated with the object. You can -// retrieve tags by sending a GET request. For more information, see -// GetObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). For -// tagging-related restrictions related to characters and encodings, see Tag -// Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html). -// Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To -// use this operation, you must have permission to perform the s3:PutObjectTagging -// action. By default, the bucket owner has this permission and can grant this -// permission to others. To put tags of any other version, use the versionId query -// parameter. You also need permission for the s3:PutObjectVersionTagging action. -// For information about the Amazon S3 object tagging feature, see Object Tagging -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). Special -// Errors +// Sets the supplied tag-set to an object that already exists in a bucket. A tag +// is a key-value pair. You can associate tags with an object by sending a PUT +// request against the tagging subresource that is associated with the object. You +// can retrieve tags by sending a GET request. For more information, see +// GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) +// . For tagging-related restrictions related to characters and encodings, see Tag +// Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// . Note that Amazon S3 limits the maximum number of tags to 10 tags per object. +// To use this operation, you must have permission to perform the +// s3:PutObjectTagging action. By default, the bucket owner has this permission and +// can grant this permission to others. To put tags of any other version, use the +// versionId query parameter. You also need permission for the +// s3:PutObjectVersionTagging action. For information about the Amazon S3 object +// tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html) +// . Special Errors +// - Code: InvalidTagError +// - Cause: The tag provided was not a valid tag. This error can occur if the +// tag did not pass input validation. For more information, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html) +// . +// - Code: MalformedXMLError +// - Cause: The XML provided does not match the schema. +// - Code: OperationAbortedError +// - Cause: A conflicting conditional action is currently in progress against +// this resource. Please try again. +// - Code: InternalError +// - Cause: The service was unable to apply the provided tag to the object. // -// * Code: InvalidTagError -// -// * Cause: The tag provided was not a valid tag. -// This error can occur if the tag did not pass input validation. For more -// information, see Object Tagging -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). -// -// * Code: -// MalformedXMLError -// -// * Cause: The XML provided does not match the schema. -// -// * Code: -// OperationAbortedError -// -// * Cause: A conflicting conditional action is currently in -// progress against this resource. Please try again. -// -// * Code: InternalError -// -// * -// Cause: The service was unable to apply the provided tag to the object. -// -// Related -// Resources -// -// * GetObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) -// -// * -// DeleteObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) +// Related Resources +// - GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) +// - DeleteObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) func (c *Client) PutObjectTagging(ctx context.Context, params *PutObjectTaggingInput, optFns ...func(*Options)) (*PutObjectTaggingOutput, error) { if params == nil { params = &PutObjectTaggingInput{} @@ -86,17 +66,15 @@ type PutObjectTaggingInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -115,9 +93,8 @@ type PutObjectTaggingInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -135,8 +112,7 @@ type PutObjectTaggingInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer diff --git a/service/s3/api_op_PutPublicAccessBlock.go b/service/s3/api_op_PutPublicAccessBlock.go index 922102b58a7..0dcee1560b6 100644 --- a/service/s3/api_op_PutPublicAccessBlock.go +++ b/service/s3/api_op_PutPublicAccessBlock.go @@ -13,35 +13,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. -// To use this operation, you must have the s3:PutBucketPublicAccessBlock +// Creates or modifies the PublicAccessBlock configuration for an Amazon S3 +// bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock // permission. For more information about Amazon S3 permissions, see Specifying -// Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). -// When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an -// object, it checks the PublicAccessBlock configuration for both the bucket (or -// the bucket that contains the object) and the bucket owner's account. If the +// Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// . When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or +// an object, it checks the PublicAccessBlock configuration for both the bucket +// (or the bucket that contains the object) and the bucket owner's account. If the // PublicAccessBlock configurations are different between the bucket and the // account, Amazon S3 uses the most restrictive combination of the bucket-level and // account-level settings. For more information about when Amazon S3 considers a -// bucket or an object public, see The Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). -// Related Resources -// -// * GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) -// -// * -// DeletePublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) -// -// * -// GetBucketPolicyStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) -// -// * -// Using Amazon S3 Block Public Access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// . Related Resources +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) +// - DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) +// - GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) +// - Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, error) { if params == nil { params = &PutPublicAccessBlockInput{} @@ -68,8 +55,7 @@ type PutPublicAccessBlockInput struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // bucket. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. // // This member is required. @@ -79,9 +65,8 @@ type PutPublicAccessBlockInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm diff --git a/service/s3/api_op_RestoreObject.go b/service/s3/api_op_RestoreObject.go index 0ad916d0345..eb665882bd6 100644 --- a/service/s3/api_op_RestoreObject.go +++ b/service/s3/api_op_RestoreObject.go @@ -16,197 +16,140 @@ import ( // Restores an archived copy of an object back into Amazon S3 This action is not // supported by Amazon S3 on Outposts. This action performs the following types of // requests: -// -// * select - Perform a select query on an archived object -// -// * restore an -// archive - Restore an archived object -// -// To use this operation, you must have -// permissions to perform the s3:RestoreObject action. The bucket owner has this -// permission by default and can grant this permission to others. For more -// information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// - select - Perform a select query on an archived object +// - restore an archive - Restore an archived object +// +// To use this operation, you must have permissions to perform the s3:RestoreObject +// action. The bucket owner has this permission by default and can grant this +// permission to others. For more information about permissions, see Permissions +// Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // in the Amazon S3 User Guide. For more information about the S3 structure in the // request body, see the following: -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * Managing -// Access with ACLs -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) in the -// Amazon S3 User Guide -// -// * Protecting Data Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in -// the Amazon S3 User Guide -// -// * Define the SQL expression for the SELECT type of -// restoration for your query in the request body's SelectParameters structure. You -// can use expressions like the following examples. -// -// * The following expression -// returns all records from the specified object. SELECT * FROM Object -// -// * Assuming -// that you are not using any headers for data stored in the object, you can -// specify columns with positional headers. SELECT s._1, s._2 FROM Object s WHERE -// s._3 > 100 -// -// * If you have headers and you set the fileHeaderInfo in the CSV -// structure in the request body to USE, you can specify headers in the query. (If -// you set the fileHeaderInfo field to IGNORE, the first row is skipped for the -// query.) You cannot mix ordinal positions with header column names. SELECT s.Id, -// s.FirstName, s.SSN FROM S3Object s -// -// When making a select request, you can also -// do the following: -// -// * To expedite your queries, specify the Expedited tier. For -// more information about tiers, see "Restoring Archives," later in this topic. -// -// * -// Specify details about the data serialization format of both the input object -// that is being queried and the serialization of the CSV-encoded query -// results. -// -// The following are additional important facts about the select -// feature: -// -// * The output results are new Amazon S3 objects. Unlike archive -// retrievals, they are stored until explicitly deleted-manually or through a -// lifecycle policy. -// -// * You can issue more than one select request on the same -// Amazon S3 object. Amazon S3 doesn't duplicate requests, so avoid issuing -// duplicate requests. -// -// * Amazon S3 accepts a select request even if the object has -// already been restored. A select request doesn’t return error response -// 409. -// -// Restoring objects Objects that you archive to the S3 Glacier Flexible -// Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering -// Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real -// time. For objects in the S3 Glacier Flexible Retrieval or S3 Glacier Deep -// Archive storage classes, you must first initiate a restore request, and then -// wait until a temporary copy of the object is available. If you want a permanent -// copy of the object, create a copy of it in the Amazon S3 Standard storage class -// in your S3 bucket. To access an archived object, you must restore the object for -// the duration (number of days) that you specify. For objects in the Archive -// Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first -// initiate a restore request, and then wait until the object is moved into the -// Frequent Access tier. To restore a specific object version, you can provide a -// version ID. If you don't provide a version ID, Amazon S3 restores the current -// version. When restoring an archived object, you can specify one of the following -// data access tier options in the Tier element of the request body: -// -// * Expedited - -// Expedited retrievals allow you to quickly access your data stored in the S3 -// Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier -// when occasional urgent requests for a subset of archives are required. For all -// but the largest archived objects (250 MB+), data accessed using Expedited -// retrievals is typically made available within 1–5 minutes. Provisioned capacity -// ensures that retrieval capacity for Expedited retrievals is available when you -// need it. Expedited retrievals and provisioned capacity are not available for -// objects stored in the S3 Glacier Deep Archive storage class or S3 -// Intelligent-Tiering Deep Archive tier. -// -// * Standard - Standard retrievals allow -// you to access any of your archived objects within several hours. This is the -// default option for retrieval requests that do not specify the retrieval option. -// Standard retrievals typically finish within 3–5 hours for objects stored in the -// S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive -// tier. They typically finish within 12 hours for objects stored in the S3 Glacier -// Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard -// retrievals are free for objects stored in S3 Intelligent-Tiering. -// -// * Bulk - Bulk -// retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 -// Intelligent-Tiering storage classes, enabling you to retrieve large amounts, -// even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 -// hours for objects stored in the S3 Glacier Flexible Retrieval storage class or -// S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost -// retrieval option when restoring objects from S3 Glacier Deep Archive. They -// typically finish within 48 hours for objects stored in the S3 Glacier Deep -// Archive storage class or S3 Intelligent-Tiering Deep Archive tier. -// -// For more -// information about archive retrieval options and provisioned capacity for -// Expedited data access, see Restoring Archived Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) in the -// Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to change the -// restore speed to a faster speed while it is in progress. For more information, -// see Upgrading the speed of an in-progress restore -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - Managing Access with ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) +// in the Amazon S3 User Guide +// - Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// in the Amazon S3 User Guide +// - Define the SQL expression for the SELECT type of restoration for your query +// in the request body's SelectParameters structure. You can use expressions like +// the following examples. +// - The following expression returns all records from the specified object. +// SELECT * FROM Object +// - Assuming that you are not using any headers for data stored in the object, +// you can specify columns with positional headers. SELECT s._1, s._2 FROM +// Object s WHERE s._3 > 100 +// - If you have headers and you set the fileHeaderInfo in the CSV structure in +// the request body to USE , you can specify headers in the query. (If you set +// the fileHeaderInfo field to IGNORE , the first row is skipped for the query.) +// You cannot mix ordinal positions with header column names. SELECT s.Id, +// s.FirstName, s.SSN FROM S3Object s +// +// When making a select request, you can also do the following: +// - To expedite your queries, specify the Expedited tier. For more information +// about tiers, see "Restoring Archives," later in this topic. +// - Specify details about the data serialization format of both the input +// object that is being queried and the serialization of the CSV-encoded query +// results. +// +// The following are additional important facts about the select feature: +// +// - The output results are new Amazon S3 objects. Unlike archive retrievals, +// they are stored until explicitly deleted-manually or through a lifecycle policy. +// +// - You can issue more than one select request on the same Amazon S3 object. +// Amazon S3 doesn't duplicate requests, so avoid issuing duplicate requests. +// +// - Amazon S3 accepts a select request even if the object has already been +// restored. A select request doesn’t return error response 409 . +// +// Restoring objects Objects that you archive to the S3 Glacier Flexible Retrieval +// or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or +// S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For +// objects in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage +// classes, you must first initiate a restore request, and then wait until a +// temporary copy of the object is available. If you want a permanent copy of the +// object, create a copy of it in the Amazon S3 Standard storage class in your S3 +// bucket. To access an archived object, you must restore the object for the +// duration (number of days) that you specify. For objects in the Archive Access or +// Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a +// restore request, and then wait until the object is moved into the Frequent +// Access tier. To restore a specific object version, you can provide a version ID. +// If you don't provide a version ID, Amazon S3 restores the current version. When +// restoring an archived object, you can specify one of the following data access +// tier options in the Tier element of the request body: +// - Expedited - Expedited retrievals allow you to quickly access your data +// stored in the S3 Glacier Flexible Retrieval storage class or S3 +// Intelligent-Tiering Archive tier when occasional urgent requests for a subset of +// archives are required. For all but the largest archived objects (250 MB+), data +// accessed using Expedited retrievals is typically made available within 1–5 +// minutes. Provisioned capacity ensures that retrieval capacity for Expedited +// retrievals is available when you need it. Expedited retrievals and provisioned +// capacity are not available for objects stored in the S3 Glacier Deep Archive +// storage class or S3 Intelligent-Tiering Deep Archive tier. +// - Standard - Standard retrievals allow you to access any of your archived +// objects within several hours. This is the default option for retrieval requests +// that do not specify the retrieval option. Standard retrievals typically finish +// within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval storage +// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 +// hours for objects stored in the S3 Glacier Deep Archive storage class or S3 +// Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects +// stored in S3 Intelligent-Tiering. +// - Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible +// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve +// large amounts, even petabytes, of data at no cost. Bulk retrievals typically +// finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval +// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also +// the lowest-cost retrieval option when restoring objects from S3 Glacier Deep +// Archive. They typically finish within 48 hours for objects stored in the S3 +// Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. +// +// For more information about archive retrieval options and provisioned capacity +// for Expedited data access, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html) +// in the Amazon S3 User Guide. You can use Amazon S3 restore speed upgrade to +// change the restore speed to a faster speed while it is in progress. For more +// information, see Upgrading the speed of an in-progress restore (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html) // in the Amazon S3 User Guide. To get the status of object restoration, you can // send a HEAD request. Operations return the x-amz-restore header, which provides // information about the restoration status, in the response. You can use Amazon S3 // event notifications to notify you when a restore is initiated or completed. For -// more information, see Configuring Amazon S3 Event Notifications -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the -// Amazon S3 User Guide. After restoring an archived object, you can update the -// restoration period by reissuing the request with a new period. Amazon S3 updates -// the restoration period relative to the current time and charges only for the -// request-there are no data transfer charges. You cannot update the restoration -// period when Amazon S3 is actively processing your current restore request for -// the object. If your bucket has a lifecycle configuration with a rule that -// includes an expiration action, the object expiration overrides the life span -// that you specify in a restore request. For example, if you restore an object -// copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 -// deletes the object in 3 days. For more information about lifecycle -// configuration, see PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) -// and Object Lifecycle Management -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in -// Amazon S3 User Guide. Responses A successful action returns either the 200 OK or -// 202 Accepted status code. -// -// * If the object is not previously restored, then -// Amazon S3 returns 202 Accepted in the response. -// -// * If the object is previously -// restored, Amazon S3 returns 200 OK in the response. -// -// # Special Errors -// -// * Code: -// RestoreAlreadyInProgress -// -// * Cause: Object restore is already in progress. (This -// error does not apply to SELECT type requests.) -// -// * HTTP Status Code: 409 -// Conflict -// -// * SOAP Fault Code Prefix: Client -// -// * Code: -// GlacierExpeditedRetrievalNotAvailable -// -// * Cause: expedited retrievals are -// currently not available. Try again later. (Returned if there is insufficient -// capacity to process the Expedited request. This error applies only to Expedited -// retrievals and not to S3 Standard or Bulk retrievals.) -// -// * HTTP Status Code: -// 503 -// -// * SOAP Fault Code Prefix: N/A -// -// # Related Resources -// -// * -// PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) -// -// * -// GetBucketNotificationConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) +// more information, see Configuring Amazon S3 Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) +// in the Amazon S3 User Guide. After restoring an archived object, you can update +// the restoration period by reissuing the request with a new period. Amazon S3 +// updates the restoration period relative to the current time and charges only for +// the request-there are no data transfer charges. You cannot update the +// restoration period when Amazon S3 is actively processing your current restore +// request for the object. If your bucket has a lifecycle configuration with a rule +// that includes an expiration action, the object expiration overrides the life +// span that you specify in a restore request. For example, if you restore an +// object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon +// S3 deletes the object in 3 days. For more information about lifecycle +// configuration, see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// and Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// in Amazon S3 User Guide. Responses A successful action returns either the 200 OK +// or 202 Accepted status code. +// - If the object is not previously restored, then Amazon S3 returns 202 +// Accepted in the response. +// - If the object is previously restored, Amazon S3 returns 200 OK in the +// response. +// +// Special Errors +// - Code: RestoreAlreadyInProgress +// - Cause: Object restore is already in progress. (This error does not apply to +// SELECT type requests.) +// - HTTP Status Code: 409 Conflict +// - SOAP Fault Code Prefix: Client +// - Code: GlacierExpeditedRetrievalNotAvailable +// - Cause: expedited retrievals are currently not available. Try again later. +// (Returned if there is insufficient capacity to process the Expedited request. +// This error applies only to Expedited retrievals and not to S3 Standard or Bulk +// retrievals.) +// - HTTP Status Code: 503 +// - SOAP Fault Code Prefix: N/A +// +// Related Resources +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// - GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) func (c *Client) RestoreObject(ctx context.Context, params *RestoreObjectInput, optFns ...func(*Options)) (*RestoreObjectOutput, error) { if params == nil { params = &RestoreObjectInput{} @@ -224,23 +167,21 @@ func (c *Client) RestoreObject(ctx context.Context, params *RestoreObjectInput, type RestoreObjectInput struct { - // The bucket name containing the object to restore. When using this action with an - // access point, you must direct requests to the access point hostname. The access - // point hostname takes the form + // The bucket name containing the object to restore. When using this action with + // an access point, you must direct requests to the access point hostname. The + // access point hostname takes the form // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -254,9 +195,8 @@ type RestoreObjectInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. ChecksumAlgorithm types.ChecksumAlgorithm @@ -269,8 +209,7 @@ type RestoreObjectInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -386,8 +325,8 @@ func newServiceMetadataMiddleware_opRestoreObject(region string) *awsmiddleware. } } -// getRestoreObjectRequestAlgorithmMember gets the request checksum algorithm value -// provided as input. +// getRestoreObjectRequestAlgorithmMember gets the request checksum algorithm +// value provided as input. func getRestoreObjectRequestAlgorithmMember(input interface{}) (string, bool) { in := input.(*RestoreObjectInput) if len(in.ChecksumAlgorithm) == 0 { diff --git a/service/s3/api_op_SelectObjectContent.go b/service/s3/api_op_SelectObjectContent.go index 0ed1ba263be..6c9120a7627 100644 --- a/service/s3/api_op_SelectObjectContent.go +++ b/service/s3/api_op_SelectObjectContent.go @@ -21,83 +21,55 @@ import ( // into records, and returns only records that match the specified SQL expression. // You must also specify the data serialization format for the response. This // action is not supported by Amazon S3 on Outposts. For more information about -// Amazon S3 Select, see Selecting Content from Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html) -// and SELECT Command -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html) +// Amazon S3 Select, see Selecting Content from Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html) +// and SELECT Command (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html) // in the Amazon S3 User Guide. Permissions You must have s3:GetObject permission // for this operation. Amazon S3 Select does not support anonymous access. For more -// information about permissions, see Specifying Permissions in a Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) in -// the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to +// information about permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) +// in the Amazon S3 User Guide. Object Data Formats You can use Amazon S3 Select to // query objects that have the following format properties: +// - CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format. +// - UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports. +// - GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. +// GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports +// for CSV and JSON files. Amazon S3 Select supports columnar compression for +// Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object +// compression for Parquet objects. +// - Server-side encryption - Amazon S3 Select supports querying objects that +// are protected with server-side encryption. For objects that are encrypted with +// customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use +// the headers that are documented in the GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// . For more information about SSE-C, see Server-Side Encryption (Using +// Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) +// in the Amazon S3 User Guide. For objects that are encrypted with Amazon S3 +// managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side +// encryption is handled transparently, so you don't need to specify anything. For +// more information about server-side encryption, including SSE-S3 and SSE-KMS, see +// Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) +// in the Amazon S3 User Guide. // -// * CSV, JSON, and -// Parquet - Objects must be in CSV, JSON, or Parquet format. +// Working with the Response Body Given the response size is unknown, Amazon S3 +// Select streams the response as a series of messages and includes a +// Transfer-Encoding header with chunked as its value in the response. For more +// information, see Appendix: SelectObjectContent Response (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html) +// . GetObject Support The SelectObjectContent action does not support the +// following GetObject functionality. For more information, see GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// . +// - Range : Although you can specify a scan range for an Amazon S3 Select +// request (see SelectObjectContentRequest - ScanRange (https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange) +// in the request parameters), you cannot specify the range of bytes of an object +// to return. +// - GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot +// specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For +// more information, about storage classes see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro) +// in the Amazon S3 User Guide. // -// * UTF-8 - UTF-8 is -// the only encoding type Amazon S3 Select supports. -// -// * GZIP or BZIP2 - CSV and -// JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only -// compression formats that Amazon S3 Select supports for CSV and JSON files. -// Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. -// Amazon S3 Select does not support whole-object compression for Parquet -// objects. -// -// * Server-side encryption - Amazon S3 Select supports querying objects -// that are protected with server-side encryption. For objects that are encrypted -// with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must -// use the headers that are documented in the GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). For more -// information about SSE-C, see Server-Side Encryption (Using Customer-Provided -// Encryption Keys) -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) -// in the Amazon S3 User Guide. For objects that are encrypted with Amazon S3 -// managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side -// encryption is handled transparently, so you don't need to specify anything. For -// more information about server-side encryption, including SSE-S3 and SSE-KMS, see -// Protecting Data Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) in -// the Amazon S3 User Guide. -// -// Working with the Response Body Given the response -// size is unknown, Amazon S3 Select streams the response as a series of messages -// and includes a Transfer-Encoding header with chunked as its value in the -// response. For more information, see Appendix: SelectObjectContent Response -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html). -// GetObject Support The SelectObjectContent action does not support the following -// GetObject functionality. For more information, see GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). -// -// * Range: -// Although you can specify a scan range for an Amazon S3 Select request (see -// SelectObjectContentRequest - ScanRange -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange) -// in the request parameters), you cannot specify the range of bytes of an object -// to return. -// -// * GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You -// cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. -// For more information, about storage classes see Storage Classes -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro) -// in the Amazon S3 User Guide. -// -// Special Errors For a list of special errors for -// this operation, see List of SELECT Object Content Error Codes -// (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList) +// Special Errors For a list of special errors for this operation, see List of +// SELECT Object Content Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList) // Related Resources -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) -// -// * -// PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) func (c *Client) SelectObjectContent(ctx context.Context, params *SelectObjectContentInput, optFns ...func(*Options)) (*SelectObjectContentOutput, error) { if params == nil { params = &SelectObjectContentInput{} @@ -119,8 +91,8 @@ func (c *Client) SelectObjectContent(ctx context.Context, params *SelectObjectCo // object. Amazon S3 uses this to parse object data into records. It returns only // records that match the specified SQL expression. You must also specify the data // serialization format for the response. For more information, see S3Select API -// Documentation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html). +// Documentation (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html) +// . type SelectObjectContentInput struct { // The S3 bucket. @@ -163,39 +135,31 @@ type SelectObjectContentInput struct { // The server-side encryption (SSE) algorithm used to encrypt the object. This // parameter is needed only when the object was created using a checksum algorithm. - // For more information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // For more information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerAlgorithm *string // The server-side encryption (SSE) customer managed key. This parameter is needed // only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKey *string // The MD5 server-side encryption (SSE) customer managed key. This parameter is // needed only when the object was created using a checksum algorithm. For more - // information, see Protecting data using SSE-C keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) + // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon S3 User Guide. SSECustomerKeyMD5 *string // Specifies the byte range of the object to get the records from. A record is // processed when its first byte is contained by the range. This parameter is // optional, but when specified, it must not be empty. See RFC 2616, Section - // 14.35.1 about how to specify the start and end of the range. ScanRangemay be + // 14.35.1 about how to specify the start and end of the range. ScanRange may be // used in the following ways: - // - // * 50100 - process only the records starting between - // the bytes 50 and 100 (inclusive, counting from zero) - // - // * 50 - process only the - // records starting after the byte 50 - // - // * 50 - process only the records within the - // last 50 bytes of the file. + // - 50100 - process only the records starting between the bytes 50 and 100 + // (inclusive, counting from zero) + // - 50 - process only the records starting after the byte 50 + // - 50 - process only the records within the last 50 bytes of the file. ScanRange *types.ScanRange noSmithyDocumentSerde diff --git a/service/s3/api_op_UploadPart.go b/service/s3/api_op_UploadPart.go index 801bab8d1bd..afbbe7224b9 100644 --- a/service/s3/api_op_UploadPart.go +++ b/service/s3/api_op_UploadPart.go @@ -18,40 +18,35 @@ import ( // Uploads a part in a multipart upload. In this operation, you provide part data // in your request. However, you have an option to specify your existing Amazon S3 // object as a data source for the part you are uploading. To upload a part from an -// existing object, you use the UploadPartCopy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) -// operation. You must initiate a multipart upload (see CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)) -// before you can upload any part. In response to your initiate request, Amazon S3 -// returns an upload ID, a unique identifier, that you must include in your upload -// part request. Part numbers can be any number from 1 to 10,000, inclusive. A part -// number uniquely identifies a part and also defines its position within the -// object being created. If you upload a new part using the same part number that -// was used with a previous part, the previously uploaded part is overwritten. For -// information about maximum and minimum part sizes and other multipart upload -// specifications, see Multipart upload limits -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in the -// Amazon S3 User Guide. To ensure that data is not corrupted when traversing the -// network, specify the Content-MD5 header in the upload part request. Amazon S3 -// checks the part data against the provided MD5 value. If they do not match, -// Amazon S3 returns an error. If the upload request is signed with Signature -// Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a -// checksum instead of Content-MD5. For more information see Authenticating -// Requests: Using the Authorization Header (Amazon Web Services Signature Version -// 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html). -// Note: After you initiate multipart upload and upload one or more parts, you must -// either complete or abort multipart upload in order to stop getting charged for -// storage of the uploaded parts. Only after you either complete or abort multipart -// upload, Amazon S3 frees up the parts storage and stops charging you for the -// parts storage. For more information on multipart uploads, go to Multipart Upload -// Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in -// the Amazon S3 User Guide . For information on the permissions required to use -// the multipart upload API, go to Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) in the -// Amazon S3 User Guide. Server-side encryption is for data encryption at rest. -// Amazon S3 encrypts your data as it writes it to disks in its data centers and -// decrypts it when you access it. You have three mutually exclusive options to +// existing object, you use the UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) +// operation. You must initiate a multipart upload (see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// ) before you can upload any part. In response to your initiate request, Amazon +// S3 returns an upload ID, a unique identifier, that you must include in your +// upload part request. Part numbers can be any number from 1 to 10,000, inclusive. +// A part number uniquely identifies a part and also defines its position within +// the object being created. If you upload a new part using the same part number +// that was used with a previous part, the previously uploaded part is overwritten. +// For information about maximum and minimum part sizes and other multipart upload +// specifications, see Multipart upload limits (https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) +// in the Amazon S3 User Guide. To ensure that data is not corrupted when +// traversing the network, specify the Content-MD5 header in the upload part +// request. Amazon S3 checks the part data against the provided MD5 value. If they +// do not match, Amazon S3 returns an error. If the upload request is signed with +// Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 +// header as a checksum instead of Content-MD5 . For more information see +// Authenticating Requests: Using the Authorization Header (Amazon Web Services +// Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html) +// . Note: After you initiate multipart upload and upload one or more parts, you +// must either complete or abort multipart upload in order to stop getting charged +// for storage of the uploaded parts. Only after you either complete or abort +// multipart upload, Amazon S3 frees up the parts storage and stops charging you +// for the parts storage. For more information on multipart uploads, go to +// Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) +// in the Amazon S3 User Guide . For information on the permissions required to use +// the multipart upload API, go to Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// in the Amazon S3 User Guide. Server-side encryption is for data encryption at +// rest. Amazon S3 encrypts your data as it writes it to disks in its data centers +// and decrypts it when you access it. You have three mutually exclusive options to // protect data using server-side encryption in Amazon S3, depending on how you // choose to manage the encryption keys. Specifically, the encryption key options // are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and @@ -62,64 +57,35 @@ import ( // (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide // your own encryption key, the request headers you provide in the request must // match the headers you used in the request to initiate the upload by using -// CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). -// For more information, go to Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) +// CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// . For more information, go to Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) // in the Amazon S3 User Guide. Server-side encryption is supported by the S3 // Multipart Upload actions. Unless you are using a customer-provided encryption // key (SSE-C), you don't need to specify the encryption parameters in each // UploadPart request. Instead, you only need to specify the server-side encryption // parameters in the initial Initiate Multipart request. For more information, see -// CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). -// If you requested server-side encryption using a customer-provided encryption key -// (SSE-C) in your initiate multipart upload request, you must provide identical -// encryption information in each part upload using the following headers. +// CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// . If you requested server-side encryption using a customer-provided encryption +// key (SSE-C) in your initiate multipart upload request, you must provide +// identical encryption information in each part upload using the following +// headers. +// - x-amz-server-side-encryption-customer-algorithm +// - x-amz-server-side-encryption-customer-key +// - x-amz-server-side-encryption-customer-key-MD5 // -// * -// x-amz-server-side-encryption-customer-algorithm +// Special Errors +// - Code: NoSuchUpload +// - Cause: The specified multipart upload does not exist. The upload ID might +// be invalid, or the multipart upload might have been aborted or completed. +// - HTTP Status Code: 404 Not Found +// - SOAP Fault Code Prefix: Client // -// * -// x-amz-server-side-encryption-customer-key -// -// * -// x-amz-server-side-encryption-customer-key-MD5 -// -// # Special Errors -// -// * Code: -// NoSuchUpload -// -// * Cause: The specified multipart upload does not exist. The upload -// ID might be invalid, or the multipart upload might have been aborted or -// completed. -// -// * HTTP Status Code: 404 Not Found -// -// * SOAP Fault Code Prefix: -// Client -// -// # Related Resources -// -// * CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// Related Resources +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) UploadPart(ctx context.Context, params *UploadPartInput, optFns ...func(*Options)) (*UploadPartOutput, error) { if params == nil { params = &UploadPartInput{} @@ -143,17 +109,15 @@ type UploadPartInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string @@ -181,9 +145,8 @@ type UploadPartInput struct { // the SDK. This header will not provide any additional functionality if not using // the SDK. When sending this header, there must be a corresponding x-amz-checksum // or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the - // HTTP status code 400 Bad Request. For more information, see Checking object - // integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // HTTP status code 400 Bad Request . For more information, see Checking object + // integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 // ignores any provided ChecksumAlgorithm parameter. This checksum algorithm must // be the same for all parts and it match the checksum value supplied in the @@ -193,32 +156,28 @@ type UploadPartInput struct { // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32C *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA1 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -239,8 +198,7 @@ type UploadPartInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -252,7 +210,7 @@ type UploadPartInput struct { // encrypting data. This value is used to store the object and then it is // discarded; Amazon S3 does not store the encryption key. The key must be // appropriate for use with the algorithm specified in the - // x-amz-server-side-encryption-customer-algorithm header. This must be the same + // x-amz-server-side-encryption-customer-algorithm header . This must be the same // encryption key specified in the initiate multipart upload request. SSECustomerKey *string @@ -273,32 +231,28 @@ type UploadPartOutput struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -309,13 +263,14 @@ type UploadPartOutput struct { // request. RequestCharged types.RequestCharged - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the ID of the Amazon Web Services Key Management Service @@ -324,7 +279,7 @@ type UploadPartOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Metadata pertaining to the operation's result. @@ -446,8 +401,9 @@ func addUploadPartInputChecksumMiddlewares(stack *middleware.Stack, options Opti }) } -// getUploadPartBucketMember returns a pointer to string denoting a provided bucket -// member valueand a boolean indicating if the input has a modeled bucket name, +// getUploadPartBucketMember returns a pointer to string denoting a provided +// bucket member valueand a boolean indicating if the input has a modeled bucket +// name, func getUploadPartBucketMember(input interface{}) (*string, bool) { in := input.(*UploadPartInput) if in.Bucket == nil { diff --git a/service/s3/api_op_UploadPartCopy.go b/service/s3/api_op_UploadPartCopy.go index 85c3da20c9f..c835cfb716d 100644 --- a/service/s3/api_op_UploadPartCopy.go +++ b/service/s3/api_op_UploadPartCopy.go @@ -15,112 +15,72 @@ import ( // Uploads a part by copying data from an existing object as data source. You // specify the data source by adding the request header x-amz-copy-source in your -// request and a byte range by adding the request header x-amz-copy-source-range in -// your request. For information about maximum and minimum part sizes and other -// multipart upload specifications, see Multipart upload limits -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) in the -// Amazon S3 User Guide. Instead of using an existing object as part data, you -// might use the UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) action and -// provide data in your request. You must initiate a multipart upload before you -// can upload any part. In response to your initiate request. Amazon S3 returns a -// unique identifier, the upload ID, that you must include in your upload part -// request. For more information about using the UploadPartCopy operation, see the -// following: +// request and a byte range by adding the request header x-amz-copy-source-range +// in your request. For information about maximum and minimum part sizes and other +// multipart upload specifications, see Multipart upload limits (https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html) +// in the Amazon S3 User Guide. Instead of using an existing object as part data, +// you might use the UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// action and provide data in your request. You must initiate a multipart upload +// before you can upload any part. In response to your initiate request. Amazon S3 +// returns a unique identifier, the upload ID, that you must include in your upload +// part request. For more information about using the UploadPartCopy operation, +// see the following: +// - For conceptual information about multipart uploads, see Uploading Objects +// Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) +// in the Amazon S3 User Guide. +// - For information about permissions required to use the multipart upload API, +// see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) +// in the Amazon S3 User Guide. +// - For information about copying objects using a single atomic action vs. a +// multipart upload, see Operations on Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html) +// in the Amazon S3 User Guide. +// - For information about using server-side encryption with customer-provided +// encryption keys with the UploadPartCopy operation, see CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) +// and UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// . // -// * For conceptual information about multipart uploads, see Uploading -// Objects Using Multipart Upload -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) in the -// Amazon S3 User Guide. +// Note the following additional considerations about the request headers +// x-amz-copy-source-if-match , x-amz-copy-source-if-none-match , +// x-amz-copy-source-if-unmodified-since , and x-amz-copy-source-if-modified-since +// : +// - Consideration 1 - If both of the x-amz-copy-source-if-match and +// x-amz-copy-source-if-unmodified-since headers are present in the request as +// follows: x-amz-copy-source-if-match condition evaluates to true , and; +// x-amz-copy-source-if-unmodified-since condition evaluates to false ; Amazon S3 +// returns 200 OK and copies the data. +// - Consideration 2 - If both of the x-amz-copy-source-if-none-match and +// x-amz-copy-source-if-modified-since headers are present in the request as +// follows: x-amz-copy-source-if-none-match condition evaluates to false , and; +// x-amz-copy-source-if-modified-since condition evaluates to true ; Amazon S3 +// returns 412 Precondition Failed response code. // -// * For information about permissions required to use the -// multipart upload API, see Multipart Upload and Permissions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html) in the -// Amazon S3 User Guide. -// -// * For information about copying objects using a single -// atomic action vs. a multipart upload, see Operations on Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html) in the -// Amazon S3 User Guide. -// -// * For information about using server-side encryption with -// customer-provided encryption keys with the UploadPartCopy operation, see -// CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) -// and UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html). -// -// Note the -// following additional considerations about the request headers -// x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, -// x-amz-copy-source-if-unmodified-since, and -// x-amz-copy-source-if-modified-since: -// -// * Consideration 1 - If both of the -// x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are -// present in the request as follows: x-amz-copy-source-if-match condition -// evaluates to true, and; x-amz-copy-source-if-unmodified-since condition -// evaluates to false; Amazon S3 returns 200 OK and copies the data. -// -// * -// Consideration 2 - If both of the x-amz-copy-source-if-none-match and -// x-amz-copy-source-if-modified-since headers are present in the request as -// follows: x-amz-copy-source-if-none-match condition evaluates to false, and; -// x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 -// returns 412 Precondition Failed response code. -// -// Versioning If your bucket has -// versioning enabled, you could have multiple versions of the same object. By -// default, x-amz-copy-source identifies the current version of the object to copy. -// If the current version is a delete marker and you don't specify a versionId in -// the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does -// not exist. If you specify versionId in the x-amz-copy-source and the versionId -// is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not -// allowed to specify a delete marker as a version for the x-amz-copy-source. You -// can optionally specify a specific version of the source object to copy by adding -// the versionId subresource as shown in the following example: x-amz-copy-source: +// Versioning If your bucket has versioning enabled, you could have multiple +// versions of the same object. By default, x-amz-copy-source identifies the +// current version of the object to copy. If the current version is a delete marker +// and you don't specify a versionId in the x-amz-copy-source , Amazon S3 returns a +// 404 error, because the object does not exist. If you specify versionId in the +// x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an +// HTTP 400 error, because you are not allowed to specify a delete marker as a +// version for the x-amz-copy-source . You can optionally specify a specific +// version of the source object to copy by adding the versionId subresource as +// shown in the following example: x-amz-copy-source: // /bucket/object?versionId=version id Special Errors +// - Code: NoSuchUpload +// - Cause: The specified multipart upload does not exist. The upload ID might +// be invalid, or the multipart upload might have been aborted or completed. +// - HTTP Status Code: 404 Not Found +// - Code: InvalidRequest +// - Cause: The specified copy source is not supported as a byte-range copy +// source. +// - HTTP Status Code: 400 Bad Request // -// * Code: NoSuchUpload -// -// * -// Cause: The specified multipart upload does not exist. The upload ID might be -// invalid, or the multipart upload might have been aborted or completed. -// -// * HTTP -// Status Code: 404 Not Found -// -// * Code: InvalidRequest -// -// * Cause: The specified copy -// source is not supported as a byte-range copy source. -// -// * HTTP Status Code: 400 -// Bad Request -// -// # Related Resources -// -// * CreateMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// -// * -// UploadPart -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// -// * -// CompleteMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) -// -// * -// AbortMultipartUpload -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) -// -// * -// ListParts -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// -// * -// ListMultipartUploads -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) +// Related Resources +// - CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) +// - UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// - CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) +// - AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) +// - ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// - ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) func (c *Client) UploadPartCopy(ctx context.Context, params *UploadPartCopyInput, optFns ...func(*Options)) (*UploadPartCopyOutput, error) { if params == nil { params = &UploadPartCopyInput{} @@ -143,53 +103,47 @@ type UploadPartCopyInput struct { // AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this // action with an access point through the Amazon Web Services SDKs, you provide // the access point ARN in place of the bucket name. For more information about - // access point ARNs, see Using access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) + // access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) // in the Amazon S3 User Guide. When you use this action with Amazon S3 on // Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on // Outposts hostname takes the form - // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you + // AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you // use this action with S3 on Outposts through the Amazon Web Services SDKs, you // provide the Outposts access point ARN in place of the bucket name. For more - // information about S3 on Outposts ARNs, see What is S3 on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the - // Amazon S3 User Guide. + // information about S3 on Outposts ARNs, see What is S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) + // in the Amazon S3 User Guide. // // This member is required. Bucket *string - // Specifies the source object for the copy operation. You specify the value in one - // of two formats, depending on whether you want to access the source object - // through an access point - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html): - // - // * - // For objects not accessed through an access point, specify the name of the source - // bucket and key of the source object, separated by a slash (/). For example, to - // copy the object reports/january.pdf from the bucket awsexamplebucket, use - // awsexamplebucket/reports/january.pdf. The value must be URL-encoded. - // - // * For - // objects accessed through access points, specify the Amazon Resource Name (ARN) - // of the object as accessed through the access point, in the format - // arn:aws:s3:::accesspoint//object/. For example, to copy the object - // reports/january.pdf through access point my-access-point owned by account - // 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. - // The value must be URL encoded. Amazon S3 supports copy operations using access - // points only when the source and destination buckets are in the same Amazon Web - // Services Region. Alternatively, for objects accessed through Amazon S3 on - // Outposts, specify the ARN of the object as accessed in the format - // arn:aws:s3-outposts:::outpost//object/. For example, to copy the object - // reports/january.pdf through outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. - // The value must be URL-encoded. - // - // To copy a specific version of an object, append - // ?versionId= to the value (for example, - // awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - // If you don't specify a version ID, Amazon S3 copies the latest version of the + // Specifies the source object for the copy operation. You specify the value in + // one of two formats, depending on whether you want to access the source object + // through an access point (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) + // : + // - For objects not accessed through an access point, specify the name of the + // source bucket and key of the source object, separated by a slash (/). For + // example, to copy the object reports/january.pdf from the bucket + // awsexamplebucket , use awsexamplebucket/reports/january.pdf . The value must + // be URL-encoded. + // - For objects accessed through access points, specify the Amazon Resource + // Name (ARN) of the object as accessed through the access point, in the format + // arn:aws:s3:::accesspoint//object/ . For example, to copy the object + // reports/january.pdf through access point my-access-point owned by account + // 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf + // . The value must be URL encoded. Amazon S3 supports copy operations using access + // points only when the source and destination buckets are in the same Amazon Web + // Services Region. Alternatively, for objects accessed through Amazon S3 on + // Outposts, specify the ARN of the object as accessed in the format + // arn:aws:s3-outposts:::outpost//object/ . For example, to copy the object + // reports/january.pdf through outpost my-outpost owned by account 123456789012 + // in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf + // . The value must be URL-encoded. + // To copy a specific version of an object, append ?versionId= to the value (for + // example, + // awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893 + // ). If you don't specify a version ID, Amazon S3 copies the latest version of the // source object. // // This member is required. @@ -257,8 +211,7 @@ type UploadPartCopyInput struct { // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. For information // about downloading objects from Requester Pays buckets, see Downloading Objects - // in Requester Pays Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) + // in Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) // in the Amazon S3 User Guide. RequestPayer types.RequestPayer @@ -291,21 +244,22 @@ type UploadPartCopyOutput struct { // Container for all response elements. CopyPartResult *types.CopyPartResult - // The version of the source object that was copied, if you have enabled versioning - // on the source bucket. + // The version of the source object that was copied, if you have enabled + // versioning on the source bucket. CopySourceVersionId *string // If present, indicates that the requester was successfully charged for the // request. RequestCharged types.RequestCharged - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header confirming the encryption algorithm used. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header confirming the encryption + // algorithm used. SSECustomerAlgorithm *string - // If server-side encryption with a customer-provided encryption key was requested, - // the response will include this header to provide round-trip message integrity - // verification of the customer-provided encryption key. + // If server-side encryption with a customer-provided encryption key was + // requested, the response will include this header to provide round-trip message + // integrity verification of the customer-provided encryption key. SSECustomerKeyMD5 *string // If present, specifies the ID of the Amazon Web Services Key Management Service @@ -314,7 +268,7 @@ type UploadPartCopyOutput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_WriteGetObjectResponse.go b/service/s3/api_op_WriteGetObjectResponse.go index 6d3e9225dc2..5ae50436b6e 100644 --- a/service/s3/api_op_WriteGetObjectResponse.go +++ b/service/s3/api_op_WriteGetObjectResponse.go @@ -19,20 +19,18 @@ import ( // Passes transformed objects to a GetObject operation when using Object Lambda // access points. For information about Object Lambda access points, see -// Transforming objects with Object Lambda access points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) +// Transforming objects with Object Lambda access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) // in the Amazon S3 User Guide. This operation supports metadata that can be -// returned by GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html), in -// addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. -// The GetObject response metadata is supported so that the WriteGetObjectResponse -// caller, typically an Lambda function, can provide the same metadata when it -// internally invokes GetObject. When WriteGetObjectResponse is called by a -// customer-owned Lambda function, the metadata returned to the end user GetObject -// call might differ from what Amazon S3 would normally return. You can include any -// number of metadata headers. When including a metadata header, it should be -// prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: -// MyCustomValue. The primary use case for this is to forward GetObject metadata. +// returned by GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// , in addition to RequestRoute , RequestToken , StatusCode , ErrorCode , and +// ErrorMessage . The GetObject response metadata is supported so that the +// WriteGetObjectResponse caller, typically an Lambda function, can provide the +// same metadata when it internally invokes GetObject . When WriteGetObjectResponse +// is called by a customer-owned Lambda function, the metadata returned to the end +// user GetObject call might differ from what Amazon S3 would normally return. You +// can include any number of metadata headers. When including a metadata header, it +// should be prefaced with x-amz-meta . For example, x-amz-meta-my-custom-header: +// MyCustomValue . The primary use case for this is to forward GetObject metadata. // Amazon Web Services provides some prebuilt Lambda functions that you can use // with S3 Object Lambda to detect and redact personally identifiable information // (PII) and decompress S3 objects. These Lambda functions are available in the @@ -52,9 +50,8 @@ import ( // equipped to decompress objects stored in S3 in one of six compressed file // formats including bzip2, gzip, snappy, zlib, zstandard and ZIP. For information // on how to view and use these functions, see Using Amazon Web Services built -// Lambda functions -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html) in -// the Amazon S3 User Guide. +// Lambda functions (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html) +// in the Amazon S3 User Guide. func (c *Client) WriteGetObjectResponse(ctx context.Context, params *WriteGetObjectResponseInput, optFns ...func(*Options)) (*WriteGetObjectResponseOutput, error) { if params == nil { params = &WriteGetObjectResponseInput{} @@ -102,8 +99,7 @@ type WriteGetObjectResponseInput struct { // Lambda function. This may not match the checksum for the object stored in Amazon // S3. Amazon S3 will perform validation of the checksum values only when the // original GetObject request required checksum validation. For more information - // about checksums, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // about checksums, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. Only one checksum header can be specified at a // time. If you supply multiple checksum headers, this request will fail. ChecksumCRC32 *string @@ -114,8 +110,7 @@ type WriteGetObjectResponseInput struct { // Lambda function. This may not match the checksum for the object stored in Amazon // S3. Amazon S3 will perform validation of the checksum values only when the // original GetObject request required checksum validation. For more information - // about checksums, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // about checksums, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. Only one checksum header can be specified at a // time. If you supply multiple checksum headers, this request will fail. ChecksumCRC32C *string @@ -126,8 +121,7 @@ type WriteGetObjectResponseInput struct { // function. This may not match the checksum for the object stored in Amazon S3. // Amazon S3 will perform validation of the checksum values only when the original // GetObject request required checksum validation. For more information about - // checksums, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // checksums, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. Only one checksum header can be specified at a // time. If you supply multiple checksum headers, this request will fail. ChecksumSHA1 *string @@ -138,8 +132,7 @@ type WriteGetObjectResponseInput struct { // Lambda function. This may not match the checksum for the object stored in Amazon // S3. Amazon S3 will perform validation of the checksum values only when the // original GetObject request required checksum validation. For more information - // about checksums, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // about checksums, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. Only one checksum header can be specified at a // time. If you supply multiple checksum headers, this request will fail. ChecksumSHA256 *string @@ -164,8 +157,8 @@ type WriteGetObjectResponseInput struct { // A standard MIME type describing the format of the object data. ContentType *string - // Specifies whether an object stored in Amazon S3 is (true) or is not (false) a - // delete marker. + // Specifies whether an object stored in Amazon S3 is ( true ) or is not ( false ) + // a delete marker. DeleteMarker bool // An opaque identifier assigned by a web server to a specific version of a @@ -173,15 +166,16 @@ type WriteGetObjectResponseInput struct { ETag *string // A string that uniquely identifies an error condition. Returned in the tag of - // the error XML response for a corresponding GetObject call. Cannot be used with a - // successful StatusCode header or when the transformed object is provided in the - // body. All error codes from S3 are sentence-cased. The regular expression (regex) - // value is "^[A-Z][a-zA-Z]+$". + // the error XML response for a corresponding GetObject call. Cannot be used with + // a successful StatusCode header or when the transformed object is provided in + // the body. All error codes from S3 are sentence-cased. The regular expression + // (regex) value is "^[A-Z][a-zA-Z]+$" . ErrorCode *string // Contains a generic description of the error condition. Returned in the tag of - // the error XML response for a corresponding GetObject call. Cannot be used with a - // successful StatusCode header or when the transformed object is provided in body. + // the error XML response for a corresponding GetObject call. Cannot be used with + // a successful StatusCode header or when the transformed object is provided in + // body. ErrorMessage *string // If the object expiration is configured (see PUT Bucket lifecycle), the response @@ -209,8 +203,8 @@ type WriteGetObjectResponseInput struct { ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus // Indicates whether an object stored in Amazon S3 has Object Lock enabled. For - // more information about S3 Object Lock, see Object Lock - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html). + // more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html) + // . ObjectLockMode types.ObjectLockMode // The date and time when Object Lock is configured to expire. @@ -219,9 +213,9 @@ type WriteGetObjectResponseInput struct { // The count of parts this object has. PartsCount int32 - // Indicates if request involves bucket that is either a source or destination in a - // Replication rule. For more information about S3 Replication, see Replication - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html). + // Indicates if request involves bucket that is either a source or destination in + // a Replication rule. For more information about S3 Replication, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html) + // . ReplicationStatus types.ReplicationStatus // If present, indicates that the requester was successfully charged for the @@ -238,8 +232,8 @@ type WriteGetObjectResponseInput struct { // 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to // encrypt data stored in S3. For more information, see Protecting data using - // server-side encryption with customer-provided encryption keys (SSE-C) - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html). + // server-side encryption with customer-provided encryption keys (SSE-C) (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html) + // . SSECustomerKeyMD5 *string // If present, specifies the ID of the Amazon Web Services Key Management Service @@ -248,49 +242,31 @@ type WriteGetObjectResponseInput struct { SSEKMSKeyId *string // The server-side encryption algorithm used when storing requested object in - // Amazon S3 (for example, AES256, aws:kms). + // Amazon S3 (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // The integer status code for an HTTP response of a corresponding GetObject // request. Status Codes - // - // * 200 - OK - // - // * 206 - Partial Content - // - // * 304 - Not - // Modified - // - // * 400 - Bad Request - // - // * 401 - Unauthorized - // - // * 403 - Forbidden - // - // * 404 - - // Not Found - // - // * 405 - Method Not Allowed - // - // * 409 - Conflict - // - // * 411 - Length - // Required - // - // * 412 - Precondition Failed - // - // * 416 - Range Not Satisfiable - // - // * 500 - - // Internal Server Error - // - // * 503 - Service Unavailable + // - 200 - OK + // - 206 - Partial Content + // - 304 - Not Modified + // - 400 - Bad Request + // - 401 - Unauthorized + // - 403 - Forbidden + // - 404 - Not Found + // - 405 - Method Not Allowed + // - 409 - Conflict + // - 411 - Length Required + // - 412 - Precondition Failed + // - 416 - Range Not Satisfiable + // - 500 - Internal Server Error + // - 503 - Service Unavailable StatusCode int32 // Provides storage class information of the object. Amazon S3 returns this header // for all objects except for S3 Standard storage class objects. For more - // information, see Storage Classes - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html). + // information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) + // . StorageClass types.StorageClass // The number of tags, if any, on the object. diff --git a/service/s3/types/enums.go b/service/s3/types/enums.go index 456565f3083..095ad898b9c 100644 --- a/service/s3/types/enums.go +++ b/service/s3/types/enums.go @@ -108,9 +108,9 @@ const ( BucketLocationConstraintUsWest2 BucketLocationConstraint = "us-west-2" ) -// Values returns all known values for BucketLocationConstraint. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for BucketLocationConstraint. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketLocationConstraint) Values() []BucketLocationConstraint { return []BucketLocationConstraint{ "af-south-1", @@ -209,9 +209,9 @@ const ( ChecksumModeEnabled ChecksumMode = "ENABLED" ) -// Values returns all known values for ChecksumMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChecksumMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChecksumMode) Values() []ChecksumMode { return []ChecksumMode{ "ENABLED", @@ -264,9 +264,9 @@ const ( EncodingTypeUrl EncodingType = "url" ) -// Values returns all known values for EncodingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EncodingType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EncodingType) Values() []EncodingType { return []EncodingType{ "url", @@ -306,8 +306,8 @@ const ( EventS3ObjectTaggingDelete Event = "s3:ObjectTagging:Delete" ) -// Values returns all known values for Event. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Event. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Event) Values() []Event { return []Event{ @@ -440,9 +440,10 @@ const ( IntelligentTieringAccessTierDeepArchiveAccess IntelligentTieringAccessTier = "DEEP_ARCHIVE_ACCESS" ) -// Values returns all known values for IntelligentTieringAccessTier. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for IntelligentTieringAccessTier. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (IntelligentTieringAccessTier) Values() []IntelligentTieringAccessTier { return []IntelligentTieringAccessTier{ "ARCHIVE_ACCESS", @@ -458,9 +459,9 @@ const ( IntelligentTieringStatusDisabled IntelligentTieringStatus = "Disabled" ) -// Values returns all known values for IntelligentTieringStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for IntelligentTieringStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (IntelligentTieringStatus) Values() []IntelligentTieringStatus { return []IntelligentTieringStatus{ "Enabled", @@ -627,9 +628,9 @@ const ( MFADeleteDisabled MFADelete = "Disabled" ) -// Values returns all known values for MFADelete. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for MFADelete. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (MFADelete) Values() []MFADelete { return []MFADelete{ "Enabled", @@ -869,8 +870,8 @@ const ( PayerBucketOwner Payer = "BucketOwner" ) -// Values returns all known values for Payer. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Payer. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Payer) Values() []Payer { return []Payer{ @@ -965,8 +966,8 @@ const ( ReplicationRuleStatusDisabled ReplicationRuleStatus = "Disabled" ) -// Values returns all known values for ReplicationRuleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReplicationRuleStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReplicationRuleStatus) Values() []ReplicationRuleStatus { return []ReplicationRuleStatus{ @@ -1005,8 +1006,8 @@ const ( ReplicationTimeStatusDisabled ReplicationTimeStatus = "Disabled" ) -// Values returns all known values for ReplicationTimeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReplicationTimeStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReplicationTimeStatus) Values() []ReplicationTimeStatus { return []ReplicationTimeStatus{ @@ -1038,9 +1039,9 @@ const ( RequestPayerRequester RequestPayer = "requester" ) -// Values returns all known values for RequestPayer. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RequestPayer. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RequestPayer) Values() []RequestPayer { return []RequestPayer{ "requester", @@ -1089,9 +1090,10 @@ const ( SseKmsEncryptedObjectsStatusDisabled SseKmsEncryptedObjectsStatus = "Disabled" ) -// Values returns all known values for SseKmsEncryptedObjectsStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SseKmsEncryptedObjectsStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (SseKmsEncryptedObjectsStatus) Values() []SseKmsEncryptedObjectsStatus { return []SseKmsEncryptedObjectsStatus{ "Enabled", @@ -1114,9 +1116,9 @@ const ( StorageClassGlacierIr StorageClass = "GLACIER_IR" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "STANDARD", @@ -1138,8 +1140,8 @@ const ( StorageClassAnalysisSchemaVersionV1 StorageClassAnalysisSchemaVersion = "V_1" ) -// Values returns all known values for StorageClassAnalysisSchemaVersion. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for StorageClassAnalysisSchemaVersion. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (StorageClassAnalysisSchemaVersion) Values() []StorageClassAnalysisSchemaVersion { diff --git a/service/s3/types/errors.go b/service/s3/types/errors.go index 18134c52df4..f3837866d10 100644 --- a/service/s3/types/errors.go +++ b/service/s3/types/errors.go @@ -34,11 +34,11 @@ func (e *BucketAlreadyExists) ErrorCode() string { } func (e *BucketAlreadyExists) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The bucket you tried to create already exists, and you own it. Amazon S3 returns -// this error in all Amazon Web Services Regions except in the North Virginia -// Region. For legacy compatibility, if you re-create an existing bucket that you -// already own in the North Virginia Region, Amazon S3 returns 200 OK and resets -// the bucket access control lists (ACLs). +// The bucket you tried to create already exists, and you own it. Amazon S3 +// returns this error in all Amazon Web Services Regions except in the North +// Virginia Region. For legacy compatibility, if you re-create an existing bucket +// that you already own in the North Virginia Region, Amazon S3 returns 200 OK and +// resets the bucket access control lists (ACLs). type BucketAlreadyOwnedByYou struct { Message *string diff --git a/service/s3/types/types.go b/service/s3/types/types.go index eaa10d91a0e..a5aa64e33ca 100644 --- a/service/s3/types/types.go +++ b/service/s3/types/types.go @@ -9,9 +9,8 @@ import ( // Specifies the days since the initiation of an incomplete multipart upload that // Amazon S3 will wait before permanently removing all parts of the upload. For -// more information, see Aborting Incomplete Multipart Uploads Using a Bucket -// Lifecycle Policy -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) +// more information, see Aborting Incomplete Multipart Uploads Using a Bucket +// Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) // in the Amazon S3 User Guide. type AbortIncompleteMultipartUpload struct { @@ -23,9 +22,8 @@ type AbortIncompleteMultipartUpload struct { } // Configures the transfer acceleration state for an Amazon S3 bucket. For more -// information, see Amazon S3 Transfer Acceleration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in -// the Amazon S3 User Guide. +// information, see Amazon S3 Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) +// in the Amazon S3 User Guide. type AccelerateConfiguration struct { // Specifies the transfer acceleration status of the bucket. @@ -50,8 +48,7 @@ type AccessControlPolicy struct { type AccessControlTranslation struct { // Specifies the replica ownership. For default and valid values, see PUT bucket - // replication - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) + // replication (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) // in the Amazon S3 API Reference. // // This member is required. @@ -60,9 +57,10 @@ type AccessControlTranslation struct { noSmithyDocumentSerde } -// A conjunction (logical AND) of predicates, which is used in evaluating a metrics -// filter. The operator must have at least two predicates in any combination, and -// an object must match all of the predicates for the filter to apply. +// A conjunction (logical AND) of predicates, which is used in evaluating a +// metrics filter. The operator must have at least two predicates in any +// combination, and an object must match all of the predicates for the filter to +// apply. type AnalyticsAndOperator struct { // The prefix to use when evaluating an AND predicate: The prefix that an object @@ -191,9 +189,8 @@ type Bucket struct { } // Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For -// more information, see Object Lifecycle Management -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in -// the Amazon S3 User Guide. +// more information, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// in the Amazon S3 User Guide. type BucketLifecycleConfiguration struct { // A lifecycle rule for individual objects in an Amazon S3 bucket. @@ -207,10 +204,9 @@ type BucketLifecycleConfiguration struct { // Container for logging status information. type BucketLoggingStatus struct { - // Describes where logs are stored and the prefix that Amazon S3 assigns to all log - // object keys for a bucket. For more information, see PUT Bucket logging - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in - // the Amazon S3 API Reference. + // Describes where logs are stored and the prefix that Amazon S3 assigns to all + // log object keys for a bucket. For more information, see PUT Bucket logging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) + // in the Amazon S3 API Reference. LoggingEnabled *LoggingEnabled noSmithyDocumentSerde @@ -222,43 +218,39 @@ type Checksum struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string noSmithyDocumentSerde } -// Container for all (if there are any) keys between Prefix and the next occurrence -// of the string specified by a delimiter. CommonPrefixes lists keys that act like -// subdirectories in the directory specified by Prefix. For example, if the prefix -// is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common -// prefix is notes/summer/. +// Container for all (if there are any) keys between Prefix and the next +// occurrence of the string specified by a delimiter. CommonPrefixes lists keys +// that act like subdirectories in the directory specified by Prefix. For example, +// if the prefix is notes/ and the delimiter is a slash (/) as in +// notes/summer/july, the common prefix is notes/summer/. type CommonPrefix struct { // Container for the specified common prefix. @@ -283,32 +275,28 @@ type CompletedPart struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -336,15 +324,15 @@ type Condition struct { HttpErrorCodeReturnedEquals *string // The object key name prefix when the redirect is applied. For example, to - // redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. - // To redirect request for all pages with the prefix docs/, the key prefix will be - // /docs, which identifies all objects in the docs/ folder. Required when the - // parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is - // not specified. If both conditions are specified, both must be true for the + // redirect requests for ExamplePage.html , the key prefix will be ExamplePage.html + // . To redirect request for all pages with the prefix docs/ , the key prefix will + // be /docs , which identifies all objects in the docs/ folder. Required when the + // parent element Condition is specified and sibling HttpErrorCodeReturnedEquals + // is not specified. If both conditions are specified, both must be true for the // redirect to be applied. Replacement must be made for object keys containing // special characters (such as carriage returns) when using XML requests. For more - // information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . KeyPrefixEquals *string noSmithyDocumentSerde @@ -360,32 +348,28 @@ type CopyObjectResult struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -405,32 +389,28 @@ type CopyPartResult struct { // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -444,9 +424,8 @@ type CopyPartResult struct { } // Describes the cross-origin access configuration for objects in an Amazon S3 -// bucket. For more information, see Enabling Cross-Origin Resource Sharing -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon S3 -// User Guide. +// bucket. For more information, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) +// in the Amazon S3 User Guide. type CORSConfiguration struct { // A set of origins and methods (cross-origin access that you want to allow). You @@ -461,8 +440,8 @@ type CORSConfiguration struct { // Specifies a cross-origin access rule for an Amazon S3 bucket. type CORSRule struct { - // An HTTP method that you allow the origin to execute. Valid values are GET, PUT, - // HEAD, POST, and DELETE. + // An HTTP method that you allow the origin to execute. Valid values are GET , PUT + // , HEAD , POST , and DELETE . // // This member is required. AllowedMethods []string @@ -477,15 +456,16 @@ type CORSRule struct { // OPTIONS request, Amazon S3 returns any requested headers that are allowed. AllowedHeaders []string - // One or more headers in the response that you want customers to be able to access - // from their applications (for example, from a JavaScript XMLHttpRequest object). + // One or more headers in the response that you want customers to be able to + // access from their applications (for example, from a JavaScript XMLHttpRequest + // object). ExposeHeaders []string // Unique identifier for the rule. The value cannot be longer than 255 characters. ID *string - // The time in seconds that your browser is to cache the preflight response for the - // specified resource. + // The time in seconds that your browser is to cache the preflight response for + // the specified resource. MaxAgeSeconds int32 noSmithyDocumentSerde @@ -512,7 +492,7 @@ type CSVInput struct { // A single character used to indicate that a row should be ignored when the // character is present at the start of that row. You can specify any character to - // indicate a comment line. The default character is #. Default: # + // indicate a comment line. The default character is # . Default: # Comments *string // A single character used to separate individual fields in a record. You can @@ -520,27 +500,22 @@ type CSVInput struct { FieldDelimiter *string // Describes the first line of input. Valid values are: - // - // * NONE: First line is not - // a header. - // - // * IGNORE: First line is a header, but you can't use the header values - // to indicate the column in an expression. You can use column position (such as - // _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s). - // - // * Use: First - // line is a header, and you can use the header value to identify a column in an - // expression (SELECT "name" FROM OBJECT). + // - NONE : First line is not a header. + // - IGNORE : First line is a header, but you can't use the header values to + // indicate the column in an expression. You can use column position (such as _1, + // _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s ). + // - Use : First line is a header, and you can use the header value to identify a + // column in an expression ( SELECT "name" FROM OBJECT ). FileHeaderInfo FileHeaderInfo // A single character used for escaping when the field delimiter is part of the - // value. For example, if the value is a, b, Amazon S3 wraps this field value in - // quotation marks, as follows: " a , b ". Type: String Default: " Ancestors: CSV + // value. For example, if the value is a, b , Amazon S3 wraps this field value in + // quotation marks, as follows: " a , b " . Type: String Default: " Ancestors: CSV QuoteCharacter *string // A single character used for escaping the quotation mark character inside an - // already escaped value. For example, the value """ a , b """ is parsed as " a , b - // ". + // already escaped value. For example, the value """ a , b """ is parsed as " a , + // b " . QuoteEscapeCharacter *string // A single character used to separate individual records in the input. Instead of @@ -559,8 +534,8 @@ type CSVOutput struct { FieldDelimiter *string // A single character used for escaping when the field delimiter is part of the - // value. For example, if the value is a, b, Amazon S3 wraps this field value in - // quotation marks, as follows: " a , b ". + // value. For example, if the value is a, b , Amazon S3 wraps this field value in + // quotation marks, as follows: " a , b " . QuoteCharacter *string // The single character used for escaping the quote character inside an already @@ -568,16 +543,12 @@ type CSVOutput struct { QuoteEscapeCharacter *string // Indicates whether to use quotation marks around output fields. - // - // * ALWAYS: Always - // use quotation marks for output fields. - // - // * ASNEEDED: Use quotation marks for - // output fields when needed. + // - ALWAYS : Always use quotation marks for output fields. + // - ASNEEDED : Use quotation marks for output fields when needed. QuoteFields QuoteFields - // A single character used to separate individual records in the output. Instead of - // the default value, you can specify an arbitrary delimiter. + // A single character used to separate individual records in the output. Instead + // of the default value, you can specify an arbitrary delimiter. RecordDelimiter *string noSmithyDocumentSerde @@ -585,25 +556,21 @@ type CSVOutput struct { // The container element for specifying the default Object Lock retention settings // for new objects placed in the specified bucket. -// -// * The DefaultRetention settings -// require both a mode and a period. -// -// * The DefaultRetention period can be either -// Days or Years but you must select one. You cannot specify Days and Years at the -// same time. +// - The DefaultRetention settings require both a mode and a period. +// - The DefaultRetention period can be either Days or Years but you must select +// one. You cannot specify Days and Years at the same time. type DefaultRetention struct { // The number of days that you want to specify for the default retention period. - // Must be used with Mode. + // Must be used with Mode . Days int32 // The default Object Lock retention mode you want to apply to new objects placed - // in the specified bucket. Must be used with either Days or Years. + // in the specified bucket. Must be used with either Days or Years . Mode ObjectLockRetentionMode // The number of years that you want to specify for the default retention period. - // Must be used with Mode. + // Must be used with Mode . Years int32 noSmithyDocumentSerde @@ -632,9 +599,9 @@ type DeletedObject struct { // whether (true) or not (false) a delete marker was created. DeleteMarker bool - // The version ID of the delete marker created as a result of the DELETE operation. - // If you delete a specific object version, the value returned by this header is - // the version ID of the object version deleted. + // The version ID of the delete marker created as a result of the DELETE + // operation. If you delete a specific object version, the value returned by this + // header is the version ID of the object version deleted. DeleteMarkerVersionId *string // The name of the deleted object. @@ -671,17 +638,15 @@ type DeleteMarkerEntry struct { // Specifies whether Amazon S3 replicates delete markers. If you specify a Filter // in your replication configuration, you must also include a // DeleteMarkerReplication element. If your Filter includes a Tag element, the -// DeleteMarkerReplicationStatus must be set to Disabled, because Amazon S3 does +// DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does // not support replicating delete markers for tag-based rules. For an example -// configuration, see Basic Rule Configuration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). -// For more information about delete marker replication, see Basic Rule -// Configuration -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). -// If you are using an earlier version of the replication configuration, Amazon S3 -// handles replication of delete markers differently. For more information, see -// Backward Compatibility -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). +// configuration, see Basic Rule Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config) +// . For more information about delete marker replication, see Basic Rule +// Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html) +// . If you are using an earlier version of the replication configuration, Amazon +// S3 handles replication of delete markers differently. For more information, see +// Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations) +// . type DeleteMarkerReplication struct { // Indicates whether to replicate delete markers. Indicates whether to replicate @@ -710,10 +675,10 @@ type Destination struct { // Destination bucket owner account ID. In a cross-account scenario, if you direct // Amazon S3 to change replica ownership to the Amazon Web Services account that - // owns the destination bucket by specifying the AccessControlTranslation property, - // this is the account ID of the destination bucket owner. For more information, - // see Replication Additional Configuration: Changing the Replica Owner - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html) + // owns the destination bucket by specifying the AccessControlTranslation + // property, this is the account ID of the destination bucket owner. For more + // information, see Replication Additional Configuration: Changing the Replica + // Owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html) // in the Amazon S3 User Guide. Account *string @@ -721,8 +686,8 @@ type Destination struct { // SourceSelectionCriteria is specified, you must specify this element. EncryptionConfiguration *EncryptionConfiguration - // A container specifying replication metrics-related settings enabling replication - // metrics and events. + // A container specifying replication metrics-related settings enabling + // replication metrics and events. Metrics *Metrics // A container specifying S3 Replication Time Control (S3 RTC), including whether @@ -733,8 +698,7 @@ type Destination struct { // The storage class to use when replicating objects, such as S3 Standard or // reduced redundancy. By default, Amazon S3 uses the storage class of the source // object to create the object replica. For valid values, see the StorageClass - // element of the PUT Bucket replication - // (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) + // element of the PUT Bucket replication (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) // action in the Amazon S3 API Reference. StorageClass StorageClass @@ -745,20 +709,19 @@ type Destination struct { type Encryption struct { // The server-side encryption algorithm used when storing job results in Amazon S3 - // (for example, AES256, aws:kms). + // (for example, AES256, aws:kms ). // // This member is required. EncryptionType ServerSideEncryption - // If the encryption type is aws:kms, this optional value can be used to specify + // If the encryption type is aws:kms , this optional value can be used to specify // the encryption context for the restore results. KMSContext *string - // If the encryption type is aws:kms, this optional value specifies the ID of the + // If the encryption type is aws:kms , this optional value specifies the ID of the // symmetric encryption customer managed key to use for encryption of job results. // Amazon S3 only supports symmetric encryption KMS keys. For more information, see - // Asymmetric keys in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // Asymmetric keys in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Amazon Web Services Key Management Service Developer Guide. KMSKeyId *string @@ -773,8 +736,7 @@ type EncryptionConfiguration struct { // Services KMS key stored in Amazon Web Services Key Management Service (KMS) for // the destination bucket. Amazon S3 uses this key to encrypt replica objects. // Amazon S3 only supports symmetric encryption KMS keys. For more information, see - // Asymmetric keys in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // Asymmetric keys in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Amazon Web Services Key Management Service Developer Guide. ReplicaKmsKeyID *string @@ -783,7 +745,7 @@ type EncryptionConfiguration struct { // A message that indicates the request is complete and no more messages will be // sent. You should not assume that the request is complete until the client -// receives an EndEvent. +// receives an EndEvent . type EndEvent struct { noSmithyDocumentSerde } @@ -794,933 +756,412 @@ type Error struct { // The error code is a string that uniquely identifies an error condition. It is // meant to be read and understood by programs that detect and handle errors by // type. Amazon S3 error codes - // - // * Code: AccessDenied - // - // * Description: Access - // Denied - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * - // Code: AccountProblem - // - // * Description: There is a problem with your Amazon Web - // Services account that prevents the action from completing successfully. Contact - // Amazon Web Services Support for further assistance. - // - // * HTTP Status Code: 403 - // Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * Code: AllAccessDisabled - // - // * - // Description: All access to this Amazon S3 resource has been disabled. Contact - // Amazon Web Services Support for further assistance. - // - // * HTTP Status Code: 403 - // Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // AmbiguousGrantByEmailAddress - // - // * Description: The email address you provided is - // associated with more than one account. - // - // * HTTP Status Code: 400 Bad Request - // - // * - // SOAP Fault Code Prefix: Client - // - // * Code: AuthorizationHeaderMalformed - // - // * - // Description: The authorization header you provided is invalid. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * HTTP Status Code: N/A - // - // * Code: BadDigest - // - // * - // Description: The Content-MD5 you specified did not match what we received. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // BucketAlreadyExists - // - // * Description: The requested bucket name is not available. - // The bucket namespace is shared by all users of the system. Please select a - // different name and try again. - // - // * HTTP Status Code: 409 Conflict - // - // * SOAP Fault - // Code Prefix: Client - // - // * Code: BucketAlreadyOwnedByYou - // - // * Description: The bucket - // you tried to create already exists, and you own it. Amazon S3 returns this error - // in all Amazon Web Services Regions except in the North Virginia Region. For - // legacy compatibility, if you re-create an existing bucket that you already own - // in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket - // access control lists (ACLs). - // - // * Code: 409 Conflict (in all Regions except the - // North Virginia Region) - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // BucketNotEmpty - // - // * Description: The bucket you tried to delete is not empty. - // - // * - // HTTP Status Code: 409 Conflict - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // CredentialsNotSupported - // - // * Description: This request does not support - // credentials. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: CrossLocationLoggingProhibited - // - // * Description: Cross-location - // logging not allowed. Buckets in one geographic location cannot log information - // to a bucket in another location. - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP - // Fault Code Prefix: Client - // - // * Code: EntityTooSmall - // - // * Description: Your proposed - // upload is smaller than the minimum allowed object size. - // - // * HTTP Status Code: 400 - // Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: EntityTooLarge - // - // * - // Description: Your proposed upload exceeds the maximum allowed object size. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // ExpiredToken - // - // * Description: The provided token has expired. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // IllegalVersioningConfigurationException - // - // * Description: Indicates that the - // versioning configuration specified in the request is invalid. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // IncompleteBody - // - // * Description: You did not provide the number of bytes specified - // by the Content-Length HTTP header - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP - // Fault Code Prefix: Client - // - // * Code: IncorrectNumberOfFilesInPostRequest - // - // * - // Description: POST requires exactly one file upload per request. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InlineDataTooLarge - // - // * Description: Inline data exceeds the maximum allowed - // size. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * - // Code: InternalError - // - // * Description: We encountered an internal error. Please try - // again. - // - // * HTTP Status Code: 500 Internal Server Error - // - // * SOAP Fault Code Prefix: - // Server - // - // * Code: InvalidAccessKeyId - // - // * Description: The Amazon Web Services - // access key ID you provided does not exist in our records. - // - // * HTTP Status Code: - // 403 Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidAddressingHeader - // - // * Description: You must specify the Anonymous role. - // - // * - // HTTP Status Code: N/A - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidArgument - // - // * Description: Invalid Argument - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidBucketName - // - // * - // Description: The specified bucket is not valid. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidBucketState - // - // * - // Description: The request is not valid with the current state of the bucket. - // - // * - // HTTP Status Code: 409 Conflict - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidDigest - // - // * Description: The Content-MD5 you specified is not valid. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidEncryptionAlgorithmError - // - // * Description: The encryption request you - // specified is not valid. The valid value is AES256. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidLocationConstraint - // - // * - // Description: The specified location constraint is not valid. For more - // information about Regions, see How to Select a Region for Your Buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro). - // - // * - // HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidObjectState - // - // * Description: The action is not valid for the current state - // of the object. - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: InvalidPart - // - // * Description: One or more of the specified parts - // could not be found. The part might not have been uploaded, or the specified - // entity tag might not have matched the part's entity tag. - // - // * HTTP Status Code: - // 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidPartOrder - // - // * - // Description: The list of parts was not in ascending order. Parts list must be - // specified in order by part number. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP - // Fault Code Prefix: Client - // - // * Code: InvalidPayer - // - // * Description: All access to - // this object has been disabled. Please contact Amazon Web Services Support for - // further assistance. - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP Fault Code - // Prefix: Client - // - // * Code: InvalidPolicyDocument - // - // * Description: The content of the - // form does not meet the conditions specified in the policy document. - // - // * HTTP - // Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidRange - // - // * Description: The requested range cannot be satisfied. - // - // * HTTP - // Status Code: 416 Requested Range Not Satisfiable - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: InvalidRequest - // - // * Description: Please use AWS4-HMAC-SHA256. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: InvalidRequest - // - // * - // Description: SOAP requests must be made over an HTTPS connection. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidRequest - // - // * Description: Amazon S3 Transfer Acceleration is not supported - // for buckets with non-DNS compliant names. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * Code: N/A - // - // * Code: InvalidRequest - // - // * Description: Amazon S3 Transfer - // Acceleration is not supported for buckets with periods (.) in their names. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: InvalidRequest - // - // * - // Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style - // requests. - // - // * HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: - // InvalidRequest - // - // * Description: Amazon S3 Transfer Accelerate is not configured - // on this bucket. - // - // * HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: - // InvalidRequest - // - // * Description: Amazon S3 Transfer Accelerate is disabled on this - // bucket. - // - // * HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: - // InvalidRequest - // - // * Description: Amazon S3 Transfer Acceleration is not supported - // on this bucket. Contact Amazon Web Services Support for more information. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * Code: N/A - // - // * Code: InvalidRequest - // - // * - // Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. - // Contact Amazon Web Services Support for more information. - // - // * HTTP Status Code: - // 400 Bad Request - // - // * Code: N/A - // - // * Code: InvalidSecurity - // - // * Description: The - // provided security credentials are not valid. - // - // * HTTP Status Code: 403 - // Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidSOAPRequest - // - // * - // Description: The SOAP request body is invalid. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: InvalidStorageClass - // - // * - // Description: The storage class you specified is not valid. - // - // * HTTP Status Code: - // 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // InvalidTargetBucketForLogging - // - // * Description: The target bucket for logging does - // not exist, is not owned by you, or does not have the appropriate grants for the - // log-delivery group. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code - // Prefix: Client - // - // * Code: InvalidToken - // - // * Description: The provided token is - // malformed or otherwise invalid. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP - // Fault Code Prefix: Client - // - // * Code: InvalidURI - // - // * Description: Couldn't parse the - // specified URI. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: KeyTooLongError - // - // * Description: Your key is too long. - // - // * HTTP - // Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // MalformedACLError - // - // * Description: The XML you provided was not well-formed or - // did not validate against our published schema. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: MalformedPOSTRequest - // - // * - // Description: The body of your POST request is not well-formed - // multipart/form-data. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code - // Prefix: Client - // - // * Code: MalformedXML - // - // * Description: This happens when the user - // sends malformed XML (XML that doesn't conform to the published XSD) for the - // configuration. The error message is, "The XML you provided was not well-formed - // or did not validate against our published schema." - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: MaxMessageLengthExceeded - // - // * - // Description: Your request was too big. - // - // * HTTP Status Code: 400 Bad Request - // - // * - // SOAP Fault Code Prefix: Client - // - // * Code: MaxPostPreDataLengthExceededError - // - // * - // Description: Your POST request fields preceding the upload file were too - // large. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * - // Code: MetadataTooLarge - // - // * Description: Your metadata headers exceed the maximum - // allowed metadata size. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code - // Prefix: Client - // - // * Code: MethodNotAllowed - // - // * Description: The specified method is - // not allowed against this resource. - // - // * HTTP Status Code: 405 Method Not - // Allowed - // - // * SOAP Fault Code Prefix: Client - // - // * Code: MissingAttachment - // - // * - // Description: A SOAP attachment was expected, but none were found. - // - // * HTTP Status - // Code: N/A - // - // * SOAP Fault Code Prefix: Client - // - // * Code: MissingContentLength - // - // * - // Description: You must provide the Content-Length HTTP header. - // - // * HTTP Status - // Code: 411 Length Required - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // MissingRequestBodyError - // - // * Description: This happens when the user sends an - // empty XML document as a request. The error message is, "Request body is - // empty." - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: MissingSecurityElement - // - // * Description: The SOAP 1.1 request is - // missing a security element. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault - // Code Prefix: Client - // - // * Code: MissingSecurityHeader - // - // * Description: Your request - // is missing a required header. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault - // Code Prefix: Client - // - // * Code: NoLoggingStatusForKey - // - // * Description: There is no - // such thing as a logging status subresource for a key. - // - // * HTTP Status Code: 400 - // Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NoSuchBucket - // - // * - // Description: The specified bucket does not exist. - // - // * HTTP Status Code: 404 Not - // Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NoSuchBucketPolicy - // - // * - // Description: The specified bucket does not have a bucket policy. - // - // * HTTP Status - // Code: 404 Not Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NoSuchKey - // - // * - // Description: The specified key does not exist. - // - // * HTTP Status Code: 404 Not - // Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NoSuchLifecycleConfiguration - // - // * - // Description: The lifecycle configuration does not exist. - // - // * HTTP Status Code: - // 404 Not Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NoSuchUpload - // - // * - // Description: The specified multipart upload does not exist. The upload ID might - // be invalid, or the multipart upload might have been aborted or completed. - // - // * - // HTTP Status Code: 404 Not Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // NoSuchVersion - // - // * Description: Indicates that the version ID specified in the - // request does not match an existing version. - // - // * HTTP Status Code: 404 Not - // Found - // - // * SOAP Fault Code Prefix: Client - // - // * Code: NotImplemented - // - // * Description: - // A header you provided implies functionality that is not implemented. - // - // * HTTP - // Status Code: 501 Not Implemented - // - // * SOAP Fault Code Prefix: Server - // - // * Code: - // NotSignedUp - // - // * Description: Your account is not signed up for the Amazon S3 - // service. You must sign up before you can use Amazon S3. You can sign up at the - // following URL: Amazon S3 (http://aws.amazon.com/s3) - // - // * HTTP Status Code: 403 - // Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * Code: OperationAborted - // - // * - // Description: A conflicting conditional action is currently in progress against - // this resource. Try again. - // - // * HTTP Status Code: 409 Conflict - // - // * SOAP Fault Code - // Prefix: Client - // - // * Code: PermanentRedirect - // - // * Description: The bucket you are - // attempting to access must be addressed using the specified endpoint. Send all - // future requests to this endpoint. - // - // * HTTP Status Code: 301 Moved Permanently - // - // * - // SOAP Fault Code Prefix: Client - // - // * Code: PreconditionFailed - // - // * Description: At - // least one of the preconditions you specified did not hold. - // - // * HTTP Status Code: - // 412 Precondition Failed - // - // * SOAP Fault Code Prefix: Client - // - // * Code: Redirect - // - // * - // Description: Temporary redirect. - // - // * HTTP Status Code: 307 Moved Temporarily - // - // * - // SOAP Fault Code Prefix: Client - // - // * Code: RestoreAlreadyInProgress - // - // * Description: - // Object restore is already in progress. - // - // * HTTP Status Code: 409 Conflict - // - // * SOAP - // Fault Code Prefix: Client - // - // * Code: RequestIsNotMultiPartContent - // - // * Description: - // Bucket POST must be of the enclosure-type multipart/form-data. - // - // * HTTP Status - // Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // RequestTimeout - // - // * Description: Your socket connection to the server was not read - // from or written to within the timeout period. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: RequestTimeTooSkewed - // - // * - // Description: The difference between the request time and the server's time is - // too large. - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: RequestTorrentOfBucketError - // - // * Description: Requesting the - // torrent file of a bucket is not permitted. - // - // * HTTP Status Code: 400 Bad - // Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: SignatureDoesNotMatch - // - // * - // Description: The request signature we calculated does not match the signature - // you provided. Check your Amazon Web Services secret access key and signing - // method. For more information, see REST Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) and - // SOAP Authentication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html) for - // details. - // - // * HTTP Status Code: 403 Forbidden - // - // * SOAP Fault Code Prefix: Client - // - // * - // Code: ServiceUnavailable - // - // * Description: Service is unable to handle request. - // - // * - // HTTP Status Code: 503 Service Unavailable - // - // * SOAP Fault Code Prefix: Server - // - // * - // Code: SlowDown - // - // * Description: Reduce your request rate. - // - // * HTTP Status Code: - // 503 Slow Down - // - // * SOAP Fault Code Prefix: Server - // - // * Code: TemporaryRedirect - // - // * - // Description: You are being redirected to the bucket while DNS updates. - // - // * HTTP - // Status Code: 307 Moved Temporarily - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // TokenRefreshRequired - // - // * Description: The provided token must be refreshed. - // - // * - // HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // TooManyBuckets - // - // * Description: You have attempted to create more buckets than - // allowed. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: UnexpectedContent - // - // * Description: This request does not support - // content. - // - // * HTTP Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: - // Client - // - // * Code: UnresolvableGrantByEmailAddress - // - // * Description: The email - // address you provided does not match any account on record. - // - // * HTTP Status Code: - // 400 Bad Request - // - // * SOAP Fault Code Prefix: Client - // - // * Code: - // UserKeyMustBeSpecified - // - // * Description: The bucket POST must contain the - // specified field name. If it is specified, check the order of the fields. - // - // * HTTP - // Status Code: 400 Bad Request - // - // * SOAP Fault Code Prefix: Client + // - Code: AccessDenied + // - Description: Access Denied + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: AccountProblem + // - Description: There is a problem with your Amazon Web Services account that + // prevents the action from completing successfully. Contact Amazon Web Services + // Support for further assistance. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: AllAccessDisabled + // - Description: All access to this Amazon S3 resource has been disabled. + // Contact Amazon Web Services Support for further assistance. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: AmbiguousGrantByEmailAddress + // - Description: The email address you provided is associated with more than + // one account. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: AuthorizationHeaderMalformed + // - Description: The authorization header you provided is invalid. + // - HTTP Status Code: 400 Bad Request + // - HTTP Status Code: N/A + // - Code: BadDigest + // - Description: The Content-MD5 you specified did not match what we received. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: BucketAlreadyExists + // - Description: The requested bucket name is not available. The bucket + // namespace is shared by all users of the system. Please select a different name + // and try again. + // - HTTP Status Code: 409 Conflict + // - SOAP Fault Code Prefix: Client + // - Code: BucketAlreadyOwnedByYou + // - Description: The bucket you tried to create already exists, and you own it. + // Amazon S3 returns this error in all Amazon Web Services Regions except in the + // North Virginia Region. For legacy compatibility, if you re-create an existing + // bucket that you already own in the North Virginia Region, Amazon S3 returns 200 + // OK and resets the bucket access control lists (ACLs). + // - Code: 409 Conflict (in all Regions except the North Virginia Region) + // - SOAP Fault Code Prefix: Client + // - Code: BucketNotEmpty + // - Description: The bucket you tried to delete is not empty. + // - HTTP Status Code: 409 Conflict + // - SOAP Fault Code Prefix: Client + // - Code: CredentialsNotSupported + // - Description: This request does not support credentials. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: CrossLocationLoggingProhibited + // - Description: Cross-location logging not allowed. Buckets in one geographic + // location cannot log information to a bucket in another location. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: EntityTooSmall + // - Description: Your proposed upload is smaller than the minimum allowed + // object size. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: EntityTooLarge + // - Description: Your proposed upload exceeds the maximum allowed object size. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: ExpiredToken + // - Description: The provided token has expired. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: IllegalVersioningConfigurationException + // - Description: Indicates that the versioning configuration specified in the + // request is invalid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: IncompleteBody + // - Description: You did not provide the number of bytes specified by the + // Content-Length HTTP header + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: IncorrectNumberOfFilesInPostRequest + // - Description: POST requires exactly one file upload per request. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InlineDataTooLarge + // - Description: Inline data exceeds the maximum allowed size. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InternalError + // - Description: We encountered an internal error. Please try again. + // - HTTP Status Code: 500 Internal Server Error + // - SOAP Fault Code Prefix: Server + // - Code: InvalidAccessKeyId + // - Description: The Amazon Web Services access key ID you provided does not + // exist in our records. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: InvalidAddressingHeader + // - Description: You must specify the Anonymous role. + // - HTTP Status Code: N/A + // - SOAP Fault Code Prefix: Client + // - Code: InvalidArgument + // - Description: Invalid Argument + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidBucketName + // - Description: The specified bucket is not valid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidBucketState + // - Description: The request is not valid with the current state of the bucket. + // - HTTP Status Code: 409 Conflict + // - SOAP Fault Code Prefix: Client + // - Code: InvalidDigest + // - Description: The Content-MD5 you specified is not valid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidEncryptionAlgorithmError + // - Description: The encryption request you specified is not valid. The valid + // value is AES256. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidLocationConstraint + // - Description: The specified location constraint is not valid. For more + // information about Regions, see How to Select a Region for Your Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) + // . + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidObjectState + // - Description: The action is not valid for the current state of the object. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: InvalidPart + // - Description: One or more of the specified parts could not be found. The + // part might not have been uploaded, or the specified entity tag might not have + // matched the part's entity tag. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidPartOrder + // - Description: The list of parts was not in ascending order. Parts list must + // be specified in order by part number. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidPayer + // - Description: All access to this object has been disabled. Please contact + // Amazon Web Services Support for further assistance. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: InvalidPolicyDocument + // - Description: The content of the form does not meet the conditions specified + // in the policy document. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidRange + // - Description: The requested range cannot be satisfied. + // - HTTP Status Code: 416 Requested Range Not Satisfiable + // - SOAP Fault Code Prefix: Client + // - Code: InvalidRequest + // - Description: Please use AWS4-HMAC-SHA256 . + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: SOAP requests must be made over an HTTPS connection. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Acceleration is not supported for buckets + // with non-DNS compliant names. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Acceleration is not supported for buckets + // with periods (.) in their names. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Accelerate endpoint only supports virtual + // style requests. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Accelerate is not configured on this + // bucket. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Accelerate is disabled on this bucket. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Acceleration is not supported on this + // bucket. Contact Amazon Web Services Support for more information. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidRequest + // - Description: Amazon S3 Transfer Acceleration cannot be enabled on this + // bucket. Contact Amazon Web Services Support for more information. + // - HTTP Status Code: 400 Bad Request + // - Code: N/A + // - Code: InvalidSecurity + // - Description: The provided security credentials are not valid. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: InvalidSOAPRequest + // - Description: The SOAP request body is invalid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidStorageClass + // - Description: The storage class you specified is not valid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidTargetBucketForLogging + // - Description: The target bucket for logging does not exist, is not owned by + // you, or does not have the appropriate grants for the log-delivery group. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidToken + // - Description: The provided token is malformed or otherwise invalid. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: InvalidURI + // - Description: Couldn't parse the specified URI. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: KeyTooLongError + // - Description: Your key is too long. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MalformedACLError + // - Description: The XML you provided was not well-formed or did not validate + // against our published schema. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MalformedPOSTRequest + // - Description: The body of your POST request is not well-formed + // multipart/form-data. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MalformedXML + // - Description: This happens when the user sends malformed XML (XML that + // doesn't conform to the published XSD) for the configuration. The error message + // is, "The XML you provided was not well-formed or did not validate against our + // published schema." + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MaxMessageLengthExceeded + // - Description: Your request was too big. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MaxPostPreDataLengthExceededError + // - Description: Your POST request fields preceding the upload file were too + // large. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MetadataTooLarge + // - Description: Your metadata headers exceed the maximum allowed metadata + // size. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MethodNotAllowed + // - Description: The specified method is not allowed against this resource. + // - HTTP Status Code: 405 Method Not Allowed + // - SOAP Fault Code Prefix: Client + // - Code: MissingAttachment + // - Description: A SOAP attachment was expected, but none were found. + // - HTTP Status Code: N/A + // - SOAP Fault Code Prefix: Client + // - Code: MissingContentLength + // - Description: You must provide the Content-Length HTTP header. + // - HTTP Status Code: 411 Length Required + // - SOAP Fault Code Prefix: Client + // - Code: MissingRequestBodyError + // - Description: This happens when the user sends an empty XML document as a + // request. The error message is, "Request body is empty." + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MissingSecurityElement + // - Description: The SOAP 1.1 request is missing a security element. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: MissingSecurityHeader + // - Description: Your request is missing a required header. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: NoLoggingStatusForKey + // - Description: There is no such thing as a logging status subresource for a + // key. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchBucket + // - Description: The specified bucket does not exist. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchBucketPolicy + // - Description: The specified bucket does not have a bucket policy. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchKey + // - Description: The specified key does not exist. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchLifecycleConfiguration + // - Description: The lifecycle configuration does not exist. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchUpload + // - Description: The specified multipart upload does not exist. The upload ID + // might be invalid, or the multipart upload might have been aborted or completed. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NoSuchVersion + // - Description: Indicates that the version ID specified in the request does + // not match an existing version. + // - HTTP Status Code: 404 Not Found + // - SOAP Fault Code Prefix: Client + // - Code: NotImplemented + // - Description: A header you provided implies functionality that is not + // implemented. + // - HTTP Status Code: 501 Not Implemented + // - SOAP Fault Code Prefix: Server + // - Code: NotSignedUp + // - Description: Your account is not signed up for the Amazon S3 service. You + // must sign up before you can use Amazon S3. You can sign up at the following URL: + // Amazon S3 (http://aws.amazon.com/s3) + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: OperationAborted + // - Description: A conflicting conditional action is currently in progress + // against this resource. Try again. + // - HTTP Status Code: 409 Conflict + // - SOAP Fault Code Prefix: Client + // - Code: PermanentRedirect + // - Description: The bucket you are attempting to access must be addressed + // using the specified endpoint. Send all future requests to this endpoint. + // - HTTP Status Code: 301 Moved Permanently + // - SOAP Fault Code Prefix: Client + // - Code: PreconditionFailed + // - Description: At least one of the preconditions you specified did not hold. + // - HTTP Status Code: 412 Precondition Failed + // - SOAP Fault Code Prefix: Client + // - Code: Redirect + // - Description: Temporary redirect. + // - HTTP Status Code: 307 Moved Temporarily + // - SOAP Fault Code Prefix: Client + // - Code: RestoreAlreadyInProgress + // - Description: Object restore is already in progress. + // - HTTP Status Code: 409 Conflict + // - SOAP Fault Code Prefix: Client + // - Code: RequestIsNotMultiPartContent + // - Description: Bucket POST must be of the enclosure-type multipart/form-data. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: RequestTimeout + // - Description: Your socket connection to the server was not read from or + // written to within the timeout period. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: RequestTimeTooSkewed + // - Description: The difference between the request time and the server's time + // is too large. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: RequestTorrentOfBucketError + // - Description: Requesting the torrent file of a bucket is not permitted. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: SignatureDoesNotMatch + // - Description: The request signature we calculated does not match the + // signature you provided. Check your Amazon Web Services secret access key and + // signing method. For more information, see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) + // and SOAP Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html) + // for details. + // - HTTP Status Code: 403 Forbidden + // - SOAP Fault Code Prefix: Client + // - Code: ServiceUnavailable + // - Description: Service is unable to handle request. + // - HTTP Status Code: 503 Service Unavailable + // - SOAP Fault Code Prefix: Server + // - Code: SlowDown + // - Description: Reduce your request rate. + // - HTTP Status Code: 503 Slow Down + // - SOAP Fault Code Prefix: Server + // - Code: TemporaryRedirect + // - Description: You are being redirected to the bucket while DNS updates. + // - HTTP Status Code: 307 Moved Temporarily + // - SOAP Fault Code Prefix: Client + // - Code: TokenRefreshRequired + // - Description: The provided token must be refreshed. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: TooManyBuckets + // - Description: You have attempted to create more buckets than allowed. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: UnexpectedContent + // - Description: This request does not support content. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: UnresolvableGrantByEmailAddress + // - Description: The email address you provided does not match any account on + // record. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client + // - Code: UserKeyMustBeSpecified + // - Description: The bucket POST must contain the specified field name. If it + // is specified, check the order of the fields. + // - HTTP Status Code: 400 Bad Request + // - SOAP Fault Code Prefix: Client Code *string // The error key. @@ -1745,9 +1186,9 @@ type ErrorDocument struct { // The object key name to use when a 4XX class error occurs. Replacement must be // made for object keys containing special characters (such as carriage returns) - // when using XML requests. For more information, see XML related object key - // constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // when using XML requests. For more information, see XML related object key + // constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . // // This member is required. Key *string @@ -1761,8 +1202,7 @@ type EventBridgeConfiguration struct { } // Optional configuration to replicate existing source bucket objects. For more -// information, see Replicating Existing Objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication) +// information, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication) // in the Amazon S3 User Guide. type ExistingObjectReplication struct { @@ -1781,9 +1221,8 @@ type FilterRule struct { // The object key name prefix or suffix identifying one or more objects to which // the filtering rule applies. The maximum length is 1,024 characters. Overlapping // prefixes and suffixes are not supported. For more information, see Configuring - // Event Notifications - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. Name FilterRuleName // The value that the filter searches for in object key names. @@ -1855,32 +1294,19 @@ type Grantee struct { // Screen name of the grantee. DisplayName *string - // Email address of the grantee. Using email addresses to specify a grantee is only - // supported in the following Amazon Web Services Regions: - // - // * US East (N. - // Virginia) - // - // * US West (N. California) - // - // * US West (Oregon) - // - // * Asia Pacific - // (Singapore) - // - // * Asia Pacific (Sydney) - // - // * Asia Pacific (Tokyo) - // - // * Europe - // (Ireland) - // - // * South America (São Paulo) - // - // For a list of all the Amazon S3 - // supported Regions and endpoints, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the - // Amazon Web Services General Reference. + // Email address of the grantee. Using email addresses to specify a grantee is + // only supported in the following Amazon Web Services Regions: + // - US East (N. Virginia) + // - US West (N. California) + // - US West (Oregon) + // - Asia Pacific (Singapore) + // - Asia Pacific (Sydney) + // - Asia Pacific (Tokyo) + // - Europe (Ireland) + // - South America (São Paulo) + // For a list of all the Amazon S3 supported Regions and endpoints, see Regions + // and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) + // in the Amazon Web Services General Reference. EmailAddress *string // The canonical user ID of the grantee. @@ -1901,8 +1327,8 @@ type IndexDocument struct { // key name images/index.html) The suffix must not be empty and must not include a // slash character. Replacement must be made for object keys containing special // characters (such as carriage returns) when using XML requests. For more - // information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . // // This member is required. Suffix *string @@ -1942,8 +1368,8 @@ type InputSerialization struct { noSmithyDocumentSerde } -// A container for specifying S3 Intelligent-Tiering filters. The filters determine -// the subset of objects to which the rule applies. +// A container for specifying S3 Intelligent-Tiering filters. The filters +// determine the subset of objects to which the rule applies. type IntelligentTieringAndOperator struct { // An object key name prefix that identifies the subset of objects to which the @@ -1959,8 +1385,8 @@ type IntelligentTieringAndOperator struct { // Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket. For // information about the S3 Intelligent-Tiering storage class, see Storage class -// for automatically optimizing frequently and infrequently accessed objects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). +// for automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) +// . type IntelligentTieringConfiguration struct { // The ID used to identify the S3 Intelligent-Tiering configuration. @@ -1978,8 +1404,8 @@ type IntelligentTieringConfiguration struct { // This member is required. Tierings []Tiering - // Specifies a bucket filter. The configuration only includes objects that meet the - // filter's criteria. + // Specifies a bucket filter. The configuration only includes objects that meet + // the filter's criteria. Filter *IntelligentTieringFilter noSmithyDocumentSerde @@ -1989,16 +1415,16 @@ type IntelligentTieringConfiguration struct { // configuration applies to. type IntelligentTieringFilter struct { - // A conjunction (logical AND) of predicates, which is used in evaluating a metrics - // filter. The operator must have at least two predicates, and an object must match - // all of the predicates in order for the filter to apply. + // A conjunction (logical AND) of predicates, which is used in evaluating a + // metrics filter. The operator must have at least two predicates, and an object + // must match all of the predicates in order for the filter to apply. And *IntelligentTieringAndOperator // An object key name prefix that identifies the subset of objects to which the // rule applies. Replacement must be made for object keys containing special // characters (such as carriage returns) when using XML requests. For more - // information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . Prefix *string // A container of a key value name pair. @@ -2008,8 +1434,7 @@ type IntelligentTieringFilter struct { } // Specifies the inventory configuration for an Amazon S3 bucket. For more -// information, see GET Bucket inventory -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) +// information, see GET Bucket inventory (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) // in the Amazon S3 API Reference. type InventoryConfiguration struct { @@ -2023,16 +1448,16 @@ type InventoryConfiguration struct { // This member is required. Id *string - // Object versions to include in the inventory list. If set to All, the list + // Object versions to include in the inventory list. If set to All , the list // includes all the object versions, which adds the version-related fields - // VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list - // does not contain these version-related fields. + // VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the + // list does not contain these version-related fields. // // This member is required. IncludedObjectVersions InventoryIncludedObjectVersions - // Specifies whether the inventory is enabled or disabled. If set to True, an - // inventory list is generated. If set to False, no inventory list is generated. + // Specifies whether the inventory is enabled or disabled. If set to True , an + // inventory list is generated. If set to False , no inventory list is generated. // // This member is required. IsEnabled bool @@ -2042,8 +1467,8 @@ type InventoryConfiguration struct { // This member is required. Schedule *InventorySchedule - // Specifies an inventory filter. The inventory only includes objects that meet the - // filter's criteria. + // Specifies an inventory filter. The inventory only includes objects that meet + // the filter's criteria. Filter *InventoryFilter // Contains the optional fields that are included in the inventory results. @@ -2077,8 +1502,8 @@ type InventoryEncryption struct { noSmithyDocumentSerde } -// Specifies an inventory filter. The inventory only includes objects that meet the -// filter's criteria. +// Specifies an inventory filter. The inventory only includes objects that meet +// the filter's criteria. type InventoryFilter struct { // The prefix that an object must have to be included in the inventory results. @@ -2154,9 +1579,8 @@ type JSONOutput struct { type LambdaFunctionConfiguration struct { // The Amazon S3 bucket event for which to invoke the Lambda function. For more - // information, see Supported Event Types - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // information, see Supported Event Types (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. // // This member is required. Events []Event @@ -2168,9 +1592,8 @@ type LambdaFunctionConfiguration struct { LambdaFunctionArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring Event Notifications - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -2181,8 +1604,7 @@ type LambdaFunctionConfiguration struct { } // Container for the expiration for the lifecycle of the object. For more -// information see, Managing your storage lifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) +// information see, Managing your storage lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) // in the Amazon S3 User Guide. type LifecycleExpiration struct { @@ -2204,8 +1626,7 @@ type LifecycleExpiration struct { } // A lifecycle rule for individual objects in an Amazon S3 bucket. For more -// information see, Managing your storage lifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) +// information see, Managing your storage lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html) // in the Amazon S3 User Guide. type LifecycleRule struct { @@ -2217,9 +1638,8 @@ type LifecycleRule struct { // Specifies the days since the initiation of an incomplete multipart upload that // Amazon S3 will wait before permanently removing all parts of the upload. For - // more information, see Aborting Incomplete Multipart Uploads Using a Bucket - // Lifecycle Policy - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + // more information, see Aborting Incomplete Multipart Uploads Using a Bucket + // Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) // in the Amazon S3 User Guide. AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload @@ -2228,7 +1648,7 @@ type LifecycleRule struct { Expiration *LifecycleExpiration // The Filter is used to identify objects that a Lifecycle Rule applies to. A - // Filter must have exactly one of Prefix, Tag, or And specified. Filter is + // Filter must have exactly one of Prefix , Tag , or And specified. Filter is // required if the LifecycleRule does not contain a Prefix element. Filter LifecycleRuleFilter @@ -2252,8 +1672,8 @@ type LifecycleRule struct { // Prefix identifying one or more objects to which the rule applies. This is no // longer used; use Filter instead. Replacement must be made for object keys // containing special characters (such as carriage returns) when using XML - // requests. For more information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // requests. For more information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . // // Deprecated: This member has been deprecated. Prefix *string @@ -2286,7 +1706,7 @@ type LifecycleRuleAndOperator struct { } // The Filter is used to identify objects that a Lifecycle Rule applies to. A -// Filter must have exactly one of Prefix, Tag, or And specified. +// Filter must have exactly one of Prefix , Tag , or And specified. // // The following types satisfy this interface: // @@ -2330,9 +1750,9 @@ func (*LifecycleRuleFilterMemberObjectSizeLessThan) isLifecycleRuleFilter() {} // Prefix identifying one or more objects to which the rule applies. Replacement // must be made for object keys containing special characters (such as carriage -// returns) when using XML requests. For more information, see XML related object -// key constraints -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +// returns) when using XML requests. For more information, see XML related object +// key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) +// . type LifecycleRuleFilterMemberPrefix struct { Value string @@ -2350,10 +1770,9 @@ type LifecycleRuleFilterMemberTag struct { func (*LifecycleRuleFilterMemberTag) isLifecycleRuleFilter() {} -// Describes where logs are stored and the prefix that Amazon S3 assigns to all log -// object keys for a bucket. For more information, see PUT Bucket logging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in -// the Amazon S3 API Reference. +// Describes where logs are stored and the prefix that Amazon S3 assigns to all +// log object keys for a bucket. For more information, see PUT Bucket logging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) +// in the Amazon S3 API Reference. type LoggingEnabled struct { // Specifies the bucket where you want Amazon S3 to store server access logs. You @@ -2366,17 +1785,16 @@ type LoggingEnabled struct { // This member is required. TargetBucket *string - // A prefix for all log object keys. If you store log files from multiple Amazon S3 - // buckets in a single bucket, you can use a prefix to distinguish which log files - // came from which bucket. + // A prefix for all log object keys. If you store log files from multiple Amazon + // S3 buckets in a single bucket, you can use a prefix to distinguish which log + // files came from which bucket. // // This member is required. TargetPrefix *string // Container for granting information. Buckets that use the bucket owner enforced // setting for Object Ownership don't support target grants. For more information, - // see Permissions for server access log delivery - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) + // see Permissions for server access log delivery (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) // in the Amazon S3 User Guide. TargetGrants []TargetGrant @@ -2395,8 +1813,8 @@ type MetadataEntry struct { noSmithyDocumentSerde } -// A container specifying replication metrics-related settings enabling replication -// metrics and events. +// A container specifying replication metrics-related settings enabling +// replication metrics and events. type Metrics struct { // Specifies whether the replication metrics are enabled. @@ -2411,9 +1829,9 @@ type Metrics struct { noSmithyDocumentSerde } -// A conjunction (logical AND) of predicates, which is used in evaluating a metrics -// filter. The operator must have at least two predicates, and an object must match -// all of the predicates in order for the filter to apply. +// A conjunction (logical AND) of predicates, which is used in evaluating a +// metrics filter. The operator must have at least two predicates, and an object +// must match all of the predicates in order for the filter to apply. type MetricsAndOperator struct { // The access point ARN used when evaluating an AND predicate. @@ -2432,8 +1850,8 @@ type MetricsAndOperator struct { // by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an // existing metrics configuration, note that this is a full replacement of the // existing metrics configuration. If you don't include the elements you want to -// keep, they are erased. For more information, see PutBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). +// keep, they are erased. For more information, see PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html) +// . type MetricsConfiguration struct { // The ID used to identify the metrics configuration. The ID has a 64 character @@ -2453,8 +1871,8 @@ type MetricsConfiguration struct { // Specifies a metrics configuration filter. The metrics configuration only // includes objects that meet the filter's criteria. A filter must be a prefix, an // object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more -// information, see PutBucketMetricsConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). +// information, see PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) +// . // // The following types satisfy this interface: // @@ -2475,9 +1893,9 @@ type MetricsFilterMemberAccessPointArn struct { func (*MetricsFilterMemberAccessPointArn) isMetricsFilter() {} -// A conjunction (logical AND) of predicates, which is used in evaluating a metrics -// filter. The operator must have at least two predicates, and an object must match -// all of the predicates in order for the filter to apply. +// A conjunction (logical AND) of predicates, which is used in evaluating a +// metrics filter. The operator must have at least two predicates, and an object +// must match all of the predicates in order for the filter to apply. type MetricsFilterMemberAnd struct { Value MetricsAndOperator @@ -2541,16 +1959,14 @@ type NoncurrentVersionExpiration struct { // Specifies how many noncurrent versions Amazon S3 will retain. If there are this // many more recent noncurrent versions, Amazon S3 will take the associated action. // For more information about noncurrent versions, see Lifecycle configuration - // elements - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) + // elements (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) // in the Amazon S3 User Guide. NewerNoncurrentVersions int32 // Specifies the number of days an object is noncurrent before Amazon S3 can // perform the associated action. The value must be a non-zero positive integer. // For information about the noncurrent days calculations, see How Amazon S3 - // Calculates When an Object Became Noncurrent - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + // Calculates When an Object Became Noncurrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) // in the Amazon S3 User Guide. NoncurrentDays int32 @@ -2558,27 +1974,25 @@ type NoncurrentVersionExpiration struct { } // Container for the transition rule that describes when noncurrent objects -// transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, -// GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or -// versioning is suspended), you can set this action to request that Amazon S3 -// transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, -// INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a +// transition to the STANDARD_IA , ONEZONE_IA , INTELLIGENT_TIERING , GLACIER_IR , +// GLACIER , or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled +// (or versioning is suspended), you can set this action to request that Amazon S3 +// transition noncurrent object versions to the STANDARD_IA , ONEZONE_IA , +// INTELLIGENT_TIERING , GLACIER_IR , GLACIER , or DEEP_ARCHIVE storage class at a // specific period in the object's lifetime. type NoncurrentVersionTransition struct { // Specifies how many noncurrent versions Amazon S3 will retain. If there are this // many more recent noncurrent versions, Amazon S3 will take the associated action. // For more information about noncurrent versions, see Lifecycle configuration - // elements - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) + // elements (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) // in the Amazon S3 User Guide. NewerNoncurrentVersions int32 // Specifies the number of days an object is noncurrent before Amazon S3 can // perform the associated action. For information about the noncurrent days // calculations, see How Amazon S3 Calculates How Long an Object Has Been - // Noncurrent - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + // Noncurrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) // in the Amazon S3 User Guide. NoncurrentDays int32 @@ -2588,8 +2002,8 @@ type NoncurrentVersionTransition struct { noSmithyDocumentSerde } -// A container for specifying the notification configuration of the bucket. If this -// element is empty, notifications are turned off for the bucket. +// A container for specifying the notification configuration of the bucket. If +// this element is empty, notifications are turned off for the bucket. type NotificationConfiguration struct { // Enables delivery of events to Amazon EventBridge. @@ -2599,21 +2013,20 @@ type NotificationConfiguration struct { // them. LambdaFunctionConfigurations []LambdaFunctionConfiguration - // The Amazon Simple Queue Service queues to publish messages to and the events for - // which to publish messages. + // The Amazon Simple Queue Service queues to publish messages to and the events + // for which to publish messages. QueueConfigurations []QueueConfiguration - // The topic to which notifications are sent and the events for which notifications - // are generated. + // The topic to which notifications are sent and the events for which + // notifications are generated. TopicConfigurations []TopicConfiguration noSmithyDocumentSerde } // Specifies object key name filtering rules. For information about key name -// filtering, see Configuring Event Notifications -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the -// Amazon S3 User Guide. +// filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) +// in the Amazon S3 User Guide. type NotificationConfigurationFilter struct { // A container for object key name prefix and suffix filtering rules. @@ -2632,22 +2045,17 @@ type Object struct { // contents of an object, not its metadata. The ETag may or may not be an MD5 // digest of the object data. Whether or not it is depends on how the object was // created and how it is encrypted as described below: - // - // * Objects created by the - // PUT Object, POST Object, or Copy operation, or through the Amazon Web Services - // Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that - // are an MD5 digest of their object data. - // - // * Objects created by the PUT Object, - // POST Object, or Copy operation, or through the Amazon Web Services Management - // Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 - // digest of their object data. - // - // * If an object is created by either the Multipart - // Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the - // method of encryption. If an object is larger than 16 MB, the Amazon Web Services - // Management Console will upload or copy that object as a Multipart Upload, and - // therefore the ETag will not be an MD5 digest. + // - Objects created by the PUT Object, POST Object, or Copy operation, or + // through the Amazon Web Services Management Console, and are encrypted by SSE-S3 + // or plaintext, have ETags that are an MD5 digest of their object data. + // - Objects created by the PUT Object, POST Object, or Copy operation, or + // through the Amazon Web Services Management Console, and are encrypted by SSE-C + // or SSE-KMS, have ETags that are not an MD5 digest of their object data. + // - If an object is created by either the Multipart Upload or Part Copy + // operation, the ETag is not an MD5 digest, regardless of the method of + // encryption. If an object is larger than 16 MB, the Amazon Web Services + // Management Console will upload or copy that object as a Multipart Upload, and + // therefore the ETag will not be an MD5 digest. ETag *string // The name that you assign to an object. You use the object key to retrieve the @@ -2674,8 +2082,8 @@ type ObjectIdentifier struct { // Key name of the object. Replacement must be made for object keys containing // special characters (such as carriage returns) when using XML requests. For more - // information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . // // This member is required. Key *string @@ -2694,9 +2102,9 @@ type ObjectLockConfiguration struct { ObjectLockEnabled ObjectLockEnabled // Specifies the Object Lock rule for the specified object. Enable the this rule - // when you apply ObjectLockConfiguration to a bucket. Bucket settings require both - // a mode and a period. The period can be either Days or Years but you must select - // one. You cannot specify Days and Years at the same time. + // when you apply ObjectLockConfiguration to a bucket. Bucket settings require + // both a mode and a period. The period can be either Days or Years but you must + // select one. You cannot specify Days and Years at the same time. Rule *ObjectLockRule noSmithyDocumentSerde @@ -2741,37 +2149,33 @@ type ObjectPart struct { // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA256 *string - // The part number identifying the part. This value is a positive integer between 1 - // and 10,000. + // The part number identifying the part. This value is a positive integer between + // 1 and 10,000. PartNumber int32 // The size of the uploaded part in bytes. @@ -2838,27 +2242,16 @@ type OutputSerialization struct { // Container for the owner's display name and ID. type Owner struct { - // Container for the display name of the owner. This value is only supported in the - // following Amazon Web Services Regions: - // - // * US East (N. Virginia) - // - // * US West (N. - // California) - // - // * US West (Oregon) - // - // * Asia Pacific (Singapore) - // - // * Asia Pacific - // (Sydney) - // - // * Asia Pacific (Tokyo) - // - // * Europe (Ireland) - // - // * South America (São - // Paulo) + // Container for the display name of the owner. This value is only supported in + // the following Amazon Web Services Regions: + // - US East (N. Virginia) + // - US West (N. California) + // - US West (Oregon) + // - Asia Pacific (Singapore) + // - Asia Pacific (Sydney) + // - Asia Pacific (Tokyo) + // - Europe (Ireland) + // - South America (São Paulo) DisplayName *string // Container for the ID of the owner. @@ -2910,32 +2303,28 @@ type Part struct { // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be // present if it was uploaded with the object. With multipart uploads, this may not // be a checksum value of the object. For more information about how checksums are - // calculated with multipart uploads, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) + // calculated with multipart uploads, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums) // in the Amazon S3 User Guide. ChecksumSHA1 *string // This header can be used as a data integrity check to verify that the data // received is the same data that was originally sent. This header specifies the // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see - // Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) + // Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) // in the Amazon S3 User Guide. ChecksumSHA256 *string @@ -2992,30 +2381,23 @@ type ProgressEvent struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // bucket. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The -// Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. type PublicAccessBlockConfiguration struct { // Specifies whether Amazon S3 should block public access control lists (ACLs) for // this bucket and objects in this bucket. Setting this element to TRUE causes the // following behavior: - // - // * PUT Bucket ACL and PUT Object ACL calls fail if the - // specified ACL is public. - // - // * PUT Object calls fail if the request includes a - // public ACL. - // - // * PUT Bucket calls fail if the request includes a public - // ACL. - // + // - PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is + // public. + // - PUT Object calls fail if the request includes a public ACL. + // - PUT Bucket calls fail if the request includes a public ACL. // Enabling this setting doesn't affect existing policies or ACLs. BlockPublicAcls bool - // Specifies whether Amazon S3 should block public bucket policies for this bucket. - // Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket - // policy if the specified bucket policy allows public access. Enabling this + // Specifies whether Amazon S3 should block public bucket policies for this + // bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT + // Bucket policy if the specified bucket policy allows public access. Enabling this // setting doesn't affect existing bucket policies. BlockPublicPolicy bool @@ -3054,9 +2436,8 @@ type QueueConfiguration struct { QueueArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring Event Notifications - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -3075,8 +2456,8 @@ type RecordsEvent struct { noSmithyDocumentSerde } -// Specifies how requests are redirected. In the event of an error, you can specify -// a different error code to return. +// Specifies how requests are redirected. In the event of an error, you can +// specify a different error code to return. type Redirect struct { // The host name to use in the redirect request. @@ -3092,22 +2473,21 @@ type Redirect struct { // The object key prefix to use in the redirect request. For example, to redirect // requests for all pages with prefix docs/ (objects in the docs/ folder) to - // documents/, you can set a condition block with KeyPrefixEquals set to docs/ and - // in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of - // the siblings is present. Can be present only if ReplaceKeyWith is not provided. - // Replacement must be made for object keys containing special characters (such as - // carriage returns) when using XML requests. For more information, see XML - // related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // documents/ , you can set a condition block with KeyPrefixEquals set to docs/ + // and in the Redirect set ReplaceKeyPrefixWith to /documents . Not required if one + // of the siblings is present. Can be present only if ReplaceKeyWith is not + // provided. Replacement must be made for object keys containing special characters + // (such as carriage returns) when using XML requests. For more information, see + // XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . ReplaceKeyPrefixWith *string // The specific object key to use in the redirect request. For example, redirect - // request to error.html. Not required if one of the siblings is present. Can be + // request to error.html . Not required if one of the siblings is present. Can be // present only if ReplaceKeyPrefixWith is not provided. Replacement must be made // for object keys containing special characters (such as carriage returns) when - // using XML requests. For more information, see XML related object key - // constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // using XML requests. For more information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . ReplaceKeyWith *string noSmithyDocumentSerde @@ -3131,11 +2511,11 @@ type RedirectAllRequestsTo struct { // A filter that you can specify for selection for modifications on replicas. // Amazon S3 doesn't replicate replica modifications by default. In the latest -// version of replication configuration (when Filter is specified), you can specify -// this element and set the status to Enabled to replicate modifications on -// replicas. If you don't specify the Filter element, Amazon S3 assumes that the -// replication configuration is the earlier version, V1. In the earlier version, -// this element is not allowed. +// version of replication configuration (when Filter is specified), you can +// specify this element and set the status to Enabled to replicate modifications +// on replicas. If you don't specify the Filter element, Amazon S3 assumes that +// the replication configuration is the earlier version, V1. In the earlier +// version, this element is not allowed. type ReplicaModifications struct { // Specifies whether Amazon S3 replicates modifications on replicas. @@ -3152,9 +2532,8 @@ type ReplicationConfiguration struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // that Amazon S3 assumes when replicating objects. For more information, see How - // to Set Up Replication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in - // the Amazon S3 User Guide. + // to Set Up Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) + // in the Amazon S3 User Guide. // // This member is required. Role *string @@ -3185,27 +2564,25 @@ type ReplicationRule struct { // Specifies whether Amazon S3 replicates delete markers. If you specify a Filter // in your replication configuration, you must also include a // DeleteMarkerReplication element. If your Filter includes a Tag element, the - // DeleteMarkerReplicationStatus must be set to Disabled, because Amazon S3 does + // DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does // not support replicating delete markers for tag-based rules. For an example - // configuration, see Basic Rule Configuration - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). - // For more information about delete marker replication, see Basic Rule - // Configuration - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). - // If you are using an earlier version of the replication configuration, Amazon S3 - // handles replication of delete markers differently. For more information, see - // Backward Compatibility - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). + // configuration, see Basic Rule Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config) + // . For more information about delete marker replication, see Basic Rule + // Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html) + // . If you are using an earlier version of the replication configuration, Amazon + // S3 handles replication of delete markers differently. For more information, see + // Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations) + // . DeleteMarkerReplication *DeleteMarkerReplication // Optional configuration to replicate existing source bucket objects. For more - // information, see Replicating Existing Objects - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication) + // information, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication) // in the Amazon S3 User Guide. ExistingObjectReplication *ExistingObjectReplication // A filter that identifies the subset of objects to which the replication rule - // applies. A Filter must specify exactly one Prefix, Tag, or an And child element. + // applies. A Filter must specify exactly one Prefix , Tag , or an And child + // element. Filter ReplicationRuleFilter // A unique identifier for the rule. The maximum value is 255 characters. @@ -3215,8 +2592,8 @@ type ReplicationRule struct { // rule applies. The maximum prefix length is 1,024 characters. To include all // objects in a bucket, specify an empty string. Replacement must be made for // object keys containing special characters (such as carriage returns) when using - // XML requests. For more information, see XML related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). + // XML requests. For more information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // . // // Deprecated: This member has been deprecated. Prefix *string @@ -3226,16 +2603,15 @@ type ReplicationRule struct { // according to all replication rules. However, if there are two or more rules with // the same destination bucket, then objects will be replicated according to the // rule with the highest priority. The higher the number, the higher the priority. - // For more information, see Replication - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the Amazon - // S3 User Guide. + // For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) + // in the Amazon S3 User Guide. Priority int32 - // A container that describes additional filters for identifying the source objects - // that you want to replicate. You can choose to enable or disable the replication - // of these objects. Currently, Amazon S3 supports only the filter that you can - // specify for objects created with server-side encryption using a customer managed - // key stored in Amazon Web Services Key Management Service (SSE-KMS). + // A container that describes additional filters for identifying the source + // objects that you want to replicate. You can choose to enable or disable the + // replication of these objects. Currently, Amazon S3 supports only the filter that + // you can specify for objects created with server-side encryption using a customer + // managed key stored in Amazon Web Services Key Management Service (SSE-KMS). SourceSelectionCriteria *SourceSelectionCriteria noSmithyDocumentSerde @@ -3244,12 +2620,10 @@ type ReplicationRule struct { // A container for specifying rule filters. The filters determine the subset of // objects to which the rule applies. This element is required only if you specify // more than one filter. For example: -// -// * If you specify both a Prefix and a Tag -// filter, wrap these filters in an And tag. -// -// * If you specify a filter based on -// multiple tags, wrap the Tag elements in an And tag. +// - If you specify both a Prefix and a Tag filter, wrap these filters in an And +// tag. +// - If you specify a filter based on multiple tags, wrap the Tag elements in an +// And tag. type ReplicationRuleAndOperator struct { // An object key name prefix that identifies the subset of objects to which the @@ -3263,7 +2637,8 @@ type ReplicationRuleAndOperator struct { } // A filter that identifies the subset of objects to which the replication rule -// applies. A Filter must specify exactly one Prefix, Tag, or an And child element. +// applies. A Filter must specify exactly one Prefix , Tag , or an And child +// element. // // The following types satisfy this interface: // @@ -3277,12 +2652,10 @@ type ReplicationRuleFilter interface { // A container for specifying rule filters. The filters determine the subset of // objects to which the rule applies. This element is required only if you specify // more than one filter. For example: -// -// * If you specify both a Prefix and a Tag -// filter, wrap these filters in an And tag. -// -// * If you specify a filter based on -// multiple tags, wrap the Tag elements in an And tag. +// - If you specify both a Prefix and a Tag filter, wrap these filters in an And +// tag. +// - If you specify a filter based on multiple tags, wrap the Tag elements in an +// And tag. type ReplicationRuleFilterMemberAnd struct { Value ReplicationRuleAndOperator @@ -3294,8 +2667,8 @@ func (*ReplicationRuleFilterMemberAnd) isReplicationRuleFilter() {} // An object key name prefix that identifies the subset of objects to which the // rule applies. Replacement must be made for object keys containing special // characters (such as carriage returns) when using XML requests. For more -// information, see XML related object key constraints -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +// information, see XML related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) +// . type ReplicationRuleFilterMemberPrefix struct { Value string @@ -3304,8 +2677,8 @@ type ReplicationRuleFilterMemberPrefix struct { func (*ReplicationRuleFilterMemberPrefix) isReplicationRuleFilter() {} -// A container for specifying a tag key and value. The rule applies only to objects -// that have the tag in their tag set. +// A container for specifying a tag key and value. The rule applies only to +// objects that have the tag in their tag set. type ReplicationRuleFilterMemberTag struct { Value Tag @@ -3314,9 +2687,10 @@ type ReplicationRuleFilterMemberTag struct { func (*ReplicationRuleFilterMemberTag) isReplicationRuleFilter() {} -// A container specifying S3 Replication Time Control (S3 RTC) related information, -// including whether S3 RTC is enabled and the time when all objects and operations -// on objects must be replicated. Must be specified together with a Metrics block. +// A container specifying S3 Replication Time Control (S3 RTC) related +// information, including whether S3 RTC is enabled and the time when all objects +// and operations on objects must be replicated. Must be specified together with a +// Metrics block. type ReplicationTime struct { // Specifies whether the replication time is enabled. @@ -3334,7 +2708,7 @@ type ReplicationTime struct { } // A container specifying the time value for S3 Replication Time Control (S3 RTC) -// and replication metrics EventThreshold. +// and replication metrics EventThreshold . type ReplicationTimeValue struct { // Contains an integer specifying time in minutes. Valid value: 15 @@ -3368,7 +2742,7 @@ type RequestProgress struct { type RestoreRequest struct { // Lifetime of the active copy in days. Do not use with restores that specify - // OutputLocation. The Days element is required for regular restores, and must not + // OutputLocation . The Days element is required for regular restores, and must not // be provided for select requests. Days int32 @@ -3376,7 +2750,7 @@ type RestoreRequest struct { Description *string // S3 Glacier related parameters pertaining to this job. Do not use with restores - // that specify OutputLocation. + // that specify OutputLocation . GlacierJobParameters *GlacierJobParameters // Describes the location where the restore job's output is stored. @@ -3395,8 +2769,7 @@ type RestoreRequest struct { } // Specifies the redirect behavior and when a redirect is applied. For more -// information about routing rules, see Configuring advanced conditional redirects -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) +// information about routing rules, see Configuring advanced conditional redirects (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) // in the Amazon S3 User Guide. type RoutingRule struct { @@ -3473,10 +2846,10 @@ type ScanRange struct { // scan the last N bytes of the file. For example, 50 means scan the last 50 bytes. End int64 - // Specifies the start of the byte range. This parameter is optional. Valid values: - // non-negative integers. The default value is 0. If only start is supplied, it - // means scan from that point to the end of the file. For example, 50 means scan - // from byte 50 until the end of the file. + // Specifies the start of the byte range. This parameter is optional. Valid + // values: non-negative integers. The default value is 0. If only start is + // supplied, it means scan from that point to the end of the file. For example, 50 + // means scan from byte 50 until the end of the file. Start int64 noSmithyDocumentSerde @@ -3572,8 +2945,7 @@ type SelectParameters struct { // at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key // in your Amazon Web Services account the first time that you add an object // encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for -// SSE-KMS. For more information, see PUT Bucket encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) +// SSE-KMS. For more information, see PUT Bucket encryption (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) // in the Amazon S3 API Reference. type ServerSideEncryptionByDefault struct { @@ -3584,23 +2956,17 @@ type ServerSideEncryptionByDefault struct { // Amazon Web Services Key Management Service (KMS) customer Amazon Web Services // KMS key ID to use for the default encryption. This parameter is allowed if and - // only if SSEAlgorithm is set to aws:kms. You can specify the key ID or the Amazon - // Resource Name (ARN) of the KMS key. However, if you are using encryption with - // cross-account or Amazon Web Services service operations you must use a fully - // qualified KMS key ARN. For more information, see Using encryption for - // cross-account operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). - // For example: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // Amazon - // S3 only supports symmetric encryption KMS keys. For more information, see - // Asymmetric keys in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) + // only if SSEAlgorithm is set to aws:kms . You can specify the key ID or the + // Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption + // with cross-account or Amazon Web Services service operations you must use a + // fully qualified KMS key ARN. For more information, see Using encryption for + // cross-account operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy) + // . For example: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // Amazon S3 only supports symmetric encryption KMS keys. For more information, + // see Asymmetric keys in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) // in the Amazon Web Services Key Management Service Developer Guide. KMSMasterKeyID *string @@ -3631,28 +2997,27 @@ type ServerSideEncryptionRule struct { // encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects // are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 // to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more - // information, see Amazon S3 Bucket Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the Amazon - // S3 User Guide. + // information, see Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) + // in the Amazon S3 User Guide. BucketKeyEnabled bool noSmithyDocumentSerde } -// A container that describes additional filters for identifying the source objects -// that you want to replicate. You can choose to enable or disable the replication -// of these objects. Currently, Amazon S3 supports only the filter that you can -// specify for objects created with server-side encryption using a customer managed -// key stored in Amazon Web Services Key Management Service (SSE-KMS). +// A container that describes additional filters for identifying the source +// objects that you want to replicate. You can choose to enable or disable the +// replication of these objects. Currently, Amazon S3 supports only the filter that +// you can specify for objects created with server-side encryption using a customer +// managed key stored in Amazon Web Services Key Management Service (SSE-KMS). type SourceSelectionCriteria struct { // A filter that you can specify for selections for modifications on replicas. // Amazon S3 doesn't replicate replica modifications by default. In the latest - // version of replication configuration (when Filter is specified), you can specify - // this element and set the status to Enabled to replicate modifications on - // replicas. If you don't specify the Filter element, Amazon S3 assumes that the - // replication configuration is the earlier version, V1. In the earlier version, - // this element is not allowed + // version of replication configuration (when Filter is specified), you can + // specify this element and set the status to Enabled to replicate modifications + // on replicas. If you don't specify the Filter element, Amazon S3 assumes that + // the replication configuration is the earlier version, V1. In the earlier + // version, this element is not allowed ReplicaModifications *ReplicaModifications // A container for filter information for the selection of Amazon S3 objects @@ -3723,15 +3088,15 @@ type StatsEvent struct { // analyze the tradeoffs between different storage classes for an Amazon S3 bucket. type StorageClassAnalysis struct { - // Specifies how data related to the storage class analysis for an Amazon S3 bucket - // should be exported. + // Specifies how data related to the storage class analysis for an Amazon S3 + // bucket should be exported. DataExport *StorageClassAnalysisDataExport noSmithyDocumentSerde } -// Container for data related to the storage class analysis for an Amazon S3 bucket -// for export. +// Container for data related to the storage class analysis for an Amazon S3 +// bucket for export. type StorageClassAnalysisDataExport struct { // The place to store the data for an analysis. @@ -3739,7 +3104,7 @@ type StorageClassAnalysisDataExport struct { // This member is required. Destination *AnalyticsExportDestination - // The version of the output schema to use when exporting data. Must be V_1. + // The version of the output schema to use when exporting data. Must be V_1 . // // This member is required. OutputSchemaVersion StorageClassAnalysisSchemaVersion @@ -3776,8 +3141,7 @@ type Tagging struct { // Container for granting information. Buckets that use the bucket owner enforced // setting for Object Ownership don't support target grants. For more information, -// see Permissions server access log delivery -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) +// see Permissions server access log delivery (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general) // in the Amazon S3 User Guide. type TargetGrant struct { @@ -3796,8 +3160,7 @@ type TargetGrant struct { type Tiering struct { // S3 Intelligent-Tiering access tier. See Storage class for automatically - // optimizing frequently and infrequently accessed objects - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) + // optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) // for a list of access tiers in the S3 Intelligent-Tiering storage class. // // This member is required. @@ -3821,9 +3184,8 @@ type Tiering struct { type TopicConfiguration struct { // The Amazon S3 bucket event about which to send notifications. For more - // information, see Supported Event Types - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // information, see Supported Event Types (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. // // This member is required. Events []Event @@ -3835,9 +3197,8 @@ type TopicConfiguration struct { TopicArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring Event Notifications - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the - // Amazon S3 User Guide. + // filtering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) + // in the Amazon S3 User Guide. Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -3849,17 +3210,16 @@ type TopicConfiguration struct { // Specifies when an object transitions to a specified storage class. For more // information about Amazon S3 lifecycle configuration rules, see Transitioning -// Objects Using Amazon S3 Lifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) +// Objects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) // in the Amazon S3 User Guide. type Transition struct { - // Indicates when objects are transitioned to the specified storage class. The date - // value must be in ISO 8601 format. The time is always midnight UTC. + // Indicates when objects are transitioned to the specified storage class. The + // date value must be in ISO 8601 format. The time is always midnight UTC. Date *time.Time - // Indicates the number of days after creation when objects are transitioned to the - // specified storage class. The value must be a positive integer. + // Indicates the number of days after creation when objects are transitioned to + // the specified storage class. The value must be a positive integer. Days int32 // The storage class to which you want the object to transition. @@ -3868,9 +3228,8 @@ type Transition struct { noSmithyDocumentSerde } -// Describes the versioning state of an Amazon S3 bucket. For more information, see -// PUT Bucket versioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) +// Describes the versioning state of an Amazon S3 bucket. For more information, +// see PUT Bucket versioning (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) // in the Amazon S3 API Reference. type VersioningConfiguration struct { diff --git a/service/s3control/api_client.go b/service/s3control/api_client.go index 628585a1c3e..0f206dd2b09 100644 --- a/service/s3control/api_client.go +++ b/service/s3control/api_client.go @@ -124,7 +124,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment @@ -474,14 +474,14 @@ func nopGetOutpostIDFromInput(input interface{}) (*string, bool) { return nil, false } -// nopGetARNAccessor provides a nop get accessor function to be used when a certain -// operation does not support ARNs +// nopGetARNAccessor provides a nop get accessor function to be used when a +// certain operation does not support ARNs func nopGetARNAccessor(input interface{}) (*string, bool) { return nil, false } -// nopSetARNAccessor provides a nop set accessor function to be used when a certain -// operation does not support ARNs +// nopSetARNAccessor provides a nop set accessor function to be used when a +// certain operation does not support ARNs func nopSetARNAccessor(input interface{}, v string) error { return nil } @@ -496,8 +496,8 @@ func addResponseErrorMiddleware(stack *middleware.Stack) error { return s3shared.AddResponseErrorMiddleware(stack) } -// ResponseError provides the HTTP centric error type wrapping the underlying error -// with the HTTP response value and the deserialized RequestID. +// ResponseError provides the HTTP centric error type wrapping the underlying +// error with the HTTP response value and the deserialized RequestID. type ResponseError interface { error @@ -507,8 +507,8 @@ type ResponseError interface { var _ ResponseError = (*s3shared.ResponseError)(nil) -// GetHostIDMetadata retrieves the host id from middleware metadata returns host id -// as string along with a boolean indicating presence of hostId on middleware +// GetHostIDMetadata retrieves the host id from middleware metadata returns host +// id as string along with a boolean indicating presence of hostId on middleware // metadata. func GetHostIDMetadata(metadata middleware.Metadata) (string, bool) { return s3shared.GetHostIDMetadata(metadata) diff --git a/service/s3control/api_op_CreateAccessPoint.go b/service/s3control/api_op_CreateAccessPoint.go index 233cfcb29b6..79d588ee2de 100644 --- a/service/s3control/api_op_CreateAccessPoint.go +++ b/service/s3control/api_op_CreateAccessPoint.go @@ -16,32 +16,20 @@ import ( ) // Creates an access point and associates it with the specified bucket. For more -// information, see Managing Data Access with Amazon S3 Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) in -// the Amazon S3 User Guide. S3 on Outposts only supports VPC-style access points. -// For more information, see Accessing Amazon S3 on Outposts using virtual private -// cloud (VPC) only access points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this -// action require an additional parameter of x-amz-outpost-id to be passed with the -// request. In addition, you must use an S3 on Outposts endpoint hostname prefix -// instead of s3-control. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) -// section. The following actions are related to CreateAccessPoint: -// -// * -// GetAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) -// -// * -// DeleteAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) -// -// * -// ListAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) +// information, see Managing Data Access with Amazon S3 Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) +// in the Amazon S3 User Guide. S3 on Outposts only supports VPC-style access +// points. For more information, see Accessing Amazon S3 on Outposts using virtual +// private cloud (VPC) only access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for +// this action require an additional parameter of x-amz-outpost-id to be passed +// with the request. In addition, you must use an S3 on Outposts endpoint hostname +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples) +// section. The following actions are related to CreateAccessPoint : +// - GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) +// - DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) +// - ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error) { if params == nil { params = &CreateAccessPointInput{} @@ -69,10 +57,10 @@ type CreateAccessPointInput struct { // using this parameter with Amazon S3 on Outposts with the REST API, you must // specify the name and the x-amz-outpost-id as well. For using this parameter with // S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the - // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. - // For example, to access the bucket reports through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/ + // . For example, to access the bucket reports through Outpost my-outpost owned by + // account 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. @@ -83,8 +71,8 @@ type CreateAccessPointInput struct { // This member is required. Name *string - // The Amazon Web Services account ID associated with the S3 bucket associated with - // this access point. + // The Amazon Web Services account ID associated with the S3 bucket associated + // with this access point. BucketAccountId *string // The PublicAccessBlock configuration that you want to apply to the access point. diff --git a/service/s3control/api_op_CreateAccessPointForObjectLambda.go b/service/s3control/api_op_CreateAccessPointForObjectLambda.go index de52542d75c..5e040298b27 100644 --- a/service/s3control/api_op_CreateAccessPointForObjectLambda.go +++ b/service/s3control/api_op_CreateAccessPointForObjectLambda.go @@ -16,21 +16,12 @@ import ( ) // Creates an Object Lambda Access Point. For more information, see Transforming -// objects with Object Lambda Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) +// objects with Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html) // in the Amazon S3 User Guide. The following actions are related to -// CreateAccessPointForObjectLambda: -// -// * DeleteAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) -// -// * -// GetAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) -// -// * -// ListAccessPointsForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) +// CreateAccessPointForObjectLambda : +// - DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) +// - GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) +// - ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) func (c *Client) CreateAccessPointForObjectLambda(ctx context.Context, params *CreateAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*CreateAccessPointForObjectLambdaOutput, error) { if params == nil { params = &CreateAccessPointForObjectLambdaInput{} diff --git a/service/s3control/api_op_CreateBucket.go b/service/s3control/api_op_CreateBucket.go index 093e8ee9d71..428694411de 100644 --- a/service/s3control/api_op_CreateBucket.go +++ b/service/s3control/api_op_CreateBucket.go @@ -13,52 +13,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see -// Create Bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) in the -// Amazon S3 API Reference. Creates a new Outposts bucket. By creating the bucket, -// you become the bucket owner. To create an Outposts bucket, you must have S3 on -// Outposts. For more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in -// Amazon S3 User Guide. Not every string is an acceptable bucket name. For -// information on bucket naming restrictions, see Working with Amazon S3 Buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules). -// S3 on Outposts buckets support: +// This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, +// see Create Bucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) +// in the Amazon S3 API Reference. Creates a new Outposts bucket. By creating the +// bucket, you become the bucket owner. To create an Outposts bucket, you must have +// S3 on Outposts. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in Amazon S3 User Guide. Not every string is an acceptable bucket name. For +// information on bucket naming restrictions, see Working with Amazon S3 Buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules) +// . S3 on Outposts buckets support: +// - Tags +// - LifecycleConfigurations for deleting expired objects // -// * Tags -// -// * LifecycleConfigurations for deleting -// expired objects -// -// For a complete list of restrictions and Amazon S3 feature -// limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and -// Limitations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html). -// For an example of the request syntax for Amazon S3 on Outposts that uses the S3 -// on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, -// see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples) +// For a complete list of restrictions and Amazon S3 feature limitations on S3 on +// Outposts, see Amazon S3 on Outposts Restrictions and Limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html) +// . For an example of the request syntax for Amazon S3 on Outposts that uses the +// S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API +// request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples) // section. The following actions are related to CreateBucket for Amazon S3 on // Outposts: -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// GetBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html) -// -// * -// CreateAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) -// -// * -// PutAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html) +// - CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) +// - PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { params = &CreateBucketInput{} @@ -85,8 +62,8 @@ type CreateBucketInput struct { // Outposts buckets. ACL types.BucketCannedACL - // The configuration information for the bucket. This is not supported by Amazon S3 - // on Outposts buckets. + // The configuration information for the bucket. This is not supported by Amazon + // S3 on Outposts buckets. CreateBucketConfiguration *types.CreateBucketConfiguration // Allows grantee the read, write, read ACP, and write ACP permissions on the @@ -105,16 +82,16 @@ type CreateBucketInput struct { // is not supported by Amazon S3 on Outposts buckets. GrantWrite *string - // Allows grantee to write the ACL for the applicable bucket. This is not supported - // by Amazon S3 on Outposts buckets. + // Allows grantee to write the ACL for the applicable bucket. This is not + // supported by Amazon S3 on Outposts buckets. GrantWriteACP *string - // Specifies whether you want S3 Object Lock to be enabled for the new bucket. This - // is not supported by Amazon S3 on Outposts buckets. + // Specifies whether you want S3 Object Lock to be enabled for the new bucket. + // This is not supported by Amazon S3 on Outposts buckets. ObjectLockEnabledForBucket bool - // The ID of the Outposts where the bucket is being created. This ID is required by - // Amazon S3 on Outposts buckets. + // The ID of the Outposts where the bucket is being created. This ID is required + // by Amazon S3 on Outposts buckets. OutpostId *string noSmithyDocumentSerde @@ -126,10 +103,10 @@ type CreateBucketOutput struct { // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed - // in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the - // bucket reports through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // in the format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access + // the bucket reports through Outpost my-outpost owned by account 123456789012 in + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. BucketArn *string diff --git a/service/s3control/api_op_CreateJob.go b/service/s3control/api_op_CreateJob.go index 169da758cac..47f0446de7e 100644 --- a/service/s3control/api_op_CreateJob.go +++ b/service/s3control/api_op_CreateJob.go @@ -17,29 +17,14 @@ import ( // You can use S3 Batch Operations to perform large-scale batch actions on Amazon // S3 objects. Batch Operations can run a single action on lists of Amazon S3 -// objects that you specify. For more information, see S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the -// Amazon S3 User Guide. This action creates a S3 Batch Operations job. Related -// actions include: -// -// * DescribeJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) -// -// * -// ListJobs -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) -// -// * -// UpdateJobPriority -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) -// -// * -// UpdateJobStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) -// -// * -// JobOperation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html) +// objects that you specify. For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) +// in the Amazon S3 User Guide. This action creates a S3 Batch Operations job. +// Related actions include: +// - DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) +// - ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) +// - UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) +// - UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) +// - JobOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html) func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -69,9 +54,8 @@ type CreateJobInput struct { ClientRequestToken *string // The action that you want this job to perform on every object listed in the - // manifest. For more information about the available actions, see Operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html) in the - // Amazon S3 User Guide. + // manifest. For more information about the available actions, see Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html) + // in the Amazon S3 User Guide. // // This member is required. Operation *types.JobOperation @@ -86,9 +70,9 @@ type CreateJobInput struct { // This member is required. Report *types.JobReport - // The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role - // that Batch Operations will use to run this job's action on every object in the - // manifest. + // The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) + // role that Batch Operations will use to run this job's action on every object in + // the manifest. // // This member is required. RoleArn *string @@ -108,8 +92,8 @@ type CreateJobInput struct { // with either a manifest file or a ManifestGenerator, but not both. ManifestGenerator types.JobManifestGenerator - // A set of tags to associate with the S3 Batch Operations job. This is an optional - // parameter. + // A set of tags to associate with the S3 Batch Operations job. This is an + // optional parameter. Tags []types.S3Tag noSmithyDocumentSerde diff --git a/service/s3control/api_op_CreateMultiRegionAccessPoint.go b/service/s3control/api_op_CreateMultiRegionAccessPoint.go index ebf247a17a2..14faa347f0f 100644 --- a/service/s3control/api_op_CreateMultiRegionAccessPoint.go +++ b/service/s3control/api_op_CreateMultiRegionAccessPoint.go @@ -17,33 +17,19 @@ import ( // Creates a Multi-Region Access Point and associates it with the specified // buckets. For more information about creating Multi-Region Access Points, see -// Creating Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html) +// Creating Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. This action will always be routed to the US West // (Oregon) Region. For more information about the restrictions around managing -// Multi-Region Access Points, see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. This request is asynchronous, meaning that you // might receive a response before the command has completed. When this request // provides a response, it provides a token that you can use to monitor the status -// of the request with DescribeMultiRegionAccessPointOperation. The following -// actions are related to CreateMultiRegionAccessPoint: -// -// * -// DeleteMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) -// -// * -// DescribeMultiRegionAccessPointOperation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) -// -// * -// GetMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) -// -// * -// ListMultiRegionAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) +// of the request with DescribeMultiRegionAccessPointOperation . The following +// actions are related to CreateMultiRegionAccessPoint : +// - DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) +// - DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) +// - GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) +// - ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) func (c *Client) CreateMultiRegionAccessPoint(ctx context.Context, params *CreateMultiRegionAccessPointInput, optFns ...func(*Options)) (*CreateMultiRegionAccessPointOutput, error) { if params == nil { params = &CreateMultiRegionAccessPointInput{} @@ -85,8 +71,7 @@ type CreateMultiRegionAccessPointInput struct { type CreateMultiRegionAccessPointOutput struct { // The request token associated with the request. You can use this token with - // DescribeMultiRegionAccessPointOperation - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) + // DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string diff --git a/service/s3control/api_op_DeleteAccessPoint.go b/service/s3control/api_op_DeleteAccessPoint.go index b34f9d10ece..358d8177e2a 100644 --- a/service/s3control/api_op_DeleteAccessPoint.go +++ b/service/s3control/api_op_DeleteAccessPoint.go @@ -15,25 +15,15 @@ import ( ) // Deletes the specified access point. All Amazon S3 on Outposts REST API requests -// for this action require an additional parameter of x-amz-outpost-id to be passed -// with the request. In addition, you must use an S3 on Outposts endpoint hostname -// prefix instead of s3-control. For an example of the request syntax for Amazon S3 -// on Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) -// section. The following actions are related to DeleteAccessPoint: -// -// * -// CreateAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) -// -// * -// GetAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) -// -// * -// ListAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) +// for this action require an additional parameter of x-amz-outpost-id to be +// passed with the request. In addition, you must use an S3 on Outposts endpoint +// hostname prefix instead of s3-control . For an example of the request syntax for +// Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and +// the x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples) +// section. The following actions are related to DeleteAccessPoint : +// - CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) +// - GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) +// - ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error) { if params == nil { params = &DeleteAccessPointInput{} @@ -61,11 +51,11 @@ type DeleteAccessPointInput struct { // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the access point - // accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/. For example, - // to access the access point reports-ap through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. - // The value must be URL encoded. + // accessed in the format arn:aws:s3-outposts:::outpost//accesspoint/ . For + // example, to access the access point reports-ap through Outpost my-outpost owned + // by account 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap + // . The value must be URL encoded. // // This member is required. Name *string diff --git a/service/s3control/api_op_DeleteAccessPointForObjectLambda.go b/service/s3control/api_op_DeleteAccessPointForObjectLambda.go index 630f102f0ee..8561a3002d5 100644 --- a/service/s3control/api_op_DeleteAccessPointForObjectLambda.go +++ b/service/s3control/api_op_DeleteAccessPointForObjectLambda.go @@ -15,18 +15,10 @@ import ( ) // Deletes the specified Object Lambda Access Point. The following actions are -// related to DeleteAccessPointForObjectLambda: -// -// * CreateAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) -// -// * -// GetAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) -// -// * -// ListAccessPointsForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) +// related to DeleteAccessPointForObjectLambda : +// - CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) +// - GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) +// - ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) func (c *Client) DeleteAccessPointForObjectLambda(ctx context.Context, params *DeleteAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*DeleteAccessPointForObjectLambdaOutput, error) { if params == nil { params = &DeleteAccessPointForObjectLambdaInput{} diff --git a/service/s3control/api_op_DeleteAccessPointPolicy.go b/service/s3control/api_op_DeleteAccessPointPolicy.go index 130fa41157d..81815722bba 100644 --- a/service/s3control/api_op_DeleteAccessPointPolicy.go +++ b/service/s3control/api_op_DeleteAccessPointPolicy.go @@ -14,23 +14,16 @@ import ( "strings" ) -// Deletes the access point policy for the specified access point. All Amazon S3 on -// Outposts REST API requests for this action require an additional parameter of +// Deletes the access point policy for the specified access point. All Amazon S3 +// on Outposts REST API requests for this action require an additional parameter of // x-amz-outpost-id to be passed with the request. In addition, you must use an S3 -// on Outposts endpoint hostname prefix instead of s3-control. For an example of +// on Outposts endpoint hostname prefix instead of s3-control . For an example of // the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts // endpoint hostname prefix and the x-amz-outpost-id derived by using the access -// point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) -// section. The following actions are related to DeleteAccessPointPolicy: -// -// * -// PutAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) -// -// * -// GetAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html) +// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples) +// section. The following actions are related to DeleteAccessPointPolicy : +// - PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) +// - GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html) func (c *Client) DeleteAccessPointPolicy(ctx context.Context, params *DeleteAccessPointPolicyInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyOutput, error) { if params == nil { params = &DeleteAccessPointPolicyInput{} @@ -58,11 +51,11 @@ type DeleteAccessPointPolicyInput struct { // name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of // the access point accessed in the format - // arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access + // arn:aws:s3-outposts:::outpost//accesspoint/ . For example, to access the access // point reports-ap through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. - // The value must be URL encoded. + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap + // . The value must be URL encoded. // // This member is required. Name *string diff --git a/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go index 81aa2dd0744..b087daaaeba 100644 --- a/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go @@ -15,15 +15,9 @@ import ( ) // Removes the resource policy for an Object Lambda Access Point. The following -// actions are related to DeleteAccessPointPolicyForObjectLambda: -// -// * -// GetAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html) -// -// * -// PutAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html) +// actions are related to DeleteAccessPointPolicyForObjectLambda : +// - GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html) +// - PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html) func (c *Client) DeleteAccessPointPolicyForObjectLambda(ctx context.Context, params *DeleteAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyForObjectLambdaOutput, error) { if params == nil { params = &DeleteAccessPointPolicyForObjectLambdaInput{} diff --git a/service/s3control/api_op_DeleteBucket.go b/service/s3control/api_op_DeleteBucket.go index 0577fe9d04d..fa4bfe50874 100644 --- a/service/s3control/api_op_DeleteBucket.go +++ b/service/s3control/api_op_DeleteBucket.go @@ -14,33 +14,22 @@ import ( "strings" ) -// This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) in the -// Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket. All objects -// (including all object versions and delete markers) in the bucket must be deleted -// before the bucket itself can be deleted. For more information, see Using Amazon -// S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in -// Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this -// action require an additional parameter of x-amz-outpost-id to be passed with the -// request. In addition, you must use an S3 on Outposts endpoint hostname prefix -// instead of s3-control. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) +// This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, +// see DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) +// in the Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket. All +// objects (including all object versions and delete markers) in the bucket must be +// deleted before the bucket itself can be deleted. For more information, see +// Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this +// action require an additional parameter of x-amz-outpost-id to be passed with +// the request. In addition, you must use an S3 on Outposts endpoint hostname +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples) // section. Related Resources -// -// * CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) -// -// * -// GetBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html) -// -// * -// DeleteObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) +// - GetBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html) +// - DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) { if params == nil { params = &DeleteBucketInput{} @@ -67,10 +56,10 @@ type DeleteBucketInput struct { // Outposts with the REST API, you must specify the name and the x-amz-outpost-id // as well. For using this parameter with S3 on Outposts with the Amazon Web // Services SDK and CLI, you must specify the ARN of the bucket accessed in the - // format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket - // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the + // bucket reports through Outpost my-outpost owned by account 123456789012 in + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go b/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go index d606b8455f7..6a47ea87b0c 100644 --- a/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go @@ -15,36 +15,27 @@ import ( ) // This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. -// To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) +// To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) // in the Amazon S3 API Reference. Deletes the lifecycle configuration from the // specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle // configuration rules in the lifecycle subresource associated with the bucket. // Your objects never expire, and Amazon S3 on Outposts no longer automatically // deletes any objects on the basis of rules contained in the deleted lifecycle -// configuration. For more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in -// Amazon S3 User Guide. To use this action, you must have permission to perform +// configuration. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in Amazon S3 User Guide. To use this action, you must have permission to perform // the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket // owner has this permission and the Outposts bucket owner can grant this // permission to others. All Amazon S3 on Outposts REST API requests for this -// action require an additional parameter of x-amz-outpost-id to be passed with the -// request. In addition, you must use an S3 on Outposts endpoint hostname prefix -// instead of s3-control. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) +// action require an additional parameter of x-amz-outpost-id to be passed with +// the request. In addition, you must use an S3 on Outposts endpoint hostname +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples) // section. For more information about object expiration, see Elements to Describe -// Lifecycle Actions -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions). -// Related actions include: -// -// * PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) +// Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions) +// . Related actions include: +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) func (c *Client) DeleteBucketLifecycleConfiguration(ctx context.Context, params *DeleteBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*DeleteBucketLifecycleConfigurationOutput, error) { if params == nil { params = &DeleteBucketLifecycleConfigurationInput{} @@ -71,10 +62,10 @@ type DeleteBucketLifecycleConfigurationInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_DeleteBucketPolicy.go b/service/s3control/api_op_DeleteBucketPolicy.go index df0367897a5..3a05e00974f 100644 --- a/service/s3control/api_op_DeleteBucketPolicy.go +++ b/service/s3control/api_op_DeleteBucketPolicy.go @@ -15,41 +15,31 @@ import ( ) // This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 -// bucket policy, see DeleteBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html) in -// the Amazon S3 API Reference. This implementation of the DELETE action uses the -// policy subresource to delete the policy of a specified Amazon S3 on Outposts +// bucket policy, see DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html) +// in the Amazon S3 API Reference. This implementation of the DELETE action uses +// the policy subresource to delete the policy of a specified Amazon S3 on Outposts // bucket. If you are using an identity other than the root user of the Amazon Web // Services account that owns the bucket, the calling identity must have the // s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and // belong to the bucket owner's account to use this action. For more information, -// see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in -// Amazon S3 User Guide. If you don't have DeleteBucketPolicy permissions, Amazon -// S3 returns a 403 Access Denied error. If you have the correct permissions, but -// you're not using an identity that belongs to the bucket owner's account, Amazon -// S3 returns a 405 Method Not Allowed error. As a security precaution, the root -// user of the Amazon Web Services account that owns a bucket can always use this -// action, even if the policy explicitly denies the root user the ability to -// perform this action. For more information about bucket policies, see Using -// Bucket Policies and User Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). All -// Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request. In addition, you -// must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For -// an example of the request syntax for Amazon S3 on Outposts that uses the S3 on -// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the -// access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) -// section. The following actions are related to DeleteBucketPolicy: -// -// * -// GetBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html) -// -// * -// PutBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html) +// see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in Amazon S3 User Guide. If you don't have DeleteBucketPolicy permissions, +// Amazon S3 returns a 403 Access Denied error. If you have the correct +// permissions, but you're not using an identity that belongs to the bucket owner's +// account, Amazon S3 returns a 405 Method Not Allowed error. As a security +// precaution, the root user of the Amazon Web Services account that owns a bucket +// can always use this action, even if the policy explicitly denies the root user +// the ability to perform this action. For more information about bucket policies, +// see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples) +// section. The following actions are related to DeleteBucketPolicy : +// - GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html) +// - PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html) func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error) { if params == nil { params = &DeleteBucketPolicyInput{} @@ -76,10 +66,10 @@ type DeleteBucketPolicyInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_DeleteBucketReplication.go b/service/s3control/api_op_DeleteBucketReplication.go index 935dd2fa5a9..63ae2088c16 100644 --- a/service/s3control/api_op_DeleteBucketReplication.go +++ b/service/s3control/api_op_DeleteBucketReplication.go @@ -16,16 +16,13 @@ import ( // This operation deletes an Amazon S3 on Outposts bucket's replication // configuration. To delete an S3 bucket's replication configuration, see -// DeleteBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) +// DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) // in the Amazon S3 API Reference. Deletes the replication configuration from the // specified S3 on Outposts bucket. To use this operation, you must have // permissions to perform the s3-outposts:PutReplicationConfiguration action. The // Outposts bucket owner has this permission by default and can grant it to others. -// For more information about permissions, see Setting up IAM with S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) and -// Managing access to S3 on Outposts buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html) +// For more information about permissions, see Setting up IAM with S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) +// and Managing access to S3 on Outposts buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html) // in the Amazon S3 User Guide. It can take a while to propagate PUT or DELETE // requests for a replication configuration to all S3 on Outposts systems. // Therefore, the replication configuration that's returned by a GET request soon @@ -34,23 +31,16 @@ import ( // configuration on that Outpost can be significant. All Amazon S3 on Outposts REST // API requests for this action require an additional parameter of x-amz-outpost-id // to be passed with the request. In addition, you must use an S3 on Outposts -// endpoint hostname prefix instead of s3-control. For an example of the request +// endpoint hostname prefix instead of s3-control . For an example of the request // syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname // prefix and the x-amz-outpost-id derived by using the access point ARN, see the -// Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html#API_control_DeleteBucketReplication_Examples) +// Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html#API_control_DeleteBucketReplication_Examples) // section. For information about S3 replication on Outposts configuration, see -// Replicating objects for S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) +// Replicating objects for S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) // in the Amazon S3 User Guide. The following operations are related to -// DeleteBucketReplication: -// -// * PutBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html) -// -// * -// GetBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html) +// DeleteBucketReplication : +// - PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html) +// - GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html) func (c *Client) DeleteBucketReplication(ctx context.Context, params *DeleteBucketReplicationInput, optFns ...func(*Options)) (*DeleteBucketReplicationOutput, error) { if params == nil { params = &DeleteBucketReplicationInput{} @@ -74,14 +64,15 @@ type DeleteBucketReplicationInput struct { // This member is required. AccountId *string - // Specifies the S3 on Outposts bucket to delete the replication configuration for. - // For using this parameter with Amazon S3 on Outposts with the REST API, you must - // specify the name and the x-amz-outpost-id as well. For using this parameter with - // S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the - // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. - // For example, to access the bucket reports through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // Specifies the S3 on Outposts bucket to delete the replication configuration + // for. For using this parameter with Amazon S3 on Outposts with the REST API, you + // must specify the name and the x-amz-outpost-id as well. For using this parameter + // with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify + // the ARN of the bucket accessed in the format + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket + // reports through Outpost my-outpost owned by account 123456789012 in Region + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_DeleteBucketTagging.go b/service/s3control/api_op_DeleteBucketTagging.go index 8beddb7a9f9..2da35d5266e 100644 --- a/service/s3control/api_op_DeleteBucketTagging.go +++ b/service/s3control/api_op_DeleteBucketTagging.go @@ -15,29 +15,20 @@ import ( ) // This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 -// bucket tags, see DeleteBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) +// bucket tags, see DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) // in the Amazon S3 API Reference. Deletes the tags from the Outposts bucket. For -// more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in -// Amazon S3 User Guide. To use this action, you must have permission to perform +// more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in Amazon S3 User Guide. To use this action, you must have permission to perform // the PutBucketTagging action. By default, the bucket owner has this permission // and can grant this permission to others. All Amazon S3 on Outposts REST API // requests for this action require an additional parameter of x-amz-outpost-id to // be passed with the request. In addition, you must use an S3 on Outposts endpoint -// hostname prefix instead of s3-control. For an example of the request syntax for +// hostname prefix instead of s3-control . For an example of the request syntax for // Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and -// the x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) -// section. The following actions are related to DeleteBucketTagging: -// -// * -// GetBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html) -// -// * -// PutBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html) +// the x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples) +// section. The following actions are related to DeleteBucketTagging : +// - GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html) +// - PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html) func (c *Client) DeleteBucketTagging(ctx context.Context, params *DeleteBucketTaggingInput, optFns ...func(*Options)) (*DeleteBucketTaggingOutput, error) { if params == nil { params = &DeleteBucketTaggingInput{} @@ -60,14 +51,14 @@ type DeleteBucketTaggingInput struct { // This member is required. AccountId *string - // The bucket ARN that has the tag set to be removed. For using this parameter with - // Amazon S3 on Outposts with the REST API, you must specify the name and the + // The bucket ARN that has the tag set to be removed. For using this parameter + // with Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed - // in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the - // bucket reports through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // in the format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access + // the bucket reports through Outpost my-outpost owned by account 123456789012 in + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_DeleteJobTagging.go b/service/s3control/api_op_DeleteJobTagging.go index 5d93b3b72a9..7b3ce8e8270 100644 --- a/service/s3control/api_op_DeleteJobTagging.go +++ b/service/s3control/api_op_DeleteJobTagging.go @@ -17,20 +17,11 @@ import ( // Removes the entire tag set from the specified S3 Batch Operations job. To use // the DeleteJobTagging operation, you must have permission to perform the // s3:DeleteJobTagging action. For more information, see Controlling access and -// labeling jobs using tags -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) +// labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) // in the Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// GetJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html) -// -// * -// PutJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html) +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html) +// - PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html) func (c *Client) DeleteJobTagging(ctx context.Context, params *DeleteJobTaggingInput, optFns ...func(*Options)) (*DeleteJobTaggingOutput, error) { if params == nil { params = &DeleteJobTaggingInput{} diff --git a/service/s3control/api_op_DeleteMultiRegionAccessPoint.go b/service/s3control/api_op_DeleteMultiRegionAccessPoint.go index 09be36210b4..07ef8807d23 100644 --- a/service/s3control/api_op_DeleteMultiRegionAccessPoint.go +++ b/service/s3control/api_op_DeleteMultiRegionAccessPoint.go @@ -19,29 +19,16 @@ import ( // associated with the Multi-Region Access Point, only the Multi-Region Access // Point itself. This action will always be routed to the US West (Oregon) Region. // For more information about the restrictions around managing Multi-Region Access -// Points, see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. This request is asynchronous, meaning that you // might receive a response before the command has completed. When this request // provides a response, it provides a token that you can use to monitor the status -// of the request with DescribeMultiRegionAccessPointOperation. The following -// actions are related to DeleteMultiRegionAccessPoint: -// -// * -// CreateMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) -// -// * -// DescribeMultiRegionAccessPointOperation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) -// -// * -// GetMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) -// -// * -// ListMultiRegionAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) +// of the request with DescribeMultiRegionAccessPointOperation . The following +// actions are related to DeleteMultiRegionAccessPoint : +// - CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) +// - DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) +// - GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) +// - ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) func (c *Client) DeleteMultiRegionAccessPoint(ctx context.Context, params *DeleteMultiRegionAccessPointInput, optFns ...func(*Options)) (*DeleteMultiRegionAccessPointOutput, error) { if params == nil { params = &DeleteMultiRegionAccessPointInput{} @@ -82,8 +69,7 @@ type DeleteMultiRegionAccessPointInput struct { type DeleteMultiRegionAccessPointOutput struct { // The request token associated with the request. You can use this token with - // DescribeMultiRegionAccessPointOperation - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) + // DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string diff --git a/service/s3control/api_op_DeletePublicAccessBlock.go b/service/s3control/api_op_DeletePublicAccessBlock.go index 5242e4aef46..80e01d86bf0 100644 --- a/service/s3control/api_op_DeletePublicAccessBlock.go +++ b/service/s3control/api_op_DeletePublicAccessBlock.go @@ -15,16 +15,10 @@ import ( ) // Removes the PublicAccessBlock configuration for an Amazon Web Services account. -// For more information, see Using Amazon S3 block public access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html). -// Related actions include: -// -// * GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html) -// -// * -// PutPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html) +// For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// . Related actions include: +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html) +// - PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html) func (c *Client) DeletePublicAccessBlock(ctx context.Context, params *DeletePublicAccessBlockInput, optFns ...func(*Options)) (*DeletePublicAccessBlockOutput, error) { if params == nil { params = &DeletePublicAccessBlockInput{} diff --git a/service/s3control/api_op_DeleteStorageLensConfiguration.go b/service/s3control/api_op_DeleteStorageLensConfiguration.go index 3143c0bb91e..093b223e759 100644 --- a/service/s3control/api_op_DeleteStorageLensConfiguration.go +++ b/service/s3control/api_op_DeleteStorageLensConfiguration.go @@ -16,12 +16,10 @@ import ( // Deletes the Amazon S3 Storage Lens configuration. For more information about S3 // Storage Lens, see Assessing your storage activity and usage with Amazon S3 -// Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the s3:DeleteStorageLensConfiguration action. For more information, see Setting -// permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the s3:DeleteStorageLensConfiguration action. For more information, see +// Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) DeleteStorageLensConfiguration(ctx context.Context, params *DeleteStorageLensConfigurationInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationOutput, error) { if params == nil { diff --git a/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go b/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go index 47e1bce56da..05d00ed88f8 100644 --- a/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go @@ -15,13 +15,11 @@ import ( ) // Deletes the Amazon S3 Storage Lens configuration tags. For more information -// about S3 Storage Lens, see Assessing your storage activity and usage with Amazon -// S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the s3:DeleteStorageLensConfigurationTagging action. For more information, see -// Setting permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// about S3 Storage Lens, see Assessing your storage activity and usage with +// Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the s3:DeleteStorageLensConfigurationTagging action. For more +// information, see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) DeleteStorageLensConfigurationTagging(ctx context.Context, params *DeleteStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationTaggingOutput, error) { if params == nil { diff --git a/service/s3control/api_op_DescribeJob.go b/service/s3control/api_op_DescribeJob.go index 8f9138b0ef5..aae9a1f1a18 100644 --- a/service/s3control/api_op_DescribeJob.go +++ b/service/s3control/api_op_DescribeJob.go @@ -16,24 +16,12 @@ import ( ) // Retrieves the configuration parameters and status for a Batch Operations job. -// For more information, see S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the -// Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// ListJobs -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) -// -// * -// UpdateJobPriority -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) -// -// * -// UpdateJobStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) +// For more information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) +// in the Amazon S3 User Guide. Related actions include: +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) +// - UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) +// - UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error) { if params == nil { params = &DescribeJobInput{} diff --git a/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go b/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go index 92f786c31aa..cb3a9bb2b04 100644 --- a/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go +++ b/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go @@ -17,25 +17,13 @@ import ( // Retrieves the status of an asynchronous request to manage a Multi-Region Access // Point. For more information about managing Multi-Region Access Points and how -// asynchronous requests work, see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// asynchronous requests work, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// GetMultiRegionAccessPoint: -// -// * CreateMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) -// -// * -// DeleteMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) -// -// * -// GetMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) -// -// * -// ListMultiRegionAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) +// GetMultiRegionAccessPoint : +// - CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) +// - DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) +// - GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) +// - ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) func (c *Client) DescribeMultiRegionAccessPointOperation(ctx context.Context, params *DescribeMultiRegionAccessPointOperationInput, optFns ...func(*Options)) (*DescribeMultiRegionAccessPointOperationOutput, error) { if params == nil { params = &DescribeMultiRegionAccessPointOperationInput{} diff --git a/service/s3control/api_op_GetAccessPoint.go b/service/s3control/api_op_GetAccessPoint.go index f15db2ccef4..7fb0eabb5cb 100644 --- a/service/s3control/api_op_GetAccessPoint.go +++ b/service/s3control/api_op_GetAccessPoint.go @@ -19,24 +19,14 @@ import ( // Returns configuration information about the specified access point. All Amazon // S3 on Outposts REST API requests for this action require an additional parameter // of x-amz-outpost-id to be passed with the request. In addition, you must use an -// S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts +// S3 on Outposts endpoint hostname prefix instead of s3-control . For an example +// of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts // endpoint hostname prefix and the x-amz-outpost-id derived by using the access -// point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) -// section. The following actions are related to GetAccessPoint: -// -// * -// CreateAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) -// -// * -// DeleteAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) -// -// * -// ListAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) +// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) +// section. The following actions are related to GetAccessPoint : +// - CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) +// - DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) +// - ListAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html) func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput, optFns ...func(*Options)) (*GetAccessPointOutput, error) { if params == nil { params = &GetAccessPointInput{} @@ -65,11 +55,11 @@ type GetAccessPointInput struct { // you must specify the name and the x-amz-outpost-id as well. For using this // parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must // specify the ARN of the access point accessed in the format - // arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access + // arn:aws:s3-outposts:::outpost//accesspoint/ . For example, to access the access // point reports-ap through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. - // The value must be URL encoded. + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap + // . The value must be URL encoded. // // This member is required. Name *string @@ -88,8 +78,8 @@ type GetAccessPointOutput struct { // The name of the bucket associated with the specified access point. Bucket *string - // The Amazon Web Services account ID associated with the S3 bucket associated with - // this access point. + // The Amazon Web Services account ID associated with the S3 bucket associated + // with this access point. BucketAccountId *string // The date and time when the specified access point was created. @@ -102,9 +92,9 @@ type GetAccessPointOutput struct { Name *string // Indicates whether this access point allows access from the public internet. If - // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, + // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , // and the access point doesn't allow access from the public internet. Otherwise, - // NetworkOrigin is Internet, and the access point allows access from the public + // NetworkOrigin is Internet , and the access point allows access from the public // internet, subject to the access point and bucket access policies. This will // always be true for an Amazon S3 on Outposts access point NetworkOrigin types.NetworkOrigin @@ -112,8 +102,7 @@ type GetAccessPointOutput struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // account. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on // Outposts. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration diff --git a/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go b/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go index 93bfc2f8d36..62a9ca70531 100644 --- a/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go @@ -16,11 +16,8 @@ import ( ) // Returns configuration for an Object Lambda Access Point. The following actions -// are related to GetAccessPointConfigurationForObjectLambda: -// -// * -// PutAccessPointConfigurationForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html) +// are related to GetAccessPointConfigurationForObjectLambda : +// - PutAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html) func (c *Client) GetAccessPointConfigurationForObjectLambda(ctx context.Context, params *GetAccessPointConfigurationForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointConfigurationForObjectLambdaOutput, error) { if params == nil { params = &GetAccessPointConfigurationForObjectLambdaInput{} diff --git a/service/s3control/api_op_GetAccessPointForObjectLambda.go b/service/s3control/api_op_GetAccessPointForObjectLambda.go index 2fb0467ab8c..050fc23cc97 100644 --- a/service/s3control/api_op_GetAccessPointForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointForObjectLambda.go @@ -16,20 +16,11 @@ import ( "time" ) -// Returns configuration information about the specified Object Lambda Access Point -// The following actions are related to GetAccessPointForObjectLambda: -// -// * -// CreateAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) -// -// * -// DeleteAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) -// -// * -// ListAccessPointsForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) +// Returns configuration information about the specified Object Lambda Access +// Point The following actions are related to GetAccessPointForObjectLambda : +// - CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) +// - DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) +// - ListAccessPointsForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html) func (c *Client) GetAccessPointForObjectLambda(ctx context.Context, params *GetAccessPointForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointForObjectLambdaOutput, error) { if params == nil { params = &GetAccessPointForObjectLambdaInput{} diff --git a/service/s3control/api_op_GetAccessPointPolicy.go b/service/s3control/api_op_GetAccessPointPolicy.go index 44a7e97aef7..04094bb01fa 100644 --- a/service/s3control/api_op_GetAccessPointPolicy.go +++ b/service/s3control/api_op_GetAccessPointPolicy.go @@ -15,14 +15,9 @@ import ( ) // Returns the access point policy associated with the specified access point. The -// following actions are related to GetAccessPointPolicy: -// -// * PutAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) -// -// * -// DeleteAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html) +// following actions are related to GetAccessPointPolicy : +// - PutAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html) +// - DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html) func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPointPolicyInput, optFns ...func(*Options)) (*GetAccessPointPolicyOutput, error) { if params == nil { params = &GetAccessPointPolicyInput{} @@ -50,11 +45,11 @@ type GetAccessPointPolicyInput struct { // name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of // the access point accessed in the format - // arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access + // arn:aws:s3-outposts:::outpost//accesspoint/ . For example, to access the access // point reports-ap through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. - // The value must be URL encoded. + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap + // . The value must be URL encoded. // // This member is required. Name *string diff --git a/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go index a3ae5b89901..9785009e46c 100644 --- a/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go @@ -15,15 +15,9 @@ import ( ) // Returns the resource policy for an Object Lambda Access Point. The following -// actions are related to GetAccessPointPolicyForObjectLambda: -// -// * -// DeleteAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html) -// -// * -// PutAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html) +// actions are related to GetAccessPointPolicyForObjectLambda : +// - DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html) +// - PutAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html) func (c *Client) GetAccessPointPolicyForObjectLambda(ctx context.Context, params *GetAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointPolicyForObjectLambdaOutput, error) { if params == nil { params = &GetAccessPointPolicyForObjectLambdaInput{} diff --git a/service/s3control/api_op_GetAccessPointPolicyStatus.go b/service/s3control/api_op_GetAccessPointPolicyStatus.go index fee3f750700..c50e42550a3 100644 --- a/service/s3control/api_op_GetAccessPointPolicyStatus.go +++ b/service/s3control/api_op_GetAccessPointPolicyStatus.go @@ -17,9 +17,8 @@ import ( // Indicates whether the specified access point currently has a policy that allows // public access. For more information about public access through access points, -// see Managing Data Access with Amazon S3 access points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) in -// the Amazon S3 User Guide. +// see Managing Data Access with Amazon S3 access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) +// in the Amazon S3 User Guide. func (c *Client) GetAccessPointPolicyStatus(ctx context.Context, params *GetAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetAccessPointPolicyStatusOutput, error) { if params == nil { params = &GetAccessPointPolicyStatusInput{} diff --git a/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go b/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go index 96c597b684a..a38d7a0d032 100644 --- a/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go @@ -50,10 +50,9 @@ type GetAccessPointPolicyStatusForObjectLambdaInput struct { type GetAccessPointPolicyStatusForObjectLambdaOutput struct { - // Indicates whether this access point policy is public. For more information about - // how Amazon S3 evaluates policies to determine whether they are public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Indicates whether this access point policy is public. For more information + // about how Amazon S3 evaluates policies to determine whether they are public, see + // The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. PolicyStatus *types.PolicyStatus diff --git a/service/s3control/api_op_GetBucket.go b/service/s3control/api_op_GetBucket.go index bdd29a31d27..babd3f9e2ae 100644 --- a/service/s3control/api_op_GetBucket.go +++ b/service/s3control/api_op_GetBucket.go @@ -15,37 +15,27 @@ import ( "time" ) -// Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 -// on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. If you are using an identity other than the root user of -// the Amazon Web Services account that owns the Outposts bucket, the calling -// identity must have the s3-outposts:GetBucket permissions on the specified -// Outposts bucket and belong to the Outposts bucket owner's account in order to -// use this action. Only users from Outposts bucket owner account with the right -// permissions can perform actions on an Outposts bucket. If you don't have +// Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon +// S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. If you are using an identity other than the root +// user of the Amazon Web Services account that owns the Outposts bucket, the +// calling identity must have the s3-outposts:GetBucket permissions on the +// specified Outposts bucket and belong to the Outposts bucket owner's account in +// order to use this action. Only users from Outposts bucket owner account with the +// right permissions can perform actions on an Outposts bucket. If you don't have // s3-outposts:GetBucket permissions or you're not using an identity that belongs // to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The -// following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon -// S3 on Outposts REST API requests for this action require an additional parameter -// of x-amz-outpost-id to be passed with the request. In addition, you must use an -// S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of -// the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts -// endpoint hostname prefix and the x-amz-outpost-id derived by using the access -// point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) +// following actions are related to GetBucket for Amazon S3 on Outposts: All +// Amazon S3 on Outposts REST API requests for this action require an additional +// parameter of x-amz-outpost-id to be passed with the request. In addition, you +// must use an S3 on Outposts endpoint hostname prefix instead of s3-control . For +// an example of the request syntax for Amazon S3 on Outposts that uses the S3 on +// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the +// access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples) // section. -// -// * PutObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) -// -// * -// CreateBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) -// -// * -// DeleteBucket -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html) +// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// - CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) +// - DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html) func (c *Client) GetBucket(ctx context.Context, params *GetBucketInput, optFns ...func(*Options)) (*GetBucketOutput, error) { if params == nil { params = &GetBucketInput{} @@ -72,10 +62,10 @@ type GetBucketInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_GetBucketLifecycleConfiguration.go b/service/s3control/api_op_GetBucketLifecycleConfiguration.go index 4e54f28ca81..e08f0db450e 100644 --- a/service/s3control/api_op_GetBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_GetBucketLifecycleConfiguration.go @@ -16,51 +16,33 @@ import ( ) // This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To -// get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) +// get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // in the Amazon S3 API Reference. Returns the lifecycle configuration information // set on the Outposts bucket. For more information, see Using Amazon S3 on -// Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) and -// for information about lifecycle configuration, see Object Lifecycle Management -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in -// Amazon S3 User Guide. To use this action, you must have permission to perform +// Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// and for information about lifecycle configuration, see Object Lifecycle +// Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// in Amazon S3 User Guide. To use this action, you must have permission to perform // the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has // this permission, by default. The bucket owner can grant this permission to // others. For more information about permissions, see Permissions Related to -// Bucket Subresource Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing Access Permissions to Your Amazon S3 Resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// All Amazon S3 on Outposts REST API requests for this action require an +// Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . All Amazon S3 on Outposts REST API requests for this action require an // additional parameter of x-amz-outpost-id to be passed with the request. In // addition, you must use an S3 on Outposts endpoint hostname prefix instead of -// s3-control. For an example of the request syntax for Amazon S3 on Outposts that +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that // uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id -// derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) // section. GetBucketLifecycleConfiguration has the following special error: +// - Error code: NoSuchLifecycleConfiguration +// - Description: The lifecycle configuration does not exist. +// - HTTP Status Code: 404 Not Found +// - SOAP Fault Code Prefix: Client // -// * -// Error code: NoSuchLifecycleConfiguration -// -// * Description: The lifecycle -// configuration does not exist. -// -// * HTTP Status Code: 404 Not Found -// -// * SOAP Fault -// Code Prefix: Client -// -// The following actions are related to -// GetBucketLifecycleConfiguration: -// -// * PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) -// -// * -// DeleteBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html) +// The following actions are related to GetBucketLifecycleConfiguration : +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// - DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html) func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*GetBucketLifecycleConfigurationOutput, error) { if params == nil { params = &GetBucketLifecycleConfigurationInput{} @@ -87,10 +69,10 @@ type GetBucketLifecycleConfigurationInput struct { // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed - // in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the - // bucket reports through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // in the format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access + // the bucket reports through Outpost my-outpost owned by account 123456789012 in + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_GetBucketPolicy.go b/service/s3control/api_op_GetBucketPolicy.go index c23eaabcc4d..f1f01efccdb 100644 --- a/service/s3control/api_op_GetBucketPolicy.go +++ b/service/s3control/api_op_GetBucketPolicy.go @@ -15,43 +15,31 @@ import ( ) // This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a -// policy for an S3 bucket, see GetBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html) in -// the Amazon S3 API Reference. Returns the policy of a specified Outposts bucket. -// For more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. If you are using an identity other than the root user of -// the Amazon Web Services account that owns the bucket, the calling identity must -// have the GetBucketPolicy permissions on the specified bucket and belong to the -// bucket owner's account in order to use this action. Only users from Outposts -// bucket owner account with the right permissions can perform actions on an -// Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or -// you're not using an identity that belongs to the bucket owner's account, Amazon -// S3 returns a 403 Access Denied error. As a security precaution, the root user of -// the Amazon Web Services account that owns a bucket can always use this action, -// even if the policy explicitly denies the root user the ability to perform this -// action. For more information about bucket policies, see Using Bucket Policies -// and User Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). All -// Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request. In addition, you -// must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For -// an example of the request syntax for Amazon S3 on Outposts that uses the S3 on -// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the -// access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) -// section. The following actions are related to GetBucketPolicy: -// -// * GetObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) -// -// * -// PutBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html) -// -// * -// DeleteBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html) +// policy for an S3 bucket, see GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html) +// in the Amazon S3 API Reference. Returns the policy of a specified Outposts +// bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. If you are using an identity other than the root +// user of the Amazon Web Services account that owns the bucket, the calling +// identity must have the GetBucketPolicy permissions on the specified bucket and +// belong to the bucket owner's account in order to use this action. Only users +// from Outposts bucket owner account with the right permissions can perform +// actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy +// permissions or you're not using an identity that belongs to the bucket owner's +// account, Amazon S3 returns a 403 Access Denied error. As a security precaution, +// the root user of the Amazon Web Services account that owns a bucket can always +// use this action, even if the policy explicitly denies the root user the ability +// to perform this action. For more information about bucket policies, see Using +// Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples) +// section. The following actions are related to GetBucketPolicy : +// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// - PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html) +// - DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html) func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error) { if params == nil { params = &GetBucketPolicyInput{} @@ -78,10 +66,10 @@ type GetBucketPolicyInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_GetBucketReplication.go b/service/s3control/api_op_GetBucketReplication.go index 240265b0cd9..c4984d69dec 100644 --- a/service/s3control/api_op_GetBucketReplication.go +++ b/service/s3control/api_op_GetBucketReplication.go @@ -15,49 +15,38 @@ import ( "strings" ) -// This operation gets an Amazon S3 on Outposts bucket's replication configuration. -// To get an S3 bucket's replication configuration, see GetBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) +// This operation gets an Amazon S3 on Outposts bucket's replication +// configuration. To get an S3 bucket's replication configuration, see +// GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) // in the Amazon S3 API Reference. Returns the replication configuration of an S3 // on Outposts bucket. For more information about S3 on Outposts, see Using Amazon -// S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. For information about S3 replication on Outposts -// configuration, see Replicating objects for S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) +// S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. For information about S3 replication on Outposts +// configuration, see Replicating objects for S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) // in the Amazon S3 User Guide. It can take a while to propagate PUT or DELETE // requests for a replication configuration to all S3 on Outposts systems. // Therefore, the replication configuration that's returned by a GET request soon // after a PUT or DELETE request might return a more recent result than what's on // the Outpost. If an Outpost is offline, the delay in updating the replication // configuration on that Outpost can be significant. This action requires -// permissions for the s3-outposts:GetReplicationConfiguration action. The Outposts -// bucket owner has this permission by default and can grant it to others. For more -// information about permissions, see Setting up IAM with S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) and -// Managing access to S3 on Outposts bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html) +// permissions for the s3-outposts:GetReplicationConfiguration action. The +// Outposts bucket owner has this permission by default and can grant it to others. +// For more information about permissions, see Setting up IAM with S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) +// and Managing access to S3 on Outposts bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html) // in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for // this action require an additional parameter of x-amz-outpost-id to be passed // with the request. In addition, you must use an S3 on Outposts endpoint hostname -// prefix instead of s3-control. For an example of the request syntax for Amazon S3 -// on Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html#API_control_GetBucketReplication_Examples) +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html#API_control_GetBucketReplication_Examples) // section. If you include the Filter element in a replication configuration, you -// must also include the DeleteMarkerReplication, Status, and Priority elements. +// must also include the DeleteMarkerReplication , Status , and Priority elements. // The response also returns those elements. For information about S3 on Outposts -// replication failure reasons, see Replication failure reasons -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes) +// replication failure reasons, see Replication failure reasons (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes) // in the Amazon S3 User Guide. The following operations are related to -// GetBucketReplication: -// -// * PutBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html) -// -// * -// DeleteBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html) +// GetBucketReplication : +// - PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html) +// - DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html) func (c *Client) GetBucketReplication(ctx context.Context, params *GetBucketReplicationInput, optFns ...func(*Options)) (*GetBucketReplicationOutput, error) { if params == nil { params = &GetBucketReplicationInput{} @@ -84,10 +73,10 @@ type GetBucketReplicationInput struct { // parameter with Amazon S3 on Outposts with the REST API, you must specify the // name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of - // the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For + // the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/ . For // example, to access the bucket reports through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // account 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_GetBucketTagging.go b/service/s3control/api_op_GetBucketTagging.go index 50d4eb5aca9..d19f7fe4653 100644 --- a/service/s3control/api_op_GetBucketTagging.go +++ b/service/s3control/api_op_GetBucketTagging.go @@ -16,37 +16,25 @@ import ( ) // This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket -// tags, see GetBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) in -// the Amazon S3 API Reference. Returns the tag set associated with the Outposts -// bucket. For more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the GetBucketTagging action. By default, the bucket owner has this permission -// and can grant this permission to others. GetBucketTagging has the following -// special error: +// tags, see GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) +// in the Amazon S3 API Reference. Returns the tag set associated with the Outposts +// bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the GetBucketTagging action. By default, the bucket owner has this +// permission and can grant this permission to others. GetBucketTagging has the +// following special error: +// - Error code: NoSuchTagSetError +// - Description: There is no tag set associated with the bucket. // -// * Error code: NoSuchTagSetError -// -// * Description: There is no tag -// set associated with the bucket. -// -// All Amazon S3 on Outposts REST API requests for -// this action require an additional parameter of x-amz-outpost-id to be passed -// with the request. In addition, you must use an S3 on Outposts endpoint hostname -// prefix instead of s3-control. For an example of the request syntax for Amazon S3 -// on Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) -// section. The following actions are related to GetBucketTagging: -// -// * -// PutBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html) -// -// * -// DeleteBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html) +// All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples) +// section. The following actions are related to GetBucketTagging : +// - PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html) +// - DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html) func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingInput, optFns ...func(*Options)) (*GetBucketTaggingOutput, error) { if params == nil { params = &GetBucketTaggingInput{} @@ -73,10 +61,10 @@ type GetBucketTaggingInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_GetBucketVersioning.go b/service/s3control/api_op_GetBucketVersioning.go index 3ceac7fb6ab..ce2daaff716 100644 --- a/service/s3control/api_op_GetBucketVersioning.go +++ b/service/s3control/api_op_GetBucketVersioning.go @@ -16,35 +16,24 @@ import ( ) // This operation returns the versioning state for S3 on Outposts buckets only. To -// return the versioning state for an S3 bucket, see GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// return the versioning state for an S3 bucket, see GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) // in the Amazon S3 API Reference. Returns the versioning state for an S3 on // Outposts bucket. With S3 Versioning, you can save multiple distinct copies of // your objects and recover from unintended user actions and application failures. // If you've never set versioning on your bucket, it has no versioning state. In // that case, the GetBucketVersioning request does not return a versioning state -// value. For more information about versioning, see Versioning -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) in the -// Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this -// action require an additional parameter of x-amz-outpost-id to be passed with the -// request. In addition, you must use an S3 on Outposts endpoint hostname prefix -// instead of s3-control. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples) +// value. For more information about versioning, see Versioning (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) +// in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for +// this action require an additional parameter of x-amz-outpost-id to be passed +// with the request. In addition, you must use an S3 on Outposts endpoint hostname +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples) // section. The following operations are related to GetBucketVersioning for S3 on // Outposts. -// -// * PutBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html) -// -// * -// PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) +// - PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html) +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) func (c *Client) GetBucketVersioning(ctx context.Context, params *GetBucketVersioningInput, optFns ...func(*Options)) (*GetBucketVersioningOutput, error) { if params == nil { params = &GetBucketVersioningInput{} diff --git a/service/s3control/api_op_GetJobTagging.go b/service/s3control/api_op_GetJobTagging.go index 21745cb634f..0e86e784959 100644 --- a/service/s3control/api_op_GetJobTagging.go +++ b/service/s3control/api_op_GetJobTagging.go @@ -17,20 +17,11 @@ import ( // Returns the tags on an S3 Batch Operations job. To use the GetJobTagging // operation, you must have permission to perform the s3:GetJobTagging action. For -// more information, see Controlling access and labeling jobs using tags -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) +// more information, see Controlling access and labeling jobs using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) // in the Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// PutJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html) -// -// * -// DeleteJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - PutJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html) +// - DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) func (c *Client) GetJobTagging(ctx context.Context, params *GetJobTaggingInput, optFns ...func(*Options)) (*GetJobTaggingOutput, error) { if params == nil { params = &GetJobTaggingInput{} diff --git a/service/s3control/api_op_GetMultiRegionAccessPoint.go b/service/s3control/api_op_GetMultiRegionAccessPoint.go index 5891d9be743..f271375e357 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPoint.go +++ b/service/s3control/api_op_GetMultiRegionAccessPoint.go @@ -15,28 +15,16 @@ import ( "strings" ) -// Returns configuration information about the specified Multi-Region Access Point. -// This action will always be routed to the US West (Oregon) Region. For more -// information about the restrictions around managing Multi-Region Access Points, -// see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// Returns configuration information about the specified Multi-Region Access +// Point. This action will always be routed to the US West (Oregon) Region. For +// more information about the restrictions around managing Multi-Region Access +// Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// GetMultiRegionAccessPoint: -// -// * CreateMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) -// -// * -// DeleteMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) -// -// * -// DescribeMultiRegionAccessPointOperation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) -// -// * -// ListMultiRegionAccessPoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) +// GetMultiRegionAccessPoint : +// - CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) +// - DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) +// - DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) +// - ListMultiRegionAccessPoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html) func (c *Client) GetMultiRegionAccessPoint(ctx context.Context, params *GetMultiRegionAccessPointInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointOutput, error) { if params == nil { params = &GetMultiRegionAccessPointInput{} @@ -63,8 +51,7 @@ type GetMultiRegionAccessPointInput struct { // The name of the Multi-Region Access Point whose configuration information you // want to receive. The name of the Multi-Region Access Point is different from the // alias. For more information about the distinction between the name and the alias - // of an Multi-Region Access Point, see Managing Multi-Region Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) + // of an Multi-Region Access Point, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. diff --git a/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go b/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go index b62e5495b7d..6a3c6f50910 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go @@ -18,17 +18,11 @@ import ( // Returns the access control policy of the specified Multi-Region Access Point. // This action will always be routed to the US West (Oregon) Region. For more // information about the restrictions around managing Multi-Region Access Points, -// see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// GetMultiRegionAccessPointPolicy: -// -// * GetMultiRegionAccessPointPolicyStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html) -// -// * -// PutMultiRegionAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html) +// GetMultiRegionAccessPointPolicy : +// - GetMultiRegionAccessPointPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html) +// - PutMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html) func (c *Client) GetMultiRegionAccessPointPolicy(ctx context.Context, params *GetMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyOutput, error) { if params == nil { params = &GetMultiRegionAccessPointPolicyInput{} @@ -55,8 +49,7 @@ type GetMultiRegionAccessPointPolicyInput struct { // Specifies the Multi-Region Access Point. The name of the Multi-Region Access // Point is different from the alias. For more information about the distinction // between the name and the alias of an Multi-Region Access Point, see Managing - // Multi-Region Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) + // Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. diff --git a/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go b/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go index c82df7ddfc2..822a28aab6b 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go @@ -18,17 +18,11 @@ import ( // Indicates whether the specified Multi-Region Access Point has an access control // policy that allows public access. This action will always be routed to the US // West (Oregon) Region. For more information about the restrictions around -// managing Multi-Region Access Points, see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// GetMultiRegionAccessPointPolicyStatus: -// -// * GetMultiRegionAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html) -// -// * -// PutMultiRegionAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html) +// GetMultiRegionAccessPointPolicyStatus : +// - GetMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html) +// - PutMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html) func (c *Client) GetMultiRegionAccessPointPolicyStatus(ctx context.Context, params *GetMultiRegionAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyStatusOutput, error) { if params == nil { params = &GetMultiRegionAccessPointPolicyStatusInput{} @@ -55,8 +49,7 @@ type GetMultiRegionAccessPointPolicyStatusInput struct { // Specifies the Multi-Region Access Point. The name of the Multi-Region Access // Point is different from the alias. For more information about the distinction // between the name and the alias of an Multi-Region Access Point, see Managing - // Multi-Region Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) + // Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) // in the Amazon S3 User Guide. // // This member is required. @@ -67,10 +60,9 @@ type GetMultiRegionAccessPointPolicyStatusInput struct { type GetMultiRegionAccessPointPolicyStatusOutput struct { - // Indicates whether this access point policy is public. For more information about - // how Amazon S3 evaluates policies to determine whether they are public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Indicates whether this access point policy is public. For more information + // about how Amazon S3 evaluates policies to determine whether they are public, see + // The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. Established *types.PolicyStatus diff --git a/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go b/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go index f32ef98b7fa..33a38c34ec6 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go @@ -19,20 +19,13 @@ import ( // which Regions are active or passive. To obtain routing control changes and // failover requests, use the Amazon S3 failover control infrastructure endpoints // in these five Amazon Web Services Regions: +// - us-east-1 +// - us-west-2 +// - ap-southeast-2 +// - ap-northeast-1 +// - eu-west-1 // -// * us-east-1 -// -// * us-west-2 -// -// * -// ap-southeast-2 -// -// * ap-northeast-1 -// -// * eu-west-1 -// -// Your Amazon S3 bucket does not -// need to be in these five Regions. +// Your Amazon S3 bucket does not need to be in these five Regions. func (c *Client) GetMultiRegionAccessPointRoutes(ctx context.Context, params *GetMultiRegionAccessPointRoutesInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointRoutesOutput, error) { if params == nil { params = &GetMultiRegionAccessPointRoutesInput{} @@ -70,7 +63,7 @@ type GetMultiRegionAccessPointRoutesOutput struct { Mrap *string // The different routes that make up the route configuration. Active routes return - // a value of 100, and passive routes return a value of 0. + // a value of 100 , and passive routes return a value of 0 . Routes []types.MultiRegionAccessPointRoute // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_GetPublicAccessBlock.go b/service/s3control/api_op_GetPublicAccessBlock.go index 54dedd37c3c..368d44fdc98 100644 --- a/service/s3control/api_op_GetPublicAccessBlock.go +++ b/service/s3control/api_op_GetPublicAccessBlock.go @@ -16,16 +16,10 @@ import ( ) // Retrieves the PublicAccessBlock configuration for an Amazon Web Services -// account. For more information, see Using Amazon S3 block public access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html). -// Related actions include: -// -// * DeletePublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html) -// -// * -// PutPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html) +// account. For more information, see Using Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// . Related actions include: +// - DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html) +// - PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html) func (c *Client) GetPublicAccessBlock(ctx context.Context, params *GetPublicAccessBlockInput, optFns ...func(*Options)) (*GetPublicAccessBlockOutput, error) { if params == nil { params = &GetPublicAccessBlockInput{} diff --git a/service/s3control/api_op_GetStorageLensConfiguration.go b/service/s3control/api_op_GetStorageLensConfiguration.go index 9e278db231f..c9dbb8c479d 100644 --- a/service/s3control/api_op_GetStorageLensConfiguration.go +++ b/service/s3control/api_op_GetStorageLensConfiguration.go @@ -16,15 +16,12 @@ import ( ) // Gets the Amazon S3 Storage Lens configuration. For more information, see -// Assessing your storage activity and usage with Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// Assessing your storage activity and usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. To use this action, you must have permission to // perform the s3:GetStorageLensConfiguration action. For more information, see -// Setting permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) GetStorageLensConfiguration(ctx context.Context, params *GetStorageLensConfigurationInput, optFns ...func(*Options)) (*GetStorageLensConfigurationOutput, error) { if params == nil { diff --git a/service/s3control/api_op_GetStorageLensConfigurationTagging.go b/service/s3control/api_op_GetStorageLensConfigurationTagging.go index bcf6fec2847..d2f589d2c20 100644 --- a/service/s3control/api_op_GetStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_GetStorageLensConfigurationTagging.go @@ -16,13 +16,11 @@ import ( ) // Gets the tags of Amazon S3 Storage Lens configuration. For more information -// about S3 Storage Lens, see Assessing your storage activity and usage with Amazon -// S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the s3:GetStorageLensConfigurationTagging action. For more information, see -// Setting permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// about S3 Storage Lens, see Assessing your storage activity and usage with +// Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the s3:GetStorageLensConfigurationTagging action. For more information, +// see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) GetStorageLensConfigurationTagging(ctx context.Context, params *GetStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*GetStorageLensConfigurationTaggingOutput, error) { if params == nil { diff --git a/service/s3control/api_op_ListAccessPoints.go b/service/s3control/api_op_ListAccessPoints.go index 4247c96aa4d..6bfae16ce18 100644 --- a/service/s3control/api_op_ListAccessPoints.go +++ b/service/s3control/api_op_ListAccessPoints.go @@ -15,31 +15,21 @@ import ( "strings" ) -// Returns a list of the access points that are owned by the current account that's -// associated with the specified bucket. You can retrieve up to 1000 access points -// per call. If the specified bucket has more than 1,000 access points (or the -// number specified in maxResults, whichever is less), the response will include a -// continuation token that you can use to list the additional access points. All -// Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request. In addition, you -// must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For -// an example of the request syntax for Amazon S3 on Outposts that uses the S3 on -// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the -// access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) -// section. The following actions are related to ListAccessPoints: -// -// * -// CreateAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) -// -// * -// DeleteAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) -// -// * -// GetAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) +// Returns a list of the access points that are owned by the current account +// that's associated with the specified bucket. You can retrieve up to 1000 access +// points per call. If the specified bucket has more than 1,000 access points (or +// the number specified in maxResults , whichever is less), the response will +// include a continuation token that you can use to list the additional access +// points. All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples) +// section. The following actions are related to ListAccessPoints : +// - CreateAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html) +// - DeleteAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html) +// - GetAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html) func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsInput, optFns ...func(*Options)) (*ListAccessPointsOutput, error) { if params == nil { params = &ListAccessPointsInput{} @@ -67,22 +57,22 @@ type ListAccessPointsInput struct { // using this parameter with Amazon S3 on Outposts with the REST API, you must // specify the name and the x-amz-outpost-id as well. For using this parameter with // S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the - // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. - // For example, to access the bucket reports through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/ + // . For example, to access the bucket reports through Outpost my-outpost owned by + // account 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. Bucket *string - // The maximum number of access points that you want to include in the list. If the - // specified bucket has more than this number of access points, then the response - // will include a continuation token in the NextToken field that you can use to - // retrieve the next page of access points. + // The maximum number of access points that you want to include in the list. If + // the specified bucket has more than this number of access points, then the + // response will include a continuation token in the NextToken field that you can + // use to retrieve the next page of access points. MaxResults int32 // A continuation token. If a previous call to ListAccessPoints returned a - // continuation token in the NextToken field, then providing that value here causes - // Amazon S3 to retrieve the next page of results. + // continuation token in the NextToken field, then providing that value here + // causes Amazon S3 to retrieve the next page of results. NextToken *string noSmithyDocumentSerde @@ -228,10 +218,10 @@ var _ ListAccessPointsAPIClient = (*Client)(nil) // ListAccessPointsPaginatorOptions is the paginator options for ListAccessPoints type ListAccessPointsPaginatorOptions struct { - // The maximum number of access points that you want to include in the list. If the - // specified bucket has more than this number of access points, then the response - // will include a continuation token in the NextToken field that you can use to - // retrieve the next page of access points. + // The maximum number of access points that you want to include in the list. If + // the specified bucket has more than this number of access points, then the + // response will include a continuation token in the NextToken field that you can + // use to retrieve the next page of access points. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/s3control/api_op_ListAccessPointsForObjectLambda.go b/service/s3control/api_op_ListAccessPointsForObjectLambda.go index fd473e1101a..d262f74a0f4 100644 --- a/service/s3control/api_op_ListAccessPointsForObjectLambda.go +++ b/service/s3control/api_op_ListAccessPointsForObjectLambda.go @@ -19,18 +19,10 @@ import ( // Lambda Access Point per call. If there are more access points than what can be // returned in one call, the response will include a continuation token that you // can use to list the additional access points. The following actions are related -// to ListAccessPointsForObjectLambda: -// -// * CreateAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) -// -// * -// DeleteAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) -// -// * -// GetAccessPointForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) +// to ListAccessPointsForObjectLambda : +// - CreateAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html) +// - DeleteAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html) +// - GetAccessPointForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html) func (c *Client) ListAccessPointsForObjectLambda(ctx context.Context, params *ListAccessPointsForObjectLambdaInput, optFns ...func(*Options)) (*ListAccessPointsForObjectLambdaOutput, error) { if params == nil { params = &ListAccessPointsForObjectLambdaInput{} @@ -61,8 +53,8 @@ type ListAccessPointsForObjectLambdaInput struct { // page of access points. MaxResults int32 - // If the list has more access points than can be returned in one call to this API, - // this field contains a continuation token that you can provide in subsequent + // If the list has more access points than can be returned in one call to this + // API, this field contains a continuation token that you can provide in subsequent // calls to this API to retrieve additional access points. NextToken *string @@ -71,8 +63,8 @@ type ListAccessPointsForObjectLambdaInput struct { type ListAccessPointsForObjectLambdaOutput struct { - // If the list has more access points than can be returned in one call to this API, - // this field contains a continuation token that you can provide in subsequent + // If the list has more access points than can be returned in one call to this + // API, this field contains a continuation token that you can provide in subsequent // calls to this API to retrieve additional access points. NextToken *string diff --git a/service/s3control/api_op_ListJobs.go b/service/s3control/api_op_ListJobs.go index 14f53b770a7..586f5c7c64c 100644 --- a/service/s3control/api_op_ListJobs.go +++ b/service/s3control/api_op_ListJobs.go @@ -17,24 +17,12 @@ import ( // Lists current S3 Batch Operations jobs and jobs that have ended within the last // 30 days for the Amazon Web Services account making the request. For more -// information, see S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the -// Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// DescribeJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) -// -// * -// UpdateJobPriority -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) -// -// * -// UpdateJobStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) +// information, see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) +// in the Amazon S3 User Guide. Related actions include: +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) +// - UpdateJobPriority (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html) +// - UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { params = &ListJobsInput{} @@ -81,8 +69,8 @@ type ListJobsOutput struct { Jobs []types.JobListDescriptor // If the List Jobs request produced more than the maximum number of results, you - // can pass this value into a subsequent List Jobs request in order to retrieve the - // next page of results. + // can pass this value into a subsequent List Jobs request in order to retrieve + // the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_ListMultiRegionAccessPoints.go b/service/s3control/api_op_ListMultiRegionAccessPoints.go index b3711ada8a9..5a6f6720b58 100644 --- a/service/s3control/api_op_ListMultiRegionAccessPoints.go +++ b/service/s3control/api_op_ListMultiRegionAccessPoints.go @@ -21,25 +21,13 @@ import ( // that can be associated with a single account. This action will always be routed // to the US West (Oregon) Region. For more information about the restrictions // around managing Multi-Region Access Points, see Managing Multi-Region Access -// Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// ListMultiRegionAccessPoint: -// -// * CreateMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) -// -// * -// DeleteMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) -// -// * -// DescribeMultiRegionAccessPointOperation -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) -// -// * -// GetMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) +// ListMultiRegionAccessPoint : +// - CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) +// - DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) +// - DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) +// - GetMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPoint.html) func (c *Client) ListMultiRegionAccessPoints(ctx context.Context, params *ListMultiRegionAccessPointsInput, optFns ...func(*Options)) (*ListMultiRegionAccessPointsOutput, error) { if params == nil { params = &ListMultiRegionAccessPointsInput{} @@ -77,10 +65,10 @@ type ListMultiRegionAccessPointsOutput struct { // The list of Multi-Region Access Points associated with the user. AccessPoints []types.MultiRegionAccessPointReport - // If the specified bucket has more Multi-Region Access Points than can be returned - // in one call to this action, this field contains a continuation token. You can - // use this token tin subsequent calls to this action to retrieve additional - // Multi-Region Access Points. + // If the specified bucket has more Multi-Region Access Points than can be + // returned in one call to this action, this field contains a continuation token. + // You can use this token tin subsequent calls to this action to retrieve + // additional Multi-Region Access Points. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_ListRegionalBuckets.go b/service/s3control/api_op_ListRegionalBuckets.go index 5375d964aa8..1c6dbf20bd8 100644 --- a/service/s3control/api_op_ListRegionalBuckets.go +++ b/service/s3control/api_op_ListRegionalBuckets.go @@ -17,12 +17,10 @@ import ( // Returns a list of all Outposts buckets in an Outpost that are owned by the // authenticated sender of the request. For more information, see Using Amazon S3 -// on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and -// x-amz-outpost-id in your request, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) +// on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. For an example of the request syntax for Amazon S3 +// on Outposts that uses the S3 on Outposts endpoint hostname prefix and +// x-amz-outpost-id in your request, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) // section. func (c *Client) ListRegionalBuckets(ctx context.Context, params *ListRegionalBucketsInput, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error) { if params == nil { @@ -63,7 +61,7 @@ type ListRegionalBucketsOutput struct { // NextToken is sent when isTruncated is true, which means there are more buckets // that can be listed. The next list requests to Amazon S3 can be continued with - // this NextToken. NextToken is obfuscated and is not a real key. + // this NextToken . NextToken is obfuscated and is not a real key. NextToken *string // @@ -188,8 +186,8 @@ func addEndpointPrefix_opListRegionalBucketsMiddleware(stack *middleware.Stack) return stack.Serialize.Insert(&endpointPrefix_opListRegionalBucketsMiddleware{}, `OperationSerializer`, middleware.After) } -// ListRegionalBucketsAPIClient is a client that implements the ListRegionalBuckets -// operation. +// ListRegionalBucketsAPIClient is a client that implements the +// ListRegionalBuckets operation. type ListRegionalBucketsAPIClient interface { ListRegionalBuckets(context.Context, *ListRegionalBucketsInput, ...func(*Options)) (*ListRegionalBucketsOutput, error) } diff --git a/service/s3control/api_op_ListStorageLensConfigurations.go b/service/s3control/api_op_ListStorageLensConfigurations.go index 09042168209..b01e1dae8e0 100644 --- a/service/s3control/api_op_ListStorageLensConfigurations.go +++ b/service/s3control/api_op_ListStorageLensConfigurations.go @@ -15,14 +15,12 @@ import ( "strings" ) -// Gets a list of Amazon S3 Storage Lens configurations. For more information about -// S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 -// Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the s3:ListStorageLensConfigurations action. For more information, see Setting -// permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// Gets a list of Amazon S3 Storage Lens configurations. For more information +// about S3 Storage Lens, see Assessing your storage activity and usage with +// Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the s3:ListStorageLensConfigurations action. For more information, see +// Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) ListStorageLensConfigurations(ctx context.Context, params *ListStorageLensConfigurationsInput, optFns ...func(*Options)) (*ListStorageLensConfigurationsOutput, error) { if params == nil { diff --git a/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go b/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go index 753f5e804b9..7fbea412014 100644 --- a/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go +++ b/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go @@ -16,11 +16,8 @@ import ( ) // Replaces configuration for an Object Lambda Access Point. The following actions -// are related to PutAccessPointConfigurationForObjectLambda: -// -// * -// GetAccessPointConfigurationForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html) +// are related to PutAccessPointConfigurationForObjectLambda : +// - GetAccessPointConfigurationForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html) func (c *Client) PutAccessPointConfigurationForObjectLambda(ctx context.Context, params *PutAccessPointConfigurationForObjectLambdaInput, optFns ...func(*Options)) (*PutAccessPointConfigurationForObjectLambdaOutput, error) { if params == nil { params = &PutAccessPointConfigurationForObjectLambdaInput{} diff --git a/service/s3control/api_op_PutAccessPointPolicy.go b/service/s3control/api_op_PutAccessPointPolicy.go index a035569a073..20ffc9ddf4e 100644 --- a/service/s3control/api_op_PutAccessPointPolicy.go +++ b/service/s3control/api_op_PutAccessPointPolicy.go @@ -19,20 +19,13 @@ import ( // policy associated with the specified access point. All Amazon S3 on Outposts // REST API requests for this action require an additional parameter of // x-amz-outpost-id to be passed with the request. In addition, you must use an S3 -// on Outposts endpoint hostname prefix instead of s3-control. For an example of +// on Outposts endpoint hostname prefix instead of s3-control . For an example of // the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts // endpoint hostname prefix and the x-amz-outpost-id derived by using the access -// point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) -// section. The following actions are related to PutAccessPointPolicy: -// -// * -// GetAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html) -// -// * -// DeleteAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html) +// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples) +// section. The following actions are related to PutAccessPointPolicy : +// - GetAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html) +// - DeleteAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html) func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPointPolicyInput, optFns ...func(*Options)) (*PutAccessPointPolicyOutput, error) { if params == nil { params = &PutAccessPointPolicyInput{} @@ -61,20 +54,19 @@ type PutAccessPointPolicyInput struct { // you must specify the name and the x-amz-outpost-id as well. For using this // parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must // specify the ARN of the access point accessed in the format - // arn:aws:s3-outposts:::outpost//accesspoint/. For example, to access the access + // arn:aws:s3-outposts:::outpost//accesspoint/ . For example, to access the access // point reports-ap through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. - // The value must be URL encoded. + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap + // . The value must be URL encoded. // // This member is required. Name *string // The policy that you want to apply to the specified access point. For more - // information about access point policies, see Managing data access with Amazon S3 - // access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) in - // the Amazon S3 User Guide. + // information about access point policies, see Managing data access with Amazon + // S3 access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) + // in the Amazon S3 User Guide. // // This member is required. Policy *string diff --git a/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go index b2c301e85fe..bb7d0ce21af 100644 --- a/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go @@ -15,17 +15,11 @@ import ( ) // Creates or replaces resource policy for an Object Lambda Access Point. For an -// example policy, see Creating Object Lambda Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli) +// example policy, see Creating Object Lambda Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli) // in the Amazon S3 User Guide. The following actions are related to -// PutAccessPointPolicyForObjectLambda: -// -// * DeleteAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html) -// -// * -// GetAccessPointPolicyForObjectLambda -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html) +// PutAccessPointPolicyForObjectLambda : +// - DeleteAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html) +// - GetAccessPointPolicyForObjectLambda (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html) func (c *Client) PutAccessPointPolicyForObjectLambda(ctx context.Context, params *PutAccessPointPolicyForObjectLambdaInput, optFns ...func(*Options)) (*PutAccessPointPolicyForObjectLambdaOutput, error) { if params == nil { params = &PutAccessPointPolicyForObjectLambdaInput{} diff --git a/service/s3control/api_op_PutBucketLifecycleConfiguration.go b/service/s3control/api_op_PutBucketLifecycleConfiguration.go index 5e844a3b36d..2f67d2c8bbd 100644 --- a/service/s3control/api_op_PutBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_PutBucketLifecycleConfiguration.go @@ -17,28 +17,20 @@ import ( // This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. // To put a lifecycle configuration to an S3 bucket, see -// PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) // in the Amazon S3 API Reference. Creates a new lifecycle configuration for the S3 // on Outposts bucket or replaces an existing lifecycle configuration. Outposts // buckets only support lifecycle configurations that delete/expire objects after a // certain period of time and abort incomplete multipart uploads. All Amazon S3 on // Outposts REST API requests for this action require an additional parameter of // x-amz-outpost-id to be passed with the request. In addition, you must use an S3 -// on Outposts endpoint hostname prefix instead of s3-control. For an example of +// on Outposts endpoint hostname prefix instead of s3-control . For an example of // the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts // endpoint hostname prefix and the x-amz-outpost-id derived by using the access -// point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) -// section. The following actions are related to -// PutBucketLifecycleConfiguration: -// -// * GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) -// -// * -// DeleteBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html) +// point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples) +// section. The following actions are related to PutBucketLifecycleConfiguration : +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) +// - DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html) func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*PutBucketLifecycleConfigurationOutput, error) { if params == nil { params = &PutBucketLifecycleConfigurationInput{} diff --git a/service/s3control/api_op_PutBucketPolicy.go b/service/s3control/api_op_PutBucketPolicy.go index 33775b102b4..a86ec4a1d31 100644 --- a/service/s3control/api_op_PutBucketPolicy.go +++ b/service/s3control/api_op_PutBucketPolicy.go @@ -15,40 +15,30 @@ import ( ) // This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a -// policy on an S3 bucket, see PutBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html) in -// the Amazon S3 API Reference. Applies an Amazon S3 bucket policy to an Outposts -// bucket. For more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. If you are using an identity other than the root user of -// the Amazon Web Services account that owns the Outposts bucket, the calling -// identity must have the PutBucketPolicy permissions on the specified Outposts -// bucket and belong to the bucket owner's account in order to use this action. If -// you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access -// Denied error. If you have the correct permissions, but you're not using an -// identity that belongs to the bucket owner's account, Amazon S3 returns a 405 +// policy on an S3 bucket, see PutBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html) +// in the Amazon S3 API Reference. Applies an Amazon S3 bucket policy to an +// Outposts bucket. For more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. If you are using an identity other than the root +// user of the Amazon Web Services account that owns the Outposts bucket, the +// calling identity must have the PutBucketPolicy permissions on the specified +// Outposts bucket and belong to the bucket owner's account in order to use this +// action. If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 +// Access Denied error. If you have the correct permissions, but you're not using +// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 // Method Not Allowed error. As a security precaution, the root user of the Amazon // Web Services account that owns a bucket can always use this action, even if the // policy explicitly denies the root user the ability to perform this action. For // more information about bucket policies, see Using Bucket Policies and User -// Policies -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). All -// Amazon S3 on Outposts REST API requests for this action require an additional -// parameter of x-amz-outpost-id to be passed with the request. In addition, you -// must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For -// an example of the request syntax for Amazon S3 on Outposts that uses the S3 on -// Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the -// access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) -// section. The following actions are related to PutBucketPolicy: -// -// * -// GetBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html) -// -// * -// DeleteBucketPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html) +// Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) +// . All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples) +// section. The following actions are related to PutBucketPolicy : +// - GetBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html) +// - DeleteBucketPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html) func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error) { if params == nil { params = &PutBucketPolicyInput{} @@ -75,10 +65,10 @@ type PutBucketPolicyInput struct { // the REST API, you must specify the name and the x-amz-outpost-id as well. For // using this parameter with S3 on Outposts with the Amazon Web Services SDK and // CLI, you must specify the ARN of the bucket accessed in the format - // arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket + // arn:aws:s3-outposts:::outpost//bucket/ . For example, to access the bucket // reports through Outpost my-outpost owned by account 123456789012 in Region - // us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_PutBucketReplication.go b/service/s3control/api_op_PutBucketReplication.go index fc234b7e10c..5b48bf8d16a 100644 --- a/service/s3control/api_op_PutBucketReplication.go +++ b/service/s3control/api_op_PutBucketReplication.go @@ -15,13 +15,12 @@ import ( "strings" ) -// This action creates an Amazon S3 on Outposts bucket's replication configuration. -// To create an S3 bucket's replication configuration, see PutBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) +// This action creates an Amazon S3 on Outposts bucket's replication +// configuration. To create an S3 bucket's replication configuration, see +// PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) // in the Amazon S3 API Reference. Creates a replication configuration or replaces // an existing one. For information about S3 replication on Outposts configuration, -// see Replicating objects for S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) +// see Replicating objects for S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html) // in the Amazon S3 User Guide. It can take a while to propagate PUT or DELETE // requests for a replication configuration to all S3 on Outposts systems. // Therefore, the replication configuration that's returned by a GET request soon @@ -30,18 +29,13 @@ import ( // configuration on that Outpost can be significant. Specify the replication // configuration in the request body. In the replication configuration, you provide // the following information: +// - The name of the destination bucket or buckets where you want S3 on Outposts +// to replicate objects +// - The Identity and Access Management (IAM) role that S3 on Outposts can +// assume to replicate objects on your behalf +// - Other relevant information, such as replication rules // -// * The name of the destination bucket or buckets -// where you want S3 on Outposts to replicate objects -// -// * The Identity and Access -// Management (IAM) role that S3 on Outposts can assume to replicate objects on -// your behalf -// -// * Other relevant information, such as replication rules -// -// A -// replication configuration must include at least one rule and can contain a +// A replication configuration must include at least one rule and can contain a // maximum of 100. Each rule identifies a subset of objects to replicate by // filtering the objects in the source Outposts bucket. To choose additional // subsets of objects to replicate, add a rule for each subset. To specify a subset @@ -49,14 +43,12 @@ import ( // the Filter element as a child of the Rule element. You can filter objects based // on an object key prefix, one or more object tags, or both. When you add the // Filter element in the configuration, you must also add the following elements: -// DeleteMarkerReplication, Status, and Priority. Using PutBucketReplication on +// DeleteMarkerReplication , Status , and Priority . Using PutBucketReplication on // Outposts requires that both the source and destination buckets must have // versioning enabled. For information about enabling versioning on a bucket, see -// Managing S3 Versioning for your S3 on Outposts bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsManagingVersioning.html). -// For information about S3 on Outposts replication failure reasons, see -// Replication failure reasons -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes) +// Managing S3 Versioning for your S3 on Outposts bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsManagingVersioning.html) +// . For information about S3 on Outposts replication failure reasons, see +// Replication failure reasons (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes) // in the Amazon S3 User Guide. Handling Replication of Encrypted Objects Outposts // buckets are encrypted at all times. All the objects in the source Outposts // bucket are encrypted and can be replicated. Also, all the replicas in the @@ -65,30 +57,20 @@ import ( // PutBucketReplication request, you must have // s3-outposts:PutReplicationConfiguration permissions for the bucket. The Outposts // bucket owner has this permission by default and can grant it to others. For more -// information about permissions, see Setting up IAM with S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) and -// Managing access to S3 on Outposts buckets -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html). -// To perform this operation, the user or role must also have the iam:CreateRole +// information about permissions, see Setting up IAM with S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html) +// and Managing access to S3 on Outposts buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html) +// . To perform this operation, the user or role must also have the iam:CreateRole // and iam:PassRole permissions. For more information, see Granting a user -// permissions to pass a role to an Amazon Web Services service -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). -// All Amazon S3 on Outposts REST API requests for this action require an +// permissions to pass a role to an Amazon Web Services service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) +// . All Amazon S3 on Outposts REST API requests for this action require an // additional parameter of x-amz-outpost-id to be passed with the request. In // addition, you must use an S3 on Outposts endpoint hostname prefix instead of -// s3-control. For an example of the request syntax for Amazon S3 on Outposts that +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that // uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id -// derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html#API_control_PutBucketReplication_Examples) -// section. The following operations are related to PutBucketReplication: -// -// * -// GetBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html) -// -// * -// DeleteBucketReplication -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html) +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html#API_control_PutBucketReplication_Examples) +// section. The following operations are related to PutBucketReplication : +// - GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html) +// - DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html) func (c *Client) PutBucketReplication(ctx context.Context, params *PutBucketReplicationInput, optFns ...func(*Options)) (*PutBucketReplicationOutput, error) { if params == nil { params = &PutBucketReplicationInput{} @@ -111,14 +93,14 @@ type PutBucketReplicationInput struct { // This member is required. AccountId *string - // Specifies the S3 on Outposts bucket to set the configuration for. For using this - // parameter with Amazon S3 on Outposts with the REST API, you must specify the - // name and the x-amz-outpost-id as well. For using this parameter with S3 on + // Specifies the S3 on Outposts bucket to set the configuration for. For using + // this parameter with Amazon S3 on Outposts with the REST API, you must specify + // the name and the x-amz-outpost-id as well. For using this parameter with S3 on // Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of - // the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For + // the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/ . For // example, to access the bucket reports through Outpost my-outpost owned by - // account 123456789012 in Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // account 123456789012 in Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_PutBucketTagging.go b/service/s3control/api_op_PutBucketTagging.go index 60f6ad49787..3ab6c83cebb 100644 --- a/service/s3control/api_op_PutBucketTagging.go +++ b/service/s3control/api_op_PutBucketTagging.go @@ -16,77 +16,51 @@ import ( ) // This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 -// bucket, see PutBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) in -// the Amazon S3 API Reference. Sets the tags for an S3 on Outposts bucket. For -// more information, see Using Amazon S3 on Outposts -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the -// Amazon S3 User Guide. Use tags to organize your Amazon Web Services bill to -// reflect your own cost structure. To do this, sign up to get your Amazon Web +// bucket, see PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) +// in the Amazon S3 API Reference. Sets the tags for an S3 on Outposts bucket. For +// more information, see Using Amazon S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) +// in the Amazon S3 User Guide. Use tags to organize your Amazon Web Services bill +// to reflect your own cost structure. To do this, sign up to get your Amazon Web // Services account bill with tag key values included. Then, to see the cost of // combined resources, organize your billing information according to resources // with the same tag key values. For example, you can tag several resources with a // specific application name, and then organize your billing information to see the // total cost of that application across several services. For more information, -// see Cost allocation and tagging -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html). -// Within a bucket, if you add a tag that has the same key as an existing tag, the -// new value overwrites the old value. For more information, see Using cost -// allocation in Amazon S3 bucket tags -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html). -// To use this action, you must have permissions to perform the +// see Cost allocation and tagging (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// . Within a bucket, if you add a tag that has the same key as an existing tag, +// the new value overwrites the old value. For more information, see Using cost +// allocation in Amazon S3 bucket tags (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html) +// . To use this action, you must have permissions to perform the // s3-outposts:PutBucketTagging action. The Outposts bucket owner has this // permission by default and can grant this permission to others. For more -// information about permissions, see Permissions Related to Bucket Subresource -// Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) -// and Managing access permissions to your Amazon S3 resources -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). -// PutBucketTagging has the following special errors: +// information about permissions, see Permissions Related to Bucket Subresource +// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) +// and Managing access permissions to your Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) +// . PutBucketTagging has the following special errors: +// - Error code: InvalidTagError +// - Description: The tag provided was not a valid tag. This error can occur if +// the tag did not pass input validation. For information about tag restrictions, +// see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// and Amazon Web Services-Generated Cost Allocation Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html) +// . +// - Error code: MalformedXMLError +// - Description: The XML provided does not match the schema. +// - Error code: OperationAbortedError +// - Description: A conflicting conditional action is currently in progress +// against this resource. Try again. +// - Error code: InternalError +// - Description: The service was unable to apply the provided tag to the +// bucket. // -// * Error code: -// InvalidTagError -// -// * Description: The tag provided was not a valid tag. This error -// can occur if the tag did not pass input validation. For information about tag -// restrictions, see User-Defined Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) -// and Amazon Web Services-Generated Cost Allocation Tag Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html). -// -// * -// Error code: MalformedXMLError -// -// * Description: The XML provided does not match -// the schema. -// -// * Error code: OperationAbortedError -// -// * Description: A conflicting -// conditional action is currently in progress against this resource. Try again. -// -// * -// Error code: InternalError -// -// * Description: The service was unable to apply the -// provided tag to the bucket. -// -// All Amazon S3 on Outposts REST API requests for -// this action require an additional parameter of x-amz-outpost-id to be passed -// with the request. In addition, you must use an S3 on Outposts endpoint hostname -// prefix instead of s3-control. For an example of the request syntax for Amazon S3 -// on Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) -// section. The following actions are related to PutBucketTagging: -// -// * -// GetBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html) -// -// * -// DeleteBucketTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html) +// All Amazon S3 on Outposts REST API requests for this action require an +// additional parameter of x-amz-outpost-id to be passed with the request. In +// addition, you must use an S3 on Outposts endpoint hostname prefix instead of +// s3-control . For an example of the request syntax for Amazon S3 on Outposts that +// uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples) +// section. The following actions are related to PutBucketTagging : +// - GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html) +// - DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html) func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error) { if params == nil { params = &PutBucketTaggingInput{} @@ -113,10 +87,10 @@ type PutBucketTaggingInput struct { // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed - // in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the - // bucket reports through Outpost my-outpost owned by account 123456789012 in - // Region us-west-2, use the URL encoding of - // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. + // in the format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access + // the bucket reports through Outpost my-outpost owned by account 123456789012 in + // Region us-west-2 , use the URL encoding of + // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. diff --git a/service/s3control/api_op_PutBucketVersioning.go b/service/s3control/api_op_PutBucketVersioning.go index 4b1e1082596..d27f2f2b8c2 100644 --- a/service/s3control/api_op_PutBucketVersioning.go +++ b/service/s3control/api_op_PutBucketVersioning.go @@ -15,58 +15,41 @@ import ( "strings" ) -// This operation sets the versioning state for S3 on Outposts buckets only. To set -// the versioning state for an S3 bucket, see PutBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html) +// This operation sets the versioning state for S3 on Outposts buckets only. To +// set the versioning state for an S3 bucket, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html) // in the Amazon S3 API Reference. Sets the versioning state for an S3 on Outposts // bucket. With S3 Versioning, you can save multiple distinct copies of your // objects and recover from unintended user actions and application failures. You // can set the versioning state to one of the following: +// - Enabled - Enables versioning for the objects in the bucket. All objects +// added to the bucket receive a unique version ID. +// - Suspended - Suspends versioning for the objects in the bucket. All objects +// added to the bucket receive the version ID null . // -// * Enabled - Enables -// versioning for the objects in the bucket. All objects added to the bucket -// receive a unique version ID. -// -// * Suspended - Suspends versioning for the objects -// in the bucket. All objects added to the bucket receive the version ID null. -// -// If -// you've never set versioning on your bucket, it has no versioning state. In that -// case, a GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) +// If you've never set versioning on your bucket, it has no versioning state. In +// that case, a GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) // request does not return a versioning state value. When you enable S3 Versioning, // for each object in your bucket, you have a current version and zero or more // noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire // noncurrent versions after a specified time period. For more information, see -// Creating and managing a lifecycle configuration for your S3 on Outposts bucket -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html) +// Creating and managing a lifecycle configuration for your S3 on Outposts bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html) // in the Amazon S3 User Guide. If you have an object expiration lifecycle // configuration in your non-versioned bucket and you want to maintain the same // permanent delete behavior when you enable versioning, you must add a noncurrent // expiration policy. The noncurrent expiration lifecycle configuration will manage // the deletes of the noncurrent object versions in the version-enabled bucket. For -// more information, see Versioning -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) in the -// Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this -// action require an additional parameter of x-amz-outpost-id to be passed with the -// request. In addition, you must use an S3 on Outposts endpoint hostname prefix -// instead of s3-control. For an example of the request syntax for Amazon S3 on -// Outposts that uses the S3 on Outposts endpoint hostname prefix and the -// x-amz-outpost-id derived by using the access point ARN, see the Examples -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples) +// more information, see Versioning (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html) +// in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for +// this action require an additional parameter of x-amz-outpost-id to be passed +// with the request. In addition, you must use an S3 on Outposts endpoint hostname +// prefix instead of s3-control . For an example of the request syntax for Amazon +// S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the +// x-amz-outpost-id derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples) // section. The following operations are related to PutBucketVersioning for S3 on // Outposts. -// -// * GetBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) -// -// * -// PutBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) -// -// * -// GetBucketLifecycleConfiguration -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) +// - GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html) +// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) +// - GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html) func (c *Client) PutBucketVersioning(ctx context.Context, params *PutBucketVersioningInput, optFns ...func(*Options)) (*PutBucketVersioningOutput, error) { if params == nil { params = &PutBucketVersioningInput{} @@ -99,8 +82,8 @@ type PutBucketVersioningInput struct { // This member is required. VersioningConfiguration *types.VersioningConfiguration - // The concatenation of the authentication device's serial number, a space, and the - // value that is displayed on your authentication device. + // The concatenation of the authentication device's serial number, a space, and + // the value that is displayed on your authentication device. MFA *string noSmithyDocumentSerde diff --git a/service/s3control/api_op_PutJobTagging.go b/service/s3control/api_op_PutJobTagging.go index d0fadf51d64..ad8d8fb5c78 100644 --- a/service/s3control/api_op_PutJobTagging.go +++ b/service/s3control/api_op_PutJobTagging.go @@ -20,59 +20,34 @@ import ( // request against the tagging subresource that is associated with the job. To // modify the existing tag set, you can either replace the existing tag set // entirely, or make changes within the existing tag set by retrieving the existing -// tag set using GetJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html), -// modify that tag set, and use this action to replace the tag set with the one you -// modified. For more information, see Controlling access and labeling jobs using -// tags -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) +// tag set using GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html) +// , modify that tag set, and use this action to replace the tag set with the one +// you modified. For more information, see Controlling access and labeling jobs +// using tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags) // in the Amazon S3 User Guide. +// - If you send this request with an empty tag set, Amazon S3 deletes the +// existing tag set on the Batch Operations job. If you use this method, you are +// charged for a Tier 1 Request (PUT). For more information, see Amazon S3 +// pricing (http://aws.amazon.com/s3/pricing/) . +// - For deleting existing tags for your Batch Operations job, a DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) +// request is preferred because it achieves the same result without incurring +// charges. +// - A few things to consider about using tags: +// - Amazon S3 limits the maximum number of tags to 50 tags per job. +// - You can associate up to 50 tags with a job as long as they have unique tag +// keys. +// - A tag key can be up to 128 Unicode characters in length, and tag values can +// be up to 256 Unicode characters in length. +// - The key and values are case sensitive. +// - For tagging-related restrictions related to characters and encodings, see +// User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// in the Billing and Cost Management User Guide. // -// * If you send this request with an empty tag set, -// Amazon S3 deletes the existing tag set on the Batch Operations job. If you use -// this method, you are charged for a Tier 1 Request (PUT). For more information, -// see Amazon S3 pricing (http://aws.amazon.com/s3/pricing/). -// -// * For deleting -// existing tags for your Batch Operations job, a DeleteJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) -// request is preferred because it achieves the same result without incurring -// charges. -// -// * A few things to consider about using tags: -// -// * Amazon S3 limits the -// maximum number of tags to 50 tags per job. -// -// * You can associate up to 50 tags -// with a job as long as they have unique tag keys. -// -// * A tag key can be up to 128 -// Unicode characters in length, and tag values can be up to 256 Unicode characters -// in length. -// -// * The key and values are case sensitive. -// -// * For tagging-related -// restrictions related to characters and encodings, see User-Defined Tag -// Restrictions -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) -// in the Billing and Cost Management User Guide. -// -// To use the PutJobTagging -// operation, you must have permission to perform the s3:PutJobTagging action. -// Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// GetJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html) -// -// * -// DeleteJobTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) +// To use the PutJobTagging operation, you must have permission to perform the +// s3:PutJobTagging action. Related actions include: +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - GetJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html) +// - DeleteJobTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html) func (c *Client) PutJobTagging(ctx context.Context, params *PutJobTaggingInput, optFns ...func(*Options)) (*PutJobTaggingOutput, error) { if params == nil { params = &PutJobTaggingInput{} diff --git a/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go b/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go index 545ab4a18ae..d2956df57ad 100644 --- a/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go +++ b/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go @@ -20,17 +20,11 @@ import ( // made to this action replaces any existing policy that is associated with the // specified Multi-Region Access Point. This action will always be routed to the US // West (Oregon) Region. For more information about the restrictions around -// managing Multi-Region Access Points, see Managing Multi-Region Access Points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) +// managing Multi-Region Access Points, see Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html) // in the Amazon S3 User Guide. The following actions are related to -// PutMultiRegionAccessPointPolicy: -// -// * GetMultiRegionAccessPointPolicy -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html) -// -// * -// GetMultiRegionAccessPointPolicyStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html) +// PutMultiRegionAccessPointPolicy : +// - GetMultiRegionAccessPointPolicy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html) +// - GetMultiRegionAccessPointPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html) func (c *Client) PutMultiRegionAccessPointPolicy(ctx context.Context, params *PutMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*PutMultiRegionAccessPointPolicyOutput, error) { if params == nil { params = &PutMultiRegionAccessPointPolicyInput{} @@ -72,8 +66,7 @@ type PutMultiRegionAccessPointPolicyInput struct { type PutMultiRegionAccessPointPolicyOutput struct { // The request token associated with the request. You can use this token with - // DescribeMultiRegionAccessPointOperation - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) + // DescribeMultiRegionAccessPointOperation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html) // to determine the status of asynchronous requests. RequestTokenARN *string diff --git a/service/s3control/api_op_PutPublicAccessBlock.go b/service/s3control/api_op_PutPublicAccessBlock.go index e0c2b5d8e37..57d424ac46c 100644 --- a/service/s3control/api_op_PutPublicAccessBlock.go +++ b/service/s3control/api_op_PutPublicAccessBlock.go @@ -18,16 +18,10 @@ import ( // Creates or modifies the PublicAccessBlock configuration for an Amazon Web // Services account. For this operation, users must have the // s3:PutAccountPublicAccessBlock permission. For more information, see Using -// Amazon S3 block public access -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html). -// Related actions include: -// -// * GetPublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html) -// -// * -// DeletePublicAccessBlock -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html) +// Amazon S3 block public access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) +// . Related actions include: +// - GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetPublicAccessBlock.html) +// - DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html) func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, error) { if params == nil { params = &PutPublicAccessBlockInput{} diff --git a/service/s3control/api_op_PutStorageLensConfiguration.go b/service/s3control/api_op_PutStorageLensConfiguration.go index 69f36a90b48..ef34af6d973 100644 --- a/service/s3control/api_op_PutStorageLensConfiguration.go +++ b/service/s3control/api_op_PutStorageLensConfiguration.go @@ -16,15 +16,12 @@ import ( ) // Puts an Amazon S3 Storage Lens configuration. For more information about S3 -// Storage Lens, see Working with Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// Storage Lens, see Working with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. To use this action, you must have permission to // perform the s3:PutStorageLensConfiguration action. For more information, see -// Setting permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) PutStorageLensConfiguration(ctx context.Context, params *PutStorageLensConfigurationInput, optFns ...func(*Options)) (*PutStorageLensConfigurationOutput, error) { if params == nil { @@ -58,8 +55,8 @@ type PutStorageLensConfigurationInput struct { // This member is required. StorageLensConfiguration *types.StorageLensConfiguration - // The tag set of the S3 Storage Lens configuration. You can set up to a maximum of - // 50 tags. + // The tag set of the S3 Storage Lens configuration. You can set up to a maximum + // of 50 tags. Tags []types.StorageLensTag noSmithyDocumentSerde diff --git a/service/s3control/api_op_PutStorageLensConfigurationTagging.go b/service/s3control/api_op_PutStorageLensConfigurationTagging.go index b160dd3dd86..7fcad00e9fd 100644 --- a/service/s3control/api_op_PutStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_PutStorageLensConfigurationTagging.go @@ -17,12 +17,10 @@ import ( // Put or replace tags on an existing Amazon S3 Storage Lens configuration. For // more information about S3 Storage Lens, see Assessing your storage activity and -// usage with Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) in the -// Amazon S3 User Guide. To use this action, you must have permission to perform -// the s3:PutStorageLensConfigurationTagging action. For more information, see -// Setting permissions to use Amazon S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) +// usage with Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html) +// in the Amazon S3 User Guide. To use this action, you must have permission to +// perform the s3:PutStorageLensConfigurationTagging action. For more information, +// see Setting permissions to use Amazon S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html) // in the Amazon S3 User Guide. func (c *Client) PutStorageLensConfigurationTagging(ctx context.Context, params *PutStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*PutStorageLensConfigurationTaggingOutput, error) { if params == nil { @@ -51,8 +49,8 @@ type PutStorageLensConfigurationTaggingInput struct { // This member is required. ConfigId *string - // The tag set of the S3 Storage Lens configuration. You can set up to a maximum of - // 50 tags. + // The tag set of the S3 Storage Lens configuration. You can set up to a maximum + // of 50 tags. // // This member is required. Tags []types.StorageLensTag diff --git a/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go b/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go index f04ff8e8151..941cfa58d73 100644 --- a/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go +++ b/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go @@ -15,9 +15,9 @@ import ( "strings" ) -// Submits an updated route configuration for a Multi-Region Access Point. This API -// operation updates the routing status for the specified Regions from active to -// passive, or from passive to active. A value of 0 indicates a passive status, +// Submits an updated route configuration for a Multi-Region Access Point. This +// API operation updates the routing status for the specified Regions from active +// to passive, or from passive to active. A value of 0 indicates a passive status, // which means that traffic won't be routed to the specified Region. A value of 100 // indicates an active status, which means that traffic will be routed to the // specified Region. At least one Region must be active at all times. When the @@ -29,20 +29,13 @@ import ( // to take effect. To submit routing control changes and failover requests, use the // Amazon S3 failover control infrastructure endpoints in these five Amazon Web // Services Regions: +// - us-east-1 +// - us-west-2 +// - ap-southeast-2 +// - ap-northeast-1 +// - eu-west-1 // -// * us-east-1 -// -// * us-west-2 -// -// * ap-southeast-2 -// -// * -// ap-northeast-1 -// -// * eu-west-1 -// -// Your Amazon S3 bucket does not need to be in these -// five Regions. +// Your Amazon S3 bucket does not need to be in these five Regions. func (c *Client) SubmitMultiRegionAccessPointRoutes(ctx context.Context, params *SubmitMultiRegionAccessPointRoutesInput, optFns ...func(*Options)) (*SubmitMultiRegionAccessPointRoutesOutput, error) { if params == nil { params = &SubmitMultiRegionAccessPointRoutesInput{} @@ -72,7 +65,7 @@ type SubmitMultiRegionAccessPointRoutesInput struct { Mrap *string // The different routes that make up the new route configuration. Active routes - // return a value of 100, and passive routes return a value of 0. + // return a value of 100 , and passive routes return a value of 0 . // // This member is required. RouteUpdates []types.MultiRegionAccessPointRoute diff --git a/service/s3control/api_op_UpdateJobPriority.go b/service/s3control/api_op_UpdateJobPriority.go index d9a0972a9f8..4996eed1673 100644 --- a/service/s3control/api_op_UpdateJobPriority.go +++ b/service/s3control/api_op_UpdateJobPriority.go @@ -15,24 +15,12 @@ import ( ) // Updates an existing S3 Batch Operations job's priority. For more information, -// see S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the -// Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// ListJobs -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) -// -// * -// DescribeJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) -// -// * -// UpdateJobStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) +// see S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) +// in the Amazon S3 User Guide. Related actions include: +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) +// - DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) +// - UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) func (c *Client) UpdateJobPriority(ctx context.Context, params *UpdateJobPriorityInput, optFns ...func(*Options)) (*UpdateJobPriorityOutput, error) { if params == nil { params = &UpdateJobPriorityInput{} diff --git a/service/s3control/api_op_UpdateJobStatus.go b/service/s3control/api_op_UpdateJobStatus.go index baa73947854..42f92765a28 100644 --- a/service/s3control/api_op_UpdateJobStatus.go +++ b/service/s3control/api_op_UpdateJobStatus.go @@ -17,24 +17,12 @@ import ( // Updates the status for the specified job. Use this action to confirm that you // want to run a job or to cancel an existing job. For more information, see S3 -// Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) in the -// Amazon S3 User Guide. Related actions include: -// -// * CreateJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) -// -// * -// ListJobs -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) -// -// * -// DescribeJob -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) -// -// * -// UpdateJobStatus -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) +// Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html) +// in the Amazon S3 User Guide. Related actions include: +// - CreateJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html) +// - ListJobs (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html) +// - DescribeJob (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html) +// - UpdateJobStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html) func (c *Client) UpdateJobStatus(ctx context.Context, params *UpdateJobStatusInput, optFns ...func(*Options)) (*UpdateJobStatusOutput, error) { if params == nil { params = &UpdateJobStatusInput{} diff --git a/service/s3control/types/enums.go b/service/s3control/types/enums.go index 1f98cc07a8f..a25b6cb8eb4 100644 --- a/service/s3control/types/enums.go +++ b/service/s3control/types/enums.go @@ -61,9 +61,9 @@ const ( BucketLocationConstraintEuCentral1 BucketLocationConstraint = "eu-central-1" ) -// Values returns all known values for BucketLocationConstraint. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for BucketLocationConstraint. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketLocationConstraint) Values() []BucketLocationConstraint { return []BucketLocationConstraint{ "EU", @@ -281,9 +281,9 @@ const ( JobStatusSuspended JobStatus = "Suspended" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "Active", @@ -328,9 +328,9 @@ const ( MFADeleteDisabled MFADelete = "Disabled" ) -// Values returns all known values for MFADelete. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for MFADelete. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (MFADelete) Values() []MFADelete { return []MFADelete{ "Enabled", @@ -368,9 +368,10 @@ const ( MultiRegionAccessPointStatusDeleting MultiRegionAccessPointStatus = "DELETING" ) -// Values returns all known values for MultiRegionAccessPointStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MultiRegionAccessPointStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (MultiRegionAccessPointStatus) Values() []MultiRegionAccessPointStatus { return []MultiRegionAccessPointStatus{ "READY", @@ -554,8 +555,8 @@ const ( ReplicationRuleStatusDisabled ReplicationRuleStatus = "Disabled" ) -// Values returns all known values for ReplicationRuleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReplicationRuleStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReplicationRuleStatus) Values() []ReplicationRuleStatus { return []ReplicationRuleStatus{ @@ -626,8 +627,8 @@ const ( ReplicationTimeStatusDisabled ReplicationTimeStatus = "Disabled" ) -// Values returns all known values for ReplicationTimeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ReplicationTimeStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ReplicationTimeStatus) Values() []ReplicationTimeStatus { return []ReplicationTimeStatus{ @@ -825,9 +826,9 @@ const ( S3PermissionWriteAcp S3Permission = "WRITE_ACP" ) -// Values returns all known values for S3Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for S3Permission. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (S3Permission) Values() []S3Permission { return []S3Permission{ "FULL_CONTROL", @@ -892,9 +893,10 @@ const ( SseKmsEncryptedObjectsStatusDisabled SseKmsEncryptedObjectsStatus = "Disabled" ) -// Values returns all known values for SseKmsEncryptedObjectsStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SseKmsEncryptedObjectsStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (SseKmsEncryptedObjectsStatus) Values() []SseKmsEncryptedObjectsStatus { return []SseKmsEncryptedObjectsStatus{ "Enabled", diff --git a/service/s3control/types/types.go b/service/s3control/types/types.go index 0bd291a843d..2909102ea65 100644 --- a/service/s3control/types/types.go +++ b/service/s3control/types/types.go @@ -43,9 +43,9 @@ type AccessPoint struct { Name *string // Indicates whether this access point allows access from the public internet. If - // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, + // VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , // and the access point doesn't allow access from the public internet. Otherwise, - // NetworkOrigin is Internet, and the access point allows access from the public + // NetworkOrigin is Internet , and the access point allows access from the public // internet, subject to the access point and bucket access policies. // // This member is required. @@ -57,8 +57,8 @@ type AccessPoint struct { // The name or alias of the access point. Alias *string - // The Amazon Web Services account ID associated with the S3 bucket associated with - // this access point. + // The Amazon Web Services account ID associated with the S3 bucket associated + // with this access point. BucketAccountId *string // The virtual private cloud (VPC) configuration for this access point, if one @@ -69,13 +69,11 @@ type AccessPoint struct { noSmithyDocumentSerde } -// A container for the account-level Amazon S3 Storage Lens configuration. For more -// information about S3 Storage Lens, see Assessing your storage activity and usage -// with S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// A container for the account-level Amazon S3 Storage Lens configuration. For +// more information about S3 Storage Lens, see Assessing your storage activity and +// usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. type AccountLevel struct { @@ -103,11 +101,9 @@ type AccountLevel struct { // metrics show details about how your storage is requested, such as requests (for // example, All requests, Get requests, Put requests), bytes uploaded or // downloaded, and errors. For more information about S3 Storage Lens, see -// Assessing your storage activity and usage with S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// Assessing your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. type ActivityMetrics struct { @@ -122,11 +118,9 @@ type ActivityMetrics struct { // manage and optimize your storage costs, for example, lifecycle rule counts for // transitions, expirations, and incomplete multipart uploads. For more information // about S3 Storage Lens, see Assessing your storage activity and usage with S3 -// Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. type AdvancedCostOptimizationMetrics struct { @@ -141,11 +135,9 @@ type AdvancedCostOptimizationMetrics struct { // metrics. Advanced data-protection metrics provide insights that you can use to // perform audits and protect your data, for example replication rule counts within // and across Regions. For more information about S3 Storage Lens, see Assessing -// your storage activity and usage with S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// your storage activity and usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. type AdvancedDataProtectionMetrics struct { @@ -200,18 +192,15 @@ type AsyncOperation struct { // A container for the request parameters associated with an asynchronous request. type AsyncRequestParameters struct { - // A container of the parameters for a CreateMultiRegionAccessPoint - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) + // A container of the parameters for a CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) // request. CreateMultiRegionAccessPointRequest *CreateMultiRegionAccessPointInput - // A container of the parameters for a DeleteMultiRegionAccessPoint - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) + // A container of the parameters for a DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) // request. DeleteMultiRegionAccessPointRequest *DeleteMultiRegionAccessPointInput - // A container of the parameters for a PutMultiRegionAccessPoint - // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) + // A container of the parameters for a PutMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) // request. PutMultiRegionAccessPointPolicyRequest *PutMultiRegionAccessPointPolicyInput @@ -248,9 +237,8 @@ type AwsLambdaTransformation struct { // A container for the bucket-level configuration for Amazon S3 Storage Lens. For // more information about S3 Storage Lens, see Assessing your storage activity and -// usage with S3 Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. +// usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. type BucketLevel struct { // A container for the bucket-level activity metrics for S3 Storage Lens. @@ -275,8 +263,7 @@ type BucketLevel struct { // A container for enabling Amazon CloudWatch publishing for S3 Storage Lens // metrics. For more information about publishing S3 Storage Lens metrics to -// CloudWatch, see Monitor S3 Storage Lens metrics in CloudWatch -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) +// CloudWatch, see Monitor S3 Storage Lens metrics in CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) // in the Amazon S3 User Guide. type CloudWatchMetrics struct { @@ -302,8 +289,7 @@ type CreateBucketConfiguration struct { noSmithyDocumentSerde } -// A container for the information associated with a CreateMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) +// A container for the information associated with a CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) // request. type CreateMultiRegionAccessPointInput struct { @@ -321,8 +307,7 @@ type CreateMultiRegionAccessPointInput struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // account. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on // Outposts. PublicAccessBlock *PublicAccessBlockConfiguration @@ -333,11 +318,10 @@ type CreateMultiRegionAccessPointInput struct { // Specifies whether S3 on Outposts replicates delete markers. If you specify a // Filter element in your replication configuration, you must also include a // DeleteMarkerReplication element. If your Filter includes a Tag element, the -// DeleteMarkerReplication element's Status child element must be set to Disabled, +// DeleteMarkerReplication element's Status child element must be set to Disabled , // because S3 on Outposts does not support replicating delete markers for tag-based // rules. For more information about delete marker replication, see How delete -// operations affect replication -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) +// operations affect replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) // in the Amazon S3 User Guide. type DeleteMarkerReplication struct { @@ -349,8 +333,7 @@ type DeleteMarkerReplication struct { noSmithyDocumentSerde } -// A container for the information associated with a DeleteMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) +// A container for the information associated with a DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) // request. type DeleteMultiRegionAccessPointInput struct { @@ -407,14 +390,12 @@ type Destination struct { } // The container element for Amazon S3 Storage Lens detailed status code metrics. -// Detailed status code metrics generate metrics for HTTP status codes, such as 200 -// OK, 403 Forbidden, 503 Service Unavailable and others. For more information -// about S3 Storage Lens, see Assessing your storage activity and usage with S3 -// Storage Lens -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the -// Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 -// Storage Lens metrics glossary -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) +// Detailed status code metrics generate metrics for HTTP status codes, such as +// 200 OK , 403 Forbidden , 503 Service Unavailable and others. For more +// information about S3 Storage Lens, see Assessing your storage activity and +// usage with S3 Storage Lens (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) +// in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see +// S3 Storage Lens metrics glossary (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) // in the Amazon S3 User Guide. type DetailedStatusCodesMetrics struct { @@ -429,23 +410,23 @@ type DetailedStatusCodesMetrics struct { // Outposts buckets. type EncryptionConfiguration struct { - // Specifies the ID of the customer managed KMS key that's stored in Key Management - // Service (KMS) for the destination bucket. This ID is either the Amazon Resource - // Name (ARN) for the KMS key or the alias ARN for the KMS key. Amazon S3 uses this - // KMS key to encrypt replica objects. Amazon S3 supports only symmetric encryption - // KMS keys. For more information, see Symmetric encryption KMS keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) + // Specifies the ID of the customer managed KMS key that's stored in Key + // Management Service (KMS) for the destination bucket. This ID is either the + // Amazon Resource Name (ARN) for the KMS key or the alias ARN for the KMS key. + // Amazon S3 uses this KMS key to encrypt replica objects. Amazon S3 supports only + // symmetric encryption KMS keys. For more information, see Symmetric encryption + // KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) // in the Amazon Web Services Key Management Service Developer Guide. ReplicaKmsKeyID *string noSmithyDocumentSerde } -// The last established access control policy for a Multi-Region Access Point. When -// you update the policy, the update is first listed as the proposed policy. After -// the update is finished and all Regions have been updated, the proposed policy is -// listed as the established policy. If both policies have the same version number, -// the proposed policy is the established policy. +// The last established access control policy for a Multi-Region Access Point. +// When you update the policy, the update is first listed as the proposed policy. +// After the update is finished and all Regions have been updated, the proposed +// policy is listed as the established policy. If both policies have the same +// version number, the proposed policy is the established policy. type EstablishedMultiRegionAccessPointPolicy struct { // The details of the last established policy. @@ -503,8 +484,8 @@ type Include struct { noSmithyDocumentSerde } -// A container element for the job configuration and status information returned by -// a Describe Job request. +// A container element for the job configuration and status information returned +// by a Describe Job request. type JobDescriptor struct { // Indicates whether confirmation is required before Amazon S3 begins running the @@ -554,8 +535,8 @@ type JobDescriptor struct { // requested one in the Create Job request. Report *JobReport - // The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role - // assigned to run the tasks for this job. + // The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) + // role assigned to run the tasks for this job. RoleArn *string // The current status of the specified job. @@ -573,8 +554,8 @@ type JobDescriptor struct { // The timestamp when this job was suspended, if it has been suspended. SuspendedDate *time.Time - // A timestamp indicating when this job terminated. A job's termination date is the - // date and time when it succeeded, failed, or was canceled. + // A timestamp indicating when this job terminated. A job's termination date is + // the date and time when it succeeded, failed, or was canceled. TerminationDate *time.Time noSmithyDocumentSerde @@ -606,8 +587,8 @@ type JobListDescriptor struct { // The ID for the specified job. JobId *string - // The operation that the specified job is configured to run on every object listed - // in the manifest. + // The operation that the specified job is configured to run on every object + // listed in the manifest. Operation OperationName // The current priority for the specified job. @@ -695,8 +676,7 @@ type JobManifestLocation struct { // The Amazon Resource Name (ARN) for a manifest object. When you're using XML // requests, you must replace special characters (such as carriage returns) in // object keys with their equivalent XML entity codes. For more information, see - // XML-related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // XML-related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) // in the Amazon S3 User Guide. // // This member is required. @@ -725,9 +705,8 @@ type JobManifestSpec struct { } // The operation that you want this job to perform on every object listed in the -// manifest. For more information about the available operations, see Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) in -// the Amazon S3 User Guide. +// manifest. For more information about the available operations, see Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html) +// in the Amazon S3 User Guide. type JobOperation struct { // Directs the specified job to invoke an Lambda function on every object in the @@ -738,8 +717,8 @@ type JobOperation struct { // object in the manifest. S3DeleteObjectTagging *S3DeleteObjectTaggingOperation - // Directs the specified job to initiate restore requests for every archived object - // in the manifest. + // Directs the specified job to initiate restore requests for every archived + // object in the manifest. S3InitiateRestoreObject *S3InitiateRestoreObjectOperation // Directs the specified job to run a PutObjectAcl call on every object in the @@ -750,19 +729,17 @@ type JobOperation struct { // manifest. S3PutObjectCopy *S3CopyObjectOperation - // Contains the configuration for an S3 Object Lock legal hold operation that an S3 - // Batch Operations job passes to every object to the underlying PutObjectLegalHold - // API operation. For more information, see Using S3 Object Lock legal hold with S3 - // Batch Operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in - // the Amazon S3 User Guide. + // Contains the configuration for an S3 Object Lock legal hold operation that an + // S3 Batch Operations job passes to every object to the underlying + // PutObjectLegalHold API operation. For more information, see Using S3 Object + // Lock legal hold with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) + // in the Amazon S3 User Guide. S3PutObjectLegalHold *S3SetObjectLegalHoldOperation // Contains the configuration parameters for the Object Lock retention action for // an S3 Batch Operations job. Batch Operations passes every object to the // underlying PutObjectRetention API operation. For more information, see Using S3 - // Object Lock retention with S3 Batch Operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) + // Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) // in the Amazon S3 User Guide. S3PutObjectRetention *S3SetObjectRetentionOperation @@ -770,8 +747,8 @@ type JobOperation struct { // the manifest. S3PutObjectTagging *S3SetObjectTaggingOperation - // Directs the specified job to invoke ReplicateObject on every object in the job's - // manifest. + // Directs the specified job to invoke ReplicateObject on every object in the + // job's manifest. S3ReplicateObject *S3ReplicateObjectOperation noSmithyDocumentSerde @@ -813,11 +790,11 @@ type JobReport struct { // An optional prefix to describe where in the specified bucket the job-completion // report will be stored. Amazon S3 stores the job-completion report at - // /job-/report.json. + // /job-/report.json . Prefix *string - // Indicates whether the job-completion report will include details of all tasks or - // only failed tasks. + // Indicates whether the job-completion report will include details of all tasks + // or only failed tasks. ReportScope JobReportScope noSmithyDocumentSerde @@ -882,9 +859,8 @@ type LifecycleRule struct { // Specifies the days since the initiation of an incomplete multipart upload that // Amazon S3 waits before permanently removing all parts of the upload. For more - // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle - // Configuration - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) + // information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle + // Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) // in the Amazon S3 User Guide. AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload @@ -950,8 +926,7 @@ type LifecycleRuleFilter struct { // Prefix identifying one or more objects to which the rule applies. When you're // using XML requests, you must replace special characters (such as carriage // returns) in object keys with their equivalent XML entity codes. For more - // information, see XML-related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // information, see XML-related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) // in the Amazon S3 User Guide. Prefix *string @@ -961,13 +936,13 @@ type LifecycleRuleFilter struct { noSmithyDocumentSerde } -// Part of ListStorageLensConfigurationResult. Each entry includes the description +// Part of ListStorageLensConfigurationResult . Each entry includes the description // of the S3 Storage Lens configuration, its home Region, whether it is enabled, // its Amazon Resource Name (ARN), and config ID. type ListStorageLensConfigurationEntry struct { - // A container for the S3 Storage Lens home Region. Your metrics data is stored and - // retained in your designated S3 Storage Lens home Region. + // A container for the S3 Storage Lens home Region. Your metrics data is stored + // and retained in your designated S3 Storage Lens home Region. // // This member is required. HomeRegion *string @@ -1005,9 +980,9 @@ type Metrics struct { noSmithyDocumentSerde } -// The Multi-Region Access Point access control policy. When you update the policy, -// the update is first listed as the proposed policy. After the update is finished -// and all Regions have been updated, the proposed policy is listed as the +// The Multi-Region Access Point access control policy. When you update the +// policy, the update is first listed as the proposed policy. After the update is +// finished and all Regions have been updated, the proposed policy is listed as the // established policy. If both policies have the same version number, the proposed // policy is the established policy. type MultiRegionAccessPointPolicyDocument struct { @@ -1039,8 +1014,8 @@ type MultiRegionAccessPointReport struct { // The alias for the Multi-Region Access Point. For more information about the // distinction between the name and the alias of an Multi-Region Access Point, see - // Managing Multi-Region Access Points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming). + // Managing Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) + // . Alias *string // When the Multi-Region Access Point create request was received. @@ -1052,8 +1027,7 @@ type MultiRegionAccessPointReport struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // account. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The - // Meaning of "Public" - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) + // Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on // Outposts. PublicAccessBlock *PublicAccessBlockConfiguration @@ -1064,10 +1038,11 @@ type MultiRegionAccessPointReport struct { // The current status of the Multi-Region Access Point. CREATING and DELETING are // temporary states that exist while the request is propagating and being - // completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you - // can retry creation or send a request to delete the Multi-Region Access Point. If - // a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a - // delete request to finish the deletion of the Multi-Region Access Point. + // completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED , + // you can retry creation or send a request to delete the Multi-Region Access + // Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED , you + // can retry a delete request to finish the deletion of the Multi-Region Access + // Point. Status MultiRegionAccessPointStatus noSmithyDocumentSerde @@ -1078,32 +1053,32 @@ type MultiRegionAccessPointReport struct { // process Amazon S3 requests through the Multi-Region Access Point, but passive // routes are not eligible to process Amazon S3 requests. Each route contains the // Amazon S3 bucket name and the Amazon Web Services Region that the bucket is -// located in. The route also includes the TrafficDialPercentage value, which shows -// whether the bucket and Region are active (indicated by a value of 100) or -// passive (indicated by a value of 0). +// located in. The route also includes the TrafficDialPercentage value, which +// shows whether the bucket and Region are active (indicated by a value of 100 ) or +// passive (indicated by a value of 0 ). type MultiRegionAccessPointRoute struct { // The traffic state for the specified bucket or Amazon Web Services Region. A // value of 0 indicates a passive state, which means that no new traffic will be - // routed to the Region. A value of 100 indicates an active state, which means that - // traffic will be routed to the specified Region. When the routing configuration - // for a Region is changed from active to passive, any in-progress operations - // (uploads, copies, deletes, and so on) to the formerly active Region will - // continue to run to until a final success or failure status is reached. If all - // Regions in the routing configuration are designated as passive, you'll receive - // an InvalidRequest error. + // routed to the Region. A value of 100 indicates an active state, which means + // that traffic will be routed to the specified Region. When the routing + // configuration for a Region is changed from active to passive, any in-progress + // operations (uploads, copies, deletes, and so on) to the formerly active Region + // will continue to run to until a final success or failure status is reached. If + // all Regions in the routing configuration are designated as passive, you'll + // receive an InvalidRequest error. // // This member is required. TrafficDialPercentage *int32 - // The name of the Amazon S3 bucket for which you'll submit a routing configuration - // change. Either the Bucket or the Region value must be provided. If both are - // provided, the bucket must be in the specified Region. + // The name of the Amazon S3 bucket for which you'll submit a routing + // configuration change. Either the Bucket or the Region value must be provided. + // If both are provided, the bucket must be in the specified Region. Bucket *string // The Amazon Web Services Region to which you'll be submitting a routing - // configuration change. Either the Bucket or the Region value must be provided. If - // both are provided, the bucket must be in the specified Region. + // configuration change. Either the Bucket or the Region value must be provided. + // If both are provided, the bucket must be in the specified Region. Region *string noSmithyDocumentSerde @@ -1113,8 +1088,8 @@ type MultiRegionAccessPointRoute struct { // asynchronous request. type MultiRegionAccessPointsAsyncResponse struct { - // A collection of status information for the different Regions that a Multi-Region - // Access Point supports. + // A collection of status information for the different Regions that a + // Multi-Region Access Point supports. Regions []MultiRegionAccessPointRegionalResponse noSmithyDocumentSerde @@ -1125,16 +1100,14 @@ type NoncurrentVersionExpiration struct { // Specifies how many noncurrent versions S3 on Outposts will retain. If there are // this many more recent noncurrent versions, S3 on Outposts will take the - // associated action. For more information about noncurrent versions, see Lifecycle - // configuration elements - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) + // associated action. For more information about noncurrent versions, see + // Lifecycle configuration elements (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) // in the Amazon S3 User Guide. NewerNoncurrentVersions *int32 // Specifies the number of days an object is noncurrent before Amazon S3 can // perform the associated action. For information about the noncurrent days - // calculations, see How Amazon S3 Calculates When an Object Became Noncurrent - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + // calculations, see How Amazon S3 Calculates When an Object Became Noncurrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) // in the Amazon S3 User Guide. NoncurrentDays int32 @@ -1146,9 +1119,8 @@ type NoncurrentVersionTransition struct { // Specifies the number of days an object is noncurrent before Amazon S3 can // perform the associated action. For information about the noncurrent days - // calculations, see How Amazon S3 Calculates How Long an Object Has Been - // Noncurrent - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) + // calculations, see How Amazon S3 Calculates How Long an Object Has Been + // Noncurrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) // in the Amazon S3 User Guide. NoncurrentDays int32 @@ -1158,8 +1130,8 @@ type NoncurrentVersionTransition struct { noSmithyDocumentSerde } -// An access point with an attached Lambda function used to access transformed data -// from an Amazon S3 bucket. +// An access point with an attached Lambda function used to access transformed +// data from an Amazon S3 bucket. type ObjectLambdaAccessPoint struct { // The name of the Object Lambda Access Point. @@ -1176,15 +1148,15 @@ type ObjectLambdaAccessPoint struct { noSmithyDocumentSerde } -// The alias of an Object Lambda Access Point. For more information, see How to use -// a bucket-style alias for your S3 bucket Object Lambda Access Point -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-use.html#ol-access-points-alias). +// The alias of an Object Lambda Access Point. For more information, see How to +// use a bucket-style alias for your S3 bucket Object Lambda Access Point (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-use.html#ol-access-points-alias) +// . type ObjectLambdaAccessPointAlias struct { // The status of the Object Lambda Access Point alias. If the status is - // PROVISIONING, the Object Lambda Access Point is provisioning the alias and the - // alias is not ready for use yet. If the status is READY, the Object Lambda Access - // Point alias is successfully provisioned and ready for use. + // PROVISIONING , the Object Lambda Access Point is provisioning the alias and the + // alias is not ready for use yet. If the status is READY , the Object Lambda + // Access Point alias is successfully provisioned and ready for use. Status ObjectLambdaAccessPointAliasStatus // The alias value of the Object Lambda Access Point. @@ -1206,8 +1178,8 @@ type ObjectLambdaConfiguration struct { // This member is required. TransformationConfigurations []ObjectLambdaTransformationConfiguration - // A container for allowed features. Valid inputs are GetObject-Range, - // GetObject-PartNumber, HeadObject-Range, and HeadObject-PartNumber. + // A container for allowed features. Valid inputs are GetObject-Range , + // GetObject-PartNumber , HeadObject-Range , and HeadObject-PartNumber . AllowedFeatures []ObjectLambdaAllowedFeature // A container for whether the CloudWatch metrics configuration is enabled. @@ -1237,8 +1209,8 @@ func (*ObjectLambdaContentTransformationMemberAwsLambda) isObjectLambdaContentTr // A configuration used when creating an Object Lambda Access Point transformation. type ObjectLambdaTransformationConfiguration struct { - // A container for the action of an Object Lambda Access Point configuration. Valid - // inputs are GetObject, ListObjects, HeadObject, and ListObjectsV2. + // A container for the action of an Object Lambda Access Point configuration. + // Valid inputs are GetObject , ListObjects , HeadObject , and ListObjectsV2 . // // This member is required. Actions []ObjectLambdaTransformationConfigurationAction @@ -1252,10 +1224,9 @@ type ObjectLambdaTransformationConfiguration struct { noSmithyDocumentSerde } -// Indicates whether this access point policy is public. For more information about -// how Amazon S3 evaluates policies to determine whether they are public, see The -// Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// Indicates whether this access point policy is public. For more information +// about how Amazon S3 evaluates policies to determine whether they are public, see +// The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. type PolicyStatus struct { @@ -1304,8 +1275,7 @@ type ProposedMultiRegionAccessPointPolicy struct { // The PublicAccessBlock configuration that you want to apply to this Amazon S3 // account. You can enable the configuration options in any combination. For more // information about when Amazon S3 considers a bucket or object public, see The -// Meaning of "Public" -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) +// Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on // Outposts. type PublicAccessBlockConfiguration struct { @@ -1313,18 +1283,11 @@ type PublicAccessBlockConfiguration struct { // Specifies whether Amazon S3 should block public access control lists (ACLs) for // buckets in this account. Setting this element to TRUE causes the following // behavior: - // - // * PutBucketAcl and PutObjectAcl calls fail if the specified ACL is - // public. - // - // * PUT Object calls fail if the request includes a public ACL. - // - // * PUT - // Bucket calls fail if the request includes a public ACL. - // - // Enabling this setting - // doesn't affect existing policies or ACLs. This property is not supported for - // Amazon S3 on Outposts. + // - PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public. + // - PUT Object calls fail if the request includes a public ACL. + // - PUT Bucket calls fail if the request includes a public ACL. + // Enabling this setting doesn't affect existing policies or ACLs. This property + // is not supported for Amazon S3 on Outposts. BlockPublicAcls bool // Specifies whether Amazon S3 should block public bucket policies for buckets in @@ -1335,8 +1298,8 @@ type PublicAccessBlockConfiguration struct { BlockPublicPolicy bool // Specifies whether Amazon S3 should ignore public ACLs for buckets in this - // account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs - // on buckets in this account and any objects that they contain. Enabling this + // account. Setting this element to TRUE causes Amazon S3 to ignore all public + // ACLs on buckets in this account and any objects that they contain. Enabling this // setting doesn't affect the persistence of any existing ACLs and doesn't prevent // new public ACLs from being set. This property is not supported for Amazon S3 on // Outposts. @@ -1354,8 +1317,7 @@ type PublicAccessBlockConfiguration struct { noSmithyDocumentSerde } -// A container for the information associated with a PutMultiRegionAccessPoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) +// A container for the information associated with a PutMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) // request. type PutMultiRegionAccessPointPolicyInput struct { @@ -1438,7 +1400,7 @@ type RegionReport struct { // replica modification sync is enabled, S3 on Outposts replicates metadata changes // made to the replica copies back to the source object, making the replication // bidirectional. To replicate object metadata modifications on replicas, you can -// specify this element and set the Status of this element to Enabled. You must +// specify this element and set the Status of this element to Enabled . You must // enable replica modification sync on the source and destination buckets to // replicate replica metadata changes between the source and the replicas. type ReplicaModifications struct { @@ -1459,8 +1421,7 @@ type ReplicationConfiguration struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // that S3 on Outposts assumes when replicating objects. For information about S3 - // replication on Outposts configuration, see Setting up replication - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html) + // replication on Outposts configuration, see Setting up replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html) // in the Amazon S3 User Guide. // // This member is required. @@ -1499,11 +1460,10 @@ type ReplicationRule struct { // Specifies whether S3 on Outposts replicates delete markers. If you specify a // Filter element in your replication configuration, you must also include a // DeleteMarkerReplication element. If your Filter includes a Tag element, the - // DeleteMarkerReplication element's Status child element must be set to Disabled, + // DeleteMarkerReplication element's Status child element must be set to Disabled , // because S3 on Outposts doesn't support replicating delete markers for tag-based // rules. For more information about delete marker replication, see How delete - // operations affect replication - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) + // operations affect replication (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated) // in the Amazon S3 User Guide. DeleteMarkerReplication *DeleteMarkerReplication @@ -1512,7 +1472,7 @@ type ReplicationRule struct { ExistingObjectReplication *ExistingObjectReplication // A filter that identifies the subset of objects to which the replication rule - // applies. A Filter element must specify exactly one Prefix, Tag, or And child + // applies. A Filter element must specify exactly one Prefix , Tag , or And child // element. Filter *ReplicationRuleFilter @@ -1524,8 +1484,7 @@ type ReplicationRule struct { // objects in an Outposts bucket, specify an empty string. When you're using XML // requests, you must replace special characters (such as carriage returns) in // object keys with their equivalent XML entity codes. For more information, see - // XML-related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // XML-related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) // in the Amazon S3 User Guide. // // Deprecated: Prefix has been deprecated @@ -1536,8 +1495,7 @@ type ReplicationRule struct { // according to all replication rules. However, if there are two or more rules with // the same destination Outposts bucket, then objects will be replicated according // to the rule with the highest priority. The higher the number, the higher the - // priority. For more information, see Creating replication rules on Outposts - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html) + // priority. For more information, see Creating replication rules on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html) // in the Amazon S3 User Guide. Priority *int32 @@ -1552,12 +1510,10 @@ type ReplicationRule struct { // A container for specifying rule filters. The filters determine the subset of // objects to which the rule applies. This element is required only if you specify // more than one filter. For example: -// -// * If you specify both a Prefix and a Tag -// filter, wrap these filters in an And element. -// -// * If you specify a filter based -// on multiple tags, wrap the Tag elements in an And element. +// - If you specify both a Prefix and a Tag filter, wrap these filters in an And +// element. +// - If you specify a filter based on multiple tags, wrap the Tag elements in an +// And element. type ReplicationRuleAndOperator struct { // An object key name prefix that identifies the subset of objects that the rule @@ -1571,26 +1527,23 @@ type ReplicationRuleAndOperator struct { } // A filter that identifies the subset of objects to which the replication rule -// applies. A Filter element must specify exactly one Prefix, Tag, or And child +// applies. A Filter element must specify exactly one Prefix , Tag , or And child // element. type ReplicationRuleFilter struct { // A container for specifying rule filters. The filters determine the subset of // objects that the rule applies to. This element is required only if you specify // more than one filter. For example: - // - // * If you specify both a Prefix and a Tag - // filter, wrap these filters in an And element. - // - // * If you specify a filter based - // on multiple tags, wrap the Tag elements in an And element. + // - If you specify both a Prefix and a Tag filter, wrap these filters in an And + // element. + // - If you specify a filter based on multiple tags, wrap the Tag elements in an + // And element. And *ReplicationRuleAndOperator // An object key name prefix that identifies the subset of objects that the rule // applies to. When you're using XML requests, you must replace special characters // (such as carriage returns) in object keys with their equivalent XML entity - // codes. For more information, see XML-related object key constraints - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) + // codes. For more information, see XML-related object key constraints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints) // in the Amazon S3 User Guide. Prefix *string @@ -1655,8 +1608,8 @@ type S3AccessControlPolicy struct { noSmithyDocumentSerde } -// A container for the bucket where the Amazon S3 Storage Lens metrics export files -// are located. +// A container for the bucket where the Amazon S3 Storage Lens metrics export +// files are located. type S3BucketDestination struct { // The account ID of the owner of the S3 Storage Lens metrics export bucket. @@ -1692,8 +1645,8 @@ type S3BucketDestination struct { // Contains the configuration parameters for a PUT Copy object operation. S3 Batch // Operations passes every object to the underlying CopyObject API operation. For -// more information about the parameters for this operation, see CopyObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html). +// more information about the parameters for this operation, see CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html) +// . type S3CopyObjectOperation struct { // @@ -1710,8 +1663,7 @@ type S3CopyObjectOperation struct { CannedAccessControlList S3CannedAccessControlList // Indicates the algorithm that you want Amazon S3 to use to create the checksum. - // For more information, see Checking object integrity - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CheckingObjectIntegrity.xml) + // For more information, see Checking object integrity (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CheckingObjectIntegrity.xml) // in the Amazon S3 User Guide. ChecksumAlgorithm S3ChecksumAlgorithm @@ -1740,7 +1692,7 @@ type S3CopyObjectOperation struct { ObjectLockRetainUntilDate *time.Time // Specifies an optional metadata property for website redirects, - // x-amz-website-redirect-location. Allows webpage redirects if the object is + // x-amz-website-redirect-location . Allows webpage redirects if the object is // accessed through a website endpoint. RedirectLocation *string @@ -1755,12 +1707,12 @@ type S3CopyObjectOperation struct { // Specifies the folder prefix that you want the objects to be copied into. For // example, to copy objects into a folder named Folder1 in the destination bucket, - // set the TargetKeyPrefix property to Folder1. + // set the TargetKeyPrefix property to Folder1 . TargetKeyPrefix *string // Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy - // operation. For example, to copy objects to a bucket named destinationBucket, set - // the TargetResource property to arn:aws:s3:::destinationBucket. + // operation. For example, to copy objects to a bucket named destinationBucket , + // set the TargetResource property to arn:aws:s3:::destinationBucket . TargetResource *string // @@ -1769,8 +1721,8 @@ type S3CopyObjectOperation struct { noSmithyDocumentSerde } -// Contains no configuration parameters because the DELETE Object tagging -// (DeleteObjectTagging) API operation accepts only the bucket name and key name as +// Contains no configuration parameters because the DELETE Object tagging ( +// DeleteObjectTagging ) API operation accepts only the bucket name and key name as // parameters, which are defined in the job's manifest. type S3DeleteObjectTaggingOperation struct { noSmithyDocumentSerde @@ -1817,8 +1769,8 @@ type S3Grantee struct { // Contains the configuration parameters for a POST Object restore job. S3 Batch // Operations passes every object to the underlying RestoreObject API operation. -// For more information about the parameters for this operation, see RestoreObject -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request). +// For more information about the parameters for this operation, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOSTrestore.html#RESTObjectPOSTrestore-restore-request) +// . type S3InitiateRestoreObjectOperation struct { // This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive @@ -1887,8 +1839,8 @@ type S3ManifestOutputLocation struct { // The Account ID that owns the bucket the generated manifest is written to. ExpectedManifestBucketOwner *string - // Specifies what encryption should be used when the generated manifest objects are - // written. + // Specifies what encryption should be used when the generated manifest objects + // are written. ManifestEncryption *GeneratedManifestEncryption // Prefix identifying one or more objects to which the manifest applies. @@ -1959,8 +1911,8 @@ type S3ObjectOwner struct { noSmithyDocumentSerde } -// Directs the specified job to invoke ReplicateObject on every object in the job's -// manifest. +// Directs the specified job to invoke ReplicateObject on every object in the +// job's manifest. type S3ReplicateObjectOperation struct { noSmithyDocumentSerde } @@ -1968,8 +1920,7 @@ type S3ReplicateObjectOperation struct { // Contains the S3 Object Lock retention mode to be applied to all objects in the // S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data // types in your operation, you will remove the retention from your objects. For -// more information, see Using S3 Object Lock retention with S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) +// more information, see Using S3 Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) // in the Amazon S3 User Guide. type S3Retention struct { @@ -1985,9 +1936,9 @@ type S3Retention struct { } // Contains the configuration parameters for a PUT Object ACL operation. S3 Batch -// Operations passes every object to the underlying PutObjectAcl API operation. For -// more information about the parameters for this operation, see PutObjectAcl -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html). +// Operations passes every object to the underlying PutObjectAcl API operation. +// For more information about the parameters for this operation, see PutObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html) +// . type S3SetObjectAclOperation struct { // @@ -1996,12 +1947,11 @@ type S3SetObjectAclOperation struct { noSmithyDocumentSerde } -// Contains the configuration for an S3 Object Lock legal hold operation that an S3 -// Batch Operations job passes to every object to the underlying PutObjectLegalHold -// API operation. For more information, see Using S3 Object Lock legal hold with S3 -// Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) in -// the Amazon S3 User Guide. +// Contains the configuration for an S3 Object Lock legal hold operation that an +// S3 Batch Operations job passes to every object to the underlying +// PutObjectLegalHold API operation. For more information, see Using S3 Object +// Lock legal hold with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html) +// in the Amazon S3 User Guide. type S3SetObjectLegalHoldOperation struct { // Contains the Object Lock legal hold status to be applied to all objects in the @@ -2016,22 +1966,20 @@ type S3SetObjectLegalHoldOperation struct { // Contains the configuration parameters for the Object Lock retention action for // an S3 Batch Operations job. Batch Operations passes every object to the // underlying PutObjectRetention API operation. For more information, see Using S3 -// Object Lock retention with S3 Batch Operations -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) +// Object Lock retention with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) // in the Amazon S3 User Guide. type S3SetObjectRetentionOperation struct { // Contains the Object Lock retention mode to be applied to all objects in the // Batch Operations job. For more information, see Using S3 Object Lock retention - // with S3 Batch Operations - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) + // with S3 Batch Operations (https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html) // in the Amazon S3 User Guide. // // This member is required. Retention *S3Retention - // Indicates if the action should be applied to objects in the Batch Operations job - // even if they have Object Lock GOVERNANCE type in place. + // Indicates if the action should be applied to objects in the Batch Operations + // job even if they have Object Lock GOVERNANCE type in place. BypassGovernanceRetention *bool noSmithyDocumentSerde @@ -2040,8 +1988,8 @@ type S3SetObjectRetentionOperation struct { // Contains the configuration parameters for a PUT Object Tagging operation. S3 // Batch Operations passes every object to the underlying PutObjectTagging API // operation. For more information about the parameters for this operation, see -// PutObjectTagging -// (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html). +// PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html) +// . type S3SetObjectTaggingOperation struct { // @@ -2075,15 +2023,15 @@ type SelectionCriteria struct { MaxDepth int32 // The minimum number of storage bytes percentage whose metrics will be selected. - // You must choose a value greater than or equal to 1.0. + // You must choose a value greater than or equal to 1.0 . MinStorageBytesPercentage float64 noSmithyDocumentSerde } -// A container that describes additional filters for identifying the source objects -// that you want to replicate. You can choose to enable or disable the replication -// of these objects. +// A container that describes additional filters for identifying the source +// objects that you want to replicate. You can choose to enable or disable the +// replication of these objects. type SourceSelectionCriteria struct { // A filter that you can use to specify whether replica modification sync is @@ -2093,7 +2041,7 @@ type SourceSelectionCriteria struct { // replica modification sync is enabled, S3 on Outposts replicates metadata changes // made to the replica copies back to the source object, making the replication // bidirectional. To replicate object metadata modifications on replicas, you can - // specify this element and set the Status of this element to Enabled. You must + // specify this element and set the Status of this element to Enabled . You must // enable replica modification sync on the source and destination buckets to // replicate replica metadata changes between the source and the replicas. ReplicaModifications *ReplicaModifications @@ -2124,8 +2072,8 @@ type SSEKMS struct { // S3 on Outposts buckets. type SseKmsEncryptedObjects struct { - // Specifies whether Amazon S3 replicates objects that are created with server-side - // encryption by using an KMS key stored in Key Management Service. + // Specifies whether Amazon S3 replicates objects that are created with + // server-side encryption by using an KMS key stored in Key Management Service. // // This member is required. Status SseKmsEncryptedObjectsStatus @@ -2265,18 +2213,17 @@ type Tagging struct { } // Specifies when an object transitions to a specified storage class. For more -// information about Amazon S3 Lifecycle configuration rules, see Transitioning -// objects using Amazon S3 Lifecycle -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) +// information about Amazon S3 Lifecycle configuration rules, see Transitioning +// objects using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) // in the Amazon S3 User Guide. type Transition struct { - // Indicates when objects are transitioned to the specified storage class. The date - // value must be in ISO 8601 format. The time is always midnight UTC. + // Indicates when objects are transitioned to the specified storage class. The + // date value must be in ISO 8601 format. The time is always midnight UTC. Date *time.Time - // Indicates the number of days after creation when objects are transitioned to the - // specified storage class. The value must be a positive integer. + // Indicates the number of days after creation when objects are transitioned to + // the specified storage class. The value must be a positive integer. Days int32 // The storage class to which you want the object to transition. @@ -2286,8 +2233,8 @@ type Transition struct { } // Describes the versioning state of an Amazon S3 on Outposts bucket. For more -// information, see PutBucketVersioning -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html). +// information, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html) +// . type VersioningConfiguration struct { // Specifies whether MFA delete is enabled or disabled in the bucket versioning diff --git a/service/s3outposts/api_client.go b/service/s3outposts/api_client.go index ff7899bde7b..836f702467c 100644 --- a/service/s3outposts/api_client.go +++ b/service/s3outposts/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/s3outposts/api_op_CreateEndpoint.go b/service/s3outposts/api_op_CreateEndpoint.go index 65d56e1171b..344e644c4c0 100644 --- a/service/s3outposts/api_op_CreateEndpoint.go +++ b/service/s3outposts/api_op_CreateEndpoint.go @@ -11,16 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an endpoint and associates it with the specified Outpost. It can take up -// to 5 minutes for this action to finish. Related actions include: -// -// * -// DeleteEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) -// -// * -// ListEndpoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html) +// Creates an endpoint and associates it with the specified Outpost. It can take +// up to 5 minutes for this action to finish. Related actions include: +// - DeleteEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) +// - ListEndpoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html) func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error) { if params == nil { params = &CreateEndpointInput{} @@ -48,16 +42,16 @@ type CreateEndpointInput struct { // This member is required. SecurityGroupId *string - // The ID of the subnet in the selected VPC. The endpoint subnet must belong to the - // Outpost that has Amazon S3 on Outposts provisioned. + // The ID of the subnet in the selected VPC. The endpoint subnet must belong to + // the Outpost that has Amazon S3 on Outposts provisioned. // // This member is required. SubnetId *string // The type of access for the network connectivity for the Amazon S3 on Outposts - // endpoint. To use the Amazon Web Services VPC, choose Private. To use the - // endpoint with an on-premises network, choose CustomerOwnedIp. If you choose - // CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP + // endpoint. To use the Amazon Web Services VPC, choose Private . To use the + // endpoint with an on-premises network, choose CustomerOwnedIp . If you choose + // CustomerOwnedIp , you must also provide the customer-owned IP address pool (CoIP // pool). Private is the default access type value. AccessType types.EndpointAccessType diff --git a/service/s3outposts/api_op_DeleteEndpoint.go b/service/s3outposts/api_op_DeleteEndpoint.go index b921da4889e..cc0e49b80fd 100644 --- a/service/s3outposts/api_op_DeleteEndpoint.go +++ b/service/s3outposts/api_op_DeleteEndpoint.go @@ -12,13 +12,8 @@ import ( // Deletes an endpoint. It can take up to 5 minutes for this action to finish. // Related actions include: -// -// * CreateEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) -// -// * -// ListEndpoints -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html) +// - CreateEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) +// - ListEndpoints (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html) func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { params = &DeleteEndpointInput{} diff --git a/service/s3outposts/api_op_ListEndpoints.go b/service/s3outposts/api_op_ListEndpoints.go index 62520d8a291..c11e60907cd 100644 --- a/service/s3outposts/api_op_ListEndpoints.go +++ b/service/s3outposts/api_op_ListEndpoints.go @@ -12,15 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists endpoints associated with the specified Outpost. Related actions -// include: -// -// * CreateEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) -// -// * -// DeleteEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) +// Lists endpoints associated with the specified Outpost. Related actions include: +// - CreateEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) +// - DeleteEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error) { if params == nil { params = &ListEndpointsInput{} @@ -54,7 +48,7 @@ type ListEndpointsOutput struct { Endpoints []types.Endpoint // If the number of endpoints associated with the specified Outpost exceeds - // MaxResults, you can include this value in subsequent calls to this operation to + // MaxResults , you can include this value in subsequent calls to this operation to // retrieve more results. NextToken *string diff --git a/service/s3outposts/api_op_ListOutpostsWithS3.go b/service/s3outposts/api_op_ListOutpostsWithS3.go index 5efcc75b7f9..7a3d1d477f6 100644 --- a/service/s3outposts/api_op_ListOutpostsWithS3.go +++ b/service/s3outposts/api_op_ListOutpostsWithS3.go @@ -50,15 +50,9 @@ type ListOutpostsWithS3Output struct { NextToken *string // Returns the list of Outposts that have the following characteristics: - // - // * - // outposts that have S3 provisioned - // - // * outposts that are Active (not pending any - // provisioning nor decommissioned) - // - // * outposts to which the the calling Amazon Web - // Services account has access + // - outposts that have S3 provisioned + // - outposts that are Active (not pending any provisioning nor decommissioned) + // - outposts to which the the calling Amazon Web Services account has access Outposts []types.Outpost // Metadata pertaining to the operation's result. diff --git a/service/s3outposts/api_op_ListSharedEndpoints.go b/service/s3outposts/api_op_ListSharedEndpoints.go index 4ea42832bed..5026a984650 100644 --- a/service/s3outposts/api_op_ListSharedEndpoints.go +++ b/service/s3outposts/api_op_ListSharedEndpoints.go @@ -14,14 +14,8 @@ import ( // Lists all endpoints associated with an Outpost that has been shared by Amazon // Web Services Resource Access Manager (RAM). Related actions include: -// -// * -// CreateEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) -// -// * -// DeleteEndpoint -// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) +// - CreateEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) +// - DeleteEndpoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) func (c *Client) ListSharedEndpoints(ctx context.Context, params *ListSharedEndpointsInput, optFns ...func(*Options)) (*ListSharedEndpointsOutput, error) { if params == nil { params = &ListSharedEndpointsInput{} @@ -61,7 +55,7 @@ type ListSharedEndpointsOutput struct { Endpoints []types.Endpoint // If the number of endpoints associated with the specified Outpost exceeds - // MaxResults, you can include this value in subsequent calls to this operation to + // MaxResults , you can include this value in subsequent calls to this operation to // retrieve more results. NextToken *string @@ -134,8 +128,8 @@ func (c *Client) addOperationListSharedEndpointsMiddlewares(stack *middleware.St return nil } -// ListSharedEndpointsAPIClient is a client that implements the ListSharedEndpoints -// operation. +// ListSharedEndpointsAPIClient is a client that implements the +// ListSharedEndpoints operation. type ListSharedEndpointsAPIClient interface { ListSharedEndpoints(context.Context, *ListSharedEndpointsInput, ...func(*Options)) (*ListSharedEndpointsOutput, error) } diff --git a/service/s3outposts/types/types.go b/service/s3outposts/types/types.go index 8ebf45cfafc..58a197f1319 100644 --- a/service/s3outposts/types/types.go +++ b/service/s3outposts/types/types.go @@ -10,9 +10,8 @@ import ( // Amazon S3 on Outposts Access Points simplify managing data access at scale for // shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to // Outposts buckets so that you can perform actions within your virtual private -// cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only -// access points -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html) +// cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only +// access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html) // in the Amazon Simple Storage Service User Guide. type Endpoint struct { diff --git a/service/sagemaker/api_client.go b/service/sagemaker/api_client.go index 40bbb802fb9..5b7b764c5b7 100644 --- a/service/sagemaker/api_client.go +++ b/service/sagemaker/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemaker/api_op_AddAssociation.go b/service/sagemaker/api_op_AddAssociation.go index a8065b0e6ec..ad315d8b131 100644 --- a/service/sagemaker/api_op_AddAssociation.go +++ b/service/sagemaker/api_op_AddAssociation.go @@ -14,8 +14,8 @@ import ( // Creates an association between the source and the destination. A source can be // associated with multiple destinations, and a destination can be associated with // multiple sources. An association is a lineage tracking entity. For more -// information, see Amazon SageMaker ML Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). +// information, see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) +// . func (c *Client) AddAssociation(ctx context.Context, params *AddAssociationInput, optFns ...func(*Options)) (*AddAssociationOutput, error) { if params == nil { params = &AddAssociationInput{} @@ -45,22 +45,16 @@ type AddAssociationInput struct { // The type of association. The following are suggested uses for each type. Amazon // SageMaker places no restrictions on their use. - // - // * ContributedTo - The source - // contributed to the destination or had a part in enabling the destination. For - // example, the training data contributed to the training job. - // - // * AssociatedWith - - // The source is connected to the destination. For example, an approval workflow is - // associated with a model deployment. - // - // * DerivedFrom - The destination is a - // modification of the source. For example, a digest output of a channel input for - // a processing job is derived from the original inputs. - // - // * Produced - The source - // generated the destination. For example, a training job produced a model - // artifact. + // - ContributedTo - The source contributed to the destination or had a part in + // enabling the destination. For example, the training data contributed to the + // training job. + // - AssociatedWith - The source is connected to the destination. For example, + // an approval workflow is associated with a model deployment. + // - DerivedFrom - The destination is a modification of the source. For example, + // a digest output of a channel input for a processing job is derived from the + // original inputs. + // - Produced - The source generated the destination. For example, a training + // job produced a model artifact. AssociationType types.AssociationEdgeType noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_AddTags.go b/service/sagemaker/api_op_AddTags.go index d8d049ee671..cd51c9d6178 100644 --- a/service/sagemaker/api_op_AddTags.go +++ b/service/sagemaker/api_op_AddTags.go @@ -16,9 +16,8 @@ import ( // batch transform jobs, models, labeling jobs, work teams, endpoint // configurations, and endpoints. Each tag consists of a key and an optional value. // Tag keys must be unique per resource. For more information about tags, see For -// more information, see Amazon Web Services Tagging Strategies -// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). -// Tags that you add to a hyperparameter tuning job by calling this API are also +// more information, see Amazon Web Services Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) +// . Tags that you add to a hyperparameter tuning job by calling this API are also // added to any training jobs that the hyperparameter tuning job launches after you // call this API, but not to training jobs that the hyperparameter tuning job // launched before you called this API. To make sure that the tags associated with @@ -32,7 +31,7 @@ import ( // associated with a Domain or User Profile are also added to all Apps that the // Domain or User Profile launches, add the tags when you first create the Domain // or User Profile by specifying them in the Tags parameter of CreateDomain or -// CreateUserProfile. +// CreateUserProfile . func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} @@ -57,8 +56,8 @@ type AddTagsInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . // // This member is required. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateAction.go b/service/sagemaker/api_op_CreateAction.go index 89e20084cff..c5435228455 100644 --- a/service/sagemaker/api_op_CreateAction.go +++ b/service/sagemaker/api_op_CreateAction.go @@ -14,8 +14,8 @@ import ( // Creates an action. An action is a lineage tracking entity that represents an // action or activity. For example, a model deployment or an HPO job. Generally, an // action involves at least one input or output artifact. For more information, see -// Amazon SageMaker ML Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). +// Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) +// . func (c *Client) CreateAction(ctx context.Context, params *CreateActionInput, optFns ...func(*Options)) (*CreateActionOutput, error) { if params == nil { params = &CreateActionInput{} @@ -33,8 +33,8 @@ func (c *Client) CreateAction(ctx context.Context, params *CreateActionInput, op type CreateActionInput struct { - // The name of the action. Must be unique to your account in an Amazon Web Services - // Region. + // The name of the action. Must be unique to your account in an Amazon Web + // Services Region. // // This member is required. ActionName *string diff --git a/service/sagemaker/api_op_CreateAlgorithm.go b/service/sagemaker/api_op_CreateAlgorithm.go index a4d7d5ef216..77d74bf8f94 100644 --- a/service/sagemaker/api_op_CreateAlgorithm.go +++ b/service/sagemaker/api_op_CreateAlgorithm.go @@ -37,27 +37,16 @@ type CreateAlgorithmInput struct { // Specifies details about training jobs run by this algorithm, including the // following: - // - // * The Amazon ECR path of the container and the version digest of the - // algorithm. - // - // * The hyperparameters that the algorithm supports. - // - // * The instance - // types that the algorithm supports for training. - // - // * Whether the algorithm - // supports distributed training. - // - // * The metrics that the algorithm emits to Amazon - // CloudWatch. - // - // * Which metrics that the algorithm emits can be used as the - // objective metric for hyperparameter tuning jobs. - // - // * The input channels that the - // algorithm supports for training data. For example, an algorithm might support - // train, validation, and test channels. + // - The Amazon ECR path of the container and the version digest of the + // algorithm. + // - The hyperparameters that the algorithm supports. + // - The instance types that the algorithm supports for training. + // - Whether the algorithm supports distributed training. + // - The metrics that the algorithm emits to Amazon CloudWatch. + // - Which metrics that the algorithm emits can be used as the objective metric + // for hyperparameter tuning jobs. + // - The input channels that the algorithm supports for training data. For + // example, an algorithm might support train , validation , and test channels. // // This member is required. TrainingSpecification *types.TrainingSpecification @@ -65,27 +54,24 @@ type CreateAlgorithmInput struct { // A description of the algorithm. AlgorithmDescription *string - // Whether to certify the algorithm so that it can be listed in Amazon Web Services - // Marketplace. + // Whether to certify the algorithm so that it can be listed in Amazon Web + // Services Marketplace. CertifyForMarketplace bool // Specifies details about inference jobs that the algorithm runs, including the // following: - // - // * The Amazon ECR paths of containers that contain the inference code - // and model artifacts. - // - // * The instance types that the algorithm supports for - // transform jobs and real-time endpoints used for inference. - // - // * The input and - // output content formats that the algorithm supports for inference. + // - The Amazon ECR paths of containers that contain the inference code and + // model artifacts. + // - The instance types that the algorithm supports for transform jobs and + // real-time endpoints used for inference. + // - The input and output content formats that the algorithm supports for + // inference. InferenceSpecification *types.InferenceSpecification // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag // Specifies configurations for one or more training jobs and that SageMaker runs diff --git a/service/sagemaker/api_op_CreateApp.go b/service/sagemaker/api_op_CreateApp.go index 255ef0f8063..ffe4e7dca7a 100644 --- a/service/sagemaker/api_op_CreateApp.go +++ b/service/sagemaker/api_op_CreateApp.go @@ -51,8 +51,8 @@ type CreateAppInput struct { // created on the instance. The value of InstanceType passed as part of the // ResourceSpec in the CreateApp call overrides the value passed as part of the // ResourceSpec configured for the user profile or the domain. If InstanceType is - // not specified in any of those three ResourceSpec values for a KernelGateway app, - // the CreateApp call fails with a request validation error. + // not specified in any of those three ResourceSpec values for a KernelGateway + // app, the CreateApp call fails with a request validation error. ResourceSpec *types.ResourceSpec // The name of the space. If this value is not set, then UserProfileName must be diff --git a/service/sagemaker/api_op_CreateArtifact.go b/service/sagemaker/api_op_CreateArtifact.go index f25b6409be8..ae2419c2009 100644 --- a/service/sagemaker/api_op_CreateArtifact.go +++ b/service/sagemaker/api_op_CreateArtifact.go @@ -13,9 +13,9 @@ import ( // Creates an artifact. An artifact is a lineage tracking entity that represents a // URI addressable object or data. Some examples are the S3 URI of a dataset and -// the ECR registry path of an image. For more information, see Amazon SageMaker ML -// Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). +// the ECR registry path of an image. For more information, see Amazon SageMaker +// ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) +// . func (c *Client) CreateArtifact(ctx context.Context, params *CreateArtifactInput, optFns ...func(*Options)) (*CreateArtifactOutput, error) { if params == nil { params = &CreateArtifactInput{} diff --git a/service/sagemaker/api_op_CreateAutoMLJob.go b/service/sagemaker/api_op_CreateAutoMLJob.go index d69ea99777a..b2e1f7942ef 100644 --- a/service/sagemaker/api_op_CreateAutoMLJob.go +++ b/service/sagemaker/api_op_CreateAutoMLJob.go @@ -12,11 +12,10 @@ import ( ) // Creates an Autopilot job. Find the best-performing model after you run an -// Autopilot job by calling DescribeAutoMLJob -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html). -// For information about how to use Autopilot, see Automate Model Development with -// Amazon SageMaker Autopilot -// (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html). +// Autopilot job by calling DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) +// . For information about how to use Autopilot, see Automate Model Development +// with Amazon SageMaker Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html) +// . func (c *Client) CreateAutoMLJob(ctx context.Context, params *CreateAutoMLJobInput, optFns ...func(*Options)) (*CreateAutoMLJobOutput, error) { if params == nil { params = &CreateAutoMLJobInput{} @@ -34,17 +33,16 @@ func (c *Client) CreateAutoMLJob(ctx context.Context, params *CreateAutoMLJobInp type CreateAutoMLJobInput struct { - // Identifies an Autopilot job. The name must be unique to your account and is case - // insensitive. + // Identifies an Autopilot job. The name must be unique to your account and is + // case insensitive. // // This member is required. AutoMLJobName *string - // An array of channel objects that describes the input data and its location. Each - // channel is a named input source. Similar to InputDataConfig supported by - // HyperParameterTrainingJobDefinition - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html). - // Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the + // An array of channel objects that describes the input data and its location. + // Each channel is a named input source. Similar to InputDataConfig supported by + // HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) + // . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the // training dataset. There is not a minimum number of rows required for the // validation dataset. // @@ -65,32 +63,29 @@ type CreateAutoMLJobInput struct { // A collection of settings used to configure an AutoML job. AutoMLJobConfig *types.AutoMLJobConfig - // Defines the objective metric used to measure the predictive quality of an AutoML - // job. You provide an AutoMLJobObjective$MetricName - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) - // and Autopilot infers whether to minimize or maximize it. For CreateAutoMLJobV2 - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html), - // only Accuracy is supported. + // Defines the objective metric used to measure the predictive quality of an + // AutoML job. You provide an AutoMLJobObjective$MetricName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) + // and Autopilot infers whether to minimize or maximize it. For CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) + // , only Accuracy is supported. AutoMLJobObjective *types.AutoMLJobObjective // Generates possible candidates without training the models. A candidate is a // combination of data preprocessors, algorithms, and algorithm parameter settings. GenerateCandidateDefinitionsOnly bool - // Specifies how to generate the endpoint name for an automatic one-click Autopilot - // model deployment. + // Specifies how to generate the endpoint name for an automatic one-click + // Autopilot model deployment. ModelDeployConfig *types.ModelDeployConfig // Defines the type of supervised learning problem available for the candidates. - // For more information, see Amazon SageMaker Autopilot problem types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types). + // For more information, see Amazon SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types) + // . ProblemType types.ProblemType // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web ServicesResources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tag keys must - // be unique per resource. + // environment. For more information, see Tagging Amazon Web ServicesResources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tag keys must be unique per resource. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateAutoMLJobV2.go b/service/sagemaker/api_op_CreateAutoMLJobV2.go index a12f66c4e89..e6c10c91f76 100644 --- a/service/sagemaker/api_op_CreateAutoMLJobV2.go +++ b/service/sagemaker/api_op_CreateAutoMLJobV2.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images -// or text for Computer Vision or Natural Language Processing problems. Find the -// resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2 -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html). -// To create an AutoMLJob using tabular data, see CreateAutoMLJob -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html). -// This API action is callable through SageMaker Canvas only. Calling it directly +// Creates an Amazon SageMaker AutoML job that uses non-tabular data such as +// images or text for Computer Vision or Natural Language Processing problems. Find +// the resulting model after you run an AutoML job V2 by calling +// DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) +// . To create an AutoMLJob using tabular data, see CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) +// . This API action is callable through SageMaker Canvas only. Calling it directly // from the CLI or an SDK results in an error. func (c *Client) CreateAutoMLJobV2(ctx context.Context, params *CreateAutoMLJobV2Input, optFns ...func(*Options)) (*CreateAutoMLJobV2Output, error) { if params == nil { @@ -37,21 +36,16 @@ func (c *Client) CreateAutoMLJobV2(ctx context.Context, params *CreateAutoMLJobV type CreateAutoMLJobV2Input struct { // An array of channel objects describing the input data and their location. Each - // channel is a named input source. Similar to InputDataConfig - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig) - // supported by CreateAutoMLJob. The supported formats depend on the problem - // type: - // - // * ImageClassification: S3Prefix, ManifestFile, AugmentedManifestFile - // - // * - // TextClassification: S3Prefix + // channel is a named input source. Similar to InputDataConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig) + // supported by CreateAutoMLJob . The supported formats depend on the problem type: + // - ImageClassification: S3Prefix, ManifestFile , AugmentedManifestFile + // - TextClassification: S3Prefix // // This member is required. AutoMLJobInputDataConfig []types.AutoMLJobChannel - // Identifies an Autopilot job. The name must be unique to your account and is case - // insensitive. + // Identifies an Autopilot job. The name must be unique to your account and is + // case insensitive. // // This member is required. AutoMLJobName *string @@ -73,21 +67,20 @@ type CreateAutoMLJobV2Input struct { RoleArn *string // Specifies a metric to minimize or maximize as the objective of a job. For - // CreateAutoMLJobV2 - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html), - // only Accuracy is supported. + // CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) + // , only Accuracy is supported. AutoMLJobObjective *types.AutoMLJobObjective // This structure specifies how to split the data into train and validation - // datasets. If you are using the V1 API (for example CreateAutoMLJob) or the V2 - // API for Natural Language Processing problems (for example CreateAutoMLJobV2 with - // a TextClassificationJobConfig problem type), the validation and training + // datasets. If you are using the V1 API (for example CreateAutoMLJob ) or the V2 + // API for Natural Language Processing problems (for example CreateAutoMLJobV2 + // with a TextClassificationJobConfig problem type), the validation and training // datasets must contain the same headers. Also, for V1 API jobs, the validation // dataset must be less than 2 GB in size. DataSplitConfig *types.AutoMLDataSplitConfig - // Specifies how to generate the endpoint name for an automatic one-click Autopilot - // model deployment. + // Specifies how to generate the endpoint name for an automatic one-click + // Autopilot model deployment. ModelDeployConfig *types.ModelDeployConfig // The security configuration for traffic encryption or Amazon VPC settings. @@ -95,9 +88,8 @@ type CreateAutoMLJobV2Input struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, such as by purpose, owner, or environment. - // For more information, see Tagging Amazon Web ServicesResources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tag keys must - // be unique per resource. + // For more information, see Tagging Amazon Web ServicesResources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tag keys must be unique per resource. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateCodeRepository.go b/service/sagemaker/api_op_CreateCodeRepository.go index a7e70f65dea..2d4d8aac9cf 100644 --- a/service/sagemaker/api_op_CreateCodeRepository.go +++ b/service/sagemaker/api_op_CreateCodeRepository.go @@ -17,9 +17,8 @@ import ( // SageMaker account, so it can be associated with more than one notebook instance, // and it persists independently from the lifecycle of any notebook instances it is // associated with. The repository can be hosted either in Amazon Web Services -// CodeCommit -// (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any -// other Git repository. +// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) +// or in any other Git repository. func (c *Client) CreateCodeRepository(ctx context.Context, params *CreateCodeRepositoryInput, optFns ...func(*Options)) (*CreateCodeRepositoryOutput, error) { if params == nil { params = &CreateCodeRepositoryInput{} @@ -51,8 +50,8 @@ type CreateCodeRepositoryInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateCompilationJob.go b/service/sagemaker/api_op_CreateCompilationJob.go index 9762fd702e6..2af4a74c776 100644 --- a/service/sagemaker/api_op_CreateCompilationJob.go +++ b/service/sagemaker/api_op_CreateCompilationJob.go @@ -18,25 +18,19 @@ import ( // artifacts as part of the model. You can also use the artifacts with Amazon Web // Services IoT Greengrass. In that case, deploy them as an ML resource. In the // request body, you provide the following: +// - A name for the compilation job +// - Information about the input model artifacts +// - The output location for the compiled model and the device (target) that the +// model runs on +// - The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker +// assumes to perform the model compilation job. // -// * A name for the compilation job -// -// * -// Information about the input model artifacts -// -// * The output location for the -// compiled model and the device (target) that the model runs on -// -// * The Amazon -// Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the -// model compilation job. -// -// You can also provide a Tag to track the model -// compilation job's resource use and costs. The response body contains the -// CompilationJobArn for the compiled job. To stop a model compilation job, use -// StopCompilationJob. To get information about a particular model compilation job, -// use DescribeCompilationJob. To get information about multiple model compilation -// jobs, use ListCompilationJobs. +// You can also provide a Tag to track the model compilation job's resource use +// and costs. The response body contains the CompilationJobArn for the compiled +// job. To stop a model compilation job, use StopCompilationJob . To get +// information about a particular model compilation job, use DescribeCompilationJob +// . To get information about multiple model compilation jobs, use +// ListCompilationJobs . func (c *Client) CreateCompilationJob(ctx context.Context, params *CreateCompilationJobInput, optFns ...func(*Options)) (*CreateCompilationJobOutput, error) { if params == nil { params = &CreateCompilationJobInput{} @@ -69,21 +63,13 @@ type CreateCompilationJobInput struct { // The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to // perform tasks on your behalf. During model compilation, Amazon SageMaker needs // your permission to: - // - // * Read input data from an S3 bucket - // - // * Write model - // artifacts to an S3 bucket - // - // * Write logs to Amazon CloudWatch Logs - // - // * Publish - // metrics to Amazon CloudWatch - // - // You grant permissions for all of these tasks to an - // IAM role. To pass this role to Amazon SageMaker, the caller of this API must - // have the iam:PassRole permission. For more information, see Amazon SageMaker - // Roles. (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) + // - Read input data from an S3 bucket + // - Write model artifacts to an S3 bucket + // - Write logs to Amazon CloudWatch Logs + // - Publish metrics to Amazon CloudWatch + // You grant permissions for all of these tasks to an IAM role. To pass this role + // to Amazon SageMaker, the caller of this API must have the iam:PassRole + // permission. For more information, see Amazon SageMaker Roles. (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) // // This member is required. RoleArn *string @@ -108,14 +94,14 @@ type CreateCompilationJobInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag // A VpcConfig object that specifies the VPC that you want your compilation job to // connect to. Control access to your models by configuring the VPC. For more // information, see Protect Compilation Jobs by Using an Amazon Virtual Private - // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). + // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html) . VpcConfig *types.NeoVpcConfig noSmithyDocumentSerde @@ -123,11 +109,9 @@ type CreateCompilationJobInput struct { type CreateCompilationJobOutput struct { - // If the action is successful, the service sends back an HTTP 200 response. Amazon - // SageMaker returns the following data in JSON format: - // - // * CompilationJobArn: The - // Amazon Resource Name (ARN) of the compiled job. + // If the action is successful, the service sends back an HTTP 200 response. + // Amazon SageMaker returns the following data in JSON format: + // - CompilationJobArn : The Amazon Resource Name (ARN) of the compiled job. // // This member is required. CompilationJobArn *string diff --git a/service/sagemaker/api_op_CreateContext.go b/service/sagemaker/api_op_CreateContext.go index f0247745c73..7ff195c7fae 100644 --- a/service/sagemaker/api_op_CreateContext.go +++ b/service/sagemaker/api_op_CreateContext.go @@ -14,8 +14,8 @@ import ( // Creates a context. A context is a lineage tracking entity that represents a // logical grouping of other tracking or experiment entities. Some examples are an // endpoint and a model package. For more information, see Amazon SageMaker ML -// Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). +// Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) +// . func (c *Client) CreateContext(ctx context.Context, params *CreateContextInput, optFns ...func(*Options)) (*CreateContextOutput, error) { if params == nil { params = &CreateContextInput{} diff --git a/service/sagemaker/api_op_CreateDataQualityJobDefinition.go b/service/sagemaker/api_op_CreateDataQualityJobDefinition.go index f67e486b250..08e0cb2e27e 100644 --- a/service/sagemaker/api_op_CreateDataQualityJobDefinition.go +++ b/service/sagemaker/api_op_CreateDataQualityJobDefinition.go @@ -12,8 +12,8 @@ import ( ) // Creates a definition for a job that monitors data quality and drift. For -// information about model monitor, see Amazon SageMaker Model Monitor -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html). +// information about model monitor, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) +// . func (c *Client) CreateDataQualityJobDefinition(ctx context.Context, params *CreateDataQualityJobDefinitionInput, optFns ...func(*Options)) (*CreateDataQualityJobDefinitionOutput, error) { if params == nil { params = &CreateDataQualityJobDefinitionInput{} @@ -73,8 +73,7 @@ type CreateDataQualityJobDefinitionInput struct { StoppingCondition *types.MonitoringStoppingCondition // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateDomain.go b/service/sagemaker/api_op_CreateDomain.go index 8d15da8a818..213f384e13a 100644 --- a/service/sagemaker/api_op_CreateDomain.go +++ b/service/sagemaker/api_op_CreateDomain.go @@ -22,30 +22,25 @@ import ( // (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with // an Amazon Web Services managed key by default. For more control, you can specify // a customer managed key. For more information, see Protect Data at Rest Using -// Encryption -// (https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html). VPC -// configuration All SageMaker Studio traffic between the domain and the EFS volume -// is through the specified VPC and subnets. For other Studio traffic, you can -// specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to -// the network access type that you choose when you onboard to Studio. The -// following options are available: +// Encryption (https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) +// . VPC configuration All SageMaker Studio traffic between the domain and the EFS +// volume is through the specified VPC and subnets. For other Studio traffic, you +// can specify the AppNetworkAccessType parameter. AppNetworkAccessType +// corresponds to the network access type that you choose when you onboard to +// Studio. The following options are available: +// - PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon +// SageMaker, which allows internet access. This is the default value. +// - VpcOnly - All Studio traffic is through the specified VPC and subnets. +// Internet access is disabled by default. To allow internet access, you must +// specify a NAT gateway. When internet access is disabled, you won't be able to +// run a Studio notebook or to train or host models unless your VPC has an +// interface endpoint to the SageMaker API and runtime or a NAT gateway and your +// security groups allow outbound connections. // -// * PublicInternetOnly - Non-EFS traffic goes -// through a VPC managed by Amazon SageMaker, which allows internet access. This is -// the default value. -// -// * VpcOnly - All Studio traffic is through the specified VPC -// and subnets. Internet access is disabled by default. To allow internet access, -// you must specify a NAT gateway. When internet access is disabled, you won't be -// able to run a Studio notebook or to train or host models unless your VPC has an -// interface endpoint to the SageMaker API and runtime or a NAT gateway and your -// security groups allow outbound connections. -// -// NFS traffic over TCP on port 2049 -// needs to be allowed in both inbound and outbound rules in order to launch a -// SageMaker Studio app successfully. For more information, see Connect SageMaker -// Studio Notebooks to Resources in a VPC -// (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html). +// NFS traffic over TCP on port 2049 needs to be allowed in both inbound and +// outbound rules in order to launch a SageMaker Studio app successfully. For more +// information, see Connect SageMaker Studio Notebooks to Resources in a VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) +// . func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -69,10 +64,10 @@ type CreateDomainInput struct { AuthMode types.AuthMode // The default settings to use to create a user profile when UserSettings isn't - // specified in the call to the CreateUserProfile API. SecurityGroups is aggregated - // when specified in both calls. For all other settings in UserSettings, the values - // specified in CreateUserProfile take precedence over those specified in - // CreateDomain. + // specified in the call to the CreateUserProfile API. SecurityGroups is + // aggregated when specified in both calls. For all other settings in UserSettings + // , the values specified in CreateUserProfile take precedence over those + // specified in CreateDomain . // // This member is required. DefaultUserSettings *types.UserSettings @@ -94,20 +89,16 @@ type CreateDomainInput struct { VpcId *string // Specifies the VPC used for non-EFS traffic. The default value is - // PublicInternetOnly. - // - // * PublicInternetOnly - Non-EFS traffic is through a VPC - // managed by Amazon SageMaker, which allows direct internet access - // - // * VpcOnly - - // All Studio traffic is through the specified VPC and subnets + // PublicInternetOnly . + // - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon + // SageMaker, which allows direct internet access + // - VpcOnly - All Studio traffic is through the specified VPC and subnets AppNetworkAccessType types.AppNetworkAccessType // The entity that creates and manages the required security groups for inter-app // communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType // is VPCOnly and - // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is - // provided. + // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. AppSecurityGroupManagement types.AppSecurityGroupManagement // The default settings used to create a space. @@ -116,13 +107,13 @@ type CreateDomainInput struct { // A collection of Domain settings. DomainSettings *types.DomainSettings - // Use KmsKeyId. + // Use KmsKeyId . // // Deprecated: This property is deprecated, use KmsKeyId instead. HomeEfsFileSystemKmsKeyId *string - // SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the - // domain with an Amazon Web Services managed key by default. For more control, + // SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to + // the domain with an Amazon Web Services managed key by default. For more control, // specify a customer managed key. KmsKeyId *string diff --git a/service/sagemaker/api_op_CreateEndpoint.go b/service/sagemaker/api_op_CreateEndpoint.go index 6e3fb0e355c..20bee13c15a 100644 --- a/service/sagemaker/api_op_CreateEndpoint.go +++ b/service/sagemaker/api_op_CreateEndpoint.go @@ -16,27 +16,25 @@ import ( // the endpoint configuration with the CreateEndpointConfig API. Use this API to // deploy models using SageMaker hosting services. For an example that calls this // method when deploying a model to SageMaker hosting services, see the Create -// Endpoint example notebook. -// (https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb) -// You must not delete an EndpointConfig that is in use by an endpoint that is live -// or while the UpdateEndpoint or CreateEndpoint operations are being performed on -// the endpoint. To update an endpoint, you must create a new EndpointConfig. The -// endpoint name must be unique within an Amazon Web Services Region in your Amazon -// Web Services account. When it receives the request, SageMaker creates the -// endpoint, launches the resources (ML compute instances), and deploys the -// model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB -// to verify that your endpoint configuration exists. When you read data from a -// DynamoDB table supporting Eventually Consistent Reads -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), -// the response might not reflect the results of a recently completed write +// Endpoint example notebook. (https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb) +// You must not delete an EndpointConfig that is in use by an endpoint that is +// live or while the UpdateEndpoint or CreateEndpoint operations are being +// performed on the endpoint. To update an endpoint, you must create a new +// EndpointConfig . The endpoint name must be unique within an Amazon Web Services +// Region in your Amazon Web Services account. When it receives the request, +// SageMaker creates the endpoint, launches the resources (ML compute instances), +// and deploys the model(s) on them. When you call CreateEndpoint , a load call is +// made to DynamoDB to verify that your endpoint configuration exists. When you +// read data from a DynamoDB table supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) +// , the response might not reflect the results of a recently completed write // operation. The response might include some stale data. If the dependent entities // are not yet in DynamoDB, this causes a validation error. If you repeat your read // request after a short time, the response should return the latest data. So retry // logic is recommended to handle these possible issues. We also recommend that // customers call DescribeEndpointConfig before calling CreateEndpoint to minimize // the potential impact of a DynamoDB eventually consistent read. When SageMaker -// receives the request, it sets the endpoint status to Creating. After it creates -// the endpoint, it sets the status to InService. SageMaker can then process +// receives the request, it sets the endpoint status to Creating . After it creates +// the endpoint, it sets the status to InService . SageMaker can then process // incoming requests for inferences. To check the status of an endpoint, use the // DescribeEndpoint API. If any of the models hosted at this endpoint get model // data from an Amazon S3 location, SageMaker uses Amazon Web Services Security @@ -45,26 +43,22 @@ import ( // you previously deactivated Amazon Web Services STS for a region, you need to // reactivate Amazon Web Services STS for that region. For more information, see // Activating and Deactivating Amazon Web Services STS in an Amazon Web Services -// Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Amazon Web Services Identity and Access Management User Guide. To add the -// IAM role policies for using this API operation, go to the IAM console -// (https://console.aws.amazon.com/iam/), and choose Roles in the left navigation -// pane. Search the IAM role that you want to grant access to use the -// CreateEndpoint and CreateEndpointConfig API operations, add the following -// policies to the role. -// -// * Option 1: For a full SageMaker access, search and -// attach the AmazonSageMakerFullAccess policy. -// -// * Option 2: For granting a limited -// access to an IAM role, paste the following Action elements manually into the -// JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", -// "sagemaker:CreateEndpointConfig"]"Resource": -// ["arn:aws:sagemaker:region:account-id:endpoint/endpointName""arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"] -// For more information, see SageMaker API Permissions: Actions, Permissions, and -// Resources Reference -// (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html). +// IAM role policies for using this API operation, go to the IAM console (https://console.aws.amazon.com/iam/) +// , and choose Roles in the left navigation pane. Search the IAM role that you +// want to grant access to use the CreateEndpoint and CreateEndpointConfig API +// operations, add the following policies to the role. +// - Option 1: For a full SageMaker access, search and attach the +// AmazonSageMakerFullAccess policy. +// - Option 2: For granting a limited access to an IAM role, paste the following +// Action elements manually into the JSON file of the IAM role: "Action": +// ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ +// "arn:aws:sagemaker:region:account-id:endpoint/endpointName" +// "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For +// more information, see SageMaker API Permissions: Actions, Permissions, and +// Resources Reference (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) +// . func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error) { if params == nil { params = &CreateEndpointInput{} @@ -83,14 +77,14 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { // The name of an endpoint configuration. For more information, see - // CreateEndpointConfig. + // CreateEndpointConfig . // // This member is required. EndpointConfigName *string // The name of the endpoint.The name must be unique within an Amazon Web Services // Region in your Amazon Web Services account. The name is case-insensitive in - // CreateEndpoint, but the case is preserved and must be matched in . + // CreateEndpoint , but the case is preserved and must be matched in . // // This member is required. EndpointName *string @@ -101,8 +95,8 @@ type CreateEndpointInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateEndpointConfig.go b/service/sagemaker/api_op_CreateEndpointConfig.go index 4e251e9558f..4a3f7d2b817 100644 --- a/service/sagemaker/api_op_CreateEndpointConfig.go +++ b/service/sagemaker/api_op_CreateEndpointConfig.go @@ -11,23 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an endpoint configuration that SageMaker hosting services uses to deploy -// models. In the configuration, you identify one or more models, created using the -// CreateModel API, to deploy and the resources that you want SageMaker to -// provision. Then you call the CreateEndpoint API. Use this API if you want to use -// SageMaker hosting services to deploy models into production. In the request, you -// define a ProductionVariant, for each model that you want to deploy. Each +// Creates an endpoint configuration that SageMaker hosting services uses to +// deploy models. In the configuration, you identify one or more models, created +// using the CreateModel API, to deploy and the resources that you want SageMaker +// to provision. Then you call the CreateEndpoint API. Use this API if you want to +// use SageMaker hosting services to deploy models into production. In the request, +// you define a ProductionVariant , for each model that you want to deploy. Each // ProductionVariant parameter also describes the resources that you want SageMaker // to provision. This includes the number and type of ML compute instances to // deploy. If you are hosting multiple models, you also assign a VariantWeight to // specify how much traffic you want to allocate to each model. For example, // suppose that you want to host two models, A and B, and you assign traffic weight // 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic -// to Model A, and one-third to model B. When you call CreateEndpoint, a load call +// to Model A, and one-third to model B. When you call CreateEndpoint , a load call // is made to DynamoDB to verify that your endpoint configuration exists. When you -// read data from a DynamoDB table supporting Eventually Consistent Reads -// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html), -// the response might not reflect the results of a recently completed write +// read data from a DynamoDB table supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) +// , the response might not reflect the results of a recently completed write // operation. The response might include some stale data. If the dependent entities // are not yet in DynamoDB, this causes a validation error. If you repeat your read // request after a short time, the response should return the latest data. So retry @@ -65,8 +64,8 @@ type CreateEndpointConfigInput struct { // Specifies configuration for how an endpoint performs asynchronous inference. // This is a required field in order for your Endpoint to be invoked using - // InvokeEndpointAsync - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html). + // InvokeEndpointAsync (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html) + // . AsyncInferenceConfig *types.AsyncInferenceConfig // Configuration to control how SageMaker captures inference data. @@ -79,23 +78,15 @@ type CreateEndpointConfigInput struct { // key that SageMaker uses to encrypt data on the storage volume attached to the ML // compute instance that hosts the endpoint. The KmsKeyId can be any of the // following formats: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias - // - // The KMS key policy must - // grant permission to the IAM role that you specify in your CreateEndpoint, - // UpdateEndpoint requests. For more information, refer to the Amazon Web Services - // Key Management Service section Using Key Policies in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // The KMS key policy must grant permission to the IAM role that you specify in + // your CreateEndpoint , UpdateEndpoint requests. For more information, refer to + // the Amazon Web Services Key Management Service section Using Key Policies in + // Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) // Certain Nitro-based instances include local storage, dependent on the instance // type. Local storage volumes are encrypted using a hardware module on the // instance. You can't request a KmsKeyId when using an instance type with local @@ -104,24 +95,23 @@ type CreateEndpointConfigInput struct { // for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any // nitro-based instances with local storage, the call to CreateEndpointConfig // fails. For a list of instance types that support local instance storage, see - // Instance Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). - // For more information about local instance storage encryption, see SSD Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). + // Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) + // . For more information about local instance storage encryption, see SSD + // Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) + // . KmsKeyId *string // An array of ProductionVariant objects, one for each model that you want to host // at this endpoint in shadow mode with production traffic replicated from the - // model specified on ProductionVariants. If you use this field, you can only + // model specified on ProductionVariants . If you use this field, you can only // specify one variant for ProductionVariants and one variant for - // ShadowProductionVariants. + // ShadowProductionVariants . ShadowProductionVariants []types.ProductionVariant // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateExperiment.go b/service/sagemaker/api_op_CreateExperiment.go index 58429e407a9..5f35caa6069 100644 --- a/service/sagemaker/api_op_CreateExperiment.go +++ b/service/sagemaker/api_op_CreateExperiment.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a SageMaker experiment. An experiment is a collection of trials that are -// observed, compared and evaluated as a group. A trial is a set of steps, called -// trial components, that produce a machine learning model. In the Studio UI, -// trials are referred to as run groups and trial components are referred to as +// Creates a SageMaker experiment. An experiment is a collection of trials that +// are observed, compared and evaluated as a group. A trial is a set of steps, +// called trial components, that produce a machine learning model. In the Studio +// UI, trials are referred to as run groups and trial components are referred to as // runs. The goal of an experiment is to determine the components that produce the // best model. Multiple trials are performed, each one isolating and measuring the // impact of a change to one or more inputs, while keeping the remaining inputs @@ -56,7 +56,7 @@ type CreateExperimentInput struct { Description *string // The name of the experiment as displayed. The name doesn't need to be unique. If - // you don't specify DisplayName, the value in ExperimentName is displayed. + // you don't specify DisplayName , the value in ExperimentName is displayed. DisplayName *string // A list of tags to associate with the experiment. You can use Search API to diff --git a/service/sagemaker/api_op_CreateFeatureGroup.go b/service/sagemaker/api_op_CreateFeatureGroup.go index 1bd68fbeeb6..661288697a3 100644 --- a/service/sagemaker/api_op_CreateFeatureGroup.go +++ b/service/sagemaker/api_op_CreateFeatureGroup.go @@ -11,16 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the -// FeatureStore to describe a Record. The FeatureGroup defines the schema and -// features contained in the FeatureGroup. A FeatureGroup definition is composed of -// a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and -// configurations for its OnlineStore and OfflineStore. Check Amazon Web Services -// service quotas -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to see -// the FeatureGroups quota for your Amazon Web Services account. You must include -// at least one of OnlineStoreConfig and OfflineStoreConfig to create a -// FeatureGroup. +// Create a new FeatureGroup . A FeatureGroup is a group of Features defined in +// the FeatureStore to describe a Record . The FeatureGroup defines the schema and +// features contained in the FeatureGroup. A FeatureGroup definition is composed +// of a list of Features , a RecordIdentifierFeatureName , an EventTimeFeatureName +// and configurations for its OnlineStore and OfflineStore . Check Amazon Web +// Services service quotas (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// to see the FeatureGroup s quota for your Amazon Web Services account. You must +// include at least one of OnlineStoreConfig and OfflineStoreConfig to create a +// FeatureGroup . func (c *Client) CreateFeatureGroup(ctx context.Context, params *CreateFeatureGroupInput, optFns ...func(*Options)) (*CreateFeatureGroupOutput, error) { if params == nil { params = &CreateFeatureGroupInput{} @@ -38,96 +37,80 @@ func (c *Client) CreateFeatureGroup(ctx context.Context, params *CreateFeatureGr type CreateFeatureGroupInput struct { - // The name of the feature that stores the EventTime of a Record in a FeatureGroup. - // An EventTime is a point in time when a new event occurs that corresponds to the - // creation or update of a Record in a FeatureGroup. All Records in the - // FeatureGroup must have a corresponding EventTime. An EventTime can be a String - // or Fractional. - // - // * Fractional: EventTime feature values must be a Unix timestamp - // in seconds. - // - // * String: EventTime feature values must be an ISO-8601 string in - // the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and - // yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and - // day respectively and HH, mm, ss, and if applicable, SSS represent the hour, - // month, second and milliseconds respsectively. 'T' and Z are constants. + // The name of the feature that stores the EventTime of a Record in a FeatureGroup + // . An EventTime is a point in time when a new event occurs that corresponds to + // the creation or update of a Record in a FeatureGroup . All Records in the + // FeatureGroup must have a corresponding EventTime . An EventTime can be a String + // or Fractional . + // - Fractional : EventTime feature values must be a Unix timestamp in seconds. + // - String : EventTime feature values must be an ISO-8601 string in the format. + // The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and + // yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy , MM , and dd represent the year, month, + // and day respectively and HH , mm , ss , and if applicable, SSS represent the + // hour, month, second and milliseconds respsectively. 'T' and Z are constants. // // This member is required. EventTimeFeatureName *string - // A list of Feature names and types. Name and Type is compulsory per Feature. - // Valid feature FeatureTypes are Integral, Fractional and String. FeatureNames - // cannot be any of the following: is_deleted, write_time, api_invocation_time You - // can create up to 2,500 FeatureDefinitions per FeatureGroup. + // A list of Feature names and types. Name and Type is compulsory per Feature . + // Valid feature FeatureType s are Integral , Fractional and String . FeatureName s + // cannot be any of the following: is_deleted , write_time , api_invocation_time + // You can create up to 2,500 FeatureDefinition s per FeatureGroup . // // This member is required. FeatureDefinitions []types.FeatureDefinition - // The name of the FeatureGroup. The name must be unique within an Amazon Web + // The name of the FeatureGroup . The name must be unique within an Amazon Web // Services Region in an Amazon Web Services account. The name: - // - // * Must start and - // end with an alphanumeric character. - // - // * Can only contain alphanumeric character - // and hyphens. Spaces are not allowed. + // - Must start and end with an alphanumeric character. + // - Can only contain alphanumeric character and hyphens. Spaces are not + // allowed. // // This member is required. FeatureGroupName *string // The name of the Feature whose value uniquely identifies a Record defined in the - // FeatureStore. Only the latest record per identifier value will be stored in the - // OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' - // names. You use the RecordIdentifierFeatureName to access data in a FeatureStore. - // This name: - // - // * Must start and end with an alphanumeric character. - // - // * Can only - // contains alphanumeric characters, hyphens, underscores. Spaces are not allowed. + // FeatureStore . Only the latest record per identifier value will be stored in the + // OnlineStore . RecordIdentifierFeatureName must be one of feature definitions' + // names. You use the RecordIdentifierFeatureName to access data in a FeatureStore + // . This name: + // - Must start and end with an alphanumeric character. + // - Can only contains alphanumeric characters, hyphens, underscores. Spaces are + // not allowed. // // This member is required. RecordIdentifierFeatureName *string - // A free-form description of a FeatureGroup. + // A free-form description of a FeatureGroup . Description *string - // Use this to configure an OfflineFeatureStore. This parameter allows you to + // Use this to configure an OfflineFeatureStore . This parameter allows you to // specify: - // - // * The Amazon Simple Storage Service (Amazon S3) location of an - // OfflineStore. - // - // * A configuration for an Amazon Web Services Glue or Amazon Web - // Services Hive data catalog. - // - // * An KMS encryption key to encrypt the Amazon S3 - // location used for OfflineStore. If KMS encryption key is not specified, by - // default we encrypt all data at rest using Amazon Web Services KMS key. By - // defining your bucket-level key - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html) for SSE, - // you can reduce Amazon Web Services KMS requests costs by up to 99 percent. - // - // * - // Format for the offline store table. Supported formats are Glue (Default) and - // Apache Iceberg (https://iceberg.apache.org/). - // - // To learn more about this - // parameter, see OfflineStoreConfig. + // - The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore . + // - A configuration for an Amazon Web Services Glue or Amazon Web Services Hive + // data catalog. + // - An KMS encryption key to encrypt the Amazon S3 location used for + // OfflineStore . If KMS encryption key is not specified, by default we encrypt + // all data at rest using Amazon Web Services KMS key. By defining your + // bucket-level key (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html) + // for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 + // percent. + // - Format for the offline store table. Supported formats are Glue (Default) + // and Apache Iceberg (https://iceberg.apache.org/) . + // To learn more about this parameter, see OfflineStoreConfig . OfflineStoreConfig *types.OfflineStoreConfig // You can turn the OnlineStore on or off by specifying True for the - // EnableOnlineStore flag in OnlineStoreConfig; the default value is False. You can - // also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption - // of the OnlineStore. + // EnableOnlineStore flag in OnlineStoreConfig ; the default value is False . You + // can also include an Amazon Web Services KMS key ID ( KMSKeyId ) for at-rest + // encryption of the OnlineStore . OnlineStoreConfig *types.OnlineStoreConfig // The Amazon Resource Name (ARN) of the IAM execution role used to persist data // into the OfflineStore if an OfflineStoreConfig is provided. RoleArn *string - // Tags used to identify Features in each FeatureGroup. + // Tags used to identify Features in each FeatureGroup . Tags []types.Tag noSmithyDocumentSerde @@ -135,7 +118,7 @@ type CreateFeatureGroupInput struct { type CreateFeatureGroupOutput struct { - // The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier + // The Amazon Resource Name (ARN) of the FeatureGroup . This is a unique identifier // for the feature group. // // This member is required. diff --git a/service/sagemaker/api_op_CreateFlowDefinition.go b/service/sagemaker/api_op_CreateFlowDefinition.go index 7567a37d569..70871c346b5 100644 --- a/service/sagemaker/api_op_CreateFlowDefinition.go +++ b/service/sagemaker/api_op_CreateFlowDefinition.go @@ -46,9 +46,10 @@ type CreateFlowDefinitionInput struct { // This member is required. OutputConfig *types.FlowDefinitionOutputConfig - // The Amazon Resource Name (ARN) of the role needed to call other services on your - // behalf. For example, - // arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298. + // The Amazon Resource Name (ARN) of the role needed to call other services on + // your behalf. For example, + // arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298 + // . // // This member is required. RoleArn *string diff --git a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go index a330e7be8a9..f1c6a49072c 100644 --- a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go @@ -19,12 +19,11 @@ import ( // hyperparameter tuning job automatically creates Amazon SageMaker experiments, // trials, and trial components for each training job that it runs. You can view // these entities in Amazon SageMaker Studio. For more information, see View -// Experiments, Trials, and Trial Components -// (https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view). -// Do not include any security-sensitive information including account access IDs, -// secrets or tokens in any hyperparameter field. If the use of security-sensitive -// credentials are detected, SageMaker will reject your training job request and -// return an exception error. +// Experiments, Trials, and Trial Components (https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view) +// . Do not include any security-sensitive information including account access +// IDs, secrets or tokens in any hyperparameter field. If the use of +// security-sensitive credentials are detected, SageMaker will reject your training +// job request and return an exception error. func (c *Client) CreateHyperParameterTuningJob(ctx context.Context, params *CreateHyperParameterTuningJobInput, optFns ...func(*Options)) (*CreateHyperParameterTuningJobOutput, error) { if params == nil { params = &CreateHyperParameterTuningJobInput{} @@ -45,8 +44,8 @@ type CreateHyperParameterTuningJobInput struct { // The HyperParameterTuningJobConfig object that describes the tuning job, // including the search strategy, the objective metric used to evaluate training // jobs, ranges of parameters to search, and resource limits for the tuning job. - // For more information, see How Hyperparameter Tuning Works - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). + // For more information, see How Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html) + // . // // This member is required. HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig @@ -62,10 +61,9 @@ type CreateHyperParameterTuningJobInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). Tags that you - // specify for the tuning job are also added to all training jobs that the tuning - // job launches. + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags that you specify for the tuning job are also added to all training jobs + // that the tuning job launches. Tags []types.Tag // The HyperParameterTrainingJobDefinition object that describes the training jobs @@ -78,11 +76,11 @@ type CreateHyperParameterTuningJobInput struct { // tuning job. TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition - // Specifies the configuration for starting the hyperparameter tuning job using one - // or more previous tuning jobs as a starting point. The results of previous tuning - // jobs are used to inform which combinations of hyperparameters to search over in - // the new tuning job. All training jobs launched by the new hyperparameter tuning - // job are evaluated by using the objective metric. If you specify + // Specifies the configuration for starting the hyperparameter tuning job using + // one or more previous tuning jobs as a starting point. The results of previous + // tuning jobs are used to inform which combinations of hyperparameters to search + // over in the new tuning job. All training jobs launched by the new hyperparameter + // tuning job are evaluated by using the objective metric. If you specify // IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start // configuration, the training job that performs the best in the new tuning job is // compared to the best training jobs from the parent tuning jobs. From these, the diff --git a/service/sagemaker/api_op_CreateImage.go b/service/sagemaker/api_op_CreateImage.go index e3b2e143954..f1713af8191 100644 --- a/service/sagemaker/api_op_CreateImage.go +++ b/service/sagemaker/api_op_CreateImage.go @@ -14,7 +14,7 @@ import ( // Creates a custom SageMaker image. A SageMaker image is a set of image versions. // Each image version represents a container image stored in Amazon Elastic // Container Registry (ECR). For more information, see Bring your own SageMaker -// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). +// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) . func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error) { if params == nil { params = &CreateImageInput{} diff --git a/service/sagemaker/api_op_CreateImageVersion.go b/service/sagemaker/api_op_CreateImageVersion.go index dc228689648..5dc67e7ae2f 100644 --- a/service/sagemaker/api_op_CreateImageVersion.go +++ b/service/sagemaker/api_op_CreateImageVersion.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a version of the SageMaker image specified by ImageName. The version +// Creates a version of the SageMaker image specified by ImageName . The version // represents the Amazon Elastic Container Registry (ECR) container image specified -// by BaseImage. +// by BaseImage . func (c *Client) CreateImageVersion(ctx context.Context, params *CreateImageVersionInput, optFns ...func(*Options)) (*CreateImageVersionOutput, error) { if params == nil { params = &CreateImageVersionInput{} @@ -58,26 +58,18 @@ type CreateImageVersionInput struct { Horovod bool // Indicates SageMaker job type compatibility. - // - // * TRAINING: The image version is - // compatible with SageMaker training jobs. - // - // * INFERENCE: The image version is - // compatible with SageMaker inference jobs. - // - // * NOTEBOOK_KERNEL: The image version - // is compatible with SageMaker notebook kernels. + // - TRAINING : The image version is compatible with SageMaker training jobs. + // - INFERENCE : The image version is compatible with SageMaker inference jobs. + // - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook + // kernels. JobType types.JobType // The machine learning framework vended in the image version. MLFramework *string // Indicates CPU or GPU compatibility. - // - // * CPU: The image version is compatible with - // CPU. - // - // * GPU: The image version is compatible with GPU. + // - CPU : The image version is compatible with CPU. + // - GPU : The image version is compatible with GPU. Processor types.Processor // The supported programming language and its version. @@ -87,20 +79,14 @@ type CreateImageVersionInput struct { ReleaseNotes *string // The stability of the image version, specified by the maintainer. - // - // * - // NOT_PROVIDED: The maintainers did not provide a status for image version - // stability. - // - // * STABLE: The image version is stable. - // - // * TO_BE_ARCHIVED: The image - // version is set to be archived. Custom image versions that are set to be archived - // are automatically archived after three months. - // - // * ARCHIVED: The image version is - // archived. Archived image versions are not searchable and are no longer actively - // supported. + // - NOT_PROVIDED : The maintainers did not provide a status for image version + // stability. + // - STABLE : The image version is stable. + // - TO_BE_ARCHIVED : The image version is set to be archived. Custom image + // versions that are set to be archived are automatically archived after three + // months. + // - ARCHIVED : The image version is archived. Archived image versions are not + // searchable and are no longer actively supported. VendorGuidance types.VendorGuidance noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateInferenceExperiment.go b/service/sagemaker/api_op_CreateInferenceExperiment.go index 421e784b072..b400ef67034 100644 --- a/service/sagemaker/api_op_CreateInferenceExperiment.go +++ b/service/sagemaker/api_op_CreateInferenceExperiment.go @@ -14,14 +14,13 @@ import ( // Creates an inference experiment using the configurations specified in the // request. Use this API to setup and schedule an experiment to compare model // variants on a Amazon SageMaker inference endpoint. For more information about -// inference experiments, see Shadow tests -// (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html). Amazon -// SageMaker begins your experiment at the scheduled time and routes traffic to -// your endpoint's model variants based on your specified configuration. While the -// experiment is in progress or after it has concluded, you can view metrics that -// compare your model variants. For more information, see View, monitor, and edit -// shadow tests -// (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html). +// inference experiments, see Shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html) +// . Amazon SageMaker begins your experiment at the scheduled time and routes +// traffic to your endpoint's model variants based on your specified configuration. +// While the experiment is in progress or after it has concluded, you can view +// metrics that compare your model variants. For more information, see View, +// monitor, and edit shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html) +// . func (c *Client) CreateInferenceExperiment(ctx context.Context, params *CreateInferenceExperimentInput, optFns ...func(*Options)) (*CreateInferenceExperimentOutput, error) { if params == nil { params = &CreateInferenceExperimentInput{} @@ -39,8 +38,8 @@ func (c *Client) CreateInferenceExperiment(ctx context.Context, params *CreateIn type CreateInferenceExperimentInput struct { - // The name of the Amazon SageMaker endpoint on which you want to run the inference - // experiment. + // The name of the Amazon SageMaker endpoint on which you want to run the + // inference experiment. // // This member is required. EndpointName *string @@ -75,18 +74,17 @@ type CreateInferenceExperimentInput struct { // The type of the inference experiment that you want to run. The following types // of experiments are possible: - // - // * ShadowMode: You can use this type to validate a - // shadow variant. For more information, see Shadow tests - // (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html). + // - ShadowMode : You can use this type to validate a shadow variant. For more + // information, see Shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html) + // . // // This member is required. Type types.InferenceExperimentType // The Amazon S3 location and configuration for storing inference request and // response data. This is an optional parameter that you can use for data capture. - // For more information, see Capture data - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html). + // For more information, see Capture data (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html) + // . DataStorageConfig *types.InferenceExperimentDataStorageConfig // A description for the inference experiment. @@ -96,35 +94,25 @@ type CreateInferenceExperimentInput struct { // that Amazon SageMaker uses to encrypt data on the storage volume attached to the // ML compute instance that hosts the endpoint. The KmsKey can be any of the // following formats: - // - // * KMS key ID "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // Amazon Resource Name (ARN) of a KMS key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // KMS key Alias "alias/ExampleAlias" - // - // * Amazon Resource Name (ARN) of a KMS key - // Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" - // - // If you use a KMS - // key ID or an alias of your KMS key, the Amazon SageMaker execution role must - // include permissions to call kms:Encrypt. If you don't provide a KMS key ID, - // Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. - // Amazon SageMaker uses server-side encryption with KMS managed keys for - // OutputDataConfig. If you use a bucket policy with an s3:PutObject permission - // that only allows objects with server-side encryption, set the condition key of - // s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS - // managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the - // Amazon Simple Storage Service Developer Guide. The KMS key policy must grant - // permission to the IAM role that you specify in your CreateEndpoint and + // - KMS key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - KMS key Alias "alias/ExampleAlias" + // - Amazon Resource Name (ARN) of a KMS key Alias + // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + // If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker + // execution role must include permissions to call kms:Encrypt . If you don't + // provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 + // for your role's account. Amazon SageMaker uses server-side encryption with KMS + // managed keys for OutputDataConfig . If you use a bucket policy with an + // s3:PutObject permission that only allows objects with server-side encryption, + // set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more + // information, see KMS managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // in the Amazon Simple Storage Service Developer Guide. The KMS key policy must + // grant permission to the IAM role that you specify in your CreateEndpoint and // UpdateEndpoint requests. For more information, see Using Key Policies in Amazon - // Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Amazon Web Services Key Management Service Developer Guide. + // Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Amazon Web Services Key Management Service Developer Guide. KmsKey *string // The duration for which you want the inference experiment to run. If you don't @@ -135,7 +123,7 @@ type CreateInferenceExperimentInput struct { // Array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or // environment. For more information, see Tagging your Amazon Web Services - // Resources (https://docs.aws.amazon.com/ARG/latest/userguide/tagging.html). + // Resources (https://docs.aws.amazon.com/ARG/latest/userguide/tagging.html) . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go b/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go index 588e15c792a..9938e4625e8 100644 --- a/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go +++ b/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a recommendation job. You can create either an instance recommendation or -// load test job. +// Starts a recommendation job. You can create either an instance recommendation +// or load test job. func (c *Client) CreateInferenceRecommendationsJob(ctx context.Context, params *CreateInferenceRecommendationsJobInput, optFns ...func(*Options)) (*CreateInferenceRecommendationsJobOutput, error) { if params == nil { params = &CreateInferenceRecommendationsJobInput{} @@ -36,16 +36,16 @@ type CreateInferenceRecommendationsJobInput struct { // This member is required. InputConfig *types.RecommendationJobInputConfig - // A name for the recommendation job. The name must be unique within the Amazon Web - // Services Region and within your Amazon Web Services account. + // A name for the recommendation job. The name must be unique within the Amazon + // Web Services Region and within your Amazon Web Services account. // // This member is required. JobName *string // Defines the type of recommendation job. Specify Default to initiate an instance - // recommendation and Advanced to initiate a load test. If left unspecified, Amazon - // SageMaker Inference Recommender will run an instance recommendation (DEFAULT) - // job. + // recommendation and Advanced to initiate a load test. If left unspecified, + // Amazon SageMaker Inference Recommender will run an instance recommendation ( + // DEFAULT ) job. // // This member is required. JobType types.RecommendationJobType diff --git a/service/sagemaker/api_op_CreateLabelingJob.go b/service/sagemaker/api_op_CreateLabelingJob.go index c5e7b16cd9e..bb5507441be 100644 --- a/service/sagemaker/api_op_CreateLabelingJob.go +++ b/service/sagemaker/api_op_CreateLabelingJob.go @@ -11,45 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a job that uses workers to label the data objects in your input dataset. -// You can use the labeled data to train machine learning models. You can select -// your workforce from one of three providers: +// Creates a job that uses workers to label the data objects in your input +// dataset. You can use the labeled data to train machine learning models. You can +// select your workforce from one of three providers: +// - A private workforce that you create. It can include employees, contractors, +// and outside experts. Use a private workforce when want the data to stay within +// your organization or when a specific set of skills is required. +// - One or more vendors that you select from the Amazon Web Services +// Marketplace. Vendors provide expertise in specific areas. +// - The Amazon Mechanical Turk workforce. This is the largest workforce, but it +// should only be used for public data or data that has been stripped of any +// personally identifiable information. // -// * A private workforce that you -// create. It can include employees, contractors, and outside experts. Use a -// private workforce when want the data to stay within your organization or when a -// specific set of skills is required. -// -// * One or more vendors that you select from -// the Amazon Web Services Marketplace. Vendors provide expertise in specific -// areas. -// -// * The Amazon Mechanical Turk workforce. This is the largest workforce, -// but it should only be used for public data or data that has been stripped of any -// personally identifiable information. -// -// You can also use automated data labeling -// to reduce the number of data objects that need to be labeled by a human. -// Automated data labeling uses active learning to determine if a data object can -// be labeled by machine or if it needs to be sent to a human worker. For more -// information, see Using Automated Data Labeling -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html). -// The data objects to be labeled are contained in an Amazon S3 bucket. You create -// a manifest file that describes the location of each object. For more -// information, see Using Input and Output Data -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html). The output can -// be used as the manifest file for another labeling job or as training data for -// your machine learning models. You can use this operation to create a static -// labeling job or a streaming labeling job. A static labeling job stops if all -// data objects in the input manifest file identified in ManifestS3Uri have been -// labeled. A streaming labeling job runs perpetually until it is manually stopped, -// or remains idle for 10 days. You can send new data objects to an active -// (InProgress) streaming labeling job in real time. To learn how to create a -// static labeling job, see Create a Labeling Job (API) -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-create-labeling-job-api.html) +// You can also use automated data labeling to reduce the number of data objects +// that need to be labeled by a human. Automated data labeling uses active learning +// to determine if a data object can be labeled by machine or if it needs to be +// sent to a human worker. For more information, see Using Automated Data Labeling (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html) +// . The data objects to be labeled are contained in an Amazon S3 bucket. You +// create a manifest file that describes the location of each object. For more +// information, see Using Input and Output Data (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html) +// . The output can be used as the manifest file for another labeling job or as +// training data for your machine learning models. You can use this operation to +// create a static labeling job or a streaming labeling job. A static labeling job +// stops if all data objects in the input manifest file identified in ManifestS3Uri +// have been labeled. A streaming labeling job runs perpetually until it is +// manually stopped, or remains idle for 10 days. You can send new data objects to +// an active ( InProgress ) streaming labeling job in real time. To learn how to +// create a static labeling job, see Create a Labeling Job (API) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-create-labeling-job-api.html) // in the Amazon SageMaker Developer Guide. To learn how to create a streaming -// labeling job, see Create a Streaming Labeling Job -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-create-job.html). +// labeling job, see Create a Streaming Labeling Job (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-create-job.html) +// . func (c *Client) CreateLabelingJob(ctx context.Context, params *CreateLabelingJobInput, optFns ...func(*Options)) (*CreateLabelingJobOutput, error) { if params == nil { params = &CreateLabelingJobInput{} @@ -75,78 +66,59 @@ type CreateLabelingJobInput struct { // Input data for the labeling job, such as the Amazon S3 location of the data // objects and the location of the manifest file that describes the data objects. - // You must specify at least one of the following: S3DataSource or - // SnsDataSource. - // - // * Use SnsDataSource to specify an SNS input topic for a - // streaming labeling job. If you do not specify and SNS input topic ARN, Ground - // Truth will create a one-time labeling job that stops after all data objects in - // the input manifest file have been labeled. - // - // * Use S3DataSource to specify an - // input manifest file for both streaming and one-time labeling jobs. Adding an - // S3DataSource is optional if you use SnsDataSource to create a streaming labeling - // job. - // - // If you use the Amazon Mechanical Turk workforce, your input data should - // not include confidential information, personal information or protected health + // You must specify at least one of the following: S3DataSource or SnsDataSource . + // - Use SnsDataSource to specify an SNS input topic for a streaming labeling + // job. If you do not specify and SNS input topic ARN, Ground Truth will create a + // one-time labeling job that stops after all data objects in the input manifest + // file have been labeled. + // - Use S3DataSource to specify an input manifest file for both streaming and + // one-time labeling jobs. Adding an S3DataSource is optional if you use + // SnsDataSource to create a streaming labeling job. + // If you use the Amazon Mechanical Turk workforce, your input data should not + // include confidential information, personal information or protected health // information. Use ContentClassifiers to specify that your data is free of // personally identifiable information and adult content. // // This member is required. InputConfig *types.LabelingJobInputConfig - // The attribute name to use for the label in the output manifest file. This is the - // key for the key/value pair formed with the label that a worker assigns to the - // object. The LabelAttributeName must meet the following requirements. - // - // * The name - // can't end with "-metadata". - // - // * If you are using one of the following built-in - // task types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html), the - // attribute name must end with "-ref". If the task type you are using is not - // listed below, the attribute name must not end with "-ref". - // - // * Image semantic - // segmentation (SemanticSegmentation), and adjustment - // (AdjustmentSemanticSegmentation) and verification - // (VerificationSemanticSegmentation) labeling jobs for this task type. - // - // * Video - // frame object detection (VideoObjectDetection), and adjustment and verification - // (AdjustmentVideoObjectDetection) labeling jobs for this task type. - // - // * Video - // frame object tracking (VideoObjectTracking), and adjustment and verification - // (AdjustmentVideoObjectTracking) labeling jobs for this task type. - // - // * 3D point - // cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment - // and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for - // this task type. - // - // * 3D point cloud object tracking (3DPointCloudObjectTracking), - // and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling - // jobs for this task type. - // - // If you are creating an adjustment or verification - // labeling job, you must use a different LabelAttributeName than the one used in - // the original labeling job. The original labeling job is the Ground Truth - // labeling job that produced the labels that you want verified or adjusted. To - // learn more about adjustment and verification labeling jobs, see Verify and - // Adjust Labels - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html). + // The attribute name to use for the label in the output manifest file. This is + // the key for the key/value pair formed with the label that a worker assigns to + // the object. The LabelAttributeName must meet the following requirements. + // - The name can't end with "-metadata". + // - If you are using one of the following built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) + // , the attribute name must end with "-ref". If the task type you are using is not + // listed below, the attribute name must not end with "-ref". + // - Image semantic segmentation ( SemanticSegmentation) , and adjustment ( + // AdjustmentSemanticSegmentation ) and verification ( + // VerificationSemanticSegmentation ) labeling jobs for this task type. + // - Video frame object detection ( VideoObjectDetection ), and adjustment and + // verification ( AdjustmentVideoObjectDetection ) labeling jobs for this task + // type. + // - Video frame object tracking ( VideoObjectTracking ), and adjustment and + // verification ( AdjustmentVideoObjectTracking ) labeling jobs for this task + // type. + // - 3D point cloud semantic segmentation ( 3DPointCloudSemanticSegmentation ), + // and adjustment and verification ( Adjustment3DPointCloudSemanticSegmentation ) + // labeling jobs for this task type. + // - 3D point cloud object tracking ( 3DPointCloudObjectTracking ), and + // adjustment and verification ( Adjustment3DPointCloudObjectTracking ) labeling + // jobs for this task type. + // If you are creating an adjustment or verification labeling job, you must use a + // different LabelAttributeName than the one used in the original labeling job. + // The original labeling job is the Ground Truth labeling job that produced the + // labels that you want verified or adjusted. To learn more about adjustment and + // verification labeling jobs, see Verify and Adjust Labels (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html) + // . // // This member is required. LabelAttributeName *string - // The name of the labeling job. This name is used to identify the job in a list of - // labeling jobs. Labeling job names must be unique within an Amazon Web Services - // account and region. LabelingJobName is not case sensitive. For example, - // Example-job and example-job are considered the same labeling job name by Ground - // Truth. + // The name of the labeling job. This name is used to identify the job in a list + // of labeling jobs. Labeling job names must be unique within an Amazon Web + // Services account and region. LabelingJobName is not case sensitive. For + // example, Example-job and example-job are considered the same labeling job name + // by Ground Truth. // // This member is required. LabelingJobName *string @@ -164,52 +136,37 @@ type CreateLabelingJobInput struct { // This member is required. RoleArn *string - // The S3 URI of the file, referred to as a label category configuration file, that - // defines the categories used to label the data objects. For 3D point cloud and - // video frame task types, you can add label category attributes and frame - // attributes to your label category configuration file. To learn how, see Create a - // Labeling Category Configuration File for 3D Point Cloud Labeling Jobs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html). - // For named entity recognition jobs, in addition to "labels", you must provide + // The S3 URI of the file, referred to as a label category configuration file, + // that defines the categories used to label the data objects. For 3D point cloud + // and video frame task types, you can add label category attributes and frame + // attributes to your label category configuration file. To learn how, see Create + // a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html) + // . For named entity recognition jobs, in addition to "labels" , you must provide // worker instructions in the label category configuration file using the // "instructions" parameter: "instructions": {"shortInstruction":" // Add header // + // Add Instructions + // ", "fullInstruction":"Add additional instructions."} . For details and an + // example, see Create a Named Entity Recognition Labeling Job (API) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api) + // . For all other built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) + // and custom tasks (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html) + // , your label category configuration file must be a JSON file in the following + // format. Identify the labels you want to use by replacing label_1 , label_2 , ... + // , label_n with your label categories. { + // "document-version": "2018-11-28", // - // Add Instructions - // - // ", "fullInstruction":"Add additional instructions."}. For - // details and an example, see Create a Named Entity Recognition Labeling Job (API) - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api). - // For all other built-in task types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) and custom - // tasks - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html), - // your label category configuration file must be a JSON file in the following - // format. Identify the labels you want to use by replacing label_1, - // label_2,...,label_n with your label categories. { - // "document-version": - // "2018-11-28", - // - // "labels": [{"label": "label_1"},{"label": - // "label_2"},...{"label": "label_n"}] - // - // } Note the following about the label - // category configuration file: - // - // * For image classification and text classification - // (single and multi-label) you must specify at least two label categories. For all - // other task types, the minimum number of label categories required is one. - // - // * - // Each label category must be unique, you cannot specify duplicate label - // categories. - // - // * If you create a 3D point cloud or video frame adjustment or - // verification labeling job, you must include auditLabelAttributeName in the label - // category configuration. Use this parameter to enter the LabelAttributeName - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName) - // of the labeling job you want to adjust or verify annotations of. + // "labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}] + // } Note the following about the label category configuration file: + // - For image classification and text classification (single and multi-label) + // you must specify at least two label categories. For all other task types, the + // minimum number of label categories required is one. + // - Each label category must be unique, you cannot specify duplicate label + // categories. + // - If you create a 3D point cloud or video frame adjustment or verification + // labeling job, you must include auditLabelAttributeName in the label category + // configuration. Use this parameter to enter the LabelAttributeName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName) + // of the labeling job you want to adjust or verify annotations of. LabelCategoryConfigS3Uri *string // Configures the information required to perform automated data labeling. @@ -221,8 +178,7 @@ type CreateLabelingJobInput struct { StoppingConditions *types.LabelingJobStoppingConditions // An array of key/value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag @@ -231,8 +187,8 @@ type CreateLabelingJobInput struct { type CreateLabelingJobOutput struct { - // The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify - // the labeling job. + // The Amazon Resource Name (ARN) of the labeling job. You use this ARN to + // identify the labeling job. // // This member is required. LabelingJobArn *string diff --git a/service/sagemaker/api_op_CreateModel.go b/service/sagemaker/api_op_CreateModel.go index a60292208fa..e2cee7688dc 100644 --- a/service/sagemaker/api_op_CreateModel.go +++ b/service/sagemaker/api_op_CreateModel.go @@ -21,8 +21,7 @@ import ( // endpoint with the CreateEndpoint API. SageMaker then deploys all of the // containers that you defined for the model in the hosting environment. For an // example that calls this method when deploying a model to SageMaker hosting -// services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)). -// (https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model) +// services, see Create a Model (Amazon Web Services SDK for Python (Boto 3)). (https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html#realtime-endpoints-deployment-create-model) // To run a batch transform using your model, you start a job with the // CreateTransformJob API. SageMaker uses your model and your dataset to get // inferences which are then saved to a specified S3 location. In the request, you @@ -51,10 +50,9 @@ type CreateModelInput struct { // The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to // access model artifacts and docker image for deployment on ML compute instances // or for batch transform jobs. Deploying on ML compute instances is part of model - // hosting. For more information, see SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be - // able to pass this role to SageMaker, the caller of this API must have the - // iam:PassRole permission. + // hosting. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) + // . To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // This member is required. ExecutionRoleArn *string @@ -81,17 +79,16 @@ type CreateModelInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag // A VpcConfig object that specifies the VPC that you want your model to connect // to. Control access to and from your model container by configuring the VPC. // VpcConfig is used in hosting services and in batch transform. For more - // information, see Protect Endpoints by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and Protect Data - // in Batch Transform Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). + // information, see Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) + // and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private + // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) . VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModelBiasJobDefinition.go b/service/sagemaker/api_op_CreateModelBiasJobDefinition.go index 59e2923a7af..1a114e2e073 100644 --- a/service/sagemaker/api_op_CreateModelBiasJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelBiasJobDefinition.go @@ -71,8 +71,7 @@ type CreateModelBiasJobDefinitionInput struct { StoppingCondition *types.MonitoringStoppingCondition // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateModelCard.go b/service/sagemaker/api_op_CreateModelCard.go index d5cfaf8a8bb..913866212cc 100644 --- a/service/sagemaker/api_op_CreateModelCard.go +++ b/service/sagemaker/api_op_CreateModelCard.go @@ -12,8 +12,8 @@ import ( ) // Creates an Amazon SageMaker Model Card. For information about how to use model -// cards, see Amazon SageMaker Model Card -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html). +// cards, see Amazon SageMaker Model Card (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html) +// . func (c *Client) CreateModelCard(ctx context.Context, params *CreateModelCardInput, optFns ...func(*Options)) (*CreateModelCardOutput, error) { if params == nil { params = &CreateModelCardInput{} @@ -31,8 +31,7 @@ func (c *Client) CreateModelCard(ctx context.Context, params *CreateModelCardInp type CreateModelCardInput struct { - // The content of the model card. Content must be in model card JSON schema - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // The content of the model card. Content must be in model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) // and provided as a string. // // This member is required. @@ -44,25 +43,18 @@ type CreateModelCardInput struct { ModelCardName *string // The approval status of the model card within your organization. Different - // organizations might have different criteria for model card review and - // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // organizations might have different criteria for model card review and approval. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. // // This member is required. ModelCardStatus types.ModelCardStatus - // An optional Key Management Service key to encrypt, decrypt, and re-encrypt model - // card content for regulated workloads with highly sensitive data. + // An optional Key Management Service key to encrypt, decrypt, and re-encrypt + // model card content for regulated workloads with highly sensitive data. SecurityConfig *types.ModelCardSecurityConfig // Key-value pairs used to manage metadata for model cards. diff --git a/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go b/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go index bab0e85f4d2..8d226b733ae 100644 --- a/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go @@ -72,8 +72,7 @@ type CreateModelExplainabilityJobDefinitionInput struct { StoppingCondition *types.MonitoringStoppingCondition // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateModelPackage.go b/service/sagemaker/api_op_CreateModelPackage.go index 0ae6a714f3c..b23095bc6f5 100644 --- a/service/sagemaker/api_op_CreateModelPackage.go +++ b/service/sagemaker/api_op_CreateModelPackage.go @@ -17,16 +17,12 @@ import ( // group. Buyers can subscribe to model packages listed on Amazon Web Services // Marketplace to create models in SageMaker. To create a model package by // specifying a Docker container that contains your inference code and the Amazon -// S3 location of your model artifacts, provide values for InferenceSpecification. +// S3 location of your model artifacts, provide values for InferenceSpecification . // To create a model from an algorithm resource that you created or subscribed to // in Amazon Web Services Marketplace, provide a value for -// SourceAlgorithmSpecification. There are two types of model packages: -// -// * -// Versioned - a model that is part of a model group in the model registry. -// -// * -// Unversioned - a model package that is not part of a model group. +// SourceAlgorithmSpecification . There are two types of model packages: +// - Versioned - a model that is part of a model group in the model registry. +// - Unversioned - a model package that is not part of a model group. func (c *Client) CreateModelPackage(ctx context.Context, params *CreateModelPackageInput, optFns ...func(*Options)) (*CreateModelPackageOutput, error) { if params == nil { params = &CreateModelPackageInput{} @@ -68,23 +64,18 @@ type CreateModelPackageInput struct { // Represents the drift check baselines that can be used when the model monitor is // set using the model package. For more information, see the topic on Drift - // Detection against Previous Baselines in SageMaker Pipelines - // (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) + // Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) // in the Amazon SageMaker Developer Guide. DriftCheckBaselines *types.DriftCheckBaselines - // Specifies details about inference jobs that can be run with models based on this - // model package, including the following: - // - // * The Amazon ECR paths of containers - // that contain the inference code and model artifacts. - // - // * The instance types that - // the model package supports for transform jobs and real-time endpoints used for - // inference. - // - // * The input and output content formats that the model package - // supports for inference. + // Specifies details about inference jobs that can be run with models based on + // this model package, including the following: + // - The Amazon ECR paths of containers that contain the inference code and + // model artifacts. + // - The instance types that the model package supports for transform jobs and + // real-time endpoints used for inference. + // - The input and output content formats that the model package supports for + // inference. InferenceSpecification *types.InferenceSpecification // Metadata properties of the tracking entity, trial, or trial component. @@ -115,8 +106,7 @@ type CreateModelPackageInput struct { // stored. This path must point to a single gzip compressed tar archive (.tar.gz // suffix). This archive can hold multiple files that are all equally used in the // load test. Each file in the archive must satisfy the size constraints of the - // InvokeEndpoint - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax) + // InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax) // call. SamplePayloadUrl *string @@ -124,16 +114,15 @@ type CreateModelPackageInput struct { SourceAlgorithmSpecification *types.SourceAlgorithmSpecification // A list of key value pairs associated with the model. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []types.Tag // The machine learning task your model package accomplishes. Common machine // learning tasks include object detection and image classification. The following // tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | - // "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | - // "CLASSIFICATION" | "REGRESSION" | "OTHER". Specify "OTHER" if none of the tasks + // "OBJECT_DETECTION" | "TEXT_GENERATION" | "IMAGE_SEGMENTATION" | "FILL_MASK" | + // "CLASSIFICATION" | "REGRESSION" | "OTHER" . Specify "OTHER" if none of the tasks // listed fit your use case. Task *string diff --git a/service/sagemaker/api_op_CreateModelPackageGroup.go b/service/sagemaker/api_op_CreateModelPackageGroup.go index 168cf23c480..b2c95e01620 100644 --- a/service/sagemaker/api_op_CreateModelPackageGroup.go +++ b/service/sagemaker/api_op_CreateModelPackageGroup.go @@ -37,10 +37,9 @@ type CreateModelPackageGroupInput struct { // A description for the model group. ModelPackageGroupDescription *string - // A list of key value pairs associated with the model group. For more information, - // see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // A list of key value pairs associated with the model group. For more + // information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModelQualityJobDefinition.go b/service/sagemaker/api_op_CreateModelQualityJobDefinition.go index 28c6d81906c..5103b8ae01a 100644 --- a/service/sagemaker/api_op_CreateModelQualityJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelQualityJobDefinition.go @@ -12,8 +12,8 @@ import ( ) // Creates a definition for a job that monitors model quality and drift. For -// information about model monitor, see Amazon SageMaker Model Monitor -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html). +// information about model monitor, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) +// . func (c *Client) CreateModelQualityJobDefinition(ctx context.Context, params *CreateModelQualityJobDefinitionInput, optFns ...func(*Options)) (*CreateModelQualityJobDefinitionOutput, error) { if params == nil { params = &CreateModelQualityJobDefinitionInput{} @@ -72,8 +72,7 @@ type CreateModelQualityJobDefinitionInput struct { StoppingCondition *types.MonitoringStoppingCondition // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateMonitoringSchedule.go b/service/sagemaker/api_op_CreateMonitoringSchedule.go index 4e7de5b581f..8674e93cc89 100644 --- a/service/sagemaker/api_op_CreateMonitoringSchedule.go +++ b/service/sagemaker/api_op_CreateMonitoringSchedule.go @@ -43,8 +43,7 @@ type CreateMonitoringScheduleInput struct { MonitoringScheduleName *string // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateNotebookInstance.go b/service/sagemaker/api_op_CreateNotebookInstance.go index b844b2b85ec..80720e57f22 100644 --- a/service/sagemaker/api_op_CreateNotebookInstance.go +++ b/service/sagemaker/api_op_CreateNotebookInstance.go @@ -20,30 +20,26 @@ import ( // notebooks. Each notebook demonstrates how to use SageMaker with a specific // algorithm or with a machine learning framework. After receiving the request, // SageMaker does the following: +// - Creates a network interface in the SageMaker VPC. +// - (Option) If you specified SubnetId , SageMaker creates a network interface +// in your own VPC, which is inferred from the subnet ID that you provide in the +// input. When creating this network interface, SageMaker attaches the security +// group that you specified in the request to the network interface that it creates +// in your VPC. +// - Launches an EC2 instance of the type specified in the request in the +// SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both +// network interfaces when launching this instance. This enables inbound traffic +// from your own VPC to the notebook instance, assuming that the security groups +// allow it. // -// * Creates a network interface in the SageMaker -// VPC. -// -// * (Option) If you specified SubnetId, SageMaker creates a network -// interface in your own VPC, which is inferred from the subnet ID that you provide -// in the input. When creating this network interface, SageMaker attaches the -// security group that you specified in the request to the network interface that -// it creates in your VPC. -// -// * Launches an EC2 instance of the type specified in the -// request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker -// specifies both network interfaces when launching this instance. This enables -// inbound traffic from your own VPC to the notebook instance, assuming that the -// security groups allow it. -// -// After creating the notebook instance, SageMaker -// returns its Amazon Resource Name (ARN). You can't change the name of a notebook -// instance after you create it. After SageMaker creates the notebook instance, you -// can connect to the Jupyter server and work in Jupyter notebooks. For example, -// you can write code to explore a dataset that you can use for model training, -// train a model, host models by creating SageMaker endpoints, and validate hosted -// models. For more information, see How It Works -// (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). +// After creating the notebook instance, SageMaker returns its Amazon Resource +// Name (ARN). You can't change the name of a notebook instance after you create +// it. After SageMaker creates the notebook instance, you can connect to the +// Jupyter server and work in Jupyter notebooks. For example, you can write code to +// explore a dataset that you can use for model training, train a model, host +// models by creating SageMaker endpoints, and validate hosted models. For more +// information, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) +// . func (c *Client) CreateNotebookInstance(ctx context.Context, params *CreateNotebookInstanceInput, optFns ...func(*Options)) (*CreateNotebookInstanceOutput, error) { if params == nil { params = &CreateNotebookInstanceInput{} @@ -75,50 +71,46 @@ type CreateNotebookInstanceInput struct { // instance, SageMaker assumes this role to perform tasks on your behalf. You must // grant this role necessary permissions so SageMaker can perform these tasks. The // policy must allow the SageMaker service principal (sagemaker.amazonaws.com) - // permissions to assume this role. For more information, see SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be - // able to pass this role to SageMaker, the caller of this API must have the - // iam:PassRole permission. + // permissions to assume this role. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) + // . To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // This member is required. RoleArn *string // A list of Elastic Inference (EI) instance types to associate with this notebook // instance. Currently, only one instance type can be associated with a notebook - // instance. For more information, see Using Elastic Inference in Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + // instance. For more information, see Using Elastic Inference in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) + // . AcceleratorTypes []types.NotebookInstanceAcceleratorType // An array of up to three Git repositories to associate with the notebook // instance. These can be either the names of Git repositories stored as resources // in your account, or the URL of Git repositories in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. These repositories are cloned at the same level + // as the default repository of your notebook instance. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . AdditionalCodeRepositories []string // A Git repository to associate with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource // in your account, or the URL of a Git repository in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. When you open a notebook instance, it opens in + // the directory that contains this repository. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . DefaultCodeRepository *string - // Sets whether SageMaker provides internet access to the notebook instance. If you - // set this to Disabled this notebook instance is able to access resources only in - // your VPC, and is not be able to connect to SageMaker training and endpoint - // services unless you configure a NAT Gateway in your VPC. For more information, - // see Notebook Instances Are Internet-Enabled by Default - // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). - // You can set the value of this parameter to Disabled only if you set a value for - // the SubnetId parameter. + // Sets whether SageMaker provides internet access to the notebook instance. If + // you set this to Disabled this notebook instance is able to access resources + // only in your VPC, and is not be able to connect to SageMaker training and + // endpoint services unless you configure a NAT Gateway in your VPC. For more + // information, see Notebook Instances Are Internet-Enabled by Default (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access) + // . You can set the value of this parameter to Disabled only if you set a value + // for the SubnetId parameter. DirectInternetAccess types.DirectInternetAccess // Information on the IMDS configuration of the notebook instance @@ -127,29 +119,28 @@ type CreateNotebookInstanceInput struct { // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service // key that SageMaker uses to encrypt data on the storage volume attached to your // notebook instance. The KMS key you provide must be enabled. For information, see - // Enabling and Disabling Keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in - // the Amazon Web Services Key Management Service Developer Guide. + // Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) + // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string // The name of a lifecycle configuration to associate with the notebook instance. // For information about lifestyle configurations, see Step 2.1: (Optional) - // Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). + // Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) + // . LifecycleConfigName *string // The platform identifier of the notebook instance runtime environment. PlatformIdentifier *string // Whether root access is enabled or disabled for users of the notebook instance. - // The default value is Enabled. Lifecycle configurations need root access to be + // The default value is Enabled . Lifecycle configurations need root access to be // able to set up a notebook instance. Because of this, lifecycle configurations // associated with a notebook instance always run with root access even if you // disable root access for users. RootAccess types.RootAccess - // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - // for the same VPC as specified in the subnet. + // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must + // be for the same VPC as specified in the subnet. SecurityGroupIds []string // The ID of the subnet in a VPC to which you would like to have a connectivity @@ -158,8 +149,8 @@ type CreateNotebookInstanceInput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag // The size, in GB, of the ML storage volume to attach to the notebook instance. diff --git a/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go index 8b3d55a053d..ee9bcfbb661 100644 --- a/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go @@ -15,15 +15,15 @@ import ( // instance. A lifecycle configuration is a collection of shell scripts that run // when you create or start a notebook instance. Each lifecycle configuration // script has a limit of 16384 characters. The value of the $PATH environment -// variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin. View -// CloudWatch Logs for notebook instance lifecycle configurations in log group +// variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin . +// View CloudWatch Logs for notebook instance lifecycle configurations in log group // /aws/sagemaker/NotebookInstances in log stream -// [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration scripts +// [notebook-instance-name]/[LifecycleConfigHook] . Lifecycle configuration scripts // cannot run for longer than 5 minutes. If a script runs for longer than 5 // minutes, it fails and the notebook instance is not created or started. For // information about notebook instance lifestyle configurations, see Step 2.1: -// (Optional) Customize a Notebook Instance -// (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). +// (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) +// . func (c *Client) CreateNotebookInstanceLifecycleConfig(ctx context.Context, params *CreateNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*CreateNotebookInstanceLifecycleConfigOutput, error) { if params == nil { params = &CreateNotebookInstanceLifecycleConfigInput{} diff --git a/service/sagemaker/api_op_CreatePresignedDomainUrl.go b/service/sagemaker/api_op_CreatePresignedDomainUrl.go index 03add6af789..6a73f2d229f 100644 --- a/service/sagemaker/api_op_CreatePresignedDomainUrl.go +++ b/service/sagemaker/api_op_CreatePresignedDomainUrl.go @@ -21,10 +21,9 @@ import ( // attempts to connect to the app. You can restrict access to this API and to the // URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC // Endpoints that you specify. For more information, see Connect to SageMaker -// Studio Through an Interface VPC Endpoint -// (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html) +// Studio Through an Interface VPC Endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html) // . The URL that you get from a call to CreatePresignedDomainUrl has a default -// timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If +// timeout of 5 minutes. You can configure this value using ExpiresInSeconds . If // you try to use the URL after the timeout limit expires, you are directed to the // Amazon Web Services console sign-in page. func (c *Client) CreatePresignedDomainUrl(ctx context.Context, params *CreatePresignedDomainUrlInput, optFns ...func(*Options)) (*CreatePresignedDomainUrlOutput, error) { diff --git a/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go b/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go index 8320247a105..f4d14481392 100644 --- a/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go +++ b/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go @@ -23,11 +23,10 @@ import ( // NotIpAddress condition operator and the aws:SourceIP condition context key to // specify the list of IP addresses that you want to have access to the notebook // instance. For more information, see Limit Access to a Notebook Instance by IP -// Address -// (https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter). -// The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid -// only for 5 minutes. If you try to use the URL after the 5-minute limit expires, -// you are directed to the Amazon Web Services console sign-in page. +// Address (https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter) +// . The URL that you get from a call to CreatePresignedNotebookInstanceUrl is +// valid only for 5 minutes. If you try to use the URL after the 5-minute limit +// expires, you are directed to the Amazon Web Services console sign-in page. func (c *Client) CreatePresignedNotebookInstanceUrl(ctx context.Context, params *CreatePresignedNotebookInstanceUrlInput, optFns ...func(*Options)) (*CreatePresignedNotebookInstanceUrlOutput, error) { if params == nil { params = &CreatePresignedNotebookInstanceUrlInput{} diff --git a/service/sagemaker/api_op_CreateProcessingJob.go b/service/sagemaker/api_op_CreateProcessingJob.go index d0aa5534f10..3361da277a9 100644 --- a/service/sagemaker/api_op_CreateProcessingJob.go +++ b/service/sagemaker/api_op_CreateProcessingJob.go @@ -40,8 +40,8 @@ type CreateProcessingJobInput struct { // This member is required. ProcessingJobName *string - // Identifies the resources, ML compute instances, and ML storage volumes to deploy - // for a processing job. In distributed training, you specify more than one + // Identifies the resources, ML compute instances, and ML storage volumes to + // deploy for a processing job. In distributed training, you specify more than one // instance. // // This member is required. @@ -59,13 +59,9 @@ type CreateProcessingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *types.ExperimentConfig // Networking options for a processing job, such as whether to allow inbound and @@ -84,8 +80,7 @@ type CreateProcessingJobInput struct { StoppingCondition *types.ProcessingStoppingCondition // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateProject.go b/service/sagemaker/api_op_CreateProject.go index df3ad83908e..38e77fc59b1 100644 --- a/service/sagemaker/api_op_CreateProject.go +++ b/service/sagemaker/api_op_CreateProject.go @@ -38,8 +38,8 @@ type CreateProjectInput struct { // The product ID and provisioning artifact ID to provision a service catalog. The // provisioning artifact ID will default to the latest provisioning artifact ID of // the product, if you don't provide the provisioning artifact ID. For more - // information, see What is Amazon Web Services Service Catalog - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) + // . // // This member is required. ServiceCatalogProvisioningDetails *types.ServiceCatalogProvisioningDetails @@ -48,10 +48,9 @@ type CreateProjectInput struct { ProjectDescription *string // An array of key-value pairs that you want to use to organize and track your - // Amazon Web Services resource costs. For more information, see Tagging Amazon Web - // Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Amazon Web Services resource costs. For more information, see Tagging Amazon + // Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateTrainingJob.go b/service/sagemaker/api_op_CreateTrainingJob.go index cc7a789f822..7544c139fb2 100644 --- a/service/sagemaker/api_op_CreateTrainingJob.go +++ b/service/sagemaker/api_op_CreateTrainingJob.go @@ -17,57 +17,39 @@ import ( // resulting model artifacts as part of the model. You can also use the artifacts // in a machine learning service other than SageMaker, provided that you know how // to use them for inference. In the request body, you provide the following: +// - AlgorithmSpecification - Identifies the training algorithm to use. +// - HyperParameters - Specify these algorithm-specific parameters to enable the +// estimation of model parameters during training. Hyperparameters can be tuned to +// optimize this learning process. For a list of hyperparameters for each training +// algorithm provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) +// . Do not include any security-sensitive information including account access +// IDs, secrets or tokens in any hyperparameter field. If the use of +// security-sensitive credentials are detected, SageMaker will reject your training +// job request and return an exception error. +// - InputDataConfig - Describes the input required by the training job and the +// Amazon S3, EFS, or FSx location where it is stored. +// - OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker +// to save the results of model training. +// - ResourceConfig - Identifies the resources, ML compute instances, and ML +// storage volumes to deploy for model training. In distributed training, you +// specify more than one instance. +// - EnableManagedSpotTraining - Optimize the cost of training machine learning +// models by up to 80% by using Amazon EC2 Spot instances. For more information, +// see Managed Spot Training (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html) +// . +// - RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform +// tasks on your behalf during model training. You must grant this role the +// necessary permissions so that SageMaker can successfully complete model +// training. +// - StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to +// set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a +// managed spot training job has to complete. +// - Environment - The environment variables to set in the Docker container. +// - RetryStrategy - The number of times to retry the job when the job fails due +// to an InternalServerError . // -// * -// AlgorithmSpecification - Identifies the training algorithm to use. -// -// * -// HyperParameters - Specify these algorithm-specific parameters to enable the -// estimation of model parameters during training. Hyperparameters can be tuned to -// optimize this learning process. For a list of hyperparameters for each training -// algorithm provided by SageMaker, see Algorithms -// (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). Do not include any -// security-sensitive information including account access IDs, secrets or tokens -// in any hyperparameter field. If the use of security-sensitive credentials are -// detected, SageMaker will reject your training job request and return an -// exception error. -// -// * InputDataConfig - Describes the input required by the -// training job and the Amazon S3, EFS, or FSx location where it is stored. -// -// * -// OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to -// save the results of model training. -// -// * ResourceConfig - Identifies the -// resources, ML compute instances, and ML storage volumes to deploy for model -// training. In distributed training, you specify more than one instance. -// -// * -// EnableManagedSpotTraining - Optimize the cost of training machine learning -// models by up to 80% by using Amazon EC2 Spot instances. For more information, -// see Managed Spot Training -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). -// -// * -// RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks -// on your behalf during model training. You must grant this role the necessary -// permissions so that SageMaker can successfully complete model training. -// -// * -// StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a -// time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed -// spot training job has to complete. -// -// * Environment - The environment variables to -// set in the Docker container. -// -// * RetryStrategy - The number of times to retry the -// job when the job fails due to an InternalServerError. -// -// For more information -// about SageMaker, see How It Works -// (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). +// For more information about SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) +// . func (c *Client) CreateTrainingJob(ctx context.Context, params *CreateTrainingJobInput, optFns ...func(*Options)) (*CreateTrainingJobOutput, error) { if params == nil { params = &CreateTrainingJobInput{} @@ -87,11 +69,10 @@ type CreateTrainingJobInput struct { // The registry path of the Docker image that contains the training algorithm and // algorithm-specific metadata, including the input mode. For more information - // about algorithms provided by SageMaker, see Algorithms - // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For information - // about providing your own algorithms, see Using Your Own Algorithms with Amazon - // SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). + // about algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) + // . For information about providing your own algorithms, see Using Your Own + // Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // . // // This member is required. AlgorithmSpecification *types.AlgorithmSpecification @@ -102,8 +83,8 @@ type CreateTrainingJobInput struct { // This member is required. OutputDataConfig *types.OutputDataConfig - // The resources, including the ML compute instances and ML storage volumes, to use - // for model training. ML storage volumes store model artifacts and incremental + // The resources, including the ML compute instances and ML storage volumes, to + // use for model training. ML storage volumes store model artifacts and incremental // states. Training algorithms might also use ML storage volumes for scratch space. // If you want SageMaker to use the ML storage volume to store the training data, // choose File as the TrainingInputMode in the algorithm specification. For @@ -118,10 +99,9 @@ type CreateTrainingJobInput struct { // contains training code, write model artifacts to an S3 bucket, write logs to // Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant // permissions for all of these tasks to an IAM role. For more information, see - // SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be - // able to pass this role to SageMaker, the caller of this API must have the - // iam:PassRole permission. + // SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) + // . To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // This member is required. RoleArn *string @@ -149,8 +129,8 @@ type CreateTrainingJobInput struct { // Configuration information for the Amazon SageMaker Debugger hook parameters, // metric and tensor collections, and storage paths. To learn more about how to // configure the DebugHookConfig parameter, see Use the SageMaker and Debugger - // Configuration API Operations to Create, Update, and Debug Your Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . DebugHookConfig *types.DebugHookConfig // Configuration information for Amazon SageMaker Debugger rules for debugging @@ -158,15 +138,15 @@ type CreateTrainingJobInput struct { DebugRuleConfigurations []types.DebugRuleConfiguration // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed + // training, choose True . Encryption provides greater security for distributed // training, but training might take longer. How long it takes depends on the // amount of communication between compute instances, especially if you use a deep // learning algorithm in distributed training. For more information, see Protect - // Communications Between ML Compute Instances in a Distributed Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html). + // Communications Between ML Compute Instances in a Distributed Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html) + // . EnableInterContainerTrafficEncryption bool - // To train models using managed spot training, choose True. Managed spot training + // To train models using managed spot training, choose True . Managed spot training // provides a fully managed and scalable infrastructure for training machine // learning models. this option is useful when training jobs can be interrupted and // when there is flexibility when the training job is run. The complete and @@ -189,22 +169,18 @@ type CreateTrainingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *types.ExperimentConfig // Algorithm-specific parameters that influence the quality of the model. You set // hyperparameters before you start the learning process. For a list of // hyperparameters for each training algorithm provided by SageMaker, see - // Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). You can - // specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value + // Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) . You + // can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value // pair. Each key and value is limited to 256 characters, as specified by the - // Length Constraint. Do not include any security-sensitive information including + // Length Constraint . Do not include any security-sensitive information including // account access IDs, secrets or tokens in any hyperparameter field. If the use of // security-sensitive credentials are detected, SageMaker will reject your training // job request and return an exception error. @@ -213,8 +189,8 @@ type CreateTrainingJobInput struct { // An array of Channel objects. Each channel is a named input source. // InputDataConfig describes the input data and its location. Algorithms can accept // input data from one or more channels. For example, an algorithm might have two - // channels of input data, training_data and validation_data. The configuration for - // each channel provides the S3, EFS, or FSx location where the input data is + // channels of input data, training_data and validation_data . The configuration + // for each channel provides the S3, EFS, or FSx location where the input data is // stored. It also provides information about the stored data: the MIME type, // compression method, and whether the data is wrapped in RecordIO format. // Depending on the input mode that the algorithm supports, SageMaker either copies @@ -233,24 +209,24 @@ type CreateTrainingJobInput struct { ProfilerRuleConfigurations []types.ProfilerRuleConfiguration // The number of times to retry the job when the job fails due to an - // InternalServerError. + // InternalServerError . RetryStrategy *types.RetryStrategy // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag - // Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard - // output data. + // Configuration of storage locations for the Amazon SageMaker Debugger + // TensorBoard output data. TensorBoardOutputConfig *types.TensorBoardOutputConfig // A VpcConfig object that specifies the VPC that you want your training job to // connect to. Control access to and from your training container by configuring // the VPC. For more information, see Protect Training Jobs by Using an Amazon - // Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateTransformJob.go b/service/sagemaker/api_op_CreateTransformJob.go index 693019dc466..dcb504ebaa0 100644 --- a/service/sagemaker/api_op_CreateTransformJob.go +++ b/service/sagemaker/api_op_CreateTransformJob.go @@ -14,33 +14,24 @@ import ( // Starts a transform job. A transform job uses a trained model to get inferences // on a dataset and saves these results to an Amazon S3 location that you specify. // To perform batch transformations, you create a transform job and use the data -// that you have readily available. In the request body, you provide the -// following: +// that you have readily available. In the request body, you provide the following: // -// * TransformJobName - Identifies the transform job. The name must be -// unique within an Amazon Web Services Region in an Amazon Web Services -// account. +// - TransformJobName - Identifies the transform job. The name must be unique +// within an Amazon Web Services Region in an Amazon Web Services account. +// - ModelName - Identifies the model to use. ModelName must be the name of an +// existing Amazon SageMaker model in the same Amazon Web Services Region and +// Amazon Web Services account. For information on creating a model, see +// CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) +// . +// - TransformInput - Describes the dataset to be transformed and the Amazon S3 +// location where it is stored. +// - TransformOutput - Identifies the Amazon S3 location where you want Amazon +// SageMaker to save the results from the transform job. +// - TransformResources - Identifies the ML compute instances for the transform +// job. // -// * ModelName - Identifies the model to use. ModelName must be the name -// of an existing Amazon SageMaker model in the same Amazon Web Services Region and -// Amazon Web Services account. For information on creating a model, see -// CreateModel -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html). -// -// * -// TransformInput - Describes the dataset to be transformed and the Amazon S3 -// location where it is stored. -// -// * TransformOutput - Identifies the Amazon S3 -// location where you want Amazon SageMaker to save the results from the transform -// job. -// -// * TransformResources - Identifies the ML compute instances for the -// transform job. -// -// For more information about how batch transformation works, see -// Batch Transform -// (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). +// For more information about how batch transformation works, see Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html) +// . func (c *Client) CreateTransformJob(ctx context.Context, params *CreateTransformJobInput, optFns ...func(*Options)) (*CreateTransformJobOutput, error) { if params == nil { params = &CreateTransformJobInput{} @@ -58,9 +49,9 @@ func (c *Client) CreateTransformJob(ctx context.Context, params *CreateTransform type CreateTransformJobInput struct { - // The name of the model that you want to use for the transform job. ModelName must - // be the name of an existing Amazon SageMaker model within an Amazon Web Services - // Region in an Amazon Web Services account. + // The name of the model that you want to use for the transform job. ModelName + // must be the name of an existing Amazon SageMaker model within an Amazon Web + // Services Region in an Amazon Web Services account. // // This member is required. ModelName *string @@ -87,14 +78,14 @@ type CreateTransformJobInput struct { // This member is required. TransformResources *types.TransformResources - // Specifies the number of records to include in a mini-batch for an HTTP inference - // request. A record is a single unit of input data that inference can be made on. - // For example, a single line in a CSV file is a record. To enable the batch - // strategy, you must set the SplitType property to Line, RecordIO, or TFRecord. To - // use only one record when making an HTTP invocation request to a container, set - // BatchStrategy to SingleRecord and SplitType to Line. To fit as many records in a - // mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to - // MultiRecord and SplitType to Line. + // Specifies the number of records to include in a mini-batch for an HTTP + // inference request. A record is a single unit of input data that inference can be + // made on. For example, a single line in a CSV file is a record. To enable the + // batch strategy, you must set the SplitType property to Line , RecordIO , or + // TFRecord . To use only one record when making an HTTP invocation request to a + // container, set BatchStrategy to SingleRecord and SplitType to Line . To fit as + // many records in a mini-batch as can fit within the MaxPayloadInMB limit, set + // BatchStrategy to MultiRecord and SplitType to Line . BatchStrategy types.BatchStrategy // Configuration to control how SageMaker captures inference data. @@ -106,8 +97,8 @@ type CreateTransformJobInput struct { // data that is not needed for inference in a batch transform job. The output // filter provided allows you to include input data relevant to interpreting the // predictions in the output from the job. For more information, see Associate - // Prediction Results with their Corresponding Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). + // Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html) + // . DataProcessing *types.DataProcessing // The environment variables to set in the Docker container. We support up to 16 @@ -116,36 +107,31 @@ type CreateTransformJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *types.ExperimentConfig // The maximum number of parallel requests that can be sent to each instance in a // transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon // SageMaker checks the optional execution-parameters to determine the settings for // your chosen algorithm. If the execution-parameters endpoint is not enabled, the - // default value is 1. For more information on execution-parameters, see How - // Containers Serve Requests - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests). - // For built-in algorithms, you don't need to set a value for - // MaxConcurrentTransforms. + // default value is 1 . For more information on execution-parameters, see How + // Containers Serve Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests) + // . For built-in algorithms, you don't need to set a value for + // MaxConcurrentTransforms . MaxConcurrentTransforms *int32 - // The maximum allowed size of the payload, in MB. A payload is the data portion of - // a record (without metadata). The value in MaxPayloadInMB must be greater than, - // or equal to, the size of a single record. To estimate the size of a record in - // MB, divide the size of your dataset by the number of records. To ensure that the - // records fit within the maximum payload size, we recommend using a slightly + // The maximum allowed size of the payload, in MB. A payload is the data portion + // of a record (without metadata). The value in MaxPayloadInMB must be greater + // than, or equal to, the size of a single record. To estimate the size of a record + // in MB, divide the size of your dataset by the number of records. To ensure that + // the records fit within the maximum payload size, we recommend using a slightly // larger value. The default value is 6 MB. The value of MaxPayloadInMB cannot be // greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the // value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB. // For cases where the payload might be arbitrarily large and is transmitted using - // HTTP chunked encoding, set the value to 0. This feature works only in supported + // HTTP chunked encoding, set the value to 0 . This feature works only in supported // algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP // chunked encoding. MaxPayloadInMB *int32 @@ -155,8 +141,7 @@ type CreateTransformJobInput struct { ModelClientConfig *types.ModelClientConfig // (Optional) An array of key-value pairs. For more information, see Using Cost - // Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_CreateTrialComponent.go b/service/sagemaker/api_op_CreateTrialComponent.go index 53fad540d07..ecad9913476 100644 --- a/service/sagemaker/api_op_CreateTrialComponent.go +++ b/service/sagemaker/api_op_CreateTrialComponent.go @@ -12,9 +12,9 @@ import ( "time" ) -// Creates a trial component, which is a stage of a machine learning trial. A trial -// is composed of one or more trial components. A trial component can be used in -// multiple trials. Trial components include pre-processing jobs, training jobs, +// Creates a trial component, which is a stage of a machine learning trial. A +// trial is composed of one or more trial components. A trial component can be used +// in multiple trials. Trial components include pre-processing jobs, training jobs, // and batch transform jobs. When you use SageMaker Studio or the SageMaker Python // SDK, all experiments, trials, and trial components are automatically tracked, // logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), @@ -50,8 +50,8 @@ type CreateTrialComponentInput struct { // When the component ended. EndTime *time.Time - // The input artifacts for the component. Examples of input artifacts are datasets, - // algorithms, hyperparameters, source code, and instance types. + // The input artifacts for the component. Examples of input artifacts are + // datasets, algorithms, hyperparameters, source code, and instance types. InputArtifacts map[string]types.TrialComponentArtifact // Metadata properties of the tracking entity, trial, or trial component. @@ -68,17 +68,13 @@ type CreateTrialComponentInput struct { StartTime *time.Time // The status of the component. States include: - // - // * InProgress - // - // * Completed - // - // * - // Failed + // - InProgress + // - Completed + // - Failed Status *types.TrialComponentStatus - // A list of tags to associate with the component. You can use Search API to search - // on the tags. + // A list of tags to associate with the component. You can use Search API to + // search on the tags. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateUserProfile.go b/service/sagemaker/api_op_CreateUserProfile.go index ebc5ca93c86..364e5f0d24c 100644 --- a/service/sagemaker/api_op_CreateUserProfile.go +++ b/service/sagemaker/api_op_CreateUserProfile.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user profile. A user profile represents a single user within a domain, -// and is the main way to reference a "person" for the purposes of sharing, +// Creates a user profile. A user profile represents a single user within a +// domain, and is the main way to reference a "person" for the purposes of sharing, // reporting, and other user-oriented features. This entity is created when a user // onboards to Amazon SageMaker Studio. If an administrator invites a person by // email or imports them from IAM Identity Center, a user profile is automatically @@ -46,10 +46,10 @@ type CreateUserProfileInput struct { // This member is required. UserProfileName *string - // A specifier for the type of value specified in SingleSignOnUserValue. Currently, - // the only supported value is "UserName". If the Domain's AuthMode is IAM Identity - // Center, this field is required. If the Domain's AuthMode is not IAM Identity - // Center, this field cannot be specified. + // A specifier for the type of value specified in SingleSignOnUserValue. + // Currently, the only supported value is "UserName". If the Domain's AuthMode is + // IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM + // Identity Center, this field cannot be specified. SingleSignOnUserIdentifier *string // The username of the associated Amazon Web Services Single Sign-On User for this diff --git a/service/sagemaker/api_op_CreateWorkforce.go b/service/sagemaker/api_op_CreateWorkforce.go index 9fc9951facb..afe72e02b2e 100644 --- a/service/sagemaker/api_op_CreateWorkforce.go +++ b/service/sagemaker/api_op_CreateWorkforce.go @@ -11,22 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use this operation to create a workforce. This operation will return an error if -// a workforce already exists in the Amazon Web Services Region that you specify. -// You can only create one workforce in each Amazon Web Services Region per Amazon -// Web Services account. If you want to create a new workforce in an Amazon Web -// Services Region where a workforce already exists, use the API operation to -// delete the existing workforce and then use CreateWorkforce to create a new -// workforce. To create a private workforce using Amazon Cognito, you must specify -// a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito -// workforce using the Amazon SageMaker console. For more information, see Create -// a Private Workforce (Amazon Cognito) -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). -// To create a private workforce using your own OIDC Identity Provider (IdP), -// specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups +// Use this operation to create a workforce. This operation will return an error +// if a workforce already exists in the Amazon Web Services Region that you +// specify. You can only create one workforce in each Amazon Web Services Region +// per Amazon Web Services account. If you want to create a new workforce in an +// Amazon Web Services Region where a workforce already exists, use the API +// operation to delete the existing workforce and then use CreateWorkforce to +// create a new workforce. To create a private workforce using Amazon Cognito, you +// must specify a Cognito user pool in CognitoConfig . You can also create an +// Amazon Cognito workforce using the Amazon SageMaker console. For more +// information, see Create a Private Workforce (Amazon Cognito) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html) +// . To create a private workforce using your own OIDC Identity Provider (IdP), +// specify your IdP configuration in OidcConfig . Your OIDC IdP must support groups // because groups are used by Ground Truth and Amazon A2I to create work teams. For -// more information, see Create a Private Workforce (OIDC IdP) -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html). +// more information, see Create a Private Workforce (OIDC IdP) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html) +// . func (c *Client) CreateWorkforce(ctx context.Context, params *CreateWorkforceInput, optFns ...func(*Options)) (*CreateWorkforceOutput, error) { if params == nil { params = &CreateWorkforceInput{} @@ -50,21 +49,20 @@ type CreateWorkforceInput struct { WorkforceName *string // Use this parameter to configure an Amazon Cognito private workforce. A single - // Cognito workforce is created using and corresponds to a single Amazon Cognito - // user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). - // Do not use OidcConfig if you specify values for CognitoConfig. + // Cognito workforce is created using and corresponds to a single Amazon Cognito + // user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // . Do not use OidcConfig if you specify values for CognitoConfig . CognitoConfig *types.CognitoConfig - // Use this parameter to configure a private workforce using your own OIDC Identity - // Provider. Do not use CognitoConfig if you specify values for OidcConfig. + // Use this parameter to configure a private workforce using your own OIDC + // Identity Provider. Do not use CognitoConfig if you specify values for OidcConfig + // . OidcConfig *types.OidcConfig - // A list of IP address ranges (CIDRs - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Used to - // create an allow list of IP addresses for a private workforce. Workers will only - // be able to login to their worker portal from an IP address within this range. By - // default, a workforce isn't restricted to specific IP addresses. + // A list of IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // ). Used to create an allow list of IP addresses for a private workforce. Workers + // will only be able to login to their worker portal from an IP address within this + // range. By default, a workforce isn't restricted to specific IP addresses. SourceIpConfig *types.SourceIpConfig // An array of key-value pairs that contain metadata to help you categorize and diff --git a/service/sagemaker/api_op_CreateWorkteam.go b/service/sagemaker/api_op_CreateWorkteam.go index 097d9023f6d..cc0f2c7899c 100644 --- a/service/sagemaker/api_op_CreateWorkteam.go +++ b/service/sagemaker/api_op_CreateWorkteam.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new work team for labeling your data. A work team is defined by one or -// more Amazon Cognito user pools. You must first create the user pools before you -// can create a work team. You cannot create more than 25 work teams in an account -// and region. +// Creates a new work team for labeling your data. A work team is defined by one +// or more Amazon Cognito user pools. You must first create the user pools before +// you can create a work team. You cannot create more than 25 work teams in an +// account and region. func (c *Client) CreateWorkteam(ctx context.Context, params *CreateWorkteamInput, optFns ...func(*Options)) (*CreateWorkteamOutput, error) { if params == nil { params = &CreateWorkteamInput{} @@ -40,19 +40,18 @@ type CreateWorkteamInput struct { // A list of MemberDefinition objects that contains objects that identify the // workers that make up the work team. Workforces can be created using Amazon // Cognito or your own OIDC Identity Provider (IdP). For private workforces created - // using Amazon Cognito use CognitoMemberDefinition. For workforces created using - // your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide + // using Amazon Cognito use CognitoMemberDefinition . For workforces created using + // your own OIDC identity provider (IdP) use OidcMemberDefinition . Do not provide // input for both of these parameters in a single request. For workforces created // using Amazon Cognito, private work teams correspond to Amazon Cognito user // groups within the user pool used to create a workforce. All of the // CognitoMemberDefinition objects that make up the member definition must have the // same ClientId and UserPool values. To add a Amazon Cognito user group to an - // existing worker pool, see Adding groups to a User Pool. For more information - // about user pools, see Amazon Cognito User Pools - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). - // For workforces created using your own OIDC IdP, specify the user groups that you - // want to include in your private work team in OidcMemberDefinition by listing - // those groups in Groups. + // existing worker pool, see Adding groups to a User Pool . For more information + // about user pools, see Amazon Cognito User Pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // . For workforces created using your own OIDC IdP, specify the user groups that + // you want to include in your private work team in OidcMemberDefinition by + // listing those groups in Groups . // // This member is required. MemberDefinitions []types.MemberDefinition @@ -65,10 +64,8 @@ type CreateWorkteamInput struct { // Configures notification of workers regarding available or expiring work items. NotificationConfiguration *types.NotificationConfiguration - // An array of key-value pairs. For more information, see Resource Tag - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) - // and Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) + // An array of key-value pairs. For more information, see Resource Tag (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) + // and Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []types.Tag diff --git a/service/sagemaker/api_op_DeleteDomain.go b/service/sagemaker/api_op_DeleteDomain.go index ab7e93436ea..3ea23c85944 100644 --- a/service/sagemaker/api_op_DeleteDomain.go +++ b/service/sagemaker/api_op_DeleteDomain.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used to delete a domain. If you onboarded with IAM mode, you will need to delete -// your domain to onboard again using IAM Identity Center. Use with caution. All of -// the members of the domain will lose access to their EFS volume, including data, -// notebooks, and other artifacts. +// Used to delete a domain. If you onboarded with IAM mode, you will need to +// delete your domain to onboard again using IAM Identity Center. Use with caution. +// All of the members of the domain will lose access to their EFS volume, including +// data, notebooks, and other artifacts. func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} diff --git a/service/sagemaker/api_op_DeleteEndpoint.go b/service/sagemaker/api_op_DeleteEndpoint.go index 2dd8d904477..2471391c50e 100644 --- a/service/sagemaker/api_op_DeleteEndpoint.go +++ b/service/sagemaker/api_op_DeleteEndpoint.go @@ -12,14 +12,12 @@ import ( // Deletes an endpoint. SageMaker frees up all of the resources that were deployed // when the endpoint was created. SageMaker retires any custom KMS key grants -// associated with the endpoint, meaning you don't need to use the RevokeGrant -// (http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) API -// call. When you delete your endpoint, SageMaker asynchronously deletes associated -// endpoint resources such as KMS key grants. You might still see these resources -// in your account for a few minutes after deleting your endpoint. Do not delete or -// revoke the permissions for your ExecutionRoleArn -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn), -// otherwise SageMaker cannot delete these resources. +// associated with the endpoint, meaning you don't need to use the RevokeGrant (http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) +// API call. When you delete your endpoint, SageMaker asynchronously deletes +// associated endpoint resources such as KMS key grants. You might still see these +// resources in your account for a few minutes after deleting your endpoint. Do not +// delete or revoke the permissions for your ExecutionRoleArn (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn) +// , otherwise SageMaker cannot delete these resources. func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { params = &DeleteEndpointInput{} diff --git a/service/sagemaker/api_op_DeleteEndpointConfig.go b/service/sagemaker/api_op_DeleteEndpointConfig.go index 4152f7e21ee..567007ddb49 100644 --- a/service/sagemaker/api_op_DeleteEndpointConfig.go +++ b/service/sagemaker/api_op_DeleteEndpointConfig.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the -// specified configuration. It does not delete endpoints created using the +// Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only +// the specified configuration. It does not delete endpoints created using the // configuration. You must not delete an EndpointConfig in use by an endpoint that // is live or while the UpdateEndpoint or CreateEndpoint operations are being // performed on the endpoint. If you delete the EndpointConfig of an endpoint that diff --git a/service/sagemaker/api_op_DeleteFeatureGroup.go b/service/sagemaker/api_op_DeleteFeatureGroup.go index 757fd41d375..70b0b8ce03c 100644 --- a/service/sagemaker/api_op_DeleteFeatureGroup.go +++ b/service/sagemaker/api_op_DeleteFeatureGroup.go @@ -11,7 +11,7 @@ import ( ) // Delete the FeatureGroup and any data that was written to the OnlineStore of the -// FeatureGroup. Data cannot be accessed from the OnlineStore immediately after +// FeatureGroup . Data cannot be accessed from the OnlineStore immediately after // DeleteFeatureGroup is called. Data written into the OfflineStore will not be // deleted. The Amazon Web Services Glue database and tables that are automatically // created for your OfflineStore are not deleted. diff --git a/service/sagemaker/api_op_DeleteHumanTaskUi.go b/service/sagemaker/api_op_DeleteHumanTaskUi.go index 4af0a84dd29..29df9fab7c9 100644 --- a/service/sagemaker/api_op_DeleteHumanTaskUi.go +++ b/service/sagemaker/api_op_DeleteHumanTaskUi.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use this operation to delete a human task user interface (worker task template). -// To see a list of human task user interfaces (work task templates) in your -// account, use . When you delete a worker task template, it no longer appears when -// you call ListHumanTaskUis. +// Use this operation to delete a human task user interface (worker task +// template). To see a list of human task user interfaces (work task templates) in +// your account, use . When you delete a worker task template, it no longer appears +// when you call ListHumanTaskUis . func (c *Client) DeleteHumanTaskUi(ctx context.Context, params *DeleteHumanTaskUiInput, optFns ...func(*Options)) (*DeleteHumanTaskUiOutput, error) { if params == nil { params = &DeleteHumanTaskUiInput{} diff --git a/service/sagemaker/api_op_DeleteNotebookInstance.go b/service/sagemaker/api_op_DeleteNotebookInstance.go index 44aee406e23..b652f3de316 100644 --- a/service/sagemaker/api_op_DeleteNotebookInstance.go +++ b/service/sagemaker/api_op_DeleteNotebookInstance.go @@ -11,10 +11,10 @@ import ( ) // Deletes an SageMaker notebook instance. Before you can delete a notebook -// instance, you must call the StopNotebookInstance API. When you delete a notebook -// instance, you lose all of your data. SageMaker removes the ML compute instance, -// and deletes the ML storage volume and the network interface associated with the -// notebook instance. +// instance, you must call the StopNotebookInstance API. When you delete a +// notebook instance, you lose all of your data. SageMaker removes the ML compute +// instance, and deletes the ML storage volume and the network interface associated +// with the notebook instance. func (c *Client) DeleteNotebookInstance(ctx context.Context, params *DeleteNotebookInstanceInput, optFns ...func(*Options)) (*DeleteNotebookInstanceOutput, error) { if params == nil { params = &DeleteNotebookInstanceInput{} diff --git a/service/sagemaker/api_op_DeleteTrial.go b/service/sagemaker/api_op_DeleteTrial.go index 7af158e31a3..5930035f5f2 100644 --- a/service/sagemaker/api_op_DeleteTrial.go +++ b/service/sagemaker/api_op_DeleteTrial.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified trial. All trial components that make up the trial must be -// deleted first. Use the DescribeTrialComponent API to get the list of trial +// Deletes the specified trial. All trial components that make up the trial must +// be deleted first. Use the DescribeTrialComponent API to get the list of trial // components. func (c *Client) DeleteTrial(ctx context.Context, params *DeleteTrialInput, optFns ...func(*Options)) (*DeleteTrialOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_DeleteUserProfile.go b/service/sagemaker/api_op_DeleteUserProfile.go index ecaf9d40ae5..a672bbbba7a 100644 --- a/service/sagemaker/api_op_DeleteUserProfile.go +++ b/service/sagemaker/api_op_DeleteUserProfile.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a user profile. When a user profile is deleted, the user loses access to -// their EFS volume, including data, notebooks, and other artifacts. +// Deletes a user profile. When a user profile is deleted, the user loses access +// to their EFS volume, including data, notebooks, and other artifacts. func (c *Client) DeleteUserProfile(ctx context.Context, params *DeleteUserProfileInput, optFns ...func(*Options)) (*DeleteUserProfileOutput, error) { if params == nil { params = &DeleteUserProfileInput{} diff --git a/service/sagemaker/api_op_DeleteWorkteam.go b/service/sagemaker/api_op_DeleteWorkteam.go index 27580a734fe..05f24f996ee 100644 --- a/service/sagemaker/api_op_DeleteWorkteam.go +++ b/service/sagemaker/api_op_DeleteWorkteam.go @@ -38,8 +38,8 @@ type DeleteWorkteamInput struct { type DeleteWorkteamOutput struct { - // Returns true if the work team was successfully deleted; otherwise, returns - // false. + // Returns true if the work team was successfully deleted; otherwise, returns false + // . // // This member is required. Success bool diff --git a/service/sagemaker/api_op_DescribeApp.go b/service/sagemaker/api_op_DescribeApp.go index 2a0d2ad59a1..874a9a862fd 100644 --- a/service/sagemaker/api_op_DescribeApp.go +++ b/service/sagemaker/api_op_DescribeApp.go @@ -79,7 +79,7 @@ type DescribeAppOutput struct { // The timestamp of the last user's activity. LastUserActivityTimestamp is also // updated when SageMaker performs health checks without user activity. As a - // result, this value is set to the same value as LastHealthCheckTimestamp. + // result, this value is set to the same value as LastHealthCheckTimestamp . LastUserActivityTimestamp *time.Time // The instance type and the Amazon Resource Name (ARN) of the SageMaker image diff --git a/service/sagemaker/api_op_DescribeAutoMLJob.go b/service/sagemaker/api_op_DescribeAutoMLJob.go index e2a15f482e6..1f6665168d2 100644 --- a/service/sagemaker/api_op_DescribeAutoMLJob.go +++ b/service/sagemaker/api_op_DescribeAutoMLJob.go @@ -87,7 +87,7 @@ type DescribeAutoMLJobOutput struct { // This member is required. RoleArn *string - // Returns information on the job's artifacts found in AutoMLJobArtifacts. + // Returns information on the job's artifacts found in AutoMLJobArtifacts . AutoMLJobArtifacts *types.AutoMLJobArtifacts // Returns the configuration for the AutoML job. @@ -97,8 +97,7 @@ type DescribeAutoMLJobOutput struct { AutoMLJobObjective *types.AutoMLJobObjective // The best model candidate selected by SageMaker Autopilot using both the best - // objective metric and lowest InferenceLatency - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html) + // objective metric and lowest InferenceLatency (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html) // for an experiment. BestCandidate *types.AutoMLCandidate @@ -125,9 +124,9 @@ type DescribeAutoMLJobOutput struct { // Returns the job's problem type. ProblemType types.ProblemType - // Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not - // provide these values, they are auto-inferred. If you do provide them, the values - // used are the ones you provide. + // Contains ProblemType , AutoMLJobObjective , and CompletionCriteria . If you do + // not provide these values, they are auto-inferred. If you do provide them, the + // values used are the ones you provide. ResolvedAttributes *types.ResolvedAttributes // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeAutoMLJobV2.go b/service/sagemaker/api_op_DescribeAutoMLJobV2.go index 6b05bc569c6..a2544037311 100644 --- a/service/sagemaker/api_op_DescribeAutoMLJobV2.go +++ b/service/sagemaker/api_op_DescribeAutoMLJobV2.go @@ -97,8 +97,8 @@ type DescribeAutoMLJobV2Output struct { // job. AutoMLProblemTypeConfig types.AutoMLProblemTypeConfig - // Information about the candidate produced by an AutoML training job V2, including - // its status, steps, and other properties. + // Information about the candidate produced by an AutoML training job V2, + // including its status, steps, and other properties. BestCandidate *types.AutoMLCandidate // Returns the configuration settings of how the data are split into train and diff --git a/service/sagemaker/api_op_DescribeCompilationJob.go b/service/sagemaker/api_op_DescribeCompilationJob.go index f0735f52e7f..8768b5284eb 100644 --- a/service/sagemaker/api_op_DescribeCompilationJob.go +++ b/service/sagemaker/api_op_DescribeCompilationJob.go @@ -12,9 +12,9 @@ import ( "time" ) -// Returns information about a model compilation job. To create a model compilation -// job, use CreateCompilationJob. To get information about multiple model -// compilation jobs, use ListCompilationJobs. +// Returns information about a model compilation job. To create a model +// compilation job, use CreateCompilationJob . To get information about multiple +// model compilation jobs, use ListCompilationJobs . func (c *Client) DescribeCompilationJob(ctx context.Context, params *DescribeCompilationJobInput, optFns ...func(*Options)) (*DescribeCompilationJobOutput, error) { if params == nil { params = &DescribeCompilationJobInput{} @@ -79,8 +79,8 @@ type DescribeCompilationJobOutput struct { // This member is required. LastModifiedTime *time.Time - // Information about the location in Amazon S3 that has been configured for storing - // the model artifacts used in the compilation job. + // Information about the location in Amazon S3 that has been configured for + // storing the model artifacts used in the compilation job. // // This member is required. ModelArtifacts *types.ModelArtifacts @@ -104,8 +104,8 @@ type DescribeCompilationJobOutput struct { // This member is required. StoppingCondition *types.StoppingCondition - // The time when the model compilation job on a compilation job instance ended. For - // a successful or stopped job, this is when the job's model artifacts have + // The time when the model compilation job on a compilation job instance ended. + // For a successful or stopped job, this is when the job's model artifacts have // finished uploading. For a failed job, this is when Amazon SageMaker detected // that the job failed. CompilationEndTime *time.Time @@ -133,7 +133,7 @@ type DescribeCompilationJobOutput struct { // A VpcConfig object that specifies the VPC that you want your compilation job to // connect to. Control access to your models by configuring the VPC. For more // information, see Protect Compilation Jobs by Using an Amazon Virtual Private - // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). + // Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html) . VpcConfig *types.NeoVpcConfig // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeDomain.go b/service/sagemaker/api_op_DescribeDomain.go index c8d37d2e1be..e01805cf926 100644 --- a/service/sagemaker/api_op_DescribeDomain.go +++ b/service/sagemaker/api_op_DescribeDomain.go @@ -41,20 +41,16 @@ type DescribeDomainInput struct { type DescribeDomainOutput struct { // Specifies the VPC used for non-EFS traffic. The default value is - // PublicInternetOnly. - // - // * PublicInternetOnly - Non-EFS traffic is through a VPC - // managed by Amazon SageMaker, which allows direct internet access - // - // * VpcOnly - - // All Studio traffic is through the specified VPC and subnets + // PublicInternetOnly . + // - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon + // SageMaker, which allows direct internet access + // - VpcOnly - All Studio traffic is through the specified VPC and subnets AppNetworkAccessType types.AppNetworkAccessType // The entity that creates and manages the required security groups for inter-app // communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType // is VPCOnly and - // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is - // provided. + // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. AppSecurityGroupManagement types.AppSecurityGroupManagement // The domain's authentication mode. @@ -88,7 +84,7 @@ type DescribeDomainOutput struct { // The ID of the Amazon Elastic File System (EFS) managed by this Domain. HomeEfsFileSystemId *string - // Use KmsKeyId. + // Use KmsKeyId . // // Deprecated: This property is deprecated, use KmsKeyId instead. HomeEfsFileSystemKmsKeyId *string diff --git a/service/sagemaker/api_op_DescribeEndpoint.go b/service/sagemaker/api_op_DescribeEndpoint.go index 067b4c162de..85d613830cc 100644 --- a/service/sagemaker/api_op_DescribeEndpoint.go +++ b/service/sagemaker/api_op_DescribeEndpoint.go @@ -67,38 +67,27 @@ type DescribeEndpointOutput struct { EndpointName *string // The status of the endpoint. - // - // * OutOfService: Endpoint is not available to take - // incoming requests. - // - // * Creating: CreateEndpoint is executing. - // - // * Updating: - // UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. - // - // * - // SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or - // deleted or re-scaled until it has completed. This maintenance operation does not - // change any customer-specified values such as VPC config, KMS encryption, model, - // instance type, or instance count. - // - // * RollingBack: Endpoint fails to scale up or - // down or change its variant weight and is in the process of rolling back to its - // previous configuration. Once the rollback completes, endpoint returns to an - // InService status. This transitional status only applies to an endpoint that has - // autoscaling enabled and is undergoing variant weight or capacity changes as part - // of an UpdateEndpointWeightsAndCapacities call or when the - // UpdateEndpointWeightsAndCapacities operation is called explicitly. - // - // * InService: - // Endpoint is available to process incoming requests. - // - // * Deleting: DeleteEndpoint - // is executing. - // - // * Failed: Endpoint could not be created, updated, or re-scaled. - // Use DescribeEndpointOutput$FailureReason for information about the failure. - // DeleteEndpoint is the only operation that can be performed on a failed endpoint. + // - OutOfService : Endpoint is not available to take incoming requests. + // - Creating : CreateEndpoint is executing. + // - Updating : UpdateEndpoint or UpdateEndpointWeightsAndCapacities is + // executing. + // - SystemUpdating : Endpoint is undergoing maintenance and cannot be updated or + // deleted or re-scaled until it has completed. This maintenance operation does not + // change any customer-specified values such as VPC config, KMS encryption, model, + // instance type, or instance count. + // - RollingBack : Endpoint fails to scale up or down or change its variant + // weight and is in the process of rolling back to its previous configuration. Once + // the rollback completes, endpoint returns to an InService status. This + // transitional status only applies to an endpoint that has autoscaling enabled and + // is undergoing variant weight or capacity changes as part of an + // UpdateEndpointWeightsAndCapacities call or when the + // UpdateEndpointWeightsAndCapacities operation is called explicitly. + // - InService : Endpoint is available to process incoming requests. + // - Deleting : DeleteEndpoint is executing. + // - Failed : Endpoint could not be created, updated, or re-scaled. Use + // DescribeEndpointOutput$FailureReason for information about the failure. + // DeleteEndpoint is the only operation that can be performed on a failed + // endpoint. // // This member is required. EndpointStatus types.EndpointStatus @@ -109,8 +98,7 @@ type DescribeEndpointOutput struct { LastModifiedTime *time.Time // Returns the description of an endpoint configuration created using the - // CreateEndpointConfig - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) + // CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) // API. AsyncInferenceConfig *types.AsyncInferenceConfig @@ -120,7 +108,7 @@ type DescribeEndpointOutput struct { // The configuration parameters for an explainer. ExplainerConfig *types.ExplainerConfig - // If the status of the endpoint is Failed, the reason why it failed. + // If the status of the endpoint is Failed , the reason why it failed. FailureReason *string // The most recent deployment configuration for the endpoint. @@ -136,7 +124,7 @@ type DescribeEndpointOutput struct { // An array of ProductionVariantSummary objects, one for each model that you want // to host at this endpoint in shadow mode with production traffic replicated from - // the model specified on ProductionVariants. + // the model specified on ProductionVariants . ShadowProductionVariants []types.ProductionVariantSummary // Metadata pertaining to the operation's result. @@ -229,9 +217,9 @@ type EndpointDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EndpointDeletedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EndpointDeletedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -271,9 +259,9 @@ func NewEndpointDeletedWaiter(client DescribeEndpointAPIClient, optFns ...func(* } } -// Wait calls the waiter function for EndpointDeleted waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for EndpointDeleted waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *EndpointDeletedWaiter) Wait(ctx context.Context, params *DescribeEndpointInput, maxWaitDur time.Duration, optFns ...func(*EndpointDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -401,9 +389,9 @@ type EndpointInServiceWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, EndpointInServiceWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, EndpointInServiceWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -451,10 +439,10 @@ func (w *EndpointInServiceWaiter) Wait(ctx context.Context, params *DescribeEndp return err } -// WaitForOutput calls the waiter function for EndpointInService waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for EndpointInService waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *EndpointInServiceWaiter) WaitForOutput(ctx context.Context, params *DescribeEndpointInput, maxWaitDur time.Duration, optFns ...func(*EndpointInServiceWaiterOptions)) (*DescribeEndpointOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/sagemaker/api_op_DescribeEndpointConfig.go b/service/sagemaker/api_op_DescribeEndpointConfig.go index 8b940cee26f..ba4bd7f620e 100644 --- a/service/sagemaker/api_op_DescribeEndpointConfig.go +++ b/service/sagemaker/api_op_DescribeEndpointConfig.go @@ -63,8 +63,7 @@ type DescribeEndpointConfigOutput struct { ProductionVariants []types.ProductionVariant // Returns the description of an endpoint configuration created using the - // CreateEndpointConfig - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) + // CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) // API. AsyncInferenceConfig *types.AsyncInferenceConfig @@ -80,7 +79,7 @@ type DescribeEndpointConfigOutput struct { // An array of ProductionVariant objects, one for each model that you want to host // at this endpoint in shadow mode with production traffic replicated from the - // model specified on ProductionVariants. + // model specified on ProductionVariants . ShadowProductionVariants []types.ProductionVariant // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeFeatureGroup.go b/service/sagemaker/api_op_DescribeFeatureGroup.go index f0650ecbfa3..30aca587e63 100644 --- a/service/sagemaker/api_op_DescribeFeatureGroup.go +++ b/service/sagemaker/api_op_DescribeFeatureGroup.go @@ -12,9 +12,9 @@ import ( "time" ) -// Use this operation to describe a FeatureGroup. The response includes information -// on the creation time, FeatureGroup name, the unique identifier for each -// FeatureGroup, and more. +// Use this operation to describe a FeatureGroup . The response includes +// information on the creation time, FeatureGroup name, the unique identifier for +// each FeatureGroup , and more. func (c *Client) DescribeFeatureGroup(ctx context.Context, params *DescribeFeatureGroupInput, optFns ...func(*Options)) (*DescribeFeatureGroupOutput, error) { if params == nil { params = &DescribeFeatureGroupInput{} @@ -37,8 +37,8 @@ type DescribeFeatureGroupInput struct { // This member is required. FeatureGroupName *string - // A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 - // Features are returned by default. + // A token to resume pagination of the list of Features ( FeatureDefinitions ). + // 2,500 Features are returned by default. NextToken *string noSmithyDocumentSerde @@ -46,41 +46,41 @@ type DescribeFeatureGroupInput struct { type DescribeFeatureGroupOutput struct { - // A timestamp indicating when SageMaker created the FeatureGroup. + // A timestamp indicating when SageMaker created the FeatureGroup . // // This member is required. CreationTime *time.Time - // The name of the feature that stores the EventTime of a Record in a FeatureGroup. - // An EventTime is a point in time when a new event occurs that corresponds to the - // creation or update of a Record in a FeatureGroup. All Records in the - // FeatureGroup have a corresponding EventTime. + // The name of the feature that stores the EventTime of a Record in a FeatureGroup + // . An EventTime is a point in time when a new event occurs that corresponds to + // the creation or update of a Record in a FeatureGroup . All Records in the + // FeatureGroup have a corresponding EventTime . // // This member is required. EventTimeFeatureName *string - // A list of the Features in the FeatureGroup. Each feature is defined by a - // FeatureName and FeatureType. + // A list of the Features in the FeatureGroup . Each feature is defined by a + // FeatureName and FeatureType . // // This member is required. FeatureDefinitions []types.FeatureDefinition - // The Amazon Resource Name (ARN) of the FeatureGroup. + // The Amazon Resource Name (ARN) of the FeatureGroup . // // This member is required. FeatureGroupArn *string - // he name of the FeatureGroup. + // he name of the FeatureGroup . // // This member is required. FeatureGroupName *string - // A token to resume pagination of the list of Features (FeatureDefinitions). + // A token to resume pagination of the list of Features ( FeatureDefinitions ). // // This member is required. NextToken *string - // The name of the Feature used for RecordIdentifier, whose value uniquely + // The name of the Feature used for RecordIdentifier , whose value uniquely // identifies a record stored in the feature store. // // This member is required. @@ -89,14 +89,10 @@ type DescribeFeatureGroupOutput struct { // A free form description of the feature group. Description *string - // The reason that the FeatureGroup failed to be replicated in the OfflineStore. + // The reason that the FeatureGroup failed to be replicated in the OfflineStore . // This is failure can occur because: - // - // * The FeatureGroup could not be created in - // the OfflineStore. - // - // * The FeatureGroup could not be deleted from the - // OfflineStore. + // - The FeatureGroup could not be created in the OfflineStore . + // - The FeatureGroup could not be deleted from the OfflineStore . FailureReason *string // The status of the feature group. @@ -110,26 +106,19 @@ type DescribeFeatureGroupOutput struct { // The configuration of the offline store. It includes the following // configurations: - // - // * Amazon S3 location of the offline store. - // - // * Configuration of - // the Glue data catalog. - // - // * Table format of the offline store. - // - // * Option to - // disable the automatic creation of a Glue table for the offline store. - // - // * - // Encryption configuration. + // - Amazon S3 location of the offline store. + // - Configuration of the Glue data catalog. + // - Table format of the offline store. + // - Option to disable the automatic creation of a Glue table for the offline + // store. + // - Encryption configuration. OfflineStoreConfig *types.OfflineStoreConfig - // The status of the OfflineStore. Notifies you if replicating data into the + // The status of the OfflineStore . Notifies you if replicating data into the // OfflineStore has failed. Returns either: Active or Blocked OfflineStoreStatus *types.OfflineStoreStatus - // The configuration for the OnlineStore. + // The configuration for the OnlineStore . OnlineStoreConfig *types.OnlineStoreConfig // The size of the OnlineStore in bytes. diff --git a/service/sagemaker/api_op_DescribeFeatureMetadata.go b/service/sagemaker/api_op_DescribeFeatureMetadata.go index 9ea96f66c2e..bced58f88d1 100644 --- a/service/sagemaker/api_op_DescribeFeatureMetadata.go +++ b/service/sagemaker/api_op_DescribeFeatureMetadata.go @@ -70,9 +70,9 @@ type DescribeFeatureMetadataOutput struct { // This member is required. FeatureType types.FeatureType - // A timestamp indicating when the metadata for the feature group was modified. For - // example, if you add a parameter describing the feature, the timestamp changes to - // reflect the last time you + // A timestamp indicating when the metadata for the feature group was modified. + // For example, if you add a parameter describing the feature, the timestamp + // changes to reflect the last time you // // This member is required. LastModifiedTime *time.Time diff --git a/service/sagemaker/api_op_DescribeFlowDefinition.go b/service/sagemaker/api_op_DescribeFlowDefinition.go index 5df0385a599..fb751cdd680 100644 --- a/service/sagemaker/api_op_DescribeFlowDefinition.go +++ b/service/sagemaker/api_op_DescribeFlowDefinition.go @@ -60,8 +60,8 @@ type DescribeFlowDefinitionOutput struct { // This member is required. FlowDefinitionStatus types.FlowDefinitionStatus - // An object containing information about who works on the task, the workforce task - // price, and other task details. + // An object containing information about who works on the task, the workforce + // task price, and other task details. // // This member is required. HumanLoopConfig *types.HumanLoopConfig diff --git a/service/sagemaker/api_op_DescribeHubContent.go b/service/sagemaker/api_op_DescribeHubContent.go index ae86fdf13fe..06a819c0cf5 100644 --- a/service/sagemaker/api_op_DescribeHubContent.go +++ b/service/sagemaker/api_op_DescribeHubContent.go @@ -118,8 +118,8 @@ type DescribeHubContentOutput struct { // The display name of the hub content. HubContentDisplayName *string - // A string that provides a description of the hub content. This string can include - // links, tables, and standard markdown formating. + // A string that provides a description of the hub content. This string can + // include links, tables, and standard markdown formating. HubContentMarkdown *string // The searchable keywords for the hub content. diff --git a/service/sagemaker/api_op_DescribeHumanTaskUi.go b/service/sagemaker/api_op_DescribeHumanTaskUi.go index 7a8f8343c70..c828b6eb5b4 100644 --- a/service/sagemaker/api_op_DescribeHumanTaskUi.go +++ b/service/sagemaker/api_op_DescribeHumanTaskUi.go @@ -63,8 +63,8 @@ type DescribeHumanTaskUiOutput struct { // This member is required. UiTemplate *types.UiTemplateInfo - // The status of the human task user interface (worker task template). Valid values - // are listed below. + // The status of the human task user interface (worker task template). Valid + // values are listed below. HumanTaskUiStatus types.HumanTaskUiStatus // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go index 3afb3c261d0..def82d9870f 100644 --- a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go @@ -50,8 +50,8 @@ type DescribeHyperParameterTuningJobOutput struct { // This member is required. HyperParameterTuningJobArn *string - // The HyperParameterTuningJobConfig object that specifies the configuration of the - // tuning job. + // The HyperParameterTuningJobConfig object that specifies the configuration of + // the tuning job. // // This member is required. HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig @@ -74,14 +74,14 @@ type DescribeHyperParameterTuningJobOutput struct { // This member is required. ObjectiveStatusCounters *types.ObjectiveStatusCounters - // The TrainingJobStatusCounters object that specifies the number of training jobs, - // categorized by status, that this tuning job launched. + // The TrainingJobStatusCounters object that specifies the number of training + // jobs, categorized by status, that this tuning job launched. // // This member is required. TrainingJobStatusCounters *types.TrainingJobStatusCounters // A TrainingJobSummary object that describes the training job that completed with - // the best current HyperParameterTuningJobObjective. + // the best current HyperParameterTuningJobObjective . BestTrainingJob *types.HyperParameterTrainingJobSummary // The total resources consumed by your hyperparameter tuning job. @@ -97,7 +97,7 @@ type DescribeHyperParameterTuningJobOutput struct { LastModifiedTime *time.Time // If the hyperparameter tuning job is an warm start tuning job with a - // WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary + // WarmStartType of IDENTICAL_DATA_AND_ALGORITHM , this is the TrainingJobSummary // for the training job with the best objective metric value of all training jobs // launched by this tuning job and all parent jobs specified for the warm start // tuning job. @@ -111,16 +111,16 @@ type DescribeHyperParameterTuningJobOutput struct { // tuning job. TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition - // Tuning job completion information returned as the response from a hyperparameter - // tuning job. This information tells if your tuning job has or has not converged. - // It also includes the number of training jobs that have not improved model - // performance as evaluated against the objective function. + // Tuning job completion information returned as the response from a + // hyperparameter tuning job. This information tells if your tuning job has or has + // not converged. It also includes the number of training jobs that have not + // improved model performance as evaluated against the objective function. TuningJobCompletionDetails *types.HyperParameterTuningJobCompletionDetails - // The configuration for starting the hyperparameter parameter tuning job using one - // or more previous tuning jobs as a starting point. The results of previous tuning - // jobs are used to inform which combinations of hyperparameters to search over in - // the new tuning job. + // The configuration for starting the hyperparameter parameter tuning job using + // one or more previous tuning jobs as a starting point. The results of previous + // tuning jobs are used to inform which combinations of hyperparameters to search + // over in the new tuning job. WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeImage.go b/service/sagemaker/api_op_DescribeImage.go index fa5c45ad4b7..d2773bc23ef 100644 --- a/service/sagemaker/api_op_DescribeImage.go +++ b/service/sagemaker/api_op_DescribeImage.go @@ -163,9 +163,9 @@ type ImageCreatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageCreatedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageCreatedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -351,9 +351,9 @@ type ImageDeletedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageDeletedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageDeletedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -534,9 +534,9 @@ type ImageUpdatedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageUpdatedWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageUpdatedWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/sagemaker/api_op_DescribeImageVersion.go b/service/sagemaker/api_op_DescribeImageVersion.go index 704495605f7..d9995f33622 100644 --- a/service/sagemaker/api_op_DescribeImageVersion.go +++ b/service/sagemaker/api_op_DescribeImageVersion.go @@ -77,15 +77,10 @@ type DescribeImageVersionOutput struct { ImageVersionStatus types.ImageVersionStatus // Indicates SageMaker job type compatibility. - // - // * TRAINING: The image version is - // compatible with SageMaker training jobs. - // - // * INFERENCE: The image version is - // compatible with SageMaker inference jobs. - // - // * NOTEBOOK_KERNEL: The image version - // is compatible with SageMaker notebook kernels. + // - TRAINING : The image version is compatible with SageMaker training jobs. + // - INFERENCE : The image version is compatible with SageMaker inference jobs. + // - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook + // kernels. JobType types.JobType // When the version was last modified. @@ -95,11 +90,8 @@ type DescribeImageVersionOutput struct { MLFramework *string // Indicates CPU or GPU compatibility. - // - // * CPU: The image version is compatible with - // CPU. - // - // * GPU: The image version is compatible with GPU. + // - CPU : The image version is compatible with CPU. + // - GPU : The image version is compatible with GPU. Processor types.Processor // The supported programming language and its version. @@ -109,19 +101,14 @@ type DescribeImageVersionOutput struct { ReleaseNotes *string // The stability of the image version specified by the maintainer. - // - // * NOT_PROVIDED: - // The maintainers did not provide a status for image version stability. - // - // * STABLE: - // The image version is stable. - // - // * TO_BE_ARCHIVED: The image version is set to be - // archived. Custom image versions that are set to be archived are automatically - // archived after three months. - // - // * ARCHIVED: The image version is archived. - // Archived image versions are not searchable and are no longer actively supported. + // - NOT_PROVIDED : The maintainers did not provide a status for image version + // stability. + // - STABLE : The image version is stable. + // - TO_BE_ARCHIVED : The image version is set to be archived. Custom image + // versions that are set to be archived are automatically archived after three + // months. + // - ARCHIVED : The image version is archived. Archived image versions are not + // searchable and are no longer actively supported. VendorGuidance types.VendorGuidance // The version number. @@ -218,9 +205,10 @@ type ImageVersionCreatedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageVersionCreatedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageVersionCreatedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -260,9 +248,9 @@ func NewImageVersionCreatedWaiter(client DescribeImageVersionAPIClient, optFns . } } -// Wait calls the waiter function for ImageVersionCreated waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ImageVersionCreated waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ImageVersionCreatedWaiter) Wait(ctx context.Context, params *DescribeImageVersionInput, maxWaitDur time.Duration, optFns ...func(*ImageVersionCreatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err @@ -408,9 +396,10 @@ type ImageVersionDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ImageVersionDeletedWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ImageVersionDeletedWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -450,9 +439,9 @@ func NewImageVersionDeletedWaiter(client DescribeImageVersionAPIClient, optFns . } } -// Wait calls the waiter function for ImageVersionDeleted waiter. The maxWaitDur is -// the maximum wait duration the waiter will wait. The maxWaitDur is required and -// must be greater than zero. +// Wait calls the waiter function for ImageVersionDeleted waiter. The maxWaitDur +// is the maximum wait duration the waiter will wait. The maxWaitDur is required +// and must be greater than zero. func (w *ImageVersionDeletedWaiter) Wait(ctx context.Context, params *DescribeImageVersionInput, maxWaitDur time.Duration, optFns ...func(*ImageVersionDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/sagemaker/api_op_DescribeInferenceExperiment.go b/service/sagemaker/api_op_DescribeInferenceExperiment.go index 4f3cbc23ca9..64848e879ef 100644 --- a/service/sagemaker/api_op_DescribeInferenceExperiment.go +++ b/service/sagemaker/api_op_DescribeInferenceExperiment.go @@ -65,30 +65,18 @@ type DescribeInferenceExperimentOutput struct { // The status of the inference experiment. The following are the possible statuses // for an inference experiment: - // - // * Creating - Amazon SageMaker is creating your - // experiment. - // - // * Created - Amazon SageMaker has finished the creation of your - // experiment and will begin the experiment at the scheduled time. - // - // * Updating - - // When you make changes to your experiment, your experiment shows as updating. - // - // * - // Starting - Amazon SageMaker is beginning your experiment. - // - // * Running - Your - // experiment is in progress. - // - // * Stopping - Amazon SageMaker is stopping your - // experiment. - // - // * Completed - Your experiment has completed. - // - // * Cancelled - When - // you conclude your experiment early using the StopInferenceExperiment API, or if - // any operation fails with an unexpected error, it shows as cancelled. + // - Creating - Amazon SageMaker is creating your experiment. + // - Created - Amazon SageMaker has finished the creation of your experiment and + // will begin the experiment at the scheduled time. + // - Updating - When you make changes to your experiment, your experiment shows + // as updating. + // - Starting - Amazon SageMaker is beginning your experiment. + // - Running - Your experiment is in progress. + // - Stopping - Amazon SageMaker is stopping your experiment. + // - Completed - Your experiment has completed. + // - Cancelled - When you conclude your experiment early using the + // StopInferenceExperiment API, or if any operation fails with an unexpected + // error, it shows as cancelled. // // This member is required. Status types.InferenceExperimentStatus @@ -114,7 +102,7 @@ type DescribeInferenceExperimentOutput struct { // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key // that Amazon SageMaker uses to encrypt data on the storage volume attached to the // ML compute instance that hosts the endpoint. For more information, see - // CreateInferenceExperimentRequest$KmsKey. + // CreateInferenceExperimentRequest$KmsKey . KmsKey *string // The timestamp at which you last modified the inference experiment. diff --git a/service/sagemaker/api_op_DescribeInferenceRecommendationsJob.go b/service/sagemaker/api_op_DescribeInferenceRecommendationsJob.go index ef426224f98..596ef80870d 100644 --- a/service/sagemaker/api_op_DescribeInferenceRecommendationsJob.go +++ b/service/sagemaker/api_op_DescribeInferenceRecommendationsJob.go @@ -89,8 +89,8 @@ type DescribeInferenceRecommendationsJobOutput struct { // A timestamp that shows when the job completed. CompletionTime *time.Time - // The performance results from running an Inference Recommender job on an existing - // endpoint. + // The performance results from running an Inference Recommender job on an + // existing endpoint. EndpointPerformances []types.EndpointPerformance // If the job fails, provides information why the job failed. diff --git a/service/sagemaker/api_op_DescribeLabelingJob.go b/service/sagemaker/api_op_DescribeLabelingJob.go index d531fb6d924..762c29634f5 100644 --- a/service/sagemaker/api_op_DescribeLabelingJob.go +++ b/service/sagemaker/api_op_DescribeLabelingJob.go @@ -63,9 +63,9 @@ type DescribeLabelingJobOutput struct { // This member is required. JobReferenceCode *string - // Provides a breakdown of the number of data objects labeled by humans, the number - // of objects labeled by machine, the number of objects than couldn't be labeled, - // and the total number of objects labeled. + // Provides a breakdown of the number of data objects labeled by humans, the + // number of objects labeled by machine, the number of objects than couldn't be + // labeled, and the total number of objects labeled. // // This member is required. LabelCounters *types.LabelCounters @@ -90,8 +90,8 @@ type DescribeLabelingJobOutput struct { // This member is required. LastModifiedTime *time.Time - // The location of the job's output data and the Amazon Web Services Key Management - // Service key ID for the key used to encrypt the output data, if any. + // The location of the job's output data and the Amazon Web Services Key + // Management Service key ID for the key used to encrypt the output data, if any. // // This member is required. OutputConfig *types.LabelingJobOutputConfig @@ -110,23 +110,16 @@ type DescribeLabelingJobOutput struct { // The S3 location of the JSON file that defines the categories used to label data // objects. Please note the following label-category limits: - // - // * Semantic - // segmentation labeling jobs using automated labeling: 20 labels - // - // * Box bounding - // labeling jobs (all): 10 labels - // - // The file is a JSON structure in the following - // format: { + // - Semantic segmentation labeling jobs using automated labeling: 20 labels + // - Box bounding labeling jobs (all): 10 labels + // The file is a JSON structure in the following format: { // "document-version": "2018-11-28" // // "labels": [ // // { // - // - // "label": "label 1" + // "label": "label 1" // // }, // @@ -138,8 +131,7 @@ type DescribeLabelingJobOutput struct { // // ... // - // - // { + // { // // "label": "label n" // @@ -162,8 +154,8 @@ type DescribeLabelingJobOutput struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeLineageGroup.go b/service/sagemaker/api_op_DescribeLineageGroup.go index d7280185fea..8eae20fffa1 100644 --- a/service/sagemaker/api_op_DescribeLineageGroup.go +++ b/service/sagemaker/api_op_DescribeLineageGroup.go @@ -13,8 +13,7 @@ import ( ) // Provides a list of properties for the requested lineage group. For more -// information, see Cross-Account Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) +// information, see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) // in the Amazon SageMaker Developer Guide. func (c *Client) DescribeLineageGroup(ctx context.Context, params *DescribeLineageGroupInput, optFns ...func(*Options)) (*DescribeLineageGroupOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_DescribeModel.go b/service/sagemaker/api_op_DescribeModel.go index c1b1eb93605..b4b1c84b526 100644 --- a/service/sagemaker/api_op_DescribeModel.go +++ b/service/sagemaker/api_op_DescribeModel.go @@ -63,7 +63,7 @@ type DescribeModelOutput struct { // The containers in the inference pipeline. Containers []types.ContainerDefinition - // If True, no inbound or outbound network calls can be made to or from the model + // If True , no inbound or outbound network calls can be made to or from the model // container. EnableNetworkIsolation bool @@ -75,8 +75,7 @@ type DescribeModelOutput struct { PrimaryContainer *types.ContainerDefinition // A VpcConfig object that specifies the VPC that this model has access to. For - // more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) + // more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) VpcConfig *types.VpcConfig // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeModelCard.go b/service/sagemaker/api_op_DescribeModelCard.go index ce1986d4d26..4318fe1beae 100644 --- a/service/sagemaker/api_op_DescribeModelCard.go +++ b/service/sagemaker/api_op_DescribeModelCard.go @@ -72,19 +72,12 @@ type DescribeModelCardOutput struct { ModelCardName *string // The approval status of the model card within your organization. Different - // organizations might have different criteria for model card review and - // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // organizations might have different criteria for model card review and approval. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. // // This member is required. ModelCardStatus types.ModelCardStatus @@ -103,23 +96,12 @@ type DescribeModelCardOutput struct { // The processing status of model card deletion. The ModelCardProcessingStatus // updates throughout the different deletion steps. - // - // * DeletePending: Model card - // deletion request received. - // - // * DeleteInProgress: Model card deletion is in - // progress. - // - // * ContentDeleted: Deleted model card content. - // - // * ExportJobsDeleted: - // Deleted all export jobs associated with the model card. - // - // * DeleteCompleted: - // Successfully deleted the model card. - // - // * DeleteFailed: The model card failed to - // delete. + // - DeletePending : Model card deletion request received. + // - DeleteInProgress : Model card deletion is in progress. + // - ContentDeleted : Deleted model card content. + // - ExportJobsDeleted : Deleted all export jobs associated with the model card. + // - DeleteCompleted : Successfully deleted the model card. + // - DeleteFailed : The model card failed to delete. ModelCardProcessingStatus types.ModelCardProcessingStatus // The security configuration used to protect model card content. diff --git a/service/sagemaker/api_op_DescribeModelCardExportJob.go b/service/sagemaker/api_op_DescribeModelCardExportJob.go index e4dd6289e4e..43795f43492 100644 --- a/service/sagemaker/api_op_DescribeModelCardExportJob.go +++ b/service/sagemaker/api_op_DescribeModelCardExportJob.go @@ -76,16 +76,11 @@ type DescribeModelCardExportJobOutput struct { OutputConfig *types.ModelCardExportOutputConfig // The completion status of the model card export job. - // - // * InProgress: The model - // card export job is in progress. - // - // * Completed: The model card export job is - // complete. - // - // * Failed: The model card export job failed. To see the reason for the - // failure, see the FailureReason field in the response to a - // DescribeModelCardExportJob call. + // - InProgress : The model card export job is in progress. + // - Completed : The model card export job is complete. + // - Failed : The model card export job failed. To see the reason for the + // failure, see the FailureReason field in the response to a + // DescribeModelCardExportJob call. // // This member is required. Status types.ModelCardExportJobStatus diff --git a/service/sagemaker/api_op_DescribeModelExplainabilityJobDefinition.go b/service/sagemaker/api_op_DescribeModelExplainabilityJobDefinition.go index 9c720594296..445123f9ee3 100644 --- a/service/sagemaker/api_op_DescribeModelExplainabilityJobDefinition.go +++ b/service/sagemaker/api_op_DescribeModelExplainabilityJobDefinition.go @@ -51,8 +51,8 @@ type DescribeModelExplainabilityJobDefinitionOutput struct { // This member is required. JobDefinitionArn *string - // The name of the explainability job definition. The name must be unique within an - // Amazon Web Services Region in the Amazon Web Services account. + // The name of the explainability job definition. The name must be unique within + // an Amazon Web Services Region in the Amazon Web Services account. // // This member is required. JobDefinitionName *string diff --git a/service/sagemaker/api_op_DescribeModelPackage.go b/service/sagemaker/api_op_DescribeModelPackage.go index b81aa36d5c4..f6993c99860 100644 --- a/service/sagemaker/api_op_DescribeModelPackage.go +++ b/service/sagemaker/api_op_DescribeModelPackage.go @@ -96,8 +96,7 @@ type DescribeModelPackageOutput struct { // Represents the drift check baselines that can be used when the model monitor is // set using the model package. For more information, see the topic on Drift - // Detection against Previous Baselines in SageMaker Pipelines - // (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) + // Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection) // in the Amazon SageMaker Developer Guide. DriftCheckBaselines *types.DriftCheckBaselines diff --git a/service/sagemaker/api_op_DescribeModelQualityJobDefinition.go b/service/sagemaker/api_op_DescribeModelQualityJobDefinition.go index 09ed6f0c450..fd655656bcc 100644 --- a/service/sagemaker/api_op_DescribeModelQualityJobDefinition.go +++ b/service/sagemaker/api_op_DescribeModelQualityJobDefinition.go @@ -51,8 +51,8 @@ type DescribeModelQualityJobDefinitionOutput struct { // This member is required. JobDefinitionArn *string - // The name of the quality job definition. The name must be unique within an Amazon - // Web Services Region in the Amazon Web Services account. + // The name of the quality job definition. The name must be unique within an + // Amazon Web Services Region in the Amazon Web Services account. // // This member is required. JobDefinitionName *string diff --git a/service/sagemaker/api_op_DescribeMonitoringSchedule.go b/service/sagemaker/api_op_DescribeMonitoringSchedule.go index d510528d3be..d54ea7c197d 100644 --- a/service/sagemaker/api_op_DescribeMonitoringSchedule.go +++ b/service/sagemaker/api_op_DescribeMonitoringSchedule.go @@ -83,17 +83,10 @@ type DescribeMonitoringScheduleOutput struct { // The type of the monitoring job that this schedule runs. This is one of the // following values. - // - // * DATA_QUALITY - The schedule is for a data quality - // monitoring job. - // - // * MODEL_QUALITY - The schedule is for a model quality - // monitoring job. - // - // * MODEL_BIAS - The schedule is for a bias monitoring job. - // - // * - // MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job. + // - DATA_QUALITY - The schedule is for a data quality monitoring job. + // - MODEL_QUALITY - The schedule is for a model quality monitoring job. + // - MODEL_BIAS - The schedule is for a bias monitoring job. + // - MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job. MonitoringType types.MonitoringType // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeNotebookInstance.go b/service/sagemaker/api_op_DescribeNotebookInstance.go index 5e5718c2022..29fff3f16c8 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstance.go +++ b/service/sagemaker/api_op_DescribeNotebookInstance.go @@ -49,17 +49,16 @@ type DescribeNotebookInstanceOutput struct { // A list of the Elastic Inference (EI) instance types associated with this // notebook instance. Currently only one EI instance type can be associated with a // notebook instance. For more information, see Using Elastic Inference in Amazon - // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) . AcceleratorTypes []types.NotebookInstanceAcceleratorType // An array of up to three Git repositories associated with the notebook instance. // These can be either the names of Git repositories stored as resources in your - // account, or the URL of Git repositories in Amazon Web Services CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // account, or the URL of Git repositories in Amazon Web Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. These repositories are cloned at the same level + // as the default repository of your notebook instance. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . AdditionalCodeRepositories []string // A timestamp. Use this parameter to return the time when the notebook instance @@ -69,22 +68,21 @@ type DescribeNotebookInstanceOutput struct { // The Git repository associated with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource // in your account, or the URL of a Git repository in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. When you open a notebook instance, it opens in + // the directory that contains this repository. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . DefaultCodeRepository *string // Describes whether SageMaker provides internet access to the notebook instance. // If this value is set to Disabled, the notebook instance does not have internet // access, and cannot connect to SageMaker training and endpoint services. For more - // information, see Notebook Instances Are Internet-Enabled by Default - // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). + // information, see Notebook Instances Are Internet-Enabled by Default (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access) + // . DirectInternetAccess types.DirectInternetAccess - // If status is Failed, the reason it failed. + // If status is Failed , the reason it failed. FailureReason *string // Information on the IMDS configuration of the notebook instance @@ -108,10 +106,9 @@ type DescribeNotebookInstanceOutput struct { // The Amazon Resource Name (ARN) of the notebook instance. NotebookInstanceArn *string - // Returns the name of a notebook instance lifecycle configuration. For information - // about notebook instance lifestyle configurations, see Step 2.1: (Optional) - // Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) + // Returns the name of a notebook instance lifecycle configuration. For + // information about notebook instance lifestyle configurations, see Step 2.1: + // (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) NotebookInstanceLifecycleConfigName *string // The name of the SageMaker notebook instance. @@ -236,8 +233,8 @@ type NotebookInstanceDeletedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NotebookInstanceDeletedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NotebookInstanceDeletedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -410,8 +407,8 @@ type NotebookInstanceInServiceWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NotebookInstanceInServiceWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NotebookInstanceInServiceWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -462,10 +459,10 @@ func (w *NotebookInstanceInServiceWaiter) Wait(ctx context.Context, params *Desc return err } -// WaitForOutput calls the waiter function for NotebookInstanceInService waiter and -// returns the output of the successful operation. The maxWaitDur is the maximum -// wait duration the waiter will wait. The maxWaitDur is required and must be -// greater than zero. +// WaitForOutput calls the waiter function for NotebookInstanceInService waiter +// and returns the output of the successful operation. The maxWaitDur is the +// maximum wait duration the waiter will wait. The maxWaitDur is required and must +// be greater than zero. func (w *NotebookInstanceInServiceWaiter) WaitForOutput(ctx context.Context, params *DescribeNotebookInstanceInput, maxWaitDur time.Duration, optFns ...func(*NotebookInstanceInServiceWaiterOptions)) (*DescribeNotebookInstanceOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -590,8 +587,8 @@ type NotebookInstanceStoppedWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, NotebookInstanceStoppedWaiter will use default max delay of 120 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, NotebookInstanceStoppedWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go index 831c1d6e513..f43bb315529 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go @@ -14,8 +14,8 @@ import ( // Returns a description of a notebook instance lifecycle configuration. For // information about notebook instance lifestyle configurations, see Step 2.1: -// (Optional) Customize a Notebook Instance -// (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). +// (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) +// . func (c *Client) DescribeNotebookInstanceLifecycleConfig(ctx context.Context, params *DescribeNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*DescribeNotebookInstanceLifecycleConfigOutput, error) { if params == nil { params = &DescribeNotebookInstanceLifecycleConfigInput{} diff --git a/service/sagemaker/api_op_DescribeProcessingJob.go b/service/sagemaker/api_op_DescribeProcessingJob.go index 27226d47434..5939dc81132 100644 --- a/service/sagemaker/api_op_DescribeProcessingJob.go +++ b/service/sagemaker/api_op_DescribeProcessingJob.go @@ -73,8 +73,8 @@ type DescribeProcessingJobOutput struct { // This member is required. ProcessingJobStatus types.ProcessingJobStatus - // Identifies the resources, ML compute instances, and ML storage volumes to deploy - // for a processing job. In distributed training, you specify more than one + // Identifies the resources, ML compute instances, and ML storage volumes to + // deploy for a processing job. In distributed training, you specify more than one // instance. // // This member is required. @@ -100,8 +100,8 @@ type DescribeProcessingJobOutput struct { // The time at which the processing job was last modified. LastModifiedTime *time.Time - // The ARN of a monitoring schedule for an endpoint associated with this processing - // job. + // The ARN of a monitoring schedule for an endpoint associated with this + // processing job. MonitoringScheduleArn *string // Networking options for a processing job. @@ -221,10 +221,10 @@ type ProcessingJobCompletedOrStoppedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ProcessingJobCompletedOrStoppedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ProcessingJobCompletedOrStoppedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/sagemaker/api_op_DescribeProject.go b/service/sagemaker/api_op_DescribeProject.go index 2eccea5c893..99b73211e01 100644 --- a/service/sagemaker/api_op_DescribeProject.go +++ b/service/sagemaker/api_op_DescribeProject.go @@ -66,8 +66,8 @@ type DescribeProjectOutput struct { ProjectStatus types.ProjectStatus // Information used to provision a service catalog product. For information, see - // What is Amazon Web Services Service Catalog - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) + // . // // This member is required. ServiceCatalogProvisioningDetails *types.ServiceCatalogProvisioningDetails diff --git a/service/sagemaker/api_op_DescribeStudioLifecycleConfig.go b/service/sagemaker/api_op_DescribeStudioLifecycleConfig.go index 7e7a1706ae0..40d3ffe0d46 100644 --- a/service/sagemaker/api_op_DescribeStudioLifecycleConfig.go +++ b/service/sagemaker/api_op_DescribeStudioLifecycleConfig.go @@ -43,8 +43,8 @@ type DescribeStudioLifecycleConfigOutput struct { // The creation time of the Studio Lifecycle Configuration. CreationTime *time.Time - // This value is equivalent to CreationTime because Studio Lifecycle Configurations - // are immutable. + // This value is equivalent to CreationTime because Studio Lifecycle + // Configurations are immutable. LastModifiedTime *time.Time // The App type that the Lifecycle Configuration is attached to. diff --git a/service/sagemaker/api_op_DescribeTrainingJob.go b/service/sagemaker/api_op_DescribeTrainingJob.go index 30145d8f9e7..fd7e65b9949 100644 --- a/service/sagemaker/api_op_DescribeTrainingJob.go +++ b/service/sagemaker/api_op_DescribeTrainingJob.go @@ -20,8 +20,8 @@ import ( // Returns information about a training job. Some of the attributes below only // appear if the training job successfully starts. If the training job fails, -// TrainingJobStatus is Failed and, depending on the FailureReason, attributes like -// TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and +// TrainingJobStatus is Failed and, depending on the FailureReason , attributes +// like TrainingStartTime , TrainingTimeInSeconds , TrainingEndTime , and // BillableTimeInSeconds may not be present in the response. func (c *Client) DescribeTrainingJob(ctx context.Context, params *DescribeTrainingJobInput, optFns ...func(*Options)) (*DescribeTrainingJobOutput, error) { if params == nil { @@ -73,62 +73,36 @@ type DescribeTrainingJobOutput struct { ResourceConfig *types.ResourceConfig // Provides detailed information about the state of the training job. For detailed - // information on the secondary status of the training job, see StatusMessage under - // SecondaryStatusTransition. SageMaker provides primary statuses and secondary - // statuses that apply to each of them: InProgress - // - // * Starting - Starting the - // training job. - // - // * Downloading - An optional stage for algorithms that support - // File training input mode. It indicates that data is being downloaded to the ML - // storage volumes. - // - // * Training - Training is in progress. - // - // * Interrupted - The job - // stopped because the managed spot training instances were interrupted. - // - // * - // Uploading - Training is complete and the model artifacts are being uploaded to - // the S3 location. - // + // information on the secondary status of the training job, see StatusMessage + // under SecondaryStatusTransition . SageMaker provides primary statuses and + // secondary statuses that apply to each of them: InProgress + // - Starting - Starting the training job. + // - Downloading - An optional stage for algorithms that support File training + // input mode. It indicates that data is being downloaded to the ML storage + // volumes. + // - Training - Training is in progress. + // - Interrupted - The job stopped because the managed spot training instances + // were interrupted. + // - Uploading - Training is complete and the model artifacts are being uploaded + // to the S3 location. // Completed - // - // * Completed - The training job has - // completed. - // + // - Completed - The training job has completed. // Failed - // - // * Failed - The training job has failed. The reason for the - // failure is returned in the FailureReason field of - // DescribeTrainingJobResponse. - // + // - Failed - The training job has failed. The reason for the failure is returned + // in the FailureReason field of DescribeTrainingJobResponse . // Stopped - // - // * MaxRuntimeExceeded - The job stopped - // because it exceeded the maximum allowed runtime. - // - // * MaxWaitTimeExceeded - The - // job stopped because it exceeded the maximum allowed wait time. - // - // * Stopped - The - // training job has stopped. - // + // - MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed + // runtime. + // - MaxWaitTimeExceeded - The job stopped because it exceeded the maximum + // allowed wait time. + // - Stopped - The training job has stopped. // Stopping - // - // * Stopping - Stopping the training - // job. - // - // Valid values for SecondaryStatus are subject to change. We no longer - // support the following secondary statuses: - // - // * LaunchingMLInstances - // - // * - // PreparingTraining - // - // * DownloadingTrainingImage + // - Stopping - Stopping the training job. + // Valid values for SecondaryStatus are subject to change. We no longer support + // the following secondary statuses: + // - LaunchingMLInstances + // - PreparingTraining + // - DownloadingTrainingImage // // This member is required. SecondaryStatus types.SecondaryStatus @@ -155,23 +129,13 @@ type DescribeTrainingJobOutput struct { // The status of the training job. SageMaker provides the following training job // statuses: - // - // * InProgress - The training is in progress. - // - // * Completed - The - // training job has completed. - // - // * Failed - The training job has failed. To see the - // reason for the failure, see the FailureReason field in the response to a - // DescribeTrainingJobResponse call. - // - // * Stopping - The training job is stopping. - // - // * - // Stopped - The training job has stopped. - // - // For more detailed information, see - // SecondaryStatus. + // - InProgress - The training is in progress. + // - Completed - The training job has completed. + // - Failed - The training job has failed. To see the reason for the failure, see + // the FailureReason field in the response to a DescribeTrainingJobResponse call. + // - Stopping - The training job is stopping. + // - Stopped - The training job has stopped. + // For more detailed information, see SecondaryStatus . // // This member is required. TrainingJobStatus types.TrainingJobStatus @@ -180,13 +144,13 @@ type DescribeTrainingJobOutput struct { AutoMLJobArn *string // The billable time in seconds. Billable time refers to the absolute wall-clock - // time. Multiply BillableTimeInSeconds by the number of instances (InstanceCount) - // in your training cluster to get the total compute time SageMaker bills you if - // you run distributed training. The formula is as follows: BillableTimeInSeconds * - // InstanceCount . You can calculate the savings from using managed spot training - // using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For - // example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the - // savings is 80%. + // time. Multiply BillableTimeInSeconds by the number of instances ( InstanceCount + // ) in your training cluster to get the total compute time SageMaker bills you if + // you run distributed training. The formula is as follows: BillableTimeInSeconds + // * InstanceCount . You can calculate the savings from using managed spot training + // using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100 . + // For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, + // the savings is 80%. BillableTimeInSeconds *int32 // Contains information about the output location for managed spot training @@ -196,34 +160,34 @@ type DescribeTrainingJobOutput struct { // Configuration information for the Amazon SageMaker Debugger hook parameters, // metric and tensor collections, and storage paths. To learn more about how to // configure the DebugHookConfig parameter, see Use the SageMaker and Debugger - // Configuration API Operations to Create, Update, and Debug Your Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . DebugHookConfig *types.DebugHookConfig // Configuration information for Amazon SageMaker Debugger rules for debugging // output tensors. DebugRuleConfigurations []types.DebugRuleConfiguration - // Evaluation status of Amazon SageMaker Debugger rules for debugging on a training - // job. + // Evaluation status of Amazon SageMaker Debugger rules for debugging on a + // training job. DebugRuleEvaluationStatuses []types.DebugRuleEvaluationStatus // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed + // training, choose True . Encryption provides greater security for distributed // training, but training might take longer. How long it takes depends on the // amount of communication between compute instances, especially if you use a deep // learning algorithms in distributed training. EnableInterContainerTrafficEncryption bool - // A Boolean indicating whether managed spot training is enabled (True) or not - // (False). + // A Boolean indicating whether managed spot training is enabled ( True ) or not ( + // False ). EnableManagedSpotTraining bool - // If you want to allow inbound or outbound network calls, except for calls between - // peers within a training cluster for distributed training, choose True. If you - // enable network isolation for training jobs that are configured to use a VPC, - // SageMaker downloads and uploads customer data and model artifacts through the - // specified VPC, but the training container does not have network access. + // If you want to allow inbound or outbound network calls, except for calls + // between peers within a training cluster for distributed training, choose True . + // If you enable network isolation for training jobs that are configured to use a + // VPC, SageMaker downloads and uploads customer data and model artifacts through + // the specified VPC, but the training container does not have network access. EnableNetworkIsolation bool // The environment variables to set in the Docker container. @@ -231,20 +195,16 @@ type DescribeTrainingJobOutput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *types.ExperimentConfig // If the training job failed, the reason it failed. FailureReason *string - // A collection of MetricData objects that specify the names, values, and dates and - // times that the training algorithm emitted to Amazon CloudWatch. + // A collection of MetricData objects that specify the names, values, and dates + // and times that the training algorithm emitted to Amazon CloudWatch. FinalMetricDataList []types.MetricData // Algorithm-specific parameters. @@ -273,27 +233,27 @@ type DescribeTrainingJobOutput struct { // system and framework metrics. ProfilerRuleConfigurations []types.ProfilerRuleConfiguration - // Evaluation status of Amazon SageMaker Debugger rules for profiling on a training - // job. + // Evaluation status of Amazon SageMaker Debugger rules for profiling on a + // training job. ProfilerRuleEvaluationStatuses []types.ProfilerRuleEvaluationStatus // Profiling status of a training job. ProfilingStatus types.ProfilingStatus // The number of times to retry the job when the job fails due to an - // InternalServerError. + // InternalServerError . RetryStrategy *types.RetryStrategy - // The Amazon Web Services Identity and Access Management (IAM) role configured for - // the training job. + // The Amazon Web Services Identity and Access Management (IAM) role configured + // for the training job. RoleArn *string // A history of all of the secondary statuses that the training job has // transitioned through. SecondaryStatusTransitions []types.SecondaryStatusTransition - // Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard - // output data. + // Configuration of storage locations for the Amazon SageMaker Debugger + // TensorBoard output data. TensorBoardOutputConfig *types.TensorBoardOutputConfig // Indicates the time when the training job ends on training instances. You are @@ -304,10 +264,10 @@ type DescribeTrainingJobOutput struct { TrainingEndTime *time.Time // Indicates the time when the training job starts on training instances. You are - // billed for the time interval between this time and the value of TrainingEndTime. - // The start time in CloudWatch Logs might be later than this time. The difference - // is due to the time it takes to download the training data and to the size of the - // training container. + // billed for the time interval between this time and the value of TrainingEndTime + // . The start time in CloudWatch Logs might be later than this time. The + // difference is due to the time it takes to download the training data and to the + // size of the training container. TrainingStartTime *time.Time // The training time in seconds. @@ -319,7 +279,7 @@ type DescribeTrainingJobOutput struct { // A VpcConfig object that specifies the VPC that this training job has access to. // For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) . VpcConfig *types.VpcConfig // The status of the warm pool associated with the training job. @@ -394,8 +354,8 @@ func (c *Client) addOperationDescribeTrainingJobMiddlewares(stack *middleware.St return nil } -// DescribeTrainingJobAPIClient is a client that implements the DescribeTrainingJob -// operation. +// DescribeTrainingJobAPIClient is a client that implements the +// DescribeTrainingJob operation. type DescribeTrainingJobAPIClient interface { DescribeTrainingJob(context.Context, *DescribeTrainingJobInput, ...func(*Options)) (*DescribeTrainingJobOutput, error) } @@ -417,10 +377,10 @@ type TrainingJobCompletedOrStoppedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TrainingJobCompletedOrStoppedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TrainingJobCompletedOrStoppedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -470,8 +430,8 @@ func (w *TrainingJobCompletedOrStoppedWaiter) Wait(ctx context.Context, params * return err } -// WaitForOutput calls the waiter function for TrainingJobCompletedOrStopped waiter -// and returns the output of the successful operation. The maxWaitDur is the +// WaitForOutput calls the waiter function for TrainingJobCompletedOrStopped +// waiter and returns the output of the successful operation. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *TrainingJobCompletedOrStoppedWaiter) WaitForOutput(ctx context.Context, params *DescribeTrainingJobInput, maxWaitDur time.Duration, optFns ...func(*TrainingJobCompletedOrStoppedWaiterOptions)) (*DescribeTrainingJobOutput, error) { diff --git a/service/sagemaker/api_op_DescribeTransformJob.go b/service/sagemaker/api_op_DescribeTransformJob.go index 1b55a112580..1b8974eb1f8 100644 --- a/service/sagemaker/api_op_DescribeTransformJob.go +++ b/service/sagemaker/api_op_DescribeTransformJob.go @@ -87,10 +87,10 @@ type DescribeTransformJobOutput struct { // The Amazon Resource Name (ARN) of the AutoML transform job. AutoMLJobArn *string - // Specifies the number of records to include in a mini-batch for an HTTP inference - // request. A record is a single unit of input data that inference can be made on. - // For example, a single line in a CSV file is a record. To enable the batch - // strategy, you must set SplitType to Line, RecordIO, or TFRecord. + // Specifies the number of records to include in a mini-batch for an HTTP + // inference request. A record is a single unit of input data that inference can be + // made on. For example, a single line in a CSV file is a record. To enable the + // batch strategy, you must set SplitType to Line , RecordIO , or TFRecord . BatchStrategy types.BatchStrategy // Configuration to control how SageMaker captures inference data. @@ -102,8 +102,8 @@ type DescribeTransformJobOutput struct { // data that is not needed for inference in a batch transform job. The output // filter provided allows you to include input data relevant to interpreting the // predictions in the output from the job. For more information, see Associate - // Prediction Results with their Corresponding Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). + // Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html) + // . DataProcessing *types.DataProcessing // The environment variables to set in the Docker container. We support up to 16 @@ -112,24 +112,20 @@ type DescribeTransformJobOutput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *types.ExperimentConfig // If the transform job failed, FailureReason describes why it failed. A transform // job creates a log file, which includes error messages, and stores it as an // Amazon S3 object. For more information, see Log Amazon SageMaker Events with - // Amazon CloudWatch - // (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html). + // Amazon CloudWatch (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html) + // . FailureReason *string - // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job - // that created the transform or training job. + // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling + // job that created the transform or training job. LabelingJobArn *string // The maximum number of parallel requests on each instance node that can be @@ -145,7 +141,7 @@ type DescribeTransformJobOutput struct { // Indicates when the transform job has been completed, or has stopped or failed. // You are billed for the time interval between this time and the value of - // TransformStartTime. + // TransformStartTime . TransformEndTime *time.Time // Identifies the Amazon S3 location where you want Amazon SageMaker to save the @@ -153,7 +149,7 @@ type DescribeTransformJobOutput struct { TransformOutput *types.TransformOutput // Indicates when the transform job starts on ML instances. You are billed for the - // time interval between this time and the value of TransformEndTime. + // time interval between this time and the value of TransformEndTime . TransformStartTime *time.Time // Metadata pertaining to the operation's result. @@ -248,10 +244,10 @@ type TransformJobCompletedOrStoppedWaiterOptions struct { // MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, TransformJobCompletedOrStoppedWaiter will use default max delay of 120 - // seconds. Note that MaxDelay must resolve to value greater than or equal to the - // MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, TransformJobCompletedOrStoppedWaiter will use default max delay of + // 120 seconds. Note that MaxDelay must resolve to value greater than or equal to + // the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/sagemaker/api_op_DescribeTrial.go b/service/sagemaker/api_op_DescribeTrial.go index 653410590df..872fd8649d3 100644 --- a/service/sagemaker/api_op_DescribeTrial.go +++ b/service/sagemaker/api_op_DescribeTrial.go @@ -46,8 +46,8 @@ type DescribeTrialOutput struct { // When the trial was created. CreationTime *time.Time - // The name of the trial as displayed. If DisplayName isn't specified, TrialName is - // displayed. + // The name of the trial as displayed. If DisplayName isn't specified, TrialName + // is displayed. DisplayName *string // The name of the experiment the trial is part of. diff --git a/service/sagemaker/api_op_DescribeTrialComponent.go b/service/sagemaker/api_op_DescribeTrialComponent.go index 8ae0d84de30..d8014a2837a 100644 --- a/service/sagemaker/api_op_DescribeTrialComponent.go +++ b/service/sagemaker/api_op_DescribeTrialComponent.go @@ -88,13 +88,9 @@ type DescribeTrialComponentOutput struct { StartTime *time.Time // The status of the component. States include: - // - // * InProgress - // - // * Completed - // - // * - // Failed + // - InProgress + // - Completed + // - Failed Status *types.TrialComponentStatus // The Amazon Resource Name (ARN) of the trial component. diff --git a/service/sagemaker/api_op_DescribeUserProfile.go b/service/sagemaker/api_op_DescribeUserProfile.go index 153484225f9..f80cf72d57f 100644 --- a/service/sagemaker/api_op_DescribeUserProfile.go +++ b/service/sagemaker/api_op_DescribeUserProfile.go @@ -12,7 +12,7 @@ import ( "time" ) -// Describes a user profile. For more information, see CreateUserProfile. +// Describes a user profile. For more information, see CreateUserProfile . func (c *Client) DescribeUserProfile(ctx context.Context, params *DescribeUserProfileInput, optFns ...func(*Options)) (*DescribeUserProfileOutput, error) { if params == nil { params = &DescribeUserProfileInput{} diff --git a/service/sagemaker/api_op_DescribeWorkforce.go b/service/sagemaker/api_op_DescribeWorkforce.go index 44d19956e56..719376dd927 100644 --- a/service/sagemaker/api_op_DescribeWorkforce.go +++ b/service/sagemaker/api_op_DescribeWorkforce.go @@ -12,10 +12,9 @@ import ( ) // Lists private workforce information, including workforce name, Amazon Resource -// Name (ARN), and, if applicable, allowed IP address ranges (CIDRs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Allowable -// IP address ranges are the IP addresses that workers can use to access tasks. -// This operation applies only to private workforces. +// Name (ARN), and, if applicable, allowed IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) +// ). Allowable IP address ranges are the IP addresses that workers can use to +// access tasks. This operation applies only to private workforces. func (c *Client) DescribeWorkforce(ctx context.Context, params *DescribeWorkforceInput, optFns ...func(*Options)) (*DescribeWorkforceOutput, error) { if params == nil { params = &DescribeWorkforceInput{} @@ -49,8 +48,8 @@ type DescribeWorkforceOutput struct { // first private work team. You can create one private work force in each Amazon // Web Services Region. By default, any workforce-related API operation used in a // specific region will apply to the workforce created in that region. To learn how - // to create a private workforce, see Create a Private Workforce - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). + // to create a private workforce, see Create a Private Workforce (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html) + // . // // This member is required. Workforce *types.Workforce diff --git a/service/sagemaker/api_op_DescribeWorkteam.go b/service/sagemaker/api_op_DescribeWorkteam.go index 047982c5e87..15ac37661f3 100644 --- a/service/sagemaker/api_op_DescribeWorkteam.go +++ b/service/sagemaker/api_op_DescribeWorkteam.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a specific work team. You can see information such as the -// create date, the last updated date, membership information, and the work team's -// Amazon Resource Name (ARN). +// Gets information about a specific work team. You can see information such as +// the create date, the last updated date, membership information, and the work +// team's Amazon Resource Name (ARN). func (c *Client) DescribeWorkteam(ctx context.Context, params *DescribeWorkteamInput, optFns ...func(*Options)) (*DescribeWorkteamOutput, error) { if params == nil { params = &DescribeWorkteamInput{} diff --git a/service/sagemaker/api_op_DisassociateTrialComponent.go b/service/sagemaker/api_op_DisassociateTrialComponent.go index 23c3fe6da93..913b6a7ca94 100644 --- a/service/sagemaker/api_op_DisassociateTrialComponent.go +++ b/service/sagemaker/api_op_DisassociateTrialComponent.go @@ -16,7 +16,7 @@ import ( // trial component with a trial, call the AssociateTrialComponent API. To get a // list of the trials a component is associated with, use the Search API. Specify // ExperimentTrialComponent for the Resource parameter. The list appears in the -// response under Results.TrialComponent.Parents. +// response under Results.TrialComponent.Parents . func (c *Client) DisassociateTrialComponent(ctx context.Context, params *DisassociateTrialComponentInput, optFns ...func(*Options)) (*DisassociateTrialComponentOutput, error) { if params == nil { params = &DisassociateTrialComponentInput{} diff --git a/service/sagemaker/api_op_GetModelPackageGroupPolicy.go b/service/sagemaker/api_op_GetModelPackageGroupPolicy.go index 2a75264191b..e610e8da36d 100644 --- a/service/sagemaker/api_op_GetModelPackageGroupPolicy.go +++ b/service/sagemaker/api_op_GetModelPackageGroupPolicy.go @@ -11,8 +11,7 @@ import ( ) // Gets a resource policy that manages access for a model group. For information -// about resource policies, see Identity-based policies and resource-based policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) +// about resource policies, see Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) // in the Amazon Web Services Identity and Access Management User Guide.. func (c *Client) GetModelPackageGroupPolicy(ctx context.Context, params *GetModelPackageGroupPolicyInput, optFns ...func(*Options)) (*GetModelPackageGroupPolicyOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_GetSearchSuggestions.go b/service/sagemaker/api_op_GetSearchSuggestions.go index 18e00f7ae7b..5e820263d40 100644 --- a/service/sagemaker/api_op_GetSearchSuggestions.go +++ b/service/sagemaker/api_op_GetSearchSuggestions.go @@ -13,7 +13,7 @@ import ( // An auto-complete API for the search functionality in the SageMaker console. It // returns suggestions of possible matches for the property name to use in Search -// queries. Provides suggestions for HyperParameters, Tags, and Metrics. +// queries. Provides suggestions for HyperParameters , Tags , and Metrics . func (c *Client) GetSearchSuggestions(ctx context.Context, params *GetSearchSuggestionsInput, optFns ...func(*Options)) (*GetSearchSuggestionsOutput, error) { if params == nil { params = &GetSearchSuggestionsInput{} @@ -44,7 +44,7 @@ type GetSearchSuggestionsInput struct { type GetSearchSuggestionsOutput struct { - // A list of property names for a Resource that match a SuggestionQuery. + // A list of property names for a Resource that match a SuggestionQuery . PropertyNameSuggestions []types.PropertyNameSuggestion // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ImportHubContent.go b/service/sagemaker/api_op_ImportHubContent.go index a27da850e99..8ddea5d3721 100644 --- a/service/sagemaker/api_op_ImportHubContent.go +++ b/service/sagemaker/api_op_ImportHubContent.go @@ -61,8 +61,8 @@ type ImportHubContentInput struct { // The display name of the hub content to import. HubContentDisplayName *string - // A string that provides a description of the hub content. This string can include - // links, tables, and standard markdown formating. + // A string that provides a description of the hub content. This string can + // include links, tables, and standard markdown formating. HubContentMarkdown *string // The searchable keywords of the hub content. diff --git a/service/sagemaker/api_op_ListActions.go b/service/sagemaker/api_op_ListActions.go index 96cb3cb5848..d6610f4774a 100644 --- a/service/sagemaker/api_op_ListActions.go +++ b/service/sagemaker/api_op_ListActions.go @@ -48,10 +48,10 @@ type ListActionsInput struct { // call returns a token for getting the next set of actions. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortActionsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only actions with the specified source URI. diff --git a/service/sagemaker/api_op_ListAlgorithms.go b/service/sagemaker/api_op_ListAlgorithms.go index 7596dbc591b..9e29ed96ad1 100644 --- a/service/sagemaker/api_op_ListAlgorithms.go +++ b/service/sagemaker/api_op_ListAlgorithms.go @@ -46,15 +46,15 @@ type ListAlgorithmsInput struct { // contains the specified string. NameContains *string - // If the response to a previous ListAlgorithms request was truncated, the response - // includes a NextToken. To retrieve the next set of algorithms, use the token in - // the next request. + // If the response to a previous ListAlgorithms request was truncated, the + // response includes a NextToken . To retrieve the next set of algorithms, use the + // token in the next request. NextToken *string - // The parameter by which to sort the results. The default is CreationTime. + // The parameter by which to sort the results. The default is CreationTime . SortBy types.AlgorithmSortBy - // The sort order for the results. The default is Ascending. + // The sort order for the results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -67,8 +67,8 @@ type ListAlgorithmsOutput struct { // This member is required. AlgorithmSummaryList []types.AlgorithmSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of algorithms, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListAppImageConfigs.go b/service/sagemaker/api_op_ListAppImageConfigs.go index 4eb9322ce15..08adc01eb03 100644 --- a/service/sagemaker/api_op_ListAppImageConfigs.go +++ b/service/sagemaker/api_op_ListAppImageConfigs.go @@ -62,10 +62,10 @@ type ListAppImageConfigsInput struct { // AppImageConfigs. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.AppImageConfigSortKey - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -145,8 +145,8 @@ func (c *Client) addOperationListAppImageConfigsMiddlewares(stack *middleware.St return nil } -// ListAppImageConfigsAPIClient is a client that implements the ListAppImageConfigs -// operation. +// ListAppImageConfigsAPIClient is a client that implements the +// ListAppImageConfigs operation. type ListAppImageConfigsAPIClient interface { ListAppImageConfigs(context.Context, *ListAppImageConfigsInput, ...func(*Options)) (*ListAppImageConfigsOutput, error) } diff --git a/service/sagemaker/api_op_ListApps.go b/service/sagemaker/api_op_ListApps.go index 423d8fb15cc..67eff92425b 100644 --- a/service/sagemaker/api_op_ListApps.go +++ b/service/sagemaker/api_op_ListApps.go @@ -50,8 +50,8 @@ type ListAppsInput struct { // value cannot be set. SpaceNameEquals *string - // A parameter to search by user profile name. If SpaceNameEquals is set, then this - // value cannot be set. + // A parameter to search by user profile name. If SpaceNameEquals is set, then + // this value cannot be set. UserProfileNameEquals *string noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListArtifacts.go b/service/sagemaker/api_op_ListArtifacts.go index b6f27c1568f..cd61dca9e49 100644 --- a/service/sagemaker/api_op_ListArtifacts.go +++ b/service/sagemaker/api_op_ListArtifacts.go @@ -48,10 +48,10 @@ type ListArtifactsInput struct { // the call returns a token for getting the next set of artifacts. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortArtifactsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only artifacts with the specified source URI. diff --git a/service/sagemaker/api_op_ListAssociations.go b/service/sagemaker/api_op_ListAssociations.go index cf2171bca54..b53a07ad680 100644 --- a/service/sagemaker/api_op_ListAssociations.go +++ b/service/sagemaker/api_op_ListAssociations.go @@ -55,10 +55,10 @@ type ListAssociationsInput struct { // associations, the call returns a token for getting the next set of associations. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortAssociationsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only associations with the specified source ARN. diff --git a/service/sagemaker/api_op_ListAutoMLJobs.go b/service/sagemaker/api_op_ListAutoMLJobs.go index ab1d64ba102..76d35786c5b 100644 --- a/service/sagemaker/api_op_ListAutoMLJobs.go +++ b/service/sagemaker/api_op_ListAutoMLJobs.go @@ -53,10 +53,10 @@ type ListAutoMLJobsInput struct { // next request to receive the next set of results. NextToken *string - // The parameter by which to sort the results. The default is Name. + // The parameter by which to sort the results. The default is Name . SortBy types.AutoMLSortBy - // The sort order for the results. The default is Descending. + // The sort order for the results. The default is Descending . SortOrder types.AutoMLSortOrder // Request a list of jobs, using a filter for status. diff --git a/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go b/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go index 21724f5f69a..a85386a154d 100644 --- a/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go +++ b/service/sagemaker/api_op_ListCandidatesForAutoMLJob.go @@ -45,10 +45,10 @@ type ListCandidatesForAutoMLJobInput struct { // next request to receive the next set of results. NextToken *string - // The parameter by which to sort the results. The default is Descending. + // The parameter by which to sort the results. The default is Descending . SortBy types.CandidateSortBy - // The sort order for the results. The default is Ascending. + // The sort order for the results. The default is Ascending . SortOrder types.AutoMLSortOrder // List the candidates for the job and filter by status. @@ -59,7 +59,7 @@ type ListCandidatesForAutoMLJobInput struct { type ListCandidatesForAutoMLJobOutput struct { - // Summaries about the AutoMLCandidates. + // Summaries about the AutoMLCandidates . // // This member is required. Candidates []types.AutoMLCandidate diff --git a/service/sagemaker/api_op_ListCodeRepositories.go b/service/sagemaker/api_op_ListCodeRepositories.go index 481aa83c6fb..da745c9d90b 100644 --- a/service/sagemaker/api_op_ListCodeRepositories.go +++ b/service/sagemaker/api_op_ListCodeRepositories.go @@ -55,14 +55,14 @@ type ListCodeRepositoriesInput struct { NameContains *string // If the result of a ListCodeRepositoriesOutput request was truncated, the - // response includes a NextToken. To get the next set of Git repositories, use the + // response includes a NextToken . To get the next set of Git repositories, use the // token in the next request. NextToken *string - // The field to sort results by. The default is Name. + // The field to sort results by. The default is Name . SortBy types.CodeRepositorySortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.CodeRepositorySortOrder noSmithyDocumentSerde @@ -72,25 +72,19 @@ type ListCodeRepositoriesOutput struct { // Gets a list of summaries of the Git repositories. Each summary specifies the // following values for the repository: - // - // * Name - // - // * Amazon Resource Name (ARN) - // - // * - // Creation time - // - // * Last modified time - // - // * Configuration information, including the - // URL location of the repository and the ARN of the Amazon Web Services Secrets - // Manager secret that contains the credentials used to access the repository. + // - Name + // - Amazon Resource Name (ARN) + // - Creation time + // - Last modified time + // - Configuration information, including the URL location of the repository and + // the ARN of the Amazon Web Services Secrets Manager secret that contains the + // credentials used to access the repository. // // This member is required. CodeRepositorySummaryList []types.CodeRepositorySummary // If the result of a ListCodeRepositoriesOutput request was truncated, the - // response includes a NextToken. To get the next set of Git repositories, use the + // response includes a NextToken . To get the next set of Git repositories, use the // token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListCompilationJobs.go b/service/sagemaker/api_op_ListCompilationJobs.go index 29eb63a4eda..9ee4153ab78 100644 --- a/service/sagemaker/api_op_ListCompilationJobs.go +++ b/service/sagemaker/api_op_ListCompilationJobs.go @@ -14,8 +14,8 @@ import ( ) // Lists model compilation jobs that satisfy various filters. To create a model -// compilation job, use CreateCompilationJob. To get information about a particular -// model compilation job you have created, use DescribeCompilationJob. +// compilation job, use CreateCompilationJob . To get information about a +// particular model compilation job you have created, use DescribeCompilationJob . func (c *Client) ListCompilationJobs(ctx context.Context, params *ListCompilationJobsInput, optFns ...func(*Options)) (*ListCompilationJobsOutput, error) { if params == nil { params = &ListCompilationJobsInput{} @@ -52,19 +52,19 @@ type ListCompilationJobsInput struct { // The maximum number of model compilation jobs to return in the response. MaxResults *int32 - // A filter that returns the model compilation jobs whose name contains a specified - // string. + // A filter that returns the model compilation jobs whose name contains a + // specified string. NameContains *string // If the result of the previous ListCompilationJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of model compilation + // response includes a NextToken . To retrieve the next set of model compilation // jobs, use the token in the next request. NextToken *string - // The field by which to sort results. The default is CreationTime. + // The field by which to sort results. The default is CreationTime . SortBy types.ListCompilationJobsSortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that retrieves model compilation jobs with a specific @@ -82,7 +82,7 @@ type ListCompilationJobsOutput struct { // This member is required. CompilationJobSummaries []types.CompilationJobSummary - // If the response is truncated, Amazon SageMaker returns this NextToken. To + // If the response is truncated, Amazon SageMaker returns this NextToken . To // retrieve the next set of model compilation jobs, use this token in the next // request. NextToken *string @@ -153,8 +153,8 @@ func (c *Client) addOperationListCompilationJobsMiddlewares(stack *middleware.St return nil } -// ListCompilationJobsAPIClient is a client that implements the ListCompilationJobs -// operation. +// ListCompilationJobsAPIClient is a client that implements the +// ListCompilationJobs operation. type ListCompilationJobsAPIClient interface { ListCompilationJobs(context.Context, *ListCompilationJobsInput, ...func(*Options)) (*ListCompilationJobsOutput, error) } diff --git a/service/sagemaker/api_op_ListContexts.go b/service/sagemaker/api_op_ListContexts.go index ab07baf081a..38bcf9fa751 100644 --- a/service/sagemaker/api_op_ListContexts.go +++ b/service/sagemaker/api_op_ListContexts.go @@ -44,14 +44,14 @@ type ListContextsInput struct { // 10. MaxResults *int32 - // If the previous call to ListContexts didn't return the full set of contexts, the - // call returns a token for getting the next set of contexts. + // If the previous call to ListContexts didn't return the full set of contexts, + // the call returns a token for getting the next set of contexts. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortContextsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only contexts with the specified source URI. diff --git a/service/sagemaker/api_op_ListDataQualityJobDefinitions.go b/service/sagemaker/api_op_ListDataQualityJobDefinitions.go index d4e6e6dd423..60e70c2e04b 100644 --- a/service/sagemaker/api_op_ListDataQualityJobDefinitions.go +++ b/service/sagemaker/api_op_ListDataQualityJobDefinitions.go @@ -31,8 +31,8 @@ func (c *Client) ListDataQualityJobDefinitions(ctx context.Context, params *List type ListDataQualityJobDefinitionsInput struct { - // A filter that returns only data quality monitoring job definitions created after - // the specified time. + // A filter that returns only data quality monitoring job definitions created + // after the specified time. CreationTimeAfter *time.Time // A filter that returns only data quality monitoring job definitions created @@ -47,20 +47,20 @@ type ListDataQualityJobDefinitionsInput struct { // response. MaxResults *int32 - // A string in the data quality monitoring job definition name. This filter returns - // only data quality monitoring job definitions whose name contains the specified - // string. + // A string in the data quality monitoring job definition name. This filter + // returns only data quality monitoring job definitions whose name contains the + // specified string. NameContains *string // If the result of the previous ListDataQualityJobDefinitions request was - // truncated, the response includes a NextToken. To retrieve the next set of + // truncated, the response includes a NextToken . To retrieve the next set of // transform jobs, use the token in the next request.> NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.MonitoringJobDefinitionSortKey - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -74,7 +74,7 @@ type ListDataQualityJobDefinitionsOutput struct { JobDefinitionSummaries []types.MonitoringJobDefinitionSummary // If the result of the previous ListDataQualityJobDefinitions request was - // truncated, the response includes a NextToken. To retrieve the next set of data + // truncated, the response includes a NextToken . To retrieve the next set of data // quality monitoring job definitions, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListEdgeDeploymentPlans.go b/service/sagemaker/api_op_ListEdgeDeploymentPlans.go index cd0b9d6dea0..d62d6d538e3 100644 --- a/service/sagemaker/api_op_ListEdgeDeploymentPlans.go +++ b/service/sagemaker/api_op_ListEdgeDeploymentPlans.go @@ -56,8 +56,8 @@ type ListEdgeDeploymentPlansInput struct { // tokening. NextToken *string - // The column by which to sort the edge deployment plans. Can be one of NAME, - // DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME. + // The column by which to sort the edge deployment plans. Can be one of NAME , + // DEVICEFLEETNAME , CREATIONTIME , LASTMODIFIEDTIME . SortBy types.ListEdgeDeploymentPlansSortBy // The direction of the sorting (ascending or descending). diff --git a/service/sagemaker/api_op_ListEndpointConfigs.go b/service/sagemaker/api_op_ListEndpointConfigs.go index dbd0a738dc3..6aa8467d8ce 100644 --- a/service/sagemaker/api_op_ListEndpointConfigs.go +++ b/service/sagemaker/api_op_ListEndpointConfigs.go @@ -47,14 +47,14 @@ type ListEndpointConfigsInput struct { NameContains *string // If the result of the previous ListEndpointConfig request was truncated, the - // response includes a NextToken. To retrieve the next set of endpoint + // response includes a NextToken . To retrieve the next set of endpoint // configurations, use the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.EndpointConfigSortKey - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.OrderKey noSmithyDocumentSerde @@ -67,8 +67,8 @@ type ListEndpointConfigsOutput struct { // This member is required. EndpointConfigs []types.EndpointConfigSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of endpoint configurations, use it in the subsequent request + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of endpoint configurations, use it in the subsequent request NextToken *string // Metadata pertaining to the operation's result. @@ -137,8 +137,8 @@ func (c *Client) addOperationListEndpointConfigsMiddlewares(stack *middleware.St return nil } -// ListEndpointConfigsAPIClient is a client that implements the ListEndpointConfigs -// operation. +// ListEndpointConfigsAPIClient is a client that implements the +// ListEndpointConfigs operation. type ListEndpointConfigsAPIClient interface { ListEndpointConfigs(context.Context, *ListEndpointConfigsInput, ...func(*Options)) (*ListEndpointConfigsOutput, error) } diff --git a/service/sagemaker/api_op_ListEndpoints.go b/service/sagemaker/api_op_ListEndpoints.go index 9d3c51a6d29..906a1e1bc55 100644 --- a/service/sagemaker/api_op_ListEndpoints.go +++ b/service/sagemaker/api_op_ListEndpoints.go @@ -35,8 +35,8 @@ type ListEndpointsInput struct { // to the specified time (timestamp). CreationTimeAfter *time.Time - // A filter that returns only endpoints that were created before the specified time - // (timestamp). + // A filter that returns only endpoints that were created before the specified + // time (timestamp). CreationTimeBefore *time.Time // A filter that returns only endpoints that were modified after the specified @@ -56,14 +56,14 @@ type ListEndpointsInput struct { NameContains *string // If the result of a ListEndpoints request was truncated, the response includes a - // NextToken. To retrieve the next set of endpoints, use the token in the next + // NextToken . To retrieve the next set of endpoints, use the token in the next // request. NextToken *string - // Sorts the list of results. The default is CreationTime. + // Sorts the list of results. The default is CreationTime . SortBy types.EndpointSortKey - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.OrderKey // A filter that returns only endpoints with the specified status. @@ -79,8 +79,8 @@ type ListEndpointsOutput struct { // This member is required. Endpoints []types.EndpointSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of training jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of training jobs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListExperiments.go b/service/sagemaker/api_op_ListExperiments.go index ef43ee9d29d..3e45beaf952 100644 --- a/service/sagemaker/api_op_ListExperiments.go +++ b/service/sagemaker/api_op_ListExperiments.go @@ -13,9 +13,9 @@ import ( "time" ) -// Lists all the experiments in your account. The list can be filtered to show only -// experiments that were created in a specific time range. The list can be sorted -// by experiment name or creation time. +// Lists all the experiments in your account. The list can be filtered to show +// only experiments that were created in a specific time range. The list can be +// sorted by experiment name or creation time. func (c *Client) ListExperiments(ctx context.Context, params *ListExperimentsInput, optFns ...func(*Options)) (*ListExperimentsOutput, error) { if params == nil { params = &ListExperimentsInput{} @@ -47,10 +47,10 @@ type ListExperimentsInput struct { // experiments, the call returns a token for getting the next set of experiments. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortExperimentsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListFeatureGroups.go b/service/sagemaker/api_op_ListFeatureGroups.go index ab9f4fea33a..e01c1028bd0 100644 --- a/service/sagemaker/api_op_ListFeatureGroups.go +++ b/service/sagemaker/api_op_ListFeatureGroups.go @@ -12,7 +12,7 @@ import ( "time" ) -// List FeatureGroups based on given filter and order. +// List FeatureGroup s based on given filter and order. func (c *Client) ListFeatureGroups(ctx context.Context, params *ListFeatureGroupsInput, optFns ...func(*Options)) (*ListFeatureGroupsOutput, error) { if params == nil { params = &ListFeatureGroupsInput{} @@ -30,22 +30,22 @@ func (c *Client) ListFeatureGroups(ctx context.Context, params *ListFeatureGroup type ListFeatureGroupsInput struct { - // Use this parameter to search for FeatureGroupss created after a specific date + // Use this parameter to search for FeatureGroups s created after a specific date // and time. CreationTimeAfter *time.Time - // Use this parameter to search for FeatureGroupss created before a specific date + // Use this parameter to search for FeatureGroups s created before a specific date // and time. CreationTimeBefore *time.Time // A FeatureGroup status. Filters by FeatureGroup status. FeatureGroupStatusEquals types.FeatureGroupStatus - // The maximum number of results returned by ListFeatureGroups. + // The maximum number of results returned by ListFeatureGroups . MaxResults *int32 - // A string that partially matches one or more FeatureGroups names. Filters - // FeatureGroups by name. + // A string that partially matches one or more FeatureGroup s names. Filters + // FeatureGroup s by name. NameContains *string // A token to resume pagination of ListFeatureGroups results. diff --git a/service/sagemaker/api_op_ListFlowDefinitions.go b/service/sagemaker/api_op_ListFlowDefinitions.go index 63b2f701bd1..28d7cbc0bc3 100644 --- a/service/sagemaker/api_op_ListFlowDefinitions.go +++ b/service/sagemaker/api_op_ListFlowDefinitions.go @@ -31,8 +31,8 @@ func (c *Client) ListFlowDefinitions(ctx context.Context, params *ListFlowDefini type ListFlowDefinitionsInput struct { - // A filter that returns only flow definitions with a creation time greater than or - // equal to the specified timestamp. + // A filter that returns only flow definitions with a creation time greater than + // or equal to the specified timestamp. CreationTimeAfter *time.Time // A filter that returns only flow definitions that were created before the @@ -40,7 +40,7 @@ type ListFlowDefinitionsInput struct { CreationTimeBefore *time.Time // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken will be provided + // more than the value specified in MaxResults , then a NextToken will be provided // in the output that you can use to resume pagination. MaxResults *int32 @@ -130,8 +130,8 @@ func (c *Client) addOperationListFlowDefinitionsMiddlewares(stack *middleware.St return nil } -// ListFlowDefinitionsAPIClient is a client that implements the ListFlowDefinitions -// operation. +// ListFlowDefinitionsAPIClient is a client that implements the +// ListFlowDefinitions operation. type ListFlowDefinitionsAPIClient interface { ListFlowDefinitions(context.Context, *ListFlowDefinitionsInput, ...func(*Options)) (*ListFlowDefinitionsOutput, error) } @@ -142,7 +142,7 @@ var _ ListFlowDefinitionsAPIClient = (*Client)(nil) // ListFlowDefinitions type ListFlowDefinitionsPaginatorOptions struct { // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken will be provided + // more than the value specified in MaxResults , then a NextToken will be provided // in the output that you can use to resume pagination. Limit int32 diff --git a/service/sagemaker/api_op_ListHubContentVersions.go b/service/sagemaker/api_op_ListHubContentVersions.go index 6d7cbca4a61..946e581ed4b 100644 --- a/service/sagemaker/api_op_ListHubContentVersions.go +++ b/service/sagemaker/api_op_ListHubContentVersions.go @@ -61,8 +61,8 @@ type ListHubContentVersionsInput struct { MinVersion *string // If the response to a previous ListHubContentVersions request was truncated, the - // response includes a NextToken. To retrieve the next set of hub content versions, - // use the token in the next request. + // response includes a NextToken . To retrieve the next set of hub content + // versions, use the token in the next request. NextToken *string // Sort hub content versions by either name or creation time. @@ -81,8 +81,8 @@ type ListHubContentVersionsOutput struct { // This member is required. HubContentSummaries []types.HubContentInfo - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of hub content versions, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of hub content versions, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListHubContents.go b/service/sagemaker/api_op_ListHubContents.go index c35d7a335c3..0a5607ca989 100644 --- a/service/sagemaker/api_op_ListHubContents.go +++ b/service/sagemaker/api_op_ListHubContents.go @@ -56,7 +56,7 @@ type ListHubContentsInput struct { NameContains *string // If the response to a previous ListHubContents request was truncated, the - // response includes a NextToken. To retrieve the next set of hub content, use the + // response includes a NextToken . To retrieve the next set of hub content, use the // token in the next request. NextToken *string @@ -76,8 +76,8 @@ type ListHubContentsOutput struct { // This member is required. HubContentSummaries []types.HubContentInfo - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of hub content, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of hub content, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListHubs.go b/service/sagemaker/api_op_ListHubs.go index 078c7b1ac93..6881bc2d666 100644 --- a/service/sagemaker/api_op_ListHubs.go +++ b/service/sagemaker/api_op_ListHubs.go @@ -49,7 +49,7 @@ type ListHubsInput struct { NameContains *string // If the response to a previous ListHubs request was truncated, the response - // includes a NextToken. To retrieve the next set of hubs, use the token in the + // includes a NextToken . To retrieve the next set of hubs, use the token in the // next request. NextToken *string @@ -69,8 +69,8 @@ type ListHubsOutput struct { // This member is required. HubSummaries []types.HubInfo - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of hubs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of hubs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListHumanTaskUis.go b/service/sagemaker/api_op_ListHumanTaskUis.go index 378d3896cc5..8f74f5612c9 100644 --- a/service/sagemaker/api_op_ListHumanTaskUis.go +++ b/service/sagemaker/api_op_ListHumanTaskUis.go @@ -40,7 +40,7 @@ type ListHumanTaskUisInput struct { CreationTimeBefore *time.Time // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken will be provided + // more than the value specified in MaxResults , then a NextToken will be provided // in the output that you can use to resume pagination. MaxResults *int32 @@ -141,7 +141,7 @@ var _ ListHumanTaskUisAPIClient = (*Client)(nil) // ListHumanTaskUisPaginatorOptions is the paginator options for ListHumanTaskUis type ListHumanTaskUisPaginatorOptions struct { // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken will be provided + // more than the value specified in MaxResults , then a NextToken will be provided // in the output that you can use to resume pagination. Limit int32 diff --git a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go index 513bbbcebeb..15105dd9a76 100644 --- a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go +++ b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go @@ -51,19 +51,19 @@ type ListHyperParameterTuningJobsInput struct { // The maximum number of tuning jobs to return. The default value is 10. MaxResults *int32 - // A string in the tuning job name. This filter returns only tuning jobs whose name - // contains the specified string. + // A string in the tuning job name. This filter returns only tuning jobs whose + // name contains the specified string. NameContains *string // If the result of the previous ListHyperParameterTuningJobs request was - // truncated, the response includes a NextToken. To retrieve the next set of tuning - // jobs, use the token in the next request. + // truncated, the response includes a NextToken . To retrieve the next set of + // tuning jobs, use the token in the next request. NextToken *string - // The field to sort results by. The default is Name. + // The field to sort results by. The default is Name . SortBy types.HyperParameterTuningJobSortByOptions - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that returns only tuning jobs with the specified status. @@ -81,7 +81,7 @@ type ListHyperParameterTuningJobsOutput struct { HyperParameterTuningJobSummaries []types.HyperParameterTuningJobSummary // If the result of this ListHyperParameterTuningJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of tuning jobs, use the + // response includes a NextToken . To retrieve the next set of tuning jobs, use the // token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListImageVersions.go b/service/sagemaker/api_op_ListImageVersions.go index 8f55a65bbdc..f8c28903cd5 100644 --- a/service/sagemaker/api_op_ListImageVersions.go +++ b/service/sagemaker/api_op_ListImageVersions.go @@ -57,10 +57,10 @@ type ListImageVersionsInput struct { // versions, the call returns a token for getting the next set of versions. NextToken *string - // The property used to sort results. The default value is CREATION_TIME. + // The property used to sort results. The default value is CREATION_TIME . SortBy types.ImageVersionSortBy - // The sort order. The default value is DESCENDING. + // The sort order. The default value is DESCENDING . SortOrder types.ImageVersionSortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListImages.go b/service/sagemaker/api_op_ListImages.go index d2830ffa517..59e35974ff5 100644 --- a/service/sagemaker/api_op_ListImages.go +++ b/service/sagemaker/api_op_ListImages.go @@ -55,10 +55,10 @@ type ListImagesInput struct { // call returns a token for getting the next set of images. NextToken *string - // The property used to sort results. The default value is CREATION_TIME. + // The property used to sort results. The default value is CREATION_TIME . SortBy types.ImageSortBy - // The sort order. The default value is DESCENDING. + // The sort order. The default value is DESCENDING . SortOrder types.ImageSortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListInferenceExperiments.go b/service/sagemaker/api_op_ListInferenceExperiments.go index 2ecdc5f955c..cd88354243e 100644 --- a/service/sagemaker/api_op_ListInferenceExperiments.go +++ b/service/sagemaker/api_op_ListInferenceExperiments.go @@ -60,11 +60,11 @@ type ListInferenceExperimentsInput struct { SortOrder types.SortOrder // Selects inference experiments which are in this status. For the possible - // statuses, see DescribeInferenceExperimentResponse$Status. + // statuses, see DescribeInferenceExperimentResponse$Status . StatusEquals types.InferenceExperimentStatus // Selects inference experiments of this type. For the possible types of inference - // experiments, see CreateInferenceExperimentRequest$Type. + // experiments, see CreateInferenceExperimentRequest$Type . Type types.InferenceExperimentType noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go b/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go index c784d8b0423..37bb1d78013 100644 --- a/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go +++ b/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go @@ -48,7 +48,7 @@ type ListInferenceRecommendationsJobStepsInput struct { // empty, then all benchmarks are returned. Status types.RecommendationJobStatus - // A filter to return details about the specified type of subtask. BENCHMARK: + // A filter to return details about the specified type of subtask. BENCHMARK : // Evaluate the performance of your model on different instance types. StepType types.RecommendationStepType diff --git a/service/sagemaker/api_op_ListInferenceRecommendationsJobs.go b/service/sagemaker/api_op_ListInferenceRecommendationsJobs.go index b00f8d04212..a97f77d9747 100644 --- a/service/sagemaker/api_op_ListInferenceRecommendationsJobs.go +++ b/service/sagemaker/api_op_ListInferenceRecommendationsJobs.go @@ -37,8 +37,8 @@ type ListInferenceRecommendationsJobsInput struct { // A filter that returns only jobs created before the specified time (timestamp). CreationTimeBefore *time.Time - // A filter that returns only jobs that were last modified after the specified time - // (timestamp). + // A filter that returns only jobs that were last modified after the specified + // time (timestamp). LastModifiedTimeAfter *time.Time // A filter that returns only jobs that were last modified before the specified @@ -53,7 +53,7 @@ type ListInferenceRecommendationsJobsInput struct { NameContains *string // If the response to a previous ListInferenceRecommendationsJobsRequest request - // was truncated, the response includes a NextToken. To retrieve the next set of + // was truncated, the response includes a NextToken . To retrieve the next set of // recommendations, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListLabelingJobs.go b/service/sagemaker/api_op_ListLabelingJobs.go index 318ec207a64..c973dc1e2b0 100644 --- a/service/sagemaker/api_op_ListLabelingJobs.go +++ b/service/sagemaker/api_op_ListLabelingJobs.go @@ -55,14 +55,14 @@ type ListLabelingJobsInput struct { NameContains *string // If the result of the previous ListLabelingJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of labeling jobs, use + // response includes a NextToken . To retrieve the next set of labeling jobs, use // the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.SortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that retrieves only labeling jobs with a specific status. @@ -76,8 +76,8 @@ type ListLabelingJobsOutput struct { // An array of LabelingJobSummary objects, each describing a labeling job. LabelingJobSummaryList []types.LabelingJobSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of labeling jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of labeling jobs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go b/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go index c8e2b2a53d1..74c1c15be44 100644 --- a/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go +++ b/service/sagemaker/api_op_ListLabelingJobsForWorkteam.go @@ -52,15 +52,15 @@ type ListLabelingJobsForWorkteamInput struct { // The maximum number of labeling jobs to return in each page of the response. MaxResults *int32 - // If the result of the previous ListLabelingJobsForWorkteam request was truncated, - // the response includes a NextToken. To retrieve the next set of labeling jobs, - // use the token in the next request. + // If the result of the previous ListLabelingJobsForWorkteam request was + // truncated, the response includes a NextToken . To retrieve the next set of + // labeling jobs, use the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.ListLabelingJobsForWorkteamSortByOptions - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -73,8 +73,8 @@ type ListLabelingJobsForWorkteamOutput struct { // This member is required. LabelingJobSummaryList []types.LabelingJobForWorkteamSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of labeling jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of labeling jobs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListLineageGroups.go b/service/sagemaker/api_op_ListLineageGroups.go index 4cd1667dd51..6e4cdac7ef3 100644 --- a/service/sagemaker/api_op_ListLineageGroups.go +++ b/service/sagemaker/api_op_ListLineageGroups.go @@ -14,8 +14,7 @@ import ( ) // A list of lineage groups shared with your Amazon Web Services account. For more -// information, see Cross-Account Lineage Tracking -// (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) +// information, see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) // in the Amazon SageMaker Developer Guide. func (c *Client) ListLineageGroups(ctx context.Context, params *ListLineageGroupsInput, optFns ...func(*Options)) (*ListLineageGroupsOutput, error) { if params == nil { @@ -46,14 +45,14 @@ type ListLineageGroupsInput struct { // to 10. MaxResults *int32 - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of algorithms, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. NextToken *string - // The parameter by which to sort the results. The default is CreationTime. + // The parameter by which to sort the results. The default is CreationTime . SortBy types.SortLineageGroupsBy - // The sort order for the results. The default is Ascending. + // The sort order for the results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -64,8 +63,8 @@ type ListLineageGroupsOutput struct { // A list of lineage groups and their properties. LineageGroupSummaries []types.LineageGroupSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of algorithms, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelBiasJobDefinitions.go b/service/sagemaker/api_op_ListModelBiasJobDefinitions.go index 8877a11493e..739f52b8f59 100644 --- a/service/sagemaker/api_op_ListModelBiasJobDefinitions.go +++ b/service/sagemaker/api_op_ListModelBiasJobDefinitions.go @@ -47,16 +47,16 @@ type ListModelBiasJobDefinitionsInput struct { // Filter for model bias jobs whose name contains a specified string. NameContains *string - // The token returned if the response is truncated. To retrieve the next set of job - // executions, use it in the next request. + // The token returned if the response is truncated. To retrieve the next set of + // job executions, use it in the next request. NextToken *string // Whether to sort results by the Name or CreationTime field. The default is - // CreationTime. + // CreationTime . SortBy types.MonitoringJobDefinitionSortKey // Whether to sort the results in Ascending or Descending order. The default is - // Descending. + // Descending . SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListModelCardExportJobs.go b/service/sagemaker/api_op_ListModelCardExportJobs.go index c7717f95c49..72844bae221 100644 --- a/service/sagemaker/api_op_ListModelCardExportJobs.go +++ b/service/sagemaker/api_op_ListModelCardExportJobs.go @@ -51,9 +51,9 @@ type ListModelCardExportJobsInput struct { // List export jobs for the model card with the specified version. ModelCardVersion int32 - // If the response to a previous ListModelCardExportJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of model card export - // jobs, use the token in the next request. + // If the response to a previous ListModelCardExportJobs request was truncated, + // the response includes a NextToken . To retrieve the next set of model card + // export jobs, use the token in the next request. NextToken *string // Sort model card export jobs by either name or creation time. Sorts by creation @@ -76,8 +76,8 @@ type ListModelCardExportJobsOutput struct { // This member is required. ModelCardExportJobSummaries []types.ModelCardExportJobSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of model card export jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model card export jobs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelCardVersions.go b/service/sagemaker/api_op_ListModelCardVersions.go index e62c6d9f54a..1e4b40c0418 100644 --- a/service/sagemaker/api_op_ListModelCardVersions.go +++ b/service/sagemaker/api_op_ListModelCardVersions.go @@ -49,7 +49,7 @@ type ListModelCardVersionsInput struct { ModelCardStatus types.ModelCardStatus // If the response to a previous ListModelCardVersions request was truncated, the - // response includes a NextToken. To retrieve the next set of model card versions, + // response includes a NextToken . To retrieve the next set of model card versions, // use the token in the next request. NextToken *string @@ -69,8 +69,8 @@ type ListModelCardVersionsOutput struct { // This member is required. ModelCardVersionSummaryList []types.ModelCardVersionSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of model card versions, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model card versions, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelCards.go b/service/sagemaker/api_op_ListModelCards.go index d59b278906f..0a2c5e46dfe 100644 --- a/service/sagemaker/api_op_ListModelCards.go +++ b/service/sagemaker/api_op_ListModelCards.go @@ -46,9 +46,9 @@ type ListModelCardsInput struct { // Only list model cards with names that contain the specified string. NameContains *string - // If the response to a previous ListModelCards request was truncated, the response - // includes a NextToken. To retrieve the next set of model cards, use the token in - // the next request. + // If the response to a previous ListModelCards request was truncated, the + // response includes a NextToken . To retrieve the next set of model cards, use the + // token in the next request. NextToken *string // Sort model cards by either name or creation time. Sorts by creation time by @@ -68,8 +68,8 @@ type ListModelCardsOutput struct { // This member is required. ModelCardSummaries []types.ModelCardSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of model cards, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model cards, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelExplainabilityJobDefinitions.go b/service/sagemaker/api_op_ListModelExplainabilityJobDefinitions.go index 40221afea8a..d376dfd6e25 100644 --- a/service/sagemaker/api_op_ListModelExplainabilityJobDefinitions.go +++ b/service/sagemaker/api_op_ListModelExplainabilityJobDefinitions.go @@ -48,16 +48,16 @@ type ListModelExplainabilityJobDefinitionsInput struct { // Filter for model explainability jobs whose name contains a specified string. NameContains *string - // The token returned if the response is truncated. To retrieve the next set of job - // executions, use it in the next request. + // The token returned if the response is truncated. To retrieve the next set of + // job executions, use it in the next request. NextToken *string // Whether to sort results by the Name or CreationTime field. The default is - // CreationTime. + // CreationTime . SortBy types.MonitoringJobDefinitionSortKey // Whether to sort the results in Ascending or Descending order. The default is - // Descending. + // Descending . SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListModelPackageGroups.go b/service/sagemaker/api_op_ListModelPackageGroups.go index 93f52ef050f..d40e3b67a06 100644 --- a/service/sagemaker/api_op_ListModelPackageGroups.go +++ b/service/sagemaker/api_op_ListModelPackageGroups.go @@ -45,14 +45,14 @@ type ListModelPackageGroupsInput struct { NameContains *string // If the result of the previous ListModelPackageGroups request was truncated, the - // response includes a NextToken. To retrieve the next set of model groups, use the - // token in the next request. + // response includes a NextToken . To retrieve the next set of model groups, use + // the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.ModelPackageGroupSortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -65,8 +65,8 @@ type ListModelPackageGroupsOutput struct { // This member is required. ModelPackageGroupSummaryList []types.ModelPackageGroupSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of model groups, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model groups, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelPackages.go b/service/sagemaker/api_op_ListModelPackages.go index 90f741247cf..8255ec019ea 100644 --- a/service/sagemaker/api_op_ListModelPackages.go +++ b/service/sagemaker/api_op_ListModelPackages.go @@ -50,17 +50,12 @@ type ListModelPackagesInput struct { // group. ModelPackageGroupName *string - // A filter that returns only the model packages of the specified type. This can be - // one of the following values. - // - // * UNVERSIONED - List only unversioined models. - // This is the default value if no ModelPackageType is specified. - // - // * VERSIONED - - // List only versioned models. - // - // * BOTH - List both versioned and unversioned - // models. + // A filter that returns only the model packages of the specified type. This can + // be one of the following values. + // - UNVERSIONED - List only unversioined models. This is the default value if no + // ModelPackageType is specified. + // - VERSIONED - List only versioned models. + // - BOTH - List both versioned and unversioned models. ModelPackageType types.ModelPackageType // A string in the model package name. This filter returns only model packages @@ -68,14 +63,14 @@ type ListModelPackagesInput struct { NameContains *string // If the response to a previous ListModelPackages request was truncated, the - // response includes a NextToken. To retrieve the next set of model packages, use + // response includes a NextToken . To retrieve the next set of model packages, use // the token in the next request. NextToken *string - // The parameter by which to sort the results. The default is CreationTime. + // The parameter by which to sort the results. The default is CreationTime . SortBy types.ModelPackageSortBy - // The sort order for the results. The default is Ascending. + // The sort order for the results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -88,8 +83,8 @@ type ListModelPackagesOutput struct { // This member is required. ModelPackageSummaryList []types.ModelPackageSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of model packages, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model packages, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListModelQualityJobDefinitions.go b/service/sagemaker/api_op_ListModelQualityJobDefinitions.go index 15ef27e44a1..63cb59f4c63 100644 --- a/service/sagemaker/api_op_ListModelQualityJobDefinitions.go +++ b/service/sagemaker/api_op_ListModelQualityJobDefinitions.go @@ -44,7 +44,7 @@ type ListModelQualityJobDefinitionsInput struct { EndpointName *string // The maximum number of results to return in a call to - // ListModelQualityJobDefinitions. + // ListModelQualityJobDefinitions . MaxResults *int32 // A string in the transform job name. This filter returns only model quality @@ -52,14 +52,14 @@ type ListModelQualityJobDefinitionsInput struct { NameContains *string // If the result of the previous ListModelQualityJobDefinitions request was - // truncated, the response includes a NextToken. To retrieve the next set of model + // truncated, the response includes a NextToken . To retrieve the next set of model // quality monitoring job definitions, use the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.MonitoringJobDefinitionSortKey - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -155,7 +155,7 @@ var _ ListModelQualityJobDefinitionsAPIClient = (*Client)(nil) // ListModelQualityJobDefinitions type ListModelQualityJobDefinitionsPaginatorOptions struct { // The maximum number of results to return in a call to - // ListModelQualityJobDefinitions. + // ListModelQualityJobDefinitions . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_ListModels.go b/service/sagemaker/api_op_ListModels.go index b5224c0b7ca..6325baff61a 100644 --- a/service/sagemaker/api_op_ListModels.go +++ b/service/sagemaker/api_op_ListModels.go @@ -46,14 +46,14 @@ type ListModelsInput struct { NameContains *string // If the response to a previous ListModels request was truncated, the response - // includes a NextToken. To retrieve the next set of models, use the token in the + // includes a NextToken . To retrieve the next set of models, use the token in the // next request. NextToken *string - // Sorts the list of results. The default is CreationTime. + // Sorts the list of results. The default is CreationTime . SortBy types.ModelSortKey - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.OrderKey noSmithyDocumentSerde @@ -66,8 +66,8 @@ type ListModelsOutput struct { // This member is required. Models []types.ModelSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of models, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of models, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListMonitoringAlertHistory.go b/service/sagemaker/api_op_ListMonitoringAlertHistory.go index f86ed7ffe07..3c587a68c5c 100644 --- a/service/sagemaker/api_op_ListMonitoringAlertHistory.go +++ b/service/sagemaker/api_op_ListMonitoringAlertHistory.go @@ -47,15 +47,15 @@ type ListMonitoringAlertHistoryInput struct { MonitoringScheduleName *string // If the result of the previous ListMonitoringAlertHistory request was truncated, - // the response includes a NextToken. To retrieve the next set of alerts in the + // the response includes a NextToken . To retrieve the next set of alerts in the // history, use the token in the next request. NextToken *string - // The field used to sort results. The default is CreationTime. + // The field used to sort results. The default is CreationTime . SortBy types.MonitoringAlertHistorySortKey - // The sort order, whether Ascending or Descending, of the alert history. The - // default is Descending. + // The sort order, whether Ascending or Descending , of the alert history. The + // default is Descending . SortOrder types.SortOrder // A filter that retrieves only alerts with a specific status. @@ -69,8 +69,8 @@ type ListMonitoringAlertHistoryOutput struct { // An alert history for a model monitoring schedule. MonitoringAlertHistory []types.MonitoringAlertHistorySummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of alerts, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of alerts, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListMonitoringAlerts.go b/service/sagemaker/api_op_ListMonitoringAlerts.go index b6acb9e3add..dab0db9f622 100644 --- a/service/sagemaker/api_op_ListMonitoringAlerts.go +++ b/service/sagemaker/api_op_ListMonitoringAlerts.go @@ -39,7 +39,7 @@ type ListMonitoringAlertsInput struct { MaxResults *int32 // If the result of the previous ListMonitoringAlerts request was truncated, the - // response includes a NextToken. To retrieve the next set of alerts in the + // response includes a NextToken . To retrieve the next set of alerts in the // history, use the token in the next request. NextToken *string @@ -51,8 +51,8 @@ type ListMonitoringAlertsOutput struct { // A JSON array where each element is a summary for a monitoring alert. MonitoringAlertSummaries []types.MonitoringAlertSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of alerts, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of alerts, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListMonitoringExecutions.go b/service/sagemaker/api_op_ListMonitoringExecutions.go index a3ce989f000..0d11904150d 100644 --- a/service/sagemaker/api_op_ListMonitoringExecutions.go +++ b/service/sagemaker/api_op_ListMonitoringExecutions.go @@ -60,8 +60,8 @@ type ListMonitoringExecutionsInput struct { // type. MonitoringTypeEquals types.MonitoringType - // The token returned if the response is truncated. To retrieve the next set of job - // executions, use it in the next request. + // The token returned if the response is truncated. To retrieve the next set of + // job executions, use it in the next request. NextToken *string // Filter for jobs scheduled after a specified time. @@ -70,12 +70,12 @@ type ListMonitoringExecutionsInput struct { // Filter for jobs scheduled before a specified time. ScheduledTimeBefore *time.Time - // Whether to sort results by Status, CreationTime, ScheduledTime field. The - // default is CreationTime. + // Whether to sort results by Status , CreationTime , ScheduledTime field. The + // default is CreationTime . SortBy types.MonitoringExecutionSortKey // Whether to sort the results in Ascending or Descending order. The default is - // Descending. + // Descending . SortOrder types.SortOrder // A filter that retrieves only jobs with a specific status. diff --git a/service/sagemaker/api_op_ListMonitoringSchedules.go b/service/sagemaker/api_op_ListMonitoringSchedules.go index 820e0b3be58..39513501938 100644 --- a/service/sagemaker/api_op_ListMonitoringSchedules.go +++ b/service/sagemaker/api_op_ListMonitoringSchedules.go @@ -54,23 +54,23 @@ type ListMonitoringSchedulesInput struct { // definition. MonitoringJobDefinitionName *string - // A filter that returns only the monitoring schedules for the specified monitoring - // type. + // A filter that returns only the monitoring schedules for the specified + // monitoring type. MonitoringTypeEquals types.MonitoringType // Filter for monitoring schedules whose name contains a specified string. NameContains *string - // The token returned if the response is truncated. To retrieve the next set of job - // executions, use it in the next request. + // The token returned if the response is truncated. To retrieve the next set of + // job executions, use it in the next request. NextToken *string - // Whether to sort results by Status, CreationTime, ScheduledTime field. The - // default is CreationTime. + // Whether to sort results by Status , CreationTime , ScheduledTime field. The + // default is CreationTime . SortBy types.MonitoringScheduleSortKey // Whether to sort the results in Ascending or Descending order. The default is - // Descending. + // Descending . SortOrder types.SortOrder // A filter that returns only monitoring schedules modified before a specified diff --git a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go index 7887590bb49..c6dfaf38731 100644 --- a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go +++ b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go @@ -36,12 +36,12 @@ type ListNotebookInstanceLifecycleConfigsInput struct { // specified time (timestamp). CreationTimeAfter *time.Time - // A filter that returns only lifecycle configurations that were created before the - // specified time (timestamp). + // A filter that returns only lifecycle configurations that were created before + // the specified time (timestamp). CreationTimeBefore *time.Time - // A filter that returns only lifecycle configurations that were modified after the - // specified time (timestamp). + // A filter that returns only lifecycle configurations that were modified after + // the specified time (timestamp). LastModifiedTimeAfter *time.Time // A filter that returns only lifecycle configurations that were modified before @@ -51,16 +51,16 @@ type ListNotebookInstanceLifecycleConfigsInput struct { // The maximum number of lifecycle configurations to return in the response. MaxResults *int32 - // A string in the lifecycle configuration name. This filter returns only lifecycle - // configurations whose name contains the specified string. + // A string in the lifecycle configuration name. This filter returns only + // lifecycle configurations whose name contains the specified string. NameContains *string // If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, - // the response includes a NextToken. To get the next set of lifecycle + // the response includes a NextToken . To get the next set of lifecycle // configurations, use the token in the next request. NextToken *string - // Sorts the list of results. The default is CreationTime. + // Sorts the list of results. The default is CreationTime . SortBy types.NotebookInstanceLifecycleConfigSortKey // The sort order for results. diff --git a/service/sagemaker/api_op_ListNotebookInstances.go b/service/sagemaker/api_op_ListNotebookInstances.go index b231559b023..ad14b6c0e83 100644 --- a/service/sagemaker/api_op_ListNotebookInstances.go +++ b/service/sagemaker/api_op_ListNotebookInstances.go @@ -13,8 +13,8 @@ import ( "time" ) -// Returns a list of the SageMaker notebook instances in the requester's account in -// an Amazon Web Services Region. +// Returns a list of the SageMaker notebook instances in the requester's account +// in an Amazon Web Services Region. func (c *Client) ListNotebookInstances(ctx context.Context, params *ListNotebookInstancesInput, optFns ...func(*Options)) (*ListNotebookInstancesOutput, error) { if params == nil { params = &ListNotebookInstancesInput{} @@ -32,8 +32,8 @@ func (c *Client) ListNotebookInstances(ctx context.Context, params *ListNotebook type ListNotebookInstancesInput struct { - // A filter that returns only notebook instances with associated with the specified - // git repository. + // A filter that returns only notebook instances with associated with the + // specified git repository. AdditionalCodeRepositoryEquals *string // A filter that returns only notebook instances that were created after the @@ -65,7 +65,7 @@ type ListNotebookInstancesInput struct { NameContains *string // If the previous call to the ListNotebookInstances is truncated, the response - // includes a NextToken. You can use this token in your subsequent + // includes a NextToken . You can use this token in your subsequent // ListNotebookInstances request to fetch the next set of notebook instances. You // might specify a filter or a sort order in your request. When response is // truncated, you must use the same values for the filer and sort order in the next @@ -78,7 +78,7 @@ type ListNotebookInstancesInput struct { // specified string. NotebookInstanceLifecycleConfigNameContains *string - // The field to sort results by. The default is Name. + // The field to sort results by. The default is Name . SortBy types.NotebookInstanceSortKey // The sort order for results. diff --git a/service/sagemaker/api_op_ListPipelineExecutionSteps.go b/service/sagemaker/api_op_ListPipelineExecutionSteps.go index 299abbf5c8e..309d0bc61e3 100644 --- a/service/sagemaker/api_op_ListPipelineExecutionSteps.go +++ b/service/sagemaker/api_op_ListPipelineExecutionSteps.go @@ -34,14 +34,14 @@ type ListPipelineExecutionStepsInput struct { MaxResults *int32 // If the result of the previous ListPipelineExecutionSteps request was truncated, - // the response includes a NextToken. To retrieve the next set of pipeline + // the response includes a NextToken . To retrieve the next set of pipeline // execution steps, use the token in the next request. NextToken *string // The Amazon Resource Name (ARN) of the pipeline execution. PipelineExecutionArn *string - // The field by which to sort results. The default is CreatedTime. + // The field by which to sort results. The default is CreatedTime . SortOrder types.SortOrder noSmithyDocumentSerde @@ -50,7 +50,7 @@ type ListPipelineExecutionStepsInput struct { type ListPipelineExecutionStepsOutput struct { // If the result of the previous ListPipelineExecutionSteps request was truncated, - // the response includes a NextToken. To retrieve the next set of pipeline + // the response includes a NextToken . To retrieve the next set of pipeline // execution steps, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListPipelineExecutions.go b/service/sagemaker/api_op_ListPipelineExecutions.go index 0c6b630e24d..93ccc95b454 100644 --- a/service/sagemaker/api_op_ListPipelineExecutions.go +++ b/service/sagemaker/api_op_ListPipelineExecutions.go @@ -48,11 +48,11 @@ type ListPipelineExecutionsInput struct { MaxResults *int32 // If the result of the previous ListPipelineExecutions request was truncated, the - // response includes a NextToken. To retrieve the next set of pipeline executions, + // response includes a NextToken . To retrieve the next set of pipeline executions, // use the token in the next request. NextToken *string - // The field by which to sort results. The default is CreatedTime. + // The field by which to sort results. The default is CreatedTime . SortBy types.SortPipelineExecutionsBy // The sort order for results. @@ -64,7 +64,7 @@ type ListPipelineExecutionsInput struct { type ListPipelineExecutionsOutput struct { // If the result of the previous ListPipelineExecutions request was truncated, the - // response includes a NextToken. To retrieve the next set of pipeline executions, + // response includes a NextToken . To retrieve the next set of pipeline executions, // use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListPipelineParametersForExecution.go b/service/sagemaker/api_op_ListPipelineParametersForExecution.go index 65ac490c43f..84698b25685 100644 --- a/service/sagemaker/api_op_ListPipelineParametersForExecution.go +++ b/service/sagemaker/api_op_ListPipelineParametersForExecution.go @@ -39,7 +39,7 @@ type ListPipelineParametersForExecutionInput struct { MaxResults *int32 // If the result of the previous ListPipelineParametersForExecution request was - // truncated, the response includes a NextToken. To retrieve the next set of + // truncated, the response includes a NextToken . To retrieve the next set of // parameters, use the token in the next request. NextToken *string @@ -49,7 +49,7 @@ type ListPipelineParametersForExecutionInput struct { type ListPipelineParametersForExecutionOutput struct { // If the result of the previous ListPipelineParametersForExecution request was - // truncated, the response includes a NextToken. To retrieve the next set of + // truncated, the response includes a NextToken . To retrieve the next set of // parameters, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListPipelines.go b/service/sagemaker/api_op_ListPipelines.go index 9dee4f44fd3..6c1808eb9ee 100644 --- a/service/sagemaker/api_op_ListPipelines.go +++ b/service/sagemaker/api_op_ListPipelines.go @@ -41,14 +41,14 @@ type ListPipelinesInput struct { MaxResults *int32 // If the result of the previous ListPipelines request was truncated, the response - // includes a NextToken. To retrieve the next set of pipelines, use the token in + // includes a NextToken . To retrieve the next set of pipelines, use the token in // the next request. NextToken *string // The prefix of the pipeline name. PipelineNamePrefix *string - // The field by which to sort results. The default is CreatedTime. + // The field by which to sort results. The default is CreatedTime . SortBy types.SortPipelinesBy // The sort order for results. @@ -60,7 +60,7 @@ type ListPipelinesInput struct { type ListPipelinesOutput struct { // If the result of the previous ListPipelines request was truncated, the response - // includes a NextToken. To retrieve the next set of pipelines, use the token in + // includes a NextToken . To retrieve the next set of pipelines, use the token in // the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListProcessingJobs.go b/service/sagemaker/api_op_ListProcessingJobs.go index 9a70f7943c5..e75d2bbebd7 100644 --- a/service/sagemaker/api_op_ListProcessingJobs.go +++ b/service/sagemaker/api_op_ListProcessingJobs.go @@ -51,14 +51,14 @@ type ListProcessingJobsInput struct { NameContains *string // If the result of the previous ListProcessingJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of processing jobs, use + // response includes a NextToken . To retrieve the next set of processing jobs, use // the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.SortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that retrieves only processing jobs with a specific status. diff --git a/service/sagemaker/api_op_ListProjects.go b/service/sagemaker/api_op_ListProjects.go index 15a961e612e..a545bbca4ef 100644 --- a/service/sagemaker/api_op_ListProjects.go +++ b/service/sagemaker/api_op_ListProjects.go @@ -44,14 +44,14 @@ type ListProjectsInput struct { NameContains *string // If the result of the previous ListProjects request was truncated, the response - // includes a NextToken. To retrieve the next set of projects, use the token in the - // next request. + // includes a NextToken . To retrieve the next set of projects, use the token in + // the next request. NextToken *string - // The field by which to sort results. The default is CreationTime. + // The field by which to sort results. The default is CreationTime . SortBy types.ProjectSortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.ProjectSortOrder noSmithyDocumentSerde @@ -65,7 +65,7 @@ type ListProjectsOutput struct { ProjectSummaryList []types.ProjectSummary // If the result of the previous ListCompilationJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of model compilation + // response includes a NextToken . To retrieve the next set of model compilation // jobs, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListSpaces.go b/service/sagemaker/api_op_ListSpaces.go index 0ea41655554..374a72741e3 100644 --- a/service/sagemaker/api_op_ListSpaces.go +++ b/service/sagemaker/api_op_ListSpaces.go @@ -40,10 +40,10 @@ type ListSpacesInput struct { // your next request to receive the next set of results. NextToken *string - // The parameter by which to sort the results. The default is CreationTime. + // The parameter by which to sort the results. The default is CreationTime . SortBy types.SpaceSortKey - // The sort order for the results. The default is Ascending. + // The sort order for the results. The default is Ascending . SortOrder types.SortOrder // A parameter by which to filter the results. diff --git a/service/sagemaker/api_op_ListStageDevices.go b/service/sagemaker/api_op_ListStageDevices.go index 3d696f2de75..57577a125c9 100644 --- a/service/sagemaker/api_op_ListStageDevices.go +++ b/service/sagemaker/api_op_ListStageDevices.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists devices allocated to the stage, containing detailed device information and -// deployment status. +// Lists devices allocated to the stage, containing detailed device information +// and deployment status. func (c *Client) ListStageDevices(ctx context.Context, params *ListStageDevicesInput, optFns ...func(*Options)) (*ListStageDevicesOutput, error) { if params == nil { params = &ListStageDevicesInput{} diff --git a/service/sagemaker/api_op_ListStudioLifecycleConfigs.go b/service/sagemaker/api_op_ListStudioLifecycleConfigs.go index 5cbf604d1fb..6dbf5b9dc71 100644 --- a/service/sagemaker/api_op_ListStudioLifecycleConfigs.go +++ b/service/sagemaker/api_op_ListStudioLifecycleConfigs.go @@ -43,25 +43,25 @@ type ListStudioLifecycleConfigsInput struct { // specified time. CreationTimeBefore *time.Time - // The maximum number of Studio Lifecycle Configurations to return in the response. - // The default value is 10. + // The maximum number of Studio Lifecycle Configurations to return in the + // response. The default value is 10. MaxResults *int32 - // A filter that returns only Lifecycle Configurations modified after the specified - // time. + // A filter that returns only Lifecycle Configurations modified after the + // specified time. ModifiedTimeAfter *time.Time // A filter that returns only Lifecycle Configurations modified before the // specified time. ModifiedTimeBefore *time.Time - // A string in the Lifecycle Configuration name. This filter returns only Lifecycle - // Configurations whose name contains the specified string. + // A string in the Lifecycle Configuration name. This filter returns only + // Lifecycle Configurations whose name contains the specified string. NameContains *string - // If the previous call to ListStudioLifecycleConfigs didn't return the full set of - // Lifecycle Configurations, the call returns a token for getting the next set of - // Lifecycle Configurations. + // If the previous call to ListStudioLifecycleConfigs didn't return the full set + // of Lifecycle Configurations, the call returns a token for getting the next set + // of Lifecycle Configurations. NextToken *string // The property used to sort results. The default value is CreationTime. @@ -158,8 +158,8 @@ var _ ListStudioLifecycleConfigsAPIClient = (*Client)(nil) // ListStudioLifecycleConfigsPaginatorOptions is the paginator options for // ListStudioLifecycleConfigs type ListStudioLifecycleConfigsPaginatorOptions struct { - // The maximum number of Studio Lifecycle Configurations to return in the response. - // The default value is 10. + // The maximum number of Studio Lifecycle Configurations to return in the + // response. The default value is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_ListSubscribedWorkteams.go b/service/sagemaker/api_op_ListSubscribedWorkteams.go index 81f215209c6..f206d01072c 100644 --- a/service/sagemaker/api_op_ListSubscribedWorkteams.go +++ b/service/sagemaker/api_op_ListSubscribedWorkteams.go @@ -39,9 +39,9 @@ type ListSubscribedWorkteamsInput struct { // contains the specified string. NameContains *string - // If the result of the previous ListSubscribedWorkteams request was truncated, the - // response includes a NextToken. To retrieve the next set of labeling jobs, use - // the token in the next request. + // If the result of the previous ListSubscribedWorkteams request was truncated, + // the response includes a NextToken . To retrieve the next set of labeling jobs, + // use the token in the next request. NextToken *string noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListTags.go b/service/sagemaker/api_op_ListTags.go index c78e3ff2842..8162130130e 100644 --- a/service/sagemaker/api_op_ListTags.go +++ b/service/sagemaker/api_op_ListTags.go @@ -38,8 +38,9 @@ type ListTagsInput struct { // Maximum number of tags to return. MaxResults *int32 - // If the response to the previous ListTags request is truncated, SageMaker returns - // this token. To retrieve the next set of tags, use it in the subsequent request. + // If the response to the previous ListTags request is truncated, SageMaker + // returns this token. To retrieve the next set of tags, use it in the subsequent + // request. NextToken *string noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListTrainingJobs.go b/service/sagemaker/api_op_ListTrainingJobs.go index 9d615e0b4c0..42d91e4942e 100644 --- a/service/sagemaker/api_op_ListTrainingJobs.go +++ b/service/sagemaker/api_op_ListTrainingJobs.go @@ -15,14 +15,15 @@ import ( // Lists training jobs. When StatusEquals and MaxResults are set at the same time, // the MaxResults number of training jobs are first retrieved ignoring the -// StatusEquals parameter and then they are filtered by the StatusEquals parameter, -// which is returned as a response. For example, if ListTrainingJobs is invoked -// with the following parameters: { ... MaxResults: 100, StatusEquals: InProgress -// ... } First, 100 trainings jobs with any status, including those other than -// InProgress, are selected (sorted according to the creation time, from the most -// current to the oldest). Next, those with a status of InProgress are returned. -// You can quickly test the API using the following Amazon Web Services CLI code. -// aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress +// StatusEquals parameter and then they are filtered by the StatusEquals +// parameter, which is returned as a response. For example, if ListTrainingJobs is +// invoked with the following parameters: { ... MaxResults: 100, StatusEquals: +// InProgress ... } First, 100 trainings jobs with any status, including those +// other than InProgress , are selected (sorted according to the creation time, +// from the most current to the oldest). Next, those with a status of InProgress +// are returned. You can quickly test the API using the following Amazon Web +// Services CLI code. aws sagemaker list-training-jobs --max-results 100 +// --status-equals InProgress func (c *Client) ListTrainingJobs(ctx context.Context, params *ListTrainingJobsInput, optFns ...func(*Options)) (*ListTrainingJobsOutput, error) { if params == nil { params = &ListTrainingJobsInput{} @@ -64,14 +65,14 @@ type ListTrainingJobsInput struct { NameContains *string // If the result of the previous ListTrainingJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of training jobs, use + // response includes a NextToken . To retrieve the next set of training jobs, use // the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.SortBy - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that retrieves only training jobs with a specific status. @@ -90,8 +91,8 @@ type ListTrainingJobsOutput struct { // This member is required. TrainingJobSummaries []types.TrainingJobSummary - // If the response is truncated, SageMaker returns this token. To retrieve the next - // set of training jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of training jobs, use it in the subsequent request. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go index e79715d5ec3..6eb907b2b8f 100644 --- a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of TrainingJobSummary objects that describe the training jobs that a -// hyperparameter tuning job launched. +// Gets a list of TrainingJobSummary objects that describe the training jobs that +// a hyperparameter tuning job launched. func (c *Client) ListTrainingJobsForHyperParameterTuningJob(ctx context.Context, params *ListTrainingJobsForHyperParameterTuningJobInput, optFns ...func(*Options)) (*ListTrainingJobsForHyperParameterTuningJobOutput, error) { if params == nil { params = &ListTrainingJobsForHyperParameterTuningJobInput{} @@ -39,17 +39,17 @@ type ListTrainingJobsForHyperParameterTuningJobInput struct { // The maximum number of training jobs to return. The default value is 10. MaxResults *int32 - // If the result of the previous ListTrainingJobsForHyperParameterTuningJob request - // was truncated, the response includes a NextToken. To retrieve the next set of - // training jobs, use the token in the next request. + // If the result of the previous ListTrainingJobsForHyperParameterTuningJob + // request was truncated, the response includes a NextToken . To retrieve the next + // set of training jobs, use the token in the next request. NextToken *string - // The field to sort results by. The default is Name. If the value of this field is - // FinalObjectiveMetricValue, any training jobs that did not return an objective - // metric are not listed. + // The field to sort results by. The default is Name . If the value of this field + // is FinalObjectiveMetricValue , any training jobs that did not return an + // objective metric are not listed. SortBy types.TrainingJobSortByOptions - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder // A filter that returns only training jobs with the specified status. @@ -67,7 +67,7 @@ type ListTrainingJobsForHyperParameterTuningJobOutput struct { TrainingJobSummaries []types.HyperParameterTrainingJobSummary // If the result of this ListTrainingJobsForHyperParameterTuningJob request was - // truncated, the response includes a NextToken. To retrieve the next set of + // truncated, the response includes a NextToken . To retrieve the next set of // training jobs, use the token in the next request. NextToken *string diff --git a/service/sagemaker/api_op_ListTransformJobs.go b/service/sagemaker/api_op_ListTransformJobs.go index aab82de07c0..0fa25ba77bd 100644 --- a/service/sagemaker/api_op_ListTransformJobs.go +++ b/service/sagemaker/api_op_ListTransformJobs.go @@ -44,7 +44,7 @@ type ListTransformJobsInput struct { LastModifiedTimeBefore *time.Time // The maximum number of transform jobs to return in the response. The default - // value is 10. + // value is 10 . MaxResults *int32 // A string in the transform job name. This filter returns only transform jobs @@ -52,14 +52,14 @@ type ListTransformJobsInput struct { NameContains *string // If the result of the previous ListTransformJobs request was truncated, the - // response includes a NextToken. To retrieve the next set of transform jobs, use + // response includes a NextToken . To retrieve the next set of transform jobs, use // the token in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.SortBy - // The sort order for results. The default is Descending. + // The sort order for results. The default is Descending . SortOrder types.SortOrder // A filter that retrieves only transform jobs with a specific status. @@ -156,7 +156,7 @@ var _ ListTransformJobsAPIClient = (*Client)(nil) // ListTransformJobsPaginatorOptions is the paginator options for ListTransformJobs type ListTransformJobsPaginatorOptions struct { // The maximum number of transform jobs to return in the response. The default - // value is 10. + // value is 10 . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_ListTrialComponents.go b/service/sagemaker/api_op_ListTrialComponents.go index e155f12aa5c..6b2a58efe60 100644 --- a/service/sagemaker/api_op_ListTrialComponents.go +++ b/service/sagemaker/api_op_ListTrialComponents.go @@ -17,12 +17,9 @@ import ( // component name or creation time. You can filter the list to show only components // that were created in a specific time range. You can also filter on one of the // following: -// -// * ExperimentName -// -// * SourceArn -// -// * TrialName +// - ExperimentName +// - SourceArn +// - TrialName func (c *Client) ListTrialComponents(ctx context.Context, params *ListTrialComponentsInput, optFns ...func(*Options)) (*ListTrialComponentsOutput, error) { if params == nil { params = &ListTrialComponentsInput{} @@ -46,31 +43,32 @@ type ListTrialComponentsInput struct { // A filter that returns only components created before the specified time. CreatedBefore *time.Time - // A filter that returns only components that are part of the specified experiment. - // If you specify ExperimentName, you can't filter by SourceArn or TrialName. + // A filter that returns only components that are part of the specified + // experiment. If you specify ExperimentName , you can't filter by SourceArn or + // TrialName . ExperimentName *string - // The maximum number of components to return in the response. The default value is - // 10. + // The maximum number of components to return in the response. The default value + // is 10. MaxResults *int32 // If the previous call to ListTrialComponents didn't return the full set of // components, the call returns a token for getting the next set of components. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortTrialComponentsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only components that have the specified source Amazon - // Resource Name (ARN). If you specify SourceArn, you can't filter by - // ExperimentName or TrialName. + // Resource Name (ARN). If you specify SourceArn , you can't filter by + // ExperimentName or TrialName . SourceArn *string // A filter that returns only components that are part of the specified trial. If - // you specify TrialName, you can't filter by ExperimentName or SourceArn. + // you specify TrialName , you can't filter by ExperimentName or SourceArn . TrialName *string noSmithyDocumentSerde @@ -150,8 +148,8 @@ func (c *Client) addOperationListTrialComponentsMiddlewares(stack *middleware.St return nil } -// ListTrialComponentsAPIClient is a client that implements the ListTrialComponents -// operation. +// ListTrialComponentsAPIClient is a client that implements the +// ListTrialComponents operation. type ListTrialComponentsAPIClient interface { ListTrialComponents(context.Context, *ListTrialComponentsInput, ...func(*Options)) (*ListTrialComponentsOutput, error) } @@ -161,8 +159,8 @@ var _ ListTrialComponentsAPIClient = (*Client)(nil) // ListTrialComponentsPaginatorOptions is the paginator options for // ListTrialComponents type ListTrialComponentsPaginatorOptions struct { - // The maximum number of components to return in the response. The default value is - // 10. + // The maximum number of components to return in the response. The default value + // is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_ListTrials.go b/service/sagemaker/api_op_ListTrials.go index 5a8a7a3c33e..3dc76fe1773 100644 --- a/service/sagemaker/api_op_ListTrials.go +++ b/service/sagemaker/api_op_ListTrials.go @@ -51,10 +51,10 @@ type ListTrialsInput struct { // call returns a token for getting the next set of trials. NextToken *string - // The property used to sort results. The default value is CreationTime. + // The property used to sort results. The default value is CreationTime . SortBy types.SortTrialsBy - // The sort order. The default value is Descending. + // The sort order. The default value is Descending . SortOrder types.SortOrder // A filter that returns only trials that are associated with the specified trial diff --git a/service/sagemaker/api_op_ListWorkteams.go b/service/sagemaker/api_op_ListWorkteams.go index 197450625b3..3d6c1fb752f 100644 --- a/service/sagemaker/api_op_ListWorkteams.go +++ b/service/sagemaker/api_op_ListWorkteams.go @@ -35,19 +35,19 @@ type ListWorkteamsInput struct { // The maximum number of work teams to return in each page of the response. MaxResults *int32 - // A string in the work team's name. This filter returns only work teams whose name - // contains the specified string. + // A string in the work team's name. This filter returns only work teams whose + // name contains the specified string. NameContains *string // If the result of the previous ListWorkteams request was truncated, the response - // includes a NextToken. To retrieve the next set of labeling jobs, use the token + // includes a NextToken . To retrieve the next set of labeling jobs, use the token // in the next request. NextToken *string - // The field to sort results by. The default is CreationTime. + // The field to sort results by. The default is CreationTime . SortBy types.ListWorkteamsSortByOptions - // The sort order for results. The default is Ascending. + // The sort order for results. The default is Ascending . SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_PutModelPackageGroupPolicy.go b/service/sagemaker/api_op_PutModelPackageGroupPolicy.go index 06a60ca91f9..fbb61eecf68 100644 --- a/service/sagemaker/api_op_PutModelPackageGroupPolicy.go +++ b/service/sagemaker/api_op_PutModelPackageGroupPolicy.go @@ -11,8 +11,7 @@ import ( ) // Adds a resouce policy to control access to a model group. For information about -// resoure policies, see Identity-based policies and resource-based policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) +// resoure policies, see Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) // in the Amazon Web Services Identity and Access Management User Guide.. func (c *Client) PutModelPackageGroupPolicy(ctx context.Context, params *PutModelPackageGroupPolicyInput, optFns ...func(*Options)) (*PutModelPackageGroupPolicyOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_QueryLineage.go b/service/sagemaker/api_op_QueryLineage.go index 73f56f554cb..ddda73e9cb4 100644 --- a/service/sagemaker/api_op_QueryLineage.go +++ b/service/sagemaker/api_op_QueryLineage.go @@ -13,8 +13,7 @@ import ( ) // Use this action to inspect your lineage and discover relationships between -// entities. For more information, see Querying Lineage Entities -// (https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html) +// entities. For more information, see Querying Lineage Entities (https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html) // in the Amazon SageMaker Developer Guide. func (c *Client) QueryLineage(ctx context.Context, params *QueryLineageInput, optFns ...func(*Options)) (*QueryLineageOutput, error) { if params == nil { @@ -37,27 +36,18 @@ type QueryLineageInput struct { // determines the direction from the StartArn(s) that the query traverses. Direction types.Direction - // A set of filtering parameters that allow you to specify which entities should be - // returned. - // - // * Properties - Key-value pairs to match on the lineage entities' - // properties. - // - // * LineageTypes - A set of lineage entity types to match on. For - // example: TrialComponent, Artifact, or Context. - // - // * CreatedBefore - Filter - // entities created before this date. - // - // * ModifiedBefore - Filter entities modified - // before this date. - // - // * ModifiedAfter - Filter entities modified after this date. + // A set of filtering parameters that allow you to specify which entities should + // be returned. + // - Properties - Key-value pairs to match on the lineage entities' properties. + // - LineageTypes - A set of lineage entity types to match on. For example: + // TrialComponent , Artifact , or Context . + // - CreatedBefore - Filter entities created before this date. + // - ModifiedBefore - Filter entities modified before this date. + // - ModifiedAfter - Filter entities modified after this date. Filters *types.QueryFilters // Setting this value to True retrieves not only the entities of interest but also - // the Associations - // (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) + // the Associations (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) // and lineage entities on the path. Set to False to only return lineage entities // that match your query. IncludeEdges bool @@ -67,12 +57,12 @@ type QueryLineageInput struct { // entity to the matched results. MaxDepth *int32 - // Limits the number of vertices in the results. Use the NextToken in a response to - // to retrieve the next page of results. + // Limits the number of vertices in the results. Use the NextToken in a response + // to to retrieve the next page of results. MaxResults *int32 - // Limits the number of vertices in the request. Use the NextToken in a response to - // to retrieve the next page of results. + // Limits the number of vertices in the request. Use the NextToken in a response + // to to retrieve the next page of results. NextToken *string // A list of resource Amazon Resource Name (ARN) that represent the starting point @@ -169,8 +159,8 @@ var _ QueryLineageAPIClient = (*Client)(nil) // QueryLineagePaginatorOptions is the paginator options for QueryLineage type QueryLineagePaginatorOptions struct { - // Limits the number of vertices in the results. Use the NextToken in a response to - // to retrieve the next page of results. + // Limits the number of vertices in the results. Use the NextToken in a response + // to to retrieve the next page of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_RenderUiTemplate.go b/service/sagemaker/api_op_RenderUiTemplate.go index b1ab198b302..099086572b6 100644 --- a/service/sagemaker/api_op_RenderUiTemplate.go +++ b/service/sagemaker/api_op_RenderUiTemplate.go @@ -42,7 +42,7 @@ type RenderUiTemplateInput struct { // The HumanTaskUiArn of the worker UI that you want to render. Do not provide a // HumanTaskUiArn if you use the UiTemplate parameter. See a list of available - // Human Ui Amazon Resource Names (ARNs) in UiConfig. + // Human Ui Amazon Resource Names (ARNs) in UiConfig . HumanTaskUiArn *string // A Template object containing the worker UI template to render. diff --git a/service/sagemaker/api_op_RetryPipelineExecution.go b/service/sagemaker/api_op_RetryPipelineExecution.go index 2697c8e51b9..62b6f3a532c 100644 --- a/service/sagemaker/api_op_RetryPipelineExecution.go +++ b/service/sagemaker/api_op_RetryPipelineExecution.go @@ -41,8 +41,8 @@ type RetryPipelineExecutionInput struct { // This member is required. PipelineExecutionArn *string - // This configuration, if specified, overrides the parallelism configuration of the - // parent pipeline. + // This configuration, if specified, overrides the parallelism configuration of + // the parent pipeline. ParallelismConfiguration *types.ParallelismConfiguration noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_Search.go b/service/sagemaker/api_op_Search.go index 6891012ff9e..34a05f86465 100644 --- a/service/sagemaker/api_op_Search.go +++ b/service/sagemaker/api_op_Search.go @@ -17,8 +17,7 @@ import ( // search results by any resource property in a ascending or descending order. You // can query against the following value types: numeric, text, Boolean, and // timestamp. The Search API may provide access to otherwise restricted data. See -// Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference -// (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) +// Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) // for more information. func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error) { if params == nil { @@ -45,23 +44,23 @@ type SearchInput struct { // The maximum number of results to return. MaxResults *int32 - // If more than MaxResults resources match the specified SearchExpression, the - // response includes a NextToken. The NextToken can be passed to the next + // If more than MaxResults resources match the specified SearchExpression , the + // response includes a NextToken . The NextToken can be passed to the next // SearchRequest to continue retrieving results. NextToken *string // A Boolean conditional statement. Resources must satisfy this condition to be // included in search results. You must provide at least one subexpression, filter, - // or nested filter. The maximum number of recursive SubExpressions, NestedFilters, - // and Filters that can be included in a SearchExpression object is 50. + // or nested filter. The maximum number of recursive SubExpressions , NestedFilters + // , and Filters that can be included in a SearchExpression object is 50. SearchExpression *types.SearchExpression - // The name of the resource property used to sort the SearchResults. The default is - // LastModifiedTime. + // The name of the resource property used to sort the SearchResults . The default + // is LastModifiedTime . SortBy *string - // How SearchResults are ordered. Valid values are Ascending or Descending. The - // default is Descending. + // How SearchResults are ordered. Valid values are Ascending or Descending . The + // default is Descending . SortOrder types.SearchSortOrder noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_SendPipelineExecutionStepFailure.go b/service/sagemaker/api_op_SendPipelineExecutionStepFailure.go index e9387387a71..0379d2e4023 100644 --- a/service/sagemaker/api_op_SendPipelineExecutionStepFailure.go +++ b/service/sagemaker/api_op_SendPipelineExecutionStepFailure.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Notifies the pipeline that the execution of a callback step failed, along with a -// message describing why. When a callback step is run, the pipeline generates a +// Notifies the pipeline that the execution of a callback step failed, along with +// a message describing why. When a callback step is run, the pipeline generates a // callback token and includes the token in a message sent to Amazon Simple Queue // Service (Amazon SQS). func (c *Client) SendPipelineExecutionStepFailure(ctx context.Context, params *SendPipelineExecutionStepFailureInput, optFns ...func(*Options)) (*SendPipelineExecutionStepFailureOutput, error) { diff --git a/service/sagemaker/api_op_StartMonitoringSchedule.go b/service/sagemaker/api_op_StartMonitoringSchedule.go index fdcd8717813..848cd4f5498 100644 --- a/service/sagemaker/api_op_StartMonitoringSchedule.go +++ b/service/sagemaker/api_op_StartMonitoringSchedule.go @@ -12,7 +12,7 @@ import ( // Starts a previously stopped monitoring schedule. By default, when you // successfully create a new schedule, the status of a monitoring schedule is -// scheduled. +// scheduled . func (c *Client) StartMonitoringSchedule(ctx context.Context, params *StartMonitoringScheduleInput, optFns ...func(*Options)) (*StartMonitoringScheduleOutput, error) { if params == nil { params = &StartMonitoringScheduleInput{} diff --git a/service/sagemaker/api_op_StartNotebookInstance.go b/service/sagemaker/api_op_StartNotebookInstance.go index 5261b21a896..0d1dda8ff32 100644 --- a/service/sagemaker/api_op_StartNotebookInstance.go +++ b/service/sagemaker/api_op_StartNotebookInstance.go @@ -12,7 +12,7 @@ import ( // Launches an ML compute instance with the latest version of the libraries and // attaches your ML storage volume. After configuring the notebook instance, -// SageMaker sets the notebook instance status to InService. A notebook instance's +// SageMaker sets the notebook instance status to InService . A notebook instance's // status must be InService before you can connect to your Jupyter notebook. func (c *Client) StartNotebookInstance(ctx context.Context, params *StartNotebookInstanceInput, optFns ...func(*Options)) (*StartNotebookInstanceOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_StartPipelineExecution.go b/service/sagemaker/api_op_StartPipelineExecution.go index 24a5d184a1e..ba4fb2d900b 100644 --- a/service/sagemaker/api_op_StartPipelineExecution.go +++ b/service/sagemaker/api_op_StartPipelineExecution.go @@ -41,8 +41,8 @@ type StartPipelineExecutionInput struct { // This member is required. PipelineName *string - // This configuration, if specified, overrides the parallelism configuration of the - // parent pipeline for this specific run. + // This configuration, if specified, overrides the parallelism configuration of + // the parent pipeline for this specific run. ParallelismConfiguration *types.ParallelismConfiguration // The description of the pipeline execution. diff --git a/service/sagemaker/api_op_StopCompilationJob.go b/service/sagemaker/api_op_StopCompilationJob.go index b476a099c5f..8ac51f3a2bc 100644 --- a/service/sagemaker/api_op_StopCompilationJob.go +++ b/service/sagemaker/api_op_StopCompilationJob.go @@ -14,9 +14,9 @@ import ( // algorithm the SIGTERM signal. This gracefully shuts the job down. If the job // hasn't stopped, it sends the SIGKILL signal. When it receives a // StopCompilationJob request, Amazon SageMaker changes the -// CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon +// CompilationJobSummary$CompilationJobStatus of the job to Stopping . After Amazon // SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus -// to Stopped. +// to Stopped . func (c *Client) StopCompilationJob(ctx context.Context, params *StopCompilationJobInput, optFns ...func(*Options)) (*StopCompilationJobOutput, error) { if params == nil { params = &StopCompilationJobInput{} diff --git a/service/sagemaker/api_op_StopHyperParameterTuningJob.go b/service/sagemaker/api_op_StopHyperParameterTuningJob.go index 87ac533bf44..275075a0439 100644 --- a/service/sagemaker/api_op_StopHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_StopHyperParameterTuningJob.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a running hyperparameter tuning job and all running training jobs that the -// tuning job launched. All model artifacts output from the training jobs are +// Stops a running hyperparameter tuning job and all running training jobs that +// the tuning job launched. All model artifacts output from the training jobs are // stored in Amazon Simple Storage Service (Amazon S3). All data that the training // jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After // the tuning job moves to the Stopped state, it releases all reserved resources diff --git a/service/sagemaker/api_op_StopInferenceExperiment.go b/service/sagemaker/api_op_StopInferenceExperiment.go index dd117143b2f..523b53f7a16 100644 --- a/service/sagemaker/api_op_StopInferenceExperiment.go +++ b/service/sagemaker/api_op_StopInferenceExperiment.go @@ -29,16 +29,11 @@ func (c *Client) StopInferenceExperiment(ctx context.Context, params *StopInfere type StopInferenceExperimentInput struct { - // Array of key-value pairs, with names of variants mapped to actions. The possible - // actions are the following: - // - // * Promote - Promote the shadow variant to a - // production variant - // - // * Remove - Delete the variant - // - // * Retain - Keep the variant - // as it is + // Array of key-value pairs, with names of variants mapped to actions. The + // possible actions are the following: + // - Promote - Promote the shadow variant to a production variant + // - Remove - Delete the variant + // - Retain - Keep the variant as it is // // This member is required. ModelVariantActions map[string]types.ModelVariantAction @@ -56,11 +51,8 @@ type StopInferenceExperimentInput struct { // The desired state of the experiment after stopping. The possible states are the // following: - // - // * Completed: The experiment completed successfully - // - // * Cancelled: The - // experiment was canceled + // - Completed : The experiment completed successfully + // - Cancelled : The experiment was canceled DesiredState types.InferenceExperimentStopDesiredState // The reason for stopping the experiment. diff --git a/service/sagemaker/api_op_StopNotebookInstance.go b/service/sagemaker/api_op_StopNotebookInstance.go index 5ad40aafe13..a5d6204209d 100644 --- a/service/sagemaker/api_op_StopNotebookInstance.go +++ b/service/sagemaker/api_op_StopNotebookInstance.go @@ -13,7 +13,7 @@ import ( // Terminates the ML compute instance. Before terminating the instance, SageMaker // disconnects the ML storage volume from it. SageMaker preserves the ML storage // volume. SageMaker stops charging you for the ML compute instance when you call -// StopNotebookInstance. To access data on the ML storage volume for a notebook +// StopNotebookInstance . To access data on the ML storage volume for a notebook // instance that has been terminated, call the StartNotebookInstance API. // StartNotebookInstance launches another ML compute instance, configures it, and // attaches the preserved ML storage volume so you can continue your work. diff --git a/service/sagemaker/api_op_StopPipelineExecution.go b/service/sagemaker/api_op_StopPipelineExecution.go index 05884d2557b..4aea089eebd 100644 --- a/service/sagemaker/api_op_StopPipelineExecution.go +++ b/service/sagemaker/api_op_StopPipelineExecution.go @@ -18,15 +18,15 @@ import ( // contains a "Status" field which is set to "Stopping". You should add logic to // your Amazon SQS message consumer to take any needed action (for example, // resource cleanup) upon receipt of the message followed by a call to -// SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure. Only when +// SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure . Only when // SageMaker Pipelines receives one of these calls will it stop the pipeline // execution. Lambda Step A pipeline execution can't be stopped while a lambda step // is running because the Lambda function invoked by the lambda step can't be // stopped. If you attempt to stop the execution while the Lambda function is // running, the pipeline waits for the Lambda function to finish or until the // timeout is hit, whichever occurs first, and then stops. If the Lambda function -// finishes, the pipeline execution status is Stopped. If the timeout is hit the -// pipeline execution status is Failed. +// finishes, the pipeline execution status is Stopped . If the timeout is hit the +// pipeline execution status is Failed . func (c *Client) StopPipelineExecution(ctx context.Context, params *StopPipelineExecutionInput, optFns ...func(*Options)) (*StopPipelineExecutionOutput, error) { if params == nil { params = &StopPipelineExecutionInput{} diff --git a/service/sagemaker/api_op_StopTrainingJob.go b/service/sagemaker/api_op_StopTrainingJob.go index cafe3790a10..8300d557480 100644 --- a/service/sagemaker/api_op_StopTrainingJob.go +++ b/service/sagemaker/api_op_StopTrainingJob.go @@ -14,8 +14,8 @@ import ( // signal, which delays job termination for 120 seconds. Algorithms might use this // 120-second window to save the model artifacts, so the results of the training is // not lost. When it receives a StopTrainingJob request, SageMaker changes the -// status of the job to Stopping. After SageMaker stops the job, it sets the status -// to Stopped. +// status of the job to Stopping . After SageMaker stops the job, it sets the +// status to Stopped . func (c *Client) StopTrainingJob(ctx context.Context, params *StopTrainingJobInput, optFns ...func(*Options)) (*StopTrainingJobOutput, error) { if params == nil { params = &StopTrainingJobInput{} diff --git a/service/sagemaker/api_op_StopTransformJob.go b/service/sagemaker/api_op_StopTransformJob.go index f07705e6b4b..21d5af65baa 100644 --- a/service/sagemaker/api_op_StopTransformJob.go +++ b/service/sagemaker/api_op_StopTransformJob.go @@ -11,9 +11,9 @@ import ( ) // Stops a batch transform job. When Amazon SageMaker receives a StopTransformJob -// request, the status of the job changes to Stopping. After Amazon SageMaker stops -// the job, the status is set to Stopped. When you stop a batch transform job -// before it is completed, Amazon SageMaker doesn't store the job's output in +// request, the status of the job changes to Stopping . After Amazon SageMaker +// stops the job, the status is set to Stopped . When you stop a batch transform +// job before it is completed, Amazon SageMaker doesn't store the job's output in // Amazon S3. func (c *Client) StopTransformJob(ctx context.Context, params *StopTransformJobInput, optFns ...func(*Options)) (*StopTransformJobOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_UpdateDomain.go b/service/sagemaker/api_op_UpdateDomain.go index f8ad274d6c5..d85dcc14a4a 100644 --- a/service/sagemaker/api_op_UpdateDomain.go +++ b/service/sagemaker/api_op_UpdateDomain.go @@ -37,8 +37,7 @@ type UpdateDomainInput struct { // The entity that creates and manages the required security groups for inter-app // communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType // is VPCOnly and - // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is - // provided. + // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. AppSecurityGroupManagement types.AppSecurityGroupManagement // The default settings used to create a space within the Domain. diff --git a/service/sagemaker/api_op_UpdateEndpoint.go b/service/sagemaker/api_op_UpdateEndpoint.go index dd835fb4a04..a26af9ba14f 100644 --- a/service/sagemaker/api_op_UpdateEndpoint.go +++ b/service/sagemaker/api_op_UpdateEndpoint.go @@ -11,15 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deploys the new EndpointConfig specified in the request, switches to using newly -// created endpoint, and then deletes resources provisioned for the endpoint using -// the previous EndpointConfig (there is no availability loss). When SageMaker -// receives the request, it sets the endpoint status to Updating. After updating -// the endpoint, it sets the status to InService. To check the status of an -// endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig in -// use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint +// Deploys the new EndpointConfig specified in the request, switches to using +// newly created endpoint, and then deletes resources provisioned for the endpoint +// using the previous EndpointConfig (there is no availability loss). When +// SageMaker receives the request, it sets the endpoint status to Updating . After +// updating the endpoint, it sets the status to InService . To check the status of +// an endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig +// in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint // operations are being performed on the endpoint. To update an endpoint, you must -// create a new EndpointConfig. If you delete the EndpointConfig of an endpoint +// create a new EndpointConfig . If you delete the EndpointConfig of an endpoint // that is active or being created or updated you may lose visibility into the // instance type the endpoint is using. The endpoint must be deleted in order to // stop incurring charges. @@ -55,21 +55,20 @@ type UpdateEndpointInput struct { DeploymentConfig *types.DeploymentConfig // When you are updating endpoint resources with - // UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, + // UpdateEndpointInput$RetainAllVariantProperties , whose value is set to true , // ExcludeRetainedVariantProperties specifies the list of type VariantProperty to - // override with the values provided by EndpointConfig. If you don't specify a - // value for ExcludeRetainedVariantProperties, no variant properties are + // override with the values provided by EndpointConfig . If you don't specify a + // value for ExcludeRetainedVariantProperties , no variant properties are // overridden. ExcludeRetainedVariantProperties []types.VariantProperty // When updating endpoint resources, enables or disables the retention of variant - // properties - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html), - // such as the instance count or the variant weight. To retain the variant + // properties (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html) + // , such as the instance count or the variant weight. To retain the variant // properties of an endpoint when updating it, set RetainAllVariantProperties to - // true. To use the variant properties specified in a new EndpointConfig call when - // updating an endpoint, set RetainAllVariantProperties to false. The default is - // false. + // true . To use the variant properties specified in a new EndpointConfig call + // when updating an endpoint, set RetainAllVariantProperties to false . The default + // is false . RetainAllVariantProperties bool // Specifies whether to reuse the last deployment configuration. The default value diff --git a/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go b/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go index 10e984c0505..85b33757ad2 100644 --- a/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go +++ b/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go @@ -13,8 +13,8 @@ import ( // Updates variant weight of one or more variants associated with an existing // endpoint, or capacity of one variant associated with an existing endpoint. When -// it receives the request, SageMaker sets the endpoint status to Updating. After -// updating the endpoint, it sets the status to InService. To check the status of +// it receives the request, SageMaker sets the endpoint status to Updating . After +// updating the endpoint, it sets the status to InService . To check the status of // an endpoint, use the DescribeEndpoint API. func (c *Client) UpdateEndpointWeightsAndCapacities(ctx context.Context, params *UpdateEndpointWeightsAndCapacitiesInput, optFns ...func(*Options)) (*UpdateEndpointWeightsAndCapacitiesOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_UpdateFeatureMetadata.go b/service/sagemaker/api_op_UpdateFeatureMetadata.go index cf8a7662455..db21ebb1656 100644 --- a/service/sagemaker/api_op_UpdateFeatureMetadata.go +++ b/service/sagemaker/api_op_UpdateFeatureMetadata.go @@ -45,8 +45,8 @@ type UpdateFeatureMetadataInput struct { // A list of key-value pairs that you can add to better describe the feature. ParameterAdditions []types.FeatureParameter - // A list of parameter keys that you can specify to remove parameters that describe - // your feature. + // A list of parameter keys that you can specify to remove parameters that + // describe your feature. ParameterRemovals []string noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_UpdateImage.go b/service/sagemaker/api_op_UpdateImage.go index 428d3243562..a1a9d2b2ef2 100644 --- a/service/sagemaker/api_op_UpdateImage.go +++ b/service/sagemaker/api_op_UpdateImage.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the properties of a SageMaker image. To change the image's tags, use the -// AddTags and DeleteTags APIs. +// Updates the properties of a SageMaker image. To change the image's tags, use +// the AddTags and DeleteTags APIs. func (c *Client) UpdateImage(ctx context.Context, params *UpdateImageInput, optFns ...func(*Options)) (*UpdateImageOutput, error) { if params == nil { params = &UpdateImageInput{} diff --git a/service/sagemaker/api_op_UpdateImageVersion.go b/service/sagemaker/api_op_UpdateImageVersion.go index 1d599c9d21e..c66deab92f2 100644 --- a/service/sagemaker/api_op_UpdateImageVersion.go +++ b/service/sagemaker/api_op_UpdateImageVersion.go @@ -47,26 +47,18 @@ type UpdateImageVersionInput struct { Horovod bool // Indicates SageMaker job type compatibility. - // - // * TRAINING: The image version is - // compatible with SageMaker training jobs. - // - // * INFERENCE: The image version is - // compatible with SageMaker inference jobs. - // - // * NOTEBOOK_KERNEL: The image version - // is compatible with SageMaker notebook kernels. + // - TRAINING : The image version is compatible with SageMaker training jobs. + // - INFERENCE : The image version is compatible with SageMaker inference jobs. + // - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook + // kernels. JobType types.JobType // The machine learning framework vended in the image version. MLFramework *string // Indicates CPU or GPU compatibility. - // - // * CPU: The image version is compatible with - // CPU. - // - // * GPU: The image version is compatible with GPU. + // - CPU : The image version is compatible with CPU. + // - GPU : The image version is compatible with GPU. Processor types.Processor // The supported programming language and its version. @@ -76,20 +68,14 @@ type UpdateImageVersionInput struct { ReleaseNotes *string // The availability of the image version specified by the maintainer. - // - // * - // NOT_PROVIDED: The maintainers did not provide a status for image version - // stability. - // - // * STABLE: The image version is stable. - // - // * TO_BE_ARCHIVED: The image - // version is set to be archived. Custom image versions that are set to be archived - // are automatically archived after three months. - // - // * ARCHIVED: The image version is - // archived. Archived image versions are not searchable and are no longer actively - // supported. + // - NOT_PROVIDED : The maintainers did not provide a status for image version + // stability. + // - STABLE : The image version is stable. + // - TO_BE_ARCHIVED : The image version is set to be archived. Custom image + // versions that are set to be archived are automatically archived after three + // months. + // - ARCHIVED : The image version is archived. Archived image versions are not + // searchable and are no longer actively supported. VendorGuidance types.VendorGuidance // The version of the image. diff --git a/service/sagemaker/api_op_UpdateInferenceExperiment.go b/service/sagemaker/api_op_UpdateInferenceExperiment.go index e91f98fbc60..6e1a248c004 100644 --- a/service/sagemaker/api_op_UpdateInferenceExperiment.go +++ b/service/sagemaker/api_op_UpdateInferenceExperiment.go @@ -12,8 +12,9 @@ import ( ) // Updates an inference experiment that you created. The status of the inference -// experiment has to be either Created, Running. For more information on the status -// of an inference experiment, see DescribeInferenceExperimentResponse$Status. +// experiment has to be either Created , Running . For more information on the +// status of an inference experiment, see +// DescribeInferenceExperimentResponse$Status . func (c *Client) UpdateInferenceExperiment(ctx context.Context, params *UpdateInferenceExperimentInput, optFns ...func(*Options)) (*UpdateInferenceExperimentOutput, error) { if params == nil { params = &UpdateInferenceExperimentInput{} @@ -48,9 +49,9 @@ type UpdateInferenceExperimentInput struct { ModelVariants []types.ModelVariantConfig // The duration for which the inference experiment will run. If the status of the - // inference experiment is Created, then you can update both the start and end - // dates. If the status of the inference experiment is Running, then you can update - // only the end date. + // inference experiment is Created , then you can update both the start and end + // dates. If the status of the inference experiment is Running , then you can + // update only the end date. Schedule *types.InferenceExperimentSchedule // The configuration of ShadowMode inference experiment type. Use this field to diff --git a/service/sagemaker/api_op_UpdateModelCard.go b/service/sagemaker/api_op_UpdateModelCard.go index 018f1595141..3deaf76c328 100644 --- a/service/sagemaker/api_op_UpdateModelCard.go +++ b/service/sagemaker/api_op_UpdateModelCard.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update an Amazon SageMaker Model Card. You cannot update both model card content -// and model card status in a single call. +// Update an Amazon SageMaker Model Card. You cannot update both model card +// content and model card status in a single call. func (c *Client) UpdateModelCard(ctx context.Context, params *UpdateModelCardInput, optFns ...func(*Options)) (*UpdateModelCardOutput, error) { if params == nil { params = &UpdateModelCardInput{} @@ -35,26 +35,18 @@ type UpdateModelCardInput struct { // This member is required. ModelCardName *string - // The updated model card content. Content must be in model card JSON schema - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // The updated model card content. Content must be in model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) // and provided as a string. When updating model card content, be sure to include // the full content and not just updated content. Content *string // The approval status of the model card within your organization. Different - // organizations might have different criteria for model card review and - // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // organizations might have different criteria for model card review and approval. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. ModelCardStatus types.ModelCardStatus noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_UpdateMonitoringAlert.go b/service/sagemaker/api_op_UpdateMonitoringAlert.go index 6de76965ac4..5ba6920e67d 100644 --- a/service/sagemaker/api_op_UpdateMonitoringAlert.go +++ b/service/sagemaker/api_op_UpdateMonitoringAlert.go @@ -28,7 +28,7 @@ func (c *Client) UpdateMonitoringAlert(ctx context.Context, params *UpdateMonito type UpdateMonitoringAlertInput struct { - // Within EvaluationPeriod, how many execution failures will raise an alert. + // Within EvaluationPeriod , how many execution failures will raise an alert. // // This member is required. DatapointsToAlert *int32 diff --git a/service/sagemaker/api_op_UpdateNotebookInstance.go b/service/sagemaker/api_op_UpdateNotebookInstance.go index e17f2349457..bf6ff71e109 100644 --- a/service/sagemaker/api_op_UpdateNotebookInstance.go +++ b/service/sagemaker/api_op_UpdateNotebookInstance.go @@ -39,35 +39,33 @@ type UpdateNotebookInstanceInput struct { // A list of the Elastic Inference (EI) instance types to associate with this // notebook instance. Currently only one EI instance type can be associated with a // notebook instance. For more information, see Using Elastic Inference in Amazon - // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) . AcceleratorTypes []types.NotebookInstanceAcceleratorType // An array of up to three Git repositories to associate with the notebook // instance. These can be either the names of Git repositories stored as resources // in your account, or the URL of Git repositories in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. These repositories are cloned at the same level + // as the default repository of your notebook instance. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . AdditionalCodeRepositories []string // The Git repository to associate with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource // in your account, or the URL of a Git repository in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. When you open a notebook instance, it opens in + // the directory that contains this repository. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . DefaultCodeRepository *string - // A list of the Elastic Inference (EI) instance types to remove from this notebook - // instance. This operation is idempotent. If you specify an accelerator type that - // is not associated with the notebook instance when you call this method, it does - // not throw an error. + // A list of the Elastic Inference (EI) instance types to remove from this + // notebook instance. This operation is idempotent. If you specify an accelerator + // type that is not associated with the notebook instance when you call this + // method, it does not throw an error. DisassociateAcceleratorTypes bool // A list of names or URLs of the default Git repositories to remove from this @@ -96,21 +94,20 @@ type UpdateNotebookInstanceInput struct { // The name of a lifecycle configuration to associate with the notebook instance. // For information about lifestyle configurations, see Step 2.1: (Optional) - // Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). + // Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) + // . LifecycleConfigName *string // The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to - // access the notebook instance. For more information, see SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be - // able to pass this role to SageMaker, the caller of this API must have the - // iam:PassRole permission. + // access the notebook instance. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) + // . To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. RoleArn *string // Whether root access is enabled or disabled for users of the notebook instance. - // The default value is Enabled. If you set this to Disabled, users don't have root - // access on the notebook instance, but lifecycle configuration scripts still run - // with root permissions. + // The default value is Enabled . If you set this to Disabled , users don't have + // root access on the notebook instance, but lifecycle configuration scripts still + // run with root permissions. RootAccess types.RootAccess // The size, in GB, of the ML storage volume to attach to the notebook instance. diff --git a/service/sagemaker/api_op_UpdatePipelineExecution.go b/service/sagemaker/api_op_UpdatePipelineExecution.go index cfd8c568d4c..6a781f5b408 100644 --- a/service/sagemaker/api_op_UpdatePipelineExecution.go +++ b/service/sagemaker/api_op_UpdatePipelineExecution.go @@ -34,8 +34,8 @@ type UpdatePipelineExecutionInput struct { // This member is required. PipelineExecutionArn *string - // This configuration, if specified, overrides the parallelism configuration of the - // parent pipeline for this specific run. + // This configuration, if specified, overrides the parallelism configuration of + // the parent pipeline for this specific run. ParallelismConfiguration *types.ParallelismConfiguration // The description of the pipeline execution. diff --git a/service/sagemaker/api_op_UpdateProject.go b/service/sagemaker/api_op_UpdateProject.go index 5afcea33843..88db339d7ab 100644 --- a/service/sagemaker/api_op_UpdateProject.go +++ b/service/sagemaker/api_op_UpdateProject.go @@ -44,18 +44,17 @@ type UpdateProjectInput struct { // The product ID and provisioning artifact ID to provision a service catalog. The // provisioning artifact ID will default to the latest provisioning artifact ID of // the product, if you don't provide the provisioning artifact ID. For more - // information, see What is Amazon Web Services Service Catalog - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) + // . ServiceCatalogProvisioningUpdateDetails *types.ServiceCatalogProvisioningUpdateDetails // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). In addition, - // the project must have tag update constraints set in order to include this - // parameter in the request. For more information, see Amazon Web Services Service - // Catalog Tag Update Constraints - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . In addition, the project must have tag update constraints set in order to + // include this parameter in the request. For more information, see Amazon Web + // Services Service Catalog Tag Update Constraints (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_UpdateTrainingJob.go b/service/sagemaker/api_op_UpdateTrainingJob.go index 6a7944ec2a0..4081aacf6cb 100644 --- a/service/sagemaker/api_op_UpdateTrainingJob.go +++ b/service/sagemaker/api_op_UpdateTrainingJob.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a model training job to request a new Debugger profiling configuration or -// to change warm pool retention length. +// Update a model training job to request a new Debugger profiling configuration +// or to change warm pool retention length. func (c *Client) UpdateTrainingJob(ctx context.Context, params *UpdateTrainingJobInput, optFns ...func(*Options)) (*UpdateTrainingJobOutput, error) { if params == nil { params = &UpdateTrainingJobInput{} diff --git a/service/sagemaker/api_op_UpdateTrialComponent.go b/service/sagemaker/api_op_UpdateTrialComponent.go index 9ec2461e984..1046e18fd59 100644 --- a/service/sagemaker/api_op_UpdateTrialComponent.go +++ b/service/sagemaker/api_op_UpdateTrialComponent.go @@ -50,9 +50,9 @@ type UpdateTrialComponentInput struct { // The input artifacts to remove from the component. InputArtifactsToRemove []string - // Replaces all of the component's output artifacts with the specified artifacts or - // adds new output artifacts. Existing output artifacts are replaced if the trial - // component is updated with an identical output artifact key. + // Replaces all of the component's output artifacts with the specified artifacts + // or adds new output artifacts. Existing output artifacts are replaced if the + // trial component is updated with an identical output artifact key. OutputArtifacts map[string]types.TrialComponentArtifact // The output artifacts to remove from the component. diff --git a/service/sagemaker/api_op_UpdateWorkforce.go b/service/sagemaker/api_op_UpdateWorkforce.go index 10a76e742fa..05f11e49203 100644 --- a/service/sagemaker/api_op_UpdateWorkforce.go +++ b/service/sagemaker/api_op_UpdateWorkforce.go @@ -14,22 +14,22 @@ import ( // Use this operation to update your workforce. You can use this operation to // require that workers use specific IP addresses to work on tasks and to update // your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration. The -// worker portal is now supported in VPC and public internet. Use SourceIpConfig to -// restrict worker access to tasks to a specific range of IP addresses. You specify -// allowed IP addresses by creating a list of up to ten CIDRs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html). By default, -// a workforce isn't restricted to specific IP addresses. If you specify a range of -// IP addresses, workers who attempt to access tasks using any IP address outside -// the specified range are denied and get a Not Found error message on the worker -// portal. To restrict access to all the workers in public internet, add the -// SourceIpConfig CIDR value as "10.0.0.0/16". Amazon SageMaker does not support -// Source Ip restriction for worker portals in VPC. Use OidcConfig to update the -// configuration of a workforce created using your own OIDC IdP. You can only -// update your OIDC IdP configuration when there are no work teams associated with -// your workforce. You can delete work teams using the operation. After restricting -// access to a range of IP addresses or updating your OIDC IdP configuration with -// this operation, you can view details about your update workforce using the -// operation. This operation only applies to private workforces. +// worker portal is now supported in VPC and public internet. Use SourceIpConfig +// to restrict worker access to tasks to a specific range of IP addresses. You +// specify allowed IP addresses by creating a list of up to ten CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) +// . By default, a workforce isn't restricted to specific IP addresses. If you +// specify a range of IP addresses, workers who attempt to access tasks using any +// IP address outside the specified range are denied and get a Not Found error +// message on the worker portal. To restrict access to all the workers in public +// internet, add the SourceIpConfig CIDR value as "10.0.0.0/16". Amazon SageMaker +// does not support Source Ip restriction for worker portals in VPC. Use OidcConfig +// to update the configuration of a workforce created using your own OIDC IdP. You +// can only update your OIDC IdP configuration when there are no work teams +// associated with your workforce. You can delete work teams using the operation. +// After restricting access to a range of IP addresses or updating your OIDC IdP +// configuration with this operation, you can view details about your update +// workforce using the operation. This operation only applies to private +// workforces. func (c *Client) UpdateWorkforce(ctx context.Context, params *UpdateWorkforceInput, optFns ...func(*Options)) (*UpdateWorkforceOutput, error) { if params == nil { params = &UpdateWorkforceInput{} @@ -53,13 +53,13 @@ type UpdateWorkforceInput struct { // This member is required. WorkforceName *string - // Use this parameter to update your OIDC Identity Provider (IdP) configuration for - // a workforce made using your own IdP. + // Use this parameter to update your OIDC Identity Provider (IdP) configuration + // for a workforce made using your own IdP. OidcConfig *types.OidcConfig - // A list of one to ten worker IP address ranges (CIDRs - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) that can be - // used to access tasks assigned to this workforce. Maximum: Ten CIDR values + // A list of one to ten worker IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // ) that can be used to access tasks assigned to this workforce. Maximum: Ten CIDR + // values SourceIpConfig *types.SourceIpConfig // Use this parameter to update your VPC configuration for a workforce. @@ -70,11 +70,11 @@ type UpdateWorkforceInput struct { type UpdateWorkforceOutput struct { - // A single private workforce. You can create one private work force in each Amazon - // Web Services Region. By default, any workforce-related API operation used in a - // specific region will apply to the workforce created in that region. To learn how - // to create a private workforce, see Create a Private Workforce - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). + // A single private workforce. You can create one private work force in each + // Amazon Web Services Region. By default, any workforce-related API operation used + // in a specific region will apply to the workforce created in that region. To + // learn how to create a private workforce, see Create a Private Workforce (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html) + // . // // This member is required. Workforce *types.Workforce diff --git a/service/sagemaker/api_op_UpdateWorkteam.go b/service/sagemaker/api_op_UpdateWorkteam.go index aac27d557ff..faca3d41a41 100644 --- a/service/sagemaker/api_op_UpdateWorkteam.go +++ b/service/sagemaker/api_op_UpdateWorkteam.go @@ -40,22 +40,21 @@ type UpdateWorkteamInput struct { // A list of MemberDefinition objects that contains objects that identify the // workers that make up the work team. Workforces can be created using Amazon // Cognito or your own OIDC Identity Provider (IdP). For private workforces created - // using Amazon Cognito use CognitoMemberDefinition. For workforces created using - // your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not + // using Amazon Cognito use CognitoMemberDefinition . For workforces created using + // your own OIDC identity provider (IdP) use OidcMemberDefinition . You should not // provide input for both of these parameters in a single request. For workforces // created using Amazon Cognito, private work teams correspond to Amazon Cognito // user groups within the user pool used to create a workforce. All of the // CognitoMemberDefinition objects that make up the member definition must have the // same ClientId and UserPool values. To add a Amazon Cognito user group to an - // existing worker pool, see Adding groups to a User Pool. For more information - // about user pools, see Amazon Cognito User Pools - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). - // For workforces created using your own OIDC IdP, specify the user groups that you - // want to include in your private work team in OidcMemberDefinition by listing - // those groups in Groups. Be aware that user groups that are already in the work - // team must also be listed in Groups when you make this request to remain on the - // work team. If you do not include these user groups, they will no longer be - // associated with the work team you update. + // existing worker pool, see Adding groups to a User Pool . For more information + // about user pools, see Amazon Cognito User Pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // . For workforces created using your own OIDC IdP, specify the user groups that + // you want to include in your private work team in OidcMemberDefinition by + // listing those groups in Groups . Be aware that user groups that are already in + // the work team must also be listed in Groups when you make this request to + // remain on the work team. If you do not include these user groups, they will no + // longer be associated with the work team you update. MemberDefinitions []types.MemberDefinition // Configures SNS topic notifications for available or expiring work items diff --git a/service/sagemaker/doc.go b/service/sagemaker/doc.go index 4b9421e88f5..6f24316ac0c 100644 --- a/service/sagemaker/doc.go +++ b/service/sagemaker/doc.go @@ -4,12 +4,6 @@ // Amazon SageMaker Service. // // Provides APIs for creating and managing SageMaker resources. Other Resources: -// -// * -// SageMaker Developer Guide -// (https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user) -// -// * -// Amazon Augmented AI Runtime API Reference -// (https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html) +// - SageMaker Developer Guide (https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user) +// - Amazon Augmented AI Runtime API Reference (https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html) package sagemaker diff --git a/service/sagemaker/types/enums.go b/service/sagemaker/types/enums.go index 9479e0d7a7b..8add0a4e526 100644 --- a/service/sagemaker/types/enums.go +++ b/service/sagemaker/types/enums.go @@ -14,9 +14,9 @@ const ( ActionStatusStopped ActionStatus = "Stopped" ) -// Values returns all known values for ActionStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActionStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ActionStatus) Values() []ActionStatus { return []ActionStatus{ "Unknown", @@ -79,8 +79,8 @@ const ( AppImageConfigSortKeyName AppImageConfigSortKey = "Name" ) -// Values returns all known values for AppImageConfigSortKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AppImageConfigSortKey. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AppImageConfigSortKey) Values() []AppImageConfigSortKey { return []AppImageConfigSortKey{ @@ -283,9 +283,9 @@ const ( AppStatusPending AppStatus = "Pending" ) -// Values returns all known values for AppStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AppStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AppStatus) Values() []AppStatus { return []AppStatus{ "Deleted", @@ -350,9 +350,9 @@ const ( AssemblyTypeLine AssemblyType = "Line" ) -// Values returns all known values for AssemblyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AssemblyType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AssemblyType) Values() []AssemblyType { return []AssemblyType{ "None", @@ -554,9 +554,9 @@ const ( AutoMLJobSecondaryStatusTrainingModels AutoMLJobSecondaryStatus = "TrainingModels" ) -// Values returns all known values for AutoMLJobSecondaryStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoMLJobSecondaryStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLJobSecondaryStatus) Values() []AutoMLJobSecondaryStatus { return []AutoMLJobSecondaryStatus{ "Starting", @@ -665,9 +665,9 @@ const ( AutoMLMetricExtendedEnumInferenceLatency AutoMLMetricExtendedEnum = "InferenceLatency" ) -// Values returns all known values for AutoMLMetricExtendedEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoMLMetricExtendedEnum. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLMetricExtendedEnum) Values() []AutoMLMetricExtendedEnum { return []AutoMLMetricExtendedEnum{ "Accuracy", @@ -755,9 +755,9 @@ const ( AutoMLSortByStatus AutoMLSortBy = "Status" ) -// Values returns all known values for AutoMLSortBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoMLSortBy. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AutoMLSortBy) Values() []AutoMLSortBy { return []AutoMLSortBy{ "Name", @@ -1203,8 +1203,8 @@ const ( CompleteOnConvergenceEnabled CompleteOnConvergence = "Enabled" ) -// Values returns all known values for CompleteOnConvergence. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CompleteOnConvergence. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CompleteOnConvergence) Values() []CompleteOnConvergence { return []CompleteOnConvergence{ @@ -1420,9 +1420,9 @@ const ( DirectionDescendants Direction = "Descendants" ) -// Values returns all known values for Direction. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Direction. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Direction) Values() []Direction { return []Direction{ "Both", @@ -1444,9 +1444,9 @@ const ( DomainStatusDeleteFailed DomainStatus = "Delete_Failed" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "Deleting", @@ -1510,9 +1510,9 @@ const ( EdgePresetDeploymentTypeGreengrassV2Component EdgePresetDeploymentType = "GreengrassV2Component" ) -// Values returns all known values for EdgePresetDeploymentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EdgePresetDeploymentType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (EdgePresetDeploymentType) Values() []EdgePresetDeploymentType { return []EdgePresetDeploymentType{ "GreengrassV2Component", @@ -1527,8 +1527,8 @@ const ( EndpointConfigSortKeyCreationTime EndpointConfigSortKey = "CreationTime" ) -// Values returns all known values for EndpointConfigSortKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for EndpointConfigSortKey. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (EndpointConfigSortKey) Values() []EndpointConfigSortKey { return []EndpointConfigSortKey{ @@ -1641,8 +1641,8 @@ const ( FailureHandlingPolicyDoNothing FailureHandlingPolicy = "DO_NOTHING" ) -// Values returns all known values for FailureHandlingPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FailureHandlingPolicy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FailureHandlingPolicy) Values() []FailureHandlingPolicy { return []FailureHandlingPolicy{ @@ -1681,8 +1681,8 @@ const ( FeatureGroupSortOrderDescending FeatureGroupSortOrder = "Descending" ) -// Values returns all known values for FeatureGroupSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FeatureGroupSortOrder. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FeatureGroupSortOrder) Values() []FeatureGroupSortOrder { return []FeatureGroupSortOrder{ @@ -1826,9 +1826,9 @@ const ( FrameworkSklearn Framework = "SKLEARN" ) -// Values returns all known values for Framework. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Framework. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Framework) Values() []Framework { return []Framework{ "TENSORFLOW", @@ -1915,9 +1915,9 @@ const ( HubSortByAccountIdOwner HubSortBy = "AccountIdOwner" ) -// Values returns all known values for HubSortBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for HubSortBy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (HubSortBy) Values() []HubSortBy { return []HubSortBy{ "HubName", @@ -1940,9 +1940,9 @@ const ( HubStatusDeleteFailed HubStatus = "DeleteFailed" ) -// Values returns all known values for HubStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for HubStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (HubStatus) Values() []HubStatus { return []HubStatus{ "InService", @@ -2002,9 +2002,9 @@ const ( HyperParameterTuningAllocationStrategyPrioritized HyperParameterTuningAllocationStrategy = "Prioritized" ) -// Values returns all known values for HyperParameterTuningAllocationStrategy. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for HyperParameterTuningAllocationStrategy. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (HyperParameterTuningAllocationStrategy) Values() []HyperParameterTuningAllocationStrategy { return []HyperParameterTuningAllocationStrategy{ @@ -2213,8 +2213,8 @@ const ( ImageVersionSortOrderDescending ImageVersionSortOrder = "DESCENDING" ) -// Values returns all known values for ImageVersionSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ImageVersionSortOrder. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ImageVersionSortOrder) Values() []ImageVersionSortOrder { return []ImageVersionSortOrder{ @@ -2338,9 +2338,9 @@ const ( InputModeFile InputMode = "File" ) -// Values returns all known values for InputMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for InputMode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (InputMode) Values() []InputMode { return []InputMode{ "Pipe", @@ -2423,9 +2423,9 @@ const ( InstanceTypeMlG548xlarge InstanceType = "ml.g5.48xlarge" ) -// Values returns all known values for InstanceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InstanceType) Values() []InstanceType { return []InstanceType{ "ml.t2.medium", @@ -2573,8 +2573,8 @@ const ( LastUpdateStatusValueInProgress LastUpdateStatusValue = "InProgress" ) -// Values returns all known values for LastUpdateStatusValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for LastUpdateStatusValue. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (LastUpdateStatusValue) Values() []LastUpdateStatusValue { return []LastUpdateStatusValue{ @@ -2702,9 +2702,9 @@ const ( ListInferenceRecommendationsJobsSortByStatus ListInferenceRecommendationsJobsSortBy = "Status" ) -// Values returns all known values for ListInferenceRecommendationsJobsSortBy. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for ListInferenceRecommendationsJobsSortBy. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (ListInferenceRecommendationsJobsSortBy) Values() []ListInferenceRecommendationsJobsSortBy { return []ListInferenceRecommendationsJobsSortBy{ @@ -2834,9 +2834,9 @@ const ( ModelCardExportJobSortByStatus ModelCardExportJobSortBy = "Status" ) -// Values returns all known values for ModelCardExportJobSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ModelCardExportJobSortBy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardExportJobSortBy) Values() []ModelCardExportJobSortBy { return []ModelCardExportJobSortBy{ "Name", @@ -2872,9 +2872,9 @@ const ( ModelCardExportJobStatusFailed ModelCardExportJobStatus = "Failed" ) -// Values returns all known values for ModelCardExportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ModelCardExportJobStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardExportJobStatus) Values() []ModelCardExportJobStatus { return []ModelCardExportJobStatus{ "InProgress", @@ -3135,9 +3135,9 @@ const ( ModelSortKeyCreationTime ModelSortKey = "CreationTime" ) -// Values returns all known values for ModelSortKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ModelSortKey. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ModelSortKey) Values() []ModelSortKey { return []ModelSortKey{ "Name", @@ -3216,8 +3216,8 @@ const ( MonitoringAlertStatusOk MonitoringAlertStatus = "OK" ) -// Values returns all known values for MonitoringAlertStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MonitoringAlertStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MonitoringAlertStatus) Values() []MonitoringAlertStatus { return []MonitoringAlertStatus{ @@ -3274,8 +3274,8 @@ const ( MonitoringProblemTypeRegression MonitoringProblemType = "Regression" ) -// Values returns all known values for MonitoringProblemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MonitoringProblemType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MonitoringProblemType) Values() []MonitoringProblemType { return []MonitoringProblemType{ @@ -3363,9 +3363,9 @@ const ( NotebookInstanceLifecycleConfigSortKeyLastModifiedTime NotebookInstanceLifecycleConfigSortKey = "LastModifiedTime" ) -// Values returns all known values for NotebookInstanceLifecycleConfigSortKey. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for NotebookInstanceLifecycleConfigSortKey. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (NotebookInstanceLifecycleConfigSortKey) Values() []NotebookInstanceLifecycleConfigSortKey { return []NotebookInstanceLifecycleConfigSortKey{ @@ -3841,8 +3841,8 @@ const ( ProcessingS3InputModeFile ProcessingS3InputMode = "File" ) -// Values returns all known values for ProcessingS3InputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ProcessingS3InputMode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ProcessingS3InputMode) Values() []ProcessingS3InputMode { return []ProcessingS3InputMode{ @@ -3877,9 +3877,9 @@ const ( ProcessorGpu Processor = "GPU" ) -// Values returns all known values for Processor. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Processor. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Processor) Values() []Processor { return []Processor{ "CPU", @@ -4333,8 +4333,8 @@ const ( RecommendationJobTypeAdvanced RecommendationJobType = "Advanced" ) -// Values returns all known values for RecommendationJobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for RecommendationJobType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (RecommendationJobType) Values() []RecommendationJobType { return []RecommendationJobType{ @@ -4459,9 +4459,9 @@ const ( ResourceTypeModel ResourceType = "Model" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "TrainingJob", @@ -4526,9 +4526,10 @@ const ( RStudioServerProAccessStatusDisabled RStudioServerProAccessStatus = "DISABLED" ) -// Values returns all known values for RStudioServerProAccessStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RStudioServerProAccessStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (RStudioServerProAccessStatus) Values() []RStudioServerProAccessStatus { return []RStudioServerProAccessStatus{ "ENABLED", @@ -4883,9 +4884,9 @@ const ( SortOrderDescending SortOrder = "Descending" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "Ascending", @@ -4901,9 +4902,9 @@ const ( SortPipelineExecutionsByPipelineExecutionArn SortPipelineExecutionsBy = "PipelineExecutionArn" ) -// Values returns all known values for SortPipelineExecutionsBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SortPipelineExecutionsBy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SortPipelineExecutionsBy) Values() []SortPipelineExecutionsBy { return []SortPipelineExecutionsBy{ "CreationTime", @@ -4937,8 +4938,8 @@ const ( SortTrialComponentsByCreationTime SortTrialComponentsBy = "CreationTime" ) -// Values returns all known values for SortTrialComponentsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SortTrialComponentsBy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SortTrialComponentsBy) Values() []SortTrialComponentsBy { return []SortTrialComponentsBy{ @@ -4955,9 +4956,9 @@ const ( SortTrialsByCreationTime SortTrialsBy = "CreationTime" ) -// Values returns all known values for SortTrialsBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SortTrialsBy. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SortTrialsBy) Values() []SortTrialsBy { return []SortTrialsBy{ "Name", @@ -4973,9 +4974,9 @@ const ( SpaceSortKeyLastModifiedTime SpaceSortKey = "LastModifiedTime" ) -// Values returns all known values for SpaceSortKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SpaceSortKey. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SpaceSortKey) Values() []SpaceSortKey { return []SpaceSortKey{ "CreationTime", @@ -5021,9 +5022,9 @@ const ( SplitTypeTfrecord SplitType = "TFRecord" ) -// Values returns all known values for SplitType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SplitType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SplitType) Values() []SplitType { return []SplitType{ "None", @@ -5097,9 +5098,10 @@ const ( StudioLifecycleConfigAppTypeKernelGateway StudioLifecycleConfigAppType = "KernelGateway" ) -// Values returns all known values for StudioLifecycleConfigAppType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StudioLifecycleConfigAppType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (StudioLifecycleConfigAppType) Values() []StudioLifecycleConfigAppType { return []StudioLifecycleConfigAppType{ "JupyterServer", @@ -5116,9 +5118,10 @@ const ( StudioLifecycleConfigSortKeyName StudioLifecycleConfigSortKey = "Name" ) -// Values returns all known values for StudioLifecycleConfigSortKey. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for StudioLifecycleConfigSortKey. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (StudioLifecycleConfigSortKey) Values() []StudioLifecycleConfigSortKey { return []StudioLifecycleConfigSortKey{ "CreationTime", @@ -5183,9 +5186,9 @@ const ( TargetDeviceImx8mplus TargetDevice = "imx8mplus" ) -// Values returns all known values for TargetDevice. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetDevice. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetDevice) Values() []TargetDevice { return []TargetDevice{ "lambda", @@ -5296,9 +5299,9 @@ const ( TrafficRoutingConfigTypeLinear TrafficRoutingConfigType = "LINEAR" ) -// Values returns all known values for TrafficRoutingConfigType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrafficRoutingConfigType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficRoutingConfigType) Values() []TrafficRoutingConfigType { return []TrafficRoutingConfigType{ "ALL_AT_ONCE", @@ -5463,9 +5466,10 @@ const ( TrainingJobEarlyStoppingTypeAuto TrainingJobEarlyStoppingType = "Auto" ) -// Values returns all known values for TrainingJobEarlyStoppingType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrainingJobEarlyStoppingType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (TrainingJobEarlyStoppingType) Values() []TrainingJobEarlyStoppingType { return []TrainingJobEarlyStoppingType{ "Off", @@ -5483,9 +5487,9 @@ const ( TrainingJobSortByOptionsFinalObjectiveMetricValue TrainingJobSortByOptions = "FinalObjectiveMetricValue" ) -// Values returns all known values for TrainingJobSortByOptions. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrainingJobSortByOptions. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingJobSortByOptions) Values() []TrainingJobSortByOptions { return []TrainingJobSortByOptions{ "Name", @@ -5527,9 +5531,10 @@ const ( TrainingRepositoryAccessModeVpc TrainingRepositoryAccessMode = "Vpc" ) -// Values returns all known values for TrainingRepositoryAccessMode. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TrainingRepositoryAccessMode. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (TrainingRepositoryAccessMode) Values() []TrainingRepositoryAccessMode { return []TrainingRepositoryAccessMode{ "Platform", @@ -5575,8 +5580,8 @@ const ( TransformInstanceTypeMlG4dn16xlarge TransformInstanceType = "ml.g4dn.16xlarge" ) -// Values returns all known values for TransformInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TransformInstanceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TransformInstanceType) Values() []TransformInstanceType { return []TransformInstanceType{ diff --git a/service/sagemaker/types/errors.go b/service/sagemaker/types/errors.go index f1e14cdd27e..f7941d2b6b2 100644 --- a/service/sagemaker/types/errors.go +++ b/service/sagemaker/types/errors.go @@ -8,7 +8,7 @@ import ( ) // There was a conflict when you attempted to modify a SageMaker entity such as an -// Experiment or Artifact. +// Experiment or Artifact . type ConflictException struct { Message *string diff --git a/service/sagemaker/types/types.go b/service/sagemaker/types/types.go index 060b08bb483..819cdf53a18 100644 --- a/service/sagemaker/types/types.go +++ b/service/sagemaker/types/types.go @@ -115,36 +115,35 @@ type Alarm struct { noSmithyDocumentSerde } -// Specifies the training algorithm to use in a CreateTrainingJob request. For more -// information about algorithms provided by SageMaker, see Algorithms -// (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For information -// about using your own algorithms, see Using Your Own Algorithms with Amazon -// SageMaker -// (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). +// Specifies the training algorithm to use in a CreateTrainingJob request. For +// more information about algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) +// . For information about using your own algorithms, see Using Your Own +// Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) +// . type AlgorithmSpecification struct { // The training input mode that the algorithm supports. For more information about - // input modes, see Algorithms - // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). Pipe mode If an - // algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon - // S3 to the container. File mode If an algorithm supports File mode, SageMaker - // downloads the training data from S3 to the provisioned ML storage volume, and - // mounts the directory to the Docker volume for the training container. You must - // provision the ML storage volume with sufficient capacity to accommodate the data - // downloaded from S3. In addition to the training data, the ML storage volume also - // stores the output model. The algorithm container uses the ML storage volume to - // also store intermediate information, if any. For distributed algorithms, - // training data is distributed uniformly. Your training duration is predictable if - // the input data objects sizes are approximately the same. SageMaker does not - // split the files any further for model training. If the object sizes are skewed, - // training won't be optimal as the data distribution is also skewed when one host - // in a training cluster is overloaded, thus becoming a bottleneck in training. - // FastFile mode If an algorithm supports FastFile mode, SageMaker streams data - // directly from S3 to the container with no code changes, and provides file system - // access to the data. Users can author their training script to interact with - // these files as if they were stored on disk. FastFile mode works best when the - // data is read sequentially. Augmented manifest files aren't supported. The - // startup time is lower when there are fewer files in the S3 bucket provided. + // input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) + // . Pipe mode If an algorithm supports Pipe mode, Amazon SageMaker streams data + // directly from Amazon S3 to the container. File mode If an algorithm supports + // File mode, SageMaker downloads the training data from S3 to the provisioned ML + // storage volume, and mounts the directory to the Docker volume for the training + // container. You must provision the ML storage volume with sufficient capacity to + // accommodate the data downloaded from S3. In addition to the training data, the + // ML storage volume also stores the output model. The algorithm container uses the + // ML storage volume to also store intermediate information, if any. For + // distributed algorithms, training data is distributed uniformly. Your training + // duration is predictable if the input data objects sizes are approximately the + // same. SageMaker does not split the files any further for model training. If the + // object sizes are skewed, training won't be optimal as the data distribution is + // also skewed when one host in a training cluster is overloaded, thus becoming a + // bottleneck in training. FastFile mode If an algorithm supports FastFile mode, + // SageMaker streams data directly from S3 to the container with no code changes, + // and provides file system access to the data. Users can author their training + // script to interact with these files as if they were stored on disk. FastFile + // mode works best when the data is read sequentially. Augmented manifest files + // aren't supported. The startup time is lower when there are fewer files in the S3 + // bucket provided. // // This member is required. TrainingInputMode TrainingInputMode @@ -154,45 +153,34 @@ type AlgorithmSpecification struct { // Marketplace. You must specify either the algorithm name to the AlgorithmName // parameter or the image URI of the algorithm container to the TrainingImage // parameter. Note that the AlgorithmName parameter is mutually exclusive with the - // TrainingImage parameter. If you specify a value for the AlgorithmName parameter, - // you can't specify a value for TrainingImage, and vice versa. If you specify - // values for both parameters, the training job might break; if you don't specify - // any value for both parameters, the training job might raise a null error. + // TrainingImage parameter. If you specify a value for the AlgorithmName + // parameter, you can't specify a value for TrainingImage , and vice versa. If you + // specify values for both parameters, the training job might break; if you don't + // specify any value for both parameters, the training job might raise a null + // error. AlgorithmName *string // The arguments for a container used to run a training job. See How Amazon - // SageMaker Runs Your Training Image - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html) + // SageMaker Runs Your Training Image (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html) // for additional information. ContainerArguments []string - // The entrypoint script for a Docker container - // (https://docs.docker.com/engine/reference/builder/) used to run a training job. - // This script takes precedence over the default train processing instructions. See - // How Amazon SageMaker Runs Your Training Image - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html) + // The entrypoint script for a Docker container (https://docs.docker.com/engine/reference/builder/) + // used to run a training job. This script takes precedence over the default train + // processing instructions. See How Amazon SageMaker Runs Your Training Image (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html) // for more information. ContainerEntrypoint []string - // To generate and save time-series metrics during training, set to true. The + // To generate and save time-series metrics during training, set to true . The // default is false and time-series metrics aren't generated except in the // following cases: - // - // * You use one of the SageMaker built-in algorithms - // - // * You use - // one of the following Prebuilt SageMaker Docker Images - // (https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html): - // - // * - // Tensorflow (version >= 1.15) - // - // * MXNet (version >= 1.6) - // - // * PyTorch (version >= - // 1.3) - // - // * You specify at least one MetricDefinition + // - You use one of the SageMaker built-in algorithms + // - You use one of the following Prebuilt SageMaker Docker Images (https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html) + // : + // - Tensorflow (version >= 1.15) + // - MXNet (version >= 1.6) + // - PyTorch (version >= 1.3) + // - You specify at least one MetricDefinition EnableSageMakerMetricsTimeSeries bool // A list of metric definition objects. Each object specifies the metric name and @@ -202,16 +190,14 @@ type AlgorithmSpecification struct { // The registry path of the Docker image that contains the training algorithm. For // information about docker registry paths for SageMaker built-in algorithms, see - // Docker Registry Paths and Example Code - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) + // Docker Registry Paths and Example Code (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) // in the Amazon SageMaker developer guide. SageMaker supports both // registry/repository[:tag] and registry/repository[@digest] image path formats. // For more information about using your custom training container, see Using Your - // Own Algorithms with Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). You must - // specify either the algorithm name to the AlgorithmName parameter or the image - // URI of the algorithm container to the TrainingImage parameter. For more - // information, see the note in the AlgorithmName parameter description. + // Own Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // . You must specify either the algorithm name to the AlgorithmName parameter or + // the image URI of the algorithm container to the TrainingImage parameter. For + // more information, see the note in the AlgorithmName parameter description. TrainingImage *string // The configuration to use an image from a private Docker registry for a training @@ -246,7 +232,7 @@ type AlgorithmStatusItem struct { // This member is required. Status DetailedAlgorithmStatus - // if the overall status is Failed, the reason for the failure. + // if the overall status is Failed , the reason for the failure. FailureReason *string noSmithyDocumentSerde @@ -281,9 +267,9 @@ type AlgorithmSummary struct { noSmithyDocumentSerde } -// Defines a training job and a batch transform job that SageMaker runs to validate -// your algorithm. The data provided in the validation profile is made available to -// your buyers on Amazon Web Services Marketplace. +// Defines a training job and a batch transform job that SageMaker runs to +// validate your algorithm. The data provided in the validation profile is made +// available to your buyers on Amazon Web Services Marketplace. type AlgorithmValidationProfile struct { // The name of the profile for the algorithm. The name must have 1 to 63 @@ -324,986 +310,560 @@ type AlgorithmValidationSpecification struct { noSmithyDocumentSerde } -// Configures how labels are consolidated across human workers and processes output -// data. +// Configures how labels are consolidated across human workers and processes +// output data. type AnnotationConsolidationConfig struct { // The Amazon Resource Name (ARN) of a Lambda function implements the logic for - // annotation consolidation - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html) + // annotation consolidation (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html) // and to process output data. This parameter is required for all labeling jobs. - // For built-in task types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html), use one - // of the following Amazon SageMaker Ground Truth Lambda function ARNs for - // AnnotationConsolidationLambdaArn. For custom labeling workflows, see - // Post-annotation Lambda - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-postlambda). - // Bounding box - Finds the most similar boxes from different workers based on the - // Jaccard index of the boxes. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox - // - // Image - // classification - Uses a variant of the Expectation Maximization approach to - // estimate the true class of an image based on annotations from individual - // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass - // - // Multi-label - // image classification - Uses a variant of the Expectation Maximization approach - // to estimate the true classes of an image based on annotations from individual - // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel - // - // Semantic - // segmentation - Treats each pixel in an image as a multi-class classification and - // treats pixel annotations from workers as "votes" for the correct label. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation - // - // Text - // classification - Uses a variant of the Expectation Maximization approach to - // estimate the true class of text based on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass - // - // Multi-label - // text classification - Uses a variant of the Expectation Maximization approach to - // estimate the true classes of text based on annotations from individual + // For built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) + // , use one of the following Amazon SageMaker Ground Truth Lambda function ARNs + // for AnnotationConsolidationLambdaArn . For custom labeling workflows, see + // Post-annotation Lambda (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-postlambda) + // . Bounding box - Finds the most similar boxes from different workers based on + // the Jaccard index of the boxes. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox + // Image classification - Uses a variant of the Expectation Maximization approach + // to estimate the true class of an image based on annotations from individual // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel - // - // Named - // entity recognition - Groups similar selections and calculates aggregate + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass + // Multi-label image classification - Uses a variant of the Expectation + // Maximization approach to estimate the true classes of an image based on + // annotations from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel + // Semantic segmentation - Treats each pixel in an image as a multi-class + // classification and treats pixel annotations from workers as "votes" for the + // correct label. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation + // Text classification - Uses a variant of the Expectation Maximization approach + // to estimate the true class of text based on annotations from individual workers. + // + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass + // Multi-label text classification - Uses a variant of the Expectation + // Maximization approach to estimate the true classes of text based on annotations + // from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel + // Named entity recognition - Groups similar selections and calculates aggregate // boundaries, resolving to most-assigned label. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition - // - // Video - // Classification - Use this task type when you need workers to classify videos - // using predefined labels that you specify. Workers are shown videos and are asked - // to choose one label for each video. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass - // - // Video - // Frame Object Detection - Use this task type to have workers identify and locate - // objects in a sequence of video frames (images extracted from a video) using - // bounding boxes. For example, you can use this task to ask workers to identify - // and localize various objects in a series of video frames, such as cars, bikes, - // and pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection - // - // Video - // Frame Object Tracking - Use this task type to have workers track the movement of - // objects in a sequence of video frames (images extracted from a video) using - // bounding boxes. For example, you can use this task to ask workers to track the - // movement of objects, such as cars, bikes, and pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking - // - // 3D - // Point Cloud Object Detection - Use this task type when you want workers to + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition + // Video Classification - Use this task type when you need workers to classify + // videos using predefined labels that you specify. Workers are shown videos and + // are asked to choose one label for each video. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass + // Video Frame Object Detection - Use this task type to have workers identify and + // locate objects in a sequence of video frames (images extracted from a video) + // using bounding boxes. For example, you can use this task to ask workers to + // identify and localize various objects in a series of video frames, such as cars, + // bikes, and pedestrians. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection + // Video Frame Object Tracking - Use this task type to have workers track the + // movement of objects in a sequence of video frames (images extracted from a + // video) using bounding boxes. For example, you can use this task to ask workers + // to track the movement of objects, such as cars, bikes, and pedestrians. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking + // 3D Point Cloud Object Detection - Use this task type when you want workers to // classify objects in a 3D point cloud by drawing 3D cuboids around objects. For // example, you can use this task type to ask workers to identify different types // of objects in a point cloud, such as cars, bikes, and pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection - // - // 3D - // Point Cloud Object Tracking - Use this task type when you want workers to draw - // 3D cuboids around objects that appear in a sequence of 3D point cloud frames. - // For example, you can use this task type to ask workers to track the movement of - // vehicles across multiple point cloud frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking - // - // 3D - // Point Cloud Semantic Segmentation - Use this task type when you want workers to - // create a point-level semantic segmentation masks by painting objects in a 3D + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection + // 3D Point Cloud Object Tracking - Use this task type when you want workers to + // draw 3D cuboids around objects that appear in a sequence of 3D point cloud + // frames. For example, you can use this task type to ask workers to track the + // movement of vehicles across multiple point cloud frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking + // 3D Point Cloud Semantic Segmentation - Use this task type when you want workers + // to create a point-level semantic segmentation masks by painting objects in a 3D // point cloud using different colors where each color is assigned to one of the // classes you specify. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation - // - // Use - // the following ARNs for Label Verification and Adjustment Jobs Use label + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation + // Use the following ARNs for Label Verification and Adjustment Jobs Use label // verification and adjustment jobs to review and adjust labels. To learn more, see - // Verify and Adjust Labels - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html). - // Semantic Segmentation Adjustment - Treats each pixel in an image as a + // Verify and Adjust Labels (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html) + // . Semantic Segmentation Adjustment - Treats each pixel in an image as a // multi-class classification and treats pixel adjusted annotations from workers as // "votes" for the correct label. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation + // Semantic Segmentation Verification - Uses a variant of the Expectation + // Maximization approach to estimate the true class of verification judgment for + // semantic segmentation labels based on annotations from individual workers. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation + // Bounding Box Adjustment - Finds the most similar boxes from different workers + // based on the Jaccard index of the adjusted annotations. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox + // - arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox + // Bounding Box Verification - Uses a variant of the Expectation Maximization + // approach to estimate the true class of verification judgement for bounding box + // labels based on annotations from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox + // Video Frame Object Detection Adjustment - Use this task type when you want + // workers to adjust bounding boxes that workers have added to video frames to + // classify and localize objects in a sequence of video frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection + // Video Frame Object Tracking Adjustment - Use this task type when you want + // workers to adjust bounding boxes that workers have added to video frames to + // track object movement across a sequence of video frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking + // 3D Point Cloud Object Detection Adjustment - Use this task type when you want + // workers to adjust 3D cuboids around objects in a 3D point cloud. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection + // 3D Point Cloud Object Tracking Adjustment - Use this task type when you want + // workers to adjust 3D cuboids around objects that appear in a sequence of 3D + // point cloud frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking + // 3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you + // want workers to adjust a point-level semantic segmentation masks using a paint + // tool. + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation - // - // Semantic - // Segmentation Verification - Uses a variant of the Expectation Maximization - // approach to estimate the true class of verification judgment for semantic - // segmentation labels based on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation - // - // Bounding - // Box Adjustment - Finds the most similar boxes from different workers based on - // the Jaccard index of the adjusted annotations. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox - // - // Bounding - // Box Verification - Uses a variant of the Expectation Maximization approach to - // estimate the true class of verification judgement for bounding box labels based - // on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox - // - // Video - // Frame Object Detection Adjustment - Use this task type when you want workers to - // adjust bounding boxes that workers have added to video frames to classify and - // localize objects in a sequence of video frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection - // - // Video - // Frame Object Tracking Adjustment - Use this task type when you want workers to - // adjust bounding boxes that workers have added to video frames to track object - // movement across a sequence of video frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking - // - // 3D - // Point Cloud Object Detection Adjustment - Use this task type when you want - // workers to adjust 3D cuboids around objects in a 3D point cloud. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection - // - // 3D - // Point Cloud Object Tracking Adjustment - Use this task type when you want - // workers to adjust 3D cuboids around objects that appear in a sequence of 3D - // point cloud frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking - // - // 3D - // Point Cloud Semantic Segmentation Adjustment - Use this task type when you want - // workers to adjust a point-level semantic segmentation masks using a paint - // tool. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation - // - // This member is required. - AnnotationConsolidationLambdaArn *string - - noSmithyDocumentSerde -} - -// Details about an Amazon SageMaker app. -type AppDetails struct { - - // The name of the app. - AppName *string - - // The type of app. - AppType AppType - - // The creation time. - CreationTime *time.Time - - // The domain ID. - DomainId *string - - // The name of the space. - SpaceName *string - - // The status. - Status AppStatus - - // The user profile name. - UserProfileName *string - - noSmithyDocumentSerde -} - -// The configuration for running a SageMaker image as a KernelGateway app. -type AppImageConfigDetails struct { - - // The Amazon Resource Name (ARN) of the AppImageConfig. - AppImageConfigArn *string - - // The name of the AppImageConfig. Must be unique to your account. - AppImageConfigName *string - - // When the AppImageConfig was created. - CreationTime *time.Time - - // The configuration for the file system and kernels in the SageMaker image. - KernelGatewayImageConfig *KernelGatewayImageConfig - - // When the AppImageConfig was last modified. - LastModifiedTime *time.Time - - noSmithyDocumentSerde -} - -// Configuration to run a processing job in a specified container image. -type AppSpecification struct { - - // The container image to be run by the processing job. + // This member is required. + AnnotationConsolidationLambdaArn *string + + noSmithyDocumentSerde +} + +// Details about an Amazon SageMaker app. +type AppDetails struct { + + // The name of the app. + AppName *string + + // The type of app. + AppType AppType + + // The creation time. + CreationTime *time.Time + + // The domain ID. + DomainId *string + + // The name of the space. + SpaceName *string + + // The status. + Status AppStatus + + // The user profile name. + UserProfileName *string + + noSmithyDocumentSerde +} + +// The configuration for running a SageMaker image as a KernelGateway app. +type AppImageConfigDetails struct { + + // The Amazon Resource Name (ARN) of the AppImageConfig. + AppImageConfigArn *string + + // The name of the AppImageConfig. Must be unique to your account. + AppImageConfigName *string + + // When the AppImageConfig was created. + CreationTime *time.Time + + // The configuration for the file system and kernels in the SageMaker image. + KernelGatewayImageConfig *KernelGatewayImageConfig + + // When the AppImageConfig was last modified. + LastModifiedTime *time.Time + + noSmithyDocumentSerde +} + +// Configuration to run a processing job in a specified container image. +type AppSpecification struct { + + // The container image to be run by the processing job. // // This member is required. ImageUri *string @@ -1372,8 +932,8 @@ type ArtifactSummary struct { noSmithyDocumentSerde } -// Lists a summary of the properties of an association. An association is an entity -// that links other lineage or experiment entities. An example would be an +// Lists a summary of the properties of an association. An association is an +// entity that links other lineage or experiment entities. An example would be an // association between a training job and a model. type AssociationSummary struct { @@ -1518,40 +1078,23 @@ type AthenaDatasetDefinition struct { // of an Autopilot job. type AutoMLAlgorithmConfig struct { - // The selection of algorithms run on a dataset to train the model candidates of an - // Autopilot job. Selected algorithms must belong to the list corresponding to the - // training mode set in AutoMLJobConfig.Mode - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html#sagemaker-Type-AutoMLJobConfig-Mode) - // (ENSEMBLING or HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm. - // - // * In - // ENSEMBLING mode: - // - // * "catboost" - // - // * "extra-trees" - // - // * "fastai" - // - // * "lightgbm" - // - // * - // "linear-learner" - // - // * "nn-torch" - // - // * "randomforest" - // - // * "xgboost" - // - // * In - // HYPERPARAMETER_TUNING mode: - // - // * "linear-learner" - // - // * "mlp" - // - // * "xgboost" + // The selection of algorithms run on a dataset to train the model candidates of + // an Autopilot job. Selected algorithms must belong to the list corresponding to + // the training mode set in AutoMLJobConfig.Mode (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html#sagemaker-Type-AutoMLJobConfig-Mode) + // ( ENSEMBLING or HYPERPARAMETER_TUNING ). Choose a minimum of 1 algorithm. + // - In ENSEMBLING mode: + // - "catboost" + // - "extra-trees" + // - "fastai" + // - "lightgbm" + // - "linear-learner" + // - "nn-torch" + // - "randomforest" + // - "xgboost" + // - In HYPERPARAMETER_TUNING mode: + // - "linear-learner" + // - "mlp" + // - "xgboost" // // This member is required. AutoMLAlgorithms []AutoMLAlgorithm @@ -1607,7 +1150,7 @@ type AutoMLCandidate struct { // The mapping of all supported processing unit (CPU, GPU, etc...) to inference // container definitions for the candidate. This field is populated for the V2 API - // only (for example, for jobs created by calling CreateAutoMLJobV2). + // only (for example, for jobs created by calling CreateAutoMLJobV2 ). InferenceContainerDefinitions map[string][]AutoMLContainerDefinition // Information about the recommended inference container definitions. @@ -1622,46 +1165,37 @@ type AutoMLCandidateGenerationConfig struct { // Stores the configuration information for the selection of algorithms used to // train the model candidates. The list of available algorithms to choose from - // depends on the training mode set in AutoMLJobConfig.Mode - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html). - // - // * - // AlgorithmsConfig should not be set in AUTO training mode. - // - // * When - // AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one - // only. If the list of algorithms provided as values for AutoMLAlgorithms is - // empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the - // given training mode. - // - // * When AlgorithmsConfig is not provided, - // AutoMLCandidateGenerationConfig uses the full set of algorithms for the given - // training mode. - // - // For the list of all algorithms per training mode, see - // AutoMLAlgorithmConfig - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html). - // For more information on each algorithm, see the Algorithm support - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support) + // depends on the training mode set in AutoMLJobConfig.Mode (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html) + // . + // - AlgorithmsConfig should not be set in AUTO training mode. + // - When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be + // set and one only. If the list of algorithms provided as values for + // AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set + // of algorithms for the given training mode. + // - When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses + // the full set of algorithms for the given training mode. + // For the list of all algorithms per training mode, see AutoMLAlgorithmConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html) + // . For more information on each algorithm, see the Algorithm support (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support) // section in Autopilot developer guide. AlgorithmsConfig []AutoMLAlgorithmConfig // A URL to the Amazon S3 data source containing selected features from the input // data source to run an Autopilot job. You can input FeatureAttributeNames // (optional) in JSON format as shown below: { "FeatureAttributeNames":["col1", - // "col2", ...] }. You can also specify the data type of the feature (optional) in + // "col2", ...] } . You can also specify the data type of the feature (optional) in // the format shown below: { "FeatureDataTypes":{"col1":"numeric", // "col2":"categorical" ... } } These column keys may not include the target // column. In ensembling mode, Autopilot only supports the following data types: - // numeric, categorical, text, and datetime. In HPO mode, Autopilot can support - // numeric, categorical, text, datetime, and sequence. If only FeatureDataTypes is - // provided, the column keys (col1, col2,..) should be a subset of the column names - // in the input data. If both FeatureDataTypes and FeatureAttributeNames are - // provided, then the column keys should be a subset of the column names provided - // in FeatureAttributeNames. The key name FeatureAttributeNames is fixed. The - // values listed in ["col1", "col2", ...] are case sensitive and should be a list - // of strings containing unique values that are a subset of the column names in the - // input data. The list of columns provided must not include the target column. + // numeric , categorical , text , and datetime . In HPO mode, Autopilot can support + // numeric , categorical , text , datetime , and sequence . If only + // FeatureDataTypes is provided, the column keys ( col1 , col2 ,..) should be a + // subset of the column names in the input data. If both FeatureDataTypes and + // FeatureAttributeNames are provided, then the column keys should be a subset of + // the column names provided in FeatureAttributeNames . The key name + // FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are + // case sensitive and should be a list of strings containing unique values that are + // a subset of the column names in the input data. The list of columns provided + // must not include the target column. FeatureSpecificationS3Uri *string noSmithyDocumentSerde @@ -1690,9 +1224,8 @@ type AutoMLCandidateStep struct { // A channel is a named input source that training algorithms can consume. The // validation dataset size is limited to less than 2 GB. The training dataset size -// must be less than 100 GB. For more information, see Channel -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html). A -// validation dataset must contain the same headers as the training dataset. +// must be less than 100 GB. For more information, see Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) +// . A validation dataset must contain the same headers as the training dataset. type AutoMLChannel struct { // The data source for an AutoML channel. @@ -1706,46 +1239,46 @@ type AutoMLChannel struct { // This member is required. TargetAttributeName *string - // The channel type (optional) is an enum string. The default value is training. + // The channel type (optional) is an enum string. The default value is training . // Channels for training and validation must share the same ContentType and - // TargetAttributeName. For information on specifying training and validation - // channel types, see How to specify training and validation datasets - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-data-sources-training-or-validation). + // TargetAttributeName . For information on specifying training and validation + // channel types, see How to specify training and validation datasets (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-data-sources-training-or-validation) + // . ChannelType AutoMLChannelType - // You can use Gzip or None. The default value is None. + // You can use Gzip or None . The default value is None . CompressionType CompressionType // The content type of the data from the input source. You can use - // text/csv;header=present or x-application/vnd.amazon+parquet. The default value - // is text/csv;header=present. + // text/csv;header=present or x-application/vnd.amazon+parquet . The default value + // is text/csv;header=present . ContentType *string noSmithyDocumentSerde } -// A list of container definitions that describe the different containers that make -// up an AutoML candidate. For more information, see ContainerDefinition -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html). +// A list of container definitions that describe the different containers that +// make up an AutoML candidate. For more information, see ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) +// . type AutoMLContainerDefinition struct { // The Amazon Elastic Container Registry (Amazon ECR) path of the container. For - // more information, see ContainerDefinition - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html). + // more information, see ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) + // . // // This member is required. Image *string // The location of the model artifacts. For more information, see - // ContainerDefinition - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html). + // ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) + // . // // This member is required. ModelDataUrl *string // The environment variables to set in the container. For more information, see - // ContainerDefinition - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html). + // ContainerDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html) + // . Environment map[string]string noSmithyDocumentSerde @@ -1763,9 +1296,9 @@ type AutoMLDataSource struct { } // This structure specifies how to split the data into train and validation -// datasets. If you are using the V1 API (for example CreateAutoMLJob) or the V2 -// API for Natural Language Processing problems (for example CreateAutoMLJobV2 with -// a TextClassificationJobConfig problem type), the validation and training +// datasets. If you are using the V1 API (for example CreateAutoMLJob ) or the V2 +// API for Natural Language Processing problems (for example CreateAutoMLJobV2 +// with a TextClassificationJobConfig problem type), the validation and training // datasets must contain the same headers. Also, for V1 API jobs, the validation // dataset must be less than 2 GB in size. type AutoMLDataSplitConfig struct { @@ -1793,30 +1326,26 @@ type AutoMLJobArtifacts struct { // A channel is a named input source that training algorithms can consume. This // channel is used for the non tabular training data of an AutoML job using the V2 -// API. For tabular training data, see AutoMLChannel -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLChannel.html). -// For more information, see Channel -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html). +// API. For tabular training data, see AutoMLChannel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLChannel.html) +// . For more information, see Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) +// . type AutoMLJobChannel struct { // The type of channel. Defines whether the data are used for training or - // validation. The default value is training. Channels for training and validation + // validation. The default value is training . Channels for training and validation // must share the same ContentType ChannelType AutoMLChannelType // The allowed compression types depend on the input format. We allow the // compression type Gzip for S3Prefix inputs only. For all other inputs, the - // compression type should be None. If no compression type is provided, we default - // to None. + // compression type should be None . If no compression type is provided, we default + // to None . CompressionType CompressionType // The content type of the data from the input source. The following are the // allowed content types for different problems: - // - // * ImageClassification: image/png, - // image/jpeg, image/* - // - // * TextClassification: text/csv;header=present + // - ImageClassification: image/png , image/jpeg , image/* + // - TextClassification: text/csv;header=present ContentType *string // The data source for an AutoML channel. @@ -1829,24 +1358,23 @@ type AutoMLJobChannel struct { // generate. type AutoMLJobCompletionCriteria struct { - // The maximum runtime, in seconds, an AutoML job has to complete. If an AutoML job - // exceeds the maximum runtime, the job is stopped automatically and its processing - // is ended gracefully. The AutoML job identifies the best model whose training was - // completed and marks it as the best-performing model. Any unfinished steps of the - // job, such as automatic one-click Autopilot model deployment, are not completed. + // The maximum runtime, in seconds, an AutoML job has to complete. If an AutoML + // job exceeds the maximum runtime, the job is stopped automatically and its + // processing is ended gracefully. The AutoML job identifies the best model whose + // training was completed and marks it as the best-performing model. Any unfinished + // steps of the job, such as automatic one-click Autopilot model deployment, are + // not completed. MaxAutoMLJobRuntimeInSeconds *int32 // The maximum number of times a training job is allowed to run. For V2 jobs (jobs - // created by calling CreateAutoMLJobV2), the supported value is 1. + // created by calling CreateAutoMLJobV2 ), the supported value is 1. MaxCandidates *int32 // The maximum time, in seconds, that each training job executed inside // hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. - // For more information, see the StoppingCondition - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html) - // used by the CreateHyperParameterTuningJob - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) - // action. For V2 jobs (jobs created by calling CreateAutoMLJobV2), this field + // For more information, see the StoppingCondition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html) + // used by the CreateHyperParameterTuningJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) + // action. For V2 jobs (jobs created by calling CreateAutoMLJobV2 ), this field // controls the runtime of the job candidate. MaxRuntimePerTrainingJobInSeconds *int32 @@ -1869,21 +1397,19 @@ type AutoMLJobConfig struct { // The method that Autopilot uses to train the data. You can either specify the // mode manually or let Autopilot choose for you based on the dataset size by - // selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller - // than 100 MB, and HYPERPARAMETER_TUNING for larger ones. The ENSEMBLING mode uses - // a multi-stack ensemble model to predict classification and regression tasks - // directly from your dataset. This machine learning mode combines several base - // models to produce an optimal predictive model. It then uses a stacking ensemble - // method to combine predictions from contributing members. A multi-stack ensemble - // model can provide better performance over a single model by combining the - // predictive capabilities of multiple models. See Autopilot algorithm support - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt) + // selecting AUTO . In AUTO mode, Autopilot chooses ENSEMBLING for datasets + // smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones. The ENSEMBLING + // mode uses a multi-stack ensemble model to predict classification and regression + // tasks directly from your dataset. This machine learning mode combines several + // base models to produce an optimal predictive model. It then uses a stacking + // ensemble method to combine predictions from contributing members. A multi-stack + // ensemble model can provide better performance over a single model by combining + // the predictive capabilities of multiple models. See Autopilot algorithm support (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt) // for a list of algorithms supported by ENSEMBLING mode. The HYPERPARAMETER_TUNING // (HPO) mode uses the best hyperparameters to train the best version of a model. // HPO automatically selects an algorithm for the type of problem you want to // solve. Then HPO finds the best hyperparameters according to your objective - // metric. See Autopilot algorithm support - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt) + // metric. See Autopilot algorithm support (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-suppprt) // for a list of algorithms supported by HYPERPARAMETER_TUNING mode. Mode AutoMLMode @@ -1894,7 +1420,7 @@ type AutoMLJobConfig struct { } // Specifies a metric to minimize or maximize as the objective of a job. V2 API -// jobs (for example jobs created by calling CreateAutoMLJobV2), support Accuracy +// jobs (for example jobs created by calling CreateAutoMLJobV2 ), support Accuracy // only. type AutoMLJobObjective struct { @@ -1941,8 +1467,8 @@ type AutoMLJobObjective struct { // F1macro score applies F1 scoring to multiclass classification problems. It does // this by calculating the precision and recall, and then taking their harmonic // mean to calculate the F1 score for each class. Lastly, the F1macro averages the - // individual scores to obtain the F1macro score. F1macro scores vary between 0 and - // 1. A score of 1 indicates the best possible performance, and 0 indicates the + // individual scores to obtain the F1macro score. F1macro scores vary between 0 + // and 1. A score of 1 indicates the best possible performance, and 0 indicates the // worst. MAE The mean absolute error (MAE) is a measure of how different the // predicted and actual values are, when they're averaged over all values. MAE is // commonly used in regression analysis to understand model prediction error. If @@ -1997,13 +1523,9 @@ type AutoMLJobObjective struct { // is dependent on scale, and should not be used to compare datasets of different // sizes. If you do not specify a metric explicitly, the default behavior is to // automatically use: - // - // * MSE: for regression. - // - // * F1: for binary classification - // - // * - // Accuracy: for multiclass classification. + // - MSE : for regression. + // - F1 : for binary classification + // - Accuracy : for multiclass classification. // // This member is required. MetricName AutoMLMetricEnum @@ -2124,30 +1646,27 @@ func (*AutoMLProblemTypeConfigMemberTextClassificationJobConfig) isAutoMLProblem type AutoMLS3DataSource struct { // The data type. - // - // * If you choose S3Prefix, S3Uri identifies a key name prefix. - // SageMaker uses all objects that match the specified key name prefix for model - // training. The S3Prefix should have the following format: - // s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE - // - // * If you choose - // ManifestFile, S3Uri identifies an object that is a manifest file containing a - // list of object keys that you want SageMaker to use for model training. A - // ManifestFile should have the format shown below: [ {"prefix": - // "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"}, - // "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1","DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",... - // "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ] - // - // * If you choose - // AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest - // file in JSON lines format. This file contains the data you want to use for model - // training. AugmentedManifestFile is available for V2 API jobs only (for example, - // for jobs created by calling CreateAutoMLJobV2). Here is a minimal, single-record - // example of an AugmentedManifestFile: {"source-ref": - // "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg","label-metadata": - // {"class-name": "cat" } For more information on AugmentedManifestFile, see - // Provide Dataset Metadata to Training Jobs with an Augmented Manifest File - // (https://docs.aws.amazon.com/sagemaker/latest/dg/augmented-manifest.html). + // - If you choose S3Prefix , S3Uri identifies a key name prefix. SageMaker uses + // all objects that match the specified key name prefix for model training. The + // S3Prefix should have the following format: + // s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE + // - If you choose ManifestFile , S3Uri identifies an object that is a manifest + // file containing a list of object keys that you want SageMaker to use for model + // training. A ManifestFile should have the format shown below: [ {"prefix": + // "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"}, + // "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1", + // "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2", ... + // "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ] + // - If you choose AugmentedManifestFile , S3Uri identifies an object that is an + // augmented manifest file in JSON lines format. This file contains the data you + // want to use for model training. AugmentedManifestFile is available for V2 API + // jobs only (for example, for jobs created by calling CreateAutoMLJobV2 ). Here + // is a minimal, single-record example of an AugmentedManifestFile : + // {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg", + // "label-metadata": {"class-name": "cat" } For more information on + // AugmentedManifestFile , see Provide Dataset Metadata to Training Jobs with an + // Augmented Manifest File (https://docs.aws.amazon.com/sagemaker/latest/dg/augmented-manifest.html) + // . // // This member is required. S3DataType AutoMLS3DataType @@ -2180,9 +1699,9 @@ type AutoMLSecurityConfig struct { // recovery. type AutoRollbackConfig struct { - // List of CloudWatch alarms in your account that are configured to monitor metrics - // on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls - // back the deployment. + // List of CloudWatch alarms in your account that are configured to monitor + // metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker + // rolls back the deployment. Alarms []Alarm noSmithyDocumentSerde @@ -2204,18 +1723,11 @@ type BatchDataCaptureConfig struct { // key that SageMaker uses to encrypt data on the storage volume attached to the ML // compute instance that hosts the batch transform job. The KmsKeyId can be any of // the following formats: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias KmsKeyId *string noSmithyDocumentSerde @@ -2298,8 +1810,8 @@ type BatchTransformInput struct { // If specified, monitoring jobs substract this time from the end time. For // information about using offsets for scheduling monitoring jobs, see Schedule - // Model Quality Monitoring Jobs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). + // Model Quality Monitoring Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) + // . EndTimeOffset *string // The attributes of the input data that are the input features. @@ -2315,19 +1827,19 @@ type BatchTransformInput struct { // The threshold for the class probability to be evaluated as a positive result. ProbabilityThresholdAttribute *float64 - // Whether input data distributed in Amazon S3 is fully replicated or sharded by an - // S3 key. Defaults to FullyReplicated + // Whether input data distributed in Amazon S3 is fully replicated or sharded by + // an S3 key. Defaults to FullyReplicated S3DataDistributionType ProcessingS3DataDistributionType - // Whether the Pipe or File is used as the input mode for transferring data for the - // monitoring job. Pipe mode is recommended for large datasets. File mode is useful - // for small files that fit in memory. Defaults to File. + // Whether the Pipe or File is used as the input mode for transferring data for + // the monitoring job. Pipe mode is recommended for large datasets. File mode is + // useful for small files that fit in memory. Defaults to File . S3InputMode ProcessingS3InputMode // If specified, monitoring jobs substract this time from the start time. For // information about using offsets for scheduling monitoring jobs, see Schedule - // Model Quality Monitoring Jobs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). + // Model Quality Monitoring Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) + // . StartTimeOffset *string noSmithyDocumentSerde @@ -2374,9 +1886,9 @@ type BlueGreenUpdatePolicy struct { // This member is required. TrafficRoutingConfiguration *TrafficRoutingConfig - // Maximum execution timeout for the deployment. Note that the timeout value should - // be larger than the total waiting time specified in TerminationWaitInSeconds and - // WaitIntervalInSeconds. + // Maximum execution timeout for the deployment. Note that the timeout value + // should be larger than the total waiting time specified in + // TerminationWaitInSeconds and WaitIntervalInSeconds . MaximumExecutionTimeoutInSeconds *int32 // Additional waiting time in seconds after the completion of an endpoint @@ -2452,12 +1964,9 @@ type CanvasAppSettings struct { type CapacitySize struct { // Specifies the endpoint capacity type. - // - // * INSTANCE_COUNT: The endpoint activates - // based on the number of instances. - // - // * CAPACITY_PERCENT: The endpoint activates - // based on the specified percentage of capacity. + // - INSTANCE_COUNT : The endpoint activates based on the number of instances. + // - CAPACITY_PERCENT : The endpoint activates based on the specified percentage + // of capacity. // // This member is required. Type CapacitySizeType @@ -2553,44 +2062,43 @@ type Channel struct { // This member is required. DataSource *DataSource - // If training data is compressed, the compression type. The default value is None. - // CompressionType is used only in Pipe input mode. In File mode, leave this field - // unset or set it to None. + // If training data is compressed, the compression type. The default value is None + // . CompressionType is used only in Pipe input mode. In File mode, leave this + // field unset or set it to None. CompressionType CompressionType // The MIME type of the data. ContentType *string // (Optional) The input mode to use for the data channel in a training job. If you - // don't set a value for InputMode, SageMaker uses the value set for - // TrainingInputMode. Use this parameter to override the TrainingInputMode setting - // in a AlgorithmSpecification request when you have a channel that needs a - // different input mode from the training job's general setting. To download the + // don't set a value for InputMode , SageMaker uses the value set for + // TrainingInputMode . Use this parameter to override the TrainingInputMode + // setting in a AlgorithmSpecification request when you have a channel that needs + // a different input mode from the training job's general setting. To download the // data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML - // storage volume, and mount the directory to a Docker volume, use File input mode. - // To stream data directly from Amazon S3 to the container, choose Pipe input mode. - // To use a model for incremental training, choose File input model. + // storage volume, and mount the directory to a Docker volume, use File input + // mode. To stream data directly from Amazon S3 to the container, choose Pipe + // input mode. To use a model for incremental training, choose File input model. InputMode TrainingInputMode // Specify RecordIO as the value when input data is in raw format but the training // algorithm requires the RecordIO format. In this case, SageMaker wraps each // individual S3 object in a RecordIO record. If the input data is already in // RecordIO format, you don't need to set this attribute. For more information, see - // Create a Dataset Using RecordIO - // (https://mxnet.apache.org/api/architecture/note_data_loading#data-format). In - // File mode, leave this field unset or set it to None. + // Create a Dataset Using RecordIO (https://mxnet.apache.org/api/architecture/note_data_loading#data-format) + // . In File mode, leave this field unset or set it to None. RecordWrapperType RecordWrapper // A configuration for a shuffle option for input data in a channel. If you use - // S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. - // If you use ManifestFile, the order of the S3 object references in the - // ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the + // S3Prefix for S3DataType , this shuffles the results of the S3 key prefix + // matches. If you use ManifestFile , the order of the S3 object references in the + // ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the // JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is // determined using the Seed value. For Pipe input mode, shuffling is done at the // start of every epoch. With large datasets this ensures that the order of the // training data is different for each epoch, it helps reduce bias and possible // overfitting. In a multi-node training job when ShuffleConfig is combined with - // S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so + // S3DataDistributionType of ShardedByS3Key , the data is shuffled across nodes so // that the content sent to a particular node on the first epoch might be sent to a // different node on the second epoch. ShuffleConfig *ShuffleConfig @@ -2637,21 +2145,20 @@ type ChannelSpecification struct { type CheckpointConfig struct { // Identifies the S3 path where you want SageMaker to store checkpoints. For - // example, s3://bucket-name/key-name-prefix. + // example, s3://bucket-name/key-name-prefix . // // This member is required. S3Uri *string // (Optional) The local directory where checkpoints are written. The default - // directory is /opt/ml/checkpoints/. + // directory is /opt/ml/checkpoints/ . LocalPath *string noSmithyDocumentSerde } // The container for the metadata for the ClarifyCheck step. For more information, -// see the topic on ClarifyCheck step -// (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check) +// see the topic on ClarifyCheck step (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check) // in the Amazon SageMaker Developer Guide. type ClarifyCheckStepMetadata struct { @@ -2673,13 +2180,13 @@ type ClarifyCheckStepMetadata struct { // This flag indicates if a newly calculated baseline can be accessed through step // properties BaselineUsedForDriftCheckConstraints and - // BaselineUsedForDriftCheckStatistics. If it is set to False, the previous + // BaselineUsedForDriftCheckStatistics . If it is set to False , the previous // baseline of the configured check type must also be available. These can be // accessed through the BaselineUsedForDriftCheckConstraints property. RegisterNewBaseline bool // This flag indicates if the drift check against the previous baseline will be - // skipped or not. If it is set to False, the previous baseline of the configured + // skipped or not. If it is set to False , the previous baseline of the configured // check type must be available. SkipCheck bool @@ -2698,9 +2205,8 @@ type ClarifyExplainerConfig struct { ShapConfig *ClarifyShapConfig // A JMESPath boolean expression used to filter which records to explain. - // Explanations are activated by default. See EnableExplanations - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable)for - // additional information. + // Explanations are activated by default. See EnableExplanations (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) + // for additional information. EnableExplanations *string // The inference configuration parameter for the model container. @@ -2715,35 +2221,33 @@ type ClarifyInferenceConfig struct { // A template string used to format a JSON record into an acceptable model // container input. For example, a ContentTemplate string // '{"myfeatures":$features}' will format a list of features [1,2,3] into the - // record string '{"myfeatures":[1,2,3]}'. Required only when the model container + // record string '{"myfeatures":[1,2,3]}' . Required only when the model container // input is in JSON Lines format. ContentTemplate *string // The names of the features. If provided, these are included in the endpoint // response payload to help readability of the InvokeEndpoint output. See the - // Response - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) + // Response (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) // section under Invoke the endpoint in the Developer Guide for more information. FeatureHeaders []string // A list of data types of the features (optional). Applicable only to NLP // explainability. If provided, FeatureTypes must have at least one 'text' string - // (for example, ['text']). If FeatureTypes is not provided, the explainer infers + // (for example, ['text'] ). If FeatureTypes is not provided, the explainer infers // the feature types based on the baseline data. The feature types are included in - // the endpoint response payload. For additional information see the response - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) + // the endpoint response payload. For additional information see the response (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) // section under Invoke the endpoint in the Developer Guide for more information. FeatureTypes []ClarifyFeatureType // Provides the JMESPath expression to extract the features from a model container // input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath - // expression 'myfeatures', it extracts a list of features [1,2,3] from request - // data '{"myfeatures":[1,2,3]}'. + // expression 'myfeatures' , it extracts a list of features [1,2,3] from request + // data '{"myfeatures":[1,2,3]}' . FeaturesAttribute *string // A JMESPath expression used to locate the list of label headers in the model // container output. Example: If the model container output of a batch request is - // '{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}', then set + // '{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}' , then set // LabelAttribute to 'labels' to extract the list of label headers // ["cat","dog","fish"] LabelAttribute *string @@ -2751,8 +2255,7 @@ type ClarifyInferenceConfig struct { // For multiclass classification problems, the label headers are the names of the // classes. Otherwise, the label header is the name of the predicted label. These // are used to help readability for the output of the InvokeEndpoint API. See the - // response - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) + // response (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) // section under Invoke the endpoint in the Developer Guide for more information. // If there are no label headers in the model container output, provide them // manually using this parameter. @@ -2761,8 +2264,8 @@ type ClarifyInferenceConfig struct { // A zero-based index used to extract a label header or list of label headers from // model container output in CSV format. Example for a multiclass model: If the // model container output consists of label headers followed by probabilities: - // '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"', set LabelIndex to 0 to select - // the label headers ['cat','dog','fish']. + // '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"' , set LabelIndex to 0 to select + // the label headers ['cat','dog','fish'] . LabelIndex *int32 // The maximum payload size (MB) allowed of a request from the explainer to the @@ -2770,56 +2273,50 @@ type ClarifyInferenceConfig struct { MaxPayloadInMB *int32 // The maximum number of records in a request that the model container can process - // when querying the model container for the predictions of a synthetic dataset - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic). - // A record is a unit of input data that inference can be made on, for example, a - // single line in CSV data. If MaxRecordCount is 1, the model container expects one - // record per request. A value of 2 or greater means that the model expects batch - // requests, which can reduce overhead and speed up the inferencing process. If - // this parameter is not provided, the explainer will tune the record count per + // when querying the model container for the predictions of a synthetic dataset (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic) + // . A record is a unit of input data that inference can be made on, for example, a + // single line in CSV data. If MaxRecordCount is 1 , the model container expects + // one record per request. A value of 2 or greater means that the model expects + // batch requests, which can reduce overhead and speed up the inferencing process. + // If this parameter is not provided, the explainer will tune the record count per // request according to the model container's capacity at runtime. MaxRecordCount *int32 // A JMESPath expression used to extract the probability (or score) from the model // container output if the model container is in JSON Lines format. Example: If the // model container output of a single request is - // '{"predicted_label":1,"probability":0.6}', then set ProbabilityAttribute to - // 'probability'. + // '{"predicted_label":1,"probability":0.6}' , then set ProbabilityAttribute to + // 'probability' . ProbabilityAttribute *string // A zero-based index used to extract a probability value (score) or list from // model container output in CSV format. If this value is not provided, the entire // model container output will be treated as a probability value (score) or list. // Example for a single class model: If the model container output consists of a - // string-formatted prediction label followed by its probability: '1,0.6', set - // ProbabilityIndex to 1 to select the probability value 0.6. Example for a + // string-formatted prediction label followed by its probability: '1,0.6' , set + // ProbabilityIndex to 1 to select the probability value 0.6 . Example for a // multiclass model: If the model container output consists of a string-formatted // prediction label followed by its probability: - // '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"', set ProbabilityIndex to 1 to - // select the probability values [0.1,0.6,0.3]. + // '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"' , set ProbabilityIndex to 1 to + // select the probability values [0.1,0.6,0.3] . ProbabilityIndex *int32 noSmithyDocumentSerde } -// The configuration for the SHAP baseline -// (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html) -// (also called the background or reference dataset) of the Kernal SHAP -// algorithm. -// -// * The number of records in the baseline data determines the size of -// the synthetic dataset, which has an impact on latency of explainability -// requests. For more information, see the Synthetic data of Configure and create -// an endpoint -// (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html). -// -// * -// ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or the -// either is required to configure a SHAP baseline. +// The configuration for the SHAP baseline (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html) +// (also called the background or reference dataset) of the Kernal SHAP algorithm. +// - The number of records in the baseline data determines the size of the +// synthetic dataset, which has an impact on latency of explainability requests. +// For more information, see the Synthetic data of Configure and create an +// endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) +// . +// - ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or +// the either is required to configure a SHAP baseline. type ClarifyShapBaselineConfig struct { // The MIME type of the baseline data. Choose from 'text/csv' or - // 'application/jsonlines'. Defaults to 'text/csv'. + // 'application/jsonlines' . Defaults to 'text/csv' . MimeType *string // The inline SHAP baseline data in string format. ShapBaseline can have one or @@ -2842,8 +2339,8 @@ type ClarifyShapBaselineConfig struct { // format. Each record should contain only the features. If you are using a virtual // private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For // more information about setting up endpoints with Amazon Virtual Private Cloud, - // see Give SageMaker access to Resources in your Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). + // see Give SageMaker access to Resources in your Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) + // . ShapBaselineUri *string noSmithyDocumentSerde @@ -2860,8 +2357,8 @@ type ClarifyShapConfig struct { // The number of samples to be used for analysis by the Kernal SHAP algorithm. The // number of samples determines the size of the synthetic dataset, which has an // impact on latency of explainability requests. For more information, see the - // Synthetic data of Configure and create an endpoint - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html). + // Synthetic data of Configure and create an endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) + // . NumberOfSamples *int32 // The starting value used to initialize the random number generator in the @@ -2869,9 +2366,9 @@ type ClarifyShapConfig struct { // result. Seed *int32 - // A parameter that indicates if text features are treated as text and explanations - // are provided for individual units of text. Required for natural language - // processing (NLP) explainability only. + // A parameter that indicates if text features are treated as text and + // explanations are provided for individual units of text. Required for natural + // language processing (NLP) explainability only. TextConfig *ClarifyTextConfig // A Boolean toggle to indicate if you want to use the logit function (true) or @@ -2887,16 +2384,15 @@ type ClarifyShapConfig struct { type ClarifyTextConfig struct { // The unit of granularity for the analysis of text features. For example, if the - // unit is 'token', then each token (like a word in English) of the text is treated - // as a feature. SHAP values are computed for each unit/feature. + // unit is 'token' , then each token (like a word in English) of the text is + // treated as a feature. SHAP values are computed for each unit/feature. // // This member is required. Granularity ClarifyTextGranularity - // Specifies the language of the text features in ISO 639-1 - // (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or ISO 639-3 - // (https://en.wikipedia.org/wiki/ISO_639-3) code of a supported language. For a - // mix of multiple languages, use code 'xx'. + // Specifies the language of the text features in ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + // or ISO 639-3 (https://en.wikipedia.org/wiki/ISO_639-3) code of a supported + // language. For a mix of multiple languages, use code 'xx' . // // This member is required. Language ClarifyTextLanguage @@ -2948,8 +2444,8 @@ type CodeRepositorySummary struct { } // Use this parameter to configure your Amazon Cognito workforce. A single Cognito -// workforce is created using and corresponds to a single Amazon Cognito user pool -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). +// workforce is created using and corresponds to a single Amazon Cognito user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) +// . type CognitoConfig struct { // The client ID for your Amazon Cognito user pool. @@ -2957,8 +2453,7 @@ type CognitoConfig struct { // This member is required. ClientId *string - // A user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // A user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) // is a user directory in Amazon Cognito. With a user pool, your users can sign in // to your web or mobile app through Amazon Cognito. Your users can also sign in // through social identity providers like Google, Facebook, Amazon, or Apple, and @@ -2974,8 +2469,8 @@ type CognitoConfig struct { // work teams. type CognitoMemberDefinition struct { - // An identifier for an application client. You must create the app client ID using - // Amazon Cognito. + // An identifier for an application client. You must create the app client ID + // using Amazon Cognito. // // This member is required. ClientId *string @@ -3002,9 +2497,9 @@ type CollectionConfiguration struct { // rule configuration names. CollectionName *string - // Parameter values for the tensor collection. The allowed parameters are "name", - // "include_regex", "reduction_config", "save_config", "tensor_names", and - // "save_histogram". + // Parameter values for the tensor collection. The allowed parameters are "name" , + // "include_regex" , "reduction_config" , "save_config" , "tensor_names" , and + // "save_histogram" . CollectionParameters map[string]string noSmithyDocumentSerde @@ -3043,8 +2538,8 @@ type CompilationJobSummary struct { // completed. CompilationTargetDevice TargetDevice - // The type of accelerator that the model will run on after the compilation job has - // completed. + // The type of accelerator that the model will run on after the compilation job + // has completed. CompilationTargetPlatformAccelerator TargetPlatformAccelerator // The type of architecture that the model will run on after the compilation job @@ -3073,18 +2568,17 @@ type ConditionStepMetadata struct { // Describes the container, as part of model definition. type ContainerDefinition struct { - // This parameter is ignored for models that contain only a PrimaryContainer. When + // This parameter is ignored for models that contain only a PrimaryContainer . When // a ContainerDefinition is part of an inference pipeline, the value of the // parameter uniquely identifies the container for the purposes of logging and // metrics. For information, see Use Logs and Metrics to Monitor an Inference - // Pipeline - // (https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html). - // If you don't specify a value for this parameter for a ContainerDefinition that - // is part of an inference pipeline, a unique name is automatically assigned based - // on the position of the ContainerDefinition in the pipeline. If you specify a - // value for the ContainerHostName for any ContainerDefinition that is part of an - // inference pipeline, you must specify a value for the ContainerHostName parameter - // of every ContainerDefinition in that pipeline. + // Pipeline (https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html) + // . If you don't specify a value for this parameter for a ContainerDefinition + // that is part of an inference pipeline, a unique name is automatically assigned + // based on the position of the ContainerDefinition in the pipeline. If you + // specify a value for the ContainerHostName for any ContainerDefinition that is + // part of an inference pipeline, you must specify a value for the + // ContainerHostName parameter of every ContainerDefinition in that pipeline. ContainerHostname *string // The environment variables to set in the Docker container. Each key and value in @@ -3097,10 +2591,9 @@ type ContainerDefinition struct { // that you configure for your endpoint. If you are using your own custom algorithm // instead of an algorithm provided by SageMaker, the inference code must meet // SageMaker requirements. SageMaker supports both registry/repository[:tag] and - // registry/repository[@digest] image path formats. For more information, see Using - // Your Own Algorithms with Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). The - // model artifacts in an Amazon S3 bucket and the Docker image for inference + // registry/repository[@digest] image path formats. For more information, see + // Using Your Own Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // . The model artifacts in an Amazon S3 bucket and the Docker image for inference // container in Amazon EC2 Container Registry must be in the same region as the // model or endpoint you are creating. Image *string @@ -3108,9 +2601,8 @@ type ContainerDefinition struct { // Specifies whether the model container is in Amazon ECR or a private Docker // registry accessible from your Amazon Virtual Private Cloud (VPC). For // information about storing containers in a private Docker registry, see Use a - // Private Docker Registry for Real-Time Inference Containers - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html). - // The model artifacts in an Amazon S3 bucket and the Docker image for inference + // Private Docker Registry for Real-Time Inference Containers (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html) + // . The model artifacts in an Amazon S3 bucket and the Docker image for inference // container in Amazon EC2 Container Registry must be in the same region as the // model or endpoint you are creating. ImageConfig *ImageConfig @@ -3125,24 +2617,22 @@ type ContainerDefinition struct { // stored. This path must point to a single gzip compressed tar archive (.tar.gz // suffix). The S3 path is required for SageMaker built-in algorithms, but not if // you use your own algorithms. For more information on built-in algorithms, see - // Common Parameters - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html). - // The model artifacts must be in an S3 bucket that is in the same region as the + // Common Parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) + // . The model artifacts must be in an S3 bucket that is in the same region as the // model or endpoint you are creating. If you provide a value for this parameter, // SageMaker uses Amazon Web Services Security Token Service to download model // artifacts from the S3 path you provide. Amazon Web Services STS is activated in // your Amazon Web Services account by default. If you previously deactivated // Amazon Web Services STS for a region, you need to reactivate Amazon Web Services // STS for that region. For more information, see Activating and Deactivating - // Amazon Web Services STS in an Amazon Web Services Region - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) + // Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Amazon Web Services Identity and Access Management User Guide. If you use // a built-in algorithm to create a model, SageMaker requires that you provide a S3 - // path to the model artifacts in ModelDataUrl. + // path to the model artifacts in ModelDataUrl . ModelDataUrl *string - // The name or Amazon Resource Name (ARN) of the model package to use to create the - // model. + // The name or Amazon Resource Name (ARN) of the model package to use to create + // the model. ModelPackageName *string // Specifies additional configuration for multi-model endpoints. @@ -3203,7 +2693,7 @@ type ContinuousParameterRange struct { MaxValue *string // The minimum value for the hyperparameter. The tuning job uses floating-point - // values between this value and MaxValuefor tuning. + // values between this value and MaxValue for tuning. // // This member is required. MinValue *string @@ -3215,9 +2705,8 @@ type ContinuousParameterRange struct { // The scale that hyperparameter tuning uses to search the hyperparameter range. // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: Auto SageMaker hyperparameter tuning chooses the + // Scaling (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type) + // . One of the following values: Auto SageMaker hyperparameter tuning chooses the // best scale for the hyperparameter. Linear Hyperparameter tuning searches the // values in the hyperparameter range by using a linear scale. Logarithmic // Hyperparameter tuning searches the values in the hyperparameter range by using a @@ -3259,7 +2748,7 @@ type ConvergenceDetected struct { } // A custom SageMaker image. For more information, see Bring your own SageMaker -// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). +// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) . type CustomImage struct { // The name of the AppImageConfig. @@ -3308,18 +2797,11 @@ type DataCaptureConfig struct { // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service // key that SageMaker uses to encrypt the captured data at rest using Amazon S3 // server-side encryption. The KmsKeyId can be any of the following formats: - // - // * Key - // ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias KmsKeyId *string noSmithyDocumentSerde @@ -3357,7 +2839,7 @@ type DataCaptureConfigSummary struct { } // The meta data of the Glue table which serves as data catalog for the -// OfflineStore. +// OfflineStore . type DataCatalogConfig struct { // The name of the Glue table catalog. @@ -3384,44 +2866,42 @@ type DataCatalogConfig struct { // data that is not needed for inference in a batch transform job. The output // filter provided allows you to include input data relevant to interpreting the // predictions in the output from the job. For more information, see Associate -// Prediction Results with their Corresponding Input Records -// (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). +// Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html) +// . type DataProcessing struct { - // A JSONPath - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) + // A JSONPath (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) // expression used to select a portion of the input data to pass to the algorithm. // Use the InputFilter parameter to exclude fields, such as an ID column, from the // input. If you want SageMaker to pass the entire input dataset to the algorithm, - // accept the default value $. Examples: "$", "$[1:]", "$.features" + // accept the default value $ . Examples: "$" , "$[1:]" , "$.features" InputFilter *string // Specifies the source of the data to join with the transformed data. The valid - // values are None and Input. The default value is None, which specifies not to + // values are None and Input . The default value is None , which specifies not to // join the input with the transformed data. If you want the batch transform job to - // join the original input data with the transformed data, set JoinSource to Input. - // You can specify OutputFilter as an additional filter to select a portion of the - // joined dataset and store it in the output file. For JSON or JSONLines objects, - // such as a JSON array, SageMaker adds the transformed data to the input JSON - // object in an attribute called SageMakerOutput. The joined result for JSON must - // be a key-value pair object. If the input is not a key-value pair object, + // join the original input data with the transformed data, set JoinSource to Input + // . You can specify OutputFilter as an additional filter to select a portion of + // the joined dataset and store it in the output file. For JSON or JSONLines + // objects, such as a JSON array, SageMaker adds the transformed data to the input + // JSON object in an attribute called SageMakerOutput . The joined result for JSON + // must be a key-value pair object. If the input is not a key-value pair object, // SageMaker creates a new JSON file. In the new JSON file, and the input data is // stored under the SageMakerInput key and the results are stored in - // SageMakerOutput. For CSV data, SageMaker takes each row as a JSON array and + // SageMakerOutput . For CSV data, SageMaker takes each row as a JSON array and // joins the transformed data with the input by appending each transformed row to // the end of the input. The joined data has the original input data followed by // the transformed data and the output is a CSV file. For information on how - // joining in applied, see Workflow for Associating Inferences with Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow). + // joining in applied, see Workflow for Associating Inferences with Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow) + // . JoinSource JoinSource - // A JSONPath - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) + // A JSONPath (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) // expression used to select a portion of the joined dataset to save in the output // file for a batch transform job. If you want SageMaker to store the entire input - // dataset in the output file, leave the default value, $. If you specify indexes + // dataset in the output file, leave the default value, $ . If you specify indexes // that aren't within the dimension size of the joined dataset, you get an error. - // Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']" + // Examples: "$" , "$[0,5:]" , "$['id','SageMakerOutput']" OutputFilter *string noSmithyDocumentSerde @@ -3475,8 +2955,8 @@ type DataQualityBaselineConfig struct { noSmithyDocumentSerde } -// The input for the data quality monitoring job. Currently endpoints are supported -// for input. +// The input for the data quality monitoring job. Currently endpoints are +// supported for input. type DataQualityJobInput struct { // Input object for the batch transform job. @@ -3499,11 +2979,12 @@ type DatasetDefinition struct { // Whether the generated dataset is FullyReplicated or ShardedByS3Key (default). DataDistributionType DataDistributionType - // Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker - // copies the data from the input source onto the local Amazon Elastic Block Store - // (Amazon EBS) volumes before starting your training algorithm. This is the most - // commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from - // the source directly to your algorithm without using the EBS volume. + // Whether to use File or Pipe input mode. In File (default) mode, Amazon + // SageMaker copies the data from the input source onto the local Amazon Elastic + // Block Store (Amazon EBS) volumes before starting your training algorithm. This + // is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams + // input data from the source directly to your algorithm without using the EBS + // volume. InputMode InputMode // The local path where you want Amazon SageMaker to download the Dataset @@ -3532,8 +3013,8 @@ type DataSource struct { // Configuration information for the Amazon SageMaker Debugger hook parameters, // metric and tensor collections, and storage paths. To learn more about how to // configure the DebugHookConfig parameter, see Use the SageMaker and Debugger -// Configuration API Operations to Create, Update, and Debug Your Training Job -// (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). +// Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) +// . type DebugHookConfig struct { // Path to Amazon S3 storage location for metrics and tensors. @@ -3542,17 +3023,17 @@ type DebugHookConfig struct { S3OutputPath *string // Configuration information for Amazon SageMaker Debugger tensor collections. To - // learn more about how to configure the CollectionConfiguration parameter, see Use - // the SageMaker and Debugger Configuration API Operations to Create, Update, and - // Debug Your Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // learn more about how to configure the CollectionConfiguration parameter, see + // Use the SageMaker and Debugger Configuration API Operations to Create, Update, + // and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . CollectionConfigurations []CollectionConfiguration // Configuration information for the Amazon SageMaker Debugger hook parameters. HookParameters map[string]string // Path to local storage location for metrics and tensors. Defaults to - // /opt/ml/output/tensors/. + // /opt/ml/output/tensors/ . LocalPath *string noSmithyDocumentSerde @@ -3561,8 +3042,8 @@ type DebugHookConfig struct { // Configuration information for SageMaker Debugger rules for debugging. To learn // more about how to configure the DebugRuleConfiguration parameter, see Use the // SageMaker and Debugger Configuration API Operations to Create, Update, and Debug -// Your Training Job -// (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). +// Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) +// . type DebugRuleConfiguration struct { // The name of the rule configuration. It must be unique relative to other rule @@ -3580,7 +3061,7 @@ type DebugRuleConfiguration struct { InstanceType ProcessingInstanceType // Path to local storage location for output of rules. Defaults to - // /opt/ml/processing/output/rule/. + // /opt/ml/processing/output/rule/ . LocalPath *string // Runtime configuration for rule container. @@ -3628,21 +3109,20 @@ type DefaultSpaceSettings struct { // The KernelGateway app settings. KernelGatewayAppSettings *KernelGatewayAppSettings - // The security groups for the Amazon Virtual Private Cloud that the space uses for - // communication. + // The security groups for the Amazon Virtual Private Cloud that the space uses + // for communication. SecurityGroups []string noSmithyDocumentSerde } // Gets the Amazon EC2 Container Registry path of the docker image of the model -// that is hosted in this ProductionVariant. If you used the +// that is hosted in this ProductionVariant . If you used the // registry/repository[:tag] form to specify the image path of the primary -// container when you created the model hosted in this ProductionVariant, the path -// resolves to a path of the form registry/repository[@digest]. A digest is a hash +// container when you created the model hosted in this ProductionVariant , the path +// resolves to a path of the form registry/repository[@digest] . A digest is a hash // value that identifies a specific version of an image. For information about -// Amazon ECR paths, see Pulling an Image -// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) +// Amazon ECR paths, see Pulling an Image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) // in the Amazon ECR User Guide. type DeployedImage struct { @@ -3650,7 +3130,7 @@ type DeployedImage struct { // ResolvedImage ResolutionTime *time.Time - // The specific digest path of the image hosted in this ProductionVariant. + // The specific digest path of the image hosted in this ProductionVariant . ResolvedImage *string // The image path you specified when you created the model. @@ -3931,13 +3411,13 @@ type DomainDetails struct { noSmithyDocumentSerde } -// A collection of settings that apply to the SageMaker Domain. These settings are +// A collection of settings that apply to the SageMaker Domain . These settings are // specified through the CreateDomain API call. type DomainSettings struct { // The configuration for attaching a SageMaker user profile name to the execution - // role as a sts:SourceIdentity key - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html). + // role as a sts:SourceIdentity key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // . ExecutionRoleIdentityConfig ExecutionRoleIdentityConfig // A collection of settings that configure the RStudioServerPro Domain-level app. @@ -3954,10 +3434,9 @@ type DomainSettings struct { type DomainSettingsForUpdate struct { // The configuration for attaching a SageMaker user profile name to the execution - // role as a sts:SourceIdentity key - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html). - // This configuration can only be modified if there are no apps in the InService or - // Pending state. + // role as a sts:SourceIdentity key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // . This configuration can only be modified if there are no apps in the InService + // or Pending state. ExecutionRoleIdentityConfig ExecutionRoleIdentityConfig // A collection of RStudioServerPro Domain-level app settings to update. @@ -4052,11 +3531,11 @@ type DriftCheckModelQuality struct { type Edge struct { // The type of the Association(Edge) between the source and destination. For - // example ContributedTo, Produced, or DerivedFrom. + // example ContributedTo , Produced , or DerivedFrom . AssociationType AssociationEdgeType - // The Amazon Resource Name (ARN) of the destination lineage entity of the directed - // edge. + // The Amazon Resource Name (ARN) of the destination lineage entity of the + // directed edge. DestinationArn *string // The Amazon Resource Name (ARN) of the source lineage entity of the directed @@ -4145,8 +3624,8 @@ type EdgeDeploymentStatus struct { // This member is required. EdgeDeploymentFailedInStage int32 - // The number of edge devices yet to pick up the deployment in current stage, or in - // progress. + // The number of edge devices yet to pick up the deployment in current stage, or + // in progress. // // This member is required. EdgeDeploymentPendingInStage int32 @@ -4262,28 +3741,20 @@ type EdgeOutputConfig struct { // The configuration used to create deployment artifacts. Specify configuration // options with a JSON string. The available configuration options for each type // are: - // - // * ComponentName (optional) - Name of the GreenGrass V2 component. If not - // specified, the default name generated consists of "SagemakerEdgeManager" and the - // name of your SageMaker Edge Manager packaging job. - // - // * ComponentDescription - // (optional) - Description of the component. - // - // * ComponentVersion (optional) - The - // version of the component. Amazon Web Services IoT Greengrass uses semantic - // versions for components. Semantic versions follow a major.minor.patch number - // system. For example, version 1.0.0 represents the first major release for a - // component. For more information, see the semantic version specification - // (https://semver.org/). - // - // * PlatformOS (optional) - The name of the operating - // system for the platform. Supported platforms include Windows and Linux. - // - // * - // PlatformArchitecture (optional) - The processor architecture for the platform. - // Supported architectures Windows include: Windows32_x86, Windows64_x64. Supported - // architectures for Linux include: Linux x86_64, Linux ARMV8. + // - ComponentName (optional) - Name of the GreenGrass V2 component. If not + // specified, the default name generated consists of "SagemakerEdgeManager" and the + // name of your SageMaker Edge Manager packaging job. + // - ComponentDescription (optional) - Description of the component. + // - ComponentVersion (optional) - The version of the component. Amazon Web + // Services IoT Greengrass uses semantic versions for components. Semantic versions + // follow a major.minor.patch number system. For example, version 1.0.0 represents + // the first major release for a component. For more information, see the + // semantic version specification (https://semver.org/) . + // - PlatformOS (optional) - The name of the operating system for the platform. + // Supported platforms include Windows and Linux. + // - PlatformArchitecture (optional) - The processor architecture for the + // platform. Supported architectures Windows include: Windows32_x86, Windows64_x64. + // Supported architectures for Linux include: Linux x86_64, Linux ARMV8. PresetDeploymentConfig *string // The deployment type SageMaker Edge Manager will create. Currently only supports @@ -4409,8 +3880,8 @@ type Endpoint struct { FailureReason *string // A list of monitoring schedules for the endpoint. For information about model - // monitoring, see Amazon SageMaker Model Monitor - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html). + // monitoring, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) + // . MonitoringSchedules []MonitoringSchedule // A list of the production variants hosted on the endpoint. Each production @@ -4423,9 +3894,8 @@ type Endpoint struct { ShadowProductionVariants []ProductionVariantSummary // A list of the tags associated with the endpoint. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []Tag noSmithyDocumentSerde @@ -4479,8 +3949,8 @@ type EndpointInput struct { // If specified, monitoring jobs substract this time from the end time. For // information about using offsets for scheduling monitoring jobs, see Schedule - // Model Quality Monitoring Jobs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). + // Model Quality Monitoring Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) + // . EndTimeOffset *string // The attributes of the input data that are the input features. @@ -4496,19 +3966,19 @@ type EndpointInput struct { // The threshold for the class probability to be evaluated as a positive result. ProbabilityThresholdAttribute *float64 - // Whether input data distributed in Amazon S3 is fully replicated or sharded by an - // S3 key. Defaults to FullyReplicated + // Whether input data distributed in Amazon S3 is fully replicated or sharded by + // an S3 key. Defaults to FullyReplicated S3DataDistributionType ProcessingS3DataDistributionType - // Whether the Pipe or File is used as the input mode for transferring data for the - // monitoring job. Pipe mode is recommended for large datasets. File mode is useful - // for small files that fit in memory. Defaults to File. + // Whether the Pipe or File is used as the input mode for transferring data for + // the monitoring job. Pipe mode is recommended for large datasets. File mode is + // useful for small files that fit in memory. Defaults to File . S3InputMode ProcessingS3InputMode // If specified, monitoring jobs substract this time from the start time. For // information about using offsets for scheduling monitoring jobs, see Schedule - // Model Quality Monitoring Jobs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). + // Model Quality Monitoring Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html) + // . StartTimeOffset *string noSmithyDocumentSerde @@ -4543,18 +4013,18 @@ type EndpointMetadata struct { EndpointConfigName *string // The status of the endpoint. For possible values of the status of an endpoint, - // see EndpointSummary$EndpointStatus. + // see EndpointSummary$EndpointStatus . EndpointStatus EndpointStatus - // If the status of the endpoint is Failed, or the status is InService but update + // If the status of the endpoint is Failed , or the status is InService but update // operation fails, this provides the reason why it failed. FailureReason *string noSmithyDocumentSerde } -// The endpoint configuration made by Inference Recommender during a recommendation -// job. +// The endpoint configuration made by Inference Recommender during a +// recommendation job. type EndpointOutputConfiguration struct { // The name of the endpoint made during a recommendation job. @@ -4572,8 +4042,8 @@ type EndpointOutputConfiguration struct { // This member is required. InstanceType ProductionVariantInstanceType - // The name of the production variant (deployed model) made during a recommendation - // job. + // The name of the production variant (deployed model) made during a + // recommendation job. // // This member is required. VariantName *string @@ -4581,8 +4051,8 @@ type EndpointOutputConfiguration struct { noSmithyDocumentSerde } -// The performance results from running an Inference Recommender job on an existing -// endpoint. +// The performance results from running an Inference Recommender job on an +// existing endpoint. type EndpointPerformance struct { // Details about a customer endpoint that was compared in an Inference Recommender @@ -4618,40 +4088,27 @@ type EndpointSummary struct { EndpointName *string // The status of the endpoint. - // - // * OutOfService: Endpoint is not available to take - // incoming requests. - // - // * Creating: CreateEndpoint is executing. - // - // * Updating: - // UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. - // - // * - // SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or - // deleted or re-scaled until it has completed. This maintenance operation does not - // change any customer-specified values such as VPC config, KMS encryption, model, - // instance type, or instance count. - // - // * RollingBack: Endpoint fails to scale up or - // down or change its variant weight and is in the process of rolling back to its - // previous configuration. Once the rollback completes, endpoint returns to an - // InService status. This transitional status only applies to an endpoint that has - // autoscaling enabled and is undergoing variant weight or capacity changes as part - // of an UpdateEndpointWeightsAndCapacities call or when the - // UpdateEndpointWeightsAndCapacities operation is called explicitly. - // - // * InService: - // Endpoint is available to process incoming requests. - // - // * Deleting: DeleteEndpoint - // is executing. - // - // * Failed: Endpoint could not be created, updated, or re-scaled. - // Use DescribeEndpointOutput$FailureReason for information about the failure. - // DeleteEndpoint is the only operation that can be performed on a failed - // endpoint. - // + // - OutOfService : Endpoint is not available to take incoming requests. + // - Creating : CreateEndpoint is executing. + // - Updating : UpdateEndpoint or UpdateEndpointWeightsAndCapacities is + // executing. + // - SystemUpdating : Endpoint is undergoing maintenance and cannot be updated or + // deleted or re-scaled until it has completed. This maintenance operation does not + // change any customer-specified values such as VPC config, KMS encryption, model, + // instance type, or instance count. + // - RollingBack : Endpoint fails to scale up or down or change its variant + // weight and is in the process of rolling back to its previous configuration. Once + // the rollback completes, endpoint returns to an InService status. This + // transitional status only applies to an endpoint that has autoscaling enabled and + // is undergoing variant weight or capacity changes as part of an + // UpdateEndpointWeightsAndCapacities call or when the + // UpdateEndpointWeightsAndCapacities operation is called explicitly. + // - InService : Endpoint is available to process incoming requests. + // - Deleting : DeleteEndpoint is executing. + // - Failed : Endpoint could not be created, updated, or re-scaled. Use + // DescribeEndpointOutput$FailureReason for information about the failure. + // DeleteEndpoint is the only operation that can be performed on a failed + // endpoint. // To get a list of endpoints with a specified status, use the // ListEndpointsInput$StatusEquals filter. // @@ -4729,8 +4186,8 @@ type Experiment struct { // The source of the experiment. Source *ExperimentSource - // The list of tags that are associated with the experiment. You can use Search API - // to search on the tags. + // The list of tags that are associated with the experiment. You can use Search + // API to search on the tags. Tags []Tag noSmithyDocumentSerde @@ -4738,13 +4195,9 @@ type Experiment struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: -// -// * CreateProcessingJob -// -// * -// CreateTrainingJob -// -// * CreateTransformJob +// - CreateProcessingJob +// - CreateTrainingJob +// - CreateTransformJob type ExperimentConfig struct { // The name of an existing experiment to associate with the trial component. @@ -4779,7 +4232,7 @@ type ExperimentSource struct { } // A summary of the properties of an experiment. To get the complete set of -// properties, call the DescribeExperiment API and provide the ExperimentName. +// properties, call the DescribeExperiment API and provide the ExperimentName . type ExperimentSummary struct { // When the experiment was created. @@ -4833,12 +4286,12 @@ type FailStepMetadata struct { noSmithyDocumentSerde } -// A list of features. You must include FeatureName and FeatureType. Valid feature -// FeatureTypes are Integral, Fractional and String. +// A list of features. You must include FeatureName and FeatureType . Valid feature +// FeatureType s are Integral , Fractional and String . type FeatureDefinition struct { // The name of a feature. The type must be a string. FeatureName cannot be any of - // the following: is_deleted, write_time, api_invocation_time. + // the following: is_deleted , write_time , api_invocation_time . FeatureName *string // The value type of a feature. Valid values are Integral, Fractional, or String. @@ -4856,30 +4309,30 @@ type FeatureGroup struct { // The time a FeatureGroup was created. CreationTime *time.Time - // A free form description of a FeatureGroup. + // A free form description of a FeatureGroup . Description *string - // The name of the feature that stores the EventTime of a Record in a FeatureGroup. - // A EventTime is point in time when a new event occurs that corresponds to the - // creation or update of a Record in FeatureGroup. All Records in the FeatureGroup - // must have a corresponding EventTime. + // The name of the feature that stores the EventTime of a Record in a FeatureGroup + // . A EventTime is point in time when a new event occurs that corresponds to the + // creation or update of a Record in FeatureGroup . All Records in the FeatureGroup + // must have a corresponding EventTime . EventTimeFeatureName *string - // The reason that the FeatureGroup failed to be replicated in the OfflineStore. + // The reason that the FeatureGroup failed to be replicated in the OfflineStore . // This is failure may be due to a failure to create a FeatureGroup in or delete a - // FeatureGroup from the OfflineStore. + // FeatureGroup from the OfflineStore . FailureReason *string - // A list of Features. Each Feature must include a FeatureName and a FeatureType. - // Valid FeatureTypes are Integral, Fractional and String. FeatureNames cannot be - // any of the following: is_deleted, write_time, api_invocation_time. You can - // create up to 2,500 FeatureDefinitions per FeatureGroup. + // A list of Feature s. Each Feature must include a FeatureName and a FeatureType . + // Valid FeatureType s are Integral , Fractional and String . FeatureName s cannot + // be any of the following: is_deleted , write_time , api_invocation_time . You can + // create up to 2,500 FeatureDefinition s per FeatureGroup . FeatureDefinitions []FeatureDefinition - // The Amazon Resource Name (ARN) of a FeatureGroup. + // The Amazon Resource Name (ARN) of a FeatureGroup . FeatureGroupArn *string - // The name of the FeatureGroup. + // The name of the FeatureGroup . FeatureGroupName *string // A FeatureGroup status. @@ -4891,60 +4344,60 @@ type FeatureGroup struct { // A value that indicates whether the feature group was updated successfully. LastUpdateStatus *LastUpdateStatus - // The configuration of an OfflineStore. Provide an OfflineStoreConfig in a request - // to CreateFeatureGroup to create an OfflineStore. To encrypt an OfflineStore - // using at rest data encryption, specify Amazon Web Services Key Management - // Service (KMS) key ID, or KMSKeyId, in S3StorageConfig. + // The configuration of an OfflineStore . Provide an OfflineStoreConfig in a + // request to CreateFeatureGroup to create an OfflineStore . To encrypt an + // OfflineStore using at rest data encryption, specify Amazon Web Services Key + // Management Service (KMS) key ID, or KMSKeyId , in S3StorageConfig . OfflineStoreConfig *OfflineStoreConfig - // The status of OfflineStore. + // The status of OfflineStore . OfflineStoreStatus *OfflineStoreStatus - // Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, - // or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by - // specifying the EnableOnlineStore flag at General Assembly; the default value is - // False. + // Use this to specify the Amazon Web Services Key Management Service (KMS) Key + // ID, or KMSKeyId , for at rest data encryption. You can turn OnlineStore on or + // off by specifying the EnableOnlineStore flag at General Assembly; the default + // value is False . OnlineStoreConfig *OnlineStoreConfig // The name of the Feature whose value uniquely identifies a Record defined in the - // FeatureGroupFeatureDefinitions. + // FeatureGroup FeatureDefinitions . RecordIdentifierFeatureName *string // The Amazon Resource Name (ARN) of the IAM execution role used to create the // feature group. RoleArn *string - // Tags used to define a FeatureGroup. + // Tags used to define a FeatureGroup . Tags []Tag noSmithyDocumentSerde } -// The name, Arn, CreationTime, FeatureGroup values, LastUpdatedTime and -// EnableOnlineStorage status of a FeatureGroup. +// The name, Arn, CreationTime , FeatureGroup values, LastUpdatedTime and +// EnableOnlineStorage status of a FeatureGroup . type FeatureGroupSummary struct { - // A timestamp indicating the time of creation time of the FeatureGroup. + // A timestamp indicating the time of creation time of the FeatureGroup . // // This member is required. CreationTime *time.Time - // Unique identifier for the FeatureGroup. + // Unique identifier for the FeatureGroup . // // This member is required. FeatureGroupArn *string - // The name of FeatureGroup. + // The name of FeatureGroup . // // This member is required. FeatureGroupName *string - // The status of a FeatureGroup. The status can be any of the following: Creating, - // Created, CreateFail, Deleting or DetailFail. + // The status of a FeatureGroup. The status can be any of the following: Creating , + // Created , CreateFail , Deleting or DetailFail . FeatureGroupStatus FeatureGroupStatus // Notifies you if replicating data into the OfflineStore has failed. Returns - // either: Active or Blocked. + // either: Active or Blocked . OfflineStoreStatus *OfflineStoreStatus noSmithyDocumentSerde @@ -5014,10 +4467,10 @@ type FileSource struct { // image. type FileSystemConfig struct { - // The default POSIX group ID (GID). If not specified, defaults to 100. + // The default POSIX group ID (GID). If not specified, defaults to 100 . DefaultGid *int32 - // The default POSIX user ID (UID). If not specified, defaults to 1000. + // The default POSIX user ID (UID). If not specified, defaults to 1000 . DefaultUid *int32 // The path within the image to mount the user's EFS home directory. The directory @@ -5056,98 +4509,74 @@ type FileSystemDataSource struct { // A conditional statement for a search expression that includes a resource // property, a Boolean operator, and a value. Resources that match the statement -// are returned in the results from the Search API. If you specify a Value, but not -// an Operator, SageMaker uses the equals operator. In search, there are several -// property types: Metrics To define a metric filter, enter a value using the form -// "Metrics.", where is a metric name. For example, the following filter searches -// -// for training jobs with an "accuracy" metric greater than "0.9": { -// "Name": -// -// "Metrics.accuracy", +// are returned in the results from the Search API. If you specify a Value , but +// not an Operator , SageMaker uses the equals operator. In search, there are +// several property types: Metrics To define a metric filter, enter a value using +// the form "Metrics." , where is a metric name. For example, the following +// filter searches for training jobs with an "accuracy" metric greater than "0.9" : // -// "Operator": "GreaterThan", +// { +// "Name": "Metrics.accuracy", // -// "Value": "0.9" +// "Operator": "GreaterThan", // -// } -// HyperParameters To define a hyperparameter filter, enter a value with the form -// "HyperParameters.". Decimal hyperparameter values are treated as a decimal in a -// comparison if the specified Value is also a decimal value. If the specified -// Value is an integer, the decimal hyperparameter values are treated as integers. -// For example, the following filter is satisfied by training jobs with a +// "Value": "0.9" +// } HyperParameters To define a hyperparameter filter, enter a value with the // -// "learning_rate" hyperparameter that is less than "0.5": { -// "Name": +// form "HyperParameters." . Decimal hyperparameter values are treated as a decimal +// in a comparison if the specified Value is also a decimal value. If the +// specified Value is an integer, the decimal hyperparameter values are treated as +// integers. For example, the following filter is satisfied by training jobs with a // -// "HyperParameters.learning_rate", +// "learning_rate" hyperparameter that is less than "0.5" : { +// "Name": "HyperParameters.learning_rate", // -// "Operator": "LessThan", +// "Operator": "LessThan", // -// "Value": -// -// "0.5" -// -// } Tags To define a tag filter, enter a value with the form Tags.. +// "Value": "0.5" +// } Tags To define a tag filter, enter a value with the form Tags. . type Filter struct { - // A resource property name. For example, TrainingJobName. For valid property - // names, see SearchRecord. You must specify a valid property for the resource. + // A resource property name. For example, TrainingJobName . For valid property + // names, see SearchRecord . You must specify a valid property for the resource. // // This member is required. Name *string // A Boolean binary operator that is used to evaluate the filter. The operator // field contains one of the following values: Equals The value of Name equals - // Value. NotEquals The value of Name doesn't equal Value. Exists The Name property - // exists. NotExists The Name property does not exist. GreaterThan The value of - // Name is greater than Value. Not supported for text properties. - // GreaterThanOrEqualTo The value of Name is greater than or equal to Value. Not - // supported for text properties. LessThan The value of Name is less than Value. + // Value . NotEquals The value of Name doesn't equal Value . Exists The Name + // property exists. NotExists The Name property does not exist. GreaterThan The + // value of Name is greater than Value . Not supported for text properties. + // GreaterThanOrEqualTo The value of Name is greater than or equal to Value . Not + // supported for text properties. LessThan The value of Name is less than Value . // Not supported for text properties. LessThanOrEqualTo The value of Name is less - // than or equal to Value. Not supported for text properties. In The value of Name - // is one of the comma delimited strings in Value. Only supported for text - // properties. Contains The value of Name contains the string Value. Only supported - // for text properties. A SearchExpression can include the Contains operator - // multiple times when the value of Name is one of the following: - // - // * - // Experiment.DisplayName - // - // * Experiment.ExperimentName - // - // * Experiment.Tags - // - // * - // Trial.DisplayName - // - // * Trial.TrialName - // - // * Trial.Tags - // - // * - // TrialComponent.DisplayName - // - // * TrialComponent.TrialComponentName - // - // * - // TrialComponent.Tags - // - // * TrialComponent.InputArtifacts - // - // * - // TrialComponent.OutputArtifacts - // - // A SearchExpression can include only one Contains - // operator for all other values of Name. In these cases, if you include multiple - // Contains operators in the SearchExpression, the result is the following error - // message: "'CONTAINS' operator usage limit of 1 exceeded." + // than or equal to Value . Not supported for text properties. In The value of Name + // is one of the comma delimited strings in Value . Only supported for text + // properties. Contains The value of Name contains the string Value . Only + // supported for text properties. A SearchExpression can include the Contains + // operator multiple times when the value of Name is one of the following: + // - Experiment.DisplayName + // - Experiment.ExperimentName + // - Experiment.Tags + // - Trial.DisplayName + // - Trial.TrialName + // - Trial.Tags + // - TrialComponent.DisplayName + // - TrialComponent.TrialComponentName + // - TrialComponent.Tags + // - TrialComponent.InputArtifacts + // - TrialComponent.OutputArtifacts + // A SearchExpression can include only one Contains operator for all other values + // of Name . In these cases, if you include multiple Contains operators in the + // SearchExpression , the result is the following error message: " 'CONTAINS' + // operator usage limit of 1 exceeded. " Operator Operator // A value used with Name and Operator to determine which resources satisfy the // filter's condition. For numerical properties, Value must be an integer or // floating-point decimal. For timestamp properties, Value must be an ISO 8601 - // date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS. + // date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS . Value *string noSmithyDocumentSerde @@ -5157,8 +4586,8 @@ type Filter struct { type FinalAutoMLJobObjectiveMetric struct { // The name of the metric with the best result. For a description of the possible - // objective metrics, see AutoMLJobObjective$MetricName - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html). + // objective metrics, see AutoMLJobObjective$MetricName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) + // . // // This member is required. MetricName AutoMLMetricEnum @@ -5169,8 +4598,8 @@ type FinalAutoMLJobObjectiveMetric struct { Value float32 // The name of the standard metric. For a description of the standard metrics, see - // Autopilot candidate metrics - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics). + // Autopilot candidate metrics (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics) + // . StandardMetricName AutoMLMetricEnum // The type of metric with the best result. @@ -5179,17 +4608,16 @@ type FinalAutoMLJobObjectiveMetric struct { noSmithyDocumentSerde } -// Shows the latest objective metric emitted by a training job that was launched by -// a hyperparameter tuning job. You define the objective metric in the -// HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig. +// Shows the latest objective metric emitted by a training job that was launched +// by a hyperparameter tuning job. You define the objective metric in the +// HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig . type FinalHyperParameterTuningJobObjectiveMetric struct { - // The name of the objective metric. For SageMaker built-in algorithms, metrics are - // defined per algorithm. See the metrics for XGBoost - // (https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html) as an - // example. You can also use a custom algorithm for training and define your own - // metrics. For more information, see Define metrics and environment variables - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). + // The name of the objective metric. For SageMaker built-in algorithms, metrics + // are defined per algorithm. See the metrics for XGBoost (https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html) + // as an example. You can also use a custom algorithm for training and define your + // own metrics. For more information, see Define metrics and environment variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) + // . // // This member is required. MetricName *string @@ -5211,8 +4639,8 @@ type FlowDefinitionOutputConfig struct { // The Amazon S3 path where the object containing human output will be made // available. To learn more about the format of Amazon A2I output data, see Amazon - // A2I Output Data - // (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-output-data.html). + // A2I Output Data (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-output-data.html) + // . // // This member is required. S3OutputPath *string @@ -5246,15 +4674,15 @@ type FlowDefinitionSummary struct { // This member is required. FlowDefinitionStatus FlowDefinitionStatus - // The reason why the flow definition creation failed. A failure reason is returned - // only when the flow definition status is Failed. + // The reason why the flow definition creation failed. A failure reason is + // returned only when the flow definition status is Failed . FailureReason *string noSmithyDocumentSerde } -// Specifies configuration details for a Git repository in your Amazon Web Services -// account. +// Specifies configuration details for a Git repository in your Amazon Web +// Services account. type GitConfig struct { // The URL where the Git repository is located. @@ -5265,10 +4693,10 @@ type GitConfig struct { // The default branch for the Git repository. Branch *string - // The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret - // that contains the credentials used to access the git repository. The secret must - // have a staging label of AWSCURRENT and must be in the following format: - // {"username": UserName, "password": Password} + // The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager + // secret that contains the credentials used to access the git repository. The + // secret must have a staging label of AWSCURRENT and must be in the following + // format: {"username": UserName, "password": Password} SecretArn *string noSmithyDocumentSerde @@ -5278,10 +4706,10 @@ type GitConfig struct { // updated. type GitConfigForUpdate struct { - // The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret - // that contains the credentials used to access the git repository. The secret must - // have a staging label of AWSCURRENT and must be in the following format: - // {"username": UserName, "password": Password} + // The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager + // secret that contains the credentials used to access the git repository. The + // secret must have a staging label of AWSCURRENT and must be in the following + // format: {"username": UserName, "password": Password} SecretArn *string noSmithyDocumentSerde @@ -5407,8 +4835,7 @@ type HumanLoopActivationConditionsConfig struct { // matched, atomic tasks are created against the configured work team. The set of // conditions is different for Rekognition and Textract. For more information about // how to structure the JSON, see JSON Schema for Human Loop Activation Conditions - // in Amazon Augmented AI - // (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-human-fallback-conditions-json-schema.html) + // in Amazon Augmented AI (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-human-fallback-conditions-json-schema.html) // in the Amazon SageMaker Developer Guide. // // This value conforms to the media type: application/json @@ -5424,8 +4851,8 @@ type HumanLoopActivationConditionsConfig struct { // humans. type HumanLoopActivationConfig struct { - // Container structure for defining under what conditions SageMaker creates a human - // loop. + // Container structure for defining under what conditions SageMaker creates a + // human loop. // // This member is required. HumanLoopActivationConditionsConfig *HumanLoopActivationConditionsConfig @@ -5439,11 +4866,10 @@ type HumanLoopConfig struct { // The Amazon Resource Name (ARN) of the human task user interface. You can use // standard HTML and Crowd HTML Elements to create a custom worker task template. // You use this template to create a human task UI. To learn how to create a custom - // HTML template, see Create Custom Worker Task Template - // (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html). To - // learn how to create a human task UI, which is a worker task template that can be - // used in a flow definition, see Create and Delete a Worker Task Templates - // (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-worker-template-console.html). + // HTML template, see Create Custom Worker Task Template (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html) + // . To learn how to create a human task UI, which is a worker task template that + // can be used in a flow definition, see Create and Delete a Worker Task Templates (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-worker-template-console.html) + // . // // This member is required. HumanTaskUiArn *string @@ -5468,8 +4894,8 @@ type HumanLoopConfig struct { // Amazon Resource Name (ARN) of a team of workers. To learn more about the types // of workforces and work teams you can create and use with Amazon A2I, see Create - // and Manage Workforces - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html). + // and Manage Workforces (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html) + // . // // This member is required. WorkteamArn *string @@ -5478,219 +4904,108 @@ type HumanLoopConfig struct { // task performed. Use one of the following prices for bounding box tasks. Prices // are in US dollars and should be based on the complexity of the task; the longer // it takes in your initial testing, the more you should offer. - // - // * 0.036 - // - // * - // 0.048 - // - // * 0.060 - // - // * 0.072 - // - // * 0.120 - // - // * 0.240 - // - // * 0.360 - // - // * 0.480 - // - // * 0.600 - // - // * 0.720 - // - // * - // 0.840 - // - // * 0.960 - // - // * 1.080 - // - // * 1.200 - // - // Use one of the following prices for image - // classification, text classification, and custom tasks. Prices are in US - // dollars. - // - // * 0.012 - // - // * 0.024 - // - // * 0.036 - // - // * 0.048 - // - // * 0.060 - // - // * 0.072 - // - // * 0.120 - // - // * - // 0.240 - // - // * 0.360 - // - // * 0.480 - // - // * 0.600 - // - // * 0.720 - // - // * 0.840 - // - // * 0.960 - // - // * 1.080 - // - // * - // 1.200 - // - // Use one of the following prices for semantic segmentation tasks. Prices - // are in US dollars. - // - // * 0.840 - // - // * 0.960 - // - // * 1.080 - // - // * 1.200 - // - // Use one of the following - // prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI - // review tasks. Prices are in US dollars. - // - // * 2.400 - // - // * 2.280 - // - // * 2.160 - // - // * 2.040 - // - // * - // 1.920 - // - // * 1.800 - // - // * 1.680 - // - // * 1.560 - // - // * 1.440 - // - // * 1.320 - // - // * 1.200 - // - // * 1.080 - // - // * 0.960 - // - // * - // 0.840 - // - // * 0.720 - // - // * 0.600 - // - // * 0.480 - // - // * 0.360 - // - // * 0.240 - // - // * 0.120 - // - // * 0.072 - // - // * 0.060 - // - // * - // 0.048 - // - // * 0.036 - // - // * 0.024 - // - // * 0.012 - // - // Use one of the following prices for - // Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are - // in US dollars. - // - // * 1.200 - // - // * 1.080 - // - // * 0.960 - // - // * 0.840 - // - // * 0.720 - // - // * 0.600 - // - // * 0.480 - // - // * - // 0.360 - // - // * 0.240 - // - // * 0.120 - // - // * 0.072 - // - // * 0.060 - // - // * 0.048 - // - // * 0.036 - // - // * 0.024 - // - // * - // 0.012 - // - // Use one of the following prices for Amazon Augmented AI custom human - // review tasks. Prices are in US dollars. - // - // * 1.200 - // - // * 1.080 - // - // * 0.960 - // - // * 0.840 - // - // * - // 0.720 - // - // * 0.600 - // - // * 0.480 - // - // * 0.360 - // - // * 0.240 - // - // * 0.120 - // - // * 0.072 - // - // * 0.060 - // - // * 0.048 - // - // * - // 0.036 - // - // * 0.024 - // - // * 0.012 + // - 0.036 + // - 0.048 + // - 0.060 + // - 0.072 + // - 0.120 + // - 0.240 + // - 0.360 + // - 0.480 + // - 0.600 + // - 0.720 + // - 0.840 + // - 0.960 + // - 1.080 + // - 1.200 + // Use one of the following prices for image classification, text classification, + // and custom tasks. Prices are in US dollars. + // - 0.012 + // - 0.024 + // - 0.036 + // - 0.048 + // - 0.060 + // - 0.072 + // - 0.120 + // - 0.240 + // - 0.360 + // - 0.480 + // - 0.600 + // - 0.720 + // - 0.840 + // - 0.960 + // - 1.080 + // - 1.200 + // Use one of the following prices for semantic segmentation tasks. Prices are in + // US dollars. + // - 0.840 + // - 0.960 + // - 1.080 + // - 1.200 + // Use one of the following prices for Textract AnalyzeDocument Important Form Key + // Amazon Augmented AI review tasks. Prices are in US dollars. + // - 2.400 + // - 2.280 + // - 2.160 + // - 2.040 + // - 1.920 + // - 1.800 + // - 1.680 + // - 1.560 + // - 1.440 + // - 1.320 + // - 1.200 + // - 1.080 + // - 0.960 + // - 0.840 + // - 0.720 + // - 0.600 + // - 0.480 + // - 0.360 + // - 0.240 + // - 0.120 + // - 0.072 + // - 0.060 + // - 0.048 + // - 0.036 + // - 0.024 + // - 0.012 + // Use one of the following prices for Rekognition DetectModerationLabels Amazon + // Augmented AI review tasks. Prices are in US dollars. + // - 1.200 + // - 1.080 + // - 0.960 + // - 0.840 + // - 0.720 + // - 0.600 + // - 0.480 + // - 0.360 + // - 0.240 + // - 0.120 + // - 0.072 + // - 0.060 + // - 0.048 + // - 0.036 + // - 0.024 + // - 0.012 + // Use one of the following prices for Amazon Augmented AI custom human review + // tasks. Prices are in US dollars. + // - 1.200 + // - 1.080 + // - 0.960 + // - 0.840 + // - 0.720 + // - 0.600 + // - 0.480 + // - 0.360 + // - 0.240 + // - 0.120 + // - 0.072 + // - 0.060 + // - 0.048 + // - 0.036 + // - 0.024 + // - 0.012 PublicWorkforceTaskPrice *PublicWorkforceTaskPrice // The length of time that a task remains available for review by human workers. @@ -5708,943 +5023,519 @@ type HumanLoopConfig struct { // Container for configuring the source of human task requests. type HumanLoopRequestSource struct { - - // Specifies whether Amazon Rekognition or Amazon Textract are used as the - // integration source. The default field settings and JSON parsing rules are - // different based on the integration source. Valid values: - // - // This member is required. - AwsManagedHumanLoopRequestSource AwsManagedHumanLoopRequestSource - - noSmithyDocumentSerde -} - -// Information required for human workers to complete a labeling task. -type HumanTaskConfig struct { - - // Configures how labels are consolidated across human workers. - // - // This member is required. - AnnotationConsolidationConfig *AnnotationConsolidationConfig - - // The number of human workers that will label an object. - // - // This member is required. - NumberOfHumanWorkersPerDataObject *int32 - - // The Amazon Resource Name (ARN) of a Lambda function that is run before a data - // object is sent to a human worker. Use this function to provide input to a custom - // labeling job. For built-in task types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html), use one - // of the following Amazon SageMaker Ground Truth Lambda function ARNs for - // PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-prelambda). - // Bounding box - Finds the most similar boxes from different workers based on the - // Jaccard index of the boxes. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox - // - // Image - // classification - Uses a variant of the Expectation Maximization approach to - // estimate the true class of an image based on annotations from individual - // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass - // - // Multi-label - // image classification - Uses a variant of the Expectation Maximization approach - // to estimate the true classes of an image based on annotations from individual - // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel - // - // Semantic - // segmentation - Treats each pixel in an image as a multi-class classification and - // treats pixel annotations from workers as "votes" for the correct label. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation - // - // Text - // classification - Uses a variant of the Expectation Maximization approach to - // estimate the true class of text based on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass - // - // Multi-label - // text classification - Uses a variant of the Expectation Maximization approach to - // estimate the true classes of text based on annotations from individual - // workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel - // - // Named - // entity recognition - Groups similar selections and calculates aggregate - // boundaries, resolving to most-assigned label. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition - // - // Video - // Classification - Use this task type when you need workers to classify videos - // using predefined labels that you specify. Workers are shown videos and are asked - // to choose one label for each video. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass - // - // Video - // Frame Object Detection - Use this task type to have workers identify and locate - // objects in a sequence of video frames (images extracted from a video) using - // bounding boxes. For example, you can use this task to ask workers to identify - // and localize various objects in a series of video frames, such as cars, bikes, - // and pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection - // - // Video - // Frame Object Tracking - Use this task type to have workers track the movement of - // objects in a sequence of video frames (images extracted from a video) using - // bounding boxes. For example, you can use this task to ask workers to track the - // movement of objects, such as cars, bikes, and pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking - // - // 3D - // Point Cloud Modalities Use the following pre-annotation lambdas for 3D point - // cloud labeling modality tasks. See 3D Point Cloud Task types - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-task-types.html) - // to learn more. 3D Point Cloud Object Detection - Use this task type when you - // want workers to classify objects in a 3D point cloud by drawing 3D cuboids - // around objects. For example, you can use this task type to ask workers to - // identify different types of objects in a point cloud, such as cars, bikes, and - // pedestrians. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection - // - // 3D - // Point Cloud Object Tracking - Use this task type when you want workers to draw - // 3D cuboids around objects that appear in a sequence of 3D point cloud frames. - // For example, you can use this task type to ask workers to track the movement of - // vehicles across multiple point cloud frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking - // - // 3D - // Point Cloud Semantic Segmentation - Use this task type when you want workers to - // create a point-level semantic segmentation masks by painting objects in a 3D - // point cloud using different colors where each color is assigned to one of the - // classes you specify. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation - // - // Use - // the following ARNs for Label Verification and Adjustment Jobs Use label - // verification and adjustment jobs to review and adjust labels. To learn more, see - // Verify and Adjust Labels - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html). - // Bounding box verification - Uses a variant of the Expectation Maximization - // approach to estimate the true class of verification judgement for bounding box - // labels based on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox - // - // Bounding - // box adjustment - Finds the most similar boxes from different workers based on - // the Jaccard index of the adjusted annotations. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox - // - // Semantic - // segmentation verification - Uses a variant of the Expectation Maximization - // approach to estimate the true class of verification judgment for semantic - // segmentation labels based on annotations from individual workers. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation - // - // Semantic - // segmentation adjustment - Treats each pixel in an image as a multi-class - // classification and treats pixel adjusted annotations from workers as "votes" for - // the correct label. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation - // - // Video - // Frame Object Detection Adjustment - Use this task type when you want workers to - // adjust bounding boxes that workers have added to video frames to classify and - // localize objects in a sequence of video frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection - // - // Video - // Frame Object Tracking Adjustment - Use this task type when you want workers to - // adjust bounding boxes that workers have added to video frames to track object - // movement across a sequence of video frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking - // - // 3D - // point cloud object detection adjustment - Adjust 3D cuboids in a point cloud - // frame. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection - // - // 3D - // point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of - // point cloud frames. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking - // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking - // - // 3D - // point cloud semantic segmentation adjustment - Adjust semantic segmentation - // masks in a 3D point cloud. - // - // * - // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation - // - // * - // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation + + // Specifies whether Amazon Rekognition or Amazon Textract are used as the + // integration source. The default field settings and JSON parsing rules are + // different based on the integration source. Valid values: // - // * - // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // This member is required. + AwsManagedHumanLoopRequestSource AwsManagedHumanLoopRequestSource + + noSmithyDocumentSerde +} + +// Information required for human workers to complete a labeling task. +type HumanTaskConfig struct { + + // Configures how labels are consolidated across human workers. // - // * - // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // This member is required. + AnnotationConsolidationConfig *AnnotationConsolidationConfig + + // The number of human workers that will label an object. // - // * - // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // This member is required. + NumberOfHumanWorkersPerDataObject *int32 + + // The Amazon Resource Name (ARN) of a Lambda function that is run before a data + // object is sent to a human worker. Use this function to provide input to a custom + // labeling job. For built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) + // , use one of the following Amazon SageMaker Ground Truth Lambda function ARNs + // for PreHumanTaskLambdaArn . For custom labeling workflows, see Pre-annotation + // Lambda (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-prelambda) + // . Bounding box - Finds the most similar boxes from different workers based on + // the Jaccard index of the boxes. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox + // Image classification - Uses a variant of the Expectation Maximization approach + // to estimate the true class of an image based on annotations from individual + // workers. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass + // Multi-label image classification - Uses a variant of the Expectation + // Maximization approach to estimate the true classes of an image based on + // annotations from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel + // Semantic segmentation - Treats each pixel in an image as a multi-class + // classification and treats pixel annotations from workers as "votes" for the + // correct label. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation + // Text classification - Uses a variant of the Expectation Maximization approach + // to estimate the true class of text based on annotations from individual workers. + // + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass + // Multi-label text classification - Uses a variant of the Expectation + // Maximization approach to estimate the true classes of text based on annotations + // from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel + // Named entity recognition - Groups similar selections and calculates aggregate + // boundaries, resolving to most-assigned label. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition + // Video Classification - Use this task type when you need workers to classify + // videos using predefined labels that you specify. Workers are shown videos and + // are asked to choose one label for each video. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass + // Video Frame Object Detection - Use this task type to have workers identify and + // locate objects in a sequence of video frames (images extracted from a video) + // using bounding boxes. For example, you can use this task to ask workers to + // identify and localize various objects in a series of video frames, such as cars, + // bikes, and pedestrians. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection + // Video Frame Object Tracking - Use this task type to have workers track the + // movement of objects in a sequence of video frames (images extracted from a + // video) using bounding boxes. For example, you can use this task to ask workers + // to track the movement of objects, such as cars, bikes, and pedestrians. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking + // 3D Point Cloud Modalities Use the following pre-annotation lambdas for 3D point + // cloud labeling modality tasks. See 3D Point Cloud Task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-task-types.html) + // to learn more. 3D Point Cloud Object Detection - Use this task type when you + // want workers to classify objects in a 3D point cloud by drawing 3D cuboids + // around objects. For example, you can use this task type to ask workers to + // identify different types of objects in a point cloud, such as cars, bikes, and + // pedestrians. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection + // 3D Point Cloud Object Tracking - Use this task type when you want workers to + // draw 3D cuboids around objects that appear in a sequence of 3D point cloud + // frames. For example, you can use this task type to ask workers to track the + // movement of vehicles across multiple point cloud frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking + // 3D Point Cloud Semantic Segmentation - Use this task type when you want workers + // to create a point-level semantic segmentation masks by painting objects in a 3D + // point cloud using different colors where each color is assigned to one of the + // classes you specify. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation + // Use the following ARNs for Label Verification and Adjustment Jobs Use label + // verification and adjustment jobs to review and adjust labels. To learn more, see + // Verify and Adjust Labels (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html) + // . Bounding box verification - Uses a variant of the Expectation Maximization + // approach to estimate the true class of verification judgement for bounding box + // labels based on annotations from individual workers. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox + // Bounding box adjustment - Finds the most similar boxes from different workers + // based on the Jaccard index of the adjusted annotations. + // - arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox + // - arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox + // Semantic segmentation verification - Uses a variant of the Expectation + // Maximization approach to estimate the true class of verification judgment for + // semantic segmentation labels based on annotations from individual workers. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation + // Semantic segmentation adjustment - Treats each pixel in an image as a + // multi-class classification and treats pixel adjusted annotations from workers as + // "votes" for the correct label. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation + // Video Frame Object Detection Adjustment - Use this task type when you want + // workers to adjust bounding boxes that workers have added to video frames to + // classify and localize objects in a sequence of video frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection + // Video Frame Object Tracking Adjustment - Use this task type when you want + // workers to adjust bounding boxes that workers have added to video frames to + // track object movement across a sequence of video frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking + // 3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud + // frame. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection + // 3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence + // of point cloud frames. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking + // 3D point cloud semantic segmentation adjustment - Adjust semantic segmentation + // masks in a 3D point cloud. + // - + // arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation + // - + // arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation // // This member is required. PreHumanTaskLambdaArn *string @@ -6656,20 +5547,15 @@ type HumanTaskConfig struct { // The amount of time that a worker has to complete a task. If you create a custom // labeling job, the maximum value for this parameter is 8 hours (28,800 seconds). - // If you create a labeling job using a built-in task type - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) the - // maximum for this parameter depends on the task type you use: - // - // * For image - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-images.html) and text - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-text.html) labeling - // jobs, the maximum is 8 hours (28,800 seconds). - // - // * For 3D point cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud.html) and video - // frame (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-video.html) labeling - // jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, - // the maximum is also 30 days. + // If you create a labeling job using a built-in task type (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html) + // the maximum for this parameter depends on the task type you use: + // - For image (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-images.html) + // and text (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-text.html) + // labeling jobs, the maximum is 8 hours (28,800 seconds). + // - For 3D point cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud.html) + // and video frame (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-video.html) + // labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For + // most users, the maximum is also 30 days. // // This member is required. TaskTimeLimitInSeconds *int32 @@ -6703,18 +5589,14 @@ type HumanTaskConfig struct { // The length of time that a task remains available for labeling by human workers. // The default and maximum values for this parameter depend on the type of // workforce you use. - // - // * If you choose the Amazon Mechanical Turk workforce, the - // maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 - // seconds). - // - // * If you choose a private or vendor workforce, the default value is - // 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also - // 30 days. + // - If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours + // (43,200 seconds). The default is 6 hours (21,600 seconds). + // - If you choose a private or vendor workforce, the default value is 30 days + // (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days. TaskAvailabilityLifetimeInSeconds *int32 - // Keywords used to describe the task so that workers on Amazon Mechanical Turk can - // discover the task. + // Keywords used to describe the task so that workers on Amazon Mechanical Turk + // can discover the task. TaskKeywords []string noSmithyDocumentSerde @@ -6741,12 +5623,12 @@ type HumanTaskUiSummary struct { noSmithyDocumentSerde } -// The configuration for Hyperband, a multi-fidelity based hyperparameter tuning -// strategy. Hyperband uses the final and intermediate results of a training job to -// dynamically allocate resources to utilized hyperparameter configurations while -// automatically stopping under-performing configurations. This parameter should be -// provided only if Hyperband is selected as the StrategyConfig under the -// HyperParameterTuningJobConfig API. +// The configuration for Hyperband , a multi-fidelity based hyperparameter tuning +// strategy. Hyperband uses the final and intermediate results of a training job +// to dynamically allocate resources to utilized hyperparameter configurations +// while automatically stopping under-performing configurations. This parameter +// should be provided only if Hyperband is selected as the StrategyConfig under +// the HyperParameterTuningJobConfig API. type HyperbandStrategyConfig struct { // The maximum number of resources (such as epochs) that can be used by a training @@ -6754,27 +5636,18 @@ type HyperbandStrategyConfig struct { // value, it is stopped. If a value for MaxResource is not provided, and Hyperband // is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts // to infer MaxResource from the following keys (if present) in - // StaticsHyperParameters - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters): - // - // * - // epochs - // - // * numepochs - // - // * n-epochs - // - // * n_epochs - // - // * num_epochs - // - // If - // HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates - // a validation error. The maximum value is 20,000 epochs. All metrics that - // correspond to an objective metric are used to derive early stopping decisions - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). - // For distributive - // (https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html) + // StaticsHyperParameters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters) + // : + // - epochs + // - numepochs + // - n-epochs + // - n_epochs + // - num_epochs + // If HyperbandStrategyConfig is unable to infer a value for MaxResource , it + // generates a validation error. The maximum value is 20,000 epochs. All metrics + // that correspond to an objective metric are used to derive early stopping + // decisions (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html) + // . For distributive (https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html) // training jobs, ensure that duplicate metrics are not printed in the logs across // the individual nodes in a training job. If multiple nodes are publishing // duplicate or incorrect metrics, training jobs may make an incorrect stopping @@ -6783,7 +5656,7 @@ type HyperbandStrategyConfig struct { // The minimum number of resources (such as epochs) that can be used by a training // job launched by a hyperparameter tuning job. If the value for MinResource has - // not been reached, the training job is not stopped by Hyperband. + // not been reached, the training job is not stopped by Hyperband . MinResource *int32 noSmithyDocumentSerde @@ -6794,48 +5667,47 @@ type HyperbandStrategyConfig struct { type HyperParameterAlgorithmSpecification struct { // The training input mode that the algorithm supports. For more information about - // input modes, see Algorithms - // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). Pipe mode If an - // algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon - // S3 to the container. File mode If an algorithm supports File mode, SageMaker - // downloads the training data from S3 to the provisioned ML storage volume, and - // mounts the directory to the Docker volume for the training container. You must - // provision the ML storage volume with sufficient capacity to accommodate the data - // downloaded from S3. In addition to the training data, the ML storage volume also - // stores the output model. The algorithm container uses the ML storage volume to - // also store intermediate information, if any. For distributed algorithms, - // training data is distributed uniformly. Your training duration is predictable if - // the input data objects sizes are approximately the same. SageMaker does not - // split the files any further for model training. If the object sizes are skewed, - // training won't be optimal as the data distribution is also skewed when one host - // in a training cluster is overloaded, thus becoming a bottleneck in training. - // FastFile mode If an algorithm supports FastFile mode, SageMaker streams data - // directly from S3 to the container with no code changes, and provides file system - // access to the data. Users can author their training script to interact with - // these files as if they were stored on disk. FastFile mode works best when the - // data is read sequentially. Augmented manifest files aren't supported. The - // startup time is lower when there are fewer files in the S3 bucket provided. + // input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) + // . Pipe mode If an algorithm supports Pipe mode, Amazon SageMaker streams data + // directly from Amazon S3 to the container. File mode If an algorithm supports + // File mode, SageMaker downloads the training data from S3 to the provisioned ML + // storage volume, and mounts the directory to the Docker volume for the training + // container. You must provision the ML storage volume with sufficient capacity to + // accommodate the data downloaded from S3. In addition to the training data, the + // ML storage volume also stores the output model. The algorithm container uses the + // ML storage volume to also store intermediate information, if any. For + // distributed algorithms, training data is distributed uniformly. Your training + // duration is predictable if the input data objects sizes are approximately the + // same. SageMaker does not split the files any further for model training. If the + // object sizes are skewed, training won't be optimal as the data distribution is + // also skewed when one host in a training cluster is overloaded, thus becoming a + // bottleneck in training. FastFile mode If an algorithm supports FastFile mode, + // SageMaker streams data directly from S3 to the container with no code changes, + // and provides file system access to the data. Users can author their training + // script to interact with these files as if they were stored on disk. FastFile + // mode works best when the data is read sequentially. Augmented manifest files + // aren't supported. The startup time is lower when there are fewer files in the S3 + // bucket provided. // // This member is required. TrainingInputMode TrainingInputMode // The name of the resource algorithm to use for the hyperparameter tuning job. If - // you specify a value for this parameter, do not specify a value for - // TrainingImage. + // you specify a value for this parameter, do not specify a value for TrainingImage + // . AlgorithmName *string - // An array of MetricDefinition objects that specify the metrics that the algorithm - // emits. + // An array of MetricDefinition objects that specify the metrics that the + // algorithm emits. MetricDefinitions []MetricDefinition // The registry path of the Docker image that contains the training algorithm. For // information about Docker registry paths for built-in algorithms, see Algorithms - // Provided by Amazon SageMaker: Common Parameters - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html). - // SageMaker supports both registry/repository[:tag] and - // registry/repository[@digest] image path formats. For more information, see Using - // Your Own Algorithms with Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). + // Provided by Amazon SageMaker: Common Parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html) + // . SageMaker supports both registry/repository[:tag] and + // registry/repository[@digest] image path formats. For more information, see + // Using Your Own Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // . TrainingImage *string noSmithyDocumentSerde @@ -6849,8 +5721,8 @@ type HyperParameterSpecification struct { // This member is required. Name *string - // The type of this hyperparameter. The valid types are Integer, Continuous, - // Categorical, and FreeText. + // The type of this hyperparameter. The valid types are Integer , Continuous , + // Categorical , and FreeText . // // This member is required. Type ParameterType @@ -6889,8 +5761,8 @@ type HyperParameterTrainingJobDefinition struct { // This member is required. OutputDataConfig *OutputDataConfig - // The Amazon Resource Name (ARN) of the IAM role associated with the training jobs - // that the tuning job launches. + // The Amazon Resource Name (ARN) of the IAM role associated with the training + // jobs that the tuning job launches. // // This member is required. RoleArn *string @@ -6911,14 +5783,14 @@ type HyperParameterTrainingJobDefinition struct { DefinitionName *string // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed + // training, choose True . Encryption provides greater security for distributed // training, but training might take longer. How long it takes depends on the // amount of communication between compute instances, especially if you use a deep // learning algorithm in distributed training. EnableInterContainerTrafficEncryption bool - // A Boolean indicating whether managed spot training is enabled (True) or not - // (False). + // A Boolean indicating whether managed spot training is enabled ( True ) or not ( + // False ). EnableManagedSpotTraining bool // Isolates the training container. No inbound or outbound network calls can be @@ -6929,12 +5801,9 @@ type HyperParameterTrainingJobDefinition struct { // access. EnableNetworkIsolation bool - // An environment variable that you can pass into the SageMaker CreateTrainingJob - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // API. You can use an existing environment variable from the training container - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment) - // or use your own. See Define metrics and variables - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) + // An environment variable that you can pass into the SageMaker CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) + // API. You can use an existing environment variable from the training container (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment) + // or use your own. See Define metrics and variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) // for more information. The maximum number of items specified for Map Entries // refers to the maximum number of environment variables for each // TrainingJobDefinition and also the maximum for the hyperparameter tuning job @@ -6947,17 +5816,17 @@ type HyperParameterTrainingJobDefinition struct { // training jobs with hyperparameter values within these ranges to find the // combination of values that result in the training job with the best performance // as measured by the objective metric of the hyperparameter tuning job. The - // maximum number of items specified for Array Members refers to the maximum number - // of hyperparameters for each range and also the maximum for the hyperparameter - // tuning job itself. That is, the sum of the number of hyperparameters for all the - // ranges can't exceed the maximum number specified. + // maximum number of items specified for Array Members refers to the maximum + // number of hyperparameters for each range and also the maximum for the + // hyperparameter tuning job itself. That is, the sum of the number of + // hyperparameters for all the ranges can't exceed the maximum number specified. HyperParameterRanges *ParameterRanges - // The configuration for the hyperparameter tuning resources, including the compute - // instances and storage volumes, used for training jobs launched by the tuning - // job. By default, storage volumes hold model artifacts and incremental states. - // Choose File for TrainingInputMode in the AlgorithmSpecification parameter to - // additionally store training data in the storage volume (optional). + // The configuration for the hyperparameter tuning resources, including the + // compute instances and storage volumes, used for training jobs launched by the + // tuning job. By default, storage volumes hold model artifacts and incremental + // states. Choose File for TrainingInputMode in the AlgorithmSpecification + // parameter to additionally store training data in the storage volume (optional). HyperParameterTuningResourceConfig *HyperParameterTuningResourceConfig // An array of Channel objects that specify the input for the training jobs that @@ -6975,7 +5844,7 @@ type HyperParameterTrainingJobDefinition struct { ResourceConfig *ResourceConfig // The number of times to retry the job when the job fails due to an - // InternalServerError. + // InternalServerError . RetryStrategy *RetryStrategy // Specifies the values of hyperparameters that do not change for the tuning job. @@ -6987,11 +5856,11 @@ type HyperParameterTrainingJobDefinition struct { // for this metric, depending on the value you specify for the Type parameter. TuningObjective *HyperParameterTuningJobObjective - // The VpcConfig object that specifies the VPC that you want the training jobs that - // this hyperparameter tuning job launches to connect to. Control access to and - // from your training container by configuring the VPC. For more information, see - // Protect Training Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // The VpcConfig object that specifies the VPC that you want the training jobs + // that this hyperparameter tuning job launches to connect to. Control access to + // and from your training container by configuring the VPC. For more information, + // see Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -7033,18 +5902,15 @@ type HyperParameterTrainingJobSummary struct { FinalHyperParameterTuningJobObjectiveMetric *FinalHyperParameterTuningJobObjectiveMetric // The status of the objective metric for the training job: + // - Succeeded: The final objective metric for the training job was evaluated by + // the hyperparameter tuning job and used in the hyperparameter tuning process. // - // * Succeeded: The final - // objective metric for the training job was evaluated by the hyperparameter tuning - // job and used in the hyperparameter tuning process. + // - Pending: The training job is in progress and evaluation of its final + // objective metric is pending. // - // * Pending: The training job - // is in progress and evaluation of its final objective metric is pending. - // - // * - // Failed: The final objective metric for the training job was not evaluated, and - // was not used in the hyperparameter tuning process. This typically occurs when - // the training job failed or did not emit an objective metric. + // - Failed: The final objective metric for the training job was not evaluated, + // and was not used in the hyperparameter tuning process. This typically occurs + // when the training job failed or did not emit an objective metric. ObjectiveStatus ObjectiveStatus // Specifies the time when the training job ends on training instances. You are @@ -7072,10 +5938,10 @@ type HyperParameterTrainingJobSummary struct { // allocation strategies to select resources (optional). type HyperParameterTuningInstanceConfig struct { - // The number of instances of the type specified by InstanceType. Choose an + // The number of instances of the type specified by InstanceType . Choose an // instance count larger than 1 for distributed training algorithms. See SageMaker - // distributed training jobs - // (https://docs.aws.amazon.com/data-parallel-use-api.html) for more information. + // distributed training jobs (https://docs.aws.amazon.com/data-parallel-use-api.html) + // for more information. // // This member is required. InstanceCount int32 @@ -7084,8 +5950,8 @@ type HyperParameterTuningInstanceConfig struct { // Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, // ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: // ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see - // instance type descriptions - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html). + // instance type descriptions (https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html) + // . // // This member is required. InstanceType TrainingInstanceType @@ -7127,8 +5993,8 @@ type HyperParameterTuningJobConfig struct { // Specifies how hyperparameter tuning chooses the combinations of hyperparameter // values to use for the training job it launches. For information about search - // strategies, see How Hyperparameter Tuning Works - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). + // strategies, see How Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html) + // . // // This member is required. Strategy HyperParameterTuningJobStrategyType @@ -7148,21 +6014,21 @@ type HyperParameterTuningJobConfig struct { // configuration between the two runs. RandomSeed *int32 - // The configuration for the Hyperband optimization strategy. This parameter should - // be provided only if Hyperband is selected as the strategy for - // HyperParameterTuningJobConfig. + // The configuration for the Hyperband optimization strategy. This parameter + // should be provided only if Hyperband is selected as the strategy for + // HyperParameterTuningJobConfig . StrategyConfig *HyperParameterTuningJobStrategyConfig // Specifies whether to use early stopping for training jobs launched by the // hyperparameter tuning job. Because the Hyperband strategy has its own advanced // internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to - // use Hyperband. This parameter can take on one of the following values (the - // default value is OFF): OFF Training jobs launched by the hyperparameter tuning + // use Hyperband . This parameter can take on one of the following values (the + // default value is OFF ): OFF Training jobs launched by the hyperparameter tuning // job do not use early stopping. AUTO SageMaker stops training jobs launched by // the hyperparameter tuning job when they are unlikely to perform better than - // previously completed training jobs. For more information, see Stop Training Jobs - // Early - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). + // previously completed training jobs. For more information, see Stop Training + // Jobs Early (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html) + // . TrainingJobEarlyStoppingType TrainingJobEarlyStoppingType // The tuning job's completion criteria. @@ -7199,8 +6065,7 @@ type HyperParameterTuningJobObjective struct { noSmithyDocumentSerde } -// An entity returned by the SearchRecord -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html) +// An entity returned by the SearchRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html) // API containing the properties of a hyperparameter tuning job. type HyperParameterTuningJobSearchEntity struct { @@ -7244,8 +6109,8 @@ type HyperParameterTuningJobSearchEntity struct { OverallBestTrainingJob *HyperParameterTrainingJobSummary // The tags associated with a hyperparameter tuning job. For more information see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []Tag // Defines the training jobs launched by a hyperparameter tuning job. @@ -7279,10 +6144,10 @@ type HyperParameterTuningJobSearchEntity struct { // The configuration for a training job launched by a hyperparameter tuning job. // Choose Bayesian for Bayesian optimization, and Random for random search -// optimization. For more advanced use cases, use Hyperband, which evaluates +// optimization. For more advanced use cases, use Hyperband , which evaluates // objective metrics for training jobs after every epoch. For more information -// about strategies, see How Hyperparameter Tuning Works -// (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). +// about strategies, see How Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html) +// . type HyperParameterTuningJobStrategyConfig struct { // The configuration for the object that specifies the Hyperband strategy. This @@ -7340,8 +6205,8 @@ type HyperParameterTuningJobSummary struct { // The date and time that the tuning job was modified. LastModifiedTime *time.Time - // The ResourceLimits object that specifies the maximum number of training jobs and - // parallel training jobs allowed for this tuning job. + // The ResourceLimits object that specifies the maximum number of training jobs + // and parallel training jobs allowed for this tuning job. ResourceLimits *ResourceLimits noSmithyDocumentSerde @@ -7363,9 +6228,8 @@ type HyperParameterTuningJobWarmStartConfig struct { // An array of hyperparameter tuning jobs that are used as the starting point for // the new hyperparameter tuning job. For more information about warm starting a // hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a - // Starting Point - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-warm-start.html). - // Hyperparameter tuning jobs created before October 1, 2018 cannot be used as + // Starting Point (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-warm-start.html) + // . Hyperparameter tuning jobs created before October 1, 2018 cannot be used as // parent jobs for warm start tuning jobs. // // This member is required. @@ -7399,12 +6263,12 @@ type HyperParameterTuningJobWarmStartConfig struct { // The configuration of resources, including compute instances and storage volumes // for use in training jobs launched by hyperparameter tuning jobs. -// HyperParameterTuningResourceConfig is similar to ResourceConfig, but has the +// HyperParameterTuningResourceConfig is similar to ResourceConfig , but has the // additional InstanceConfigs and AllocationStrategy fields to allow for flexible // instance management. Specify one or more instance types, count, and the // allocation strategy for instance selection. HyperParameterTuningResourceConfig // supports the capabilities of ResourceConfig with the exception of -// KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, +// KeepAlivePeriodInSeconds . Hyperparameter tuning jobs use warm pools by default, // which reuse clusters between training jobs. type HyperParameterTuningResourceConfig struct { @@ -7418,21 +6282,19 @@ type HyperParameterTuningResourceConfig struct { // The AllocationStrategy controls the order in which multiple configurations // provided in InstanceConfigs are used. If you only want to use a single instance // configuration inside the HyperParameterTuningResourceConfig API, do not provide - // a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and - // InstanceCount. If you use InstanceConfigs, do not provide values for - // InstanceType, VolumeSizeInGB or InstanceCount. + // a value for InstanceConfigs . Instead, use InstanceType , VolumeSizeInGB and + // InstanceCount . If you use InstanceConfigs , do not provide values for + // InstanceType , VolumeSizeInGB or InstanceCount . InstanceConfigs []HyperParameterTuningInstanceConfig // The number of compute instances of type InstanceType to use. For distributed - // training - // (https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html), - // select a value greater than 1. + // training (https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html) + // , select a value greater than 1. InstanceCount int32 // The instance type used to run hyperparameter optimization tuning jobs. See - // descriptions of instance types - // (https://docs.aws.amazon.com/notebooks-available-instance-types.html) for more - // information. + // descriptions of instance types (https://docs.aws.amazon.com/notebooks-available-instance-types.html) + // for more information. InstanceType TrainingInstanceType // A key used by Amazon Web Services Key Management Service to encrypt data on the @@ -7440,15 +6302,12 @@ type HyperParameterTuningResourceConfig struct { // You can use either of the following formats to specify a key. KMS Key ID: // "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS key: // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // Some instances use local storage, which use a hardware module to encrypt - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) + // Some instances use local storage, which use a hardware module to encrypt (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) // storage volumes. If you choose one of these instance types, you cannot request a - // VolumeKmsKeyId. For a list of instance types that use local storage, see - // instance store volumes - // (http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/). For - // more information about Amazon Web Services Key Management Service, see KMS - // encryption - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html) + // VolumeKmsKeyId . For a list of instance types that use local storage, see + // instance store volumes (http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/) + // . For more information about Amazon Web Services Key Management Service, see + // KMS encryption (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html) // for more information. VolumeKmsKeyId *string @@ -7459,10 +6318,8 @@ type HyperParameterTuningResourceConfig struct { // InstanceConfigs is also specified. Some instance types have a fixed total local // storage size. If you select one of these instances for training, VolumeSizeInGB // cannot be greater than this total size. For a list of instance types with local - // instance storage and their sizes, see instance store volumes - // (http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/). - // SageMaker supports only the General Purpose SSD (gp2) - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) + // instance storage and their sizes, see instance store volumes (http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/) + // . SageMaker supports only the General Purpose SSD (gp2) (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) // storage volume type. VolumeSizeInGB int32 @@ -7487,7 +6344,7 @@ type IamIdentity struct { // A SageMaker image. A SageMaker image represents a set of container images that // are derived from a common base container image. Each of these container images -// is represented by a SageMaker ImageVersion. +// is represented by a SageMaker ImageVersion . type Image struct { // When the image was created. @@ -7543,12 +6400,8 @@ type ImageClassificationJobConfig struct { type ImageConfig struct { // Set this to one of the following values: - // - // * Platform - The model image is hosted - // in Amazon ECR. - // - // * Vpc - The model image is hosted in a private Docker registry - // in your VPC. + // - Platform - The model image is hosted in Amazon ECR. + // - Vpc - The model image is hosted in a private Docker registry in your VPC. // // This member is required. RepositoryAccessMode RepositoryAccessMode @@ -7563,7 +6416,7 @@ type ImageConfig struct { noSmithyDocumentSerde } -// A version of a SageMaker Image. A version represents an existing container +// A version of a SageMaker Image . A version represents an existing container // image. type ImageVersion struct { @@ -7607,12 +6460,8 @@ type ImageVersion struct { type InferenceExecutionConfig struct { // How containers in a multi-container are run. The following values are valid. - // - // * - // SERIAL - Containers run as a serial pipeline. - // - // * DIRECT - Only the individual - // container that you specify is run. + // - SERIAL - Containers run as a serial pipeline. + // - DIRECT - Only the individual container that you specify is run. // // This member is required. Mode InferenceExecutionMode @@ -7633,8 +6482,8 @@ type InferenceExperimentDataStorageConfig struct { // specified SageMaker will by default base64 encode when capturing the data. ContentType *CaptureContentTypeHeader - // The Amazon Web Services Key Management Service key that Amazon SageMaker uses to - // encrypt captured data at rest using Amazon S3 server-side encryption. + // The Amazon Web Services Key Management Service key that Amazon SageMaker uses + // to encrypt captured data at rest using Amazon S3 server-side encryption. KmsKey *string noSmithyDocumentSerde @@ -7796,8 +6645,7 @@ type InferenceRecommendationsJob struct { } // A returned array object for the Steps response field in the -// ListInferenceRecommendationsJobSteps -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html) +// ListInferenceRecommendationsJobSteps (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html) // API command. type InferenceRecommendationsJobStep struct { @@ -7811,7 +6659,7 @@ type InferenceRecommendationsJobStep struct { // This member is required. Status RecommendationJobStatus - // The type of the subtask. BENCHMARK: Evaluate the performance of your model on + // The type of the subtask. BENCHMARK : Evaluate the performance of your model on // different instance types. // // This member is required. @@ -7863,199 +6711,104 @@ type InputConfig struct { // Specifies the name and shape of the expected data inputs for your trained model // with a JSON dictionary form. The data inputs are InputConfig$Framework // specific. - // - // * TensorFlow: You must specify the name and shape (NHWC format) of - // the expected data inputs using a dictionary format for your trained model. The - // dictionary formats required for the console and CLI are different. - // - // * Examples - // for one input: - // - // * If using the console, {"input":[1,1024,1024,3]} - // - // * If using - // the CLI, {\"input\":[1,1024,1024,3]} - // - // * Examples for two inputs: - // - // * If using the - // console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} - // - // * If using the CLI, - // {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} - // - // * KERAS: You must specify the - // name and shape (NCHW format) of expected data inputs using a dictionary format - // for your trained model. Note that while Keras model artifacts should be uploaded - // in NHWC (channel-last) format, DataInputConfig should be specified in NCHW - // (channel-first) format. The dictionary formats required for the console and CLI - // are different. - // - // * Examples for one input: - // - // * If using the console, - // {"input_1":[1,3,224,224]} - // - // * If using the CLI, {\"input_1\":[1,3,224,224]} - // - // * - // Examples for two inputs: - // - // * If using the console, {"input_1": [1,3,224,224], - // "input_2":[1,3,224,224]} - // - // * If using the CLI, {\"input_1\": [1,3,224,224], - // \"input_2\":[1,3,224,224]} - // - // * MXNET/ONNX/DARKNET: You must specify the name and - // shape (NCHW format) of the expected data inputs in order using a dictionary - // format for your trained model. The dictionary formats required for the console - // and CLI are different. - // - // * Examples for one input: - // - // * If using the console, - // {"data":[1,3,1024,1024]} - // - // * If using the CLI, {\"data\":[1,3,1024,1024]} - // - // * - // Examples for two inputs: - // - // * If using the console, {"var1": [1,1,28,28], - // "var2":[1,1,28,28]} - // - // * If using the CLI, {\"var1\": [1,1,28,28], - // \"var2\":[1,1,28,28]} - // - // * PyTorch: You can either specify the name and shape - // (NCHW format) of expected data inputs in order using a dictionary format for - // your trained model or you can specify the shape only using a list format. The - // dictionary formats required for the console and CLI are different. The list - // formats for the console and CLI are the same. - // - // * Examples for one input in - // dictionary format: - // - // * If using the console, {"input0":[1,3,224,224]} - // - // * If using - // the CLI, {\"input0\":[1,3,224,224]} - // - // * Example for one input in list format: - // [[1,3,224,224]] - // - // * Examples for two inputs in dictionary format: - // - // * If using the - // console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} - // - // * If using the CLI, - // {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} - // - // * Example for two inputs - // in list format: [[1,3,224,224], [1,3,224,224]] - // - // * XGBOOST: input data name and - // shape are not needed. - // - // DataInputConfig supports the following parameters for - // CoreMLOutputConfig$TargetDevice (ML Model format): - // - // * shape: Input shape, for - // example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input - // shapes, CoreML converter supports Flexible input shapes: - // - // * Range Dimension. You - // can use the Range Dimension feature if you know the input shape will be within - // some specific interval in that dimension, for example: {"input_1": {"shape": - // ["1..10", 224, 224, 3]}} - // - // * Enumerated shapes. Sometimes, the models are trained - // to work only on a select set of inputs. You can enumerate all supported input - // shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, - // 3]]}} - // - // * default_shape: Default input shape. You can set a default shape during - // conversion for both Range Dimension and Enumerated Shapes. For example - // {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, - // 3]}} - // - // * type: Input type. Allowed values: Image and Tensor. By default, the - // converter generates an ML Model with inputs of type Tensor (MultiArray). User - // can set input type to be Image. Image input type requires additional input - // parameters such as bias and scale. - // - // * bias: If the input type is an Image, you - // need to provide the bias vector. - // - // * scale: If the input type is an Image, you - // need to provide a scale factor. - // - // CoreML ClassifierConfig parameters can be - // specified using OutputConfig$CompilerOptions. CoreML converter supports - // Tensorflow and PyTorch models. CoreML conversion examples: - // - // * Tensor type - // input: - // - // * "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], - // [1,160,160,3]], "default_shape": [1,224,224,3]}} - // - // * Tensor type input without - // input name (PyTorch): - // - // * "DataInputConfig": [{"shape": [[1,3,224,224], - // [1,3,160,160]], "default_shape": [1,3,224,224]}] - // - // * Image type input: - // - // * - // "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], - // "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": - // 0.007843137255}} - // - // * "CompilerOptions": {"class_labels": - // "imagenet_labels_1000.txt"} - // - // * Image type input without input name (PyTorch): - // - // * - // "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": - // [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}] - // - // * - // "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"} - // - // Depending on - // the model format, DataInputConfig requires the following parameters for - // ml_eia2OutputConfig:TargetDevice - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice). - // - // * - // For TensorFlow models saved in the SavedModel format, specify the input names - // from signature_def_key and the input model shapes for DataInputConfig. Specify - // the signature_def_key in OutputConfig:CompilerOptions - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions) - // if the model does not use TensorFlow's default signature def key. For - // example: - // - // * "DataInputConfig": {"inputs": [1, 224, 224, 3]} - // - // * - // "CompilerOptions": {"signature_def_key": "serving_custom"} - // - // * For TensorFlow - // models saved as a frozen graph, specify the input tensor names and shapes in - // DataInputConfig and the output tensor names for output_names in - // OutputConfig:CompilerOptions - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions). - // For example: - // - // * "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]} - // - // * - // "CompilerOptions": {"output_names": ["output_tensor:0"]} + // - TensorFlow : You must specify the name and shape (NHWC format) of the + // expected data inputs using a dictionary format for your trained model. The + // dictionary formats required for the console and CLI are different. + // - Examples for one input: + // - If using the console, {"input":[1,1024,1024,3]} + // - If using the CLI, {\"input\":[1,1024,1024,3]} + // - Examples for two inputs: + // - If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} + // - If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} + // - KERAS : You must specify the name and shape (NCHW format) of expected data + // inputs using a dictionary format for your trained model. Note that while Keras + // model artifacts should be uploaded in NHWC (channel-last) format, + // DataInputConfig should be specified in NCHW (channel-first) format. The + // dictionary formats required for the console and CLI are different. + // - Examples for one input: + // - If using the console, {"input_1":[1,3,224,224]} + // - If using the CLI, {\"input_1\":[1,3,224,224]} + // - Examples for two inputs: + // - If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]} + // - If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]} + // - MXNET/ONNX/DARKNET : You must specify the name and shape (NCHW format) of + // the expected data inputs in order using a dictionary format for your trained + // model. The dictionary formats required for the console and CLI are different. + // - Examples for one input: + // - If using the console, {"data":[1,3,1024,1024]} + // - If using the CLI, {\"data\":[1,3,1024,1024]} + // - Examples for two inputs: + // - If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]} + // - If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} + // - PyTorch : You can either specify the name and shape (NCHW format) of + // expected data inputs in order using a dictionary format for your trained model + // or you can specify the shape only using a list format. The dictionary formats + // required for the console and CLI are different. The list formats for the console + // and CLI are the same. + // - Examples for one input in dictionary format: + // - If using the console, {"input0":[1,3,224,224]} + // - If using the CLI, {\"input0\":[1,3,224,224]} + // - Example for one input in list format: [[1,3,224,224]] + // - Examples for two inputs in dictionary format: + // - If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} + // - If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} + // - Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]] + // - XGBOOST : input data name and shape are not needed. + // DataInputConfig supports the following parameters for CoreML + // OutputConfig$TargetDevice (ML Model format): + // - shape : Input shape, for example {"input_1": {"shape": [1,224,224,3]}} . In + // addition to static input shapes, CoreML converter supports Flexible input + // shapes: + // - Range Dimension. You can use the Range Dimension feature if you know the + // input shape will be within some specific interval in that dimension, for + // example: {"input_1": {"shape": ["1..10", 224, 224, 3]}} + // - Enumerated shapes. Sometimes, the models are trained to work only on a + // select set of inputs. You can enumerate all supported input shapes, for example: + // {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}} + // - default_shape : Default input shape. You can set a default shape during + // conversion for both Range Dimension and Enumerated Shapes. For example + // {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, + // 3]}} + // - type : Input type. Allowed values: Image and Tensor . By default, the + // converter generates an ML Model with inputs of type Tensor (MultiArray). User + // can set input type to be Image. Image input type requires additional input + // parameters such as bias and scale . + // - bias : If the input type is an Image, you need to provide the bias vector. + // - scale : If the input type is an Image, you need to provide a scale factor. + // CoreML ClassifierConfig parameters can be specified using + // OutputConfig$CompilerOptions . CoreML converter supports Tensorflow and PyTorch + // models. CoreML conversion examples: + // - Tensor type input: + // - "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], + // "default_shape": [1,224,224,3]}} + // - Tensor type input without input name (PyTorch): + // - "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], + // "default_shape": [1,3,224,224]}] + // - Image type input: + // - "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], + // "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": + // 0.007843137255}} + // - "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"} + // - Image type input without input name (PyTorch): + // - "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], + // "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": + // 0.007843137255}] + // - "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"} + // Depending on the model format, DataInputConfig requires the following + // parameters for ml_eia2 OutputConfig:TargetDevice (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice) + // . + // - For TensorFlow models saved in the SavedModel format, specify the input + // names from signature_def_key and the input model shapes for DataInputConfig . + // Specify the signature_def_key in OutputConfig:CompilerOptions (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions) + // if the model does not use TensorFlow's default signature def key. For example: + // - "DataInputConfig": {"inputs": [1, 224, 224, 3]} + // - "CompilerOptions": {"signature_def_key": "serving_custom"} + // - For TensorFlow models saved as a frozen graph, specify the input tensor + // names and shapes in DataInputConfig and the output tensor names for + // output_names in OutputConfig:CompilerOptions (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions) + // . For example: + // - "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]} + // - "CompilerOptions": {"output_names": ["output_tensor:0"]} // // This member is required. DataInputConfig *string @@ -8073,21 +6826,19 @@ type InputConfig struct { // This member is required. S3Uri *string - // Specifies the framework version to use. This API field is only supported for the - // MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks. For information about - // framework versions supported for cloud targets and edge devices, see Cloud - // Supported Instance Types and Frameworks - // (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html) and - // Edge Supported Frameworks - // (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-devices-edge-frameworks.html). + // Specifies the framework version to use. This API field is only supported for + // the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks. For information + // about framework versions supported for cloud targets and edge devices, see + // Cloud Supported Instance Types and Frameworks (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html) + // and Edge Supported Frameworks (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-devices-edge-frameworks.html) + // . FrameworkVersion *string noSmithyDocumentSerde } // Defines an instance group for heterogeneous cluster training. When requesting a -// training job using the CreateTrainingJob -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) +// training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) // API, you can configure multiple instance groups . type InstanceGroup struct { @@ -8113,9 +6864,9 @@ type InstanceGroup struct { type InstanceMetadataServiceConfiguration struct { // Indicates the minimum IMDS version that the notebook instance supports. When - // passed as part of CreateNotebookInstance, if no value is selected, then it + // passed as part of CreateNotebookInstance , if no value is selected, then it // defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If - // passed as part of UpdateNotebookInstance, there is no default. + // passed as part of UpdateNotebookInstance , there is no default. // // This member is required. MinimumInstanceMetadataServiceVersion *string @@ -8144,9 +6895,8 @@ type IntegerParameterRange struct { // The scale that hyperparameter tuning uses to search the hyperparameter range. // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: Auto SageMaker hyperparameter tuning chooses the + // Scaling (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type) + // . One of the following values: Auto SageMaker hyperparameter tuning chooses the // best scale for the hyperparameter. Linear Hyperparameter tuning searches the // values in the hyperparameter range by using a linear scale. Logarithmic // Hyperparameter tuning searches the values in the hyperparameter range by using a @@ -8290,22 +7040,14 @@ type LabelingJobAlgorithmsConfig struct { // Specifies the Amazon Resource Name (ARN) of the algorithm used for // auto-labeling. You must select one of the following ARNs: - // - // * Image - // classification - // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification - // - // * - // Text classification - // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification - // - // * - // Object detection - // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection - // - // * - // Semantic Segmentation - // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation + // - Image classification + // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification + // - Text classification + // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification + // - Object detection + // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection + // - Semantic Segmentation + // arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation // // This member is required. LabelingJobAlgorithmSpecificationArn *string @@ -8322,8 +7064,8 @@ type LabelingJobAlgorithmsConfig struct { noSmithyDocumentSerde } -// Attributes of the data specified by the customer. Use these to describe the data -// to be labeled. +// Attributes of the data specified by the customer. Use these to describe the +// data to be labeled. type LabelingJobDataAttributes struct { // Declares that your content is free of personally identifiable information or @@ -8334,21 +7076,21 @@ type LabelingJobDataAttributes struct { noSmithyDocumentSerde } -// Provides information about the location of input data. You must specify at least -// one of the following: S3DataSource or SnsDataSource. Use SnsDataSource to -// specify an SNS input topic for a streaming labeling job. If you do not specify -// and SNS input topic ARN, Ground Truth will create a one-time labeling job. Use -// S3DataSource to specify an input manifest file for both streaming and one-time -// labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to -// create a streaming labeling job. +// Provides information about the location of input data. You must specify at +// least one of the following: S3DataSource or SnsDataSource . Use SnsDataSource +// to specify an SNS input topic for a streaming labeling job. If you do not +// specify and SNS input topic ARN, Ground Truth will create a one-time labeling +// job. Use S3DataSource to specify an input manifest file for both streaming and +// one-time labeling jobs. Adding an S3DataSource is optional if you use +// SnsDataSource to create a streaming labeling job. type LabelingJobDataSource struct { // The Amazon S3 location of the input data objects. S3DataSource *LabelingJobS3DataSource // An Amazon SNS data source used for streaming labeling jobs. To learn more, see - // Send Data to a Streaming Labeling Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-send-data). + // Send Data to a Streaming Labeling Job (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-send-data) + // . SnsDataSource *LabelingJobSnsDataSource noSmithyDocumentSerde @@ -8423,29 +7165,27 @@ type LabelingJobOutputConfig struct { // This member is required. S3OutputPath *string - // The Amazon Web Services Key Management Service ID of the key used to encrypt the - // output data, if any. If you provide your own KMS key ID, you must add the + // The Amazon Web Services Key Management Service ID of the key used to encrypt + // the output data, if any. If you provide your own KMS key ID, you must add the // required permissions to your KMS key described in Encrypt Output Data and - // Storage Volume with Amazon Web Services KMS - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-permission.html#sms-security-kms-permissions). - // If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web - // Services KMS key for Amazon S3 for your role's account to encrypt your output - // data. If you use a bucket policy with an s3:PutObject permission that only - // allows objects with server-side encryption, set the condition key of - // s3:x-amz-server-side-encryption to "aws:kms". For more information, see - // KMS-Managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the - // Amazon Simple Storage Service Developer Guide. + // Storage Volume with Amazon Web Services KMS (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-permission.html#sms-security-kms-permissions) + // . If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon + // Web Services KMS key for Amazon S3 for your role's account to encrypt your + // output data. If you use a bucket policy with an s3:PutObject permission that + // only allows objects with server-side encryption, set the condition key of + // s3:x-amz-server-side-encryption to "aws:kms" . For more information, see + // KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // in the Amazon Simple Storage Service Developer Guide. KmsKeyId *string // An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a // SnsTopicArn if you want to do real time chaining to another streaming job and // receive an Amazon SNS notifications each time a data object is submitted by a - // worker. If you provide an SnsTopicArn in OutputConfig, when workers complete + // worker. If you provide an SnsTopicArn in OutputConfig , when workers complete // labeling tasks, Ground Truth will send labeling task output data to the SNS // output topic you specify here. To learn more, see Receive Output Data from a - // Streaming Labeling Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-output-data). + // Streaming Labeling Job (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-output-data) + // . SnsTopicArn *string noSmithyDocumentSerde @@ -8458,29 +7198,24 @@ type LabelingJobResourceConfig struct { // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key // that Amazon SageMaker uses to encrypt data on the storage volume attached to the // ML compute instance(s) that run the training and inference jobs used for - // automated data labeling. You can only specify a VolumeKmsKeyId when you create a - // labeling job with automated data labeling enabled using the API operation - // CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt + // automated data labeling. You can only specify a VolumeKmsKeyId when you create + // a labeling job with automated data labeling enabled using the API operation + // CreateLabelingJob . You cannot specify an Amazon Web Services KMS key to encrypt // the storage volume used for automated data labeling model training and inference - // when you create a labeling job using the console. To learn more, see Output Data - // and Storage Volume Encryption - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security.html). The - // VolumeKmsKeyId can be any of the following formats: - // - // * KMS Key ID - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * Amazon Resource Name (ARN) of a KMS - // Key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // when you create a labeling job using the console. To learn more, see Output + // Data and Storage Volume Encryption (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security.html) + // . The VolumeKmsKeyId can be any of the following formats: + // - KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - Amazon Resource Name (ARN) of a KMS Key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string // Specifies a VPC that your training jobs and hosted models have access to. // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) - // and Protect Training Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // and Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -8490,20 +7225,15 @@ type LabelingJobResourceConfig struct { type LabelingJobS3DataSource struct { // The Amazon S3 location of the manifest file that describes the input data - // objects. The input manifest file referenced in ManifestS3Uri must contain one of - // the following keys: source-ref or source. The value of the keys are interpreted - // as follows: - // - // * source-ref: The source of the object is the Amazon S3 object - // specified in the value. Use this value when the object is a binary object, such - // as an image. - // - // * source: The source of the object is the value. Use this value - // when the object is a text value. - // - // If you are a new user of Ground Truth, it is - // recommended you review Use an Input Manifest File - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-input-data-input-manifest.html) + // objects. The input manifest file referenced in ManifestS3Uri must contain one + // of the following keys: source-ref or source . The value of the keys are + // interpreted as follows: + // - source-ref : The source of the object is the Amazon S3 object specified in + // the value. Use this value when the object is a binary object, such as an image. + // - source : The source of the object is the value. Use this value when the + // object is a text value. + // If you are a new user of Ground Truth, it is recommended you review Use an + // Input Manifest File (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-input-data-input-manifest.html) // in the Amazon SageMaker Developer Guide to learn how to create an input manifest // file. // @@ -8586,11 +7316,11 @@ type LabelingJobSummary struct { // The Amazon Resource Name (ARN) of the Lambda function used to consolidate the // annotations from individual workers into a label for a data object. For more - // information, see Annotation Consolidation - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html). + // information, see Annotation Consolidation (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html) + // . AnnotationConsolidationLambdaArn *string - // If the LabelingJobStatus field is Failed, this field contains a description of + // If the LabelingJobStatus field is Failed , this field contains a description of // the error. FailureReason *string @@ -8630,8 +7360,8 @@ type LastUpdateStatus struct { noSmithyDocumentSerde } -// Lists a summary of the properties of a lineage group. A lineage group provides a -// group of shareable lineage entity resources. +// Lists a summary of the properties of a lineage group. A lineage group provides +// a group of shareable lineage entity resources. type LineageGroupSummary struct { // The creation time of the lineage group summary. @@ -8652,8 +7382,8 @@ type LineageGroupSummary struct { noSmithyDocumentSerde } -// Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work -// team. +// Defines an Amazon Cognito or your own OIDC IdP user group that is part of a +// work team. type MemberDefinition struct { // The Amazon Cognito user group that is part of the work team. @@ -8661,7 +7391,7 @@ type MemberDefinition struct { // A list user groups that exist in your OIDC Identity Provider (IdP). One to ten // groups can be used to create a single private work team. When you add a user - // group to the list of Groups, you can add that user group to one or more private + // group to the list of Groups , you can add that user group to one or more private // work teams. If you add a user group to a private work team, all workers in that // user group are added to the work team. OidcMemberDefinition *OidcMemberDefinition @@ -8713,8 +7443,8 @@ type MetricDatum struct { Set MetricSetSource // The name of the standard metric. For definitions of the standard metrics, see - // Autopilot candidate metrics - // (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics). + // Autopilot candidate metrics (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics) + // . StandardMetricName AutoMLMetricExtendedEnum // The value of the metric. @@ -8723,12 +7453,11 @@ type MetricDatum struct { noSmithyDocumentSerde } -// Specifies a metric that the training algorithm writes to stderr or stdout. You +// Specifies a metric that the training algorithm writes to stderr or stdout . You // can view these logs to understand how your training job performs and check for // any errors encountered during training. SageMaker hyperparameter tuning captures // all defined metrics. Specify one of the defined metrics to use as an objective -// metric using the TuningObjective -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective) +// metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective) // parameter in the HyperParameterTrainingJobDefinition API to evaluate job // performance during hyperparameter tuning. type MetricDefinition struct { @@ -8740,8 +7469,8 @@ type MetricDefinition struct { // A regular expression that searches the output of a training job and gets the // value of the metric. For more information about using regular expressions to - // define metrics, see Defining metrics and environment variables - // (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). + // define metrics, see Defining metrics and environment variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) + // . // // This member is required. Regex *string @@ -8797,17 +7526,16 @@ type Model struct { PrimaryContainer *ContainerDefinition // A list of key-value pairs associated with the model. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []Tag // Specifies a VPC that your training jobs and hosted models have access to. // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) - // and Protect Training Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // and Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -8820,7 +7548,7 @@ type Model struct { type ModelArtifacts struct { // The path of the S3 object that contains the model artifacts. For example, - // s3://bucket-name/keynameprefix/model.tar.gz. + // s3://bucket-name/keynameprefix/model.tar.gz . // // This member is required. S3ModelArtifacts *string @@ -8832,8 +7560,8 @@ type ModelArtifacts struct { type ModelBiasAppSpecification struct { // JSON formatted S3 file that defines bias parameters. For more information on - // this JSON configuration file, see Configure bias parameters - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html). + // this JSON configuration file, see Configure bias parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html) + // . // // This member is required. ConfigUri *string @@ -8881,8 +7609,7 @@ type ModelBiasJobInput struct { // An Amazon SageMaker Model Card. type ModelCard struct { - // The content of the model card. Content uses the model card JSON schema - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) + // The content of the model card. Content uses the model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html) // and provided as a string. Content *string @@ -8907,19 +7634,12 @@ type ModelCard struct { ModelCardName *string // The approval status of the model card within your organization. Different - // organizations might have different criteria for model card review and - // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // organizations might have different criteria for model card review and approval. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. ModelCardStatus ModelCardStatus // The version of the model card. @@ -8929,8 +7649,8 @@ type ModelCard struct { ModelId *string // The risk rating of the model. Different organizations might have different - // criteria for model card risk ratings. For more information, see Risk ratings - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-risk-rating.html). + // criteria for model card risk ratings. For more information, see Risk ratings (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-risk-rating.html) + // . RiskRating *string // The security configuration used to protect model card data. @@ -9008,8 +7728,7 @@ type ModelCardExportOutputConfig struct { // Configure the security settings to protect model card data. type ModelCardSecurityConfig struct { - // A Key Management Service key ID - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) + // A Key Management Service key ID (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) // to use for encrypting a model card. KmsKeyId *string @@ -9035,19 +7754,12 @@ type ModelCardSummary struct { ModelCardName *string // The approval status of the model card within your organization. Different - // organizations might have different criteria for model card review and - // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // organizations might have different criteria for model card review and approval. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. // // This member is required. ModelCardStatus ModelCardStatus @@ -9079,17 +7791,11 @@ type ModelCardVersionSummary struct { // The approval status of the model card version within your organization. // Different organizations might have different criteria for model card review and // approval. - // - // * Draft: The model card is a work in progress. - // - // * PendingReview: The - // model card is pending review. - // - // * Approved: The model card is approved. - // - // * - // Archived: The model card is archived. No more updates should be made to the - // model card, but it can still be exported. + // - Draft : The model card is a work in progress. + // - PendingReview : The model card is pending review. + // - Approved : The model card is approved. + // - Archived : The model card is archived. No more updates should be made to the + // model card, but it can still be exported. // // This member is required. ModelCardStatus ModelCardStatus @@ -9120,8 +7826,8 @@ type ModelClientConfig struct { noSmithyDocumentSerde } -// Defines the model configuration. Includes the specification name and environment -// parameters. +// Defines the model configuration. Includes the specification name and +// environment parameters. type ModelConfiguration struct { // The name of the compilation job used to create the recommended model artifacts. @@ -9185,8 +7891,8 @@ type ModelDashboardModel struct { Endpoints []ModelDashboardEndpoint // A batch transform job. For information about SageMaker batch transform, see Use - // Batch Transform - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). + // Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html) + // . LastBatchTransformJob *TransformJob // A model displayed in the Model Dashboard. @@ -9237,7 +7943,7 @@ type ModelDashboardModelCard struct { // A model card's risk rating. Can be low, medium, or high. RiskRating *string - // The KMS Key ID (KMSKeyId) for encryption of model card information. + // The KMS Key ID ( KMSKeyId ) for encryption of model card information. SecurityConfig *ModelCardSecurityConfig // The tags associated with a model card. @@ -9298,20 +8004,20 @@ type ModelDataQuality struct { noSmithyDocumentSerde } -// Specifies how to generate the endpoint name for an automatic one-click Autopilot -// model deployment. +// Specifies how to generate the endpoint name for an automatic one-click +// Autopilot model deployment. type ModelDeployConfig struct { - // Set to True to automatically generate an endpoint name for a one-click Autopilot - // model deployment; set to False otherwise. The default value is False. If you set - // AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a - // 400 error is thrown. + // Set to True to automatically generate an endpoint name for a one-click + // Autopilot model deployment; set to False otherwise. The default value is False . + // If you set AutoGenerateEndpointName to True , do not specify the EndpointName ; + // otherwise a 400 error is thrown. AutoGenerateEndpointName bool - // Specifies the endpoint name to use for a one-click Autopilot model deployment if - // the endpoint name is not generated automatically. Specify the EndpointName if - // and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is - // thrown. + // Specifies the endpoint name to use for a one-click Autopilot model deployment + // if the endpoint name is not generated automatically. Specify the EndpointName + // if and only if you set AutoGenerateEndpointName to False ; otherwise a 400 error + // is thrown. EndpointName *string noSmithyDocumentSerde @@ -9341,8 +8047,8 @@ type ModelExplainabilityAppSpecification struct { // JSON formatted S3 file that defines explainability parameters. For more // information on this JSON configuration file, see Configure model explainability - // parameters - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html). + // parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html) + // . // // This member is required. ConfigUri *string @@ -9387,8 +8093,7 @@ type ModelInfrastructureConfig struct { // The inference option to which to deploy your model. Possible values are the // following: - // - // * RealTime: Deploy to real-time inference. + // - RealTime : Deploy to real-time inference. // // This member is required. InfrastructureType ModelInfrastructureType @@ -9424,8 +8129,8 @@ type ModelLatencyThreshold struct { noSmithyDocumentSerde } -// Part of the search expression. You can specify the name and value (domain, task, -// framework, framework version, task, and model). +// Part of the search expression. You can specify the name and value (domain, +// task, framework, framework version, task, and model). type ModelMetadataFilter struct { // The name of the of the model to filter by. @@ -9510,11 +8215,11 @@ type ModelPackage struct { // A description provided when the model approval is set. ApprovalDescription *string - // Whether the model package is to be certified to be listed on Amazon Web Services - // Marketplace. For information about listing model packages on Amazon Web Services - // Marketplace, see List Your Algorithm or Model Package on Amazon Web Services - // Marketplace - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html). + // Whether the model package is to be certified to be listed on Amazon Web + // Services Marketplace. For information about listing model packages on Amazon Web + // Services Marketplace, see List Your Algorithm or Model Package on Amazon Web + // Services Marketplace (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html) + // . CertifyForMarketplace bool // Information about the user who created or modified an experiment, trial, trial @@ -9550,14 +8255,9 @@ type ModelPackage struct { MetadataProperties *MetadataProperties // The approval status of the model. This can be one of the following values. - // - // * - // APPROVED - The model is approved - // - // * REJECTED - The model is rejected. - // - // * - // PENDING_MANUAL_APPROVAL - The model is waiting for manual approval. + // - APPROVED - The model is approved + // - REJECTED - The model is rejected. + // - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval. ModelApprovalStatus ModelApprovalStatus // Metrics for the model. @@ -9576,20 +8276,11 @@ type ModelPackage struct { ModelPackageName *string // The status of the model package. This can be one of the following values. - // - // * - // PENDING - The model package is pending being created. - // - // * IN_PROGRESS - The model - // package is in the process of being created. - // - // * COMPLETED - The model package was - // successfully created. - // - // * FAILED - The model package failed. - // - // * DELETING - The - // model package is in the process of being deleted. + // - PENDING - The model package is pending being created. + // - IN_PROGRESS - The model package is in the process of being created. + // - COMPLETED - The model package was successfully created. + // - FAILED - The model package failed. + // - DELETING - The model package is in the process of being deleted. ModelPackageStatus ModelPackageStatus // Specifies the validation and image scan statuses of the model package. @@ -9598,17 +8289,16 @@ type ModelPackage struct { // The version number of a versioned model. ModelPackageVersion *int32 - // The Amazon Simple Storage Service path where the sample payload are stored. This - // path must point to a single gzip compressed tar archive (.tar.gz suffix). + // The Amazon Simple Storage Service path where the sample payload are stored. + // This path must point to a single gzip compressed tar archive (.tar.gz suffix). SamplePayloadUrl *string // A list of algorithms that were used to create a model package. SourceAlgorithmSpecification *SourceAlgorithmSpecification // A list of the tags associated with the model package. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []Tag // The machine learning task your model package accomplishes. Common machine @@ -9629,9 +8319,9 @@ type ModelPackageContainerDefinition struct { // stored. If you are using your own custom algorithm instead of an algorithm // provided by SageMaker, the inference code must meet SageMaker requirements. // SageMaker supports both registry/repository[:tag] and - // registry/repository[@digest] image path formats. For more information, see Using - // Your Own Algorithms with Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). + // registry/repository[@digest] image path formats. For more information, see + // Using Your Own Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // . // // This member is required. Image *string @@ -9655,9 +8345,9 @@ type ModelPackageContainerDefinition struct { ImageDigest *string // The Amazon S3 path where the model artifacts, which result from model training, - // are stored. This path must point to a single gzip compressed tar archive - // (.tar.gz suffix). The model artifacts must be in an S3 bucket that is in the - // same region as the model package. + // are stored. This path must point to a single gzip compressed tar archive ( + // .tar.gz suffix). The model artifacts must be in an S3 bucket that is in the same + // region as the model package. ModelDataUrl *string // A structure with Model Input details. @@ -9665,7 +8355,7 @@ type ModelPackageContainerDefinition struct { // The name of a pre-trained machine learning benchmarked by Amazon SageMaker // Inference Recommender model that matches your model. You can find a list of - // benchmarked models by calling ListModelMetadata. + // benchmarked models by calling ListModelMetadata . NearestModelName *string // The Amazon Web Services Marketplace product ID of the model package. @@ -9694,29 +8384,17 @@ type ModelPackageGroup struct { ModelPackageGroupName *string // The status of the model group. This can be one of the following values. - // - // * - // PENDING - The model group is pending being created. - // - // * IN_PROGRESS - The model - // group is in the process of being created. - // - // * COMPLETED - The model group was - // successfully created. - // - // * FAILED - The model group failed. - // - // * DELETING - The - // model group is in the process of being deleted. - // - // * DELETE_FAILED - SageMaker - // failed to delete the model group. + // - PENDING - The model group is pending being created. + // - IN_PROGRESS - The model group is in the process of being created. + // - COMPLETED - The model group was successfully created. + // - FAILED - The model group failed. + // - DELETING - The model group is in the process of being deleted. + // - DELETE_FAILED - SageMaker failed to delete the model group. ModelPackageGroupStatus ModelPackageGroupStatus // A list of the tags associated with the model group. For more information, see - // Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []Tag noSmithyDocumentSerde @@ -9778,7 +8456,7 @@ type ModelPackageStatusItem struct { // This member is required. Status DetailedModelPackageStatus - // if the overall status is Failed, the reason for the failure. + // if the overall status is Failed , the reason for the failure. FailureReason *string noSmithyDocumentSerde @@ -9808,14 +8486,9 @@ type ModelPackageSummary struct { ModelPackageStatus ModelPackageStatus // The approval status of the model. This can be one of the following values. - // - // * - // APPROVED - The model is approved - // - // * REJECTED - The model is rejected. - // - // * - // PENDING_MANUAL_APPROVAL - The model is waiting for manual approval. + // - APPROVED - The model is approved + // - REJECTED - The model is rejected. + // - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval. ModelApprovalStatus ModelApprovalStatus // A brief description of the model package. @@ -9927,8 +8600,8 @@ type ModelQualityBaselineConfig struct { noSmithyDocumentSerde } -// The input for the model quality monitoring job. Currently endponts are supported -// for input for model quality monitoring jobs. +// The input for the model quality monitoring job. Currently endponts are +// supported for input for model quality monitoring jobs. type ModelQualityJobInput struct { // The ground truth label provided for the model. @@ -10011,22 +8684,15 @@ type ModelVariantConfigSummary struct { // The status of deployment for the model variant on the hosted inference // endpoint. - // - // * Creating - Amazon SageMaker is preparing the model variant on the - // hosted inference endpoint. - // - // * InService - The model variant is running on the - // hosted inference endpoint. - // - // * Updating - Amazon SageMaker is updating the model - // variant on the hosted inference endpoint. - // - // * Deleting - Amazon SageMaker is - // deleting the model variant on the hosted inference endpoint. - // - // * Deleted - The - // model variant has been deleted on the hosted inference endpoint. This can only - // happen after stopping the experiment. + // - Creating - Amazon SageMaker is preparing the model variant on the hosted + // inference endpoint. + // - InService - The model variant is running on the hosted inference endpoint. + // - Updating - Amazon SageMaker is updating the model variant on the hosted + // inference endpoint. + // - Deleting - Amazon SageMaker is deleting the model variant on the hosted + // inference endpoint. + // - Deleted - The model variant has been deleted on the hosted inference + // endpoint. This can only happen after stopping the experiment. // // This member is required. Status ModelVariantStatus @@ -10058,8 +8724,8 @@ type MonitoringAlertHistorySummary struct { AlertStatus MonitoringAlertStatus // A timestamp that indicates when the first alert transition occurred in an alert - // history. An alert transition can be from status InAlert to OK, or from OK to - // InAlert. + // history. An alert transition can be from status InAlert to OK , or from OK to + // InAlert . // // This member is required. CreationTime *time.Time @@ -10095,7 +8761,7 @@ type MonitoringAlertSummary struct { // This member is required. CreationTime *time.Time - // Within EvaluationPeriod, how many execution failures will raise an alert. + // Within EvaluationPeriod , how many execution failures will raise an alert. // // This member is required. DatapointsToAlert *int32 @@ -10154,12 +8820,12 @@ type MonitoringBaselineConfig struct { // The name of the job that performs baselining for the monitoring job. BaseliningJobName *string - // The baseline constraint file in Amazon S3 that the current monitoring job should - // validated against. + // The baseline constraint file in Amazon S3 that the current monitoring job + // should validated against. ConstraintsResource *MonitoringConstraintsResource - // The baseline statistics file in Amazon S3 that the current monitoring job should - // be validated against. + // The baseline statistics file in Amazon S3 that the current monitoring job + // should be validated against. StatisticsResource *MonitoringStatisticsResource noSmithyDocumentSerde @@ -10180,8 +8846,8 @@ type MonitoringClusterConfig struct { // This member is required. InstanceType ProcessingInstanceType - // The size of the ML storage volume, in gigabytes, that you want to provision. You - // must specify sufficient ML storage for your scenario. + // The size of the ML storage volume, in gigabytes, that you want to provision. + // You must specify sufficient ML storage for your scenario. // // This member is required. VolumeSizeInGB *int32 @@ -10314,9 +8980,9 @@ type MonitoringJobDefinition struct { // This member is required. MonitoringOutputConfig *MonitoringOutputConfig - // Identifies the resources, ML compute instances, and ML storage volumes to deploy - // for a monitoring job. In distributed processing, you specify more than one - // instance. + // Identifies the resources, ML compute instances, and ML storage volumes to + // deploy for a monitoring job. In distributed processing, you specify more than + // one instance. // // This member is required. MonitoringResources *MonitoringResources @@ -10394,8 +9060,8 @@ type MonitoringNetworkConfig struct { // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) - // and Protect Training Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // and Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -10415,8 +9081,8 @@ type MonitoringOutput struct { // The output configuration for monitoring jobs. type MonitoringOutputConfig struct { - // Monitoring outputs for monitoring jobs. This is where the output of the periodic - // monitoring jobs is uploaded. + // Monitoring outputs for monitoring jobs. This is where the output of the + // periodic monitoring jobs is uploaded. // // This member is required. MonitoringOutputs []MonitoringOutput @@ -10470,8 +9136,8 @@ type MonitoringS3Output struct { } // A schedule for a model monitoring job. For information about model monitor, see -// Amazon SageMaker Model Monitor -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html). +// Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) +// . type MonitoringSchedule struct { // The time that the monitoring schedule was created. @@ -10498,27 +9164,19 @@ type MonitoringSchedule struct { // The name of the monitoring schedule. MonitoringScheduleName *string - // The status of the monitoring schedule. This can be one of the following - // values. - // - // * PENDING - The schedule is pending being created. - // - // * FAILED - The - // schedule failed. - // - // * SCHEDULED - The schedule was successfully created. - // - // * - // STOPPED - The schedule was stopped. + // The status of the monitoring schedule. This can be one of the following values. + // - PENDING - The schedule is pending being created. + // - FAILED - The schedule failed. + // - SCHEDULED - The schedule was successfully created. + // - STOPPED - The schedule was stopped. MonitoringScheduleStatus ScheduleStatus // The type of the monitoring job definition to schedule. MonitoringType MonitoringType // A list of the tags associated with the monitoring schedlue. For more - // information, see Tagging Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference Guide. + // information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference Guide. Tags []Tag noSmithyDocumentSerde @@ -10613,7 +9271,7 @@ type MultiModelConfig struct { // each time it is invoked. Some use cases do not benefit from model caching. For // example, if an endpoint hosts a large number of models that are each invoked // infrequently, the endpoint might perform better if you disable model caching. To - // disable model caching, set the value of this parameter to Disabled. + // disable model caching, set the value of this parameter to Disabled . ModelCacheSetting ModelCacheSetting noSmithyDocumentSerde @@ -10622,18 +9280,18 @@ type MultiModelConfig struct { // The VpcConfig configuration object that specifies the VPC that you want the // compilation jobs to connect to. For more information on controlling access to // your Amazon S3 buckets used for compilation job, see Give Amazon SageMaker -// Compilation Jobs Access to Resources in Your Amazon VPC -// (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html). +// Compilation Jobs Access to Resources in Your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html) +// . type NeoVpcConfig struct { - // The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the + // The VPC security group IDs. IDs have the form of sg-xxxxxxxx . Specify the // security groups for the VPC that is specified in the Subnets field. // // This member is required. SecurityGroupIds []string - // The ID of the subnets in the VPC that you want to connect the compilation job to - // for accessing the model in Amazon S3. + // The ID of the subnets in the VPC that you want to connect the compilation job + // to for accessing the model in Amazon S3. // // This member is required. Subnets []string @@ -10642,28 +9300,25 @@ type NeoVpcConfig struct { } // A list of nested Filter objects. A resource must satisfy the conditions of all -// filters to be included in the results returned from the Search API. For example, -// to filter on a training job's InputDataConfig property with a specific channel -// name and S3Uri prefix, define the following filters: -// -// * -// '{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}', -// -// * -// '{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", -// "Value":"mybucket/catdata"}' +// filters to be included in the results returned from the Search API. For +// example, to filter on a training job's InputDataConfig property with a specific +// channel name and S3Uri prefix, define the following filters: +// - '{Name:"InputDataConfig.ChannelName", "Operator":"Equals", +// "Value":"train"}', +// - '{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", +// "Operator":"Contains", "Value":"mybucket/catdata"}' type NestedFilters struct { - // A list of filters. Each filter acts on a property. Filters must contain at least - // one Filters value. For example, a NestedFilters call might include a filter on - // the PropertyName parameter of the InputDataConfig property: - // InputDataConfig.DataSource.S3DataSource.S3Uri. + // A list of filters. Each filter acts on a property. Filters must contain at + // least one Filters value. For example, a NestedFilters call might include a + // filter on the PropertyName parameter of the InputDataConfig property: + // InputDataConfig.DataSource.S3DataSource.S3Uri . // // This member is required. Filters []Filter // The name of the property to use in the nested filters. The value must match a - // listed property name, such as InputDataConfig. + // listed property name, such as InputDataConfig . // // This member is required. NestedPropertyName *string @@ -10689,8 +9344,8 @@ type NetworkConfig struct { // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) - // and Protect Training Jobs by Using an Amazon Virtual Private Cloud - // (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // and Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) + // . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -10721,14 +9376,14 @@ type NotebookInstanceLifecycleConfigSummary struct { // Contains the notebook instance lifecycle configuration script. Each lifecycle // configuration script has a limit of 16384 characters. The value of the $PATH // environment variable that is available to both scripts is -// /sbin:bin:/usr/sbin:/usr/bin. View CloudWatch Logs for notebook instance +// /sbin:bin:/usr/sbin:/usr/bin . View CloudWatch Logs for notebook instance // lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log -// stream [notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration +// stream [notebook-instance-name]/[LifecycleConfigHook] . Lifecycle configuration // scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 // minutes, it fails and the notebook instance is not created or started. For // information about notebook instance lifestyle configurations, see Step 2.1: -// (Optional) Customize a Notebook Instance -// (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). +// (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) +// . type NotebookInstanceLifecycleHook struct { // A base64-encoded string that contains a shell script for a notebook instance @@ -10753,12 +9408,11 @@ type NotebookInstanceSummary struct { // An array of up to three Git repositories associated with the notebook instance. // These can be either the names of Git repositories stored as resources in your - // account, or the URL of Git repositories in Amazon Web Services CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // account, or the URL of Git repositories in Amazon Web Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. These repositories are cloned at the same level + // as the default repository of your notebook instance. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . AdditionalCodeRepositories []string // A timestamp that shows when the notebook instance was created. @@ -10767,12 +9421,11 @@ type NotebookInstanceSummary struct { // The Git repository associated with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource // in your account, or the URL of a Git repository in Amazon Web Services - // CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git Repositories with SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. When you open a notebook instance, it opens in + // the directory that contains this repository. For more information, see + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // . DefaultCodeRepository *string // The type of ML compute instance that the notebook instance is running on. @@ -10783,22 +9436,22 @@ type NotebookInstanceSummary struct { // The name of a notebook instance lifecycle configuration associated with this // notebook instance. For information about notebook instance lifestyle - // configurations, see Step 2.1: (Optional) Customize a Notebook Instance - // (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). + // configurations, see Step 2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) + // . NotebookInstanceLifecycleConfigName *string // The status of the notebook instance. NotebookInstanceStatus NotebookInstanceStatus - // The URL that you use to connect to the Jupyter notebook running in your notebook - // instance. + // The URL that you use to connect to the Jupyter notebook running in your + // notebook instance. Url *string noSmithyDocumentSerde } -// Configures Amazon SNS notifications of available or expiring work items for work -// teams. +// Configures Amazon SNS notifications of available or expiring work items for +// work teams. type NotificationConfiguration struct { // The ARN for the Amazon SNS topic to which notifications should be published. @@ -10818,8 +9471,8 @@ type ObjectiveStatusCounters struct { // training job failed or did not emit an objective metric. Failed int32 - // The number of training jobs that are in progress and pending evaluation of their - // final objective metric. + // The number of training jobs that are in progress and pending evaluation of + // their final objective metric. Pending int32 // The number of training jobs whose final objective metric was evaluated by the @@ -10829,13 +9482,13 @@ type ObjectiveStatusCounters struct { noSmithyDocumentSerde } -// The configuration of an OfflineStore. Provide an OfflineStoreConfig in a request -// to CreateFeatureGroup to create an OfflineStore. To encrypt an OfflineStore -// using at rest data encryption, specify Amazon Web Services Key Management -// Service (KMS) key ID, or KMSKeyId, in S3StorageConfig. +// The configuration of an OfflineStore . Provide an OfflineStoreConfig in a +// request to CreateFeatureGroup to create an OfflineStore . To encrypt an +// OfflineStore using at rest data encryption, specify Amazon Web Services Key +// Management Service (KMS) key ID, or KMSKeyId , in S3StorageConfig . type OfflineStoreConfig struct { - // The Amazon Simple Storage (Amazon S3) location of OfflineStore. + // The Amazon Simple Storage (Amazon S3) location of OfflineStore . // // This member is required. S3StorageConfig *S3StorageConfig @@ -10845,17 +9498,17 @@ type OfflineStoreConfig struct { DataCatalogConfig *DataCatalogConfig // Set to True to disable the automatic creation of an Amazon Web Services Glue - // table when configuring an OfflineStore. + // table when configuring an OfflineStore . DisableGlueTableCreation bool // Format for the offline store table. Supported formats are Glue (Default) and - // Apache Iceberg (https://iceberg.apache.org/). + // Apache Iceberg (https://iceberg.apache.org/) . TableFormat TableFormat noSmithyDocumentSerde } -// The status of OfflineStore. +// The status of OfflineStore . type OfflineStoreStatus struct { // An OfflineStore status. @@ -10946,7 +9599,7 @@ type OidcConfigForResponse struct { // A list of user groups that exist in your OIDC Identity Provider (IdP). One to // ten groups can be used to create a single private work team. When you add a user -// group to the list of Groups, you can add that user group to one or more private +// group to the list of Groups , you can add that user group to one or more private // work teams. If you add a user group to a private work team, all workers in that // user group are added to the work team. type OidcMemberDefinition struct { @@ -10960,62 +9613,45 @@ type OidcMemberDefinition struct { noSmithyDocumentSerde } -// Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, -// or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by -// specifying the EnableOnlineStore flag at General Assembly; the default value is -// False. +// Use this to specify the Amazon Web Services Key Management Service (KMS) Key +// ID, or KMSKeyId , for at rest data encryption. You can turn OnlineStore on or +// off by specifying the EnableOnlineStore flag at General Assembly; the default +// value is False . type OnlineStoreConfig struct { // Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn // OnlineStore on by specifying True for the EnableOnlineStore flag. The default - // value is False. + // value is False . EnableOnlineStore bool - // Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore. + // Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your + // OnlineStore . SecurityConfig *OnlineStoreSecurityConfig noSmithyDocumentSerde } -// The security configuration for OnlineStore. +// The security configuration for OnlineStore . type OnlineStoreSecurityConfig struct { // The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker // Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 // server-side encryption. The caller (either user or IAM role) of - // CreateFeatureGroup must have below permissions to the OnlineStoreKmsKeyId: - // - // * - // "kms:Encrypt" - // - // * "kms:Decrypt" - // - // * "kms:DescribeKey" - // - // * "kms:CreateGrant" - // - // * - // "kms:RetireGrant" - // - // * "kms:ReEncryptFrom" - // - // * "kms:ReEncryptTo" - // - // * - // "kms:GenerateDataKey" - // - // * "kms:ListAliases" - // - // * "kms:ListGrants" - // - // * - // "kms:RevokeGrant" - // - // The caller (either user or IAM role) to all DataPlane - // operations (PutRecord, GetRecord, DeleteRecord) must have the following - // permissions to the KmsKeyId: - // - // * "kms:Decrypt" + // CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId : + // - "kms:Encrypt" + // - "kms:Decrypt" + // - "kms:DescribeKey" + // - "kms:CreateGrant" + // - "kms:RetireGrant" + // - "kms:ReEncryptFrom" + // - "kms:ReEncryptTo" + // - "kms:GenerateDataKey" + // - "kms:ListAliases" + // - "kms:ListGrants" + // - "kms:RevokeGrant" + // The caller (either user or IAM role) to all DataPlane operations ( PutRecord , + // GetRecord , DeleteRecord ) must have the following permissions to the KmsKeyId : + // - "kms:Decrypt" KmsKeyId *string noSmithyDocumentSerde @@ -11031,7 +9667,7 @@ type OnlineStoreSecurityConfig struct { type OutputConfig struct { // Identifies the S3 bucket where you want Amazon SageMaker to store the model - // artifacts. For example, s3://bucket-name/key-name-prefix. + // artifacts. For example, s3://bucket-name/key-name-prefix . // // This member is required. S3OutputLocation *string @@ -11040,150 +9676,90 @@ type OutputConfig struct { // compiler options are TargetPlatform specific. It is required for NVIDIA // accelerators and highly recommended for CPU compilations. For any other cases, // it is optional to specify CompilerOptions. - // - // * DTYPE: Specifies the data type for - // the input. When compiling for ml_* (except for ml_inf) instances using PyTorch - // framework, provide the data type (dtype) of the model's input. "float32" is used - // if "DTYPE" is not specified. Options for data type are: - // - // * float32: Use either - // "float" or "float32". - // - // * int64: Use either "int64" or "long". - // - // For example, - // {"dtype" : "float32"}. - // - // * CPU: Compilation for CPU supports the following - // compiler options. - // - // * mcpu: CPU micro-architecture. For example, {'mcpu': - // 'skylake-avx512'} - // - // * mattr: CPU flags. For example, {'mattr': ['+neon', - // '+vfpv4']} - // - // * ARM: Details of ARM CPU compilations. - // - // * NEON: NEON is an - // implementation of the Advanced SIMD extension used in ARMv7 processors. For - // example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM - // 32-bit platform with the NEON support. - // - // * NVIDIA: Compilation for NVIDIA GPU - // supports the following compiler options. - // - // * gpu_code: Specifies the targeted - // architecture. - // - // * trt-ver: Specifies the TensorRT versions in x.y.z. format. - // - // * - // cuda-ver: Specifies the CUDA version in x.y format. - // - // For example, {'gpu-code': - // 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'} - // - // * ANDROID: Compilation for the - // Android OS supports the following compiler options: - // - // * ANDROID_PLATFORM: - // Specifies the Android API levels. Available levels range from 21 to 29. For - // example, {'ANDROID_PLATFORM': 28}. - // - // * mattr: Add {'mattr': ['+neon']} to - // compiler options if compiling for ARM 32-bit platform with NEON support. - // - // * - // INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a - // JSON string. For example, "CompilerOptions": "\"--verbose 1 --num-neuroncores 2 - // -O2\"". For information about supported compiler options, see Neuron Compiler - // CLI - // (https://github.com/aws/aws-neuron-sdk/blob/master/docs/neuron-cc/command-line-reference.md). - // - // * - // CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the - // following compiler options: - // - // * class_labels: Specifies the classification labels - // file name inside input tar.gz file. For example, {"class_labels": - // "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by - // newlines. - // - // * EIA: Compilation for the Elastic Inference Accelerator supports the - // following compiler options: - // - // * precision_mode: Specifies the precision of - // compiled artifacts. Supported values are "FP16" and "FP32". Default is - // "FP32". - // - // * signature_def_key: Specifies the signature to use for models in - // SavedModel format. Defaults is TensorFlow's default signature def key. - // - // * - // output_names: Specifies a list of output tensor names for models in FrozenGraph - // format. Set at most one API field, either: signature_def_key or - // output_names. - // - // For example: {"precision_mode": "FP32", "output_names": - // ["output:0"]} + // - DTYPE : Specifies the data type for the input. When compiling for ml_* + // (except for ml_inf ) instances using PyTorch framework, provide the data type + // (dtype) of the model's input. "float32" is used if "DTYPE" is not specified. + // Options for data type are: + // - float32: Use either "float" or "float32" . + // - int64: Use either "int64" or "long" . For example, {"dtype" : "float32"} . + // - CPU : Compilation for CPU supports the following compiler options. + // - mcpu : CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'} + // - mattr : CPU flags. For example, {'mattr': ['+neon', '+vfpv4']} + // - ARM : Details of ARM CPU compilations. + // - NEON : NEON is an implementation of the Advanced SIMD extension used in + // ARMv7 processors. For example, add {'mattr': ['+neon']} to the compiler + // options if compiling for ARM 32-bit platform with the NEON support. + // - NVIDIA : Compilation for NVIDIA GPU supports the following compiler options. + // - gpu_code : Specifies the targeted architecture. + // - trt-ver : Specifies the TensorRT versions in x.y.z. format. + // - cuda-ver : Specifies the CUDA version in x.y format. For example, + // {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'} + // - ANDROID : Compilation for the Android OS supports the following compiler + // options: + // - ANDROID_PLATFORM : Specifies the Android API levels. Available levels range + // from 21 to 29. For example, {'ANDROID_PLATFORM': 28} . + // - mattr : Add {'mattr': ['+neon']} to compiler options if compiling for ARM + // 32-bit platform with NEON support. + // - INFERENTIA : Compilation for target ml_inf1 uses compiler options passed in + // as a JSON string. For example, "CompilerOptions": "\"--verbose 1 + // --num-neuroncores 2 -O2\"" . For information about supported compiler options, + // see Neuron Compiler CLI (https://github.com/aws/aws-neuron-sdk/blob/master/docs/neuron-cc/command-line-reference.md) + // . + // - CoreML : Compilation for the CoreML OutputConfig$TargetDevice supports the + // following compiler options: + // - class_labels : Specifies the classification labels file name inside input + // tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"} . + // Labels inside the txt file should be separated by newlines. + // - EIA : Compilation for the Elastic Inference Accelerator supports the + // following compiler options: + // - precision_mode : Specifies the precision of compiled artifacts. Supported + // values are "FP16" and "FP32" . Default is "FP32" . + // - signature_def_key : Specifies the signature to use for models in SavedModel + // format. Defaults is TensorFlow's default signature def key. + // - output_names : Specifies a list of output tensor names for models in + // FrozenGraph format. Set at most one API field, either: signature_def_key or + // output_names . For example: {"precision_mode": "FP32", "output_names": + // ["output:0"]} CompilerOptions *string // The Amazon Web Services Key Management Service key (Amazon Web Services KMS) // that Amazon SageMaker uses to encrypt your output models with Amazon S3 // server-side encryption after compilation job. If you don't provide a KMS key ID, // Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. - // For more information, see KMS-Managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) + // For more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) // in the Amazon Simple Storage Service Developer Guide. The KmsKeyId can be any of // the following formats: - // - // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key - // ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias KmsKeyId *string // Identifies the target device or the machine learning instance that you want to // run your model on after the compilation has completed. Alternatively, you can - // specify OS, architecture, and accelerator using TargetPlatform fields. It can be - // used instead of TargetPlatform. + // specify OS, architecture, and accelerator using TargetPlatform fields. It can + // be used instead of TargetPlatform . TargetDevice TargetDevice - // Contains information about a target platform that you want your model to run on, - // such as OS, architecture, and accelerators. It is an alternative of - // TargetDevice. The following examples show how to configure the TargetPlatform + // Contains information about a target platform that you want your model to run + // on, such as OS, architecture, and accelerators. It is an alternative of + // TargetDevice . The following examples show how to configure the TargetPlatform // and CompilerOptions JSON strings for popular target platforms: - // - // * Raspberry Pi 3 - // Model B+ "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"}, - // "CompilerOptions": {'mattr': ['+neon']} - // - // * Jetson TX2 "TargetPlatform": {"Os": - // "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"}, "CompilerOptions": - // {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'} - // - // * EC2 m5.2xlarge - // instance OS "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": - // "NVIDIA"}, "CompilerOptions": {'mcpu': 'skylake-avx512'} - // - // * RK3399 - // "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"} - // - // * - // ARMv7 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"}, - // "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']} - // - // * ARMv8 phone - // (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, "CompilerOptions": - // {'ANDROID_PLATFORM': 29} + // - Raspberry Pi 3 Model B+ "TargetPlatform": {"Os": "LINUX", "Arch": + // "ARM_EABIHF"}, "CompilerOptions": {'mattr': ['+neon']} + // - Jetson TX2 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", + // "Accelerator": "NVIDIA"}, "CompilerOptions": {'gpu-code': 'sm_62', 'trt-ver': + // '6.0.1', 'cuda-ver': '10.0'} + // - EC2 m5.2xlarge instance OS "TargetPlatform": {"Os": "LINUX", "Arch": + // "X86_64", "Accelerator": "NVIDIA"}, "CompilerOptions": {'mcpu': + // 'skylake-avx512'} + // - RK3399 "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": + // "MALI"} + // - ARMv7 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"}, + // "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']} + // - ARMv8 phone (CPU) "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"}, + // "CompilerOptions": {'ANDROID_PLATFORM': 29} TargetPlatform *TargetPlatform noSmithyDocumentSerde @@ -11194,7 +9770,7 @@ type OutputConfig struct { type OutputDataConfig struct { // Identifies the S3 path where you want SageMaker to store the model artifacts. - // For example, s3://bucket-name/key-name-prefix. + // For example, s3://bucket-name/key-name-prefix . // // This member is required. S3OutputPath *string @@ -11202,36 +9778,25 @@ type OutputDataConfig struct { // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key // that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 // server-side encryption. The KmsKeyId can be any of the following formats: - // - // * // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // Amazon Resource Name - // (ARN) of a KMS Key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // // KMS Key Alias "alias/ExampleAlias" - // - // * // Amazon Resource Name (ARN) of a KMS - // Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" - // - // If you use a - // KMS key ID or an alias of your KMS key, the SageMaker execution role must - // include permissions to call kms:Encrypt. If you don't provide a KMS key ID, - // SageMaker uses the default KMS key for Amazon S3 for your role's account. - // SageMaker uses server-side encryption with KMS-managed keys for - // OutputDataConfig. If you use a bucket policy with an s3:PutObject permission + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - // KMS Key Alias "alias/ExampleAlias" + // - // Amazon Resource Name (ARN) of a KMS Key Alias + // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + // If you use a KMS key ID or an alias of your KMS key, the SageMaker execution + // role must include permissions to call kms:Encrypt . If you don't provide a KMS + // key ID, SageMaker uses the default KMS key for Amazon S3 for your role's + // account. SageMaker uses server-side encryption with KMS-managed keys for + // OutputDataConfig . If you use a bucket policy with an s3:PutObject permission // that only allows objects with server-side encryption, set the condition key of - // s3:x-amz-server-side-encryption to "aws:kms". For more information, see - // KMS-Managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) + // s3:x-amz-server-side-encryption to "aws:kms" . For more information, see + // KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) // in the Amazon Simple Storage Service Developer Guide. The KMS key policy must - // grant permission to the IAM role that you specify in your CreateTrainingJob, - // CreateTransformJob, or CreateHyperParameterTuningJob requests. For more - // information, see Using Key Policies in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Amazon Web Services Key Management Service Developer Guide. + // grant permission to the IAM role that you specify in your CreateTrainingJob , + // CreateTransformJob , or CreateHyperParameterTuningJob requests. For more + // information, see Using Key Policies in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string noSmithyDocumentSerde @@ -11269,8 +9834,8 @@ type ParallelismConfiguration struct { // Assigns a value to a named Pipeline parameter. type Parameter struct { - // The name of the parameter to assign a value to. This parameter name must match a - // named parameter in the pipeline definition. + // The name of the parameter to assign a value to. This parameter name must match + // a named parameter in the pipeline definition. // // This member is required. Name *string @@ -11287,16 +9852,16 @@ type Parameter struct { // hyperparameters to be used by an algorithm. type ParameterRange struct { - // A CategoricalParameterRangeSpecification object that defines the possible values - // for a categorical hyperparameter. + // A CategoricalParameterRangeSpecification object that defines the possible + // values for a categorical hyperparameter. CategoricalParameterRangeSpecification *CategoricalParameterRangeSpecification // A ContinuousParameterRangeSpecification object that defines the possible values // for a continuous hyperparameter. ContinuousParameterRangeSpecification *ContinuousParameterRangeSpecification - // A IntegerParameterRangeSpecification object that defines the possible values for - // an integer hyperparameter. + // A IntegerParameterRangeSpecification object that defines the possible values + // for an integer hyperparameter. IntegerParameterRangeSpecification *IntegerParameterRangeSpecification noSmithyDocumentSerde @@ -11307,10 +9872,10 @@ type ParameterRange struct { // training jobs with hyperparameter values within these ranges to find the // combination of values that result in the training job with the best performance // as measured by the objective metric of the hyperparameter tuning job. The -// maximum number of items specified for Array Members refers to the maximum number -// of hyperparameters for each range and also the maximum for the hyperparameter -// tuning job itself. That is, the sum of the number of hyperparameters for all the -// ranges can't exceed the maximum number specified. +// maximum number of items specified for Array Members refers to the maximum +// number of hyperparameters for each range and also the maximum for the +// hyperparameter tuning job itself. That is, the sum of the number of +// hyperparameters for all the ranges can't exceed the maximum number specified. type ParameterRanges struct { // The array of CategoricalParameterRange objects that specify ranges of @@ -11328,9 +9893,9 @@ type ParameterRanges struct { noSmithyDocumentSerde } -// The trial that a trial component is associated with and the experiment the trial -// is part of. A component might not be associated with a trial. A component can be -// associated with multiple trials. +// The trial that a trial component is associated with and the experiment the +// trial is part of. A component might not be associated with a trial. A component +// can be associated with multiple trials. type Parent struct { // The name of the experiment. @@ -11390,8 +9955,8 @@ type PendingProductionVariantSummary struct { // The size of the Elastic Inference (EI) instance to use for the production // variant. EI instances provide on-demand GPU computing for inference. For more - // information, see Using Elastic Inference in Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + // information, see Using Elastic Inference in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) + // . AcceleratorType ProductionVariantAcceleratorType // The number of instances associated with the variant. @@ -11403,8 +9968,9 @@ type PendingProductionVariantSummary struct { // The weight associated with the variant. CurrentWeight *float32 - // An array of DeployedImage objects that specify the Amazon EC2 Container Registry - // paths of the inference images deployed on instances of this ProductionVariant. + // An array of DeployedImage objects that specify the Amazon EC2 Container + // Registry paths of the inference images deployed on instances of this + // ProductionVariant . DeployedImages []DeployedImage // The number of instances requested in this deployment, as specified in the @@ -11564,8 +10130,8 @@ type PipelineExecution struct { type PipelineExecutionStep struct { // The current attempt of the execution step. For more information, see Retry - // Policy for SageMaker Pipelines steps - // (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html). + // Policy for SageMaker Pipelines steps (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html) + // . AttemptCount int32 // If this pipeline execution step was cached, details on the cache hit. @@ -11611,29 +10177,17 @@ type PipelineExecutionStepMetadata struct { // Container for the metadata for a Clarify check step. The configurations and // outcomes of the check step execution. This includes: - // - // * The type of the check - // conducted, - // - // * The Amazon S3 URIs of baseline constraints and statistics files to - // be used for the drift check. - // - // * The Amazon S3 URIs of newly calculated baseline - // constraints and statistics. - // - // * The model package group name provided. - // - // * The - // Amazon S3 URI of the violation report if violations detected. - // - // * The Amazon - // Resource Name (ARN) of check processing job initiated by the step execution. - // - // * - // The boolean flags indicating if the drift check is skipped. - // - // * If step property - // BaselineUsedForDriftCheck is set the same as CalculatedBaseline. + // - The type of the check conducted, + // - The Amazon S3 URIs of baseline constraints and statistics files to be used + // for the drift check. + // - The Amazon S3 URIs of newly calculated baseline constraints and statistics. + // - The model package group name provided. + // - The Amazon S3 URI of the violation report if violations detected. + // - The Amazon Resource Name (ARN) of check processing job initiated by the + // step execution. + // - The boolean flags indicating if the drift check is skipped. + // - If step property BaselineUsedForDriftCheck is set the same as + // CalculatedBaseline . ClarifyCheck *ClarifyCheckStepMetadata // The outcome of the condition evaluation that was run by this step execution. @@ -11658,30 +10212,17 @@ type PipelineExecutionStepMetadata struct { ProcessingJob *ProcessingJobStepMetadata // The configurations and outcomes of the check step execution. This includes: - // - // * - // The type of the check conducted. - // - // * The Amazon S3 URIs of baseline constraints - // and statistics files to be used for the drift check. - // - // * The Amazon S3 URIs of - // newly calculated baseline constraints and statistics. - // - // * The model package group - // name provided. - // - // * The Amazon S3 URI of the violation report if violations - // detected. - // - // * The Amazon Resource Name (ARN) of check processing job initiated by - // the step execution. - // - // * The Boolean flags indicating if the drift check is - // skipped. - // - // * If step property BaselineUsedForDriftCheck is set the same as - // CalculatedBaseline. + // - The type of the check conducted. + // - The Amazon S3 URIs of baseline constraints and statistics files to be used + // for the drift check. + // - The Amazon S3 URIs of newly calculated baseline constraints and statistics. + // - The model package group name provided. + // - The Amazon S3 URI of the violation report if violations detected. + // - The Amazon Resource Name (ARN) of check processing job initiated by the + // step execution. + // - The Boolean flags indicating if the drift check is skipped. + // - If step property BaselineUsedForDriftCheck is set the same as + // CalculatedBaseline . QualityCheck *QualityCheckStepMetadata // The Amazon Resource Name (ARN) of the model package that the model was @@ -11715,8 +10256,8 @@ type PipelineExecutionSummary struct { // The display name of the pipeline execution. PipelineExecutionDisplayName *string - // A message generated by SageMaker Pipelines describing why the pipeline execution - // failed. + // A message generated by SageMaker Pipelines describing why the pipeline + // execution failed. PipelineExecutionFailureReason *string // The status of the pipeline execution. @@ -11773,8 +10314,9 @@ type PipelineSummary struct { // Configuration for the cluster used to run a processing job. type ProcessingClusterConfig struct { - // The number of ML compute instances to use in the processing job. For distributed - // processing jobs, specify a value greater than 1. The default value is 1. + // The number of ML compute instances to use in the processing job. For + // distributed processing jobs, specify a value greater than 1. The default value + // is 1. // // This member is required. InstanceCount *int32 @@ -11791,8 +10333,8 @@ type ProcessingClusterConfig struct { // mounts the local instance storage instead of Amazon EBS gp2 storage. You can't // request a VolumeSizeInGB greater than the total size of the local instance // storage. For a list of instance types that support local instance storage, - // including the total size per instance type, see Instance Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). + // including the total size per instance type, see Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) + // . // // This member is required. VolumeSizeInGB *int32 @@ -11803,11 +10345,10 @@ type ProcessingClusterConfig struct { // instances include local storage, dependent on the instance type. Local storage // volumes are encrypted using a hardware module on the instance. You can't request // a VolumeKmsKeyId when using an instance type with local storage. For a list of - // instance types that support local instance storage, see Instance Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). - // For more information about local instance storage encryption, see SSD Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). + // instance types that support local instance storage, see Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) + // . For more information about local instance storage encryption, see SSD + // Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) + // . VolumeKmsKeyId *string noSmithyDocumentSerde @@ -11835,7 +10376,7 @@ type ProcessingInput struct { // This member is required. InputName *string - // When True, input operations such as data download are managed natively by the + // When True , input operations such as data download are managed natively by the // processing job application. When False (default), input operations are managed // by Amazon SageMaker. AppManaged bool @@ -11851,15 +10392,15 @@ type ProcessingInput struct { } // An Amazon SageMaker processing job that is used to analyze data and evaluate -// models. For more information, see Process Data and Evaluate Models -// (https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html). +// models. For more information, see Process Data and Evaluate Models (https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html) +// . type ProcessingJob struct { // Configuration to run a processing job in a specified container image. AppSpecification *AppSpecification - // The Amazon Resource Name (ARN) of the AutoML job associated with this processing - // job. + // The Amazon Resource Name (ARN) of the AutoML job associated with this + // processing job. AutoMLJobArn *string // The time the processing job was created. @@ -11874,13 +10415,9 @@ type ProcessingJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *ExperimentConfig // A string, up to one KB in size, that contains the reason a processing job @@ -11890,8 +10427,8 @@ type ProcessingJob struct { // The time the processing job was last modified. LastModifiedTime *time.Time - // The ARN of a monitoring schedule for an endpoint associated with this processing - // job. + // The ARN of a monitoring schedule for an endpoint associated with this + // processing job. MonitoringScheduleArn *string // Networking options for a job, such as network traffic encryption between @@ -11917,8 +10454,8 @@ type ProcessingJob struct { // Configuration for uploading output from the processing container. ProcessingOutputConfig *ProcessingOutputConfig - // Identifies the resources, ML compute instances, and ML storage volumes to deploy - // for a processing job. In distributed training, you specify more than one + // Identifies the resources, ML compute instances, and ML storage volumes to + // deploy for a processing job. In distributed training, you specify more than one // instance. ProcessingResources *ProcessingResources @@ -11934,8 +10471,7 @@ type ProcessingJob struct { StoppingCondition *ProcessingStoppingCondition // An array of key-value pairs. For more information, see Using Cost Allocation - // Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) + // Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) // in the Amazon Web Services Billing and Cost Management User Guide. Tags []Tag @@ -12003,13 +10539,13 @@ type ProcessingOutput struct { // This member is required. OutputName *string - // When True, output operations such as data upload are managed natively by the + // When True , output operations such as data upload are managed natively by the // processing job application. When False (default), output operations are managed // by Amazon SageMaker. AppManaged bool - // Configuration for processing job outputs in Amazon SageMaker Feature Store. This - // processing output type is only supported when AppManaged is specified. + // Configuration for processing job outputs in Amazon SageMaker Feature Store. + // This processing output type is only supported when AppManaged is specified. FeatureStoreOutput *ProcessingFeatureStoreOutput // Configuration for processing job outputs in Amazon S3. @@ -12028,16 +10564,16 @@ type ProcessingOutputConfig struct { Outputs []ProcessingOutput // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key - // that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be - // an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. - // The KmsKeyId is applied to all outputs. + // that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can + // be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS + // key. The KmsKeyId is applied to all outputs. KmsKeyId *string noSmithyDocumentSerde } -// Identifies the resources, ML compute instances, and ML storage volumes to deploy -// for a processing job. In distributed training, you specify more than one +// Identifies the resources, ML compute instances, and ML storage volumes to +// deploy for a processing job. In distributed training, you specify more than one // instance. type ProcessingResources struct { @@ -12054,9 +10590,9 @@ type ProcessingResources struct { type ProcessingS3Input struct { // Whether you use an S3Prefix or a ManifestFile for the data type. If you choose - // S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects - // with the specified key name prefix for the processing job. If you choose - // ManifestFile, S3Uri identifies an object that is a manifest file containing a + // S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all + // objects with the specified key name prefix for the processing job. If you choose + // ManifestFile , S3Uri identifies an object that is a manifest file containing a // list of object keys that you want Amazon SageMaker to use for the processing // job. // @@ -12071,18 +10607,18 @@ type ProcessingS3Input struct { // The local path in your container where you want Amazon SageMaker to write input // data to. LocalPath is an absolute path to the input data and must begin with - // /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False + // /opt/ml/processing/ . LocalPath is a required parameter when AppManaged is False // (default). LocalPath *string // Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the // processing container. Gzip can only be used when Pipe mode is specified as the - // S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source + // S3InputMode . In Pipe mode, Amazon SageMaker streams input data from the source // directly to your container without using the EBS volume. S3CompressionType ProcessingS3CompressionType // Whether to distribute the data from Amazon S3 to all processing instances with - // FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, + // FullyReplicated , or whether the data from Amazon S3 is shared by Amazon S3 key, // downloading one shard of data to each processing instance. S3DataDistributionType ProcessingS3DataDistributionType @@ -12139,12 +10675,12 @@ type ProcessingStoppingCondition struct { // Identifies a model that you want to host and the resources chosen to deploy for // hosting it. If you are deploying multiple models, tell SageMaker how to // distribute traffic among the models by specifying variant weights. For more -// information on production variants, check Production variants -// (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html). +// information on production variants, check Production variants (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html) +// . type ProductionVariant struct { - // The name of the model that you want to host. This is the name that you specified - // when creating the model. + // The name of the model that you want to host. This is the name that you + // specified when creating the model. // // This member is required. ModelName *string @@ -12156,34 +10692,34 @@ type ProductionVariant struct { // The size of the Elastic Inference (EI) instance to use for the production // variant. EI instances provide on-demand GPU computing for inference. For more - // information, see Using Elastic Inference in Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). + // information, see Using Elastic Inference in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) + // . AcceleratorType ProductionVariantAcceleratorType - // The timeout value, in seconds, for your inference container to pass health check - // by SageMaker Hosting. For more information about health check, see How Your - // Container Should Respond to Health Check (Ping) Requests - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests). + // The timeout value, in seconds, for your inference container to pass health + // check by SageMaker Hosting. For more information about health check, see How + // Your Container Should Respond to Health Check (Ping) Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests) + // . ContainerStartupHealthCheckTimeoutInSeconds *int32 // Specifies configuration for a core dump from the model container when the // process crashes. CoreDumpConfig *ProductionVariantCoreDumpConfig - // You can use this parameter to turn on native Amazon Web Services Systems Manager - // (SSM) access for a production variant behind an endpoint. By default, SSM access - // is disabled for all production variants behind an endpoint. You can turn on or - // turn off SSM access for a production variant behind an existing endpoint by - // creating a new endpoint configuration and calling UpdateEndpoint. + // You can use this parameter to turn on native Amazon Web Services Systems + // Manager (SSM) access for a production variant behind an endpoint. By default, + // SSM access is disabled for all production variants behind an endpoint. You can + // turn on or turn off SSM access for a production variant behind an existing + // endpoint by creating a new endpoint configuration and calling UpdateEndpoint . EnableSSMAccess *bool // Number of instances to launch initially. InitialInstanceCount *int32 - // Determines initial traffic distribution among all of the models that you specify - // in the endpoint configuration. The traffic to a production variant is determined - // by the ratio of the VariantWeight to the sum of all VariantWeight values across - // all ProductionVariants. If unspecified, it defaults to 1.0. + // Determines initial traffic distribution among all of the models that you + // specify in the endpoint configuration. The traffic to a production variant is + // determined by the ratio of the VariantWeight to the sum of all VariantWeight + // values across all ProductionVariants. If unspecified, it defaults to 1.0. InitialVariantWeight *float32 // The ML compute instance type. @@ -12216,38 +10752,27 @@ type ProductionVariantCoreDumpConfig struct { DestinationS3Uri *string // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key - // that SageMaker uses to encrypt the core dump data at rest using Amazon S3 - // server-side encryption. The KmsKeyId can be any of the following formats: - // - // * // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // Amazon Resource Name - // (ARN) of a KMS Key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * - // // KMS Key Alias "alias/ExampleAlias" - // - // * // Amazon Resource Name (ARN) of a KMS - // Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" - // - // If you use a - // KMS key ID or an alias of your KMS key, the SageMaker execution role must - // include permissions to call kms:Encrypt. If you don't provide a KMS key ID, - // SageMaker uses the default KMS key for Amazon S3 for your role's account. - // SageMaker uses server-side encryption with KMS-managed keys for - // OutputDataConfig. If you use a bucket policy with an s3:PutObject permission + // that SageMaker uses to encrypt the core dump data at rest using Amazon S3 + // server-side encryption. The KmsKeyId can be any of the following formats: + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // - // KMS Key Alias "alias/ExampleAlias" + // - // Amazon Resource Name (ARN) of a KMS Key Alias + // "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" + // If you use a KMS key ID or an alias of your KMS key, the SageMaker execution + // role must include permissions to call kms:Encrypt . If you don't provide a KMS + // key ID, SageMaker uses the default KMS key for Amazon S3 for your role's + // account. SageMaker uses server-side encryption with KMS-managed keys for + // OutputDataConfig . If you use a bucket policy with an s3:PutObject permission // that only allows objects with server-side encryption, set the condition key of - // s3:x-amz-server-side-encryption to "aws:kms". For more information, see - // KMS-Managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the - // Amazon Simple Storage Service Developer Guide. The KMS key policy must grant - // permission to the IAM role that you specify in your CreateEndpoint and + // s3:x-amz-server-side-encryption to "aws:kms" . For more information, see + // KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // in the Amazon Simple Storage Service Developer Guide. The KMS key policy must + // grant permission to the IAM role that you specify in your CreateEndpoint and // UpdateEndpoint requests. For more information, see Using Key Policies in Amazon - // Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Amazon Web Services Key Management Service Developer Guide. + // Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string noSmithyDocumentSerde @@ -12276,21 +10801,12 @@ type ProductionVariantStatus struct { // The endpoint variant status which describes the current deployment stage status // or operational status. - // - // * Creating: Creating inference resources for the - // production variant. - // - // * Deleting: Terminating inference resources for the - // production variant. - // - // * Updating: Updating capacity for the production - // variant. - // - // * ActivatingTraffic: Turning on traffic for the production variant. - // - // * - // Baking: Waiting period to monitor the CloudWatch alarms in the automatic - // rollback configuration. + // - Creating : Creating inference resources for the production variant. + // - Deleting : Terminating inference resources for the production variant. + // - Updating : Updating capacity for the production variant. + // - ActivatingTraffic : Turning on traffic for the production variant. + // - Baking : Waiting period to monitor the CloudWatch alarms in the automatic + // rollback configuration. // // This member is required. Status VariantStatus @@ -12306,7 +10822,7 @@ type ProductionVariantStatus struct { // Describes weight and capacities for a production variant associated with an // endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API -// and the endpoint status is Updating, you get different desired and current +// and the endpoint status is Updating , you get different desired and current // values. type ProductionVariantSummary struct { @@ -12324,8 +10840,9 @@ type ProductionVariantSummary struct { // The weight associated with the variant. CurrentWeight *float32 - // An array of DeployedImage objects that specify the Amazon EC2 Container Registry - // paths of the inference images deployed on instances of this ProductionVariant. + // An array of DeployedImage objects that specify the Amazon EC2 Container + // Registry paths of the inference images deployed on instances of this + // ProductionVariant . DeployedImages []DeployedImage // The number of instances requested in the UpdateEndpointWeightsAndCapacities @@ -12351,7 +10868,7 @@ type ProductionVariantSummary struct { type ProfilerConfig struct { // Configuration to turn off Amazon SageMaker Debugger's system monitoring and - // profiling functionality. To turn it off, set to True. + // profiling functionality. To turn it off, set to True . DisableProfiler bool // A time interval for capturing system metrics in milliseconds. Available values @@ -12359,14 +10876,14 @@ type ProfilerConfig struct { // milliseconds. The default value is 500 milliseconds. ProfilingIntervalInMilliseconds *int64 - // Configuration information for capturing framework metrics. Available key strings - // for different profiling options are DetailedProfilingConfig, - // PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are + // Configuration information for capturing framework metrics. Available key + // strings for different profiling options are DetailedProfilingConfig , + // PythonProfilingConfig , and DataLoaderProfilingConfig . The following codes are // configuration structures for the ProfilingParameters parameter. To learn more // about how to configure the ProfilingParameters parameter, see Use the SageMaker // and Debugger Configuration API Operations to Create, Update, and Debug Your - // Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . ProfilingParameters map[string]string // Path to Amazon S3 storage location for system and framework metrics. @@ -12380,7 +10897,7 @@ type ProfilerConfig struct { type ProfilerConfigForUpdate struct { // To turn off Amazon SageMaker Debugger monitoring and profiling while a training - // job is in progress, set to True. + // job is in progress, set to True . DisableProfiler bool // A time interval for capturing system metrics in milliseconds. Available values @@ -12388,14 +10905,14 @@ type ProfilerConfigForUpdate struct { // milliseconds. The default value is 500 milliseconds. ProfilingIntervalInMilliseconds *int64 - // Configuration information for capturing framework metrics. Available key strings - // for different profiling options are DetailedProfilingConfig, - // PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are + // Configuration information for capturing framework metrics. Available key + // strings for different profiling options are DetailedProfilingConfig , + // PythonProfilingConfig , and DataLoaderProfilingConfig . The following codes are // configuration structures for the ProfilingParameters parameter. To learn more // about how to configure the ProfilingParameters parameter, see Use the SageMaker // and Debugger Configuration API Operations to Create, Update, and Debug Your - // Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . ProfilingParameters map[string]string // Path to Amazon S3 storage location for system and framework metrics. @@ -12422,7 +10939,7 @@ type ProfilerRuleConfiguration struct { InstanceType ProcessingInstanceType // Path to local storage location for output of rules. Defaults to - // /opt/ml/processing/output/rule/. + // /opt/ml/processing/output/rule/ . LocalPath *string // Runtime configuration for rule container. @@ -12490,19 +11007,20 @@ type Project struct { ProjectStatus ProjectStatus // Details of a provisioned service catalog product. For information about service - // catalog, see What is Amazon Web Services Service Catalog - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // catalog, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) + // . ServiceCatalogProvisionedProductDetails *ServiceCatalogProvisionedProductDetails - // Details that you specify to provision a service catalog product. For information - // about service catalog, see What is Amazon Web Services Service Catalog - // (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). + // Details that you specify to provision a service catalog product. For + // information about service catalog, see What is Amazon Web Services Service + // Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) + // . ServiceCatalogProvisioningDetails *ServiceCatalogProvisioningDetails // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []Tag noSmithyDocumentSerde @@ -12542,8 +11060,8 @@ type ProjectSummary struct { noSmithyDocumentSerde } -// Part of the SuggestionQuery type. Specifies a hint for retrieving property names -// that begin with the specified text. +// Part of the SuggestionQuery type. Specifies a hint for retrieving property +// names that begin with the specified text. type PropertyNameQuery struct { // Text that begins a property's name. @@ -12554,20 +11072,20 @@ type PropertyNameQuery struct { noSmithyDocumentSerde } -// A property name returned from a GetSearchSuggestions call that specifies a value -// in the PropertyNameQuery field. +// A property name returned from a GetSearchSuggestions call that specifies a +// value in the PropertyNameQuery field. type PropertyNameSuggestion struct { - // A suggested property name based on what you entered in the search textbox in the - // SageMaker console. + // A suggested property name based on what you entered in the search textbox in + // the SageMaker console. PropertyName *string noSmithyDocumentSerde } -// A key value pair used when you provision a project as a service catalog product. -// For information, see What is Amazon Web Services Service Catalog -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). +// A key value pair used when you provision a project as a service catalog +// product. For information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) +// . type ProvisioningParameter struct { // The key that identifies a provisioning parameter. @@ -12583,219 +11101,113 @@ type ProvisioningParameter struct { // task performed. Use one of the following prices for bounding box tasks. Prices // are in US dollars and should be based on the complexity of the task; the longer // it takes in your initial testing, the more you should offer. +// - 0.036 +// - 0.048 +// - 0.060 +// - 0.072 +// - 0.120 +// - 0.240 +// - 0.360 +// - 0.480 +// - 0.600 +// - 0.720 +// - 0.840 +// - 0.960 +// - 1.080 +// - 1.200 // -// * 0.036 -// -// * -// 0.048 -// -// * 0.060 -// -// * 0.072 -// -// * 0.120 -// -// * 0.240 -// -// * 0.360 -// -// * 0.480 -// -// * 0.600 -// -// * 0.720 -// -// * -// 0.840 -// -// * 0.960 -// -// * 1.080 -// -// * 1.200 -// -// Use one of the following prices for image -// classification, text classification, and custom tasks. Prices are in US -// dollars. -// -// * 0.012 -// -// * 0.024 -// -// * 0.036 -// -// * 0.048 -// -// * 0.060 -// -// * 0.072 -// -// * 0.120 -// -// * -// 0.240 -// -// * 0.360 -// -// * 0.480 -// -// * 0.600 -// -// * 0.720 -// -// * 0.840 -// -// * 0.960 -// -// * 1.080 -// -// * -// 1.200 -// -// Use one of the following prices for semantic segmentation tasks. Prices -// are in US dollars. -// -// * 0.840 -// -// * 0.960 -// -// * 1.080 -// -// * 1.200 -// -// Use one of the following -// prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI -// review tasks. Prices are in US dollars. -// -// * 2.400 -// -// * 2.280 -// -// * 2.160 -// -// * 2.040 -// -// * -// 1.920 -// -// * 1.800 -// -// * 1.680 -// -// * 1.560 -// -// * 1.440 -// -// * 1.320 -// -// * 1.200 -// -// * 1.080 -// -// * 0.960 -// -// * -// 0.840 -// -// * 0.720 -// -// * 0.600 -// -// * 0.480 +// Use one of the following prices for image classification, text classification, +// and custom tasks. Prices are in US dollars. +// - 0.012 +// - 0.024 +// - 0.036 +// - 0.048 +// - 0.060 +// - 0.072 +// - 0.120 +// - 0.240 +// - 0.360 +// - 0.480 +// - 0.600 +// - 0.720 +// - 0.840 +// - 0.960 +// - 1.080 +// - 1.200 // -// * 0.360 +// Use one of the following prices for semantic segmentation tasks. Prices are in +// US dollars. +// - 0.840 +// - 0.960 +// - 1.080 +// - 1.200 // -// * 0.240 +// Use one of the following prices for Textract AnalyzeDocument Important Form Key +// Amazon Augmented AI review tasks. Prices are in US dollars. +// - 2.400 +// - 2.280 +// - 2.160 +// - 2.040 +// - 1.920 +// - 1.800 +// - 1.680 +// - 1.560 +// - 1.440 +// - 1.320 +// - 1.200 +// - 1.080 +// - 0.960 +// - 0.840 +// - 0.720 +// - 0.600 +// - 0.480 +// - 0.360 +// - 0.240 +// - 0.120 +// - 0.072 +// - 0.060 +// - 0.048 +// - 0.036 +// - 0.024 +// - 0.012 // -// * 0.120 +// Use one of the following prices for Rekognition DetectModerationLabels Amazon +// Augmented AI review tasks. Prices are in US dollars. +// - 1.200 +// - 1.080 +// - 0.960 +// - 0.840 +// - 0.720 +// - 0.600 +// - 0.480 +// - 0.360 +// - 0.240 +// - 0.120 +// - 0.072 +// - 0.060 +// - 0.048 +// - 0.036 +// - 0.024 +// - 0.012 // -// * 0.072 -// -// * 0.060 -// -// * -// 0.048 -// -// * 0.036 -// -// * 0.024 -// -// * 0.012 -// -// Use one of the following prices for -// Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are -// in US dollars. -// -// * 1.200 -// -// * 1.080 -// -// * 0.960 -// -// * 0.840 -// -// * 0.720 -// -// * 0.600 -// -// * 0.480 -// -// * -// 0.360 -// -// * 0.240 -// -// * 0.120 -// -// * 0.072 -// -// * 0.060 -// -// * 0.048 -// -// * 0.036 -// -// * 0.024 -// -// * -// 0.012 -// -// Use one of the following prices for Amazon Augmented AI custom human -// review tasks. Prices are in US dollars. -// -// * 1.200 -// -// * 1.080 -// -// * 0.960 -// -// * 0.840 -// -// * -// 0.720 -// -// * 0.600 -// -// * 0.480 -// -// * 0.360 -// -// * 0.240 -// -// * 0.120 -// -// * 0.072 -// -// * 0.060 -// -// * 0.048 -// -// * -// 0.036 -// -// * 0.024 -// -// * 0.012 +// Use one of the following prices for Amazon Augmented AI custom human review +// tasks. Prices are in US dollars. +// - 1.200 +// - 1.080 +// - 0.960 +// - 0.840 +// - 0.720 +// - 0.600 +// - 0.480 +// - 0.360 +// - 0.240 +// - 0.120 +// - 0.072 +// - 0.060 +// - 0.048 +// - 0.036 +// - 0.024 +// - 0.012 type PublicWorkforceTaskPrice struct { // Defines the amount of money paid to an Amazon Mechanical Turk worker in United @@ -12806,8 +11218,7 @@ type PublicWorkforceTaskPrice struct { } // Container for the metadata for a Quality check step. For more information, see -// the topic on QualityCheck step -// (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-quality-check) +// the topic on QualityCheck step (https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-quality-check) // in the Amazon SageMaker Developer Guide. type QualityCheckStepMetadata struct { @@ -12835,14 +11246,14 @@ type QualityCheckStepMetadata struct { // This flag indicates if a newly calculated baseline can be accessed through step // properties BaselineUsedForDriftCheckConstraints and - // BaselineUsedForDriftCheckStatistics. If it is set to False, the previous + // BaselineUsedForDriftCheckStatistics . If it is set to False , the previous // baseline of the configured check type must also be available. These can be // accessed through the BaselineUsedForDriftCheckConstraints and // BaselineUsedForDriftCheckStatistics properties. RegisterNewBaseline bool // This flag indicates if the drift check against the previous baseline will be - // skipped or not. If it is set to False, the previous baseline of the configured + // skipped or not. If it is set to False , the previous baseline of the configured // check type must be available. SkipCheck bool @@ -12852,35 +11263,35 @@ type QualityCheckStepMetadata struct { noSmithyDocumentSerde } -// A set of filters to narrow the set of lineage entities connected to the -// StartArn(s) returned by the QueryLineage API action. +// A set of filters to narrow the set of lineage entities connected to the StartArn +// (s) returned by the QueryLineage API action. type QueryFilters struct { - // Filter the lineage entities connected to the StartArn(s) after the create date. + // Filter the lineage entities connected to the StartArn (s) after the create date. CreatedAfter *time.Time - // Filter the lineage entities connected to the StartArn(s) by created date. + // Filter the lineage entities connected to the StartArn (s) by created date. CreatedBefore *time.Time - // Filter the lineage entities connected to the StartArn(s) by the type of the + // Filter the lineage entities connected to the StartArn (s) by the type of the // lineage entity. LineageTypes []LineageType - // Filter the lineage entities connected to the StartArn(s) after the last modified - // date. + // Filter the lineage entities connected to the StartArn (s) after the last + // modified date. ModifiedAfter *time.Time - // Filter the lineage entities connected to the StartArn(s) before the last + // Filter the lineage entities connected to the StartArn (s) before the last // modified date. ModifiedBefore *time.Time - // Filter the lineage entities connected to the StartArn(s) by a set if property + // Filter the lineage entities connected to the StartArn (s) by a set if property // key value pairs. If multiple pairs are provided, an entity is included in the // results if it matches any of the provided pairs. Properties map[string]string // Filter the lineage entities connected to the StartArn by type. For example: - // DataSet, Model, Endpoint, or ModelDeployment. + // DataSet , Model , Endpoint , or ModelDeployment . Types []string noSmithyDocumentSerde @@ -12890,7 +11301,7 @@ type QueryFilters struct { // inference endpoint. type RealTimeInferenceConfig struct { - // The number of instances of the type specified by InstanceType. + // The number of instances of the type specified by InstanceType . // // This member is required. InstanceCount *int32 @@ -12914,8 +11325,7 @@ type RecommendationJobCompiledOutputConfig struct { } // Specifies mandatory fields for running an Inference Recommender job directly in -// the CreateInferenceRecommendationsJob -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) +// the CreateInferenceRecommendationsJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) // API. The fields specified in ContainerConfig override the corresponding fields // in the model package. Use ContainerConfig if you want to specify these fields // for the recommendation job but don't want to edit them in your model package. @@ -12923,8 +11333,8 @@ type RecommendationJobContainerConfig struct { // Specifies the name and shape of the expected data inputs for your trained model // with a JSON dictionary form. This field is used for optimizing your model using - // SageMaker Neo. For more information, see DataInputConfig - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InputConfig.html#sagemaker-Type-InputConfig-DataInputConfig). + // SageMaker Neo. For more information, see DataInputConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InputConfig.html#sagemaker-Type-InputConfig-DataInputConfig) + // . DataInputConfig *string // The machine learning domain of the model and its components. Valid Values: @@ -12938,12 +11348,12 @@ type RecommendationJobContainerConfig struct { // The framework version of the container image. FrameworkVersion *string - // The name of a pre-trained machine learning model benchmarked by Amazon SageMaker - // Inference Recommender that matches your model. Valid Values: efficientnetb7 | - // unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | - // mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | - // xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras - // | resnet50 | retinanet + // The name of a pre-trained machine learning model benchmarked by Amazon + // SageMaker Inference Recommender that matches your model. Valid Values: + // efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | + // inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | + // resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased + // | xceptionV1-keras | resnet50 | retinanet NearestModelName *string // Specifies the SamplePayloadUrl and all other sample payload-related fields. @@ -12963,14 +11373,14 @@ type RecommendationJobContainerConfig struct { // The details for a specific benchmark from an Inference Recommender job. type RecommendationJobInferenceBenchmark struct { - // Defines the model configuration. Includes the specification name and environment - // parameters. + // Defines the model configuration. Includes the specification name and + // environment parameters. // // This member is required. ModelConfiguration *ModelConfiguration - // The endpoint configuration made by Inference Recommender during a recommendation - // job. + // The endpoint configuration made by Inference Recommender during a + // recommendation job. EndpointConfiguration *EndpointOutputConfiguration // The metrics for an existing endpoint compared in an Inference Recommender job. @@ -13023,21 +11433,11 @@ type RecommendationJobInputConfig struct { // inference recommendation job will fail asynchronously during endpoint // configuration creation if the role passed does not have kms:CreateGrant // permission. The KmsKeyId can be any of the following formats: - // - // * // KMS Key ID - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // Amazon Resource Name (ARN) of a KMS - // Key "arn:aws:kms:::key/" - // - // * // KMS Key Alias "alias/ExampleAlias" - // - // * // Amazon - // Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:::alias/" - // - // For more - // information about key identifiers, see Key identifiers (KeyID) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:::key/" + // - // KMS Key Alias "alias/ExampleAlias" + // - // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:::alias/" + // For more information about key identifiers, see Key identifiers (KeyID) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) // in the Amazon Web Services Key Management Service (Amazon Web Services KMS) // documentation. VolumeKmsKeyId *string @@ -13060,21 +11460,11 @@ type RecommendationJobOutputConfig struct { // artifacts with Amazon S3 server-side encryption. The SageMaker execution role // must have kms:GenerateDataKey permission. The KmsKeyId can be any of the // following formats: - // - // * // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // - // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:::key/" - // - // * // KMS Key Alias - // "alias/ExampleAlias" - // - // * // Amazon Resource Name (ARN) of a KMS Key Alias - // "arn:aws:kms:::alias/" - // - // For more information about key identifiers, see Key - // identifiers (KeyID) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:::key/" + // - // KMS Key Alias "alias/ExampleAlias" + // - // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:::alias/" + // For more information about key identifiers, see Key identifiers (KeyID) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) // in the Amazon Web Services Key Management Service (Amazon Web Services KMS) // documentation. KmsKeyId *string @@ -13109,8 +11499,8 @@ type RecommendationJobResourceLimit struct { noSmithyDocumentSerde } -// Specifies conditions for stopping a job. When a job reaches a stopping condition -// limit, SageMaker ends the job. +// Specifies conditions for stopping a job. When a job reaches a stopping +// condition limit, SageMaker ends the job. type RecommendationJobStoppingConditions struct { // The maximum number of requests per minute expected for the endpoint. @@ -13129,7 +11519,7 @@ type RecommendationJobStoppingConditions struct { // inference recommendation job. type RecommendationJobVpcConfig struct { - // The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the + // The VPC security group IDs. IDs have the form of sg-xxxxxxxx . Specify the // security groups for the VPC that is specified in the Subnets field. // // This member is required. @@ -13166,8 +11556,8 @@ type RecommendationMetrics struct { // This member is required. ModelLatency int32 - // The expected CPU utilization at maximum invocations per minute for the instance. - // NaN indicates that the value is not available. + // The expected CPU utilization at maximum invocations per minute for the + // instance. NaN indicates that the value is not available. CpuUtilization *float32 // The expected memory utilization at maximum invocations per minute for the @@ -13238,10 +11628,10 @@ type RegisterModelStepMetadata struct { // Contains input values for a task. type RenderableTask struct { - // A JSON object that contains values for the variables defined in the template. It - // is made available to the template under the substitution variable task.input. - // For example, if you define a variable task.input.text in your template, you can - // supply the variable in the JSON object as "text": "sample text". + // A JSON object that contains values for the variables defined in the template. + // It is made available to the template under the substitution variable task.input + // . For example, if you define a variable task.input.text in your template, you + // can supply the variable in the JSON object as "text": "sample text" . // // This member is required. Input *string @@ -13275,8 +11665,7 @@ type RepositoryAuthConfig struct { // The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that // provides credentials to authenticate to the private Docker registry where your // model image is hosted. For information about how to create an Amazon Web - // Services Lambda function, see Create a Lambda function with the console - // (https://docs.aws.amazon.com/lambda/latest/dg/getting-started-create-function.html) + // Services Lambda function, see Create a Lambda function with the console (https://docs.aws.amazon.com/lambda/latest/dg/getting-started-create-function.html) // in the Amazon Web Services Lambda Developer Guide. // // This member is required. @@ -13289,7 +11678,7 @@ type RepositoryAuthConfig struct { type ResolvedAttributes struct { // Specifies a metric to minimize or maximize as the objective of a job. V2 API - // jobs (for example jobs created by calling CreateAutoMLJobV2), support Accuracy + // jobs (for example jobs created by calling CreateAutoMLJobV2 ), support Accuracy // only. AutoMLJobObjective *AutoMLJobObjective @@ -13307,26 +11696,25 @@ type ResolvedAttributes struct { // ML storage volumes, to use for model training. type ResourceConfig struct { - // The size of the ML storage volume that you want to provision. ML storage volumes - // store model artifacts and incremental states. Training algorithms might also use - // the ML storage volume for scratch space. If you want to store the training data - // in the ML storage volume, choose File as the TrainingInputMode in the algorithm - // specification. When using an ML instance with NVMe SSD volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes), - // SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. + // The size of the ML storage volume that you want to provision. ML storage + // volumes store model artifacts and incremental states. Training algorithms might + // also use the ML storage volume for scratch space. If you want to store the + // training data in the ML storage volume, choose File as the TrainingInputMode in + // the algorithm specification. When using an ML instance with NVMe SSD volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes) + // , SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. // Available storage is fixed to the NVMe-type instance's storage capacity. // SageMaker configures storage paths for training datasets, checkpoints, model // artifacts, and outputs to use the entire capacity of the instance storage. For - // example, ML instance families with the NVMe-type instance storage include - // ml.p4d, ml.g4dn, and ml.g5. When using an ML instance with the EBS-only storage + // example, ML instance families with the NVMe-type instance storage include ml.p4d + // , ml.g4dn , and ml.g5 . When using an ML instance with the EBS-only storage // option and without instance storage, you must define the size of EBS volume // through VolumeSizeInGB in the ResourceConfig API. For example, ML instance - // families that use EBS volumes include ml.c5 and ml.p2. To look up instance types - // and their instance storage types and volumes, see Amazon EC2 Instance Types - // (http://aws.amazon.com/ec2/instance-types/). To find the default local paths - // defined by the SageMaker training platform, see Amazon SageMaker Training - // Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-train-storage.html). + // families that use EBS volumes include ml.c5 and ml.p2 . To look up instance + // types and their instance storage types and volumes, see Amazon EC2 Instance + // Types (http://aws.amazon.com/ec2/instance-types/) . To find the default local + // paths defined by the SageMaker training platform, see Amazon SageMaker Training + // Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs (https://docs.aws.amazon.com/sagemaker/latest/dg/model-train-storage.html) + // . // // This member is required. VolumeSizeInGB int32 @@ -13338,24 +11726,20 @@ type ResourceConfig struct { // The configuration of a heterogeneous cluster in JSON format. InstanceGroups []InstanceGroup - // The ML compute instance type. SageMaker Training on Amazon Elastic Compute Cloud - // (EC2) P4de instances is in preview release starting December 9th, 2022. Amazon - // EC2 P4de instances (http://aws.amazon.com/ec2/instance-types/p4/) (currently in - // preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU - // memory, which accelerate the speed of training ML models that need to be trained - // on large datasets of high-resolution data. In this preview release, Amazon - // SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to - // reduce model training time. The ml.p4de.24xlarge instances are available in the - // following Amazon Web Services Regions. - // - // * US East (N. Virginia) (us-east-1) - // - // * - // US West (Oregon) (us-west-2) - // - // To request quota limit increase and start using - // P4de instances, contact the SageMaker Training service team through your account - // team. + // The ML compute instance type. SageMaker Training on Amazon Elastic Compute + // Cloud (EC2) P4de instances is in preview release starting December 9th, 2022. + // Amazon EC2 P4de instances (http://aws.amazon.com/ec2/instance-types/p4/) + // (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB + // high-performance HBM2e GPU memory, which accelerate the speed of training ML + // models that need to be trained on large datasets of high-resolution data. In + // this preview release, Amazon SageMaker supports ML training jobs on P4de + // instances ( ml.p4de.24xlarge ) to reduce model training time. The + // ml.p4de.24xlarge instances are available in the following Amazon Web Services + // Regions. + // - US East (N. Virginia) (us-east-1) + // - US West (Oregon) (us-west-2) + // To request quota limit increase and start using P4de instances, contact the + // SageMaker Training service team through your account team. InstanceType TrainingInstanceType // The duration of time in seconds to retain configured resources in a warm pool @@ -13368,25 +11752,19 @@ type ResourceConfig struct { // type. Local storage volumes are encrypted using a hardware module on the // instance. You can't request a VolumeKmsKeyId when using an instance type with // local storage. For a list of instance types that support local instance storage, - // see Instance Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). - // For more information about local instance storage encryption, see SSD Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). - // The VolumeKmsKeyId can be in any of the following formats: - // - // * // KMS Key ID - // "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // Amazon Resource Name (ARN) of a KMS - // Key - // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // see Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) + // . For more information about local instance storage encryption, see SSD + // Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) + // . The VolumeKmsKeyId can be in any of the following formats: + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string noSmithyDocumentSerde } -// The ResourceConfig to update KeepAlivePeriodInSeconds. Other fields in the +// The ResourceConfig to update KeepAlivePeriodInSeconds . Other fields in the // ResourceConfig cannot be updated. type ResourceConfigForUpdate struct { @@ -13422,9 +11800,9 @@ type ResourceLimits struct { type ResourceSpec struct { // The instance type that the image version runs on. JupyterServer apps only - // support the system value. For KernelGateway apps, the system value is translated - // to ml.t3.medium. KernelGateway apps also support all other values for available - // instance types. + // support the system value. For KernelGateway apps, the system value is + // translated to ml.t3.medium . KernelGateway apps also support all other values + // for available instance types. InstanceType AppInstanceType // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the @@ -13444,7 +11822,7 @@ type ResourceSpec struct { // volume. type RetentionPolicy struct { - // The default is Retain, which specifies to keep the data stored on the EFS + // The default is Retain , which specifies to keep the data stored on the EFS // volume. Specify Delete to delete the data stored on the EFS volume. HomeEfsFileSystem RetentionType @@ -13452,13 +11830,14 @@ type RetentionPolicy struct { } // The retry strategy to use when a training job fails due to an -// InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob -// and CreateHyperParameterTuningJob requests. You can add the StoppingCondition -// parameter to the request to limit the training time for the complete job. +// InternalServerError . RetryStrategy is specified as part of the +// CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the +// StoppingCondition parameter to the request to limit the training time for the +// complete job. type RetryStrategy struct { // The number of times to retry the job. When the job is retried, it's - // SecondaryStatus is changed to STARTING. + // SecondaryStatus is changed to STARTING . // // This member is required. MaximumRetryAttempts int32 @@ -13487,8 +11866,8 @@ type RStudioServerProAppSettings struct { // Indicates whether the current user has access to the RStudioServerPro app. AccessStatus RStudioServerProAccessStatus - // The level of permissions that the user has within the RStudioServerPro app. This - // value defaults to `User`. The `Admin` value allows the user access to the + // The level of permissions that the user has within the RStudioServerPro app. + // This value defaults to `User`. The `Admin` value allows the user access to the // RStudio Administrative Dashboard. UserGroup RStudioServerProUserGroup @@ -13541,38 +11920,37 @@ type RStudioServerProDomainSettingsForUpdate struct { // Describes the S3 data source. type S3DataSource struct { - // If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all + // If you choose S3Prefix , S3Uri identifies a key name prefix. SageMaker uses all // objects that match the specified key name prefix for model training. If you - // choose ManifestFile, S3Uri identifies an object that is a manifest file + // choose ManifestFile , S3Uri identifies an object that is a manifest file // containing a list of object keys that you want SageMaker to use for model - // training. If you choose AugmentedManifestFile, S3Uri identifies an object that + // training. If you choose AugmentedManifestFile , S3Uri identifies an object that // is an augmented manifest file in JSON lines format. This file contains the data // you want to use for model training. AugmentedManifestFile can only be used if - // the Channel's input mode is Pipe. + // the Channel's input mode is Pipe . // // This member is required. S3DataType S3DataType - // Depending on the value specified for the S3DataType, identifies either a key + // Depending on the value specified for the S3DataType , identifies either a key // name prefix or a manifest. For example: - // - // * A key name prefix might look like - // this: s3://bucketname/exampleprefix - // - // * A manifest might look like this: - // s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file - // consisting of an array of elements. The first element is a prefix which is - // followed by one or more suffixes. SageMaker appends the suffix elements to the - // prefix to get a full set of S3Uri. Note that the prefix must be a valid - // non-empty S3Uri that precludes users from specifying a manifest whose individual - // S3Uri is sourced from different S3 buckets. The following code example shows a - // valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, - // "relative/path/to/custdata-1", "relative/path/custdata-2", ... - // "relative/path/custdata-N"] This JSON is equivalent to the following S3Uri list: - // s3://customer_bucket/some/prefix/relative/path/to/custdata-1s3://customer_bucket/some/prefix/relative/path/custdata-2...s3://customer_bucket/some/prefix/relative/path/custdata-N - // The complete set of S3Uri in this manifest is the input data for the channel for - // this data source. The object that each S3Uri points to must be readable by the - // IAM role that SageMaker uses to perform tasks on your behalf. + // - A key name prefix might look like this: s3://bucketname/exampleprefix + // - A manifest might look like this: s3://bucketname/example.manifest A manifest + // is an S3 object which is a JSON file consisting of an array of elements. The + // first element is a prefix which is followed by one or more suffixes. SageMaker + // appends the suffix elements to the prefix to get a full set of S3Uri . Note + // that the prefix must be a valid non-empty S3Uri that precludes users from + // specifying a manifest whose individual S3Uri is sourced from different S3 + // buckets. The following code example shows a valid manifest format: [ + // {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", + // "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is + // equivalent to the following S3Uri list: + // s3://customer_bucket/some/prefix/relative/path/to/custdata-1 + // s3://customer_bucket/some/prefix/relative/path/custdata-2 ... + // s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of + // S3Uri in this manifest is the input data for the channel for this data source. + // The object that each S3Uri points to must be readable by the IAM role that + // SageMaker uses to perform tasks on your behalf. // // This member is required. S3Uri *string @@ -13585,9 +11963,9 @@ type S3DataSource struct { InstanceGroupNames []string // If you want SageMaker to replicate the entire dataset on each ML compute - // instance that is launched for model training, specify FullyReplicated. If you + // instance that is launched for model training, specify FullyReplicated . If you // want SageMaker to replicate a subset of data on each ML compute instance that is - // launched for model training, specify ShardedByS3Key. If there are n ML compute + // launched for model training, specify ShardedByS3Key . If there are n ML compute // instances launched for a training job, each instance gets approximately 1/n of // the number of S3 objects. In this case, model training on each machine uses only // the subset of training data. Don't choose more ML compute instances for training @@ -13595,8 +11973,8 @@ type S3DataSource struct { // pay for nodes that aren't getting any training data. This applies in both File // and Pipe modes. Keep this in mind when developing algorithms. In distributed // training, where you use multiple ML compute EC2 instances, you might choose - // ShardedByS3Key. If the algorithm requires copying training data to the ML - // storage volume (when TrainingInputMode is set to File), this copies 1/n of the + // ShardedByS3Key . If the algorithm requires copying training data to the ML + // storage volume (when TrainingInputMode is set to File ), this copies 1/n of the // number of objects. S3DataDistributionType S3DataDistribution @@ -13604,11 +11982,11 @@ type S3DataSource struct { } // The Amazon Simple Storage (Amazon S3) location and and security configuration -// for OfflineStore. +// for OfflineStore . type S3StorageConfig struct { - // The S3 URI, or location in Amazon S3, of OfflineStore. S3 URIs have a format - // similar to the following: s3://example-bucket/prefix/. + // The S3 URI, or location in Amazon S3, of OfflineStore . S3 URIs have a format + // similar to the following: s3://example-bucket/prefix/ . // // This member is required. S3Uri *string @@ -13616,9 +11994,8 @@ type S3StorageConfig struct { // The Amazon Web Services Key Management Service (KMS) key ARN of the key used to // encrypt any objects written into the OfflineStore S3 location. The IAM roleARN // that is passed as a parameter to CreateFeatureGroup must have below permissions - // to the KmsKeyId: - // - // * "kms:GenerateDataKey" + // to the KmsKeyId : + // - "kms:GenerateDataKey" KmsKeyId *string // The S3 path where offline records are written. @@ -13632,38 +12009,22 @@ type ScheduleConfig struct { // A cron expression that describes details about the monitoring schedule. // Currently the only supported cron expressions are: - // - // * If you want to set the job - // to start every hour, please use the following: Hourly: cron(0 * ? * * *) - // - // * If - // you want to start the job daily: cron(0 [00-23] ? * * *) - // - // For example, the - // following are valid cron expressions: - // - // * Daily at noon UTC: cron(0 12 ? * * - // *) - // - // * Daily at midnight UTC: cron(0 0 ? * * *) - // - // To support running every 6, 12 - // hours, the following are also supported: cron(0 [00-23]/[01-24] ? * * *) For - // example, the following are valid cron expressions: - // - // * Every 12 hours, starting - // at 5pm UTC: cron(0 17/12 ? * * *) - // - // * Every two hours starting at midnight: - // cron(0 0/2 ? * * *) - // - // * Even though the cron expression is set to start at 5PM - // UTC, note that there could be a delay of 0-20 minutes from the actual requested - // time to run the execution. - // - // * We recommend that if you would like a daily - // schedule, you do not provide this parameter. Amazon SageMaker will pick a time - // for running every day. + // - If you want to set the job to start every hour, please use the following: + // Hourly: cron(0 * ? * * *) + // - If you want to start the job daily: cron(0 [00-23] ? * * *) + // For example, the following are valid cron expressions: + // - Daily at noon UTC: cron(0 12 ? * * *) + // - Daily at midnight UTC: cron(0 0 ? * * *) + // To support running every 6, 12 hours, the following are also supported: cron(0 + // [00-23]/[01-24] ? * * *) For example, the following are valid cron expressions: + // - Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *) + // - Every two hours starting at midnight: cron(0 0/2 ? * * *) + // + // - Even though the cron expression is set to start at 5PM UTC, note that there + // could be a delay of 0-20 minutes from the actual requested time to run the + // execution. + // - We recommend that if you would like a daily schedule, you do not provide + // this parameter. Amazon SageMaker will pick a time for running every day. // // This member is required. ScheduleExpression *string @@ -13676,21 +12037,14 @@ type ScheduleConfig struct { // included in the search results. You must specify at least one subexpression, // filter, or nested filter. A SearchExpression can contain up to twenty elements. // A SearchExpression contains the following components: -// -// * A list of Filter -// objects. Each filter defines a simple Boolean expression comprised of a resource -// property name, Boolean operator, and value. -// -// * A list of NestedFilter objects. -// Each nested filter defines a list of Boolean expressions using a list of -// resource properties. A nested filter is satisfied if a single object in the list -// satisfies all Boolean expressions. -// -// * A list of SearchExpression objects. A -// search expression object can be nested in a list of search expression -// objects. -// -// * A Boolean operator: And or Or. +// - A list of Filter objects. Each filter defines a simple Boolean expression +// comprised of a resource property name, Boolean operator, and value. +// - A list of NestedFilter objects. Each nested filter defines a list of Boolean +// expressions using a list of resource properties. A nested filter is satisfied if +// a single object in the list satisfies all Boolean expressions. +// - A list of SearchExpression objects. A search expression object can be nested +// in a list of search expression objects. +// - A Boolean operator: And or Or . type SearchExpression struct { // A list of filter objects. @@ -13701,9 +12055,9 @@ type SearchExpression struct { // A Boolean operator used to evaluate the search expression. If you want every // conditional statement in all lists to be satisfied for the entire search - // expression to be true, specify And. If only a single conditional statement needs - // to be true for the entire search expression to be true, specify Or. The default - // value is And. + // expression to be true, specify And . If only a single conditional statement + // needs to be true for the entire search expression to be true, specify Or . The + // default value is And . Operator BooleanOperator // A list of search expression objects. @@ -13767,7 +12121,7 @@ type SearchRecord struct { noSmithyDocumentSerde } -// An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It +// An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions . It // provides additional details about a status that the training job has // transitioned through. A training job can be in one of several states, for // example, starting, downloading, training, or uploading. Within each state, there @@ -13782,54 +12136,30 @@ type SecondaryStatusTransition struct { // This member is required. StartTime *time.Time - // Contains a secondary status information from a training job. Status might be one - // of the following secondary statuses: InProgress - // - // * Starting - Starting the - // training job. - // - // * Downloading - An optional stage for algorithms that support - // File training input mode. It indicates that data is being downloaded to the ML - // storage volumes. - // - // * Training - Training is in progress. - // - // * Uploading - Training - // is complete and the model artifacts are being uploaded to the S3 - // location. - // + // Contains a secondary status information from a training job. Status might be + // one of the following secondary statuses: InProgress + // - Starting - Starting the training job. + // - Downloading - An optional stage for algorithms that support File training + // input mode. It indicates that data is being downloaded to the ML storage + // volumes. + // - Training - Training is in progress. + // - Uploading - Training is complete and the model artifacts are being uploaded + // to the S3 location. // Completed - // - // * Completed - The training job has completed. - // + // - Completed - The training job has completed. // Failed - // - // * - // Failed - The training job has failed. The reason for the failure is returned in - // the FailureReason field of DescribeTrainingJobResponse. - // + // - Failed - The training job has failed. The reason for the failure is returned + // in the FailureReason field of DescribeTrainingJobResponse . // Stopped - // - // * - // MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed - // runtime. - // - // * Stopped - The training job has stopped. - // + // - MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed + // runtime. + // - Stopped - The training job has stopped. // Stopping - // - // * Stopping - - // Stopping the training job. - // - // We no longer support the following secondary - // statuses: - // - // * LaunchingMLInstances - // - // * PreparingTrainingStack - // - // * - // DownloadingTrainingImage + // - Stopping - Stopping the training job. + // We no longer support the following secondary statuses: + // - LaunchingMLInstances + // - PreparingTrainingStack + // - DownloadingTrainingImage // // This member is required. Status SecondaryStatus @@ -13842,86 +12172,61 @@ type SecondaryStatusTransition struct { // A detailed description of the progress within a secondary status. SageMaker // provides secondary statuses and status messages that apply to each of them: // Starting - // - // * Starting the training job. - // - // * Launching requested ML instances. - // - // * - // Insufficient capacity error from EC2 while launching instances, retrying! - // - // * - // Launched instance was unhealthy, replacing it! - // - // * Preparing the instances for - // training. - // + // - Starting the training job. + // - Launching requested ML instances. + // - Insufficient capacity error from EC2 while launching instances, retrying! + // - Launched instance was unhealthy, replacing it! + // - Preparing the instances for training. // Training - // - // * Downloading the training image. - // - // * Training image - // download completed. Training in progress. - // - // Status messages are subject to - // change. Therefore, we recommend not including them in code that programmatically - // initiates actions. For examples, don't use status messages in if statements. To - // have an overview of your training job's progress, view TrainingJobStatus and - // SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, - // at the start of a training job, you might see the following: - // - // * - // TrainingJobStatus - InProgress - // - // * SecondaryStatus - Training - // - // * StatusMessage - - // Downloading the training image + // - Downloading the training image. + // - Training image download completed. Training in progress. + // Status messages are subject to change. Therefore, we recommend not including + // them in code that programmatically initiates actions. For examples, don't use + // status messages in if statements. To have an overview of your training job's + // progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob , + // and StatusMessage together. For example, at the start of a training job, you + // might see the following: + // - TrainingJobStatus - InProgress + // - SecondaryStatus - Training + // - StatusMessage - Downloading the training image StatusMessage *string noSmithyDocumentSerde } // Details of a provisioned service catalog product. For information about service -// catalog, see What is Amazon Web Services Service Catalog -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). +// catalog, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) +// . type ServiceCatalogProvisionedProductDetails struct { // The ID of the provisioned product. ProvisionedProductId *string // The current status of the product. - // - // * AVAILABLE - Stable state, ready to perform - // any operation. The most recent operation succeeded and completed. - // - // * - // UNDER_CHANGE - Transitive state. Operations performed might not have valid - // results. Wait for an AVAILABLE status before performing operations. - // - // * TAINTED - - // Stable state, ready to perform any operation. The stack has completed the - // requested operation but is not exactly what was requested. For example, a - // request to update to a new version failed and the stack rolled back to the - // current version. - // - // * ERROR - An unexpected error occurred. The provisioned - // product exists but the stack is not running. For example, CloudFormation - // received a parameter value that was not valid and could not launch the stack. - // - // * - // PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to - // provision a new product, but resources have not yet been created. After - // reviewing the list of resources to be created, execute the plan. Wait for an - // AVAILABLE status before performing operations. + // - AVAILABLE - Stable state, ready to perform any operation. The most recent + // operation succeeded and completed. + // - UNDER_CHANGE - Transitive state. Operations performed might not have valid + // results. Wait for an AVAILABLE status before performing operations. + // - TAINTED - Stable state, ready to perform any operation. The stack has + // completed the requested operation but is not exactly what was requested. For + // example, a request to update to a new version failed and the stack rolled back + // to the current version. + // - ERROR - An unexpected error occurred. The provisioned product exists but the + // stack is not running. For example, CloudFormation received a parameter value + // that was not valid and could not launch the stack. + // - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to + // provision a new product, but resources have not yet been created. After + // reviewing the list of resources to be created, execute the plan. Wait for an + // AVAILABLE status before performing operations. ProvisionedProductStatusMessage *string noSmithyDocumentSerde } -// Details that you specify to provision a service catalog product. For information -// about service catalog, see What is Amazon Web Services Service Catalog -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). +// Details that you specify to provision a service catalog product. For +// information about service catalog, see What is Amazon Web Services Service +// Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) +// . type ServiceCatalogProvisioningDetails struct { // The ID of the product to provision. @@ -13942,9 +12247,10 @@ type ServiceCatalogProvisioningDetails struct { noSmithyDocumentSerde } -// Details that you specify to provision a service catalog product. For information -// about service catalog, see What is Amazon Web Services Service Catalog -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html). +// Details that you specify to provision a service catalog product. For +// information about service catalog, see What is Amazon Web Services Service +// Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html) +// . type ServiceCatalogProvisioningUpdateDetails struct { // The ID of the provisioning artifact. @@ -14000,15 +12306,15 @@ type ShadowModelVariantConfig struct { type SharingSettings struct { // Whether to include the notebook cell output when sharing the notebook. The - // default is Disabled. + // default is Disabled . NotebookOutputOption NotebookOutputOption - // When NotebookOutputOption is Allowed, the Amazon Web Services Key Management + // When NotebookOutputOption is Allowed , the Amazon Web Services Key Management // Service (KMS) encryption key ID used to encrypt the notebook cell output in the // Amazon S3 bucket. S3KmsKeyId *string - // When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the + // When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the // shared notebook snapshots. S3OutputPath *string @@ -14016,15 +12322,15 @@ type SharingSettings struct { } // A configuration for a shuffle option for input data in a channel. If you use -// S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. -// If you use ManifestFile, the order of the S3 object references in the -// ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the +// S3Prefix for S3DataType , the results of the S3 key prefix matches are shuffled. +// If you use ManifestFile , the order of the S3 object references in the +// ManifestFile is shuffled. If you use AugmentedManifestFile , the order of the // JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is // determined using the Seed value. For Pipe input mode, when ShuffleConfig is // specified shuffling is done at the start of every epoch. With large datasets, // this ensures that the order of the training data is different for each epoch, // and it helps reduce bias and possible overfitting. In a multi-node training job -// when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, +// when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key , // the data is shuffled across nodes so that the content sent to a particular node // on the first epoch might be sent to a different node on the second epoch. type ShuffleConfig struct { @@ -14050,9 +12356,9 @@ type SourceAlgorithm struct { AlgorithmName *string // The Amazon S3 path where the model artifacts, which result from model training, - // are stored. This path must point to a single gzip compressed tar archive - // (.tar.gz suffix). The model artifacts must be in an S3 bucket that is in the - // same region as the algorithm. + // are stored. This path must point to a single gzip compressed tar archive ( + // .tar.gz suffix). The model artifacts must be in an S3 bucket that is in the same + // region as the algorithm. ModelDataUrl *string noSmithyDocumentSerde @@ -14069,17 +12375,15 @@ type SourceAlgorithmSpecification struct { noSmithyDocumentSerde } -// A list of IP address ranges (CIDRs -// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)). Used to -// create an allow list of IP addresses for a private workforce. Workers will only -// be able to login to their worker portal from an IP address within this range. By -// default, a workforce isn't restricted to specific IP addresses. +// A list of IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) +// ). Used to create an allow list of IP addresses for a private workforce. Workers +// will only be able to login to their worker portal from an IP address within this +// range. By default, a workforce isn't restricted to specific IP addresses. type SourceIpConfig struct { - // A list of one to ten Classless Inter-Domain Routing - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) (CIDR) - // values. Maximum: Ten CIDR values The following Length Constraints apply to - // individual CIDR values in the CIDR value list. + // A list of one to ten Classless Inter-Domain Routing (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // (CIDR) values. Maximum: Ten CIDR values The following Length Constraints apply + // to individual CIDR values in the CIDR value list. // // This member is required. Cidrs []string @@ -14132,7 +12436,7 @@ type SpaceSettings struct { // model might not be in a state from which it can be saved. For example, if // training has just started, the model might not be ready to save. When saved, // this intermediate data is a valid model artifact. You can use it to create a -// model with CreateModel. The Neural Topic Model (NTM) currently does not support +// model with CreateModel . The Neural Topic Model (NTM) currently does not support // saving intermediate model artifacts. When training NTMs, make sure that the // maximum runtime is sufficient for the training job to complete. type StoppingCondition struct { @@ -14142,17 +12446,17 @@ type StoppingCondition struct { // during this time, a TimeOut error is generated. We recommend starting with 900 // seconds and increasing as necessary based on your model. For all other jobs, if // the job does not complete during this time, SageMaker ends the job. When - // RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the - // maximum time for all of the attempts in total, not each individual attempt. The - // default value is 1 day. The maximum value is 28 days. The maximum time that a - // TrainingJob can run in total, including any time spent publishing metrics or + // RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies + // the maximum time for all of the attempts in total, not each individual attempt. + // The default value is 1 day. The maximum value is 28 days. The maximum time that + // a TrainingJob can run in total, including any time spent publishing metrics or // archiving and uploading models after it has been stopped, is 30 days. MaxRuntimeInSeconds int32 // The maximum length of time, in seconds, that a managed Spot training job has to // complete. It is the amount of time spent waiting for Spot capacity plus the // amount of time the job can run. It must be equal to or greater than - // MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker + // MaxRuntimeInSeconds . If the job does not complete during this time, SageMaker // ends the job. When RetryStrategy is specified in the job request, // MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in // total, not each individual attempt. @@ -14167,8 +12471,8 @@ type StudioLifecycleConfigDetails struct { // The creation time of the Studio Lifecycle Configuration. CreationTime *time.Time - // This value is equivalent to CreationTime because Studio Lifecycle Configurations - // are immutable. + // This value is equivalent to CreationTime because Studio Lifecycle + // Configurations are immutable. LastModifiedTime *time.Time // The App type to which the Lifecycle Configuration is attached. @@ -14221,14 +12525,13 @@ type SuggestionQuery struct { // metadata for SageMaker Amazon Web Services resources. You can add tags to // notebook instances, training jobs, hyperparameter tuning jobs, batch transform // jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. -// For more information on adding tags to SageMaker resources, see AddTags. For +// For more information on adding tags to SageMaker resources, see AddTags . For // more information on adding metadata to your Amazon Web Services resources with -// tagging, see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on -// best practices for managing Amazon Web Services resources with tagging, see -// Tagging Best Practices: Implement an Effective Amazon Web Services Resource -// Tagging Strategy -// (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). +// tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// . For advice on best practices for managing Amazon Web Services resources with +// tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services +// Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf) +// . type Tag struct { // The tag key. Tag keys must be unique per resource. @@ -14244,51 +12547,35 @@ type Tag struct { noSmithyDocumentSerde } -// Contains information about a target platform that you want your model to run on, -// such as OS, architecture, and accelerators. It is an alternative of -// TargetDevice. +// Contains information about a target platform that you want your model to run +// on, such as OS, architecture, and accelerators. It is an alternative of +// TargetDevice . type TargetPlatform struct { // Specifies a target platform architecture. - // - // * X86_64: 64-bit version of the x86 - // instruction set. - // - // * X86: 32-bit version of the x86 instruction set. - // - // * ARM64: - // ARMv8 64-bit CPU. - // - // * ARM_EABIHF: ARMv7 32-bit, Hard Float. - // - // * ARM_EABI: ARMv7 - // 32-bit, Soft Float. Used by Android 32-bit ARM platform. + // - X86_64 : 64-bit version of the x86 instruction set. + // - X86 : 32-bit version of the x86 instruction set. + // - ARM64 : ARMv8 64-bit CPU. + // - ARM_EABIHF : ARMv7 32-bit, Hard Float. + // - ARM_EABI : ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform. // // This member is required. Arch TargetPlatformArch // Specifies a target platform OS. - // - // * LINUX: Linux-based operating systems. - // - // * - // ANDROID: Android operating systems. Android API level can be specified using the - // ANDROID_PLATFORM compiler option. For example, "CompilerOptions": - // {'ANDROID_PLATFORM': 28} + // - LINUX : Linux-based operating systems. + // - ANDROID : Android operating systems. Android API level can be specified + // using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": + // {'ANDROID_PLATFORM': 28} // // This member is required. Os TargetPlatformOs // Specifies a target platform accelerator (optional). - // - // * NVIDIA: Nvidia graphics - // processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler - // options - // - // * MALI: ARM Mali graphics processor - // - // * INTEL_GRAPHICS: Integrated Intel - // graphics + // - NVIDIA : Nvidia graphics processing unit. It also requires gpu-code , + // trt-ver , cuda-ver compiler options + // - MALI : ARM Mali graphics processor + // - INTEL_GRAPHICS : Integrated Intel graphics Accelerator TargetPlatformAccelerator noSmithyDocumentSerde @@ -14304,8 +12591,8 @@ type TensorBoardAppSettings struct { noSmithyDocumentSerde } -// Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard -// output data. +// Configuration of storage locations for the Amazon SageMaker Debugger +// TensorBoard output data. type TensorBoardOutputConfig struct { // Path to Amazon S3 storage location for TensorBoard output. @@ -14314,7 +12601,7 @@ type TensorBoardOutputConfig struct { S3OutputPath *string // Path to local storage location for tensorBoard output. Defaults to - // /opt/ml/output/tensorboard. + // /opt/ml/output/tensorboard . LocalPath *string noSmithyDocumentSerde @@ -14328,8 +12615,8 @@ type TextClassificationJobConfig struct { // generate. CompletionCriteria *AutoMLJobCompletionCriteria - // The name of the column used to provide the sentences to be classified. It should - // not be the same as the target column. + // The name of the column used to provide the sentences to be classified. It + // should not be the same as the target column. ContentColumn *string // The name of the column used to provide the class labels. It should not be same @@ -14345,10 +12632,9 @@ type TimeSeriesForecastingSettings struct { // The IAM role that Canvas passes to Amazon Forecast for time series forecasting. // By default, Canvas uses the execution role specified in the UserProfile that // launches the Canvas app. If an execution role is not specified in the - // UserProfile, Canvas uses the execution role specified in the Domain that owns - // the UserProfile. To allow time series forecasting, this IAM role should have the - // AmazonSageMakerCanvasForecastAccess - // (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess) + // UserProfile , Canvas uses the execution role specified in the Domain that owns + // the UserProfile . To allow time series forecasting, this IAM role should have + // the AmazonSageMakerCanvasForecastAccess (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess) // policy attached and forecast.amazonaws.com added in the trust relationship as a // service principal. AmazonForecastRoleArn *string @@ -14377,16 +12663,12 @@ type TrafficPattern struct { type TrafficRoutingConfig struct { // Traffic routing strategy type. - // - // * ALL_AT_ONCE: Endpoint traffic shifts to the - // new fleet in a single step. - // - // * CANARY: Endpoint traffic shifts to the new fleet - // in two steps. The first step is the canary, which is a small portion of the - // traffic. The second step is the remainder of the traffic. - // - // * LINEAR: Endpoint - // traffic shifts to the new fleet in n steps of a configurable size. + // - ALL_AT_ONCE : Endpoint traffic shifts to the new fleet in a single step. + // - CANARY : Endpoint traffic shifts to the new fleet in two steps. The first + // step is the canary, which is a small portion of the traffic. The second step is + // the remainder of the traffic. + // - LINEAR : Endpoint traffic shifts to the new fleet in n steps of a + // configurable size. // // This member is required. Type TrafficRoutingConfigType @@ -14414,7 +12696,7 @@ type TrainingImageConfig struct { // The method that your training job will use to gain access to the images in your // private Docker registry. For access to an image in a private Docker registry, - // set to Vpc. + // set to Vpc . // // This member is required. TrainingRepositoryAccessMode TrainingRepositoryAccessMode @@ -14448,8 +12730,8 @@ type TrainingJob struct { // Configuration information for the Amazon SageMaker Debugger hook parameters, // metric and tensor collections, and storage paths. To learn more about how to // configure the DebugHookConfig parameter, see Use the SageMaker and Debugger - // Configuration API Operations to Create, Update, and Debug Your Training Job - // (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html). + // Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html) + // . DebugHookConfig *DebugHookConfig // Information about the debug rule configuration. @@ -14459,7 +12741,7 @@ type TrainingJob struct { DebugRuleEvaluationStatuses []DebugRuleEvaluationStatus // To encrypt all communications between ML compute instances in distributed - // training, choose True. Encryption provides greater security for distributed + // training, choose True . Encryption provides greater security for distributed // training, but training might take longer. How long it takes depends on the // amount of communication between compute instances, especially if you use a deep // learning algorithm in distributed training. @@ -14467,13 +12749,13 @@ type TrainingJob struct { // When true, enables managed spot training using Amazon EC2 Spot instances to run // training jobs instead of on-demand instances. For more information, see Managed - // Spot Training - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). + // Spot Training (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html) + // . EnableManagedSpotTraining bool - // If the TrainingJob was created with network isolation, the value is set to true. - // If network isolation is enabled, nodes can't communicate beyond the VPC they run - // in. + // If the TrainingJob was created with network isolation, the value is set to true + // . If network isolation is enabled, nodes can't communicate beyond the VPC they + // run in. EnableNetworkIsolation bool // The environment variables to set in the Docker container. @@ -14481,20 +12763,16 @@ type TrainingJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *ExperimentConfig // If the training job failed, the reason it failed. FailureReason *string - // A list of final metric values that are set when the training job completes. Used - // only if the training job was configured to use metrics. + // A list of final metric values that are set when the training job completes. + // Used only if the training job was configured to use metrics. FinalMetricDataList []MetricData // Algorithm-specific parameters. @@ -14523,63 +12801,40 @@ type TrainingJob struct { ResourceConfig *ResourceConfig // The number of times to retry the job when the job fails due to an - // InternalServerError. + // InternalServerError . RetryStrategy *RetryStrategy - // The Amazon Web Services Identity and Access Management (IAM) role configured for - // the training job. + // The Amazon Web Services Identity and Access Management (IAM) role configured + // for the training job. RoleArn *string // Provides detailed information about the state of the training job. For detailed // information about the secondary status of the training job, see StatusMessage - // under SecondaryStatusTransition. SageMaker provides primary statuses and + // under SecondaryStatusTransition . SageMaker provides primary statuses and // secondary statuses that apply to each of them: InProgress - // - // * Starting - Starting - // the training job. - // - // * Downloading - An optional stage for algorithms that support - // File training input mode. It indicates that data is being downloaded to the ML - // storage volumes. - // - // * Training - Training is in progress. - // - // * Uploading - Training - // is complete and the model artifacts are being uploaded to the S3 - // location. - // + // - Starting - Starting the training job. + // - Downloading - An optional stage for algorithms that support File training + // input mode. It indicates that data is being downloaded to the ML storage + // volumes. + // - Training - Training is in progress. + // - Uploading - Training is complete and the model artifacts are being uploaded + // to the S3 location. // Completed - // - // * Completed - The training job has completed. - // + // - Completed - The training job has completed. // Failed - // - // * - // Failed - The training job has failed. The reason for the failure is returned in - // the FailureReason field of DescribeTrainingJobResponse. - // + // - Failed - The training job has failed. The reason for the failure is returned + // in the FailureReason field of DescribeTrainingJobResponse . // Stopped - // - // * - // MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed - // runtime. - // - // * Stopped - The training job has stopped. - // + // - MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed + // runtime. + // - Stopped - The training job has stopped. // Stopping - // - // * Stopping - - // Stopping the training job. - // - // Valid values for SecondaryStatus are subject to - // change. We no longer support the following secondary statuses: - // - // * - // LaunchingMLInstances - // - // * PreparingTrainingStack - // - // * DownloadingTrainingImage + // - Stopping - Stopping the training job. + // Valid values for SecondaryStatus are subject to change. We no longer support + // the following secondary statuses: + // - LaunchingMLInstances + // - PreparingTrainingStack + // - DownloadingTrainingImage SecondaryStatus SecondaryStatus // A history of all of the secondary statuses that the training job has @@ -14596,12 +12851,12 @@ type TrainingJob struct { // An array of key-value pairs. You can use tags to categorize your Amazon Web // Services resources in different ways, for example, by purpose, owner, or - // environment. For more information, see Tagging Amazon Web Services Resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + // environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // . Tags []Tag - // Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard - // output data. + // Configuration of storage locations for the Amazon SageMaker Debugger + // TensorBoard output data. TensorBoardOutputConfig *TensorBoardOutputConfig // Indicates the time when the training job ends on training instances. You are @@ -14618,30 +12873,20 @@ type TrainingJob struct { TrainingJobName *string // The status of the training job. Training job statuses are: - // - // * InProgress - The - // training is in progress. - // - // * Completed - The training job has completed. - // - // * - // Failed - The training job has failed. To see the reason for the failure, see the - // FailureReason field in the response to a DescribeTrainingJobResponse call. - // - // * - // Stopping - The training job is stopping. - // - // * Stopped - The training job has - // stopped. - // - // For more detailed information, see SecondaryStatus. + // - InProgress - The training is in progress. + // - Completed - The training job has completed. + // - Failed - The training job has failed. To see the reason for the failure, see + // the FailureReason field in the response to a DescribeTrainingJobResponse call. + // - Stopping - The training job is stopping. + // - Stopped - The training job has stopped. + // For more detailed information, see SecondaryStatus . TrainingJobStatus TrainingJobStatus // Indicates the time when the training job starts on training instances. You are - // billed for the time interval between this time and the value of TrainingEndTime. - // The start time in CloudWatch Logs might be later than this time. The difference - // is due to the time it takes to download the training data and to the size of the - // training container. + // billed for the time interval between this time and the value of TrainingEndTime + // . The start time in CloudWatch Logs might be later than this time. The + // difference is due to the time it takes to download the training data and to the + // size of the training container. TrainingStartTime *time.Time // The training time in seconds. @@ -14653,7 +12898,7 @@ type TrainingJob struct { // A VpcConfig object that specifies the VPC that this training job has access to. // For more information, see Protect Training Jobs by Using an Amazon Virtual - // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). + // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) . VpcConfig *VpcConfig noSmithyDocumentSerde @@ -14673,8 +12918,8 @@ type TrainingJobDefinition struct { // This member is required. OutputDataConfig *OutputDataConfig - // The resources, including the ML compute instances and ML storage volumes, to use - // for model training. + // The resources, including the ML compute instances and ML storage volumes, to + // use for model training. // // This member is required. ResourceConfig *ResourceConfig @@ -14690,27 +12935,27 @@ type TrainingJobDefinition struct { StoppingCondition *StoppingCondition // The training input mode that the algorithm supports. For more information about - // input modes, see Algorithms - // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). Pipe mode If an - // algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon - // S3 to the container. File mode If an algorithm supports File mode, SageMaker - // downloads the training data from S3 to the provisioned ML storage volume, and - // mounts the directory to the Docker volume for the training container. You must - // provision the ML storage volume with sufficient capacity to accommodate the data - // downloaded from S3. In addition to the training data, the ML storage volume also - // stores the output model. The algorithm container uses the ML storage volume to - // also store intermediate information, if any. For distributed algorithms, - // training data is distributed uniformly. Your training duration is predictable if - // the input data objects sizes are approximately the same. SageMaker does not - // split the files any further for model training. If the object sizes are skewed, - // training won't be optimal as the data distribution is also skewed when one host - // in a training cluster is overloaded, thus becoming a bottleneck in training. - // FastFile mode If an algorithm supports FastFile mode, SageMaker streams data - // directly from S3 to the container with no code changes, and provides file system - // access to the data. Users can author their training script to interact with - // these files as if they were stored on disk. FastFile mode works best when the - // data is read sequentially. Augmented manifest files aren't supported. The - // startup time is lower when there are fewer files in the S3 bucket provided. + // input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) + // . Pipe mode If an algorithm supports Pipe mode, Amazon SageMaker streams data + // directly from Amazon S3 to the container. File mode If an algorithm supports + // File mode, SageMaker downloads the training data from S3 to the provisioned ML + // storage volume, and mounts the directory to the Docker volume for the training + // container. You must provision the ML storage volume with sufficient capacity to + // accommodate the data downloaded from S3. In addition to the training data, the + // ML storage volume also stores the output model. The algorithm container uses the + // ML storage volume to also store intermediate information, if any. For + // distributed algorithms, training data is distributed uniformly. Your training + // duration is predictable if the input data objects sizes are approximately the + // same. SageMaker does not split the files any further for model training. If the + // object sizes are skewed, training won't be optimal as the data distribution is + // also skewed when one host in a training cluster is overloaded, thus becoming a + // bottleneck in training. FastFile mode If an algorithm supports FastFile mode, + // SageMaker streams data directly from S3 to the container with no code changes, + // and provides file system access to the data. Users can author their training + // script to interact with these files as if they were stored on disk. FastFile + // mode works best when the data is read sequentially. Augmented manifest files + // aren't supported. The startup time is lower when there are fewer files in the S3 + // bucket provided. // // This member is required. TrainingInputMode TrainingInputMode @@ -14783,8 +13028,8 @@ type TrainingJobSummary struct { LastModifiedTime *time.Time // A timestamp that shows when the training job ended. This field is set only if - // the training job has one of the terminal statuses (Completed, Failed, or - // Stopped). + // the training job has one of the terminal statuses ( Completed , Failed , or + // Stopped ). TrainingEndTime *time.Time // The status of the warm pool associated with the training job. @@ -14796,8 +13041,8 @@ type TrainingJobSummary struct { // An object containing authentication information for a private Docker registry. type TrainingRepositoryAuthConfig struct { - // The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used to - // give SageMaker access credentials to your private Docker registry. + // The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function used + // to give SageMaker access credentials to your private Docker registry. // // This member is required. TrainingRepositoryCredentialsProviderArn *string @@ -14825,8 +13070,8 @@ type TrainingSpecification struct { // This member is required. TrainingImage *string - // A list of MetricDefinition objects, which are used for parsing metrics generated - // by the algorithm. + // A list of MetricDefinition objects, which are used for parsing metrics + // generated by the algorithm. MetricDefinitions []MetricDefinition // A list of the HyperParameterSpecification objects, that define the supported @@ -14834,8 +13079,8 @@ type TrainingSpecification struct { // tuning.> SupportedHyperParameters []HyperParameterSpecification - // A list of the metrics that the algorithm emits that can be used as the objective - // metric in a hyperparameter tuning job. + // A list of the metrics that the algorithm emits that can be used as the + // objective metric in a hyperparameter tuning job. SupportedTuningJobObjectiveMetrics []HyperParameterTuningJobObjective // Indicates whether the algorithm supports distributed training. If set to false, @@ -14872,7 +13117,7 @@ type TransformInput struct { // If your transform data is compressed, specify the compression type. Amazon // SageMaker automatically decompresses the data for the transform job accordingly. - // The default value is None. + // The default value is None . CompressionType CompressionType // The multipurpose internet mail extension (MIME) type of the data. Amazon @@ -14884,28 +13129,24 @@ type TransformInput struct { // Splitting is necessary when the total size of each object is too large to fit in // a single request. You can also use data splitting to improve performance by // processing multiple concurrent mini-batches. The default value for SplitType is - // None, which indicates that input data files are not split, and request payloads + // None , which indicates that input data files are not split, and request payloads // contain the entire contents of an input object. Set the value of this parameter // to Line to split records on a newline character boundary. SplitType also // supports a number of record-oriented binary data formats. Currently, the // supported record formats are: - // - // * RecordIO - // - // * TFRecord - // - // When splitting is - // enabled, the size of a mini-batch depends on the values of the BatchStrategy and - // MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, - // Amazon SageMaker sends the maximum number of records in each request, up to the - // MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon - // SageMaker sends individual records in each request. Some data formats represent - // a record as a binary payload wrapped with extra padding bytes. When splitting is - // applied to a binary data format, padding is removed if the value of - // BatchStrategy is set to SingleRecord. Padding is not removed if the value of - // BatchStrategy is set to MultiRecord. For more information about RecordIO, see - // Create a Dataset Using RecordIO (https://mxnet.apache.org/api/faq/recordio) in - // the MXNet documentation. For more information about TFRecord, see Consuming + // - RecordIO + // - TFRecord + // When splitting is enabled, the size of a mini-batch depends on the values of + // the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy + // is MultiRecord , Amazon SageMaker sends the maximum number of records in each + // request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is + // SingleRecord , Amazon SageMaker sends individual records in each request. Some + // data formats represent a record as a binary payload wrapped with extra padding + // bytes. When splitting is applied to a binary data format, padding is removed if + // the value of BatchStrategy is set to SingleRecord . Padding is not removed if + // the value of BatchStrategy is set to MultiRecord . For more information about + // RecordIO , see Create a Dataset Using RecordIO (https://mxnet.apache.org/api/faq/recordio) + // in the MXNet documentation. For more information about TFRecord , see Consuming // TFRecord data (https://www.tensorflow.org/guide/data#consuming_tfrecord_data) in // the TensorFlow documentation. SplitType SplitType @@ -14914,16 +13155,16 @@ type TransformInput struct { } // A batch transform job. For information about SageMaker batch transform, see Use -// Batch Transform -// (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html). +// Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html) +// . type TransformJob struct { // The Amazon Resource Name (ARN) of the AutoML job that created the transform job. AutoMLJobArn *string - // Specifies the number of records to include in a mini-batch for an HTTP inference - // request. A record is a single unit of input data that inference can be made on. - // For example, a single line in a CSV file is a record. + // Specifies the number of records to include in a mini-batch for an HTTP + // inference request. A record is a single unit of input data that inference can be + // made on. For example, a single line in a CSV file is a record. BatchStrategy BatchStrategy // A timestamp that shows when the transform Job was created. @@ -14935,8 +13176,8 @@ type TransformJob struct { // data that is not needed for inference in a batch transform job. The output // filter provided allows you to include input data relevant to interpreting the // predictions in the output from the job. For more information, see Associate - // Prediction Results with their Corresponding Input Records - // (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html). + // Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html) + // . DataProcessing *DataProcessing // The environment variables to set in the Docker container. We support up to 16 @@ -14945,13 +13186,9 @@ type TransformJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - // * CreateProcessingJob - // - // * - // CreateTrainingJob - // - // * CreateTransformJob + // - CreateProcessingJob + // - CreateTrainingJob + // - CreateTransformJob ExperimentConfig *ExperimentConfig // If the transform job failed, the reason it failed. @@ -14966,14 +13203,14 @@ type TransformJob struct { // checks the optional execution-parameters to determine the settings for your // chosen algorithm. If the execution-parameters endpoint is not enabled, the // default value is 1. For built-in algorithms, you don't need to set a value for - // MaxConcurrentTransforms. + // MaxConcurrentTransforms . MaxConcurrentTransforms *int32 - // The maximum allowed size of the payload, in MB. A payload is the data portion of - // a record (without metadata). The value in MaxPayloadInMB must be greater than, - // or equal to, the size of a single record. To estimate the size of a record in - // MB, divide the size of your dataset by the number of records. To ensure that the - // records fit within the maximum payload size, we recommend using a slightly + // The maximum allowed size of the payload, in MB. A payload is the data portion + // of a record (without metadata). The value in MaxPayloadInMB must be greater + // than, or equal to, the size of a single record. To estimate the size of a record + // in MB, divide the size of your dataset by the number of records. To ensure that + // the records fit within the maximum payload size, we recommend using a slightly // larger value. The default value is 6 MB. For cases where the payload might be // arbitrarily large and is transmitted using HTTP chunked encoding, set the value // to 0. This feature works only in supported algorithms. Currently, SageMaker @@ -14992,7 +13229,7 @@ type TransformJob struct { // Indicates when the transform job has been completed, or has stopped or failed. // You are billed for the time interval between this time and the value of - // TransformStartTime. + // TransformStartTime . TransformEndTime *time.Time // Describes the input source of a transform job and the way the transform job @@ -15006,20 +13243,12 @@ type TransformJob struct { TransformJobName *string // The status of the transform job. Transform job statuses are: - // - // * InProgress - The - // job is in progress. - // - // * Completed - The job has completed. - // - // * Failed - The - // transform job has failed. To see the reason for the failure, see the - // FailureReason field in the response to a DescribeTransformJob call. - // - // * Stopping - // - The transform job is stopping. - // - // * Stopped - The transform job has stopped. + // - InProgress - The job is in progress. + // - Completed - The job has completed. + // - Failed - The transform job has failed. To see the reason for the failure, + // see the FailureReason field in the response to a DescribeTransformJob call. + // - Stopping - The transform job is stopping. + // - Stopped - The transform job has stopped. TransformJobStatus TransformJobStatus // Describes the results of a transform job. @@ -15030,7 +13259,7 @@ type TransformJob struct { TransformResources *TransformResources // Indicates when the transform job starts on ML instances. You are billed for the - // time interval between this time and the value of TransformEndTime. + // time interval between this time and the value of TransformEndTime . TransformStartTime *time.Time noSmithyDocumentSerde @@ -15130,15 +13359,15 @@ type TransformJobSummary struct { type TransformOutput struct { // The Amazon S3 path where you want Amazon SageMaker to store the results of the - // transform job. For example, s3://bucket-name/key-name-prefix. For every S3 + // transform job. For example, s3://bucket-name/key-name-prefix . For every S3 // object used as input for the transform job, batch transform stores the - // transformed data with an .out suffix in a corresponding subfolder in the + // transformed data with an . out suffix in a corresponding subfolder in the // location in the output prefix. For example, for the input data stored at - // s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores + // s3://bucket-name/input-name-prefix/dataset01/data.csv , batch transform stores // the transformed data at - // s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch + // s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out . Batch // transform doesn't upload partially processed objects. For an input S3 object - // that contains multiple records, it creates an .out file only if the transform + // that contains multiple records, it creates an . out file only if the transform // job succeeds on the entire file. When the input contains multiple S3 objects, // the batch transform job processes the listed S3 objects and uploads only the // output for successfully processed objects. If any object fails in the transform @@ -15153,36 +13382,25 @@ type TransformOutput struct { // Defines how to assemble the results of the transform job as a single S3 object. // Choose a format that is most convenient to you. To concatenate the results in - // binary format, specify None. To add a newline character at the end of every - // transformed record, specify Line. + // binary format, specify None . To add a newline character at the end of every + // transformed record, specify Line . AssembleWith AssemblyType // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key // that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon // S3 server-side encryption. The KmsKeyId can be any of the following formats: - // - // * - // Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias - // - // If you don't provide a - // KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your - // role's account. For more information, see KMS-Managed Encryption Keys - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the - // Amazon Simple Storage Service Developer Guide. The KMS key policy must grant - // permission to the IAM role that you specify in your CreateModel - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) - // request. For more information, see Using Key Policies in Amazon Web Services KMS - // (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the - // Amazon Web Services Key Management Service Developer Guide. + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key + // for Amazon S3 for your role's account. For more information, see KMS-Managed + // Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // in the Amazon Simple Storage Service Developer Guide. The KMS key policy must + // grant permission to the IAM role that you specify in your CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) + // request. For more information, see Using Key Policies in Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) + // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string noSmithyDocumentSerde @@ -15193,15 +13411,15 @@ type TransformOutput struct { type TransformResources struct { // The number of ML compute instances to use in the transform job. The default - // value is 1, and the maximum is 100. For distributed transform jobs, specify a - // value greater than 1. + // value is 1 , and the maximum is 100 . For distributed transform jobs, specify a + // value greater than 1 . // // This member is required. InstanceCount *int32 // The ML compute instance type for the transform job. If you are using built-in // algorithms to transform moderately sized datasets, we recommend using - // ml.m4.xlarge or ml.m5.largeinstance types. + // ml.m4.xlarge or ml.m5.large instance types. // // This member is required. InstanceType TransformInstanceType @@ -15213,24 +13431,15 @@ type TransformResources struct { // Local storage volumes are encrypted using a hardware module on the instance. You // can't request a VolumeKmsKeyId when using an instance type with local storage. // For a list of instance types that support local instance storage, see Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). - // For more information about local instance storage encryption, see SSD Instance - // Store Volumes - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). - // The VolumeKmsKeyId can be any of the following formats: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias name ARN: - // arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + // Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) + // . For more information about local instance storage encryption, see SSD + // Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) + // . The VolumeKmsKeyId can be any of the following formats: + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias VolumeKmsKeyId *string noSmithyDocumentSerde @@ -15239,32 +13448,30 @@ type TransformResources struct { // Describes the S3 data source. type TransformS3DataSource struct { - // If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker + // If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker // uses all objects with the specified key name prefix for batch transform. If you - // choose ManifestFile, S3Uri identifies an object that is a manifest file + // choose ManifestFile , S3Uri identifies an object that is a manifest file // containing a list of object keys that you want Amazon SageMaker to use for batch - // transform. The following values are compatible: ManifestFile, S3Prefix The + // transform. The following values are compatible: ManifestFile , S3Prefix The // following value is not compatible: AugmentedManifestFile // // This member is required. S3DataType S3DataType - // Depending on the value specified for the S3DataType, identifies either a key + // Depending on the value specified for the S3DataType , identifies either a key // name prefix or a manifest. For example: - // - // * A key name prefix might look like - // this: s3://bucketname/exampleprefix. - // - // * A manifest might look like this: - // s3://bucketname/example.manifest The manifest is an S3 object which is a JSON - // file with the following format: [ {"prefix": - // "s3://customer_bucket/some/prefix/"},"relative/path/to/custdata-1","relative/path/custdata-2",..."relative/path/custdata-N"] - // The preceding JSON matches the following S3Uris: - // s3://customer_bucket/some/prefix/relative/path/to/custdata-1s3://customer_bucket/some/prefix/relative/path/custdata-2...s3://customer_bucket/some/prefix/relative/path/custdata-N - // The complete set of S3Uris in this manifest constitutes the input data for the - // channel for this datasource. The object that each S3Uris points to must be - // readable by the IAM role that Amazon SageMaker uses to perform tasks on your - // behalf. + // - A key name prefix might look like this: s3://bucketname/exampleprefix . + // - A manifest might look like this: s3://bucketname/example.manifest The + // manifest is an S3 object which is a JSON file with the following format: [ + // {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", + // "relative/path/custdata-2", ... "relative/path/custdata-N" ] The preceding + // JSON matches the following S3Uris : + // s3://customer_bucket/some/prefix/relative/path/to/custdata-1 + // s3://customer_bucket/some/prefix/relative/path/custdata-2 ... + // s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of + // S3Uris in this manifest constitutes the input data for the channel for this + // datasource. The object that each S3Uris points to must be readable by the IAM + // role that Amazon SageMaker uses to perform tasks on your behalf. // // This member is required. S3Uri *string @@ -15281,8 +13488,8 @@ type Trial struct { // When the trial was created. CreationTime *time.Time - // The name of the trial as displayed. If DisplayName isn't specified, TrialName is - // displayed. + // The name of the trial as displayed. If DisplayName isn't specified, TrialName + // is displayed. DisplayName *string // The name of the experiment the trial is part of. @@ -15404,10 +13611,10 @@ type TrialComponentArtifact struct { // This member is required. Value *string - // The media type of the artifact, which indicates the type of data in the artifact - // file. The media type consists of a type and a subtype concatenated with a slash - // (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies - // the category of the media. The subtype specifies the kind of data. + // The media type of the artifact, which indicates the type of data in the + // artifact file. The media type consists of a type and a subtype concatenated with + // a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type + // specifies the category of the media. The subtype specifies the kind of data. MediaType *string noSmithyDocumentSerde @@ -15545,7 +13752,7 @@ type TrialComponentStatus struct { } // A summary of the properties of a trial component. To get all the properties, -// call the DescribeTrialComponent API and provide the TrialComponentName. +// call the DescribeTrialComponent API and provide the TrialComponentName . type TrialComponentSummary struct { // Who created the trial component. @@ -15571,13 +13778,9 @@ type TrialComponentSummary struct { StartTime *time.Time // The status of the component. States include: - // - // * InProgress - // - // * Completed - // - // * - // Failed + // - InProgress + // - Completed + // - Failed Status *TrialComponentStatus // The Amazon Resource Name (ARN) of the trial component. @@ -15607,14 +13810,14 @@ type TrialSource struct { } // A summary of the properties of a trial. To get the complete set of properties, -// call the DescribeTrial API and provide the TrialName. +// call the DescribeTrial API and provide the TrialName . type TrialSummary struct { // When the trial was created. CreationTime *time.Time - // The name of the trial as displayed. If DisplayName isn't specified, TrialName is - // displayed. + // The name of the trial as displayed. If DisplayName isn't specified, TrialName + // is displayed. DisplayName *string // When the trial was last modified. @@ -15639,8 +13842,8 @@ type TuningJobCompletionCriteria struct { // improve as evaluated against an objective function. BestObjectiveNotImproving *BestObjectiveNotImproving - // A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has - // detected that your model has converged as evaluated against your objective + // A flag to top your hyperparameter tuning job if automatic model tuning (AMT) + // has detected that your model has converged as evaluated against your objective // function. ConvergenceDetected *ConvergenceDetected @@ -15660,63 +13863,48 @@ type TuningJobStepMetaData struct { noSmithyDocumentSerde } -// Provided configuration information for the worker UI for a labeling job. Provide -// either HumanTaskUiArn or UiTemplateS3Uri. For named entity recognition, 3D point -// cloud and video frame labeling jobs, use HumanTaskUiArn. For all other Ground -// Truth built-in task types and custom task types, use UiTemplateS3Uri to specify -// the location of a worker task template in Amazon S3. +// Provided configuration information for the worker UI for a labeling job. +// Provide either HumanTaskUiArn or UiTemplateS3Uri . For named entity recognition, +// 3D point cloud and video frame labeling jobs, use HumanTaskUiArn . For all other +// Ground Truth built-in task types and custom task types, use UiTemplateS3Uri to +// specify the location of a worker task template in Amazon S3. type UiConfig struct { // The ARN of the worker task template used to render the worker UI and tools for // labeling job tasks. Use this parameter when you are creating a labeling job for // named entity recognition, 3D point cloud and video frame labeling jobs. Use your // labeling job task type to select one of the following ARNs and use it with this - // parameter when you create a labeling job. Replace aws-region with the Amazon Web - // Services Region you are creating your labeling job in. For example, replace + // parameter when you create a labeling job. Replace aws-region with the Amazon + // Web Services Region you are creating your labeling job in. For example, replace // aws-region with us-west-1 if you create a labeling job in US West (N. - // California). Named Entity Recognition Use the following HumanTaskUiArn for named - // entity recognition labeling jobs: + // California). Named Entity Recognition Use the following HumanTaskUiArn for + // named entity recognition labeling jobs: // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition - // 3D Point Cloud HumanTaskUiArns Use this HumanTaskUiArn for 3D point cloud object - // detection and 3D point cloud object detection adjustment labeling jobs. - // - // * - // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection - // - // Use - // this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object - // tracking adjustment labeling jobs. - // - // * - // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking - // - // Use - // this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud - // semantic segmentation adjustment labeling jobs. - // - // * - // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation - // - // Video - // Frame HumanTaskUiArns Use this HumanTaskUiArn for video frame object detection - // and video frame object detection adjustment labeling jobs. - // - // * - // arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection - // - // Use - // this HumanTaskUiArn for video frame object tracking and video frame object + // 3D Point Cloud HumanTaskUiArns Use this HumanTaskUiArn for 3D point cloud + // object detection and 3D point cloud object detection adjustment labeling jobs. + // - + // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection + // Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud + // object tracking adjustment labeling jobs. + // - + // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking + // Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point + // cloud semantic segmentation adjustment labeling jobs. + // - + // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation + // Video Frame HumanTaskUiArns Use this HumanTaskUiArn for video frame object + // detection and video frame object detection adjustment labeling jobs. + // - arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection + // Use this HumanTaskUiArn for video frame object tracking and video frame object // tracking adjustment labeling jobs. - // - // * - // arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking + // - arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking HumanTaskUiArn *string // The Amazon S3 bucket location of the UI template, or worker task template. This // is the template used to render the worker UI and tools for labeling job tasks. - // For more information about the contents of a UI template, see Creating Your - // Custom Labeling Task Template - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step2.html). + // For more information about the contents of a UI template, see Creating Your + // Custom Labeling Task Template (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step2.html) + // . UiTemplateS3Uri *string noSmithyDocumentSerde @@ -15804,9 +13992,9 @@ type UserProfileDetails struct { // A collection of settings that apply to users of Amazon SageMaker Studio. These // settings are specified when the CreateUserProfile API is called, and as // DefaultUserSettings when the CreateDomain API is called. SecurityGroups is -// aggregated when specified in both calls. For all other settings in UserSettings, -// the values specified in CreateUserProfile take precedence over those specified -// in CreateDomain. +// aggregated when specified in both calls. For all other settings in UserSettings +// , the values specified in CreateUserProfile take precedence over those +// specified in CreateDomain . type UserSettings struct { // The Canvas app settings. @@ -15829,9 +14017,9 @@ type UserSettings struct { RStudioServerProAppSettings *RStudioServerProAppSettings // The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses - // for communication. Optional when the CreateDomain.AppNetworkAccessType parameter - // is set to PublicInternetOnly. Required when the - // CreateDomain.AppNetworkAccessType parameter is set to VpcOnly. Amazon SageMaker + // for communication. Optional when the CreateDomain.AppNetworkAccessType + // parameter is set to PublicInternetOnly . Required when the + // CreateDomain.AppNetworkAccessType parameter is set to VpcOnly . Amazon SageMaker // adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the // number of security groups that you can specify is one less than the maximum // number shown. @@ -15848,24 +14036,19 @@ type UserSettings struct { // Specifies a production variant property type for an Endpoint. If you are // updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties -// option set to true, the VariantProperty objects listed in +// option set to true , the VariantProperty objects listed in // UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing // variant properties of the endpoint. type VariantProperty struct { // The type of variant property. The supported values are: - // - // * DesiredInstanceCount: - // Overrides the existing variant instance counts using the - // ProductionVariant$InitialInstanceCount values in the - // CreateEndpointConfigInput$ProductionVariants. - // - // * DesiredWeight: Overrides the - // existing variant weights using the ProductionVariant$InitialVariantWeight values - // in the CreateEndpointConfigInput$ProductionVariants. - // - // * DataCaptureConfig: (Not - // currently supported.) + // - DesiredInstanceCount : Overrides the existing variant instance counts using + // the ProductionVariant$InitialInstanceCount values in the + // CreateEndpointConfigInput$ProductionVariants . + // - DesiredWeight : Overrides the existing variant weights using the + // ProductionVariant$InitialVariantWeight values in the + // CreateEndpointConfigInput$ProductionVariants . + // - DataCaptureConfig : (Not currently supported.) // // This member is required. VariantPropertyType VariantPropertyType @@ -15882,8 +14065,8 @@ type Vertex struct { // The type of resource of the lineage entity. LineageType LineageType - // The type of the lineage entity resource. For example: DataSet, Model, Endpoint, - // etc... + // The type of the lineage entity resource. For example: DataSet , Model , Endpoint + // , etc... Type *string noSmithyDocumentSerde @@ -15893,20 +14076,20 @@ type Vertex struct { // Control access to and from your training and model containers by configuring the // VPC. For more information, see Protect Endpoints by Using an Amazon Virtual // Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) -// and Protect Training Jobs by Using an Amazon Virtual Private Cloud -// (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). +// and Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) +// . type VpcConfig struct { - // The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups - // for the VPC that is specified in the Subnets field. + // The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security + // groups for the VPC that is specified in the Subnets field. // // This member is required. SecurityGroupIds []string // The ID of the subnets in the VPC to which you want to connect your training job // or model. For information about the availability of specific instance types, see - // Supported Instance Types and Availability Zones - // (https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html). + // Supported Instance Types and Availability Zones (https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) + // . // // This member is required. Subnets []string @@ -15918,28 +14101,21 @@ type VpcConfig struct { type WarmPoolStatus struct { // The status of the warm pool. - // - // * InUse: The warm pool is in use for the training - // job. - // - // * Available: The warm pool is available to reuse for a matching training - // job. - // - // * Reused: The warm pool moved to a matching training job for reuse. - // - // * - // Terminated: The warm pool is no longer available. Warm pools are unavailable if - // they are terminated by a user, terminated for a patch update, or terminated for - // exceeding the specified KeepAlivePeriodInSeconds. + // - InUse : The warm pool is in use for the training job. + // - Available : The warm pool is available to reuse for a matching training job. + // - Reused : The warm pool moved to a matching training job for reuse. + // - Terminated : The warm pool is no longer available. Warm pools are + // unavailable if they are terminated by a user, terminated for a patch update, or + // terminated for exceeding the specified KeepAlivePeriodInSeconds . // // This member is required. Status WarmPoolResourceStatus // The billable time in seconds used by the warm pool. Billable time refers to the // absolute wall-clock time. Multiply ResourceRetainedBillableTimeInSeconds by the - // number of instances (InstanceCount) in your training cluster to get the total + // number of instances ( InstanceCount ) in your training cluster to get the total // compute time SageMaker bills you if you run warm pool training. The formula is - // as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount. + // as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount . ResourceRetainedBillableTimeInSeconds *int32 // The name of the matching training job that reused the warm pool. @@ -15952,8 +14128,8 @@ type WarmPoolStatus struct { // first private work team. You can create one private work force in each Amazon // Web Services Region. By default, any workforce-related API operation used in a // specific region will apply to the workforce created in that region. To learn how -// to create a private workforce, see Create a Private Workforce -// (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html). +// to create a private workforce, see Create a Private Workforce (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html) +// . type Workforce struct { // The Amazon Resource Name (ARN) of the private workforce. @@ -15967,8 +14143,8 @@ type Workforce struct { WorkforceName *string // The configuration of an Amazon Cognito workforce. A single Cognito workforce is - // created using and corresponds to a single Amazon Cognito user pool - // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html). + // created using and corresponds to a single Amazon Cognito user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) + // . CognitoConfig *CognitoConfig // The date that the workforce is created. @@ -15978,18 +14154,16 @@ type Workforce struct { FailureReason *string // The most recent date that was used to successfully add one or more IP address - // ranges (CIDRs - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to a - // private workforce's allow list. + // ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // ) to a private workforce's allow list. LastUpdatedDate *time.Time // The configuration of an OIDC Identity Provider (IdP) private workforce. OidcConfig *OidcConfigForResponse - // A list of one to ten IP address ranges (CIDRs - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)) to be added - // to the workforce allow list. By default, a workforce isn't restricted to - // specific IP addresses. + // A list of one to ten IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) + // ) to be added to the workforce allow list. By default, a workforce isn't + // restricted to specific IP addresses. SourceIpConfig *SourceIpConfig // The status of your workforce. @@ -16007,8 +14181,8 @@ type Workforce struct { // The VPC object you use to create or update a workforce. type WorkforceVpcConfigRequest struct { - // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - // for the same VPC as specified in the subnet. + // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must + // be for the same VPC as specified in the subnet. SecurityGroupIds []string // The ID of the subnets in the VPC that you want to connect. @@ -16024,8 +14198,8 @@ type WorkforceVpcConfigRequest struct { // connect to. type WorkforceVpcConfigResponse struct { - // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be - // for the same VPC as specified in the subnet. + // The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must + // be for the same VPC as specified in the subnet. // // This member is required. SecurityGroupIds []string @@ -16058,8 +14232,8 @@ type Workteam struct { // A list of MemberDefinition objects that contains objects that identify the // workers that make up the work team. Workforces can be created using Amazon // Cognito or your own OIDC Identity Provider (IdP). For private workforces created - // using Amazon Cognito use CognitoMemberDefinition. For workforces created using - // your own OIDC identity provider (IdP) use OidcMemberDefinition. + // using Amazon Cognito use CognitoMemberDefinition . For workforces created using + // your own OIDC identity provider (IdP) use OidcMemberDefinition . // // This member is required. MemberDefinitions []MemberDefinition diff --git a/service/sagemakera2iruntime/api_client.go b/service/sagemakera2iruntime/api_client.go index deb0621b0e0..69c8745d9f3 100644 --- a/service/sagemakera2iruntime/api_client.go +++ b/service/sagemakera2iruntime/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go b/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go index a1e0b2ea45a..8110699431f 100644 --- a/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go @@ -11,7 +11,7 @@ import ( ) // Deletes the specified human loop for a flow definition. If the human loop was -// deleted, this operation will return a ResourceNotFoundException. +// deleted, this operation will return a ResourceNotFoundException . func (c *Client) DeleteHumanLoop(ctx context.Context, params *DeleteHumanLoopInput, optFns ...func(*Options)) (*DeleteHumanLoopOutput, error) { if params == nil { params = &DeleteHumanLoopInput{} diff --git a/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go b/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go index 1d0b2cf9817..4f5475c8fc3 100644 --- a/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go @@ -56,9 +56,9 @@ type DescribeHumanLoopOutput struct { // This member is required. HumanLoopArn *string - // The name of the human loop. The name must be lowercase, unique within the Region - // in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, - // and - (hyphen). + // The name of the human loop. The name must be lowercase, unique within the + // Region in your account, and can have up to 63 characters. Valid characters: a-z, + // 0-9, and - (hyphen). // // This member is required. HumanLoopName *string @@ -69,11 +69,11 @@ type DescribeHumanLoopOutput struct { HumanLoopStatus types.HumanLoopStatus // A failure code that identifies the type of failure. Possible values: - // ValidationError, Expired, InternalError + // ValidationError , Expired , InternalError FailureCode *string // The reason why a human loop failed. The failure reason is returned when the - // status of the human loop is Failed. + // status of the human loop is Failed . FailureReason *string // An object that contains information about the output of the human loop. diff --git a/service/sagemakera2iruntime/api_op_ListHumanLoops.go b/service/sagemakera2iruntime/api_op_ListHumanLoops.go index 250da42cbb8..dbd2f7cbdf8 100644 --- a/service/sagemakera2iruntime/api_op_ListHumanLoops.go +++ b/service/sagemakera2iruntime/api_op_ListHumanLoops.go @@ -38,23 +38,23 @@ type ListHumanLoopsInput struct { FlowDefinitionArn *string // (Optional) The timestamp of the date when you want the human loops to begin in - // ISO 8601 format. For example, 2020-02-24. + // ISO 8601 format. For example, 2020-02-24 . CreationTimeAfter *time.Time // (Optional) The timestamp of the date before which you want the human loops to - // begin in ISO 8601 format. For example, 2020-02-24. + // begin in ISO 8601 format. For example, 2020-02-24 . CreationTimeBefore *time.Time // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken is returned in the - // output. You can use this token to display the next page of results. + // more than the value specified in MaxResults , then a NextToken is returned in + // the output. You can use this token to display the next page of results. MaxResults *int32 // A token to display the next page of results. NextToken *string // Optional. The order for displaying results. Valid values: Ascending and - // Descending. + // Descending . SortOrder types.SortOrder noSmithyDocumentSerde @@ -150,8 +150,8 @@ var _ ListHumanLoopsAPIClient = (*Client)(nil) // ListHumanLoopsPaginatorOptions is the paginator options for ListHumanLoops type ListHumanLoopsPaginatorOptions struct { // The total number of items to return. If the total number of available items is - // more than the value specified in MaxResults, then a NextToken is returned in the - // output. You can use this token to display the next page of results. + // more than the value specified in MaxResults , then a NextToken is returned in + // the output. You can use this token to display the next page of results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemakera2iruntime/api_op_StartHumanLoop.go b/service/sagemakera2iruntime/api_op_StartHumanLoop.go index c7c6af2023a..aaf2d2b71ad 100644 --- a/service/sagemakera2iruntime/api_op_StartHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_StartHumanLoop.go @@ -29,8 +29,8 @@ func (c *Client) StartHumanLoop(ctx context.Context, params *StartHumanLoopInput type StartHumanLoopInput struct { - // The Amazon Resource Name (ARN) of the flow definition associated with this human - // loop. + // The Amazon Resource Name (ARN) of the flow definition associated with this + // human loop. // // This member is required. FlowDefinitionArn *string diff --git a/service/sagemakera2iruntime/doc.go b/service/sagemakera2iruntime/doc.go index 80591d9315d..0593e05e904 100644 --- a/service/sagemakera2iruntime/doc.go +++ b/service/sagemakera2iruntime/doc.go @@ -9,32 +9,23 @@ // called a human review workflow. To create and start a human review workflow, you // need three resources: a worker task template, a flow definition, and a human // loop. For information about these resources and prerequisites for using Amazon -// A2I, see Get Started with Amazon Augmented AI -// (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html) in -// the Amazon SageMaker Developer Guide. This API reference includes information +// A2I, see Get Started with Amazon Augmented AI (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html) +// in the Amazon SageMaker Developer Guide. This API reference includes information // about API actions and data types that you can use to interact with Amazon A2I // programmatically. Use this guide to: +// - Start a human loop with the StartHumanLoop operation when using Amazon A2I +// with a custom task type. To learn more about the difference between custom and +// built-in task types, see Use Task Types (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html) +// . To learn how to start a human loop using this API, see Create and Start a +// Human Loop for a Custom Task Type (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop) +// in the Amazon SageMaker Developer Guide. +// - Manage your human loops. You can list all human loops that you have +// created, describe individual human loops, and stop and delete human loops. To +// learn more, see Monitor and Manage Your Human Loop (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html) +// in the Amazon SageMaker Developer Guide. // -// * Start a human loop with the -// StartHumanLoop operation when using Amazon A2I with a custom task type. To learn -// more about the difference between custom and built-in task types, see Use Task -// Types -// (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html). -// To learn how to start a human loop using this API, see Create and Start a Human -// Loop for a Custom Task Type -// (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop) +// Amazon A2I integrates APIs from various AWS services to create and start human +// review workflows for those services. To learn how Amazon A2I uses these APIs, +// see Use APIs in Amazon A2I (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html) // in the Amazon SageMaker Developer Guide. -// -// * Manage your human loops. You can -// list all human loops that you have created, describe individual human loops, and -// stop and delete human loops. To learn more, see Monitor and Manage Your Human -// Loop -// (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html) -// in the Amazon SageMaker Developer Guide. -// -// Amazon A2I integrates APIs from -// various AWS services to create and start human review workflows for those -// services. To learn how Amazon A2I uses these APIs, see Use APIs in Amazon A2I -// (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html) in the -// Amazon SageMaker Developer Guide. package sagemakera2iruntime diff --git a/service/sagemakera2iruntime/types/enums.go b/service/sagemakera2iruntime/types/enums.go index 0947a887ee7..52c0572df70 100644 --- a/service/sagemakera2iruntime/types/enums.go +++ b/service/sagemakera2iruntime/types/enums.go @@ -52,9 +52,9 @@ const ( SortOrderDescending SortOrder = "Descending" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "Ascending", diff --git a/service/sagemakera2iruntime/types/errors.go b/service/sagemakera2iruntime/types/errors.go index 5b09ad8f2d7..67ce0ce5557 100644 --- a/service/sagemakera2iruntime/types/errors.go +++ b/service/sagemakera2iruntime/types/errors.go @@ -89,15 +89,13 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You exceeded your service quota. Service quotas, also referred to as limits, are -// the maximum number of service resources or operations for your AWS account. For -// a list of Amazon A2I service quotes, see Amazon Augmented AI Service Quotes -// (https://docs.aws.amazon.com/general/latest/gr/a2i.html). Delete some resources -// or request an increase in your service quota. You can request a quota increase -// using Service Quotas or the AWS Support Center. To request an increase, see AWS -// Service Quotas -// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) in the -// AWS General Reference. +// You exceeded your service quota. Service quotas, also referred to as limits, +// are the maximum number of service resources or operations for your AWS account. +// For a list of Amazon A2I service quotes, see Amazon Augmented AI Service Quotes (https://docs.aws.amazon.com/general/latest/gr/a2i.html) +// . Delete some resources or request an increase in your service quota. You can +// request a quota increase using Service Quotas or the AWS Support Center. To +// request an increase, see AWS Service Quotas (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) +// in the AWS General Reference. type ServiceQuotaExceededException struct { Message *string diff --git a/service/sagemakera2iruntime/types/types.go b/service/sagemakera2iruntime/types/types.go index 87550e9e55e..f12fdb302ad 100644 --- a/service/sagemakera2iruntime/types/types.go +++ b/service/sagemakera2iruntime/types/types.go @@ -7,8 +7,8 @@ import ( "time" ) -// Attributes of the data specified by the customer. Use these to describe the data -// to be labeled. +// Attributes of the data specified by the customer. Use these to describe the +// data to be labeled. type HumanLoopDataAttributes struct { // Declares that your content is free of personally identifiable information or @@ -36,8 +36,8 @@ type HumanLoopInput struct { // Information about where the human output will be stored. type HumanLoopOutput struct { - // The location of the Amazon S3 object where Amazon Augmented AI stores your human - // loop output. + // The location of the Amazon S3 object where Amazon Augmented AI stores your + // human loop output. // // This member is required. OutputS3Uri *string @@ -52,7 +52,7 @@ type HumanLoopSummary struct { CreationTime *time.Time // The reason why the human loop failed. A failure reason is returned when the - // status of the human loop is Failed. + // status of the human loop is Failed . FailureReason *string // The Amazon Resource Name (ARN) of the flow definition used to configure the diff --git a/service/sagemakeredge/api_client.go b/service/sagemakeredge/api_client.go index d8075a917e0..8eab1572ba9 100644 --- a/service/sagemakeredge/api_client.go +++ b/service/sagemakeredge/api_client.go @@ -24,8 +24,8 @@ import ( const ServiceID = "Sagemaker Edge" const ServiceAPIVersion = "2020-09-23" -// Client provides the API client to make operations call for Amazon Sagemaker Edge -// Manager. +// Client provides the API client to make operations call for Amazon Sagemaker +// Edge Manager. type Client struct { options Options } @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakeredge/types/enums.go b/service/sagemakeredge/types/enums.go index 1bd0485f8e7..a9b64a6e4c0 100644 --- a/service/sagemakeredge/types/enums.go +++ b/service/sagemakeredge/types/enums.go @@ -9,9 +9,9 @@ const ( ChecksumTypeSha1 ChecksumType = "SHA1" ) -// Values returns all known values for ChecksumType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChecksumType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChecksumType) Values() []ChecksumType { return []ChecksumType{ "SHA1", @@ -60,8 +60,8 @@ const ( FailureHandlingPolicyDoNothing FailureHandlingPolicy = "DO_NOTHING" ) -// Values returns all known values for FailureHandlingPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for FailureHandlingPolicy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (FailureHandlingPolicy) Values() []FailureHandlingPolicy { return []FailureHandlingPolicy{ diff --git a/service/sagemakeredge/types/types.go b/service/sagemakeredge/types/types.go index 40cbe6f6862..22102ed70b5 100644 --- a/service/sagemakeredge/types/types.go +++ b/service/sagemakeredge/types/types.go @@ -69,8 +69,8 @@ type DeploymentModel struct { // registered with SageMaker Edge Manager. type DeploymentResult struct { - // The timestamp of when the deployment was ended, and the agent got the deployment - // results. + // The timestamp of when the deployment was ended, and the agent got the + // deployment results. DeploymentEndTime *time.Time // Returns a list of models deployed on the agent. diff --git a/service/sagemakerfeaturestoreruntime/api_client.go b/service/sagemakerfeaturestoreruntime/api_client.go index c584d02e3b0..b33e8f80ff5 100644 --- a/service/sagemakerfeaturestoreruntime/api_client.go +++ b/service/sagemakerfeaturestoreruntime/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakerfeaturestoreruntime/api_op_BatchGetRecord.go b/service/sagemakerfeaturestoreruntime/api_op_BatchGetRecord.go index 3931f3b0d89..22c91a715cf 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_BatchGetRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_BatchGetRecord.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a batch of Records from a FeatureGroup. +// Retrieves a batch of Records from a FeatureGroup . func (c *Client) BatchGetRecord(ctx context.Context, params *BatchGetRecordInput, optFns ...func(*Options)) (*BatchGetRecordOutput, error) { if params == nil { params = &BatchGetRecordInput{} diff --git a/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go b/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go index e079c5ec59b..58a128acdd1 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go @@ -11,24 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports -// both SOFT_DELETE and HARD_DELETE. For SOFT_DELETE (default), feature columns are -// set to null and the record is no longer retrievable by GetRecord or -// BatchGetRecord. For HARD_DELETE, the complete Record is removed from the -// OnlineStore. In both cases, Feature Store appends the deleted record marker to -// the OfflineStore with feature values set to null, is_deleted value set to True, -// and EventTime set to the delete input EventTime. Note that the EventTime -// specified in DeleteRecord should be set later than the EventTime of the existing -// record in the OnlineStore for that RecordIdentifer. If it is not, the deletion -// does not occur: -// -// * For SOFT_DELETE, the existing (undeleted) record remains in -// the OnlineStore, though the delete record marker is still written to the -// OfflineStore. -// -// * HARD_DELETE returns EventTime: 400 ValidationException to -// indicate that the delete operation failed. No delete record marker is written to -// the OfflineStore. +// Deletes a Record from a FeatureGroup in the OnlineStore . Feature Store supports +// both SOFT_DELETE and HARD_DELETE . For SOFT_DELETE (default), feature columns +// are set to null and the record is no longer retrievable by GetRecord or +// BatchGetRecord . For HARD_DELETE , the complete Record is removed from the +// OnlineStore . In both cases, Feature Store appends the deleted record marker to +// the OfflineStore with feature values set to null , is_deleted value set to True +// , and EventTime set to the delete input EventTime . Note that the EventTime +// specified in DeleteRecord should be set later than the EventTime of the +// existing record in the OnlineStore for that RecordIdentifer . If it is not, the +// deletion does not occur: +// - For SOFT_DELETE , the existing (undeleted) record remains in the OnlineStore +// , though the delete record marker is still written to the OfflineStore . +// - HARD_DELETE returns EventTime : 400 ValidationException to indicate that the +// delete operation failed. No delete record marker is written to the +// OfflineStore . func (c *Client) DeleteRecord(ctx context.Context, params *DeleteRecordInput, optFns ...func(*Options)) (*DeleteRecordOutput, error) { if params == nil { params = &DeleteRecordInput{} @@ -64,12 +61,12 @@ type DeleteRecordInput struct { RecordIdentifierValueAsString *string // The name of the deletion mode for deleting the record. By default, the deletion - // mode is set to SoftDelete. + // mode is set to SoftDelete . DeletionMode types.DeletionMode // A list of stores from which you're deleting the record. By default, Feature // Store deletes the record from all of the stores that you're using for the - // FeatureGroup. + // FeatureGroup . TargetStores []types.TargetStore noSmithyDocumentSerde diff --git a/service/sagemakerfeaturestoreruntime/api_op_GetRecord.go b/service/sagemakerfeaturestoreruntime/api_op_GetRecord.go index e2620ed6327..7ea75c4ed3f 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_GetRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_GetRecord.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use for OnlineStore serving from a FeatureStore. Only the latest records stored +// Use for OnlineStore serving from a FeatureStore . Only the latest records stored // in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is // found, then an empty result is returned. func (c *Client) GetRecord(ctx context.Context, params *GetRecordInput, optFns ...func(*Options)) (*GetRecordOutput, error) { @@ -37,7 +37,7 @@ type GetRecordInput struct { FeatureGroupName *string // The value that corresponds to RecordIdentifier type and uniquely identifies the - // record in the FeatureGroup. + // record in the FeatureGroup . // // This member is required. RecordIdentifierValueAsString *string @@ -51,7 +51,7 @@ type GetRecordInput struct { type GetRecordOutput struct { - // The record you requested. A list of FeatureValues. + // The record you requested. A list of FeatureValues . Record []types.FeatureValue // Metadata pertaining to the operation's result. diff --git a/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go b/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go index 924ab5eb134..3fd85e556f8 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used for data ingestion into the FeatureStore. The PutRecord API writes to both -// the OnlineStore and OfflineStore. If the record is the latest record for the -// recordIdentifier, the record is written to both the OnlineStore and -// OfflineStore. If the record is a historic record, it is written only to the -// OfflineStore. +// Used for data ingestion into the FeatureStore . The PutRecord API writes to +// both the OnlineStore and OfflineStore . If the record is the latest record for +// the recordIdentifier , the record is written to both the OnlineStore and +// OfflineStore . If the record is a historic record, it is written only to the +// OfflineStore . func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns ...func(*Options)) (*PutRecordOutput, error) { if params == nil { params = &PutRecordInput{} @@ -40,20 +40,15 @@ type PutRecordInput struct { // List of FeatureValues to be inserted. This will be a full over-write. If you // only want to update few of the feature values, do the following: - // - // * Use - // GetRecord to retrieve the latest record. - // - // * Update the record returned from - // GetRecord. - // - // * Use PutRecord to update feature values. + // - Use GetRecord to retrieve the latest record. + // - Update the record returned from GetRecord . + // - Use PutRecord to update feature values. // // This member is required. Record []types.FeatureValue // A list of stores to which you're adding the record. By default, Feature Store - // adds the record to all of the stores that you're using for the FeatureGroup. + // adds the record to all of the stores that you're using for the FeatureGroup . TargetStores []types.TargetStore noSmithyDocumentSerde diff --git a/service/sagemakerfeaturestoreruntime/doc.go b/service/sagemakerfeaturestoreruntime/doc.go index 337161afa55..48a222daa95 100644 --- a/service/sagemakerfeaturestoreruntime/doc.go +++ b/service/sagemakerfeaturestoreruntime/doc.go @@ -7,20 +7,8 @@ // Feature Store. Use this API to put, delete, and retrieve (get) features from a // feature store. Use the following operations to configure your OnlineStore and // OfflineStore features, and to create and manage feature groups: -// -// * -// CreateFeatureGroup -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFeatureGroup.html) -// -// * -// DeleteFeatureGroup -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteFeatureGroup.html) -// -// * -// DescribeFeatureGroup -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeFeatureGroup.html) -// -// * -// ListFeatureGroups -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListFeatureGroups.html) +// - CreateFeatureGroup (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFeatureGroup.html) +// - DeleteFeatureGroup (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteFeatureGroup.html) +// - DescribeFeatureGroup (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeFeatureGroup.html) +// - ListFeatureGroups (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListFeatureGroups.html) package sagemakerfeaturestoreruntime diff --git a/service/sagemakerfeaturestoreruntime/types/enums.go b/service/sagemakerfeaturestoreruntime/types/enums.go index 09dd3360c20..7f3df1e67b7 100644 --- a/service/sagemakerfeaturestoreruntime/types/enums.go +++ b/service/sagemakerfeaturestoreruntime/types/enums.go @@ -10,9 +10,9 @@ const ( DeletionModeHardDelete DeletionMode = "HardDelete" ) -// Values returns all known values for DeletionMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeletionMode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DeletionMode) Values() []DeletionMode { return []DeletionMode{ "SoftDelete", diff --git a/service/sagemakerfeaturestoreruntime/types/types.go b/service/sagemakerfeaturestoreruntime/types/types.go index 522902d7d13..cb3327e883c 100644 --- a/service/sagemakerfeaturestoreruntime/types/types.go +++ b/service/sagemakerfeaturestoreruntime/types/types.go @@ -9,9 +9,9 @@ import ( // The error that has occurred when attempting to retrieve a batch of Records. type BatchGetRecordError struct { - // The error code of an error that has occurred when attempting to retrieve a batch - // of Records. For more information on errors, see Errors - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors). + // The error code of an error that has occurred when attempting to retrieve a + // batch of Records. For more information on errors, see Errors (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors) + // . // // This member is required. ErrorCode *string diff --git a/service/sagemakergeospatial/api_client.go b/service/sagemakergeospatial/api_client.go index 4693d2285de..9b446c8897b 100644 --- a/service/sagemakergeospatial/api_client.go +++ b/service/sagemakergeospatial/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go b/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go index 37da6ba611c..df99be72282 100644 --- a/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go +++ b/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you run image query on a specific raster data collection to get a list of -// the satellite imagery matching the selected filters. +// Allows you run image query on a specific raster data collection to get a list +// of the satellite imagery matching the selected filters. func (c *Client) SearchRasterDataCollection(ctx context.Context, params *SearchRasterDataCollectionInput, optFns ...func(*Options)) (*SearchRasterDataCollectionOutput, error) { if params == nil { params = &SearchRasterDataCollectionInput{} @@ -36,14 +36,11 @@ type SearchRasterDataCollectionInput struct { // This member is required. Arn *string - // RasterDataCollectionQuery consisting of AreaOfInterest(AOI) - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html), - // PropertyFilters - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html) - // and TimeRangeFilterInput - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html) - // used in SearchRasterDataCollection - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_SearchRasterDataCollection.html). + // RasterDataCollectionQuery consisting of AreaOfInterest(AOI) (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html) + // , PropertyFilters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html) + // and TimeRangeFilterInput (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html) + // used in SearchRasterDataCollection (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_SearchRasterDataCollection.html) + // . // // This member is required. RasterDataCollectionQuery *types.RasterDataCollectionQueryWithBandFilterInput diff --git a/service/sagemakergeospatial/types/enums.go b/service/sagemakergeospatial/types/enums.go index 8c8865cc54d..de4d7aaa8d7 100644 --- a/service/sagemakergeospatial/types/enums.go +++ b/service/sagemakergeospatial/types/enums.go @@ -187,9 +187,10 @@ const ( EarthObservationJobErrorTypeServerError EarthObservationJobErrorType = "SERVER_ERROR" ) -// Values returns all known values for EarthObservationJobErrorType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for EarthObservationJobErrorType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (EarthObservationJobErrorType) Values() []EarthObservationJobErrorType { return []EarthObservationJobErrorType{ "CLIENT_ERROR", @@ -395,9 +396,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -492,9 +493,10 @@ const ( VectorEnrichmentJobErrorTypeServerError VectorEnrichmentJobErrorType = "SERVER_ERROR" ) -// Values returns all known values for VectorEnrichmentJobErrorType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for VectorEnrichmentJobErrorType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (VectorEnrichmentJobErrorType) Values() []VectorEnrichmentJobErrorType { return []VectorEnrichmentJobErrorType{ "CLIENT_ERROR", diff --git a/service/sagemakergeospatial/types/types.go b/service/sagemakergeospatial/types/types.go index f5b52339978..076b5a7ab13 100644 --- a/service/sagemakergeospatial/types/types.go +++ b/service/sagemakergeospatial/types/types.go @@ -69,8 +69,8 @@ type BandMathConfigInput struct { // CustomIndices that are computed. CustomIndices *CustomIndicesInput - // One or many of the supported predefined indices to compute. Allowed values: - // NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI. + // One or many of the supported predefined indices to compute. Allowed values: NDVI + // , EVI2 , MSAVI , NDWI , NDMI , NDSI , and WDRVI . PredefinedIndices []string noSmithyDocumentSerde @@ -143,8 +143,8 @@ type EojDataSourceConfigInput interface { isEojDataSourceConfigInput() } -// The input structure for S3Data; representing the Amazon S3 location of the input -// data objects. +// The input structure for S3Data; representing the Amazon S3 location of the +// input data objects. type EojDataSourceConfigInputMemberS3Data struct { Value S3DataInput @@ -269,8 +269,8 @@ type InputConfigInput struct { // The Amazon Resource Name (ARN) of the previous Earth Observation job. PreviousEarthObservationJobArn *string - // The structure representing the RasterDataCollection Query consisting of the Area - // of Interest, RasterDataCollectionArn,TimeRange and Property Filters. + // The structure representing the RasterDataCollection Query consisting of the + // Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters. RasterDataCollectionQuery *RasterDataCollectionQueryInput noSmithyDocumentSerde @@ -285,9 +285,9 @@ type InputConfigOutput struct { // The Amazon Resource Name (ARN) of the previous Earth Observation job. PreviousEarthObservationJobArn *string - // The structure representing the RasterDataCollection Query consisting of the Area - // of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and - // Property Filters. + // The structure representing the RasterDataCollection Query consisting of the + // Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, + // and Property Filters. RasterDataCollectionQuery *RasterDataCollectionQueryOutput noSmithyDocumentSerde @@ -553,8 +553,8 @@ type MapMatchingConfig struct { noSmithyDocumentSerde } -// The structure representing Polygon Geometry based on the GeoJson spec -// (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6). +// The structure representing Polygon Geometry based on the GeoJson spec (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6) +// . type MultiPolygonGeometryInput struct { // The coordinates of the multipolygon geometry. @@ -630,7 +630,7 @@ type OutputResolutionResamplingInput struct { type OutputResolutionStackInput struct { // A string value representing Predefined Output Resolution for a stacking - // operation. Allowed values are HIGHEST, LOWEST, and AVERAGE. + // operation. Allowed values are HIGHEST , LOWEST , and AVERAGE . Predefined PredefinedResolution // The structure representing User Output Resolution for a Stacking operation @@ -656,12 +656,12 @@ type PlatformInput struct { noSmithyDocumentSerde } -// The structure representing Polygon Geometry based on the GeoJson spec -// (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6). +// The structure representing Polygon Geometry based on the GeoJson spec (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6) +// . type PolygonGeometryInput struct { - // Coordinates representing a Polygon based on the GeoJson spec - // (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6). + // Coordinates representing a Polygon based on the GeoJson spec (https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6) + // . // // This member is required. Coordinates [][][]float64 @@ -691,11 +691,11 @@ type Properties struct { // angle between truth north and the sun. Measured clockwise in degrees (0-360). ViewSunAzimuth *float32 - // The sun elevation angle. The angle from the tangent of the scene center point to - // the sun. Measured from the horizon in degrees (-90-90). Negative values indicate - // the sun is below the horizon, e.g. sun elevation of -10° means the data was - // captured during nautical twilight - // (https://www.timeanddate.com/astronomy/different-types-twilight.html). + // The sun elevation angle. The angle from the tangent of the scene center point + // to the sun. Measured from the horizon in degrees (-90-90). Negative values + // indicate the sun is below the horizon, e.g. sun elevation of -10° means the data + // was captured during nautical twilight (https://www.timeanddate.com/astronomy/different-types-twilight.html) + // . ViewSunElevation *float32 noSmithyDocumentSerde @@ -715,8 +715,8 @@ type Property interface { isProperty() } -// The structure representing EoCloudCover property filter containing a lower bound -// and upper bound. +// The structure representing EoCloudCover property filter containing a lower +// bound and upper bound. type PropertyMemberEoCloudCover struct { Value EoCloudCoverInput @@ -745,8 +745,8 @@ type PropertyMemberPlatform struct { func (*PropertyMemberPlatform) isProperty() {} -// The structure representing ViewOffNadir property filter containing a lower bound -// and upper bound. +// The structure representing ViewOffNadir property filter containing a lower +// bound and upper bound. type PropertyMemberViewOffNadir struct { Value ViewOffNadirInput @@ -920,8 +920,8 @@ type ResamplingConfigInput struct { // The name of the algorithm used for resampling. AlgorithmName AlgorithmNameResampling - // Bands used in the operation. If no target bands are specified, it uses all bands - // available in the input. + // Bands used in the operation. If no target bands are specified, it uses all + // bands available in the input. TargetBands []string noSmithyDocumentSerde @@ -930,8 +930,8 @@ type ResamplingConfigInput struct { // The input structure for Reverse Geocoding operation type. type ReverseGeocodingConfig struct { - // The field name for the data that describes x-axis coordinate, eg. longitude of a - // point. + // The field name for the data that describes x-axis coordinate, eg. longitude of + // a point. // // This member is required. XAttributeName *string @@ -1222,8 +1222,8 @@ type ZonalStatisticsConfigInput struct { // This member is required. ZoneS3Path *string - // Bands used in the operation. If no target bands are specified, it uses all bands - // available input. + // Bands used in the operation. If no target bands are specified, it uses all + // bands available input. TargetBands []string // The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management @@ -1231,16 +1231,10 @@ type ZonalStatisticsConfigInput struct { // output artifacts with Amazon S3 server-side encryption. The SageMaker execution // role must have kms:GenerateDataKey permission. The KmsKeyId can be any of the // following formats: - // - // * // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" - // - // * // - // Amazon Resource Name (ARN) of a KMS Key - // "arn:aws:kms:::key/" - // - // For - // more information about key identifiers, see Key identifiers (KeyID) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) + // - // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" + // - // Amazon Resource Name (ARN) of a KMS Key + // "arn:aws:kms:::key/" + // For more information about key identifiers, see Key identifiers (KeyID) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) // in the Amazon Web Services Key Management Service (Amazon Web Services KMS) // documentation. ZoneS3PathKmsKeyId *string diff --git a/service/sagemakermetrics/api_client.go b/service/sagemakermetrics/api_client.go index f55be9969a6..a8465bd7084 100644 --- a/service/sagemakermetrics/api_client.go +++ b/service/sagemakermetrics/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakermetrics/doc.go b/service/sagemakermetrics/doc.go index c4fdbf15d85..348b164e6cb 100644 --- a/service/sagemakermetrics/doc.go +++ b/service/sagemakermetrics/doc.go @@ -6,7 +6,5 @@ // Contains all data plane API operations and data types for Amazon SageMaker // Metrics. Use these APIs to put and retrieve (get) features related to your // training run. -// -// * BatchPutMetrics -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_metrics_BatchPutMetrics.html) +// - BatchPutMetrics (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_metrics_BatchPutMetrics.html) package sagemakermetrics diff --git a/service/sagemakermetrics/types/types.go b/service/sagemakermetrics/types/types.go index 9f2b49c076f..0c2e4313250 100644 --- a/service/sagemakermetrics/types/types.go +++ b/service/sagemakermetrics/types/types.go @@ -11,18 +11,12 @@ import ( type BatchPutMetricsError struct { // The error code of an error that occured when attempting to put metrics. - // - // * - // METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is - // exceeded. - // - // * INTERNAL_ERROR: An internal error occured. - // - // * VALIDATION_ERROR: The - // metric data failed validation. - // - // * CONFLICT_ERROR: Multiple requests attempted to - // modify the same data simultaneously. + // - METRIC_LIMIT_EXCEEDED : The maximum amount of metrics per resource is + // exceeded. + // - INTERNAL_ERROR : An internal error occured. + // - VALIDATION_ERROR : The metric data failed validation. + // - CONFLICT_ERROR : Multiple requests attempted to modify the same data + // simultaneously. Code PutMetricsErrorCode // An index that corresponds to the metric in the request. diff --git a/service/sagemakerruntime/api_client.go b/service/sagemakerruntime/api_client.go index 5444ee15e3f..886f7068039 100644 --- a/service/sagemakerruntime/api_client.go +++ b/service/sagemakerruntime/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sagemakerruntime/api_op_InvokeEndpoint.go b/service/sagemakerruntime/api_op_InvokeEndpoint.go index 0c21b36ed0a..1acf151f452 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpoint.go +++ b/service/sagemakerruntime/api_op_InvokeEndpoint.go @@ -13,14 +13,13 @@ import ( // After you deploy a model into production using Amazon SageMaker hosting // services, your client applications use this API to get inferences from the model // hosted at the specified endpoint. For an overview of Amazon SageMaker, see How -// It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). +// It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) . // Amazon SageMaker strips all POST headers except those supported by the API. // Amazon SageMaker might add additional headers. You should not rely on the // behavior of headers outside those enumerated in the request syntax. Calls to // InvokeEndpoint are authenticated by using Amazon Web Services Signature Version // 4. For information, see Authenticating Requests (Amazon Web Services Signature -// Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) // in the Amazon S3 API Reference. A customer's model containers must respond to // requests within 60 seconds. The model itself can have a maximum processing time // of 60 seconds before responding to invocations. If your model is going to take @@ -48,15 +47,15 @@ type InvokeEndpointInput struct { // Provides input data, in the format specified in the ContentType request header. // Amazon SageMaker passes all of the data in the body to the model. For // information about the format of the request body, see Common Data - // Formats-Inference - // (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html). + // Formats-Inference (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html) + // . // // This member is required. Body []byte // The name of the endpoint that you specified when you created the endpoint using - // the CreateEndpoint - // (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) API. + // the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html) + // API. // // This member is required. EndpointName *string @@ -72,26 +71,25 @@ type InvokeEndpointInput struct { // that is forwarded verbatim. You could use this value, for example, to provide an // ID that you can use to track a request or to provide other metadata that a // service endpoint was programmed to process. The value must consist of no more - // than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value - // Components (https://tools.ietf.org/html/rfc7230#section-3.2.6) of the Hypertext - // Transfer Protocol (HTTP/1.1). The code in your model is responsible for setting - // or updating any custom attributes in the response. If your code does not set - // this value in the response, an empty value is returned. For example, if a custom - // attribute represents the trace ID, your model can prepend the custom attribute - // with Trace ID: in your post-processing function. This feature is currently - // supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python - // SDK. + // than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field + // Value Components (https://tools.ietf.org/html/rfc7230#section-3.2.6) of the + // Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible + // for setting or updating any custom attributes in the response. If your code does + // not set this value in the response, an empty value is returned. For example, if + // a custom attribute represents the trace ID, your model can prepend the custom + // attribute with Trace ID: in your post-processing function. This feature is + // currently supported in the Amazon Web Services SDKs but not in the Amazon + // SageMaker Python SDK. CustomAttributes *string // An optional JMESPath expression used to override the EnableExplanations - // parameter of the ClarifyExplainerConfig API. See the EnableExplanations - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) + // parameter of the ClarifyExplainerConfig API. See the EnableExplanations (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) // section in the developer guide for more information. EnableExplanations *string // If you provide a value, it is added to the captured data when you enable data - // capture on the endpoint. For information about data capture, see Capture Data - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html). + // capture on the endpoint. For information about data capture, see Capture Data (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html) + // . InferenceId *string // If the endpoint hosts multiple containers and is configured to use direct @@ -101,12 +99,11 @@ type InvokeEndpointInput struct { // The model to request for inference when invoking a multi-model endpoint. TargetModel *string - // Specify the production variant to send the inference request to when invoking an - // endpoint that is running two or more variants. Note that this parameter + // Specify the production variant to send the inference request to when invoking + // an endpoint that is running two or more variants. Note that this parameter // overrides the default behavior for the endpoint, which is to distribute the // invocation traffic based on the variant weights. For information about how to - // use variant targeting to perform a/b testing, see Test models in production - // (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html) + // use variant targeting to perform a/b testing, see Test models in production (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html) TargetVariant *string noSmithyDocumentSerde @@ -115,11 +112,10 @@ type InvokeEndpointInput struct { type InvokeEndpointOutput struct { // Includes the inference provided by the model. For information about the format - // of the response body, see Common Data Formats-Inference - // (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html). If the - // explainer is activated, the body includes the explanations provided by the - // model. For more information, see the Response section under Invoke the Endpoint - // (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) + // of the response body, see Common Data Formats-Inference (https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html) + // . If the explainer is activated, the body includes the explanations provided by + // the model. For more information, see the Response section under Invoke the + // Endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) // in the Developer Guide. // // This member is required. @@ -133,17 +129,16 @@ type InvokeEndpointOutput struct { // value that is forwarded verbatim. You could use this value, for example, to // return an ID received in the CustomAttributes header of a request or other // metadata that a service endpoint was programmed to produce. The value must - // consist of no more than 1024 visible US-ASCII characters as specified in Section - // 3.3.6. Field Value Components - // (https://tools.ietf.org/html/rfc7230#section-3.2.6) of the Hypertext Transfer - // Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the - // model must set the custom attribute to be included on the way back. The code in - // your model is responsible for setting or updating any custom attributes in the - // response. If your code does not set this value in the response, an empty value - // is returned. For example, if a custom attribute represents the trace ID, your - // model can prepend the custom attribute with Trace ID: in your post-processing - // function. This feature is currently supported in the Amazon Web Services SDKs - // but not in the Amazon SageMaker Python SDK. + // consist of no more than 1024 visible US-ASCII characters as specified in + // Section 3.3.6. Field Value Components (https://tools.ietf.org/html/rfc7230#section-3.2.6) + // of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom + // attribute returned, the model must set the custom attribute to be included on + // the way back. The code in your model is responsible for setting or updating any + // custom attributes in the response. If your code does not set this value in the + // response, an empty value is returned. For example, if a custom attribute + // represents the trace ID, your model can prepend the custom attribute with Trace + // ID: in your post-processing function. This feature is currently supported in the + // Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK. CustomAttributes *string // Identifies the production variant that was invoked. diff --git a/service/sagemakerruntime/api_op_InvokeEndpointAsync.go b/service/sagemakerruntime/api_op_InvokeEndpointAsync.go index e3f50357e3f..d1abf38033f 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpointAsync.go +++ b/service/sagemakerruntime/api_op_InvokeEndpointAsync.go @@ -22,8 +22,7 @@ import ( // headers outside those enumerated in the request syntax. Calls to // InvokeEndpointAsync are authenticated by using Amazon Web Services Signature // Version 4. For information, see Authenticating Requests (Amazon Web Services -// Signature Version 4) -// (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) // in the Amazon S3 API Reference. func (c *Client) InvokeEndpointAsync(ctx context.Context, params *InvokeEndpointAsyncInput, optFns ...func(*Options)) (*InvokeEndpointAsyncOutput, error) { if params == nil { @@ -43,8 +42,7 @@ func (c *Client) InvokeEndpointAsync(ctx context.Context, params *InvokeEndpoint type InvokeEndpointAsyncInput struct { // The name of the endpoint that you specified when you created the endpoint using - // the CreateEndpoint - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) + // the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) // API. // // This member is required. @@ -66,23 +64,23 @@ type InvokeEndpointAsyncInput struct { // that is forwarded verbatim. You could use this value, for example, to provide an // ID that you can use to track a request or to provide other metadata that a // service endpoint was programmed to process. The value must consist of no more - // than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value - // Components (https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6) of the - // Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible - // for setting or updating any custom attributes in the response. If your code does - // not set this value in the response, an empty value is returned. For example, if - // a custom attribute represents the trace ID, your model can prepend the custom - // attribute with Trace ID: in your post-processing function. This feature is - // currently supported in the Amazon Web Services SDKs but not in the Amazon - // SageMaker Python SDK. + // than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field + // Value Components (https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6) + // of the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is + // responsible for setting or updating any custom attributes in the response. If + // your code does not set this value in the response, an empty value is returned. + // For example, if a custom attribute represents the trace ID, your model can + // prepend the custom attribute with Trace ID : in your post-processing function. + // This feature is currently supported in the Amazon Web Services SDKs but not in + // the Amazon SageMaker Python SDK. CustomAttributes *string // The identifier for the inference request. Amazon SageMaker will generate an // identifier for you if none is specified. InferenceId *string - // Maximum amount of time in seconds a request can be processed before it is marked - // as expired. The default is 15 minutes, or 900 seconds. + // Maximum amount of time in seconds a request can be processed before it is + // marked as expired. The default is 15 minutes, or 900 seconds. InvocationTimeoutSeconds *int32 // Maximum age in seconds a request can be in the queue before it is marked as diff --git a/service/sagemakerruntime/types/errors.go b/service/sagemakerruntime/types/errors.go index efcd7be5047..a5d6356ec95 100644 --- a/service/sagemakerruntime/types/errors.go +++ b/service/sagemakerruntime/types/errors.go @@ -90,8 +90,8 @@ func (e *ModelError) ErrorCode() string { } func (e *ModelError) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Either a serverless endpoint variant's resources are still being provisioned, or -// a multi-model endpoint is still downloading or loading the target model. Wait +// Either a serverless endpoint variant's resources are still being provisioned, +// or a multi-model endpoint is still downloading or loading the target model. Wait // and try your request again. type ModelNotReadyException struct { Message *string diff --git a/service/savingsplans/api_client.go b/service/savingsplans/api_client.go index 992d7eeee9f..b289d8a2c0f 100644 --- a/service/savingsplans/api_client.go +++ b/service/savingsplans/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/savingsplans/api_op_CreateSavingsPlan.go b/service/savingsplans/api_op_CreateSavingsPlan.go index 673af47b1d1..a4ca6e04202 100644 --- a/service/savingsplans/api_op_CreateSavingsPlan.go +++ b/service/savingsplans/api_op_CreateSavingsPlan.go @@ -52,9 +52,9 @@ type CreateSavingsPlanInput struct { // One or more tags. Tags map[string]string - // The up-front payment amount. This is a whole number between 50 and 99 percent of - // the total value of the Savings Plan. This parameter is supported only if the - // payment option is Partial Upfront. + // The up-front payment amount. This is a whole number between 50 and 99 percent + // of the total value of the Savings Plan. This parameter is supported only if the + // payment option is Partial Upfront . UpfrontPaymentAmount *string noSmithyDocumentSerde diff --git a/service/savingsplans/doc.go b/service/savingsplans/doc.go index f72852baef8..4ab327eb6e5 100644 --- a/service/savingsplans/doc.go +++ b/service/savingsplans/doc.go @@ -6,6 +6,6 @@ // Savings Plans are a pricing model that offer significant savings on AWS usage // (for example, on Amazon EC2 instances). You commit to a consistent amount of // usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price -// for that usage. For more information, see the AWS Savings Plans User Guide -// (https://docs.aws.amazon.com/savingsplans/latest/userguide/). +// for that usage. For more information, see the AWS Savings Plans User Guide (https://docs.aws.amazon.com/savingsplans/latest/userguide/) +// . package savingsplans diff --git a/service/savingsplans/types/enums.go b/service/savingsplans/types/enums.go index a980ccd7e62..a9d7658a9f9 100644 --- a/service/savingsplans/types/enums.go +++ b/service/savingsplans/types/enums.go @@ -10,9 +10,9 @@ const ( CurrencyCodeUsd CurrencyCode = "USD" ) -// Values returns all known values for CurrencyCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for CurrencyCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (CurrencyCode) Values() []CurrencyCode { return []CurrencyCode{ "CNY", @@ -67,9 +67,9 @@ const ( SavingsPlanPaymentOptionNoUpfront SavingsPlanPaymentOption = "No Upfront" ) -// Values returns all known values for SavingsPlanPaymentOption. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SavingsPlanPaymentOption. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanPaymentOption) Values() []SavingsPlanPaymentOption { return []SavingsPlanPaymentOption{ "All Upfront", diff --git a/service/scheduler/api_client.go b/service/scheduler/api_client.go index e8d4532b5dc..237bdd8143a 100644 --- a/service/scheduler/api_client.go +++ b/service/scheduler/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/scheduler/api_op_CreateSchedule.go b/service/scheduler/api_op_CreateSchedule.go index d5534227790..95370186a67 100644 --- a/service/scheduler/api_op_CreateSchedule.go +++ b/service/scheduler/api_op_CreateSchedule.go @@ -31,8 +31,8 @@ func (c *Client) CreateSchedule(ctx context.Context, params *CreateScheduleInput type CreateScheduleInput struct { - // Allows you to configure a time window during which EventBridge Scheduler invokes - // the schedule. + // Allows you to configure a time window during which EventBridge Scheduler + // invokes the schedule. // // This member is required. FlexibleTimeWindow *types.FlexibleTimeWindow @@ -44,28 +44,21 @@ type CreateScheduleInput struct { // The expression that defines when the schedule runs. The following formats are // supported. - // - // * at expression - at(yyyy-mm-ddThh:mm:ss) - // - // * rate expression - - // rate(unit value) - // - // * cron expression - cron(fields) - // - // You can use at expressions - // to create one-time schedules that invoke a target once, at the time and in the - // time zone, that you specify. You can use rate and cron expressions to create - // recurring schedules. Rate-based schedules are useful when you want to invoke a - // target at regular intervals, such as every 15 minutes or every five days. - // Cron-based schedules are useful when you want to invoke a target periodically at - // a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A cron - // expression consists of six fields separated by white spaces: (minutes hours - // day_of_month month day_of_week year). A rate expression consists of a value as a - // positive integer, and a unit with the following options: minute | minutes | hour - // | hours | day | days For more information and examples, see Schedule types on - // EventBridge Scheduler - // (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in - // the EventBridge Scheduler User Guide. + // - at expression - at(yyyy-mm-ddThh:mm:ss) + // - rate expression - rate(unit value) + // - cron expression - cron(fields) + // You can use at expressions to create one-time schedules that invoke a target + // once, at the time and in the time zone, that you specify. You can use rate and + // cron expressions to create recurring schedules. Rate-based schedules are useful + // when you want to invoke a target at regular intervals, such as every 15 minutes + // or every five days. Cron-based schedules are useful when you want to invoke a + // target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day + // of the month. A cron expression consists of six fields separated by white + // spaces: (minutes hours day_of_month month day_of_week year) . A rate expression + // consists of a value as a positive integer, and a unit with the following + // options: minute | minutes | hour | hours | day | days For more information and + // examples, see Schedule types on EventBridge Scheduler (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) + // in the EventBridge Scheduler User Guide. // // This member is required. ScheduleExpression *string @@ -93,8 +86,8 @@ type CreateScheduleInput struct { // this, the default schedule group is used. GroupName *string - // The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge - // Scheduler will use to encrypt and decrypt your data. + // The Amazon Resource Name (ARN) for the customer managed KMS key that + // EventBridge Scheduler will use to encrypt and decrypt your data. KmsKeyArn *string // The timezone in which the scheduling expression is evaluated. @@ -102,8 +95,8 @@ type CreateScheduleInput struct { // The date, in UTC, after which the schedule can begin invoking its target. // Depending on the schedule's recurrence expression, invocations might occur on, - // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for - // one-time schedules. + // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate + // for one-time schedules. StartDate *time.Time // Specifies whether the schedule is enabled or disabled. diff --git a/service/scheduler/api_op_GetSchedule.go b/service/scheduler/api_op_GetSchedule.go index 8adb512e07d..1e9861c4e4c 100644 --- a/service/scheduler/api_op_GetSchedule.go +++ b/service/scheduler/api_op_GetSchedule.go @@ -60,8 +60,8 @@ type GetScheduleOutput struct { // schedules. EndDate *time.Time - // Allows you to configure a time window during which EventBridge Scheduler invokes - // the schedule. + // Allows you to configure a time window during which EventBridge Scheduler + // invokes the schedule. FlexibleTimeWindow *types.FlexibleTimeWindow // The name of the schedule group associated with this schedule. @@ -79,28 +79,21 @@ type GetScheduleOutput struct { // The expression that defines when the schedule runs. The following formats are // supported. - // - // * at expression - at(yyyy-mm-ddThh:mm:ss) - // - // * rate expression - - // rate(unit value) - // - // * cron expression - cron(fields) - // - // You can use at expressions - // to create one-time schedules that invoke a target once, at the time and in the - // time zone, that you specify. You can use rate and cron expressions to create - // recurring schedules. Rate-based schedules are useful when you want to invoke a - // target at regular intervals, such as every 15 minutes or every five days. - // Cron-based schedules are useful when you want to invoke a target periodically at - // a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A cron - // expression consists of six fields separated by white spaces: (minutes hours - // day_of_month month day_of_week year). A rate expression consists of a value as a - // positive integer, and a unit with the following options: minute | minutes | hour - // | hours | day | days For more information and examples, see Schedule types on - // EventBridge Scheduler - // (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in - // the EventBridge Scheduler User Guide. + // - at expression - at(yyyy-mm-ddThh:mm:ss) + // - rate expression - rate(unit value) + // - cron expression - cron(fields) + // You can use at expressions to create one-time schedules that invoke a target + // once, at the time and in the time zone, that you specify. You can use rate and + // cron expressions to create recurring schedules. Rate-based schedules are useful + // when you want to invoke a target at regular intervals, such as every 15 minutes + // or every five days. Cron-based schedules are useful when you want to invoke a + // target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day + // of the month. A cron expression consists of six fields separated by white + // spaces: (minutes hours day_of_month month day_of_week year) . A rate expression + // consists of a value as a positive integer, and a unit with the following + // options: minute | minutes | hour | hours | day | days For more information and + // examples, see Schedule types on EventBridge Scheduler (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) + // in the EventBridge Scheduler User Guide. ScheduleExpression *string // The timezone in which the scheduling expression is evaluated. @@ -108,8 +101,8 @@ type GetScheduleOutput struct { // The date, in UTC, after which the schedule can begin invoking its target. // Depending on the schedule's recurrence expression, invocations might occur on, - // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for - // one-time schedules. + // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate + // for one-time schedules. StartDate *time.Time // Specifies whether the schedule is enabled or disabled. diff --git a/service/scheduler/api_op_UntagResource.go b/service/scheduler/api_op_UntagResource.go index 47cecff4cc5..415036b7651 100644 --- a/service/scheduler/api_op_UntagResource.go +++ b/service/scheduler/api_op_UntagResource.go @@ -29,8 +29,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the schedule group from which you are removing - // tags. + // The Amazon Resource Name (ARN) of the schedule group from which you are + // removing tags. // // This member is required. ResourceArn *string diff --git a/service/scheduler/api_op_UpdateSchedule.go b/service/scheduler/api_op_UpdateSchedule.go index a57d84d7be4..0c437337770 100644 --- a/service/scheduler/api_op_UpdateSchedule.go +++ b/service/scheduler/api_op_UpdateSchedule.go @@ -13,7 +13,7 @@ import ( "time" ) -// Updates the specified schedule. When you call UpdateSchedule, EventBridge +// Updates the specified schedule. When you call UpdateSchedule , EventBridge // Scheduler uses all values, including empty values, specified in the request and // overrides the existing schedule. This is by design. This means that if you do // not set an optional field in your request, that field will be set to its @@ -37,8 +37,8 @@ func (c *Client) UpdateSchedule(ctx context.Context, params *UpdateScheduleInput type UpdateScheduleInput struct { - // Allows you to configure a time window during which EventBridge Scheduler invokes - // the schedule. + // Allows you to configure a time window during which EventBridge Scheduler + // invokes the schedule. // // This member is required. FlexibleTimeWindow *types.FlexibleTimeWindow @@ -50,28 +50,21 @@ type UpdateScheduleInput struct { // The expression that defines when the schedule runs. The following formats are // supported. - // - // * at expression - at(yyyy-mm-ddThh:mm:ss) - // - // * rate expression - - // rate(unit value) - // - // * cron expression - cron(fields) - // - // You can use at expressions - // to create one-time schedules that invoke a target once, at the time and in the - // time zone, that you specify. You can use rate and cron expressions to create - // recurring schedules. Rate-based schedules are useful when you want to invoke a - // target at regular intervals, such as every 15 minutes or every five days. - // Cron-based schedules are useful when you want to invoke a target periodically at - // a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A cron - // expression consists of six fields separated by white spaces: (minutes hours - // day_of_month month day_of_week year). A rate expression consists of a value as a - // positive integer, and a unit with the following options: minute | minutes | hour - // | hours | day | days For more information and examples, see Schedule types on - // EventBridge Scheduler - // (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in - // the EventBridge Scheduler User Guide. + // - at expression - at(yyyy-mm-ddThh:mm:ss) + // - rate expression - rate(unit value) + // - cron expression - cron(fields) + // You can use at expressions to create one-time schedules that invoke a target + // once, at the time and in the time zone, that you specify. You can use rate and + // cron expressions to create recurring schedules. Rate-based schedules are useful + // when you want to invoke a target at regular intervals, such as every 15 minutes + // or every five days. Cron-based schedules are useful when you want to invoke a + // target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day + // of the month. A cron expression consists of six fields separated by white + // spaces: (minutes hours day_of_month month day_of_week year) . A rate expression + // consists of a value as a positive integer, and a unit with the following + // options: minute | minutes | hour | hours | day | days For more information and + // examples, see Schedule types on EventBridge Scheduler (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) + // in the EventBridge Scheduler User Guide. // // This member is required. ScheduleExpression *string @@ -111,8 +104,8 @@ type UpdateScheduleInput struct { // The date, in UTC, after which the schedule can begin invoking its target. // Depending on the schedule's recurrence expression, invocations might occur on, - // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for - // one-time schedules. + // or after, the StartDate you specify. EventBridge Scheduler ignores StartDate + // for one-time schedules. StartDate *time.Time // Specifies whether the schedule is enabled or disabled. diff --git a/service/scheduler/types/enums.go b/service/scheduler/types/enums.go index 8fa88ac1b3f..9f220d975ab 100644 --- a/service/scheduler/types/enums.go +++ b/service/scheduler/types/enums.go @@ -85,8 +85,8 @@ const ( PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" ) -// Values returns all known values for PlacementStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PlacementStrategyType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategyType) Values() []PlacementStrategyType { return []PlacementStrategyType{ diff --git a/service/scheduler/types/types.go b/service/scheduler/types/types.go index 72f6170ce41..e9aade15cda 100644 --- a/service/scheduler/types/types.go +++ b/service/scheduler/types/types.go @@ -12,15 +12,15 @@ import ( // ECS tasks that use the awsvpc network mode. type AwsVpcConfiguration struct { - // Specifies the subnets associated with the task. These subnets must all be in the - // same VPC. You can specify as many as 16 subnets. + // Specifies the subnets associated with the task. These subnets must all be in + // the same VPC. You can specify as many as 16 subnets. // // This member is required. Subnets []string // Specifies whether the task's elastic network interface receives a public IP - // address. You can specify ENABLED only when LaunchType in EcsParameters is set to - // FARGATE. + // address. You can specify ENABLED only when LaunchType in EcsParameters is set + // to FARGATE . AssignPublicIp AssignPublicIp // Specifies the security groups associated with the task. These security groups @@ -46,9 +46,9 @@ type CapacityProviderStrategyItem struct { // used. Base int32 - // The weight value designates the relative percentage of the total number of tasks - // launched that should use the specified capacity provider. The weight value is - // taken into consideration after the base value, if defined, is satisfied. + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight value + // is taken into consideration after the base value, if defined, is satisfied. Weight int32 noSmithyDocumentSerde @@ -60,20 +60,19 @@ type CapacityProviderStrategyItem struct { // delivered to a target to the queue. type DeadLetterConfig struct { - // The Amazon Resource Name (ARN) of the SQS queue specified as the destination for - // the dead-letter queue. + // The Amazon Resource Name (ARN) of the SQS queue specified as the destination + // for the dead-letter queue. Arn *string noSmithyDocumentSerde } -// The templated target type for the Amazon ECS RunTask -// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API -// operation. +// The templated target type for the Amazon ECS RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) +// API operation. type EcsParameters struct { - // The Amazon Resource Name (ARN) of the task definition to use if the event target - // is an Amazon ECS task. + // The Amazon Resource Name (ARN) of the task definition to use if the event + // target is an Amazon ECS task. // // This member is required. TaskDefinitionArn *string @@ -82,14 +81,13 @@ type EcsParameters struct { CapacityProviderStrategy []CapacityProviderStrategyItem // Specifies whether to enable Amazon ECS managed tags for the task. For more - // information, see Tagging Your Amazon ECS Resources - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // in the Amazon ECS Developer Guide. EnableECSManagedTags *bool - // Whether or not to enable the execute command functionality for the containers in - // this task. If true, this enables execute command functionality on all containers - // in the task. + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. EnableExecuteCommand *bool // Specifies an ECS task group for the task. The maximum length is 255 characters. @@ -99,31 +97,29 @@ type EcsParameters struct { // you specify here must match one of the launch type (compatibilities) of the // target task. The FARGATE value is supported only in the Regions where Fargate // with Amazon ECS is supported. For more information, see AWS Fargate on Amazon - // ECS - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) + // ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) // in the Amazon ECS Developer Guide. LaunchType LaunchType // This structure specifies the network configuration for an ECS task. NetworkConfiguration *NetworkConfiguration - // An array of placement constraint objects to use for the task. You can specify up - // to 10 constraints per task (including constraints in the task definition and + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition and // those specified at runtime). PlacementConstraints []PlacementConstraint // The task placement strategy for a task or service. PlacementStrategy []PlacementStrategy - // Specifies the platform version for the task. Specify only the numeric portion of - // the platform version, such as 1.1.0. + // Specifies the platform version for the task. Specify only the numeric portion + // of the platform version, such as 1.1.0 . PlatformVersion *string - // Specifies whether to propagate the tags from the task definition to the task. If - // no value is specified, the tags are not propagated. Tags can only be propagated - // to the task during task creation. To add tags to a task after task creation, use - // Amazon ECS's TagResource - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be + // propagated to the task during task creation. To add tags to a task after task + // creation, use Amazon ECS's TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) // API action. PropagateTags PropagateTags @@ -132,24 +128,22 @@ type EcsParameters struct { // The metadata that you apply to the task to help you categorize and organize // them. Each tag consists of a key and an optional value, both of which you - // define. For more information, see RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) in - // the Amazon ECS API Reference. + // define. For more information, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) + // in the Amazon ECS API Reference. Tags []map[string]string - // The number of tasks to create based on TaskDefinition. The default is 1. + // The number of tasks to create based on TaskDefinition . The default is 1 . TaskCount *int32 noSmithyDocumentSerde } -// The templated target type for the EventBridge PutEvents -// (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) +// The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) // API operation. type EventBridgeParameters struct { - // A free-form string, with a maximum of 128 characters, used to decide what fields - // to expect in the event detail. + // A free-form string, with a maximum of 128 characters, used to decide what + // fields to expect in the event detail. // // This member is required. DetailType *string @@ -162,8 +156,8 @@ type EventBridgeParameters struct { noSmithyDocumentSerde } -// Allows you to configure a time window during which EventBridge Scheduler invokes -// the schedule. +// Allows you to configure a time window during which EventBridge Scheduler +// invokes the schedule. type FlexibleTimeWindow struct { // Determines whether the schedule is invoked within a flexible time window. @@ -181,9 +175,8 @@ type FlexibleTimeWindow struct { type KinesisParameters struct { // Specifies the shard to which EventBridge Scheduler sends the event. For more - // information, see Amazon Kinesis Data Streams terminology and concepts - // (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) in the Amazon - // Kinesis Streams Developer Guide. + // information, see Amazon Kinesis Data Streams terminology and concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) + // in the Amazon Kinesis Streams Developer Guide. // // This member is required. PartitionKey *string @@ -194,8 +187,8 @@ type KinesisParameters struct { // Specifies the network configuration for an ECS task. type NetworkConfiguration struct { - // Specifies the Amazon VPC subnets and security groups for the task, and whether a - // public IP address is to be used. This structure is relevant only for ECS tasks + // Specifies the Amazon VPC subnets and security groups for the task, and whether + // a public IP address is to be used. This structure is relevant only for ECS tasks // that use the awsvpc network mode. AwsvpcConfiguration *AwsVpcConfiguration @@ -206,9 +199,8 @@ type NetworkConfiguration struct { type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. You cannot - // specify an expression if the constraint type is distinctInstance. For more - // information, see Cluster query language - // (https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html) + // specify an expression if the constraint type is distinctInstance . For more + // information, see Cluster query language (https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html) // in the Amazon ECS Developer Guide. Expression *string @@ -224,10 +216,10 @@ type PlacementConstraint struct { type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement - // strategy, valid values are instanceId (or instanceId, which has the same + // strategy, valid values are instanceId (or instanceId , which has the same // effect), or any platform or custom attribute that is applied to a container - // instance, such as attribute:ecs.availability-zone. For the binpack placement - // strategy, valid values are cpu and memory. For the random placement strategy, + // instance, such as attribute:ecs.availability-zone . For the binpack placement + // strategy, valid values are cpu and memory . For the random placement strategy, // this field is not used. Field *string @@ -277,8 +269,7 @@ type SageMakerPipelineParameter struct { noSmithyDocumentSerde } -// The templated target type for the Amazon SageMaker StartPipelineExecution -// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) +// The templated target type for the Amazon SageMaker StartPipelineExecution (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) // API operation. type SageMakerPipelineParameters struct { @@ -337,13 +328,11 @@ type ScheduleSummary struct { noSmithyDocumentSerde } -// The templated target type for the Amazon SQS SendMessage -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) +// The templated target type for the Amazon SQS SendMessage (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) // API operation. Contains the message group ID to use when the target is a FIFO // queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have // content-based deduplication enabled. For more information, see Using the Amazon -// SQS message deduplication ID -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) +// SQS message deduplication ID (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. type SqsParameters struct { @@ -392,13 +381,11 @@ type Target struct { // delivered to a target to the queue. DeadLetterConfig *DeadLetterConfig - // The templated target type for the Amazon ECS RunTask - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API - // operation. + // The templated target type for the Amazon ECS RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) + // API operation. EcsParameters *EcsParameters - // The templated target type for the EventBridge PutEvents - // (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) + // The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) // API operation. EventBridgeParameters *EventBridgeParameters @@ -417,18 +404,15 @@ type Target struct { // EventBridge Scheduler will try to deliver the event to a target. RetryPolicy *RetryPolicy - // The templated target type for the Amazon SageMaker StartPipelineExecution - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) + // The templated target type for the Amazon SageMaker StartPipelineExecution (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) // API operation. SageMakerPipelineParameters *SageMakerPipelineParameters - // The templated target type for the Amazon SQS SendMessage - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) + // The templated target type for the Amazon SQS SendMessage (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) // API operation. Contains the message group ID to use when the target is a FIFO // queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have // content-based deduplication enabled. For more information, see Using the Amazon - // SQS message deduplication ID - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) + // SQS message deduplication ID (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. SqsParameters *SqsParameters diff --git a/service/schemas/api_client.go b/service/schemas/api_client.go index bca388b7df8..8d294cfe39a 100644 --- a/service/schemas/api_client.go +++ b/service/schemas/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/schemas/api_op_CreateDiscoverer.go b/service/schemas/api_op_CreateDiscoverer.go index 33985fd0018..b8688758d71 100644 --- a/service/schemas/api_op_CreateDiscoverer.go +++ b/service/schemas/api_op_CreateDiscoverer.go @@ -49,8 +49,8 @@ type CreateDiscovererInput struct { type CreateDiscovererOutput struct { - // The Status if the discoverer will discover schemas from events sent from another - // account. + // The Status if the discoverer will discover schemas from events sent from + // another account. CrossAccount bool // The description of the discoverer. diff --git a/service/schemas/api_op_DescribeCodeBinding.go b/service/schemas/api_op_DescribeCodeBinding.go index fe8702ed6a9..1ca0162289d 100644 --- a/service/schemas/api_op_DescribeCodeBinding.go +++ b/service/schemas/api_op_DescribeCodeBinding.go @@ -139,8 +139,8 @@ func (c *Client) addOperationDescribeCodeBindingMiddlewares(stack *middleware.St return nil } -// DescribeCodeBindingAPIClient is a client that implements the DescribeCodeBinding -// operation. +// DescribeCodeBindingAPIClient is a client that implements the +// DescribeCodeBinding operation. type DescribeCodeBindingAPIClient interface { DescribeCodeBinding(context.Context, *DescribeCodeBindingInput, ...func(*Options)) (*DescribeCodeBindingOutput, error) } @@ -160,9 +160,9 @@ type CodeBindingExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CodeBindingExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CodeBindingExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -210,10 +210,10 @@ func (w *CodeBindingExistsWaiter) Wait(ctx context.Context, params *DescribeCode return err } -// WaitForOutput calls the waiter function for CodeBindingExists waiter and returns -// the output of the successful operation. The maxWaitDur is the maximum wait -// duration the waiter will wait. The maxWaitDur is required and must be greater -// than zero. +// WaitForOutput calls the waiter function for CodeBindingExists waiter and +// returns the output of the successful operation. The maxWaitDur is the maximum +// wait duration the waiter will wait. The maxWaitDur is required and must be +// greater than zero. func (w *CodeBindingExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeCodeBindingInput, maxWaitDur time.Duration, optFns ...func(*CodeBindingExistsWaiterOptions)) (*DescribeCodeBindingOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") diff --git a/service/schemas/api_op_DescribeDiscoverer.go b/service/schemas/api_op_DescribeDiscoverer.go index e871ddb89ed..7e7fe30a98d 100644 --- a/service/schemas/api_op_DescribeDiscoverer.go +++ b/service/schemas/api_op_DescribeDiscoverer.go @@ -39,8 +39,8 @@ type DescribeDiscovererInput struct { type DescribeDiscovererOutput struct { - // The Status if the discoverer will discover schemas from events sent from another - // account. + // The Status if the discoverer will discover schemas from events sent from + // another account. CrossAccount bool // The description of the discoverer. diff --git a/service/schemas/api_op_GetDiscoveredSchema.go b/service/schemas/api_op_GetDiscoveredSchema.go index 487554a02ab..d38e67742cb 100644 --- a/service/schemas/api_op_GetDiscoveredSchema.go +++ b/service/schemas/api_op_GetDiscoveredSchema.go @@ -29,9 +29,9 @@ func (c *Client) GetDiscoveredSchema(ctx context.Context, params *GetDiscoveredS type GetDiscoveredSchemaInput struct { - // An array of strings where each string is a JSON event. These are the events that - // were used to generate the schema. The array includes a single type of event and - // has a maximum size of 10 events. + // An array of strings where each string is a JSON event. These are the events + // that were used to generate the schema. The array includes a single type of event + // and has a maximum size of 10 events. // // This member is required. Events []string diff --git a/service/schemas/api_op_UpdateDiscoverer.go b/service/schemas/api_op_UpdateDiscoverer.go index 41547ae3f1d..04b14e83fcc 100644 --- a/service/schemas/api_op_UpdateDiscoverer.go +++ b/service/schemas/api_op_UpdateDiscoverer.go @@ -46,8 +46,8 @@ type UpdateDiscovererInput struct { type UpdateDiscovererOutput struct { - // The Status if the discoverer will discover schemas from events sent from another - // account. + // The Status if the discoverer will discover schemas from events sent from + // another account. CrossAccount bool // The description of the discoverer. diff --git a/service/schemas/types/types.go b/service/schemas/types/types.go index 731d3cd7ab8..b66487b82e5 100644 --- a/service/schemas/types/types.go +++ b/service/schemas/types/types.go @@ -9,8 +9,8 @@ import ( type DiscovererSummary struct { - // The Status if the discoverer will discover schemas from events sent from another - // account. + // The Status if the discoverer will discover schemas from events sent from + // another account. CrossAccount bool // The ARN of the discoverer. diff --git a/service/secretsmanager/api_client.go b/service/secretsmanager/api_client.go index 9c8fae5ba56..50d06454b8e 100644 --- a/service/secretsmanager/api_client.go +++ b/service/secretsmanager/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/secretsmanager/api_op_CancelRotateSecret.go b/service/secretsmanager/api_op_CancelRotateSecret.go index 56bcc45ac5d..f8bd5b82f13 100644 --- a/service/secretsmanager/api_op_CancelRotateSecret.go +++ b/service/secretsmanager/api_op_CancelRotateSecret.go @@ -15,21 +15,18 @@ import ( // VersionStage labels in an unexpected state. You might need to remove the staging // label AWSPENDING from the partially created version. You also need to determine // whether to roll back to the previous version of the secret by moving the staging -// label AWSCURRENT to the version that has AWSPENDING. To determine which version -// has a specific staging label, call ListSecretVersionIds. Then use -// UpdateSecretVersionStage to change staging labels. For more information, see How -// rotation works -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html). -// To turn on automatic rotation again, call RotateSecret. Secrets Manager +// label AWSCURRENT to the version that has AWSPENDING . To determine which version +// has a specific staging label, call ListSecretVersionIds . Then use +// UpdateSecretVersionStage to change staging labels. For more information, see +// How rotation works (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) +// . To turn on automatic rotation again, call RotateSecret . Secrets Manager // generates a CloudTrail log entry when you call this action. Do not include // sensitive information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:CancelRotateSecret. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:CancelRotateSecret . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) CancelRotateSecret(ctx context.Context, params *CancelRotateSecretInput, optFns ...func(*Options)) (*CancelRotateSecretOutput, error) { if params == nil { params = &CancelRotateSecretInput{} @@ -48,8 +45,8 @@ func (c *Client) CancelRotateSecret(ctx context.Context, params *CancelRotateSec type CancelRotateSecretInput struct { // The ARN or name of the secret. For an ARN, we recommend that you specify a - // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string diff --git a/service/secretsmanager/api_op_CreateSecret.go b/service/secretsmanager/api_op_CreateSecret.go index abd6438d97f..830a53b24e8 100644 --- a/service/secretsmanager/api_op_CreateSecret.go +++ b/service/secretsmanager/api_op_CreateSecret.go @@ -12,46 +12,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new secret. A secret can be a password, a set of credentials such as a -// user name and password, an OAuth token, or other secret information that you +// Creates a new secret. A secret can be a password, a set of credentials such as +// a user name and password, an OAuth token, or other secret information that you // store in an encrypted form in Secrets Manager. The secret also includes the // connection information to access a database or other service, which Secrets // Manager doesn't encrypt. A secret in Secrets Manager consists of both the // protected secret data and the important information needed to manage the secret. // For secrets that use managed rotation, you need to create the secret through the // managing service. For more information, see Secrets Manager secrets managed by -// other Amazon Web Services services -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html). -// For information about creating a secret in the console, see Create a secret -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). -// To create a secret, you can provide the secret value to be encrypted in either +// other Amazon Web Services services (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html) +// . For information about creating a secret in the console, see Create a secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) +// . To create a secret, you can provide the secret value to be encrypted in either // the SecretString parameter or the SecretBinary parameter, but not both. If you // include SecretString or SecretBinary then Secrets Manager creates an initial // secret version and automatically attaches the staging label AWSCURRENT to it. // For database credentials you want to rotate, for Secrets Manager to be able to // rotate the secret, you must make sure the JSON you store in the SecretString -// matches the JSON structure of a database secret -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html). -// If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web -// Services managed key aws/secretsmanager. If this key doesn't already exist in -// your account, then Secrets Manager creates it for you automatically. All users -// and roles in the Amazon Web Services account automatically have access to use -// aws/secretsmanager. Creating aws/secretsmanager can result in a one-time +// matches the JSON structure of a database secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html) +// . If you don't specify an KMS encryption key, Secrets Manager uses the Amazon +// Web Services managed key aws/secretsmanager . If this key doesn't already exist +// in your account, then Secrets Manager creates it for you automatically. All +// users and roles in the Amazon Web Services account automatically have access to +// use aws/secretsmanager . Creating aws/secretsmanager can result in a one-time // significant delay in returning the result. If the secret is in a different // Amazon Web Services account from the credentials calling the API, then you can't // use aws/secretsmanager to encrypt the secret, and you must create and use a // customer managed KMS key. Secrets Manager generates a CloudTrail log entry when // you call this action. Do not include sensitive information in request parameters // except SecretBinary or SecretString because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:CreateSecret. If you include tags in the -// secret, you also need secretsmanager:TagResource. For more information, see IAM -// policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). -// To encrypt the secret with a KMS key other than aws/secretsmanager, you need +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:CreateSecret . If you include tags in the +// secret, you also need secretsmanager:TagResource . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . To encrypt the secret with a KMS key other than aws/secretsmanager , you need // kms:GenerateDataKey and kms:Decrypt permission to the key. func (c *Client) CreateSecret(ctx context.Context, params *CreateSecretInput, optFns ...func(*Options)) (*CreateSecretOutput, error) { if params == nil { @@ -83,7 +77,7 @@ type CreateSecretInput struct { // A list of Regions and KMS keys to replicate secrets. AddReplicaRegions []types.ReplicaRegionType - // If you include SecretString or SecretBinary, then Secrets Manager creates an + // If you include SecretString or SecretBinary , then Secrets Manager creates an // initial version for the secret, and this parameter specifies the unique // identifier for the new version. If you use the Amazon Web Services CLI or one of // the Amazon Web Services SDKs to call this operation, then you can leave this @@ -96,21 +90,15 @@ type CreateSecretInput struct { // if there are failures and retries during a rotation. We recommend that you // generate a UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier) // value to ensure uniqueness of your versions within the specified secret. - // - // * If - // the ClientRequestToken value isn't already associated with a version of the - // secret then a new version of the secret is created. - // - // * If a version with this - // value already exists and the version SecretString and SecretBinary values are - // the same as those in the request, then the request is ignored. - // - // * If a version - // with this value already exists and that version's SecretString and SecretBinary - // values are different from those in the request, then the request fails because - // you cannot modify an existing version. Instead, use PutSecretValue to create a - // new version. - // + // - If the ClientRequestToken value isn't already associated with a version of + // the secret then a new version of the secret is created. + // - If a version with this value already exists and the version SecretString and + // SecretBinary values are the same as those in the request, then the request is + // ignored. + // - If a version with this value already exists and that version's SecretString + // and SecretBinary values are different from those in the request, then the + // request fails because you cannot modify an existing version. Instead, use + // PutSecretValue to create a new version. // This value becomes the VersionId of the new version. ClientRequestToken *string @@ -122,16 +110,15 @@ type CreateSecretInput struct { ForceOverwriteReplicaSecret bool // The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt - // the secret value in the secret. An alias is always prefixed by alias/, for - // example alias/aws/secretsmanager. For more information, see About aliases - // (https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use - // a KMS key in a different account, use the key ARN or the alias ARN. If you don't - // specify this value, then Secrets Manager uses the key aws/secretsmanager. If - // that key doesn't yet exist, then Secrets Manager creates it for you - // automatically the first time it encrypts the secret value. If the secret is in a - // different Amazon Web Services account from the credentials calling the API, then - // you can't use aws/secretsmanager to encrypt the secret, and you must create and - // use a customer managed KMS key. + // the secret value in the secret. An alias is always prefixed by alias/ , for + // example alias/aws/secretsmanager . For more information, see About aliases (https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html) + // . To use a KMS key in a different account, use the key ARN or the alias ARN. If + // you don't specify this value, then Secrets Manager uses the key + // aws/secretsmanager . If that key doesn't yet exist, then Secrets Manager creates + // it for you automatically the first time it encrypts the secret value. If the + // secret is in a different Amazon Web Services account from the credentials + // calling the API, then you can't use aws/secretsmanager to encrypt the secret, + // and you must create and use a customer managed KMS key. KmsKeyId *string // The binary data to encrypt and store in the new version of the secret. We @@ -159,38 +146,25 @@ type CreateSecretInput struct { // permissions. If the completion of this operation would result in you losing your // permissions for this secret, then Secrets Manager blocks the operation and // returns an Access Denied error. For more information, see Control access to - // secrets using tags - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) - // and Limit access to identities with tags that match secrets' tags - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). - // For information about how to format a JSON parameter for the various command - // line tool environments, see Using JSON for Parameters - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). - // If your command-line tool or SDK requires quotation marks around the parameter, - // you should use single quotes to avoid confusion with the double quotes required - // in the JSON text. The following restrictions apply to tags: - // - // * Maximum number of - // tags per secret: 50 - // - // * Maximum key length: 127 Unicode characters in UTF-8 - // - // * - // Maximum value length: 255 Unicode characters in UTF-8 - // - // * Tag keys and values are - // case sensitive. - // - // * Do not use the aws: prefix in your tag names or values - // because Amazon Web Services reserves it for Amazon Web Services use. You can't - // edit or delete tag names or values with this prefix. Tags with this prefix do - // not count against your tags per secret limit. - // - // * If you use your tagging schema - // across multiple services and resources, other services might have restrictions - // on allowed characters. Generally allowed characters: letters, spaces, and - // numbers representable in UTF-8, plus the following special characters: + - = . _ - // : / @. + // secrets using tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) + // and Limit access to identities with tags that match secrets' tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2) + // . For information about how to format a JSON parameter for the various command + // line tool environments, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) + // . If your command-line tool or SDK requires quotation marks around the + // parameter, you should use single quotes to avoid confusion with the double + // quotes required in the JSON text. The following restrictions apply to tags: + // - Maximum number of tags per secret: 50 + // - Maximum key length: 127 Unicode characters in UTF-8 + // - Maximum value length: 255 Unicode characters in UTF-8 + // - Tag keys and values are case sensitive. + // - Do not use the aws: prefix in your tag names or values because Amazon Web + // Services reserves it for Amazon Web Services use. You can't edit or delete tag + // names or values with this prefix. Tags with this prefix do not count against + // your tags per secret limit. + // - If you use your tagging schema across multiple services and resources, + // other services might have restrictions on allowed characters. Generally allowed + // characters: letters, spaces, and numbers representable in UTF-8, plus the + // following special characters: + - = . _ : / @. Tags []types.Tag noSmithyDocumentSerde @@ -208,15 +182,10 @@ type CreateSecretOutput struct { Name *string // A list of the replicas of this secret and their status: - // - // * Failed, which - // indicates that the replica was not created. - // - // * InProgress, which indicates that - // Secrets Manager is in the process of creating the replica. - // - // * InSync, which - // indicates that the replica was created. + // - Failed , which indicates that the replica was not created. + // - InProgress , which indicates that Secrets Manager is in the process of + // creating the replica. + // - InSync , which indicates that the replica was created. ReplicationStatus []types.ReplicationStatusType // The unique identifier associated with the version of the new secret. diff --git a/service/secretsmanager/api_op_DeleteResourcePolicy.go b/service/secretsmanager/api_op_DeleteResourcePolicy.go index 5723a461299..40dd0d61799 100644 --- a/service/secretsmanager/api_op_DeleteResourcePolicy.go +++ b/service/secretsmanager/api_op_DeleteResourcePolicy.go @@ -10,17 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the resource-based permission policy attached to the secret. To attach a -// policy to a secret, use PutResourcePolicy. Secrets Manager generates a +// Deletes the resource-based permission policy attached to the secret. To attach +// a policy to a secret, use PutResourcePolicy . Secrets Manager generates a // CloudTrail log entry when you call this action. Do not include sensitive // information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:DeleteResourcePolicy. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:DeleteResourcePolicy . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} @@ -40,8 +38,8 @@ type DeleteResourcePolicyInput struct { // The ARN or name of the secret to delete the attached resource-based policy for. // For an ARN, we recommend that you specify a complete ARN rather than a partial - // ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string diff --git a/service/secretsmanager/api_op_DeleteSecret.go b/service/secretsmanager/api_op_DeleteSecret.go index 86824a5a352..20eab045d0b 100644 --- a/service/secretsmanager/api_op_DeleteSecret.go +++ b/service/secretsmanager/api_op_DeleteSecret.go @@ -17,32 +17,29 @@ import ( // stamp to the secret that specifies the end of the recovery window. At the end of // the recovery window, Secrets Manager deletes the secret permanently. You can't // delete a primary secret that is replicated to other Regions. You must first -// delete the replicas using RemoveRegionsFromReplication, and then delete the +// delete the replicas using RemoveRegionsFromReplication , and then delete the // primary secret. When you delete a replica, it is deleted immediately. You can't // directly delete a version of a secret. Instead, you remove all staging labels -// from the version using UpdateSecretVersionStage. This marks the version as +// from the version using UpdateSecretVersionStage . This marks the version as // deprecated, and then Secrets Manager can automatically delete the version in the // background. To determine whether an application still uses a secret, you can // create an Amazon CloudWatch alarm to alert you to any attempts to access a -// secret during the recovery window. For more information, see Monitor secrets -// scheduled for deletion -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html). -// Secrets Manager performs the permanent secret deletion at the end of the waiting -// period as a background task with low priority. There is no guarantee of a -// specific time after the recovery window for the permanent delete to occur. At +// secret during the recovery window. For more information, see Monitor secrets +// scheduled for deletion (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html) +// . Secrets Manager performs the permanent secret deletion at the end of the +// waiting period as a background task with low priority. There is no guarantee of +// a specific time after the recovery window for the permanent delete to occur. At // any time before recovery window ends, you can use RestoreSecret to remove the // DeletionDate and cancel the deletion of the secret. When a secret is scheduled // for deletion, you cannot retrieve the secret value. You must first cancel the // deletion with RestoreSecret and then you can retrieve the secret. Secrets // Manager generates a CloudTrail log entry when you call this action. Do not // include sensitive information in request parameters because it might be logged. -// For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:DeleteSecret. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:DeleteSecret . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error) { if params == nil { params = &DeleteSecretInput{} @@ -62,8 +59,8 @@ type DeleteSecretInput struct { // The ARN or name of the secret to delete. For an ARN, we recommend that you // specify a complete ARN rather than a partial ARN. See Finding a secret from a - // partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -96,9 +93,9 @@ type DeleteSecretOutput struct { // The ARN of the secret. ARN *string - // The date and time after which this secret Secrets Manager can permanently delete - // this secret, and it can no longer be restored. This value is the date and time - // of the delete request plus the number of days in RecoveryWindowInDays. + // The date and time after which this secret Secrets Manager can permanently + // delete this secret, and it can no longer be restored. This value is the date and + // time of the delete request plus the number of days in RecoveryWindowInDays . DeletionDate *time.Time // The name of the secret. diff --git a/service/secretsmanager/api_op_DescribeSecret.go b/service/secretsmanager/api_op_DescribeSecret.go index 4a73673fa67..aa386a87030 100644 --- a/service/secretsmanager/api_op_DescribeSecret.go +++ b/service/secretsmanager/api_op_DescribeSecret.go @@ -16,13 +16,11 @@ import ( // value. Secrets Manager only returns fields that have a value in the response. // Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:DescribeSecret. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:DescribeSecret . For more information, +// see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error) { if params == nil { params = &DescribeSecretInput{} @@ -41,8 +39,8 @@ func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput type DescribeSecretInput struct { // The ARN or name of the secret. For an ARN, we recommend that you specify a - // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -64,7 +62,7 @@ type DescribeSecretOutput struct { // time after the deleted date, Secrets Manager deletes the secret, including all // of its versions. If a secret is scheduled for deletion, then its details, // including the encrypted secret value, is not accessible. To cancel a scheduled - // deletion and restore access to the secret, use RestoreSecret. + // deletion and restore access to the secret, use RestoreSecret . DeletedDate *time.Time // The description of the secret. @@ -72,8 +70,8 @@ type DescribeSecretOutput struct { // The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the // secret value. If the secret is encrypted with the Amazon Web Services managed - // key aws/secretsmanager, this field is omitted. Secrets created using the console - // use an KMS key ID. + // key aws/secretsmanager , this field is omitted. Secrets created using the + // console use an KMS key ID. KmsKeyId *string // The date that the secret was last accessed in the Region. This field is omitted @@ -96,28 +94,23 @@ type DescribeSecretOutput struct { NextRotationDate *time.Time // The ID of the service that created this secret. For more information, see - // Secrets managed by other Amazon Web Services services - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html). + // Secrets managed by other Amazon Web Services services (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html) + // . OwningService *string // The Region the secret is in. If a secret is replicated to other Regions, the - // replicas are listed in ReplicationStatus. + // replicas are listed in ReplicationStatus . PrimaryRegion *string // A list of the replicas of this secret and their status: - // - // * Failed, which - // indicates that the replica was not created. - // - // * InProgress, which indicates that - // Secrets Manager is in the process of creating the replica. - // - // * InSync, which - // indicates that the replica was created. + // - Failed , which indicates that the replica was not created. + // - InProgress , which indicates that Secrets Manager is in the process of + // creating the replica. + // - InSync , which indicates that the replica was created. ReplicationStatus []types.ReplicationStatusType // Specifies whether automatic rotation is turned on for this secret. To turn on - // rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret. + // rotation, use RotateSecret . To turn off rotation, use CancelRotateSecret . RotationEnabled *bool // The ARN of the Lambda function that Secrets Manager invokes to rotate the @@ -131,30 +124,24 @@ type DescribeSecretOutput struct { RotationRules *types.RotationRulesType // The list of tags attached to the secret. To add tags to a secret, use - // TagResource. To remove tags, use UntagResource. + // TagResource . To remove tags, use UntagResource . Tags []types.Tag - // A list of the versions of the secret that have staging labels attached. Versions - // that don't have staging labels are considered deprecated and Secrets Manager can - // delete them. Secrets Manager uses staging labels to indicate the status of a - // secret version during rotation. The three staging labels for rotation are: - // - // * - // AWSCURRENT, which indicates the current version of the secret. - // - // * AWSPENDING, - // which indicates the version of the secret that contains new secret information - // that will become the next current version when rotation finishes. During - // rotation, Secrets Manager creates an AWSPENDING version ID before creating the - // new secret version. To check if a secret version exists, call GetSecretValue. - // - // * - // AWSPREVIOUS, which indicates the previous current version of the secret. You can - // use this as the last known good version. - // - // For more information about rotation - // and staging labels, see How rotation works - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html). + // A list of the versions of the secret that have staging labels attached. + // Versions that don't have staging labels are considered deprecated and Secrets + // Manager can delete them. Secrets Manager uses staging labels to indicate the + // status of a secret version during rotation. The three staging labels for + // rotation are: + // - AWSCURRENT , which indicates the current version of the secret. + // - AWSPENDING , which indicates the version of the secret that contains new + // secret information that will become the next current version when rotation + // finishes. During rotation, Secrets Manager creates an AWSPENDING version ID + // before creating the new secret version. To check if a secret version exists, + // call GetSecretValue . + // - AWSPREVIOUS , which indicates the previous current version of the secret. + // You can use this as the last known good version. + // For more information about rotation and staging labels, see How rotation works (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) + // . VersionIdsToStages map[string][]string // Metadata pertaining to the operation's result. diff --git a/service/secretsmanager/api_op_GetRandomPassword.go b/service/secretsmanager/api_op_GetRandomPassword.go index 6116f185852..69ecc48c76c 100644 --- a/service/secretsmanager/api_op_GetRandomPassword.go +++ b/service/secretsmanager/api_op_GetRandomPassword.go @@ -15,13 +15,11 @@ import ( // for can support. Secrets Manager generates a CloudTrail log entry when you call // this action. Do not include sensitive information in request parameters because // it might be logged. For more information, see Logging Secrets Manager events -// with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:GetRandomPassword. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:GetRandomPassword . For more information, +// see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) GetRandomPassword(ctx context.Context, params *GetRandomPasswordInput, optFns ...func(*Options)) (*GetRandomPasswordOutput, error) { if params == nil { params = &GetRandomPasswordInput{} @@ -51,7 +49,7 @@ type GetRandomPasswordInput struct { ExcludeNumbers *bool // Specifies whether to exclude the following punctuation characters from the - // password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If + // password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ . If // you don't include this switch, the password can contain punctuation. ExcludePunctuation *bool diff --git a/service/secretsmanager/api_op_GetResourcePolicy.go b/service/secretsmanager/api_op_GetResourcePolicy.go index 4f7f54705ce..6ff73efc6f3 100644 --- a/service/secretsmanager/api_op_GetResourcePolicy.go +++ b/service/secretsmanager/api_op_GetResourcePolicy.go @@ -12,17 +12,14 @@ import ( // Retrieves the JSON text of the resource-based policy document attached to the // secret. For more information about permissions policies attached to a secret, -// see Permissions policies attached to a secret -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html). -// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// see Permissions policies attached to a secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html) +// . Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:GetResourcePolicy. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:GetResourcePolicy . For more information, +// see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { if params == nil { params = &GetResourcePolicyInput{} @@ -42,8 +39,8 @@ type GetResourcePolicyInput struct { // The ARN or name of the secret to retrieve the attached resource-based policy // for. For an ARN, we recommend that you specify a complete ARN rather than a - // partial ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // partial ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -61,8 +58,8 @@ type GetResourcePolicyOutput struct { // A JSON-formatted string that contains the permissions policy attached to the // secret. For more information about permissions policies, see Authentication and - // access control for Secrets Manager - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). + // access control for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) + // . ResourcePolicy *string // Metadata pertaining to the operation's result. diff --git a/service/secretsmanager/api_op_GetSecretValue.go b/service/secretsmanager/api_op_GetSecretValue.go index 20d01928f86..496fc0da188 100644 --- a/service/secretsmanager/api_op_GetSecretValue.go +++ b/service/secretsmanager/api_op_GetSecretValue.go @@ -11,27 +11,23 @@ import ( "time" ) -// Retrieves the contents of the encrypted fields SecretString or SecretBinary from -// the specified version of a secret, whichever contains content. We recommend that -// you cache your secret values by using client-side caching. Caching secrets +// Retrieves the contents of the encrypted fields SecretString or SecretBinary +// from the specified version of a secret, whichever contains content. We recommend +// that you cache your secret values by using client-side caching. Caching secrets // improves speed and reduces your costs. For more information, see Cache secrets -// for your applications -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html). -// To retrieve the previous version of a secret, use VersionStage and specify +// for your applications (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html) +// . To retrieve the previous version of a secret, use VersionStage and specify // AWSPREVIOUS. To revert to the previous version of a secret, call -// UpdateSecretVersionStage -// (https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html). -// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// UpdateSecretVersionStage (https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html) +// . Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:GetSecretValue. If the secret is encrypted -// using a customer-managed key instead of the Amazon Web Services managed key -// aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For -// more information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:GetSecretValue . If the secret is +// encrypted using a customer-managed key instead of the Amazon Web Services +// managed key aws/secretsmanager , then you also need kms:Decrypt permissions for +// that key. For more information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) GetSecretValue(ctx context.Context, params *GetSecretValueInput, optFns ...func(*Options)) (*GetSecretValueOutput, error) { if params == nil { params = &GetSecretValueInput{} @@ -51,25 +47,25 @@ type GetSecretValueInput struct { // The ARN or name of the secret to retrieve. For an ARN, we recommend that you // specify a complete ARN rather than a partial ARN. See Finding a secret from a - // partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string // The unique identifier of the version of the secret to retrieve. If you include - // both this parameter and VersionStage, the two parameters must refer to the same - // secret version. If you don't specify either a VersionStage or VersionId, then + // both this parameter and VersionStage , the two parameters must refer to the same + // secret version. If you don't specify either a VersionStage or VersionId , then // Secrets Manager returns the AWSCURRENT version. This value is typically a // UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier) value with // 32 hexadecimal digits. VersionId *string - // The staging label of the version of the secret to retrieve. Secrets Manager uses - // staging labels to keep track of different versions during the rotation process. - // If you include both this parameter and VersionId, the two parameters must refer - // to the same secret version. If you don't specify either a VersionStage or - // VersionId, Secrets Manager returns the AWSCURRENT version. + // The staging label of the version of the secret to retrieve. Secrets Manager + // uses staging labels to keep track of different versions during the rotation + // process. If you include both this parameter and VersionId , the two parameters + // must refer to the same secret version. If you don't specify either a + // VersionStage or VersionId , Secrets Manager returns the AWSCURRENT version. VersionStage *string noSmithyDocumentSerde @@ -81,7 +77,7 @@ type GetSecretValueOutput struct { ARN *string // The date and time that this version of the secret was created. If you don't - // specify which version in VersionId or VersionStage, then Secrets Manager uses + // specify which version in VersionId or VersionStage , then Secrets Manager uses // the AWSCURRENT version. CreatedDate *time.Time diff --git a/service/secretsmanager/api_op_ListSecretVersionIds.go b/service/secretsmanager/api_op_ListSecretVersionIds.go index ee50ebc308b..38a675e4643 100644 --- a/service/secretsmanager/api_op_ListSecretVersionIds.go +++ b/service/secretsmanager/api_op_ListSecretVersionIds.go @@ -13,19 +13,16 @@ import ( ) // Lists the versions of a secret. Secrets Manager uses staging labels to indicate -// the different versions of a secret. For more information, see Secrets Manager -// concepts: Versions -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version). -// To list the secrets in the account, use ListSecrets. Secrets Manager generates a -// CloudTrail log entry when you call this action. Do not include sensitive -// information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:ListSecretVersionIds. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// the different versions of a secret. For more information, see Secrets Manager +// concepts: Versions (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version) +// . To list the secrets in the account, use ListSecrets . Secrets Manager +// generates a CloudTrail log entry when you call this action. Do not include +// sensitive information in request parameters because it might be logged. For more +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:ListSecretVersionIds . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVersionIdsInput, optFns ...func(*Options)) (*ListSecretVersionIdsOutput, error) { if params == nil { params = &ListSecretVersionIdsInput{} @@ -44,9 +41,9 @@ func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVer type ListSecretVersionIdsInput struct { // The ARN or name of the secret whose versions you want to list. For an ARN, we - // recommend that you specify a complete ARN rather than a partial ARN. See Finding - // a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // recommend that you specify a complete ARN rather than a partial ARN. See + // Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -57,13 +54,13 @@ type ListSecretVersionIdsInput struct { IncludeDeprecated *bool // The number of results to include in the response. If there are more results - // available, in the response, Secrets Manager includes NextToken. To get the next - // results, call ListSecretVersionIds again with the value from NextToken. + // available, in the response, Secrets Manager includes NextToken . To get the next + // results, call ListSecretVersionIds again with the value from NextToken . MaxResults *int32 - // A token that indicates where the output should continue from, if a previous call - // did not show all results. To get the next results, call ListSecretVersionIds - // again with this value. + // A token that indicates where the output should continue from, if a previous + // call did not show all results. To get the next results, call + // ListSecretVersionIds again with this value. NextToken *string noSmithyDocumentSerde @@ -167,8 +164,8 @@ var _ ListSecretVersionIdsAPIClient = (*Client)(nil) // ListSecretVersionIds type ListSecretVersionIdsPaginatorOptions struct { // The number of results to include in the response. If there are more results - // available, in the response, Secrets Manager includes NextToken. To get the next - // results, call ListSecretVersionIds again with the value from NextToken. + // available, in the response, Secrets Manager includes NextToken . To get the next + // results, call ListSecretVersionIds again with the value from NextToken . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/secretsmanager/api_op_ListSecrets.go b/service/secretsmanager/api_op_ListSecrets.go index 50c6a25fbb6..a21326b8dfe 100644 --- a/service/secretsmanager/api_op_ListSecrets.go +++ b/service/secretsmanager/api_op_ListSecrets.go @@ -16,20 +16,17 @@ import ( // account, not including secrets that are marked for deletion. To see secrets // marked for deletion, use the Secrets Manager console. ListSecrets is eventually // consistent, however it might not reflect changes from the last five minutes. To -// get the latest information for a specific secret, use DescribeSecret. To list -// the versions of a secret, use ListSecretVersionIds. To get the secret value from -// SecretString or SecretBinary, call GetSecretValue. For information about finding -// secrets in the console, see Find secrets in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html). -// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// get the latest information for a specific secret, use DescribeSecret . To list +// the versions of a secret, use ListSecretVersionIds . To get the secret value +// from SecretString or SecretBinary , call GetSecretValue . For information about +// finding secrets in the console, see Find secrets in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html) +// . Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:ListSecrets. For more information, see IAM -// policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:ListSecrets . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) ListSecrets(ctx context.Context, params *ListSecretsInput, optFns ...func(*Options)) (*ListSecretsOutput, error) { if params == nil { params = &ListSecretsInput{} @@ -54,16 +51,16 @@ type ListSecretsInput struct { IncludePlannedDeletion *bool // The number of results to include in the response. If there are more results - // available, in the response, Secrets Manager includes NextToken. To get the next - // results, call ListSecrets again with the value from NextToken. + // available, in the response, Secrets Manager includes NextToken . To get the next + // results, call ListSecrets again with the value from NextToken . MaxResults *int32 - // A token that indicates where the output should continue from, if a previous call - // did not show all results. To get the next results, call ListSecrets again with - // this value. + // A token that indicates where the output should continue from, if a previous + // call did not show all results. To get the next results, call ListSecrets again + // with this value. NextToken *string - // Secrets are listed by CreatedDate. + // Secrets are listed by CreatedDate . SortOrder types.SortOrderType noSmithyDocumentSerde @@ -156,8 +153,8 @@ var _ ListSecretsAPIClient = (*Client)(nil) // ListSecretsPaginatorOptions is the paginator options for ListSecrets type ListSecretsPaginatorOptions struct { // The number of results to include in the response. If there are more results - // available, in the response, Secrets Manager includes NextToken. To get the next - // results, call ListSecrets again with the value from NextToken. + // available, in the response, Secrets Manager includes NextToken . To get the next + // results, call ListSecrets again with the value from NextToken . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/secretsmanager/api_op_PutResourcePolicy.go b/service/secretsmanager/api_op_PutResourcePolicy.go index ae8d1081902..7872b0a7bf6 100644 --- a/service/secretsmanager/api_op_PutResourcePolicy.go +++ b/service/secretsmanager/api_op_PutResourcePolicy.go @@ -10,22 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a resource-based permission policy to a secret. A resource-based policy -// is optional. For more information, see Authentication and access control for -// Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// Attaches a resource-based permission policy to a secret. A resource-based +// policy is optional. For more information, see Authentication and access control +// for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) // For information about attaching a policy in the console, see Attach a -// permissions policy to a secret -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html). -// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// permissions policy to a secret (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html) +// . Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:PutResourcePolicy. For more information, -// see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:PutResourcePolicy . For more information, +// see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -44,16 +40,16 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { // A JSON-formatted string for an Amazon Web Services resource-based policy. For - // example policies, see Permissions policy examples - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html). + // example policies, see Permissions policy examples (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html) + // . // // This member is required. ResourcePolicy *string // The ARN or name of the secret to attach the resource-based policy. For an ARN, // we recommend that you specify a complete ARN rather than a partial ARN. See - // Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string diff --git a/service/secretsmanager/api_op_PutSecretValue.go b/service/secretsmanager/api_op_PutSecretValue.go index 0c0240b6de9..1ea7b185814 100644 --- a/service/secretsmanager/api_op_PutSecretValue.go +++ b/service/secretsmanager/api_op_PutSecretValue.go @@ -13,34 +13,32 @@ import ( // Creates a new version with a new encrypted secret value and attaches it to the // secret. The version can contain a new SecretString value or a new SecretBinary -// value. We recommend you avoid calling PutSecretValue at a sustained rate of more -// than once every 10 minutes. When you update the secret value, Secrets Manager -// creates a new version of the secret. Secrets Manager removes outdated versions -// when there are more than 100, but it does not remove versions created less than -// 24 hours ago. If you call PutSecretValue more than once every 10 minutes, you -// create more versions than Secrets Manager removes, and you will reach the quota -// for secret versions. You can specify the staging labels to attach to the new -// version in VersionStages. If you don't include VersionStages, then Secrets -// Manager automatically moves the staging label AWSCURRENT to this version. If -// this operation creates the first version for the secret, then Secrets Manager -// automatically attaches the staging label AWSCURRENT to it. If this operation -// moves the staging label AWSCURRENT from another version to this version, then -// Secrets Manager also automatically moves the staging label AWSPREVIOUS to the -// version that AWSCURRENT was removed from. This operation is idempotent. If you -// call this operation with a ClientRequestToken that matches an existing version's -// VersionId, and you specify the same secret data, the operation succeeds but does -// nothing. However, if the secret data is different, then the operation fails -// because you can't modify an existing version; you can only create new ones. -// Secrets Manager generates a CloudTrail log entry when you call this action. Do -// not include sensitive information in request parameters except SecretBinary or -// SecretString because it might be logged. For more information, see Logging -// Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:PutSecretValue. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// value. We recommend you avoid calling PutSecretValue at a sustained rate of +// more than once every 10 minutes. When you update the secret value, Secrets +// Manager creates a new version of the secret. Secrets Manager removes outdated +// versions when there are more than 100, but it does not remove versions created +// less than 24 hours ago. If you call PutSecretValue more than once every 10 +// minutes, you create more versions than Secrets Manager removes, and you will +// reach the quota for secret versions. You can specify the staging labels to +// attach to the new version in VersionStages . If you don't include VersionStages +// , then Secrets Manager automatically moves the staging label AWSCURRENT to this +// version. If this operation creates the first version for the secret, then +// Secrets Manager automatically attaches the staging label AWSCURRENT to it. If +// this operation moves the staging label AWSCURRENT from another version to this +// version, then Secrets Manager also automatically moves the staging label +// AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is +// idempotent. If you call this operation with a ClientRequestToken that matches +// an existing version's VersionId, and you specify the same secret data, the +// operation succeeds but does nothing. However, if the secret data is different, +// then the operation fails because you can't modify an existing version; you can +// only create new ones. Secrets Manager generates a CloudTrail log entry when you +// call this action. Do not include sensitive information in request parameters +// except SecretBinary or SecretString because it might be logged. For more +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:PutSecretValue . For more information, +// see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) PutSecretValue(ctx context.Context, params *PutSecretValueInput, optFns ...func(*Options)) (*PutSecretValueOutput, error) { if params == nil { params = &PutSecretValueInput{} @@ -60,52 +58,45 @@ type PutSecretValueInput struct { // The ARN or name of the secret to add a new version to. For an ARN, we recommend // that you specify a complete ARN rather than a partial ARN. See Finding a secret - // from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). - // If the secret doesn't already exist, use CreateSecret instead. + // from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . If the secret doesn't already exist, use CreateSecret instead. // // This member is required. SecretId *string - // A unique identifier for the new version of the secret. If you use the Amazon Web - // Services CLI or one of the Amazon Web Services SDKs to call this operation, then - // you can leave this parameter empty because they generate a random UUID for you. - // If you don't use the SDK and instead generate a raw HTTP request to the Secrets - // Manager service endpoint, then you must generate a ClientRequestToken yourself - // for new versions and include that value in the request. This value helps ensure - // idempotency. Secrets Manager uses this value to prevent the accidental creation - // of duplicate versions if there are failures and retries during the Lambda - // rotation function processing. We recommend that you generate a UUID-type - // (https://wikipedia.org/wiki/Universally_unique_identifier) value to ensure - // uniqueness within the specified secret. - // - // * If the ClientRequestToken value isn't - // already associated with a version of the secret then a new version of the secret - // is created. - // - // * If a version with this value already exists and that version's - // SecretString or SecretBinary values are the same as those in the request then - // the request is ignored. The operation is idempotent. - // - // * If a version with this - // value already exists and the version of the SecretString and SecretBinary values - // are different from those in the request, then the request fails because you - // can't modify a secret version. You can only create new versions to store new - // secret values. - // + // A unique identifier for the new version of the secret. If you use the Amazon + // Web Services CLI or one of the Amazon Web Services SDKs to call this operation, + // then you can leave this parameter empty because they generate a random UUID for + // you. If you don't use the SDK and instead generate a raw HTTP request to the + // Secrets Manager service endpoint, then you must generate a ClientRequestToken + // yourself for new versions and include that value in the request. This value + // helps ensure idempotency. Secrets Manager uses this value to prevent the + // accidental creation of duplicate versions if there are failures and retries + // during the Lambda rotation function processing. We recommend that you generate a + // UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier) value to + // ensure uniqueness within the specified secret. + // - If the ClientRequestToken value isn't already associated with a version of + // the secret then a new version of the secret is created. + // - If a version with this value already exists and that version's SecretString + // or SecretBinary values are the same as those in the request then the request + // is ignored. The operation is idempotent. + // - If a version with this value already exists and the version of the + // SecretString and SecretBinary values are different from those in the request, + // then the request fails because you can't modify a secret version. You can only + // create new versions to store new secret values. // This value becomes the VersionId of the new version. ClientRequestToken *string // The binary data to encrypt and store in the new version of the secret. To use // this parameter in the command-line tools, we recommend that you store your // binary data in a file and then pass the contents of the file as a parameter. You - // must include SecretBinary or SecretString, but not both. You can't access this + // must include SecretBinary or SecretString , but not both. You can't access this // value from the Secrets Manager console. SecretBinary []byte - // The text to encrypt and store in the new version of the secret. You must include - // SecretBinary or SecretString, but not both. We recommend you create the secret - // string as JSON key/value pairs, as shown in the example. + // The text to encrypt and store in the new version of the secret. You must + // include SecretBinary or SecretString , but not both. We recommend you create the + // secret string as JSON key/value pairs, as shown in the example. SecretString *string // A list of staging labels to attach to this version of the secret. Secrets @@ -113,9 +104,9 @@ type PutSecretValueInput struct { // process. If you specify a staging label that's already associated with a // different version of the same secret, then Secrets Manager removes the label // from the other version and attaches it to this version. If you specify - // AWSCURRENT, and it is already attached to another version, then Secrets Manager + // AWSCURRENT , and it is already attached to another version, then Secrets Manager // also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was - // removed from. If you don't include VersionStages, then Secrets Manager + // removed from. If you don't include VersionStages , then Secrets Manager // automatically moves the staging label AWSCURRENT to this version. VersionStages []string diff --git a/service/secretsmanager/api_op_RemoveRegionsFromReplication.go b/service/secretsmanager/api_op_RemoveRegionsFromReplication.go index f798d94b71f..a25ff07c0a9 100644 --- a/service/secretsmanager/api_op_RemoveRegionsFromReplication.go +++ b/service/secretsmanager/api_op_RemoveRegionsFromReplication.go @@ -14,14 +14,12 @@ import ( // For a secret that is replicated to other Regions, deletes the secret replicas // from the Regions you specify. Secrets Manager generates a CloudTrail log entry // when you call this action. Do not include sensitive information in request -// parameters because it might be logged. For more information, see Logging Secrets -// Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:RemoveRegionsFromReplication. For more -// information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// parameters because it might be logged. For more information, see Logging +// Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:RemoveRegionsFromReplication . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) RemoveRegionsFromReplication(ctx context.Context, params *RemoveRegionsFromReplicationInput, optFns ...func(*Options)) (*RemoveRegionsFromReplicationOutput, error) { if params == nil { params = &RemoveRegionsFromReplicationInput{} diff --git a/service/secretsmanager/api_op_ReplicateSecretToRegions.go b/service/secretsmanager/api_op_ReplicateSecretToRegions.go index f0e56594efa..dcd3ea62465 100644 --- a/service/secretsmanager/api_op_ReplicateSecretToRegions.go +++ b/service/secretsmanager/api_op_ReplicateSecretToRegions.go @@ -11,17 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replicates the secret to a new Regions. See Multi-Region secrets -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html). -// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// Replicates the secret to a new Regions. See Multi-Region secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html) +// . Secrets Manager generates a CloudTrail log entry when you call this action. Do // not include sensitive information in request parameters because it might be -// logged. For more information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:ReplicateSecretToRegions. For more -// information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:ReplicateSecretToRegions . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) ReplicateSecretToRegions(ctx context.Context, params *ReplicateSecretToRegionsInput, optFns ...func(*Options)) (*ReplicateSecretToRegionsOutput, error) { if params == nil { params = &ReplicateSecretToRegionsInput{} diff --git a/service/secretsmanager/api_op_RestoreSecret.go b/service/secretsmanager/api_op_RestoreSecret.go index 4acd15ea29e..b276b8f0165 100644 --- a/service/secretsmanager/api_op_RestoreSecret.go +++ b/service/secretsmanager/api_op_RestoreSecret.go @@ -14,13 +14,11 @@ import ( // stamp. You can access a secret again after it has been restored. Secrets Manager // generates a CloudTrail log entry when you call this action. Do not include // sensitive information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:RestoreSecret. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:RestoreSecret . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) RestoreSecret(ctx context.Context, params *RestoreSecretInput, optFns ...func(*Options)) (*RestoreSecretOutput, error) { if params == nil { params = &RestoreSecretInput{} @@ -40,8 +38,8 @@ type RestoreSecretInput struct { // The ARN or name of the secret to restore. For an ARN, we recommend that you // specify a complete ARN rather than a partial ARN. See Finding a secret from a - // partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string diff --git a/service/secretsmanager/api_op_RotateSecret.go b/service/secretsmanager/api_op_RotateSecret.go index 51ad8a1c8a1..e05fa89b4ab 100644 --- a/service/secretsmanager/api_op_RotateSecret.go +++ b/service/secretsmanager/api_op_RotateSecret.go @@ -13,8 +13,7 @@ import ( ) // Configures and starts the asynchronous process of rotating the secret. For -// information about rotation, see Rotate secrets -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) +// information about rotation, see Rotate secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) // in the Secrets Manager User Guide. If you include the configuration parameters, // the operation sets the values for the secret and then immediately starts a // rotation. If you don't include the configuration parameters, the operation @@ -22,24 +21,20 @@ import ( // successful, the AWSPENDING staging label might be attached to the same version // as the AWSCURRENT version, or it might not be attached to any version. If the // AWSPENDING staging label is present but not attached to the same version as -// AWSCURRENT, then any later invocation of RotateSecret assumes that a previous +// AWSCURRENT , then any later invocation of RotateSecret assumes that a previous // rotation request is still in progress and returns an error. When rotation is // unsuccessful, the AWSPENDING staging label might be attached to an empty secret -// version. For more information, see Troubleshoot rotation -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html) +// version. For more information, see Troubleshoot rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html) // in the Secrets Manager User Guide. Secrets Manager generates a CloudTrail log // entry when you call this action. Do not include sensitive information in request -// parameters because it might be logged. For more information, see Logging Secrets -// Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:RotateSecret. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). -// You also need lambda:InvokeFunction permissions on the rotation function. For -// more information, see Permissions for rotation -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html). +// parameters because it might be logged. For more information, see Logging +// Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:RotateSecret . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . You also need lambda:InvokeFunction permissions on the rotation function. For +// more information, see Permissions for rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html) +// . func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, optFns ...func(*Options)) (*RotateSecretOutput, error) { if params == nil { params = &RotateSecretInput{} @@ -59,8 +54,8 @@ type RotateSecretInput struct { // The ARN or name of the secret to rotate. For an ARN, we recommend that you // specify a complete ARN rather than a partial ARN. See Finding a secret from a - // partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -83,19 +78,17 @@ type RotateSecretInput struct { // Specifies whether to rotate the secret immediately or wait until the next // scheduled rotation window. The rotation schedule is defined in - // RotateSecretRequest$RotationRules. For secrets that use a Lambda rotation + // RotateSecretRequest$RotationRules . For secrets that use a Lambda rotation // function to rotate, if you don't immediately rotate the secret, Secrets Manager - // tests the rotation configuration by running the testSecret step - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) + // tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) // of the Lambda rotation function. The test creates an AWSPENDING version of the // secret and then removes it. If you don't specify this value, then by default, // Secrets Manager rotates the secret immediately. RotateImmediately *bool - // For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda - // rotation function. For secrets that use managed rotation, omit this field. For - // more information, see Managed rotation - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html) + // For secrets that use a Lambda rotation function to rotate, the ARN of the + // Lambda rotation function. For secrets that use managed rotation, omit this + // field. For more information, see Managed rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html) // in the Secrets Manager User Guide. RotationLambdaARN *string diff --git a/service/secretsmanager/api_op_StopReplicationToReplica.go b/service/secretsmanager/api_op_StopReplicationToReplica.go index ba5e9fca813..19a7c7286a3 100644 --- a/service/secretsmanager/api_op_StopReplicationToReplica.go +++ b/service/secretsmanager/api_op_StopReplicationToReplica.go @@ -16,13 +16,11 @@ import ( // secret. Secrets Manager generates a CloudTrail log entry when you call this // action. Do not include sensitive information in request parameters because it // might be logged. For more information, see Logging Secrets Manager events with -// CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:StopReplicationToReplica. For more -// information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:StopReplicationToReplica . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) StopReplicationToReplica(ctx context.Context, params *StopReplicationToReplicaInput, optFns ...func(*Options)) (*StopReplicationToReplicaOutput, error) { if params == nil { params = &StopReplicationToReplicaInput{} diff --git a/service/secretsmanager/api_op_TagResource.go b/service/secretsmanager/api_op_TagResource.go index 568617d1a13..6710b171c11 100644 --- a/service/secretsmanager/api_op_TagResource.go +++ b/service/secretsmanager/api_op_TagResource.go @@ -11,46 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches tags to a secret. Tags consist of a key name and a value. Tags are part -// of the secret's metadata. They are not associated with specific versions of the -// secret. This operation appends tags to the existing list of tags. The following -// restrictions apply to tags: +// Attaches tags to a secret. Tags consist of a key name and a value. Tags are +// part of the secret's metadata. They are not associated with specific versions of +// the secret. This operation appends tags to the existing list of tags. The +// following restrictions apply to tags: +// - Maximum number of tags per secret: 50 +// - Maximum key length: 127 Unicode characters in UTF-8 +// - Maximum value length: 255 Unicode characters in UTF-8 +// - Tag keys and values are case sensitive. +// - Do not use the aws: prefix in your tag names or values because Amazon Web +// Services reserves it for Amazon Web Services use. You can't edit or delete tag +// names or values with this prefix. Tags with this prefix do not count against +// your tags per secret limit. +// - If you use your tagging schema across multiple services and resources, +// other services might have restrictions on allowed characters. Generally allowed +// characters: letters, spaces, and numbers representable in UTF-8, plus the +// following special characters: + - = . _ : / @. // -// * Maximum number of tags per secret: 50 -// -// * Maximum -// key length: 127 Unicode characters in UTF-8 -// -// * Maximum value length: 255 Unicode -// characters in UTF-8 -// -// * Tag keys and values are case sensitive. -// -// * Do not use the -// aws: prefix in your tag names or values because Amazon Web Services reserves it -// for Amazon Web Services use. You can't edit or delete tag names or values with -// this prefix. Tags with this prefix do not count against your tags per secret -// limit. -// -// * If you use your tagging schema across multiple services and resources, -// other services might have restrictions on allowed characters. Generally allowed -// characters: letters, spaces, and numbers representable in UTF-8, plus the -// following special characters: + - = . _ : / @. -// -// If you use tags as part of your -// security strategy, then adding or removing a tag can change permissions. If -// successfully completing this operation would result in you losing your -// permissions for this secret, then the operation is blocked and returns an Access -// Denied error. Secrets Manager generates a CloudTrail log entry when you call -// this action. Do not include sensitive information in request parameters because -// it might be logged. For more information, see Logging Secrets Manager events -// with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:TagResource. For more information, see IAM -// policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// If you use tags as part of your security strategy, then adding or removing a +// tag can change permissions. If successfully completing this operation would +// result in you losing your permissions for this secret, then the operation is +// blocked and returns an Access Denied error. Secrets Manager generates a +// CloudTrail log entry when you call this action. Do not include sensitive +// information in request parameters because it might be logged. For more +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:TagResource . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -70,20 +58,19 @@ type TagResourceInput struct { // The identifier for the secret to attach tags to. You can specify either the // Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we - // recommend that you specify a complete ARN rather than a partial ARN. See Finding - // a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // recommend that you specify a complete ARN rather than a partial ARN. See + // Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string - // The tags to attach to the secret as a JSON text string argument. Each element in - // the list consists of a Key and a Value. For storing multiple values, we + // The tags to attach to the secret as a JSON text string argument. Each element + // in the list consists of a Key and a Value . For storing multiple values, we // recommend that you use a JSON text string argument and specify key/value pairs. // For more information, see Specifying parameter values for the Amazon Web - // Services CLI - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) in - // the Amazon Web Services CLI User Guide. + // Services CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) + // in the Amazon Web Services CLI User Guide. // // This member is required. Tags []types.Tag diff --git a/service/secretsmanager/api_op_UntagResource.go b/service/secretsmanager/api_op_UntagResource.go index bdf6b3c4eb1..924c3ceb794 100644 --- a/service/secretsmanager/api_op_UntagResource.go +++ b/service/secretsmanager/api_op_UntagResource.go @@ -18,13 +18,11 @@ import ( // is blocked and returns an Access Denied error. Secrets Manager generates a // CloudTrail log entry when you call this action. Do not include sensitive // information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:UntagResource. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:UntagResource . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -43,8 +41,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The ARN or name of the secret. For an ARN, we recommend that you specify a - // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string @@ -53,9 +51,8 @@ type UntagResourceInput struct { // Both the key and its associated value are removed. This parameter requires a // JSON text string argument. For storing multiple values, we recommend that you // use a JSON text string argument and specify key/value pairs. For more - // information, see Specifying parameter values for the Amazon Web Services CLI - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) in - // the Amazon Web Services CLI User Guide. + // information, see Specifying parameter values for the Amazon Web Services CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html) + // in the Amazon Web Services CLI User Guide. // // This member is required. TagKeys []string diff --git a/service/secretsmanager/api_op_UpdateSecret.go b/service/secretsmanager/api_op_UpdateSecret.go index 6a33805ec24..b222f19bfcf 100644 --- a/service/secretsmanager/api_op_UpdateSecret.go +++ b/service/secretsmanager/api_op_UpdateSecret.go @@ -12,13 +12,12 @@ import ( ) // Modifies the details of a secret, including metadata and the secret value. To -// change the secret value, you can also use PutSecretValue. To change the rotation -// configuration of a secret, use RotateSecret instead. To change a secret so that -// it is managed by another service, you need to recreate the secret in that -// service. See Secrets Manager secrets managed by other Amazon Web Services -// services -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html). -// We recommend you avoid calling UpdateSecret at a sustained rate of more than +// change the secret value, you can also use PutSecretValue . To change the +// rotation configuration of a secret, use RotateSecret instead. To change a +// secret so that it is managed by another service, you need to recreate the secret +// in that service. See Secrets Manager secrets managed by other Amazon Web +// Services services (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html) +// . We recommend you avoid calling UpdateSecret at a sustained rate of more than // once every 10 minutes. When you call UpdateSecret to update the secret value, // Secrets Manager creates a new version of the secret. Secrets Manager removes // outdated versions when there are more than 100, but it does not remove versions @@ -28,24 +27,20 @@ import ( // SecretBinary to create a new secret version, Secrets Manager automatically moves // the staging label AWSCURRENT to the new version. Then it attaches the label // AWSPREVIOUS to the version that AWSCURRENT was removed from. If you call this -// operation with a ClientRequestToken that matches an existing version's -// VersionId, the operation results in an error. You can't modify an existing -// version, you can only create a new version. To remove a version, remove all -// staging labels from it. See UpdateSecretVersionStage. Secrets Manager generates -// a CloudTrail log entry when you call this action. Do not include sensitive -// information in request parameters except SecretBinary or SecretString because it -// might be logged. For more information, see Logging Secrets Manager events with -// CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:UpdateSecret. For more information, see -// IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). -// If you use a customer managed key, you must also have kms:GenerateDataKey and -// kms:Decrypt permissions on the key. For more information, see Secret encryption -// and decryption -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html). +// operation with a ClientRequestToken that matches an existing version's VersionId +// , the operation results in an error. You can't modify an existing version, you +// can only create a new version. To remove a version, remove all staging labels +// from it. See UpdateSecretVersionStage . Secrets Manager generates a CloudTrail +// log entry when you call this action. Do not include sensitive information in +// request parameters except SecretBinary or SecretString because it might be +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:UpdateSecret . For more information, see +// IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . If you use a customer managed key, you must also have kms:GenerateDataKey and +// kms:Decrypt permissions on the key. For more information, see Secret +// encryption and decryption (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html) +// . func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, optFns ...func(*Options)) (*UpdateSecretOutput, error) { if params == nil { params = &UpdateSecretInput{} @@ -64,13 +59,13 @@ func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, op type UpdateSecretInput struct { // The ARN or name of the secret. For an ARN, we recommend that you specify a - // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // complete ARN rather than a partial ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string - // If you include SecretString or SecretBinary, then Secrets Manager creates a new + // If you include SecretString or SecretBinary , then Secrets Manager creates a new // version for the secret, and this parameter specifies the unique identifier for // the new version. If you use the Amazon Web Services CLI or one of the Amazon Web // Services SDKs to call this operation, then you can leave this parameter empty. @@ -86,17 +81,15 @@ type UpdateSecretInput struct { // The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt // new secret versions as well as any existing versions with the staging labels - // AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and - // staging labels, see Concepts: Version - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version). - // A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. - // For more information, see About aliases - // (https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). If you - // set this to an empty string, Secrets Manager uses the Amazon Web Services - // managed key aws/secretsmanager. If this key doesn't already exist in your - // account, then Secrets Manager creates it for you automatically. All users and - // roles in the Amazon Web Services account automatically have access to use - // aws/secretsmanager. Creating aws/secretsmanager can result in a one-time + // AWSCURRENT , AWSPENDING , or AWSPREVIOUS . For more information about versions + // and staging labels, see Concepts: Version (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version) + // . A key alias is always prefixed by alias/ , for example + // alias/aws/secretsmanager . For more information, see About aliases (https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html) + // . If you set this to an empty string, Secrets Manager uses the Amazon Web + // Services managed key aws/secretsmanager . If this key doesn't already exist in + // your account, then Secrets Manager creates it for you automatically. All users + // and roles in the Amazon Web Services account automatically have access to use + // aws/secretsmanager . Creating aws/secretsmanager can result in a one-time // significant delay in returning the result. You can only use the Amazon Web // Services managed key aws/secretsmanager if you call this operation using // credentials from the same Amazon Web Services account that owns the secret. If diff --git a/service/secretsmanager/api_op_UpdateSecretVersionStage.go b/service/secretsmanager/api_op_UpdateSecretVersionStage.go index 160f9ebbd11..08556dfb7e8 100644 --- a/service/secretsmanager/api_op_UpdateSecretVersionStage.go +++ b/service/secretsmanager/api_op_UpdateSecretVersionStage.go @@ -16,24 +16,21 @@ import ( // time. To add a staging label to a version when it is already attached to another // version, Secrets Manager first removes it from the other version first and then // attaches it to this one. For more information about versions and staging labels, -// see Concepts: Version -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version). -// The staging labels that you specify in the VersionStage parameter are added to -// the existing list of staging labels for the version. You can move the AWSCURRENT -// staging label to this version by including it in this call. Whenever you move -// AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the -// version that AWSCURRENT was removed from. If this action results in the last -// label being removed from a version, then the version is considered to be +// see Concepts: Version (https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version) +// . The staging labels that you specify in the VersionStage parameter are added +// to the existing list of staging labels for the version. You can move the +// AWSCURRENT staging label to this version by including it in this call. Whenever +// you move AWSCURRENT , Secrets Manager automatically moves the label AWSPREVIOUS +// to the version that AWSCURRENT was removed from. If this action results in the +// last label being removed from a version, then the version is considered to be // 'deprecated' and can be deleted by Secrets Manager. Secrets Manager generates a // CloudTrail log entry when you call this action. Do not include sensitive // information in request parameters because it might be logged. For more -// information, see Logging Secrets Manager events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:UpdateSecretVersionStage. For more -// information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:UpdateSecretVersionStage . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSecretVersionStageInput, optFns ...func(*Options)) (*UpdateSecretVersionStageOutput, error) { if params == nil { params = &UpdateSecretVersionStageInput{} @@ -53,8 +50,8 @@ type UpdateSecretVersionStageInput struct { // The ARN or the name of the secret with the version and staging labelsto modify. // For an ARN, we recommend that you specify a complete ARN rather than a partial - // ARN. See Finding a secret from a partial ARN - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen). + // ARN. See Finding a secret from a partial ARN (https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen) + // . // // This member is required. SecretId *string diff --git a/service/secretsmanager/api_op_ValidateResourcePolicy.go b/service/secretsmanager/api_op_ValidateResourcePolicy.go index 81e571b4826..df141e1eb31 100644 --- a/service/secretsmanager/api_op_ValidateResourcePolicy.go +++ b/service/secretsmanager/api_op_ValidateResourcePolicy.go @@ -14,28 +14,20 @@ import ( // Validates that a resource policy does not grant a wide range of principals // access to your secret. A resource-based policy is optional for secrets. The API // performs three checks when validating the policy: +// - Sends a call to Zelkova (https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/) +// , an automated reasoning engine, to ensure your resource policy does not allow +// broad access to your secret, for example policies that use a wildcard for the +// principal. +// - Checks for correct syntax in a policy. +// - Verifies the policy does not lock out a caller. // -// * Sends a call to Zelkova -// (https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/), -// an automated reasoning engine, to ensure your resource policy does not allow -// broad access to your secret, for example policies that use a wildcard for the -// principal. -// -// * Checks for correct syntax in a policy. -// -// * Verifies the policy does -// not lock out a caller. -// -// Secrets Manager generates a CloudTrail log entry when -// you call this action. Do not include sensitive information in request parameters -// because it might be logged. For more information, see Logging Secrets Manager -// events with CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html). -// Required permissions: secretsmanager:ValidateResourcePolicy. For more -// information, see IAM policy actions for Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) -// and Authentication and access control in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). +// Secrets Manager generates a CloudTrail log entry when you call this action. Do +// not include sensitive information in request parameters because it might be +// logged. For more information, see Logging Secrets Manager events with CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html) +// . Required permissions: secretsmanager:ValidateResourcePolicy . For more +// information, see IAM policy actions for Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions) +// and Authentication and access control in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) +// . func (c *Client) ValidateResourcePolicy(ctx context.Context, params *ValidateResourcePolicyInput, optFns ...func(*Options)) (*ValidateResourcePolicyOutput, error) { if params == nil { params = &ValidateResourcePolicyInput{} @@ -55,8 +47,8 @@ type ValidateResourcePolicyInput struct { // A JSON-formatted string that contains an Amazon Web Services resource-based // policy. The policy in the string identifies who can access or manage this secret - // and its versions. For example policies, see Permissions policy examples - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html). + // and its versions. For example policies, see Permissions policy examples (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html) + // . // // This member is required. ResourcePolicy *string diff --git a/service/secretsmanager/doc.go b/service/secretsmanager/doc.go index 77c97c288e5..e3e68d833d0 100644 --- a/service/secretsmanager/doc.go +++ b/service/secretsmanager/doc.go @@ -3,33 +3,29 @@ // Package secretsmanager provides the API client, operations, and parameter types // for AWS Secrets Manager. // -// Amazon Web Services Secrets Manager Amazon Web Services Secrets Manager provides -// a service to enable you to store, manage, and retrieve, secrets. This guide -// provides descriptions of the Secrets Manager API. For more information about -// using this service, see the Amazon Web Services Secrets Manager User Guide -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html). -// API Version This version of the Secrets Manager API Reference documents the +// Amazon Web Services Secrets Manager Amazon Web Services Secrets Manager +// provides a service to enable you to store, manage, and retrieve, secrets. This +// guide provides descriptions of the Secrets Manager API. For more information +// about using this service, see the Amazon Web Services Secrets Manager User Guide (https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html) +// . API Version This version of the Secrets Manager API Reference documents the // Secrets Manager API version 2017-10-17. For a list of endpoints, see Amazon Web -// Services Secrets Manager endpoints -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints). -// Support and Feedback for Amazon Web Services Secrets Manager We welcome your -// feedback. Send your comments to awssecretsmanager-feedback@amazon.com -// (mailto:awssecretsmanager-feedback@amazon.com), or post your feedback and -// questions in the Amazon Web Services Secrets Manager Discussion Forum -// (http://forums.aws.amazon.com/forum.jspa?forumID=296). For more information -// about the Amazon Web Services Discussion Forums, see Forums Help -// (http://forums.aws.amazon.com/help.jspa). Logging API Requests Amazon Web -// Services Secrets Manager supports Amazon Web Services CloudTrail, a service that -// records Amazon Web Services API calls for your Amazon Web Services account and -// delivers log files to an Amazon S3 bucket. By using information that's collected -// by Amazon Web Services CloudTrail, you can determine the requests successfully -// made to Secrets Manager, who made the request, when it was made, and so on. For -// more about Amazon Web Services Secrets Manager and support for Amazon Web -// Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with -// Amazon Web Services CloudTrail -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail) +// Services Secrets Manager endpoints (https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints) +// . Support and Feedback for Amazon Web Services Secrets Manager We welcome your +// feedback. Send your comments to awssecretsmanager-feedback@amazon.com (mailto:awssecretsmanager-feedback@amazon.com) +// , or post your feedback and questions in the Amazon Web Services Secrets +// Manager Discussion Forum (http://forums.aws.amazon.com/forum.jspa?forumID=296) . +// For more information about the Amazon Web Services Discussion Forums, see +// Forums Help (http://forums.aws.amazon.com/help.jspa) . Logging API Requests +// Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a +// service that records Amazon Web Services API calls for your Amazon Web Services +// account and delivers log files to an Amazon S3 bucket. By using information +// that's collected by Amazon Web Services CloudTrail, you can determine the +// requests successfully made to Secrets Manager, who made the request, when it was +// made, and so on. For more about Amazon Web Services Secrets Manager and support +// for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets +// Manager Events with Amazon Web Services CloudTrail (https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail) // in the Amazon Web Services Secrets Manager User Guide. To learn more about // CloudTrail, including enabling it and find your log files, see the Amazon Web -// Services CloudTrail User Guide -// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). +// Services CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html) +// . package secretsmanager diff --git a/service/secretsmanager/types/errors.go b/service/secretsmanager/types/errors.go index f9236760c16..aff130bb247 100644 --- a/service/secretsmanager/types/errors.go +++ b/service/secretsmanager/types/errors.go @@ -36,8 +36,8 @@ func (e *DecryptionFailure) ErrorFault() smithy.ErrorFault { return smithy.Fault // Secrets Manager can't encrypt the protected secret text using the provided KMS // key. Check that the KMS key is available, enabled, and not in an invalid state. -// For more information, see Key state: Effect on your KMS key -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html). +// For more information, see Key state: Effect on your KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// . type EncryptionFailure struct { Message *string @@ -143,17 +143,14 @@ func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smit // A parameter value is not valid for the current state of the resource. Possible // causes: -// -// * The secret is scheduled for deletion. -// -// * You tried to enable rotation -// on a secret that doesn't already have a Lambda function ARN configured and you -// didn't include such an ARN as a parameter in this call. -// -// * The secret is managed -// by another service, and you must use that service to update it. For more -// information, see Secrets managed by other Amazon Web Services services -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html). +// - The secret is scheduled for deletion. +// - You tried to enable rotation on a secret that doesn't already have a Lambda +// function ARN configured and you didn't include such an ARN as a parameter in +// this call. +// - The secret is managed by another service, and you must use that service to +// update it. For more information, see Secrets managed by other Amazon Web +// Services services (https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html) +// . type InvalidRequestException struct { Message *string diff --git a/service/secretsmanager/types/types.go b/service/secretsmanager/types/types.go index ae1d63a3c91..6869576a43e 100644 --- a/service/secretsmanager/types/types.go +++ b/service/secretsmanager/types/types.go @@ -8,34 +8,23 @@ import ( ) // Allows you to add filters when you use the search function in Secrets Manager. -// For more information, see Find secrets in Secrets Manager -// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html). +// For more information, see Find secrets in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html) +// . type Filter struct { // The following are keys you can use: - // - // * description: Prefix match, not - // case-sensitive. - // - // * name: Prefix match, case-sensitive. - // - // * tag-key: Prefix match, - // case-sensitive. - // - // * tag-value: Prefix match, case-sensitive. - // - // * primary-region: - // Prefix match, case-sensitive. - // - // * owning-service: Prefix match, - // case-sensitive. - // - // * all: Breaks the filter value string into words and then - // searches all attributes for matches. Not case-sensitive. + // - description: Prefix match, not case-sensitive. + // - name: Prefix match, case-sensitive. + // - tag-key: Prefix match, case-sensitive. + // - tag-value: Prefix match, case-sensitive. + // - primary-region: Prefix match, case-sensitive. + // - owning-service: Prefix match, case-sensitive. + // - all: Breaks the filter value string into words and then searches all + // attributes for matches. Not case-sensitive. Key FilterNameStringType // The keyword to filter for. You can prefix your search value with an exclamation - // mark (!) in order to perform negation filters. + // mark ( ! ) in order to perform negation filters. Values []string noSmithyDocumentSerde @@ -45,21 +34,21 @@ type Filter struct { type ReplicaRegionType struct { // The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't - // include this field, Secrets Manager uses aws/secretsmanager. + // include this field, Secrets Manager uses aws/secretsmanager . KmsKeyId *string - // A Region code. For a list of Region codes, see Name and code of Regions - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). + // A Region code. For a list of Region codes, see Name and code of Regions (https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) + // . Region *string noSmithyDocumentSerde } -// A replication object consisting of a RegionReplicationStatus object and includes -// a Region, KMSKeyId, status, and status message. +// A replication object consisting of a RegionReplicationStatus object and +// includes a Region, KMSKeyId, status, and status message. type ReplicationStatusType struct { - // Can be an ARN, Key ID, or Alias. + // Can be an ARN , Key ID , or Alias . KmsKeyId *string // The date that the secret was last accessed in the Region. This field is omitted @@ -69,7 +58,7 @@ type ReplicationStatusType struct { // The Region where replication occurs. Region *string - // The status can be InProgress, Failed, or InSync. + // The status can be InProgress , Failed , or InSync . Status StatusType // Status message such as "Secret with this name already exists in this region". @@ -86,22 +75,21 @@ type RotationRulesType struct { // must be rotated. If you use this field to set the rotation schedule, Secrets // Manager calculates the next rotation date based on the previous rotation. // Manually updating the secret value by calling PutSecretValue or UpdateSecret is - // considered a valid rotation. In DescribeSecret and ListSecrets, this value is + // considered a valid rotation. In DescribeSecret and ListSecrets , this value is // calculated from the rotation schedule after every successful rotation. In - // RotateSecret, you can set the rotation schedule in RotationRules with - // AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation - // schedule in hours, use ScheduleExpression. + // RotateSecret , you can set the rotation schedule in RotationRules with + // AutomaticallyAfterDays or ScheduleExpression , but not both. To set a rotation + // schedule in hours, use ScheduleExpression . AutomaticallyAfterDays *int64 // The length of the rotation window in hours, for example 3h for a three hour // window. Secrets Manager rotates your secret at any time during this window. The // window must not extend into the next rotation window or the next UTC day. The - // window starts according to the ScheduleExpression. If you don't specify a - // Duration, for a ScheduleExpression in hours, the window automatically closes + // window starts according to the ScheduleExpression . If you don't specify a + // Duration , for a ScheduleExpression in hours, the window automatically closes // after one hour. For a ScheduleExpression in days, the window automatically // closes at the end of the UTC day. For more information, including examples, see - // Schedule expressions in Secrets Manager rotation - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) + // Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) // in the Secrets Manager Users Guide. Duration *string @@ -109,7 +97,7 @@ type RotationRulesType struct { // secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager // rotates your secret any time during a rotation window. Secrets Manager rate() // expressions represent the interval in hours or days that you want to rotate your - // secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as + // secret, for example rate(12 hours) or rate(10 days) . You can rotate a secret as // often as every four hours. If you use a rate() expression, the rotation window // starts at midnight. For a rate in hours, the default rotation window closes // after one hour. For a rate in days, the default rotation window closes at the @@ -117,8 +105,7 @@ type RotationRulesType struct { // rotation window must not extend into the next UTC day or into the next rotation // window. You can use a cron() expression to create a rotation schedule that is // more detailed than a rotation interval. For more information, including - // examples, see Schedule expressions in Secrets Manager rotation - // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) + // examples, see Schedule expressions in Secrets Manager rotation (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html) // in the Secrets Manager Users Guide. For a cron expression that represents a // schedule in hours, the default rotation window closes after one hour. For a cron // expression that represents a schedule in days, the default rotation window @@ -132,8 +119,7 @@ type RotationRulesType struct { // A structure that contains the details about a secret. It does not include the // encrypted SecretString and SecretBinary values. To get those values, use -// GetSecretValue -// (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) +// GetSecretValue (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) // . type SecretListEntry struct { @@ -146,17 +132,16 @@ type SecretListEntry struct { // The date and time the deletion of the secret occurred. Not present on active // secrets. The secret can be recovered until the number of days in the recovery // window has passed, as specified in the RecoveryWindowInDays parameter of the - // DeleteSecret - // (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html) + // DeleteSecret (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html) // operation. DeletedDate *time.Time // The user-provided description of the secret. Description *string - // The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If - // the secret is encrypted with the Amazon Web Services managed key - // aws/secretsmanager, this field is omitted. + // The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. + // If the secret is encrypted with the Amazon Web Services managed key + // aws/secretsmanager , this field is omitted. KmsKeyId *string // The date that the secret was last accessed in the Region. This field is omitted @@ -172,8 +157,8 @@ type SecretListEntry struct { // The friendly name of the secret. You can use forward slashes in the name to // represent a path hierarchy. For example, /prod/databases/dbserver1 could - // represent the secret for a server named dbserver1 in the folder databases in the - // folder prod. + // represent the secret for a server named dbserver1 in the folder databases in + // the folder prod . Name *string // The next date and time that Secrets Manager will attempt to rotate the secret, @@ -192,8 +177,8 @@ type SecretListEntry struct { // The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to // rotate and expire the secret either automatically per the schedule or manually - // by a call to RotateSecret - // (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html). + // by a call to RotateSecret (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html) + // . RotationLambdaARN *string // A structure that defines the rotation configuration for the secret. @@ -207,10 +192,9 @@ type SecretListEntry struct { SecretVersionsToStages map[string][]string // The list of user-defined tags associated with the secret. To add tags to a - // secret, use TagResource - // (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html). - // To remove tags, use UntagResource - // (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html). + // secret, use TagResource (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html) + // . To remove tags, use UntagResource (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html) + // . Tags []Tag noSmithyDocumentSerde diff --git a/service/securityhub/api_client.go b/service/securityhub/api_client.go index 1d450b4d66e..2cc30f6eed9 100644 --- a/service/securityhub/api_client.go +++ b/service/securityhub/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/securityhub/api_op_AcceptInvitation.go b/service/securityhub/api_op_AcceptInvitation.go index 58c8e8f7f01..43b234c184d 100644 --- a/service/securityhub/api_op_AcceptInvitation.go +++ b/service/securityhub/api_op_AcceptInvitation.go @@ -10,15 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This method is deprecated. Instead, use AcceptAdministratorInvitation. The -// Security Hub console continues to use AcceptInvitation. It will eventually -// change to use AcceptAdministratorInvitation. Any IAM policies that specifically -// control access to this function must continue to use AcceptInvitation. You +// This method is deprecated. Instead, use AcceptAdministratorInvitation . The +// Security Hub console continues to use AcceptInvitation . It will eventually +// change to use AcceptAdministratorInvitation . Any IAM policies that specifically +// control access to this function must continue to use AcceptInvitation . You // should also add AcceptAdministratorInvitation to your policies to ensure that // the correct permissions are in place after the console begins to use -// AcceptAdministratorInvitation. Accepts the invitation to be a member account and -// be monitored by the Security Hub administrator account that the invitation was -// sent from. This operation is only used by member accounts that are not added +// AcceptAdministratorInvitation . Accepts the invitation to be a member account +// and be monitored by the Security Hub administrator account that the invitation +// was sent from. This operation is only used by member accounts that are not added // through Organizations. When the member account accepts the invitation, // permission is granted to the administrator account to view findings generated in // the member account. diff --git a/service/securityhub/api_op_BatchDisableStandards.go b/service/securityhub/api_op_BatchDisableStandards.go index c846611025b..933cd5963a0 100644 --- a/service/securityhub/api_op_BatchDisableStandards.go +++ b/service/securityhub/api_op_BatchDisableStandards.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables the standards specified by the provided StandardsSubscriptionArns. For -// more information, see Security Standards -// (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) +// Disables the standards specified by the provided StandardsSubscriptionArns . For +// more information, see Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) // section of the Security Hub User Guide. func (c *Client) BatchDisableStandards(ctx context.Context, params *BatchDisableStandardsInput, optFns ...func(*Options)) (*BatchDisableStandardsOutput, error) { if params == nil { diff --git a/service/securityhub/api_op_BatchEnableStandards.go b/service/securityhub/api_op_BatchEnableStandards.go index ea0d8444ddc..4b0db881a63 100644 --- a/service/securityhub/api_op_BatchEnableStandards.go +++ b/service/securityhub/api_op_BatchEnableStandards.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the standards specified by the provided StandardsArn. To obtain the ARN +// Enables the standards specified by the provided StandardsArn . To obtain the ARN // for a standard, use the DescribeStandards operation. For more information, see -// the Security Standards -// (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) +// the Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) // section of the Security Hub User Guide. func (c *Client) BatchEnableStandards(ctx context.Context, params *BatchEnableStandardsInput, optFns ...func(*Options)) (*BatchEnableStandardsOutput, error) { if params == nil { diff --git a/service/securityhub/api_op_BatchGetSecurityControls.go b/service/securityhub/api_op_BatchGetSecurityControls.go index 720fd66fdc0..5b144705dcc 100644 --- a/service/securityhub/api_op_BatchGetSecurityControls.go +++ b/service/securityhub/api_op_BatchGetSecurityControls.go @@ -30,8 +30,8 @@ func (c *Client) BatchGetSecurityControls(ctx context.Context, params *BatchGetS type BatchGetSecurityControlsInput struct { - // A list of security controls (identified with SecurityControlId, - // SecurityControlArn, or a mix of both parameters). The security control ID or + // A list of security controls (identified with SecurityControlId , + // SecurityControlArn , or a mix of both parameters). The security control ID or // Amazon Resource Name (ARN) is the same across standards. // // This member is required. @@ -44,13 +44,13 @@ type BatchGetSecurityControlsOutput struct { // An array that returns the identifier, Amazon Resource Name (ARN), and other // details about a security control. The same information is returned whether the - // request includes SecurityControlId or SecurityControlArn. + // request includes SecurityControlId or SecurityControlArn . // // This member is required. SecurityControls []types.SecurityControl - // A security control (identified with SecurityControlId, SecurityControlArn, or a - // mix of both parameters) for which details cannot be returned. + // A security control (identified with SecurityControlId , SecurityControlArn , or + // a mix of both parameters) for which details cannot be returned. UnprocessedIds []types.UnprocessedSecurityControl // Metadata pertaining to the operation's result. diff --git a/service/securityhub/api_op_BatchGetStandardsControlAssociations.go b/service/securityhub/api_op_BatchGetStandardsControlAssociations.go index 6930511cb3f..9f80a1eca61 100644 --- a/service/securityhub/api_op_BatchGetStandardsControlAssociations.go +++ b/service/securityhub/api_op_BatchGetStandardsControlAssociations.go @@ -31,8 +31,8 @@ func (c *Client) BatchGetStandardsControlAssociations(ctx context.Context, param type BatchGetStandardsControlAssociationsInput struct { // An array with one or more objects that includes a security control (identified - // with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the - // Amazon Resource Name (ARN) of a standard. This field is used to query the + // with SecurityControlId , SecurityControlArn , or a mix of both parameters) and + // the Amazon Resource Name (ARN) of a standard. This field is used to query the // enablement status of a control in a specified standard. The security control ID // or ARN is the same across standards. // @@ -44,14 +44,14 @@ type BatchGetStandardsControlAssociationsInput struct { type BatchGetStandardsControlAssociationsOutput struct { - // Provides the enablement status of a security control in a specified standard and - // other details for the control in relation to the specified standard. + // Provides the enablement status of a security control in a specified standard + // and other details for the control in relation to the specified standard. // // This member is required. StandardsControlAssociationDetails []types.StandardsControlAssociationDetail - // A security control (identified with SecurityControlId, SecurityControlArn, or a - // mix of both parameters) whose enablement status in a specified standard cannot + // A security control (identified with SecurityControlId , SecurityControlArn , or + // a mix of both parameters) whose enablement status in a specified standard cannot // be returned. UnprocessedAssociations []types.UnprocessedStandardsControlAssociation diff --git a/service/securityhub/api_op_BatchImportFindings.go b/service/securityhub/api_op_BatchImportFindings.go index e9fec732574..f656170d391 100644 --- a/service/securityhub/api_op_BatchImportFindings.go +++ b/service/securityhub/api_op_BatchImportFindings.go @@ -14,52 +14,36 @@ import ( // Imports security findings generated by a finding provider into Security Hub. // This action is requested by the finding provider to import its findings into // Security Hub. BatchImportFindings must be called by one of the following: +// - The Amazon Web Services account that is associated with a finding if you +// are using the default product ARN (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs) +// or are a partner sending findings from within a customer's Amazon Web Services +// account. In these cases, the identifier of the account that you are calling +// BatchImportFindings from needs to be the same as the AwsAccountId attribute +// for the finding. +// - An Amazon Web Services account that Security Hub has allow-listed for an +// official partner integration. In this case, you can call BatchImportFindings +// from the allow-listed account and send findings from different customer accounts +// in the same batch. // -// * The -// Amazon Web Services account that is associated with a finding if you are using -// the default product ARN -// (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs) -// or are a partner sending findings from within a customer's Amazon Web Services -// account. In these cases, the identifier of the account that you are calling -// BatchImportFindings from needs to be the same as the AwsAccountId attribute for -// the finding. +// The maximum allowed size for a finding is 240 Kb. An error is returned for any +// finding larger than 240 Kb. After a finding is created, BatchImportFindings +// cannot be used to update the following finding fields and objects, which +// Security Hub customers use to manage their investigation workflow. +// - Note +// - UserDefinedFields +// - VerificationState +// - Workflow // -// * An Amazon Web Services account that Security Hub has -// allow-listed for an official partner integration. In this case, you can call -// BatchImportFindings from the allow-listed account and send findings from -// different customer accounts in the same batch. +// Finding providers also should not use BatchImportFindings to update the +// following attributes. +// - Confidence +// - Criticality +// - RelatedFindings +// - Severity +// - Types // -// The maximum allowed size for a -// finding is 240 Kb. An error is returned for any finding larger than 240 Kb. -// After a finding is created, BatchImportFindings cannot be used to update the -// following finding fields and objects, which Security Hub customers use to manage -// their investigation workflow. -// -// * Note -// -// * UserDefinedFields -// -// * -// VerificationState -// -// * Workflow -// -// Finding providers also should not use -// BatchImportFindings to update the following attributes. -// -// * Confidence -// -// * -// Criticality -// -// * RelatedFindings -// -// * Severity -// -// * Types -// -// Instead, finding providers -// use FindingProviderFields to provide values for these attributes. +// Instead, finding providers use FindingProviderFields to provide values for +// these attributes. func (c *Client) BatchImportFindings(ctx context.Context, params *BatchImportFindingsInput, optFns ...func(*Options)) (*BatchImportFindingsOutput, error) { if params == nil { params = &BatchImportFindingsInput{} @@ -78,9 +62,8 @@ func (c *Client) BatchImportFindings(ctx context.Context, params *BatchImportFin type BatchImportFindingsInput struct { // A list of findings to import. To successfully import a finding, it must follow - // the Amazon Web Services Security Finding Format - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html). - // Maximum of 100 findings per request. + // the Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) + // . Maximum of 100 findings per request. // // This member is required. Findings []types.AwsSecurityFinding diff --git a/service/securityhub/api_op_BatchUpdateFindings.go b/service/securityhub/api_op_BatchUpdateFindings.go index 21b50e4767a..e930dfadc4e 100644 --- a/service/securityhub/api_op_BatchUpdateFindings.go +++ b/service/securityhub/api_op_BatchUpdateFindings.go @@ -18,32 +18,19 @@ import ( // BatchUpdateFindings do not affect the value of UpdatedAt for a finding. // Administrator and member accounts can use BatchUpdateFindings to update the // following finding fields and objects. +// - Confidence +// - Criticality +// - Note +// - RelatedFindings +// - Severity +// - Types +// - UserDefinedFields +// - VerificationState +// - Workflow // -// * Confidence -// -// * Criticality -// -// * Note -// -// * -// RelatedFindings -// -// * Severity -// -// * Types -// -// * UserDefinedFields -// -// * -// VerificationState -// -// * Workflow -// -// You can configure IAM policies to restrict access -// to fields and field values. For example, you might not want member accounts to -// be able to suppress findings or change the finding severity. See Configuring -// access to BatchUpdateFindings -// (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) +// You can configure IAM policies to restrict access to fields and field values. +// For example, you might not want member accounts to be able to suppress findings +// or change the finding severity. See Configuring access to BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) // in the Security Hub User Guide. func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFindingsInput, optFns ...func(*Options)) (*BatchUpdateFindingsOutput, error) { if params == nil { @@ -93,38 +80,24 @@ type BatchUpdateFindingsInput struct { // One or more finding types in the format of namespace/category/classifier that // classify a finding. Valid namespace values are as follows. - // - // * Software and - // Configuration Checks - // - // * TTPs - // - // * Effects - // - // * Unusual Behaviors - // - // * Sensitive Data - // Identifications + // - Software and Configuration Checks + // - TTPs + // - Effects + // - Unusual Behaviors + // - Sensitive Data Identifications Types []string - // A list of name/value string pairs associated with the finding. These are custom, - // user-defined fields added to a finding. + // A list of name/value string pairs associated with the finding. These are + // custom, user-defined fields added to a finding. UserDefinedFields map[string]string // Indicates the veracity of a finding. The available values for VerificationState // are as follows. - // - // * UNKNOWN – The default disposition of a security finding - // - // * - // TRUE_POSITIVE – The security finding is confirmed - // - // * FALSE_POSITIVE – The - // security finding was determined to be a false alarm - // - // * BENIGN_POSITIVE – A - // special case of TRUE_POSITIVE where the finding doesn't pose any threat, is - // expected, or both + // - UNKNOWN – The default disposition of a security finding + // - TRUE_POSITIVE – The security finding is confirmed + // - FALSE_POSITIVE – The security finding was determined to be a false alarm + // - BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't + // pose any threat, is expected, or both VerificationState types.VerificationState // Used to update the workflow status of a finding. The workflow status indicates diff --git a/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go b/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go index 9061fec4fc6..a5c707e3908 100644 --- a/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go +++ b/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go @@ -40,9 +40,9 @@ type BatchUpdateStandardsControlAssociationsInput struct { type BatchUpdateStandardsControlAssociationsOutput struct { - // A security control (identified with SecurityControlId, SecurityControlArn, or a - // mix of both parameters) whose enablement status in a specified standard couldn't - // be updated. + // A security control (identified with SecurityControlId , SecurityControlArn , or + // a mix of both parameters) whose enablement status in a specified standard + // couldn't be updated. UnprocessedAssociationUpdates []types.UnprocessedStandardsControlAssociationUpdate // Metadata pertaining to the operation's result. diff --git a/service/securityhub/api_op_CreateFindingAggregator.go b/service/securityhub/api_op_CreateFindingAggregator.go index 25372b89733..71c72c66563 100644 --- a/service/securityhub/api_op_CreateFindingAggregator.go +++ b/service/securityhub/api_op_CreateFindingAggregator.go @@ -12,8 +12,7 @@ import ( // Used to enable finding aggregation. Must be called from the aggregation Region. // For more details about cross-Region replication, see Configuring finding -// aggregation -// (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) +// aggregation (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html) // in the Security Hub User Guide. func (c *Client) CreateFindingAggregator(ctx context.Context, params *CreateFindingAggregatorInput, optFns ...func(*Options)) (*CreateFindingAggregatorOutput, error) { if params == nil { @@ -32,34 +31,30 @@ func (c *Client) CreateFindingAggregator(ctx context.Context, params *CreateFind type CreateFindingAggregatorInput struct { - // Indicates whether to aggregate findings from all of the available Regions in the - // current partition. Also determines whether to automatically aggregate findings - // from new Regions as Security Hub supports them and you opt into them. The - // selected option also determines how to use the Regions provided in the Regions - // list. The options are as follows: - // - // * ALL_REGIONS - Indicates to aggregate - // findings from all of the Regions where Security Hub is enabled. When you choose - // this option, Security Hub also automatically aggregates findings from new - // Regions as Security Hub supports them and you opt into them. - // - // * - // ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the - // Regions where Security Hub is enabled, except for the Regions listed in the - // Regions parameter. When you choose this option, Security Hub also automatically - // aggregates findings from new Regions as Security Hub supports them and you opt - // into them. - // - // * SPECIFIED_REGIONS - Indicates to aggregate findings only from the - // Regions listed in the Regions parameter. Security Hub does not automatically - // aggregate findings from new Regions. + // Indicates whether to aggregate findings from all of the available Regions in + // the current partition. Also determines whether to automatically aggregate + // findings from new Regions as Security Hub supports them and you opt into them. + // The selected option also determines how to use the Regions provided in the + // Regions list. The options are as follows: + // - ALL_REGIONS - Indicates to aggregate findings from all of the Regions where + // Security Hub is enabled. When you choose this option, Security Hub also + // automatically aggregates findings from new Regions as Security Hub supports them + // and you opt into them. + // - ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of + // the Regions where Security Hub is enabled, except for the Regions listed in the + // Regions parameter. When you choose this option, Security Hub also + // automatically aggregates findings from new Regions as Security Hub supports them + // and you opt into them. + // - SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions + // listed in the Regions parameter. Security Hub does not automatically aggregate + // findings from new Regions. // // This member is required. RegionLinkingMode *string - // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a + // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED , then this is a // space-separated list of Regions that do not aggregate findings to the - // aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a + // aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS , then this is a // space-separated list of Regions that do aggregate findings to the aggregation // Region. Regions []string @@ -76,8 +71,8 @@ type CreateFindingAggregatorOutput struct { // retrieve details for, update, and stop finding aggregation. FindingAggregatorArn *string - // Indicates whether to link all Regions, all Regions except for a list of excluded - // Regions, or a list of included Regions. + // Indicates whether to link all Regions, all Regions except for a list of + // excluded Regions, or a list of included Regions. RegionLinkingMode *string // The list of excluded Regions or included Regions. diff --git a/service/securityhub/api_op_CreateInsight.go b/service/securityhub/api_op_CreateInsight.go index 2f95fe6e129..7c4e9a97482 100644 --- a/service/securityhub/api_op_CreateInsight.go +++ b/service/securityhub/api_op_CreateInsight.go @@ -13,7 +13,7 @@ import ( // Creates a custom insight in Security Hub. An insight is a consolidation of // findings that relate to a security issue that requires attention or remediation. -// To group the related findings in the insight, use the GroupByAttribute. +// To group the related findings in the insight, use the GroupByAttribute . func (c *Client) CreateInsight(ctx context.Context, params *CreateInsightInput, optFns ...func(*Options)) (*CreateInsightOutput, error) { if params == nil { params = &CreateInsightInput{} @@ -37,10 +37,10 @@ type CreateInsightInput struct { // This member is required. Filters *types.AwsSecurityFindingFilters - // The attribute used to group the findings for the insight. The grouping attribute - // identifies the type of item that the insight applies to. For example, if an - // insight is grouped by resource identifier, then the insight produces a list of - // resource identifiers. + // The attribute used to group the findings for the insight. The grouping + // attribute identifies the type of item that the insight applies to. For example, + // if an insight is grouped by resource identifier, then the insight produces a + // list of resource identifiers. // // This member is required. GroupByAttribute *string diff --git a/service/securityhub/api_op_CreateMembers.go b/service/securityhub/api_op_CreateMembers.go index dff6e3e7da8..af9517a64b5 100644 --- a/service/securityhub/api_op_CreateMembers.go +++ b/service/securityhub/api_op_CreateMembers.go @@ -17,38 +17,31 @@ import ( // by the organization management account. CreateMembers is always used to add // accounts that are not organization members. For accounts that are managed using // Organizations, CreateMembers is only used in the following cases: +// - Security Hub is not configured to automatically add new organization +// accounts. +// - The account was disassociated or deleted in Security Hub. // -// * Security -// Hub is not configured to automatically add new organization accounts. +// This action can only be used by an account that has Security Hub enabled. To +// enable Security Hub, you can use the EnableSecurityHub operation. For accounts +// that are not organization members, you create the account association and then +// send an invitation to the member account. To send the invitation, you use the +// InviteMembers operation. If the account owner accepts the invitation, the +// account becomes a member account in Security Hub. Accounts that are managed +// using Organizations do not receive an invitation. They automatically become a +// member account in Security Hub. +// - If the organization account does not have Security Hub enabled, then +// Security Hub and the default standards are automatically enabled. Note that +// Security Hub cannot be enabled automatically for the organization management +// account. The organization management account must enable Security Hub before the +// administrator account enables it as a member account. +// - For organization accounts that already have Security Hub enabled, Security +// Hub does not make any other changes to those accounts. It does not change their +// enabled standards or controls. // -// * The -// account was disassociated or deleted in Security Hub. -// -// This action can only be -// used by an account that has Security Hub enabled. To enable Security Hub, you -// can use the EnableSecurityHub operation. For accounts that are not organization -// members, you create the account association and then send an invitation to the -// member account. To send the invitation, you use the InviteMembers operation. If -// the account owner accepts the invitation, the account becomes a member account -// in Security Hub. Accounts that are managed using Organizations do not receive an -// invitation. They automatically become a member account in Security Hub. -// -// * If -// the organization account does not have Security Hub enabled, then Security Hub -// and the default standards are automatically enabled. Note that Security Hub -// cannot be enabled automatically for the organization management account. The -// organization management account must enable Security Hub before the -// administrator account enables it as a member account. -// -// * For organization -// accounts that already have Security Hub enabled, Security Hub does not make any -// other changes to those accounts. It does not change their enabled standards or -// controls. -// -// A permissions policy is added that permits the administrator account -// to view the findings generated in the member account. To remove the association -// between the administrator and member accounts, use the -// DisassociateFromMasterAccount or DisassociateMembers operation. +// A permissions policy is added that permits the administrator account to view +// the findings generated in the member account. To remove the association between +// the administrator and member accounts, use the DisassociateFromMasterAccount or +// DisassociateMembers operation. func (c *Client) CreateMembers(ctx context.Context, params *CreateMembersInput, optFns ...func(*Options)) (*CreateMembersOutput, error) { if params == nil { params = &CreateMembersInput{} diff --git a/service/securityhub/api_op_DeleteFindingAggregator.go b/service/securityhub/api_op_DeleteFindingAggregator.go index d5db7669dbb..bfcc0d13fb0 100644 --- a/service/securityhub/api_op_DeleteFindingAggregator.go +++ b/service/securityhub/api_op_DeleteFindingAggregator.go @@ -32,7 +32,7 @@ func (c *Client) DeleteFindingAggregator(ctx context.Context, params *DeleteFind type DeleteFindingAggregatorInput struct { // The ARN of the finding aggregator to delete. To obtain the ARN, use - // ListFindingAggregators. + // ListFindingAggregators . // // This member is required. FindingAggregatorArn *string diff --git a/service/securityhub/api_op_DeleteInsight.go b/service/securityhub/api_op_DeleteInsight.go index 3c38604c3a1..83f61c9548e 100644 --- a/service/securityhub/api_op_DeleteInsight.go +++ b/service/securityhub/api_op_DeleteInsight.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the insight specified by the InsightArn. +// Deletes the insight specified by the InsightArn . func (c *Client) DeleteInsight(ctx context.Context, params *DeleteInsightInput, optFns ...func(*Options)) (*DeleteInsightOutput, error) { if params == nil { params = &DeleteInsightInput{} diff --git a/service/securityhub/api_op_DescribeActionTargets.go b/service/securityhub/api_op_DescribeActionTargets.go index d4c2edc4172..52c2479a7e9 100644 --- a/service/securityhub/api_op_DescribeActionTargets.go +++ b/service/securityhub/api_op_DescribeActionTargets.go @@ -37,7 +37,7 @@ type DescribeActionTargetsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // DescribeActionTargets operation, set the value of this parameter to NULL. For + // DescribeActionTargets operation, set the value of this parameter to NULL . For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string @@ -47,8 +47,8 @@ type DescribeActionTargetsInput struct { type DescribeActionTargetsOutput struct { - // A list of ActionTarget objects. Each object includes the ActionTargetArn, - // Description, and Name of a custom action target available in Security Hub. + // A list of ActionTarget objects. Each object includes the ActionTargetArn , + // Description , and Name of a custom action target available in Security Hub. // // This member is required. ActionTargets []types.ActionTarget diff --git a/service/securityhub/api_op_DescribeHub.go b/service/securityhub/api_op_DescribeHub.go index 1116d224d73..fba2dc0eb91 100644 --- a/service/securityhub/api_op_DescribeHub.go +++ b/service/securityhub/api_op_DescribeHub.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns details about the Hub resource in your account, including the HubArn and -// the time when you enabled Security Hub. +// Returns details about the Hub resource in your account, including the HubArn +// and the time when you enabled Security Hub. func (c *Client) DescribeHub(ctx context.Context, params *DescribeHubInput, optFns ...func(*Options)) (*DescribeHubOutput, error) { if params == nil { params = &DescribeHubInput{} @@ -39,15 +39,15 @@ type DescribeHubInput struct { type DescribeHubOutput struct { // Whether to automatically enable new controls when they are added to standards - // that are enabled. If set to true, then new controls for enabled standards are - // enabled automatically. If set to false, then new controls are not enabled. + // that are enabled. If set to true , then new controls for enabled standards are + // enabled automatically. If set to false , then new controls are not enabled. AutoEnableControls bool // Specifies whether the calling account has consolidated control findings turned - // on. If the value for this field is set to SECURITY_CONTROL, Security Hub + // on. If the value for this field is set to SECURITY_CONTROL , Security Hub // generates a single finding for a control check even when the check applies to // multiple enabled standards. If the value for this field is set to - // STANDARD_CONTROL, Security Hub generates separate findings for a control check + // STANDARD_CONTROL , Security Hub generates separate findings for a control check // when the check applies to multiple enabled standards. The value for this field // in a member account matches the value in the administrator account. For accounts // that aren't part of an organization, the default value of this field is diff --git a/service/securityhub/api_op_DescribeOrganizationConfiguration.go b/service/securityhub/api_op_DescribeOrganizationConfiguration.go index f6e4cdc8559..2e4ef7c03e7 100644 --- a/service/securityhub/api_op_DescribeOrganizationConfiguration.go +++ b/service/securityhub/api_op_DescribeOrganizationConfiguration.go @@ -35,15 +35,14 @@ type DescribeOrganizationConfigurationInput struct { type DescribeOrganizationConfigurationOutput struct { // Whether to automatically enable Security Hub for new accounts in the - // organization. If set to true, then Security Hub is enabled for new accounts. If + // organization. If set to true , then Security Hub is enabled for new accounts. If // set to false, then new accounts are not added automatically. AutoEnable bool - // Whether to automatically enable Security Hub default standards - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) + // Whether to automatically enable Security Hub default standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) // for new member accounts in the organization. The default value of this parameter - // is equal to DEFAULT. If equal to DEFAULT, then Security Hub default standards - // are automatically enabled for new member accounts. If equal to NONE, then + // is equal to DEFAULT . If equal to DEFAULT , then Security Hub default standards + // are automatically enabled for new member accounts. If equal to NONE , then // default standards are not automatically enabled for new member accounts. AutoEnableStandards types.AutoEnableStandards diff --git a/service/securityhub/api_op_DescribeProducts.go b/service/securityhub/api_op_DescribeProducts.go index 6b3108563b6..16d5f1db459 100644 --- a/service/securityhub/api_op_DescribeProducts.go +++ b/service/securityhub/api_op_DescribeProducts.go @@ -37,7 +37,7 @@ type DescribeProductsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // DescribeProducts operation, set the value of this parameter to NULL. For + // DescribeProducts operation, set the value of this parameter to NULL . For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_DescribeStandards.go b/service/securityhub/api_op_DescribeStandards.go index 8f2e2c4f956..ef5a98024d1 100644 --- a/service/securityhub/api_op_DescribeStandards.go +++ b/service/securityhub/api_op_DescribeStandards.go @@ -35,7 +35,7 @@ type DescribeStandardsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // DescribeStandards operation, set the value of this parameter to NULL. For + // DescribeStandards operation, set the value of this parameter to NULL . For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_DescribeStandardsControls.go b/service/securityhub/api_op_DescribeStandardsControls.go index ab28929e6dd..fc866086a86 100644 --- a/service/securityhub/api_op_DescribeStandardsControls.go +++ b/service/securityhub/api_op_DescribeStandardsControls.go @@ -32,9 +32,9 @@ func (c *Client) DescribeStandardsControls(ctx context.Context, params *Describe type DescribeStandardsControlsInput struct { - // The ARN of a resource that represents your subscription to a supported standard. - // To get the subscription ARNs of the standards you have enabled, use the - // GetEnabledStandards operation. + // The ARN of a resource that represents your subscription to a supported + // standard. To get the subscription ARNs of the standards you have enabled, use + // the GetEnabledStandards operation. // // This member is required. StandardsSubscriptionArn *string @@ -43,7 +43,7 @@ type DescribeStandardsControlsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // DescribeStandardsControls operation, set the value of this parameter to NULL. + // DescribeStandardsControls operation, set the value of this parameter to NULL . // For subsequent calls to the operation, to continue listing data, set the value // of this parameter to the value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_DisassociateFromMasterAccount.go b/service/securityhub/api_op_DisassociateFromMasterAccount.go index 2164da8cdc7..2dabee5502a 100644 --- a/service/securityhub/api_op_DisassociateFromMasterAccount.go +++ b/service/securityhub/api_op_DisassociateFromMasterAccount.go @@ -10,14 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This method is deprecated. Instead, use DisassociateFromAdministratorAccount. -// The Security Hub console continues to use DisassociateFromMasterAccount. It will -// eventually change to use DisassociateFromAdministratorAccount. Any IAM policies -// that specifically control access to this function must continue to use -// DisassociateFromMasterAccount. You should also add +// This method is deprecated. Instead, use DisassociateFromAdministratorAccount . +// The Security Hub console continues to use DisassociateFromMasterAccount . It +// will eventually change to use DisassociateFromAdministratorAccount . Any IAM +// policies that specifically control access to this function must continue to use +// DisassociateFromMasterAccount . You should also add // DisassociateFromAdministratorAccount to your policies to ensure that the correct // permissions are in place after the console begins to use -// DisassociateFromAdministratorAccount. Disassociates the current Security Hub +// DisassociateFromAdministratorAccount . Disassociates the current Security Hub // member account from the associated administrator account. This operation is only // used by accounts that are not part of an organization. For organization // accounts, only the administrator account can disassociate a member account. diff --git a/service/securityhub/api_op_EnableSecurityHub.go b/service/securityhub/api_op_EnableSecurityHub.go index b6970acd6e6..789398131d5 100644 --- a/service/securityhub/api_op_EnableSecurityHub.go +++ b/service/securityhub/api_op_EnableSecurityHub.go @@ -16,20 +16,15 @@ import ( // the permissions necessary to gather findings from other services that are // integrated with Security Hub. When you use the EnableSecurityHub operation to // enable Security Hub, you also automatically enable the following standards: +// - Center for Internet Security (CIS) Amazon Web Services Foundations +// Benchmark v1.2.0 +// - Amazon Web Services Foundational Security Best Practices // -// * -// Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark -// v1.2.0 -// -// * Amazon Web Services Foundational Security Best Practices -// -// Other -// standards are not automatically enabled. To opt out of automatically enabled -// standards, set EnableDefaultStandards to false. After you enable Security Hub, -// to enable a standard, use the BatchEnableStandards operation. To disable a -// standard, use the BatchDisableStandards operation. To learn more, see the setup -// information -// (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) +// Other standards are not automatically enabled. To opt out of automatically +// enabled standards, set EnableDefaultStandards to false . After you enable +// Security Hub, to enable a standard, use the BatchEnableStandards operation. To +// disable a standard, use the BatchDisableStandards operation. To learn more, see +// the setup information (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) // in the Security Hub User Guide. func (c *Client) EnableSecurityHub(ctx context.Context, params *EnableSecurityHubInput, optFns ...func(*Options)) (*EnableSecurityHubOutput, error) { if params == nil { @@ -50,10 +45,10 @@ type EnableSecurityHubInput struct { // This field, used when enabling Security Hub, specifies whether the calling // account has consolidated control findings turned on. If the value for this field - // is set to SECURITY_CONTROL, Security Hub generates a single finding for a + // is set to SECURITY_CONTROL , Security Hub generates a single finding for a // control check even when the check applies to multiple enabled standards. If the - // value for this field is set to STANDARD_CONTROL, Security Hub generates separate - // findings for a control check when the check applies to multiple enabled + // value for this field is set to STANDARD_CONTROL , Security Hub generates + // separate findings for a control check when the check applies to multiple enabled // standards. The value for this field in a member account matches the value in the // administrator account. For accounts that aren't part of an organization, the // default value of this field is SECURITY_CONTROL if you enabled Security Hub on @@ -61,9 +56,9 @@ type EnableSecurityHubInput struct { ControlFindingGenerator types.ControlFindingGenerator // Whether to enable the security standards that Security Hub has designated as - // automatically enabled. If you do not provide a value for EnableDefaultStandards, - // it is set to true. To not enable the automatically enabled standards, set - // EnableDefaultStandards to false. + // automatically enabled. If you do not provide a value for EnableDefaultStandards + // , it is set to true . To not enable the automatically enabled standards, set + // EnableDefaultStandards to false . EnableDefaultStandards bool // The tags to add to the hub resource when you enable Security Hub. diff --git a/service/securityhub/api_op_GetEnabledStandards.go b/service/securityhub/api_op_GetEnabledStandards.go index 56700f93967..2e65eadcc61 100644 --- a/service/securityhub/api_op_GetEnabledStandards.go +++ b/service/securityhub/api_op_GetEnabledStandards.go @@ -34,7 +34,7 @@ type GetEnabledStandardsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // GetEnabledStandards operation, set the value of this parameter to NULL. For + // GetEnabledStandards operation, set the value of this parameter to NULL . For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string @@ -120,8 +120,8 @@ func (c *Client) addOperationGetEnabledStandardsMiddlewares(stack *middleware.St return nil } -// GetEnabledStandardsAPIClient is a client that implements the GetEnabledStandards -// operation. +// GetEnabledStandardsAPIClient is a client that implements the +// GetEnabledStandards operation. type GetEnabledStandardsAPIClient interface { GetEnabledStandards(context.Context, *GetEnabledStandardsInput, ...func(*Options)) (*GetEnabledStandardsOutput, error) } diff --git a/service/securityhub/api_op_GetFindingAggregator.go b/service/securityhub/api_op_GetFindingAggregator.go index 65fa123e172..adb3622ffca 100644 --- a/service/securityhub/api_op_GetFindingAggregator.go +++ b/service/securityhub/api_op_GetFindingAggregator.go @@ -29,7 +29,7 @@ func (c *Client) GetFindingAggregator(ctx context.Context, params *GetFindingAgg type GetFindingAggregatorInput struct { // The ARN of the finding aggregator to return details for. To obtain the ARN, use - // ListFindingAggregators. + // ListFindingAggregators . // // This member is required. FindingAggregatorArn *string @@ -45,8 +45,8 @@ type GetFindingAggregatorOutput struct { // The ARN of the finding aggregator. FindingAggregatorArn *string - // Indicates whether to link all Regions, all Regions except for a list of excluded - // Regions, or a list of included Regions. + // Indicates whether to link all Regions, all Regions except for a list of + // excluded Regions, or a list of included Regions. RegionLinkingMode *string // The list of excluded Regions or included Regions. diff --git a/service/securityhub/api_op_GetFindings.go b/service/securityhub/api_op_GetFindings.go index 05065ce832e..cd946e17f6f 100644 --- a/service/securityhub/api_op_GetFindings.go +++ b/service/securityhub/api_op_GetFindings.go @@ -37,14 +37,14 @@ type GetFindingsInput struct { // findings. You can filter by up to 10 finding attributes. For each attribute, you // can provide up to 20 filter values. Note that in the available filter fields, // WorkflowState is deprecated. To search for a finding based on its workflow - // status, use WorkflowStatus. + // status, use WorkflowStatus . Filters *types.AwsSecurityFindingFilters // The maximum number of findings to return. MaxResults int32 // The token that is required for pagination. On your first call to the GetFindings - // operation, set the value of this parameter to NULL. For subsequent calls to the + // operation, set the value of this parameter to NULL . For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_GetInsights.go b/service/securityhub/api_op_GetInsights.go index 6382e40fc25..32d9eeb28f3 100644 --- a/service/securityhub/api_op_GetInsights.go +++ b/service/securityhub/api_op_GetInsights.go @@ -39,7 +39,7 @@ type GetInsightsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the GetInsights - // operation, set the value of this parameter to NULL. For subsequent calls to the + // operation, set the value of this parameter to NULL . For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_GetMasterAccount.go b/service/securityhub/api_op_GetMasterAccount.go index 7bfe083c4e3..9b83f1d8353 100644 --- a/service/securityhub/api_op_GetMasterAccount.go +++ b/service/securityhub/api_op_GetMasterAccount.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This method is deprecated. Instead, use GetAdministratorAccount. The Security -// Hub console continues to use GetMasterAccount. It will eventually change to use -// GetAdministratorAccount. Any IAM policies that specifically control access to -// this function must continue to use GetMasterAccount. You should also add +// This method is deprecated. Instead, use GetAdministratorAccount . The Security +// Hub console continues to use GetMasterAccount . It will eventually change to use +// GetAdministratorAccount . Any IAM policies that specifically control access to +// this function must continue to use GetMasterAccount . You should also add // GetAdministratorAccount to your policies to ensure that the correct permissions -// are in place after the console begins to use GetAdministratorAccount. Provides +// are in place after the console begins to use GetAdministratorAccount . Provides // the details for the Security Hub administrator account for the current member // account. Can be used by both member accounts that are managed using // Organizations and accounts that were invited manually. diff --git a/service/securityhub/api_op_ListEnabledProductsForImport.go b/service/securityhub/api_op_ListEnabledProductsForImport.go index e0adcd481c2..12e3da2af8a 100644 --- a/service/securityhub/api_op_ListEnabledProductsForImport.go +++ b/service/securityhub/api_op_ListEnabledProductsForImport.go @@ -34,8 +34,8 @@ type ListEnabledProductsForImportInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // ListEnabledProductsForImport operation, set the value of this parameter to NULL. - // For subsequent calls to the operation, to continue listing data, set the value + // ListEnabledProductsForImport operation, set the value of this parameter to NULL + // . For subsequent calls to the operation, to continue listing data, set the value // of this parameter to the value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_ListFindingAggregators.go b/service/securityhub/api_op_ListFindingAggregators.go index e0f6c81d510..ff44470bd1a 100644 --- a/service/securityhub/api_op_ListFindingAggregators.go +++ b/service/securityhub/api_op_ListFindingAggregators.go @@ -31,8 +31,8 @@ func (c *Client) ListFindingAggregators(ctx context.Context, params *ListFinding type ListFindingAggregatorsInput struct { - // The maximum number of results to return. This operation currently only returns a - // single result. + // The maximum number of results to return. This operation currently only returns + // a single result. MaxResults int32 // The token returned with the previous set of results. Identifies the next set of @@ -49,7 +49,7 @@ type ListFindingAggregatorsOutput struct { FindingAggregators []types.FindingAggregator // If there are more results, this is the token to provide in the next call to - // ListFindingAggregators. This operation currently only returns a single result. + // ListFindingAggregators . This operation currently only returns a single result. NextToken *string // Metadata pertaining to the operation's result. @@ -129,8 +129,8 @@ var _ ListFindingAggregatorsAPIClient = (*Client)(nil) // ListFindingAggregatorsPaginatorOptions is the paginator options for // ListFindingAggregators type ListFindingAggregatorsPaginatorOptions struct { - // The maximum number of results to return. This operation currently only returns a - // single result. + // The maximum number of results to return. This operation currently only returns + // a single result. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/securityhub/api_op_ListInvitations.go b/service/securityhub/api_op_ListInvitations.go index c3d96fd7084..88f30d83af8 100644 --- a/service/securityhub/api_op_ListInvitations.go +++ b/service/securityhub/api_op_ListInvitations.go @@ -37,7 +37,7 @@ type ListInvitationsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // ListInvitations operation, set the value of this parameter to NULL. For + // ListInvitations operation, set the value of this parameter to NULL . For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string diff --git a/service/securityhub/api_op_ListMembers.go b/service/securityhub/api_op_ListMembers.go index 1b5e3a144ca..8d94c527e4d 100644 --- a/service/securityhub/api_op_ListMembers.go +++ b/service/securityhub/api_op_ListMembers.go @@ -36,16 +36,16 @@ type ListMembersInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the ListMembers - // operation, set the value of this parameter to NULL. For subsequent calls to the + // operation, set the value of this parameter to NULL . For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string // Specifies which member accounts to include in the response based on their - // relationship status with the administrator account. The default value is TRUE. - // If OnlyAssociated is set to TRUE, the response includes member accounts whose - // relationship status with the administrator account is set to ENABLED. If - // OnlyAssociated is set to FALSE, the response includes all existing member + // relationship status with the administrator account. The default value is TRUE . + // If OnlyAssociated is set to TRUE , the response includes member accounts whose + // relationship status with the administrator account is set to ENABLED . If + // OnlyAssociated is set to FALSE , the response includes all existing member // accounts. OnlyAssociated bool diff --git a/service/securityhub/api_op_ListOrganizationAdminAccounts.go b/service/securityhub/api_op_ListOrganizationAdminAccounts.go index f1e50f94f90..4cdc62a69df 100644 --- a/service/securityhub/api_op_ListOrganizationAdminAccounts.go +++ b/service/securityhub/api_op_ListOrganizationAdminAccounts.go @@ -35,9 +35,9 @@ type ListOrganizationAdminAccountsInput struct { MaxResults int32 // The token that is required for pagination. On your first call to the - // ListOrganizationAdminAccounts operation, set the value of this parameter to - // NULL. For subsequent calls to the operation, to continue listing data, set the - // value of this parameter to the value returned from the previous response. + // ListOrganizationAdminAccounts operation, set the value of this parameter to NULL + // . For subsequent calls to the operation, to continue listing data, set the value + // of this parameter to the value returned from the previous response. NextToken *string noSmithyDocumentSerde diff --git a/service/securityhub/api_op_ListStandardsControlAssociations.go b/service/securityhub/api_op_ListStandardsControlAssociations.go index 85f86c18fd5..cfd671b794f 100644 --- a/service/securityhub/api_op_ListStandardsControlAssociations.go +++ b/service/securityhub/api_op_ListStandardsControlAssociations.go @@ -31,8 +31,8 @@ func (c *Client) ListStandardsControlAssociations(ctx context.Context, params *L type ListStandardsControlAssociationsInput struct { - // The identifier of the control (identified with SecurityControlId, - // SecurityControlArn, or a mix of both parameters) that you want to determine the + // The identifier of the control (identified with SecurityControlId , + // SecurityControlArn , or a mix of both parameters) that you want to determine the // enablement status of in each enabled standard. // // This member is required. @@ -55,8 +55,8 @@ type ListStandardsControlAssociationsInput struct { type ListStandardsControlAssociationsOutput struct { - // An array that provides the enablement status and other details for each security - // control that applies to each enabled standard. + // An array that provides the enablement status and other details for each + // security control that applies to each enabled standard. // // This member is required. StandardsControlAssociationSummaries []types.StandardsControlAssociationSummary diff --git a/service/securityhub/api_op_UpdateFindingAggregator.go b/service/securityhub/api_op_UpdateFindingAggregator.go index cc24c681586..d4eff0b3ba1 100644 --- a/service/securityhub/api_op_UpdateFindingAggregator.go +++ b/service/securityhub/api_op_UpdateFindingAggregator.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the finding aggregation configuration. Used to update the Region linking -// mode and the list of included or excluded Regions. You cannot use +// Updates the finding aggregation configuration. Used to update the Region +// linking mode and the list of included or excluded Regions. You cannot use // UpdateFindingAggregator to change the aggregation Region. You must run // UpdateFindingAggregator from the current aggregation Region. func (c *Client) UpdateFindingAggregator(ctx context.Context, params *UpdateFindingAggregatorInput, optFns ...func(*Options)) (*UpdateFindingAggregatorOutput, error) { @@ -31,40 +31,36 @@ func (c *Client) UpdateFindingAggregator(ctx context.Context, params *UpdateFind type UpdateFindingAggregatorInput struct { - // The ARN of the finding aggregator. To obtain the ARN, use - // ListFindingAggregators. + // The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators + // . // // This member is required. FindingAggregatorArn *string - // Indicates whether to aggregate findings from all of the available Regions in the - // current partition. Also determines whether to automatically aggregate findings - // from new Regions as Security Hub supports them and you opt into them. The - // selected option also determines how to use the Regions provided in the Regions - // list. The options are as follows: - // - // * ALL_REGIONS - Indicates to aggregate - // findings from all of the Regions where Security Hub is enabled. When you choose - // this option, Security Hub also automatically aggregates findings from new - // Regions as Security Hub supports them and you opt into them. - // - // * - // ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the - // Regions where Security Hub is enabled, except for the Regions listed in the - // Regions parameter. When you choose this option, Security Hub also automatically - // aggregates findings from new Regions as Security Hub supports them and you opt - // into them. - // - // * SPECIFIED_REGIONS - Indicates to aggregate findings only from the - // Regions listed in the Regions parameter. Security Hub does not automatically - // aggregate findings from new Regions. + // Indicates whether to aggregate findings from all of the available Regions in + // the current partition. Also determines whether to automatically aggregate + // findings from new Regions as Security Hub supports them and you opt into them. + // The selected option also determines how to use the Regions provided in the + // Regions list. The options are as follows: + // - ALL_REGIONS - Indicates to aggregate findings from all of the Regions where + // Security Hub is enabled. When you choose this option, Security Hub also + // automatically aggregates findings from new Regions as Security Hub supports them + // and you opt into them. + // - ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of + // the Regions where Security Hub is enabled, except for the Regions listed in the + // Regions parameter. When you choose this option, Security Hub also + // automatically aggregates findings from new Regions as Security Hub supports them + // and you opt into them. + // - SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions + // listed in the Regions parameter. Security Hub does not automatically aggregate + // findings from new Regions. // // This member is required. RegionLinkingMode *string - // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a + // If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED , then this is a // space-separated list of Regions that do not aggregate findings to the - // aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a + // aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS , then this is a // space-separated list of Regions that do aggregate findings to the aggregation // Region. Regions []string @@ -80,8 +76,8 @@ type UpdateFindingAggregatorOutput struct { // The ARN of the finding aggregator. FindingAggregatorArn *string - // Indicates whether to link all Regions, all Regions except for a list of excluded - // Regions, or a list of included Regions. + // Indicates whether to link all Regions, all Regions except for a list of + // excluded Regions, or a list of included Regions. RegionLinkingMode *string // The list of excluded Regions or included Regions. diff --git a/service/securityhub/api_op_UpdateFindings.go b/service/securityhub/api_op_UpdateFindings.go index 7ca4ed2664c..8ab7095f24e 100644 --- a/service/securityhub/api_op_UpdateFindings.go +++ b/service/securityhub/api_op_UpdateFindings.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// UpdateFindings is deprecated. Instead of UpdateFindings, use -// BatchUpdateFindings. Updates the Note and RecordState of the Security +// UpdateFindings is deprecated. Instead of UpdateFindings , use +// BatchUpdateFindings . Updates the Note and RecordState of the Security // Hub-aggregated findings that the filter attributes specify. Any member account // that can view the finding also sees the update to the finding. func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput, optFns ...func(*Options)) (*UpdateFindingsOutput, error) { diff --git a/service/securityhub/api_op_UpdateOrganizationConfiguration.go b/service/securityhub/api_op_UpdateOrganizationConfiguration.go index 788a8efbb8f..b3bc5aad4dc 100644 --- a/service/securityhub/api_op_UpdateOrganizationConfiguration.go +++ b/service/securityhub/api_op_UpdateOrganizationConfiguration.go @@ -31,19 +31,18 @@ func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *Up type UpdateOrganizationConfigurationInput struct { // Whether to automatically enable Security Hub for new accounts in the - // organization. By default, this is false, and new accounts are not added + // organization. By default, this is false , and new accounts are not added // automatically. To automatically enable Security Hub for new accounts, set this - // to true. + // to true . // // This member is required. AutoEnable bool - // Whether to automatically enable Security Hub default standards - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) + // Whether to automatically enable Security Hub default standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) // for new member accounts in the organization. By default, this parameter is equal - // to DEFAULT, and new member accounts are automatically enabled with default + // to DEFAULT , and new member accounts are automatically enabled with default // Security Hub standards. To opt out of enabling default standards for new member - // accounts, set this parameter equal to NONE. + // accounts, set this parameter equal to NONE . AutoEnableStandards types.AutoEnableStandards noSmithyDocumentSerde diff --git a/service/securityhub/api_op_UpdateSecurityHubConfiguration.go b/service/securityhub/api_op_UpdateSecurityHubConfiguration.go index 363dfae956f..70ff23f8773 100644 --- a/service/securityhub/api_op_UpdateSecurityHubConfiguration.go +++ b/service/securityhub/api_op_UpdateSecurityHubConfiguration.go @@ -30,17 +30,17 @@ func (c *Client) UpdateSecurityHubConfiguration(ctx context.Context, params *Upd type UpdateSecurityHubConfigurationInput struct { // Whether to automatically enable new controls when they are added to standards - // that are enabled. By default, this is set to true, and new controls are enabled - // automatically. To not automatically enable new controls, set this to false. + // that are enabled. By default, this is set to true , and new controls are enabled + // automatically. To not automatically enable new controls, set this to false . AutoEnableControls bool - // Updates whether the calling account has consolidated control findings turned on. - // If the value for this field is set to SECURITY_CONTROL, Security Hub generates a - // single finding for a control check even when the check applies to multiple - // enabled standards. If the value for this field is set to STANDARD_CONTROL, - // Security Hub generates separate findings for a control check when the check - // applies to multiple enabled standards. For accounts that are part of an - // organization, this value can only be updated in the administrator account. + // Updates whether the calling account has consolidated control findings turned + // on. If the value for this field is set to SECURITY_CONTROL , Security Hub + // generates a single finding for a control check even when the check applies to + // multiple enabled standards. If the value for this field is set to + // STANDARD_CONTROL , Security Hub generates separate findings for a control check + // when the check applies to multiple enabled standards. For accounts that are part + // of an organization, this value can only be updated in the administrator account. ControlFindingGenerator types.ControlFindingGenerator noSmithyDocumentSerde diff --git a/service/securityhub/doc.go b/service/securityhub/doc.go index dc5da0d72bd..ea43a41d8b2 100644 --- a/service/securityhub/doc.go +++ b/service/securityhub/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package securityhub provides the API client, operations, and parameter types for -// AWS SecurityHub. +// Package securityhub provides the API client, operations, and parameter types +// for AWS SecurityHub. // // Security Hub provides you with a comprehensive view of the security state of // your Amazon Web Services environment and resources. It also provides you with @@ -9,37 +9,28 @@ // security standards. Security Hub collects security data from Amazon Web Services // accounts, services, and integrated third-party products and helps you analyze // security trends in your environment to identify the highest priority security -// issues. For more information about Security Hub, see the Security HubUser Guide -// (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html). -// When you use operations in the Security Hub API, the requests are executed only -// in the Amazon Web Services Region that is currently active or in the specific -// Amazon Web Services Region that you specify in your request. Any configuration -// or settings change that results from the operation is applied only to that -// Region. To make the same change in other Regions, run the same command for each -// Region in which you want to apply the change. For example, if your Region is set -// to us-west-2, when you use CreateMembers to add a member account to Security -// Hub, the association of the member account with the administrator account is -// created only in the us-west-2 Region. Security Hub must be enabled for the -// member account in the same Region that the invitation was sent from. The +// issues. For more information about Security Hub, see the Security HubUser Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) +// . When you use operations in the Security Hub API, the requests are executed +// only in the Amazon Web Services Region that is currently active or in the +// specific Amazon Web Services Region that you specify in your request. Any +// configuration or settings change that results from the operation is applied only +// to that Region. To make the same change in other Regions, run the same command +// for each Region in which you want to apply the change. For example, if your +// Region is set to us-west-2 , when you use CreateMembers to add a member account +// to Security Hub, the association of the member account with the administrator +// account is created only in the us-west-2 Region. Security Hub must be enabled +// for the member account in the same Region that the invitation was sent from. The // following throttling limits apply to using Security Hub API operations. -// -// * -// BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 -// request per second. -// -// * GetFindings - RateLimit of 3 requests per second. -// BurstLimit of 6 requests per second. -// -// * BatchImportFindings - RateLimit of 10 -// requests per second. BurstLimit of 30 requests per second. -// -// * -// BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 -// requests per second. -// -// * UpdateStandardsControl - RateLimit of 1 request per -// second. BurstLimit of 5 requests per second. -// -// * All other operations - RateLimit -// of 10 requests per second. BurstLimit of 30 requests per second. +// - BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 +// request per second. +// - GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests +// per second. +// - BatchImportFindings - RateLimit of 10 requests per second. BurstLimit of 30 +// requests per second. +// - BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 +// requests per second. +// - UpdateStandardsControl - RateLimit of 1 request per second. BurstLimit of 5 +// requests per second. +// - All other operations - RateLimit of 10 requests per second. BurstLimit of 30 +// requests per second. package securityhub diff --git a/service/securityhub/types/enums.go b/service/securityhub/types/enums.go index e048dc69356..1fa0b180629 100644 --- a/service/securityhub/types/enums.go +++ b/service/securityhub/types/enums.go @@ -64,8 +64,8 @@ const ( AwsIamAccessKeyStatusInactive AwsIamAccessKeyStatus = "Inactive" ) -// Values returns all known values for AwsIamAccessKeyStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AwsIamAccessKeyStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AwsIamAccessKeyStatus) Values() []AwsIamAccessKeyStatus { return []AwsIamAccessKeyStatus{ @@ -196,9 +196,9 @@ const ( MalwareStateRemoved MalwareState = "REMOVED" ) -// Values returns all known values for MalwareState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MalwareState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MalwareState) Values() []MalwareState { return []MalwareState{ "OBSERVED", @@ -296,9 +296,9 @@ const ( PartitionAwsUsGov Partition = "aws-us-gov" ) -// Values returns all known values for Partition. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Partition. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Partition) Values() []Partition { return []Partition{ "aws", @@ -333,9 +333,9 @@ const ( RegionAvailabilityStatusUnavailable RegionAvailabilityStatus = "UNAVAILABLE" ) -// Values returns all known values for RegionAvailabilityStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RegionAvailabilityStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RegionAvailabilityStatus) Values() []RegionAvailabilityStatus { return []RegionAvailabilityStatus{ "AVAILABLE", @@ -397,9 +397,9 @@ const ( SortOrderDescending SortOrder = "desc" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "asc", @@ -483,9 +483,10 @@ const ( ThreatIntelIndicatorCategoryKeylogger ThreatIntelIndicatorCategory = "KEYLOGGER" ) -// Values returns all known values for ThreatIntelIndicatorCategory. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ThreatIntelIndicatorCategory. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ThreatIntelIndicatorCategory) Values() []ThreatIntelIndicatorCategory { return []ThreatIntelIndicatorCategory{ "BACKDOOR", @@ -514,9 +515,9 @@ const ( ThreatIntelIndicatorTypeUrl ThreatIntelIndicatorType = "URL" ) -// Values returns all known values for ThreatIntelIndicatorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ThreatIntelIndicatorType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ThreatIntelIndicatorType) Values() []ThreatIntelIndicatorType { return []ThreatIntelIndicatorType{ "DOMAIN", diff --git a/service/securityhub/types/types.go b/service/securityhub/types/types.go index 4bc754f6f61..80f1086eb53 100644 --- a/service/securityhub/types/types.go +++ b/service/securityhub/types/types.go @@ -23,45 +23,33 @@ type AccountDetails struct { // Provides details about one of the following actions that affects or that was // taken on a resource: -// -// * A remote IP address issued an Amazon Web Services API -// call -// -// * A DNS request was received -// -// * A remote IP address attempted to connect -// to an EC2 instance -// -// * A remote IP address attempted a port probe on an EC2 -// instance +// - A remote IP address issued an Amazon Web Services API call +// - A DNS request was received +// - A remote IP address attempted to connect to an EC2 instance +// - A remote IP address attempted a port probe on an EC2 instance type Action struct { // The type of action that was detected. The possible action types are: - // - // * - // NETWORK_CONNECTION - // - // * AWS_API_CALL - // - // * DNS_REQUEST - // - // * PORT_PROBE + // - NETWORK_CONNECTION + // - AWS_API_CALL + // - DNS_REQUEST + // - PORT_PROBE ActionType *string - // Included if ActionType is AWS_API_CALL. Provides details about the API call that - // was detected. + // Included if ActionType is AWS_API_CALL . Provides details about the API call + // that was detected. AwsApiCallAction *AwsApiCallAction - // Included if ActionType is DNS_REQUEST. Provides details about the DNS request + // Included if ActionType is DNS_REQUEST . Provides details about the DNS request // that was detected. DnsRequestAction *DnsRequestAction - // Included if ActionType is NETWORK_CONNECTION. Provides details about the network - // connection that was detected. + // Included if ActionType is NETWORK_CONNECTION . Provides details about the + // network connection that was detected. NetworkConnectionAction *NetworkConnectionAction - // Included if ActionType is PORT_PROBE. Provides details about the port probe that - // was detected. + // Included if ActionType is PORT_PROBE . Provides details about the port probe + // that was detected. PortProbeAction *PortProbeAction noSmithyDocumentSerde @@ -76,7 +64,7 @@ type ActionLocalIpDetails struct { noSmithyDocumentSerde } -// For NetworkConnectionAction and PortProbeDetails, LocalPortDetails provides +// For NetworkConnectionAction and PortProbeDetails , LocalPortDetails provides // information about the local port that was involved in the action. type ActionLocalPortDetails struct { @@ -89,9 +77,9 @@ type ActionLocalPortDetails struct { noSmithyDocumentSerde } -// For AwsApiAction, NetworkConnectionAction, and PortProbeAction, RemoteIpDetails -// provides information about the remote IP address that was involved in the -// action. +// For AwsApiAction , NetworkConnectionAction , and PortProbeAction , +// RemoteIpDetails provides information about the remote IP address that was +// involved in the action. type ActionRemoteIpDetails struct { // The city where the remote IP address is located. @@ -180,8 +168,7 @@ type AssociatedStandard struct { // The unique identifier of a standard in which a control is enabled. This field // consists of the resource portion of the Amazon Resource Name (ARN) returned for - // a standard in the DescribeStandards - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) + // a standard in the DescribeStandards (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) // API response. StandardsId *string @@ -237,7 +224,7 @@ type AvailabilityZone struct { noSmithyDocumentSerde } -// Provided if ActionType is AWS_API_CALL. It provides details about the API call +// Provided if ActionType is AWS_API_CALL . It provides details about the API call // that was detected. type AwsApiCallAction struct { @@ -247,29 +234,29 @@ type AwsApiCallAction struct { // The name of the API method that was issued. Api *string - // Indicates whether the API call originated from a remote IP address (remoteip) or - // from a DNS domain (domain). + // Indicates whether the API call originated from a remote IP address ( remoteip ) + // or from a DNS domain ( domain ). CallerType *string - // Provided if CallerType is domain. Provides information about the DNS domain that - // the API call originated from. + // Provided if CallerType is domain . Provides information about the DNS domain + // that the API call originated from. DomainDetails *AwsApiCallActionDomainDetails // An ISO8601-formatted timestamp that indicates when the API call was first - // observed. A correctly formatted example is 2020-05-21T20:16:34.724Z. The value - // cannot contain spaces, and date and time should be separated by T. For more - // information, see RFC 3339 section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // observed. A correctly formatted example is 2020-05-21T20:16:34.724Z . The value + // cannot contain spaces, and date and time should be separated by T . For more + // information, see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . FirstSeen *string // An ISO8601-formatted timestamp that indicates when the API call was most - // recently observed. A correctly formatted example is 2020-05-21T20:16:34.724Z. - // The value cannot contain spaces, and date and time should be separated by T. For - // more information, see RFC 3339 section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // recently observed. A correctly formatted example is 2020-05-21T20:16:34.724Z . + // The value cannot contain spaces, and date and time should be separated by T . + // For more information, see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . LastSeen *string - // Provided if CallerType is remoteIp. Provides information about the remote IP + // Provided if CallerType is remoteIp . Provides information about the remote IP // address that the API call originated from. RemoteIpDetails *ActionRemoteIpDetails @@ -279,7 +266,7 @@ type AwsApiCallAction struct { noSmithyDocumentSerde } -// Provided if CallerType is domain. It provides information about the DNS domain +// Provided if CallerType is domain . It provides information about the DNS domain // that issued the API call. type AwsApiCallActionDomainDetails struct { @@ -296,7 +283,7 @@ type AwsApiGatewayAccessLogSettings struct { DestinationArn *string // A single-line format of the access logs of data, as specified by selected - // $context variables. The format must include at least $context.requestId. + // $context variables. The format must include at least $context.requestId . Format *string noSmithyDocumentSerde @@ -327,8 +314,8 @@ type AwsApiGatewayCanarySettings struct { type AwsApiGatewayEndpointConfiguration struct { // A list of endpoint types for the REST API. For an edge-optimized API, the - // endpoint type is EDGE. For a Regional API, the endpoint type is REGIONAL. For a - // private API, the endpoint type is PRIVATE. + // endpoint type is EDGE . For a Regional API, the endpoint type is REGIONAL . For + // a private API, the endpoint type is PRIVATE . Types []string noSmithyDocumentSerde @@ -357,10 +344,10 @@ type AwsApiGatewayMethodSettings struct { HttpMethod *string // The logging level for this method. The logging level affects the log entries - // that are pushed to CloudWatch Logs. If the logging level is ERROR, then the logs - // only include error-level entries. If the logging level is INFO, then the logs - // include both ERROR events and extra informational events. Valid values: OFF | - // ERROR | INFO + // that are pushed to CloudWatch Logs. If the logging level is ERROR , then the + // logs only include error-level entries. If the logging level is INFO , then the + // logs include both ERROR events and extra informational events. Valid values: OFF + // | ERROR | INFO LoggingLevel *string // Indicates whether CloudWatch metrics are enabled for the method. @@ -371,7 +358,7 @@ type AwsApiGatewayMethodSettings struct { // The resource path for this method. Forward slashes (/) are encoded as ~1 . The // initial slash must include a forward slash. For example, the path value - // /resource/subresource must be encoded as /~1resource~1subresource. To specify + // /resource/subresource must be encoded as /~1resource~1subresource . To specify // the root path, use only a slash (/). You can use an asterisk (*) as a wildcard // to apply method settings to multiple methods. ResourcePath *string @@ -403,10 +390,9 @@ type AwsApiGatewayRestApiDetails struct { BinaryMediaTypes []string // Indicates when the API was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedDate *string // A description of the REST API. @@ -418,7 +404,7 @@ type AwsApiGatewayRestApiDetails struct { // The identifier of the REST API. Id *string - // The minimum size in bytes of a payload before compression is enabled. If null, + // The minimum size in bytes of a payload before compression is enabled. If null , // then compression is disabled. If 0, then all payloads are compressed. MinimumCompressionSize int32 @@ -452,11 +438,10 @@ type AwsApiGatewayStageDetails struct { // The identifier of the client certificate for the stage. ClientCertificateId *string - // Indicates when the stage was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the stage was created. Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedDate *string // The identifier of the deployment that the stage points to. @@ -469,10 +454,9 @@ type AwsApiGatewayStageDetails struct { DocumentationVersion *string // Indicates when the stage was most recently updated. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastUpdatedDate *string // Defines the method settings for the stage. @@ -487,13 +471,9 @@ type AwsApiGatewayStageDetails struct { // A map that defines the stage variables for the stage. Variable names can have // alphanumeric and underscore characters. Variable values can contain the // following characters: - // - // * Uppercase and lowercase letters - // - // * Numbers - // - // * Special - // characters -._~:/?#&=, + // - Uppercase and lowercase letters + // - Numbers + // - Special characters -._~:/?#&=, Variables map[string]string // The ARN of the web ACL associated with the stage. @@ -521,10 +501,9 @@ type AwsApiGatewayV2ApiDetails struct { CorsConfiguration *AwsCorsConfiguration // Indicates when the API was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedDate *string // A description of the API. @@ -537,7 +516,7 @@ type AwsApiGatewayV2ApiDetails struct { ProtocolType *string // The route selection expression for the API. For HTTP APIs, must be - // ${request.method} ${request.path}. This is the default value for HTTP APIs. For + // ${request.method} ${request.path} . This is the default value for HTTP APIs. For // WebSocket APIs, there is no default value. RouteSelectionExpression *string @@ -560,8 +539,8 @@ type AwsApiGatewayV2RouteSettings struct { // The logging level. The logging level affects the log entries that are pushed to // CloudWatch Logs. Supported only for WebSocket APIs. If the logging level is - // ERROR, then the logs only include error-level entries. If the logging level is - // INFO, then the logs include both ERROR events and extra informational events. + // ERROR , then the logs only include error-level entries. If the logging level is + // INFO , then the logs include both ERROR events and extra informational events. // Valid values: OFF | ERROR | INFO LoggingLevel *string @@ -586,15 +565,14 @@ type AwsApiGatewayV2StageDetails struct { // Indicates whether updates to an API automatically trigger a new deployment. AutoDeploy bool - // The identifier of a client certificate for a stage. Supported only for WebSocket - // API calls. + // The identifier of a client certificate for a stage. Supported only for + // WebSocket API calls. ClientCertificateId *string - // Indicates when the stage was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the stage was created. Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedDate *string // Default route settings for the stage. @@ -611,10 +589,9 @@ type AwsApiGatewayV2StageDetails struct { LastDeploymentStatusMessage *string // Indicates when the stage was most recently updated. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastUpdatedDate *string // The route settings for the stage. @@ -626,13 +603,9 @@ type AwsApiGatewayV2StageDetails struct { // A map that defines the stage variables for the stage. Variable names can have // alphanumeric and underscore characters. Variable values can contain the // following characters: - // - // * Uppercase and lowercase letters - // - // * Numbers - // - // * Special - // characters -._~:/?#&=, + // - Uppercase and lowercase letters + // - Numbers + // - Special characters -._~:/?#&=, StageVariables map[string]string noSmithyDocumentSerde @@ -657,17 +630,16 @@ type AwsAutoScalingAutoScalingGroupDetails struct { CapacityRebalance bool // Indicates when the auto scaling group was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedTime *string // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it // checks the health status of an EC2 instance that has come into service. HealthCheckGracePeriod int32 - // The service to use for the health checks. Valid values are EC2 or ELB. + // The service to use for the health checks. Valid values are EC2 or ELB . HealthCheckType *string // The name of the launch configuration. @@ -689,15 +661,15 @@ type AwsAutoScalingAutoScalingGroupDetails struct { type AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification struct { // The identifier of the launch template. You must specify either LaunchTemplateId - // or LaunchTemplateName. + // or LaunchTemplateName . LaunchTemplateId *string // The name of the launch template. You must specify either LaunchTemplateId or - // LaunchTemplateName. + // LaunchTemplateName . LaunchTemplateName *string // Identifies the version of the launch template. You can specify a version - // identifier, or use the values $Latest or $Default. + // identifier, or use the values $Latest or $Default . Version *string noSmithyDocumentSerde @@ -722,26 +694,23 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails struct { // Information about the instances distribution. type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails struct { - // How to allocate instance types to fulfill On-Demand capacity. The valid value is - // prioritized. + // How to allocate instance types to fulfill On-Demand capacity. The valid value + // is prioritized . OnDemandAllocationStrategy *string // The minimum amount of the Auto Scaling group's capacity that must be fulfilled // by On-Demand Instances. OnDemandBaseCapacity int32 - // The percentage of On-Demand Instances and Spot Instances for additional capacity - // beyond OnDemandBaseCapacity. + // The percentage of On-Demand Instances and Spot Instances for additional + // capacity beyond OnDemandBaseCapacity . OnDemandPercentageAboveBaseCapacity int32 // How to allocate instances across Spot Instance pools. Valid values are as // follows: - // - // * lowest-price - // - // * capacity-optimized - // - // * capacity-optimized-prioritized + // - lowest-price + // - capacity-optimized + // - capacity-optimized-prioritized SpotAllocationStrategy *string // The number of Spot Instance pools across which to allocate your Spot Instances. @@ -769,15 +738,15 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails str type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification struct { // The identifier of the launch template. You must specify either LaunchTemplateId - // or LaunchTemplateName. + // or LaunchTemplateName . LaunchTemplateId *string // The name of the launch template. You must specify either LaunchTemplateId or - // LaunchTemplateName. + // LaunchTemplateName . LaunchTemplateName *string // Identifies the version of the launch template. You can specify a version - // identifier, or use the values $Latest or $Default. + // identifier, or use the values $Latest or $Default . Version *string noSmithyDocumentSerde @@ -786,11 +755,11 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTempl // Property values to use to override the values in the launch template. type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails struct { - // The instance type. For example, m3.xlarge. + // The instance type. For example, m3.xlarge . InstanceType *string - // The number of capacity units provided by the specified instance type in terms of - // virtual CPUs, memory, storage, throughput, or other relative performance + // The number of capacity units provided by the specified instance type in terms + // of virtual CPUs, memory, storage, throughput, or other relative performance // characteristic. WeightedCapacity *string @@ -801,7 +770,7 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesLi type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails struct { // The device name that is exposed to the EC2 instance. For example, /dev/sdh or - // xvdh. + // xvdh . DeviceName *string // Parameters that are used to automatically set up Amazon EBS volumes when an @@ -809,19 +778,19 @@ type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails struct { Ebs *AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails // Whether to suppress the device that is included in the block device mapping of - // the Amazon Machine Image (AMI). If NoDevice is true, then you cannot specify - // Ebs.> + // the Amazon Machine Image (AMI). If NoDevice is true , then you cannot specify + // Ebs .> NoDevice bool - // The name of the virtual device (for example, ephemeral0). You can provide either - // VirtualName or Ebs, but not both. + // The name of the virtual device (for example, ephemeral0 ). You can provide + // either VirtualName or Ebs , but not both. VirtualName *string noSmithyDocumentSerde } -// Parameters that are used to automatically set up EBS volumes when an instance is -// launched. +// Parameters that are used to automatically set up EBS volumes when an instance +// is launched. type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails struct { // Whether to delete the volume when the instance is terminated. @@ -831,45 +800,32 @@ type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails struct { Encrypted bool // The number of input/output (I/O) operations per second (IOPS) to provision for - // the volume. Only supported for gp3 or io1 volumes. Required for io1 volumes. Not - // used with standard, gp2, st1, or sc1 volumes. + // the volume. Only supported for gp3 or io1 volumes. Required for io1 volumes. + // Not used with standard , gp2 , st1 , or sc1 volumes. Iops int32 // The snapshot ID of the volume to use. You must specify either VolumeSize or - // SnapshotId. + // SnapshotId . SnapshotId *string - // The volume size, in GiBs. The following are the supported volumes sizes for each - // volume type: - // - // * gp2 and gp3: 1-16,384 - // - // * io1: 4-16,384 - // - // * st1 and sc1: - // 125-16,384 - // - // * standard: 1-1,024 - // - // You must specify either SnapshotId or - // VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must - // be equal or greater than the size of the snapshot. + // The volume size, in GiBs. The following are the supported volumes sizes for + // each volume type: + // - gp2 and gp3: 1-16,384 + // - io1: 4-16,384 + // - st1 and sc1: 125-16,384 + // - standard: 1-1,024 + // You must specify either SnapshotId or VolumeSize . If you specify both + // SnapshotId and VolumeSize , the volume size must be equal or greater than the + // size of the snapshot. VolumeSize int32 // The volume type. Valid values are as follows: - // - // * gp2 - // - // * gp3 - // - // * io1 - // - // * sc1 - // - // * - // st1 - // - // * standard + // - gp2 + // - gp3 + // - io1 + // - sc1 + // - st1 + // - standard VolumeType *string noSmithyDocumentSerde @@ -890,21 +846,20 @@ type AwsAutoScalingLaunchConfigurationDetails struct { ClassicLinkVpcId *string // The identifiers of one or more security groups for the VPC that is specified in - // ClassicLinkVPCId. + // ClassicLinkVPCId . ClassicLinkVpcSecurityGroups []string // The creation date and time for the launch configuration. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedTime *string // Whether the launch configuration is optimized for Amazon EBS I/O. EbsOptimized bool - // The name or the ARN of the instance profile associated with the IAM role for the - // instance. The instance profile contains the IAM role. + // The name or the ARN of the instance profile associated with the IAM role for + // the instance. The instance profile contains the IAM role. IamInstanceProfile *string // The identifier of the Amazon Machine Image (AMI) that is used to launch EC2 @@ -953,8 +908,8 @@ type AwsAutoScalingLaunchConfigurationDetails struct { // Information about the type of monitoring for instances in the group. type AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails struct { - // If set to true, then instances in the group launch with detailed monitoring. If - // set to false, then instances in the group launch with basic monitoring. + // If set to true , then instances in the group launch with detailed monitoring. If + // set to false , then instances in the group launch with basic monitoring. Enabled bool noSmithyDocumentSerde @@ -972,7 +927,7 @@ type AwsAutoScalingLaunchConfigurationMetadataOptions struct { HttpPutResponseHopLimit int32 // Indicates whether token usage is required or optional for metadata requests. By - // default, token usage is optional. + // default, token usage is optional . HttpTokens *string noSmithyDocumentSerde @@ -984,23 +939,21 @@ type AwsBackupBackupPlanAdvancedBackupSettingsDetails struct { // Specifies the backup option for a selected resource. This option is only // available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid values // are as follows: - // - // * Set to WindowsVSS: enabled to enable the WindowsVSS backup - // option and create a Windows VSS backup. - // - // * Set to WindowsVSS: disabled to create - // a regular backup. The WindowsVSS option is not enabled by default. + // - Set to WindowsVSS: enabled to enable the WindowsVSS backup option and create + // a Windows VSS backup. + // - Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS + // option is not enabled by default. BackupOptions map[string]string // The name of a resource type. The only supported resource type is Amazon EC2 - // instances with Windows VSS. The only valid value is EC2. + // instances with Windows VSS. The only valid value is EC2 . ResourceType *string noSmithyDocumentSerde } -// Provides details about an Backup backup plan and an array of BackupRule objects, -// each of which specifies a backup rule. +// Provides details about an Backup backup plan and an array of BackupRule +// objects, each of which specifies a backup rule. type AwsBackupBackupPlanBackupPlanDetails struct { // A list of backup options for each resource type. @@ -1009,15 +962,15 @@ type AwsBackupBackupPlanBackupPlanDetails struct { // The display name of a backup plan. BackupPlanName *string - // An array of BackupRule objects, each of which specifies a scheduled task that is - // used to back up a selection of resources. + // An array of BackupRule objects, each of which specifies a scheduled task that + // is used to back up a selection of resources. BackupPlanRule []AwsBackupBackupPlanRuleDetails noSmithyDocumentSerde } -// Provides details about an Backup backup plan and an array of BackupRule objects, -// each of which specifies a backup rule. +// Provides details about an Backup backup plan and an array of BackupRule +// objects, each of which specifies a backup rule. type AwsBackupBackupPlanDetails struct { // Uniquely identifies the backup plan to be associated with the selection of @@ -1042,7 +995,7 @@ type AwsBackupBackupPlanDetails struct { type AwsBackupBackupPlanLifecycleDetails struct { // Specifies the number of days after creation that a recovery point is deleted. - // Must be greater than 90 days plus MoveToColdStorageAfterDays. + // Must be greater than 90 days plus MoveToColdStorageAfterDays . DeleteAfterDays int64 // Specifies the number of days after creation that a recovery point is moved to @@ -1071,8 +1024,8 @@ type AwsBackupBackupPlanRuleCopyActionsDetails struct { noSmithyDocumentSerde } -// Provides details about an array of BackupRule objects, each of which specifies a -// scheduled task that is used to back up a selection of resources. +// Provides details about an array of BackupRule objects, each of which specifies +// a scheduled task that is used to back up a selection of resources. type AwsBackupBackupPlanRuleDetails struct { // A value in minutes after a backup job is successfully started before it must be @@ -1095,8 +1048,8 @@ type AwsBackupBackupPlanRuleDetails struct { // days. Lifecycle *AwsBackupBackupPlanLifecycleDetails - // Uniquely identifies a rule that is used to schedule the backup of a selection of - // resources. + // Uniquely identifies a rule that is used to schedule the backup of a selection + // of resources. RuleId *string // A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' @@ -1136,8 +1089,8 @@ type AwsBackupBackupVaultDetails struct { // consist of lowercase letters, numbers, and hyphens. BackupVaultName *string - // The unique ARN associated with the server-side encryption key. You can specify a - // key to encrypt your backups from services that support full Backup management. + // The unique ARN associated with the server-side encryption key. You can specify + // a key to encrypt your backups from services that support full Backup management. // If you do not specify a key, Backup creates an KMS key for you by default. EncryptionKeyArn *string @@ -1153,21 +1106,14 @@ type AwsBackupBackupVaultNotificationsDetails struct { // An array of events that indicate the status of jobs to back up resources to the // backup vault. The following events are supported: - // - // * BACKUP_JOB_STARTED | - // BACKUP_JOB_COMPLETED - // - // * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | - // COPY_JOB_FAILED - // - // * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | - // RECOVERY_POINT_MODIFIED - // - // * S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED + // - BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED + // - COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED + // - RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED + // - S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED BackupVaultEvents []string - // The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for - // a backup vault's events. + // The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic + // for a backup vault's events. SnsTopicArn *string noSmithyDocumentSerde @@ -1178,7 +1124,7 @@ type AwsBackupBackupVaultNotificationsDetails struct { type AwsBackupRecoveryPointCalculatedLifecycleDetails struct { // Specifies the number of days after creation that a recovery point is deleted. - // Must be greater than 90 days plus MoveToColdStorageAfterDays. + // Must be greater than 90 days plus MoveToColdStorageAfterDays . DeleteAt *string // Specifies the number of days after creation that a recovery point is moved to @@ -1188,8 +1134,8 @@ type AwsBackupRecoveryPointCalculatedLifecycleDetails struct { noSmithyDocumentSerde } -// Contains information about the backup plan and rule that Backup used to initiate -// the recovery point backup. +// Contains information about the backup plan and rule that Backup used to +// initiate the recovery point backup. type AwsBackupRecoveryPointCreatedByDetails struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan. @@ -1237,12 +1183,12 @@ type AwsBackupRecoveryPointDetails struct { CompletionDate *string // Contains identifying information about the creation of a recovery point, - // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId - // of the backup plan that is used to create it. + // including the BackupPlanArn , BackupPlanId , BackupPlanVersion , and + // BackupRuleId of the backup plan that is used to create it. CreatedBy *AwsBackupRecoveryPointCreatedByDetails - // The date and time a recovery point is created, in Unix format and UTC. The value - // of CreationDate is accurate to milliseconds. For example, the value + // The date and time a recovery point is created, in Unix format and UTC. The + // value of CreationDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. CreationDate *string @@ -1269,8 +1215,8 @@ type AwsBackupRecoveryPointDetails struct { // An ARN that uniquely identifies a recovery point. RecoveryPointArn *string - // An ARN that uniquely identifies a resource. The format of the ARN depends on the - // resource type. + // An ARN that uniquely identifies a resource. The format of the ARN depends on + // the resource type. ResourceArn *string // The type of Amazon Web Services resource saved as a recovery point, such as an @@ -1284,27 +1230,19 @@ type AwsBackupRecoveryPointDetails struct { // A status code specifying the state of the recovery point. Valid values are as // follows: - // - // * COMPLETED - // - // * DELETING - // - // * EXPIRED - // - // * PARTIAL + // - COMPLETED + // - DELETING + // - EXPIRED + // - PARTIAL Status *string // A message explaining the reason of the recovery point deletion failure. StatusMessage *string - // Specifies the storage class of the recovery point. Valid values are as - // follows: - // - // * COLD - // - // * DELETED - // - // * WARM + // Specifies the storage class of the recovery point. Valid values are as follows: + // - COLD + // - DELETED + // - WARM StorageClass *string noSmithyDocumentSerde @@ -1315,7 +1253,7 @@ type AwsBackupRecoveryPointDetails struct { type AwsBackupRecoveryPointLifecycleDetails struct { // Specifies the number of days after creation that a recovery point is deleted. - // Must be greater than 90 days plus MoveToColdStorageAfterDays. + // Must be greater than 90 days plus MoveToColdStorageAfterDays . DeleteAfterDays int64 // Specifies the number of days after creation that a recovery point is moved to @@ -1328,24 +1266,23 @@ type AwsBackupRecoveryPointLifecycleDetails struct { // Provides details about an Certificate Manager certificate. type AwsCertificateManagerCertificateDetails struct { - // The ARN of the private certificate authority (CA) that will be used to issue the - // certificate. + // The ARN of the private certificate authority (CA) that will be used to issue + // the certificate. CertificateAuthorityArn *string // Indicates when the certificate was requested. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedAt *string - // The fully qualified domain name (FQDN), such as www.example.com, that is secured - // by the certificate. + // The fully qualified domain name (FQDN), such as www.example.com, that is + // secured by the certificate. DomainName *string // Contains information about the initial validation of each domain name that // occurs as a result of the RequestCertificate request. Only provided if the - // certificate type is AMAZON_ISSUED. + // certificate type is AMAZON_ISSUED . DomainValidationOptions []AwsCertificateManagerCertificateDomainValidationOption // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object @@ -1361,21 +1298,21 @@ type AwsCertificateManagerCertificateDetails struct { // PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER FailureReason *string - // Indicates when the certificate was imported. Provided if the certificate type is - // IMPORTED. Uses the date-time format specified in RFC 3339 section 5.6, Internet - // Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value - // cannot contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the certificate was imported. Provided if the certificate type + // is IMPORTED . Uses the date-time format specified in RFC 3339 section 5.6, + // Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) . + // The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . ImportedAt *string // The list of ARNs for the Amazon Web Services resources that use the certificate. InUseBy []string // Indicates when the certificate was issued. Provided if the certificate type is - // AMAZON_ISSUED. Uses the date-time format specified in RFC 3339 section 5.6, - // Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The - // value cannot contain spaces, and date and time should be separated by T. For - // example, 2020-03-22T13:22:13.933Z. + // AMAZON_ISSUED . Uses the date-time format specified in RFC 3339 section 5.6, + // Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) . + // The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . IssuedAt *string // The name of the certificate authority that issued and signed the certificate. @@ -1390,21 +1327,19 @@ type AwsCertificateManagerCertificateDetails struct { KeyUsages []AwsCertificateManagerCertificateKeyUsage // The time after which the certificate becomes invalid. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . NotAfter *string // The time before which the certificate is not valid. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . NotBefore *string - // Provides a value that specifies whether to add the certificate to a transparency - // log. + // Provides a value that specifies whether to add the certificate to a + // transparency log. Options *AwsCertificateManagerCertificateOptions // Whether the certificate is eligible for renewal. Valid values: ELIGIBLE | @@ -1412,7 +1347,7 @@ type AwsCertificateManagerCertificateDetails struct { RenewalEligibility *string // Information about the status of the Certificate Manager managed renewal for the - // certificate. Provided only when the certificate type is AMAZON_ISSUED. + // certificate. Provided only when the certificate type is AMAZON_ISSUED . RenewalSummary *AwsCertificateManagerCertificateRenewalSummary // The serial number of the certificate. @@ -1437,8 +1372,8 @@ type AwsCertificateManagerCertificateDetails struct { SubjectAlternativeNames []string // The source of the certificate. For certificates that Certificate Manager - // provides, Type is AMAZON_ISSUED. For certificates that are imported with - // ImportCertificate, Type is IMPORTED. Valid values: IMPORTED | AMAZON_ISSUED | + // provides, Type is AMAZON_ISSUED . For certificates that are imported with + // ImportCertificate , Type is IMPORTED . Valid values: IMPORTED | AMAZON_ISSUED | // PRIVATE Type *string @@ -1446,13 +1381,10 @@ type AwsCertificateManagerCertificateDetails struct { } // Contains information about one of the following: -// -// * The initial validation of -// each domain name that occurs as a result of the RequestCertificate request -// -// * -// The validation of each domain name in the certificate, as it pertains to -// Certificate Manager managed renewal +// - The initial validation of each domain name that occurs as a result of the +// RequestCertificate request +// - The validation of each domain name in the certificate, as it pertains to +// Certificate Manager managed renewal type AwsCertificateManagerCertificateDomainValidationOption struct { // A fully qualified domain name (FQDN) in the certificate. @@ -1516,7 +1448,7 @@ type AwsCertificateManagerCertificateRenewalSummary struct { // Information about the validation of each domain name in the certificate, as it // pertains to Certificate Manager managed renewal. Provided only when the - // certificate type is AMAZON_ISSUED. + // certificate type is AMAZON_ISSUED . DomainValidationOptions []AwsCertificateManagerCertificateDomainValidationOption // The status of the Certificate Manager managed renewal of the certificate. Valid @@ -1524,7 +1456,7 @@ type AwsCertificateManagerCertificateRenewalSummary struct { RenewalStatus *string // The reason that a renewal request was unsuccessful. This attribute is used only - // when RenewalStatus is FAILED. Valid values: NO_AVAILABLE_CONTACTS | + // when RenewalStatus is FAILED . Valid values: NO_AVAILABLE_CONTACTS | // ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | // DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | // PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | @@ -1533,10 +1465,9 @@ type AwsCertificateManagerCertificateRenewalSummary struct { RenewalStatusReason *string // Indicates when the renewal summary was last updated. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . UpdatedAt *string noSmithyDocumentSerde @@ -1646,16 +1577,12 @@ type AwsCloudFrontDistributionCacheBehavior struct { // The protocol that viewers can use to access the files in an origin. You can // specify the following options: - // - // * allow-all - Viewers can use HTTP or HTTPS. - // - // * - // redirect-to-https - CloudFront responds to HTTP requests with an HTTP status - // code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new - // URL to resubmit. - // - // * https-only - CloudFront responds to HTTP request with an - // HTTP status code of 403 (Forbidden). + // - allow-all - Viewers can use HTTP or HTTPS. + // - redirect-to-https - CloudFront responds to HTTP requests with an HTTP status + // code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new + // URL to resubmit. + // - https-only - CloudFront responds to HTTP request with an HTTP status code of + // 403 (Forbidden). ViewerProtocolPolicy *string noSmithyDocumentSerde @@ -1676,16 +1603,12 @@ type AwsCloudFrontDistributionDefaultCacheBehavior struct { // The protocol that viewers can use to access the files in an origin. You can // specify the following options: - // - // * allow-all - Viewers can use HTTP or HTTPS. - // - // * - // redirect-to-https - CloudFront responds to HTTP requests with an HTTP status - // code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new - // URL to resubmit. - // - // * https-only - CloudFront responds to HTTP request with an - // HTTP status code of 403 (Forbidden). + // - allow-all - Viewers can use HTTP or HTTPS. + // - redirect-to-https - CloudFront responds to HTTP requests with an HTTP status + // code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new + // URL to resubmit. + // - https-only - CloudFront responds to HTTP request with an HTTP status code of + // 403 (Forbidden). ViewerProtocolPolicy *string noSmithyDocumentSerde @@ -1713,10 +1636,9 @@ type AwsCloudFrontDistributionDetails struct { ETag *string // Indicates when that the distribution was last modified. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastModifiedTime *string // A complex type that controls whether access logs are written for the @@ -1756,8 +1678,8 @@ type AwsCloudFrontDistributionLogging struct { // Specifies whether you want CloudFront to include cookies in access logs. IncludeCookies bool - // An optional string that you want CloudFront to use as a prefix to the access log - // filenames for this distribution. + // An optional string that you want CloudFront to use as a prefix to the access + // log filenames for this distribution. Prefix *string noSmithyDocumentSerde @@ -1823,8 +1745,8 @@ type AwsCloudFrontDistributionOriginGroupFailoverStatusCodes struct { noSmithyDocumentSerde } -// Provides information about origin groups that are associated with the CloudFront -// distribution. +// Provides information about origin groups that are associated with the +// CloudFront distribution. type AwsCloudFrontDistributionOriginGroups struct { // The list of origin groups. @@ -1900,30 +1822,30 @@ type AwsCloudFrontDistributionOriginSslProtocols struct { // distribution uses to communicate with viewers. type AwsCloudFrontDistributionViewerCertificate struct { - // The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you - // provide an ACM certificate ARN, you must also provide MinimumCertificateVersion - // and SslSupportMethod. + // The ARN of the ACM certificate. Used if the certificate is stored in ACM. If + // you provide an ACM certificate ARN, you must also provide + // MinimumCertificateVersion and SslSupportMethod . AcmCertificateArn *string // The identifier of the certificate. Note that in CloudFront, this attribute is // deprecated. Certificate *string - // The source of the certificate identified by Certificate. Note that in + // The source of the certificate identified by Certificate . Note that in // CloudFront, this attribute is deprecated. CertificateSource *string - // Whether the distribution uses the CloudFront domain name. If set to false, then - // you provide either AcmCertificateArn or IamCertificateId. + // Whether the distribution uses the CloudFront domain name. If set to false , then + // you provide either AcmCertificateArn or IamCertificateId . CloudFrontDefaultCertificate bool - // The identifier of the IAM certificate. Used if the certificate is stored in IAM. - // If you provide IamCertificateId, then you also must provide - // MinimumProtocolVersion and SslSupportMethod. + // The identifier of the IAM certificate. Used if the certificate is stored in + // IAM. If you provide IamCertificateId , then you also must provide + // MinimumProtocolVersion and SslSupportMethod . IamCertificateId *string // The security policy that CloudFront uses for HTTPS connections with viewers. If - // SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1 or + // SslSupportMethod is sni-only , then MinimumProtocolVersion must be TLSv1 or // higher. MinimumProtocolVersion *string @@ -1949,8 +1871,8 @@ type AwsCloudTrailTrailDetails struct { // The Region where the trail was created. HomeRegion *string - // Indicates whether the trail publishes events from global services such as IAM to - // the log files. + // Indicates whether the trail publishes events from global services such as IAM + // to the log files. IncludeGlobalServiceEvents bool // Indicates whether the trail applies only to the current Region or to all @@ -1973,8 +1895,8 @@ type AwsCloudTrailTrailDetails struct { // The name of the S3 bucket where the log files are published. S3BucketName *string - // The S3 key prefix. The key prefix is added after the name of the S3 bucket where - // the log files are published. + // The S3 key prefix. The key prefix is added after the name of the S3 bucket + // where the log files are published. S3KeyPrefix *string // The ARN of the SNS topic that is used for notifications of log file delivery. @@ -2024,7 +1946,7 @@ type AwsCloudWatchAlarmDetails struct { // The dimensions for the metric associated with the alarm. Dimensions []AwsCloudWatchAlarmDimensionsDetails - // Used only for alarms based on percentiles. If ignore, the alarm state does not + // Used only for alarms based on percentiles. If ignore , the alarm state does not // change during periods with too few data points to be statistically significant. // If evaluate or this parameter is not used, the alarm is always evaluated and // possibly changes state no matter how many data points are available. @@ -2042,7 +1964,7 @@ type AwsCloudWatchAlarmDetails struct { // The name of the metric associated with the alarm. This is required for an alarm // based on a metric. For an alarm based on a math expression, you use Metrics - // instead and you can't specify MetricName. + // instead and you can't specify MetricName . MetricName *string // The namespace of the metric associated with the alarm. This is required for an @@ -2059,10 +1981,10 @@ type AwsCloudWatchAlarmDetails struct { Period int32 // The statistic for the metric associated with the alarm, other than percentile. - // For percentile statistics, use ExtendedStatistic. For an alarm based on a - // metric, you must specify either Statistic or ExtendedStatistic but not both. For - // an alarm based on a math expression, you can't specify Statistic. Instead, you - // use Metrics. + // For percentile statistics, use ExtendedStatistic . For an alarm based on a + // metric, you must specify either Statistic or ExtendedStatistic but not both. + // For an alarm based on a math expression, you can't specify Statistic . Instead, + // you use Metrics . Statistic *string // The value to compare with the specified statistic. @@ -2099,11 +2021,11 @@ type AwsCodeBuildProjectArtifactsDetails struct { // An identifier for the artifact definition. ArtifactIdentifier *string - // Indicates whether to disable encryption on the artifact. Only valid when Type is - // S3. + // Indicates whether to disable encryption on the artifact. Only valid when Type + // is S3 . EncryptionDisabled bool - // Only used when Type is S3. The name of the S3 bucket where the artifact is + // Only used when Type is S3 . The name of the S3 bucket where the artifact is // located. Location *string @@ -2111,17 +2033,17 @@ type AwsCodeBuildProjectArtifactsDetails struct { // Path to determine the pattern for storing the artifact. Name *string - // Only used when Type is S3. The value to use for the namespace. Used with Name + // Only used when Type is S3 . The value to use for the namespace. Used with Name // and Path to determine the pattern for storing the artifact. NamespaceType *string // Whether the name specified in the buildspec file overrides the artifact name. OverrideArtifactName bool - // Only used when Type is S3. The type of output artifact to create. + // Only used when Type is S3 . The type of output artifact to create. Packaging *string - // Only used when Type is S3. The path to the artifact. Used with Name and + // Only used when Type is S3 . The path to the artifact. Used with Name and // NamespaceType to determine the pattern for storing the artifact. Path *string @@ -2154,8 +2076,8 @@ type AwsCodeBuildProjectDetails struct { // Information about the secondary artifacts for the CodeBuild project. SecondaryArtifacts []AwsCodeBuildProjectArtifactsDetails - // The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon - // Web Services services on behalf of the Amazon Web Services account. + // The ARN of the IAM role that enables CodeBuild to interact with dependent + // Amazon Web Services services on behalf of the Amazon Web Services account. ServiceRole *string // Information about the build input source code for this build project. @@ -2179,17 +2101,14 @@ type AwsCodeBuildProjectEnvironment struct { // The type of credentials CodeBuild uses to pull images in your build. Valid // values: - // - // * CODEBUILD specifies that CodeBuild uses its own credentials. This - // requires that you modify your ECR repository policy to trust the CodeBuild - // service principal. - // - // * SERVICE_ROLE specifies that CodeBuild uses your build - // project's service role. - // - // When you use a cross-account or private registry image, - // you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, - // you must use CODEBUILD credentials. + // - CODEBUILD specifies that CodeBuild uses its own credentials. This requires + // that you modify your ECR repository policy to trust the CodeBuild service + // principal. + // - SERVICE_ROLE specifies that CodeBuild uses your build project's service + // role. + // When you use a cross-account or private registry image, you must use + // SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use + // CODEBUILD credentials. ImagePullCredentialsType *string // Whether to allow the Docker daemon to run inside a Docker container. Set to true @@ -2238,13 +2157,13 @@ type AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails struct { // The credentials for access to a private registry. type AwsCodeBuildProjectEnvironmentRegistryCredential struct { - // The ARN or name of credentials created using Secrets Manager. The credential can - // use the name of the credentials only if they exist in your current Amazon Web - // Services Region. + // The ARN or name of credentials created using Secrets Manager. The credential + // can use the name of the credentials only if they exist in your current Amazon + // Web Services Region. Credential *string // The service that created the credentials to access a private Docker registry. - // The valid value, SECRETS_MANAGER, is for Secrets Manager. + // The valid value, SECRETS_MANAGER , is for Secrets Manager. CredentialProvider *string noSmithyDocumentSerde @@ -2303,58 +2222,34 @@ type AwsCodeBuildProjectSource struct { // Information about the location of the source code to be built. Valid values // include: - // - // * For source code settings that are specified in the source action of - // a pipeline in CodePipeline, location should not be specified. If it is - // specified, CodePipeline ignores it. This is because CodePipeline uses the - // settings in a pipeline's source action instead of this value. - // - // * For source code - // in an CodeCommit repository, the HTTPS clone URL to the repository that contains - // the source code and the build spec file (for example, - // https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ). - // - // * For - // source code in an S3 input bucket, one of the following. - // - // * The path to the ZIP - // file that contains the source code (for example, - // bucket-name/path/to/object-name.zip). - // - // * The path to the folder that contains - // the source code (for example, bucket-name/path/to/source-code/folder/). - // - // * For - // source code in a GitHub repository, the HTTPS clone URL to the repository that - // contains the source and the build spec file. - // - // * For source code in a Bitbucket - // repository, the HTTPS clone URL to the repository that contains the source and - // the build spec file. + // - For source code settings that are specified in the source action of a + // pipeline in CodePipeline, location should not be specified. If it is specified, + // CodePipeline ignores it. This is because CodePipeline uses the settings in a + // pipeline's source action instead of this value. + // - For source code in an CodeCommit repository, the HTTPS clone URL to the + // repository that contains the source code and the build spec file (for example, + // https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ). + // - For source code in an S3 input bucket, one of the following. + // - The path to the ZIP file that contains the source code (for example, + // bucket-name/path/to/object-name.zip ). + // - The path to the folder that contains the source code (for example, + // bucket-name/path/to/source-code/folder/ ). + // - For source code in a GitHub repository, the HTTPS clone URL to the + // repository that contains the source and the build spec file. + // - For source code in a Bitbucket repository, the HTTPS clone URL to the + // repository that contains the source and the build spec file. Location *string // The type of repository that contains the source code to be built. Valid values // are: - // - // * BITBUCKET - The source code is in a Bitbucket repository. - // - // * CODECOMMIT - // - The source code is in an CodeCommit repository. - // - // * CODEPIPELINE - The source - // code settings are specified in the source action of a pipeline in - // CodePipeline. - // - // * GITHUB - The source code is in a GitHub repository. - // - // * - // GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository. - // - // * - // NO_SOURCE - The project does not have input source code. - // - // * S3 - The source code - // is in an S3 input bucket. + // - BITBUCKET - The source code is in a Bitbucket repository. + // - CODECOMMIT - The source code is in an CodeCommit repository. + // - CODEPIPELINE - The source code settings are specified in the source action + // of a pipeline in CodePipeline. + // - GITHUB - The source code is in a GitHub repository. + // - GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository. + // - NO_SOURCE - The project does not have input source code. + // - S3 - The source code is in an S3 input bucket. Type *string noSmithyDocumentSerde @@ -2418,11 +2313,11 @@ type AwsDynamoDbTableBillingModeSummary struct { // The method used to charge for read and write throughput and to manage capacity. BillingMode *string - // If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was set + // If the billing mode is PAY_PER_REQUEST , indicates when the billing mode was set // to that value. Uses the date-time format specified in RFC 3339 section 5.6, - // Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The - // value cannot contain spaces, and date and time should be separated by T. For - // example, 2020-03-22T13:22:13.933Z. + // Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) . + // The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastUpdateToPayPerRequestDateTime *string noSmithyDocumentSerde @@ -2437,11 +2332,10 @@ type AwsDynamoDbTableDetails struct { // Information about the billing for read/write capacity on the table. BillingModeSummary *AwsDynamoDbTableBillingModeSummary - // Indicates when the table was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the table was created. Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreationDateTime *string // List of global secondary indexes for the table. @@ -2490,22 +2384,13 @@ type AwsDynamoDbTableDetails struct { TableSizeBytes int64 // The current status of the table. Valid values are as follows: - // - // * ACTIVE - // - // * - // ARCHIVED - // - // * ARCHIVING - // - // * CREATING - // - // * DELETING - // - // * - // INACCESSIBLE_ENCRYPTION_CREDENTIALS - // - // * UPDATING + // - ACTIVE + // - ARCHIVED + // - ARCHIVING + // - CREATING + // - DELETING + // - INACCESSIBLE_ENCRYPTION_CREDENTIALS + // - UPDATING TableStatus *string noSmithyDocumentSerde @@ -2527,14 +2412,10 @@ type AwsDynamoDbTableGlobalSecondaryIndex struct { IndexSizeBytes int64 // The current status of the index. - // - // * ACTIVE - // - // * CREATING - // - // * DELETING - // - // * UPDATING + // - ACTIVE + // - CREATING + // - DELETING + // - UPDATING IndexStatus *string // The number of items in the index. @@ -2560,7 +2441,7 @@ type AwsDynamoDbTableKeySchema struct { AttributeName *string // The type of key used for the key schema attribute. Valid values are HASH or - // RANGE. + // RANGE . KeyType *string noSmithyDocumentSerde @@ -2596,12 +2477,9 @@ type AwsDynamoDbTableProjection struct { // The types of attributes that are projected into the index. Valid values are as // follows: - // - // * ALL - // - // * INCLUDE - // - // * KEYS_ONLY + // - ALL + // - INCLUDE + // - KEYS_ONLY ProjectionType *string noSmithyDocumentSerde @@ -2612,17 +2490,15 @@ type AwsDynamoDbTableProjection struct { type AwsDynamoDbTableProvisionedThroughput struct { // Indicates when the provisioned throughput was last decreased. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastDecreaseDateTime *string // Indicates when the provisioned throughput was last increased. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastIncreaseDateTime *string // The number of times during the current UTC calendar day that the provisioned @@ -2630,11 +2506,11 @@ type AwsDynamoDbTableProvisionedThroughput struct { NumberOfDecreasesToday int32 // The maximum number of strongly consistent reads consumed per second before - // DynamoDB returns a ThrottlingException. + // DynamoDB returns a ThrottlingException . ReadCapacityUnits int32 // The maximum number of writes consumed per second before DynamoDB returns a - // ThrottlingException. + // ThrottlingException . WriteCapacityUnits int32 noSmithyDocumentSerde @@ -2666,17 +2542,11 @@ type AwsDynamoDbTableReplica struct { RegionName *string // The current status of the replica. Valid values are as follows: - // - // * ACTIVE - // - // * - // CREATING - // - // * CREATION_FAILED - // - // * DELETING - // - // * UPDATING + // - ACTIVE + // - CREATING + // - CREATION_FAILED + // - DELETING + // - UPDATING ReplicaStatus *string // Detailed information about the replica status. @@ -2701,10 +2571,9 @@ type AwsDynamoDbTableReplicaGlobalSecondaryIndex struct { type AwsDynamoDbTableRestoreSummary struct { // Indicates the point in time that the table was restored to. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . RestoreDateTime *string // Whether a restore is currently in progress. @@ -2724,10 +2593,9 @@ type AwsDynamoDbTableSseDescription struct { // If the key is inaccessible, the date and time when DynamoDB detected that the // key was inaccessible. Uses the date-time format specified in RFC 3339 section - // 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . InaccessibleEncryptionDateTime *string // The ARN of the KMS key that is used for the KMS encryption. @@ -2761,12 +2629,12 @@ type AwsEc2EipDetails struct { // the Elastic IP address for use with Amazon VPC. AllocationId *string - // The identifier that represents the association of the Elastic IP address with an - // EC2 instance. + // The identifier that represents the association of the Elastic IP address with + // an EC2 instance. AssociationId *string // The domain in which to allocate the address. If the address is for use with EC2 - // instances in a VPC, then Domain is vpc. Otherwise, Domain is standard. + // instances in a VPC, then Domain is vpc . Otherwise, Domain is standard . Domain *string // The identifier of the EC2 instance. @@ -2787,8 +2655,8 @@ type AwsEc2EipDetails struct { // A public IP address that is associated with the EC2 instance. PublicIp *string - // The identifier of an IP address pool. This parameter allows Amazon EC2 to select - // an IP address from the address pool. + // The identifier of an IP address pool. This parameter allows Amazon EC2 to + // select an IP address from the address pool. PublicIpv4Pool *string noSmithyDocumentSerde @@ -2812,11 +2680,10 @@ type AwsEc2InstanceDetails struct { // The key name associated with the instance. KeyName *string - // Indicates when the instance was launched. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the instance was launched. Uses the date-time format specified + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LaunchedAt *string // Details about the metadata options for the Amazon EC2 instance. @@ -2836,8 +2703,8 @@ type AwsEc2InstanceDetails struct { // The instance type of the instance. Type *string - // The virtualization type of the Amazon Machine Image (AMI) required to launch the - // instance. + // The virtualization type of the Amazon Machine Image (AMI) required to launch + // the instance. VirtualizationType *string // The identifier of the VPC that the instance was launched in. @@ -2905,8 +2772,8 @@ type AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails struct { // The virtual device name (ephemeralN). Instance store volumes are numbered // starting from 0. An instance type with 2 available instance store volumes can - // specify mappings for ephemeral0 and ephemeral1. The number of available instance - // store volumes depends on the instance type. + // specify mappings for ephemeral0 and ephemeral1 . The number of available + // instance store volumes depends on the instance type. VirtualName *string noSmithyDocumentSerde @@ -2964,11 +2831,11 @@ type AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservation // Specifies the Capacity Reservation targeting option of an Amazon EC2 instance. type AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails struct { - // Indicates the instance's Capacity Reservation preferences. If equal to open, the - // instance can run in any open Capacity Reservation that has matching attributes - // (instance type, platform, Availability Zone). If equal to none, the instance - // avoids running in a Capacity Reservation even if one is available. The instance - // runs in On-Demand capacity. + // Indicates the instance's Capacity Reservation preferences. If equal to open , + // the instance can run in any open Capacity Reservation that has matching + // attributes (instance type, platform, Availability Zone). If equal to none , the + // instance avoids running in a Capacity Reservation even if one is available. The + // instance runs in On-Demand capacity. CapacityReservationPreference *string // Specifies a target Capacity Reservation. @@ -2978,16 +2845,15 @@ type AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails struct { } // Specifies the CPU options for an Amazon EC2 instance. For more information, see -// Optimize CPU options -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) +// Optimize CPU options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. type AwsEc2LaunchTemplateDataCpuOptionsDetails struct { // The number of CPU cores for the instance. CoreCount int32 - // The number of threads per CPU core. A value of 1 disables multithreading for the - // instance, The default value is 2. + // The number of threads per CPU core. A value of 1 disables multithreading for + // the instance, The default value is 2 . ThreadsPerCore int32 noSmithyDocumentSerde @@ -3015,8 +2881,7 @@ type AwsEc2LaunchTemplateDataDetails struct { CapacityReservationSpecification *AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails // Specifies the CPU options for an instance. For more information, see Optimize - // CPU options - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) + // CPU options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) // in the Amazon Elastic Compute Cloud User Guide. CpuOptions *AwsEc2LaunchTemplateDataCpuOptionsDetails @@ -3024,13 +2889,12 @@ type AwsEc2LaunchTemplateDataDetails struct { CreditSpecification *AwsEc2LaunchTemplateDataCreditSpecificationDetails // Indicates whether to enable the instance for stop protection. For more - // information, see Enable stop protection - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) + // information, see Enable stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) // in the Amazon EC2 User Guide. DisableApiStop bool - // If you set this parameter to true, you can't terminate the instance using the - // Amazon EC2 console, CLI, or API. If set to true, you can. + // If you set this parameter to true , you can't terminate the instance using the + // Amazon EC2 console, CLI, or API. If set to true , you can. DisableApiTermination bool // Indicates whether the instance is optimized for Amazon EBS I/O. @@ -3064,13 +2928,12 @@ type AwsEc2LaunchTemplateDataDetails struct { // The attributes for the instance types. When you specify instance attributes, // Amazon EC2 will identify instance types with these attributes. If you specify - // InstanceRequirements, you can't specify InstanceType. + // InstanceRequirements , you can't specify InstanceType . InstanceRequirements *AwsEc2LaunchTemplateDataInstanceRequirementsDetails - // The instance type. For more information, see Instance types - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the - // Amazon EC2 User Guide. If you specify InstanceType, you can't specify - // InstanceRequirements. + // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) + // in the Amazon EC2 User Guide. If you specify InstanceType , you can't specify + // InstanceRequirements . InstanceType *string // The ID of the kernel. @@ -3086,8 +2949,7 @@ type AwsEc2LaunchTemplateDataDetails struct { MaintenanceOptions *AwsEc2LaunchTemplateDataMaintenanceOptionsDetails // The metadata options for the instance. For more information, see Instance - // metadata and user data - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) // in the Amazon EC2 User Guide. MetadataOptions *AwsEc2LaunchTemplateDataMetadataOptionsDetails @@ -3147,7 +3009,7 @@ type AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails struct { // Enclaves. type AwsEc2LaunchTemplateDataEnclaveOptionsDetails struct { - // If this parameter is set to true, the instance is enabled for Amazon Web + // If this parameter is set to true , the instance is enabled for Amazon Web // Services Nitro Enclaves. Enabled bool @@ -3157,7 +3019,7 @@ type AwsEc2LaunchTemplateDataEnclaveOptionsDetails struct { // Specifies whether your Amazon EC2 instance is configured for hibernation. type AwsEc2LaunchTemplateDataHibernationOptionsDetails struct { - // If you set this parameter to true, the instance is enabled for hibernation. + // If you set this parameter to true , the instance is enabled for hibernation. Configured bool noSmithyDocumentSerde @@ -3216,7 +3078,7 @@ type AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails struct { type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails struct { // The maximum number of accelerators. If this parameter isn't specified, there's - // no maximum limit. To exclude accelerator-enabled instance types, set Max to 0. + // no maximum limit. To exclude accelerator-enabled instance types, set Max to 0 . Max int32 // The minimum number of accelerators. If this parameter isn't specified, there's @@ -3230,8 +3092,8 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails struct // Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails struct { - // The maximum amount of memory, in MiB. If this parameter isn't specified, there's - // no maximum limit. + // The maximum amount of memory, in MiB. If this parameter isn't specified, + // there's no maximum limit. Max int32 // The minimum amount of memory, in MiB. If 0 is specified, there's no maximum @@ -3241,10 +3103,9 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetail noSmithyDocumentSerde } -// The minimum and maximum baseline bandwidth to Amazon Elastic Block Store (Amazon -// EBS), in Mbps. For more information, see Amazon EBS–optimized instances -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the -// Amazon EC2 User Guide. +// The minimum and maximum baseline bandwidth to Amazon Elastic Block Store +// (Amazon EBS), in Mbps. For more information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) +// in the Amazon EC2 User Guide. type AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails struct { // The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's @@ -3283,14 +3144,12 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { BareMetal *string // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more - // information, see Amazon EBS optimized instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the - // Amazon EC2 User Guide. + // information, see Amazon EBS optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) + // in the Amazon EC2 User Guide. BaselineEbsBandwidthMbps *AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails - // Indicates whether burstable performance T instance types are included, excluded, - // or required. For more information, Burstable performance instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) + // Indicates whether burstable performance T instance types are included, + // excluded, or required. For more information, Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) // in the Amazon EC2 User Guide. BurstablePerformance *string @@ -3304,9 +3163,8 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { InstanceGenerations []string // Indicates whether instance types with instance store volumes are included, - // excluded, or required. For more information, see Amazon EC2 instance store - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in - // the Amazon EC2 User Guide. + // excluded, or required. For more information, see Amazon EC2 instance store (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) + // in the Amazon EC2 User Guide. LocalStorage *string // The type of local storage that is required. @@ -3327,7 +3185,7 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { // attributes. When Amazon EC2 selects instance types with your attributes, it // excludes instance types priced above your threshold. The parameter accepts an // integer, which Amazon EC2 interprets as a percentage. A high value, such as - // 999999, turns off price protection. + // 999999 , turns off price protection. OnDemandMaxPricePercentageOverLowestPrice int32 // Indicates whether instance types must support hibernation for On-Demand @@ -3339,7 +3197,7 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { // current generation M, C, or R instance type with your specified attributes. When // Amazon EC2 selects instance types with your attributes, it excludes instance // types priced above your threshold. The parameter accepts an integer, which - // Amazon EC2 interprets as a percentage. A high value, such as 999999, turns off + // Amazon EC2 interprets as a percentage. A high value, such as 999999 , turns off // price protection. SpotMaxPricePercentageOverLowestPrice int32 @@ -3378,8 +3236,8 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails struct { noSmithyDocumentSerde } -// The minimum and maximum number of network interfaces to be attached to an Amazon -// EC2 instance. +// The minimum and maximum number of network interfaces to be attached to an +// Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails struct { // The maximum number of network interfaces. @@ -3391,8 +3249,8 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails st noSmithyDocumentSerde } -// The minimum and maximum amount of total local storage, in GB, that an Amazon EC2 -// instance uses. +// The minimum and maximum amount of total local storage, in GB, that an Amazon +// EC2 instance uses. type AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails struct { // The maximum amount of total local storage, in GB. @@ -3452,11 +3310,10 @@ type AwsEc2LaunchTemplateDataMetadataOptionsDetails struct { // The state of token usage for your instance metadata requests. HttpTokens *string - // When set to enabled, this parameter allows access to instance tags from the - // instance metadata. When set to disabled, it turns off access to instance tags - // from the instance metadata. For more information, see Work with instance tags in - // instance metadata - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) + // When set to enabled , this parameter allows access to instance tags from the + // instance metadata. When set to disabled , it turns off access to instance tags + // from the instance metadata. For more information, see Work with instance tags + // in instance metadata (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS) // in the Amazon EC2 User Guide. InstanceMetadataTags *string @@ -3468,8 +3325,7 @@ type AwsEc2LaunchTemplateDataMonitoringDetails struct { // Enables detailed monitoring when true is specified. Otherwise, basic monitoring // is enabled. For more information about detailed monitoring, see Enable or turn - // off detailed monitoring for your instances - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) + // off detailed monitoring for your instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) // in the Amazon EC2 User Guide. Enabled bool @@ -3484,8 +3340,7 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct { // Indicates whether to associate a Carrier IP address with eth0 for a new network // interface. You use this option when you launch an instance in a Wavelength Zone // and want to associate a Carrier IP address with the network interface. For more - // information, see Carrier IP address - // (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) + // information, see Carrier IP address (https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) // in the Wavelength Developer Guide. AssociateCarrierIpAddress bool @@ -3518,11 +3373,11 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct { // The number of IPv6 addresses to assign to a network interface. Amazon EC2 // automatically selects the IPv6 addresses from the subnet range. You can't use - // this option if you use Ipv6Addresses. + // this option if you use Ipv6Addresses . Ipv6AddressCount int32 // One or more specific IPv6 addresses from the IPv6 CIDR block range of your - // subnet. You can't use this option if you use Ipv6AddressCount. + // subnet. You can't use this option if you use Ipv6AddressCount . Ipv6Addresses []AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails // The number of IPv6 prefixes to be automatically assigned to the network @@ -3534,8 +3389,8 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct { Ipv6Prefixes []AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails // The index of the network card. Some instance types support multiple network - // cards. The primary network interface must be assigned to network card index 0. - // The default is network card index 0. + // cards. The primary network interface must be assigned to network card index 0 . + // The default is network card index 0 . NetworkCardIndex int32 // The ID of the network interface. @@ -3560,9 +3415,8 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct { type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails struct { // The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 - // network interfaces - // (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the - // Amazon Elastic Compute Cloud User Guide. + // network interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) + // in the Amazon Elastic Compute Cloud User Guide. Ipv4Prefix *string noSmithyDocumentSerde @@ -3616,8 +3470,8 @@ type AwsEc2LaunchTemplateDataPlacementDetails struct { // The ID of the Dedicated Host for the instance. HostId *string - // The Amazon Resource Name (ARN) of the host resource group in which to launch the - // instances. + // The Amazon Resource Name (ARN) of the host resource group in which to launch + // the instances. HostResourceGroupArn *string // The number of the partition the instance should launch in. @@ -3636,8 +3490,8 @@ type AwsEc2LaunchTemplateDataPlacementDetails struct { // Describes the options for Amazon EC2 instance hostnames. type AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails struct { - // Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA - // records. + // Indicates whether to respond to DNS queries for instance hostnames with DNS + // AAAA records. EnableResourceNameDnsAAAARecord bool // Indicates whether to respond to DNS queries for instance hostnames with DNS A @@ -3732,8 +3586,8 @@ type AwsEc2NetworkAclEntry struct { // For TCP or UDP protocols, the range of ports that the rule applies to. PortRange *PortRangeFromTo - // The protocol that the rule applies to. To deny or allow access to all protocols, - // use the value -1. + // The protocol that the rule applies to. To deny or allow access to all + // protocols, use the value -1 . Protocol *string // Whether the rule is used to allow access or deny access. @@ -3749,10 +3603,9 @@ type AwsEc2NetworkAclEntry struct { type AwsEc2NetworkInterfaceAttachment struct { // Indicates when the attachment initiated. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . AttachTime *string // The identifier of the network interface attachment @@ -3898,12 +3751,12 @@ type AwsEc2SecurityGroupIpPermission struct { // ICMP/ICMPv6 types, you must specify all codes. FromPort int32 - // The IP protocol name (tcp, udp, icmp, icmpv6) or number. [VPC only] Use -1 to - // specify all protocols. When authorizing security group rules, specifying -1 or a - // protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all - // ports, regardless of any port range you specify. For tcp, udp, and icmp, you - // must specify a port range. For icmpv6, the port range is optional. If you omit - // the port range, traffic for all types and codes is allowed. + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number. [VPC only] Use -1 + // to specify all protocols. When authorizing security group rules, specifying -1 + // or a protocol number other than tcp , udp , icmp , or icmpv6 allows traffic on + // all ports, regardless of any port range you specify. For tcp , udp , and icmp , + // you must specify a port range. For icmpv6 , the port range is optional. If you + // omit the port range, traffic for all types and codes is allowed. IpProtocol *string // The IPv4 ranges. @@ -3912,14 +3765,14 @@ type AwsEc2SecurityGroupIpPermission struct { // The IPv6 ranges. Ipv6Ranges []AwsEc2SecurityGroupIpv6Range - // [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound - // rules, this is the Amazon Web Services service to access through a VPC endpoint - // from instances associated with the security group. + // [VPC only] The prefix list IDs for an Amazon Web Services service. With + // outbound rules, this is the Amazon Web Services service to access through a VPC + // endpoint from instances associated with the security group. PrefixListIds []AwsEc2SecurityGroupPrefixListId - // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. - // A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 - // types, you must specify all codes. + // The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 + // code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all + // ICMP/ICMPv6 types, you must specify all codes. ToPort int32 // The security group and Amazon Web Services account ID pairs. @@ -3990,8 +3843,8 @@ type AwsEc2SecurityGroupUserIdGroupPair struct { // Contains information about a subnet in Amazon EC2. type AwsEc2SubnetDetails struct { - // Whether to assign an IPV6 address to a network interface that is created in this - // subnet. + // Whether to assign an IPV6 address to a network interface that is created in + // this subnet. AssignIpv6AddressOnCreation bool // The Availability Zone for the subnet. @@ -4000,8 +3853,8 @@ type AwsEc2SubnetDetails struct { // The identifier of the Availability Zone for the subnet. AvailabilityZoneId *string - // The number of available IPV4 addresses in the subnet. Does not include addresses - // for stopped instances. + // The number of available IPV4 addresses in the subnet. Does not include + // addresses for stopped instances. AvailableIpAddressCount int32 // The IPV4 CIDR block that is assigned to the subnet. @@ -4019,7 +3872,7 @@ type AwsEc2SubnetDetails struct { // The identifier of the Amazon Web Services account that owns the subnet. OwnerId *string - // The current state of the subnet. Valid values are available or pending. + // The current state of the subnet. Valid values are available or pending . State *string // The ARN of the subnet. @@ -4092,17 +3945,11 @@ type AwsEc2VolumeAttachment struct { InstanceId *string // The attachment state of the volume. Valid values are as follows: - // - // * attaching - // - // * - // attached - // - // * busy - // - // * detaching - // - // * detached + // - attaching + // - attached + // - busy + // - detaching + // - detached Status *string noSmithyDocumentSerde @@ -4115,10 +3962,9 @@ type AwsEc2VolumeDetails struct { Attachments []AwsEc2VolumeAttachment // Indicates when the volume was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateTime *string // The device name for the volume that is attached to the instance. @@ -4138,19 +3984,12 @@ type AwsEc2VolumeDetails struct { SnapshotId *string // The volume state. Valid values are as follows: - // - // * available - // - // * creating - // - // * - // deleted - // - // * deleting - // - // * error - // - // * in-use + // - available + // - creating + // - deleted + // - deleting + // - error + // - in-use Status *string // The ID of the volume. @@ -4179,7 +4018,7 @@ type AwsEc2VpcDetails struct { // Information about the IPv6 CIDR blocks associated with the VPC. Ipv6CidrBlockAssociationSet []Ipv6CidrBlockAssociation - // The current state of the VPC. Valid values are available or pending. + // The current state of the VPC. Valid values are available or pending . State *string noSmithyDocumentSerde @@ -4217,17 +4056,11 @@ type AwsEc2VpcEndpointServiceDetails struct { ServiceName *string // The current state of the service. Valid values are as follows: - // - // * Available - // - // * - // Deleted - // - // * Deleting - // - // * Failed - // - // * Pending + // - Available + // - Deleted + // - Deleting + // - Failed + // - Pending ServiceState *string // The types for the service. @@ -4330,15 +4163,10 @@ type AwsEc2VpnConnectionDetails struct { Routes []AwsEc2VpnConnectionRoutesDetails // The current state of the VPN connection. Valid values are as follows: - // - // * - // available - // - // * deleted - // - // * deleting - // - // * pending + // - available + // - deleted + // - deleting + // - pending State *string // The identifier of the transit gateway that is associated with the VPN @@ -4354,8 +4182,8 @@ type AwsEc2VpnConnectionDetails struct { // The identifier of the VPN connection. VpnConnectionId *string - // The identifier of the virtual private gateway that is at the Amazon Web Services - // side of the VPN connection. + // The identifier of the virtual private gateway that is at the Amazon Web + // Services side of the VPN connection. VpnGatewayId *string noSmithyDocumentSerde @@ -4458,17 +4286,16 @@ type AwsEc2VpnConnectionVgwTelemetryDetails struct { CertificateArn *string // The date and time of the last change in status. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastStatusChange *string // The Internet-routable IP address of the virtual private gateway's outside // interface. OutsideIpAddress *string - // The status of the VPN tunnel. Valid values are DOWN or UP. + // The status of the VPN tunnel. Valid values are DOWN or UP . Status *string // If an error occurs, a description of the error. @@ -4481,23 +4308,18 @@ type AwsEc2VpnConnectionVgwTelemetryDetails struct { type AwsEcrContainerImageDetails struct { // The architecture of the image. Valid values are as follows: - // - // * arm64 - // - // * i386 - // - // * - // x86_64 + // - arm64 + // - i386 + // - x86_64 Architecture *string // The sha256 digest of the image manifest. ImageDigest *string // The date and time when the image was pushed to the repository. Uses the - // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . ImagePublishedAt *string // The list of tags that are associated with the image. @@ -4523,7 +4345,7 @@ type AwsEcrRepositoryDetails struct { ImageScanningConfiguration *AwsEcrRepositoryImageScanningConfigurationDetails // The tag mutability setting for the repository. Valid values are IMMUTABLE or - // MUTABLE. + // MUTABLE . ImageTagMutability *string // Information about the lifecycle policy for the repository. @@ -4563,10 +4385,10 @@ type AwsEcrRepositoryLifecyclePolicyDetails struct { // Indicates whether to enable CloudWatch Container Insights for the ECS cluster. type AwsEcsClusterClusterSettingsDetails struct { - // The name of the setting. The valid value is containerInsights. + // The name of the setting. The valid value is containerInsights . Name *string - // The value of the setting. Valid values are disabled or enabled. + // The value of the setting. Valid values are disabled or enabled . Value *string noSmithyDocumentSerde @@ -4584,12 +4406,12 @@ type AwsEcsClusterConfigurationDetails struct { // Contains the run command configuration for the cluster. type AwsEcsClusterConfigurationExecuteCommandConfigurationDetails struct { - // The identifier of the KMS key that is used to encrypt the data between the local - // client and the container. + // The identifier of the KMS key that is used to encrypt the data between the + // local client and the container. KmsKeyId *string // The log configuration for the results of the run command actions. Required if - // Logging is NONE. + // Logging is NONE . LogConfiguration *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails // The log setting to use for redirecting logs for run command results. @@ -4641,8 +4463,7 @@ type AwsEcsClusterDefaultCapacityProviderStrategyDetails struct { type AwsEcsClusterDetails struct { // The number of services that are running on the cluster in an ACTIVE state. You - // can view these services with the Amazon ECS ListServices - // (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html) + // can view these services with the Amazon ECS ListServices (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html) // API operation. ActiveServicesCount int32 @@ -4655,8 +4476,8 @@ type AwsEcsClusterDetails struct { // A name that you use to identify your cluster. ClusterName *string - // The setting to use to create the cluster. Specifically used to configure whether - // to enable CloudWatch Container Insights for the cluster. + // The setting to use to create the cluster. Specifically used to configure + // whether to enable CloudWatch Container Insights for the cluster. ClusterSettings []AwsEcsClusterClusterSettingsDetails // The run command configuration for the cluster. @@ -4703,7 +4524,7 @@ type AwsEcsContainerDetails struct { type AwsEcsServiceCapacityProviderStrategyDetails struct { // The minimum number of tasks to run on the capacity provider. Only one strategy - // item can specify a value for Base. The value must be between 0 and 100000. + // item can specify a value for Base . The value must be between 0 and 100000. Base int32 // The short name of the capacity provider. @@ -4718,8 +4539,8 @@ type AwsEcsServiceCapacityProviderStrategyDetails struct { noSmithyDocumentSerde } -// Determines whether a service deployment fails if a service cannot reach a steady -// state. +// Determines whether a service deployment fails if a service cannot reach a +// steady state. type AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails struct { // Whether to enable the deployment circuit breaker logic for the service. @@ -4736,30 +4557,30 @@ type AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails struct // Optional deployment parameters for the service. type AwsEcsServiceDeploymentConfigurationDetails struct { - // Determines whether a service deployment fails if a service cannot reach a steady - // state. + // Determines whether a service deployment fails if a service cannot reach a + // steady state. DeploymentCircuitBreaker *AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails - // For a service that uses the rolling update (ECS) deployment type, the maximum + // For a service that uses the rolling update ( ECS ) deployment type, the maximum // number of tasks in a service that are allowed in the RUNNING or PENDING state // during a deployment, and for tasks that use the EC2 launch type, when any // container instances are in the DRAINING state. Provided as a percentage of the // desired number of tasks. The default value is 200%. For a service that uses the - // blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the + // blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types, and tasks that use the // EC2 launch type, the maximum number of tasks in the service that remain in the // RUNNING state while the container instances are in the DRAINING state. For the // Fargate launch type, the maximum percent value is not used. MaximumPercent int32 - // For a service that uses the rolling update (ECS) deployment type, the minimum + // For a service that uses the rolling update ( ECS ) deployment type, the minimum // number of tasks in a service that must remain in the RUNNING state during a // deployment, and while any container instances are in the DRAINING state if the // service contains tasks using the EC2 launch type. Expressed as a percentage of // the desired number of tasks. The default value is 100%. For a service that uses - // the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the - // EC2 launch type, the minimum number of the tasks in the service that remain in - // the RUNNING state while the container instances are in the DRAINING state. For - // the Fargate launch type, the minimum healthy percent value is not used. + // the blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types and tasks that use + // the EC2 launch type, the minimum number of the tasks in the service that remain + // in the RUNNING state while the container instances are in the DRAINING state. + // For the Fargate launch type, the minimum healthy percent value is not used. MinimumHealthyPercent int32 noSmithyDocumentSerde @@ -4768,13 +4589,14 @@ type AwsEcsServiceDeploymentConfigurationDetails struct { // Information about the deployment controller type that the service uses. type AwsEcsServiceDeploymentControllerDetails struct { - // The rolling update (ECS) deployment type replaces the current running version of - // the container with the latest version. The blue/green (CODE_DEPLOY) deployment - // type uses the blue/green deployment model that is powered by CodeDeploy. This - // deployment model a new deployment of a service can be verified before production - // traffic is sent to it. The external (EXTERNAL) deployment type allows the use of - // any third-party deployment controller for full control over the deployment - // process for an Amazon ECS service. Valid values: ECS | CODE_DEPLOY | EXTERNAL + // The rolling update ( ECS ) deployment type replaces the current running version + // of the container with the latest version. The blue/green ( CODE_DEPLOY ) + // deployment type uses the blue/green deployment model that is powered by + // CodeDeploy. This deployment model a new deployment of a service can be verified + // before production traffic is sent to it. The external ( EXTERNAL ) deployment + // type allows the use of any third-party deployment controller for full control + // over the deployment process for an Amazon ECS service. Valid values: ECS | + // CODE_DEPLOY | EXTERNAL Type *string noSmithyDocumentSerde @@ -4789,8 +4611,8 @@ type AwsEcsServiceDetails struct { // The ARN of the cluster that hosts the service. Cluster *string - // Deployment parameters for the service. Includes the number of tasks that run and - // the order in which to start and stop tasks. + // Deployment parameters for the service. Includes the number of tasks that run + // and the order in which to start and stop tasks. DeploymentConfiguration *AwsEcsServiceDeploymentConfigurationDetails // Contains the deployment controller type that the service uses. @@ -4818,8 +4640,8 @@ type AwsEcsServiceDetails struct { // The name of the service. Name *string - // For tasks that use the awsvpc networking mode, the VPC subnet and security group - // configuration. + // For tasks that use the awsvpc networking mode, the VPC subnet and security + // group configuration. NetworkConfiguration *AwsEcsServiceNetworkConfigurationDetails // The placement constraints for the tasks in the service. @@ -4838,9 +4660,9 @@ type AwsEcsServiceDetails struct { // propagated. Valid values: TASK_DEFINITION | SERVICE PropagateTags *string - // The ARN of the IAM role that is associated with the service. The role allows the - // Amazon ECS container agent to register container instances with an Elastic Load - // Balancing load balancer. + // The ARN of the IAM role that is associated with the service. The role allows + // the Amazon ECS container agent to register container instances with an Elastic + // Load Balancing load balancer. Role *string // The scheduling strategy to use for the service. The REPLICA scheduling strategy @@ -4896,12 +4718,12 @@ type AwsEcsServiceLoadBalancersDetails struct { noSmithyDocumentSerde } -// For tasks that use the awsvpc networking mode, the VPC subnet and security group -// configuration. +// For tasks that use the awsvpc networking mode, the VPC subnet and security +// group configuration. type AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails struct { // Whether the task's elastic network interface receives a public IP address. The - // default value is DISABLED. Valid values: ENABLED | DISABLED + // default value is DISABLED . Valid values: ENABLED | DISABLED AssignPublicIp *string // The IDs of the security groups associated with the task or service. You can @@ -4915,8 +4737,8 @@ type AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails struct { noSmithyDocumentSerde } -// For tasks that use the awsvpc networking mode, the VPC subnet and security group -// configuration. +// For tasks that use the awsvpc networking mode, the VPC subnet and security +// group configuration. type AwsEcsServiceNetworkConfigurationDetails struct { // The VPC subnet and security group configuration. @@ -4929,7 +4751,7 @@ type AwsEcsServiceNetworkConfigurationDetails struct { type AwsEcsServicePlacementConstraintsDetails struct { // A cluster query language expression to apply to the constraint. You cannot - // specify an expression if the constraint type is distinctInstance. + // specify an expression if the constraint type is distinctInstance . Expression *string // The type of constraint. Use distinctInstance to run each task in a particular @@ -4944,19 +4766,19 @@ type AwsEcsServicePlacementConstraintsDetails struct { type AwsEcsServicePlacementStrategiesDetails struct { // The field to apply the placement strategy against. For the spread placement - // strategy, valid values are instanceId (or host, which has the same effect), or + // strategy, valid values are instanceId (or host , which has the same effect), or // any platform or custom attribute that is applied to a container instance, such - // as attribute:ecs.availability-zone. For the binpack placement strategy, valid - // values are cpu and memory. For the random placement strategy, this attribute is - // not used. + // as attribute:ecs.availability-zone . For the binpack placement strategy, valid + // values are cpu and memory . For the random placement strategy, this attribute + // is not used. Field *string // The type of placement strategy. The random placement strategy randomly places // tasks on available candidates. The spread placement strategy spreads placement - // across available candidates evenly based on the value of Field. The binpack + // across available candidates evenly based on the value of Field . The binpack // strategy places tasks on available candidates that have the least available - // amount of the resource that is specified in Field. Valid values: random | spread - // | binpack + // amount of the resource that is specified in Field . Valid values: random | + // spread | binpack Type *string noSmithyDocumentSerde @@ -4967,20 +4789,20 @@ type AwsEcsServiceServiceRegistriesDetails struct { // The container name value to use for the service discovery service. If the task // definition uses the bridge or host network mode, you must specify ContainerName - // and ContainerPort. If the task definition uses the awsvpc network mode and a - // type SRV DNS record, you must specify either ContainerName and ContainerPort, or - // Port , but not both. + // and ContainerPort . If the task definition uses the awsvpc network mode and a + // type SRV DNS record, you must specify either ContainerName and ContainerPort , + // or Port , but not both. ContainerName *string // The port value to use for the service discovery service. If the task definition // uses the bridge or host network mode, you must specify ContainerName and - // ContainerPort. If the task definition uses the awsvpc network mode and a type - // SRV DNS record, you must specify either ContainerName and ContainerPort, or Port - // , but not both. + // ContainerPort . If the task definition uses the awsvpc network mode and a type + // SRV DNS record, you must specify either ContainerName and ContainerPort , or + // Port , but not both. ContainerPort int32 // The port value to use for a service discovery service that specifies an SRV - // record. This field can be used if both the awsvpcawsvpc network mode and SRV + // record. This field can be used if both the awsvpc awsvpc network mode and SRV // records are used. Port int32 @@ -4996,14 +4818,10 @@ type AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails struct { // The dependency condition of the dependent container. Indicates the required // status of the dependent container before the current container can start. Valid // values are as follows: - // - // * COMPLETE - // - // * HEALTHY - // - // * SUCCESS - // - // * START + // - COMPLETE + // - HEALTHY + // - SUCCESS + // - START Condition *string // The name of the dependent container. @@ -5128,8 +4946,8 @@ type AwsEcsTaskDefinitionContainerDefinitionsDetails struct { // container. StartTimeout int32 - // The number of seconds to wait before the container is stopped if it doesn't shut - // down normally on its own. + // The number of seconds to wait before the container is stopped if it doesn't + // shut down normally on its own. StopTimeout int32 // A list of namespaced kernel parameters to set in the container. @@ -5140,19 +4958,12 @@ type AwsEcsTaskDefinitionContainerDefinitionsDetails struct { // The user to use inside the container. The value can use one of the following // formats. - // - // * user - // - // * user : group - // - // * uid - // - // * uid : gid - // - // * user : gid - // - // * uid : - // group + // - user + // - user : group + // - uid + // - uid : gid + // - user : gid + // - uid : group User *string // Data volumes to mount from another container. @@ -5179,7 +4990,7 @@ type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails struct { // A file that contain environment variables to pass to a container. type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails struct { - // The type of environment file. The valid value is s3. + // The type of environment file. The valid value is s3 . Type *string // The ARN of the S3 object that contains the environment variable file. @@ -5207,17 +5018,12 @@ type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails struct // The options to use to configure the log router. The valid option keys are as // follows: - // - // * enable-ecs-log-metadata. The value can be true or false. - // - // * - // config-file-type. The value can be s3 or file. - // - // * config-file-value. The value - // is either an S3 ARN or a file path. + // - enable-ecs-log-metadata . The value can be true or false . + // - config-file-type . The value can be s3 or file . + // - config-file-value . The value is either an S3 ARN or a file path. Options map[string]string - // The log router to use. Valid values are fluentbit or fluentd. + // The log router to use. Valid values are fluentbit or fluentd . Type *string noSmithyDocumentSerde @@ -5267,8 +5073,8 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails // The Linux capabilities for the container that are dropped from the default // configuration provided by Docker. Valid values: "ALL" | "AUDIT_CONTROL" | - // "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | - // "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | + // "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" + // | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | // "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | // "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | // "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | @@ -5320,8 +5126,9 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails struc // The path for the device on the host container instance. HostPath *string - // The explicit permissions to provide to the container for the device. By default, - // the container has permissions for read, write, and mknod for the device. + // The explicit permissions to provide to the container for the device. By + // default, the container has permissions for read, write, and mknod for the + // device. Permissions []string noSmithyDocumentSerde @@ -5333,8 +5140,8 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails struct // The absolute file path where the tmpfs volume is to be mounted. ContainerPath *string - // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | - // "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | + // The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" + // | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | // "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | // "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | // "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | @@ -5353,34 +5160,19 @@ type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails struct { // The log driver to use for the container. Valid values on Fargate are as // follows: - // - // * awsfirelens - // - // * awslogs - // - // * splunk - // - // Valid values on Amazon EC2 are as - // follows: - // - // * awsfirelens - // - // * awslogs - // - // * fluentd - // - // * gelf - // - // * journald - // - // * - // json-file - // - // * logentries - // - // * splunk - // - // * syslog + // - awsfirelens + // - awslogs + // - splunk + // Valid values on Amazon EC2 are as follows: + // - awsfirelens + // - awslogs + // - fluentd + // - gelf + // - journald + // - json-file + // - logentries + // - splunk + // - syslog LogDriver *string // The configuration options to send to the log driver. Requires version 1.19 of @@ -5433,7 +5225,7 @@ type AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails struct { // The port number on the container instance to reserve for the container. HostPort int32 - // The protocol used for the port mapping. The default is tcp. + // The protocol used for the port mapping. The default is tcp . Protocol *string noSmithyDocumentSerde @@ -5452,13 +5244,13 @@ type AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails struct type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails struct { // The type of resource to assign to a container. Valid values are GPU or - // InferenceAccelerator. + // InferenceAccelerator . Type *string - // The value for the specified resource type. For GPU, the value is the number of + // The value for the specified resource type. For GPU , the value is the number of // physical GPUs the Amazon ECS container agent reserves for the container. For - // InferenceAccelerator, the value should match the DeviceName attribute of an - // entry in InferenceAccelerators. + // InferenceAccelerator , the value should match the DeviceName attribute of an + // entry in InferenceAccelerators . Value *string noSmithyDocumentSerde @@ -5497,38 +5289,21 @@ type AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails struct { HardLimit int32 // The type of the ulimit. Valid values are as follows: - // - // * core - // - // * cpu - // - // * data - // - // * - // fsize - // - // * locks - // - // * memlock - // - // * msgqueue - // - // * nice - // - // * nofile - // - // * nproc - // - // * rss - // - // * - // rtprio - // - // * rttime - // - // * sigpending - // - // * stack + // - core + // - cpu + // - data + // - fsize + // - locks + // - memlock + // - msgqueue + // - nice + // - nofile + // - nproc + // - rss + // - rtprio + // - rttime + // - sigpending + // - stack Name *string // The soft limit for the ulimit type. @@ -5558,21 +5333,15 @@ type AwsEcsTaskDefinitionDetails struct { ContainerDefinitions []AwsEcsTaskDefinitionContainerDefinitionsDetails // The number of CPU units used by the task.Valid values are as follows: - // - // * 256 - // (.25 vCPU) - // - // * 512 (.5 vCPU) - // - // * 1024 (1 vCPU) - // - // * 2048 (2 vCPU) - // - // * 4096 (4 vCPU) + // - 256 (.25 vCPU) + // - 512 (.5 vCPU) + // - 1024 (1 vCPU) + // - 2048 (2 vCPU) + // - 4096 (4 vCPU) Cpu *string - // The ARN of the task execution role that grants the container agent permission to - // make API calls on behalf of the container user. + // The ARN of the task execution role that grants the container agent permission + // to make API calls on behalf of the container user. ExecutionRoleArn *string // The name of a family that this task definition is registered to. @@ -5583,37 +5352,29 @@ type AwsEcsTaskDefinitionDetails struct { // The inter-process communication (IPC) resource namespace to use for the // containers in the task. Valid values are as follows: - // - // * host - // - // * none - // - // * task + // - host + // - none + // - task IpcMode *string // The amount (in MiB) of memory used by the task. For tasks that are hosted on // Amazon EC2, you can provide a task-level memory value or a container-level // memory value. For tasks that are hosted on Fargate, you must use one of the - // specified values - // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) + // specified values (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) // in the Amazon Elastic Container Service Developer Guide , which determines your // range of supported values for the Cpu and Memory parameters. Memory *string // The Docker networking mode to use for the containers in the task. Valid values // are as follows: - // - // * awsvpc - // - // * bridge - // - // * host - // - // * none + // - awsvpc + // - bridge + // - host + // - none NetworkMode *string // The process namespace to use for the containers in the task. Valid values are - // host or task. + // host or task . PidMode *string // The placement constraint objects to use for tasks. @@ -5725,7 +5486,7 @@ type AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails struct { // The scope for the Docker volume that determines its lifecycle. Docker volumes // that are scoped to a task are provisioned automatically when the task starts and // destroyed when the task stops. Docker volumes that are shared persist after the - // task stops. Valid values are shared or task. + // task stops. Valid values are shared or task . Scope *string noSmithyDocumentSerde @@ -5824,7 +5585,7 @@ type AwsEcsTaskVolumeDetails struct { // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, // underscores, and hyphens are allowed. This name is referenced in the - // sourceVolume parameter of container definition mountPoints. + // sourceVolume parameter of container definition mountPoints . Name *string noSmithyDocumentSerde @@ -5833,8 +5594,8 @@ type AwsEcsTaskVolumeDetails struct { // Provides details on a container instance bind mount host volume. type AwsEcsTaskVolumeHostDetails struct { - // When the host parameter is used, specify a sourcePath to declare the path on the - // host container instance that's presented to the container. + // When the host parameter is used, specify a sourcePath to declare the path on + // the host container instance that's presented to the container. SourcePath *string noSmithyDocumentSerde @@ -5860,8 +5621,8 @@ type AwsEfsAccessPointDetails struct { // using the access point. PosixUser *AwsEfsAccessPointPosixUserDetails - // The directory on the Amazon EFS file system that the access point exposes as the - // root directory to NFS clients using the access point. + // The directory on the Amazon EFS file system that the access point exposes as + // the root directory to NFS clients using the access point. RootDirectory *AwsEfsAccessPointRootDirectoryDetails noSmithyDocumentSerde @@ -5894,8 +5655,8 @@ type AwsEfsAccessPointRootDirectoryCreationInfoDetails struct { // Specifies the POSIX user ID to apply to the root directory. OwnerUid *string - // Specifies the POSIX permissions to apply to the root directory, in the format of - // an octal number representing the file's mode bits. + // Specifies the POSIX permissions to apply to the root directory, in the format + // of an octal number representing the file's mode bits. Permissions *string noSmithyDocumentSerde @@ -5910,10 +5671,10 @@ type AwsEfsAccessPointRootDirectoryDetails struct { // directory. CreationInfo *AwsEfsAccessPointRootDirectoryCreationInfoDetails - // Specifies the path on the Amazon EFS file system to expose as the root directory - // to NFS clients using the access point to access the EFS file system. A path can - // have up to four subdirectories. If the specified path does not exist, you are - // required to provide CreationInfo. + // Specifies the path on the Amazon EFS file system to expose as the root + // directory to NFS clients using the access point to access the EFS file system. A + // path can have up to four subdirectories. If the specified path does not exist, + // you are required to provide CreationInfo . Path *string noSmithyDocumentSerde @@ -5929,19 +5690,12 @@ type AwsEksClusterDetails struct { CertificateAuthorityData *string // The status of the cluster. Valid values are as follows: - // - // * ACTIVE - // - // * CREATING - // - // * - // DELETING - // - // * FAILED - // - // * PENDING - // - // * UPDATING + // - ACTIVE + // - CREATING + // - DELETING + // - FAILED + // - PENDING + // - UPDATING ClusterStatus *string // The endpoint for the Amazon EKS API server. @@ -5973,17 +5727,11 @@ type AwsEksClusterLoggingClusterLoggingDetails struct { Enabled bool // A list of logging types. Valid values are as follows: - // - // * api - // - // * audit - // - // * - // authenticator - // - // * controllerManager - // - // * scheduler + // - api + // - audit + // - authenticator + // - controllerManager + // - scheduler Types []string noSmithyDocumentSerde @@ -6001,9 +5749,10 @@ type AwsEksClusterLoggingDetails struct { // Information about the VPC configuration used by the cluster control plane. type AwsEksClusterResourcesVpcConfigDetails struct { - // Indicates whether the Amazon EKS public API server endpoint is turned on. If the - // Amazon EKS public API server endpoint is turned off, your cluster's Kubernetes - // API server can only receive requests that originate from within the cluster VPC. + // Indicates whether the Amazon EKS public API server endpoint is turned on. If + // the Amazon EKS public API server endpoint is turned off, your cluster's + // Kubernetes API server can only receive requests that originate from within the + // cluster VPC. EndpointPublicAccess bool // The security groups that are associated with the cross-account elastic network @@ -6060,25 +5809,15 @@ type AwsElasticBeanstalkEnvironmentDetails struct { // The name of the solution stack that is deployed with the environment. SolutionStackName *string - // The current operational status of the environment. Valid values are as - // follows: - // - // * Aborting - // - // * Launching - // - // * LinkingFrom - // - // * LinkingTo - // - // * Ready - // - // * - // Terminated - // - // * Terminating - // - // * Updating + // The current operational status of the environment. Valid values are as follows: + // - Aborting + // - Launching + // - LinkingFrom + // - LinkingTo + // - Ready + // - Terminated + // - Terminating + // - Updating Status *string // The tier of the environment. @@ -6124,10 +5863,10 @@ type AwsElasticBeanstalkEnvironmentOptionSetting struct { // Contains information about the tier of the environment. type AwsElasticBeanstalkEnvironmentTier struct { - // The name of the environment tier. Valid values are WebServer or Worker. + // The name of the environment tier. Valid values are WebServer or Worker . Name *string - // The type of environment tier. Valid values are Standard or SQS/HTTP. + // The type of environment tier. Valid values are Standard or SQS/HTTP . Type *string // The version of the environment tier. @@ -6187,20 +5926,17 @@ type AwsElasticsearchDomainDetails struct { noSmithyDocumentSerde } -// Additional options for the domain endpoint, such as whether to require HTTPS for -// all traffic. +// Additional options for the domain endpoint, such as whether to require HTTPS +// for all traffic. type AwsElasticsearchDomainDomainEndpointOptions struct { // Whether to require that all traffic to the domain arrive over HTTPS. EnforceHTTPS bool - // The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain. - // Valid values: - // - // * Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and - // higher - // - // * Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2 + // The TLS security policy to apply to the HTTPS endpoint of the OpenSearch + // domain. Valid values: + // - Policy-Min-TLS-1-0-2019-07 , which supports TLSv1.0 and higher + // - Policy-Min-TLS-1-2-2019-07 , which only supports TLSv1.2 TLSSecurityPolicy *string noSmithyDocumentSerde @@ -6210,34 +5946,32 @@ type AwsElasticsearchDomainDomainEndpointOptions struct { type AwsElasticsearchDomainElasticsearchClusterConfigDetails struct { // The number of instances to use for the master node. If this attribute is - // specified, then DedicatedMasterEnabled must be true. + // specified, then DedicatedMasterEnabled must be true . DedicatedMasterCount int32 - // Whether to use a dedicated master node for the Elasticsearch domain. A dedicated - // master node performs cluster management tasks, but doesn't hold data or respond - // to data upload requests. + // Whether to use a dedicated master node for the Elasticsearch domain. A + // dedicated master node performs cluster management tasks, but doesn't hold data + // or respond to data upload requests. DedicatedMasterEnabled bool - // The hardware configuration of the computer that hosts the dedicated master node. - // A sample value is m3.medium.elasticsearch. If this attribute is specified, then - // DedicatedMasterEnabled must be true. For a list of valid values, see Supported - // instance types in Amazon OpenSearch Service - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // The hardware configuration of the computer that hosts the dedicated master + // node. A sample value is m3.medium.elasticsearch . If this attribute is + // specified, then DedicatedMasterEnabled must be true . For a list of valid + // values, see Supported instance types in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) // in the Amazon OpenSearch Service Developer Guide. DedicatedMasterType *string // The number of data nodes to use in the Elasticsearch domain. InstanceCount int32 - // The instance type for your data nodes. For example, m3.medium.elasticsearch. For - // a list of valid values, see Supported instance types in Amazon OpenSearch - // Service - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // The instance type for your data nodes. For example, m3.medium.elasticsearch . + // For a list of valid values, see Supported instance types in Amazon OpenSearch + // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) // in the Amazon OpenSearch Service Developer Guide. InstanceType *string // Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is - // true. + // true . ZoneAwarenessConfig *AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails // Whether to enable zone awareness for the Elasticsearch domain. When zone @@ -6265,7 +5999,7 @@ type AwsElasticsearchDomainEncryptionAtRestOptions struct { // Whether encryption at rest is enabled. Enabled bool - // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. + // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a . KmsKeyId *string noSmithyDocumentSerde @@ -6332,17 +6066,11 @@ type AwsElasticsearchDomainServiceSoftwareOptions struct { UpdateAvailable bool // The status of the service software update. Valid values are as follows: - // - // * - // COMPLETED - // - // * ELIGIBLE - // - // * IN_PROGRESS - // - // * NOT_ELIGIBLE - // - // * PENDING_UPDATE + // - COMPLETED + // - ELIGIBLE + // - IN_PROGRESS + // - NOT_ELIGIBLE + // - PENDING_UPDATE UpdateStatus *string noSmithyDocumentSerde @@ -6367,7 +6095,7 @@ type AwsElasticsearchDomainVPCOptions struct { } // Contains information about a stickiness policy that was created using -// CreateAppCookieStickinessPolicy. +// CreateAppCookieStickinessPolicy . type AwsElbAppCookieStickinessPolicy struct { // The name of the application cookie used for stickiness. @@ -6381,7 +6109,7 @@ type AwsElbAppCookieStickinessPolicy struct { } // Contains information about a stickiness policy that was created using -// CreateLBCookieStickinessPolicy. +// CreateLBCookieStickinessPolicy . type AwsElbLbCookieStickinessPolicy struct { // The amount of time, in seconds, after which the cookie is considered stale. If @@ -6445,9 +6173,9 @@ type AwsElbLoadBalancerAttributes struct { // instance. ConnectionDraining *AwsElbLoadBalancerConnectionDraining - // Connection settings for the load balancer. If an idle timeout is configured, the - // load balancer allows connections to remain idle for the specified duration. When - // a connection is idle, no data is sent over the connection. + // Connection settings for the load balancer. If an idle timeout is configured, + // the load balancer allows connections to remain idle for the specified duration. + // When a connection is idle, no data is sent over the connection. ConnectionSettings *AwsElbLoadBalancerConnectionSettings // Cross-zone load balancing settings for the load balancer. If cross-zone load @@ -6520,10 +6248,9 @@ type AwsElbLoadBalancerDetails struct { CanonicalHostedZoneNameID *string // Indicates when the load balancer was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedTime *string // The DNS name of the load balancer. @@ -6548,17 +6275,17 @@ type AwsElbLoadBalancerDetails struct { Policies *AwsElbLoadBalancerPolicies // The type of load balancer. Only provided if the load balancer is in a VPC. If - // Scheme is internet-facing, the load balancer has a public DNS name that resolves - // to a public IP address. If Scheme is internal, the load balancer has a public - // DNS name that resolves to a private IP address. + // Scheme is internet-facing , the load balancer has a public DNS name that + // resolves to a public IP address. If Scheme is internal , the load balancer has a + // public DNS name that resolves to a private IP address. Scheme *string - // The security groups for the load balancer. Only provided if the load balancer is - // in a VPC. + // The security groups for the load balancer. Only provided if the load balancer + // is in a VPC. SecurityGroups []string - // Information about the security group for the load balancer. This is the security - // group that is used for inbound rules. + // Information about the security group for the load balancer. This is the + // security group that is used for inbound rules. SourceSecurityGroup *AwsElbLoadBalancerSourceSecurityGroup // The list of subnet identifiers for the load balancer. @@ -6574,8 +6301,8 @@ type AwsElbLoadBalancerDetails struct { // balancer. type AwsElbLoadBalancerHealthCheck struct { - // The number of consecutive health check successes required before the instance is - // moved to the Healthy state. + // The number of consecutive health check successes required before the instance + // is moved to the Healthy state. HealthyThreshold int32 // The approximate interval, in seconds, between health checks of an individual @@ -6587,7 +6314,7 @@ type AwsElbLoadBalancerHealthCheck struct { // is 1 through 65535. For the HTTP and HTTPS protocols, the target also specifies // the ping path. For the TCP protocol, the target is specified as TCP: . For the // SSL protocol, the target is specified as SSL. . For the HTTP and HTTPS - // protocols, the target is specified as :/ . + // protocols, the target is specified as :/ . Target *string // The amount of time, in seconds, during which no response means a failed health @@ -6650,10 +6377,10 @@ type AwsElbLoadBalancerListenerDescription struct { // Contains information about the policies for a load balancer. type AwsElbLoadBalancerPolicies struct { - // The stickiness policies that are created using CreateAppCookieStickinessPolicy. + // The stickiness policies that are created using CreateAppCookieStickinessPolicy . AppCookieStickinessPolicies []AwsElbAppCookieStickinessPolicy - // The stickiness policies that are created using CreateLBCookieStickinessPolicy. + // The stickiness policies that are created using CreateLBCookieStickinessPolicy . LbCookieStickinessPolicies []AwsElbLbCookieStickinessPolicy // The policies other than the stickiness policies. @@ -6696,10 +6423,9 @@ type AwsElbv2LoadBalancerDetails struct { CanonicalHostedZoneId *string // Indicates when the load balancer was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedTime *string // The public DNS name of the load balancer. @@ -6741,10 +6467,9 @@ type AwsIamAccessKeyDetails struct { AccountId *string // Indicates when the IAM access key was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedAt *string // The ID of the principal associated with an access key. @@ -6763,8 +6488,8 @@ type AwsIamAccessKeyDetails struct { Status AwsIamAccessKeyStatus // The user associated with the IAM access key related to a finding. The UserName - // parameter has been replaced with the PrincipalName parameter because access keys - // can also be assigned to principals that are not IAM users. + // parameter has been replaced with the PrincipalName parameter because access + // keys can also be assigned to principals that are not IAM users. // // Deprecated: This filter is deprecated. Instead, use PrincipalName. UserName *string @@ -6788,10 +6513,9 @@ type AwsIamAccessKeySessionContext struct { type AwsIamAccessKeySessionContextAttributes struct { // Indicates when the session was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreationDate *string // Indicates whether the session used multi-factor authentication (MFA). @@ -6840,11 +6564,10 @@ type AwsIamGroupDetails struct { // A list of the managed policies that are attached to the IAM group. AttachedManagedPolicies []AwsIamAttachedManagedPolicy - // Indicates when the IAM group was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the IAM group was created. Uses the date-time format specified + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // The identifier of the IAM group. @@ -6878,10 +6601,9 @@ type AwsIamInstanceProfile struct { Arn *string // Indicates when the instance profile was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // The identifier of the instance profile. @@ -6909,10 +6631,9 @@ type AwsIamInstanceProfileRole struct { AssumeRolePolicyDocument *string // Indicates when the role was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // The path to the role. @@ -6947,10 +6668,9 @@ type AwsIamPolicyDetails struct { AttachmentCount int32 // When the policy was created. Uses the date-time format specified in RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // The identifier of the default version of the policy. @@ -6979,10 +6699,9 @@ type AwsIamPolicyDetails struct { PolicyVersionList []AwsIamPolicyVersion // When the policy was most recently updated. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . UpdateDate *string noSmithyDocumentSerde @@ -6992,10 +6711,9 @@ type AwsIamPolicyDetails struct { type AwsIamPolicyVersion struct { // Indicates when the version was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // Whether the version is the default version. @@ -7017,17 +6735,16 @@ type AwsIamRoleDetails struct { AttachedManagedPolicies []AwsIamAttachedManagedPolicy // Indicates when the role was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // The list of instance profiles that contain this role. InstanceProfileList []AwsIamInstanceProfile - // The maximum session duration (in seconds) that you want to set for the specified - // role. + // The maximum session duration (in seconds) that you want to set for the + // specified role. MaxSessionDuration int32 // The path to the role. @@ -7065,10 +6782,9 @@ type AwsIamUserDetails struct { AttachedManagedPolicies []AwsIamAttachedManagedPolicy // Indicates when the user was created. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreateDate *string // A list of IAM groups that the user belongs to. @@ -7118,8 +6834,8 @@ type AwsKinesisStreamDetails struct { // The number of shards that the stream uses. ShardCount int32 - // When specified, enables or updates server-side encryption using an KMS key for a - // specified stream. Removing this property from your stack template and updating + // When specified, enables or updates server-side encryption using an KMS key for + // a specified stream. Removing this property from your stack template and updating // your stack disables encryption. StreamEncryption *AwsKinesisStreamStreamEncryptionDetails @@ -7142,15 +6858,14 @@ type AwsKinesisStreamStreamEncryptionDetails struct { // Contains metadata about an KMS key. type AwsKmsKeyDetails struct { - // The twelve-digit account ID of the Amazon Web Services account that owns the KMS - // key. + // The twelve-digit account ID of the Amazon Web Services account that owns the + // KMS key. AWSAccountId *string // Indicates when the KMS key was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreationDate float64 // A description of the KMS key. @@ -7167,35 +6882,29 @@ type AwsKmsKeyDetails struct { KeyRotationStatus bool // The state of the KMS key. Valid values are as follows: - // - // * Disabled - // - // * Enabled - // - // * - // PendingDeletion - // - // * PendingImport - // - // * Unavailable + // - Disabled + // - Enabled + // - PendingDeletion + // - PendingImport + // - Unavailable KeyState *string - // The source of the KMS key material. When this value is AWS_KMS, KMS created the - // key material. When this value is EXTERNAL, the key material was imported from + // The source of the KMS key material. When this value is AWS_KMS , KMS created the + // key material. When this value is EXTERNAL , the key material was imported from // your existing key management infrastructure or the KMS key lacks key material. - // When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM + // When this value is AWS_CLOUDHSM , the key material was created in the CloudHSM // cluster associated with a custom key store. Origin *string noSmithyDocumentSerde } -// The code for the Lambda function. You can specify either an object in Amazon S3, -// or upload a deployment package directly. +// The code for the Lambda function. You can specify either an object in Amazon +// S3, or upload a deployment package directly. type AwsLambdaFunctionCode struct { - // An Amazon S3 bucket in the same Amazon Web Services Region as your function. The - // bucket can be in a different Amazon Web Services account. + // An Amazon S3 bucket in the same Amazon Web Services Region as your function. + // The bucket can be in a different Amazon Web Services account. S3Bucket *string // The Amazon S3 key of the deployment package. @@ -7224,7 +6933,7 @@ type AwsLambdaFunctionDeadLetterConfig struct { type AwsLambdaFunctionDetails struct { // The instruction set architecture that the function uses. Valid values are x86_64 - // or arm64. + // or arm64 . Architectures []string // An AwsLambdaFunctionCode object. @@ -7251,10 +6960,9 @@ type AwsLambdaFunctionDetails struct { KmsKeyArn *string // Indicates when the function was last updated. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastModified *string // The function's layers. @@ -7363,10 +7071,9 @@ type AwsLambdaLayerVersionDetails struct { CompatibleRuntimes []string // Indicates when the version was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedDate *string // The version number. @@ -7382,7 +7089,7 @@ type AwsMountPoint struct { ContainerPath *string // The name of the volume to mount. Must be a volume name referenced in the name - // parameter of task definition volume. + // parameter of task definition volume . SourceVolume *string noSmithyDocumentSerde @@ -7391,7 +7098,7 @@ type AwsMountPoint struct { // Details about an Network Firewall firewall. type AwsNetworkFirewallFirewallDetails struct { - // Whether the firewall is protected from deletion. If set to true, then the + // Whether the firewall is protected from deletion. If set to true , then the // firewall cannot be deleted. DeleteProtection bool @@ -7411,15 +7118,15 @@ type AwsNetworkFirewallFirewallDetails struct { FirewallPolicyArn *string // Whether the firewall is protected from a change to the firewall policy. If set - // to true, you cannot associate a different policy with the firewall. + // to true , you cannot associate a different policy with the firewall. FirewallPolicyChangeProtection bool // Whether the firewall is protected from a change to the subnet associations. If - // set to true, you cannot map different subnets to the firewall. + // set to true , you cannot map different subnets to the firewall. SubnetChangeProtection bool - // The public subnets that Network Firewall uses for the firewall. Each subnet must - // belong to a different Availability Zone. + // The public subnets that Network Firewall uses for the firewall. Each subnet + // must belong to a different Availability Zone. SubnetMappings []AwsNetworkFirewallFirewallSubnetMappingsDetails // The identifier of the VPC where the firewall is used. @@ -7508,7 +7215,7 @@ type AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails struct { type AwsOpenSearchServiceDomainClusterConfigDetails struct { // The number of instances to use for the master node. If this attribute is - // specified, then DedicatedMasterEnabled must be true. + // specified, then DedicatedMasterEnabled must be true . DedicatedMasterCount int32 // Whether to use a dedicated master node for the OpenSearch domain. A dedicated @@ -7516,16 +7223,15 @@ type AwsOpenSearchServiceDomainClusterConfigDetails struct { // to data upload requests. DedicatedMasterEnabled bool - // The hardware configuration of the computer that hosts the dedicated master node. - // If this attribute is specified, then DedicatedMasterEnabled must be true. + // The hardware configuration of the computer that hosts the dedicated master + // node. If this attribute is specified, then DedicatedMasterEnabled must be true . DedicatedMasterType *string // The number of data nodes to use in the OpenSearch domain. InstanceCount int32 - // The instance type for your data nodes. For a list of valid values, see Supported - // instance types in Amazon OpenSearch Service - // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // The instance type for your data nodes. For a list of valid values, see + // Supported instance types in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) // in the Amazon OpenSearch Service Developer Guide. InstanceType *string @@ -7539,7 +7245,7 @@ type AwsOpenSearchServiceDomainClusterConfigDetails struct { WarmType *string // Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is - // true. + // true . ZoneAwarenessConfig *AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails // Whether to enable zone awareness for the OpenSearch domain. When zone awareness @@ -7554,8 +7260,8 @@ type AwsOpenSearchServiceDomainClusterConfigDetails struct { // Configuration options for zone awareness. type AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails struct { - // The number of Availability Zones that the domain uses. Valid values are 2 or 3. - // The default is 2. + // The number of Availability Zones that the domain uses. Valid values are 2 or 3 . + // The default is 2 . AvailabilityZoneCount int32 noSmithyDocumentSerde @@ -7584,7 +7290,7 @@ type AwsOpenSearchServiceDomainDetails struct { DomainEndpointOptions *AwsOpenSearchServiceDomainDomainEndpointOptionsDetails // The domain endpoints. Used if the OpenSearch domain resides in a VPC. This is a - // map of key-value pairs. The key is always vpc. The value is the endpoint. + // map of key-value pairs. The key is always vpc . The value is the endpoint. DomainEndpoints map[string]string // The name of the endpoint. @@ -7727,24 +7433,18 @@ type AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails struct { UpdateAvailable bool // The status of the service software update. Valid values are as follows: - // - // * - // COMPLETED - // - // * ELIGIBLE - // - // * IN_PROGRESS - // - // * NOT_ELIGIBLE - // - // * PENDING_UPDATE + // - COMPLETED + // - ELIGIBLE + // - IN_PROGRESS + // - NOT_ELIGIBLE + // - PENDING_UPDATE UpdateStatus *string noSmithyDocumentSerde } -// Contains information that OpenSearch Service derives based on the VPCOptions for -// the domain. +// Contains information that OpenSearch Service derives based on the VPCOptions +// for the domain. type AwsOpenSearchServiceDomainVpcOptionsDetails struct { // The list of security group IDs that are associated with the VPC endpoints for @@ -7765,12 +7465,9 @@ type AwsRdsDbClusterAssociatedRole struct { // The status of the association between the IAM role and the DB cluster. Valid // values are as follows: - // - // * ACTIVE - // - // * INVALID - // - // * PENDING + // - ACTIVE + // - INVALID + // - PENDING Status *string noSmithyDocumentSerde @@ -7780,15 +7477,10 @@ type AwsRdsDbClusterAssociatedRole struct { type AwsRdsDbClusterDetails struct { // The status of the database activity stream. Valid values are as follows: - // - // * - // started - // - // * starting - // - // * stopped - // - // * stopping + // - started + // - starting + // - stopped + // - stopping ActivityStreamStatus *string // For all database engines except Aurora, specifies the allocated storage size in @@ -7807,9 +7499,9 @@ type AwsRdsDbClusterDetails struct { // Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time - // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot - // contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Format (https://tools.ietf.org/html/rfc3339#section-5.6) . The value cannot + // contain spaces, and date and time should be separated by T . For example, + // 2020-03-22T13:22:13.933Z . ClusterCreateTime *string // Whether tags are copied from the DB cluster to snapshots of the DB cluster. @@ -7825,8 +7517,8 @@ type AwsRdsDbClusterDetails struct { // The name of the database. DatabaseName *string - // The DB cluster identifier that the user assigned to the cluster. This identifier - // is the unique key that identifies a DB cluster. + // The DB cluster identifier that the user assigned to the cluster. This + // identifier is the unique key that identifies a DB cluster. DbClusterIdentifier *string // The list of instances that make up the DB cluster. @@ -7862,26 +7554,17 @@ type AwsRdsDbClusterDetails struct { // The name of the database engine to use for this DB cluster. Valid values are as // follows: - // - // * aurora - // - // * aurora-mysql - // - // * aurora-postgresql + // - aurora + // - aurora-mysql + // - aurora-postgresql Engine *string // The database engine mode of the DB cluster.Valid values are as follows: - // - // * - // global - // - // * multimaster - // - // * parallelquery - // - // * provisioned - // - // * serverless + // - global + // - multimaster + // - parallelquery + // - provisioned + // - serverless EngineMode *string // The version number of the database engine to use. @@ -7911,12 +7594,12 @@ type AwsRdsDbClusterDetails struct { Port int32 // The range of time each day when automated backups are created, if automated - // backups are enabled. Uses the format HH:MM-HH:MM. For example, 04:52-05:22. + // backups are enabled. Uses the format HH:MM-HH:MM . For example, 04:52-05:22 . PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Uses the format :HH:MM-:HH:MM. For the day values, use - // mon|tue|wed|thu|fri|sat|sun. For example, sun:09:32-sun:10:02. + // Coordinated Time (UTC). Uses the format :HH:MM-:HH:MM . For the day values, use + // mon | tue | wed | thu | fri | sat | sun . For example, sun:09:32-sun:10:02 . PreferredMaintenanceWindow *string // The identifiers of the read replicas that are associated with this DB cluster. @@ -7979,9 +7662,9 @@ type AwsRdsDbClusterSnapshotDetails struct { // Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time - // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot - // contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Format (https://tools.ietf.org/html/rfc3339#section-5.6) . The value cannot + // contain spaces, and date and time should be separated by T . For example, + // 2020-03-22T13:22:13.933Z . ClusterCreateTime *string // The DB cluster identifier. @@ -8016,10 +7699,9 @@ type AwsRdsDbClusterSnapshotDetails struct { Port int32 // Indicates when the snapshot was taken. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . SnapshotCreateTime *string // The type of DB cluster snapshot. @@ -8065,19 +7747,14 @@ type AwsRdsDbInstanceAssociatedRole struct { // The ARN of the IAM role that is associated with the DB instance. RoleArn *string - // Describes the state of the association between the IAM role and the DB instance. - // The Status property returns one of the following values: - // - // * ACTIVE - The IAM - // role ARN is associated with the DB instance and can be used to access other - // Amazon Web Services services on your behalf. - // - // * PENDING - The IAM role ARN is - // being associated with the DB instance. - // - // * INVALID - The IAM role ARN is - // associated with the DB instance. But the DB instance is unable to assume the IAM - // role in order to access other Amazon Web Services services on your behalf. + // Describes the state of the association between the IAM role and the DB + // instance. The Status property returns one of the following values: + // - ACTIVE - The IAM role ARN is associated with the DB instance and can be used + // to access other Amazon Web Services services on your behalf. + // - PENDING - The IAM role ARN is being associated with the DB instance. + // - INVALID - The IAM role ARN is associated with the DB instance. But the DB + // instance is unable to assume the IAM role in order to access other Amazon Web + // Services services on your behalf. Status *string noSmithyDocumentSerde @@ -8145,13 +7822,13 @@ type AwsRdsDbInstanceDetails struct { // Information about the subnet group that is associated with the DB instance. DbSubnetGroup *AwsRdsDbSubnetGroup - // The Amazon Web Services Region-unique, immutable identifier for the DB instance. - // This identifier is found in CloudTrail log entries whenever the KMS key for the - // DB instance is accessed. + // The Amazon Web Services Region-unique, immutable identifier for the DB + // instance. This identifier is found in CloudTrail log entries whenever the KMS + // key for the DB instance is accessed. DbiResourceId *string - // Indicates whether the DB instance has deletion protection enabled. When deletion - // protection is enabled, the database cannot be deleted. + // Indicates whether the DB instance has deletion protection enabled. When + // deletion protection is enabled, the database cannot be deleted. DeletionProtection bool // The Active Directory domain membership records associated with the DB instance. @@ -8177,20 +7854,15 @@ type AwsRdsDbInstanceDetails struct { // True if mapping of IAM accounts to database accounts is enabled, and otherwise // false. IAM database authentication can be enabled for the following database // engines. - // - // * For MySQL 5.6, minor version 5.6.34 or higher - // - // * For MySQL 5.7, - // minor version 5.7.16 or higher - // - // * Aurora 5.6 or higher + // - For MySQL 5.6, minor version 5.6.34 or higher + // - For MySQL 5.7, minor version 5.7.16 or higher + // - Aurora 5.6 or higher IAMDatabaseAuthenticationEnabled bool // Indicates when the DB instance was created. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . InstanceCreateTime *string // Specifies the provisioned IOPS (I/O operations per second) for this DB instance. @@ -8200,11 +7872,11 @@ type AwsRdsDbInstanceDetails struct { // instance. KmsKeyId *string - // Specifies the latest time to which a database can be restored with point-in-time - // restore. Uses the date-time format specified in RFC 3339 section 5.6, Internet - // Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value - // cannot contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Specifies the latest time to which a database can be restored with + // point-in-time restore. Uses the date-time format specified in RFC 3339 section + // 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LatestRestorableTime *string // License model information for this DB instance. @@ -8247,12 +7919,12 @@ type AwsRdsDbInstanceDetails struct { PerformanceInsightsRetentionPeriod int32 // The range of time each day when automated backups are created, if automated - // backups are enabled. Uses the format HH:MM-HH:MM. For example, 04:52-05:22. + // backups are enabled. Uses the format HH:MM-HH:MM . For example, 04:52-05:22 . PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Uses the format :HH:MM-:HH:MM. For the day values, use - // mon|tue|wed|thu|fri|sat|sun. For example, sun:09:32-sun:10:02. + // Coordinated Time (UTC). Uses the format :HH:MM-:HH:MM . For the day values, use + // mon | tue | wed | thu | fri | sat | sun . For example, sun:09:32-sun:10:02 . PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance @@ -8413,7 +8085,7 @@ type AwsRdsDbPendingModifiedValues struct { // A processor feature. type AwsRdsDbProcessorFeature struct { - // The name of the processor feature. Valid values are coreCount or threadsPerCore. + // The name of the processor feature. Valid values are coreCount or threadsPerCore . Name *string // The value of the processor feature. @@ -8487,8 +8159,8 @@ type AwsRdsDbSnapshotDetails struct { // instance. AllocatedStorage int32 - // Specifies the name of the Availability Zone in which the DB instance was located - // at the time of the DB snapshot. + // Specifies the name of the Availability Zone in which the DB instance was + // located at the time of the DB snapshot. AvailabilityZone *string // A name for the DB instance. @@ -8503,38 +8175,22 @@ type AwsRdsDbSnapshotDetails struct { // Whether the DB snapshot is encrypted. Encrypted bool - // The name of the database engine to use for this DB instance. Valid values are as - // follows: - // - // * aurora - // - // * aurora-mysql - // - // * aurora-postgresql - // - // * c - // - // * mariadb - // - // * - // mysql - // - // * oracle-ee - // - // * oracle-se - // - // * oracle-se1 - // - // * oracle-se2 - // - // * sqlserver-ee - // - // * - // sqlserver-ex - // - // * sqlserver-se - // - // * sqlserver-web + // The name of the database engine to use for this DB instance. Valid values are + // as follows: + // - aurora + // - aurora-mysql + // - aurora-postgresql + // - c + // - mariadb + // - mysql + // - oracle-ee + // - oracle-se + // - oracle-se1 + // - oracle-se2 + // - sqlserver-ee + // - sqlserver-ex + // - sqlserver-se + // - sqlserver-web Engine *string // The version of the database engine. @@ -8547,11 +8203,11 @@ type AwsRdsDbSnapshotDetails struct { // from which the snapshot was taken, was created. InstanceCreateTime *string - // The provisioned IOPS (I/O operations per second) value of the DB instance at the - // time of the snapshot. + // The provisioned IOPS (I/O operations per second) value of the DB instance at + // the time of the snapshot. Iops int32 - // If Encrypted is true, the KMS key identifier for the encrypted DB snapshot. + // If Encrypted is true , the KMS key identifier for the encrypted DB snapshot. KmsKeyId *string // License model information for the restored DB instance. @@ -8589,14 +8245,10 @@ type AwsRdsDbSnapshotDetails struct { // The status of this DB snapshot. Status *string - // The storage type associated with the DB snapshot. Valid values are as - // follows: - // - // * gp2 - // - // * io1 - // - // * standard + // The storage type associated with the DB snapshot. Valid values are as follows: + // - gp2 + // - io1 + // - standard StorageType *string // The ARN from the key store with which to associate the instance for TDE @@ -8712,10 +8364,9 @@ type AwsRdsEventSubscriptionDetails struct { Status *string // The datetime when the event notification subscription was created. Uses the - // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . SubscriptionCreationTime *string noSmithyDocumentSerde @@ -8770,10 +8421,10 @@ type AwsRedshiftClusterClusterParameterStatus struct { // The error that prevented the parameter from being applied to the database. ParameterApplyErrorDescription *string - // The status of the parameter. Indicates whether the parameter is in sync with the - // database, waiting for a cluster reboot, or encountered an error when it was - // applied. Valid values: in-sync | pending-reboot | applying | invalid-parameter | - // apply-deferred | apply-error | unknown-error + // The status of the parameter. Indicates whether the parameter is in sync with + // the database, waiting for a cluster reboot, or encountered an error when it was + // applied. Valid values: in-sync | pending-reboot | applying | invalid-parameter + // | apply-deferred | apply-error | unknown-error ParameterApplyStatus *string // The name of the parameter. @@ -8804,13 +8455,13 @@ type AwsRedshiftClusterClusterSnapshotCopyStatus struct { DestinationRegion *string // The number of days that manual snapshots are retained in the destination Region - // after they are copied from a source Region. If the value is -1, then the manual - // snapshot is retained indefinitely. Valid values: Either -1 or an integer between - // 1 and 3,653 + // after they are copied from a source Region. If the value is -1 , then the manual + // snapshot is retained indefinitely. Valid values: Either -1 or an integer + // between 1 and 3,653 ManualSnapshotRetentionPeriod int32 - // The number of days to retain automated snapshots in the destination Region after - // they are copied from a source Region. + // The number of days to retain automated snapshots in the destination Region + // after they are copied from a source Region. RetentionPeriod int32 // The name of the snapshot copy grant. @@ -8824,20 +8475,18 @@ type AwsRedshiftClusterClusterSnapshotCopyStatus struct { type AwsRedshiftClusterDeferredMaintenanceWindow struct { // The end of the time window for which maintenance was deferred. Uses the - // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . DeferMaintenanceEndTime *string // The identifier of the maintenance window. DeferMaintenanceIdentifier *string // The start of the time window for which maintenance was deferred. Uses the - // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . DeferMaintenanceStartTime *string noSmithyDocumentSerde @@ -8858,27 +8507,19 @@ type AwsRedshiftClusterDetails struct { // 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. + // - 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 // Indicates when the cluster was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . ClusterCreateTime *string // The unique identifier of the cluster. @@ -8911,8 +8552,8 @@ type AwsRedshiftClusterDetails struct { // storage-full | updating-hsm ClusterStatus *string - // The name of the subnet group that is associated with the cluster. This parameter - // is valid only when the cluster is in a VPC. + // The name of the subnet group that is associated with the cluster. This + // parameter is valid only when the cluster is in a VPC. ClusterSubnetGroupName *string // The version ID of the Amazon Redshift engine that runs on the cluster. @@ -8944,10 +8585,9 @@ type AwsRedshiftClusterDetails struct { // Indicates when the next snapshot is expected to be taken. The cluster must have // a valid snapshot schedule and have backups enabled. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . ExpectedNextSnapshotScheduleTime *string // The status of the next expected snapshot. Valid values: OnTrack | Pending @@ -8958,8 +8598,8 @@ type AwsRedshiftClusterDetails struct { // modify cluster command. HsmStatus *AwsRedshiftClusterHsmStatus - // A list of IAM roles that the cluster can use to access other Amazon Web Services - // services. + // A list of IAM roles that the cluster can use to access other Amazon Web + // Services services. IamRoles []AwsRedshiftClusterIamRole // The identifier of the KMS encryption key that is used to encrypt data in the @@ -8972,21 +8612,20 @@ type AwsRedshiftClusterDetails struct { // The name of the maintenance track for the cluster. MaintenanceTrackName *string - // The default number of days to retain a manual snapshot. If the value is -1, the + // The default number of days to retain a manual snapshot. If the value is -1 , the // snapshot is retained indefinitely. This setting doesn't change the retention // period of existing snapshots. Valid values: Either -1 or an integer between 1 // and 3,653 ManualSnapshotRetentionPeriod int32 // The master user name for the cluster. This name is used to connect to the - // database that is specified in as the value of DBName. + // database that is specified in as the value of DBName . MasterUsername *string // Indicates the start of the next maintenance window. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . NextMaintenanceWindowStartTime *string // The node type for the nodes in the cluster. @@ -9002,7 +8641,7 @@ type AwsRedshiftClusterDetails struct { PendingModifiedValues *AwsRedshiftClusterPendingModifiedValues // The weekly time range, in Universal Coordinated Time (UTC), during which system - // maintenance can occur. Format: :HH:MM-:HH:MM For the day values, use mon | tue + // maintenance can occur. Format: :HH:MM-:HH:MM For the day values, use mon | tue // | wed | thu | fri | sat | sun For example, sun:09:32-sun:10:02 PreferredMaintenanceWindow *string @@ -9102,17 +8741,15 @@ type AwsRedshiftClusterLoggingStatus struct { LastFailureMessage *string // The last time when logs failed to be delivered. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastFailureTime *string // The last time that logs were delivered successfully. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastSuccessfulDeliveryTime *string // Indicates whether logging is enabled. @@ -9177,8 +8814,8 @@ type AwsRedshiftClusterResizeInfo struct { noSmithyDocumentSerde } -// Information about the status of a cluster restore action. It only applies if the -// cluster was created by restoring a snapshot. +// Information about the status of a cluster restore action. It only applies if +// the cluster was created by restoring a snapshot. type AwsRedshiftClusterRestoreStatus struct { // The number of megabytes per second being transferred from the backup storage. @@ -9191,9 +8828,9 @@ type AwsRedshiftClusterRestoreStatus struct { // restore to DC2 and DS2 node types. ElapsedTimeInSeconds int64 - // The estimate of the time remaining before the restore is complete. Returns 0 for - // a completed restore. This field is only updated when you restore to DC2 and DS2 - // node types. + // The estimate of the time remaining before the restore is complete. Returns 0 + // for a completed restore. This field is only updated when you restore to DC2 and + // DS2 node types. EstimatedTimeToCompletionInSeconds int64 // The number of megabytes that were transferred from snapshot storage. This field @@ -9273,19 +8910,18 @@ type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct { AbortIncompleteMultipartUpload *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails // The date when objects are moved or deleted. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . ExpirationDate *string // The length in days of the lifetime for objects that are subject to the rule. ExpirationInDays int32 // Whether Amazon S3 removes a delete marker that has no noncurrent versions. If - // set to true, the delete marker is expired. If set to false, the policy takes no - // action. If you provide ExpiredObjectDeleteMarker, you cannot provide - // ExpirationInDays or ExpirationDate. + // set to true , the delete marker is expired. If set to false , the policy takes + // no action. If you provide ExpiredObjectDeleteMarker , you cannot provide + // ExpirationInDays or ExpirationDate . ExpiredObjectDeleteMarker bool // Identifies the objects that a rule applies to. @@ -9294,12 +8930,12 @@ type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct { // The unique identifier of the rule. ID *string - // The number of days that an object is noncurrent before Amazon S3 can perform the - // associated action. + // The number of days that an object is noncurrent before Amazon S3 can perform + // the associated action. NoncurrentVersionExpirationInDays int32 - // Transition rules that describe when noncurrent objects transition to a specified - // storage class. + // Transition rules that describe when noncurrent objects transition to a + // specified storage class. NoncurrentVersionTransitions []AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails // A prefix that identifies one or more objects that the rule applies to. @@ -9338,7 +8974,7 @@ type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails struct { Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails // Whether to use AND or OR to join the operands. Valid values are - // LifecycleAndOperator or LifecycleOrOperator. + // LifecycleAndOperator or LifecycleOrOperator . Type *string noSmithyDocumentSerde @@ -9354,7 +8990,7 @@ type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails // The type of filter value. Valid values are LifecyclePrefixPredicate or - // LifecycleTagPredicate. + // LifecycleTagPredicate . Type *string noSmithyDocumentSerde @@ -9388,8 +9024,8 @@ type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails struc // specified storage class. type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails struct { - // The number of days that an object is noncurrent before Amazon S3 can perform the - // associated action. + // The number of days that an object is noncurrent before Amazon S3 can perform + // the associated action. Days int32 // The class of storage to change the object to after the object is noncurrent for @@ -9403,29 +9039,22 @@ type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDet type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct { // A date on which to transition objects to the specified storage class. If you - // provide Date, you cannot provide Days. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // provide Date , you cannot provide Days . Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . Date *string - // The number of days after which to transition the object to the specified storage - // class. If you provide Days, you cannot provide Date. + // The number of days after which to transition the object to the specified + // storage class. If you provide Days , you cannot provide Date . Days int32 // The storage class to transition the object to. Valid values are as follows: - // - // * - // DEEP_ARCHIVE - // - // * GLACIER - // - // * INTELLIGENT_TIERING - // - // * ONEZONE_IA - // - // * STANDARD_IA + // - DEEP_ARCHIVE + // - GLACIER + // - INTELLIGENT_TIERING + // - ONEZONE_IA + // - STANDARD_IA StorageClass *string noSmithyDocumentSerde @@ -9439,7 +9068,7 @@ type AwsS3BucketBucketVersioningConfiguration struct { // attribute is not included. IsMfaDeleteEnabled bool - // The versioning status of the S3 bucket. Valid values are Enabled or Suspended. + // The versioning status of the S3 bucket. Valid values are Enabled or Suspended . Status *string noSmithyDocumentSerde @@ -9466,11 +9095,10 @@ type AwsS3BucketDetails struct { // The website configuration parameters for the S3 bucket. BucketWebsiteConfiguration *AwsS3BucketWebsiteConfiguration - // Indicates when the S3 bucket was created. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the S3 bucket was created. Uses the date-time format specified + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . CreatedAt *string // Specifies which rule Amazon S3 applies by default to every new object placed in @@ -9534,20 +9162,16 @@ type AwsS3BucketNotificationConfigurationDetail struct { // Indicates the type of notification. Notifications can be generated using Lambda // functions, Amazon SQS queues, or Amazon SNS topics, with corresponding valid // values as follows: - // - // * LambdaConfiguration - // - // * QueueConfiguration - // - // * - // TopicConfiguration + // - LambdaConfiguration + // - QueueConfiguration + // - TopicConfiguration Type *string noSmithyDocumentSerde } -// Filtering information for the notifications. The filtering is based on Amazon S3 -// key names. +// Filtering information for the notifications. The filtering is based on Amazon +// S3 key names. type AwsS3BucketNotificationConfigurationFilter struct { // Details for an Amazon S3 filter. @@ -9578,8 +9202,8 @@ type AwsS3BucketNotificationConfigurationS3KeyFilterRule struct { noSmithyDocumentSerde } -// The container element for S3 Object Lock configuration parameters. In Amazon S3, -// Object Lock can help prevent objects from being deleted or overwritten for a +// The container element for S3 Object Lock configuration parameters. In Amazon +// S3, Object Lock can help prevent objects from being deleted or overwritten for a // fixed amount of time or indefinitely. type AwsS3BucketObjectLockConfiguration struct { @@ -9609,9 +9233,9 @@ type AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails struct { noSmithyDocumentSerde } -// Specifies the S3 Object Lock rule for the specified object. In Amazon S3, Object -// Lock can help prevent objects from being deleted or overwritten for a fixed -// amount of time or indefinitely. +// Specifies the S3 Object Lock rule for the specified object. In Amazon S3, +// Object Lock can help prevent objects from being deleted or overwritten for a +// fixed amount of time or indefinitely. type AwsS3BucketObjectLockConfigurationRuleDetails struct { // The default Object Lock retention mode and period that you want to apply to new @@ -9628,8 +9252,8 @@ type AwsS3BucketServerSideEncryptionByDefault struct { // KMS key ID to use for the default encryption. KMSMasterKeyID *string - // Server-side encryption algorithm to use for the default encryption. Valid values - // are aws: kms or AES256. + // Server-side encryption algorithm to use for the default encryption. Valid + // values are aws: kms or AES256 . SSEAlgorithm *string noSmithyDocumentSerde @@ -9648,8 +9272,8 @@ type AwsS3BucketServerSideEncryptionConfiguration struct { type AwsS3BucketServerSideEncryptionRule struct { // Specifies the default server-side encryption to apply to new objects in the - // bucket. If a PUT object request doesn't specify any server-side encryption, this - // default encryption is applied. + // bucket. If a PUT object request doesn't specify any server-side encryption, + // this default encryption is applied. ApplyServerSideEncryptionByDefault *AwsS3BucketServerSideEncryptionByDefault noSmithyDocumentSerde @@ -9680,7 +9304,7 @@ type AwsS3BucketWebsiteConfigurationRedirectTo struct { Hostname *string // The protocol to use when redirecting requests. By default, this field uses the - // same protocol as the original request. Valid values are http or https. + // same protocol as the original request. Valid values are http or https . Protocol *string noSmithyDocumentSerde @@ -9744,11 +9368,10 @@ type AwsS3ObjectDetails struct { // resource found at a URL. ETag *string - // Indicates when the object was last modified. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the object was last modified. Uses the date-time format + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastModified *string // The identifier of the KMS symmetric customer managed key that was used for the @@ -9768,41 +9391,37 @@ type AwsS3ObjectDetails struct { // Provides details about an Amazon SageMaker notebook instance. type AwsSageMakerNotebookInstanceDetails struct { - // A list of Amazon Elastic Inference instance types to associate with the notebook - // instance. Currently, only one instance type can be associated with a notebook - // instance. + // A list of Amazon Elastic Inference instance types to associate with the + // notebook instance. Currently, only one instance type can be associated with a + // notebook instance. AcceleratorTypes []string // An array of up to three Git repositories associated with the notebook instance. // These can be either the names of Git repositories stored as resources in your - // account, or the URL of Git repositories in CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. These repositories are cloned at the same level as the - // default repository of your notebook instance. For more information, see - // Associating Git repositories with SageMaker notebook instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) in the - // Amazon SageMaker Developer Guide. + // account, or the URL of Git repositories in CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. These repositories are cloned at the same level + // as the default repository of your notebook instance. For more information, see + // Associating Git repositories with SageMaker notebook instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // in the Amazon SageMaker Developer Guide. AdditionalCodeRepositories []string // The Git repository associated with the notebook instance as its default code // repository. This can be either the name of a Git repository stored as a resource - // in your account, or the URL of a Git repository in CodeCommit - // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any - // other Git repository. When you open a notebook instance, it opens in the - // directory that contains this repository. For more information, see Associating - // Git repositories with SageMaker notebook instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) in the - // Amazon SageMaker Developer Guide. + // in your account, or the URL of a Git repository in CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) + // or in any other Git repository. When you open a notebook instance, it opens in + // the directory that contains this repository. For more information, see + // Associating Git repositories with SageMaker notebook instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) + // in the Amazon SageMaker Developer Guide. DefaultCodeRepository *string - // Sets whether SageMaker provides internet access to the notebook instance. If you - // set this to Disabled, this notebook instance is able to access resources only in - // your VPC, and is not be able to connect to SageMaker training and endpoint - // services unless you configure a Network Address Translation (NAT) Gateway in - // your VPC. + // Sets whether SageMaker provides internet access to the notebook instance. If + // you set this to Disabled , this notebook instance is able to access resources + // only in your VPC, and is not be able to connect to SageMaker training and + // endpoint services unless you configure a Network Address Translation (NAT) + // Gateway in your VPC. DirectInternetAccess *string - // If status of the instance is Failed, the reason it failed. + // If status of the instance is Failed , the reason it failed. FailureReason *string // Information on the IMDS configuration of the notebook instance. @@ -9814,10 +9433,9 @@ type AwsSageMakerNotebookInstanceDetails struct { // The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that // SageMaker uses to encrypt data on the storage volume attached to your notebook - // instance. The KMS key you provide must be enabled. For information, see Enabling - // and disabling keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in - // the Key Management Service Developer Guide. + // instance. The KMS key you provide must be enabled. For information, see + // Enabling and disabling keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) + // in the Key Management Service Developer Guide. KmsKeyId *string // The network interface ID that SageMaker created when the instance was created. @@ -9925,10 +9543,9 @@ type AwsSecurityFinding struct { // Indicates when the security-findings provider created the potential security // issue that a finding captured. Uses the date-time format specified in RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . // // This member is required. CreatedAt *string @@ -9957,8 +9574,8 @@ type AwsSecurityFinding struct { // This member is required. ProductArn *string - // A set of resource data types that describe the resources that the finding refers - // to. + // A set of resource data types that describe the resources that the finding + // refers to. // // This member is required. Resources []Resource @@ -9975,9 +9592,9 @@ type AwsSecurityFinding struct { // Indicates when the security-findings provider last updated the finding record. // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time - // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot - // contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Format (https://tools.ietf.org/html/rfc3339#section-5.6) . The value cannot + // contain spaces, and date and time should be separated by T . For example, + // 2020-03-22T13:22:13.933Z . // // This member is required. UpdatedAt *string @@ -9985,11 +9602,11 @@ type AwsSecurityFinding struct { // Provides details about an action that affects or that was taken on a resource. Action *Action - // The name of the company for the product that generated the finding. Security Hub - // populates this attribute automatically for each finding. You cannot update this - // attribute with BatchImportFindings or BatchUpdateFindings. The exception to this - // is a custom integration. When you use the Security Hub console or API to filter - // findings by company name, you use this attribute. + // The name of the company for the product that generated the finding. Security + // Hub populates this attribute automatically for each finding. You cannot update + // this attribute with BatchImportFindings or BatchUpdateFindings . The exception + // to this is a custom integration. When you use the Security Hub console or API to + // filter findings by company name, you use this attribute. CompanyName *string // This data type is exclusive to findings that are generated as the result of a @@ -10004,30 +9621,28 @@ type AwsSecurityFinding struct { // percent confidence and 100 means 100 percent confidence. Confidence int32 - // The level of importance assigned to the resources associated with the finding. A - // score of 0 means that the underlying resources have no criticality, and a score - // of 100 is reserved for the most critical resources. + // The level of importance assigned to the resources associated with the finding. + // A score of 0 means that the underlying resources have no criticality, and a + // score of 100 is reserved for the most critical resources. Criticality int32 - // In a BatchImportFindings request, finding providers use FindingProviderFields to - // provide and update their own values for confidence, criticality, related + // In a BatchImportFindings request, finding providers use FindingProviderFields + // to provide and update their own values for confidence, criticality, related // findings, severity, and types. FindingProviderFields *FindingProviderFields // Indicates when the security-findings provider first observed the potential // security issue that a finding captured. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . FirstObservedAt *string // Indicates when the security-findings provider most recently observed the // potential security issue that a finding captured. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LastObservedAt *string // A list of malware related to a finding. @@ -10059,7 +9674,7 @@ type AwsSecurityFinding struct { // The name of the product that generated the finding. Security Hub populates this // attribute automatically for each finding. You cannot update this attribute with - // BatchImportFindings or BatchUpdateFindings. The exception to this is a custom + // BatchImportFindings or BatchUpdateFindings . The exception to this is a custom // integration. When you use the Security Hub console or API to filter findings by // product name, you use this attribute. ProductName *string @@ -10069,7 +9684,7 @@ type AwsSecurityFinding struct { // The Region from which the finding was generated. Security Hub populates this // attribute automatically for each finding. You cannot update it using - // BatchImportFindings or BatchUpdateFindings. + // BatchImportFindings or BatchUpdateFindings . Region *string // A list of related findings. @@ -10100,8 +9715,8 @@ type AwsSecurityFinding struct { // Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications Types []string - // A list of name/value string pairs associated with the finding. These are custom, - // user-defined fields added to a finding. + // A list of name/value string pairs associated with the finding. These are + // custom, user-defined fields added to a finding. UserDefinedFields map[string]string // Indicates the veracity of a finding. @@ -10137,8 +9752,7 @@ type AwsSecurityFindingFilters struct { // The unique identifier of a standard in which a control is enabled. This field // consists of the resource portion of the Amazon Resource Name (ARN) returned for - // a standard in the DescribeStandards - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) + // a standard in the DescribeStandards (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) // API response. ComplianceAssociatedStandardsId []StringFilter @@ -10159,15 +9773,15 @@ type AwsSecurityFindingFilters struct { // An ISO8601-formatted timestamp that indicates when the security-findings // provider captured the potential security issue that a finding captured. A - // correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot - // contain spaces, and date and time should be separated by T. For more - // information, see RFC 3339 section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // correctly formatted example is 2020-05-21T20:16:34.724Z . The value cannot + // contain spaces, and date and time should be separated by T . For more + // information, see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . CreatedAt []DateFilter - // The level of importance assigned to the resources associated with the finding. A - // score of 0 means that the underlying resources have no criticality, and a score - // of 100 is reserved for the most critical resources. + // The level of importance assigned to the resources associated with the finding. + // A score of 0 means that the underlying resources have no criticality, and a + // score of 100 is reserved for the most critical resources. Criticality []NumberFilter // A finding's description. @@ -10180,10 +9794,10 @@ type AwsSecurityFindingFilters struct { // confidence. FindingProviderFieldsConfidence []NumberFilter - // The finding provider value for the level of importance assigned to the resources - // associated with the findings. A score of 0 means that the underlying resources - // have no criticality, and a score of 100 is reserved for the most critical - // resources. + // The finding provider value for the level of importance assigned to the + // resources associated with the findings. A score of 0 means that the underlying + // resources have no criticality, and a score of 100 is reserved for the most + // critical resources. FindingProviderFieldsCriticality []NumberFilter // The finding identifier of a related finding that is identified by the finding @@ -10208,10 +9822,10 @@ type AwsSecurityFindingFilters struct { // An ISO8601-formatted timestamp that indicates when the security-findings // provider first observed the potential security issue that a finding captured. A - // correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot - // contain spaces, and date and time should be separated by T. For more - // information, see RFC 3339 section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // correctly formatted example is 2020-05-21T20:16:34.724Z . The value cannot + // contain spaces, and date and time should be separated by T . For more + // information, see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . FirstObservedAt []DateFilter // The identifier for the solution-specific component (a discrete unit of logic) @@ -10229,10 +9843,10 @@ type AwsSecurityFindingFilters struct { // An ISO8601-formatted timestamp that indicates when the security-findings // provider most recently observed the potential security issue that a finding - // captured. A correctly formatted example is 2020-05-21T20:16:34.724Z. The value - // cannot contain spaces, and date and time should be separated by T. For more - // information, see RFC 3339 section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // captured. A correctly formatted example is 2020-05-21T20:16:34.724Z . The value + // cannot contain spaces, and date and time should be separated by T . For more + // information, see RFC 3339 section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . LastObservedAt []DateFilter // The name of the malware that was observed. @@ -10290,18 +9904,18 @@ type AwsSecurityFindingFilters struct { // The principal that created a note. NoteUpdatedBy []StringFilter - // A timestamp that identifies when the process was launched. A correctly formatted - // example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date - // and time should be separated by T. For more information, see RFC 3339 section - // 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // A timestamp that identifies when the process was launched. A correctly + // formatted example is 2020-05-21T20:16:34.724Z . The value cannot contain spaces, + // and date and time should be separated by T . For more information, see RFC 3339 + // section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . ProcessLaunchedAt []DateFilter // The name of the process. ProcessName []StringFilter // The parent process ID. This field accepts positive integers between O and - // 2147483647. + // 2147483647 . ProcessParentPid []NumberFilter // The path to the process executable. @@ -10311,15 +9925,15 @@ type AwsSecurityFindingFilters struct { ProcessPid []NumberFilter // A timestamp that identifies when the process was terminated. A correctly - // formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, - // and date and time should be separated by T. For more information, see RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // formatted example is 2020-05-21T20:16:34.724Z . The value cannot contain spaces, + // and date and time should be separated by T . For more information, see RFC 3339 + // section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . ProcessTerminatedAt []DateFilter - // The ARN generated by Security Hub that uniquely identifies a third-party company - // (security findings provider) after this provider's product (solution that - // generates findings) is registered with Security Hub. + // The ARN generated by Security Hub that uniquely identifies a third-party + // company (security findings provider) after this provider's product (solution + // that generates findings) is registered with Security Hub. ProductArn []StringFilter // A data type where security-findings providers can include additional @@ -10403,17 +10017,17 @@ type AwsSecurityFindingFilters struct { ResourceContainerImageName []StringFilter // A timestamp that identifies when the container was started. A correctly - // formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, - // and date and time should be separated by T. For more information, see RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // formatted example is 2020-05-21T20:16:34.724Z . The value cannot contain spaces, + // and date and time should be separated by T . For more information, see RFC 3339 + // section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . ResourceContainerLaunchedAt []DateFilter // The name of the container related to a finding. ResourceContainerName []StringFilter - // The details of a resource that doesn't have a specific subfield for the resource - // type defined. + // The details of a resource that doesn't have a specific subfield for the + // resource type defined. ResourceDetailsOther []MapFilter // The canonical identifier for the given resource type. @@ -10445,8 +10059,8 @@ type AwsSecurityFindingFilters struct { // FindingProviderFieldsSeverityLabel. SeverityNormalized []NumberFilter - // The native severity as defined by the security-findings provider's solution that - // generated the finding. + // The native severity as defined by the security-findings provider's solution + // that generated the finding. // // Deprecated: This filter is deprecated. Instead, use // FindingProviderSeverityOriginal. @@ -10484,70 +10098,53 @@ type AwsSecurityFindingFilters struct { // An ISO8601-formatted timestamp that indicates when the security-findings // provider last updated the finding record. A correctly formatted example is - // 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time - // should be separated by T. For more information, see RFC 3339 section 5.6, - // Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // 2020-05-21T20:16:34.724Z . The value cannot contain spaces, and date and time + // should be separated by T . For more information, see RFC 3339 section 5.6, + // Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) . UpdatedAt []DateFilter - // A list of name/value string pairs associated with the finding. These are custom, - // user-defined fields added to a finding. + // A list of name/value string pairs associated with the finding. These are + // custom, user-defined fields added to a finding. UserDefinedFields []MapFilter // The veracity of a finding. VerificationState []StringFilter // The workflow state of a finding. Note that this field is deprecated. To search - // for a finding based on its workflow status, use WorkflowStatus. + // for a finding based on its workflow status, use WorkflowStatus . WorkflowState []StringFilter // The status of the investigation into a finding. Allowed values are the // following. - // - // * NEW - The initial state of a finding, before it is reviewed. - // Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in - // the following cases: - // - // * RecordState changes from ARCHIVED to ACTIVE. - // - // * - // Compliance.Status changes from PASSED to either WARNING, FAILED, or - // NOT_AVAILABLE. - // - // * NOTIFIED - Indicates that the resource owner has been notified - // about the security issue. Used when the initial reviewer is not the resource - // owner, and needs intervention from the resource owner. If one of the following - // occurs, the workflow status is changed automatically from NOTIFIED to NEW: - // - // * - // RecordState changes from ARCHIVED to ACTIVE. - // - // * Compliance.Status changes from - // PASSED to FAILED, WARNING, or NOT_AVAILABLE. - // - // * SUPPRESSED - Indicates that you - // reviewed the finding and do not believe that any action is needed. The workflow - // status of a SUPPRESSED finding does not change if RecordState changes from - // ARCHIVED to ACTIVE. - // - // * RESOLVED - The finding was reviewed and remediated and is - // now considered resolved. The finding remains RESOLVED unless one of the - // following occurs: - // - // * RecordState changes from ARCHIVED to ACTIVE. - // - // * - // Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE. - // - // In - // those cases, the workflow status is automatically reset to NEW. For findings - // from controls, if Compliance.Status is PASSED, then Security Hub automatically - // sets the workflow status to RESOLVED. + // - NEW - The initial state of a finding, before it is reviewed. Security Hub + // also resets the workflow status from NOTIFIED or RESOLVED to NEW in the + // following cases: + // - RecordState changes from ARCHIVED to ACTIVE . + // - Compliance.Status changes from PASSED to either WARNING , FAILED , or + // NOT_AVAILABLE . + // - NOTIFIED - Indicates that the resource owner has been notified about the + // security issue. Used when the initial reviewer is not the resource owner, and + // needs intervention from the resource owner. If one of the following occurs, the + // workflow status is changed automatically from NOTIFIED to NEW : + // - RecordState changes from ARCHIVED to ACTIVE . + // - Compliance.Status changes from PASSED to FAILED , WARNING , or NOT_AVAILABLE + // . + // - SUPPRESSED - Indicates that you reviewed the finding and do not believe that + // any action is needed. The workflow status of a SUPPRESSED finding does not + // change if RecordState changes from ARCHIVED to ACTIVE . + // - RESOLVED - The finding was reviewed and remediated and is now considered + // resolved. The finding remains RESOLVED unless one of the following occurs: + // - RecordState changes from ARCHIVED to ACTIVE . + // - Compliance.Status changes from PASSED to FAILED , WARNING , or NOT_AVAILABLE + // . In those cases, the workflow status is automatically reset to NEW . For + // findings from controls, if Compliance.Status is PASSED , then Security Hub + // automatically sets the workflow status to RESOLVED . WorkflowStatus []StringFilter noSmithyDocumentSerde } -// Identifies a finding to update using BatchUpdateFindings. +// Identifies a finding to update using BatchUpdateFindings . type AwsSecurityFindingIdentifier struct { // The identifier of the finding that was specified by the finding provider. @@ -10650,68 +10247,61 @@ type AwsSqsQueueDetails struct { type AwsSsmComplianceSummary struct { // The type of resource for which the compliance was determined. For - // AwsSsmPatchCompliance, ComplianceType is Patch. + // AwsSsmPatchCompliance , ComplianceType is Patch . ComplianceType *string - // For the patches that are compliant, the number that have a severity of CRITICAL. + // For the patches that are compliant, the number that have a severity of CRITICAL . CompliantCriticalCount int32 - // For the patches that are compliant, the number that have a severity of HIGH. + // For the patches that are compliant, the number that have a severity of HIGH . CompliantHighCount int32 // For the patches that are compliant, the number that have a severity of - // INFORMATIONAL. + // INFORMATIONAL . CompliantInformationalCount int32 - // For the patches that are compliant, the number that have a severity of LOW. + // For the patches that are compliant, the number that have a severity of LOW . CompliantLowCount int32 - // For the patches that are compliant, the number that have a severity of MEDIUM. + // For the patches that are compliant, the number that have a severity of MEDIUM . CompliantMediumCount int32 // For the patches that are compliant, the number that have a severity of - // UNSPECIFIED. + // UNSPECIFIED . CompliantUnspecifiedCount int32 // The type of execution that was used determine compliance. ExecutionType *string // For the patch items that are noncompliant, the number of items that have a - // severity of CRITICAL. + // severity of CRITICAL . NonCompliantCriticalCount int32 - // For the patches that are noncompliant, the number that have a severity of HIGH. + // For the patches that are noncompliant, the number that have a severity of HIGH . NonCompliantHighCount int32 // For the patches that are noncompliant, the number that have a severity of - // INFORMATIONAL. + // INFORMATIONAL . NonCompliantInformationalCount int32 - // For the patches that are noncompliant, the number that have a severity of LOW. + // For the patches that are noncompliant, the number that have a severity of LOW . NonCompliantLowCount int32 - // For the patches that are noncompliant, the number that have a severity of - // MEDIUM. + // For the patches that are noncompliant, the number that have a severity of MEDIUM + // . NonCompliantMediumCount int32 // For the patches that are noncompliant, the number that have a severity of - // UNSPECIFIED. + // UNSPECIFIED . NonCompliantUnspecifiedCount int32 // The highest severity for the patches. Valid values are as follows: - // - // * - // CRITICAL - // - // * HIGH - // - // * MEDIUM - // - // * LOW - // - // * INFORMATIONAL - // - // * UNSPECIFIED + // - CRITICAL + // - HIGH + // - MEDIUM + // - LOW + // - INFORMATIONAL + // - UNSPECIFIED OverallSeverity *string // The identifier of the patch baseline. The patch baseline lists the patches that @@ -10724,13 +10314,9 @@ type AwsSsmComplianceSummary struct { PatchGroup *string // The current patch compliance status. Valid values are as follows: - // - // * - // COMPLIANT - // - // * NON_COMPLIANT - // - // * UNSPECIFIED_DATA + // - COMPLIANT + // - NON_COMPLIANT + // - UNSPECIFIED_DATA Status *string noSmithyDocumentSerde @@ -10755,9 +10341,10 @@ type AwsSsmPatchComplianceDetails struct { noSmithyDocumentSerde } -// Details about a rate-based rule for global resources. A rate-based rule provides -// settings to indicate when to allow, block, or count a request. Rate-based rules -// include the number of requests that arrive over a specified period of time. +// Details about a rate-based rule for global resources. A rate-based rule +// provides settings to indicate when to allow, block, or count a request. +// Rate-based rules include the number of requests that arrive over a specified +// period of time. type AwsWafRateBasedRuleDetails struct { // The predicates to include in the rate-based rule. @@ -10774,9 +10361,9 @@ type AwsWafRateBasedRuleDetails struct { RateKey *string // The maximum number of requests that have an identical value for the field - // specified in RateKey that are allowed within a five-minute period. If the number - // of requests exceeds RateLimit and the other predicates specified in the rule are - // met, WAF triggers the action for the rule. + // specified in RateKey that are allowed within a five-minute period. If the + // number of requests exceeds RateLimit and the other predicates specified in the + // rule are met, WAF triggers the action for the rule. RateLimit int64 // The unique identifier for the rate-based rule. @@ -10792,27 +10379,19 @@ type AwsWafRateBasedRuleMatchPredicate struct { // The unique identifier for the predicate. DataId *string - // If set to true, then the rule actions are performed on requests that match the - // predicate settings. If set to false, then the rule actions are performed on all + // If set to true , then the rule actions are performed on requests that match the + // predicate settings. If set to false , then the rule actions are performed on all // requests except those that match the predicate settings. Negated bool // The type of predicate. Valid values are as follows: - // - // * ByteMatch - // - // * GeoMatch - // - // * - // IPMatch - // - // * RegexMatch - // - // * SizeConstraint - // - // * SqlInjectionMatch - // - // * XssMatch + // - ByteMatch + // - GeoMatch + // - IPMatch + // - RegexMatch + // - SizeConstraint + // - SqlInjectionMatch + // - XssMatch Type *string noSmithyDocumentSerde @@ -10838,9 +10417,9 @@ type AwsWafRegionalRateBasedRuleDetails struct { RateKey *string // The maximum number of requests that have an identical value for the field - // specified in RateKey that are allowed within a five-minute period. If the number - // of requests exceeds RateLimit and the other predicates specified in the rule are - // met, WAF triggers the action for the rule. + // specified in RateKey that are allowed within a five-minute period. If the + // number of requests exceeds RateLimit and the other predicates specified in the + // rule are met, WAF triggers the action for the rule. RateLimit int64 // The unique identifier for the rate-based rule. @@ -10856,27 +10435,19 @@ type AwsWafRegionalRateBasedRuleMatchPredicate struct { // The unique identifier for the predicate. DataId *string - // If set to true, then the rule actions are performed on requests that match the - // predicate settings. If set to false, then the rule actions are performed on all + // If set to true , then the rule actions are performed on requests that match the + // predicate settings. If set to false , then the rule actions are performed on all // requests except those that match the predicate settings. Negated bool // The type of predicate. Valid values are as follows: - // - // * ByteMatch - // - // * GeoMatch - // - // * - // IPMatch - // - // * RegexMatch - // - // * SizeConstraint - // - // * SqlInjectionMatch - // - // * XssMatch + // - ByteMatch + // - GeoMatch + // - IPMatch + // - RegexMatch + // - SizeConstraint + // - SqlInjectionMatch + // - XssMatch Type *string noSmithyDocumentSerde @@ -10892,9 +10463,9 @@ type AwsWafRegionalRuleDetails struct { // A descriptive name for the rule. Name *string - // Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add - // to a rule and, for each object, indicates whether you want to negate the + // Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that you want to + // add to a rule and, for each object, indicates whether you want to negate the // settings. PredicateList []AwsWafRegionalRulePredicateListDetails @@ -10917,8 +10488,8 @@ type AwsWafRegionalRuleGroupDetails struct { // The ID of the rule group. RuleGroupId *string - // Provides information about the rule statements used to identify the web requests - // that you want to allow, block, or count. + // Provides information about the rule statements used to identify the web + // requests that you want to allow, block, or count. Rules []AwsWafRegionalRuleGroupRulesDetails noSmithyDocumentSerde @@ -10928,9 +10499,9 @@ type AwsWafRegionalRuleGroupDetails struct { // criteria defined in the rule. type AwsWafRegionalRuleGroupRulesActionDetails struct { - // Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add - // to a rule and, for each object, indicates whether you want to negate the + // Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that you want to + // add to a rule and, for each object, indicates whether you want to negate the // settings. Type *string @@ -10945,7 +10516,7 @@ type AwsWafRegionalRuleGroupRulesDetails struct { Action *AwsWafRegionalRuleGroupRulesActionDetails // If you define more than one rule in a web ACL, WAF evaluates each request - // against the rules in order based on the value of Priority. + // against the rules in order based on the value of Priority . Priority int32 // The ID for a rule. @@ -10957,22 +10528,22 @@ type AwsWafRegionalRuleGroupRulesDetails struct { noSmithyDocumentSerde } -// Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, -// XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you -// want to add to a rule and, for each object, indicates whether you want to negate -// the settings. +// Provides details about the ByteMatchSet , IPSet , SqlInjectionMatchSet , +// XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that +// you want to add to a rule and, for each object, indicates whether you want to +// negate the settings. type AwsWafRegionalRulePredicateListDetails struct { - // A unique identifier for a predicate in a rule, such as ByteMatchSetId or - // IPSetId. + // A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId + // . DataId *string // Specifies if you want WAF to allow, block, or count requests based on the - // settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, or SizeConstraintSet. + // settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , or SizeConstraintSet . Negated bool - // The type of predicate in a rule, such as ByteMatch or IPSet. + // The type of predicate in a rule, such as ByteMatch or IPSet . Type *string noSmithyDocumentSerde @@ -11002,8 +10573,8 @@ type AwsWafRegionalWebAclDetails struct { noSmithyDocumentSerde } -// The action that WAF takes when a web request matches all conditions in the rule, -// such as allow, block, or count the request. +// The action that WAF takes when a web request matches all conditions in the +// rule, such as allow, block, or count the request. type AwsWafRegionalWebAclRulesListActionDetails struct { // For actions that are associated with a rule, the action that WAF takes when a @@ -11013,12 +10584,12 @@ type AwsWafRegionalWebAclRulesListActionDetails struct { noSmithyDocumentSerde } -// A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that -// identify the web requests that you want to allow, block, or count. +// A combination of ByteMatchSet , IPSet , and/or SqlInjectionMatchSet objects +// that identify the web requests that you want to allow, block, or count. type AwsWafRegionalWebAclRulesListDetails struct { - // The action that WAF takes when a web request matches all conditions in the rule, - // such as allow, block, or count the request. + // The action that WAF takes when a web request matches all conditions in the + // rule, such as allow, block, or count the request. Action *AwsWafRegionalWebAclRulesListActionDetails // Overrides the rule evaluation result in the rule group. @@ -11037,8 +10608,8 @@ type AwsWafRegionalWebAclRulesListDetails struct { noSmithyDocumentSerde } -// Provides details about the action to use in the place of the action that results -// from the rule group evaluation. +// Provides details about the action to use in the place of the action that +// results from the rule group evaluation. type AwsWafRegionalWebAclRulesListOverrideActionDetails struct { // Overrides the rule evaluation result in the rule group. @@ -11047,8 +10618,8 @@ type AwsWafRegionalWebAclRulesListOverrideActionDetails struct { noSmithyDocumentSerde } -// Provides information about a WAF rule. This rule specifies the web requests that -// you want to allow, block, or count. +// Provides information about a WAF rule. This rule specifies the web requests +// that you want to allow, block, or count. type AwsWafRuleDetails struct { // The name of the metrics for this rule. @@ -11057,9 +10628,9 @@ type AwsWafRuleDetails struct { // A descriptive name for the rule. Name *string - // Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add - // to a rule and, for each object, indicates whether you want to negate the + // Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that you want to + // add to a rule and, for each object, indicates whether you want to negate the // settings. PredicateList []AwsWafRulePredicateListDetails @@ -11109,7 +10680,7 @@ type AwsWafRuleGroupRulesDetails struct { Action *AwsWafRuleGroupRulesActionDetails // If you define more than one rule in a web ACL, WAF evaluates each request - // against the rules in order based on the value of Priority. + // against the rules in order based on the value of Priority . Priority int32 // The rule ID for a rule. @@ -11121,22 +10692,22 @@ type AwsWafRuleGroupRulesDetails struct { noSmithyDocumentSerde } -// Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, -// XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you -// want to add to a rule and, for each object, indicates whether you want to negate -// the settings. +// Provides details about the ByteMatchSet , IPSet , SqlInjectionMatchSet , +// XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that +// you want to add to a rule and, for each object, indicates whether you want to +// negate the settings. type AwsWafRulePredicateListDetails struct { - // A unique identifier for a predicate in a rule, such as ByteMatchSetId or - // IPSetId. + // A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId + // . DataId *string // Specifies if you want WAF to allow, block, or count requests based on the - // settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, or SizeConstraintSet. + // settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , or SizeConstraintSet . Negated bool - // The type of predicate in a rule, such as ByteMatch or IPSet. + // The type of predicate in a rule, such as ByteMatch or IPSet . Type *string noSmithyDocumentSerde @@ -11147,8 +10718,7 @@ type AwsWafRulePredicateListDetails struct { type AwsWafv2ActionAllowDetails struct { // Defines custom handling for the web request. For information about customizing - // web requests and responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // web requests and responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide.. CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails @@ -11160,8 +10730,7 @@ type AwsWafv2ActionAllowDetails struct { type AwsWafv2ActionBlockDetails struct { // Defines a custom response for the web request. For information, see Customizing - // web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide.. CustomResponse *AwsWafv2CustomResponseDetails @@ -11180,8 +10749,9 @@ type AwsWafv2CustomHttpHeader struct { noSmithyDocumentSerde } -// Custom request handling behavior that inserts custom headers into a web request. -// WAF uses custom request handling when the rule action doesn't block the request. +// Custom request handling behavior that inserts custom headers into a web +// request. WAF uses custom request handling when the rule action doesn't block the +// request. type AwsWafv2CustomRequestHandlingDetails struct { // The HTTP headers to insert into the request. @@ -11201,8 +10771,7 @@ type AwsWafv2CustomResponseDetails struct { // The HTTP status code to return to the client. For a list of status codes that // you can use in your custom responses, see Supported status codes for custom - // response - // (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) + // response (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) // in the WAF Developer Guide. ResponseCode int32 @@ -11227,8 +10796,8 @@ type AwsWafv2RuleGroupDetails struct { // A unique identifier for the rule group. Id *string - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. Name *string // The Rule statements used to identify the web requests that you want to allow, @@ -11236,8 +10805,8 @@ type AwsWafv2RuleGroupDetails struct { // identify matching web requests, and parameters that govern how WAF handles them. Rules []AwsWafv2RulesDetails - // Specifies whether the rule group is for an Amazon CloudFront distribution or for - // a regional application. A regional application can be an Application Load + // Specifies whether the rule group is for an Amazon CloudFront distribution or + // for a regional application. A regional application can be an Application Load // Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an // Amazon Cognito user pool. Scope *string @@ -11253,8 +10822,7 @@ type AwsWafv2RulesActionCaptchaDetails struct { // Defines custom handling for the web request, used when the CAPTCHA inspection // determines that the request's token is valid and unexpired. For more - // information, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // information, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide.. CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails @@ -11265,8 +10833,7 @@ type AwsWafv2RulesActionCaptchaDetails struct { type AwsWafv2RulesActionCountDetails struct { // Defines custom handling for the web request. For more information, see - // Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide.. CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails @@ -11310,10 +10877,10 @@ type AwsWafv2RulesDetails struct { // evaluation. OverrideAction *string - // If you define more than one Rule in a WebACL, WAF evaluates each request against - // the Rules in order based on the value of Priority. WAF processes rules with - // lower priority first. The priorities don't need to be consecutive, but they must - // all be different. + // If you define more than one Rule in a WebACL, WAF evaluates each request + // against the Rules in order based on the value of Priority . WAF processes rules + // with lower priority first. The priorities don't need to be consecutive, but they + // must all be different. Priority int32 // Defines and enables Amazon CloudWatch metrics and web request sample collection. @@ -11326,8 +10893,7 @@ type AwsWafv2RulesDetails struct { type AwsWafv2VisibilityConfigDetails struct { // A boolean indicating whether the associated resource sends metrics to Amazon - // CloudWatch. For the list of available metrics, see WAF metrics and dimensions - // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) + // CloudWatch. For the list of available metrics, see WAF metrics and dimensions (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) // in the WAF Developer Guide. CloudWatchMetricsEnabled bool @@ -11440,23 +11006,24 @@ type AwsWafWebAclDetails struct { // Details for a rule in an WAF web ACL. type AwsWafWebAclRule struct { - // Specifies the action that CloudFront or WAF takes when a web request matches the - // conditions in the rule. + // Specifies the action that CloudFront or WAF takes when a web request matches + // the conditions in the rule. Action *WafAction // Rules to exclude from a rule group. ExcludedRules []WafExcludedRule - // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can - // potentially block a request. If you set the OverrideAction to None, the + // Use the OverrideAction to test your RuleGroup . Any rule in a RuleGroup can + // potentially block a request. If you set the OverrideAction to None , the // RuleGroup blocks a request if any individual rule in the RuleGroup matches the // request and is configured to block that request. However, if you first want to - // test the RuleGroup, set the OverrideAction to Count. The RuleGroup then + // test the RuleGroup , set the OverrideAction to Count . The RuleGroup then // overrides any block action specified by individual rules contained within the // group. Instead of blocking matching requests, those requests are counted. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a web ACL. In this case you do not use ActivatedRuleAction. For all other update - // requests, ActivatedRuleAction is used instead of ActivatedRuleOverrideAction. + // ActivatedRule | OverrideAction applies only when updating or adding a RuleGroup + // to a web ACL. In this case you do not use ActivatedRule Action . For all other + // update requests, ActivatedRule Action is used instead of ActivatedRule + // OverrideAction . OverrideAction *WafOverrideAction // Specifies the order in which the rules in a web ACL are evaluated. Rules with a @@ -11468,8 +11035,8 @@ type AwsWafWebAclRule struct { // The identifier for a rule. RuleId *string - // The rule type. Valid values: REGULAR | RATE_BASED | GROUP The default is - // REGULAR. + // The rule type. Valid values: REGULAR | RATE_BASED | GROUP The default is REGULAR + // . Type *string noSmithyDocumentSerde @@ -11479,12 +11046,12 @@ type AwsWafWebAclRule struct { type AwsXrayEncryptionConfigDetails struct { // The identifier of the KMS key that is used for encryption. Provided if Type is - // KMS. + // KMS . KeyId *string // The current status of the encryption configuration. Valid values are ACTIVE or - // UPDATING. When Status is equal to UPDATING, X-Ray might use both the old and new - // encryption. + // UPDATING . When Status is equal to UPDATING , X-Ray might use both the old and + // new encryption. Status *string // The type of encryption. KMS indicates that the encryption uses KMS keys. NONE @@ -11499,53 +11066,33 @@ type AwsXrayEncryptionConfigDetails struct { type BatchUpdateFindingsUnprocessedFinding struct { // The code associated with the error. Possible values are: - // - // * - // ConcurrentUpdateError - Another request attempted to update the finding while - // this request was being processed. This error may also occur if you call - // BatchUpdateFindings - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html) - // and BatchImportFindings - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html) - // at the same time. - // - // * DuplicatedFindingIdentifier - The request included two or - // more findings with the same FindingIdentifier. - // - // * FindingNotFound - The - // FindingIdentifier included in the request did not match an existing finding. - // - // * - // FindingSizeExceeded - The finding size was greater than the permissible value of - // 240 KB. - // - // * InternalFailure - An internal service failure occurred when updating - // the finding. - // - // * InvalidInput - The finding update contained an invalid value - // that did not satisfy the Amazon Web Services Security Finding Format - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) - // syntax. + // - ConcurrentUpdateError - Another request attempted to update the finding + // while this request was being processed. This error may also occur if you call + // BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html) + // and BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html) + // at the same time. + // - DuplicatedFindingIdentifier - The request included two or more findings with + // the same FindingIdentifier . + // - FindingNotFound - The FindingIdentifier included in the request did not + // match an existing finding. + // - FindingSizeExceeded - The finding size was greater than the permissible + // value of 240 KB. + // - InternalFailure - An internal service failure occurred when updating the + // finding. + // - InvalidInput - The finding update contained an invalid value that did not + // satisfy the Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) + // syntax. // // This member is required. ErrorCode *string // The message associated with the error. Possible values are: - // - // * Concurrent - // finding updates detected - // - // * Finding Identifier is duplicated - // - // * Finding Not - // Found - // - // * Finding size exceeded 240 KB - // - // * Internal service failure - // - // * Invalid - // Input + // - Concurrent finding updates detected + // - Finding Identifier is duplicated + // - Finding Not Found + // - Finding size exceeded 240 KB + // - Internal service failure + // - Invalid Input // // This member is required. ErrorMessage *string @@ -11672,27 +11219,19 @@ type Compliance struct { SecurityControlId *string // The result of a standards check. The valid values for Status are as follows. - // - // * - // PASSED - Standards check passed for all evaluated resources. - // - // * WARNING - Some - // information is missing or this check is not supported for your configuration. - // - // * - // FAILED - Standards check failed for at least one evaluated resource. - // - // * - // NOT_AVAILABLE - Check could not be performed due to a service outage, API error, - // or because the result of the Config evaluation was NOT_APPLICABLE. If the Config - // evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub - // automatically archives the finding. + // - PASSED - Standards check passed for all evaluated resources. + // - WARNING - Some information is missing or this check is not supported for + // your configuration. + // - FAILED - Standards check failed for at least one evaluated resource. + // - NOT_AVAILABLE - Check could not be performed due to a service outage, API + // error, or because the result of the Config evaluation was NOT_APPLICABLE . If + // the Config evaluation result was NOT_APPLICABLE , then after 3 days, Security + // Hub automatically archives the finding. Status ComplianceStatus // For findings generated from controls, a list of reasons behind the value of - // Status. For the list of status reason codes and their meanings, see - // Standards-related information in the ASFF - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff) + // Status . For the list of status reason codes and their meanings, see + // Standards-related information in the ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff) // in the Security Hub User Guide. StatusReasons []StatusReason @@ -11711,17 +11250,16 @@ type ContainerDetails struct { // The name of the container image related to a finding. ImageName *string - // Indicates when the container started. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the container started. Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LaunchedAt *string // The name of the container related to a finding. Name *string - // When this parameter is true, the container is given elevated privileges on the + // When this parameter is true , the container is given elevated privileges on the // host container instance (similar to the root user). Privileged bool @@ -11814,17 +11352,17 @@ type DateFilter struct { DateRange *DateRange // A timestamp that provides the end date for the date filter. A correctly - // formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, - // and date and time should be separated by T. For more information, see RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // formatted example is 2020-05-21T20:16:34.724Z . The value cannot contain spaces, + // and date and time should be separated by T . For more information, see RFC 3339 + // section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . End *string // A timestamp that provides the start date for the date filter. A correctly - // formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, - // and date and time should be separated by T. For more information, see RFC 3339 - // section 5.6, Internet Date/Time Format - // (https://www.rfc-editor.org/rfc/rfc3339#section-5.6). + // formatted example is 2020-05-21T20:16:34.724Z . The value cannot contain spaces, + // and date and time should be separated by T . For more information, see RFC 3339 + // section 5.6, Internet Date/Time Format (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) + // . Start *string noSmithyDocumentSerde @@ -11842,8 +11380,8 @@ type DateRange struct { noSmithyDocumentSerde } -// Provided if ActionType is DNS_REQUEST. It provides details about the DNS request -// that was detected. +// Provided if ActionType is DNS_REQUEST . It provides details about the DNS +// request that was detected. type DnsRequestAction struct { // Indicates whether the DNS request was blocked. @@ -11887,8 +11425,8 @@ type FindingAggregator struct { noSmithyDocumentSerde } -// In a BatchImportFindings request, finding providers use FindingProviderFields to -// provide and update values for confidence, criticality, related findings, +// In a BatchImportFindings request, finding providers use FindingProviderFields +// to provide and update values for confidence, criticality, related findings, // severity, and types. type FindingProviderFields struct { @@ -11898,9 +11436,9 @@ type FindingProviderFields struct { // percent confidence and 100 means 100 percent confidence. Confidence int32 - // The level of importance assigned to the resources associated with the finding. A - // score of 0 means that the underlying resources have no criticality, and a score - // of 100 is reserved for the most critical resources. + // The level of importance assigned to the resources associated with the finding. + // A score of 0 means that the underlying resources have no criticality, and a + // score of 100 is reserved for the most critical resources. Criticality int32 // A list of findings that are related to the current finding. @@ -11935,20 +11473,20 @@ type FirewallPolicyDetails struct { // The stateful rule groups that are used in the firewall policy. StatefulRuleGroupReferences []FirewallPolicyStatefulRuleGroupReferencesDetails - // The custom action definitions that are available to use in the firewall policy's - // StatelessDefaultActions setting. + // The custom action definitions that are available to use in the firewall + // policy's StatelessDefaultActions setting. StatelessCustomActions []FirewallPolicyStatelessCustomActionsDetails // The actions to take on a packet if it doesn't match any of the stateless rules - // in the policy. You must specify a standard action (aws:pass, aws:drop, - // aws:forward_to_sfe), and can optionally include a custom action from - // StatelessCustomActions. + // in the policy. You must specify a standard action ( aws:pass , aws:drop , + // aws:forward_to_sfe ), and can optionally include a custom action from + // StatelessCustomActions . StatelessDefaultActions []string // The actions to take on a fragmented UDP packet if it doesn't match any of the - // stateless rules in the policy. You must specify a standard action (aws:pass, - // aws:drop, aws:forward_to_sfe), and can optionally include a custom action from - // StatelessCustomActions. + // stateless rules in the policy. You must specify a standard action ( aws:pass , + // aws:drop , aws:forward_to_sfe ), and can optionally include a custom action from + // StatelessCustomActions . StatelessFragmentDefaultActions []string // The stateless rule groups that are used in the firewall policy. @@ -12005,12 +11543,12 @@ type GeoLocation struct { // An Internet Control Message Protocol (ICMP) type and code. type IcmpTypeCode struct { - // The ICMP code for which to deny or allow access. To deny or allow all codes, use - // the value -1. + // The ICMP code for which to deny or allow access. To deny or allow all codes, + // use the value -1 . Code int32 - // The ICMP type for which to deny or allow access. To deny or allow all types, use - // the value -1. + // The ICMP type for which to deny or allow access. To deny or allow all types, + // use the value -1 . Type int32 noSmithyDocumentSerde @@ -12071,8 +11609,8 @@ type Insight struct { // The insight results returned by the GetInsightResults operation. type InsightResults struct { - // The attribute that the findings are grouped by for the insight whose results are - // returned by the GetInsightResults operation. + // The attribute that the findings are grouped by for the insight whose results + // are returned by the GetInsightResults operation. // // This member is required. GroupByAttribute *string @@ -12094,7 +11632,7 @@ type InsightResults struct { // The insight result values returned by the GetInsightResults operation. type InsightResultValue struct { - // The number of findings returned for each GroupByAttributeValue. + // The number of findings returned for each GroupByAttributeValue . // // This member is required. Count int32 @@ -12111,8 +11649,8 @@ type InsightResultValue struct { // Details about an invitation. type Invitation struct { - // The account ID of the Security Hub administrator account that the invitation was - // sent from. + // The account ID of the Security Hub administrator account that the invitation + // was sent from. AccountId *string // The ID of the invitation sent to the member account. @@ -12162,20 +11700,12 @@ type Ipv6CidrBlockAssociation struct { AssociationId *string // Information about the state of the CIDR block. Valid values are as follows: - // - // * - // associating - // - // * associated - // - // * disassociating - // - // * disassociated - // - // * failed - // - // * - // failing + // - associating + // - associated + // - disassociating + // - disassociated + // - failed + // - failing CidrBlockState *string // The IPv6 CIDR block. @@ -12227,30 +11757,30 @@ type Malware struct { noSmithyDocumentSerde } -// A map filter for querying findings. Each map filter provides the field to check, -// the value to look for, and the comparison operator. +// A map filter for querying findings. Each map filter provides the field to +// check, the value to look for, and the comparison operator. type MapFilter struct { // The condition to apply to the key value when querying for findings with a map - // filter. To search for values that exactly match the filter value, use EQUALS. + // filter. To search for values that exactly match the filter value, use EQUALS . // For example, for the ResourceTags field, the filter Department EQUALS Security - // matches findings that have the value Security for the tag Department. To search - // for values other than the filter value, use NOT_EQUALS. For example, for the + // matches findings that have the value Security for the tag Department . To search + // for values other than the filter value, use NOT_EQUALS . For example, for the // ResourceTags field, the filter Department NOT_EQUALS Finance matches findings - // that do not have the value Finance for the tag Department. EQUALS filters on the - // same field are joined by OR. A finding matches if it matches any one of those - // filters. NOT_EQUALS filters on the same field are joined by AND. A finding - // matches only if it matches all of those filters. You cannot have both an EQUALS - // filter and a NOT_EQUALS filter on the same field. + // that do not have the value Finance for the tag Department . EQUALS filters on + // the same field are joined by OR . A finding matches if it matches any one of + // those filters. NOT_EQUALS filters on the same field are joined by AND . A + // finding matches only if it matches all of those filters. You cannot have both an + // EQUALS filter and a NOT_EQUALS filter on the same field. Comparison MapFilterComparison - // The key of the map filter. For example, for ResourceTags, Key identifies the - // name of the tag. For UserDefinedFields, Key is the name of the field. + // The key of the map filter. For example, for ResourceTags , Key identifies the + // name of the tag. For UserDefinedFields , Key is the name of the field. Key *string // The value for the key in the map filter. Filter values are case sensitive. For - // example, one of the values for a tag called Department might be Security. If you - // provide security as the filter value, then there is no match. + // example, one of the values for a tag called Department might be Security . If + // you provide security as the filter value, then there is no match. Value *string noSmithyDocumentSerde @@ -12273,7 +11803,7 @@ type Member struct { // account. InvitedAt *time.Time - // This is replaced by AdministratorID. The Amazon Web Services account ID of the + // This is replaced by AdministratorID . The Amazon Web Services account ID of the // Security Hub administrator account associated with this member account. // // Deprecated: This field is deprecated, use AdministratorId instead. @@ -12281,32 +11811,22 @@ type Member struct { // The status of the relationship between the member account and its administrator // account. The status can have one of the following values: - // - // * Created - Indicates - // that the administrator account added the member account, but has not yet invited - // the member account. - // - // * Invited - Indicates that the administrator account - // invited the member account. The member account has not yet responded to the - // invitation. - // - // * Enabled - Indicates that the member account is currently active. - // For manually invited member accounts, indicates that the member account accepted - // the invitation. - // - // * Removed - Indicates that the administrator account - // disassociated the member account. - // - // * Resigned - Indicates that the member - // account disassociated themselves from the administrator account. - // - // * Deleted - - // Indicates that the administrator account deleted the member account. - // - // * - // AccountSuspended - Indicates that an organization account was suspended from - // Amazon Web Services at the same time that the administrator account tried to - // enable the organization account as a member account. + // - Created - Indicates that the administrator account added the member account, + // but has not yet invited the member account. + // - Invited - Indicates that the administrator account invited the member + // account. The member account has not yet responded to the invitation. + // - Enabled - Indicates that the member account is currently active. For + // manually invited member accounts, indicates that the member account accepted the + // invitation. + // - Removed - Indicates that the administrator account disassociated the member + // account. + // - Resigned - Indicates that the member account disassociated themselves from + // the administrator account. + // - Deleted - Indicates that the administrator account deleted the member + // account. + // - AccountSuspended - Indicates that an organization account was suspended from + // Amazon Web Services at the same time that the administrator account tried to + // enable the organization account as a member account. MemberStatus *string // The timestamp for the date and time when the member account was updated. @@ -12358,14 +11878,14 @@ type Network struct { noSmithyDocumentSerde } -// Provided if ActionType is NETWORK_CONNECTION. It provides details about the +// Provided if ActionType is NETWORK_CONNECTION . It provides details about the // attempted network connection that was detected. type NetworkConnectionAction struct { // Indicates whether the network connection attempt was blocked. Blocked bool - // The direction of the network connection request (IN or OUT). + // The direction of the network connection request ( IN or OUT ). ConnectionDirection *string // Information about the port on the EC2 instance. @@ -12441,10 +11961,9 @@ type Note struct { Text *string // The timestamp of when the note was updated. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . // // This member is required. UpdatedAt *string @@ -12566,21 +12085,19 @@ type PatchSummary struct { MissingCount int32 // The type of patch operation performed. For Patch Manager, the values are SCAN - // and INSTALL. + // and INSTALL . Operation *string // Indicates when the operation completed. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . OperationEndTime *string - // Indicates when the operation started. Uses the date-time format specified in RFC - // 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the operation started. Uses the date-time format specified in + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . OperationStartTime *string // The reboot option specified for the instance. @@ -12589,7 +12106,7 @@ type PatchSummary struct { noSmithyDocumentSerde } -// Provided if ActionType is PORT_PROBE. It provides details about the attempted +// Provided if ActionType is PORT_PROBE . It provides details about the attempted // port probe that was detected. type PortProbeAction struct { @@ -12647,17 +12164,16 @@ type PortRangeFromTo struct { type ProcessDetails struct { // Indicates when the process was launched. Uses the date-time format specified in - // RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . LaunchedAt *string // The name of the process. Name *string // The parent process ID. This field accepts positive integers between O and - // 2147483647. + // 2147483647 . ParentPid int32 // The path to the process executable. @@ -12667,10 +12183,9 @@ type ProcessDetails struct { Pid int32 // Indicates when the process was terminated. Uses the date-time format specified - // in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . TerminatedAt *string noSmithyDocumentSerde @@ -12699,16 +12214,13 @@ type Product struct { // The types of integration that the product supports. Available values are the // following. - // - // * SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to - // Security Hub. - // - // * RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives - // findings from Security Hub. - // - // * UPDATE_FINDINGS_IN_SECURITY_HUB - The integration - // does not send new findings to Security Hub, but does make updates to the - // findings that it receives from Security Hub. + // - SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security + // Hub. + // - RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from + // Security Hub. + // - UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings + // to Security Hub, but does make updates to the findings that it receives from + // Security Hub. IntegrationTypes []IntegrationType // For integrations with Amazon Web Services services, the Amazon Web Services @@ -12771,9 +12283,9 @@ type Recommendation struct { // Parquet file. type Record struct { - // The path, as a JSONPath expression, to the field in the record that contains the - // data. If the field name is longer than 20 characters, it is truncated. If the - // path is longer than 250 characters, it is truncated. + // The path, as a JSONPath expression, to the field in the record that contains + // the data. If the field name is longer than 20 characters, it is truncated. If + // the path is longer than 250 characters, it is truncated. JsonPath *string // The record index, starting from 0, for the record that contains the data. @@ -12816,10 +12328,10 @@ type Resource struct { // This member is required. Id *string - // The type of the resource that details are provided for. If possible, set Type to - // one of the supported resource types. For example, if the resource is an EC2 - // instance, then set Type to AwsEc2Instance. If the resource does not match any of - // the provided types, then set Type to Other. + // The type of the resource that details are provided for. If possible, set Type + // to one of the supported resource types. For example, if the resource is an EC2 + // instance, then set Type to AwsEc2Instance . If the resource does not match any + // of the provided types, then set Type to Other . // // This member is required. Type *string @@ -12850,7 +12362,7 @@ type Resource struct { // Additional details about a resource related to a finding. To provide the // details, use the object that corresponds to the resource type. For example, if -// the resource type is AwsEc2Instance, then you use the AwsEc2Instance object to +// the resource type is AwsEc2Instance , then you use the AwsEc2Instance object to // provide the details. If the type-specific object does not contain all of the // fields you want to populate, then you use the Other object to populate those // additional fields. You also use the Other object to populate the details when @@ -13122,15 +12634,12 @@ type ResourceDetails struct { // Details about a resource that are not available in a type-specific details // object. Use the Other object in the following cases. - // - // * The type-specific object - // does not contain all of the fields that you want to populate. In this case, - // first use the type-specific object to populate those fields. Use the Other - // object to populate the fields that are missing from the type-specific object. - // - // * - // The resource type does not have a corresponding object. This includes resources - // for which the type is Other. + // - The type-specific object does not contain all of the fields that you want + // to populate. In this case, first use the type-specific object to populate those + // fields. Use the Other object to populate the fields that are missing from the + // type-specific object. + // - The resource type does not have a corresponding object. This includes + // resources for which the type is Other . Other map[string]string noSmithyDocumentSerde @@ -13209,8 +12718,8 @@ type RuleGroupDetails struct { RuleVariables *RuleGroupVariables // The rules and actions for the rule group. For stateful rule groups, can contain - // RulesString, RulesSourceList, or StatefulRules. For stateless rule groups, - // contains StatelessRulesAndCustomActions. + // RulesString , RulesSourceList , or StatefulRules . For stateless rule groups, + // contains StatelessRulesAndCustomActions . RulesSource *RuleGroupSource noSmithyDocumentSerde @@ -13252,7 +12761,7 @@ type RuleGroupSourceCustomActionsDetails struct { // Stateful inspection criteria for a domain list rule group. type RuleGroupSourceListDetails struct { - // Indicates whether to allow or deny access to the domains listed in Targets. + // Indicates whether to allow or deny access to the domains listed in Targets . GeneratedRulesType *string // The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify @@ -13261,7 +12770,7 @@ type RuleGroupSourceListDetails struct { // The domains that you want to inspect for in your traffic flows. You can provide // full domain names, or use the '.' prefix as a wildcard. For example, - // .example.com matches all domains that end with example.com. + // .example.com matches all domains that end with example.com . Targets []string noSmithyDocumentSerde @@ -13286,31 +12795,31 @@ type RuleGroupSourceStatefulRulesDetails struct { // The inspection criteria for a stateful rule. type RuleGroupSourceStatefulRulesHeaderDetails struct { - // The destination IP address or address range to inspect for, in CIDR notation. To - // match with any address, specify ANY. + // The destination IP address or address range to inspect for, in CIDR notation. + // To match with any address, specify ANY . Destination *string - // The destination port to inspect for. You can specify an individual port, such as - // 1994. You also can specify a port range, such as 1990:1994. To match with any - // port, specify ANY. + // The destination port to inspect for. You can specify an individual port, such + // as 1994 . You also can specify a port range, such as 1990:1994 . To match with + // any port, specify ANY . DestinationPort *string - // The direction of traffic flow to inspect. If set to ANY, the inspection matches + // The direction of traffic flow to inspect. If set to ANY , the inspection matches // bidirectional traffic, both from the source to the destination and from the - // destination to the source. If set to FORWARD, the inspection only matches + // destination to the source. If set to FORWARD , the inspection only matches // traffic going from the source to the destination. Direction *string - // The protocol to inspect for. To inspector for all protocols, use IP. + // The protocol to inspect for. To inspector for all protocols, use IP . Protocol *string // The source IP address or address range to inspect for, in CIDR notation. To - // match with any address, specify ANY. + // match with any address, specify ANY . Source *string - // The source port to inspect for. You can specify an individual port, such as - // 1994. You also can specify a port range, such as 1990:1994. To match with any - // port, specify ANY. + // The source port to inspect for. You can specify an individual port, such as 1994 + // . You also can specify a port range, such as 1990:1994 . To match with any port, + // specify ANY . SourcePort *string noSmithyDocumentSerde @@ -13332,8 +12841,8 @@ type RuleGroupSourceStatefulRulesOptionsDetails struct { type RuleGroupSourceStatelessRuleDefinition struct { // The actions to take on a packet that matches one of the stateless rule - // definition's match attributes. You must specify a standard action (aws:pass, - // aws:drop, or aws:forward_to_sfe). You can then add custom actions. + // definition's match attributes. You must specify a standard action ( aws:pass , + // aws:drop , or aws:forward_to_sfe ). You can then add custom actions. Actions []string // The criteria for Network Firewall to use to inspect an individual packet in a @@ -13418,8 +12927,8 @@ type RuleGroupSourceStatelessRuleMatchAttributesTcpFlags struct { // must not be set. Flags []string - // The set of flags to consider in the inspection. If not specified, then all flags - // are inspected. + // The set of flags to consider in the inspection. If not specified, then all + // flags are inspected. Masks []string noSmithyDocumentSerde @@ -13480,8 +12989,8 @@ type RuleGroupVariablesPortSetsDetails struct { noSmithyDocumentSerde } -// A security control in Security Hub describes a security best practice related to -// a specific resource. +// A security control in Security Hub describes a security best practice related +// to a specific resource. type SecurityControl struct { // The description of a security control across standards. This typically @@ -13499,7 +13008,7 @@ type SecurityControl struct { RemediationUrl *string // The Amazon Resource Name (ARN) for a security control across standards, such as - // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This + // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1 . This // parameter doesn't mention a specific standard. // // This member is required. @@ -13512,18 +13021,16 @@ type SecurityControl struct { // This member is required. SecurityControlId *string - // The status of a security control based on the compliance status of its findings. - // For more information about how control status is determined, see Determining the - // overall status of a control from its findings - // (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html) + // The status of a security control based on the compliance status of its + // findings. For more information about how control status is determined, see + // Determining the overall status of a control from its findings (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html) // in the Security Hub User Guide. // // This member is required. SecurityControlStatus ControlStatus // The severity of a security control. For more information about how Security Hub - // determines control severity, see Assigning severity to control findings - // (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity) + // determines control severity, see Assigning severity to control findings (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity) // in the Security Hub User Guide. // // This member is required. @@ -13537,9 +13044,9 @@ type SecurityControl struct { noSmithyDocumentSerde } -// Provides metadata for a security control, including its unique standard-agnostic -// identifier, title, description, severity, availability in Amazon Web Services -// Regions, and a link to remediation steps. +// Provides metadata for a security control, including its unique +// standard-agnostic identifier, title, description, severity, availability in +// Amazon Web Services Regions, and a link to remediation steps. type SecurityControlDefinition struct { // Specifies whether a security control is available in the current Amazon Web @@ -13564,8 +13071,8 @@ type SecurityControlDefinition struct { // The unique identifier of a security control across standards. Values for this // field typically consist of an Amazon Web Service name and a number (for example, - // APIGateway.3). This parameter differs from SecurityControlArn, which is a unique - // Amazon Resource Name (ARN) assigned to a control. The ARN references the + // APIGateway.3). This parameter differs from SecurityControlArn , which is a + // unique Amazon Resource Name (ARN) assigned to a control. The ARN references the // security control ID (for example, // arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3). // @@ -13573,8 +13080,7 @@ type SecurityControlDefinition struct { SecurityControlId *string // The severity of a security control. For more information about how Security Hub - // determines control severity, see Assigning severity to control findings - // (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity) + // determines control severity, see Assigning severity to control findings (https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity) // in the Security Hub User Guide. // // This member is required. @@ -13624,66 +13130,43 @@ type SensitiveDataResult struct { // The severity of the finding. The finding provider can provide the initial // severity. The finding provider can only update the severity if it hasn't been -// updated using BatchUpdateFindings. The finding must have either Label or +// updated using BatchUpdateFindings . The finding must have either Label or // Normalized populated. If only one of these attributes is populated, then // Security Hub automatically populates the other one. If neither attribute is // populated, then the finding is invalid. Label is the preferred attribute. type Severity struct { // The severity value of the finding. The allowed values are the following. - // - // * - // INFORMATIONAL - No issue was found. - // - // * LOW - The issue does not require action - // on its own. - // - // * MEDIUM - The issue must be addressed but not urgently. - // - // * HIGH - - // The issue must be addressed as a priority. - // - // * CRITICAL - The issue must be - // remediated immediately to avoid it escalating. - // - // If you provide Normalized and do - // not provide Label, then Label is set automatically as follows. - // - // * 0 - - // INFORMATIONAL - // - // * 1–39 - LOW - // - // * 40–69 - MEDIUM - // - // * 70–89 - HIGH - // - // * 90–100 - - // CRITICAL + // - INFORMATIONAL - No issue was found. + // - LOW - The issue does not require action on its own. + // - MEDIUM - The issue must be addressed but not urgently. + // - HIGH - The issue must be addressed as a priority. + // - CRITICAL - The issue must be remediated immediately to avoid it escalating. + // If you provide Normalized and do not provide Label , then Label is set + // automatically as follows. + // - 0 - INFORMATIONAL + // - 1–39 - LOW + // - 40–69 - MEDIUM + // - 70–89 - HIGH + // - 90–100 - CRITICAL Label SeverityLabel // Deprecated. The normalized severity of a finding. This attribute is being - // deprecated. Instead of providing Normalized, provide Label. If you provide Label - // and do not provide Normalized, then Normalized is set automatically as + // deprecated. Instead of providing Normalized , provide Label . If you provide + // Label and do not provide Normalized , then Normalized is set automatically as // follows. - // - // * INFORMATIONAL - 0 - // - // * LOW - 1 - // - // * MEDIUM - 40 - // - // * HIGH - 70 - // - // * CRITICAL - // - 90 + // - INFORMATIONAL - 0 + // - LOW - 1 + // - MEDIUM - 40 + // - HIGH - 70 + // - CRITICAL - 90 Normalized int32 // The native severity from the finding product that generated the finding. Original *string - // Deprecated. This attribute is being deprecated. Instead of providing Product, - // provide Original. The native severity as defined by the Amazon Web Services + // Deprecated. This attribute is being deprecated. Instead of providing Product , + // provide Original . The native severity as defined by the Amazon Web Services // service or integrated partner product that generated the finding. Product float64 @@ -13694,36 +13177,21 @@ type Severity struct { type SeverityUpdate struct { // The severity value of the finding. The allowed values are the following. - // - // * - // INFORMATIONAL - No issue was found. - // - // * LOW - The issue does not require action - // on its own. - // - // * MEDIUM - The issue must be addressed but not urgently. - // - // * HIGH - - // The issue must be addressed as a priority. - // - // * CRITICAL - The issue must be - // remediated immediately to avoid it escalating. + // - INFORMATIONAL - No issue was found. + // - LOW - The issue does not require action on its own. + // - MEDIUM - The issue must be addressed but not urgently. + // - HIGH - The issue must be addressed as a priority. + // - CRITICAL - The issue must be remediated immediately to avoid it escalating. Label SeverityLabel // The normalized severity for the finding. This attribute is to be deprecated in - // favor of Label. If you provide Normalized and do not provide Label, Label is set - // automatically as follows. - // - // * 0 - INFORMATIONAL - // - // * 1–39 - LOW - // - // * 40–69 - - // MEDIUM - // - // * 70–89 - HIGH - // - // * 90–100 - CRITICAL + // favor of Label . If you provide Normalized and do not provide Label , Label is + // set automatically as follows. + // - 0 - INFORMATIONAL + // - 1–39 - LOW + // - 40–69 - MEDIUM + // - 70–89 - HIGH + // - 90–100 - CRITICAL Normalized int32 // The native severity as defined by the Amazon Web Services service or integrated @@ -13796,7 +13264,7 @@ type Standard struct { // the console, if a standard is enabled by default, the check box for that // standard is selected by default. When Security Hub is enabled using the // EnableSecurityHub API operation, the standard is enabled by default unless - // EnableDefaultStandards is set to false. + // EnableDefaultStandards is set to false . EnabledByDefault bool // The name of the standard. @@ -13863,7 +13331,7 @@ type StandardsControlAssociationDetail struct { AssociationStatus AssociationStatus // The ARN of a security control across standards, such as - // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This + // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1 . This // parameter doesn't mention a specific standard. // // This member is required. @@ -13886,8 +13354,7 @@ type StandardsControlAssociationDetail struct { RelatedRequirements []string // Provides the input parameter that Security Hub uses to call the - // UpdateStandardsControl - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html) + // UpdateStandardsControl (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html) // API. This API can be used to enable or disable a control in a specified // standard. StandardsControlArns []string @@ -13900,8 +13367,8 @@ type StandardsControlAssociationDetail struct { // The title of a control. This field may reference a specific standard. StandardsControlTitle *string - // The time at which the enablement status of the control in the specified standard - // was last updated. + // The time at which the enablement status of the control in the specified + // standard was last updated. UpdatedAt *time.Time // The reason for updating the enablement status of a control in a specified @@ -13912,13 +13379,13 @@ type StandardsControlAssociationDetail struct { } // An array with one or more objects that includes a security control (identified -// with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the -// Amazon Resource Name (ARN) of a standard. The security control ID or ARN is the -// same across standards. +// with SecurityControlId , SecurityControlArn , or a mix of both parameters) and +// the Amazon Resource Name (ARN) of a standard. The security control ID or ARN is +// the same across standards. type StandardsControlAssociationId struct { - // The unique identifier (identified with SecurityControlId, SecurityControlArn, or - // a mix of both parameters) of a security control across standards. + // The unique identifier (identified with SecurityControlId , SecurityControlArn , + // or a mix of both parameters) of a security control across standards. // // This member is required. SecurityControlId *string @@ -13941,7 +13408,7 @@ type StandardsControlAssociationSummary struct { AssociationStatus AssociationStatus // The ARN of a control, such as - // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This + // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1 . This // parameter doesn't mention a specific standard. // // This member is required. @@ -14014,7 +13481,7 @@ type StandardsControlAssociationUpdate struct { type StandardsManagedBy struct { // An identifier for the company that manages a specific security standard. For - // existing standards, the value is equal to Amazon Web Services. + // existing standards, the value is equal to Amazon Web Services . Company *string // An identifier for the product that manages a specific security standard. For @@ -14051,20 +13518,12 @@ type StandardsSubscription struct { StandardsInput map[string]string // The status of the standard subscription. The status values are as follows: - // - // * - // PENDING - Standard is in the process of being enabled. - // - // * READY - Standard is - // enabled. - // - // * INCOMPLETE - Standard could not be enabled completely. Some controls - // may not be available. - // - // * DELETING - Standard is in the process of being - // disabled. - // - // * FAILED - Standard could not be disabled. + // - PENDING - Standard is in the process of being enabled. + // - READY - Standard is enabled. + // - INCOMPLETE - Standard could not be enabled completely. Some controls may not + // be available. + // - DELETING - Standard is in the process of being disabled. + // - FAILED - Standard could not be disabled. // // This member is required. StandardsStatus StandardsStatus @@ -14123,12 +13582,11 @@ type StatelessCustomPublishMetricActionDimension struct { noSmithyDocumentSerde } -// Provides additional context for the value of Compliance.Status. +// Provides additional context for the value of Compliance.Status . type StatusReason struct { // A code that represents a reason for the control status. For the list of status - // reason codes and their meanings, see Standards-related information in the ASFF - // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff) + // reason codes and their meanings, see Standards-related information in the ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff) // in the Security Hub User Guide. // // This member is required. @@ -14146,60 +13604,44 @@ type StringFilter struct { // The condition to apply to a string value when querying for findings. To search // for values that contain the filter criteria value, use one of the following // comparison operators: - // - // * To search for values that exactly match the filter - // value, use EQUALS. For example, the filter ResourceType EQUALS - // AwsEc2SecurityGroup only matches findings that have a resource type of - // AwsEc2SecurityGroup. - // - // * To search for values that start with the filter value, - // use PREFIX. For example, the filter ResourceType PREFIX AwsIam matches findings - // that have a resource type that starts with AwsIam. Findings with a resource type - // of AwsIamPolicy, AwsIamRole, or AwsIamUser would all match. - // - // EQUALS and PREFIX - // filters on the same field are joined by OR. A finding matches if it matches any - // one of those filters. To search for values that do not contain the filter - // criteria value, use one of the following comparison operators: - // - // * To search for - // values that do not exactly match the filter value, use NOT_EQUALS. For example, - // the filter ResourceType NOT_EQUALS AwsIamPolicy matches findings that have a - // resource type other than AwsIamPolicy. - // - // * To search for values that do not start - // with the filter value, use PREFIX_NOT_EQUALS. For example, the filter - // ResourceType PREFIX_NOT_EQUALS AwsIam matches findings that have a resource type - // that does not start with AwsIam. Findings with a resource type of AwsIamPolicy, - // AwsIamRole, or AwsIamUser would all be excluded from the results. - // - // NOT_EQUALS - // and PREFIX_NOT_EQUALS filters on the same field are joined by AND. A finding - // matches only if it matches all of those filters. For filters on the same field, - // you cannot provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS - // filter. Combining filters in this way always returns an error, even if the - // provided filter values would return valid results. You can combine PREFIX - // filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. + // - To search for values that exactly match the filter value, use EQUALS . For + // example, the filter ResourceType EQUALS AwsEc2SecurityGroup only matches + // findings that have a resource type of AwsEc2SecurityGroup . + // - To search for values that start with the filter value, use PREFIX . For + // example, the filter ResourceType PREFIX AwsIam matches findings that have a + // resource type that starts with AwsIam . Findings with a resource type of + // AwsIamPolicy , AwsIamRole , or AwsIamUser would all match. + // EQUALS and PREFIX filters on the same field are joined by OR . A finding matches + // if it matches any one of those filters. To search for values that do not contain + // the filter criteria value, use one of the following comparison operators: + // - To search for values that do not exactly match the filter value, use + // NOT_EQUALS . For example, the filter ResourceType NOT_EQUALS AwsIamPolicy + // matches findings that have a resource type other than AwsIamPolicy . + // - To search for values that do not start with the filter value, use + // PREFIX_NOT_EQUALS . For example, the filter ResourceType PREFIX_NOT_EQUALS + // AwsIam matches findings that have a resource type that does not start with + // AwsIam . Findings with a resource type of AwsIamPolicy , AwsIamRole , or + // AwsIamUser would all be excluded from the results. + // NOT_EQUALS and PREFIX_NOT_EQUALS filters on the same field are joined by AND . A + // finding matches only if it matches all of those filters. For filters on the same + // field, you cannot provide both an EQUALS filter and a NOT_EQUALS or + // PREFIX_NOT_EQUALS filter. Combining filters in this way always returns an error, + // even if the provided filter values would return valid results. You can combine + // PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. // Security Hub first processes the PREFIX filters, then the NOT_EQUALS or // PREFIX_NOT_EQUALS filters. For example, for the following filter, Security Hub // first identifies findings that have resource types that start with either AwsIAM - // or AwsEc2. It then excludes findings that have a resource type of AwsIamPolicy - // and findings that have a resource type of AwsEc2NetworkInterface. - // - // * - // ResourceType PREFIX AwsIam - // - // * ResourceType PREFIX AwsEc2 - // - // * ResourceType - // NOT_EQUALS AwsIamPolicy - // - // * ResourceType NOT_EQUALS AwsEc2NetworkInterface + // or AwsEc2 . It then excludes findings that have a resource type of AwsIamPolicy + // and findings that have a resource type of AwsEc2NetworkInterface . + // - ResourceType PREFIX AwsIam + // - ResourceType PREFIX AwsEc2 + // - ResourceType NOT_EQUALS AwsIamPolicy + // - ResourceType NOT_EQUALS AwsEc2NetworkInterface Comparison StringFilterComparison // The string filter value. Filter values are case sensitive. For example, the - // product name for control-based findings is Security Hub. If you provide security - // hub as the filter text, then there is no match. + // product name for control-based findings is Security Hub . If you provide + // security hub as the filter text, then there is no match. Value *string noSmithyDocumentSerde @@ -14232,9 +13674,9 @@ type ThreatIntelIndicator struct { // Indicates when the most recent instance of a threat intelligence indicator was // observed. Uses the date-time format specified in RFC 3339 section 5.6, Internet - // Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value - // cannot contain spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) . The value + // cannot contain spaces, and date and time should be separated by T . For example, + // 2020-03-22T13:22:13.933Z . LastObservedAt *string // The source of the threat intelligence indicator. @@ -14262,8 +13704,8 @@ type UnprocessedSecurityControl struct { // This member is required. ErrorCode UnprocessedErrorCode - // The control (identified with SecurityControlId, SecurityControlArn, or a mix of - // both parameters) for which a response couldn't be returned. + // The control (identified with SecurityControlId , SecurityControlArn , or a mix + // of both parameters) for which a response couldn't be returned. // // This member is required. SecurityControlId *string @@ -14275,9 +13717,8 @@ type UnprocessedSecurityControl struct { } // Provides details about which control's enablement status couldn't be retrieved -// in a specified standard when calling BatchUpdateStandardsControlAssociations -// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html). -// This parameter also provides details about why the request was unprocessed. +// in a specified standard when calling BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) +// . This parameter also provides details about why the request was unprocessed. type UnprocessedStandardsControlAssociation struct { // The error code for the unprocessed standard and control association. @@ -14286,11 +13727,11 @@ type UnprocessedStandardsControlAssociation struct { ErrorCode UnprocessedErrorCode // An array with one or more objects that includes a security control (identified - // with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the - // Amazon Resource Name (ARN) of a standard. This parameter shows the specific + // with SecurityControlId , SecurityControlArn , or a mix of both parameters) and + // the Amazon Resource Name (ARN) of a standard. This parameter shows the specific // controls for which the enablement status couldn't be retrieved in specified - // standards when calling BatchUpdateStandardsControlAssociations - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html). + // standards when calling BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) + // . // // This member is required. StandardsControlAssociationId *StandardsControlAssociationId @@ -14301,9 +13742,8 @@ type UnprocessedStandardsControlAssociation struct { noSmithyDocumentSerde } -// Provides details about which control's enablement status could not be updated in -// a specified standard when calling the BatchUpdateStandardsControlAssociations -// (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) +// Provides details about which control's enablement status could not be updated +// in a specified standard when calling the BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) // API. This parameter also provides details about why the request was unprocessed. type UnprocessedStandardsControlAssociationUpdate struct { @@ -14314,8 +13754,8 @@ type UnprocessedStandardsControlAssociationUpdate struct { ErrorCode UnprocessedErrorCode // An array of control and standard associations for which an update failed when - // calling BatchUpdateStandardsControlAssociations - // (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html). + // calling BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) + // . // // This member is required. StandardsControlAssociationUpdate *StandardsControlAssociationUpdate @@ -14388,18 +13828,13 @@ type Vulnerability struct { Cvss []Cvss // Specifies if all vulnerable packages in a finding have a value for - // FixedInVersion and Remediation. This field is evaluated for each vulnerability + // FixedInVersion and Remediation . This field is evaluated for each vulnerability // Id based on the number of vulnerable packages that have a value for both - // FixedInVersion and Remediation. Valid values are as follows: - // - // * YES if all - // vulnerable packages have a value for both FixedInVersion and Remediation - // - // * NO - // if no vulnerable packages have a value for FixedInVersion and Remediation - // - // * - // PARTIAL otherwise + // FixedInVersion and Remediation . Valid values are as follows: + // - YES if all vulnerable packages have a value for both FixedInVersion and + // Remediation + // - NO if no vulnerable packages have a value for FixedInVersion and Remediation + // - PARTIAL otherwise FixAvailable VulnerabilityFixAvailable // A list of URLs that provide additional information about the vulnerability. @@ -14428,42 +13863,36 @@ type VulnerabilityVendor struct { // The URL of the vulnerability advisory. Url *string - // Indicates when the vulnerability advisory was created. Uses the date-time format - // specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // Indicates when the vulnerability advisory was created. Uses the date-time + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . VendorCreatedAt *string // The severity that the vendor assigned to the vulnerability. VendorSeverity *string // Indicates when the vulnerability advisory was last updated. Uses the date-time - // format specified in RFC 3339 section 5.6, Internet Date/Time Format - // (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain - // spaces, and date and time should be separated by T. For example, - // 2020-03-22T13:22:13.933Z. + // format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6) + // . The value cannot contain spaces, and date and time should be separated by T . + // For example, 2020-03-22T13:22:13.933Z . VendorUpdatedAt *string noSmithyDocumentSerde } -// Details about the action that CloudFront or WAF takes when a web request matches -// the conditions in the rule. +// Details about the action that CloudFront or WAF takes when a web request +// matches the conditions in the rule. type WafAction struct { // Specifies how you want WAF to respond to requests that match the settings in a // rule. Valid settings include the following: - // - // * ALLOW - WAF allows requests - // - // * - // BLOCK - WAF blocks requests - // - // * COUNT - WAF increments a counter of the requests - // that match all of the conditions in the rule. WAF then continues to inspect the - // web request based on the remaining rules in the web ACL. You can't specify COUNT - // for the default action for a web ACL. + // - ALLOW - WAF allows requests + // - BLOCK - WAF blocks requests + // - COUNT - WAF increments a counter of the requests that match all of the + // conditions in the rule. WAF then continues to inspect the web request based on + // the remaining rules in the web ACL. You can't specify COUNT for the default + // action for a web ACL. Type *string noSmithyDocumentSerde @@ -14481,8 +13910,8 @@ type WafExcludedRule struct { // Details about an override action for a rule. type WafOverrideAction struct { - // COUNT overrides the action specified by the individual rule within a RuleGroup . - // If set to NONE, the rule's action takes place. + // COUNT overrides the action specified by the individual rule within a RuleGroup + // . If set to NONE , the rule's action takes place. Type *string noSmithyDocumentSerde @@ -14496,27 +13925,19 @@ type Workflow struct { // findings. For example, setting the workflow status to SUPPRESSED or RESOLVED // does not prevent a new finding for the same issue. The allowed values are the // following. - // - // * NEW - The initial state of a finding, before it is reviewed. - // Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in - // the following cases: - // - // * RecordState changes from ARCHIVED to ACTIVE. - // - // * - // ComplianceStatus changes from PASSED to either WARNING, FAILED, or - // NOT_AVAILABLE. - // - // * NOTIFIED - Indicates that you notified the resource owner - // about the security issue. Used when the initial reviewer is not the resource - // owner, and needs intervention from the resource owner. - // - // * SUPPRESSED - Indicates - // that you reviewed the finding and do not believe that any action is needed. The - // finding is no longer updated. - // - // * RESOLVED - The finding was reviewed and - // remediated and is now considered resolved. + // - NEW - The initial state of a finding, before it is reviewed. Security Hub + // also resets the workflow status from NOTIFIED or RESOLVED to NEW in the + // following cases: + // - RecordState changes from ARCHIVED to ACTIVE . + // - ComplianceStatus changes from PASSED to either WARNING , FAILED , or + // NOT_AVAILABLE . + // - NOTIFIED - Indicates that you notified the resource owner about the security + // issue. Used when the initial reviewer is not the resource owner, and needs + // intervention from the resource owner. + // - SUPPRESSED - Indicates that you reviewed the finding and do not believe that + // any action is needed. The finding is no longer updated. + // - RESOLVED - The finding was reviewed and remediated and is now considered + // resolved. Status WorkflowStatus noSmithyDocumentSerde @@ -14530,27 +13951,19 @@ type WorkflowUpdate struct { // findings. For example, setting the workflow status to SUPPRESSED or RESOLVED // does not prevent a new finding for the same issue. The allowed values are the // following. - // - // * NEW - The initial state of a finding, before it is reviewed. - // Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the - // following cases: - // - // * The record state changes from ARCHIVED to ACTIVE. - // - // * The - // compliance status changes from PASSED to either WARNING, FAILED, or - // NOT_AVAILABLE. - // - // * NOTIFIED - Indicates that you notified the resource owner - // about the security issue. Used when the initial reviewer is not the resource - // owner, and needs intervention from the resource owner. - // - // * RESOLVED - The finding - // was reviewed and remediated and is now considered resolved. - // - // * SUPPRESSED - - // Indicates that you reviewed the finding and do not believe that any action is - // needed. The finding is no longer updated. + // - NEW - The initial state of a finding, before it is reviewed. Security Hub + // also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following + // cases: + // - The record state changes from ARCHIVED to ACTIVE . + // - The compliance status changes from PASSED to either WARNING , FAILED , or + // NOT_AVAILABLE . + // - NOTIFIED - Indicates that you notified the resource owner about the security + // issue. Used when the initial reviewer is not the resource owner, and needs + // intervention from the resource owner. + // - RESOLVED - The finding was reviewed and remediated and is now considered + // resolved. + // - SUPPRESSED - Indicates that you reviewed the finding and do not believe that + // any action is needed. The finding is no longer updated. Status WorkflowStatus noSmithyDocumentSerde diff --git a/service/securitylake/api_client.go b/service/securitylake/api_client.go index f888d7efedc..772ba66a3d2 100644 --- a/service/securitylake/api_client.go +++ b/service/securitylake/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/securitylake/api_op_CreateAwsLogSource.go b/service/securitylake/api_op_CreateAwsLogSource.go index 69a71767b30..1f9382b58d8 100644 --- a/service/securitylake/api_op_CreateAwsLogSource.go +++ b/service/securitylake/api_op_CreateAwsLogSource.go @@ -24,8 +24,8 @@ import ( // member accounts for all sources. Similarly, when you do not specify Regions, // Security Lake is enabled for all the Regions where Security Lake is available as // a service. You can use this API only to enable natively supported Amazon Web -// Services as a source. Use CreateCustomLogSource to enable data collection from a -// custom source. +// Services as a source. Use CreateCustomLogSource to enable data collection from +// a custom source. func (c *Client) CreateAwsLogSource(ctx context.Context, params *CreateAwsLogSourceInput, optFns ...func(*Options)) (*CreateAwsLogSourceOutput, error) { if params == nil { params = &CreateAwsLogSourceInput{} diff --git a/service/securitylake/api_op_CreateCustomLogSource.go b/service/securitylake/api_op_CreateCustomLogSource.go index d09d777dad0..bc44d40f53a 100644 --- a/service/securitylake/api_op_CreateCustomLogSource.go +++ b/service/securitylake/api_op_CreateCustomLogSource.go @@ -49,18 +49,14 @@ type CreateCustomLogSourceInput struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // to be used by the Glue crawler. The recommended IAM policies are: - // - // * The managed - // policy AWSGlueServiceRole - // - // * A custom policy granting access to your Amazon S3 - // Data Lake + // - The managed policy AWSGlueServiceRole + // - A custom policy granting access to your Amazon S3 Data Lake // // This member is required. GlueInvocationRoleArn *string - // The Amazon Web Services account ID of the custom source that will write logs and - // events into the Amazon S3 Data Lake. + // The Amazon Web Services account ID of the custom source that will write logs + // and events into the Amazon S3 Data Lake. // // This member is required. LogProviderAccountId *string @@ -81,7 +77,7 @@ type CreateCustomLogSourceOutput struct { GlueCrawlerName *string // The Glue database where results are written, such as: - // arn:aws:daylight:us-east-1::database/sometable/*. + // arn:aws:daylight:us-east-1::database/sometable/* . // // This member is required. GlueDatabaseName *string diff --git a/service/securitylake/api_op_CreateDatalake.go b/service/securitylake/api_op_CreateDatalake.go index e1ccabe1509..fe7f60c97d7 100644 --- a/service/securitylake/api_op_CreateDatalake.go +++ b/service/securitylake/api_op_CreateDatalake.go @@ -27,8 +27,8 @@ import ( // also enables all the existing settings and resources that it stores or maintains // for your Amazon Web Services account in the current Region, including security // log and event data. For more information, see the Amazon Security Lake User -// Guide -// (https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html). +// Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html) +// . func (c *Client) CreateDatalake(ctx context.Context, params *CreateDatalakeInput, optFns ...func(*Options)) (*CreateDatalakeOutput, error) { if params == nil { params = &CreateDatalakeInput{} diff --git a/service/securitylake/api_op_CreateSubscriber.go b/service/securitylake/api_op_CreateSubscriber.go index 9eda5dac48c..4eb167c8baa 100644 --- a/service/securitylake/api_op_CreateSubscriber.go +++ b/service/securitylake/api_op_CreateSubscriber.go @@ -81,9 +81,9 @@ type CreateSubscriberOutput struct { ResourceShareName *string // The Amazon Resource Name (ARN) created by you to provide to the subscriber. For - // more information about ARNs and how to use them in policies, see Amazon Security - // Lake User Guide - // (https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html). + // more information about ARNs and how to use them in policies, see Amazon + // Security Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html) + // . RoleArn *string // The ARN for the Amazon S3 bucket. diff --git a/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go b/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go index d5e09477f8d..0dce15d399a 100644 --- a/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go +++ b/service/securitylake/api_op_CreateSubscriptionNotificationConfiguration.go @@ -48,12 +48,10 @@ type CreateSubscriptionNotificationConfigurationInput struct { // The HTTPS method used for the notification subscription. HttpsMethod types.HttpsMethod - // The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that - // you created. For more information about ARNs and how to use them in policies, - // see Managing data access - // (https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html) - // and Amazon Web Services Managed Policies - // (https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html) + // The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role + // that you created. For more information about ARNs and how to use them in + // policies, see Managing data access (https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html) + // and Amazon Web Services Managed Policies (https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html) // in the Amazon Security Lake User Guide. RoleArn *string diff --git a/service/securitylake/api_op_DeleteDatalake.go b/service/securitylake/api_op_DeleteDatalake.go index e8f92fe7e75..afdc718825c 100644 --- a/service/securitylake/api_op_DeleteDatalake.go +++ b/service/securitylake/api_op_DeleteDatalake.go @@ -19,8 +19,8 @@ import ( // account in the current Region, including security log and event data. The // DeleteDatalake operation does not delete the Amazon S3 bucket, which is owned by // your Amazon Web Services account. For more information, see the Amazon Security -// Lake User Guide -// (https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html). +// Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html) +// . func (c *Client) DeleteDatalake(ctx context.Context, params *DeleteDatalakeInput, optFns ...func(*Options)) (*DeleteDatalakeOutput, error) { if params == nil { params = &DeleteDatalakeInput{} diff --git a/service/securitylake/api_op_DeleteDatalakeAutoEnable.go b/service/securitylake/api_op_DeleteDatalakeAutoEnable.go index 747a9bffe54..64396a058d5 100644 --- a/service/securitylake/api_op_DeleteDatalakeAutoEnable.go +++ b/service/securitylake/api_op_DeleteDatalakeAutoEnable.go @@ -34,8 +34,8 @@ func (c *Client) DeleteDatalakeAutoEnable(ctx context.Context, params *DeleteDat type DeleteDatalakeAutoEnableInput struct { - // Remove automatic enablement of configuration settings for new member accounts in - // Security Lake. + // Remove automatic enablement of configuration settings for new member accounts + // in Security Lake. // // This member is required. RemoveFromConfigurationForNewAccounts []types.AutoEnableNewRegionConfiguration diff --git a/service/securitylake/api_op_GetDatalake.go b/service/securitylake/api_op_GetDatalake.go index 83b9bb3aa4d..75eb1903f54 100644 --- a/service/securitylake/api_op_GetDatalake.go +++ b/service/securitylake/api_op_GetDatalake.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the Amazon Security Lake configuration object for the specified Amazon -// Web Services account ID. You can use the GetDatalake API to know whether +// Retrieves the Amazon Security Lake configuration object for the specified +// Amazon Web Services account ID. You can use the GetDatalake API to know whether // Security Lake is enabled for the current Region. This API does not take input // parameters. func (c *Client) GetDatalake(ctx context.Context, params *GetDatalakeInput, optFns ...func(*Options)) (*GetDatalakeOutput, error) { diff --git a/service/securitylake/api_op_GetDatalakeAutoEnable.go b/service/securitylake/api_op_GetDatalakeAutoEnable.go index 195227ab256..46e465f057c 100644 --- a/service/securitylake/api_op_GetDatalakeAutoEnable.go +++ b/service/securitylake/api_op_GetDatalakeAutoEnable.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the configuration that will be automatically set up for accounts added -// to the organization after the organization has onboarded to Amazon Security -// Lake. This API does not take input parameters. +// Retrieves the configuration that will be automatically set up for accounts +// added to the organization after the organization has onboarded to Amazon +// Security Lake. This API does not take input parameters. func (c *Client) GetDatalakeAutoEnable(ctx context.Context, params *GetDatalakeAutoEnableInput, optFns ...func(*Options)) (*GetDatalakeAutoEnableOutput, error) { if params == nil { params = &GetDatalakeAutoEnableInput{} diff --git a/service/securitylake/api_op_ListDatalakeExceptions.go b/service/securitylake/api_op_ListDatalakeExceptions.go index da162e781da..a0c91566efe 100644 --- a/service/securitylake/api_op_ListDatalakeExceptions.go +++ b/service/securitylake/api_op_ListDatalakeExceptions.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Amazon Security Lake exceptions that you can use to find the source of -// problems and fix them. +// Lists the Amazon Security Lake exceptions that you can use to find the source +// of problems and fix them. func (c *Client) ListDatalakeExceptions(ctx context.Context, params *ListDatalakeExceptionsInput, optFns ...func(*Options)) (*ListDatalakeExceptionsOutput, error) { if params == nil { params = &ListDatalakeExceptionsInput{} diff --git a/service/securitylake/api_op_UpdateSubscriber.go b/service/securitylake/api_op_UpdateSubscriber.go index 1b63eee1b9a..740109ae749 100644 --- a/service/securitylake/api_op_UpdateSubscriber.go +++ b/service/securitylake/api_op_UpdateSubscriber.go @@ -38,8 +38,8 @@ type UpdateSubscriberInput struct { // The supported Amazon Web Services from which logs and events are collected. For // the list of supported Amazon Web Services, see the Amazon Security Lake User - // Guide - // (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). + // Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html) + // . // // This member is required. SourceTypes []types.SourceType diff --git a/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go b/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go index 71a9f36e537..f3b02c1adda 100644 --- a/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go +++ b/service/securitylake/api_op_UpdateSubscriptionNotificationConfiguration.go @@ -50,11 +50,9 @@ type UpdateSubscriptionNotificationConfigurationInput struct { // The Amazon Resource Name (ARN) specifying the role of the subscriber. For more // information about ARNs and how to use them in policies, see, see the Managing - // data access - // (https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html) - // and Amazon Web Services Managed Policies - // (https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html)in - // the Amazon Security Lake User Guide. + // data access (https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html) + // and Amazon Web Services Managed Policies (https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html) + // in the Amazon Security Lake User Guide. RoleArn *string // The subscription endpoint in Security Lake. diff --git a/service/securitylake/doc.go b/service/securitylake/doc.go index 971352ad980..606bcedd8cd 100644 --- a/service/securitylake/doc.go +++ b/service/securitylake/doc.go @@ -4,33 +4,32 @@ // for Amazon Security Lake. // // Amazon Security Lake is in preview release. Your use of the Security Lake -// preview is subject to Section 2 of the Amazon Web Services Service Terms -// (http://aws.amazon.com/service-terms/)("Betas and Previews"). Amazon Security -// Lake is a fully managed security data lake service. You can use Security Lake to -// automatically centralize security data from cloud, on-premises, and custom -// sources into a data lake that's stored in your Amazon Web Servicesaccount. -// Amazon Web Services Organizations is an account management service that lets you -// consolidate multiple Amazon Web Services accounts into an organization that you -// create and centrally manage. With Organizations, you can create member accounts -// and invite existing accounts to join your organization. Security Lake helps you -// analyze security data for a more complete understanding of your security posture -// across the entire organization. It can also help you improve the protection of -// your workloads, applications, and data. The data lake is backed by Amazon Simple -// Storage Service (Amazon S3) buckets, and you retain ownership over your data. -// Amazon Security Lake integrates with CloudTrail, a service that provides a -// record of actions taken by a user, role, or an Amazon Web Services service in -// Security Lake CloudTrail captures API calls for Security Lake as events. The -// calls captured include calls from the Security Lake console and code calls to -// the Security Lake API operations. If you create a trail, you can enable -// continuous delivery of CloudTrail events to an Amazon S3 bucket, including -// events for Security Lake. If you don't configure a trail, you can still view the -// most recent events in the CloudTrail console in Event history. Using the -// information collected by CloudTrail you can determine the request that was made -// to Security Lake, the IP address from which the request was made, who made the -// request, when it was made, and additional details. To learn more about Security -// Lake information in CloudTrail, see the Amazon Security Lake User Guide -// (https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html). -// Security Lake automates the collection of security-related log and event data +// preview is subject to Section 2 of the Amazon Web Services Service Terms (http://aws.amazon.com/service-terms/) +// ("Betas and Previews"). Amazon Security Lake is a fully managed security data +// lake service. You can use Security Lake to automatically centralize security +// data from cloud, on-premises, and custom sources into a data lake that's stored +// in your Amazon Web Servicesaccount. Amazon Web Services Organizations is an +// account management service that lets you consolidate multiple Amazon Web +// Services accounts into an organization that you create and centrally manage. +// With Organizations, you can create member accounts and invite existing accounts +// to join your organization. Security Lake helps you analyze security data for a +// more complete understanding of your security posture across the entire +// organization. It can also help you improve the protection of your workloads, +// applications, and data. The data lake is backed by Amazon Simple Storage Service +// (Amazon S3) buckets, and you retain ownership over your data. Amazon Security +// Lake integrates with CloudTrail, a service that provides a record of actions +// taken by a user, role, or an Amazon Web Services service in Security Lake +// CloudTrail captures API calls for Security Lake as events. The calls captured +// include calls from the Security Lake console and code calls to the Security Lake +// API operations. If you create a trail, you can enable continuous delivery of +// CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If +// you don't configure a trail, you can still view the most recent events in the +// CloudTrail console in Event history. Using the information collected by +// CloudTrail you can determine the request that was made to Security Lake, the IP +// address from which the request was made, who made the request, when it was made, +// and additional details. To learn more about Security Lake information in +// CloudTrail, see the Amazon Security Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html) +// . Security Lake automates the collection of security-related log and event data // from integrated Amazon Web Services and third-party services. It also helps you // manage the lifecycle of data with customizable retention and replication // settings. Security Lake converts ingested data into Apache Parquet format and a diff --git a/service/securitylake/types/enums.go b/service/securitylake/types/enums.go index 8ef1b3aebbe..67dadae26fa 100644 --- a/service/securitylake/types/enums.go +++ b/service/securitylake/types/enums.go @@ -51,9 +51,9 @@ const ( DimensionMember Dimension = "MEMBER" ) -// Values returns all known values for Dimension. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Dimension. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Dimension) Values() []Dimension { return []Dimension{ "REGION", @@ -237,9 +237,9 @@ const ( SourceStatusPending SourceStatus = "PENDING" ) -// Values returns all known values for SourceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SourceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SourceStatus) Values() []SourceStatus { return []SourceStatus{ "ACTIVE", @@ -261,9 +261,9 @@ const ( StorageClassExpire StorageClass = "EXPIRE" ) -// Values returns all known values for StorageClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StorageClass. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StorageClass) Values() []StorageClass { return []StorageClass{ "STANDARD_IA", @@ -291,9 +291,9 @@ const ( SubscriptionProtocolTypeFirehose SubscriptionProtocolType = "FIREHOSE" ) -// Values returns all known values for SubscriptionProtocolType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SubscriptionProtocolType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionProtocolType) Values() []SubscriptionProtocolType { return []SubscriptionProtocolType{ "HTTP", diff --git a/service/securitylake/types/errors.go b/service/securitylake/types/errors.go index 4f1ee108542..df0f1990539 100644 --- a/service/securitylake/types/errors.go +++ b/service/securitylake/types/errors.go @@ -231,8 +231,8 @@ func (e *EventBridgeException) ErrorCode() string { } func (e *EventBridgeException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Internal service exceptions are sometimes caused by transient issues. Before you -// start troubleshooting, perform the operation again. +// Internal service exceptions are sometimes caused by transient issues. Before +// you start troubleshooting, perform the operation again. type InternalServerException struct { Message *string @@ -260,8 +260,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The request was rejected because a value that's not valid or is out of range was -// supplied for an input parameter. +// The request was rejected because a value that's not valid or is out of range +// was supplied for an input parameter. type InvalidInputException struct { Message *string diff --git a/service/securitylake/types/types.go b/service/securitylake/types/types.go index 6f97341dcac..edf76a274ce 100644 --- a/service/securitylake/types/types.go +++ b/service/securitylake/types/types.go @@ -7,10 +7,10 @@ import ( "time" ) -// Amazon Security Lake collects logs and events from supported Amazon Web Services -// and custom sources. For the list of supported Amazon Web Services, see the -// Amazon Security Lake User Guide -// (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). +// Amazon Security Lake collects logs and events from supported Amazon Web +// Services and custom sources. For the list of supported Amazon Web Services, see +// the Amazon Security Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html) +// . type AccountSources struct { // The ID of the Security Lake account for which logs are collected. @@ -34,8 +34,8 @@ type AccountSources struct { noSmithyDocumentSerde } -// Automatically enable new organization accounts as member accounts from an Amazon -// Security Lake administrator account. +// Automatically enable new organization accounts as member accounts from an +// Amazon Security Lake administrator account. type AutoEnableNewRegionConfiguration struct { // The Amazon Web Services Regions where Security Lake is automatically enabled. @@ -73,8 +73,8 @@ type Failures struct { noSmithyDocumentSerde } -// Response element for actions that make changes, namely create, update, or delete -// actions. +// Response element for actions that make changes, namely create, update, or +// delete actions. type FailuresResponse struct { // List of all failures. @@ -103,9 +103,9 @@ type LakeConfigurationRequest struct { // rollup Region. ReplicationDestinationRegions []Region - // Replication settings for the Amazon S3 buckets. This parameter uses the Identity - // and Access Management (IAM) role you created that is managed by Security Lake, - // to ensure the replication setting is correct. + // Replication settings for the Amazon S3 buckets. This parameter uses the + // Identity and Access Management (IAM) role you created that is managed by + // Security Lake, to ensure the replication setting is correct. ReplicationRoleArn *string // Retention settings for the destination Amazon S3 buckets. @@ -135,9 +135,9 @@ type LakeConfigurationResponse struct { // rollup Region. ReplicationDestinationRegions []Region - // Replication settings for the Amazon S3 buckets. This parameter uses the IAM role - // you created that is managed by Security Lake, to ensure the replication setting - // is correct. + // Replication settings for the Amazon S3 buckets. This parameter uses the IAM + // role you created that is managed by Security Lake, to ensure the replication + // setting is correct. ReplicationRoleArn *string // Retention settings for the destination Amazon S3 buckets. @@ -167,11 +167,11 @@ type LakeConfigurationResponse struct { // failed. type LastUpdateFailure struct { - // The reason code for the failure of the last UpdateDatalake or DeleteDatalake API - // request. + // The reason code for the failure of the last UpdateDatalake or DeleteDatalake + // API request. Code *string - // The reason for the failure of the last UpdateDatalakeor DeleteDatalake API + // The reason for the failure of the last UpdateDatalake or DeleteDatalake API // request. Reason *string @@ -195,8 +195,8 @@ type LogsStatus struct { noSmithyDocumentSerde } -// Protocol used in Amazon Security Lake that dictates how notifications are posted -// at the endpoint. +// Protocol used in Amazon Security Lake that dictates how notifications are +// posted at the endpoint. type ProtocolAndNotificationEndpoint struct { // The account that is subscribed to receive exception notifications. @@ -226,8 +226,8 @@ type RetentionSetting struct { // The supported source types from which logs and events are collected in Amazon // Security Lake. For the list of supported Amazon Web Services, see the Amazon -// Security Lake User Guide -// (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html). +// Security Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html) +// . // // The following types satisfy this interface: // @@ -284,7 +284,7 @@ type SubscriberResource struct { // Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by // the subscriber. Subscribers can consume data by directly querying Lake Formation // tables in your Amazon S3 bucket through services like Amazon Athena. This - // subscription type is defined as LAKEFORMATION. + // subscription type is defined as LAKEFORMATION . AccessTypes []AccessType // The date and time when the subscription was created. @@ -315,7 +315,8 @@ type SubscriberResource struct { SnsArn *string // The subscriber descriptions for a subscriber account. The description for a - // subscriber includes subscriberName, accountID, externalID, and subscriptionId. + // subscriber includes subscriberName , accountID , externalID , and subscriptionId + // . SubscriberDescription *string // The name of your Amazon Security Lake subscriber account. @@ -336,12 +337,12 @@ type SubscriberResource struct { noSmithyDocumentSerde } -// The status of the last UpdateDatalake or DeleteDatalake API request. This is set -// to Completed after the configuration is updated, or removed if deletion of the -// data lake is successful. +// The status of the last UpdateDatalake or DeleteDatalake API request. This is +// set to Completed after the configuration is updated, or removed if deletion of +// the data lake is successful. type UpdateStatus struct { - // The details of the last UpdateDatalakeor DeleteDatalake API request which + // The details of the last UpdateDatalake or DeleteDatalake API request which // failed. LastUpdateFailure *LastUpdateFailure diff --git a/service/serverlessapplicationrepository/api_client.go b/service/serverlessapplicationrepository/api_client.go index b140cde2ee7..6564838883a 100644 --- a/service/serverlessapplicationrepository/api_client.go +++ b/service/serverlessapplicationrepository/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/serverlessapplicationrepository/api_op_CreateApplication.go b/service/serverlessapplicationrepository/api_op_CreateApplication.go index aff05cefb83..5e2323a1a5d 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplication.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplication.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an application, optionally including an AWS SAM file to create the first -// application version in the same call. +// Creates an application, optionally including an AWS SAM file to create the +// first application version in the same call. func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -77,8 +77,7 @@ type CreateApplicationInput struct { // only one of readmeBody and readmeUrl; otherwise, an error results. ReadmeUrl *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for @@ -89,7 +88,7 @@ type CreateApplicationInput struct { // example the URL of a specific GitHub commit. SourceCodeUrl *string - // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). + // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/) . SpdxLicenseId *string // The local raw packaged AWS SAM template file of your application. The file has @@ -134,8 +133,8 @@ type CreateApplicationOutput struct { // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB + // A link to a license file of the app that matches the spdxLicenseID value of + // your application.Maximum size 5 MB LicenseUrl *string // The name of the application.Minimum length=1. Maximum length=140Pattern: @@ -149,8 +148,8 @@ type CreateApplicationOutput struct { // A valid identifier from https://spdx.org/licenses/. SpdxLicenseId *string - // The URL to the public profile of a verified author. This URL is submitted by the - // author. + // The URL to the public profile of a verified author. This URL is submitted by + // the author. VerifiedAuthorUrl *string // Version information about the application. diff --git a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go index 52d09c104be..44a0e6c9b44 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go @@ -74,33 +74,24 @@ type CreateApplicationVersionOutput struct { // acknowledge their capabilities by specifying this parameter.The only valid // values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and // CAPABILITY_AUTO_EXPAND.The following resources require you to specify - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html), - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html), - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // and AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). - // If the application contains IAM resources, you can specify either CAPABILITY_IAM - // or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM.The following resources require you - // to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html), - // AWS::IAM:Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // AWS::ApplicationAutoScaling::ScalingPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html), - // AWS::S3::BucketPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html), - // AWS::SQS::QueuePolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html), - // and AWS::SNS::TopicPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html).Applications - // that contain one or more nested applications require you to specify - // CAPABILITY_AUTO_EXPAND.If your application template contains any of the above - // resources, we recommend that you review all permissions associated with the - // application before deploying. If you don't specify this parameter for an + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // , AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // , AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , and AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // . If the application contains IAM resources, you can specify either + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM + // resources with custom names, you must specify CAPABILITY_NAMED_IAM.The following + // resources require you to specify CAPABILITY_RESOURCE_POLICY: + // AWS::Lambda::Permission (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) + // , AWS::IAM:Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , AWS::ApplicationAutoScaling::ScalingPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) + // , AWS::S3::BucketPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html) + // , AWS::SQS::QueuePolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html) + // , and AWS::SNS::TopicPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html) + // .Applications that contain one or more nested applications require you to + // specify CAPABILITY_AUTO_EXPAND.If your application template contains any of the + // above resources, we recommend that you review all permissions associated with + // the application before deploying. If you don't specify this parameter for an // application that requires capabilities, the call will fail. RequiredCapabilities []types.Capability @@ -108,8 +99,7 @@ type CreateApplicationVersionOutput struct { // the region in which it is being retrieved. ResourcesSupported bool - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for diff --git a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go index 06bdad0928f..04a70050980 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go @@ -35,8 +35,7 @@ type CreateCloudFormationChangeSetInput struct { ApplicationId *string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. // // This member is required. @@ -49,57 +48,44 @@ type CreateCloudFormationChangeSetInput struct { // acknowledge their capabilities by specifying this parameter.The only valid // values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and // CAPABILITY_AUTO_EXPAND.The following resources require you to specify - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html), - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html), - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // and AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). - // If the application contains IAM resources, you can specify either CAPABILITY_IAM - // or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM.The following resources require you - // to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html), - // AWS::IAM:Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // AWS::ApplicationAutoScaling::ScalingPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html), - // AWS::S3::BucketPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html), - // AWS::SQS::QueuePolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html), - // and AWS::SNS:TopicPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html).Applications - // that contain one or more nested applications require you to specify - // CAPABILITY_AUTO_EXPAND.If your application template contains any of the above - // resources, we recommend that you review all permissions associated with the - // application before deploying. If you don't specify this parameter for an + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // , AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // , AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , and AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // . If the application contains IAM resources, you can specify either + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM + // resources with custom names, you must specify CAPABILITY_NAMED_IAM.The following + // resources require you to specify CAPABILITY_RESOURCE_POLICY: + // AWS::Lambda::Permission (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) + // , AWS::IAM:Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , AWS::ApplicationAutoScaling::ScalingPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) + // , AWS::S3::BucketPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html) + // , AWS::SQS::QueuePolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html) + // , and AWS::SNS:TopicPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html) + // .Applications that contain one or more nested applications require you to + // specify CAPABILITY_AUTO_EXPAND.If your application template contains any of the + // above resources, we recommend that you review all permissions associated with + // the application before deploying. If you don't specify this parameter for an // application that requires capabilities, the call will fail. Capabilities []string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. ChangeSetName *string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. ClientToken *string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. Description *string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. NotificationArns []string @@ -107,24 +93,20 @@ type CreateCloudFormationChangeSetInput struct { ParameterOverrides []types.ParameterValue // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. ResourceTypes []string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. RollbackConfiguration *types.RollbackConfiguration - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // This property corresponds to the parameter of the same name for the AWS - // CloudFormation CreateChangeSet - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) + // CloudFormation CreateChangeSet (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet) // API. Tags []types.Tag @@ -144,8 +126,7 @@ type CreateCloudFormationChangeSetOutput struct { // length of 1.Pattern: ARN:[-a-zA-Z0-9:/]* ChangeSetId *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // The unique ID of the stack. diff --git a/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go b/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go index 868ac38e142..b168089abcf 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go @@ -34,8 +34,7 @@ type CreateCloudFormationTemplateInput struct { // This member is required. ApplicationId *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string noSmithyDocumentSerde @@ -52,8 +51,7 @@ type CreateCloudFormationTemplateOutput struct { // The date and time this template expires. Templates expire 1 hour after creation. ExpirationTime *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | diff --git a/service/serverlessapplicationrepository/api_op_GetApplication.go b/service/serverlessapplicationrepository/api_op_GetApplication.go index aa6a738f59c..e0bbf9dfc05 100644 --- a/service/serverlessapplicationrepository/api_op_GetApplication.go +++ b/service/serverlessapplicationrepository/api_op_GetApplication.go @@ -69,8 +69,8 @@ type GetApplicationOutput struct { // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB + // A link to a license file of the app that matches the spdxLicenseID value of + // your application.Maximum size 5 MB LicenseUrl *string // The name of the application.Minimum length=1. Maximum length=140Pattern: @@ -84,8 +84,8 @@ type GetApplicationOutput struct { // A valid identifier from https://spdx.org/licenses/. SpdxLicenseId *string - // The URL to the public profile of a verified author. This URL is submitted by the - // author. + // The URL to the public profile of a verified author. This URL is submitted by + // the author. VerifiedAuthorUrl *string // Version information about the application. diff --git a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go index fbfcbbf58a3..f3e3717d19c 100644 --- a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go @@ -54,8 +54,7 @@ type GetCloudFormationTemplateOutput struct { // The date and time this template expires. Templates expire 1 hour after creation. ExpirationTime *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) SemanticVersion *string // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | diff --git a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go index 485968d73ac..309261aee3f 100644 --- a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go +++ b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the permission policy for an application. For the list of actions supported -// for this operation, see Application Permissions -// (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions) +// Sets the permission policy for an application. For the list of actions +// supported for this operation, see Application Permissions (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions) // . func (c *Client) PutApplicationPolicy(ctx context.Context, params *PutApplicationPolicyInput, optFns ...func(*Options)) (*PutApplicationPolicyOutput, error) { if params == nil { diff --git a/service/serverlessapplicationrepository/api_op_UpdateApplication.go b/service/serverlessapplicationrepository/api_op_UpdateApplication.go index 0fc3bf1f99e..5f1ee538a7c 100644 --- a/service/serverlessapplicationrepository/api_op_UpdateApplication.go +++ b/service/serverlessapplicationrepository/api_op_UpdateApplication.go @@ -89,8 +89,8 @@ type UpdateApplicationOutput struct { // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string - // A link to a license file of the app that matches the spdxLicenseID value of your - // application.Maximum size 5 MB + // A link to a license file of the app that matches the spdxLicenseID value of + // your application.Maximum size 5 MB LicenseUrl *string // The name of the application.Minimum length=1. Maximum length=140Pattern: @@ -104,8 +104,8 @@ type UpdateApplicationOutput struct { // A valid identifier from https://spdx.org/licenses/. SpdxLicenseId *string - // The URL to the public profile of a verified author. This URL is submitted by the - // author. + // The URL to the public profile of a verified author. This URL is submitted by + // the author. VerifiedAuthorUrl *string // Version information about the application. diff --git a/service/serverlessapplicationrepository/doc.go b/service/serverlessapplicationrepository/doc.go index a34f3718a65..9bbf1734f82 100644 --- a/service/serverlessapplicationrepository/doc.go +++ b/service/serverlessapplicationrepository/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package serverlessapplicationrepository provides the API client, operations, and -// parameter types for AWSServerlessApplicationRepository. +// Package serverlessapplicationrepository provides the API client, operations, +// and parameter types for AWSServerlessApplicationRepository. // // The AWS Serverless Application Repository makes it easy for developers and // enterprises to quickly find and deploy serverless applications in the AWS Cloud. @@ -22,11 +22,9 @@ // SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs GitHub // repository.The AWS Serverless Application Repository Developer Guide contains // more information about the two developer experiences available: -// -// * Consuming -// Applications – Browse for applications and view information about them, -// including source code and readme files. Also install, configure, and deploy -// applications of your choosing. Publishing Applications – Configure and upload -// applications to make them available to other developers, and publish new -// versions of applications. +// - Consuming Applications – Browse for applications and view information about +// them, including source code and readme files. Also install, configure, and +// deploy applications of your choosing. Publishing Applications – Configure and +// upload applications to make them available to other developers, and publish new +// versions of applications. package serverlessapplicationrepository diff --git a/service/serverlessapplicationrepository/types/types.go b/service/serverlessapplicationrepository/types/types.go index 88cdf2d256c..401d9ff1a14 100644 --- a/service/serverlessapplicationrepository/types/types.go +++ b/service/serverlessapplicationrepository/types/types.go @@ -26,8 +26,8 @@ type ApplicationDependencySummary struct { type ApplicationPolicyStatement struct { // For the list of actions supported for this operation, see Application - // Permissions - // (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions). + // Permissions (https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions) + // . // // This member is required. Actions []string @@ -37,8 +37,7 @@ type ApplicationPolicyStatement struct { // This member is required. Principals []string - // An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id) + // An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id) // global condition key. PrincipalOrgIDs []string @@ -84,7 +83,7 @@ type ApplicationSummary struct { // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string - // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/). + // A valid identifier from https://spdx.org/licenses/ (https://spdx.org/licenses/) . SpdxLicenseId *string noSmithyDocumentSerde @@ -119,9 +118,9 @@ type ParameterDefinition struct { // only uppercase and lowercase letters and numbers. ConstraintDescription *string - // A value of the appropriate type for the template to use if no value is specified - // when a stack is created. If you define constraints for the parameter, you must - // specify a value that adheres to those constraints. + // A value of the appropriate type for the template to use if no value is + // specified when a stack is created. If you define constraints for the parameter, + // you must specify a value that adheres to those constraints. DefaultValue *string // A string of up to 4,000 characters that describes the parameter. @@ -131,12 +130,12 @@ type ParameterDefinition struct { // to allow for String types. MaxLength int32 - // A numeric value that determines the largest numeric value that you want to allow - // for Number types. + // A numeric value that determines the largest numeric value that you want to + // allow for Number types. MaxValue int32 - // An integer value that determines the smallest number of characters that you want - // to allow for String types. + // An integer value that determines the smallest number of characters that you + // want to allow for String types. MinLength int32 // A numeric value that determines the smallest numeric value that you want to @@ -186,42 +185,36 @@ type ParameterValue struct { noSmithyDocumentSerde } -// This property corresponds to the AWS CloudFormation RollbackConfiguration -// (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) +// This property corresponds to the AWS CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) // Data Type. type RollbackConfiguration struct { // This property corresponds to the content of the same name for the AWS - // CloudFormation RollbackConfiguration - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) + // CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) // Data Type. MonitoringTimeInMinutes int32 // This property corresponds to the content of the same name for the AWS - // CloudFormation RollbackConfiguration - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) + // CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) // Data Type. RollbackTriggers []RollbackTrigger noSmithyDocumentSerde } -// This property corresponds to the AWS CloudFormation RollbackTrigger -// (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) +// This property corresponds to the AWS CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) // Data Type. type RollbackTrigger struct { // This property corresponds to the content of the same name for the AWS - // CloudFormation RollbackTrigger - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) + // CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) // Data Type. // // This member is required. Arn *string // This property corresponds to the content of the same name for the AWS - // CloudFormation RollbackTrigger - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) + // CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) // Data Type. // // This member is required. @@ -230,23 +223,20 @@ type RollbackTrigger struct { noSmithyDocumentSerde } -// This property corresponds to the AWS CloudFormation Tag -// (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) Data -// Type. +// This property corresponds to the AWS CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) +// Data Type. type Tag struct { // This property corresponds to the content of the same name for the AWS - // CloudFormation Tag - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) Data - // Type. + // CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) + // Data Type. // // This member is required. Key *string // This property corresponds to the content of the same name for the AWS - // CloudFormation Tag - // (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) Data - // Type. + // CloudFormation Tag (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag) + // Data Type. // // This member is required. Value *string @@ -279,33 +269,24 @@ type Version struct { // acknowledge their capabilities by specifying this parameter.The only valid // values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and // CAPABILITY_AUTO_EXPAND.The following resources require you to specify - // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html), - // AWS::IAM::InstanceProfile - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html), - // AWS::IAM::Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // and AWS::IAM::Role - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). - // If the application contains IAM resources, you can specify either CAPABILITY_IAM - // or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom - // names, you must specify CAPABILITY_NAMED_IAM.The following resources require you - // to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html), - // AWS::IAM:Policy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html), - // AWS::ApplicationAutoScaling::ScalingPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html), - // AWS::S3::BucketPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html), - // AWS::SQS::QueuePolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html), - // and AWS::SNS::TopicPolicy - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html).Applications - // that contain one or more nested applications require you to specify - // CAPABILITY_AUTO_EXPAND.If your application template contains any of the above - // resources, we recommend that you review all permissions associated with the - // application before deploying. If you don't specify this parameter for an + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) + // , AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) + // , AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , and AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) + // . If the application contains IAM resources, you can specify either + // CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM + // resources with custom names, you must specify CAPABILITY_NAMED_IAM.The following + // resources require you to specify CAPABILITY_RESOURCE_POLICY: + // AWS::Lambda::Permission (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) + // , AWS::IAM:Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html) + // , AWS::ApplicationAutoScaling::ScalingPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) + // , AWS::S3::BucketPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html) + // , AWS::SQS::QueuePolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html) + // , and AWS::SNS::TopicPolicy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html) + // .Applications that contain one or more nested applications require you to + // specify CAPABILITY_AUTO_EXPAND.If your application template contains any of the + // above resources, we recommend that you review all permissions associated with + // the application before deploying. If you don't specify this parameter for an // application that requires capabilities, the call will fail. // // This member is required. @@ -317,8 +298,7 @@ type Version struct { // This member is required. ResourcesSupported bool - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) // // This member is required. SemanticVersion *string @@ -352,8 +332,7 @@ type VersionSummary struct { // This member is required. CreationTime *string - // The semantic version of the application: https://semver.org/ - // (https://semver.org/) + // The semantic version of the application: https://semver.org/ (https://semver.org/) // // This member is required. SemanticVersion *string diff --git a/service/servicecatalog/api_client.go b/service/servicecatalog/api_client.go index 8543019c279..9dcc7dc1827 100644 --- a/service/servicecatalog/api_client.go +++ b/service/servicecatalog/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/servicecatalog/api_op_AcceptPortfolioShare.go b/service/servicecatalog/api_op_AcceptPortfolioShare.go index 970a427fc78..37f30da5a90 100644 --- a/service/servicecatalog/api_op_AcceptPortfolioShare.go +++ b/service/servicecatalog/api_op_AcceptPortfolioShare.go @@ -35,25 +35,17 @@ type AcceptPortfolioShareInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The type of shared portfolios to accept. The default is to accept imported // portfolios. - // - // * AWS_ORGANIZATIONS - Accept portfolios shared by the management - // account of your organization. - // - // * IMPORTED - Accept imported portfolios. - // - // * - // AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) - // - // For - // example, aws servicecatalog accept-portfolio-share --portfolio-id + // - AWS_ORGANIZATIONS - Accept portfolios shared by the management account of + // your organization. + // - IMPORTED - Accept imported portfolios. + // - AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) + // For example, aws servicecatalog accept-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType diff --git a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go index f77dd123f5c..75e8a1e005b 100644 --- a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go @@ -13,7 +13,7 @@ import ( // Associates the specified principal ARN with the specified portfolio. If you // share the portfolio with principal name sharing enabled, the PrincipalARN -// association is included in the share. The PortfolioID, PrincipalARN, and +// association is included in the share. The PortfolioID , PrincipalARN , and // PrincipalType parameters are required. You can associate a maximum of 10 // Principals with a portfolio using PrincipalType as IAM_PATTERN When you // associate a principal with portfolio, a potential privilege escalation path may @@ -23,7 +23,7 @@ import ( // matches a principal name association for the portfolio. Although this user may // not know which principal names are associated through Service Catalog, they may // be able to guess the user. If this potential escalation path is a concern, then -// Service Catalog recommends using PrincipalType as IAM. With this configuration, +// Service Catalog recommends using PrincipalType as IAM . With this configuration, // the PrincipalARN must already exist in the recipient account before it can be // associated. func (c *Client) AssociatePrincipalWithPortfolio(ctx context.Context, params *AssociatePrincipalWithPortfolioInput, optFns ...func(*Options)) (*AssociatePrincipalWithPortfolioOutput, error) { @@ -49,7 +49,7 @@ type AssociatePrincipalWithPortfolioInput struct { PortfolioId *string // The ARN of the principal (user, role, or group). This field allows an ARN with - // no accountID if PrincipalType is IAM_PATTERN. You can associate multiple IAM + // no accountID if PrincipalType is IAM_PATTERN . You can associate multiple IAM // patterns even if the account has no principal with that name. This is useful in // Principal Name Sharing if you want to share a principal without creating it in // the account that owns the portfolio. @@ -58,16 +58,14 @@ type AssociatePrincipalWithPortfolioInput struct { PrincipalARN *string // The principal type. The supported value is IAM if you use a fully defined ARN, - // or IAM_PATTERN if you use an ARN with no accountID. + // or IAM_PATTERN if you use an ARN with no accountID . // // This member is required. PrincipalType types.PrincipalType // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go index e176e56931e..3e98f402777 100644 --- a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified product with the specified portfolio. A delegated admin -// is authorized to invoke this command. +// Associates the specified product with the specified portfolio. A delegated +// admin is authorized to invoke this command. func (c *Client) AssociateProductWithPortfolio(ctx context.Context, params *AssociateProductWithPortfolioInput, optFns ...func(*Options)) (*AssociateProductWithPortfolioOutput, error) { if params == nil { params = &AssociateProductWithPortfolioInput{} @@ -40,10 +40,8 @@ type AssociateProductWithPortfolioInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The identifier of the source portfolio. diff --git a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go index 1bec4568c71..62862347489 100644 --- a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go +++ b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go @@ -28,26 +28,24 @@ func (c *Client) AssociateServiceActionWithProvisioningArtifact(ctx context.Cont type AssociateServiceActionWithProvisioningArtifactInput struct { - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go b/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go index d9d0aa0a24e..5570f2f4aab 100644 --- a/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go +++ b/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go @@ -36,10 +36,8 @@ type BatchAssociateServiceActionWithProvisioningArtifactInput struct { ServiceActionAssociations []types.ServiceActionAssociation // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go index 2067eeb41dc..a94200c3adc 100644 --- a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go @@ -37,10 +37,8 @@ type BatchDisassociateServiceActionFromProvisioningArtifactInput struct { ServiceActionAssociations []types.ServiceActionAssociation // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_CopyProduct.go b/service/servicecatalog/api_op_CopyProduct.go index fb7eb55aa3b..796a02ca560 100644 --- a/service/servicecatalog/api_op_CopyProduct.go +++ b/service/servicecatalog/api_op_CopyProduct.go @@ -16,8 +16,8 @@ import ( // product. You can copy a product to the same account or another account. You can // copy a product to the same Region or another Region. If you copy a product to // another account, you must first share the product in a portfolio using -// CreatePortfolioShare. This operation is performed asynchronously. To track the -// progress of the operation, use DescribeCopyProductStatus. +// CreatePortfolioShare . This operation is performed asynchronously. To track the +// progress of the operation, use DescribeCopyProductStatus . func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optFns ...func(*Options)) (*CopyProductOutput, error) { if params == nil { params = &CopyProductInput{} @@ -35,9 +35,9 @@ func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optF type CopyProductInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -48,14 +48,12 @@ type CopyProductInput struct { SourceProductArn *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The copy options. If the value is CopyTags, the tags from the source product are - // copied to the target product. + // The copy options. If the value is CopyTags , the tags from the source product + // are copied to the target product. CopyOptions []types.CopyOption // The identifiers of the provisioning artifacts (also known as versions) of the diff --git a/service/servicecatalog/api_op_CreateConstraint.go b/service/servicecatalog/api_op_CreateConstraint.go index e071d643fa3..958ebf668b0 100644 --- a/service/servicecatalog/api_op_CreateConstraint.go +++ b/service/servicecatalog/api_op_CreateConstraint.go @@ -30,9 +30,9 @@ func (c *Client) CreateConstraint(ctx context.Context, params *CreateConstraintI type CreateConstraintInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -41,27 +41,27 @@ type CreateConstraintInput struct { // type as follows: LAUNCH You are required to specify either the RoleArn or the // LocalRoleName but can't use both. Specify the RoleArn property as follows: // {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} Specify the - // LocalRoleName property as follows: {"LocalRoleName": "SCBasicLaunchRole"} If you - // specify the LocalRoleName property, when an account uses the launch constraint, - // the IAM role with that name in the account will be used. This allows launch-role - // constraints to be account-agnostic so the administrator can create fewer - // resources per shared account. The given role name must exist in the account used - // to create the launch constraint and the account of the user who launches a - // product with this launch constraint. You cannot have both a LAUNCH and a - // STACKSET constraint. You also cannot have more than one LAUNCH constraint on a - // product and portfolio. NOTIFICATION Specify the NotificationArns property as - // follows: {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} + // LocalRoleName property as follows: {"LocalRoleName": "SCBasicLaunchRole"} If + // you specify the LocalRoleName property, when an account uses the launch + // constraint, the IAM role with that name in the account will be used. This allows + // launch-role constraints to be account-agnostic so the administrator can create + // fewer resources per shared account. The given role name must exist in the + // account used to create the launch constraint and the account of the user who + // launches a product with this launch constraint. You cannot have both a LAUNCH + // and a STACKSET constraint. You also cannot have more than one LAUNCH constraint + // on a product and portfolio. NOTIFICATION Specify the NotificationArns property + // as follows: {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} // RESOURCE_UPDATE Specify the TagUpdatesOnProvisionedProduct property as follows: // {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}} The // TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or - // NOT_ALLOWED. STACKSET Specify the Parameters property as follows: {"Version": + // NOT_ALLOWED . STACKSET Specify the Parameters property as follows: {"Version": // "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" // ], "AdminRole": "String", "ExecutionRole": "String"}} You cannot have both a // LAUNCH and a STACKSET constraint. You also cannot have more than one STACKSET // constraint on a product and portfolio. Products with a STACKSET constraint will // launch an CloudFormation stack set. TEMPLATE Specify the Rules property. For - // more information, see Template Constraint Rules - // (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html). + // more information, see Template Constraint Rules (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html) + // . // // This member is required. Parameters *string @@ -77,26 +77,18 @@ type CreateConstraintInput struct { ProductId *string // The type of constraint. - // - // * LAUNCH - // - // * NOTIFICATION - // - // * RESOURCE_UPDATE - // - // * - // STACKSET - // - // * TEMPLATE + // - LAUNCH + // - NOTIFICATION + // - RESOURCE_UPDATE + // - STACKSET + // - TEMPLATE // // This member is required. Type *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The description of the constraint. diff --git a/service/servicecatalog/api_op_CreatePortfolio.go b/service/servicecatalog/api_op_CreatePortfolio.go index 8773cfa067d..fb62c89cbe9 100644 --- a/service/servicecatalog/api_op_CreatePortfolio.go +++ b/service/servicecatalog/api_op_CreatePortfolio.go @@ -35,9 +35,9 @@ type CreatePortfolioInput struct { // This member is required. DisplayName *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -48,10 +48,8 @@ type CreatePortfolioInput struct { ProviderName *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The description of the portfolio. diff --git a/service/servicecatalog/api_op_CreatePortfolioShare.go b/service/servicecatalog/api_op_CreatePortfolioShare.go index fc90d5131cf..19185b12d1b 100644 --- a/service/servicecatalog/api_op_CreatePortfolioShare.go +++ b/service/servicecatalog/api_op_CreatePortfolioShare.go @@ -29,7 +29,7 @@ import ( // name association for the portfolio. Although this user may not know which // principal names are associated through Service Catalog, they may be able to // guess the user. If this potential escalation path is a concern, then Service -// Catalog recommends using PrincipalType as IAM. With this configuration, the +// Catalog recommends using PrincipalType as IAM . With this configuration, the // PrincipalARN must already exist in the recipient account before it can be // associated. func (c *Client) CreatePortfolioShare(ctx context.Context, params *CreatePortfolioShareInput, optFns ...func(*Options)) (*CreatePortfolioShareOutput, error) { @@ -55,29 +55,27 @@ type CreatePortfolioShareInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The Amazon Web Services account ID. For example, 123456789012. + // The Amazon Web Services account ID. For example, 123456789012 . AccountId *string // The organization node to whom you are going to share. When you pass - // OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services - // accounts that are associated to the OrganizationNode. The output returns a - // PortfolioShareToken, which enables the administrator to monitor the status of + // OrganizationNode , it creates PortfolioShare for all of the Amazon Web Services + // accounts that are associated to the OrganizationNode . The output returns a + // PortfolioShareToken , which enables the administrator to monitor the status of // the PortfolioShare creation process. OrganizationNode *types.OrganizationNode - // Enables or disables Principal sharing when creating the portfolio share. If this - // flag is not provided, principal sharing is disabled. When you enable Principal - // Name Sharing for a portfolio share, the share recipient account end users with a - // principal that matches any of the associated IAM patterns can provision products - // from the portfolio. Once shared, the share recipient can view associations of - // PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in - // the recipient account before or after creating the share. + // Enables or disables Principal sharing when creating the portfolio share. If + // this flag is not provided, principal sharing is disabled. When you enable + // Principal Name Sharing for a portfolio share, the share recipient account end + // users with a principal that matches any of the associated IAM patterns can + // provision products from the portfolio. Once shared, the share recipient can view + // associations of PrincipalType : IAM_PATTERN on their portfolio. You can create + // the principals in the recipient account before or after creating the share. SharePrincipals bool // Enables or disables TagOptions sharing when creating the portfolio share. If diff --git a/service/servicecatalog/api_op_CreateProduct.go b/service/servicecatalog/api_op_CreateProduct.go index 49feb639445..d67756cdaf2 100644 --- a/service/servicecatalog/api_op_CreateProduct.go +++ b/service/servicecatalog/api_op_CreateProduct.go @@ -34,9 +34,9 @@ func (c *Client) CreateProduct(ctx context.Context, params *CreateProductInput, type CreateProductInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -57,10 +57,8 @@ type CreateProductInput struct { ProductType types.ProductType // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The description of the product. @@ -76,10 +74,8 @@ type CreateProductInput struct { // the connection source artifact. This automatically manages the product's // artifacts based on changes to the source. The SourceConnection parameter // consists of the following sub-fields. - // - // * Type - // - // * ConnectionParamters + // - Type + // - ConnectionParamters SourceConnection *types.SourceConnection // The support information about the product. diff --git a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go index c55e9ac73f7..1878124a124 100644 --- a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go @@ -17,8 +17,8 @@ import ( // when the plan is executed. You can create one plan for each provisioned product. // To create a plan for an existing provisioned product, the product status must be // AVAILABLE or TAINTED. To view the resource changes in the change set, use -// DescribeProvisionedProductPlan. To create or modify the provisioned product, use -// ExecuteProvisionedProductPlan. +// DescribeProvisionedProductPlan . To create or modify the provisioned product, +// use ExecuteProvisionedProductPlan . func (c *Client) CreateProvisionedProductPlan(ctx context.Context, params *CreateProvisionedProductPlanInput, optFns ...func(*Options)) (*CreateProvisionedProductPlanOutput, error) { if params == nil { params = &CreateProvisionedProductPlanInput{} @@ -36,9 +36,9 @@ func (c *Client) CreateProvisionedProductPlan(ctx context.Context, params *Creat type CreateProvisionedProductPlanInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -71,10 +71,8 @@ type CreateProvisionedProductPlanInput struct { ProvisioningArtifactId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related @@ -83,11 +81,11 @@ type CreateProvisionedProductPlanInput struct { // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths. + // paths for a product, use ListLaunchPaths . PathId *string - // Parameters specified by the administrator that are required for provisioning the - // product. + // Parameters specified by the administrator that are required for provisioning + // the product. ProvisioningParameters []types.UpdateProvisioningParameter // One or more tags. If the plan is for an existing provisioned product, the diff --git a/service/servicecatalog/api_op_CreateProvisioningArtifact.go b/service/servicecatalog/api_op_CreateProvisioningArtifact.go index 28a4098e8f2..5d06a9df623 100644 --- a/service/servicecatalog/api_op_CreateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_CreateProvisioningArtifact.go @@ -35,9 +35,9 @@ func (c *Client) CreateProvisioningArtifact(ctx context.Context, params *CreateP type CreateProvisioningArtifactInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -53,10 +53,8 @@ type CreateProvisioningArtifactInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde @@ -65,8 +63,8 @@ type CreateProvisioningArtifactInput struct { type CreateProvisioningArtifactOutput struct { // Specify the template source with one of the following options, but not both. - // Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]. Use the URL of the - // CloudFormation template in Amazon S3 or GitHub in JSON format. + // Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ]. Use the URL of + // the CloudFormation template in Amazon S3 or GitHub in JSON format. // LoadTemplateFromURL Use the URL of the CloudFormation template in Amazon S3 or // GitHub in JSON format. ImportFromPhysicalId Use the physical id of the resource // that contains the template; currently supports CloudFormation stack ARN. diff --git a/service/servicecatalog/api_op_CreateServiceAction.go b/service/servicecatalog/api_op_CreateServiceAction.go index 204991d1473..13917055a18 100644 --- a/service/servicecatalog/api_op_CreateServiceAction.go +++ b/service/servicecatalog/api_op_CreateServiceAction.go @@ -32,27 +32,28 @@ type CreateServiceActionInput struct { // The self-service action definition. Can be one of the following: Name The name // of the Amazon Web Services Systems Manager document (SSM document). For example, - // AWS-RestartEC2Instance. If you are using a shared SSM document, you must provide - // the ARN instead of the name. Version The Amazon Web Services Systems Manager - // automation document version. For example, "Version": "1" AssumeRole The Amazon - // Resource Name (ARN) of the role that performs the self-service actions on your - // behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole". - // To reuse the provisioned product launch role, set to "AssumeRole": - // "LAUNCH_ROLE". Parameters The list of parameters in JSON format. For example: + // AWS-RestartEC2Instance . If you are using a shared SSM document, you must + // provide the ARN instead of the name. Version The Amazon Web Services Systems + // Manager automation document version. For example, "Version": "1" AssumeRole The + // Amazon Resource Name (ARN) of the role that performs the self-service actions on + // your behalf. For example, "AssumeRole": + // "arn:aws:iam::12345678910:role/ActionRole" . To reuse the provisioned product + // launch role, set to "AssumeRole": "LAUNCH_ROLE" . Parameters The list of + // parameters in JSON format. For example: // [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or - // [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]. + // [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}] . // // This member is required. Definition map[string]string - // The service action definition type. For example, SSM_AUTOMATION. + // The service action definition type. For example, SSM_AUTOMATION . // // This member is required. DefinitionType types.ServiceActionDefinitionType - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -63,10 +64,8 @@ type CreateServiceActionInput struct { Name *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The self-service action description. diff --git a/service/servicecatalog/api_op_DeleteConstraint.go b/service/servicecatalog/api_op_DeleteConstraint.go index 0ba80affa52..886be0aff84 100644 --- a/service/servicecatalog/api_op_DeleteConstraint.go +++ b/service/servicecatalog/api_op_DeleteConstraint.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified constraint. A delegated admin is authorized to invoke this -// command. +// Deletes the specified constraint. A delegated admin is authorized to invoke +// this command. func (c *Client) DeleteConstraint(ctx context.Context, params *DeleteConstraintInput, optFns ...func(*Options)) (*DeleteConstraintOutput, error) { if params == nil { params = &DeleteConstraintInput{} @@ -35,10 +35,8 @@ type DeleteConstraintInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DeletePortfolio.go b/service/servicecatalog/api_op_DeletePortfolio.go index 81d5e86fbe0..3228042f899 100644 --- a/service/servicecatalog/api_op_DeletePortfolio.go +++ b/service/servicecatalog/api_op_DeletePortfolio.go @@ -36,10 +36,8 @@ type DeletePortfolioInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DeletePortfolioShare.go b/service/servicecatalog/api_op_DeletePortfolioShare.go index ae48529ccee..9106acec86d 100644 --- a/service/servicecatalog/api_op_DeletePortfolioShare.go +++ b/service/servicecatalog/api_op_DeletePortfolioShare.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops sharing the specified portfolio with the specified account or organization -// node. Shares to an organization node can only be deleted by the management -// account of an organization or by a delegated administrator. Note that if a -// delegated admin is de-registered, portfolio shares created from that account are -// removed. +// Stops sharing the specified portfolio with the specified account or +// organization node. Shares to an organization node can only be deleted by the +// management account of an organization or by a delegated administrator. Note that +// if a delegated admin is de-registered, portfolio shares created from that +// account are removed. func (c *Client) DeletePortfolioShare(ctx context.Context, params *DeletePortfolioShareInput, optFns ...func(*Options)) (*DeletePortfolioShareOutput, error) { if params == nil { params = &DeletePortfolioShareInput{} @@ -39,10 +39,8 @@ type DeletePortfolioShareInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The Amazon Web Services account ID. diff --git a/service/servicecatalog/api_op_DeleteProduct.go b/service/servicecatalog/api_op_DeleteProduct.go index 82648ea08a3..a001ec331b4 100644 --- a/service/servicecatalog/api_op_DeleteProduct.go +++ b/service/servicecatalog/api_op_DeleteProduct.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified product. You cannot delete a product if it was shared with -// you or is associated with a portfolio. A delegated admin is authorized to invoke -// this command. +// Deletes the specified product. You cannot delete a product if it was shared +// with you or is associated with a portfolio. A delegated admin is authorized to +// invoke this command. func (c *Client) DeleteProduct(ctx context.Context, params *DeleteProductInput, optFns ...func(*Options)) (*DeleteProductOutput, error) { if params == nil { params = &DeleteProductInput{} @@ -36,10 +36,8 @@ type DeleteProductInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go index 88123e1d9f2..f06816d723f 100644 --- a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go @@ -34,14 +34,12 @@ type DeleteProvisionedProductPlanInput struct { PlanId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // If set to true, Service Catalog stops managing the specified provisioned product - // even if it cannot delete the underlying resources. + // If set to true, Service Catalog stops managing the specified provisioned + // product even if it cannot delete the underlying resources. IgnoreErrors bool noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go index 329edc8784e..423c7ac0468 100644 --- a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go @@ -43,10 +43,8 @@ type DeleteProvisioningArtifactInput struct { ProvisioningArtifactId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DeleteServiceAction.go b/service/servicecatalog/api_op_DeleteServiceAction.go index 12aea4ed02c..6a7687c1011 100644 --- a/service/servicecatalog/api_op_DeleteServiceAction.go +++ b/service/servicecatalog/api_op_DeleteServiceAction.go @@ -28,16 +28,14 @@ func (c *Client) DeleteServiceAction(ctx context.Context, params *DeleteServiceA type DeleteServiceActionInput struct { - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribeConstraint.go b/service/servicecatalog/api_op_DescribeConstraint.go index 46cb94350cf..3658e6b9f85 100644 --- a/service/servicecatalog/api_op_DescribeConstraint.go +++ b/service/servicecatalog/api_op_DescribeConstraint.go @@ -35,10 +35,8 @@ type DescribeConstraintInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribeCopyProductStatus.go b/service/servicecatalog/api_op_DescribeCopyProductStatus.go index 01626df63e8..2667eecc1c6 100644 --- a/service/servicecatalog/api_op_DescribeCopyProductStatus.go +++ b/service/servicecatalog/api_op_DescribeCopyProductStatus.go @@ -29,16 +29,14 @@ func (c *Client) DescribeCopyProductStatus(ctx context.Context, params *Describe type DescribeCopyProductStatusInput struct { - // The token for the copy product operation. This token is returned by CopyProduct. + // The token for the copy product operation. This token is returned by CopyProduct . // // This member is required. CopyProductToken *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribePortfolio.go b/service/servicecatalog/api_op_DescribePortfolio.go index b2c129dbc30..6454b350b0e 100644 --- a/service/servicecatalog/api_op_DescribePortfolio.go +++ b/service/servicecatalog/api_op_DescribePortfolio.go @@ -36,10 +36,8 @@ type DescribePortfolioInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribePortfolioShareStatus.go b/service/servicecatalog/api_op_DescribePortfolioShareStatus.go index c040c9cabf2..3faae2a2120 100644 --- a/service/servicecatalog/api_op_DescribePortfolioShareStatus.go +++ b/service/servicecatalog/api_op_DescribePortfolioShareStatus.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the status of the specified portfolio share operation. This API can only be -// called by the management account in the organization or by a delegated admin. +// Gets the status of the specified portfolio share operation. This API can only +// be called by the management account in the organization or by a delegated admin. func (c *Client) DescribePortfolioShareStatus(ctx context.Context, params *DescribePortfolioShareStatusInput, optFns ...func(*Options)) (*DescribePortfolioShareStatusOutput, error) { if params == nil { params = &DescribePortfolioShareStatusInput{} @@ -48,7 +48,7 @@ type DescribePortfolioShareStatusOutput struct { // The portfolio identifier. PortfolioId *string - // The token for the portfolio share operation. For example, share-6v24abcdefghi. + // The token for the portfolio share operation. For example, share-6v24abcdefghi . PortfolioShareToken *string // Information about the portfolio share operation. diff --git a/service/servicecatalog/api_op_DescribeProduct.go b/service/servicecatalog/api_op_DescribeProduct.go index f37c3a3bbd8..8ca46b4aade 100644 --- a/service/servicecatalog/api_op_DescribeProduct.go +++ b/service/servicecatalog/api_op_DescribeProduct.go @@ -12,8 +12,8 @@ import ( ) // Gets information about the specified product. Running this operation with -// administrator access results in a failure. DescribeProductAsAdmin should be used -// instead. +// administrator access results in a failure. DescribeProductAsAdmin should be +// used instead. func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInput, optFns ...func(*Options)) (*DescribeProductOutput, error) { if params == nil { params = &DescribeProductInput{} @@ -32,10 +32,8 @@ func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInp type DescribeProductInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The product identifier. diff --git a/service/servicecatalog/api_op_DescribeProductAsAdmin.go b/service/servicecatalog/api_op_DescribeProductAsAdmin.go index bdcf440134f..bf9e267d3e3 100644 --- a/service/servicecatalog/api_op_DescribeProductAsAdmin.go +++ b/service/servicecatalog/api_op_DescribeProductAsAdmin.go @@ -31,10 +31,8 @@ func (c *Client) DescribeProductAsAdmin(ctx context.Context, params *DescribePro type DescribeProductAsAdminInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The product identifier. diff --git a/service/servicecatalog/api_op_DescribeProductView.go b/service/servicecatalog/api_op_DescribeProductView.go index fcf646b18e4..be122d1a18a 100644 --- a/service/servicecatalog/api_op_DescribeProductView.go +++ b/service/servicecatalog/api_op_DescribeProductView.go @@ -35,10 +35,8 @@ type DescribeProductViewInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribeProvisionedProduct.go b/service/servicecatalog/api_op_DescribeProvisionedProduct.go index 87ccc04a2a3..86e0d6b8b24 100644 --- a/service/servicecatalog/api_op_DescribeProvisionedProduct.go +++ b/service/servicecatalog/api_op_DescribeProvisionedProduct.go @@ -34,10 +34,8 @@ func (c *Client) DescribeProvisionedProduct(ctx context.Context, params *Describ type DescribeProvisionedProductInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The provisioned product identifier. You must provide the name or ID, but not diff --git a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go index a56631136f1..fc381ce1c19 100644 --- a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go @@ -35,10 +35,8 @@ type DescribeProvisionedProductPlanInput struct { PlanId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go index 17f136f48e7..09df4852414 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go @@ -31,10 +31,8 @@ func (c *Client) DescribeProvisioningArtifact(ctx context.Context, params *Descr type DescribeProvisioningArtifactInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The product identifier. diff --git a/service/servicecatalog/api_op_DescribeProvisioningParameters.go b/service/servicecatalog/api_op_DescribeProvisioningParameters.go index 873b14e97ee..abdcceb2ba7 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningParameters.go +++ b/service/servicecatalog/api_op_DescribeProvisioningParameters.go @@ -15,10 +15,10 @@ import ( // product using the specified provisioning artifact. If the output contains a // TagOption key with an empty list of values, there is a TagOption conflict for // that key. The end user cannot take action to fix the conflict, and launch is not -// blocked. In subsequent calls to ProvisionProduct, do not include conflicted +// blocked. In subsequent calls to ProvisionProduct , do not include conflicted // TagOption keys as tags, or this causes the error "Parameter validation failed: // Missing required parameter in Tags[N]:Value". Tag the provisioned product with -// the value sc-tagoption-conflict-portfolioId-productId. +// the value sc-tagoption-conflict-portfolioId-productId . func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *DescribeProvisioningParametersInput, optFns ...func(*Options)) (*DescribeProvisioningParametersOutput, error) { if params == nil { params = &DescribeProvisioningParametersInput{} @@ -37,15 +37,13 @@ func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *Des type DescribeProvisioningParametersInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths. You must provide the name or ID, but + // paths for a product, use ListLaunchPaths . You must provide the name or ID, but // not both. PathId *string @@ -95,8 +93,8 @@ type DescribeProvisioningParametersOutput struct { // Information about the TagOptions associated with the resource. TagOptions []types.TagOptionSummary - // Any additional metadata specifically related to the provisioning of the product. - // For example, see the Version field of the CloudFormation template. + // Any additional metadata specifically related to the provisioning of the + // product. For example, see the Version field of the CloudFormation template. UsageInstructions []types.UsageInstruction // Metadata pertaining to the operation's result. diff --git a/service/servicecatalog/api_op_DescribeRecord.go b/service/servicecatalog/api_op_DescribeRecord.go index acc7642c4fb..80d8969b88c 100644 --- a/service/servicecatalog/api_op_DescribeRecord.go +++ b/service/servicecatalog/api_op_DescribeRecord.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the specified request operation. Use this operation after -// calling a request operation (for example, ProvisionProduct, -// TerminateProvisionedProduct, or UpdateProvisionedProduct). If a provisioned -// product was transferred to a new owner using UpdateProvisionedProductProperties, -// the new owner will be able to describe all past records for that product. The +// Gets information about the specified request operation. Use this operation +// after calling a request operation (for example, ProvisionProduct , +// TerminateProvisionedProduct , or UpdateProvisionedProduct ). If a provisioned +// product was transferred to a new owner using UpdateProvisionedProductProperties +// , the new owner will be able to describe all past records for that product. The // previous owner will no longer be able to describe the records, but will be able // to use ListRecordHistory to see the product's history from when he was the // owner. @@ -36,17 +36,15 @@ func (c *Client) DescribeRecord(ctx context.Context, params *DescribeRecordInput type DescribeRecordInput struct { - // The record identifier of the provisioned product. This identifier is returned by - // the request operation. + // The record identifier of the provisioned product. This identifier is returned + // by the request operation. // // This member is required. Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_DescribeServiceAction.go b/service/servicecatalog/api_op_DescribeServiceAction.go index 881590cd4af..41d8d6b2d8d 100644 --- a/service/servicecatalog/api_op_DescribeServiceAction.go +++ b/service/servicecatalog/api_op_DescribeServiceAction.go @@ -35,10 +35,8 @@ type DescribeServiceActionInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go index 0b5976e45c9..f31ad9ac2db 100644 --- a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go +++ b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go @@ -41,10 +41,8 @@ type DescribeServiceActionExecutionParametersInput struct { ServiceActionId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go b/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go index 6240f6605c4..38cbcdd8714 100644 --- a/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go +++ b/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go @@ -17,7 +17,7 @@ import ( // management account in the organization can call this API. You cannot call this // API if there are active delegated administrators in the organization. Note that // a delegated administrator is not authorized to invoke -// DisableAWSOrganizationsAccess. If you share an Service Catalog portfolio in an +// DisableAWSOrganizationsAccess . If you share an Service Catalog portfolio in an // organization within Organizations, and then disable Organizations access for // Service Catalog, the portfolio access permissions will not sync with the latest // changes to the organization structure. Specifically, accounts that you removed diff --git a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go index 8b879ae90be..d8cab779855 100644 --- a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go +++ b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go @@ -14,12 +14,12 @@ import ( // Disassociates a previously associated principal ARN from a specified portfolio. // The PrincipalType and PrincipalARN must match the // AssociatePrincipalWithPortfolio call request details. For example, to -// disassociate an association created with a PrincipalARN of PrincipalType IAM you -// must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio. -// For portfolios that have been shared with principal name sharing enabled: after -// disassociating a principal, share recipient accounts will no longer be able to -// provision products in this portfolio using a role matching the name of the -// associated principal. +// disassociate an association created with a PrincipalARN of PrincipalType IAM +// you must use the PrincipalType IAM when calling +// DisassociatePrincipalFromPortfolio . For portfolios that have been shared with +// principal name sharing enabled: after disassociating a principal, share +// recipient accounts will no longer be able to provision products in this +// portfolio using a role matching the name of the associated principal. func (c *Client) DisassociatePrincipalFromPortfolio(ctx context.Context, params *DisassociatePrincipalFromPortfolioInput, optFns ...func(*Options)) (*DisassociatePrincipalFromPortfolioOutput, error) { if params == nil { params = &DisassociatePrincipalFromPortfolioInput{} @@ -43,20 +43,18 @@ type DisassociatePrincipalFromPortfolioInput struct { PortfolioId *string // The ARN of the principal (user, role, or group). This field allows an ARN with - // no accountID if PrincipalType is IAM_PATTERN. + // no accountID if PrincipalType is IAM_PATTERN . // // This member is required. PrincipalARN *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you - // use no accountID. + // The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if + // you use no accountID . PrincipalType types.PrincipalType noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go b/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go index 4321c8645ac..b00903bd959 100644 --- a/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go +++ b/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go @@ -40,10 +40,8 @@ type DisassociateProductFromPortfolioInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go index 67ffd5d87e8..fece9477b14 100644 --- a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go @@ -29,26 +29,24 @@ func (c *Client) DisassociateServiceActionFromProvisioningArtifact(ctx context.C type DisassociateServiceActionFromProvisioningArtifactInput struct { - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go b/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go index 69d86c0a045..217c356d560 100644 --- a/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go +++ b/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go @@ -16,7 +16,7 @@ import ( // account in the organization. When you call this API, Service Catalog calls // organizations:EnableAWSServiceAccess on your behalf so that your shares stay in // sync with any changes in your Organizations structure. Note that a delegated -// administrator is not authorized to invoke EnableAWSOrganizationsAccess. If you +// administrator is not authorized to invoke EnableAWSOrganizationsAccess . If you // have previously disabled Organizations access for Service Catalog, and then // enable access again, the portfolio access permissions might not sync with the // latest changes to the organization structure. Specifically, accounts that you diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go index b196fb8fe44..1670f8b369f 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provisions or modifies a product based on the resource changes for the specified -// plan. +// Provisions or modifies a product based on the resource changes for the +// specified plan. func (c *Client) ExecuteProvisionedProductPlan(ctx context.Context, params *ExecuteProvisionedProductPlanInput, optFns ...func(*Options)) (*ExecuteProvisionedProductPlanOutput, error) { if params == nil { params = &ExecuteProvisionedProductPlanInput{} @@ -31,9 +31,9 @@ func (c *Client) ExecuteProvisionedProductPlan(ctx context.Context, params *Exec type ExecuteProvisionedProductPlanInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string @@ -44,10 +44,8 @@ type ExecuteProvisionedProductPlanInput struct { PlanId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go index ca88d2c287e..3f8f7718500 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go @@ -40,23 +40,21 @@ type ExecuteProvisionedProductServiceActionInput struct { // This member is required. ProvisionedProductId *string - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // A map of all self-service action parameters and their values. If a provided - // parameter is of a special type, such as TARGET, the provided value will override - // the default value generated by Service Catalog. If the parameters field is not - // provided, no additional parameters are passed and default values will be used - // for any special parameters such as TARGET. + // parameter is of a special type, such as TARGET , the provided value will + // override the default value generated by Service Catalog. If the parameters field + // is not provided, no additional parameters are passed and default values will be + // used for any special parameters such as TARGET . Parameters map[string][]string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_GetProvisionedProductOutputs.go b/service/servicecatalog/api_op_GetProvisionedProductOutputs.go index 34bece5de0d..b7cb8745f8f 100644 --- a/service/servicecatalog/api_op_GetProvisionedProductOutputs.go +++ b/service/servicecatalog/api_op_GetProvisionedProductOutputs.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API takes either a ProvisonedProductId or a ProvisionedProductName, along +// This API takes either a ProvisonedProductId or a ProvisionedProductName , along // with a list of one or more output keys, and responds with the key/value pairs of // those outputs. func (c *Client) GetProvisionedProductOutputs(ctx context.Context, params *GetProvisionedProductOutputsInput, optFns ...func(*Options)) (*GetProvisionedProductOutputsOutput, error) { @@ -33,10 +33,8 @@ func (c *Client) GetProvisionedProductOutputs(ctx context.Context, params *GetPr type GetProvisionedProductOutputsInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The list of keys that the API should return with their values. If none are diff --git a/service/servicecatalog/api_op_ImportAsProvisionedProduct.go b/service/servicecatalog/api_op_ImportAsProvisionedProduct.go index c464ddebaf2..ea5d4adb0a6 100644 --- a/service/servicecatalog/api_op_ImportAsProvisionedProduct.go +++ b/service/servicecatalog/api_op_ImportAsProvisionedProduct.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests the import of a resource as an Service Catalog provisioned product that -// is associated to an Service Catalog product and provisioning artifact. Once +// Requests the import of a resource as an Service Catalog provisioned product +// that is associated to an Service Catalog product and provisioning artifact. Once // imported, all supported governance actions are supported on the provisioned // product. Resource import only supports CloudFormation stack ARNs. CloudFormation // StackSets, and non-root nested stacks are not supported. The CloudFormation -// stack must have one of the following statuses to be imported: CREATE_COMPLETE, -// UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and -// IMPORT_ROLLBACK_COMPLETE. Import of the resource requires that the +// stack must have one of the following statuses to be imported: CREATE_COMPLETE , +// UPDATE_COMPLETE , UPDATE_ROLLBACK_COMPLETE , IMPORT_COMPLETE , and +// IMPORT_ROLLBACK_COMPLETE . Import of the resource requires that the // CloudFormation stack template matches the associated Service Catalog product // provisioning artifact. When you import an existing CloudFormation stack into a // portfolio, constraints that are associated with the product aren't applied @@ -44,15 +44,15 @@ func (c *Client) ImportAsProvisionedProduct(ctx context.Context, params *ImportA type ImportAsProvisionedProductInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. // // This member is required. IdempotencyToken *string - // The unique identifier of the resource to be imported. It only currently supports - // CloudFormation stack IDs. + // The unique identifier of the resource to be imported. It only currently + // supports CloudFormation stack IDs. // // This member is required. PhysicalId *string @@ -75,10 +75,8 @@ type ImportAsProvisionedProductInput struct { ProvisioningArtifactId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go index d37acc5b12a..35639fc15f4 100644 --- a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go +++ b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go @@ -13,7 +13,7 @@ import ( ) // Lists all imported portfolios for which account-to-account shares were accepted -// by this account. By specifying the PortfolioShareType, you can list portfolios +// by this account. By specifying the PortfolioShareType , you can list portfolios // for which organizational shares were accepted by this account. func (c *Client) ListAcceptedPortfolioShares(ctx context.Context, params *ListAcceptedPortfolioSharesInput, optFns ...func(*Options)) (*ListAcceptedPortfolioSharesOutput, error) { if params == nil { @@ -33,10 +33,8 @@ func (c *Client) ListAcceptedPortfolioShares(ctx context.Context, params *ListAc type ListAcceptedPortfolioSharesInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. @@ -48,16 +46,12 @@ type ListAcceptedPortfolioSharesInput struct { // The type of shared portfolios to list. The default is to list imported // portfolios. - // - // * AWS_ORGANIZATIONS - List portfolios accepted and shared via - // organizational sharing by the management account or delegated administrator of - // your organization. - // - // * AWS_SERVICECATALOG - Deprecated type. - // - // * IMPORTED - List - // imported portfolios that have been accepted and shared through - // account-to-account sharing. + // - AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational + // sharing by the management account or delegated administrator of your + // organization. + // - AWS_SERVICECATALOG - Deprecated type. + // - IMPORTED - List imported portfolios that have been accepted and shared + // through account-to-account sharing. PortfolioShareType types.PortfolioShareType noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ListBudgetsForResource.go b/service/servicecatalog/api_op_ListBudgetsForResource.go index 316ee11253d..3cc8a01d4b1 100644 --- a/service/servicecatalog/api_op_ListBudgetsForResource.go +++ b/service/servicecatalog/api_op_ListBudgetsForResource.go @@ -36,10 +36,8 @@ type ListBudgetsForResourceInput struct { ResourceId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go index f0b86d83abb..e392227b254 100644 --- a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go +++ b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go @@ -36,10 +36,8 @@ type ListConstraintsForPortfolioInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListLaunchPaths.go b/service/servicecatalog/api_op_ListLaunchPaths.go index a1f87c68651..e4b127f8acb 100644 --- a/service/servicecatalog/api_op_ListLaunchPaths.go +++ b/service/servicecatalog/api_op_ListLaunchPaths.go @@ -17,8 +17,7 @@ import ( // path also determines the constraints that are put on a product. A path is // dependent on a specific product, porfolio, and principal. When provisioning a // product that's been added to a portfolio, you must grant your user, group, or -// role access to the portfolio. For more information, see Granting users access -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) +// role access to the portfolio. For more information, see Granting users access (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) // in the Service Catalog User Guide. func (c *Client) ListLaunchPaths(ctx context.Context, params *ListLaunchPathsInput, optFns ...func(*Options)) (*ListLaunchPathsOutput, error) { if params == nil { @@ -43,10 +42,8 @@ type ListLaunchPathsInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go index b0059cdd690..7395fffc3c1 100644 --- a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go @@ -34,30 +34,22 @@ func (c *Client) ListOrganizationPortfolioAccess(ctx context.Context, params *Li type ListOrganizationPortfolioAccessInput struct { // The organization node type that will be returned in the output. - // - // * ORGANIZATION - // - Organization that has access to the portfolio. - // - // * ORGANIZATIONAL_UNIT - - // Organizational unit that has access to the portfolio within your - // organization. - // - // * ACCOUNT - Account that has access to the portfolio within your - // organization. + // - ORGANIZATION - Organization that has access to the portfolio. + // - ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio + // within your organization. + // - ACCOUNT - Account that has access to the portfolio within your organization. // // This member is required. OrganizationNodeType types.OrganizationNodeType - // The portfolio identifier. For example, port-2abcdext3y5fk. + // The portfolio identifier. For example, port-2abcdext3y5fk . // // This member is required. PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListPortfolioAccess.go b/service/servicecatalog/api_op_ListPortfolioAccess.go index 8c694a910a4..9bf30900013 100644 --- a/service/servicecatalog/api_op_ListPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListPortfolioAccess.go @@ -38,10 +38,8 @@ type ListPortfolioAccessInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The ID of an organization node the portfolio is shared with. All children of @@ -136,8 +134,8 @@ func (c *Client) addOperationListPortfolioAccessMiddlewares(stack *middleware.St return nil } -// ListPortfolioAccessAPIClient is a client that implements the ListPortfolioAccess -// operation. +// ListPortfolioAccessAPIClient is a client that implements the +// ListPortfolioAccess operation. type ListPortfolioAccessAPIClient interface { ListPortfolioAccess(context.Context, *ListPortfolioAccessInput, ...func(*Options)) (*ListPortfolioAccessOutput, error) } diff --git a/service/servicecatalog/api_op_ListPortfolios.go b/service/servicecatalog/api_op_ListPortfolios.go index 220962e624c..1384baa731a 100644 --- a/service/servicecatalog/api_op_ListPortfolios.go +++ b/service/servicecatalog/api_op_ListPortfolios.go @@ -31,10 +31,8 @@ func (c *Client) ListPortfolios(ctx context.Context, params *ListPortfoliosInput type ListPortfoliosInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListPortfoliosForProduct.go b/service/servicecatalog/api_op_ListPortfoliosForProduct.go index be2be6bc322..b7d3a795206 100644 --- a/service/servicecatalog/api_op_ListPortfoliosForProduct.go +++ b/service/servicecatalog/api_op_ListPortfoliosForProduct.go @@ -36,10 +36,8 @@ type ListPortfoliosForProductInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go index 6187e76f964..fc21f60e725 100644 --- a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go +++ b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all PrincipalARNs and corresponding PrincipalTypes associated with the +// Lists all PrincipalARN s and corresponding PrincipalType s associated with the // specified portfolio. func (c *Client) ListPrincipalsForPortfolio(ctx context.Context, params *ListPrincipalsForPortfolioInput, optFns ...func(*Options)) (*ListPrincipalsForPortfolioOutput, error) { if params == nil { @@ -37,10 +37,8 @@ type ListPrincipalsForPortfolioInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. @@ -59,7 +57,7 @@ type ListPrincipalsForPortfolioOutput struct { // additional results, this value is null. NextPageToken *string - // The PrincipalARNs and corresponding PrincipalTypes associated with the + // The PrincipalARN s and corresponding PrincipalType s associated with the // portfolio. Principals []types.Principal diff --git a/service/servicecatalog/api_op_ListProvisionedProductPlans.go b/service/servicecatalog/api_op_ListProvisionedProductPlans.go index 2fb47256225..7b878784729 100644 --- a/service/servicecatalog/api_op_ListProvisionedProductPlans.go +++ b/service/servicecatalog/api_op_ListProvisionedProductPlans.go @@ -31,13 +31,11 @@ func (c *Client) ListProvisionedProductPlans(ctx context.Context, params *ListPr type ListProvisionedProductPlansInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The access level to use to obtain results. The default is User. + // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListProvisioningArtifacts.go b/service/servicecatalog/api_op_ListProvisioningArtifacts.go index c4a2d3c61e8..08385ca45f0 100644 --- a/service/servicecatalog/api_op_ListProvisioningArtifacts.go +++ b/service/servicecatalog/api_op_ListProvisioningArtifacts.go @@ -36,10 +36,8 @@ type ListProvisioningArtifactsInput struct { ProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go index 87b3fb98e19..54dc0a7a4e5 100644 --- a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go +++ b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go @@ -31,16 +31,14 @@ func (c *Client) ListProvisioningArtifactsForServiceAction(ctx context.Context, type ListProvisioningArtifactsForServiceActionInput struct { - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListRecordHistory.go b/service/servicecatalog/api_op_ListRecordHistory.go index f14855d2da5..6e1314ff2a6 100644 --- a/service/servicecatalog/api_op_ListRecordHistory.go +++ b/service/servicecatalog/api_op_ListRecordHistory.go @@ -30,13 +30,11 @@ func (c *Client) ListRecordHistory(ctx context.Context, params *ListRecordHistor type ListRecordHistoryInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The access level to use to obtain results. The default is User. + // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListResourcesForTagOption.go b/service/servicecatalog/api_op_ListResourcesForTagOption.go index 383c0dc27fc..3d75b6e54a3 100644 --- a/service/servicecatalog/api_op_ListResourcesForTagOption.go +++ b/service/servicecatalog/api_op_ListResourcesForTagOption.go @@ -43,10 +43,8 @@ type ListResourcesForTagOptionInput struct { PageToken *string // The resource type. - // - // * Portfolio - // - // * Product + // - Portfolio + // - Product ResourceType *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ListServiceActions.go b/service/servicecatalog/api_op_ListServiceActions.go index 73c1b5059cc..9c570c16a1b 100644 --- a/service/servicecatalog/api_op_ListServiceActions.go +++ b/service/servicecatalog/api_op_ListServiceActions.go @@ -31,10 +31,8 @@ func (c *Client) ListServiceActions(ctx context.Context, params *ListServiceActi type ListServiceActionsInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go index f2dbb6e3cfc..e8b688325c9 100644 --- a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go +++ b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go @@ -31,21 +31,19 @@ func (c *Client) ListServiceActionsForProvisioningArtifact(ctx context.Context, type ListServiceActionsForProvisioningArtifactInput struct { - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go index 14f6e8aa774..d869501f2b4 100644 --- a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go +++ b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go @@ -38,10 +38,8 @@ type ListStackInstancesForProvisionedProductInput struct { ProvisionedProductId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go b/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go index c5611faa482..b86f6eed957 100644 --- a/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go +++ b/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go @@ -45,8 +45,8 @@ type NotifyProvisionProductEngineWorkflowResultInput struct { // This member is required. Status types.EngineWorkflowStatus - // The encrypted contents of the provisioning engine execution payload that Service - // Catalog sends after the Terraform product provisioning workflow starts. + // The encrypted contents of the provisioning engine execution payload that + // Service Catalog sends after the Terraform product provisioning workflow starts. // // This member is required. WorkflowToken *string diff --git a/service/servicecatalog/api_op_ProvisionProduct.go b/service/servicecatalog/api_op_ProvisionProduct.go index 00d90a40d48..ced061aa874 100644 --- a/service/servicecatalog/api_op_ProvisionProduct.go +++ b/service/servicecatalog/api_op_ProvisionProduct.go @@ -15,14 +15,13 @@ import ( // Provisions the specified product. A provisioned product is a resourced instance // of a product. For example, provisioning a product that's based on an // CloudFormation template launches an CloudFormation stack and its underlying -// resources. You can check the status of this request using DescribeRecord. If the -// request contains a tag key with an empty list of values, there's a tag conflict -// for that key. Don't include conflicted keys as tags, or this will cause the -// error "Parameter validation failed: Missing required parameter in +// resources. You can check the status of this request using DescribeRecord . If +// the request contains a tag key with an empty list of values, there's a tag +// conflict for that key. Don't include conflicted keys as tags, or this will cause +// the error "Parameter validation failed: Missing required parameter in // Tags[N]:Value". When provisioning a product that's been added to a portfolio, // you must grant your user, group, or role access to the portfolio. For more -// information, see Granting users access -// (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) +// information, see Granting users access (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) // in the Service Catalog User Guide. func (c *Client) ProvisionProduct(ctx context.Context, params *ProvisionProductInput, optFns ...func(*Options)) (*ProvisionProductOutput, error) { if params == nil { @@ -54,10 +53,8 @@ type ProvisionProductInput struct { ProvisionedProductName *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related @@ -66,7 +63,7 @@ type ProvisionProductInput struct { // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths. You must provide the name or ID, but + // paths for a product, use ListLaunchPaths . You must provide the name or ID, but // not both. PathId *string @@ -87,8 +84,8 @@ type ProvisionProductInput struct { // both. ProvisioningArtifactName *string - // Parameters specified by the administrator that are required for provisioning the - // product. + // Parameters specified by the administrator that are required for provisioning + // the product. ProvisioningParameters []types.ProvisioningParameter // An object that contains information about the provisioning preferences for a diff --git a/service/servicecatalog/api_op_RejectPortfolioShare.go b/service/servicecatalog/api_op_RejectPortfolioShare.go index d4534ed818d..55e18aacefc 100644 --- a/service/servicecatalog/api_op_RejectPortfolioShare.go +++ b/service/servicecatalog/api_op_RejectPortfolioShare.go @@ -35,25 +35,17 @@ type RejectPortfolioShareInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The type of shared portfolios to reject. The default is to reject imported // portfolios. - // - // * AWS_ORGANIZATIONS - Reject portfolios shared by the management - // account of your organization. - // - // * IMPORTED - Reject imported portfolios. - // - // * - // AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) - // - // For - // example, aws servicecatalog reject-portfolio-share --portfolio-id + // - AWS_ORGANIZATIONS - Reject portfolios shared by the management account of + // your organization. + // - IMPORTED - Reject imported portfolios. + // - AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) + // For example, aws servicecatalog reject-portfolio-share --portfolio-id // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType diff --git a/service/servicecatalog/api_op_ScanProvisionedProducts.go b/service/servicecatalog/api_op_ScanProvisionedProducts.go index 8093df8c431..deb3cff9b79 100644 --- a/service/servicecatalog/api_op_ScanProvisionedProducts.go +++ b/service/servicecatalog/api_op_ScanProvisionedProducts.go @@ -12,7 +12,7 @@ import ( ) // Lists the provisioned products that are available (not terminated). To use -// additional filtering, see SearchProvisionedProducts. +// additional filtering, see SearchProvisionedProducts . func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvisionedProductsInput, optFns ...func(*Options)) (*ScanProvisionedProductsOutput, error) { if params == nil { params = &ScanProvisionedProductsInput{} @@ -31,13 +31,11 @@ func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvis type ScanProvisionedProductsInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The access level to use to obtain results. The default is User. + // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter // The maximum number of items to return with this call. diff --git a/service/servicecatalog/api_op_SearchProducts.go b/service/servicecatalog/api_op_SearchProducts.go index bb12d5a86fc..042cd35374c 100644 --- a/service/servicecatalog/api_op_SearchProducts.go +++ b/service/servicecatalog/api_op_SearchProducts.go @@ -31,10 +31,8 @@ func (c *Client) SearchProducts(ctx context.Context, params *SearchProductsInput type SearchProductsInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The search filters. If no search filters are specified, the output includes all diff --git a/service/servicecatalog/api_op_SearchProductsAsAdmin.go b/service/servicecatalog/api_op_SearchProductsAsAdmin.go index 95a9bb28341..1c2f96f91a7 100644 --- a/service/servicecatalog/api_op_SearchProductsAsAdmin.go +++ b/service/servicecatalog/api_op_SearchProductsAsAdmin.go @@ -31,10 +31,8 @@ func (c *Client) SearchProductsAsAdmin(ctx context.Context, params *SearchProduc type SearchProductsAsAdminInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The search filters. If no search filters are specified, the output includes all diff --git a/service/servicecatalog/api_op_SearchProvisionedProducts.go b/service/servicecatalog/api_op_SearchProvisionedProducts.go index 080ac33c244..45b9b99a84a 100644 --- a/service/servicecatalog/api_op_SearchProvisionedProducts.go +++ b/service/servicecatalog/api_op_SearchProvisionedProducts.go @@ -32,20 +32,19 @@ func (c *Client) SearchProvisionedProducts(ctx context.Context, params *SearchPr type SearchProvisionedProductsInput struct { // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // The access level to use to obtain results. The default is User. + // The access level to use to obtain results. The default is User . AccessLevelFilter *types.AccessLevelFilter - // The search filters. When the key is SearchQuery, the searchable fields are arn, - // createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, - // provisioningArtifact, type, status, tags, userArn, userArnSession, - // lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and - // provisioningArtifactName. Example: "SearchQuery":["status:AVAILABLE"] + // The search filters. When the key is SearchQuery , the searchable fields are arn + // , createdTime , id , lastRecordId , idempotencyToken , name , physicalId , + // productId , provisioningArtifact , type , status , tags , userArn , + // userArnSession , lastProvisioningRecordId , lastSuccessfulProvisioningRecordId , + // productName , and provisioningArtifactName . Example: + // "SearchQuery":["status:AVAILABLE"] Filters map[string][]string // The maximum number of items to return with this call. @@ -56,7 +55,7 @@ type SearchProvisionedProductsInput struct { PageToken *string // The sort field. If no value is specified, the results are not sorted. The valid - // values are arn, id, name, and lastRecordId. + // values are arn , id , name , and lastRecordId . SortBy *string // The sort order. If no value is specified, the results are not sorted. diff --git a/service/servicecatalog/api_op_TerminateProvisionedProduct.go b/service/servicecatalog/api_op_TerminateProvisionedProduct.go index d96a1db5bc1..3b72827ed01 100644 --- a/service/servicecatalog/api_op_TerminateProvisionedProduct.go +++ b/service/servicecatalog/api_op_TerminateProvisionedProduct.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Terminates the specified provisioned product. This operation does not delete any -// records associated with the provisioned product. You can check the status of -// this request using DescribeRecord. +// Terminates the specified provisioned product. This operation does not delete +// any records associated with the provisioned product. You can check the status of +// this request using DescribeRecord . func (c *Client) TerminateProvisionedProduct(ctx context.Context, params *TerminateProvisionedProductInput, optFns ...func(*Options)) (*TerminateProvisionedProductOutput, error) { if params == nil { params = &TerminateProvisionedProductInput{} @@ -41,22 +41,20 @@ type TerminateProvisionedProductInput struct { TerminateToken *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // If set to true, Service Catalog stops managing the specified provisioned product - // even if it cannot delete the underlying resources. + // If set to true, Service Catalog stops managing the specified provisioned + // product even if it cannot delete the underlying resources. IgnoreErrors bool // The identifier of the provisioned product. You cannot specify both - // ProvisionedProductName and ProvisionedProductId. + // ProvisionedProductName and ProvisionedProductId . ProvisionedProductId *string // The name of the provisioned product. You cannot specify both - // ProvisionedProductName and ProvisionedProductId. + // ProvisionedProductName and ProvisionedProductId . ProvisionedProductName *string // When this boolean parameter is set to true, the TerminateProvisionedProduct API diff --git a/service/servicecatalog/api_op_UpdateConstraint.go b/service/servicecatalog/api_op_UpdateConstraint.go index 796c4edb543..7de8a93f3d9 100644 --- a/service/servicecatalog/api_op_UpdateConstraint.go +++ b/service/servicecatalog/api_op_UpdateConstraint.go @@ -35,10 +35,8 @@ type UpdateConstraintInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The updated description of the constraint. @@ -48,27 +46,27 @@ type UpdateConstraintInput struct { // type as follows: LAUNCH You are required to specify either the RoleArn or the // LocalRoleName but can't use both. Specify the RoleArn property as follows: // {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"} Specify the - // LocalRoleName property as follows: {"LocalRoleName": "SCBasicLaunchRole"} If you - // specify the LocalRoleName property, when an account uses the launch constraint, - // the IAM role with that name in the account will be used. This allows launch-role - // constraints to be account-agnostic so the administrator can create fewer - // resources per shared account. The given role name must exist in the account used - // to create the launch constraint and the account of the user who launches a - // product with this launch constraint. You cannot have both a LAUNCH and a - // STACKSET constraint. You also cannot have more than one LAUNCH constraint on a - // product and portfolio. NOTIFICATION Specify the NotificationArns property as - // follows: {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} + // LocalRoleName property as follows: {"LocalRoleName": "SCBasicLaunchRole"} If + // you specify the LocalRoleName property, when an account uses the launch + // constraint, the IAM role with that name in the account will be used. This allows + // launch-role constraints to be account-agnostic so the administrator can create + // fewer resources per shared account. The given role name must exist in the + // account used to create the launch constraint and the account of the user who + // launches a product with this launch constraint. You cannot have both a LAUNCH + // and a STACKSET constraint. You also cannot have more than one LAUNCH constraint + // on a product and portfolio. NOTIFICATION Specify the NotificationArns property + // as follows: {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} // RESOURCE_UPDATE Specify the TagUpdatesOnProvisionedProduct property as follows: // {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}} The // TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or - // NOT_ALLOWED. STACKSET Specify the Parameters property as follows: {"Version": + // NOT_ALLOWED . STACKSET Specify the Parameters property as follows: {"Version": // "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" // ], "AdminRole": "String", "ExecutionRole": "String"}} You cannot have both a // LAUNCH and a STACKSET constraint. You also cannot have more than one STACKSET // constraint on a product and portfolio. Products with a STACKSET constraint will // launch an CloudFormation stack set. TEMPLATE Specify the Rules property. For - // more information, see Template Constraint Rules - // (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html). + // more information, see Template Constraint Rules (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html) + // . Parameters *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_UpdatePortfolio.go b/service/servicecatalog/api_op_UpdatePortfolio.go index 464f52de8c1..18bc5e560d2 100644 --- a/service/servicecatalog/api_op_UpdatePortfolio.go +++ b/service/servicecatalog/api_op_UpdatePortfolio.go @@ -36,10 +36,8 @@ type UpdatePortfolioInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The tags to add. diff --git a/service/servicecatalog/api_op_UpdatePortfolioShare.go b/service/servicecatalog/api_op_UpdatePortfolioShare.go index 5beb6a3ffce..b05fb917706 100644 --- a/service/servicecatalog/api_op_UpdatePortfolioShare.go +++ b/service/servicecatalog/api_op_UpdatePortfolioShare.go @@ -11,24 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified portfolio share. You can use this API to enable or disable -// TagOptions sharing or Principal sharing for an existing portfolio share. The -// portfolio share cannot be updated if the CreatePortfolioShare operation is -// IN_PROGRESS, as the share is not available to recipient entities. In this case, -// you must wait for the portfolio share to be COMPLETED. You must provide the -// accountId or organization node in the input, but not both. If the portfolio is -// shared to both an external account and an organization node, and both shares -// need to be updated, you must invoke UpdatePortfolioShare separately for each -// share type. This API cannot be used for removing the portfolio share. You must -// use DeletePortfolioShare API for that action. When you associate a principal -// with portfolio, a potential privilege escalation path may occur when that -// portfolio is then shared with other accounts. For a user in a recipient account -// who is not an Service Catalog Admin, but still has the ability to create +// Updates the specified portfolio share. You can use this API to enable or +// disable TagOptions sharing or Principal sharing for an existing portfolio +// share. The portfolio share cannot be updated if the CreatePortfolioShare +// operation is IN_PROGRESS , as the share is not available to recipient entities. +// In this case, you must wait for the portfolio share to be COMPLETED. You must +// provide the accountId or organization node in the input, but not both. If the +// portfolio is shared to both an external account and an organization node, and +// both shares need to be updated, you must invoke UpdatePortfolioShare separately +// for each share type. This API cannot be used for removing the portfolio share. +// You must use DeletePortfolioShare API for that action. When you associate a +// principal with portfolio, a potential privilege escalation path may occur when +// that portfolio is then shared with other accounts. For a user in a recipient +// account who is not an Service Catalog Admin, but still has the ability to create // Principals (Users/Groups/Roles), that user could create a role that matches a // principal name association for the portfolio. Although this user may not know // which principal names are associated through Service Catalog, they may be able // to guess the user. If this potential escalation path is a concern, then Service -// Catalog recommends using PrincipalType as IAM. With this configuration, the +// Catalog recommends using PrincipalType as IAM . With this configuration, the // PrincipalARN must already exist in the recipient account before it can be // associated. func (c *Client) UpdatePortfolioShare(ctx context.Context, params *UpdatePortfolioShareInput, optFns ...func(*Options)) (*UpdatePortfolioShareOutput, error) { @@ -54,10 +54,8 @@ type UpdatePortfolioShareInput struct { PortfolioId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The Amazon Web Services account Id of the recipient account. This field is @@ -67,13 +65,13 @@ type UpdatePortfolioShareInput struct { // Information about the organization node. OrganizationNode *types.OrganizationNode - // A flag to enables or disables Principals sharing in the portfolio. If this field - // is not provided, the current state of the Principals sharing on the portfolio - // share will not be modified. + // A flag to enables or disables Principals sharing in the portfolio. If this + // field is not provided, the current state of the Principals sharing on the + // portfolio share will not be modified. SharePrincipals *bool - // Enables or disables TagOptions sharing for the portfolio share. If this field is - // not provided, the current state of TagOptions sharing on the portfolio share + // Enables or disables TagOptions sharing for the portfolio share. If this field + // is not provided, the current state of TagOptions sharing on the portfolio share // will not be modified. ShareTagOptions *bool diff --git a/service/servicecatalog/api_op_UpdateProduct.go b/service/servicecatalog/api_op_UpdateProduct.go index 21b8b751cbf..78e89ea0cbf 100644 --- a/service/servicecatalog/api_op_UpdateProduct.go +++ b/service/servicecatalog/api_op_UpdateProduct.go @@ -35,10 +35,8 @@ type UpdateProductInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The tags to add to the product. @@ -63,10 +61,8 @@ type UpdateProductInput struct { // the connection source artifact. This automatically manages the product's // artifacts based on changes to the source. The SourceConnection parameter // consists of the following sub-fields. - // - // * Type - // - // * ConnectionParamters + // - Type + // - ConnectionParamters SourceConnection *types.SourceConnection // The updated support description for the product. diff --git a/service/servicecatalog/api_op_UpdateProvisionedProduct.go b/service/servicecatalog/api_op_UpdateProvisionedProduct.go index 60785d4885b..bf47fa5150a 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProduct.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProduct.go @@ -16,7 +16,7 @@ import ( // there are tags associated with the object, they cannot be updated or added. // Depending on the specific updates requested, this operation can update with no // interruption, with some interruption, or replace the provisioned product -// entirely. You can check the status of this request using DescribeRecord. +// entirely. You can check the status of this request using DescribeRecord . func (c *Client) UpdateProvisionedProduct(ctx context.Context, params *UpdateProvisionedProductInput, optFns ...func(*Options)) (*UpdateProvisionedProductOutput, error) { if params == nil { params = &UpdateProvisionedProductInput{} @@ -40,10 +40,8 @@ type UpdateProvisionedProductInput struct { UpdateToken *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // The path identifier. This value is optional if the product has a default path, @@ -65,7 +63,7 @@ type UpdateProvisionedProductInput struct { ProvisionedProductId *string // The name of the provisioned product. You cannot specify both - // ProvisionedProductName and ProvisionedProductId. + // ProvisionedProductName and ProvisionedProductId . ProvisionedProductName *string // The identifier of the provisioning artifact. diff --git a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go index b4256909473..507c387092a 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go @@ -45,8 +45,8 @@ type UpdateProvisionedProductPropertiesInput struct { // LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call // UpdateProvisionedProductProperties to update the launch role that is associated // with a provisioned product. This role is used when an end user calls a - // provisioning operation such as UpdateProvisionedProduct, - // TerminateProvisionedProduct, or ExecuteProvisionedProductServiceAction. Only a + // provisioning operation such as UpdateProvisionedProduct , + // TerminateProvisionedProduct , or ExecuteProvisionedProductServiceAction . Only a // role ARN is valid. A user ARN is invalid. The OWNER key accepts user ARNs, IAM // role ARNs, and STS assumed-role ARNs. The owner is the user that has permission // to see, update, terminate, and execute service actions in the provisioned @@ -55,8 +55,8 @@ type UpdateProvisionedProductPropertiesInput struct { // administrators can see ownership history of the provisioned product using the // ListRecordHistory API. The new owner can describe all past records for the // provisioned product using the DescribeRecord API. The previous owner can no - // longer use DescribeRecord, but can still see the product's history from when he - // was an owner using ListRecordHistory. If a provisioned product ownership is + // longer use DescribeRecord , but can still see the product's history from when he + // was an owner using ListRecordHistory . If a provisioned product ownership is // assigned to an end user, they can see and perform any action through the API or // Service Catalog console such as update, terminate, and execute service actions. // If an end user provisions a product and the owner is updated to someone else, @@ -67,10 +67,8 @@ type UpdateProvisionedProductPropertiesInput struct { ProvisionedProductProperties map[string]string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go index 7d449aec590..2b1cd9d111d 100644 --- a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go @@ -42,15 +42,13 @@ type UpdateProvisioningArtifactInput struct { ProvisioningArtifactId *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string - // Indicates whether the product version is active. Inactive provisioning artifacts - // are invisible to end users. End users cannot launch or update a provisioned - // product from an inactive provisioning artifact. + // Indicates whether the product version is active. Inactive provisioning + // artifacts are invisible to end users. End users cannot launch or update a + // provisioned product from an inactive provisioning artifact. Active *bool // The updated description of the provisioning artifact. diff --git a/service/servicecatalog/api_op_UpdateServiceAction.go b/service/servicecatalog/api_op_UpdateServiceAction.go index 9f7d540091a..b2b17e584cc 100644 --- a/service/servicecatalog/api_op_UpdateServiceAction.go +++ b/service/servicecatalog/api_op_UpdateServiceAction.go @@ -35,10 +35,8 @@ type UpdateServiceActionInput struct { Id *string // The language code. - // - // * jp - Japanese - // - // * zh - Chinese + // - jp - Japanese + // - zh - Chinese AcceptLanguage *string // A map that defines the self-service action. diff --git a/service/servicecatalog/doc.go b/service/servicecatalog/doc.go index cf6d375dac1..399b3f6d081 100644 --- a/service/servicecatalog/doc.go +++ b/service/servicecatalog/doc.go @@ -6,6 +6,6 @@ // Service Catalog Service Catalog (http://aws.amazon.com/servicecatalog) enables // organizations to create and manage catalogs of IT services that are approved for // Amazon Web Services. To get the most out of this documentation, you should be -// familiar with the terminology discussed in Service Catalog Concepts -// (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html). +// familiar with the terminology discussed in Service Catalog Concepts (http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html) +// . package servicecatalog diff --git a/service/servicecatalog/types/enums.go b/service/servicecatalog/types/enums.go index c7142ba928a..877d4f2e7c6 100644 --- a/service/servicecatalog/types/enums.go +++ b/service/servicecatalog/types/enums.go @@ -31,9 +31,9 @@ const ( AccessStatusDisabled AccessStatus = "DISABLED" ) -// Values returns all known values for AccessStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AccessStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AccessStatus) Values() []AccessStatus { return []AccessStatus{ "ENABLED", @@ -51,9 +51,9 @@ const ( ChangeActionRemove ChangeAction = "REMOVE" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "ADD", @@ -340,9 +340,10 @@ const ( ProvisionedProductPlanStatusExecuteFailed ProvisionedProductPlanStatus = "EXECUTE_FAILED" ) -// Values returns all known values for ProvisionedProductPlanStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProvisionedProductPlanStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ProvisionedProductPlanStatus) Values() []ProvisionedProductPlanStatus { return []ProvisionedProductPlanStatus{ "CREATE_IN_PROGRESS", @@ -381,9 +382,9 @@ const ( ProvisionedProductStatusPlanInProgress ProvisionedProductStatus = "PLAN_IN_PROGRESS" ) -// Values returns all known values for ProvisionedProductStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProvisionedProductStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedProductStatus) Values() []ProvisionedProductStatus { return []ProvisionedProductStatus{ "AVAILABLE", @@ -419,9 +420,10 @@ const ( ProvisioningArtifactGuidanceDeprecated ProvisioningArtifactGuidance = "DEPRECATED" ) -// Values returns all known values for ProvisioningArtifactGuidance. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProvisioningArtifactGuidance. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ProvisioningArtifactGuidance) Values() []ProvisioningArtifactGuidance { return []ProvisioningArtifactGuidance{ "DEFAULT", @@ -456,9 +458,9 @@ const ( ProvisioningArtifactTypeTerraformOpenSource ProvisioningArtifactType = "TERRAFORM_OPEN_SOURCE" ) -// Values returns all known values for ProvisioningArtifactType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ProvisioningArtifactType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisioningArtifactType) Values() []ProvisioningArtifactType { return []ProvisioningArtifactType{ "CLOUD_FORMATION_TEMPLATE", @@ -479,9 +481,9 @@ const ( RecordStatusFailed RecordStatus = "FAILED" ) -// Values returns all known values for RecordStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecordStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RecordStatus) Values() []RecordStatus { return []RecordStatus{ "CREATED", @@ -570,8 +572,8 @@ const ( ServiceActionAssociationErrorCodeInvalidParameterException ServiceActionAssociationErrorCode = "INVALID_PARAMETER" ) -// Values returns all known values for ServiceActionAssociationErrorCode. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for ServiceActionAssociationErrorCode. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (ServiceActionAssociationErrorCode) Values() []ServiceActionAssociationErrorCode { @@ -655,9 +657,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -710,8 +712,8 @@ const ( StackSetOperationTypeDelete StackSetOperationType = "DELETE" ) -// Values returns all known values for StackSetOperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StackSetOperationType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StackSetOperationType) Values() []StackSetOperationType { return []StackSetOperationType{ diff --git a/service/servicecatalog/types/types.go b/service/servicecatalog/types/types.go index 8918e4daed8..c5c49638b36 100644 --- a/service/servicecatalog/types/types.go +++ b/service/servicecatalog/types/types.go @@ -11,17 +11,12 @@ import ( type AccessLevelFilter struct { // The access level. - // - // * Account - Filter results based on the account. - // - // * Role - - // Filter results based on the federated role of the specified user. - // - // * User - - // Filter results based on the specified user. + // - Account - Filter results based on the account. + // - Role - Filter results based on the federated role of the specified user. + // - User - Filter results based on the specified user. Key AccessLevelFilterKey - // The user to which the access level applies. The only supported value is Self. + // The user to which the access level applies. The only supported value is Self . Value *string noSmithyDocumentSerde @@ -45,7 +40,7 @@ type CloudWatchDashboard struct { noSmithyDocumentSerde } -// The subtype containing details about the Codestar connection Type. +// The subtype containing details about the Codestar connection Type . type CodeStarParameters struct { // The absolute path wehre the artifact resides within the repo and branch, @@ -95,14 +90,10 @@ type ConstraintDetail struct { ProductId *string // The type of constraint. - // - // * LAUNCH - // - // * NOTIFICATION - // - // * STACKSET - // - // * TEMPLATE + // - LAUNCH + // - NOTIFICATION + // - STACKSET + // - TEMPLATE Type *string noSmithyDocumentSerde @@ -115,14 +106,10 @@ type ConstraintSummary struct { Description *string // The type of constraint. - // - // * LAUNCH - // - // * NOTIFICATION - // - // * STACKSET - // - // * TEMPLATE + // - LAUNCH + // - NOTIFICATION + // - STACKSET + // - TEMPLATE Type *string noSmithyDocumentSerde @@ -164,13 +151,13 @@ type FailedServiceActionAssociation struct { // A text description of the error. ErrorMessage *string - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . ProvisioningArtifactId *string - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . ServiceActionId *string noSmithyDocumentSerde @@ -178,17 +165,11 @@ type FailedServiceActionAssociation struct { // Provides details about the product's connection sync and contains the following // sub-fields. -// -// * LastSyncTime -// -// * LastSyncStatus -// -// * LastSyncStatusMessage -// -// * -// LastSuccessfulSyncTime -// -// * LastSuccessfulSyncProvisioningArtifactID +// - LastSyncTime +// - LastSyncStatus +// - LastSyncStatusMessage +// - LastSuccessfulSyncTime +// - LastSuccessfulSyncProvisioningArtifactID type LastSync struct { // The ProvisioningArtifactID of the ProvisioningArtifact created from the latest @@ -199,7 +180,7 @@ type LastSync struct { // Service Catalog product. LastSuccessfulSyncTime *time.Time - // The current status of the sync. Responses include SUCCEEDED or FAILED. + // The current status of the sync. Responses include SUCCEEDED or FAILED . LastSyncStatus LastSyncStatus // The sync's status message. @@ -246,12 +227,9 @@ type LaunchPathSummary struct { type ListRecordHistorySearchFilter struct { // The filter key. - // - // * product - Filter results based on the specified product - // identifier. - // - // * provisionedproduct - Filter results based on the provisioned - // product identifier. + // - product - Filter results based on the specified product identifier. + // - provisionedproduct - Filter results based on the provisioned product + // identifier. Key *string // The filter value. @@ -319,8 +297,8 @@ type ParameterConstraints struct { // allow for String types. MinLength *string - // A numeric value that determines the smallest numeric value you want to allow for - // Number types. + // A numeric value that determines the smallest numeric value you want to allow + // for Number types. MinValue *string noSmithyDocumentSerde @@ -381,11 +359,11 @@ type PortfolioShareDetail struct { type Principal struct { // The ARN of the principal (user, role, or group). This field allows for an ARN - // with no accountID if the PrincipalType is an IAM_PATTERN. + // with no accountID if the PrincipalType is an IAM_PATTERN . PrincipalARN *string // The principal type. The supported value is IAM if you use a fully defined ARN, - // or IAM_PATTERN if you use an ARN with no accountID. + // or IAM_PATTERN if you use an ARN with no accountID . PrincipalType PrincipalType noSmithyDocumentSerde @@ -417,21 +395,16 @@ type ProductViewDetail struct { ProductViewSummary *ProductViewSummary // A top level ProductViewDetail response containing details about the product’s - // connection. Service Catalog returns this field for the CreateProduct, - // UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This + // connection. Service Catalog returns this field for the CreateProduct , + // UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This // response contains the same fields as the ConnectionParameters request, with the // addition of the LastSync response. SourceConnection *SourceConnectionDetail // The status of the product. - // - // * AVAILABLE - The product is ready for use. - // - // * - // CREATING - Product creation has started; the product is not ready for use. - // - // * - // FAILED - An action failed. + // - AVAILABLE - The product is ready for use. + // - CREATING - Product creation has started; the product is not ready for use. + // - FAILED - An action failed. Status Status noSmithyDocumentSerde @@ -444,10 +417,10 @@ type ProductViewSummary struct { // significance of this value. Distributor *string - // Indicates whether the product has a default path. If the product does not have a - // default path, call ListLaunchPaths to disambiguate between paths. Otherwise, + // Indicates whether the product has a default path. If the product does not have + // a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, // ListLaunchPaths is not required, and the output of ProductViewSummary can be - // used directly with DescribeProvisioningParameters. + // used directly with DescribeProvisioningParameters . HasDefaultPath bool // The product view identifier. @@ -456,8 +429,8 @@ type ProductViewSummary struct { // The name of the product. Name *string - // The owner of the product. Contact the product administrator for the significance - // of this value. + // The owner of the product. Contact the product administrator for the + // significance of this value. Owner *string // The product identifier. @@ -475,8 +448,8 @@ type ProductViewSummary struct { // The URL information to obtain support for this Product. SupportUrl *string - // The product type. Contact the product administrator for the significance of this - // value. If this value is MARKETPLACE, the product was created by Amazon Web + // The product type. Contact the product administrator for the significance of + // this value. If this value is MARKETPLACE , the product was created by Amazon Web // Services Marketplace. Type ProductType @@ -495,22 +468,17 @@ type ProvisionedProductAttribute struct { // The identifier of the provisioned product. Id *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. IdempotencyToken *string // The record identifier of the last request performed on this provisioned product // of the following types: - // - // * ProvisionedProduct - // - // * UpdateProvisionedProduct - // - // * - // ExecuteProvisionedProductPlan - // - // * TerminateProvisionedProduct + // - ProvisionedProduct + // - UpdateProvisionedProduct + // - ExecuteProvisionedProductPlan + // - TerminateProvisionedProduct LastProvisioningRecordId *string // The record identifier of the last request performed on this provisioned product. @@ -518,16 +486,10 @@ type ProvisionedProductAttribute struct { // The record identifier of the last successful request performed on this // provisioned product of the following types: - // - // * ProvisionedProduct - // - // * - // UpdateProvisionedProduct - // - // * ExecuteProvisionedProductPlan - // - // * - // TerminateProvisionedProduct + // - ProvisionedProduct + // - UpdateProvisionedProduct + // - ExecuteProvisionedProductPlan + // - TerminateProvisionedProduct LastSuccessfulProvisioningRecordId *string // The user-friendly name of the provisioned product. @@ -550,29 +512,21 @@ type ProvisionedProductAttribute struct { ProvisioningArtifactName *string // The current status of the provisioned product. - // - // * AVAILABLE - Stable state, - // ready to perform any operation. The most recent operation succeeded and - // completed. - // - // * UNDER_CHANGE - Transitive state. Operations performed might not - // have valid results. Wait for an AVAILABLE status before performing - // operations. - // - // * TAINTED - Stable state, ready to perform any operation. The stack - // has completed the requested operation but is not exactly what was requested. For - // example, a request to update to a new version failed and the stack rolled back - // to the current version. - // - // * ERROR - An unexpected error occurred. The provisioned - // product exists but the stack is not running. For example, CloudFormation - // received a parameter value that was not valid and could not launch the stack. - // - // * - // PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to - // provision a new product, but resources have not yet been created. After - // reviewing the list of resources to be created, execute the plan. Wait for an - // AVAILABLE status before performing operations. + // - AVAILABLE - Stable state, ready to perform any operation. The most recent + // operation succeeded and completed. + // - UNDER_CHANGE - Transitive state. Operations performed might not have valid + // results. Wait for an AVAILABLE status before performing operations. + // - TAINTED - Stable state, ready to perform any operation. The stack has + // completed the requested operation but is not exactly what was requested. For + // example, a request to update to a new version failed and the stack rolled back + // to the current version. + // - ERROR - An unexpected error occurred. The provisioned product exists but the + // stack is not running. For example, CloudFormation received a parameter value + // that was not valid and could not launch the stack. + // - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to + // provision a new product, but resources have not yet been created. After + // reviewing the list of resources to be created, execute the plan. Wait for an + // AVAILABLE status before performing operations. Status ProvisionedProductStatus // The current status message of the provisioned product. @@ -582,7 +536,7 @@ type ProvisionedProductAttribute struct { Tags []Tag // The type of provisioned product. The supported values are CFN_STACK and - // CFN_STACKSET. + // CFN_STACKSET . Type *string // The Amazon Resource Name (ARN) of the user. @@ -606,22 +560,17 @@ type ProvisionedProductDetail struct { // The identifier of the provisioned product. Id *string - // A unique identifier that you provide to ensure idempotency. If multiple requests - // differ only by the idempotency token, the same response is returned for each - // repeated request. + // A unique identifier that you provide to ensure idempotency. If multiple + // requests differ only by the idempotency token, the same response is returned for + // each repeated request. IdempotencyToken *string // The record identifier of the last request performed on this provisioned product // of the following types: - // - // * ProvisionedProduct - // - // * UpdateProvisionedProduct - // - // * - // ExecuteProvisionedProductPlan - // - // * TerminateProvisionedProduct + // - ProvisionedProduct + // - UpdateProvisionedProduct + // - ExecuteProvisionedProductPlan + // - TerminateProvisionedProduct LastProvisioningRecordId *string // The record identifier of the last request performed on this provisioned product. @@ -629,16 +578,10 @@ type ProvisionedProductDetail struct { // The record identifier of the last successful request performed on this // provisioned product of the following types: - // - // * ProvisionedProduct - // - // * - // UpdateProvisionedProduct - // - // * ExecuteProvisionedProductPlan - // - // * - // TerminateProvisionedProduct + // - ProvisionedProduct + // - UpdateProvisionedProduct + // - ExecuteProvisionedProductPlan + // - TerminateProvisionedProduct LastSuccessfulProvisioningRecordId *string // The ARN of the launch role associated with the provisioned product. @@ -647,43 +590,35 @@ type ProvisionedProductDetail struct { // The user-friendly name of the provisioned product. Name *string - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . ProvisioningArtifactId *string // The current status of the provisioned product. - // - // * AVAILABLE - Stable state, - // ready to perform any operation. The most recent operation succeeded and - // completed. - // - // * UNDER_CHANGE - Transitive state. Operations performed might not - // have valid results. Wait for an AVAILABLE status before performing - // operations. - // - // * TAINTED - Stable state, ready to perform any operation. The stack - // has completed the requested operation but is not exactly what was requested. For - // example, a request to update to a new version failed and the stack rolled back - // to the current version. - // - // * ERROR - An unexpected error occurred. The provisioned - // product exists but the stack is not running. For example, CloudFormation - // received a parameter value that was not valid and could not launch the stack. - // - // * - // PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to - // provision a new product, but resources have not yet been created. After - // reviewing the list of resources to be created, execute the plan. Wait for an - // AVAILABLE status before performing operations. + // - AVAILABLE - Stable state, ready to perform any operation. The most recent + // operation succeeded and completed. + // - UNDER_CHANGE - Transitive state. Operations performed might not have valid + // results. Wait for an AVAILABLE status before performing operations. + // - TAINTED - Stable state, ready to perform any operation. The stack has + // completed the requested operation but is not exactly what was requested. For + // example, a request to update to a new version failed and the stack rolled back + // to the current version. + // - ERROR - An unexpected error occurred. The provisioned product exists but the + // stack is not running. For example, CloudFormation received a parameter value + // that was not valid and could not launch the stack. + // - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to + // provision a new product, but resources have not yet been created. After + // reviewing the list of resources to be created, execute the plan. Wait for an + // AVAILABLE status before performing operations. Status ProvisionedProductStatus // The current status message of the provisioned product. StatusMessage *string // The type of provisioned product. The supported values are CFN_STACK and - // CFN_STACKSET. + // CFN_STACKSET . Type *string noSmithyDocumentSerde @@ -701,7 +636,7 @@ type ProvisionedProductPlanDetails struct { // The path identifier of the product. This value is optional if the product has a // default path, and required if the product has more than one path. To list the - // paths for a product, use ListLaunchPaths. + // paths for a product, use ListLaunchPaths . PathId *string // The plan identifier. @@ -725,8 +660,8 @@ type ProvisionedProductPlanDetails struct { // The identifier of the provisioning artifact. ProvisioningArtifactId *string - // Parameters specified by the administrator that are required for provisioning the - // product. + // Parameters specified by the administrator that are required for provisioning + // the product. ProvisioningParameters []UpdateProvisioningParameter // The status. @@ -768,8 +703,8 @@ type ProvisionedProductPlanSummary struct { noSmithyDocumentSerde } -// Information about a provisioning artifact. A provisioning artifact is also known -// as a product version. +// Information about a provisioning artifact. A provisioning artifact is also +// known as a product version. type ProvisioningArtifact struct { // The UTC time stamp of the creation time. @@ -818,21 +753,16 @@ type ProvisioningArtifactDetail struct { // sync the Service Catalog product and create the provisioning artifact. Service // Catalog includes this response parameter as a high level field to the existing // ProvisioningArtifactDetail type, which is returned as part of the response for - // CreateProduct, UpdateProduct, DescribeProductAsAdmin, - // DescribeProvisioningArtifact, ListProvisioningArtifact, and + // CreateProduct , UpdateProduct , DescribeProductAsAdmin , + // DescribeProvisioningArtifact , ListProvisioningArtifact , and // UpdateProvisioningArticat APIs. This field only exists for Repo-Synced products. SourceRevision *string // The type of provisioning artifact. - // - // * CLOUD_FORMATION_TEMPLATE - CloudFormation - // template - // - // * MARKETPLACE_AMI - Amazon Web Services Marketplace AMI - // - // * - // MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web - // Services Resources + // - CLOUD_FORMATION_TEMPLATE - CloudFormation template + // - MARKETPLACE_AMI - Amazon Web Services Marketplace AMI + // - MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web + // Services Resources Type ProvisioningArtifactType noSmithyDocumentSerde @@ -859,8 +789,8 @@ type ProvisioningArtifactParameter struct { // The description of the parameter. Description *string - // If this value is true, the value for this parameter is obfuscated from view when - // the parameter is retrieved. This parameter is used to hide sensitive + // If this value is true, the value for this parameter is obfuscated from view + // when the parameter is retrieved. This parameter is used to hide sensitive // information. IsNoEcho bool @@ -877,25 +807,24 @@ type ProvisioningArtifactParameter struct { } // The user-defined preferences that will be applied during product provisioning, -// unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences. +// unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences . // For more information on maximum concurrent accounts and failure tolerance, see -// Stack set operation options -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) +// Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) // in the CloudFormation User Guide. type ProvisioningArtifactPreferences struct { - // One or more Amazon Web Services accounts where stack instances are deployed from - // the stack set. These accounts can be scoped in + // One or more Amazon Web Services accounts where stack instances are deployed + // from the stack set. These accounts can be scoped in // ProvisioningPreferences$StackSetAccounts and - // UpdateProvisioningPreferences$StackSetAccounts. Applicable only to a + // UpdateProvisioningPreferences$StackSetAccounts . Applicable only to a // CFN_STACKSET provisioned product type. StackSetAccounts []string // One or more Amazon Web Services Regions where stack instances are deployed from // the stack set. These Regions can be scoped in // ProvisioningPreferences$StackSetRegions and - // UpdateProvisioningPreferences$StackSetRegions. Applicable only to a CFN_STACKSET - // provisioned product type. + // UpdateProvisioningPreferences$StackSetRegions . Applicable only to a + // CFN_STACKSET provisioned product type. StackSetRegions []string noSmithyDocumentSerde @@ -914,13 +843,13 @@ type ProvisioningArtifactProperties struct { DisableTemplateValidation bool // Specify the template source with one of the following options, but not both. - // Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ] The URL of the + // Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ] The URL of the // CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL // in JSON format as follows: "LoadTemplateFromURL": - // "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."ImportFromPhysicalId: - // The physical id of the resource that contains the template. Currently only - // supports CloudFormation stack arn. Specify the physical id in JSON format as - // follows: ImportFromPhysicalId: + // "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." + // ImportFromPhysicalId : The physical id of the resource that contains the + // template. Currently only supports CloudFormation stack arn. Specify the physical + // id in JSON format as follows: ImportFromPhysicalId: // “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId] Info map[string]string @@ -929,18 +858,11 @@ type ProvisioningArtifactProperties struct { Name *string // The type of provisioning artifact. - // - // * CLOUD_FORMATION_TEMPLATE - CloudFormation - // template - // - // * MARKETPLACE_AMI - Amazon Web Services Marketplace AMI - // - // * - // MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web - // Services Resources - // - // * TERRAFORM_OPEN_SOURCE - Terraform open source - // configuration file + // - CLOUD_FORMATION_TEMPLATE - CloudFormation template + // - MARKETPLACE_AMI - Amazon Web Services Marketplace AMI + // - MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web + // Services Resources + // - TERRAFORM_OPEN_SOURCE - Terraform open source configuration file Type ProvisioningArtifactType noSmithyDocumentSerde @@ -976,8 +898,8 @@ type ProvisioningArtifactView struct { // Summary information about a product view. ProductViewSummary *ProductViewSummary - // Information about a provisioning artifact. A provisioning artifact is also known - // as a product version. + // Information about a provisioning artifact. A provisioning artifact is also + // known as a product version. ProvisioningArtifact *ProvisioningArtifact noSmithyDocumentSerde @@ -1000,9 +922,9 @@ type ProvisioningParameter struct { // or more Amazon Web Services accounts that will have access to the provisioned // product. Applicable only to a CFN_STACKSET provisioned product type. The Amazon // Web Services accounts specified should be within the list of accounts in the -// STACKSET constraint. To get the list of accounts in the STACKSET constraint, use -// the DescribeProvisioningParameters operation. If no values are specified, the -// default value is all accounts from the STACKSET constraint. +// STACKSET constraint. To get the list of accounts in the STACKSET constraint, +// use the DescribeProvisioningParameters operation. If no values are specified, +// the default value is all accounts from the STACKSET constraint. type ProvisioningPreferences struct { // One or more Amazon Web Services accounts where the provisioned product will be @@ -1018,7 +940,7 @@ type ProvisioningPreferences struct { // in a Region, Service Catalog doesn't attempt the operation in any subsequent // Regions. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetFailureToleranceCount or - // StackSetFailureTolerancePercentage, but not both. The default value is 0 if no + // StackSetFailureTolerancePercentage , but not both. The default value is 0 if no // value is specified. StackSetFailureToleranceCount *int32 @@ -1029,18 +951,18 @@ type ProvisioningPreferences struct { // specified percentage, Service Catalog rounds down to the next whole number. // Applicable only to a CFN_STACKSET provisioned product type. Conditional: You // must specify either StackSetFailureToleranceCount or - // StackSetFailureTolerancePercentage, but not both. + // StackSetFailureTolerancePercentage , but not both. StackSetFailureTolerancePercentage *int32 // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of StackSetFailureToleranceCount. + // This is dependent on the value of StackSetFailureToleranceCount . // StackSetMaxConcurrentCount is at most one more than the - // StackSetFailureToleranceCount. Note that this setting lets you specify the + // StackSetFailureToleranceCount . Note that this setting lets you specify the // maximum for operations. For large deployments, under certain circumstances the // actual number of accounts acted upon concurrently may be lower due to service // throttling. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. + // StackSetMaxConcurrentPercentage , but not both. StackSetMaxConcurrencyCount *int32 // The maximum percentage of accounts in which to perform this operation at one @@ -1052,7 +974,7 @@ type ProvisioningPreferences struct { // actual number of accounts acted upon concurrently may be lower due to service // throttling. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. + // StackSetMaxConcurrentPercentage , but not both. StackSetMaxConcurrencyPercentage *int32 // One or more Amazon Web Services Regions where the provisioned product will be @@ -1088,7 +1010,7 @@ type RecordDetail struct { ProvisionedProductName *string // The type of provisioned product. The supported values are CFN_STACK and - // CFN_STACKSET. + // CFN_STACKSET . ProvisionedProductType *string // The identifier of the provisioning artifact. @@ -1104,32 +1026,20 @@ type RecordDetail struct { RecordTags []RecordTag // The record type. - // - // * PROVISION_PRODUCT - // - // * UPDATE_PROVISIONED_PRODUCT - // - // * - // TERMINATE_PROVISIONED_PRODUCT + // - PROVISION_PRODUCT + // - UPDATE_PROVISIONED_PRODUCT + // - TERMINATE_PROVISIONED_PRODUCT RecordType *string // The status of the provisioned product. - // - // * CREATED - The request was created but - // the operation has not started. - // - // * IN_PROGRESS - The requested operation is in - // progress. - // - // * IN_PROGRESS_IN_ERROR - The provisioned product is under change but - // the requested operation failed and some remediation is occurring. For example, a - // rollback. - // - // * SUCCEEDED - The requested operation has successfully completed. - // - // * - // FAILED - The requested operation has unsuccessfully completed. Investigate using - // the error messages returned. + // - CREATED - The request was created but the operation has not started. + // - IN_PROGRESS - The requested operation is in progress. + // - IN_PROGRESS_IN_ERROR - The provisioned product is under change but the + // requested operation failed and some remediation is occurring. For example, a + // rollback. + // - SUCCEEDED - The requested operation has successfully completed. + // - FAILED - The requested operation has unsuccessfully completed. Investigate + // using the error messages returned. Status RecordStatus // The time when the record was last updated. @@ -1194,8 +1104,8 @@ type ResourceChange struct { // The ID of the resource, if it was already created. PhysicalResourceId *string - // If the change type is Modify, indicates whether the existing resource is deleted - // and replaced with a new one. + // If the change type is Modify , indicates whether the existing resource is + // deleted and replaced with a new one. Replacement Replacement // The type of resource. @@ -1251,11 +1161,11 @@ type ResourceTargetDefinition struct { // The attribute to be changed. Attribute ResourceAttribute - // If the attribute is Properties, the value is the name of the property. + // If the attribute is Properties , the value is the name of the property. // Otherwise, the value is null. Name *string - // If the attribute is Properties, indicates whether a change to this property + // If the attribute is Properties , indicates whether a change to this property // causes the resource to be re-created. RequiresRecreation RequiresRecreation @@ -1266,17 +1176,17 @@ type ResourceTargetDefinition struct { // and the Provisioning Artifact ID. type ServiceActionAssociation struct { - // The product identifier. For example, prod-abcdzk7xy33qa. + // The product identifier. For example, prod-abcdzk7xy33qa . // // This member is required. ProductId *string - // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. + // The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne . // // This member is required. ProvisioningArtifactId *string - // The self-service action identifier. For example, act-fs7abcd89wxyz. + // The self-service action identifier. For example, act-fs7abcd89wxyz . // // This member is required. ServiceActionId *string @@ -1299,7 +1209,7 @@ type ServiceActionDetail struct { // Detailed information about the self-service action. type ServiceActionSummary struct { - // The self-service action definition type. For example, SSM_AUTOMATION. + // The self-service action definition type. For example, SSM_AUTOMATION . DefinitionType ServiceActionDefinitionType // The self-service action description. @@ -1342,13 +1252,13 @@ type ShareError struct { } // A top level ProductViewDetail response containing details about the product’s -// connection. Service Catalog returns this field for the CreateProduct, -// UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This +// connection. Service Catalog returns this field for the CreateProduct , +// UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This // response contains the same fields as the ConnectionParameters request, with the // addition of the LastSync response. type SourceConnection struct { - // The connection details based on the connection Type. + // The connection details based on the connection Type . // // This member is required. ConnectionParameters *SourceConnectionParameters @@ -1359,25 +1269,19 @@ type SourceConnection struct { noSmithyDocumentSerde } -// Provides details about the configured SourceConnection. +// Provides details about the configured SourceConnection . type SourceConnectionDetail struct { - // The connection details based on the connection Type. + // The connection details based on the connection Type . ConnectionParameters *SourceConnectionParameters // Provides details about the product's connection sync and contains the following // sub-fields. - // - // * LastSyncTime - // - // * LastSyncStatus - // - // * LastSyncStatusMessage - // - // * - // LastSuccessfulSyncTime - // - // * LastSuccessfulSyncProvisioningArtifactID + // - LastSyncTime + // - LastSyncStatus + // - LastSyncStatusMessage + // - LastSuccessfulSyncTime + // - LastSuccessfulSyncProvisioningArtifactID LastSync *LastSync // The only supported SourceConnection type is Codestar. @@ -1408,27 +1312,22 @@ type StackInstance struct { // associated with. Account *string - // The name of the Amazon Web Services Region that the stack instance is associated - // with. + // The name of the Amazon Web Services Region that the stack instance is + // associated with. Region *string // The status of the stack instance, in terms of its synchronization with its // associated stack set. - // - // * INOPERABLE: A DeleteStackInstances operation has failed - // and left the stack in an unstable state. Stacks in this state are excluded from - // further UpdateStackSet operations. You might need to perform a - // DeleteStackInstances operation, with RetainStacks set to true, to delete the - // stack instance, and then delete the stack manually. - // - // * OUTDATED: The stack isn't - // currently up to date with the stack set because either the associated stack - // failed during a CreateStackSet or UpdateStackSet operation, or the stack was - // part of a CreateStackSet or UpdateStackSet operation that failed or was stopped - // before the stack was created or updated. - // - // * CURRENT: The stack is currently up - // to date with the stack set. + // - INOPERABLE : A DeleteStackInstances operation has failed and left the stack + // in an unstable state. Stacks in this state are excluded from further + // UpdateStackSet operations. You might need to perform a DeleteStackInstances + // operation, with RetainStacks set to true, to delete the stack instance, and + // then delete the stack manually. + // - OUTDATED : The stack isn't currently up to date with the stack set because + // either the associated stack failed during a CreateStackSet or UpdateStackSet + // operation, or the stack was part of a CreateStackSet or UpdateStackSet + // operation that failed or was stopped before the stack was created or updated. + // - CURRENT : The stack is currently up to date with the stack set. StackInstanceStatus StackInstanceStatus noSmithyDocumentSerde @@ -1518,9 +1417,9 @@ type UpdateProvisioningParameter struct { type UpdateProvisioningPreferences struct { // One or more Amazon Web Services accounts that will have access to the - // provisioned product. Applicable only to a CFN_STACKSET provisioned product type. - // The Amazon Web Services accounts specified should be within the list of accounts - // in the STACKSET constraint. To get the list of accounts in the STACKSET + // provisioned product. Applicable only to a CFN_STACKSET provisioned product + // type. The Amazon Web Services accounts specified should be within the list of + // accounts in the STACKSET constraint. To get the list of accounts in the STACKSET // constraint, use the DescribeProvisioningParameters operation. If no values are // specified, the default value is all accounts from the STACKSET constraint. StackSetAccounts []string @@ -1530,7 +1429,7 @@ type UpdateProvisioningPreferences struct { // in a Region, Service Catalog doesn't attempt the operation in any subsequent // Regions. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetFailureToleranceCount or - // StackSetFailureTolerancePercentage, but not both. The default value is 0 if no + // StackSetFailureTolerancePercentage , but not both. The default value is 0 if no // value is specified. StackSetFailureToleranceCount *int32 @@ -1541,18 +1440,18 @@ type UpdateProvisioningPreferences struct { // specified percentage, Service Catalog rounds down to the next whole number. // Applicable only to a CFN_STACKSET provisioned product type. Conditional: You // must specify either StackSetFailureToleranceCount or - // StackSetFailureTolerancePercentage, but not both. + // StackSetFailureTolerancePercentage , but not both. StackSetFailureTolerancePercentage *int32 // The maximum number of accounts in which to perform this operation at one time. - // This is dependent on the value of StackSetFailureToleranceCount. + // This is dependent on the value of StackSetFailureToleranceCount . // StackSetMaxConcurrentCount is at most one more than the - // StackSetFailureToleranceCount. Note that this setting lets you specify the + // StackSetFailureToleranceCount . Note that this setting lets you specify the // maximum for operations. For large deployments, under certain circumstances the // actual number of accounts acted upon concurrently may be lower due to service // throttling. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. + // StackSetMaxConcurrentPercentage , but not both. StackSetMaxConcurrencyCount *int32 // The maximum percentage of accounts in which to perform this operation at one @@ -1564,7 +1463,7 @@ type UpdateProvisioningPreferences struct { // actual number of accounts acted upon concurrently may be lower due to service // throttling. Applicable only to a CFN_STACKSET provisioned product type. // Conditional: You must specify either StackSetMaxConcurrentCount or - // StackSetMaxConcurrentPercentage, but not both. + // StackSetMaxConcurrentPercentage , but not both. StackSetMaxConcurrencyPercentage *int32 // Determines what action Service Catalog performs to a stack set or a stack diff --git a/service/servicecatalogappregistry/api_client.go b/service/servicecatalogappregistry/api_client.go index 8714c107c28..bdffc8e3e7b 100644 --- a/service/servicecatalogappregistry/api_client.go +++ b/service/servicecatalogappregistry/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go b/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go index 4271ecbc843..a43410d49a5 100644 --- a/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an attribute group, specified either by its attribute group ID, name, or -// ARN. +// Deletes an attribute group, specified either by its attribute group ID, name, +// or ARN. func (c *Client) DeleteAttributeGroup(ctx context.Context, params *DeleteAttributeGroupInput, optFns ...func(*Options)) (*DeleteAttributeGroupOutput, error) { if params == nil { params = &DeleteAttributeGroupInput{} diff --git a/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go b/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go index 6600649ddf2..3a72639b001 100644 --- a/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go @@ -12,7 +12,7 @@ import ( // Disassociates an attribute group from an application to remove the extra // attributes contained in the attribute group from the application's metadata. -// This operation reverts AssociateAttributeGroup. +// This operation reverts AssociateAttributeGroup . func (c *Client) DisassociateAttributeGroup(ctx context.Context, params *DisassociateAttributeGroupInput, optFns ...func(*Options)) (*DisassociateAttributeGroupOutput, error) { if params == nil { params = &DisassociateAttributeGroupInput{} diff --git a/service/servicecatalogappregistry/api_op_DisassociateResource.go b/service/servicecatalogappregistry/api_op_DisassociateResource.go index f39b5e23661..2541d62b9cb 100644 --- a/service/servicecatalogappregistry/api_op_DisassociateResource.go +++ b/service/servicecatalogappregistry/api_op_DisassociateResource.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a resource from application. Both the resource and the application -// can be specified either by ID or name. +// Disassociates a resource from application. Both the resource and the +// application can be specified either by ID or name. func (c *Client) DisassociateResource(ctx context.Context, params *DisassociateResourceInput, optFns ...func(*Options)) (*DisassociateResourceOutput, error) { if params == nil { params = &DisassociateResourceInput{} diff --git a/service/servicecatalogappregistry/api_op_GetAttributeGroup.go b/service/servicecatalogappregistry/api_op_GetAttributeGroup.go index 3bb29fb730f..c319f033195 100644 --- a/service/servicecatalogappregistry/api_op_GetAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_GetAttributeGroup.go @@ -11,8 +11,8 @@ import ( "time" ) -// Retrieves an attribute group by its ARN, ID, or name. The attribute group can be -// specified by its ARN, ID, or name. +// Retrieves an attribute group by its ARN, ID, or name. The attribute group can +// be specified by its ARN, ID, or name. func (c *Client) GetAttributeGroup(ctx context.Context, params *GetAttributeGroupInput, optFns ...func(*Options)) (*GetAttributeGroupOutput, error) { if params == nil { params = &GetAttributeGroupInput{} diff --git a/service/servicecatalogappregistry/api_op_ListAttributeGroups.go b/service/servicecatalogappregistry/api_op_ListAttributeGroups.go index a5184e71284..fbfde1d9062 100644 --- a/service/servicecatalogappregistry/api_op_ListAttributeGroups.go +++ b/service/servicecatalogappregistry/api_op_ListAttributeGroups.go @@ -114,8 +114,8 @@ func (c *Client) addOperationListAttributeGroupsMiddlewares(stack *middleware.St return nil } -// ListAttributeGroupsAPIClient is a client that implements the ListAttributeGroups -// operation. +// ListAttributeGroupsAPIClient is a client that implements the +// ListAttributeGroups operation. type ListAttributeGroupsAPIClient interface { ListAttributeGroups(context.Context, *ListAttributeGroupsInput, ...func(*Options)) (*ListAttributeGroupsOutput, error) } diff --git a/service/servicecatalogappregistry/types/enums.go b/service/servicecatalogappregistry/types/enums.go index 24a66c159c1..a6d72035d4b 100644 --- a/service/servicecatalogappregistry/types/enums.go +++ b/service/servicecatalogappregistry/types/enums.go @@ -36,9 +36,9 @@ const ( ResourceTypeResourceTagValue ResourceType = "RESOURCE_TAG_VALUE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "CFN_STACK", diff --git a/service/servicecatalogappregistry/types/types.go b/service/servicecatalogappregistry/types/types.go index 73f0932f9c0..068b66eac14 100644 --- a/service/servicecatalogappregistry/types/types.go +++ b/service/servicecatalogappregistry/types/types.go @@ -7,8 +7,8 @@ import ( "time" ) -// Represents a Amazon Web Services Service Catalog AppRegistry application that is -// the top-level node in a hierarchy of related cloud resource abstractions. +// Represents a Amazon Web Services Service Catalog AppRegistry application that +// is the top-level node in a hierarchy of related cloud resource abstractions. type Application struct { // The Amazon resource name (ARN) that specifies the application across services. @@ -66,7 +66,7 @@ type ApplicationSummary struct { // Includes all of the AppRegistry settings. type AppRegistryConfiguration struct { - // Includes the definition of a tagQuery. + // Includes the definition of a tagQuery . TagQueryConfiguration *TagQueryConfiguration noSmithyDocumentSerde @@ -116,7 +116,7 @@ type AttributeGroupDetails struct { Id *string // This field is no longer supported. We recommend you don't use the field when - // using ListAttributeGroupsForApplication. The name of the attribute group. + // using ListAttributeGroupsForApplication . The name of the attribute group. // // Deprecated: This field is deprecated. We recommend not using the field when // using ListAttributeGroupsForApplication. @@ -203,9 +203,9 @@ type ResourceGroup struct { // The state of the propagation process for the resource group. The states // includes: CREATING if the resource group is in the process of being created. - // CREATE_COMPLETE if the resource group was created successfully. CREATE_FAILED if - // the resource group failed to be created. UPDATING if the resource group is in - // the process of being updated. UPDATE_COMPLETE if the resource group updated + // CREATE_COMPLETE if the resource group was created successfully. CREATE_FAILED + // if the resource group failed to be created. UPDATING if the resource group is + // in the process of being updated. UPDATE_COMPLETE if the resource group updated // successfully. UPDATE_FAILED if the resource group could not update successfully. State ResourceGroupState @@ -239,7 +239,7 @@ type ResourceIntegrations struct { noSmithyDocumentSerde } -// The definition of tagQuery. Specifies which resources are associated with an +// The definition of tagQuery . Specifies which resources are associated with an // application. type TagQueryConfiguration struct { diff --git a/service/servicediscovery/api_client.go b/service/servicediscovery/api_client.go index aac103ec491..5ba41560655 100644 --- a/service/servicediscovery/api_client.go +++ b/service/servicediscovery/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/servicediscovery/api_op_CreateHttpNamespace.go b/service/servicediscovery/api_op_CreateHttpNamespace.go index 88b0537f28b..f63067b5357 100644 --- a/service/servicediscovery/api_op_CreateHttpNamespace.go +++ b/service/servicediscovery/api_op_CreateHttpNamespace.go @@ -15,9 +15,8 @@ import ( // Creates an HTTP namespace. Service instances registered using an HTTP namespace // can be discovered using a DiscoverInstances request but can't be discovered // using DNS. For the current quota on the number of namespaces that you can create -// using the same Amazon Web Services account, see Cloud Map quotas -// (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the -// Cloud Map Developer Guide. +// using the same Amazon Web Services account, see Cloud Map quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) +// in the Cloud Map Developer Guide. func (c *Client) CreateHttpNamespace(ctx context.Context, params *CreateHttpNamespaceInput, optFns ...func(*Options)) (*CreateHttpNamespaceOutput, error) { if params == nil { params = &CreateHttpNamespaceInput{} @@ -60,8 +59,8 @@ type CreateHttpNamespaceInput struct { type CreateHttpNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go b/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go index 227d2efdd66..bb12e03c9cd 100644 --- a/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go @@ -14,14 +14,13 @@ import ( // Creates a private namespace based on DNS, which is visible only inside a // specified Amazon VPC. The namespace defines your service naming scheme. For -// example, if you name your namespace example.com and name your service backend, -// the resulting DNS name for the service is backend.example.com. Service instances -// that are registered using a private DNS namespace can be discovered using either -// a DiscoverInstances request or using DNS. For the current quota on the number of -// namespaces that you can create using the same Amazon Web Services account, see -// Cloud Map quotas -// (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the -// Cloud Map Developer Guide. +// example, if you name your namespace example.com and name your service backend , +// the resulting DNS name for the service is backend.example.com . Service +// instances that are registered using a private DNS namespace can be discovered +// using either a DiscoverInstances request or using DNS. For the current quota on +// the number of namespaces that you can create using the same Amazon Web Services +// account, see Cloud Map quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) +// in the Cloud Map Developer Guide. func (c *Client) CreatePrivateDnsNamespace(ctx context.Context, params *CreatePrivateDnsNamespaceInput, optFns ...func(*Options)) (*CreatePrivateDnsNamespaceOutput, error) { if params == nil { params = &CreatePrivateDnsNamespaceInput{} @@ -74,8 +73,8 @@ type CreatePrivateDnsNamespaceInput struct { type CreatePrivateDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_CreatePublicDnsNamespace.go b/service/servicediscovery/api_op_CreatePublicDnsNamespace.go index 3e4ef152e15..e25c3c66c56 100644 --- a/service/servicediscovery/api_op_CreatePublicDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePublicDnsNamespace.go @@ -14,14 +14,13 @@ import ( // Creates a public namespace based on DNS, which is visible on the internet. The // namespace defines your service naming scheme. For example, if you name your -// namespace example.com and name your service backend, the resulting DNS name for -// the service is backend.example.com. You can discover instances that were +// namespace example.com and name your service backend , the resulting DNS name for +// the service is backend.example.com . You can discover instances that were // registered with a public DNS namespace by using either a DiscoverInstances // request or using DNS. For the current quota on the number of namespaces that you -// can create using the same Amazon Web Services account, see Cloud Map quotas -// (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the -// Cloud Map Developer Guide. The CreatePublicDnsNamespace API operation is not -// supported in the Amazon Web Services GovCloud (US) Regions. +// can create using the same Amazon Web Services account, see Cloud Map quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) +// in the Cloud Map Developer Guide. The CreatePublicDnsNamespace API operation is +// not supported in the Amazon Web Services GovCloud (US) Regions. func (c *Client) CreatePublicDnsNamespace(ctx context.Context, params *CreatePublicDnsNamespaceInput, optFns ...func(*Options)) (*CreatePublicDnsNamespaceOutput, error) { if params == nil { params = &CreatePublicDnsNamespaceInput{} @@ -68,8 +67,8 @@ type CreatePublicDnsNamespaceInput struct { type CreatePublicDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_CreateService.go b/service/servicediscovery/api_op_CreateService.go index 8314ac1de57..6afab78d2e1 100644 --- a/service/servicediscovery/api_op_CreateService.go +++ b/service/servicediscovery/api_op_CreateService.go @@ -14,26 +14,16 @@ import ( // Creates a service. This action defines the configuration for the following // entities: +// - For public and private DNS namespaces, one of the following combinations of +// DNS records in Amazon Route 53: +// - A +// - AAAA +// - A and AAAA +// - SRV +// - CNAME +// - Optionally, a health check // -// * For public and private DNS namespaces, one of the following -// combinations of DNS records in Amazon Route 53: -// -// * A -// -// * AAAA -// -// * A and AAAA -// -// * -// SRV -// -// * CNAME -// -// * Optionally, a health check -// -// After you create the service, you -// can submit a RegisterInstance -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) +// After you create the service, you can submit a RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) // request, and Cloud Map uses the values in the configuration to create the // specified entities. For the current quota on the number of instances that you // can register using the same namespace and using the same service, see Cloud Map @@ -59,23 +49,18 @@ type CreateServiceInput struct { // The name that you want to assign to the service. Do not include sensitive // information in the name if the namespace is discoverable by public DNS queries. // If you want Cloud Map to create an SRV record when you register an instance and - // you're using a system that requires a specific SRV format, such as HAProxy - // (http://www.haproxy.org/), specify the following for Name: - // - // * Start the name - // with an underscore (_), such as _exampleservice. - // - // * End the name with - // ._protocol, such as ._tcp. - // - // When you register an instance, Cloud Map creates an - // SRV record and assigns a name to the record by concatenating the service name - // and the namespace name (for example, _exampleservice._tcp.example.com). For - // services that are accessible by DNS queries, you can't create multiple services - // with names that differ only by case (such as EXAMPLE and example). Otherwise, - // these services have the same DNS name and can't be distinguished. However, if - // you use a namespace that's only accessible by API calls, then you can create - // services that with names that differ only by case. + // you're using a system that requires a specific SRV format, such as HAProxy (http://www.haproxy.org/) + // , specify the following for Name : + // - Start the name with an underscore (_), such as _exampleservice . + // - End the name with ._protocol, such as ._tcp . + // When you register an instance, Cloud Map creates an SRV record and assigns a + // name to the record by concatenating the service name and the namespace name (for + // example, _exampleservice._tcp.example.com ). For services that are accessible by + // DNS queries, you can't create multiple services with names that differ only by + // case (such as EXAMPLE and example). Otherwise, these services have the same DNS + // name and can't be distinguished. However, if you use a namespace that's only + // accessible by API calls, then you can create services that with names that + // differ only by case. // // This member is required. Name *string @@ -95,10 +80,10 @@ type CreateServiceInput struct { // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional Route 53 health check. If you specify settings for a health check, // Cloud Map associates the health check with all the Route 53 DNS records that you - // specify in DnsConfig. If you specify a health check configuration, you can + // specify in DnsConfig . If you specify a health check configuration, you can // specify either HealthCheckCustomConfig or HealthCheckConfig but not both. For - // information about the charges for health checks, see Cloud Map Pricing - // (http://aws.amazon.com/cloud-map/pricing/). + // information about the charges for health checks, see Cloud Map Pricing (http://aws.amazon.com/cloud-map/pricing/) + // . HealthCheckConfig *types.HealthCheckConfig // A complex type that contains information about an optional custom health check. @@ -113,14 +98,14 @@ type CreateServiceInput struct { // DnsConfig object. NamespaceId *string - // The tags to add to the service. Each tag consists of a key and an optional value - // that you define. Tags keys can be up to 128 characters in length, and tag values - // can be up to 256 characters in length. + // The tags to add to the service. Each tag consists of a key and an optional + // value that you define. Tags keys can be up to 128 characters in length, and tag + // values can be up to 256 characters in length. Tags []types.Tag - // If present, specifies that the service instances are only discoverable using the - // DiscoverInstances API operation. No DNS records is registered for the service - // instances. The only valid value is HTTP. + // If present, specifies that the service instances are only discoverable using + // the DiscoverInstances API operation. No DNS records is registered for the + // service instances. The only valid value is HTTP . Type types.ServiceTypeOption noSmithyDocumentSerde diff --git a/service/servicediscovery/api_op_DeleteNamespace.go b/service/servicediscovery/api_op_DeleteNamespace.go index f6f7109829f..e008037fb2a 100644 --- a/service/servicediscovery/api_op_DeleteNamespace.go +++ b/service/servicediscovery/api_op_DeleteNamespace.go @@ -40,8 +40,8 @@ type DeleteNamespaceInput struct { type DeleteNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_DeregisterInstance.go b/service/servicediscovery/api_op_DeregisterInstance.go index c46319ed837..f277b1e22e7 100644 --- a/service/servicediscovery/api_op_DeregisterInstance.go +++ b/service/servicediscovery/api_op_DeregisterInstance.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map -// created for the specified instance. +// Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud +// Map created for the specified instance. func (c *Client) DeregisterInstance(ctx context.Context, params *DeregisterInstanceInput, optFns ...func(*Options)) (*DeregisterInstanceOutput, error) { if params == nil { params = &DeregisterInstanceInput{} @@ -29,8 +29,7 @@ func (c *Client) DeregisterInstance(ctx context.Context, params *DeregisterInsta type DeregisterInstanceInput struct { - // The value that you specified for Id in the RegisterInstance - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) + // The value that you specified for Id in the RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) // request. // // This member is required. @@ -47,8 +46,8 @@ type DeregisterInstanceInput struct { type DeregisterInstanceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_DiscoverInstances.go b/service/servicediscovery/api_op_DiscoverInstances.go index 02f2fe3c487..c4b2929a92e 100644 --- a/service/servicediscovery/api_op_DiscoverInstances.go +++ b/service/servicediscovery/api_op_DiscoverInstances.go @@ -54,7 +54,7 @@ type DiscoverInstancesInput struct { // The maximum number of instances that you want Cloud Map to return in the // response to a DiscoverInstances request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 instances. + // MaxResults , Cloud Map returns up to 100 instances. MaxResults *int32 // Opportunistic filters to scope the results based on custom attributes. If there @@ -65,7 +65,7 @@ type DiscoverInstancesInput struct { OptionalParameters map[string]string // Filters to scope the results based on custom attributes for the instance (for - // example, {version=v1, az=1a}). Only instances that match all the specified + // example, {version=v1, az=1a} ). Only instances that match all the specified // key-value pairs are returned. QueryParameters map[string]string diff --git a/service/servicediscovery/api_op_GetInstancesHealthStatus.go b/service/servicediscovery/api_op_GetInstancesHealthStatus.go index 11a3986e3fc..7f3073492dc 100644 --- a/service/servicediscovery/api_op_GetInstancesHealthStatus.go +++ b/service/servicediscovery/api_op_GetInstancesHealthStatus.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more -// instances that are associated with a specified service. There's a brief delay -// between when you register an instance and when the health status for the +// Gets the current health status ( Healthy , Unhealthy , or Unknown ) of one or +// more instances that are associated with a specified service. There's a brief +// delay between when you register an instance and when the health status for the // instance is available. func (c *Client) GetInstancesHealthStatus(ctx context.Context, params *GetInstancesHealthStatusInput, optFns ...func(*Options)) (*GetInstancesHealthStatusOutput, error) { if params == nil { @@ -39,17 +39,16 @@ type GetInstancesHealthStatusInput struct { ServiceId *string // An array that contains the IDs of all the instances that you want to get the - // health status for. If you omit Instances, Cloud Map returns the health status + // health status for. If you omit Instances , Cloud Map returns the health status // for all the instances that are associated with the specified service. To get the // IDs for the instances that you've registered by using a specified service, - // submit a ListInstances - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html) + // submit a ListInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html) // request. Instances []string // The maximum number of instances that you want Cloud Map to return in the - // response to a GetInstancesHealthStatus request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 instances. + // response to a GetInstancesHealthStatus request. If you don't specify a value + // for MaxResults , Cloud Map returns up to 100 instances. MaxResults *int32 // For the first GetInstancesHealthStatus request, omit this value. If more than @@ -68,8 +67,8 @@ type GetInstancesHealthStatusOutput struct { // Specify the value of NextToken from the previous response in the next request. NextToken *string - // A complex type that contains the IDs and the health status of the instances that - // you specified in the GetInstancesHealthStatus request. + // A complex type that contains the IDs and the health status of the instances + // that you specified in the GetInstancesHealthStatus request. Status map[string]types.HealthStatus // Metadata pertaining to the operation's result. @@ -153,8 +152,8 @@ var _ GetInstancesHealthStatusAPIClient = (*Client)(nil) // GetInstancesHealthStatus type GetInstancesHealthStatusPaginatorOptions struct { // The maximum number of instances that you want Cloud Map to return in the - // response to a GetInstancesHealthStatus request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 instances. + // response to a GetInstancesHealthStatus request. If you don't specify a value + // for MaxResults , Cloud Map returns up to 100 instances. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicediscovery/api_op_GetOperation.go b/service/servicediscovery/api_op_GetOperation.go index 5ea5cfc6bd7..afa4064f0be 100644 --- a/service/servicediscovery/api_op_GetOperation.go +++ b/service/servicediscovery/api_op_GetOperation.go @@ -13,8 +13,8 @@ import ( // Gets information about any operation that returns an operation ID in the // response, such as a CreateService request. To get a list of operations that -// match specified criteria, see ListOperations -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html). +// match specified criteria, see ListOperations (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html) +// . func (c *Client) GetOperation(ctx context.Context, params *GetOperationInput, optFns ...func(*Options)) (*GetOperationOutput, error) { if params == nil { params = &GetOperationInput{} diff --git a/service/servicediscovery/api_op_ListInstances.go b/service/servicediscovery/api_op_ListInstances.go index ef0a1cc0211..3c210b757f9 100644 --- a/service/servicediscovery/api_op_ListInstances.go +++ b/service/servicediscovery/api_op_ListInstances.go @@ -37,8 +37,8 @@ type ListInstancesInput struct { ServiceId *string // The maximum number of instances that you want Cloud Map to return in the - // response to a ListInstances request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 instances. + // response to a ListInstances request. If you don't specify a value for MaxResults + // , Cloud Map returns up to 100 instances. MaxResults *int32 // For the first ListInstances request, omit this value. If more than MaxResults @@ -140,8 +140,8 @@ var _ ListInstancesAPIClient = (*Client)(nil) // ListInstancesPaginatorOptions is the paginator options for ListInstances type ListInstancesPaginatorOptions struct { // The maximum number of instances that you want Cloud Map to return in the - // response to a ListInstances request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 instances. + // response to a ListInstances request. If you don't specify a value for MaxResults + // , Cloud Map returns up to 100 instances. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicediscovery/api_op_ListNamespaces.go b/service/servicediscovery/api_op_ListNamespaces.go index a10299a511a..7a243deec8f 100644 --- a/service/servicediscovery/api_op_ListNamespaces.go +++ b/service/servicediscovery/api_op_ListNamespaces.go @@ -33,19 +33,19 @@ type ListNamespacesInput struct { // A complex type that contains specifications for the namespaces that you want to // list. If you specify more than one filter, a namespace must match all filters to - // be returned by ListNamespaces. + // be returned by ListNamespaces . Filters []types.NamespaceFilter // The maximum number of namespaces that you want Cloud Map to return in the // response to a ListNamespaces request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 namespaces. + // MaxResults , Cloud Map returns up to 100 namespaces. MaxResults *int32 // For the first ListNamespaces request, omit this value. If the response contains - // NextToken, submit another ListNamespaces request to get the next group of + // NextToken , submit another ListNamespaces request to get the next group of // results. Specify the value of NextToken from the previous response in the next - // request. Cloud Map gets MaxResults namespaces and then filters them based on the - // specified criteria. It's possible that no namespaces in the first MaxResults + // request. Cloud Map gets MaxResults namespaces and then filters them based on + // the specified criteria. It's possible that no namespaces in the first MaxResults // namespaces matched the specified criteria but that subsequent groups of // MaxResults namespaces do contain namespaces that match the criteria. NextToken *string @@ -59,8 +59,8 @@ type ListNamespacesOutput struct { // matches the specified filter criteria. Namespaces []types.NamespaceSummary - // If the response contains NextToken, submit another ListNamespaces request to get - // the next group of results. Specify the value of NextToken from the previous + // If the response contains NextToken , submit another ListNamespaces request to + // get the next group of results. Specify the value of NextToken from the previous // response in the next request. Cloud Map gets MaxResults namespaces and then // filters them based on the specified criteria. It's possible that no namespaces // in the first MaxResults namespaces matched the specified criteria but that @@ -149,7 +149,7 @@ var _ ListNamespacesAPIClient = (*Client)(nil) type ListNamespacesPaginatorOptions struct { // The maximum number of namespaces that you want Cloud Map to return in the // response to a ListNamespaces request. If you don't specify a value for - // MaxResults, Cloud Map returns up to 100 namespaces. + // MaxResults , Cloud Map returns up to 100 namespaces. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicediscovery/api_op_ListOperations.go b/service/servicediscovery/api_op_ListOperations.go index 76c05d478a1..cbbfc1814c4 100644 --- a/service/servicediscovery/api_op_ListOperations.go +++ b/service/servicediscovery/api_op_ListOperations.go @@ -33,19 +33,19 @@ type ListOperationsInput struct { // A complex type that contains specifications for the operations that you want to // list, for example, operations that you started between a specified start date // and end date. If you specify more than one filter, an operation must match all - // filters to be returned by ListOperations. + // filters to be returned by ListOperations . Filters []types.OperationFilter - // The maximum number of items that you want Cloud Map to return in the response to - // a ListOperations request. If you don't specify a value for MaxResults, Cloud Map - // returns up to 100 operations. + // The maximum number of items that you want Cloud Map to return in the response + // to a ListOperations request. If you don't specify a value for MaxResults , Cloud + // Map returns up to 100 operations. MaxResults *int32 // For the first ListOperations request, omit this value. If the response contains - // NextToken, submit another ListOperations request to get the next group of + // NextToken , submit another ListOperations request to get the next group of // results. Specify the value of NextToken from the previous response in the next - // request. Cloud Map gets MaxResults operations and then filters them based on the - // specified criteria. It's possible that no operations in the first MaxResults + // request. Cloud Map gets MaxResults operations and then filters them based on + // the specified criteria. It's possible that no operations in the first MaxResults // operations matched the specified criteria but that subsequent groups of // MaxResults operations do contain operations that match the criteria. NextToken *string @@ -55,8 +55,8 @@ type ListOperationsInput struct { type ListOperationsOutput struct { - // If the response contains NextToken, submit another ListOperations request to get - // the next group of results. Specify the value of NextToken from the previous + // If the response contains NextToken , submit another ListOperations request to + // get the next group of results. Specify the value of NextToken from the previous // response in the next request. Cloud Map gets MaxResults operations and then // filters them based on the specified criteria. It's possible that no operations // in the first MaxResults operations matched the specified criteria but that @@ -146,9 +146,9 @@ var _ ListOperationsAPIClient = (*Client)(nil) // ListOperationsPaginatorOptions is the paginator options for ListOperations type ListOperationsPaginatorOptions struct { - // The maximum number of items that you want Cloud Map to return in the response to - // a ListOperations request. If you don't specify a value for MaxResults, Cloud Map - // returns up to 100 operations. + // The maximum number of items that you want Cloud Map to return in the response + // to a ListOperations request. If you don't specify a value for MaxResults , Cloud + // Map returns up to 100 operations. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicediscovery/api_op_ListServices.go b/service/servicediscovery/api_op_ListServices.go index 21c8985dbb5..408ffeb174d 100644 --- a/service/servicediscovery/api_op_ListServices.go +++ b/service/servicediscovery/api_op_ListServices.go @@ -33,21 +33,21 @@ type ListServicesInput struct { // A complex type that contains specifications for the namespaces that you want to // list services for. If you specify more than one filter, an operation must match - // all filters to be returned by ListServices. + // all filters to be returned by ListServices . Filters []types.ServiceFilter - // The maximum number of services that you want Cloud Map to return in the response - // to a ListServices request. If you don't specify a value for MaxResults, Cloud - // Map returns up to 100 services. + // The maximum number of services that you want Cloud Map to return in the + // response to a ListServices request. If you don't specify a value for MaxResults + // , Cloud Map returns up to 100 services. MaxResults *int32 // For the first ListServices request, omit this value. If the response contains - // NextToken, submit another ListServices request to get the next group of results. - // Specify the value of NextToken from the previous response in the next request. - // Cloud Map gets MaxResults services and then filters them based on the specified - // criteria. It's possible that no services in the first MaxResults services - // matched the specified criteria but that subsequent groups of MaxResults services - // do contain services that match the criteria. + // NextToken , submit another ListServices request to get the next group of + // results. Specify the value of NextToken from the previous response in the next + // request. Cloud Map gets MaxResults services and then filters them based on the + // specified criteria. It's possible that no services in the first MaxResults + // services matched the specified criteria but that subsequent groups of MaxResults + // services do contain services that match the criteria. NextToken *string noSmithyDocumentSerde @@ -55,12 +55,13 @@ type ListServicesInput struct { type ListServicesOutput struct { - // If the response contains NextToken, submit another ListServices request to get + // If the response contains NextToken , submit another ListServices request to get // the next group of results. Specify the value of NextToken from the previous // response in the next request. Cloud Map gets MaxResults services and then // filters them based on the specified criteria. It's possible that no services in - // the first MaxResults services matched the specified criteria but that subsequent - // groups of MaxResults services do contain services that match the criteria. + // the first MaxResults services matched the specified criteria but that + // subsequent groups of MaxResults services do contain services that match the + // criteria. NextToken *string // An array that contains one ServiceSummary object for each service that matches @@ -145,9 +146,9 @@ var _ ListServicesAPIClient = (*Client)(nil) // ListServicesPaginatorOptions is the paginator options for ListServices type ListServicesPaginatorOptions struct { - // The maximum number of services that you want Cloud Map to return in the response - // to a ListServices request. If you don't specify a value for MaxResults, Cloud - // Map returns up to 100 services. + // The maximum number of services that you want Cloud Map to return in the + // response to a ListServices request. If you don't specify a value for MaxResults + // , Cloud Map returns up to 100 services. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicediscovery/api_op_RegisterInstance.go b/service/servicediscovery/api_op_RegisterInstance.go index 9d4f2a32631..edf30935ca2 100644 --- a/service/servicediscovery/api_op_RegisterInstance.go +++ b/service/servicediscovery/api_op_RegisterInstance.go @@ -14,37 +14,26 @@ import ( // Creates or updates one or more records and, optionally, creates a health check // based on the settings in a specified service. When you submit a RegisterInstance // request, the following occurs: +// - For each DNS record that you define in the service that's specified by +// ServiceId , a record is created or updated in the hosted zone that's +// associated with the corresponding namespace. +// - If the service includes HealthCheckConfig , a health check is created based +// on the settings in the health check configuration. +// - The health check, if any, is associated with each of the new or updated +// records. // -// * For each DNS record that you define in the -// service that's specified by ServiceId, a record is created or updated in the -// hosted zone that's associated with the corresponding namespace. -// -// * If the -// service includes HealthCheckConfig, a health check is created based on the -// settings in the health check configuration. -// -// * The health check, if any, is -// associated with each of the new or updated records. -// -// One RegisterInstance -// request must complete before you can submit another request and specify the same -// service ID and instance ID. For more information, see CreateService -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). When -// Cloud Map receives a DNS query for the specified DNS name, it returns the +// One RegisterInstance request must complete before you can submit another +// request and specify the same service ID and instance ID. For more information, +// see CreateService (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) +// . When Cloud Map receives a DNS query for the specified DNS name, it returns the // applicable value: +// - If the health check is healthy: returns all the records +// - If the health check is unhealthy: returns the applicable value for the last +// healthy instance +// - If you didn't specify a health check configuration: returns all the records // -// * If the health check is healthy: returns all the records -// -// * -// If the health check is unhealthy: returns the applicable value for the last -// healthy instance -// -// * If you didn't specify a health check configuration: returns -// all the records -// -// For the current quota on the number of instances that you can -// register using the same namespace and using the same service, see Cloud Map -// quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) +// For the current quota on the number of instances that you can register using +// the same namespace and using the same service, see Cloud Map quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) // in the Cloud Map Developer Guide. func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceInput, optFns ...func(*Options)) (*RegisterInstanceOutput, error) { if params == nil { @@ -64,104 +53,82 @@ func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceI type RegisterInstanceInput struct { // A string map that contains the following information for the service that you - // specify in ServiceId: - // - // * The attributes that apply to the records that are - // defined in the service. - // - // * For each attribute, the applicable value. - // - // Do not - // include sensitive information in the attributes if the namespace is discoverable - // by public DNS queries. Supported attribute keys include the following: - // AWS_ALIAS_DNS_NAME If you want Cloud Map to create an Amazon Route 53 alias - // record that routes traffic to an Elastic Load Balancing load balancer, specify - // the DNS name that's associated with the load balancer. For information about how - // to get the DNS name, see "DNSName" in the topic AliasTarget - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html) + // specify in ServiceId : + // - The attributes that apply to the records that are defined in the service. + // - For each attribute, the applicable value. + // Do not include sensitive information in the attributes if the namespace is + // discoverable by public DNS queries. Supported attribute keys include the + // following: AWS_ALIAS_DNS_NAME If you want Cloud Map to create an Amazon Route 53 + // alias record that routes traffic to an Elastic Load Balancing load balancer, + // specify the DNS name that's associated with the load balancer. For information + // about how to get the DNS name, see "DNSName" in the topic AliasTarget (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html) // in the Route 53 API Reference. Note the following: - // - // * The configuration for the - // service that's specified by ServiceId must include settings for an A record, an - // AAAA record, or both. - // - // * In the service that's specified by ServiceId, the value - // of RoutingPolicy must be WEIGHTED. - // - // * If the service that's specified by - // ServiceId includes HealthCheckConfig settings, Cloud Map will create the Route - // 53 health check, but it doesn't associate the health check with the alias - // record. - // - // * Auto naming currently doesn't support creating alias records that - // route traffic to Amazon Web Services resources other than Elastic Load Balancing - // load balancers. - // - // * If you specify a value for AWS_ALIAS_DNS_NAME, don't specify - // values for any of the AWS_INSTANCE attributes. - // - // AWS_EC2_INSTANCE_ID HTTP - // namespaces only. The Amazon EC2 instance ID for the instance. If the - // AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that - // can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID - // attribute is specified, then the AWS_INSTANCE_IPV4 attribute will be filled out - // with the primary private IPv4 address. AWS_INIT_HEALTH_STATUS If the service - // configuration includes HealthCheckCustomConfig, you can optionally use - // AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, - // HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, - // the initial status is HEALTHY. AWS_INSTANCE_CNAME If the service configuration - // includes a CNAME record, the domain name that you want Route 53 to return in - // response to DNS queries (for example, example.com). This value is required if - // the service specified by ServiceId includes settings for an CNAME record. - // AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 - // address that you want Route 53 to return in response to DNS queries (for - // example, 192.0.2.44). This value is required if the service specified by - // ServiceId includes settings for an A record. If the service includes settings - // for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, - // AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service configuration - // includes an AAAA record, the IPv6 address that you want Route 53 to return in - // response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345). + // - The configuration for the service that's specified by ServiceId must include + // settings for an A record, an AAAA record, or both. + // - In the service that's specified by ServiceId , the value of RoutingPolicy + // must be WEIGHTED . + // - If the service that's specified by ServiceId includes HealthCheckConfig + // settings, Cloud Map will create the Route 53 health check, but it doesn't + // associate the health check with the alias record. + // - Auto naming currently doesn't support creating alias records that route + // traffic to Amazon Web Services resources other than Elastic Load Balancing load + // balancers. + // - If you specify a value for AWS_ALIAS_DNS_NAME , don't specify values for any + // of the AWS_INSTANCE attributes. + // AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the + // instance. If the AWS_EC2_INSTANCE_ID attribute is specified, then the only + // other attribute that can be specified is AWS_INIT_HEALTH_STATUS . When the + // AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 + // attribute will be filled out with the primary private IPv4 address. + // AWS_INIT_HEALTH_STATUS If the service configuration includes + // HealthCheckCustomConfig , you can optionally use AWS_INIT_HEALTH_STATUS to + // specify the initial status of the custom health check, HEALTHY or UNHEALTHY . If + // you don't specify a value for AWS_INIT_HEALTH_STATUS , the initial status is + // HEALTHY . AWS_INSTANCE_CNAME If the service configuration includes a CNAME + // record, the domain name that you want Route 53 to return in response to DNS + // queries (for example, example.com ). This value is required if the service + // specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 + // If the service configuration includes an A record, the IPv4 address that you + // want Route 53 to return in response to DNS queries (for example, 192.0.2.44 ). // This value is required if the service specified by ServiceId includes settings - // for an AAAA record. If the service includes settings for an SRV record, you must - // specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. - // AWS_INSTANCE_PORT If the service includes an SRV record, the value that you want - // Route 53 to return for the port. If the service includes HealthCheckConfig, the - // port on the endpoint that you want Route 53 to send requests to. This value is - // required if you specified settings for an SRV record or a Route 53 health check - // when you created the service. Custom attributes You can add up to 30 custom - // attributes. For each key-value pair, the maximum length of the attribute name is - // 255 characters, and the maximum length of the attribute value is 1,024 - // characters. The total size of all provided attributes (sum of all keys and - // values) must not exceed 5,000 characters. + // for an A record. If the service includes settings for an SRV record, you must + // specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both. + // AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the + // IPv6 address that you want Route 53 to return in response to DNS queries (for + // example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 ). This value is required if + // the service specified by ServiceId includes settings for an AAAA record. If the + // service includes settings for an SRV record, you must specify a value for + // AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both. AWS_INSTANCE_PORT If the + // service includes an SRV record, the value that you want Route 53 to return for + // the port. If the service includes HealthCheckConfig , the port on the endpoint + // that you want Route 53 to send requests to. This value is required if you + // specified settings for an SRV record or a Route 53 health check when you + // created the service. Custom attributes You can add up to 30 custom attributes. + // For each key-value pair, the maximum length of the attribute name is 255 + // characters, and the maximum length of the attribute value is 1,024 characters. + // The total size of all provided attributes (sum of all keys and values) must not + // exceed 5,000 characters. // // This member is required. Attributes map[string]string - // An identifier that you want to associate with the instance. Note the - // following: - // - // * If the service that's specified by ServiceId includes settings for - // an SRV record, the value of InstanceId is automatically included as part of the - // value for the SRV record. For more information, see DnsRecord > Type - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type). - // - // * - // You can use this value to update an existing instance. - // - // * To register a new - // instance, you must specify a value that's unique among instances that you - // register by using the same service. - // - // * If you specify an existing InstanceId and - // ServiceId, Cloud Map updates the existing DNS records, if any. If there's also - // an existing health check, Cloud Map deletes the old health check and creates a - // new one. The health check isn't deleted immediately, so it will still appear for - // a while if you submit a ListHealthChecks request, for example. - // - // Do not include - // sensitive information in InstanceId if the namespace is discoverable by public - // DNS queries and any Type member of DnsRecord for the service contains SRV - // because the InstanceId is discoverable by public DNS queries. + // An identifier that you want to associate with the instance. Note the following: + // - If the service that's specified by ServiceId includes settings for an SRV + // record, the value of InstanceId is automatically included as part of the value + // for the SRV record. For more information, see DnsRecord > Type (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type) + // . + // - You can use this value to update an existing instance. + // - To register a new instance, you must specify a value that's unique among + // instances that you register by using the same service. + // - If you specify an existing InstanceId and ServiceId , Cloud Map updates the + // existing DNS records, if any. If there's also an existing health check, Cloud + // Map deletes the old health check and creates a new one. The health check isn't + // deleted immediately, so it will still appear for a while if you submit a + // ListHealthChecks request, for example. + // Do not include sensitive information in InstanceId if the namespace is + // discoverable by public DNS queries and any Type member of DnsRecord for the + // service contains SRV because the InstanceId is discoverable by public DNS + // queries. // // This member is required. InstanceId *string @@ -174,9 +141,9 @@ type RegisterInstanceInput struct { // A unique string that identifies the request and that allows failed // RegisterInstance requests to be retried without the risk of executing the // operation twice. You must use a unique CreatorRequestId string every time you - // submit a RegisterInstance request if you're registering additional instances for - // the same namespace and service. CreatorRequestId can be any unique string (for - // example, a date/time stamp). + // submit a RegisterInstance request if you're registering additional instances + // for the same namespace and service. CreatorRequestId can be any unique string + // (for example, a date/time stamp). CreatorRequestId *string noSmithyDocumentSerde @@ -185,8 +152,8 @@ type RegisterInstanceInput struct { type RegisterInstanceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_UpdateHttpNamespace.go b/service/servicediscovery/api_op_UpdateHttpNamespace.go index 329ae5566ac..ec4ff24b119 100644 --- a/service/servicediscovery/api_op_UpdateHttpNamespace.go +++ b/service/servicediscovery/api_op_UpdateHttpNamespace.go @@ -52,8 +52,8 @@ type UpdateHttpNamespaceInput struct { type UpdateHttpNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go b/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go index 2d6648a0328..67f4dc729a2 100644 --- a/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go +++ b/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go @@ -12,12 +12,12 @@ import ( ) // Submits a request to change the health status of a custom health check to -// healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the -// status only for custom health checks, which you define using +// healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change +// the status only for custom health checks, which you define using // HealthCheckCustomConfig when you create a service. You can't use it to change -// the status for Route 53 health checks, which you define using HealthCheckConfig. -// For more information, see HealthCheckCustomConfig -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html). +// the status for Route 53 health checks, which you define using HealthCheckConfig +// . For more information, see HealthCheckCustomConfig (https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html) +// . func (c *Client) UpdateInstanceCustomHealthStatus(ctx context.Context, params *UpdateInstanceCustomHealthStatusInput, optFns ...func(*Options)) (*UpdateInstanceCustomHealthStatusOutput, error) { if params == nil { params = &UpdateInstanceCustomHealthStatusInput{} @@ -46,7 +46,7 @@ type UpdateInstanceCustomHealthStatusInput struct { // This member is required. ServiceId *string - // The new status of the instance, HEALTHY or UNHEALTHY. + // The new status of the instance, HEALTHY or UNHEALTHY . // // This member is required. Status types.CustomHealthStatus diff --git a/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go b/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go index 6e474bed1ae..1c8f870518f 100644 --- a/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go +++ b/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go @@ -52,8 +52,8 @@ type UpdatePrivateDnsNamespaceInput struct { type UpdatePrivateDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go b/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go index 5fdea0ae2ca..9a54565c807 100644 --- a/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go +++ b/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go @@ -52,8 +52,8 @@ type UpdatePublicDnsNamespaceInput struct { type UpdatePublicDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_UpdateService.go b/service/servicediscovery/api_op_UpdateService.go index ab3e22fef2d..5788e8d3f66 100644 --- a/service/servicediscovery/api_op_UpdateService.go +++ b/service/servicediscovery/api_op_UpdateService.go @@ -12,28 +12,19 @@ import ( ) // Submits a request to perform the following operations: +// - Update the TTL setting for existing DnsRecords configurations +// - Add, update, or delete HealthCheckConfig for a specified service You can't +// add, update, or delete a HealthCheckCustomConfig configuration. // -// * Update the TTL setting -// for existing DnsRecords configurations +// For public and private DNS namespaces, note the following: +// - If you omit any existing DnsRecords or HealthCheckConfig configurations from +// an UpdateService request, the configurations are deleted from the service. +// - If you omit an existing HealthCheckCustomConfig configuration from an +// UpdateService request, the configuration isn't deleted from the service. // -// * Add, update, or delete -// HealthCheckConfig for a specified service You can't add, update, or delete a -// HealthCheckCustomConfig configuration. -// -// For public and private DNS namespaces, -// note the following: -// -// * If you omit any existing DnsRecords or HealthCheckConfig -// configurations from an UpdateService request, the configurations are deleted -// from the service. -// -// * If you omit an existing HealthCheckCustomConfig -// configuration from an UpdateService request, the configuration isn't deleted -// from the service. -// -// When you update settings for a service, Cloud Map also -// updates the corresponding settings in all the records and health checks that -// were created by using the specified service. +// When you update settings for a service, Cloud Map also updates the +// corresponding settings in all the records and health checks that were created by +// using the specified service. func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { if params == nil { params = &UpdateServiceInput{} @@ -67,8 +58,8 @@ type UpdateServiceInput struct { type UpdateServiceOutput struct { // A value that you can use to determine whether the request completed - // successfully. To get the status of the operation, see GetOperation - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html). + // successfully. To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) + // . OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/types/enums.go b/service/servicediscovery/types/enums.go index c02abcdfc2b..b121366530d 100644 --- a/service/servicediscovery/types/enums.go +++ b/service/servicediscovery/types/enums.go @@ -71,9 +71,9 @@ const ( HealthStatusUnknown HealthStatus = "UNKNOWN" ) -// Values returns all known values for HealthStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for HealthStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (HealthStatus) Values() []HealthStatus { return []HealthStatus{ "HEALTHY", diff --git a/service/servicediscovery/types/errors.go b/service/servicediscovery/types/errors.go index 511efc6d6cd..a7a922266c4 100644 --- a/service/servicediscovery/types/errors.go +++ b/service/servicediscovery/types/errors.go @@ -198,10 +198,10 @@ func (e *OperationNotFound) ErrorCode() string { } func (e *OperationNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation can't be completed because you've reached the quota for the number -// of requests. For more information, see Cloud Map API request throttling quota -// (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in the Cloud -// Map Developer Guide. +// The operation can't be completed because you've reached the quota for the +// number of requests. For more information, see Cloud Map API request throttling +// quota (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in the +// Cloud Map Developer Guide. type RequestLimitExceeded struct { Message *string @@ -227,8 +227,8 @@ func (e *RequestLimitExceeded) ErrorCode() string { } func (e *RequestLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified resource can't be deleted because it contains other resources. For -// example, you can't delete a service that contains any instances. +// The specified resource can't be deleted because it contains other resources. +// For example, you can't delete a service that contains any instances. type ResourceInUse struct { Message *string diff --git a/service/servicediscovery/types/types.go b/service/servicediscovery/types/types.go index af0ff90ae02..018f7fefa74 100644 --- a/service/servicediscovery/types/types.go +++ b/service/servicediscovery/types/types.go @@ -10,7 +10,7 @@ import ( // A complex type that contains information about the Amazon Route 53 DNS records // that you want Cloud Map to create when you register an instance. The record // types of a service can only be changed by deleting the service and recreating it -// with a new Dnsconfig. +// with a new Dnsconfig . type DnsConfig struct { // An array that contains one DnsRecord object for each Route 53 DNS record that @@ -19,42 +19,39 @@ type DnsConfig struct { // This member is required. DnsRecords []DnsRecord - // Use NamespaceId in Service - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html) instead. The - // ID of the namespace to use for DNS configuration. + // Use NamespaceId in Service (https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html) + // instead. The ID of the namespace to use for DNS configuration. // // Deprecated: Top level attribute in request should be used to reference // namespace-id NamespaceId *string - // The routing policy that you want to apply to all Route 53 DNS records that Cloud - // Map creates when you register an instance and specify this service. If you want - // to use this service to register instances that create alias records, specify - // WEIGHTED for the routing policy. You can specify the following values: + // The routing policy that you want to apply to all Route 53 DNS records that + // Cloud Map creates when you register an instance and specify this service. If you + // want to use this service to register instances that create alias records, + // specify WEIGHTED for the routing policy. You can specify the following values: // MULTIVALUE If you define a health check for the service and the health check is // healthy, Route 53 returns the applicable value for up to eight instances. For - // example, suppose that the service includes configurations for one A record and a - // health check. You use the service to register 10 instances. Route 53 responds to - // DNS queries with IP addresses for up to eight healthy instances. If fewer than - // eight instances are healthy, Route 53 responds to every DNS query with the IP - // addresses for all of the healthy instances. If you don't define a health check - // for the service, Route 53 assumes that all instances are healthy and returns the - // values for up to eight instances. For more information about the multivalue - // routing policy, see Multivalue Answer Routing - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue) + // example, suppose that the service includes configurations for one A record and + // a health check. You use the service to register 10 instances. Route 53 responds + // to DNS queries with IP addresses for up to eight healthy instances. If fewer + // than eight instances are healthy, Route 53 responds to every DNS query with the + // IP addresses for all of the healthy instances. If you don't define a health + // check for the service, Route 53 assumes that all instances are healthy and + // returns the values for up to eight instances. For more information about the + // multivalue routing policy, see Multivalue Answer Routing (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue) // in the Route 53 Developer Guide. WEIGHTED Route 53 returns the applicable value // from one randomly selected instance from among the instances that you registered // using the same service. Currently, all records have the same weight, so you // can't route more or less traffic to any instances. For example, suppose that the - // service includes configurations for one A record and a health check. You use the - // service to register 10 instances. Route 53 responds to DNS queries with the IP - // address for one randomly selected instance from among the healthy instances. If - // no instances are healthy, Route 53 responds to DNS queries as if all of the + // service includes configurations for one A record and a health check. You use + // the service to register 10 instances. Route 53 responds to DNS queries with the + // IP address for one randomly selected instance from among the healthy instances. + // If no instances are healthy, Route 53 responds to DNS queries as if all of the // instances were healthy. If you don't define a health check for the service, // Route 53 assumes that all instances are healthy and returns the applicable value // for one randomly selected instance. For more information about the weighted - // routing policy, see Weighted Routing - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) + // routing policy, see Weighted Routing (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) // in the Route 53 Developer Guide. RoutingPolicy RoutingPolicy @@ -88,18 +85,17 @@ type DnsProperties struct { noSmithyDocumentSerde } -// A complex type that contains information about the Route 53 DNS records that you -// want Cloud Map to create when you register an instance. +// A complex type that contains information about the Route 53 DNS records that +// you want Cloud Map to create when you register an instance. type DnsRecord struct { // The amount of time, in seconds, that you want DNS resolvers to cache the // settings for this record. Alias records don't include a TTL because Route 53 // uses the TTL for the Amazon Web Services resource that an alias record routes // traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a - // RegisterInstance - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) - // request, the TTL value is ignored. Always specify a TTL for the service; you can - // use a service to register instances that create either alias or non-alias + // RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) + // request, the TTL value is ignored. Always specify a TTL for the service; you + // can use a service to register instances that create either alias or non-alias // records. // // This member is required. @@ -108,85 +104,50 @@ type DnsRecord struct { // The type of the resource, which indicates the type of value that Route 53 // returns in response to DNS queries. You can specify values for Type in the // following combinations: - // - // * A - // - // * AAAA - // - // * A and AAAA - // - // * SRV - // - // * CNAME - // - // If you want - // Cloud Map to create a Route 53 alias record when you register an instance, - // specify A or AAAA for Type. You specify other settings, such as the IP address - // for A and AAAA records, when you register an instance. For more information, see - // RegisterInstance - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html). - // The following values are supported: A Route 53 returns the IP address of the + // - A + // - AAAA + // - A and AAAA + // - SRV + // - CNAME + // If you want Cloud Map to create a Route 53 alias record when you register an + // instance, specify A or AAAA for Type . You specify other settings, such as the + // IP address for A and AAAA records, when you register an instance. For more + // information, see RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) + // . The following values are supported: A Route 53 returns the IP address of the // resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP // address of the resource in IPv6 format, such as // 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name // of the resource, such as www.example.com. Note the following: - // - // * You specify the - // domain name that you want to route traffic to when you register an instance. For - // more information, see Attributes - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes) - // in the topic RegisterInstance - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html). - // - // * - // You must specify WEIGHTED for the value of RoutingPolicy. - // - // * You can't specify - // both CNAME for Type and settings for HealthCheckConfig. If you do, the request - // will fail with an InvalidInput error. - // - // SRV Route 53 returns the value for an SRV - // record. The value for an SRV record uses the following values: priority weight - // port service-hostname Note the following about the values: - // - // * The values of - // priority and weight are both set to 1 and can't be changed. - // - // * The value of port - // comes from the value that you specify for the AWS_INSTANCE_PORT attribute when - // you submit a RegisterInstance - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) - // request. - // - // * The value of service-hostname is a concatenation of the following - // values: - // - // * The value that you specify for InstanceId when you register an - // instance. - // - // * The name of the service. - // - // * The name of the namespace. - // - // For - // example, if the value of InstanceId is test, the name of the service is backend, - // and the name of the namespace is example.com, the value of service-hostname is - // the following: test.backend.example.com - // - // If you specify settings for an SRV - // record, note the following: - // - // * If you specify values for AWS_INSTANCE_IPV4, - // AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map - // automatically creates A and/or AAAA records that have the same name as the value - // of service-hostname in the SRV record. You can ignore these records. - // - // * If - // you're using a system that requires a specific SRV format, such as HAProxy, see - // the Name - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name) - // element in the documentation about CreateService for information about how to - // specify the correct name format. + // - You specify the domain name that you want to route traffic to when you + // register an instance. For more information, see Attributes (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes) + // in the topic RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) + // . + // - You must specify WEIGHTED for the value of RoutingPolicy . + // - You can't specify both CNAME for Type and settings for HealthCheckConfig . + // If you do, the request will fail with an InvalidInput error. + // SRV Route 53 returns the value for an SRV record. The value for an SRV record + // uses the following values: priority weight port service-hostname Note the + // following about the values: + // - The values of priority and weight are both set to 1 and can't be changed. + // - The value of port comes from the value that you specify for the + // AWS_INSTANCE_PORT attribute when you submit a RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) + // request. + // - The value of service-hostname is a concatenation of the following values: + // - The value that you specify for InstanceId when you register an instance. + // - The name of the service. + // - The name of the namespace. For example, if the value of InstanceId is test , + // the name of the service is backend , and the name of the namespace is + // example.com , the value of service-hostname is the following: + // test.backend.example.com + // If you specify settings for an SRV record, note the following: + // - If you specify values for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both in + // the RegisterInstance request, Cloud Map automatically creates A and/or AAAA + // records that have the same name as the value of service-hostname in the SRV + // record. You can ignore these records. + // - If you're using a system that requires a specific SRV format, such as + // HAProxy, see the Name (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name) + // element in the documentation about CreateService for information about how to + // specify the correct name format. // // This member is required. Type RecordType @@ -196,69 +157,57 @@ type DnsRecord struct { // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional health check. If you specify settings for a health check, Cloud Map -// associates the health check with the records that you specify in DnsConfig. If +// associates the health check with the records that you specify in DnsConfig . If // you specify a health check configuration, you can specify either // HealthCheckCustomConfig or HealthCheckConfig but not both. Health checks are // basic Route 53 health checks that monitor an Amazon Web Services endpoint. For -// information about pricing for health checks, see Amazon Route 53 Pricing -// (http://aws.amazon.com/route53/pricing/). Note the following about configuring -// health checks. A and AAAA records If DnsConfig includes configurations for both -// A and AAAA records, Cloud Map creates a health check that uses the IPv4 address -// to check the health of the resource. If the endpoint tthat's specified by the -// IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be -// unhealthy. CNAME records You can't specify settings for HealthCheckConfig when -// the DNSConfig includes CNAME for the value of Type. If you do, the CreateService -// request will fail with an InvalidInput error. Request interval A Route 53 health -// checker in each health-checking Amazon Web Services Region sends a health check -// request to an endpoint every 30 seconds. On average, your endpoint receives a -// health check request about every two seconds. However, health checkers don't -// coordinate with one another. Therefore, you might sometimes see several requests -// in one second that's followed by a few seconds with no health checks at all. -// Health checking regions Health checkers perform checks from all Route 53 -// health-checking Regions. For a list of the current Regions, see Regions -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions). -// Alias records When you register an instance, if you include the +// information about pricing for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) +// . Note the following about configuring health checks. A and AAAA records If +// DnsConfig includes configurations for both A and AAAA records, Cloud Map +// creates a health check that uses the IPv4 address to check the health of the +// resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, +// Route 53 considers both the A and AAAA records to be unhealthy. CNAME records +// You can't specify settings for HealthCheckConfig when the DNSConfig includes +// CNAME for the value of Type . If you do, the CreateService request will fail +// with an InvalidInput error. Request interval A Route 53 health checker in each +// health-checking Amazon Web Services Region sends a health check request to an +// endpoint every 30 seconds. On average, your endpoint receives a health check +// request about every two seconds. However, health checkers don't coordinate with +// one another. Therefore, you might sometimes see several requests in one second +// that's followed by a few seconds with no health checks at all. Health checking +// regions Health checkers perform checks from all Route 53 health-checking +// Regions. For a list of the current Regions, see Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions) +// . Alias records When you register an instance, if you include the // AWS_ALIAS_DNS_NAME attribute, Cloud Map creates a Route 53 alias record. Note // the following: +// - Route 53 automatically sets EvaluateTargetHealth to true for alias records. +// When EvaluateTargetHealth is true, the alias record inherits the health of the +// referenced Amazon Web Services resource. such as an ELB load balancer. For more +// information, see EvaluateTargetHealth (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth) +// . +// - If you include HealthCheckConfig and then use the service to register an +// instance that creates an alias record, Route 53 doesn't create the health check. // -// * Route 53 automatically sets EvaluateTargetHealth to true for -// alias records. When EvaluateTargetHealth is true, the alias record inherits the -// health of the referenced Amazon Web Services resource. such as an ELB load -// balancer. For more information, see EvaluateTargetHealth -// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). -// -// * -// If you include HealthCheckConfig and then use the service to register an -// instance that creates an alias record, Route 53 doesn't create the health -// check. -// -// Charges for health checks Health checks are basic Route 53 health checks -// that monitor an Amazon Web Services endpoint. For information about pricing for -// health checks, see Amazon Route 53 Pricing -// (http://aws.amazon.com/route53/pricing/). +// Charges for health checks Health checks are basic Route 53 health checks that +// monitor an Amazon Web Services endpoint. For information about pricing for +// health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) +// . type HealthCheckConfig struct { // The type of health check that you want to create, which indicates how Route 53 // determines whether an endpoint is healthy. You can't change the value of Type // after you create a health check. You can create the following types of health // checks: - // - // * HTTP: Route 53 tries to establish a TCP connection. If successful, - // Route 53 submits an HTTP request and waits for an HTTP status code of 200 or - // greater and less than 400. - // - // * HTTPS: Route 53 tries to establish a TCP - // connection. If successful, Route 53 submits an HTTPS request and waits for an - // HTTP status code of 200 or greater and less than 400. If you specify HTTPS for - // the value of Type, the endpoint must support TLS v1.0 or later. - // - // * TCP: Route 53 - // tries to establish a TCP connection. If you specify TCP for Type, don't specify - // a value for ResourcePath. - // - // For more information, see How Route 53 Determines - // Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // - HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 + // submits an HTTP request and waits for an HTTP status code of 200 or greater and + // less than 400. + // - HTTPS: Route 53 tries to establish a TCP connection. If successful, Route + // 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater + // and less than 400. If you specify HTTPS for the value of Type , the endpoint + // must support TLS v1.0 or later. + // - TCP: Route 53 tries to establish a TCP connection. If you specify TCP for + // Type , don't specify a value for ResourcePath . + // For more information, see How Route 53 Determines Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. // // This member is required. @@ -267,17 +216,17 @@ type HealthCheckConfig struct { // The number of consecutive health checks that an endpoint must pass or fail for // Route 53 to change the current status of the endpoint from unhealthy to healthy // or the other way around. For more information, see How Route 53 Determines - // Whether an Endpoint Is Healthy - // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) + // Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. FailureThreshold *int32 // The path that you want Route 53 to request when performing health checks. The // path can be any value that your endpoint returns an HTTP status code of a 2xx or // 3xx format for when the endpoint is healthy. An example file is - // /docs/route53-health-check.html. Route 53 automatically adds the DNS name for - // the service. If you don't specify a value for ResourcePath, the default value is - // /. If you specify TCP for Type, you must not specify a value for ResourcePath. + // /docs/route53-health-check.html . Route 53 automatically adds the DNS name for + // the service. If you don't specify a value for ResourcePath , the default value + // is / . If you specify TCP for Type , you must not specify a value for + // ResourcePath . ResourcePath *string noSmithyDocumentSerde @@ -287,45 +236,31 @@ type HealthCheckConfig struct { // A custom health check, which requires that you use a third-party health checker // to evaluate the health of your resources, is useful in the following // circumstances: +// - You can't use a health check that's defined by HealthCheckConfig because the +// resource isn't available over the internet. For example, you can use a custom +// health check when the instance is in an Amazon VPC. (To check the health of +// resources in a VPC, the health checker must also be in the VPC.) +// - You want to use a third-party health checker regardless of where your +// resources are located. // -// * You can't use a health check that's defined by -// HealthCheckConfig because the resource isn't available over the internet. For -// example, you can use a custom health check when the instance is in an Amazon -// VPC. (To check the health of resources in a VPC, the health checker must also be -// in the VPC.) -// -// * You want to use a third-party health checker regardless of where -// your resources are located. -// -// If you specify a health check configuration, you -// can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. To -// change the status of a custom health check, submit an -// UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status -// of the resource, it just keeps a record of the status specified in the most -// recent UpdateInstanceCustomHealthStatus request. Here's how custom health checks -// work: -// -// * You create a service. -// -// * You register an instance. -// -// * You configure a -// third-party health checker to monitor the resource that's associated with the -// new instance. Cloud Map doesn't check the health of the resource directly. -// -// * -// The third-party health-checker determines that the resource is unhealthy and -// notifies your application. -// -// * Your application submits an -// UpdateInstanceCustomHealthStatus request. -// -// * Cloud Map waits for 30 seconds. -// -// * -// If another UpdateInstanceCustomHealthStatus request doesn't arrive during that -// time to change the status back to healthy, Cloud Map stops routing traffic to -// the resource. +// If you specify a health check configuration, you can specify either +// HealthCheckCustomConfig or HealthCheckConfig but not both. To change the status +// of a custom health check, submit an UpdateInstanceCustomHealthStatus request. +// Cloud Map doesn't monitor the status of the resource, it just keeps a record of +// the status specified in the most recent UpdateInstanceCustomHealthStatus +// request. Here's how custom health checks work: +// - You create a service. +// - You register an instance. +// - You configure a third-party health checker to monitor the resource that's +// associated with the new instance. Cloud Map doesn't check the health of the +// resource directly. +// - The third-party health-checker determines that the resource is unhealthy +// and notifies your application. +// - Your application submits an UpdateInstanceCustomHealthStatus request. +// - Cloud Map waits for 30 seconds. +// - If another UpdateInstanceCustomHealthStatus request doesn't arrive during +// that time to change the status back to healthy, Cloud Map stops routing traffic +// to the resource. type HealthCheckCustomConfig struct { // This parameter is no longer supported and is always set to 1. Cloud Map waits @@ -335,8 +270,8 @@ type HealthCheckCustomConfig struct { // UpdateInstanceCustomHealthStatus request before it changes the health status of // a service instance. Sending a second or subsequent // UpdateInstanceCustomHealthStatus request with the same value before 30 seconds - // has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after - // the first request to make the change. + // has passed doesn't accelerate the change. Cloud Map still waits 30 seconds + // after the first request to make the change. // // Deprecated: Configurable FailureThreshold of HealthCheckCustomConfig is // deprecated. It will always have value 1. @@ -345,8 +280,7 @@ type HealthCheckCustomConfig struct { noSmithyDocumentSerde } -// In a response to a DiscoverInstances -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) +// In a response to a DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) // request, HttpInstanceSummary contains information about one instance that // matches the values that you specified in the request. type HttpInstanceSummary struct { @@ -396,136 +330,110 @@ type HttpProperties struct { // creates when you submit a RegisterInstance request. type Instance struct { - // An identifier that you want to associate with the instance. Note the - // following: - // - // * If the service that's specified by ServiceId includes settings for - // an SRV record, the value of InstanceId is automatically included as part of the - // value for the SRV record. For more information, see DnsRecord > Type - // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type). - // - // * - // You can use this value to update an existing instance. - // - // * To register a new - // instance, you must specify a value that's unique among instances that you - // register by using the same service. - // - // * If you specify an existing InstanceId and - // ServiceId, Cloud Map updates the existing DNS records. If there's also an - // existing health check, Cloud Map deletes the old health check and creates a new - // one. The health check isn't deleted immediately, so it will still appear for a - // while if you submit a ListHealthChecks request, for example. + // An identifier that you want to associate with the instance. Note the following: + // - If the service that's specified by ServiceId includes settings for an SRV + // record, the value of InstanceId is automatically included as part of the value + // for the SRV record. For more information, see DnsRecord > Type (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type) + // . + // - You can use this value to update an existing instance. + // - To register a new instance, you must specify a value that's unique among + // instances that you register by using the same service. + // - If you specify an existing InstanceId and ServiceId , Cloud Map updates the + // existing DNS records. If there's also an existing health check, Cloud Map + // deletes the old health check and creates a new one. The health check isn't + // deleted immediately, so it will still appear for a while if you submit a + // ListHealthChecks request, for example. // // This member is required. Id *string // A string map that contains the following information for the service that you - // specify in ServiceId: - // - // * The attributes that apply to the records that are - // defined in the service. - // - // * For each attribute, the applicable value. - // - // Do not - // include sensitive information in the attributes if the namespace is discoverable - // by public DNS queries. Supported attribute keys include the following: - // AWS_ALIAS_DNS_NAME If you want Cloud Map to create a Route 53 alias record that - // routes traffic to an Elastic Load Balancing load balancer, specify the DNS name - // that's associated with the load balancer. For information about how to get the - // DNS name, see AliasTarget->DNSName - // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName) + // specify in ServiceId : + // - The attributes that apply to the records that are defined in the service. + // - For each attribute, the applicable value. + // Do not include sensitive information in the attributes if the namespace is + // discoverable by public DNS queries. Supported attribute keys include the + // following: AWS_ALIAS_DNS_NAME If you want Cloud Map to create a Route 53 alias + // record that routes traffic to an Elastic Load Balancing load balancer, specify + // the DNS name that's associated with the load balancer. For information about how + // to get the DNS name, see AliasTarget->DNSName (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName) // in the Route 53 API Reference. Note the following: - // - // * The configuration for the - // service that's specified by ServiceId must include settings for an A record, an - // AAAA record, or both. - // - // * In the service that's specified by ServiceId, the value - // of RoutingPolicy must be WEIGHTED. - // - // * If the service that's specified by - // ServiceId includes HealthCheckConfig settings, Cloud Map creates the health - // check, but it won't associate the health check with the alias record. - // - // * Auto - // naming currently doesn't support creating alias records that route traffic to - // Amazon Web Services resources other than ELB load balancers. - // - // * If you specify a - // value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE - // attributes. - // - // AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance - // ID for the instance. The AWS_INSTANCE_IPV4 attribute contains the primary - // private IPv4 address. AWS_INIT_HEALTH_STATUS If the service configuration - // includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS - // to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. - // If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is - // HEALTHY. AWS_INSTANCE_CNAME If the service configuration includes a CNAME + // - The configuration for the service that's specified by ServiceId must include + // settings for an A record, an AAAA record, or both. + // - In the service that's specified by ServiceId , the value of RoutingPolicy + // must be WEIGHTED . + // - If the service that's specified by ServiceId includes HealthCheckConfig + // settings, Cloud Map creates the health check, but it won't associate the health + // check with the alias record. + // - Auto naming currently doesn't support creating alias records that route + // traffic to Amazon Web Services resources other than ELB load balancers. + // - If you specify a value for AWS_ALIAS_DNS_NAME , don't specify values for any + // of the AWS_INSTANCE attributes. + // AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the + // instance. The AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 + // address. AWS_INIT_HEALTH_STATUS If the service configuration includes + // HealthCheckCustomConfig , you can optionally use AWS_INIT_HEALTH_STATUS to + // specify the initial status of the custom health check, HEALTHY or UNHEALTHY . If + // you don't specify a value for AWS_INIT_HEALTH_STATUS , the initial status is + // HEALTHY . AWS_INSTANCE_CNAME If the service configuration includes a CNAME // record, the domain name that you want Route 53 to return in response to DNS - // queries (for example, example.com). This value is required if the service + // queries (for example, example.com ). This value is required if the service // specified by ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 // If the service configuration includes an A record, the IPv4 address that you - // want Route 53 to return in response to DNS queries (for example, 192.0.2.44). + // want Route 53 to return in response to DNS queries (for example, 192.0.2.44 ). // This value is required if the service specified by ServiceId includes settings // for an A record. If the service includes settings for an SRV record, you must - // specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. - // AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 - // address that you want Route 53 to return in response to DNS queries (for - // example, 2001:0db8:85a3:0000:0000:abcd:0001:2345). This value is required if the - // service specified by ServiceId includes settings for an AAAA record. If the + // specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both. + // AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the + // IPv6 address that you want Route 53 to return in response to DNS queries (for + // example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 ). This value is required if + // the service specified by ServiceId includes settings for an AAAA record. If the // service includes settings for an SRV record, you must specify a value for - // AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service - // includes an SRV record, the value that you want Route 53 to return for the port. - // If the service includes HealthCheckConfig, the port on the endpoint that you - // want Route 53 to send requests to. This value is required if you specified - // settings for an SRV record or a Route 53 health check when you created the - // service. + // AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both. AWS_INSTANCE_PORT If the + // service includes an SRV record, the value that you want Route 53 to return for + // the port. If the service includes HealthCheckConfig , the port on the endpoint + // that you want Route 53 to send requests to. This value is required if you + // specified settings for an SRV record or a Route 53 health check when you + // created the service. Attributes map[string]string // A unique string that identifies the request and that allows failed // RegisterInstance requests to be retried without the risk of executing the // operation twice. You must use a unique CreatorRequestId string every time you - // submit a RegisterInstance request if you're registering additional instances for - // the same namespace and service. CreatorRequestId can be any unique string (for - // example, a date/time stamp). + // submit a RegisterInstance request if you're registering additional instances + // for the same namespace and service. CreatorRequestId can be any unique string + // (for example, a date/time stamp). CreatorRequestId *string noSmithyDocumentSerde } -// A complex type that contains information about the instances that you registered -// by using a specified service. +// A complex type that contains information about the instances that you +// registered by using a specified service. type InstanceSummary struct { // A string map that contains the following information: - // - // * The attributes that are - // associated with the instance. - // - // * For each attribute, the applicable - // value. - // - // Supported attribute keys include the following: AWS_ALIAS_DNS_NAME For - // an alias record that routes traffic to an Elastic Load Balancing load balancer, - // the DNS name that's associated with the load balancer. AWS_EC2_INSTANCE_ID (HTTP + // - The attributes that are associated with the instance. + // - For each attribute, the applicable value. + // Supported attribute keys include the following: AWS_ALIAS_DNS_NAME For an alias + // record that routes traffic to an Elastic Load Balancing load balancer, the DNS + // name that's associated with the load balancer. AWS_EC2_INSTANCE_ID (HTTP // namespaces only) The Amazon EC2 instance ID for the instance. When the - // AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute - // contains the primary private IPv4 address. AWS_INIT_HEALTH_STATUS If the service - // configuration includes HealthCheckCustomConfig, you can optionally use - // AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, - // HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, - // the initial status is HEALTHY. AWS_INSTANCE_CNAME For a CNAME record, the domain - // name that Route 53 returns in response to DNS queries (for example, - // example.com). AWS_INSTANCE_IPV4 For an A record, the IPv4 address that Route 53 - // returns in response to DNS queries (for example, 192.0.2.44). AWS_INSTANCE_IPV6 - // For an AAAA record, the IPv6 address that Route 53 returns in response to DNS - // queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345). - // AWS_INSTANCE_PORT For an SRV record, the value that Route 53 returns for the - // port. In addition, if the service includes HealthCheckConfig, the port on the - // endpoint that Route 53 sends requests to. + // AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 + // attribute contains the primary private IPv4 address. AWS_INIT_HEALTH_STATUS If + // the service configuration includes HealthCheckCustomConfig , you can optionally + // use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health + // check, HEALTHY or UNHEALTHY . If you don't specify a value for + // AWS_INIT_HEALTH_STATUS , the initial status is HEALTHY . AWS_INSTANCE_CNAME For + // a CNAME record, the domain name that Route 53 returns in response to DNS + // queries (for example, example.com ). AWS_INSTANCE_IPV4 For an A record, the + // IPv4 address that Route 53 returns in response to DNS queries (for example, + // 192.0.2.44 ). AWS_INSTANCE_IPV6 For an AAAA record, the IPv6 address that Route + // 53 returns in response to DNS queries (for example, + // 2001:0db8:85a3:0000:0000:abcd:0001:2345 ). AWS_INSTANCE_PORT For an SRV record, + // the value that Route 53 returns for the port. In addition, if the service + // includes HealthCheckConfig , the port on the endpoint that Route 53 sends + // requests to. Attributes map[string]string // The ID for an instance that you created by using a specified service. @@ -557,7 +465,7 @@ type Namespace struct { // The ID of a namespace. Id *string - // The name of the namespace, such as example.com. + // The name of the namespace, such as example.com . Name *string // A complex type that contains information that's specific to the type of the @@ -583,29 +491,18 @@ type Namespace struct { type NamespaceFilter struct { // Specify the namespaces that you want to get using one of the following. - // - // * TYPE: - // Gets the namespaces of the specified type. - // - // * NAME: Gets the namespaces with the - // specified name. - // - // * HTTP_NAME: Gets the namespaces with the specified HTTP name. + // - TYPE : Gets the namespaces of the specified type. + // - NAME : Gets the namespaces with the specified name. + // - HTTP_NAME : Gets the namespaces with the specified HTTP name. // // This member is required. Name NamespaceFilterName - // Specify the values that are applicable to the value that you specify for - // Name. - // - // * TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE. - // - // * NAME: Specify the - // name of the namespace, which is found in Namespace.Name. - // - // * HTTP_NAME: Specify - // the HTTP name of the namespace, which is found in - // Namespace.Properties.HttpProperties.HttpName. + // Specify the values that are applicable to the value that you specify for Name . + // - TYPE : Specify HTTP , DNS_PUBLIC , or DNS_PRIVATE . + // - NAME : Specify the name of the namespace, which is found in Namespace.Name . + // - HTTP_NAME : Specify the HTTP name of the namespace, which is found in + // Namespace.Properties.HttpProperties.HttpName . // // This member is required. Values []string @@ -613,14 +510,11 @@ type NamespaceFilter struct { // Specify the operator that you want to use to determine whether a namespace // matches the specified value. Valid values for Condition are one of the // following. - // - // * EQ: When you specify EQ for Condition, you can specify only one - // value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default - // condition and can be omitted. - // - // * BEGINS_WITH: When you specify BEGINS_WITH for - // Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, - // NAME, and HTTP_NAME. + // - EQ : When you specify EQ for Condition , you can specify only one value. EQ + // is supported for TYPE , NAME , and HTTP_NAME . EQ is the default condition and + // can be omitted. + // - BEGINS_WITH : When you specify BEGINS_WITH for Condition , you can specify + // only one value. BEGINS_WITH is supported for TYPE , NAME , and HTTP_NAME . Condition FilterCondition noSmithyDocumentSerde @@ -680,36 +574,27 @@ type Operation struct { // 26, 2018 12:11:30.087 AM. CreateDate *time.Time - // The code associated with ErrorMessage. Values for ErrorCode include the + // The code associated with ErrorMessage . Values for ErrorCode include the // following: - // - // * ACCESS_DENIED - // - // * CANNOT_CREATE_HOSTED_ZONE - // - // * EXPIRED_TOKEN - // - // * - // HOSTED_ZONE_NOT_FOUND - // - // * INTERNAL_FAILURE - // - // * INVALID_CHANGE_BATCH - // - // * - // THROTTLED_REQUEST + // - ACCESS_DENIED + // - CANNOT_CREATE_HOSTED_ZONE + // - EXPIRED_TOKEN + // - HOSTED_ZONE_NOT_FOUND + // - INTERNAL_FAILURE + // - INVALID_CHANGE_BATCH + // - THROTTLED_REQUEST ErrorCode *string - // If the value of Status is FAIL, the reason that the operation failed. + // If the value of Status is FAIL , the reason that the operation failed. ErrorMessage *string // The ID of the operation that you want to get information about. Id *string - // The status of the operation. Values include the following: SUBMITTED This is the - // initial state that occurs immediately after you submit a request. PENDING Cloud - // Map is performing the operation. SUCCESS The operation succeeded. FAIL The - // operation failed. For the failure reason, see ErrorMessage. + // The status of the operation. Values include the following: SUBMITTED This is + // the initial state that occurs immediately after you submit a request. PENDING + // Cloud Map is performing the operation. SUCCESS The operation succeeded. FAIL The + // operation failed. For the failure reason, see ErrorMessage . Status OperationStatus // The name of the target entity that's associated with the operation: NAMESPACE @@ -721,10 +606,10 @@ type Operation struct { // The name of the operation that's associated with the specified ID. Type OperationType - // The date and time that the value of Status changed to the current value, in Unix - // date/time format and Coordinated Universal Time (UTC). The value of UpdateDate - // is accurate to milliseconds. For example, the value 1516925490.087 represents - // Friday, January 26, 2018 12:11:30.087 AM. + // The date and time that the value of Status changed to the current value, in + // Unix date/time format and Coordinated Universal Time (UTC). The value of + // UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 + // represents Friday, January 26, 2018 12:11:30.087 AM. UpdateDate *time.Time noSmithyDocumentSerde @@ -734,70 +619,49 @@ type Operation struct { type OperationFilter struct { // Specify the operations that you want to get: - // - // * NAMESPACE_ID: Gets operations - // related to specified namespaces. - // - // * SERVICE_ID: Gets operations related to - // specified services. - // - // * STATUS: Gets operations based on the status of the - // operations: SUBMITTED, PENDING, SUCCEED, or FAIL. - // - // * TYPE: Gets specified types - // of operation. - // - // * UPDATE_DATE: Gets operations that changed status during a - // specified date/time range. + // - NAMESPACE_ID: Gets operations related to specified namespaces. + // - SERVICE_ID: Gets operations related to specified services. + // - STATUS: Gets operations based on the status of the operations: SUBMITTED , + // PENDING , SUCCEED , or FAIL . + // - TYPE: Gets specified types of operation. + // - UPDATE_DATE: Gets operations that changed status during a specified + // date/time range. // // This member is required. Name OperationFilterName - // Specify values that are applicable to the value that you specify for Name: - // - // * - // NAMESPACE_ID: Specify one namespace ID. - // - // * SERVICE_ID: Specify one service - // ID. - // - // * STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or - // FAIL. - // - // * TYPE: Specify one or more of the following types: CREATE_NAMESPACE, - // DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE. - // - // * - // UPDATE_DATE: Specify a start date and an end date in Unix date/time format and - // Coordinated Universal Time (UTC). The start date must be the first value. + // Specify values that are applicable to the value that you specify for Name : + // - NAMESPACE_ID: Specify one namespace ID. + // - SERVICE_ID: Specify one service ID. + // - STATUS: Specify one or more statuses: SUBMITTED , PENDING , SUCCEED , or + // FAIL . + // - TYPE: Specify one or more of the following types: CREATE_NAMESPACE , + // DELETE_NAMESPACE , UPDATE_SERVICE , REGISTER_INSTANCE , or DEREGISTER_INSTANCE + // . + // - UPDATE_DATE: Specify a start date and an end date in Unix date/time format + // and Coordinated Universal Time (UTC). The start date must be the first value. // // This member is required. Values []string // The operator that you want to use to determine whether an operation matches the // specified value. Valid values for condition include: - // - // * EQ: When you specify EQ - // for the condition, you can specify only one value. EQ is supported for - // NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can - // be omitted. - // - // * IN: When you specify IN for the condition, you can specify a list - // of one or more values. IN is supported for STATUS and TYPE. An operation must - // match one of the specified values to be returned in the response. - // - // * BETWEEN: - // Specify a start date and an end date in Unix date/time format and Coordinated - // Universal Time (UTC). The start date must be the first value. BETWEEN is - // supported for UPDATE_DATE. + // - EQ : When you specify EQ for the condition, you can specify only one value. + // EQ is supported for NAMESPACE_ID , SERVICE_ID , STATUS , and TYPE . EQ is the + // default condition and can be omitted. + // - IN : When you specify IN for the condition, you can specify a list of one or + // more values. IN is supported for STATUS and TYPE . An operation must match one + // of the specified values to be returned in the response. + // - BETWEEN : Specify a start date and an end date in Unix date/time format and + // Coordinated Universal Time (UTC). The start date must be the first value. + // BETWEEN is supported for UPDATE_DATE . Condition FilterCondition noSmithyDocumentSerde } // A complex type that contains information about an operation that matches the -// criteria that you specified in a ListOperations -// (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html) +// criteria that you specified in a ListOperations (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html) // request. type OperationSummary struct { @@ -805,17 +669,11 @@ type OperationSummary struct { Id *string // The status of the operation. Values include the following: - // - // * SUBMITTED: This is - // the initial state immediately after you submit a request. - // - // * PENDING: Cloud Map - // is performing the operation. - // - // * SUCCESS: The operation succeeded. - // - // * FAIL: The - // operation failed. For the failure reason, see ErrorMessage. + // - SUBMITTED: This is the initial state immediately after you submit a + // request. + // - PENDING: Cloud Map is performing the operation. + // - SUCCESS: The operation succeeded. + // - FAIL: The operation failed. For the failure reason, see ErrorMessage . Status OperationStatus noSmithyDocumentSerde @@ -951,24 +809,24 @@ type Service struct { CreateDate *time.Time // A unique string that identifies the request and that allows failed requests to - // be retried without the risk of running the operation twice. CreatorRequestId can - // be any unique string (for example, a date/timestamp). + // be retried without the risk of running the operation twice. CreatorRequestId + // can be any unique string (for example, a date/timestamp). CreatorRequestId *string // The description of the service. Description *string - // A complex type that contains information about the Route 53 DNS records that you - // want Cloud Map to create when you register an instance. The record types of a - // service can only be changed by deleting the service and recreating it with a new - // Dnsconfig. + // A complex type that contains information about the Route 53 DNS records that + // you want Cloud Map to create when you register an instance. The record types of + // a service can only be changed by deleting the service and recreating it with a + // new Dnsconfig . DnsConfig *DnsConfig // Public DNS and HTTP namespaces only. A complex type that contains settings for // an optional health check. If you specify settings for a health check, Cloud Map - // associates the health check with the records that you specify in DnsConfig. For - // information about the charges for health checks, see Amazon Route 53 Pricing - // (http://aws.amazon.com/route53/pricing/). + // associates the health check with the records that you specify in DnsConfig . For + // information about the charges for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/) + // . HealthCheckConfig *HealthCheckConfig // A complex type that contains information about an optional custom health check. @@ -1012,7 +870,7 @@ type ServiceChange struct { // Public DNS and HTTP namespaces only. Settings for an optional health check. If // you specify settings for a health check, Cloud Map associates the health check - // with the records that you specify in DnsConfig. + // with the records that you specify in DnsConfig . HealthCheckConfig *HealthCheckConfig noSmithyDocumentSerde @@ -1022,7 +880,7 @@ type ServiceChange struct { // services for. type ServiceFilter struct { - // Specify NAMESPACE_ID. + // Specify NAMESPACE_ID . // // This member is required. Name ServiceFilterName @@ -1034,11 +892,9 @@ type ServiceFilter struct { Values []string // The operator that you want to use to determine whether a service is returned by - // ListServices. Valid values for Condition include the following: - // - // * EQ: When you - // specify EQ, specify one namespace ID for Values. EQ is the default condition and - // can be omitted. + // ListServices . Valid values for Condition include the following: + // - EQ : When you specify EQ , specify one namespace ID for Values . EQ is the + // default condition and can be omitted. Condition FilterCondition noSmithyDocumentSerde @@ -1063,25 +919,20 @@ type ServiceSummary struct { // Public DNS and HTTP namespaces only. Settings for an optional health check. If // you specify settings for a health check, Cloud Map associates the health check - // with the records that you specify in DnsConfig. + // with the records that you specify in DnsConfig . HealthCheckConfig *HealthCheckConfig // Information about an optional custom health check. A custom health check, which // requires that you use a third-party health checker to evaluate the health of // your resources, is useful in the following circumstances: - // - // * You can't use a - // health check that's defined by HealthCheckConfig because the resource isn't - // available over the internet. For example, you can use a custom health check when - // the instance is in an Amazon VPC. (To check the health of resources in a VPC, - // the health checker must also be in the VPC.) - // - // * You want to use a third-party - // health checker regardless of where your resources are located. - // - // If you specify a - // health check configuration, you can specify either HealthCheckCustomConfig or - // HealthCheckConfig but not both. + // - You can't use a health check that's defined by HealthCheckConfig because the + // resource isn't available over the internet. For example, you can use a custom + // health check when the instance is in an Amazon VPC. (To check the health of + // resources in a VPC, the health checker must also be in the VPC.) + // - You want to use a third-party health checker regardless of where your + // resources are located. + // If you specify a health check configuration, you can specify either + // HealthCheckCustomConfig or HealthCheckConfig but not both. HealthCheckCustomConfig *HealthCheckCustomConfig // The ID that Cloud Map assigned to the service when you created it. diff --git a/service/servicequotas/api_client.go b/service/servicequotas/api_client.go index edd53653f65..0b733be897e 100644 --- a/service/servicequotas/api_client.go +++ b/service/servicequotas/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/servicequotas/api_op_GetAssociationForServiceQuotaTemplate.go b/service/servicequotas/api_op_GetAssociationForServiceQuotaTemplate.go index b60d73593db..f2283798220 100644 --- a/service/servicequotas/api_op_GetAssociationForServiceQuotaTemplate.go +++ b/service/servicequotas/api_op_GetAssociationForServiceQuotaTemplate.go @@ -33,8 +33,9 @@ type GetAssociationForServiceQuotaTemplateInput struct { type GetAssociationForServiceQuotaTemplateOutput struct { - // The association status. If the status is ASSOCIATED, the quota increase requests - // in the template are automatically applied to new accounts in your organization. + // The association status. If the status is ASSOCIATED , the quota increase + // requests in the template are automatically applied to new accounts in your + // organization. ServiceQuotaTemplateAssociationStatus types.ServiceQuotaTemplateAssociationStatus // Metadata pertaining to the operation's result. diff --git a/service/servicequotas/api_op_GetServiceQuota.go b/service/servicequotas/api_op_GetServiceQuota.go index 3464286477f..2d9389c2221 100644 --- a/service/servicequotas/api_op_GetServiceQuota.go +++ b/service/servicequotas/api_op_GetServiceQuota.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the applied quota value for the specified quota. For some quotas, only -// the default values are available. If the applied quota value is not available -// for a quota, the quota is not retrieved. +// Retrieves the applied quota value for the specified quota. For some quotas, +// only the default values are available. If the applied quota value is not +// available for a quota, the quota is not retrieved. func (c *Client) GetServiceQuota(ctx context.Context, params *GetServiceQuotaInput, optFns ...func(*Options)) (*GetServiceQuotaOutput, error) { if params == nil { params = &GetServiceQuotaInput{} diff --git a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go index d890ce1fb38..8779d73aeaa 100644 --- a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go +++ b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the default values for the quotas for the specified AWS service. A default -// value does not reflect any quota increases. +// Lists the default values for the quotas for the specified AWS service. A +// default value does not reflect any quota increases. func (c *Client) ListAWSDefaultServiceQuotas(ctx context.Context, params *ListAWSDefaultServiceQuotasInput, optFns ...func(*Options)) (*ListAWSDefaultServiceQuotasOutput, error) { if params == nil { params = &ListAWSDefaultServiceQuotasInput{} diff --git a/service/servicequotas/api_op_ListTagsForResource.go b/service/servicequotas/api_op_ListTagsForResource.go index 50a927464d3..a53ed7eed9d 100644 --- a/service/servicequotas/api_op_ListTagsForResource.go +++ b/service/servicequotas/api_op_ListTagsForResource.go @@ -31,10 +31,8 @@ type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for the applied quota for which you want to list // tags. You can get this information by using the Service Quotas console, or by - // listing the quotas using the list-service-quotas - // (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) - // AWS CLI command or the ListServiceQuotas - // (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // listing the quotas using the list-service-quotas (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) // AWS API operation. // // This member is required. diff --git a/service/servicequotas/api_op_TagResource.go b/service/servicequotas/api_op_TagResource.go index 7d693d00357..61dc2e48949 100644 --- a/service/servicequotas/api_op_TagResource.go +++ b/service/servicequotas/api_op_TagResource.go @@ -32,10 +32,8 @@ type TagResourceInput struct { // The Amazon Resource Name (ARN) for the applied quota. You can get this // information by using the Service Quotas console, or by listing the quotas using - // the list-service-quotas - // (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) - // AWS CLI command or the ListServiceQuotas - // (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // the list-service-quotas (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) // AWS API operation. // // This member is required. diff --git a/service/servicequotas/api_op_UntagResource.go b/service/servicequotas/api_op_UntagResource.go index 7e43661e98c..ed42b94dd47 100644 --- a/service/servicequotas/api_op_UntagResource.go +++ b/service/servicequotas/api_op_UntagResource.go @@ -29,12 +29,10 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) for the applied quota that you want to untag. You - // can get this information by using the Service Quotas console, or by listing the - // quotas using the list-service-quotas - // (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) - // AWS CLI command or the ListServiceQuotas - // (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // The Amazon Resource Name (ARN) for the applied quota that you want to untag. + // You can get this information by using the Service Quotas console, or by listing + // the quotas using the list-service-quotas (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) // AWS API operation. // // This member is required. diff --git a/service/servicequotas/doc.go b/service/servicequotas/doc.go index 938a774ba4e..215fe7c3a4a 100644 --- a/service/servicequotas/doc.go +++ b/service/servicequotas/doc.go @@ -6,6 +6,6 @@ // With Service Quotas, you can view and manage your quotas easily as your AWS // workloads grow. Quotas, also referred to as limits, are the maximum number of // resources that you can create in your AWS account. For more information, see the -// Service Quotas User Guide -// (https://docs.aws.amazon.com/servicequotas/latest/userguide/). +// Service Quotas User Guide (https://docs.aws.amazon.com/servicequotas/latest/userguide/) +// . package servicequotas diff --git a/service/servicequotas/types/enums.go b/service/servicequotas/types/enums.go index 5e70047383d..755c7988bcd 100644 --- a/service/servicequotas/types/enums.go +++ b/service/servicequotas/types/enums.go @@ -12,9 +12,9 @@ const ( ErrorCodeServiceQuotaNotAvailableError ErrorCode = "SERVICE_QUOTA_NOT_AVAILABLE_ERROR" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "DEPENDENCY_ACCESS_DENIED_ERROR", diff --git a/service/servicequotas/types/errors.go b/service/servicequotas/types/errors.go index cc80c77bad1..1c3356d1e58 100644 --- a/service/servicequotas/types/errors.go +++ b/service/servicequotas/types/errors.go @@ -435,9 +435,8 @@ func (e *TooManyRequestsException) ErrorCode() string { } func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've exceeded the number of tags allowed for a resource. For more information, -// see Tag restrictions -// (https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions) +// You've exceeded the number of tags allowed for a resource. For more +// information, see Tag restrictions (https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions) // in the Service Quotas User Guide. type TooManyTagsException struct { Message *string diff --git a/service/servicequotas/types/types.go b/service/servicequotas/types/types.go index 526e36ed66d..16860aed514 100644 --- a/service/servicequotas/types/types.go +++ b/service/servicequotas/types/types.go @@ -11,20 +11,12 @@ import ( type ErrorReason struct { // Service Quotas returns the following error values: - // - // * - // DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required - // permissions to complete the action. To resolve the error, you must have - // permission to access the service or quota. - // - // * DEPENDENCY_THROTTLING_ERROR - The - // service is throttling Service Quotas. - // - // * DEPENDENCY_SERVICE_ERROR - The service - // is not available. - // - // * SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in - // Service Quotas. + // - DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required + // permissions to complete the action. To resolve the error, you must have + // permission to access the service or quota. + // - DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas. + // - DEPENDENCY_SERVICE_ERROR - The service is not available. + // - SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas. ErrorCode ErrorCode // The error message. diff --git a/service/ses/api_client.go b/service/ses/api_client.go index 4961ee172c0..01b23525134 100644 --- a/service/ses/api_client.go +++ b/service/ses/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ses/api_op_CloneReceiptRuleSet.go b/service/ses/api_op_CloneReceiptRuleSet.go index ca8279f3c88..6fac95047c5 100644 --- a/service/ses/api_op_CloneReceiptRuleSet.go +++ b/service/ses/api_op_CloneReceiptRuleSet.go @@ -13,9 +13,8 @@ import ( // Creates a receipt rule set by cloning an existing one. All receipt rules and // configurations are copied to the new receipt rule set and are completely // independent of the source rule set. For information about setting up rule sets, -// see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). -// You can execute this operation no more than once per second. +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html) +// . You can execute this operation no more than once per second. func (c *Client) CloneReceiptRuleSet(ctx context.Context, params *CloneReceiptRuleSetInput, optFns ...func(*Options)) (*CloneReceiptRuleSetOutput, error) { if params == nil { params = &CloneReceiptRuleSetInput{} @@ -33,8 +32,8 @@ func (c *Client) CloneReceiptRuleSet(ctx context.Context, params *CloneReceiptRu // Represents a request to create a receipt rule set by cloning an existing one. // You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type CloneReceiptRuleSetInput struct { // The name of the rule set to clone. @@ -43,15 +42,10 @@ type CloneReceiptRuleSetInput struct { OriginalRuleSetName *string // The name of the rule set to create. The name must: - // - // * This value can only - // contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes - // (-). - // - // * Start and end with a letter or number. - // - // * Contain less than 64 - // characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Start and end with a letter or number. + // - Contain less than 64 characters. // // This member is required. RuleSetName *string diff --git a/service/ses/api_op_CreateConfigurationSet.go b/service/ses/api_op_CreateConfigurationSet.go index 741d239e532..db9b07751ba 100644 --- a/service/ses/api_op_CreateConfigurationSet.go +++ b/service/ses/api_op_CreateConfigurationSet.go @@ -13,9 +13,8 @@ import ( // Creates a configuration set. Configuration sets enable you to publish email // sending events. For information about using configuration sets, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). -// You can execute this operation no more than once per second. +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error) { if params == nil { params = &CreateConfigurationSetInput{} @@ -33,8 +32,8 @@ func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfi // Represents a request to create a configuration set. Configuration sets enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type CreateConfigurationSetInput struct { // A data structure that contains the name of the configuration set. diff --git a/service/ses/api_op_CreateConfigurationSetEventDestination.go b/service/ses/api_op_CreateConfigurationSetEventDestination.go index 59a273b8cf6..2fadf25cdbb 100644 --- a/service/ses/api_op_CreateConfigurationSetEventDestination.go +++ b/service/ses/api_op_CreateConfigurationSetEventDestination.go @@ -17,9 +17,8 @@ import ( // Notification Service (Amazon SNS). An event destination is the AWS service to // which Amazon SES publishes the email sending events associated with a // configuration set. For information about using configuration sets, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &CreateConfigurationSetEventDestinationInput{} @@ -39,8 +38,8 @@ func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, par // configuration set event destination, which can be either Amazon CloudWatch or // Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes // the email sending events associated with a configuration set. For information -// about using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type CreateConfigurationSetEventDestinationInput struct { // The name of the configuration set that the event destination should be diff --git a/service/ses/api_op_CreateConfigurationSetTrackingOptions.go b/service/ses/api_op_CreateConfigurationSetTrackingOptions.go index b32499624f9..09635c34785 100644 --- a/service/ses/api_op_CreateConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_CreateConfigurationSetTrackingOptions.go @@ -15,8 +15,8 @@ import ( // and click event tracking. By default, images and links used for tracking open // and click events are hosted on domains operated by Amazon SES. You can configure // a subdomain of your own to handle these events. For information about using -// custom domains, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). +// custom domains, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) +// . func (c *Client) CreateConfigurationSetTrackingOptions(ctx context.Context, params *CreateConfigurationSetTrackingOptionsInput, optFns ...func(*Options)) (*CreateConfigurationSetTrackingOptionsOutput, error) { if params == nil { params = &CreateConfigurationSetTrackingOptionsInput{} @@ -36,8 +36,8 @@ func (c *Client) CreateConfigurationSetTrackingOptions(ctx context.Context, para // configuration set. type CreateConfigurationSetTrackingOptionsInput struct { - // The name of the configuration set that the tracking options should be associated - // with. + // The name of the configuration set that the tracking options should be + // associated with. // // This member is required. ConfigurationSetName *string @@ -45,8 +45,7 @@ type CreateConfigurationSetTrackingOptionsInput struct { // A domain that is used to redirect email recipients to an Amazon SES-operated // domain. This domain captures open and click events generated by Amazon SES // emails. For more information, see Configuring Custom Domains to Handle Open and - // Click Tracking - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) + // Click Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. // // This member is required. diff --git a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go index 5e2c717d506..f5dd7ee7a75 100644 --- a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Creates a new custom verification email template. For more information about // custom verification email templates, see Using Custom Verification Email -// Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, params *CreateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*CreateCustomVerificationEmailTemplateOutput, error) { @@ -53,8 +52,7 @@ type CreateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email must // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) + // For more information, see Custom Verification Email Frequently Asked Questions (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) // in the Amazon SES Developer Guide. // // This member is required. diff --git a/service/ses/api_op_CreateReceiptFilter.go b/service/ses/api_op_CreateReceiptFilter.go index 0ddae5b4ccb..2c545f26e61 100644 --- a/service/ses/api_op_CreateReceiptFilter.go +++ b/service/ses/api_op_CreateReceiptFilter.go @@ -12,9 +12,8 @@ import ( ) // Creates a new IP address filter. For information about setting up IP address -// filters, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). -// You can execute this operation no more than once per second. +// filters, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateReceiptFilter(ctx context.Context, params *CreateReceiptFilterInput, optFns ...func(*Options)) (*CreateReceiptFilterOutput, error) { if params == nil { params = &CreateReceiptFilterInput{} @@ -32,8 +31,8 @@ func (c *Client) CreateReceiptFilter(ctx context.Context, params *CreateReceiptF // Represents a request to create a new IP address filter. You use IP address // filters when you receive email with Amazon SES. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type CreateReceiptFilterInput struct { // A data structure that describes the IP address filter to create, which consists diff --git a/service/ses/api_op_CreateReceiptRule.go b/service/ses/api_op_CreateReceiptRule.go index 34a6046bca6..49c8e69431b 100644 --- a/service/ses/api_op_CreateReceiptRule.go +++ b/service/ses/api_op_CreateReceiptRule.go @@ -12,9 +12,8 @@ import ( ) // Creates a receipt rule. For information about setting up receipt rules, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateReceiptRule(ctx context.Context, params *CreateReceiptRuleInput, optFns ...func(*Options)) (*CreateReceiptRuleOutput, error) { if params == nil { params = &CreateReceiptRuleInput{} @@ -31,8 +30,8 @@ func (c *Client) CreateReceiptRule(ctx context.Context, params *CreateReceiptRul } // Represents a request to create a receipt rule. You use receipt rules to receive -// email with Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// email with Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type CreateReceiptRuleInput struct { // A data structure that contains the specified rule's name, actions, recipients, diff --git a/service/ses/api_op_CreateReceiptRuleSet.go b/service/ses/api_op_CreateReceiptRuleSet.go index 3dd491bc088..eb0bd690706 100644 --- a/service/ses/api_op_CreateReceiptRuleSet.go +++ b/service/ses/api_op_CreateReceiptRuleSet.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an empty receipt rule set. For information about setting up receipt rule -// sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). -// You can execute this operation no more than once per second. +// Creates an empty receipt rule set. For information about setting up receipt +// rule sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateReceiptRuleSet(ctx context.Context, params *CreateReceiptRuleSetInput, optFns ...func(*Options)) (*CreateReceiptRuleSetOutput, error) { if params == nil { params = &CreateReceiptRuleSetInput{} @@ -31,20 +30,15 @@ func (c *Client) CreateReceiptRuleSet(ctx context.Context, params *CreateReceipt // Represents a request to create an empty receipt rule set. You use receipt rule // sets to receive email with Amazon SES. For more information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type CreateReceiptRuleSetInput struct { // The name of the rule set to create. The name must: - // - // * This value can only - // contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes - // (-). - // - // * Start and end with a letter or number. - // - // * Contain less than 64 - // characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Start and end with a letter or number. + // - Contain less than 64 characters. // // This member is required. RuleSetName *string diff --git a/service/ses/api_op_CreateTemplate.go b/service/ses/api_op_CreateTemplate.go index 86cd5682a51..19db39ebc64 100644 --- a/service/ses/api_op_CreateTemplate.go +++ b/service/ses/api_op_CreateTemplate.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an email template. Email templates enable you to send personalized email -// to one or more destinations in a single API operation. For more information, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). -// You can execute this operation no more than once per second. +// Creates an email template. Email templates enable you to send personalized +// email to one or more destinations in a single API operation. For more +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error) { if params == nil { params = &CreateTemplateInput{} @@ -32,8 +31,8 @@ func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput } // Represents a request to create an email template. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type CreateTemplateInput struct { // The content of the email, composed of a subject line, an HTML part, and a diff --git a/service/ses/api_op_DeleteConfigurationSet.go b/service/ses/api_op_DeleteConfigurationSet.go index 6498e691c13..4b6b22778df 100644 --- a/service/ses/api_op_DeleteConfigurationSet.go +++ b/service/ses/api_op_DeleteConfigurationSet.go @@ -12,9 +12,8 @@ import ( // Deletes a configuration set. Configuration sets enable you to publish email // sending events. For information about using configuration sets, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). -// You can execute this operation no more than once per second. +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error) { if params == nil { params = &DeleteConfigurationSetInput{} @@ -32,8 +31,8 @@ func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfi // Represents a request to delete a configuration set. Configuration sets enable // you to publish email sending events. For information about using configuration -// sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type DeleteConfigurationSetInput struct { // The name of the configuration set to delete. diff --git a/service/ses/api_op_DeleteConfigurationSetEventDestination.go b/service/ses/api_op_DeleteConfigurationSetEventDestination.go index 8901121451c..0de9d675339 100644 --- a/service/ses/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/ses/api_op_DeleteConfigurationSetEventDestination.go @@ -13,9 +13,8 @@ import ( // Deletes a configuration set event destination. Configuration set event // destinations are associated with configuration sets, which enable you to publish // email sending events. For information about using configuration sets, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error) { if params == nil { params = &DeleteConfigurationSetEventDestinationInput{} @@ -34,8 +33,8 @@ func (c *Client) DeleteConfigurationSetEventDestination(ctx context.Context, par // Represents a request to delete a configuration set event destination. // Configuration set event destinations are associated with configuration sets, // which enable you to publish email sending events. For information about using -// configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type DeleteConfigurationSetEventDestinationInput struct { // The name of the configuration set from which to delete the event destination. diff --git a/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go b/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go index bdd0e42214a..7a2530e85c1 100644 --- a/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go @@ -14,11 +14,10 @@ import ( // and click event tracking. By default, images and links used for tracking open // and click events are hosted on domains operated by Amazon SES. You can configure // a subdomain of your own to handle these events. For information about using -// custom domains, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). -// Deleting this kind of association will result in emails sent using the specified -// configuration set to capture open and click events using the standard, Amazon -// SES-operated domains. +// custom domains, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) +// . Deleting this kind of association will result in emails sent using the +// specified configuration set to capture open and click events using the standard, +// Amazon SES-operated domains. func (c *Client) DeleteConfigurationSetTrackingOptions(ctx context.Context, params *DeleteConfigurationSetTrackingOptionsInput, optFns ...func(*Options)) (*DeleteConfigurationSetTrackingOptionsOutput, error) { if params == nil { params = &DeleteConfigurationSetTrackingOptionsInput{} diff --git a/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go b/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go index 38f0b75a1a0..72a9c40c369 100644 --- a/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Deletes an existing custom verification email template. For more information // about custom verification email templates, see Using Custom Verification Email -// Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) DeleteCustomVerificationEmailTemplate(ctx context.Context, params *DeleteCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*DeleteCustomVerificationEmailTemplateOutput, error) { diff --git a/service/ses/api_op_DeleteIdentityPolicy.go b/service/ses/api_op_DeleteIdentityPolicy.go index 5efb5a77fbd..13ef8d532a6 100644 --- a/service/ses/api_op_DeleteIdentityPolicy.go +++ b/service/ses/api_op_DeleteIdentityPolicy.go @@ -16,9 +16,8 @@ import ( // you have not verified the identity, this API will return an error. Sending // authorization is a feature that enables an identity owner to authorize other // senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteIdentityPolicy(ctx context.Context, params *DeleteIdentityPolicyInput, optFns ...func(*Options)) (*DeleteIdentityPolicyOutput, error) { if params == nil { params = &DeleteIdentityPolicyInput{} @@ -37,14 +36,14 @@ func (c *Client) DeleteIdentityPolicy(ctx context.Context, params *DeleteIdentit // Represents a request to delete a sending authorization policy for an identity. // Sending authorization is an Amazon SES feature that enables you to authorize // other senders to use your identities. For information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . type DeleteIdentityPolicyInput struct { - // The identity that is associated with the policy that you want to delete. You can - // specify the identity by using its name or by using its Amazon Resource Name - // (ARN). Examples: user@example.com, example.com, - // arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call + // The identity that is associated with the policy that you want to delete. You + // can specify the identity by using its name or by using its Amazon Resource Name + // (ARN). Examples: user@example.com , example.com , + // arn:aws:ses:us-east-1:123456789012:identity/example.com . To successfully call // this API, you must own the identity. // // This member is required. diff --git a/service/ses/api_op_DeleteReceiptFilter.go b/service/ses/api_op_DeleteReceiptFilter.go index 307df7eacde..d5247b08de5 100644 --- a/service/ses/api_op_DeleteReceiptFilter.go +++ b/service/ses/api_op_DeleteReceiptFilter.go @@ -11,9 +11,8 @@ import ( ) // Deletes the specified IP address filter. For information about managing IP -// address filters, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html). -// You can execute this operation no more than once per second. +// address filters, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteReceiptFilter(ctx context.Context, params *DeleteReceiptFilterInput, optFns ...func(*Options)) (*DeleteReceiptFilterOutput, error) { if params == nil { params = &DeleteReceiptFilterInput{} @@ -30,9 +29,9 @@ func (c *Client) DeleteReceiptFilter(ctx context.Context, params *DeleteReceiptF } // Represents a request to delete an IP address filter. You use IP address filters -// when you receive email with Amazon SES. For more information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// when you receive email with Amazon SES. For more information, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DeleteReceiptFilterInput struct { // The name of the IP address filter to delete. diff --git a/service/ses/api_op_DeleteReceiptRule.go b/service/ses/api_op_DeleteReceiptRule.go index e3dc096f9cb..c5fbe0c1f69 100644 --- a/service/ses/api_op_DeleteReceiptRule.go +++ b/service/ses/api_op_DeleteReceiptRule.go @@ -11,9 +11,8 @@ import ( ) // Deletes the specified receipt rule. For information about managing receipt -// rules, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). -// You can execute this operation no more than once per second. +// rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteReceiptRule(ctx context.Context, params *DeleteReceiptRuleInput, optFns ...func(*Options)) (*DeleteReceiptRuleOutput, error) { if params == nil { params = &DeleteReceiptRuleInput{} @@ -30,8 +29,8 @@ func (c *Client) DeleteReceiptRule(ctx context.Context, params *DeleteReceiptRul } // Represents a request to delete a receipt rule. You use receipt rules to receive -// email with Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// email with Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DeleteReceiptRuleInput struct { // The name of the receipt rule to delete. diff --git a/service/ses/api_op_DeleteReceiptRuleSet.go b/service/ses/api_op_DeleteReceiptRuleSet.go index 28966fa70b4..7f51f8207a7 100644 --- a/service/ses/api_op_DeleteReceiptRuleSet.go +++ b/service/ses/api_op_DeleteReceiptRuleSet.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified receipt rule set and all of the receipt rules it contains. -// The currently active rule set cannot be deleted. For information about managing -// receipt rule sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). -// You can execute this operation no more than once per second. +// Deletes the specified receipt rule set and all of the receipt rules it +// contains. The currently active rule set cannot be deleted. For information about +// managing receipt rule sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteReceiptRuleSet(ctx context.Context, params *DeleteReceiptRuleSetInput, optFns ...func(*Options)) (*DeleteReceiptRuleSetOutput, error) { if params == nil { params = &DeleteReceiptRuleSetInput{} @@ -32,8 +31,8 @@ func (c *Client) DeleteReceiptRuleSet(ctx context.Context, params *DeleteReceipt // Represents a request to delete a receipt rule set and all of the receipt rules // it contains. You use receipt rule sets to receive email with Amazon SES. For -// more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DeleteReceiptRuleSetInput struct { // The name of the receipt rule set to delete. diff --git a/service/ses/api_op_DeleteTemplate.go b/service/ses/api_op_DeleteTemplate.go index 7a74fd1bafb..6d258aa5795 100644 --- a/service/ses/api_op_DeleteTemplate.go +++ b/service/ses/api_op_DeleteTemplate.go @@ -28,8 +28,8 @@ func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput } // Represents a request to delete an email template. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type DeleteTemplateInput struct { // The name of the template to be deleted. diff --git a/service/ses/api_op_DeleteVerifiedEmailAddress.go b/service/ses/api_op_DeleteVerifiedEmailAddress.go index 4c00167f26d..d2eb245c758 100644 --- a/service/ses/api_op_DeleteVerifiedEmailAddress.go +++ b/service/ses/api_op_DeleteVerifiedEmailAddress.go @@ -27,8 +27,8 @@ func (c *Client) DeleteVerifiedEmailAddress(ctx context.Context, params *DeleteV return out, nil } -// Represents a request to delete an email address from the list of email addresses -// you have attempted to verify under your AWS account. +// Represents a request to delete an email address from the list of email +// addresses you have attempted to verify under your AWS account. type DeleteVerifiedEmailAddressInput struct { // An email address to be removed from the list of verified addresses. diff --git a/service/ses/api_op_DescribeActiveReceiptRuleSet.go b/service/ses/api_op_DescribeActiveReceiptRuleSet.go index 1bcf9a42cdf..c24c4ba53b4 100644 --- a/service/ses/api_op_DescribeActiveReceiptRuleSet.go +++ b/service/ses/api_op_DescribeActiveReceiptRuleSet.go @@ -13,9 +13,8 @@ import ( // Returns the metadata and receipt rules for the receipt rule set that is // currently active. For information about setting up receipt rule sets, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html) +// . You can execute this operation no more than once per second. func (c *Client) DescribeActiveReceiptRuleSet(ctx context.Context, params *DescribeActiveReceiptRuleSetInput, optFns ...func(*Options)) (*DescribeActiveReceiptRuleSetOutput, error) { if params == nil { params = &DescribeActiveReceiptRuleSetInput{} @@ -33,8 +32,8 @@ func (c *Client) DescribeActiveReceiptRuleSet(ctx context.Context, params *Descr // Represents a request to return the metadata and receipt rules for the receipt // rule set that is currently active. You use receipt rule sets to receive email -// with Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// with Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DescribeActiveReceiptRuleSetInput struct { noSmithyDocumentSerde } @@ -43,8 +42,8 @@ type DescribeActiveReceiptRuleSetInput struct { // currently active. type DescribeActiveReceiptRuleSetOutput struct { - // The metadata for the currently active receipt rule set. The metadata consists of - // the rule set name and a timestamp of when the rule set was created. + // The metadata for the currently active receipt rule set. The metadata consists + // of the rule set name and a timestamp of when the rule set was created. Metadata *types.ReceiptRuleSetMetadata // The receipt rules that belong to the active rule set. diff --git a/service/ses/api_op_DescribeConfigurationSet.go b/service/ses/api_op_DescribeConfigurationSet.go index 3051d3e5a28..8b981f03f01 100644 --- a/service/ses/api_op_DescribeConfigurationSet.go +++ b/service/ses/api_op_DescribeConfigurationSet.go @@ -12,9 +12,8 @@ import ( ) // Returns the details of the specified configuration set. For information about -// using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). -// You can execute this operation no more than once per second. +// using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . You can execute this operation no more than once per second. func (c *Client) DescribeConfigurationSet(ctx context.Context, params *DescribeConfigurationSetInput, optFns ...func(*Options)) (*DescribeConfigurationSetOutput, error) { if params == nil { params = &DescribeConfigurationSetInput{} @@ -30,10 +29,10 @@ func (c *Client) DescribeConfigurationSet(ctx context.Context, params *DescribeC return out, nil } -// Represents a request to return the details of a configuration set. Configuration -// sets enable you to publish email sending events. For information about using -// configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Represents a request to return the details of a configuration set. +// Configuration sets enable you to publish email sending events. For information +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type DescribeConfigurationSetInput struct { // The name of the configuration set to describe. @@ -49,8 +48,8 @@ type DescribeConfigurationSetInput struct { // Represents the details of a configuration set. Configuration sets enable you to // publish email sending events. For information about using configuration sets, -// see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type DescribeConfigurationSetOutput struct { // The configuration set object associated with the specified configuration set. diff --git a/service/ses/api_op_DescribeReceiptRule.go b/service/ses/api_op_DescribeReceiptRule.go index 3e31e4390e4..4676efb17c9 100644 --- a/service/ses/api_op_DescribeReceiptRule.go +++ b/service/ses/api_op_DescribeReceiptRule.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the details of the specified receipt rule. For information about setting -// up receipt rules, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). -// You can execute this operation no more than once per second. +// Returns the details of the specified receipt rule. For information about +// setting up receipt rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html) +// . You can execute this operation no more than once per second. func (c *Client) DescribeReceiptRule(ctx context.Context, params *DescribeReceiptRuleInput, optFns ...func(*Options)) (*DescribeReceiptRuleOutput, error) { if params == nil { params = &DescribeReceiptRuleInput{} @@ -31,9 +30,9 @@ func (c *Client) DescribeReceiptRule(ctx context.Context, params *DescribeReceip } // Represents a request to return the details of a receipt rule. You use receipt -// rules to receive email with Amazon SES. For more information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// rules to receive email with Amazon SES. For more information, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DescribeReceiptRuleInput struct { // The name of the receipt rule. diff --git a/service/ses/api_op_DescribeReceiptRuleSet.go b/service/ses/api_op_DescribeReceiptRuleSet.go index a8cf72cc5a5..fb16ab34fc2 100644 --- a/service/ses/api_op_DescribeReceiptRuleSet.go +++ b/service/ses/api_op_DescribeReceiptRuleSet.go @@ -12,9 +12,8 @@ import ( ) // Returns the details of the specified receipt rule set. For information about -// managing receipt rule sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). -// You can execute this operation no more than once per second. +// managing receipt rule sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) +// . You can execute this operation no more than once per second. func (c *Client) DescribeReceiptRuleSet(ctx context.Context, params *DescribeReceiptRuleSetInput, optFns ...func(*Options)) (*DescribeReceiptRuleSetOutput, error) { if params == nil { params = &DescribeReceiptRuleSetInput{} @@ -32,8 +31,8 @@ func (c *Client) DescribeReceiptRuleSet(ctx context.Context, params *DescribeRec // Represents a request to return the details of a receipt rule set. You use // receipt rule sets to receive email with Amazon SES. For more information, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type DescribeReceiptRuleSetInput struct { // The name of the receipt rule set to describe. diff --git a/service/ses/api_op_GetCustomVerificationEmailTemplate.go b/service/ses/api_op_GetCustomVerificationEmailTemplate.go index 27e868ad302..e1b475b7fc9 100644 --- a/service/ses/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_GetCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Returns the custom email verification template for the template name you // specify. For more information about custom verification email templates, see -// Using Custom Verification Email Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) GetCustomVerificationEmailTemplate(ctx context.Context, params *GetCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*GetCustomVerificationEmailTemplateOutput, error) { diff --git a/service/ses/api_op_GetIdentityDkimAttributes.go b/service/ses/api_op_GetIdentityDkimAttributes.go index 09f757356ae..a30db5a7271 100644 --- a/service/ses/api_op_GetIdentityDkimAttributes.go +++ b/service/ses/api_op_GetIdentityDkimAttributes.go @@ -16,23 +16,17 @@ import ( // Easy DKIM signing, and whether Amazon SES has successfully verified that these // tokens have been published. This operation takes a list of identities as input // and returns the following information for each: +// - Whether Easy DKIM signing is enabled or disabled. +// - A set of DKIM tokens that represent the identity. If the identity is an +// email address, the tokens represent the domain of that address. +// - Whether Amazon SES has successfully verified the DKIM tokens published in +// the domain's DNS. This information is only returned for domain name identities, +// not for email addresses. // -// * Whether Easy DKIM signing is -// enabled or disabled. -// -// * A set of DKIM tokens that represent the identity. If the -// identity is an email address, the tokens represent the domain of that -// address. -// -// * Whether Amazon SES has successfully verified the DKIM tokens -// published in the domain's DNS. This information is only returned for domain name -// identities, not for email addresses. -// -// This operation is throttled at one request -// per second and can only get DKIM attributes for up to 100 identities at a time. -// For more information about creating DNS records using DKIM tokens, go to the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html). +// This operation is throttled at one request per second and can only get DKIM +// attributes for up to 100 identities at a time. For more information about +// creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html) +// . func (c *Client) GetIdentityDkimAttributes(ctx context.Context, params *GetIdentityDkimAttributesInput, optFns ...func(*Options)) (*GetIdentityDkimAttributesOutput, error) { if params == nil { params = &GetIdentityDkimAttributesInput{} @@ -52,8 +46,8 @@ func (c *Client) GetIdentityDkimAttributes(ctx context.Context, params *GetIdent // identity. For domain identities, this request also returns the DKIM tokens that // are required for Easy DKIM signing, and whether Amazon SES successfully verified // that these tokens were published. For more information about Easy DKIM, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . type GetIdentityDkimAttributesInput struct { // A list of one or more verified identities - email addresses, domains, or both. diff --git a/service/ses/api_op_GetIdentityMailFromDomainAttributes.go b/service/ses/api_op_GetIdentityMailFromDomainAttributes.go index 73d4bbd09a0..ce72a4a65f8 100644 --- a/service/ses/api_op_GetIdentityMailFromDomainAttributes.go +++ b/service/ses/api_op_GetIdentityMailFromDomainAttributes.go @@ -31,8 +31,8 @@ func (c *Client) GetIdentityMailFromDomainAttributes(ctx context.Context, params // Represents a request to return the Amazon SES custom MAIL FROM attributes for a // list of identities. For information about using a custom MAIL FROM domain, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html) +// . type GetIdentityMailFromDomainAttributesInput struct { // A list of one or more identities. diff --git a/service/ses/api_op_GetIdentityNotificationAttributes.go b/service/ses/api_op_GetIdentityNotificationAttributes.go index 3b9af7db8ec..c3d9dc08c18 100644 --- a/service/ses/api_op_GetIdentityNotificationAttributes.go +++ b/service/ses/api_op_GetIdentityNotificationAttributes.go @@ -15,8 +15,8 @@ import ( // structure describing identity notification attributes. This operation is // throttled at one request per second and can only get notification attributes for // up to 100 identities at a time. For more information about using notifications -// with Amazon SES, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// with Amazon SES, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html) +// . func (c *Client) GetIdentityNotificationAttributes(ctx context.Context, params *GetIdentityNotificationAttributesInput, optFns ...func(*Options)) (*GetIdentityNotificationAttributesOutput, error) { if params == nil { params = &GetIdentityNotificationAttributesInput{} @@ -34,13 +34,13 @@ func (c *Client) GetIdentityNotificationAttributes(ctx context.Context, params * // Represents a request to return the notification attributes for a list of // identities you verified with Amazon SES. For information about Amazon SES -// notifications, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html) +// . type GetIdentityNotificationAttributesInput struct { // A list of one or more identities. You can specify an identity by using its name - // or by using its Amazon Resource Name (ARN). Examples: user@example.com, - // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // or by using its Amazon Resource Name (ARN). Examples: user@example.com , + // example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com . // // This member is required. Identities []string diff --git a/service/ses/api_op_GetIdentityPolicies.go b/service/ses/api_op_GetIdentityPolicies.go index 9c1df271076..1defbb057ef 100644 --- a/service/ses/api_op_GetIdentityPolicies.go +++ b/service/ses/api_op_GetIdentityPolicies.go @@ -16,9 +16,8 @@ import ( // API is for the identity owner only. If you have not verified the identity, this // API will return an error. Sending authorization is a feature that enables an // identity owner to authorize other senders to use its identities. For information -// about using sending authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) GetIdentityPolicies(ctx context.Context, params *GetIdentityPoliciesInput, optFns ...func(*Options)) (*GetIdentityPoliciesOutput, error) { if params == nil { params = &GetIdentityPoliciesInput{} @@ -37,14 +36,14 @@ func (c *Client) GetIdentityPolicies(ctx context.Context, params *GetIdentityPol // Represents a request to return the requested sending authorization policies for // an identity. Sending authorization is an Amazon SES feature that enables you to // authorize other senders to use your identities. For information, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . type GetIdentityPoliciesInput struct { // The identity for which the policies will be retrieved. You can specify an // identity by using its name or by using its Amazon Resource Name (ARN). Examples: - // user@example.com, example.com, - // arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call + // user@example.com , example.com , + // arn:aws:ses:us-east-1:123456789012:identity/example.com . To successfully call // this API, you must own the identity. // // This member is required. @@ -52,7 +51,7 @@ type GetIdentityPoliciesInput struct { // A list of the names of policies to be retrieved. You can retrieve a maximum of // 20 policies at a time. If you do not know the names of the policies that are - // attached to the identity, you can use ListIdentityPolicies. + // attached to the identity, you can use ListIdentityPolicies . // // This member is required. PolicyNames []string diff --git a/service/ses/api_op_GetIdentityVerificationAttributes.go b/service/ses/api_op_GetIdentityVerificationAttributes.go index d55cdde6e24..2603dfdf823 100644 --- a/service/ses/api_op_GetIdentityVerificationAttributes.go +++ b/service/ses/api_op_GetIdentityVerificationAttributes.go @@ -51,8 +51,8 @@ func (c *Client) GetIdentityVerificationAttributes(ctx context.Context, params * // Represents a request to return the Amazon SES verification status of a list of // identities. For domain identities, this request also returns the verification // token. For information about verifying identities with Amazon SES, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// . type GetIdentityVerificationAttributesInput struct { // A list of identities. @@ -162,9 +162,9 @@ type IdentityExistsWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, IdentityExistsWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, IdentityExistsWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/ses/api_op_ListConfigurationSets.go b/service/ses/api_op_ListConfigurationSets.go index 30b88dbf285..40659f90bae 100644 --- a/service/ses/api_op_ListConfigurationSets.go +++ b/service/ses/api_op_ListConfigurationSets.go @@ -13,8 +13,7 @@ import ( // Provides a list of the configuration sets associated with your Amazon SES // account in the current AWS Region. For information about using configuration -// sets, see Monitoring Your Amazon SES Sending Activity -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. This operation will return up to 1,000 configuration sets each // time it is run. If your Amazon SES account has more than 1,000 configuration @@ -38,8 +37,8 @@ func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigur // Represents a request to list the configuration sets associated with your AWS // account. Configuration sets enable you to publish email sending events. For -// information about using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// information about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type ListConfigurationSetsInput struct { // The number of configuration sets to return. @@ -54,15 +53,15 @@ type ListConfigurationSetsInput struct { // A list of configuration sets associated with your AWS account. Configuration // sets enable you to publish email sending events. For information about using -// configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type ListConfigurationSetsOutput struct { // A list of configuration sets. ConfigurationSets []types.ConfigurationSet // A token indicating that there are additional configuration sets available to be - // listed. Pass this token to successive calls of ListConfigurationSets. + // listed. Pass this token to successive calls of ListConfigurationSets . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ses/api_op_ListCustomVerificationEmailTemplates.go b/service/ses/api_op_ListCustomVerificationEmailTemplates.go index 275ab091cfe..94e61992d55 100644 --- a/service/ses/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/ses/api_op_ListCustomVerificationEmailTemplates.go @@ -14,8 +14,7 @@ import ( // Lists the existing custom verification email templates for your account in the // current AWS Region. For more information about custom verification email -// templates, see Using Custom Verification Email Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// templates, see Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error) { @@ -35,8 +34,7 @@ func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, param // Represents a request to list the existing custom verification email templates // for your account. For more information about custom verification email -// templates, see Using Custom Verification Email Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// templates, see Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. type ListCustomVerificationEmailTemplatesInput struct { @@ -46,8 +44,8 @@ type ListCustomVerificationEmailTemplatesInput struct { // return up to 50 results. MaxResults *int32 - // An array the contains the name and creation time stamp for each template in your - // Amazon SES account. + // An array the contains the name and creation time stamp for each template in + // your Amazon SES account. NextToken *string noSmithyDocumentSerde @@ -59,9 +57,9 @@ type ListCustomVerificationEmailTemplatesOutput struct { // A list of the custom verification email templates that exist in your account. CustomVerificationEmailTemplates []types.CustomVerificationEmailTemplate - // A token indicating that there are additional custom verification email templates - // available to be listed. Pass this token to a subsequent call to ListTemplates to - // retrieve the next 50 custom verification email templates. + // A token indicating that there are additional custom verification email + // templates available to be listed. Pass this token to a subsequent call to + // ListTemplates to retrieve the next 50 custom verification email templates. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/ses/api_op_ListIdentityPolicies.go b/service/ses/api_op_ListIdentityPolicies.go index 6f6c34a6ea1..57d460eba33 100644 --- a/service/ses/api_op_ListIdentityPolicies.go +++ b/service/ses/api_op_ListIdentityPolicies.go @@ -12,13 +12,12 @@ import ( // Returns a list of sending authorization policies that are attached to the given // identity (an email address or a domain). This API returns only a list. If you -// want the actual policy content, you can use GetIdentityPolicies. This API is for -// the identity owner only. If you have not verified the identity, this API will -// return an error. Sending authorization is a feature that enables an identity -// owner to authorize other senders to use its identities. For information about -// using sending authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// want the actual policy content, you can use GetIdentityPolicies . This API is +// for the identity owner only. If you have not verified the identity, this API +// will return an error. Sending authorization is a feature that enables an +// identity owner to authorize other senders to use its identities. For information +// about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) ListIdentityPolicies(ctx context.Context, params *ListIdentityPoliciesInput, optFns ...func(*Options)) (*ListIdentityPoliciesOutput, error) { if params == nil { params = &ListIdentityPoliciesInput{} @@ -34,17 +33,17 @@ func (c *Client) ListIdentityPolicies(ctx context.Context, params *ListIdentityP return out, nil } -// Represents a request to return a list of sending authorization policies that are -// attached to an identity. Sending authorization is an Amazon SES feature that +// Represents a request to return a list of sending authorization policies that +// are attached to an identity. Sending authorization is an Amazon SES feature that // enables you to authorize other senders to use your identities. For information, -// see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . type ListIdentityPoliciesInput struct { // The identity that is associated with the policy for which the policies will be // listed. You can specify an identity by using its name or by using its Amazon - // Resource Name (ARN). Examples: user@example.com, example.com, - // arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call + // Resource Name (ARN). Examples: user@example.com , example.com , + // arn:aws:ses:us-east-1:123456789012:identity/example.com . To successfully call // this API, you must own the identity. // // This member is required. diff --git a/service/ses/api_op_ListReceiptFilters.go b/service/ses/api_op_ListReceiptFilters.go index 2af90b958a2..19834b83b2f 100644 --- a/service/ses/api_op_ListReceiptFilters.go +++ b/service/ses/api_op_ListReceiptFilters.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the IP address filters associated with your AWS account in the current AWS -// Region. For information about managing IP address filters, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html). -// You can execute this operation no more than once per second. +// Lists the IP address filters associated with your AWS account in the current +// AWS Region. For information about managing IP address filters, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html) +// . You can execute this operation no more than once per second. func (c *Client) ListReceiptFilters(ctx context.Context, params *ListReceiptFiltersInput, optFns ...func(*Options)) (*ListReceiptFiltersOutput, error) { if params == nil { params = &ListReceiptFiltersInput{} @@ -33,8 +32,8 @@ func (c *Client) ListReceiptFilters(ctx context.Context, params *ListReceiptFilt // Represents a request to list the IP address filters that exist under your AWS // account. You use IP address filters when you receive email with Amazon SES. For -// more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type ListReceiptFiltersInput struct { noSmithyDocumentSerde } @@ -42,8 +41,8 @@ type ListReceiptFiltersInput struct { // A list of IP address filters that exist under your AWS account. type ListReceiptFiltersOutput struct { - // A list of IP address filter data structures, which each consist of a name, an IP - // address range, and whether to allow or block mail from it. + // A list of IP address filter data structures, which each consist of a name, an + // IP address range, and whether to allow or block mail from it. Filters []types.ReceiptFilter // Metadata pertaining to the operation's result. diff --git a/service/ses/api_op_ListReceiptRuleSets.go b/service/ses/api_op_ListReceiptRuleSets.go index 065fe473675..fc2ed1022e7 100644 --- a/service/ses/api_op_ListReceiptRuleSets.go +++ b/service/ses/api_op_ListReceiptRuleSets.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the receipt rule sets that exist under your AWS account in the current AWS -// Region. If there are additional receipt rule sets to be retrieved, you will +// Lists the receipt rule sets that exist under your AWS account in the current +// AWS Region. If there are additional receipt rule sets to be retrieved, you will // receive a NextToken that you can provide to the next call to ListReceiptRuleSets // to retrieve the additional entries. For information about managing receipt rule -// sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). -// You can execute this operation no more than once per second. +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) +// . You can execute this operation no more than once per second. func (c *Client) ListReceiptRuleSets(ctx context.Context, params *ListReceiptRuleSetsInput, optFns ...func(*Options)) (*ListReceiptRuleSetsOutput, error) { if params == nil { params = &ListReceiptRuleSetsInput{} @@ -35,8 +34,8 @@ func (c *Client) ListReceiptRuleSets(ctx context.Context, params *ListReceiptRul // Represents a request to list the receipt rule sets that exist under your AWS // account. You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type ListReceiptRuleSetsInput struct { // A token returned from a previous call to ListReceiptRuleSets to indicate the @@ -54,8 +53,8 @@ type ListReceiptRuleSetsOutput struct { // up to 100 receipt rule sets at a time. NextToken *string - // The metadata for the currently active receipt rule set. The metadata consists of - // the rule set name and the timestamp of when the rule set was created. + // The metadata for the currently active receipt rule set. The metadata consists + // of the rule set name and the timestamp of when the rule set was created. RuleSets []types.ReceiptRuleSetMetadata // Metadata pertaining to the operation's result. diff --git a/service/ses/api_op_ListTemplates.go b/service/ses/api_op_ListTemplates.go index 104022d94e0..97ab129ec14 100644 --- a/service/ses/api_op_ListTemplates.go +++ b/service/ses/api_op_ListTemplates.go @@ -50,8 +50,8 @@ type ListTemplatesOutput struct { // next 50 email templates. NextToken *string - // An array the contains the name and creation time stamp for each template in your - // Amazon SES account. + // An array the contains the name and creation time stamp for each template in + // your Amazon SES account. TemplatesMetadata []types.TemplateMetadata // Metadata pertaining to the operation's result. diff --git a/service/ses/api_op_PutConfigurationSetDeliveryOptions.go b/service/ses/api_op_PutConfigurationSetDeliveryOptions.go index cefe6639959..2308ea9d647 100644 --- a/service/ses/api_op_PutConfigurationSetDeliveryOptions.go +++ b/service/ses/api_op_PutConfigurationSetDeliveryOptions.go @@ -43,8 +43,8 @@ type PutConfigurationSetDeliveryOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetDeliveryOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ses/api_op_PutIdentityPolicy.go b/service/ses/api_op_PutIdentityPolicy.go index 985e5b194dc..2928ea53b65 100644 --- a/service/ses/api_op_PutIdentityPolicy.go +++ b/service/ses/api_op_PutIdentityPolicy.go @@ -15,9 +15,8 @@ import ( // not verified the identity, this API will return an error. Sending authorization // is a feature that enables an identity owner to authorize other senders to use // its identities. For information about using sending authorization, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) PutIdentityPolicy(ctx context.Context, params *PutIdentityPolicyInput, optFns ...func(*Options)) (*PutIdentityPolicyOutput, error) { if params == nil { params = &PutIdentityPolicyInput{} @@ -36,28 +35,29 @@ func (c *Client) PutIdentityPolicy(ctx context.Context, params *PutIdentityPolic // Represents a request to add or update a sending authorization policy for an // identity. Sending authorization is an Amazon SES feature that enables you to // authorize other senders to use your identities. For information, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . type PutIdentityPolicyInput struct { - // The identity that the policy will apply to. You can specify an identity by using - // its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, - // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To - // successfully call this API, you must own the identity. + // The identity that the policy will apply to. You can specify an identity by + // using its name or by using its Amazon Resource Name (ARN). Examples: + // user@example.com , example.com , + // arn:aws:ses:us-east-1:123456789012:identity/example.com . To successfully call + // this API, you must own the identity. // // This member is required. Identity *string // The text of the policy in JSON format. The policy cannot exceed 4 KB. For // information about the syntax of sending authorization policies, see the Amazon - // SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html) + // . // // This member is required. Policy *string - // The name of the policy. The policy name cannot exceed 64 characters and can only - // include alphanumeric characters, dashes, and underscores. + // The name of the policy. The policy name cannot exceed 64 characters and can + // only include alphanumeric characters, dashes, and underscores. // // This member is required. PolicyName *string diff --git a/service/ses/api_op_ReorderReceiptRuleSet.go b/service/ses/api_op_ReorderReceiptRuleSet.go index a8029b144df..2b47207518c 100644 --- a/service/ses/api_op_ReorderReceiptRuleSet.go +++ b/service/ses/api_op_ReorderReceiptRuleSet.go @@ -13,9 +13,8 @@ import ( // Reorders the receipt rules within a receipt rule set. All of the rules in the // rule set must be represented in this request. That is, this API will return an // error if the reorder request doesn't explicitly position all of the rules. For -// information about managing receipt rule sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). -// You can execute this operation no more than once per second. +// information about managing receipt rule sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) +// . You can execute this operation no more than once per second. func (c *Client) ReorderReceiptRuleSet(ctx context.Context, params *ReorderReceiptRuleSetInput, optFns ...func(*Options)) (*ReorderReceiptRuleSetOutput, error) { if params == nil { params = &ReorderReceiptRuleSetInput{} @@ -31,10 +30,10 @@ func (c *Client) ReorderReceiptRuleSet(ctx context.Context, params *ReorderRecei return out, nil } -// Represents a request to reorder the receipt rules within a receipt rule set. You -// use receipt rule sets to receive email with Amazon SES. For more information, -// see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// Represents a request to reorder the receipt rules within a receipt rule set. +// You use receipt rule sets to receive email with Amazon SES. For more +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type ReorderReceiptRuleSetInput struct { // A list of the specified receipt rule set's receipt rules in the order that you diff --git a/service/ses/api_op_SendBounce.go b/service/ses/api_op_SendBounce.go index e139b9cec60..afb7832f181 100644 --- a/service/ses/api_op_SendBounce.go +++ b/service/ses/api_op_SendBounce.go @@ -15,9 +15,8 @@ import ( // through Amazon SES. You can only use this API on an email up to 24 hours after // you receive it. You cannot use this API to send generic bounces for mail that // was not received by Amazon SES. For information about receiving email through -// Amazon SES, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). -// You can execute this operation no more than once per second. +// Amazon SES, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html) +// . You can execute this operation no more than once per second. func (c *Client) SendBounce(ctx context.Context, params *SendBounceInput, optFns ...func(*Options)) (*SendBounceOutput, error) { if params == nil { params = &SendBounceInput{} @@ -58,8 +57,8 @@ type SendBounceInput struct { // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to use the address in the "From" header of the bounce. For more information - // about sending authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . BounceSenderArn *string // Human-readable text for the bounce message to explain the failure. If not diff --git a/service/ses/api_op_SendBulkTemplatedEmail.go b/service/ses/api_op_SendBulkTemplatedEmail.go index 9df93cf74d5..3581d9d481a 100644 --- a/service/ses/api_op_SendBulkTemplatedEmail.go +++ b/service/ses/api_op_SendBulkTemplatedEmail.go @@ -14,39 +14,27 @@ import ( // Composes an email message to multiple destinations. The message body is created // using an email template. In order to send email using the SendBulkTemplatedEmail // operation, your call to the API must meet the following requirements: -// -// * The -// call must refer to an existing email template. You can create email templates -// using the CreateTemplate operation. -// -// * The message must be sent from a verified -// email address or domain. -// -// * If your account is still in the Amazon SES sandbox, -// you may only send to verified addresses or domains, or to email addresses -// associated with the Amazon SES Mailbox Simulator. For more information, see -// Verifying Email Addresses and Domains -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. -// -// * The maximum message size is 10 MB. -// -// * Each -// Destination parameter must include at least one recipient email address. The -// recipient address can be a To: address, a CC: address, or a BCC: address. If a -// recipient email address is invalid (that is, it is not in the format -// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be -// rejected, even if the message contains other recipients that are valid. -// -// * The -// message may not include more than 50 recipients, across the To:, CC: and BCC: -// fields. If you need to send an email message to a larger audience, you can -// divide your recipient list into groups of 50 or fewer, and then call the -// SendBulkTemplatedEmail operation several times to send the message to each -// group. -// -// * The number of destinations you can contact in a single call to the API -// may be limited by your account's maximum sending rate. +// - The call must refer to an existing email template. You can create email +// templates using the CreateTemplate operation. +// - The message must be sent from a verified email address or domain. +// - If your account is still in the Amazon SES sandbox, you may only send to +// verified addresses or domains, or to email addresses associated with the Amazon +// SES Mailbox Simulator. For more information, see Verifying Email Addresses +// and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// in the Amazon SES Developer Guide. +// - The maximum message size is 10 MB. +// - Each Destination parameter must include at least one recipient email +// address. The recipient address can be a To: address, a CC: address, or a BCC: +// address. If a recipient email address is invalid (that is, it is not in the +// format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be +// rejected, even if the message contains other recipients that are valid. +// - The message may not include more than 50 recipients, across the To:, CC: +// and BCC: fields. If you need to send an email message to a larger audience, you +// can divide your recipient list into groups of 50 or fewer, and then call the +// SendBulkTemplatedEmail operation several times to send the message to each +// group. +// - The number of destinations you can contact in a single call to the API may +// be limited by your account's maximum sending rate. func (c *Client) SendBulkTemplatedEmail(ctx context.Context, params *SendBulkTemplatedEmailInput, optFns ...func(*Options)) (*SendBulkTemplatedEmailOutput, error) { if params == nil { params = &SendBulkTemplatedEmailInput{} @@ -63,8 +51,8 @@ func (c *Client) SendBulkTemplatedEmail(ctx context.Context, params *SendBulkTem } // Represents a request to send a templated email to multiple destinations using -// Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type SendBulkTemplatedEmailInput struct { // One or more Destination objects. All of the recipients in a Destination will @@ -77,25 +65,21 @@ type SendBulkTemplatedEmailInput struct { // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). - // If you are sending on behalf of another user and have been permitted to do so by - // a sending authorization policy, then you must also specify the SourceArn + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) + // . If you are sending on behalf of another user and have been permitted to do so + // by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a - // source email address (the part of the email address that precedes the @ sign) - // may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the - // friendly name) may contain non-ASCII characters. These characters must be - // encoded using MIME encoded-word syntax, as described in RFC 2047 - // (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the - // following form: =?charset?encoding?encoded-text?=. + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/rfc6531) + // . For this reason, the local part of a source email address (the part of the + // email address that precedes the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . The sender name (also known + // as the friendly name) may contain non-ASCII characters. These characters must be + // encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . MIME encoded-word syntax uses the following form: + // =?charset?encoding?encoded-text?= . // // This member is required. Source *string @@ -106,11 +90,11 @@ type SendBulkTemplatedEmailInput struct { Template *string // The name of the configuration set to use when you send an email using - // SendBulkTemplatedEmail. + // SendBulkTemplatedEmail . ConfigurationSetName *string // A list of tags, in the form of name/value pairs, to apply to an email that you - // send to a destination using SendBulkTemplatedEmail. + // send to a destination using SendBulkTemplatedEmail . DefaultTags []types.MessageTag // A list of replacement values to apply to the template when replacement data is @@ -124,37 +108,37 @@ type SendBulkTemplatedEmailInput struct { // message, each reply-to address will receive the reply. ReplyToAddresses []string - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. If the message cannot be delivered to the recipient, then - // an error message will be returned from the recipient's ISP; this message will - // then be forwarded to the email address specified by the ReturnPath parameter. - // The ReturnPath parameter is never overwritten. This email address must be either - // individually verified with Amazon SES, or from a domain that has been verified - // with Amazon SES. + // The email address that bounces and complaints will be forwarded to when + // feedback forwarding is enabled. If the message cannot be delivered to the + // recipient, then an error message will be returned from the recipient's ISP; this + // message will then be forwarded to the email address specified by the ReturnPath + // parameter. The ReturnPath parameter is never overwritten. This email address + // must be either individually verified with Amazon SES, or from a domain that has + // been verified with Amazon SES. ReturnPath *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // you to use the email address specified in the ReturnPath parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to use feedback@example.com , then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the ReturnPath to be feedback@example.com . For more information about + // sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . ReturnPathArn *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. For more information about sending authorization, - // see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to send from user@example.com , then you would specify + // the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the Source to be user@example.com . For more information about sending + // authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . SourceArn *string // The ARN of the template to use when sending this email. diff --git a/service/ses/api_op_SendCustomVerificationEmail.go b/service/ses/api_op_SendCustomVerificationEmail.go index ba16c04c372..ae6e8542be3 100644 --- a/service/ses/api_op_SendCustomVerificationEmail.go +++ b/service/ses/api_op_SendCustomVerificationEmail.go @@ -15,8 +15,7 @@ import ( // operation, a customized verification email is sent to the specified address. To // use this operation, you must first create a custom verification email template. // For more information about creating and using custom verification email -// templates, see Using Custom Verification Email Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// templates, see Using Custom Verification Email Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) SendCustomVerificationEmail(ctx context.Context, params *SendCustomVerificationEmailInput, optFns ...func(*Options)) (*SendCustomVerificationEmailOutput, error) { diff --git a/service/ses/api_op_SendEmail.go b/service/ses/api_op_SendEmail.go index d7d7fcfa11b..c8df8f42928 100644 --- a/service/ses/api_op_SendEmail.go +++ b/service/ses/api_op_SendEmail.go @@ -14,40 +14,30 @@ import ( // Composes an email message and immediately queues it for sending. In order to // send email using the SendEmail operation, your message must meet the following // requirements: +// - The message must be sent from a verified email address or domain. If you +// attempt to send email using a non-verified address or domain, the operation will +// result in an "Email address not verified" error. +// - If your account is still in the Amazon SES sandbox, you may only send to +// verified addresses or domains, or to email addresses associated with the Amazon +// SES Mailbox Simulator. For more information, see Verifying Email Addresses +// and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// in the Amazon SES Developer Guide. +// - The maximum message size is 10 MB. +// - The message must include at least one recipient email address. The +// recipient address can be a To: address, a CC: address, or a BCC: address. If a +// recipient email address is invalid (that is, it is not in the format +// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be +// rejected, even if the message contains other recipients that are valid. +// - The message may not include more than 50 recipients, across the To:, CC: +// and BCC: fields. If you need to send an email message to a larger audience, you +// can divide your recipient list into groups of 50 or fewer, and then call the +// SendEmail operation several times to send the message to each group. // -// * The message must be sent from a verified email address or -// domain. If you attempt to send email using a non-verified address or domain, the -// operation will result in an "Email address not verified" error. -// -// * If your -// account is still in the Amazon SES sandbox, you may only send to verified -// addresses or domains, or to email addresses associated with the Amazon SES -// Mailbox Simulator. For more information, see Verifying Email Addresses and -// Domains -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. -// -// * The maximum message size is 10 MB. -// -// * The -// message must include at least one recipient email address. The recipient address -// can be a To: address, a CC: address, or a BCC: address. If a recipient email -// address is invalid (that is, it is not in the format -// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be -// rejected, even if the message contains other recipients that are valid. -// -// * The -// message may not include more than 50 recipients, across the To:, CC: and BCC: -// fields. If you need to send an email message to a larger audience, you can -// divide your recipient list into groups of 50 or fewer, and then call the -// SendEmail operation several times to send the message to each group. -// -// For every -// message that you send, the total number of recipients (including each recipient -// in the To:, CC: and BCC: fields) is counted against the maximum number of emails -// you can send in a 24-hour period (your sending quota). For more information -// about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) +// For every message that you send, the total number of recipients (including each +// recipient in the To:, CC: and BCC: fields) is counted against the maximum number +// of emails you can send in a 24-hour period (your sending quota). For more +// information about sending quotas in Amazon SES, see Managing Your Amazon SES +// Sending Limits (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) // in the Amazon SES Developer Guide. func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns ...func(*Options)) (*SendEmailOutput, error) { if params == nil { @@ -64,9 +54,9 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . return out, nil } -// Represents a request to send a single formatted email using Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). +// Represents a request to send a single formatted email using Amazon SES. For +// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html) +// . type SendEmailInput struct { // The destination for this email, composed of To:, CC:, and BCC: fields. @@ -82,71 +72,67 @@ type SendEmailInput struct { // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). - // If you are sending on behalf of another user and have been permitted to do so by - // a sending authorization policy, then you must also specify the SourceArn + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) + // . If you are sending on behalf of another user and have been permitted to do so + // by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a - // source email address (the part of the email address that precedes the @ sign) - // may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the - // friendly name) may contain non-ASCII characters. These characters must be - // encoded using MIME encoded-word syntax, as described in RFC 2047 - // (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the - // following form: =?charset?encoding?encoded-text?=. + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/rfc6531) + // . For this reason, the local part of a source email address (the part of the + // email address that precedes the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . The sender name (also known + // as the friendly name) may contain non-ASCII characters. These characters must be + // encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . MIME encoded-word syntax uses the following form: + // =?charset?encoding?encoded-text?= . // // This member is required. Source *string - // The name of the configuration set to use when you send an email using SendEmail. + // The name of the configuration set to use when you send an email using SendEmail . ConfigurationSetName *string // The reply-to email address(es) for the message. If the recipient replies to the // message, each reply-to address will receive the reply. ReplyToAddresses []string - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. If the message cannot be delivered to the recipient, then - // an error message will be returned from the recipient's ISP; this message will - // then be forwarded to the email address specified by the ReturnPath parameter. - // The ReturnPath parameter is never overwritten. This email address must be either - // individually verified with Amazon SES, or from a domain that has been verified - // with Amazon SES. + // The email address that bounces and complaints will be forwarded to when + // feedback forwarding is enabled. If the message cannot be delivered to the + // recipient, then an error message will be returned from the recipient's ISP; this + // message will then be forwarded to the email address specified by the ReturnPath + // parameter. The ReturnPath parameter is never overwritten. This email address + // must be either individually verified with Amazon SES, or from a domain that has + // been verified with Amazon SES. ReturnPath *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // you to use the email address specified in the ReturnPath parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to use feedback@example.com , then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the ReturnPath to be feedback@example.com . For more information about + // sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . ReturnPathArn *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. For more information about sending authorization, - // see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to send from user@example.com , then you would specify + // the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the Source to be user@example.com . For more information about sending + // authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . SourceArn *string // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendEmail. Tags correspond to characteristics of the email that you + // send using SendEmail . Tags correspond to characteristics of the email that you // define, so that you can publish email sending events. Tags []types.MessageTag diff --git a/service/ses/api_op_SendRawEmail.go b/service/ses/api_op_SendRawEmail.go index 766434421c7..4ea777e7725 100644 --- a/service/ses/api_op_SendRawEmail.go +++ b/service/ses/api_op_SendRawEmail.go @@ -18,86 +18,56 @@ import ( // email (such a message that contains both a text and an HTML version). You can // also use this operation to send messages that include attachments. The // SendRawEmail operation has the following requirements: +// - You can only send email from verified email addresses or domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// . If you try to send email from an address that isn't verified, the operation +// results in an "Email address not verified" error. +// - If your account is still in the Amazon SES sandbox (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html) +// , you can only send email to other verified addresses in your account, or to +// addresses that are associated with the Amazon SES mailbox simulator (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html) +// . +// - The maximum message size, including attachments, is 10 MB. +// - Each message has to include at least one recipient address. A recipient +// address includes any address on the To:, CC:, or BCC: lines. +// - If you send a single message to more than one recipient address, and one of +// the recipient addresses isn't in a valid format (that is, it's not in the format +// UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire +// message, even if the other addresses are valid. +// - Each message can include up to 50 recipient addresses across the To:, CC:, +// or BCC: lines. If you need to send a single message to more than 50 recipients, +// you have to split the list of recipient addresses into groups of less than 50 +// recipients, and send separate messages to each group. +// - Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME +// message parts. However, if Amazon SES has to modify the contents of your message +// (for example, if you use open and click tracking), 8-bit content isn't +// preserved. For this reason, we highly recommend that you encode all content that +// isn't 7-bit ASCII. For more information, see MIME Encoding (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding) +// in the Amazon SES Developer Guide. // -// * You can only send -// email from verified email addresses or domains -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). -// If you try to send email from an address that isn't verified, the operation -// results in an "Email address not verified" error. -// -// * If your account is still in -// the Amazon SES sandbox -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html), -// you can only send email to other verified addresses in your account, or to -// addresses that are associated with the Amazon SES mailbox simulator -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html). -// -// * -// The maximum message size, including attachments, is 10 MB. -// -// * Each message has -// to include at least one recipient address. A recipient address includes any -// address on the To:, CC:, or BCC: lines. -// -// * If you send a single message to more -// than one recipient address, and one of the recipient addresses isn't in a valid -// format (that is, it's not in the format -// UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire -// message, even if the other addresses are valid. -// -// * Each message can include up -// to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to -// send a single message to more than 50 recipients, you have to split the list of -// recipient addresses into groups of less than 50 recipients, and send separate -// messages to each group. -// -// * Amazon SES allows you to specify 8-bit -// Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to -// modify the contents of your message (for example, if you use open and click -// tracking), 8-bit content isn't preserved. For this reason, we highly recommend -// that you encode all content that isn't 7-bit ASCII. For more information, see -// MIME Encoding -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding) -// in the Amazon SES Developer Guide. -// -// Additionally, keep the following -// considerations in mind when using the SendRawEmail operation: -// -// * Although you -// can customize the message headers when using the SendRawEmail operation, Amazon -// SES will automatically apply its own Message-ID and Date headers; if you passed -// these headers when creating the message, they will be overwritten by the values -// that Amazon SES provides. -// -// * If you are using sending authorization to send on -// behalf of another user, SendRawEmail enables you to specify the cross-account -// identity for the email's Source, From, and Return-Path parameters in one of two -// ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn -// to the API, or you can include the following X-headers in the header of your raw -// email: -// -// * X-SES-SOURCE-ARN -// -// * X-SES-FROM-ARN -// -// * X-SES-RETURN-PATH-ARN -// -// Don't -// include these X-headers in the DKIM signature. Amazon SES removes these before -// it sends the email. If you only specify the SourceIdentityArn parameter, Amazon -// SES sets the From and Return-Path addresses to the same identity that you -// specified. For more information about sending authorization, see the Using -// Sending Authorization with Amazon SES -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) -// in the Amazon SES Developer Guide. -// -// * For every message that you send, the total -// number of recipients (including each recipient in the To:, CC: and BCC: fields) -// is counted against the maximum number of emails you can send in a 24-hour period -// (your sending quota). For more information about sending quotas in Amazon SES, -// see Managing Your Amazon SES Sending Limits -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) -// in the Amazon SES Developer Guide. +// Additionally, keep the following considerations in mind when using the +// SendRawEmail operation: +// - Although you can customize the message headers when using the SendRawEmail +// operation, Amazon SES will automatically apply its own Message-ID and Date +// headers; if you passed these headers when creating the message, they will be +// overwritten by the values that Amazon SES provides. +// - If you are using sending authorization to send on behalf of another user, +// SendRawEmail enables you to specify the cross-account identity for the email's +// Source, From, and Return-Path parameters in one of two ways: you can pass +// optional parameters SourceArn , FromArn , and/or ReturnPathArn to the API, or +// you can include the following X-headers in the header of your raw email: +// - X-SES-SOURCE-ARN +// - X-SES-FROM-ARN +// - X-SES-RETURN-PATH-ARN Don't include these X-headers in the DKIM signature. +// Amazon SES removes these before it sends the email. If you only specify the +// SourceIdentityArn parameter, Amazon SES sets the From and Return-Path +// addresses to the same identity that you specified. For more information about +// sending authorization, see the Using Sending Authorization with Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// in the Amazon SES Developer Guide. +// - For every message that you send, the total number of recipients (including +// each recipient in the To:, CC: and BCC: fields) is counted against the maximum +// number of emails you can send in a 24-hour period (your sending quota). For more +// information about sending quotas in Amazon SES, see Managing Your Amazon SES +// Sending Limits (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) +// in the Amazon SES Developer Guide. func (c *Client) SendRawEmail(ctx context.Context, params *SendRawEmailInput, optFns ...func(*Options)) (*SendRawEmailOutput, error) { if params == nil { params = &SendRawEmailInput{} @@ -114,45 +84,31 @@ func (c *Client) SendRawEmail(ctx context.Context, params *SendRawEmailInput, op } // Represents a request to send a single raw email using Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) +// . type SendRawEmailInput struct { // The raw email message itself. The message has to meet the following criteria: - // - // * - // The message has to contain a header and a body, separated by a blank line. - // - // * - // All of the required header fields must be present in the message. - // - // * Each part - // of a multipart MIME message must be formatted properly. - // - // * Attachments must be - // of a content type that Amazon SES supports. For a list on unsupported content - // types, see Unsupported Attachment Types - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html) in the - // Amazon SES Developer Guide. - // - // * The entire message must be base64-encoded. - // - // * If - // any of the MIME parts in your message contain content that is outside of the - // 7-bit ASCII character range, we highly recommend that you encode that content. - // For more information, see Sending Raw Email - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) in - // the Amazon SES Developer Guide. - // - // * Per RFC 5321 - // (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6), the maximum length of - // each line of text, including the , must not exceed 1,000 characters. + // - The message has to contain a header and a body, separated by a blank line. + // - All of the required header fields must be present in the message. + // - Each part of a multipart MIME message must be formatted properly. + // - Attachments must be of a content type that Amazon SES supports. For a list + // on unsupported content types, see Unsupported Attachment Types (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html) + // in the Amazon SES Developer Guide. + // - The entire message must be base64-encoded. + // - If any of the MIME parts in your message contain content that is outside of + // the 7-bit ASCII character range, we highly recommend that you encode that + // content. For more information, see Sending Raw Email (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) + // in the Amazon SES Developer Guide. + // - Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6) , the + // maximum length of each line of text, including the , must not exceed 1,000 + // characters. // // This member is required. RawMessage *types.RawMessage // The name of the configuration set to use when you send an email using - // SendRawEmail. + // SendRawEmail . ConfigurationSetName *string // A list of destinations for the message, consisting of To:, CC:, and BCC: @@ -166,63 +122,62 @@ type SendRawEmailInput struct { // raw message of the email. If you use both the FromArn parameter and the // corresponding X-header, Amazon SES uses the value of the FromArn parameter. For // information about when to use this parameter, see the description of - // SendRawEmail in this guide, or see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // SendRawEmail in this guide, or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html) + // . FromArn *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. Instead of using this parameter, you - // can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If - // you use both the ReturnPathArn parameter and the corresponding X-header, Amazon - // SES uses the value of the ReturnPathArn parameter. For information about when to - // use this parameter, see the description of SendRawEmail in this guide, or see - // the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // you to use the email address specified in the ReturnPath parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to use feedback@example.com , then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the ReturnPath to be feedback@example.com . Instead of using this parameter, + // you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. + // If you use both the ReturnPathArn parameter and the corresponding X-header, + // Amazon SES uses the value of the ReturnPathArn parameter. For information about + // when to use this parameter, see the description of SendRawEmail in this guide, + // or see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html) + // . ReturnPathArn *string // The identity's email address. If you do not provide a value for this parameter, // you must specify a "From" address in the raw text of the message. (You can also // specify both.) Amazon SES does not support the SMTPUTF8 extension, as described - // inRFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part - // of a source email address (the part of the email address that precedes the @ - // sign) may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the - // friendly name) may contain non-ASCII characters. These characters must be - // encoded using MIME encoded-word syntax, as described in RFC 2047 - // (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the - // following form: =?charset?encoding?encoded-text?=. If you specify the Source - // parameter and have feedback forwarding enabled, then bounces and complaints will - // be sent to this email address. This takes precedence over any Return-Path header - // that you might include in the raw text of the message. + // in RFC6531 (https://tools.ietf.org/html/rfc6531) . For this reason, the local + // part of a source email address (the part of the email address that precedes the + // @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . The sender name (also known + // as the friendly name) may contain non-ASCII characters. These characters must be + // encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . MIME encoded-word syntax uses the following form: + // =?charset?encoding?encoded-text?= . If you specify the Source parameter and + // have feedback forwarding enabled, then bounces and complaints will be sent to + // this email address. This takes precedence over any Return-Path header that you + // might include in the raw text of the message. Source *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. Instead of using this parameter, you can use the - // X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the - // SourceArn parameter and the corresponding X-header, Amazon SES uses the value of - // the SourceArn parameter. For information about when to use this parameter, see - // the description of SendRawEmail in this guide, or see the Amazon SES Developer - // Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html). + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to send from user@example.com , then you would specify + // the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the Source to be user@example.com . Instead of using this parameter, you can + // use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use + // both the SourceArn parameter and the corresponding X-header, Amazon SES uses + // the value of the SourceArn parameter. For information about when to use this + // parameter, see the description of SendRawEmail in this guide, or see the Amazon + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html) + // . SourceArn *string // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendRawEmail. Tags correspond to characteristics of the email that + // send using SendRawEmail . Tags correspond to characteristics of the email that // you define, so that you can publish email sending events. Tags []types.MessageTag diff --git a/service/ses/api_op_SendTemplatedEmail.go b/service/ses/api_op_SendTemplatedEmail.go index 78f8b80f65e..c61384ded22 100644 --- a/service/ses/api_op_SendTemplatedEmail.go +++ b/service/ses/api_op_SendTemplatedEmail.go @@ -14,46 +14,33 @@ import ( // Composes an email message using an email template and immediately queues it for // sending. In order to send email using the SendTemplatedEmail operation, your // call to the API must meet the following requirements: +// - The call must refer to an existing email template. You can create email +// templates using the CreateTemplate operation. +// - The message must be sent from a verified email address or domain. +// - If your account is still in the Amazon SES sandbox, you may only send to +// verified addresses or domains, or to email addresses associated with the Amazon +// SES Mailbox Simulator. For more information, see Verifying Email Addresses +// and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// in the Amazon SES Developer Guide. +// - The maximum message size is 10 MB. +// - Calls to the SendTemplatedEmail operation may only include one Destination +// parameter. A destination is a set of recipients who will receive the same +// version of the email. The Destination parameter can include up to 50 +// recipients, across the To:, CC: and BCC: fields. +// - The Destination parameter must include at least one recipient email address. +// The recipient address can be a To: address, a CC: address, or a BCC: address. If +// a recipient email address is invalid (that is, it is not in the format +// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be +// rejected, even if the message contains other recipients that are valid. // -// * The call must refer to -// an existing email template. You can create email templates using the -// CreateTemplate operation. -// -// * The message must be sent from a verified email -// address or domain. -// -// * If your account is still in the Amazon SES sandbox, you -// may only send to verified addresses or domains, or to email addresses associated -// with the Amazon SES Mailbox Simulator. For more information, see Verifying Email -// Addresses and Domains -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. -// -// * The maximum message size is 10 MB. -// -// * -// Calls to the SendTemplatedEmail operation may only include one Destination -// parameter. A destination is a set of recipients who will receive the same -// version of the email. The Destination parameter can include up to 50 recipients, -// across the To:, CC: and BCC: fields. -// -// * The Destination parameter must include -// at least one recipient email address. The recipient address can be a To: -// address, a CC: address, or a BCC: address. If a recipient email address is -// invalid (that is, it is not in the format -// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be -// rejected, even if the message contains other recipients that are valid. -// -// If your -// call to the SendTemplatedEmail operation includes all of the required +// If your call to the SendTemplatedEmail operation includes all of the required // parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon // SES can't render the email because the template contains errors, it doesn't send // the email. Additionally, because it already accepted the message, Amazon SES // doesn't return a message stating that it was unable to send the email. For these // reasons, we highly recommend that you set up Amazon SES to send you // notifications when Rendering Failure events occur. For more information, see -// Sending Personalized Email Using the Amazon SES API -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// Sending Personalized Email Using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) // in the Amazon Simple Email Service Developer Guide. func (c *Client) SendTemplatedEmail(ctx context.Context, params *SendTemplatedEmailInput, optFns ...func(*Options)) (*SendTemplatedEmailOutput, error) { if params == nil { @@ -71,8 +58,8 @@ func (c *Client) SendTemplatedEmail(ctx context.Context, params *SendTemplatedEm } // Represents a request to send a templated email using Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type SendTemplatedEmailInput struct { // The destination for this email, composed of To:, CC:, and BCC: fields. A @@ -84,25 +71,21 @@ type SendTemplatedEmailInput struct { // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). - // If you are sending on behalf of another user and have been permitted to do so by - // a sending authorization policy, then you must also specify the SourceArn + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) + // . If you are sending on behalf of another user and have been permitted to do so + // by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 - // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a - // source email address (the part of the email address that precedes the @ sign) - // may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as the - // friendly name) may contain non-ASCII characters. These characters must be - // encoded using MIME encoded-word syntax, as described inRFC 2047 - // (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the - // following form: =?charset?encoding?encoded-text?=. + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/rfc6531) + // . For this reason, the local part of a source email address (the part of the + // email address that precedes the @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . The sender name (also known + // as the friendly name) may contain non-ASCII characters. These characters must be + // encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . MIME encoded-word syntax uses the following form: + // =?charset?encoding?encoded-text?= . // // This member is required. Source *string @@ -120,48 +103,48 @@ type SendTemplatedEmailInput struct { TemplateData *string // The name of the configuration set to use when you send an email using - // SendTemplatedEmail. + // SendTemplatedEmail . ConfigurationSetName *string // The reply-to email address(es) for the message. If the recipient replies to the // message, each reply-to address will receive the reply. ReplyToAddresses []string - // The email address that bounces and complaints will be forwarded to when feedback - // forwarding is enabled. If the message cannot be delivered to the recipient, then - // an error message will be returned from the recipient's ISP; this message will - // then be forwarded to the email address specified by the ReturnPath parameter. - // The ReturnPath parameter is never overwritten. This email address must be either - // individually verified with Amazon SES, or from a domain that has been verified - // with Amazon SES. + // The email address that bounces and complaints will be forwarded to when + // feedback forwarding is enabled. If the message cannot be delivered to the + // recipient, then an error message will be returned from the recipient's ISP; this + // message will then be forwarded to the email address specified by the ReturnPath + // parameter. The ReturnPath parameter is never overwritten. This email address + // must be either individually verified with Amazon SES, or from a domain that has + // been verified with Amazon SES. ReturnPath *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits - // you to use the email address specified in the ReturnPath parameter. For example, - // if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to use feedback@example.com, then you would specify the - // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and - // the ReturnPath to be feedback@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // you to use the email address specified in the ReturnPath parameter. For + // example, if the owner of example.com (which has ARN + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to use feedback@example.com , then you would specify the + // ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the ReturnPath to be feedback@example.com . For more information about + // sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . ReturnPathArn *string // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to send for the email address specified in the Source parameter. For // example, if the owner of example.com (which has ARN - // arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it - // that authorizes you to send from user@example.com, then you would specify the - // SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the - // Source to be user@example.com. For more information about sending authorization, - // see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // arn:aws:ses:us-east-1:123456789012:identity/example.com ) attaches a policy to + // it that authorizes you to send from user@example.com , then you would specify + // the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , + // and the Source to be user@example.com . For more information about sending + // authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . SourceArn *string // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendTemplatedEmail. Tags correspond to characteristics of the email + // send using SendTemplatedEmail . Tags correspond to characteristics of the email // that you define, so that you can publish email sending events. Tags []types.MessageTag diff --git a/service/ses/api_op_SetActiveReceiptRuleSet.go b/service/ses/api_op_SetActiveReceiptRuleSet.go index 304684c2584..03b9f6887f8 100644 --- a/service/ses/api_op_SetActiveReceiptRuleSet.go +++ b/service/ses/api_op_SetActiveReceiptRuleSet.go @@ -13,9 +13,8 @@ import ( // Sets the specified receipt rule set as the active receipt rule set. To disable // your email-receiving through Amazon SES completely, you can call this API with // RuleSetName set to null. For information about managing receipt rule sets, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html). -// You can execute this operation no more than once per second. +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) +// . You can execute this operation no more than once per second. func (c *Client) SetActiveReceiptRuleSet(ctx context.Context, params *SetActiveReceiptRuleSetInput, optFns ...func(*Options)) (*SetActiveReceiptRuleSetOutput, error) { if params == nil { params = &SetActiveReceiptRuleSetInput{} @@ -33,8 +32,8 @@ func (c *Client) SetActiveReceiptRuleSet(ctx context.Context, params *SetActiveR // Represents a request to set a receipt rule set as the active receipt rule set. // You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type SetActiveReceiptRuleSetInput struct { // The name of the receipt rule set to make active. Setting this value to null diff --git a/service/ses/api_op_SetIdentityDkimEnabled.go b/service/ses/api_op_SetIdentityDkimEnabled.go index 6b5b2fc7da1..7fefc640994 100644 --- a/service/ses/api_op_SetIdentityDkimEnabled.go +++ b/service/ses/api_op_SetIdentityDkimEnabled.go @@ -14,14 +14,14 @@ import ( // DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all // email that it sends from addresses on that domain. If Easy DKIM signing is // enabled for an email address, then Amazon SES uses DKIM to sign all email it -// sends from that address. For email addresses (for example, user@example.com), +// sends from that address. For email addresses (for example, user@example.com ), // you can only enable DKIM signing if the corresponding domain (in this case, -// example.com) has been set up to use Easy DKIM. You can enable DKIM signing for +// example.com ) has been set up to use Easy DKIM. You can enable DKIM signing for // an identity at any time after you start the verification process for the // identity, even if the verification process isn't complete. You can execute this // operation no more than once per second. For more information about Easy DKIM -// signing, go to the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// signing, go to the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . func (c *Client) SetIdentityDkimEnabled(ctx context.Context, params *SetIdentityDkimEnabledInput, optFns ...func(*Options)) (*SetIdentityDkimEnabledOutput, error) { if params == nil { params = &SetIdentityDkimEnabledInput{} @@ -39,12 +39,12 @@ func (c *Client) SetIdentityDkimEnabled(ctx context.Context, params *SetIdentity // Represents a request to enable or disable Amazon SES Easy DKIM signing for an // identity. For more information about setting up Easy DKIM, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . type SetIdentityDkimEnabledInput struct { - // Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM - // signing for this identity; false to disable it. + // Sets whether DKIM signing is enabled for an identity. Set to true to enable + // DKIM signing for this identity; false to disable it. // // This member is required. DkimEnabled bool diff --git a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go index c32a955b963..770a25e66ba 100644 --- a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go +++ b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go @@ -17,8 +17,8 @@ import ( // does not apply to delivery notifications. Delivery notifications are only // available through Amazon SNS. You can execute this operation no more than once // per second. For more information about using notifications with Amazon SES, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html) +// . func (c *Client) SetIdentityFeedbackForwardingEnabled(ctx context.Context, params *SetIdentityFeedbackForwardingEnabledInput, optFns ...func(*Options)) (*SetIdentityFeedbackForwardingEnabledOutput, error) { if params == nil { params = &SetIdentityFeedbackForwardingEnabledInput{} @@ -34,10 +34,10 @@ func (c *Client) SetIdentityFeedbackForwardingEnabled(ctx context.Context, param return out, nil } -// Represents a request to enable or disable whether Amazon SES forwards you bounce -// and complaint notifications through email. For information about email feedback -// forwarding, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html). +// Represents a request to enable or disable whether Amazon SES forwards you +// bounce and complaint notifications through email. For information about email +// feedback forwarding, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html) +// . type SetIdentityFeedbackForwardingEnabledInput struct { // Sets whether Amazon SES will forward bounce and complaint notifications as @@ -51,7 +51,7 @@ type SetIdentityFeedbackForwardingEnabledInput struct { ForwardingEnabled bool // The identity for which to set bounce and complaint notification forwarding. - // Examples: user@example.com, example.com. + // Examples: user@example.com , example.com . // // This member is required. Identity *string diff --git a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go index b1f5253d30d..c75029ef4f4 100644 --- a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go +++ b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go @@ -15,8 +15,8 @@ import ( // includes the original email headers in the Amazon Simple Notification Service // (Amazon SNS) notifications of a specified type. You can execute this operation // no more than once per second. For more information about using notifications -// with Amazon SES, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// with Amazon SES, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html) +// . func (c *Client) SetIdentityHeadersInNotificationsEnabled(ctx context.Context, params *SetIdentityHeadersInNotificationsEnabledInput, optFns ...func(*Options)) (*SetIdentityHeadersInNotificationsEnabledOutput, error) { if params == nil { params = &SetIdentityHeadersInNotificationsEnabledInput{} @@ -34,22 +34,22 @@ func (c *Client) SetIdentityHeadersInNotificationsEnabled(ctx context.Context, p // Represents a request to set whether Amazon SES includes the original email // headers in the Amazon SNS notifications of a specified type. For information -// about notifications, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html). +// about notifications, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html) +// . type SetIdentityHeadersInNotificationsEnabledInput struct { // Sets whether Amazon SES includes the original email headers in Amazon SNS - // notifications of the specified notification type. A value of true specifies that - // Amazon SES will include headers in notifications, and a value of false specifies - // that Amazon SES will not include headers in notifications. This value can only - // be set when NotificationType is already set to use a particular Amazon SNS - // topic. + // notifications of the specified notification type. A value of true specifies + // that Amazon SES will include headers in notifications, and a value of false + // specifies that Amazon SES will not include headers in notifications. This value + // can only be set when NotificationType is already set to use a particular Amazon + // SNS topic. // // This member is required. Enabled bool // The identity for which to enable or disable headers in notifications. Examples: - // user@example.com, example.com. + // user@example.com , example.com . // // This member is required. Identity *string diff --git a/service/ses/api_op_SetIdentityMailFromDomain.go b/service/ses/api_op_SetIdentityMailFromDomain.go index 57f6034d25f..b341fe5acef 100644 --- a/service/ses/api_op_SetIdentityMailFromDomain.go +++ b/service/ses/api_op_SetIdentityMailFromDomain.go @@ -16,9 +16,8 @@ import ( // domain, you must add an MX record to your MAIL FROM domain's DNS settings. If // you want your emails to pass Sender Policy Framework (SPF) checks, you must also // add or update an SPF record. For more information, see the Amazon SES Developer -// Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html). You -// can execute this operation no more than once per second. +// Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html) +// . You can execute this operation no more than once per second. func (c *Client) SetIdentityMailFromDomain(ctx context.Context, params *SetIdentityMailFromDomainInput, optFns ...func(*Options)) (*SetIdentityMailFromDomainOutput, error) { if params == nil { params = &SetIdentityMailFromDomainInput{} @@ -34,10 +33,10 @@ func (c *Client) SetIdentityMailFromDomain(ctx context.Context, params *SetIdent return out, nil } -// Represents a request to enable or disable the Amazon SES custom MAIL FROM domain -// setup for a verified identity. For information about using a custom MAIL FROM -// domain, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html). +// Represents a request to enable or disable the Amazon SES custom MAIL FROM +// domain setup for a verified identity. For information about using a custom MAIL +// FROM domain, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html) +// . type SetIdentityMailFromDomainInput struct { // The verified identity for which you want to enable or disable the specified @@ -47,21 +46,20 @@ type SetIdentityMailFromDomainInput struct { Identity *string // The action that you want Amazon SES to take if it cannot successfully read the - // required MX record when you send an email. If you choose UseDefaultValue, Amazon - // SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If - // you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified - // error and not send the email. The action specified in BehaviorOnMXFailure is - // taken when the custom MAIL FROM domain setup is in the Pending, Failed, and - // TemporaryFailure states. + // required MX record when you send an email. If you choose UseDefaultValue , + // Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM + // domain. If you choose RejectMessage , Amazon SES will return a + // MailFromDomainNotVerified error and not send the email. The action specified in + // BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the + // Pending , Failed , and TemporaryFailure states. BehaviorOnMXFailure types.BehaviorOnMXFailure - // The custom MAIL FROM domain that you want the verified identity to use. The MAIL - // FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a - // "From" address if the MAIL FROM domain is the destination of email feedback - // forwarding (for more information, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html)), and 3) - // not be used to receive emails. A value of null disables the custom MAIL FROM - // setting for the identity. + // The custom MAIL FROM domain that you want the verified identity to use. The + // MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used + // in a "From" address if the MAIL FROM domain is the destination of email feedback + // forwarding (for more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html) + // ), and 3) not be used to receive emails. A value of null disables the custom + // MAIL FROM setting for the identity. MailFromDomain *string noSmithyDocumentSerde diff --git a/service/ses/api_op_SetIdentityNotificationTopic.go b/service/ses/api_op_SetIdentityNotificationTopic.go index 997fd4d0ef1..578d7b9d5be 100644 --- a/service/ses/api_op_SetIdentityNotificationTopic.go +++ b/service/ses/api_op_SetIdentityNotificationTopic.go @@ -18,8 +18,8 @@ import ( // topic you specified. You can send bounce, complaint, or delivery notifications // (or any combination of the three) to the Amazon SNS topic that you specify. You // can execute this operation no more than once per second. For more information -// about feedback notification, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html). +// about feedback notification, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html) +// . func (c *Client) SetIdentityNotificationTopic(ctx context.Context, params *SetIdentityNotificationTopicInput, optFns ...func(*Options)) (*SetIdentityNotificationTopicOutput, error) { if params == nil { params = &SetIdentityNotificationTopicInput{} @@ -38,15 +38,15 @@ func (c *Client) SetIdentityNotificationTopic(ctx context.Context, params *SetId // Represents a request to specify the Amazon SNS topic to which Amazon SES will // publish bounce, complaint, or delivery notifications for emails sent with that // identity as the Source. For information about Amazon SES notifications, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html) +// . type SetIdentityNotificationTopicInput struct { - // The identity (email address or domain) that you want to set the Amazon SNS topic - // for. You can only specify a verified identity for this parameter. You can + // The identity (email address or domain) that you want to set the Amazon SNS + // topic for. You can only specify a verified identity for this parameter. You can // specify an identity by using its name or by using its Amazon Resource Name - // (ARN). The following examples are all valid identities: sender@example.com, - // example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. + // (ARN). The following examples are all valid identities: sender@example.com , + // example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com . // // This member is required. Identity *string diff --git a/service/ses/api_op_SetReceiptRulePosition.go b/service/ses/api_op_SetReceiptRulePosition.go index 25f17f3474a..dc6a9fd7260 100644 --- a/service/ses/api_op_SetReceiptRulePosition.go +++ b/service/ses/api_op_SetReceiptRulePosition.go @@ -11,9 +11,8 @@ import ( ) // Sets the position of the specified receipt rule in the receipt rule set. For -// information about managing receipt rules, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). -// You can execute this operation no more than once per second. +// information about managing receipt rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html) +// . You can execute this operation no more than once per second. func (c *Client) SetReceiptRulePosition(ctx context.Context, params *SetReceiptRulePositionInput, optFns ...func(*Options)) (*SetReceiptRulePositionOutput, error) { if params == nil { params = &SetReceiptRulePositionInput{} @@ -31,8 +30,8 @@ func (c *Client) SetReceiptRulePosition(ctx context.Context, params *SetReceiptR // Represents a request to set the position of a receipt rule in a receipt rule // set. You use receipt rule sets to receive email with Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type SetReceiptRulePositionInput struct { // The name of the receipt rule to reposition. diff --git a/service/ses/api_op_UpdateConfigurationSetEventDestination.go b/service/ses/api_op_UpdateConfigurationSetEventDestination.go index f9ed54033d7..2c3e7b29286 100644 --- a/service/ses/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/ses/api_op_UpdateConfigurationSetEventDestination.go @@ -15,8 +15,7 @@ import ( // associated with configuration sets, which enable you to publish email sending // events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple // Notification Service (Amazon SNS). For information about using configuration -// sets, see Monitoring Your Amazon SES Sending Activity -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) // in the Amazon SES Developer Guide. When you create or update an event // destination, you must provide one, and only one, destination. The destination // can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification @@ -39,8 +38,8 @@ func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, par // Represents a request to update the event destination of a configuration set. // Configuration sets enable you to publish email sending events. For information -// about using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type UpdateConfigurationSetEventDestinationInput struct { // The name of the configuration set that contains the event destination that you diff --git a/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go b/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go index 61b6c860a00..b4fb4674a44 100644 --- a/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go +++ b/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables or disables the publishing of reputation metrics for emails sent using a -// specific configuration set in a given AWS Region. Reputation metrics include +// Enables or disables the publishing of reputation metrics for emails sent using +// a specific configuration set in a given AWS Region. Reputation metrics include // bounce and complaint rates. These metrics are published to Amazon CloudWatch. By // using CloudWatch, you can create alarms when bounce or complaint rates exceed // certain thresholds. You can execute this operation no more than once per second. diff --git a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go index 79ba679ceea..9591aef163f 100644 --- a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an association between a configuration set and a custom domain for open -// and click event tracking. By default, images and links used for tracking open -// and click events are hosted on domains operated by Amazon SES. You can configure -// a subdomain of your own to handle these events. For information about using -// custom domains, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html). +// Modifies an association between a configuration set and a custom domain for +// open and click event tracking. By default, images and links used for tracking +// open and click events are hosted on domains operated by Amazon SES. You can +// configure a subdomain of your own to handle these events. For information about +// using custom domains, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) +// . func (c *Client) UpdateConfigurationSetTrackingOptions(ctx context.Context, params *UpdateConfigurationSetTrackingOptionsInput, optFns ...func(*Options)) (*UpdateConfigurationSetTrackingOptionsOutput, error) { if params == nil { params = &UpdateConfigurationSetTrackingOptionsInput{} @@ -44,8 +44,7 @@ type UpdateConfigurationSetTrackingOptionsInput struct { // A domain that is used to redirect email recipients to an Amazon SES-operated // domain. This domain captures open and click events generated by Amazon SES // emails. For more information, see Configuring Custom Domains to Handle Open and - // Click Tracking - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) + // Click Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. // // This member is required. diff --git a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go index dcbbd7a4215..4b29904ba52 100644 --- a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Updates an existing custom verification email template. For more information // about custom verification email templates, see Using Custom Verification Email -// Templates -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) +// Templates (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, params *UpdateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*UpdateCustomVerificationEmailTemplateOutput, error) { @@ -52,8 +51,7 @@ type UpdateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email must // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom Verification Email Frequently Asked Questions - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) + // For more information, see Custom Verification Email Frequently Asked Questions (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq) // in the Amazon SES Developer Guide. TemplateContent *string diff --git a/service/ses/api_op_UpdateReceiptRule.go b/service/ses/api_op_UpdateReceiptRule.go index 68ddfdc6d0b..9a27c6ccb5f 100644 --- a/service/ses/api_op_UpdateReceiptRule.go +++ b/service/ses/api_op_UpdateReceiptRule.go @@ -12,9 +12,8 @@ import ( ) // Updates a receipt rule. For information about managing receipt rules, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html) +// . You can execute this operation no more than once per second. func (c *Client) UpdateReceiptRule(ctx context.Context, params *UpdateReceiptRuleInput, optFns ...func(*Options)) (*UpdateReceiptRuleOutput, error) { if params == nil { params = &UpdateReceiptRuleInput{} @@ -31,8 +30,8 @@ func (c *Client) UpdateReceiptRule(ctx context.Context, params *UpdateReceiptRul } // Represents a request to update a receipt rule. You use receipt rules to receive -// email with Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html). +// email with Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html) +// . type UpdateReceiptRuleInput struct { // A data structure that contains the updated receipt rule information. diff --git a/service/ses/api_op_UpdateTemplate.go b/service/ses/api_op_UpdateTemplate.go index b6f52a8ae18..0941d25809d 100644 --- a/service/ses/api_op_UpdateTemplate.go +++ b/service/ses/api_op_UpdateTemplate.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an email template. Email templates enable you to send personalized email -// to one or more destinations in a single API operation. For more information, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). -// You can execute this operation no more than once per second. +// Updates an email template. Email templates enable you to send personalized +// email to one or more destinations in a single API operation. For more +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . You can execute this operation no more than once per second. func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error) { if params == nil { params = &UpdateTemplateInput{} diff --git a/service/ses/api_op_VerifyDomainDkim.go b/service/ses/api_op_VerifyDomainDkim.go index 7a152a0bbd6..32fa0d7e071 100644 --- a/service/ses/api_op_VerifyDomainDkim.go +++ b/service/ses/api_op_VerifyDomainDkim.go @@ -15,31 +15,23 @@ import ( // identities that are associated with your account. This is true even if you // haven't already associated the domain with your account by using the // VerifyDomainIdentity operation. However, you can't send email from the domain -// until you either successfully verify it -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html) or -// you successfully set up DKIM for it -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). You use -// the tokens that are generated by this operation to create CNAME records. When -// Amazon SES detects that you've added these records to the DNS configuration for -// a domain, you can start sending email from that domain. You can start sending -// email even if you haven't added the TXT record provided by the +// until you either successfully verify it (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html) +// or you successfully set up DKIM for it (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . You use the tokens that are generated by this operation to create CNAME +// records. When Amazon SES detects that you've added these records to the DNS +// configuration for a domain, you can start sending email from that domain. You +// can start sending email even if you haven't added the TXT record provided by the // VerifyDomainIdentity operation to the DNS configuration for your domain. All // email that you send from the domain is authenticated using DKIM. To create the // CNAME records for DKIM authentication, use the following values: +// - Name: token._domainkey.example.com +// - Type: CNAME +// - Value: token.dkim.amazonses.com // -// * Name: -// token._domainkey.example.com -// -// * Type: CNAME -// -// * Value: -// token.dkim.amazonses.com -// -// In the preceding example, replace token with one of -// the tokens that are generated when you execute this operation. Replace -// example.com with your domain. Repeat this process for each token that's -// generated by this operation. You can execute this operation no more than once -// per second. +// In the preceding example, replace token with one of the tokens that are +// generated when you execute this operation. Replace example.com with your domain. +// Repeat this process for each token that's generated by this operation. You can +// execute this operation no more than once per second. func (c *Client) VerifyDomainDkim(ctx context.Context, params *VerifyDomainDkimInput, optFns ...func(*Options)) (*VerifyDomainDkimOutput, error) { if params == nil { params = &VerifyDomainDkimInput{} @@ -56,9 +48,9 @@ func (c *Client) VerifyDomainDkim(ctx context.Context, params *VerifyDomainDkimI } // Represents a request to generate the CNAME records needed to set up Easy DKIM -// with Amazon SES. For more information about setting up Easy DKIM, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). +// with Amazon SES. For more information about setting up Easy DKIM, see the +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . type VerifyDomainDkimInput struct { // The name of the domain to be verified for Easy DKIM signing. @@ -73,16 +65,16 @@ type VerifyDomainDkimInput struct { // set up Easy DKIM with Amazon SES. type VerifyDomainDkimOutput struct { - // A set of character strings that represent the domain's identity. If the identity - // is an email address, the tokens represent the domain of that address. Using - // these tokens, you need to create DNS CNAME records that point to DKIM public - // keys that are hosted by Amazon SES. Amazon Web Services eventually detects that - // you've updated your DNS records. This detection process might take up to 72 - // hours. After successful detection, Amazon SES is able to DKIM-sign email - // originating from that domain. (This only applies to domain identities, not email - // address identities.) For more information about creating DNS records using DKIM - // tokens, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). + // A set of character strings that represent the domain's identity. If the + // identity is an email address, the tokens represent the domain of that address. + // Using these tokens, you need to create DNS CNAME records that point to DKIM + // public keys that are hosted by Amazon SES. Amazon Web Services eventually + // detects that you've updated your DNS records. This detection process might take + // up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign + // email originating from that domain. (This only applies to domain identities, not + // email address identities.) For more information about creating DNS records using + // DKIM tokens, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // . // // This member is required. DkimTokens []string diff --git a/service/ses/api_op_VerifyDomainIdentity.go b/service/ses/api_op_VerifyDomainIdentity.go index 489e6393045..ff4de30e0ea 100644 --- a/service/ses/api_op_VerifyDomainIdentity.go +++ b/service/ses/api_op_VerifyDomainIdentity.go @@ -12,8 +12,7 @@ import ( // Adds a domain to the list of identities for your Amazon SES account in the // current AWS Region and attempts to verify it. For more information about -// verifying domains, see Verifying Email Addresses and Domains -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) +// verifying domains, see Verifying Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) VerifyDomainIdentity(ctx context.Context, params *VerifyDomainIdentityInput, optFns ...func(*Options)) (*VerifyDomainIdentityOutput, error) { @@ -31,11 +30,11 @@ func (c *Client) VerifyDomainIdentity(ctx context.Context, params *VerifyDomainI return out, nil } -// Represents a request to begin Amazon SES domain verification and to generate the -// TXT records that you must publish to the DNS server of your domain to complete -// the verification. For information about domain verification, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html). +// Represents a request to begin Amazon SES domain verification and to generate +// the TXT records that you must publish to the DNS server of your domain to +// complete the verification. For information about domain verification, see the +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html) +// . type VerifyDomainIdentityInput struct { // The domain to be verified. diff --git a/service/ses/api_op_VerifyEmailAddress.go b/service/ses/api_op_VerifyEmailAddress.go index f087c608b86..a3fc1925891 100644 --- a/service/ses/api_op_VerifyEmailAddress.go +++ b/service/ses/api_op_VerifyEmailAddress.go @@ -27,8 +27,8 @@ func (c *Client) VerifyEmailAddress(ctx context.Context, params *VerifyEmailAddr } // Represents a request to begin email address verification with Amazon SES. For -// information about email address verification, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). +// information about email address verification, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) +// . type VerifyEmailAddressInput struct { // The email address to be verified. diff --git a/service/ses/api_op_VerifyEmailIdentity.go b/service/ses/api_op_VerifyEmailIdentity.go index 56b3e26c803..e131a5c03c2 100644 --- a/service/ses/api_op_VerifyEmailIdentity.go +++ b/service/ses/api_op_VerifyEmailIdentity.go @@ -30,8 +30,8 @@ func (c *Client) VerifyEmailIdentity(ctx context.Context, params *VerifyEmailIde } // Represents a request to begin email address verification with Amazon SES. For -// information about email address verification, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). +// information about email address verification, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html) +// . type VerifyEmailIdentityInput struct { // The email address to be verified. diff --git a/service/ses/doc.go b/service/ses/doc.go index 8e462ca4899..d24d6af9024 100644 --- a/service/ses/doc.go +++ b/service/ses/doc.go @@ -3,13 +3,12 @@ // Package ses provides the API client, operations, and parameter types for Amazon // Simple Email Service. // -// Amazon Simple Email Service This document contains reference information for the -// Amazon Simple Email Service (https://aws.amazon.com/ses/) (Amazon SES) API, +// Amazon Simple Email Service This document contains reference information for +// the Amazon Simple Email Service (https://aws.amazon.com/ses/) (Amazon SES) API, // version 2010-12-01. This document is best used in conjunction with the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html). For a list -// of Amazon SES endpoints to use in service requests, see Regions and Amazon SES -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html) in the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html) +// . For a list of Amazon SES endpoints to use in service requests, see Regions +// and Amazon SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html) +// in the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html) +// . package ses diff --git a/service/ses/types/enums.go b/service/ses/types/enums.go index 66ad03df69a..c1eee5e3078 100644 --- a/service/ses/types/enums.go +++ b/service/ses/types/enums.go @@ -163,9 +163,9 @@ const ( DsnActionExpanded DsnAction = "expanded" ) -// Values returns all known values for DsnAction. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DsnAction. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DsnAction) Values() []DsnAction { return []DsnAction{ "failed", @@ -190,9 +190,9 @@ const ( EventTypeRenderingFailure EventType = "renderingFailure" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "send", @@ -214,9 +214,9 @@ const ( IdentityTypeDomain IdentityType = "Domain" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "EmailAddress", @@ -305,9 +305,9 @@ const ( StopScopeRuleSet StopScope = "RuleSet" ) -// Values returns all known values for StopScope. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for StopScope. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (StopScope) Values() []StopScope { return []StopScope{ "RuleSet", @@ -322,9 +322,9 @@ const ( TlsPolicyOptional TlsPolicy = "Optional" ) -// Values returns all known values for TlsPolicy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TlsPolicy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TlsPolicy) Values() []TlsPolicy { return []TlsPolicy{ "Require", diff --git a/service/ses/types/errors.go b/service/ses/types/errors.go index a4b318a6581..ba48f4ce243 100644 --- a/service/ses/types/errors.go +++ b/service/ses/types/errors.go @@ -7,9 +7,9 @@ import ( smithy "github.com/aws/smithy-go" ) -// Indicates that email sending is disabled for your entire Amazon SES account. You -// can enable or disable email sending for your Amazon SES account using -// UpdateAccountSendingEnabled. +// Indicates that email sending is disabled for your entire Amazon SES account. +// You can enable or disable email sending for your Amazon SES account using +// UpdateAccountSendingEnabled . type AccountSendingPausedException struct { Message *string @@ -154,7 +154,7 @@ func (e *ConfigurationSetDoesNotExistException) ErrorFault() smithy.ErrorFault { // Indicates that email sending is disabled for the configuration set. You can // enable or disable email sending for a configuration set using -// UpdateConfigurationSetSendingEnabled. +// UpdateConfigurationSetSendingEnabled . type ConfigurationSetSendingPausedException struct { Message *string @@ -454,8 +454,8 @@ func (e *InvalidDeliveryOptionsException) ErrorCode() string { } func (e *InvalidDeliveryOptionsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that the Amazon Kinesis Firehose destination is invalid. See the error -// message for details. +// Indicates that the Amazon Kinesis Firehose destination is invalid. See the +// error message for details. type InvalidFirehoseDestinationException struct { Message *string @@ -488,8 +488,8 @@ func (e *InvalidFirehoseDestinationException) ErrorFault() smithy.ErrorFault { // Indicates that the provided AWS Lambda function is invalid, or that Amazon SES // could not execute the provided function, possibly due to permissions issues. For -// information about giving permissions, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// information about giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . type InvalidLambdaFunctionException struct { Message *string @@ -577,9 +577,9 @@ func (e *InvalidRenderingParameterException) ErrorFault() smithy.ErrorFault { // Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is // invalid, or that Amazon SES could not publish to the bucket, possibly due to -// permissions issues. For information about giving permissions, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// permissions issues. For information about giving permissions, see the Amazon +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . type InvalidS3ConfigurationException struct { Message *string @@ -639,8 +639,8 @@ func (e *InvalidSNSDestinationException) ErrorFault() smithy.ErrorFault { return // Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES // could not publish to the topic, possibly due to permissions issues. For -// information about giving permissions, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). +// information about giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . type InvalidSnsTopicException struct { Message *string @@ -668,8 +668,8 @@ func (e *InvalidSnsTopicException) ErrorCode() string { } func (e *InvalidSnsTopicException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that the template that you specified could not be rendered. This issue -// may occur when a template refers to a partial that does not exist. +// Indicates that the template that you specified could not be rendered. This +// issue may occur when a template refers to a partial that does not exist. type InvalidTemplateException struct { Message *string @@ -698,14 +698,10 @@ func (e *InvalidTemplateException) ErrorCode() string { func (e *InvalidTemplateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Indicates that the custom domain to be used for open and click tracking -// redirects is invalid. This error appears most often in the following -// situations: -// -// * When the tracking domain you specified is not verified in Amazon -// SES. +// redirects is invalid. This error appears most often in the following situations: // -// * When the tracking domain you specified is not a valid domain or -// subdomain. +// - When the tracking domain you specified is not verified in Amazon SES. +// - When the tracking domain you specified is not a valid domain or subdomain. type InvalidTrackingOptionsException struct { Message *string @@ -732,8 +728,8 @@ func (e *InvalidTrackingOptionsException) ErrorCode() string { func (e *InvalidTrackingOptionsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Indicates that a resource could not be created because of service limits. For a -// list of Amazon SES limits, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html). +// list of Amazon SES limits, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html) +// . type LimitExceededException struct { Message *string @@ -762,8 +758,8 @@ func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy. // Indicates that the message could not be sent because Amazon SES could not read // the MX record required to use the specified MAIL FROM domain. For information // about editing the custom MAIL FROM domain settings for an identity, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html) +// . type MailFromDomainNotVerifiedException struct { Message *string diff --git a/service/ses/types/types.go b/service/ses/types/types.go index d1da9fa0b55..8b4f317f160 100644 --- a/service/ses/types/types.go +++ b/service/ses/types/types.go @@ -9,8 +9,8 @@ import ( // When included in a receipt rule, this action adds a header to the received // email. For information about adding a header using a receipt rule, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-add-header.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-add-header.html) +// . type AddHeaderAction struct { // The name of the header to add. Must be between 1 and 50 characters, inclusive, @@ -19,8 +19,8 @@ type AddHeaderAction struct { // This member is required. HeaderName *string - // Must be less than 2048 characters, and must not contain newline characters ("\r" - // or "\n"). + // Must be less than 2048 characters, and must not contain newline characters + // ("\r" or "\n"). // // This member is required. HeaderValue *string @@ -49,8 +49,8 @@ type Body struct { // returning a bounce response to the sender and, optionally, publishes a // notification to Amazon Simple Notification Service (Amazon SNS). For information // about sending a bounce message in response to a received email, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html) +// . type BounceAction struct { // Human-readable text to include in the bounce message. @@ -64,21 +64,21 @@ type BounceAction struct { // This member is required. Sender *string - // The SMTP reply code, as defined by RFC 5321 - // (https://tools.ietf.org/html/rfc5321). + // The SMTP reply code, as defined by RFC 5321 (https://tools.ietf.org/html/rfc5321) + // . // // This member is required. SmtpReplyCode *string - // The SMTP enhanced status code, as defined by RFC 3463 - // (https://tools.ietf.org/html/rfc3463). + // The SMTP enhanced status code, as defined by RFC 3463 (https://tools.ietf.org/html/rfc3463) + // . StatusCode *string - // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce - // action is taken. An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the + // bounce action is taken. An example of an Amazon SNS topic ARN is + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . TopicArn *string noSmithyDocumentSerde @@ -87,8 +87,8 @@ type BounceAction struct { // Recipient-related information to include in the Delivery Status Notification // (DSN) when an email that Amazon SES receives on your behalf bounces. For // information about receiving email through Amazon SES, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html) +// . type BouncedRecipientInfo struct { // The email address of the recipient of the bounced email. @@ -97,19 +97,19 @@ type BouncedRecipientInfo struct { Recipient *string // The reason for the bounce. You must provide either this parameter or - // RecipientDsnFields. + // RecipientDsnFields . BounceType BounceType // This parameter is used only for sending authorization. It is the ARN of the // identity that is associated with the sending authorization policy that permits // you to receive email for the recipient of the bounced email. For more - // information about sending authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // information about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . RecipientArn *string // Recipient-related DSN fields, most of which would normally be filled in - // automatically when provided with a BounceType. You must provide either this - // parameter or BounceType. + // automatically when provided with a BounceType . You must provide either this + // parameter or BounceType . RecipientDsnFields *RecipientDsnFields noSmithyDocumentSerde @@ -121,19 +121,18 @@ type BulkEmailDestination struct { // Represents the destination of the message, consisting of To:, CC:, and BCC: // fields. Amazon SES does not support the SMTPUTF8 extension, as described in - // RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part + // RFC6531 (https://tools.ietf.org/html/rfc6531) . For this reason, the local part // of a destination email address (the part of the email address that precedes the - // @ sign) may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). + // @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . // // This member is required. Destination *Destination // A list of tags, in the form of name/value pairs, to apply to an email that you - // send using SendBulkTemplatedEmail. Tags correspond to characteristics of the + // send using SendBulkTemplatedEmail . Tags correspond to characteristics of the // email that you define, so that you can publish email sending events. ReplacementTags []MessageTag @@ -158,54 +157,33 @@ type BulkEmailDestinationStatus struct { // The status of a message sent using the SendBulkTemplatedEmail operation. // Possible values for this parameter include: - // - // * Success: Amazon SES accepted the - // message, and will attempt to deliver it to the recipients. - // - // * MessageRejected: - // The message was rejected because it contained a virus. - // - // * - // MailFromDomainNotVerified: The sender's email address or domain was not - // verified. - // - // * ConfigurationSetDoesNotExist: The configuration set you specified - // does not exist. - // - // * TemplateDoesNotExist: The template you specified does not - // exist. - // - // * AccountSuspended: Your account has been shut down because of issues - // related to your email sending practices. - // - // * AccountThrottled: The number of - // emails you can send has been reduced because your account has exceeded its - // allocated sending limit. - // - // * AccountDailyQuotaExceeded: You have reached or - // exceeded the maximum number of emails you can send from your account in a - // 24-hour period. - // - // * InvalidSendingPoolName: The configuration set you specified - // refers to an IP pool that does not exist. - // - // * AccountSendingPaused: Email sending - // for the Amazon SES account was disabled using the UpdateAccountSendingEnabled - // operation. - // - // * ConfigurationSetSendingPaused: Email sending for this - // configuration set was disabled using the UpdateConfigurationSetSendingEnabled - // operation. - // - // * InvalidParameterValue: One or more of the parameters you specified - // when calling this operation was invalid. See the error message for additional - // information. - // - // * TransientFailure: Amazon SES was unable to process your request - // because of a temporary issue. - // - // * Failed: Amazon SES was unable to process your - // request. See the error message for additional information. + // - Success : Amazon SES accepted the message, and will attempt to deliver it to + // the recipients. + // - MessageRejected : The message was rejected because it contained a virus. + // - MailFromDomainNotVerified : The sender's email address or domain was not + // verified. + // - ConfigurationSetDoesNotExist : The configuration set you specified does not + // exist. + // - TemplateDoesNotExist : The template you specified does not exist. + // - AccountSuspended : Your account has been shut down because of issues related + // to your email sending practices. + // - AccountThrottled : The number of emails you can send has been reduced + // because your account has exceeded its allocated sending limit. + // - AccountDailyQuotaExceeded : You have reached or exceeded the maximum number + // of emails you can send from your account in a 24-hour period. + // - InvalidSendingPoolName : The configuration set you specified refers to an IP + // pool that does not exist. + // - AccountSendingPaused : Email sending for the Amazon SES account was disabled + // using the UpdateAccountSendingEnabled operation. + // - ConfigurationSetSendingPaused : Email sending for this configuration set was + // disabled using the UpdateConfigurationSetSendingEnabled operation. + // - InvalidParameterValue : One or more of the parameters you specified when + // calling this operation was invalid. See the error message for additional + // information. + // - TransientFailure : Amazon SES was unable to process your request because of + // a temporary issue. + // - Failed : Amazon SES was unable to process your request. See the error + // message for additional information. Status BulkEmailStatus noSmithyDocumentSerde @@ -215,12 +193,12 @@ type BulkEmailDestinationStatus struct { // which email sending events are published. Event destinations, such as Amazon // CloudWatch, are associated with configuration sets, which enable you to publish // email sending events. For information about using configuration sets, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type CloudWatchDestination struct { - // A list of dimensions upon which to categorize your emails when you publish email - // sending events to Amazon CloudWatch. + // A list of dimensions upon which to categorize your emails when you publish + // email sending events to Amazon CloudWatch. // // This member is required. DimensionConfigurations []CloudWatchDimensionConfiguration @@ -230,39 +208,34 @@ type CloudWatchDestination struct { // Contains the dimension configuration to use when you publish email sending // events to Amazon CloudWatch. For information about publishing email sending -// events to Amazon CloudWatch, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// events to Amazon CloudWatch, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type CloudWatchDimensionConfiguration struct { - // The default value of the dimension that is published to Amazon CloudWatch if you - // do not provide the value of the dimension when you send an email. The default - // value must: - // - // * This value can only contain ASCII letters (a-z, A-Z), numbers - // (0-9), underscores (_), or dashes (-). - // - // * Contain less than 256 characters. + // The default value of the dimension that is published to Amazon CloudWatch if + // you do not provide the value of the dimension when you send an email. The + // default value must: + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Contain less than 256 characters. // // This member is required. DefaultDimensionValue *string // The name of an Amazon CloudWatch dimension associated with an email sending // metric. The name must: - // - // * This value can only contain ASCII letters (a-z, A-Z), - // numbers (0-9), underscores (_), or dashes (-). - // - // * Contain less than 256 - // characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Contain less than 256 characters. // // This member is required. DimensionName *string // The place where Amazon SES finds the value of a dimension to publish to Amazon // CloudWatch. If you want Amazon SES to use the message tags that you specify - // using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail - // API, choose messageTag. If you want Amazon SES to use your own email headers, - // choose emailHeader. + // using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail / SendRawEmail + // API, choose messageTag . If you want Amazon SES to use your own email headers, + // choose emailHeader . // // This member is required. DimensionValueSource DimensionValueSource @@ -273,19 +246,16 @@ type CloudWatchDimensionConfiguration struct { // The name of the configuration set. Configuration sets let you create groups of // rules that you can apply to the emails you send using Amazon SES. For more // information about using configuration sets, see Using Amazon SES Configuration -// Sets -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html) -// in the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). +// Sets (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html) +// in the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/) +// . type ConfigurationSet struct { // The name of the configuration set. The name must meet the following // requirements: - // - // * Contain only letters (a-z, A-Z), numbers (0-9), underscores - // (_), or dashes (-). - // - // * Contain 64 characters or fewer. + // - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes + // (-). + // - Contain 64 characters or fewer. // // This member is required. Name *string @@ -338,8 +308,8 @@ type CustomVerificationEmailTemplate struct { type DeliveryOptions struct { // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). If the value is Require, messages are only - // delivered if a TLS connection can be established. If the value is Optional, + // Transport Layer Security (TLS). If the value is Require , messages are only + // delivered if a TLS connection can be established. If the value is Optional , // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy TlsPolicy @@ -349,13 +319,12 @@ type DeliveryOptions struct { // Represents the destination of the message, consisting of To:, CC:, and BCC: // fields. Amazon SES does not support the SMTPUTF8 extension, as described in -// RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part +// RFC6531 (https://tools.ietf.org/html/rfc6531) . For this reason, the local part // of a destination email address (the part of the email address that precedes the -// @ sign) may only contain 7-bit ASCII characters -// (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of -// an address (the part after the @ sign) contains non-ASCII characters, they must -// be encoded using Punycode, as described in RFC3492 -// (https://tools.ietf.org/html/rfc3492.html). +// @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) +// . If the domain part of an address (the part after the @ sign) contains +// non-ASCII characters, they must be encoded using Punycode, as described in +// RFC3492 (https://tools.ietf.org/html/rfc3492.html) . type Destination struct { // The recipients to place on the BCC: line of the message. @@ -377,8 +346,8 @@ type Destination struct { // Service (Amazon SNS). Event destinations are associated with configuration sets, // which enable you to publish email sending events to Amazon CloudWatch, Amazon // Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For -// information about using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// information about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type EventDestination struct { // The type of email sending events to publish to the event destination. @@ -387,24 +356,21 @@ type EventDestination struct { MatchingEventTypes []EventType // The name of the event destination. The name must: - // - // * This value can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * - // Contain less than 64 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Contain less than 64 characters. // // This member is required. Name *string - // An object that contains the names, default values, and sources of the dimensions - // associated with an Amazon CloudWatch event destination. + // An object that contains the names, default values, and sources of the + // dimensions associated with an Amazon CloudWatch event destination. CloudWatchDestination *CloudWatchDestination // Sets whether Amazon SES publishes events to this destination when you send an - // email with the associated configuration set. Set to true to enable publishing to - // this destination; set to false to prevent publishing to this destination. The - // default value is false. + // email with the associated configuration set. Set to true to enable publishing + // to this destination; set to false to prevent publishing to this destination. + // The default value is false . Enabled bool // An object that contains the delivery stream ARN and the IAM role ARN associated @@ -420,8 +386,8 @@ type EventDestination struct { // Additional X-headers to include in the Delivery Status Notification (DSN) when // an email that Amazon SES receives on your behalf bounces. For information about -// receiving email through Amazon SES, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// receiving email through Amazon SES, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html) +// . type ExtensionField struct { // The name of the header to add. Must be between 1 and 50 characters, inclusive, @@ -462,8 +428,8 @@ type IdentityDkimAttributes struct { // After successful detection, Amazon SES is able to DKIM-sign email originating // from that domain. (This only applies to domain identities, not email address // identities.) For more information about creating DNS records using DKIM tokens, - // see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). + // see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // . DkimTokens []string noSmithyDocumentSerde @@ -479,8 +445,8 @@ type IdentityMailFromDomainAttributes struct { // subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates // that if Amazon SES cannot read the required MX record, Amazon SES returns a // MailFromDomainNotVerified error and does not send the email. The custom MAIL - // FROM setup states that result in this behavior are Pending, Failed, and - // TemporaryFailure. + // FROM setup states that result in this behavior are Pending , Failed , and + // TemporaryFailure . // // This member is required. BehaviorOnMXFailure BehaviorOnMXFailure @@ -491,10 +457,10 @@ type IdentityMailFromDomainAttributes struct { MailFromDomain *string // The state that indicates whether Amazon SES has successfully read the MX record - // required for custom MAIL FROM domain setup. If the state is Success, Amazon SES + // required for custom MAIL FROM domain setup. If the state is Success , Amazon SES // uses the specified custom MAIL FROM domain when the verified identity sends an // email. All other states indicate that Amazon SES takes the action described by - // BehaviorOnMXFailure. + // BehaviorOnMXFailure . // // This member is required. MailFromDomainStatus CustomMailFromStatus @@ -536,19 +502,19 @@ type IdentityNotificationAttributes struct { ForwardingEnabled bool // Describes whether Amazon SES includes the original email headers in Amazon SNS - // notifications of type Bounce. A value of true specifies that Amazon SES will + // notifications of type Bounce . A value of true specifies that Amazon SES will // include headers in bounce notifications, and a value of false specifies that // Amazon SES will not include headers in bounce notifications. HeadersInBounceNotificationsEnabled bool // Describes whether Amazon SES includes the original email headers in Amazon SNS - // notifications of type Complaint. A value of true specifies that Amazon SES will - // include headers in complaint notifications, and a value of false specifies that - // Amazon SES will not include headers in complaint notifications. + // notifications of type Complaint . A value of true specifies that Amazon SES + // will include headers in complaint notifications, and a value of false specifies + // that Amazon SES will not include headers in complaint notifications. HeadersInComplaintNotificationsEnabled bool // Describes whether Amazon SES includes the original email headers in Amazon SNS - // notifications of type Delivery. A value of true specifies that Amazon SES will + // notifications of type Delivery . A value of true specifies that Amazon SES will // include headers in delivery notifications, and a value of false specifies that // Amazon SES will not include headers in delivery notifications. HeadersInDeliveryNotificationsEnabled bool @@ -575,8 +541,8 @@ type IdentityVerificationAttributes struct { // Kinesis Firehose event destination. Event destinations, such as Amazon Kinesis // Firehose, are associated with configuration sets, which enable you to publish // email sending events. For information about using configuration sets, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type KinesisFirehoseDestination struct { // The ARN of the Amazon Kinesis Firehose stream that email sending events should @@ -585,8 +551,8 @@ type KinesisFirehoseDestination struct { // This member is required. DeliveryStreamARN *string - // The ARN of the IAM role under which Amazon SES publishes email sending events to - // the Amazon Kinesis Firehose stream. + // The ARN of the IAM role under which Amazon SES publishes email sending events + // to the Amazon Kinesis Firehose stream. // // This member is required. IAMRoleARN *string @@ -599,17 +565,16 @@ type KinesisFirehoseDestination struct { // (Amazon SNS). To enable Amazon SES to call your AWS Lambda function or to // publish to an Amazon SNS topic of another account, Amazon SES must have // permission to access those resources. For information about giving permissions, -// see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). -// For information about using AWS Lambda actions in receipt rules, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html). +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . For information about using AWS Lambda actions in receipt rules, see the +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html) +// . type LambdaAction struct { // The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS - // Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. - // For more information about AWS Lambda, see the AWS Lambda Developer Guide - // (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). + // Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . + // For more information about AWS Lambda, see the AWS Lambda Developer Guide (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) + // . // // This member is required. FunctionArn *string @@ -617,19 +582,19 @@ type LambdaAction struct { // The invocation type of the AWS Lambda function. An invocation type of // RequestResponse means that the execution of the function will immediately result // in a response, and a value of Event means that the function will be invoked - // asynchronously. The default value is Event. For information about AWS Lambda - // invocation types, see the AWS Lambda Developer Guide - // (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html). There is a - // 30-second timeout on RequestResponse invocations. You should use Event - // invocation in most cases. Use RequestResponse only when you want to make a mail - // flow decision, such as whether to stop the receipt rule or the receipt rule set. + // asynchronously. The default value is Event . For information about AWS Lambda + // invocation types, see the AWS Lambda Developer Guide (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html) + // . There is a 30-second timeout on RequestResponse invocations. You should use + // Event invocation in most cases. Use RequestResponse only when you want to make + // a mail flow decision, such as whether to stop the receipt rule or the receipt + // rule set. InvocationType InvocationType - // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda - // action is taken. An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the + // Lambda action is taken. An example of an Amazon SNS topic ARN is + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . TopicArn *string noSmithyDocumentSerde @@ -643,8 +608,8 @@ type Message struct { // This member is required. Body *Body - // The subject of the message: A short summary of the content, which will appear in - // the recipient's inbox. + // The subject of the message: A short summary of the content, which will appear + // in the recipient's inbox. // // This member is required. Subject *Content @@ -652,21 +617,22 @@ type Message struct { noSmithyDocumentSerde } -// Message-related information to include in the Delivery Status Notification (DSN) -// when an email that Amazon SES receives on your behalf bounces. For information -// about receiving email through Amazon SES, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// Message-related information to include in the Delivery Status Notification +// (DSN) when an email that Amazon SES receives on your behalf bounces. For +// information about receiving email through Amazon SES, see the Amazon SES +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html) +// . type MessageDsn struct { // The reporting MTA that attempted to deliver the message, formatted as specified - // in RFC 3464 (https://tools.ietf.org/html/rfc3464) (mta-name-type; mta-name). The - // default value is dns; inbound-smtp.[region].amazonaws.com. + // in RFC 3464 (https://tools.ietf.org/html/rfc3464) ( mta-name-type; mta-name ). + // The default value is dns; inbound-smtp.[region].amazonaws.com . // // This member is required. ReportingMta *string - // When the message was received by the reporting mail transfer agent (MTA), in RFC - // 822 (https://www.ietf.org/rfc/rfc0822.txt) date-time format. + // When the message was received by the reporting mail transfer agent (MTA), in + // RFC 822 (https://www.ietf.org/rfc/rfc0822.txt) date-time format. ArrivalDate *time.Time // Additional X-headers to include in the DSN. @@ -678,28 +644,22 @@ type MessageDsn struct { // Contains the name and value of a tag that you can provide to SendEmail or // SendRawEmail to apply to an email. Message tags, which you use with // configuration sets, enable you to publish email sending events. For information -// about using configuration sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type MessageTag struct { // The name of the tag. The name must: - // - // * This value can only contain ASCII letters - // (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * Contain less than - // 256 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Contain less than 256 characters. // // This member is required. Name *string // The value of the tag. The value must: - // - // * This value can only contain ASCII - // letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * Contain - // less than 256 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Contain less than 256 characters. // // This member is required. Value *string @@ -718,11 +678,11 @@ type RawMessage struct { // encoding. The To:, CC:, and BCC: headers in the raw message can contain a group // list. If you are using SendRawEmail with sending authorization, you can include // X-headers in the raw message to specify the "Source," "From," and "Return-Path" - // addresses. For more information, see the documentation for SendRawEmail. Do not + // addresses. For more information, see the documentation for SendRawEmail . Do not // include these X-headers in the DKIM signature, because they are removed by // Amazon SES before sending the email. For more information, go to the Amazon SES - // Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html). + // Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html) + // . // // This member is required. Data []byte @@ -730,11 +690,11 @@ type RawMessage struct { noSmithyDocumentSerde } -// An action that Amazon SES can take when it receives an email on behalf of one or -// more email addresses or domains that you own. An instance of this data type can -// represent only one action. For information about setting up receipt rules, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// An action that Amazon SES can take when it receives an email on behalf of one +// or more email addresses or domains that you own. An instance of this data type +// can represent only one action. For information about setting up receipt rules, +// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html) +// . type ReceiptAction struct { // Adds a header to the received email. @@ -745,8 +705,8 @@ type ReceiptAction struct { // (Amazon SNS). BounceAction *BounceAction - // Calls an AWS Lambda function, and optionally, publishes a notification to Amazon - // SNS. + // Calls an AWS Lambda function, and optionally, publishes a notification to + // Amazon SNS. LambdaAction *LambdaAction // Saves the received message to an Amazon Simple Storage Service (Amazon S3) @@ -760,8 +720,8 @@ type ReceiptAction struct { // notification to Amazon SNS. StopAction *StopAction - // Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon - // SNS. + // Calls Amazon WorkMail and, optionally, publishes a notification to Amazon + // Amazon SNS. WorkmailAction *WorkmailAction noSmithyDocumentSerde @@ -769,8 +729,8 @@ type ReceiptAction struct { // A receipt IP address filter enables you to specify whether to accept or reject // mail originating from an IP address or range of IP addresses. For information -// about setting up IP address filters, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). +// about setting up IP address filters, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html) +// . type ReceiptFilter struct { // A structure that provides the IP addresses to block or allow, and whether to @@ -780,14 +740,10 @@ type ReceiptFilter struct { IpFilter *ReceiptIpFilter // The name of the IP address filter. The name must: - // - // * This value can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * - // Start and end with a letter or number. - // - // * Contain less than 64 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Start and end with a letter or number. + // - Contain less than 64 characters. // // This member is required. Name *string @@ -797,15 +753,15 @@ type ReceiptFilter struct { // A receipt IP address filter enables you to specify whether to accept or reject // mail originating from an IP address or range of IP addresses. For information -// about setting up IP address filters, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html). +// about setting up IP address filters, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html) +// . type ReceiptIpFilter struct { // A single IP address or a range of IP addresses that you want to block or allow, // specified in Classless Inter-Domain Routing (CIDR) notation. An example of a // single email address is 10.0.0.1. An example of a range of IP addresses is - // 10.0.0.1/24. For more information about CIDR notation, see RFC 2317 - // (https://tools.ietf.org/html/rfc2317). + // 10.0.0.1/24. For more information about CIDR notation, see RFC 2317 (https://tools.ietf.org/html/rfc2317) + // . // // This member is required. Cidr *string @@ -819,34 +775,30 @@ type ReceiptIpFilter struct { noSmithyDocumentSerde } -// Receipt rules enable you to specify which actions Amazon SES should take when it -// receives mail on behalf of one or more email addresses or domains that you own. -// Each receipt rule defines a set of email addresses or domains that it applies -// to. If the email addresses or domains match at least one recipient address of -// the message, Amazon SES executes all of the receipt rule's actions on the -// message. For information about setting up receipt rules, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html). +// Receipt rules enable you to specify which actions Amazon SES should take when +// it receives mail on behalf of one or more email addresses or domains that you +// own. Each receipt rule defines a set of email addresses or domains that it +// applies to. If the email addresses or domains match at least one recipient +// address of the message, Amazon SES executes all of the receipt rule's actions on +// the message. For information about setting up receipt rules, see the Amazon SES +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html) +// . type ReceiptRule struct { // The name of the receipt rule. The name must: - // - // * This value can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * - // Start and end with a letter or number. - // - // * Contain less than 64 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Start and end with a letter or number. + // - Contain less than 64 characters. // // This member is required. Name *string - // An ordered list of actions to perform on messages that match at least one of the - // recipient email addresses or domains specified in the receipt rule. + // An ordered list of actions to perform on messages that match at least one of + // the recipient email addresses or domains specified in the receipt rule. Actions []ReceiptAction - // If true, the receipt rule is active. The default value is false. + // If true , the receipt rule is active. The default value is false . Enabled bool // The recipient domains and email addresses that the receipt rule applies to. If @@ -854,14 +806,14 @@ type ReceiptRule struct { // verified domains. Recipients []string - // If true, then messages that this receipt rule applies to are scanned for spam - // and viruses. The default value is false. + // If true , then messages that this receipt rule applies to are scanned for spam + // and viruses. The default value is false . ScanEnabled bool // Specifies whether Amazon SES should require that incoming email is delivered // over a connection encrypted with Transport Layer Security (TLS). If this - // parameter is set to Require, Amazon SES will bounce emails that are not received - // over TLS. The default is Optional. + // parameter is set to Require , Amazon SES will bounce emails that are not + // received over TLS. The default is Optional . TlsPolicy TlsPolicy noSmithyDocumentSerde @@ -870,22 +822,18 @@ type ReceiptRule struct { // Information about a receipt rule set. A receipt rule set is a collection of // rules that specify what Amazon SES should do with mail it receives on behalf of // your account's verified domains. For information about setting up receipt rule -// sets, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html). +// sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html) +// . type ReceiptRuleSetMetadata struct { // The date and time the receipt rule set was created. CreatedTimestamp *time.Time // The name of the receipt rule set. The name must: - // - // * This value can only contain - // ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - // - // * - // Start and end with a letter or number. - // - // * Contain less than 64 characters. + // - This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), + // underscores (_), or dashes (-). + // - Start and end with a letter or number. + // - Contain less than 64 characters. Name *string noSmithyDocumentSerde @@ -894,46 +842,47 @@ type ReceiptRuleSetMetadata struct { // Recipient-related information to include in the Delivery Status Notification // (DSN) when an email that Amazon SES receives on your behalf bounces. For // information about receiving email through Amazon SES, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html) +// . type RecipientDsnFields struct { // The action performed by the reporting mail transfer agent (MTA) as a result of // its attempt to deliver the message to the recipient address. This is required by - // RFC 3464 (https://tools.ietf.org/html/rfc3464). + // RFC 3464 (https://tools.ietf.org/html/rfc3464) . // // This member is required. Action DsnAction - // The status code that indicates what went wrong. This is required by RFC 3464 - // (https://tools.ietf.org/html/rfc3464). + // The status code that indicates what went wrong. This is required by RFC 3464 (https://tools.ietf.org/html/rfc3464) + // . // // This member is required. Status *string // An extended explanation of what went wrong; this is usually an SMTP response. - // See RFC 3463 (https://tools.ietf.org/html/rfc3463) for the correct formatting of - // this parameter. + // See RFC 3463 (https://tools.ietf.org/html/rfc3463) for the correct formatting + // of this parameter. DiagnosticCode *string // Additional X-headers to include in the DSN. ExtensionFields []ExtensionField - // The email address that the message was ultimately delivered to. This corresponds - // to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set - // to the Recipient specified in the BouncedRecipientInfo structure. Either - // FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of - // the original bounced message. Do not prepend the FinalRecipient email address - // with rfc 822;, as described in RFC 3798 (https://tools.ietf.org/html/rfc3798). + // The email address that the message was ultimately delivered to. This + // corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient + // will be set to the Recipient specified in the BouncedRecipientInfo structure. + // Either FinalRecipient or the recipient in BouncedRecipientInfo must be a + // recipient of the original bounced message. Do not prepend the FinalRecipient + // email address with rfc 822; , as described in RFC 3798 (https://tools.ietf.org/html/rfc3798) + // . FinalRecipient *string - // The time the final delivery attempt was made, in RFC 822 - // (https://www.ietf.org/rfc/rfc0822.txt) date-time format. + // The time the final delivery attempt was made, in RFC 822 (https://www.ietf.org/rfc/rfc0822.txt) + // date-time format. LastAttemptDate *time.Time // The MTA to which the remote MTA attempted to deliver the message, formatted as - // specified in RFC 3464 (https://tools.ietf.org/html/rfc3464) (mta-name-type; - // mta-name). This parameter typically applies only to propagating synchronous + // specified in RFC 3464 (https://tools.ietf.org/html/rfc3464) ( mta-name-type; + // mta-name ). This parameter typically applies only to propagating synchronous // bounces. RemoteMta *string @@ -943,26 +892,26 @@ type RecipientDsnFields struct { // Contains information about the reputation settings for a configuration set. type ReputationOptions struct { - // The date and time at which the reputation metrics for the configuration set were - // last reset. Resetting these metrics is known as a fresh start. When you disable - // email sending for a configuration set using UpdateConfigurationSetSendingEnabled - // and later re-enable it, the reputation metrics for the configuration set (but - // not for the entire Amazon SES account) are reset. If email sending for the - // configuration set has never been disabled and later re-enabled, the value of - // this attribute is null. + // The date and time at which the reputation metrics for the configuration set + // were last reset. Resetting these metrics is known as a fresh start. When you + // disable email sending for a configuration set using + // UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation + // metrics for the configuration set (but not for the entire Amazon SES account) + // are reset. If email sending for the configuration set has never been disabled + // and later re-enabled, the value of this attribute is null . LastFreshStart *time.Time // Describes whether or not Amazon SES publishes reputation metrics for the // configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If - // the value is true, reputation metrics are published. If the value is false, - // reputation metrics are not published. The default value is false. + // the value is true , reputation metrics are published. If the value is false , + // reputation metrics are not published. The default value is false . ReputationMetricsEnabled bool // Describes whether email sending is enabled or disabled for the configuration - // set. If the value is true, then Amazon SES will send emails that use the - // configuration set. If the value is false, Amazon SES will not send emails that - // use the configuration set. The default value is true. You can change this - // setting using UpdateConfigurationSetSendingEnabled. + // set. If the value is true , then Amazon SES will send emails that use the + // configuration set. If the value is false , Amazon SES will not send emails that + // use the configuration set. The default value is true . You can change this + // setting using UpdateConfigurationSetSendingEnabled . SendingEnabled bool noSmithyDocumentSerde @@ -974,13 +923,12 @@ type ReputationOptions struct { // Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to // encrypt your emails, or publish to an Amazon SNS topic of another account, // Amazon SES must have permission to access those resources. For information about -// giving permissions, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). -// When you save your emails to an Amazon S3 bucket, the maximum email size +// giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . When you save your emails to an Amazon S3 bucket, the maximum email size // (including headers) is 30 MB. Emails larger than that will bounce. For // information about specifying Amazon S3 actions in receipt rules, see the Amazon -// SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html). +// SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html) +// . type S3Action struct { // The name of the Amazon S3 bucket that incoming email will be saved to. @@ -988,59 +936,52 @@ type S3Action struct { // This member is required. BucketName *string - // The customer master key that Amazon SES should use to encrypt your emails before - // saving them to the Amazon S3 bucket. You can use the default master key or a - // custom master key you created in AWS KMS as follows: - // - // * To use the default - // master key, provide an ARN in the form of - // arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if - // your AWS account ID is 123456789012 and you want to use the default master key - // in the US West (Oregon) region, the ARN of the default master key would be - // arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master - // key, you don't need to perform any extra steps to give Amazon SES permission to - // use the key. - // - // * To use a custom master key you created in AWS KMS, provide the - // ARN of the master key and ensure that you add a statement to your key's policy - // to give Amazon SES permission to use it. For more information about giving - // permissions, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). - // - // For - // more information about key policies, see the AWS KMS Developer Guide - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html). If you do - // not specify a master key, Amazon SES will not encrypt your emails. Your mail is - // encrypted by Amazon SES using the Amazon S3 encryption client before the mail is - // submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 - // server-side encryption. This means that you must use the Amazon S3 encryption - // client to decrypt the email after retrieving it from Amazon S3, as the service - // has no access to use your AWS KMS keys for decryption. This encryption client is - // currently available with the AWS SDK for Java - // (http://aws.amazon.com/sdk-for-java/) and AWS SDK for Ruby - // (http://aws.amazon.com/sdk-for-ruby/) only. For more information about - // client-side encryption using AWS KMS master keys, see the Amazon S3 Developer - // Guide - // (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). + // The customer master key that Amazon SES should use to encrypt your emails + // before saving them to the Amazon S3 bucket. You can use the default master key + // or a custom master key you created in AWS KMS as follows: + // - To use the default master key, provide an ARN in the form of + // arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses . For example, if + // your AWS account ID is 123456789012 and you want to use the default master key + // in the US West (Oregon) region, the ARN of the default master key would be + // arn:aws:kms:us-west-2:123456789012:alias/aws/ses . If you use the default + // master key, you don't need to perform any extra steps to give Amazon SES + // permission to use the key. + // - To use a custom master key you created in AWS KMS, provide the ARN of the + // master key and ensure that you add a statement to your key's policy to give + // Amazon SES permission to use it. For more information about giving permissions, + // see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) + // . + // For more information about key policies, see the AWS KMS Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) + // . If you do not specify a master key, Amazon SES will not encrypt your emails. + // Your mail is encrypted by Amazon SES using the Amazon S3 encryption client + // before the mail is submitted to Amazon S3 for storage. It is not encrypted using + // Amazon S3 server-side encryption. This means that you must use the Amazon S3 + // encryption client to decrypt the email after retrieving it from Amazon S3, as + // the service has no access to use your AWS KMS keys for decryption. This + // encryption client is currently available with the AWS SDK for Java (http://aws.amazon.com/sdk-for-java/) + // and AWS SDK for Ruby (http://aws.amazon.com/sdk-for-ruby/) only. For more + // information about client-side encryption using AWS KMS master keys, see the + // Amazon S3 Developer Guide (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) + // . KmsKeyArn *string - // The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory - // name that enables you to store similar data under the same directory in a - // bucket. + // The key prefix of the Amazon S3 bucket. The key prefix is similar to a + // directory name that enables you to store similar data under the same directory + // in a bucket. ObjectKeyPrefix *string // The ARN of the Amazon SNS topic to notify when the message is saved to the // Amazon S3 bucket. An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . TopicArn *string noSmithyDocumentSerde } -// Represents sending statistics data. Each SendDataPoint contains statistics for a -// 15-minute period of sending activity. +// Represents sending statistics data. Each SendDataPoint contains statistics for +// a 15-minute period of sending activity. type SendDataPoint struct { // Number of emails that have bounced. @@ -1069,19 +1010,18 @@ type SendDataPoint struct { // need to do anything to give Amazon SES permission to publish emails to it. // However, if you don't own the Amazon SNS topic, you need to attach a policy to // the topic to give Amazon SES permissions to access it. For information about -// giving permissions, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html). -// You can only publish emails that are 150 KB or less (including the header) to +// giving permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html) +// . You can only publish emails that are 150 KB or less (including the header) to // Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 // KB, use the S3 action instead. For information about using a receipt rule to -// publish an Amazon SNS notification, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html). +// publish an Amazon SNS notification, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html) +// . type SNSAction struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of - // an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more - // information about Amazon SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more + // information about Amazon SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . // // This member is required. TopicArn *string @@ -1099,15 +1039,15 @@ type SNSAction struct { // (Amazon SNS) event destination. Event destinations, such as Amazon SNS, are // associated with configuration sets, which enable you to publish email sending // events. For information about using configuration sets, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html) +// . type SNSDestination struct { // The ARN of the Amazon SNS topic that email sending events will be published to. // An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . // // This member is required. TopicARN *string @@ -1118,20 +1058,20 @@ type SNSDestination struct { // When included in a receipt rule, this action terminates the evaluation of the // receipt rule set and, optionally, publishes a notification to Amazon Simple // Notification Service (Amazon SNS). For information about setting a stop action -// in a receipt rule, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html). +// in a receipt rule, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html) +// . type StopAction struct { - // The scope of the StopAction. The only acceptable value is RuleSet. + // The scope of the StopAction. The only acceptable value is RuleSet . // // This member is required. Scope StopScope // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop // action is taken. An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . TopicArn *string noSmithyDocumentSerde @@ -1175,8 +1115,7 @@ type TemplateMetadata struct { // A domain that is used to redirect email recipients to an Amazon SES-operated // domain. This domain captures open and click events generated by Amazon SES // emails. For more information, see Configuring Custom Domains to Handle Open and -// Click Tracking -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) +// Click Tracking (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html) // in the Amazon SES Developer Guide. type TrackingOptions struct { @@ -1191,25 +1130,25 @@ type TrackingOptions struct { // optionally, publishes a notification to Amazon Simple Notification Service // (Amazon SNS). You will typically not use this action directly because Amazon // WorkMail adds the rule automatically during its setup procedure. For information -// using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html). +// using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html) +// . type WorkmailAction struct { // The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail // organization ARN is - // arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. - // For information about Amazon WorkMail organizations, see the Amazon WorkMail - // Administrator Guide - // (https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html). + // arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 + // . For information about Amazon WorkMail organizations, see the Amazon WorkMail + // Administrator Guide (https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html) + // . // // This member is required. OrganizationArn *string // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the // WorkMail action is called. An example of an Amazon SNS topic ARN is - // arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon - // SNS topics, see the Amazon SNS Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon + // SNS topics, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) + // . TopicArn *string noSmithyDocumentSerde diff --git a/service/sesv2/api_client.go b/service/sesv2/api_client.go index a69074e1c99..15ca1367bf7 100644 --- a/service/sesv2/api_client.go +++ b/service/sesv2/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sesv2/api_op_BatchGetMetricData.go b/service/sesv2/api_op_BatchGetMetricData.go index 0fd1b02a015..0577b145070 100644 --- a/service/sesv2/api_op_BatchGetMetricData.go +++ b/service/sesv2/api_op_BatchGetMetricData.go @@ -47,7 +47,7 @@ type BatchGetMetricDataOutput struct { // request. Errors []types.MetricDataError - // A list of successfully retrieved MetricDataResult. + // A list of successfully retrieved MetricDataResult . Results []types.MetricDataResult // Metadata pertaining to the operation's result. diff --git a/service/sesv2/api_op_CreateConfigurationSet.go b/service/sesv2/api_op_CreateConfigurationSet.go index 5ef0fcff2f2..358ebb4dafa 100644 --- a/service/sesv2/api_op_CreateConfigurationSet.go +++ b/service/sesv2/api_op_CreateConfigurationSet.go @@ -44,8 +44,8 @@ type CreateConfigurationSetInput struct { // you send using the configuration set. DeliveryOptions *types.DeliveryOptions - // An object that defines whether or not Amazon SES collects reputation metrics for - // the emails that you send that use the configuration set. + // An object that defines whether or not Amazon SES collects reputation metrics + // for the emails that you send that use the configuration set. ReputationOptions *types.ReputationOptions // An object that defines whether or not Amazon SES can send email that you send @@ -56,8 +56,8 @@ type CreateConfigurationSetInput struct { // your account. SuppressionOptions *types.SuppressionOptions - // An array of objects that define the tags (keys and values) to associate with the - // configuration set. + // An array of objects that define the tags (keys and values) to associate with + // the configuration set. Tags []types.Tag // An object that defines the open and click tracking options for emails that you @@ -71,8 +71,8 @@ type CreateConfigurationSetInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateConfigurationSetEventDestination.go b/service/sesv2/api_op_CreateConfigurationSetEventDestination.go index 0733bcc18cf..39373106696 100644 --- a/service/sesv2/api_op_CreateConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_CreateConfigurationSetEventDestination.go @@ -54,8 +54,8 @@ type CreateConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go index 2a996abd9b1..0f4b2df6736 100644 --- a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Creates a new custom verification email template. For more information about // custom verification email templates, see Using custom verification email -// templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, params *CreateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*CreateCustomVerificationEmailTemplateOutput, error) { @@ -53,8 +52,7 @@ type CreateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email must // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom verification email frequently asked questions - // (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq) + // For more information, see Custom verification email frequently asked questions (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq) // in the Amazon SES Developer Guide. // // This member is required. @@ -73,8 +71,8 @@ type CreateCustomVerificationEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type CreateCustomVerificationEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateDedicatedIpPool.go b/service/sesv2/api_op_CreateDedicatedIpPool.go index 5d5b7ff5b29..6709749cbcd 100644 --- a/service/sesv2/api_op_CreateDedicatedIpPool.go +++ b/service/sesv2/api_op_CreateDedicatedIpPool.go @@ -49,8 +49,8 @@ type CreateDedicatedIpPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateDedicatedIpPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateDeliverabilityTestReport.go b/service/sesv2/api_op_CreateDeliverabilityTestReport.go index f253bdd573c..4b7b8478011 100644 --- a/service/sesv2/api_op_CreateDeliverabilityTestReport.go +++ b/service/sesv2/api_op_CreateDeliverabilityTestReport.go @@ -69,10 +69,10 @@ type CreateDeliverabilityTestReportInput struct { // Information about the predictive inbox placement test that you created. type CreateDeliverabilityTestReportOutput struct { - // The status of the predictive inbox placement test. If the status is IN_PROGRESS, - // then the predictive inbox placement test is currently running. Predictive inbox - // placement tests are usually complete within 24 hours of creating the test. If - // the status is COMPLETE, then the test is finished, and you can use the + // The status of the predictive inbox placement test. If the status is IN_PROGRESS + // , then the predictive inbox placement test is currently running. Predictive + // inbox placement tests are usually complete within 24 hours of creating the test. + // If the status is COMPLETE , then the test is finished, and you can use the // GetDeliverabilityTestReport to view the results of the test. // // This member is required. diff --git a/service/sesv2/api_op_CreateEmailIdentity.go b/service/sesv2/api_op_CreateEmailIdentity.go index d6a48e8bc88..3f599641143 100644 --- a/service/sesv2/api_op_CreateEmailIdentity.go +++ b/service/sesv2/api_op_CreateEmailIdentity.go @@ -22,9 +22,8 @@ import ( // operation provides a set of DKIM tokens. You can convert these tokens into CNAME // records, which you then add to the DNS configuration for your domain. Your // domain is verified when Amazon SES detects these records in the DNS -// configuration for your domain. This verification method is known as Easy DKIM -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). -// Alternatively, you can perform the verification process by providing your own +// configuration for your domain. This verification method is known as Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// . Alternatively, you can perform the verification process by providing your own // public-private key pair. This verification method is known as Bring Your Own // DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation // has to include the DkimSigningAttributes object. When you specify this object, @@ -68,14 +67,13 @@ type CreateEmailIdentityInput struct { // If your request includes this object, Amazon SES configures the identity to use // Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures - // the key length to be used for Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). You can - // only specify this object if the email identity is a domain, as opposed to an - // address. + // the key length to be used for Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // . You can only specify this object if the email identity is a domain, as opposed + // to an address. DkimSigningAttributes *types.DkimSigningAttributes - // An array of objects that define the tags (keys and values) to associate with the - // email identity. + // An array of objects that define the tags (keys and values) to associate with + // the email identity. Tags []types.Tag noSmithyDocumentSerde @@ -95,8 +93,8 @@ type CreateEmailIdentityOutput struct { // Specifies whether or not the identity is verified. You can only send email from // verified email addresses or domains. For more information about verifying - // identities, see the Amazon Pinpoint User Guide - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). + // identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html) + // . VerifiedForSendingStatus bool // Metadata pertaining to the operation's result. diff --git a/service/sesv2/api_op_CreateEmailIdentityPolicy.go b/service/sesv2/api_op_CreateEmailIdentityPolicy.go index a74bb98c4ad..44b985e1046 100644 --- a/service/sesv2/api_op_CreateEmailIdentityPolicy.go +++ b/service/sesv2/api_op_CreateEmailIdentityPolicy.go @@ -15,9 +15,8 @@ import ( // not verified the identity, this API will return an error. Sending authorization // is a feature that enables an identity owner to authorize other senders to use // its identities. For information about using sending authorization, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateEmailIdentityPolicy(ctx context.Context, params *CreateEmailIdentityPolicyInput, optFns ...func(*Options)) (*CreateEmailIdentityPolicyOutput, error) { if params == nil { params = &CreateEmailIdentityPolicyInput{} @@ -36,8 +35,8 @@ func (c *Client) CreateEmailIdentityPolicy(ctx context.Context, params *CreateEm // Represents a request to create a sending authorization policy for an identity. // Sending authorization is an Amazon SES feature that enables you to authorize // other senders to use your identities. For information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) +// . type CreateEmailIdentityPolicyInput struct { // The email identity. @@ -47,14 +46,14 @@ type CreateEmailIdentityPolicyInput struct { // The text of the policy in JSON format. The policy cannot exceed 4 KB. For // information about the syntax of sending authorization policies, see the Amazon - // SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html) + // . // // This member is required. Policy *string - // The name of the policy. The policy name cannot exceed 64 characters and can only - // include alphanumeric characters, dashes, and underscores. + // The name of the policy. The policy name cannot exceed 64 characters and can + // only include alphanumeric characters, dashes, and underscores. // // This member is required. PolicyName *string @@ -62,8 +61,8 @@ type CreateEmailIdentityPolicyInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateEmailIdentityPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateEmailTemplate.go b/service/sesv2/api_op_CreateEmailTemplate.go index a8139a8f503..23e733b95c2 100644 --- a/service/sesv2/api_op_CreateEmailTemplate.go +++ b/service/sesv2/api_op_CreateEmailTemplate.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an email template. Email templates enable you to send personalized email -// to one or more destinations in a single API operation. For more information, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). -// You can execute this operation no more than once per second. +// Creates an email template. Email templates enable you to send personalized +// email to one or more destinations in a single API operation. For more +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . You can execute this operation no more than once per second. func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTemplateInput, optFns ...func(*Options)) (*CreateEmailTemplateOutput, error) { if params == nil { params = &CreateEmailTemplateInput{} @@ -32,12 +31,12 @@ func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTem } // Represents a request to create an email template. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type CreateEmailTemplateInput struct { - // The content of the email template, composed of a subject line, an HTML part, and - // a text-only part. + // The content of the email template, composed of a subject line, an HTML part, + // and a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent @@ -50,8 +49,8 @@ type CreateEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type CreateEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_CreateImportJob.go b/service/sesv2/api_op_CreateImportJob.go index 71c2993bade..63f64e0362c 100644 --- a/service/sesv2/api_op_CreateImportJob.go +++ b/service/sesv2/api_op_CreateImportJob.go @@ -44,8 +44,8 @@ type CreateImportJobInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type CreateImportJobOutput struct { // A string that represents the import job ID. diff --git a/service/sesv2/api_op_DeleteConfigurationSet.go b/service/sesv2/api_op_DeleteConfigurationSet.go index 6e36073eb4e..995741454b9 100644 --- a/service/sesv2/api_op_DeleteConfigurationSet.go +++ b/service/sesv2/api_op_DeleteConfigurationSet.go @@ -41,8 +41,8 @@ type DeleteConfigurationSetInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteConfigurationSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go b/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go index d9d03d0c65a..aff2d24f601 100644 --- a/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go @@ -47,8 +47,8 @@ type DeleteConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go b/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go index d7a8a65068b..3a46853a34a 100644 --- a/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Deletes an existing custom verification email template. For more information // about custom verification email templates, see Using custom verification email -// templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) DeleteCustomVerificationEmailTemplate(ctx context.Context, params *DeleteCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*DeleteCustomVerificationEmailTemplateOutput, error) { @@ -42,8 +41,8 @@ type DeleteCustomVerificationEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type DeleteCustomVerificationEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteDedicatedIpPool.go b/service/sesv2/api_op_DeleteDedicatedIpPool.go index f262bac6750..872ec00d7cf 100644 --- a/service/sesv2/api_op_DeleteDedicatedIpPool.go +++ b/service/sesv2/api_op_DeleteDedicatedIpPool.go @@ -37,8 +37,8 @@ type DeleteDedicatedIpPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteDedicatedIpPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteEmailIdentity.go b/service/sesv2/api_op_DeleteEmailIdentity.go index 5d535631954..1c9a8a6c7eb 100644 --- a/service/sesv2/api_op_DeleteEmailIdentity.go +++ b/service/sesv2/api_op_DeleteEmailIdentity.go @@ -27,9 +27,10 @@ func (c *Client) DeleteEmailIdentity(ctx context.Context, params *DeleteEmailIde return out, nil } -// A request to delete an existing email identity. When you delete an identity, you -// lose the ability to send email from that identity. You can restore your ability -// to send email by completing the verification process for the identity again. +// A request to delete an existing email identity. When you delete an identity, +// you lose the ability to send email from that identity. You can restore your +// ability to send email by completing the verification process for the identity +// again. type DeleteEmailIdentityInput struct { // The identity (that is, the email address or domain) to delete. @@ -40,8 +41,8 @@ type DeleteEmailIdentityInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteEmailIdentityOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteEmailIdentityPolicy.go b/service/sesv2/api_op_DeleteEmailIdentityPolicy.go index 85ba260daa3..f273f8aa202 100644 --- a/service/sesv2/api_op_DeleteEmailIdentityPolicy.go +++ b/service/sesv2/api_op_DeleteEmailIdentityPolicy.go @@ -16,9 +16,8 @@ import ( // you have not verified the identity, this API will return an error. Sending // authorization is a feature that enables an identity owner to authorize other // senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) DeleteEmailIdentityPolicy(ctx context.Context, params *DeleteEmailIdentityPolicyInput, optFns ...func(*Options)) (*DeleteEmailIdentityPolicyOutput, error) { if params == nil { params = &DeleteEmailIdentityPolicyInput{} @@ -37,8 +36,8 @@ func (c *Client) DeleteEmailIdentityPolicy(ctx context.Context, params *DeleteEm // Represents a request to delete a sending authorization policy for an identity. // Sending authorization is an Amazon SES feature that enables you to authorize // other senders to use your identities. For information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) +// . type DeleteEmailIdentityPolicyInput struct { // The email identity. @@ -46,8 +45,8 @@ type DeleteEmailIdentityPolicyInput struct { // This member is required. EmailIdentity *string - // The name of the policy. The policy name cannot exceed 64 characters and can only - // include alphanumeric characters, dashes, and underscores. + // The name of the policy. The policy name cannot exceed 64 characters and can + // only include alphanumeric characters, dashes, and underscores. // // This member is required. PolicyName *string @@ -55,8 +54,8 @@ type DeleteEmailIdentityPolicyInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteEmailIdentityPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteEmailTemplate.go b/service/sesv2/api_op_DeleteEmailTemplate.go index e11dd22edc1..4d1d0b07134 100644 --- a/service/sesv2/api_op_DeleteEmailTemplate.go +++ b/service/sesv2/api_op_DeleteEmailTemplate.go @@ -28,8 +28,8 @@ func (c *Client) DeleteEmailTemplate(ctx context.Context, params *DeleteEmailTem } // Represents a request to delete an email template. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type DeleteEmailTemplateInput struct { // The name of the template to be deleted. @@ -40,8 +40,8 @@ type DeleteEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type DeleteEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_DeleteSuppressedDestination.go b/service/sesv2/api_op_DeleteSuppressedDestination.go index 715f6bafe43..89eda0f5d81 100644 --- a/service/sesv2/api_op_DeleteSuppressedDestination.go +++ b/service/sesv2/api_op_DeleteSuppressedDestination.go @@ -37,8 +37,8 @@ type DeleteSuppressedDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type DeleteSuppressedDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_GetAccount.go b/service/sesv2/api_op_GetAccount.go index 357ed876ba4..91a6748b95a 100644 --- a/service/sesv2/api_op_GetAccount.go +++ b/service/sesv2/api_op_GetAccount.go @@ -47,26 +47,23 @@ type GetAccountOutput struct { // The reputation status of your Amazon SES account. The status can be one of the // following: - // - // * HEALTHY – There are no reputation-related issues that currently - // impact your account. - // - // * PROBATION – We've identified potential issues with your - // Amazon SES account. We're placing your account under review while you work on - // correcting these issues. - // - // * SHUTDOWN – Your account's ability to send email is - // currently paused because of an issue with the email sent from your account. When - // you correct the issue, you can contact us and request that your account's - // ability to send email is resumed. + // - HEALTHY – There are no reputation-related issues that currently impact your + // account. + // - PROBATION – We've identified potential issues with your Amazon SES account. + // We're placing your account under review while you work on correcting these + // issues. + // - SHUTDOWN – Your account's ability to send email is currently paused because + // of an issue with the email sent from your account. When you correct the issue, + // you can contact us and request that your account's ability to send email is + // resumed. EnforcementStatus *string // Indicates whether or not your account has production access in the current - // Amazon Web Services Region. If the value is false, then your account is in the + // Amazon Web Services Region. If the value is false , then your account is in the // sandbox. When your account is in the sandbox, you can only send email to // verified identities. Additionally, the maximum number of emails you can send in // a 24-hour period (your sending quota) is 200, and the maximum number of emails - // you can send per second (your maximum sending rate) is 1. If the value is true, + // you can send per second (your maximum sending rate) is 1. If the value is true , // then your account has production access. When your account has production // access, you can send email to any address. The sending quota and maximum sending // rate for your account vary based on your specific use case. @@ -76,8 +73,8 @@ type GetAccountOutput struct { // limits for your Amazon SES account in the current Amazon Web Services Region. SendQuota *types.SendQuota - // Indicates whether or not email sending is enabled for your Amazon SES account in - // the current Amazon Web Services Region. + // Indicates whether or not email sending is enabled for your Amazon SES account + // in the current Amazon Web Services Region. SendingEnabled bool // An object that contains information about the email address suppression diff --git a/service/sesv2/api_op_GetBlacklistReports.go b/service/sesv2/api_op_GetBlacklistReports.go index 45233d68299..1d00a620ab5 100644 --- a/service/sesv2/api_op_GetBlacklistReports.go +++ b/service/sesv2/api_op_GetBlacklistReports.go @@ -44,8 +44,8 @@ type GetBlacklistReportsInput struct { // An object that contains information about blacklist events. type GetBlacklistReportsOutput struct { - // An object that contains information about a blacklist that one of your dedicated - // IP addresses appears on. + // An object that contains information about a blacklist that one of your + // dedicated IP addresses appears on. // // This member is required. BlacklistReport map[string][]types.BlacklistEntry diff --git a/service/sesv2/api_op_GetConfigurationSet.go b/service/sesv2/api_op_GetConfigurationSet.go index d19d65e3926..7edeaed1d9b 100644 --- a/service/sesv2/api_op_GetConfigurationSet.go +++ b/service/sesv2/api_op_GetConfigurationSet.go @@ -54,8 +54,8 @@ type GetConfigurationSetOutput struct { // you send using the configuration set. DeliveryOptions *types.DeliveryOptions - // An object that defines whether or not Amazon SES collects reputation metrics for - // the emails that you send that use the configuration set. + // An object that defines whether or not Amazon SES collects reputation metrics + // for the emails that you send that use the configuration set. ReputationOptions *types.ReputationOptions // An object that defines whether or not Amazon SES can send email that you send diff --git a/service/sesv2/api_op_GetConfigurationSetEventDestinations.go b/service/sesv2/api_op_GetConfigurationSetEventDestinations.go index 26617943aa1..8c7553e5b26 100644 --- a/service/sesv2/api_op_GetConfigurationSetEventDestinations.go +++ b/service/sesv2/api_op_GetConfigurationSetEventDestinations.go @@ -32,8 +32,8 @@ func (c *Client) GetConfigurationSetEventDestinations(ctx context.Context, param return out, nil } -// A request to obtain information about the event destinations for a configuration -// set. +// A request to obtain information about the event destinations for a +// configuration set. type GetConfigurationSetEventDestinationsInput struct { // The name of the configuration set that contains the event destination. diff --git a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go index e5e1b466ebc..989b7a0d3d4 100644 --- a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Returns the custom email verification template for the template name you // specify. For more information about custom verification email templates, see -// Using custom verification email templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) GetCustomVerificationEmailTemplate(ctx context.Context, params *GetCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*GetCustomVerificationEmailTemplateOutput, error) { diff --git a/service/sesv2/api_op_GetDedicatedIps.go b/service/sesv2/api_op_GetDedicatedIps.go index f9a365ec063..64797c209a8 100644 --- a/service/sesv2/api_op_GetDedicatedIps.go +++ b/service/sesv2/api_op_GetDedicatedIps.go @@ -36,8 +36,8 @@ type GetDedicatedIpsInput struct { // position of the dedicated IP pool in the list of IP pools. NextToken *string - // The number of results to show in a single call to GetDedicatedIpsRequest. If the - // number of results is larger than the number you specified in this parameter, + // The number of results to show in a single call to GetDedicatedIpsRequest . If + // the number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. PageSize *int32 @@ -56,9 +56,9 @@ type GetDedicatedIpsOutput struct { // Services account. DedicatedIps []types.DedicatedIp - // A token that indicates that there are additional dedicated IP addresses to list. - // To view additional addresses, issue another request to GetDedicatedIps, passing - // this token in the NextToken parameter. + // A token that indicates that there are additional dedicated IP addresses to + // list. To view additional addresses, issue another request to GetDedicatedIps , + // passing this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -137,8 +137,8 @@ var _ GetDedicatedIpsAPIClient = (*Client)(nil) // GetDedicatedIpsPaginatorOptions is the paginator options for GetDedicatedIps type GetDedicatedIpsPaginatorOptions struct { - // The number of results to show in a single call to GetDedicatedIpsRequest. If the - // number of results is larger than the number you specified in this parameter, + // The number of results to show in a single call to GetDedicatedIpsRequest . If + // the number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. Limit int32 diff --git a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go index deade1483e3..6950a37201f 100644 --- a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go @@ -19,8 +19,8 @@ import ( // tests. When you use the Deliverability dashboard, you pay a monthly subscription // charge, in addition to any other fees that you accrue by using Amazon SES and // other Amazon Web Services services. For more information about the features and -// cost of a Deliverability dashboard subscription, see Amazon SES Pricing -// (http://aws.amazon.com/ses/pricing/). +// cost of a Deliverability dashboard subscription, see Amazon SES Pricing (http://aws.amazon.com/ses/pricing/) +// . func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params *GetDeliverabilityDashboardOptionsInput, optFns ...func(*Options)) (*GetDeliverabilityDashboardOptionsOutput, error) { if params == nil { params = &GetDeliverabilityDashboardOptionsInput{} @@ -43,8 +43,8 @@ func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params * // use the Deliverability dashboard, you pay a monthly subscription charge, in // addition to any other fees that you accrue by using Amazon SES and other Amazon // Web Services services. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . type GetDeliverabilityDashboardOptionsInput struct { noSmithyDocumentSerde } @@ -52,25 +52,25 @@ type GetDeliverabilityDashboardOptionsInput struct { // An object that shows the status of the Deliverability dashboard. type GetDeliverabilityDashboardOptionsOutput struct { - // Specifies whether the Deliverability dashboard is enabled. If this value is - // true, the dashboard is enabled. + // Specifies whether the Deliverability dashboard is enabled. If this value is true + // , the dashboard is enabled. // // This member is required. DashboardEnabled bool // The current status of your Deliverability dashboard subscription. If this value - // is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of + // is PENDING_EXPIRATION , your subscription is scheduled to expire at the end of // the current calendar month. AccountStatus types.DeliverabilityDashboardAccountStatus - // An array of objects, one for each verified domain that you use to send email and - // currently has an active Deliverability dashboard subscription that isn’t + // An array of objects, one for each verified domain that you use to send email + // and currently has an active Deliverability dashboard subscription that isn’t // scheduled to expire at the end of the current calendar month. ActiveSubscribedDomains []types.DomainDeliverabilityTrackingOption - // An array of objects, one for each verified domain that you use to send email and - // currently has an active Deliverability dashboard subscription that's scheduled - // to expire at the end of the current calendar month. + // An array of objects, one for each verified domain that you use to send email + // and currently has an active Deliverability dashboard subscription that's + // scheduled to expire at the end of the current calendar month. PendingExpirationSubscribedDomains []types.DomainDeliverabilityTrackingOption // The date when your current subscription to the Deliverability dashboard is diff --git a/service/sesv2/api_op_GetDomainDeliverabilityCampaign.go b/service/sesv2/api_op_GetDomainDeliverabilityCampaign.go index 5cc78d83d8d..c66c29151f1 100644 --- a/service/sesv2/api_op_GetDomainDeliverabilityCampaign.go +++ b/service/sesv2/api_op_GetDomainDeliverabilityCampaign.go @@ -31,7 +31,7 @@ func (c *Client) GetDomainDeliverabilityCampaign(ctx context.Context, params *Ge // Retrieve all the deliverability data for a specific campaign. This data is // available for a campaign only if the campaign sent email by using a domain that -// the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// the Deliverability dashboard is enabled for ( PutDeliverabilityDashboardOption // operation). type GetDomainDeliverabilityCampaignInput struct { diff --git a/service/sesv2/api_op_GetDomainStatisticsReport.go b/service/sesv2/api_op_GetDomainStatisticsReport.go index 260ac239ac1..9b38d75f9ca 100644 --- a/service/sesv2/api_op_GetDomainStatisticsReport.go +++ b/service/sesv2/api_op_GetDomainStatisticsReport.go @@ -39,7 +39,7 @@ type GetDomainStatisticsReportInput struct { // The last day (in Unix time) that you want to obtain domain deliverability // metrics for. The EndDate that you specify has to be less than or equal to 30 - // days after the StartDate. + // days after the StartDate . // // This member is required. EndDate *time.Time @@ -58,15 +58,15 @@ type GetDomainStatisticsReportInput struct { type GetDomainStatisticsReportOutput struct { // An object that contains deliverability metrics for the domain that you - // specified. This object contains data for each day, starting on the StartDate and - // ending on the EndDate. + // specified. This object contains data for each day, starting on the StartDate + // and ending on the EndDate . // // This member is required. DailyVolumes []types.DailyVolume // An object that contains deliverability metrics for the domain that you // specified. The data in this object is a summary of all of the data that was - // collected from the StartDate to the EndDate. + // collected from the StartDate to the EndDate . // // This member is required. OverallVolume *types.OverallVolume diff --git a/service/sesv2/api_op_GetEmailIdentity.go b/service/sesv2/api_op_GetEmailIdentity.go index 9217856c45d..2fad2490bc1 100644 --- a/service/sesv2/api_op_GetEmailIdentity.go +++ b/service/sesv2/api_op_GetEmailIdentity.go @@ -49,7 +49,7 @@ type GetEmailIdentityOutput struct { // An object that contains information about the DKIM attributes for the identity. DkimAttributes *types.DkimAttributes - // The feedback forwarding configuration for the identity. If the value is true, + // The feedback forwarding configuration for the identity. If the value is true , // you receive email notifications when bounce or complaint events occur. These // notifications are sent to the address that you specified in the Return-Path // header of the original email. You're required to have a method of tracking @@ -63,8 +63,8 @@ type GetEmailIdentityOutput struct { // supported. IdentityType types.IdentityType - // An object that contains information about the Mail-From attributes for the email - // identity. + // An object that contains information about the Mail-From attributes for the + // email identity. MailFromAttributes *types.MailFromAttributes // A map of policy names to policies. @@ -76,27 +76,20 @@ type GetEmailIdentityOutput struct { // The verification status of the identity. The status can be one of the // following: - // - // * PENDING – The verification process was initiated, but Amazon SES - // hasn't yet been able to verify the identity. - // - // * SUCCESS – The verification - // process completed successfully. - // - // * FAILED – The verification process failed. - // - // * - // TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining - // the verification status of the identity. - // - // * NOT_STARTED – The verification - // process hasn't been initiated for the identity. + // - PENDING – The verification process was initiated, but Amazon SES hasn't yet + // been able to verify the identity. + // - SUCCESS – The verification process completed successfully. + // - FAILED – The verification process failed. + // - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from + // determining the verification status of the identity. + // - NOT_STARTED – The verification process hasn't been initiated for the + // identity. VerificationStatus types.VerificationStatus // Specifies whether or not the identity is verified. You can only send email from // verified email addresses or domains. For more information about verifying - // identities, see the Amazon Pinpoint User Guide - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html). + // identities, see the Amazon Pinpoint User Guide (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html) + // . VerifiedForSendingStatus bool // Metadata pertaining to the operation's result. diff --git a/service/sesv2/api_op_GetEmailIdentityPolicies.go b/service/sesv2/api_op_GetEmailIdentityPolicies.go index 490f8a6d81d..f993d34091b 100644 --- a/service/sesv2/api_op_GetEmailIdentityPolicies.go +++ b/service/sesv2/api_op_GetEmailIdentityPolicies.go @@ -16,9 +16,8 @@ import ( // API is for the identity owner only. If you have not verified the identity, this // API will return an error. Sending authorization is a feature that enables an // identity owner to authorize other senders to use its identities. For information -// about using sending authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// about using sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) GetEmailIdentityPolicies(ctx context.Context, params *GetEmailIdentityPoliciesInput, optFns ...func(*Options)) (*GetEmailIdentityPoliciesOutput, error) { if params == nil { params = &GetEmailIdentityPoliciesInput{} diff --git a/service/sesv2/api_op_GetEmailTemplate.go b/service/sesv2/api_op_GetEmailTemplate.go index b8ccd71f15d..7e15320e236 100644 --- a/service/sesv2/api_op_GetEmailTemplate.go +++ b/service/sesv2/api_op_GetEmailTemplate.go @@ -44,8 +44,8 @@ type GetEmailTemplateInput struct { // The following element is returned by the service. type GetEmailTemplateOutput struct { - // The content of the email template, composed of a subject line, an HTML part, and - // a text-only part. + // The content of the email template, composed of a subject line, an HTML part, + // and a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent diff --git a/service/sesv2/api_op_GetImportJob.go b/service/sesv2/api_op_GetImportJob.go index 6288d0dcf30..d94593751ca 100644 --- a/service/sesv2/api_op_GetImportJob.go +++ b/service/sesv2/api_op_GetImportJob.go @@ -40,8 +40,8 @@ type GetImportJobInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type GetImportJobOutput struct { // The time stamp of when the import job was completed. diff --git a/service/sesv2/api_op_ListConfigurationSets.go b/service/sesv2/api_op_ListConfigurationSets.go index 45f71dd469f..09eb5faa8cb 100644 --- a/service/sesv2/api_op_ListConfigurationSets.go +++ b/service/sesv2/api_op_ListConfigurationSets.go @@ -40,7 +40,7 @@ type ListConfigurationSetsInput struct { // position in the list of configuration sets. NextToken *string - // The number of results to show in a single call to ListConfigurationSets. If the + // The number of results to show in a single call to ListConfigurationSets . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. @@ -59,7 +59,7 @@ type ListConfigurationSetsOutput struct { // A token that indicates that there are additional configuration sets to list. To // view additional configuration sets, issue another request to - // ListConfigurationSets, and pass this token in the NextToken parameter. + // ListConfigurationSets , and pass this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListConfigurationSetsAPIClient = (*Client)(nil) // ListConfigurationSetsPaginatorOptions is the paginator options for // ListConfigurationSets type ListConfigurationSetsPaginatorOptions struct { - // The number of results to show in a single call to ListConfigurationSets. If the + // The number of results to show in a single call to ListConfigurationSets . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. diff --git a/service/sesv2/api_op_ListContactLists.go b/service/sesv2/api_op_ListContactLists.go index 16795672492..398a2993b75 100644 --- a/service/sesv2/api_op_ListContactLists.go +++ b/service/sesv2/api_op_ListContactLists.go @@ -30,10 +30,10 @@ func (c *Client) ListContactLists(ctx context.Context, params *ListContactListsI type ListContactListsInput struct { - // A string token indicating that there might be additional contact lists available - // to be listed. Use the token provided in the Response to use in the subsequent - // call to ListContactLists with the same parameters to retrieve the next page of - // contact lists. + // A string token indicating that there might be additional contact lists + // available to be listed. Use the token provided in the Response to use in the + // subsequent call to ListContactLists with the same parameters to retrieve the + // next page of contact lists. NextToken *string // Maximum number of contact lists to return at once. Use this parameter to @@ -50,9 +50,9 @@ type ListContactListsOutput struct { // The available contact lists. ContactLists []types.ContactList - // A string token indicating that there might be additional contact lists available - // to be listed. Copy this token to a subsequent call to ListContactLists with the - // same parameters to retrieve the next page of contact lists. + // A string token indicating that there might be additional contact lists + // available to be listed. Copy this token to a subsequent call to ListContactLists + // with the same parameters to retrieve the next page of contact lists. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/sesv2/api_op_ListContacts.go b/service/sesv2/api_op_ListContacts.go index 6e1d2033a41..117555aa8a7 100644 --- a/service/sesv2/api_op_ListContacts.go +++ b/service/sesv2/api_op_ListContacts.go @@ -46,8 +46,8 @@ type ListContactsInput struct { // The number of contacts that may be returned at once, which is dependent on if // there are more or less contacts than the value of the PageSize. Use this // parameter to paginate results. If additional contacts exist beyond the specified - // limit, the NextToken element is sent in the response. Use the NextToken value in - // subsequent requests to retrieve additional contacts. + // limit, the NextToken element is sent in the response. Use the NextToken value + // in subsequent requests to retrieve additional contacts. PageSize *int32 noSmithyDocumentSerde @@ -144,8 +144,8 @@ type ListContactsPaginatorOptions struct { // The number of contacts that may be returned at once, which is dependent on if // there are more or less contacts than the value of the PageSize. Use this // parameter to paginate results. If additional contacts exist beyond the specified - // limit, the NextToken element is sent in the response. Use the NextToken value in - // subsequent requests to retrieve additional contacts. + // limit, the NextToken element is sent in the response. Use the NextToken value + // in subsequent requests to retrieve additional contacts. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go index 5d76964f983..9f39c346196 100644 --- a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go @@ -14,8 +14,7 @@ import ( // Lists the existing custom verification email templates for your account in the // current Amazon Web Services Region. For more information about custom -// verification email templates, see Using custom verification email templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// verification email templates, see Using custom verification email templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error) { @@ -37,12 +36,12 @@ func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, param // for your account. type ListCustomVerificationEmailTemplatesInput struct { - // A token returned from a previous call to ListCustomVerificationEmailTemplates to - // indicate the position in the list of custom verification email templates. + // A token returned from a previous call to ListCustomVerificationEmailTemplates + // to indicate the position in the list of custom verification email templates. NextToken *string // The number of results to show in a single call to - // ListCustomVerificationEmailTemplates. If the number of results is larger than + // ListCustomVerificationEmailTemplates . If the number of results is larger than // the number you specified in this parameter, then the response includes a // NextToken element, which you can use to obtain additional results. The value you // specify has to be at least 1, and can be no more than 50. @@ -57,8 +56,8 @@ type ListCustomVerificationEmailTemplatesOutput struct { // A list of the custom verification email templates that exist in your account. CustomVerificationEmailTemplates []types.CustomVerificationEmailTemplateMetadata - // A token indicating that there are additional custom verification email templates - // available to be listed. Pass this token to a subsequent call to + // A token indicating that there are additional custom verification email + // templates available to be listed. Pass this token to a subsequent call to // ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification // email templates. NextToken *string @@ -141,7 +140,7 @@ var _ ListCustomVerificationEmailTemplatesAPIClient = (*Client)(nil) // for ListCustomVerificationEmailTemplates type ListCustomVerificationEmailTemplatesPaginatorOptions struct { // The number of results to show in a single call to - // ListCustomVerificationEmailTemplates. If the number of results is larger than + // ListCustomVerificationEmailTemplates . If the number of results is larger than // the number you specified in this parameter, then the response includes a // NextToken element, which you can use to obtain additional results. The value you // specify has to be at least 1, and can be no more than 50. diff --git a/service/sesv2/api_op_ListDedicatedIpPools.go b/service/sesv2/api_op_ListDedicatedIpPools.go index df03e077375..cd7372e5920 100644 --- a/service/sesv2/api_op_ListDedicatedIpPools.go +++ b/service/sesv2/api_op_ListDedicatedIpPools.go @@ -35,7 +35,7 @@ type ListDedicatedIpPoolsInput struct { // position in the list of dedicated IP pools. NextToken *string - // The number of results to show in a single call to ListDedicatedIpPools. If the + // The number of results to show in a single call to ListDedicatedIpPools . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. @@ -47,13 +47,13 @@ type ListDedicatedIpPoolsInput struct { // A list of dedicated IP pools. type ListDedicatedIpPoolsOutput struct { - // A list of all of the dedicated IP pools that are associated with your Amazon Web - // Services account in the current Region. + // A list of all of the dedicated IP pools that are associated with your Amazon + // Web Services account in the current Region. DedicatedIpPools []string // A token that indicates that there are additional IP pools to list. To view - // additional IP pools, issue another request to ListDedicatedIpPools, passing this - // token in the NextToken parameter. + // additional IP pools, issue another request to ListDedicatedIpPools , passing + // this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -133,7 +133,7 @@ var _ ListDedicatedIpPoolsAPIClient = (*Client)(nil) // ListDedicatedIpPoolsPaginatorOptions is the paginator options for // ListDedicatedIpPools type ListDedicatedIpPoolsPaginatorOptions struct { - // The number of results to show in a single call to ListDedicatedIpPools. If the + // The number of results to show in a single call to ListDedicatedIpPools . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. diff --git a/service/sesv2/api_op_ListDeliverabilityTestReports.go b/service/sesv2/api_op_ListDeliverabilityTestReports.go index 9d679c573b6..67321364d11 100644 --- a/service/sesv2/api_op_ListDeliverabilityTestReports.go +++ b/service/sesv2/api_op_ListDeliverabilityTestReports.go @@ -39,8 +39,8 @@ type ListDeliverabilityTestReportsInput struct { // indicate the position in the list of predictive inbox placement tests. NextToken *string - // The number of results to show in a single call to ListDeliverabilityTestReports. - // If the number of results is larger than the number you specified in this + // The number of results to show in a single call to ListDeliverabilityTestReports + // . If the number of results is larger than the number you specified in this // parameter, then the response includes a NextToken element, which you can use to // obtain additional results. The value you specify has to be at least 0, and can // be no more than 1000. @@ -61,7 +61,7 @@ type ListDeliverabilityTestReportsOutput struct { // A token that indicates that there are additional predictive inbox placement // tests to list. To view additional predictive inbox placement tests, issue - // another request to ListDeliverabilityTestReports, and pass this token in the + // another request to ListDeliverabilityTestReports , and pass this token in the // NextToken parameter. NextToken *string @@ -142,8 +142,8 @@ var _ ListDeliverabilityTestReportsAPIClient = (*Client)(nil) // ListDeliverabilityTestReportsPaginatorOptions is the paginator options for // ListDeliverabilityTestReports type ListDeliverabilityTestReportsPaginatorOptions struct { - // The number of results to show in a single call to ListDeliverabilityTestReports. - // If the number of results is larger than the number you specified in this + // The number of results to show in a single call to ListDeliverabilityTestReports + // . If the number of results is larger than the number you specified in this // parameter, then the response includes a NextToken element, which you can use to // obtain additional results. The value you specify has to be at least 0, and can // be no more than 1000. diff --git a/service/sesv2/api_op_ListEmailIdentities.go b/service/sesv2/api_op_ListEmailIdentities.go index ca15f3be2e2..558690909ec 100644 --- a/service/sesv2/api_op_ListEmailIdentities.go +++ b/service/sesv2/api_op_ListEmailIdentities.go @@ -42,7 +42,7 @@ type ListEmailIdentitiesInput struct { // position in the list of identities. NextToken *string - // The number of results to show in a single call to ListEmailIdentities. If the + // The number of results to show in a single call to ListEmailIdentities . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 0, and can be no @@ -61,8 +61,8 @@ type ListEmailIdentitiesOutput struct { EmailIdentities []types.IdentityInfo // A token that indicates that there are additional configuration sets to list. To - // view additional configuration sets, issue another request to - // ListEmailIdentities, and pass this token in the NextToken parameter. + // view additional configuration sets, issue another request to ListEmailIdentities + // , and pass this token in the NextToken parameter. NextToken *string // Metadata pertaining to the operation's result. @@ -131,8 +131,8 @@ func (c *Client) addOperationListEmailIdentitiesMiddlewares(stack *middleware.St return nil } -// ListEmailIdentitiesAPIClient is a client that implements the ListEmailIdentities -// operation. +// ListEmailIdentitiesAPIClient is a client that implements the +// ListEmailIdentities operation. type ListEmailIdentitiesAPIClient interface { ListEmailIdentities(context.Context, *ListEmailIdentitiesInput, ...func(*Options)) (*ListEmailIdentitiesOutput, error) } @@ -142,7 +142,7 @@ var _ ListEmailIdentitiesAPIClient = (*Client)(nil) // ListEmailIdentitiesPaginatorOptions is the paginator options for // ListEmailIdentities type ListEmailIdentitiesPaginatorOptions struct { - // The number of results to show in a single call to ListEmailIdentities. If the + // The number of results to show in a single call to ListEmailIdentities . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 0, and can be no diff --git a/service/sesv2/api_op_ListEmailTemplates.go b/service/sesv2/api_op_ListEmailTemplates.go index 0e8deafca5e..b085d806f1f 100644 --- a/service/sesv2/api_op_ListEmailTemplates.go +++ b/service/sesv2/api_op_ListEmailTemplates.go @@ -32,15 +32,15 @@ func (c *Client) ListEmailTemplates(ctx context.Context, params *ListEmailTempla // Represents a request to list the email templates present in your Amazon SES // account in the current Amazon Web Services Region. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type ListEmailTemplatesInput struct { // A token returned from a previous call to ListEmailTemplates to indicate the // position in the list of email templates. NextToken *string - // The number of results to show in a single call to ListEmailTemplates. If the + // The number of results to show in a single call to ListEmailTemplates . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 1, and can be no @@ -58,8 +58,8 @@ type ListEmailTemplatesOutput struct { // next 10 email templates. NextToken *string - // An array the contains the name and creation time stamp for each template in your - // Amazon SES account. + // An array the contains the name and creation time stamp for each template in + // your Amazon SES account. TemplatesMetadata []types.EmailTemplateMetadata // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListEmailTemplatesAPIClient = (*Client)(nil) // ListEmailTemplatesPaginatorOptions is the paginator options for // ListEmailTemplates type ListEmailTemplatesPaginatorOptions struct { - // The number of results to show in a single call to ListEmailTemplates. If the + // The number of results to show in a single call to ListEmailTemplates . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 1, and can be no diff --git a/service/sesv2/api_op_ListImportJobs.go b/service/sesv2/api_op_ListImportJobs.go index 7af517c4e9a..1a0b213636c 100644 --- a/service/sesv2/api_op_ListImportJobs.go +++ b/service/sesv2/api_op_ListImportJobs.go @@ -33,7 +33,7 @@ func (c *Client) ListImportJobs(ctx context.Context, params *ListImportJobsInput type ListImportJobsInput struct { // The destination of the import job, which can be used to list import jobs that - // have a certain ImportDestinationType. + // have a certain ImportDestinationType . ImportDestinationType types.ImportDestinationType // A string token indicating that there might be additional import jobs available @@ -43,15 +43,15 @@ type ListImportJobsInput struct { // Maximum number of import jobs to return at once. Use this parameter to paginate // results. If additional import jobs exist beyond the specified limit, the - // NextToken element is sent in the response. Use the NextToken value in subsequent - // requests to retrieve additional addresses. + // NextToken element is sent in the response. Use the NextToken value in + // subsequent requests to retrieve additional addresses. PageSize *int32 noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type ListImportJobsOutput struct { // A list of the import job summaries. @@ -140,8 +140,8 @@ var _ ListImportJobsAPIClient = (*Client)(nil) type ListImportJobsPaginatorOptions struct { // Maximum number of import jobs to return at once. Use this parameter to paginate // results. If additional import jobs exist beyond the specified limit, the - // NextToken element is sent in the response. Use the NextToken value in subsequent - // requests to retrieve additional addresses. + // NextToken element is sent in the response. Use the NextToken value in + // subsequent requests to retrieve additional addresses. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListRecommendations.go b/service/sesv2/api_op_ListRecommendations.go index 5a3c934cf19..010fbf9ce3f 100644 --- a/service/sesv2/api_op_ListRecommendations.go +++ b/service/sesv2/api_op_ListRecommendations.go @@ -41,7 +41,7 @@ type ListRecommendationsInput struct { // position in the list of recommendations. NextToken *string - // The number of results to show in a single call to ListRecommendations. If the + // The number of results to show in a single call to ListRecommendations . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 1, and can be no @@ -130,8 +130,8 @@ func (c *Client) addOperationListRecommendationsMiddlewares(stack *middleware.St return nil } -// ListRecommendationsAPIClient is a client that implements the ListRecommendations -// operation. +// ListRecommendationsAPIClient is a client that implements the +// ListRecommendations operation. type ListRecommendationsAPIClient interface { ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error) } @@ -141,7 +141,7 @@ var _ ListRecommendationsAPIClient = (*Client)(nil) // ListRecommendationsPaginatorOptions is the paginator options for // ListRecommendations type ListRecommendationsPaginatorOptions struct { - // The number of results to show in a single call to ListRecommendations. If the + // The number of results to show in a single call to ListRecommendations . If the // number of results is larger than the number you specified in this parameter, // then the response includes a NextToken element, which you can use to obtain // additional results. The value you specify has to be at least 1, and can be no diff --git a/service/sesv2/api_op_ListSuppressedDestinations.go b/service/sesv2/api_op_ListSuppressedDestinations.go index 1cb2987c378..a9235ad7f03 100644 --- a/service/sesv2/api_op_ListSuppressedDestinations.go +++ b/service/sesv2/api_op_ListSuppressedDestinations.go @@ -42,10 +42,10 @@ type ListSuppressedDestinationsInput struct { // the position in the list of suppressed email addresses. NextToken *string - // The number of results to show in a single call to ListSuppressedDestinations. If - // the number of results is larger than the number you specified in this parameter, - // then the response includes a NextToken element, which you can use to obtain - // additional results. + // The number of results to show in a single call to ListSuppressedDestinations . + // If the number of results is larger than the number you specified in this + // parameter, then the response includes a NextToken element, which you can use to + // obtain additional results. PageSize *int32 // The factors that caused the email address to be added to . @@ -63,7 +63,7 @@ type ListSuppressedDestinationsOutput struct { // A token that indicates that there are additional email addresses on the // suppression list for your account. To view additional suppressed addresses, - // issue another request to ListSuppressedDestinations, and pass this token in the + // issue another request to ListSuppressedDestinations , and pass this token in the // NextToken parameter. NextToken *string @@ -148,10 +148,10 @@ var _ ListSuppressedDestinationsAPIClient = (*Client)(nil) // ListSuppressedDestinationsPaginatorOptions is the paginator options for // ListSuppressedDestinations type ListSuppressedDestinationsPaginatorOptions struct { - // The number of results to show in a single call to ListSuppressedDestinations. If - // the number of results is larger than the number you specified in this parameter, - // then the response includes a NextToken element, which you can use to obtain - // additional results. + // The number of results to show in a single call to ListSuppressedDestinations . + // If the number of results is larger than the number you specified in this + // parameter, then the response includes a NextToken element, which you can use to + // obtain additional results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListTagsForResource.go b/service/sesv2/api_op_ListTagsForResource.go index f6dfc214951..952a20322b7 100644 --- a/service/sesv2/api_op_ListTagsForResource.go +++ b/service/sesv2/api_op_ListTagsForResource.go @@ -44,8 +44,8 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // An array that lists all the tags that are associated with the resource. Each tag - // consists of a required tag key (Key) and an associated tag value (Value) + // An array that lists all the tags that are associated with the resource. Each + // tag consists of a required tag key ( Key ) and an associated tag value ( Value ) // // This member is required. Tags []types.Tag diff --git a/service/sesv2/api_op_PutAccountDedicatedIpWarmupAttributes.go b/service/sesv2/api_op_PutAccountDedicatedIpWarmupAttributes.go index ffda0f964cd..2ad3c42f645 100644 --- a/service/sesv2/api_op_PutAccountDedicatedIpWarmupAttributes.go +++ b/service/sesv2/api_op_PutAccountDedicatedIpWarmupAttributes.go @@ -38,8 +38,8 @@ type PutAccountDedicatedIpWarmupAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountDedicatedIpWarmupAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutAccountDetails.go b/service/sesv2/api_op_PutAccountDetails.go index 46458b554f6..469129d62de 100644 --- a/service/sesv2/api_op_PutAccountDetails.go +++ b/service/sesv2/api_op_PutAccountDetails.go @@ -40,8 +40,8 @@ type PutAccountDetailsInput struct { // This member is required. UseCaseDescription *string - // The URL of your website. This information helps us better understand the type of - // content that you plan to send. + // The URL of your website. This information helps us better understand the type + // of content that you plan to send. // // This member is required. WebsiteURL *string @@ -54,11 +54,11 @@ type PutAccountDetailsInput struct { ContactLanguage types.ContactLanguage // Indicates whether or not your account should have production access in the - // current Amazon Web Services Region. If the value is false, then your account is + // current Amazon Web Services Region. If the value is false , then your account is // in the sandbox. When your account is in the sandbox, you can only send email to // verified identities. Additionally, the maximum number of emails you can send in // a 24-hour period (your sending quota) is 200, and the maximum number of emails - // you can send per second (your maximum sending rate) is 1. If the value is true, + // you can send per second (your maximum sending rate) is 1. If the value is true , // then your account has production access. When your account has production // access, you can send email to any address. The sending quota and maximum sending // rate for your account vary based on your specific use case. @@ -67,8 +67,8 @@ type PutAccountDetailsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountDetailsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutAccountSendingAttributes.go b/service/sesv2/api_op_PutAccountSendingAttributes.go index 60b6e0c4416..d4e5d48b233 100644 --- a/service/sesv2/api_op_PutAccountSendingAttributes.go +++ b/service/sesv2/api_op_PutAccountSendingAttributes.go @@ -38,8 +38,8 @@ type PutAccountSendingAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountSendingAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutAccountSuppressionAttributes.go b/service/sesv2/api_op_PutAccountSuppressionAttributes.go index 96ecbe3b2d3..a9def719280 100644 --- a/service/sesv2/api_op_PutAccountSuppressionAttributes.go +++ b/service/sesv2/api_op_PutAccountSuppressionAttributes.go @@ -33,21 +33,17 @@ type PutAccountSuppressionAttributesInput struct { // A list that contains the reasons that email addresses will be automatically // added to the suppression list for your account. This list can contain any or all // of the following: - // - // * COMPLAINT – Amazon SES adds an email address to the - // suppression list for your account when a message sent to that address results in - // a complaint. - // - // * BOUNCE – Amazon SES adds an email address to the suppression - // list for your account when a message sent to that address results in a hard - // bounce. + // - COMPLAINT – Amazon SES adds an email address to the suppression list for + // your account when a message sent to that address results in a complaint. + // - BOUNCE – Amazon SES adds an email address to the suppression list for your + // account when a message sent to that address results in a hard bounce. SuppressedReasons []types.SuppressionListReason noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutAccountSuppressionAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutAccountVdmAttributes.go b/service/sesv2/api_op_PutAccountVdmAttributes.go index bd4d2966906..9a696385aa3 100644 --- a/service/sesv2/api_op_PutAccountVdmAttributes.go +++ b/service/sesv2/api_op_PutAccountVdmAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update your Amazon SES account VDM attributes. You can execute this operation no -// more than once per second. +// Update your Amazon SES account VDM attributes. You can execute this operation +// no more than once per second. func (c *Client) PutAccountVdmAttributes(ctx context.Context, params *PutAccountVdmAttributesInput, optFns ...func(*Options)) (*PutAccountVdmAttributesOutput, error) { if params == nil { params = &PutAccountVdmAttributesInput{} diff --git a/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go b/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go index 742a23ca9c7..e3af54d1c03 100644 --- a/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetDeliveryOptions.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate a configuration set with a dedicated IP pool. You can use dedicated IP -// pools to create groups of dedicated IP addresses for sending specific types of -// email. +// Associate a configuration set with a dedicated IP pool. You can use dedicated +// IP pools to create groups of dedicated IP addresses for sending specific types +// of email. func (c *Client) PutConfigurationSetDeliveryOptions(ctx context.Context, params *PutConfigurationSetDeliveryOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetDeliveryOptionsOutput, error) { if params == nil { params = &PutConfigurationSetDeliveryOptionsInput{} @@ -41,8 +41,8 @@ type PutConfigurationSetDeliveryOptionsInput struct { SendingPoolName *string // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). If the value is Require, messages are only - // delivered if a TLS connection can be established. If the value is Optional, + // Transport Layer Security (TLS). If the value is Require , messages are only + // delivered if a TLS connection can be established. If the value is Optional , // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy types.TlsPolicy @@ -50,8 +50,8 @@ type PutConfigurationSetDeliveryOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetDeliveryOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutConfigurationSetReputationOptions.go b/service/sesv2/api_op_PutConfigurationSetReputationOptions.go index af3c2cbc6bc..dba6e5e37a8 100644 --- a/service/sesv2/api_op_PutConfigurationSetReputationOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetReputationOptions.go @@ -36,15 +36,15 @@ type PutConfigurationSetReputationOptionsInput struct { // This member is required. ConfigurationSetName *string - // If true, tracking of reputation metrics is enabled for the configuration set. If - // false, tracking of reputation metrics is disabled for the configuration set. + // If true , tracking of reputation metrics is enabled for the configuration set. + // If false , tracking of reputation metrics is disabled for the configuration set. ReputationMetricsEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetReputationOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutConfigurationSetSendingOptions.go b/service/sesv2/api_op_PutConfigurationSetSendingOptions.go index 204dfb24660..d6d2a66dd99 100644 --- a/service/sesv2/api_op_PutConfigurationSetSendingOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetSendingOptions.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enable or disable email sending for messages that use a particular configuration -// set in a specific Amazon Web Services Region. +// Enable or disable email sending for messages that use a particular +// configuration set in a specific Amazon Web Services Region. func (c *Client) PutConfigurationSetSendingOptions(ctx context.Context, params *PutConfigurationSetSendingOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetSendingOptionsOutput, error) { if params == nil { params = &PutConfigurationSetSendingOptionsInput{} @@ -27,8 +27,8 @@ func (c *Client) PutConfigurationSetSendingOptions(ctx context.Context, params * return out, nil } -// A request to enable or disable the ability of Amazon SES to send emails that use -// a specific configuration set. +// A request to enable or disable the ability of Amazon SES to send emails that +// use a specific configuration set. type PutConfigurationSetSendingOptionsInput struct { // The name of the configuration set to enable or disable email sending for. @@ -36,15 +36,15 @@ type PutConfigurationSetSendingOptionsInput struct { // This member is required. ConfigurationSetName *string - // If true, email sending is enabled for the configuration set. If false, email + // If true , email sending is enabled for the configuration set. If false , email // sending is disabled for the configuration set. SendingEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetSendingOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go index 27706949359..b1d89162d61 100644 --- a/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go @@ -37,23 +37,20 @@ type PutConfigurationSetSuppressionOptionsInput struct { // This member is required. ConfigurationSetName *string - // A list that contains the reasons that email addresses are automatically added to - // the suppression list for your account. This list can contain any or all of the - // following: - // - // * COMPLAINT – Amazon SES adds an email address to the suppression - // list for your account when a message sent to that address results in a - // complaint. - // - // * BOUNCE – Amazon SES adds an email address to the suppression list - // for your account when a message sent to that address results in a hard bounce. + // A list that contains the reasons that email addresses are automatically added + // to the suppression list for your account. This list can contain any or all of + // the following: + // - COMPLAINT – Amazon SES adds an email address to the suppression list for + // your account when a message sent to that address results in a complaint. + // - BOUNCE – Amazon SES adds an email address to the suppression list for your + // account when a message sent to that address results in a hard bounce. SuppressedReasons []types.SuppressionListReason noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetSuppressionOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go b/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go index 2c6e71f2a5b..8b64a959cc9 100644 --- a/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetTrackingOptions.go @@ -42,8 +42,8 @@ type PutConfigurationSetTrackingOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetTrackingOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutConfigurationSetVdmOptions.go b/service/sesv2/api_op_PutConfigurationSetVdmOptions.go index 6b423744c1a..8cc6b03b07d 100644 --- a/service/sesv2/api_op_PutConfigurationSetVdmOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetVdmOptions.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Specify VDM preferences for email that you send using the configuration set. You -// can execute this operation no more than once per second. +// Specify VDM preferences for email that you send using the configuration set. +// You can execute this operation no more than once per second. func (c *Client) PutConfigurationSetVdmOptions(ctx context.Context, params *PutConfigurationSetVdmOptionsInput, optFns ...func(*Options)) (*PutConfigurationSetVdmOptionsOutput, error) { if params == nil { params = &PutConfigurationSetVdmOptionsInput{} @@ -42,8 +42,8 @@ type PutConfigurationSetVdmOptionsInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutConfigurationSetVdmOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutDedicatedIpInPool.go b/service/sesv2/api_op_PutDedicatedIpInPool.go index 2fd13229f4f..6a827331b20 100644 --- a/service/sesv2/api_op_PutDedicatedIpInPool.go +++ b/service/sesv2/api_op_PutDedicatedIpInPool.go @@ -48,8 +48,8 @@ type PutDedicatedIpInPoolInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutDedicatedIpInPoolOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutDedicatedIpWarmupAttributes.go b/service/sesv2/api_op_PutDedicatedIpWarmupAttributes.go index cc0f780071c..6541fab95d4 100644 --- a/service/sesv2/api_op_PutDedicatedIpWarmupAttributes.go +++ b/service/sesv2/api_op_PutDedicatedIpWarmupAttributes.go @@ -43,8 +43,8 @@ type PutDedicatedIpWarmupAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutDedicatedIpWarmupAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go index 7371b0c4cd2..1e1d352544b 100644 --- a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go +++ b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go @@ -18,8 +18,8 @@ import ( // Deliverability dashboard, you pay a monthly subscription charge, in addition to // any other fees that you accrue by using Amazon SES and other Amazon Web Services // services. For more information about the features and cost of a Deliverability -// dashboard subscription, see Amazon SES Pricing -// (http://aws.amazon.com/ses/pricing/). +// dashboard subscription, see Amazon SES Pricing (http://aws.amazon.com/ses/pricing/) +// . func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *PutDeliverabilityDashboardOptionInput, optFns ...func(*Options)) (*PutDeliverabilityDashboardOptionOutput, error) { if params == nil { params = &PutDeliverabilityDashboardOptionInput{} @@ -42,18 +42,18 @@ func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *P // you use the Deliverability dashboard, you pay a monthly subscription charge, in // addition to any other fees that you accrue by using Amazon SES and other Amazon // Web Services services. For more information about the features and cost of a -// Deliverability dashboard subscription, see Amazon Pinpoint Pricing -// (http://aws.amazon.com/pinpoint/pricing/). +// Deliverability dashboard subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/) +// . type PutDeliverabilityDashboardOptionInput struct { // Specifies whether to enable the Deliverability dashboard. To enable the - // dashboard, set this value to true. + // dashboard, set this value to true . // // This member is required. DashboardEnabled bool - // An array of objects, one for each verified domain that you use to send email and - // enabled the Deliverability dashboard for. + // An array of objects, one for each verified domain that you use to send email + // and enabled the Deliverability dashboard for. SubscribedDomains []types.DomainDeliverabilityTrackingOption noSmithyDocumentSerde diff --git a/service/sesv2/api_op_PutEmailIdentityConfigurationSetAttributes.go b/service/sesv2/api_op_PutEmailIdentityConfigurationSetAttributes.go index 8b5ec3426a7..34434bb39e0 100644 --- a/service/sesv2/api_op_PutEmailIdentityConfigurationSetAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityConfigurationSetAttributes.go @@ -40,8 +40,8 @@ type PutEmailIdentityConfigurationSetAttributesInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type PutEmailIdentityConfigurationSetAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go b/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go index 7f61c12cebe..9081ea32765 100644 --- a/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go @@ -26,8 +26,8 @@ func (c *Client) PutEmailIdentityDkimAttributes(ctx context.Context, params *Put return out, nil } -// A request to enable or disable DKIM signing of email that you send from an email -// identity. +// A request to enable or disable DKIM signing of email that you send from an +// email identity. type PutEmailIdentityDkimAttributesInput struct { // The email identity. @@ -36,15 +36,15 @@ type PutEmailIdentityDkimAttributesInput struct { EmailIdentity *string // Sets the DKIM signing configuration for the identity. When you set this value - // true, then the messages that are sent from the identity are signed using DKIM. - // If you set this value to false, your messages are sent without DKIM signing. + // true , then the messages that are sent from the identity are signed using DKIM. + // If you set this value to false , your messages are sent without DKIM signing. SigningEnabled bool noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityDkimAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go index 0092e7dcc16..47c33d46c45 100644 --- a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go @@ -11,25 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used to configure or change the DKIM authentication settings for an email domain -// identity. You can use this operation to do any of the following: -// -// * Update the -// signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM). -// -// * -// Update the key length that should be used for Easy DKIM. -// -// * Change from using no -// DKIM authentication to using Easy DKIM. -// -// * Change from using no DKIM -// authentication to using BYODKIM. -// -// * Change from using Easy DKIM to using -// BYODKIM. -// -// * Change from using BYODKIM to using Easy DKIM. +// Used to configure or change the DKIM authentication settings for an email +// domain identity. You can use this operation to do any of the following: +// - Update the signing attributes for an identity that uses Bring Your Own DKIM +// (BYODKIM). +// - Update the key length that should be used for Easy DKIM. +// - Change from using no DKIM authentication to using Easy DKIM. +// - Change from using no DKIM authentication to using BYODKIM. +// - Change from using Easy DKIM to using BYODKIM. +// - Change from using BYODKIM to using Easy DKIM. func (c *Client) PutEmailIdentityDkimSigningAttributes(ctx context.Context, params *PutEmailIdentityDkimSigningAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityDkimSigningAttributesOutput, error) { if params == nil { params = &PutEmailIdentityDkimSigningAttributesInput{} @@ -55,21 +45,18 @@ type PutEmailIdentityDkimSigningAttributesInput struct { // The method to use to configure DKIM for the identity. There are the following // possible values: - // - // * AWS_SES – Configure DKIM for the identity by using Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). - // - // * - // EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM - // (BYODKIM). + // - AWS_SES – Configure DKIM for the identity by using Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // . + // - EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM + // (BYODKIM). // // This member is required. SigningAttributesOrigin types.DkimSigningAttributesOrigin // An object that contains information about the private key and selector that you // want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) - // for the identity, or, configures the key length to be used for Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). + // for the identity, or, configures the key length to be used for Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // . SigningAttributes *types.DkimSigningAttributes noSmithyDocumentSerde @@ -81,42 +68,31 @@ type PutEmailIdentityDkimSigningAttributesOutput struct { // The DKIM authentication status of the identity. Amazon SES determines the // authentication status by searching for specific records in the DNS configuration - // for your domain. If you used Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to set up - // DKIM authentication, Amazon SES tries to find three unique CNAME records in the - // DNS configuration for your domain. If you provided a public key to perform DKIM - // authentication, Amazon SES tries to find a TXT record that uses the selector - // that you specified. The value of the TXT record must be a public key that's - // paired with the private key that you specified in the process of creating the - // identity. The status can be one of the following: - // - // * PENDING – The verification - // process was initiated, but Amazon SES hasn't yet detected the DKIM records in - // the DNS configuration for the domain. - // - // * SUCCESS – The verification process - // completed successfully. - // - // * FAILED – The verification process failed. This - // typically occurs when Amazon SES fails to find the DKIM records in the DNS - // configuration of the domain. - // - // * TEMPORARY_FAILURE – A temporary issue is - // preventing Amazon SES from determining the DKIM authentication status of the - // domain. - // - // * NOT_STARTED – The DKIM verification process hasn't been initiated for - // the domain. + // for your domain. If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // to set up DKIM authentication, Amazon SES tries to find three unique CNAME + // records in the DNS configuration for your domain. If you provided a public key + // to perform DKIM authentication, Amazon SES tries to find a TXT record that uses + // the selector that you specified. The value of the TXT record must be a public + // key that's paired with the private key that you specified in the process of + // creating the identity. The status can be one of the following: + // - PENDING – The verification process was initiated, but Amazon SES hasn't yet + // detected the DKIM records in the DNS configuration for the domain. + // - SUCCESS – The verification process completed successfully. + // - FAILED – The verification process failed. This typically occurs when Amazon + // SES fails to find the DKIM records in the DNS configuration of the domain. + // - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from + // determining the DKIM authentication status of the domain. + // - NOT_STARTED – The DKIM verification process hasn't been initiated for the + // domain. DkimStatus types.DkimStatus - // If you used Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to - // configure DKIM authentication for the domain, then this object contains a set of - // unique strings that you use to create a set of CNAME records that you add to the - // DNS configuration for your domain. When Amazon SES detects these records in the - // DNS configuration for your domain, the DKIM authentication process is complete. - // If you configured DKIM authentication for the domain by providing your own - // public-private key pair, then this object contains the selector that's + // If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // to configure DKIM authentication for the domain, then this object contains a set + // of unique strings that you use to create a set of CNAME records that you add to + // the DNS configuration for your domain. When Amazon SES detects these records in + // the DNS configuration for your domain, the DKIM authentication process is + // complete. If you configured DKIM authentication for the domain by providing your + // own public-private key pair, then this object contains the selector that's // associated with your public key. Regardless of the DKIM authentication method // you use, Amazon SES searches for the appropriate records in the DNS // configuration of the domain for up to 72 hours. diff --git a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go index cb214081c7d..2cdf1bc0fb0 100644 --- a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go @@ -12,13 +12,14 @@ import ( // Used to enable or disable feedback forwarding for an identity. This setting // determines what happens when an identity is used to send an email that results -// in a bounce or complaint event. If the value is true, you receive email +// in a bounce or complaint event. If the value is true , you receive email // notifications when bounce or complaint events occur. These notifications are -// sent to the address that you specified in the Return-Path header of the original -// email. You're required to have a method of tracking bounces and complaints. If -// you haven't set up another mechanism for receiving bounce or complaint -// notifications (for example, by setting up an event destination), you receive an -// email notification when these events occur (even if this setting is disabled). +// sent to the address that you specified in the Return-Path header of the +// original email. You're required to have a method of tracking bounces and +// complaints. If you haven't set up another mechanism for receiving bounce or +// complaint notifications (for example, by setting up an event destination), you +// receive an email notification when these events occur (even if this setting is +// disabled). func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params *PutEmailIdentityFeedbackAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityFeedbackAttributesOutput, error) { if params == nil { params = &PutEmailIdentityFeedbackAttributesInput{} @@ -34,8 +35,8 @@ func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params return out, nil } -// A request to set the attributes that control how bounce and complaint events are -// processed. +// A request to set the attributes that control how bounce and complaint events +// are processed. type PutEmailIdentityFeedbackAttributesInput struct { // The email identity. @@ -44,7 +45,7 @@ type PutEmailIdentityFeedbackAttributesInput struct { EmailIdentity *string // Sets the feedback forwarding configuration for the identity. If the value is - // true, you receive email notifications when bounce or complaint events occur. + // true , you receive email notifications when bounce or complaint events occur. // These notifications are sent to the address that you specified in the // Return-Path header of the original email. You're required to have a method of // tracking bounces and complaints. If you haven't set up another mechanism for @@ -56,8 +57,8 @@ type PutEmailIdentityFeedbackAttributesInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityFeedbackAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go b/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go index e9e3f6c7589..1fda31c8b83 100644 --- a/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used to enable or disable the custom Mail-From domain configuration for an email -// identity. +// Used to enable or disable the custom Mail-From domain configuration for an +// email identity. func (c *Client) PutEmailIdentityMailFromAttributes(ctx context.Context, params *PutEmailIdentityMailFromAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityMailFromAttributesOutput, error) { if params == nil { params = &PutEmailIdentityMailFromAttributesInput{} @@ -36,32 +36,28 @@ type PutEmailIdentityMailFromAttributesInput struct { // This member is required. EmailIdentity *string - // The action to take if the required MX record isn't found when you send an email. - // When you set this value to UseDefaultValue, the mail is sent using amazonses.com - // as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon - // SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to - // deliver the email. These behaviors are taken when the custom MAIL FROM domain - // configuration is in the Pending, Failed, and TemporaryFailure states. + // The action to take if the required MX record isn't found when you send an + // email. When you set this value to UseDefaultValue , the mail is sent using + // amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage + // , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't + // attempt to deliver the email. These behaviors are taken when the custom MAIL + // FROM domain configuration is in the Pending , Failed , and TemporaryFailure + // states. BehaviorOnMxFailure types.BehaviorOnMxFailure - // The custom MAIL FROM domain that you want the verified identity to use. The MAIL - // FROM domain must meet the following criteria: - // - // * It has to be a subdomain of the - // verified identity. - // - // * It can't be used to receive email. - // - // * It can't be used in - // a "From" address if the MAIL FROM domain is a destination for feedback - // forwarding emails. + // The custom MAIL FROM domain that you want the verified identity to use. The + // MAIL FROM domain must meet the following criteria: + // - It has to be a subdomain of the verified identity. + // - It can't be used to receive email. + // - It can't be used in a "From" address if the MAIL FROM domain is a + // destination for feedback forwarding emails. MailFromDomain *string noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutEmailIdentityMailFromAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_PutSuppressedDestination.go b/service/sesv2/api_op_PutSuppressedDestination.go index 3067e26cd2a..b877a9c1293 100644 --- a/service/sesv2/api_op_PutSuppressedDestination.go +++ b/service/sesv2/api_op_PutSuppressedDestination.go @@ -44,8 +44,8 @@ type PutSuppressedDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type PutSuppressedDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_SendBulkEmail.go b/service/sesv2/api_op_SendBulkEmail.go index 0fbb31ccbc6..112109eaa51 100644 --- a/service/sesv2/api_op_SendBulkEmail.go +++ b/service/sesv2/api_op_SendBulkEmail.go @@ -28,8 +28,8 @@ func (c *Client) SendBulkEmail(ctx context.Context, params *SendBulkEmailInput, } // Represents a request to send email messages to multiple destinations using -// Amazon SES. For more information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type SendBulkEmailInput struct { // The list of bulk email entry objects. @@ -63,8 +63,8 @@ type SendBulkEmailInput struct { // FeedbackForwardingEmailAddressIdentityArn to be // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the // FeedbackForwardingEmailAddress to be feedback@example.com. For more information - // about sending authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . FeedbackForwardingEmailAddressIdentityArn *string // The email address to use as the "From" address for the email. The address that @@ -80,8 +80,8 @@ type SendBulkEmailInput struct { // FromEmailAddressIdentityArn to be // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the // FromEmailAddress to be sender@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . FromEmailAddressIdentityArn *string // The "Reply-to" email addresses for the message. When the recipient replies to diff --git a/service/sesv2/api_op_SendCustomVerificationEmail.go b/service/sesv2/api_op_SendCustomVerificationEmail.go index 3e34509ffba..3cb38e99f59 100644 --- a/service/sesv2/api_op_SendCustomVerificationEmail.go +++ b/service/sesv2/api_op_SendCustomVerificationEmail.go @@ -16,8 +16,7 @@ import ( // specified address. To use this operation, you must first create a custom // verification email template. For more information about creating and using // custom verification email templates, see Using custom verification email -// templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) SendCustomVerificationEmail(ctx context.Context, params *SendCustomVerificationEmailInput, optFns ...func(*Options)) (*SendCustomVerificationEmailOutput, error) { diff --git a/service/sesv2/api_op_SendEmail.go b/service/sesv2/api_op_SendEmail.go index 5911d52e53c..c8d7f761d65 100644 --- a/service/sesv2/api_op_SendEmail.go +++ b/service/sesv2/api_op_SendEmail.go @@ -13,20 +13,16 @@ import ( // Sends an email message. You can use the Amazon SES API v2 to send the following // types of messages: -// -// * Simple – A standard email message. When you create this -// type of message, you specify the sender, the recipient, and the message body, -// and Amazon SES assembles the message for you. -// -// * Raw – A raw, MIME-formatted -// email message. When you send this type of email, you have to specify all of the -// message headers, as well as the message body. You can use this message type to -// send messages that contain attachments. The message that you specify has to be a -// valid MIME message. -// -// * Templated – A message that contains personalization tags. -// When you send this type of email, Amazon SES API v2 automatically replaces the -// tags with values that you specify. +// - Simple – A standard email message. When you create this type of message, +// you specify the sender, the recipient, and the message body, and Amazon SES +// assembles the message for you. +// - Raw – A raw, MIME-formatted email message. When you send this type of +// email, you have to specify all of the message headers, as well as the message +// body. You can use this message type to send messages that contain attachments. +// The message that you specify has to be a valid MIME message. +// - Templated – A message that contains personalization tags. When you send +// this type of email, Amazon SES API v2 automatically replaces the tags with +// values that you specify. func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns ...func(*Options)) (*SendEmailOutput, error) { if params == nil { params = &SendEmailInput{} @@ -42,9 +38,9 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . return out, nil } -// Represents a request to send a single formatted email using Amazon SES. For more -// information, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). +// Represents a request to send a single formatted email using Amazon SES. For +// more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html) +// . type SendEmailInput struct { // An object that contains the body of the message. You can send either a Simple @@ -76,8 +72,8 @@ type SendEmailInput struct { // FeedbackForwardingEmailAddressIdentityArn to be // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the // FeedbackForwardingEmailAddress to be feedback@example.com. For more information - // about sending authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). + // about sending authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . FeedbackForwardingEmailAddressIdentityArn *string // The email address to use as the "From" address for the email. The address that @@ -93,9 +89,8 @@ type SendEmailInput struct { // FromEmailAddressIdentityArn to be // arn:aws:ses:us-east-1:123456789012:identity/example.com, and the // FromEmailAddress to be sender@example.com. For more information about sending - // authorization, see the Amazon SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). - // For Raw emails, the FromEmailAddressIdentityArn value overrides the + // authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) + // . For Raw emails, the FromEmailAddressIdentityArn value overrides the // X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message // content. FromEmailAddressIdentityArn *string diff --git a/service/sesv2/api_op_TagResource.go b/service/sesv2/api_op_TagResource.go index 71b698e70fa..bacee1f037f 100644 --- a/service/sesv2/api_op_TagResource.go +++ b/service/sesv2/api_op_TagResource.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add one or more tags (keys and values) to a specified resource. A tag is a label -// that you optionally define and associate with a resource. Tags can help you -// categorize and manage resources in different ways, such as by purpose, owner, -// environment, or other criteria. A resource can have as many as 50 tags. Each tag -// consists of a required tag key and an associated tag value, both of which you -// define. A tag key is a general label that acts as a category for more specific -// tag values. A tag value acts as a descriptor within a tag key. +// Add one or more tags (keys and values) to a specified resource. A tag is a +// label that you optionally define and associate with a resource. Tags can help +// you categorize and manage resources in different ways, such as by purpose, +// owner, environment, or other criteria. A resource can have as many as 50 tags. +// Each tag consists of a required tag key and an associated tag value, both of +// which you define. A tag key is a general label that acts as a category for more +// specific tag values. A tag value acts as a descriptor within a tag key. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -42,8 +42,8 @@ type TagResourceInput struct { ResourceArn *string // A list of the tags that you want to add to the resource. A tag consists of a - // required tag key (Key) and an associated tag value (Value). The maximum length - // of a tag key is 128 characters. The maximum length of a tag value is 256 + // required tag key ( Key ) and an associated tag value ( Value ). The maximum + // length of a tag key is 128 characters. The maximum length of a tag value is 256 // characters. // // This member is required. diff --git a/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go b/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go index c88bc8102d3..c54fa568db8 100644 --- a/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the configuration of an event destination for a configuration set. Events -// include message sends, deliveries, opens, clicks, bounces, and complaints. Event -// destinations are places that you can send information about these events to. For -// example, you can send event data to Amazon SNS to receive notifications when you -// receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to -// stream data to Amazon S3 for long-term storage. +// Update the configuration of an event destination for a configuration set. +// Events include message sends, deliveries, opens, clicks, bounces, and +// complaints. Event destinations are places that you can send information about +// these events to. For example, you can send event data to Amazon SNS to receive +// notifications when you receive bounces or complaints, or you can use Amazon +// Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, params *UpdateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*UpdateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &UpdateConfigurationSetEventDestinationInput{} @@ -54,8 +54,8 @@ type UpdateConfigurationSetEventDestinationInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type UpdateConfigurationSetEventDestinationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go index 70586f510b1..80a0dcb75af 100644 --- a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go @@ -12,8 +12,7 @@ import ( // Updates an existing custom verification email template. For more information // about custom verification email templates, see Using custom verification email -// templates -// (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) +// templates (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom) // in the Amazon SES Developer Guide. You can execute this operation no more than // once per second. func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, params *UpdateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*UpdateCustomVerificationEmailTemplateOutput, error) { @@ -53,8 +52,7 @@ type UpdateCustomVerificationEmailTemplateInput struct { // The content of the custom verification email. The total size of the email must // be less than 10 MB. The message body may contain HTML, with some limitations. - // For more information, see Custom verification email frequently asked questions - // (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq) + // For more information, see Custom verification email frequently asked questions (https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq) // in the Amazon SES Developer Guide. // // This member is required. @@ -73,8 +71,8 @@ type UpdateCustomVerificationEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type UpdateCustomVerificationEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go index 5452abf9a8d..5531d7be7de 100644 --- a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go +++ b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go @@ -16,9 +16,8 @@ import ( // you have not verified the identity, this API will return an error. Sending // authorization is a feature that enables an identity owner to authorize other // senders to use its identities. For information about using sending -// authorization, see the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). -// You can execute this operation no more than once per second. +// authorization, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html) +// . You can execute this operation no more than once per second. func (c *Client) UpdateEmailIdentityPolicy(ctx context.Context, params *UpdateEmailIdentityPolicyInput, optFns ...func(*Options)) (*UpdateEmailIdentityPolicyOutput, error) { if params == nil { params = &UpdateEmailIdentityPolicyInput{} @@ -37,8 +36,8 @@ func (c *Client) UpdateEmailIdentityPolicy(ctx context.Context, params *UpdateEm // Represents a request to update a sending authorization policy for an identity. // Sending authorization is an Amazon SES feature that enables you to authorize // other senders to use your identities. For information, see the Amazon SES -// Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html). +// Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html) +// . type UpdateEmailIdentityPolicyInput struct { // The email identity. @@ -48,14 +47,14 @@ type UpdateEmailIdentityPolicyInput struct { // The text of the policy in JSON format. The policy cannot exceed 4 KB. For // information about the syntax of sending authorization policies, see the Amazon - // SES Developer Guide - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html). + // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html) + // . // // This member is required. Policy *string - // The name of the policy. The policy name cannot exceed 64 characters and can only - // include alphanumeric characters, dashes, and underscores. + // The name of the policy. The policy name cannot exceed 64 characters and can + // only include alphanumeric characters, dashes, and underscores. // // This member is required. PolicyName *string @@ -63,8 +62,8 @@ type UpdateEmailIdentityPolicyInput struct { noSmithyDocumentSerde } -// An HTTP 200 response if the request succeeds, or an error message if the request -// fails. +// An HTTP 200 response if the request succeeds, or an error message if the +// request fails. type UpdateEmailIdentityPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/api_op_UpdateEmailTemplate.go b/service/sesv2/api_op_UpdateEmailTemplate.go index 3076894c173..52f06f942fe 100644 --- a/service/sesv2/api_op_UpdateEmailTemplate.go +++ b/service/sesv2/api_op_UpdateEmailTemplate.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an email template. Email templates enable you to send personalized email -// to one or more destinations in a single API operation. For more information, see -// the Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). -// You can execute this operation no more than once per second. +// Updates an email template. Email templates enable you to send personalized +// email to one or more destinations in a single API operation. For more +// information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . You can execute this operation no more than once per second. func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTemplateInput, optFns ...func(*Options)) (*UpdateEmailTemplateOutput, error) { if params == nil { params = &UpdateEmailTemplateInput{} @@ -32,12 +31,12 @@ func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTem } // Represents a request to update an email template. For more information, see the -// Amazon SES Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). +// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) +// . type UpdateEmailTemplateInput struct { - // The content of the email template, composed of a subject line, an HTML part, and - // a text-only part. + // The content of the email template, composed of a subject line, an HTML part, + // and a text-only part. // // This member is required. TemplateContent *types.EmailTemplateContent @@ -50,8 +49,8 @@ type UpdateEmailTemplateInput struct { noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response with an -// empty HTTP body. +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. type UpdateEmailTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/sesv2/doc.go b/service/sesv2/doc.go index 6d7bcca5a88..bded1d8b0a0 100644 --- a/service/sesv2/doc.go +++ b/service/sesv2/doc.go @@ -6,8 +6,7 @@ // Amazon SES API v2 Amazon SES (http://aws.amazon.com/ses) is an Amazon Web // Services service that you can use to send email messages to your customers. If // you're new to Amazon SES API v2, you might find it helpful to review the Amazon -// Simple Email Service Developer Guide -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). The Amazon SES -// Developer Guide provides information and code samples that demonstrate how to -// use Amazon SES API v2 features programmatically. +// Simple Email Service Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/) +// . The Amazon SES Developer Guide provides information and code samples that +// demonstrate how to use Amazon SES API v2 features programmatically. package sesv2 diff --git a/service/sesv2/types/enums.go b/service/sesv2/types/enums.go index d1c7760deae..365ae732bbc 100644 --- a/service/sesv2/types/enums.go +++ b/service/sesv2/types/enums.go @@ -145,9 +145,9 @@ const ( DeliverabilityTestStatusCompleted DeliverabilityTestStatus = "COMPLETED" ) -// Values returns all known values for DeliverabilityTestStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeliverabilityTestStatus. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliverabilityTestStatus) Values() []DeliverabilityTestStatus { return []DeliverabilityTestStatus{ "IN_PROGRESS", @@ -251,9 +251,9 @@ const ( EventTypeSubscription EventType = "SUBSCRIPTION" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "SEND", @@ -296,9 +296,9 @@ const ( IdentityTypeManagedDomain IdentityType = "MANAGED_DOMAIN" ) -// Values returns all known values for IdentityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for IdentityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (IdentityType) Values() []IdentityType { return []IdentityType{ "EMAIL_ADDRESS", @@ -315,8 +315,8 @@ const ( ImportDestinationTypeContactList ImportDestinationType = "CONTACT_LIST" ) -// Values returns all known values for ImportDestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ImportDestinationType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ImportDestinationType) Values() []ImportDestinationType { return []ImportDestinationType{ @@ -335,9 +335,9 @@ const ( JobStatusFailed JobStatus = "FAILED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "CREATED", @@ -357,9 +357,10 @@ const ( ListRecommendationsFilterKeyResourceArn ListRecommendationsFilterKey = "RESOURCE_ARN" ) -// Values returns all known values for ListRecommendationsFilterKey. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ListRecommendationsFilterKey. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (ListRecommendationsFilterKey) Values() []ListRecommendationsFilterKey { return []ListRecommendationsFilterKey{ "TYPE", @@ -565,9 +566,9 @@ const ( ReviewStatusDenied ReviewStatus = "DENIED" ) -// Values returns all known values for ReviewStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReviewStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReviewStatus) Values() []ReviewStatus { return []ReviewStatus{ "PENDING", @@ -639,8 +640,8 @@ const ( SuppressionListReasonComplaint SuppressionListReason = "COMPLAINT" ) -// Values returns all known values for SuppressionListReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for SuppressionListReason. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (SuppressionListReason) Values() []SuppressionListReason { return []SuppressionListReason{ @@ -657,9 +658,9 @@ const ( TlsPolicyOptional TlsPolicy = "OPTIONAL" ) -// Values returns all known values for TlsPolicy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TlsPolicy. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TlsPolicy) Values() []TlsPolicy { return []TlsPolicy{ "REQUIRE", @@ -699,9 +700,9 @@ const ( WarmupStatusDone WarmupStatus = "DONE" ) -// Values returns all known values for WarmupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for WarmupStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (WarmupStatus) Values() []WarmupStatus { return []WarmupStatus{ "IN_PROGRESS", diff --git a/service/sesv2/types/types.go b/service/sesv2/types/types.go index bbdd39aa24c..530c239fa37 100644 --- a/service/sesv2/types/types.go +++ b/service/sesv2/types/types.go @@ -15,17 +15,15 @@ type AccountDetails struct { AdditionalContactEmailAddresses []string // The language you would prefer for the case. The contact language can be one of - // ENGLISH or JAPANESE. + // ENGLISH or JAPANESE . ContactLanguage ContactLanguage // The type of email your account is sending. The mail type can be one of the // following: - // - // * MARKETING – Most of your sending traffic is to keep your customers - // informed of your latest offering. - // - // * TRANSACTIONAL – Most of your sending - // traffic is to communicate during a transaction with a customer. + // - MARKETING – Most of your sending traffic is to keep your customers informed + // of your latest offering. + // - TRANSACTIONAL – Most of your sending traffic is to communicate during a + // transaction with a customer. MailType MailType // Information about the review of the latest details you submitted. @@ -34,8 +32,8 @@ type AccountDetails struct { // A description of the types of email that you plan to send. UseCaseDescription *string - // The URL of your website. This information helps us better understand the type of - // content that you plan to send. + // The URL of your website. This information helps us better understand the type + // of content that you plan to send. WebsiteURL *string noSmithyDocumentSerde @@ -55,52 +53,37 @@ type BatchGetMetricDataQuery struct { Id *string // The queried metric. This can be one of the following: - // - // * SEND – Emails sent - // eligible for tracking in the VDM dashboard. This excludes emails sent to the - // mailbox simulator and emails addressed to more than one recipient. - // - // * COMPLAINT - // – Complaints received for your account. This excludes complaints from the - // mailbox simulator, those originating from your account-level suppression list - // (if enabled), and those for emails addressed to more than one recipient - // - // * - // PERMANENT_BOUNCE – Permanent bounces - i.e. feedback received for emails sent to - // non-existent mailboxes. Excludes bounces from the mailbox simulator, those - // originating from your account-level suppression list (if enabled), and those for - // emails addressed to more than one recipient. - // - // * TRANSIENT_BOUNCE – Transient - // bounces - i.e. feedback received for delivery failures excluding issues with - // non-existent mailboxes. Excludes bounces from the mailbox simulator, and those - // for emails addressed to more than one recipient. - // - // * OPEN – Unique open events - // for emails including open trackers. Excludes opens for emails addressed to more - // than one recipient. - // - // * CLICK – Unique click events for emails including wrapped - // links. Excludes clicks for emails addressed to more than one recipient. - // - // * - // DELIVERY – Successful deliveries for email sending attempts. Excludes deliveries - // to the mailbox simulator and for emails addressed to more than one recipient. - // - // * - // DELIVERY_OPEN – Successful deliveries for email sending attempts. Excludes - // deliveries to the mailbox simulator, for emails addressed to more than one - // recipient, and emails without open trackers. - // - // * DELIVERY_CLICK – Successful - // deliveries for email sending attempts. Excludes deliveries to the mailbox - // simulator, for emails addressed to more than one recipient, and emails without - // click trackers. - // - // * DELIVERY_COMPLAINT – Successful deliveries for email sending - // attempts. Excludes deliveries to the mailbox simulator, for emails addressed to - // more than one recipient, and emails addressed to recipients hosted by ISPs with - // which Amazon SES does not have a feedback loop agreement. + // - SEND – Emails sent eligible for tracking in the VDM dashboard. This excludes + // emails sent to the mailbox simulator and emails addressed to more than one + // recipient. + // - COMPLAINT – Complaints received for your account. This excludes complaints + // from the mailbox simulator, those originating from your account-level + // suppression list (if enabled), and those for emails addressed to more than one + // recipient + // - PERMANENT_BOUNCE – Permanent bounces - i.e. feedback received for emails + // sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, + // those originating from your account-level suppression list (if enabled), and + // those for emails addressed to more than one recipient. + // - TRANSIENT_BOUNCE – Transient bounces - i.e. feedback received for delivery + // failures excluding issues with non-existent mailboxes. Excludes bounces from the + // mailbox simulator, and those for emails addressed to more than one recipient. + // - OPEN – Unique open events for emails including open trackers. Excludes opens + // for emails addressed to more than one recipient. + // - CLICK – Unique click events for emails including wrapped links. Excludes + // clicks for emails addressed to more than one recipient. + // - DELIVERY – Successful deliveries for email sending attempts. Excludes + // deliveries to the mailbox simulator and for emails addressed to more than one + // recipient. + // - DELIVERY_OPEN – Successful deliveries for email sending attempts. Excludes + // deliveries to the mailbox simulator, for emails addressed to more than one + // recipient, and emails without open trackers. + // - DELIVERY_CLICK – Successful deliveries for email sending attempts. Excludes + // deliveries to the mailbox simulator, for emails addressed to more than one + // recipient, and emails without click trackers. + // - DELIVERY_COMPLAINT – Successful deliveries for email sending attempts. + // Excludes deliveries to the mailbox simulator, for emails addressed to more than + // one recipient, and emails addressed to recipients hosted by ISPs with which + // Amazon SES does not have a feedback loop agreement. // // This member is required. Metric Metric @@ -169,18 +152,17 @@ type BulkEmailEntry struct { // Represents the destination of the message, consisting of To:, CC:, and BCC: // fields. Amazon SES does not support the SMTPUTF8 extension, as described in - // RFC6531 (https://tools.ietf.org/html/rfc6531). For this reason, the local part + // RFC6531 (https://tools.ietf.org/html/rfc6531) . For this reason, the local part // of a destination email address (the part of the email address that precedes the - // @ sign) may only contain 7-bit ASCII characters - // (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of - // an address (the part after the @ sign) contains non-ASCII characters, they must - // be encoded using Punycode, as described in RFC3492 - // (https://tools.ietf.org/html/rfc3492.html). + // @ sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part) + // . If the domain part of an address (the part after the @ sign) contains + // non-ASCII characters, they must be encoded using Punycode, as described in + // RFC3492 (https://tools.ietf.org/html/rfc3492.html) . // // This member is required. Destination *Destination - // The ReplacementEmailContent associated with a BulkEmailEntry. + // The ReplacementEmailContent associated with a BulkEmailEntry . ReplacementEmailContent *ReplacementEmailContent // A list of tags, in the form of name/value pairs, to apply to an email that you @@ -192,7 +174,7 @@ type BulkEmailEntry struct { noSmithyDocumentSerde } -// The result of the SendBulkEmail operation of each specified BulkEmailEntry. +// The result of the SendBulkEmail operation of each specified BulkEmailEntry . type BulkEmailEntryResult struct { // A description of an error that prevented a message being sent using the @@ -205,57 +187,35 @@ type BulkEmailEntryResult struct { // The status of a message sent using the SendBulkTemplatedEmail operation. // Possible values for this parameter include: - // - // * SUCCESS: Amazon SES accepted the - // message, and will attempt to deliver it to the recipients. - // - // * MESSAGE_REJECTED: - // The message was rejected because it contained a virus. - // - // * - // MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not - // verified. - // - // * CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you - // specified does not exist. - // - // * TEMPLATE_DOES_NOT_EXIST: The template you specified - // does not exist. - // - // * ACCOUNT_SUSPENDED: Your account has been shut down because of - // issues related to your email sending practices. - // - // * ACCOUNT_THROTTLED: The number - // of emails you can send has been reduced because your account has exceeded its - // allocated sending limit. - // - // * ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or - // exceeded the maximum number of emails you can send from your account in a - // 24-hour period. - // - // * INVALID_SENDING_POOL_NAME: The configuration set you - // specified refers to an IP pool that does not exist. - // - // * ACCOUNT_SENDING_PAUSED: - // Email sending for the Amazon SES account was disabled using the - // UpdateAccountSendingEnabled - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html) - // operation. - // - // * CONFIGURATION_SET_SENDING_PAUSED: Email sending for this - // configuration set was disabled using the UpdateConfigurationSetSendingEnabled - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html) - // operation. - // - // * INVALID_PARAMETER_VALUE: One or more of the parameters you - // specified when calling this operation was invalid. See the error message for - // additional information. - // - // * TRANSIENT_FAILURE: Amazon SES was unable to process - // your request because of a temporary issue. - // - // * FAILED: Amazon SES was unable to - // process your request. See the error message for additional information. + // - SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to + // the recipients. + // - MESSAGE_REJECTED: The message was rejected because it contained a virus. + // - MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not + // verified. + // - CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does + // not exist. + // - TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist. + // - ACCOUNT_SUSPENDED: Your account has been shut down because of issues + // related to your email sending practices. + // - ACCOUNT_THROTTLED: The number of emails you can send has been reduced + // because your account has exceeded its allocated sending limit. + // - ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum + // number of emails you can send from your account in a 24-hour period. + // - INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an + // IP pool that does not exist. + // - ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was + // disabled using the UpdateAccountSendingEnabled (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html) + // operation. + // - CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set + // was disabled using the UpdateConfigurationSetSendingEnabled (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html) + // operation. + // - INVALID_PARAMETER_VALUE: One or more of the parameters you specified when + // calling this operation was invalid. See the error message for additional + // information. + // - TRANSIENT_FAILURE: Amazon SES was unable to process your request because of + // a temporary issue. + // - FAILED: Amazon SES was unable to process your request. See the error + // message for additional information. Status BulkEmailStatus noSmithyDocumentSerde @@ -266,8 +226,8 @@ type BulkEmailEntryResult struct { // metrics. type CloudWatchDestination struct { - // An array of objects that define the dimensions to use when you send email events - // to Amazon CloudWatch. + // An array of objects that define the dimensions to use when you send email + // events to Amazon CloudWatch. // // This member is required. DimensionConfigurations []CloudWatchDimensionConfiguration @@ -279,27 +239,21 @@ type CloudWatchDestination struct { // events to Amazon CloudWatch. type CloudWatchDimensionConfiguration struct { - // The default value of the dimension that is published to Amazon CloudWatch if you - // don't provide the value of the dimension when you send an email. This value has - // to meet the following criteria: - // - // * Can only contain ASCII letters (a–z, A–Z), - // numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.). - // - // * - // It can contain no more than 256 characters. + // The default value of the dimension that is published to Amazon CloudWatch if + // you don't provide the value of the dimension when you send an email. This value + // has to meet the following criteria: + // - Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), + // or dashes (-), at signs (@), and periods (.). + // - It can contain no more than 256 characters. // // This member is required. DefaultDimensionValue *string // The name of an Amazon CloudWatch dimension associated with an email sending // metric. The name has to meet the following criteria: - // - // * It can only contain - // ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). - // - // * It - // can contain no more than 256 characters. + // - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. DimensionName *string @@ -307,8 +261,8 @@ type CloudWatchDimensionConfiguration struct { // The location where the Amazon SES API v2 finds the value of a dimension to // publish to Amazon CloudWatch. To use the message tags that you specify using an // X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, - // choose messageTag. To use your own email headers, choose emailHeader. To use - // link tags, choose linkTags. + // choose messageTag . To use your own email headers, choose emailHeader . To use + // link tags, choose linkTags . // // This member is required. DimensionValueSource DimensionValueSource @@ -356,12 +310,9 @@ type ContactListDestination struct { // >The type of action to perform on the addresses. The following are the possible // values: - // - // * PUT: add the addresses to the contact list. If the record already - // exists, it will override it with the new value. - // - // * DELETE: remove the addresses - // from the contact list. + // - PUT: add the addresses to the contact list. If the record already exists, + // it will override it with the new value. + // - DELETE: remove the addresses from the contact list. // // This member is required. ContactListImportAction ContactListImportAction @@ -386,7 +337,7 @@ type Content struct { // The character set for the content. Because of the constraints of the SMTP // protocol, Amazon SES uses 7-bit ASCII by default. If the text includes // characters outside of the ASCII range, you have to specify a character set. For - // example, you could specify UTF-8, ISO-8859-1, or Shift_JIS. + // example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS . Charset *string noSmithyDocumentSerde @@ -439,11 +390,8 @@ type DashboardAttributes struct { // Specifies the status of your VDM engagement metrics collection. Can be one of // the following: - // - // * ENABLED – Amazon SES enables engagement metrics for your - // account. - // - // * DISABLED – Amazon SES disables engagement metrics for your account. + // - ENABLED – Amazon SES enables engagement metrics for your account. + // - DISABLED – Amazon SES disables engagement metrics for your account. EngagementMetrics FeatureStatus noSmithyDocumentSerde @@ -455,12 +403,8 @@ type DashboardOptions struct { // Specifies the status of your VDM engagement metrics collection. Can be one of // the following: - // - // * ENABLED – Amazon SES enables engagement metrics for the - // configuration set. - // - // * DISABLED – Amazon SES disables engagement metrics for the - // configuration set. + // - ENABLED – Amazon SES enables engagement metrics for the configuration set. + // - DISABLED – Amazon SES disables engagement metrics for the configuration set. EngagementMetrics FeatureStatus noSmithyDocumentSerde @@ -468,8 +412,7 @@ type DashboardOptions struct { // Contains information about a dedicated IP address that is associated with your // Amazon SES account. To learn more about requesting dedicated IP addresses, see -// Requesting and Relinquishing Dedicated IP Addresses -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html) +// Requesting and Relinquishing Dedicated IP Addresses (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html) // in the Amazon SES Developer Guide. type DedicatedIp struct { @@ -486,12 +429,10 @@ type DedicatedIp struct { // The warm-up status of a dedicated IP address. The status can have one of the // following values: - // - // * IN_PROGRESS – The IP address isn't ready to use because the - // dedicated IP warm-up process is ongoing. - // - // * DONE – The dedicated IP warm-up - // process is complete, and the IP address is ready to use. + // - IN_PROGRESS – The IP address isn't ready to use because the dedicated IP + // warm-up process is ongoing. + // - DONE – The dedicated IP warm-up process is complete, and the IP address is + // ready to use. // // This member is required. WarmupStatus WarmupStatus @@ -511,13 +452,10 @@ type DedicatedIpPool struct { PoolName *string // The type of the dedicated IP pool. - // - // * STANDARD – A dedicated IP pool where the - // customer can control which IPs are part of the pool. - // - // * MANAGED – A dedicated IP - // pool where the reputation and number of IPs is automatically managed by Amazon - // SES. + // - STANDARD – A dedicated IP pool where the customer can control which IPs are + // part of the pool. + // - MANAGED – A dedicated IP pool where the reputation and number of IPs is + // automatically managed by Amazon SES. // // This member is required. ScalingMode ScalingMode @@ -531,10 +469,10 @@ type DeliverabilityTestReport struct { // The date and time when the predictive inbox placement test was created. CreateDate *time.Time - // The status of the predictive inbox placement test. If the status is IN_PROGRESS, - // then the predictive inbox placement test is currently running. Predictive inbox - // placement tests are usually complete within 24 hours of creating the test. If - // the status is COMPLETE, then the test is finished, and you can use the + // The status of the predictive inbox placement test. If the status is IN_PROGRESS + // , then the predictive inbox placement test is currently running. Predictive + // inbox placement tests are usually complete within 24 hours of creating the test. + // If the status is COMPLETE , then the test is finished, and you can use the // GetDeliverabilityTestReport to view the results of the test. DeliverabilityTestStatus DeliverabilityTestStatus @@ -547,8 +485,8 @@ type DeliverabilityTestReport struct { // A name that helps you identify a predictive inbox placement test report. ReportName *string - // The subject line for an email that you submitted in a predictive inbox placement - // test. + // The subject line for an email that you submitted in a predictive inbox + // placement test. Subject *string noSmithyDocumentSerde @@ -561,8 +499,8 @@ type DeliveryOptions struct { SendingPoolName *string // Specifies whether messages that use the configuration set are required to use - // Transport Layer Security (TLS). If the value is Require, messages are only - // delivered if a TLS connection can be established. If the value is Optional, + // Transport Layer Security (TLS). If the value is Require , messages are only + // delivered if a TLS connection can be established. If the value is Optional , // messages can be delivered in plain text if a TLS connection can't be // established. TlsPolicy TlsPolicy @@ -571,14 +509,13 @@ type DeliveryOptions struct { } // An object that describes the recipients for an email. Amazon SES does not -// support the SMTPUTF8 extension, as described in RFC6531 -// (https://tools.ietf.org/html/rfc6531). For this reason, the local part of a -// destination email address (the part of the email address that precedes the @ -// sign) may only contain 7-bit ASCII characters -// (https://en.wikipedia.org/wiki/Email_address#Local-part). If the domain part of -// an address (the part after the @ sign) contains non-ASCII characters, they must -// be encoded using Punycode, as described in RFC3492 -// (https://tools.ietf.org/html/rfc3492.html). +// support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/rfc6531) +// . For this reason, the local part of a destination email address (the part of +// the email address that precedes the @ sign) may only contain 7-bit ASCII +// characters (https://en.wikipedia.org/wiki/Email_address#Local-part) . If the +// domain part of an address (the part after the @ sign) contains non-ASCII +// characters, they must be encoded using Punycode, as described in RFC3492 (https://tools.ietf.org/html/rfc3492.html) +// . type Destination struct { // An array that contains the email addresses of the "BCC" (blind carbon copy) @@ -597,14 +534,13 @@ type Destination struct { // An object that contains information about the DKIM authentication status for an // email identity. Amazon SES determines the authentication status by searching for -// specific records in the DNS configuration for the domain. If you used Easy DKIM -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to set up -// DKIM authentication, Amazon SES tries to find three unique CNAME records in the -// DNS configuration for your domain. If you provided a public key to perform DKIM -// authentication, Amazon SES tries to find a TXT record that uses the selector -// that you specified. The value of the TXT record must be a public key that's -// paired with the private key that you specified in the process of creating the -// identity +// specific records in the DNS configuration for the domain. If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) +// to set up DKIM authentication, Amazon SES tries to find three unique CNAME +// records in the DNS configuration for your domain. If you provided a public key +// to perform DKIM authentication, Amazon SES tries to find a TXT record that uses +// the selector that you specified. The value of the TXT record must be a public +// key that's paired with the private key that you specified in the process of +// creating the identity type DkimAttributes struct { // [Easy DKIM] The key length of the DKIM key pair in use. @@ -613,67 +549,53 @@ type DkimAttributes struct { // [Easy DKIM] The last time a key pair was generated for this identity. LastKeyGenerationTimestamp *time.Time - // [Easy DKIM] The key length of the future DKIM key pair to be generated. This can - // be changed at most once per day. + // [Easy DKIM] The key length of the future DKIM key pair to be generated. This + // can be changed at most once per day. NextSigningKeyLength DkimSigningKeyLength // A string that indicates how DKIM was configured for the identity. These are the // possible values: - // - // * AWS_SES – Indicates that DKIM was configured for the - // identity by using Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). - // - // * - // EXTERNAL – Indicates that DKIM was configured for the identity by using Bring - // Your Own DKIM (BYODKIM). + // - AWS_SES – Indicates that DKIM was configured for the identity by using Easy + // DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) . + // - EXTERNAL – Indicates that DKIM was configured for the identity by using + // Bring Your Own DKIM (BYODKIM). SigningAttributesOrigin DkimSigningAttributesOrigin - // If the value is true, then the messages that you send from the identity are - // signed using DKIM. If the value is false, then the messages that you send from + // If the value is true , then the messages that you send from the identity are + // signed using DKIM. If the value is false , then the messages that you send from // the identity aren't DKIM-signed. SigningEnabled bool - // Describes whether or not Amazon SES has successfully located the DKIM records in - // the DNS records for the domain. The status can be one of the following: - // - // * - // PENDING – The verification process was initiated, but Amazon SES hasn't yet - // detected the DKIM records in the DNS configuration for the domain. - // - // * SUCCESS – - // The verification process completed successfully. - // - // * FAILED – The verification - // process failed. This typically occurs when Amazon SES fails to find the DKIM - // records in the DNS configuration of the domain. - // - // * TEMPORARY_FAILURE – A - // temporary issue is preventing Amazon SES from determining the DKIM - // authentication status of the domain. - // - // * NOT_STARTED – The DKIM verification - // process hasn't been initiated for the domain. + // Describes whether or not Amazon SES has successfully located the DKIM records + // in the DNS records for the domain. The status can be one of the following: + // - PENDING – The verification process was initiated, but Amazon SES hasn't yet + // detected the DKIM records in the DNS configuration for the domain. + // - SUCCESS – The verification process completed successfully. + // - FAILED – The verification process failed. This typically occurs when Amazon + // SES fails to find the DKIM records in the DNS configuration of the domain. + // - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from + // determining the DKIM authentication status of the domain. + // - NOT_STARTED – The DKIM verification process hasn't been initiated for the + // domain. Status DkimStatus - // If you used Easy DKIM - // (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to - // configure DKIM authentication for the domain, then this object contains a set of - // unique strings that you use to create a set of CNAME records that you add to the - // DNS configuration for your domain. When Amazon SES detects these records in the - // DNS configuration for your domain, the DKIM authentication process is complete. - // If you configured DKIM authentication for the domain by providing your own - // public-private key pair, then this object contains the selector for the public - // key. Regardless of the DKIM authentication method you use, Amazon SES searches - // for the appropriate records in the DNS configuration of the domain for up to 72 - // hours. + // If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) + // to configure DKIM authentication for the domain, then this object contains a set + // of unique strings that you use to create a set of CNAME records that you add to + // the DNS configuration for your domain. When Amazon SES detects these records in + // the DNS configuration for your domain, the DKIM authentication process is + // complete. If you configured DKIM authentication for the domain by providing your + // own public-private key pair, then this object contains the selector for the + // public key. Regardless of the DKIM authentication method you use, Amazon SES + // searches for the appropriate records in the DNS configuration of the domain for + // up to 72 hours. Tokens []string noSmithyDocumentSerde } -// An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for -// Easy DKIM +// An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, +// for Easy DKIM type DkimSigningAttributes struct { // [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. @@ -685,8 +607,8 @@ type DkimSigningAttributes struct { // configuration for a domain. DomainSigningSelector *string - // [Easy DKIM] The key length of the future DKIM key pair to be generated. This can - // be changed at most once per day. + // [Easy DKIM] The key length of the future DKIM key pair to be generated. This + // can be changed at most once per day. NextSigningKeyLength DkimSigningKeyLength noSmithyDocumentSerde @@ -694,8 +616,8 @@ type DkimSigningAttributes struct { // An object that contains the deliverability data for a specific campaign. This // data is available for a campaign only if the campaign sent email by using a -// domain that the Deliverability dashboard is enabled for -// (PutDeliverabilityDashboardOption operation). +// domain that the Deliverability dashboard is enabled for ( +// PutDeliverabilityDashboardOption operation). type DomainDeliverabilityCampaign struct { // The unique identifier for the campaign. The Deliverability dashboard @@ -810,30 +732,19 @@ type DomainIspPlacement struct { type EmailContent struct { // The raw email message. The message has to meet the following criteria: - // - // * The - // message has to contain a header and a body, separated by one blank line. - // - // * All - // of the required header fields must be present in the message. - // - // * Each part of a - // multipart MIME message must be formatted properly. - // - // * If you include - // attachments, they must be in a file format that the Amazon SES API v2 - // supports. - // - // * The entire message must be Base64 encoded. - // - // * If any of the MIME - // parts in your message contain content that is outside of the 7-bit ASCII - // character range, you should encode that content to ensure that recipients' email - // clients render the message properly. - // - // * The length of any single line of text in - // the message can't exceed 1,000 characters. This restriction is defined in RFC - // 5321 (https://tools.ietf.org/html/rfc5321). + // - The message has to contain a header and a body, separated by one blank + // line. + // - All of the required header fields must be present in the message. + // - Each part of a multipart MIME message must be formatted properly. + // - If you include attachments, they must be in a file format that the Amazon + // SES API v2 supports. + // - The entire message must be Base64 encoded. + // - If any of the MIME parts in your message contain content that is outside of + // the 7-bit ASCII character range, you should encode that content to ensure that + // recipients' email clients render the message properly. + // - The length of any single line of text in the message can't exceed 1,000 + // characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321) + // . Raw *RawMessage // The simple email message. The message consists of a subject and a message body. @@ -882,53 +793,36 @@ type EmailTemplateMetadata struct { // S3 for long-term storage. type EventDestination struct { - // The types of events that Amazon SES sends to the specified event - // destinations. - // - // * SEND - The send request was successful and SES will attempt to - // deliver the message to the recipient’s mail server. (If account-level or global - // suppression is being used, SES will still count it as a send, but delivery is - // suppressed.) - // - // * REJECT - SES accepted the email, but determined that it - // contained a virus and didn’t attempt to deliver it to the recipient’s mail - // server. - // - // * BOUNCE - (Hard bounce) The recipient's mail server permanently - // rejected the email. (Soft bounces are only included when SES fails to deliver - // the email after retrying for a period of time.) - // - // * COMPLAINT - The email was - // successfully delivered to the recipient’s mail server, but the recipient marked - // it as spam. - // - // * DELIVERY - SES successfully delivered the email to the - // recipient's mail server. - // - // * OPEN - The recipient received the message and opened - // it in their email client. - // - // * CLICK - The recipient clicked one or more links in - // the email. - // - // * RENDERING_FAILURE - The email wasn't sent because of a template - // rendering issue. This event type can occur when template data is missing, or - // when there is a mismatch between template parameters and data. (This event type - // only occurs when you send email using the SendTemplatedEmail - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html) - // or SendBulkTemplatedEmail - // (https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html) - // API operations.) - // - // * DELIVERY_DELAY - The email couldn't be delivered to the - // recipient’s mail server because a temporary issue occurred. Delivery delays can - // occur, for example, when the recipient's inbox is full, or when the receiving - // email server experiences a transient issue. - // - // * SUBSCRIPTION - The email was - // successfully delivered, but the recipient updated their subscription preferences - // by clicking on an unsubscribe link as part of your subscription management - // (https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html). + // The types of events that Amazon SES sends to the specified event destinations. + // - SEND - The send request was successful and SES will attempt to deliver the + // message to the recipient’s mail server. (If account-level or global suppression + // is being used, SES will still count it as a send, but delivery is suppressed.) + // - REJECT - SES accepted the email, but determined that it contained a virus + // and didn’t attempt to deliver it to the recipient’s mail server. + // - BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the + // email. (Soft bounces are only included when SES fails to deliver the email after + // retrying for a period of time.) + // - COMPLAINT - The email was successfully delivered to the recipient’s mail + // server, but the recipient marked it as spam. + // - DELIVERY - SES successfully delivered the email to the recipient's mail + // server. + // - OPEN - The recipient received the message and opened it in their email + // client. + // - CLICK - The recipient clicked one or more links in the email. + // - RENDERING_FAILURE - The email wasn't sent because of a template rendering + // issue. This event type can occur when template data is missing, or when there is + // a mismatch between template parameters and data. (This event type only occurs + // when you send email using the SendTemplatedEmail (https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html) + // or SendBulkTemplatedEmail (https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html) + // API operations.) + // - DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail + // server because a temporary issue occurred. Delivery delays can occur, for + // example, when the recipient's inbox is full, or when the receiving email server + // experiences a transient issue. + // - SUBSCRIPTION - The email was successfully delivered, but the recipient + // updated their subscription preferences by clicking on an unsubscribe link as + // part of your subscription management (https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html) + // . // // This member is required. MatchingEventTypes []EventType @@ -943,9 +837,9 @@ type EventDestination struct { // metrics. CloudWatchDestination *CloudWatchDestination - // If true, the event destination is enabled. When the event destination is + // If true , the event destination is enabled. When the event destination is // enabled, the specified event types are sent to the destinations in this - // EventDestinationDefinition. If false, the event destination is disabled. When + // EventDestinationDefinition . If false , the event destination is disabled. When // the event destination is disabled, events aren't sent to the specified // destinations. Enabled bool @@ -958,8 +852,7 @@ type EventDestination struct { // An object that defines an Amazon Pinpoint project destination for email events. // You can send email event data to a Amazon Pinpoint project to view metrics using // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For - // more information, see Transactional Messaging Charts - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) + // more information, see Transactional Messaging Charts (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) // in the Amazon Pinpoint User Guide. PinpointDestination *PinpointDestination @@ -981,9 +874,9 @@ type EventDestinationDefinition struct { // metrics. CloudWatchDestination *CloudWatchDestination - // If true, the event destination is enabled. When the event destination is + // If true , the event destination is enabled. When the event destination is // enabled, the specified event types are sent to the destinations in this - // EventDestinationDefinition. If false, the event destination is disabled. When + // EventDestinationDefinition . If false , the event destination is disabled. When // the event destination is disabled, events aren't sent to the specified // destinations. Enabled bool @@ -994,14 +887,13 @@ type EventDestinationDefinition struct { KinesisFirehoseDestination *KinesisFirehoseDestination // An array that specifies which events the Amazon SES API v2 should send to the - // destinations in this EventDestinationDefinition. + // destinations in this EventDestinationDefinition . MatchingEventTypes []EventType // An object that defines an Amazon Pinpoint project destination for email events. // You can send email event data to a Amazon Pinpoint project to view metrics using // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For - // more information, see Transactional Messaging Charts - // (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) + // more information, see Transactional Messaging Charts (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) // in the Amazon Pinpoint User Guide. PinpointDestination *PinpointDestination @@ -1031,12 +923,8 @@ type GuardianAttributes struct { // Specifies the status of your VDM optimized shared delivery. Can be one of the // following: - // - // * ENABLED – Amazon SES enables optimized shared delivery for your - // account. - // - // * DISABLED – Amazon SES disables optimized shared delivery for your - // account. + // - ENABLED – Amazon SES enables optimized shared delivery for your account. + // - DISABLED – Amazon SES disables optimized shared delivery for your account. OptimizedSharedDelivery FeatureStatus noSmithyDocumentSerde @@ -1048,12 +936,10 @@ type GuardianOptions struct { // Specifies the status of your VDM optimized shared delivery. Can be one of the // following: - // - // * ENABLED – Amazon SES enables optimized shared delivery for the - // configuration set. - // - // * DISABLED – Amazon SES disables optimized shared delivery - // for the configuration set. + // - ENABLED – Amazon SES enables optimized shared delivery for the configuration + // set. + // - DISABLED – Amazon SES disables optimized shared delivery for the + // configuration set. OptimizedSharedDelivery FeatureStatus noSmithyDocumentSerde @@ -1069,29 +955,22 @@ type IdentityInfo struct { // email identity types. IdentityType IdentityType - // Indicates whether or not you can send email from the identity. An identity is an - // email address or domain that you send email from. Before you can send email from - // an identity, you have to demostrate that you own the identity, and that you + // Indicates whether or not you can send email from the identity. An identity is + // an email address or domain that you send email from. Before you can send email + // from an identity, you have to demostrate that you own the identity, and that you // authorize Amazon SES to send email from that identity. SendingEnabled bool // The verification status of the identity. The status can be one of the // following: - // - // * PENDING – The verification process was initiated, but Amazon SES - // hasn't yet been able to verify the identity. - // - // * SUCCESS – The verification - // process completed successfully. - // - // * FAILED – The verification process failed. - // - // * - // TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining - // the verification status of the identity. - // - // * NOT_STARTED – The verification - // process hasn't been initiated for the identity. + // - PENDING – The verification process was initiated, but Amazon SES hasn't yet + // been able to verify the identity. + // - SUCCESS – The verification process completed successfully. + // - FAILED – The verification process failed. + // - TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from + // determining the verification status of the identity. + // - NOT_STARTED – The verification process hasn't been initiated for the + // identity. VerificationStatus VerificationStatus noSmithyDocumentSerde @@ -1113,8 +992,8 @@ type ImportDataSource struct { noSmithyDocumentSerde } -// An object that contains details about the resource destination the import job is -// going to target. +// An object that contains details about the resource destination the import job +// is going to target. type ImportDestination struct { // An object that contains the action of the import job towards a contact list. @@ -1136,8 +1015,8 @@ type ImportJobSummary struct { // reasons. FailedRecordsCount *int32 - // An object that contains details about the resource destination the import job is - // going to target. + // An object that contains details about the resource destination the import job + // is going to target. ImportDestination *ImportDestination // A string that represents the import job ID. @@ -1204,7 +1083,7 @@ type KinesisFirehoseDestination struct { // A filter that can be applied to a list of contacts. type ListContactsFilter struct { - // The status by which you are filtering: OPT_IN or OPT_OUT. + // The status by which you are filtering: OPT_IN or OPT_OUT . FilteredStatus SubscriptionStatus // Used for filtering by a specific topic preference. @@ -1232,12 +1111,12 @@ type ListManagementOptions struct { type MailFromAttributes struct { // The action to take if the required MX record can't be found when you send an - // email. When you set this value to USE_DEFAULT_VALUE, the mail is sent using - // amazonses.com as the MAIL FROM domain. When you set this value to - // REJECT_MESSAGE, the Amazon SES API v2 returns a MailFromDomainNotVerified error, - // and doesn't attempt to deliver the email. These behaviors are taken when the - // custom MAIL FROM domain configuration is in the Pending, Failed, and - // TemporaryFailure states. + // email. When you set this value to USE_DEFAULT_VALUE , the mail is sent using + // amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE + // , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't + // attempt to deliver the email. These behaviors are taken when the custom MAIL + // FROM domain configuration is in the Pending , Failed , and TemporaryFailure + // states. // // This member is required. BehaviorOnMxFailure BehaviorOnMxFailure @@ -1247,20 +1126,14 @@ type MailFromAttributes struct { // This member is required. MailFromDomain *string - // The status of the MAIL FROM domain. This status can have the following - // values: - // - // * PENDING – Amazon SES hasn't started searching for the MX record - // yet. - // - // * SUCCESS – Amazon SES detected the required MX record for the MAIL FROM - // domain. - // - // * FAILED – Amazon SES can't find the required MX record, or the record - // no longer exists. - // - // * TEMPORARY_FAILURE – A temporary issue occurred, which - // prevented Amazon SES from determining the status of the MAIL FROM domain. + // The status of the MAIL FROM domain. This status can have the following values: + // - PENDING – Amazon SES hasn't started searching for the MX record yet. + // - SUCCESS – Amazon SES detected the required MX record for the MAIL FROM + // domain. + // - FAILED – Amazon SES can't find the required MX record, or the record no + // longer exists. + // - TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES + // from determining the status of the MAIL FROM domain. // // This member is required. MailFromDomainStatus MailFromDomainStatus @@ -1268,8 +1141,8 @@ type MailFromAttributes struct { noSmithyDocumentSerde } -// Represents the email message that you're sending. The Message object consists of -// a subject line and a message body. +// Represents the email message that you're sending. The Message object consists +// of a subject line and a message body. type Message struct { // The body of the message. You can specify an HTML version of the message, a @@ -1280,8 +1153,8 @@ type Message struct { // The subject line of the email. The subject line can only contain 7-bit ASCII // characters. However, you can specify non-ASCII characters in the subject line by - // using encoded-word syntax, as described in RFC 2047 - // (https://tools.ietf.org/html/rfc2047). + // using encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047) + // . // // This member is required. Subject *Content @@ -1295,22 +1168,18 @@ type MessageTag struct { // The name of the message tag. The message tag name has to meet the following // criteria: - // - // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), - // underscores (_), or dashes (-). - // - // * It can contain no more than 256 characters. + // - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. Name *string // The value of the message tag. The message tag value has to meet the following // criteria: - // - // * It can only contain ASCII letters (a–z, A–Z), numbers (0–9), - // underscores (_), or dashes (-). - // - // * It can contain no more than 256 characters. + // - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores + // (_), or dashes (-). + // - It can contain no more than 256 characters. // // This member is required. Value *string @@ -1323,12 +1192,9 @@ type MessageTag struct { type MetricDataError struct { // The query error code. Can be one of: - // - // * INTERNAL_FAILURE – Amazon SES has failed - // to process one of the queries. - // - // * ACCESS_DENIED – You have insufficient access - // to retrieve metrics based on the given query. + // - INTERNAL_FAILURE – Amazon SES has failed to process one of the queries. + // - ACCESS_DENIED – You have insufficient access to retrieve metrics based on + // the given query. Code QueryErrorCode // The query identifier. @@ -1377,8 +1243,7 @@ type OverallVolume struct { // An object that defines an Amazon Pinpoint project destination for email events. // You can send email event data to a Amazon Pinpoint project to view metrics using // the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For -// more information, see Transactional Messaging Charts -// (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) +// more information, see Transactional Messaging Charts (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) // in the Amazon Pinpoint User Guide. type PinpointDestination struct { @@ -1400,8 +1265,8 @@ type PlacementStatistics struct { // predictive inbox placement test. InboxPercentage *float64 - // The percentage of emails that didn't arrive in recipients' inboxes at all during - // the predictive inbox placement test. + // The percentage of emails that didn't arrive in recipients' inboxes at all + // during the predictive inbox placement test. MissingPercentage *float64 // The percentage of emails that arrived in recipients' spam or junk mail folders @@ -1419,29 +1284,18 @@ type PlacementStatistics struct { type RawMessage struct { // The raw email message. The message has to meet the following criteria: - // - // * The - // message has to contain a header and a body, separated by one blank line. - // - // * All - // of the required header fields must be present in the message. - // - // * Each part of a - // multipart MIME message must be formatted properly. - // - // * Attachments must be in a - // file format that the Amazon SES supports. - // - // * The entire message must be Base64 - // encoded. - // - // * If any of the MIME parts in your message contain content that is - // outside of the 7-bit ASCII character range, you should encode that content to - // ensure that recipients' email clients render the message properly. - // - // * The length - // of any single line of text in the message can't exceed 1,000 characters. This - // restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321). + // - The message has to contain a header and a body, separated by one blank + // line. + // - All of the required header fields must be present in the message. + // - Each part of a multipart MIME message must be formatted properly. + // - Attachments must be in a file format that the Amazon SES supports. + // - The entire message must be Base64 encoded. + // - If any of the MIME parts in your message contain content that is outside of + // the 7-bit ASCII character range, you should encode that content to ensure that + // recipients' email clients render the message properly. + // - The length of any single line of text in the message can't exceed 1,000 + // characters. This restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321) + // . // // This member is required. Data []byte @@ -1459,37 +1313,37 @@ type Recommendation struct { // different recommendations about your DKIM setup. Description *string - // The recommendation impact, with values like HIGH or LOW. + // The recommendation impact, with values like HIGH or LOW . Impact RecommendationImpact // The last time the recommendation was updated. LastUpdatedTimestamp *time.Time // The resource affected by the recommendation, with values like - // arn:aws:ses:us-east-1:123456789012:identity/example.com. + // arn:aws:ses:us-east-1:123456789012:identity/example.com . ResourceArn *string - // The recommendation status, with values like OPEN or FIXED. + // The recommendation status, with values like OPEN or FIXED . Status RecommendationStatus - // The recommendation type, with values like DKIM, SPF, DMARC or BIMI. + // The recommendation type, with values like DKIM , SPF , DMARC or BIMI . Type RecommendationType noSmithyDocumentSerde } -// The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The +// The ReplaceEmailContent object to be used for a specific BulkEmailEntry . The // ReplacementTemplate can be specified within this object. type ReplacementEmailContent struct { - // The ReplacementTemplate associated with ReplacementEmailContent. + // The ReplacementTemplate associated with ReplacementEmailContent . ReplacementTemplate *ReplacementTemplate noSmithyDocumentSerde } // An object which contains ReplacementTemplateData to be used for a specific -// BulkEmailEntry. +// BulkEmailEntry . type ReplacementTemplate struct { // A list of replacement values to apply to the template. This parameter is a JSON @@ -1509,8 +1363,8 @@ type ReputationOptions struct { // are calculated starting from the date of the fresh start. LastFreshStart *time.Time - // If true, tracking of reputation metrics is enabled for the configuration set. If - // false, tracking of reputation metrics is disabled for the configuration set. + // If true , tracking of reputation metrics is enabled for the configuration set. + // If false , tracking of reputation metrics is disabled for the configuration set. ReputationMetricsEnabled bool noSmithyDocumentSerde @@ -1524,28 +1378,24 @@ type ReviewDetails struct { // The status of the latest review of your account. The status can be one of the // following: - // - // * PENDING – We have received your appeal and are in the process of - // reviewing it. - // - // * GRANTED – Your appeal has been reviewed and your production - // access has been granted. - // - // * DENIED – Your appeal has been reviewed and your - // production access has been denied. - // - // * FAILED – An internal error occurred and we - // didn't receive your appeal. You can submit your appeal again. + // - PENDING – We have received your appeal and are in the process of reviewing + // it. + // - GRANTED – Your appeal has been reviewed and your production access has been + // granted. + // - DENIED – Your appeal has been reviewed and your production access has been + // denied. + // - FAILED – An internal error occurred and we didn't receive your appeal. You + // can submit your appeal again. Status ReviewStatus noSmithyDocumentSerde } -// Used to enable or disable email sending for messages that use this configuration -// set in the current Amazon Web Services Region. +// Used to enable or disable email sending for messages that use this +// configuration set in the current Amazon Web Services Region. type SendingOptions struct { - // If true, email sending is enabled for the configuration set. If false, email + // If true , email sending is enabled for the configuration set. If false , email // sending is disabled for the configuration set. SendingEnabled bool @@ -1566,8 +1416,8 @@ type SendQuota struct { // maximum TPS (transactions per second) rate. MaxSendRate float64 - // The number of emails sent from your Amazon SES account in the current Amazon Web - // Services Region over the past 24 hours. + // The number of emails sent from your Amazon SES account in the current Amazon + // Web Services Region over the past 24 hours. SentLast24Hours float64 noSmithyDocumentSerde @@ -1579,7 +1429,7 @@ type SnsDestination struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events // to. For more information about Amazon SNS topics, see the Amazon SNS Developer - // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html). + // Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) . // // This member is required. TopicArn *string @@ -1607,8 +1457,8 @@ type SuppressedDestination struct { // This member is required. Reason SuppressionListReason - // An optional value that can contain additional information about the reasons that - // the address was added to the suppression list for your account. + // An optional value that can contain additional information about the reasons + // that the address was added to the suppression list for your account. Attributes *SuppressedDestinationAttributes noSmithyDocumentSerde @@ -1658,14 +1508,10 @@ type SuppressionAttributes struct { // A list that contains the reasons that email addresses will be automatically // added to the suppression list for your account. This list can contain any or all // of the following: - // - // * COMPLAINT – Amazon SES adds an email address to the - // suppression list for your account when a message sent to that address results in - // a complaint. - // - // * BOUNCE – Amazon SES adds an email address to the suppression - // list for your account when a message sent to that address results in a hard - // bounce. + // - COMPLAINT – Amazon SES adds an email address to the suppression list for + // your account when a message sent to that address results in a complaint. + // - BOUNCE – Amazon SES adds an email address to the suppression list for your + // account when a message sent to that address results in a hard bounce. SuppressedReasons []SuppressionListReason noSmithyDocumentSerde @@ -1676,12 +1522,9 @@ type SuppressionListDestination struct { // The type of action to perform on the address. The following are possible // values: - // - // * PUT: add the addresses to the suppression list. If the record already - // exists, it will override it with the new value. - // - // * DELETE: remove the addresses - // from the suppression list. + // - PUT: add the addresses to the suppression list. If the record already + // exists, it will override it with the new value. + // - DELETE: remove the addresses from the suppression list. // // This member is required. SuppressionListImportAction SuppressionListImportAction @@ -1693,16 +1536,13 @@ type SuppressionListDestination struct { // your account. type SuppressionOptions struct { - // A list that contains the reasons that email addresses are automatically added to - // the suppression list for your account. This list can contain any or all of the - // following: - // - // * COMPLAINT – Amazon SES adds an email address to the suppression - // list for your account when a message sent to that address results in a - // complaint. - // - // * BOUNCE – Amazon SES adds an email address to the suppression list - // for your account when a message sent to that address results in a hard bounce. + // A list that contains the reasons that email addresses are automatically added + // to the suppression list for your account. This list can contain any or all of + // the following: + // - COMPLAINT – Amazon SES adds an email address to the suppression list for + // your account when a message sent to that address results in a complaint. + // - BOUNCE – Amazon SES adds an email address to the suppression list for your + // account when a message sent to that address results in a hard bounce. SuppressedReasons []SuppressionListReason noSmithyDocumentSerde @@ -1719,27 +1559,22 @@ type SuppressionOptions struct { // as 256 characters. The characters can be Unicode letters, digits, white space, // or one of the following symbols: _ . : / = + -. The following additional // restrictions apply to tags: -// -// * Tag keys and values are case sensitive. -// -// * For -// each associated resource, each tag key must be unique and it can have only one -// value. -// -// * The aws: prefix is reserved for use by Amazon Web Services; you can’t -// use it in any tag keys or values that you define. In addition, you can't edit or -// remove tag keys or values that use this prefix. Tags that use this prefix don’t -// count against the limit of 50 tags per resource. -// -// * You can associate tags with -// public or shared resources, but the tags are available only for your Amazon Web -// Services account, not any other accounts that share the resource. In addition, -// the tags are available only for resources that are located in the specified -// Amazon Web Services Region for your Amazon Web Services account. +// - Tag keys and values are case sensitive. +// - For each associated resource, each tag key must be unique and it can have +// only one value. +// - The aws: prefix is reserved for use by Amazon Web Services; you can’t use it +// in any tag keys or values that you define. In addition, you can't edit or remove +// tag keys or values that use this prefix. Tags that use this prefix don’t count +// against the limit of 50 tags per resource. +// - You can associate tags with public or shared resources, but the tags are +// available only for your Amazon Web Services account, not any other accounts that +// share the resource. In addition, the tags are available only for resources that +// are located in the specified Amazon Web Services Region for your Amazon Web +// Services account. type Tag struct { - // One part of a key-value pair that defines a tag. The maximum length of a tag key - // is 128 characters. The minimum length is 1 character. + // One part of a key-value pair that defines a tag. The maximum length of a tag + // key is 128 characters. The minimum length is 1 character. // // This member is required. Key *string @@ -1820,7 +1655,7 @@ type TopicFilter struct { // The contact's preference for being opted-in to or opted-out of a topic. type TopicPreference struct { - // The contact's subscription status to a topic which is either OPT_IN or OPT_OUT. + // The contact's subscription status to a topic which is either OPT_IN or OPT_OUT . // // This member is required. SubscriptionStatus SubscriptionStatus @@ -1854,12 +1689,8 @@ type TrackingOptions struct { type VdmAttributes struct { // Specifies the status of your VDM configuration. Can be one of the following: - // - // * - // ENABLED – Amazon SES enables VDM for your account. - // - // * DISABLED – Amazon SES - // disables VDM for your account. + // - ENABLED – Amazon SES enables VDM for your account. + // - DISABLED – Amazon SES disables VDM for your account. // // This member is required. VdmEnabled FeatureStatus @@ -1875,8 +1706,8 @@ type VdmAttributes struct { noSmithyDocumentSerde } -// An object that defines the VDM settings that apply to emails that you send using -// the configuration set. +// An object that defines the VDM settings that apply to emails that you send +// using the configuration set. type VdmOptions struct { // Specifies additional settings for your VDM configuration as applicable to the @@ -1890,8 +1721,8 @@ type VdmOptions struct { noSmithyDocumentSerde } -// An object that contains information about the amount of email that was delivered -// to recipients. +// An object that contains information about the amount of email that was +// delivered to recipients. type VolumeStatistics struct { // The total number of emails that arrived in recipients' inboxes. diff --git a/service/sfn/api_client.go b/service/sfn/api_client.go index a4999d1d103..fffa96448d6 100644 --- a/service/sfn/api_client.go +++ b/service/sfn/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sfn/api_op_CreateActivity.go b/service/sfn/api_op_CreateActivity.go index 6e540df3b1d..aa105764e08 100644 --- a/service/sfn/api_op_CreateActivity.go +++ b/service/sfn/api_op_CreateActivity.go @@ -20,11 +20,11 @@ import ( // polling from the activity. This operation is eventually consistent. The results // are best effort and may not reflect very recent updates and changes. // CreateActivity is an idempotent API. Subsequent requests won’t create a -// duplicate resource if it was already created. CreateActivity's idempotency check -// is based on the activity name. If a following request has different tags values, -// Step Functions will ignore these differences and treat it as an idempotent -// request of the previous. In this case, tags will not be updated, even if they -// are different. +// duplicate resource if it was already created. CreateActivity 's idempotency +// check is based on the activity name . If a following request has different tags +// values, Step Functions will ignore these differences and treat it as an +// idempotent request of the previous. In this case, tags will not be updated, +// even if they are different. func (c *Client) CreateActivity(ctx context.Context, params *CreateActivityInput, optFns ...func(*Options)) (*CreateActivityOutput, error) { if params == nil { params = &CreateActivityInput{} @@ -42,39 +42,27 @@ func (c *Client) CreateActivity(ctx context.Context, params *CreateActivityInput type CreateActivityInput struct { - // The name of the activity to create. This name must be unique for your Amazon Web - // Services account and region for 90 days. For more information, see Limits - // Related to State Machine Executions - // (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) + // The name of the activity to create. This name must be unique for your Amazon + // Web Services account and region for 90 days. For more information, see Limits + // Related to State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) // in the Step Functions Developer Guide. A name must not contain: - // - // * white - // space - // - // * brackets < > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " - // # % \ ^ | ~ ` $ & , ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To - // enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - // - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string // The list of tags to add to a resource. An array of key-value pairs. For more - // information, see Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) + // information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide, and - // Controlling Access Using IAM Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags - // may only contain Unicode letters, digits, white space, or these symbols: _ . : / - // = + - @. + // Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) + // . Tags may only contain Unicode letters, digits, white space, or these symbols: + // _ . : / = + - @ . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sfn/api_op_CreateStateMachine.go b/service/sfn/api_op_CreateStateMachine.go index 3669dbc50d2..6a22018c1fe 100644 --- a/service/sfn/api_op_CreateStateMachine.go +++ b/service/sfn/api_op_CreateStateMachine.go @@ -12,21 +12,20 @@ import ( "time" ) -// Creates a state machine. A state machine consists of a collection of states that -// can do work (Task states), determine to which states to transition next (Choice -// states), stop an execution with an error (Fail states), and so on. State -// machines are specified using a JSON-based, structured language. For more -// information, see Amazon States Language -// (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) +// Creates a state machine. A state machine consists of a collection of states +// that can do work ( Task states), determine to which states to transition next ( +// Choice states), stop an execution with an error ( Fail states), and so on. +// State machines are specified using a JSON-based, structured language. For more +// information, see Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) // in the Step Functions User Guide. This operation is eventually consistent. The // results are best effort and may not reflect very recent updates and changes. // CreateStateMachine is an idempotent API. Subsequent requests won’t create a -// duplicate resource if it was already created. CreateStateMachine's idempotency -// check is based on the state machine name, definition, type, LoggingConfiguration -// and TracingConfiguration. If a following request has a different roleArn or -// tags, Step Functions will ignore these differences and treat it as an idempotent -// request of the previous. In this case, roleArn and tags will not be updated, -// even if they are different. +// duplicate resource if it was already created. CreateStateMachine 's idempotency +// check is based on the state machine name , definition , type , +// LoggingConfiguration and TracingConfiguration . If a following request has a +// different roleArn or tags , Step Functions will ignore these differences and +// treat it as an idempotent request of the previous. In this case, roleArn and +// tags will not be updated, even if they are different. func (c *Client) CreateStateMachine(ctx context.Context, params *CreateStateMachineInput, optFns ...func(*Options)) (*CreateStateMachineOutput, error) { if params == nil { params = &CreateStateMachineInput{} @@ -45,29 +44,20 @@ func (c *Client) CreateStateMachine(ctx context.Context, params *CreateStateMach type CreateStateMachineInput struct { // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) + // . // // This member is required. Definition *string // The name of the state machine. A name must not contain: - // - // * white space - // - // * - // brackets < > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ - // | ~ ` $ & , ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable - // logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and - // _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string @@ -78,26 +68,23 @@ type CreateStateMachineInput struct { RoleArn *string // Defines what execution history events are logged and where they are logged. By - // default, the level is set to OFF. For more information see Log Levels - // (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) + // default, the level is set to OFF . For more information see Log Levels (https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) // in the Step Functions User Guide. LoggingConfiguration *types.LoggingConfiguration - // Tags to be added when creating a state machine. An array of key-value pairs. For - // more information, see Using Cost Allocation Tags - // (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) + // Tags to be added when creating a state machine. An array of key-value pairs. + // For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide, and - // Controlling Access Using IAM Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags - // may only contain Unicode letters, digits, white space, or these symbols: _ . : / - // = + - @. + // Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) + // . Tags may only contain Unicode letters, digits, white space, or these symbols: + // _ . : / = + - @ . Tags []types.Tag // Selects whether X-Ray tracing is enabled. TracingConfiguration *types.TracingConfiguration // Determines whether a Standard or Express state machine is created. The default - // is STANDARD. You cannot update the type of a state machine once it has been + // is STANDARD . You cannot update the type of a state machine once it has been // created. Type types.StateMachineType diff --git a/service/sfn/api_op_DeleteStateMachine.go b/service/sfn/api_op_DeleteStateMachine.go index aeba32a923d..3db7cba2015 100644 --- a/service/sfn/api_op_DeleteStateMachine.go +++ b/service/sfn/api_op_DeleteStateMachine.go @@ -11,14 +11,14 @@ import ( ) // Deletes a state machine. This is an asynchronous operation: It sets the state -// machine's status to DELETING and begins the deletion process. If the given state -// machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will -// fail with ValidationException. A qualified state machine ARN refers to a +// machine's status to DELETING and begins the deletion process. If the given +// state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it +// will fail with ValidationException. A qualified state machine ARN refers to a // Distributed Map state defined within a state machine. For example, the qualified // state machine ARN // arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel // refers to a Distributed Map state with a label mapStateLabel in the state -// machine named stateMachineName. For EXPRESS state machines, the deletion will +// machine named stateMachineName . For EXPRESS state machines, the deletion will // happen eventually (usually less than a minute). Running executions may emit logs // after DeleteStateMachine API is called. func (c *Client) DeleteStateMachine(ctx context.Context, params *DeleteStateMachineInput, optFns ...func(*Options)) (*DeleteStateMachineOutput, error) { diff --git a/service/sfn/api_op_DescribeActivity.go b/service/sfn/api_op_DescribeActivity.go index 2531f54d289..a2ba5d32d3f 100644 --- a/service/sfn/api_op_DescribeActivity.go +++ b/service/sfn/api_op_DescribeActivity.go @@ -51,21 +51,13 @@ type DescribeActivityOutput struct { CreationDate *time.Time // The name of the activity. A name must not contain: - // - // * white space - // - // * brackets < - // > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ | ~ ` $ & , - // ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable logging with - // CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string diff --git a/service/sfn/api_op_DescribeExecution.go b/service/sfn/api_op_DescribeExecution.go index 216079561c7..6d3b8fda6c1 100644 --- a/service/sfn/api_op_DescribeExecution.go +++ b/service/sfn/api_op_DescribeExecution.go @@ -85,21 +85,13 @@ type DescribeExecutionOutput struct { MapRunArn *string // The name of the execution. A name must not contain: - // - // * white space - // - // * brackets < - // > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ | ~ ` $ & , - // ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable logging with - // CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. Name *string // The JSON output data of the execution. Length constraints apply to the payload diff --git a/service/sfn/api_op_DescribeMapRun.go b/service/sfn/api_op_DescribeMapRun.go index d61fc67ef02..c1583fb0356 100644 --- a/service/sfn/api_op_DescribeMapRun.go +++ b/service/sfn/api_op_DescribeMapRun.go @@ -12,9 +12,8 @@ import ( "time" ) -// Provides information about a Map Run's configuration, progress, and results. For -// more information, see Examining Map Run -// (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) +// Provides information about a Map Run's configuration, progress, and results. +// For more information, see Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) // in the Step Functions Developer Guide. func (c *Client) DescribeMapRun(ctx context.Context, params *DescribeMapRunInput, optFns ...func(*Options)) (*DescribeMapRunOutput, error) { if params == nil { @@ -49,15 +48,15 @@ type DescribeMapRunOutput struct { // This member is required. ExecutionArn *string - // A JSON object that contains information about the total number of child workflow - // executions for the Map Run, and the count of child workflow executions for each - // status, such as failed and succeeded. + // A JSON object that contains information about the total number of child + // workflow executions for the Map Run, and the count of child workflow executions + // for each status, such as failed and succeeded . // // This member is required. ExecutionCounts *types.MapRunExecutionCounts - // A JSON object that contains information about the total number of items, and the - // item count for each processing status, such as pending and failed. + // A JSON object that contains information about the total number of items, and + // the item count for each processing status, such as pending and failed . // // This member is required. ItemCounts *types.MapRunItemCounts diff --git a/service/sfn/api_op_DescribeStateMachine.go b/service/sfn/api_op_DescribeStateMachine.go index 1b70c9da8ec..53c4c4a34ac 100644 --- a/service/sfn/api_op_DescribeStateMachine.go +++ b/service/sfn/api_op_DescribeStateMachine.go @@ -19,7 +19,7 @@ import ( // state machine. For example, the qualified state machine ARN // arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel // refers to a Distributed Map state with a label mapStateLabel in the state -// machine named stateMachineName. This operation is eventually consistent. The +// machine named stateMachineName . This operation is eventually consistent. The // results are best effort and may not reflect very recent updates and changes. func (c *Client) DescribeStateMachine(ctx context.Context, params *DescribeStateMachineInput, optFns ...func(*Options)) (*DescribeStateMachineOutput, error) { if params == nil { @@ -54,29 +54,20 @@ type DescribeStateMachineOutput struct { CreationDate *time.Time // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) + // . // // This member is required. Definition *string // The name of the state machine. A name must not contain: - // - // * white space - // - // * - // brackets < > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ - // | ~ ` $ & , ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable - // logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and - // _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string @@ -93,7 +84,7 @@ type DescribeStateMachineOutput struct { // This member is required. StateMachineArn *string - // The type of the state machine (STANDARD or EXPRESS). + // The type of the state machine ( STANDARD or EXPRESS ). // // This member is required. Type types.StateMachineType diff --git a/service/sfn/api_op_DescribeStateMachineForExecution.go b/service/sfn/api_op_DescribeStateMachineForExecution.go index 3d168425b5c..57bca99e00c 100644 --- a/service/sfn/api_op_DescribeStateMachineForExecution.go +++ b/service/sfn/api_op_DescribeStateMachineForExecution.go @@ -12,10 +12,10 @@ import ( "time" ) -// Provides information about a state machine's definition, its execution role ARN, -// and configuration. If an execution was dispatched by a Map Run, the Map Run is -// returned in the response. Additionally, the state machine returned will be the -// state machine associated with the Map Run. This operation is eventually +// Provides information about a state machine's definition, its execution role +// ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run +// is returned in the response. Additionally, the state machine returned will be +// the state machine associated with the Map Run. This operation is eventually // consistent. The results are best effort and may not reflect very recent updates // and changes. This API action is not supported by EXPRESS state machines. func (c *Client) DescribeStateMachineForExecution(ctx context.Context, params *DescribeStateMachineForExecutionInput, optFns ...func(*Options)) (*DescribeStateMachineForExecutionOutput, error) { @@ -47,8 +47,8 @@ type DescribeStateMachineForExecutionInput struct { type DescribeStateMachineForExecutionOutput struct { // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) + // . // // This member is required. Definition *string @@ -77,8 +77,8 @@ type DescribeStateMachineForExecutionOutput struct { UpdateDate *time.Time // A user-defined or an auto-generated string that identifies a Map state. This - // field is returned only if the executionArn is a child workflow execution that was - // started by a Distributed Map state. + // field is returned only if the executionArn is a child workflow execution that + // was started by a Distributed Map state. Label *string // The LoggingConfiguration data type is used to set CloudWatch Logs options. diff --git a/service/sfn/api_op_GetActivityTask.go b/service/sfn/api_op_GetActivityTask.go index bc5dffed1e1..6e6a8363ee3 100644 --- a/service/sfn/api_op_GetActivityTask.go +++ b/service/sfn/api_op_GetActivityTask.go @@ -20,8 +20,7 @@ import ( // set their client side socket timeout to at least 65 seconds (5 seconds higher // than the maximum time the service may hold the poll request). Polling with // GetActivityTask can cause latency in some implementations. See Avoid Latency -// When Polling for Activity Tasks -// (https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html) +// When Polling for Activity Tasks (https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html) // in the Step Functions Developer Guide. func (c *Client) GetActivityTask(ctx context.Context, params *GetActivityTaskInput, optFns ...func(*Options)) (*GetActivityTaskOutput, error) { if params == nil { @@ -41,7 +40,7 @@ func (c *Client) GetActivityTask(ctx context.Context, params *GetActivityTaskInp type GetActivityTaskInput struct { // The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned - // when you create the task using CreateActivity.) + // when you create the task using CreateActivity .) // // This member is required. ActivityArn *string @@ -60,7 +59,7 @@ type GetActivityTaskOutput struct { Input *string // A token that identifies the scheduled task. This token must be copied and - // included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or + // included in subsequent calls to SendTaskHeartbeat , SendTaskSuccess or // SendTaskFailure in order to report the progress or completion of the task. TaskToken *string diff --git a/service/sfn/api_op_GetExecutionHistory.go b/service/sfn/api_op_GetExecutionHistory.go index eb75d1caf8e..edd96cf0de9 100644 --- a/service/sfn/api_op_GetExecutionHistory.go +++ b/service/sfn/api_op_GetExecutionHistory.go @@ -44,7 +44,7 @@ type GetExecutionHistoryInput struct { ExecutionArn *string // You can select whether execution data (input or output of a history event) is - // returned. The default is true. + // returned. The default is true . IncludeExecutionData *bool // The maximum number of results that are returned per call. You can use nextToken @@ -61,7 +61,7 @@ type GetExecutionHistoryInput struct { // pagination token will return an HTTP 400 InvalidToken error. NextToken *string - // Lists events in descending order of their timeStamp. + // Lists events in descending order of their timeStamp . ReverseOrder bool noSmithyDocumentSerde @@ -150,8 +150,8 @@ func (c *Client) addOperationGetExecutionHistoryMiddlewares(stack *middleware.St return nil } -// GetExecutionHistoryAPIClient is a client that implements the GetExecutionHistory -// operation. +// GetExecutionHistoryAPIClient is a client that implements the +// GetExecutionHistory operation. type GetExecutionHistoryAPIClient interface { GetExecutionHistory(context.Context, *GetExecutionHistoryInput, ...func(*Options)) (*GetExecutionHistoryOutput, error) } diff --git a/service/sfn/api_op_ListExecutions.go b/service/sfn/api_op_ListExecutions.go index 1d718689088..87d95c61187 100644 --- a/service/sfn/api_op_ListExecutions.go +++ b/service/sfn/api_op_ListExecutions.go @@ -43,10 +43,9 @@ type ListExecutionsInput struct { // The Amazon Resource Name (ARN) of the Map Run that started the child workflow // executions. If the mapRunArn field is specified, a list of all of the child // workflow executions started by a Map Run is returned. For more information, see - // Examining Map Run - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) + // Examining Map Run (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html) // in the Step Functions Developer Guide. You can specify either a mapRunArn or a - // stateMachineArn, but not both. + // stateMachineArn , but not both. MapRunArn *string // The maximum number of results that are returned per call. You can use nextToken @@ -64,7 +63,7 @@ type ListExecutionsInput struct { NextToken *string // The Amazon Resource Name (ARN) of the state machine whose executions is listed. - // You can specify either a mapRunArn or a stateMachineArn, but not both. + // You can specify either a mapRunArn or a stateMachineArn , but not both. StateMachineArn *string // If specified, only list the executions whose current execution status matches diff --git a/service/sfn/api_op_ListTagsForResource.go b/service/sfn/api_op_ListTagsForResource.go index 497674c7f05..14e059e7994 100644 --- a/service/sfn/api_op_ListTagsForResource.go +++ b/service/sfn/api_op_ListTagsForResource.go @@ -12,7 +12,7 @@ import ( ) // List tags for a given resource. Tags may only contain Unicode letters, digits, -// white space, or these symbols: _ . : / = + - @. +// white space, or these symbols: _ . : / = + - @ . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/sfn/api_op_SendTaskFailure.go b/service/sfn/api_op_SendTaskFailure.go index 3a5e2c001f9..5fe4cb90413 100644 --- a/service/sfn/api_op_SendTaskFailure.go +++ b/service/sfn/api_op_SendTaskFailure.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers and task states using the callback -// (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) +// Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) // pattern to report that the task identified by the taskToken failed. func (c *Client) SendTaskFailure(ctx context.Context, params *SendTaskFailureInput, optFns ...func(*Options)) (*SendTaskFailureOutput, error) { if params == nil { @@ -30,10 +29,9 @@ func (c *Client) SendTaskFailure(ctx context.Context, params *SendTaskFailureInp type SendTaskFailureInput struct { - // The token that represents this task. Task tokens are generated by Step Functions - // when tasks are assigned to a worker, or in the context object - // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) - // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. + // The token that represents this task. Task tokens are generated by Step + // Functions when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) + // when a workflow enters a task state. See GetActivityTaskOutput$taskToken . // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_SendTaskHeartbeat.go b/service/sfn/api_op_SendTaskHeartbeat.go index 162b9446d07..75e8fe3dcd6 100644 --- a/service/sfn/api_op_SendTaskHeartbeat.go +++ b/service/sfn/api_op_SendTaskHeartbeat.go @@ -10,18 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers and task states using the callback -// (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) +// Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) // pattern to report to Step Functions that the task represented by the specified // taskToken is still making progress. This action resets the Heartbeat clock. The // Heartbeat threshold is specified in the state machine's Amazon States Language -// definition (HeartbeatSeconds). This action does not in itself create an event in -// the execution history. However, if the task times out, the execution history +// definition ( HeartbeatSeconds ). This action does not in itself create an event +// in the execution history. However, if the task times out, the execution history // contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for -// for tasks using the job run -// (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) -// or callback -// (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) +// for tasks using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) +// or callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) // pattern. The Timeout of a task, defined in the state machine's Amazon States // Language definition, is its maximum allowed duration, regardless of the number // of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the @@ -43,10 +40,9 @@ func (c *Client) SendTaskHeartbeat(ctx context.Context, params *SendTaskHeartbea type SendTaskHeartbeatInput struct { - // The token that represents this task. Task tokens are generated by Step Functions - // when tasks are assigned to a worker, or in the context object - // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) - // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. + // The token that represents this task. Task tokens are generated by Step + // Functions when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) + // when a workflow enters a task state. See GetActivityTaskOutput$taskToken . // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_SendTaskSuccess.go b/service/sfn/api_op_SendTaskSuccess.go index 63941a55225..cfb307ece64 100644 --- a/service/sfn/api_op_SendTaskSuccess.go +++ b/service/sfn/api_op_SendTaskSuccess.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers and task states using the callback -// (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) +// Used by activity workers and task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) // pattern to report that the task identified by the taskToken completed // successfully. func (c *Client) SendTaskSuccess(ctx context.Context, params *SendTaskSuccessInput, optFns ...func(*Options)) (*SendTaskSuccessOutput, error) { @@ -37,10 +36,9 @@ type SendTaskSuccessInput struct { // This member is required. Output *string - // The token that represents this task. Task tokens are generated by Step Functions - // when tasks are assigned to a worker, or in the context object - // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) - // when a workflow enters a task state. See GetActivityTaskOutput$taskToken. + // The token that represents this task. Task tokens are generated by Step + // Functions when tasks are assigned to a worker, or in the context object (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) + // when a workflow enters a task state. See GetActivityTaskOutput$taskToken . // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_StartExecution.go b/service/sfn/api_op_StartExecution.go index e0914da5e87..0fe1734f7f9 100644 --- a/service/sfn/api_op_StartExecution.go +++ b/service/sfn/api_op_StartExecution.go @@ -18,7 +18,7 @@ import ( // ARN // arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel // refers to a Distributed Map state with a label mapStateLabel in the state -// machine named stateMachineName. StartExecution is idempotent for STANDARD +// machine named stateMachineName . StartExecution is idempotent for STANDARD // workflows. For a STANDARD workflow, if StartExecution is called with the same // name and input as a running execution, the call will succeed and return the same // response as the original request. If the execution is closed or if the input is @@ -53,27 +53,17 @@ type StartExecutionInput struct { // encoding. Input *string - // The name of the execution. This name must be unique for your Amazon Web Services - // account, region, and state machine for 90 days. For more information, see - // Limits Related to State Machine Executions - // (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) + // The name of the execution. This name must be unique for your Amazon Web + // Services account, region, and state machine for 90 days. For more information, + // see Limits Related to State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions) // in the Step Functions Developer Guide. A name must not contain: - // - // * white - // space - // - // * brackets < > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " - // # % \ ^ | ~ ` $ & , ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To - // enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - // - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. Name *string // Passes the X-Ray trace header. The trace header can also be passed in the diff --git a/service/sfn/api_op_StartSyncExecution.go b/service/sfn/api_op_StartSyncExecution.go index 79cba52cb56..c3157f6a86d 100644 --- a/service/sfn/api_op_StartSyncExecution.go +++ b/service/sfn/api_op_StartSyncExecution.go @@ -81,8 +81,8 @@ type StartSyncExecutionOutput struct { // This member is required. StopDate *time.Time - // An object that describes workflow billing details, including billed duration and - // memory use. + // An object that describes workflow billing details, including billed duration + // and memory use. BillingDetails *types.BillingDetails // A more detailed explanation of the cause of the failure. diff --git a/service/sfn/api_op_TagResource.go b/service/sfn/api_op_TagResource.go index eaee15fea84..e5e79e2d9d9 100644 --- a/service/sfn/api_op_TagResource.go +++ b/service/sfn/api_op_TagResource.go @@ -12,13 +12,11 @@ import ( ) // Add a tag to a Step Functions resource. An array of key-value pairs. For more -// information, see Using Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide, and -// Controlling Access Using IAM Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags -// may only contain Unicode letters, digits, white space, or these symbols: _ . : / -// = + - @. +// Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) +// . Tags may only contain Unicode letters, digits, white space, or these symbols: +// _ . : / = + - @ . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -42,7 +40,7 @@ type TagResourceInput struct { ResourceArn *string // The list of tags to add to a resource. Tags may only contain Unicode letters, - // digits, white space, or these symbols: _ . : / = + - @. + // digits, white space, or these symbols: _ . : / = + - @ . // // This member is required. Tags []types.Tag diff --git a/service/sfn/api_op_UpdateStateMachine.go b/service/sfn/api_op_UpdateStateMachine.go index 9c57cbdf7ef..0db5c70ce6e 100644 --- a/service/sfn/api_op_UpdateStateMachine.go +++ b/service/sfn/api_op_UpdateStateMachine.go @@ -12,20 +12,20 @@ import ( "time" ) -// Updates an existing state machine by modifying its definition, roleArn, or -// loggingConfiguration. Running executions will continue to use the previous -// definition and roleArn. You must include at least one of definition or roleArn -// or you will receive a MissingRequiredParameter error. If the given state machine -// Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with -// ValidationException. A qualified state machine ARN refers to a Distributed Map -// state defined within a state machine. For example, the qualified state machine -// ARN +// Updates an existing state machine by modifying its definition , roleArn , or +// loggingConfiguration . Running executions will continue to use the previous +// definition and roleArn . You must include at least one of definition or roleArn +// or you will receive a MissingRequiredParameter error. If the given state +// machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will +// fail with ValidationException. A qualified state machine ARN refers to a +// Distributed Map state defined within a state machine. For example, the qualified +// state machine ARN // arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel // refers to a Distributed Map state with a label mapStateLabel in the state -// machine named stateMachineName. All StartExecution calls within a few seconds -// will use the updated definition and roleArn. Executions started immediately +// machine named stateMachineName . All StartExecution calls within a few seconds +// will use the updated definition and roleArn . Executions started immediately // after calling UpdateStateMachine may use the previous state machine definition -// and roleArn. +// and roleArn . func (c *Client) UpdateStateMachine(ctx context.Context, params *UpdateStateMachineInput, optFns ...func(*Options)) (*UpdateStateMachineOutput, error) { if params == nil { params = &UpdateStateMachineInput{} @@ -49,8 +49,8 @@ type UpdateStateMachineInput struct { StateMachineArn *string // The Amazon States Language definition of the state machine. See Amazon States - // Language - // (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html). + // Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) + // . Definition *string // The LoggingConfiguration data type is used to set CloudWatch Logs options. diff --git a/service/sfn/doc.go b/service/sfn/doc.go index 3f7d10077da..9e370fe8ea9 100644 --- a/service/sfn/doc.go +++ b/service/sfn/doc.go @@ -17,6 +17,6 @@ // tasks on Amazon Web Services, your own servers, or any system that has access to // Amazon Web Services. You can access and use Step Functions using the console, // the Amazon Web Services SDKs, or an HTTP API. For more information about Step -// Functions, see the Step Functions Developer Guide -// (https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) . +// Functions, see the Step Functions Developer Guide (https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) +// . package sfn diff --git a/service/sfn/types/enums.go b/service/sfn/types/enums.go index c3a04801e84..d71cae8a9c8 100644 --- a/service/sfn/types/enums.go +++ b/service/sfn/types/enums.go @@ -190,9 +190,9 @@ const ( MapRunStatusAborted MapRunStatus = "ABORTED" ) -// Values returns all known values for MapRunStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for MapRunStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (MapRunStatus) Values() []MapRunStatus { return []MapRunStatus{ "RUNNING", diff --git a/service/sfn/types/errors.go b/service/sfn/types/errors.go index 7b79a588aad..966019d5209 100644 --- a/service/sfn/types/errors.go +++ b/service/sfn/types/errors.go @@ -87,7 +87,7 @@ func (e *ActivityWorkerLimitExceeded) ErrorCode() string { } func (e *ActivityWorkerLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The execution has the same name as another execution (but a different input). +// The execution has the same name as another execution (but a different input ). // Executions with the same name and input are considered idempotent. type ExecutionAlreadyExists struct { Message *string @@ -349,7 +349,7 @@ func (e *InvalidToken) ErrorCode() string { func (e *InvalidToken) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Your tracingConfiguration key does not match, or enabled has not been set to -// true or false. +// true or false . type InvalidTracingConfiguration struct { Message *string @@ -402,8 +402,8 @@ func (e *MissingRequiredParameter) ErrorCode() string { } func (e *MissingRequiredParameter) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Could not find the referenced resource. Only state machine and activity ARNs are -// supported. +// Could not find the referenced resource. Only state machine and activity ARNs +// are supported. type ResourceNotFound struct { Message *string @@ -612,9 +612,8 @@ func (e *TaskTimedOut) ErrorCode() string { } func (e *TaskTimedOut) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've exceeded the number of tags allowed for a resource. See the Limits Topic -// (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) in the Step -// Functions Developer Guide. +// You've exceeded the number of tags allowed for a resource. See the Limits Topic (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html) +// in the Step Functions Developer Guide. type TooManyTags struct { Message *string diff --git a/service/sfn/types/types.go b/service/sfn/types/types.go index 689ed78d2be..9c5b8be51c8 100644 --- a/service/sfn/types/types.go +++ b/service/sfn/types/types.go @@ -33,21 +33,13 @@ type ActivityListItem struct { CreationDate *time.Time // The name of the activity. A name must not contain: - // - // * white space - // - // * brackets < - // > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ | ~ ` $ & , - // ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable logging with - // CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string @@ -95,8 +87,8 @@ type ActivityScheduleFailedEventDetails struct { // Contains details about the start of an activity during an execution. type ActivityStartedEventDetails struct { - // The name of the worker that the task is assigned to. These names are provided by - // the workers when calling GetActivityTask. + // The name of the worker that the task is assigned to. These names are provided + // by the workers when calling GetActivityTask . WorkerName *string noSmithyDocumentSerde @@ -192,21 +184,13 @@ type ExecutionListItem struct { ExecutionArn *string // The name of the execution. A name must not contain: - // - // * white space - // - // * brackets < - // > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ | ~ ` $ & , - // ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable logging with - // CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string @@ -226,15 +210,15 @@ type ExecutionListItem struct { // This member is required. Status ExecutionStatus - // The total number of items processed in a child workflow execution. This field is - // returned only if mapRunArn was specified in the ListExecutions API action. If - // stateMachineArn was specified in ListExecutions, the itemCount field isn't + // The total number of items processed in a child workflow execution. This field + // is returned only if mapRunArn was specified in the ListExecutions API action. + // If stateMachineArn was specified in ListExecutions , the itemCount field isn't // returned. ItemCount *int32 // The Amazon Resource Name (ARN) of a Map Run. This field is returned only if - // mapRunArn was specified in the ListExecutions API action. If stateMachineArn was - // specified in ListExecutions, the mapRunArn isn't returned. + // mapRunArn was specified in the ListExecutions API action. If stateMachineArn + // was specified in ListExecutions , the mapRunArn isn't returned. MapRunArn *string // If the execution already ended, the date the execution stopped. @@ -374,7 +358,7 @@ type HistoryEvent struct { // Contains error and cause details about a Map Run that failed. MapRunFailedEventDetails *MapRunFailedEventDetails - // Contains details, such as mapRunArn, and the start date and time of a Map Run. + // Contains details, such as mapRunArn , and the start date and time of a Map Run. // mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started. MapRunStartedEventDetails *MapRunStartedEventDetails @@ -519,8 +503,7 @@ type LambdaFunctionTimedOutEventDetails struct { type LogDestination struct { // An object describing a CloudWatch log group. For more information, see - // AWS::Logs::LogGroup - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) + // AWS::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) // in the CloudFormation User Guide. CloudWatchLogsLogGroup *CloudWatchLogsLogGroup @@ -531,10 +514,10 @@ type LogDestination struct { type LoggingConfiguration struct { // An array of objects that describes where your execution history events will be - // logged. Limited to size 1. Required, if your log level is not set to OFF. + // logged. Limited to size 1. Required, if your log level is not set to OFF . Destinations []LogDestination - // Determines whether execution data is included in your log. When set to false, + // Determines whether execution data is included in your log. When set to false , // data is excluded. IncludeExecutionData bool @@ -560,9 +543,9 @@ type MapIterationEventDetails struct { // Run. type MapRunExecutionCounts struct { - // The total number of child workflow executions that were started by a Map Run and - // were running, but were either stopped by the user or by Step Functions because - // the Map Run failed. + // The total number of child workflow executions that were started by a Map Run + // and were running, but were either stopped by the user or by Step Functions + // because the Map Run failed. // // This member is required. Aborted int64 @@ -580,27 +563,26 @@ type MapRunExecutionCounts struct { Pending int64 // Returns the count of child workflow executions whose results were written by - // ResultWriter. For more information, see ResultWriter - // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) + // ResultWriter . For more information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) // in the Step Functions Developer Guide. // // This member is required. ResultsWritten int64 - // The total number of child workflow executions that were started by a Map Run and - // are currently in-progress. + // The total number of child workflow executions that were started by a Map Run + // and are currently in-progress. // // This member is required. Running int64 - // The total number of child workflow executions that were started by a Map Run and - // have completed successfully. + // The total number of child workflow executions that were started by a Map Run + // and have completed successfully. // // This member is required. Succeeded int64 - // The total number of child workflow executions that were started by a Map Run and - // have timed out. + // The total number of child workflow executions that were started by a Map Run + // and have timed out. // // This member is required. TimedOut int64 @@ -648,9 +630,8 @@ type MapRunItemCounts struct { // This member is required. Pending int64 - // Returns the count of items whose results were written by ResultWriter. For more - // information, see ResultWriter - // (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) + // Returns the count of items whose results were written by ResultWriter . For more + // information, see ResultWriter (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html) // in the Step Functions Developer Guide. // // This member is required. @@ -668,14 +649,14 @@ type MapRunItemCounts struct { // This member is required. Succeeded int64 - // The total number of items processed in child workflow executions that have timed - // out. + // The total number of items processed in child workflow executions that have + // timed out. // // This member is required. TimedOut int64 - // The total number of items processed in all the child workflow executions started - // by a Map Run. + // The total number of items processed in all the child workflow executions + // started by a Map Run. // // This member is required. Total int64 @@ -753,27 +734,19 @@ type StateEnteredEventDetails struct { type StateExitedEventDetails struct { // The name of the state. A name must not contain: - // - // * white space - // - // * brackets < > { - // } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ | ~ ` $ & , ; : - // / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable logging with - // CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string - // The JSON output data of the state. Length constraints apply to the payload size, - // and are expressed as bytes in UTF-8 encoding. + // The JSON output data of the state. Length constraints apply to the payload + // size, and are expressed as bytes in UTF-8 encoding. Output *string // Contains details about the output of an execution history event. @@ -791,22 +764,13 @@ type StateMachineListItem struct { CreationDate *time.Time // The name of the state machine. A name must not contain: - // - // * white space - // - // * - // brackets < > { } [ ] - // - // * wildcard characters ? * - // - // * special characters " # % \ ^ - // | ~ ` $ & , ; : / - // - // * control characters (U+0000-001F, U+007F-009F) - // - // To enable - // logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and - // _. + // - white space + // - brackets < > { } [ ] + // - wildcard characters ? * + // - special characters " # % \ ^ | ~ ` $ & , ; : / + // - control characters ( U+0000-001F , U+007F-009F ) + // To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, + // a-z, - and _. // // This member is required. Name *string @@ -826,13 +790,11 @@ type StateMachineListItem struct { // Tags are key-value pairs that can be associated with Step Functions state // machines and activities. An array of key-value pairs. For more information, see -// Using Cost Allocation Tags -// (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) +// Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) // in the Amazon Web Services Billing and Cost Management User Guide, and -// Controlling Access Using IAM Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags -// may only contain Unicode letters, digits, white space, or these symbols: _ . : / -// = + - @. +// Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html) +// . Tags may only contain Unicode letters, digits, white space, or these symbols: +// _ . : / = + - @ . type Tag struct { // The key of a tag. @@ -1046,7 +1008,7 @@ type TaskTimedOutEventDetails struct { // false type TracingConfiguration struct { - // When set to true, X-Ray tracing is enabled. + // When set to true , X-Ray tracing is enabled. Enabled bool noSmithyDocumentSerde diff --git a/service/shield/api_client.go b/service/shield/api_client.go index 882ef76cbaf..4a036beaae9 100644 --- a/service/shield/api_client.go +++ b/service/shield/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/shield/api_op_AssociateDRTLogBucket.go b/service/shield/api_op_AssociateDRTLogBucket.go index ee4ce221623..faa23a4744e 100644 --- a/service/shield/api_op_AssociateDRTLogBucket.go +++ b/service/shield/api_op_AssociateDRTLogBucket.go @@ -16,8 +16,8 @@ import ( // Amazon S3 buckets with your subscription. To use the services of the SRT and // make an AssociateDRTLogBucket request, you must be subscribed to the Business // Support plan (http://aws.amazon.com/premiumsupport/business-support/) or the -// Enterprise Support plan -// (http://aws.amazon.com/premiumsupport/enterprise-support/). +// Enterprise Support plan (http://aws.amazon.com/premiumsupport/enterprise-support/) +// . func (c *Client) AssociateDRTLogBucket(ctx context.Context, params *AssociateDRTLogBucketInput, optFns ...func(*Options)) (*AssociateDRTLogBucketOutput, error) { if params == nil { params = &AssociateDRTLogBucketInput{} diff --git a/service/shield/api_op_AssociateDRTRole.go b/service/shield/api_op_AssociateDRTRole.go index 14b46ea6838..c1e61668b40 100644 --- a/service/shield/api_op_AssociateDRTRole.go +++ b/service/shield/api_op_AssociateDRTRole.go @@ -13,30 +13,26 @@ import ( // Authorizes the Shield Response Team (SRT) using the specified role, to access // your Amazon Web Services account to assist with DDoS attack mitigation during // potential attacks. This enables the SRT to inspect your WAF configuration and -// create or update WAF rules and web ACLs. You can associate only one RoleArn with -// your subscription. If you submit an AssociateDRTRole request for an account that -// already has an associated role, the new RoleArn will replace the existing -// RoleArn. Prior to making the AssociateDRTRole request, you must attach the -// AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the -// request. You can access this policy in the IAM console at -// AWSShieldDRTAccessPolicy -// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy). -// For more information see Adding and removing IAM identity permissions -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). -// The role must also trust the service principal drt.shield.amazonaws.com. For -// more information, see IAM JSON policy elements: Principal -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). -// The SRT will have access only to your WAF and Shield resources. By submitting +// create or update WAF rules and web ACLs. You can associate only one RoleArn +// with your subscription. If you submit an AssociateDRTRole request for an +// account that already has an associated role, the new RoleArn will replace the +// existing RoleArn . Prior to making the AssociateDRTRole request, you must +// attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll +// specify in the request. You can access this policy in the IAM console at +// AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) +// . For more information see Adding and removing IAM identity permissions (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html) +// . The role must also trust the service principal drt.shield.amazonaws.com . For +// more information, see IAM JSON policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) +// . The SRT will have access only to your WAF and Shield resources. By submitting // this request, you authorize the SRT to inspect your WAF and Shield configuration // and create and update WAF rules and web ACLs on your behalf. The SRT takes these // actions only if explicitly authorized by you. You must have the iam:PassRole // permission to make an AssociateDRTRole request. For more information, see -// Granting a user permissions to pass a role to an Amazon Web Services service -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). -// To use the services of the SRT and make an AssociateDRTRole request, you must be -// subscribed to the Business Support plan -// (http://aws.amazon.com/premiumsupport/business-support/) or the Enterprise -// Support plan (http://aws.amazon.com/premiumsupport/enterprise-support/). +// Granting a user permissions to pass a role to an Amazon Web Services service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) +// . To use the services of the SRT and make an AssociateDRTRole request, you must +// be subscribed to the Business Support plan (http://aws.amazon.com/premiumsupport/business-support/) +// or the Enterprise Support plan (http://aws.amazon.com/premiumsupport/enterprise-support/) +// . func (c *Client) AssociateDRTRole(ctx context.Context, params *AssociateDRTRoleInput, optFns ...func(*Options)) (*AssociateDRTRoleOutput, error) { if params == nil { params = &AssociateDRTRoleInput{} @@ -56,11 +52,10 @@ type AssociateDRTRoleInput struct { // The Amazon Resource Name (ARN) of the role the SRT will use to access your // Amazon Web Services account. Prior to making the AssociateDRTRole request, you - // must attach the AWSShieldDRTAccessPolicy - // (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) + // must attach the AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) // managed policy to this role. For more information see Attaching and Detaching - // IAM Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). + // IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html) + // . // // This member is required. RoleArn *string diff --git a/service/shield/api_op_AssociateHealthCheck.go b/service/shield/api_op_AssociateHealthCheck.go index 7118a7df3b4..554e9630add 100644 --- a/service/shield/api_op_AssociateHealthCheck.go +++ b/service/shield/api_op_AssociateHealthCheck.go @@ -15,8 +15,7 @@ import ( // Services resource to improve responsiveness and accuracy in attack detection and // response. You define the health check in Route 53 and then associate it with // your Shield Advanced protection. For more information, see Shield Advanced -// Health-Based Detection -// (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) +// Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) // in the WAF Developer Guide. func (c *Client) AssociateHealthCheck(ctx context.Context, params *AssociateHealthCheckInput, optFns ...func(*Options)) (*AssociateHealthCheckOutput, error) { if params == nil { diff --git a/service/shield/api_op_AssociateProactiveEngagementDetails.go b/service/shield/api_op_AssociateProactiveEngagementDetails.go index 26bea908cee..6eac0da04c9 100644 --- a/service/shield/api_op_AssociateProactiveEngagementDetails.go +++ b/service/shield/api_op_AssociateProactiveEngagementDetails.go @@ -15,7 +15,7 @@ import ( // Response Team (SRT) to use. You must provide at least one phone number in the // emergency contact list. After you have initialized proactive engagement using // this call, to disable or enable proactive engagement, use the calls -// DisableProactiveEngagement and EnableProactiveEngagement. This call defines the +// DisableProactiveEngagement and EnableProactiveEngagement . This call defines the // list of email addresses and phone numbers that the SRT can use to contact you // for escalations to the SRT and to initiate proactive customer support. The // contacts that you provide in the request replace any contacts that were already diff --git a/service/shield/api_op_CreateProtection.go b/service/shield/api_op_CreateProtection.go index 8b7d6a9a7a4..d0e0a1502c6 100644 --- a/service/shield/api_op_CreateProtection.go +++ b/service/shield/api_op_CreateProtection.go @@ -19,12 +19,10 @@ import ( // addresses. You can add protection to only a single resource with each // CreateProtection request. You can add protection to multiple resources at once // through the Shield Advanced console at -// https://console.aws.amazon.com/wafv2/shieldv2#/ -// (https://console.aws.amazon.com/wafv2/shieldv2#/). For more information see -// Getting Started with Shield Advanced -// (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) -// and Adding Shield Advanced protection to Amazon Web Services resources -// (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html). +// https://console.aws.amazon.com/wafv2/shieldv2#/ (https://console.aws.amazon.com/wafv2/shieldv2#/) +// . For more information see Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) +// and Adding Shield Advanced protection to Amazon Web Services resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html) +// . func (c *Client) CreateProtection(ctx context.Context, params *CreateProtectionInput, optFns ...func(*Options)) (*CreateProtectionOutput, error) { if params == nil { params = &CreateProtectionInput{} @@ -49,27 +47,18 @@ type CreateProtectionInput struct { // The ARN (Amazon Resource Name) of the resource to be protected. The ARN should // be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Elastic Load Balancer (Classic Load Balancer): - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name - // - // * - // For an Amazon CloudFront distribution: - // arn:aws:cloudfront::account-id:distribution/distribution-id - // - // * For an Global - // Accelerator standard accelerator: - // arn:aws:globalaccelerator::account-id:accelerator/accelerator-id - // - // * For Amazon - // Route 53: arn:aws:route53:::hostedzone/hosted-zone-id - // - // * For an Elastic IP - // address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id + // - For an Elastic Load Balancer (Classic Load Balancer): + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name + // - For an Amazon CloudFront distribution: + // arn:aws:cloudfront::account-id:distribution/distribution-id + // - For an Global Accelerator standard accelerator: + // arn:aws:globalaccelerator::account-id:accelerator/accelerator-id + // - For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id + // - For an Elastic IP address: + // arn:aws:ec2:region:account-id:eip-allocation/allocation-id // // This member is required. ResourceArn *string diff --git a/service/shield/api_op_CreateProtectionGroup.go b/service/shield/api_op_CreateProtectionGroup.go index 4bd04ddf4a1..676dedaac6d 100644 --- a/service/shield/api_op_CreateProtectionGroup.go +++ b/service/shield/api_op_CreateProtectionGroup.go @@ -33,20 +33,16 @@ type CreateProtectionGroupInput struct { // Defines how Shield combines resource data for the group in order to detect, // mitigate, and report events. - // - // * Sum - Use the total traffic across the group. - // This is a good choice for most cases. Examples include Elastic IP addresses for - // EC2 instances that scale manually or automatically. - // - // * Mean - Use the average of - // the traffic across the group. This is a good choice for resources that share - // traffic uniformly. Examples include accelerators and load balancers. - // - // * Max - - // Use the highest traffic from each resource. This is useful for resources that - // don't share traffic and for resources that share that traffic in a non-uniform - // way. Examples include Amazon CloudFront and origin resources for CloudFront - // distributions. + // - Sum - Use the total traffic across the group. This is a good choice for + // most cases. Examples include Elastic IP addresses for EC2 instances that scale + // manually or automatically. + // - Mean - Use the average of the traffic across the group. This is a good + // choice for resources that share traffic uniformly. Examples include accelerators + // and load balancers. + // - Max - Use the highest traffic from each resource. This is useful for + // resources that don't share traffic and for resources that share that traffic in + // a non-uniform way. Examples include Amazon CloudFront and origin resources for + // CloudFront distributions. // // This member is required. Aggregation types.ProtectionGroupAggregation @@ -71,8 +67,8 @@ type CreateProtectionGroupInput struct { // it for any other Pattern setting. Members []string - // The resource type to include in the protection group. All protected resources of - // this type are included in the protection group. Newly protected resources of + // The resource type to include in the protection group. All protected resources + // of this type are included in the protection group. Newly protected resources of // this type are automatically added to the group. You must set this when you set // Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern // setting. diff --git a/service/shield/api_op_DeleteProtection.go b/service/shield/api_op_DeleteProtection.go index 2833c21e768..2527a807a75 100644 --- a/service/shield/api_op_DeleteProtection.go +++ b/service/shield/api_op_DeleteProtection.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Shield Advanced Protection. +// Deletes an Shield Advanced Protection . func (c *Client) DeleteProtection(ctx context.Context, params *DeleteProtectionInput, optFns ...func(*Options)) (*DeleteProtectionOutput, error) { if params == nil { params = &DeleteProtectionInput{} diff --git a/service/shield/api_op_DescribeAttackStatistics.go b/service/shield/api_op_DescribeAttackStatistics.go index 6c67e347ad4..e4e8e13289f 100644 --- a/service/shield/api_op_DescribeAttackStatistics.go +++ b/service/shield/api_op_DescribeAttackStatistics.go @@ -11,14 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the number and type of attacks Shield has detected in -// the last year for all resources that belong to your account, regardless of +// Provides information about the number and type of attacks Shield has detected +// in the last year for all resources that belong to your account, regardless of // whether you've defined Shield protections for them. This operation is available // to Shield customers as well as to Shield Advanced customers. The operation // returns data for the time range of midnight UTC, one year ago, to midnight UTC, -// today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to -// 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is -// from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC. The time range +// today. For example, if the current time is 2020-10-26 15:39:32 PDT , equal to +// 2020-10-26 22:39:32 UTC , then the time range for the attack data returned is +// from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC . The time range // indicates the period covered by the attack statistics data items. func (c *Client) DescribeAttackStatistics(ctx context.Context, params *DescribeAttackStatisticsInput, optFns ...func(*Options)) (*DescribeAttackStatisticsOutput, error) { if params == nil { diff --git a/service/shield/api_op_DisassociateHealthCheck.go b/service/shield/api_op_DisassociateHealthCheck.go index 386dbfca02a..c093adf1268 100644 --- a/service/shield/api_op_DisassociateHealthCheck.go +++ b/service/shield/api_op_DisassociateHealthCheck.go @@ -15,8 +15,7 @@ import ( // Web Services resource to improve responsiveness and accuracy in attack detection // and response. You define the health check in Route 53 and then associate or // disassociate it with your Shield Advanced protection. For more information, see -// Shield Advanced Health-Based Detection -// (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) +// Shield Advanced Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) // in the WAF Developer Guide. func (c *Client) DisassociateHealthCheck(ctx context.Context, params *DisassociateHealthCheckInput, optFns ...func(*Options)) (*DisassociateHealthCheckOutput, error) { if params == nil { diff --git a/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go b/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go index eaa29322509..2a236edb104 100644 --- a/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go +++ b/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go @@ -18,21 +18,18 @@ import ( // resource. Shield Advanced applies the rules in a Shield rule group inside the // web ACL that you've associated with the resource. For information about how // automatic mitigation works and the requirements for using it, see Shield -// Advanced automatic application layer DDoS mitigation -// (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html). -// Don't use this action to make changes to automatic mitigation settings when it's -// already enabled for a resource. Instead, use -// UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate -// a web ACL with the protected resource. The web ACL must be created using the -// latest version of WAF (v2). You can associate the web ACL through the Shield -// Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ -// (https://console.aws.amazon.com/wafv2/shieldv2#/). For more information, see -// Getting Started with Shield Advanced -// (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html). -// You can also associate the web ACL to the resource through the WAF console or +// Advanced automatic application layer DDoS mitigation (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html) +// . Don't use this action to make changes to automatic mitigation settings when +// it's already enabled for a resource. Instead, use +// UpdateApplicationLayerAutomaticResponse . To use this feature, you must +// associate a web ACL with the protected resource. The web ACL must be created +// using the latest version of WAF (v2). You can associate the web ACL through the +// Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ (https://console.aws.amazon.com/wafv2/shieldv2#/) +// . For more information, see Getting Started with Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) +// . You can also associate the web ACL to the resource through the WAF console or // the WAF API, but you must manage Shield Advanced automatic mitigation through -// Shield Advanced. For information about WAF, see WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// Shield Advanced. For information about WAF, see WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) EnableApplicationLayerAutomaticResponse(ctx context.Context, params *EnableApplicationLayerAutomaticResponseInput, optFns ...func(*Options)) (*EnableApplicationLayerAutomaticResponseOutput, error) { if params == nil { params = &EnableApplicationLayerAutomaticResponseInput{} diff --git a/service/shield/api_op_GetSubscriptionState.go b/service/shield/api_op_GetSubscriptionState.go index 534715a3ecc..a31a2d9b86b 100644 --- a/service/shield/api_op_GetSubscriptionState.go +++ b/service/shield/api_op_GetSubscriptionState.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the SubscriptionState, either Active or Inactive. +// Returns the SubscriptionState , either Active or Inactive . func (c *Client) GetSubscriptionState(ctx context.Context, params *GetSubscriptionStateInput, optFns ...func(*Options)) (*GetSubscriptionStateOutput, error) { if params == nil { params = &GetSubscriptionStateInput{} diff --git a/service/shield/api_op_ListAttacks.go b/service/shield/api_op_ListAttacks.go index 66a1443f446..8d42ffccdce 100644 --- a/service/shield/api_op_ListAttacks.go +++ b/service/shield/api_op_ListAttacks.go @@ -33,8 +33,7 @@ type ListAttacksInput struct { // The end of the time period for the attacks. This is a timestamp type. The // request syntax listing for this call indicates a number type, but you can - // provide the time in any valid timestamp format - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) + // provide the time in any valid timestamp format (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) // setting. EndTime *types.TimeRange @@ -64,8 +63,7 @@ type ListAttacksInput struct { // The start of the time period for the attacks. This is a timestamp type. The // request syntax listing for this call indicates a number type, but you can - // provide the time in any valid timestamp format - // (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) + // provide the time in any valid timestamp format (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) // setting. StartTime *types.TimeRange diff --git a/service/shield/api_op_ListProtectionGroups.go b/service/shield/api_op_ListProtectionGroups.go index a879e2c4ada..449b1ee29d1 100644 --- a/service/shield/api_op_ListProtectionGroups.go +++ b/service/shield/api_op_ListProtectionGroups.go @@ -32,8 +32,8 @@ func (c *Client) ListProtectionGroups(ctx context.Context, params *ListProtectio type ListProtectionGroupsInput struct { - // Narrows the set of protection groups that the call retrieves. You can retrieve a - // single protection group by its name and you can retrieve all protection groups + // Narrows the set of protection groups that the call retrieves. You can retrieve + // a single protection group by its name and you can retrieve all protection groups // that are configured with specific pattern or aggregation settings. You can // provide up to one criteria per filter type. Shield Advanced returns the // protection groups that exactly match all of the search criteria that you diff --git a/service/shield/api_op_UpdateProtectionGroup.go b/service/shield/api_op_UpdateProtectionGroup.go index 8c98f0e72d3..51f18a68f15 100644 --- a/service/shield/api_op_UpdateProtectionGroup.go +++ b/service/shield/api_op_UpdateProtectionGroup.go @@ -33,20 +33,16 @@ type UpdateProtectionGroupInput struct { // Defines how Shield combines resource data for the group in order to detect, // mitigate, and report events. - // - // * Sum - Use the total traffic across the group. - // This is a good choice for most cases. Examples include Elastic IP addresses for - // EC2 instances that scale manually or automatically. - // - // * Mean - Use the average of - // the traffic across the group. This is a good choice for resources that share - // traffic uniformly. Examples include accelerators and load balancers. - // - // * Max - - // Use the highest traffic from each resource. This is useful for resources that - // don't share traffic and for resources that share that traffic in a non-uniform - // way. Examples include Amazon CloudFront distributions and origin resources for - // CloudFront distributions. + // - Sum - Use the total traffic across the group. This is a good choice for + // most cases. Examples include Elastic IP addresses for EC2 instances that scale + // manually or automatically. + // - Mean - Use the average of the traffic across the group. This is a good + // choice for resources that share traffic uniformly. Examples include accelerators + // and load balancers. + // - Max - Use the highest traffic from each resource. This is useful for + // resources that don't share traffic and for resources that share that traffic in + // a non-uniform way. Examples include Amazon CloudFront distributions and origin + // resources for CloudFront distributions. // // This member is required. Aggregation types.ProtectionGroupAggregation @@ -71,9 +67,9 @@ type UpdateProtectionGroupInput struct { // it for any other Pattern setting. Members []string - // The resource type to include in the protection group. All protected resources of - // this type are included in the protection group. You must set this when you set - // Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern + // The resource type to include in the protection group. All protected resources + // of this type are included in the protection group. You must set this when you + // set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern // setting. ResourceType types.ProtectedResourceType diff --git a/service/shield/api_op_UpdateSubscription.go b/service/shield/api_op_UpdateSubscription.go index 7855ad12bd8..b6b6ddfe8b9 100644 --- a/service/shield/api_op_UpdateSubscription.go +++ b/service/shield/api_op_UpdateSubscription.go @@ -33,11 +33,11 @@ func (c *Client) UpdateSubscription(ctx context.Context, params *UpdateSubscript type UpdateSubscriptionInput struct { - // When you initally create a subscription, AutoRenew is set to ENABLED. If - // ENABLED, the subscription will be automatically renewed at the end of the + // When you initally create a subscription, AutoRenew is set to ENABLED . If + // ENABLED , the subscription will be automatically renewed at the end of the // existing subscription period. You can change this by submitting an // UpdateSubscription request. If the UpdateSubscription request does not included - // a value for AutoRenew, the existing value for AutoRenew remains unchanged. + // a value for AutoRenew , the existing value for AutoRenew remains unchanged. AutoRenew types.AutoRenew noSmithyDocumentSerde diff --git a/service/shield/doc.go b/service/shield/doc.go index 999865fb971..9e110fcdaa4 100644 --- a/service/shield/doc.go +++ b/service/shield/doc.go @@ -7,6 +7,6 @@ // developers who need detailed information about the Shield Advanced API actions, // data types, and errors. For detailed information about WAF and Shield Advanced // features and an overview of how to use the WAF and Shield Advanced APIs, see the -// WAF and Shield Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// WAF and Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . package shield diff --git a/service/shield/types/enums.go b/service/shield/types/enums.go index 4773d6f2176..d0bd71e9a55 100644 --- a/service/shield/types/enums.go +++ b/service/shield/types/enums.go @@ -53,9 +53,9 @@ const ( AttackPropertyIdentifierWordpressPingbackSource AttackPropertyIdentifier = "WORDPRESS_PINGBACK_SOURCE" ) -// Values returns all known values for AttackPropertyIdentifier. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AttackPropertyIdentifier. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AttackPropertyIdentifier) Values() []AttackPropertyIdentifier { return []AttackPropertyIdentifier{ "DESTINATION_URL", @@ -77,9 +77,9 @@ const ( AutoRenewDisabled AutoRenew = "DISABLED" ) -// Values returns all known values for AutoRenew. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AutoRenew. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AutoRenew) Values() []AutoRenew { return []AutoRenew{ "ENABLED", @@ -119,8 +119,8 @@ const ( ProtectedResourceTypeGlobalAccelerator ProtectedResourceType = "GLOBAL_ACCELERATOR" ) -// Values returns all known values for ProtectedResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ProtectedResourceType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ProtectedResourceType) Values() []ProtectedResourceType { return []ProtectedResourceType{ diff --git a/service/shield/types/errors.go b/service/shield/types/errors.go index 26d993b4f0e..99a2eb18a47 100644 --- a/service/shield/types/errors.go +++ b/service/shield/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// Exception that indicates the specified AttackId does not exist, or the requester -// does not have the appropriate permissions to access the AttackId. +// Exception that indicates the specified AttackId does not exist, or the +// requester does not have the appropriate permissions to access the AttackId . type AccessDeniedException struct { Message *string @@ -38,8 +38,8 @@ func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.F // user submitting the request must have the iam:PassRole permission. This error // indicates the user did not have the appropriate permissions. For more // information, see Granting a User Permissions to Pass a Role to an Amazon Web -// Services Service -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). +// Services Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) +// . type AccessDeniedForDependencyException struct { Message *string @@ -120,9 +120,9 @@ func (e *InvalidOperationException) ErrorCode() string { } func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Exception that indicates that the NextToken specified in the request is invalid. -// Submit the request using the NextToken value that was returned in the prior -// response. +// Exception that indicates that the NextToken specified in the request is +// invalid. Submit the request using the NextToken value that was returned in the +// prior response. type InvalidPaginationTokenException struct { Message *string @@ -178,8 +178,8 @@ func (e *InvalidParameterException) ErrorCode() string { } func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Exception that indicates that the resource is invalid. You might not have access -// to the resource, or the resource might not exist. +// Exception that indicates that the resource is invalid. You might not have +// access to the resource, or the resource might not exist. type InvalidResourceException struct { Message *string diff --git a/service/shield/types/types.go b/service/shield/types/types.go index 1c25f9d7c98..5b7782e78c4 100644 --- a/service/shield/types/types.go +++ b/service/shield/types/types.go @@ -7,7 +7,7 @@ import ( "time" ) -// The automatic application layer DDoS mitigation settings for a Protection. This +// The automatic application layer DDoS mitigation settings for a Protection . This // configuration determines whether Shield Advanced automatically manages rules in // the web ACL in order to respond to application layer events that Shield Advanced // determines to be DDoS attacks. @@ -23,8 +23,8 @@ type ApplicationLayerAutomaticResponseConfiguration struct { // This member is required. Action *ResponseAction - // Indicates whether automatic application layer DDoS mitigation is enabled for the - // protection. + // Indicates whether automatic application layer DDoS mitigation is enabled for + // the protection. // // This member is required. Status ApplicationLayerAutomaticResponseStatus @@ -44,8 +44,7 @@ type AttackDetail struct { // The array of objects that provide details of the Shield event. For // infrastructure layer events (L3 and L4 events), you can view metrics for top // contributors in Amazon CloudWatch metrics. For more information, see Shield - // metrics and alarms - // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) + // metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) // in the WAF Developer Guide. AttackProperties []AttackProperty @@ -61,27 +60,26 @@ type AttackDetail struct { // The time the attack started, in Unix time in seconds. StartTime *time.Time - // If applicable, additional detail about the resource being attacked, for example, - // IP address or URL. + // If applicable, additional detail about the resource being attacked, for + // example, IP address or URL. SubResources []SubResourceSummary noSmithyDocumentSerde } -// Details of a Shield event. This is provided as part of an AttackDetail. +// Details of a Shield event. This is provided as part of an AttackDetail . type AttackProperty struct { // The type of Shield event that was observed. NETWORK indicates layer 3 and layer // 4 events and APPLICATION indicates layer 7 events. For infrastructure layer // events (L3 and L4 events), you can view metrics for top contributors in Amazon - // CloudWatch metrics. For more information, see Shield metrics and alarms - // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) + // CloudWatch metrics. For more information, see Shield metrics and alarms (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms) // in the WAF Developer Guide. AttackLayer AttackLayer // Defines the Shield event property information that is provided. The - // WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only - // for WordPress reflective pingback events. + // WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid + // only for WordPress reflective pingback events. AttackPropertyIdentifier AttackPropertyIdentifier // Contributor objects for the top five contributors to a Shield event. A @@ -92,7 +90,7 @@ type AttackProperty struct { // The total contributions made to this Shield event by all contributors. Total int64 - // The unit used for the ContributorValue property. + // The unit used for the Contributor Value property. Unit Unit noSmithyDocumentSerde @@ -141,47 +139,24 @@ type AttackSummary struct { type AttackVectorDescription struct { // The attack type. Valid values: - // - // * UDP_TRAFFIC - // - // * UDP_FRAGMENT - // - // * - // GENERIC_UDP_REFLECTION - // - // * DNS_REFLECTION - // - // * NTP_REFLECTION - // - // * - // CHARGEN_REFLECTION - // - // * SSDP_REFLECTION - // - // * PORT_MAPPER - // - // * RIP_REFLECTION - // - // * - // SNMP_REFLECTION - // - // * MSSQL_REFLECTION - // - // * NET_BIOS_REFLECTION - // - // * SYN_FLOOD - // - // * - // ACK_FLOOD - // - // * REQUEST_FLOOD - // - // * HTTP_REFLECTION - // - // * UDS_REFLECTION - // - // * - // MEMCACHED_REFLECTION + // - UDP_TRAFFIC + // - UDP_FRAGMENT + // - GENERIC_UDP_REFLECTION + // - DNS_REFLECTION + // - NTP_REFLECTION + // - CHARGEN_REFLECTION + // - SSDP_REFLECTION + // - PORT_MAPPER + // - RIP_REFLECTION + // - SNMP_REFLECTION + // - MSSQL_REFLECTION + // - NET_BIOS_REFLECTION + // - SYN_FLOOD + // - ACK_FLOOD + // - REQUEST_FLOOD + // - HTTP_REFLECTION + // - UDS_REFLECTION + // - MEMCACHED_REFLECTION // // This member is required. VectorType *string @@ -190,7 +165,7 @@ type AttackVectorDescription struct { } // Information about the volume of attacks during the time period, included in an -// AttackStatisticsDataItem. If the accompanying AttackCount in the statistics +// AttackStatisticsDataItem . If the accompanying AttackCount in the statistics // object is zero, this setting might be empty. type AttackVolume struct { @@ -210,7 +185,7 @@ type AttackVolume struct { noSmithyDocumentSerde } -// Statistics objects for the various data types in AttackVolume. +// Statistics objects for the various data types in AttackVolume . type AttackVolumeStatistics struct { // The maximum attack volume observed for the given unit. @@ -234,11 +209,11 @@ type Contributor struct { // The name of the contributor. The type of name that you'll find here depends on // the AttackPropertyIdentifier setting in the AttackProperty where this // contributor is defined. For example, if the AttackPropertyIdentifier is - // SOURCE_COUNTRY, the Name could be United States. + // SOURCE_COUNTRY , the Name could be United States . Name *string // The contribution of this contributor expressed in Protection units. For example - // 10,000. + // 10,000 . Value int64 noSmithyDocumentSerde @@ -291,8 +266,8 @@ type InclusionProtectionFilters struct { noSmithyDocumentSerde } -// Narrows the set of protection groups that the call retrieves. You can retrieve a -// single protection group by its name and you can retrieve all protection groups +// Narrows the set of protection groups that the call retrieves. You can retrieve +// a single protection group by its name and you can retrieve all protection groups // that are configured with a specific pattern, aggregation, or resource type. You // can provide up to one criteria per filter type. Shield Advanced returns the // protection groups that exactly match all of the search criteria that you @@ -310,7 +285,7 @@ type InclusionProtectionGroupFilters struct { // The resource type configuration of the protection groups that you want to // retrieve. In the protection group configuration, you specify the resource type - // when you set the group's Pattern to BY_RESOURCE_TYPE. + // when you set the group's Pattern to BY_RESOURCE_TYPE . ResourceTypes []ProtectedResourceType noSmithyDocumentSerde @@ -319,7 +294,7 @@ type InclusionProtectionGroupFilters struct { // Specifies how many protections of a given type you can create. type Limit struct { - // The maximum number of protections that can be created for the specified Type. + // The maximum number of protections that can be created for the specified Type . Max int64 // The type of protection. @@ -353,7 +328,7 @@ type Protection struct { // The unique identifier (ID) of the protection. Id *string - // The name of the protection. For example, My CloudFront distributions. + // The name of the protection. For example, My CloudFront distributions . Name *string // The ARN (Amazon Resource Name) of the protection. @@ -373,20 +348,16 @@ type ProtectionGroup struct { // Defines how Shield combines resource data for the group in order to detect, // mitigate, and report events. - // - // * Sum - Use the total traffic across the group. - // This is a good choice for most cases. Examples include Elastic IP addresses for - // EC2 instances that scale manually or automatically. - // - // * Mean - Use the average of - // the traffic across the group. This is a good choice for resources that share - // traffic uniformly. Examples include accelerators and load balancers. - // - // * Max - - // Use the highest traffic from each resource. This is useful for resources that - // don't share traffic and for resources that share that traffic in a non-uniform - // way. Examples include Amazon CloudFront distributions and origin resources for - // CloudFront distributions. + // - Sum - Use the total traffic across the group. This is a good choice for + // most cases. Examples include Elastic IP addresses for EC2 instances that scale + // manually or automatically. + // - Mean - Use the average of the traffic across the group. This is a good + // choice for resources that share traffic uniformly. Examples include accelerators + // and load balancers. + // - Max - Use the highest traffic from each resource. This is useful for + // resources that don't share traffic and for resources that share that traffic in + // a non-uniform way. Examples include Amazon CloudFront distributions and origin + // resources for CloudFront distributions. // // This member is required. Aggregation ProtectionGroupAggregation @@ -416,9 +387,9 @@ type ProtectionGroup struct { // The ARN (Amazon Resource Name) of the protection group. ProtectionGroupArn *string - // The resource type to include in the protection group. All protected resources of - // this type are included in the protection group. You must set this when you set - // Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern + // The resource type to include in the protection group. All protected resources + // of this type are included in the protection group. You must set this when you + // set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern // setting. ResourceType ProtectedResourceType @@ -484,11 +455,11 @@ type ProtectionLimits struct { type ResponseAction struct { // Specifies that Shield Advanced should configure its WAF rules with the WAF Block - // action. You must specify exactly one action, either Block or Count. + // action. You must specify exactly one action, either Block or Count . Block *BlockAction // Specifies that Shield Advanced should configure its WAF rules with the WAF Count - // action. You must specify exactly one action, either Block or Count. + // action. You must specify exactly one action, either Block or Count . Count *CountAction noSmithyDocumentSerde @@ -503,7 +474,7 @@ type SubResourceSummary struct { // The counters that describe the details of the attack. Counters []SummarizedCounter - // The unique identifier (ID) of the SubResource. + // The unique identifier (ID) of the SubResource . Id *string // The SubResource type. @@ -520,11 +491,11 @@ type Subscription struct { // This member is required. SubscriptionLimits *SubscriptionLimits - // If ENABLED, the subscription will be automatically renewed at the end of the + // If ENABLED , the subscription will be automatically renewed at the end of the // existing subscription period. When you initally create a subscription, AutoRenew - // is set to ENABLED. You can change this by submitting an UpdateSubscription + // is set to ENABLED . You can change this by submitting an UpdateSubscription // request. If the UpdateSubscription request does not included a value for - // AutoRenew, the existing value for AutoRenew remains unchanged. + // AutoRenew , the existing value for AutoRenew remains unchanged. AutoRenew AutoRenew // The date and time your subscription will end. @@ -533,11 +504,11 @@ type Subscription struct { // Specifies how many protections of a given type you can create. Limits []Limit - // If ENABLED, the Shield Response Team (SRT) will use email and phone to notify + // If ENABLED , the Shield Response Team (SRT) will use email and phone to notify // contacts about escalations to the SRT and to initiate proactive customer - // support. If PENDING, you have requested proactive engagement and the request is + // support. If PENDING , you have requested proactive engagement and the request is // pending. The status changes to ENABLED when your request is fully processed. If - // DISABLED, the SRT will not proactively notify contacts about escalations or to + // DISABLED , the SRT will not proactively notify contacts about escalations or to // initiate proactive customer support. ProactiveEngagementStatus ProactiveEngagementStatus @@ -617,8 +588,9 @@ type SummarizedCounter struct { // a resource. type Tag struct { - // Part of the key:value pair that defines a tag. You can use a tag key to describe - // a category of information, such as "customer." Tag keys are case-sensitive. + // Part of the key:value pair that defines a tag. You can use a tag key to + // describe a category of information, such as "customer." Tag keys are + // case-sensitive. Key *string // Part of the key:value pair that defines a tag. You can use a tag value to diff --git a/service/signer/api_client.go b/service/signer/api_client.go index 59848c3cd42..70cfbcf0eb5 100644 --- a/service/signer/api_client.go +++ b/service/signer/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/signer/api_op_CancelSigningProfile.go b/service/signer/api_op_CancelSigningProfile.go index f0f63fa802e..642c4a5e62a 100644 --- a/service/signer/api_op_CancelSigningProfile.go +++ b/service/signer/api_op_CancelSigningProfile.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile +// Changes the state of an ACTIVE signing profile to CANCELED . A canceled profile // is still viewable with the ListSigningProfiles operation, but it cannot perform // new signing jobs, and is deleted two years after cancelation. func (c *Client) CancelSigningProfile(ctx context.Context, params *CancelSigningProfileInput, optFns ...func(*Options)) (*CancelSigningProfileOutput, error) { diff --git a/service/signer/api_op_DescribeSigningJob.go b/service/signer/api_op_DescribeSigningJob.go index d798a786d7d..50149156eab 100644 --- a/service/signer/api_op_DescribeSigningJob.go +++ b/service/signer/api_op_DescribeSigningJob.go @@ -198,9 +198,10 @@ type SuccessfulSigningJobWaiterOptions struct { // that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, SuccessfulSigningJobWaiter will use default max delay of 120 seconds. - // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, SuccessfulSigningJobWaiter will use default max delay of 120 + // seconds. Note that MaxDelay must resolve to value greater than or equal to the + // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/signer/api_op_ListSigningProfiles.go b/service/signer/api_op_ListSigningProfiles.go index 693291854bd..bf2e1e15189 100644 --- a/service/signer/api_op_ListSigningProfiles.go +++ b/service/signer/api_op_ListSigningProfiles.go @@ -13,7 +13,7 @@ import ( ) // Lists all available signing profiles in your AWS account. Returns only profiles -// with an ACTIVE status unless the includeCanceled request field is set to true. +// with an ACTIVE status unless the includeCanceled request field is set to true . // If additional jobs remain to be listed, code signing returns a nextToken value. // Use this value in subsequent calls to ListSigningJobs to fetch the remaining // values. You can continue calling ListSigningJobs with your maxResults parameter @@ -36,7 +36,7 @@ func (c *Client) ListSigningProfiles(ctx context.Context, params *ListSigningPro type ListSigningProfilesInput struct { - // Designates whether to include profiles with the status of CANCELED. + // Designates whether to include profiles with the status of CANCELED . IncludeCanceled bool // The maximum number of profiles to be returned. @@ -63,8 +63,9 @@ type ListSigningProfilesOutput struct { // Value for specifying the next set of paginated results to return. NextToken *string - // A list of profiles that are available in the AWS account. This includes profiles - // with the status of CANCELED if the includeCanceled parameter is set to true. + // A list of profiles that are available in the AWS account. This includes + // profiles with the status of CANCELED if the includeCanceled parameter is set to + // true . Profiles []types.SigningProfile // Metadata pertaining to the operation's result. @@ -133,8 +134,8 @@ func (c *Client) addOperationListSigningProfilesMiddlewares(stack *middleware.St return nil } -// ListSigningProfilesAPIClient is a client that implements the ListSigningProfiles -// operation. +// ListSigningProfilesAPIClient is a client that implements the +// ListSigningProfiles operation. type ListSigningProfilesAPIClient interface { ListSigningProfiles(context.Context, *ListSigningProfilesInput, ...func(*Options)) (*ListSigningProfilesOutput, error) } diff --git a/service/signer/api_op_PutSigningProfile.go b/service/signer/api_op_PutSigningProfile.go index e567475a29a..be4ce39eb32 100644 --- a/service/signer/api_op_PutSigningProfile.go +++ b/service/signer/api_op_PutSigningProfile.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a signing profile. A signing profile is a code signing template that can -// be used to carry out a pre-defined signing job. For more information, see -// http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html -// (http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html) +// Creates a signing profile. A signing profile is a code signing template that +// can be used to carry out a pre-defined signing job. For more information, see +// http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html (http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html) func (c *Client) PutSigningProfile(ctx context.Context, params *PutSigningProfileInput, optFns ...func(*Options)) (*PutSigningProfileOutput, error) { if params == nil { params = &PutSigningProfileInput{} @@ -42,9 +41,9 @@ type PutSigningProfileInput struct { // This member is required. ProfileName *string - // A subfield of platform. This specifies any different configuration options that + // A subfield of platform . This specifies any different configuration options that // you want to apply to the chosen platform (such as a different hash-algorithm or - // signing-algorithm). + // signing-algorithm ). Overrides *types.SigningPlatformOverrides // The default validity period override for any signature generated using this diff --git a/service/signer/api_op_RevokeSignature.go b/service/signer/api_op_RevokeSignature.go index 6eccd1186d0..e9b124d65f3 100644 --- a/service/signer/api_op_RevokeSignature.go +++ b/service/signer/api_op_RevokeSignature.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the state of a signing job to REVOKED. This indicates that the signature -// is no longer valid. +// Changes the state of a signing job to REVOKED. This indicates that the +// signature is no longer valid. func (c *Client) RevokeSignature(ctx context.Context, params *RevokeSignatureInput, optFns ...func(*Options)) (*RevokeSignatureOutput, error) { if params == nil { params = &RevokeSignatureInput{} diff --git a/service/signer/api_op_StartSigningJob.go b/service/signer/api_op_StartSigningJob.go index 42a4a1725c6..8f4482e70b3 100644 --- a/service/signer/api_op_StartSigningJob.go +++ b/service/signer/api_op_StartSigningJob.go @@ -15,29 +15,20 @@ import ( // Initiates a signing job to be performed on the code provided. Signing jobs are // viewable by the ListSigningJobs operation for two years after they are // performed. Note the following requirements: +// - You must create an Amazon S3 source bucket. For more information, see +// Create a Bucket (http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) +// in the Amazon S3 Getting Started Guide. +// - Your S3 source bucket must be version enabled. +// - You must create an S3 destination bucket. Code signing uses your S3 +// destination bucket to write your signed code. +// - You specify the name of the source and destination buckets when calling the +// StartSigningJob operation. +// - You must also specify a request token that identifies your request to code +// signing. // -// * You must create an Amazon S3 -// source bucket. For more information, see Create a Bucket -// (http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) in the -// Amazon S3 Getting Started Guide. -// -// * Your S3 source bucket must be version -// enabled. -// -// * You must create an S3 destination bucket. Code signing uses your S3 -// destination bucket to write your signed code. -// -// * You specify the name of the -// source and destination buckets when calling the StartSigningJob operation. -// -// * -// You must also specify a request token that identifies your request to code -// signing. -// -// You can call the DescribeSigningJob and the ListSigningJobs actions -// after you call StartSigningJob. For a Java example that shows how to use this -// action, see http://docs.aws.amazon.com/acm/latest/userguide/ -// (http://docs.aws.amazon.com/acm/latest/userguide/) +// You can call the DescribeSigningJob and the ListSigningJobs actions after you +// call StartSigningJob . For a Java example that shows how to use this action, see +// http://docs.aws.amazon.com/acm/latest/userguide/ (http://docs.aws.amazon.com/acm/latest/userguide/) func (c *Client) StartSigningJob(ctx context.Context, params *StartSigningJobInput, optFns ...func(*Options)) (*StartSigningJobOutput, error) { if params == nil { params = &StartSigningJobInput{} diff --git a/service/signer/doc.go b/service/signer/doc.go index f4efdb53176..c054f9a08bc 100644 --- a/service/signer/doc.go +++ b/service/signer/doc.go @@ -11,12 +11,10 @@ // Signer to sign Lambda zip files in S3. With code signing for IoT, you can sign // code for any IoT device that is supported by AWS. IoT code signing is available // for Amazon FreeRTOS (http://docs.aws.amazon.com/freertos/latest/userguide/) and -// AWS IoT Device Management -// (http://docs.aws.amazon.com/iot/latest/developerguide/), and is integrated with -// AWS Certificate Manager (ACM) -// (http://docs.aws.amazon.com/acm/latest/userguide/). In order to sign code, you -// import a third-party code signing certificate using ACM, and use that to sign -// updates in Amazon FreeRTOS and AWS IoT Device Management. For more information -// about AWS Signer, see the AWS Signer Developer Guide -// (http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html). +// AWS IoT Device Management (http://docs.aws.amazon.com/iot/latest/developerguide/) +// , and is integrated with AWS Certificate Manager (ACM) (http://docs.aws.amazon.com/acm/latest/userguide/) +// . In order to sign code, you import a third-party code signing certificate using +// ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device +// Management. For more information about AWS Signer, see the AWS Signer Developer +// Guide (http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html) . package signer diff --git a/service/signer/types/enums.go b/service/signer/types/enums.go index ecc20891319..6478368a501 100644 --- a/service/signer/types/enums.go +++ b/service/signer/types/enums.go @@ -123,9 +123,9 @@ const ( ValidityTypeYears ValidityType = "YEARS" ) -// Values returns all known values for ValidityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ValidityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ValidityType) Values() []ValidityType { return []ValidityType{ "DAYS", diff --git a/service/signer/types/errors.go b/service/signer/types/errors.go index a390a919b0a..68d483d3950 100644 --- a/service/signer/types/errors.go +++ b/service/signer/types/errors.go @@ -35,8 +35,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request contains invalid parameters for the ARN or tags. This exception also -// occurs when you call a tagging API on a cancelled signing profile. +// The request contains invalid parameters for the ARN or tags. This exception +// also occurs when you call a tagging API on a cancelled signing profile. type BadRequestException struct { Message *string @@ -234,7 +234,7 @@ func (e *ThrottlingException) ErrorCode() string { func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The allowed number of job-signing requests has been exceeded. This error -// supersedes the error ThrottlingException. +// supersedes the error ThrottlingException . type TooManyRequestsException struct { Message *string diff --git a/service/signer/types/types.go b/service/signer/types/types.go index b9e78993479..5c59d084560 100644 --- a/service/signer/types/types.go +++ b/service/signer/types/types.go @@ -75,8 +75,8 @@ type S3Destination struct { // Name of the S3 bucket. BucketName *string - // An Amazon S3 prefix that you can use to limit responses to those that begin with - // the specified prefix. + // An Amazon S3 prefix that you can use to limit responses to those that begin + // with the specified prefix. Prefix *string noSmithyDocumentSerde @@ -131,7 +131,7 @@ type SignatureValidityPeriod struct { // code image. type SignedObject struct { - // The S3SignedObject. + // The S3SignedObject . S3 *S3SignedObject noSmithyDocumentSerde @@ -306,9 +306,9 @@ type SigningPlatformOverrides struct { // A signed image is a JSON object. When overriding the default signing platform // configuration, a customer can select either of two signing formats, JSONEmbedded - // or JSONDetached. (A third format value, JSON, is reserved for future use.) With - // JSONEmbedded, the signing image has the payload embedded in it. With - // JSONDetached, the payload is not be embedded in the signing image. + // or JSONDetached . (A third format value, JSON , is reserved for future use.) + // With JSONEmbedded , the signing image has the payload embedded in it. With + // JSONDetached , the payload is not be embedded in the signing image. SigningImageFormat ImageFormat noSmithyDocumentSerde @@ -369,8 +369,8 @@ type SigningProfileRevocationRecord struct { noSmithyDocumentSerde } -// An S3Source object that contains information about the S3 bucket where you saved -// your unsigned code. +// An S3Source object that contains information about the S3 bucket where you +// saved your unsigned code. type Source struct { // The S3Source object. diff --git a/service/simspaceweaver/api_client.go b/service/simspaceweaver/api_client.go index 43bfd3fae82..a5f2adbaa24 100644 --- a/service/simspaceweaver/api_client.go +++ b/service/simspaceweaver/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/simspaceweaver/api_op_DescribeSimulation.go b/service/simspaceweaver/api_op_DescribeSimulation.go index 39bd648e3d5..6cd42026158 100644 --- a/service/simspaceweaver/api_op_DescribeSimulation.go +++ b/service/simspaceweaver/api_op_DescribeSimulation.go @@ -41,13 +41,12 @@ type DescribeSimulationInput struct { type DescribeSimulationOutput struct { // The Amazon Resource Name (ARN) of the simulation. For more information about - // ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string - // The time when the simulation was created, expressed as the number of seconds and - // milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). + // The time when the simulation was created, expressed as the number of seconds + // and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). CreationTime *time.Time // The description of the simulation. @@ -73,10 +72,9 @@ type DescribeSimulationOutput struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // that the simulation assumes to perform actions. For more information about ARNs, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. For more information about IAM roles, - // see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. For more information about IAM + // roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) // in the Identity and Access Management User Guide. RoleArn *string @@ -85,9 +83,9 @@ type DescribeSimulationOutput struct { SchemaError *string // The location of the simulation schema in Amazon Simple Storage Service (Amazon - // S3). For more information about Amazon S3, see the Amazon Simple Storage - // Service User Guide - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html). + // S3). For more information about Amazon S3, see the Amazon Simple Storage + // Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) + // . SchemaS3Location *types.S3Location // The current lifecycle state of the simulation. diff --git a/service/simspaceweaver/api_op_ListApps.go b/service/simspaceweaver/api_op_ListApps.go index 6880de5c0e4..c904eb91bfd 100644 --- a/service/simspaceweaver/api_op_ListApps.go +++ b/service/simspaceweaver/api_op_ListApps.go @@ -41,10 +41,10 @@ type ListAppsInput struct { // The maximum number of apps to list. MaxResults *int32 - // If SimSpace Weaver returns nextToken, there are more results available. The + // If SimSpace Weaver returns nextToken , there are more results available. The // value of nextToken is a unique pagination token for each page. To retrieve the // next page, call the operation again using the returned token. Keep all other - // arguments unchanged. If no results remain, nextToken is set to null. Each + // arguments unchanged. If no results remain, nextToken is set to null . Each // pagination token expires after 24 hours. If you provide a token that isn't // valid, you receive an HTTP 400 ValidationException error. NextToken *string @@ -57,10 +57,10 @@ type ListAppsOutput struct { // The list of apps for the given simulation and domain. Apps []types.SimulationAppMetadata - // If SimSpace Weaver returns nextToken, there are more results available. The + // If SimSpace Weaver returns nextToken , there are more results available. The // value of nextToken is a unique pagination token for each page. To retrieve the // next page, call the operation again using the returned token. Keep all other - // arguments unchanged. If no results remain, nextToken is set to null. Each + // arguments unchanged. If no results remain, nextToken is set to null . Each // pagination token expires after 24 hours. If you provide a token that isn't // valid, you receive an HTTP 400 ValidationException error. NextToken *string diff --git a/service/simspaceweaver/api_op_ListSimulations.go b/service/simspaceweaver/api_op_ListSimulations.go index 7dac8a20583..17d7da4b9c1 100644 --- a/service/simspaceweaver/api_op_ListSimulations.go +++ b/service/simspaceweaver/api_op_ListSimulations.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the SimSpace Weaver simulations in the Amazon Web Services account used to -// make the API call. +// Lists the SimSpace Weaver simulations in the Amazon Web Services account used +// to make the API call. func (c *Client) ListSimulations(ctx context.Context, params *ListSimulationsInput, optFns ...func(*Options)) (*ListSimulationsOutput, error) { if params == nil { params = &ListSimulationsInput{} @@ -34,10 +34,10 @@ type ListSimulationsInput struct { // The maximum number of simulations to list. MaxResults *int32 - // If SimSpace Weaver returns nextToken, there are more results available. The + // If SimSpace Weaver returns nextToken , there are more results available. The // value of nextToken is a unique pagination token for each page. To retrieve the // next page, call the operation again using the returned token. Keep all other - // arguments unchanged. If no results remain, nextToken is set to null. Each + // arguments unchanged. If no results remain, nextToken is set to null . Each // pagination token expires after 24 hours. If you provide a token that isn't // valid, you receive an HTTP 400 ValidationException error. NextToken *string @@ -47,10 +47,10 @@ type ListSimulationsInput struct { type ListSimulationsOutput struct { - // If SimSpace Weaver returns nextToken, there are more results available. The + // If SimSpace Weaver returns nextToken , there are more results available. The // value of nextToken is a unique pagination token for each page. To retrieve the // next page, call the operation again using the returned token. Keep all other - // arguments unchanged. If no results remain, nextToken is set to null. Each + // arguments unchanged. If no results remain, nextToken is set to null . Each // pagination token expires after 24 hours. If you provide a token that isn't // valid, you receive an HTTP 400 ValidationException error. NextToken *string diff --git a/service/simspaceweaver/api_op_ListTagsForResource.go b/service/simspaceweaver/api_op_ListTagsForResource.go index aadd836de2c..f3526034675 100644 --- a/service/simspaceweaver/api_op_ListTagsForResource.go +++ b/service/simspaceweaver/api_op_ListTagsForResource.go @@ -28,10 +28,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. For more information about ARNs, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // The Amazon Resource Name (ARN) of the resource. For more information about + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/api_op_StartSimulation.go b/service/simspaceweaver/api_op_StartSimulation.go index a9290fd2dec..f598512b6f2 100644 --- a/service/simspaceweaver/api_op_StartSimulation.go +++ b/service/simspaceweaver/api_op_StartSimulation.go @@ -38,19 +38,18 @@ type StartSimulationInput struct { // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role // that the simulation assumes to perform actions. For more information about ARNs, - // see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. For more information about IAM roles, - // see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) + // see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. For more information about IAM + // roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) // in the Identity and Access Management User Guide. // // This member is required. RoleArn *string // The location of the simulation schema in Amazon Simple Storage Service (Amazon - // S3). For more information about Amazon S3, see the Amazon Simple Storage - // Service User Guide - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html). + // S3). For more information about Amazon S3, see the Amazon Simple Storage + // Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) + // . // // This member is required. SchemaS3Location *types.S3Location @@ -69,9 +68,8 @@ type StartSimulationInput struct { MaximumDuration *string // A list of tags for the simulation. For more information about tags, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. + // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. Tags map[string]string noSmithyDocumentSerde @@ -80,13 +78,12 @@ type StartSimulationInput struct { type StartSimulationOutput struct { // The Amazon Resource Name (ARN) of the simulation. For more information about - // ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string - // The time when the simulation was created, expressed as the number of seconds and - // milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). + // The time when the simulation was created, expressed as the number of seconds + // and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). CreationTime *time.Time // A universally unique identifier (UUID) for this simulation. diff --git a/service/simspaceweaver/api_op_StopSimulation.go b/service/simspaceweaver/api_op_StopSimulation.go index 7a4a9cd283f..767bfabb139 100644 --- a/service/simspaceweaver/api_op_StopSimulation.go +++ b/service/simspaceweaver/api_op_StopSimulation.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops the given simulation. You can't restart a simulation after you stop it. If -// you need to restart a simulation, you must stop it, delete it, and start a new -// instance of it. +// Stops the given simulation. You can't restart a simulation after you stop it. +// If you need to restart a simulation, you must stop it, delete it, and start a +// new instance of it. func (c *Client) StopSimulation(ctx context.Context, params *StopSimulationInput, optFns ...func(*Options)) (*StopSimulationOutput, error) { if params == nil { params = &StopSimulationInput{} diff --git a/service/simspaceweaver/api_op_TagResource.go b/service/simspaceweaver/api_op_TagResource.go index c15f00841cd..c14b2b31a5c 100644 --- a/service/simspaceweaver/api_op_TagResource.go +++ b/service/simspaceweaver/api_op_TagResource.go @@ -11,9 +11,8 @@ import ( ) // Adds tags to a SimSpace Weaver resource. For more information about tags, see -// Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. +// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -31,10 +30,9 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that you want to add tags to. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // The Amazon Resource Name (ARN) of the resource that you want to add tags to. + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/api_op_UntagResource.go b/service/simspaceweaver/api_op_UntagResource.go index f3a5f1145bd..a98fe04dba0 100644 --- a/service/simspaceweaver/api_op_UntagResource.go +++ b/service/simspaceweaver/api_op_UntagResource.go @@ -11,9 +11,8 @@ import ( ) // Removes tags from a SimSpace Weaver resource. For more information about tags, -// see Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. +// see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -32,9 +31,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that you want to remove tags - // from. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // from. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/doc.go b/service/simspaceweaver/doc.go index 29121f911a6..7e203c969cf 100644 --- a/service/simspaceweaver/doc.go +++ b/service/simspaceweaver/doc.go @@ -8,11 +8,11 @@ // Web Services Cloud. For example, you can create a digital twin of a city, crowd // simulations with millions of people and objects, and massilvely-multiplayer // games with hundreds of thousands of connected players. For more information -// about SimSpace Weaver, see the Amazon Web Services SimSpace Weaver User Guide -// (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/) . This API -// reference describes the API operations and data types that you can use to -// communicate directly with SimSpace Weaver. SimSpace Weaver also provides the -// SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver -// app SDK API reference is included in the SimSpace Weaver app SDK documentation, -// which is part of the SimSpace Weaver app SDK distributable package. +// about SimSpace Weaver, see the Amazon Web Services SimSpace Weaver User Guide (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/) +// . This API reference describes the API operations and data types that you can +// use to communicate directly with SimSpace Weaver. SimSpace Weaver also provides +// the SimSpace Weaver app SDK, which you use for app development. The SimSpace +// Weaver app SDK API reference is included in the SimSpace Weaver app SDK +// documentation, which is part of the SimSpace Weaver app SDK distributable +// package. package simspaceweaver diff --git a/service/simspaceweaver/types/types.go b/service/simspaceweaver/types/types.go index c9fa16db411..1e64a089b46 100644 --- a/service/simspaceweaver/types/types.go +++ b/service/simspaceweaver/types/types.go @@ -8,46 +8,36 @@ import ( ) // The Amazon CloudWatch Logs log group for the simulation. For more information -// about log groups, see Working with log groups and log streams -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) +// about log groups, see Working with log groups and log streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) // in the Amazon CloudWatch Logs User Guide. type CloudWatchLogsLogGroup struct { // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the - // simulation. For more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. For more information about log - // groups, see Working with log groups and log streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) + // simulation. For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. For more information about log + // groups, see Working with log groups and log streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) // in the Amazon CloudWatch Logs User Guide. LogGroupArn *string noSmithyDocumentSerde } -// A collection of app instances that run the same executable app code and have the -// same launch options and commands. For more information about domains, see Key -// concepts -// (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) +// A collection of app instances that run the same executable app code and have +// the same launch options and commands. For more information about domains, see +// Key concepts (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) // in the Amazon Web Services SimSpace Weaver User Guide. type Domain struct { // The type of lifecycle management for apps in the domain. This value indicates // whether apps in this domain are managed (SimSpace Weaver starts and stops the // apps) or unmanaged (you must start and stop the apps). Lifecycle types - // - // * - // PerWorker – Managed: SimSpace Weaver starts 1 app on each worker - // - // * - // BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each spatial - // partition - // - // * ByRequest – Unmanaged: You use the StartApp API to start the apps - // and use the StopApp API to stop the apps. - // - // The lifecycle types will change when - // the service is released for general availability (GA). + // - PerWorker – Managed: SimSpace Weaver starts 1 app on each worker + // - BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each + // spatial partition + // - ByRequest – Unmanaged: You use the StartApp API to start the apps and use + // the StopApp API to stop the apps. + // The lifecycle types will change when the service is released for general + // availability (GA). Lifecycle LifecycleManagementStrategy // The name of the domain. @@ -60,8 +50,8 @@ type Domain struct { // behavior. type LaunchOverrides struct { - // App launch commands and command line parameters that override the launch command - // configured in the simulation schema. + // App launch commands and command line parameters that override the launch + // command configured in the simulation schema. LaunchCommands []string noSmithyDocumentSerde @@ -75,8 +65,7 @@ type LiveSimulationState struct { Clocks []SimulationClock // A list of domains for the simulation. For more information about domains, see - // Key concepts - // (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) + // Key concepts (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) // in the Amazon Web Services SimSpace Weaver User Guide. Domains []Domain @@ -87,8 +76,7 @@ type LiveSimulationState struct { type LogDestination struct { // An Amazon CloudWatch Logs log group that stores simulation log data. For more - // information about log groups, see Working with log groups and log streams - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) + // information about log groups, see Working with log groups and log streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) // in the Amazon CloudWatch Logs User Guide. CloudWatchLogsLogGroup *CloudWatchLogsLogGroup @@ -106,20 +94,18 @@ type LoggingConfiguration struct { // A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver // stores simulation data, such as your app zip files and schema file. For more -// information about Amazon S3, see the Amazon Simple Storage Service User Guide -// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html). +// information about Amazon S3, see the Amazon Simple Storage Service User Guide (https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) +// . type S3Location struct { // The name of an Amazon S3 bucket. For more information about buckets, see - // Creating, configuring, and working with Amazon S3 buckets - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) + // Creating, configuring, and working with Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) // in the Amazon Simple Storage Service User Guide. BucketName *string // The key name of an object in Amazon S3. For more information about Amazon S3 - // objects and object keys, see Uploading, downloading, and working with objects in - // Amazon S3 - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) + // objects and object keys, see Uploading, downloading, and working with objects + // in Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) // in the Amazon Simple Storage Service User Guide. ObjectKey *string @@ -144,8 +130,7 @@ type SimulationAppEndpointInfo struct { // A collection of metadata about an app. type SimulationAppMetadata struct { - // The domain of the app. For more information about domains, see Key concepts - // (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) + // The domain of the app. For more information about domains, see Key concepts (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html) // in the Amazon Web Services SimSpace Weaver User Guide. Domain *string @@ -197,13 +182,12 @@ type SimulationClock struct { type SimulationMetadata struct { // The Amazon Resource Name (ARN) of the simulation. For more information about - // ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string - // The time when the simulation was created, expressed as the number of seconds and - // milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). + // The time when the simulation was created, expressed as the number of seconds + // and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970). CreationTime *time.Time // The name of the simulation. diff --git a/service/sms/api_client.go b/service/sms/api_client.go index 38a00101b11..04785eed5cb 100644 --- a/service/sms/api_client.go +++ b/service/sms/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sms/api_op_CreateReplicationJob.go b/service/sms/api_op_CreateReplicationJob.go index 54903801bac..042a8701117 100644 --- a/service/sms/api_op_CreateReplicationJob.go +++ b/service/sms/api_op_CreateReplicationJob.go @@ -53,19 +53,12 @@ type CreateReplicationJobInput struct { // The ID of the KMS key for replication jobs that produce encrypted AMIs. This // value can be any of the following: - // - // * KMS key ID - // - // * KMS key alias - // - // * ARN - // referring to the KMS key ID - // - // * ARN referring to the KMS key alias - // - // If encrypted - // is true but a KMS key ID is not specified, the customer's default KMS key for - // Amazon EBS is used. + // - KMS key ID + // - KMS key alias + // - ARN referring to the KMS key ID + // - ARN referring to the KMS key alias + // If encrypted is true but a KMS key ID is not specified, the customer's default + // KMS key for Amazon EBS is used. KmsKeyId *string // The license type to be used for the AMI created by a successful replication run. diff --git a/service/sms/api_op_DeleteReplicationJob.go b/service/sms/api_op_DeleteReplicationJob.go index 884e0968522..874968047ee 100644 --- a/service/sms/api_op_DeleteReplicationJob.go +++ b/service/sms/api_op_DeleteReplicationJob.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified replication job. After you delete a replication job, there -// are no further replication runs. Amazon Web Services deletes the contents of the -// Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs -// created by the replication runs are not deleted. +// Deletes the specified replication job. After you delete a replication job, +// there are no further replication runs. Amazon Web Services deletes the contents +// of the Amazon S3 bucket used to store Server Migration Service artifacts. The +// AMIs created by the replication runs are not deleted. func (c *Client) DeleteReplicationJob(ctx context.Context, params *DeleteReplicationJobInput, optFns ...func(*Options)) (*DeleteReplicationJobOutput, error) { if params == nil { params = &DeleteReplicationJobInput{} diff --git a/service/sms/api_op_GenerateChangeSet.go b/service/sms/api_op_GenerateChangeSet.go index 9437cdc02e9..750645f3009 100644 --- a/service/sms/api_op_GenerateChangeSet.go +++ b/service/sms/api_op_GenerateChangeSet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates a target change set for a currently launched stack and writes it to an -// Amazon S3 object in the customer’s Amazon S3 bucket. +// Generates a target change set for a currently launched stack and writes it to +// an Amazon S3 object in the customer’s Amazon S3 bucket. func (c *Client) GenerateChangeSet(ctx context.Context, params *GenerateChangeSetInput, optFns ...func(*Options)) (*GenerateChangeSetOutput, error) { if params == nil { params = &GenerateChangeSetInput{} diff --git a/service/sms/api_op_GetServers.go b/service/sms/api_op_GetServers.go index 1cea6e3462d..b2c2126e38d 100644 --- a/service/sms/api_op_GetServers.go +++ b/service/sms/api_op_GetServers.go @@ -14,7 +14,7 @@ import ( ) // Describes the servers in your server catalog. Before you can describe your -// servers, you must import them using ImportServerCatalog. +// servers, you must import them using ImportServerCatalog . func (c *Client) GetServers(ctx context.Context, params *GetServersInput, optFns ...func(*Options)) (*GetServersOutput, error) { if params == nil { params = &GetServersInput{} diff --git a/service/sms/api_op_ImportAppCatalog.go b/service/sms/api_op_ImportAppCatalog.go index 378e098a0d8..496697ea7ff 100644 --- a/service/sms/api_op_ImportAppCatalog.go +++ b/service/sms/api_op_ImportAppCatalog.go @@ -30,8 +30,7 @@ type ImportAppCatalogInput struct { // The name of the service role. If you omit this parameter, we create a // service-linked role for Migration Hub in your account. Otherwise, the role that - // you provide must have the policy and trust policy - // (https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed) + // you provide must have the policy and trust policy (https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed) // described in the Migration Hub User Guide. RoleName *string diff --git a/service/sms/api_op_ImportServerCatalog.go b/service/sms/api_op_ImportServerCatalog.go index 0baad857497..8604da05239 100644 --- a/service/sms/api_op_ImportServerCatalog.go +++ b/service/sms/api_op_ImportServerCatalog.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gathers a complete list of on-premises servers. Connectors must be installed and -// monitoring all servers to import. This call returns immediately, but might take -// additional time to retrieve all the servers. +// Gathers a complete list of on-premises servers. Connectors must be installed +// and monitoring all servers to import. This call returns immediately, but might +// take additional time to retrieve all the servers. func (c *Client) ImportServerCatalog(ctx context.Context, params *ImportServerCatalogInput, optFns ...func(*Options)) (*ImportServerCatalogOutput, error) { if params == nil { params = &ImportServerCatalogInput{} diff --git a/service/sms/api_op_UpdateReplicationJob.go b/service/sms/api_op_UpdateReplicationJob.go index 9fe145e283a..a13794f4510 100644 --- a/service/sms/api_op_UpdateReplicationJob.go +++ b/service/sms/api_op_UpdateReplicationJob.go @@ -39,7 +39,7 @@ type UpdateReplicationJobInput struct { Description *string // When true, the replication job produces encrypted AMIs. For more information, - // KmsKeyId. + // KmsKeyId . Encrypted *bool // The time between consecutive replication runs, in hours. @@ -47,19 +47,12 @@ type UpdateReplicationJobInput struct { // The ID of the KMS key for replication jobs that produce encrypted AMIs. This // value can be any of the following: - // - // * KMS key ID - // - // * KMS key alias - // - // * ARN - // referring to the KMS key ID - // - // * ARN referring to the KMS key alias - // - // If encrypted - // is enabled but a KMS key ID is not specified, the customer's default KMS key for - // Amazon EBS is used. + // - KMS key ID + // - KMS key alias + // - ARN referring to the KMS key ID + // - ARN referring to the KMS key alias + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string // The license type to be used for the AMI created by a successful replication run. diff --git a/service/sms/doc.go b/service/sms/doc.go index a599551333c..a3e8a64a7f1 100644 --- a/service/sms/doc.go +++ b/service/sms/doc.go @@ -3,19 +3,13 @@ // Package sms provides the API client, operations, and parameter types for AWS // Server Migration Service. // -// Product update We recommend Amazon Web Services Application Migration Service -// (http://aws.amazon.com/application-migration-service) (Amazon Web Services MGN) -// as the primary migration service for lift-and-shift migrations. If Amazon Web -// Services MGN is unavailable in a specific Amazon Web Services Region, you can -// use the Server Migration Service APIs through March 2023. Server Migration -// Service (Server Migration Service) makes it easier and faster for you to migrate -// your on-premises workloads to Amazon Web Services. To learn more about Server -// Migration Service, see the following resources: -// -// * Server Migration Service -// product page (http://aws.amazon.com/server-migration-service/) -// -// * Server -// Migration Service User Guide -// (https://docs.aws.amazon.com/server-migration-service/latest/userguide/) +// Product update We recommend Amazon Web Services Application Migration Service (http://aws.amazon.com/application-migration-service) +// (Amazon Web Services MGN) as the primary migration service for lift-and-shift +// migrations. If Amazon Web Services MGN is unavailable in a specific Amazon Web +// Services Region, you can use the Server Migration Service APIs through March +// 2023. Server Migration Service (Server Migration Service) makes it easier and +// faster for you to migrate your on-premises workloads to Amazon Web Services. To +// learn more about Server Migration Service, see the following resources: +// - Server Migration Service product page (http://aws.amazon.com/server-migration-service/) +// - Server Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/) package sms diff --git a/service/sms/types/enums.go b/service/sms/types/enums.go index 3e5979b878b..c5b0bc0c64a 100644 --- a/service/sms/types/enums.go +++ b/service/sms/types/enums.go @@ -10,9 +10,10 @@ const ( AppLaunchConfigurationStatusConfigured AppLaunchConfigurationStatus = "CONFIGURED" ) -// Values returns all known values for AppLaunchConfigurationStatus. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AppLaunchConfigurationStatus. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AppLaunchConfigurationStatus) Values() []AppLaunchConfigurationStatus { return []AppLaunchConfigurationStatus{ "NOT_CONFIGURED", @@ -72,8 +73,8 @@ const ( AppReplicationConfigurationStatusConfigured AppReplicationConfigurationStatus = "CONFIGURED" ) -// Values returns all known values for AppReplicationConfigurationStatus. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for AppReplicationConfigurationStatus. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (AppReplicationConfigurationStatus) Values() []AppReplicationConfigurationStatus { @@ -141,9 +142,9 @@ const ( AppStatusDeleteFailed AppStatus = "DELETE_FAILED" ) -// Values returns all known values for AppStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for AppStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (AppStatus) Values() []AppStatus { return []AppStatus{ "CREATING", @@ -162,8 +163,8 @@ const ( AppValidationStrategySsm AppValidationStrategy = "SSM" ) -// Values returns all known values for AppValidationStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AppValidationStrategy. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AppValidationStrategy) Values() []AppValidationStrategy { return []AppValidationStrategy{ @@ -239,9 +240,9 @@ const ( OutputFormatYaml OutputFormat = "YAML" ) -// Values returns all known values for OutputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for OutputFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (OutputFormat) Values() []OutputFormat { return []OutputFormat{ "JSON", @@ -390,9 +391,9 @@ const ( ServerValidationStrategyUserdata ServerValidationStrategy = "USERDATA" ) -// Values returns all known values for ServerValidationStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ServerValidationStrategy. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerValidationStrategy) Values() []ServerValidationStrategy { return []ServerValidationStrategy{ "USERDATA", diff --git a/service/sms/types/types.go b/service/sms/types/types.go index 8658ee25ced..7fe99b360a5 100644 --- a/service/sms/types/types.go +++ b/service/sms/types/types.go @@ -178,19 +178,12 @@ type ReplicationJob struct { // The ID of the KMS key for replication jobs that produce encrypted AMIs. This // value can be any of the following: - // - // * KMS key ID - // - // * KMS key alias - // - // * ARN - // referring to the KMS key ID - // - // * ARN referring to the KMS key alias - // - // If encrypted - // is enabled but a KMS key ID is not specified, the customer's default KMS key for - // Amazon EBS is used. + // - KMS key ID + // - KMS key alias + // - ARN referring to the KMS key ID + // - ARN referring to the KMS key alias + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string // The ID of the latest Amazon Machine Image (AMI). @@ -256,19 +249,12 @@ type ReplicationRun struct { // The ID of the KMS key for replication jobs that produce encrypted AMIs. This // value can be any of the following: - // - // * KMS key ID - // - // * KMS key alias - // - // * ARN - // referring to the KMS key ID - // - // * ARN referring to the KMS key alias - // - // If encrypted - // is true but a KMS key ID is not specified, the customer's default KMS key for - // Amazon EBS is used. + // - KMS key ID + // - KMS key alias + // - ARN referring to the KMS key ID + // - ARN referring to the KMS key alias + // If encrypted is true but a KMS key ID is not specified, the customer's default + // KMS key for Amazon EBS is used. KmsKeyId *string // The ID of the replication run. @@ -395,8 +381,8 @@ type ServerGroupValidationConfiguration struct { // Launch configuration for a server. type ServerLaunchConfiguration struct { - // Indicates whether a publicly accessible IP address is created when launching the - // server. + // Indicates whether a publicly accessible IP address is created when launching + // the server. AssociatePublicIpAddress *bool // Location of an Amazon S3 object. @@ -459,19 +445,12 @@ type ServerReplicationParameters struct { // The ID of the KMS key for replication jobs that produce encrypted AMIs. This // value can be any of the following: - // - // * KMS key ID - // - // * KMS key alias - // - // * ARN - // referring to the KMS key ID - // - // * ARN referring to the KMS key alias - // - // If encrypted - // is enabled but a KMS key ID is not specified, the customer's default KMS key for - // Amazon EBS is used. + // - KMS key ID + // - KMS key alias + // - ARN referring to the KMS key ID + // - ARN referring to the KMS key alias + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string // The license type for creating a replication job for the server. diff --git a/service/snowball/api_client.go b/service/snowball/api_client.go index 3236026bfa9..91c315598f1 100644 --- a/service/snowball/api_client.go +++ b/service/snowball/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/snowball/api_op_CancelCluster.go b/service/snowball/api_op_CancelCluster.go index 2f0e29c1aab..44bb088e3ad 100644 --- a/service/snowball/api_op_CancelCluster.go +++ b/service/snowball/api_op_CancelCluster.go @@ -31,7 +31,7 @@ func (c *Client) CancelCluster(ctx context.Context, params *CancelClusterInput, type CancelClusterInput struct { // The 39-character ID for the cluster that you want to cancel, for example - // CID123e4567-e89b-12d3-a456-426655440000. + // CID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. ClusterId *string diff --git a/service/snowball/api_op_CancelJob.go b/service/snowball/api_op_CancelJob.go index 04d1d017397..45af098cfc3 100644 --- a/service/snowball/api_op_CancelJob.go +++ b/service/snowball/api_op_CancelJob.go @@ -11,7 +11,7 @@ import ( ) // Cancels the specified job. You can only cancel a job before its JobState value -// changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action +// changes to PreparingAppliance . Requesting the ListJobs or DescribeJob action // returns a job's JobState as part of the response element data returned. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { @@ -31,7 +31,7 @@ func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns . type CancelJobInput struct { // The 39-character job ID for the job that you want to cancel, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string diff --git a/service/snowball/api_op_CreateCluster.go b/service/snowball/api_op_CreateCluster.go index 2799185c6e3..136c86f41cf 100644 --- a/service/snowball/api_op_CreateCluster.go +++ b/service/snowball/api_op_CreateCluster.go @@ -37,7 +37,7 @@ type CreateClusterInput struct { AddressId *string // The type of job for this cluster. Currently, the only job type supported for - // clusters is LOCAL_USE. For more information, see + // clusters is LOCAL_USE . For more information, see // "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" // (Snow Family Devices and Capacity) in the Snowcone User Guide or // "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" @@ -46,53 +46,41 @@ type CreateClusterInput struct { // This member is required. JobType types.JobType - // The resources associated with the cluster job. These resources include Amazon S3 - // buckets and optional Lambda functions written in the Python language. + // The resources associated with the cluster job. These resources include Amazon + // S3 buckets and optional Lambda functions written in the Python language. // // This member is required. Resources *types.JobResource // The RoleARN that you want to associate with this cluster. RoleArn values are - // created by using the CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API - // action in Identity and Access Management (IAM). + // created by using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // API action in Identity and Access Management (IAM). // // This member is required. RoleARN *string - // The shipping speed for each node in this cluster. This speed doesn't dictate how - // soon you'll get each Snowball Edge device, rather it represents how quickly each - // device moves to its destination while in transit. Regional shipping speeds are - // as follows: + // The shipping speed for each node in this cluster. This speed doesn't dictate + // how soon you'll get each Snowball Edge device, rather it represents how quickly + // each device moves to its destination while in transit. Regional shipping speeds + // are as follows: + // - In Australia, you have access to express shipping. Typically, Snow devices + // shipped express are delivered in about a day. + // - In the European Union (EU), you have access to express shipping. Typically, + // Snow devices shipped express are delivered in about a day. In addition, most + // countries in the EU have access to standard shipping, which typically takes less + // than a week, one way. + // - In India, Snow devices are delivered in one to seven days. + // - In the United States of America (US), you have access to one-day shipping + // and two-day shipping. // - // * In Australia, you have access to express shipping. Typically, - // Snow devices shipped express are delivered in about a day. - // - // * In the European - // Union (EU), you have access to express shipping. Typically, Snow devices shipped - // express are delivered in about a day. In addition, most countries in the EU have - // access to standard shipping, which typically takes less than a week, one way. - // - // * - // In India, Snow devices are delivered in one to seven days. - // - // * In the United - // States of America (US), you have access to one-day shipping and two-day - // shipping. - // - // * In Australia, you have access to express shipping. Typically, - // devices shipped express are delivered in about a day. - // - // * In the European Union - // (EU), you have access to express shipping. Typically, Snow devices shipped - // express are delivered in about a day. In addition, most countries in the EU have - // access to standard shipping, which typically takes less than a week, one way. - // - // * - // In India, Snow devices are delivered in one to seven days. - // - // * In the US, you - // have access to one-day shipping and two-day shipping. + // - In Australia, you have access to express shipping. Typically, devices + // shipped express are delivered in about a day. + // - In the European Union (EU), you have access to express shipping. Typically, + // Snow devices shipped express are delivered in about a day. In addition, most + // countries in the EU have access to standard shipping, which typically takes less + // than a week, one way. + // - In India, Snow devices are delivered in one to seven days. + // - In the US, you have access to one-day shipping and two-day shipping. // // This member is required. ShippingOption types.ShippingOption @@ -108,8 +96,8 @@ type CreateClusterInput struct { // This member is required. SnowballType types.SnowballType - // An optional description of this specific cluster, for example Environmental Data - // Cluster-01. + // An optional description of this specific cluster, for example Environmental + // Data Cluster-01 . Description *string // The forwarding address ID for a cluster. This field is not supported in most @@ -117,9 +105,8 @@ type CreateClusterInput struct { ForwardingAddressId *string // The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN - // values are created by using the CreateKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API - // action in Key Management Service (KMS). + // values are created by using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) + // API action in Key Management Service (KMS). KmsKeyARN *string // The Amazon Simple Notification Service (Amazon SNS) notification settings for @@ -132,7 +119,7 @@ type CreateClusterInput struct { OnDeviceServiceConfiguration *types.OnDeviceServiceConfiguration // Allows you to securely operate and manage Snow devices in a cluster remotely - // from outside of your internal network. When set to INSTALLED_AUTOSTART, remote + // from outside of your internal network. When set to INSTALLED_AUTOSTART , remote // management will automatically be available when the device arrives at your // location. Otherwise, you need to use the Snowball Client to manage the device. RemoteManagement types.RemoteManagement diff --git a/service/snowball/api_op_CreateJob.go b/service/snowball/api_op_CreateJob.go index cdfd6df1d4c..15783383d42 100644 --- a/service/snowball/api_op_CreateJob.go +++ b/service/snowball/api_op_CreateJob.go @@ -19,69 +19,34 @@ import ( // device type is supported when ordering clustered jobs. The device capacity is // optional. Availability of device types differ by Amazon Web Services Region. For // more information about Region availability, see Amazon Web Services Regional -// Services -// (https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&loc=4). -// Snow Family devices and their capacities. -// -// * Snow Family device type: -// SNC1_SSD -// -// * Capacity: T14 -// -// * Description: Snowcone -// -// * Snow Family device type: -// SNC1_HDD -// -// * Capacity: T8 -// -// * Description: Snowcone -// -// * Device type: EDGE_S -// -// * -// Capacity: T98 -// -// * Description: Snowball Edge Storage Optimized for data transfer -// only -// -// * Device type: EDGE_CG -// -// * Capacity: T42 -// -// * Description: Snowball Edge -// Compute Optimized with GPU -// -// * Device type: EDGE_C -// -// * Capacity: T42 -// -// * -// Description: Snowball Edge Compute Optimized without GPU -// -// * Device type: EDGE -// -// * -// Capacity: T100 -// -// * Description: Snowball Edge Storage Optimized with EC2 -// Compute -// -// * Device type: STANDARD -// -// * Capacity: T50 -// -// * Description: Original -// Snowball device This device is only available in the Ningxia, Beijing, and -// Singapore Amazon Web Services Region -// -// * Device type: STANDARD -// -// * Capacity: -// T80 -// -// * Description: Original Snowball device This device is only available in -// the Ningxia, Beijing, and Singapore Amazon Web Services Region. +// Services (https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&loc=4) +// . Snow Family devices and their capacities. +// - Snow Family device type: SNC1_SSD +// - Capacity: T14 +// - Description: Snowcone +// - Snow Family device type: SNC1_HDD +// - Capacity: T8 +// - Description: Snowcone +// - Device type: EDGE_S +// - Capacity: T98 +// - Description: Snowball Edge Storage Optimized for data transfer only +// - Device type: EDGE_CG +// - Capacity: T42 +// - Description: Snowball Edge Compute Optimized with GPU +// - Device type: EDGE_C +// - Capacity: T42 +// - Description: Snowball Edge Compute Optimized without GPU +// - Device type: EDGE +// - Capacity: T100 +// - Description: Snowball Edge Storage Optimized with EC2 Compute +// - Device type: STANDARD +// - Capacity: T50 +// - Description: Original Snowball device This device is only available in the +// Ningxia, Beijing, and Singapore Amazon Web Services Region +// - Device type: STANDARD +// - Capacity: T80 +// - Description: Original Snowball device This device is only available in the +// Ningxia, Beijing, and Singapore Amazon Web Services Region. func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -108,7 +73,7 @@ type CreateJobInput struct { ClusterId *string // Defines an optional description of this specific job, for example Important - // Photos 2016-08-11. + // Photos 2016-08-11 . Description *string // Defines the device configuration for an Snowcone job. For more information, see @@ -125,10 +90,9 @@ type CreateJobInput struct { // Defines the type of job that you're creating. JobType types.JobType - // The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created - // using the CreateKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) Key - // Management Service (KMS) API action. + // The KmsKeyARN that you want to associate with this job. KmsKeyARN s are created + // using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) + // Key Management Service (KMS) API action. KmsKeyARN *string // The ID of the long-term pricing type for the device. @@ -144,45 +108,37 @@ type CreateJobInput struct { // Services Storage Gateway service Tape Gateway type. OnDeviceServiceConfiguration *types.OnDeviceServiceConfiguration - // Allows you to securely operate and manage Snowcone devices remotely from outside - // of your internal network. When set to INSTALLED_AUTOSTART, remote management - // will automatically be available when the device arrives at your location. - // Otherwise, you need to use the Snowball Client to manage the device. + // Allows you to securely operate and manage Snowcone devices remotely from + // outside of your internal network. When set to INSTALLED_AUTOSTART , remote + // management will automatically be available when the device arrives at your + // location. Otherwise, you need to use the Snowball Client to manage the device. RemoteManagement types.RemoteManagement // Defines the Amazon S3 buckets associated with this job. With IMPORT jobs, you // specify the bucket or buckets that your transferred data will be imported into. // With EXPORT jobs, you specify the bucket or buckets that your transferred data - // will be exported from. Optionally, you can also specify a KeyRange value. If you - // choose to export a range, you define the length of the range by providing either - // an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges - // are UTF-8 binary sorted. + // will be exported from. Optionally, you can also specify a KeyRange value. If + // you choose to export a range, you define the length of the range by providing + // either an inclusive BeginMarker value, an inclusive EndMarker value, or both. + // Ranges are UTF-8 binary sorted. Resources *types.JobResource - // The RoleARN that you want to associate with this job. RoleArns are created using - // the CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // The RoleARN that you want to associate with this job. RoleArn s are created + // using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) // Identity and Access Management (IAM) API action. RoleARN *string // The shipping speed for this job. This speed doesn't dictate how soon you'll get // the Snow device, rather it represents how quickly the Snow device moves to its // destination while in transit. Regional shipping speeds are as follows: - // - // * In - // Australia, you have access to express shipping. Typically, Snow devices shipped - // express are delivered in about a day. - // - // * In the European Union (EU), you have - // access to express shipping. Typically, Snow devices shipped express are - // delivered in about a day. In addition, most countries in the EU have access to - // standard shipping, which typically takes less than a week, one way. - // - // * In India, - // Snow devices are delivered in one to seven days. - // - // * In the US, you have access - // to one-day shipping and two-day shipping. + // - In Australia, you have access to express shipping. Typically, Snow devices + // shipped express are delivered in about a day. + // - In the European Union (EU), you have access to express shipping. Typically, + // Snow devices shipped express are delivered in about a day. In addition, most + // countries in the EU have access to standard shipping, which typically takes less + // than a week, one way. + // - In India, Snow devices are delivered in one to seven days. + // - In the US, you have access to one-day shipping and two-day shipping. ShippingOption types.ShippingOption // If your job is being created in one of the US regions, you have the option of @@ -197,9 +153,8 @@ type CreateJobInput struct { // The type of Snow Family devices to use for this job. For cluster jobs, Amazon // Web Services Snow Family currently supports only the EDGE device type. The type // of Amazon Web Services Snow device to use for this job. Currently, the only - // supported device type for cluster jobs is EDGE. For more information, see - // Snowball Edge Device Options - // (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html) + // supported device type for cluster jobs is EDGE . For more information, see + // Snowball Edge Device Options (https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html) // in the Snowball Edge Developer Guide. For more information, see // "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" // (Snow Family Devices and Capacity) in the Snowcone User Guide or @@ -216,7 +171,7 @@ type CreateJobInput struct { type CreateJobOutput struct { // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . JobId *string // Metadata pertaining to the operation's result. diff --git a/service/snowball/api_op_CreateReturnShippingLabel.go b/service/snowball/api_op_CreateReturnShippingLabel.go index ad99c846f8e..3ef69ded2ab 100644 --- a/service/snowball/api_op_CreateReturnShippingLabel.go +++ b/service/snowball/api_op_CreateReturnShippingLabel.go @@ -31,14 +31,14 @@ func (c *Client) CreateReturnShippingLabel(ctx context.Context, params *CreateRe type CreateReturnShippingLabelInput struct { // The ID for a job that you want to create the return shipping label for; for - // example, JID123e4567-e89b-12d3-a456-426655440000. + // example, JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string - // The shipping speed for a particular job. This speed doesn't dictate how soon the - // device is returned to Amazon Web Services. This speed represents how quickly it - // moves to its destination while in transit. Regional shipping speeds are as + // The shipping speed for a particular job. This speed doesn't dictate how soon + // the device is returned to Amazon Web Services. This speed represents how quickly + // it moves to its destination while in transit. Regional shipping speeds are as // follows: ShippingOption types.ShippingOption diff --git a/service/snowball/api_op_DescribeAddresses.go b/service/snowball/api_op_DescribeAddresses.go index 570b90df19f..07556b5d84c 100644 --- a/service/snowball/api_op_DescribeAddresses.go +++ b/service/snowball/api_op_DescribeAddresses.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a specified number of ADDRESS objects. Calling this API in one of the US -// regions will return addresses from the list of all addresses associated with +// Returns a specified number of ADDRESS objects. Calling this API in one of the +// US regions will return addresses from the list of all addresses associated with // this account in all US regions. func (c *Client) DescribeAddresses(ctx context.Context, params *DescribeAddressesInput, optFns ...func(*Options)) (*DescribeAddressesOutput, error) { if params == nil { @@ -35,9 +35,9 @@ type DescribeAddressesInput struct { // The number of ADDRESS objects to return. MaxResults *int32 - // HTTP requests are stateless. To identify what object comes "next" in the list of - // ADDRESS objects, you have the option of specifying a value for NextToken as the - // starting point for your list of returned addresses. + // HTTP requests are stateless. To identify what object comes "next" in the list + // of ADDRESS objects, you have the option of specifying a value for NextToken as + // the starting point for your list of returned addresses. NextToken *string noSmithyDocumentSerde diff --git a/service/snowball/api_op_DescribeJob.go b/service/snowball/api_op_DescribeJob.go index 65f600c0d47..dba264fe6d5 100644 --- a/service/snowball/api_op_DescribeJob.go +++ b/service/snowball/api_op_DescribeJob.go @@ -31,7 +31,7 @@ func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optF type DescribeJobInput struct { // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string diff --git a/service/snowball/api_op_DescribeReturnShippingLabel.go b/service/snowball/api_op_DescribeReturnShippingLabel.go index bc089a5e9b3..9add40c5c68 100644 --- a/service/snowball/api_op_DescribeReturnShippingLabel.go +++ b/service/snowball/api_op_DescribeReturnShippingLabel.go @@ -32,7 +32,7 @@ func (c *Client) DescribeReturnShippingLabel(ctx context.Context, params *Descri type DescribeReturnShippingLabelInput struct { // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string diff --git a/service/snowball/api_op_GetJobManifest.go b/service/snowball/api_op_GetJobManifest.go index 8fbaa9dd501..b77481c70f2 100644 --- a/service/snowball/api_op_GetJobManifest.go +++ b/service/snowball/api_op_GetJobManifest.go @@ -20,8 +20,8 @@ import ( // and should only be used when you have the device. The manifest is decrypted by // using the UnlockCode code value, when you pass both values to the Snow device // through the Snowball client when the client is started for the first time. As a -// best practice, we recommend that you don't save a copy of an UnlockCode value in -// the same location as the manifest file for that job. Saving these separately +// best practice, we recommend that you don't save a copy of an UnlockCode value +// in the same location as the manifest file for that job. Saving these separately // helps prevent unauthorized parties from gaining access to the Snow device // associated with that job. The credentials of a given job, including its manifest // file and unlock code, expire 360 days after the job is created. @@ -43,7 +43,7 @@ func (c *Client) GetJobManifest(ctx context.Context, params *GetJobManifestInput type GetJobManifestInput struct { // The ID for a job that you want to get the manifest file for, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string diff --git a/service/snowball/api_op_GetJobUnlockCode.go b/service/snowball/api_op_GetJobUnlockCode.go index 0df178ae097..7ea939b4767 100644 --- a/service/snowball/api_op_GetJobUnlockCode.go +++ b/service/snowball/api_op_GetJobUnlockCode.go @@ -40,7 +40,7 @@ func (c *Client) GetJobUnlockCode(ctx context.Context, params *GetJobUnlockCodeI type GetJobUnlockCodeInput struct { // The ID for the job that you want to get the UnlockCode value for, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string @@ -50,8 +50,8 @@ type GetJobUnlockCodeInput struct { type GetJobUnlockCodeOutput struct { - // The UnlockCode value for the specified job. The UnlockCode value can be accessed - // for up to 360 days after the job has been created. + // The UnlockCode value for the specified job. The UnlockCode value can be + // accessed for up to 360 days after the job has been created. UnlockCode *string // Metadata pertaining to the operation's result. diff --git a/service/snowball/api_op_GetSoftwareUpdates.go b/service/snowball/api_op_GetSoftwareUpdates.go index ae77a933883..bc6e03ee22b 100644 --- a/service/snowball/api_op_GetSoftwareUpdates.go +++ b/service/snowball/api_op_GetSoftwareUpdates.go @@ -11,7 +11,7 @@ import ( ) // Returns an Amazon S3 presigned URL for an update file associated with a -// specified JobId. +// specified JobId . func (c *Client) GetSoftwareUpdates(ctx context.Context, params *GetSoftwareUpdatesInput, optFns ...func(*Options)) (*GetSoftwareUpdatesOutput, error) { if params == nil { params = &GetSoftwareUpdatesInput{} @@ -30,7 +30,7 @@ func (c *Client) GetSoftwareUpdates(ctx context.Context, params *GetSoftwareUpda type GetSoftwareUpdatesInput struct { // The ID for a job that you want to get the software update file for, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string @@ -43,7 +43,7 @@ type GetSoftwareUpdatesOutput struct { // The Amazon S3 presigned URL for the update file associated with the specified // JobId value. The software update will be available for 2 days after this request // is made. To access an update after the 2 days have passed, you'll have to make - // another call to GetSoftwareUpdates. + // another call to GetSoftwareUpdates . UpdatesURI *string // Metadata pertaining to the operation's result. diff --git a/service/snowball/api_op_ListClusterJobs.go b/service/snowball/api_op_ListClusterJobs.go index 638bbda0ad9..d715f5c96aa 100644 --- a/service/snowball/api_op_ListClusterJobs.go +++ b/service/snowball/api_op_ListClusterJobs.go @@ -33,7 +33,7 @@ func (c *Client) ListClusterJobs(ctx context.Context, params *ListClusterJobsInp type ListClusterJobsInput struct { // The 39-character ID for the cluster that you want to list, for example - // CID123e4567-e89b-12d3-a456-426655440000. + // CID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. ClusterId *string @@ -41,8 +41,8 @@ type ListClusterJobsInput struct { // The number of JobListEntry objects to return. MaxResults *int32 - // HTTP requests are stateless. To identify what object comes "next" in the list of - // JobListEntry objects, you have the option of specifying NextToken as the + // HTTP requests are stateless. To identify what object comes "next" in the list + // of JobListEntry objects, you have the option of specifying NextToken as the // starting point for your returned list. NextToken *string diff --git a/service/snowball/api_op_ListClusters.go b/service/snowball/api_op_ListClusters.go index c764bd76d2f..aa068f27bc9 100644 --- a/service/snowball/api_op_ListClusters.go +++ b/service/snowball/api_op_ListClusters.go @@ -35,8 +35,8 @@ type ListClustersInput struct { // The number of ClusterListEntry objects to return. MaxResults *int32 - // HTTP requests are stateless. To identify what object comes "next" in the list of - // ClusterListEntry objects, you have the option of specifying NextToken as the + // HTTP requests are stateless. To identify what object comes "next" in the list + // of ClusterListEntry objects, you have the option of specifying NextToken as the // starting point for your returned list. NextToken *string diff --git a/service/snowball/api_op_ListCompatibleImages.go b/service/snowball/api_op_ListCompatibleImages.go index 766e319220a..afbdb5ffbad 100644 --- a/service/snowball/api_op_ListCompatibleImages.go +++ b/service/snowball/api_op_ListCompatibleImages.go @@ -38,9 +38,9 @@ type ListCompatibleImagesInput struct { // Snowball Edge device can store 10 AMIs. MaxResults *int32 - // HTTP requests are stateless. To identify what object comes "next" in the list of - // compatible images, you can specify a value for NextToken as the starting point - // for your list of returned images. + // HTTP requests are stateless. To identify what object comes "next" in the list + // of compatible images, you can specify a value for NextToken as the starting + // point for your list of returned images. NextToken *string noSmithyDocumentSerde diff --git a/service/snowball/api_op_ListJobs.go b/service/snowball/api_op_ListJobs.go index 966f34a9f6e..2bbd182ac5d 100644 --- a/service/snowball/api_op_ListJobs.go +++ b/service/snowball/api_op_ListJobs.go @@ -37,8 +37,8 @@ type ListJobsInput struct { // The number of JobListEntry objects to return. MaxResults *int32 - // HTTP requests are stateless. To identify what object comes "next" in the list of - // JobListEntry objects, you have the option of specifying NextToken as the + // HTTP requests are stateless. To identify what object comes "next" in the list + // of JobListEntry objects, you have the option of specifying NextToken as the // starting point for your returned list. NextToken *string diff --git a/service/snowball/api_op_ListLongTermPricing.go b/service/snowball/api_op_ListLongTermPricing.go index 85566d2e205..3a18f2d062a 100644 --- a/service/snowball/api_op_ListLongTermPricing.go +++ b/service/snowball/api_op_ListLongTermPricing.go @@ -116,8 +116,8 @@ func (c *Client) addOperationListLongTermPricingMiddlewares(stack *middleware.St return nil } -// ListLongTermPricingAPIClient is a client that implements the ListLongTermPricing -// operation. +// ListLongTermPricingAPIClient is a client that implements the +// ListLongTermPricing operation. type ListLongTermPricingAPIClient interface { ListLongTermPricing(context.Context, *ListLongTermPricingInput, ...func(*Options)) (*ListLongTermPricingOutput, error) } diff --git a/service/snowball/api_op_ListServiceVersions.go b/service/snowball/api_op_ListServiceVersions.go index 1a6dd5d1ac2..7815e662433 100644 --- a/service/snowball/api_op_ListServiceVersions.go +++ b/service/snowball/api_op_ListServiceVersions.go @@ -12,8 +12,7 @@ import ( ) // Lists all supported versions for Snow on-device services. Returns an array of -// ServiceVersion object containing the supported versions for a particular -// service. +// ServiceVersion object containing the supported versions for a particular service. func (c *Client) ListServiceVersions(ctx context.Context, params *ListServiceVersionsInput, optFns ...func(*Options)) (*ListServiceVersionsOutput, error) { if params == nil { params = &ListServiceVersionsInput{} @@ -65,8 +64,8 @@ type ListServiceVersionsOutput struct { // system provided supported versions. DependentServices []types.DependentService - // Because HTTP requests are stateless, this is the starting point of the next list - // of returned ListServiceVersionsResult results. + // Because HTTP requests are stateless, this is the starting point of the next + // list of returned ListServiceVersionsResult results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/snowball/api_op_UpdateCluster.go b/service/snowball/api_op_UpdateCluster.go index d3050880a39..46ba8ebf634 100644 --- a/service/snowball/api_op_UpdateCluster.go +++ b/service/snowball/api_op_UpdateCluster.go @@ -33,7 +33,7 @@ func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, type UpdateClusterInput struct { // The cluster ID of the cluster that you want to update, for example - // CID123e4567-e89b-12d3-a456-426655440000. + // CID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. ClusterId *string @@ -61,9 +61,8 @@ type UpdateClusterInput struct { Resources *types.JobResource // The new role Amazon Resource Name (ARN) that you want to associate with this - // cluster. To create a role ARN, use the CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API - // action in Identity and Access Management (IAM). + // cluster. To create a role ARN, use the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // API action in Identity and Access Management (IAM). RoleARN *string // The updated shipping option value of this cluster's ShippingDetails object. diff --git a/service/snowball/api_op_UpdateJob.go b/service/snowball/api_op_UpdateJob.go index 05972fa409c..eed7969c4c4 100644 --- a/service/snowball/api_op_UpdateJob.go +++ b/service/snowball/api_op_UpdateJob.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// While a job's JobState value is New, you can update some of the information +// While a job's JobState value is New , you can update some of the information // associated with a job. Once the job changes to a different job state, usually // within 60 minutes of the job being created, this action is no longer available. func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns ...func(*Options)) (*UpdateJobOutput, error) { @@ -32,7 +32,7 @@ func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns . type UpdateJobInput struct { // The job ID of the job that you want to update, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string @@ -43,8 +43,8 @@ type UpdateJobInput struct { // The updated description of this job's JobMetadata object. Description *string - // The updated ID for the forwarding address for a job. This field is not supported - // in most regions. + // The updated ID for the forwarding address for a job. This field is not + // supported in most regions. ForwardingAddressId *string // The new or updated Notification object. @@ -60,9 +60,8 @@ type UpdateJobInput struct { Resources *types.JobResource // The new role Amazon Resource Name (ARN) that you want to associate with this - // job. To create a role ARN, use the CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html)Identity - // and Access Management (IAM) API action. + // job. To create a role ARN, use the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // Identity and Access Management (IAM) API action. RoleARN *string // The updated shipping option value of this job's ShippingDetails object. diff --git a/service/snowball/api_op_UpdateJobShipmentState.go b/service/snowball/api_op_UpdateJobShipmentState.go index 90050911149..b18c425a85c 100644 --- a/service/snowball/api_op_UpdateJobShipmentState.go +++ b/service/snowball/api_op_UpdateJobShipmentState.go @@ -30,7 +30,7 @@ func (c *Client) UpdateJobShipmentState(ctx context.Context, params *UpdateJobSh type UpdateJobShipmentStateInput struct { // The job ID of the job whose shipment date you want to update, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . // // This member is required. JobId *string diff --git a/service/snowball/api_op_UpdateLongTermPricing.go b/service/snowball/api_op_UpdateLongTermPricing.go index 853d5471383..62f33ebb482 100644 --- a/service/snowball/api_op_UpdateLongTermPricing.go +++ b/service/snowball/api_op_UpdateLongTermPricing.go @@ -33,8 +33,9 @@ type UpdateLongTermPricingInput struct { // This member is required. LongTermPricingId *string - // If set to true, specifies that the current long-term pricing type for the device - // should be automatically renewed before the long-term pricing contract expires. + // If set to true , specifies that the current long-term pricing type for the + // device should be automatically renewed before the long-term pricing contract + // expires. IsLongTermPricingAutoRenew *bool // Specifies that a device that is ordered with long-term pricing should be diff --git a/service/snowball/doc.go b/service/snowball/doc.go index 9b52731816b..fa513418660 100644 --- a/service/snowball/doc.go +++ b/service/snowball/doc.go @@ -11,6 +11,6 @@ // enables you to create and manage jobs for a Snow Family device. To transfer data // locally with a Snow Family device, you'll need to use the Snowball Edge client // or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more -// information, see the User Guide -// (https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html). +// information, see the User Guide (https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html) +// . package snowball diff --git a/service/snowball/types/enums.go b/service/snowball/types/enums.go index 1200c41ef61..4a1498fb0c8 100644 --- a/service/snowball/types/enums.go +++ b/service/snowball/types/enums.go @@ -13,9 +13,9 @@ const ( ClusterStateCancelled ClusterState = "Cancelled" ) -// Values returns all known values for ClusterState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ClusterState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ClusterState) Values() []ClusterState { return []ClusterState{ "AwaitingQuorum", @@ -266,9 +266,9 @@ const ( SnowballTypeV35c SnowballType = "V3_5C" ) -// Values returns all known values for SnowballType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SnowballType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SnowballType) Values() []SnowballType { return []SnowballType{ "STANDARD", diff --git a/service/snowball/types/errors.go b/service/snowball/types/errors.go index b61cf32589b..54eb9b8567d 100644 --- a/service/snowball/types/errors.go +++ b/service/snowball/types/errors.go @@ -120,7 +120,7 @@ func (e *InvalidAddressException) ErrorFault() smithy.ErrorFault { return smithy // Job or cluster creation failed. One or more inputs were invalid. Confirm that // the CreateClusterRequest$SnowballType value supports your -// CreateJobRequest$JobType, and try again. +// CreateJobRequest$JobType , and try again. type InvalidInputCombinationException struct { Message *string @@ -146,8 +146,8 @@ func (e *InvalidInputCombinationException) ErrorCode() string { } func (e *InvalidInputCombinationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The action can't be performed because the job's current state doesn't allow that -// action to be performed. +// The action can't be performed because the job's current state doesn't allow +// that action to be performed. type InvalidJobStateException struct { Message *string diff --git a/service/snowball/types/types.go b/service/snowball/types/types.go index 2970b07ef74..a2403732f8e 100644 --- a/service/snowball/types/types.go +++ b/service/snowball/types/types.go @@ -65,18 +65,18 @@ type Address struct { type ClusterListEntry struct { // The 39-character ID for the cluster that you want to list, for example - // CID123e4567-e89b-12d3-a456-426655440000. + // CID123e4567-e89b-12d3-a456-426655440000 . ClusterId *string - // The current state of this cluster. For information about the state of a specific - // node, see JobListEntry$JobState. + // The current state of this cluster. For information about the state of a + // specific node, see JobListEntry$JobState . ClusterState ClusterState // The creation date for this cluster. CreationDate *time.Time // Defines an optional description of the cluster, for example Environmental Data - // Cluster-01. + // Cluster-01 . Description *string noSmithyDocumentSerde @@ -105,13 +105,12 @@ type ClusterMetadata struct { ForwardingAddressId *string // The type of job for this cluster. Currently, the only job type supported for - // clusters is LOCAL_USE. + // clusters is LOCAL_USE . JobType JobType // The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN - // was created using the CreateKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API - // action in Key Management Service (KMS. + // was created using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) + // API action in Key Management Service (KMS. KmsKeyARN *string // The Amazon Simple Notification Service (Amazon SNS) notification settings for @@ -122,34 +121,27 @@ type ClusterMetadata struct { // Services Snow Family device. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration - // The arrays of JobResource objects that can include updated S3Resource objects or - // LambdaResource objects. + // The arrays of JobResource objects that can include updated S3Resource objects + // or LambdaResource objects. Resources *JobResource // The role ARN associated with this cluster. This ARN was created using the - // CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API - // action in Identity and Access Management (IAM). + // CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // API action in Identity and Access Management (IAM). RoleARN *string - // The shipping speed for each node in this cluster. This speed doesn't dictate how - // soon you'll get each device, rather it represents how quickly each device moves - // to its destination while in transit. Regional shipping speeds are as follows: - // - // * - // In Australia, you have access to express shipping. Typically, devices shipped - // express are delivered in about a day. - // - // * In the European Union (EU), you have - // access to express shipping. Typically, Snow devices shipped express are - // delivered in about a day. In addition, most countries in the EU have access to - // standard shipping, which typically takes less than a week, one way. - // - // * In India, - // Snow devices are delivered in one to seven days. - // - // * In the US, you have access - // to one-day shipping and two-day shipping. + // The shipping speed for each node in this cluster. This speed doesn't dictate + // how soon you'll get each device, rather it represents how quickly each device + // moves to its destination while in transit. Regional shipping speeds are as + // follows: + // - In Australia, you have access to express shipping. Typically, devices + // shipped express are delivered in about a day. + // - In the European Union (EU), you have access to express shipping. Typically, + // Snow devices shipped express are delivered in about a day. In addition, most + // countries in the EU have access to standard shipping, which typically takes less + // than a week, one way. + // - In India, Snow devices are delivered in one to seven days. + // - In the US, you have access to one-day shipping and two-day shipping. ShippingOption ShippingOption // The type of Snowcone device to use for this cluster. For cluster jobs, Amazon @@ -179,7 +171,7 @@ type CompatibleImage struct { // Defines the real-time status of a Snow device's data transfer while the device // is at Amazon Web Services. This data is only available while a job has a -// JobState value of InProgress, for both import and export jobs. +// JobState value of InProgress , for both import and export jobs. type DataTransfer struct { // The number of bytes transferred between a Snow device and Amazon S3. @@ -188,9 +180,9 @@ type DataTransfer struct { // The number of objects transferred between a Snow device and Amazon S3. ObjectsTransferred int64 - // The total bytes of data for a transfer between a Snow device and Amazon S3. This - // value is set to 0 (zero) until all the keys that will be transferred have been - // listed. + // The total bytes of data for a transfer between a Snow device and Amazon S3. + // This value is set to 0 (zero) until all the keys that will be transferred have + // been listed. TotalBytes int64 // The total number of objects for a transfer between a Snow device and Amazon S3. @@ -213,7 +205,7 @@ type DependentService struct { noSmithyDocumentSerde } -// The container for SnowconeDeviceConfiguration. +// The container for SnowconeDeviceConfiguration . type DeviceConfiguration struct { // Returns information about the device configuration for an Snowcone job. @@ -222,10 +214,10 @@ type DeviceConfiguration struct { noSmithyDocumentSerde } -// A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), -// including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these -// two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud -// and on the device. +// A JSON-formatted object that contains the IDs for an Amazon Machine Image +// (AMI), including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has +// these two IDs to simplify identifying the AMI in both the Amazon Web Services +// Cloud and on the device. type Ec2AmiResource struct { // The ID of the AMI in Amazon EC2. @@ -252,7 +244,7 @@ type EKSOnDeviceServiceConfiguration struct { noSmithyDocumentSerde } -// The container for the EventTriggerDefinition$EventResourceARN. +// The container for the EventTriggerDefinition$EventResourceARN . type EventTriggerDefinition struct { // The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an @@ -280,7 +272,7 @@ type JobListEntry struct { CreationDate *time.Time // The optional description of this specific job, for example Important Photos - // 2016-08-11. + // 2016-08-11 . Description *string // A value that indicates that this job is a main job. A main job represents a @@ -292,7 +284,7 @@ type JobListEntry struct { IsMaster bool // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . JobId *string // The current state of this job. @@ -309,19 +301,19 @@ type JobListEntry struct { // Contains job logs. Whenever a Snow device is used to import data into or export // data out of Amazon S3, you'll have the option of downloading a PDF job report. -// Job logs are returned as a part of the response syntax of the DescribeJob action -// in the JobMetadata data type. The job logs can be accessed for up to 60 minutes -// after this request has been made. To access any of the job logs after 60 minutes -// have passed, you'll have to make another call to the DescribeJob action. For -// import jobs, the PDF job report becomes available at the end of the import -// process. For export jobs, your job report typically becomes available while the -// Snow device for your job part is being delivered to you. The job report provides -// you insight into the state of your Amazon S3 data transfer. The report includes -// details about your job or job part for your records. For deeper visibility into -// the status of your transferred objects, you can look at the two associated logs: -// a success log and a failure log. The logs are saved in comma-separated value -// (CSV) format, and the name of each log includes the ID of the job or job part -// that the log describes. +// Job logs are returned as a part of the response syntax of the DescribeJob +// action in the JobMetadata data type. The job logs can be accessed for up to 60 +// minutes after this request has been made. To access any of the job logs after 60 +// minutes have passed, you'll have to make another call to the DescribeJob +// action. For import jobs, the PDF job report becomes available at the end of the +// import process. For export jobs, your job report typically becomes available +// while the Snow device for your job part is being delivered to you. The job +// report provides you insight into the state of your Amazon S3 data transfer. The +// report includes details about your job or job part for your records. For deeper +// visibility into the status of your transferred objects, you can look at the two +// associated logs: a success log and a failure log. The logs are saved in +// comma-separated value (CSV) format, and the name of each log includes the ID of +// the job or job part that the log describes. type JobLogs struct { // A link to an Amazon S3 presigned URL where the job completion report is located. @@ -345,21 +337,21 @@ type JobMetadata struct { AddressId *string // The 39-character ID for the cluster, for example - // CID123e4567-e89b-12d3-a456-426655440000. + // CID123e4567-e89b-12d3-a456-426655440000 . ClusterId *string // The creation date for this job. CreationDate *time.Time - // A value that defines the real-time status of a Snow device's data transfer while - // the device is at Amazon Web Services. This data is only available while a job - // has a JobState value of InProgress, for both import and export jobs. + // A value that defines the real-time status of a Snow device's data transfer + // while the device is at Amazon Web Services. This data is only available while a + // job has a JobState value of InProgress , for both import and export jobs. DataTransferProgress *DataTransfer // The description of the job, provided at job creation. Description *string - // The container for SnowconeDeviceConfiguration. + // The container for SnowconeDeviceConfiguration . DeviceConfiguration *DeviceConfiguration // The ID of the address that you want a job shipped to, after it will be shipped @@ -367,7 +359,7 @@ type JobMetadata struct { ForwardingAddressId *string // The automatically generated ID for a job, for example - // JID123e4567-e89b-12d3-a456-426655440000. + // JID123e4567-e89b-12d3-a456-426655440000 . JobId *string // Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, @@ -383,36 +375,34 @@ type JobMetadata struct { JobType JobType // The Amazon Resource Name (ARN) for the Key Management Service (KMS) key - // associated with this job. This ARN was created using the CreateKey - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API - // action in KMS. + // associated with this job. This ARN was created using the CreateKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) + // API action in KMS. KmsKeyARN *string // The ID of the long-term pricing type for the device. LongTermPricingId *string // The Amazon Simple Notification Service (Amazon SNS) notification settings - // associated with a specific job. The Notification object is returned as a part of - // the response syntax of the DescribeJob action in the JobMetadata data type. + // associated with a specific job. The Notification object is returned as a part + // of the response syntax of the DescribeJob action in the JobMetadata data type. Notification *Notification // Represents metadata and configuration settings for services on an Amazon Web // Services Snow Family device. OnDeviceServiceConfiguration *OnDeviceServiceConfiguration - // Allows you to securely operate and manage Snowcone devices remotely from outside - // of your internal network. When set to INSTALLED_AUTOSTART, remote management - // will automatically be available when the device arrives at your location. - // Otherwise, you need to use the Snowball Client to manage the device. + // Allows you to securely operate and manage Snowcone devices remotely from + // outside of your internal network. When set to INSTALLED_AUTOSTART , remote + // management will automatically be available when the device arrives at your + // location. Otherwise, you need to use the Snowball Client to manage the device. RemoteManagement RemoteManagement // An array of S3Resource objects. Each S3Resource object represents an Amazon S3 // bucket that your transferred data will be exported from or imported into. Resources *JobResource - // The role ARN associated with this job. This ARN was created using the CreateRole - // (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API - // action in Identity and Access Management. + // The role ARN associated with this job. This ARN was created using the CreateRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) + // API action in Identity and Access Management. RoleARN *string // A job's shipping information, including inbound and outbound tracking numbers @@ -457,7 +447,7 @@ type JobResource struct { // Contains a key range. For export jobs, a S3Resource object can have an optional // KeyRange value. The length of the range is defined at job creation, and has -// either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are +// either an inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are // UTF-8 binary sorted. type KeyRange struct { @@ -479,8 +469,8 @@ type LambdaResource struct { // associated with this job. EventTriggers []EventTriggerDefinition - // An Amazon Resource Name (ARN) that represents an Lambda function to be triggered - // by PUT object actions on the associated local Amazon S3 resource. + // An Amazon Resource Name (ARN) that represents an Lambda function to be + // triggered by PUT object actions on the associated local Amazon S3 resource. LambdaArn *string noSmithyDocumentSerde @@ -493,8 +483,9 @@ type LongTermPricingListEntry struct { // The current active jobs on the device the long-term pricing type. CurrentActiveJob *string - // If set to true, specifies that the current long-term pricing type for the device - // should be automatically renewed before the long-term pricing contract expires. + // If set to true , specifies that the current long-term pricing type for the + // device should be automatically renewed before the long-term pricing contract + // expires. IsLongTermPricingAutoRenew *bool // The IDs of the jobs that are associated with a long-term pricing type. @@ -538,12 +529,12 @@ type NFSOnDeviceServiceConfiguration struct { } // The Amazon Simple Notification Service (Amazon SNS) notification settings -// associated with a specific job. The Notification object is returned as a part of -// the response syntax of the DescribeJob action in the JobMetadata data type. When -// the notification settings are defined during job creation, you can choose to -// notify based on a specific set of job states using the JobStatesToNotify array -// of strings, or you can specify that you want to have Amazon SNS notifications -// sent out for all job states with NotifyAll set to true. +// associated with a specific job. The Notification object is returned as a part +// of the response syntax of the DescribeJob action in the JobMetadata data type. +// When the notification settings are defined during job creation, you can choose +// to notify based on a specific set of job states using the JobStatesToNotify +// array of strings, or you can specify that you want to have Amazon SNS +// notifications sent out for all job states with NotifyAll set to true. type Notification struct { // The list of job states that will trigger a notification for this job. @@ -553,12 +544,10 @@ type Notification struct { NotifyAll bool // The new SNS TopicArn that you want to associate with this job. You can create - // Amazon Resource Names (ARNs) for topics by using the CreateTopic - // (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) Amazon SNS API - // action. You can subscribe email addresses to an Amazon SNS topic through the - // Amazon Web Services Management Console, or by using the Subscribe - // (https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) Amazon Simple - // Notification Service (Amazon SNS) API action. + // Amazon Resource Names (ARNs) for topics by using the CreateTopic (https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html) + // Amazon SNS API action. You can subscribe email addresses to an Amazon SNS topic + // through the Amazon Web Services Management Console, or by using the Subscribe (https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) + // Amazon Simple Notification Service (Amazon SNS) API action. SnsTopicARN *string noSmithyDocumentSerde @@ -581,11 +570,11 @@ type OnDeviceServiceConfiguration struct { noSmithyDocumentSerde } -// Each S3Resource object represents an Amazon S3 bucket that your transferred data -// will be exported from or imported into. For export jobs, this object can have an -// optional KeyRange value. The length of the range is defined at job creation, and -// has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are -// UTF-8 binary sorted. +// Each S3Resource object represents an Amazon S3 bucket that your transferred +// data will be exported from or imported into. For export jobs, this object can +// have an optional KeyRange value. The length of the range is defined at job +// creation, and has either an inclusive BeginMarker , an inclusive EndMarker , or +// both. Ranges are UTF-8 binary sorted. type S3Resource struct { // The Amazon Resource Name (ARN) of an Amazon S3 bucket. @@ -593,8 +582,8 @@ type S3Resource struct { // For export jobs, you can provide an optional KeyRange within a specific Amazon // S3 bucket. The length of the range is defined at job creation, and has either an - // inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary - // sorted. + // inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 + // binary sorted. KeyRange *KeyRange // Specifies the service or services on the Snow Family device that your @@ -645,21 +634,15 @@ type ShippingDetails struct { // you'll get the Snow device from the job's creation date. This speed represents // how quickly it moves to its destination while in transit. Regional shipping // speeds are as follows: - // - // * In Australia, you have access to express shipping. - // Typically, Snow devices shipped express are delivered in about a day. - // - // * In the - // European Union (EU), you have access to express shipping. Typically, Snow - // devices shipped express are delivered in about a day. In addition, most - // countries in the EU have access to standard shipping, which typically takes less - // than a week, one way. - // - // * In India, Snow devices are delivered in one to seven - // days. - // - // * In the United States of America (US), you have access to one-day - // shipping and two-day shipping. + // - In Australia, you have access to express shipping. Typically, Snow devices + // shipped express are delivered in about a day. + // - In the European Union (EU), you have access to express shipping. Typically, + // Snow devices shipped express are delivered in about a day. In addition, most + // countries in the EU have access to standard shipping, which typically takes less + // than a week, one way. + // - In India, Snow devices are delivered in one to seven days. + // - In the United States of America (US), you have access to one-day shipping + // and two-day shipping. ShippingOption ShippingOption noSmithyDocumentSerde @@ -674,8 +657,8 @@ type SnowconeDeviceConfiguration struct { noSmithyDocumentSerde } -// An object that represents the service or services on the Snow Family device that -// your transferred data will be exported from or imported into. Amazon Web +// An object that represents the service or services on the Snow Family device +// that your transferred data will be exported from or imported into. Amazon Web // Services Snow Family supports Amazon S3 and NFS (Network File System). type TargetOnDeviceService struct { diff --git a/service/snowdevicemanagement/api_client.go b/service/snowdevicemanagement/api_client.go index 2fedc14545a..60aa7886e6a 100644 --- a/service/snowdevicemanagement/api_client.go +++ b/service/snowdevicemanagement/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/snowdevicemanagement/api_op_CancelTask.go b/service/snowdevicemanagement/api_op_CancelTask.go index 2d9897a52ff..ce39e8c7786 100644 --- a/service/snowdevicemanagement/api_op_CancelTask.go +++ b/service/snowdevicemanagement/api_op_CancelTask.go @@ -31,8 +31,8 @@ func (c *Client) CancelTask(ctx context.Context, params *CancelTaskInput, optFns type CancelTaskInput struct { - // The ID of the task that you are attempting to cancel. You can retrieve a task ID - // by using the ListTasks operation. + // The ID of the task that you are attempting to cancel. You can retrieve a task + // ID by using the ListTasks operation. // // This member is required. TaskId *string diff --git a/service/snowdevicemanagement/api_op_DescribeDevice.go b/service/snowdevicemanagement/api_op_DescribeDevice.go index 9a3b8e06501..25df163fb53 100644 --- a/service/snowdevicemanagement/api_op_DescribeDevice.go +++ b/service/snowdevicemanagement/api_op_DescribeDevice.go @@ -53,8 +53,8 @@ type DescribeDeviceOutput struct { // The type of Amazon Web Services Snow Family device. DeviceType *string - // When the device last contacted the Amazon Web Services Cloud. Indicates that the - // device is online. + // When the device last contacted the Amazon Web Services Cloud. Indicates that + // the device is online. LastReachedOutAt *time.Time // When the device last pushed an update to the Amazon Web Services Cloud. diff --git a/service/snowdevicemanagement/api_op_DescribeDeviceEc2Instances.go b/service/snowdevicemanagement/api_op_DescribeDeviceEc2Instances.go index 11489e757c5..293c8cb5683 100644 --- a/service/snowdevicemanagement/api_op_DescribeDeviceEc2Instances.go +++ b/service/snowdevicemanagement/api_op_DescribeDeviceEc2Instances.go @@ -12,7 +12,7 @@ import ( ) // Checks the current state of the Amazon EC2 instances. The output is similar to -// describeDevice, but the results are sourced from the device cache in the Amazon +// describeDevice , but the results are sourced from the device cache in the Amazon // Web Services Cloud and include a subset of the available fields. func (c *Client) DescribeDeviceEc2Instances(ctx context.Context, params *DescribeDeviceEc2InstancesInput, optFns ...func(*Options)) (*DescribeDeviceEc2InstancesOutput, error) { if params == nil { diff --git a/service/snowdevicemanagement/api_op_ListDeviceResources.go b/service/snowdevicemanagement/api_op_ListDeviceResources.go index 53eca385563..6250d58826b 100644 --- a/service/snowdevicemanagement/api_op_ListDeviceResources.go +++ b/service/snowdevicemanagement/api_op_ListDeviceResources.go @@ -125,8 +125,8 @@ func (c *Client) addOperationListDeviceResourcesMiddlewares(stack *middleware.St return nil } -// ListDeviceResourcesAPIClient is a client that implements the ListDeviceResources -// operation. +// ListDeviceResourcesAPIClient is a client that implements the +// ListDeviceResources operation. type ListDeviceResourcesAPIClient interface { ListDeviceResources(context.Context, *ListDeviceResourcesInput, ...func(*Options)) (*ListDeviceResourcesOutput, error) } diff --git a/service/snowdevicemanagement/types/enums.go b/service/snowdevicemanagement/types/enums.go index 75f6aee92bb..5ca65fcb467 100644 --- a/service/snowdevicemanagement/types/enums.go +++ b/service/snowdevicemanagement/types/enums.go @@ -107,8 +107,8 @@ const ( PhysicalConnectorTypeWifi PhysicalConnectorType = "WIFI" ) -// Values returns all known values for PhysicalConnectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PhysicalConnectorType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PhysicalConnectorType) Values() []PhysicalConnectorType { return []PhysicalConnectorType{ @@ -129,9 +129,9 @@ const ( TaskStateCompleted TaskState = "COMPLETED" ) -// Values returns all known values for TaskState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for TaskState. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (TaskState) Values() []TaskState { return []TaskState{ "IN_PROGRESS", diff --git a/service/snowdevicemanagement/types/types.go b/service/snowdevicemanagement/types/types.go index d9fc035fb67..843066cbf4d 100644 --- a/service/snowdevicemanagement/types/types.go +++ b/service/snowdevicemanagement/types/types.go @@ -156,7 +156,7 @@ type Instance struct { // The public IPv4 address assigned to the instance. PublicIpAddress *string - // The device name of the root device volume (for example, /dev/sda1). + // The device name of the root device volume (for example, /dev/sda1 ). RootDeviceName *string // The security groups for the instance. @@ -193,23 +193,14 @@ type InstanceState struct { // ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals // decimal values between 0 and 255. The valid values for the instance state code // are all in the range of the low byte. These values are: - // - // * 0 : pending - // - // * 16 : - // running - // - // * 32 : shutting-down - // - // * 48 : terminated - // - // * 64 : stopping - // - // * 80 : - // stopped - // - // You can ignore the high byte value by zeroing out all of the bits above - // 2^8 or 256 in decimal. + // - 0 : pending + // - 16 : running + // - 32 : shutting-down + // - 48 : terminated + // - 64 : stopping + // - 80 : stopped + // You can ignore the high byte value by zeroing out all of the bits above 2^8 or + // 256 in decimal. Code *int32 // The current state of the instance. diff --git a/service/sns/api_client.go b/service/sns/api_client.go index 6011dbf121c..5dd21c28e9c 100644 --- a/service/sns/api_client.go +++ b/service/sns/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sns/api_op_AddPermission.go b/service/sns/api_op_AddPermission.go index b6cf31506b9..485a825f77a 100644 --- a/service/sns/api_op_AddPermission.go +++ b/service/sns/api_op_AddPermission.go @@ -13,7 +13,7 @@ import ( // Adds a statement to a topic's access control policy, granting access for the // specified Amazon Web Services accounts to the specified actions. To remove the // ability to change topic permissions, you must deny permissions to the -// AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM +// AddPermission , RemovePermission , and SetTopicAttributes actions in your IAM // policy. func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error) { if params == nil { @@ -40,7 +40,7 @@ type AddPermissionInput struct { AWSAccountId []string // The action you want to allow for the specified principal(s). Valid values: Any - // Amazon SNS action name, for example Publish. + // Amazon SNS action name, for example Publish . // // This member is required. ActionName []string diff --git a/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go b/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go index 71c69bd7806..6b3b2f7f0a9 100644 --- a/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go +++ b/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go @@ -44,12 +44,10 @@ type CheckIfPhoneNumberIsOptedOutInput struct { type CheckIfPhoneNumberIsOptedOutOutput struct { // Indicates whether the phone number is opted out: - // - // * true – The phone number is - // opted out, meaning you cannot publish SMS messages to it. - // - // * false – The phone - // number is opted in, meaning you can publish SMS messages to it. + // - true – The phone number is opted out, meaning you cannot publish SMS + // messages to it. + // - false – The phone number is opted in, meaning you can publish SMS messages + // to it. IsOptedOut bool // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_ConfirmSubscription.go b/service/sns/api_op_ConfirmSubscription.go index a6346ff533b..f42ad3e2199 100644 --- a/service/sns/api_op_ConfirmSubscription.go +++ b/service/sns/api_op_ConfirmSubscription.go @@ -13,8 +13,8 @@ import ( // Verifies an endpoint owner's intent to receive messages by validating the token // sent to the endpoint by an earlier Subscribe action. If the token is valid, the // action creates a new subscription and returns its Amazon Resource Name (ARN). -// This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag -// is set to "true". +// This call requires an AWS signature only when the AuthenticateOnUnsubscribe +// flag is set to "true". func (c *Client) ConfirmSubscription(ctx context.Context, params *ConfirmSubscriptionInput, optFns ...func(*Options)) (*ConfirmSubscriptionOutput, error) { if params == nil { params = &ConfirmSubscriptionInput{} @@ -43,10 +43,10 @@ type ConfirmSubscriptionInput struct { // This member is required. TopicArn *string - // Disallows unauthenticated unsubscribes of the subscription. If the value of this - // parameter is true and the request has an Amazon Web Services signature, then - // only the topic owner and the subscription owner can unsubscribe the endpoint. - // The unsubscribe action requires Amazon Web Services authentication. + // Disallows unauthenticated unsubscribes of the subscription. If the value of + // this parameter is true and the request has an Amazon Web Services signature, + // then only the topic owner and the subscription owner can unsubscribe the + // endpoint. The unsubscribe action requires Amazon Web Services authentication. AuthenticateOnUnsubscribe *string noSmithyDocumentSerde diff --git a/service/sns/api_op_CreatePlatformApplication.go b/service/sns/api_op_CreatePlatformApplication.go index 34da3a120c9..7fed85e4281 100644 --- a/service/sns/api_op_CreatePlatformApplication.go +++ b/service/sns/api_op_CreatePlatformApplication.go @@ -10,38 +10,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a platform application object for one of the supported push notification -// services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and -// mobile apps may register. You must specify PlatformPrincipal and +// Creates a platform application object for one of the supported push +// notification services, such as APNS and GCM (Firebase Cloud Messaging), to which +// devices and mobile apps may register. You must specify PlatformPrincipal and // PlatformCredential attributes when using the CreatePlatformApplication action. // PlatformPrincipal and PlatformCredential are received from the notification // service. +// - For ADM , PlatformPrincipal is client id and PlatformCredential is client +// secret . +// - For Baidu , PlatformPrincipal is API key and PlatformCredential is secret +// key . +// - For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal +// is SSL certificate and PlatformCredential is private key . +// - For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is +// signing key ID and PlatformCredential is signing key . +// - For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the +// PlatformCredential is API key . +// - For MPNS , PlatformPrincipal is TLS certificate and PlatformCredential is +// private key . +// - For WNS , PlatformPrincipal is Package Security Identifier and +// PlatformCredential is secret key . // -// * For ADM, PlatformPrincipal is client id and PlatformCredential is -// client secret. -// -// * For Baidu, PlatformPrincipal is API key and PlatformCredential -// is secret key. -// -// * For APNS and APNS_SANDBOX using certificate credentials, -// PlatformPrincipal is SSL certificate and PlatformCredential is private key. -// -// * -// For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing -// key ID and PlatformCredential is signing key. -// -// * For GCM (Firebase Cloud -// Messaging), there is no PlatformPrincipal and the PlatformCredential is API -// key. -// -// * For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is -// private key. -// -// * For WNS, PlatformPrincipal is Package Security Identifier and -// PlatformCredential is secret key. -// -// You can use the returned -// PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action. +// You can use the returned PlatformApplicationArn as an attribute for the +// CreatePlatformEndpoint action. func (c *Client) CreatePlatformApplication(ctx context.Context, params *CreatePlatformApplicationInput, optFns ...func(*Options)) (*CreatePlatformApplicationOutput, error) { if params == nil { params = &CreatePlatformApplicationInput{} @@ -60,15 +51,15 @@ func (c *Client) CreatePlatformApplication(ctx context.Context, params *CreatePl // Input for CreatePlatformApplication action. type CreatePlatformApplicationInput struct { - // For a list of attributes, see SetPlatformApplicationAttributes - // (https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html). + // For a list of attributes, see SetPlatformApplicationAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html) + // . // // This member is required. Attributes map[string]string - // Application names must be made up of only uppercase and lowercase ASCII letters, - // numbers, underscores, hyphens, and periods, and must be between 1 and 256 - // characters long. + // Application names must be made up of only uppercase and lowercase ASCII + // letters, numbers, underscores, hyphens, and periods, and must be between 1 and + // 256 characters long. // // This member is required. Name *string diff --git a/service/sns/api_op_CreatePlatformEndpoint.go b/service/sns/api_op_CreatePlatformEndpoint.go index 0e042fd783f..6f3ad49cc18 100644 --- a/service/sns/api_op_CreatePlatformEndpoint.go +++ b/service/sns/api_op_CreatePlatformEndpoint.go @@ -12,18 +12,17 @@ import ( // Creates an endpoint for a device and mobile app on one of the supported push // notification services, such as GCM (Firebase Cloud Messaging) and APNS. -// CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from -// CreatePlatformApplication. You can use the returned EndpointArn to send a +// CreatePlatformEndpoint requires the PlatformApplicationArn that is returned +// from CreatePlatformApplication . You can use the returned EndpointArn to send a // message to a mobile app or by the Subscribe action for subscription to a topic. // The CreatePlatformEndpoint action is idempotent, so if the requester already // owns an endpoint with the same device token and attributes, that endpoint's ARN // is returned without creating a new endpoint. For more information, see Using -// Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). When using -// CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId -// and UserId. The token field must also contain the ChannelId. For more -// information, see Creating an Amazon SNS Endpoint for Baidu -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html). +// Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . When using CreatePlatformEndpoint with Baidu, two attributes must be +// provided: ChannelId and UserId. The token field must also contain the ChannelId. +// For more information, see Creating an Amazon SNS Endpoint for Baidu (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html) +// . func (c *Client) CreatePlatformEndpoint(ctx context.Context, params *CreatePlatformEndpointInput, optFns ...func(*Options)) (*CreatePlatformEndpointOutput, error) { if params == nil { params = &CreatePlatformEndpointInput{} @@ -42,8 +41,8 @@ func (c *Client) CreatePlatformEndpoint(ctx context.Context, params *CreatePlatf // Input for CreatePlatformEndpoint action. type CreatePlatformEndpointInput struct { - // PlatformApplicationArn returned from CreatePlatformApplication is used to create - // a an endpoint. + // PlatformApplicationArn returned from CreatePlatformApplication is used to + // create a an endpoint. // // This member is required. PlatformApplicationArn *string @@ -57,12 +56,12 @@ type CreatePlatformEndpointInput struct { // This member is required. Token *string - // For a list of attributes, see SetEndpointAttributes - // (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html). + // For a list of attributes, see SetEndpointAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html) + // . Attributes map[string]string - // Arbitrary user data to associate with the endpoint. Amazon SNS does not use this - // data. The data must be in UTF-8 format and less than 2KB. + // Arbitrary user data to associate with the endpoint. Amazon SNS does not use + // this data. The data must be in UTF-8 format and less than 2KB. CustomUserData *string noSmithyDocumentSerde diff --git a/service/sns/api_op_CreateSMSSandboxPhoneNumber.go b/service/sns/api_op_CreateSMSSandboxPhoneNumber.go index a16b05ab935..b24b967e543 100644 --- a/service/sns/api_op_CreateSMSSandboxPhoneNumber.go +++ b/service/sns/api_op_CreateSMSSandboxPhoneNumber.go @@ -19,9 +19,8 @@ import ( // Amazon Web Services account is in the SMS sandbox, you can use all of the // features of Amazon SNS. However, you can send SMS messages only to verified // destination phone numbers. For more information, including how to move out of -// the sandbox to send messages without restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. func (c *Client) CreateSMSSandboxPhoneNumber(ctx context.Context, params *CreateSMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*CreateSMSSandboxPhoneNumberOutput, error) { if params == nil { params = &CreateSMSSandboxPhoneNumberInput{} @@ -46,7 +45,7 @@ type CreateSMSSandboxPhoneNumberInput struct { // This member is required. PhoneNumber *string - // The language to use for sending the OTP. The default value is en-US. + // The language to use for sending the OTP. The default value is en-US . LanguageCode types.LanguageCodeString noSmithyDocumentSerde diff --git a/service/sns/api_op_CreateTopic.go b/service/sns/api_op_CreateTopic.go index 4f9121362d6..5349f54ab1d 100644 --- a/service/sns/api_op_CreateTopic.go +++ b/service/sns/api_op_CreateTopic.go @@ -13,11 +13,10 @@ import ( // Creates a topic to which notifications can be published. Users can create at // most 100,000 standard topics (at most 1,000 FIFO topics). For more information, -// see Creating an Amazon SNS topic -// (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) in the Amazon -// SNS Developer Guide. This action is idempotent, so if the requester already owns -// a topic with the specified name, that topic's ARN is returned without creating a -// new topic. +// see Creating an Amazon SNS topic (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) +// in the Amazon SNS Developer Guide. This action is idempotent, so if the +// requester already owns a topic with the specified name, that topic's ARN is +// returned without creating a new topic. func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error) { if params == nil { params = &CreateTopicInput{} @@ -47,69 +46,46 @@ type CreateTopicInput struct { // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // CreateTopic action uses: - // - // * DeliveryPolicy – The policy that defines how Amazon - // SNS retries failed deliveries to HTTP/S endpoints. - // - // * DisplayName – The display - // name to use for a topic with SMS subscriptions. - // - // * FifoTopic – Set to true to - // create a FIFO topic. - // - // * Policy – The policy that defines who can access your - // topic. By default, only the topic owner can publish or subscribe to the - // topic. - // - // * SignatureVersion – The signature version corresponds to the hashing - // algorithm used while creating the signature of the notifications, subscription - // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By - // default, SignatureVersion is set to 1. - // - // * TracingConfig – Tracing mode of an - // Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic - // passes through the tracing header it receives from an Amazon SNS publisher to - // its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to - // topic owner account if the sampled flag in the tracing header is true. This is - // only supported on standard topics. - // - // The following attribute applies only to - // server-side encryption - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): - // - // * - // KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key - // (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). - // For more examples, see KeyId - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the Key Management Service API Reference. - // - // The following attributes apply - // only to FIFO topics - // (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): - // - // * FifoTopic – - // When this is set to true, a FIFO topic is created. - // - // * ContentBasedDeduplication - // – Enables content-based deduplication for FIFO topics. - // - // * By default, - // ContentBasedDeduplication is set to false. If you create a FIFO topic and this - // attribute is false, you must specify a value for the MessageDeduplicationId - // parameter for the Publish - // (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. - // - // * When - // you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to - // generate the MessageDeduplicationId using the body of the message (but not the - // attributes of the message). (Optional) To override the generated value, you can - // specify a value for the MessageDeduplicationId parameter for the Publish action. + // - DeliveryPolicy – The policy that defines how Amazon SNS retries failed + // deliveries to HTTP/S endpoints. + // - DisplayName – The display name to use for a topic with SMS subscriptions. + // - FifoTopic – Set to true to create a FIFO topic. + // - Policy – The policy that defines who can access your topic. By default, only + // the topic owner can publish or subscribe to the topic. + // - SignatureVersion – The signature version corresponds to the hashing + // algorithm used while creating the signature of the notifications, subscription + // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By + // default, SignatureVersion is set to 1 . + // - TracingConfig – Tracing mode of an Amazon SNS topic. By default + // TracingConfig is set to PassThrough , and the topic passes through the tracing + // header it receives from an Amazon SNS publisher to its subscriptions. If set to + // Active , Amazon SNS will vend X-Ray segment data to topic owner account if the + // sampled flag in the tracing header is true. This is only supported on standard + // topics. + // The following attribute applies only to server-side encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) + // : + // - KmsMasterKeyId – The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) + // . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // in the Key Management Service API Reference. + // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) + // : + // - FifoTopic – When this is set to true , a FIFO topic is created. + // - ContentBasedDeduplication – Enables content-based deduplication for FIFO + // topics. + // - By default, ContentBasedDeduplication is set to false . If you create a FIFO + // topic and this attribute is false , you must specify a value for the + // MessageDeduplicationId parameter for the Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) + // action. + // - When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 + // hash to generate the MessageDeduplicationId using the body of the message (but + // not the attributes of the message). (Optional) To override the generated value, + // you can specify a value for the MessageDeduplicationId parameter for the + // Publish action. Attributes map[string]string - // The body of the policy document you want to use for this topic. You can only add - // one policy per topic. The policy must be in JSON string format. Length + // The body of the policy document you want to use for this topic. You can only + // add one policy per topic. The policy must be in JSON string format. Length // Constraints: Maximum length of 30,720. DataProtectionPolicy *string diff --git a/service/sns/api_op_DeleteEndpoint.go b/service/sns/api_op_DeleteEndpoint.go index e648ff37d42..4382b0cd361 100644 --- a/service/sns/api_op_DeleteEndpoint.go +++ b/service/sns/api_op_DeleteEndpoint.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the endpoint for a device and mobile app from Amazon SNS. This action is -// idempotent. For more information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). When you delete -// an endpoint that is also subscribed to a topic, then you must also unsubscribe -// the endpoint from the topic. +// Deletes the endpoint for a device and mobile app from Amazon SNS. This action +// is idempotent. For more information, see Using Amazon SNS Mobile Push +// Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) . +// When you delete an endpoint that is also subscribed to a topic, then you must +// also unsubscribe the endpoint from the topic. func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { params = &DeleteEndpointInput{} diff --git a/service/sns/api_op_DeletePlatformApplication.go b/service/sns/api_op_DeletePlatformApplication.go index bbdc82abc5a..f095a94c0fd 100644 --- a/service/sns/api_op_DeletePlatformApplication.go +++ b/service/sns/api_op_DeletePlatformApplication.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a platform application object for one of the supported push notification -// services, such as APNS and GCM (Firebase Cloud Messaging). For more information, -// see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). +// Deletes a platform application object for one of the supported push +// notification services, such as APNS and GCM (Firebase Cloud Messaging). For more +// information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . func (c *Client) DeletePlatformApplication(ctx context.Context, params *DeletePlatformApplicationInput, optFns ...func(*Options)) (*DeletePlatformApplicationOutput, error) { if params == nil { params = &DeletePlatformApplicationInput{} diff --git a/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go b/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go index 7d1a34889ca..dc4c00c9fbf 100644 --- a/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go +++ b/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go @@ -18,9 +18,8 @@ import ( // SMS sandbox, you can use all of the features of Amazon SNS. However, you can // send SMS messages only to verified destination phone numbers. For more // information, including how to move out of the sandbox to send messages without -// restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. func (c *Client) DeleteSMSSandboxPhoneNumber(ctx context.Context, params *DeleteSMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*DeleteSMSSandboxPhoneNumberOutput, error) { if params == nil { params = &DeleteSMSSandboxPhoneNumberInput{} diff --git a/service/sns/api_op_GetDataProtectionPolicy.go b/service/sns/api_op_GetDataProtectionPolicy.go index 425c0fcdc17..61313659029 100644 --- a/service/sns/api_op_GetDataProtectionPolicy.go +++ b/service/sns/api_op_GetDataProtectionPolicy.go @@ -30,9 +30,8 @@ func (c *Client) GetDataProtectionPolicy(ctx context.Context, params *GetDataPro type GetDataProtectionPolicyInput struct { // The ARN of the topic whose DataProtectionPolicy you want to get. For more - // information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/sns/api_op_GetEndpointAttributes.go b/service/sns/api_op_GetEndpointAttributes.go index c5154e0babe..4a23fc2e7a5 100644 --- a/service/sns/api_op_GetEndpointAttributes.go +++ b/service/sns/api_op_GetEndpointAttributes.go @@ -12,8 +12,8 @@ import ( // Retrieves the endpoint attributes for a device on one of the supported push // notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more -// information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). +// information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . func (c *Client) GetEndpointAttributes(ctx context.Context, params *GetEndpointAttributesInput, optFns ...func(*Options)) (*GetEndpointAttributesOutput, error) { if params == nil { params = &GetEndpointAttributesInput{} @@ -44,21 +44,16 @@ type GetEndpointAttributesInput struct { type GetEndpointAttributesOutput struct { // Attributes include the following: - // - // * CustomUserData – arbitrary user data to - // associate with the endpoint. Amazon SNS does not use this data. The data must be - // in UTF-8 format and less than 2KB. - // - // * Enabled – flag that enables/disables - // delivery to the endpoint. Amazon SNS will set this to false when a notification - // service indicates to Amazon SNS that the endpoint is invalid. Users can set it - // back to true, typically after updating Token. - // - // * Token – device token, also - // referred to as a registration id, for an app and mobile device. This is returned - // from the notification service when an app and mobile device are registered with - // the notification service. The device token for the iOS platform is returned in - // lowercase. + // - CustomUserData – arbitrary user data to associate with the endpoint. Amazon + // SNS does not use this data. The data must be in UTF-8 format and less than 2KB. + // - Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS + // will set this to false when a notification service indicates to Amazon SNS that + // the endpoint is invalid. Users can set it back to true, typically after updating + // Token. + // - Token – device token, also referred to as a registration id, for an app and + // mobile device. This is returned from the notification service when an app and + // mobile device are registered with the notification service. The device token for + // the iOS platform is returned in lowercase. Attributes map[string]string // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_GetPlatformApplicationAttributes.go b/service/sns/api_op_GetPlatformApplicationAttributes.go index a570b052a8a..11bf36cb679 100644 --- a/service/sns/api_op_GetPlatformApplicationAttributes.go +++ b/service/sns/api_op_GetPlatformApplicationAttributes.go @@ -12,8 +12,8 @@ import ( // Retrieves the attributes of the platform application object for the supported // push notification services, such as APNS and GCM (Firebase Cloud Messaging). For -// more information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). +// more information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . func (c *Client) GetPlatformApplicationAttributes(ctx context.Context, params *GetPlatformApplicationAttributesInput, optFns ...func(*Options)) (*GetPlatformApplicationAttributesOutput, error) { if params == nil { params = &GetPlatformApplicationAttributesInput{} @@ -44,30 +44,21 @@ type GetPlatformApplicationAttributesInput struct { type GetPlatformApplicationAttributesOutput struct { // Attributes include the following: - // - // * AppleCertificateExpiryDate – The expiry - // date of the SSL certificate used to configure certificate-based - // authentication. - // - // * ApplePlatformTeamID – The Apple developer account ID used to - // configure token-based authentication. - // - // * ApplePlatformBundleID – The app - // identifier used to configure token-based authentication. - // - // * EventEndpointCreated - // – Topic ARN to which EndpointCreated event notifications should be sent. - // - // * - // EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications - // should be sent. - // - // * EventEndpointUpdated – Topic ARN to which EndpointUpdate - // event notifications should be sent. - // - // * EventDeliveryFailure – Topic ARN to which - // DeliveryFailure event notifications should be sent upon Direct Publish delivery - // failure (permanent) to one of the application's endpoints. + // - AppleCertificateExpiryDate – The expiry date of the SSL certificate used to + // configure certificate-based authentication. + // - ApplePlatformTeamID – The Apple developer account ID used to configure + // token-based authentication. + // - ApplePlatformBundleID – The app identifier used to configure token-based + // authentication. + // - EventEndpointCreated – Topic ARN to which EndpointCreated event + // notifications should be sent. + // - EventEndpointDeleted – Topic ARN to which EndpointDeleted event + // notifications should be sent. + // - EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications + // should be sent. + // - EventDeliveryFailure – Topic ARN to which DeliveryFailure event + // notifications should be sent upon Direct Publish delivery failure (permanent) to + // one of the application's endpoints. Attributes map[string]string // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_GetSMSAttributes.go b/service/sns/api_op_GetSMSAttributes.go index efd46c8fe04..97730e66fa2 100644 --- a/service/sns/api_op_GetSMSAttributes.go +++ b/service/sns/api_op_GetSMSAttributes.go @@ -30,10 +30,9 @@ func (c *Client) GetSMSAttributes(ctx context.Context, params *GetSMSAttributesI // The input for the GetSMSAttributes request. type GetSMSAttributesInput struct { - // A list of the individual attribute names, such as MonthlySpendLimit, for which - // you want values. For all attribute names, see SetSMSAttributes - // (https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html). If you - // don't use this parameter, Amazon SNS returns all SMS attributes. + // A list of the individual attribute names, such as MonthlySpendLimit , for which + // you want values. For all attribute names, see SetSMSAttributes (https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html) + // . If you don't use this parameter, Amazon SNS returns all SMS attributes. Attributes []string noSmithyDocumentSerde diff --git a/service/sns/api_op_GetSMSSandboxAccountStatus.go b/service/sns/api_op_GetSMSSandboxAccountStatus.go index d63d8992ab1..c19a679a425 100644 --- a/service/sns/api_op_GetSMSSandboxAccountStatus.go +++ b/service/sns/api_op_GetSMSSandboxAccountStatus.go @@ -18,9 +18,8 @@ import ( // is in the SMS sandbox, you can use all of the features of Amazon SNS. However, // you can send SMS messages only to verified destination phone numbers. For more // information, including how to move out of the sandbox to send messages without -// restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. func (c *Client) GetSMSSandboxAccountStatus(ctx context.Context, params *GetSMSSandboxAccountStatusInput, optFns ...func(*Options)) (*GetSMSSandboxAccountStatusOutput, error) { if params == nil { params = &GetSMSSandboxAccountStatusInput{} diff --git a/service/sns/api_op_GetSubscriptionAttributes.go b/service/sns/api_op_GetSubscriptionAttributes.go index 46a137ce29d..da583930371 100644 --- a/service/sns/api_op_GetSubscriptionAttributes.go +++ b/service/sns/api_op_GetSubscriptionAttributes.go @@ -42,73 +42,44 @@ type GetSubscriptionAttributesOutput struct { // A map of the subscription's attributes. Attributes in this map include the // following: - // - // * ConfirmationWasAuthenticated – true if the subscription - // confirmation request was authenticated. - // - // * DeliveryPolicy – The JSON - // serialization of the subscription's delivery policy. - // - // * EffectiveDeliveryPolicy - // – The JSON serialization of the effective delivery policy that takes into - // account the topic delivery policy and account system defaults. - // - // * FilterPolicy – - // The filter policy JSON that is assigned to the subscription. For more - // information, see Amazon SNS Message Filtering - // (https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the - // Amazon SNS Developer Guide. - // - // * FilterPolicyScope – This attribute lets you - // choose the filtering scope by using one of the following string value types: - // - // * - // MessageAttributes (default) – The filter is applied on the message - // attributes. - // - // * MessageBody – The filter is applied on the message body. - // - // * Owner - // – The Amazon Web Services account ID of the subscription's owner. - // - // * - // PendingConfirmation – true if the subscription hasn't been confirmed. To confirm - // a pending subscription, call the ConfirmSubscription action with a confirmation - // token. - // - // * RawMessageDelivery – true if raw message delivery is enabled for the - // subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S - // and Amazon SQS endpoints. - // - // * RedrivePolicy – When specified, sends undeliverable - // messages to the specified Amazon SQS dead-letter queue. Messages that can't be - // delivered due to client errors (for example, when the subscribed endpoint is - // unreachable) or server errors (for example, when the service that powers the - // subscribed endpoint becomes unavailable) are held in the dead-letter queue for - // further analysis or reprocessing. - // - // * SubscriptionArn – The subscription's - // ARN. - // - // * TopicArn – The topic ARN that the subscription is associated with. - // - // The - // following attribute applies only to Amazon Kinesis Data Firehose delivery stream - // subscriptions: - // - // * SubscriptionRoleArn – The ARN of the IAM role that has the - // following: - // - // * Permission to write to the Kinesis Data Firehose delivery - // stream - // - // * Amazon SNS listed as a trusted entity - // - // Specifying a valid ARN for this - // attribute is required for Kinesis Data Firehose delivery stream subscriptions. - // For more information, see Fanout to Kinesis Data Firehose delivery streams - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in - // the Amazon SNS Developer Guide. + // - ConfirmationWasAuthenticated – true if the subscription confirmation request + // was authenticated. + // - DeliveryPolicy – The JSON serialization of the subscription's delivery + // policy. + // - EffectiveDeliveryPolicy – The JSON serialization of the effective delivery + // policy that takes into account the topic delivery policy and account system + // defaults. + // - FilterPolicy – The filter policy JSON that is assigned to the subscription. + // For more information, see Amazon SNS Message Filtering (https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) + // in the Amazon SNS Developer Guide. + // - FilterPolicyScope – This attribute lets you choose the filtering scope by + // using one of the following string value types: + // - MessageAttributes (default) – The filter is applied on the message + // attributes. + // - MessageBody – The filter is applied on the message body. + // - Owner – The Amazon Web Services account ID of the subscription's owner. + // - PendingConfirmation – true if the subscription hasn't been confirmed. To + // confirm a pending subscription, call the ConfirmSubscription action with a + // confirmation token. + // - RawMessageDelivery – true if raw message delivery is enabled for the + // subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S + // and Amazon SQS endpoints. + // - RedrivePolicy – When specified, sends undeliverable messages to the + // specified Amazon SQS dead-letter queue. Messages that can't be delivered due to + // client errors (for example, when the subscribed endpoint is unreachable) or + // server errors (for example, when the service that powers the subscribed endpoint + // becomes unavailable) are held in the dead-letter queue for further analysis or + // reprocessing. + // - SubscriptionArn – The subscription's ARN. + // - TopicArn – The topic ARN that the subscription is associated with. + // The following attribute applies only to Amazon Kinesis Data Firehose delivery + // stream subscriptions: + // - SubscriptionRoleArn – The ARN of the IAM role that has the following: + // - Permission to write to the Kinesis Data Firehose delivery stream + // - Amazon SNS listed as a trusted entity Specifying a valid ARN for this + // attribute is required for Kinesis Data Firehose delivery stream subscriptions. + // For more information, see Fanout to Kinesis Data Firehose delivery streams (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // in the Amazon SNS Developer Guide. Attributes map[string]string // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_GetTopicAttributes.go b/service/sns/api_op_GetTopicAttributes.go index 000d2d3eff3..122a62268b8 100644 --- a/service/sns/api_op_GetTopicAttributes.go +++ b/service/sns/api_op_GetTopicAttributes.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns all of the properties of a topic. Topic properties returned might differ -// based on the authorization of the user. +// Returns all of the properties of a topic. Topic properties returned might +// differ based on the authorization of the user. func (c *Client) GetTopicAttributes(ctx context.Context, params *GetTopicAttributesInput, optFns ...func(*Options)) (*GetTopicAttributesOutput, error) { if params == nil { params = &GetTopicAttributesInput{} @@ -41,89 +41,55 @@ type GetTopicAttributesInput struct { // Response for GetTopicAttributes action. type GetTopicAttributesOutput struct { - // A map of the topic's attributes. Attributes in this map include the - // following: - // - // * DeliveryPolicy – The JSON serialization of the topic's delivery - // policy. - // - // * DisplayName – The human-readable name used in the From field for - // notifications to email and email-json endpoints. - // - // * EffectiveDeliveryPolicy – - // The JSON serialization of the effective delivery policy, taking system defaults - // into account. - // - // * Owner – The Amazon Web Services account ID of the topic's - // owner. - // - // * Policy – The JSON serialization of the topic's access control - // policy. - // - // * SignatureVersion – The signature version corresponds to the hashing - // algorithm used while creating the signature of the notifications, subscription - // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - // - // * By - // default, SignatureVersion is set to 1. The signature is a Base64-encoded - // SHA1withRSA signature. - // - // * When you set SignatureVersion to 2. Amazon SNS uses a - // Base64-encoded SHA256withRSA signature. If the API response does not include the - // SignatureVersion attribute, it means that the SignatureVersion for the topic has - // value 1. - // - // * SubscriptionsConfirmed – The number of confirmed subscriptions for - // the topic. - // - // * SubscriptionsDeleted – The number of deleted subscriptions for the - // topic. - // - // * SubscriptionsPending – The number of subscriptions pending - // confirmation for the topic. - // - // * TopicArn – The topic's ARN. - // - // * TracingConfig – - // Tracing mode of an Amazon SNS topic. By default TracingConfig is set to - // PassThrough, and the topic passes through the tracing header it receives from an - // Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will - // vend X-Ray segment data to topic owner account if the sampled flag in the - // tracing header is true. This is only supported on standard topics. - // - // The - // following attribute applies only to server-side-encryption - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): - // - // * - // KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key - // (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). - // For more examples, see KeyId - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the Key Management Service API Reference. - // - // The following attributes apply - // only to FIFO topics - // (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): - // - // * FifoTopic – - // When this is set to true, a FIFO topic is created. - // - // * ContentBasedDeduplication - // – Enables content-based deduplication for FIFO topics. - // - // * By default, - // ContentBasedDeduplication is set to false. If you create a FIFO topic and this - // attribute is false, you must specify a value for the MessageDeduplicationId - // parameter for the Publish - // (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. - // - // * When - // you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to - // generate the MessageDeduplicationId using the body of the message (but not the - // attributes of the message). (Optional) To override the generated value, you can - // specify a value for the MessageDeduplicationId parameter for the Publish action. + // A map of the topic's attributes. Attributes in this map include the following: + // - DeliveryPolicy – The JSON serialization of the topic's delivery policy. + // - DisplayName – The human-readable name used in the From field for + // notifications to email and email-json endpoints. + // - EffectiveDeliveryPolicy – The JSON serialization of the effective delivery + // policy, taking system defaults into account. + // - Owner – The Amazon Web Services account ID of the topic's owner. + // - Policy – The JSON serialization of the topic's access control policy. + // - SignatureVersion – The signature version corresponds to the hashing + // algorithm used while creating the signature of the notifications, subscription + // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. + // - By default, SignatureVersion is set to 1. The signature is a Base64-encoded + // SHA1withRSA signature. + // - When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded + // SHA256withRSA signature. If the API response does not include the + // SignatureVersion attribute, it means that the SignatureVersion for the topic + // has value 1. + // - SubscriptionsConfirmed – The number of confirmed subscriptions for the + // topic. + // - SubscriptionsDeleted – The number of deleted subscriptions for the topic. + // - SubscriptionsPending – The number of subscriptions pending confirmation for + // the topic. + // - TopicArn – The topic's ARN. + // - TracingConfig – Tracing mode of an Amazon SNS topic. By default + // TracingConfig is set to PassThrough , and the topic passes through the tracing + // header it receives from an Amazon SNS publisher to its subscriptions. If set to + // Active , Amazon SNS will vend X-Ray segment data to topic owner account if the + // sampled flag in the tracing header is true. This is only supported on standard + // topics. + // The following attribute applies only to server-side-encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) + // : + // - KmsMasterKeyId - The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) + // . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // in the Key Management Service API Reference. + // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) + // : + // - FifoTopic – When this is set to true , a FIFO topic is created. + // - ContentBasedDeduplication – Enables content-based deduplication for FIFO + // topics. + // - By default, ContentBasedDeduplication is set to false . If you create a FIFO + // topic and this attribute is false , you must specify a value for the + // MessageDeduplicationId parameter for the Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) + // action. + // - When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 + // hash to generate the MessageDeduplicationId using the body of the message (but + // not the attributes of the message). (Optional) To override the generated value, + // you can specify a value for the MessageDeduplicationId parameter for the + // Publish action. Attributes map[string]string // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_ListEndpointsByPlatformApplication.go b/service/sns/api_op_ListEndpointsByPlatformApplication.go index 47f6ab13951..45f779b1c43 100644 --- a/service/sns/api_op_ListEndpointsByPlatformApplication.go +++ b/service/sns/api_op_ListEndpointsByPlatformApplication.go @@ -17,12 +17,11 @@ import ( // results for ListEndpointsByPlatformApplication are paginated and return a // limited list of endpoints, up to 100. If additional records are available after // the first page results, then a NextToken string will be returned. To receive the -// next page, you call ListEndpointsByPlatformApplication again using the NextToken -// string received from the previous call. When there are no more records to -// return, NextToken will be null. For more information, see Using Amazon SNS -// Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). This action is -// throttled at 30 transactions per second (TPS). +// next page, you call ListEndpointsByPlatformApplication again using the +// NextToken string received from the previous call. When there are no more records +// to return, NextToken will be null. For more information, see Using Amazon SNS +// Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . This action is throttled at 30 transactions per second (TPS). func (c *Client) ListEndpointsByPlatformApplication(ctx context.Context, params *ListEndpointsByPlatformApplicationInput, optFns ...func(*Options)) (*ListEndpointsByPlatformApplicationOutput, error) { if params == nil { params = &ListEndpointsByPlatformApplicationInput{} diff --git a/service/sns/api_op_ListOriginationNumbers.go b/service/sns/api_op_ListOriginationNumbers.go index 98483b1cc4b..02b513e72ea 100644 --- a/service/sns/api_op_ListOriginationNumbers.go +++ b/service/sns/api_op_ListOriginationNumbers.go @@ -14,8 +14,7 @@ import ( // Lists the calling Amazon Web Services account's dedicated origination numbers // and their metadata. For more information about origination numbers, see -// Origination numbers -// (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html) +// Origination numbers (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html) // in the Amazon SNS Developer Guide. func (c *Client) ListOriginationNumbers(ctx context.Context, params *ListOriginationNumbersInput, optFns ...func(*Options)) (*ListOriginationNumbersOutput, error) { if params == nil { diff --git a/service/sns/api_op_ListPhoneNumbersOptedOut.go b/service/sns/api_op_ListPhoneNumbersOptedOut.go index 04b2721d7f8..a63ac6da54d 100644 --- a/service/sns/api_op_ListPhoneNumbersOptedOut.go +++ b/service/sns/api_op_ListPhoneNumbersOptedOut.go @@ -46,8 +46,8 @@ type ListPhoneNumbersOptedOutInput struct { // The response from the ListPhoneNumbersOptedOut action. type ListPhoneNumbersOptedOutOutput struct { - // A NextToken string is returned when you call the ListPhoneNumbersOptedOut action - // if additional records are available after the first page of results. + // A NextToken string is returned when you call the ListPhoneNumbersOptedOut + // action if additional records are available after the first page of results. NextToken *string // A list of phone numbers that are opted out of receiving SMS messages. The list diff --git a/service/sns/api_op_ListPlatformApplications.go b/service/sns/api_op_ListPlatformApplications.go index 6ce2ddb9b8d..7b39d30cca1 100644 --- a/service/sns/api_op_ListPlatformApplications.go +++ b/service/sns/api_op_ListPlatformApplications.go @@ -17,11 +17,11 @@ import ( // ListPlatformApplications are paginated and return a limited list of // applications, up to 100. If additional records are available after the first // page results, then a NextToken string will be returned. To receive the next -// page, you call ListPlatformApplications using the NextToken string received from -// the previous call. When there are no more records to return, NextToken will be -// null. For more information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). This action is -// throttled at 15 transactions per second (TPS). +// page, you call ListPlatformApplications using the NextToken string received +// from the previous call. When there are no more records to return, NextToken +// will be null. For more information, see Using Amazon SNS Mobile Push +// Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) . +// This action is throttled at 15 transactions per second (TPS). func (c *Client) ListPlatformApplications(ctx context.Context, params *ListPlatformApplicationsInput, optFns ...func(*Options)) (*ListPlatformApplicationsOutput, error) { if params == nil { params = &ListPlatformApplicationsInput{} diff --git a/service/sns/api_op_ListSMSSandboxPhoneNumbers.go b/service/sns/api_op_ListSMSSandboxPhoneNumbers.go index 5e33ef1c29c..a4f04db763a 100644 --- a/service/sns/api_op_ListSMSSandboxPhoneNumbers.go +++ b/service/sns/api_op_ListSMSSandboxPhoneNumbers.go @@ -20,9 +20,8 @@ import ( // account is in the SMS sandbox, you can use all of the features of Amazon SNS. // However, you can send SMS messages only to verified destination phone numbers. // For more information, including how to move out of the sandbox to send messages -// without restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. func (c *Client) ListSMSSandboxPhoneNumbers(ctx context.Context, params *ListSMSSandboxPhoneNumbersInput, optFns ...func(*Options)) (*ListSMSSandboxPhoneNumbersOutput, error) { if params == nil { params = &ListSMSSandboxPhoneNumbersInput{} diff --git a/service/sns/api_op_ListSubscriptions.go b/service/sns/api_op_ListSubscriptions.go index 16dd9681bee..eb831c06c50 100644 --- a/service/sns/api_op_ListSubscriptions.go +++ b/service/sns/api_op_ListSubscriptions.go @@ -14,8 +14,8 @@ import ( // Returns a list of the requester's subscriptions. Each call returns a limited // list of subscriptions, up to 100. If there are more subscriptions, a NextToken -// is also returned. Use the NextToken parameter in a new ListSubscriptions call to -// get further results. This action is throttled at 30 transactions per second +// is also returned. Use the NextToken parameter in a new ListSubscriptions call +// to get further results. This action is throttled at 30 transactions per second // (TPS). func (c *Client) ListSubscriptions(ctx context.Context, params *ListSubscriptionsInput, optFns ...func(*Options)) (*ListSubscriptionsOutput, error) { if params == nil { diff --git a/service/sns/api_op_Publish.go b/service/sns/api_op_Publish.go index f77cb212831..08746c35636 100644 --- a/service/sns/api_op_Publish.go +++ b/service/sns/api_op_Publish.go @@ -11,20 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sends a message to an Amazon SNS topic, a text message (SMS message) directly to -// a phone number, or a message to a mobile platform endpoint (when you specify the -// TargetArn). If you send a message to a topic, Amazon SNS delivers the message to -// each endpoint that is subscribed to the topic. The format of the message depends -// on the notification protocol for each subscribed endpoint. When a messageId is -// returned, the message is saved and Amazon SNS immediately delivers it to -// subscribers. To use the Publish action for publishing a message to a mobile -// endpoint, such as an app on a Kindle device or mobile phone, you must specify -// the EndpointArn for the TargetArn parameter. The EndpointArn is returned when -// making a call with the CreatePlatformEndpoint action. For more information about -// formatting messages, see Send Custom Platform-Specific Payloads in Messages to -// Mobile Devices -// (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html). -// You can publish messages only to topics and endpoints in the same Amazon Web +// Sends a message to an Amazon SNS topic, a text message (SMS message) directly +// to a phone number, or a message to a mobile platform endpoint (when you specify +// the TargetArn ). If you send a message to a topic, Amazon SNS delivers the +// message to each endpoint that is subscribed to the topic. The format of the +// message depends on the notification protocol for each subscribed endpoint. When +// a messageId is returned, the message is saved and Amazon SNS immediately +// delivers it to subscribers. To use the Publish action for publishing a message +// to a mobile endpoint, such as an app on a Kindle device or mobile phone, you +// must specify the EndpointArn for the TargetArn parameter. The EndpointArn is +// returned when making a call with the CreatePlatformEndpoint action. For more +// information about formatting messages, see Send Custom Platform-Specific +// Payloads in Messages to Mobile Devices (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html) +// . You can publish messages only to topics and endpoints in the same Amazon Web // Services Region. func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*PublishOutput, error) { if params == nil { @@ -49,49 +48,30 @@ type PublishInput struct { // message as a String value. If you want to send different messages for each // transport protocol, set the value of the MessageStructure parameter to json and // use a JSON object for the Message parameter. Constraints: - // - // * With the exception - // of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size - // (262,144 bytes, not 262,144 characters). - // - // * For SMS, each message can contain up - // to 140 characters. This character limit depends on the encoding schema. For - // example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or - // 70 UCS-2 characters. If you publish a message that exceeds this size limit, - // Amazon SNS sends the message as multiple messages, each fitting within the size - // limit. Messages aren't truncated mid-word but are cut off at whole-word - // boundaries. The total size limit for a single SMS Publish action is 1,600 - // characters. - // + // - With the exception of SMS, messages must be UTF-8 encoded strings and at + // most 256 KB in size (262,144 bytes, not 262,144 characters). + // - For SMS, each message can contain up to 140 characters. This character + // limit depends on the encoding schema. For example, an SMS message can contain + // 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish + // a message that exceeds this size limit, Amazon SNS sends the message as multiple + // messages, each fitting within the size limit. Messages aren't truncated mid-word + // but are cut off at whole-word boundaries. The total size limit for a single SMS + // Publish action is 1,600 characters. // JSON-specific constraints: - // - // * Keys in the JSON object that - // correspond to supported transport protocols must have simple JSON string - // values. - // - // * The values will be parsed (unescaped) before they are used in - // outgoing messages. - // - // * Outbound notifications are JSON encoded (meaning that the - // characters will be reescaped for sending). - // - // * Values have a minimum length of 0 - // (the empty string, "", is allowed). - // - // * Values have a maximum length bounded by - // the overall message size (so, including multiple protocols may limit message - // sizes). - // - // * Non-string values will cause the key to be ignored. - // - // * Keys that do - // not correspond to supported transport protocols are ignored. - // - // * Duplicate keys - // are not allowed. - // - // * Failure to parse or validate any key or value in the message - // will cause the Publish call to return an error (no partial delivery). + // - Keys in the JSON object that correspond to supported transport protocols + // must have simple JSON string values. + // - The values will be parsed (unescaped) before they are used in outgoing + // messages. + // - Outbound notifications are JSON encoded (meaning that the characters will + // be reescaped for sending). + // - Values have a minimum length of 0 (the empty string, "", is allowed). + // - Values have a maximum length bounded by the overall message size (so, + // including multiple protocols may limit message sizes). + // - Non-string values will cause the key to be ignored. + // - Keys that do not correspond to supported transport protocols are ignored. + // - Duplicate keys are not allowed. + // - Failure to parse or validate any key or value in the message will cause the + // Publish call to return an error (no partial delivery). // // This member is required. Message *string @@ -101,9 +81,9 @@ type PublishInput struct { // This parameter applies only to FIFO (first-in-first-out) topics. The // MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, - // 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). Every message must have - // a unique MessageDeduplicationId, which is a token used for deduplication of sent - // messages. If a message with a particular MessageDeduplicationId is sent + // 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . Every message must + // have a unique MessageDeduplicationId , which is a token used for deduplication + // of sent messages. If a message with a particular MessageDeduplicationId is sent // successfully, any message sent with the same MessageDeduplicationId during the // 5-minute deduplication interval is treated as a duplicate. If the topic has // ContentBasedDeduplication set, the system generates a MessageDeduplicationId @@ -112,28 +92,23 @@ type PublishInput struct { MessageDeduplicationId *string // This parameter applies only to FIFO (first-in-first-out) topics. The - // MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and - // punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). The MessageGroupId is a tag that - // specifies that a message belongs to a specific message group. Messages that - // belong to the same message group are processed in a FIFO manner (however, + // MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) + // and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . The MessageGroupId is a + // tag that specifies that a message belongs to a specific message group. Messages + // that belong to the same message group are processed in a FIFO manner (however, // messages in different message groups might be processed out of order). Every - // message must include a MessageGroupId. + // message must include a MessageGroupId . MessageGroupId *string // Set MessageStructure to json if you want to send a different message for each // protocol. For example, using one publish action, you can send a short message to // your SMS subscribers and a longer message to your email subscribers. If you set - // MessageStructure to json, the value of the Message parameter must: - // - // * be a - // syntactically valid JSON object; and - // - // * contain at least a top-level JSON key of - // "default" with a value that is a string. - // - // You can define other top-level keys - // that define the message you want to send to a specific transport protocol (e.g., - // "http"). Valid value: json + // MessageStructure to json , the value of the Message parameter must: + // - be a syntactically valid JSON object; and + // - contain at least a top-level JSON key of "default" with a value that is a + // string. + // You can define other top-level keys that define the message you want to send to + // a specific transport protocol (e.g., "http"). Valid value: json MessageStructure *string // The phone number to which you want to deliver an SMS message. Use E.164 format. @@ -169,8 +144,8 @@ type PublishOutput struct { // This response element applies only to FIFO (first-in-first-out) topics. The // sequence number is a large, non-consecutive number that Amazon SNS assigns to - // each message. The length of SequenceNumber is 128 bits. SequenceNumber continues - // to increase for each MessageGroupId. + // each message. The length of SequenceNumber is 128 bits. SequenceNumber + // continues to increase for each MessageGroupId . SequenceNumber *string // Metadata pertaining to the operation's result. diff --git a/service/sns/api_op_PublishBatch.go b/service/sns/api_op_PublishBatch.go index a84a1bb7b2d..dd3fcb1a142 100644 --- a/service/sns/api_op_PublishBatch.go +++ b/service/sns/api_op_PublishBatch.go @@ -12,12 +12,12 @@ import ( ) // Publishes up to ten messages to the specified topic. This is a batch version of -// Publish. For FIFO topics, multiple messages within a single batch are published +// Publish . For FIFO topics, multiple messages within a single batch are published // in the order they are sent, and messages are deduplicated within the batch and // across batches for 5 minutes. The result of publishing each message is reported // individually in the response. Because the batch request can result in a // combination of successful and unsuccessful actions, you should check for batch -// errors even when the call returns an HTTP status code of 200. The maximum +// errors even when the call returns an HTTP status code of 200 . The maximum // allowed individual message size and the maximum total payload size (the sum of // the individual lengths of all of the batched messages) are both 256 KB (262,144 // bytes). Some actions take lists of parameters. These lists are specified using diff --git a/service/sns/api_op_PutDataProtectionPolicy.go b/service/sns/api_op_PutDataProtectionPolicy.go index 34a3819f87f..96f72e137fe 100644 --- a/service/sns/api_op_PutDataProtectionPolicy.go +++ b/service/sns/api_op_PutDataProtectionPolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or updates an inline policy document that is stored in the specified Amazon -// SNS topic. +// Adds or updates an inline policy document that is stored in the specified +// Amazon SNS topic. func (c *Client) PutDataProtectionPolicy(ctx context.Context, params *PutDataProtectionPolicyInput, optFns ...func(*Options)) (*PutDataProtectionPolicyOutput, error) { if params == nil { params = &PutDataProtectionPolicyInput{} @@ -29,7 +29,7 @@ func (c *Client) PutDataProtectionPolicy(ctx context.Context, params *PutDataPro type PutDataProtectionPolicyInput struct { - // The JSON serialization of the topic's DataProtectionPolicy. The + // The JSON serialization of the topic's DataProtectionPolicy . The // DataProtectionPolicy must be in JSON string format. Length Constraints: Maximum // length of 30,720. // @@ -37,9 +37,8 @@ type PutDataProtectionPolicyInput struct { DataProtectionPolicy *string // The ARN of the topic whose DataProtectionPolicy you want to add or update. For - // more information about ARNs, see Amazon Resource Names (ARNs) - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. // // This member is required. ResourceArn *string diff --git a/service/sns/api_op_RemovePermission.go b/service/sns/api_op_RemovePermission.go index 958fd347548..032c6e38880 100644 --- a/service/sns/api_op_RemovePermission.go +++ b/service/sns/api_op_RemovePermission.go @@ -11,8 +11,8 @@ import ( ) // Removes a statement from a topic's access control policy. To remove the ability -// to change topic permissions, you must deny permissions to the AddPermission, -// RemovePermission, and SetTopicAttributes actions in your IAM policy. +// to change topic permissions, you must deny permissions to the AddPermission , +// RemovePermission , and SetTopicAttributes actions in your IAM policy. func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} diff --git a/service/sns/api_op_SetEndpointAttributes.go b/service/sns/api_op_SetEndpointAttributes.go index 907fa802d76..bdf57fc7ca8 100644 --- a/service/sns/api_op_SetEndpointAttributes.go +++ b/service/sns/api_op_SetEndpointAttributes.go @@ -12,8 +12,8 @@ import ( // Sets the attributes for an endpoint for a device on one of the supported push // notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more -// information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). +// information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . func (c *Client) SetEndpointAttributes(ctx context.Context, params *SetEndpointAttributesInput, optFns ...func(*Options)) (*SetEndpointAttributesOutput, error) { if params == nil { params = &SetEndpointAttributesInput{} @@ -32,22 +32,16 @@ func (c *Client) SetEndpointAttributes(ctx context.Context, params *SetEndpointA // Input for SetEndpointAttributes action. type SetEndpointAttributesInput struct { - // A map of the endpoint attributes. Attributes in this map include the - // following: - // - // * CustomUserData – arbitrary user data to associate with the - // endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format - // and less than 2KB. - // - // * Enabled – flag that enables/disables delivery to the - // endpoint. Amazon SNS will set this to false when a notification service - // indicates to Amazon SNS that the endpoint is invalid. Users can set it back to - // true, typically after updating Token. - // - // * Token – device token, also referred to - // as a registration id, for an app and mobile device. This is returned from the - // notification service when an app and mobile device are registered with the - // notification service. + // A map of the endpoint attributes. Attributes in this map include the following: + // - CustomUserData – arbitrary user data to associate with the endpoint. Amazon + // SNS does not use this data. The data must be in UTF-8 format and less than 2KB. + // - Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS + // will set this to false when a notification service indicates to Amazon SNS that + // the endpoint is invalid. Users can set it back to true, typically after updating + // Token. + // - Token – device token, also referred to as a registration id, for an app and + // mobile device. This is returned from the notification service when an app and + // mobile device are registered with the notification service. // // This member is required. Attributes map[string]string diff --git a/service/sns/api_op_SetPlatformApplicationAttributes.go b/service/sns/api_op_SetPlatformApplicationAttributes.go index 977c06c7957..a2d3ab9111f 100644 --- a/service/sns/api_op_SetPlatformApplicationAttributes.go +++ b/service/sns/api_op_SetPlatformApplicationAttributes.go @@ -12,11 +12,10 @@ import ( // Sets the attributes of the platform application object for the supported push // notification services, such as APNS and GCM (Firebase Cloud Messaging). For more -// information, see Using Amazon SNS Mobile Push Notifications -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). For information -// on configuring attributes for message delivery status, see Using Amazon SNS -// Application Attributes for Message Delivery Status -// (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html). +// information, see Using Amazon SNS Mobile Push Notifications (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html) +// . For information on configuring attributes for message delivery status, see +// Using Amazon SNS Application Attributes for Message Delivery Status (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html) +// . func (c *Client) SetPlatformApplicationAttributes(ctx context.Context, params *SetPlatformApplicationAttributesInput, optFns ...func(*Options)) (*SetPlatformApplicationAttributesOutput, error) { if params == nil { params = &SetPlatformApplicationAttributesInput{} @@ -35,71 +34,44 @@ func (c *Client) SetPlatformApplicationAttributes(ctx context.Context, params *S // Input for SetPlatformApplicationAttributes action. type SetPlatformApplicationAttributesInput struct { - // A map of the platform application attributes. Attributes in this map include the - // following: - // - // * PlatformCredential – The credential received from the notification - // service. - // - // * For ADM, PlatformCredentialis client secret. - // - // * For Apple Services - // using certificate credentials, PlatformCredential is private key. - // - // * For Apple - // Services using token credentials, PlatformCredential is signing key. - // - // * For GCM - // (Firebase Cloud Messaging), PlatformCredential is API key. - // - // * PlatformPrincipal - // – The principal received from the notification service. - // - // * For ADM, - // PlatformPrincipalis client id. - // - // * For Apple Services using certificate - // credentials, PlatformPrincipal is SSL certificate. - // - // * For Apple Services using - // token credentials, PlatformPrincipal is signing key ID. - // - // * For GCM (Firebase - // Cloud Messaging), there is no PlatformPrincipal. - // - // * EventEndpointCreated – Topic - // ARN to which EndpointCreated event notifications are sent. - // - // * - // EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications - // are sent. - // - // * EventEndpointUpdated – Topic ARN to which EndpointUpdate event - // notifications are sent. - // - // * EventDeliveryFailure – Topic ARN to which - // DeliveryFailure event notifications are sent upon Direct Publish delivery - // failure (permanent) to one of the application's endpoints. - // - // * - // SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to - // use CloudWatch Logs on your behalf. - // - // * FailureFeedbackRoleArn – IAM role ARN - // used to give Amazon SNS write access to use CloudWatch Logs on your behalf. - // - // * - // SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully - // delivered messages. - // - // The following attributes only apply to APNs token-based - // authentication: - // - // * ApplePlatformTeamID – The identifier that's assigned to your - // Apple developer account team. - // - // * ApplePlatformBundleID – The bundle identifier - // that's assigned to your iOS app. + // A map of the platform application attributes. Attributes in this map include + // the following: + // - PlatformCredential – The credential received from the notification service. + // - For ADM, PlatformCredential is client secret. + // - For Apple Services using certificate credentials, PlatformCredential is + // private key. + // - For Apple Services using token credentials, PlatformCredential is signing + // key. + // - For GCM (Firebase Cloud Messaging), PlatformCredential is API key. + // + // - PlatformPrincipal – The principal received from the notification service. + // - For ADM, PlatformPrincipal is client id. + // - For Apple Services using certificate credentials, PlatformPrincipal is SSL + // certificate. + // - For Apple Services using token credentials, PlatformPrincipal is signing key + // ID. + // - For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal . + // + // - EventEndpointCreated – Topic ARN to which EndpointCreated event + // notifications are sent. + // - EventEndpointDeleted – Topic ARN to which EndpointDeleted event + // notifications are sent. + // - EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications + // are sent. + // - EventDeliveryFailure – Topic ARN to which DeliveryFailure event + // notifications are sent upon Direct Publish delivery failure (permanent) to one + // of the application's endpoints. + // - SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access + // to use CloudWatch Logs on your behalf. + // - FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access + // to use CloudWatch Logs on your behalf. + // - SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully + // delivered messages. + // The following attributes only apply to APNs token-based authentication: + // - ApplePlatformTeamID – The identifier that's assigned to your Apple developer + // account team. + // - ApplePlatformBundleID – The bundle identifier that's assigned to your iOS + // app. // // This member is required. Attributes map[string]string diff --git a/service/sns/api_op_SetSMSAttributes.go b/service/sns/api_op_SetSMSAttributes.go index aa818327aad..e7e78af2f31 100644 --- a/service/sns/api_op_SetSMSAttributes.go +++ b/service/sns/api_op_SetSMSAttributes.go @@ -14,11 +14,10 @@ import ( // receiving daily SMS usage reports. You can override some of these settings for a // single message when you use the Publish action with the // MessageAttributes.entry.N parameter. For more information, see Publishing to a -// mobile phone -// (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the -// Amazon SNS Developer Guide. To use this operation, you must grant the Amazon SNS -// service principal (sns.amazonaws.com) permission to perform the s3:ListBucket -// action. +// mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) +// in the Amazon SNS Developer Guide. To use this operation, you must grant the +// Amazon SNS service principal ( sns.amazonaws.com ) permission to perform the +// s3:ListBucket action. func (c *Client) SetSMSAttributes(ctx context.Context, params *SetSMSAttributesInput, optFns ...func(*Options)) (*SetSMSAttributesOutput, error) { if params == nil { params = &SetSMSAttributesInput{} @@ -46,65 +45,46 @@ type SetSMSAttributesInput struct { // During that interval, if you continue to send SMS messages, you will incur costs // that exceed your limit. By default, the spend limit is set to the maximum // allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit - // Increase case - // (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns). - // For New limit value, enter your desired monthly spend limit. In the Use Case + // Increase case (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns) + // . For New limit value, enter your desired monthly spend limit. In the Use Case // Description field, explain that you are requesting an SMS monthly spend limit - // increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS - // to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that - // you send, Amazon SNS writes a log that includes the message price, the success - // or failure status, the reason for failure (if the message failed), the message - // dwell time, and other information. DeliveryStatusSuccessSamplingRate – The - // percentage of successful SMS deliveries for which Amazon SNS will write logs in - // CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write - // logs only for failed deliveries, set this value to 0. To write logs for 10% of - // your successful deliveries, set it to 10. DefaultSenderID – A string, such as - // your business brand, that is displayed as the sender on the receiving device. - // Support for sender IDs varies by country. The sender ID can be 1 - 11 + // increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon + // SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message + // that you send, Amazon SNS writes a log that includes the message price, the + // success or failure status, the reason for failure (if the message failed), the + // message dwell time, and other information. DeliveryStatusSuccessSamplingRate – + // The percentage of successful SMS deliveries for which Amazon SNS will write logs + // in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to + // write logs only for failed deliveries, set this value to 0 . To write logs for + // 10% of your successful deliveries, set it to 10 . DefaultSenderID – A string, + // such as your business brand, that is displayed as the sender on the receiving + // device. Support for sender IDs varies by country. The sender ID can be 1 - 11 // alphanumeric characters, and it must contain at least one letter. DefaultSMSType // – The type of SMS message that you will send by default. You can assign the // following values: - // - // * Promotional – (Default) Noncritical messages, such as - // marketing messages. Amazon SNS optimizes the message delivery to incur the - // lowest cost. - // - // * Transactional – Critical messages that support customer - // transactions, such as one-time passcodes for multi-factor authentication. Amazon - // SNS optimizes the message delivery to achieve the highest - // reliability. - // - // UsageReportS3Bucket – The name of the Amazon S3 bucket to receive - // daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a - // usage report as a CSV file to the bucket. The report includes the following - // information for each SMS message that was successfully delivered by your Amazon - // Web Services account: - // - // * Time that the message was published (in UTC) - // - // * Message - // ID - // - // * Destination phone number - // - // * Message type - // - // * Delivery status - // - // * Message - // price (in USD) - // - // * Part number (a message is split into multiple parts if it is - // too long for a single message) - // - // * Total number of parts - // - // To receive the report, - // the bucket must have a policy that allows the Amazon SNS service principal to - // perform the s3:PutObject and s3:GetBucketLocation actions. For an example bucket - // policy and usage report, see Monitoring SMS Activity - // (https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html) in the Amazon SNS - // Developer Guide. + // - Promotional – (Default) Noncritical messages, such as marketing messages. + // Amazon SNS optimizes the message delivery to incur the lowest cost. + // - Transactional – Critical messages that support customer transactions, such + // as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the + // message delivery to achieve the highest reliability. + // UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS + // usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report + // as a CSV file to the bucket. The report includes the following information for + // each SMS message that was successfully delivered by your Amazon Web Services + // account: + // - Time that the message was published (in UTC) + // - Message ID + // - Destination phone number + // - Message type + // - Delivery status + // - Message price (in USD) + // - Part number (a message is split into multiple parts if it is too long for a + // single message) + // - Total number of parts + // To receive the report, the bucket must have a policy that allows the Amazon SNS + // service principal to perform the s3:PutObject and s3:GetBucketLocation actions. + // For an example bucket policy and usage report, see Monitoring SMS Activity (https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html) + // in the Amazon SNS Developer Guide. // // This member is required. Attributes map[string]string diff --git a/service/sns/api_op_SetSubscriptionAttributes.go b/service/sns/api_op_SetSubscriptionAttributes.go index 5d0c8684d49..e110f0ec920 100644 --- a/service/sns/api_op_SetSubscriptionAttributes.go +++ b/service/sns/api_op_SetSubscriptionAttributes.go @@ -33,53 +33,33 @@ type SetSubscriptionAttributesInput struct { // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that this // action uses: - // - // * DeliveryPolicy – The policy that defines how Amazon SNS retries - // failed deliveries to HTTP/S endpoints. - // - // * FilterPolicy – The simple JSON object - // that lets your subscriber receive only a subset of messages, rather than - // receiving every message published to the topic. - // - // * FilterPolicyScope – This - // attribute lets you choose the filtering scope by using one of the following - // string value types: - // - // * MessageAttributes (default) – The filter is applied on - // the message attributes. - // - // * MessageBody – The filter is applied on the message - // body. - // - // * RawMessageDelivery – When set to true, enables raw message delivery to - // Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to - // process JSON formatting, which is otherwise created for Amazon SNS metadata. - // - // * - // RedrivePolicy – When specified, sends undeliverable messages to the specified - // Amazon SQS dead-letter queue. Messages that can't be delivered due to client - // errors (for example, when the subscribed endpoint is unreachable) or server - // errors (for example, when the service that powers the subscribed endpoint - // becomes unavailable) are held in the dead-letter queue for further analysis or - // reprocessing. - // - // The following attribute applies only to Amazon Kinesis Data - // Firehose delivery stream subscriptions: - // - // * SubscriptionRoleArn – The ARN of the - // IAM role that has the following: - // - // * Permission to write to the Kinesis Data - // Firehose delivery stream - // - // * Amazon SNS listed as a trusted entity - // - // Specifying a - // valid ARN for this attribute is required for Kinesis Data Firehose delivery - // stream subscriptions. For more information, see Fanout to Kinesis Data Firehose - // delivery streams - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in - // the Amazon SNS Developer Guide. + // - DeliveryPolicy – The policy that defines how Amazon SNS retries failed + // deliveries to HTTP/S endpoints. + // - FilterPolicy – The simple JSON object that lets your subscriber receive only + // a subset of messages, rather than receiving every message published to the + // topic. + // - FilterPolicyScope – This attribute lets you choose the filtering scope by + // using one of the following string value types: + // - MessageAttributes (default) – The filter is applied on the message + // attributes. + // - MessageBody – The filter is applied on the message body. + // - RawMessageDelivery – When set to true , enables raw message delivery to + // Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to + // process JSON formatting, which is otherwise created for Amazon SNS metadata. + // - RedrivePolicy – When specified, sends undeliverable messages to the + // specified Amazon SQS dead-letter queue. Messages that can't be delivered due to + // client errors (for example, when the subscribed endpoint is unreachable) or + // server errors (for example, when the service that powers the subscribed endpoint + // becomes unavailable) are held in the dead-letter queue for further analysis or + // reprocessing. + // The following attribute applies only to Amazon Kinesis Data Firehose delivery + // stream subscriptions: + // - SubscriptionRoleArn – The ARN of the IAM role that has the following: + // - Permission to write to the Kinesis Data Firehose delivery stream + // - Amazon SNS listed as a trusted entity Specifying a valid ARN for this + // attribute is required for Kinesis Data Firehose delivery stream subscriptions. + // For more information, see Fanout to Kinesis Data Firehose delivery streams (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // in the Amazon SNS Developer Guide. // // This member is required. AttributeName *string diff --git a/service/sns/api_op_SetTopicAttributes.go b/service/sns/api_op_SetTopicAttributes.go index 85e5362f287..915aeb0b9d4 100644 --- a/service/sns/api_op_SetTopicAttributes.go +++ b/service/sns/api_op_SetTopicAttributes.go @@ -12,7 +12,7 @@ import ( // Allows a topic owner to set an attribute of the topic to a new value. To remove // the ability to change topic permissions, you must deny permissions to the -// AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM +// AddPermission , RemovePermission , and SetTopicAttributes actions in your IAM // policy. func (c *Client) SetTopicAttributes(ctx context.Context, params *SetTopicAttributesInput, optFns ...func(*Options)) (*SetTopicAttributesOutput, error) { if params == nil { @@ -35,148 +35,95 @@ type SetTopicAttributesInput struct { // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // SetTopicAttributes action uses: - // - // * ApplicationSuccessFeedbackRoleArn – Indicates - // failed message delivery status for an Amazon SNS topic that is subscribed to a - // platform application endpoint. - // - // * DeliveryPolicy – The policy that defines how - // Amazon SNS retries failed deliveries to HTTP/S endpoints. - // - // * DisplayName – The - // display name to use for a topic with SMS subscriptions. - // - // * Policy – The policy - // that defines who can access your topic. By default, only the topic owner can - // publish or subscribe to the topic. - // - // * TracingConfig – Tracing mode of an Amazon - // SNS topic. By default TracingConfig is set to PassThrough, and the topic passes - // through the tracing header it receives from an Amazon SNS publisher to its - // subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to - // topic owner account if the sampled flag in the tracing header is true. This is - // only supported on standard topics. - // - // * HTTP - // - // * HTTPSuccessFeedbackRoleArn – - // Indicates successful message delivery status for an Amazon SNS topic that is - // subscribed to an HTTP endpoint. - // - // * HTTPSuccessFeedbackSampleRate – Indicates - // percentage of successful messages to sample for an Amazon SNS topic that is - // subscribed to an HTTP endpoint. - // - // * HTTPFailureFeedbackRoleArn – Indicates failed - // message delivery status for an Amazon SNS topic that is subscribed to an HTTP - // endpoint. - // - // * Amazon Kinesis Data Firehose - // - // * FirehoseSuccessFeedbackRoleArn – - // Indicates successful message delivery status for an Amazon SNS topic that is - // subscribed to an Amazon Kinesis Data Firehose endpoint. - // - // * - // FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages - // to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data - // Firehose endpoint. - // - // * FirehoseFailureFeedbackRoleArn – Indicates failed message - // delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis - // Data Firehose endpoint. - // - // * Lambda - // - // * LambdaSuccessFeedbackRoleArn – Indicates - // successful message delivery status for an Amazon SNS topic that is subscribed to - // an Lambda endpoint. - // - // * LambdaSuccessFeedbackSampleRate – Indicates percentage of - // successful messages to sample for an Amazon SNS topic that is subscribed to an - // Lambda endpoint. - // - // * LambdaFailureFeedbackRoleArn – Indicates failed message - // delivery status for an Amazon SNS topic that is subscribed to an Lambda - // endpoint. - // - // * Platform application endpoint - // - // * ApplicationSuccessFeedbackRoleArn - // – Indicates successful message delivery status for an Amazon SNS topic that is - // subscribed to an Amazon Web Services application endpoint. - // - // * - // ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful - // messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web - // Services application endpoint. - // - // * ApplicationFailureFeedbackRoleArn – Indicates - // failed message delivery status for an Amazon SNS topic that is subscribed to an - // Amazon Web Services application endpoint. - // - // In addition to being able to - // configure topic attributes for message delivery status of notification messages - // sent to Amazon SNS application endpoints, you can also configure application - // attributes for the delivery status of push notification messages sent to push - // notification services. For example, For more information, see Using Amazon SNS - // Application Attributes for Message Delivery Status - // (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html). - // - // * Amazon - // SQS - // - // * SQSSuccessFeedbackRoleArn – Indicates successful message delivery status - // for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. - // - // * - // SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to - // sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. - // - // * - // SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an - // Amazon SNS topic that is subscribed to an Amazon SQS endpoint. - // - // The - // SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to give - // Amazon SNS write access to use CloudWatch Logs on your behalf. The + // - ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status + // for an Amazon SNS topic that is subscribed to a platform application endpoint. + // - DeliveryPolicy – The policy that defines how Amazon SNS retries failed + // deliveries to HTTP/S endpoints. + // - DisplayName – The display name to use for a topic with SMS subscriptions. + // - Policy – The policy that defines who can access your topic. By default, only + // the topic owner can publish or subscribe to the topic. + // - TracingConfig – Tracing mode of an Amazon SNS topic. By default + // TracingConfig is set to PassThrough , and the topic passes through the tracing + // header it receives from an Amazon SNS publisher to its subscriptions. If set to + // Active , Amazon SNS will vend X-Ray segment data to topic owner account if the + // sampled flag in the tracing header is true. This is only supported on standard + // topics. + // - HTTP + // - HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status + // for an Amazon SNS topic that is subscribed to an HTTP endpoint. + // - HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages + // to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint. + // - HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an + // Amazon SNS topic that is subscribed to an HTTP endpoint. + // - Amazon Kinesis Data Firehose + // - FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery + // status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data + // Firehose endpoint. + // - FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful + // messages to sample for an Amazon SNS topic that is subscribed to an Amazon + // Kinesis Data Firehose endpoint. + // - FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status + // for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose + // endpoint. + // - Lambda + // - LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status + // for an Amazon SNS topic that is subscribed to an Lambda endpoint. + // - LambdaSuccessFeedbackSampleRate – Indicates percentage of successful + // messages to sample for an Amazon SNS topic that is subscribed to an Lambda + // endpoint. + // - LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for + // an Amazon SNS topic that is subscribed to an Lambda endpoint. + // - Platform application endpoint + // - ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery + // status for an Amazon SNS topic that is subscribed to an Amazon Web Services + // application endpoint. + // - ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful + // messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web + // Services application endpoint. + // - ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status + // for an Amazon SNS topic that is subscribed to an Amazon Web Services application + // endpoint. In addition to being able to configure topic attributes for message + // delivery status of notification messages sent to Amazon SNS application + // endpoints, you can also configure application attributes for the delivery status + // of push notification messages sent to push notification services. For example, + // For more information, see Using Amazon SNS Application Attributes for Message + // Delivery Status (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html) + // . + // - Amazon SQS + // - SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for + // an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. + // - SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages + // to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. + // - SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an + // Amazon SNS topic that is subscribed to an Amazon SQS endpoint. + // The SuccessFeedbackRoleArn and FailureFeedbackRoleArn attributes are used to + // give Amazon SNS write access to use CloudWatch Logs on your behalf. The // SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage // (0-100) of successfully delivered messages. After you configure the // FailureFeedbackRoleArn attribute, then all failed message deliveries generate - // CloudWatch Logs. The following attribute applies only to server-side-encryption - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html): - // - // * - // KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key - // (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). - // For more examples, see KeyId - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the Key Management Service API Reference. - // - // * SignatureVersion – The signature - // version corresponds to the hashing algorithm used while creating the signature - // of the notifications, subscription confirmations, or unsubscribe confirmation - // messages sent by Amazon SNS. By default, SignatureVersion is set to 1. - // - // The - // following attribute applies only to FIFO topics - // (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html): - // - // * - // ContentBasedDeduplication – Enables content-based deduplication for FIFO - // topics. - // - // * By default, ContentBasedDeduplication is set to false. If you create - // a FIFO topic and this attribute is false, you must specify a value for the - // MessageDeduplicationId parameter for the Publish - // (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. - // - // * When - // you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to - // generate the MessageDeduplicationId using the body of the message (but not the - // attributes of the message). (Optional) To override the generated value, you can - // specify a value for the MessageDeduplicationId parameter for the Publish action. + // CloudWatch Logs. The following attribute applies only to server-side-encryption (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) + // : + // - KmsMasterKeyId – The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) + // . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // in the Key Management Service API Reference. + // - SignatureVersion – The signature version corresponds to the hashing + // algorithm used while creating the signature of the notifications, subscription + // confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By + // default, SignatureVersion is set to 1 . + // The following attribute applies only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) + // : + // - ContentBasedDeduplication – Enables content-based deduplication for FIFO + // topics. + // - By default, ContentBasedDeduplication is set to false . If you create a FIFO + // topic and this attribute is false , you must specify a value for the + // MessageDeduplicationId parameter for the Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) + // action. + // - When you set ContentBasedDeduplication to true , Amazon SNS uses a SHA-256 + // hash to generate the MessageDeduplicationId using the body of the message (but + // not the attributes of the message). (Optional) To override the generated value, + // you can specify a value for the MessageDeduplicationId parameter for the + // Publish action. // // This member is required. AttributeName *string diff --git a/service/sns/api_op_Subscribe.go b/service/sns/api_op_Subscribe.go index 87d488cdfe6..571ccd142e3 100644 --- a/service/sns/api_op_Subscribe.go +++ b/service/sns/api_op_Subscribe.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or -// email, or if the endpoint and the topic are not in the same Amazon Web Services -// account, the endpoint owner must run the ConfirmSubscription action to confirm -// the subscription. You call the ConfirmSubscription action with the token from -// the subscription response. Confirmation tokens are valid for three days. This -// action is throttled at 100 transactions per second (TPS). +// Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S +// or email, or if the endpoint and the topic are not in the same Amazon Web +// Services account, the endpoint owner must run the ConfirmSubscription action to +// confirm the subscription. You call the ConfirmSubscription action with the +// token from the subscription response. Confirmation tokens are valid for three +// days. This action is throttled at 100 transactions per second (TPS). func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns ...func(*Options)) (*SubscribeOutput, error) { if params == nil { params = &SubscribeInput{} @@ -35,32 +35,17 @@ func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns . type SubscribeInput struct { // The protocol that you want to use. Supported protocols include: - // - // * http – - // delivery of JSON-encoded message via HTTP POST - // - // * https – delivery of - // JSON-encoded message via HTTPS POST - // - // * email – delivery of message via SMTP - // - // * - // email-json – delivery of JSON-encoded message via SMTP - // - // * sms – delivery of - // message via SMS - // - // * sqs – delivery of JSON-encoded message to an Amazon SQS - // queue - // - // * application – delivery of JSON-encoded message to an EndpointArn for a - // mobile app and device - // - // * lambda – delivery of JSON-encoded message to an Lambda - // function - // - // * firehose – delivery of JSON-encoded message to an Amazon Kinesis - // Data Firehose delivery stream. + // - http – delivery of JSON-encoded message via HTTP POST + // - https – delivery of JSON-encoded message via HTTPS POST + // - email – delivery of message via SMTP + // - email-json – delivery of JSON-encoded message via SMTP + // - sms – delivery of message via SMS + // - sqs – delivery of JSON-encoded message to an Amazon SQS queue + // - application – delivery of JSON-encoded message to an EndpointArn for a + // mobile app and device + // - lambda – delivery of JSON-encoded message to an Lambda function + // - firehose – delivery of JSON-encoded message to an Amazon Kinesis Data + // Firehose delivery stream. // // This member is required. Protocol *string @@ -73,94 +58,61 @@ type SubscribeInput struct { // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // Subscribe action uses: - // - // * DeliveryPolicy – The policy that defines how Amazon - // SNS retries failed deliveries to HTTP/S endpoints. - // - // * FilterPolicy – The simple - // JSON object that lets your subscriber receive only a subset of messages, rather - // than receiving every message published to the topic. - // - // * FilterPolicyScope – This - // attribute lets you choose the filtering scope by using one of the following - // string value types: - // - // * MessageAttributes (default) – The filter is applied on - // the message attributes. - // - // * MessageBody – The filter is applied on the message - // body. - // - // * RawMessageDelivery – When set to true, enables raw message delivery to - // Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to - // process JSON formatting, which is otherwise created for Amazon SNS metadata. - // - // * - // RedrivePolicy – When specified, sends undeliverable messages to the specified - // Amazon SQS dead-letter queue. Messages that can't be delivered due to client - // errors (for example, when the subscribed endpoint is unreachable) or server - // errors (for example, when the service that powers the subscribed endpoint - // becomes unavailable) are held in the dead-letter queue for further analysis or - // reprocessing. - // - // The following attribute applies only to Amazon Kinesis Data - // Firehose delivery stream subscriptions: - // - // * SubscriptionRoleArn – The ARN of the - // IAM role that has the following: - // - // * Permission to write to the Kinesis Data - // Firehose delivery stream - // - // * Amazon SNS listed as a trusted entity - // - // Specifying a - // valid ARN for this attribute is required for Kinesis Data Firehose delivery - // stream subscriptions. For more information, see Fanout to Kinesis Data Firehose - // delivery streams - // (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in - // the Amazon SNS Developer Guide. + // - DeliveryPolicy – The policy that defines how Amazon SNS retries failed + // deliveries to HTTP/S endpoints. + // - FilterPolicy – The simple JSON object that lets your subscriber receive only + // a subset of messages, rather than receiving every message published to the + // topic. + // - FilterPolicyScope – This attribute lets you choose the filtering scope by + // using one of the following string value types: + // - MessageAttributes (default) – The filter is applied on the message + // attributes. + // - MessageBody – The filter is applied on the message body. + // - RawMessageDelivery – When set to true , enables raw message delivery to + // Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to + // process JSON formatting, which is otherwise created for Amazon SNS metadata. + // - RedrivePolicy – When specified, sends undeliverable messages to the + // specified Amazon SQS dead-letter queue. Messages that can't be delivered due to + // client errors (for example, when the subscribed endpoint is unreachable) or + // server errors (for example, when the service that powers the subscribed endpoint + // becomes unavailable) are held in the dead-letter queue for further analysis or + // reprocessing. + // The following attribute applies only to Amazon Kinesis Data Firehose delivery + // stream subscriptions: + // - SubscriptionRoleArn – The ARN of the IAM role that has the following: + // - Permission to write to the Kinesis Data Firehose delivery stream + // - Amazon SNS listed as a trusted entity Specifying a valid ARN for this + // attribute is required for Kinesis Data Firehose delivery stream subscriptions. + // For more information, see Fanout to Kinesis Data Firehose delivery streams (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) + // in the Amazon SNS Developer Guide. Attributes map[string]string // The endpoint that you want to receive notifications. Endpoints vary by // protocol: - // - // * For the http protocol, the (public) endpoint is a URL beginning - // with http://. - // - // * For the https protocol, the (public) endpoint is a URL - // beginning with https://. - // - // * For the email protocol, the endpoint is an email - // address. - // - // * For the email-json protocol, the endpoint is an email address. - // - // * - // For the sms protocol, the endpoint is a phone number of an SMS-enabled - // device. - // - // * For the sqs protocol, the endpoint is the ARN of an Amazon SQS - // queue. - // - // * For the application protocol, the endpoint is the EndpointArn of a - // mobile app and device. - // - // * For the lambda protocol, the endpoint is the ARN of an - // Lambda function. - // - // * For the firehose protocol, the endpoint is the ARN of an - // Amazon Kinesis Data Firehose delivery stream. + // - For the http protocol, the (public) endpoint is a URL beginning with http:// + // . + // - For the https protocol, the (public) endpoint is a URL beginning with + // https:// . + // - For the email protocol, the endpoint is an email address. + // - For the email-json protocol, the endpoint is an email address. + // - For the sms protocol, the endpoint is a phone number of an SMS-enabled + // device. + // - For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue. + // - For the application protocol, the endpoint is the EndpointArn of a mobile + // app and device. + // - For the lambda protocol, the endpoint is the ARN of an Lambda function. + // - For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data + // Firehose delivery stream. Endpoint *string // Sets whether the response from the Subscribe request includes the subscription // ARN, even if the subscription is not yet confirmed. If you set this parameter to - // true, the response includes the ARN in all cases, even if the subscription is + // true , the response includes the ARN in all cases, even if the subscription is // not yet confirmed. In addition to the ARN for confirmed subscriptions, the - // response also includes the pending subscription ARN value for subscriptions that - // aren't yet confirmed. A subscription becomes confirmed when the subscriber calls - // the ConfirmSubscription action with a confirmation token. The default value is - // false. + // response also includes the pending subscription ARN value for subscriptions + // that aren't yet confirmed. A subscription becomes confirmed when the subscriber + // calls the ConfirmSubscription action with a confirmation token. The default + // value is false . ReturnSubscriptionArn bool noSmithyDocumentSerde diff --git a/service/sns/api_op_TagResource.go b/service/sns/api_op_TagResource.go index 089da5c12bb..47c4aed354d 100644 --- a/service/sns/api_op_TagResource.go +++ b/service/sns/api_op_TagResource.go @@ -11,26 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags -// (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon SNS -// Developer Guide. When you use topic tags, keep the following guidelines in -// mind: -// -// * Adding more than 50 tags to a topic isn't recommended. -// -// * Tags don't -// have any semantic meaning. Amazon SNS interprets tags as character strings. -// -// * -// Tags are case-sensitive. -// -// * A new tag with a key identical to that of an -// existing tag overwrites the existing tag. -// -// * Tagging actions are limited to 10 -// TPS per Amazon Web Services account, per Amazon Web Services Region. If your -// application requires a higher throughput, file a technical support request -// (https://console.aws.amazon.com/support/home#/case/create?issueType=technical). +// Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) +// in the Amazon SNS Developer Guide. When you use topic tags, keep the following +// guidelines in mind: +// - Adding more than 50 tags to a topic isn't recommended. +// - Tags don't have any semantic meaning. Amazon SNS interprets tags as +// character strings. +// - Tags are case-sensitive. +// - A new tag with a key identical to that of an existing tag overwrites the +// existing tag. +// - Tagging actions are limited to 10 TPS per Amazon Web Services account, per +// Amazon Web Services Region. If your application requires a higher throughput, +// file a technical support request (https://console.aws.amazon.com/support/home#/case/create?issueType=technical) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/sns/api_op_UntagResource.go b/service/sns/api_op_UntagResource.go index 707d1297b9f..c68a09a5b9f 100644 --- a/service/sns/api_op_UntagResource.go +++ b/service/sns/api_op_UntagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS -// Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon SNS -// Developer Guide. +// Remove tags from the specified Amazon SNS topic. For an overview, see Amazon +// SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the Amazon +// SNS Developer Guide. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/sns/api_op_VerifySMSSandboxPhoneNumber.go b/service/sns/api_op_VerifySMSSandboxPhoneNumber.go index 7717a969ad2..020cb3c60ed 100644 --- a/service/sns/api_op_VerifySMSSandboxPhoneNumber.go +++ b/service/sns/api_op_VerifySMSSandboxPhoneNumber.go @@ -18,9 +18,8 @@ import ( // is in the SMS sandbox, you can use all of the features of Amazon SNS. However, // you can send SMS messages only to verified destination phone numbers. For more // information, including how to move out of the sandbox to send messages without -// restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. func (c *Client) VerifySMSSandboxPhoneNumber(ctx context.Context, params *VerifySMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*VerifySMSSandboxPhoneNumberOutput, error) { if params == nil { params = &VerifySMSSandboxPhoneNumberInput{} diff --git a/service/sns/doc.go b/service/sns/doc.go index 7cb0b4438ce..387ca7c0018 100644 --- a/service/sns/doc.go +++ b/service/sns/doc.go @@ -8,15 +8,14 @@ // applications. Applications can use Amazon SNS to easily push real-time // notification messages to interested subscribers over multiple delivery // protocols. For more information about this product see the Amazon SNS product -// page (http://aws.amazon.com/sns/). For detailed information about Amazon SNS -// features and their associated API calls, see the Amazon SNS Developer Guide -// (https://docs.aws.amazon.com/sns/latest/dg/). For information on the permissions -// you need to use this API, see Identity and access management in Amazon SNS -// (https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html) +// page (http://aws.amazon.com/sns/) . For detailed information about Amazon SNS +// features and their associated API calls, see the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/) +// . For information on the permissions you need to use this API, see Identity and +// access management in Amazon SNS (https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html) // in the Amazon SNS Developer Guide. We also provide SDKs that enable you to // access Amazon SNS from your preferred programming language. The SDKs contain // functionality that automatically takes care of tasks such as: cryptographically // signing your service requests, retrying requests, and handling error responses. -// For a list of available SDKs, go to Tools for Amazon Web Services -// (http://aws.amazon.com/tools/). +// For a list of available SDKs, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/) +// . package sns diff --git a/service/sns/types/enums.go b/service/sns/types/enums.go index 9d6fa8a5b90..45639544b4b 100644 --- a/service/sns/types/enums.go +++ b/service/sns/types/enums.go @@ -71,9 +71,9 @@ const ( RouteTypePremium RouteType = "Premium" ) -// Values returns all known values for RouteType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for RouteType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (RouteType) Values() []RouteType { return []RouteType{ "Transactional", diff --git a/service/sns/types/errors.go b/service/sns/types/errors.go index 6fd885edec0..3fc0dcf06e1 100644 --- a/service/sns/types/errors.go +++ b/service/sns/types/errors.go @@ -33,7 +33,7 @@ func (e *AuthorizationErrorException) ErrorCode() string { } func (e *AuthorizationErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Two or more batch entries in the request have the same Id. +// Two or more batch entries in the request have the same Id . type BatchEntryIdsNotDistinctException struct { Message *string @@ -327,8 +327,8 @@ func (e *InvalidSecurityException) ErrorCode() string { } func (e *InvalidSecurityException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The ciphertext references a key that doesn't exist or that you don't have access -// to. +// The ciphertext references a key that doesn't exist or that you don't have +// access to. type KMSAccessDeniedException struct { Message *string @@ -381,11 +381,10 @@ func (e *KMSDisabledException) ErrorCode() string { } func (e *KMSDisabledException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the state of the specified resource isn't valid -// for this request. For more information, see How Key State Affects Use of a -// Customer Master Key -// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the -// Key Management Service Developer Guide. +// The request was rejected because the state of the specified resource isn't +// valid for this request. For more information, see How Key State Affects Use of +// a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// in the Key Management Service Developer Guide. type KMSInvalidStateException struct { Message *string @@ -465,8 +464,7 @@ func (e *KMSOptInRequired) ErrorCode() string { func (e *KMSOptInRequired) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was denied due to request throttling. For more information about -// throttling, see Limits -// (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the Key Management Service Developer Guide. type KMSThrottlingException struct { Message *string @@ -602,8 +600,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A tag has been added to a resource with the same ARN as a deleted resource. Wait -// a short while and then retry the operation. +// A tag has been added to a resource with the same ARN as a deleted resource. +// Wait a short while and then retry the operation. type StaleTagException struct { Message *string diff --git a/service/sns/types/types.go b/service/sns/types/types.go index 4ff3eff4951..0e8c617897a 100644 --- a/service/sns/types/types.go +++ b/service/sns/types/types.go @@ -45,21 +45,19 @@ type Endpoint struct { // The user-specified message attribute value. For string data types, the value // attribute has the same restrictions on the content as the message body. For more -// information, see Publish -// (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html). Name, type, and -// value must not be empty or null. In addition, the message body should not be -// empty or null. All parts of the message attribute, including name, type, and -// value, are included in the message size restriction, which is currently 256 KB -// (262,144 bytes). For more information, see Amazon SNS message attributes -// (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html) and -// Publishing to a mobile phone -// (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) in the -// Amazon SNS Developer Guide. +// information, see Publish (https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) +// . Name, type, and value must not be empty or null. In addition, the message body +// should not be empty or null. All parts of the message attribute, including name, +// type, and value, are included in the message size restriction, which is +// currently 256 KB (262,144 bytes). For more information, see Amazon SNS message +// attributes (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html) +// and Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) +// in the Amazon SNS Developer Guide. type MessageAttributeValue struct { // Amazon SNS supports the following logical data types: String, String.Array, - // Number, and Binary. For more information, see Message Attribute Data Types - // (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes). + // Number, and Binary. For more information, see Message Attribute Data Types (https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes) + // . // // This member is required. DataType *string @@ -69,8 +67,8 @@ type MessageAttributeValue struct { BinaryValue []byte // Strings are Unicode with UTF8 binary encoding. For a list of code values, see - // ASCII Printable Characters - // (https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). + // ASCII Printable Characters (https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) + // . StringValue *string noSmithyDocumentSerde @@ -129,10 +127,9 @@ type PublishBatchRequestEntry struct { // This member is required. Message *string - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SNS message attributes - // (https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html) in the - // Amazon SNS Developer Guide. + // Each message attribute consists of a Name , Type , and Value . For more + // information, see Amazon SNS message attributes (https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html) + // in the Amazon SNS Developer Guide. MessageAttributes map[string]MessageAttributeValue // This parameter applies only to FIFO (first-in-first-out) topics. The token used @@ -140,45 +137,32 @@ type PublishBatchRequestEntry struct { // If a message with a particular MessageDeduplicationId is sent successfully, // subsequent messages with the same MessageDeduplicationId are accepted // successfully but aren't delivered. - // - // * Every message must have a unique - // MessageDeduplicationId. - // - // * You may provide a MessageDeduplicationId - // explicitly. - // - // * If you aren't able to provide a MessageDeduplicationId and you - // enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash - // to generate the MessageDeduplicationId using the body of the message (but not - // the attributes of the message). - // - // * If you don't provide a MessageDeduplicationId - // and the topic doesn't have ContentBasedDeduplication set, the action fails with - // an error. - // - // * If the topic has a ContentBasedDeduplication set, your - // MessageDeduplicationId overrides the generated one. - // - // * When - // ContentBasedDeduplication is in effect, messages with identical content sent - // within the deduplication interval are treated as duplicates and only one copy of - // the message is delivered. - // - // * If you send one message with - // ContentBasedDeduplication enabled, and then another message with a - // MessageDeduplicationId that is the same as the one generated for the first - // MessageDeduplicationId, the two messages are treated as duplicates and only one - // copy of the message is delivered. - // - // The MessageDeduplicationId is available to - // the consumer of the message (this can be useful for troubleshooting delivery - // issues). If a message is sent successfully but the acknowledgement is lost and - // the message is resent with the same MessageDeduplicationId after the - // deduplication interval, Amazon SNS can't detect duplicate messages. Amazon SNS - // continues to keep track of the message deduplication ID even after the message - // is received and deleted. The length of MessageDeduplicationId is 128 characters. - // MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and - // punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). + // - Every message must have a unique MessageDeduplicationId . + // - You may provide a MessageDeduplicationId explicitly. + // - If you aren't able to provide a MessageDeduplicationId and you enable + // ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to + // generate the MessageDeduplicationId using the body of the message (but not the + // attributes of the message). + // - If you don't provide a MessageDeduplicationId and the topic doesn't have + // ContentBasedDeduplication set, the action fails with an error. + // - If the topic has a ContentBasedDeduplication set, your + // MessageDeduplicationId overrides the generated one. + // - When ContentBasedDeduplication is in effect, messages with identical content + // sent within the deduplication interval are treated as duplicates and only one + // copy of the message is delivered. + // - If you send one message with ContentBasedDeduplication enabled, and then + // another message with a MessageDeduplicationId that is the same as the one + // generated for the first MessageDeduplicationId , the two messages are treated + // as duplicates and only one copy of the message is delivered. + // The MessageDeduplicationId is available to the consumer of the message (this + // can be useful for troubleshooting delivery issues). If a message is sent + // successfully but the acknowledgement is lost and the message is resent with the + // same MessageDeduplicationId after the deduplication interval, Amazon SNS can't + // detect duplicate messages. Amazon SNS continues to keep track of the message + // deduplication ID even after the message is received and deleted. The length of + // MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain + // alphanumeric characters (a-z, A-Z, 0-9) and punctuation + // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . MessageDeduplicationId *string // This parameter applies only to FIFO (first-in-first-out) topics. The tag that @@ -189,27 +173,21 @@ type PublishBatchRequestEntry struct { // values (for example, session data for multiple users). In this scenario, // multiple consumers can process the topic, but the session data of each user is // processed in a FIFO fashion. You must associate a non-empty MessageGroupId with - // a message. If you don't provide a MessageGroupId, the action fails. The length + // a message. If you don't provide a MessageGroupId , the action fails. The length // of MessageGroupId is 128 characters. MessageGroupId can contain alphanumeric - // characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). - // MessageGroupId is required for FIFO topics. You can't use it for standard - // topics. + // characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . + // MessageGroupId is required for FIFO topics. You can't use it for standard topics. MessageGroupId *string // Set MessageStructure to json if you want to send a different message for each // protocol. For example, using one publish action, you can send a short message to // your SMS subscribers and a longer message to your email subscribers. If you set - // MessageStructure to json, the value of the Message parameter must: - // - // * be a - // syntactically valid JSON object; and - // - // * contain at least a top-level JSON key of - // "default" with a value that is a string. - // - // You can define other top-level keys - // that define the message you want to send to a specific transport protocol (e.g. - // http). + // MessageStructure to json , the value of the Message parameter must: + // - be a syntactically valid JSON object; and + // - contain at least a top-level JSON key of "default" with a value that is a + // string. + // You can define other top-level keys that define the message you want to send to + // a specific transport protocol (e.g. http). MessageStructure *string // The subject of the batch message. @@ -230,7 +208,7 @@ type PublishBatchResultEntry struct { // This parameter applies only to FIFO (first-in-first-out) topics. The large, // non-consecutive number that Amazon SNS assigns to each message. The length of // SequenceNumber is 128 bits. SequenceNumber continues to increase for a - // particular MessageGroupId. + // particular MessageGroupId . SequenceNumber *string noSmithyDocumentSerde @@ -243,9 +221,8 @@ type PublishBatchResultEntry struct { // Amazon Web Services account is in the SMS sandbox, you can use all of the // features of Amazon SNS. However, you can send SMS messages only to verified // destination phone numbers. For more information, including how to move out of -// the sandbox to send messages without restrictions, see SMS sandbox -// (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the Amazon -// SNS Developer Guide. +// the sandbox to send messages without restrictions, see SMS sandbox (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) +// in the Amazon SNS Developer Guide. type SMSSandboxPhoneNumber struct { // The destination phone number. @@ -294,8 +271,8 @@ type Tag struct { noSmithyDocumentSerde } -// A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's -// attributes, use GetTopicAttributes. +// A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a +// topic's attributes, use GetTopicAttributes . type Topic struct { // The topic's ARN. diff --git a/service/sqs/api_client.go b/service/sqs/api_client.go index 57602e07446..e93d9b92611 100644 --- a/service/sqs/api_client.go +++ b/service/sqs/api_client.go @@ -119,7 +119,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sqs/api_op_AddPermission.go b/service/sqs/api_op_AddPermission.go index 971e29e1daf..aca19433d77 100644 --- a/service/sqs/api_op_AddPermission.go +++ b/service/sqs/api_op_AddPermission.go @@ -10,35 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a permission to a queue for a specific principal -// (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). This allows -// sharing access to the queue. When you create a queue, you have full control -// access rights for the queue. Only you, the owner of the queue, can grant or deny -// permissions to the queue. For more information about these permissions, see -// Allow Developers to Write Messages to a Shared Queue -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) +// Adds a permission to a queue for a specific principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) +// . This allows sharing access to the queue. When you create a queue, you have +// full control access rights for the queue. Only you, the owner of the queue, can +// grant or deny permissions to the queue. For more information about these +// permissions, see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) // in the Amazon SQS Developer Guide. +// - AddPermission generates a policy for you. You can use SetQueueAttributes to +// upload your policy. For more information, see Using Custom Policies with the +// Amazon SQS Access Policy Language (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) +// in the Amazon SQS Developer Guide. +// - An Amazon SQS policy can have a maximum of 7 actions. +// - To remove the ability to change queue permissions, you must deny permission +// to the AddPermission , RemovePermission , and SetQueueAttributes actions in +// your IAM policy. // -// * AddPermission generates a policy for you. -// You can use SetQueueAttributes to upload your policy. For more information, see -// Using Custom Policies with the Amazon SQS Access Policy Language -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) -// in the Amazon SQS Developer Guide. -// -// * An Amazon SQS policy can have a maximum of -// 7 actions. -// -// * To remove the ability to change queue permissions, you must deny -// permission to the AddPermission, RemovePermission, and SetQueueAttributes -// actions in your IAM policy. -// -// Some actions take lists of parameters. These lists -// are specified using the param.n notation. Values of n are integers starting from -// 1. For example, a parameter list with two elements looks like this: -// &AttributeName.1=first&AttributeName.2=second Cross-account permissions don't -// apply to this action. For more information, see Grant cross-account permissions -// to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// Some actions take lists of parameters. These lists are specified using the +// param.n notation. Values of n are integers starting from 1. For example, a +// parameter list with two elements looks like this: &AttributeName.1=first +// &AttributeName.2=second Cross-account permissions don't apply to this action. +// For more information, see Grant cross-account permissions to a role and a user +// name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error) { if params == nil { @@ -57,32 +49,29 @@ func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, type AddPermissionInput struct { - // The Amazon Web Services account numbers of the principals - // (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) who are to - // receive permission. For information about locating the Amazon Web Services - // account identification, see Your Amazon Web Services Identifiers - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) + // The Amazon Web Services account numbers of the principals (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) + // who are to receive permission. For information about locating the Amazon Web + // Services account identification, see Your Amazon Web Services Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) // in the Amazon SQS Developer Guide. // // This member is required. AWSAccountIds []string // The action the client wants to allow for the specified principal. Valid values: - // the name of any action or *. For more information about these actions, see + // the name of any action or * . For more information about these actions, see // Overview of Managing Access Permissions to Your Amazon Simple Queue Service - // Resource - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html) - // in the Amazon SQS Developer Guide. Specifying SendMessage, DeleteMessage, or + // Resource (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html) + // in the Amazon SQS Developer Guide. Specifying SendMessage , DeleteMessage , or // ChangeMessageVisibility for ActionName.n also grants permissions for the - // corresponding batch versions of those actions: SendMessageBatch, - // DeleteMessageBatch, and ChangeMessageVisibilityBatch. + // corresponding batch versions of those actions: SendMessageBatch , + // DeleteMessageBatch , and ChangeMessageVisibilityBatch . // // This member is required. Actions []string // The unique identification of the permission you're setting (for example, - // AliceSendMessage). Maximum 80 characters. Allowed characters include - // alphanumeric characters, hyphens (-), and underscores (_). + // AliceSendMessage ). Maximum 80 characters. Allowed characters include + // alphanumeric characters, hyphens ( - ), and underscores ( _ ). // // This member is required. Label *string diff --git a/service/sqs/api_op_ChangeMessageVisibility.go b/service/sqs/api_op_ChangeMessageVisibility.go index 02d77e89543..35dce5c05cc 100644 --- a/service/sqs/api_op_ChangeMessageVisibility.go +++ b/service/sqs/api_op_ChangeMessageVisibility.go @@ -10,41 +10,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the visibility timeout of a specified message in a queue to a new value. -// The default visibility timeout for a message is 30 seconds. The minimum is 0 -// seconds. The maximum is 12 hours. For more information, see Visibility Timeout -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) +// Changes the visibility timeout of a specified message in a queue to a new +// value. The default visibility timeout for a message is 30 seconds. The minimum +// is 0 seconds. The maximum is 12 hours. For more information, see Visibility +// Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. For example, you have a message with a // visibility timeout of 5 minutes. After 3 minutes, you call // ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call // ChangeMessageVisibility to extend the visibility timeout to the maximum allowed // time. If you try to extend the visibility timeout beyond the maximum, your // request is rejected. An Amazon SQS message has three basic states: +// - Sent to a queue by a producer. +// - Received from the queue by a consumer. +// - Deleted from the queue. // -// * Sent to a -// queue by a producer. -// -// * Received from the queue by a consumer. -// -// * Deleted from -// the queue. -// -// A message is considered to be stored after it is sent to a queue by -// a producer, but not yet received from the queue by a consumer (that is, between -// states 1 and 2). There is no limit to the number of stored messages. A message -// is considered to be in flight after it is received from a queue by a consumer, -// but not yet deleted from the queue (that is, between states 2 and 3). There is a -// limit to the number of inflight messages. Limits that apply to inflight messages -// are unrelated to the unlimited number of stored messages. For most standard -// queues (depending on queue traffic and message backlog), there can be a maximum -// of approximately 120,000 inflight messages (received from a queue by a consumer, +// A message is considered to be stored after it is sent to a queue by a producer, +// but not yet received from the queue by a consumer (that is, between states 1 and +// 2). There is no limit to the number of stored messages. A message is considered +// to be in flight after it is received from a queue by a consumer, but not yet +// deleted from the queue (that is, between states 2 and 3). There is a limit to +// the number of inflight messages. Limits that apply to inflight messages are +// unrelated to the unlimited number of stored messages. For most standard queues +// (depending on queue traffic and message backlog), there can be a maximum of +// approximately 120,000 inflight messages (received from a queue by a consumer, // but not yet deleted from the queue). If you reach this limit, Amazon SQS returns // the OverLimit error message. To avoid reaching the limit, you should delete // messages from the queue after they're processed. You can also increase the // number of queues you use to process your messages. To request a limit increase, -// file a support request -// (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs). -// For FIFO queues, there can be a maximum of 20,000 inflight messages (received +// file a support request (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs) +// . For FIFO queues, there can be a maximum of 20,000 inflight messages (received // from a queue by a consumer, but not yet deleted from the queue). If you reach // this limit, Amazon SQS returns no error messages. If you attempt to set the // VisibilityTimeout to a value greater than the maximum time left, Amazon SQS @@ -85,7 +79,7 @@ type ChangeMessageVisibilityInput struct { ReceiptHandle *string // The new value for the message's visibility timeout (in seconds). Values range: 0 - // to 43200. Maximum: 12 hours. + // to 43200 . Maximum: 12 hours. // // This member is required. VisibilityTimeout int32 diff --git a/service/sqs/api_op_ChangeMessageVisibilityBatch.go b/service/sqs/api_op_ChangeMessageVisibilityBatch.go index 6781ca4aa61..4599b1ccf1e 100644 --- a/service/sqs/api_op_ChangeMessageVisibilityBatch.go +++ b/service/sqs/api_op_ChangeMessageVisibilityBatch.go @@ -12,16 +12,16 @@ import ( ) // Changes the visibility timeout of multiple messages. This is a batch version of -// ChangeMessageVisibility. The result of the action on each message is reported +// ChangeMessageVisibility . The result of the action on each message is reported // individually in the response. You can send up to 10 ChangeMessageVisibility // requests with each ChangeMessageVisibilityBatch action. Because the batch // request can result in a combination of successful and unsuccessful actions, you // should check for batch errors even when the call returns an HTTP status code of -// 200. Some actions take lists of parameters. These lists are specified using the +// 200 . Some actions take lists of parameters. These lists are specified using the // param.n notation. Values of n are integers starting from 1. For example, a // parameter list with two elements looks like this: &AttributeName.1=first // -// &AttributeName.2=second +// &AttributeName.2=second func (c *Client) ChangeMessageVisibilityBatch(ctx context.Context, params *ChangeMessageVisibilityBatchInput, optFns ...func(*Options)) (*ChangeMessageVisibilityBatchOutput, error) { if params == nil { params = &ChangeMessageVisibilityBatchInput{} diff --git a/service/sqs/api_op_CreateQueue.go b/service/sqs/api_op_CreateQueue.go index 950ec7c125b..00de2d107ac 100644 --- a/service/sqs/api_op_CreateQueue.go +++ b/service/sqs/api_op_CreateQueue.go @@ -10,48 +10,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new standard or FIFO queue. You can pass one or more attributes in the -// request. Keep the following in mind: +// Creates a new standard or FIFO queue. You can pass one or more attributes in +// the request. Keep the following in mind: +// - If you don't specify the FifoQueue attribute, Amazon SQS creates a standard +// queue. You can't change the queue type after you create it and you can't convert +// an existing standard queue into a FIFO queue. You must either create a new FIFO +// queue for your application or delete your existing standard queue and recreate +// it as a FIFO queue. For more information, see Moving From a Standard Queue to +// a FIFO Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) +// in the Amazon SQS Developer Guide. +// - If you don't provide a value for an attribute, the queue is created with +// the default value for the attribute. +// - If you delete a queue, you must wait at least 60 seconds before creating a +// queue with the same name. // -// * If you don't specify the FifoQueue -// attribute, Amazon SQS creates a standard queue. You can't change the queue type -// after you create it and you can't convert an existing standard queue into a FIFO -// queue. You must either create a new FIFO queue for your application or delete -// your existing standard queue and recreate it as a FIFO queue. For more -// information, see Moving From a Standard Queue to a FIFO Queue -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) -// in the Amazon SQS Developer Guide. -// -// * If you don't provide a value for an -// attribute, the queue is created with the default value for the attribute. -// -// * If -// you delete a queue, you must wait at least 60 seconds before creating a queue -// with the same name. -// -// To successfully create a new queue, you must provide a -// queue name that adheres to the limits related to queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) +// To successfully create a new queue, you must provide a queue name that adheres +// to the limits related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) // and is unique within the scope of your queues. After you create a queue, you // must wait at least one second after the queue is created to be able to use the // queue. To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires // only the QueueName parameter. be aware of existing queue names: +// - If you provide the name of an existing queue along with the exact names and +// values of all the queue's attributes, CreateQueue returns the queue URL for +// the existing queue. +// - If the queue name, attribute names, or attribute values don't match an +// existing queue, CreateQueue returns an error. // -// * If you -// provide the name of an existing queue along with the exact names and values of -// all the queue's attributes, CreateQueue returns the queue URL for the existing -// queue. -// -// * If the queue name, attribute names, or attribute values don't match an -// existing queue, CreateQueue returns an error. -// -// Some actions take lists of -// parameters. These lists are specified using the param.n notation. Values of n -// are integers starting from 1. For example, a parameter list with two elements -// looks like this: &AttributeName.1=first&AttributeName.2=second Cross-account -// permissions don't apply to this action. For more information, see Grant -// cross-account permissions to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// Some actions take lists of parameters. These lists are specified using the +// param.n notation. Values of n are integers starting from 1. For example, a +// parameter list with two elements looks like this: &AttributeName.1=first +// &AttributeName.2=second Cross-account permissions don't apply to this action. +// For more information, see Grant cross-account permissions to a role and a user +// name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error) { if params == nil { @@ -71,16 +61,9 @@ func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optF type CreateQueueInput struct { // The name of the new queue. The following limits apply to this name: - // - // * A queue - // name can have up to 80 characters. - // - // * Valid values: alphanumeric characters, - // hyphens (-), and underscores (_). - // - // * A FIFO queue name must end with the .fifo - // suffix. - // + // - A queue name can have up to 80 characters. + // - Valid values: alphanumeric characters, hyphens ( - ), and underscores ( _ ). + // - A FIFO queue name must end with the .fifo suffix. // Queue URLs and names are case-sensitive. // // This member is required. @@ -89,194 +72,123 @@ type CreateQueueInput struct { // A map of attributes with their corresponding values. The following lists the // names, descriptions, and values of the special request parameters that the // CreateQueue action uses: - // - // * DelaySeconds – The length of time, in seconds, for - // which the delivery of all messages in the queue is delayed. Valid values: An - // integer from 0 to 900 seconds (15 minutes). Default: 0. - // - // * MaximumMessageSize – - // The limit of how many bytes a message can contain before Amazon SQS rejects it. - // Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). - // Default: 262,144 (256 KiB). - // - // * MessageRetentionPeriod – The length of time, in - // seconds, for which Amazon SQS retains a message. Valid values: An integer from - // 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 - // days). - // - // * Policy – The queue's policy. A valid Amazon Web Services policy. For - // more information about policy structure, see Overview of Amazon Web Services IAM - // Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) in the - // Amazon IAM User Guide. - // - // * ReceiveMessageWaitTimeSeconds – The length of time, in - // seconds, for which a ReceiveMessage action waits for a message to arrive. Valid - // values: An integer from 0 to 20 (seconds). Default: 0. - // - // * RedrivePolicy – The - // string that includes the parameters for the dead-letter queue functionality of - // the source queue as a JSON object. For more information about the redrive policy - // and dead-letter queues, see Using Amazon SQS Dead-Letter Queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) - // in the Amazon SQS Developer Guide. - // - // * deadLetterTargetArn – The Amazon Resource - // Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the - // value of maxReceiveCount is exceeded. - // - // * maxReceiveCount – The number of times a - // message is delivered to the source queue before being moved to the dead-letter - // queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a - // queue, Amazon SQS moves the message to the dead-letter-queue. - // - // The dead-letter - // queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter - // queue of a standard queue must also be a standard queue. - // - // * VisibilityTimeout – - // The visibility timeout for the queue, in seconds. Valid values: An integer from - // 0 to 43,200 (12 hours). Default: 30. For more information about the visibility - // timeout, see Visibility Timeout - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) - // in the Amazon SQS Developer Guide. - // - // The following attributes apply only to - // server-side-encryption - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): - // - // * - // KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key - // (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). - // While the alias of the Amazon Web Services managed CMK for Amazon SQS is always - // alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . - // For more examples, see KeyId - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the Key Management Service API Reference. - // - // * KmsDataKeyReusePeriodSeconds – - // The length of time, in seconds, for which Amazon SQS can reuse a data key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) - // to encrypt or decrypt messages before calling KMS again. An integer representing - // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: - // 300 (5 minutes). A shorter time period provides better security but results in - // more calls to KMS which might incur charges after Free Tier. For more - // information, see How Does the Data Key Reuse Period Work? - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). - // - // * - // SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned - // encryption keys. Only one server-side encryption option is supported per queue - // (e.g. SSE-KMS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) - // or SSE-SQS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). - // - // The - // following attributes apply only to FIFO (first-in-first-out) queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): - // - // * - // FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you - // don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You - // can provide this attribute only during queue creation. You can't change it for - // an existing queue. When you set this attribute, you must also provide the - // MessageGroupId for your messages explicitly. For more information, see FIFO - // queue logic - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) - // in the Amazon SQS Developer Guide. - // - // * ContentBasedDeduplication – Enables - // content-based deduplication. Valid values are true and false. For more - // information, see Exactly-once processing - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) - // in the Amazon SQS Developer Guide. Note the following: - // - // * Every message must - // have a unique MessageDeduplicationId. - // - // * You may provide a - // MessageDeduplicationId explicitly. - // - // * If you aren't able to provide a - // MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, - // Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the - // body of the message (but not the attributes of the message). - // - // * If you don't - // provide a MessageDeduplicationId and the queue doesn't have - // ContentBasedDeduplication set, the action fails with an error. - // - // * If the queue - // has ContentBasedDeduplication set, your MessageDeduplicationId overrides the - // generated one. - // - // * When ContentBasedDeduplication is in effect, messages with - // identical content sent within the deduplication interval are treated as - // duplicates and only one copy of the message is delivered. - // - // * If you send one - // message with ContentBasedDeduplication enabled and then another message with a - // MessageDeduplicationId that is the same as the one generated for the first - // MessageDeduplicationId, the two messages are treated as duplicates and only one - // copy of the message is delivered. - // - // The following attributes apply only to high - // throughput for FIFO queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): - // - // * - // DeduplicationScope – Specifies whether message deduplication occurs at the - // message group or queue level. Valid values are messageGroup and queue. - // - // * - // FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies - // to the entire queue or per message group. Valid values are perQueue and - // perMessageGroupId. The perMessageGroupId value is allowed only when the value - // for DeduplicationScope is messageGroup. - // - // To enable high throughput for FIFO - // queues, do the following: - // - // * Set DeduplicationScope to messageGroup. - // - // * Set - // FifoThroughputLimit to perMessageGroupId. - // - // If you set these attributes to - // anything other than the values shown for enabling high throughput, normal - // throughput is in effect and deduplication occurs as specified. For information - // on throughput quotas, see Quotas related to messages - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) + // - DelaySeconds – The length of time, in seconds, for which the delivery of all + // messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds + // (15 minutes). Default: 0. + // - MaximumMessageSize – The limit of how many bytes a message can contain + // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) + // to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). + // - MessageRetentionPeriod – The length of time, in seconds, for which Amazon + // SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to + // 1,209,600 seconds (14 days). Default: 345,600 (4 days). + // - Policy – The queue's policy. A valid Amazon Web Services policy. For more + // information about policy structure, see Overview of Amazon Web Services IAM + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) + // in the Amazon IAM User Guide. + // - ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a + // ReceiveMessage action waits for a message to arrive. Valid values: An integer + // from 0 to 20 (seconds). Default: 0. + // - RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information + // about the redrive policy and dead-letter queues, see Using Amazon SQS + // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // in the Amazon SQS Developer Guide. + // - deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter + // queue to which Amazon SQS moves messages after the value of maxReceiveCount is + // exceeded. + // - maxReceiveCount – The number of times a message is delivered to the source + // queue before being moved to the dead-letter queue. When the ReceiveCount for a + // message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message + // to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be + // a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be + // a standard queue. + // - VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid + // values: An integer from 0 to 43,200 (12 hours). Default: 30. For more + // information about the visibility timeout, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) + // in the Amazon SQS Developer Guide. + // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) + // : + // - KmsMasterKeyId – The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms) + // . While the alias of the Amazon Web Services managed CMK for Amazon SQS is + // always alias/aws/sqs , the alias of a custom CMK can, for example, be + // alias/MyAlias . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // in the Key Management Service API Reference. + // - KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which + // Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) + // to encrypt or decrypt messages before calling KMS again. An integer representing + // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: + // 300 (5 minutes). A shorter time period provides better security but results in + // more calls to KMS which might incur charges after Free Tier. For more + // information, see How Does the Data Key Reuse Period Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) + // . + // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned + // encryption keys. Only one server-side encryption option is supported per queue + // (e.g. SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) + // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) + // ). + // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) + // : + // - FifoQueue – Designates a queue as FIFO. Valid values are true and false . If + // you don't specify the FifoQueue attribute, Amazon SQS creates a standard + // queue. You can provide this attribute only during queue creation. You can't + // change it for an existing queue. When you set this attribute, you must also + // provide the MessageGroupId for your messages explicitly. For more information, + // see FIFO queue logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) + // in the Amazon SQS Developer Guide. + // - ContentBasedDeduplication – Enables content-based deduplication. Valid + // values are true and false . For more information, see Exactly-once processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) + // in the Amazon SQS Developer Guide. Note the following: + // - Every message must have a unique MessageDeduplicationId . + // - You may provide a MessageDeduplicationId explicitly. + // - If you aren't able to provide a MessageDeduplicationId and you enable + // ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to + // generate the MessageDeduplicationId using the body of the message (but not the + // attributes of the message). + // - If you don't provide a MessageDeduplicationId and the queue doesn't have + // ContentBasedDeduplication set, the action fails with an error. + // - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId + // overrides the generated one. + // - When ContentBasedDeduplication is in effect, messages with identical content + // sent within the deduplication interval are treated as duplicates and only one + // copy of the message is delivered. + // - If you send one message with ContentBasedDeduplication enabled and then + // another message with a MessageDeduplicationId that is the same as the one + // generated for the first MessageDeduplicationId , the two messages are treated + // as duplicates and only one copy of the message is delivered. + // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) + // : + // - DeduplicationScope – Specifies whether message deduplication occurs at the + // message group or queue level. Valid values are messageGroup and queue . + // - FifoThroughputLimit – Specifies whether the FIFO queue throughput quota + // applies to the entire queue or per message group. Valid values are perQueue + // and perMessageGroupId . The perMessageGroupId value is allowed only when the + // value for DeduplicationScope is messageGroup . + // To enable high throughput for FIFO queues, do the following: + // - Set DeduplicationScope to messageGroup . + // - Set FifoThroughputLimit to perMessageGroupId . + // If you set these attributes to anything other than the values shown for + // enabling high throughput, normal throughput is in effect and deduplication + // occurs as specified. For information on throughput quotas, see Quotas related + // to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. Attributes map[string]string - // Add cost allocation tags to the specified Amazon SQS queue. For an overview, see - // Tagging Your Amazon SQS Queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) + // Add cost allocation tags to the specified Amazon SQS queue. For an overview, + // see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) // in the Amazon SQS Developer Guide. When you use queue tags, keep the following // guidelines in mind: - // - // * Adding more than 50 tags to a queue isn't recommended. - // - // * - // Tags don't have any semantic meaning. Amazon SQS interprets tags as character - // strings. - // - // * Tags are case-sensitive. - // - // * A new tag with a key identical to that - // of an existing tag overwrites the existing tag. - // - // For a full list of tag - // restrictions, see Quotas related to queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) + // - Adding more than 50 tags to a queue isn't recommended. + // - Tags don't have any semantic meaning. Amazon SQS interprets tags as + // character strings. + // - Tags are case-sensitive. + // - A new tag with a key identical to that of an existing tag overwrites the + // existing tag. + // For a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) // in the Amazon SQS Developer Guide. To be able to tag a queue on creation, you // must have the sqs:CreateQueue and sqs:TagQueue permissions. Cross-account // permissions don't apply to this action. For more information, see Grant - // cross-account permissions to a role and a user name - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) + // cross-account permissions to a role and a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. Tags map[string]string diff --git a/service/sqs/api_op_DeleteMessage.go b/service/sqs/api_op_DeleteMessage.go index 7d8e6fe9b78..12de6e601fc 100644 --- a/service/sqs/api_op_DeleteMessage.go +++ b/service/sqs/api_op_DeleteMessage.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified message from the specified queue. To select the message to -// delete, use the ReceiptHandle of the message (not the MessageId which you +// Deletes the specified message from the specified queue. To select the message +// to delete, use the ReceiptHandle of the message (not the MessageId which you // receive when you send the message). Amazon SQS can delete a message from a queue // even if a visibility timeout setting causes the message to be locked by another // consumer. Amazon SQS automatically deletes messages left in a queue longer than diff --git a/service/sqs/api_op_DeleteMessageBatch.go b/service/sqs/api_op_DeleteMessageBatch.go index 2fe221baa9c..6f4978a5e10 100644 --- a/service/sqs/api_op_DeleteMessageBatch.go +++ b/service/sqs/api_op_DeleteMessageBatch.go @@ -12,13 +12,13 @@ import ( ) // Deletes up to ten messages from the specified queue. This is a batch version of -// DeleteMessage. The result of the action on each message is reported individually -// in the response. Because the batch request can result in a combination of -// successful and unsuccessful actions, you should check for batch errors even when -// the call returns an HTTP status code of 200. Some actions take lists of -// parameters. These lists are specified using the param.n notation. Values of n -// are integers starting from 1. For example, a parameter list with two elements -// looks like this: &AttributeName.1=first +// DeleteMessage . The result of the action on each message is reported +// individually in the response. Because the batch request can result in a +// combination of successful and unsuccessful actions, you should check for batch +// errors even when the call returns an HTTP status code of 200 . Some actions take +// lists of parameters. These lists are specified using the param.n notation. +// Values of n are integers starting from 1. For example, a parameter list with +// two elements looks like this: &AttributeName.1=first // // &AttributeName.2=second func (c *Client) DeleteMessageBatch(ctx context.Context, params *DeleteMessageBatchInput, optFns ...func(*Options)) (*DeleteMessageBatchOutput, error) { diff --git a/service/sqs/api_op_DeleteQueue.go b/service/sqs/api_op_DeleteQueue.go index b5eab8d47e7..25809ca597f 100644 --- a/service/sqs/api_op_DeleteQueue.go +++ b/service/sqs/api_op_DeleteQueue.go @@ -10,16 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the queue specified by the QueueUrl, regardless of the queue's contents. -// Be careful with the DeleteQueue action: When you delete a queue, any messages in -// the queue are no longer available. When you delete a queue, the deletion process -// takes up to 60 seconds. Requests you send involving that queue during the 60 -// seconds might succeed. For example, a SendMessage request might succeed, but -// after 60 seconds the queue and the message you sent no longer exist. When you -// delete a queue, you must wait at least 60 seconds before creating a queue with -// the same name. Cross-account permissions don't apply to this action. For more -// information, see Grant cross-account permissions to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// Deletes the queue specified by the QueueUrl , regardless of the queue's +// contents. Be careful with the DeleteQueue action: When you delete a queue, any +// messages in the queue are no longer available. When you delete a queue, the +// deletion process takes up to 60 seconds. Requests you send involving that queue +// during the 60 seconds might succeed. For example, a SendMessage request might +// succeed, but after 60 seconds the queue and the message you sent no longer +// exist. When you delete a queue, you must wait at least 60 seconds before +// creating a queue with the same name. Cross-account permissions don't apply to +// this action. For more information, see Grant cross-account permissions to a +// role and a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error) { if params == nil { diff --git a/service/sqs/api_op_GetQueueAttributes.go b/service/sqs/api_op_GetQueueAttributes.go index 82be851ba71..76bcd4d613d 100644 --- a/service/sqs/api_op_GetQueueAttributes.go +++ b/service/sqs/api_op_GetQueueAttributes.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets attributes for the specified queue. To determine whether a queue is FIFO -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), -// you can check whether QueueName ends with the .fifo suffix. +// Gets attributes for the specified queue. To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) +// , you can check whether QueueName ends with the .fifo suffix. func (c *Client) GetQueueAttributes(ctx context.Context, params *GetQueueAttributesInput, optFns ...func(*Options)) (*GetQueueAttributesOutput, error) { if params == nil { params = &GetQueueAttributesInput{} @@ -42,148 +41,90 @@ type GetQueueAttributesInput struct { // request returns empty results. In the future, new attributes might be added. If // you write code that calls this action, we recommend that you structure your code // so that it can handle new attributes gracefully. The following attributes are - // supported: The ApproximateNumberOfMessagesDelayed, - // ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible + // supported: The ApproximateNumberOfMessagesDelayed , + // ApproximateNumberOfMessagesNotVisible , and ApproximateNumberOfMessagesVisible // metrics may not achieve consistency until at least 1 minute after the producers // stop sending messages. This period is required for the queue metadata to reach // eventual consistency. - // - // * All – Returns all values. - // - // * - // ApproximateNumberOfMessages – Returns the approximate number of messages - // available for retrieval from the queue. - // - // * ApproximateNumberOfMessagesDelayed – - // Returns the approximate number of messages in the queue that are delayed and not - // available for reading immediately. This can happen when the queue is configured - // as a delay queue or when a message has been sent with a delay parameter. - // - // * - // ApproximateNumberOfMessagesNotVisible – Returns the approximate number of - // messages that are in flight. Messages are considered to be in flight if they - // have been sent to a client but have not yet been deleted or have not yet reached - // the end of their visibility window. - // - // * CreatedTimestamp – Returns the time when - // the queue was created in seconds (epoch time - // (http://en.wikipedia.org/wiki/Unix_time)). - // - // * DelaySeconds – Returns the default - // delay on the queue in seconds. - // - // * LastModifiedTimestamp – Returns the time when - // the queue was last changed in seconds (epoch time - // (http://en.wikipedia.org/wiki/Unix_time)). - // - // * MaximumMessageSize – Returns the - // limit of how many bytes a message can contain before Amazon SQS rejects it. - // - // * - // MessageRetentionPeriod – Returns the length of time, in seconds, for which - // Amazon SQS retains a message. - // - // * Policy – Returns the policy of the queue. - // - // * - // QueueArn – Returns the Amazon resource name (ARN) of the queue. - // - // * - // ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for - // which the ReceiveMessage action waits for a message to arrive. - // - // * RedrivePolicy - // – The string that includes the parameters for the dead-letter queue - // functionality of the source queue as a JSON object. For more information about - // the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter - // Queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) - // in the Amazon SQS Developer Guide. - // - // * deadLetterTargetArn – The Amazon Resource - // Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the - // value of maxReceiveCount is exceeded. - // - // * maxReceiveCount – The number of times a - // message is delivered to the source queue before being moved to the dead-letter - // queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a - // queue, Amazon SQS moves the message to the dead-letter-queue. - // - // * - // VisibilityTimeout – Returns the visibility timeout for the queue. For more - // information about the visibility timeout, see Visibility Timeout - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) - // in the Amazon SQS Developer Guide. - // - // The following attributes apply only to - // server-side-encryption - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): - // - // * - // KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer - // master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key - // Terms - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). - // - // * - // KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which - // Amazon SQS can reuse a data key to encrypt or decrypt messages before calling - // KMS again. For more information, see How Does the Data Key Reuse Period Work? - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). - // - // * - // SqsManagedSseEnabled – Returns information about whether the queue is using - // SSE-SQS encryption using SQS owned encryption keys. Only one server-side - // encryption option is supported per queue (e.g. SSE-KMS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) - // or SSE-SQS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). - // - // The - // following attributes apply only to FIFO (first-in-first-out) queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): - // - // * - // FifoQueue – Returns information about whether the queue is FIFO. For more - // information, see FIFO queue logic - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) - // in the Amazon SQS Developer Guide. To determine whether a queue is FIFO - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), - // you can check whether QueueName ends with the .fifo suffix. - // - // * - // ContentBasedDeduplication – Returns whether content-based deduplication is - // enabled for the queue. For more information, see Exactly-once processing - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) - // in the Amazon SQS Developer Guide. - // - // The following attributes apply only to high - // throughput for FIFO queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): - // - // * - // DeduplicationScope – Specifies whether message deduplication occurs at the - // message group or queue level. Valid values are messageGroup and queue. - // - // * - // FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies - // to the entire queue or per message group. Valid values are perQueue and - // perMessageGroupId. The perMessageGroupId value is allowed only when the value - // for DeduplicationScope is messageGroup. - // - // To enable high throughput for FIFO - // queues, do the following: - // - // * Set DeduplicationScope to messageGroup. - // - // * Set - // FifoThroughputLimit to perMessageGroupId. - // - // If you set these attributes to - // anything other than the values shown for enabling high throughput, normal - // throughput is in effect and deduplication occurs as specified. For information - // on throughput quotas, see Quotas related to messages - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) + // - All – Returns all values. + // - ApproximateNumberOfMessages – Returns the approximate number of messages + // available for retrieval from the queue. + // - ApproximateNumberOfMessagesDelayed – Returns the approximate number of + // messages in the queue that are delayed and not available for reading + // immediately. This can happen when the queue is configured as a delay queue or + // when a message has been sent with a delay parameter. + // - ApproximateNumberOfMessagesNotVisible – Returns the approximate number of + // messages that are in flight. Messages are considered to be in flight if they + // have been sent to a client but have not yet been deleted or have not yet reached + // the end of their visibility window. + // - CreatedTimestamp – Returns the time when the queue was created in seconds ( + // epoch time (http://en.wikipedia.org/wiki/Unix_time) ). + // - DelaySeconds – Returns the default delay on the queue in seconds. + // - LastModifiedTimestamp – Returns the time when the queue was last changed in + // seconds ( epoch time (http://en.wikipedia.org/wiki/Unix_time) ). + // - MaximumMessageSize – Returns the limit of how many bytes a message can + // contain before Amazon SQS rejects it. + // - MessageRetentionPeriod – Returns the length of time, in seconds, for which + // Amazon SQS retains a message. + // - Policy – Returns the policy of the queue. + // - QueueArn – Returns the Amazon resource name (ARN) of the queue. + // - ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for + // which the ReceiveMessage action waits for a message to arrive. + // - RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information + // about the redrive policy and dead-letter queues, see Using Amazon SQS + // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // in the Amazon SQS Developer Guide. + // - deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter + // queue to which Amazon SQS moves messages after the value of maxReceiveCount is + // exceeded. + // - maxReceiveCount – The number of times a message is delivered to the source + // queue before being moved to the dead-letter queue. When the ReceiveCount for a + // message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message + // to the dead-letter-queue. + // - VisibilityTimeout – Returns the visibility timeout for the queue. For more + // information about the visibility timeout, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) + // in the Amazon SQS Developer Guide. + // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) + // : + // - KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer + // master key (CMK) for Amazon SQS or a custom CMK. For more information, see + // Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms) + // . + // - KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for + // which Amazon SQS can reuse a data key to encrypt or decrypt messages before + // calling KMS again. For more information, see How Does the Data Key Reuse + // Period Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) + // . + // - SqsManagedSseEnabled – Returns information about whether the queue is using + // SSE-SQS encryption using SQS owned encryption keys. Only one server-side + // encryption option is supported per queue (e.g. SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) + // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) + // ). + // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) + // : + // - FifoQueue – Returns information about whether the queue is FIFO. For more + // information, see FIFO queue logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) + // in the Amazon SQS Developer Guide. To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) + // , you can check whether QueueName ends with the .fifo suffix. + // - ContentBasedDeduplication – Returns whether content-based deduplication is + // enabled for the queue. For more information, see Exactly-once processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) + // in the Amazon SQS Developer Guide. + // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) + // : + // - DeduplicationScope – Specifies whether message deduplication occurs at the + // message group or queue level. Valid values are messageGroup and queue . + // - FifoThroughputLimit – Specifies whether the FIFO queue throughput quota + // applies to the entire queue or per message group. Valid values are perQueue + // and perMessageGroupId . The perMessageGroupId value is allowed only when the + // value for DeduplicationScope is messageGroup . + // To enable high throughput for FIFO queues, do the following: + // - Set DeduplicationScope to messageGroup . + // - Set FifoThroughputLimit to perMessageGroupId . + // If you set these attributes to anything other than the values shown for + // enabling high throughput, normal throughput is in effect and deduplication + // occurs as specified. For information on throughput quotas, see Quotas related + // to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. AttributeNames []types.QueueAttributeName diff --git a/service/sqs/api_op_GetQueueUrl.go b/service/sqs/api_op_GetQueueUrl.go index b27b4153a8b..94036e52418 100644 --- a/service/sqs/api_op_GetQueueUrl.go +++ b/service/sqs/api_op_GetQueueUrl.go @@ -14,8 +14,7 @@ import ( // to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the // account ID of the queue's owner. The queue's owner must grant you permission to // access the queue. For more information about shared queue access, see -// AddPermission or see Allow Developers to Write Messages to a Shared Queue -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) +// AddPermission or see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) // in the Amazon SQS Developer Guide. func (c *Client) GetQueueUrl(ctx context.Context, params *GetQueueUrlInput, optFns ...func(*Options)) (*GetQueueUrlOutput, error) { if params == nil { @@ -35,8 +34,8 @@ func (c *Client) GetQueueUrl(ctx context.Context, params *GetQueueUrlInput, optF type GetQueueUrlInput struct { // The name of the queue whose URL must be fetched. Maximum 80 characters. Valid - // values: alphanumeric characters, hyphens (-), and underscores (_). Queue URLs - // and names are case-sensitive. + // values: alphanumeric characters, hyphens ( - ), and underscores ( _ ). Queue + // URLs and names are case-sensitive. // // This member is required. QueueName *string @@ -47,8 +46,7 @@ type GetQueueUrlInput struct { noSmithyDocumentSerde } -// For more information, see Interpreting Responses -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) +// For more information, see Interpreting Responses (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) // in the Amazon SQS Developer Guide. type GetQueueUrlOutput struct { diff --git a/service/sqs/api_op_ListDeadLetterSourceQueues.go b/service/sqs/api_op_ListDeadLetterSourceQueues.go index 0a8481d45bb..4f8f04a680a 100644 --- a/service/sqs/api_op_ListDeadLetterSourceQueues.go +++ b/service/sqs/api_op_ListDeadLetterSourceQueues.go @@ -15,13 +15,12 @@ import ( // configured with a dead-letter queue. The ListDeadLetterSourceQueues methods // supports pagination. Set parameter MaxResults in the request to specify the // maximum number of results to be returned in the response. If you do not set -// MaxResults, the response includes a maximum of 1,000 results. If you set +// MaxResults , the response includes a maximum of 1,000 results. If you set // MaxResults and there are additional results to display, the response includes a -// value for NextToken. Use NextToken as a parameter in your next request to +// value for NextToken . Use NextToken as a parameter in your next request to // ListDeadLetterSourceQueues to receive the next page of results. For more // information about using dead-letter queues, see Using Amazon SQS Dead-Letter -// Queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) +// Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // in the Amazon SQS Developer Guide. func (c *Client) ListDeadLetterSourceQueues(ctx context.Context, params *ListDeadLetterSourceQueuesInput, optFns ...func(*Options)) (*ListDeadLetterSourceQueuesOutput, error) { if params == nil { diff --git a/service/sqs/api_op_ListQueueTags.go b/service/sqs/api_op_ListQueueTags.go index b40539f74ef..eba892c7c7e 100644 --- a/service/sqs/api_op_ListQueueTags.go +++ b/service/sqs/api_op_ListQueueTags.go @@ -11,12 +11,10 @@ import ( ) // List all cost allocation tags added to the specified Amazon SQS queue. For an -// overview, see Tagging Your Amazon SQS Queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) +// overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) // in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this // action. For more information, see Grant cross-account permissions to a role and -// a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) ListQueueTags(ctx context.Context, params *ListQueueTagsInput, optFns ...func(*Options)) (*ListQueueTagsOutput, error) { if params == nil { diff --git a/service/sqs/api_op_ListQueues.go b/service/sqs/api_op_ListQueues.go index d11b23896cf..bb5a9dfc2e4 100644 --- a/service/sqs/api_op_ListQueues.go +++ b/service/sqs/api_op_ListQueues.go @@ -16,13 +16,12 @@ import ( // QueueNamePrefix parameter, only queues with a name that begins with the // specified value are returned. The listQueues methods supports pagination. Set // parameter MaxResults in the request to specify the maximum number of results to -// be returned in the response. If you do not set MaxResults, the response includes -// a maximum of 1,000 results. If you set MaxResults and there are additional -// results to display, the response includes a value for NextToken. Use NextToken -// as a parameter in your next request to listQueues to receive the next page of -// results. Cross-account permissions don't apply to this action. For more -// information, see Grant cross-account permissions to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// be returned in the response. If you do not set MaxResults , the response +// includes a maximum of 1,000 results. If you set MaxResults and there are +// additional results to display, the response includes a value for NextToken . Use +// NextToken as a parameter in your next request to listQueues to receive the next +// page of results. Cross-account permissions don't apply to this action. For more +// information, see Grant cross-account permissions to a role and a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error) { if params == nil { diff --git a/service/sqs/api_op_PurgeQueue.go b/service/sqs/api_op_PurgeQueue.go index a582f773fee..a07c99e979d 100644 --- a/service/sqs/api_op_PurgeQueue.go +++ b/service/sqs/api_op_PurgeQueue.go @@ -11,12 +11,12 @@ import ( ) // Deletes the messages in a queue specified by the QueueURL parameter. When you -// use the PurgeQueue action, you can't retrieve any messages deleted from a queue. -// The message deletion process takes up to 60 seconds. We recommend waiting for 60 -// seconds regardless of your queue's size. Messages sent to the queue before you -// call PurgeQueue might be received but are deleted within the next minute. -// Messages sent to the queue after you call PurgeQueue might be deleted while the -// queue is being purged. +// use the PurgeQueue action, you can't retrieve any messages deleted from a +// queue. The message deletion process takes up to 60 seconds. We recommend waiting +// for 60 seconds regardless of your queue's size. Messages sent to the queue +// before you call PurgeQueue might be received but are deleted within the next +// minute. Messages sent to the queue after you call PurgeQueue might be deleted +// while the queue is being purged. func (c *Client) PurgeQueue(ctx context.Context, params *PurgeQueueInput, optFns ...func(*Options)) (*PurgeQueueOutput, error) { if params == nil { params = &PurgeQueueInput{} diff --git a/service/sqs/api_op_ReceiveMessage.go b/service/sqs/api_op_ReceiveMessage.go index 411b164308e..abb079a2a14 100644 --- a/service/sqs/api_op_ReceiveMessage.go +++ b/service/sqs/api_op_ReceiveMessage.go @@ -13,43 +13,30 @@ import ( // Retrieves one or more messages (up to 10), from the specified queue. Using the // WaitTimeSeconds parameter enables long-poll support. For more information, see -// Amazon SQS Long Polling -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) +// Amazon SQS Long Polling (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) // in the Amazon SQS Developer Guide. Short poll is the default behavior where a // weighted random set of machines is sampled on a ReceiveMessage call. Thus, only // the messages on the sampled machines are returned. If the number of messages in // the queue is small (fewer than 1,000), you most likely get fewer messages than -// you requested per ReceiveMessage call. If the number of messages in the queue is -// extremely small, you might not receive any messages in a particular +// you requested per ReceiveMessage call. If the number of messages in the queue +// is extremely small, you might not receive any messages in a particular // ReceiveMessage response. If this happens, repeat the request. For each message // returned, the response includes the following: +// - The message body. +// - An MD5 digest of the message body. For information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) +// . +// - The MessageId you received when you sent the message to the queue. +// - The receipt handle. +// - The message attributes. +// - An MD5 digest of the message attributes. // -// * The message body. -// -// * An MD5 -// digest of the message body. For information about MD5, see RFC1321 -// (https://www.ietf.org/rfc/rfc1321.txt). -// -// * The MessageId you received when you -// sent the message to the queue. -// -// * The receipt handle. -// -// * The message -// attributes. -// -// * An MD5 digest of the message attributes. -// -// The receipt handle is -// the identifier you must provide when deleting the message. For more information, -// see Queue and Message Identifiers -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) +// The receipt handle is the identifier you must provide when deleting the +// message. For more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) // in the Amazon SQS Developer Guide. You can provide the VisibilityTimeout // parameter in your request. The parameter is applied to the messages that Amazon // SQS returns in the response. If you don't include the parameter, the overall // visibility timeout for the queue is used for the returned messages. For more -// information, see Visibility Timeout -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) +// information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. A message that isn't deleted or a message // whose visibility isn't extended before the visibility timeout expires counts as // a failed receive. Depending on the configuration of the queue, the message might @@ -73,87 +60,60 @@ func (c *Client) ReceiveMessage(ctx context.Context, params *ReceiveMessageInput type ReceiveMessageInput struct { - // The URL of the Amazon SQS queue from which messages are received. Queue URLs and - // names are case-sensitive. + // The URL of the Amazon SQS queue from which messages are received. Queue URLs + // and names are case-sensitive. // // This member is required. QueueUrl *string // A list of attributes that need to be returned along with each message. These // attributes include: - // - // * All – Returns all values. - // - // * - // ApproximateFirstReceiveTimestamp – Returns the time the message was first - // received from the queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) in - // milliseconds). - // - // * ApproximateReceiveCount – Returns the number of times a - // message has been received across all queues but not deleted. - // - // * AWSTraceHeader – - // Returns the X-Ray trace header string. - // - // * SenderId - // - // * For an IAM user, returns - // the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R. - // - // * For an IAM role, returns - // the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. - // - // * SentTimestamp - // – Returns the time the message was sent to the queue (epoch time - // (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). - // - // * - // SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned - // encryption keys. Only one server-side encryption option is supported per queue - // (e.g. SSE-KMS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) - // or SSE-SQS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). - // - // * - // MessageDeduplicationId – Returns the value provided by the producer that calls - // the SendMessage action. - // - // * MessageGroupId – Returns the value provided by the - // producer that calls the SendMessage action. Messages with the same - // MessageGroupId are returned in sequence. - // - // * SequenceNumber – Returns the value - // provided by Amazon SQS. + // - All – Returns all values. + // - ApproximateFirstReceiveTimestamp – Returns the time the message was first + // received from the queue ( epoch time (http://en.wikipedia.org/wiki/Unix_time) + // in milliseconds). + // - ApproximateReceiveCount – Returns the number of times a message has been + // received across all queues but not deleted. + // - AWSTraceHeader – Returns the X-Ray trace header string. + // - SenderId + // - For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R + // . + // - For an IAM role, returns the IAM role ID, for example + // ABCDE1F2GH3I4JK5LMNOP:i-a123b456 . + // - SentTimestamp – Returns the time the message was sent to the queue ( epoch + // time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). + // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned + // encryption keys. Only one server-side encryption option is supported per queue + // (e.g. SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) + // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) + // ). + // - MessageDeduplicationId – Returns the value provided by the producer that + // calls the SendMessage action. + // - MessageGroupId – Returns the value provided by the producer that calls the + // SendMessage action. Messages with the same MessageGroupId are returned in + // sequence. + // - SequenceNumber – Returns the value provided by Amazon SQS. AttributeNames []types.QueueAttributeName - // The maximum number of messages to return. Amazon SQS never returns more messages - // than this value (however, fewer messages might be returned). Valid values: 1 to - // 10. Default: 1. + // The maximum number of messages to return. Amazon SQS never returns more + // messages than this value (however, fewer messages might be returned). Valid + // values: 1 to 10. Default: 1. MaxNumberOfMessages int32 // The name of the message attribute, where N is the index. - // - // * The name can contain - // alphanumeric characters and the underscore (_), hyphen (-), and period (.). - // - // * - // The name is case-sensitive and must be unique among all attribute names for the - // message. - // - // * The name must not start with AWS-reserved prefixes such as AWS. or - // Amazon. (or any casing variants). - // - // * The name must not start or end with a - // period (.), and it should not have periods in succession (..). - // - // * The name can - // be up to 256 characters long. - // - // When using ReceiveMessage, you can send a list of - // attribute names to receive, or you can return all of the attributes by - // specifying All or . in your request. You can also use all message attributes - // starting with a prefix, for example bar.. + // - The name can contain alphanumeric characters and the underscore ( _ ), + // hyphen ( - ), and period ( . ). + // - The name is case-sensitive and must be unique among all attribute names for + // the message. + // - The name must not start with AWS-reserved prefixes such as AWS. or Amazon. + // (or any casing variants). + // - The name must not start or end with a period ( . ), and it should not have + // periods in succession ( .. ). + // - The name can be up to 256 characters long. + // When using ReceiveMessage , you can send a list of attribute names to receive, + // or you can return all of the attributes by specifying All or . in your request. + // You can also use all message attributes starting with a prefix, for example bar. + // . MessageAttributeNames []string // This parameter applies only to FIFO (first-in-first-out) queues. The token used @@ -162,53 +122,39 @@ type ReceiveMessageInput struct { // is possible to retry the same action with an identical ReceiveRequestAttemptId // to retrieve the same set of messages, even if their visibility timeout has not // yet expired. - // - // * You can use ReceiveRequestAttemptId only for 5 minutes after a - // ReceiveMessage action. - // - // * When you set FifoQueue, a caller of the ReceiveMessage - // action can provide a ReceiveRequestAttemptId explicitly. - // - // * If a caller of the - // ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS - // generates a ReceiveRequestAttemptId. - // - // * It is possible to retry the - // ReceiveMessage action with the same ReceiveRequestAttemptId if none of the - // messages have been modified (deleted or had their visibility changes). - // - // * During - // a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId - // return the same messages and receipt handles. If a retry occurs within the - // deduplication interval, it resets the visibility timeout. For more information, - // see Visibility Timeout - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) - // in the Amazon SQS Developer Guide. If a caller of the ReceiveMessage action - // still processes messages when the visibility timeout expires and messages become - // visible, another worker consuming from the same queue can receive the same - // messages and therefore process duplicates. Also, if a consumer whose message - // processing time is longer than the visibility timeout tries to delete the - // processed messages, the action fails with an error. To mitigate this effect, - // ensure that your application observes a safe threshold before the visibility - // timeout expires and extend the visibility timeout as necessary. - // - // * While - // messages with a particular MessageGroupId are invisible, no more messages - // belonging to the same MessageGroupId are returned until the visibility timeout - // expires. You can still receive messages with another MessageGroupId as long as - // it is also visible. - // - // * If a caller of ReceiveMessage can't track the - // ReceiveRequestAttemptId, no retries work until the original visibility timeout - // expires. As a result, delays might occur but the messages in the queue remain in - // a strict order. - // - // The maximum length of ReceiveRequestAttemptId is 128 - // characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, - // A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices - // of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request - // Parameter - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) + // - You can use ReceiveRequestAttemptId only for 5 minutes after a + // ReceiveMessage action. + // - When you set FifoQueue , a caller of the ReceiveMessage action can provide a + // ReceiveRequestAttemptId explicitly. + // - If a caller of the ReceiveMessage action doesn't provide a + // ReceiveRequestAttemptId , Amazon SQS generates a ReceiveRequestAttemptId . + // - It is possible to retry the ReceiveMessage action with the same + // ReceiveRequestAttemptId if none of the messages have been modified (deleted or + // had their visibility changes). + // - During a visibility timeout, subsequent calls with the same + // ReceiveRequestAttemptId return the same messages and receipt handles. If a + // retry occurs within the deduplication interval, it resets the visibility + // timeout. For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) + // in the Amazon SQS Developer Guide. If a caller of the ReceiveMessage action + // still processes messages when the visibility timeout expires and messages become + // visible, another worker consuming from the same queue can receive the same + // messages and therefore process duplicates. Also, if a consumer whose message + // processing time is longer than the visibility timeout tries to delete the + // processed messages, the action fails with an error. To mitigate this effect, + // ensure that your application observes a safe threshold before the visibility + // timeout expires and extend the visibility timeout as necessary. + // - While messages with a particular MessageGroupId are invisible, no more + // messages belonging to the same MessageGroupId are returned until the + // visibility timeout expires. You can still receive messages with another + // MessageGroupId as long as it is also visible. + // - If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId , no + // retries work until the original visibility timeout expires. As a result, delays + // might occur but the messages in the queue remain in a strict order. + // The maximum length of ReceiveRequestAttemptId is 128 characters. + // ReceiveRequestAttemptId can contain alphanumeric characters ( a-z , A-Z , 0-9 ) + // and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ). For best practices of + // using ReceiveRequestAttemptId , see Using the ReceiveRequestAttemptId Request + // Parameter (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) // in the Amazon SQS Developer Guide. ReceiveRequestAttemptId *string @@ -218,14 +164,12 @@ type ReceiveMessageInput struct { // The duration (in seconds) for which the call waits for a message to arrive in // the queue before returning. If a message is available, the call returns sooner - // than WaitTimeSeconds. If no messages are available and the wait time expires, + // than WaitTimeSeconds . If no messages are available and the wait time expires, // the call returns successfully with an empty list of messages. To avoid HTTP // errors, ensure that the HTTP response timeout for ReceiveMessage requests is // longer than the WaitTimeSeconds parameter. For example, with the Java SDK, you - // can set HTTP transport settings using the NettyNioAsyncHttpClient - // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) - // for asynchronous clients, or the ApacheHttpClient - // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) + // can set HTTP transport settings using the NettyNioAsyncHttpClient (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) + // for asynchronous clients, or the ApacheHttpClient (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) // for synchronous clients. WaitTimeSeconds int32 diff --git a/service/sqs/api_op_RemovePermission.go b/service/sqs/api_op_RemovePermission.go index bb7f871287d..4a1258e7856 100644 --- a/service/sqs/api_op_RemovePermission.go +++ b/service/sqs/api_op_RemovePermission.go @@ -12,18 +12,13 @@ import ( // Revokes any permissions in the queue policy that matches the specified Label // parameter. -// -// * Only the owner of a queue can remove permissions from it. -// -// * -// Cross-account permissions don't apply to this action. For more information, see -// Grant cross-account permissions to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) -// in the Amazon SQS Developer Guide. -// -// * To remove the ability to change queue -// permissions, you must deny permission to the AddPermission, RemovePermission, -// and SetQueueAttributes actions in your IAM policy. +// - Only the owner of a queue can remove permissions from it. +// - Cross-account permissions don't apply to this action. For more information, +// see Grant cross-account permissions to a role and a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// in the Amazon SQS Developer Guide. +// - To remove the ability to change queue permissions, you must deny permission +// to the AddPermission , RemovePermission , and SetQueueAttributes actions in +// your IAM policy. func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} diff --git a/service/sqs/api_op_SendMessage.go b/service/sqs/api_op_SendMessage.go index 60634ec15ee..2819eb5e4cd 100644 --- a/service/sqs/api_op_SendMessage.go +++ b/service/sqs/api_op_SendMessage.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delivers a message to the specified queue. A message can include only XML, JSON, -// and unformatted text. The following Unicode characters are allowed: #x9 | #xA | -// #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not -// included in this list will be rejected. For more information, see the W3C -// specification for characters (http://www.w3.org/TR/REC-xml/#charsets). +// Delivers a message to the specified queue. A message can include only XML, +// JSON, and unformatted text. The following Unicode characters are allowed: #x9 | +// #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF Any +// characters not included in this list will be rejected. For more information, see +// the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets) . func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error) { if params == nil { params = &SendMessageInput{} @@ -37,14 +37,14 @@ type SendMessageInput struct { // KB. A message can include only XML, JSON, and unformatted text. The following // Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to // #xFFFD | #x10000 to #x10FFFF Any characters not included in this list will be - // rejected. For more information, see the W3C specification for characters - // (http://www.w3.org/TR/REC-xml/#charsets). + // rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets) + // . // // This member is required. MessageBody *string - // The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names - // are case-sensitive. + // The URL of the Amazon SQS queue to which a message is sent. Queue URLs and + // names are case-sensitive. // // This member is required. QueueUrl *string @@ -53,13 +53,12 @@ type SendMessageInput struct { // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. If you // don't specify a value, the default value for the queue applies. When you set - // FifoQueue, you can't set DelaySeconds per message. You can set this parameter + // FifoQueue , you can't set DelaySeconds per message. You can set this parameter // only on a queue level. DelaySeconds int32 - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SQS message attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) + // Each message attribute consists of a Name , Type , and Value . For more + // information, see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]types.MessageAttributeValue @@ -67,51 +66,36 @@ type SendMessageInput struct { // for deduplication of sent messages. If a message with a particular // MessageDeduplicationId is sent successfully, any messages sent with the same // MessageDeduplicationId are accepted successfully but aren't delivered during the - // 5-minute deduplication interval. For more information, see Exactly-once - // processing - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) + // 5-minute deduplication interval. For more information, see Exactly-once + // processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. - // - // * Every message must have a unique - // MessageDeduplicationId, - // - // * You may provide a MessageDeduplicationId - // explicitly. - // - // * If you aren't able to provide a MessageDeduplicationId and you - // enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash - // to generate the MessageDeduplicationId using the body of the message (but not - // the attributes of the message). - // - // * If you don't provide a MessageDeduplicationId - // and the queue doesn't have ContentBasedDeduplication set, the action fails with - // an error. - // - // * If the queue has ContentBasedDeduplication set, your - // MessageDeduplicationId overrides the generated one. - // - // * When - // ContentBasedDeduplication is in effect, messages with identical content sent - // within the deduplication interval are treated as duplicates and only one copy of - // the message is delivered. - // - // * If you send one message with - // ContentBasedDeduplication enabled and then another message with a - // MessageDeduplicationId that is the same as the one generated for the first - // MessageDeduplicationId, the two messages are treated as duplicates and only one - // copy of the message is delivered. - // - // The MessageDeduplicationId is available to - // the consumer of the message (this can be useful for troubleshooting delivery - // issues). If a message is sent successfully but the acknowledgement is lost and - // the message is resent with the same MessageDeduplicationId after the - // deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS - // continues to keep track of the message deduplication ID even after the message - // is received and deleted. The maximum length of MessageDeduplicationId is 128 - // characters. MessageDeduplicationId can contain alphanumeric characters (a-z, - // A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices - // of using MessageDeduplicationId, see Using the MessageDeduplicationId Property - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) + // - Every message must have a unique MessageDeduplicationId , + // - You may provide a MessageDeduplicationId explicitly. + // - If you aren't able to provide a MessageDeduplicationId and you enable + // ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to + // generate the MessageDeduplicationId using the body of the message (but not the + // attributes of the message). + // - If you don't provide a MessageDeduplicationId and the queue doesn't have + // ContentBasedDeduplication set, the action fails with an error. + // - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId + // overrides the generated one. + // - When ContentBasedDeduplication is in effect, messages with identical content + // sent within the deduplication interval are treated as duplicates and only one + // copy of the message is delivered. + // - If you send one message with ContentBasedDeduplication enabled and then + // another message with a MessageDeduplicationId that is the same as the one + // generated for the first MessageDeduplicationId , the two messages are treated + // as duplicates and only one copy of the message is delivered. + // The MessageDeduplicationId is available to the consumer of the message (this + // can be useful for troubleshooting delivery issues). If a message is sent + // successfully but the acknowledgement is lost and the message is resent with the + // same MessageDeduplicationId after the deduplication interval, Amazon SQS can't + // detect duplicate messages. Amazon SQS continues to keep track of the message + // deduplication ID even after the message is received and deleted. The maximum + // length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can + // contain alphanumeric characters ( a-z , A-Z , 0-9 ) and punctuation ( + // !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ). For best practices of using + // MessageDeduplicationId , see Using the MessageDeduplicationId Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. MessageDeduplicationId *string @@ -123,33 +107,25 @@ type SendMessageInput struct { // values (for example, session data for multiple users). In this scenario, // multiple consumers can process the queue, but the session data of each user is // processed in a FIFO fashion. - // - // * You must associate a non-empty MessageGroupId - // with a message. If you don't provide a MessageGroupId, the action fails. - // - // * - // ReceiveMessage might return messages with multiple MessageGroupId values. For - // each MessageGroupId, the messages are sorted by time sent. The caller can't - // specify a MessageGroupId. - // - // The length of MessageGroupId is 128 characters. Valid - // values: alphanumeric characters and punctuation - // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, - // see Using the MessageGroupId Property - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) + // - You must associate a non-empty MessageGroupId with a message. If you don't + // provide a MessageGroupId , the action fails. + // - ReceiveMessage might return messages with multiple MessageGroupId values. + // For each MessageGroupId , the messages are sorted by time sent. The caller + // can't specify a MessageGroupId . + // The length of MessageGroupId is 128 characters. Valid values: alphanumeric + // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . For best + // practices of using MessageGroupId , see Using the MessageGroupId Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. // You can't use it for Standard queues. MessageGroupId *string // The message system attribute to send. Each message system attribute consists of - // a Name, Type, and Value. - // - // * Currently, the only supported message system - // attribute is AWSTraceHeader. Its type must be String and its value must be a - // correctly formatted X-Ray trace header string. - // - // * The size of a message system - // attribute doesn't count towards the total size of a message. + // a Name , Type , and Value . + // - Currently, the only supported message system attribute is AWSTraceHeader . + // Its type must be String and its value must be a correctly formatted X-Ray + // trace header string. + // - The size of a message system attribute doesn't count towards the total size + // of a message. MessageSystemAttributes map[string]types.MessageSystemAttributeValue noSmithyDocumentSerde @@ -161,13 +137,13 @@ type SendMessageOutput struct { // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . MD5OfMessageAttributes *string // An MD5 digest of the non-URL-encoded message body string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . MD5OfMessageBody *string // An MD5 digest of the non-URL-encoded message system attribute string. You can @@ -175,16 +151,15 @@ type SendMessageOutput struct { // Amazon SQS URL-decodes the message before creating the MD5 digest. MD5OfMessageSystemAttributes *string - // An attribute containing the MessageId of the message sent to the queue. For more - // information, see Queue and Message Identifiers - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) + // An attribute containing the MessageId of the message sent to the queue. For + // more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) // in the Amazon SQS Developer Guide. MessageId *string // This parameter applies only to FIFO (first-in-first-out) queues. The large, // non-consecutive number that Amazon SQS assigns to each message. The length of // SequenceNumber is 128 bits. SequenceNumber continues to increase for a - // particular MessageGroupId. + // particular MessageGroupId . SequenceNumber *string // Metadata pertaining to the operation's result. diff --git a/service/sqs/api_op_SendMessageBatch.go b/service/sqs/api_op_SendMessageBatch.go index 509d57814d2..d81fb6082da 100644 --- a/service/sqs/api_op_SendMessageBatch.go +++ b/service/sqs/api_op_SendMessageBatch.go @@ -12,24 +12,24 @@ import ( ) // Delivers up to ten messages to the specified queue. This is a batch version of -// SendMessage. For a FIFO queue, multiple messages within a single batch are +// SendMessage . For a FIFO queue, multiple messages within a single batch are // enqueued in the order they are sent. The result of sending each message is // reported individually in the response. Because the batch request can result in a // combination of successful and unsuccessful actions, you should check for batch -// errors even when the call returns an HTTP status code of 200. The maximum +// errors even when the call returns an HTTP status code of 200 . The maximum // allowed individual message size and the maximum total payload size (the sum of // the individual lengths of all of the batched messages) are both 256 KB (262,144 // bytes). A message can include only XML, JSON, and unformatted text. The // following Unicode characters are allowed: #x9 | #xA | #xD | #x20 to #xD7FF | // #xE000 to #xFFFD | #x10000 to #x10FFFF Any characters not included in this list -// will be rejected. For more information, see the W3C specification for characters -// (http://www.w3.org/TR/REC-xml/#charsets). If you don't specify the DelaySeconds -// parameter for an entry, Amazon SQS uses the default value for the queue. Some -// actions take lists of parameters. These lists are specified using the param.n -// notation. Values of n are integers starting from 1. For example, a parameter -// list with two elements looks like this: &AttributeName.1=first +// will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets) +// . If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses +// the default value for the queue. Some actions take lists of parameters. These +// lists are specified using the param.n notation. Values of n are integers +// starting from 1. For example, a parameter list with two elements looks like +// this: &AttributeName.1=first // -// &AttributeName.2=second +// &AttributeName.2=second func (c *Client) SendMessageBatch(ctx context.Context, params *SendMessageBatchInput, optFns ...func(*Options)) (*SendMessageBatchOutput, error) { if params == nil { params = &SendMessageBatchInput{} @@ -66,8 +66,8 @@ type SendMessageBatchInput struct { // BatchResultErrorEntry tag if the message fails. type SendMessageBatchOutput struct { - // A list of BatchResultErrorEntry items with error details about each message that - // can't be enqueued. + // A list of BatchResultErrorEntry items with error details about each message + // that can't be enqueued. // // This member is required. Failed []types.BatchResultErrorEntry diff --git a/service/sqs/api_op_SetQueueAttributes.go b/service/sqs/api_op_SetQueueAttributes.go index 48c6bc993ab..78ad36254a0 100644 --- a/service/sqs/api_op_SetQueueAttributes.go +++ b/service/sqs/api_op_SetQueueAttributes.go @@ -14,20 +14,15 @@ import ( // attributes, the change can take up to 60 seconds for most of the attributes to // propagate throughout the Amazon SQS system. Changes made to the // MessageRetentionPeriod attribute can take up to 15 minutes. -// -// * In the future, -// new attributes might be added. If you write code that calls this action, we -// recommend that you structure your code so that it can handle new attributes -// gracefully. -// -// * Cross-account permissions don't apply to this action. For more -// information, see Grant cross-account permissions to a role and a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) -// in the Amazon SQS Developer Guide. -// -// * To remove the ability to change queue -// permissions, you must deny permission to the AddPermission, RemovePermission, -// and SetQueueAttributes actions in your IAM policy. +// - In the future, new attributes might be added. If you write code that calls +// this action, we recommend that you structure your code so that it can handle new +// attributes gracefully. +// - Cross-account permissions don't apply to this action. For more information, +// see Grant cross-account permissions to a role and a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// in the Amazon SQS Developer Guide. +// - To remove the ability to change queue permissions, you must deny permission +// to the AddPermission , RemovePermission , and SetQueueAttributes actions in +// your IAM policy. func (c *Client) SetQueueAttributes(ctx context.Context, params *SetQueueAttributesInput, optFns ...func(*Options)) (*SetQueueAttributesOutput, error) { if params == nil { params = &SetQueueAttributesInput{} @@ -48,156 +43,100 @@ type SetQueueAttributesInput struct { // A map of attributes to set. The following lists the names, descriptions, and // values of the special request parameters that the SetQueueAttributes action // uses: - // - // * DelaySeconds – The length of time, in seconds, for which the delivery - // of all messages in the queue is delayed. Valid values: An integer from 0 to 900 - // (15 minutes). Default: 0. - // - // * MaximumMessageSize – The limit of how many bytes a - // message can contain before Amazon SQS rejects it. Valid values: An integer from - // 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 - // KiB). - // - // * MessageRetentionPeriod – The length of time, in seconds, for which - // Amazon SQS retains a message. Valid values: An integer representing seconds, - // from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). - // - // * Policy - // – The queue's policy. A valid Amazon Web Services policy. For more information - // about policy structure, see Overview of Amazon Web Services IAM Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) in the - // Identity and Access Management User Guide. - // - // * ReceiveMessageWaitTimeSeconds – - // The length of time, in seconds, for which a ReceiveMessage action waits for a - // message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: - // 0. - // - // * RedrivePolicy – The string that includes the parameters for the - // dead-letter queue functionality of the source queue as a JSON object. For more - // information about the redrive policy and dead-letter queues, see Using Amazon - // SQS Dead-Letter Queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) - // in the Amazon SQS Developer Guide. - // - // * deadLetterTargetArn – The Amazon Resource - // Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the - // value of maxReceiveCount is exceeded. - // - // * maxReceiveCount – The number of times a - // message is delivered to the source queue before being moved to the dead-letter - // queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a - // queue, Amazon SQS moves the message to the dead-letter-queue. - // - // The dead-letter - // queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter - // queue of a standard queue must also be a standard queue. - // - // * VisibilityTimeout – - // The visibility timeout for the queue, in seconds. Valid values: An integer from - // 0 to 43,200 (12 hours). Default: 30. For more information about the visibility - // timeout, see Visibility Timeout - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) - // in the Amazon SQS Developer Guide. - // - // The following attributes apply only to - // server-side-encryption - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): - // - // * - // KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key - // (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). - // While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, - // the alias of a custom CMK can, for example, be alias/MyAlias . For more - // examples, see KeyId - // (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // in the Key Management Service API Reference. - // - // * KmsDataKeyReusePeriodSeconds – - // The length of time, in seconds, for which Amazon SQS can reuse a data key - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) - // to encrypt or decrypt messages before calling KMS again. An integer representing - // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: - // 300 (5 minutes). A shorter time period provides better security but results in - // more calls to KMS which might incur charges after Free Tier. For more - // information, see How Does the Data Key Reuse Period Work? - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). - // - // * - // SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned - // encryption keys. Only one server-side encryption option is supported per queue - // (e.g. SSE-KMS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) - // or SSE-SQS - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). - // - // The - // following attribute applies only to FIFO (first-in-first-out) queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): - // - // * - // ContentBasedDeduplication – Enables content-based deduplication. For more - // information, see Exactly-once processing - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) - // in the Amazon SQS Developer Guide. Note the following: - // - // * Every message must - // have a unique MessageDeduplicationId. - // - // * You may provide a - // MessageDeduplicationId explicitly. - // - // * If you aren't able to provide a - // MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, - // Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the - // body of the message (but not the attributes of the message). - // - // * If you don't - // provide a MessageDeduplicationId and the queue doesn't have - // ContentBasedDeduplication set, the action fails with an error. - // - // * If the queue - // has ContentBasedDeduplication set, your MessageDeduplicationId overrides the - // generated one. - // - // * When ContentBasedDeduplication is in effect, messages with - // identical content sent within the deduplication interval are treated as - // duplicates and only one copy of the message is delivered. - // - // * If you send one - // message with ContentBasedDeduplication enabled and then another message with a - // MessageDeduplicationId that is the same as the one generated for the first - // MessageDeduplicationId, the two messages are treated as duplicates and only one - // copy of the message is delivered. - // - // The following attributes apply only to high - // throughput for FIFO queues - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): - // - // * - // DeduplicationScope – Specifies whether message deduplication occurs at the - // message group or queue level. Valid values are messageGroup and queue. - // - // * - // FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies - // to the entire queue or per message group. Valid values are perQueue and - // perMessageGroupId. The perMessageGroupId value is allowed only when the value - // for DeduplicationScope is messageGroup. - // - // To enable high throughput for FIFO - // queues, do the following: - // - // * Set DeduplicationScope to messageGroup. - // - // * Set - // FifoThroughputLimit to perMessageGroupId. - // - // If you set these attributes to - // anything other than the values shown for enabling high throughput, normal - // throughput is in effect and deduplication occurs as specified. For information - // on throughput quotas, see Quotas related to messages - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) + // - DelaySeconds – The length of time, in seconds, for which the delivery of all + // messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 + // minutes). Default: 0. + // - MaximumMessageSize – The limit of how many bytes a message can contain + // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) + // up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). + // - MessageRetentionPeriod – The length of time, in seconds, for which Amazon + // SQS retains a message. Valid values: An integer representing seconds, from 60 (1 + // minute) to 1,209,600 (14 days). Default: 345,600 (4 days). + // - Policy – The queue's policy. A valid Amazon Web Services policy. For more + // information about policy structure, see Overview of Amazon Web Services IAM + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) + // in the Identity and Access Management User Guide. + // - ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a + // ReceiveMessage action waits for a message to arrive. Valid values: An integer + // from 0 to 20 (seconds). Default: 0. + // - RedrivePolicy – The string that includes the parameters for the dead-letter + // queue functionality of the source queue as a JSON object. For more information + // about the redrive policy and dead-letter queues, see Using Amazon SQS + // Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // in the Amazon SQS Developer Guide. + // - deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter + // queue to which Amazon SQS moves messages after the value of maxReceiveCount is + // exceeded. + // - maxReceiveCount – The number of times a message is delivered to the source + // queue before being moved to the dead-letter queue. When the ReceiveCount for a + // message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message + // to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be + // a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be + // a standard queue. + // - VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid + // values: An integer from 0 to 43,200 (12 hours). Default: 30. For more + // information about the visibility timeout, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) + // in the Amazon SQS Developer Guide. + // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) + // : + // + // - KmsMasterKeyId – The ID of an Amazon Web Services managed customer master + // key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms) + // . While the alias of the AWS-managed CMK for Amazon SQS is always + // alias/aws/sqs , the alias of a custom CMK can, for example, be alias/MyAlias + // . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) + // in the Key Management Service API Reference. + // - KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which + // Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) + // to encrypt or decrypt messages before calling KMS again. An integer representing + // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: + // 300 (5 minutes). A shorter time period provides better security but results in + // more calls to KMS which might incur charges after Free Tier. For more + // information, see How Does the Data Key Reuse Period Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) + // . + // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned + // encryption keys. Only one server-side encryption option is supported per queue + // (e.g. SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) + // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html) + // ). + // The following attribute applies only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) + // : + // - ContentBasedDeduplication – Enables content-based deduplication. For more + // information, see Exactly-once processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) + // in the Amazon SQS Developer Guide. Note the following: + // - Every message must have a unique MessageDeduplicationId . + // - You may provide a MessageDeduplicationId explicitly. + // - If you aren't able to provide a MessageDeduplicationId and you enable + // ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to + // generate the MessageDeduplicationId using the body of the message (but not the + // attributes of the message). + // - If you don't provide a MessageDeduplicationId and the queue doesn't have + // ContentBasedDeduplication set, the action fails with an error. + // - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId + // overrides the generated one. + // - When ContentBasedDeduplication is in effect, messages with identical content + // sent within the deduplication interval are treated as duplicates and only one + // copy of the message is delivered. + // - If you send one message with ContentBasedDeduplication enabled and then + // another message with a MessageDeduplicationId that is the same as the one + // generated for the first MessageDeduplicationId , the two messages are treated + // as duplicates and only one copy of the message is delivered. + // + // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) + // : + // - DeduplicationScope – Specifies whether message deduplication occurs at the + // message group or queue level. Valid values are messageGroup and queue . + // - FifoThroughputLimit – Specifies whether the FIFO queue throughput quota + // applies to the entire queue or per message group. Valid values are perQueue + // and perMessageGroupId . The perMessageGroupId value is allowed only when the + // value for DeduplicationScope is messageGroup . + // To enable high throughput for FIFO queues, do the following: + // - Set DeduplicationScope to messageGroup . + // - Set FifoThroughputLimit to perMessageGroupId . + // If you set these attributes to anything other than the values shown for + // enabling high throughput, normal throughput is in effect and deduplication + // occurs as specified. For information on throughput quotas, see Quotas related + // to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. // // This member is required. diff --git a/service/sqs/api_op_TagQueue.go b/service/sqs/api_op_TagQueue.go index 50be1bcf8da..ee62d0d8c8b 100644 --- a/service/sqs/api_op_TagQueue.go +++ b/service/sqs/api_op_TagQueue.go @@ -10,30 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add cost allocation tags to the specified Amazon SQS queue. For an overview, see -// Tagging Your Amazon SQS Queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) +// Add cost allocation tags to the specified Amazon SQS queue. For an overview, +// see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) // in the Amazon SQS Developer Guide. When you use queue tags, keep the following // guidelines in mind: +// - Adding more than 50 tags to a queue isn't recommended. +// - Tags don't have any semantic meaning. Amazon SQS interprets tags as +// character strings. +// - Tags are case-sensitive. +// - A new tag with a key identical to that of an existing tag overwrites the +// existing tag. // -// * Adding more than 50 tags to a queue isn't recommended. -// -// * -// Tags don't have any semantic meaning. Amazon SQS interprets tags as character -// strings. -// -// * Tags are case-sensitive. -// -// * A new tag with a key identical to that -// of an existing tag overwrites the existing tag. -// -// For a full list of tag -// restrictions, see Quotas related to queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) +// For a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) // in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this // action. For more information, see Grant cross-account permissions to a role and -// a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) TagQueue(ctx context.Context, params *TagQueueInput, optFns ...func(*Options)) (*TagQueueOutput, error) { if params == nil { diff --git a/service/sqs/api_op_UntagQueue.go b/service/sqs/api_op_UntagQueue.go index 45e8c8880e2..7096f84ae5d 100644 --- a/service/sqs/api_op_UntagQueue.go +++ b/service/sqs/api_op_UntagQueue.go @@ -11,12 +11,10 @@ import ( ) // Remove cost allocation tags from the specified Amazon SQS queue. For an -// overview, see Tagging Your Amazon SQS Queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) +// overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) // in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this // action. For more information, see Grant cross-account permissions to a role and -// a user name -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// a user name (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. func (c *Client) UntagQueue(ctx context.Context, params *UntagQueueInput, optFns ...func(*Options)) (*UntagQueueOutput, error) { if params == nil { diff --git a/service/sqs/doc.go b/service/sqs/doc.go index f66e5a5d7aa..e3bfe76da32 100644 --- a/service/sqs/doc.go +++ b/service/sqs/doc.go @@ -7,46 +7,21 @@ // highly-scalable hosted queue for storing messages as they travel between // applications or microservices. Amazon SQS moves data between distributed // application components and helps you decouple these components. For information -// on the permissions you need to use this API, see Identity and access management -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html) -// in the Amazon SQS Developer Guide. You can use Amazon Web Services SDKs -// (http://aws.amazon.com/tools/#sdk) to access Amazon SQS using your favorite -// programming language. The SDKs perform tasks such as the following -// automatically: -// -// * Cryptographically sign your service requests -// -// * Retry -// requests -// -// * Handle error responses -// -// # Additional information -// -// * Amazon SQS Product -// Page (http://aws.amazon.com/sqs/) -// -// * Amazon SQS Developer Guide -// -// * Making API -// Requests -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html) -// -// * -// Amazon SQS Message Attributes -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) -// -// * -// Amazon SQS Dead-Letter Queues -// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) -// -// * -// Amazon SQS in the Command Line Interface -// (http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html) -// -// * Amazon Web -// Services General Reference -// -// * Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region) +// on the permissions you need to use this API, see Identity and access management (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html) +// in the Amazon SQS Developer Guide. You can use Amazon Web Services SDKs (http://aws.amazon.com/tools/#sdk) +// to access Amazon SQS using your favorite programming language. The SDKs perform +// tasks such as the following automatically: +// - Cryptographically sign your service requests +// - Retry requests +// - Handle error responses +// +// Additional information +// - Amazon SQS Product Page (http://aws.amazon.com/sqs/) +// - Amazon SQS Developer Guide +// - Making API Requests (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html) +// - Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) +// - Amazon SQS Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) +// - Amazon SQS in the Command Line Interface (http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html) +// - Amazon Web Services General Reference +// - Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region) package sqs diff --git a/service/sqs/types/errors.go b/service/sqs/types/errors.go index 0671b155afb..9e5807a3fb8 100644 --- a/service/sqs/types/errors.go +++ b/service/sqs/types/errors.go @@ -7,7 +7,7 @@ import ( smithy "github.com/aws/smithy-go" ) -// Two or more batch entries in the request have the same Id. +// Two or more batch entries in the request have the same Id . type BatchEntryIdsNotDistinct struct { Message *string @@ -325,8 +325,8 @@ func (e *QueueDoesNotExist) ErrorCode() string { } func (e *QueueDoesNotExist) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A queue with this name already exists. Amazon SQS returns this error only if the -// request includes attributes whose values differ from those of the existing +// A queue with this name already exists. Amazon SQS returns this error only if +// the request includes attributes whose values differ from those of the existing // queue. type QueueNameExists struct { Message *string diff --git a/service/sqs/types/types.go b/service/sqs/types/types.go index 913b0ff6a5c..054fe3a25f3 100644 --- a/service/sqs/types/types.go +++ b/service/sqs/types/types.go @@ -32,20 +32,20 @@ type BatchResultErrorEntry struct { } // Encloses a receipt handle and an entry id for each message in -// ChangeMessageVisibilityBatch. All of the following list parameters must be -// prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer -// value starting with 1. For example, a parameter list for this action might look -// like this: +// ChangeMessageVisibilityBatch . All of the following list parameters must be +// prefixed with ChangeMessageVisibilityBatchRequestEntry.n , where n is an +// integer value starting with 1 . For example, a parameter list for this action +// might look like this: // &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2 // -// &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle +// &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle // -// &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45 +// &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45 type ChangeMessageVisibilityBatchRequestEntry struct { - // An identifier for this particular receipt handle used to communicate the result. - // The Ids of a batch request need to be unique within a request. This identifier - // can have up to 80 characters. The following characters are accepted: + // An identifier for this particular receipt handle used to communicate the + // result. The Id s of a batch request need to be unique within a request. This + // identifier can have up to 80 characters. The following characters are accepted: // alphanumeric characters, hyphens(-), and underscores (_). // // This member is required. @@ -62,7 +62,7 @@ type ChangeMessageVisibilityBatchRequestEntry struct { noSmithyDocumentSerde } -// Encloses the Id of an entry in ChangeMessageVisibilityBatch. +// Encloses the Id of an entry in ChangeMessageVisibilityBatch . type ChangeMessageVisibilityBatchResultEntry struct { // Represents a message whose visibility timeout has been changed successfully. @@ -77,7 +77,7 @@ type ChangeMessageVisibilityBatchResultEntry struct { type DeleteMessageBatchRequestEntry struct { // An identifier for this particular receipt handle. This is used to communicate - // the result. The Ids of a batch request need to be unique within a request. This + // the result. The Id s of a batch request need to be unique within a request. This // identifier can have up to 80 characters. The following characters are accepted: // alphanumeric characters, hyphens(-), and underscores (_). // @@ -92,7 +92,7 @@ type DeleteMessageBatchRequestEntry struct { noSmithyDocumentSerde } -// Encloses the Id of an entry in DeleteMessageBatch. +// Encloses the Id of an entry in DeleteMessageBatch . type DeleteMessageBatchResultEntry struct { // Represents a successfully deleted message. @@ -108,26 +108,16 @@ type Message struct { // A map of the attributes requested in ReceiveMessage to their respective values. // Supported attributes: - // - // * ApproximateReceiveCount - // - // * - // ApproximateFirstReceiveTimestamp - // - // * MessageDeduplicationId - // - // * MessageGroupId - // - // * - // SenderId - // - // * SentTimestamp - // - // * SequenceNumber - // - // ApproximateFirstReceiveTimestamp - // and SentTimestamp are each returned as an integer representing the epoch time - // (http://en.wikipedia.org/wiki/Unix_time) in milliseconds. + // - ApproximateReceiveCount + // - ApproximateFirstReceiveTimestamp + // - MessageDeduplicationId + // - MessageGroupId + // - SenderId + // - SentTimestamp + // - SequenceNumber + // ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an + // integer representing the epoch time (http://en.wikipedia.org/wiki/Unix_time) in + // milliseconds. Attributes map[string]string // The message's contents (not URL-encoded). @@ -139,16 +129,15 @@ type Message struct { // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . MD5OfMessageAttributes *string - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SQS message attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) + // Each message attribute consists of a Name , Type , and Value . For more + // information, see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]MessageAttributeValue - // A unique identifier for the message. A MessageIdis considered unique across all + // A unique identifier for the message. A MessageId is considered unique across all // Amazon Web Services accounts for an extended period of time. MessageId *string @@ -162,15 +151,14 @@ type Message struct { // The user-specified message attribute value. For string data types, the Value // attribute has the same restrictions on the content as the message body. For more -// information, see SendMessage.Name, type, value and the message body must not be -// empty or null. All parts of the message attribute, including Name, Type, and -// Value, are part of the message size restriction (256 KB or 262,144 bytes). +// information, see SendMessage . Name , type , value and the message body must +// not be empty or null. All parts of the message attribute, including Name , Type +// , and Value , are part of the message size restriction (256 KB or 262,144 bytes). type MessageAttributeValue struct { - // Amazon SQS supports the following logical data types: String, Number, and - // Binary. For the Number data type, you must use StringValue. You can also append - // custom labels. For more information, see Amazon SQS Message Attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) + // Amazon SQS supports the following logical data types: String , Number , and + // Binary . For the Number data type, you must use StringValue . You can also + // append custom labels. For more information, see Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. // // This member is required. @@ -187,8 +175,8 @@ type MessageAttributeValue struct { StringListValues []string // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see - // ASCII Printable Characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). + // ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) + // . StringValue *string noSmithyDocumentSerde @@ -196,14 +184,13 @@ type MessageAttributeValue struct { // The user-specified message system attribute value. For string data types, the // Value attribute has the same restrictions on the content as the message body. -// For more information, see SendMessage.Name, type, value and the message body -// must not be empty or null. +// For more information, see SendMessage . Name , type , value and the message +// body must not be empty or null. type MessageSystemAttributeValue struct { - // Amazon SQS supports the following logical data types: String, Number, and - // Binary. For the Number data type, you must use StringValue. You can also append - // custom labels. For more information, see Amazon SQS Message Attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) + // Amazon SQS supports the following logical data types: String , Number , and + // Binary . For the Number data type, you must use StringValue . You can also + // append custom labels. For more information, see Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. // // This member is required. @@ -220,18 +207,18 @@ type MessageSystemAttributeValue struct { StringListValues []string // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see - // ASCII Printable Characters - // (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). + // ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters) + // . StringValue *string noSmithyDocumentSerde } -// Contains the details of a single Amazon SQS message along with an Id. +// Contains the details of a single Amazon SQS message along with an Id . type SendMessageBatchRequestEntry struct { - // An identifier for a message in this batch used to communicate the result. The - // Ids of a batch request need to be unique within a request. This identifier can + // An identifier for a message in this batch used to communicate the result. The Id + // s of a batch request need to be unique within a request. This identifier can // have up to 80 characters. The following characters are accepted: alphanumeric // characters, hyphens(-), and underscores (_). // @@ -247,13 +234,12 @@ type SendMessageBatchRequestEntry struct { // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. If you // don't specify a value, the default value for the queue is applied. When you set - // FifoQueue, you can't set DelaySeconds per message. You can set this parameter + // FifoQueue , you can't set DelaySeconds per message. You can set this parameter // only on a queue level. DelaySeconds int32 - // Each message attribute consists of a Name, Type, and Value. For more - // information, see Amazon SQS message attributes - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) + // Each message attribute consists of a Name , Type , and Value . For more + // information, see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]MessageAttributeValue @@ -261,51 +247,36 @@ type SendMessageBatchRequestEntry struct { // for deduplication of messages within a 5-minute minimum deduplication interval. // If a message with a particular MessageDeduplicationId is sent successfully, // subsequent messages with the same MessageDeduplicationId are accepted - // successfully but aren't delivered. For more information, see Exactly-once - // processing - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) + // successfully but aren't delivered. For more information, see Exactly-once + // processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. - // - // * Every message must have a unique - // MessageDeduplicationId, - // - // * You may provide a MessageDeduplicationId - // explicitly. - // - // * If you aren't able to provide a MessageDeduplicationId and you - // enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash - // to generate the MessageDeduplicationId using the body of the message (but not - // the attributes of the message). - // - // * If you don't provide a MessageDeduplicationId - // and the queue doesn't have ContentBasedDeduplication set, the action fails with - // an error. - // - // * If the queue has ContentBasedDeduplication set, your - // MessageDeduplicationId overrides the generated one. - // - // * When - // ContentBasedDeduplication is in effect, messages with identical content sent - // within the deduplication interval are treated as duplicates and only one copy of - // the message is delivered. - // - // * If you send one message with - // ContentBasedDeduplication enabled and then another message with a - // MessageDeduplicationId that is the same as the one generated for the first - // MessageDeduplicationId, the two messages are treated as duplicates and only one - // copy of the message is delivered. - // - // The MessageDeduplicationId is available to - // the consumer of the message (this can be useful for troubleshooting delivery - // issues). If a message is sent successfully but the acknowledgement is lost and - // the message is resent with the same MessageDeduplicationId after the - // deduplication interval, Amazon SQS can't detect duplicate messages. Amazon SQS - // continues to keep track of the message deduplication ID even after the message - // is received and deleted. The length of MessageDeduplicationId is 128 characters. - // MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and - // punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using - // MessageDeduplicationId, see Using the MessageDeduplicationId Property - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) + // - Every message must have a unique MessageDeduplicationId , + // - You may provide a MessageDeduplicationId explicitly. + // - If you aren't able to provide a MessageDeduplicationId and you enable + // ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to + // generate the MessageDeduplicationId using the body of the message (but not the + // attributes of the message). + // - If you don't provide a MessageDeduplicationId and the queue doesn't have + // ContentBasedDeduplication set, the action fails with an error. + // - If the queue has ContentBasedDeduplication set, your MessageDeduplicationId + // overrides the generated one. + // - When ContentBasedDeduplication is in effect, messages with identical content + // sent within the deduplication interval are treated as duplicates and only one + // copy of the message is delivered. + // - If you send one message with ContentBasedDeduplication enabled and then + // another message with a MessageDeduplicationId that is the same as the one + // generated for the first MessageDeduplicationId , the two messages are treated + // as duplicates and only one copy of the message is delivered. + // The MessageDeduplicationId is available to the consumer of the message (this + // can be useful for troubleshooting delivery issues). If a message is sent + // successfully but the acknowledgement is lost and the message is resent with the + // same MessageDeduplicationId after the deduplication interval, Amazon SQS can't + // detect duplicate messages. Amazon SQS continues to keep track of the message + // deduplication ID even after the message is received and deleted. The length of + // MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain + // alphanumeric characters ( a-z , A-Z , 0-9 ) and punctuation ( + // !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ). For best practices of using + // MessageDeduplicationId , see Using the MessageDeduplicationId Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. MessageDeduplicationId *string @@ -317,39 +288,31 @@ type SendMessageBatchRequestEntry struct { // values (for example, session data for multiple users). In this scenario, // multiple consumers can process the queue, but the session data of each user is // processed in a FIFO fashion. - // - // * You must associate a non-empty MessageGroupId - // with a message. If you don't provide a MessageGroupId, the action fails. - // - // * - // ReceiveMessage might return messages with multiple MessageGroupId values. For - // each MessageGroupId, the messages are sorted by time sent. The caller can't - // specify a MessageGroupId. - // - // The length of MessageGroupId is 128 characters. Valid - // values: alphanumeric characters and punctuation - // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). For best practices of using MessageGroupId, - // see Using the MessageGroupId Property - // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) + // - You must associate a non-empty MessageGroupId with a message. If you don't + // provide a MessageGroupId , the action fails. + // - ReceiveMessage might return messages with multiple MessageGroupId values. + // For each MessageGroupId , the messages are sorted by time sent. The caller + // can't specify a MessageGroupId . + // The length of MessageGroupId is 128 characters. Valid values: alphanumeric + // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . For best + // practices of using MessageGroupId , see Using the MessageGroupId Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. // You can't use it for Standard queues. MessageGroupId *string - // The message system attribute to send Each message system attribute consists of a - // Name, Type, and Value. - // - // * Currently, the only supported message system attribute - // is AWSTraceHeader. Its type must be String and its value must be a correctly - // formatted X-Ray trace header string. - // - // * The size of a message system attribute - // doesn't count towards the total size of a message. + // The message system attribute to send Each message system attribute consists of + // a Name , Type , and Value . + // - Currently, the only supported message system attribute is AWSTraceHeader . + // Its type must be String and its value must be a correctly formatted X-Ray + // trace header string. + // - The size of a message system attribute doesn't count towards the total size + // of a message. MessageSystemAttributes map[string]MessageSystemAttributeValue noSmithyDocumentSerde } -// Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch. +// Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch . type SendMessageBatchResultEntry struct { // An identifier for the message in this batch. @@ -360,7 +323,7 @@ type SendMessageBatchResultEntry struct { // An MD5 digest of the non-URL-encoded message body string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . // // This member is required. MD5OfMessageBody *string @@ -373,19 +336,19 @@ type SendMessageBatchResultEntry struct { // An MD5 digest of the non-URL-encoded message attribute string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon SQS // URL-decodes the message before creating the MD5 digest. For information about - // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . MD5OfMessageAttributes *string // An MD5 digest of the non-URL-encoded message system attribute string. You can // use this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For - // information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). + // information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt) . MD5OfMessageSystemAttributes *string // This parameter applies only to FIFO (first-in-first-out) queues. The large, // non-consecutive number that Amazon SQS assigns to each message. The length of // SequenceNumber is 128 bits. As SequenceNumber continues to increase for a - // particular MessageGroupId. + // particular MessageGroupId . SequenceNumber *string noSmithyDocumentSerde diff --git a/service/ssm/api_client.go b/service/ssm/api_client.go index ce314c3736a..5cf20ad9775 100644 --- a/service/ssm/api_client.go +++ b/service/ssm/api_client.go @@ -26,8 +26,8 @@ import ( const ServiceID = "SSM" const ServiceAPIVersion = "2014-11-06" -// Client provides the API client to make operations call for Amazon Simple Systems -// Manager (SSM). +// Client provides the API client to make operations call for Amazon Simple +// Systems Manager (SSM). type Client struct { options Options } @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssm/api_op_AddTagsToResource.go b/service/ssm/api_op_AddTagsToResource.go index 14e38b09352..705754b0cfd 100644 --- a/service/ssm/api_op_AddTagsToResource.go +++ b/service/ssm/api_op_AddTagsToResource.go @@ -19,31 +19,22 @@ import ( // value, both of which you define. For example, you could define a set of tags for // your account's managed nodes that helps you track each node's owner and stack // level. For example: +// - Key=Owner,Value=DbAdmin +// - Key=Owner,Value=SysAdmin +// - Key=Owner,Value=Dev +// - Key=Stack,Value=Production +// - Key=Stack,Value=Pre-Production +// - Key=Stack,Value=Test // -// * Key=Owner,Value=DbAdmin -// -// * Key=Owner,Value=SysAdmin -// -// * -// Key=Owner,Value=Dev -// -// * Key=Stack,Value=Production -// -// * -// Key=Stack,Value=Pre-Production -// -// * Key=Stack,Value=Test -// -// Most resources can have -// a maximum of 50 tags. Automations can have a maximum of 5 tags. We recommend -// that you devise a set of tag keys that meets your needs for each resource type. -// Using a consistent set of tag keys makes it easier for you to manage your -// resources. You can search and filter the resources based on the tags you add. -// Tags don't have any semantic meaning to and are interpreted strictly as a string -// of characters. For more information about using tags with Amazon Elastic Compute -// Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources -// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the -// Amazon EC2 User Guide. +// Most resources can have a maximum of 50 tags. Automations can have a maximum of +// 5 tags. We recommend that you devise a set of tag keys that meets your needs for +// each resource type. Using a consistent set of tag keys makes it easier for you +// to manage your resources. You can search and filter the resources based on the +// tags you add. Tags don't have any semantic meaning to and are interpreted +// strictly as a string of characters. For more information about using tags with +// Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon +// EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) +// in the Amazon EC2 User Guide. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -62,17 +53,18 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { // The resource ID you want to tag. Use the ID of the resource. Here are some - // examples: MaintenanceWindow: mw-012345abcdePatchBaseline: - // pb-012345abcdeAutomation: example-c160-4567-8519-012345abcdeOpsMetadata object: - // ResourceID for tagging is created from the Amazon Resource Name (ARN) for the - // object. Specifically, ResourceID is created from the strings that come after the - // word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of + // examples: MaintenanceWindow : mw-012345abcde PatchBaseline : pb-012345abcde + // Automation : example-c160-4567-8519-012345abcde OpsMetadata object: ResourceID + // for tagging is created from the Amazon Resource Name (ARN) for the object. + // Specifically, ResourceID is created from the strings that come after the word + // opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of // arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a - // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager. + // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager . // For the Document and Parameter values, use the name of the resource. - // ManagedInstance: mi-012345abcde The ManagedInstance type for this API operation - // is only for on-premises managed nodes. You must specify the name of the managed - // node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f. + // ManagedInstance : mi-012345abcde The ManagedInstance type for this API + // operation is only for on-premises managed nodes. You must specify the name of + // the managed node in the following format: mi-ID_number . For example, + // mi-1a2b3c4d5e6f . // // This member is required. ResourceId *string @@ -80,7 +72,7 @@ type AddTagsToResourceInput struct { // Specifies the type of resource you are tagging. The ManagedInstance type for // this API operation is for on-premises managed nodes. You must specify the name // of the managed node in the following format: mi-ID_number . For example, - // mi-1a2b3c4d5e6f. + // mi-1a2b3c4d5e6f . // // This member is required. ResourceType types.ResourceTypeForTagging diff --git a/service/ssm/api_op_AssociateOpsItemRelatedItem.go b/service/ssm/api_op_AssociateOpsItemRelatedItem.go index 81990105914..1b1d0cd7589 100644 --- a/service/ssm/api_op_AssociateOpsItemRelatedItem.go +++ b/service/ssm/api_op_AssociateOpsItemRelatedItem.go @@ -44,14 +44,14 @@ type AssociateOpsItemRelatedItemInput struct { OpsItemId *string // The type of resource that you want to associate with an OpsItem. OpsCenter - // supports the following types: AWS::SSMIncidents::IncidentRecord: an Incident - // Manager incident. AWS::SSM::Document: a Systems Manager (SSM) document. + // supports the following types: AWS::SSMIncidents::IncidentRecord : an Incident + // Manager incident. AWS::SSM::Document : a Systems Manager (SSM) document. // // This member is required. ResourceType *string - // The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want - // to associate with the OpsItem. + // The Amazon Resource Name (ARN) of the Amazon Web Services resource that you + // want to associate with the OpsItem. // // This member is required. ResourceUri *string diff --git a/service/ssm/api_op_CancelCommand.go b/service/ssm/api_op_CancelCommand.go index c76f861bb4a..6f2e5ce11fc 100644 --- a/service/ssm/api_op_CancelCommand.go +++ b/service/ssm/api_op_CancelCommand.go @@ -43,8 +43,8 @@ type CancelCommandInput struct { noSmithyDocumentSerde } -// Whether or not the command was successfully canceled. There is no guarantee that -// a request can be canceled. +// Whether or not the command was successfully canceled. There is no guarantee +// that a request can be canceled. type CancelCommandOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/ssm/api_op_CancelMaintenanceWindowExecution.go b/service/ssm/api_op_CancelMaintenanceWindowExecution.go index 9591060008a..76d10f67880 100644 --- a/service/ssm/api_op_CancelMaintenanceWindowExecution.go +++ b/service/ssm/api_op_CancelMaintenanceWindowExecution.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a maintenance window execution that is already in progress and cancels any -// tasks in the window that haven't already starting running. Tasks already in +// Stops a maintenance window execution that is already in progress and cancels +// any tasks in the window that haven't already starting running. Tasks already in // progress will continue to completion. func (c *Client) CancelMaintenanceWindowExecution(ctx context.Context, params *CancelMaintenanceWindowExecutionInput, optFns ...func(*Options)) (*CancelMaintenanceWindowExecutionOutput, error) { if params == nil { diff --git a/service/ssm/api_op_CreateActivation.go b/service/ssm/api_op_CreateActivation.go index e2cdcf01972..6fe427fcdc6 100644 --- a/service/ssm/api_op_CreateActivation.go +++ b/service/ssm/api_op_CreateActivation.go @@ -19,8 +19,7 @@ import ( // activation code and ID when installing SSM Agent on machines in your hybrid // environment. For more information about requirements for managing on-premises // machines using Systems Manager, see Setting up Amazon Web Services Systems -// Manager for hybrid environments -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) +// Manager for hybrid environments (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) // in the Amazon Web Services Systems Manager User Guide. Amazon Elastic Compute // Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that // are configured for Systems Manager are all called managed nodes. @@ -43,9 +42,8 @@ type CreateActivationInput struct { // The name of the Identity and Access Management (IAM) role that you want to // assign to the managed node. This IAM role must provide AssumeRole permissions - // for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. - // For more information, see Create an IAM service role for a hybrid environment - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) + // for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com + // . For more information, see Create an IAM service role for a hybrid environment (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) // in the Amazon Web Services Systems Manager User Guide. You can't specify an IAM // service-linked role for this parameter. You must create a unique role. // @@ -69,34 +67,29 @@ type CreateActivationInput struct { ExpirationDate *time.Time // Specify the maximum number of managed nodes you want to register. The default - // value is 1. + // value is 1 . RegistrationLimit *int32 // Reserved for internal use. RegistrationMetadata []types.RegistrationMetadataItem - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For + // Optional metadata that you assign to a resource. Tags enable you to categorize + // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag an activation to identify which servers or // virtual machines (VMs) in your on-premises environment you intend to activate. // In this case, you could specify the following key-value pairs: - // - // * - // Key=OS,Value=Windows - // - // * Key=Environment,Value=Production - // - // When you install SSM - // Agent on your on-premises servers and VMs, you specify an activation ID and - // code. When you specify the activation ID and code, tags assigned to the - // activation are automatically applied to the on-premises servers or VMs. You - // can't add tags to or delete tags from an existing activation. You can tag your - // on-premises servers, edge devices, and VMs after they connect to Systems Manager - // for the first time and are assigned a managed node ID. This means they are - // listed in the Amazon Web Services Systems Manager console with an ID that is - // prefixed with "mi-". For information about how to add tags to your managed - // nodes, see AddTagsToResource. For information about how to remove tags from your - // managed nodes, see RemoveTagsFromResource. + // - Key=OS,Value=Windows + // - Key=Environment,Value=Production + // When you install SSM Agent on your on-premises servers and VMs, you specify an + // activation ID and code. When you specify the activation ID and code, tags + // assigned to the activation are automatically applied to the on-premises servers + // or VMs. You can't add tags to or delete tags from an existing activation. You + // can tag your on-premises servers, edge devices, and VMs after they connect to + // Systems Manager for the first time and are assigned a managed node ID. This + // means they are listed in the Amazon Web Services Systems Manager console with an + // ID that is prefixed with "mi-". For information about how to add tags to your + // managed nodes, see AddTagsToResource . For information about how to remove tags + // from your managed nodes, see RemoveTagsFromResource . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateAssociation.go b/service/ssm/api_op_CreateAssociation.go index bc1dfecfc37..07f71b5c438 100644 --- a/service/ssm/api_op_CreateAssociation.go +++ b/service/ssm/api_op_CreateAssociation.go @@ -50,7 +50,7 @@ type CreateAssociationInput struct { // For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For // Amazon Web Services-predefined documents and SSM documents you created in your // account, you only need to specify the document name. For example, - // AWS-ApplyPatchBaseline or My-Document. + // AWS-ApplyPatchBaseline or My-Document . // // This member is required. Name *string @@ -77,40 +77,40 @@ type CreateAssociationInput struct { // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // you want to gate your associations under. The associations only run when that // change calendar is open. For more information, see Amazon Web Services Systems - // Manager Change Calendar - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). + // Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) + // . CalendarNames []string // The severity level to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity - // The document version you want to associate with the target(s). Can be a specific - // version or the default version. State Manager doesn't support running + // The document version you want to associate with the target(s). Can be a + // specific version or the default version. State Manager doesn't support running // associations that use a new version of a document if that document is shared // from another account. State Manager always runs the default version of a // document if shared from another account, even though the Systems Manager console // shows that a new version was processed. If you want to run an association using // a new version of a document shared form another account, you must set the - // document version to default. + // document version to default . DocumentVersion *string // The managed node ID. InstanceId has been deprecated. To specify a managed node // ID for an association, use the Targets parameter. Requests that include the // parameter InstanceID with Systems Manager documents (SSM documents) that use // schema version 2.0 or later will fail. In addition, if you use the parameter - // InstanceId, you can't use the parameters AssociationName, DocumentVersion, - // MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these - // parameters, you must use the Targets parameter. + // InstanceId , you can't use the parameters AssociationName , DocumentVersion , + // MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use + // these parameters, you must use the Targets parameter. InstanceId *string // The maximum number of targets allowed to run the association at the same time. // You can specify a number, for example 10, or a percentage of the target set, for // example 10%. The default value is 100%, which means all targets run the // association at the same time. If a new managed node starts and attempts to run - // an association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new + // an association while Systems Manager is running MaxConcurrency associations, + // the association is allowed to run. During the next association interval, the new // managed node will process its association within the limit specified for - // MaxConcurrency. + // MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -119,12 +119,12 @@ type CreateAssociationInput struct { // 10%. If you specify 3, for example, the system stops sending requests when the // fourth error is received. If you specify 0, then the system stops sending // requests after the first error is returned. If you run an association on 50 - // managed nodes and set MaxError to 10%, then the system stops sending the request - // when the sixth error is received. Executions that are already running an - // association when MaxErrors is reached are allowed to complete, but some of these - // executions may fail as well. If you need to ensure that there won't be more than - // max-errors failed executions, set MaxConcurrency to 1 so that executions proceed - // one at a time. + // managed nodes and set MaxError to 10%, then the system stops sending the + // request when the sixth error is received. Executions that are already running an + // association when MaxErrors is reached are allowed to complete, but some of + // these executions may fail as well. If you need to ensure that there won't be + // more than max-errors failed executions, set MaxConcurrency to 1 so that + // executions proceed one at a time. MaxErrors *string // An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the @@ -138,25 +138,24 @@ type CreateAssociationInput struct { ScheduleExpression *string // Number of days to wait after the scheduled day to run an association. For - // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could + // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *) , you could // specify an offset of 3 to run the association each Sunday after the second // Thursday of the month. For more information about cron schedules for - // associations, see Reference: Cron and rate expressions for Systems Manager - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) + // associations, see Reference: Cron and rate expressions for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) // in the Amazon Web Services Systems Manager User Guide. To use offsets, you must // specify the ApplyOnlyAtCronInterval parameter. This option tells the system not // to run an association immediately after you create it. ScheduleOffset *int32 - // The mode for generating association compliance. You can specify AUTO or MANUAL. + // The mode for generating association compliance. You can specify AUTO or MANUAL . // In AUTO mode, the system uses the status of the association execution to // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems API operation. In - // this case, compliance data isn't managed by State Manager. It is managed by your - // direct call to the PutComplianceItems API operation. By default, all - // associations use AUTO mode. + // then the association is COMPLIANT . If the association execution doesn't run + // successfully, the association is NON-COMPLIANT . In MANUAL mode, you must + // specify the AssociationId as a parameter for the PutComplianceItems API + // operation. In this case, compliance data isn't managed by State Manager. It is + // managed by your direct call to the PutComplianceItems API operation. By + // default, all associations use AUTO mode. SyncCompliance types.AssociationSyncCompliance // Adds or overwrites one or more tags for a State Manager association. Tags are @@ -171,17 +170,16 @@ type CreateAssociationInput struct { // create an association in multiple Regions and multiple accounts. TargetLocations []types.TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The targets for the association. You can target managed nodes by using tags, // Amazon Web Services resource groups, all managed nodes in an Amazon Web Services // account, or individual managed node IDs. You can target all managed nodes in an - // Amazon Web Services account by specifying the InstanceIds key with a value of *. - // For more information about choosing targets for an association, see Using - // targets and rate controls with State Manager associations - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html) + // Amazon Web Services account by specifying the InstanceIds key with a value of * + // . For more information about choosing targets for an association, see Using + // targets and rate controls with State Manager associations (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html) // in the Amazon Web Services Systems Manager User Guide. Targets []types.Target diff --git a/service/ssm/api_op_CreateDocument.go b/service/ssm/api_op_CreateDocument.go index 684befc28b8..430a8e9fc09 100644 --- a/service/ssm/api_op_CreateDocument.go +++ b/service/ssm/api_op_CreateDocument.go @@ -14,8 +14,7 @@ import ( // Creates a Amazon Web Services Systems Manager (SSM document). An SSM document // defines the actions that Systems Manager performs on your managed nodes. For // more information about SSM documents, including information about supported -// schemas, features, and syntax, see Amazon Web Services Systems Manager Documents -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) +// schemas, features, and syntax, see Amazon Web Services Systems Manager Documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) // in the Amazon Web Services Systems Manager User Guide. func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentInput, optFns ...func(*Options)) (*CreateDocumentOutput, error) { if params == nil { @@ -40,17 +39,9 @@ type CreateDocumentInput struct { // document in an external JSON or YAML file and referencing the file in a command. // For examples, see the following topics in the Amazon Web Services Systems // Manager User Guide. - // - // * Create an SSM document (Amazon Web Services API) - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) - // - // * - // Create an SSM document (Amazon Web Services CLI) - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html) - // - // * - // Create an SSM document (API) - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) + // - Create an SSM document (Amazon Web Services API) (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) + // - Create an SSM document (Amazon Web Services CLI) (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html) + // - Create an SSM document (API) (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) // // This member is required. Content *string @@ -58,12 +49,9 @@ type CreateDocumentInput struct { // A name for the SSM document. You can't use the following strings as document // name prefixes. These are reserved by Amazon Web Services for use as document // name prefixes: - // - // * aws - // - // * amazon - // - // * amzn + // - aws + // - amazon + // - amzn // // This member is required. Name *string @@ -89,39 +77,32 @@ type CreateDocumentInput struct { // SSM document, the user must also specify a required document for validation // purposes. In this case, an ApplicationConfiguration document requires an // ApplicationConfigurationSchema document for validation purposes. For more - // information, see What is AppConfig? - // (https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) + // information, see What is AppConfig? (https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) // in the AppConfig User Guide. Requires []types.DocumentRequires - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For + // Optional metadata that you assign to a resource. Tags enable you to categorize + // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag an SSM document to identify the types of targets // or the environment where it will run. In this case, you could specify the // following key-value pairs: - // - // * Key=OS,Value=Windows - // - // * - // Key=Environment,Value=Production - // - // To add tags to an existing SSM document, use - // the AddTagsToResource operation. + // - Key=OS,Value=Windows + // - Key=Environment,Value=Production + // To add tags to an existing SSM document, use the AddTagsToResource operation. Tags []types.Tag // Specify a target type to define the kinds of resources the document can run on. // For example, to run a document on EC2 instances, specify the following value: - // /AWS::EC2::Instance. If you specify a value of '/' the document can run on all + // /AWS::EC2::Instance . If you specify a value of '/' the document can run on all // types of resources. If you don't specify a value, the document can't run on any // resources. For a list of valid resource types, see Amazon Web Services resource - // and property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. TargetType *string // An optional field specifying the version of the artifact you are creating with - // the document. For example, Release12.1. This value is unique across all versions - // of a document, and can't be changed. + // the document. For example, Release12.1 . This value is unique across all + // versions of a document, and can't be changed. VersionName *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateMaintenanceWindow.go b/service/ssm/api_op_CreateMaintenanceWindow.go index 89a31980161..d7825488e0d 100644 --- a/service/ssm/api_op_CreateMaintenanceWindow.go +++ b/service/ssm/api_op_CreateMaintenanceWindow.go @@ -15,7 +15,7 @@ import ( // Creates a new maintenance window. The value you specify for Duration determines // the specific end time for the maintenance window based on the time it begins. No // maintenance window tasks are permitted to start after the resulting endtime -// minus the number of hours you specify for Cutoff. For example, if the +// minus the number of hours you specify for Cutoff . For example, if the // maintenance window starts at 3 PM, the duration is three hours, and the value // you specify for Cutoff is one hour, no maintenance window tasks can start after // 5 PM. @@ -75,14 +75,14 @@ type CreateMaintenanceWindowInput struct { Description *string // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become inactive. EndDate allows you to set a date and time - // in the future when the maintenance window will no longer run. + // maintenance window to become inactive. EndDate allows you to set a date and + // time in the future when the maintenance window will no longer run. EndDate *string // The number of days to wait after the date and time specified by a cron // expression before running the maintenance window. For example, the following // cron expression schedules a maintenance window to run on the third Tuesday of - // every month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, + // every month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2 , // the maintenance window won't run until two days later. ScheduleOffset *int32 @@ -93,26 +93,20 @@ type CreateMaintenanceWindowInput struct { ScheduleTimezone *string // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become active. StartDate allows you to delay activation of - // the maintenance window until the specified future date. + // maintenance window to become active. StartDate allows you to delay activation + // of the maintenance window until the specified future date. StartDate *string - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For + // Optional metadata that you assign to a resource. Tags enable you to categorize + // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag a maintenance window to identify the type of // tasks it will run, the types of targets, and the environment it will run in. In // this case, you could specify the following key-value pairs: - // - // * - // Key=TaskType,Value=AgentUpdate - // - // * Key=OS,Value=Windows - // - // * - // Key=Environment,Value=Production - // - // To add tags to an existing maintenance window, - // use the AddTagsToResource operation. + // - Key=TaskType,Value=AgentUpdate + // - Key=OS,Value=Windows + // - Key=Environment,Value=Production + // To add tags to an existing maintenance window, use the AddTagsToResource + // operation. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateOpsItem.go b/service/ssm/api_op_CreateOpsItem.go index 906d701bfe2..6693c3cedfc 100644 --- a/service/ssm/api_op_CreateOpsItem.go +++ b/service/ssm/api_op_CreateOpsItem.go @@ -14,15 +14,13 @@ import ( // Creates a new OpsItem. You must have permission in Identity and Access // Management (IAM) to create a new OpsItem. For more information, see Getting -// started with OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) // in the Amazon Web Services Systems Manager User Guide. Operations engineers and // IT professionals use Amazon Web Services Systems Manager OpsCenter to view, // investigate, and remediate operational issues impacting the performance and // health of their Amazon Web Services resources. For more information, see Amazon -// Web Services Systems Manager OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in -// the Amazon Web Services Systems Manager User Guide. +// Web Services Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, optFns ...func(*Options)) (*CreateOpsItemOutput, error) { if params == nil { params = &CreateOpsItemInput{} @@ -46,7 +44,7 @@ type CreateOpsItemInput struct { Description *string // The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source - // name can't contain the following strings: aws, amazon, and amzn. + // name can't contain the following strings: aws , amazon , and amzn . // // This member is required. Source *string @@ -60,65 +58,60 @@ type CreateOpsItemInput struct { // The target Amazon Web Services account where you want to create an OpsItem. To // make this call, your account must be configured to work with OpsItems across // accounts. For more information, see Setting up OpsCenter to work with OpsItems - // across accounts - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-OpsCenter-multiple-accounts.html) + // across accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-OpsCenter-multiple-accounts.html) // in the Amazon Web Services Systems Manager User Guide. AccountId *string // The time a runbook workflow ended. Currently reported only for the OpsItem type - // /aws/changerequest. + // /aws/changerequest . ActualEndTime *time.Time // The time a runbook workflow started. Currently reported only for the OpsItem - // type /aws/changerequest. + // type /aws/changerequest . ActualStartTime *time.Time // Specify a category to assign to an OpsItem. Category *string - // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when - // this OpsItem is edited or changed. + // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent + // when this OpsItem is edited or changed. Notifications []types.OpsItemNotification - // Operational data is custom data that provides useful reference details about the - // OpsItem. For example, you can specify log files, error strings, license keys, - // troubleshooting tips, or other relevant data. You enter operational data as - // key-value pairs. The key has a maximum length of 128 characters. The value has a - // maximum size of 20 KB. Operational data keys can't begin with the following: - // amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the - // data searchable by other users in the account or you can restrict search access. - // Searchable data means that all users with access to the OpsItem Overview page - // (as provided by the DescribeOpsItems API operation) can view and search on the - // specified data. Operational data that isn't searchable is only viewable by users - // who have access to the OpsItem (as provided by the GetOpsItem API operation). - // Use the /aws/resources key in OperationalData to specify a related resource in - // the request. Use the /aws/automations key in OperationalData to associate an - // Automation runbook with the OpsItem. To view Amazon Web Services CLI example - // commands that use these keys, see Creating OpsItems manually - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) + // Operational data is custom data that provides useful reference details about + // the OpsItem. For example, you can specify log files, error strings, license + // keys, troubleshooting tips, or other relevant data. You enter operational data + // as key-value pairs. The key has a maximum length of 128 characters. The value + // has a maximum size of 20 KB. Operational data keys can't begin with the + // following: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , /ssm . You can + // choose to make the data searchable by other users in the account or you can + // restrict search access. Searchable data means that all users with access to the + // OpsItem Overview page (as provided by the DescribeOpsItems API operation) can + // view and search on the specified data. Operational data that isn't searchable is + // only viewable by users who have access to the OpsItem (as provided by the + // GetOpsItem API operation). Use the /aws/resources key in OperationalData to + // specify a related resource in the request. Use the /aws/automations key in + // OperationalData to associate an Automation runbook with the OpsItem. To view + // Amazon Web Services CLI example commands that use these keys, see Creating + // OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) // in the Amazon Web Services Systems Manager User Guide. OperationalData map[string]types.OpsItemDataValue // The type of OpsItem to create. Systems Manager supports the following types of // OpsItems: - // - // * /aws/issue This type of OpsItem is used for default OpsItems - // created by OpsCenter. - // - // * /aws/changerequest This type of OpsItem is used by - // Change Manager for reviewing and approving or rejecting change requests. - // - // * - // /aws/insights This type of OpsItem is used by OpsCenter for aggregating and - // reporting on duplicate OpsItems. + // - /aws/issue This type of OpsItem is used for default OpsItems created by + // OpsCenter. + // - /aws/changerequest This type of OpsItem is used by Change Manager for + // reviewing and approving or rejecting change requests. + // - /aws/insights This type of OpsItem is used by OpsCenter for aggregating and + // reporting on duplicate OpsItems. OpsItemType *string // The time specified in a change request for a runbook workflow to end. Currently - // supported only for the OpsItem type /aws/changerequest. + // supported only for the OpsItem type /aws/changerequest . PlannedEndTime *time.Time // The time specified in a change request for a runbook workflow to start. - // Currently supported only for the OpsItem type /aws/changerequest. + // Currently supported only for the OpsItem type /aws/changerequest . PlannedStartTime *time.Time // The importance of this OpsItem in relation to other OpsItems in the system. @@ -134,13 +127,12 @@ type CreateOpsItemInput struct { // Optional metadata that you assign to a resource. You can restrict access to // OpsItems by using an inline IAM policy that specifies tags. For more - // information, see Getting started with OpsCenter - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions) + // information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions) // in the Amazon Web Services Systems Manager User Guide. Tags use a key-value // pair. For example: Key=Department,Value=Finance To add tags to a new OpsItem, a - // user must have IAM permissions for both the ssm:CreateOpsItems operation and the - // ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the - // AddTagsToResource operation. + // user must have IAM permissions for both the ssm:CreateOpsItems operation and + // the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use + // the AddTagsToResource operation. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateOpsMetadata.go b/service/ssm/api_op_CreateOpsMetadata.go index 136f4350e9f..be186a76248 100644 --- a/service/ssm/api_op_CreateOpsMetadata.go +++ b/service/ssm/api_op_CreateOpsMetadata.go @@ -45,11 +45,8 @@ type CreateOpsMetadataInput struct { // might want to tag an OpsMetadata object to identify an environment or target // Amazon Web Services Region. In this case, you could specify the following // key-value pairs: - // - // * Key=Environment,Value=Production - // - // * - // Key=Region,Value=us-east-2 + // - Key=Environment,Value=Production + // - Key=Region,Value=us-east-2 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreatePatchBaseline.go b/service/ssm/api_op_CreatePatchBaseline.go index 6fa797aa1fa..1353ec178b4 100644 --- a/service/ssm/api_op_CreatePatchBaseline.go +++ b/service/ssm/api_op_CreatePatchBaseline.go @@ -13,7 +13,7 @@ import ( ) // Creates a patch baseline. For information about valid key-value pairs in -// PatchFilters for each supported operating system type, see PatchFilter. +// PatchFilters for each supported operating system type, see PatchFilter . func (c *Client) CreatePatchBaseline(ctx context.Context, params *CreatePatchBaselineInput, optFns ...func(*Options)) (*CreatePatchBaselineOutput, error) { if params == nil { params = &CreatePatchBaselineInput{} @@ -41,19 +41,18 @@ type CreatePatchBaselineInput struct { // A list of explicitly approved patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. ApprovedPatches []string // Defines the compliance level for approved patches. When an approved patch is // reported as missing, this value describes the severity of the compliance - // violation. The default value is UNSPECIFIED. + // violation. The default value is UNSPECIFIED . ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the managed nodes. The default value is false. Applies - // to Linux managed nodes only. + // that should be applied to the managed nodes. The default value is false . + // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // User-provided idempotency token. @@ -65,30 +64,27 @@ type CreatePatchBaselineInput struct { // A set of global filters used to include patches in the baseline. GlobalFilters *types.PatchFilterGroup - // Defines the operating system the patch baseline applies to. The default value is - // WINDOWS. + // Defines the operating system the patch baseline applies to. The default value + // is WINDOWS . OperatingSystem types.OperatingSystem // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. RejectedPatches []string // The action for Patch Manager to take on patches included in the RejectedPackages // list. - // - // * ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is - // installed only if it is a dependency of another package. It is considered - // compliant with the patch baseline, and its status is reported as InstalledOther. - // This is the default action if no option is specified. - // - // * BLOCK : Packages in the - // RejectedPatches list, and packages that include them as dependencies, aren't - // installed under any circumstances. If a package was installed before it was - // added to the Rejected patches list, it is considered non-compliant with the - // patch baseline, and its status is reported as InstalledRejected. + // - ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed + // only if it is a dependency of another package. It is considered compliant with + // the patch baseline, and its status is reported as InstalledOther . This is the + // default action if no option is specified. + // - BLOCK : Packages in the RejectedPatches list, and packages that include them + // as dependencies, aren't installed under any circumstances. If a package was + // installed before it was added to the Rejected patches list, it is considered + // non-compliant with the patch baseline, and its status is reported as + // InstalledRejected . RejectedPatchesAction types.PatchAction // Information about the patches to use to update the managed nodes, including @@ -96,19 +92,14 @@ type CreatePatchBaselineInput struct { // only. Sources []types.PatchSource - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For + // Optional metadata that you assign to a resource. Tags enable you to categorize + // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag a patch baseline to identify the severity level // of patches it specifies and the operating system family it applies to. In this // case, you could specify the following key-value pairs: - // - // * - // Key=PatchSeverity,Value=Critical - // - // * Key=OS,Value=Windows - // - // To add tags to an - // existing patch baseline, use the AddTagsToResource operation. + // - Key=PatchSeverity,Value=Critical + // - Key=OS,Value=Windows + // To add tags to an existing patch baseline, use the AddTagsToResource operation. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateResourceDataSync.go b/service/ssm/api_op_CreateResourceDataSync.go index 9b4edcd152d..b6f3b76b337 100644 --- a/service/ssm/api_op_CreateResourceDataSync.go +++ b/service/ssm/api_op_CreateResourceDataSync.go @@ -13,12 +13,11 @@ import ( // A resource data sync helps you view data from multiple sources in a single // location. Amazon Web Services Systems Manager offers two types of resource data -// sync: SyncToDestination and SyncFromSource. You can configure Systems Manager +// sync: SyncToDestination and SyncFromSource . You can configure Systems Manager // Inventory to use the SyncToDestination type to synchronize Inventory data from // multiple Amazon Web Services Regions to a single Amazon Simple Storage Service -// (Amazon S3) bucket. For more information, see Configuring resource data sync for -// Inventory -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) +// (Amazon S3) bucket. For more information, see Configuring resource data sync +// for Inventory (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) // in the Amazon Web Services Systems Manager User Guide. You can configure Systems // Manager Explorer to use the SyncFromSource type to synchronize operational work // items (OpsItems) and operational data (OpsData) from multiple Amazon Web @@ -26,12 +25,11 @@ import ( // OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web // Services Regions or EntireOrganization by using Organizations. For more // information, see Setting up Systems Manager Explorer to display data from -// multiple accounts and Regions -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) +// multiple accounts and Regions (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) // in the Amazon Web Services Systems Manager User Guide. A resource data sync is // an asynchronous operation that returns immediately. After a successful initial // sync is completed, the system continuously syncs data. To check the status of a -// sync, use the ListResourceDataSync. By default, data isn't encrypted in Amazon +// sync, use the ListResourceDataSync . By default, data isn't encrypted in Amazon // S3. We strongly recommend that you enable encryption in Amazon S3 to ensure // secure data storage. We also recommend that you secure access to the Amazon S3 // bucket by creating a restrictive bucket policy. @@ -66,12 +64,12 @@ type CreateResourceDataSyncInput struct { SyncSource *types.ResourceDataSyncSource // Specify SyncToDestination to create a resource data sync that synchronizes data - // to an S3 bucket for Inventory. If you specify SyncToDestination, you must - // provide a value for S3Destination. Specify SyncFromSource to synchronize data + // to an S3 bucket for Inventory. If you specify SyncToDestination , you must + // provide a value for S3Destination . Specify SyncFromSource to synchronize data // from a single account and multiple Regions, or multiple Amazon Web Services // accounts and Amazon Web Services Regions, as listed in Organizations for - // Explorer. If you specify SyncFromSource, you must provide a value for - // SyncSource. The default value is SyncToDestination. + // Explorer. If you specify SyncFromSource , you must provide a value for + // SyncSource . The default value is SyncToDestination . SyncType *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_DeleteAssociation.go b/service/ssm/api_op_DeleteAssociation.go index 89dab0b165b..047d553a72c 100644 --- a/service/ssm/api_op_DeleteAssociation.go +++ b/service/ssm/api_op_DeleteAssociation.go @@ -41,9 +41,9 @@ type DeleteAssociationInput struct { // ID for an association, use the Targets parameter. Requests that include the // parameter InstanceID with Systems Manager documents (SSM documents) that use // schema version 2.0 or later will fail. In addition, if you use the parameter - // InstanceId, you can't use the parameters AssociationName, DocumentVersion, - // MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these - // parameters, you must use the Targets parameter. + // InstanceId , you can't use the parameters AssociationName , DocumentVersion , + // MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use + // these parameters, you must use the Targets parameter. InstanceId *string // The name of the SSM document. diff --git a/service/ssm/api_op_DeleteDocument.go b/service/ssm/api_op_DeleteDocument.go index 02fc4ae9657..064218830d3 100644 --- a/service/ssm/api_op_DeleteDocument.go +++ b/service/ssm/api_op_DeleteDocument.go @@ -42,7 +42,7 @@ type DeleteDocumentInput struct { // Some SSM document types require that you specify a Force flag before you can // delete the document. For example, you must specify a Force flag to delete a - // document of type ApplicationConfigurationSchema. You can restrict access to the + // document of type ApplicationConfigurationSchema . You can restrict access to the // Force flag in an Identity and Access Management (IAM) policy. Force bool diff --git a/service/ssm/api_op_DeleteInventory.go b/service/ssm/api_op_DeleteInventory.go index ca7c45baf84..59e1c8bdd37 100644 --- a/service/ssm/api_op_DeleteInventory.go +++ b/service/ssm/api_op_DeleteInventory.go @@ -70,8 +70,7 @@ type DeleteInventoryOutput struct { DeletionId *string // A summary of the delete operation. For more information about this summary, see - // Deleting custom inventory - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary) + // Deleting custom inventory (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary) // in the Amazon Web Services Systems Manager User Guide. DeletionSummary *types.InventoryDeletionSummary diff --git a/service/ssm/api_op_DeleteResourcePolicy.go b/service/ssm/api_op_DeleteResourcePolicy.go index 65af656626d..0ec3c7785d8 100644 --- a/service/ssm/api_op_DeleteResourcePolicy.go +++ b/service/ssm/api_op_DeleteResourcePolicy.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Systems Manager resource policy. A resource policy helps you to define -// the IAM entity (for example, an Amazon Web Services account) that can manage -// your Systems Manager resources. Currently, OpsItemGroup is the only resource -// that supports Systems Manager resource policies. The resource policy for -// OpsItemGroup enables Amazon Web Services accounts to view and interact with +// Deletes a Systems Manager resource policy. A resource policy helps you to +// define the IAM entity (for example, an Amazon Web Services account) that can +// manage your Systems Manager resources. Currently, OpsItemGroup is the only +// resource that supports Systems Manager resource policies. The resource policy +// for OpsItemGroup enables Amazon Web Services accounts to view and interact with // OpsCenter operational work items (OpsItems). func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { diff --git a/service/ssm/api_op_DescribeActivations.go b/service/ssm/api_op_DescribeActivations.go index d559161a37a..0793690c436 100644 --- a/service/ssm/api_op_DescribeActivations.go +++ b/service/ssm/api_op_DescribeActivations.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes details about the activation, such as the date and time the activation -// was created, its expiration date, the Identity and Access Management (IAM) role -// assigned to the managed nodes in the activation, and the number of nodes -// registered by using this activation. +// Describes details about the activation, such as the date and time the +// activation was created, its expiration date, the Identity and Access Management +// (IAM) role assigned to the managed nodes in the activation, and the number of +// nodes registered by using this activation. func (c *Client) DescribeActivations(ctx context.Context, params *DescribeActivationsInput, optFns ...func(*Options)) (*DescribeActivationsOutput, error) { if params == nil { params = &DescribeActivationsInput{} @@ -121,8 +121,8 @@ func (c *Client) addOperationDescribeActivationsMiddlewares(stack *middleware.St return nil } -// DescribeActivationsAPIClient is a client that implements the DescribeActivations -// operation. +// DescribeActivationsAPIClient is a client that implements the +// DescribeActivations operation. type DescribeActivationsAPIClient interface { DescribeActivations(context.Context, *DescribeActivationsInput, ...func(*Options)) (*DescribeActivationsOutput, error) } diff --git a/service/ssm/api_op_DescribeAssociation.go b/service/ssm/api_op_DescribeAssociation.go index 01e17d3fd9c..b65c8546af1 100644 --- a/service/ssm/api_op_DescribeAssociation.go +++ b/service/ssm/api_op_DescribeAssociation.go @@ -36,8 +36,8 @@ type DescribeAssociationInput struct { // Specify the association version to retrieve. To view the latest version, either // specify $LATEST for this parameter, or omit this parameter. To view a list of - // all associations for a managed node, use ListAssociations. To get a list of - // versions for a specific association, use ListAssociationVersions. + // all associations for a managed node, use ListAssociations . To get a list of + // versions for a specific association, use ListAssociationVersions . AssociationVersion *string // The managed node ID. diff --git a/service/ssm/api_op_DescribeAssociationExecutionTargets.go b/service/ssm/api_op_DescribeAssociationExecutionTargets.go index 13ab5a410a2..4561e77d3d3 100644 --- a/service/ssm/api_op_DescribeAssociationExecutionTargets.go +++ b/service/ssm/api_op_DescribeAssociationExecutionTargets.go @@ -141,8 +141,8 @@ type DescribeAssociationExecutionTargetsAPIClient interface { var _ DescribeAssociationExecutionTargetsAPIClient = (*Client)(nil) -// DescribeAssociationExecutionTargetsPaginatorOptions is the paginator options for -// DescribeAssociationExecutionTargets +// DescribeAssociationExecutionTargetsPaginatorOptions is the paginator options +// for DescribeAssociationExecutionTargets type DescribeAssociationExecutionTargetsPaginatorOptions struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. diff --git a/service/ssm/api_op_DescribeAvailablePatches.go b/service/ssm/api_op_DescribeAvailablePatches.go index 7087a7c4f16..280f43f0517 100644 --- a/service/ssm/api_op_DescribeAvailablePatches.go +++ b/service/ssm/api_op_DescribeAvailablePatches.go @@ -33,60 +33,32 @@ type DescribeAvailablePatchesInput struct { // Each element in the array is a structure containing a key-value pair. Windows // Server Supported keys for Windows Server managed node patches include the // following: - // - // * PATCH_SET Sample values: OS | APPLICATION - // - // * PRODUCT Sample - // values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus - // - // * - // PRODUCT_FAMILY Sample values: Windows | Office - // - // * MSRC_SEVERITY Sample values: - // ServicePacks | Important | Moderate - // - // * CLASSIFICATION Sample values: - // ServicePacks | SecurityUpdates | DefinitionUpdates - // - // * PATCH_ID Sample values: - // KB123456 | KB4516046 - // - // Linux When specifying filters for Linux patches, you must - // specify a key-pair for PRODUCT. For example, using the Command Line Interface - // (CLI), the following command fails: aws ssm describe-available-patches --filters - // Key=CVE_ID,Values=CVE-2018-3615 However, the following command succeeds: aws ssm - // describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 + // - PATCH_SET Sample values: OS | APPLICATION + // - PRODUCT Sample values: WindowsServer2012 | Office 2010 | + // MicrosoftDefenderAntivirus + // - PRODUCT_FAMILY Sample values: Windows | Office + // - MSRC_SEVERITY Sample values: ServicePacks | Important | Moderate + // - CLASSIFICATION Sample values: ServicePacks | SecurityUpdates | + // DefinitionUpdates + // - PATCH_ID Sample values: KB123456 | KB4516046 + // Linux When specifying filters for Linux patches, you must specify a key-pair + // for PRODUCT . For example, using the Command Line Interface (CLI), the following + // command fails: aws ssm describe-available-patches --filters + // Key=CVE_ID,Values=CVE-2018-3615 However, the following command succeeds: aws + // ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 // Key=CVE_ID,Values=CVE-2018-3615 Supported keys for Linux managed node patches // include the following: - // - // * PRODUCT Sample values: AmazonLinux2018.03 | - // AmazonLinux2.0 - // - // * NAME Sample values: kernel-headers | samba-python | php - // - // * - // SEVERITY Sample values: Critical | Important | Medium | Low - // - // * EPOCH Sample - // values: 0 | 1 - // - // * VERSION Sample values: 78.6.1 | 4.10.16 - // - // * RELEASE Sample - // values: 9.56.amzn1 | 1.amzn2 - // - // * ARCH Sample values: i686 | x86_64 - // - // * REPOSITORY - // Sample values: Core | Updates - // - // * ADVISORY_ID Sample values: ALAS-2018-1058 | - // ALAS2-2021-1594 - // - // * CVE_ID Sample values: CVE-2018-3615 | CVE-2020-1472 - // - // * - // BUGZILLA_ID Sample values: 1463241 + // - PRODUCT Sample values: AmazonLinux2018.03 | AmazonLinux2.0 + // - NAME Sample values: kernel-headers | samba-python | php + // - SEVERITY Sample values: Critical | Important | Medium | Low + // - EPOCH Sample values: 0 | 1 + // - VERSION Sample values: 78.6.1 | 4.10.16 + // - RELEASE Sample values: 9.56.amzn1 | 1.amzn2 + // - ARCH Sample values: i686 | x86_64 + // - REPOSITORY Sample values: Core | Updates + // - ADVISORY_ID Sample values: ALAS-2018-1058 | ALAS2-2021-1594 + // - CVE_ID Sample values: CVE-2018-3615 | CVE-2020-1472 + // - BUGZILLA_ID Sample values: 1463241 Filters []types.PatchOrchestratorFilter // The maximum number of patches to return (per page). diff --git a/service/ssm/api_op_DescribeInstanceInformation.go b/service/ssm/api_op_DescribeInstanceInformation.go index d8fcc0adbac..a8e41da2f3c 100644 --- a/service/ssm/api_op_DescribeInstanceInformation.go +++ b/service/ssm/api_op_DescribeInstanceInformation.go @@ -40,7 +40,7 @@ type DescribeInstanceInformationInput struct { // One or more filters. Use a filter to return a more specific list of managed // nodes. You can filter based on tags applied to your managed nodes. Use this - // Filters data type instead of InstanceInformationFilterList, which is deprecated. + // Filters data type instead of InstanceInformationFilterList , which is deprecated. Filters []types.InstanceInformationStringFilter // This is a legacy method. We recommend that you don't use this method. Instead, diff --git a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go index e8125294419..3ba9ae04769 100644 --- a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go +++ b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go @@ -38,14 +38,9 @@ type DescribeInstancePatchStatesForPatchGroupInput struct { PatchGroup *string // Each entry in the array is a structure containing: - // - // * Key (string between 1 and - // 200 characters) - // - // * Values (array containing a single string) - // - // * Type (string - // "Equal", "NotEqual", "LessThan", "GreaterThan") + // - Key (string between 1 and 200 characters) + // - Values (array containing a single string) + // - Type (string "Equal", "NotEqual", "LessThan", "GreaterThan") Filters []types.InstancePatchStateFilter // The maximum number of patches to return (per page). diff --git a/service/ssm/api_op_DescribeInstancePatches.go b/service/ssm/api_op_DescribeInstancePatches.go index 45d91700294..9a68c5fee85 100644 --- a/service/ssm/api_op_DescribeInstancePatches.go +++ b/service/ssm/api_op_DescribeInstancePatches.go @@ -37,18 +37,11 @@ type DescribeInstancePatchesInput struct { InstanceId *string // Each element in the array is a structure containing a key-value pair. Supported - // keys for DescribeInstancePatchesinclude the following: - // - // * Classification Sample - // values: Security | SecurityUpdates - // - // * KBId Sample values: KB4480056 | - // java-1.7.0-openjdk.x86_64 - // - // * Severity Sample values: Important | Medium | Low - // - // * - // State Sample values: Installed | InstalledOther | InstalledPendingReboot + // keys for DescribeInstancePatches include the following: + // - Classification Sample values: Security | SecurityUpdates + // - KBId Sample values: KB4480056 | java-1.7.0-openjdk.x86_64 + // - Severity Sample values: Important | Medium | Low + // - State Sample values: Installed | InstalledOther | InstalledPendingReboot Filters []types.PatchOrchestratorFilter // The maximum number of patches to return (per page). @@ -68,22 +61,13 @@ type DescribeInstancePatchesOutput struct { NextToken *string // Each entry in the array is a structure containing: - // - // * Title (string) - // - // * KBId - // (string) - // - // * Classification (string) - // - // * Severity (string) - // - // * State (string, such - // as "INSTALLED" or "FAILED") - // - // * InstalledTime (DateTime) - // - // * InstalledBy (string) + // - Title (string) + // - KBId (string) + // - Classification (string) + // - Severity (string) + // - State (string, such as "INSTALLED" or "FAILED") + // - InstalledTime (DateTime) + // - InstalledBy (string) Patches []types.PatchComplianceData // Metadata pertaining to the operation's result. diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go index ee0e0a746c2..fda1baf3803 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go @@ -42,9 +42,9 @@ type DescribeMaintenanceWindowExecutionTaskInvocationsInput struct { // This member is required. WindowExecutionId *string - // Optional filters used to scope down the returned task invocations. The supported - // filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, - // SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED. + // Optional filters used to scope down the returned task invocations. The + // supported filter key is STATUS with the corresponding values PENDING , + // IN_PROGRESS , SUCCESS , FAILED , TIMED_OUT , CANCELLING , and CANCELLED . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go index eee81eda6ad..2b847ef90e5 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutionTasks.go @@ -36,9 +36,9 @@ type DescribeMaintenanceWindowExecutionTasksInput struct { // This member is required. WindowExecutionId *string - // Optional filters used to scope down the returned tasks. The supported filter key - // is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, - // TIMED_OUT, CANCELLING, and CANCELLED. + // Optional filters used to scope down the returned tasks. The supported filter + // key is STATUS with the corresponding values PENDING , IN_PROGRESS , SUCCESS , + // FAILED , TIMED_OUT , CANCELLING , and CANCELLED . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a @@ -130,16 +130,16 @@ func (c *Client) addOperationDescribeMaintenanceWindowExecutionTasksMiddlewares( return nil } -// DescribeMaintenanceWindowExecutionTasksAPIClient is a client that implements the -// DescribeMaintenanceWindowExecutionTasks operation. +// DescribeMaintenanceWindowExecutionTasksAPIClient is a client that implements +// the DescribeMaintenanceWindowExecutionTasks operation. type DescribeMaintenanceWindowExecutionTasksAPIClient interface { DescribeMaintenanceWindowExecutionTasks(context.Context, *DescribeMaintenanceWindowExecutionTasksInput, ...func(*Options)) (*DescribeMaintenanceWindowExecutionTasksOutput, error) } var _ DescribeMaintenanceWindowExecutionTasksAPIClient = (*Client)(nil) -// DescribeMaintenanceWindowExecutionTasksPaginatorOptions is the paginator options -// for DescribeMaintenanceWindowExecutionTasks +// DescribeMaintenanceWindowExecutionTasksPaginatorOptions is the paginator +// options for DescribeMaintenanceWindowExecutionTasks type DescribeMaintenanceWindowExecutionTasksPaginatorOptions struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go index 507b11ce0b3..5a4e979fcad 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go @@ -38,14 +38,11 @@ type DescribeMaintenanceWindowExecutionsInput struct { WindowId *string // Each entry in the array is a structure containing: - // - // * Key. A string between 1 - // and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter. - // - // * - // Values. An array of strings, each between 1 and 256 characters. Supported values - // are date/time strings in a valid ISO 8601 date/time format, such as - // 2021-11-04T05:00:00Z. + // - Key. A string between 1 and 128 characters. Supported keys include + // ExecutedBefore and ExecutedAfter . + // - Values. An array of strings, each between 1 and 256 characters. Supported + // values are date/time strings in a valid ISO 8601 date/time format, such as + // 2021-11-04T05:00:00Z . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a @@ -145,8 +142,8 @@ type DescribeMaintenanceWindowExecutionsAPIClient interface { var _ DescribeMaintenanceWindowExecutionsAPIClient = (*Client)(nil) -// DescribeMaintenanceWindowExecutionsPaginatorOptions is the paginator options for -// DescribeMaintenanceWindowExecutions +// DescribeMaintenanceWindowExecutionsPaginatorOptions is the paginator options +// for DescribeMaintenanceWindowExecutions type DescribeMaintenanceWindowExecutionsPaginatorOptions struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. diff --git a/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go b/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go index 7a49e2e9c2c..d7cfc03fca3 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowSchedule.go @@ -44,7 +44,7 @@ type DescribeMaintenanceWindowScheduleInput struct { NextToken *string // The type of resource you want to retrieve information about. For example, - // INSTANCE. + // INSTANCE . ResourceType types.MaintenanceWindowResourceType // The managed node ID or key-value pair to retrieve information about. @@ -62,8 +62,8 @@ type DescribeMaintenanceWindowScheduleOutput struct { // call.) NextToken *string - // Information about maintenance window executions scheduled for the specified time - // range. + // Information about maintenance window executions scheduled for the specified + // time range. ScheduledWindowExecutions []types.ScheduledWindowExecution // Metadata pertaining to the operation's result. diff --git a/service/ssm/api_op_DescribeMaintenanceWindowTargets.go b/service/ssm/api_op_DescribeMaintenanceWindowTargets.go index f9492508628..86a96b73fc5 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowTargets.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowTargets.go @@ -36,8 +36,8 @@ type DescribeMaintenanceWindowTargetsInput struct { WindowId *string // Optional filters that can be used to narrow down the scope of the returned - // window targets. The supported filter keys are Type, WindowTargetId, and - // OwnerInformation. + // window targets. The supported filter keys are Type , WindowTargetId , and + // OwnerInformation . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go index 6c98fd8ec14..858674ba3e2 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go @@ -13,10 +13,10 @@ import ( ) // Lists the tasks in a maintenance window. For maintenance window tasks without a -// specified target, you can't supply values for --max-errors and -// --max-concurrency. Instead, the system inserts a placeholder value of 1, which -// may be reported in the response to this command. These values don't affect the -// running of your task and can be ignored. +// specified target, you can't supply values for --max-errors and --max-concurrency +// . Instead, the system inserts a placeholder value of 1 , which may be reported +// in the response to this command. These values don't affect the running of your +// task and can be ignored. func (c *Client) DescribeMaintenanceWindowTasks(ctx context.Context, params *DescribeMaintenanceWindowTasksInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error) { if params == nil { params = &DescribeMaintenanceWindowTasksInput{} @@ -40,7 +40,7 @@ type DescribeMaintenanceWindowTasksInput struct { WindowId *string // Optional filters used to narrow down the scope of the returned tasks. The - // supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType. + // supported filter keys are WindowTaskId , TaskArn , Priority , and TaskType . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeMaintenanceWindows.go b/service/ssm/api_op_DescribeMaintenanceWindows.go index 74339868e1d..7f2573f98c8 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindows.go +++ b/service/ssm/api_op_DescribeMaintenanceWindows.go @@ -31,8 +31,8 @@ func (c *Client) DescribeMaintenanceWindows(ctx context.Context, params *Describ type DescribeMaintenanceWindowsInput struct { // Optional filters used to narrow down the scope of the returned maintenance - // windows. Supported filter keys are Name and Enabled. For example, - // Name=MyMaintenanceWindow and Enabled=True. + // windows. Supported filter keys are Name and Enabled . For example, + // Name=MyMaintenanceWindow and Enabled=True . Filters []types.MaintenanceWindowFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go b/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go index 3a74e0a9f96..63de9b9a507 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowsForTarget.go @@ -32,7 +32,7 @@ func (c *Client) DescribeMaintenanceWindowsForTarget(ctx context.Context, params type DescribeMaintenanceWindowsForTargetInput struct { // The type of resource you want to retrieve information about. For example, - // INSTANCE. + // INSTANCE . // // This member is required. ResourceType types.MaintenanceWindowResourceType @@ -140,8 +140,8 @@ type DescribeMaintenanceWindowsForTargetAPIClient interface { var _ DescribeMaintenanceWindowsForTargetAPIClient = (*Client)(nil) -// DescribeMaintenanceWindowsForTargetPaginatorOptions is the paginator options for -// DescribeMaintenanceWindowsForTarget +// DescribeMaintenanceWindowsForTargetPaginatorOptions is the paginator options +// for DescribeMaintenanceWindowsForTarget type DescribeMaintenanceWindowsForTargetPaginatorOptions struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. diff --git a/service/ssm/api_op_DescribeOpsItems.go b/service/ssm/api_op_DescribeOpsItems.go index 70de9f044ca..836bba7cb80 100644 --- a/service/ssm/api_op_DescribeOpsItems.go +++ b/service/ssm/api_op_DescribeOpsItems.go @@ -14,15 +14,13 @@ import ( // Query a set of OpsItems. You must have permission in Identity and Access // Management (IAM) to query a list of OpsItems. For more information, see Getting -// started with OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) // in the Amazon Web Services Systems Manager User Guide. Operations engineers and // IT professionals use Amazon Web Services Systems Manager OpsCenter to view, // investigate, and remediate operational issues impacting the performance and // health of their Amazon Web Services resources. For more information, see -// OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in -// the Amazon Web Services Systems Manager User Guide. +// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. func (c *Client) DescribeOpsItems(ctx context.Context, params *DescribeOpsItemsInput, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error) { if params == nil { params = &DescribeOpsItemsInput{} @@ -48,46 +46,24 @@ type DescribeOpsItemsInput struct { NextToken *string // One or more filters to limit the response. - // - // * Key: CreatedTime Operations: - // GreaterThan, LessThan - // - // * Key: LastModifiedBy Operations: Contains, Equals - // - // * - // Key: LastModifiedTime Operations: GreaterThan, LessThan - // - // * Key: Priority - // Operations: Equals - // - // * Key: Source Operations: Contains, Equals - // - // * Key: Status - // Operations: Equals - // - // * Key: Title* Operations: Equals,Contains - // - // * Key: - // OperationalData** Operations: Equals - // - // * Key: OperationalDataKey Operations: - // Equals - // - // * Key: OperationalDataValue Operations: Equals, Contains - // - // * Key: - // OpsItemId Operations: Equals - // - // * Key: ResourceId Operations: Contains - // - // * Key: - // AutomationId Operations: Equals - // - // *The Equals operator for Title matches the - // first 100 characters. If you specify more than 100 characters, they system - // returns an error that the filter value exceeds the length limit. **If you filter - // the response by using the OperationalData operator, specify a key-value pair by - // using the following JSON format: {"key":"key_name","value":"a_value"} + // - Key: CreatedTime Operations: GreaterThan, LessThan + // - Key: LastModifiedBy Operations: Contains, Equals + // - Key: LastModifiedTime Operations: GreaterThan, LessThan + // - Key: Priority Operations: Equals + // - Key: Source Operations: Contains, Equals + // - Key: Status Operations: Equals + // - Key: Title* Operations: Equals,Contains + // - Key: OperationalData** Operations: Equals + // - Key: OperationalDataKey Operations: Equals + // - Key: OperationalDataValue Operations: Equals, Contains + // - Key: OpsItemId Operations: Equals + // - Key: ResourceId Operations: Contains + // - Key: AutomationId Operations: Equals + // *The Equals operator for Title matches the first 100 characters. If you specify + // more than 100 characters, they system returns an error that the filter value + // exceeds the length limit. **If you filter the response by using the + // OperationalData operator, specify a key-value pair by using the following JSON + // format: {"key":"key_name","value":"a_value"} OpsItemFilters []types.OpsItemFilter noSmithyDocumentSerde diff --git a/service/ssm/api_op_DescribeParameters.go b/service/ssm/api_op_DescribeParameters.go index d014969f66c..85bdb63307b 100644 --- a/service/ssm/api_op_DescribeParameters.go +++ b/service/ssm/api_op_DescribeParameters.go @@ -12,16 +12,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get information about a parameter. Request results are returned on a best-effort -// basis. If you specify MaxResults in the request, the response includes -// information up to the limit specified. The number of items returned, however, -// can be between zero and the value of MaxResults. If the service reaches an -// internal limit while processing the results, it stops the operation and returns -// the matching values up to that point and a NextToken. You can specify the -// NextToken in a subsequent call to get the next set of results. If you change the -// KMS key alias for the KMS key used to encrypt a parameter, then you must also -// update the key alias the parameter uses to reference KMS. Otherwise, -// DescribeParameters retrieves whatever the original key alias was referencing. +// Get information about a parameter. Request results are returned on a +// best-effort basis. If you specify MaxResults in the request, the response +// includes information up to the limit specified. The number of items returned, +// however, can be between zero and the value of MaxResults . If the service +// reaches an internal limit while processing the results, it stops the operation +// and returns the matching values up to that point and a NextToken . You can +// specify the NextToken in a subsequent call to get the next set of results. If +// you change the KMS key alias for the KMS key used to encrypt a parameter, then +// you must also update the key alias the parameter uses to reference KMS. +// Otherwise, DescribeParameters retrieves whatever the original key alias was +// referencing. func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error) { if params == nil { params = &DescribeParametersInput{} @@ -39,7 +40,7 @@ func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParamet type DescribeParametersInput struct { - // This data type is deprecated. Instead, use ParameterFilters. + // This data type is deprecated. Instead, use ParameterFilters . Filters []types.ParametersFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribePatchBaselines.go b/service/ssm/api_op_DescribePatchBaselines.go index 017b169c55c..fd345eeaa8a 100644 --- a/service/ssm/api_op_DescribePatchBaselines.go +++ b/service/ssm/api_op_DescribePatchBaselines.go @@ -32,14 +32,9 @@ type DescribePatchBaselinesInput struct { // Each element in the array is a structure containing a key-value pair. Supported // keys for DescribePatchBaselines include the following: - // - // * NAME_PREFIX Sample - // values: AWS- | My- - // - // * OWNER Sample values: AWS | Self - // - // * OPERATING_SYSTEM Sample - // values: AMAZON_LINUX | SUSE | WINDOWS + // - NAME_PREFIX Sample values: AWS- | My- + // - OWNER Sample values: AWS | Self + // - OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS Filters []types.PatchOrchestratorFilter // The maximum number of patch baselines to return (per page). diff --git a/service/ssm/api_op_DescribePatchGroupState.go b/service/ssm/api_op_DescribePatchGroupState.go index 72cca493821..c0930ed801d 100644 --- a/service/ssm/api_op_DescribePatchGroupState.go +++ b/service/ssm/api_op_DescribePatchGroupState.go @@ -46,7 +46,7 @@ type DescribePatchGroupStateOutput struct { // compliance reporting in the patch baseline aren't installed. These patches might // be missing, have failed installation, were rejected, or were installed but // awaiting a required managed node reboot. The status of these managed nodes is - // NON_COMPLIANT. + // NON_COMPLIANT . InstancesWithCriticalNonCompliantPatches *int32 // The number of managed nodes with patches from the patch baseline that failed to @@ -60,16 +60,16 @@ type DescribePatchGroupStateOutput struct { // The number of managed nodes with installed patches. InstancesWithInstalledPatches int32 - // The number of managed nodes with patches installed by Patch Manager that haven't - // been rebooted after the patch installation. The status of these managed nodes is - // NON_COMPLIANT. + // The number of managed nodes with patches installed by Patch Manager that + // haven't been rebooted after the patch installation. The status of these managed + // nodes is NON_COMPLIANT . InstancesWithInstalledPendingRebootPatches *int32 // The number of managed nodes with patches installed that are specified in a - // RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically - // installed before they were added to a RejectedPatches list. If - // ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value - // of InstancesWithInstalledRejectedPatches will always be 0 (zero). + // RejectedPatches list. Patches with a status of INSTALLED_REJECTED were + // typically installed before they were added to a RejectedPatches list. If + // ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction , the + // value of InstancesWithInstalledRejectedPatches will always be 0 (zero). InstancesWithInstalledRejectedPatches *int32 // The number of managed nodes with missing patches from the patch baseline. @@ -80,13 +80,13 @@ type DescribePatchGroupStateOutput struct { // The number of managed nodes with patches installed that are specified as other // than Critical or Security but aren't compliant with the patch baseline. The - // status of these managed nodes is NON_COMPLIANT. + // status of these managed nodes is NON_COMPLIANT . InstancesWithOtherNonCompliantPatches *int32 // The number of managed nodes where patches that are specified as Security in a // patch advisory aren't installed. These patches might be missing, have failed // installation, were rejected, or were installed but awaiting a required managed - // node reboot. The status of these managed nodes is NON_COMPLIANT. + // node reboot. The status of these managed nodes is NON_COMPLIANT . InstancesWithSecurityNonCompliantPatches *int32 // The number of managed nodes with NotApplicable patches beyond the supported diff --git a/service/ssm/api_op_DescribePatchGroups.go b/service/ssm/api_op_DescribePatchGroups.go index f960600f422..4238c803519 100644 --- a/service/ssm/api_op_DescribePatchGroups.go +++ b/service/ssm/api_op_DescribePatchGroups.go @@ -32,12 +32,8 @@ type DescribePatchGroupsInput struct { // Each element in the array is a structure containing a key-value pair. Supported // keys for DescribePatchGroups include the following: - // - // * NAME_PREFIX Sample - // values: AWS- | My-. - // - // * OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | - // WINDOWS + // - NAME_PREFIX Sample values: AWS- | My- . + // - OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS Filters []types.PatchOrchestratorFilter // The maximum number of patch groups to return (per page). @@ -53,12 +49,9 @@ type DescribePatchGroupsInput struct { type DescribePatchGroupsOutput struct { // Each entry in the array contains: - // - // * PatchGroup: string (between 1 and 256 - // characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) - // - // * PatchBaselineIdentity: A - // PatchBaselineIdentity element. + // - PatchGroup : string (between 1 and 256 characters. Regex: + // ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) + // - PatchBaselineIdentity : A PatchBaselineIdentity element. Mappings []types.PatchGroupPatchBaselineMapping // The token to use when requesting the next set of items. If there are no @@ -131,8 +124,8 @@ func (c *Client) addOperationDescribePatchGroupsMiddlewares(stack *middleware.St return nil } -// DescribePatchGroupsAPIClient is a client that implements the DescribePatchGroups -// operation. +// DescribePatchGroupsAPIClient is a client that implements the +// DescribePatchGroups operation. type DescribePatchGroupsAPIClient interface { DescribePatchGroups(context.Context, *DescribePatchGroupsInput, ...func(*Options)) (*DescribePatchGroupsOutput, error) } diff --git a/service/ssm/api_op_DescribePatchProperties.go b/service/ssm/api_op_DescribePatchProperties.go index 9f41e715043..e6b9d5a1d6b 100644 --- a/service/ssm/api_op_DescribePatchProperties.go +++ b/service/ssm/api_op_DescribePatchProperties.go @@ -15,12 +15,12 @@ import ( // Lists the properties of available patches organized by product, product family, // classification, severity, and other properties of available patches. You can use // the reported properties in the filters you specify in requests for operations -// such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and -// DescribePatchBaselines. The following section lists the properties that can be -// used in filters for each major operating system type: AMAZON_LINUX Valid -// properties: PRODUCT | CLASSIFICATION | SEVERITY AMAZON_LINUX_2 Valid properties: -// PRODUCT | CLASSIFICATION | SEVERITY CENTOS Valid properties: PRODUCT | -// CLASSIFICATION | SEVERITY DEBIAN Valid properties: PRODUCT | PRIORITY MACOS +// such as CreatePatchBaseline , UpdatePatchBaseline , DescribeAvailablePatches , +// and DescribePatchBaselines . The following section lists the properties that can +// be used in filters for each major operating system type: AMAZON_LINUX Valid +// properties: PRODUCT | CLASSIFICATION | SEVERITY AMAZON_LINUX_2 Valid +// properties: PRODUCT | CLASSIFICATION | SEVERITY CENTOS Valid properties: PRODUCT +// | CLASSIFICATION | SEVERITY DEBIAN Valid properties: PRODUCT | PRIORITY MACOS // Valid properties: PRODUCT | CLASSIFICATION ORACLE_LINUX Valid properties: // PRODUCT | CLASSIFICATION | SEVERITY REDHAT_ENTERPRISE_LINUX Valid properties: // PRODUCT | CLASSIFICATION | SEVERITY SUSE Valid properties: PRODUCT | diff --git a/service/ssm/api_op_DisassociateOpsItemRelatedItem.go b/service/ssm/api_op_DisassociateOpsItemRelatedItem.go index 10d1cb1b5fb..76cbaae0723 100644 --- a/service/ssm/api_op_DisassociateOpsItemRelatedItem.go +++ b/service/ssm/api_op_DisassociateOpsItemRelatedItem.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the association between an OpsItem and a related item. For example, this -// API operation can delete an Incident Manager incident from an OpsItem. Incident -// Manager is a capability of Amazon Web Services Systems Manager. +// Deletes the association between an OpsItem and a related item. For example, +// this API operation can delete an Incident Manager incident from an OpsItem. +// Incident Manager is a capability of Amazon Web Services Systems Manager. func (c *Client) DisassociateOpsItemRelatedItem(ctx context.Context, params *DisassociateOpsItemRelatedItemInput, optFns ...func(*Options)) (*DisassociateOpsItemRelatedItemOutput, error) { if params == nil { params = &DisassociateOpsItemRelatedItemInput{} diff --git a/service/ssm/api_op_GetCalendarState.go b/service/ssm/api_op_GetCalendarState.go index 2fbf2a8c5aa..600933781ac 100644 --- a/service/ssm/api_op_GetCalendarState.go +++ b/service/ssm/api_op_GetCalendarState.go @@ -16,13 +16,12 @@ import ( // returns the state of the calendar at that specific time, and returns the next // time that the change calendar state will transition. If you don't specify a // time, GetCalendarState uses the current time. Change Calendar entries have two -// possible states: OPEN or CLOSED. If you specify more than one calendar in a +// possible states: OPEN or CLOSED . If you specify more than one calendar in a // request, the command returns the status of OPEN only if all calendars in the // request are open. If one or more calendars in the request are closed, the status -// returned is CLOSED. For more information about Change Calendar, a capability of +// returned is CLOSED . For more information about Change Calendar, a capability of // Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager -// Change Calendar -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) +// Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) // in the Amazon Web Services Systems Manager User Guide. func (c *Client) GetCalendarState(ctx context.Context, params *GetCalendarStateInput, optFns ...func(*Options)) (*GetCalendarStateOutput, error) { if params == nil { @@ -49,8 +48,8 @@ type GetCalendarStateInput struct { CalendarNames []string // (Optional) The specific time for which you want to get calendar state - // information, in ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) format. If you - // don't specify a value or AtTime, the current time is used. + // information, in ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) format. If + // you don't specify a value or AtTime , the current time is used. AtTime *string noSmithyDocumentSerde @@ -64,8 +63,8 @@ type GetCalendarStateOutput struct { AtTime *string // The time, as an ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) string, that - // the calendar state will change. If the current calendar state is OPEN, - // NextTransitionTime indicates when the calendar state changes to CLOSED, and + // the calendar state will change. If the current calendar state is OPEN , + // NextTransitionTime indicates when the calendar state changes to CLOSED , and // vice-versa. NextTransitionTime *string diff --git a/service/ssm/api_op_GetCommandInvocation.go b/service/ssm/api_op_GetCommandInvocation.go index e95d7b1abfa..181f71f2bbc 100644 --- a/service/ssm/api_op_GetCommandInvocation.go +++ b/service/ssm/api_op_GetCommandInvocation.go @@ -20,8 +20,8 @@ import ( // Returns detailed information about command execution for an invocation or // plugin. GetCommandInvocation only gives the execution status of a plugin in a // document. To get the command execution status on a specific managed node, use -// ListCommandInvocations. To get the command execution status across managed -// nodes, use ListCommands. +// ListCommandInvocations . To get the command execution status across managed +// nodes, use ListCommands . func (c *Client) GetCommandInvocation(ctx context.Context, params *GetCommandInvocationInput, optFns ...func(*Options)) (*GetCommandInvocationOutput, error) { if params == nil { params = &GetCommandInvocationInput{} @@ -56,7 +56,7 @@ type GetCommandInvocationInput struct { // contains only one step, you can omit the name and details for that step. If the // document contains more than one step, you must specify the name of the step for // which you want to view details. Be sure to specify the name of the step, not the - // name of a plugin like aws:RunShellScript. To find the PluginName, check the + // name of a plugin like aws:RunShellScript . To find the PluginName , check the // document content and find the name of the step you want details for. // Alternatively, use ListCommandInvocations with the CommandId and Details // parameters. The PluginName is the Name attribute of the CommandPlugin object in @@ -78,13 +78,13 @@ type GetCommandInvocationOutput struct { // The comment text for the command. Comment *string - // The name of the document that was run. For example, AWS-RunShellScript. + // The name of the document that was run. For example, AWS-RunShellScript . DocumentName *string // The Systems Manager document (SSM document) version used in the request. DocumentVersion *string - // Duration since ExecutionStartDateTime. + // Duration since ExecutionStartDateTime . ExecutionElapsedTime *string // The date and time the plugin finished running. Date and time are written in ISO @@ -111,20 +111,20 @@ type GetCommandInvocationOutput struct { // example, aws:RunShellScript is a plugin. PluginName *string - // The error level response code for the plugin script. If the response code is -1, - // then the command hasn't started running on the managed node, or it wasn't + // The error level response code for the plugin script. If the response code is -1 + // , then the command hasn't started running on the managed node, or it wasn't // received by the node. ResponseCode int32 - // The first 8,000 characters written by the plugin to stderr. If the command + // The first 8,000 characters written by the plugin to stderr . If the command // hasn't finished running, then this string is empty. StandardErrorContent *string - // The URL for the complete text written by the plugin to stderr. If the command + // The URL for the complete text written by the plugin to stderr . If the command // hasn't finished running, then this string is empty. StandardErrorUrl *string - // The first 24,000 characters written by the plugin to stdout. If the command + // The first 24,000 characters written by the plugin to stdout . If the command // hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, // then this string is empty. StandardOutputContent *string @@ -135,62 +135,46 @@ type GetCommandInvocationOutput struct { StandardOutputUrl *string // The status of this invocation plugin. This status can be different than - // StatusDetails. + // StatusDetails . Status types.CommandInvocationStatus // A detailed status of the command execution for an invocation. StatusDetails // includes more information than Status because it includes states resulting from // error and concurrency control parameters. StatusDetails can show different - // results than Status. For more information about these statuses, see - // Understanding command statuses - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) + // results than Status . For more information about these statuses, see + // Understanding command statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one // of the following values: - // - // * Pending: The command hasn't been sent to the managed - // node. - // - // * In Progress: The command has been sent to the managed node but hasn't - // reached a terminal state. - // - // * Delayed: The system attempted to send the command - // to the target, but the target wasn't available. The managed node might not be - // available because of network issues, because the node was stopped, or for - // similar reasons. The system will try to send the command again. - // - // * Success: The - // command or plugin ran successfully. This is a terminal state. - // - // * Delivery Timed - // Out: The command wasn't delivered to the managed node before the delivery - // timeout expired. Delivery timeouts don't count against the parent command's - // MaxErrors limit, but they do contribute to whether the parent command status is - // Success or Incomplete. This is a terminal state. - // - // * Execution Timed Out: The - // command started to run on the managed node, but the execution wasn't complete - // before the timeout expired. Execution timeouts count against the MaxErrors limit - // of the parent command. This is a terminal state. - // - // * Failed: The command wasn't - // run successfully on the managed node. For a plugin, this indicates that the - // result code wasn't zero. For a command invocation, this indicates that the - // result code for one or more plugins wasn't zero. Invocation failures count - // against the MaxErrors limit of the parent command. This is a terminal state. - // - // * - // Cancelled: The command was terminated before it was completed. This is a - // terminal state. - // - // * Undeliverable: The command can't be delivered to the managed - // node. The node might not exist or might not be responding. Undeliverable - // invocations don't count against the parent command's MaxErrors limit and don't - // contribute to whether the parent command status is Success or Incomplete. This - // is a terminal state. - // - // * Terminated: The parent command exceeded its MaxErrors - // limit and subsequent command invocations were canceled by the system. This is a - // terminal state. + // - Pending: The command hasn't been sent to the managed node. + // - In Progress: The command has been sent to the managed node but hasn't + // reached a terminal state. + // - Delayed: The system attempted to send the command to the target, but the + // target wasn't available. The managed node might not be available because of + // network issues, because the node was stopped, or for similar reasons. The system + // will try to send the command again. + // - Success: The command or plugin ran successfully. This is a terminal state. + // - Delivery Timed Out: The command wasn't delivered to the managed node before + // the delivery timeout expired. Delivery timeouts don't count against the parent + // command's MaxErrors limit, but they do contribute to whether the parent + // command status is Success or Incomplete. This is a terminal state. + // - Execution Timed Out: The command started to run on the managed node, but + // the execution wasn't complete before the timeout expired. Execution timeouts + // count against the MaxErrors limit of the parent command. This is a terminal + // state. + // - Failed: The command wasn't run successfully on the managed node. For a + // plugin, this indicates that the result code wasn't zero. For a command + // invocation, this indicates that the result code for one or more plugins wasn't + // zero. Invocation failures count against the MaxErrors limit of the parent + // command. This is a terminal state. + // - Cancelled: The command was terminated before it was completed. This is a + // terminal state. + // - Undeliverable: The command can't be delivered to the managed node. The node + // might not exist or might not be responding. Undeliverable invocations don't + // count against the parent command's MaxErrors limit and don't contribute to + // whether the parent command status is Success or Incomplete. This is a terminal + // state. + // - Terminated: The parent command exceeded its MaxErrors limit and subsequent + // command invocations were canceled by the system. This is a terminal state. StatusDetails *string // Metadata pertaining to the operation's result. @@ -283,9 +267,9 @@ type CommandExecutedWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, CommandExecutedWaiter will use default max delay of 120 seconds. Note - // that MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, CommandExecutedWaiter will use default max delay of 120 seconds. + // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts @@ -325,9 +309,9 @@ func NewCommandExecutedWaiter(client GetCommandInvocationAPIClient, optFns ...fu } } -// Wait calls the waiter function for CommandExecuted waiter. The maxWaitDur is the -// maximum wait duration the waiter will wait. The maxWaitDur is required and must -// be greater than zero. +// Wait calls the waiter function for CommandExecuted waiter. The maxWaitDur is +// the maximum wait duration the waiter will wait. The maxWaitDur is required and +// must be greater than zero. func (w *CommandExecutedWaiter) Wait(ctx context.Context, params *GetCommandInvocationInput, maxWaitDur time.Duration, optFns ...func(*CommandExecutedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err diff --git a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go index 36120491408..6ae594102e1 100644 --- a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go +++ b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go @@ -43,7 +43,7 @@ type GetDeployablePatchSnapshotForInstanceInput struct { // This member is required. InstanceId *string - // The snapshot ID provided by the user when running AWS-RunPatchBaseline. + // The snapshot ID provided by the user when running AWS-RunPatchBaseline . // // This member is required. SnapshotId *string @@ -59,8 +59,8 @@ type GetDeployablePatchSnapshotForInstanceOutput struct { // The managed node ID. InstanceId *string - // Returns the specific operating system (for example Windows Server 2012 or Amazon - // Linux 2015.09) on the managed node for the specified patch snapshot. + // Returns the specific operating system (for example Windows Server 2012 or + // Amazon Linux 2015.09) on the managed node for the specified patch snapshot. Product *string // A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to diff --git a/service/ssm/api_op_GetDocument.go b/service/ssm/api_op_GetDocument.go index e2e41ef0faa..6ebedaeac60 100644 --- a/service/ssm/api_op_GetDocument.go +++ b/service/ssm/api_op_GetDocument.go @@ -63,8 +63,8 @@ type GetDocumentOutput struct { // The date the SSM document was created. CreatedDate *time.Time - // The friendly name of the SSM document. This value can differ for each version of - // the document. If you want to update this value, see UpdateDocument. + // The friendly name of the SSM document. This value can differ for each version + // of the document. If you want to update this value, see UpdateDocument . DisplayName *string // The document format, either JSON or YAML. @@ -92,8 +92,8 @@ type GetDocumentOutput struct { // in review, or PENDING, at a time. ReviewStatus types.ReviewStatus - // The status of the SSM document, such as Creating, Active, Updating, Failed, and - // Deleting. + // The status of the SSM document, such as Creating , Active , Updating , Failed , + // and Deleting . Status types.DocumentStatus // A message returned by Amazon Web Services Systems Manager that explains the diff --git a/service/ssm/api_op_GetInventory.go b/service/ssm/api_op_GetInventory.go index 0f175a81d01..0aae17e1427 100644 --- a/service/ssm/api_op_GetInventory.go +++ b/service/ssm/api_op_GetInventory.go @@ -13,7 +13,7 @@ import ( ) // Query inventory information. This includes managed node status, such as Stopped -// or Terminated. +// or Terminated . func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, optFns ...func(*Options)) (*GetInventoryOutput, error) { if params == nil { params = &GetInventoryInput{} @@ -31,8 +31,8 @@ func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, op type GetInventoryInput struct { - // Returns counts of inventory types based on one or more expressions. For example, - // if you aggregate by using an expression that uses the + // Returns counts of inventory types based on one or more expressions. For + // example, if you aggregate by using an expression that uses the // AWS:InstanceInformation.PlatformType type, you can see a count of how many // Windows and Linux managed nodes exist in your inventoried fleet. Aggregators []types.InventoryAggregator diff --git a/service/ssm/api_op_GetInventorySchema.go b/service/ssm/api_op_GetInventorySchema.go index fb4e5b834be..3054f6767ab 100644 --- a/service/ssm/api_op_GetInventorySchema.go +++ b/service/ssm/api_op_GetInventorySchema.go @@ -33,7 +33,7 @@ type GetInventorySchemaInput struct { // Returns inventory schemas that support aggregation. For example, this call // returns the AWS:InstanceInformation type, because it supports aggregation based - // on the PlatformName, PlatformType, and PlatformVersion attributes. + // on the PlatformName , PlatformType , and PlatformVersion attributes. Aggregator bool // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go index 245a9dbe38d..9787af63d43 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go @@ -31,8 +31,8 @@ func (c *Client) GetMaintenanceWindowExecutionTask(ctx context.Context, params * type GetMaintenanceWindowExecutionTaskInput struct { - // The ID of the specific task execution in the maintenance window task that should - // be retrieved. + // The ID of the specific task execution in the maintenance window task that + // should be retrieved. // // This member is required. TaskId *string @@ -57,8 +57,8 @@ type GetMaintenanceWindowExecutionTaskOutput struct { // The defined maximum number of task executions that could be run in parallel. MaxConcurrency *string - // The defined maximum number of task execution errors allowed before scheduling of - // the task execution would have been stopped. + // The defined maximum number of task execution errors allowed before scheduling + // of the task execution would have been stopped. MaxErrors *string // The priority of the task. @@ -85,15 +85,12 @@ type GetMaintenanceWindowExecutionTaskOutput struct { // The parameters passed to the task when it was run. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use - // the Parameters option in the TaskInvocationParameters structure. For information - // about how Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. The map has - // the following format: - // - // * Key: string, between 1 and 255 characters - // - // * Value: an - // array of strings, each between 1 and 255 characters + // the Parameters option in the TaskInvocationParameters structure. For + // information about how Systems Manager handles these options for the supported + // maintenance window task types, see MaintenanceWindowTaskInvocationParameters . + // The map has the following format: + // - Key : string, between 1 and 255 characters + // - Value : an array of strings, each between 1 and 255 characters TaskParameters []map[string]types.MaintenanceWindowTaskParameterValueExpression // The CloudWatch alarms that were invoked by the maintenance window task. diff --git a/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go b/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go index 30fdcfd86c9..fdcc1245b7d 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecutionTaskInvocation.go @@ -74,8 +74,8 @@ type GetMaintenanceWindowExecutionTaskInvocationOutput struct { // The task status for an invocation. Status types.MaintenanceWindowExecutionStatus - // The details explaining the status. Details are only available for certain status - // values. + // The details explaining the status. Details are only available for certain + // status values. StatusDetails *string // The task execution ID. diff --git a/service/ssm/api_op_GetMaintenanceWindowTask.go b/service/ssm/api_op_GetMaintenanceWindowTask.go index 8d2057465c0..1ee798c56a9 100644 --- a/service/ssm/api_op_GetMaintenanceWindowTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowTask.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the details of a maintenance window task. For maintenance window tasks -// without a specified target, you can't supply values for --max-errors and -// --max-concurrency. Instead, the system inserts a placeholder value of 1, which +// Retrieves the details of a maintenance window task. For maintenance window +// tasks without a specified target, you can't supply values for --max-errors and +// --max-concurrency . Instead, the system inserts a placeholder value of 1 , which // may be reported in the response to this command. These values don't affect the // running of your task and can be ignored. To retrieve a list of tasks in a // maintenance window, instead use the DescribeMaintenanceWindowTasks command. @@ -64,26 +64,26 @@ type GetMaintenanceWindowTaskOutput struct { // The retrieved task description. Description *string - // The location in Amazon Simple Storage Service (Amazon S3) where the task results - // are logged. LoggingInfo has been deprecated. To specify an Amazon Simple Storage - // Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName - // and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For - // information about how Amazon Web Services Systems Manager handles these options - // for the supported maintenance window task types, see - // MaintenanceWindowTaskInvocationParameters. + // The location in Amazon Simple Storage Service (Amazon S3) where the task + // results are logged. LoggingInfo has been deprecated. To specify an Amazon + // Simple Storage Service (Amazon S3) bucket to contain logs, instead use the + // OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters + // structure. For information about how Amazon Web Services Systems Manager handles + // these options for the supported maintenance window task types, see + // MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The maximum number of targets allowed to run this task in parallel. For // maintenance window tasks without a target specified, you can't supply a value - // for this option. Instead, the system inserts a placeholder value of 1, which may - // be reported in the response to this command. This value doesn't affect the + // for this option. Instead, the system inserts a placeholder value of 1 , which + // may be reported in the response to this command. This value doesn't affect the // running of your task and can be ignored. MaxConcurrency *string // The maximum number of errors allowed before the task stops being scheduled. For // maintenance window tasks without a target specified, you can't supply a value - // for this option. Instead, the system inserts a placeholder value of 1, which may - // be reported in the response to this command. This value doesn't affect the + // for this option. Instead, the system inserts a placeholder value of 1 , which + // may be reported in the response to this command. This value doesn't affect the // running of your task and can be ignored. MaxErrors *string @@ -103,9 +103,9 @@ type GetMaintenanceWindowTaskOutput struct { Targets []types.Target // The resource that the task used during execution. For RUN_COMMAND and AUTOMATION - // task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, - // the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the - // state machine ARN. + // task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA + // tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value + // is the state machine ARN. TaskArn *string // The parameters to pass to the task when it runs. @@ -113,9 +113,9 @@ type GetMaintenanceWindowTaskOutput struct { // The parameters to pass to the task when it runs. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use - // the Parameters option in the TaskInvocationParameters structure. For information - // about how Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. + // the Parameters option in the TaskInvocationParameters structure. For + // information about how Systems Manager handles these options for the supported + // maintenance window task types, see MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // The type of task to run. diff --git a/service/ssm/api_op_GetOpsItem.go b/service/ssm/api_op_GetOpsItem.go index 387e055dcb8..bfcd355f1d3 100644 --- a/service/ssm/api_op_GetOpsItem.go +++ b/service/ssm/api_op_GetOpsItem.go @@ -13,15 +13,13 @@ import ( // Get information about an OpsItem by using the ID. You must have permission in // Identity and Access Management (IAM) to view information about an OpsItem. For -// more information, see Getting started with OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) // in the Amazon Web Services Systems Manager User Guide. Operations engineers and // IT professionals use Amazon Web Services Systems Manager OpsCenter to view, // investigate, and remediate operational issues impacting the performance and // health of their Amazon Web Services resources. For more information, see -// OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in -// the Amazon Web Services Systems Manager User Guide. +// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. func (c *Client) GetOpsItem(ctx context.Context, params *GetOpsItemInput, optFns ...func(*Options)) (*GetOpsItemOutput, error) { if params == nil { params = &GetOpsItemInput{} diff --git a/service/ssm/api_op_GetParameter.go b/service/ssm/api_op_GetParameter.go index f58354b6528..b3c0b44f03c 100644 --- a/service/ssm/api_op_GetParameter.go +++ b/service/ssm/api_op_GetParameter.go @@ -32,7 +32,8 @@ func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, op type GetParameterInput struct { // The name of the parameter you want to query. To query by parameter label, use - // "Name": "name:label". To query by parameter version, use "Name": "name:version". + // "Name": "name:label" . To query by parameter version, use "Name": "name:version" + // . // // This member is required. Name *string diff --git a/service/ssm/api_op_GetParameterHistory.go b/service/ssm/api_op_GetParameterHistory.go index b380f8bc075..4182a19ba81 100644 --- a/service/ssm/api_op_GetParameterHistory.go +++ b/service/ssm/api_op_GetParameterHistory.go @@ -131,8 +131,8 @@ func (c *Client) addOperationGetParameterHistoryMiddlewares(stack *middleware.St return nil } -// GetParameterHistoryAPIClient is a client that implements the GetParameterHistory -// operation. +// GetParameterHistoryAPIClient is a client that implements the +// GetParameterHistory operation. type GetParameterHistoryAPIClient interface { GetParameterHistory(context.Context, *GetParameterHistoryInput, ...func(*Options)) (*GetParameterHistoryOutput, error) } diff --git a/service/ssm/api_op_GetParameters.go b/service/ssm/api_op_GetParameters.go index bab227d2fce..77f51ff8cea 100644 --- a/service/ssm/api_op_GetParameters.go +++ b/service/ssm/api_op_GetParameters.go @@ -32,8 +32,8 @@ func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, type GetParametersInput struct { // Names of the parameters for which you want to query information. To query by - // parameter label, use "Name": "name:label". To query by parameter version, use - // "Name": "name:version". + // parameter label, use "Name": "name:label" . To query by parameter version, use + // "Name": "name:version" . // // This member is required. Names []string diff --git a/service/ssm/api_op_GetParametersByPath.go b/service/ssm/api_op_GetParametersByPath.go index aa0b5df87c4..78f0057d360 100644 --- a/service/ssm/api_op_GetParametersByPath.go +++ b/service/ssm/api_op_GetParametersByPath.go @@ -16,9 +16,9 @@ import ( // Request results are returned on a best-effort basis. If you specify MaxResults // in the request, the response includes information up to the limit specified. The // number of items returned, however, can be between zero and the value of -// MaxResults. If the service reaches an internal limit while processing the +// MaxResults . If the service reaches an internal limit while processing the // results, it stops the operation and returns the matching values up to that point -// and a NextToken. You can specify the NextToken in a subsequent call to get the +// and a NextToken . You can specify the NextToken in a subsequent call to get the // next set of results. func (c *Client) GetParametersByPath(ctx context.Context, params *GetParametersByPathInput, optFns ...func(*Options)) (*GetParametersByPathOutput, error) { if params == nil { @@ -37,11 +37,11 @@ func (c *Client) GetParametersByPath(ctx context.Context, params *GetParametersB type GetParametersByPathInput struct { - // The hierarchy for the parameter. Hierarchies start with a forward slash (/). The - // hierarchy is the parameter name except the last part of the parameter. For the - // API call to succeed, the last part of the parameter name can't be in the path. A - // parameter name hierarchy can have a maximum of 15 levels. Here is an example of - // a hierarchy: /Finance/Prod/IAD/WinServ2016/license33 + // The hierarchy for the parameter. Hierarchies start with a forward slash (/). + // The hierarchy is the parameter name except the last part of the parameter. For + // the API call to succeed, the last part of the parameter name can't be in the + // path. A parameter name hierarchy can have a maximum of 15 levels. Here is an + // example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33 // // This member is required. Path *string @@ -53,16 +53,18 @@ type GetParametersByPathInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string - // Filters to limit the request results. The following Key values are supported for - // GetParametersByPath: Type, KeyId, and Label. The following Key values aren't - // supported for GetParametersByPath: tag, DataType, Name, Path, and Tier. + // Filters to limit the request results. The following Key values are supported + // for GetParametersByPath : Type , KeyId , and Label . The following Key values + // aren't supported for GetParametersByPath : tag , DataType , Name , Path , and + // Tier . ParameterFilters []types.ParameterStringFilter - // Retrieve all parameters within a hierarchy. If a user has access to a path, then - // the user can access all levels of that path. For example, if a user has - // permission to access path /a, then the user can also access /a/b. Even if a user - // has explicitly been denied access in IAM for parameter /a/b, they can still call - // the GetParametersByPath API operation recursively for /a and view /a/b. + // Retrieve all parameters within a hierarchy. If a user has access to a path, + // then the user can access all levels of that path. For example, if a user has + // permission to access path /a , then the user can also access /a/b . Even if a + // user has explicitly been denied access in IAM for parameter /a/b , they can + // still call the GetParametersByPath API operation recursively for /a and view + // /a/b . Recursive *bool // Retrieve all parameters in a hierarchy with their value decrypted. @@ -149,8 +151,8 @@ func (c *Client) addOperationGetParametersByPathMiddlewares(stack *middleware.St return nil } -// GetParametersByPathAPIClient is a client that implements the GetParametersByPath -// operation. +// GetParametersByPathAPIClient is a client that implements the +// GetParametersByPath operation. type GetParametersByPathAPIClient interface { GetParametersByPath(context.Context, *GetParametersByPathInput, ...func(*Options)) (*GetParametersByPathOutput, error) } diff --git a/service/ssm/api_op_GetPatchBaseline.go b/service/ssm/api_op_GetPatchBaseline.go index 45c290bd294..ad9f76ab782 100644 --- a/service/ssm/api_op_GetPatchBaseline.go +++ b/service/ssm/api_op_GetPatchBaseline.go @@ -33,9 +33,9 @@ type GetPatchBaselineInput struct { // The ID of the patch baseline to retrieve. To retrieve information about an // Amazon Web Services managed patch baseline, specify the full Amazon Resource // Name (ARN) of the baseline. For example, for the baseline - // AWS-AmazonLinuxDefaultPatchBaseline, specify + // AWS-AmazonLinuxDefaultPatchBaseline , specify // arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of - // pb-0e392de35e7c563b7. + // pb-0e392de35e7c563b7 . // // This member is required. BaselineId *string @@ -56,8 +56,8 @@ type GetPatchBaselineOutput struct { ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the managed nodes. The default value is false. Applies - // to Linux managed nodes only. + // that should be applied to the managed nodes. The default value is false . + // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // The ID of the retrieved patch baseline. diff --git a/service/ssm/api_op_GetResourcePolicies.go b/service/ssm/api_op_GetResourcePolicies.go index dc527ef6994..8ead52bfd05 100644 --- a/service/ssm/api_op_GetResourcePolicies.go +++ b/service/ssm/api_op_GetResourcePolicies.go @@ -123,8 +123,8 @@ func (c *Client) addOperationGetResourcePoliciesMiddlewares(stack *middleware.St return nil } -// GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies -// operation. +// GetResourcePoliciesAPIClient is a client that implements the +// GetResourcePolicies operation. type GetResourcePoliciesAPIClient interface { GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error) } diff --git a/service/ssm/api_op_GetServiceSetting.go b/service/ssm/api_op_GetServiceSetting.go index 0a2d208c06a..c8d65db275e 100644 --- a/service/ssm/api_op_GetServiceSetting.go +++ b/service/ssm/api_op_GetServiceSetting.go @@ -15,11 +15,11 @@ import ( // This setting defines how a user interacts with or uses a service or a feature of // a service. For example, if an Amazon Web Services service charges money to the // account based on feature or service usage, then the Amazon Web Services service -// team might create a default setting of false. This means the user can't use this -// feature unless they change the setting to true and intentionally opt in for a -// paid feature. Services map a SettingId object to a setting value. Amazon Web -// Services services teams define the default value for a SettingId. You can't -// create a new SettingId, but you can overwrite the default value if you have the +// team might create a default setting of false . This means the user can't use +// this feature unless they change the setting to true and intentionally opt in +// for a paid feature. Services map a SettingId object to a setting value. Amazon +// Web Services services teams define the default value for a SettingId . You can't +// create a new SettingId , but you can overwrite the default value if you have the // ssm:UpdateServiceSetting permission for the setting. Use the // UpdateServiceSetting API operation to change the default setting. Or use the // ResetServiceSetting to change the value back to the original value defined by @@ -45,28 +45,14 @@ type GetServiceSettingInput struct { // The ID of the service setting to get. The setting ID can be one of the // following. - // - // * /ssm/managed-instance/default-ec2-instance-management-role - // - // * - // /ssm/automation/customer-script-log-destination - // - // * - // /ssm/automation/customer-script-log-group-name - // - // * - // /ssm/documents/console/public-sharing-permission - // - // * - // /ssm/managed-instance/activation-tier - // - // * /ssm/opsinsights/opscenter - // - // * - // /ssm/parameter-store/default-parameter-tier - // - // * - // /ssm/parameter-store/high-throughput-enabled + // - /ssm/managed-instance/default-ec2-instance-management-role + // - /ssm/automation/customer-script-log-destination + // - /ssm/automation/customer-script-log-group-name + // - /ssm/documents/console/public-sharing-permission + // - /ssm/managed-instance/activation-tier + // - /ssm/opsinsights/opscenter + // - /ssm/parameter-store/default-parameter-tier + // - /ssm/parameter-store/high-throughput-enabled // // This member is required. SettingId *string diff --git a/service/ssm/api_op_LabelParameterVersion.go b/service/ssm/api_op_LabelParameterVersion.go index 1f64e216a22..cd6c36fb360 100644 --- a/service/ssm/api_op_LabelParameterVersion.go +++ b/service/ssm/api_op_LabelParameterVersion.go @@ -15,35 +15,21 @@ import ( // automatically saves a new version and increments the version number by one. A // label can help you remember the purpose of a parameter when there are multiple // versions. Parameter labels have the following requirements and restrictions. -// -// * -// A version of a parameter can have a maximum of 10 labels. -// -// * You can't attach -// the same label to different versions of the same parameter. For example, if -// version 1 has the label Production, then you can't attach Production to version -// 2. -// -// * You can move a label from one version of a parameter to another. -// -// * You -// can't create a label when you create a new parameter. You must attach a label to -// a specific version of a parameter. -// -// * If you no longer want to use a parameter -// label, then you can either delete it or move it to a different version of a -// parameter. -// -// * A label can have a maximum of 100 characters. -// -// * Labels can -// contain letters (case sensitive), numbers, periods (.), hyphens (-), or -// underscores (_). -// -// * Labels can't begin with a number, "aws" or "ssm" (not case -// sensitive). If a label fails to meet these requirements, then the label isn't -// associated with a parameter and the system displays it in the list of -// InvalidLabels. +// - A version of a parameter can have a maximum of 10 labels. +// - You can't attach the same label to different versions of the same +// parameter. For example, if version 1 has the label Production, then you can't +// attach Production to version 2. +// - You can move a label from one version of a parameter to another. +// - You can't create a label when you create a new parameter. You must attach a +// label to a specific version of a parameter. +// - If you no longer want to use a parameter label, then you can either delete +// it or move it to a different version of a parameter. +// - A label can have a maximum of 100 characters. +// - Labels can contain letters (case sensitive), numbers, periods (.), hyphens +// (-), or underscores (_). +// - Labels can't begin with a number, " aws " or " ssm " (not case sensitive). +// If a label fails to meet these requirements, then the label isn't associated +// with a parameter and the system displays it in the list of InvalidLabels. func (c *Client) LabelParameterVersion(ctx context.Context, params *LabelParameterVersionInput, optFns ...func(*Options)) (*LabelParameterVersionOutput, error) { if params == nil { params = &LabelParameterVersionInput{} @@ -82,8 +68,7 @@ type LabelParameterVersionInput struct { type LabelParameterVersionOutput struct { // The label doesn't meet the requirements. For information about parameter label - // requirements, see Labeling parameters - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) + // requirements, see Labeling parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) // in the Amazon Web Services Systems Manager User Guide. InvalidLabels []string diff --git a/service/ssm/api_op_ListAssociations.go b/service/ssm/api_op_ListAssociations.go index 9850e70ba33..4fb470e28b5 100644 --- a/service/ssm/api_op_ListAssociations.go +++ b/service/ssm/api_op_ListAssociations.go @@ -36,8 +36,8 @@ type ListAssociationsInput struct { // One or more filters. Use a filter to return a more specific list of results. // Filtering associations using the InstanceID attribute only returns legacy // associations created using the InstanceID attribute. Associations targeting the - // managed node that are part of the Target Attributes ResourceGroup or Tags aren't - // returned. + // managed node that are part of the Target Attributes ResourceGroup or Tags + // aren't returned. AssociationFilterList []types.AssociationFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_ListCommandInvocations.go b/service/ssm/api_op_ListCommandInvocations.go index 7af019fe08c..2dfa20bef08 100644 --- a/service/ssm/api_op_ListCommandInvocations.go +++ b/service/ssm/api_op_ListCommandInvocations.go @@ -38,7 +38,7 @@ type ListCommandInvocationsInput struct { CommandId *string // (Optional) If set this returns the response of the command executions and any - // command output. The default value is false. + // command output. The default value is false . Details bool // (Optional) One or more filters. Use a filter to return a more specific list of diff --git a/service/ssm/api_op_ListCommands.go b/service/ssm/api_op_ListCommands.go index f08b453abba..78c61fdf483 100644 --- a/service/ssm/api_op_ListCommands.go +++ b/service/ssm/api_op_ListCommands.go @@ -37,9 +37,9 @@ type ListCommandsInput struct { // results. Filters []types.CommandFilter - // (Optional) Lists commands issued against this managed node ID. You can't specify - // a managed node ID in the same command that you specify Status = Pending. This is - // because the command hasn't reached the managed node yet. + // (Optional) Lists commands issued against this managed node ID. You can't + // specify a managed node ID in the same command that you specify Status = Pending + // . This is because the command hasn't reached the managed node yet. InstanceId *string // (Optional) The maximum number of items to return for this call. The call also diff --git a/service/ssm/api_op_ListComplianceItems.go b/service/ssm/api_op_ListComplianceItems.go index 52fcc76285e..e2fea203ef3 100644 --- a/service/ssm/api_op_ListComplianceItems.go +++ b/service/ssm/api_op_ListComplianceItems.go @@ -49,7 +49,7 @@ type ListComplianceItemsInput struct { ResourceIds []string // The type of resource from which to get compliance information. Currently, the - // only supported resource type is ManagedInstance. + // only supported resource type is ManagedInstance . ResourceTypes []string noSmithyDocumentSerde @@ -130,8 +130,8 @@ func (c *Client) addOperationListComplianceItemsMiddlewares(stack *middleware.St return nil } -// ListComplianceItemsAPIClient is a client that implements the ListComplianceItems -// operation. +// ListComplianceItemsAPIClient is a client that implements the +// ListComplianceItems operation. type ListComplianceItemsAPIClient interface { ListComplianceItems(context.Context, *ListComplianceItemsInput, ...func(*Options)) (*ListComplianceItemsOutput, error) } diff --git a/service/ssm/api_op_ListDocumentMetadataHistory.go b/service/ssm/api_op_ListDocumentMetadataHistory.go index 85ede1ee0ff..d6778eeb503 100644 --- a/service/ssm/api_op_ListDocumentMetadataHistory.go +++ b/service/ssm/api_op_ListDocumentMetadataHistory.go @@ -31,7 +31,7 @@ func (c *Client) ListDocumentMetadataHistory(ctx context.Context, params *ListDo type ListDocumentMetadataHistoryInput struct { // The type of data for which details are being requested. Currently, the only - // supported value is DocumentReviews. + // supported value is DocumentReviews . // // This member is required. Metadata types.DocumentMetadataEnum diff --git a/service/ssm/api_op_ListDocuments.go b/service/ssm/api_op_ListDocuments.go index 96cc3d08c4e..aefdc3c0faa 100644 --- a/service/ssm/api_op_ListDocuments.go +++ b/service/ssm/api_op_ListDocuments.go @@ -32,17 +32,17 @@ func (c *Client) ListDocuments(ctx context.Context, params *ListDocumentsInput, type ListDocumentsInput struct { - // This data type is deprecated. Instead, use Filters. + // This data type is deprecated. Instead, use Filters . DocumentFilterList []types.DocumentFilter // One or more DocumentKeyValuesFilter objects. Use a filter to return a more // specific list of results. For keys, you can specify one or more key-value pair - // tags that have been applied to a document. Other valid keys include Owner, Name, - // PlatformTypes, DocumentType, and TargetType. For example, to return documents - // you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the - // format Key=tag:tagName,Values=valueName. This API operation only supports - // filtering documents by using a single tag key and one or more tag values. For - // example: Key=tag:tagName,Values=valueName1,valueName2 + // tags that have been applied to a document. Other valid keys include Owner , Name + // , PlatformTypes , DocumentType , and TargetType . For example, to return + // documents you own use Key=Owner,Values=Self . To specify a custom key-value + // pair, use the format Key=tag:tagName,Values=valueName . This API operation only + // supports filtering documents by using a single tag key and one or more tag + // values. For example: Key=tag:tagName,Values=valueName1,valueName2 Filters []types.DocumentKeyValuesFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_ListOpsMetadata.go b/service/ssm/api_op_ListOpsMetadata.go index 83349c3076f..9dc37266603 100644 --- a/service/ssm/api_op_ListOpsMetadata.go +++ b/service/ssm/api_op_ListOpsMetadata.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Amazon Web Services Systems Manager calls this API operation when displaying all -// Application Manager OpsMetadata objects or blobs. +// Amazon Web Services Systems Manager calls this API operation when displaying +// all Application Manager OpsMetadata objects or blobs. func (c *Client) ListOpsMetadata(ctx context.Context, params *ListOpsMetadataInput, optFns ...func(*Options)) (*ListOpsMetadataOutput, error) { if params == nil { params = &ListOpsMetadataInput{} diff --git a/service/ssm/api_op_ListResourceDataSync.go b/service/ssm/api_op_ListResourceDataSync.go index 93b4a0c0f00..64467d56444 100644 --- a/service/ssm/api_op_ListResourceDataSync.go +++ b/service/ssm/api_op_ListResourceDataSync.go @@ -15,7 +15,7 @@ import ( // Lists your resource data sync configurations. Includes information about the // last time a sync attempted to start, the last sync status, and the last time a // sync successfully completed. The number of sync configurations might be too -// large to return using a single call to ListResourceDataSync. You can limit the +// large to return using a single call to ListResourceDataSync . You can limit the // number of sync configurations returned by using the MaxResults parameter. To // determine whether there are more sync configurations to list, check the value of // NextToken in the output. If there are more sync configurations to list, you can @@ -47,8 +47,8 @@ type ListResourceDataSyncInput struct { // View a list of resource data syncs according to the sync type. Specify // SyncToDestination to view resource data syncs that synchronize data to an Amazon - // S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations - // or from multiple Amazon Web Services Regions. + // S3 bucket. Specify SyncFromSource to view resource data syncs from + // Organizations or from multiple Amazon Web Services Regions. SyncType *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_ListTagsForResource.go b/service/ssm/api_op_ListTagsForResource.go index f2a96985244..f807ea25420 100644 --- a/service/ssm/api_op_ListTagsForResource.go +++ b/service/ssm/api_op_ListTagsForResource.go @@ -12,7 +12,7 @@ import ( ) // Returns a list of the tags assigned to the specified resource. For information -// about the ID format for each supported resource type, see AddTagsToResource. +// about the ID format for each supported resource type, see AddTagsToResource . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/ssm/api_op_ModifyDocumentPermission.go b/service/ssm/api_op_ModifyDocumentPermission.go index e6bf5c5ce46..40c0ee48325 100644 --- a/service/ssm/api_op_ModifyDocumentPermission.go +++ b/service/ssm/api_op_ModifyDocumentPermission.go @@ -46,10 +46,10 @@ type ModifyDocumentPermissionInput struct { // account IDs can either be a group of account IDs or All. AccountIdsToAdd []string - // The Amazon Web Services users that should no longer have access to the document. - // The Amazon Web Services user can either be a group of account IDs or All. This - // action has a higher priority than AccountIdsToAdd. If you specify an ID to add - // and the same ID to remove, the system removes access to the document. + // The Amazon Web Services users that should no longer have access to the + // document. The Amazon Web Services user can either be a group of account IDs or + // All. This action has a higher priority than AccountIdsToAdd. If you specify an + // ID to add and the same ID to remove, the system removes access to the document. AccountIdsToRemove []string // (Optional) The version of the document to share. If it isn't specified, the diff --git a/service/ssm/api_op_PutComplianceItems.go b/service/ssm/api_op_PutComplianceItems.go index 538ee5c27fc..84e76f2944d 100644 --- a/service/ssm/api_op_PutComplianceItems.go +++ b/service/ssm/api_op_PutComplianceItems.go @@ -16,51 +16,26 @@ import ( // resource. This call overwrites existing compliance information on the resource, // so you must provide a full list of compliance items each time that you send the // request. ComplianceType can be one of the following: -// -// * ExecutionId: The -// execution ID when the patch, association, or custom compliance item was -// applied. -// -// * ExecutionType: Specify patch, association, or Custom:string. -// -// * -// ExecutionTime. The time the patch, association, or custom compliance item was -// applied to the managed node. -// -// * Id: The patch, association, or custom compliance -// ID. -// -// * Title: A title. -// -// * Status: The status of the compliance item. For -// example, approved for patches, or Failed for associations. -// -// * Severity: A patch -// severity. For example, Critical. -// -// * DocumentName: An SSM document name. For -// example, AWS-RunPatchBaseline. -// -// * DocumentVersion: An SSM document version -// number. For example, 4. -// -// * Classification: A patch classification. For example, -// security updates. -// -// * PatchBaselineId: A patch baseline ID. -// -// * PatchSeverity: A -// patch severity. For example, Critical. -// -// * PatchState: A patch state. For -// example, InstancesWithFailedPatches. -// -// * PatchGroup: The name of a patch -// group. -// -// * InstalledTime: The time the association, patch, or custom compliance -// item was applied to the resource. Specify the time by using the following -// format: yyyy-MM-dd'T'HH:mm:ss'Z' +// - ExecutionId: The execution ID when the patch, association, or custom +// compliance item was applied. +// - ExecutionType: Specify patch, association, or Custom: string . +// - ExecutionTime. The time the patch, association, or custom compliance item +// was applied to the managed node. +// - Id: The patch, association, or custom compliance ID. +// - Title: A title. +// - Status: The status of the compliance item. For example, approved for +// patches, or Failed for associations. +// - Severity: A patch severity. For example, Critical . +// - DocumentName: An SSM document name. For example, AWS-RunPatchBaseline . +// - DocumentVersion: An SSM document version number. For example, 4. +// - Classification: A patch classification. For example, security updates . +// - PatchBaselineId: A patch baseline ID. +// - PatchSeverity: A patch severity. For example, Critical . +// - PatchState: A patch state. For example, InstancesWithFailedPatches . +// - PatchGroup: The name of a patch group. +// - InstalledTime: The time the association, patch, or custom compliance item +// was applied to the resource. Specify the time by using the following format: +// yyyy-MM-dd'T'HH:mm:ss'Z' func (c *Client) PutComplianceItems(ctx context.Context, params *PutComplianceItemsInput, optFns ...func(*Options)) (*PutComplianceItemsOutput, error) { if params == nil { params = &PutComplianceItemsInput{} @@ -79,21 +54,21 @@ func (c *Client) PutComplianceItems(ctx context.Context, params *PutComplianceIt type PutComplianceItemsInput struct { // Specify the compliance type. For example, specify Association (for a State - // Manager association), Patch, or Custom:string. + // Manager association), Patch, or Custom: string . // // This member is required. ComplianceType *string // A summary of the call execution that includes an execution ID, the type of - // execution (for example, Command), and the date/time of the execution using a + // execution (for example, Command ), and the date/time of the execution using a // datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. // // This member is required. ExecutionSummary *types.ComplianceExecutionSummary // Information about the compliance as defined by the resource type. For example, - // for a patch compliance type, Items includes information about the PatchSeverity, - // Classification, and so on. + // for a patch compliance type, Items includes information about the + // PatchSeverity, Classification, and so on. // // This member is required. Items []types.ComplianceItemEntry @@ -114,13 +89,13 @@ type PutComplianceItemsInput struct { // request to put compliance information is ignored. ItemContentHash *string - // The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In - // COMPLETE mode, the system overwrites all existing compliance information for the - // resource. You must provide a full list of compliance items each time you send - // the request. In PARTIAL mode, the system overwrites compliance information for a - // specific association. The association must be configured with SyncCompliance set - // to MANUAL. By default, all requests use COMPLETE mode. This attribute is only - // valid for association compliance. + // The mode for uploading compliance items. You can specify COMPLETE or PARTIAL . + // In COMPLETE mode, the system overwrites all existing compliance information for + // the resource. You must provide a full list of compliance items each time you + // send the request. In PARTIAL mode, the system overwrites compliance information + // for a specific association. The association must be configured with + // SyncCompliance set to MANUAL . By default, all requests use COMPLETE mode. This + // attribute is only valid for association compliance. UploadType types.ComplianceUploadType noSmithyDocumentSerde diff --git a/service/ssm/api_op_PutParameter.go b/service/ssm/api_op_PutParameter.go index 0ae5addc252..33e3e7c5238 100644 --- a/service/ssm/api_op_PutParameter.go +++ b/service/ssm/api_op_PutParameter.go @@ -34,42 +34,30 @@ type PutParameterInput struct { // and name. For parameters in a hierarchy, you must include a leading forward // slash character (/) when you create or reference a parameter. For example: // /Dev/DBServer/MySQL/db-string13 Naming Constraints: - // - // * Parameter names are case - // sensitive. - // - // * A parameter name must be unique within an Amazon Web Services - // Region - // - // * A parameter name can't be prefixed with "aws" or "ssm" - // (case-insensitive). - // - // * Parameter names can include only the following symbols - // and letters: a-zA-Z0-9_.- In addition, the slash character ( / ) is used to - // delineate hierarchies in parameter names. For example: - // /Dev/Production/East/Project-ABC/MyParameter - // - // * A parameter name can't include - // spaces. - // - // * Parameter hierarchies are limited to a maximum depth of fifteen - // levels. - // - // For additional information about valid values for parameter names, see - // Creating Systems Manager parameters - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html) + // - Parameter names are case sensitive. + // - A parameter name must be unique within an Amazon Web Services Region + // - A parameter name can't be prefixed with " aws " or " ssm " + // (case-insensitive). + // - Parameter names can include only the following symbols and letters: + // a-zA-Z0-9_.- In addition, the slash character ( / ) is used to delineate + // hierarchies in parameter names. For example: + // /Dev/Production/East/Project-ABC/MyParameter + // - A parameter name can't include spaces. + // - Parameter hierarchies are limited to a maximum depth of fifteen levels. + // For additional information about valid values for parameter names, see Creating + // Systems Manager parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html) // in the Amazon Web Services Systems Manager User Guide. The maximum length // constraint of 2048 characters listed below includes 1037 characters reserved for // internal use by Systems Manager. The maximum length for a parameter name that // you create is 1011 characters. This includes the characters in the ARN that // precede the name you specify, such as - // arn:aws:ssm:us-east-2:111122223333:parameter/. + // arn:aws:ssm:us-east-2:111122223333:parameter/ . // // This member is required. Name *string - // The parameter value that you want to add to the system. Standard parameters have - // a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. + // The parameter value that you want to add to the system. Standard parameters + // have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. // Parameters can't be referenced or nested in the values of other parameters. You // can't include {{}} or {{ssm:parameter-name}} in a parameter value. // @@ -84,86 +72,74 @@ type PutParameterInput struct { // The data type for a String parameter. Supported data types include plain text // and Amazon Machine Image (AMI) IDs. The following data type values are // supported. - // - // * text - // - // * aws:ec2:image - // - // * aws:ssm:integration - // - // When you create a - // String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager - // validates the parameter value is in the required format, such as - // ami-12345abcdeEXAMPLE, and that the specified AMI is available in your Amazon - // Web Services account. If the action is successful, the service sends back an - // HTTP 200 response which indicates a successful PutParameter call for all cases - // except for data type aws:ec2:image. If you call PutParameter with aws:ec2:image - // data type, a successful HTTP 200 response does not guarantee that your parameter - // was successfully created or updated. The aws:ec2:image value is validated - // asynchronously, and the PutParameter call returns before the validation is - // complete. If you submit an invalid AMI value, the PutParameter operation will - // return success, but the asynchronous validation will fail and the parameter will - // not be created or updated. To monitor whether your aws:ec2:image parameters are - // created successfully, see Setting up notifications or trigger actions based on - // Parameter Store events - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html). - // For more information about AMI format validation , see Native parameter support - // for Amazon Machine Image (AMI) IDs - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html). + // - text + // - aws:ec2:image + // - aws:ssm:integration + // When you create a String parameter and specify aws:ec2:image , Amazon Web + // Services Systems Manager validates the parameter value is in the required + // format, such as ami-12345abcdeEXAMPLE , and that the specified AMI is available + // in your Amazon Web Services account. If the action is successful, the service + // sends back an HTTP 200 response which indicates a successful PutParameter call + // for all cases except for data type aws:ec2:image . If you call PutParameter + // with aws:ec2:image data type, a successful HTTP 200 response does not guarantee + // that your parameter was successfully created or updated. The aws:ec2:image + // value is validated asynchronously, and the PutParameter call returns before the + // validation is complete. If you submit an invalid AMI value, the PutParameter + // operation will return success, but the asynchronous validation will fail and the + // parameter will not be created or updated. To monitor whether your aws:ec2:image + // parameters are created successfully, see Setting up notifications or trigger + // actions based on Parameter Store events (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html) + // . For more information about AMI format validation , see Native parameter + // support for Amazon Machine Image (AMI) IDs (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html) + // . DataType *string - // Information about the parameter that you want to add to the system. Optional but - // recommended. Don't enter personally identifiable information in this field. + // Information about the parameter that you want to add to the system. Optional + // but recommended. Don't enter personally identifiable information in this field. Description *string - // The Key Management Service (KMS) ID that you want to use to encrypt a parameter. - // Use a custom key for better security. Required for parameters that use the - // SecureString data type. If you don't specify a key ID, the system uses the - // default key associated with your Amazon Web Services account which is not as + // The Key Management Service (KMS) ID that you want to use to encrypt a + // parameter. Use a custom key for better security. Required for parameters that + // use the SecureString data type. If you don't specify a key ID, the system uses + // the default key associated with your Amazon Web Services account which is not as // secure as using a custom key. - // - // * To use a custom KMS key, choose the - // SecureString data type with the Key ID parameter. + // - To use a custom KMS key, choose the SecureString data type with the Key ID + // parameter. KeyId *string - // Overwrite an existing parameter. The default value is false. + // Overwrite an existing parameter. The default value is false . Overwrite *bool - // One or more policies to apply to a parameter. This operation takes a JSON array. - // Parameter Store, a capability of Amazon Web Services Systems Manager supports - // the following policy types: Expiration: This policy deletes the parameter after - // it expires. When you create the policy, you specify the expiration date. You can - // update the expiration date and time by updating the policy. Updating the - // parameter doesn't affect the expiration date and time. When the expiration time - // is reached, Parameter Store deletes the parameter. ExpirationNotification: This - // policy initiates an event in Amazon CloudWatch Events that notifies you about - // the expiration. By using this policy, you can receive notification before or - // after the expiration time is reached, in units of days or hours. - // NoChangeNotification: This policy initiates a CloudWatch Events event if a - // parameter hasn't been modified for a specified period of time. This policy type - // is useful when, for example, a secret needs to be changed within a period of - // time, but it hasn't been changed. All existing policies are preserved until you - // send new policies or an empty policy. For more information about parameter - // policies, see Assigning parameter policies - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html). + // One or more policies to apply to a parameter. This operation takes a JSON + // array. Parameter Store, a capability of Amazon Web Services Systems Manager + // supports the following policy types: Expiration: This policy deletes the + // parameter after it expires. When you create the policy, you specify the + // expiration date. You can update the expiration date and time by updating the + // policy. Updating the parameter doesn't affect the expiration date and time. When + // the expiration time is reached, Parameter Store deletes the parameter. + // ExpirationNotification: This policy initiates an event in Amazon CloudWatch + // Events that notifies you about the expiration. By using this policy, you can + // receive notification before or after the expiration time is reached, in units of + // days or hours. NoChangeNotification: This policy initiates a CloudWatch Events + // event if a parameter hasn't been modified for a specified period of time. This + // policy type is useful when, for example, a secret needs to be changed within a + // period of time, but it hasn't been changed. All existing policies are preserved + // until you send new policies or an empty policy. For more information about + // parameter policies, see Assigning parameter policies (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) + // . Policies *string - // Optional metadata that you assign to a resource. Tags enable you to categorize a - // resource in different ways, such as by purpose, owner, or environment. For + // Optional metadata that you assign to a resource. Tags enable you to categorize + // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag a Systems Manager parameter to identify the type // of resource to which it applies, the environment, or the type of configuration // data referenced by the parameter. In this case, you could specify the following // key-value pairs: - // - // * Key=Resource,Value=S3bucket - // - // * Key=OS,Value=Windows - // - // * - // Key=ParameterType,Value=LicenseKey - // - // To add tags to an existing Systems Manager - // parameter, use the AddTagsToResource operation. + // - Key=Resource,Value=S3bucket + // - Key=OS,Value=Windows + // - Key=ParameterType,Value=LicenseKey + // To add tags to an existing Systems Manager parameter, use the AddTagsToResource + // operation. Tags []types.Tag // The parameter tier to assign to a parameter. Parameter Store offers a standard @@ -174,8 +150,7 @@ type PutParameterInput struct { // Advanced parameters have a content size limit of 8 KB and can be configured to // use parameter policies. You can create a maximum of 100,000 advanced parameters // for each Region in an Amazon Web Services account. Advanced parameters incur a - // charge. For more information, see Standard and advanced parameter tiers - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) + // charge. For more information, see Standard and advanced parameter tiers (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) // in the Amazon Web Services Systems Manager User Guide. You can change a standard // parameter to an advanced parameter any time. But you can't revert an advanced // parameter to a standard parameter. Reverting an advanced parameter to a standard @@ -185,42 +160,31 @@ type PutParameterInput struct { // encryption than standard parameters. If you no longer need an advanced // parameter, or if you no longer want to incur charges for an advanced parameter, // you must delete it and recreate it as a new standard parameter. Using the - // Default Tier Configuration In PutParameter requests, you can specify the tier to - // create the parameter in. Whenever you specify a tier in the request, Parameter - // Store creates or updates the parameter according to that request. However, if - // you don't specify a tier in a request, Parameter Store assigns the tier based on - // the current Parameter Store default tier configuration. The default tier when - // you begin using Parameter Store is the standard-parameter tier. If you use the - // advanced-parameter tier, you can specify one of the following as the default: - // - // * - // Advanced: With this option, Parameter Store evaluates all requests as advanced - // parameters. - // - // * Intelligent-Tiering: With this option, Parameter Store evaluates - // each request to determine if the parameter is standard or advanced. If the - // request doesn't include any options that require an advanced parameter, the - // parameter is created in the standard-parameter tier. If one or more options - // requiring an advanced parameter are included in the request, Parameter Store - // create a parameter in the advanced-parameter tier. This approach helps control - // your parameter-related costs by always creating standard parameters unless an - // advanced parameter is necessary. - // - // Options that require an advanced parameter - // include the following: - // - // * The content size of the parameter is more than 4 - // KB. - // - // * The parameter uses a parameter policy. - // - // * More than 10,000 parameters - // already exist in your Amazon Web Services account in the current Amazon Web - // Services Region. - // - // For more information about configuring the default tier - // option, see Specifying a default parameter tier - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html) + // Default Tier Configuration In PutParameter requests, you can specify the tier + // to create the parameter in. Whenever you specify a tier in the request, + // Parameter Store creates or updates the parameter according to that request. + // However, if you don't specify a tier in a request, Parameter Store assigns the + // tier based on the current Parameter Store default tier configuration. The + // default tier when you begin using Parameter Store is the standard-parameter + // tier. If you use the advanced-parameter tier, you can specify one of the + // following as the default: + // - Advanced: With this option, Parameter Store evaluates all requests as + // advanced parameters. + // - Intelligent-Tiering: With this option, Parameter Store evaluates each + // request to determine if the parameter is standard or advanced. If the request + // doesn't include any options that require an advanced parameter, the parameter is + // created in the standard-parameter tier. If one or more options requiring an + // advanced parameter are included in the request, Parameter Store create a + // parameter in the advanced-parameter tier. This approach helps control your + // parameter-related costs by always creating standard parameters unless an + // advanced parameter is necessary. + // Options that require an advanced parameter include the following: + // - The content size of the parameter is more than 4 KB. + // - The parameter uses a parameter policy. + // - More than 10,000 parameters already exist in your Amazon Web Services + // account in the current Amazon Web Services Region. + // For more information about configuring the default tier option, see Specifying + // a default parameter tier (https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html) // in the Amazon Web Services Systems Manager User Guide. Tier types.ParameterTier @@ -228,9 +192,9 @@ type PutParameterInput struct { // currently supported for CloudFormation templates. Items in a StringList must be // separated by a comma (,). You can't use other punctuation or special character // to escape items in the list. If you have a parameter value that requires a - // comma, then use the String data type. Specifying a parameter type isn't required - // when updating a parameter. You must specify a parameter type when creating a - // parameter. + // comma, then use the String data type. Specifying a parameter type isn't + // required when updating a parameter. You must specify a parameter type when + // creating a parameter. Type types.ParameterType noSmithyDocumentSerde diff --git a/service/ssm/api_op_PutResourcePolicy.go b/service/ssm/api_op_PutResourcePolicy.go index 894a0fa01aa..21e7ba513f1 100644 --- a/service/ssm/api_op_PutResourcePolicy.go +++ b/service/ssm/api_op_PutResourcePolicy.go @@ -59,7 +59,7 @@ type PutResourcePolicyOutput struct { // ID of the current policy version. PolicyHash *string - // The policy ID. To update a policy, you must specify PolicyId and PolicyHash. + // The policy ID. To update a policy, you must specify PolicyId and PolicyHash . PolicyId *string // Metadata pertaining to the operation's result. diff --git a/service/ssm/api_op_RegisterDefaultPatchBaseline.go b/service/ssm/api_op_RegisterDefaultPatchBaseline.go index 60d799cd747..5791ad7cc86 100644 --- a/service/ssm/api_op_RegisterDefaultPatchBaseline.go +++ b/service/ssm/api_op_RegisterDefaultPatchBaseline.go @@ -15,7 +15,7 @@ import ( // full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For // example, for CentOS, specify // arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of -// pb-0574b43a65ea646ed. +// pb-0574b43a65ea646ed . func (c *Client) RegisterDefaultPatchBaseline(ctx context.Context, params *RegisterDefaultPatchBaselineInput, optFns ...func(*Options)) (*RegisterDefaultPatchBaselineOutput, error) { if params == nil { params = &RegisterDefaultPatchBaselineInput{} diff --git a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go index 2c0c72dac85..b749eb9e882 100644 --- a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go @@ -35,8 +35,8 @@ type RegisterTargetWithMaintenanceWindowInput struct { // This member is required. ResourceType types.MaintenanceWindowResourceType - // The targets to register with the maintenance window. In other words, the managed - // nodes to run commands on when the maintenance window runs. If a single + // The targets to register with the maintenance window. In other words, the + // managed nodes to run commands on when the maintenance window runs. If a single // maintenance window task is registered with multiple targets, its task // invocations occur sequentially and not in parallel. If your task must run on // multiple targets at the same time, register a task for each target individually @@ -45,14 +45,13 @@ type RegisterTargetWithMaintenanceWindowInput struct { // managed nodes. Example 1: Specify managed node IDs Key=InstanceIds,Values=,, // Example 2: Use tag key-pairs applied to managed nodes Key=tag:,Values=, Example // 3: Use tag-keys applied to managed nodes Key=tag-key,Values=, Example 4: Use - // resource group names Key=resource-groups:Name,Values= Example 5: Use filters for - // resource group types Key=resource-groups:ResourceTypeFilters,Values=, For - // Key=resource-groups:ResourceTypeFilters, specify resource types in the following - // format + // resource group names Key=resource-groups:Name,Values= Example 5: Use filters + // for resource group types Key=resource-groups:ResourceTypeFilters,Values=, For + // Key=resource-groups:ResourceTypeFilters , specify resource types in the + // following format // Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC // For more information about these examples formats, including the best use case - // for each one, see Examples: Register targets with a maintenance window - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) + // for each one, see Examples: Register targets with a maintenance window (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. @@ -72,8 +71,8 @@ type RegisterTargetWithMaintenanceWindowInput struct { // An optional name for the target. Name *string - // User-provided value that will be included in any Amazon CloudWatch Events events - // raised while running tasks for these targets in this maintenance window. + // User-provided value that will be included in any Amazon CloudWatch Events + // events raised while running tasks for these targets in this maintenance window. OwnerInformation *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go index 29f716b913c..5dc04ea6f1a 100644 --- a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go @@ -53,24 +53,17 @@ type RegisterTaskWithMaintenanceWindowInput struct { // Indicates whether tasks should continue to run after the cutoff time specified // in the maintenance windows is reached. - // - // * CONTINUE_TASK: When the cutoff time is - // reached, any tasks that are running continue. The default value. - // - // * - // CANCEL_TASK: - // - // * For Automation, Lambda, Step Functions tasks: When the cutoff - // time is reached, any task invocations that are already running continue, but no - // new task invocations are started. - // - // * For Run Command tasks: When the cutoff time - // is reached, the system sends a CancelCommand operation that attempts to cancel - // the command associated with the task. However, there is no guarantee that the - // command will be terminated and the underlying process stopped. - // - // The status for - // tasks that are not completed is TIMED_OUT. + // - CONTINUE_TASK : When the cutoff time is reached, any tasks that are running + // continue. The default value. + // - CANCEL_TASK : + // - For Automation, Lambda, Step Functions tasks: When the cutoff time is + // reached, any task invocations that are already running continue, but no new task + // invocations are started. + // - For Run Command tasks: When the cutoff time is reached, the system sends a + // CancelCommand operation that attempts to cancel the command associated with + // the task. However, there is no guarantee that the command will be terminated and + // the underlying process stopped. The status for tasks that are not completed + // is TIMED_OUT . CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // An optional description for the task. @@ -82,26 +75,24 @@ type RegisterTaskWithMaintenanceWindowInput struct { // contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options // in the TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. + // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The maximum number of targets this task can be run for, in parallel. Although // this element is listed as "Required: No", a value can be omitted only when you - // are registering or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxConcurrency *string // The maximum number of errors allowed before this task stops being scheduled. // Although this element is listed as "Required: No", a value can be omitted only - // when you are registering or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // when you are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxErrors *string @@ -117,17 +108,12 @@ type RegisterTaskWithMaintenanceWindowInput struct { // Systems Manager to assume when running a maintenance window task. If you do not // specify a service role ARN, Systems Manager uses your account's service-linked // role. If no service-linked role for Systems Manager exists in your account, it - // is created when you run RegisterTaskWithMaintenanceWindow. For more information, - // see the following topics in the in the Amazon Web Services Systems Manager User - // Guide: - // - // * Using service-linked roles for Systems Manager - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) - // - // * - // Should I use a service-linked role or a custom service role to run maintenance - // window tasks? - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) + // is created when you run RegisterTaskWithMaintenanceWindow . For more + // information, see the following topics in the in the Amazon Web Services Systems + // Manager User Guide: + // - Using service-linked roles for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) + // - Should I use a service-linked role or a custom service role to run + // maintenance window tasks? (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string // The targets (either managed nodes or maintenance window targets). One or more @@ -135,8 +121,7 @@ type RegisterTaskWithMaintenanceWindowInput struct { // Depending on the task, targets are optional for other maintenance window task // types (Automation, Lambda, and Step Functions). For more information about // running tasks that don't specify targets, see Registering maintenance window - // tasks without targets - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. Specify managed nodes // using the following format: Key=InstanceIds,Values=, Specify maintenance window // targets using the following format: Key=WindowTargetIds,Values=, @@ -148,9 +133,10 @@ type RegisterTaskWithMaintenanceWindowInput struct { // The parameters that should be passed to the task when it is run. TaskParameters // has been deprecated. To specify parameters to pass to a task when it runs, - // instead use the Parameters option in the TaskInvocationParameters structure. For - // information about how Systems Manager handles these options for the supported - // maintenance window task types, see MaintenanceWindowTaskInvocationParameters. + // instead use the Parameters option in the TaskInvocationParameters structure. + // For information about how Systems Manager handles these options for the + // supported maintenance window task types, see + // MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression noSmithyDocumentSerde diff --git a/service/ssm/api_op_RemoveTagsFromResource.go b/service/ssm/api_op_RemoveTagsFromResource.go index 614b9e8f0c9..72904bffb77 100644 --- a/service/ssm/api_op_RemoveTagsFromResource.go +++ b/service/ssm/api_op_RemoveTagsFromResource.go @@ -30,14 +30,14 @@ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsF type RemoveTagsFromResourceInput struct { // The ID of the resource from which you want to remove tags. For example: - // ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde Automation: + // ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde Automation : // example-c160-4567-8519-012345abcde PatchBaseline: pb-012345abcde OpsMetadata // object: ResourceID for tagging is created from the Amazon Resource Name (ARN) // for the object. Specifically, ResourceID is created from the strings that come // after the word opsmetadata in the ARN. For example, an OpsMetadata object with // an ARN of // arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a - // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager. + // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager . // For the Document and Parameter values, use the name of the resource. The // ManagedInstance type for this API operation is only for on-premises managed // nodes. Specify the name of the managed node in the following format: @@ -49,7 +49,7 @@ type RemoveTagsFromResourceInput struct { // The type of resource from which you want to remove a tag. The ManagedInstance // type for this API operation is only for on-premises managed nodes. Specify the // name of the managed node in the following format: mi-ID_number . For example, - // mi-1a2b3c4d5e6f. + // mi-1a2b3c4d5e6f . // // This member is required. ResourceType types.ResourceTypeForTagging diff --git a/service/ssm/api_op_ResetServiceSetting.go b/service/ssm/api_op_ResetServiceSetting.go index 361f32d2d09..eb17d9823b9 100644 --- a/service/ssm/api_op_ResetServiceSetting.go +++ b/service/ssm/api_op_ResetServiceSetting.go @@ -18,8 +18,8 @@ import ( // team might create a default setting of "false". This means the user can't use // this feature unless they change the setting to "true" and intentionally opt in // for a paid feature. Services map a SettingId object to a setting value. Amazon -// Web Services services teams define the default value for a SettingId. You can't -// create a new SettingId, but you can overwrite the default value if you have the +// Web Services services teams define the default value for a SettingId . You can't +// create a new SettingId , but you can overwrite the default value if you have the // ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting // API operation to view the current value. Use the UpdateServiceSetting API // operation to change the default setting. Reset the service setting for the @@ -45,29 +45,14 @@ type ResetServiceSettingInput struct { // The Amazon Resource Name (ARN) of the service setting to reset. The setting ID // can be one of the following. - // - // * - // /ssm/managed-instance/default-ec2-instance-management-role - // - // * - // /ssm/automation/customer-script-log-destination - // - // * - // /ssm/automation/customer-script-log-group-name - // - // * - // /ssm/documents/console/public-sharing-permission - // - // * - // /ssm/managed-instance/activation-tier - // - // * /ssm/opsinsights/opscenter - // - // * - // /ssm/parameter-store/default-parameter-tier - // - // * - // /ssm/parameter-store/high-throughput-enabled + // - /ssm/managed-instance/default-ec2-instance-management-role + // - /ssm/automation/customer-script-log-destination + // - /ssm/automation/customer-script-log-group-name + // - /ssm/documents/console/public-sharing-permission + // - /ssm/managed-instance/activation-tier + // - /ssm/opsinsights/opscenter + // - /ssm/parameter-store/default-parameter-tier + // - /ssm/parameter-store/high-throughput-enabled // // This member is required. SettingId *string @@ -78,8 +63,8 @@ type ResetServiceSettingInput struct { // The result body of the ResetServiceSetting API operation. type ResetServiceSettingOutput struct { - // The current, effective service setting after calling the ResetServiceSetting API - // operation. + // The current, effective service setting after calling the ResetServiceSetting + // API operation. ServiceSetting *types.ServiceSetting // Metadata pertaining to the operation's result. diff --git a/service/ssm/api_op_ResumeSession.go b/service/ssm/api_op_ResumeSession.go index 3cc45eb83bb..eaf01a9a266 100644 --- a/service/ssm/api_op_ResumeSession.go +++ b/service/ssm/api_op_ResumeSession.go @@ -45,16 +45,15 @@ type ResumeSessionOutput struct { // The ID of the session. SessionId *string - // A URL back to SSM Agent on the managed node that the Session Manager client uses - // to send commands and receive output from the managed node. Format: - // wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output). - // region represents the Region identifier for an Amazon Web Services Region + // A URL back to SSM Agent on the managed node that the Session Manager client + // uses to send commands and receive output from the managed node. Format: + // wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) + // . region represents the Region identifier for an Amazon Web Services Region // supported by Amazon Web Services Systems Manager, such as us-east-2 for the US // East (Ohio) Region. For a list of supported region values, see the Region column - // in Systems Manager service endpoints - // (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in the - // Amazon Web Services General Reference. session-id represents the ID of a Session - // Manager session, such as 1a2b3c4dEXAMPLE. + // in Systems Manager service endpoints (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) + // in the Amazon Web Services General Reference. session-id represents the ID of a + // Session Manager session, such as 1a2b3c4dEXAMPLE . StreamUrl *string // An encrypted token value containing session and caller information. Used to diff --git a/service/ssm/api_op_SendAutomationSignal.go b/service/ssm/api_op_SendAutomationSignal.go index 97309c1ff8a..9044f681e23 100644 --- a/service/ssm/api_op_SendAutomationSignal.go +++ b/service/ssm/api_op_SendAutomationSignal.go @@ -30,8 +30,8 @@ func (c *Client) SendAutomationSignal(ctx context.Context, params *SendAutomatio type SendAutomationSignalInput struct { - // The unique identifier for an existing Automation execution that you want to send - // the signal to. + // The unique identifier for an existing Automation execution that you want to + // send the signal to. // // This member is required. AutomationExecutionId *string diff --git a/service/ssm/api_op_SendCommand.go b/service/ssm/api_op_SendCommand.go index 1e5fbbec396..dd42b98f446 100644 --- a/service/ssm/api_op_SendCommand.go +++ b/service/ssm/api_op_SendCommand.go @@ -33,8 +33,7 @@ type SendCommandInput struct { // run. This can be a public document or a custom document. To run a shared // document belonging to another account, specify the document Amazon Resource Name // (ARN). For more information about how to use shared documents, see Using shared - // SSM documents - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) + // SSM documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) // in the Amazon Web Services Systems Manager User Guide. If you specify a document // name or ARN that hasn't been shared with your account, you receive an // InvalidDocument error. @@ -45,9 +44,9 @@ type SendCommandInput struct { // The CloudWatch alarm you want to apply to your command. AlarmConfiguration *types.AlarmConfiguration - // Enables Amazon Web Services Systems Manager to send Run Command output to Amazon - // CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems - // Manager. + // Enables Amazon Web Services Systems Manager to send Run Command output to + // Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services + // Systems Manager. CloudWatchOutputConfig *types.CloudWatchOutputConfig // User-specified information about the command, such as a brief description of @@ -73,28 +72,25 @@ type SendCommandInput struct { // node IDs is most useful when you are targeting a limited number of managed // nodes, though you can specify up to 50 IDs. To target a larger number of managed // nodes, or if you prefer not to list individual node IDs, we recommend using the - // Targets option instead. Using Targets, which accepts tag key-value pairs to + // Targets option instead. Using Targets , which accepts tag key-value pairs to // identify the managed nodes to send commands to, you can a send command to tens, // hundreds, or thousands of nodes at once. For more information about how to use - // targets, see Using targets and rate controls to send commands to a fleet - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) + // targets, see Using targets and rate controls to send commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) // in the Amazon Web Services Systems Manager User Guide. InstanceIds []string // (Optional) The maximum number of managed nodes that are allowed to run the // command at the same time. You can specify a number such as 10 or a percentage - // such as 10%. The default value is 50. For more information about how to use - // MaxConcurrency, see Using concurrency controls - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) + // such as 10%. The default value is 50 . For more information about how to use + // MaxConcurrency , see Using concurrency controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) // in the Amazon Web Services Systems Manager User Guide. MaxConcurrency *string // The maximum number of errors allowed without the command failing. When the - // command fails one more time beyond the value of MaxErrors, the systems stops + // command fails one more time beyond the value of MaxErrors , the systems stops // sending the command to additional targets. You can specify a number like 10 or a - // percentage like 10%. The default value is 0. For more information about how to - // use MaxErrors, see Using error controls - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) + // percentage like 10%. The default value is 0 . For more information about how to + // use MaxErrors , see Using error controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) // in the Amazon Web Services Systems Manager User Guide. MaxErrors *string @@ -120,24 +116,22 @@ type SendCommandInput struct { // publish Amazon Simple Notification Service (Amazon SNS) notifications for Run // Command commands. This role must provide the sns:Publish permission for your // notification topic. For information about creating and using this service role, - // see Monitoring Systems Manager status changes using Amazon SNS notifications - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) + // see Monitoring Systems Manager status changes using Amazon SNS notifications (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) // in the Amazon Web Services Systems Manager User Guide. ServiceRoleArn *string // An array of search criteria that targets managed nodes using a Key,Value // combination that you specify. Specifying targets is most useful when you want to - // send a command to a large number of managed nodes at once. Using Targets, which + // send a command to a large number of managed nodes at once. Using Targets , which // accepts tag key-value pairs to identify managed nodes, you can send a command to // tens, hundreds, or thousands of nodes at once. To send a command to a smaller // number of managed nodes, you can use the InstanceIds option instead. For more - // information about how to use targets, see Sending commands to a fleet - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) + // information about how to use targets, see Sending commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) // in the Amazon Web Services Systems Manager User Guide. Targets []types.Target - // If this time is reached and the command hasn't already started running, it won't - // run. + // If this time is reached and the command hasn't already started running, it + // won't run. TimeoutSeconds *int32 noSmithyDocumentSerde diff --git a/service/ssm/api_op_StartAssociationsOnce.go b/service/ssm/api_op_StartAssociationsOnce.go index cb1e12c32b8..e526948464f 100644 --- a/service/ssm/api_op_StartAssociationsOnce.go +++ b/service/ssm/api_op_StartAssociationsOnce.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs an association immediately and only one time. This operation can be helpful -// when troubleshooting associations. +// Runs an association immediately and only one time. This operation can be +// helpful when troubleshooting associations. func (c *Client) StartAssociationsOnce(ctx context.Context, params *StartAssociationsOnceInput, optFns ...func(*Options)) (*StartAssociationsOnceOutput, error) { if params == nil { params = &StartAssociationsOnceInput{} diff --git a/service/ssm/api_op_StartAutomationExecution.go b/service/ssm/api_op_StartAutomationExecution.go index da569b1ee81..2d7f522e63d 100644 --- a/service/ssm/api_op_StartAutomationExecution.go +++ b/service/ssm/api_op_StartAutomationExecution.go @@ -32,8 +32,7 @@ type StartAutomationExecutionInput struct { // The name of the SSM document to run. This can be a public document or a custom // document. To run a shared document belonging to another account, specify the // document ARN. For more information about how to use shared documents, see Using - // shared SSM documents - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) + // shared SSM documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. @@ -51,7 +50,7 @@ type StartAutomationExecutionInput struct { // The maximum number of targets allowed to run this task in parallel. You can // specify a number, such as 10, or a percentage, such as 10%. The default value is - // 10. + // 10 . MaxConcurrency *string // The number of errors that are allowed before the system stops running the @@ -81,27 +80,21 @@ type StartAutomationExecutionInput struct { // different ways, such as by purpose, owner, or environment. For example, you // might want to tag an automation to identify an environment or operating system. // In this case, you could specify the following key-value pairs: - // - // * - // Key=environment,Value=test - // - // * Key=OS,Value=Windows - // - // To add tags to an existing - // automation, use the AddTagsToResource operation. + // - Key=environment,Value=test + // - Key=OS,Value=Windows + // To add tags to an existing automation, use the AddTagsToResource operation. Tags []types.Tag // A location is a combination of Amazon Web Services Regions and/or Amazon Web // Services accounts where you want to run the automation. Use this operation to // start an automation in multiple Amazon Web Services Regions and multiple Amazon - // Web Services accounts. For more information, see Running Automation workflows in - // multiple Amazon Web Services Regions and Amazon Web Services accounts - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) + // Web Services accounts. For more information, see Running Automation workflows + // in multiple Amazon Web Services Regions and Amazon Web Services accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) // in the Amazon Web Services Systems Manager User Guide. TargetLocations []types.TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The name of the parameter used as the target resource for the rate-controlled diff --git a/service/ssm/api_op_StartChangeRequestExecution.go b/service/ssm/api_op_StartChangeRequestExecution.go index b60799671b6..e65f1ea3e1e 100644 --- a/service/ssm/api_op_StartChangeRequestExecution.go +++ b/service/ssm/api_op_StartChangeRequestExecution.go @@ -46,12 +46,12 @@ type StartChangeRequestExecutionInput struct { // Indicates whether the change request can be approved automatically without the // need for manual approvals. If AutoApprovable is enabled in a change template, - // then setting AutoApprove to true in StartChangeRequestExecution creates a change - // request that bypasses approver review. Change Calendar restrictions are not - // bypassed in this scenario. If the state of an associated calendar is CLOSED, - // change freeze approvers must still grant permission for this change request to + // then setting AutoApprove to true in StartChangeRequestExecution creates a + // change request that bypasses approver review. Change Calendar restrictions are + // not bypassed in this scenario. If the state of an associated calendar is CLOSED + // , change freeze approvers must still grant permission for this change request to // run. If they don't, the change won't be processed until the calendar state is - // again OPEN. + // again OPEN . AutoApprove bool // User-provided details about the change. If no details are provided, content @@ -89,10 +89,8 @@ type StartChangeRequestExecutionInput struct { // might want to tag a change request to identify an environment or target Amazon // Web Services Region. In this case, you could specify the following key-value // pairs: - // - // * Key=Environment,Value=Production - // - // * Key=Region,Value=us-east-2 + // - Key=Environment,Value=Production + // - Key=Region,Value=us-east-2 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_StartSession.go b/service/ssm/api_op_StartSession.go index ae93b8cdec7..bed84bdb593 100644 --- a/service/ssm/api_op_StartSession.go +++ b/service/ssm/api_op_StartSession.go @@ -13,10 +13,10 @@ import ( // Initiates a connection to a target (for example, a managed node) for a Session // Manager session. Returns a URL and token that can be used to open a WebSocket // connection for sending input and receiving outputs. Amazon Web Services CLI -// usage: start-session is an interactive command that requires the Session Manager -// plugin to be installed on the client machine making the call. For information, -// see Install the Session Manager plugin for the Amazon Web Services CLI -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) +// usage: start-session is an interactive command that requires the Session +// Manager plugin to be installed on the client machine making the call. For +// information, see Install the Session Manager plugin for the Amazon Web Services +// CLI (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) // in the Amazon Web Services Systems Manager User Guide. Amazon Web Services Tools // for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web // Services Tools for PowerShell on Windows local machines. @@ -44,11 +44,10 @@ type StartSessionInput struct { // The name of the SSM document you want to use to define the type of session, // input parameters, or preferences for the session. For example, - // SSM-SessionManagerRunShell. You can call the GetDocument API to verify the + // SSM-SessionManagerRunShell . You can call the GetDocument API to verify the // document exists before attempting to start a session. If no document name is // provided, a shell to the managed node is launched by default. For more - // information, see Start a session - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html) + // information, see Start a session (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html) // in the Amazon Web Services Systems Manager User Guide. DocumentName *string @@ -56,8 +55,9 @@ type StartSessionInput struct { // document. Parameters map[string][]string - // The reason for connecting to the instance. This value is included in the details - // for the Amazon CloudWatch Events event created when you start the session. + // The reason for connecting to the instance. This value is included in the + // details for the Amazon CloudWatch Events event created when you start the + // session. Reason *string noSmithyDocumentSerde @@ -68,16 +68,15 @@ type StartSessionOutput struct { // The ID of the session. SessionId *string - // A URL back to SSM Agent on the managed node that the Session Manager client uses - // to send commands and receive output from the node. Format: + // A URL back to SSM Agent on the managed node that the Session Manager client + // uses to send commands and receive output from the node. Format: // wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) // region represents the Region identifier for an Amazon Web Services Region // supported by Amazon Web Services Systems Manager, such as us-east-2 for the US // East (Ohio) Region. For a list of supported region values, see the Region column - // in Systems Manager service endpoints - // (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in the - // Amazon Web Services General Reference. session-id represents the ID of a Session - // Manager session, such as 1a2b3c4dEXAMPLE. + // in Systems Manager service endpoints (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) + // in the Amazon Web Services General Reference. session-id represents the ID of a + // Session Manager session, such as 1a2b3c4dEXAMPLE . StreamUrl *string // An encrypted token value containing session and caller information. This token diff --git a/service/ssm/api_op_UpdateAssociation.go b/service/ssm/api_op_UpdateAssociation.go index 39be8a84f87..009a5143c85 100644 --- a/service/ssm/api_op_UpdateAssociation.go +++ b/service/ssm/api_op_UpdateAssociation.go @@ -13,7 +13,7 @@ import ( // Updates an association. You can update the association name and version, the // document version, schedule, parameters, and Amazon Simple Storage Service -// (Amazon S3) output. When you call UpdateAssociation, the system removes all +// (Amazon S3) output. When you call UpdateAssociation , the system removes all // optional parameters from the request and overwrites the association with null // values for those parameters. This is by design. You must specify all optional // parameters in the call, even if you are not changing the parameters. This @@ -22,9 +22,9 @@ import ( // parameters required for your UpdateAssociation call. In order to call this API // operation, a user, group, or role must be granted permission to call the // DescribeAssociation API operation. If you don't have permission to call -// DescribeAssociation, then you receive the following error: An error occurred +// DescribeAssociation , then you receive the following error: An error occurred // (AccessDeniedException) when calling the UpdateAssociation operation: User: -// isn't authorized to perform: ssm:DescribeAssociation on resource: When you +// isn't authorized to perform: ssm:DescribeAssociation on resource: When you // update an association, the association immediately runs against the specified // targets. You can add the ApplyOnlyAtCronInterval parameter to run the // association during the next schedule run. @@ -54,22 +54,22 @@ type UpdateAssociationInput struct { // command. AlarmConfiguration *types.AlarmConfiguration - // By default, when you update an association, the system runs it immediately after - // it is updated and then according to the schedule you specified. Specify this - // option if you don't want an association to run immediately after you update it. - // This parameter isn't supported for rate expressions. If you chose this option - // when you created an association and later you edit that association or you make - // changes to the SSM document on which that association is based (by using the - // Documents page in the console), State Manager applies the association at the - // next specified cron interval. For example, if you chose the Latest version of an - // SSM document when you created an association and you edit the association by - // choosing a different document version on the Documents page, State Manager - // applies the association at the next specified cron interval if you previously - // selected this option. If this option wasn't selected, State Manager immediately - // runs the association. You can reset this option. To do so, specify the - // no-apply-only-at-cron-interval parameter when you update the association from - // the command line. This parameter forces the association to run immediately after - // updating it and according to the interval specified. + // By default, when you update an association, the system runs it immediately + // after it is updated and then according to the schedule you specified. Specify + // this option if you don't want an association to run immediately after you update + // it. This parameter isn't supported for rate expressions. If you chose this + // option when you created an association and later you edit that association or + // you make changes to the SSM document on which that association is based (by + // using the Documents page in the console), State Manager applies the association + // at the next specified cron interval. For example, if you chose the Latest + // version of an SSM document when you created an association and you edit the + // association by choosing a different document version on the Documents page, + // State Manager applies the association at the next specified cron interval if you + // previously selected this option. If this option wasn't selected, State Manager + // immediately runs the association. You can reset this option. To do so, specify + // the no-apply-only-at-cron-interval parameter when you update the association + // from the command line. This parameter forces the association to run immediately + // after updating it and according to the interval specified. ApplyOnlyAtCronInterval bool // The name of the association that you want to update. @@ -77,7 +77,7 @@ type UpdateAssociationInput struct { // This parameter is provided for concurrency control purposes. You must specify // the latest association version in the service. If you want to ensure that this - // request succeeds, either specify $LATEST, or omit this parameter. + // request succeeds, either specify $LATEST , or omit this parameter. AssociationVersion *string // Choose the parameter that will define how your automation will branch out. This @@ -89,8 +89,8 @@ type UpdateAssociationInput struct { // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // you want to gate your associations under. The associations only run when that // change calendar is open. For more information, see Amazon Web Services Systems - // Manager Change Calendar - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). + // Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) + // . CalendarNames []string // The severity level to assign to the association. @@ -102,17 +102,17 @@ type UpdateAssociationInput struct { // version of a document if shared from another account, even though the Systems // Manager console shows that a new version was processed. If you want to run an // association using a new version of a document shared form another account, you - // must set the document version to default. + // must set the document version to default . DocumentVersion *string // The maximum number of targets allowed to run the association at the same time. // You can specify a number, for example 10, or a percentage of the target set, for // example 10%. The default value is 100%, which means all targets run the // association at the same time. If a new managed node starts and attempts to run - // an association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new + // an association while Systems Manager is running MaxConcurrency associations, + // the association is allowed to run. During the next association interval, the new // managed node will process its association within the limit specified for - // MaxConcurrency. + // MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -121,12 +121,12 @@ type UpdateAssociationInput struct { // 10%. If you specify 3, for example, the system stops sending requests when the // fourth error is received. If you specify 0, then the system stops sending // requests after the first error is returned. If you run an association on 50 - // managed nodes and set MaxError to 10%, then the system stops sending the request - // when the sixth error is received. Executions that are already running an - // association when MaxErrors is reached are allowed to complete, but some of these - // executions may fail as well. If you need to ensure that there won't be more than - // max-errors failed executions, set MaxConcurrency to 1 so that executions proceed - // one at a time. + // managed nodes and set MaxError to 10%, then the system stops sending the + // request when the sixth error is received. Executions that are already running an + // association when MaxErrors is reached are allowed to complete, but some of + // these executions may fail as well. If you need to ensure that there won't be + // more than max-errors failed executions, set MaxConcurrency to 1 so that + // executions proceed one at a time. MaxErrors *string // The name of the SSM Command document or Automation runbook that contains the @@ -135,44 +135,44 @@ type UpdateAssociationInput struct { // shared with you from another account. For Systems Manager document (SSM // document) that are shared with you from other Amazon Web Services accounts, you // must specify the complete SSM document ARN, in the following format: - // arn:aws:ssm:region:account-id:document/document-name For example: + // arn:aws:ssm:region:account-id:document/document-name For example: // arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For Amazon Web // Services-predefined documents and SSM documents you created in your account, you // only need to specify the document name. For example, AWS-ApplyPatchBaseline or - // My-Document. + // My-Document . Name *string // An S3 bucket where you want to store the results of this request. OutputLocation *types.InstanceAssociationOutputLocation - // The parameters you want to update for the association. If you create a parameter - // using Parameter Store, a capability of Amazon Web Services Systems Manager, you - // can reference the parameter using {{ssm:parameter-name}}. + // The parameters you want to update for the association. If you create a + // parameter using Parameter Store, a capability of Amazon Web Services Systems + // Manager, you can reference the parameter using {{ssm:parameter-name}} . Parameters map[string][]string // The cron expression used to schedule the association that you want to update. ScheduleExpression *string // Number of days to wait after the scheduled day to run an association. For - // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could + // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *) , you could // specify an offset of 3 to run the association each Sunday after the second // Thursday of the month. For more information about cron schedules for - // associations, see Reference: Cron and rate expressions for Systems Manager - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) + // associations, see Reference: Cron and rate expressions for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) // in the Amazon Web Services Systems Manager User Guide. To use offsets, you must // specify the ApplyOnlyAtCronInterval parameter. This option tells the system not // to run an association immediately after you create it. ScheduleOffset *int32 - // The mode for generating association compliance. You can specify AUTO or MANUAL. + // The mode for generating association compliance. You can specify AUTO or MANUAL . // In AUTO mode, the system uses the status of the association execution to // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems API operation. In - // this case, compliance data isn't managed by State Manager, a capability of - // Amazon Web Services Systems Manager. It is managed by your direct call to the - // PutComplianceItems API operation. By default, all associations use AUTO mode. + // then the association is COMPLIANT . If the association execution doesn't run + // successfully, the association is NON-COMPLIANT . In MANUAL mode, you must + // specify the AssociationId as a parameter for the PutComplianceItems API + // operation. In this case, compliance data isn't managed by State Manager, a + // capability of Amazon Web Services Systems Manager. It is managed by your direct + // call to the PutComplianceItems API operation. By default, all associations use + // AUTO mode. SyncCompliance types.AssociationSyncCompliance // A location is a combination of Amazon Web Services Regions and Amazon Web @@ -180,8 +180,8 @@ type UpdateAssociationInput struct { // update an association in multiple Regions and multiple accounts. TargetLocations []types.TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The targets of the association. diff --git a/service/ssm/api_op_UpdateAssociationStatus.go b/service/ssm/api_op_UpdateAssociationStatus.go index d5ac7998025..07c66d72764 100644 --- a/service/ssm/api_op_UpdateAssociationStatus.go +++ b/service/ssm/api_op_UpdateAssociationStatus.go @@ -12,10 +12,10 @@ import ( ) // Updates the status of the Amazon Web Services Systems Manager document (SSM -// document) associated with the specified managed node. UpdateAssociationStatus is -// primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to -// report status updates about your associations and is only used for associations -// created with the InstanceId legacy parameter. +// document) associated with the specified managed node. UpdateAssociationStatus +// is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) +// to report status updates about your associations and is only used for +// associations created with the InstanceId legacy parameter. func (c *Client) UpdateAssociationStatus(ctx context.Context, params *UpdateAssociationStatusInput, optFns ...func(*Options)) (*UpdateAssociationStatusOutput, error) { if params == nil { params = &UpdateAssociationStatusInput{} diff --git a/service/ssm/api_op_UpdateMaintenanceWindow.go b/service/ssm/api_op_UpdateMaintenanceWindow.go index b8e6a49a303..afc0fe4ecc5 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindow.go +++ b/service/ssm/api_op_UpdateMaintenanceWindow.go @@ -14,7 +14,7 @@ import ( // The value you specify for Duration determines the specific end time for the // maintenance window based on the time it begins. No maintenance window tasks are // permitted to start after the resulting endtime minus the number of hours you -// specify for Cutoff. For example, if the maintenance window starts at 3 PM, the +// specify for Cutoff . For example, if the maintenance window starts at 3 PM, the // duration is three hours, and the value you specify for Cutoff is one hour, no // maintenance window tasks can start after 5 PM. func (c *Client) UpdateMaintenanceWindow(ctx context.Context, params *UpdateMaintenanceWindowInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowOutput, error) { @@ -57,14 +57,14 @@ type UpdateMaintenanceWindowInput struct { Enabled *bool // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become inactive. EndDate allows you to set a date and time - // in the future when the maintenance window will no longer run. + // maintenance window to become inactive. EndDate allows you to set a date and + // time in the future when the maintenance window will no longer run. EndDate *string // The name of the maintenance window. Name *string - // If True, then all fields that are required by the CreateMaintenanceWindow + // If True , then all fields that are required by the CreateMaintenanceWindow // operation are also required for this API request. Optional fields that aren't // specified are set to null. Replace *bool @@ -75,7 +75,7 @@ type UpdateMaintenanceWindowInput struct { // The number of days to wait after the date and time specified by a cron // expression before running the maintenance window. For example, the following // cron expression schedules a maintenance window to run the third Tuesday of every - // month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, the + // month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2 , the // maintenance window won't run until two days later. ScheduleOffset *int32 @@ -86,8 +86,8 @@ type UpdateMaintenanceWindowInput struct { ScheduleTimezone *string // The date and time, in ISO-8601 Extended format, for when you want the - // maintenance window to become active. StartDate allows you to delay activation of - // the maintenance window until the specified future date. + // maintenance window to become active. StartDate allows you to delay activation + // of the maintenance window until the specified future date. StartDate *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go index 3a89be294d6..d55ef2b2baf 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go @@ -13,21 +13,13 @@ import ( // Modifies the target of an existing maintenance window. You can change the // following: -// -// * Name -// -// * Description -// -// * Owner -// -// * IDs for an ID target -// -// * Tags for a -// Tag target -// -// * From any supported tag type to another. The three supported tag -// types are ID target, Tag target, and resource group. For more information, see -// Target. +// - Name +// - Description +// - Owner +// - IDs for an ID target +// - Tags for a Tag target +// - From any supported tag type to another. The three supported tag types are +// ID target, Tag target, and resource group. For more information, see Target . // // If a parameter is null, then the corresponding field isn't modified. func (c *Client) UpdateMaintenanceWindowTarget(ctx context.Context, params *UpdateMaintenanceWindowTargetInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowTargetOutput, error) { @@ -63,11 +55,11 @@ type UpdateMaintenanceWindowTargetInput struct { // A name for the update. Name *string - // User-provided value that will be included in any Amazon CloudWatch Events events - // raised while running tasks for these targets in this maintenance window. + // User-provided value that will be included in any Amazon CloudWatch Events + // events raised while running tasks for these targets in this maintenance window. OwnerInformation *string - // If True, then all fields that are required by the + // If True , then all fields that are required by the // RegisterTargetWithMaintenanceWindow operation are also required for this API // request. Optional fields that aren't specified are set to null. Replace *bool diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTask.go b/service/ssm/api_op_UpdateMaintenanceWindowTask.go index b3c3c5c13f3..c582420f3b4 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTask.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTask.go @@ -13,40 +13,31 @@ import ( // Modifies a task assigned to a maintenance window. You can't change the task // type, but you can change the following values: +// - TaskARN . For example, you can change a RUN_COMMAND task from +// AWS-RunPowerShellScript to AWS-RunShellScript . +// - ServiceRoleArn +// - TaskInvocationParameters +// - Priority +// - MaxConcurrency +// - MaxErrors // -// * TaskARN. For example, you can -// change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. -// -// * -// ServiceRoleArn -// -// * TaskInvocationParameters -// -// * Priority -// -// * MaxConcurrency -// -// * -// MaxErrors -// -// One or more targets must be specified for maintenance window Run -// Command-type tasks. Depending on the task, targets are optional for other -// maintenance window task types (Automation, Lambda, and Step Functions). For more -// information about running tasks that don't specify targets, see Registering -// maintenance window tasks without targets -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) +// One or more targets must be specified for maintenance window Run Command-type +// tasks. Depending on the task, targets are optional for other maintenance window +// task types (Automation, Lambda, and Step Functions). For more information about +// running tasks that don't specify targets, see Registering maintenance window +// tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. If the value for a // parameter in UpdateMaintenanceWindowTask is null, then the corresponding field // isn't modified. If you set Replace to true, then all fields required by the // RegisterTaskWithMaintenanceWindow operation are required for this request. // Optional fields that aren't specified are set to null. When you update a -// maintenance window task that has options specified in TaskInvocationParameters, +// maintenance window task that has options specified in TaskInvocationParameters , // you must provide again all the TaskInvocationParameters values that you want to // retain. The values you don't specify again are removed. For example, suppose // that when you registered a Run Command task, you specified -// TaskInvocationParameters values for Comment, NotificationConfig, and -// OutputS3BucketName. If you update the maintenance window task and specify only a -// different OutputS3BucketName value, the values for Comment and +// TaskInvocationParameters values for Comment , NotificationConfig , and +// OutputS3BucketName . If you update the maintenance window task and specify only +// a different OutputS3BucketName value, the values for Comment and // NotificationConfig are removed. func (c *Client) UpdateMaintenanceWindowTask(ctx context.Context, params *UpdateMaintenanceWindowTaskInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowTaskOutput, error) { if params == nil { @@ -80,24 +71,17 @@ type UpdateMaintenanceWindowTaskInput struct { // Indicates whether tasks should continue to run after the cutoff time specified // in the maintenance windows is reached. - // - // * CONTINUE_TASK: When the cutoff time is - // reached, any tasks that are running continue. The default value. - // - // * - // CANCEL_TASK: - // - // * For Automation, Lambda, Step Functions tasks: When the cutoff - // time is reached, any task invocations that are already running continue, but no - // new task invocations are started. - // - // * For Run Command tasks: When the cutoff time - // is reached, the system sends a CancelCommand operation that attempts to cancel - // the command associated with the task. However, there is no guarantee that the - // command will be terminated and the underlying process stopped. - // - // The status for - // tasks that are not completed is TIMED_OUT. + // - CONTINUE_TASK : When the cutoff time is reached, any tasks that are running + // continue. The default value. + // - CANCEL_TASK : + // - For Automation, Lambda, Step Functions tasks: When the cutoff time is + // reached, any task invocations that are already running continue, but no new task + // invocations are started. + // - For Run Command tasks: When the cutoff time is reached, the system sends a + // CancelCommand operation that attempts to cancel the command associated with + // the task. However, there is no guarantee that the command will be terminated and + // the underlying process stopped. The status for tasks that are not completed + // is TIMED_OUT . CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // The new task description to specify. @@ -108,36 +92,34 @@ type UpdateMaintenanceWindowTaskInput struct { // contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options // in the TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. + // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The new MaxConcurrency value you want to specify. MaxConcurrency is the number // of targets that are allowed to run this task, in parallel. Although this element // is listed as "Required: No", a value can be omitted only when you are - // registering or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxConcurrency *string // The new MaxErrors value to specify. MaxErrors is the maximum number of errors // that are allowed before the task stops being scheduled. Although this element is // listed as "Required: No", a value can be omitted only when you are registering - // or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxErrors *string // The new task name to specify. Name *string - // The new task priority to specify. The lower the number, the higher the priority. - // Tasks that have the same priority are scheduled in parallel. + // The new task priority to specify. The lower the number, the higher the + // priority. Tasks that have the same priority are scheduled in parallel. Priority *int32 // If True, then all fields that are required by the @@ -149,28 +131,22 @@ type UpdateMaintenanceWindowTaskInput struct { // Systems Manager to assume when running a maintenance window task. If you do not // specify a service role ARN, Systems Manager uses your account's service-linked // role. If no service-linked role for Systems Manager exists in your account, it - // is created when you run RegisterTaskWithMaintenanceWindow. For more information, - // see the following topics in the in the Amazon Web Services Systems Manager User - // Guide: - // - // * Using service-linked roles for Systems Manager - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) - // - // * - // Should I use a service-linked role or a custom service role to run maintenance - // window tasks? - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) + // is created when you run RegisterTaskWithMaintenanceWindow . For more + // information, see the following topics in the in the Amazon Web Services Systems + // Manager User Guide: + // - Using service-linked roles for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) + // - Should I use a service-linked role or a custom service role to run + // maintenance window tasks? (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string // The targets (either managed nodes or tags) to modify. Managed nodes are - // specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. - // Tags are specified using the format Key=tag_name,Values=tag_value. One or more + // specified using the format Key=instanceids,Values=instanceID_1,instanceID_2 . + // Tags are specified using the format Key=tag_name,Values=tag_value . One or more // targets must be specified for maintenance window Run Command-type tasks. // Depending on the task, targets are optional for other maintenance window task // types (Automation, Lambda, and Step Functions). For more information about // running tasks that don't specify targets, see Registering maintenance window - // tasks without targets - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. Targets []types.Target @@ -180,22 +156,22 @@ type UpdateMaintenanceWindowTaskInput struct { // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. When you // update a maintenance window task that has options specified in - // TaskInvocationParameters, you must provide again all the + // TaskInvocationParameters , you must provide again all the // TaskInvocationParameters values that you want to retain. The values you don't // specify again are removed. For example, suppose that when you registered a Run - // Command task, you specified TaskInvocationParameters values for Comment, - // NotificationConfig, and OutputS3BucketName. If you update the maintenance window - // task and specify only a different OutputS3BucketName value, the values for - // Comment and NotificationConfig are removed. + // Command task, you specified TaskInvocationParameters values for Comment , + // NotificationConfig , and OutputS3BucketName . If you update the maintenance + // window task and specify only a different OutputS3BucketName value, the values + // for Comment and NotificationConfig are removed. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The parameters to modify. TaskParameters has been deprecated. To specify // parameters to pass to a task when it runs, instead use the Parameters option in // the TaskInvocationParameters structure. For information about how Systems // Manager handles these options for the supported maintenance window task types, - // see MaintenanceWindowTaskInvocationParameters. The map has the following format: - // Key: string, between 1 and 255 characters Value: an array of strings, each - // string is between 1 and 255 characters + // see MaintenanceWindowTaskInvocationParameters . The map has the following + // format: Key: string, between 1 and 255 characters Value: an array of strings, + // each string is between 1 and 255 characters TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression noSmithyDocumentSerde @@ -207,8 +183,8 @@ type UpdateMaintenanceWindowTaskOutput struct { // task. AlarmConfiguration *types.AlarmConfiguration - // The specification for whether tasks should continue to run after the cutoff time - // specified in the maintenance windows is reached. + // The specification for whether tasks should continue to run after the cutoff + // time specified in the maintenance windows is reached. CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // The updated task description. @@ -219,7 +195,7 @@ type UpdateMaintenanceWindowTaskOutput struct { // instead use the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. + // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The updated MaxConcurrency value. @@ -252,7 +228,7 @@ type UpdateMaintenanceWindowTaskOutput struct { // parameters to pass to a task when it runs, instead use the Parameters option in // the TaskInvocationParameters structure. For information about how Systems // Manager handles these options for the supported maintenance window task types, - // see MaintenanceWindowTaskInvocationParameters. + // see MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // The ID of the maintenance window that was updated. diff --git a/service/ssm/api_op_UpdateManagedInstanceRole.go b/service/ssm/api_op_UpdateManagedInstanceRole.go index d22cc2424fa..c528a17e698 100644 --- a/service/ssm/api_op_UpdateManagedInstanceRole.go +++ b/service/ssm/api_op_UpdateManagedInstanceRole.go @@ -13,7 +13,7 @@ import ( // Changes the Identity and Access Management (IAM) role that is assigned to the // on-premises server, edge device, or virtual machines (VM). IAM roles are first // assigned to these hybrid nodes during the activation process. For more -// information, see CreateActivation. +// information, see CreateActivation . func (c *Client) UpdateManagedInstanceRole(ctx context.Context, params *UpdateManagedInstanceRoleInput, optFns ...func(*Options)) (*UpdateManagedInstanceRoleOutput, error) { if params == nil { params = &UpdateManagedInstanceRoleInput{} @@ -33,9 +33,8 @@ type UpdateManagedInstanceRoleInput struct { // The name of the Identity and Access Management (IAM) role that you want to // assign to the managed node. This IAM role must provide AssumeRole permissions - // for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. - // For more information, see Create an IAM service role for a hybrid environment - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) + // for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com + // . For more information, see Create an IAM service role for a hybrid environment (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) // in the Amazon Web Services Systems Manager User Guide. You can't specify an IAM // service-linked role for this parameter. You must create a unique role. // diff --git a/service/ssm/api_op_UpdateOpsItem.go b/service/ssm/api_op_UpdateOpsItem.go index a90deafd800..4c289fb5b18 100644 --- a/service/ssm/api_op_UpdateOpsItem.go +++ b/service/ssm/api_op_UpdateOpsItem.go @@ -13,16 +13,14 @@ import ( ) // Edit or change an OpsItem. You must have permission in Identity and Access -// Management (IAM) to update an OpsItem. For more information, see Getting started -// with OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) +// Management (IAM) to update an OpsItem. For more information, see Getting +// started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) // in the Amazon Web Services Systems Manager User Guide. Operations engineers and // IT professionals use Amazon Web Services Systems Manager OpsCenter to view, // investigate, and remediate operational issues impacting the performance and // health of their Amazon Web Services resources. For more information, see -// OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in -// the Amazon Web Services Systems Manager User Guide. +// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. func (c *Client) UpdateOpsItem(ctx context.Context, params *UpdateOpsItemInput, optFns ...func(*Options)) (*UpdateOpsItemOutput, error) { if params == nil { params = &UpdateOpsItemInput{} @@ -46,11 +44,11 @@ type UpdateOpsItemInput struct { OpsItemId *string // The time a runbook workflow ended. Currently reported only for the OpsItem type - // /aws/changerequest. + // /aws/changerequest . ActualEndTime *time.Time // The time a runbook workflow started. Currently reported only for the OpsItem - // type /aws/changerequest. + // type /aws/changerequest . ActualStartTime *time.Time // Specify a new category for an OpsItem. @@ -60,8 +58,8 @@ type UpdateOpsItemInput struct { // users reading this OpsItem for the first time understand the issue. Description *string - // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when - // this OpsItem is edited or changed. + // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent + // when this OpsItem is edited or changed. Notifications []types.OpsItemNotification // Add new keys or edit existing key-value pairs of the OperationalData map in the @@ -70,18 +68,17 @@ type UpdateOpsItemInput struct { // strings, license keys, troubleshooting tips, or other relevant data. You enter // operational data as key-value pairs. The key has a maximum length of 128 // characters. The value has a maximum size of 20 KB. Operational data keys can't - // begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. - // You can choose to make the data searchable by other users in the account or you - // can restrict search access. Searchable data means that all users with access to - // the OpsItem Overview page (as provided by the DescribeOpsItems API operation) - // can view and search on the specified data. Operational data that isn't - // searchable is only viewable by users who have access to the OpsItem (as provided - // by the GetOpsItem API operation). Use the /aws/resources key in OperationalData - // to specify a related resource in the request. Use the /aws/automations key in - // OperationalData to associate an Automation runbook with the OpsItem. To view - // Amazon Web Services CLI example commands that use these keys, see Creating - // OpsItems manually - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) + // begin with the following: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , + // /ssm . You can choose to make the data searchable by other users in the account + // or you can restrict search access. Searchable data means that all users with + // access to the OpsItem Overview page (as provided by the DescribeOpsItems API + // operation) can view and search on the specified data. Operational data that + // isn't searchable is only viewable by users who have access to the OpsItem (as + // provided by the GetOpsItem API operation). Use the /aws/resources key in + // OperationalData to specify a related resource in the request. Use the + // /aws/automations key in OperationalData to associate an Automation runbook with + // the OpsItem. To view Amazon Web Services CLI example commands that use these + // keys, see Creating OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) // in the Amazon Web Services Systems Manager User Guide. OperationalData map[string]types.OpsItemDataValue @@ -92,11 +89,11 @@ type UpdateOpsItemInput struct { OpsItemArn *string // The time specified in a change request for a runbook workflow to end. Currently - // supported only for the OpsItem type /aws/changerequest. + // supported only for the OpsItem type /aws/changerequest . PlannedEndTime *time.Time // The time specified in a change request for a runbook workflow to start. - // Currently supported only for the OpsItem type /aws/changerequest. + // Currently supported only for the OpsItem type /aws/changerequest . PlannedStartTime *time.Time // The importance of this OpsItem in relation to other OpsItems in the system. @@ -110,9 +107,8 @@ type UpdateOpsItemInput struct { // Specify a new severity for an OpsItem. Severity *string - // The OpsItem status. Status can be Open, In Progress, or Resolved. For more - // information, see Editing OpsItem details - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details) + // The OpsItem status. Status can be Open , In Progress , or Resolved . For more + // information, see Editing OpsItem details (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details) // in the Amazon Web Services Systems Manager User Guide. Status types.OpsItemStatus diff --git a/service/ssm/api_op_UpdatePatchBaseline.go b/service/ssm/api_op_UpdatePatchBaseline.go index abf9f067b63..cbb2de92ef4 100644 --- a/service/ssm/api_op_UpdatePatchBaseline.go +++ b/service/ssm/api_op_UpdatePatchBaseline.go @@ -14,7 +14,7 @@ import ( // Modifies an existing patch baseline. Fields not specified in the request are // left unchanged. For information about valid key-value pairs in PatchFilters for -// each supported operating system type, see PatchFilter. +// each supported operating system type, see PatchFilter . func (c *Client) UpdatePatchBaseline(ctx context.Context, params *UpdatePatchBaselineInput, optFns ...func(*Options)) (*UpdatePatchBaselineOutput, error) { if params == nil { params = &UpdatePatchBaselineInput{} @@ -42,8 +42,7 @@ type UpdatePatchBaselineInput struct { // A list of explicitly approved patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. ApprovedPatches []string @@ -51,8 +50,8 @@ type UpdatePatchBaselineInput struct { ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the managed nodes. The default value is false. Applies - // to Linux managed nodes only. + // that should be applied to the managed nodes. The default value is false . + // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // A description of the patch baseline. @@ -66,24 +65,21 @@ type UpdatePatchBaselineInput struct { // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. RejectedPatches []string // The action for Patch Manager to take on patches included in the RejectedPackages // list. - // - // * ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is - // installed only if it is a dependency of another package. It is considered - // compliant with the patch baseline, and its status is reported as InstalledOther. - // This is the default action if no option is specified. - // - // * BLOCK : Packages in the - // RejectedPatches list, and packages that include them as dependencies, aren't - // installed under any circumstances. If a package was installed before it was - // added to the Rejected patches list, it is considered non-compliant with the - // patch baseline, and its status is reported as InstalledRejected. + // - ALLOW_AS_DEPENDENCY : A package in the Rejected patches list is installed + // only if it is a dependency of another package. It is considered compliant with + // the patch baseline, and its status is reported as InstalledOther . This is the + // default action if no option is specified. + // - BLOCK : Packages in the RejectedPatches list, and packages that include them + // as dependencies, aren't installed under any circumstances. If a package was + // installed before it was added to the Rejected patches list, it is considered + // non-compliant with the patch baseline, and its status is reported as + // InstalledRejected . RejectedPatchesAction types.PatchAction // If True, then all fields that are required by the CreatePatchBaseline operation @@ -112,8 +108,8 @@ type UpdatePatchBaselineOutput struct { ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the managed nodes. The default value is false. Applies - // to Linux managed nodes only. + // that should be applied to the managed nodes. The default value is false . + // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // The ID of the deleted patch baseline. diff --git a/service/ssm/api_op_UpdateResourceDataSync.go b/service/ssm/api_op_UpdateResourceDataSync.go index 332a8410c51..d792c3a0e86 100644 --- a/service/ssm/api_op_UpdateResourceDataSync.go +++ b/service/ssm/api_op_UpdateResourceDataSync.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a resource data sync. After you create a resource data sync for a Region, -// you can't change the account options for that sync. For example, if you create a -// sync in the us-east-2 (Ohio) Region and you choose the Include only the current -// account option, you can't edit that sync later and choose the Include all -// accounts from my Organizations configuration option. Instead, you must delete -// the first resource data sync, and create a new one. This API operation only -// supports a resource data sync that was created with a SyncFromSource SyncType. +// Update a resource data sync. After you create a resource data sync for a +// Region, you can't change the account options for that sync. For example, if you +// create a sync in the us-east-2 (Ohio) Region and you choose the Include only +// the current account option, you can't edit that sync later and choose the +// Include all accounts from my Organizations configuration option. Instead, you +// must delete the first resource data sync, and create a new one. This API +// operation only supports a resource data sync that was created with a +// SyncFromSource SyncType . func (c *Client) UpdateResourceDataSync(ctx context.Context, params *UpdateResourceDataSyncInput, optFns ...func(*Options)) (*UpdateResourceDataSyncOutput, error) { if params == nil { params = &UpdateResourceDataSyncInput{} diff --git a/service/ssm/api_op_UpdateServiceSetting.go b/service/ssm/api_op_UpdateServiceSetting.go index 4f57698e388..ddd1ae3eceb 100644 --- a/service/ssm/api_op_UpdateServiceSetting.go +++ b/service/ssm/api_op_UpdateServiceSetting.go @@ -17,8 +17,8 @@ import ( // team might create a default setting of "false". This means the user can't use // this feature unless they change the setting to "true" and intentionally opt in // for a paid feature. Services map a SettingId object to a setting value. Amazon -// Web Services services teams define the default value for a SettingId. You can't -// create a new SettingId, but you can overwrite the default value if you have the +// Web Services services teams define the default value for a SettingId . You can't +// create a new SettingId , but you can overwrite the default value if you have the // ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting // API operation to view the current value. Or, use the ResetServiceSetting to // change the value back to the original value defined by the Amazon Web Services @@ -42,32 +42,16 @@ func (c *Client) UpdateServiceSetting(ctx context.Context, params *UpdateService type UpdateServiceSettingInput struct { // The Amazon Resource Name (ARN) of the service setting to update. For example, - // arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled. - // The setting ID can be one of the following. - // - // * - // /ssm/managed-instance/default-ec2-instance-management-role - // - // * - // /ssm/automation/customer-script-log-destination - // - // * - // /ssm/automation/customer-script-log-group-name - // - // * - // /ssm/documents/console/public-sharing-permission - // - // * - // /ssm/managed-instance/activation-tier - // - // * /ssm/opsinsights/opscenter - // - // * - // /ssm/parameter-store/default-parameter-tier - // - // * - // /ssm/parameter-store/high-throughput-enabled - // + // arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled + // . The setting ID can be one of the following. + // - /ssm/managed-instance/default-ec2-instance-management-role + // - /ssm/automation/customer-script-log-destination + // - /ssm/automation/customer-script-log-group-name + // - /ssm/documents/console/public-sharing-permission + // - /ssm/managed-instance/activation-tier + // - /ssm/opsinsights/opscenter + // - /ssm/parameter-store/default-parameter-tier + // - /ssm/parameter-store/high-throughput-enabled // Permissions to update the // /ssm/managed-instance/default-ec2-instance-management-role setting should only // be provided to administrators. Implement least privilege access when allowing @@ -78,31 +62,17 @@ type UpdateServiceSettingInput struct { // The new value to specify for the service setting. The following list specifies // the available values for each setting. - // - // * - // /ssm/managed-instance/default-ec2-instance-management-role: The name of an IAM - // role - // - // * /ssm/automation/customer-script-log-destination: CloudWatch - // - // * - // /ssm/automation/customer-script-log-group-name: The name of an Amazon CloudWatch - // Logs log group - // - // * /ssm/documents/console/public-sharing-permission: Enable or - // Disable - // - // * /ssm/managed-instance/activation-tier: standard or advanced - // - // * - // /ssm/opsinsights/opscenter: Enabled or Disabled - // - // * - // /ssm/parameter-store/default-parameter-tier: Standard, Advanced, - // Intelligent-Tiering - // - // * /ssm/parameter-store/high-throughput-enabled: true or - // false + // - /ssm/managed-instance/default-ec2-instance-management-role: The name of an + // IAM role + // - /ssm/automation/customer-script-log-destination : CloudWatch + // - /ssm/automation/customer-script-log-group-name : The name of an Amazon + // CloudWatch Logs log group + // - /ssm/documents/console/public-sharing-permission : Enable or Disable + // - /ssm/managed-instance/activation-tier : standard or advanced + // - /ssm/opsinsights/opscenter : Enabled or Disabled + // - /ssm/parameter-store/default-parameter-tier : Standard , Advanced , + // Intelligent-Tiering + // - /ssm/parameter-store/high-throughput-enabled : true or false // // This member is required. SettingValue *string diff --git a/service/ssm/doc.go b/service/ssm/doc.go index 6d7585bf0eb..21d190632e0 100644 --- a/service/ssm/doc.go +++ b/service/ssm/doc.go @@ -7,32 +7,22 @@ // Services applications and resources and a secure end-to-end management solution // for hybrid cloud environments that enables safe and secure operations at scale. // This reference is intended to be used with the Amazon Web Services Systems -// Manager User Guide -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/). To get started, -// see Setting up Amazon Web Services Systems Manager -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html). -// Related resources -// -// * For information about each of the capabilities that -// comprise Systems Manager, see Systems Manager capabilities -// (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities) -// in the Amazon Web Services Systems Manager User Guide. -// -// * For details about -// predefined runbooks for Automation, a capability of Amazon Web Services Systems -// Manager, see the Systems Manager Automation runbook reference -// (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html) -// . -// -// * For information about AppConfig, a capability of Systems Manager, see the -// AppConfig User Guide (https://docs.aws.amazon.com/appconfig/latest/userguide/) -// and the AppConfig API Reference -// (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/) . -// -// * For -// information about Incident Manager, a capability of Systems Manager, see the -// Systems Manager Incident Manager User Guide -// (https://docs.aws.amazon.com/incident-manager/latest/userguide/) and the Systems -// Manager Incident Manager API Reference -// (https://docs.aws.amazon.com/incident-manager/latest/APIReference/) . +// Manager User Guide (https://docs.aws.amazon.com/systems-manager/latest/userguide/) +// . To get started, see Setting up Amazon Web Services Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html) +// . Related resources +// - For information about each of the capabilities that comprise Systems +// Manager, see Systems Manager capabilities (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities) +// in the Amazon Web Services Systems Manager User Guide. +// - For details about predefined runbooks for Automation, a capability of +// Amazon Web Services Systems Manager, see the Systems Manager Automation +// runbook reference (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html) +// . +// - For information about AppConfig, a capability of Systems Manager, see the +// AppConfig User Guide (https://docs.aws.amazon.com/appconfig/latest/userguide/) +// and the AppConfig API Reference (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/) +// . +// - For information about Incident Manager, a capability of Systems Manager, +// see the Systems Manager Incident Manager User Guide (https://docs.aws.amazon.com/incident-manager/latest/userguide/) +// and the Systems Manager Incident Manager API Reference (https://docs.aws.amazon.com/incident-manager/latest/APIReference/) +// . package ssm diff --git a/service/ssm/types/enums.go b/service/ssm/types/enums.go index d4c5822a9ca..3f5f724b6f1 100644 --- a/service/ssm/types/enums.go +++ b/service/ssm/types/enums.go @@ -129,8 +129,8 @@ const ( AssociationStatusNameFailed AssociationStatusName = "Failed" ) -// Values returns all known values for AssociationStatusName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for AssociationStatusName. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (AssociationStatusName) Values() []AssociationStatusName { return []AssociationStatusName{ @@ -212,9 +212,10 @@ const ( AutomationExecutionFilterKeyOpsItemId AutomationExecutionFilterKey = "OpsItemId" ) -// Values returns all known values for AutomationExecutionFilterKey. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AutomationExecutionFilterKey. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (AutomationExecutionFilterKey) Values() []AutomationExecutionFilterKey { return []AutomationExecutionFilterKey{ "DocumentNamePrefix", @@ -651,8 +652,8 @@ const ( DocumentParameterTypeStringList DocumentParameterType = "StringList" ) -// Values returns all known values for DocumentParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DocumentParameterType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DocumentParameterType) Values() []DocumentParameterType { return []DocumentParameterType{ @@ -760,9 +761,9 @@ const ( DocumentTypeQuickSetup DocumentType = "QuickSetup" ) -// Values returns all known values for DocumentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DocumentType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DocumentType) Values() []DocumentType { return []DocumentType{ "Command", @@ -828,8 +829,8 @@ const ( FaultUnknown Fault = "Unknown" ) -// Values returns all known values for Fault. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Fault. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Fault) Values() []Fault { return []Fault{ @@ -853,9 +854,10 @@ const ( InstanceInformationFilterKeyAssociationStatus InstanceInformationFilterKey = "AssociationStatus" ) -// Values returns all known values for InstanceInformationFilterKey. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for InstanceInformationFilterKey. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (InstanceInformationFilterKey) Values() []InstanceInformationFilterKey { return []InstanceInformationFilterKey{ "InstanceIds", @@ -1183,8 +1185,8 @@ const ( OpsFilterOperatorTypeExists OpsFilterOperatorType = "Exists" ) -// Values returns all known values for OpsFilterOperatorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OpsFilterOperatorType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OpsFilterOperatorType) Values() []OpsFilterOperatorType { return []OpsFilterOperatorType{ @@ -1222,8 +1224,8 @@ const ( OpsItemEventFilterKeyOpsitemId OpsItemEventFilterKey = "OpsItemId" ) -// Values returns all known values for OpsItemEventFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OpsItemEventFilterKey. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OpsItemEventFilterKey) Values() []OpsItemEventFilterKey { return []OpsItemEventFilterKey{ @@ -1327,8 +1329,8 @@ const ( OpsItemFilterOperatorLessThan OpsItemFilterOperator = "LessThan" ) -// Values returns all known values for OpsItemFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for OpsItemFilterOperator. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (OpsItemFilterOperator) Values() []OpsItemFilterOperator { return []OpsItemFilterOperator{ @@ -1348,9 +1350,10 @@ const ( OpsItemRelatedItemsFilterKeyResourceUri OpsItemRelatedItemsFilterKey = "ResourceUri" ) -// Values returns all known values for OpsItemRelatedItemsFilterKey. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for OpsItemRelatedItemsFilterKey. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (OpsItemRelatedItemsFilterKey) Values() []OpsItemRelatedItemsFilterKey { return []OpsItemRelatedItemsFilterKey{ "ResourceType", @@ -1366,8 +1369,8 @@ const ( OpsItemRelatedItemsFilterOperatorEqual OpsItemRelatedItemsFilterOperator = "Equal" ) -// Values returns all known values for OpsItemRelatedItemsFilterOperator. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for OpsItemRelatedItemsFilterOperator. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (OpsItemRelatedItemsFilterOperator) Values() []OpsItemRelatedItemsFilterOperator { @@ -1519,9 +1522,9 @@ const ( PatchComplianceDataStateFailed PatchComplianceDataState = "FAILED" ) -// Values returns all known values for PatchComplianceDataState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for PatchComplianceDataState. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchComplianceDataState) Values() []PatchComplianceDataState { return []PatchComplianceDataState{ "INSTALLED", @@ -1570,8 +1573,8 @@ const ( PatchDeploymentStatusExplicitRejected PatchDeploymentStatus = "EXPLICIT_REJECTED" ) -// Values returns all known values for PatchDeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for PatchDeploymentStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (PatchDeploymentStatus) Values() []PatchDeploymentStatus { return []PatchDeploymentStatus{ @@ -1725,9 +1728,9 @@ const ( PlatformTypeMacos PlatformType = "MacOS" ) -// Values returns all known values for PlatformType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PlatformType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PlatformType) Values() []PlatformType { return []PlatformType{ "Windows", @@ -1744,9 +1747,9 @@ const ( RebootOptionNoReboot RebootOption = "NoReboot" ) -// Values returns all known values for RebootOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RebootOption. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RebootOption) Values() []RebootOption { return []RebootOption{ "RebootIfNeeded", @@ -1761,9 +1764,9 @@ const ( ResourceDataSyncS3FormatJsonSerde ResourceDataSyncS3Format = "JsonSerDe" ) -// Values returns all known values for ResourceDataSyncS3Format. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceDataSyncS3Format. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceDataSyncS3Format) Values() []ResourceDataSyncS3Format { return []ResourceDataSyncS3Format{ "JsonSerDe", @@ -1779,9 +1782,9 @@ const ( ResourceTypeEc2Instance ResourceType = "EC2Instance" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "ManagedInstance", @@ -1832,9 +1835,9 @@ const ( ReviewStatusRejected ReviewStatus = "REJECTED" ) -// Values returns all known values for ReviewStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReviewStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReviewStatus) Values() []ReviewStatus { return []ReviewStatus{ "APPROVED", @@ -1878,9 +1881,9 @@ const ( SessionStateHistory SessionState = "History" ) -// Values returns all known values for SessionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for SessionState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (SessionState) Values() []SessionState { return []SessionState{ "Active", diff --git a/service/ssm/types/errors.go b/service/ssm/types/errors.go index a017e367562..d39fc3b073a 100644 --- a/service/ssm/types/errors.go +++ b/service/ssm/types/errors.go @@ -192,8 +192,8 @@ func (e *AssociationVersionLimitExceeded) ErrorCode() string { } func (e *AssociationVersionLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that the Change Manager change template used in the change request was -// rejected or is still in a pending state. +// Indicates that the Change Manager change template used in the change request +// was rejected or is still in a pending state. type AutomationDefinitionNotApprovedException struct { Message *string @@ -335,8 +335,8 @@ func (e *AutomationExecutionNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified step name and execution ID don't exist. Verify the information and -// try again. +// The specified step name and execution ID don't exist. Verify the information +// and try again. type AutomationStepNotFoundException struct { Message *string @@ -503,8 +503,8 @@ func (e *DocumentPermissionLimit) ErrorCode() string { } func (e *DocumentPermissionLimit) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The document has too many versions. Delete one or more document versions and try -// again. +// The document has too many versions. Delete one or more document versions and +// try again. type DocumentVersionLimitExceeded struct { Message *string @@ -532,9 +532,8 @@ func (e *DocumentVersionLimitExceeded) ErrorFault() smithy.ErrorFault { return s // Error returned when the ID specified for a resource, such as a maintenance // window or patch baseline, doesn't exist. For information about resource quotas -// in Amazon Web Services Systems Manager, see Systems Manager service quotas -// (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the -// Amazon Web Services General Reference. +// in Amazon Web Services Systems Manager, see Systems Manager service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. type DoesNotExistException struct { Message *string @@ -668,8 +667,7 @@ func (e *FeatureNotAvailableException) ErrorCode() string { func (e *FeatureNotAvailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // A hierarchy can have a maximum of 15 levels. For more information, see -// Requirements and constraints for parameter names -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html) +// Requirements and constraints for parameter names (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html) // in the Amazon Web Services Systems Manager User Guide. type HierarchyLevelLimitExceededException struct { Message *string @@ -699,8 +697,8 @@ func (e *HierarchyLevelLimitExceededException) ErrorFault() smithy.ErrorFault { } // Parameter Store doesn't support changing a parameter type in a hierarchy. For -// example, you can't change a parameter from a String type to a SecureString type. -// You must create a new, unique parameter. +// example, you can't change a parameter from a String type to a SecureString +// type. You must create a new, unique parameter. type HierarchyTypeMismatchException struct { Message *string @@ -753,9 +751,9 @@ func (e *IdempotentParameterMismatch) ErrorCode() string { } func (e *IdempotentParameterMismatch) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There is a conflict in the policies specified for this parameter. You can't, for -// example, specify two Expiration policies for a parameter. Review your policies, -// and try again. +// There is a conflict in the policies specified for this parameter. You can't, +// for example, specify two Expiration policies for a parameter. Review your +// policies, and try again. type IncompatiblePolicyException struct { Message *string @@ -863,7 +861,7 @@ func (e *InvalidActivationId) ErrorFault() smithy.ErrorFault { return smithy.Fau // The specified aggregator isn't valid for inventory groups. Verify that the // aggregator uses a valid inventory type such as AWS:Application or -// AWS:InstanceInformation. +// AWS:InstanceInformation . type InvalidAggregatorException struct { Message *string @@ -1400,19 +1398,13 @@ func (e *InvalidFilterValue) ErrorCode() string { func (e *InvalidFilterValue) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The following problems can cause this exception: -// -// * You don't have permission to -// access the managed node. -// -// * Amazon Web Services Systems Manager Agent(SSM Agent) -// isn't running. Verify that SSM Agent is running. -// -// * SSM Agent isn't registered -// with the SSM endpoint. Try reinstalling SSM Agent. -// -// * The managed node isn't in -// valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid -// states are: Shutting-down and Terminated. +// - You don't have permission to access the managed node. +// - Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify +// that SSM Agent is running. +// - SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM +// Agent. +// - The managed node isn't in valid state. Valid states are: Running , Pending , +// Stopped , and Stopping . Invalid states are: Shutting-down and Terminated . type InvalidInstanceId struct { Message *string @@ -1492,8 +1484,8 @@ func (e *InvalidInventoryGroupException) ErrorCode() string { } func (e *InvalidInventoryGroupException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You specified invalid keys or values in the Context attribute for InventoryItem. -// Verify the keys and values, and try again. +// You specified invalid keys or values in the Context attribute for InventoryItem +// . Verify the keys and values, and try again. type InvalidInventoryItemContextException struct { Message *string @@ -1627,8 +1619,9 @@ func (e *InvalidNextToken) ErrorCode() string { } func (e *InvalidNextToken) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// One or more configuration items isn't valid. Verify that a valid Amazon Resource -// Name (ARN) was provided for an Amazon Simple Notification Service topic. +// One or more configuration items isn't valid. Verify that a valid Amazon +// Resource Name (ARN) was provided for an Amazon Simple Notification Service +// topic. type InvalidNotificationConfig struct { Message *string @@ -1950,8 +1943,7 @@ func (e *InvalidResultAttributeException) ErrorFault() smithy.ErrorFault { retur // The role name can't contain invalid characters. Also verify that you specified // an IAM role for notifications that includes the required trust policy. For // information about configuring the IAM role for Run Command notifications, see -// Configuring Amazon SNS Notifications for Run Command -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html) +// Configuring Amazon SNS Notifications for Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html) // in the Amazon Web Services Systems Manager User Guide. type InvalidRole struct { Message *string @@ -2244,9 +2236,9 @@ func (e *MaxDocumentSizeExceeded) ErrorCode() string { } func (e *MaxDocumentSizeExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You don't have permission to view OpsItems in the specified account. Verify that -// your account is configured either as a Systems Manager delegated administrator -// or that you are logged into the Organizations management account. +// You don't have permission to view OpsItems in the specified account. Verify +// that your account is configured either as a Systems Manager delegated +// administrator or that you are logged into the Organizations management account. type OpsItemAccessDeniedException struct { Message *string @@ -2330,8 +2322,8 @@ func (e *OpsItemInvalidParameterException) ErrorCode() string { func (e *OpsItemInvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request caused OpsItems to exceed one or more quotas. For information about -// OpsItem quotas, see What are the resource limits for OpsCenter? -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits). +// OpsItem quotas, see What are the resource limits for OpsCenter? (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits) +// . type OpsItemLimitExceededException struct { Message *string @@ -2584,8 +2576,8 @@ func (e *OpsMetadataNotFoundException) ErrorCode() string { } func (e *OpsMetadataNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The system is processing too many concurrent updates. Wait a few moments and try -// again. +// The system is processing too many concurrent updates. Wait a few moments and +// try again. type OpsMetadataTooManyUpdatesException struct { Message *string @@ -2639,8 +2631,8 @@ func (e *ParameterAlreadyExists) ErrorCode() string { } func (e *ParameterAlreadyExists) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have exceeded the number of parameters for this Amazon Web Services account. -// Delete one or more parameters and try again. +// You have exceeded the number of parameters for this Amazon Web Services +// account. Delete one or more parameters and try again. type ParameterLimitExceeded struct { Message *string @@ -2679,10 +2671,8 @@ func (e *ParameterLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy. // versions with mission critical labels assigned to them from being deleted. To // continue creating new parameters, first move the label from the oldest version // of the parameter to a newer one for use in your operations. For information -// about moving parameter labels, see Move a parameter label (console) -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move) -// or Move a parameter label (CLI) -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move) +// about moving parameter labels, see Move a parameter label (console) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move) +// or Move a parameter label (CLI) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move) // in the Amazon Web Services Systems Manager User Guide. type ParameterMaxVersionLimitExceeded struct { Message *string @@ -3015,9 +3005,8 @@ func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault { return smithy. // Error returned when the caller has exceeded the default resource quotas. For // example, too many maintenance windows or patch baselines have been created. For // information about resource quotas in Systems Manager, see Systems Manager -// service quotas -// (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) in the -// Amazon Web Services General Reference. +// service quotas (https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm) +// in the Amazon Web Services General Reference. type ResourceLimitExceededException struct { Message *string @@ -3103,7 +3092,7 @@ func (e *ResourcePolicyInvalidParameterException) ErrorFault() smithy.ErrorFault } // The PutResourcePolicy API action enforces two limits. A policy can't be greater -// than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. +// than 1024 bytes in size. And only one policy can be attached to OpsItemGroup . // Verify these limits and try again. type ResourcePolicyLimitExceededException struct { Message *string @@ -3243,10 +3232,9 @@ func (e *TargetInUseException) ErrorCode() string { } func (e *TargetInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified target managed node for the session isn't fully configured for use -// with Session Manager. For more information, see Getting started with Session -// Manager -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html) +// The specified target managed node for the session isn't fully configured for +// use with Session Manager. For more information, see Getting started with +// Session Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html) // in the Amazon Web Services Systems Manager User Guide. This error is also // returned if you attempt to start a session on a managed node that is located in // a different account or Region @@ -3383,8 +3371,7 @@ func (e *UnsupportedCalendarException) ErrorFault() smithy.ErrorFault { return s // Patching for applications released by Microsoft is only available on EC2 // instances and advanced instances. To patch applications released by Microsoft on // on-premises servers and VMs, you must enable advanced instances. For more -// information, see Enabling the advanced-instances tier -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) +// information, see Enabling the advanced-instances tier (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) // in the Amazon Web Services Systems Manager User Guide. type UnsupportedFeatureRequiredException struct { Message *string @@ -3413,9 +3400,9 @@ func (e *UnsupportedFeatureRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Context attribute that you specified for the InventoryItem isn't allowed for -// this inventory type. You can only use the Context attribute with inventory types -// like AWS:ComplianceItem. +// The Context attribute that you specified for the InventoryItem isn't allowed +// for this inventory type. You can only use the Context attribute with inventory +// types like AWS:ComplianceItem . type UnsupportedInventoryItemContextException struct { Message *string diff --git a/service/ssm/types/types.go b/service/ssm/types/types.go index 381bf52caca..656aa9d711a 100644 --- a/service/ssm/types/types.go +++ b/service/ssm/types/types.go @@ -110,8 +110,8 @@ type AlarmStateInformation struct { // document) and a managed node. type Association struct { - // The ID created by the system when you create an association. An association is a - // binding between a document and a set of targets with a schedule. + // The ID created by the system when you create an association. An association is + // a binding between a document and a set of targets with a schedule. AssociationId *string // The association name. @@ -128,7 +128,7 @@ type Association struct { // Manager always runs the default version of a document if shared from another // account, even though the Systems Manager console shows that a new version was // processed. If you want to run an association using a new version of a document - // shared form another account, you must set the document version to default. + // shared form another account, you must set the document version to default . DocumentVersion *string // The managed node ID. @@ -150,13 +150,13 @@ type Association struct { // Number of days to wait after the scheduled day to run an association. ScheduleOffset *int32 - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The managed nodes targeted by the request to create an association. You can // target all managed nodes in an Amazon Web Services account by specifying the - // InstanceIds key with a value of *. + // InstanceIds key with a value of * . Targets []Target noSmithyDocumentSerde @@ -193,8 +193,8 @@ type AssociationDescription struct { // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // your associations are gated under. The associations only run when that change // calendar is open. For more information, see Amazon Web Services Systems Manager - // Change Calendar - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). + // Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) + // . CalendarNames []string // The severity level that is assigned to the association. @@ -222,10 +222,10 @@ type AssociationDescription struct { // You can specify a number, for example 10, or a percentage of the target set, for // example 10%. The default value is 100%, which means all targets run the // association at the same time. If a new managed node starts and attempts to run - // an association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new + // an association while Systems Manager is running MaxConcurrency associations, + // the association is allowed to run. During the next association interval, the new // managed node will process its association within the limit specified for - // MaxConcurrency. + // MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -234,12 +234,12 @@ type AssociationDescription struct { // 10%. If you specify 3, for example, the system stops sending requests when the // fourth error is received. If you specify 0, then the system stops sending // requests after the first error is returned. If you run an association on 50 - // managed nodes and set MaxError to 10%, then the system stops sending the request - // when the sixth error is received. Executions that are already running an - // association when MaxErrors is reached are allowed to complete, but some of these - // executions may fail as well. If you need to ensure that there won't be more than - // max-errors failed executions, set MaxConcurrency to 1 so that executions proceed - // one at a time. + // managed nodes and set MaxError to 10%, then the system stops sending the + // request when the sixth error is received. Executions that are already running an + // association when MaxErrors is reached are allowed to complete, but some of + // these executions may fail as well. If you need to ensure that there won't be + // more than max-errors failed executions, set MaxConcurrency to 1 so that + // executions proceed one at a time. MaxErrors *string // The name of the SSM document. @@ -263,23 +263,24 @@ type AssociationDescription struct { // The association status. Status *AssociationStatus - // The mode for generating association compliance. You can specify AUTO or MANUAL. + // The mode for generating association compliance. You can specify AUTO or MANUAL . // In AUTO mode, the system uses the status of the association execution to // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems API operation. In - // this case, compliance data isn't managed by State Manager, a capability of - // Amazon Web Services Systems Manager. It is managed by your direct call to the - // PutComplianceItems API operation. By default, all associations use AUTO mode. + // then the association is COMPLIANT . If the association execution doesn't run + // successfully, the association is NON-COMPLIANT . In MANUAL mode, you must + // specify the AssociationId as a parameter for the PutComplianceItems API + // operation. In this case, compliance data isn't managed by State Manager, a + // capability of Amazon Web Services Systems Manager. It is managed by your direct + // call to the PutComplianceItems API operation. By default, all associations use + // AUTO mode. SyncCompliance AssociationSyncCompliance // The combination of Amazon Web Services Regions and Amazon Web Services accounts // where you want to run the association. TargetLocations []TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The managed nodes targeted by the request. @@ -476,9 +477,9 @@ type AssociationVersionInfo struct { // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // your associations are gated under. The associations for this version only run - // when that Change Calendar is open. For more information, see Amazon Web Services - // Systems Manager Change Calendar - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). + // when that Change Calendar is open. For more information, see Amazon Web + // Services Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) + // . CalendarNames []string // The severity level that is assigned to the association. @@ -495,10 +496,10 @@ type AssociationVersionInfo struct { // You can specify a number, for example 10, or a percentage of the target set, for // example 10%. The default value is 100%, which means all targets run the // association at the same time. If a new managed node starts and attempts to run - // an association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new + // an association while Systems Manager is running MaxConcurrency associations, + // the association is allowed to run. During the next association interval, the new // managed node will process its association within the limit specified for - // MaxConcurrency. + // MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -507,12 +508,12 @@ type AssociationVersionInfo struct { // 10%. If you specify 3, for example, the system stops sending requests when the // fourth error is received. If you specify 0, then the system stops sending // requests after the first error is returned. If you run an association on 50 - // managed nodes and set MaxError to 10%, then the system stops sending the request - // when the sixth error is received. Executions that are already running an - // association when MaxErrors is reached are allowed to complete, but some of these - // executions may fail as well. If you need to ensure that there won't be more than - // max-errors failed executions, set MaxConcurrency to 1 so that executions proceed - // one at a time. + // managed nodes and set MaxError to 10%, then the system stops sending the + // request when the sixth error is received. Executions that are already running an + // association when MaxErrors is reached are allowed to complete, but some of + // these executions may fail as well. If you need to ensure that there won't be + // more than max-errors failed executions, set MaxConcurrency to 1 so that + // executions proceed one at a time. MaxErrors *string // The name specified when the association was created. @@ -532,15 +533,16 @@ type AssociationVersionInfo struct { // Number of days to wait after the scheduled day to run an association. ScheduleOffset *int32 - // The mode for generating association compliance. You can specify AUTO or MANUAL. + // The mode for generating association compliance. You can specify AUTO or MANUAL . // In AUTO mode, the system uses the status of the association execution to // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems API operation. In - // this case, compliance data isn't managed by State Manager, a capability of - // Amazon Web Services Systems Manager. It is managed by your direct call to the - // PutComplianceItems API operation. By default, all associations use AUTO mode. + // then the association is COMPLIANT . If the association execution doesn't run + // successfully, the association is NON-COMPLIANT . In MANUAL mode, you must + // specify the AssociationId as a parameter for the PutComplianceItems API + // operation. In this case, compliance data isn't managed by State Manager, a + // capability of Amazon Web Services Systems Manager. It is managed by your direct + // call to the PutComplianceItems API operation. By default, all associations use + // AUTO mode. SyncCompliance AssociationSyncCompliance // The combination of Amazon Web Services Regions and Amazon Web Services accounts @@ -548,8 +550,8 @@ type AssociationVersionInfo struct { // created. TargetLocations []TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The targets specified for the association when the association version was @@ -589,8 +591,9 @@ type AttachmentInformation struct { noSmithyDocumentSerde } -// Identifying information about a document attachment, including the file name and -// a key-value pair that identifies the location of an attachment to a document. +// Identifying information about a document attachment, including the file name +// and a key-value pair that identifies the location of an attachment to a +// document. type AttachmentsSource struct { // The key of a key-value pair that identifies the location of an attachment to a @@ -600,26 +603,20 @@ type AttachmentsSource struct { // The name of the document attachment file. Name *string - // The value of a key-value pair that identifies the location of an attachment to a - // document. The format for Value depends on the type of key you specify. - // - // * For - // the key SourceUrl, the value is an S3 bucket location. For example: "Values": [ - // "s3://doc-example-bucket/my-folder" ] - // - // * For the key S3FileUrl, the value is a - // file in an S3 bucket. For example: "Values": [ - // "s3://doc-example-bucket/my-folder/my-file.py" ] - // - // * For the key - // AttachmentReference, the value is constructed from the name of another SSM - // document in your account, a version number of that document, and a file attached - // to that document version that you want to reuse. For example: "Values": [ - // "MyOtherDocument/3/my-other-file.py" ] However, if the SSM document is shared - // with you from another account, the full SSM document ARN must be specified - // instead of the document name only. For example: "Values": [ - // "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" - // ] + // The value of a key-value pair that identifies the location of an attachment to + // a document. The format for Value depends on the type of key you specify. + // - For the key SourceUrl, the value is an S3 bucket location. For example: + // "Values": [ "s3://doc-example-bucket/my-folder" ] + // - For the key S3FileUrl, the value is a file in an S3 bucket. For example: + // "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ] + // - For the key AttachmentReference, the value is constructed from the name of + // another SSM document in your account, a version number of that document, and a + // file attached to that document version that you want to reuse. For example: + // "Values": [ "MyOtherDocument/3/my-other-file.py" ] However, if the SSM + // document is shared with you from another account, the full SSM document ARN must + // be specified instead of the document name only. For example: "Values": [ + // "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" + // ] Values []string noSmithyDocumentSerde @@ -642,7 +639,7 @@ type AutomationExecution struct { AutomationExecutionStatus AutomationExecutionStatus // The subtype of the Automation operation. Currently, the only supported value is - // ChangeRequest. + // ChangeRequest . AutomationSubtype AutomationSubtype // The name of the Change Manager change request. @@ -690,7 +687,7 @@ type AutomationExecution struct { Outputs map[string][]string // The key-value map of execution parameters, which were supplied when calling - // StartAutomationExecution. + // StartAutomationExecution . Parameters map[string][]string // The AutomationExecutionId of the parent automation. @@ -743,8 +740,8 @@ type AutomationExecution struct { noSmithyDocumentSerde } -// A filter used to match specific automation executions. This is used to limit the -// scope of Automation execution information returned. +// A filter used to match specific automation executions. This is used to limit +// the scope of Automation execution information returned. type AutomationExecutionFilter struct { // One or more keys to limit the results. @@ -777,15 +774,14 @@ type AutomationExecutionMetadata struct { AutomationExecutionStatus AutomationExecutionStatus // The subtype of the Automation operation. Currently, the only supported value is - // ChangeRequest. + // ChangeRequest . AutomationSubtype AutomationSubtype - // Use this filter with DescribeAutomationExecutions. Specify either Local or + // Use this filter with DescribeAutomationExecutions . Specify either Local or // CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web // Services Regions and Amazon Web Services accounts. For more information, see // Running Automation workflows in multiple Amazon Web Services Regions and - // accounts - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) + // accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) // in the Amazon Web Services Systems Manager User Guide. AutomationType AutomationType @@ -842,9 +838,9 @@ type AutomationExecutionMetadata struct { // A list of targets that resolved during the execution. ResolvedTargets *ResolvedTargets - // Information about the Automation runbooks that are run during a runbook workflow - // in Change Manager. The Automation runbooks specified for the runbook workflow - // can't run until all required approvals for the change request have been + // Information about the Automation runbooks that are run during a runbook + // workflow in Change Manager. The Automation runbooks specified for the runbook + // workflow can't run until all required approvals for the change request have been // received. Runbooks []Runbook @@ -877,8 +873,7 @@ type BaselineOverride struct { // A list of explicitly approved patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. ApprovedPatches []string @@ -888,8 +883,8 @@ type BaselineOverride struct { ApprovedPatchesComplianceLevel PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates - // that should be applied to the managed nodes. The default value is false. Applies - // to Linux managed nodes only. + // that should be applied to the managed nodes. The default value is false . + // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity bool // A set of patch filters, typically used for approval rules. @@ -900,8 +895,7 @@ type BaselineOverride struct { // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About - // package name formats for approved and rejected patch lists - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) + // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services Systems Manager User Guide. RejectedPatches []string @@ -921,8 +915,8 @@ type BaselineOverride struct { // Configuration options for sending command output to Amazon CloudWatch Logs. type CloudWatchOutputConfig struct { - // The name of the CloudWatch Logs log group where you want to send command output. - // If you don't specify a group name, Amazon Web Services Systems Manager + // The name of the CloudWatch Logs log group where you want to send command + // output. If you don't specify a group name, Amazon Web Services Systems Manager // automatically creates a log group for you. The log group uses the following // naming format: aws/ssm/SystemsManagerDocumentName CloudWatchLogGroupName *string @@ -950,9 +944,9 @@ type Command struct { // what the command should do. Comment *string - // The number of targets for which the command invocation reached a terminal state. - // Terminal states include the following: Success, Failed, Execution Timed Out, - // Delivery Timed Out, Cancelled, Terminated, or Undeliverable. + // The number of targets for which the command invocation reached a terminal + // state. Terminal states include the following: Success, Failed, Execution Timed + // Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. CompletedCount int32 // The number of targets for which the status is Delivery Timed Out. @@ -968,10 +962,9 @@ type Command struct { ErrorCount int32 // If a command expires, it changes status to DeliveryTimedOut for all invocations - // that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated - // based on the total timeout for the overall command. For more information, see - // Understanding command timeout values - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts) + // that have the status InProgress , Pending , or Delayed . ExpiresAfter is + // calculated based on the total timeout for the overall command. For more + // information, see Understanding command timeout values (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts) // in the Amazon Web Services Systems Manager User Guide. ExpiresAfter *time.Time @@ -981,18 +974,16 @@ type Command struct { // The maximum number of managed nodes that are allowed to run the command at the // same time. You can specify a number of managed nodes, such as 10, or a // percentage of nodes, such as 10%. The default value is 50. For more information - // about how to use MaxConcurrency, see Running commands using Systems Manager Run - // Command - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) + // about how to use MaxConcurrency , see Running commands using Systems Manager + // Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) // in the Amazon Web Services Systems Manager User Guide. MaxConcurrency *string - // The maximum number of errors allowed before the system stops sending the command - // to additional targets. You can specify a number of errors, such as 10, or a - // percentage or errors, such as 10%. The default value is 0. For more information - // about how to use MaxErrors, see Running commands using Systems Manager Run - // Command - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) + // The maximum number of errors allowed before the system stops sending the + // command to additional targets. You can specify a number of errors, such as 10, + // or a percentage or errors, such as 10%. The default value is 0 . For more + // information about how to use MaxErrors , see Running commands using Systems + // Manager Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) // in the Amazon Web Services Systems Manager User Guide. MaxErrors *string @@ -1030,46 +1021,30 @@ type Command struct { // information than Status because it includes states resulting from error and // concurrency control parameters. StatusDetails can show different results than // Status. For more information about these statuses, see Understanding command - // statuses - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) + // statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one // of the following values: - // - // * Pending: The command hasn't been sent to any managed - // nodes. - // - // * In Progress: The command has been sent to at least one managed node - // but hasn't reached a final state on all managed nodes. - // - // * Success: The command - // successfully ran on all invocations. This is a terminal state. - // - // * Delivery Timed - // Out: The value of MaxErrors or more command invocations shows a status of - // Delivery Timed Out. This is a terminal state. - // - // * Execution Timed Out: The value - // of MaxErrors or more command invocations shows a status of Execution Timed Out. - // This is a terminal state. - // - // * Failed: The value of MaxErrors or more command - // invocations shows a status of Failed. This is a terminal state. - // - // * Incomplete: - // The command was attempted on all managed nodes and one or more invocations - // doesn't have a value of Success but not enough invocations failed for the status - // to be Failed. This is a terminal state. - // - // * Cancelled: The command was terminated - // before it was completed. This is a terminal state. - // - // * Rate Exceeded: The number - // of managed nodes targeted by the command exceeded the account limit for pending - // invocations. The system has canceled the command before running it on any - // managed node. This is a terminal state. - // - // * Delayed: The system attempted to send - // the command to the managed node but wasn't successful. The system retries again. + // - Pending: The command hasn't been sent to any managed nodes. + // - In Progress: The command has been sent to at least one managed node but + // hasn't reached a final state on all managed nodes. + // - Success: The command successfully ran on all invocations. This is a + // terminal state. + // - Delivery Timed Out: The value of MaxErrors or more command invocations + // shows a status of Delivery Timed Out. This is a terminal state. + // - Execution Timed Out: The value of MaxErrors or more command invocations + // shows a status of Execution Timed Out. This is a terminal state. + // - Failed: The value of MaxErrors or more command invocations shows a status + // of Failed. This is a terminal state. + // - Incomplete: The command was attempted on all managed nodes and one or more + // invocations doesn't have a value of Success but not enough invocations failed + // for the status to be Failed. This is a terminal state. + // - Cancelled: The command was terminated before it was completed. This is a + // terminal state. + // - Rate Exceeded: The number of managed nodes targeted by the command exceeded + // the account limit for pending invocations. The system has canceled the command + // before running it on any managed node. This is a terminal state. + // - Delayed: The system attempted to send the command to the managed node but + // wasn't successful. The system retries again. StatusDetails *string // The number of targets for the command. @@ -1094,100 +1069,56 @@ type Command struct { type CommandFilter struct { // The name of the filter. The ExecutionStage filter can't be used with the - // ListCommandInvocations operation, only with ListCommands. + // ListCommandInvocations operation, only with ListCommands . // // This member is required. Key CommandFilterKey // The filter value. Valid values for each filter key are as follows: - // - // * - // InvokedAfter: Specify a timestamp to limit your results. For example, specify - // 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, - // and later. - // - // * InvokedBefore: Specify a timestamp to limit your results. For - // example, specify 2021-07-07T00:00:00Z to see a list of command executions from - // before July 7, 2021. - // - // * Status: Specify a valid command status to see a list of - // all command executions with that status. The status choices depend on the API - // you call. The status values you can specify for ListCommands are: - // - // * Pending - // - // * - // InProgress - // - // * Success - // - // * Cancelled - // - // * Failed - // - // * TimedOut (this includes both - // Delivery and Execution time outs) - // - // * AccessDenied - // - // * DeliveryTimedOut - // - // * - // ExecutionTimedOut - // - // * Incomplete - // - // * NoInstancesInTag - // - // * LimitExceeded - // - // The status - // values you can specify for ListCommandInvocations are: - // - // * Pending - // - // * - // InProgress - // - // * Delayed - // - // * Success - // - // * Cancelled - // - // * Failed - // - // * TimedOut (this - // includes both Delivery and Execution time outs) - // - // * AccessDenied - // - // * - // DeliveryTimedOut - // - // * ExecutionTimedOut - // - // * Undeliverable - // - // * InvalidPlatform - // - // * - // Terminated - // - // * DocumentName: Specify name of the Amazon Web Services Systems - // Manager document (SSM document) for which you want to see command execution - // results. For example, specify AWS-RunPatchBaseline to see command executions - // that used this SSM document to perform security patching operations on managed - // nodes. - // - // * ExecutionStage: Specify one of the following values (ListCommands - // operations only): - // - // * Executing: Returns a list of command executions that are - // currently still running. - // - // * Complete: Returns a list of command executions that - // have already completed. + // - InvokedAfter: Specify a timestamp to limit your results. For example, + // specify 2021-07-07T00:00:00Z to see a list of command executions occurring + // July 7, 2021, and later. + // - InvokedBefore: Specify a timestamp to limit your results. For example, + // specify 2021-07-07T00:00:00Z to see a list of command executions from before + // July 7, 2021. + // - Status: Specify a valid command status to see a list of all command + // executions with that status. The status choices depend on the API you call. The + // status values you can specify for ListCommands are: + // - Pending + // - InProgress + // - Success + // - Cancelled + // - Failed + // - TimedOut (this includes both Delivery and Execution time outs) + // - AccessDenied + // - DeliveryTimedOut + // - ExecutionTimedOut + // - Incomplete + // - NoInstancesInTag + // - LimitExceeded The status values you can specify for ListCommandInvocations + // are: + // - Pending + // - InProgress + // - Delayed + // - Success + // - Cancelled + // - Failed + // - TimedOut (this includes both Delivery and Execution time outs) + // - AccessDenied + // - DeliveryTimedOut + // - ExecutionTimedOut + // - Undeliverable + // - InvalidPlatform + // - Terminated + // - DocumentName: Specify name of the Amazon Web Services Systems Manager + // document (SSM document) for which you want to see command execution results. For + // example, specify AWS-RunPatchBaseline to see command executions that used this + // SSM document to perform security patching operations on managed nodes. + // - ExecutionStage: Specify one of the following values ( ListCommands + // operations only): + // - Executing : Returns a list of command executions that are currently still + // running. + // - Complete : Returns a list of command executions that have already completed. // // This member is required. Value *string @@ -1261,53 +1192,38 @@ type CommandInvocation struct { // node targeted by the command). StatusDetails includes more information than // Status because it includes states resulting from error and concurrency control // parameters. StatusDetails can show different results than Status. For more - // information about these statuses, see Understanding command statuses - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) + // information about these statuses, see Understanding command statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one // of the following values: - // - // * Pending: The command hasn't been sent to the managed - // node. - // - // * In Progress: The command has been sent to the managed node but hasn't - // reached a terminal state. - // - // * Success: The execution of the command or plugin was - // successfully completed. This is a terminal state. - // - // * Delivery Timed Out: The - // command wasn't delivered to the managed node before the delivery timeout - // expired. Delivery timeouts don't count against the parent command's MaxErrors - // limit, but they do contribute to whether the parent command status is Success or - // Incomplete. This is a terminal state. - // - // * Execution Timed Out: Command execution - // started on the managed node, but the execution wasn't complete before the - // execution timeout expired. Execution timeouts count against the MaxErrors limit - // of the parent command. This is a terminal state. - // - // * Failed: The command wasn't - // successful on the managed node. For a plugin, this indicates that the result - // code wasn't zero. For a command invocation, this indicates that the result code - // for one or more plugins wasn't zero. Invocation failures count against the - // MaxErrors limit of the parent command. This is a terminal state. - // - // * Cancelled: - // The command was terminated before it was completed. This is a terminal state. - // - // * - // Undeliverable: The command can't be delivered to the managed node. The managed - // node might not exist or might not be responding. Undeliverable invocations don't - // count against the parent command's MaxErrors limit and don't contribute to - // whether the parent command status is Success or Incomplete. This is a terminal - // state. - // - // * Terminated: The parent command exceeded its MaxErrors limit and - // subsequent command invocations were canceled by the system. This is a terminal - // state. - // - // * Delayed: The system attempted to send the command to the managed node - // but wasn't successful. The system retries again. + // - Pending: The command hasn't been sent to the managed node. + // - In Progress: The command has been sent to the managed node but hasn't + // reached a terminal state. + // - Success: The execution of the command or plugin was successfully completed. + // This is a terminal state. + // - Delivery Timed Out: The command wasn't delivered to the managed node before + // the delivery timeout expired. Delivery timeouts don't count against the parent + // command's MaxErrors limit, but they do contribute to whether the parent + // command status is Success or Incomplete. This is a terminal state. + // - Execution Timed Out: Command execution started on the managed node, but the + // execution wasn't complete before the execution timeout expired. Execution + // timeouts count against the MaxErrors limit of the parent command. This is a + // terminal state. + // - Failed: The command wasn't successful on the managed node. For a plugin, + // this indicates that the result code wasn't zero. For a command invocation, this + // indicates that the result code for one or more plugins wasn't zero. Invocation + // failures count against the MaxErrors limit of the parent command. This is a + // terminal state. + // - Cancelled: The command was terminated before it was completed. This is a + // terminal state. + // - Undeliverable: The command can't be delivered to the managed node. The + // managed node might not exist or might not be responding. Undeliverable + // invocations don't count against the parent command's MaxErrors limit and don't + // contribute to whether the parent command status is Success or Incomplete. This + // is a terminal state. + // - Terminated: The parent command exceeded its MaxErrors limit and subsequent + // command invocations were canceled by the system. This is a terminal state. + // - Delayed: The system attempted to send the command to the managed node but + // wasn't successful. The system retries again. StatusDetails *string // Gets the trace output sent by the agent. @@ -1319,9 +1235,9 @@ type CommandInvocation struct { // Describes plugin details. type CommandPlugin struct { - // The name of the plugin. Must be one of the following: aws:updateAgent, - // aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, - // aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent. + // The name of the plugin. Must be one of the following: aws:updateAgent , + // aws:domainjoin , aws:applications , aws:runPowerShellScript , aws:psmodule , + // aws:cloudWatch , aws:runShellScript , or aws:updateSSMAgent . Name *string // Output of the plugin execution. @@ -1330,19 +1246,21 @@ type CommandPlugin struct { // The S3 bucket where the responses to the command executions should be stored. // This was requested when issuing the command. For example, in the following // response: - // doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScriptdoc-example-bucket - // is the name of the S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the - // name of the S3 prefix; i-02573cafcfEXAMPLE is the managed node ID; - // awsrunShellScript is the name of the plugin. + // doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript + // doc-example-bucket is the name of the S3 bucket; + // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; + // i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of + // the plugin. OutputS3BucketName *string // The S3 directory path inside the bucket where the responses to the command // executions should be stored. This was requested when issuing the command. For // example, in the following response: - // doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScriptdoc-example-bucket - // is the name of the S3 bucket; ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the - // name of the S3 prefix; i-02573cafcfEXAMPLE is the managed node ID; - // awsrunShellScript is the name of the plugin. + // doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript + // doc-example-bucket is the name of the S3 bucket; + // ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix; + // i-02573cafcfEXAMPLE is the managed node ID; awsrunShellScript is the name of + // the plugin. OutputS3KeyPrefix *string // (Deprecated) You can no longer specify this parameter. The system ignores it. @@ -1375,57 +1293,43 @@ type CommandPlugin struct { // information than Status because it includes states resulting from error and // concurrency control parameters. StatusDetails can show different results than // Status. For more information about these statuses, see Understanding command - // statuses - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) + // statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one // of the following values: - // - // * Pending: The command hasn't been sent to the managed - // node. - // - // * In Progress: The command has been sent to the managed node but hasn't - // reached a terminal state. - // - // * Success: The execution of the command or plugin was - // successfully completed. This is a terminal state. - // - // * Delivery Timed Out: The - // command wasn't delivered to the managed node before the delivery timeout - // expired. Delivery timeouts don't count against the parent command's MaxErrors - // limit, but they do contribute to whether the parent command status is Success or - // Incomplete. This is a terminal state. - // - // * Execution Timed Out: Command execution - // started on the managed node, but the execution wasn't complete before the - // execution timeout expired. Execution timeouts count against the MaxErrors limit - // of the parent command. This is a terminal state. - // - // * Failed: The command wasn't - // successful on the managed node. For a plugin, this indicates that the result - // code wasn't zero. For a command invocation, this indicates that the result code - // for one or more plugins wasn't zero. Invocation failures count against the - // MaxErrors limit of the parent command. This is a terminal state. - // - // * Cancelled: - // The command was terminated before it was completed. This is a terminal state. - // - // * - // Undeliverable: The command can't be delivered to the managed node. The managed - // node might not exist, or it might not be responding. Undeliverable invocations - // don't count against the parent command's MaxErrors limit, and they don't - // contribute to whether the parent command status is Success or Incomplete. This - // is a terminal state. - // - // * Terminated: The parent command exceeded its MaxErrors - // limit and subsequent command invocations were canceled by the system. This is a - // terminal state. + // - Pending: The command hasn't been sent to the managed node. + // - In Progress: The command has been sent to the managed node but hasn't + // reached a terminal state. + // - Success: The execution of the command or plugin was successfully completed. + // This is a terminal state. + // - Delivery Timed Out: The command wasn't delivered to the managed node before + // the delivery timeout expired. Delivery timeouts don't count against the parent + // command's MaxErrors limit, but they do contribute to whether the parent + // command status is Success or Incomplete. This is a terminal state. + // - Execution Timed Out: Command execution started on the managed node, but the + // execution wasn't complete before the execution timeout expired. Execution + // timeouts count against the MaxErrors limit of the parent command. This is a + // terminal state. + // - Failed: The command wasn't successful on the managed node. For a plugin, + // this indicates that the result code wasn't zero. For a command invocation, this + // indicates that the result code for one or more plugins wasn't zero. Invocation + // failures count against the MaxErrors limit of the parent command. This is a + // terminal state. + // - Cancelled: The command was terminated before it was completed. This is a + // terminal state. + // - Undeliverable: The command can't be delivered to the managed node. The + // managed node might not exist, or it might not be responding. Undeliverable + // invocations don't count against the parent command's MaxErrors limit, and they + // don't contribute to whether the parent command status is Success or Incomplete. + // This is a terminal state. + // - Terminated: The parent command exceeded its MaxErrors limit and subsequent + // command invocations were canceled by the system. This is a terminal state. StatusDetails *string noSmithyDocumentSerde } // A summary of the call execution that includes an execution ID, the type of -// execution (for example, Command), and the date/time of the execution using a +// execution (for example, Command ), and the date/time of the execution using a // datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. type ComplianceExecutionSummary struct { @@ -1450,8 +1354,8 @@ type ComplianceExecutionSummary struct { // Classification, and so on. type ComplianceItem struct { - // The compliance type. For example, Association (for a State Manager association), - // Patch, or Custom:string are all valid compliance types. + // The compliance type. For example, Association (for a State Manager + // association), Patch, or Custom: string are all valid compliance types. ComplianceType *string // A "Key": "Value" tag combination for the compliance item. @@ -1549,8 +1453,8 @@ type ComplianceSummaryItem struct { noSmithyDocumentSerde } -// A summary of resources that are compliant. The summary is organized according to -// the resource count for each compliance type. +// A summary of resources that are compliant. The summary is organized according +// to the resource count for each compliance type. type CompliantSummary struct { // The total number of resources that are compliant. @@ -1562,21 +1466,21 @@ type CompliantSummary struct { noSmithyDocumentSerde } -// Describes the association of a Amazon Web Services Systems Manager document (SSM -// document) and a managed node. +// Describes the association of a Amazon Web Services Systems Manager document +// (SSM document) and a managed node. type CreateAssociationBatchRequestEntry struct { - // The name of the SSM document that contains the configuration information for the - // managed node. You can specify Command or Automation runbooks. You can specify - // Amazon Web Services-predefined documents, documents you created, or a document - // that is shared with you from another account. For SSM documents that are shared - // with you from other Amazon Web Services accounts, you must specify the complete - // SSM document ARN, in the following format: - // arn:aws:ssm:region:account-id:document/document-name For example: + // The name of the SSM document that contains the configuration information for + // the managed node. You can specify Command or Automation runbooks. You can + // specify Amazon Web Services-predefined documents, documents you created, or a + // document that is shared with you from another account. For SSM documents that + // are shared with you from other Amazon Web Services accounts, you must specify + // the complete SSM document ARN, in the following format: + // arn:aws:ssm:region:account-id:document/document-name For example: // arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For Amazon Web // Services-predefined documents and SSM documents you created in your account, you // only need to specify the document name. For example, AWS-ApplyPatchBaseline or - // My-Document. + // My-Document . // // This member is required. Name *string @@ -1594,16 +1498,16 @@ type CreateAssociationBatchRequestEntry struct { // Specify a descriptive name for the association. AssociationName *string - // Specify the target for the association. This target is required for associations - // that use an Automation runbook and target resources by using rate controls. - // Automation is a capability of Amazon Web Services Systems Manager. + // Specify the target for the association. This target is required for + // associations that use an Automation runbook and target resources by using rate + // controls. Automation is a capability of Amazon Web Services Systems Manager. AutomationTargetParameterName *string // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // your associations are gated under. The associations only run when that Change // Calendar is open. For more information, see Amazon Web Services Systems Manager - // Change Calendar - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). + // Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) + // . CalendarNames []string // The severity level to assign to the association. @@ -1616,19 +1520,19 @@ type CreateAssociationBatchRequestEntry struct { // ID for an association, use the Targets parameter. Requests that include the // parameter InstanceID with Systems Manager documents (SSM documents) that use // schema version 2.0 or later will fail. In addition, if you use the parameter - // InstanceId, you can't use the parameters AssociationName, DocumentVersion, - // MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these - // parameters, you must use the Targets parameter. + // InstanceId , you can't use the parameters AssociationName , DocumentVersion , + // MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use + // these parameters, you must use the Targets parameter. InstanceId *string // The maximum number of targets allowed to run the association at the same time. // You can specify a number, for example 10, or a percentage of the target set, for // example 10%. The default value is 100%, which means all targets run the // association at the same time. If a new managed node starts and attempts to run - // an association while Systems Manager is running MaxConcurrency associations, the - // association is allowed to run. During the next association interval, the new + // an association while Systems Manager is running MaxConcurrency associations, + // the association is allowed to run. During the next association interval, the new // managed node will process its association within the limit specified for - // MaxConcurrency. + // MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -1637,12 +1541,12 @@ type CreateAssociationBatchRequestEntry struct { // 10%. If you specify 3, for example, the system stops sending requests when the // fourth error is received. If you specify 0, then the system stops sending // requests after the first error is returned. If you run an association on 50 - // managed nodes and set MaxError to 10%, then the system stops sending the request - // when the sixth error is received. Executions that are already running an - // association when MaxErrors is reached are allowed to complete, but some of these - // executions may fail as well. If you need to ensure that there won't be more than - // max-errors failed executions, set MaxConcurrency to 1 so that executions proceed - // one at a time. + // managed nodes and set MaxError to 10%, then the system stops sending the + // request when the sixth error is received. Executions that are already running an + // association when MaxErrors is reached are allowed to complete, but some of + // these executions may fail as well. If you need to ensure that there won't be + // more than max-errors failed executions, set MaxConcurrency to 1 so that + // executions proceed one at a time. MaxErrors *string // An S3 bucket where you want to store the results of this request. @@ -1657,23 +1561,24 @@ type CreateAssociationBatchRequestEntry struct { // Number of days to wait after the scheduled day to run an association. ScheduleOffset *int32 - // The mode for generating association compliance. You can specify AUTO or MANUAL. + // The mode for generating association compliance. You can specify AUTO or MANUAL . // In AUTO mode, the system uses the status of the association execution to // determine the compliance status. If the association execution runs successfully, - // then the association is COMPLIANT. If the association execution doesn't run - // successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify - // the AssociationId as a parameter for the PutComplianceItems API operation. In - // this case, compliance data isn't managed by State Manager, a capability of - // Amazon Web Services Systems Manager. It is managed by your direct call to the - // PutComplianceItems API operation. By default, all associations use AUTO mode. + // then the association is COMPLIANT . If the association execution doesn't run + // successfully, the association is NON-COMPLIANT . In MANUAL mode, you must + // specify the AssociationId as a parameter for the PutComplianceItems API + // operation. In this case, compliance data isn't managed by State Manager, a + // capability of Amazon Web Services Systems Manager. It is managed by your direct + // call to the PutComplianceItems API operation. By default, all associations use + // AUTO mode. SyncCompliance AssociationSyncCompliance // Use this action to create an association in multiple Regions and multiple // accounts. TargetLocations []TargetLocation - // A key-value mapping of document parameters to target resources. Both Targets and - // TargetMaps can't be specified together. + // A key-value mapping of document parameters to target resources. Both Targets + // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The managed nodes targeted by the request. @@ -1737,8 +1642,8 @@ type DocumentDescription struct { // A description of the document. Description *string - // The friendly name of the SSM document. This value can differ for each version of - // the document. If you want to update this value, see UpdateDocument. + // The friendly name of the SSM document. This value can differ for each version + // of the document. If you want to update this value, see UpdateDocument . DisplayName *string // The document format, either JSON or YAML. @@ -1754,7 +1659,7 @@ type DocumentDescription struct { // Sha1 hashes have been deprecated. Hash *string - // The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes + // The hash type of the document. Valid values include Sha256 or Sha1 . Sha1 hashes // have been deprecated. HashType DocumentHashType @@ -1806,9 +1711,8 @@ type DocumentDescription struct { Tags []Tag // The target type which defines the kinds of resources the document can run on. - // For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon - // Web Services resource and property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // For example, /AWS::EC2::Instance . For a list of valid resource types, see + // Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. TargetType *string @@ -1818,7 +1722,7 @@ type DocumentDescription struct { noSmithyDocumentSerde } -// This data type is deprecated. Instead, use DocumentKeyValuesFilter. +// This data type is deprecated. Instead, use DocumentKeyValuesFilter . type DocumentFilter struct { // The name of the filter. @@ -1845,7 +1749,7 @@ type DocumentIdentifier struct { // An optional field where you can specify a friendly name for the SSM document. // This value can differ for each version of the document. If you want to update - // this value, see UpdateDocument. + // this value, see UpdateDocument . DisplayName *string // The document format, either JSON or YAML. @@ -1881,9 +1785,8 @@ type DocumentIdentifier struct { Tags []Tag // The target type which defines the kinds of resources the document can run on. - // For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon - // Web Services resource and property types reference - // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) + // For example, /AWS::EC2::Instance . For a list of valid resource types, see + // Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. TargetType *string @@ -1900,59 +1803,39 @@ type DocumentIdentifier struct { // You can also use Amazon Web Services-provided keys, some of which have specific // allowed values. These keys and their associated values are as follows: // DocumentType +// - ApplicationConfiguration +// - ApplicationConfigurationSchema +// - Automation +// - ChangeCalendar +// - Command +// - Package +// - Policy +// - Session // -// * ApplicationConfiguration -// -// * ApplicationConfigurationSchema -// -// * -// Automation -// -// * ChangeCalendar -// -// * Command -// -// * Package -// -// * Policy -// -// * Session -// -// Owner -// Note that only one Owner can be specified in a request. For example: -// Key=Owner,Values=Self. -// -// * Amazon +// Owner Note that only one Owner can be specified in a request. For example: +// Key=Owner,Values=Self . +// - Amazon +// - Private +// - Public +// - Self +// - ThirdParty // -// * Private +// PlatformTypes +// - Linux +// - Windows // -// * Public -// -// * Self -// -// * -// ThirdParty -// -// # PlatformTypes -// -// * Linux -// -// * Windows -// -// Name is another Amazon Web -// Services-provided key. If you use Name as a key, you can use a name prefix to -// return a list of documents. For example, in the Amazon Web Services CLI, to -// return a list of all documents that begin with Te, run the following command: -// aws ssm list-documents --filters Key=Name,Values=Te You can also use the -// TargetType Amazon Web Services-provided key. For a list of valid resource type -// values that can be used with this key, see Amazon Web Services resource and -// property types reference -// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) +// Name is another Amazon Web Services-provided key. If you use Name as a key, you +// can use a name prefix to return a list of documents. For example, in the Amazon +// Web Services CLI, to return a list of all documents that begin with Te , run the +// following command: aws ssm list-documents --filters Key=Name,Values=Te You can +// also use the TargetType Amazon Web Services-provided key. For a list of valid +// resource type values that can be used with this key, see Amazon Web Services +// resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. If you specify more than two keys, only // documents that are identified by all the tags are returned in the results. If // you specify more than two values for a key, documents that are identified by any // of the values are returned in the results. To specify a custom key-value pair, -// use the format Key=tag:tagName,Values=valueName. For example, if you created a +// use the format Key=tag:tagName,Values=valueName . For example, if you created a // key called region and are using the Amazon Web Services CLI to call the // list-documents command: aws ssm list-documents --filters // Key=tag:region,Values=east,west Key=Owner,Values=Self @@ -2082,8 +1965,8 @@ type DocumentVersionInfo struct { // The date the document was created. CreatedDate *time.Time - // The friendly name of the SSM document. This value can differ for each version of - // the document. If you want to update this value, see UpdateDocument. + // The friendly name of the SSM document. This value can differ for each version + // of the document. If you want to update this value, see UpdateDocument . DisplayName *string // The document format, either JSON or YAML. @@ -2102,7 +1985,8 @@ type DocumentVersionInfo struct { // document. ReviewStatus ReviewStatus - // The status of the SSM document, such as Creating, Active, Failed, and Deleting. + // The status of the SSM document, such as Creating , Active , Failed , and + // Deleting . Status DocumentStatus // A message returned by Amazon Web Services Systems Manager that explains the @@ -2173,15 +2057,15 @@ type FailureDetails struct { noSmithyDocumentSerde } -// A resource policy helps you to define the IAM entity (for example, an Amazon Web -// Services account) that can manage your Systems Manager resources. Currently, +// A resource policy helps you to define the IAM entity (for example, an Amazon +// Web Services account) that can manage your Systems Manager resources. Currently, // OpsItemGroup is the only resource that supports Systems Manager resource // policies. The resource policy for OpsItemGroup enables Amazon Web Services // accounts to view and interact with OpsCenter operational work items (OpsItems). type GetResourcePoliciesResponseEntry struct { - // A resource policy helps you to define the IAM entity (for example, an Amazon Web - // Services account) that can manage your Systems Manager resources. Currently, + // A resource policy helps you to define the IAM entity (for example, an Amazon + // Web Services account) that can manage your Systems Manager resources. Currently, // OpsItemGroup is the only resource that supports Systems Manager resource // policies. The resource policy for OpsItemGroup enables Amazon Web Services // accounts to view and interact with OpsCenter operational work items (OpsItems). @@ -2230,8 +2114,7 @@ type InstanceAssociation struct { // An S3 bucket where you want to store the results of this request. For the // minimal permissions required to enable Amazon S3 output for an association, see -// Creating associations -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html) +// Creating associations (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html) // in the Systems Manager User Guide. type InstanceAssociationOutputLocation struct { @@ -2295,8 +2178,8 @@ type InstanceAssociationStatusInfo struct { // Describes a filter for a specific list of managed nodes. type InstanceInformation struct { - // The activation ID created by Amazon Web Services Systems Manager when the server - // or virtual machine (VM) was registered. + // The activation ID created by Amazon Web Services Systems Manager when the + // server or virtual machine (VM) was registered. ActivationId *string // The version of SSM Agent running on your Linux managed node. @@ -2318,11 +2201,9 @@ type InstanceInformation struct { // Systems Manager managed node. This call doesn't return the IAM role for Amazon // Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an // EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, - // see DescribeInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) - // in the Amazon EC2 API Reference or describe-instances - // (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) in the - // Amazon Web Services CLI Command Reference. + // see DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) + // in the Amazon EC2 API Reference or describe-instances (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) + // in the Amazon Web Services CLI Command Reference. IamRole *string // The managed node ID. @@ -2343,21 +2224,17 @@ type InstanceInformation struct { // The last date the association was successfully run. LastSuccessfulAssociationExecutionDate *time.Time - // The name assigned to an on-premises server, edge device, or virtual machine (VM) - // when it is activated as a Systems Manager managed node. The name is specified as - // the DefaultInstanceName property using the CreateActivation command. It is - // applied to the managed node by specifying the Activation Code and Activation ID - // when you install SSM Agent on the node, as explained in Install SSM Agent for a - // hybrid environment (Linux) - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html) - // and Install SSM Agent for a hybrid environment (Windows) - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html). - // To retrieve the Name tag of an EC2 instance, use the Amazon EC2 - // DescribeInstances operation. For information, see DescribeInstances - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) - // in the Amazon EC2 API Reference or describe-instances - // (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) in the - // Amazon Web Services CLI Command Reference. + // The name assigned to an on-premises server, edge device, or virtual machine + // (VM) when it is activated as a Systems Manager managed node. The name is + // specified as the DefaultInstanceName property using the CreateActivation + // command. It is applied to the managed node by specifying the Activation Code and + // Activation ID when you install SSM Agent on the node, as explained in Install + // SSM Agent for a hybrid environment (Linux) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html) + // and Install SSM Agent for a hybrid environment (Windows) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html) + // . To retrieve the Name tag of an EC2 instance, use the Amazon EC2 + // DescribeInstances operation. For information, see DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) + // in the Amazon EC2 API Reference or describe-instances (https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html) + // in the Amazon Web Services CLI Command Reference. Name *string // Connection status of SSM Agent. The status Inactive has been deprecated and is @@ -2380,12 +2257,12 @@ type InstanceInformation struct { // The type of instance. Instances are either EC2 instances or managed instances. ResourceType ResourceType - // The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing - // name. + // The ID of the source resource. For IoT Greengrass devices, SourceId is the + // Thing name. SourceId *string // The type of the source resource. For IoT Greengrass devices, SourceType is - // AWS::IoT::Thing. + // AWS::IoT::Thing . SourceType SourceType noSmithyDocumentSerde @@ -2395,8 +2272,7 @@ type InstanceInformation struct { // information by using tags. You specify tags by using a key-value mapping. Use // this operation instead of the // DescribeInstanceInformationRequest$InstanceInformationFilterList method. The -// InstanceInformationFilterList method is a legacy method and doesn't support -// tags. +// InstanceInformationFilterList method is a legacy method and doesn't support tags. type InstanceInformationFilter struct { // The name of the filter. @@ -2418,25 +2294,17 @@ type InstanceInformationStringFilter struct { // The filter key name to describe your managed nodes. Valid filter key values: // ActivationIds | AgentVersion | AssociationStatus | IamRole | InstanceIds | // PingStatus | PlatformTypes | ResourceType | SourceIds | SourceTypes | "tag-key" - // | "tag:{keyname} - // - // * Valid values for the AssociationStatus filter key: Success | - // Pending | Failed - // - // * Valid values for the PingStatus filter key: Online | - // ConnectionLost | Inactive (deprecated) - // - // * Valid values for the PlatformType - // filter key: Windows | Linux | MacOS - // - // * Valid values for the ResourceType filter - // key: EC2Instance | ManagedInstance - // - // * Valid values for the SourceType filter - // key: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing - // - // * Valid - // tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test. + // | "tag: {keyname} + // - Valid values for the AssociationStatus filter key: Success | Pending | + // Failed + // - Valid values for the PingStatus filter key: Online | ConnectionLost | + // Inactive (deprecated) + // - Valid values for the PlatformType filter key: Windows | Linux | MacOS + // - Valid values for the ResourceType filter key: EC2Instance | ManagedInstance + // - Valid values for the SourceType filter key: AWS::EC2::Instance | + // AWS::SSM::ManagedInstance | AWS::IoT::Thing + // - Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test + // . // // This member is required. Key *string @@ -2467,11 +2335,8 @@ type InstancePatchState struct { InstanceId *string // The type of patching operation that was performed: or - // - // * SCAN assesses the patch - // compliance state. - // - // * INSTALL installs missing patches. + // - SCAN assesses the patch compliance state. + // - INSTALL installs missing patches. // // This member is required. Operation PatchOperationType @@ -2495,20 +2360,19 @@ type InstancePatchState struct { // reporting in the patch baseline aren't installed. These patches might be // missing, have failed installation, were rejected, or were installed but awaiting // a required managed node reboot. The status of these managed nodes is - // NON_COMPLIANT. + // NON_COMPLIANT . CriticalNonCompliantCount *int32 // The number of patches from the patch baseline that were attempted to be // installed during the last patching operation, but failed to install. FailedCount int32 - // An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a - // list of patches to be installed. This patch installation list, which you + // An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to + // a list of patches to be installed. This patch installation list, which you // maintain in an S3 bucket in YAML format and specify in the SSM document - // AWS-RunPatchBaseline, overrides the patches specified by the default patch + // AWS-RunPatchBaseline , overrides the patches specified by the default patch // baseline. For more information about the InstallOverrideList parameter, see - // About the AWS-RunPatchBaseline - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) + // About the AWS-RunPatchBaseline (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) // SSM document in the Amazon Web Services Systems Manager User Guide. InstallOverrideList *string @@ -2520,15 +2384,15 @@ type InstancePatchState struct { // the managed node. InstalledOtherCount int32 - // The number of patches installed by Patch Manager since the last time the managed - // node was rebooted. + // The number of patches installed by Patch Manager since the last time the + // managed node was rebooted. InstalledPendingRebootCount *int32 // The number of patches installed on a managed node that are specified in a // RejectedPatches list. Patches with a status of InstalledRejected were typically // installed before they were added to a RejectedPatches list. If - // ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value - // of InstalledRejectedCount will always be 0 (zero). + // ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction , the + // value of InstalledRejectedCount will always be 0 (zero). InstalledRejectedCount *int32 // The time of the last attempt to patch the managed node with NoReboot specified @@ -2542,12 +2406,12 @@ type InstancePatchState struct { // The number of patches from the patch baseline that aren't applicable for the // managed node and therefore aren't installed on the node. This number may be // truncated if the list of patch names is very large. The number of patches beyond - // this limit are reported in UnreportedNotApplicableCount. + // this limit are reported in UnreportedNotApplicableCount . NotApplicableCount int32 // The number of patches per node that are specified as other than Critical or // Security but aren't compliant with the patch baseline. The status of these - // managed nodes is NON_COMPLIANT. + // managed nodes is NON_COMPLIANT . OtherNonCompliantCount *int32 // Placeholder information. This field will always be empty in the current release @@ -2557,21 +2421,19 @@ type InstancePatchState struct { // Indicates the reboot option specified in the patch baseline. Reboot options // apply to Install operations only. Reboots aren't attempted for Patch Manager // Scan operations. - // - // * RebootIfNeeded: Patch Manager tries to reboot the managed - // node if it installed any patches, or if any patches are detected with a status - // of InstalledPendingReboot. - // - // * NoReboot: Patch Manager attempts to install - // missing packages without trying to reboot the system. Patches installed with - // this option are assigned a status of InstalledPendingReboot. These patches might - // not be in effect until a reboot is performed. + // - RebootIfNeeded : Patch Manager tries to reboot the managed node if it + // installed any patches, or if any patches are detected with a status of + // InstalledPendingReboot . + // - NoReboot : Patch Manager attempts to install missing packages without trying + // to reboot the system. Patches installed with this option are assigned a status + // of InstalledPendingReboot . These patches might not be in effect until a + // reboot is performed. RebootOption RebootOption // The number of patches per node that are specified as Security in a patch // advisory aren't installed. These patches might be missing, have failed // installation, were rejected, or were installed but awaiting a required managed - // node reboot. The status of these managed nodes is NON_COMPLIANT. + // node reboot. The status of these managed nodes is NON_COMPLIANT . SecurityNonCompliantCount *int32 // The ID of the patch baseline snapshot used during the patching operation when @@ -2590,35 +2452,20 @@ type InstancePatchState struct { // the information returned by the API. Example: To filter for all managed nodes in // a patch group having more than three patches with a FailedCount status, use the // following for the filter: -// -// * Value for Key: FailedCount -// -// * Value for Type: -// GreaterThan -// -// * Value for Values: 3 +// - Value for Key : FailedCount +// - Value for Type : GreaterThan +// - Value for Values : 3 type InstancePatchStateFilter struct { // The key for the filter. Supported values include the following: - // - // * - // InstalledCount - // - // * InstalledOtherCount - // - // * InstalledPendingRebootCount - // - // * - // InstalledRejectedCount - // - // * MissingCount - // - // * FailedCount - // - // * - // UnreportedNotApplicableCount - // - // * NotApplicableCount + // - InstalledCount + // - InstalledOtherCount + // - InstalledPendingRebootCount + // - InstalledRejectedCount + // - MissingCount + // - FailedCount + // - UnreportedNotApplicableCount + // - NotApplicableCount // // This member is required. Key *string @@ -2662,9 +2509,8 @@ type InventoryDeletionStatusItem struct { // The UTC timestamp when the delete operation started. DeletionStartTime *time.Time - // Information about the delete operation. For more information about this summary, - // see Understanding the delete inventory summary - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete) + // Information about the delete operation. For more information about this + // summary, see Understanding the delete inventory summary (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete) // in the Amazon Web Services Systems Manager User Guide. DeletionSummary *InventoryDeletionSummary @@ -2692,8 +2538,8 @@ type InventoryDeletionSummary struct { // A list of counts and versions for deleted items. SummaryItems []InventoryDeletionSummaryItem - // The total number of items to delete. This count doesn't change during the delete - // operation. + // The total number of items to delete. This count doesn't change during the + // delete operation. TotalCount int32 noSmithyDocumentSerde @@ -2725,14 +2571,13 @@ type InventoryFilter struct { // Inventory filter values. Example: inventory filter where managed node IDs are // specified as values Key=AWS:InstanceInformation.InstanceId,Values= - // i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal. + // i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal . // // This member is required. Values []string // The type of filter. The Exists filter must be used with aggregators. For more - // information, see Aggregating inventory data - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html) + // information, see Aggregating inventory data (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html) // in the Amazon Web Services Systems Manager User Guide. Type InventoryQueryOperatorType @@ -2745,8 +2590,8 @@ type InventoryFilter struct { type InventoryGroup struct { // Filters define the criteria for the group. The matchingCount field displays the - // number of resources that match the criteria. The notMatchingCount field displays - // the number of resources that don't match the criteria. + // number of resources that match the criteria. The notMatchingCount field + // displays the number of resources that don't match the criteria. // // This member is required. Filters []InventoryFilter @@ -2772,10 +2617,10 @@ type InventoryItem struct { // This member is required. SchemaVersion *string - // The name of the inventory type. Default inventory item type names start with - // AWS. Custom inventory type names will start with Custom. Default inventory item - // types include the following: AWS:AWSComponent, AWS:Application, - // AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. + // The name of the inventory type. Default inventory item type names start with AWS + // . Custom inventory type names will start with Custom. Default inventory item + // types include the following: AWS:AWSComponent , AWS:Application , + // AWS:InstanceInformation , AWS:Network , and AWS:WindowsUpdate . // // This member is required. TypeName *string @@ -2789,9 +2634,9 @@ type InventoryItem struct { // last update. ContentHash *string - // A map of associated properties for a specified inventory type. For example, with - // this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType - // properties of the AWS:ComplianceItem type. + // A map of associated properties for a specified inventory type. For example, + // with this attribute, you can specify the ExecutionId , ExecutionType , + // ComplianceType properties of the AWS:ComplianceItem type. Context map[string]string noSmithyDocumentSerde @@ -2825,8 +2670,8 @@ type InventoryItemSchema struct { // The name of the inventory type. Default inventory item type names start with // Amazon Web Services. Custom inventory type names will start with Custom. Default - // inventory item types include the following: AWS:AWSComponent, AWS:Application, - // AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. + // inventory item types include the following: AWS:AWSComponent , AWS:Application , + // AWS:InstanceInformation , AWS:Network , and AWS:WindowsUpdate . // // This member is required. TypeName *string @@ -2892,7 +2737,7 @@ type InventoryResultItem struct { // the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance -// window task types, see MaintenanceWindowTaskInvocationParameters. +// window task types, see MaintenanceWindowTaskInvocationParameters . type LoggingInfo struct { // The name of an S3 bucket where execution logs are stored. @@ -2919,18 +2764,18 @@ type MaintenanceWindowAutomationParameters struct { // The parameters for the AUTOMATION task. For information about specifying and // updating task parameters, see RegisterTaskWithMaintenanceWindow and - // UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an + // UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an // Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use // the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters - // has been deprecated. To specify parameters to pass to a task when it runs, - // instead use the Parameters option in the TaskInvocationParameters structure. For - // information about how Systems Manager handles these options for the supported - // maintenance window task types, see MaintenanceWindowTaskInvocationParameters. - // For AUTOMATION task types, Amazon Web Services Systems Manager ignores any - // values specified for these parameters. + // window task types, see MaintenanceWindowTaskInvocationParameters . + // TaskParameters has been deprecated. To specify parameters to pass to a task when + // it runs, instead use the Parameters option in the TaskInvocationParameters + // structure. For information about how Systems Manager handles these options for + // the supported maintenance window task types, see + // MaintenanceWindowTaskInvocationParameters . For AUTOMATION task types, Amazon + // Web Services Systems Manager ignores any values specified for these parameters. Parameters map[string][]string noSmithyDocumentSerde @@ -3006,7 +2851,7 @@ type MaintenanceWindowExecutionTaskInvocationIdentity struct { EndTime *time.Time // The ID of the action performed in the service that actually handled the task - // invocation. If the task type is RUN_COMMAND, this value is the command ID. + // invocation. If the task type is RUN_COMMAND , this value is the command ID. ExecutionId *string // The ID of the task invocation. @@ -3049,21 +2894,12 @@ type MaintenanceWindowExecutionTaskInvocationIdentity struct { // Filter used in the request. Supported filter keys depend on the API operation // that includes the filter. API operations that use MaintenanceWindowFilter> // include the following: -// -// * DescribeMaintenanceWindowExecutions -// -// * -// DescribeMaintenanceWindowExecutionTaskInvocations -// -// * -// DescribeMaintenanceWindowExecutionTasks -// -// * DescribeMaintenanceWindows -// -// * -// DescribeMaintenanceWindowTargets -// -// * DescribeMaintenanceWindowTasks +// - DescribeMaintenanceWindowExecutions +// - DescribeMaintenanceWindowExecutionTaskInvocations +// - DescribeMaintenanceWindowExecutionTasks +// - DescribeMaintenanceWindows +// - DescribeMaintenanceWindowTargets +// - DescribeMaintenanceWindowTasks type MaintenanceWindowFilter struct { // The name of the filter. @@ -3137,18 +2973,18 @@ type MaintenanceWindowIdentityForTarget struct { // The parameters for a LAMBDA task type. For information about specifying and // updating task parameters, see RegisterTaskWithMaintenanceWindow and -// UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an +// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an // Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use // the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance -// window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters -// has been deprecated. To specify parameters to pass to a task when it runs, -// instead use the Parameters option in the TaskInvocationParameters structure. For -// information about how Systems Manager handles these options for the supported -// maintenance window task types, see MaintenanceWindowTaskInvocationParameters. -// For Lambda tasks, Systems Manager ignores any values specified for -// TaskParameters and LoggingInfo. +// window task types, see MaintenanceWindowTaskInvocationParameters . +// TaskParameters has been deprecated. To specify parameters to pass to a task when +// it runs, instead use the Parameters option in the TaskInvocationParameters +// structure. For information about how Systems Manager handles these options for +// the supported maintenance window task types, see +// MaintenanceWindowTaskInvocationParameters . For Lambda tasks, Systems Manager +// ignores any values specified for TaskParameters and LoggingInfo. type MaintenanceWindowLambdaParameters struct { // Pass client-specific information to the Lambda function that you are invoking. @@ -3169,20 +3005,21 @@ type MaintenanceWindowLambdaParameters struct { noSmithyDocumentSerde } -// The parameters for a RUN_COMMAND task type. For information about specifying and -// updating task parameters, see RegisterTaskWithMaintenanceWindow and -// UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an +// The parameters for a RUN_COMMAND task type. For information about specifying +// and updating task parameters, see RegisterTaskWithMaintenanceWindow and +// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an // Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use // the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance -// window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters -// has been deprecated. To specify parameters to pass to a task when it runs, -// instead use the Parameters option in the TaskInvocationParameters structure. For -// information about how Systems Manager handles these options for the supported -// maintenance window task types, see MaintenanceWindowTaskInvocationParameters. -// For RUN_COMMAND tasks, Systems Manager uses specified values for TaskParameters -// and LoggingInfo only if no values are specified for TaskInvocationParameters. +// window task types, see MaintenanceWindowTaskInvocationParameters . +// TaskParameters has been deprecated. To specify parameters to pass to a task when +// it runs, instead use the Parameters option in the TaskInvocationParameters +// structure. For information about how Systems Manager handles these options for +// the supported maintenance window task types, see +// MaintenanceWindowTaskInvocationParameters . For RUN_COMMAND tasks, Systems +// Manager uses specified values for TaskParameters and LoggingInfo only if no +// values are specified for TaskInvocationParameters . type MaintenanceWindowRunCommandParameters struct { // Configuration options for sending command output to Amazon CloudWatch Logs. @@ -3199,11 +3036,11 @@ type MaintenanceWindowRunCommandParameters struct { DocumentHashType DocumentHashType // The Amazon Web Services Systems Manager document (SSM document) version to use - // in the request. You can specify $DEFAULT, $LATEST, or a specific version number. - // If you run commands by using the Amazon Web Services CLI, then you must escape - // the first two options by using a backslash. If you specify a version number, - // then you don't need to use the backslash. For example: --document-version - // "\$DEFAULT" + // in the request. You can specify $DEFAULT , $LATEST , or a specific version + // number. If you run commands by using the Amazon Web Services CLI, then you must + // escape the first two options by using a backslash. If you specify a version + // number, then you don't need to use the backslash. For example: + // --document-version "\$DEFAULT" // --document-version "\$LATEST" // // --document-version "3" @@ -3236,18 +3073,18 @@ type MaintenanceWindowRunCommandParameters struct { // The parameters for a STEP_FUNCTIONS task. For information about specifying and // updating task parameters, see RegisterTaskWithMaintenanceWindow and -// UpdateMaintenanceWindowTask. LoggingInfo has been deprecated. To specify an +// UpdateMaintenanceWindowTask . LoggingInfo has been deprecated. To specify an // Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use // the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance -// window task types, see MaintenanceWindowTaskInvocationParameters. TaskParameters -// has been deprecated. To specify parameters to pass to a task when it runs, -// instead use the Parameters option in the TaskInvocationParameters structure. For -// information about how Systems Manager handles these options for the supported -// maintenance window task types, see MaintenanceWindowTaskInvocationParameters. -// For Step Functions tasks, Systems Manager ignores any values specified for -// TaskParameters and LoggingInfo. +// window task types, see MaintenanceWindowTaskInvocationParameters . +// TaskParameters has been deprecated. To specify parameters to pass to a task when +// it runs, instead use the Parameters option in the TaskInvocationParameters +// structure. For information about how Systems Manager handles these options for +// the supported maintenance window task types, see +// MaintenanceWindowTaskInvocationParameters . For Step Functions tasks, Systems +// Manager ignores any values specified for TaskParameters and LoggingInfo . type MaintenanceWindowStepFunctionsParameters struct { // The inputs for the STEP_FUNCTIONS task. @@ -3278,7 +3115,7 @@ type MaintenanceWindowTarget struct { // The targets, either managed nodes or tags. Specify managed nodes using the // following format: Key=instanceids,Values=, Tags are specified using the - // following format: Key=,Values=. + // following format: Key=,Values= . Targets []Target // The ID of the maintenance window to register the target with. @@ -3296,38 +3133,36 @@ type MaintenanceWindowTask struct { // The details for the CloudWatch alarm applied to your maintenance window task. AlarmConfiguration *AlarmConfiguration - // The specification for whether tasks should continue to run after the cutoff time - // specified in the maintenance windows is reached. + // The specification for whether tasks should continue to run after the cutoff + // time specified in the maintenance windows is reached. CutoffBehavior MaintenanceWindowTaskCutoffBehavior // A description of the task. Description *string - // Information about an S3 bucket to write task-level logs to. LoggingInfo has been - // deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to - // contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options - // in the TaskInvocationParameters structure. For information about how Amazon Web - // Services Systems Manager handles these options for the supported maintenance - // window task types, see MaintenanceWindowTaskInvocationParameters. + // Information about an S3 bucket to write task-level logs to. LoggingInfo has + // been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket + // to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix + // options in the TaskInvocationParameters structure. For information about how + // Amazon Web Services Systems Manager handles these options for the supported + // maintenance window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *LoggingInfo // The maximum number of targets this task can be run for, in parallel. Although // this element is listed as "Required: No", a value can be omitted only when you - // are registering or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxConcurrency *string // The maximum number of errors allowed before this task stops being scheduled. // Although this element is listed as "Required: No", a value can be omitted only - // when you are registering or updating a targetless task - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) + // when you are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, - // the system inserts a placeholder value of 1. This value doesn't affect the + // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxErrors *string @@ -3345,7 +3180,7 @@ type MaintenanceWindowTask struct { ServiceRoleArn *string // The targets (either managed nodes or tags). Managed nodes are specified using - // Key=instanceids,Values=,. Tags are specified using Key=,Values=. + // Key=instanceids,Values=, . Tags are specified using Key=,Values= . Targets []Target // The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION @@ -3356,9 +3191,10 @@ type MaintenanceWindowTask struct { // The parameters that should be passed to the task when it is run. TaskParameters // has been deprecated. To specify parameters to pass to a task when it runs, - // instead use the Parameters option in the TaskInvocationParameters structure. For - // information about how Systems Manager handles these options for the supported - // maintenance window task types, see MaintenanceWindowTaskInvocationParameters. + // instead use the Parameters option in the TaskInvocationParameters structure. + // For information about how Systems Manager handles these options for the + // supported maintenance window task types, see + // MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]MaintenanceWindowTaskParameterValueExpression // The type of task. @@ -3410,8 +3246,8 @@ type MetadataValue struct { noSmithyDocumentSerde } -// A summary of resources that aren't compliant. The summary is organized according -// to resource type. +// A summary of resources that aren't compliant. The summary is organized +// according to resource type. type NonCompliantSummary struct { // The total number of compliance items that aren't compliant. @@ -3433,25 +3269,22 @@ type NotificationConfig struct { // The different events for which you can receive notifications. To learn more // about these events, see Monitoring Systems Manager status changes using Amazon - // SNS notifications - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) + // SNS notifications (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) // in the Amazon Web Services Systems Manager User Guide. NotificationEvents []NotificationEvent // The type of notification. - // - // * Command: Receive notification when the status of a - // command changes. - // - // * Invocation: For commands sent to multiple managed nodes, - // receive notification on a per-node basis when the status of a command changes. + // - Command : Receive notification when the status of a command changes. + // - Invocation : For commands sent to multiple managed nodes, receive + // notification on a per-node basis when the status of a command changes. NotificationType NotificationType noSmithyDocumentSerde } -// One or more aggregators for viewing counts of OpsData using different dimensions -// such as Source, CreatedTime, or Source and CreatedTime, to name a few. +// One or more aggregators for viewing counts of OpsData using different +// dimensions such as Source , CreatedTime , or Source and CreatedTime , to name a +// few. type OpsAggregator struct { // Either a Range or Count aggregator for limiting an OpsData summary. @@ -3533,17 +3366,16 @@ type OpsFilter struct { // alarm or event details, alarm history, and an alarm timeline graph. For the // Amazon Web Services resource, OpsCenter aggregates information from Config, // CloudTrail logs, and EventBridge, so you don't have to navigate across multiple -// console pages during your investigation. For more information, see OpsCenter -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in -// the Amazon Web Services Systems Manager User Guide. +// console pages during your investigation. For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) +// in the Amazon Web Services Systems Manager User Guide. type OpsItem struct { // The time a runbook workflow ended. Currently reported only for the OpsItem type - // /aws/changerequest. + // /aws/changerequest . ActualEndTime *time.Time // The time a runbook workflow started. Currently reported only for the OpsItem - // type /aws/changerequest. + // type /aws/changerequest . ActualStartTime *time.Time // An OpsItem category. Category options include: Availability, Cost, Performance, @@ -3569,22 +3401,22 @@ type OpsItem struct { // SNS) topic where notifications are sent when this OpsItem is edited or changed. Notifications []OpsItemNotification - // Operational data is custom data that provides useful reference details about the - // OpsItem. For example, you can specify log files, error strings, license keys, - // troubleshooting tips, or other relevant data. You enter operational data as - // key-value pairs. The key has a maximum length of 128 characters. The value has a - // maximum size of 20 KB. Operational data keys can't begin with the following: - // amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the - // data searchable by other users in the account or you can restrict search access. - // Searchable data means that all users with access to the OpsItem Overview page - // (as provided by the DescribeOpsItems API operation) can view and search on the - // specified data. Operational data that isn't searchable is only viewable by users - // who have access to the OpsItem (as provided by the GetOpsItem API operation). - // Use the /aws/resources key in OperationalData to specify a related resource in - // the request. Use the /aws/automations key in OperationalData to associate an - // Automation runbook with the OpsItem. To view Amazon Web Services CLI example - // commands that use these keys, see Creating OpsItems manually - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) + // Operational data is custom data that provides useful reference details about + // the OpsItem. For example, you can specify log files, error strings, license + // keys, troubleshooting tips, or other relevant data. You enter operational data + // as key-value pairs. The key has a maximum length of 128 characters. The value + // has a maximum size of 20 KB. Operational data keys can't begin with the + // following: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , /ssm . You can + // choose to make the data searchable by other users in the account or you can + // restrict search access. Searchable data means that all users with access to the + // OpsItem Overview page (as provided by the DescribeOpsItems API operation) can + // view and search on the specified data. Operational data that isn't searchable is + // only viewable by users who have access to the OpsItem (as provided by the + // GetOpsItem API operation). Use the /aws/resources key in OperationalData to + // specify a related resource in the request. Use the /aws/automations key in + // OperationalData to associate an Automation runbook with the OpsItem. To view + // Amazon Web Services CLI example commands that use these keys, see Creating + // OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) // in the Amazon Web Services Systems Manager User Guide. OperationalData map[string]OpsItemDataValue @@ -3594,26 +3426,21 @@ type OpsItem struct { // The ID of the OpsItem. OpsItemId *string - // The type of OpsItem. Systems Manager supports the following types of - // OpsItems: - // - // * /aws/issue This type of OpsItem is used for default OpsItems - // created by OpsCenter. - // - // * /aws/changerequest This type of OpsItem is used by - // Change Manager for reviewing and approving or rejecting change requests. - // - // * - // /aws/insights This type of OpsItem is used by OpsCenter for aggregating and - // reporting on duplicate OpsItems. + // The type of OpsItem. Systems Manager supports the following types of OpsItems: + // - /aws/issue This type of OpsItem is used for default OpsItems created by + // OpsCenter. + // - /aws/changerequest This type of OpsItem is used by Change Manager for + // reviewing and approving or rejecting change requests. + // - /aws/insights This type of OpsItem is used by OpsCenter for aggregating and + // reporting on duplicate OpsItems. OpsItemType *string // The time specified in a change request for a runbook workflow to end. Currently - // supported only for the OpsItem type /aws/changerequest. + // supported only for the OpsItem type /aws/changerequest . PlannedEndTime *time.Time // The time specified in a change request for a runbook workflow to start. - // Currently supported only for the OpsItem type /aws/changerequest. + // Currently supported only for the OpsItem type /aws/changerequest . PlannedStartTime *time.Time // The importance of this OpsItem in relation to other OpsItems in the system. @@ -3631,9 +3458,8 @@ type OpsItem struct { // resource is a subset of source. Source *string - // The OpsItem status. Status can be Open, In Progress, or Resolved. For more - // information, see Editing OpsItem details - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) + // The OpsItem status. Status can be Open , In Progress , or Resolved . For more + // information, see Editing OpsItem details (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) // in the Amazon Web Services Systems Manager User Guide. Status OpsItemStatus @@ -3652,7 +3478,7 @@ type OpsItem struct { // map. type OpsItemDataValue struct { - // The type of key-value pair. Valid types include SearchableString and String. + // The type of key-value pair. Valid types include SearchableString and String . Type OpsItemDataType // The value of the OperationalData key. @@ -3665,13 +3491,13 @@ type OpsItemDataValue struct { // information by using tags. You specify tags by using a key-value pair mapping. type OpsItemEventFilter struct { - // The name of the filter key. Currently, the only supported value is OpsItemId. + // The name of the filter key. Currently, the only supported value is OpsItemId . // // This member is required. Key OpsItemEventFilterKey // The operator used by the filter call. Currently, the only supported value is - // Equal. + // Equal . // // This member is required. Operator OpsItemEventFilterOperator @@ -3755,13 +3581,13 @@ type OpsItemNotification struct { // Describes a filter for a specific list of related-item resources. type OpsItemRelatedItemsFilter struct { - // The name of the filter key. Supported values include ResourceUri, ResourceType, - // or AssociationId. + // The name of the filter key. Supported values include ResourceUri , ResourceType + // , or AssociationId . // // This member is required. Key OpsItemRelatedItemsFilterKey - // The operator used by the filter call. The only supported operator is EQUAL. + // The operator used by the filter call. The only supported operator is EQUAL . // // This member is required. Operator OpsItemRelatedItemsFilterOperator @@ -3811,11 +3637,11 @@ type OpsItemRelatedItemSummary struct { type OpsItemSummary struct { // The time a runbook workflow ended. Currently reported only for the OpsItem type - // /aws/changerequest. + // /aws/changerequest . ActualEndTime *time.Time // The time a runbook workflow started. Currently reported only for the OpsItem - // type /aws/changerequest. + // type /aws/changerequest . ActualStartTime *time.Time // A list of OpsItems by category. @@ -3833,33 +3659,28 @@ type OpsItemSummary struct { // The date and time the OpsItem was last updated. LastModifiedTime *time.Time - // Operational data is custom data that provides useful reference details about the - // OpsItem. + // Operational data is custom data that provides useful reference details about + // the OpsItem. OperationalData map[string]OpsItemDataValue // The ID of the OpsItem. OpsItemId *string - // The type of OpsItem. Systems Manager supports the following types of - // OpsItems: - // - // * /aws/issue This type of OpsItem is used for default OpsItems - // created by OpsCenter. - // - // * /aws/changerequest This type of OpsItem is used by - // Change Manager for reviewing and approving or rejecting change requests. - // - // * - // /aws/insights This type of OpsItem is used by OpsCenter for aggregating and - // reporting on duplicate OpsItems. + // The type of OpsItem. Systems Manager supports the following types of OpsItems: + // - /aws/issue This type of OpsItem is used for default OpsItems created by + // OpsCenter. + // - /aws/changerequest This type of OpsItem is used by Change Manager for + // reviewing and approving or rejecting change requests. + // - /aws/insights This type of OpsItem is used by OpsCenter for aggregating and + // reporting on duplicate OpsItems. OpsItemType *string // The time specified in a change request for a runbook workflow to end. Currently - // supported only for the OpsItem type /aws/changerequest. + // supported only for the OpsItem type /aws/changerequest . PlannedEndTime *time.Time // The time specified in a change request for a runbook workflow to start. - // Currently supported only for the OpsItem type /aws/changerequest. + // Currently supported only for the OpsItem type /aws/changerequest . PlannedStartTime *time.Time // The importance of this OpsItem in relation to other OpsItems in the system. @@ -3871,7 +3692,7 @@ type OpsItemSummary struct { // The impacted Amazon Web Services resource. Source *string - // The OpsItem status. Status can be Open, In Progress, or Resolved. + // The OpsItem status. Status can be Open , In Progress , or Resolved . Status OpsItemStatus // A short heading that describes the nature of the OpsItem and the impacted @@ -3921,8 +3742,8 @@ type OpsMetadataFilter struct { // The OpsItem data type to return. type OpsResultAttribute struct { - // Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, - // AWS:OpsItemTrendline, or AWS:ComplianceSummary. + // Name of the data type. Valid value: AWS:OpsItem , AWS:EC2InstanceInformation , + // AWS:OpsItemTrendline , or AWS:ComplianceSummary . // // This member is required. TypeName *string @@ -3949,8 +3770,8 @@ type Parameter struct { // The Amazon Resource Name (ARN) of the parameter. ARN *string - // The data type of the parameter, such as text or aws:ec2:image. The default is - // text. + // The data type of the parameter, such as text or aws:ec2:image . The default is + // text . DataType *string // Date the parameter was last changed or updated and the parameter version was @@ -3969,13 +3790,13 @@ type Parameter struct { // services. SourceResult is the raw result or response from the source. SourceResult *string - // The type of parameter. Valid values include the following: String, StringList, - // and SecureString. If type is StringList, the system returns a comma-separated + // The type of parameter. Valid values include the following: String , StringList , + // and SecureString . If type is StringList , the system returns a comma-separated // string with no spaces between commas in the Value field. Type ParameterType - // The parameter value. If type is StringList, the system returns a comma-separated - // string with no spaces between commas in the Value field. + // The parameter value. If type is StringList , the system returns a + // comma-separated string with no spaces between commas in the Value field. Value *string // The parameter version. @@ -3990,8 +3811,8 @@ type ParameterHistory struct { // Parameter names can include the following letters and symbols. a-zA-Z0-9_.- AllowedPattern *string - // The data type of the parameter, such as text or aws:ec2:image. The default is - // text. + // The data type of the parameter, such as text or aws:ec2:image . The default is + // text . DataType *string // Information about the parameter. @@ -4014,8 +3835,7 @@ type ParameterHistory struct { Name *string // Information about the policies assigned to a parameter. Assigning parameter - // policies - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) + // policies (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) // in the Amazon Web Services Systems Manager User Guide. Policies []ParameterInlinePolicy @@ -4046,8 +3866,8 @@ type ParameterInlinePolicy struct { // The JSON text of the policy. PolicyText *string - // The type of policy. Parameter Store, a capability of Amazon Web Services Systems - // Manager, supports the following policy types: Expiration, + // The type of policy. Parameter Store, a capability of Amazon Web Services + // Systems Manager, supports the following policy types: Expiration, // ExpirationNotification, and NoChangeNotification. PolicyType *string @@ -4062,8 +3882,8 @@ type ParameterMetadata struct { // a-zA-Z0-9_.- AllowedPattern *string - // The data type of the parameter, such as text or aws:ec2:image. The default is - // text. + // The data type of the parameter, such as text or aws:ec2:image . The default is + // text . DataType *string // Description of the parameter actions. @@ -4088,8 +3908,8 @@ type ParameterMetadata struct { // The parameter tier. Tier ParameterTier - // The type of parameter. Valid parameter types include the following: String, - // StringList, and SecureString. + // The type of parameter. Valid parameter types include the following: String , + // StringList , and SecureString . Type ParameterType // The parameter version. @@ -4098,7 +3918,7 @@ type ParameterMetadata struct { noSmithyDocumentSerde } -// This data type is deprecated. Instead, use ParameterStringFilter. +// This data type is deprecated. Instead, use ParameterStringFilter . type ParametersFilter struct { // The name of the filter. @@ -4120,23 +3940,22 @@ type ParameterStringFilter struct { // The name of the filter. The ParameterStringFilter object is used by the // DescribeParameters and GetParametersByPath API operations. However, not all of // the pattern values listed for Key can be used with both operations. For - // DescribeParameters, all of the listed patterns are valid except Label. For - // GetParametersByPath, the following patterns listed for Key aren't valid: tag, - // DataType, Name, Path, and Tier. For examples of Amazon Web Services CLI commands - // demonstrating valid parameter filter constructions, see Searching for Systems - // Manager parameters - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html) + // DescribeParameters , all of the listed patterns are valid except Label . For + // GetParametersByPath , the following patterns listed for Key aren't valid: tag , + // DataType , Name , Path , and Tier . For examples of Amazon Web Services CLI + // commands demonstrating valid parameter filter constructions, see Searching for + // Systems Manager parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. Key *string - // For all filters used with DescribeParameters, valid options include Equals and - // BeginsWith. The Name filter additionally supports the Contains option. - // (Exception: For filters using the key Path, valid options include Recursive and - // OneLevel.) For filters used with GetParametersByPath, valid options include - // Equals and BeginsWith. (Exception: For filters using Label as the Key name, the - // only valid option is Equals.) + // For all filters used with DescribeParameters , valid options include Equals and + // BeginsWith . The Name filter additionally supports the Contains option. + // (Exception: For filters using the key Path , valid options include Recursive + // and OneLevel .) For filters used with GetParametersByPath , valid options + // include Equals and BeginsWith . (Exception: For filters using Label as the Key + // name, the only valid option is Equals .) Option *string // The value you want to search for. @@ -4148,25 +3967,25 @@ type ParameterStringFilter struct { // Represents metadata about a patch. type Patch struct { - // The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to + // The Advisory ID of the patch. For example, RHSA-2020:3779 . Applies to // Linux-based managed nodes only. AdvisoryIds []string // The architecture of the patch. For example, in - // example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. + // example-pkg-0.710.10-2.7.abcd.x86_64 , the architecture is indicated by x86_64 . // Applies to Linux-based managed nodes only. Arch *string - // The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based + // The Bugzilla ID of the patch. For example, 1600646 . Applies to Linux-based // managed nodes only. BugzillaIds []string // The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, - // CVE-2011-3192. Applies to Linux-based managed nodes only. + // CVE-2011-3192 . Applies to Linux-based managed nodes only. CVEIds []string - // The classification of the patch. For example, SecurityUpdates, Updates, or - // CriticalUpdates. + // The classification of the patch. For example, SecurityUpdates , Updates , or + // CriticalUpdates . Classification *string // The URL where more information can be obtained about the patch. @@ -4175,8 +3994,8 @@ type Patch struct { // The description of the patch. Description *string - // The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, - // the epoch value is 20180914-2. Applies to Linux-based managed nodes only. + // The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch + // , the epoch value is 20180914-2 . Applies to Linux-based managed nodes only. Epoch int32 // The ID of the patch. Applies to Windows patches only. This ID isn't the same as @@ -4190,26 +4009,26 @@ type Patch struct { Language *string // The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is - // related to. For example, MS14-045. Applies to Windows patches only. + // related to. For example, MS14-045 . Applies to Windows patches only. MsrcNumber *string - // The severity of the patch, such as Critical, Important, or Moderate. Applies to - // Windows patches only. + // The severity of the patch, such as Critical , Important , or Moderate . Applies + // to Windows patches only. MsrcSeverity *string // The name of the patch. Applies to Linux-based managed nodes only. Name *string // The specific product the patch is applicable for. For example, WindowsServer2016 - // or AmazonLinux2018.03. + // or AmazonLinux2018.03 . Product *string // The product family the patch is applicable for. For example, Windows or Amazon - // Linux 2. + // Linux 2 . ProductFamily *string // The particular release of a patch. For example, in - // pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to + // pkg-example-EE-20180914-2.2.amzn1.noarch , the release is 2.amaz1 . Applies to // Linux-based managed nodes only. Release *string @@ -4217,11 +4036,11 @@ type Patch struct { ReleaseDate *time.Time // The source patch repository for the operating system and version, such as - // trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server - // 20.04 LTE. Applies to Linux-based managed nodes only. + // trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu + // Server 20.04 LTE. Applies to Linux-based managed nodes only. Repository *string - // The severity level of the patch. For example, CRITICAL or MODERATE. + // The severity level of the patch. For example, CRITICAL or MODERATE . Severity *string // The title of the patch. @@ -4231,7 +4050,7 @@ type Patch struct { Vendor *string // The version number of the patch. For example, in - // example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. + // example-pkg-1.710.10-2.7.abcd.x86_64 , the version number is indicated by -1 . // Applies to Linux-based managed nodes only. Version *string @@ -4255,8 +4074,8 @@ type PatchBaselineIdentity struct { // a default patch baseline for each operating system. DefaultBaseline bool - // Defines the operating system the patch baseline applies to. The default value is - // WINDOWS. + // Defines the operating system the patch baseline applies to. The default value + // is WINDOWS . OperatingSystem OperatingSystem noSmithyDocumentSerde @@ -4266,8 +4085,8 @@ type PatchBaselineIdentity struct { // relates to the patch baseline used to patch the node. type PatchComplianceData struct { - // The classification of the patch, such as SecurityUpdates, Updates, and - // CriticalUpdates. + // The classification of the patch, such as SecurityUpdates , Updates , and + // CriticalUpdates . // // This member is required. Classification *string @@ -4283,14 +4102,13 @@ type PatchComplianceData struct { // This member is required. KBId *string - // The severity of the patch such as Critical, Important, and Moderate. + // The severity of the patch such as Critical , Important , and Moderate . // // This member is required. Severity *string // The state of the patch on the managed node, such as INSTALLED or FAILED. For - // descriptions of each patch state, see About patch compliance - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch) + // descriptions of each patch state, see About patch compliance (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. @@ -4301,8 +4119,8 @@ type PatchComplianceData struct { // This member is required. Title *string - // The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are - // resolved by the patch. + // The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that + // are resolved by the patch. CVEIds *string noSmithyDocumentSerde @@ -4310,20 +4128,20 @@ type PatchComplianceData struct { // Defines which patches should be included in a patch baseline. A patch filter // consists of a key and a set of values. The filter key is a patch property. For -// example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, -// PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a +// example, the available filter keys for WINDOWS are PATCH_SET , PRODUCT , +// PRODUCT_FAMILY , CLASSIFICATION , and MSRC_SEVERITY . The filter values define a // matching criterion for the patch property indicated by the key. For example, if // the filter key is PRODUCT and the filter values are ["Office 2013", "Office -// 2016"], then the filter accepts all patches where product name is either "Office -// 2013" or "Office 2016". The filter values can be exact values for the patch -// property given as a key, or a wildcard (*), which matches all values. You can -// view lists of valid values for the patch properties by running the +// 2016"] , then the filter accepts all patches where product name is either +// "Office 2013" or "Office 2016". The filter values can be exact values for the +// patch property given as a key, or a wildcard (*), which matches all values. You +// can view lists of valid values for the patch properties by running the // DescribePatchProperties command. For information about which patch properties -// can be used with each major operating system, see DescribePatchProperties. +// can be used with each major operating system, see DescribePatchProperties . type PatchFilter struct { - // The key for the filter. Run the DescribePatchProperties command to view lists of - // valid keys for each operating system type. + // The key for the filter. Run the DescribePatchProperties command to view lists + // of valid keys for each operating system type. // // This member is required. Key PatchFilterKey @@ -4361,18 +4179,13 @@ type PatchGroupPatchBaselineMapping struct { noSmithyDocumentSerde } -// Defines a filter used in Patch Manager APIs. Supported filter keys depend on the -// API operation that includes the filter. Patch Manager API operations that use -// PatchOrchestratorFilter include the following: -// -// * DescribeAvailablePatches -// -// * -// DescribeInstancePatches -// -// * DescribePatchBaselines -// -// * DescribePatchGroups +// Defines a filter used in Patch Manager APIs. Supported filter keys depend on +// the API operation that includes the filter. Patch Manager API operations that +// use PatchOrchestratorFilter include the following: +// - DescribeAvailablePatches +// - DescribeInstancePatches +// - DescribePatchBaselines +// - DescribePatchGroups type PatchOrchestratorFilter struct { // The key for the filter. @@ -4392,15 +4205,16 @@ type PatchRule struct { // This member is required. PatchFilterGroup *PatchFilterGroup - // The number of days after the release date of each patch matched by the rule that - // the patch is marked as approved in the patch baseline. For example, a value of 7 - // means that patches are approved seven days after they are released. Not + // The number of days after the release date of each patch matched by the rule + // that the patch is marked as approved in the patch baseline. For example, a value + // of 7 means that patches are approved seven days after they are released. Not // supported on Debian Server or Ubuntu Server. ApproveAfterDays *int32 // The cutoff date for auto approval of released patches. Any patches released on // or before this date are installed automatically. Not supported on Debian Server - // or Ubuntu Server. Enter dates in the format YYYY-MM-DD. For example, 2021-12-31. + // or Ubuntu Server. Enter dates in the format YYYY-MM-DD . For example, 2021-12-31 + // . ApproveUntilDate *string // A compliance severity level for all approved patches in a patch baseline. @@ -4408,7 +4222,7 @@ type PatchRule struct { // For managed nodes identified by the approval rule filters, enables a patch // baseline to apply non-security updates available in the specified repository. - // The default value is false. Applies to Linux managed nodes only. + // The default value is false . Applies to Linux managed nodes only. EnableNonSecurity *bool noSmithyDocumentSerde @@ -4431,14 +4245,12 @@ type PatchRuleGroup struct { type PatchSource struct { // The value of the yum repo configuration. For example: [main] - // - // name=MyCustomRepository + // name=MyCustomRepository // // baseurl=https://my-custom-repository - // - // enabled=1 For - // information about other options available for your yum repository configuration, - // see dnf.conf(5) (https://man7.org/linux/man-pages/man5/dnf.conf.5.html). + // enabled=1 For information about other options available for your yum repository + // configuration, see dnf.conf(5) (https://man7.org/linux/man-pages/man5/dnf.conf.5.html) + // . // // This member is required. Configuration *string @@ -4450,7 +4262,7 @@ type PatchSource struct { // The specific operating system versions a patch repository applies to, such as // "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". - // For lists of supported product values, see PatchFilter. + // For lists of supported product values, see PatchFilter . // // This member is required. Products []string @@ -4462,7 +4274,7 @@ type PatchSource struct { type PatchStatus struct { // The date the patch was approved (or will be approved if the status is - // PENDING_APPROVAL). + // PENDING_APPROVAL ). ApprovalDate *time.Time // The compliance severity level for a patch. @@ -4584,9 +4396,9 @@ type ResourceComplianceSummaryItem struct { type ResourceDataSyncAwsOrganizationsSource struct { // If an Amazon Web Services organization is present, this is either - // OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is - // aggregated from a set of organization units. For EntireOrganization, the data is - // aggregated from the entire Amazon Web Services organization. + // OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data + // is aggregated from a set of organization units. For EntireOrganization , the + // data is aggregated from the entire Amazon Web Services organization. // // This member is required. OrganizationSourceType *string @@ -4640,7 +4452,7 @@ type ResourceDataSyncItem struct { // Information about the source where the data was synchronized. SyncSource *ResourceDataSyncSourceWithState - // The type of resource data sync. If SyncType is SyncToDestination, then the + // The type of resource data sync. If SyncType is SyncToDestination , then the // resource data sync synchronizes data to an S3 bucket. If the SyncType is // SyncFromSource then the resource data sync synchronizes data from Organizations // or from multiple Amazon Web Services Regions. @@ -4681,7 +4493,7 @@ type ResourceDataSyncS3Destination struct { // same Region as the destination S3 bucket. AWSKMSKeyARN *string - // Enables destination data sharing. By default, this field is null. + // Enables destination data sharing. By default, this field is null . DestinationDataSharing *ResourceDataSyncDestinationDataSharing // An Amazon S3 prefix for the bucket. @@ -4700,7 +4512,7 @@ type ResourceDataSyncSource struct { // The type of data source for the resource data sync. SourceType is either // AwsOrganizations (if an organization is present in Organizations) or - // SingleAccountMultiRegions. + // SingleAccountMultiRegions . // // This member is required. SourceType *string @@ -4713,8 +4525,7 @@ type ResourceDataSyncSource struct { // options, then Systems Manager automatically enables all OpsData sources in the // selected Amazon Web Services Regions for all Amazon Web Services accounts in // your organization (or in the selected organization units). For more information, - // see About multiple account and Region resource data syncs - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html) + // see About multiple account and Region resource data syncs (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html) // in the Amazon Web Services Systems Manager User Guide. EnableAllOpsDataSources bool @@ -4742,8 +4553,7 @@ type ResourceDataSyncSourceWithState struct { // options, then Systems Manager automatically enables all OpsData sources in the // selected Amazon Web Services Regions for all Amazon Web Services accounts in // your organization (or in the selected organization units). For more information, - // see About multiple account and Region resource data syncs - // (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html) + // see About multiple account and Region resource data syncs (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html) // in the Amazon Web Services Systems Manager User Guide. EnableAllOpsDataSources bool @@ -4756,15 +4566,15 @@ type ResourceDataSyncSourceWithState struct { // The type of data source for the resource data sync. SourceType is either // AwsOrganizations (if an organization is present in Organizations) or - // singleAccountMultiRegions. + // singleAccountMultiRegions . SourceType *string // The data type name for including resource data sync state. There are four sync - // states: OrganizationNotExists: Your organization doesn't exist. NoPermissions: + // states: OrganizationNotExists : Your organization doesn't exist. NoPermissions : // The system can't locate the service-linked role. This role is automatically // created when a user creates a resource data sync in Explorer. - // InvalidOrganizationalUnit: You specified or selected an invalid unit in the - // resource data sync configuration. TrustedAccessDisabled: You disabled Systems + // InvalidOrganizationalUnit : You specified or selected an invalid unit in the + // resource data sync configuration. TrustedAccessDisabled : You disabled Systems // Manager access in the organization in Organizations. State *string @@ -4774,8 +4584,8 @@ type ResourceDataSyncSourceWithState struct { // The inventory item result attribute. type ResultAttribute struct { - // Name of the inventory item type. Valid value: AWS:InstanceInformation. Default - // Value: AWS:InstanceInformation. + // Name of the inventory item type. Valid value: AWS:InstanceInformation . Default + // Value: AWS:InstanceInformation . // // This member is required. TypeName *string @@ -4816,13 +4626,13 @@ type Runbook struct { // at the same time. MaxConcurrency *string - // The MaxErrors value specified by the user when the execution started, indicating - // the maximum number of errors that can occur during the operation before the - // updates are stopped or rolled back. + // The MaxErrors value specified by the user when the execution started, + // indicating the maximum number of errors that can occur during the operation + // before the updates are stopped or rolled back. MaxErrors *string // The key-value map of execution parameters, which were supplied when calling - // StartChangeRequestExecution. + // StartChangeRequestExecution . Parameters map[string][]string // Information about the Amazon Web Services Regions and Amazon Web Services @@ -4834,11 +4644,11 @@ type Runbook struct { TargetMaps []map[string][]string // The name of the parameter used as the target resource for the rate-controlled - // runbook workflow. Required if you specify Targets. + // runbook workflow. Required if you specify Targets . TargetParameterName *string // A key-value mapping to target resources that the runbook operation performs - // tasks on. Required if you specify TargetParameterName. + // tasks on. Required if you specify TargetParameterName . Targets []Target noSmithyDocumentSerde @@ -4859,8 +4669,8 @@ type S3OutputLocation struct { noSmithyDocumentSerde } -// A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where -// you want to store the results of this request. +// A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket +// where you want to store the results of this request. type S3OutputUrl struct { // A URL for an S3 bucket where you want to store the results of this request. @@ -4893,11 +4703,11 @@ type ScheduledWindowExecution struct { // "false". This means the user can't use this feature unless they change the // setting to "true" and intentionally opt in for a paid feature. Services map a // SettingId object to a setting value. Amazon Web Services services teams define -// the default value for a SettingId. You can't create a new SettingId, but you can -// overwrite the default value if you have the ssm:UpdateServiceSetting permission -// for the setting. Use the UpdateServiceSetting API operation to change the -// default setting. Or, use the ResetServiceSetting to change the value back to the -// original value defined by the Amazon Web Services service team. +// the default value for a SettingId . You can't create a new SettingId , but you +// can overwrite the default value if you have the ssm:UpdateServiceSetting +// permission for the setting. Use the UpdateServiceSetting API operation to +// change the default setting. Or, use the ResetServiceSetting to change the value +// back to the original value defined by the Amazon Web Services service team. type ServiceSetting struct { // The ARN of the service setting. @@ -4918,16 +4728,12 @@ type ServiceSetting struct { // The status of the service setting. The value can be Default, Customized or // PendingUpdate. - // - // * Default: The current setting uses a default value provisioned - // by the Amazon Web Services service team. - // - // * Customized: The current setting use - // a custom value specified by the customer. - // - // * PendingUpdate: The current setting - // uses a default or custom value, but a setting change request is pending - // approval. + // - Default: The current setting uses a default value provisioned by the Amazon + // Web Services service team. + // - Customized: The current setting use a custom value specified by the + // customer. + // - PendingUpdate: The current setting uses a default or custom value, but a + // setting change request is pending approval. Status *string noSmithyDocumentSerde @@ -4940,7 +4746,7 @@ type Session struct { Details *string // The name of the Session Manager SSM document used to define the parameters and - // plugin settings for the session. For example, SSM-SessionManagerRunShell. + // plugin settings for the session. For example, SSM-SessionManagerRunShell . DocumentName *string // The date and time, in ISO-8601 Extended format, when the session was terminated. @@ -4982,40 +4788,24 @@ type SessionFilter struct { Key SessionFilterKey // The filter value. Valid values for each filter key are as follows: - // - // * - // InvokedAfter: Specify a timestamp to limit your results. For example, specify - // 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later. - // - // * - // InvokedBefore: Specify a timestamp to limit your results. For example, specify - // 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018. - // - // * - // Target: Specify a managed node to which session connections have been made. - // - // * - // Owner: Specify an Amazon Web Services user to see a list of sessions started by - // that user. - // - // * Status: Specify a valid session status to see a list of all - // sessions with that status. Status values you can specify include: - // - // * - // Connected - // - // * Connecting - // - // * Disconnected - // - // * Terminated - // - // * Terminating - // - // * - // Failed - // - // * SessionId: Specify a session ID to return details about the session. + // - InvokedAfter: Specify a timestamp to limit your results. For example, + // specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and + // later. + // - InvokedBefore: Specify a timestamp to limit your results. For example, + // specify 2018-08-29T00:00:00Z to see sessions that started before August 29, + // 2018. + // - Target: Specify a managed node to which session connections have been made. + // - Owner: Specify an Amazon Web Services user to see a list of sessions + // started by that user. + // - Status: Specify a valid session status to see a list of all sessions with + // that status. Status values you can specify include: + // - Connected + // - Connecting + // - Disconnected + // - Terminated + // - Terminating + // - Failed + // - SessionId: Specify a session ID to return details about the session. // // This member is required. Value *string @@ -5040,8 +4830,8 @@ type SessionManagerOutputUrl struct { type SeveritySummary struct { // The total number of resources or compliance items that have a severity level of - // Critical. Critical severity is determined by the organization that published the - // compliance items. + // Critical . Critical severity is determined by the organization that published + // the compliance items. CriticalCount int32 // The total number of resources or compliance items that have a severity level of @@ -5078,8 +4868,8 @@ type StepExecution struct { // The action this step performs. The action determines the behavior of the step. Action *string - // If a step has finished execution, this contains the time the execution ended. If - // the step hasn't yet concluded, this field isn't populated. + // If a step has finished execution, this contains the time the execution ended. + // If the step hasn't yet concluded, this field isn't populated. ExecutionEndTime *time.Time // If a step has begun execution, this contains the time the step started. If the @@ -5099,18 +4889,18 @@ type StepExecution struct { // leads to the Automation failure. IsCritical *bool - // The flag which can be used to end automation no matter whether the step succeeds - // or fails. + // The flag which can be used to end automation no matter whether the step + // succeeds or fails. IsEnd *bool // The maximum number of tries to run the action of the step. The default value is - // 1. + // 1 . MaxAttempts *int32 // The next step after the step succeeds. NextStep *string - // The action to take if the step fails. The default value is Abort. + // The action to take if the step fails. The default value is Abort . OnFailure *string // Returned values from the execution of the step. @@ -5199,61 +4989,39 @@ type Tag struct { // Run Command-type tasks. Depending on the task, targets are optional for other // maintenance window task types (Automation, Lambda, and Step Functions). For more // information about running tasks that don't specify targets, see Registering -// maintenance window tasks without targets -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) +// maintenance window tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. Supported formats include // the following. -// -// * Key=InstanceIds,Values=,, -// -// * Key=tag:,Values=, -// -// * -// Key=tag-key,Values=, -// -// * Run Command and Maintenance window targets only: -// Key=resource-groups:Name,Values= -// -// * Maintenance window targets only: -// Key=resource-groups:ResourceTypeFilters,Values=, -// -// * Automation targets only: -// Key=ResourceGroup;Values= +// - Key=InstanceIds,Values=,, +// - Key=tag:,Values=, +// - Key=tag-key,Values=, +// - Run Command and Maintenance window targets only: +// Key=resource-groups:Name,Values= +// - Maintenance window targets only: +// Key=resource-groups:ResourceTypeFilters,Values=, +// - Automation targets only: Key=ResourceGroup;Values= // // For example: // -// * -// Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE -// -// * -// Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3 -// -// * -// Key=tag-key,Values=Name,Instance-Type,CostCenter -// -// * Run Command and Maintenance -// window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup -// This example demonstrates how to target all resources in the resource group -// ProductionResourceGroup in your maintenance window. -// -// * Maintenance window -// targets only: -// Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC -// This example demonstrates how to target only Amazon Elastic Compute Cloud -// (Amazon EC2) instances and VPCs in your maintenance window. -// -// * Automation -// targets only: Key=ResourceGroup,Values=MyResourceGroup -// -// * State Manager -// association targets only: Key=InstanceIds,Values=* This example demonstrates how -// to target all managed instances in the Amazon Web Services Region where the -// association was created. +// - +// Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE +// - Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3 +// - Key=tag-key,Values=Name,Instance-Type,CostCenter +// - Run Command and Maintenance window targets only: +// Key=resource-groups:Name,Values=ProductionResourceGroup This example +// demonstrates how to target all resources in the resource group +// ProductionResourceGroup in your maintenance window. +// - Maintenance window targets only: +// Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC +// This example demonstrates how to target only Amazon Elastic Compute Cloud +// (Amazon EC2) instances and VPCs in your maintenance window. +// - Automation targets only: Key=ResourceGroup,Values=MyResourceGroup +// - State Manager association targets only: Key=InstanceIds,Values=* This +// example demonstrates how to target all managed instances in the Amazon Web +// Services Region where the association was created. // -// For more information about how to send commands that -// target managed nodes using Key,Value parameters, see Targeting multiple -// instances -// (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting) +// For more information about how to send commands that target managed nodes using +// Key,Value parameters, see Targeting multiple instances (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting) // in the Amazon Web Services Systems Manager User Guide. type Target struct { @@ -5261,11 +5029,11 @@ type Target struct { // the criteria. Key *string - // User-defined criteria that maps to Key. For example, if you specified - // tag:ServerRole, you could specify value:WebServer to run a command on instances - // that include EC2 tags of ServerRole,WebServer. Depending on the type of target, - // the maximum number of values for a key might be lower than the global maximum of - // 50. + // User-defined criteria that maps to Key . For example, if you specified + // tag:ServerRole , you could specify value:WebServer to run a command on + // instances that include EC2 tags of ServerRole,WebServer . Depending on the type + // of target, the maximum number of values for a key might be lower than the global + // maximum of 50. Values []string noSmithyDocumentSerde @@ -5279,7 +5047,7 @@ type TargetLocation struct { Accounts []string // The Automation execution role used by the currently running Automation. If not - // specified, the default value is AWS-SystemsManager-AutomationExecutionRole. + // specified, the default value is AWS-SystemsManager-AutomationExecutionRole . ExecutionRoleName *string // The Amazon Web Services Regions targeted by the current Automation execution. @@ -5293,8 +5061,8 @@ type TargetLocation struct { // accounts allowed to run the Automation concurrently. TargetLocationMaxConcurrency *string - // The maximum number of errors allowed before the system stops queueing additional - // Automation executions for the currently running Automation. + // The maximum number of errors allowed before the system stops queueing + // additional Automation executions for the currently running Automation. TargetLocationMaxErrors *string noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_client.go b/service/ssmcontacts/api_client.go index b49f26bc13e..df56975e687 100644 --- a/service/ssmcontacts/api_client.go +++ b/service/ssmcontacts/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssmcontacts/api_op_AcceptPage.go b/service/ssmcontacts/api_op_AcceptPage.go index ccca32e7853..e6a20bc181b 100644 --- a/service/ssmcontacts/api_op_AcceptPage.go +++ b/service/ssmcontacts/api_op_AcceptPage.go @@ -34,7 +34,7 @@ type AcceptPageInput struct { // This member is required. AcceptCode *string - // The type indicates if the page was DELIVERED or READ. + // The type indicates if the page was DELIVERED or READ . // // This member is required. AcceptType types.AcceptType @@ -44,13 +44,13 @@ type AcceptPageInput struct { // This member is required. PageId *string - // An optional field that Incident Manager uses to ENFORCEAcceptCode validation + // An optional field that Incident Manager uses to ENFORCE AcceptCode validation // when acknowledging an page. Acknowledgement can occur by replying to a page, or // when entering the AcceptCode in the console. Enforcing AcceptCode validation // causes Incident Manager to verify that the code entered by the user matches the - // code sent by Incident Manager with the page. Incident Manager can also - // IGNOREAcceptCode validation. Ignoring AcceptCode validation causes Incident - // Manager to accept any value entered for the AcceptCode. + // code sent by Incident Manager with the page. Incident Manager can also IGNORE + // AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager + // to accept any value entered for the AcceptCode . AcceptCodeValidation types.AcceptCodeValidation // The ARN of the contact channel. diff --git a/service/ssmcontacts/api_op_CreateContact.go b/service/ssmcontacts/api_op_CreateContact.go index 245333d2b65..7c8bc798e8e 100644 --- a/service/ssmcontacts/api_op_CreateContact.go +++ b/service/ssmcontacts/api_op_CreateContact.go @@ -45,7 +45,7 @@ type CreateContactInput struct { // This member is required. Plan *types.Plan - // To create an escalation plan use ESCALATION. To create a contact use PERSONAL. + // To create an escalation plan use ESCALATION . To create a contact use PERSONAL . // // This member is required. Type types.ContactType @@ -57,8 +57,8 @@ type CreateContactInput struct { // details. IdempotencyToken *string - // Adds a tag to the target. You can only tag resources created in the first Region - // of your replication set. + // Adds a tag to the target. You can only tag resources created in the first + // Region of your replication set. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_CreateContactChannel.go b/service/ssmcontacts/api_op_CreateContactChannel.go index 43fe9b340cb..cdefdd3c15e 100644 --- a/service/ssmcontacts/api_op_CreateContactChannel.go +++ b/service/ssmcontacts/api_op_CreateContactChannel.go @@ -31,8 +31,8 @@ func (c *Client) CreateContactChannel(ctx context.Context, params *CreateContact type CreateContactChannelInput struct { - // The Amazon Resource Name (ARN) of the contact you are adding the contact channel - // to. + // The Amazon Resource Name (ARN) of the contact you are adding the contact + // channel to. // // This member is required. ContactId *string @@ -40,14 +40,9 @@ type CreateContactChannelInput struct { // The details that Incident Manager uses when trying to engage the contact // channel. The format is dependent on the type of the contact channel. The // following are the expected formats: - // - // * SMS - '+' followed by the country code - // and phone number - // - // * VOICE - '+' followed by the country code and phone number - // - // * - // EMAIL - any standard email format + // - SMS - '+' followed by the country code and phone number + // - VOICE - '+' followed by the country code and phone number + // - EMAIL - any standard email format // // This member is required. DeliveryAddress *types.ContactChannelAddress @@ -58,13 +53,9 @@ type CreateContactChannelInput struct { Name *string // Incident Manager supports three types of contact channels: - // - // * SMS - // - // * VOICE - // - // * - // EMAIL + // - SMS + // - VOICE + // - EMAIL // // This member is required. Type types.ChannelType diff --git a/service/ssmcontacts/api_op_CreateRotation.go b/service/ssmcontacts/api_op_CreateRotation.go index 4944c3bbcf9..2114f8be96f 100644 --- a/service/ssmcontacts/api_op_CreateRotation.go +++ b/service/ssmcontacts/api_op_CreateRotation.go @@ -50,10 +50,10 @@ type CreateRotationInput struct { // The time zone to base the rotation’s activity on in Internet Assigned Numbers // Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or - // "Asia/Seoul". For more information, see the Time Zone Database - // (https://www.iana.org/time-zones) on the IANA website. Designators for time - // zones that don’t support Daylight Savings Time rules, such as Pacific Standard - // Time (PST) and Pacific Daylight Time (PDT), are not supported. + // "Asia/Seoul". For more information, see the Time Zone Database (https://www.iana.org/time-zones) + // on the IANA website. Designators for time zones that don’t support Daylight + // Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight + // Time (PDT), are not supported. // // This member is required. TimeZoneId *string @@ -67,9 +67,8 @@ type CreateRotationInput struct { // Optional metadata to assign to the rotation. Tags enable you to categorize a // resource in different ways, such as by purpose, owner, or environment. For more - // information, see Tagging Incident Manager resources - // (https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in - // the Incident Manager User Guide. + // information, see Tagging Incident Manager resources (https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) + // in the Incident Manager User Guide. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_CreateRotationOverride.go b/service/ssmcontacts/api_op_CreateRotationOverride.go index e785cc22471..87aa5b5112c 100644 --- a/service/ssmcontacts/api_op_CreateRotationOverride.go +++ b/service/ssmcontacts/api_op_CreateRotationOverride.go @@ -34,9 +34,9 @@ type CreateRotationOverrideInput struct { // This member is required. EndTime *time.Time - // The Amazon Resource Names (ARNs) of the contacts to replace those in the current - // on-call rotation with. If you want to include any current team members in the - // override shift, you must include their ARNs in the new contact ID list. + // The Amazon Resource Names (ARNs) of the contacts to replace those in the + // current on-call rotation with. If you want to include any current team members + // in the override shift, you must include their ARNs in the new contact ID list. // // This member is required. NewContactIds []string diff --git a/service/ssmcontacts/api_op_DescribeEngagement.go b/service/ssmcontacts/api_op_DescribeEngagement.go index 3cb859e121f..3ca1b669c5b 100644 --- a/service/ssmcontacts/api_op_DescribeEngagement.go +++ b/service/ssmcontacts/api_op_DescribeEngagement.go @@ -11,9 +11,9 @@ import ( "time" ) -// Incident Manager uses engagements to engage contacts and escalation plans during -// an incident. Use this command to describe the engagement that occurred during an -// incident. +// Incident Manager uses engagements to engage contacts and escalation plans +// during an incident. Use this command to describe the engagement that occurred +// during an incident. func (c *Client) DescribeEngagement(ctx context.Context, params *DescribeEngagementInput, optFns ...func(*Options)) (*DescribeEngagementOutput, error) { if params == nil { params = &DescribeEngagementInput{} @@ -47,7 +47,7 @@ type DescribeEngagementOutput struct { ContactArn *string // The secure content of the message that was sent to the contact. Use this field - // for engagements to VOICE and EMAIL. + // for engagements to VOICE and EMAIL . // // This member is required. Content *string @@ -63,7 +63,7 @@ type DescribeEngagementOutput struct { Sender *string // The secure subject of the message that was sent to the contact. Use this field - // for engagements to VOICE and EMAIL. + // for engagements to VOICE and EMAIL . // // This member is required. Subject *string @@ -71,12 +71,12 @@ type DescribeEngagementOutput struct { // The ARN of the incident in which the engagement occurred. IncidentId *string - // The insecure content of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure content of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicContent *string - // The insecure subject of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure subject of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicSubject *string // The time that the engagement started. diff --git a/service/ssmcontacts/api_op_DescribePage.go b/service/ssmcontacts/api_op_DescribePage.go index 16fec2dede1..c7863ec5f73 100644 --- a/service/ssmcontacts/api_op_DescribePage.go +++ b/service/ssmcontacts/api_op_DescribePage.go @@ -45,7 +45,7 @@ type DescribePageOutput struct { ContactArn *string // The secure content of the message that was sent to the contact. Use this field - // for engagements to VOICE and EMAIL. + // for engagements to VOICE and EMAIL . // // This member is required. Content *string @@ -66,7 +66,7 @@ type DescribePageOutput struct { Sender *string // The secure subject of the message that was sent to the contact. Use this field - // for engagements to VOICE and EMAIL. + // for engagements to VOICE and EMAIL . // // This member is required. Subject *string @@ -77,12 +77,12 @@ type DescribePageOutput struct { // The ARN of the incident that engaged the contact channel. IncidentId *string - // The insecure content of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure content of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicContent *string - // The insecure subject of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure subject of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicSubject *string // The time that the contact channel acknowledged the engagement. diff --git a/service/ssmcontacts/api_op_GetContact.go b/service/ssmcontacts/api_op_GetContact.go index b71fe0973a2..8a6c7609c5a 100644 --- a/service/ssmcontacts/api_op_GetContact.go +++ b/service/ssmcontacts/api_op_GetContact.go @@ -56,7 +56,7 @@ type GetContactOutput struct { // This member is required. Plan *types.Plan - // The type of contact, either PERSONAL or ESCALATION. + // The type of contact, either PERSONAL or ESCALATION . // // This member is required. Type types.ContactType diff --git a/service/ssmcontacts/api_op_GetContactChannel.go b/service/ssmcontacts/api_op_GetContactChannel.go index 837e21a083d..4a118eef7e2 100644 --- a/service/ssmcontacts/api_op_GetContactChannel.go +++ b/service/ssmcontacts/api_op_GetContactChannel.go @@ -61,7 +61,7 @@ type GetContactChannelOutput struct { // This member is required. Name *string - // The type of contact channel. The type is SMS, VOICE, or EMAIL. + // The type of contact channel. The type is SMS , VOICE , or EMAIL . // // This member is required. Type types.ChannelType diff --git a/service/ssmcontacts/api_op_GetRotationOverride.go b/service/ssmcontacts/api_op_GetRotationOverride.go index 2938e2503dc..e6d3789715c 100644 --- a/service/ssmcontacts/api_op_GetRotationOverride.go +++ b/service/ssmcontacts/api_op_GetRotationOverride.go @@ -52,8 +52,8 @@ type GetRotationOverrideOutput struct { // The date and time when the override ends. EndTime *time.Time - // The Amazon Resource Names (ARNs) of the contacts assigned to the override of the - // on-call rotation. + // The Amazon Resource Names (ARNs) of the contacts assigned to the override of + // the on-call rotation. NewContactIds []string // The Amazon Resource Name (ARN) of the on-call rotation that was overridden. diff --git a/service/ssmcontacts/api_op_ListContactChannels.go b/service/ssmcontacts/api_op_ListContactChannels.go index 16bb140b97c..7dc72296ea4 100644 --- a/service/ssmcontacts/api_op_ListContactChannels.go +++ b/service/ssmcontacts/api_op_ListContactChannels.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListContactChannelsMiddlewares(stack *middleware.St return nil } -// ListContactChannelsAPIClient is a client that implements the ListContactChannels -// operation. +// ListContactChannelsAPIClient is a client that implements the +// ListContactChannels operation. type ListContactChannelsAPIClient interface { ListContactChannels(context.Context, *ListContactChannelsInput, ...func(*Options)) (*ListContactChannelsOutput, error) } diff --git a/service/ssmcontacts/api_op_ListContacts.go b/service/ssmcontacts/api_op_ListContacts.go index be1118474c5..fcbd2bb17a1 100644 --- a/service/ssmcontacts/api_op_ListContacts.go +++ b/service/ssmcontacts/api_op_ListContacts.go @@ -40,7 +40,7 @@ type ListContactsInput struct { NextToken *string // The type of contact. A contact is type PERSONAL and an escalation plan is type - // ESCALATION. + // ESCALATION . Type types.ContactType noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_ListPageResolutions.go b/service/ssmcontacts/api_op_ListPageResolutions.go index f21cf7f7a32..a76bbb84d95 100644 --- a/service/ssmcontacts/api_op_ListPageResolutions.go +++ b/service/ssmcontacts/api_op_ListPageResolutions.go @@ -125,8 +125,8 @@ func (c *Client) addOperationListPageResolutionsMiddlewares(stack *middleware.St return nil } -// ListPageResolutionsAPIClient is a client that implements the ListPageResolutions -// operation. +// ListPageResolutionsAPIClient is a client that implements the +// ListPageResolutions operation. type ListPageResolutionsAPIClient interface { ListPageResolutions(context.Context, *ListPageResolutionsInput, ...func(*Options)) (*ListPageResolutionsOutput, error) } diff --git a/service/ssmcontacts/api_op_ListRotations.go b/service/ssmcontacts/api_op_ListRotations.go index eb084650370..3a0b9bc9f10 100644 --- a/service/ssmcontacts/api_op_ListRotations.go +++ b/service/ssmcontacts/api_op_ListRotations.go @@ -38,8 +38,8 @@ type ListRotationsInput struct { NextToken *string // A filter to include rotations in list results based on their common prefix. For - // example, entering prod returns a list of all rotation names that begin with - // prod, such as production and prod-1. + // example, entering prod returns a list of all rotation names that begin with prod + // , such as production and prod-1 . RotationNamePrefix *string noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_PutContactPolicy.go b/service/ssmcontacts/api_op_PutContactPolicy.go index 9e8da4db622..56f2b8aaa3c 100644 --- a/service/ssmcontacts/api_op_PutContactPolicy.go +++ b/service/ssmcontacts/api_op_PutContactPolicy.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a resource policy to the specified contact or escalation plan. The resource -// policy is used to share the contact or escalation plan using Resource Access -// Manager (RAM). For more information about cross-account sharing, see Setting up -// cross-account functionality -// (https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html). +// Adds a resource policy to the specified contact or escalation plan. The +// resource policy is used to share the contact or escalation plan using Resource +// Access Manager (RAM). For more information about cross-account sharing, see +// Setting up cross-account functionality (https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html) +// . func (c *Client) PutContactPolicy(ctx context.Context, params *PutContactPolicyInput, optFns ...func(*Options)) (*PutContactPolicyOutput, error) { if params == nil { params = &PutContactPolicyInput{} diff --git a/service/ssmcontacts/api_op_StartEngagement.go b/service/ssmcontacts/api_op_StartEngagement.go index 8afadfdabb0..0b73b6e86aa 100644 --- a/service/ssmcontacts/api_op_StartEngagement.go +++ b/service/ssmcontacts/api_op_StartEngagement.go @@ -36,7 +36,7 @@ type StartEngagementInput struct { ContactId *string // The secure content of the message that was sent to the contact. Use this field - // for engagements to VOICE or EMAIL. + // for engagements to VOICE or EMAIL . // // This member is required. Content *string @@ -47,7 +47,7 @@ type StartEngagementInput struct { Sender *string // The secure subject of the message that was sent to the contact. Use this field - // for engagements to VOICE or EMAIL. + // for engagements to VOICE or EMAIL . // // This member is required. Subject *string @@ -59,12 +59,12 @@ type StartEngagementInput struct { // The ARN of the incident that the engagement is part of. IncidentId *string - // The insecure content of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure content of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicContent *string - // The insecure subject of the message that was sent to the contact. Use this field - // for engagements to SMS. + // The insecure subject of the message that was sent to the contact. Use this + // field for engagements to SMS . PublicSubject *string noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_StopEngagement.go b/service/ssmcontacts/api_op_StopEngagement.go index 98a68e152a0..e86ee25ec32 100644 --- a/service/ssmcontacts/api_op_StopEngagement.go +++ b/service/ssmcontacts/api_op_StopEngagement.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an engagement before it finishes the final stage of the escalation plan or -// engagement plan. Further contacts aren't engaged. +// Stops an engagement before it finishes the final stage of the escalation plan +// or engagement plan. Further contacts aren't engaged. func (c *Client) StopEngagement(ctx context.Context, params *StopEngagementInput, optFns ...func(*Options)) (*StopEngagementOutput, error) { if params == nil { params = &StopEngagementInput{} diff --git a/service/ssmcontacts/api_op_UpdateRotation.go b/service/ssmcontacts/api_op_UpdateRotation.go index 7b4875d9b69..f6ce6ca4af6 100644 --- a/service/ssmcontacts/api_op_UpdateRotation.go +++ b/service/ssmcontacts/api_op_UpdateRotation.go @@ -51,10 +51,10 @@ type UpdateRotationInput struct { // The time zone to base the updated rotation’s activity on, in Internet Assigned // Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or - // "Asia/Seoul". For more information, see the Time Zone Database - // (https://www.iana.org/time-zones) on the IANA website. Designators for time - // zones that don’t support Daylight Savings Time Rules, such as Pacific Standard - // Time (PST) and Pacific Daylight Time (PDT), aren't supported. + // "Asia/Seoul". For more information, see the Time Zone Database (https://www.iana.org/time-zones) + // on the IANA website. Designators for time zones that don’t support Daylight + // Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight + // Time (PDT), aren't supported. TimeZoneId *string noSmithyDocumentSerde diff --git a/service/ssmcontacts/doc.go b/service/ssmcontacts/doc.go index bb26eb9075d..023c1fcb1b9 100644 --- a/service/ssmcontacts/doc.go +++ b/service/ssmcontacts/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package ssmcontacts provides the API client, operations, and parameter types for -// AWS Systems Manager Incident Manager Contacts. +// Package ssmcontacts provides the API client, operations, and parameter types +// for AWS Systems Manager Incident Manager Contacts. // // Systems Manager Incident Manager is an incident management console designed to // help users mitigate and recover from incidents affecting their Amazon Web diff --git a/service/ssmcontacts/types/enums.go b/service/ssmcontacts/types/enums.go index a0885e164be..bab001774b0 100644 --- a/service/ssmcontacts/types/enums.go +++ b/service/ssmcontacts/types/enums.go @@ -109,9 +109,9 @@ const ( DayOfWeekSun DayOfWeek = "SUN" ) -// Values returns all known values for DayOfWeek. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for DayOfWeek. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (DayOfWeek) Values() []DayOfWeek { return []DayOfWeek{ "MON", @@ -156,9 +156,9 @@ const ( ShiftTypeOverridden ShiftType = "OVERRIDDEN" ) -// Values returns all known values for ShiftType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ShiftType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ShiftType) Values() []ShiftType { return []ShiftType{ "REGULAR", diff --git a/service/ssmcontacts/types/types.go b/service/ssmcontacts/types/types.go index 54ec5ad2ce4..92acfd68b21 100644 --- a/service/ssmcontacts/types/types.go +++ b/service/ssmcontacts/types/types.go @@ -38,7 +38,7 @@ type Contact struct { ContactArn *string // Refers to the type of contact. A single contact is type PERSONAL and an - // escalation plan is type ESCALATION. + // escalation plan is type ESCALATION . // // This member is required. Type ContactType @@ -82,12 +82,9 @@ type ContactChannel struct { // The type of the contact channel. Incident Manager supports three contact // methods: - // - // * SMS - // - // * VOICE - // - // * EMAIL + // - SMS + // - VOICE + // - EMAIL Type ChannelType noSmithyDocumentSerde @@ -99,14 +96,9 @@ type ContactChannelAddress struct { // The format is dependent on the type of the contact channel. The following are // the expected formats: - // - // * SMS - '+' followed by the country code and phone - // number - // - // * VOICE - '+' followed by the country code and phone number - // - // * EMAIL - - // any standard email format + // - SMS - '+' followed by the country code and phone number + // - VOICE - '+' followed by the country code and phone number + // - EMAIL - any standard email format SimpleAddress *string noSmithyDocumentSerde @@ -292,12 +284,12 @@ type PreviewOverride struct { // Records events during an engagement. type Receipt struct { - // The time receipt was SENT, DELIVERED, or READ. + // The time receipt was SENT , DELIVERED , or READ . // // This member is required. ReceiptTime *time.Time - // The type follows the engagement cycle, SENT, DELIVERED, and READ. + // The type follows the engagement cycle, SENT , DELIVERED , and READ . // // This member is required. ReceiptType ReceiptType @@ -412,8 +404,8 @@ type RotationOverride struct { // This member is required. EndTime *time.Time - // The Amazon Resource Names (ARNs) of the contacts assigned to the override of the - // on-call rotation. + // The Amazon Resource Names (ARNs) of the contacts assigned to the override of + // the on-call rotation. // // This member is required. NewContactIds []string @@ -474,8 +466,8 @@ type ShiftDetails struct { // specified contacts or contact methods. type Stage struct { - // The time to wait until beginning the next stage. The duration can only be set to - // 0 if a target is specified. + // The time to wait until beginning the next stage. The duration can only be set + // to 0 if a target is specified. // // This member is required. DurationInMinutes *int32 diff --git a/service/ssmincidents/api_client.go b/service/ssmincidents/api_client.go index e5c6b8e3b09..7de9fde52f1 100644 --- a/service/ssmincidents/api_client.go +++ b/service/ssmincidents/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssmincidents/api_op_CreateReplicationSet.go b/service/ssmincidents/api_op_CreateReplicationSet.go index d8c52d0d641..d1291c6f5dc 100644 --- a/service/ssmincidents/api_op_CreateReplicationSet.go +++ b/service/ssmincidents/api_op_CreateReplicationSet.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A replication set replicates and encrypts your data to the provided Regions with -// the provided KMS key. +// A replication set replicates and encrypts your data to the provided Regions +// with the provided KMS key. func (c *Client) CreateReplicationSet(ctx context.Context, params *CreateReplicationSetInput, optFns ...func(*Options)) (*CreateReplicationSetOutput, error) { if params == nil { params = &CreateReplicationSetInput{} diff --git a/service/ssmincidents/api_op_CreateTimelineEvent.go b/service/ssmincidents/api_op_CreateTimelineEvent.go index 8833582e9de..94b001b876f 100644 --- a/service/ssmincidents/api_op_CreateTimelineEvent.go +++ b/service/ssmincidents/api_op_CreateTimelineEvent.go @@ -44,7 +44,7 @@ type CreateTimelineEventInput struct { // This member is required. EventTime *time.Time - // The type of event. You can create timeline events of type Custom Event. + // The type of event. You can create timeline events of type Custom Event . // // This member is required. EventType *string @@ -55,11 +55,11 @@ type CreateTimelineEventInput struct { // This member is required. IncidentRecordArn *string - // A token that ensures that a client calls the action only once with the specified - // details. + // A token that ensures that a client calls the action only once with the + // specified details. ClientToken *string - // Adds one or more references to the TimelineEvent. A reference is an Amazon Web + // Adds one or more references to the TimelineEvent . A reference is an Amazon Web // Services resource involved or associated with the incident. To specify a // reference, enter its Amazon Resource Name (ARN). You can also specify a related // item associated with a resource. For example, to specify an Amazon DynamoDB diff --git a/service/ssmincidents/api_op_DeleteTimelineEvent.go b/service/ssmincidents/api_op_DeleteTimelineEvent.go index 97fe6638593..d3ab7017897 100644 --- a/service/ssmincidents/api_op_DeleteTimelineEvent.go +++ b/service/ssmincidents/api_op_DeleteTimelineEvent.go @@ -28,8 +28,8 @@ func (c *Client) DeleteTimelineEvent(ctx context.Context, params *DeleteTimeline type DeleteTimelineEventInput struct { - // The ID of the event to update. You can use ListTimelineEvents to find an event's - // ID. + // The ID of the event to update. You can use ListTimelineEvents to find an + // event's ID. // // This member is required. EventId *string diff --git a/service/ssmincidents/api_op_GetReplicationSet.go b/service/ssmincidents/api_op_GetReplicationSet.go index a968b8b013f..d733ad9428b 100644 --- a/service/ssmincidents/api_op_GetReplicationSet.go +++ b/service/ssmincidents/api_op_GetReplicationSet.go @@ -141,8 +141,8 @@ type WaitForReplicationSetActiveWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, WaitForReplicationSetActiveWaiter will use default max delay of 30 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, WaitForReplicationSetActiveWaiter will use default max delay of 30 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration @@ -356,8 +356,8 @@ type WaitForReplicationSetDeletedWaiterOptions struct { // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, WaitForReplicationSetDeletedWaiter will use default max delay of 30 + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, WaitForReplicationSetDeletedWaiter will use default max delay of 30 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration diff --git a/service/ssmincidents/api_op_GetResourcePolicies.go b/service/ssmincidents/api_op_GetResourcePolicies.go index d88621e911e..c2ea88b9376 100644 --- a/service/ssmincidents/api_op_GetResourcePolicies.go +++ b/service/ssmincidents/api_op_GetResourcePolicies.go @@ -124,8 +124,8 @@ func (c *Client) addOperationGetResourcePoliciesMiddlewares(stack *middleware.St return nil } -// GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies -// operation. +// GetResourcePoliciesAPIClient is a client that implements the +// GetResourcePolicies operation. type GetResourcePoliciesAPIClient interface { GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error) } diff --git a/service/ssmincidents/api_op_GetTimelineEvent.go b/service/ssmincidents/api_op_GetTimelineEvent.go index 466e9aeba94..34851f72722 100644 --- a/service/ssmincidents/api_op_GetTimelineEvent.go +++ b/service/ssmincidents/api_op_GetTimelineEvent.go @@ -30,7 +30,7 @@ func (c *Client) GetTimelineEvent(ctx context.Context, params *GetTimelineEventI type GetTimelineEventInput struct { // The ID of the event. You can get an event's ID when you create it, or by using - // ListTimelineEvents. + // ListTimelineEvents . // // This member is required. EventId *string diff --git a/service/ssmincidents/api_op_ListIncidentRecords.go b/service/ssmincidents/api_op_ListIncidentRecords.go index f2b56d0fe3f..d930195dc26 100644 --- a/service/ssmincidents/api_op_ListIncidentRecords.go +++ b/service/ssmincidents/api_op_ListIncidentRecords.go @@ -33,27 +33,16 @@ type ListIncidentRecordsInput struct { // Filters the list of incident records you want to search through. You can filter // on the following keys: - // - // * creationTime - // - // * impact - // - // * status - // - // * createdBy - // - // Note - // the following when when you use Filters: - // - // * If you don't specify a Filter, the - // response includes all incident records. - // - // * If you specify more than one filter - // in a single request, the response returns incident records that match all - // filters. - // - // * If you specify a filter with more than one value, the response - // returns incident records that match any of the values provided. + // - creationTime + // - impact + // - status + // - createdBy + // Note the following when when you use Filters: + // - If you don't specify a Filter, the response includes all incident records. + // - If you specify more than one filter in a single request, the response + // returns incident records that match all filters. + // - If you specify a filter with more than one value, the response returns + // incident records that match any of the values provided. Filters []types.Filter // The maximum number of results per page. @@ -144,8 +133,8 @@ func (c *Client) addOperationListIncidentRecordsMiddlewares(stack *middleware.St return nil } -// ListIncidentRecordsAPIClient is a client that implements the ListIncidentRecords -// operation. +// ListIncidentRecordsAPIClient is a client that implements the +// ListIncidentRecords operation. type ListIncidentRecordsAPIClient interface { ListIncidentRecords(context.Context, *ListIncidentRecordsInput, ...func(*Options)) (*ListIncidentRecordsOutput, error) } diff --git a/service/ssmincidents/api_op_ListReplicationSets.go b/service/ssmincidents/api_op_ListReplicationSets.go index 4731a825172..dcb9c0951c0 100644 --- a/service/ssmincidents/api_op_ListReplicationSets.go +++ b/service/ssmincidents/api_op_ListReplicationSets.go @@ -114,8 +114,8 @@ func (c *Client) addOperationListReplicationSetsMiddlewares(stack *middleware.St return nil } -// ListReplicationSetsAPIClient is a client that implements the ListReplicationSets -// operation. +// ListReplicationSetsAPIClient is a client that implements the +// ListReplicationSets operation. type ListReplicationSetsAPIClient interface { ListReplicationSets(context.Context, *ListReplicationSetsInput, ...func(*Options)) (*ListReplicationSetsOutput, error) } diff --git a/service/ssmincidents/api_op_ListTimelineEvents.go b/service/ssmincidents/api_op_ListTimelineEvents.go index e2636e8e1b5..61c8ea3a6fb 100644 --- a/service/ssmincidents/api_op_ListTimelineEvents.go +++ b/service/ssmincidents/api_op_ListTimelineEvents.go @@ -37,23 +37,14 @@ type ListTimelineEventsInput struct { // Filters the timeline events based on the provided conditional values. You can // filter timeline events with the following keys: - // - // * eventTime - // - // * eventType - // - // Note - // the following when deciding how to use Filters: - // - // * If you don't specify a - // Filter, the response includes all timeline events. - // - // * If you specify more than - // one filter in a single request, the response returns timeline events that match - // all filters. - // - // * If you specify a filter with more than one value, the response - // returns timeline events that match any of the values provided. + // - eventTime + // - eventType + // Note the following when deciding how to use Filters: + // - If you don't specify a Filter, the response includes all timeline events. + // - If you specify more than one filter in a single request, the response + // returns timeline events that match all filters. + // - If you specify a filter with more than one value, the response returns + // timeline events that match any of the values provided. Filters []types.Filter // The maximum number of results per page. diff --git a/service/ssmincidents/api_op_PutResourcePolicy.go b/service/ssmincidents/api_op_PutResourcePolicy.go index a93c24eeafd..01e07fcfc2f 100644 --- a/service/ssmincidents/api_op_PutResourcePolicy.go +++ b/service/ssmincidents/api_op_PutResourcePolicy.go @@ -13,8 +13,8 @@ import ( // Adds a resource policy to the specified response plan. The resource policy is // used to share the response plan using Resource Access Manager (RAM). For more // information about cross-account sharing, see Cross-Region and cross-account -// incident management -// (https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-cross-account-cross-region.html). +// incident management (https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-cross-account-cross-region.html) +// . func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} diff --git a/service/ssmincidents/api_op_StartIncident.go b/service/ssmincidents/api_op_StartIncident.go index 02e6d20dc4f..fed4d6ff78c 100644 --- a/service/ssmincidents/api_op_StartIncident.go +++ b/service/ssmincidents/api_op_StartIncident.go @@ -43,27 +43,19 @@ type StartIncidentInput struct { // Defines the impact to the customers. Providing an impact overwrites the impact // provided by a response plan. Possible impacts: - // - // * 1 - Critical impact, this - // typically relates to full application failure that impacts many to all - // customers. - // - // * 2 - High impact, partial application failure with impact to many - // customers. - // - // * 3 - Medium impact, the application is providing reduced service to - // customers. - // - // * 4 - Low impact, customer might aren't impacted by the problem - // yet. - // - // * 5 - No impact, customers aren't currently impacted but urgent action is - // needed to avoid impact. + // - 1 - Critical impact, this typically relates to full application failure that + // impacts many to all customers. + // - 2 - High impact, partial application failure with impact to many customers. + // - 3 - Medium impact, the application is providing reduced service to + // customers. + // - 4 - Low impact, customer might aren't impacted by the problem yet. + // - 5 - No impact, customers aren't currently impacted but urgent action is + // needed to avoid impact. Impact *int32 - // Add related items to the incident for other responders to use. Related items are - // Amazon Web Services resources, external links, or files uploaded to an Amazon S3 - // bucket. + // Add related items to the incident for other responders to use. Related items + // are Amazon Web Services resources, external links, or files uploaded to an + // Amazon S3 bucket. RelatedItems []types.RelatedItem // Provide a title for the incident. Providing a title overwrites the title diff --git a/service/ssmincidents/api_op_UpdateIncidentRecord.go b/service/ssmincidents/api_op_UpdateIncidentRecord.go index 7fc6f77e31c..cd7ec3c9a1e 100644 --- a/service/ssmincidents/api_op_UpdateIncidentRecord.go +++ b/service/ssmincidents/api_op_UpdateIncidentRecord.go @@ -14,8 +14,8 @@ import ( // Update the details of an incident record. You can use this operation to update // an incident record from the defined chat channel. For more information about -// using actions in chat channels, see Interacting through chat -// (https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact). +// using actions in chat channels, see Interacting through chat (https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact) +// . func (c *Client) UpdateIncidentRecord(ctx context.Context, params *UpdateIncidentRecordInput, optFns ...func(*Options)) (*UpdateIncidentRecordOutput, error) { if params == nil { params = &UpdateIncidentRecordInput{} @@ -45,24 +45,17 @@ type UpdateIncidentRecordInput struct { // specified details. ClientToken *string - // Defines the impact of the incident to customers and applications. If you provide - // an impact for an incident, it overwrites the impact provided by the response - // plan. Possible impacts: - // - // * 1 - Critical impact, full application failure that - // impacts many to all customers. - // - // * 2 - High impact, partial application failure - // with impact to many customers. - // - // * 3 - Medium impact, the application is - // providing reduced service to customers. - // - // * 4 - Low impact, customer aren't - // impacted by the problem yet. - // - // * 5 - No impact, customers aren't currently - // impacted but urgent action is needed to avoid impact. + // Defines the impact of the incident to customers and applications. If you + // provide an impact for an incident, it overwrites the impact provided by the + // response plan. Possible impacts: + // - 1 - Critical impact, full application failure that impacts many to all + // customers. + // - 2 - High impact, partial application failure with impact to many customers. + // - 3 - Medium impact, the application is providing reduced service to + // customers. + // - 4 - Low impact, customer aren't impacted by the problem yet. + // - 5 - No impact, customers aren't currently impacted but urgent action is + // needed to avoid impact. Impact *int32 // The Amazon SNS targets that Incident Manager notifies when a client updates an @@ -70,7 +63,7 @@ type UpdateIncidentRecordInput struct { // Region is down during the incident. NotificationTargets []types.NotificationTargetItem - // The status of the incident. Possible statuses are Open or Resolved. + // The status of the incident. Possible statuses are Open or Resolved . Status types.IncidentRecordStatus // A longer description of what occurred during the incident. diff --git a/service/ssmincidents/api_op_UpdateResponsePlan.go b/service/ssmincidents/api_op_UpdateResponsePlan.go index 43b3f469c63..c754aaf0862 100644 --- a/service/ssmincidents/api_op_UpdateResponsePlan.go +++ b/service/ssmincidents/api_op_UpdateResponsePlan.go @@ -60,17 +60,11 @@ type UpdateResponsePlanInput struct { // Defines the impact to the customers. Providing an impact overwrites the impact // provided by a response plan. Possible impacts: - // - // * 5 - Severe impact - // - // * 4 - High - // impact - // - // * 3 - Medium impact - // - // * 2 - Low impact - // - // * 1 - No impact + // - 5 - Severe impact + // - 4 - High impact + // - 3 - Medium impact + // - 2 - Low impact + // - 1 - No impact IncidentTemplateImpact *int32 // The Amazon SNS targets that are notified when updates are made to an incident. diff --git a/service/ssmincidents/api_op_UpdateTimelineEvent.go b/service/ssmincidents/api_op_UpdateTimelineEvent.go index 712a33f61f2..f2dda68f75d 100644 --- a/service/ssmincidents/api_op_UpdateTimelineEvent.go +++ b/service/ssmincidents/api_op_UpdateTimelineEvent.go @@ -13,7 +13,7 @@ import ( "time" ) -// Updates a timeline event. You can update events of type Custom Event. +// Updates a timeline event. You can update events of type Custom Event . func (c *Client) UpdateTimelineEvent(ctx context.Context, params *UpdateTimelineEventInput, optFns ...func(*Options)) (*UpdateTimelineEventOutput, error) { if params == nil { params = &UpdateTimelineEventInput{} @@ -31,8 +31,8 @@ func (c *Client) UpdateTimelineEvent(ctx context.Context, params *UpdateTimeline type UpdateTimelineEventInput struct { - // The ID of the event to update. You can use ListTimelineEvents to find an event's - // ID. + // The ID of the event to update. You can use ListTimelineEvents to find an + // event's ID. // // This member is required. EventId *string @@ -49,8 +49,8 @@ type UpdateTimelineEventInput struct { // A short description of the event. EventData *string - // Updates all existing references in a TimelineEvent. A reference is an Amazon Web - // Services resource involved or associated with the incident. To specify a + // Updates all existing references in a TimelineEvent . A reference is an Amazon + // Web Services resource involved or associated with the incident. To specify a // reference, enter its Amazon Resource Name (ARN). You can also specify a related // item associated with that resource. For example, to specify an Amazon DynamoDB // (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon @@ -63,7 +63,7 @@ type UpdateTimelineEventInput struct { // The time that the event occurred. EventTime *time.Time - // The type of event. You can update events of type Custom Event. + // The type of event. You can update events of type Custom Event . EventType *string noSmithyDocumentSerde diff --git a/service/ssmincidents/types/enums.go b/service/ssmincidents/types/enums.go index 36ec2740688..9073d03323b 100644 --- a/service/ssmincidents/types/enums.go +++ b/service/ssmincidents/types/enums.go @@ -66,9 +66,9 @@ const ( RegionStatusFailed RegionStatus = "FAILED" ) -// Values returns all known values for RegionStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RegionStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RegionStatus) Values() []RegionStatus { return []RegionStatus{ "ACTIVE", @@ -119,9 +119,9 @@ const ( ResourceTypeResourcePolicy ResourceType = "RESOURCE_POLICY" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "RESPONSE_PLAN", @@ -156,9 +156,9 @@ const ( SortOrderDescending SortOrder = "DESCENDING" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASCENDING", @@ -208,9 +208,9 @@ const ( VariableTypeInvolvedResources VariableType = "INVOLVED_RESOURCES" ) -// Values returns all known values for VariableType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for VariableType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (VariableType) Values() []VariableType { return []VariableType{ "INCIDENT_RECORD_ARN", diff --git a/service/ssmincidents/types/types.go b/service/ssmincidents/types/types.go index 129e835ac36..fc92acc6b5d 100644 --- a/service/ssmincidents/types/types.go +++ b/service/ssmincidents/types/types.go @@ -17,8 +17,8 @@ type Action interface { isAction() } -// The Systems Manager automation document to start as the runbook at the beginning -// of the incident. +// The Systems Manager automation document to start as the runbook at the +// beginning of the incident. type ActionMemberSsmAutomation struct { Value SsmAutomation @@ -119,10 +119,10 @@ type ChatChannelMemberEmpty struct { func (*ChatChannelMemberEmpty) isChatChannel() {} -// A conditional statement with which to compare a value, after a timestamp, before -// a timestamp, or equal to a string or integer. If multiple conditions are -// specified, the conditionals become an ANDed statement. If multiple values are -// specified for a conditional, the values are ORd. +// A conditional statement with which to compare a value, after a timestamp, +// before a timestamp, or equal to a string or integer. If multiple conditions are +// specified, the conditionals become an AND ed statement. If multiple values are +// specified for a conditional, the values are OR d. // // The following types satisfy this interface: // @@ -182,8 +182,8 @@ type DynamicSsmParameterValue interface { isDynamicSsmParameterValue() } -// Variable dynamic parameters. A parameter value is determined when an incident is -// created. +// Variable dynamic parameters. A parameter value is determined when an incident +// is created. type DynamicSsmParameterValueMemberVariable struct { Value VariableType @@ -209,7 +209,7 @@ type EventReference interface { isEventReference() } -// The ID of a RelatedItem referenced in a TimelineEvent. +// The ID of a RelatedItem referenced in a TimelineEvent . type EventReferenceMemberRelatedItemId struct { Value string @@ -219,7 +219,7 @@ type EventReferenceMemberRelatedItemId struct { func (*EventReferenceMemberRelatedItemId) isEventReference() {} // The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in -// a TimelineEvent. +// a TimelineEvent . type EventReferenceMemberResource struct { Value string @@ -241,7 +241,7 @@ type EventSummary struct { // This member is required. EventTime *time.Time - // The type of event. The timeline event must be Custom Event. + // The type of event. The timeline event must be Custom Event . // // This member is required. EventType *string @@ -256,7 +256,7 @@ type EventSummary struct { // This member is required. IncidentRecordArn *string - // A list of references in a TimelineEvent. + // A list of references in a TimelineEvent . EventReferences []EventReference noSmithyDocumentSerde @@ -363,7 +363,7 @@ type IncidentRecordSource struct { // This member is required. Source *string - // The service principal that assumed the role specified in createdBy. If no + // The service principal that assumed the role specified in createdBy . If no // service principal assumed the role this will be left blank. InvokedBy *string @@ -401,8 +401,8 @@ type IncidentRecordSummary struct { // This member is required. Status IncidentRecordStatus - // The title of the incident. This value is either provided by the response plan or - // overwritten on creation. + // The title of the incident. This value is either provided by the response plan + // or overwritten on creation. // // This member is required. Title *string @@ -646,7 +646,7 @@ type RelatedItem struct { // This member is required. Identifier *ItemIdentifier - // A unique ID for a RelatedItem. Don't specify this parameter when you add a + // A unique ID for a RelatedItem . Don't specify this parameter when you add a // RelatedItem by using the UpdateRelatedItems API action. GeneratedId *string @@ -733,8 +733,8 @@ type ReplicationSet struct { noSmithyDocumentSerde } -// The resource policy that allows Incident Manager to perform actions on resources -// on your behalf. +// The resource policy that allows Incident Manager to perform actions on +// resources on your behalf. type ResourcePolicy struct { // The JSON blob that describes the policy. @@ -792,8 +792,8 @@ type SsmAutomation struct { // The automation document's version to use when running. DocumentVersion *string - // The key-value pair to resolve dynamic parameter values when processing a Systems - // Manager Automation runbook. + // The key-value pair to resolve dynamic parameter values when processing a + // Systems Manager Automation runbook. DynamicParameters map[string]DynamicSsmParameterValue // The key-value pair parameters to use when running the automation document. @@ -840,7 +840,7 @@ type TimelineEvent struct { // This member is required. IncidentRecordArn *string - // A list of references in a TimelineEvent. + // A list of references in a TimelineEvent . EventReferences []EventReference noSmithyDocumentSerde @@ -850,9 +850,9 @@ type TimelineEvent struct { type TriggerDetails struct { // Identifies the service that sourced the event. All events sourced from within - // Amazon Web Services begin with "aws." Customer-generated events can have any - // value here, as long as it doesn't begin with "aws." We recommend the use of Java - // package-name style reverse domain-name strings. + // Amazon Web Services begin with " aws. " Customer-generated events can have any + // value here, as long as it doesn't begin with " aws. " We recommend the use of + // Java package-name style reverse domain-name strings. // // This member is required. Source *string diff --git a/service/ssmsap/api_client.go b/service/ssmsap/api_client.go index 9bfe6546e98..3e9ac99af21 100644 --- a/service/ssmsap/api_client.go +++ b/service/ssmsap/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssmsap/api_op_DeregisterApplication.go b/service/ssmsap/api_op_DeregisterApplication.go index 3abdfed460e..606919c03cc 100644 --- a/service/ssmsap/api_op_DeregisterApplication.go +++ b/service/ssmsap/api_op_DeregisterApplication.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregister an SAP application with AWS Systems Manager for SAP. This action does -// not affect the existing setup of your SAP workloads on Amazon EC2. +// Deregister an SAP application with AWS Systems Manager for SAP. This action +// does not affect the existing setup of your SAP workloads on Amazon EC2. func (c *Client) DeregisterApplication(ctx context.Context, params *DeregisterApplicationInput, optFns ...func(*Options)) (*DeregisterApplicationOutput, error) { if params == nil { params = &DeregisterApplicationInput{} diff --git a/service/ssmsap/api_op_GetApplication.go b/service/ssmsap/api_op_GetApplication.go index 369ea55d795..0074d432251 100644 --- a/service/ssmsap/api_op_GetApplication.go +++ b/service/ssmsap/api_op_GetApplication.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets an application registered with AWS Systems Manager for SAP. It also returns -// the components of the application. +// Gets an application registered with AWS Systems Manager for SAP. It also +// returns the components of the application. func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error) { if params == nil { params = &GetApplicationInput{} diff --git a/service/ssmsap/api_op_GetDatabase.go b/service/ssmsap/api_op_GetDatabase.go index 8c4e8e4d690..e9db1fc1ff7 100644 --- a/service/ssmsap/api_op_GetDatabase.go +++ b/service/ssmsap/api_op_GetDatabase.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the SAP HANA database of an application registered with AWS Systems Manager -// for SAP. +// Gets the SAP HANA database of an application registered with AWS Systems +// Manager for SAP. func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optFns ...func(*Options)) (*GetDatabaseOutput, error) { if params == nil { params = &GetDatabaseInput{} diff --git a/service/ssmsap/api_op_UntagResource.go b/service/ssmsap/api_op_UntagResource.go index dd06a3ecff1..b259426e0b3 100644 --- a/service/ssmsap/api_op_UntagResource.go +++ b/service/ssmsap/api_op_UntagResource.go @@ -33,8 +33,8 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // Adds/updates or removes credentials for applications registered with AWS Systems - // Manager for SAP. + // Adds/updates or removes credentials for applications registered with AWS + // Systems Manager for SAP. // // This member is required. TagKeys []string diff --git a/service/ssmsap/types/enums.go b/service/ssmsap/types/enums.go index aac848827a9..84cf595c818 100644 --- a/service/ssmsap/types/enums.go +++ b/service/ssmsap/types/enums.go @@ -128,9 +128,9 @@ const ( DatabaseTypeTenant DatabaseType = "TENANT" ) -// Values returns all known values for DatabaseType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DatabaseType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DatabaseType) Values() []DatabaseType { return []DatabaseType{ "SYSTEM", diff --git a/service/ssmsap/types/types.go b/service/ssmsap/types/types.go index 18b1fe3cfd3..d5d67e3f3eb 100644 --- a/service/ssmsap/types/types.go +++ b/service/ssmsap/types/types.go @@ -50,8 +50,8 @@ type ApplicationCredential struct { // This member is required. DatabaseName *string - // The secret ID created in AWS Secrets Manager to store the credentials of the SAP - // application. + // The secret ID created in AWS Secrets Manager to store the credentials of the + // SAP application. // // This member is required. SecretId *string @@ -125,8 +125,8 @@ type ComponentSummary struct { noSmithyDocumentSerde } -// The SAP HANA database of the application registered with AWS Systems Manager for -// SAP. +// The SAP HANA database of the application registered with AWS Systems Manager +// for SAP. type Database struct { // The ID of the application. diff --git a/service/sso/api_client.go b/service/sso/api_client.go index 7bb06984442..6f30ddc9948 100644 --- a/service/sso/api_client.go +++ b/service/sso/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sso/api_op_GetRoleCredentials.go b/service/sso/api_op_GetRoleCredentials.go index 1c2b7499d58..e3b50cdb29e 100644 --- a/service/sso/api_op_GetRoleCredentials.go +++ b/service/sso/api_op_GetRoleCredentials.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the STS short-term credentials for a given role name that is assigned to -// the user. +// Returns the STS short-term credentials for a given role name that is assigned +// to the user. func (c *Client) GetRoleCredentials(ctx context.Context, params *GetRoleCredentialsInput, optFns ...func(*Options)) (*GetRoleCredentialsOutput, error) { if params == nil { params = &GetRoleCredentialsInput{} @@ -30,8 +30,7 @@ func (c *Client) GetRoleCredentials(ctx context.Context, params *GetRoleCredenti type GetRoleCredentialsInput struct { // The token issued by the CreateToken API call. For more information, see - // CreateToken - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) + // CreateToken (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) // in the IAM Identity Center OIDC API Reference Guide. // // This member is required. diff --git a/service/sso/api_op_ListAccountRoles.go b/service/sso/api_op_ListAccountRoles.go index 4fffc77af54..14e753e78a9 100644 --- a/service/sso/api_op_ListAccountRoles.go +++ b/service/sso/api_op_ListAccountRoles.go @@ -30,8 +30,7 @@ func (c *Client) ListAccountRoles(ctx context.Context, params *ListAccountRolesI type ListAccountRolesInput struct { // The token issued by the CreateToken API call. For more information, see - // CreateToken - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) + // CreateToken (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) // in the IAM Identity Center OIDC API Reference Guide. // // This member is required. diff --git a/service/sso/api_op_ListAccounts.go b/service/sso/api_op_ListAccounts.go index e717a426c54..7848b01d2dd 100644 --- a/service/sso/api_op_ListAccounts.go +++ b/service/sso/api_op_ListAccounts.go @@ -12,8 +12,7 @@ import ( ) // Lists all AWS accounts assigned to the user. These AWS accounts are assigned by -// the administrator of the account. For more information, see Assign User Access -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers) +// the administrator of the account. For more information, see Assign User Access (https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers) // in the IAM Identity Center User Guide. This operation returns a paginated // response. func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error) { @@ -34,8 +33,7 @@ func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, op type ListAccountsInput struct { // The token issued by the CreateToken API call. For more information, see - // CreateToken - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) + // CreateToken (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) // in the IAM Identity Center OIDC API Reference Guide. // // This member is required. diff --git a/service/sso/api_op_Logout.go b/service/sso/api_op_Logout.go index 8b9b44745e7..407f9d1b3b3 100644 --- a/service/sso/api_op_Logout.go +++ b/service/sso/api_op_Logout.go @@ -19,9 +19,8 @@ import ( // temporary AWS credentials are returned to the client. After user logout, any // existing IAM role sessions that were created by using IAM Identity Center // permission sets continue based on the duration configured in the permission set. -// For more information, see User authentications -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html) in -// the IAM Identity Center User Guide. +// For more information, see User authentications (https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html) +// in the IAM Identity Center User Guide. func (c *Client) Logout(ctx context.Context, params *LogoutInput, optFns ...func(*Options)) (*LogoutOutput, error) { if params == nil { params = &LogoutInput{} @@ -40,8 +39,7 @@ func (c *Client) Logout(ctx context.Context, params *LogoutInput, optFns ...func type LogoutInput struct { // The token issued by the CreateToken API call. For more information, see - // CreateToken - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) + // CreateToken (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) // in the IAM Identity Center OIDC API Reference Guide. // // This member is required. diff --git a/service/sso/doc.go b/service/sso/doc.go index f981b154fb4..59456d5dc27 100644 --- a/service/sso/doc.go +++ b/service/sso/doc.go @@ -9,14 +9,13 @@ // and roles assigned to them and get federated into the application. Although AWS // Single Sign-On was renamed, the sso and identitystore API namespaces will // continue to retain their original name for backward compatibility purposes. For -// more information, see IAM Identity Center rename -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed). -// This reference guide describes the IAM Identity Center Portal operations that +// more information, see IAM Identity Center rename (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed) +// . This reference guide describes the IAM Identity Center Portal operations that // you can call programatically and includes detailed information on data types and // errors. AWS provides SDKs that consist of libraries and sample code for various // programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. // The SDKs provide a convenient way to create programmatic access to IAM Identity // Center and other AWS services. For more information about the AWS SDKs, -// including how to download and install them, see Tools for Amazon Web Services -// (http://aws.amazon.com/tools/). +// including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/) +// . package sso diff --git a/service/sso/types/types.go b/service/sso/types/types.go index 051056b7598..8dc02296b11 100644 --- a/service/sso/types/types.go +++ b/service/sso/types/types.go @@ -26,8 +26,7 @@ type RoleCredentials struct { // The identifier used for the temporary security credentials. For more // information, see Using Temporary Security Credentials to Request Access to AWS - // Resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) + // Resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) // in the AWS IAM User Guide. AccessKeyId *string @@ -35,14 +34,12 @@ type RoleCredentials struct { Expiration int64 // The key that is used to sign the request. For more information, see Using - // Temporary Security Credentials to Request Access to AWS Resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) + // Temporary Security Credentials to Request Access to AWS Resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) // in the AWS IAM User Guide. SecretAccessKey *string // The token used for temporary credentials. For more information, see Using - // Temporary Security Credentials to Request Access to AWS Resources - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) + // Temporary Security Credentials to Request Access to AWS Resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) // in the AWS IAM User Guide. SessionToken *string diff --git a/service/ssoadmin/api_client.go b/service/ssoadmin/api_client.go index 7cc44d3dbcb..065f2a02b69 100644 --- a/service/ssoadmin/api_client.go +++ b/service/ssoadmin/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go b/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go index c3a9e1babbc..a7751fc0553 100644 --- a/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go +++ b/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches the specified customer managed policy to the specified PermissionSet. +// Attaches the specified customer managed policy to the specified PermissionSet . func (c *Client) AttachCustomerManagedPolicyReferenceToPermissionSet(ctx context.Context, params *AttachCustomerManagedPolicyReferenceToPermissionSetInput, optFns ...func(*Options)) (*AttachCustomerManagedPolicyReferenceToPermissionSetOutput, error) { if params == nil { params = &AttachCustomerManagedPolicyReferenceToPermissionSetInput{} @@ -42,7 +42,7 @@ type AttachCustomerManagedPolicyReferenceToPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string diff --git a/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go b/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go index 559e8d1565c..f99195ec449 100644 --- a/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go +++ b/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches an AWS managed policy ARN to a permission set. If the permission set is -// already referenced by one or more account assignments, you will need to call +// Attaches an AWS managed policy ARN to a permission set. If the permission set +// is already referenced by one or more account assignments, you will need to call // ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet // applies the corresponding IAM policy updates to all assigned accounts. func (c *Client) AttachManagedPolicyToPermissionSet(ctx context.Context, params *AttachManagedPolicyToPermissionSetInput, optFns ...func(*Options)) (*AttachManagedPolicyToPermissionSetOutput, error) { diff --git a/service/ssoadmin/api_op_CreateAccountAssignment.go b/service/ssoadmin/api_op_CreateAccountAssignment.go index a54461535d5..ca811bf1c0a 100644 --- a/service/ssoadmin/api_op_CreateAccountAssignment.go +++ b/service/ssoadmin/api_op_CreateAccountAssignment.go @@ -46,16 +46,16 @@ type CreateAccountAssignmentInput struct { // This member is required. InstanceArn *string - // The ARN of the permission set that the admin wants to grant the principal access - // to. + // The ARN of the permission set that the admin wants to grant the principal + // access to. // // This member is required. PermissionSetArn *string // An identifier for an object in IAM Identity Center, such as a user or group. // PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For - // more information about PrincipalIds in IAM Identity Center, see the IAM Identity - // Center Identity Store API Reference. + // more information about PrincipalIds in IAM Identity Center, see the IAM + // Identity Center Identity Store API Reference . // // This member is required. PrincipalId *string diff --git a/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go index 7e9dab4f1fa..650dccd4f91 100644 --- a/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the attributes-based access control (ABAC) feature for the specified IAM -// Identity Center instance. You can also specify new attributes to add to your +// Enables the attributes-based access control (ABAC) feature for the specified +// IAM Identity Center instance. You can also specify new attributes to add to your // ABAC configuration during the enabling process. For more information about ABAC, // see Attribute-Based Access Control in the IAM Identity Center User Guide. After // a successful response, call DescribeInstanceAccessControlAttributeConfiguration diff --git a/service/ssoadmin/api_op_CreatePermissionSet.go b/service/ssoadmin/api_op_CreatePermissionSet.go index 56f65e099c2..703fcbd75e7 100644 --- a/service/ssoadmin/api_op_CreatePermissionSet.go +++ b/service/ssoadmin/api_op_CreatePermissionSet.go @@ -13,7 +13,7 @@ import ( // Creates a permission set within a specified IAM Identity Center instance. To // grant users and groups access to AWS account resources, use -// CreateAccountAssignment. +// CreateAccountAssignment . func (c *Client) CreatePermissionSet(ctx context.Context, params *CreatePermissionSetInput, optFns ...func(*Options)) (*CreatePermissionSetOutput, error) { if params == nil { params = &CreatePermissionSetInput{} @@ -38,12 +38,12 @@ type CreatePermissionSetInput struct { // This member is required. InstanceArn *string - // The name of the PermissionSet. + // The name of the PermissionSet . // // This member is required. Name *string - // The description of the PermissionSet. + // The description of the PermissionSet . Description *string // Used to redirect users within the application during the federation @@ -54,7 +54,7 @@ type CreatePermissionSetInput struct { // standard. SessionDuration *string - // The tags to attach to the new PermissionSet. + // The tags to attach to the new PermissionSet . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssoadmin/api_op_DeleteAccountAssignment.go b/service/ssoadmin/api_op_DeleteAccountAssignment.go index 816ea17dbb6..650494fd0c1 100644 --- a/service/ssoadmin/api_op_DeleteAccountAssignment.go +++ b/service/ssoadmin/api_op_DeleteAccountAssignment.go @@ -46,8 +46,8 @@ type DeleteAccountAssignmentInput struct { // An identifier for an object in IAM Identity Center, such as a user or group. // PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For - // more information about PrincipalIds in IAM Identity Center, see the IAM Identity - // Center Identity Store API Reference. + // more information about PrincipalIds in IAM Identity Center, see the IAM + // Identity Center Identity Store API Reference . // // This member is required. PrincipalId *string diff --git a/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go b/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go index 0f5e43ef83d..e4d43dd070b 100644 --- a/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go +++ b/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the permissions boundary from a specified PermissionSet. +// Deletes the permissions boundary from a specified PermissionSet . func (c *Client) DeletePermissionsBoundaryFromPermissionSet(ctx context.Context, params *DeletePermissionsBoundaryFromPermissionSetInput, optFns ...func(*Options)) (*DeletePermissionsBoundaryFromPermissionSetOutput, error) { if params == nil { params = &DeletePermissionsBoundaryFromPermissionSetInput{} @@ -34,7 +34,7 @@ type DeletePermissionsBoundaryFromPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string diff --git a/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go index a09a0e43117..a210b398e54 100644 --- a/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of IAM Identity Center identity store attributes that have been -// configured to work with attributes-based access control (ABAC) for the specified -// IAM Identity Center instance. This will not return attributes configured and -// sent by an external identity provider. For more information about ABAC, see -// Attribute-Based Access Control in the IAM Identity Center User Guide. +// Returns the list of IAM Identity Center identity store attributes that have +// been configured to work with attributes-based access control (ABAC) for the +// specified IAM Identity Center instance. This will not return attributes +// configured and sent by an external identity provider. For more information about +// ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide. func (c *Client) DescribeInstanceAccessControlAttributeConfiguration(ctx context.Context, params *DescribeInstanceAccessControlAttributeConfigurationInput, optFns ...func(*Options)) (*DescribeInstanceAccessControlAttributeConfigurationOutput, error) { if params == nil { params = &DescribeInstanceAccessControlAttributeConfigurationInput{} diff --git a/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go b/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go index eb48280132a..e7f50eade5e 100644 --- a/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go +++ b/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches the specified customer managed policy from the specified PermissionSet. +// Detaches the specified customer managed policy from the specified PermissionSet . func (c *Client) DetachCustomerManagedPolicyReferenceFromPermissionSet(ctx context.Context, params *DetachCustomerManagedPolicyReferenceFromPermissionSetInput, optFns ...func(*Options)) (*DetachCustomerManagedPolicyReferenceFromPermissionSetOutput, error) { if params == nil { params = &DetachCustomerManagedPolicyReferenceFromPermissionSetInput{} @@ -42,7 +42,7 @@ type DetachCustomerManagedPolicyReferenceFromPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string diff --git a/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go b/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go index 7ff24433f9d..018bf87d66d 100644 --- a/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go +++ b/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Obtains the permissions boundary for a specified PermissionSet. +// Obtains the permissions boundary for a specified PermissionSet . func (c *Client) GetPermissionsBoundaryForPermissionSet(ctx context.Context, params *GetPermissionsBoundaryForPermissionSetInput, optFns ...func(*Options)) (*GetPermissionsBoundaryForPermissionSetOutput, error) { if params == nil { params = &GetPermissionsBoundaryForPermissionSetInput{} @@ -35,7 +35,7 @@ type GetPermissionsBoundaryForPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string diff --git a/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go b/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go index 8908553710d..5f20ac4957b 100644 --- a/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go +++ b/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the status of the AWS account assignment creation requests for a specified -// IAM Identity Center instance. +// Lists the status of the AWS account assignment creation requests for a +// specified IAM Identity Center instance. func (c *Client) ListAccountAssignmentCreationStatus(ctx context.Context, params *ListAccountAssignmentCreationStatusInput, optFns ...func(*Options)) (*ListAccountAssignmentCreationStatusOutput, error) { if params == nil { params = &ListAccountAssignmentCreationStatusInput{} @@ -137,8 +137,8 @@ type ListAccountAssignmentCreationStatusAPIClient interface { var _ ListAccountAssignmentCreationStatusAPIClient = (*Client)(nil) -// ListAccountAssignmentCreationStatusPaginatorOptions is the paginator options for -// ListAccountAssignmentCreationStatus +// ListAccountAssignmentCreationStatusPaginatorOptions is the paginator options +// for ListAccountAssignmentCreationStatus type ListAccountAssignmentCreationStatusPaginatorOptions struct { // The maximum number of results to display for the assignment. Limit int32 diff --git a/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go b/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go index e8c5ba3f3f2..f866ff72f0b 100644 --- a/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go +++ b/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the status of the AWS account assignment deletion requests for a specified -// IAM Identity Center instance. +// Lists the status of the AWS account assignment deletion requests for a +// specified IAM Identity Center instance. func (c *Client) ListAccountAssignmentDeletionStatus(ctx context.Context, params *ListAccountAssignmentDeletionStatusInput, optFns ...func(*Options)) (*ListAccountAssignmentDeletionStatusOutput, error) { if params == nil { params = &ListAccountAssignmentDeletionStatusInput{} @@ -137,8 +137,8 @@ type ListAccountAssignmentDeletionStatusAPIClient interface { var _ ListAccountAssignmentDeletionStatusAPIClient = (*Client)(nil) -// ListAccountAssignmentDeletionStatusPaginatorOptions is the paginator options for -// ListAccountAssignmentDeletionStatus +// ListAccountAssignmentDeletionStatusPaginatorOptions is the paginator options +// for ListAccountAssignmentDeletionStatus type ListAccountAssignmentDeletionStatusPaginatorOptions struct { // The maximum number of results to display for the assignment. Limit int32 diff --git a/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go b/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go index 23800441e2d..0f18c57ba98 100644 --- a/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go +++ b/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go @@ -43,7 +43,7 @@ type ListAccountsForProvisionedPermissionSetInput struct { // This member is required. PermissionSetArn *string - // The maximum number of results to display for the PermissionSet. + // The maximum number of results to display for the PermissionSet . MaxResults *int32 // The pagination token for the list API. Initially the value is null. Use the @@ -58,7 +58,7 @@ type ListAccountsForProvisionedPermissionSetInput struct { type ListAccountsForProvisionedPermissionSetOutput struct { - // The list of AWS AccountIds. + // The list of AWS AccountIds . AccountIds []string // The pagination token for the list API. Initially the value is null. Use the @@ -134,18 +134,18 @@ func (c *Client) addOperationListAccountsForProvisionedPermissionSetMiddlewares( return nil } -// ListAccountsForProvisionedPermissionSetAPIClient is a client that implements the -// ListAccountsForProvisionedPermissionSet operation. +// ListAccountsForProvisionedPermissionSetAPIClient is a client that implements +// the ListAccountsForProvisionedPermissionSet operation. type ListAccountsForProvisionedPermissionSetAPIClient interface { ListAccountsForProvisionedPermissionSet(context.Context, *ListAccountsForProvisionedPermissionSetInput, ...func(*Options)) (*ListAccountsForProvisionedPermissionSetOutput, error) } var _ ListAccountsForProvisionedPermissionSetAPIClient = (*Client)(nil) -// ListAccountsForProvisionedPermissionSetPaginatorOptions is the paginator options -// for ListAccountsForProvisionedPermissionSet +// ListAccountsForProvisionedPermissionSetPaginatorOptions is the paginator +// options for ListAccountsForProvisionedPermissionSet type ListAccountsForProvisionedPermissionSetPaginatorOptions struct { - // The maximum number of results to display for the PermissionSet. + // The maximum number of results to display for the PermissionSet . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go b/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go index a351bd50d48..d29dfea7aca 100644 --- a/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go +++ b/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all customer managed policies attached to a specified PermissionSet. +// Lists all customer managed policies attached to a specified PermissionSet . func (c *Client) ListCustomerManagedPolicyReferencesInPermissionSet(ctx context.Context, params *ListCustomerManagedPolicyReferencesInPermissionSetInput, optFns ...func(*Options)) (*ListCustomerManagedPolicyReferencesInPermissionSetOutput, error) { if params == nil { params = &ListCustomerManagedPolicyReferencesInPermissionSetInput{} @@ -36,7 +36,7 @@ type ListCustomerManagedPolicyReferencesInPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string diff --git a/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go b/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go index 709f8113631..947de2a8aa7 100644 --- a/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go +++ b/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go @@ -42,7 +42,7 @@ type ListManagedPoliciesInPermissionSetInput struct { // This member is required. PermissionSetArn *string - // The maximum number of results to display for the PermissionSet. + // The maximum number of results to display for the PermissionSet . MaxResults *int32 // The pagination token for the list API. Initially the value is null. Use the @@ -141,7 +141,7 @@ var _ ListManagedPoliciesInPermissionSetAPIClient = (*Client)(nil) // ListManagedPoliciesInPermissionSetPaginatorOptions is the paginator options for // ListManagedPoliciesInPermissionSet type ListManagedPoliciesInPermissionSetPaginatorOptions struct { - // The maximum number of results to display for the PermissionSet. + // The maximum number of results to display for the PermissionSet . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go b/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go index 871b858fe0f..b7ffd7f8a06 100644 --- a/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go +++ b/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the status of the permission set provisioning requests for a specified IAM -// Identity Center instance. +// Lists the status of the permission set provisioning requests for a specified +// IAM Identity Center instance. func (c *Client) ListPermissionSetProvisioningStatus(ctx context.Context, params *ListPermissionSetProvisioningStatusInput, optFns ...func(*Options)) (*ListPermissionSetProvisioningStatusOutput, error) { if params == nil { params = &ListPermissionSetProvisioningStatusInput{} @@ -137,8 +137,8 @@ type ListPermissionSetProvisioningStatusAPIClient interface { var _ ListPermissionSetProvisioningStatusAPIClient = (*Client)(nil) -// ListPermissionSetProvisioningStatusPaginatorOptions is the paginator options for -// ListPermissionSetProvisioningStatus +// ListPermissionSetProvisioningStatusPaginatorOptions is the paginator options +// for ListPermissionSetProvisioningStatus type ListPermissionSetProvisioningStatusPaginatorOptions struct { // The maximum number of results to display for the assignment. Limit int32 diff --git a/service/ssoadmin/api_op_ListPermissionSets.go b/service/ssoadmin/api_op_ListPermissionSets.go index 8ca16cd84bd..00cb0255523 100644 --- a/service/ssoadmin/api_op_ListPermissionSets.go +++ b/service/ssoadmin/api_op_ListPermissionSets.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the PermissionSets in an IAM Identity Center instance. +// Lists the PermissionSet s in an IAM Identity Center instance. func (c *Client) ListPermissionSets(ctx context.Context, params *ListPermissionSetsInput, optFns ...func(*Options)) (*ListPermissionSetsOutput, error) { if params == nil { params = &ListPermissionSetsInput{} diff --git a/service/ssoadmin/api_op_ListTagsForResource.go b/service/ssoadmin/api_op_ListTagsForResource.go index e97882a5123..3079f9532d0 100644 --- a/service/ssoadmin/api_op_ListTagsForResource.go +++ b/service/ssoadmin/api_op_ListTagsForResource.go @@ -127,8 +127,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go b/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go index aadef2fa8ee..70c76781846 100644 --- a/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go +++ b/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go @@ -31,7 +31,7 @@ func (c *Client) PutInlinePolicyToPermissionSet(ctx context.Context, params *Put type PutInlinePolicyToPermissionSetInput struct { - // The inline policy to attach to a PermissionSet. + // The inline policy to attach to a PermissionSet . // // This member is required. InlinePolicy *string diff --git a/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go b/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go index ee7175a9a78..57c804dea3e 100644 --- a/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go +++ b/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go @@ -36,12 +36,12 @@ type PutPermissionsBoundaryToPermissionSetInput struct { // This member is required. InstanceArn *string - // The ARN of the PermissionSet. + // The ARN of the PermissionSet . // // This member is required. PermissionSetArn *string - // The permissions boundary that you want to attach to a PermissionSet. + // The permissions boundary that you want to attach to a PermissionSet . // // This member is required. PermissionsBoundary *types.PermissionsBoundary diff --git a/service/ssoadmin/api_op_UpdatePermissionSet.go b/service/ssoadmin/api_op_UpdatePermissionSet.go index c468bc6fa09..04f7f5e4259 100644 --- a/service/ssoadmin/api_op_UpdatePermissionSet.go +++ b/service/ssoadmin/api_op_UpdatePermissionSet.go @@ -40,7 +40,7 @@ type UpdatePermissionSetInput struct { // This member is required. PermissionSetArn *string - // The description of the PermissionSet. + // The description of the PermissionSet . Description *string // Used to redirect users within the application during the federation diff --git a/service/ssoadmin/doc.go b/service/ssoadmin/doc.go index 5022cdf70b8..e52767e993e 100644 --- a/service/ssoadmin/doc.go +++ b/service/ssoadmin/doc.go @@ -8,23 +8,20 @@ // across AWS accounts and applications. IAM Identity Center is the recommended // approach for workforce authentication and authorization in AWS, for // organizations of any size and type. Although AWS Single Sign-On was renamed, the -// sso and identitystore API namespaces will continue to retain their original name -// for backward compatibility purposes. For more information, see IAM Identity -// Center rename -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed). -// This reference guide provides information on single sign-on operations which +// sso and identitystore API namespaces will continue to retain their original +// name for backward compatibility purposes. For more information, see IAM +// Identity Center rename (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed) +// . This reference guide provides information on single sign-on operations which // could be used for access management of AWS accounts. For information about IAM -// Identity Center features, see the IAM Identity Center User Guide -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html). Many -// operations in the IAM Identity Center APIs rely on identifiers for users and -// groups, known as principals. For more information about how to work with +// Identity Center features, see the IAM Identity Center User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) +// . Many operations in the IAM Identity Center APIs rely on identifiers for users +// and groups, known as principals. For more information about how to work with // principals and principal IDs in IAM Identity Center, see the Identity Store API -// Reference -// (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html). -// AWS provides SDKs that consist of libraries and sample code for various +// Reference (https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html) +// . AWS provides SDKs that consist of libraries and sample code for various // programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). // The SDKs provide a convenient way to create programmatic access to IAM Identity // Center and other AWS services. For more information about the AWS SDKs, -// including how to download and install them, see Tools for Amazon Web Services -// (http://aws.amazon.com/tools/). +// including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/) +// . package ssoadmin diff --git a/service/ssoadmin/types/enums.go b/service/ssoadmin/types/enums.go index 68812fed6b6..02aac94c37c 100644 --- a/service/ssoadmin/types/enums.go +++ b/service/ssoadmin/types/enums.go @@ -86,9 +86,9 @@ const ( StatusValuesSucceeded StatusValues = "SUCCEEDED" ) -// Values returns all known values for StatusValues. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for StatusValues. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (StatusValues) Values() []StatusValues { return []StatusValues{ "IN_PROGRESS", diff --git a/service/ssoadmin/types/types.go b/service/ssoadmin/types/types.go index 1e018b78295..5065b6192e5 100644 --- a/service/ssoadmin/types/types.go +++ b/service/ssoadmin/types/types.go @@ -11,7 +11,7 @@ import ( // for use in attributes-based access control (ABAC). You can create permissions // policies that determine who can access your AWS resources based upon the // configured attribute values. When you enable ABAC and specify -// AccessControlAttributes, IAM Identity Center passes the attribute values of the +// AccessControlAttributes , IAM Identity Center passes the attribute values of the // authenticated user into IAM for use in policy evaluation. type AccessControlAttribute struct { @@ -30,9 +30,8 @@ type AccessControlAttribute struct { noSmithyDocumentSerde } -// The value used for mapping a specified attribute to an identity source. For more -// information, see Attribute mappings -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/attributemappingsconcept.html) +// The value used for mapping a specified attribute to an identity source. For +// more information, see Attribute mappings (https://docs.aws.amazon.com/singlesignon/latest/userguide/attributemappingsconcept.html) // in the IAM Identity Center User Guide. type AccessControlAttributeValue struct { @@ -59,8 +58,8 @@ type AccountAssignment struct { // An identifier for an object in IAM Identity Center, such as a user or group. // PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For - // more information about PrincipalIds in IAM Identity Center, see the IAM Identity - // Center Identity Store API Reference. + // more information about PrincipalIds in IAM Identity Center, see the IAM + // Identity Center Identity Store API Reference . PrincipalId *string // The entity type for which the assignment will be created. @@ -85,8 +84,8 @@ type AccountAssignmentOperationStatus struct { // An identifier for an object in IAM Identity Center, such as a user or group. // PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For - // more information about PrincipalIds in IAM Identity Center, see the IAM Identity - // Center Identity Store API Reference. + // more information about PrincipalIds in IAM Identity Center, see the IAM + // Identity Center Identity Store API Reference . PrincipalId *string // The entity type for which the assignment will be created. @@ -150,9 +149,8 @@ type CustomerManagedPolicyReference struct { Name *string // The path to the IAM policy that you have configured in each account where you - // want to deploy your permission set. The default is /. For more information, see - // Friendly names and paths - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) + // want to deploy your permission set. The default is / . For more information, see + // Friendly names and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) // in the IAM User Guide. Path *string @@ -202,13 +200,11 @@ type OperationStatusFilter struct { // policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A // permissions boundary represents the maximum permissions that any policy can // grant your role. For more information, see Permissions boundaries for IAM -// entities -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) +// entities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) // in the IAM User Guide. Policies used as permissions boundaries don't provide // permissions. You must also attach an IAM policy to the role. To learn how the // effective permissions for a role are evaluated, see IAM JSON policy evaluation -// logic -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) +// logic (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) // in the IAM User Guide. type PermissionsBoundary struct { @@ -230,7 +226,7 @@ type PermissionSet struct { // The date that the permission set was created. CreatedDate *time.Time - // The description of the PermissionSet. + // The description of the PermissionSet . Description *string // The name of the permission set. @@ -251,8 +247,8 @@ type PermissionSet struct { noSmithyDocumentSerde } -// A structure that is used to provide the status of the provisioning operation for -// a specified permission set. +// A structure that is used to provide the status of the provisioning operation +// for a specified permission set. type PermissionSetProvisioningStatus struct { // The identifier of the AWS account from which to list the assignments. diff --git a/service/ssooidc/api_client.go b/service/ssooidc/api_client.go index 5e0a85a2c1a..111f66d3b9c 100644 --- a/service/ssooidc/api_client.go +++ b/service/ssooidc/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/ssooidc/api_op_CreateToken.go b/service/ssooidc/api_op_CreateToken.go index cde97b4f3ab..2c2d4393a35 100644 --- a/service/ssooidc/api_op_CreateToken.go +++ b/service/ssooidc/api_op_CreateToken.go @@ -43,7 +43,7 @@ type CreateTokenInput struct { // Supports grant types for the authorization code, refresh token, and device code // request. For device code requests, specify the following value: - // urn:ietf:params:oauth:grant-type:device_code For information about how to + // urn:ietf:params:oauth:grant-type:device_code For information about how to // obtain the device code, see the StartDeviceAuthorization topic. // // This member is required. @@ -65,9 +65,8 @@ type CreateTokenInput struct { // Currently, refreshToken is not yet implemented and is not supported. For more // information about the features and limitations of the current IAM Identity // Center OIDC implementation, see Considerations for Using this Guide in the IAM - // Identity Center OIDC API Reference - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html). - // The token used to obtain an access token in the event that the access token is + // Identity Center OIDC API Reference (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html) + // . The token used to obtain an access token in the event that the access token is // invalid or expired. RefreshToken *string @@ -89,22 +88,20 @@ type CreateTokenOutput struct { // Currently, idToken is not yet implemented and is not supported. For more // information about the features and limitations of the current IAM Identity // Center OIDC implementation, see Considerations for Using this Guide in the IAM - // Identity Center OIDC API Reference - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html). - // The identifier of the user that associated with the access token, if present. + // Identity Center OIDC API Reference (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html) + // . The identifier of the user that associated with the access token, if present. IdToken *string // Currently, refreshToken is not yet implemented and is not supported. For more // information about the features and limitations of the current IAM Identity // Center OIDC implementation, see Considerations for Using this Guide in the IAM - // Identity Center OIDC API Reference - // (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html). - // A token that, if present, can be used to refresh a previously issued access + // Identity Center OIDC API Reference (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html) + // . A token that, if present, can be used to refresh a previously issued access // token that might have expired. RefreshToken *string // Used to notify the client that the returned token is an access token. The - // supported type is BearerToken. + // supported type is BearerToken . TokenType *string // Metadata pertaining to the operation's result. diff --git a/service/ssooidc/api_op_RegisterClient.go b/service/ssooidc/api_op_RegisterClient.go index 3ed8cc35f78..0c8a4b31411 100644 --- a/service/ssooidc/api_op_RegisterClient.go +++ b/service/ssooidc/api_op_RegisterClient.go @@ -40,8 +40,8 @@ type RegisterClientInput struct { // This member is required. ClientType *string - // The list of scopes that are defined by the client. Upon authorization, this list - // is used to restrict permissions when granting an access token. + // The list of scopes that are defined by the client. Upon authorization, this + // list is used to restrict permissions when granting an access token. Scopes []string noSmithyDocumentSerde @@ -59,8 +59,8 @@ type RegisterClientOutput struct { // Indicates the time at which the clientId and clientSecret were issued. ClientIdIssuedAt int64 - // A secret string generated for the client. The client will use this string to get - // authenticated by the service in subsequent calls. + // A secret string generated for the client. The client will use this string to + // get authenticated by the service in subsequent calls. ClientSecret *string // Indicates the time at which the clientId and clientSecret will become invalid. diff --git a/service/ssooidc/api_op_StartDeviceAuthorization.go b/service/ssooidc/api_op_StartDeviceAuthorization.go index 013ccbc9358..42796d7f023 100644 --- a/service/ssooidc/api_op_StartDeviceAuthorization.go +++ b/service/ssooidc/api_op_StartDeviceAuthorization.go @@ -28,9 +28,9 @@ func (c *Client) StartDeviceAuthorization(ctx context.Context, params *StartDevi type StartDeviceAuthorizationInput struct { - // The unique identifier string for the client that is registered with IAM Identity - // Center. This value should come from the persisted result of the RegisterClient - // API operation. + // The unique identifier string for the client that is registered with IAM + // Identity Center. This value should come from the persisted result of the + // RegisterClient API operation. // // This member is required. ClientId *string @@ -42,8 +42,7 @@ type StartDeviceAuthorizationInput struct { ClientSecret *string // The URL for the AWS access portal. For more information, see Using the AWS - // access portal - // (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html) + // access portal (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html) // in the IAM Identity Center User Guide. // // This member is required. @@ -73,9 +72,9 @@ type StartDeviceAuthorizationOutput struct { // device. VerificationUri *string - // An alternate URL that the client can use to automatically launch a browser. This - // process skips the manual step in which the user visits the verification page and - // enters their code. + // An alternate URL that the client can use to automatically launch a browser. + // This process skips the manual step in which the user visits the verification + // page and enters their code. VerificationUriComplete *string // Metadata pertaining to the operation's result. diff --git a/service/ssooidc/doc.go b/service/ssooidc/doc.go index a025f7327eb..2239427d889 100644 --- a/service/ssooidc/doc.go +++ b/service/ssooidc/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package ssooidc provides the API client, operations, and parameter types for AWS -// SSO OIDC. +// Package ssooidc provides the API client, operations, and parameter types for +// AWS SSO OIDC. // // AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) // is a web service that enables a client (such as AWS CLI or a native application) @@ -10,37 +10,27 @@ // with IAM Identity Center. Although AWS Single Sign-On was renamed, the sso and // identitystore API namespaces will continue to retain their original name for // backward compatibility purposes. For more information, see IAM Identity Center -// rename -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed). -// Considerations for Using This Guide Before you begin using this guide, we +// rename (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed) +// . Considerations for Using This Guide Before you begin using this guide, we // recommend that you first review the following important information about how // the IAM Identity Center OIDC service works. +// - The IAM Identity Center OIDC service currently implements only the portions +// of the OAuth 2.0 Device Authorization Grant standard ( +// https://tools.ietf.org/html/rfc8628 (https://tools.ietf.org/html/rfc8628) ) +// that are necessary to enable single sign-on authentication with the AWS CLI. +// Support for other OIDC flows frequently needed for native applications, such as +// Authorization Code Flow (+ PKCE), will be addressed in future releases. +// - The service emits only OIDC access tokens, such that obtaining a new token +// (For example, token refresh) requires explicit user re-authentication. +// - The access tokens provided by this service grant access to all AWS account +// entitlements assigned to an IAM Identity Center user, not just a particular +// application. +// - The documentation in this guide does not describe the mechanism to convert +// the access token into AWS Auth (“sigv4”) credentials for use with IAM-protected +// AWS service endpoints. For more information, see GetRoleCredentials (https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html) +// in the IAM Identity Center Portal API Reference Guide. // -// * The IAM Identity Center OIDC -// service currently implements only the portions of the OAuth 2.0 Device -// Authorization Grant standard (https://tools.ietf.org/html/rfc8628 -// (https://tools.ietf.org/html/rfc8628)) that are necessary to enable single -// sign-on authentication with the AWS CLI. Support for other OIDC flows frequently -// needed for native applications, such as Authorization Code Flow (+ PKCE), will -// be addressed in future releases. -// -// * The service emits only OIDC access tokens, -// such that obtaining a new token (For example, token refresh) requires explicit -// user re-authentication. -// -// * The access tokens provided by this service grant -// access to all AWS account entitlements assigned to an IAM Identity Center user, -// not just a particular application. -// -// * The documentation in this guide does not -// describe the mechanism to convert the access token into AWS Auth (“sigv4”) -// credentials for use with IAM-protected AWS service endpoints. For more -// information, see GetRoleCredentials -// (https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html) -// in the IAM Identity Center Portal API Reference Guide. -// -// For general information -// about IAM Identity Center, see What is IAM Identity Center? -// (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the -// IAM Identity Center User Guide. +// For general information about IAM Identity Center, see What is IAM Identity +// Center? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) +// in the IAM Identity Center User Guide. package ssooidc diff --git a/service/ssooidc/types/errors.go b/service/ssooidc/types/errors.go index 8814b27d17f..115a51a9eb3 100644 --- a/service/ssooidc/types/errors.go +++ b/service/ssooidc/types/errors.go @@ -36,8 +36,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that a request to authorize a client with an access user session token -// is pending. +// Indicates that a request to authorize a client with an access user session +// token is pending. type AuthorizationPendingException struct { Message *string @@ -128,7 +128,7 @@ func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy // Indicates that the clientId or clientSecret in the request is invalid. For // example, this can occur when a client sends an incorrect clientId or an expired -// clientSecret. +// clientSecret . type InvalidClientException struct { Message *string @@ -157,8 +157,8 @@ func (e *InvalidClientException) ErrorCode() string { } func (e *InvalidClientException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that the client information sent in the request during registration is -// invalid. +// Indicates that the client information sent in the request during registration +// is invalid. type InvalidClientMetadataException struct { Message *string diff --git a/service/storagegateway/api_client.go b/service/storagegateway/api_client.go index 66b2dd56df0..362c23c1117 100644 --- a/service/storagegateway/api_client.go +++ b/service/storagegateway/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/storagegateway/api_op_ActivateGateway.go b/service/storagegateway/api_op_ActivateGateway.go index 7aeffc2f64a..08c46570b96 100644 --- a/service/storagegateway/api_op_ActivateGateway.go +++ b/service/storagegateway/api_op_ActivateGateway.go @@ -16,7 +16,7 @@ import ( // want to use for storing snapshots or tapes, the time zone for scheduled // snapshots the gateway snapshot schedule window, an activation key, and a name // for your gateway. The activation process also associates your gateway with your -// account. For more information, see UpdateGatewayInformation. You must turn on +// account. For more information, see UpdateGatewayInformation . You must turn on // the gateway VM before you can activate your gateway. func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInput, optFns ...func(*Options)) (*ActivateGatewayOutput, error) { if params == nil { @@ -34,34 +34,22 @@ func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInp } // A JSON object containing one or more of the following fields: -// -// * -// ActivateGatewayInput$ActivationKey -// -// * ActivateGatewayInput$GatewayName -// -// * -// ActivateGatewayInput$GatewayRegion -// -// * ActivateGatewayInput$GatewayTimezone -// -// * -// ActivateGatewayInput$GatewayType -// -// * ActivateGatewayInput$MediumChangerType -// -// * -// ActivateGatewayInput$TapeDriveType +// - ActivateGatewayInput$ActivationKey +// - ActivateGatewayInput$GatewayName +// - ActivateGatewayInput$GatewayRegion +// - ActivateGatewayInput$GatewayTimezone +// - ActivateGatewayInput$GatewayType +// - ActivateGatewayInput$MediumChangerType +// - ActivateGatewayInput$TapeDriveType type ActivateGatewayInput struct { // Your gateway activation key. You can obtain the activation key by sending an // HTTP GET request with redirects enabled to the gateway IP address (port 80). The // redirect URL returned in the response provides you the activation key for your - // gateway in the query string parameter activationKey. It may also include other + // gateway in the query string parameter activationKey . It may also include other // activation-related parameters, however, these are merely defaults -- the // arguments you pass to the ActivateGateway API call determine the actual - // configuration of your gateway. For more information, see Getting activation key - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html) + // configuration of your gateway. For more information, see Getting activation key (https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html) // in the Storage Gateway User Guide. // // This member is required. @@ -74,11 +62,11 @@ type ActivateGatewayInput struct { // A value that indicates the Amazon Web Services Region where you want to store // your data. The gateway Amazon Web Services Region specified must be the same - // Amazon Web Services Region as the Amazon Web Services Region in your Host header - // in the request. For more information about available Amazon Web Services Regions - // and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web - // Services General Reference. Valid Values: See Storage Gateway endpoints and + // Amazon Web Services Region as the Amazon Web Services Region in your Host + // header in the request. For more information about available Amazon Web Services + // Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and + // quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web + // Services General Reference. Valid Values: See Storage Gateway endpoints and // quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web // Services General Reference. // @@ -96,7 +84,7 @@ type ActivateGatewayInput struct { // A value that defines the type of gateway to activate. The type specified is // critical to all later functions of the gateway and cannot be changed after - // activation. The default value is CACHED. Valid Values: STORED | CACHED | VTL | + // activation. The default value is CACHED . Valid Values: STORED | CACHED | VTL | // VTL_SNOW | FILE_S3 | FILE_FSX_SMB GatewayType *string @@ -119,17 +107,17 @@ type ActivateGatewayInput struct { noSmithyDocumentSerde } -// Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. -// It is a string made of information such as your account, gateway name, and -// Amazon Web Services Region. This ARN is used to reference the gateway in other -// API operations as well as resource-based authorization. For gateways activated -// prior to September 02, 2015, the gateway ARN contains the gateway name rather -// than the gateway ID. Changing the name of the gateway has no effect on the -// gateway ARN. +// Storage Gateway returns the Amazon Resource Name (ARN) of the activated +// gateway. It is a string made of information such as your account, gateway name, +// and Amazon Web Services Region. This ARN is used to reference the gateway in +// other API operations as well as resource-based authorization. For gateways +// activated prior to September 02, 2015, the gateway ARN contains the gateway name +// rather than the gateway ID. Changing the name of the gateway has no effect on +// the gateway ARN. type ActivateGatewayOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_AddCache.go b/service/storagegateway/api_op_AddCache.go index ba627a99d37..98475e08b0a 100644 --- a/service/storagegateway/api_op_AddCache.go +++ b/service/storagegateway/api_op_AddCache.go @@ -12,10 +12,10 @@ import ( // Configures one or more gateway local disks as cache for a gateway. This // operation is only supported in the cached volume, tape, and file gateway type -// (see How Storage Gateway works (architecture) -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html). -// In the request, you specify the gateway Amazon Resource Name (ARN) to which you -// want to add cache, and one or more disk IDs that you want to configure as cache. +// (see How Storage Gateway works (architecture) (https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html) +// . In the request, you specify the gateway Amazon Resource Name (ARN) to which +// you want to add cache, and one or more disk IDs that you want to configure as +// cache. func (c *Client) AddCache(ctx context.Context, params *AddCacheInput, optFns ...func(*Options)) (*AddCacheOutput, error) { if params == nil { params = &AddCacheInput{} @@ -40,8 +40,8 @@ type AddCacheInput struct { // This member is required. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -51,8 +51,8 @@ type AddCacheInput struct { type AddCacheOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_AddTagsToResource.go b/service/storagegateway/api_op_AddTagsToResource.go index 3dc3718698b..c7471c406ea 100644 --- a/service/storagegateway/api_op_AddTagsToResource.go +++ b/service/storagegateway/api_op_AddTagsToResource.go @@ -11,27 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to the specified resource. You use tags to add metadata to -// resources, which you can use to categorize these resources. For example, you can -// categorize resources by purpose, owner, environment, or team. Each tag consists -// of a key and a value, which you define. You can add tags to the following -// Storage Gateway resources: +// Adds one or more tags to the specified resource. You use tags to add metadata +// to resources, which you can use to categorize these resources. For example, you +// can categorize resources by purpose, owner, environment, or team. Each tag +// consists of a key and a value, which you define. You can add tags to the +// following Storage Gateway resources: +// - Storage gateways of all types +// - Storage volumes +// - Virtual tapes +// - NFS and SMB file shares +// - File System associations // -// * Storage gateways of all types -// -// * Storage -// volumes -// -// * Virtual tapes -// -// * NFS and SMB file shares -// -// * File System -// associations -// -// You can create a maximum of 50 tags for each resource. Virtual -// tapes and storage volumes that are recovered to a new gateway maintain their -// tags. +// You can create a maximum of 50 tags for each resource. Virtual tapes and +// storage volumes that are recovered to a new gateway maintain their tags. func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} diff --git a/service/storagegateway/api_op_AddUploadBuffer.go b/service/storagegateway/api_op_AddUploadBuffer.go index 31c8994478a..8121a208b98 100644 --- a/service/storagegateway/api_op_AddUploadBuffer.go +++ b/service/storagegateway/api_op_AddUploadBuffer.go @@ -39,8 +39,8 @@ type AddUploadBufferInput struct { // This member is required. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -50,8 +50,8 @@ type AddUploadBufferInput struct { type AddUploadBufferOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_AddWorkingStorage.go b/service/storagegateway/api_op_AddWorkingStorage.go index 6bf57c45355..c89c2777310 100644 --- a/service/storagegateway/api_op_AddWorkingStorage.go +++ b/service/storagegateway/api_op_AddWorkingStorage.go @@ -34,9 +34,7 @@ func (c *Client) AddWorkingStorage(ctx context.Context, params *AddWorkingStorag } // A JSON object containing one or more of the following fields: -// -// * -// AddWorkingStorageInput$DiskIds +// - AddWorkingStorageInput$DiskIds type AddWorkingStorageInput struct { // An array of strings that identify disks that are to be configured as working @@ -46,8 +44,8 @@ type AddWorkingStorageInput struct { // This member is required. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -55,12 +53,12 @@ type AddWorkingStorageInput struct { noSmithyDocumentSerde } -// A JSON object containing the Amazon Resource Name (ARN) of the gateway for which -// working storage was configured. +// A JSON object containing the Amazon Resource Name (ARN) of the gateway for +// which working storage was configured. type AddWorkingStorageOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_AssignTapePool.go b/service/storagegateway/api_op_AssignTapePool.go index f3ab02dfd43..7a4c7160cab 100644 --- a/service/storagegateway/api_op_AssignTapePool.go +++ b/service/storagegateway/api_op_AssignTapePool.go @@ -47,10 +47,10 @@ type AssignTapePoolInput struct { // This member is required. TapeARN *string - // Set permissions to bypass governance retention. If the lock type of the archived - // tape is Governance, the tape's archived age is not older than - // RetentionLockInDays, and the user does not already have - // BypassGovernanceRetention, setting this to TRUE enables the user to bypass the + // Set permissions to bypass governance retention. If the lock type of the + // archived tape is Governance , the tape's archived age is not older than + // RetentionLockInDays , and the user does not already have + // BypassGovernanceRetention , setting this to TRUE enables the user to bypass the // retention lock. This parameter is set to true by default for calls from the // console. Valid values: TRUE | FALSE BypassGovernanceRetention bool @@ -60,8 +60,8 @@ type AssignTapePoolInput struct { type AssignTapePoolOutput struct { - // The unique Amazon Resource Names (ARN) of the virtual tape that was added to the - // tape pool. + // The unique Amazon Resource Names (ARN) of the virtual tape that was added to + // the tape pool. TapeARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_AssociateFileSystem.go b/service/storagegateway/api_op_AssociateFileSystem.go index cb57edf0ff1..e39d60b1c46 100644 --- a/service/storagegateway/api_op_AssociateFileSystem.go +++ b/service/storagegateway/api_op_AssociateFileSystem.go @@ -38,8 +38,8 @@ type AssociateFileSystemInput struct { // This member is required. ClientToken *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_AttachVolume.go b/service/storagegateway/api_op_AttachVolume.go index 44130ff8d5d..80f3d5c9f82 100644 --- a/service/storagegateway/api_op_AttachVolume.go +++ b/service/storagegateway/api_op_AttachVolume.go @@ -33,15 +33,15 @@ func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, op // AttachVolumeInput type AttachVolumeInput struct { - // The Amazon Resource Name (ARN) of the gateway that you want to attach the volume - // to. + // The Amazon Resource Name (ARN) of the gateway that you want to attach the + // volume to. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only - // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the - // network interfaces available on a gateway. Valid Values: A valid IP address. + // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of + // the network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string @@ -51,16 +51,16 @@ type AttachVolumeInput struct { // This member is required. VolumeARN *string - // The unique device ID or other distinguishing data that identifies the local disk - // used to create the volume. This value is only required when you are attaching a - // stored volume. + // The unique device ID or other distinguishing data that identifies the local + // disk used to create the volume. This value is only required when you are + // attaching a stored volume. DiskId *string // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway. If you don't + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume + // . The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. TargetName *string diff --git a/service/storagegateway/api_op_CancelArchival.go b/service/storagegateway/api_op_CancelArchival.go index e8679897f61..7d75b0fb29f 100644 --- a/service/storagegateway/api_op_CancelArchival.go +++ b/service/storagegateway/api_op_CancelArchival.go @@ -31,8 +31,8 @@ func (c *Client) CancelArchival(ctx context.Context, params *CancelArchivalInput // CancelArchivalInput type CancelArchivalInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_CancelRetrieval.go b/service/storagegateway/api_op_CancelRetrieval.go index c4401348478..f15937142dd 100644 --- a/service/storagegateway/api_op_CancelRetrieval.go +++ b/service/storagegateway/api_op_CancelRetrieval.go @@ -31,8 +31,8 @@ func (c *Client) CancelRetrieval(ctx context.Context, params *CancelRetrievalInp // CancelRetrievalInput type CancelRetrievalInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_CreateCachediSCSIVolume.go b/service/storagegateway/api_op_CreateCachediSCSIVolume.go index eca634f3e9d..348d79dec61 100644 --- a/service/storagegateway/api_op_CreateCachediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateCachediSCSIVolume.go @@ -41,21 +41,21 @@ func (c *Client) CreateCachediSCSIVolume(ctx context.Context, params *CreateCach type CreateCachediSCSIVolumeInput struct { - // A unique identifier that you use to retry a request. If you retry a request, use - // the same ClientToken you specified in the initial request. + // A unique identifier that you use to retry a request. If you retry a request, + // use the same ClientToken you specified in the initial request. // // This member is required. ClientToken *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only - // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the - // network interfaces available on a gateway. Valid Values: A valid IP address. + // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of + // the network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string @@ -63,8 +63,8 @@ type CreateCachediSCSIVolumeInput struct { // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway. If you don't + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume + // . The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. // @@ -80,21 +80,20 @@ type CreateCachediSCSIVolumeInput struct { // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new // cached volume. Specify this field if you want to create the iSCSI storage volume // from a snapshot; otherwise, do not include this field. To list snapshots for - // your account use DescribeSnapshots - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) + // your account use DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string - // The ARN for an existing volume. Specifying this ARN makes the new volume into an - // exact copy of the specified existing volume's latest recovery point. The + // The ARN for an existing volume. Specifying this ARN makes the new volume into + // an exact copy of the specified existing volume's latest recovery point. The // VolumeSizeInBytes value for this new volume must be equal to or larger than the // size of the existing volume, in bytes. SourceVolumeARN *string diff --git a/service/storagegateway/api_op_CreateNFSFileShare.go b/service/storagegateway/api_op_CreateNFSFileShare.go index aed6a804166..a41276693ae 100644 --- a/service/storagegateway/api_op_CreateNFSFileShare.go +++ b/service/storagegateway/api_op_CreateNFSFileShare.go @@ -21,8 +21,7 @@ import ( // Web Services STS is not activated in the Amazon Web Services Region, activate // it. For information about how to activate Amazon Web Services STS, see // Activating and deactivating Amazon Web Services STS in an Amazon Web Services -// Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Identity and Access Management User Guide. S3 File Gateways do not // support creating hard or symbolic links on a file share. func (c *Client) CreateNFSFileShare(ctx context.Context, params *CreateNFSFileShareInput, optFns ...func(*Options)) (*CreateNFSFileShareOutput, error) { @@ -63,16 +62,15 @@ type CreateNFSFileShareInput struct { // arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you // specify an access point, the bucket policy must be configured to delegate access // control to the access point. For information, see Delegating access control to - // access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) + // access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) // in the Amazon S3 User Guide. Access point alias: // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias // // This member is required. LocationARN *string - // The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway - // assumes when it accesses the underlying storage. + // The ARN of the Identity and Access Management (IAM) role that an S3 File + // Gateway assumes when it accesses the underlying storage. // // This member is required. Role *string @@ -94,26 +92,26 @@ type CreateNFSFileShareInput struct { ClientList []string // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // File share default values. Optional. @@ -131,33 +129,29 @@ type CreateNFSFileShareInput struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that a S3 File Gateway puts objects into. The default value is private + // . ObjectACL types.ObjectACL // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false. Valid Values: true | - // false + // set the write status to read-only, otherwise set to false . Valid Values: true + // | false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // A value that maps a user to anonymous user. Valid values are the following: - // - // * - // RootSquash: Only root is mapped to anonymous user. - // - // * NoSquash: No one is mapped - // to anonymous user. - // - // * AllSquash: Everyone is mapped to anonymous user. + // - RootSquash : Only root is mapped to anonymous user. + // - NoSquash : No one is mapped to anonymous user. + // - AllSquash : Everyone is mapped to anonymous user. Squash *string // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is diff --git a/service/storagegateway/api_op_CreateSMBFileShare.go b/service/storagegateway/api_op_CreateSMBFileShare.go index 2b5a5993beb..5c8d8d883ee 100644 --- a/service/storagegateway/api_op_CreateSMBFileShare.go +++ b/service/storagegateway/api_op_CreateSMBFileShare.go @@ -21,8 +21,7 @@ import ( // Amazon Web Services STS is not activated in this Amazon Web Services Region, // activate it. For information about how to activate Amazon Web Services STS, see // Activating and deactivating Amazon Web Services STS in an Amazon Web Services -// Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Identity and Access Management User Guide. File gateways don't support // creating hard or symbolic links on a file share. func (c *Client) CreateSMBFileShare(ctx context.Context, params *CreateSMBFileShareInput, optFns ...func(*Options)) (*CreateSMBFileShareOutput, error) { @@ -62,16 +61,15 @@ type CreateSMBFileShareInput struct { // arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you // specify an access point, the bucket policy must be configured to delegate access // control to the access point. For information, see Delegating access control to - // access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) + // access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) // in the Amazon S3 User Guide. Access point alias: // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias // // This member is required. LocationARN *string - // The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway - // assumes when it accesses the underlying storage. + // The ARN of the Identity and Access Management (IAM) role that an S3 File + // Gateway assumes when it accesses the underlying storage. // // This member is required. Role *string @@ -82,9 +80,9 @@ type CreateSMBFileShareInput struct { // A list of users or groups in the Active Directory that will be granted // administrator privileges on the file share. These users can do all file - // operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, - // @group1, and @DOMAIN\group1. Use this option very carefully, because any user in - // this list can do anything they like on the file share, regardless of file + // operations as the super-user. Acceptable formats include: DOMAIN\User1 , user1 , + // @group1 , and @DOMAIN\group1 . Use this option very carefully, because any user + // in this list can do anything they like on the file share, regardless of file // permissions. AdminUserList []string @@ -92,7 +90,7 @@ type CreateSMBFileShareInput struct { AuditDestinationARN *string // The authentication method that users use to access the file share. The default - // is ActiveDirectory. Valid Values: ActiveDirectory | GuestAccess + // is ActiveDirectory . Valid Values: ActiveDirectory | GuestAccess Authentication *string // Specifies the Region of the S3 bucket where the SMB file share stores files. @@ -104,38 +102,38 @@ type CreateSMBFileShareInput struct { // Specifies refresh cache information for the file share. CacheAttributes *types.CacheAttributes - // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the - // client determines the case sensitivity. For CaseSensitive, the gateway - // determines the case sensitivity. The default value is ClientSpecified. + // The case of an object name in an Amazon S3 bucket. For ClientSpecified , the + // client determines the case sensitivity. For CaseSensitive , the gateway + // determines the case sensitivity. The default value is ClientSpecified . CaseSensitivity types.CaseSensitivity // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool - // A list of users or groups in the Active Directory that are not allowed to access - // the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are not allowed to + // access the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . InvalidUserList []string // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The notification policy of the file share. SettlingTimeInSeconds controls the @@ -150,8 +148,9 @@ type CreateSMBFileShareInput struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that a S3 File Gateway puts objects into. The default value is private + // . ObjectACL types.ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. @@ -161,25 +160,24 @@ type CreateSMBFileShareInput struct { OplocksEnabled *bool // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false. Valid Values: true | - // false + // set the write status to read-only, otherwise set to false . Valid Values: true + // | false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // Set this value to true to enable access control list (ACL) on the SMB file // share. Set it to false to map file and directory permissions to the POSIX // permissions. For more information, see Using Microsoft Windows ACLs to control - // access to an SMB file share - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in - // the Storage Gateway User Guide. Valid Values: true | false + // access to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the Storage Gateway User Guide. Valid Values: true | false SMBACLEnabled *bool // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is @@ -195,10 +193,10 @@ type CreateSMBFileShareInput struct { // point alias that points to a VPC access point. VPCEndpointDNSName *string - // A list of users or groups in the Active Directory that are allowed to access the - // file share. A group must be prefixed with the @ character. Acceptable formats - // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if - // Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are allowed to access + // the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . ValidUserList []string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_CreateSnapshot.go b/service/storagegateway/api_op_CreateSnapshot.go index 4462770a162..fac18951773 100644 --- a/service/storagegateway/api_op_CreateSnapshot.go +++ b/service/storagegateway/api_op_CreateSnapshot.go @@ -16,24 +16,20 @@ import ( // durable off-site recovery, and also import the data to an Amazon Elastic Block // Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots // of your gateway volume on a scheduled or ad hoc basis. This API enables you to -// take an ad hoc snapshot. For more information, see Editing a snapshot schedule -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot). -// In the CreateSnapshot request, you identify the volume by providing its Amazon -// Resource Name (ARN). You must also provide description for the snapshot. When -// Storage Gateway takes the snapshot of specified volume, the snapshot and +// take an ad hoc snapshot. For more information, see Editing a snapshot schedule (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot) +// . In the CreateSnapshot request, you identify the volume by providing its +// Amazon Resource Name (ARN). You must also provide description for the snapshot. +// When Storage Gateway takes the snapshot of specified volume, the snapshot and // description appears in the Storage Gateway console. In response, Storage Gateway // returns you a snapshot ID. You can use this snapshot ID to check the snapshot // progress or later use it when you want to create a volume from a snapshot. This // operation is only supported in stored and cached volume gateway type. To list or // delete a snapshot, you must use the Amazon EC2 API. For more information, see -// DescribeSnapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) -// or DeleteSnapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) +// DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) +// or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) // in the Amazon Elastic Compute Cloud API Reference. Volume and snapshot IDs are // changing to a longer length ID format. For more information, see the important -// note on the Welcome -// (https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) +// note on the Welcome (https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) // page. func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { @@ -51,11 +47,8 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput } // A JSON object containing one or more of the following fields: -// -// * -// CreateSnapshotInput$SnapshotDescription -// -// * CreateSnapshotInput$VolumeARN +// - CreateSnapshotInput$SnapshotDescription +// - CreateSnapshotInput$VolumeARN type CreateSnapshotInput struct { // Textual description of the snapshot that appears in the Amazon EC2 console, @@ -85,8 +78,8 @@ type CreateSnapshotInput struct { type CreateSnapshotOutput struct { // The snapshot ID that is used to refer to the snapshot in future operations such - // as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or - // creating a volume from a snapshot (CreateStorediSCSIVolume). + // as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or + // creating a volume from a snapshot ( CreateStorediSCSIVolume ). SnapshotId *string // The Amazon Resource Name (ARN) of the volume of which the snapshot was taken. diff --git a/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go b/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go index 523cb823f8b..4a558768008 100644 --- a/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go +++ b/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go @@ -15,7 +15,7 @@ import ( // is only supported in the cached volume gateway type. A volume recovery point is // a point in time at which all data of the volume is consistent and from which you // can create a snapshot. To get a list of volume recovery point for cached volume -// gateway, use ListVolumeRecoveryPoints. In the +// gateway, use ListVolumeRecoveryPoints . In the // CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by // providing its Amazon Resource Name (ARN). You must also provide a description // for the snapshot. When the gateway takes a snapshot of the specified volume, the @@ -23,10 +23,8 @@ import ( // the gateway returns you a snapshot ID. You can use this snapshot ID to check the // snapshot progress or later use it when you want to create a volume from a // snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For -// more information, see DescribeSnapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) -// or DeleteSnapshot -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) +// more information, see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) +// or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) // in the Amazon Elastic Compute Cloud API Reference. func (c *Client) CreateSnapshotFromVolumeRecoveryPoint(ctx context.Context, params *CreateSnapshotFromVolumeRecoveryPointInput, optFns ...func(*Options)) (*CreateSnapshotFromVolumeRecoveryPointOutput, error) { if params == nil { diff --git a/service/storagegateway/api_op_CreateStorediSCSIVolume.go b/service/storagegateway/api_op_CreateStorediSCSIVolume.go index 3f15ad79a8a..fef61ed0c37 100644 --- a/service/storagegateway/api_op_CreateStorediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateStorediSCSIVolume.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a volume on a specified gateway. This operation is only supported in the -// stored volume gateway type. The size of the volume to create is inferred from -// the disk size. You can choose to preserve existing data on the disk, create +// Creates a volume on a specified gateway. This operation is only supported in +// the stored volume gateway type. The size of the volume to create is inferred +// from the disk size. You can choose to preserve existing data on the disk, create // volume from an existing snapshot, or create an empty volume. If you choose to // create an empty gateway volume, then any existing data on the disk is erased. In // the request, you must specify the gateway and the disk information on which you @@ -36,40 +36,29 @@ func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStor } // A JSON object containing one or more of the following fields: -// -// * -// CreateStorediSCSIVolumeInput$DiskId -// -// * -// CreateStorediSCSIVolumeInput$NetworkInterfaceId -// -// * -// CreateStorediSCSIVolumeInput$PreserveExistingData -// -// * -// CreateStorediSCSIVolumeInput$SnapshotId -// -// * -// CreateStorediSCSIVolumeInput$TargetName +// - CreateStorediSCSIVolumeInput$DiskId +// - CreateStorediSCSIVolumeInput$NetworkInterfaceId +// - CreateStorediSCSIVolumeInput$PreserveExistingData +// - CreateStorediSCSIVolumeInput$SnapshotId +// - CreateStorediSCSIVolumeInput$TargetName type CreateStorediSCSIVolumeInput struct { // The unique identifier for the gateway local disk that is configured as a stored - // volume. Use ListLocalDisks - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html) + // volume. Use ListLocalDisks (https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html) // to list disk IDs for a gateway. // // This member is required. DiskId *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string // The network interface of the gateway on which to expose the iSCSI target. Only - // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the - // network interfaces available on a gateway. Valid Values: A valid IP address. + // IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of + // the network interfaces available on a gateway. Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string @@ -83,8 +72,8 @@ type CreateStorediSCSIVolumeInput struct { // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway. If you don't + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume + // . The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. // @@ -95,16 +84,15 @@ type CreateStorediSCSIVolumeInput struct { // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new // stored volume. Specify this field if you want to create the iSCSI storage volume // from a snapshot; otherwise, do not include this field. To list snapshots for - // your account use DescribeSnapshots - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) + // your account use DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string diff --git a/service/storagegateway/api_op_CreateTapePool.go b/service/storagegateway/api_op_CreateTapePool.go index 200a9396d94..bd07a4a6696 100644 --- a/service/storagegateway/api_op_CreateTapePool.go +++ b/service/storagegateway/api_op_CreateTapePool.go @@ -35,10 +35,10 @@ type CreateTapePoolInput struct { // This member is required. PoolName *string - // The storage class that is associated with the new custom pool. When you use your - // backup application to eject the tape, the tape is archived directly into the - // storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the - // pool. + // The storage class that is associated with the new custom pool. When you use + // your backup application to eject the tape, the tape is archived directly into + // the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to + // the pool. // // This member is required. StorageClass types.TapeStorageClass diff --git a/service/storagegateway/api_op_CreateTapeWithBarcode.go b/service/storagegateway/api_op_CreateTapeWithBarcode.go index cf3022cb38f..e902466732f 100644 --- a/service/storagegateway/api_op_CreateTapeWithBarcode.go +++ b/service/storagegateway/api_op_CreateTapeWithBarcode.go @@ -42,8 +42,8 @@ type CreateTapeWithBarcodeInput struct { // This member is required. GatewayARN *string - // The barcode that you want to assign to the tape. Barcodes cannot be reused. This - // includes barcodes used for tapes that have been deleted. + // The barcode that you want to assign to the tape. Barcodes cannot be reused. + // This includes barcodes used for tapes that have been deleted. // // This member is required. TapeBarcode *string @@ -58,9 +58,9 @@ type CreateTapeWithBarcodeInput struct { // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The ID of the pool that you want to add your tape to for archiving. The tape in diff --git a/service/storagegateway/api_op_CreateTapes.go b/service/storagegateway/api_op_CreateTapes.go index 0a2724717fb..7870bbe92ee 100644 --- a/service/storagegateway/api_op_CreateTapes.go +++ b/service/storagegateway/api_op_CreateTapes.go @@ -33,8 +33,8 @@ func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optF // CreateTapesInput type CreateTapesInput struct { - // A unique identifier that you use to retry a request. If you retry a request, use - // the same ClientToken you specified in the initial request. Using the same + // A unique identifier that you use to retry a request. If you retry a request, + // use the same ClientToken you specified in the initial request. Using the same // ClientToken prevents creating the tape multiple times. // // This member is required. @@ -69,9 +69,9 @@ type CreateTapesInput struct { // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The ID of the pool that you want to add your tape to for archiving. The tape in diff --git a/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go b/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go index 300a6427843..99598fb4aaa 100644 --- a/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go +++ b/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go @@ -30,8 +30,8 @@ func (c *Client) DeleteAutomaticTapeCreationPolicy(ctx context.Context, params * type DeleteAutomaticTapeCreationPolicyInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -41,8 +41,8 @@ type DeleteAutomaticTapeCreationPolicyInput struct { type DeleteAutomaticTapeCreationPolicyOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DeleteBandwidthRateLimit.go b/service/storagegateway/api_op_DeleteBandwidthRateLimit.go index e4228b93fd7..4fb0225cb30 100644 --- a/service/storagegateway/api_op_DeleteBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DeleteBandwidthRateLimit.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the bandwidth rate limits of a gateway. You can delete either the upload -// and download bandwidth rate limit, or you can delete both. If you delete only -// one of the limits, the other limit remains unchanged. To specify which gateway -// to work with, use the Amazon Resource Name (ARN) of the gateway in your request. -// This operation is supported only for the stored volume, cached volume, and tape -// gateway types. +// Deletes the bandwidth rate limits of a gateway. You can delete either the +// upload and download bandwidth rate limit, or you can delete both. If you delete +// only one of the limits, the other limit remains unchanged. To specify which +// gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your +// request. This operation is supported only for the stored volume, cached volume, +// and tape gateway types. func (c *Client) DeleteBandwidthRateLimit(ctx context.Context, params *DeleteBandwidthRateLimitInput, optFns ...func(*Options)) (*DeleteBandwidthRateLimitOutput, error) { if params == nil { params = &DeleteBandwidthRateLimitInput{} @@ -32,9 +32,7 @@ func (c *Client) DeleteBandwidthRateLimit(ctx context.Context, params *DeleteBan } // A JSON object containing the following fields: -// -// * -// DeleteBandwidthRateLimitInput$BandwidthType +// - DeleteBandwidthRateLimitInput$BandwidthType type DeleteBandwidthRateLimitInput struct { // One of the BandwidthType values that indicates the gateway bandwidth rate limit @@ -43,8 +41,8 @@ type DeleteBandwidthRateLimitInput struct { // This member is required. BandwidthType *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -56,8 +54,8 @@ type DeleteBandwidthRateLimitInput struct { // bandwidth rate information was deleted. type DeleteBandwidthRateLimitOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DeleteChapCredentials.go b/service/storagegateway/api_op_DeleteChapCredentials.go index 9fe6dc86ba2..517267adda2 100644 --- a/service/storagegateway/api_op_DeleteChapCredentials.go +++ b/service/storagegateway/api_op_DeleteChapCredentials.go @@ -29,11 +29,8 @@ func (c *Client) DeleteChapCredentials(ctx context.Context, params *DeleteChapCr } // A JSON object containing one or more of the following fields: -// -// * -// DeleteChapCredentialsInput$InitiatorName -// -// * DeleteChapCredentialsInput$TargetARN +// - DeleteChapCredentialsInput$InitiatorName +// - DeleteChapCredentialsInput$TargetARN type DeleteChapCredentialsInput struct { // The iSCSI initiator that connects to the target. diff --git a/service/storagegateway/api_op_DeleteFileShare.go b/service/storagegateway/api_op_DeleteFileShare.go index 21b2569200b..bc49eff5615 100644 --- a/service/storagegateway/api_op_DeleteFileShare.go +++ b/service/storagegateway/api_op_DeleteFileShare.go @@ -35,11 +35,11 @@ type DeleteFileShareInput struct { // This member is required. FileShareARN *string - // If this value is set to true, the operation deletes a file share immediately and - // aborts all data uploads to Amazon Web Services. Otherwise, the file share is not - // deleted until all data is uploaded to Amazon Web Services. This process aborts - // the data upload process, and the file share enters the FORCE_DELETING status. - // Valid Values: true | false + // If this value is set to true , the operation deletes a file share immediately + // and aborts all data uploads to Amazon Web Services. Otherwise, the file share is + // not deleted until all data is uploaded to Amazon Web Services. This process + // aborts the data upload process, and the file share enters the FORCE_DELETING + // status. Valid Values: true | false ForceDelete bool noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_DeleteGateway.go b/service/storagegateway/api_op_DeleteGateway.go index 7e854967a90..3a1d64b4047 100644 --- a/service/storagegateway/api_op_DeleteGateway.go +++ b/service/storagegateway/api_op_DeleteGateway.go @@ -22,7 +22,7 @@ import ( // can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon // EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you // can delete your snapshots using the Amazon EC2 console. For more information, -// see the Storage Gateway detail page (http://aws.amazon.com/storagegateway). +// see the Storage Gateway detail page (http://aws.amazon.com/storagegateway) . func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error) { if params == nil { params = &DeleteGatewayInput{} @@ -41,8 +41,8 @@ func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, // A JSON object containing the ID of the gateway to delete. type DeleteGatewayInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -53,8 +53,8 @@ type DeleteGatewayInput struct { // A JSON object containing the ID of the deleted gateway. type DeleteGatewayOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DeleteSnapshotSchedule.go b/service/storagegateway/api_op_DeleteSnapshotSchedule.go index ee5f72d7dba..2eb373be743 100644 --- a/service/storagegateway/api_op_DeleteSnapshotSchedule.go +++ b/service/storagegateway/api_op_DeleteSnapshotSchedule.go @@ -12,13 +12,11 @@ import ( // Deletes a snapshot of a volume. You can take snapshots of your gateway volumes // on a scheduled or ad hoc basis. This API action enables you to delete a snapshot -// schedule for a volume. For more information, see Backing up your volumes -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html). -// In the DeleteSnapshotSchedule request, you identify the volume by providing its -// Amazon Resource Name (ARN). This operation is only supported for cached volume -// gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. -// For more information, go to DescribeSnapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) +// schedule for a volume. For more information, see Backing up your volumes (https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html) +// . In the DeleteSnapshotSchedule request, you identify the volume by providing +// its Amazon Resource Name (ARN). This operation is only supported for cached +// volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 +// API. For more information, go to DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. func (c *Client) DeleteSnapshotSchedule(ctx context.Context, params *DeleteSnapshotScheduleInput, optFns ...func(*Options)) (*DeleteSnapshotScheduleOutput, error) { if params == nil { diff --git a/service/storagegateway/api_op_DeleteTape.go b/service/storagegateway/api_op_DeleteTape.go index 62eee90eab1..6e0343f9a30 100644 --- a/service/storagegateway/api_op_DeleteTape.go +++ b/service/storagegateway/api_op_DeleteTape.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified virtual tape. This operation is only supported in the tape -// gateway type. +// Deletes the specified virtual tape. This operation is only supported in the +// tape gateway type. func (c *Client) DeleteTape(ctx context.Context, params *DeleteTapeInput, optFns ...func(*Options)) (*DeleteTapeOutput, error) { if params == nil { params = &DeleteTapeInput{} diff --git a/service/storagegateway/api_op_DeleteVolume.go b/service/storagegateway/api_op_DeleteVolume.go index 40d4918215c..4819bca8e38 100644 --- a/service/storagegateway/api_op_DeleteVolume.go +++ b/service/storagegateway/api_op_DeleteVolume.go @@ -19,8 +19,7 @@ import ( // are deleting. You should also make sure there is no snapshot in progress. You // can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on // the volume you are deleting and check the snapshot status. For more information, -// go to DescribeSnapshots -// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) +// go to DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. In the request, you must // provide the Amazon Resource Name (ARN) of the storage volume you want to delete. func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error) { @@ -54,8 +53,8 @@ type DeleteVolumeInput struct { // that was deleted. type DeleteVolumeOutput struct { - // The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the - // same ARN you provided in the request. + // The Amazon Resource Name (ARN) of the storage volume that was deleted. It is + // the same ARN you provided in the request. VolumeARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go index 5307fb4a156..2806f047d0d 100644 --- a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go +++ b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go @@ -12,9 +12,9 @@ import ( "time" ) -// Returns information about the most recent high availability monitoring test that -// was performed on the host in a cluster. If a test isn't performed, the status -// and start time in the response would be null. +// Returns information about the most recent high availability monitoring test +// that was performed on the host in a cluster. If a test isn't performed, the +// status and start time in the response would be null. func (c *Client) DescribeAvailabilityMonitorTest(ctx context.Context, params *DescribeAvailabilityMonitorTestInput, optFns ...func(*Options)) (*DescribeAvailabilityMonitorTestOutput, error) { if params == nil { params = &DescribeAvailabilityMonitorTestInput{} @@ -32,8 +32,8 @@ func (c *Client) DescribeAvailabilityMonitorTest(ctx context.Context, params *De type DescribeAvailabilityMonitorTestInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -43,8 +43,8 @@ type DescribeAvailabilityMonitorTestInput struct { type DescribeAvailabilityMonitorTestOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The time the high availability monitoring test was started. If a test hasn't diff --git a/service/storagegateway/api_op_DescribeBandwidthRateLimit.go b/service/storagegateway/api_op_DescribeBandwidthRateLimit.go index dda40a95f9d..2e4437cf68f 100644 --- a/service/storagegateway/api_op_DescribeBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DescribeBandwidthRateLimit.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the bandwidth rate limits of a gateway. By default, these limits are not -// set, which means no bandwidth rate limiting is in effect. This operation is +// Returns the bandwidth rate limits of a gateway. By default, these limits are +// not set, which means no bandwidth rate limiting is in effect. This operation is // supported only for the stored volume, cached volume, and tape gateway types. To // describe bandwidth rate limits for S3 file gateways, use -// DescribeBandwidthRateLimitSchedule. This operation returns a value for a +// DescribeBandwidthRateLimitSchedule . This operation returns a value for a // bandwidth rate limit only if the limit is set. If no limits are set for the // gateway, then this operation returns only the gateway ARN in the response body. // To specify which gateway to describe, use the Amazon Resource Name (ARN) of the @@ -37,8 +37,8 @@ func (c *Client) DescribeBandwidthRateLimit(ctx context.Context, params *Describ // A JSON object containing the Amazon Resource Name (ARN) of the gateway. type DescribeBandwidthRateLimitInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -57,8 +57,8 @@ type DescribeBandwidthRateLimitOutput struct { // appear in the response if the upload rate limit is not set. AverageUploadRateLimitInBitsPerSec *int64 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go b/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go index 01f492bdcc6..499af2f7339 100644 --- a/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go +++ b/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go @@ -42,8 +42,8 @@ func (c *Client) DescribeBandwidthRateLimitSchedule(ctx context.Context, params type DescribeBandwidthRateLimitScheduleInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -57,8 +57,8 @@ type DescribeBandwidthRateLimitScheduleOutput struct { // gateway. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeCache.go b/service/storagegateway/api_op_DescribeCache.go index c879ab1572d..21c7544e781 100644 --- a/service/storagegateway/api_op_DescribeCache.go +++ b/service/storagegateway/api_op_DescribeCache.go @@ -31,8 +31,8 @@ func (c *Client) DescribeCache(ctx context.Context, params *DescribeCacheInput, type DescribeCacheInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -50,8 +50,8 @@ type DescribeCacheOutput struct { // end of the reporting period. CacheDirtyPercentage float64 - // Percent of application read operations from the file shares that are served from - // cache. The sample is taken at the end of the reporting period. + // Percent of application read operations from the file shares that are served + // from cache. The sample is taken at the end of the reporting period. CacheHitPercentage float64 // Percent of application read operations from the file shares that are not served @@ -68,8 +68,8 @@ type DescribeCacheOutput struct { // can get the disk IDs from the ListLocalDisks API. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeChapCredentials.go b/service/storagegateway/api_op_DescribeChapCredentials.go index 58c97b96626..ace8ebac735 100644 --- a/service/storagegateway/api_op_DescribeChapCredentials.go +++ b/service/storagegateway/api_op_DescribeChapCredentials.go @@ -47,24 +47,17 @@ type DescribeChapCredentialsInput struct { // A JSON object containing the following fields: type DescribeChapCredentialsOutput struct { - // An array of ChapInfo objects that represent CHAP credentials. Each object in the - // array contains CHAP credential information for one target-initiator pair. If no - // CHAP credentials are set, an empty array is returned. CHAP credential + // An array of ChapInfo objects that represent CHAP credentials. Each object in + // the array contains CHAP credential information for one target-initiator pair. If + // no CHAP credentials are set, an empty array is returned. CHAP credential // information is provided in a JSON object with the following fields: - // - // * - // InitiatorName: The iSCSI initiator that connects to the target. - // - // * - // SecretToAuthenticateInitiator: The secret key that the initiator (for example, - // the Windows client) must provide to participate in mutual CHAP with the - // target. - // - // * SecretToAuthenticateTarget: The secret key that the target must - // provide to participate in mutual CHAP with the initiator (e.g. Windows - // client). - // - // * TargetARN: The Amazon Resource Name (ARN) of the storage volume. + // - InitiatorName: The iSCSI initiator that connects to the target. + // - SecretToAuthenticateInitiator: The secret key that the initiator (for + // example, the Windows client) must provide to participate in mutual CHAP with the + // target. + // - SecretToAuthenticateTarget: The secret key that the target must provide to + // participate in mutual CHAP with the initiator (e.g. Windows client). + // - TargetARN: The Amazon Resource Name (ARN) of the storage volume. ChapCredentials []types.ChapInfo // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeGatewayInformation.go b/service/storagegateway/api_op_DescribeGatewayInformation.go index ee0a6c8c81f..c02d145006b 100644 --- a/service/storagegateway/api_op_DescribeGatewayInformation.go +++ b/service/storagegateway/api_op_DescribeGatewayInformation.go @@ -33,8 +33,8 @@ func (c *Client) DescribeGatewayInformation(ctx context.Context, params *Describ // A JSON object containing the ID of the gateway. type DescribeGatewayInformationInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -51,8 +51,8 @@ type DescribeGatewayInformationOutput struct { // gateway VM CloudWatchLogGroupARN *string - // Date after which this gateway will not receive software updates for new features - // and bug fixes. + // Date after which this gateway will not receive software updates for new + // features and bug fixes. DeprecationDate *string // The ID of the Amazon EC2 instance that was used to launch the gateway. @@ -64,8 +64,8 @@ type DescribeGatewayInformationOutput struct { // The type of endpoint for your gateway. Valid Values: STANDARD | FIPS EndpointType *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Specifies the size of the gateway's metadata cache. @@ -124,8 +124,8 @@ type DescribeGatewayInformationOutput struct { // assigned, you can view all tags using the ListTagsForResource API operation. Tags []types.Tag - // The configuration settings for the virtual private cloud (VPC) endpoint for your - // gateway. + // The configuration settings for the virtual private cloud (VPC) endpoint for + // your gateway. VPCEndpoint *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeMaintenanceStartTime.go b/service/storagegateway/api_op_DescribeMaintenanceStartTime.go index eebbb2129cd..1d5525815c2 100644 --- a/service/storagegateway/api_op_DescribeMaintenanceStartTime.go +++ b/service/storagegateway/api_op_DescribeMaintenanceStartTime.go @@ -30,8 +30,8 @@ func (c *Client) DescribeMaintenanceStartTime(ctx context.Context, params *Descr // A JSON object containing the Amazon Resource Name (ARN) of the gateway. type DescribeMaintenanceStartTimeInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -40,21 +40,11 @@ type DescribeMaintenanceStartTimeInput struct { } // A JSON object containing the following fields: -// -// * -// DescribeMaintenanceStartTimeOutput$DayOfMonth -// -// * -// DescribeMaintenanceStartTimeOutput$DayOfWeek -// -// * -// DescribeMaintenanceStartTimeOutput$HourOfDay -// -// * -// DescribeMaintenanceStartTimeOutput$MinuteOfHour -// -// * -// DescribeMaintenanceStartTimeOutput$Timezone +// - DescribeMaintenanceStartTimeOutput$DayOfMonth +// - DescribeMaintenanceStartTimeOutput$DayOfWeek +// - DescribeMaintenanceStartTimeOutput$HourOfDay +// - DescribeMaintenanceStartTimeOutput$MinuteOfHour +// - DescribeMaintenanceStartTimeOutput$Timezone type DescribeMaintenanceStartTimeOutput struct { // The day of the month component of the maintenance start time represented as an @@ -67,8 +57,8 @@ type DescribeMaintenanceStartTimeOutput struct { // of the gateway. DayOfWeek *int32 - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The hour component of the maintenance start time represented as hh, where hh is @@ -80,8 +70,8 @@ type DescribeMaintenanceStartTimeOutput struct { // gateway. MinuteOfHour *int32 - // A value that indicates the time zone that is set for the gateway. The start time - // and day of week specified should be in the time zone of the gateway. + // A value that indicates the time zone that is set for the gateway. The start + // time and day of week specified should be in the time zone of the gateway. Timezone *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeNFSFileShares.go b/service/storagegateway/api_op_DescribeNFSFileShares.go index 6a268634e15..eb51c1f07a6 100644 --- a/service/storagegateway/api_op_DescribeNFSFileShares.go +++ b/service/storagegateway/api_op_DescribeNFSFileShares.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a description for one or more Network File System (NFS) file shares from an -// S3 File Gateway. This operation is only supported for S3 File Gateways. +// Gets a description for one or more Network File System (NFS) file shares from +// an S3 File Gateway. This operation is only supported for S3 File Gateways. func (c *Client) DescribeNFSFileShares(ctx context.Context, params *DescribeNFSFileSharesInput, optFns ...func(*Options)) (*DescribeNFSFileSharesOutput, error) { if params == nil { params = &DescribeNFSFileSharesInput{} diff --git a/service/storagegateway/api_op_DescribeSMBFileShares.go b/service/storagegateway/api_op_DescribeSMBFileShares.go index 900b10d4b15..74a29413583 100644 --- a/service/storagegateway/api_op_DescribeSMBFileShares.go +++ b/service/storagegateway/api_op_DescribeSMBFileShares.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a description for one or more Server Message Block (SMB) file shares from a -// S3 File Gateway. This operation is only supported for S3 File Gateways. +// Gets a description for one or more Server Message Block (SMB) file shares from +// a S3 File Gateway. This operation is only supported for S3 File Gateways. func (c *Client) DescribeSMBFileShares(ctx context.Context, params *DescribeSMBFileSharesInput, optFns ...func(*Options)) (*DescribeSMBFileSharesOutput, error) { if params == nil { params = &DescribeSMBFileSharesInput{} diff --git a/service/storagegateway/api_op_DescribeSMBSettings.go b/service/storagegateway/api_op_DescribeSMBSettings.go index e6e28babf95..bdfc692464a 100644 --- a/service/storagegateway/api_op_DescribeSMBSettings.go +++ b/service/storagegateway/api_op_DescribeSMBSettings.go @@ -30,8 +30,8 @@ func (c *Client) DescribeSMBSettings(ctx context.Context, params *DescribeSMBSet type DescribeSMBSettingsInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -43,28 +43,17 @@ type DescribeSMBSettingsOutput struct { // Indicates the status of a gateway that is a member of the Active Directory // domain. - // - // * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to - // an authentication error. - // - // * DETACHED: Indicates that gateway is not joined to a - // domain. - // - // * JOINED: Indicates that the gateway has successfully joined a - // domain. - // - // * JOINING: Indicates that a JoinDomain operation is in progress. - // - // * - // NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or - // connectivity error. - // - // * TIMEOUT: Indicates that the JoinDomain operation failed - // because the operation didn't complete within the allotted time. - // - // * - // UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another - // type of error. + // - ACCESS_DENIED : Indicates that the JoinDomain operation failed due to an + // authentication error. + // - DETACHED : Indicates that gateway is not joined to a domain. + // - JOINED : Indicates that the gateway has successfully joined a domain. + // - JOINING : Indicates that a JoinDomain operation is in progress. + // - NETWORK_ERROR : Indicates that JoinDomain operation failed due to a network + // or connectivity error. + // - TIMEOUT : Indicates that the JoinDomain operation failed because the + // operation didn't complete within the allotted time. + // - UNKNOWN_ERROR : Indicates that the JoinDomain operation failed due to + // another type of error. ActiveDirectoryStatus types.ActiveDirectoryStatus // The name of the domain that the gateway is joined to. @@ -74,12 +63,12 @@ type DescribeSMBSettingsOutput struct { // File Gateways. FileSharesVisible *bool - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // This value is true if a password for the guest user smbguest is set, otherwise - // false. Only supported for S3 File Gateways. Valid Values: true | false + // false . Only supported for S3 File Gateways. Valid Values: true | false SMBGuestPasswordSet *bool // A list of Active Directory users and groups that have special permissions for @@ -87,23 +76,18 @@ type DescribeSMBSettingsOutput struct { SMBLocalGroups *types.SMBLocalGroups // The type of security strategy that was specified for file gateway. + // - ClientSpecified : If you use this option, requests are established based on + // what is negotiated by the client. This option is recommended when you want to + // maximize compatibility across different clients in your environment. Only + // supported for S3 File Gateways. + // - MandatorySigning : If you use this option, file gateway only allows + // connections from SMBv2 or SMBv3 clients that have signing enabled. This option + // works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. // - // * - // ClientSpecified: If you use this option, requests are established based on what - // is negotiated by the client. This option is recommended when you want to - // maximize compatibility across different clients in your environment. Only - // supported for S3 File Gateways. - // - // * MandatorySigning: If you use this option, - // file gateway only allows connections from SMBv2 or SMBv3 clients that have - // signing enabled. This option works with SMB clients on Microsoft Windows Vista, - // Windows Server 2008 or newer. - // - // * MandatoryEncryption: If you use this option, - // file gateway only allows connections from SMBv3 clients that have encryption - // enabled. This option is highly recommended for environments that handle - // sensitive data. This option works with SMB clients on Microsoft Windows 8, - // Windows Server 2012 or newer. + // - MandatoryEncryption : If you use this option, file gateway only allows + // connections from SMBv3 clients that have encryption enabled. This option is + // highly recommended for environments that handle sensitive data. This option + // works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. SMBSecurityStrategy types.SMBSecurityStrategy // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeSnapshotSchedule.go b/service/storagegateway/api_op_DescribeSnapshotSchedule.go index 5d633c6e6ef..9ee1b3507bb 100644 --- a/service/storagegateway/api_op_DescribeSnapshotSchedule.go +++ b/service/storagegateway/api_op_DescribeSnapshotSchedule.go @@ -56,9 +56,10 @@ type DescribeSnapshotScheduleOutput struct { // gateway. StartAt *int32 - // A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically - // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags - // assigned, you can view all tags using the ListTagsForResource API operation. + // A list of up to 50 tags assigned to the snapshot schedule, sorted + // alphabetically by key name. Each tag is a key-value pair. For a gateway with + // more than 10 tags assigned, you can view all tags using the ListTagsForResource + // API operation. Tags []types.Tag // A value that indicates the time zone of the gateway. diff --git a/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go b/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go index ae684aad8f8..f2f39c06bae 100644 --- a/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go +++ b/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go @@ -30,7 +30,7 @@ func (c *Client) DescribeStorediSCSIVolumes(ctx context.Context, params *Describ return out, nil } -// A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs. +// A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs . type DescribeStorediSCSIVolumesInput struct { // An array of strings where each string represents the Amazon Resource Name (ARN) @@ -45,62 +45,36 @@ type DescribeStorediSCSIVolumesInput struct { type DescribeStorediSCSIVolumesOutput struct { - // Describes a single unit of output from DescribeStorediSCSIVolumes. The following - // fields are returned: - // - // * ChapEnabled: Indicates whether mutual CHAP is enabled - // for the iSCSI target. - // - // * LunNumber: The logical disk number. - // - // * - // NetworkInterfaceId: The network interface ID of the stored volume that initiator - // use to map the stored volume as an iSCSI target. - // - // * NetworkInterfacePort: The - // port used to communicate with iSCSI targets. - // - // * PreservedExistingData: Indicates - // when the stored volume was created, existing data on the underlying local disk - // was preserved. - // - // * SourceSnapshotId: If the stored volume was created from a - // snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. - // Otherwise, this field is not included. - // - // * StorediSCSIVolumes: An array of - // StorediSCSIVolume objects where each object contains metadata about one stored - // volume. - // - // * TargetARN: The Amazon Resource Name (ARN) of the volume target. - // - // * - // VolumeARN: The Amazon Resource Name (ARN) of the stored volume. - // - // * VolumeDiskId: - // The disk ID of the local disk that was specified in the CreateStorediSCSIVolume - // operation. - // - // * VolumeId: The unique identifier of the storage volume, e.g. - // vol-1122AABB. - // - // * VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that - // represents a collection of iSCSI attributes for one stored volume. - // - // * - // VolumeProgress: Represents the percentage complete if the volume is restoring or - // bootstrapping that represents the percent of data transferred. This field does - // not appear in the response if the stored volume is not restoring or - // bootstrapping. - // - // * VolumeSizeInBytes: The size of the volume in bytes. - // - // * - // VolumeStatus: One of the VolumeStatus values that indicates the state of the - // volume. - // - // * VolumeType: One of the enumeration values describing the type of the - // volume. Currently, only STORED volumes are supported. + // Describes a single unit of output from DescribeStorediSCSIVolumes . The + // following fields are returned: + // - ChapEnabled : Indicates whether mutual CHAP is enabled for the iSCSI target. + // - LunNumber : The logical disk number. + // - NetworkInterfaceId : The network interface ID of the stored volume that + // initiator use to map the stored volume as an iSCSI target. + // - NetworkInterfacePort : The port used to communicate with iSCSI targets. + // - PreservedExistingData : Indicates when the stored volume was created, + // existing data on the underlying local disk was preserved. + // - SourceSnapshotId : If the stored volume was created from a snapshot, this + // field contains the snapshot ID used, e.g. snap-1122aabb . Otherwise, this + // field is not included. + // - StorediSCSIVolumes : An array of StorediSCSIVolume objects where each object + // contains metadata about one stored volume. + // - TargetARN : The Amazon Resource Name (ARN) of the volume target. + // - VolumeARN : The Amazon Resource Name (ARN) of the stored volume. + // - VolumeDiskId : The disk ID of the local disk that was specified in the + // CreateStorediSCSIVolume operation. + // - VolumeId : The unique identifier of the storage volume, e.g. vol-1122AABB . + // - VolumeiSCSIAttributes : An VolumeiSCSIAttributes object that represents a + // collection of iSCSI attributes for one stored volume. + // - VolumeProgress : Represents the percentage complete if the volume is + // restoring or bootstrapping that represents the percent of data transferred. This + // field does not appear in the response if the stored volume is not restoring or + // bootstrapping. + // - VolumeSizeInBytes : The size of the volume in bytes. + // - VolumeStatus : One of the VolumeStatus values that indicates the state of + // the volume. + // - VolumeType : One of the enumeration values describing the type of the + // volume. Currently, only STORED volumes are supported. StorediSCSIVolumes []types.StorediSCSIVolume // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeTapeArchives.go b/service/storagegateway/api_op_DescribeTapeArchives.go index 5238d4550f1..da4e5bb2ee5 100644 --- a/service/storagegateway/api_op_DescribeTapeArchives.go +++ b/service/storagegateway/api_op_DescribeTapeArchives.go @@ -34,8 +34,8 @@ func (c *Client) DescribeTapeArchives(ctx context.Context, params *DescribeTapeA // DescribeTapeArchivesInput type DescribeTapeArchivesInput struct { - // Specifies that the number of virtual tapes described be limited to the specified - // number. + // Specifies that the number of virtual tapes described be limited to the + // specified number. Limit *int32 // An opaque string that indicates the position at which to begin describing @@ -143,8 +143,8 @@ var _ DescribeTapeArchivesAPIClient = (*Client)(nil) // DescribeTapeArchivesPaginatorOptions is the paginator options for // DescribeTapeArchives type DescribeTapeArchivesPaginatorOptions struct { - // Specifies that the number of virtual tapes described be limited to the specified - // number. + // Specifies that the number of virtual tapes described be limited to the + // specified number. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go index c9b032440ff..e63559ccb4a 100644 --- a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go +++ b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go @@ -35,8 +35,8 @@ func (c *Client) DescribeTapeRecoveryPoints(ctx context.Context, params *Describ // DescribeTapeRecoveryPointsInput type DescribeTapeRecoveryPointsInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -55,8 +55,8 @@ type DescribeTapeRecoveryPointsInput struct { // DescribeTapeRecoveryPointsOutput type DescribeTapeRecoveryPointsOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // An opaque string that indicates the position at which the virtual tape recovery diff --git a/service/storagegateway/api_op_DescribeTapes.go b/service/storagegateway/api_op_DescribeTapes.go index a36de24469c..63f307be9cd 100644 --- a/service/storagegateway/api_op_DescribeTapes.go +++ b/service/storagegateway/api_op_DescribeTapes.go @@ -13,9 +13,9 @@ import ( ) // Returns a description of the specified Amazon Resource Name (ARN) of virtual -// tapes. If a TapeARN is not specified, returns a description of all virtual tapes -// associated with the specified gateway. This operation is only supported in the -// tape gateway type. +// tapes. If a TapeARN is not specified, returns a description of all virtual +// tapes associated with the specified gateway. This operation is only supported in +// the tape gateway type. func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, optFns ...func(*Options)) (*DescribeTapesOutput, error) { if params == nil { params = &DescribeTapesInput{} @@ -34,17 +34,18 @@ func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, // DescribeTapesInput type DescribeTapesInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string - // Specifies that the number of virtual tapes described be limited to the specified - // number. Amazon Web Services may impose its own limit, if this field is not set. + // Specifies that the number of virtual tapes described be limited to the + // specified number. Amazon Web Services may impose its own limit, if this field is + // not set. Limit *int32 - // A marker value, obtained in a previous call to DescribeTapes. This marker + // A marker value, obtained in a previous call to DescribeTapes . This marker // indicates which page of results to retrieve. If not specified, the first page of // results is retrieved. Marker *string @@ -147,8 +148,9 @@ var _ DescribeTapesAPIClient = (*Client)(nil) // DescribeTapesPaginatorOptions is the paginator options for DescribeTapes type DescribeTapesPaginatorOptions struct { - // Specifies that the number of virtual tapes described be limited to the specified - // number. Amazon Web Services may impose its own limit, if this field is not set. + // Specifies that the number of virtual tapes described be limited to the + // specified number. Amazon Web Services may impose its own limit, if this field is + // not set. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/storagegateway/api_op_DescribeUploadBuffer.go b/service/storagegateway/api_op_DescribeUploadBuffer.go index a7fcf5dfa90..9a8d25cc84e 100644 --- a/service/storagegateway/api_op_DescribeUploadBuffer.go +++ b/service/storagegateway/api_op_DescribeUploadBuffer.go @@ -31,8 +31,8 @@ func (c *Client) DescribeUploadBuffer(ctx context.Context, params *DescribeUploa type DescribeUploadBufferInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -42,14 +42,14 @@ type DescribeUploadBufferInput struct { type DescribeUploadBufferOutput struct { - // An array of the gateway's local disk IDs that are configured as working storage. - // Each local disk ID is specified as a string (minimum length of 1 and maximum - // length of 300). If no local disks are configured as working storage, then the - // DiskIds array is empty. + // An array of the gateway's local disk IDs that are configured as working + // storage. Each local disk ID is specified as a string (minimum length of 1 and + // maximum length of 300). If no local disks are configured as working storage, + // then the DiskIds array is empty. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The total number of bytes allocated in the gateway's as upload buffer. diff --git a/service/storagegateway/api_op_DescribeVTLDevices.go b/service/storagegateway/api_op_DescribeVTLDevices.go index 5023331be99..2ce7ba13fa8 100644 --- a/service/storagegateway/api_op_DescribeVTLDevices.go +++ b/service/storagegateway/api_op_DescribeVTLDevices.go @@ -33,8 +33,8 @@ func (c *Client) DescribeVTLDevices(ctx context.Context, params *DescribeVTLDevi // DescribeVTLDevicesInput type DescribeVTLDevicesInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -47,10 +47,10 @@ type DescribeVTLDevicesInput struct { // VTL devices. Marker *string - // An array of strings, where each string represents the Amazon Resource Name (ARN) - // of a VTL device. All of the specified VTL devices must be from the same gateway. - // If no VTL devices are specified, the result will contain all devices on the - // specified gateway. + // An array of strings, where each string represents the Amazon Resource Name + // (ARN) of a VTL device. All of the specified VTL devices must be from the same + // gateway. If no VTL devices are specified, the result will contain all devices on + // the specified gateway. VTLDeviceARNs []string noSmithyDocumentSerde @@ -59,8 +59,8 @@ type DescribeVTLDevicesInput struct { // DescribeVTLDevicesOutput type DescribeVTLDevicesOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // An opaque string that indicates the position at which the VTL devices that were @@ -69,8 +69,8 @@ type DescribeVTLDevicesOutput struct { // describe, this field does not appear in the response. Marker *string - // An array of VTL device objects composed of the Amazon Resource Name (ARN) of the - // VTL devices. + // An array of VTL device objects composed of the Amazon Resource Name (ARN) of + // the VTL devices. VTLDevices []types.VTLDevice // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_DescribeWorkingStorage.go b/service/storagegateway/api_op_DescribeWorkingStorage.go index ad096903a18..66818b49034 100644 --- a/service/storagegateway/api_op_DescribeWorkingStorage.go +++ b/service/storagegateway/api_op_DescribeWorkingStorage.go @@ -35,8 +35,8 @@ func (c *Client) DescribeWorkingStorage(ctx context.Context, params *DescribeWor // A JSON object containing the Amazon Resource Name (ARN) of the gateway. type DescribeWorkingStorageInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -47,14 +47,14 @@ type DescribeWorkingStorageInput struct { // A JSON object containing the following fields: type DescribeWorkingStorageOutput struct { - // An array of the gateway's local disk IDs that are configured as working storage. - // Each local disk ID is specified as a string (minimum length of 1 and maximum - // length of 300). If no local disks are configured as working storage, then the - // DiskIds array is empty. + // An array of the gateway's local disk IDs that are configured as working + // storage. Each local disk ID is specified as a string (minimum length of 1 and + // maximum length of 300). If no local disks are configured as working storage, + // then the DiskIds array is empty. DiskIds []string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The total working storage in bytes allocated for the gateway. If no working diff --git a/service/storagegateway/api_op_DetachVolume.go b/service/storagegateway/api_op_DetachVolume.go index 79fed4eb6f2..c38396353a5 100644 --- a/service/storagegateway/api_op_DetachVolume.go +++ b/service/storagegateway/api_op_DetachVolume.go @@ -40,9 +40,9 @@ type DetachVolumeInput struct { VolumeARN *string // Set to true to forcibly remove the iSCSI connection of the target volume and - // detach the volume. The default is false. If this value is set to false, you must - // manually disconnect the iSCSI connection from the target volume. Valid Values: - // true | false + // detach the volume. The default is false . If this value is set to false , you + // must manually disconnect the iSCSI connection from the target volume. Valid + // Values: true | false ForceDetach *bool noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_DisableGateway.go b/service/storagegateway/api_op_DisableGateway.go index abc4a95cb7d..2ec00833cd2 100644 --- a/service/storagegateway/api_op_DisableGateway.go +++ b/service/storagegateway/api_op_DisableGateway.go @@ -33,8 +33,8 @@ func (c *Client) DisableGateway(ctx context.Context, params *DisableGatewayInput // DisableGatewayInput type DisableGatewayInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_JoinDomain.go b/service/storagegateway/api_op_JoinDomain.go index bd3ca9dc9be..e5878d74f05 100644 --- a/service/storagegateway/api_op_JoinDomain.go +++ b/service/storagegateway/api_op_JoinDomain.go @@ -36,8 +36,8 @@ type JoinDomainInput struct { // This member is required. DomainName *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -58,12 +58,12 @@ type JoinDomainInput struct { // List of IPv4 addresses, NetBIOS names, or host names of your domain server. If // you need to specify the port number include it after the colon (“:”). For - // example, mydc.mydomain.com:389. + // example, mydc.mydomain.com:389 . DomainControllers []string - // The organizational unit (OU) is a container in an Active Directory that can hold - // users, groups, computers, and other OUs and this parameter specifies the OU that - // the gateway will join within the AD domain. + // The organizational unit (OU) is a container in an Active Directory that can + // hold users, groups, computers, and other OUs and this parameter specifies the OU + // that the gateway will join within the AD domain. OrganizationalUnit *string // Specifies the time in seconds, in which the JoinDomain operation must complete. @@ -76,30 +76,18 @@ type JoinDomainInput struct { // JoinDomainOutput type JoinDomainOutput struct { - // Indicates the status of the gateway as a member of the Active Directory - // domain. - // - // * ACCESS_DENIED: Indicates that the JoinDomain operation failed due to - // an authentication error. - // - // * DETACHED: Indicates that gateway is not joined to a - // domain. - // - // * JOINED: Indicates that the gateway has successfully joined a - // domain. - // - // * JOINING: Indicates that a JoinDomain operation is in progress. - // - // * - // NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or - // connectivity error. - // - // * TIMEOUT: Indicates that the JoinDomain operation failed - // because the operation didn't complete within the allotted time. - // - // * - // UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another - // type of error. + // Indicates the status of the gateway as a member of the Active Directory domain. + // - ACCESS_DENIED : Indicates that the JoinDomain operation failed due to an + // authentication error. + // - DETACHED : Indicates that gateway is not joined to a domain. + // - JOINED : Indicates that the gateway has successfully joined a domain. + // - JOINING : Indicates that a JoinDomain operation is in progress. + // - NETWORK_ERROR : Indicates that JoinDomain operation failed due to a network + // or connectivity error. + // - TIMEOUT : Indicates that the JoinDomain operation failed because the + // operation didn't complete within the allotted time. + // - UNKNOWN_ERROR : Indicates that the JoinDomain operation failed due to + // another type of error. ActiveDirectoryStatus types.ActiveDirectoryStatus // The unique Amazon Resource Name (ARN) of the gateway that joined the domain. diff --git a/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go b/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go index 9b83a0909ea..fe72b970889 100644 --- a/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go +++ b/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go @@ -31,8 +31,8 @@ func (c *Client) ListAutomaticTapeCreationPolicies(ctx context.Context, params * type ListAutomaticTapeCreationPoliciesInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_ListFileShares.go b/service/storagegateway/api_op_ListFileShares.go index 256437df4c4..894cdef5bf8 100644 --- a/service/storagegateway/api_op_ListFileShares.go +++ b/service/storagegateway/api_op_ListFileShares.go @@ -56,12 +56,12 @@ type ListFileSharesOutput struct { // An array of information about the S3 File Gateway's file shares. FileShareInfoList []types.FileShareInfo - // If the request includes Marker, the response returns that value in this field. + // If the request includes Marker , the response returns that value in this field. Marker *string // If a value is present, there are more file shares to return. In a subsequent - // request, use NextMarker as the value for Marker to retrieve the next set of file - // shares. + // request, use NextMarker as the value for Marker to retrieve the next set of + // file shares. NextMarker *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_ListFileSystemAssociations.go b/service/storagegateway/api_op_ListFileSystemAssociations.go index ffd86796e3a..57fcd7855b2 100644 --- a/service/storagegateway/api_op_ListFileSystemAssociations.go +++ b/service/storagegateway/api_op_ListFileSystemAssociations.go @@ -32,8 +32,8 @@ func (c *Client) ListFileSystemAssociations(ctx context.Context, params *ListFil type ListFileSystemAssociationsInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The maximum number of file system associations to return in the response. If @@ -42,7 +42,7 @@ type ListFileSystemAssociationsInput struct { // Opaque pagination token returned from a previous ListFileSystemAssociations // operation. If present, Marker specifies where to continue the list from after a - // previous call to ListFileSystemAssociations. Optional. + // previous call to ListFileSystemAssociations . Optional. Marker *string noSmithyDocumentSerde @@ -53,7 +53,7 @@ type ListFileSystemAssociationsOutput struct { // An array of information about the Amazon FSx gateway's file system associations. FileSystemAssociationSummaryList []types.FileSystemAssociationSummary - // If the request includes Marker, the response returns that value in this field. + // If the request includes Marker , the response returns that value in this field. Marker *string // If a value is present, there are more file system associations to return. In a diff --git a/service/storagegateway/api_op_ListGateways.go b/service/storagegateway/api_op_ListGateways.go index 25993325bfe..28d2e3c04fa 100644 --- a/service/storagegateway/api_op_ListGateways.go +++ b/service/storagegateway/api_op_ListGateways.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists gateways owned by an Amazon Web Services account in an Amazon Web Services -// Region specified in the request. The returned list is ordered by gateway Amazon -// Resource Name (ARN). By default, the operation returns a maximum of 100 -// gateways. This operation supports pagination that allows you to optionally -// reduce the number of gateways returned in a response. If you have more gateways -// than are returned in a response (that is, the response returns only a truncated -// list of your gateways), the response contains a marker that you can specify in -// your next request to fetch the next page of gateways. +// Lists gateways owned by an Amazon Web Services account in an Amazon Web +// Services Region specified in the request. The returned list is ordered by +// gateway Amazon Resource Name (ARN). By default, the operation returns a maximum +// of 100 gateways. This operation supports pagination that allows you to +// optionally reduce the number of gateways returned in a response. If you have +// more gateways than are returned in a response (that is, the response returns +// only a truncated list of your gateways), the response contains a marker that you +// can specify in your next request to fetch the next page of gateways. func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error) { if params == nil { params = &ListGatewaysInput{} @@ -36,19 +36,16 @@ func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, op } // A JSON object containing zero or more of the following fields: -// -// * -// ListGatewaysInput$Limit -// -// * ListGatewaysInput$Marker +// - ListGatewaysInput$Limit +// - ListGatewaysInput$Marker type ListGatewaysInput struct { // Specifies that the list of gateways returned be limited to the specified number // of items. Limit *int32 - // An opaque string that indicates the position at which to begin the returned list - // of gateways. + // An opaque string that indicates the position at which to begin the returned + // list of gateways. Marker *string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_ListLocalDisks.go b/service/storagegateway/api_op_ListLocalDisks.go index 361027e9cdd..7183b8f0e1e 100644 --- a/service/storagegateway/api_op_ListLocalDisks.go +++ b/service/storagegateway/api_op_ListLocalDisks.go @@ -15,10 +15,10 @@ import ( // describe, you use the Amazon Resource Name (ARN) of the gateway in the body of // the request. The request returns a list of all disks, specifying which are // configured as working storage, cache storage, or stored volume or not configured -// at all. The response includes a DiskStatus field. This field can have a value of -// present (the disk is available to use), missing (the disk is no longer connected -// to the gateway), or mismatch (the disk node is occupied by a disk that has -// incorrect metadata or the disk content is corrupted). +// at all. The response includes a DiskStatus field. This field can have a value +// of present (the disk is available to use), missing (the disk is no longer +// connected to the gateway), or mismatch (the disk node is occupied by a disk that +// has incorrect metadata or the disk content is corrupted). func (c *Client) ListLocalDisks(ctx context.Context, params *ListLocalDisksInput, optFns ...func(*Options)) (*ListLocalDisksOutput, error) { if params == nil { params = &ListLocalDisksInput{} @@ -37,8 +37,8 @@ func (c *Client) ListLocalDisks(ctx context.Context, params *ListLocalDisksInput // A JSON object containing the Amazon Resource Name (ARN) of the gateway. type ListLocalDisksInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -49,12 +49,11 @@ type ListLocalDisksInput struct { type ListLocalDisksOutput struct { // A JSON object containing the following fields: - // - // * ListLocalDisksOutput$Disks + // - ListLocalDisksOutput$Disks Disks []types.Disk - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_ListTagsForResource.go b/service/storagegateway/api_op_ListTagsForResource.go index fcbf19fa052..f61e90cc64a 100644 --- a/service/storagegateway/api_op_ListTagsForResource.go +++ b/service/storagegateway/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags that have been added to the specified resource. This operation is -// supported in storage gateways of all types. +// Lists the tags that have been added to the specified resource. This operation +// is supported in storage gateways of all types. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -51,8 +51,8 @@ type ListTagsForResourceInput struct { // ListTagsForResourceOutput type ListTagsForResourceOutput struct { - // An opaque string that indicates the position at which to stop returning the list - // of tags. + // An opaque string that indicates the position at which to stop returning the + // list of tags. Marker *string // The Amazon Resource Name (ARN) of the resource for which you want to list tags. @@ -130,8 +130,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/storagegateway/api_op_ListTapePools.go b/service/storagegateway/api_op_ListTapePools.go index 22637fbefa5..3d8bdaf8b89 100644 --- a/service/storagegateway/api_op_ListTapePools.go +++ b/service/storagegateway/api_op_ListTapePools.go @@ -12,14 +12,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists custom tape pools. You specify custom tape pools to list by specifying one -// or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a -// custom tape pool ARN, the operation lists all custom tape pools. This operation -// supports pagination. You can optionally specify the Limit parameter in the body -// to limit the number of tape pools in the response. If the number of tape pools -// returned in the response is truncated, the response includes a Marker element -// that you can use in your subsequent request to retrieve the next set of tape -// pools. +// Lists custom tape pools. You specify custom tape pools to list by specifying +// one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify +// a custom tape pool ARN, the operation lists all custom tape pools. This +// operation supports pagination. You can optionally specify the Limit parameter +// in the body to limit the number of tape pools in the response. If the number of +// tape pools returned in the response is truncated, the response includes a Marker +// element that you can use in your subsequent request to retrieve the next set of +// tape pools. func (c *Client) ListTapePools(ctx context.Context, params *ListTapePoolsInput, optFns ...func(*Options)) (*ListTapePoolsOutput, error) { if params == nil { params = &ListTapePoolsInput{} @@ -40,8 +40,8 @@ type ListTapePoolsInput struct { // An optional number limit for the tape pools in the list returned by this call. Limit *int32 - // A string that indicates the position at which to begin the returned list of tape - // pools. + // A string that indicates the position at which to begin the returned list of + // tape pools. Marker *string // The Amazon Resource Name (ARN) of each of the custom tape pools you want to @@ -54,10 +54,10 @@ type ListTapePoolsInput struct { type ListTapePoolsOutput struct { - // A string that indicates the position at which to begin the returned list of tape - // pools. Use the marker in your next request to continue pagination of tape pools. - // If there are no more tape pools to list, this element does not appear in the - // response body. + // A string that indicates the position at which to begin the returned list of + // tape pools. Use the marker in your next request to continue pagination of tape + // pools. If there are no more tape pools to list, this element does not appear in + // the response body. Marker *string // An array of PoolInfo objects, where each object describes a single custom tape diff --git a/service/storagegateway/api_op_ListTapes.go b/service/storagegateway/api_op_ListTapes.go index e265b7f425d..6ddf1ca7624 100644 --- a/service/storagegateway/api_op_ListTapes.go +++ b/service/storagegateway/api_op_ListTapes.go @@ -38,13 +38,9 @@ func (c *Client) ListTapes(ctx context.Context, params *ListTapesInput, optFns . } // A JSON object that contains one or more of the following fields: -// -// * -// ListTapesInput$Limit -// -// * ListTapesInput$Marker -// -// * ListTapesInput$TapeARNs +// - ListTapesInput$Limit +// - ListTapesInput$Marker +// - ListTapesInput$TapeARNs type ListTapesInput struct { // An optional number limit for the tapes in the list returned by this call. @@ -62,11 +58,8 @@ type ListTapesInput struct { } // A JSON object containing the following fields: -// -// * ListTapesOutput$Marker -// -// * -// ListTapesOutput$VolumeInfos +// - ListTapesOutput$Marker +// - ListTapesOutput$VolumeInfos type ListTapesOutput struct { // A string that indicates the position at which to begin returning the next list diff --git a/service/storagegateway/api_op_ListVolumeRecoveryPoints.go b/service/storagegateway/api_op_ListVolumeRecoveryPoints.go index 8f197038be5..f6f046a114a 100644 --- a/service/storagegateway/api_op_ListVolumeRecoveryPoints.go +++ b/service/storagegateway/api_op_ListVolumeRecoveryPoints.go @@ -34,8 +34,8 @@ func (c *Client) ListVolumeRecoveryPoints(ctx context.Context, params *ListVolum type ListVolumeRecoveryPointsInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -45,8 +45,8 @@ type ListVolumeRecoveryPointsInput struct { type ListVolumeRecoveryPointsOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // An array of VolumeRecoveryPointInfo objects. diff --git a/service/storagegateway/api_op_ListVolumes.go b/service/storagegateway/api_op_ListVolumes.go index 67430b4ba10..88459dad640 100644 --- a/service/storagegateway/api_op_ListVolumes.go +++ b/service/storagegateway/api_op_ListVolumes.go @@ -38,15 +38,12 @@ func (c *Client) ListVolumes(ctx context.Context, params *ListVolumesInput, optF } // A JSON object that contains one or more of the following fields: -// -// * -// ListVolumesInput$Limit -// -// * ListVolumesInput$Marker +// - ListVolumesInput$Limit +// - ListVolumesInput$Marker type ListVolumesInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Specifies that the list of volumes returned be limited to the specified number @@ -62,15 +59,12 @@ type ListVolumesInput struct { } // A JSON object containing the following fields: -// -// * ListVolumesOutput$Marker -// -// * -// ListVolumesOutput$VolumeInfos +// - ListVolumesOutput$Marker +// - ListVolumesOutput$VolumeInfos type ListVolumesOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Use the marker in your next request to continue pagination of iSCSI volumes. If diff --git a/service/storagegateway/api_op_NotifyWhenUploaded.go b/service/storagegateway/api_op_NotifyWhenUploaded.go index 8e9b247ec2f..d9482feec8e 100644 --- a/service/storagegateway/api_op_NotifyWhenUploaded.go +++ b/service/storagegateway/api_op_NotifyWhenUploaded.go @@ -19,8 +19,7 @@ import ( // notification through an Amazon CloudWatch Event. You can configure CloudWatch // Events to send the notification through event targets such as Amazon SNS or // Lambda function. This operation is only supported for S3 File Gateways. For more -// information, see Getting file upload notification -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification) +// information, see Getting file upload notification (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification) // in the Storage Gateway User Guide. func (c *Client) NotifyWhenUploaded(ctx context.Context, params *NotifyWhenUploadedInput, optFns ...func(*Options)) (*NotifyWhenUploadedOutput, error) { if params == nil { diff --git a/service/storagegateway/api_op_RefreshCache.go b/service/storagegateway/api_op_RefreshCache.go index c0aa1faa318..e30d0e2b460 100644 --- a/service/storagegateway/api_op_RefreshCache.go +++ b/service/storagegateway/api_op_RefreshCache.go @@ -18,8 +18,7 @@ import ( // inventory of the objects in the S3 bucket. This operation is only supported in // the S3 File Gateway types. You can subscribe to be notified through an Amazon // CloudWatch event when your RefreshCache operation completes. For more -// information, see Getting notified about file operations -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) // in the Storage Gateway User Guide. This operation is Only supported for S3 File // Gateways. When this API is called, it only initiates the refresh operation. When // the API call completes and returns a success code, it doesn't necessarily mean @@ -30,25 +29,18 @@ import ( // This API is asynchronous, so the gateway will accept no more than two refreshes // at any time. We recommend using the refresh-complete CloudWatch event // notification before issuing additional requests. For more information, see -// Getting notified about file operations -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) // in the Storage Gateway User Guide. +// - Wait at least 60 seconds between consecutive RefreshCache API requests. +// - RefreshCache does not evict cache entries if invoked consecutively within +// 60 seconds of a previous RefreshCache request. +// - If you invoke the RefreshCache API when two requests are already being +// processed, any new request will cause an InvalidGatewayRequestException error +// because too many requests were sent to the server. // -// * Wait at least 60 seconds between -// consecutive RefreshCache API requests. -// -// * RefreshCache does not evict cache -// entries if invoked consecutively within 60 seconds of a previous RefreshCache -// request. -// -// * If you invoke the RefreshCache API when two requests are already -// being processed, any new request will cause an InvalidGatewayRequestException -// error because too many requests were sent to the server. -// -// The S3 bucket name -// does not need to be included when entering the list of folders in the FolderList -// parameter. For more information, see Getting notified about file operations -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// The S3 bucket name does not need to be included when entering the list of +// folders in the FolderList parameter. For more information, see Getting notified +// about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) // in the Storage Gateway User Guide. func (c *Client) RefreshCache(ctx context.Context, params *RefreshCacheInput, optFns ...func(*Options)) (*RefreshCacheOutput, error) { if params == nil { @@ -74,18 +66,18 @@ type RefreshCacheInput struct { FileShareARN *string // A comma-separated list of the paths of folders to refresh in the cache. The - // default is ["/"]. The default refreshes objects and folders at the root of the - // Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the + // default is [ "/" ]. The default refreshes objects and folders at the root of the + // Amazon S3 bucket. If Recursive is set to true , the entire S3 bucket that the // file share has access to is refreshed. FolderList []string // A value that specifies whether to recursively refresh folders in the cache. The // refresh includes folders that were in the cache the last time the gateway listed - // the folder's contents. If this value set to true, each folder that is listed in + // the folder's contents. If this value set to true , each folder that is listed in // FolderList is recursively updated. Otherwise, subfolders listed in FolderList // are not refreshed. Only objects that are in folders listed directly under - // FolderList are found and used for the update. The default is true. Valid Values: - // true | false + // FolderList are found and used for the update. The default is true . Valid + // Values: true | false Recursive *bool noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_ResetCache.go b/service/storagegateway/api_op_ResetCache.go index 71eb69abf60..f309ece2049 100644 --- a/service/storagegateway/api_op_ResetCache.go +++ b/service/storagegateway/api_op_ResetCache.go @@ -38,8 +38,8 @@ func (c *Client) ResetCache(ctx context.Context, params *ResetCacheInput, optFns type ResetCacheInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -49,8 +49,8 @@ type ResetCacheInput struct { type ResetCacheOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_RetrieveTapeArchive.go b/service/storagegateway/api_op_RetrieveTapeArchive.go index 73a42cc7af0..16229451496 100644 --- a/service/storagegateway/api_op_RetrieveTapeArchive.go +++ b/service/storagegateway/api_op_RetrieveTapeArchive.go @@ -44,8 +44,8 @@ type RetrieveTapeArchiveInput struct { // This member is required. GatewayARN *string - // The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the - // virtual tape shelf (VTS). + // The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from + // the virtual tape shelf (VTS). // // This member is required. TapeARN *string diff --git a/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go b/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go index 4e3505722d8..a29dbbbcce8 100644 --- a/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go +++ b/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go @@ -35,8 +35,8 @@ func (c *Client) RetrieveTapeRecoveryPoint(ctx context.Context, params *Retrieve // RetrieveTapeRecoveryPointInput type RetrieveTapeRecoveryPointInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_SetLocalConsolePassword.go b/service/storagegateway/api_op_SetLocalConsolePassword.go index 5c537aa950c..b7689eb02cc 100644 --- a/service/storagegateway/api_op_SetLocalConsolePassword.go +++ b/service/storagegateway/api_op_SetLocalConsolePassword.go @@ -32,8 +32,8 @@ func (c *Client) SetLocalConsolePassword(ctx context.Context, params *SetLocalCo // SetLocalConsolePasswordInput type SetLocalConsolePasswordInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -48,8 +48,8 @@ type SetLocalConsolePasswordInput struct { type SetLocalConsolePasswordOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_SetSMBGuestPassword.go b/service/storagegateway/api_op_SetSMBGuestPassword.go index a325c61685a..8411b95cf99 100644 --- a/service/storagegateway/api_op_SetSMBGuestPassword.go +++ b/service/storagegateway/api_op_SetSMBGuestPassword.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the password for the guest user smbguest. The smbguest user is the user -// when the authentication method for the file share is set to GuestAccess. This +// Sets the password for the guest user smbguest . The smbguest user is the user +// when the authentication method for the file share is set to GuestAccess . This // operation only supported for S3 File Gateways func (c *Client) SetSMBGuestPassword(ctx context.Context, params *SetSMBGuestPasswordInput, optFns ...func(*Options)) (*SetSMBGuestPasswordOutput, error) { if params == nil { @@ -47,8 +47,8 @@ type SetSMBGuestPasswordInput struct { type SetSMBGuestPasswordOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_ShutdownGateway.go b/service/storagegateway/api_op_ShutdownGateway.go index 1fc383cc46d..45e474428c6 100644 --- a/service/storagegateway/api_op_ShutdownGateway.go +++ b/service/storagegateway/api_op_ShutdownGateway.go @@ -16,15 +16,15 @@ import ( // machine (VM) and not the host VM. If you want to shut down the VM, it is // recommended that you first shut down the gateway component in the VM to avoid // unpredictable conditions. After the gateway is shutdown, you cannot call any -// other API except StartGateway, DescribeGatewayInformation, and ListGateways. For -// more information, see ActivateGateway. Your applications cannot read from or -// write to the gateway's storage volumes, and there are no snapshots taken. When -// you make a shutdown request, you will get a 200 OK success response immediately. -// However, it might take some time for the gateway to shut down. You can call the -// DescribeGatewayInformation API to check the status. For more information, see -// ActivateGateway. If do not intend to use the gateway again, you must delete the -// gateway (using DeleteGateway) to no longer pay software charges associated with -// the gateway. +// other API except StartGateway , DescribeGatewayInformation , and ListGateways . +// For more information, see ActivateGateway . Your applications cannot read from +// or write to the gateway's storage volumes, and there are no snapshots taken. +// When you make a shutdown request, you will get a 200 OK success response +// immediately. However, it might take some time for the gateway to shut down. You +// can call the DescribeGatewayInformation API to check the status. For more +// information, see ActivateGateway . If do not intend to use the gateway again, +// you must delete the gateway (using DeleteGateway ) to no longer pay software +// charges associated with the gateway. func (c *Client) ShutdownGateway(ctx context.Context, params *ShutdownGatewayInput, optFns ...func(*Options)) (*ShutdownGatewayOutput, error) { if params == nil { params = &ShutdownGatewayInput{} @@ -44,8 +44,8 @@ func (c *Client) ShutdownGateway(ctx context.Context, params *ShutdownGatewayInp // down. type ShutdownGatewayInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -57,8 +57,8 @@ type ShutdownGatewayInput struct { // shut down. type ShutdownGatewayOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_StartAvailabilityMonitorTest.go b/service/storagegateway/api_op_StartAvailabilityMonitorTest.go index 9395ffaaf8c..ead848f439a 100644 --- a/service/storagegateway/api_op_StartAvailabilityMonitorTest.go +++ b/service/storagegateway/api_op_StartAvailabilityMonitorTest.go @@ -33,8 +33,8 @@ func (c *Client) StartAvailabilityMonitorTest(ctx context.Context, params *Start type StartAvailabilityMonitorTestInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -44,8 +44,8 @@ type StartAvailabilityMonitorTestInput struct { type StartAvailabilityMonitorTestOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_StartGateway.go b/service/storagegateway/api_op_StartGateway.go index 39ac4880851..3e16022f62a 100644 --- a/service/storagegateway/api_op_StartGateway.go +++ b/service/storagegateway/api_op_StartGateway.go @@ -10,13 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a gateway that you previously shut down (see ShutdownGateway). After the +// Starts a gateway that you previously shut down (see ShutdownGateway ). After the // gateway starts, you can then make other API calls, your applications can read // from or write to the gateway's storage volumes and you will be able to take // snapshot backups. When you make a request, you will get a 200 OK success // response immediately. However, it might take some time for the gateway to be // ready. You should call DescribeGatewayInformation and check the status before -// making any additional API calls. For more information, see ActivateGateway. To +// making any additional API calls. For more information, see ActivateGateway . To // specify which gateway to start, use the Amazon Resource Name (ARN) of the // gateway in your request. func (c *Client) StartGateway(ctx context.Context, params *StartGatewayInput, optFns ...func(*Options)) (*StartGatewayOutput, error) { @@ -37,8 +37,8 @@ func (c *Client) StartGateway(ctx context.Context, params *StartGatewayInput, op // A JSON object containing the Amazon Resource Name (ARN) of the gateway to start. type StartGatewayInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -50,8 +50,8 @@ type StartGatewayInput struct { // restarted. type StartGatewayOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go b/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go index f64813ff299..427ab0b34bd 100644 --- a/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go +++ b/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go @@ -38,8 +38,8 @@ type UpdateAutomaticTapeCreationPolicyInput struct { // This member is required. AutomaticTapeCreationRules []types.AutomaticTapeCreationRule - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -49,8 +49,8 @@ type UpdateAutomaticTapeCreationPolicyInput struct { type UpdateAutomaticTapeCreationPolicyOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateBandwidthRateLimit.go b/service/storagegateway/api_op_UpdateBandwidthRateLimit.go index 4c65427a6b8..4cb305e9cc1 100644 --- a/service/storagegateway/api_op_UpdateBandwidthRateLimit.go +++ b/service/storagegateway/api_op_UpdateBandwidthRateLimit.go @@ -15,7 +15,7 @@ import ( // set a bandwidth rate limit, the existing rate limit remains. This operation is // supported only for the stored volume, cached volume, and tape gateway types. To // update bandwidth rate limits for S3 file gateways, use -// UpdateBandwidthRateLimitSchedule. By default, a gateway's bandwidth rate limits +// UpdateBandwidthRateLimitSchedule . By default, a gateway's bandwidth rate limits // are not set. If you don't set any limit, the gateway does not have any // limitations on its bandwidth usage and could potentially use the maximum // available bandwidth. To specify which gateway to update, use the Amazon Resource @@ -36,16 +36,12 @@ func (c *Client) UpdateBandwidthRateLimit(ctx context.Context, params *UpdateBan } // A JSON object containing one or more of the following fields: -// -// * -// UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec -// -// * -// UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec +// - UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec +// - UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec type UpdateBandwidthRateLimitInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -63,8 +59,8 @@ type UpdateBandwidthRateLimitInput struct { // throttle information was updated. type UpdateBandwidthRateLimitOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go b/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go index 4cadd63426c..9c47cb22044 100644 --- a/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go +++ b/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go @@ -39,8 +39,8 @@ type UpdateBandwidthRateLimitScheduleInput struct { // This member is required. BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -50,8 +50,8 @@ type UpdateBandwidthRateLimitScheduleInput struct { type UpdateBandwidthRateLimitScheduleOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateChapCredentials.go b/service/storagegateway/api_op_UpdateChapCredentials.go index 194f510b892..44fa57a6ff3 100644 --- a/service/storagegateway/api_op_UpdateChapCredentials.go +++ b/service/storagegateway/api_op_UpdateChapCredentials.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a -// specified iSCSI target. By default, a gateway does not have CHAP enabled; +// Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for +// a specified iSCSI target. By default, a gateway does not have CHAP enabled; // however, for added security, you might use it. This operation is supported in // the volume and tape gateway types. When you update CHAP credentials, all // existing connections on the target are closed and initiators must reconnect with @@ -32,18 +32,10 @@ func (c *Client) UpdateChapCredentials(ctx context.Context, params *UpdateChapCr } // A JSON object containing one or more of the following fields: -// -// * -// UpdateChapCredentialsInput$InitiatorName -// -// * -// UpdateChapCredentialsInput$SecretToAuthenticateInitiator -// -// * -// UpdateChapCredentialsInput$SecretToAuthenticateTarget -// -// * -// UpdateChapCredentialsInput$TargetARN +// - UpdateChapCredentialsInput$InitiatorName +// - UpdateChapCredentialsInput$SecretToAuthenticateInitiator +// - UpdateChapCredentialsInput$SecretToAuthenticateTarget +// - UpdateChapCredentialsInput$TargetARN type UpdateChapCredentialsInput struct { // The iSCSI initiator that connects to the target. @@ -51,9 +43,9 @@ type UpdateChapCredentialsInput struct { // This member is required. InitiatorName *string - // The secret key that the initiator (for example, the Windows client) must provide - // to participate in mutual CHAP with the target. The secret key must be between 12 - // and 16 bytes when encoded in UTF-8. + // The secret key that the initiator (for example, the Windows client) must + // provide to participate in mutual CHAP with the target. The secret key must be + // between 12 and 16 bytes when encoded in UTF-8. // // This member is required. SecretToAuthenticateInitiator *string @@ -77,8 +69,8 @@ type UpdateChapCredentialsInput struct { // A JSON object containing the following fields: type UpdateChapCredentialsOutput struct { - // The iSCSI initiator that connects to the target. This is the same initiator name - // specified in the request. + // The iSCSI initiator that connects to the target. This is the same initiator + // name specified in the request. InitiatorName *string // The Amazon Resource Name (ARN) of the target. This is the same target specified diff --git a/service/storagegateway/api_op_UpdateGatewayInformation.go b/service/storagegateway/api_op_UpdateGatewayInformation.go index b4752931c1f..fb1e253a3f9 100644 --- a/service/storagegateway/api_op_UpdateGatewayInformation.go +++ b/service/storagegateway/api_op_UpdateGatewayInformation.go @@ -33,16 +33,15 @@ func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGat type UpdateGatewayInformationInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want // to use to monitor and log events in the gateway. For more information, see What - // is Amazon CloudWatch Logs? - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) + // is Amazon CloudWatch Logs? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) CloudWatchLogGroupARN *string // Specifies the size of the gateway's metadata cache. @@ -61,8 +60,8 @@ type UpdateGatewayInformationInput struct { // updated. type UpdateGatewayInformationOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The name you configured for your gateway. diff --git a/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go b/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go index 53b797696e2..ea79453ccb7 100644 --- a/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go +++ b/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go @@ -18,11 +18,9 @@ import ( // gateway. You can minimize the chance of any disruption to your applications by // increasing your iSCSI Initiators' timeouts. For more information about // increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your -// Windows iSCSI settings -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) -// and Customizing your Linux iSCSI settings -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), -// respectively. +// Windows iSCSI settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) +// and Customizing your Linux iSCSI settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings) +// , respectively. func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error) { if params == nil { params = &UpdateGatewaySoftwareNowInput{} @@ -42,8 +40,8 @@ func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGat // update. type UpdateGatewaySoftwareNowInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -55,8 +53,8 @@ type UpdateGatewaySoftwareNowInput struct { // updated. type UpdateGatewaySoftwareNowOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateMaintenanceStartTime.go b/service/storagegateway/api_op_UpdateMaintenanceStartTime.go index 3c08da16d2e..ca8541e3b7d 100644 --- a/service/storagegateway/api_op_UpdateMaintenanceStartTime.go +++ b/service/storagegateway/api_op_UpdateMaintenanceStartTime.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a gateway's weekly maintenance start time information, including day and -// time of the week. The maintenance time is the time in your gateway's time zone. +// Updates a gateway's weekly maintenance start time information, including day +// and time of the week. The maintenance time is the time in your gateway's time +// zone. func (c *Client) UpdateMaintenanceStartTime(ctx context.Context, params *UpdateMaintenanceStartTimeInput, optFns ...func(*Options)) (*UpdateMaintenanceStartTimeOutput, error) { if params == nil { params = &UpdateMaintenanceStartTimeInput{} @@ -28,22 +29,14 @@ func (c *Client) UpdateMaintenanceStartTime(ctx context.Context, params *UpdateM } // A JSON object containing the following fields: -// -// * -// UpdateMaintenanceStartTimeInput$DayOfMonth -// -// * -// UpdateMaintenanceStartTimeInput$DayOfWeek -// -// * -// UpdateMaintenanceStartTimeInput$HourOfDay -// -// * -// UpdateMaintenanceStartTimeInput$MinuteOfHour +// - UpdateMaintenanceStartTimeInput$DayOfMonth +// - UpdateMaintenanceStartTimeInput$DayOfWeek +// - UpdateMaintenanceStartTimeInput$HourOfDay +// - UpdateMaintenanceStartTimeInput$MinuteOfHour type UpdateMaintenanceStartTimeInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -77,8 +70,8 @@ type UpdateMaintenanceStartTimeInput struct { // maintenance start time is updated. type UpdateMaintenanceStartTimeOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateNFSFileShare.go b/service/storagegateway/api_op_UpdateNFSFileShare.go index edcc4323c7a..3176c5c7ab4 100644 --- a/service/storagegateway/api_op_UpdateNFSFileShare.go +++ b/service/storagegateway/api_op_UpdateNFSFileShare.go @@ -11,22 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a Network File System (NFS) file share. This operation is only supported -// in S3 File Gateways. To leave a file share field unchanged, set the +// Updates a Network File System (NFS) file share. This operation is only +// supported in S3 File Gateways. To leave a file share field unchanged, set the // corresponding input field to null. Updates the following file share settings: -// -// * -// Default storage class for your S3 bucket -// -// * Metadata defaults for your S3 -// bucket -// -// * Allowed NFS clients for your file share -// -// * Squash settings -// -// * Write -// status of your file share +// - Default storage class for your S3 bucket +// - Metadata defaults for your S3 bucket +// - Allowed NFS clients for your file share +// - Squash settings +// - Write status of your file share func (c *Client) UpdateNFSFileShare(ctx context.Context, params *UpdateNFSFileShareInput, optFns ...func(*Options)) (*UpdateNFSFileShareOutput, error) { if params == nil { params = &UpdateNFSFileShareInput{} @@ -61,26 +53,26 @@ type UpdateNFSFileShareInput struct { ClientList []string // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The default values for the file share. Optional. @@ -98,33 +90,29 @@ type UpdateNFSFileShareInput struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that a S3 File Gateway puts objects into. The default value is private + // . ObjectACL types.ObjectACL // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false. Valid Values: true | - // false + // set the write status to read-only, otherwise set to false . Valid Values: true + // | false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // The user mapped to anonymous user. Valid values are the following: - // - // * - // RootSquash: Only root is mapped to anonymous user. - // - // * NoSquash: No one is mapped - // to anonymous user. - // - // * AllSquash: Everyone is mapped to anonymous user. + // - RootSquash : Only root is mapped to anonymous user. + // - NoSquash : No one is mapped to anonymous user. + // - AllSquash : Everyone is mapped to anonymous user. Squash *string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_UpdateSMBFileShare.go b/service/storagegateway/api_op_UpdateSMBFileShare.go index a007fcf9959..af86c3711de 100644 --- a/service/storagegateway/api_op_UpdateSMBFileShare.go +++ b/service/storagegateway/api_op_UpdateSMBFileShare.go @@ -19,8 +19,7 @@ import ( // Region you are creating your file gateway in. If Amazon Web Services STS is not // activated in this Amazon Web Services Region, activate it. For information about // how to activate Amazon Web Services STS, see Activating and deactivating Amazon -// Web Services STS in an Amazon Web Services Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Identity and Access Management User Guide. File gateways don't support // creating hard or symbolic links on a file share. func (c *Client) UpdateSMBFileShare(ctx context.Context, params *UpdateSMBFileShareInput, optFns ...func(*Options)) (*UpdateSMBFileShareOutput, error) { @@ -50,10 +49,10 @@ type UpdateSMBFileShareInput struct { // access. AccessBasedEnumeration *bool - // A list of users or groups in the Active Directory that have administrator rights - // to the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that have administrator + // rights to the file share. A group must be prefixed with the @ character. + // Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 + // . Can only be set if Authentication is set to ActiveDirectory . AdminUserList []string // The Amazon Resource Name (ARN) of the storage used for audit logs. @@ -62,38 +61,38 @@ type UpdateSMBFileShareInput struct { // Specifies refresh cache information for the file share. CacheAttributes *types.CacheAttributes - // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the - // client determines the case sensitivity. For CaseSensitive, the gateway - // determines the case sensitivity. The default value is ClientSpecified. + // The case of an object name in an Amazon S3 bucket. For ClientSpecified , the + // client determines the case sensitivity. For CaseSensitive , the gateway + // determines the case sensitivity. The default value is ClientSpecified . CaseSensitivity types.CaseSensitivity // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool - // A list of users or groups in the Active Directory that are not allowed to access - // the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are not allowed to + // access the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . InvalidUserList []string // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted *bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The notification policy of the file share. SettlingTimeInSeconds controls the @@ -108,8 +107,9 @@ type UpdateSMBFileShareInput struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that a S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that a S3 File Gateway puts objects into. The default value is private + // . ObjectACL types.ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. @@ -119,31 +119,30 @@ type UpdateSMBFileShareInput struct { OplocksEnabled *bool // A value that sets the write status of a file share. Set this value to true to - // set write status to read-only, otherwise set to false. Valid Values: true | + // set write status to read-only, otherwise set to false . Valid Values: true | // false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // Set this value to true to enable access control list (ACL) on the SMB file // share. Set it to false to map file and directory permissions to the POSIX // permissions. For more information, see Using Microsoft Windows ACLs to control - // access to an SMB file share - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in - // the Storage Gateway User Guide. Valid Values: true | false + // access to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the Storage Gateway User Guide. Valid Values: true | false SMBACLEnabled *bool - // A list of users or groups in the Active Directory that are allowed to access the - // file share. A group must be prefixed with the @ character. Acceptable formats - // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if - // Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are allowed to access + // the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . ValidUserList []string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go b/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go index d0cd241e9db..1d760ff820e 100644 --- a/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go +++ b/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go @@ -34,8 +34,8 @@ type UpdateSMBFileShareVisibilityInput struct { // This member is required. FileSharesVisible *bool - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -45,8 +45,8 @@ type UpdateSMBFileShareVisibilityInput struct { type UpdateSMBFileShareVisibilityOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateSMBLocalGroups.go b/service/storagegateway/api_op_UpdateSMBLocalGroups.go index da5363569be..bacdf0da2a5 100644 --- a/service/storagegateway/api_op_UpdateSMBLocalGroups.go +++ b/service/storagegateway/api_op_UpdateSMBLocalGroups.go @@ -30,8 +30,8 @@ func (c *Client) UpdateSMBLocalGroups(ctx context.Context, params *UpdateSMBLoca type UpdateSMBLocalGroupsInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -47,8 +47,8 @@ type UpdateSMBLocalGroupsInput struct { type UpdateSMBLocalGroupsOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go b/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go index eda57632e63..0d78e5a0a6f 100644 --- a/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go +++ b/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go @@ -31,8 +31,8 @@ func (c *Client) UpdateSMBSecurityStrategy(ctx context.Context, params *UpdateSM type UpdateSMBSecurityStrategyInput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -57,8 +57,8 @@ type UpdateSMBSecurityStrategyInput struct { type UpdateSMBSecurityStrategyOutput struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateSnapshotSchedule.go b/service/storagegateway/api_op_UpdateSnapshotSchedule.go index a621bece8e7..e58b9738419 100644 --- a/service/storagegateway/api_op_UpdateSnapshotSchedule.go +++ b/service/storagegateway/api_op_UpdateSnapshotSchedule.go @@ -35,17 +35,10 @@ func (c *Client) UpdateSnapshotSchedule(ctx context.Context, params *UpdateSnaps } // A JSON object containing one or more of the following fields: -// -// * -// UpdateSnapshotScheduleInput$Description -// -// * -// UpdateSnapshotScheduleInput$RecurrenceInHours -// -// * -// UpdateSnapshotScheduleInput$StartAt -// -// * UpdateSnapshotScheduleInput$VolumeARN +// - UpdateSnapshotScheduleInput$Description +// - UpdateSnapshotScheduleInput$RecurrenceInHours +// - UpdateSnapshotScheduleInput$StartAt +// - UpdateSnapshotScheduleInput$VolumeARN type UpdateSnapshotScheduleInput struct { // Frequency of snapshots. Specify the number of hours between snapshots. diff --git a/service/storagegateway/doc.go b/service/storagegateway/doc.go index 72a4130604f..bd1a7484769 100644 --- a/service/storagegateway/doc.go +++ b/service/storagegateway/doc.go @@ -10,50 +10,38 @@ // upload data to the Amazon Web Services Cloud for cost effective backup and rapid // disaster recovery. Use the following links to get started using the Storage // Gateway Service API Reference: +// - Storage Gateway required request headers (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders) +// : Describes the required headers that you must send with every POST request to +// Storage Gateway. +// - Signing requests (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests) +// : Storage Gateway requires that you authenticate every request you send; this +// topic describes how sign such a request. +// - Error responses (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses) +// : Provides reference information about Storage Gateway errors. +// - Operations in Storage Gateway (https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html) +// : Contains detailed descriptions of all Storage Gateway operations, their +// request parameters, response elements, possible errors, and examples of requests +// and responses. +// - Storage Gateway endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) +// : Provides a list of each Amazon Web Services Region and the endpoints available +// for use with Storage Gateway. // -// * Storage Gateway required request headers -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders): -// Describes the required headers that you must send with every POST request to -// Storage Gateway. -// -// * Signing requests -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests): -// Storage Gateway requires that you authenticate every request you send; this -// topic describes how sign such a request. -// -// * Error responses -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses): -// Provides reference information about Storage Gateway errors. -// -// * Operations in -// Storage Gateway -// (https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html): -// Contains detailed descriptions of all Storage Gateway operations, their request -// parameters, response elements, possible errors, and examples of requests and -// responses. -// -// * Storage Gateway endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/sg.html): Provides a list of each -// Amazon Web Services Region and the endpoints available for use with Storage -// Gateway. -// -// Storage Gateway resource IDs are in uppercase. When you use these -// resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You -// must change your resource ID to lowercase to use it with the EC2 API. For -// example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. -// When you use this ID with the EC2 API, you must change it to -// vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected. IDs -// for Storage Gateway volumes and Amazon EBS snapshots created from gateway -// volumes are changing to a longer format. Starting in December 2016, all new -// volumes and snapshots will be created with a 17-character string. Starting in -// April 2016, you will be able to use these longer IDs so you can test your -// systems with the new format. For more information, see Longer EC2 and EBS -// resource IDs (http://aws.amazon.com/ec2/faqs/#longer-ids). For example, a volume -// Amazon Resource Name (ARN) with the longer volume ID format looks like the -// following: -// arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG. -// A snapshot ID with the longer ID format looks like the following: -// snap-78e226633445566ee. For more information, see Announcement: Heads-up – -// Longer Storage Gateway volume and snapshot IDs coming in 2016 -// (http://forums.aws.amazon.com/ann.jspa?annID=3557). +// Storage Gateway resource IDs are in uppercase. When you use these resource IDs +// with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change +// your resource ID to lowercase to use it with the EC2 API. For example, in +// Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670 . When you +// use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670 . +// Otherwise, the EC2 API might not behave as expected. IDs for Storage Gateway +// volumes and Amazon EBS snapshots created from gateway volumes are changing to a +// longer format. Starting in December 2016, all new volumes and snapshots will be +// created with a 17-character string. Starting in April 2016, you will be able to +// use these longer IDs so you can test your systems with the new format. For more +// information, see Longer EC2 and EBS resource IDs (http://aws.amazon.com/ec2/faqs/#longer-ids) +// . For example, a volume Amazon Resource Name (ARN) with the longer volume ID +// format looks like the following: +// arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG +// . A snapshot ID with the longer ID format looks like the following: +// snap-78e226633445566ee . For more information, see Announcement: Heads-up – +// Longer Storage Gateway volume and snapshot IDs coming in 2016 (http://forums.aws.amazon.com/ann.jspa?annID=3557) +// . package storagegateway diff --git a/service/storagegateway/types/enums.go b/service/storagegateway/types/enums.go index 137d66c354f..a5c91efce72 100644 --- a/service/storagegateway/types/enums.go +++ b/service/storagegateway/types/enums.go @@ -15,8 +15,8 @@ const ( ActiveDirectoryStatusUnknownError ActiveDirectoryStatus = "UNKNOWN_ERROR" ) -// Values returns all known values for ActiveDirectoryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ActiveDirectoryStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ActiveDirectoryStatus) Values() []ActiveDirectoryStatus { return []ActiveDirectoryStatus{ @@ -137,9 +137,9 @@ const ( ErrorCodeVolumeNotReady ErrorCode = "VolumeNotReady" ) -// Values returns all known values for ErrorCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ErrorCode. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ErrorCode) Values() []ErrorCode { return []ErrorCode{ "ActivationKeyExpired", @@ -284,9 +284,9 @@ const ( ObjectACLAwsExecRead ObjectACL = "aws-exec-read" ) -// Values returns all known values for ObjectACL. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ObjectACL. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ObjectACL) Values() []ObjectACL { return []ObjectACL{ "private", diff --git a/service/storagegateway/types/types.go b/service/storagegateway/types/types.go index 3c0d269a81c..a03357c1326 100644 --- a/service/storagegateway/types/types.go +++ b/service/storagegateway/types/types.go @@ -16,8 +16,8 @@ type AutomaticTapeCreationPolicyInfo struct { // create new tapes. AutomaticTapeCreationRules []AutomaticTapeCreationRule - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string noSmithyDocumentSerde @@ -25,16 +25,16 @@ type AutomaticTapeCreationPolicyInfo struct { // An automatic tape creation policy consists of automatic tape creation rules // where each rule defines when and how to create new tapes. For more information -// about automatic tape creation, see Creating Tapes Automatically -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically). +// about automatic tape creation, see Creating Tapes Automatically (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically) +// . type AutomaticTapeCreationRule struct { // The minimum number of available virtual tapes that the gateway maintains at all // times. If the number of tapes on the gateway goes below this value, the gateway // creates as many new tapes as are needed to have MinimumNumTapes on the gateway. // For more information about automatic tape creation, see Creating Tapes - // Automatically - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically). + // Automatically (https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically) + // . // // This member is required. MinimumNumTapes *int32 @@ -74,9 +74,9 @@ type AutomaticTapeCreationRule struct { // both. type BandwidthRateLimitInterval struct { - // The days of the week component of the bandwidth rate limit interval, represented - // as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents - // Saturday. + // The days of the week component of the bandwidth rate limit interval, + // represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 + // represents Saturday. // // This member is required. DaysOfWeek []int32 @@ -88,7 +88,7 @@ type BandwidthRateLimitInterval struct { // The minute of the hour to end the bandwidth rate limit interval. The bandwidth // rate limit interval ends at the end of the minute. To end an interval at the end - // of an hour, use the value 59. + // of an hour, use the value 59 . // // This member is required. EndMinuteOfHour *int32 @@ -100,7 +100,7 @@ type BandwidthRateLimitInterval struct { // The minute of the hour to start the bandwidth rate limit interval. The interval // begins at the start of that minute. To begin an interval exactly at the start of - // the hour, use the value 0. + // the hour, use the value 0 . // // This member is required. StartMinuteOfHour *int32 @@ -110,9 +110,9 @@ type BandwidthRateLimitInterval struct { // rate limit is not set. AverageDownloadRateLimitInBitsPerSec *int64 - // The average upload rate limit component of the bandwidth rate limit interval, in - // bits per second. This field does not appear in the response if the upload rate - // limit is not set. + // The average upload rate limit component of the bandwidth rate limit interval, + // in bits per second. This field does not appear in the response if the upload + // rate limit is not set. AverageUploadRateLimitInBitsPerSec *int64 noSmithyDocumentSerde @@ -121,9 +121,9 @@ type BandwidthRateLimitInterval struct { // The refresh cache information for the file share or FSx file systems. type CacheAttributes struct { - // Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of - // time since the last refresh after which access to the directory would cause the - // file gateway to first refresh that directory's contents from the Amazon S3 + // Refreshes a file share's cache by using Time To Live (TTL). TTL is the length + // of time since the last refresh after which access to the directory would cause + // the file gateway to first refresh that directory's contents from the Amazon S3 // bucket or Amazon FSx file system. The TTL duration is in seconds. Valid // Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days) CacheStaleTimeoutInSeconds *int32 @@ -138,9 +138,9 @@ type CachediSCSIVolume struct { // have this timestamp. CreatedDate *time.Time - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // If the cached volume was created from a snapshot, this field contains the @@ -150,8 +150,8 @@ type CachediSCSIVolume struct { // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway. If you don't + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume + // . The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. TargetName *string @@ -160,8 +160,8 @@ type CachediSCSIVolume struct { VolumeARN *string // A value that indicates whether a storage volume is attached to or detached from - // a gateway. For more information, see Moving your volumes to a different gateway - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). + // a gateway. For more information, see Moving your volumes to a different gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume) + // . VolumeAttachmentStatus *string // The unique identifier of the volume, e.g., vol-AE4B946D. @@ -194,8 +194,8 @@ type CachediSCSIVolume struct { // compress the data to a negligible amount of actual storage. VolumeUsedInBytes *int64 - // An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes - // for one stored volume. + // An VolumeiSCSIAttributes object that represents a collection of iSCSI + // attributes for one stored volume. VolumeiSCSIAttributes *VolumeiSCSIAttributes noSmithyDocumentSerde @@ -208,8 +208,8 @@ type ChapInfo struct { // The iSCSI initiator that connects to the target. InitiatorName *string - // The secret key that the initiator (for example, the Windows client) must provide - // to participate in mutual CHAP with the target. + // The secret key that the initiator (for example, the Windows client) must + // provide to participate in mutual CHAP with the target. SecretToAuthenticateInitiator *string // The secret key that the target must provide to participate in mutual CHAP with @@ -235,8 +235,8 @@ type DeviceiSCSIAttributes struct { // The port used to communicate with iSCSI VTL device targets. NetworkInterfacePort int32 - // Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified - // name(iqn) of a tape drive or media changer target. + // Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI + // qualified name(iqn) of a tape drive or media changer target. TargetARN *string noSmithyDocumentSerde @@ -279,9 +279,9 @@ type Disk struct { // Amazon FSx file system. type EndpointNetworkConfiguration struct { - // A list of gateway IP addresses on which the associated Amazon FSx file system is - // available. If multiple file systems are associated with this gateway, this field - // is required. + // A list of gateway IP addresses on which the associated Amazon FSx file system + // is available. If multiple file systems are associated with this gateway, this + // field is required. IpAddresses []string noSmithyDocumentSerde @@ -303,15 +303,15 @@ type FileShareInfo struct { // The type of the file share. FileShareType FileShareType - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string noSmithyDocumentSerde } -// Describes the object returned by DescribeFileSystemAssociations that describes a -// created file system association. +// Describes the object returned by DescribeFileSystemAssociations that describes +// a created file system association. type FileSystemAssociationInfo struct { // The Amazon Resource Name (ARN) of the storage used for the audit logs. @@ -336,18 +336,17 @@ type FileSystemAssociationInfo struct { // provides detailed information on file system association status. FileSystemAssociationStatusDetails []FileSystemAssociationStatusDetail - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The ARN of the backend Amazon FSx file system used for storing file data. For - // information, see FileSystem - // (https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html) in the - // Amazon FSx API Reference. + // information, see FileSystem (https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html) + // in the Amazon FSx API Reference. LocationARN *string - // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by - // key name. Each tag is a key-value pair. + // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically + // by key name. Each tag is a key-value pair. Tags []Tag noSmithyDocumentSerde @@ -362,7 +361,7 @@ type FileSystemAssociationStatusDetail struct { noSmithyDocumentSerde } -// Gets the summary returned by ListFileSystemAssociation, which is a summary of a +// Gets the summary returned by ListFileSystemAssociation , which is a summary of a // created file system association. type FileSystemAssociationSummary struct { @@ -376,8 +375,8 @@ type FileSystemAssociationSummary struct { // FORCE_DELETING | UPDATING | ERROR FileSystemAssociationStatus *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string noSmithyDocumentSerde @@ -392,8 +391,8 @@ type GatewayInfo struct { // The Amazon Web Services Region where the Amazon EC2 instance is located. Ec2InstanceRegion *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The unique identifier assigned to your gateway during activation. This ID @@ -438,28 +437,28 @@ type NetworkInterface struct { noSmithyDocumentSerde } -// Describes Network File System (NFS) file share default values. Files and folders -// stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file -// permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, -// the S3 objects that represent files and folders are assigned these default Unix -// permissions. This operation is only supported for S3 File Gateways. +// Describes Network File System (NFS) file share default values. Files and +// folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix +// file permissions assigned to them. Upon discovery in an S3 bucket by Storage +// Gateway, the S3 objects that represent files and folders are assigned these +// default Unix permissions. This operation is only supported for S3 File Gateways. type NFSFileShareDefaults struct { // The Unix directory mode in the form "nnnn". For example, 0666 represents the // default access mode for all directories inside the file share. The default value - // is 0777. + // is 0777 . DirectoryMode *string // The Unix file mode in the form "nnnn". For example, 0666 represents the default - // file mode inside the file share. The default value is 0666. + // file mode inside the file share. The default value is 0666 . FileMode *string // The default group ID for the file share (unless the files have another group ID - // specified). The default value is nfsnobody. + // specified). The default value is nfsnobody . GroupId *int64 // The default owner ID for files in the file share (unless the files have another - // owner ID specified). The default value is nfsnobody. + // owner ID specified). The default value is nfsnobody . OwnerId *int64 noSmithyDocumentSerde @@ -487,7 +486,7 @@ type NFSFileShareInfo struct { ClientList []string // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string @@ -498,29 +497,29 @@ type NFSFileShareInfo struct { FileShareId *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | // DELETING FileShareStatus *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // A custom ARN for the backend storage used for storing data for file shares. It @@ -531,17 +530,16 @@ type NFSFileShareInfo struct { // arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you // specify an access point, the bucket policy must be configured to delegate access // control to the access point. For information, see Delegating access control to - // access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) + // access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) // in the Amazon S3 User Guide. Access point alias: // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias LocationARN *string - // Describes Network File System (NFS) file share default values. Files and folders - // stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file - // permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, - // the S3 objects that represent files and folders are assigned these default Unix - // permissions. This operation is only supported for S3 File Gateways. + // Describes Network File System (NFS) file share default values. Files and + // folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix + // file permissions assigned to them. Upon discovery in an S3 bucket by Storage + // Gateway, the S3 objects that represent files and folders are assigned these + // default Unix permissions. This operation is only supported for S3 File Gateways. NFSFileShareDefaults *NFSFileShareDefaults // The notification policy of the file share. SettlingTimeInSeconds controls the @@ -556,25 +554,26 @@ type NFSFileShareInfo struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that an S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that an S3 File Gateway puts objects into. The default value is + // private . ObjectACL ObjectACL // The file share path used by the NFS client to identify the mount point. Path *string // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false. Valid Values: true | - // false + // set the write status to read-only, otherwise set to false . Valid Values: true + // | false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // The ARN of the IAM role that an S3 File Gateway assumes when it accesses the @@ -582,18 +581,13 @@ type NFSFileShareInfo struct { Role *string // The user mapped to anonymous user. Valid options are the following: - // - // * - // RootSquash: Only root is mapped to anonymous user. - // - // * NoSquash: No one is mapped - // to anonymous user. - // - // * AllSquash: Everyone is mapped to anonymous user. + // - RootSquash : Only root is mapped to anonymous user. + // - NoSquash : No one is mapped to anonymous user. + // - AllSquash : Everyone is mapped to anonymous user. Squash *string - // A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by - // key name. Each tag is a key-value pair. For a gateway with more than 10 tags + // A list of up to 50 tags assigned to the NFS file share, sorted alphabetically + // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags // assigned, you can view all tags using the ListTagsForResource API operation. Tags []Tag @@ -618,7 +612,7 @@ type PoolInfo struct { // '/' and '\'. PoolName *string - // Status of the custom tape pool. Pool can be ACTIVE or DELETED. + // Status of the custom tape pool. Pool can be ACTIVE or DELETED . PoolStatus PoolStatus // Tape retention lock time is set in days. Tape retention lock can be enabled for @@ -649,16 +643,16 @@ type SMBFileShareInfo struct { // Indicates whether AccessBasedEnumeration is enabled. AccessBasedEnumeration *bool - // A list of users or groups in the Active Directory that have administrator rights - // to the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that have administrator + // rights to the file share. A group must be prefixed with the @ character. + // Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 + // . Can only be set if Authentication is set to ActiveDirectory . AdminUserList []string // The Amazon Resource Name (ARN) of the storage used for audit logs. AuditDestinationARN *string - // The authentication method of the file share. The default is ActiveDirectory. + // The authentication method of the file share. The default is ActiveDirectory . // Valid Values: ActiveDirectory | GuestAccess Authentication *string @@ -671,13 +665,13 @@ type SMBFileShareInfo struct { // Refresh cache information for the file share. CacheAttributes *CacheAttributes - // The case of an object name in an Amazon S3 bucket. For ClientSpecified, the - // client determines the case sensitivity. For CaseSensitive, the gateway - // determines the case sensitivity. The default value is ClientSpecified. + // The case of an object name in an Amazon S3 bucket. For ClientSpecified , the + // client determines the case sensitivity. For CaseSensitive , the gateway + // determines the case sensitivity. The default value is ClientSpecified . CaseSensitivity CaseSensitivity // The default storage class for objects put into an Amazon S3 bucket by the S3 - // File Gateway. The default value is S3_STANDARD. Optional. Valid Values: + // File Gateway. The default value is S3_STANDARD . Optional. Valid Values: // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string @@ -688,35 +682,35 @@ type SMBFileShareInfo struct { FileShareId *string // The name of the file share. Optional. FileShareName must be set if an S3 prefix - // name is set in LocationARN, or if an access point or access point alias is used. + // name is set in LocationARN , or if an access point or access point alias is used. FileShareName *string // The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | // DELETING FileShareStatus *string - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // A value that enables guessing of the MIME type for uploaded objects based on // file extensions. Set this value to true to enable MIME type guessing, otherwise - // set to false. The default value is true. Valid Values: true | false + // set to false . The default value is true . Valid Values: true | false GuessMIMETypeEnabled *bool - // A list of users or groups in the Active Directory that are not allowed to access - // the file share. A group must be prefixed with the @ character. Acceptable - // formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be - // set if Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are not allowed to + // access the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . InvalidUserList []string // Set to true to use Amazon S3 server-side encryption with your own KMS key, or // false to use a key managed by Amazon S3. Optional. Valid Values: true | false KMSEncrypted bool - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // A custom ARN for the backend storage used for storing data for file shares. It @@ -727,8 +721,7 @@ type SMBFileShareInfo struct { // arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you // specify an access point, the bucket policy must be configured to delegate access // control to the access point. For information, see Delegating access control to - // access points - // (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) + // access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) // in the Amazon S3 User Guide. Access point alias: // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias LocationARN *string @@ -745,8 +738,9 @@ type SMBFileShareInfo struct { // NotificationPolicy off. {} NotificationPolicy *string - // A value that sets the access control list (ACL) permission for objects in the S3 - // bucket that an S3 File Gateway puts objects into. The default value is private. + // A value that sets the access control list (ACL) permission for objects in the + // S3 bucket that an S3 File Gateway puts objects into. The default value is + // private . ObjectACL ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. @@ -759,33 +753,33 @@ type SMBFileShareInfo struct { Path *string // A value that sets the write status of a file share. Set this value to true to - // set the write status to read-only, otherwise set to false. Valid Values: true | - // false + // set the write status to read-only, otherwise set to false . Valid Values: true + // | false ReadOnly *bool // A value that sets who pays the cost of the request and the cost associated with - // data download from the S3 bucket. If this value is set to true, the requester + // data download from the S3 bucket. If this value is set to true , the requester // pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket - // owner always pays the cost of storing data. RequesterPays is a configuration for - // the S3 bucket that backs the file share, so make sure that the configuration on - // the file share is the same as the S3 bucket configuration. Valid Values: true | - // false + // owner always pays the cost of storing data. RequesterPays is a configuration + // for the S3 bucket that backs the file share, so make sure that the configuration + // on the file share is the same as the S3 bucket configuration. Valid Values: true + // | false RequesterPays *bool // The ARN of the IAM role that an S3 File Gateway assumes when it accesses the // underlying storage. Role *string - // If this value is set to true, it indicates that access control list (ACL) is - // enabled on the SMB file share. If it is set to false, it indicates that file and - // directory permissions are mapped to the POSIX permission. For more information, - // see Using Microsoft Windows ACLs to control access to an SMB file share - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in - // the Storage Gateway User Guide. + // If this value is set to true , it indicates that access control list (ACL) is + // enabled on the SMB file share. If it is set to false , it indicates that file + // and directory permissions are mapped to the POSIX permission. For more + // information, see Using Microsoft Windows ACLs to control access to an SMB file + // share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the Storage Gateway User Guide. SMBACLEnabled *bool - // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by - // key name. Each tag is a key-value pair. For a gateway with more than 10 tags + // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically + // by key name. Each tag is a key-value pair. For a gateway with more than 10 tags // assigned, you can view all tags using the ListTagsForResource API operation. Tags []Tag @@ -795,10 +789,10 @@ type SMBFileShareInfo struct { // point alias that points to a VPC access point. VPCEndpointDNSName *string - // A list of users or groups in the Active Directory that are allowed to access the - // file share. A group must be prefixed with the @ character. Acceptable formats - // include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if - // Authentication is set to ActiveDirectory. + // A list of users or groups in the Active Directory that are allowed to access + // the file share. A group must be prefixed with the @ character. Acceptable + // formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only + // be set if Authentication is set to ActiveDirectory . ValidUserList []string noSmithyDocumentSerde @@ -809,16 +803,17 @@ type SMBFileShareInfo struct { type SMBLocalGroups struct { // A list of Active Directory users and groups that have local Gateway Admin - // permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1, and - // group1. Gateway Admins can use the Shared Folders Microsoft Management Console - // snap-in to force-close files that are open and locked. + // permissions. Acceptable formats include: DOMAIN\User1 , user1 , DOMAIN\group1 , + // and group1 . Gateway Admins can use the Shared Folders Microsoft Management + // Console snap-in to force-close files that are open and locked. GatewayAdmins []string noSmithyDocumentSerde } -// Provides additional information about an error that was returned by the service. -// See the errorCode and errorDetails members for more information about the error. +// Provides additional information about an error that was returned by the +// service. See the errorCode and errorDetails members for more information about +// the error. type StorageGatewayError struct { // Additional information about the error. @@ -837,13 +832,13 @@ type StorediSCSIVolume struct { // have this timestamp. CreatedDate *time.Time - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string - // Indicates if when the stored volume was created, existing data on the underlying - // local disk was preserved. Valid Values: true | false + // Indicates if when the stored volume was created, existing data on the + // underlying local disk was preserved. Valid Values: true | false PreservedExistingData bool // If the stored volume was created from a snapshot, this field contains the @@ -853,8 +848,8 @@ type StorediSCSIVolume struct { // The name of the iSCSI target used by an initiator to connect to a volume and // used as a suffix for the target ARN. For example, specifying TargetName as // myvolume results in the target ARN of - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. - // The target name must be unique across all volumes on a gateway. If you don't + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume + // . The target name must be unique across all volumes on a gateway. If you don't // specify a value, Storage Gateway uses the value that was previously used for // this volume as the new target name. TargetName *string @@ -864,8 +859,8 @@ type StorediSCSIVolume struct { // A value that indicates whether a storage volume is attached to, detached from, // or is in the process of detaching from a gateway. For more information, see - // Moving your volumes to a different gateway - // (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). + // Moving your volumes to a different gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume) + // . VolumeAttachmentStatus *string // The ID of the local disk that was specified in the CreateStorediSCSIVolume @@ -898,8 +893,8 @@ type StorediSCSIVolume struct { // until you store data on the volume. VolumeUsedInBytes *int64 - // An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes - // for one stored volume. + // An VolumeiSCSIAttributes object that represents a collection of iSCSI + // attributes for one stored volume. VolumeiSCSIAttributes *VolumeiSCSIAttributes noSmithyDocumentSerde @@ -926,9 +921,9 @@ type Tag struct { // Describes a virtual tape object. type Tape struct { - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The date that the tape enters a custom tape pool. @@ -970,7 +965,7 @@ type Tape struct { // The virtual tape library (VTL) device that the virtual tape is associated with. VTLDevice *string - // If the tape is archived as write-once-read-many (WORM), this value is true. + // If the tape is archived as write-once-read-many (WORM), this value is true . Worm bool noSmithyDocumentSerde @@ -983,17 +978,17 @@ type TapeArchive struct { // timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. CompletionTime *time.Time - // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for - // Amazon S3 server-side encryption. Storage Gateway does not support asymmetric - // CMKs. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support + // asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional. KMSKey *string // The time that the tape entered the custom tape pool. The default timestamp // format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. PoolEntryDate *time.Time - // The ID of the pool that was used to archive the tape. The tapes in this pool are - // archived in the S3 storage class that is associated with the pool. + // The ID of the pool that was used to archive the tape. The tapes in this pool + // are archived in the S3 storage class that is associated with the pool. PoolId *string // If the archived tape is subject to tape retention lock, the date that the @@ -1033,8 +1028,8 @@ type TapeArchive struct { // Describes a virtual tape. type TapeInfo struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The date that the tape entered the custom tape pool with tape retention lock @@ -1089,8 +1084,8 @@ type TapeRecoveryPointInfo struct { // Describes a storage volume object. type VolumeInfo struct { - // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to - // return a list of gateways for your account and Amazon Web Services Region. + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. GatewayARN *string // The unique identifier assigned to your gateway during activation. This ID @@ -1109,9 +1104,10 @@ type VolumeInfo struct { // One of the VolumeStatus values that indicates the state of the storage volume. VolumeAttachmentStatus *string - // The unique identifier assigned to the volume. This ID becomes part of the volume - // Amazon Resource Name (ARN), which you use as input for other operations. Valid - // Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). + // The unique identifier assigned to the volume. This ID becomes part of the + // volume Amazon Resource Name (ARN), which you use as input for other operations. + // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens + // (-). VolumeId *string // The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, diff --git a/service/sts/api_client.go b/service/sts/api_client.go index 3041fc467e7..78eb2670202 100644 --- a/service/sts/api_client.go +++ b/service/sts/api_client.go @@ -117,7 +117,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/sts/api_op_AssumeRole.go b/service/sts/api_op_AssumeRole.go index 4cbb046b62b..99d74625d04 100644 --- a/service/sts/api_op_AssumeRole.go +++ b/service/sts/api_op_AssumeRole.go @@ -16,16 +16,13 @@ import ( // key ID, a secret access key, and a security token. Typically, you use AssumeRole // within your account or for cross-account access. For a comparison of AssumeRole // with other API operations that produce temporary credentials, see Requesting -// Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) -// and Comparing the Amazon Web Services STS API operations -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) +// Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) +// and Comparing the Amazon Web Services STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) // in the IAM User Guide. Permissions The temporary security credentials created by -// AssumeRole can be used to make API calls to any Amazon Web Services service with -// the following exception: You cannot call the Amazon Web Services STS +// AssumeRole can be used to make API calls to any Amazon Web Services service +// with the following exception: You cannot call the Amazon Web Services STS // GetFederationToken or GetSessionToken API operations. (Optional) You can pass -// inline or managed session policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. The plaintext that you @@ -36,8 +33,7 @@ import ( // credentials in subsequent Amazon Web Services API calls to access resources in // the account that owns the role. You cannot use session policies to grant more // permissions than those allowed by the identity-based policy of the role that is -// being assumed. For more information, see Session Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// being assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. When you create a role, you create two policies: A role // trust policy that specifies who can assume the role and a permissions policy // that specifies what can be done with the role. You specify the trusted principal @@ -48,37 +44,29 @@ import ( // that access to users in the account. A user who wants to access a role in a // different account must also have permissions that are delegated from the user // account administrator. The administrator must attach a policy that allows the -// user to call AssumeRole for the ARN of the role in the other account. To allow a -// user to assume a role in the same account, you can do either of the -// following: +// user to call AssumeRole for the ARN of the role in the other account. To allow +// a user to assume a role in the same account, you can do either of the following: // -// * Attach a policy to the user that allows the user to call -// AssumeRole (as long as the role's trust policy trusts the account). +// - Attach a policy to the user that allows the user to call AssumeRole (as long +// as the role's trust policy trusts the account). +// - Add the user as a principal directly in the role's trust policy. // -// * Add the -// user as a principal directly in the role's trust policy. -// -// You can do either -// because the role’s trust policy acts as an IAM resource-based policy. When a -// resource-based policy grants access to a principal in the same account, no -// additional identity-based policy is required. For more information about trust -// policies and resource-based policies, see IAM Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) in the -// IAM User Guide. Tags (Optional) You can pass tag key-value pairs to your +// You can do either because the role’s trust policy acts as an IAM resource-based +// policy. When a resource-based policy grants access to a principal in the same +// account, no additional identity-based policy is required. For more information +// about trust policies and resource-based policies, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) +// in the IAM User Guide. Tags (Optional) You can pass tag key-value pairs to your // session. These tags are called session tags. For more information about session -// tags, see Passing Session Tags in STS -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. An administrator must grant you the permissions necessary to -// pass session tags. The administrator can also create granular permissions to +// tags, see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. An administrator must grant you the permissions necessary +// to pass session tags. The administrator can also create granular permissions to // allow you to pass only specific session tags. For more information, see -// Tutorial: Using Tags for Attribute-Based Access Control -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) +// Tutorial: Using Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) // in the IAM User Guide. You can set the session tags as transitive. Transitive -// tags persist during role chaining. For more information, see Chaining Roles with -// Session Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) +// tags persist during role chaining. For more information, see Chaining Roles +// with Session Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) // in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include -// multi-factor authentication (MFA) information when you call AssumeRole. This is +// multi-factor authentication (MFA) information when you call AssumeRole . This is // useful for cross-account scenarios to ensure that the user that assumes the role // has been authenticated with an Amazon Web Services MFA device. In that scenario, // the trust policy of the role being assumed includes a condition that tests for @@ -86,12 +74,11 @@ import ( // request to assume the role is denied. The condition in a trust policy that tests // for MFA authentication might look like the following example. "Condition": // {"Bool": {"aws:MultiFactorAuthPresent": true}} For more information, see -// Configuring MFA-Protected API Access -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html) in the -// IAM User Guide guide. To use MFA with AssumeRole, you pass values for the -// SerialNumber and TokenCode parameters. The SerialNumber value identifies the -// user's hardware or virtual MFA device. The TokenCode is the time-based one-time -// password (TOTP) that the MFA device produces. +// Configuring MFA-Protected API Access (https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html) +// in the IAM User Guide guide. To use MFA with AssumeRole , you pass values for +// the SerialNumber and TokenCode parameters. The SerialNumber value identifies +// the user's hardware or virtual MFA device. The TokenCode is the time-based +// one-time password (TOTP) that the MFA device produces. func (c *Client) AssumeRole(ctx context.Context, params *AssumeRoleInput, optFns ...func(*Options)) (*AssumeRoleOutput, error) { if params == nil { params = &AssumeRoleInput{} @@ -143,16 +130,14 @@ type AssumeRoleInput struct { // maximum session duration setting for your role. However, if you assume a role // using role chaining and provide a DurationSeconds parameter value greater than // one hour, the operation fails. To learn how to view the maximum value for your - // role, see View the Maximum Session Duration Setting for a Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) + // role, see View the Maximum Session Duration Setting for a Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) // in the IAM User Guide. By default, the value is set to 3600 seconds. The // DurationSeconds parameter is separate from the duration of a console session // that you might request using the returned credentials. The request to the // federation endpoint for a console sign-in token takes a SessionDuration // parameter that specifies the maximum length of the console session. For more // information, see Creating a URL that Enables Federated Users to Access the - // Amazon Web Services Management Console - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) + // Amazon Web Services Management Console (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) // in the IAM User Guide. DurationSeconds *int32 @@ -165,8 +150,7 @@ type AssumeRoleInput struct { // administrator of the trusted account. That way, only someone with the ID can // assume the role, rather than everyone in the account. For more information about // the external ID, see How to Use an External ID When Granting Access to Your - // Amazon Web Services Resources to a Third Party - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) + // Amazon Web Services Resources to a Third Party (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) // in the IAM User Guide. The regex used to validate this parameter is a string of // characters consisting of upper- and lower-case alphanumeric characters with no // spaces. You can also include underscores or any of the following characters: @@ -181,8 +165,7 @@ type AssumeRoleInput struct { // access resources in the account that owns the role. You cannot use session // policies to grant more permissions than those allowed by the identity-based // policy of the role that is being assumed. For more information, see Session - // Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. The plaintext that you use for both inline and managed // session policies can't exceed 2,048 characters. The JSON policy characters can // be any ASCII character from the space character to the end of the valid @@ -200,9 +183,8 @@ type AssumeRoleInput struct { // the role. This parameter is optional. You can provide up to 10 managed policy // ARNs. However, the plaintext that you use for both inline and managed session // policies can't exceed 2,048 characters. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. An Amazon Web Services conversion + // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. An Amazon Web Services conversion // compresses the passed inline session policy, managed policy ARNs, and session // tags into a packed binary format that has a separate limit. Your request can // fail for this limit even if your plaintext meets the other requirements. The @@ -214,17 +196,16 @@ type AssumeRoleInput struct { // Services API calls to access resources in the account that owns the role. You // cannot use session policies to grant more permissions than those allowed by the // identity-based policy of the role that is being assumed. For more information, - // see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []types.PolicyDescriptorType - // The identification number of the MFA device that is associated with the user who - // is making the AssumeRole call. Specify this value if the trust policy of the - // role being assumed includes a condition that requires MFA authentication. The - // value is either the serial number for a hardware device (such as GAHT12345678) - // or an Amazon Resource Name (ARN) for a virtual device (such as - // arn:aws:iam::123456789012:mfa/user). The regex used to validate this parameter + // The identification number of the MFA device that is associated with the user + // who is making the AssumeRole call. Specify this value if the trust policy of + // the role being assumed includes a condition that requires MFA authentication. + // The value is either the serial number for a hardware device (such as + // GAHT12345678 ) or an Amazon Resource Name (ARN) for a virtual device (such as + // arn:aws:iam::123456789012:mfa/user ). The regex used to validate this parameter // is a string of characters consisting of upper- and lower-case alphanumeric // characters with no spaces. You can also include underscores or any of the // following characters: =,.@- @@ -237,24 +218,21 @@ type AssumeRoleInput struct { // who took actions with a role. You can use the aws:SourceIdentity condition key // to further control access to Amazon Web Services resources based on the value of // source identity. For more information about using source identity, see Monitor - // and control actions taken with assumed roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // and control actions taken with assumed roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) // in the IAM User Guide. The regex used to validate this parameter is a string of // characters consisting of upper- and lower-case alphanumeric characters with no // spaces. You can also include underscores or any of the following characters: - // =,.@-. You cannot use a value that begins with the text aws:. This prefix is + // =,.@-. You cannot use a value that begins with the text aws: . This prefix is // reserved for Amazon Web Services internal use. SourceIdentity *string - // A list of session tags that you want to pass. Each session tag consists of a key - // name and an associated value. For more information about session tags, see - // Tagging Amazon Web Services STS Sessions - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the - // IAM User Guide. This parameter is optional. You can pass up to 50 session tags. - // The plaintext session tag keys can’t exceed 128 characters, and the values can’t - // exceed 256 characters. For these and additional limits, see IAM and STS - // Character Limits - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) + // A list of session tags that you want to pass. Each session tag consists of a + // key name and an associated value. For more information about session tags, see + // Tagging Amazon Web Services STS Sessions (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) + // in the IAM User Guide. This parameter is optional. You can pass up to 50 session + // tags. The plaintext session tag keys can’t exceed 128 characters, and the values + // can’t exceed 256 characters. For these and additional limits, see IAM and STS + // Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. An Amazon Web Services conversion compresses the passed // inline session policy, managed policy ARNs, and session tags into a packed // binary format that has a separate limit. Your request can fail for this limit @@ -264,16 +242,15 @@ type AssumeRoleInput struct { // same key as a tag that is already attached to the role. When you do, session // tags override a role tag with the same key. Tag key–value pairs are not case // sensitive, but case is preserved. This means that you cannot have separate - // Department and department tag keys. Assume that the role has the - // Department=Marketing tag and you pass the department=engineering session tag. - // Department and department are not saved as separate tags, and the session tag - // passed in the request takes precedence over the role tag. Additionally, if you - // used temporary credentials to perform this operation, the new session inherits - // any transitive session tags from the calling session. If you pass a session tag - // with the same key as an inherited tag, the operation fails. To view the - // inherited tags for a session, see the CloudTrail logs. For more information, see - // Viewing Session Tags in CloudTrail - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs) + // Department and department tag keys. Assume that the role has the Department = + // Marketing tag and you pass the department = engineering session tag. Department + // and department are not saved as separate tags, and the session tag passed in + // the request takes precedence over the role tag. Additionally, if you used + // temporary credentials to perform this operation, the new session inherits any + // transitive session tags from the calling session. If you pass a session tag with + // the same key as an inherited tag, the operation fails. To view the inherited + // tags for a session, see the CloudTrail logs. For more information, see Viewing + // Session Tags in CloudTrail (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs) // in the IAM User Guide. Tags []types.Tag @@ -285,11 +262,10 @@ type AssumeRoleInput struct { // sequence of six numeric digits. TokenCode *string - // A list of keys for session tags that you want to set as transitive. If you set a - // tag key as transitive, the corresponding key and value passes to subsequent + // A list of keys for session tags that you want to set as transitive. If you set + // a tag key as transitive, the corresponding key and value passes to subsequent // sessions in a role chain. For more information, see Chaining Roles with Session - // Tags - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) + // Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) // in the IAM User Guide. This parameter is optional. When you set session tags as // transitive, the session policy and session tags packed binary limit is not // affected. If you choose not to specify a transitive tag key, then no tags are @@ -308,7 +284,7 @@ type AssumeRoleOutput struct { // that you can use to refer to the resulting temporary security credentials. For // example, you can reference these credentials as a principal in a resource-based // policy by using the ARN or assumed role ID. The ARN and ID include the - // RoleSessionName that you specified when you called AssumeRole. + // RoleSessionName that you specified when you called AssumeRole . AssumedRoleUser *types.AssumedRoleUser // The temporary security credentials, which include an access key ID, a secret @@ -330,8 +306,7 @@ type AssumeRoleOutput struct { // who took actions with a role. You can use the aws:SourceIdentity condition key // to further control access to Amazon Web Services resources based on the value of // source identity. For more information about using source identity, see Monitor - // and control actions taken with assumed roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // and control actions taken with assumed roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) // in the IAM User Guide. The regex used to validate this parameter is a string of // characters consisting of upper- and lower-case alphanumeric characters with no // spaces. You can also include underscores or any of the following characters: diff --git a/service/sts/api_op_AssumeRoleWithSAML.go b/service/sts/api_op_AssumeRoleWithSAML.go index 4ed0f5d07f8..4c62d77e314 100644 --- a/service/sts/api_op_AssumeRoleWithSAML.go +++ b/service/sts/api_op_AssumeRoleWithSAML.go @@ -15,10 +15,8 @@ import ( // mechanism for tying an enterprise identity store or directory to role-based // Amazon Web Services access without user-specific credentials or configuration. // For a comparison of AssumeRoleWithSAML with the other API operations that -// produce temporary credentials, see Requesting Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) -// and Comparing the Amazon Web Services STS API operations -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) +// produce temporary credentials, see Requesting Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) +// and Comparing the Amazon Web Services STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) // in the IAM User Guide. The temporary security credentials returned by this // operation consist of an access key ID, a secret access key, and a security // token. Applications can use these temporary security credentials to sign calls @@ -31,15 +29,12 @@ import ( // DurationSeconds value from 900 seconds (15 minutes) up to the maximum session // duration setting for the role. This setting can have a value from 1 hour to 12 // hours. To learn how to view the maximum value for your role, see View the -// Maximum Session Duration Setting for a Role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) +// Maximum Session Duration Setting for a Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) // in the IAM User Guide. The maximum session duration limit applies when you use // the AssumeRole* API operations or the assume-role* CLI commands. However the // limit does not apply when you use those operations to create a console URL. For -// more information, see Using IAM Roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM -// User Guide. Role chaining -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining) +// more information, see Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) +// in the IAM User Guide. Role chaining (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining) // limits your CLI or Amazon Web Services API role session to a maximum of one // hour. When you use the AssumeRole API operation to assume a role, you can // specify the duration of your role session with the DurationSeconds parameter. @@ -50,8 +45,7 @@ import ( // credentials created by AssumeRoleWithSAML can be used to make API calls to any // Amazon Web Services service with the following exception: you cannot call the // STS GetFederationToken or GetSessionToken API operations. (Optional) You can -// pass inline or managed session policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// pass inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. The plaintext that you @@ -62,8 +56,7 @@ import ( // credentials in subsequent Amazon Web Services API calls to access resources in // the account that owns the role. You cannot use session policies to grant more // permissions than those allowed by the identity-based policy of the role that is -// being assumed. For more information, see Session Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// being assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. Calling AssumeRoleWithSAML does not require the use of // Amazon Web Services security credentials. The identity of the caller is // validated by using keys in the metadata document that is uploaded for the SAML @@ -71,16 +64,14 @@ import ( // result in an entry in your CloudTrail logs. The entry includes the value in the // NameID element of the SAML assertion. We recommend that you use a NameIDType // that is not associated with any personally identifiable information (PII). For -// example, you could instead use the persistent identifier -// (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). Tags (Optional) You can +// example, you could instead use the persistent identifier ( +// urn:oasis:names:tc:SAML:2.0:nameid-format:persistent ). Tags (Optional) You can // configure your IdP to pass attributes into your SAML assertion as session tags. // Each session tag consists of a key name and an associated value. For more -// information about session tags, see Passing Session Tags in STS -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. You can pass up to 50 session tags. The plaintext session tag -// keys can’t exceed 128 characters and the values can’t exceed 256 characters. For -// these and additional limits, see IAM and STS Character Limits -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) +// information about session tags, see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. You can pass up to 50 session tags. The plaintext session +// tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. +// For these and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. An Amazon Web Services conversion compresses the passed // inline session policy, managed policy ARNs, and session tags into a packed // binary format that has a separate limit. Your request can fail for this limit @@ -91,36 +82,25 @@ import ( // override the role's tags with the same key. An administrator must grant you the // permissions necessary to pass session tags. The administrator can also create // granular permissions to allow you to pass only specific session tags. For more -// information, see Tutorial: Using Tags for Attribute-Based Access Control -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) +// information, see Tutorial: Using Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) // in the IAM User Guide. You can set the session tags as transitive. Transitive -// tags persist during role chaining. For more information, see Chaining Roles with -// Session Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) +// tags persist during role chaining. For more information, see Chaining Roles +// with Session Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) // in the IAM User Guide. SAML Configuration Before your application can call -// AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to +// AssumeRoleWithSAML , you must configure your SAML identity provider (IdP) to // issue the claims required by Amazon Web Services. Additionally, you must use // Identity and Access Management (IAM) to create a SAML provider entity in your // Amazon Web Services account that represents your identity provider. You must // also create an IAM role that specifies this SAML provider in its trust policy. // For more information, see the following resources: -// -// * About SAML 2.0-based -// Federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) -// in the IAM User Guide. -// -// * Creating SAML Identity Providers -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) -// in the IAM User Guide. -// -// * Configuring a Relying Party and Claims -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html) -// in the IAM User Guide. -// -// * Creating a Role for SAML 2.0 Federation -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html) -// in the IAM User Guide. +// - About SAML 2.0-based Federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) +// in the IAM User Guide. +// - Creating SAML Identity Providers (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html) +// in the IAM User Guide. +// - Configuring a Relying Party and Claims (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html) +// in the IAM User Guide. +// - Creating a Role for SAML 2.0 Federation (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html) +// in the IAM User Guide. func (c *Client) AssumeRoleWithSAML(ctx context.Context, params *AssumeRoleWithSAMLInput, optFns ...func(*Options)) (*AssumeRoleWithSAMLOutput, error) { if params == nil { params = &AssumeRoleWithSAMLInput{} @@ -150,8 +130,7 @@ type AssumeRoleWithSAMLInput struct { RoleArn *string // The base64 encoded SAML authentication response provided by the IdP. For more - // information, see Configuring a Relying Party and Adding Claims - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html) + // information, see Configuring a Relying Party and Adding Claims (https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html) // in the IAM User Guide. // // This member is required. @@ -166,16 +145,14 @@ type AssumeRoleWithSAMLInput struct { // than this setting, the operation fails. For example, if you specify a session // duration of 12 hours, but your administrator set the maximum session duration to // 6 hours, your operation fails. To learn how to view the maximum value for your - // role, see View the Maximum Session Duration Setting for a Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) + // role, see View the Maximum Session Duration Setting for a Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) // in the IAM User Guide. By default, the value is set to 3600 seconds. The // DurationSeconds parameter is separate from the duration of a console session // that you might request using the returned credentials. The request to the // federation endpoint for a console sign-in token takes a SessionDuration // parameter that specifies the maximum length of the console session. For more // information, see Creating a URL that Enables Federated Users to Access the - // Amazon Web Services Management Console - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) + // Amazon Web Services Management Console (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) // in the IAM User Guide. DurationSeconds *int32 @@ -187,8 +164,7 @@ type AssumeRoleWithSAMLInput struct { // access resources in the account that owns the role. You cannot use session // policies to grant more permissions than those allowed by the identity-based // policy of the role that is being assumed. For more information, see Session - // Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. The plaintext that you use for both inline and managed // session policies can't exceed 2,048 characters. The JSON policy characters can // be any ASCII character from the space character to the end of the valid @@ -206,9 +182,8 @@ type AssumeRoleWithSAMLInput struct { // the role. This parameter is optional. You can provide up to 10 managed policy // ARNs. However, the plaintext that you use for both inline and managed session // policies can't exceed 2,048 characters. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. An Amazon Web Services conversion + // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. An Amazon Web Services conversion // compresses the passed inline session policy, managed policy ARNs, and session // tags into a packed binary format that has a separate limit. Your request can // fail for this limit even if your plaintext meets the other requirements. The @@ -220,8 +195,7 @@ type AssumeRoleWithSAMLInput struct { // Services API calls to access resources in the account that owns the role. You // cannot use session policies to grant more permissions than those allowed by the // identity-based policy of the role that is being assumed. For more information, - // see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []types.PolicyDescriptorType @@ -251,19 +225,12 @@ type AssumeRoleWithSAMLOutput struct { Issuer *string // A hash value based on the concatenation of the following: - // - // * The Issuer response - // value. - // - // * The Amazon Web Services account ID. - // - // * The friendly name (the last - // part of the ARN) of the SAML provider in IAM. - // - // The combination of NameQualifier - // and Subject can be used to uniquely identify a federated user. The following - // pseudocode shows how the hash value is calculated: BASE64 ( SHA1 ( - // "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) ) + // - The Issuer response value. + // - The Amazon Web Services account ID. + // - The friendly name (the last part of the ARN) of the SAML provider in IAM. + // The combination of NameQualifier and Subject can be used to uniquely identify a + // federated user. The following pseudocode shows how the hash value is calculated: + // BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) ) NameQualifier *string // A percentage value that indicates the packed size of the session policies and @@ -272,20 +239,18 @@ type AssumeRoleWithSAMLOutput struct { // allowed space. PackedPolicySize *int32 - // The value in the SourceIdentity attribute in the SAML assertion. You can require - // users to set a source identity value when they assume a role. You do this by - // using the sts:SourceIdentity condition key in a role trust policy. That way, - // actions that are taken with the role are associated with that user. After the - // source identity is set, the value cannot be changed. It is present in the + // The value in the SourceIdentity attribute in the SAML assertion. You can + // require users to set a source identity value when they assume a role. You do + // this by using the sts:SourceIdentity condition key in a role trust policy. That + // way, actions that are taken with the role are associated with that user. After + // the source identity is set, the value cannot be changed. It is present in the // request for all actions that are taken by the role and persists across chained - // role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) + // role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) // sessions. You can configure your SAML identity provider to use an attribute // associated with your users, like user name or email, as the source identity when - // calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML + // calling AssumeRoleWithSAML . You do this by adding an attribute to the SAML // assertion. For more information about using source identity, see Monitor and - // control actions taken with assumed roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // control actions taken with assumed roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) // in the IAM User Guide. The regex used to validate this parameter is a string of // characters consisting of upper- and lower-case alphanumeric characters with no // spaces. You can also include underscores or any of the following characters: @@ -297,10 +262,10 @@ type AssumeRoleWithSAMLOutput struct { // The format of the name ID, as defined by the Format attribute in the NameID // element of the SAML assertion. Typical examples of the format are transient or - // persistent. If the format includes the prefix - // urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, - // urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If - // the format includes any other prefix, the format is returned with no + // persistent . If the format includes the prefix + // urn:oasis:names:tc:SAML:2.0:nameid-format , that prefix is removed. For example, + // urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient . + // If the format includes any other prefix, the format is returned with no // modifications. SubjectType *string diff --git a/service/sts/api_op_AssumeRoleWithWebIdentity.go b/service/sts/api_op_AssumeRoleWithWebIdentity.go index e2ff4ac62e9..870f3a583d7 100644 --- a/service/sts/api_op_AssumeRoleWithWebIdentity.go +++ b/service/sts/api_op_AssumeRoleWithWebIdentity.go @@ -14,19 +14,15 @@ import ( // authenticated in a mobile or web application with a web identity provider. // Example providers include the OAuth 2.0 providers Login with Amazon and // Facebook, or any OpenID Connect-compatible identity provider such as Google or -// Amazon Cognito federated identities -// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html). -// For mobile applications, we recommend that you use Amazon Cognito. You can use -// Amazon Cognito with the Amazon Web Services SDK for iOS Developer Guide -// (http://aws.amazon.com/sdkforios/) and the Amazon Web Services SDK for Android -// Developer Guide (http://aws.amazon.com/sdkforandroid/) to uniquely identify a -// user. You can also supply the user with a consistent identity throughout the -// lifetime of an application. To learn more about Amazon Cognito, see Amazon -// Cognito Overview -// (https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840) +// Amazon Cognito federated identities (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html) +// . For mobile applications, we recommend that you use Amazon Cognito. You can use +// Amazon Cognito with the Amazon Web Services SDK for iOS Developer Guide (http://aws.amazon.com/sdkforios/) +// and the Amazon Web Services SDK for Android Developer Guide (http://aws.amazon.com/sdkforandroid/) +// to uniquely identify a user. You can also supply the user with a consistent +// identity throughout the lifetime of an application. To learn more about Amazon +// Cognito, see Amazon Cognito Overview (https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840) // in Amazon Web Services SDK for Android Developer Guide and Amazon Cognito -// Overview -// (https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664) +// Overview (https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664) // in the Amazon Web Services SDK for iOS Developer Guide. Calling // AssumeRoleWithWebIdentity does not require the use of Amazon Web Services // security credentials. Therefore, you can distribute an application (for example, @@ -36,32 +32,28 @@ import ( // Services credentials. Instead, the identity of the caller is validated by using // a token from the web identity provider. For a comparison of // AssumeRoleWithWebIdentity with the other API operations that produce temporary -// credentials, see Requesting Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) -// and Comparing the Amazon Web Services STS API operations -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) +// credentials, see Requesting Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) +// and Comparing the Amazon Web Services STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) // in the IAM User Guide. The temporary security credentials returned by this API // consist of an access key ID, a secret access key, and a security token. // Applications can use these temporary security credentials to sign calls to // Amazon Web Services service API operations. Session Duration By default, the -// temporary security credentials created by AssumeRoleWithWebIdentity last for one -// hour. However, you can use the optional DurationSeconds parameter to specify the -// duration of your session. You can provide a value from 900 seconds (15 minutes) -// up to the maximum session duration setting for the role. This setting can have a -// value from 1 hour to 12 hours. To learn how to view the maximum value for your -// role, see View the Maximum Session Duration Setting for a Role -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) +// temporary security credentials created by AssumeRoleWithWebIdentity last for +// one hour. However, you can use the optional DurationSeconds parameter to +// specify the duration of your session. You can provide a value from 900 seconds +// (15 minutes) up to the maximum session duration setting for the role. This +// setting can have a value from 1 hour to 12 hours. To learn how to view the +// maximum value for your role, see View the Maximum Session Duration Setting for +// a Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) // in the IAM User Guide. The maximum session duration limit applies when you use // the AssumeRole* API operations or the assume-role* CLI commands. However the // limit does not apply when you use those operations to create a console URL. For -// more information, see Using IAM Roles -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the IAM -// User Guide. Permissions The temporary security credentials created by +// more information, see Using IAM Roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) +// in the IAM User Guide. Permissions The temporary security credentials created by // AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web // Services service with the following exception: you cannot call the STS // GetFederationToken or GetSessionToken API operations. (Optional) You can pass -// inline or managed session policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// inline or managed session policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. The plaintext that you @@ -72,17 +64,14 @@ import ( // credentials in subsequent Amazon Web Services API calls to access resources in // the account that owns the role. You cannot use session policies to grant more // permissions than those allowed by the identity-based policy of the role that is -// being assumed. For more information, see Session Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// being assumed. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. Tags (Optional) You can configure your IdP to pass // attributes into your web identity token as session tags. Each session tag // consists of a key name and an associated value. For more information about -// session tags, see Passing Session Tags in STS -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. You can pass up to 50 session tags. The plaintext session tag -// keys can’t exceed 128 characters and the values can’t exceed 256 characters. For -// these and additional limits, see IAM and STS Character Limits -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) +// session tags, see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. You can pass up to 50 session tags. The plaintext session +// tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. +// For these and additional limits, see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. An Amazon Web Services conversion compresses the passed // inline session policy, managed policy ARNs, and session tags into a packed // binary format that has a separate limit. Your request can fail for this limit @@ -93,52 +82,38 @@ import ( // overrides the role tag with the same key. An administrator must grant you the // permissions necessary to pass session tags. The administrator can also create // granular permissions to allow you to pass only specific session tags. For more -// information, see Tutorial: Using Tags for Attribute-Based Access Control -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) +// information, see Tutorial: Using Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) // in the IAM User Guide. You can set the session tags as transitive. Transitive -// tags persist during role chaining. For more information, see Chaining Roles with -// Session Tags -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) +// tags persist during role chaining. For more information, see Chaining Roles +// with Session Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining) // in the IAM User Guide. Identities Before your application can call -// AssumeRoleWithWebIdentity, you must have an identity token from a supported +// AssumeRoleWithWebIdentity , you must have an identity token from a supported // identity provider and create a role that the application can assume. The role // that your application assumes must trust the identity provider that is // associated with the identity token. In other words, the identity provider must // be specified in the role's trust policy. Calling AssumeRoleWithWebIdentity can -// result in an entry in your CloudTrail logs. The entry includes the Subject -// (http://openid.net/specs/openid-connect-core-1_0.html#Claims) of the provided -// web identity token. We recommend that you avoid using any personally -// identifiable information (PII) in this field. For example, you could instead use -// a GUID or a pairwise identifier, as suggested in the OIDC specification -// (http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes). For more -// information about how to use web identity federation and the +// result in an entry in your CloudTrail logs. The entry includes the Subject (http://openid.net/specs/openid-connect-core-1_0.html#Claims) +// of the provided web identity token. We recommend that you avoid using any +// personally identifiable information (PII) in this field. For example, you could +// instead use a GUID or a pairwise identifier, as suggested in the OIDC +// specification (http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes) +// . For more information about how to use web identity federation and the // AssumeRoleWithWebIdentity API, see the following resources: -// -// * Using Web -// Identity Federation API Operations for Mobile Apps -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html) -// and Federation Through a Web-based Identity Provider -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity). -// -// * -// Web Identity Federation Playground -// (https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/). -// Walk through the process of authenticating through Login with Amazon, Facebook, -// or Google, getting temporary security credentials, and then using those -// credentials to make a request to Amazon Web Services. -// -// * Amazon Web Services SDK -// for iOS Developer Guide (http://aws.amazon.com/sdkforios/) and Amazon Web -// Services SDK for Android Developer Guide (http://aws.amazon.com/sdkforandroid/). -// These toolkits contain sample apps that show how to invoke the identity -// providers. The toolkits then show how to use the information from these -// providers to get and use temporary security credentials. -// -// * Web Identity -// Federation with Mobile Applications -// (http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications). -// This article discusses web identity federation and shows an example of how to -// use web identity federation to get access to content in Amazon S3. +// - Using Web Identity Federation API Operations for Mobile Apps (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html) +// and Federation Through a Web-based Identity Provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) +// . +// - Web Identity Federation Playground (https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/) +// . Walk through the process of authenticating through Login with Amazon, +// Facebook, or Google, getting temporary security credentials, and then using +// those credentials to make a request to Amazon Web Services. +// - Amazon Web Services SDK for iOS Developer Guide (http://aws.amazon.com/sdkforios/) +// and Amazon Web Services SDK for Android Developer Guide (http://aws.amazon.com/sdkforandroid/) +// . These toolkits contain sample apps that show how to invoke the identity +// providers. The toolkits then show how to use the information from these +// providers to get and use temporary security credentials. +// - Web Identity Federation with Mobile Applications (http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications) +// . This article discusses web identity federation and shows an example of how to +// use web identity federation to get access to content in Amazon S3. func (c *Client) AssumeRoleWithWebIdentity(ctx context.Context, params *AssumeRoleWithWebIdentityInput, optFns ...func(*Options)) (*AssumeRoleWithWebIdentityOutput, error) { if params == nil { params = &AssumeRoleWithWebIdentityInput{} @@ -187,16 +162,14 @@ type AssumeRoleWithWebIdentityInput struct { // higher than this setting, the operation fails. For example, if you specify a // session duration of 12 hours, but your administrator set the maximum session // duration to 6 hours, your operation fails. To learn how to view the maximum - // value for your role, see View the Maximum Session Duration Setting for a Role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) + // value for your role, see View the Maximum Session Duration Setting for a Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session) // in the IAM User Guide. By default, the value is set to 3600 seconds. The // DurationSeconds parameter is separate from the duration of a console session // that you might request using the returned credentials. The request to the // federation endpoint for a console sign-in token takes a SessionDuration // parameter that specifies the maximum length of the console session. For more // information, see Creating a URL that Enables Federated Users to Access the - // Amazon Web Services Management Console - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) + // Amazon Web Services Management Console (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html) // in the IAM User Guide. DurationSeconds *int32 @@ -208,8 +181,7 @@ type AssumeRoleWithWebIdentityInput struct { // access resources in the account that owns the role. You cannot use session // policies to grant more permissions than those allowed by the identity-based // policy of the role that is being assumed. For more information, see Session - // Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. The plaintext that you use for both inline and managed // session policies can't exceed 2,048 characters. The JSON policy characters can // be any ASCII character from the space character to the end of the valid @@ -227,9 +199,8 @@ type AssumeRoleWithWebIdentityInput struct { // the role. This parameter is optional. You can provide up to 10 managed policy // ARNs. However, the plaintext that you use for both inline and managed session // policies can't exceed 2,048 characters. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. An Amazon Web Services conversion + // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. An Amazon Web Services conversion // compresses the passed inline session policy, managed policy ARNs, and session // tags into a packed binary format that has a separate limit. Your request can // fail for this limit even if your plaintext meets the other requirements. The @@ -241,8 +212,7 @@ type AssumeRoleWithWebIdentityInput struct { // Services API calls to access resources in the account that owns the role. You // cannot use session policies to grant more permissions than those allowed by the // identity-based policy of the role that is being assumed. For more information, - // see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []types.PolicyDescriptorType @@ -265,7 +235,7 @@ type AssumeRoleWithWebIdentityOutput struct { // that you can use to refer to the resulting temporary security credentials. For // example, you can reference these credentials as a principal in a resource-based // policy by using the ARN or assumed role ID. The ARN and ID include the - // RoleSessionName that you specified when you called AssumeRole. + // RoleSessionName that you specified when you called AssumeRole . AssumedRoleUser *types.AssumedRoleUser // The intended audience (also known as client ID) of the web identity token. This @@ -285,10 +255,10 @@ type AssumeRoleWithWebIdentityOutput struct { // allowed space. PackedPolicySize *int32 - // The issuing authority of the web identity token presented. For OpenID Connect ID - // tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, - // this contains the value of the ProviderId parameter that was passed in the - // AssumeRoleWithWebIdentity request. + // The issuing authority of the web identity token presented. For OpenID Connect + // ID tokens, this contains the value of the iss field. For OAuth 2.0 access + // tokens, this contains the value of the ProviderId parameter that was passed in + // the AssumeRoleWithWebIdentity request. Provider *string // The value of the source identity that is returned in the JSON web token (JWT) @@ -297,17 +267,14 @@ type AssumeRoleWithWebIdentityOutput struct { // key in a role trust policy. That way, actions that are taken with the role are // associated with that user. After the source identity is set, the value cannot be // changed. It is present in the request for all actions that are taken by the role - // and persists across chained role - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) + // and persists across chained role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) // sessions. You can configure your identity provider to use an attribute // associated with your users, like user name or email, as the source identity when - // calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web - // token. To learn more about OIDC tokens and claims, see Using Tokens with User - // Pools - // (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html) + // calling AssumeRoleWithWebIdentity . You do this by adding a claim to the JSON + // web token. To learn more about OIDC tokens and claims, see Using Tokens with + // User Pools (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html) // in the Amazon Cognito Developer Guide. For more information about using source - // identity, see Monitor and control actions taken with assumed roles - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) + // identity, see Monitor and control actions taken with assumed roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) // in the IAM User Guide. The regex used to validate this parameter is a string of // characters consisting of upper- and lower-case alphanumeric characters with no // spaces. You can also include underscores or any of the following characters: diff --git a/service/sts/api_op_DecodeAuthorizationMessage.go b/service/sts/api_op_DecodeAuthorizationMessage.go index b7a637d420c..2dcc3110819 100644 --- a/service/sts/api_op_DecodeAuthorizationMessage.go +++ b/service/sts/api_op_DecodeAuthorizationMessage.go @@ -22,27 +22,17 @@ import ( // encoded because the details of the authorization status can contain privileged // information that the user who requested the operation should not see. To decode // an authorization status message, a user must be granted permissions through an -// IAM policy -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) to -// request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. -// The decoded message includes the following type of information: -// -// * Whether the -// request was denied due to an explicit deny or due to the absence of an explicit -// allow. For more information, see Determining Whether a Request is Allowed or -// Denied -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) -// in the IAM User Guide. -// -// * The principal who made the request. -// -// * The requested -// action. -// -// * The requested resource. -// -// * The values of condition keys in the -// context of the user's request. +// IAM policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) +// to request the DecodeAuthorizationMessage ( sts:DecodeAuthorizationMessage ) +// action. The decoded message includes the following type of information: +// - Whether the request was denied due to an explicit deny or due to the +// absence of an explicit allow. For more information, see Determining Whether a +// Request is Allowed or Denied (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) +// in the IAM User Guide. +// - The principal who made the request. +// - The requested action. +// - The requested resource. +// - The values of condition keys in the context of the user's request. func (c *Client) DecodeAuthorizationMessage(ctx context.Context, params *DecodeAuthorizationMessageInput, optFns ...func(*Options)) (*DecodeAuthorizationMessageOutput, error) { if params == nil { params = &DecodeAuthorizationMessageInput{} diff --git a/service/sts/api_op_GetAccessKeyInfo.go b/service/sts/api_op_GetAccessKeyInfo.go index b86a425d0a8..13aef999e6e 100644 --- a/service/sts/api_op_GetAccessKeyInfo.go +++ b/service/sts/api_op_GetAccessKeyInfo.go @@ -11,21 +11,18 @@ import ( ) // Returns the account identifier for the specified access key ID. Access keys -// consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a -// secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For -// more information about access keys, see Managing Access Keys for IAM Users -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) +// consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE ) and +// a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY ). +// For more information about access keys, see Managing Access Keys for IAM Users (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) // in the IAM User Guide. When you pass an access key ID to this operation, it // returns the ID of the Amazon Web Services account to which the keys belong. // Access key IDs beginning with AKIA are long-term credentials for an IAM user or // the Amazon Web Services account root user. Access key IDs beginning with ASIA // are temporary credentials that are created using STS operations. If the account // in the response belongs to you, you can sign in as the root user and review your -// root user access keys. Then, you can pull a credentials report -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) +// root user access keys. Then, you can pull a credentials report (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html) // to learn which IAM user owns the keys. To learn who requested the temporary -// credentials for an ASIA access key, view the STS events in your CloudTrail logs -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) +// credentials for an ASIA access key, view the STS events in your CloudTrail logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html) // in the IAM User Guide. This operation does not indicate the state of the access // key. The key might be active, inactive, or deleted. Active keys might not have // permissions to perform an operation. Providing a deleted access key might return diff --git a/service/sts/api_op_GetCallerIdentity.go b/service/sts/api_op_GetCallerIdentity.go index a7f96c22014..ca14ae8894e 100644 --- a/service/sts/api_op_GetCallerIdentity.go +++ b/service/sts/api_op_GetCallerIdentity.go @@ -15,9 +15,8 @@ import ( // administrator adds a policy to your IAM user or role that explicitly denies // access to the sts:GetCallerIdentity action, you can still perform this // operation. Permissions are not required because the same information is returned -// when an IAM user or role is denied access. To view an example response, see I Am -// Not Authorized to Perform: iam:DeleteVirtualMFADevice -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa) +// when an IAM user or role is denied access. To view an example response, see I +// Am Not Authorized to Perform: iam:DeleteVirtualMFADevice (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa) // in the IAM User Guide. func (c *Client) GetCallerIdentity(ctx context.Context, params *GetCallerIdentityInput, optFns ...func(*Options)) (*GetCallerIdentityOutput, error) { if params == nil { @@ -49,10 +48,9 @@ type GetCallerIdentityOutput struct { // The Amazon Web Services ARN associated with the calling entity. Arn *string - // The unique identifier of the calling entity. The exact value depends on the type - // of entity that is making the call. The values returned are those listed in the - // aws:userid column in the Principal table - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable) + // The unique identifier of the calling entity. The exact value depends on the + // type of entity that is making the call. The values returned are those listed in + // the aws:userid column in the Principal table (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable) // found on the Policy Variables reference page in the IAM User Guide. UserId *string diff --git a/service/sts/api_op_GetFederationToken.go b/service/sts/api_op_GetFederationToken.go index 8acb5acaacb..9f31731c35b 100644 --- a/service/sts/api_op_GetFederationToken.go +++ b/service/sts/api_op_GetFederationToken.go @@ -11,50 +11,41 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a set of temporary security credentials (consisting of an access key ID, -// a secret access key, and a security token) for a federated user. A typical use -// is in a proxy application that gets temporary security credentials on behalf of -// distributed applications inside a corporate network. You must call the +// Returns a set of temporary security credentials (consisting of an access key +// ID, a secret access key, and a security token) for a federated user. A typical +// use is in a proxy application that gets temporary security credentials on behalf +// of distributed applications inside a corporate network. You must call the // GetFederationToken operation using the long-term security credentials of an IAM // user. As a result, this call is appropriate in contexts where those credentials // can be safely stored, usually in a server-based application. For a comparison of // GetFederationToken with the other API operations that produce temporary -// credentials, see Requesting Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) -// and Comparing the Amazon Web Services STS API operations -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) +// credentials, see Requesting Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) +// and Comparing the Amazon Web Services STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) // in the IAM User Guide. You can create a mobile-based or browser-based app that // can authenticate users using a web identity provider like Login with Amazon, // Facebook, Google, or an OpenID Connect-compatible identity provider. In this // case, we recommend that you use Amazon Cognito (http://aws.amazon.com/cognito/) -// or AssumeRoleWithWebIdentity. For more information, see Federation Through a -// Web-based Identity Provider -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) +// or AssumeRoleWithWebIdentity . For more information, see Federation Through a +// Web-based Identity Provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) // in the IAM User Guide. You can also call GetFederationToken using the security // credentials of an Amazon Web Services account root user, but we do not recommend // it. Instead, we recommend that you create an IAM user for the purpose of the // proxy application. Then attach a policy to the IAM user that limits federated // users to only the actions and resources that they need to access. For more -// information, see IAM Best Practices -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) in the -// IAM User Guide. Session duration The temporary credentials are valid for the -// specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 +// information, see IAM Best Practices (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) +// in the IAM User Guide. Session duration The temporary credentials are valid for +// the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 // seconds (36 hours). The default session duration is 43,200 seconds (12 hours). // Temporary credentials obtained by using the Amazon Web Services account root // user credentials have a maximum duration of 3,600 seconds (1 hour). Permissions // You can use the temporary credentials created by GetFederationToken in any // Amazon Web Services service with the following exceptions: +// - You cannot call any IAM operations using the CLI or the Amazon Web Services +// API. This limitation does not apply to console sessions. +// - You cannot call any STS operations except GetCallerIdentity . // -// * You cannot call -// any IAM operations using the CLI or the Amazon Web Services API. This limitation -// does not apply to console sessions. -// -// * You cannot call any STS operations except -// GetCallerIdentity. -// -// You can use temporary credentials for single sign-on (SSO) -// to the console. You must pass an inline or managed session policy -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// You can use temporary credentials for single sign-on (SSO) to the console. You +// must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. The plaintext that you @@ -65,38 +56,33 @@ import ( // policies and the session policies that you pass. This gives you a way to further // restrict the permissions for a federated user. You cannot use session policies // to grant more permissions than those that are defined in the permissions policy -// of the IAM user. For more information, see Session Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) +// of the IAM user. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. For information about using GetFederationToken to create // temporary security credentials, see GetFederationToken—Federation Through a -// Custom Identity Broker -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken). -// You can use the credentials to access a resource that has a resource-based +// Custom Identity Broker (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken) +// . You can use the credentials to access a resource that has a resource-based // policy. If that policy specifically references the federated user session in the // Principal element of the policy, the session has the permissions allowed by the // policy. These permissions are granted in addition to the permissions granted by // the session policies. Tags (Optional) You can pass tag key-value pairs to your // session. These are called session tags. For more information about session tags, -// see Passing Session Tags in STS -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. You can create a mobile-based or browser-based app that can -// authenticate users using a web identity provider like Login with Amazon, +// see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. You can create a mobile-based or browser-based app that +// can authenticate users using a web identity provider like Login with Amazon, // Facebook, Google, or an OpenID Connect-compatible identity provider. In this // case, we recommend that you use Amazon Cognito (http://aws.amazon.com/cognito/) -// or AssumeRoleWithWebIdentity. For more information, see Federation Through a -// Web-based Identity Provider -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) +// or AssumeRoleWithWebIdentity . For more information, see Federation Through a +// Web-based Identity Provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity) // in the IAM User Guide. An administrator must grant you the permissions necessary // to pass session tags. The administrator can also create granular permissions to // allow you to pass only specific session tags. For more information, see -// Tutorial: Using Tags for Attribute-Based Access Control -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) +// Tutorial: Using Tags for Attribute-Based Access Control (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html) // in the IAM User Guide. Tag key–value pairs are not case sensitive, but case is // preserved. This means that you cannot have separate Department and department -// tag keys. Assume that the user that you are federating has the -// Department=Marketing tag and you pass the department=engineering session tag. -// Department and department are not saved as separate tags, and the session tag -// passed in the request takes precedence over the user tag. +// tag keys. Assume that the user that you are federating has the Department = +// Marketing tag and you pass the department = engineering session tag. Department +// and department are not saved as separate tags, and the session tag passed in +// the request takes precedence over the user tag. func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTokenInput, optFns ...func(*Options)) (*GetFederationTokenOutput, error) { if params == nil { params = &GetFederationTokenInput{} @@ -115,26 +101,27 @@ func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTo type GetFederationTokenInput struct { // The name of the federated user. The name is used as an identifier for the - // temporary security credentials (such as Bob). For example, you can reference the - // federated user name in a resource-based policy, such as in an Amazon S3 bucket - // policy. The regex used to validate this parameter is a string of characters - // consisting of upper- and lower-case alphanumeric characters with no spaces. You - // can also include underscores or any of the following characters: =,.@- + // temporary security credentials (such as Bob ). For example, you can reference + // the federated user name in a resource-based policy, such as in an Amazon S3 + // bucket policy. The regex used to validate this parameter is a string of + // characters consisting of upper- and lower-case alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@- // // This member is required. Name *string - // The duration, in seconds, that the session should last. Acceptable durations for - // federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 - // hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using - // Amazon Web Services account root user credentials are restricted to a maximum of - // 3,600 seconds (one hour). If the specified duration is longer than one hour, the - // session obtained by using root user credentials defaults to one hour. + // The duration, in seconds, that the session should last. Acceptable durations + // for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds + // (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained + // using Amazon Web Services account root user credentials are restricted to a + // maximum of 3,600 seconds (one hour). If the specified duration is longer than + // one hour, the session obtained by using root user credentials defaults to one + // hour. DurationSeconds *int32 // An IAM policy in JSON format that you want to use as an inline session policy. - // You must pass an inline or managed session policy - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // You must pass an inline or managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. This parameter is @@ -144,8 +131,7 @@ type GetFederationTokenInput struct { // session policies that you pass. This gives you a way to further restrict the // permissions for a federated user. You cannot use session policies to grant more // permissions than those that are defined in the permissions policy of the IAM - // user. For more information, see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // user. For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. The resulting credentials can be used to access a // resource that has a resource-based policy. If that policy specifically // references the federated user session in the Principal element of the policy, @@ -166,24 +152,21 @@ type GetFederationTokenInput struct { // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as a managed session policy. The policies must exist in the same account as // the IAM user that is requesting federated access. You must pass an inline or - // managed session policy - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // managed session policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // to this operation. You can pass a single JSON policy document to use as an // inline session policy. You can also specify up to 10 managed policy Amazon // Resource Names (ARNs) to use as managed session policies. The plaintext that you // use for both inline and managed session policies can't exceed 2,048 characters. // You can provide up to 10 managed policy ARNs. For more information about ARNs, - // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. This parameter is optional. However, - // if you do not pass any session policies, then the resulting federated user - // session has no permissions. When you pass session policies, the session + // see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. This parameter is optional. + // However, if you do not pass any session policies, then the resulting federated + // user session has no permissions. When you pass session policies, the session // permissions are the intersection of the IAM user policies and the session // policies that you pass. This gives you a way to further restrict the permissions // for a federated user. You cannot use session policies to grant more permissions // than those that are defined in the permissions policy of the IAM user. For more - // information, see Session Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) + // information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. The resulting credentials can be used to access a // resource that has a resource-based policy. If that policy specifically // references the federated user session in the Principal element of the policy, @@ -192,20 +175,18 @@ type GetFederationTokenInput struct { // An Amazon Web Services conversion compresses the passed inline session policy, // managed policy ARNs, and session tags into a packed binary format that has a // separate limit. Your request can fail for this limit even if your plaintext - // meets the other requirements. The PackedPolicySize response element indicates by - // percentage how close the policies and tags for your request are to the upper + // meets the other requirements. The PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the upper // size limit. PolicyArns []types.PolicyDescriptorType // A list of session tags. Each session tag consists of a key name and an // associated value. For more information about session tags, see Passing Session - // Tags in STS - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the - // IAM User Guide. This parameter is optional. You can pass up to 50 session tags. - // The plaintext session tag keys can’t exceed 128 characters and the values can’t - // exceed 256 characters. For these and additional limits, see IAM and STS - // Character Limits - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) + // Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) + // in the IAM User Guide. This parameter is optional. You can pass up to 50 session + // tags. The plaintext session tag keys can’t exceed 128 characters and the values + // can’t exceed 256 characters. For these and additional limits, see IAM and STS + // Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. An Amazon Web Services conversion compresses the passed // inline session policy, managed policy ARNs, and session tags into a packed // binary format that has a separate limit. Your request can fail for this limit @@ -216,9 +197,9 @@ type GetFederationTokenInput struct { // you do, session tags override a user tag with the same key. Tag key–value pairs // are not case sensitive, but case is preserved. This means that you cannot have // separate Department and department tag keys. Assume that the role has the - // Department=Marketing tag and you pass the department=engineering session tag. - // Department and department are not saved as separate tags, and the session tag - // passed in the request takes precedence over the role tag. + // Department = Marketing tag and you pass the department = engineering session + // tag. Department and department are not saved as separate tags, and the session + // tag passed in the request takes precedence over the role tag. Tags []types.Tag noSmithyDocumentSerde @@ -236,7 +217,7 @@ type GetFederationTokenOutput struct { Credentials *types.Credentials // Identifiers for the federated user associated with the credentials (such as - // arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use + // arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob ). You can use // the federated user's ARN in your resource-based policies, such as an Amazon S3 // bucket policy. FederatedUser *types.FederatedUser diff --git a/service/sts/api_op_GetSessionToken.go b/service/sts/api_op_GetSessionToken.go index bfde51689d1..1e5bd4e6724 100644 --- a/service/sts/api_op_GetSessionToken.go +++ b/service/sts/api_op_GetSessionToken.go @@ -11,26 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a set of temporary credentials for an Amazon Web Services account or IAM -// user. The credentials consist of an access key ID, a secret access key, and a -// security token. Typically, you use GetSessionToken if you want to use MFA to +// Returns a set of temporary credentials for an Amazon Web Services account or +// IAM user. The credentials consist of an access key ID, a secret access key, and +// a security token. Typically, you use GetSessionToken if you want to use MFA to // protect programmatic calls to specific Amazon Web Services API operations like -// Amazon EC2 StopInstances. MFA-enabled IAM users would need to call +// Amazon EC2 StopInstances . MFA-enabled IAM users would need to call // GetSessionToken and submit an MFA code that is associated with their MFA device. // Using the temporary security credentials that are returned from the call, IAM // users can then make programmatic calls to API operations that require MFA // authentication. If you do not supply a correct MFA code, then the API returns an // access denied error. For a comparison of GetSessionToken with the other API -// operations that produce temporary credentials, see Requesting Temporary Security -// Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) -// and Comparing the Amazon Web Services STS API operations -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) +// operations that produce temporary credentials, see Requesting Temporary +// Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html) +// and Comparing the Amazon Web Services STS API operations (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison) // in the IAM User Guide. No permissions are required for users to perform this // operation. The purpose of the sts:GetSessionToken operation is to authenticate // the user using MFA. You cannot use policies to control authentication -// operations. For more information, see Permissions for GetSessionToken -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html) +// operations. For more information, see Permissions for GetSessionToken (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html) // in the IAM User Guide. Session Duration The GetSessionToken operation must be // called by using the long-term Amazon Web Services security credentials of the // Amazon Web Services account root user or an IAM user. Credentials that are @@ -41,18 +38,12 @@ import ( // (1 hour), with a default of 1 hour. Permissions The temporary security // credentials created by GetSessionToken can be used to make API calls to any // Amazon Web Services service with the following exceptions: +// - You cannot call any IAM API operations unless MFA authentication +// information is included in the request. +// - You cannot call any STS API except AssumeRole or GetCallerIdentity . // -// * You cannot call -// any IAM API operations unless MFA authentication information is included in the -// request. -// -// * You cannot call any STS API except AssumeRole or -// GetCallerIdentity. -// -// We recommend that you do not call GetSessionToken with -// Amazon Web Services account root user credentials. Instead, follow our best -// practices -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users) +// We recommend that you do not call GetSessionToken with Amazon Web Services +// account root user credentials. Instead, follow our best practices (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users) // by creating one or more IAM users, giving them the necessary permissions, and // using IAM users for everyday interaction with Amazon Web Services. The // credentials that are returned by GetSessionToken are based on permissions @@ -62,8 +53,7 @@ import ( // GetSessionToken is called using the credentials of an IAM user, the temporary // credentials have the same permissions as the IAM user. For more information // about using GetSessionToken to create temporary credentials, go to Temporary -// Credentials for Users in Untrusted Environments -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken) +// Credentials for Users in Untrusted Environments (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken) // in the IAM User Guide. func (c *Client) GetSessionToken(ctx context.Context, params *GetSessionTokenInput, optFns ...func(*Options)) (*GetSessionTokenOutput, error) { if params == nil { @@ -90,25 +80,25 @@ type GetSessionTokenInput struct { // Services account owners defaults to one hour. DurationSeconds *int32 - // The identification number of the MFA device that is associated with the IAM user - // who is making the GetSessionToken call. Specify this value if the IAM user has a - // policy that requires MFA authentication. The value is either the serial number - // for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) - // for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find - // the device for an IAM user by going to the Amazon Web Services Management - // Console and viewing the user's security credentials. The regex used to validate - // this parameter is a string of characters consisting of upper- and lower-case - // alphanumeric characters with no spaces. You can also include underscores or any - // of the following characters: =,.@:/- + // The identification number of the MFA device that is associated with the IAM + // user who is making the GetSessionToken call. Specify this value if the IAM user + // has a policy that requires MFA authentication. The value is either the serial + // number for a hardware device (such as GAHT12345678 ) or an Amazon Resource Name + // (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user ). You + // can find the device for an IAM user by going to the Amazon Web Services + // Management Console and viewing the user's security credentials. The regex used + // to validate this parameter is a string of characters consisting of upper- and + // lower-case alphanumeric characters with no spaces. You can also include + // underscores or any of the following characters: =,.@:/- SerialNumber *string - // The value provided by the MFA device, if MFA is required. If any policy requires - // the IAM user to submit an MFA code, specify this value. If MFA authentication is - // required, the user must provide a code when requesting a set of temporary - // security credentials. A user who fails to provide the code receives an "access - // denied" response when requesting resources that require MFA authentication. The - // format for this parameter, as described by its regex pattern, is a sequence of - // six numeric digits. + // The value provided by the MFA device, if MFA is required. If any policy + // requires the IAM user to submit an MFA code, specify this value. If MFA + // authentication is required, the user must provide a code when requesting a set + // of temporary security credentials. A user who fails to provide the code receives + // an "access denied" response when requesting resources that require MFA + // authentication. The format for this parameter, as described by its regex + // pattern, is a sequence of six numeric digits. TokenCode *string noSmithyDocumentSerde diff --git a/service/sts/doc.go b/service/sts/doc.go index 7cabbb97e9f..7f41c0a6db0 100644 --- a/service/sts/doc.go +++ b/service/sts/doc.go @@ -7,6 +7,6 @@ // temporary, limited-privilege credentials for Identity and Access Management // (IAM) users or for users that you authenticate (federated users). This guide // provides descriptions of the STS API. For more information about using this -// service, see Temporary Security Credentials -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html). +// service, see Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) +// . package sts diff --git a/service/sts/types/errors.go b/service/sts/types/errors.go index 9e3adaa9a07..097875b279b 100644 --- a/service/sts/types/errors.go +++ b/service/sts/types/errors.go @@ -183,12 +183,10 @@ func (e *MalformedPolicyDocumentException) ErrorFault() smithy.ErrorFault { retu // compresses the session policy document, session policy ARNs, and session tags // into a packed binary format that has a separate limit. The error message // indicates by percentage how close the policies and tags are to the upper size -// limit. For more information, see Passing Session Tags in STS -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. You could receive this error even though you meet other defined -// session policy and session tag limits. For more information, see IAM and STS -// Entity Character Limits -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length) +// limit. For more information, see Passing Session Tags in STS (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. You could receive this error even though you meet other +// defined session policy and session tag limits. For more information, see IAM +// and STS Entity Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length) // in the IAM User Guide. type PackedPolicyTooLargeException struct { Message *string @@ -215,11 +213,10 @@ func (e *PackedPolicyTooLargeException) ErrorCode() string { } func (e *PackedPolicyTooLargeException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// STS is not activated in the requested region for the account that is being asked -// to generate credentials. The account administrator must use the IAM console to -// activate STS in that region. For more information, see Activating and -// Deactivating Amazon Web Services STS in an Amazon Web Services Region -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// STS is not activated in the requested region for the account that is being +// asked to generate credentials. The account administrator must use the IAM +// console to activate STS in that region. For more information, see Activating +// and Deactivating Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the IAM User Guide. type RegionDisabledException struct { Message *string diff --git a/service/sts/types/types.go b/service/sts/types/types.go index 86e509905be..90d4f62ae94 100644 --- a/service/sts/types/types.go +++ b/service/sts/types/types.go @@ -13,9 +13,8 @@ type AssumedRoleUser struct { // The ARN of the temporary security credentials that are returned from the // AssumeRole action. For more information about ARNs and how to use them in - // policies, see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // policies, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string @@ -62,9 +61,8 @@ type FederatedUser struct { // The ARN that specifies the federated user that is associated with the // credentials. For more information about ARNs and how to use them in policies, - // see IAM Identifiers - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in - // the IAM User Guide. + // see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) + // in the IAM User Guide. // // This member is required. Arn *string @@ -84,26 +82,23 @@ type PolicyDescriptorType struct { // The Amazon Resource Name (ARN) of the IAM managed policy to use as a session // policy for the role. For more information about ARNs, see Amazon Resource Names - // (ARNs) and Amazon Web Services Service Namespaces - // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in - // the Amazon Web Services General Reference. + // (ARNs) and Amazon Web Services Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. Arn *string noSmithyDocumentSerde } -// You can pass custom key-value pair attributes when you assume a role or federate -// a user. These are called session tags. You can then use the session tags to -// control access to resources. For more information, see Tagging Amazon Web -// Services STS Sessions -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) in the -// IAM User Guide. +// You can pass custom key-value pair attributes when you assume a role or +// federate a user. These are called session tags. You can then use the session +// tags to control access to resources. For more information, see Tagging Amazon +// Web Services STS Sessions (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html) +// in the IAM User Guide. type Tag struct { // The key for a session tag. You can pass up to 50 session tags. The plain text // session tag keys can’t exceed 128 characters. For these and additional limits, - // see IAM and STS Character Limits - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) + // see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // // This member is required. @@ -111,8 +106,7 @@ type Tag struct { // The value for a session tag. You can pass up to 50 session tags. The plain text // session tag values can’t exceed 256 characters. For these and additional limits, - // see IAM and STS Character Limits - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) + // see IAM and STS Character Limits (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length) // in the IAM User Guide. // // This member is required. diff --git a/service/support/api_client.go b/service/support/api_client.go index 610595f1c59..dedf529f9be 100644 --- a/service/support/api_client.go +++ b/service/support/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/support/api_op_AddAttachmentsToSet.go b/service/support/api_op_AddAttachmentsToSet.go index 4d0644fb8f9..f0a750d4dd5 100644 --- a/service/support/api_op_AddAttachmentsToSet.go +++ b/service/support/api_op_AddAttachmentsToSet.go @@ -15,16 +15,13 @@ import ( // temporary container for attachments that you add to a case or case // communication. The set is available for 1 hour after it's created. The // expiryTime returned in the response is when the set expires. -// -// * You must have a -// Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web -// Services Support API. -// -// * If you call the Amazon Web Services Support API from an -// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support -// plan, the SubscriptionRequiredException error message appears. For information -// about changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) AddAttachmentsToSet(ctx context.Context, params *AddAttachmentsToSetInput, optFns ...func(*Options)) (*AddAttachmentsToSetOutput, error) { if params == nil { params = &AddAttachmentsToSetInput{} @@ -45,17 +42,17 @@ type AddAttachmentsToSetInput struct { // One or more attachments to add to the set. You can add up to three attachments // per set. The size limit is 5 MB per attachment. In the Attachment object, use // the data parameter to specify the contents of the attachment file. In the - // previous request syntax, the value for data appear as blob, which is represented - // as a base64-encoded string. The value for fileName is the name of the - // attachment, such as troubleshoot-screenshot.png. + // previous request syntax, the value for data appear as blob , which is + // represented as a base64-encoded string. The value for fileName is the name of + // the attachment, such as troubleshoot-screenshot.png . // // This member is required. Attachments []types.Attachment // The ID of the attachment set. If an attachmentSetId is not specified, a new // attachment set is created, and the ID of the set is returned in the response. If - // an attachmentSetId is specified, the attachments are added to the specified set, - // if it exists. + // an attachmentSetId is specified, the attachments are added to the specified + // set, if it exists. AttachmentSetId *string noSmithyDocumentSerde diff --git a/service/support/api_op_AddCommunicationToCase.go b/service/support/api_op_AddCommunicationToCase.go index db72bcc0509..3efa54674cc 100644 --- a/service/support/api_op_AddCommunicationToCase.go +++ b/service/support/api_op_AddCommunicationToCase.go @@ -11,20 +11,17 @@ import ( ) // Adds additional customer communication to an Amazon Web Services Support case. -// Use the caseId parameter to identify the case to which to add communication. You -// can list a set of email addresses to copy on the communication by using the -// ccEmailAddresses parameter. The communicationBody value contains the text of the -// communication. -// -// * You must have a Business, Enterprise On-Ramp, or Enterprise -// Support plan to use the Amazon Web Services Support API. -// -// * If you call the -// Amazon Web Services Support API from an account that doesn't have a Business, -// Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// Use the caseId parameter to identify the case to which to add communication. +// You can list a set of email addresses to copy on the communication by using the +// ccEmailAddresses parameter. The communicationBody value contains the text of +// the communication. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) AddCommunicationToCase(ctx context.Context, params *AddCommunicationToCaseInput, optFns ...func(*Options)) (*AddCommunicationToCaseOutput, error) { if params == nil { params = &AddCommunicationToCaseInput{} diff --git a/service/support/api_op_CreateCase.go b/service/support/api_op_CreateCase.go index 16960a0ab8e..6db65c2f5a1 100644 --- a/service/support/api_op_CreateCase.go +++ b/service/support/api_op_CreateCase.go @@ -15,34 +15,25 @@ import ( // Create Case (https://console.aws.amazon.com/support/home#/case/create) page. The // Amazon Web Services Support API doesn't support requesting service limit // increases. You can submit a service limit increase in the following ways: +// - Submit a request from the Amazon Web Services Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) +// page. +// - Use the Service Quotas RequestServiceQuotaIncrease (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html) +// operation. // -// * -// Submit a request from the Amazon Web Services Support Center Create Case -// (https://console.aws.amazon.com/support/home#/case/create) page. -// -// * Use the -// Service Quotas RequestServiceQuotaIncrease -// (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html) -// operation. -// -// A successful CreateCase request returns an Amazon Web Services -// Support case number. You can use the DescribeCases operation and specify the -// case number to get existing Amazon Web Services Support cases. After you create -// a case, use the AddCommunicationToCase operation to add additional communication -// or attachments to an existing case. The caseId is separate from the displayId -// that appears in the Amazon Web Services Support Center -// (https://console.aws.amazon.com/support). Use the DescribeCases operation to get -// the displayId. -// -// * You must have a Business, Enterprise On-Ramp, or Enterprise -// Support plan to use the Amazon Web Services Support API. -// -// * If you call the -// Amazon Web Services Support API from an account that doesn't have a Business, -// Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// A successful CreateCase request returns an Amazon Web Services Support case +// number. You can use the DescribeCases operation and specify the case number to +// get existing Amazon Web Services Support cases. After you create a case, use the +// AddCommunicationToCase operation to add additional communication or attachments +// to an existing case. The caseId is separate from the displayId that appears in +// the Amazon Web Services Support Center (https://console.aws.amazon.com/support) +// . Use the DescribeCases operation to get the displayId . +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error) { if params == nil { params = &CreateCaseInput{} @@ -61,21 +52,21 @@ func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns type CreateCaseInput struct { // The communication body text that describes the issue. This text appears in the - // Description field on the Amazon Web Services Support Center Create Case - // (https://console.aws.amazon.com/support/home#/case/create) page. + // Description field on the Amazon Web Services Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) + // page. // // This member is required. CommunicationBody *string // The title of the support case. The title appears in the Subject field on the - // Amazon Web Services Support Center Create Case - // (https://console.aws.amazon.com/support/home#/case/create) page. + // Amazon Web Services Support Center Create Case (https://console.aws.amazon.com/support/home#/case/create) + // page. // // This member is required. Subject *string - // The ID of a set of one or more attachments for the case. Create the set by using - // the AddAttachmentsToSet operation. + // The ID of a set of one or more attachments for the case. Create the set by + // using the AddAttachmentsToSet operation. AttachmentSetId *string // The category of problem for the support case. You also use the DescribeServices @@ -86,11 +77,11 @@ type CreateCaseInput struct { // A list of email addresses that Amazon Web Services Support copies on case // correspondence. Amazon Web Services Support identifies the account that creates // the case when you specify your Amazon Web Services credentials in an HTTP POST - // method or use the Amazon Web Services SDKs (http://aws.amazon.com/tools/). + // method or use the Amazon Web Services SDKs (http://aws.amazon.com/tools/) . CcEmailAddresses []string - // The type of issue for the case. You can specify customer-service or technical. - // If you don't specify a value, the default is technical. + // The type of issue for the case. You can specify customer-service or technical . + // If you don't specify a value, the default is technical . IssueType *string // The language in which Amazon Web Services Support handles the case. Amazon Web @@ -106,9 +97,8 @@ type CreateCaseInput struct { // A value that indicates the urgency of the case. This value determines the // response time according to your service level agreement with Amazon Web Services // Support. You can use the DescribeSeverityLevels operation to get the possible - // values for severityCode. For more information, see SeverityLevel and Choosing a - // Severity - // (https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity) + // values for severityCode . For more information, see SeverityLevel and Choosing + // a Severity (https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity) // in the Amazon Web Services Support User Guide. The availability of severity // levels depends on the support plan for the Amazon Web Services account. SeverityCode *string diff --git a/service/support/api_op_DescribeAttachment.go b/service/support/api_op_DescribeAttachment.go index c13f54d2136..b58ac56aff4 100644 --- a/service/support/api_op_DescribeAttachment.go +++ b/service/support/api_op_DescribeAttachment.go @@ -16,16 +16,13 @@ import ( // are generated by the case management system when you add an attachment to a case // or case communication. Attachment IDs are returned in the AttachmentDetails // objects that are returned by the DescribeCommunications operation. -// -// * You must -// have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the -// Amazon Web Services Support API. -// -// * If you call the Amazon Web Services Support -// API from an account that doesn't have a Business, Enterprise On-Ramp, or -// Enterprise Support plan, the SubscriptionRequiredException error message -// appears. For information about changing your support plan, see Amazon Web -// Services Support (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) DescribeAttachment(ctx context.Context, params *DescribeAttachmentInput, optFns ...func(*Options)) (*DescribeAttachmentOutput, error) { if params == nil { params = &DescribeAttachmentInput{} @@ -57,9 +54,9 @@ type DescribeAttachmentInput struct { type DescribeAttachmentOutput struct { // This object includes the attachment content and file name. In the previous - // response syntax, the value for the data parameter appears as blob, which is + // response syntax, the value for the data parameter appears as blob , which is // represented as a base64-encoded string. The value for fileName is the name of - // the attachment, such as troubleshoot-screenshot.png. + // the attachment, such as troubleshoot-screenshot.png . Attachment *types.Attachment // Metadata pertaining to the operation's result. diff --git a/service/support/api_op_DescribeCases.go b/service/support/api_op_DescribeCases.go index 6215a86bc59..b3ceea43616 100644 --- a/service/support/api_op_DescribeCases.go +++ b/service/support/api_op_DescribeCases.go @@ -13,31 +13,24 @@ import ( ) // Returns a list of cases that you specify by passing one or more case IDs. You -// can use the afterTime and beforeTime parameters to filter the cases by date. You -// can set values for the includeResolvedCases and includeCommunications parameters -// to specify how much information to return. The response returns the following in -// JSON format: +// can use the afterTime and beforeTime parameters to filter the cases by date. +// You can set values for the includeResolvedCases and includeCommunications +// parameters to specify how much information to return. The response returns the +// following in JSON format: +// - One or more CaseDetails (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) +// data types. +// - One or more nextToken values, which specify where to paginate the returned +// records represented by the CaseDetails objects. // -// * One or more CaseDetails -// (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) -// data types. -// -// * One or more nextToken values, which specify where to paginate the -// returned records represented by the CaseDetails objects. -// -// Case data is available -// for 12 months after creation. If a case was created more than 12 months ago, a -// request might return an error. -// -// * You must have a Business, Enterprise On-Ramp, -// or Enterprise Support plan to use the Amazon Web Services Support API. -// -// * If you -// call the Amazon Web Services Support API from an account that doesn't have a -// Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// Case data is available for 12 months after creation. If a case was created more +// than 12 months ago, a request might return an error. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) DescribeCases(ctx context.Context, params *DescribeCasesInput, optFns ...func(*Options)) (*DescribeCasesOutput, error) { if params == nil { params = &DescribeCasesInput{} @@ -94,8 +87,7 @@ type DescribeCasesInput struct { noSmithyDocumentSerde } -// Returns an array of CaseDetails -// (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) +// Returns an array of CaseDetails (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) // objects and a nextToken that defines a point for pagination in the result set. type DescribeCasesOutput struct { diff --git a/service/support/api_op_DescribeCommunications.go b/service/support/api_op_DescribeCommunications.go index 063af033633..400db184680 100644 --- a/service/support/api_op_DescribeCommunications.go +++ b/service/support/api_op_DescribeCommunications.go @@ -20,16 +20,13 @@ import ( // parameters to control the pagination of the results. Set maxResults to the // number of cases that you want to display on each page, and use nextToken to // specify the resumption of pagination. -// -// * You must have a Business, Enterprise -// On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support -// API. -// -// * If you call the Amazon Web Services Support API from an account that -// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) DescribeCommunications(ctx context.Context, params *DescribeCommunicationsInput, optFns ...func(*Options)) (*DescribeCommunicationsOutput, error) { if params == nil { params = &DescribeCommunicationsInput{} diff --git a/service/support/api_op_DescribeServices.go b/service/support/api_op_DescribeServices.go index 34c6595c73c..461ad0a2727 100644 --- a/service/support/api_op_DescribeServices.go +++ b/service/support/api_op_DescribeServices.go @@ -21,16 +21,13 @@ import ( // categories returned by the DescribeServices operation. Always use the service // codes and categories that the DescribeServices operation returns, so that you // have the most recent set of service and category codes. -// -// * You must have a -// Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web -// Services Support API. -// -// * If you call the Amazon Web Services Support API from an -// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support -// plan, the SubscriptionRequiredException error message appears. For information -// about changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error) { if params == nil { params = &DescribeServicesInput{} diff --git a/service/support/api_op_DescribeSeverityLevels.go b/service/support/api_op_DescribeSeverityLevels.go index 71ff745f87e..564b886721c 100644 --- a/service/support/api_op_DescribeSeverityLevels.go +++ b/service/support/api_op_DescribeSeverityLevels.go @@ -14,16 +14,13 @@ import ( // Returns the list of severity levels that you can assign to a support case. The // severity level for a case is also a field in the CaseDetails data type that you // include for a CreateCase request. -// -// * You must have a Business, Enterprise -// On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support -// API. -// -// * If you call the Amazon Web Services Support API from an account that -// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) DescribeSeverityLevels(ctx context.Context, params *DescribeSeverityLevelsInput, optFns ...func(*Options)) (*DescribeSeverityLevelsOutput, error) { if params == nil { params = &DescribeSeverityLevelsInput{} diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go b/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go index 3890d1f7560..be5743ff3d1 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go @@ -11,29 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the refresh status of the Trusted Advisor checks that have the specified -// check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks -// operation. Some checks are refreshed automatically, and you can't return their -// refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses -// operation. If you call this operation for these checks, you might see an -// InvalidParameterValue error. +// Returns the refresh status of the Trusted Advisor checks that have the +// specified check IDs. You can get the check IDs by calling the +// DescribeTrustedAdvisorChecks operation. Some checks are refreshed automatically, +// and you can't return their refresh statuses by using the +// DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation +// for these checks, you might see an InvalidParameterValue error. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . // -// * You must have a Business, Enterprise On-Ramp, or -// Enterprise Support plan to use the Amazon Web Services Support API. -// -// * If you -// call the Amazon Web Services Support API from an account that doesn't have a -// Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// To call the Trusted Advisor operations -// in the Amazon Web Services Support API, you must use the US East (N. Virginia) -// endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't -// support the Trusted Advisor operations. For more information, see About the -// Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) +// To call the Trusted Advisor operations in the Amazon Web Services Support API, +// you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) +// and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For +// more information, see About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) // in the Amazon Web Services Support User Guide. func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, params *DescribeTrustedAdvisorCheckRefreshStatusesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error) { if params == nil { diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckResult.go b/service/support/api_op_DescribeTrustedAdvisorCheckResult.go index 65892b33694..012edade8de 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckResult.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckResult.go @@ -15,42 +15,32 @@ import ( // ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks // operation. The response contains a TrustedAdvisorCheckResult object, which // contains these three objects: +// - TrustedAdvisorCategorySpecificSummary +// - TrustedAdvisorResourceDetail +// - TrustedAdvisorResourcesSummary // -// * TrustedAdvisorCategorySpecificSummary +// In addition, the response contains these fields: // -// * -// TrustedAdvisorResourceDetail +// - status - The alert status of the check can be ok (green), warning (yellow), +// error (red), or not_available . // -// * TrustedAdvisorResourcesSummary +// - timestamp - The time of the last refresh of the check. // -// In addition, the -// response contains these fields: +// - checkId - The unique identifier for the check. // -// * status - The alert status of the check can be -// ok (green), warning (yellow), error (red), or not_available. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. // -// * timestamp - The -// time of the last refresh of the check. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . // -// * checkId - The unique identifier for -// the check. -// -// * You must have a Business, Enterprise On-Ramp, or Enterprise -// Support plan to use the Amazon Web Services Support API. -// -// * If you call the -// Amazon Web Services Support API from an account that doesn't have a Business, -// Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// To call the Trusted Advisor operations -// in the Amazon Web Services Support API, you must use the US East (N. Virginia) -// endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't -// support the Trusted Advisor operations. For more information, see About the -// Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) +// To call the Trusted Advisor operations in the Amazon Web Services Support API, +// you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) +// and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For +// more information, see About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) // in the Amazon Web Services Support User Guide. func (c *Client) DescribeTrustedAdvisorCheckResult(ctx context.Context, params *DescribeTrustedAdvisorCheckResultInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckResultOutput, error) { if params == nil { @@ -77,31 +67,17 @@ type DescribeTrustedAdvisorCheckResultInput struct { // The ISO 639-1 code for the language that you want your check results to appear // in. The Amazon Web Services Support API currently supports the following // languages for Trusted Advisor: - // - // * Chinese, Simplified - zh - // - // * Chinese, - // Traditional - zh_TW - // - // * English - en - // - // * French - fr - // - // * German - de - // - // * Indonesian - // - id - // - // * Italian - it - // - // * Japanese - ja - // - // * Korean - ko - // - // * Portuguese, Brazilian - - // pt_BR - // - // * Spanish - es + // - Chinese, Simplified - zh + // - Chinese, Traditional - zh_TW + // - English - en + // - French - fr + // - German - de + // - Indonesian - id + // - Italian - it + // - Japanese - ja + // - Korean - ko + // - Portuguese, Brazilian - pt_BR + // - Spanish - es Language *string noSmithyDocumentSerde diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go b/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go index d10c66c975f..656e39b98c6 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go @@ -15,23 +15,18 @@ import ( // that you specified. You can get the check IDs by calling the // DescribeTrustedAdvisorChecks operation. The response contains an array of // TrustedAdvisorCheckSummary objects. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . // -// * You must have a Business, Enterprise -// On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support -// API. -// -// * If you call the Amazon Web Services Support API from an account that -// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// To call the Trusted Advisor operations -// in the Amazon Web Services Support API, you must use the US East (N. Virginia) -// endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't -// support the Trusted Advisor operations. For more information, see About the -// Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) +// To call the Trusted Advisor operations in the Amazon Web Services Support API, +// you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) +// and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For +// more information, see About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) // in the Amazon Web Services Support User Guide. func (c *Client) DescribeTrustedAdvisorCheckSummaries(ctx context.Context, params *DescribeTrustedAdvisorCheckSummariesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckSummariesOutput, error) { if params == nil { diff --git a/service/support/api_op_DescribeTrustedAdvisorChecks.go b/service/support/api_op_DescribeTrustedAdvisorChecks.go index f3c729919cd..3ba5d62e928 100644 --- a/service/support/api_op_DescribeTrustedAdvisorChecks.go +++ b/service/support/api_op_DescribeTrustedAdvisorChecks.go @@ -15,27 +15,21 @@ import ( // name, ID, category, description, and metadata. You must specify a language code. // The response contains a TrustedAdvisorCheckDescription object for each check. // You must set the Amazon Web Services Region to us-east-1. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . +// - The names and descriptions for Trusted Advisor checks are subject to +// change. We recommend that you specify the check ID in your code to uniquely +// identify a check. // -// * You must have a -// Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web -// Services Support API. -// -// * If you call the Amazon Web Services Support API from an -// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support -// plan, the SubscriptionRequiredException error message appears. For information -// about changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// * The names and descriptions for -// Trusted Advisor checks are subject to change. We recommend that you specify the -// check ID in your code to uniquely identify a check. -// -// To call the Trusted Advisor -// operations in the Amazon Web Services Support API, you must use the US East (N. -// Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) -// endpoints don't support the Trusted Advisor operations. For more information, -// see About the Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) +// To call the Trusted Advisor operations in the Amazon Web Services Support API, +// you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) +// and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For +// more information, see About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) // in the Amazon Web Services Support User Guide. func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *DescribeTrustedAdvisorChecksInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorChecksOutput, error) { if params == nil { @@ -57,30 +51,17 @@ type DescribeTrustedAdvisorChecksInput struct { // The ISO 639-1 code for the language that you want your checks to appear in. The // Amazon Web Services Support API currently supports the following languages for // Trusted Advisor: - // - // * Chinese, Simplified - zh - // - // * Chinese, Traditional - zh_TW - // - // * - // English - en - // - // * French - fr - // - // * German - de - // - // * Indonesian - id - // - // * Italian - it - // - // * - // Japanese - ja - // - // * Korean - ko - // - // * Portuguese, Brazilian - pt_BR - // - // * Spanish - es + // - Chinese, Simplified - zh + // - Chinese, Traditional - zh_TW + // - English - en + // - French - fr + // - German - de + // - Indonesian - id + // - Italian - it + // - Japanese - ja + // - Korean - ko + // - Portuguese, Brazilian - pt_BR + // - Spanish - es // // This member is required. Language *string diff --git a/service/support/api_op_RefreshTrustedAdvisorCheck.go b/service/support/api_op_RefreshTrustedAdvisorCheck.go index f5064271550..148c483eafb 100644 --- a/service/support/api_op_RefreshTrustedAdvisorCheck.go +++ b/service/support/api_op_RefreshTrustedAdvisorCheck.go @@ -11,28 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Refreshes the Trusted Advisor check that you specify using the check ID. You can -// get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some -// checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck -// operation to refresh them, you might see the InvalidParameterValue error. The -// response contains a TrustedAdvisorCheckRefreshStatus object. +// Refreshes the Trusted Advisor check that you specify using the check ID. You +// can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. +// Some checks are refreshed automatically. If you call the +// RefreshTrustedAdvisorCheck operation to refresh them, you might see the +// InvalidParameterValue error. The response contains a +// TrustedAdvisorCheckRefreshStatus object. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . // -// * You must have a -// Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web -// Services Support API. -// -// * If you call the Amazon Web Services Support API from an -// account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support -// plan, the SubscriptionRequiredException error message appears. For information -// about changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// To call the Trusted Advisor operations -// in the Amazon Web Services Support API, you must use the US East (N. Virginia) -// endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't -// support the Trusted Advisor operations. For more information, see About the -// Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) +// To call the Trusted Advisor operations in the Amazon Web Services Support API, +// you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) +// and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For +// more information, see About the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) // in the Amazon Web Services Support User Guide. func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *RefreshTrustedAdvisorCheckInput, optFns ...func(*Options)) (*RefreshTrustedAdvisorCheckOutput, error) { if params == nil { diff --git a/service/support/api_op_ResolveCase.go b/service/support/api_op_ResolveCase.go index 275ab8817ff..555e5232332 100644 --- a/service/support/api_op_ResolveCase.go +++ b/service/support/api_op_ResolveCase.go @@ -12,16 +12,13 @@ import ( // Resolves a support case. This operation takes a caseId and returns the initial // and final state of the case. -// -// * You must have a Business, Enterprise On-Ramp, or -// Enterprise Support plan to use the Amazon Web Services Support API. -// -// * If you -// call the Amazon Web Services Support API from an account that doesn't have a -// Business, Enterprise On-Ramp, or Enterprise Support plan, the -// SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . func (c *Client) ResolveCase(ctx context.Context, params *ResolveCaseInput, optFns ...func(*Options)) (*ResolveCaseOutput, error) { if params == nil { params = &ResolveCaseInput{} diff --git a/service/support/doc.go b/service/support/doc.go index a8218aba2e2..703888aad62 100644 --- a/service/support/doc.go +++ b/service/support/doc.go @@ -1,53 +1,41 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package support provides the API client, operations, and parameter types for AWS -// Support. +// Package support provides the API client, operations, and parameter types for +// AWS Support. // // Amazon Web Services Support The Amazon Web Services Support API Reference is // intended for programmers who need detailed information about the Amazon Web // Services Support operations and data types. You can use the API to manage your // support cases programmatically. The Amazon Web Services Support API uses HTTP // methods that return results in JSON format. -// -// * You must have a Business, -// Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services -// Support API. -// -// * If you call the Amazon Web Services Support API from an account -// that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, -// the SubscriptionRequiredException error message appears. For information about -// changing your support plan, see Amazon Web Services Support -// (http://aws.amazon.com/premiumsupport/). -// -// You can also use the Amazon Web -// Services Support API to access features for Trusted Advisor -// (http://aws.amazon.com/premiumsupport/trustedadvisor/). You can return a list of -// checks and their descriptions, get check results, specify checks to refresh, and -// get the refresh status of checks. You can manage your support cases with the -// following Amazon Web Services Support API operations: -// -// * The CreateCase, -// DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web -// Services Support cases, retrieve information about cases, and resolve cases. -// -// * -// The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet -// operations retrieve and add communications and attachments to Amazon Web -// Services Support cases. -// -// * The DescribeServices and DescribeSeverityLevels -// operations return Amazon Web Service names, service codes, service categories, -// and problem severity levels. You use these values when you call the CreateCase -// operation. -// -// You can also use the Amazon Web Services Support API to call the -// Trusted Advisor operations. For more information, see Trusted Advisor -// (https://docs.aws.amazon.com/) in the Amazon Web Services Support User Guide. -// For authentication of requests, Amazon Web Services Support uses Signature -// Version 4 Signing Process -// (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). For -// more information about this service and the endpoints to use, see About the -// Amazon Web Services Support API -// (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html) in -// the Amazon Web Services Support User Guide. +// - You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to +// use the Amazon Web Services Support API. +// - If you call the Amazon Web Services Support API from an account that +// doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the +// SubscriptionRequiredException error message appears. For information about +// changing your support plan, see Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) +// . +// +// You can also use the Amazon Web Services Support API to access features for +// Trusted Advisor (http://aws.amazon.com/premiumsupport/trustedadvisor/) . You can +// return a list of checks and their descriptions, get check results, specify +// checks to refresh, and get the refresh status of checks. You can manage your +// support cases with the following Amazon Web Services Support API operations: +// - The CreateCase , DescribeCases , DescribeAttachment , and ResolveCase +// operations create Amazon Web Services Support cases, retrieve information about +// cases, and resolve cases. +// - The DescribeCommunications , AddCommunicationToCase , and +// AddAttachmentsToSet operations retrieve and add communications and attachments +// to Amazon Web Services Support cases. +// - The DescribeServices and DescribeSeverityLevels operations return Amazon Web +// Service names, service codes, service categories, and problem severity levels. +// You use these values when you call the CreateCase operation. +// +// You can also use the Amazon Web Services Support API to call the Trusted +// Advisor operations. For more information, see Trusted Advisor (https://docs.aws.amazon.com/) +// in the Amazon Web Services Support User Guide. For authentication of requests, +// Amazon Web Services Support uses Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// . For more information about this service and the endpoints to use, see About +// the Amazon Web Services Support API (https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html) +// in the Amazon Web Services Support User Guide. package support diff --git a/service/support/types/types.go b/service/support/types/types.go index d17da683891..8ed57039d38 100644 --- a/service/support/types/types.go +++ b/service/support/types/types.go @@ -33,64 +33,38 @@ type AttachmentDetails struct { } // A JSON-formatted object that contains the metadata for a support case. It is -// contained in the response from a DescribeCases request. CaseDetails contains the -// following fields: -// -// * caseId - The support case ID requested or returned in the -// call. The case ID is an alphanumeric string formatted as shown in this example: -// case-12345678910-2013-c4c1d2bf33c5cf47. -// -// * categoryCode - The category of -// problem for the support case. Corresponds to the CategoryCode values returned by -// a call to DescribeServices. -// -// * displayId - The identifier for the case on pages -// in the Amazon Web Services Support Center. -// -// * language - The language in which -// Amazon Web Services Support handles the case. Amazon Web Services Support -// currently supports English ("en") and Japanese ("ja"). You must specify the ISO -// 639-1 code for the language parameter if you want support in that language. -// -// * -// nextToken - A resumption point for pagination. -// -// * recentCommunications - One or -// more Communication objects. Fields of these objects are attachments, body, -// caseId, submittedBy, and timeCreated. -// -// * serviceCode - The identifier for the -// Amazon Web Services service that corresponds to the service code defined in the -// call to DescribeServices. -// -// * severityCode - The severity code assigned to the -// case. Contains one of the values returned by the call to DescribeSeverityLevels. -// The possible values are: low, normal, high, urgent, and critical. -// -// * status - -// The status of the case in the Amazon Web Services Support Center. Valid -// values: -// -// * opened -// -// * pending-customer-action -// -// * reopened -// -// * resolved -// -// * -// unassigned -// -// * work-in-progress -// -// * subject - The subject line of the case. -// -// * -// submittedBy - The email address of the account that submitted the case. -// -// * -// timeCreated - The time the case was created, in ISO-8601 format. +// contained in the response from a DescribeCases request. CaseDetails contains +// the following fields: +// - caseId - The support case ID requested or returned in the call. The case ID +// is an alphanumeric string formatted as shown in this example: +// case-12345678910-2013-c4c1d2bf33c5cf47. +// - categoryCode - The category of problem for the support case. Corresponds to +// the CategoryCode values returned by a call to DescribeServices . +// - displayId - The identifier for the case on pages in the Amazon Web Services +// Support Center. +// - language - The language in which Amazon Web Services Support handles the +// case. Amazon Web Services Support currently supports English ("en") and Japanese +// ("ja"). You must specify the ISO 639-1 code for the language parameter if you +// want support in that language. +// - nextToken - A resumption point for pagination. +// - recentCommunications - One or more Communication objects. Fields of these +// objects are attachments , body , caseId , submittedBy , and timeCreated . +// - serviceCode - The identifier for the Amazon Web Services service that +// corresponds to the service code defined in the call to DescribeServices . +// - severityCode - The severity code assigned to the case. Contains one of the +// values returned by the call to DescribeSeverityLevels . The possible values +// are: low , normal , high , urgent , and critical . +// - status - The status of the case in the Amazon Web Services Support Center. +// Valid values: +// - opened +// - pending-customer-action +// - reopened +// - resolved +// - unassigned +// - work-in-progress +// - subject - The subject line of the case. +// - submittedBy - The email address of the account that submitted the case. +// - timeCreated - The time the case was created, in ISO-8601 format. type CaseDetails struct { // The support case ID requested or returned in the call. The case ID is an @@ -104,8 +78,8 @@ type CaseDetails struct { // The email addresses that receive copies of communication about the case. CcEmailAddresses []string - // The ID displayed for the case in the Amazon Web Services Support Center. This is - // a numeric string. + // The ID displayed for the case in the Amazon Web Services Support Center. This + // is a numeric string. DisplayId *string // The language in which Amazon Web Services Support handles the case. Amazon Web @@ -120,26 +94,19 @@ type CaseDetails struct { RecentCommunications *RecentCaseCommunications // The code for the Amazon Web Services service. You can get a list of codes and - // the corresponding service names by calling DescribeServices. + // the corresponding service names by calling DescribeServices . ServiceCode *string - // The code for the severity level returned by the call to DescribeSeverityLevels. + // The code for the severity level returned by the call to DescribeSeverityLevels . SeverityCode *string // The status of the case. Valid values: - // - // * opened - // - // * pending-customer-action - // - // * - // reopened - // - // * resolved - // - // * unassigned - // - // * work-in-progress + // - opened + // - pending-customer-action + // - reopened + // - resolved + // - unassigned + // - work-in-progress Status *string // The subject line for the case in the Amazon Web Services Support Center. @@ -155,8 +122,8 @@ type CaseDetails struct { } // A JSON-formatted name/value pair that represents the category name and category -// code of the problem, selected from the DescribeServices response for each Amazon -// Web Services service. +// code of the problem, selected from the DescribeServices response for each +// Amazon Web Services service. type Category struct { // The category code for the support case. @@ -215,7 +182,7 @@ type Service struct { // A list of categories that describe the type of support issue a case describes. // Categories consist of a category name and a category code. Category names and - // codes are passed to Amazon Web Services Support when you call CreateCase. + // codes are passed to Amazon Web Services Support when you call CreateCase . Categories []Category // The code for an Amazon Web Services service returned by the DescribeServices @@ -231,8 +198,7 @@ type Service struct { // A code and name pair that represents the severity level of a support case. The // available values depend on the support plan for the account. For more -// information, see Choosing a severity -// (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) +// information, see Choosing a severity (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) // in the Amazon Web Services Support User Guide. type SeverityLevel struct { @@ -242,25 +208,15 @@ type SeverityLevel struct { // The name of the severity level that corresponds to the severity level code. The // values returned by the API are different from the values that appear in the - // Amazon Web Services Support Center. For example, the API uses the code low, but + // Amazon Web Services Support Center. For example, the API uses the code low , but // the name appears as General guidance in Support Center. The following are the // API code names and how they appear in the console: - // - // * low - General guidance - // - // * - // normal - System impaired - // - // * high - Production system impaired - // - // * urgent - - // Production system down - // - // * critical - Business-critical system down - // - // For more - // information, see Choosing a severity - // (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) + // - low - General guidance + // - normal - System impaired + // - high - Production system impaired + // - urgent - Production system down + // - critical - Business-critical system down + // For more information, see Choosing a severity (https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity) // in the Amazon Web Services Support User Guide. Name *string @@ -299,9 +255,9 @@ type TrustedAdvisorCheckDescription struct { // The column headings for the data returned by the Trusted Advisor check. The // order of the headings corresponds to the order of the data in the Metadata - // element of the TrustedAdvisorResourceDetail for the check. Metadata contains all - // the data that is shown in the Excel download, even in those cases where the UI - // shows just summary data. + // element of the TrustedAdvisorResourceDetail for the check. Metadata contains + // all the data that is shown in the Excel download, even in those cases where the + // UI shows just summary data. // // This member is required. Metadata []*string @@ -322,28 +278,20 @@ type TrustedAdvisorCheckRefreshStatus struct { // This member is required. CheckId *string - // The amount of time, in milliseconds, until the Trusted Advisor check is eligible - // for refresh. + // The amount of time, in milliseconds, until the Trusted Advisor check is + // eligible for refresh. // // This member is required. MillisUntilNextRefreshable int64 - // The status of the Trusted Advisor check for which a refresh has been - // requested: - // - // * none - The check is not refreshed or the non-success status - // exceeds the timeout - // - // * enqueued - The check refresh requests has entered the - // refresh queue - // - // * processing - The check refresh request is picked up by the rule - // processing engine - // - // * success - The check is successfully refreshed - // - // * abandoned - // - The check refresh has failed + // The status of the Trusted Advisor check for which a refresh has been requested: + // - none - The check is not refreshed or the non-success status exceeds the + // timeout + // - enqueued - The check refresh requests has entered the refresh queue + // - processing - The check refresh request is picked up by the rule processing + // engine + // - success - The check is successfully refreshed + // - abandoned - The check refresh has failed // // This member is required. Status *string @@ -352,7 +300,7 @@ type TrustedAdvisorCheckRefreshStatus struct { } // The results of a Trusted Advisor check returned by -// DescribeTrustedAdvisorCheckResult. +// DescribeTrustedAdvisorCheckResult . type TrustedAdvisorCheckResult struct { // Summary information that relates to the category of the check. Cost Optimizing @@ -372,7 +320,7 @@ type TrustedAdvisorCheckResult struct { FlaggedResources []TrustedAdvisorResourceDetail // Details about Amazon Web Services resources that were analyzed in a call to - // Trusted Advisor DescribeTrustedAdvisorCheckSummaries. + // Trusted Advisor DescribeTrustedAdvisorCheckSummaries . // // This member is required. ResourcesSummary *TrustedAdvisorResourcesSummary @@ -407,7 +355,7 @@ type TrustedAdvisorCheckSummary struct { CheckId *string // Details about Amazon Web Services resources that were analyzed in a call to - // Trusted Advisor DescribeTrustedAdvisorCheckSummaries. + // Trusted Advisor DescribeTrustedAdvisorCheckSummaries . // // This member is required. ResourcesSummary *TrustedAdvisorResourcesSummary @@ -451,11 +399,11 @@ type TrustedAdvisorCostOptimizingSummary struct { // Contains information about a resource identified by a Trusted Advisor check. type TrustedAdvisorResourceDetail struct { - // Additional information about the identified resource. The exact metadata and its - // order can be obtained by inspecting the TrustedAdvisorCheckDescription object - // returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the - // data that is shown in the Excel download, even in those cases where the UI shows - // just summary data. + // Additional information about the identified resource. The exact metadata and + // its order can be obtained by inspecting the TrustedAdvisorCheckDescription + // object returned by the call to DescribeTrustedAdvisorChecks . Metadata contains + // all the data that is shown in the Excel download, even in those cases where the + // UI shows just summary data. // // This member is required. Metadata []*string @@ -481,7 +429,7 @@ type TrustedAdvisorResourceDetail struct { } // Details about Amazon Web Services resources that were analyzed in a call to -// Trusted Advisor DescribeTrustedAdvisorCheckSummaries. +// Trusted Advisor DescribeTrustedAdvisorCheckSummaries . type TrustedAdvisorResourcesSummary struct { // The number of Amazon Web Services resources that were flagged (listed) by the diff --git a/service/supportapp/api_client.go b/service/supportapp/api_client.go index 28b2f4f77e1..089c50b6158 100644 --- a/service/supportapp/api_client.go +++ b/service/supportapp/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/supportapp/api_op_CreateSlackChannelConfiguration.go b/service/supportapp/api_op_CreateSlackChannelConfiguration.go index db2e79619be..b57f6c15690 100644 --- a/service/supportapp/api_op_CreateSlackChannelConfiguration.go +++ b/service/supportapp/api_op_CreateSlackChannelConfiguration.go @@ -12,22 +12,18 @@ import ( ) // Creates a Slack channel configuration for your Amazon Web Services account. +// - You can add up to 5 Slack workspaces for your account. +// - You can add up to 20 Slack channels for your account. // -// * -// You can add up to 5 Slack workspaces for your account. -// -// * You can add up to 20 -// Slack channels for your account. -// -// A Slack channel can have up to 100 Amazon Web -// Services accounts. This means that only 100 accounts can add the same Slack -// channel to the Amazon Web Services Support App. We recommend that you only add -// the accounts that you need to manage support cases for your organization. This -// can reduce the notifications about case updates that you receive in the Slack -// channel. We recommend that you choose a private Slack channel so that only -// members in that channel have read and write access to your support cases. Anyone -// in your Slack channel can create, update, or resolve support cases for your -// account. Users require an invitation to join private channels. +// A Slack channel can have up to 100 Amazon Web Services accounts. This means +// that only 100 accounts can add the same Slack channel to the Amazon Web Services +// Support App. We recommend that you only add the accounts that you need to manage +// support cases for your organization. This can reduce the notifications about +// case updates that you receive in the Slack channel. We recommend that you choose +// a private Slack channel so that only members in that channel have read and write +// access to your support cases. Anyone in your Slack channel can create, update, +// or resolve support cases for your account. Users require an invitation to join +// private channels. func (c *Client) CreateSlackChannelConfiguration(ctx context.Context, params *CreateSlackChannelConfigurationInput, optFns ...func(*Options)) (*CreateSlackChannelConfigurationOutput, error) { if params == nil { params = &CreateSlackChannelConfigurationInput{} @@ -52,42 +48,29 @@ type CreateSlackChannelConfigurationInput struct { // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform // operations on Amazon Web Services. For more information, see Managing access to - // the Amazon Web Services Support App - // (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) // in the Amazon Web Services Support User Guide. // // This member is required. ChannelRoleArn *string // The case severity for a support case that you want to receive notifications. If - // you specify high or all, you must specify true for at least one of the following - // parameters: - // - // * notifyOnAddCorrespondenceToCase - // - // * notifyOnCreateOrReopenCase - // - // * - // notifyOnResolveCase - // - // If you specify none, the following parameters must be null - // or false: - // - // * notifyOnAddCorrespondenceToCase - // - // * notifyOnCreateOrReopenCase - // - // * - // notifyOnResolveCase - // - // If you don't specify these parameters in your request, they - // default to false. + // you specify high or all , you must specify true for at least one of the + // following parameters: + // - notifyOnAddCorrespondenceToCase + // - notifyOnCreateOrReopenCase + // - notifyOnResolveCase + // If you specify none , the following parameters must be null or false : + // - notifyOnAddCorrespondenceToCase + // - notifyOnCreateOrReopenCase + // - notifyOnResolveCase + // If you don't specify these parameters in your request, they default to false . // // This member is required. NotifyOnCaseSeverity types.NotificationSeverityLevel // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string diff --git a/service/supportapp/api_op_DeleteAccountAlias.go b/service/supportapp/api_op_DeleteAccountAlias.go index 1410979f015..80d1c56e1a2 100644 --- a/service/supportapp/api_op_DeleteAccountAlias.go +++ b/service/supportapp/api_op_DeleteAccountAlias.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an alias for an Amazon Web Services account ID. The alias appears in the -// Amazon Web Services Support App page of the Amazon Web Services Support Center. -// The alias also appears in Slack messages from the Amazon Web Services Support -// App. +// Deletes an alias for an Amazon Web Services account ID. The alias appears in +// the Amazon Web Services Support App page of the Amazon Web Services Support +// Center. The alias also appears in Slack messages from the Amazon Web Services +// Support App. func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAliasInput, optFns ...func(*Options)) (*DeleteAccountAliasOutput, error) { if params == nil { params = &DeleteAccountAliasInput{} diff --git a/service/supportapp/api_op_DeleteSlackChannelConfiguration.go b/service/supportapp/api_op_DeleteSlackChannelConfiguration.go index fb6c2f04b9c..e8b84b25b52 100644 --- a/service/supportapp/api_op_DeleteSlackChannelConfiguration.go +++ b/service/supportapp/api_op_DeleteSlackChannelConfiguration.go @@ -35,7 +35,7 @@ type DeleteSlackChannelConfigurationInput struct { ChannelId *string // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string diff --git a/service/supportapp/api_op_DeleteSlackWorkspaceConfiguration.go b/service/supportapp/api_op_DeleteSlackWorkspaceConfiguration.go index d0918bd0133..0337c194ed9 100644 --- a/service/supportapp/api_op_DeleteSlackWorkspaceConfiguration.go +++ b/service/supportapp/api_op_DeleteSlackWorkspaceConfiguration.go @@ -30,7 +30,7 @@ func (c *Client) DeleteSlackWorkspaceConfiguration(ctx context.Context, params * type DeleteSlackWorkspaceConfigurationInput struct { // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string diff --git a/service/supportapp/api_op_GetAccountAlias.go b/service/supportapp/api_op_GetAccountAlias.go index ecc24ae8dc2..10bc13e9306 100644 --- a/service/supportapp/api_op_GetAccountAlias.go +++ b/service/supportapp/api_op_GetAccountAlias.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the alias from an Amazon Web Services account ID. The alias appears in -// the Amazon Web Services Support App page of the Amazon Web Services Support +// Retrieves the alias from an Amazon Web Services account ID. The alias appears +// in the Amazon Web Services Support App page of the Amazon Web Services Support // Center. The alias also appears in Slack messages from the Amazon Web Services // Support App. func (c *Client) GetAccountAlias(ctx context.Context, params *GetAccountAliasInput, optFns ...func(*Options)) (*GetAccountAliasOutput, error) { diff --git a/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go b/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go index 638535c54ce..8fe8ca432fd 100644 --- a/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go +++ b/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go @@ -15,34 +15,27 @@ import ( // API, your account must be part of an organization in Organizations. If you're // the management account and you want to register Slack workspaces for your // organization, you must complete the following tasks: +// - Sign in to the Amazon Web Services Support Center (https://console.aws.amazon.com/support/app) +// and authorize the Slack workspaces where you want your organization to have +// access to. See Authorize a Slack workspace (https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html) +// in the Amazon Web Services Support User Guide. +// - Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack +// workspace for the organization. // -// * Sign in to the Amazon -// Web Services Support Center (https://console.aws.amazon.com/support/app) and -// authorize the Slack workspaces where you want your organization to have access -// to. See Authorize a Slack workspace -// (https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html) -// in the Amazon Web Services Support User Guide. -// -// * Call the -// RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for -// the organization. -// -// After the management account authorizes the Slack workspace, -// member accounts can call this API to authorize the same Slack workspace for -// their individual accounts. Member accounts don't need to authorize the Slack -// workspace manually through the Amazon Web Services Support Center -// (https://console.aws.amazon.com/support/app). To use the Amazon Web Services -// Support App, each account must then complete the following tasks: -// -// * Create an -// Identity and Access Management (IAM) role with the required permission. For more -// information, see Managing access to the Amazon Web Services Support App -// (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html). -// -// * -// Configure a Slack channel to use the Amazon Web Services Support App for support -// cases for that account. For more information, see Configuring a Slack channel -// (https://docs.aws.amazon.com/awssupport/latest/user/add-your-slack-channel.html). +// After the management account authorizes the Slack workspace, member accounts +// can call this API to authorize the same Slack workspace for their individual +// accounts. Member accounts don't need to authorize the Slack workspace manually +// through the Amazon Web Services Support Center (https://console.aws.amazon.com/support/app) +// . To use the Amazon Web Services Support App, each account must then complete +// the following tasks: +// - Create an Identity and Access Management (IAM) role with the required +// permission. For more information, see Managing access to the Amazon Web +// Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) +// . +// - Configure a Slack channel to use the Amazon Web Services Support App for +// support cases for that account. For more information, see Configuring a Slack +// channel (https://docs.aws.amazon.com/awssupport/latest/user/add-your-slack-channel.html) +// . func (c *Client) RegisterSlackWorkspaceForOrganization(ctx context.Context, params *RegisterSlackWorkspaceForOrganizationInput, optFns ...func(*Options)) (*RegisterSlackWorkspaceForOrganizationOutput, error) { if params == nil { params = &RegisterSlackWorkspaceForOrganizationInput{} @@ -61,7 +54,7 @@ func (c *Client) RegisterSlackWorkspaceForOrganization(ctx context.Context, para type RegisterSlackWorkspaceForOrganizationInput struct { // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. Specify the Slack workspace that you want to use for your + // T012ABCDEFG . Specify the Slack workspace that you want to use for your // organization. // // This member is required. @@ -72,12 +65,12 @@ type RegisterSlackWorkspaceForOrganizationInput struct { type RegisterSlackWorkspaceForOrganizationOutput struct { - // Whether the Amazon Web Services account is a management or member account that's - // part of an organization in Organizations. + // Whether the Amazon Web Services account is a management or member account + // that's part of an organization in Organizations. AccountType types.AccountType // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . TeamId *string // The name of the Slack workspace. diff --git a/service/supportapp/api_op_UpdateSlackChannelConfiguration.go b/service/supportapp/api_op_UpdateSlackChannelConfiguration.go index cbedc3209d6..3dcbe7f501b 100644 --- a/service/supportapp/api_op_UpdateSlackChannelConfiguration.go +++ b/service/supportapp/api_op_UpdateSlackChannelConfiguration.go @@ -36,7 +36,7 @@ type UpdateSlackChannelConfigurationInput struct { ChannelId *string // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string @@ -46,8 +46,7 @@ type UpdateSlackChannelConfigurationInput struct { // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform // operations on Amazon Web Services. For more information, see Managing access to - // the Amazon Web Services Support App - // (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) // in the Amazon Web Services Support User Guide. ChannelRoleArn *string @@ -55,29 +54,18 @@ type UpdateSlackChannelConfigurationInput struct { NotifyOnAddCorrespondenceToCase *bool // The case severity for a support case that you want to receive notifications. If - // you specify high or all, at least one of the following parameters must be - // true: - // - // * notifyOnAddCorrespondenceToCase - // - // * notifyOnCreateOrReopenCase - // - // * - // notifyOnResolveCase - // - // If you specify none, any of the following parameters that - // you specify in your request must be false: - // - // * notifyOnAddCorrespondenceToCase - // - // * - // notifyOnCreateOrReopenCase - // - // * notifyOnResolveCase - // - // If you don't specify these - // parameters in your request, the Amazon Web Services Support App uses the current - // values by default. + // you specify high or all , at least one of the following parameters must be true + // : + // - notifyOnAddCorrespondenceToCase + // - notifyOnCreateOrReopenCase + // - notifyOnResolveCase + // If you specify none , any of the following parameters that you specify in your + // request must be false : + // - notifyOnAddCorrespondenceToCase + // - notifyOnCreateOrReopenCase + // - notifyOnResolveCase + // If you don't specify these parameters in your request, the Amazon Web Services + // Support App uses the current values by default. NotifyOnCaseSeverity types.NotificationSeverityLevel // Whether you want to get notified when a support case is created or reopened. @@ -100,8 +88,7 @@ type UpdateSlackChannelConfigurationOutput struct { // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform // operations on Amazon Web Services. For more information, see Managing access to - // the Amazon Web Services Support App - // (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) // in the Amazon Web Services Support User Guide. ChannelRoleArn *string @@ -118,7 +105,7 @@ type UpdateSlackChannelConfigurationOutput struct { NotifyOnResolveCase *bool // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . TeamId *string // Metadata pertaining to the operation's result. diff --git a/service/supportapp/doc.go b/service/supportapp/doc.go index 70670e55fe5..cbb96157c56 100644 --- a/service/supportapp/doc.go +++ b/service/supportapp/doc.go @@ -8,49 +8,26 @@ // Web Services account. After you configure your Slack workspace and channel with // the Amazon Web Services Support App, you can perform the following tasks // directly in your Slack channel: -// -// * Create, search, update, and resolve your -// support cases -// -// * Request service quota increases for your account -// -// * Invite -// Amazon Web Services Support agents to your channel so that you can chat directly -// about your support cases -// -// For more information about how to perform these -// actions in Slack, see the following documentation in the Amazon Web Services -// Support User Guide: -// -// * Amazon Web Services Support App in Slack -// (https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html) -// -// * -// Joining a live chat session with Amazon Web Services Support -// (https://docs.aws.amazon.com/awssupport/latest/user/joining-a-live-chat-session.html) -// -// * -// Requesting service quota increases -// (https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html) -// -// * -// Amazon Web Services Support App commands in Slack -// (https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html) -// -// You -// can also use the Amazon Web Services Management Console instead of the Amazon -// Web Services Support App API to manage your Slack configurations. For more -// information, see Authorize a Slack workspace to enable the Amazon Web Services -// Support App -// (https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html). -// -// * -// You must have a Business or Enterprise Support plan to use the Amazon Web -// Services Support App API. -// -// * For more information about the Amazon Web Services -// Support App endpoints, see the Amazon Web Services Support App in Slack -// endpoints -// (https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region) -// in the Amazon Web Services General Reference. +// - Create, search, update, and resolve your support cases +// - Request service quota increases for your account +// - Invite Amazon Web Services Support agents to your channel so that you can +// chat directly about your support cases +// +// For more information about how to perform these actions in Slack, see the +// following documentation in the Amazon Web Services Support User Guide: +// - Amazon Web Services Support App in Slack (https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html) +// - Joining a live chat session with Amazon Web Services Support (https://docs.aws.amazon.com/awssupport/latest/user/joining-a-live-chat-session.html) +// - Requesting service quota increases (https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html) +// - Amazon Web Services Support App commands in Slack (https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html) +// +// You can also use the Amazon Web Services Management Console instead of the +// Amazon Web Services Support App API to manage your Slack configurations. For +// more information, see Authorize a Slack workspace to enable the Amazon Web +// Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html) +// . +// - You must have a Business or Enterprise Support plan to use the Amazon Web +// Services Support App API. +// - For more information about the Amazon Web Services Support App endpoints, +// see the Amazon Web Services Support App in Slack endpoints (https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region) +// in the Amazon Web Services General Reference. package supportapp diff --git a/service/supportapp/types/errors.go b/service/supportapp/types/errors.go index 15a1ba4ad7f..c081e40de69 100644 --- a/service/supportapp/types/errors.go +++ b/service/supportapp/types/errors.go @@ -35,27 +35,18 @@ func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.F // Your request has a conflict. For example, you might receive this error if you // try the following: -// -// * Add, update, or delete a Slack channel configuration -// before you add a Slack workspace to your Amazon Web Services account. -// -// * Add a -// Slack channel configuration that already exists in your Amazon Web Services -// account. -// -// * Delete a Slack channel configuration for a live chat channel. -// -// * -// Delete a Slack workspace from your Amazon Web Services account that has an -// active live chat channel. -// -// * Call the RegisterSlackWorkspaceForOrganization API -// from an Amazon Web Services account that doesn't belong to an organization. -// -// * -// Call the RegisterSlackWorkspaceForOrganization API from a member account, but -// the management account hasn't registered that workspace yet for the -// organization. +// - Add, update, or delete a Slack channel configuration before you add a Slack +// workspace to your Amazon Web Services account. +// - Add a Slack channel configuration that already exists in your Amazon Web +// Services account. +// - Delete a Slack channel configuration for a live chat channel. +// - Delete a Slack workspace from your Amazon Web Services account that has an +// active live chat channel. +// - Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web +// Services account that doesn't belong to an organization. +// - Call the RegisterSlackWorkspaceForOrganization API from a member account, +// but the management account hasn't registered that workspace yet for the +// organization. type ConflictException struct { Message *string @@ -135,8 +126,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Your Service Quotas request exceeds the quota for the service. For example, your -// Service Quotas request to Amazon Web Services Support App might exceed the +// Your Service Quotas request exceeds the quota for the service. For example, +// your Service Quotas request to Amazon Web Services Support App might exceed the // maximum number of workspaces or channels per account, or the maximum number of // accounts per Slack channel. type ServiceQuotaExceededException struct { diff --git a/service/supportapp/types/types.go b/service/supportapp/types/types.go index 451b2e09e3f..7f18fd92095 100644 --- a/service/supportapp/types/types.go +++ b/service/supportapp/types/types.go @@ -16,7 +16,7 @@ type SlackChannelConfiguration struct { ChannelId *string // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string @@ -27,8 +27,7 @@ type SlackChannelConfiguration struct { // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform // operations on Amazon Web Services. For more information, see Managing access to - // the Amazon Web Services Support App - // (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) // in the Amazon Web Services Support User Guide. ChannelRoleArn *string @@ -47,12 +46,12 @@ type SlackChannelConfiguration struct { noSmithyDocumentSerde } -// The configuration for a Slack workspace that you added to an Amazon Web Services -// account. +// The configuration for a Slack workspace that you added to an Amazon Web +// Services account. type SlackWorkspaceConfiguration struct { // The team ID in Slack. This ID uniquely identifies a Slack workspace, such as - // T012ABCDEFG. + // T012ABCDEFG . // // This member is required. TeamId *string diff --git a/service/swf/api_client.go b/service/swf/api_client.go index 1c1646a4311..6b121c70c97 100644 --- a/service/swf/api_client.go +++ b/service/swf/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/swf/api_op_CountClosedWorkflowExecutions.go b/service/swf/api_op_CountClosedWorkflowExecutions.go index 9823c1beb55..f32d45363a8 100644 --- a/service/swf/api_op_CountClosedWorkflowExecutions.go +++ b/service/swf/api_op_CountClosedWorkflowExecutions.go @@ -16,32 +16,20 @@ import ( // The results are best effort and may not exactly reflect recent updates and // changes. Access Control You can use IAM policies to control this action's access // to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagFilter.tag : String constraint. The key is swf:tagFilter.tag . +// - typeFilter.name : String constraint. The key is swf:typeFilter.name . +// - typeFilter.version : String constraint. The key is swf:typeFilter.version . // -// * Use a Resource element with the domain -// name to limit the action to only specified domains. -// -// * Use an Action element to -// allow or deny permission to call this action. -// -// * Constrain the following -// parameters by using a Condition element with the appropriate keys. -// -// * -// tagFilter.tag: String constraint. The key is swf:tagFilter.tag. -// -// * -// typeFilter.name: String constraint. The key is swf:typeFilter.name. -// -// * -// typeFilter.version: String constraint. The key is swf:typeFilter.version. -// -// If -// the caller doesn't have sufficient permissions to invoke the action, or the +// If the caller doesn't have sufficient permissions to invoke the action, or the // parameter values fall outside the specified constraints, the action fails. The -// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . // For details and example IAM policies, see Using IAM to Manage Access to Amazon -// SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) CountClosedWorkflowExecutions(ctx context.Context, params *CountClosedWorkflowExecutionsInput, optFns ...func(*Options)) (*CountClosedWorkflowExecutionsOutput, error) { if params == nil { @@ -65,10 +53,10 @@ type CountClosedWorkflowExecutionsInput struct { // This member is required. Domain *string - // If specified, only workflow executions that match this close status are counted. - // This filter has an affect only if executionStatus is specified as CLOSED. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually - // exclusive. You can specify at most one of these in a request. + // If specified, only workflow executions that match this close status are + // counted. This filter has an affect only if executionStatus is specified as + // CLOSED . closeStatusFilter , executionFilter , typeFilter and tagFilter are + // mutually exclusive. You can specify at most one of these in a request. CloseStatusFilter *types.CloseStatusFilter // If specified, only workflow executions that meet the close time criteria of the @@ -76,8 +64,8 @@ type CountClosedWorkflowExecutionsInput struct { // You must specify one of these in a request but not both. CloseTimeFilter *types.ExecutionTimeFilter - // If specified, only workflow executions matching the WorkflowId in the filter are - // counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are + // If specified, only workflow executions matching the WorkflowId in the filter + // are counted. closeStatusFilter , executionFilter , typeFilter and tagFilter are // mutually exclusive. You can specify at most one of these in a request. ExecutionFilter *types.WorkflowExecutionFilter @@ -87,12 +75,12 @@ type CountClosedWorkflowExecutionsInput struct { StartTimeFilter *types.ExecutionTimeFilter // If specified, only executions that have a tag that matches the filter are - // counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are + // counted. closeStatusFilter , executionFilter , typeFilter and tagFilter are // mutually exclusive. You can specify at most one of these in a request. TagFilter *types.TagFilter // If specified, indicates the type of the workflow executions to be counted. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually + // closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter diff --git a/service/swf/api_op_CountOpenWorkflowExecutions.go b/service/swf/api_op_CountOpenWorkflowExecutions.go index 947b68a4f27..abb11123ff5 100644 --- a/service/swf/api_op_CountOpenWorkflowExecutions.go +++ b/service/swf/api_op_CountOpenWorkflowExecutions.go @@ -11,36 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the number of open workflow executions within the given domain that meet -// the specified filtering criteria. This operation is eventually consistent. The -// results are best effort and may not exactly reflect recent updates and changes. -// Access Control You can use IAM policies to control this action's access to -// Amazon SWF resources as follows: +// Returns the number of open workflow executions within the given domain that +// meet the specified filtering criteria. This operation is eventually consistent. +// The results are best effort and may not exactly reflect recent updates and +// changes. Access Control You can use IAM policies to control this action's access +// to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagFilter.tag : String constraint. The key is swf:tagFilter.tag . +// - typeFilter.name : String constraint. The key is swf:typeFilter.name . +// - typeFilter.version : String constraint. The key is swf:typeFilter.version . // -// * Use a Resource element with the domain name -// to limit the action to only specified domains. -// -// * Use an Action element to allow -// or deny permission to call this action. -// -// * Constrain the following parameters by -// using a Condition element with the appropriate keys. -// -// * tagFilter.tag: String -// constraint. The key is swf:tagFilter.tag. -// -// * typeFilter.name: String constraint. -// The key is swf:typeFilter.name. -// -// * typeFilter.version: String constraint. The -// key is swf:typeFilter.version. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) CountOpenWorkflowExecutions(ctx context.Context, params *CountOpenWorkflowExecutionsInput, optFns ...func(*Options)) (*CountOpenWorkflowExecutionsOutput, error) { if params == nil { @@ -64,23 +53,23 @@ type CountOpenWorkflowExecutionsInput struct { // This member is required. Domain *string - // Specifies the start time criteria that workflow executions must meet in order to - // be counted. + // Specifies the start time criteria that workflow executions must meet in order + // to be counted. // // This member is required. StartTimeFilter *types.ExecutionTimeFilter - // If specified, only workflow executions matching the WorkflowId in the filter are - // counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You - // can specify at most one of these in a request. + // If specified, only workflow executions matching the WorkflowId in the filter + // are counted. executionFilter , typeFilter and tagFilter are mutually exclusive. + // You can specify at most one of these in a request. ExecutionFilter *types.WorkflowExecutionFilter // If specified, only executions that have a tag that matches the filter are - // counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You + // counted. executionFilter , typeFilter and tagFilter are mutually exclusive. You // can specify at most one of these in a request. TagFilter *types.TagFilter - // Specifies the type of the workflow executions to be counted. executionFilter, + // Specifies the type of the workflow executions to be counted. executionFilter , // typeFilter and tagFilter are mutually exclusive. You can specify at most one of // these in a request. TypeFilter *types.WorkflowTypeFilter diff --git a/service/swf/api_op_CountPendingActivityTasks.go b/service/swf/api_op_CountPendingActivityTasks.go index 06af02b491a..c24a8c24902 100644 --- a/service/swf/api_op_CountPendingActivityTasks.go +++ b/service/swf/api_op_CountPendingActivityTasks.go @@ -16,23 +16,17 @@ import ( // specify a task list that no activity task was ever scheduled in then 0 is // returned. Access Control You can use IAM policies to control this action's // access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the taskList.name parameter by using a Condition element with the +// swf:taskList.name key to allow the action to access only certain task lists. // -// * Use a Resource element with the -// domain name to limit the action to only specified domains. -// -// * Use an Action -// element to allow or deny permission to call this action. -// -// * Constrain the -// taskList.name parameter by using a Condition element with the swf:taskList.name -// key to allow the action to access only certain task lists. -// -// If the caller -// doesn't have sufficient permissions to invoke the action, or the parameter -// values fall outside the specified constraints, the action fails. The associated -// event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details -// and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) CountPendingActivityTasks(ctx context.Context, params *CountPendingActivityTasksInput, optFns ...func(*Options)) (*CountPendingActivityTasksOutput, error) { if params == nil { diff --git a/service/swf/api_op_CountPendingDecisionTasks.go b/service/swf/api_op_CountPendingDecisionTasks.go index 397c5bd15a0..55fc9177d34 100644 --- a/service/swf/api_op_CountPendingDecisionTasks.go +++ b/service/swf/api_op_CountPendingDecisionTasks.go @@ -16,23 +16,17 @@ import ( // specify a task list that no decision task was ever scheduled in then 0 is // returned. Access Control You can use IAM policies to control this action's // access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the taskList.name parameter by using a Condition element with the +// swf:taskList.name key to allow the action to access only certain task lists. // -// * Use a Resource element with the -// domain name to limit the action to only specified domains. -// -// * Use an Action -// element to allow or deny permission to call this action. -// -// * Constrain the -// taskList.name parameter by using a Condition element with the swf:taskList.name -// key to allow the action to access only certain task lists. -// -// If the caller -// doesn't have sufficient permissions to invoke the action, or the parameter -// values fall outside the specified constraints, the action fails. The associated -// event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details -// and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) CountPendingDecisionTasks(ctx context.Context, params *CountPendingDecisionTasksInput, optFns ...func(*Options)) (*CountPendingDecisionTasksOutput, error) { if params == nil { diff --git a/service/swf/api_op_DeprecateActivityType.go b/service/swf/api_op_DeprecateActivityType.go index 93ce6ebe974..d4754e4d0f6 100644 --- a/service/swf/api_op_DeprecateActivityType.go +++ b/service/swf/api_op_DeprecateActivityType.go @@ -17,29 +17,20 @@ import ( // operation is eventually consistent. The results are best effort and may not // exactly reflect recent updates and changes. Access Control You can use IAM // policies to control this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - activityType.name : String constraint. The key is swf:activityType.name . +// - activityType.version : String constraint. The key is +// swf:activityType.version . // -// * -// Use a Resource element with the domain name to limit the action to only -// specified domains. -// -// * Use an Action element to allow or deny permission to call -// this action. -// -// * Constrain the following parameters by using a Condition element -// with the appropriate keys. -// -// * activityType.name: String constraint. The key is -// swf:activityType.name. -// -// * activityType.version: String constraint. The key is -// swf:activityType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DeprecateActivityType(ctx context.Context, params *DeprecateActivityTypeInput, optFns ...func(*Options)) (*DeprecateActivityTypeOutput, error) { if params == nil { diff --git a/service/swf/api_op_DeprecateDomain.go b/service/swf/api_op_DeprecateDomain.go index 84f640a8da0..aa300abe914 100644 --- a/service/swf/api_op_DeprecateDomain.go +++ b/service/swf/api_op_DeprecateDomain.go @@ -10,31 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprecates the specified domain. After a domain has been deprecated it cannot be -// used to create new workflow executions or register new types. However, you can -// still use visibility actions on this domain. Deprecating a domain also +// Deprecates the specified domain. After a domain has been deprecated it cannot +// be used to create new workflow executions or register new types. However, you +// can still use visibility actions on this domain. Deprecating a domain also // deprecates all activity and workflow types registered in the domain. Executions // that were started before the domain was deprecated continues to run. This // operation is eventually consistent. The results are best effort and may not // exactly reflect recent updates and changes. Access Control You can use IAM // policies to control this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * -// Use a Resource element with the domain name to limit the action to only -// specified domains. -// -// * Use an Action element to allow or deny permission to call -// this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DeprecateDomain(ctx context.Context, params *DeprecateDomainInput, optFns ...func(*Options)) (*DeprecateDomainOutput, error) { if params == nil { diff --git a/service/swf/api_op_DeprecateWorkflowType.go b/service/swf/api_op_DeprecateWorkflowType.go index 7e1d28b2cfd..7226a6b0f0e 100644 --- a/service/swf/api_op_DeprecateWorkflowType.go +++ b/service/swf/api_op_DeprecateWorkflowType.go @@ -18,29 +18,20 @@ import ( // eventually consistent. The results are best effort and may not exactly reflect // recent updates and changes. Access Control You can use IAM policies to control // this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - workflowType.name : String constraint. The key is swf:workflowType.name . +// - workflowType.version : String constraint. The key is +// swf:workflowType.version . // -// * Use a Resource -// element with the domain name to limit the action to only specified domains. -// -// * -// Use an Action element to allow or deny permission to call this action. -// -// * -// Constrain the following parameters by using a Condition element with the -// appropriate keys. -// -// * workflowType.name: String constraint. The key is -// swf:workflowType.name. -// -// * workflowType.version: String constraint. The key is -// swf:workflowType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DeprecateWorkflowType(ctx context.Context, params *DeprecateWorkflowTypeInput, optFns ...func(*Options)) (*DeprecateWorkflowTypeOutput, error) { if params == nil { diff --git a/service/swf/api_op_DescribeActivityType.go b/service/swf/api_op_DescribeActivityType.go index 2f651e4204b..f39d15cad87 100644 --- a/service/swf/api_op_DescribeActivityType.go +++ b/service/swf/api_op_DescribeActivityType.go @@ -15,29 +15,20 @@ import ( // configuration settings provided when the type was registered and other general // information about the type. Access Control You can use IAM policies to control // this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - activityType.name : String constraint. The key is swf:activityType.name . +// - activityType.version : String constraint. The key is +// swf:activityType.version . // -// * Use a Resource -// element with the domain name to limit the action to only specified domains. -// -// * -// Use an Action element to allow or deny permission to call this action. -// -// * -// Constrain the following parameters by using a Condition element with the -// appropriate keys. -// -// * activityType.name: String constraint. The key is -// swf:activityType.name. -// -// * activityType.version: String constraint. The key is -// swf:activityType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DescribeActivityType(ctx context.Context, params *DescribeActivityTypeInput, optFns ...func(*Options)) (*DescribeActivityTypeOutput, error) { if params == nil { @@ -56,8 +47,8 @@ func (c *Client) DescribeActivityType(ctx context.Context, params *DescribeActiv type DescribeActivityTypeInput struct { - // The activity type to get information about. Activity types are identified by the - // name and version that were supplied when the activity was registered. + // The activity type to get information about. Activity types are identified by + // the name and version that were supplied when the activity was registered. // // This member is required. ActivityType *types.ActivityType @@ -80,14 +71,11 @@ type DescribeActivityTypeOutput struct { // General information about the activity type. The status of activity type // (returned in the ActivityTypeInfo structure) can be one of the following. - // - // * - // REGISTERED – The type is registered and available. Workers supporting this type - // should be running. - // - // * DEPRECATED – The type was deprecated using - // DeprecateActivityType, but is still in use. You should keep workers supporting - // this type running. You cannot create new tasks of this type. + // - REGISTERED – The type is registered and available. Workers supporting this + // type should be running. + // - DEPRECATED – The type was deprecated using DeprecateActivityType , but is + // still in use. You should keep workers supporting this type running. You cannot + // create new tasks of this type. // // This member is required. TypeInfo *types.ActivityTypeInfo diff --git a/service/swf/api_op_DescribeDomain.go b/service/swf/api_op_DescribeDomain.go index 2fed8a733b9..4d261298c8b 100644 --- a/service/swf/api_op_DescribeDomain.go +++ b/service/swf/api_op_DescribeDomain.go @@ -14,22 +14,16 @@ import ( // Returns information about the specified domain, including description and // status. Access Control You can use IAM policies to control this action's access // to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain -// name to limit the action to only specified domains. -// -// * Use an Action element to -// allow or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error) { if params == nil { diff --git a/service/swf/api_op_DescribeWorkflowExecution.go b/service/swf/api_op_DescribeWorkflowExecution.go index 8d9a6566d33..b1aae417634 100644 --- a/service/swf/api_op_DescribeWorkflowExecution.go +++ b/service/swf/api_op_DescribeWorkflowExecution.go @@ -17,22 +17,16 @@ import ( // best effort and may not exactly reflect recent updates and changes. Access // Control You can use IAM policies to control this action's access to Amazon SWF // resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * You cannot use an IAM policy to constrain -// this action's parameters. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DescribeWorkflowExecution(ctx context.Context, params *DescribeWorkflowExecutionInput, optFns ...func(*Options)) (*DescribeWorkflowExecutionOutput, error) { if params == nil { @@ -67,8 +61,8 @@ type DescribeWorkflowExecutionInput struct { // Contains details about a workflow execution. type DescribeWorkflowExecutionOutput struct { - // The configuration settings for this workflow execution including timeout values, - // tasklist etc. + // The configuration settings for this workflow execution including timeout + // values, tasklist etc. // // This member is required. ExecutionConfiguration *types.WorkflowExecutionConfiguration @@ -89,9 +83,9 @@ type DescribeWorkflowExecutionOutput struct { // for an unusually long period of time and might require a corrective action. LatestActivityTaskTimestamp *time.Time - // The latest executionContext provided by the decider for this workflow execution. - // A decider can provide an executionContext (a free-form string) when closing a - // decision task using RespondDecisionTaskCompleted. + // The latest executionContext provided by the decider for this workflow + // execution. A decider can provide an executionContext (a free-form string) when + // closing a decision task using RespondDecisionTaskCompleted . LatestExecutionContext *string // Metadata pertaining to the operation's result. diff --git a/service/swf/api_op_DescribeWorkflowType.go b/service/swf/api_op_DescribeWorkflowType.go index 69d3446e56d..da93fe0ff2d 100644 --- a/service/swf/api_op_DescribeWorkflowType.go +++ b/service/swf/api_op_DescribeWorkflowType.go @@ -16,28 +16,20 @@ import ( // information such as creation date, current status, etc. Access Control You can // use IAM policies to control this action's access to Amazon SWF resources as // follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - workflowType.name : String constraint. The key is swf:workflowType.name . +// - workflowType.version : String constraint. The key is +// swf:workflowType.version . // -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * Constrain the following parameters by using a Condition -// element with the appropriate keys. -// -// * workflowType.name: String constraint. The -// key is swf:workflowType.name. -// -// * workflowType.version: String constraint. The -// key is swf:workflowType.version. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) DescribeWorkflowType(ctx context.Context, params *DescribeWorkflowTypeInput, optFns ...func(*Options)) (*DescribeWorkflowTypeOutput, error) { if params == nil { @@ -80,14 +72,11 @@ type DescribeWorkflowTypeOutput struct { // General information about the workflow type. The status of the workflow type // (returned in the WorkflowTypeInfo structure) can be one of the following. - // - // * - // REGISTERED – The type is registered and available. Workers supporting this type - // should be running. - // - // * DEPRECATED – The type was deprecated using - // DeprecateWorkflowType, but is still in use. You should keep workers supporting - // this type running. You cannot create new workflow executions of this type. + // - REGISTERED – The type is registered and available. Workers supporting this + // type should be running. + // - DEPRECATED – The type was deprecated using DeprecateWorkflowType , but is + // still in use. You should keep workers supporting this type running. You cannot + // create new workflow executions of this type. // // This member is required. TypeInfo *types.WorkflowTypeInfo diff --git a/service/swf/api_op_GetWorkflowExecutionHistory.go b/service/swf/api_op_GetWorkflowExecutionHistory.go index 2407c1cfde0..c74b871706e 100644 --- a/service/swf/api_op_GetWorkflowExecutionHistory.go +++ b/service/swf/api_op_GetWorkflowExecutionHistory.go @@ -18,22 +18,16 @@ import ( // eventually consistent. The results are best effort and may not exactly reflect // recent updates and changes. Access Control You can use IAM policies to control // this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource -// element with the domain name to limit the action to only specified domains. -// -// * -// Use an Action element to allow or deny permission to call this action. -// -// * You -// cannot use an IAM policy to constrain this action's parameters. -// -// If the caller -// doesn't have sufficient permissions to invoke the action, or the parameter -// values fall outside the specified constraints, the action fails. The associated -// event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details -// and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) GetWorkflowExecutionHistory(ctx context.Context, params *GetWorkflowExecutionHistoryInput, optFns ...func(*Options)) (*GetWorkflowExecutionHistoryOutput, error) { if params == nil { @@ -70,21 +64,21 @@ type GetWorkflowExecutionHistoryInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the events in reverse order. By default the results + // When set to true , returns the events in reverse order. By default the results // are returned in ascending order of the eventTimeStamp of the events. ReverseOrder bool noSmithyDocumentSerde } -// Paginated representation of a workflow history for a workflow execution. This is -// the up to date, complete and authoritative record of the events related to all -// tasks and events in the life of the workflow execution. +// Paginated representation of a workflow history for a workflow execution. This +// is the up to date, complete and authoritative record of the events related to +// all tasks and events in the life of the workflow execution. type GetWorkflowExecutionHistoryOutput struct { // The list of history events. @@ -94,7 +88,7 @@ type GetWorkflowExecutionHistoryOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_ListActivityTypes.go b/service/swf/api_op_ListActivityTypes.go index 9b9bb74c52e..be02a36e3d7 100644 --- a/service/swf/api_op_ListActivityTypes.go +++ b/service/swf/api_op_ListActivityTypes.go @@ -12,29 +12,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about all activities registered in the specified domain that -// match the specified name and registration status. The result includes +// Returns information about all activities registered in the specified domain +// that match the specified name and registration status. The result includes // information like creation date, current status of the activity, etc. The results // may be split into multiple pages. To retrieve subsequent pages, make the call // again using the nextPageToken returned by the initial call. Access Control You // can use IAM policies to control this action's access to Amazon SWF resources as // follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) ListActivityTypes(ctx context.Context, params *ListActivityTypesInput, optFns ...func(*Options)) (*ListActivityTypesOutput, error) { if params == nil { @@ -74,12 +68,12 @@ type ListActivityTypesInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the results in reverse order. By default, the results + // When set to true , returns the results in reverse order. By default, the results // are returned in ascending alphabetical order by name of the activity types. ReverseOrder bool @@ -96,7 +90,7 @@ type ListActivityTypesOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_ListClosedWorkflowExecutions.go b/service/swf/api_op_ListClosedWorkflowExecutions.go index 6526db0b25e..49fba6e2606 100644 --- a/service/swf/api_op_ListClosedWorkflowExecutions.go +++ b/service/swf/api_op_ListClosedWorkflowExecutions.go @@ -19,31 +19,20 @@ import ( // best effort and may not exactly reflect recent updates and changes. Access // Control You can use IAM policies to control this action's access to Amazon SWF // resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagFilter.tag : String constraint. The key is swf:tagFilter.tag . +// - typeFilter.name : String constraint. The key is swf:typeFilter.name . +// - typeFilter.version : String constraint. The key is swf:typeFilter.version . // -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * Constrain the following parameters by using a -// Condition element with the appropriate keys. -// -// * tagFilter.tag: String -// constraint. The key is swf:tagFilter.tag. -// -// * typeFilter.name: String constraint. -// The key is swf:typeFilter.name. -// -// * typeFilter.version: String constraint. The -// key is swf:typeFilter.version. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) ListClosedWorkflowExecutions(ctx context.Context, params *ListClosedWorkflowExecutionsInput, optFns ...func(*Options)) (*ListClosedWorkflowExecutionsOutput, error) { if params == nil { @@ -69,20 +58,20 @@ type ListClosedWorkflowExecutionsInput struct { // If specified, only workflow executions that match this close status are listed. // For example, if TERMINATED is specified, then only TERMINATED workflow - // executions are listed. closeStatusFilter, executionFilter, typeFilter and + // executions are listed. closeStatusFilter , executionFilter , typeFilter and // tagFilter are mutually exclusive. You can specify at most one of these in a // request. CloseStatusFilter *types.CloseStatusFilter - // If specified, the workflow executions are included in the returned results based - // on whether their close times are within the range specified by this filter. - // Also, if this parameter is specified, the returned results are ordered by their - // close times. startTimeFilter and closeTimeFilter are mutually exclusive. You - // must specify one of these in a request but not both. + // If specified, the workflow executions are included in the returned results + // based on whether their close times are within the range specified by this + // filter. Also, if this parameter is specified, the returned results are ordered + // by their close times. startTimeFilter and closeTimeFilter are mutually + // exclusive. You must specify one of these in a request but not both. CloseTimeFilter *types.ExecutionTimeFilter - // If specified, only workflow executions matching the workflow ID specified in the - // filter are returned. closeStatusFilter, executionFilter, typeFilter and + // If specified, only workflow executions matching the workflow ID specified in + // the filter are returned. closeStatusFilter , executionFilter , typeFilter and // tagFilter are mutually exclusive. You can specify at most one of these in a // request. ExecutionFilter *types.WorkflowExecutionFilter @@ -95,30 +84,30 @@ type ListClosedWorkflowExecutionsInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the results in reverse order. By default the results + // When set to true , returns the results in reverse order. By default the results // are returned in descending order of the start or the close time of the // executions. ReverseOrder bool - // If specified, the workflow executions are included in the returned results based - // on whether their start times are within the range specified by this filter. - // Also, if this parameter is specified, the returned results are ordered by their - // start times. startTimeFilter and closeTimeFilter are mutually exclusive. You - // must specify one of these in a request but not both. + // If specified, the workflow executions are included in the returned results + // based on whether their start times are within the range specified by this + // filter. Also, if this parameter is specified, the returned results are ordered + // by their start times. startTimeFilter and closeTimeFilter are mutually + // exclusive. You must specify one of these in a request but not both. StartTimeFilter *types.ExecutionTimeFilter // If specified, only executions that have the matching tag are listed. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually + // closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. TagFilter *types.TagFilter // If specified, only executions of the type specified in the filter are returned. - // closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually + // closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually // exclusive. You can specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter @@ -135,7 +124,7 @@ type ListClosedWorkflowExecutionsOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_ListDomains.go b/service/swf/api_op_ListDomains.go index 4a1506a41a4..f24ae8dd59a 100644 --- a/service/swf/api_op_ListDomains.go +++ b/service/swf/api_op_ListDomains.go @@ -18,24 +18,17 @@ import ( // consistent. The results are best effort and may not exactly reflect recent // updates and changes. Access Control You can use IAM policies to control this // action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. The element must be set to arn:aws:swf::AccountID:domain/* +// , where AccountID is the account ID, with no dashes. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element -// with the domain name to limit the action to only specified domains. The element -// must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account -// ID, with no dashes. -// -// * Use an Action element to allow or deny permission to call -// this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error) { if params == nil { @@ -67,12 +60,12 @@ type ListDomainsInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the results in reverse order. By default, the results + // When set to true , returns the results in reverse order. By default, the results // are returned in ascending alphabetical order by name of the domains. ReverseOrder bool @@ -89,7 +82,7 @@ type ListDomainsOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_ListOpenWorkflowExecutions.go b/service/swf/api_op_ListOpenWorkflowExecutions.go index a02f5d282a0..bd5b396484d 100644 --- a/service/swf/api_op_ListOpenWorkflowExecutions.go +++ b/service/swf/api_op_ListOpenWorkflowExecutions.go @@ -12,38 +12,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of open workflow executions in the specified domain that meet the -// filtering criteria. The results may be split into multiple pages. To retrieve -// subsequent pages, make the call again using the nextPageToken returned by the -// initial call. This operation is eventually consistent. The results are best -// effort and may not exactly reflect recent updates and changes. Access Control -// You can use IAM policies to control this action's access to Amazon SWF resources -// as follows: +// Returns a list of open workflow executions in the specified domain that meet +// the filtering criteria. The results may be split into multiple pages. To +// retrieve subsequent pages, make the call again using the nextPageToken returned +// by the initial call. This operation is eventually consistent. The results are +// best effort and may not exactly reflect recent updates and changes. Access +// Control You can use IAM policies to control this action's access to Amazon SWF +// resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagFilter.tag : String constraint. The key is swf:tagFilter.tag . +// - typeFilter.name : String constraint. The key is swf:typeFilter.name . +// - typeFilter.version : String constraint. The key is swf:typeFilter.version . // -// * Use a Resource element with the domain name to limit the action -// to only specified domains. -// -// * Use an Action element to allow or deny permission -// to call this action. -// -// * Constrain the following parameters by using a Condition -// element with the appropriate keys. -// -// * tagFilter.tag: String constraint. The key -// is swf:tagFilter.tag. -// -// * typeFilter.name: String constraint. The key is -// swf:typeFilter.name. -// -// * typeFilter.version: String constraint. The key is -// swf:typeFilter.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) ListOpenWorkflowExecutions(ctx context.Context, params *ListOpenWorkflowExecutionsInput, optFns ...func(*Options)) (*ListOpenWorkflowExecutionsOutput, error) { if params == nil { @@ -73,9 +62,9 @@ type ListOpenWorkflowExecutionsInput struct { // This member is required. StartTimeFilter *types.ExecutionTimeFilter - // If specified, only workflow executions matching the workflow ID specified in the - // filter are returned. executionFilter, typeFilter and tagFilter are mutually - // exclusive. You can specify at most one of these in a request. + // If specified, only workflow executions matching the workflow ID specified in + // the filter are returned. executionFilter , typeFilter and tagFilter are + // mutually exclusive. You can specify at most one of these in a request. ExecutionFilter *types.WorkflowExecutionFilter // The maximum number of results that are returned per call. Use nextPageToken to @@ -86,22 +75,22 @@ type ListOpenWorkflowExecutionsInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the results in reverse order. By default the results + // When set to true , returns the results in reverse order. By default the results // are returned in descending order of the start time of the executions. ReverseOrder bool // If specified, only executions that have the matching tag are listed. - // executionFilter, typeFilter and tagFilter are mutually exclusive. You can + // executionFilter , typeFilter and tagFilter are mutually exclusive. You can // specify at most one of these in a request. TagFilter *types.TagFilter // If specified, only executions of the type specified in the filter are returned. - // executionFilter, typeFilter and tagFilter are mutually exclusive. You can + // executionFilter , typeFilter and tagFilter are mutually exclusive. You can // specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter @@ -118,7 +107,7 @@ type ListOpenWorkflowExecutionsOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_ListWorkflowTypes.go b/service/swf/api_op_ListWorkflowTypes.go index f9a657a5525..b83a91d680a 100644 --- a/service/swf/api_op_ListWorkflowTypes.go +++ b/service/swf/api_op_ListWorkflowTypes.go @@ -16,22 +16,16 @@ import ( // may be split into multiple pages that can be retrieved by making the call // repeatedly. Access Control You can use IAM policies to control this action's // access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the -// domain name to limit the action to only specified domains. -// -// * Use an Action -// element to allow or deny permission to call this action. -// -// * You cannot use an -// IAM policy to constrain this action's parameters. -// -// If the caller doesn't have -// sufficient permissions to invoke the action, or the parameter values fall -// outside the specified constraints, the action fails. The associated event -// attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and -// example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) ListWorkflowTypes(ctx context.Context, params *ListWorkflowTypesInput, optFns ...func(*Options)) (*ListWorkflowTypesOutput, error) { if params == nil { @@ -71,12 +65,12 @@ type ListWorkflowTypesInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. NextPageToken *string - // When set to true, returns the results in reverse order. By default the results + // When set to true , returns the results in reverse order. By default the results // are returned in ascending alphabetical order of the name of the workflow types. ReverseOrder bool @@ -93,7 +87,7 @@ type ListWorkflowTypesOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string diff --git a/service/swf/api_op_PollForActivityTask.go b/service/swf/api_op_PollForActivityTask.go index 7e680702e12..4aaf866f935 100644 --- a/service/swf/api_op_PollForActivityTask.go +++ b/service/swf/api_op_PollForActivityTask.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by workers to get an ActivityTask from the specified activity taskList. +// Used by workers to get an ActivityTask from the specified activity taskList . // This initiates a long poll, where the service holds the HTTP connection open and // responds as soon as a task becomes available. The maximum time the service holds // on to the request before responding is 60 seconds. If no task is available @@ -22,24 +22,17 @@ import ( // timeout to at least 70 seconds (10 seconds higher than the maximum time service // may hold the poll request). Access Control You can use IAM policies to control // this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the taskList.name parameter by using a Condition element with the +// swf:taskList.name key to allow the action to access only certain task lists. // -// * Use a Resource -// element with the domain name to limit the action to only specified domains. -// -// * -// Use an Action element to allow or deny permission to call this action. -// -// * -// Constrain the taskList.name parameter by using a Condition element with the -// swf:taskList.name key to allow the action to access only certain task lists. -// -// If -// the caller doesn't have sufficient permissions to invoke the action, or the +// If the caller doesn't have sufficient permissions to invoke the action, or the // parameter values fall outside the specified constraints, the action fails. The -// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . // For details and example IAM policies, see Using IAM to Manage Access to Amazon -// SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) PollForActivityTask(ctx context.Context, params *PollForActivityTaskInput, optFns ...func(*Options)) (*PollForActivityTaskOutput, error) { if params == nil { @@ -65,8 +58,8 @@ type PollForActivityTaskInput struct { // Specifies the task list to poll for activity tasks. The specified string must // not start or end with whitespace. It must not contain a : (colon), / (slash), | - // (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, - // it must not be the literal string arn. + // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). + // Also, it must not be the literal string arn . // // This member is required. TaskList *types.TaskList @@ -97,8 +90,9 @@ type PollForActivityTaskOutput struct { // This member is required. StartedEventId int64 - // The opaque string used as a handle on the task. This token is used by workers to - // communicate progress and response information back to the system about the task. + // The opaque string used as a handle on the task. This token is used by workers + // to communicate progress and response information back to the system about the + // task. // // This member is required. TaskToken *string diff --git a/service/swf/api_op_PollForDecisionTask.go b/service/swf/api_op_PollForDecisionTask.go index c5a03430526..91d672f26d6 100644 --- a/service/swf/api_op_PollForDecisionTask.go +++ b/service/swf/api_op_PollForDecisionTask.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by deciders to get a DecisionTask from the specified decision taskList. A +// Used by deciders to get a DecisionTask from the specified decision taskList . A // decision task may be returned for any open workflow execution that is using the // specified task list. The task includes a paginated view of the history of the // workflow execution. The decider should use the workflow type and the history to @@ -27,27 +27,20 @@ import ( // might be very large, the result returned might be split up across a number of // pages. To retrieve subsequent pages, make additional calls to // PollForDecisionTask using the nextPageToken returned by the initial call. Note -// that you do not call GetWorkflowExecutionHistory with this nextPageToken. -// Instead, call PollForDecisionTask again. Access Control You can use IAM policies -// to control this action's access to Amazon SWF resources as follows: +// that you do not call GetWorkflowExecutionHistory with this nextPageToken . +// Instead, call PollForDecisionTask again. Access Control You can use IAM +// policies to control this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the taskList.name parameter by using a Condition element with the +// swf:taskList.name key to allow the action to access only certain task lists. // -// * Use a -// Resource element with the domain name to limit the action to only specified -// domains. -// -// * Use an Action element to allow or deny permission to call this -// action. -// -// * Constrain the taskList.name parameter by using a Condition element -// with the swf:taskList.name key to allow the action to access only certain task -// lists. -// -// If the caller doesn't have sufficient permissions to invoke the action, -// or the parameter values fall outside the specified constraints, the action -// fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) PollForDecisionTask(ctx context.Context, params *PollForDecisionTaskInput, optFns ...func(*Options)) (*PollForDecisionTaskOutput, error) { if params == nil { @@ -73,8 +66,8 @@ type PollForDecisionTaskInput struct { // Specifies the task list to poll for decision tasks. The specified string must // not start or end with whitespace. It must not contain a : (colon), / (slash), | - // (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, - // it must not be the literal string arn. + // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). + // Also, it must not be the literal string arn . // // This member is required. TaskList *types.TaskList @@ -93,24 +86,24 @@ type PollForDecisionTaskInput struct { // NextPageToken is a unique pagination token for each page. Make the call again // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 60 seconds. Using an expired - // pagination token will return a 400 error: "Specified token has exceeded its - // maximum lifetime". The configured maximumPageSize determines how many results + // pagination token will return a 400 error: " Specified token has exceeded its + // maximum lifetime ". The configured maximumPageSize determines how many results // can be returned in a single call. The nextPageToken returned by this action // cannot be used with GetWorkflowExecutionHistory to get the next page. You must - // call PollForDecisionTask again (with the nextPageToken) to retrieve the next + // call PollForDecisionTask again (with the nextPageToken ) to retrieve the next // page of history records. Calling PollForDecisionTask with a nextPageToken // doesn't return a new decision task. NextPageToken *string - // When set to true, returns the events in reverse order. By default the results + // When set to true , returns the events in reverse order. By default the results // are returned in ascending order of the eventTimestamp of the events. ReverseOrder bool noSmithyDocumentSerde } -// A structure that represents a decision task. Decision tasks are sent to deciders -// in order for them to make decisions. +// A structure that represents a decision task. Decision tasks are sent to +// deciders in order for them to make decisions. type PollForDecisionTaskOutput struct { // A paginated list of history events of the workflow execution. The decider uses @@ -124,8 +117,9 @@ type PollForDecisionTaskOutput struct { // This member is required. StartedEventId int64 - // The opaque string used as a handle on the task. This token is used by workers to - // communicate progress and response information back to the system about the task. + // The opaque string used as a handle on the task. This token is used by workers + // to communicate progress and response information back to the system about the + // task. // // This member is required. TaskToken *string @@ -142,7 +136,7 @@ type PollForDecisionTaskOutput struct { // If a NextPageToken was returned by a previous call, there are more results // available. To retrieve the next page of results, make the call again using the - // returned token in nextPageToken. Keep all other arguments unchanged. The + // returned token in nextPageToken . Keep all other arguments unchanged. The // configured maximumPageSize determines how many results can be returned in a // single call. NextPageToken *string @@ -222,8 +216,8 @@ func (c *Client) addOperationPollForDecisionTaskMiddlewares(stack *middleware.St return nil } -// PollForDecisionTaskAPIClient is a client that implements the PollForDecisionTask -// operation. +// PollForDecisionTaskAPIClient is a client that implements the +// PollForDecisionTask operation. type PollForDecisionTaskAPIClient interface { PollForDecisionTask(context.Context, *PollForDecisionTaskInput, ...func(*Options)) (*PollForDecisionTaskOutput, error) } diff --git a/service/swf/api_op_RecordActivityTaskHeartbeat.go b/service/swf/api_op_RecordActivityTaskHeartbeat.go index cfbe10a0956..75848c8dbd7 100644 --- a/service/swf/api_op_RecordActivityTaskHeartbeat.go +++ b/service/swf/api_op_RecordActivityTaskHeartbeat.go @@ -16,38 +16,32 @@ import ( // details parameter. This action can also be used by the worker as a mechanism to // check if cancellation is being requested for the activity task. If a // cancellation is being attempted for the specified task, then the boolean -// cancelRequested flag returned by the service is set to true. This action resets +// cancelRequested flag returned by the service is set to true . This action resets // the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in -// RegisterActivityType. This action doesn't in itself create an event in the +// RegisterActivityType . This action doesn't in itself create an event in the // workflow execution history. However, if the task times out, the workflow // execution history contains a ActivityTaskTimedOut event that contains the // information from the last heartbeat generated by the activity worker. The // taskStartToCloseTimeout of an activity type is the maximum duration of an // activity task, regardless of the number of RecordActivityTaskHeartbeat requests -// received. The taskStartToCloseTimeout is also specified in RegisterActivityType. -// This operation is only useful for long-lived activities to report liveliness of -// the task and to determine if a cancellation is being attempted. If the -// cancelRequested flag returns true, a cancellation is being attempted. If the +// received. The taskStartToCloseTimeout is also specified in RegisterActivityType +// . This operation is only useful for long-lived activities to report liveliness +// of the task and to determine if a cancellation is being attempted. If the +// cancelRequested flag returns true , a cancellation is being attempted. If the // worker can cancel the activity, it should respond with -// RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation +// RespondActivityTaskCanceled . Otherwise, it should ignore the cancellation // request. Access Control You can use IAM policies to control this action's access // to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain -// name to limit the action to only specified domains. -// -// * Use an Action element to -// allow or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RecordActivityTaskHeartbeat(ctx context.Context, params *RecordActivityTaskHeartbeatInput, optFns ...func(*Options)) (*RecordActivityTaskHeartbeatOutput, error) { if params == nil { @@ -66,7 +60,7 @@ func (c *Client) RecordActivityTaskHeartbeat(ctx context.Context, params *Record type RecordActivityTaskHeartbeatInput struct { - // The taskToken of the ActivityTask. taskToken is generated by the service and + // The taskToken of the ActivityTask . taskToken is generated by the service and // should be treated as an opaque value. If the task is passed to another process, // its taskToken must also be passed. This enables it to provide its progress and // respond with results. diff --git a/service/swf/api_op_RegisterActivityType.go b/service/swf/api_op_RegisterActivityType.go index c82e957d9d3..9f9a5b6d07f 100644 --- a/service/swf/api_op_RegisterActivityType.go +++ b/service/swf/api_op_RegisterActivityType.go @@ -17,31 +17,21 @@ import ( // after its registration, and it must be registered as a new version. Access // Control You can use IAM policies to control this action's access to Amazon SWF // resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - defaultTaskList.name : String constraint. The key is +// swf:defaultTaskList.name . +// - name : String constraint. The key is swf:name . +// - version : String constraint. The key is swf:version . // -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * Constrain the following parameters by using a -// Condition element with the appropriate keys. -// -// * defaultTaskList.name: String -// constraint. The key is swf:defaultTaskList.name. -// -// * name: String constraint. The -// key is swf:name. -// -// * version: String constraint. The key is swf:version. -// -// If the -// caller doesn't have sufficient permissions to invoke the action, or the +// If the caller doesn't have sufficient permissions to invoke the action, or the // parameter values fall outside the specified constraints, the action fails. The -// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . // For details and example IAM policies, see Using IAM to Manage Access to Amazon -// SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RegisterActivityType(ctx context.Context, params *RegisterActivityTypeInput, optFns ...func(*Options)) (*RegisterActivityTypeOutput, error) { if params == nil { @@ -67,8 +57,8 @@ type RegisterActivityTypeInput struct { // The name of the activity type within the domain. The specified string must not // start or end with whitespace. It must not contain a : (colon), / (slash), | - // (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, - // it must not be the literal string arn. + // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). + // Also, it must not be the literal string arn . // // This member is required. Name *string @@ -76,56 +66,55 @@ type RegisterActivityTypeInput struct { // The version of the activity type. The activity type consists of the name and // version, the combination of which must be unique within the domain. The // specified string must not start or end with whitespace. It must not contain a : - // (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | - // \u007f-\u009f). Also, it must not be the literal string arn. + // (colon), / (slash), | (vertical bar), or any control characters ( \u0000-\u001f + // | \u007f-\u009f ). Also, it must not be the literal string arn . // // This member is required. Version *string // If set, specifies the default maximum time before which a worker processing a - // task of this type must report progress by calling RecordActivityTaskHeartbeat. + // task of this type must report progress by calling RecordActivityTaskHeartbeat . // If the timeout is exceeded, the activity task is automatically timed out. This // default can be overridden when scheduling an activity task using the - // ScheduleActivityTaskDecision. If the activity worker subsequently attempts to + // ScheduleActivityTask Decision . If the activity worker subsequently attempts to // record a heartbeat or returns a result, the activity worker receives an // UnknownResource fault. In this case, Amazon SWF no longer considers the activity // task to be valid; the activity worker should clean up the activity task. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. + // duration is specified in seconds, an integer greater than or equal to 0 . You + // can use NONE to specify unlimited duration. DefaultTaskHeartbeatTimeout *string // If set, specifies the default task list to use for scheduling tasks of this // activity type. This default task list is used if a task list isn't provided when - // a task is scheduled through the ScheduleActivityTaskDecision. + // a task is scheduled through the ScheduleActivityTask Decision . DefaultTaskList *types.TaskList // The default task priority to assign to the activity type. If not assigned, then // 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher // priority. For more information about setting task priority, see Setting Task - // Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the in the Amazon SWF Developer Guide.. DefaultTaskPriority *string - // If set, specifies the default maximum duration for a task of this activity type. - // This default can be overridden when scheduling an activity task using the - // ScheduleActivityTaskDecision. The duration is specified in seconds, an integer - // greater than or equal to 0. You can use NONE to specify unlimited duration. + // If set, specifies the default maximum duration for a task of this activity + // type. This default can be overridden when scheduling an activity task using the + // ScheduleActivityTask Decision . The duration is specified in seconds, an integer + // greater than or equal to 0 . You can use NONE to specify unlimited duration. DefaultTaskScheduleToCloseTimeout *string - // If set, specifies the default maximum duration that a task of this activity type - // can wait before being assigned to a worker. This default can be overridden when - // scheduling an activity task using the ScheduleActivityTaskDecision. The duration - // is specified in seconds, an integer greater than or equal to 0. You can use NONE - // to specify unlimited duration. + // If set, specifies the default maximum duration that a task of this activity + // type can wait before being assigned to a worker. This default can be overridden + // when scheduling an activity task using the ScheduleActivityTask Decision . The + // duration is specified in seconds, an integer greater than or equal to 0 . You + // can use NONE to specify unlimited duration. DefaultTaskScheduleToStartTimeout *string - // If set, specifies the default maximum duration that a worker can take to process - // tasks of this activity type. This default can be overridden when scheduling an - // activity task using the ScheduleActivityTaskDecision. The duration is specified - // in seconds, an integer greater than or equal to 0. You can use NONE to specify - // unlimited duration. + // If set, specifies the default maximum duration that a worker can take to + // process tasks of this activity type. This default can be overridden when + // scheduling an activity task using the ScheduleActivityTask Decision . The + // duration is specified in seconds, an integer greater than or equal to 0 . You + // can use NONE to specify unlimited duration. DefaultTaskStartToCloseTimeout *string // A textual description of the activity type. diff --git a/service/swf/api_op_RegisterDomain.go b/service/swf/api_op_RegisterDomain.go index 0be1882da39..9a6b691ed2c 100644 --- a/service/swf/api_op_RegisterDomain.go +++ b/service/swf/api_op_RegisterDomain.go @@ -14,22 +14,18 @@ import ( // Registers a new domain. Access Control You can use IAM policies to control this // action's access to Amazon SWF resources as follows: // -// * You cannot use an IAM -// policy to control domain access for this action. The name of the domain being -// registered is available as the resource of this action. +// - You cannot use an IAM policy to control domain access for this action. The +// name of the domain being registered is available as the resource of this action. // -// * Use an Action element -// to allow or deny permission to call this action. +// - Use an Action element to allow or deny permission to call this action. // -// * You cannot use an IAM policy -// to constrain this action's parameters. +// - You cannot use an IAM policy to constrain this action's parameters. // -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput, optFns ...func(*Options)) (*RegisterDomainOutput, error) { if params == nil { @@ -50,9 +46,9 @@ type RegisterDomainInput struct { // Name of the domain to register. The name must be unique in the region that the // domain is registered in. The specified string must not start or end with - // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any - // control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the - // literal string arn. + // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or + // any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not be + // the literal string arn . // // This member is required. Name *string @@ -63,8 +59,7 @@ type RegisterDomainInput struct { // value NONE or 0 (zero), then the workflow execution history isn't retained. As // soon as the workflow execution completes, the execution record and its history // are deleted. The maximum workflow execution retention period is 90 days. For - // more information about Amazon SWF service limits, see: Amazon SWF Service Limits - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html) + // more information about Amazon SWF service limits, see: Amazon SWF Service Limits (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -74,7 +69,7 @@ type RegisterDomainInput struct { Description *string // Tags to be added when registering a domain. Tags may only contain unicode - // letters, digits, whitespace, or these symbols: _ . : / = + - @. + // letters, digits, whitespace, or these symbols: _ . : / = + - @ . Tags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/swf/api_op_RegisterWorkflowType.go b/service/swf/api_op_RegisterWorkflowType.go index 102fdf8954f..c90f588e80b 100644 --- a/service/swf/api_op_RegisterWorkflowType.go +++ b/service/swf/api_op_RegisterWorkflowType.go @@ -18,31 +18,21 @@ import ( // type once it is registered and it must be registered as a new version. Access // Control You can use IAM policies to control this action's access to Amazon SWF // resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - defaultTaskList.name : String constraint. The key is +// swf:defaultTaskList.name . +// - name : String constraint. The key is swf:name . +// - version : String constraint. The key is swf:version . // -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * Constrain the following parameters by using a -// Condition element with the appropriate keys. -// -// * defaultTaskList.name: String -// constraint. The key is swf:defaultTaskList.name. -// -// * name: String constraint. The -// key is swf:name. -// -// * version: String constraint. The key is swf:version. -// -// If the -// caller doesn't have sufficient permissions to invoke the action, or the +// If the caller doesn't have sufficient permissions to invoke the action, or the // parameter values fall outside the specified constraints, the action fails. The -// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . // For details and example IAM policies, see Using IAM to Manage Access to Amazon -// SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RegisterWorkflowType(ctx context.Context, params *RegisterWorkflowTypeInput, optFns ...func(*Options)) (*RegisterWorkflowTypeOutput, error) { if params == nil { @@ -67,9 +57,9 @@ type RegisterWorkflowTypeInput struct { Domain *string // The name of the workflow type. The specified string must not start or end with - // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any - // control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the - // literal string arn. + // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or + // any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not be + // the literal string arn . // // This member is required. Name *string @@ -78,8 +68,8 @@ type RegisterWorkflowTypeInput struct { // version, the combination of which must be unique within the domain. To get a // list of all currently registered workflow types, use the ListWorkflowTypes // action. The specified string must not start or end with whitespace. It must not - // contain a : (colon), / (slash), | (vertical bar), or any control characters - // (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn. + // contain a : (colon), / (slash), | (vertical bar), or any control characters ( + // \u0000-\u001f | \u007f-\u009f ). Also, it must not be the literal string arn . // // This member is required. Version *string @@ -88,61 +78,53 @@ type RegisterWorkflowTypeInput struct { // when a workflow execution of this type is terminated, by calling the // TerminateWorkflowExecution action explicitly or due to an expired timeout. This // default can be overridden when starting a workflow execution using the - // StartWorkflowExecution action or the StartChildWorkflowExecutionDecision. The + // StartWorkflowExecution action or the StartChildWorkflowExecution Decision . The // supported child policies are: - // - // * TERMINATE – The child executions are - // terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted for each child - // execution by recording a WorkflowExecutionCancelRequested event in its history. - // It is up to the decider to take appropriate actions when it receives an - // execution history with this event. - // - // * ABANDON – No action is taken. The child - // executions continue to run. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. DefaultChildPolicy types.ChildPolicy // If set, specifies the default maximum duration for executions of this workflow // type. You can override this default when starting an execution through the - // StartWorkflowExecution Action or StartChildWorkflowExecutionDecision. The + // StartWorkflowExecution Action or StartChildWorkflowExecution Decision . The // duration is specified in seconds; an integer greater than or equal to 0. Unlike // some of the other timeout parameters in Amazon SWF, you cannot specify a value - // of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit - // on the time that a workflow execution can run. Exceeding this limit always + // of "NONE" for defaultExecutionStartToCloseTimeout ; there is a one-year max + // limit on the time that a workflow execution can run. Exceeding this limit always // causes the workflow execution to time out. DefaultExecutionStartToCloseTimeout *string - // The default IAM role attached to this workflow type. Executions of this workflow - // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role - // when you start this workflow type, the default Lambda role is attached to the - // execution. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // The default IAM role attached to this workflow type. Executions of this + // workflow type need IAM roles to invoke Lambda functions. If you don't specify an + // IAM role when you start this workflow type, the default Lambda role is attached + // to the execution. For more information, see + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. DefaultLambdaRole *string - // If set, specifies the default task list to use for scheduling decision tasks for - // executions of this workflow type. This default is used only if a task list isn't - // provided when starting the execution through the StartWorkflowExecution Action - // or StartChildWorkflowExecutionDecision. + // If set, specifies the default task list to use for scheduling decision tasks + // for executions of this workflow type. This default is used only if a task list + // isn't provided when starting the execution through the StartWorkflowExecution + // Action or StartChildWorkflowExecution Decision . DefaultTaskList *types.TaskList // The default task priority to assign to the workflow type. If not assigned, then // 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher // priority. For more information about setting task priority, see Setting Task - // Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. DefaultTaskPriority *string // If set, specifies the default maximum duration of decision tasks for this // workflow type. This default can be overridden when starting a workflow execution - // using the StartWorkflowExecution action or the - // StartChildWorkflowExecutionDecision. The duration is specified in seconds, an - // integer greater than or equal to 0. You can use NONE to specify unlimited - // duration. + // using the StartWorkflowExecution action or the StartChildWorkflowExecution + // Decision . The duration is specified in seconds, an integer greater than or + // equal to 0 . You can use NONE to specify unlimited duration. DefaultTaskStartToCloseTimeout *string // Textual description of the workflow type. diff --git a/service/swf/api_op_RequestCancelWorkflowExecution.go b/service/swf/api_op_RequestCancelWorkflowExecution.go index f93b0b7c8c6..22d7c020fe0 100644 --- a/service/swf/api_op_RequestCancelWorkflowExecution.go +++ b/service/swf/api_op_RequestCancelWorkflowExecution.go @@ -21,22 +21,16 @@ import ( // should be used instead of TerminateWorkflowExecution when possible. Access // Control You can use IAM policies to control this action's access to Amazon SWF // resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * You cannot use an IAM policy to constrain -// this action's parameters. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RequestCancelWorkflowExecution(ctx context.Context, params *RequestCancelWorkflowExecutionInput, optFns ...func(*Options)) (*RequestCancelWorkflowExecutionOutput, error) { if params == nil { diff --git a/service/swf/api_op_RespondActivityTaskCanceled.go b/service/swf/api_op_RespondActivityTaskCanceled.go index 512c6650922..26683506d1b 100644 --- a/service/swf/api_op_RespondActivityTaskCanceled.go +++ b/service/swf/api_op_RespondActivityTaskCanceled.go @@ -18,28 +18,21 @@ import ( // true and if the activity can be safely undone or abandoned. A task is considered // open from the time that it is scheduled until it is closed. Therefore a task is // reported as open while a worker is processing it. A task is closed after it has -// been specified in a call to RespondActivityTaskCompleted, -// RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed -// out -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types). -// Access Control You can use IAM policies to control this action's access to +// been specified in a call to RespondActivityTaskCompleted , +// RespondActivityTaskCanceled, RespondActivityTaskFailed , or the task has timed +// out (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types) +// . Access Control You can use IAM policies to control this action's access to // Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name -// to limit the action to only specified domains. -// -// * Use an Action element to allow -// or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RespondActivityTaskCanceled(ctx context.Context, params *RespondActivityTaskCanceledInput, optFns ...func(*Options)) (*RespondActivityTaskCanceledOutput, error) { if params == nil { @@ -58,7 +51,7 @@ func (c *Client) RespondActivityTaskCanceled(ctx context.Context, params *Respon type RespondActivityTaskCanceledInput struct { - // The taskToken of the ActivityTask. taskToken is generated by the service and + // The taskToken of the ActivityTask . taskToken is generated by the service and // should be treated as an opaque value. If the task is passed to another process, // its taskToken must also be passed. This enables it to provide its progress and // respond with results. diff --git a/service/swf/api_op_RespondActivityTaskCompleted.go b/service/swf/api_op_RespondActivityTaskCompleted.go index 7ceb436043f..bc7a73d0436 100644 --- a/service/swf/api_op_RespondActivityTaskCompleted.go +++ b/service/swf/api_op_RespondActivityTaskCompleted.go @@ -11,35 +11,28 @@ import ( ) // Used by workers to tell the service that the ActivityTask identified by the -// taskToken completed successfully with a result (if provided). The result appears -// in the ActivityTaskCompleted event in the workflow history. If the requested -// task doesn't complete successfully, use RespondActivityTaskFailed instead. If -// the worker finds that the task is canceled through the canceled flag returned by -// RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call -// RespondActivityTaskCanceled. A task is considered open from the time that it is -// scheduled until it is closed. Therefore a task is reported as open while a -// worker is processing it. A task is closed after it has been specified in a call -// to RespondActivityTaskCompleted, RespondActivityTaskCanceled, -// RespondActivityTaskFailed, or the task has timed out -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types). -// Access Control You can use IAM policies to control this action's access to +// taskToken completed successfully with a result (if provided). The result +// appears in the ActivityTaskCompleted event in the workflow history. If the +// requested task doesn't complete successfully, use RespondActivityTaskFailed +// instead. If the worker finds that the task is canceled through the canceled +// flag returned by RecordActivityTaskHeartbeat , it should cancel the task, clean +// up and then call RespondActivityTaskCanceled . A task is considered open from +// the time that it is scheduled until it is closed. Therefore a task is reported +// as open while a worker is processing it. A task is closed after it has been +// specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled +// , RespondActivityTaskFailed , or the task has timed out (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types) +// . Access Control You can use IAM policies to control this action's access to // Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name -// to limit the action to only specified domains. -// -// * Use an Action element to allow -// or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RespondActivityTaskCompleted(ctx context.Context, params *RespondActivityTaskCompletedInput, optFns ...func(*Options)) (*RespondActivityTaskCompletedOutput, error) { if params == nil { @@ -58,7 +51,7 @@ func (c *Client) RespondActivityTaskCompleted(ctx context.Context, params *Respo type RespondActivityTaskCompletedInput struct { - // The taskToken of the ActivityTask. taskToken is generated by the service and + // The taskToken of the ActivityTask . taskToken is generated by the service and // should be treated as an opaque value. If the task is passed to another process, // its taskToken must also be passed. This enables it to provide its progress and // respond with results. @@ -66,8 +59,8 @@ type RespondActivityTaskCompletedInput struct { // This member is required. TaskToken *string - // The result of the activity task. It is a free form string that is implementation - // specific. + // The result of the activity task. It is a free form string that is + // implementation specific. Result *string noSmithyDocumentSerde diff --git a/service/swf/api_op_RespondActivityTaskFailed.go b/service/swf/api_op_RespondActivityTaskFailed.go index b80f70dd8a0..9b007e5ac3c 100644 --- a/service/swf/api_op_RespondActivityTaskFailed.go +++ b/service/swf/api_op_RespondActivityTaskFailed.go @@ -15,28 +15,21 @@ import ( // in the ActivityTaskFailed event added to the workflow history. A task is // considered open from the time that it is scheduled until it is closed. Therefore // a task is reported as open while a worker is processing it. A task is closed -// after it has been specified in a call to RespondActivityTaskCompleted, -// RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed -// out -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types). -// Access Control You can use IAM policies to control this action's access to +// after it has been specified in a call to RespondActivityTaskCompleted , +// RespondActivityTaskCanceled , RespondActivityTaskFailed, or the task has timed +// out (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types) +// . Access Control You can use IAM policies to control this action's access to // Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name -// to limit the action to only specified domains. -// -// * Use an Action element to allow -// or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RespondActivityTaskFailed(ctx context.Context, params *RespondActivityTaskFailedInput, optFns ...func(*Options)) (*RespondActivityTaskFailedOutput, error) { if params == nil { @@ -55,7 +48,7 @@ func (c *Client) RespondActivityTaskFailed(ctx context.Context, params *RespondA type RespondActivityTaskFailedInput struct { - // The taskToken of the ActivityTask. taskToken is generated by the service and + // The taskToken of the ActivityTask . taskToken is generated by the service and // should be treated as an opaque value. If the task is passed to another process, // its taskToken must also be passed. This enables it to provide its progress and // respond with results. diff --git a/service/swf/api_op_RespondDecisionTaskCompleted.go b/service/swf/api_op_RespondDecisionTaskCompleted.go index 1cc9ae77906..04b4b24126d 100644 --- a/service/swf/api_op_RespondDecisionTaskCompleted.go +++ b/service/swf/api_op_RespondDecisionTaskCompleted.go @@ -14,15 +14,15 @@ import ( // Used by deciders to tell the service that the DecisionTask identified by the // taskToken has successfully completed. The decisions argument specifies the list // of decisions made while processing the task. A DecisionTaskCompleted event is -// added to the workflow history. The executionContext specified is attached to the -// event in the workflow execution history. Access Control If an IAM policy grants -// permission to use RespondDecisionTaskCompleted, it can express permissions for -// the list of decisions in the decisions parameter. Each of the decisions has one -// or more parameters, much like a regular API call. To allow for policies to be as -// readable as possible, you can express permissions on decisions as if they were -// actual API calls, including applying conditions to some parameters. For more -// information, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// added to the workflow history. The executionContext specified is attached to +// the event in the workflow execution history. Access Control If an IAM policy +// grants permission to use RespondDecisionTaskCompleted , it can express +// permissions for the list of decisions in the decisions parameter. Each of the +// decisions has one or more parameters, much like a regular API call. To allow for +// policies to be as readable as possible, you can express permissions on decisions +// as if they were actual API calls, including applying conditions to some +// parameters. For more information, see Using IAM to Manage Access to Amazon SWF +// Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) RespondDecisionTaskCompleted(ctx context.Context, params *RespondDecisionTaskCompletedInput, optFns ...func(*Options)) (*RespondDecisionTaskCompletedOutput, error) { if params == nil { @@ -42,7 +42,7 @@ func (c *Client) RespondDecisionTaskCompleted(ctx context.Context, params *Respo // Input data for a TaskCompleted response to a decision task. type RespondDecisionTaskCompletedInput struct { - // The taskToken from the DecisionTask. taskToken is generated by the service and + // The taskToken from the DecisionTask . taskToken is generated by the service and // should be treated as an opaque value. If the task is passed to another process, // its taskToken must also be passed. This enables it to provide its progress and // respond with results. @@ -50,8 +50,8 @@ type RespondDecisionTaskCompletedInput struct { // This member is required. TaskToken *string - // The list of decisions (possibly empty) made by the decider while processing this - // decision task. See the docs for the Decision structure for details. + // The list of decisions (possibly empty) made by the decider while processing + // this decision task. See the docs for the Decision structure for details. Decisions []types.Decision // User defined context to add to workflow execution. diff --git a/service/swf/api_op_SignalWorkflowExecution.go b/service/swf/api_op_SignalWorkflowExecution.go index 356230b8375..41f888cfec6 100644 --- a/service/swf/api_op_SignalWorkflowExecution.go +++ b/service/swf/api_op_SignalWorkflowExecution.go @@ -16,25 +16,19 @@ import ( // defined signalName and input (if provided). If a runId isn't specified, then the // WorkflowExecutionSignaled event is recorded in the history of the current open // workflow with the matching workflowId in the domain. If the specified workflow -// execution isn't open, this method fails with UnknownResource. Access Control You -// can use IAM policies to control this action's access to Amazon SWF resources as -// follows: +// execution isn't open, this method fails with UnknownResource . Access Control +// You can use IAM policies to control this action's access to Amazon SWF resources +// as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) SignalWorkflowExecution(ctx context.Context, params *SignalWorkflowExecutionInput, optFns ...func(*Options)) (*SignalWorkflowExecutionOutput, error) { if params == nil { diff --git a/service/swf/api_op_StartWorkflowExecution.go b/service/swf/api_op_StartWorkflowExecution.go index 43f12e3e785..6a62492e266 100644 --- a/service/swf/api_op_StartWorkflowExecution.go +++ b/service/swf/api_op_StartWorkflowExecution.go @@ -15,45 +15,26 @@ import ( // provided workflowId and input data. This action returns the newly started // workflow execution. Access Control You can use IAM policies to control this // action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagList.member.0 : The key is swf:tagList.member.0 . +// - tagList.member.1 : The key is swf:tagList.member.1 . +// - tagList.member.2 : The key is swf:tagList.member.2 . +// - tagList.member.3 : The key is swf:tagList.member.3 . +// - tagList.member.4 : The key is swf:tagList.member.4 . +// - taskList : String constraint. The key is swf:taskList.name . +// - workflowType.name : String constraint. The key is swf:workflowType.name . +// - workflowType.version : String constraint. The key is +// swf:workflowType.version . // -// * Use a Resource element -// with the domain name to limit the action to only specified domains. -// -// * Use an -// Action element to allow or deny permission to call this action. -// -// * Constrain the -// following parameters by using a Condition element with the appropriate keys. -// -// * -// tagList.member.0: The key is swf:tagList.member.0. -// -// * tagList.member.1: The key -// is swf:tagList.member.1. -// -// * tagList.member.2: The key is -// swf:tagList.member.2. -// -// * tagList.member.3: The key is swf:tagList.member.3. -// -// * -// tagList.member.4: The key is swf:tagList.member.4. -// -// * taskList: String -// constraint. The key is swf:taskList.name. -// -// * workflowType.name: String -// constraint. The key is swf:workflowType.name. -// -// * workflowType.version: String -// constraint. The key is swf:workflowType.version. -// -// If the caller doesn't have -// sufficient permissions to invoke the action, or the parameter values fall -// outside the specified constraints, the action fails. The associated event -// attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and -// example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) StartWorkflowExecution(ctx context.Context, params *StartWorkflowExecutionInput, optFns ...func(*Options)) (*StartWorkflowExecutionOutput, error) { if params == nil { @@ -83,8 +64,8 @@ type StartWorkflowExecutionInput struct { // previous execution. You cannot have two open workflow executions with the same // workflowId at the same time within the same domain. The specified string must // not start or end with whitespace. It must not contain a : (colon), / (slash), | - // (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, - // it must not be the literal string arn. + // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). + // Also, it must not be the literal string arn . // // This member is required. WorkflowId *string @@ -98,30 +79,23 @@ type StartWorkflowExecutionInput struct { // workflow execution if it is terminated, by calling the // TerminateWorkflowExecution action explicitly or due to an expired timeout. This // policy overrides the default child policy specified when registering the - // workflow type using RegisterWorkflowType. The supported child policies are: - // - // * - // TERMINATE – The child executions are terminated. - // - // * REQUEST_CANCEL – A request - // to cancel is attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. - // - // A - // child policy for this workflow execution must be specified either as a default - // for the workflow type or through this parameter. If neither this parameter is - // set nor a default child policy was specified at registration time then a fault - // is returned. + // workflow type using RegisterWorkflowType . The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. ChildPolicy types.ChildPolicy // The total duration for this workflow execution. This overrides the // defaultExecutionStartToCloseTimeout specified when registering the workflow // type. The duration is specified in seconds; an integer greater than or equal to - // 0. Exceeding this limit causes the workflow execution to time out. Unlike some + // 0 . Exceeding this limit causes the workflow execution to time out. Unlike some // of the other timeout parameters in Amazon SWF, you cannot specify a value of // "NONE" for this timeout; there is a one-year max limit on the time that a // workflow execution can run. An execution start-to-close timeout must be @@ -130,24 +104,23 @@ type StartWorkflowExecutionInput struct { // timeout is specified, a fault is returned. ExecutionStartToCloseTimeout *string - // The input for the workflow execution. This is a free form string which should be - // meaningful to the workflow you are starting. This input is made available to the - // new workflow execution in the WorkflowExecutionStarted history event. + // The input for the workflow execution. This is a free form string which should + // be meaningful to the workflow you are starting. This input is made available to + // the new workflow execution in the WorkflowExecutionStarted history event. Input *string // The IAM role to attach to this workflow execution. Executions of this workflow // type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, // any attempt to schedule a Lambda task fails. This results in a // ScheduleLambdaFunctionFailed history event. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. LambdaRole *string // The list of tags to associate with the workflow execution. You can specify a // maximum of 5 tags. You can list workflow executions with a specific tag by // calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and - // specifying a TagFilter. + // specifying a TagFilter . TagList []string // The task list to use for the decision tasks generated for this workflow @@ -157,25 +130,24 @@ type StartWorkflowExecutionInput struct { // parameter is set nor a default task list was specified at registration time then // a fault is returned. The specified string must not start or end with whitespace. // It must not contain a : (colon), / (slash), | (vertical bar), or any control - // characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal - // string arn. + // characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not be the literal + // string arn . TaskList *types.TaskList - // The task priority to use for this workflow execution. This overrides any default - // priority that was assigned when the workflow type was registered. If not set, - // then the default task priority for the workflow type is used. Valid values are - // integers that range from Java's Integer.MIN_VALUE (-2147483648) to + // The task priority to use for this workflow execution. This overrides any + // default priority that was assigned when the workflow type was registered. If not + // set, then the default task priority for the workflow type is used. Valid values + // are integers that range from Java's Integer.MIN_VALUE (-2147483648) to // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // more information about setting task priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string // Specifies the maximum duration of decision tasks for this workflow execution. // This parameter overrides the defaultTaskStartToCloseTimout specified when - // registering the workflow type using RegisterWorkflowType. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A task start-to-close timeout for this workflow + // registering the workflow type using RegisterWorkflowType . The duration is + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. A task start-to-close timeout for this workflow // execution must be specified either as a default for the workflow type or through // this parameter. If neither this parameter is set nor a default task // start-to-close timeout was specified at registration time then a fault is diff --git a/service/swf/api_op_TagResource.go b/service/swf/api_op_TagResource.go index 463f7db9429..953ddf49908 100644 --- a/service/swf/api_op_TagResource.go +++ b/service/swf/api_op_TagResource.go @@ -36,7 +36,7 @@ type TagResourceInput struct { ResourceArn *string // The list of tags to add to a domain. Tags may only contain unicode letters, - // digits, whitespace, or these symbols: _ . : / = + - @. + // digits, whitespace, or these symbols: _ . : / = + - @ . // // This member is required. Tags []types.ResourceTag diff --git a/service/swf/api_op_TerminateWorkflowExecution.go b/service/swf/api_op_TerminateWorkflowExecution.go index 716695d357e..fc6b04bec01 100644 --- a/service/swf/api_op_TerminateWorkflowExecution.go +++ b/service/swf/api_op_TerminateWorkflowExecution.go @@ -23,22 +23,16 @@ import ( // gracefully close while TerminateWorkflowExecution doesn't. Access Control You // can use IAM policies to control this action's access to Amazon SWF resources as // follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) TerminateWorkflowExecution(ctx context.Context, params *TerminateWorkflowExecutionInput, optFns ...func(*Options)) (*TerminateWorkflowExecutionOutput, error) { if params == nil { @@ -71,22 +65,16 @@ type TerminateWorkflowExecutionInput struct { // workflow execution being terminated. This policy overrides the child policy // specified for the workflow execution at registration time or when starting the // execution. The supported child policies are: - // - // * TERMINATE – The child executions - // are terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted for each - // child execution by recording a WorkflowExecutionCancelRequested event in its - // history. It is up to the decider to take appropriate actions when it receives an - // execution history with this event. - // - // * ABANDON – No action is taken. The child - // executions continue to run. - // - // A child policy for this workflow execution must be - // specified either as a default for the workflow type or through this parameter. - // If neither this parameter is set nor a default child policy was specified at - // registration time then a fault is returned. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. ChildPolicy types.ChildPolicy // Details for terminating the workflow execution. diff --git a/service/swf/api_op_UndeprecateActivityType.go b/service/swf/api_op_UndeprecateActivityType.go index 3ed89abac63..eeab155a2cc 100644 --- a/service/swf/api_op_UndeprecateActivityType.go +++ b/service/swf/api_op_UndeprecateActivityType.go @@ -16,29 +16,20 @@ import ( // operation is eventually consistent. The results are best effort and may not // exactly reflect recent updates and changes. Access Control You can use IAM // policies to control this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - activityType.name : String constraint. The key is swf:activityType.name . +// - activityType.version : String constraint. The key is +// swf:activityType.version . // -// * -// Use a Resource element with the domain name to limit the action to only -// specified domains. -// -// * Use an Action element to allow or deny permission to call -// this action. -// -// * Constrain the following parameters by using a Condition element -// with the appropriate keys. -// -// * activityType.name: String constraint. The key is -// swf:activityType.name. -// -// * activityType.version: String constraint. The key is -// swf:activityType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) UndeprecateActivityType(ctx context.Context, params *UndeprecateActivityTypeInput, optFns ...func(*Options)) (*UndeprecateActivityTypeOutput, error) { if params == nil { diff --git a/service/swf/api_op_UndeprecateDomain.go b/service/swf/api_op_UndeprecateDomain.go index 2cc27504576..1a1cd967b22 100644 --- a/service/swf/api_op_UndeprecateDomain.go +++ b/service/swf/api_op_UndeprecateDomain.go @@ -14,24 +14,18 @@ import ( // undeprecated it can be used to create new workflow executions or register new // types. This operation is eventually consistent. The results are best effort and // may not exactly reflect recent updates and changes. Access Control You can use -// IAM policies to control this action's access to Amazon SWF resources as -// follows: +// IAM policies to control this action's access to Amazon SWF resources as follows: // -// * Use a Resource element with the domain name to limit the action to -// only specified domains. +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. // -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) UndeprecateDomain(ctx context.Context, params *UndeprecateDomainInput, optFns ...func(*Options)) (*UndeprecateDomainOutput, error) { if params == nil { diff --git a/service/swf/api_op_UndeprecateWorkflowType.go b/service/swf/api_op_UndeprecateWorkflowType.go index 10ea5de7f46..20c236bc79e 100644 --- a/service/swf/api_op_UndeprecateWorkflowType.go +++ b/service/swf/api_op_UndeprecateWorkflowType.go @@ -16,29 +16,20 @@ import ( // eventually consistent. The results are best effort and may not exactly reflect // recent updates and changes. Access Control You can use IAM policies to control // this action's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - workflowType.name : String constraint. The key is swf:workflowType.name . +// - workflowType.version : String constraint. The key is +// swf:workflowType.version . // -// * Use a Resource -// element with the domain name to limit the action to only specified domains. -// -// * -// Use an Action element to allow or deny permission to call this action. -// -// * -// Constrain the following parameters by using a Condition element with the -// appropriate keys. -// -// * workflowType.name: String constraint. The key is -// swf:workflowType.name. -// -// * workflowType.version: String constraint. The key is -// swf:workflowType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. func (c *Client) UndeprecateWorkflowType(ctx context.Context, params *UndeprecateWorkflowTypeInput, optFns ...func(*Options)) (*UndeprecateWorkflowTypeOutput, error) { if params == nil { diff --git a/service/swf/doc.go b/service/swf/doc.go index 5746b33ab66..1b27b35e856 100644 --- a/service/swf/doc.go +++ b/service/swf/doc.go @@ -12,6 +12,6 @@ // full control over implementing tasks and coordinating them without worrying // about underlying complexities such as tracking their progress and maintaining // their state. This documentation serves as reference only. For a broader overview -// of the Amazon SWF programming model, see the Amazon SWF Developer Guide -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/) . +// of the Amazon SWF programming model, see the Amazon SWF Developer Guide (https://docs.aws.amazon.com/amazonswf/latest/developerguide/) +// . package swf diff --git a/service/swf/types/enums.go b/service/swf/types/enums.go index f11545b4fcb..1b21a0a57a2 100644 --- a/service/swf/types/enums.go +++ b/service/swf/types/enums.go @@ -194,9 +194,9 @@ const ( DecisionTypeScheduleLambdaFunction DecisionType = "ScheduleLambdaFunction" ) -// Values returns all known values for DecisionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DecisionType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DecisionType) Values() []DecisionType { return []DecisionType{ "ScheduleActivityTask", @@ -275,9 +275,9 @@ const ( EventTypeStartLambdaFunctionFailed EventType = "StartLambdaFunctionFailed" ) -// Values returns all known values for EventType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for EventType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (EventType) Values() []EventType { return []EventType{ "WorkflowExecutionStarted", @@ -511,8 +511,8 @@ const ( ScheduleLambdaFunctionFailedCauseLambdaServiceNotAvailableInRegion ScheduleLambdaFunctionFailedCause = "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" ) -// Values returns all known values for ScheduleLambdaFunctionFailedCause. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for ScheduleLambdaFunctionFailedCause. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (ScheduleLambdaFunctionFailedCause) Values() []ScheduleLambdaFunctionFailedCause { @@ -562,9 +562,9 @@ const ( StartChildWorkflowExecutionFailedCauseOperationNotPermitted StartChildWorkflowExecutionFailedCause = "OPERATION_NOT_PERMITTED" ) -// Values returns all known values for StartChildWorkflowExecutionFailedCause. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for StartChildWorkflowExecutionFailedCause. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (StartChildWorkflowExecutionFailedCause) Values() []StartChildWorkflowExecutionFailedCause { return []StartChildWorkflowExecutionFailedCause{ @@ -609,8 +609,8 @@ const ( StartTimerFailedCauseOperationNotPermitted StartTimerFailedCause = "OPERATION_NOT_PERMITTED" ) -// Values returns all known values for StartTimerFailedCause. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for StartTimerFailedCause. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (StartTimerFailedCause) Values() []StartTimerFailedCause { return []StartTimerFailedCause{ @@ -666,9 +666,10 @@ const ( WorkflowExecutionTimeoutTypeStartToClose WorkflowExecutionTimeoutType = "START_TO_CLOSE" ) -// Values returns all known values for WorkflowExecutionTimeoutType. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for WorkflowExecutionTimeoutType. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (WorkflowExecutionTimeoutType) Values() []WorkflowExecutionTimeoutType { return []WorkflowExecutionTimeoutType{ "START_TO_CLOSE", diff --git a/service/swf/types/errors.go b/service/swf/types/errors.go index 4986e6bc221..8a642543c64 100644 --- a/service/swf/types/errors.go +++ b/service/swf/types/errors.go @@ -7,13 +7,14 @@ import ( smithy "github.com/aws/smithy-go" ) -// The StartWorkflowExecution API action was called without the required parameters -// set. Some workflow execution parameters, such as the decision taskList, must be -// set to start the execution. However, these parameters might have been set as -// defaults when the workflow type was registered. In this case, you can omit these -// parameters from the StartWorkflowExecution call and Amazon SWF uses the values -// defined in the workflow type. If these parameters aren't set and no default -// parameters were defined in the workflow type, this error is displayed. +// The StartWorkflowExecution API action was called without the required +// parameters set. Some workflow execution parameters, such as the decision +// taskList , must be set to start the execution. However, these parameters might +// have been set as defaults when the workflow type was registered. In this case, +// you can omit these parameters from the StartWorkflowExecution call and Amazon +// SWF uses the values defined in the workflow type. If these parameters aren't set +// and no default parameters were defined in the workflow type, this error is +// displayed. type DefaultUndefinedFault struct { Message *string diff --git a/service/swf/types/types.go b/service/swf/types/types.go index 1841f82e9d5..66daf8d91bd 100644 --- a/service/swf/types/types.go +++ b/service/swf/types/types.go @@ -134,9 +134,9 @@ type ActivityTaskScheduledEventAttributes struct { Control *string // The maximum time before which the worker processing this task must report - // progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the - // activity task is automatically timed out. If the worker subsequently attempts to - // record a heartbeat or return a result, it is ignored. + // progress by calling RecordActivityTaskHeartbeat . If the timeout is exceeded, + // the activity task is automatically timed out. If the worker subsequently + // attempts to record a heartbeat or return a result, it is ignored. HeartbeatTimeout *string // The input provided to the activity task. @@ -157,8 +157,7 @@ type ActivityTaskScheduledEventAttributes struct { // registered. Valid values are integers that range from Java's Integer.MIN_VALUE // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher // priority. For more information about setting task priority, see Setting Task - // Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string @@ -205,7 +204,7 @@ type ActivityTaskTimedOutEventAttributes struct { TimeoutType ActivityTaskTimeoutType // Contains the content of the details parameter for the last call made by the - // activity to RecordActivityTaskHeartbeat. + // activity to RecordActivityTaskHeartbeat . Details *string noSmithyDocumentSerde @@ -233,21 +232,21 @@ type ActivityType struct { type ActivityTypeConfiguration struct { // The default maximum time, in seconds, before which a worker processing a task - // must report progress by calling RecordActivityTaskHeartbeat. You can specify + // must report progress by calling RecordActivityTaskHeartbeat . You can specify // this value only when registering an activity type. The registered default value - // can be overridden when you schedule a task through the - // ScheduleActivityTaskDecision. If the activity worker subsequently attempts to - // record a heartbeat or returns a result, the activity worker receives an - // UnknownResource fault. In this case, Amazon SWF no longer considers the activity - // task to be valid; the activity worker should clean up the activity task. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. + // can be overridden when you schedule a task through the ScheduleActivityTask + // Decision . If the activity worker subsequently attempts to record a heartbeat or + // returns a result, the activity worker receives an UnknownResource fault. In + // this case, Amazon SWF no longer considers the activity task to be valid; the + // activity worker should clean up the activity task. The duration is specified in + // seconds, an integer greater than or equal to 0 . You can use NONE to specify + // unlimited duration. DefaultTaskHeartbeatTimeout *string // The default task list specified for this activity type at registration. This // default is used if a task list isn't provided when a task is scheduled through - // the ScheduleActivityTaskDecision. You can override the default registered task - // list when scheduling a task through the ScheduleActivityTaskDecision. + // the ScheduleActivityTask Decision . You can override the default registered task + // list when scheduling a task through the ScheduleActivityTask Decision . DefaultTaskList *TaskList // The default task priority for tasks of this activity type, specified at @@ -255,29 +254,28 @@ type ActivityTypeConfiguration struct { // can be overridden when scheduling an activity task. Valid values are integers // that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE // (2147483647). Higher numbers indicate higher priority. For more information - // about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // about setting task priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. DefaultTaskPriority *string // The default maximum duration, specified when registering the activity type, for // tasks of this activity type. You can override this default when scheduling a - // task through the ScheduleActivityTaskDecision. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify + // task through the ScheduleActivityTask Decision . The duration is specified in + // seconds, an integer greater than or equal to 0 . You can use NONE to specify // unlimited duration. DefaultTaskScheduleToCloseTimeout *string - // The default maximum duration, specified when registering the activity type, that - // a task of an activity type can wait before being assigned to a worker. You can - // override this default when scheduling a task through the - // ScheduleActivityTaskDecision. The duration is specified in seconds, an integer - // greater than or equal to 0. You can use NONE to specify unlimited duration. + // The default maximum duration, specified when registering the activity type, + // that a task of an activity type can wait before being assigned to a worker. You + // can override this default when scheduling a task through the + // ScheduleActivityTask Decision . The duration is specified in seconds, an integer + // greater than or equal to 0 . You can use NONE to specify unlimited duration. DefaultTaskScheduleToStartTimeout *string // The default maximum duration for tasks of an activity type specified when // registering the activity type. You can override this default when scheduling a - // task through the ScheduleActivityTaskDecision. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify + // task through the ScheduleActivityTask Decision . The duration is specified in + // seconds, an integer greater than or equal to 0 . You can use NONE to specify // unlimited duration. DefaultTaskStartToCloseTimeout *string @@ -292,7 +290,7 @@ type ActivityTypeInfo struct { // This member is required. ActivityType *ActivityType - // The date and time this activity type was created through RegisterActivityType. + // The date and time this activity type was created through RegisterActivityType . // // This member is required. CreationDate *time.Time @@ -305,31 +303,25 @@ type ActivityTypeInfo struct { // If DEPRECATED, the date and time DeprecateActivityType was called. DeprecationDate *time.Time - // The description of the activity type provided in RegisterActivityType. + // The description of the activity type provided in RegisterActivityType . Description *string noSmithyDocumentSerde } -// Provides the details of the CancelTimer decision. Access Control You can use IAM -// policies to control this decision's access to Amazon SWF resources as +// Provides the details of the CancelTimer decision. Access Control You can use +// IAM policies to control this decision's access to Amazon SWF resources as // follows: -// -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type CancelTimerDecisionAttributes struct { @@ -344,20 +336,19 @@ type CancelTimerDecisionAttributes struct { // Provides the details of the CancelTimerFailed event. type CancelTimerFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. Cause CancelTimerFailedCause // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the CancelTimer decision to cancel this timer. This information - // can be useful for diagnosing problems by tracing back the chain of events - // leading up to this event. + // that resulted in the CancelTimer decision to cancel this timer. This + // information can be useful for diagnosing problems by tracing back the chain of + // events leading up to this event. // // This member is required. DecisionTaskCompletedEventId int64 @@ -370,25 +361,19 @@ type CancelTimerFailedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the CancelWorkflowExecution decision. Access Control You -// can use IAM policies to control this decision's access to Amazon SWF resources -// as follows: -// -// * Use a Resource element with the domain name to limit the action -// to only specified domains. -// -// * Use an Action element to allow or deny permission -// to call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// Provides the details of the CancelWorkflowExecution decision. Access Control +// You can use IAM policies to control this decision's access to Amazon SWF +// resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type CancelWorkflowExecutionDecisionAttributes struct { @@ -401,11 +386,10 @@ type CancelWorkflowExecutionDecisionAttributes struct { // Provides the details of the CancelWorkflowExecutionFailed event. type CancelWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -426,9 +410,9 @@ type CancelWorkflowExecutionFailedEventAttributes struct { type ChildWorkflowExecutionCanceledEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -460,9 +444,9 @@ type ChildWorkflowExecutionCanceledEventAttributes struct { type ChildWorkflowExecutionCompletedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -494,9 +478,9 @@ type ChildWorkflowExecutionCompletedEventAttributes struct { type ChildWorkflowExecutionFailedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -531,9 +515,9 @@ type ChildWorkflowExecutionFailedEventAttributes struct { type ChildWorkflowExecutionStartedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -555,9 +539,9 @@ type ChildWorkflowExecutionStartedEventAttributes struct { type ChildWorkflowExecutionTerminatedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -586,9 +570,9 @@ type ChildWorkflowExecutionTerminatedEventAttributes struct { type ChildWorkflowExecutionTimedOutEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this child workflow execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // StartChildWorkflowExecution Decision to start this child workflow execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. InitiatedEventId int64 @@ -622,8 +606,8 @@ type ChildWorkflowExecutionTimedOutEventAttributes struct { // status. type CloseStatusFilter struct { - // The close status that must match the close status of an execution for it to meet - // the criteria of this filter. + // The close status that must match the close status of an execution for it to + // meet the criteria of this filter. // // This member is required. Status CloseStatus @@ -634,22 +618,16 @@ type CloseStatusFilter struct { // Provides the details of the CompleteWorkflowExecution decision. Access Control // You can use IAM policies to control this decision's access to Amazon SWF // resources as follows: -// -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * You cannot use an IAM policy to constrain -// this action's parameters. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type CompleteWorkflowExecutionDecisionAttributes struct { @@ -663,11 +641,10 @@ type CompleteWorkflowExecutionDecisionAttributes struct { // Provides the details of the CompleteWorkflowExecutionFailed event. type CompleteWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -687,65 +664,49 @@ type CompleteWorkflowExecutionFailedEventAttributes struct { // Provides the details of the ContinueAsNewWorkflowExecution decision. Access // Control You can use IAM policies to control this decision's access to Amazon SWF // resources as follows: -// -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * Constrain the following parameters by using a -// Condition element with the appropriate keys. -// -// * tag – A tag used to identify the -// workflow execution -// -// * taskList – String constraint. The key is -// swf:taskList.name. -// -// * workflowType.version – String constraint. The key is -// swf:workflowType.version. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tag – A tag used to identify the workflow execution +// - taskList – String constraint. The key is swf:taskList.name . +// - workflowType.version – String constraint. The key is +// swf:workflowType.version . +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type ContinueAsNewWorkflowExecutionDecisionAttributes struct { - // If set, specifies the policy to use for the child workflow executions of the new - // execution if it is terminated by calling the TerminateWorkflowExecution action - // explicitly or due to an expired timeout. This policy overrides the default child - // policy specified when registering the workflow type using RegisterWorkflowType. - // The supported child policies are: - // - // * TERMINATE – The child executions are - // terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted for each child - // execution by recording a WorkflowExecutionCancelRequested event in its history. - // It is up to the decider to take appropriate actions when it receives an - // execution history with this event. - // - // * ABANDON – No action is taken. The child - // executions continue to run. - // - // A child policy for this workflow execution must be - // specified either as a default for the workflow type or through this parameter. - // If neither this parameter is set nor a default child policy was specified at - // registration time then a fault is returned. + // If set, specifies the policy to use for the child workflow executions of the + // new execution if it is terminated by calling the TerminateWorkflowExecution + // action explicitly or due to an expired timeout. This policy overrides the + // default child policy specified when registering the workflow type using + // RegisterWorkflowType . The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. ChildPolicy ChildPolicy - // If set, specifies the total duration for this workflow execution. This overrides - // the defaultExecutionStartToCloseTimeout specified when registering the workflow - // type. The duration is specified in seconds, an integer greater than or equal to - // 0. You can use NONE to specify unlimited duration. An execution start-to-close - // timeout for this workflow execution must be specified either as a default for - // the workflow type or through this field. If neither this field is set nor a - // default execution start-to-close timeout was specified at registration time then - // a fault is returned. + // If set, specifies the total duration for this workflow execution. This + // overrides the defaultExecutionStartToCloseTimeout specified when registering + // the workflow type. The duration is specified in seconds, an integer greater than + // or equal to 0 . You can use NONE to specify unlimited duration. An execution + // start-to-close timeout for this workflow execution must be specified either as a + // default for the workflow type or through this field. If neither this field is + // set nor a default execution start-to-close timeout was specified at registration + // time then a fault is returned. ExecutionStartToCloseTimeout *string // The input provided to the new workflow execution. @@ -757,7 +718,7 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // The list of tags to associate with the new workflow execution. A maximum of 5 // tags can be specified. You can list workflow executions with a specific tag by // calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and - // specifying a TagFilter. + // specifying a TagFilter . TagList []string // The task list to use for the decisions of the new (continued) workflow @@ -767,20 +728,19 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // The task priority that, if set, specifies the priority for the decision tasks // for this workflow execution. This overrides the defaultTaskPriority specified // when registering the workflow type. Valid values are integers that range from - // Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher - // numbers indicate higher priority. For more information about setting task - // priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). + // Higher numbers indicate higher priority. For more information about setting task + // priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string - // Specifies the maximum duration of decision tasks for the new workflow execution. - // This parameter overrides the defaultTaskStartToCloseTimout specified when - // registering the workflow type using RegisterWorkflowType. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A task start-to-close timeout for the new workflow - // execution must be specified either as a default for the workflow type or through - // this parameter. If neither this parameter is set nor a default task + // Specifies the maximum duration of decision tasks for the new workflow + // execution. This parameter overrides the defaultTaskStartToCloseTimout specified + // when registering the workflow type using RegisterWorkflowType . The duration is + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. A task start-to-close timeout for the new + // workflow execution must be specified either as a default for the workflow type + // or through this parameter. If neither this parameter is set nor a default task // start-to-close timeout was specified at registration time then a fault is // returned. TaskStartToCloseTimeout *string @@ -794,11 +754,10 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // Provides the details of the ContinueAsNewWorkflowExecutionFailed event. type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -815,145 +774,101 @@ type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { noSmithyDocumentSerde } -// Specifies a decision made by the decider. A decision can be one of these -// types: -// -// * CancelTimer – Cancels a previously started timer and records a -// TimerCanceled event in the history. -// -// * CancelWorkflowExecution – Closes the -// workflow execution and records a WorkflowExecutionCanceled event in the -// history. -// -// * CompleteWorkflowExecution – Closes the workflow execution and -// records a WorkflowExecutionCompleted event in the history . -// -// * -// ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new -// workflow execution of the same type using the same workflow ID and a unique run -// Id. A WorkflowExecutionContinuedAsNew event is recorded in the history. -// -// * -// FailWorkflowExecution – Closes the workflow execution and records a -// WorkflowExecutionFailed event in the history. -// -// * RecordMarker – Records a -// MarkerRecorded event in the history. Markers can be used for adding custom -// information in the history for instance to let deciders know that they don't -// need to look at the history beyond the marker event. -// -// * -// RequestCancelActivityTask – Attempts to cancel a previously scheduled activity -// task. If the activity task was scheduled but has not been assigned to a worker, -// then it is canceled. If the activity task was already assigned to a worker, then -// the worker is informed that cancellation has been requested in the response to -// RecordActivityTaskHeartbeat. -// -// * RequestCancelExternalWorkflowExecution – -// Requests that a request be made to cancel the specified external workflow -// execution and records a RequestCancelExternalWorkflowExecutionInitiated event in -// the history. -// -// * ScheduleActivityTask – Schedules an activity task. -// -// * -// SignalExternalWorkflowExecution – Requests a signal to be delivered to the -// specified external workflow execution and records a -// SignalExternalWorkflowExecutionInitiated event in the history. -// -// * -// StartChildWorkflowExecution – Requests that a child workflow execution be -// started and records a StartChildWorkflowExecutionInitiated event in the history. -// The child workflow execution is a separate workflow execution with its own -// history. -// -// * StartTimer – Starts a timer for this workflow execution and records -// a TimerStarted event in the history. This timer fires after the specified delay -// and record a TimerFired event. -// -// Access Control If you grant permission to use -// RespondDecisionTaskCompleted, you can use IAM policies to express permissions -// for the list of decisions returned by this action as if they were members of the -// API. Treating decisions as a pseudo API maintains a uniform conceptual model and -// helps keep policies readable. For details and example IAM policies, see Using -// IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// Specifies a decision made by the decider. A decision can be one of these types: +// - CancelTimer – Cancels a previously started timer and records a TimerCanceled +// event in the history. +// - CancelWorkflowExecution – Closes the workflow execution and records a +// WorkflowExecutionCanceled event in the history. +// - CompleteWorkflowExecution – Closes the workflow execution and records a +// WorkflowExecutionCompleted event in the history . +// - ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a +// new workflow execution of the same type using the same workflow ID and a unique +// run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history. +// - FailWorkflowExecution – Closes the workflow execution and records a +// WorkflowExecutionFailed event in the history. +// - RecordMarker – Records a MarkerRecorded event in the history. Markers can be +// used for adding custom information in the history for instance to let deciders +// know that they don't need to look at the history beyond the marker event. +// - RequestCancelActivityTask – Attempts to cancel a previously scheduled +// activity task. If the activity task was scheduled but has not been assigned to a +// worker, then it is canceled. If the activity task was already assigned to a +// worker, then the worker is informed that cancellation has been requested in the +// response to RecordActivityTaskHeartbeat . +// - RequestCancelExternalWorkflowExecution – Requests that a request be made to +// cancel the specified external workflow execution and records a +// RequestCancelExternalWorkflowExecutionInitiated event in the history. +// - ScheduleActivityTask – Schedules an activity task. +// - SignalExternalWorkflowExecution – Requests a signal to be delivered to the +// specified external workflow execution and records a +// SignalExternalWorkflowExecutionInitiated event in the history. +// - StartChildWorkflowExecution – Requests that a child workflow execution be +// started and records a StartChildWorkflowExecutionInitiated event in the +// history. The child workflow execution is a separate workflow execution with its +// own history. +// - StartTimer – Starts a timer for this workflow execution and records a +// TimerStarted event in the history. This timer fires after the specified delay +// and record a TimerFired event. +// +// Access Control If you grant permission to use RespondDecisionTaskCompleted , you +// can use IAM policies to express permissions for the list of decisions returned +// by this action as if they were members of the API. Treating decisions as a +// pseudo API maintains a uniform conceptual model and helps keep policies +// readable. For details and example IAM policies, see Using IAM to Manage Access +// to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. Decision Failure Decisions can fail for // several reasons -// -// * The ordering of decisions should follow a logical flow. Some -// decisions might not make sense in the current context of the workflow execution -// and therefore fails. -// -// * A limit on your account was reached. -// -// * The decision -// lacks sufficient permissions. -// -// One of the following events might be added to the -// history to indicate an error. The event attribute's cause parameter indicates -// the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed -// because it lacked sufficient permissions. For details and example IAM policies, -// see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - The ordering of decisions should follow a logical flow. Some decisions +// might not make sense in the current context of the workflow execution and +// therefore fails. +// - A limit on your account was reached. +// - The decision lacks sufficient permissions. +// +// One of the following events might be added to the history to indicate an error. +// The event attribute's cause parameter indicates the cause. If cause is set to +// OPERATION_NOT_PERMITTED , the decision failed because it lacked sufficient +// permissions. For details and example IAM policies, see Using IAM to Manage +// Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. -// -// * ScheduleActivityTaskFailed – A -// ScheduleActivityTask decision failed. This could happen if the activity type -// specified in the decision isn't registered, is in a deprecated state, or the -// decision isn't properly configured. -// -// * RequestCancelActivityTaskFailed – A -// RequestCancelActivityTask decision failed. This could happen if there is no open -// activity task with the specified activityId. -// -// * StartTimerFailed – A StartTimer -// decision failed. This could happen if there is another open timer with the same -// timerId. -// -// * CancelTimerFailed – A CancelTimer decision failed. This could happen -// if there is no open timer with the specified timerId. -// -// * -// StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision -// failed. This could happen if the workflow type specified isn't registered, is -// deprecated, or the decision isn't properly configured. -// -// * -// SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution -// decision failed. This could happen if the workflowID specified in the decision -// was incorrect. -// -// * RequestCancelExternalWorkflowExecutionFailed – A -// RequestCancelExternalWorkflowExecution decision failed. This could happen if the -// workflowID specified in the decision was incorrect. -// -// * -// CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This -// could happen if there is an unhandled decision task pending in the workflow -// execution. -// -// * CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution -// decision failed. This could happen if there is an unhandled decision task -// pending in the workflow execution. -// -// * ContinueAsNewWorkflowExecutionFailed – A -// ContinueAsNewWorkflowExecution decision failed. This could happen if there is an -// unhandled decision task pending in the workflow execution or the -// ContinueAsNewWorkflowExecution decision was not configured correctly. -// -// * -// FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This -// could happen if there is an unhandled decision task pending in the workflow -// execution. -// -// The preceding error events might occur due to an error in the -// decider logic, which might put the workflow execution in an unstable state The -// cause field in the event structure for the error event indicates the cause of -// the error. A workflow execution may be closed by the decider by returning one of -// the following decisions when completing a decision task: -// CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and -// ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a +// - ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This +// could happen if the activity type specified in the decision isn't registered, is +// in a deprecated state, or the decision isn't properly configured. +// - RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision +// failed. This could happen if there is no open activity task with the specified +// activityId. +// - StartTimerFailed – A StartTimer decision failed. This could happen if there +// is another open timer with the same timerId. +// - CancelTimerFailed – A CancelTimer decision failed. This could happen if +// there is no open timer with the specified timerId. +// - StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision +// failed. This could happen if the workflow type specified isn't registered, is +// deprecated, or the decision isn't properly configured. +// - SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution +// decision failed. This could happen if the workflowID specified in the decision +// was incorrect. +// - RequestCancelExternalWorkflowExecutionFailed – A +// RequestCancelExternalWorkflowExecution decision failed. This could happen if +// the workflowID specified in the decision was incorrect. +// - CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. +// This could happen if there is an unhandled decision task pending in the workflow +// execution. +// - CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision +// failed. This could happen if there is an unhandled decision task pending in the +// workflow execution. +// - ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution +// decision failed. This could happen if there is an unhandled decision task +// pending in the workflow execution or the ContinueAsNewWorkflowExecution decision +// was not configured correctly. +// - FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This +// could happen if there is an unhandled decision task pending in the workflow +// execution. +// +// The preceding error events might occur due to an error in the decider logic, +// which might put the workflow execution in an unstable state The cause field in +// the event structure for the error event indicates the cause of the error. A +// workflow execution may be closed by the decider by returning one of the +// following decisions when completing a decision task: CompleteWorkflowExecution , +// FailWorkflowExecution , CancelWorkflowExecution and +// ContinueAsNewWorkflowExecution . An UnhandledDecision fault is returned if a // workflow closing decision is specified and a signal or activity event had been // added to the history while the decision task was being performed by the decider. // Unlike the above situations which are logic issues, this fault is always @@ -964,41 +879,18 @@ type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { // execution. How to Code a Decision You code a decision by first setting the // decision type field to one of the above decision values, and then set the // corresponding attributes field shown below: -// -// * -// ScheduleActivityTaskDecisionAttributes -// -// * -// RequestCancelActivityTaskDecisionAttributes -// -// * -// CompleteWorkflowExecutionDecisionAttributes -// -// * -// FailWorkflowExecutionDecisionAttributes -// -// * -// CancelWorkflowExecutionDecisionAttributes -// -// * -// ContinueAsNewWorkflowExecutionDecisionAttributes -// -// * -// RecordMarkerDecisionAttributes -// -// * StartTimerDecisionAttributes -// -// * -// CancelTimerDecisionAttributes -// -// * -// SignalExternalWorkflowExecutionDecisionAttributes -// -// * -// RequestCancelExternalWorkflowExecutionDecisionAttributes -// -// * -// StartChildWorkflowExecutionDecisionAttributes +// - ScheduleActivityTaskDecisionAttributes +// - RequestCancelActivityTaskDecisionAttributes +// - CompleteWorkflowExecutionDecisionAttributes +// - FailWorkflowExecutionDecisionAttributes +// - CancelWorkflowExecutionDecisionAttributes +// - ContinueAsNewWorkflowExecutionDecisionAttributes +// - RecordMarkerDecisionAttributes +// - StartTimerDecisionAttributes +// - CancelTimerDecisionAttributes +// - SignalExternalWorkflowExecutionDecisionAttributes +// - RequestCancelExternalWorkflowExecutionDecisionAttributes +// - StartChildWorkflowExecutionDecisionAttributes type Decision struct { // Specifies the type of the decision. @@ -1014,8 +906,8 @@ type Decision struct { // other decision types. CancelWorkflowExecutionDecisionAttributes *CancelWorkflowExecutionDecisionAttributes - // Provides the details of the CompleteWorkflowExecution decision. It isn't set for - // other decision types. + // Provides the details of the CompleteWorkflowExecution decision. It isn't set + // for other decision types. CompleteWorkflowExecutionDecisionAttributes *CompleteWorkflowExecutionDecisionAttributes // Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't @@ -1030,8 +922,8 @@ type Decision struct { // decision types. RecordMarkerDecisionAttributes *RecordMarkerDecisionAttributes - // Provides the details of the RequestCancelActivityTask decision. It isn't set for - // other decision types. + // Provides the details of the RequestCancelActivityTask decision. It isn't set + // for other decision types. RequestCancelActivityTaskDecisionAttributes *RequestCancelActivityTaskDecisionAttributes // Provides the details of the RequestCancelExternalWorkflowExecution decision. It @@ -1054,8 +946,8 @@ type Decision struct { // for other decision types. StartChildWorkflowExecutionDecisionAttributes *StartChildWorkflowExecutionDecisionAttributes - // Provides the details of the StartTimer decision. It isn't set for other decision - // types. + // Provides the details of the StartTimer decision. It isn't set for other + // decision types. StartTimerDecisionAttributes *StartTimerDecisionAttributes noSmithyDocumentSerde @@ -1092,17 +984,17 @@ type DecisionTaskScheduledEventAttributes struct { // This member is required. TaskList *TaskList - // The maximum duration for this decision task. The task is considered timed out if - // it doesn't completed within this duration. The duration is specified in seconds, - // an integer greater than or equal to 0. You can use NONE to specify unlimited - // duration. + // The maximum duration for this decision task. The task is considered timed out + // if it doesn't completed within this duration. The duration is specified in + // seconds, an integer greater than or equal to 0 . You can use NONE to specify + // unlimited duration. StartToCloseTimeout *string // A task priority that, if set, specifies the priority for this decision task. - // Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) - // to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Valid values are integers that range from Java's Integer.MIN_VALUE + // (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher + // priority. For more information about setting task priority, see Setting Task + // Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string @@ -1119,8 +1011,8 @@ type DecisionTaskStartedEventAttributes struct { // This member is required. ScheduledEventId int64 - // Identity of the decider making the request. This enables diagnostic tracing when - // problems arise. The form of this identity is user defined. + // Identity of the decider making the request. This enables diagnostic tracing + // when problems arise. The form of this identity is user defined. Identity *string noSmithyDocumentSerde @@ -1171,14 +1063,10 @@ type DomainInfo struct { Name *string // The status of the domain: - // - // * REGISTERED – The domain is properly registered and - // available. You can use this domain for registering types and creating new - // workflow executions. - // - // * DEPRECATED – The domain was deprecated using - // DeprecateDomain, but is still in use. You should not create new workflow - // executions in this domain. + // - REGISTERED – The domain is properly registered and available. You can use + // this domain for registering types and creating new workflow executions. + // - DEPRECATED – The domain was deprecated using DeprecateDomain , but is still + // in use. You should not create new workflow executions in this domain. // // This member is required. Status RegistrationStatus @@ -1186,7 +1074,7 @@ type DomainInfo struct { // The ARN of the domain. Arn *string - // The description of the domain provided through RegisterDomain. + // The description of the domain provided through RegisterDomain . Description *string noSmithyDocumentSerde @@ -1194,9 +1082,8 @@ type DomainInfo struct { // Used to filter the workflow executions in visibility APIs by various time-based // rules. Each parameter, if specified, defines a rule that must be satisfied by -// each returned query result. The parameter values are in the Unix Time format -// (https://en.wikipedia.org/wiki/Unix_time). For example: "oldestDate": -// 1325376070. +// each returned query result. The parameter values are in the Unix Time format (https://en.wikipedia.org/wiki/Unix_time) +// . For example: "oldestDate": 1325376070. type ExecutionTimeFilter struct { // Specifies the oldest start or close date and time to return. @@ -1251,22 +1138,16 @@ type ExternalWorkflowExecutionSignaledEventAttributes struct { // Provides the details of the FailWorkflowExecution decision. Access Control You // can use IAM policies to control this decision's access to Amazon SWF resources // as follows: -// -// * Use a Resource element with the domain name to limit the action -// to only specified domains. -// -// * Use an Action element to allow or deny permission -// to call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type FailWorkflowExecutionDecisionAttributes struct { @@ -1282,20 +1163,19 @@ type FailWorkflowExecutionDecisionAttributes struct { // Provides the details of the FailWorkflowExecutionFailed event. type FailWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. Cause FailWorkflowExecutionFailedCause // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the FailWorkflowExecution decision to fail this execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // that resulted in the FailWorkflowExecution decision to fail this execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. DecisionTaskCompletedEventId int64 @@ -1305,175 +1185,146 @@ type FailWorkflowExecutionFailedEventAttributes struct { // Event within a workflow execution. A history event can be one of these types: // -// * -// ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received -// by the system. +// - ActivityTaskCancelRequested – A RequestCancelActivityTask decision was +// received by the system. // -// * ActivityTaskCanceled – The activity task was successfully -// canceled. +// - ActivityTaskCanceled – The activity task was successfully canceled. // -// * ActivityTaskCompleted – An activity worker successfully completed -// an activity task by calling RespondActivityTaskCompleted. +// - ActivityTaskCompleted – An activity worker successfully completed an +// activity task by calling RespondActivityTaskCompleted . // -// * ActivityTaskFailed -// – An activity worker failed an activity task by calling -// RespondActivityTaskFailed. +// - ActivityTaskFailed – An activity worker failed an activity task by calling +// RespondActivityTaskFailed . // -// * ActivityTaskScheduled – An activity task was -// scheduled for execution. +// - ActivityTaskScheduled – An activity task was scheduled for execution. // -// * ActivityTaskStarted – The scheduled activity task -// was dispatched to a worker. +// - ActivityTaskStarted – The scheduled activity task was dispatched to a +// worker. // -// * ActivityTaskTimedOut – The activity task timed -// out. +// - ActivityTaskTimedOut – The activity task timed out. // -// * CancelTimerFailed – Failed to process CancelTimer decision. This happens -// when the decision isn't configured properly, for example no timer exists with -// the specified timer Id. +// - CancelTimerFailed – Failed to process CancelTimer decision. This happens +// when the decision isn't configured properly, for example no timer exists with +// the specified timer Id. // -// * CancelWorkflowExecutionFailed – A request to cancel a -// workflow execution failed. +// - CancelWorkflowExecutionFailed – A request to cancel a workflow execution +// failed. // -// * ChildWorkflowExecutionCanceled – A child workflow -// execution, started by this workflow execution, was canceled and closed. +// - ChildWorkflowExecutionCanceled – A child workflow execution, started by this +// workflow execution, was canceled and closed. // -// * -// ChildWorkflowExecutionCompleted – A child workflow execution, started by this -// workflow execution, completed successfully and was closed. +// - ChildWorkflowExecutionCompleted – A child workflow execution, started by +// this workflow execution, completed successfully and was closed. // -// * -// ChildWorkflowExecutionFailed – A child workflow execution, started by this -// workflow execution, failed to complete successfully and was closed. +// - ChildWorkflowExecutionFailed – A child workflow execution, started by this +// workflow execution, failed to complete successfully and was closed. // -// * -// ChildWorkflowExecutionStarted – A child workflow execution was successfully -// started. +// - ChildWorkflowExecutionStarted – A child workflow execution was successfully +// started. // -// * ChildWorkflowExecutionTerminated – A child workflow execution, -// started by this workflow execution, was terminated. +// - ChildWorkflowExecutionTerminated – A child workflow execution, started by +// this workflow execution, was terminated. // -// * -// ChildWorkflowExecutionTimedOut – A child workflow execution, started by this -// workflow execution, timed out and was closed. +// - ChildWorkflowExecutionTimedOut – A child workflow execution, started by this +// workflow execution, timed out and was closed. // -// * CompleteWorkflowExecutionFailed -// – The workflow execution failed to complete. +// - CompleteWorkflowExecutionFailed – The workflow execution failed to complete. // -// * -// ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete -// after being continued as a new workflow execution. +// - ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to +// complete after being continued as a new workflow execution. // -// * DecisionTaskCompleted – -// The decider successfully completed a decision task by calling -// RespondDecisionTaskCompleted. +// - DecisionTaskCompleted – The decider successfully completed a decision task +// by calling RespondDecisionTaskCompleted . // -// * DecisionTaskScheduled – A decision task was -// scheduled for the workflow execution. +// - DecisionTaskScheduled – A decision task was scheduled for the workflow +// execution. // -// * DecisionTaskStarted – The decision task -// was dispatched to a decider. +// - DecisionTaskStarted – The decision task was dispatched to a decider. // -// * DecisionTaskTimedOut – The decision task timed -// out. +// - DecisionTaskTimedOut – The decision task timed out. // -// * ExternalWorkflowExecutionCancelRequested – Request to cancel an external -// workflow execution was successfully delivered to the target execution. +// - ExternalWorkflowExecutionCancelRequested – Request to cancel an external +// workflow execution was successfully delivered to the target execution. // -// * -// ExternalWorkflowExecutionSignaled – A signal, requested by this workflow -// execution, was successfully delivered to the target external workflow -// execution. +// - ExternalWorkflowExecutionSignaled – A signal, requested by this workflow +// execution, was successfully delivered to the target external workflow execution. // -// * FailWorkflowExecutionFailed – A request to mark a workflow -// execution as failed, itself failed. +// - FailWorkflowExecutionFailed – A request to mark a workflow execution as +// failed, itself failed. // -// * MarkerRecorded – A marker was recorded in -// the workflow history as the result of a RecordMarker decision. +// - MarkerRecorded – A marker was recorded in the workflow history as the result +// of a RecordMarker decision. // -// * -// RecordMarkerFailed – A RecordMarker decision was returned as failed. +// - RecordMarkerFailed – A RecordMarker decision was returned as failed. // -// * -// RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask -// decision. This happens when the decision isn't configured properly. +// - RequestCancelActivityTaskFailed – Failed to process +// RequestCancelActivityTask decision. This happens when the decision isn't +// configured properly. // -// * -// RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external -// workflow execution failed. +// - RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external +// workflow execution failed. // -// * RequestCancelExternalWorkflowExecutionInitiated – -// A request was made to request the cancellation of an external workflow -// execution. +// - RequestCancelExternalWorkflowExecutionInitiated – A request was made to +// request the cancellation of an external workflow execution. // -// * ScheduleActivityTaskFailed – Failed to process -// ScheduleActivityTask decision. This happens when the decision isn't configured -// properly, for example the activity type specified isn't registered. +// - ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask +// decision. This happens when the decision isn't configured properly, for example +// the activity type specified isn't registered. // -// * -// SignalExternalWorkflowExecutionFailed – The request to signal an external -// workflow execution failed. +// - SignalExternalWorkflowExecutionFailed – The request to signal an external +// workflow execution failed. // -// * SignalExternalWorkflowExecutionInitiated – A -// request to signal an external workflow was made. +// - SignalExternalWorkflowExecutionInitiated – A request to signal an external +// workflow was made. // -// * StartActivityTaskFailed – A -// scheduled activity task failed to start. +// - StartActivityTaskFailed – A scheduled activity task failed to start. // -// * StartChildWorkflowExecutionFailed – -// Failed to process StartChildWorkflowExecution decision. This happens when the -// decision isn't configured properly, for example the workflow type specified -// isn't registered. +// - StartChildWorkflowExecutionFailed – Failed to process +// StartChildWorkflowExecution decision. This happens when the decision isn't +// configured properly, for example the workflow type specified isn't registered. // -// * StartChildWorkflowExecutionInitiated – A request was made -// to start a child workflow execution. +// - StartChildWorkflowExecutionInitiated – A request was made to start a child +// workflow execution. // -// * StartTimerFailed – Failed to process -// StartTimer decision. This happens when the decision isn't configured properly, -// for example a timer already exists with the specified timer Id. +// - StartTimerFailed – Failed to process StartTimer decision. This happens when +// the decision isn't configured properly, for example a timer already exists with +// the specified timer Id. // -// * TimerCanceled -// – A timer, previously started for this workflow execution, was successfully -// canceled. +// - TimerCanceled – A timer, previously started for this workflow execution, was +// successfully canceled. // -// * TimerFired – A timer, previously started for this workflow -// execution, fired. +// - TimerFired – A timer, previously started for this workflow execution, fired. // -// * TimerStarted – A timer was started for the workflow -// execution due to a StartTimer decision. +// - TimerStarted – A timer was started for the workflow execution due to a +// StartTimer decision. // -// * WorkflowExecutionCancelRequested – A -// request to cancel this workflow execution was made. +// - WorkflowExecutionCancelRequested – A request to cancel this workflow +// execution was made. // -// * WorkflowExecutionCanceled -// – The workflow execution was successfully canceled and closed. +// - WorkflowExecutionCanceled – The workflow execution was successfully canceled +// and closed. // -// * -// WorkflowExecutionCompleted – The workflow execution was closed due to successful -// completion. +// - WorkflowExecutionCompleted – The workflow execution was closed due to +// successful completion. // -// * WorkflowExecutionContinuedAsNew – The workflow execution was -// closed and a new execution of the same type was created with the same -// workflowId. +// - WorkflowExecutionContinuedAsNew – The workflow execution was closed and a +// new execution of the same type was created with the same workflowId. // -// * WorkflowExecutionFailed – The workflow execution closed due to a -// failure. +// - WorkflowExecutionFailed – The workflow execution closed due to a failure. // -// * WorkflowExecutionSignaled – An external signal was received for the -// workflow execution. +// - WorkflowExecutionSignaled – An external signal was received for the workflow +// execution. // -// * WorkflowExecutionStarted – The workflow execution was -// started. +// - WorkflowExecutionStarted – The workflow execution was started. // -// * WorkflowExecutionTerminated – The workflow execution was -// terminated. +// - WorkflowExecutionTerminated – The workflow execution was terminated. // -// * WorkflowExecutionTimedOut – The workflow execution was closed -// because a time out was exceeded. +// - WorkflowExecutionTimedOut – The workflow execution was closed because a time +// out was exceeded. type HistoryEvent struct { - // The system generated ID of the event. This ID uniquely identifies the event with - // in the workflow execution history. + // The system generated ID of the event. This ID uniquely identifies the event + // with in the workflow execution history. // // This member is required. EventId int64 @@ -1512,8 +1363,9 @@ type HistoryEvent struct { // types. ActivityTaskScheduledEventAttributes *ActivityTaskScheduledEventAttributes - // If the event is of type ActivityTaskStarted then this member is set and provides - // detailed information about the event. It isn't set for other event types. + // If the event is of type ActivityTaskStarted then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. ActivityTaskStartedEventAttributes *ActivityTaskStartedEventAttributes // If the event is of type ActivityTaskTimedOut then this member is set and @@ -1540,8 +1392,8 @@ type HistoryEvent struct { // types. ChildWorkflowExecutionCompletedEventAttributes *ChildWorkflowExecutionCompletedEventAttributes - // If the event is of type ChildWorkflowExecutionFailed then this member is set and - // provides detailed information about the event. It isn't set for other event + // If the event is of type ChildWorkflowExecutionFailed then this member is set + // and provides detailed information about the event. It isn't set for other event // types. ChildWorkflowExecutionFailedEventAttributes *ChildWorkflowExecutionFailedEventAttributes @@ -1550,9 +1402,9 @@ type HistoryEvent struct { // types. ChildWorkflowExecutionStartedEventAttributes *ChildWorkflowExecutionStartedEventAttributes - // If the event is of type ChildWorkflowExecutionTerminated then this member is set - // and provides detailed information about the event. It isn't set for other event - // types. + // If the event is of type ChildWorkflowExecutionTerminated then this member is + // set and provides detailed information about the event. It isn't set for other + // event types. ChildWorkflowExecutionTerminatedEventAttributes *ChildWorkflowExecutionTerminatedEventAttributes // If the event is of type ChildWorkflowExecutionTimedOut then this member is set @@ -1565,8 +1417,8 @@ type HistoryEvent struct { // types. CompleteWorkflowExecutionFailedEventAttributes *CompleteWorkflowExecutionFailedEventAttributes - // If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is - // set and provides detailed information about the event. It isn't set for other + // If the event is of type ContinueAsNewWorkflowExecutionFailed then this member + // is set and provides detailed information about the event. It isn't set for other // event types. ContinueAsNewWorkflowExecutionFailedEventAttributes *ContinueAsNewWorkflowExecutionFailedEventAttributes @@ -1580,8 +1432,9 @@ type HistoryEvent struct { // types. DecisionTaskScheduledEventAttributes *DecisionTaskScheduledEventAttributes - // If the event is of type DecisionTaskStarted then this member is set and provides - // detailed information about the event. It isn't set for other event types. + // If the event is of type DecisionTaskStarted then this member is set and + // provides detailed information about the event. It isn't set for other event + // types. DecisionTaskStartedEventAttributes *DecisionTaskStartedEventAttributes // If the event is of type DecisionTaskTimedOut then this member is set and @@ -1620,8 +1473,8 @@ type HistoryEvent struct { // event types. LambdaFunctionStartedEventAttributes *LambdaFunctionStartedEventAttributes - // Provides the details of the LambdaFunctionTimedOut event. It isn't set for other - // event types. + // Provides the details of the LambdaFunctionTimedOut event. It isn't set for + // other event types. LambdaFunctionTimedOutEventAttributes *LambdaFunctionTimedOutEventAttributes // If the event is of type MarkerRecorded then this member is set and provides @@ -1652,8 +1505,8 @@ type HistoryEvent struct { // types. ScheduleActivityTaskFailedEventAttributes *ScheduleActivityTaskFailedEventAttributes - // Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for - // other event types. + // Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set + // for other event types. ScheduleLambdaFunctionFailedEventAttributes *ScheduleLambdaFunctionFailedEventAttributes // If the event is of type SignalExternalWorkflowExecutionFailed then this member @@ -1671,8 +1524,8 @@ type HistoryEvent struct { // event types. StartChildWorkflowExecutionFailedEventAttributes *StartChildWorkflowExecutionFailedEventAttributes - // If the event is of type StartChildWorkflowExecutionInitiated then this member is - // set and provides detailed information about the event. It isn't set for other + // If the event is of type StartChildWorkflowExecutionInitiated then this member + // is set and provides detailed information about the event. It isn't set for other // event types. StartChildWorkflowExecutionInitiatedEventAttributes *StartChildWorkflowExecutionInitiatedEventAttributes @@ -1688,17 +1541,17 @@ type HistoryEvent struct { // detailed information about the event. It isn't set for other event types. TimerCanceledEventAttributes *TimerCanceledEventAttributes - // If the event is of type TimerFired then this member is set and provides detailed - // information about the event. It isn't set for other event types. + // If the event is of type TimerFired then this member is set and provides + // detailed information about the event. It isn't set for other event types. TimerFiredEventAttributes *TimerFiredEventAttributes // If the event is of type TimerStarted then this member is set and provides // detailed information about the event. It isn't set for other event types. TimerStartedEventAttributes *TimerStartedEventAttributes - // If the event is of type WorkflowExecutionCancelRequested then this member is set - // and provides detailed information about the event. It isn't set for other event - // types. + // If the event is of type WorkflowExecutionCancelRequested then this member is + // set and provides detailed information about the event. It isn't set for other + // event types. WorkflowExecutionCancelRequestedEventAttributes *WorkflowExecutionCancelRequestedEventAttributes // If the event is of type WorkflowExecutionCanceled then this member is set and @@ -1772,9 +1625,9 @@ type LambdaFunctionCompletedEventAttributes struct { // event types. type LambdaFunctionFailedEventAttributes struct { - // The ID of the LambdaFunctionScheduled event that was recorded when this activity - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. + // The ID of the LambdaFunctionScheduled event that was recorded when this + // activity task was scheduled. To help diagnose issues, use this information to + // trace back the chain of events leading up to this event. // // This member is required. ScheduledEventId int64 @@ -1833,9 +1686,9 @@ type LambdaFunctionScheduledEventAttributes struct { // event types. type LambdaFunctionStartedEventAttributes struct { - // The ID of the LambdaFunctionScheduled event that was recorded when this activity - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. + // The ID of the LambdaFunctionScheduled event that was recorded when this + // activity task was scheduled. To help diagnose issues, use this information to + // trace back the chain of events leading up to this event. // // This member is required. ScheduledEventId int64 @@ -1846,9 +1699,9 @@ type LambdaFunctionStartedEventAttributes struct { // Provides details of the LambdaFunctionTimedOut event. type LambdaFunctionTimedOutEventAttributes struct { - // The ID of the LambdaFunctionScheduled event that was recorded when this activity - // task was scheduled. To help diagnose issues, use this information to trace back - // the chain of events leading up to this event. + // The ID of the LambdaFunctionScheduled event that was recorded when this + // activity task was scheduled. To help diagnose issues, use this information to + // trace back the chain of events leading up to this event. // // This member is required. ScheduledEventId int64 @@ -1891,22 +1744,16 @@ type MarkerRecordedEventAttributes struct { // Provides the details of the RecordMarker decision. Access Control You can use // IAM policies to control this decision's access to Amazon SWF resources as // follows: -// -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type RecordMarkerDecisionAttributes struct { @@ -1924,11 +1771,10 @@ type RecordMarkerDecisionAttributes struct { // Provides the details of the RecordMarkerFailed event. type RecordMarkerFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -1953,22 +1799,16 @@ type RecordMarkerFailedEventAttributes struct { // Provides the details of the RequestCancelActivityTask decision. Access Control // You can use IAM policies to control this decision's access to Amazon SWF // resources as follows: -// -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * You cannot use an IAM policy to constrain -// this action's parameters. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type RequestCancelActivityTaskDecisionAttributes struct { @@ -1988,11 +1828,10 @@ type RequestCancelActivityTaskFailedEventAttributes struct { // This member is required. ActivityId *string - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2012,22 +1851,16 @@ type RequestCancelActivityTaskFailedEventAttributes struct { // Provides the details of the RequestCancelExternalWorkflowExecution decision. // Access Control You can use IAM policies to control this decision's access to // Amazon SWF resources as follows: -// -// * Use a Resource element with the domain name -// to limit the action to only specified domains. -// -// * Use an Action element to allow -// or deny permission to call this action. -// -// * You cannot use an IAM policy to -// constrain this action's parameters. -// -// If the caller doesn't have sufficient -// permissions to invoke the action, or the parameter values fall outside the -// specified constraints, the action fails. The associated event attribute's cause -// parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM -// policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type RequestCancelExternalWorkflowExecutionDecisionAttributes struct { @@ -2049,11 +1882,10 @@ type RequestCancelExternalWorkflowExecutionDecisionAttributes struct { // Provides the details of the RequestCancelExternalWorkflowExecutionFailed event. type RequestCancelExternalWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2120,7 +1952,7 @@ type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes struct { // Tags are key-value pairs that can be associated with Amazon SWF state machines // and activities. Tags may only contain unicode letters, digits, whitespace, or -// these symbols: _ . : / = + - @. +// these symbols: _ . : / = + - @ . type ResourceTag struct { // The key of a tag. @@ -2137,38 +1969,28 @@ type ResourceTag struct { // Provides the details of the ScheduleActivityTask decision. Access Control You // can use IAM policies to control this decision's access to Amazon SWF resources // as follows: -// -// * Use a Resource element with the domain name to limit the action -// to only specified domains. -// -// * Use an Action element to allow or deny permission -// to call this action. -// -// * Constrain the following parameters by using a Condition -// element with the appropriate keys. -// -// * activityType.name – String constraint. The -// key is swf:activityType.name. -// -// * activityType.version – String constraint. The -// key is swf:activityType.version. -// -// * taskList – String constraint. The key is -// swf:taskList.name. -// -// If the caller doesn't have sufficient permissions to invoke -// the action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - activityType.name – String constraint. The key is swf:activityType.name . +// - activityType.version – String constraint. The key is +// swf:activityType.version . +// - taskList – String constraint. The key is swf:taskList.name . +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type ScheduleActivityTaskDecisionAttributes struct { // The activityId of the activity task. The specified string must not start or end // with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), - // or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not - // contain the literal string arn. + // or any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not + // contain the literal string arn . // // This member is required. ActivityId *string @@ -2183,12 +2005,12 @@ type ScheduleActivityTaskDecisionAttributes struct { Control *string // If set, specifies the maximum time before which a worker processing a task of - // this type must report progress by calling RecordActivityTaskHeartbeat. If the + // this type must report progress by calling RecordActivityTaskHeartbeat . If the // timeout is exceeded, the activity task is automatically timed out. If the worker // subsequently attempts to record a heartbeat or returns a result, it is ignored. // This overrides the default heartbeat timeout specified when registering the - // activity type using RegisterActivityType. The duration is specified in seconds, - // an integer greater than or equal to 0. You can use NONE to specify unlimited + // activity type using RegisterActivityType . The duration is specified in seconds, + // an integer greater than or equal to 0 . You can use NONE to specify unlimited // duration. HeartbeatTimeout *string @@ -2196,51 +2018,51 @@ type ScheduleActivityTaskDecisionAttributes struct { Input *string // The maximum duration for this activity task. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify + // seconds, an integer greater than or equal to 0 . You can use NONE to specify // unlimited duration. A schedule-to-close timeout for this activity task must be // specified either as a default for the activity type or through this field. If // neither this field is set nor a default schedule-to-close timeout was specified // at registration time then a fault is returned. ScheduleToCloseTimeout *string - // If set, specifies the maximum duration the activity task can wait to be assigned - // to a worker. This overrides the default schedule-to-start timeout specified when - // registering the activity type using RegisterActivityType. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A schedule-to-start timeout for this activity task - // must be specified either as a default for the activity type or through this - // field. If neither this field is set nor a default schedule-to-start timeout was - // specified at registration time then a fault is returned. + // If set, specifies the maximum duration the activity task can wait to be + // assigned to a worker. This overrides the default schedule-to-start timeout + // specified when registering the activity type using RegisterActivityType . The + // duration is specified in seconds, an integer greater than or equal to 0 . You + // can use NONE to specify unlimited duration. A schedule-to-start timeout for + // this activity task must be specified either as a default for the activity type + // or through this field. If neither this field is set nor a default + // schedule-to-start timeout was specified at registration time then a fault is + // returned. ScheduleToStartTimeout *string // If set, specifies the maximum duration a worker may take to process this // activity task. This overrides the default start-to-close timeout specified when - // registering the activity type using RegisterActivityType. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A start-to-close timeout for this activity task must - // be specified either as a default for the activity type or through this field. If - // neither this field is set nor a default start-to-close timeout was specified at - // registration time then a fault is returned. + // registering the activity type using RegisterActivityType . The duration is + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. A start-to-close timeout for this activity task + // must be specified either as a default for the activity type or through this + // field. If neither this field is set nor a default start-to-close timeout was + // specified at registration time then a fault is returned. StartToCloseTimeout *string // If set, specifies the name of the task list in which to schedule the activity - // task. If not specified, the defaultTaskList registered with the activity type is - // used. A task list for this activity task must be specified either as a default - // for the activity type or through this field. If neither this field is set nor a - // default task list was specified at registration time then a fault is returned. - // The specified string must not start or end with whitespace. It must not contain - // a : (colon), / (slash), | (vertical bar), or any control characters - // (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string - // arn. + // task. If not specified, the defaultTaskList registered with the activity type + // is used. A task list for this activity task must be specified either as a + // default for the activity type or through this field. If neither this field is + // set nor a default task list was specified at registration time then a fault is + // returned. The specified string must not start or end with whitespace. It must + // not contain a : (colon), / (slash), | (vertical bar), or any control characters + // ( \u0000-\u001f | \u007f-\u009f ). Also, it must not contain the literal string + // arn . TaskList *TaskList - // If set, specifies the priority with which the activity task is to be assigned to - // a worker. This overrides the defaultTaskPriority specified when registering the - // activity type using RegisterActivityType. Valid values are integers that range - // from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). - // Higher numbers indicate higher priority. For more information about setting task - // priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // If set, specifies the priority with which the activity task is to be assigned + // to a worker. This overrides the defaultTaskPriority specified when registering + // the activity type using RegisterActivityType . Valid values are integers that + // range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE + // (2147483647). Higher numbers indicate higher priority. For more information + // about setting task priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string @@ -2260,11 +2082,10 @@ type ScheduleActivityTaskFailedEventAttributes struct { // This member is required. ActivityType *ActivityType - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2281,8 +2102,8 @@ type ScheduleActivityTaskFailedEventAttributes struct { noSmithyDocumentSerde } -// Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within -// the list of decisions decisions passed to RespondDecisionTaskCompleted. +// Decision attributes specified in scheduleLambdaFunctionDecisionAttributes +// within the list of decisions decisions passed to RespondDecisionTaskCompleted . type ScheduleLambdaFunctionDecisionAttributes struct { // A string that identifies the Lambda function execution in the event history. @@ -2310,16 +2131,15 @@ type ScheduleLambdaFunctionDecisionAttributes struct { noSmithyDocumentSerde } -// Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for -// other event types. +// Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set +// for other event types. type ScheduleLambdaFunctionFailedEventAttributes struct { - // The cause of the failure. To help diagnose issues, use this information to trace - // back the chain of events leading up to this event. If cause is set to - // OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient + // The cause of the failure. To help diagnose issues, use this information to + // trace back the chain of events leading up to this event. If cause is set to + // OPERATION_NOT_PERMITTED , the decision failed because it lacked sufficient // permissions. For details and example IAM policies, see Using IAM to Manage - // Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2348,22 +2168,16 @@ type ScheduleLambdaFunctionFailedEventAttributes struct { // Provides the details of the SignalExternalWorkflowExecution decision. Access // Control You can use IAM policies to control this decision's access to Amazon SWF // resources as follows: -// -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * You cannot use an IAM policy to constrain -// this action's parameters. -// -// If the caller doesn't have sufficient permissions to -// invoke the action, or the parameter values fall outside the specified -// constraints, the action fails. The associated event attribute's cause parameter -// is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see -// Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type SignalExternalWorkflowExecutionDecisionAttributes struct { @@ -2395,11 +2209,10 @@ type SignalExternalWorkflowExecutionDecisionAttributes struct { // Provides the details of the SignalExternalWorkflowExecutionFailed event. type SignalExternalWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2431,8 +2244,8 @@ type SignalExternalWorkflowExecutionFailedEventAttributes struct { // tasks. This data isn't sent to the workflow execution. Control *string - // The runId of the external workflow execution that the signal was being delivered - // to. + // The runId of the external workflow execution that the signal was being + // delivered to. RunId *string noSmithyDocumentSerde @@ -2472,44 +2285,33 @@ type SignalExternalWorkflowExecutionInitiatedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the StartChildWorkflowExecution decision. Access Control -// You can use IAM policies to control this decision's access to Amazon SWF +// Provides the details of the StartChildWorkflowExecution decision. Access +// Control You can use IAM policies to control this decision's access to Amazon SWF // resources as follows: -// -// * Use a Resource element with the domain name to limit -// the action to only specified domains. -// -// * Use an Action element to allow or deny -// permission to call this action. -// -// * Constrain the following parameters by using a -// Condition element with the appropriate keys. -// -// * tagList.member.N – The key is -// "swf:tagList.N" where N is the tag number from 0 to 4, inclusive. -// -// * taskList – -// String constraint. The key is swf:taskList.name. -// -// * workflowType.name – String -// constraint. The key is swf:workflowType.name. -// -// * workflowType.version – String -// constraint. The key is swf:workflowType.version. -// -// If the caller doesn't have -// sufficient permissions to invoke the action, or the parameter values fall -// outside the specified constraints, the action fails. The associated event -// attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and -// example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - Constrain the following parameters by using a Condition element with the +// appropriate keys. +// - tagList.member.N – The key is "swf:tagList.N" where N is the tag number from +// 0 to 4, inclusive. +// - taskList – String constraint. The key is swf:taskList.name . +// - workflowType.name – String constraint. The key is swf:workflowType.name . +// - workflowType.version – String constraint. The key is +// swf:workflowType.version . +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type StartChildWorkflowExecutionDecisionAttributes struct { - // The workflowId of the workflow execution. The specified string must not start or - // end with whitespace. It must not contain a : (colon), / (slash), | (vertical - // bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must - // not contain the literal string arn. + // The workflowId of the workflow execution. The specified string must not start + // or end with whitespace. It must not contain a : (colon), / (slash), | (vertical + // bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must + // not contain the literal string arn . // // This member is required. WorkflowId *string @@ -2523,24 +2325,17 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // workflow execution being started is terminated by calling the // TerminateWorkflowExecution action explicitly or due to an expired timeout. This // policy overrides the default child policy specified when registering the - // workflow type using RegisterWorkflowType. The supported child policies are: - // - // * - // TERMINATE – The child executions are terminated. - // - // * REQUEST_CANCEL – A request - // to cancel is attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. - // - // A - // child policy for this workflow execution must be specified either as a default - // for the workflow type or through this parameter. If neither this parameter is - // set nor a default child policy was specified at registration time then a fault - // is returned. + // workflow type using RegisterWorkflowType . The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. + // A child policy for this workflow execution must be specified either as a + // default for the workflow type or through this parameter. If neither this + // parameter is set nor a default child policy was specified at registration time + // then a fault is returned. ChildPolicy ChildPolicy // The data attached to the event that can be used by the decider in subsequent @@ -2550,7 +2345,7 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // The total duration for this workflow execution. This overrides the // defaultExecutionStartToCloseTimeout specified when registering the workflow // type. The duration is specified in seconds, an integer greater than or equal to - // 0. You can use NONE to specify unlimited duration. An execution start-to-close + // 0 . You can use NONE to specify unlimited duration. An execution start-to-close // timeout for this workflow execution must be specified either as a default for // the workflow type or through this parameter. If neither this parameter is set // nor a default execution start-to-close timeout was specified at registration @@ -2566,7 +2361,7 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // The list of tags to associate with the child workflow execution. A maximum of 5 // tags can be specified. You can list workflow executions with a specific tag by // calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and - // specifying a TagFilter. + // specifying a TagFilter . TagList []string // The name of the task list to be used for decision tasks of the child workflow @@ -2575,25 +2370,24 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // parameter is set nor a default task list was specified at registration time then // a fault is returned. The specified string must not start or end with whitespace. // It must not contain a : (colon), / (slash), | (vertical bar), or any control - // characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the - // literal string arn. + // characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not contain the + // literal string arn . TaskList *TaskList - // A task priority that, if set, specifies the priority for a decision task of this - // workflow execution. This overrides the defaultTaskPriority specified when + // A task priority that, if set, specifies the priority for a decision task of + // this workflow execution. This overrides the defaultTaskPriority specified when // registering the workflow type. Valid values are integers that range from Java's // Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher // numbers indicate higher priority. For more information about setting task - // priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string // Specifies the maximum duration of decision tasks for this workflow execution. // This parameter overrides the defaultTaskStartToCloseTimout specified when - // registering the workflow type using RegisterWorkflowType. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. A task start-to-close timeout for this workflow + // registering the workflow type using RegisterWorkflowType . The duration is + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. A task start-to-close timeout for this workflow // execution must be specified either as a default for the workflow type or through // this parameter. If neither this parameter is set nor a default task // start-to-close timeout was specified at registration time then a fault is @@ -2606,29 +2400,28 @@ type StartChildWorkflowExecutionDecisionAttributes struct { // Provides the details of the StartChildWorkflowExecutionFailed event. type StartChildWorkflowExecutionFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED, - // the decision fails because it lacks sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. When cause is set to OPERATION_NOT_PERMITTED + // , the decision fails because it lacks sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. Cause StartChildWorkflowExecutionFailedCause // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the StartChildWorkflowExecutionDecision to request this child + // that resulted in the StartChildWorkflowExecution Decision to request this child // workflow execution. This information can be useful for diagnosing problems by // tracing back the chain of events. // // This member is required. DecisionTaskCompletedEventId int64 - // When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the + // When the cause is WORKFLOW_ALREADY_RUNNING , initiatedEventId is the ID of the // StartChildWorkflowExecutionInitiated event that corresponds to the - // StartChildWorkflowExecutionDecision to start the workflow execution. You can use - // this information to diagnose problems by tracing back the chain of events - // leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING, + // StartChildWorkflowExecution Decision to start the workflow execution. You can + // use this information to diagnose problems by tracing back the chain of events + // leading up to this event. When the cause isn't WORKFLOW_ALREADY_RUNNING , // initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated // event doesn't exist. // @@ -2640,7 +2433,7 @@ type StartChildWorkflowExecutionFailedEventAttributes struct { // This member is required. WorkflowId *string - // The workflow type provided in the StartChildWorkflowExecutionDecision that + // The workflow type provided in the StartChildWorkflowExecution Decision that // failed. // // This member is required. @@ -2657,25 +2450,20 @@ type StartChildWorkflowExecutionFailedEventAttributes struct { type StartChildWorkflowExecutionInitiatedEventAttributes struct { // The policy to use for the child workflow executions if this execution gets - // terminated by explicitly calling the TerminateWorkflowExecution action or due to - // an expired timeout. The supported child policies are: - // - // * TERMINATE – The child - // executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted - // for each child execution by recording a WorkflowExecutionCancelRequested event - // in its history. It is up to the decider to take appropriate actions when it - // receives an execution history with this event. - // - // * ABANDON – No action is taken. - // The child executions continue to run. + // terminated by explicitly calling the TerminateWorkflowExecution action or due + // to an expired timeout. The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the StartChildWorkflowExecutionDecision to request this child + // that resulted in the StartChildWorkflowExecution Decision to request this child // workflow execution. This information can be useful for diagnosing problems by // tracing back the cause of events. // @@ -2702,10 +2490,10 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // decision tasks. This data isn't sent to the activity. Control *string - // The maximum duration for the child workflow execution. If the workflow execution - // isn't closed within this duration, it is timed out and force-terminated. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. + // The maximum duration for the child workflow execution. If the workflow + // execution isn't closed within this duration, it is timed out and + // force-terminated. The duration is specified in seconds, an integer greater than + // or equal to 0 . You can use NONE to specify unlimited duration. ExecutionStartToCloseTimeout *string // The inputs provided to the child workflow execution. @@ -2720,14 +2508,13 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // The priority assigned for the decision tasks for this workflow execution. Valid // values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // more information about setting task priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string - // The maximum duration allowed for the decision tasks for this workflow execution. - // The duration is specified in seconds, an integer greater than or equal to 0. You - // can use NONE to specify unlimited duration. + // The maximum duration allowed for the decision tasks for this workflow + // execution. The duration is specified in seconds, an integer greater than or + // equal to 0 . You can use NONE to specify unlimited duration. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -2737,12 +2524,11 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // other event types. type StartLambdaFunctionFailedEventAttributes struct { - // The cause of the failure. To help diagnose issues, use this information to trace - // back the chain of events leading up to this event. If cause is set to - // OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to + // The cause of the failure. To help diagnose issues, use this information to + // trace back the chain of events leading up to this event. If cause is set to + // OPERATION_NOT_PERMITTED , the decision failed because the IAM role attached to // the execution lacked sufficient permissions. For details and example IAM - // policies, see Lambda Tasks - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // policies, see Lambda Tasks (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. Cause StartLambdaFunctionFailedCause @@ -2758,37 +2544,30 @@ type StartLambdaFunctionFailedEventAttributes struct { } // Provides the details of the StartTimer decision. Access Control You can use IAM -// policies to control this decision's access to Amazon SWF resources as -// follows: -// -// * Use a Resource element with the domain name to limit the action to -// only specified domains. -// -// * Use an Action element to allow or deny permission to -// call this action. -// -// * You cannot use an IAM policy to constrain this action's -// parameters. -// -// If the caller doesn't have sufficient permissions to invoke the -// action, or the parameter values fall outside the specified constraints, the -// action fails. The associated event attribute's cause parameter is set to -// OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to -// Manage Access to Amazon SWF Workflows -// (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) +// policies to control this decision's access to Amazon SWF resources as follows: +// - Use a Resource element with the domain name to limit the action to only +// specified domains. +// - Use an Action element to allow or deny permission to call this action. +// - You cannot use an IAM policy to constrain this action's parameters. +// +// If the caller doesn't have sufficient permissions to invoke the action, or the +// parameter values fall outside the specified constraints, the action fails. The +// associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . +// For details and example IAM policies, see Using IAM to Manage Access to Amazon +// SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. type StartTimerDecisionAttributes struct { // The duration to wait before firing the timer. The duration is specified in - // seconds, an integer greater than or equal to 0. + // seconds, an integer greater than or equal to 0 . // // This member is required. StartToFireTimeout *string // The unique ID of the timer. The specified string must not start or end with - // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any - // control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain - // the literal string arn. + // whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or + // any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not + // contain the literal string arn . // // This member is required. TimerId *string @@ -2803,11 +2582,10 @@ type StartTimerDecisionAttributes struct { // Provides the details of the StartTimerFailed event. type StartTimerFailedEventAttributes struct { - // The cause of the failure. This information is generated by the system and can be - // useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED, the - // decision failed because it lacked sufficient permissions. For details and - // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) + // The cause of the failure. This information is generated by the system and can + // be useful for diagnostic purposes. If cause is set to OPERATION_NOT_PERMITTED , + // the decision failed because it lacked sufficient permissions. For details and + // example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // This member is required. @@ -2834,7 +2612,7 @@ type TagFilter struct { // Specifies the tag that must be associated with the execution for it to meet the // filter criteria. Tags may only contain unicode letters, digits, whitespace, or - // these symbols: _ . : / = + - @. + // these symbols: _ . : / = + - @ . // // This member is required. Tag *string @@ -2857,9 +2635,9 @@ type TaskList struct { type TimerCanceledEventAttributes struct { // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the CancelTimer decision to cancel this timer. This information - // can be useful for diagnosing problems by tracing back the chain of events - // leading up to this event. + // that resulted in the CancelTimer decision to cancel this timer. This + // information can be useful for diagnosing problems by tracing back the chain of + // events leading up to this event. // // This member is required. DecisionTaskCompletedEventId int64 @@ -2909,7 +2687,7 @@ type TimerStartedEventAttributes struct { DecisionTaskCompletedEventId int64 // The duration of time after which the timer fires. The duration is specified in - // seconds, an integer greater than or equal to 0. + // seconds, an integer greater than or equal to 0 . // // This member is required. StartToFireTimeout *string @@ -3008,23 +2786,18 @@ type WorkflowExecutionConfiguration struct { // The policy to use for the child workflow executions if this workflow execution // is terminated, by calling the TerminateWorkflowExecution action explicitly or // due to an expired timeout. The supported child policies are: - // - // * TERMINATE – The - // child executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel is - // attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy // The total duration for this workflow execution. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify + // seconds, an integer greater than or equal to 0 . You can use NONE to specify // unlimited duration. // // This member is required. @@ -3035,9 +2808,9 @@ type WorkflowExecutionConfiguration struct { // This member is required. TaskList *TaskList - // The maximum duration allowed for decision tasks for this workflow execution. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. + // The maximum duration allowed for decision tasks for this workflow execution. + // The duration is specified in seconds, an integer greater than or equal to 0 . + // You can use NONE to specify unlimited duration. // // This member is required. TaskStartToCloseTimeout *string @@ -3048,8 +2821,7 @@ type WorkflowExecutionConfiguration struct { // The priority assigned to decision tasks for this workflow execution. Valid // values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. For - // more information about setting task priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // more information about setting task priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. TaskPriority *string @@ -3060,19 +2832,14 @@ type WorkflowExecutionConfiguration struct { type WorkflowExecutionContinuedAsNewEventAttributes struct { // The policy to use for the child workflow executions of the new execution if it - // is terminated by calling the TerminateWorkflowExecution action explicitly or due - // to an expired timeout. The supported child policies are: - // - // * TERMINATE – The - // child executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel is - // attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. + // is terminated by calling the TerminateWorkflowExecution action explicitly or + // due to an expired timeout. The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy @@ -3102,8 +2869,8 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { WorkflowType *WorkflowType // The total duration allowed for the new workflow execution. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. ExecutionStartToCloseTimeout *string // The input provided to the new workflow execution. @@ -3120,8 +2887,8 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { TaskPriority *string // The maximum duration of decision tasks for the new workflow execution. The - // duration is specified in seconds, an integer greater than or equal to 0. You can - // use NONE to specify unlimited duration. + // duration is specified in seconds, an integer greater than or equal to 0 . You + // can use NONE to specify unlimited duration. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -3131,9 +2898,9 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { type WorkflowExecutionFailedEventAttributes struct { // The ID of the DecisionTaskCompleted event corresponding to the decision task - // that resulted in the FailWorkflowExecution decision to fail this execution. This - // information can be useful for diagnosing problems by tracing back the chain of - // events leading up to this event. + // that resulted in the FailWorkflowExecution decision to fail this execution. + // This information can be useful for diagnosing problems by tracing back the chain + // of events leading up to this event. // // This member is required. DecisionTaskCompletedEventId int64 @@ -3147,7 +2914,7 @@ type WorkflowExecutionFailedEventAttributes struct { noSmithyDocumentSerde } -// Used to filter the workflow executions in visibility APIs by their workflowId. +// Used to filter the workflow executions in visibility APIs by their workflowId . type WorkflowExecutionFilter struct { // The workflowId to pass of match the criteria of this filter. @@ -3186,25 +2953,16 @@ type WorkflowExecutionInfo struct { // If the execution status is closed then this specifies how the execution was // closed: - // - // * COMPLETED – the execution was successfully completed. - // - // * CANCELED – - // the execution was canceled.Cancellation allows the implementation to gracefully - // clean up before the execution is closed. - // - // * TERMINATED – the execution was force - // terminated. - // - // * FAILED – the execution failed to complete. - // - // * TIMED_OUT – the - // execution did not complete in the alloted time and was automatically timed - // out. - // - // * CONTINUED_AS_NEW – the execution is logically continued. This means the - // current execution was completed and a new execution was started to carry on the - // workflow. + // - COMPLETED – the execution was successfully completed. + // - CANCELED – the execution was canceled.Cancellation allows the implementation + // to gracefully clean up before the execution is closed. + // - TERMINATED – the execution was force terminated. + // - FAILED – the execution failed to complete. + // - TIMED_OUT – the execution did not complete in the alloted time and was + // automatically timed out. + // - CONTINUED_AS_NEW – the execution is logically continued. This means the + // current execution was completed and a new execution was started to carry on the + // workflow. CloseStatus CloseStatus // The time when the workflow execution was closed. Set only if the execution @@ -3227,12 +2985,12 @@ type WorkflowExecutionInfo struct { // workflow execution. type WorkflowExecutionOpenCounts struct { - // The count of activity tasks whose status is OPEN. + // The count of activity tasks whose status is OPEN . // // This member is required. OpenActivityTasks int32 - // The count of child workflow executions whose status is OPEN. + // The count of child workflow executions whose status is OPEN . // // This member is required. OpenChildWorkflowExecutions int32 @@ -3248,7 +3006,7 @@ type WorkflowExecutionOpenCounts struct { // This member is required. OpenTimers int32 - // The count of Lambda tasks whose status is OPEN. + // The count of Lambda tasks whose status is OPEN . OpenLambdaFunctions int32 noSmithyDocumentSerde @@ -3264,11 +3022,11 @@ type WorkflowExecutionSignaledEventAttributes struct { SignalName *string // The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to - // the SignalExternalWorkflow decision to signal this workflow execution.The source - // event with this ID can be found in the history of the source workflow execution. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. This field is set only if the signal was - // initiated by another workflow execution. + // the SignalExternalWorkflow decision to signal this workflow execution.The + // source event with this ID can be found in the history of the source workflow + // execution. This information can be useful for diagnosing problems by tracing + // back the chain of events leading up to this event. This field is set only if the + // signal was initiated by another workflow execution. ExternalInitiatedEventId int64 // The workflow execution that sent the signal. This is set only of the signal was @@ -3288,17 +3046,12 @@ type WorkflowExecutionStartedEventAttributes struct { // The policy to use for the child workflow executions if this workflow execution // is terminated, by calling the TerminateWorkflowExecution action explicitly or // due to an expired timeout. The supported child policies are: - // - // * TERMINATE – The - // child executions are terminated. - // - // * REQUEST_CANCEL – A request to cancel is - // attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy @@ -3315,12 +3068,12 @@ type WorkflowExecutionStartedEventAttributes struct { WorkflowType *WorkflowType // If this workflow execution was started due to a ContinueAsNewWorkflowExecution - // decision, then it contains the runId of the previous workflow execution that was - // closed and continued as this execution. + // decision, then it contains the runId of the previous workflow execution that + // was closed and continued as this execution. ContinuedExecutionRunId *string // The maximum duration for this workflow execution. The duration is specified in - // seconds, an integer greater than or equal to 0. You can use NONE to specify + // seconds, an integer greater than or equal to 0 . You can use NONE to specify // unlimited duration. ExecutionStartToCloseTimeout *string @@ -3331,10 +3084,10 @@ type WorkflowExecutionStartedEventAttributes struct { LambdaRole *string // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // StartChildWorkflowExecutionDecision to start this workflow execution. The source - // event with this ID can be found in the history of the source workflow execution. - // This information can be useful for diagnosing problems by tracing back the chain - // of events leading up to this event. + // StartChildWorkflowExecution Decision to start this workflow execution. The + // source event with this ID can be found in the history of the source workflow + // execution. This information can be useful for diagnosing problems by tracing + // back the chain of events leading up to this event. ParentInitiatedEventId int64 // The source workflow execution that started this workflow execution. The member @@ -3349,8 +3102,8 @@ type WorkflowExecutionStartedEventAttributes struct { TaskPriority *string // The maximum duration of decision tasks for this workflow type. The duration is - // specified in seconds, an integer greater than or equal to 0. You can use NONE to - // specify unlimited duration. + // specified in seconds, an integer greater than or equal to 0 . You can use NONE + // to specify unlimited duration. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -3361,17 +3114,12 @@ type WorkflowExecutionTerminatedEventAttributes struct { // The policy used for the child workflow executions of this workflow execution. // The supported child policies are: - // - // * TERMINATE – The child executions are - // terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted for each child - // execution by recording a WorkflowExecutionCancelRequested event in its history. - // It is up to the decider to take appropriate actions when it receives an - // execution history with this event. - // - // * ABANDON – No action is taken. The child - // executions continue to run. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy @@ -3395,17 +3143,12 @@ type WorkflowExecutionTimedOutEventAttributes struct { // The policy used for the child workflow executions of this workflow execution. // The supported child policies are: - // - // * TERMINATE – The child executions are - // terminated. - // - // * REQUEST_CANCEL – A request to cancel is attempted for each child - // execution by recording a WorkflowExecutionCancelRequested event in its history. - // It is up to the decider to take appropriate actions when it receives an - // execution history with this event. - // - // * ABANDON – No action is taken. The child - // executions continue to run. + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. // // This member is required. ChildPolicy ChildPolicy @@ -3421,8 +3164,8 @@ type WorkflowExecutionTimedOutEventAttributes struct { // Represents a workflow type. type WorkflowType struct { - // The name of the workflow type. The combination of workflow type name and version - // must be unique with in a domain. + // The name of the workflow type. The combination of workflow type name and + // version must be unique with in a domain. // // This member is required. Name *string @@ -3443,63 +3186,56 @@ type WorkflowTypeConfiguration struct { // execution of this type is terminated, by calling the TerminateWorkflowExecution // action explicitly or due to an expired timeout. This default can be overridden // when starting a workflow execution using the StartWorkflowExecution action or - // the StartChildWorkflowExecutionDecision. The supported child policies are: - // - // * - // TERMINATE – The child executions are terminated. - // - // * REQUEST_CANCEL – A request - // to cancel is attempted for each child execution by recording a - // WorkflowExecutionCancelRequested event in its history. It is up to the decider - // to take appropriate actions when it receives an execution history with this - // event. - // - // * ABANDON – No action is taken. The child executions continue to run. + // the StartChildWorkflowExecution Decision . The supported child policies are: + // - TERMINATE – The child executions are terminated. + // - REQUEST_CANCEL – A request to cancel is attempted for each child execution + // by recording a WorkflowExecutionCancelRequested event in its history. It is up + // to the decider to take appropriate actions when it receives an execution history + // with this event. + // - ABANDON – No action is taken. The child executions continue to run. DefaultChildPolicy ChildPolicy // The default maximum duration, specified when registering the workflow type, for // executions of this workflow type. This default can be overridden when starting a // workflow execution using the StartWorkflowExecution action or the - // StartChildWorkflowExecutionDecision. The duration is specified in seconds, an - // integer greater than or equal to 0. You can use NONE to specify unlimited + // StartChildWorkflowExecution Decision . The duration is specified in seconds, an + // integer greater than or equal to 0 . You can use NONE to specify unlimited // duration. DefaultExecutionStartToCloseTimeout *string - // The default IAM role attached to this workflow type. Executions of this workflow - // type need IAM roles to invoke Lambda functions. If you don't specify an IAM role - // when starting this workflow type, the default Lambda role is attached to the - // execution. For more information, see - // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) + // The default IAM role attached to this workflow type. Executions of this + // workflow type need IAM roles to invoke Lambda functions. If you don't specify an + // IAM role when starting this workflow type, the default Lambda role is attached + // to the execution. For more information, see + // https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) // in the Amazon SWF Developer Guide. DefaultLambdaRole *string // The default task list, specified when registering the workflow type, for // decisions tasks scheduled for workflow executions of this type. This default can // be overridden when starting a workflow execution using the - // StartWorkflowExecution action or the StartChildWorkflowExecutionDecision. + // StartWorkflowExecution action or the StartChildWorkflowExecution Decision . DefaultTaskList *TaskList - // The default task priority, specified when registering the workflow type, for all - // decision tasks of this workflow type. This default can be overridden when + // The default task priority, specified when registering the workflow type, for + // all decision tasks of this workflow type. This default can be overridden when // starting a workflow execution using the StartWorkflowExecution action or the // StartChildWorkflowExecution decision. Valid values are integers that range from - // Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher - // numbers indicate higher priority. For more information about setting task - // priority, see Setting Task Priority - // (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) + // Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). + // Higher numbers indicate higher priority. For more information about setting task + // priority, see Setting Task Priority (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) // in the Amazon SWF Developer Guide. DefaultTaskPriority *string - // The default maximum duration, specified when registering the workflow type, that - // a decision task for executions of this workflow type might take before returning - // completion or failure. If the task doesn'tdo close in the specified time then - // the task is automatically timed out and rescheduled. If the decider eventually - // reports a completion or failure, it is ignored. This default can be overridden - // when starting a workflow execution using the StartWorkflowExecution action or - // the StartChildWorkflowExecutionDecision. The duration is specified in seconds, - // an integer greater than or equal to 0. You can use NONE to specify unlimited - // duration. + // The default maximum duration, specified when registering the workflow type, + // that a decision task for executions of this workflow type might take before + // returning completion or failure. If the task doesn'tdo close in the specified + // time then the task is automatically timed out and rescheduled. If the decider + // eventually reports a completion or failure, it is ignored. This default can be + // overridden when starting a workflow execution using the StartWorkflowExecution + // action or the StartChildWorkflowExecution Decision . The duration is specified + // in seconds, an integer greater than or equal to 0 . You can use NONE to specify + // unlimited duration. DefaultTaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -3538,11 +3274,11 @@ type WorkflowTypeInfo struct { // This member is required. WorkflowType *WorkflowType - // If the type is in deprecated state, then it is set to the date when the type was - // deprecated. + // If the type is in deprecated state, then it is set to the date when the type + // was deprecated. DeprecationDate *time.Time - // The description of the type registered through RegisterWorkflowType. + // The description of the type registered through RegisterWorkflowType . Description *string noSmithyDocumentSerde diff --git a/service/synthetics/api_client.go b/service/synthetics/api_client.go index 320611cd3be..fc8326def71 100644 --- a/service/synthetics/api_client.go +++ b/service/synthetics/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/synthetics/api_op_AssociateResource.go b/service/synthetics/api_op_AssociateResource.go index 918763a9357..5662e7cb6ab 100644 --- a/service/synthetics/api_op_AssociateResource.go +++ b/service/synthetics/api_op_AssociateResource.go @@ -31,8 +31,8 @@ func (c *Client) AssociateResource(ctx context.Context, params *AssociateResourc type AssociateResourceInput struct { - // Specifies the group. You can specify the group name, the ARN, or the group ID as - // the GroupIdentifier. + // Specifies the group. You can specify the group name, the ARN, or the group ID + // as the GroupIdentifier . // // This member is required. GroupIdentifier *string diff --git a/service/synthetics/api_op_CreateCanary.go b/service/synthetics/api_op_CreateCanary.go index 97f90553306..533eab32bea 100644 --- a/service/synthetics/api_op_CreateCanary.go +++ b/service/synthetics/api_op_CreateCanary.go @@ -11,23 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a canary. Canaries are scripts that monitor your endpoints and APIs from -// the outside-in. Canaries help you check the availability and latency of your web -// services and troubleshoot anomalies by investigating load time data, screenshots -// of the UI, logs, and metrics. You can set up a canary to run continuously or -// just once. Do not use CreateCanary to modify an existing canary. Use -// UpdateCanary -// (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html) +// Creates a canary. Canaries are scripts that monitor your endpoints and APIs +// from the outside-in. Canaries help you check the availability and latency of +// your web services and troubleshoot anomalies by investigating load time data, +// screenshots of the UI, logs, and metrics. You can set up a canary to run +// continuously or just once. Do not use CreateCanary to modify an existing +// canary. Use UpdateCanary (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html) // instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess // policy. If you are creating a new IAM role for the canary, you also need the -// iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more -// information, see Necessary Roles and Permissions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles). -// Do not include secrets or proprietary information in your canary names. The +// iam:CreateRole , iam:CreatePolicy and iam:AttachRolePolicy permissions. For +// more information, see Necessary Roles and Permissions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles) +// . Do not include secrets or proprietary information in your canary names. The // canary name makes up part of the Amazon Resource Name (ARN) for the canary, and // the ARN is included in outbound calls over the internet. For more information, -// see Security Considerations for Synthetics Canaries -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). +// see Security Considerations for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) +// . func (c *Client) CreateCanary(ctx context.Context, params *CreateCanaryInput, optFns ...func(*Options)) (*CreateCanaryOutput, error) { if params == nil { params = &CreateCanaryInput{} @@ -60,24 +58,15 @@ type CreateCanaryInput struct { Code *types.CanaryCodeInput // The ARN of the IAM role to be used to run the canary. This role must already - // exist, and must include lambda.amazonaws.com as a principal in the trust policy. - // The role must also have the following permissions: - // - // * s3:PutObject - // - // * - // s3:GetBucketLocation - // - // * s3:ListAllMyBuckets - // - // * cloudwatch:PutMetricData - // - // * - // logs:CreateLogGroup - // - // * logs:CreateLogStream - // - // * logs:PutLogEvents + // exist, and must include lambda.amazonaws.com as a principal in the trust + // policy. The role must also have the following permissions: + // - s3:PutObject + // - s3:GetBucketLocation + // - s3:ListAllMyBuckets + // - cloudwatch:PutMetricData + // - logs:CreateLogGroup + // - logs:CreateLogStream + // - logs:PutLogEvents // // This member is required. ExecutionRoleArn *string @@ -86,16 +75,16 @@ type CreateCanaryInput struct { // distinguishes it from other canaries in your account. Do not include secrets or // proprietary information in your canary names. The canary name makes up part of // the canary ARN, and the ARN is included in outbound calls over the internet. For - // more information, see Security Considerations for Synthetics Canaries - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). + // more information, see Security Considerations for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) + // . // // This member is required. Name *string - // Specifies the runtime version to use for the canary. For a list of valid runtime - // versions and more information about runtime versions, see Canary Runtime - // Versions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). + // Specifies the runtime version to use for the canary. For a list of valid + // runtime versions and more information about runtime versions, see Canary + // Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) + // . // // This member is required. RuntimeVersion *string @@ -132,8 +121,8 @@ type CreateCanaryInput struct { // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnet and security groups of the VPC endpoint. For more - // information, see Running a Canary in a VPC - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). + // information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) + // . VpcConfig *types.VpcConfigInput noSmithyDocumentSerde diff --git a/service/synthetics/api_op_CreateGroup.go b/service/synthetics/api_op_CreateGroup.go index b8602b207c5..32e33fcc2d6 100644 --- a/service/synthetics/api_op_CreateGroup.go +++ b/service/synthetics/api_op_CreateGroup.go @@ -22,10 +22,9 @@ import ( // group, and then use that group to view and manage all of those canaries in a // single view. Groups are supported in all Regions except the Regions that are // disabled by default. For more information about these Regions, see Enabling a -// Region -// (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable). -// Each group can contain as many as 10 canaries. You can have as many as 20 groups -// in your account. Any single canary can be a member of up to 10 groups. +// Region (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) +// . Each group can contain as many as 10 canaries. You can have as many as 20 +// groups in your account. Any single canary can be a member of up to 10 groups. func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -43,14 +42,14 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { - // The name for the group. It can include any Unicode characters. The names for all - // groups in your account, across all Regions, must be unique. + // The name for the group. It can include any Unicode characters. The names for + // all groups in your account, across all Regions, must be unique. // // This member is required. Name *string - // A list of key-value pairs to associate with the group. You can associate as many - // as 50 tags with a group. Tags can help you organize and categorize your + // A list of key-value pairs to associate with the group. You can associate as + // many as 50 tags with a group. Tags can help you organize and categorize your // resources. You can also use them to scope user permissions, by granting a user // permission to access or change only the resources that have certain tag values. Tags map[string]string diff --git a/service/synthetics/api_op_DeleteCanary.go b/service/synthetics/api_op_DeleteCanary.go index 2c16d0b8140..e7ef50de138 100644 --- a/service/synthetics/api_op_DeleteCanary.go +++ b/service/synthetics/api_op_DeleteCanary.go @@ -10,31 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently deletes the specified canary. If you specify DeleteLambda to true, +// Permanently deletes the specified canary. If you specify DeleteLambda to true , // CloudWatch Synthetics also deletes the Lambda functions and layers that are used // by the canary. Other resources used and created by the canary are not // automatically deleted. After you delete a canary that you do not intend to use // again, you should also delete the following: +// - The CloudWatch alarms created for this canary. These alarms have a name of +// Synthetics-SharpDrop-Alarm-MyCanaryName . +// - Amazon S3 objects and buckets, such as the canary's artifact location. +// - IAM roles created for the canary. If they were created in the console, +// these roles have the name +// role/service-role/CloudWatchSyntheticsRole-MyCanaryName . +// - CloudWatch Logs log groups created for the canary. These logs groups have +// the name /aws/lambda/cwsyn-MyCanaryName . // -// * The CloudWatch alarms created -// for this canary. These alarms have a name of -// Synthetics-SharpDrop-Alarm-MyCanaryName . -// -// * Amazon S3 objects and buckets, such -// as the canary's artifact location. -// -// * IAM roles created for the canary. If they -// were created in the console, these roles have the name -// role/service-role/CloudWatchSyntheticsRole-MyCanaryName . -// -// * CloudWatch Logs log -// groups created for the canary. These logs groups have the name -// /aws/lambda/cwsyn-MyCanaryName . -// -// Before you delete a canary, you might want to -// use GetCanary to display the information about this canary. Make note of the -// information returned by this operation so that you can delete these resources -// after you delete the canary. +// Before you delete a canary, you might want to use GetCanary to display the +// information about this canary. Make note of the information returned by this +// operation so that you can delete these resources after you delete the canary. func (c *Client) DeleteCanary(ctx context.Context, params *DeleteCanaryInput, optFns ...func(*Options)) (*DeleteCanaryOutput, error) { if params == nil { params = &DeleteCanaryInput{} @@ -53,8 +45,8 @@ func (c *Client) DeleteCanary(ctx context.Context, params *DeleteCanaryInput, op type DeleteCanaryInput struct { // The name of the canary that you want to delete. To find the names of your - // canaries, use DescribeCanaries - // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). + // canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html) + // . // // This member is required. Name *string diff --git a/service/synthetics/api_op_DeleteGroup.go b/service/synthetics/api_op_DeleteGroup.go index d35d7006c3b..bd6f3554ba2 100644 --- a/service/synthetics/api_op_DeleteGroup.go +++ b/service/synthetics/api_op_DeleteGroup.go @@ -32,8 +32,8 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // Specifies which group to delete. You can specify the group name, the ARN, or the - // group ID as the GroupIdentifier. + // Specifies which group to delete. You can specify the group name, the ARN, or + // the group ID as the GroupIdentifier . // // This member is required. GroupIdentifier *string diff --git a/service/synthetics/api_op_DescribeCanaries.go b/service/synthetics/api_op_DescribeCanaries.go index 932bcd02f0a..a396e5b37b2 100644 --- a/service/synthetics/api_op_DescribeCanaries.go +++ b/service/synthetics/api_op_DescribeCanaries.go @@ -14,14 +14,14 @@ import ( // This operation returns a list of the canaries in your account, along with full // details about each canary. This operation supports resource-level authorization -// using an IAM policy and the Names parameter. If you specify the Names parameter, -// the operation is successful only if you have authorization to view all the -// canaries that you specify in your request. If you do not have permission to view -// any of the canaries, the request fails with a 403 response. You are required to -// use the Names parameter if you are logged on to a user or role that has an IAM -// policy that restricts which canaries that you are allowed to view. For more -// information, see Limiting a user to viewing specific canaries -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html). +// using an IAM policy and the Names parameter. If you specify the Names +// parameter, the operation is successful only if you have authorization to view +// all the canaries that you specify in your request. If you do not have permission +// to view any of the canaries, the request fails with a 403 response. You are +// required to use the Names parameter if you are logged on to a user or role that +// has an IAM policy that restricts which canaries that you are allowed to view. +// For more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html) +// . func (c *Client) DescribeCanaries(ctx context.Context, params *DescribeCanariesInput, optFns ...func(*Options)) (*DescribeCanariesOutput, error) { if params == nil { params = &DescribeCanariesInput{} @@ -39,24 +39,24 @@ func (c *Client) DescribeCanaries(ctx context.Context, params *DescribeCanariesI type DescribeCanariesInput struct { - // Specify this parameter to limit how many canaries are returned each time you use - // the DescribeCanaries operation. If you omit this parameter, the default of 100 - // is used. + // Specify this parameter to limit how many canaries are returned each time you + // use the DescribeCanaries operation. If you omit this parameter, the default of + // 100 is used. MaxResults *int32 - // Use this parameter to return only canaries that match the names that you specify - // here. You can specify as many as five canary names. If you specify this + // Use this parameter to return only canaries that match the names that you + // specify here. You can specify as many as five canary names. If you specify this // parameter, the operation is successful only if you have authorization to view // all the canaries that you specify in your request. If you do not have permission // to view any of the canaries, the request fails with a 403 response. You are // required to use this parameter if you are logged on to a user or role that has // an IAM policy that restricts which canaries that you are allowed to view. For - // more information, see Limiting a user to viewing specific canaries - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html). + // more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html) + // . Names []string - // A token that indicates that there is more data available. You can use this token - // in a subsequent operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent operation to retrieve the next set of results. NextToken *string noSmithyDocumentSerde @@ -64,12 +64,13 @@ type DescribeCanariesInput struct { type DescribeCanariesOutput struct { - // Returns an array. Each item in the array contains the full information about one - // canary. + // Returns an array. Each item in the array contains the full information about + // one canary. Canaries []types.Canary - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeCanaries operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent DescribeCanaries operation to retrieve the next set of + // results. NextToken *string // Metadata pertaining to the operation's result. @@ -148,9 +149,9 @@ var _ DescribeCanariesAPIClient = (*Client)(nil) // DescribeCanariesPaginatorOptions is the paginator options for DescribeCanaries type DescribeCanariesPaginatorOptions struct { - // Specify this parameter to limit how many canaries are returned each time you use - // the DescribeCanaries operation. If you omit this parameter, the default of 100 - // is used. + // Specify this parameter to limit how many canaries are returned each time you + // use the DescribeCanaries operation. If you omit this parameter, the default of + // 100 is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/synthetics/api_op_DescribeCanariesLastRun.go b/service/synthetics/api_op_DescribeCanariesLastRun.go index 24a8c7a22db..3d46709aced 100644 --- a/service/synthetics/api_op_DescribeCanariesLastRun.go +++ b/service/synthetics/api_op_DescribeCanariesLastRun.go @@ -14,14 +14,14 @@ import ( // Use this operation to see information from the most recent run of each canary // that you have created. This operation supports resource-level authorization -// using an IAM policy and the Names parameter. If you specify the Names parameter, -// the operation is successful only if you have authorization to view all the -// canaries that you specify in your request. If you do not have permission to view -// any of the canaries, the request fails with a 403 response. You are required to -// use the Names parameter if you are logged on to a user or role that has an IAM -// policy that restricts which canaries that you are allowed to view. For more -// information, see Limiting a user to viewing specific canaries -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html). +// using an IAM policy and the Names parameter. If you specify the Names +// parameter, the operation is successful only if you have authorization to view +// all the canaries that you specify in your request. If you do not have permission +// to view any of the canaries, the request fails with a 403 response. You are +// required to use the Names parameter if you are logged on to a user or role that +// has an IAM policy that restricts which canaries that you are allowed to view. +// For more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html) +// . func (c *Client) DescribeCanariesLastRun(ctx context.Context, params *DescribeCanariesLastRunInput, optFns ...func(*Options)) (*DescribeCanariesLastRunOutput, error) { if params == nil { params = &DescribeCanariesLastRunInput{} @@ -39,25 +39,25 @@ func (c *Client) DescribeCanariesLastRun(ctx context.Context, params *DescribeCa type DescribeCanariesLastRunInput struct { - // Specify this parameter to limit how many runs are returned each time you use the - // DescribeLastRun operation. If you omit this parameter, the default of 100 is - // used. + // Specify this parameter to limit how many runs are returned each time you use + // the DescribeLastRun operation. If you omit this parameter, the default of 100 + // is used. MaxResults *int32 - // Use this parameter to return only canaries that match the names that you specify - // here. You can specify as many as five canary names. If you specify this + // Use this parameter to return only canaries that match the names that you + // specify here. You can specify as many as five canary names. If you specify this // parameter, the operation is successful only if you have authorization to view // all the canaries that you specify in your request. If you do not have permission // to view any of the canaries, the request fails with a 403 response. You are // required to use the Names parameter if you are logged on to a user or role that // has an IAM policy that restricts which canaries that you are allowed to view. - // For more information, see Limiting a user to viewing specific canaries - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html). + // For more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html) + // . Names []string - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeCanariesLastRun operation to retrieve the next set of - // results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent DescribeCanariesLastRun operation to retrieve the next + // set of results. NextToken *string noSmithyDocumentSerde @@ -68,9 +68,9 @@ type DescribeCanariesLastRunOutput struct { // An array that contains the information from the most recent run of each canary. CanariesLastRun []types.CanaryLastRun - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeCanariesLastRun operation to retrieve the next set of - // results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent DescribeCanariesLastRun operation to retrieve the next + // set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -150,9 +150,9 @@ var _ DescribeCanariesLastRunAPIClient = (*Client)(nil) // DescribeCanariesLastRunPaginatorOptions is the paginator options for // DescribeCanariesLastRun type DescribeCanariesLastRunPaginatorOptions struct { - // Specify this parameter to limit how many runs are returned each time you use the - // DescribeLastRun operation. If you omit this parameter, the default of 100 is - // used. + // Specify this parameter to limit how many runs are returned each time you use + // the DescribeLastRun operation. If you omit this parameter, the default of 100 + // is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/synthetics/api_op_DescribeRuntimeVersions.go b/service/synthetics/api_op_DescribeRuntimeVersions.go index 7d7c203c9ce..c973e6d4a5c 100644 --- a/service/synthetics/api_op_DescribeRuntimeVersions.go +++ b/service/synthetics/api_op_DescribeRuntimeVersions.go @@ -13,8 +13,8 @@ import ( ) // Returns a list of Synthetics canary runtime versions. For more information, see -// Canary Runtime Versions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). +// Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) +// . func (c *Client) DescribeRuntimeVersions(ctx context.Context, params *DescribeRuntimeVersionsInput, optFns ...func(*Options)) (*DescribeRuntimeVersionsOutput, error) { if params == nil { params = &DescribeRuntimeVersionsInput{} @@ -32,14 +32,14 @@ func (c *Client) DescribeRuntimeVersions(ctx context.Context, params *DescribeRu type DescribeRuntimeVersionsInput struct { - // Specify this parameter to limit how many runs are returned each time you use the - // DescribeRuntimeVersions operation. If you omit this parameter, the default of - // 100 is used. + // Specify this parameter to limit how many runs are returned each time you use + // the DescribeRuntimeVersions operation. If you omit this parameter, the default + // of 100 is used. MaxResults *int32 - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeRuntimeVersions operation to retrieve the next set of - // results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent DescribeRuntimeVersions operation to retrieve the next + // set of results. NextToken *string noSmithyDocumentSerde @@ -47,9 +47,9 @@ type DescribeRuntimeVersionsInput struct { type DescribeRuntimeVersionsOutput struct { - // A token that indicates that there is more data available. You can use this token - // in a subsequent DescribeRuntimeVersions operation to retrieve the next set of - // results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent DescribeRuntimeVersions operation to retrieve the next + // set of results. NextToken *string // An array of objects that display the details about each Synthetics canary @@ -133,9 +133,9 @@ var _ DescribeRuntimeVersionsAPIClient = (*Client)(nil) // DescribeRuntimeVersionsPaginatorOptions is the paginator options for // DescribeRuntimeVersions type DescribeRuntimeVersionsPaginatorOptions struct { - // Specify this parameter to limit how many runs are returned each time you use the - // DescribeRuntimeVersions operation. If you omit this parameter, the default of - // 100 is used. + // Specify this parameter to limit how many runs are returned each time you use + // the DescribeRuntimeVersions operation. If you omit this parameter, the default + // of 100 is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/synthetics/api_op_DisassociateResource.go b/service/synthetics/api_op_DisassociateResource.go index d21a0807b97..1aee0977192 100644 --- a/service/synthetics/api_op_DisassociateResource.go +++ b/service/synthetics/api_op_DisassociateResource.go @@ -29,8 +29,8 @@ func (c *Client) DisassociateResource(ctx context.Context, params *DisassociateR type DisassociateResourceInput struct { - // Specifies the group. You can specify the group name, the ARN, or the group ID as - // the GroupIdentifier. + // Specifies the group. You can specify the group name, the ARN, or the group ID + // as the GroupIdentifier . // // This member is required. GroupIdentifier *string diff --git a/service/synthetics/api_op_GetCanary.go b/service/synthetics/api_op_GetCanary.go index c399bf28205..92c5a2da653 100644 --- a/service/synthetics/api_op_GetCanary.go +++ b/service/synthetics/api_op_GetCanary.go @@ -13,8 +13,8 @@ import ( // Retrieves complete information about one canary. You must specify the name of // the canary that you want. To get a list of canaries and their names, use -// DescribeCanaries -// (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). +// DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html) +// . func (c *Client) GetCanary(ctx context.Context, params *GetCanaryInput, optFns ...func(*Options)) (*GetCanaryOutput, error) { if params == nil { params = &GetCanaryInput{} diff --git a/service/synthetics/api_op_GetCanaryRuns.go b/service/synthetics/api_op_GetCanaryRuns.go index 55278ec7d91..e4ec944eec2 100644 --- a/service/synthetics/api_op_GetCanaryRuns.go +++ b/service/synthetics/api_op_GetCanaryRuns.go @@ -35,12 +35,14 @@ type GetCanaryRunsInput struct { // This member is required. Name *string - // Specify this parameter to limit how many runs are returned each time you use the - // GetCanaryRuns operation. If you omit this parameter, the default of 100 is used. + // Specify this parameter to limit how many runs are returned each time you use + // the GetCanaryRuns operation. If you omit this parameter, the default of 100 is + // used. MaxResults *int32 - // A token that indicates that there is more data available. You can use this token - // in a subsequent GetCanaryRuns operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent GetCanaryRuns operation to retrieve the next set of + // results. NextToken *string noSmithyDocumentSerde @@ -52,8 +54,9 @@ type GetCanaryRunsOutput struct { // retrieved canary runs. CanaryRuns []types.CanaryRun - // A token that indicates that there is more data available. You can use this token - // in a subsequent GetCanaryRuns operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent GetCanaryRuns operation to retrieve the next set of + // results. NextToken *string // Metadata pertaining to the operation's result. @@ -134,8 +137,9 @@ var _ GetCanaryRunsAPIClient = (*Client)(nil) // GetCanaryRunsPaginatorOptions is the paginator options for GetCanaryRuns type GetCanaryRunsPaginatorOptions struct { - // Specify this parameter to limit how many runs are returned each time you use the - // GetCanaryRuns operation. If you omit this parameter, the default of 100 is used. + // Specify this parameter to limit how many runs are returned each time you use + // the GetCanaryRuns operation. If you omit this parameter, the default of 100 is + // used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/synthetics/api_op_GetGroup.go b/service/synthetics/api_op_GetGroup.go index abdb4cc8123..d4523e18943 100644 --- a/service/synthetics/api_op_GetGroup.go +++ b/service/synthetics/api_op_GetGroup.go @@ -31,7 +31,7 @@ func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ... type GetGroupInput struct { // Specifies the group to return information for. You can specify the group name, - // the ARN, or the group ID as the GroupIdentifier. + // the ARN, or the group ID as the GroupIdentifier . // // This member is required. GroupIdentifier *string diff --git a/service/synthetics/api_op_ListAssociatedGroups.go b/service/synthetics/api_op_ListAssociatedGroups.go index 0ca59a1e1f4..0d0af5b5825 100644 --- a/service/synthetics/api_op_ListAssociatedGroups.go +++ b/service/synthetics/api_op_ListAssociatedGroups.go @@ -41,8 +41,8 @@ type ListAssociatedGroupsInput struct { // 20 is used. MaxResults *int32 - // A token that indicates that there is more data available. You can use this token - // in a subsequent operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent operation to retrieve the next set of results. NextToken *string noSmithyDocumentSerde @@ -54,9 +54,9 @@ type ListAssociatedGroupsOutput struct { // canary is associated with. Groups []types.GroupSummary - // A token that indicates that there is more data available. You can use this token - // in a subsequent ListAssociatedGroups operation to retrieve the next set of - // results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent ListAssociatedGroups operation to retrieve the next set + // of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/synthetics/api_op_ListGroupResources.go b/service/synthetics/api_op_ListGroupResources.go index 7f44cab9603..7b8e3176ea0 100644 --- a/service/synthetics/api_op_ListGroupResources.go +++ b/service/synthetics/api_op_ListGroupResources.go @@ -31,18 +31,18 @@ func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResour type ListGroupResourcesInput struct { // Specifies the group to return information for. You can specify the group name, - // the ARN, or the group ID as the GroupIdentifier. + // the ARN, or the group ID as the GroupIdentifier . // // This member is required. GroupIdentifier *string // Specify this parameter to limit how many canary ARNs are returned each time you - // use the ListGroupResources operation. If you omit this parameter, the default of - // 20 is used. + // use the ListGroupResources operation. If you omit this parameter, the default + // of 20 is used. MaxResults *int32 - // A token that indicates that there is more data available. You can use this token - // in a subsequent operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent operation to retrieve the next set of results. NextToken *string noSmithyDocumentSerde @@ -50,8 +50,8 @@ type ListGroupResourcesInput struct { type ListGroupResourcesOutput struct { - // A token that indicates that there is more data available. You can use this token - // in a subsequent ListGroupResources operation to retrieve the next set of + // A token that indicates that there is more data available. You can use this + // token in a subsequent ListGroupResources operation to retrieve the next set of // results. NextToken *string @@ -140,8 +140,8 @@ var _ ListGroupResourcesAPIClient = (*Client)(nil) // ListGroupResources type ListGroupResourcesPaginatorOptions struct { // Specify this parameter to limit how many canary ARNs are returned each time you - // use the ListGroupResources operation. If you omit this parameter, the default of - // 20 is used. + // use the ListGroupResources operation. If you omit this parameter, the default + // of 20 is used. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/synthetics/api_op_ListGroups.go b/service/synthetics/api_op_ListGroups.go index 79c6d843764..68e2791eea5 100644 --- a/service/synthetics/api_op_ListGroups.go +++ b/service/synthetics/api_op_ListGroups.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of all groups in the account, displaying their names, unique IDs, -// and ARNs. The groups from all Regions are returned. +// Returns a list of all groups in the account, displaying their names, unique +// IDs, and ARNs. The groups from all Regions are returned. func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} @@ -35,8 +35,8 @@ type ListGroupsInput struct { // the ListGroups operation. If you omit this parameter, the default of 20 is used. MaxResults *int32 - // A token that indicates that there is more data available. You can use this token - // in a subsequent operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent operation to retrieve the next set of results. NextToken *string noSmithyDocumentSerde @@ -47,8 +47,8 @@ type ListGroupsOutput struct { // An array of structures that each contain information about one group. Groups []types.GroupSummary - // A token that indicates that there is more data available. You can use this token - // in a subsequent ListGroups operation to retrieve the next set of results. + // A token that indicates that there is more data available. You can use this + // token in a subsequent ListGroups operation to retrieve the next set of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/synthetics/api_op_ListTagsForResource.go b/service/synthetics/api_op_ListTagsForResource.go index e51e64247ad..5f9748688b5 100644 --- a/service/synthetics/api_op_ListTagsForResource.go +++ b/service/synthetics/api_op_ListTagsForResource.go @@ -28,9 +28,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN of the canary or group that you want to view tags for. The ARN format of - // a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN - // format of a group is arn:aws:synthetics:Region:account-id:group:group-name + // The ARN of the canary or group that you want to view tags for. The ARN format + // of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The + // ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name // // This member is required. ResourceArn *string diff --git a/service/synthetics/api_op_StartCanary.go b/service/synthetics/api_op_StartCanary.go index 508aa629a18..2fc2d605f8e 100644 --- a/service/synthetics/api_op_StartCanary.go +++ b/service/synthetics/api_op_StartCanary.go @@ -11,9 +11,9 @@ import ( ) // Use this operation to run a canary that has already been created. The frequency -// of the canary runs is determined by the value of the canary's Schedule. To see a -// canary's schedule, use GetCanary -// (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html). +// of the canary runs is determined by the value of the canary's Schedule . To see +// a canary's schedule, use GetCanary (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html) +// . func (c *Client) StartCanary(ctx context.Context, params *StartCanaryInput, optFns ...func(*Options)) (*StartCanaryOutput, error) { if params == nil { params = &StartCanaryInput{} @@ -32,8 +32,8 @@ func (c *Client) StartCanary(ctx context.Context, params *StartCanaryInput, optF type StartCanaryInput struct { // The name of the canary that you want to run. To find canary names, use - // DescribeCanaries - // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). + // DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html) + // . // // This member is required. Name *string diff --git a/service/synthetics/api_op_StopCanary.go b/service/synthetics/api_op_StopCanary.go index 28dad3ea3cb..8cc0993fade 100644 --- a/service/synthetics/api_op_StopCanary.go +++ b/service/synthetics/api_op_StopCanary.go @@ -13,8 +13,8 @@ import ( // Stops the canary to prevent all future runs. If the canary is currently // running,the run that is in progress completes on its own, publishes metrics, and // uploads artifacts, but it is not recorded in Synthetics as a completed run. You -// can use StartCanary to start it running again with the canary’s current schedule -// at any point in the future. +// can use StartCanary to start it running again with the canary’s current +// schedule at any point in the future. func (c *Client) StopCanary(ctx context.Context, params *StopCanaryInput, optFns ...func(*Options)) (*StopCanaryOutput, error) { if params == nil { params = &StopCanaryInput{} @@ -33,8 +33,8 @@ func (c *Client) StopCanary(ctx context.Context, params *StopCanaryInput, optFns type StopCanaryInput struct { // The name of the canary that you want to stop. To find the names of your - // canaries, use ListCanaries - // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). + // canaries, use ListCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html) + // . // // This member is required. Name *string diff --git a/service/synthetics/api_op_UntagResource.go b/service/synthetics/api_op_UntagResource.go index c321f182d4b..a0e50da9e3f 100644 --- a/service/synthetics/api_op_UntagResource.go +++ b/service/synthetics/api_op_UntagResource.go @@ -28,9 +28,9 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ARN of the canary or group that you're removing tags from. The ARN format of - // a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN - // format of a group is arn:aws:synthetics:Region:account-id:group:group-name + // The ARN of the canary or group that you're removing tags from. The ARN format + // of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The + // ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name // // This member is required. ResourceArn *string diff --git a/service/synthetics/api_op_UpdateCanary.go b/service/synthetics/api_op_UpdateCanary.go index d07525bf1c9..79da3f1f955 100644 --- a/service/synthetics/api_op_UpdateCanary.go +++ b/service/synthetics/api_op_UpdateCanary.go @@ -13,8 +13,8 @@ import ( // Updates the configuration of a canary that has already been created. You can't // use this operation to update the tags of an existing canary. To change the tags -// of an existing canary, use TagResource -// (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html). +// of an existing canary, use TagResource (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html) +// . func (c *Client) UpdateCanary(ctx context.Context, params *UpdateCanaryInput, optFns ...func(*Options)) (*UpdateCanaryOutput, error) { if params == nil { params = &UpdateCanaryInput{} @@ -33,9 +33,8 @@ func (c *Client) UpdateCanary(ctx context.Context, params *UpdateCanaryInput, op type UpdateCanaryInput struct { // The name of the canary that you want to update. To find the names of your - // canaries, use DescribeCanaries - // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html). - // You cannot change the name of a canary that has already been created. + // canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html) + // . You cannot change the name of a canary that has already been created. // // This member is required. Name *string @@ -55,38 +54,29 @@ type UpdateCanaryInput struct { Code *types.CanaryCodeInput // The ARN of the IAM role to be used to run the canary. This role must already - // exist, and must include lambda.amazonaws.com as a principal in the trust policy. - // The role must also have the following permissions: - // - // * s3:PutObject - // - // * - // s3:GetBucketLocation - // - // * s3:ListAllMyBuckets - // - // * cloudwatch:PutMetricData - // - // * - // logs:CreateLogGroup - // - // * logs:CreateLogStream - // - // * logs:CreateLogStream + // exist, and must include lambda.amazonaws.com as a principal in the trust + // policy. The role must also have the following permissions: + // - s3:PutObject + // - s3:GetBucketLocation + // - s3:ListAllMyBuckets + // - cloudwatch:PutMetricData + // - logs:CreateLogGroup + // - logs:CreateLogStream + // - logs:CreateLogStream ExecutionRoleArn *string // The number of days to retain data about failed runs of this canary. FailureRetentionPeriodInDays *int32 - // A structure that contains the timeout value that is used for each individual run - // of the canary. The environment variables keys and values are not encrypted. Do - // not store sensitive information in this field. + // A structure that contains the timeout value that is used for each individual + // run of the canary. The environment variables keys and values are not encrypted. + // Do not store sensitive information in this field. RunConfig *types.CanaryRunConfigInput - // Specifies the runtime version to use for the canary. For a list of valid runtime - // versions and for more information about runtime versions, see Canary Runtime - // Versions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). + // Specifies the runtime version to use for the canary. For a list of valid + // runtime versions and for more information about runtime versions, see Canary + // Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) + // . RuntimeVersion *string // A structure that contains information about how often the canary is to run, and @@ -100,17 +90,15 @@ type UpdateCanaryInput struct { // monitoring comparisons during future runs of this canary. If you omit this // parameter, no changes are made to any baseline screenshots that the canary might // be using already. Visual monitoring is supported only on canaries running the - // syn-puppeteer-node-3.2 runtime or later. For more information, see Visual - // monitoring - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) - // and Visual monitoring blueprint - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) + // syn-puppeteer-node-3.2 runtime or later. For more information, see Visual + // monitoring (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) + // and Visual monitoring blueprint (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) VisualReference *types.VisualReferenceInput // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnet and security groups of the VPC endpoint. For more - // information, see Running a Canary in a VPC - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). + // information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) + // . VpcConfig *types.VpcConfigInput noSmithyDocumentSerde diff --git a/service/synthetics/doc.go b/service/synthetics/doc.go index 7164a30e178..a00f1ee7aca 100644 --- a/service/synthetics/doc.go +++ b/service/synthetics/doc.go @@ -12,10 +12,9 @@ // UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch // ServiceLens to help you trace the causes of impacted nodes in your applications. // For more information, see Using ServiceLens to Monitor the Health of Your -// Applications -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html) +// Applications (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html) // in the Amazon CloudWatch User Guide. Before you create and manage canaries, be // aware of the security considerations. For more information, see Security -// Considerations for Synthetics Canaries -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html). +// Considerations for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) +// . package synthetics diff --git a/service/synthetics/types/enums.go b/service/synthetics/types/enums.go index 0fbd1d65a0c..938c00904c6 100644 --- a/service/synthetics/types/enums.go +++ b/service/synthetics/types/enums.go @@ -30,9 +30,9 @@ const ( CanaryRunStateReasonCodeExecutionFailure CanaryRunStateReasonCode = "EXECUTION_FAILURE" ) -// Values returns all known values for CanaryRunStateReasonCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for CanaryRunStateReasonCode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (CanaryRunStateReasonCode) Values() []CanaryRunStateReasonCode { return []CanaryRunStateReasonCode{ "CANARY_FAILURE", @@ -90,8 +90,8 @@ const ( CanaryStateReasonCodeSyncDeleteInProgress CanaryStateReasonCode = "SYNC_DELETE_IN_PROGRESS" ) -// Values returns all known values for CanaryStateReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CanaryStateReasonCode. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CanaryStateReasonCode) Values() []CanaryStateReasonCode { return []CanaryStateReasonCode{ diff --git a/service/synthetics/types/types.go b/service/synthetics/types/types.go index f2144a9e5cc..83737e714d9 100644 --- a/service/synthetics/types/types.go +++ b/service/synthetics/types/types.go @@ -15,8 +15,7 @@ type ArtifactConfigInput struct { // for artifacts that the canary uploads to Amazon S3. Artifact encryption // functionality is available only for canaries that use Synthetics runtime version // syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary - // artifacts - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) + // artifacts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) S3Encryption *S3EncryptionConfig noSmithyDocumentSerde @@ -46,9 +45,8 @@ type BaseScreenshot struct { // Coordinates that define the part of a screen to ignore during screenshot // comparisons. To obtain the coordinates to use here, use the CloudWatch console - // to draw the boundaries on the screen. For more information, see Editing or - // deleting a canary - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html) + // to draw the boundaries on the screen. For more information, see Editing or + // deleting a canary (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html) IgnoreCoordinates []string noSmithyDocumentSerde @@ -71,8 +69,8 @@ type Canary struct { // The ARN of the Lambda function that is used as your canary's engine. For more // information about Lambda ARN format, see Resources and Conditions for Lambda - // Actions - // (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html). + // Actions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html) + // . EngineArn *string // The ARN of the IAM role used to run the canary. This role must include @@ -92,8 +90,8 @@ type Canary struct { RunConfig *CanaryRunConfigOutput // Specifies the runtime version to use for the canary. For more information about - // runtime versions, see Canary Runtime Versions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). + // runtime versions, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) + // . RuntimeVersion *string // A structure that contains information about how often the canary is to run, and @@ -121,8 +119,8 @@ type Canary struct { // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnets and security groups of the VPC endpoint. For more - // information, see Running a Canary in a VPC - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). + // information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) + // . VpcConfig *VpcConfigOutput noSmithyDocumentSerde @@ -132,14 +130,14 @@ type Canary struct { // contains the Lambda handler with the location where the canary should start // running the script. If the script is stored in an S3 bucket, the bucket name, // key, and version are also included. If the script was passed into the canary -// directly, the script code is contained in the value of Zipfile. +// directly, the script code is contained in the value of Zipfile . type CanaryCodeInput struct { - // The entry point to use for the source code when running the canary. For canaries - // that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime - // earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as - // fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and - // later runtimes, the handler can be specified as fileName.functionName , or you + // The entry point to use for the source code when running the canary. For + // canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer + // runtime earlier than syn-nodejs.puppeteer-3.4 , the handler must be specified as + // fileName.handler . For syn-python-selenium-1.1 , syn-nodejs.puppeteer-3.4 , and + // later runtimes, the handler can be specified as fileName.functionName , or you // can specify a folder where canary scripts reside as // folder/fileName.functionName . // @@ -151,14 +149,14 @@ type CanaryCodeInput struct { S3Bucket *string // The S3 key of your script. For more information, see Working with Amazon S3 - // Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html). + // Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) . S3Key *string // The S3 version ID of your script. S3Version *string - // If you input your canary script directly into the canary instead of referring to - // an S3 location, the value of this parameter is the base64-encoded contents of + // If you input your canary script directly into the canary instead of referring + // to an S3 location, the value of this parameter is the base64-encoded contents of // the .zip file that contains the script. It must be smaller than 225 Kb. For // large canary scripts, we recommend that you use an S3 location instead of // inputting it directly with this parameter. @@ -222,10 +220,9 @@ type CanaryRunConfigInput struct { // Active tracing enables this canary run to be displayed in the ServiceLens and // X-Ray service maps even if the canary does not hit an endpoint that has X-Ray // tracing enabled. Using X-Ray tracing incurs charges. For more information, see - // Canaries and X-Ray tracing - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html). - // You can enable active tracing only for canaries that use version syn-nodejs-2.0 - // or later for their canary runtime. + // Canaries and X-Ray tracing (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html) + // . You can enable active tracing only for canaries that use version + // syn-nodejs-2.0 or later for their canary runtime. ActiveTracing *bool // Specifies the keys and values to use for any environment variables used in the @@ -233,15 +230,14 @@ type CanaryRunConfigInput struct { // ...} Keys must start with a letter and be at least two characters. The total // size of your environment variables cannot exceed 4 KB. You can't specify any // Lambda reserved environment variables as the keys for your environment - // variables. For more information about reserved keys, see Runtime environment - // variables - // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime). - // The environment variables keys and values are not encrypted. Do not store + // variables. For more information about reserved keys, see Runtime environment + // variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) + // . The environment variables keys and values are not encrypted. Do not store // sensitive information in this field. EnvironmentVariables map[string]string - // The maximum amount of memory available to the canary while it is running, in MB. - // This value must be a multiple of 64. + // The maximum amount of memory available to the canary while it is running, in + // MB. This value must be a multiple of 64. MemoryInMB *int32 // How long the canary is allowed to run before it must stop. You can't set this @@ -259,8 +255,8 @@ type CanaryRunConfigOutput struct { // Displays whether this canary run used active X-Ray tracing. ActiveTracing *bool - // The maximum amount of memory available to the canary while it is running, in MB. - // This value must be a multiple of 64. + // The maximum amount of memory available to the canary while it is running, in + // MB. This value must be a multiple of 64. MemoryInMB *int32 // How long the canary is allowed to run before it must stop. @@ -278,8 +274,8 @@ type CanaryRunStatus struct { // If run of the canary failed, this field contains the reason for the error. StateReason *string - // If this value is CANARY_FAILURE, an exception occurred in the canary code. If - // this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics. + // If this value is CANARY_FAILURE , an exception occurred in the canary code. If + // this value is EXECUTION_FAILURE , an exception occurred in CloudWatch Synthetics. StateReasonCode CanaryRunStateReasonCode noSmithyDocumentSerde @@ -302,16 +298,16 @@ type CanaryRunTimeline struct { type CanaryScheduleInput struct { // A rate expression or a cron expression that defines how often the canary is to - // run. For a rate expression, The syntax is rate(number unit). unit can be minute, - // minutes, or hour. For example, rate(1 minute) runs the canary once a minute, - // rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once - // every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). - // Specifying rate(0 minute) or rate(0 hour) is a special value that causes the - // canary to run only once when it is started. Use cron(expression) to specify a - // cron expression. You can't schedule a canary to wait for more than a year before - // running. For information about the syntax for cron expressions, see Scheduling - // canary runs using cron - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html). + // run. For a rate expression, The syntax is rate(number unit) . unit can be minute + // , minutes , or hour . For example, rate(1 minute) runs the canary once a + // minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs + // it once every hour. You can specify a frequency between rate(1 minute) and + // rate(1 hour) . Specifying rate(0 minute) or rate(0 hour) is a special value + // that causes the canary to run only once when it is started. Use cron(expression) + // to specify a cron expression. You can't schedule a canary to wait for more than + // a year before running. For information about the syntax for cron expressions, + // see Scheduling canary runs using cron (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) + // . // // This member is required. Expression *string @@ -334,15 +330,15 @@ type CanaryScheduleOutput struct { DurationInSeconds *int64 // A rate expression or a cron expression that defines how often the canary is to - // run. For a rate expression, The syntax is rate(number unit). unit can be minute, - // minutes, or hour. For example, rate(1 minute) runs the canary once a minute, - // rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once - // every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). - // Specifying rate(0 minute) or rate(0 hour) is a special value that causes the - // canary to run only once when it is started. Use cron(expression) to specify a - // cron expression. For information about the syntax for cron expressions, see - // Scheduling canary runs using cron - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html). + // run. For a rate expression, The syntax is rate(number unit) . unit can be minute + // , minutes , or hour . For example, rate(1 minute) runs the canary once a + // minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs + // it once every hour. You can specify a frequency between rate(1 minute) and + // rate(1 hour) . Specifying rate(0 minute) or rate(0 hour) is a special value + // that causes the canary to run only once when it is started. Use cron(expression) + // to specify a cron expression. For information about the syntax for cron + // expressions, see Scheduling canary runs using cron (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) + // . Expression *string noSmithyDocumentSerde @@ -423,8 +419,8 @@ type GroupSummary struct { } // This structure contains information about one canary runtime version. For more -// information about runtime versions, see Canary Runtime Versions -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). +// information about runtime versions, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) +// . type RuntimeVersion struct { // If this runtime version is deprecated, this value is the date of deprecation. @@ -437,8 +433,8 @@ type RuntimeVersion struct { ReleaseDate *time.Time // The name of the runtime version. For a list of valid runtime versions, see - // Canary Runtime Versions - // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). + // Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) + // . VersionName *string noSmithyDocumentSerde @@ -446,8 +442,7 @@ type RuntimeVersion struct { // A structure that contains the configuration of encryption-at-rest settings for // canary artifacts that the canary uploads to Amazon S3. For more information, see -// Encrypting canary artifacts -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) +// Encrypting canary artifacts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) type S3EncryptionConfig struct { // The encryption method to use for artifacts created by this canary. Specify @@ -467,18 +462,15 @@ type S3EncryptionConfig struct { // monitoring by this canary. It can optionally also specify parts of the // screenshots to ignore during the visual monitoring comparison. Visual monitoring // is supported only on canaries running the syn-puppeteer-node-3.2 runtime or -// later. For more information, see Visual monitoring -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) -// and Visual monitoring blueprint -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) +// later. For more information, see Visual monitoring (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) +// and Visual monitoring blueprint (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) type VisualReferenceInput struct { // Specifies which canary run to use the screenshots from as the baseline for // future visual monitoring with this canary. Valid values are nextrun to use the // screenshots from the next run after this update is made, lastrun to use the // screenshots from the most recent run before this update was made, or the value - // of Id in the CanaryRun - // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) + // of Id in the CanaryRun (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) // from any past run of this canary. // // This member is required. @@ -512,8 +504,8 @@ type VisualReferenceOutput struct { // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnets and security groups of the VPC endpoint. For more -// information, see Running a Canary in a VPC -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). +// information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) +// . type VpcConfigInput struct { // The IDs of the security groups for this canary. @@ -527,8 +519,8 @@ type VpcConfigInput struct { // If this canary is to test an endpoint in a VPC, this structure contains // information about the subnets and security groups of the VPC endpoint. For more -// information, see Running a Canary in a VPC -// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html). +// information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) +// . type VpcConfigOutput struct { // The IDs of the security groups for this canary. diff --git a/service/textract/api_client.go b/service/textract/api_client.go index 4b81b96cdce..f9d65b62314 100644 --- a/service/textract/api_client.go +++ b/service/textract/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/textract/api_op_AnalyzeDocument.go b/service/textract/api_op_AnalyzeDocument.go index 979ba26a8be..b1ac01a1260 100644 --- a/service/textract/api_op_AnalyzeDocument.go +++ b/service/textract/api_op_AnalyzeDocument.go @@ -13,43 +13,34 @@ import ( // Analyzes an input document for relationships between detected items. The types // of information returned are as follows: +// - Form data (key-value pairs). The related information is returned in two +// Block objects, each of type KEY_VALUE_SET : a KEY Block object and a VALUE +// Block object. For example, Name: Ana Silva Carolina contains a key and value. +// Name: is the key. Ana Silva Carolina is the value. +// - Table and table cell data. A TABLE Block object contains information about a +// detected table. A CELL Block object is returned for each cell in a table. +// - Lines and words of text. A LINE Block object contains one or more WORD Block +// objects. All lines and words that are detected in the document are returned +// (including text that doesn't have a relationship with the value of +// FeatureTypes ). +// - Signatures. A SIGNATURE Block object contains the location information of a +// signature in a document. If used in conjunction with forms or tables, a +// signature can be given a Key-Value pairing or be detected in the cell of a +// table. +// - Query. A QUERY Block object contains the query text, alias and link to the +// associated Query results block object. +// - Query Result. A QUERY_RESULT Block object contains the answer to the query +// and an ID that connects it to the query asked. This Block also contains a +// confidence score. // -// * Form data (key-value pairs). The -// related information is returned in two Block objects, each of type -// KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: -// Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva -// Carolina is the value. -// -// * Table and table cell data. A TABLE Block object -// contains information about a detected table. A CELL Block object is returned for -// each cell in a table. -// -// * Lines and words of text. A LINE Block object contains -// one or more WORD Block objects. All lines and words that are detected in the -// document are returned (including text that doesn't have a relationship with the -// value of FeatureTypes). -// -// * Signatures. A SIGNATURE Block object contains the -// location information of a signature in a document. If used in conjunction with -// forms or tables, a signature can be given a Key-Value pairing or be detected in -// the cell of a table. -// -// * Query. A QUERY Block object contains the query text, -// alias and link to the associated Query results block object. -// -// * Query Result. A -// QUERY_RESULT Block object contains the answer to the query and an ID that -// connects it to the query asked. This Block also contains a confidence -// score. -// -// Selection elements such as check boxes and option buttons (radio -// buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block -// object contains information about a selection element, including the selection -// status. You can choose which type of analysis to perform by specifying the -// FeatureTypes list. The output is returned in a list of Block objects. -// AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, -// use StartDocumentAnalysis. For more information, see Document Text Analysis -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). +// Selection elements such as check boxes and option buttons (radio buttons) can +// be detected in form data and in tables. A SELECTION_ELEMENT Block object +// contains information about a selection element, including the selection status. +// You can choose which type of analysis to perform by specifying the FeatureTypes +// list. The output is returned in a list of Block objects. AnalyzeDocument is a +// synchronous operation. To analyze documents asynchronously, use +// StartDocumentAnalysis . For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html) +// . func (c *Client) AnalyzeDocument(ctx context.Context, params *AnalyzeDocumentInput, optFns ...func(*Options)) (*AnalyzeDocumentOutput, error) { if params == nil { params = &AnalyzeDocumentInput{} @@ -80,10 +71,10 @@ type AnalyzeDocumentInput struct { // information about the tables that are detected in the input document. Add FORMS // to return detected form data. Add SIGNATURES to return the locations of detected // signatures. To perform both forms and table analysis, add TABLES and FORMS to - // FeatureTypes. To detect signatures within form data and table data, add + // FeatureTypes . To detect signatures within form data and table data, add // SIGNATURES to either TABLES or FORMS. All lines and words detected in the // document are included in the response (including text that isn't related to the - // value of FeatureTypes). + // value of FeatureTypes ). // // This member is required. FeatureTypes []types.FeatureType @@ -103,7 +94,7 @@ type AnalyzeDocumentOutput struct { // The version of the model used to analyze the document. AnalyzeDocumentModelVersion *string - // The items that are detected and analyzed by AnalyzeDocument. + // The items that are detected and analyzed by AnalyzeDocument . Blocks []types.Block // Metadata about the analyzed document. An example is the number of pages. diff --git a/service/textract/api_op_AnalyzeExpense.go b/service/textract/api_op_AnalyzeExpense.go index ce23d8cd101..d00e41c225a 100644 --- a/service/textract/api_op_AnalyzeExpense.go +++ b/service/textract/api_op_AnalyzeExpense.go @@ -14,13 +14,10 @@ import ( // AnalyzeExpense synchronously analyzes an input document for financially related // relationships between text. Information is returned as ExpenseDocuments and // seperated as follows: -// -// * LineItemGroups- A data set containing LineItems which -// store information about the lines of text, such as an item purchased and its -// price on a receipt. -// -// * SummaryFields- Contains all other information a receipt, -// such as header information or the vendors name. +// - LineItemGroups - A data set containing LineItems which store information +// about the lines of text, such as an item purchased and its price on a receipt. +// - SummaryFields - Contains all other information a receipt, such as header +// information or the vendors name. func (c *Client) AnalyzeExpense(ctx context.Context, params *AnalyzeExpenseInput, optFns ...func(*Options)) (*AnalyzeExpenseOutput, error) { if params == nil { params = &AnalyzeExpenseInput{} @@ -40,18 +37,18 @@ type AnalyzeExpenseInput struct { // The input document, either as bytes or as an S3 object. You pass image bytes to // an Amazon Textract API operation by using the Bytes property. For example, you - // would use the Bytes property to pass a document loaded from a local file system. - // Image bytes passed by using the Bytes property must be base64 encoded. Your code - // might not need to encode document file bytes if you're using an AWS SDK to call - // Amazon Textract API operations. You pass images stored in an S3 bucket to an - // Amazon Textract API operation by using the S3Object property. Documents stored - // in an S3 bucket don't need to be base64 encoded. The AWS Region for the S3 - // bucket that contains the S3 object must match the AWS Region that you use for - // Amazon Textract operations. If you use the AWS CLI to call Amazon Textract - // operations, passing image bytes using the Bytes property isn't supported. You - // must first upload the document to an Amazon S3 bucket, and then call the - // operation using the S3Object property. For Amazon Textract to process an S3 - // object, the user must have permission to access the S3 object. + // would use the Bytes property to pass a document loaded from a local file + // system. Image bytes passed by using the Bytes property must be base64 encoded. + // Your code might not need to encode document file bytes if you're using an AWS + // SDK to call Amazon Textract API operations. You pass images stored in an S3 + // bucket to an Amazon Textract API operation by using the S3Object property. + // Documents stored in an S3 bucket don't need to be base64 encoded. The AWS Region + // for the S3 bucket that contains the S3 object must match the AWS Region that you + // use for Amazon Textract operations. If you use the AWS CLI to call Amazon + // Textract operations, passing image bytes using the Bytes property isn't + // supported. You must first upload the document to an Amazon S3 bucket, and then + // call the operation using the S3Object property. For Amazon Textract to process + // an S3 object, the user must have permission to access the S3 object. // // This member is required. Document *types.Document diff --git a/service/textract/api_op_AnalyzeID.go b/service/textract/api_op_AnalyzeID.go index 899b0722684..1fef4a8b204 100644 --- a/service/textract/api_op_AnalyzeID.go +++ b/service/textract/api_op_AnalyzeID.go @@ -12,7 +12,7 @@ import ( ) // Analyzes identity documents for relevant information. This information is -// extracted and returned as IdentityDocumentFields, which records both the +// extracted and returned as IdentityDocumentFields , which records both the // normalized field and value of the extracted text. Unlike other Amazon Textract // operations, AnalyzeID doesn't return any Geometry data. func (c *Client) AnalyzeID(ctx context.Context, params *AnalyzeIDInput, optFns ...func(*Options)) (*AnalyzeIDOutput, error) { diff --git a/service/textract/api_op_DetectDocumentText.go b/service/textract/api_op_DetectDocumentText.go index d28b925e131..bacc4483c1f 100644 --- a/service/textract/api_op_DetectDocumentText.go +++ b/service/textract/api_op_DetectDocumentText.go @@ -11,17 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detects text in the input document. Amazon Textract can detect lines of text and -// the words that make up a line of text. The input document must be in one of the -// following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the -// detected text in an array of Block objects. Each document page has as an -// associated Block of type PAGE. Each PAGE Block object is the parent of LINE -// Block objects that represent the lines of detected text on a page. A LINE Block -// object is a parent for each word that makes up the line. Words are represented -// by Block objects of type WORD. DetectDocumentText is a synchronous operation. To -// analyze documents asynchronously, use StartDocumentTextDetection. For more -// information, see Document Text Detection -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). +// Detects text in the input document. Amazon Textract can detect lines of text +// and the words that make up a line of text. The input document must be in one of +// the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText +// returns the detected text in an array of Block objects. Each document page has +// as an associated Block of type PAGE. Each PAGE Block object is the parent of +// LINE Block objects that represent the lines of detected text on a page. A LINE +// Block object is a parent for each word that makes up the line. Words are +// represented by Block objects of type WORD. DetectDocumentText is a synchronous +// operation. To analyze documents asynchronously, use StartDocumentTextDetection . +// For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html) +// . func (c *Client) DetectDocumentText(ctx context.Context, params *DetectDocumentTextInput, optFns ...func(*Options)) (*DetectDocumentTextOutput, error) { if params == nil { params = &DetectDocumentTextInput{} diff --git a/service/textract/api_op_GetDocumentAnalysis.go b/service/textract/api_op_GetDocumentAnalysis.go index 65e1853c442..9e33a1ff654 100644 --- a/service/textract/api_op_GetDocumentAnalysis.go +++ b/service/textract/api_op_GetDocumentAnalysis.go @@ -13,53 +13,45 @@ import ( // Gets the results for an Amazon Textract asynchronous operation that analyzes // text in a document. You start asynchronous text analysis by calling -// StartDocumentAnalysis, which returns a job identifier (JobId). When the text +// StartDocumentAnalysis , which returns a job identifier ( JobId ). When the text // analysis operation finishes, Amazon Textract publishes a completion status to // the Amazon Simple Notification Service (Amazon SNS) topic that's registered in -// the initial call to StartDocumentAnalysis. To get the results of the +// the initial call to StartDocumentAnalysis . To get the results of the // text-detection operation, first check that the status value published to the -// Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job -// identifier (JobId) from the initial call to StartDocumentAnalysis. +// Amazon SNS topic is SUCCEEDED . If so, call GetDocumentAnalysis , and pass the +// job identifier ( JobId ) from the initial call to StartDocumentAnalysis . // GetDocumentAnalysis returns an array of Block objects. The following types of // information are returned: +// - Form data (key-value pairs). The related information is returned in two +// Block objects, each of type KEY_VALUE_SET : a KEY Block object and a VALUE +// Block object. For example, Name: Ana Silva Carolina contains a key and value. +// Name: is the key. Ana Silva Carolina is the value. +// - Table and table cell data. A TABLE Block object contains information about a +// detected table. A CELL Block object is returned for each cell in a table. +// - Lines and words of text. A LINE Block object contains one or more WORD Block +// objects. All lines and words that are detected in the document are returned +// (including text that doesn't have a relationship with the value of the +// StartDocumentAnalysis FeatureTypes input parameter). +// - Query. A QUERY Block object contains the query text, alias and link to the +// associated Query results block object. +// - Query Results. A QUERY_RESULT Block object contains the answer to the query +// and an ID that connects it to the query asked. This Block also contains a +// confidence score. // -// * Form data (key-value pairs). The related -// information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY -// Block object and a VALUE Block object. For example, Name: Ana Silva Carolina -// contains a key and value. Name: is the key. Ana Silva Carolina is the value. -// -// * -// Table and table cell data. A TABLE Block object contains information about a -// detected table. A CELL Block object is returned for each cell in a table. -// -// * -// Lines and words of text. A LINE Block object contains one or more WORD Block -// objects. All lines and words that are detected in the document are returned -// (including text that doesn't have a relationship with the value of the -// StartDocumentAnalysisFeatureTypes input parameter). -// -// * Query. A QUERY Block -// object contains the query text, alias and link to the associated Query results -// block object. -// -// * Query Results. A QUERY_RESULT Block object contains the answer -// to the query and an ID that connects it to the query asked. This Block also -// contains a confidence score. -// -// While processing a document with queries, look out -// for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page -// query limit has been exceeded or that the operation is trying to query a page in -// the document which doesn’t exist. Selection elements such as check boxes and -// option buttons (radio buttons) can be detected in form data and in tables. A +// While processing a document with queries, look out for +// INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query +// limit has been exceeded or that the operation is trying to query a page in the +// document which doesn’t exist. Selection elements such as check boxes and option +// buttons (radio buttons) can be detected in form data and in tables. A // SELECTION_ELEMENT Block object contains information about a selection element, -// including the selection status. Use the MaxResults parameter to limit the number -// of blocks that are returned. If there are more results than specified in -// MaxResults, the value of NextToken in the operation response contains a +// including the selection status. Use the MaxResults parameter to limit the +// number of blocks that are returned. If there are more results than specified in +// MaxResults , the value of NextToken in the operation response contains a // pagination token for getting the next set of results. To get the next page of -// results, call GetDocumentAnalysis, and populate the NextToken request parameter -// with the token value that's returned from the previous call to -// GetDocumentAnalysis. For more information, see Document Text Analysis -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). +// results, call GetDocumentAnalysis , and populate the NextToken request +// parameter with the token value that's returned from the previous call to +// GetDocumentAnalysis . For more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html) +// . func (c *Client) GetDocumentAnalysis(ctx context.Context, params *GetDocumentAnalysisInput, optFns ...func(*Options)) (*GetDocumentAnalysisOutput, error) { if params == nil { params = &GetDocumentAnalysisInput{} @@ -78,7 +70,7 @@ func (c *Client) GetDocumentAnalysis(ctx context.Context, params *GetDocumentAna type GetDocumentAnalysisInput struct { // A unique identifier for the text-detection job. The JobId is returned from - // StartDocumentAnalysis. A JobId value is only valid for 7 days. + // StartDocumentAnalysis . A JobId value is only valid for 7 days. // // This member is required. JobId *string @@ -104,8 +96,8 @@ type GetDocumentAnalysisOutput struct { // The results of the text-analysis operation. Blocks []types.Block - // Information about a document that Amazon Textract processed. DocumentMetadata is - // returned in every page of paginated responses from an Amazon Textract video + // Information about a document that Amazon Textract processed. DocumentMetadata + // is returned in every page of paginated responses from an Amazon Textract video // operation. DocumentMetadata *types.DocumentMetadata diff --git a/service/textract/api_op_GetDocumentTextDetection.go b/service/textract/api_op_GetDocumentTextDetection.go index e2f422c94bc..a6bb59b136b 100644 --- a/service/textract/api_op_GetDocumentTextDetection.go +++ b/service/textract/api_op_GetDocumentTextDetection.go @@ -11,28 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the results for an Amazon Textract asynchronous operation that detects text -// in a document. Amazon Textract can detect lines of text and the words that make -// up a line of text. You start asynchronous text detection by calling -// StartDocumentTextDetection, which returns a job identifier (JobId). When the +// Gets the results for an Amazon Textract asynchronous operation that detects +// text in a document. Amazon Textract can detect lines of text and the words that +// make up a line of text. You start asynchronous text detection by calling +// StartDocumentTextDetection , which returns a job identifier ( JobId ). When the // text detection operation finishes, Amazon Textract publishes a completion status // to the Amazon Simple Notification Service (Amazon SNS) topic that's registered -// in the initial call to StartDocumentTextDetection. To get the results of the +// in the initial call to StartDocumentTextDetection . To get the results of the // text-detection operation, first check that the status value published to the -// Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass -// the job identifier (JobId) from the initial call to StartDocumentTextDetection. -// GetDocumentTextDetection returns an array of Block objects. Each document page -// has as an associated Block of type PAGE. Each PAGE Block object is the parent of -// LINE Block objects that represent the lines of detected text on a page. A LINE -// Block object is a parent for each word that makes up the line. Words are -// represented by Block objects of type WORD. Use the MaxResults parameter to limit -// the number of blocks that are returned. If there are more results than specified -// in MaxResults, the value of NextToken in the operation response contains a -// pagination token for getting the next set of results. To get the next page of -// results, call GetDocumentTextDetection, and populate the NextToken request -// parameter with the token value that's returned from the previous call to -// GetDocumentTextDetection. For more information, see Document Text Detection -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). +// Amazon SNS topic is SUCCEEDED . If so, call GetDocumentTextDetection , and pass +// the job identifier ( JobId ) from the initial call to StartDocumentTextDetection +// . GetDocumentTextDetection returns an array of Block objects. Each document +// page has as an associated Block of type PAGE. Each PAGE Block object is the +// parent of LINE Block objects that represent the lines of detected text on a +// page. A LINE Block object is a parent for each word that makes up the line. +// Words are represented by Block objects of type WORD. Use the MaxResults +// parameter to limit the number of blocks that are returned. If there are more +// results than specified in MaxResults , the value of NextToken in the operation +// response contains a pagination token for getting the next set of results. To get +// the next page of results, call GetDocumentTextDetection , and populate the +// NextToken request parameter with the token value that's returned from the +// previous call to GetDocumentTextDetection . For more information, see Document +// Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html) +// . func (c *Client) GetDocumentTextDetection(ctx context.Context, params *GetDocumentTextDetectionInput, optFns ...func(*Options)) (*GetDocumentTextDetectionOutput, error) { if params == nil { params = &GetDocumentTextDetectionInput{} @@ -51,7 +52,7 @@ func (c *Client) GetDocumentTextDetection(ctx context.Context, params *GetDocume type GetDocumentTextDetectionInput struct { // A unique identifier for the text detection job. The JobId is returned from - // StartDocumentTextDetection. A JobId value is only valid for 7 days. + // StartDocumentTextDetection . A JobId value is only valid for 7 days. // // This member is required. JobId *string @@ -77,8 +78,8 @@ type GetDocumentTextDetectionOutput struct { // DetectDocumentTextModelVersion *string - // Information about a document that Amazon Textract processed. DocumentMetadata is - // returned in every page of paginated responses from an Amazon Textract video + // Information about a document that Amazon Textract processed. DocumentMetadata + // is returned in every page of paginated responses from an Amazon Textract video // operation. DocumentMetadata *types.DocumentMetadata diff --git a/service/textract/api_op_GetExpenseAnalysis.go b/service/textract/api_op_GetExpenseAnalysis.go index 00f88b6cd3f..49f8eed7e39 100644 --- a/service/textract/api_op_GetExpenseAnalysis.go +++ b/service/textract/api_op_GetExpenseAnalysis.go @@ -14,22 +14,22 @@ import ( // Gets the results for an Amazon Textract asynchronous operation that analyzes // invoices and receipts. Amazon Textract finds contact information, items // purchased, and vendor name, from input invoices and receipts. You start -// asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which -// returns a job identifier (JobId). Upon completion of the invoice/receipt +// asynchronous invoice/receipt analysis by calling StartExpenseAnalysis , which +// returns a job identifier ( JobId ). Upon completion of the invoice/receipt // analysis, Amazon Textract publishes the completion status to the Amazon Simple // Notification Service (Amazon SNS) topic. This topic must be registered in the -// initial call to StartExpenseAnalysis. To get the results of the invoice/receipt +// initial call to StartExpenseAnalysis . To get the results of the invoice/receipt // analysis operation, first ensure that the status value published to the Amazon -// SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job -// identifier (JobId) from the initial call to StartExpenseAnalysis. Use the +// SNS topic is SUCCEEDED . If so, call GetExpenseAnalysis , and pass the job +// identifier ( JobId ) from the initial call to StartExpenseAnalysis . Use the // MaxResults parameter to limit the number of blocks that are returned. If there -// are more results than specified in MaxResults, the value of NextToken in the +// are more results than specified in MaxResults , the value of NextToken in the // operation response contains a pagination token for getting the next set of -// results. To get the next page of results, call GetExpenseAnalysis, and populate +// results. To get the next page of results, call GetExpenseAnalysis , and populate // the NextToken request parameter with the token value that's returned from the -// previous call to GetExpenseAnalysis. For more information, see Analyzing -// Invoices and Receipts -// (https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html). +// previous call to GetExpenseAnalysis . For more information, see Analyzing +// Invoices and Receipts (https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html) +// . func (c *Client) GetExpenseAnalysis(ctx context.Context, params *GetExpenseAnalysisInput, optFns ...func(*Options)) (*GetExpenseAnalysisOutput, error) { if params == nil { params = &GetExpenseAnalysisInput{} @@ -48,7 +48,7 @@ func (c *Client) GetExpenseAnalysis(ctx context.Context, params *GetExpenseAnaly type GetExpenseAnalysisInput struct { // A unique identifier for the text detection job. The JobId is returned from - // StartExpenseAnalysis. A JobId value is only valid for 7 days. + // StartExpenseAnalysis . A JobId value is only valid for 7 days. // // This member is required. JobId *string @@ -71,8 +71,9 @@ type GetExpenseAnalysisOutput struct { // The current model version of AnalyzeExpense. AnalyzeExpenseModelVersion *string - // Information about a document that Amazon Textract processed. DocumentMetadata is - // returned in every page of paginated responses from an Amazon Textract operation. + // Information about a document that Amazon Textract processed. DocumentMetadata + // is returned in every page of paginated responses from an Amazon Textract + // operation. DocumentMetadata *types.DocumentMetadata // The expenses detected by Amazon Textract. diff --git a/service/textract/api_op_GetLendingAnalysis.go b/service/textract/api_op_GetLendingAnalysis.go index 30a035b2af9..8bad26f5cfd 100644 --- a/service/textract/api_op_GetLendingAnalysis.go +++ b/service/textract/api_op_GetLendingAnalysis.go @@ -13,13 +13,13 @@ import ( // Gets the results for an Amazon Textract asynchronous operation that analyzes // text in a lending document. You start asynchronous text analysis by calling -// StartLendingAnalysis, which returns a job identifier (JobId). When the text +// StartLendingAnalysis , which returns a job identifier ( JobId ). When the text // analysis operation finishes, Amazon Textract publishes a completion status to // the Amazon Simple Notification Service (Amazon SNS) topic that's registered in -// the initial call to StartLendingAnalysis. To get the results of the text +// the initial call to StartLendingAnalysis . To get the results of the text // analysis operation, first check that the status value published to the Amazon // SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job -// identifier (JobId) from the initial call to StartLendingAnalysis. +// identifier ( JobId ) from the initial call to StartLendingAnalysis . func (c *Client) GetLendingAnalysis(ctx context.Context, params *GetLendingAnalysisInput, optFns ...func(*Options)) (*GetLendingAnalysisOutput, error) { if params == nil { params = &GetLendingAnalysisInput{} @@ -37,8 +37,8 @@ func (c *Client) GetLendingAnalysis(ctx context.Context, params *GetLendingAnaly type GetLendingAnalysisInput struct { - // A unique identifier for the lending or text-detection job. The JobId is returned - // from StartLendingAnalysis. A JobId value is only valid for 7 days. + // A unique identifier for the lending or text-detection job. The JobId is + // returned from StartLendingAnalysis . A JobId value is only valid for 7 days. // // This member is required. JobId *string @@ -76,8 +76,8 @@ type GetLendingAnalysisOutput struct { // operations for the pinstripe. Results []types.LendingResult - // Returns if the lending analysis job could not be completed. Contains explanation - // for what error occurred. + // Returns if the lending analysis job could not be completed. Contains + // explanation for what error occurred. StatusMessage *string // A list of warnings that occurred during the lending analysis operation. diff --git a/service/textract/api_op_GetLendingAnalysisSummary.go b/service/textract/api_op_GetLendingAnalysisSummary.go index e4159725eec..dd7e37c619f 100644 --- a/service/textract/api_op_GetLendingAnalysisSummary.go +++ b/service/textract/api_op_GetLendingAnalysisSummary.go @@ -16,13 +16,13 @@ import ( // documents grouped together by a common document type. Information like detected // signatures, page numbers, and split documents is returned with respect to the // type of grouped document. You start asynchronous text analysis by calling -// StartLendingAnalysis, which returns a job identifier (JobId). When the text +// StartLendingAnalysis , which returns a job identifier ( JobId ). When the text // analysis operation finishes, Amazon Textract publishes a completion status to // the Amazon Simple Notification Service (Amazon SNS) topic that's registered in -// the initial call to StartLendingAnalysis. To get the results of the text +// the initial call to StartLendingAnalysis . To get the results of the text // analysis operation, first check that the status value published to the Amazon -// SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job -// identifier (JobId) from the initial call to StartLendingAnalysis. +// SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary , and pass the job +// identifier ( JobId ) from the initial call to StartLendingAnalysis . func (c *Client) GetLendingAnalysisSummary(ctx context.Context, params *GetLendingAnalysisSummaryInput, optFns ...func(*Options)) (*GetLendingAnalysisSummaryOutput, error) { if params == nil { params = &GetLendingAnalysisSummaryInput{} @@ -40,8 +40,8 @@ func (c *Client) GetLendingAnalysisSummary(ctx context.Context, params *GetLendi type GetLendingAnalysisSummaryInput struct { - // A unique identifier for the lending or text-detection job. The JobId is returned - // from StartLendingAnalysis. A JobId value is only valid for 7 days. + // A unique identifier for the lending or text-detection job. The JobId is + // returned from StartLendingAnalysis. A JobId value is only valid for 7 days. // // This member is required. JobId *string @@ -60,8 +60,8 @@ type GetLendingAnalysisSummaryOutput struct { // The current status of the lending analysis job. JobStatus types.JobStatus - // Returns if the lending analysis could not be completed. Contains explanation for - // what error occurred. + // Returns if the lending analysis could not be completed. Contains explanation + // for what error occurred. StatusMessage *string // Contains summary information for documents grouped by type. diff --git a/service/textract/api_op_StartDocumentAnalysis.go b/service/textract/api_op_StartDocumentAnalysis.go index eb56ca6acc1..fc5c2a598af 100644 --- a/service/textract/api_op_StartDocumentAnalysis.go +++ b/service/textract/api_op_StartDocumentAnalysis.go @@ -16,15 +16,15 @@ import ( // StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, // and PDF format. The documents are stored in an Amazon S3 bucket. Use // DocumentLocation to specify the bucket name and file name of the document. -// StartDocumentAnalysis returns a job identifier (JobId) that you use to get the +// StartDocumentAnalysis returns a job identifier ( JobId ) that you use to get the // results of the operation. When text analysis is finished, Amazon Textract // publishes a completion status to the Amazon Simple Notification Service (Amazon -// SNS) topic that you specify in NotificationChannel. To get the results of the +// SNS) topic that you specify in NotificationChannel . To get the results of the // text analysis operation, first check that the status value published to the -// Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job -// identifier (JobId) from the initial call to StartDocumentAnalysis. For more -// information, see Document Text Analysis -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). +// Amazon SNS topic is SUCCEEDED . If so, call GetDocumentAnalysis , and pass the +// job identifier ( JobId ) from the initial call to StartDocumentAnalysis . For +// more information, see Document Text Analysis (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html) +// . func (c *Client) StartDocumentAnalysis(ctx context.Context, params *StartDocumentAnalysisInput, optFns ...func(*Options)) (*StartDocumentAnalysisOutput, error) { if params == nil { params = &StartDocumentAnalysisInput{} @@ -50,19 +50,19 @@ type StartDocumentAnalysisInput struct { // A list of the types of analysis to perform. Add TABLES to the list to return // information about the tables that are detected in the input document. Add FORMS // to return detected form data. To perform both types of analysis, add TABLES and - // FORMS to FeatureTypes. All lines and words detected in the document are included - // in the response (including text that isn't related to the value of - // FeatureTypes). + // FORMS to FeatureTypes . All lines and words detected in the document are + // included in the response (including text that isn't related to the value of + // FeatureTypes ). // // This member is required. FeatureTypes []types.FeatureType // The idempotent token that you use to identify the start request. If you use the // same token with multiple StartDocumentAnalysis requests, the same JobId is - // returned. Use ClientRequestToken to prevent the same job from being accidentally - // started more than once. For more information, see Calling Amazon Textract - // Asynchronous Operations - // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). + // returned. Use ClientRequestToken to prevent the same job from being + // accidentally started more than once. For more information, see Calling Amazon + // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html) + // . ClientRequestToken *string // An identifier that you specify that's included in the completion notification @@ -77,8 +77,8 @@ type StartDocumentAnalysisInput struct { // parameter is not enabled, the result will be encrypted server side,using SSE-S3. KMSKeyId *string - // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion - // status of the operation to. + // The Amazon SNS topic ARN that you want Amazon Textract to publish the + // completion status of the operation to. NotificationChannel *types.NotificationChannel // Sets if the output will go to a customer defined bucket. By default, Amazon @@ -95,8 +95,8 @@ type StartDocumentAnalysisInput struct { type StartDocumentAnalysisOutput struct { // The identifier for the document text detection job. Use JobId to identify the - // job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for - // 7 days. + // job in a subsequent call to GetDocumentAnalysis . A JobId value is only valid + // for 7 days. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/textract/api_op_StartDocumentTextDetection.go b/service/textract/api_op_StartDocumentTextDetection.go index 96881b5a0a4..d174517b433 100644 --- a/service/textract/api_op_StartDocumentTextDetection.go +++ b/service/textract/api_op_StartDocumentTextDetection.go @@ -16,15 +16,15 @@ import ( // StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, // TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use // DocumentLocation to specify the bucket name and file name of the document. -// StartTextDetection returns a job identifier (JobId) that you use to get the +// StartTextDetection returns a job identifier ( JobId ) that you use to get the // results of the operation. When text detection is finished, Amazon Textract // publishes a completion status to the Amazon Simple Notification Service (Amazon -// SNS) topic that you specify in NotificationChannel. To get the results of the +// SNS) topic that you specify in NotificationChannel . To get the results of the // text detection operation, first check that the status value published to the -// Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass -// the job identifier (JobId) from the initial call to StartDocumentTextDetection. -// For more information, see Document Text Detection -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). +// Amazon SNS topic is SUCCEEDED . If so, call GetDocumentTextDetection , and pass +// the job identifier ( JobId ) from the initial call to StartDocumentTextDetection +// . For more information, see Document Text Detection (https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html) +// . func (c *Client) StartDocumentTextDetection(ctx context.Context, params *StartDocumentTextDetectionInput, optFns ...func(*Options)) (*StartDocumentTextDetectionOutput, error) { if params == nil { params = &StartDocumentTextDetectionInput{} @@ -49,10 +49,10 @@ type StartDocumentTextDetectionInput struct { // The idempotent token that's used to identify the start request. If you use the // same token with multiple StartDocumentTextDetection requests, the same JobId is - // returned. Use ClientRequestToken to prevent the same job from being accidentally - // started more than once. For more information, see Calling Amazon Textract - // Asynchronous Operations - // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html). + // returned. Use ClientRequestToken to prevent the same job from being + // accidentally started more than once. For more information, see Calling Amazon + // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html) + // . ClientRequestToken *string // An identifier that you specify that's included in the completion notification @@ -67,8 +67,8 @@ type StartDocumentTextDetectionInput struct { // parameter is not enabled, the result will be encrypted server side,using SSE-S3. KMSKeyId *string - // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion - // status of the operation to. + // The Amazon SNS topic ARN that you want Amazon Textract to publish the + // completion status of the operation to. NotificationChannel *types.NotificationChannel // Sets if the output will go to a customer defined bucket. By default Amazon @@ -81,9 +81,9 @@ type StartDocumentTextDetectionInput struct { type StartDocumentTextDetectionOutput struct { - // The identifier of the text detection job for the document. Use JobId to identify - // the job in a subsequent call to GetDocumentTextDetection. A JobId value is only - // valid for 7 days. + // The identifier of the text detection job for the document. Use JobId to + // identify the job in a subsequent call to GetDocumentTextDetection . A JobId + // value is only valid for 7 days. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/textract/api_op_StartExpenseAnalysis.go b/service/textract/api_op_StartExpenseAnalysis.go index 9b1c8c06a7e..60845520953 100644 --- a/service/textract/api_op_StartExpenseAnalysis.go +++ b/service/textract/api_op_StartExpenseAnalysis.go @@ -12,20 +12,20 @@ import ( ) // Starts the asynchronous analysis of invoices or receipts for data like contact -// information, items purchased, and vendor names. StartExpenseAnalysis can analyze -// text in documents that are in JPEG, PNG, and PDF format. The documents must be -// stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the -// name of your S3 bucket and the name of the document in that bucket. -// StartExpenseAnalysis returns a job identifier (JobId) that you will provide to +// information, items purchased, and vendor names. StartExpenseAnalysis can +// analyze text in documents that are in JPEG, PNG, and PDF format. The documents +// must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to +// specify the name of your S3 bucket and the name of the document in that bucket. +// StartExpenseAnalysis returns a job identifier ( JobId ) that you will provide to // GetExpenseAnalysis to retrieve the results of the operation. When the analysis // of the input invoices/receipts is finished, Amazon Textract publishes a // completion status to the Amazon Simple Notification Service (Amazon SNS) topic -// that you provide to the NotificationChannel. To obtain the results of the +// that you provide to the NotificationChannel . To obtain the results of the // invoice and receipt analysis operation, ensure that the status value published -// to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass -// the job identifier (JobId) that was returned by your call to -// StartExpenseAnalysis. For more information, see Analyzing Invoices and Receipts -// (https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html). +// to the Amazon SNS topic is SUCCEEDED . If so, call GetExpenseAnalysis , and pass +// the job identifier ( JobId ) that was returned by your call to +// StartExpenseAnalysis . For more information, see Analyzing Invoices and Receipts (https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html) +// . func (c *Client) StartExpenseAnalysis(ctx context.Context, params *StartExpenseAnalysisInput, optFns ...func(*Options)) (*StartExpenseAnalysisOutput, error) { if params == nil { params = &StartExpenseAnalysisInput{} @@ -50,10 +50,9 @@ type StartExpenseAnalysisInput struct { // The idempotent token that's used to identify the start request. If you use the // same token with multiple StartDocumentTextDetection requests, the same JobId is - // returned. Use ClientRequestToken to prevent the same job from being accidentally - // started more than once. For more information, see Calling Amazon Textract - // Asynchronous Operations - // (https://docs.aws.amazon.com/textract/latest/dg/api-async.html) + // returned. Use ClientRequestToken to prevent the same job from being + // accidentally started more than once. For more information, see Calling Amazon + // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-async.html) ClientRequestToken *string // An identifier you specify that's included in the completion notification @@ -68,8 +67,8 @@ type StartExpenseAnalysisInput struct { // parameter is not enabled, the result will be encrypted server side,using SSE-S3. KMSKeyId *string - // The Amazon SNS topic ARN that you want Amazon Textract to publish the completion - // status of the operation to. + // The Amazon SNS topic ARN that you want Amazon Textract to publish the + // completion status of the operation to. NotificationChannel *types.NotificationChannel // Sets if the output will go to a customer defined bucket. By default, Amazon @@ -83,7 +82,7 @@ type StartExpenseAnalysisInput struct { type StartExpenseAnalysisOutput struct { // A unique identifier for the text detection job. The JobId is returned from - // StartExpenseAnalysis. A JobId value is only valid for 7 days. + // StartExpenseAnalysis . A JobId value is only valid for 7 days. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/textract/api_op_StartLendingAnalysis.go b/service/textract/api_op_StartLendingAnalysis.go index 355708351b3..13184ec5a15 100644 --- a/service/textract/api_op_StartLendingAnalysis.go +++ b/service/textract/api_op_StartLendingAnalysis.go @@ -14,28 +14,22 @@ import ( // Starts the classification and analysis of an input document. // StartLendingAnalysis initiates the classification and analysis of a packet of // lending documents. StartLendingAnalysis operates on a document file located in -// an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that are -// in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to -// specify the bucket name and the file name of the document. StartLendingAnalysis -// returns a job identifier (JobId) that you use to get the results of the -// operation. When the text analysis is finished, Amazon Textract publishes a -// completion status to the Amazon Simple Notification Service (Amazon SNS) topic -// that you specify in NotificationChannel. To get the results of the text analysis -// operation, first check that the status value published to the Amazon SNS topic -// is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis -// or GetLendingAnalysisSummary and provide the JobId to obtain the results of the -// analysis. If using OutputConfig to specify an Amazon S3 bucket, the output will -// be contained within the specified prefix in a directory labeled with the job-id. -// In the directory there are 3 sub-directories: -// -// * detailedResponse (contains the -// GetLendingAnalysis response) -// -// * summaryResponse (for the -// GetLendingAnalysisSummary response) -// -// * splitDocuments (documents split across -// logical boundaries) +// an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that +// are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation +// to specify the bucket name and the file name of the document. +// StartLendingAnalysis returns a job identifier ( JobId ) that you use to get the +// results of the operation. When the text analysis is finished, Amazon Textract +// publishes a completion status to the Amazon Simple Notification Service (Amazon +// SNS) topic that you specify in NotificationChannel . To get the results of the +// text analysis operation, first check that the status value published to the +// Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either +// GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain +// the results of the analysis. If using OutputConfig to specify an Amazon S3 +// bucket, the output will be contained within the specified prefix in a directory +// labeled with the job-id. In the directory there are 3 sub-directories: +// - detailedResponse (contains the GetLendingAnalysis response) +// - summaryResponse (for the GetLendingAnalysisSummary response) +// - splitDocuments (documents split across logical boundaries) func (c *Client) StartLendingAnalysis(ctx context.Context, params *StartLendingAnalysisInput, optFns ...func(*Options)) (*StartLendingAnalysisOutput, error) { if params == nil { params = &StartLendingAnalysisInput{} @@ -62,10 +56,10 @@ type StartLendingAnalysisInput struct { // The idempotent token that you use to identify the start request. If you use the // same token with multiple StartLendingAnalysis requests, the same JobId is - // returned. Use ClientRequestToken to prevent the same job from being accidentally - // started more than once. For more information, see Calling Amazon Textract - // Asynchronous Operations - // (https://docs.aws.amazon.com/textract/latest/dg/api-sync.html). + // returned. Use ClientRequestToken to prevent the same job from being + // accidentally started more than once. For more information, see Calling Amazon + // Textract Asynchronous Operations (https://docs.aws.amazon.com/textract/latest/dg/api-sync.html) + // . ClientRequestToken *string // An identifier that you specify to be included in the completion notification @@ -99,10 +93,9 @@ type StartLendingAnalysisInput struct { // opt out policy then all unencrypted Customer Content is immediately and // permanently deleted after the Customer Content has been processed by the // service. No copy of of the output is retained by Amazon Textract. For - // information about how to opt out, see Managing AI services opt-out policy. - // (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) - // For more information on data privacy, see the Data Privacy FAQ - // (https://aws.amazon.com/compliance/data-privacy-faq/). + // information about how to opt out, see Managing AI services opt-out policy. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) + // For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/) + // . OutputConfig *types.OutputConfig noSmithyDocumentSerde @@ -110,8 +103,8 @@ type StartLendingAnalysisInput struct { type StartLendingAnalysisOutput struct { - // A unique identifier for the lending or text-detection job. The JobId is returned - // from StartLendingAnalysis. A JobId value is only valid for 7 days. + // A unique identifier for the lending or text-detection job. The JobId is + // returned from StartLendingAnalysis . A JobId value is only valid for 7 days. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/textract/types/enums.go b/service/textract/types/enums.go index 5b9806e1585..b5e1a38c84a 100644 --- a/service/textract/types/enums.go +++ b/service/textract/types/enums.go @@ -22,9 +22,9 @@ const ( BlockTypeTableFooter BlockType = "TABLE_FOOTER" ) -// Values returns all known values for BlockType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for BlockType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (BlockType) Values() []BlockType { return []BlockType{ "KEY_VALUE_SET", @@ -126,9 +126,9 @@ const ( JobStatusPartialSuccess JobStatus = "PARTIAL_SUCCESS" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "IN_PROGRESS", @@ -213,9 +213,9 @@ const ( ValueTypeDate ValueType = "DATE" ) -// Values returns all known values for ValueType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ValueType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ValueType) Values() []ValueType { return []ValueType{ "DATE", diff --git a/service/textract/types/errors.go b/service/textract/types/errors.go index efb39ef72fb..b0a5ad99381 100644 --- a/service/textract/types/errors.go +++ b/service/textract/types/errors.go @@ -37,7 +37,7 @@ func (e *AccessDeniedException) ErrorCode() string { func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Amazon Textract isn't able to read the document. For more information on the -// document limits in Amazon Textract, see limits. +// document limits in Amazon Textract, see limits . type BadDocumentException struct { Message *string @@ -276,10 +276,8 @@ func (e *InvalidParameterException) ErrorCode() string { func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Amazon Textract is unable to access the S3 object that's specified in the -// request. for more information, Configure Access to Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For -// troubleshooting information, see Troubleshooting Amazon S3 -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) +// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) +// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) type InvalidS3ObjectException struct { Message *string @@ -308,8 +306,8 @@ func (e *InvalidS3ObjectException) ErrorCode() string { func (e *InvalidS3ObjectException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An Amazon Textract service limit was exceeded. For example, if you start too -// many asynchronous jobs concurrently, calls to start operations -// (StartDocumentTextDetection, for example) raise a LimitExceededException +// many asynchronous jobs concurrently, calls to start operations ( +// StartDocumentTextDetection , for example) raise a LimitExceededException // exception (HTTP status code: 400) until the number of concurrently running jobs // is below the Amazon Textract service limit. type LimitExceededException struct { diff --git a/service/textract/types/types.go b/service/textract/types/types.go index 83e2aac09a7..c53b103df0c 100644 --- a/service/textract/types/types.go +++ b/service/textract/types/types.go @@ -17,8 +17,8 @@ type AnalyzeIDDetections struct { // The confidence score of the detected text. Confidence *float32 - // Only returned for dates, returns the type of value detected and the date written - // in a more machine readable way. + // Only returned for dates, returns the type of value detected and the date + // written in a more machine readable way. NormalizedValue *NormalizedValue noSmithyDocumentSerde @@ -27,91 +27,65 @@ type AnalyzeIDDetections struct { // A Block represents items that are recognized in a document within a group of // pixels close to each other. The information returned in a Block object depends // on the type of operation. In text detection for documents (for example -// DetectDocumentText), you get information about the detected words and lines of -// text. In text analysis (for example AnalyzeDocument), you can also get +// DetectDocumentText ), you get information about the detected words and lines of +// text. In text analysis (for example AnalyzeDocument ), you can also get // information about the fields, tables, and selection elements that are detected // in the document. An array of Block objects is returned by both synchronous and -// asynchronous operations. In synchronous operations, such as DetectDocumentText, +// asynchronous operations. In synchronous operations, such as DetectDocumentText , // the array of Block objects is the entire set of results. In asynchronous -// operations, such as GetDocumentAnalysis, the array is returned over one or more -// responses. For more information, see How Amazon Textract Works -// (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html). +// operations, such as GetDocumentAnalysis , the array is returned over one or more +// responses. For more information, see How Amazon Textract Works (https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html) +// . type Block struct { // The type of text item that's recognized. In operations for text detection, the // following types are returned: - // - // * PAGE - Contains a list of the LINE Block - // objects that are detected on a document page. - // - // * WORD - A word detected on a - // document page. A word is one or more ISO basic Latin script characters that - // aren't separated by spaces. - // - // * LINE - A string of tab-delimited, contiguous - // words that are detected on a document page. - // - // In text analysis operations, the - // following types are returned: - // - // * PAGE - Contains a list of child Block objects - // that are detected on a document page. - // - // * KEY_VALUE_SET - Stores the KEY and - // VALUE Block objects for linked text that's detected on a document page. Use the - // EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or - // a VALUE Block object. - // - // * WORD - A word that's detected on a document page. A - // word is one or more ISO basic Latin script characters that aren't separated by - // spaces. - // - // * LINE - A string of tab-delimited, contiguous words that are detected - // on a document page. - // - // * TABLE - A table that's detected on a document page. A - // table is grid-based information with two or more rows or columns, with a cell - // span of one row and one column each. - // - // * TABLE_TITLE - The title of a table. A - // title is typically a line of text above or below a table, or embedded as the - // first row of a table. - // - // * TABLE_FOOTER - The footer associated with a table. A - // footer is typically a line or lines of text below a table or embedded as the - // last row of a table. - // - // * CELL - A cell within a detected table. The cell is the - // parent of the block that contains the text in the cell. - // - // * MERGED_CELL - A cell - // in a table whose content spans more than one row or column. The Relationships - // array for this cell contain data from individual cells. - // - // * SELECTION_ELEMENT - A - // selection element such as an option button (radio button) or a check box that's - // detected on a document page. Use the value of SelectionStatus to determine the - // status of the selection element. - // - // * SIGNATURE - The location and confidene score - // of a signature detected on a document page. Can be returned as part of a - // Key-Value pair or a detected cell. - // - // * QUERY - A question asked during the call - // of AnalyzeDocument. Contains an alias and an ID that attaches it to its - // answer. - // - // * QUERY_RESULT - A response to a question asked during the call of - // analyze document. Comes with an alias and ID for ease of locating in a response. - // Also contains location and confidence score. + // - PAGE - Contains a list of the LINE Block objects that are detected on a + // document page. + // - WORD - A word detected on a document page. A word is one or more ISO basic + // Latin script characters that aren't separated by spaces. + // - LINE - A string of tab-delimited, contiguous words that are detected on a + // document page. + // In text analysis operations, the following types are returned: + // - PAGE - Contains a list of child Block objects that are detected on a + // document page. + // - KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text + // that's detected on a document page. Use the EntityType field to determine if a + // KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. + // - WORD - A word that's detected on a document page. A word is one or more ISO + // basic Latin script characters that aren't separated by spaces. + // - LINE - A string of tab-delimited, contiguous words that are detected on a + // document page. + // - TABLE - A table that's detected on a document page. A table is grid-based + // information with two or more rows or columns, with a cell span of one row and + // one column each. + // - TABLE_TITLE - The title of a table. A title is typically a line of text + // above or below a table, or embedded as the first row of a table. + // - TABLE_FOOTER - The footer associated with a table. A footer is typically a + // line or lines of text below a table or embedded as the last row of a table. + // - CELL - A cell within a detected table. The cell is the parent of the block + // that contains the text in the cell. + // - MERGED_CELL - A cell in a table whose content spans more than one row or + // column. The Relationships array for this cell contain data from individual + // cells. + // - SELECTION_ELEMENT - A selection element such as an option button (radio + // button) or a check box that's detected on a document page. Use the value of + // SelectionStatus to determine the status of the selection element. + // - SIGNATURE - The location and confidene score of a signature detected on a + // document page. Can be returned as part of a Key-Value pair or a detected cell. + // - QUERY - A question asked during the call of AnalyzeDocument. Contains an + // alias and an ID that attaches it to its answer. + // - QUERY_RESULT - A response to a question asked during the call of analyze + // document. Comes with an alias and ID for ease of locating in a response. Also + // contains location and confidence score. BlockType BlockType // The column in which a table cell appears. The first column position is 1. - // ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection. + // ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection . ColumnIndex *int32 // The number of columns that a table cell spans. ColumnSpan isn't returned by - // DetectDocumentText and GetDocumentTextDetection. + // DetectDocumentText and GetDocumentTextDetection . ColumnSpan *int32 // The confidence score that Amazon Textract has in the accuracy of the recognized @@ -120,40 +94,22 @@ type Block struct { // The type of entity. The following entity types can be returned by FORMS // analysis: - // - // * KEY - An identifier for a field on the document. - // - // * VALUE - The - // field text. - // + // - KEY - An identifier for a field on the document. + // - VALUE - The field text. // The following entity types can be returned by TABLES analysis: - // - // * - // COLUMN_HEADER - Identifies a cell that is a header of a column. - // - // * TABLE_TITLE - - // Identifies a cell that is a title within the table. - // - // * TABLE_SECTION_TITLE - - // Identifies a cell that is a title of a section within a table. A section title - // is a cell that typically spans an entire row above a section. - // - // * TABLE_FOOTER - - // Identifies a cell that is a footer of a table. - // - // * TABLE_SUMMARY - Identifies a - // summary cell of a table. A summary cell can be a row of a table or an - // additional, smaller table that contains summary information for another - // table. - // - // * STRUCTURED_TABLE - Identifies a table with column headers where the - // content of each row corresponds to the headers. - // - // * SEMI_STRUCTURED_TABLE - - // Identifies a non-structured table. - // - // EntityTypes isn't returned by - // DetectDocumentText and GetDocumentTextDetection. + // - COLUMN_HEADER - Identifies a cell that is a header of a column. + // - TABLE_TITLE - Identifies a cell that is a title within the table. + // - TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within + // a table. A section title is a cell that typically spans an entire row above a + // section. + // - TABLE_FOOTER - Identifies a cell that is a footer of a table. + // - TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be + // a row of a table or an additional, smaller table that contains summary + // information for another table. + // - STRUCTURED_TABLE - Identifies a table with column headers where the content + // of each row corresponds to the headers. + // - SEMI_STRUCTURED_TABLE - Identifies a non-structured table. + // EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection . EntityTypes []EntityType // The location of the recognized text on the image. It includes an axis-aligned, @@ -186,11 +142,11 @@ type Block struct { Relationships []Relationship // The row in which a table cell is located. The first row position is 1. RowIndex - // isn't returned by DetectDocumentText and GetDocumentTextDetection. + // isn't returned by DetectDocumentText and GetDocumentTextDetection . RowIndex *int32 // The number of rows that a table cell spans. RowSpan isn't returned by - // DetectDocumentText and GetDocumentTextDetection. + // DetectDocumentText and GetDocumentTextDetection . RowSpan *int32 // The selection status of a selection element, such as an option button or check @@ -248,18 +204,18 @@ type DetectedSignature struct { // The input document, either as bytes or as an S3 object. You pass image bytes to // an Amazon Textract API operation by using the Bytes property. For example, you -// would use the Bytes property to pass a document loaded from a local file system. -// Image bytes passed by using the Bytes property must be base64 encoded. Your code -// might not need to encode document file bytes if you're using an AWS SDK to call -// Amazon Textract API operations. You pass images stored in an S3 bucket to an -// Amazon Textract API operation by using the S3Object property. Documents stored -// in an S3 bucket don't need to be base64 encoded. The AWS Region for the S3 -// bucket that contains the S3 object must match the AWS Region that you use for -// Amazon Textract operations. If you use the AWS CLI to call Amazon Textract -// operations, passing image bytes using the Bytes property isn't supported. You -// must first upload the document to an Amazon S3 bucket, and then call the -// operation using the S3Object property. For Amazon Textract to process an S3 -// object, the user must have permission to access the S3 object. +// would use the Bytes property to pass a document loaded from a local file +// system. Image bytes passed by using the Bytes property must be base64 encoded. +// Your code might not need to encode document file bytes if you're using an AWS +// SDK to call Amazon Textract API operations. You pass images stored in an S3 +// bucket to an Amazon Textract API operation by using the S3Object property. +// Documents stored in an S3 bucket don't need to be base64 encoded. The AWS Region +// for the S3 bucket that contains the S3 object must match the AWS Region that you +// use for Amazon Textract operations. If you use the AWS CLI to call Amazon +// Textract operations, passing image bytes using the Bytes property isn't +// supported. You must first upload the document to an Amazon S3 bucket, and then +// call the operation using the S3Object property. For Amazon Textract to process +// an S3 object, the user must have permission to access the S3 object. type Document struct { // A blob of base64-encoded document bytes. The maximum size of a document that's @@ -286,8 +242,7 @@ type DocumentGroup struct { SplitDocuments []SplitDocument // The type of document that Amazon Textract has detected. See Analyze Lending - // Response Objects - // (https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html) + // Response Objects (https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html) // for a list of all types returned by Textract. Type *string @@ -321,31 +276,18 @@ type DocumentMetadata struct { type ExpenseCurrency struct { // Currency code for detected currency. the current supported codes are: - // - // * USD - // - // * - // EUR - // - // * GBP - // - // * CAD - // - // * INR - // - // * JPY - // - // * CHF - // - // * AUD - // - // * CNY - // - // * BZR - // - // * SEK - // - // * HKD + // - USD + // - EUR + // - GBP + // - CAD + // - INR + // - JPY + // - CHF + // - AUD + // - CNY + // - BZR + // - SEK + // - HKD Code *string // Percentage confideence in the detected currency. @@ -375,15 +317,15 @@ type ExpenseDetection struct { // The structure holding all the information returned by AnalyzeExpense type ExpenseDocument struct { - // This is a block object, the same as reported when DetectDocumentText is run on a - // document. It provides word level recognition of text. + // This is a block object, the same as reported when DetectDocumentText is run on + // a document. It provides word level recognition of text. Blocks []Block - // Denotes which invoice or receipt in the document the information is coming from. - // First document will be 1, the second 2, and so on. + // Denotes which invoice or receipt in the document the information is coming + // from. First document will be 1, the second 2, and so on. ExpenseIndex *int32 - // Information detected on each table of a document, seperated into LineItems. + // Information detected on each table of a document, seperated into LineItems . LineItemGroups []LineItemGroup // Any information found outside of a table by Amazon Textract. @@ -647,7 +589,7 @@ type LineItemFields struct { } // A grouping of tables which contain LineItems, with each table identified by the -// table's LineItemGroupIndex. +// table's LineItemGroupIndex . type LineItemGroup struct { // The number used to identify a specific table in a document. The first table @@ -705,10 +647,9 @@ type NotificationChannel struct { // opt out policy then all unencrypted Customer Content is immediately and // permanently deleted after the Customer Content has been processed by the // service. No copy of of the output is retained by Amazon Textract. For -// information about how to opt out, see Managing AI services opt-out policy. -// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) -// For more information on data privacy, see the Data Privacy FAQ -// (https://aws.amazon.com/compliance/data-privacy-faq/). +// information about how to opt out, see Managing AI services opt-out policy. (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) +// For more information on data privacy, see the Data Privacy FAQ (https://aws.amazon.com/compliance/data-privacy-faq/) +// . type OutputConfig struct { // The name of the bucket your output will go to. @@ -716,8 +657,8 @@ type OutputConfig struct { // This member is required. S3Bucket *string - // The prefix of the object key that the output will be saved to. When not enabled, - // the prefix will be “textract_output". + // The prefix of the object key that the output will be saved to. When not + // enabled, the prefix will be “textract_output". S3Prefix *string noSmithyDocumentSerde @@ -747,15 +688,15 @@ type PageClassification struct { // are returned are ratios of the overall document page size. For example, if the // input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the // point is at the (350,50) pixel coordinate on the document page. An array of -// Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a -// fine-grained polygon around detected text. For more information, see Geometry in -// the Amazon Textract Developer Guide. +// Point objects, Polygon , is returned by DetectDocumentText . Polygon represents +// a fine-grained polygon around detected text. For more information, see Geometry +// in the Amazon Textract Developer Guide. type Point struct { - // The value of the X coordinate for a point on a Polygon. + // The value of the X coordinate for a point on a Polygon . X float32 - // The value of the Y coordinate for a point on a Polygon. + // The value of the Y coordinate for a point on a Polygon . Y float32 noSmithyDocumentSerde @@ -800,31 +741,24 @@ type Query struct { // Pages is a parameter that the user inputs to specify which pages to apply a // query to. The following is a list of rules for using this parameter. - // - // * If a - // page is not specified, it is set to ["1"] by default. - // - // * The following - // characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No - // whitespace is allowed. - // - // * When using * to indicate all pages, it must be the - // only element in the list. - // - // * You can use page intervals, such as [“1-3”, “1-1”, - // “4-*”]. Where * indicates last page of document. - // - // * Specified pages must be - // greater than 0 and less than or equal to the number of pages in the document. + // - If a page is not specified, it is set to ["1"] by default. + // - The following characters are allowed in the parameter's string: 0 1 2 3 4 5 + // 6 7 8 9 - * . No whitespace is allowed. + // - When using * to indicate all pages, it must be the only element in the + // list. + // - You can use page intervals, such as [“1-3”, “1-1”, “4-*”] . Where * + // indicates last page of document. + // - Specified pages must be greater than 0 and less than or equal to the number + // of pages in the document. Pages []string noSmithyDocumentSerde } // Information about how blocks are related to each other. A Block object contains -// 0 or more Relation objects in a list, Relationships. For more information, see -// Block. The Type element provides the type of the relationship for all blocks in -// the IDs array. +// 0 or more Relation objects in a list, Relationships . For more information, see +// Block . The Type element provides the type of the relationship for all blocks +// in the IDs array. type Relationship struct { // An array of IDs for related blocks. You can get the type of the relationship @@ -832,31 +766,22 @@ type Relationship struct { Ids []string // The type of relationship between the blocks in the IDs array and the current - // block. The following list describes the relationship types that can be - // returned. - // - // * VALUE - A list that contains the ID of the VALUE block that's - // associated with the KEY of a key-value pair. - // - // * CHILD - A list of IDs that - // identify blocks found within the current block object. For example, WORD blocks - // have a CHILD relationship to the LINE block type. - // - // * MERGED_CELL - A list of IDs - // that identify each of the MERGED_CELL block types in a table. - // - // * ANSWER - A list - // that contains the ID of the QUERY_RESULT block that’s associated with the - // corresponding QUERY block. - // - // * TABLE - A list of IDs that identify associated - // TABLE block types. - // - // * TABLE_TITLE - A list that contains the ID for the - // TABLE_TITLE block type in a table. - // - // * TABLE_FOOTER - A list of IDs that identify - // the TABLE_FOOTER block types in a table. + // block. The following list describes the relationship types that can be returned. + // + // - VALUE - A list that contains the ID of the VALUE block that's associated + // with the KEY of a key-value pair. + // - CHILD - A list of IDs that identify blocks found within the current block + // object. For example, WORD blocks have a CHILD relationship to the LINE block + // type. + // - MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block + // types in a table. + // - ANSWER - A list that contains the ID of the QUERY_RESULT block that’s + // associated with the corresponding QUERY block. + // - TABLE - A list of IDs that identify associated TABLE block types. + // - TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in + // a table. + // - TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in + // a table. Type RelationshipType noSmithyDocumentSerde @@ -910,8 +835,8 @@ type SplitDocument struct { noSmithyDocumentSerde } -// A structure containing information about an undetected signature on a page where -// it was expected but not found. +// A structure containing information about an undetected signature on a page +// where it was expected but not found. type UndetectedSignature struct { // The page where a signature was expected but not found. @@ -920,9 +845,9 @@ type UndetectedSignature struct { noSmithyDocumentSerde } -// A warning about an issue that occurred during asynchronous text analysis -// (StartDocumentAnalysis) or asynchronous document text detection -// (StartDocumentTextDetection). +// A warning about an issue that occurred during asynchronous text analysis ( +// StartDocumentAnalysis ) or asynchronous document text detection ( +// StartDocumentTextDetection ). type Warning struct { // The error code for the warning. diff --git a/service/timestreamquery/api_client.go b/service/timestreamquery/api_client.go index 6b9601faf06..ffc57bccc98 100644 --- a/service/timestreamquery/api_client.go +++ b/service/timestreamquery/api_client.go @@ -137,7 +137,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/timestreamquery/api_op_CancelQuery.go b/service/timestreamquery/api_op_CancelQuery.go index 85b20fc2eb4..c0ab2052837 100644 --- a/service/timestreamquery/api_op_CancelQuery.go +++ b/service/timestreamquery/api_op_CancelQuery.go @@ -12,12 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a query that has been issued. Cancellation is provided only if the query -// has not completed running before the cancellation request was issued. Because -// cancellation is an idempotent operation, subsequent cancellation requests will -// return a CancellationMessage, indicating that the query has already been -// canceled. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html) +// Cancels a query that has been issued. Cancellation is provided only if the +// query has not completed running before the cancellation request was issued. +// Because cancellation is an idempotent operation, subsequent cancellation +// requests will return a CancellationMessage , indicating that the query has +// already been canceled. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html) // for details. func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optFns ...func(*Options)) (*CancelQueryOutput, error) { if params == nil { diff --git a/service/timestreamquery/api_op_CreateScheduledQuery.go b/service/timestreamquery/api_op_CreateScheduledQuery.go index 907d7dc6817..4efd131f8c1 100644 --- a/service/timestreamquery/api_op_CreateScheduledQuery.go +++ b/service/timestreamquery/api_op_CreateScheduledQuery.go @@ -81,20 +81,18 @@ type CreateScheduledQueryInput struct { // words, making the same request repeatedly will produce the same result. Making // multiple identical CreateScheduledQuery requests has the same effect as making a // single request. - // - // * If CreateScheduledQuery is called without a ClientToken, the - // Query SDK generates a ClientToken on your behalf. - // - // * After 8 hours, any request - // with the same ClientToken is treated as a new request. + // - If CreateScheduledQuery is called without a ClientToken , the Query SDK + // generates a ClientToken on your behalf. + // - After 8 hours, any request with the same ClientToken is treated as a new + // request. ClientToken *string - // The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the - // Amazon KMS key is not specified, the scheduled query resource will be encrypted - // with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, - // key ARN, alias name, or alias ARN. When using an alias name, prefix the name - // with alias/ If ErrorReportConfiguration uses SSE_KMS as encryption type, the - // same KmsKeyId is used to encrypt the error report at rest. + // The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If + // the Amazon KMS key is not specified, the scheduled query resource will be + // encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the + // key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the + // name with alias/ If ErrorReportConfiguration uses SSE_KMS as encryption type, + // the same KmsKeyId is used to encrypt the error report at rest. KmsKeyId *string // A list of key-value pairs to label the scheduled query. diff --git a/service/timestreamquery/api_op_DescribeEndpoints.go b/service/timestreamquery/api_op_DescribeEndpoints.go index 78607941854..42c6f3ab30c 100644 --- a/service/timestreamquery/api_op_DescribeEndpoints.go +++ b/service/timestreamquery/api_op_DescribeEndpoints.go @@ -16,21 +16,15 @@ import ( // Timestream SDKs are designed to transparently work with the service’s // architecture, including the management and mapping of the service endpoints, it // is not recommended that you use this API unless: +// - You are using VPC endpoints (Amazon Web Services PrivateLink) with +// Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) +// - Your application uses a programming language that does not yet have SDK +// support +// - You require better control over the client-side implementation // -// * You are using VPC endpoints -// (Amazon Web Services PrivateLink) with Timestream -// (https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) -// -// * -// Your application uses a programming language that does not yet have SDK -// support -// -// * You require better control over the client-side implementation -// -// For -// detailed information on how and when to use and implement DescribeEndpoints, see -// The Endpoint Discovery Pattern -// (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery). +// For detailed information on how and when to use and implement +// DescribeEndpoints, see The Endpoint Discovery Pattern (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery) +// . func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpointsInput, optFns ...func(*Options)) (*DescribeEndpointsOutput, error) { if params == nil { params = &DescribeEndpointsInput{} diff --git a/service/timestreamquery/api_op_ListScheduledQueries.go b/service/timestreamquery/api_op_ListScheduledQueries.go index 97aaa014f53..4c313bd382d 100644 --- a/service/timestreamquery/api_op_ListScheduledQueries.go +++ b/service/timestreamquery/api_op_ListScheduledQueries.go @@ -33,9 +33,9 @@ func (c *Client) ListScheduledQueries(ctx context.Context, params *ListScheduled type ListScheduledQueriesInput struct { // The maximum number of items to return in the output. If the total number of - // items available is more than the value specified, a NextToken is provided in the - // output. To resume pagination, provide the NextToken value as the argument to the - // subsequent call to ListScheduledQueriesRequest. + // items available is more than the value specified, a NextToken is provided in + // the output. To resume pagination, provide the NextToken value as the argument + // to the subsequent call to ListScheduledQueriesRequest . MaxResults *int32 // A pagination token to resume pagination. @@ -185,9 +185,9 @@ var _ ListScheduledQueriesAPIClient = (*Client)(nil) // ListScheduledQueries type ListScheduledQueriesPaginatorOptions struct { // The maximum number of items to return in the output. If the total number of - // items available is more than the value specified, a NextToken is provided in the - // output. To resume pagination, provide the NextToken value as the argument to the - // subsequent call to ListScheduledQueriesRequest. + // items available is more than the value specified, a NextToken is provided in + // the output. To resume pagination, provide the NextToken value as the argument + // to the subsequent call to ListScheduledQueriesRequest . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/timestreamquery/api_op_ListTagsForResource.go b/service/timestreamquery/api_op_ListTagsForResource.go index 861810cba1a..ad1594614b0 100644 --- a/service/timestreamquery/api_op_ListTagsForResource.go +++ b/service/timestreamquery/api_op_ListTagsForResource.go @@ -31,8 +31,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Timestream resource with tags to be listed. This value is an Amazon Resource - // Name (ARN). + // The Timestream resource with tags to be listed. This value is an Amazon + // Resource Name (ARN). // // This member is required. ResourceARN *string @@ -54,7 +54,7 @@ type ListTagsForResourceOutput struct { Tags []types.Tag // A pagination token to resume pagination with a subsequent call to - // ListTagsForResourceResponse. + // ListTagsForResourceResponse . NextToken *string // Metadata pertaining to the operation's result. @@ -178,8 +178,8 @@ func (c *Client) fetchOpListTagsForResourceDiscoverEndpoint(ctx context.Context, return weighted, nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/timestreamquery/api_op_PrepareQuery.go b/service/timestreamquery/api_op_PrepareQuery.go index c988b5500df..ce51de909df 100644 --- a/service/timestreamquery/api_op_PrepareQuery.go +++ b/service/timestreamquery/api_op_PrepareQuery.go @@ -15,7 +15,7 @@ import ( // A synchronous operation that allows you to submit a query with parameters to be // stored by Timestream for later running. Timestream only supports using this -// operation with the PrepareQueryRequest$ValidateOnly set to true. +// operation with the PrepareQueryRequest$ValidateOnly set to true . func (c *Client) PrepareQuery(ctx context.Context, params *PrepareQueryInput, optFns ...func(*Options)) (*PrepareQueryOutput, error) { if params == nil { params = &PrepareQueryInput{} @@ -40,7 +40,7 @@ type PrepareQueryInput struct { // This member is required. QueryString *string - // By setting this value to true, Timestream will only validate that the query + // By setting this value to true , Timestream will only validate that the query // string is a valid Timestream query, and not store the prepared query for later // use. ValidateOnly *bool diff --git a/service/timestreamquery/api_op_Query.go b/service/timestreamquery/api_op_Query.go index 204c3fe77bf..641e7f73785 100644 --- a/service/timestreamquery/api_op_Query.go +++ b/service/timestreamquery/api_op_Query.go @@ -16,26 +16,19 @@ import ( // Query is a synchronous operation that enables you to run a query against your // Amazon Timestream data. Query will time out after 60 seconds. You must update // the default timeout in the SDK to support a timeout of 60 seconds. See the code -// sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) +// sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) // for details. Your query request will fail in the following cases: -// -// * If you -// submit a Query request with the same client token outside of the 5-minute -// idempotency window. -// -// * If you submit a Query request with the same client token, -// but change other parameters, within the 5-minute idempotency window. -// -// * If the -// size of the row (including the query metadata) exceeds 1 MB, then the query will -// fail with the following error message: Query aborted as max page response size -// has been exceeded by the output result row -// -// * If the IAM principal of the query -// initiator and the result reader are not the same and/or the query initiator and -// the result reader do not have the same query string in the query requests, the -// query will fail with an Invalid pagination token error. +// - If you submit a Query request with the same client token outside of the +// 5-minute idempotency window. +// - If you submit a Query request with the same client token, but change other +// parameters, within the 5-minute idempotency window. +// - If the size of the row (including the query metadata) exceeds 1 MB, then +// the query will fail with the following error message: Query aborted as max +// page response size has been exceeded by the output result row +// - If the IAM principal of the query initiator and the result reader are not +// the same and/or the query initiator and the result reader do not have the same +// query string in the query requests, the query will fail with an Invalid +// pagination token error. func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -64,70 +57,51 @@ type QueryInput struct { // same result. In other words, making multiple identical Query requests has the // same effect as making a single request. When using ClientToken in a query, note // the following: - // - // * If the Query API is instantiated without a ClientToken, the - // Query SDK generates a ClientToken on your behalf. - // - // * If the Query invocation - // only contains the ClientToken but does not include a NextToken, that invocation - // of Query is assumed to be a new query run. - // - // * If the invocation contains - // NextToken, that particular invocation is assumed to be a subsequent invocation - // of a prior call to the Query API, and a result set is returned. - // - // * After 4 - // hours, any request with the same ClientToken is treated as a new request. + // - If the Query API is instantiated without a ClientToken , the Query SDK + // generates a ClientToken on your behalf. + // - If the Query invocation only contains the ClientToken but does not include a + // NextToken , that invocation of Query is assumed to be a new query run. + // - If the invocation contains NextToken , that particular invocation is assumed + // to be a subsequent invocation of a prior call to the Query API, and a result set + // is returned. + // - After 4 hours, any request with the same ClientToken is treated as a new + // request. ClientToken *string // The total number of rows to be returned in the Query output. The initial run of // Query with a MaxRows value specified will return the result set of the query in // two cases: - // - // * The size of the result is less than 1MB. - // - // * The number of rows in - // the result set is less than the value of maxRows. - // - // Otherwise, the initial - // invocation of Query only returns a NextToken, which can then be used in - // subsequent calls to fetch the result set. To resume pagination, provide the - // NextToken value in the subsequent command. If the row size is large (e.g. a row - // has many columns), Timestream may return fewer rows to keep the response size - // from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send - // the necessary number of rows to meet the 1 MB limit. + // - The size of the result is less than 1MB . + // - The number of rows in the result set is less than the value of maxRows . + // Otherwise, the initial invocation of Query only returns a NextToken , which can + // then be used in subsequent calls to fetch the result set. To resume pagination, + // provide the NextToken value in the subsequent command. If the row size is large + // (e.g. a row has many columns), Timestream may return fewer rows to keep the + // response size from exceeding the 1 MB limit. If MaxRows is not provided, + // Timestream will send the necessary number of rows to meet the 1 MB limit. MaxRows *int32 // A pagination token used to return a set of results. When the Query API is - // invoked using NextToken, that particular invocation is assumed to be a - // subsequent invocation of a prior call to Query, and a result set is returned. - // However, if the Query invocation only contains the ClientToken, that invocation + // invoked using NextToken , that particular invocation is assumed to be a + // subsequent invocation of a prior call to Query , and a result set is returned. + // However, if the Query invocation only contains the ClientToken , that invocation // of Query is assumed to be a new query run. Note the following when using // NextToken in a query: - // - // * A pagination token can be used for up to five Query - // invocations, OR for a duration of up to 1 hour – whichever comes first. - // - // * Using - // the same NextToken will return the same set of records. To keep paginating - // through the result set, you must to use the most recent nextToken. - // - // * Suppose a - // Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is - // used in a subsequent Query invocation, then TokenA is invalidated and cannot be - // reused. - // - // * To request a previous result set from a query after pagination has - // begun, you must re-invoke the Query API. - // - // * The latest NextToken should be used - // to paginate until null is returned, at which point a new NextToken should be - // used. - // - // * If the IAM principal of the query initiator and the result reader are - // not the same and/or the query initiator and the result reader do not have the - // same query string in the query requests, the query will fail with an Invalid - // pagination token error. + // - A pagination token can be used for up to five Query invocations, OR for a + // duration of up to 1 hour – whichever comes first. + // - Using the same NextToken will return the same set of records. To keep + // paginating through the result set, you must to use the most recent nextToken . + // - Suppose a Query invocation returns two NextToken values, TokenA and TokenB . + // If TokenB is used in a subsequent Query invocation, then TokenA is invalidated + // and cannot be reused. + // - To request a previous result set from a query after pagination has begun, + // you must re-invoke the Query API. + // - The latest NextToken should be used to paginate until null is returned, at + // which point a new NextToken should be used. + // - If the IAM principal of the query initiator and the result reader are not + // the same and/or the query initiator and the result reader do not have the same + // query string in the query requests, the query will fail with an Invalid + // pagination token error. NextToken *string noSmithyDocumentSerde @@ -150,8 +124,8 @@ type QueryOutput struct { // This member is required. Rows []types.Row - // A pagination token that can be used again on a Query call to get the next set of - // results. + // A pagination token that can be used again on a Query call to get the next set + // of results. NextToken *string // Information about the status of the query, including progress and bytes scanned. @@ -293,19 +267,14 @@ type QueryPaginatorOptions struct { // The total number of rows to be returned in the Query output. The initial run of // Query with a MaxRows value specified will return the result set of the query in // two cases: - // - // * The size of the result is less than 1MB. - // - // * The number of rows in - // the result set is less than the value of maxRows. - // - // Otherwise, the initial - // invocation of Query only returns a NextToken, which can then be used in - // subsequent calls to fetch the result set. To resume pagination, provide the - // NextToken value in the subsequent command. If the row size is large (e.g. a row - // has many columns), Timestream may return fewer rows to keep the response size - // from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send - // the necessary number of rows to meet the 1 MB limit. + // - The size of the result is less than 1MB . + // - The number of rows in the result set is less than the value of maxRows . + // Otherwise, the initial invocation of Query only returns a NextToken , which can + // then be used in subsequent calls to fetch the result set. To resume pagination, + // provide the NextToken value in the subsequent command. If the row size is large + // (e.g. a row has many columns), Timestream may return fewer rows to keep the + // response size from exceeding the 1 MB limit. If MaxRows is not provided, + // Timestream will send the necessary number of rows to meet the 1 MB limit. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/timestreamquery/doc.go b/service/timestreamquery/doc.go index 070d329da70..8f0a150680b 100644 --- a/service/timestreamquery/doc.go +++ b/service/timestreamquery/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package timestreamquery provides the API client, operations, and parameter types -// for Amazon Timestream Query. +// Package timestreamquery provides the API client, operations, and parameter +// types for Amazon Timestream Query. // // Amazon Timestream Query package timestreamquery diff --git a/service/timestreamquery/types/types.go b/service/timestreamquery/types/types.go index 04330040b89..50f4487c873 100644 --- a/service/timestreamquery/types/types.go +++ b/service/timestreamquery/types/types.go @@ -125,8 +125,8 @@ type ExecutionStats struct { noSmithyDocumentSerde } -// MixedMeasureMappings are mappings that can be used to ingest data into a mixture -// of narrow and multi measures in the derived table. +// MixedMeasureMappings are mappings that can be used to ingest data into a +// mixture of narrow and multi measures in the derived table. type MixedMeasureMapping struct { // Type of the value that is to be read from sourceColumn. If the mapping is for @@ -179,8 +179,8 @@ type MultiMeasureAttributeMapping struct { // table. type MultiMeasureMappings struct { - // Required. Attribute mappings to be used for mapping query results to ingest data - // for multi-measure attributes. + // Required. Attribute mappings to be used for mapping query results to ingest + // data for multi-measure attributes. // // This member is required. MultiMeasureAttributeMappings []MultiMeasureAttributeMapping @@ -268,8 +268,8 @@ type S3Configuration struct { // specified, Timestream will choose SSE_S3 as default. EncryptionOption S3EncryptionOption - // Prefix for the error report key. Timestream by default adds the following prefix - // to the error report path. + // Prefix for the error report key. Timestream by default adds the following + // prefix to the error report path. ObjectKeyPrefix *string noSmithyDocumentSerde @@ -410,12 +410,12 @@ type ScheduledQueryRunSummary struct { // Runtime statistics for a scheduled run. ExecutionStats *ExecutionStats - // Error message for the scheduled query in case of failure. You might have to look - // at the error report to get more detailed error reasons. + // Error message for the scheduled query in case of failure. You might have to + // look at the error report to get more detailed error reasons. FailureReason *string - // InvocationTime for this run. This is the time at which the query is scheduled to - // run. Parameter @scheduled_runtime can be used in the query to get the value. + // InvocationTime for this run. This is the time at which the query is scheduled + // to run. Parameter @scheduled_runtime can be used in the query to get the value. InvocationTime *time.Time // The status of a scheduled query run. @@ -462,10 +462,10 @@ type SnsConfiguration struct { noSmithyDocumentSerde } -// A tag is a label that you assign to a Timestream database and/or table. Each tag -// consists of a key and an optional value, both of which you define. Tags enable -// you to categorize databases and/or tables, for example, by purpose, owner, or -// environment. +// A tag is a label that you assign to a Timestream database and/or table. Each +// tag consists of a key and an optional value, both of which you define. Tags +// enable you to categorize databases and/or tables, for example, by purpose, +// owner, or environment. type Tag struct { // The key of the tag. Tag keys are case sensitive. @@ -531,8 +531,8 @@ type TimestreamConfiguration struct { // This member is required. DatabaseName *string - // This is to allow mapping column(s) from the query result to the dimension in the - // destination table. + // This is to allow mapping column(s) from the query result to the dimension in + // the destination table. // // This member is required. DimensionMappings []DimensionMapping diff --git a/service/timestreamwrite/api_client.go b/service/timestreamwrite/api_client.go index b56b32f97d1..2f308dc4548 100644 --- a/service/timestreamwrite/api_client.go +++ b/service/timestreamwrite/api_client.go @@ -137,7 +137,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/timestreamwrite/api_op_CreateBatchLoadTask.go b/service/timestreamwrite/api_op_CreateBatchLoadTask.go index 846a66d7f85..fe1e7e84ea6 100644 --- a/service/timestreamwrite/api_op_CreateBatchLoadTask.go +++ b/service/timestreamwrite/api_op_CreateBatchLoadTask.go @@ -18,12 +18,10 @@ import ( // source to target is defined in a batch load task. Errors and events are written // to a report at an S3 location. For the report, if the KMS key is not specified, // the batch load task will be encrypted with a Timestream managed KMS key located -// in your account. For more information, see Amazon Web Services managed keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). -// Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// For details, see code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html). +// in your account. For more information, see Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// . Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . For details, see code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html) +// . func (c *Client) CreateBatchLoadTask(ctx context.Context, params *CreateBatchLoadTaskInput, optFns ...func(*Options)) (*CreateBatchLoadTaskOutput, error) { if params == nil { params = &CreateBatchLoadTaskInput{} diff --git a/service/timestreamwrite/api_op_CreateDatabase.go b/service/timestreamwrite/api_op_CreateDatabase.go index 4ec2b1bfbc7..37600678a89 100644 --- a/service/timestreamwrite/api_op_CreateDatabase.go +++ b/service/timestreamwrite/api_op_CreateDatabase.go @@ -13,14 +13,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Timestream database. If the KMS key is not specified, the database -// will be encrypted with a Timestream managed KMS key located in your account. For -// more information, see Amazon Web Services managed keys -// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). -// Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// For details, see code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html). +// Creates a new Timestream database. If the KMS key is not specified, the +// database will be encrypted with a Timestream managed KMS key located in your +// account. For more information, see Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) +// . Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . For details, see code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html) +// . func (c *Client) CreateDatabase(ctx context.Context, params *CreateDatabaseInput, optFns ...func(*Options)) (*CreateDatabaseOutput, error) { if params == nil { params = &CreateDatabaseInput{} @@ -43,10 +41,10 @@ type CreateDatabaseInput struct { // This member is required. DatabaseName *string - // The KMS key for the database. If the KMS key is not specified, the database will - // be encrypted with a Timestream managed KMS key located in your account. For more - // information, see Amazon Web Services managed keys - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + // The KMS key for the database. If the KMS key is not specified, the database + // will be encrypted with a Timestream managed KMS key located in your account. For + // more information, see Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) + // . KmsKeyId *string // A list of key-value pairs to label the table. diff --git a/service/timestreamwrite/api_op_CreateTable.go b/service/timestreamwrite/api_op_CreateTable.go index b390536ab0c..e98d6e24445 100644 --- a/service/timestreamwrite/api_op_CreateTable.go +++ b/service/timestreamwrite/api_op_CreateTable.go @@ -18,10 +18,8 @@ import ( // are in the same database. You might have identical table names in the same // Region if the tables are in separate databases. While creating the table, you // must specify the table name, database name, and the retention properties. -// Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) +// Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) // for details. func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_DeleteDatabase.go b/service/timestreamwrite/api_op_DeleteDatabase.go index b64e6f5f953..38bd4d159d4 100644 --- a/service/timestreamwrite/api_op_DeleteDatabase.go +++ b/service/timestreamwrite/api_op_DeleteDatabase.go @@ -17,8 +17,7 @@ import ( // All tables in the database must be deleted first, or a ValidationException error // will be thrown. Due to the nature of distributed retries, the operation can // return either success or a ResourceNotFoundException. Clients should consider -// them equivalent. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) +// them equivalent. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) // for details. func (c *Client) DeleteDatabase(ctx context.Context, params *DeleteDatabaseInput, optFns ...func(*Options)) (*DeleteDatabaseOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_DeleteTable.go b/service/timestreamwrite/api_op_DeleteTable.go index 079cd6162d6..25cc48a5276 100644 --- a/service/timestreamwrite/api_op_DeleteTable.go +++ b/service/timestreamwrite/api_op_DeleteTable.go @@ -16,8 +16,7 @@ import ( // Timestream database table is deleted, the time-series data stored in the table // cannot be recovered. Due to the nature of distributed retries, the operation can // return either success or a ResourceNotFoundException. Clients should consider -// them equivalent. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) +// them equivalent. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) // for details. func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_DescribeBatchLoadTask.go b/service/timestreamwrite/api_op_DescribeBatchLoadTask.go index 68ed3ae55ff..e7cf9237f94 100644 --- a/service/timestreamwrite/api_op_DescribeBatchLoadTask.go +++ b/service/timestreamwrite/api_op_DescribeBatchLoadTask.go @@ -14,10 +14,8 @@ import ( ) // Returns information about the batch load task, including configurations, -// mappings, progress, and other details. Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) +// mappings, progress, and other details. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) // for details. func (c *Client) DescribeBatchLoadTask(ctx context.Context, params *DescribeBatchLoadTaskInput, optFns ...func(*Options)) (*DescribeBatchLoadTaskOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_DescribeDatabase.go b/service/timestreamwrite/api_op_DescribeDatabase.go index 69cb6ab3ef1..4ff68790909 100644 --- a/service/timestreamwrite/api_op_DescribeDatabase.go +++ b/service/timestreamwrite/api_op_DescribeDatabase.go @@ -15,10 +15,8 @@ import ( // Returns information about the database, including the database name, time that // the database was created, and the total number of tables found within the -// database. Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) +// database. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) // for details. func (c *Client) DescribeDatabase(ctx context.Context, params *DescribeDatabaseInput, optFns ...func(*Options)) (*DescribeDatabaseOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_DescribeEndpoints.go b/service/timestreamwrite/api_op_DescribeEndpoints.go index 126a8581a96..8a685dbf904 100644 --- a/service/timestreamwrite/api_op_DescribeEndpoints.go +++ b/service/timestreamwrite/api_op_DescribeEndpoints.go @@ -11,26 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of available endpoints to make Timestream API calls against. This -// API operation is available through both the Write and Query APIs. Because the -// Timestream SDKs are designed to transparently work with the service’s +// Returns a list of available endpoints to make Timestream API calls against. +// This API operation is available through both the Write and Query APIs. Because +// the Timestream SDKs are designed to transparently work with the service’s // architecture, including the management and mapping of the service endpoints, we // don't recommend that you use this API operation unless: +// - You are using VPC endpoints (Amazon Web Services PrivateLink) with +// Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) +// - Your application uses a programming language that does not yet have SDK +// support +// - You require better control over the client-side implementation // -// * You are using VPC -// endpoints (Amazon Web Services PrivateLink) with Timestream -// (https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) -// -// * -// Your application uses a programming language that does not yet have SDK -// support -// -// * You require better control over the client-side implementation -// -// For -// detailed information on how and when to use and implement DescribeEndpoints, see -// The Endpoint Discovery Pattern -// (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery). +// For detailed information on how and when to use and implement +// DescribeEndpoints, see The Endpoint Discovery Pattern (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery) +// . func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpointsInput, optFns ...func(*Options)) (*DescribeEndpointsOutput, error) { if params == nil { params = &DescribeEndpointsInput{} diff --git a/service/timestreamwrite/api_op_DescribeTable.go b/service/timestreamwrite/api_op_DescribeTable.go index 4620b393acd..e138e320387 100644 --- a/service/timestreamwrite/api_op_DescribeTable.go +++ b/service/timestreamwrite/api_op_DescribeTable.go @@ -15,10 +15,8 @@ import ( // Returns information about the table, including the table name, database name, // retention duration of the memory store and the magnetic store. Service quotas -// apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) +// apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) // for details. func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_ListBatchLoadTasks.go b/service/timestreamwrite/api_op_ListBatchLoadTasks.go index 9c41c1d158f..8e4e37b8ce9 100644 --- a/service/timestreamwrite/api_op_ListBatchLoadTasks.go +++ b/service/timestreamwrite/api_op_ListBatchLoadTasks.go @@ -14,8 +14,7 @@ import ( ) // Provides a list of batch load tasks, along with the name, status, when the task -// is resumable until, and other details. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) +// is resumable until, and other details. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) // for details. func (c *Client) ListBatchLoadTasks(ctx context.Context, params *ListBatchLoadTasksInput, optFns ...func(*Options)) (*ListBatchLoadTasksOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_ListDatabases.go b/service/timestreamwrite/api_op_ListDatabases.go index 060b3a5032b..0affcf6d200 100644 --- a/service/timestreamwrite/api_op_ListDatabases.go +++ b/service/timestreamwrite/api_op_ListDatabases.go @@ -13,10 +13,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of your Timestream databases. Service quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) +// Returns a list of your Timestream databases. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) // for details. func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_ListTables.go b/service/timestreamwrite/api_op_ListTables.go index 36571aaf6ad..4de867085a0 100644 --- a/service/timestreamwrite/api_op_ListTables.go +++ b/service/timestreamwrite/api_op_ListTables.go @@ -13,9 +13,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides a list of tables, along with the name, status, and retention properties -// of each table. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) +// Provides a list of tables, along with the name, status, and retention +// properties of each table. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) // for details. func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_ListTagsForResource.go b/service/timestreamwrite/api_op_ListTagsForResource.go index 22e2667b146..4387658a2eb 100644 --- a/service/timestreamwrite/api_op_ListTagsForResource.go +++ b/service/timestreamwrite/api_op_ListTagsForResource.go @@ -31,8 +31,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Timestream resource with tags to be listed. This value is an Amazon Resource - // Name (ARN). + // The Timestream resource with tags to be listed. This value is an Amazon + // Resource Name (ARN). // // This member is required. ResourceARN *string diff --git a/service/timestreamwrite/api_op_TagResource.go b/service/timestreamwrite/api_op_TagResource.go index 41f726a1864..87118787b70 100644 --- a/service/timestreamwrite/api_op_TagResource.go +++ b/service/timestreamwrite/api_op_TagResource.go @@ -13,9 +13,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a set of tags with a Timestream resource. You can then activate these -// user-defined tags so that they appear on the Billing and Cost Management console -// for cost allocation tracking. +// Associates a set of tags with a Timestream resource. You can then activate +// these user-defined tags so that they appear on the Billing and Cost Management +// console for cost allocation tracking. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/timestreamwrite/api_op_UpdateDatabase.go b/service/timestreamwrite/api_op_UpdateDatabase.go index c1d84506835..53ea6facc13 100644 --- a/service/timestreamwrite/api_op_UpdateDatabase.go +++ b/service/timestreamwrite/api_op_UpdateDatabase.go @@ -15,9 +15,8 @@ import ( // Modifies the KMS key for an existing database. While updating the database, you // must specify the database name and the identifier of the new KMS key to be used -// (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer -// wins. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) +// ( KmsKeyId ). If there are any concurrent UpdateDatabase requests, first writer +// wins. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) // for details. func (c *Client) UpdateDatabase(ctx context.Context, params *UpdateDatabaseInput, optFns ...func(*Options)) (*UpdateDatabaseOutput, error) { if params == nil { @@ -41,22 +40,15 @@ type UpdateDatabaseInput struct { // This member is required. DatabaseName *string - // The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data + // The identifier of the new KMS key ( KmsKeyId ) to be used to encrypt the data // stored in the database. If the KmsKeyId currently registered with the database // is the same as the KmsKeyId in the request, there will not be any update. You // can specify the KmsKeyId using any of the following: - // - // * Key ID: - // 1234abcd-12ab-34cd-56ef-1234567890ab - // - // * Key ARN: - // arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - // - // * - // Alias name: alias/ExampleAlias - // - // * Alias ARN: - // arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias + // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // - Key ARN: + // arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // - Alias name: alias/ExampleAlias + // - Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias // // This member is required. KmsKeyId *string diff --git a/service/timestreamwrite/api_op_UpdateTable.go b/service/timestreamwrite/api_op_UpdateTable.go index 7a63de62115..8041daf96b9 100644 --- a/service/timestreamwrite/api_op_UpdateTable.go +++ b/service/timestreamwrite/api_op_UpdateTable.go @@ -19,8 +19,7 @@ import ( // initially set to 2 hours and then changed to 24 hours, the memory store will be // capable of holding 24 hours of data, but will be populated with 24 hours of data // 22 hours after this change was made. Timestream does not retrieve data from the -// magnetic store to populate the memory store. See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) +// magnetic store to populate the memory store. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) // for details. func (c *Client) UpdateTable(ctx context.Context, params *UpdateTableInput, optFns ...func(*Options)) (*UpdateTableOutput, error) { if params == nil { diff --git a/service/timestreamwrite/api_op_WriteRecords.go b/service/timestreamwrite/api_op_WriteRecords.go index 037e5818ff4..90233b81ade 100644 --- a/service/timestreamwrite/api_op_WriteRecords.go +++ b/service/timestreamwrite/api_op_WriteRecords.go @@ -23,32 +23,30 @@ import ( // query results might not reflect the results of a recently completed write // operation. The results may also include some stale data. If you repeat the query // request after a short time, the results should return the latest data. Service -// quotas apply -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). -// See code sample -// (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) -// for details. Upserts You can use the Version parameter in a WriteRecords request -// to update data points. Timestream tracks a version number with each record. -// Version defaults to 1 when it's not specified for the record in the request. -// Timestream updates an existing record’s measure value along with its Version -// when it receives a write request with a higher Version number for that record. -// When it receives an update request where the measure value is the same as that -// of the existing record, Timestream still updates Version, if it is greater than -// the existing value of Version. You can update a data point as many times as -// desired, as long as the value of Version continuously increases. For example, -// suppose you write a new record without indicating Version in the request. -// Timestream stores this record, and set Version to 1. Now, suppose you try to -// update this record with a WriteRecords request of the same record with a -// different measure value but, like before, do not provide Version. In this case, +// quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// . See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) +// for details. Upserts You can use the Version parameter in a WriteRecords +// request to update data points. Timestream tracks a version number with each +// record. Version defaults to 1 when it's not specified for the record in the +// request. Timestream updates an existing record’s measure value along with its +// Version when it receives a write request with a higher Version number for that +// record. When it receives an update request where the measure value is the same +// as that of the existing record, Timestream still updates Version , if it is +// greater than the existing value of Version . You can update a data point as many +// times as desired, as long as the value of Version continuously increases. For +// example, suppose you write a new record without indicating Version in the +// request. Timestream stores this record, and set Version to 1 . Now, suppose you +// try to update this record with a WriteRecords request of the same record with a +// different measure value but, like before, do not provide Version . In this case, // Timestream will reject this update with a RejectedRecordsException since the // updated record’s version is not greater than the existing value of Version. -// However, if you were to resend the update request with Version set to 2, +// However, if you were to resend the update request with Version set to 2 , // Timestream would then succeed in updating the record’s value, and the Version -// would be set to 2. Next, suppose you sent a WriteRecords request with this same -// record and an identical measure value, but with Version set to 3. In this case, -// Timestream would only update Version to 3. Any further updates would need to -// send a version number greater than 3, or the update requests would receive a -// RejectedRecordsException. +// would be set to 2 . Next, suppose you sent a WriteRecords request with this +// same record and an identical measure value, but with Version set to 3 . In this +// case, Timestream would only update Version to 3 . Any further updates would need +// to send a version number greater than 3 , or the update requests would receive a +// RejectedRecordsException . func (c *Client) WriteRecords(ctx context.Context, params *WriteRecordsInput, optFns ...func(*Options)) (*WriteRecordsOutput, error) { if params == nil { params = &WriteRecordsInput{} diff --git a/service/timestreamwrite/doc.go b/service/timestreamwrite/doc.go index 631dc9f43c6..a1c121d349a 100644 --- a/service/timestreamwrite/doc.go +++ b/service/timestreamwrite/doc.go @@ -1,7 +1,7 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package timestreamwrite provides the API client, operations, and parameter types -// for Amazon Timestream Write. +// Package timestreamwrite provides the API client, operations, and parameter +// types for Amazon Timestream Write. // // Amazon Timestream Write Amazon Timestream is a fast, scalable, fully managed // time-series database service that makes it easy to store and analyze trillions diff --git a/service/timestreamwrite/types/errors.go b/service/timestreamwrite/types/errors.go index 4e2932a630f..cf746a06085 100644 --- a/service/timestreamwrite/types/errors.go +++ b/service/timestreamwrite/types/errors.go @@ -114,32 +114,22 @@ func (e *InvalidEndpointException) ErrorCode() string { func (e *InvalidEndpointException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // WriteRecords would throw this exception in the following cases: +// - Records with duplicate data where there are multiple records with the same +// dimensions, timestamps, and measure names but: +// - Measure values are different +// - Version is not present in the request or the value of version in the new +// record is equal to or lower than the existing value In this case, if +// Timestream rejects data, the ExistingVersion field in the RejectedRecords +// response will indicate the current record’s version. To force an update, you can +// resend the request with a version for the record set to a value greater than the +// ExistingVersion . +// - Records with timestamps that lie outside the retention duration of the +// memory store. +// - Records with dimensions or measures that exceed the Timestream defined +// limits. // -// * Records with -// duplicate data where there are multiple records with the same dimensions, -// timestamps, and measure names but: -// -// * Measure values are different -// -// * Version is -// not present in the request or the value of version in the new record is equal to -// or lower than the existing value -// -// In this case, if Timestream rejects data, the -// ExistingVersion field in the RejectedRecords response will indicate the current -// record’s version. To force an update, you can resend the request with a version -// for the record set to a value greater than the ExistingVersion. -// -// * Records with -// timestamps that lie outside the retention duration of the memory store. -// -// * -// Records with dimensions or measures that exceed the Timestream defined -// limits. -// -// For more information, see Quotas -// (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in -// the Amazon Timestream Developer Guide. +// For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) +// in the Amazon Timestream Developer Guide. type RejectedRecordsException struct { Message *string diff --git a/service/timestreamwrite/types/types.go b/service/timestreamwrite/types/types.go index 7a8c45bb72c..b59b7947460 100644 --- a/service/timestreamwrite/types/types.go +++ b/service/timestreamwrite/types/types.go @@ -105,8 +105,8 @@ type BatchLoadTaskDescription struct { noSmithyDocumentSerde } -// A delimited data format where the column separator can be a comma and the record -// separator is a newline character. +// A delimited data format where the column separator can be a comma and the +// record separator is a newline character. type CsvConfiguration struct { // Column separator can be one of comma (','), pipe ('|), semicolon (';'), @@ -176,7 +176,7 @@ type DataModel struct { // The granularity of the timestamp unit. It indicates if the time value is in // seconds, milliseconds, nanoseconds, or other supported values. Default is - // MILLISECONDS. + // MILLISECONDS . TimeUnit TimeUnit noSmithyDocumentSerde @@ -217,8 +217,8 @@ type DataSourceConfiguration struct { // This member is required. DataSourceS3Configuration *DataSourceS3Configuration - // A delimited data format where the column separator can be a comma and the record - // separator is a newline character. + // A delimited data format where the column separator can be a comma and the + // record separator is a newline character. CsvConfiguration *CsvConfiguration noSmithyDocumentSerde @@ -237,16 +237,16 @@ type DataSourceS3Configuration struct { noSmithyDocumentSerde } -// Represents the metadata attributes of the time series. For example, the name and -// Availability Zone of an EC2 instance or the name of the manufacturer of a wind -// turbine are dimensions. +// Represents the metadata attributes of the time series. For example, the name +// and Availability Zone of an EC2 instance or the name of the manufacturer of a +// wind turbine are dimensions. type Dimension struct { // Dimension represents the metadata attributes of the time series. For example, // the name and Availability Zone of an EC2 instance or the name of the // manufacturer of a wind turbine are dimensions. For constraints on dimension - // names, see Naming Constraints - // (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming). + // names, see Naming Constraints (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming) + // . // // This member is required. Name *string @@ -290,8 +290,8 @@ type Endpoint struct { noSmithyDocumentSerde } -// The location to write error reports for records rejected, asynchronously, during -// magnetic store writes. +// The location to write error reports for records rejected, asynchronously, +// during magnetic store writes. type MagneticStoreRejectedDataLocation struct { // Configuration of an S3 location to write error reports for records rejected, @@ -319,13 +319,12 @@ type MagneticStoreWriteProperties struct { // Represents the data attribute of the time series. For example, the CPU // utilization of an EC2 instance or the RPM of a wind turbine are measures. // MeasureValue has both name and value. MeasureValue is only allowed for type -// MULTI. Using MULTI type, you can pass multiple data attributes associated with +// MULTI . Using MULTI type, you can pass multiple data attributes associated with // the same time series in a single record type MeasureValue struct { - // The name of the MeasureValue. For constraints on MeasureValue names, see Naming - // Constraints - // (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming) + // The name of the MeasureValue. For constraints on MeasureValue names, see + // Naming Constraints (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming) // in the Amazon Timestream Developer Guide. // // This member is required. @@ -406,9 +405,9 @@ type MultiMeasureMappings struct { // granularity of the timestamp. Records have a Version field, which is a 64-bit // long that you can use for updating data points. Writes of a duplicate record // with the same dimension, timestamp, and measure name but different measure value -// will only succeed if the Version attribute of the record in the write request is -// higher than that of the existing record. Timestream defaults to a Version of 1 -// for records without the Version field. +// will only succeed if the Version attribute of the record in the write request +// is higher than that of the existing record. Timestream defaults to a Version of +// 1 for records without the Version field. type Record struct { // Contains the list of dimensions for time-series data points. @@ -422,29 +421,29 @@ type Record struct { MeasureValue *string // Contains the data type of the measure value for the time-series data point. - // Default type is DOUBLE. + // Default type is DOUBLE . MeasureValueType MeasureValueType // Contains the list of MeasureValue for time-series data points. This is only - // allowed for type MULTI. For scalar values, use MeasureValue attribute of the + // allowed for type MULTI . For scalar values, use MeasureValue attribute of the // record directly. MeasureValues []MeasureValue // Contains the time at which the measure value for the data point was collected. // The time value plus the unit provides the time elapsed since the epoch. For - // example, if the time value is 12345 and the unit is ms, then 12345 ms have + // example, if the time value is 12345 and the unit is ms , then 12345 ms have // elapsed since the epoch. Time *string // The granularity of the timestamp unit. It indicates if the time value is in // seconds, milliseconds, nanoseconds, or other supported values. Default is - // MILLISECONDS. + // MILLISECONDS . TimeUnit TimeUnit - // 64-bit attribute used for record updates. Write requests for duplicate data with - // a higher version number will update the existing measure value and version. In - // cases where the measure value is the same, Version will still be updated. - // Default value is 1. Version must be 1 or greater, or you will receive a + // 64-bit attribute used for record updates. Write requests for duplicate data + // with a higher version number will update the existing measure value and version. + // In cases where the measure value is the same, Version will still be updated. + // Default value is 1 . Version must be 1 or greater, or you will receive a // ValidationException error. Version *int64 @@ -478,39 +477,27 @@ type RejectedRecord struct { // The reason why a record was not successfully inserted into Timestream. Possible // causes of failure include: - // - // * Records with duplicate data where there are - // multiple records with the same dimensions, timestamps, and measure names but: - // - // * - // Measure values are different - // - // * Version is not present in the request, or the - // value of version in the new record is equal to or lower than the existing - // value - // - // If Timestream rejects data for this case, the ExistingVersion field in - // the RejectedRecords response will indicate the current record’s version. To - // force an update, you can resend the request with a version for the record set to - // a value greater than the ExistingVersion. - // - // * Records with timestamps that lie - // outside the retention duration of the memory store. When the retention window is - // updated, you will receive a RejectedRecords exception if you immediately try to - // ingest data within the new window. To avoid a RejectedRecords exception, wait - // until the duration of the new window to ingest new data. For further - // information, see Best Practices for Configuring Timestream - // (https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration) - // and the explanation of how storage works in Timestream - // (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html). - // - // * - // Records with dimensions or measures that exceed the Timestream defined - // limits. - // - // For more information, see Access Management - // (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in - // the Timestream Developer Guide. + // - Records with duplicate data where there are multiple records with the same + // dimensions, timestamps, and measure names but: + // - Measure values are different + // - Version is not present in the request, or the value of version in the new + // record is equal to or lower than the existing value If Timestream rejects + // data for this case, the ExistingVersion field in the RejectedRecords response + // will indicate the current record’s version. To force an update, you can resend + // the request with a version for the record set to a value greater than the + // ExistingVersion . + // - Records with timestamps that lie outside the retention duration of the + // memory store. When the retention window is updated, you will receive a + // RejectedRecords exception if you immediately try to ingest data within the new + // window. To avoid a RejectedRecords exception, wait until the duration of the + // new window to ingest new data. For further information, see Best Practices + // for Configuring Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration) + // and the explanation of how storage works in Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html) + // . + // - Records with dimensions or measures that exceed the Timestream defined + // limits. + // For more information, see Access Management (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) + // in the Timestream Developer Guide. Reason *string // The index of the record in the input request for WriteRecords. Indexes begin @@ -614,20 +601,17 @@ type Table struct { TableName *string // The current state of the table: - // - // * DELETING - The table is being deleted. - // - // * - // ACTIVE - The table is ready for use. + // - DELETING - The table is being deleted. + // - ACTIVE - The table is ready for use. TableStatus TableStatus noSmithyDocumentSerde } -// A tag is a label that you assign to a Timestream database and/or table. Each tag -// consists of a key and an optional value, both of which you define. With tags, -// you can categorize databases and/or tables, for example, by purpose, owner, or -// environment. +// A tag is a label that you assign to a Timestream database and/or table. Each +// tag consists of a key and an optional value, both of which you define. With +// tags, you can categorize databases and/or tables, for example, by purpose, +// owner, or environment. type Tag struct { // The key of the tag. Tag keys are case sensitive. diff --git a/service/tnb/api_client.go b/service/tnb/api_client.go index 8940c69a559..567946e59a6 100644 --- a/service/tnb/api_client.go +++ b/service/tnb/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/tnb/api_op_CreateSolFunctionPackage.go b/service/tnb/api_op_CreateSolFunctionPackage.go index 19512553c68..cabbda891ff 100644 --- a/service/tnb/api_op_CreateSolFunctionPackage.go +++ b/service/tnb/api_op_CreateSolFunctionPackage.go @@ -15,14 +15,13 @@ import ( // Service Archive) format that contains a network function (an ETSI standard // telecommunication application) and function package descriptor that uses the // TOSCA standard to describe how the network functions should run on your network. -// For more information, see Function packages -// (https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html) in the Amazon -// Web Services Telco Network Builder User Guide. Creating a function package is -// the first step for creating a network in AWS TNB. This request creates an empty -// container with an ID. The next step is to upload the actual CSAR zip file into -// that empty container. To upload function package content, see -// PutSolFunctionPackageContent -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html). +// For more information, see Function packages (https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html) +// in the Amazon Web Services Telco Network Builder User Guide. Creating a function +// package is the first step for creating a network in AWS TNB. This request +// creates an empty container with an ID. The next step is to upload the actual +// CSAR zip file into that empty container. To upload function package content, see +// PutSolFunctionPackageContent (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html) +// . func (c *Client) CreateSolFunctionPackage(ctx context.Context, params *CreateSolFunctionPackageInput, optFns ...func(*Options)) (*CreateSolFunctionPackageOutput, error) { if params == nil { params = &CreateSolFunctionPackageInput{} diff --git a/service/tnb/api_op_CreateSolNetworkInstance.go b/service/tnb/api_op_CreateSolNetworkInstance.go index 9297586b509..02e6a8e300d 100644 --- a/service/tnb/api_op_CreateSolNetworkInstance.go +++ b/service/tnb/api_op_CreateSolNetworkInstance.go @@ -14,12 +14,11 @@ import ( // Amazon Web Services TNB that can be deployed and on which life-cycle operations // (like terminate, update, and delete) can be performed. Creating a network // instance is the third step after creating a network package. For more -// information about network instances, Network instances -// (https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html) in the Amazon -// Web Services Telco Network Builder User Guide. Once you create a network -// instance, you can instantiate it. To instantiate a network, see -// InstantiateSolNetworkInstance -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html). +// information about network instances, Network instances (https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html) +// in the Amazon Web Services Telco Network Builder User Guide. Once you create a +// network instance, you can instantiate it. To instantiate a network, see +// InstantiateSolNetworkInstance (https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html) +// . func (c *Client) CreateSolNetworkInstance(ctx context.Context, params *CreateSolNetworkInstanceInput, optFns ...func(*Options)) (*CreateSolNetworkInstanceOutput, error) { if params == nil { params = &CreateSolNetworkInstanceInput{} diff --git a/service/tnb/api_op_CreateSolNetworkPackage.go b/service/tnb/api_op_CreateSolNetworkPackage.go index 695b617cb20..18acbba57c6 100644 --- a/service/tnb/api_op_CreateSolNetworkPackage.go +++ b/service/tnb/api_op_CreateSolNetworkPackage.go @@ -14,17 +14,16 @@ import ( // Creates a network package. A network package is a .zip file in CSAR (Cloud // Service Archive) format defines the function packages you want to deploy and the // Amazon Web Services infrastructure you want to deploy them on. For more -// information, see Network instances -// (https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html) in the Amazon -// Web Services Telco Network Builder User Guide. A network package consists of a -// network service descriptor (NSD) file (required) and any additional files -// (optional), such as scripts specific to your needs. For example, if you have -// multiple function packages in your network package, you can use the NSD to -// define which network functions should run in certain VPCs, subnets, or EKS -// clusters. This request creates an empty network package container with an ID. -// Once you create a network package, you can upload the network package content -// using PutSolNetworkPackageContent -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html). +// information, see Network instances (https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html) +// in the Amazon Web Services Telco Network Builder User Guide. A network package +// consists of a network service descriptor (NSD) file (required) and any +// additional files (optional), such as scripts specific to your needs. For +// example, if you have multiple function packages in your network package, you can +// use the NSD to define which network functions should run in certain VPCs, +// subnets, or EKS clusters. This request creates an empty network package +// container with an ID. Once you create a network package, you can upload the +// network package content using PutSolNetworkPackageContent (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html) +// . func (c *Client) CreateSolNetworkPackage(ctx context.Context, params *CreateSolNetworkPackageInput, optFns ...func(*Options)) (*CreateSolNetworkPackageOutput, error) { if params == nil { params = &CreateSolNetworkPackageInput{} diff --git a/service/tnb/api_op_DeleteSolFunctionPackage.go b/service/tnb/api_op_DeleteSolFunctionPackage.go index 1ca8b7eefc9..6335494eea5 100644 --- a/service/tnb/api_op_DeleteSolFunctionPackage.go +++ b/service/tnb/api_op_DeleteSolFunctionPackage.go @@ -15,8 +15,8 @@ import ( // telecommunication application) and function package descriptor that uses the // TOSCA standard to describe how the network functions should run on your network. // To delete a function package, the package must be in a disabled state. To -// disable a function package, see UpdateSolFunctionPackage -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolFunctionPackage.html). +// disable a function package, see UpdateSolFunctionPackage (https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolFunctionPackage.html) +// . func (c *Client) DeleteSolFunctionPackage(ctx context.Context, params *DeleteSolFunctionPackageInput, optFns ...func(*Options)) (*DeleteSolFunctionPackageOutput, error) { if params == nil { params = &DeleteSolFunctionPackageInput{} diff --git a/service/tnb/api_op_DeleteSolNetworkInstance.go b/service/tnb/api_op_DeleteSolNetworkInstance.go index 789a7c98f2a..2a4d8ddc5c6 100644 --- a/service/tnb/api_op_DeleteSolNetworkInstance.go +++ b/service/tnb/api_op_DeleteSolNetworkInstance.go @@ -14,8 +14,8 @@ import ( // Amazon Web Services TNB that can be deployed and on which life-cycle operations // (like terminate, update, and delete) can be performed. To delete a network // instance, the instance must be in a stopped or terminated state. To terminate a -// network instance, see TerminateSolNetworkInstance -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_TerminateSolNetworkInstance.html). +// network instance, see TerminateSolNetworkInstance (https://docs.aws.amazon.com/tnb/latest/APIReference/API_TerminateSolNetworkInstance.html) +// . func (c *Client) DeleteSolNetworkInstance(ctx context.Context, params *DeleteSolNetworkInstanceInput, optFns ...func(*Options)) (*DeleteSolNetworkInstanceOutput, error) { if params == nil { params = &DeleteSolNetworkInstanceInput{} diff --git a/service/tnb/api_op_DeleteSolNetworkPackage.go b/service/tnb/api_op_DeleteSolNetworkPackage.go index e03139ef50b..c4b119297e9 100644 --- a/service/tnb/api_op_DeleteSolNetworkPackage.go +++ b/service/tnb/api_op_DeleteSolNetworkPackage.go @@ -10,12 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes network package. A network package is a .zip file in CSAR (Cloud Service -// Archive) format defines the function packages you want to deploy and the Amazon -// Web Services infrastructure you want to deploy them on. To delete a network -// package, the package must be in a disable state. To disable a network package, -// see UpdateSolNetworkPackage -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolNetworkPackage.html). +// Deletes network package. A network package is a .zip file in CSAR (Cloud +// Service Archive) format defines the function packages you want to deploy and the +// Amazon Web Services infrastructure you want to deploy them on. To delete a +// network package, the package must be in a disable state. To disable a network +// package, see UpdateSolNetworkPackage (https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolNetworkPackage.html) +// . func (c *Client) DeleteSolNetworkPackage(ctx context.Context, params *DeleteSolNetworkPackageInput, optFns ...func(*Options)) (*DeleteSolNetworkPackageOutput, error) { if params == nil { params = &DeleteSolNetworkPackageInput{} diff --git a/service/tnb/api_op_GetSolNetworkInstance.go b/service/tnb/api_op_GetSolNetworkInstance.go index eb0abedb626..0763dd63fcd 100644 --- a/service/tnb/api_op_GetSolNetworkInstance.go +++ b/service/tnb/api_op_GetSolNetworkInstance.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the details of the network instance. A network instance is a single network -// created in Amazon Web Services TNB that can be deployed and on which life-cycle -// operations (like terminate, update, and delete) can be performed. +// Gets the details of the network instance. A network instance is a single +// network created in Amazon Web Services TNB that can be deployed and on which +// life-cycle operations (like terminate, update, and delete) can be performed. func (c *Client) GetSolNetworkInstance(ctx context.Context, params *GetSolNetworkInstanceInput, optFns ...func(*Options)) (*GetSolNetworkInstanceOutput, error) { if params == nil { params = &GetSolNetworkInstanceInput{} diff --git a/service/tnb/api_op_GetSolNetworkPackageContent.go b/service/tnb/api_op_GetSolNetworkPackageContent.go index 29117fb3098..1ed9400beb7 100644 --- a/service/tnb/api_op_GetSolNetworkPackageContent.go +++ b/service/tnb/api_op_GetSolNetworkPackageContent.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the contents of a network package. A network package is a .zip file in CSAR -// (Cloud Service Archive) format defines the function packages you want to deploy -// and the Amazon Web Services infrastructure you want to deploy them on. +// Gets the contents of a network package. A network package is a .zip file in +// CSAR (Cloud Service Archive) format defines the function packages you want to +// deploy and the Amazon Web Services infrastructure you want to deploy them on. func (c *Client) GetSolNetworkPackageContent(ctx context.Context, params *GetSolNetworkPackageContentInput, optFns ...func(*Options)) (*GetSolNetworkPackageContentOutput, error) { if params == nil { params = &GetSolNetworkPackageContentInput{} diff --git a/service/tnb/api_op_GetSolNetworkPackageDescriptor.go b/service/tnb/api_op_GetSolNetworkPackageDescriptor.go index fed7f53959a..6a6671ffc0a 100644 --- a/service/tnb/api_op_GetSolNetworkPackageDescriptor.go +++ b/service/tnb/api_op_GetSolNetworkPackageDescriptor.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the content of the network service descriptor. A network service descriptor -// is a .yaml file in a network package that uses the TOSCA standard to describe -// the network functions you want to deploy and the Amazon Web Services +// Gets the content of the network service descriptor. A network service +// descriptor is a .yaml file in a network package that uses the TOSCA standard to +// describe the network functions you want to deploy and the Amazon Web Services // infrastructure you want to deploy the network functions on. func (c *Client) GetSolNetworkPackageDescriptor(ctx context.Context, params *GetSolNetworkPackageDescriptorInput, optFns ...func(*Options)) (*GetSolNetworkPackageDescriptorOutput, error) { if params == nil { diff --git a/service/tnb/api_op_InstantiateSolNetworkInstance.go b/service/tnb/api_op_InstantiateSolNetworkInstance.go index fc8ddbc590b..2611e3b8166 100644 --- a/service/tnb/api_op_InstantiateSolNetworkInstance.go +++ b/service/tnb/api_op_InstantiateSolNetworkInstance.go @@ -15,8 +15,8 @@ import ( // in Amazon Web Services TNB that can be deployed and on which life-cycle // operations (like terminate, update, and delete) can be performed. Before you can // instantiate a network instance, you have to create a network instance. For more -// information, see CreateSolNetworkInstance -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_CreateSolNetworkInstance.html). +// information, see CreateSolNetworkInstance (https://docs.aws.amazon.com/tnb/latest/APIReference/API_CreateSolNetworkInstance.html) +// . func (c *Client) InstantiateSolNetworkInstance(ctx context.Context, params *InstantiateSolNetworkInstanceInput, optFns ...func(*Options)) (*InstantiateSolNetworkInstanceOutput, error) { if params == nil { params = &InstantiateSolNetworkInstanceInput{} @@ -44,8 +44,8 @@ type InstantiateSolNetworkInstanceInput struct { // A check for whether you have the required permissions for the action without // actually making the request and provides an error response. If you have the - // required permissions, the error response is DryRunOperation. Otherwise, it is - // UnauthorizedOperation. + // required permissions, the error response is DryRunOperation . Otherwise, it is + // UnauthorizedOperation . DryRun *bool // A tag is a label that you assign to an Amazon Web Services resource. Each tag diff --git a/service/tnb/api_op_ListSolFunctionInstances.go b/service/tnb/api_op_ListSolFunctionInstances.go index e9d485d6e60..a39d3abb537 100644 --- a/service/tnb/api_op_ListSolFunctionInstances.go +++ b/service/tnb/api_op_ListSolFunctionInstances.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists network function instances. A network function instance is a function in a -// function package . +// Lists network function instances. A network function instance is a function in +// a function package . func (c *Client) ListSolFunctionInstances(ctx context.Context, params *ListSolFunctionInstancesInput, optFns ...func(*Options)) (*ListSolFunctionInstancesOutput, error) { if params == nil { params = &ListSolFunctionInstancesInput{} diff --git a/service/tnb/api_op_ListSolNetworkOperations.go b/service/tnb/api_op_ListSolNetworkOperations.go index 4d3b2d8d5c1..48624bba168 100644 --- a/service/tnb/api_op_ListSolNetworkOperations.go +++ b/service/tnb/api_op_ListSolNetworkOperations.go @@ -43,8 +43,8 @@ type ListSolNetworkOperationsInput struct { type ListSolNetworkOperationsOutput struct { - // Lists network operation occurrences. Lifecycle management operations are deploy, - // update, or delete operations. + // Lists network operation occurrences. Lifecycle management operations are + // deploy, update, or delete operations. NetworkOperations []types.ListSolNetworkOperationsInfo // The token to use to retrieve the next page of results. This value is null when diff --git a/service/tnb/api_op_PutSolFunctionPackageContent.go b/service/tnb/api_op_PutSolFunctionPackageContent.go index 5d81f4fa39e..71b9a9564d7 100644 --- a/service/tnb/api_op_PutSolFunctionPackageContent.go +++ b/service/tnb/api_op_PutSolFunctionPackageContent.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads the contents of a function package. A function package is a .zip file in -// CSAR (Cloud Service Archive) format that contains a network function (an ETSI +// Uploads the contents of a function package. A function package is a .zip file +// in CSAR (Cloud Service Archive) format that contains a network function (an ETSI // standard telecommunication application) and function package descriptor that // uses the TOSCA standard to describe how the network functions should run on your // network. diff --git a/service/tnb/api_op_TerminateSolNetworkInstance.go b/service/tnb/api_op_TerminateSolNetworkInstance.go index ba395c0ac6b..5a7c008064c 100644 --- a/service/tnb/api_op_TerminateSolNetworkInstance.go +++ b/service/tnb/api_op_TerminateSolNetworkInstance.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Terminates a network instance. A network instance is a single network created in -// Amazon Web Services TNB that can be deployed and on which life-cycle operations -// (like terminate, update, and delete) can be performed. You must terminate a -// network instance before you can delete it. +// Terminates a network instance. A network instance is a single network created +// in Amazon Web Services TNB that can be deployed and on which life-cycle +// operations (like terminate, update, and delete) can be performed. You must +// terminate a network instance before you can delete it. func (c *Client) TerminateSolNetworkInstance(ctx context.Context, params *TerminateSolNetworkInstanceInput, optFns ...func(*Options)) (*TerminateSolNetworkInstanceOutput, error) { if params == nil { params = &TerminateSolNetworkInstanceInput{} diff --git a/service/tnb/api_op_ValidateSolFunctionPackageContent.go b/service/tnb/api_op_ValidateSolFunctionPackageContent.go index c5e31a420a8..68bc3bab770 100644 --- a/service/tnb/api_op_ValidateSolFunctionPackageContent.go +++ b/service/tnb/api_op_ValidateSolFunctionPackageContent.go @@ -12,9 +12,8 @@ import ( ) // Validates function package content. This can be used as a dry run before -// uploading function package content with PutSolFunctionPackageContent -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html). -// A function package is a .zip file in CSAR (Cloud Service Archive) format that +// uploading function package content with PutSolFunctionPackageContent (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html) +// . A function package is a .zip file in CSAR (Cloud Service Archive) format that // contains a network function (an ETSI standard telecommunication application) and // function package descriptor that uses the TOSCA standard to describe how the // network functions should run on your network. diff --git a/service/tnb/api_op_ValidateSolNetworkPackageContent.go b/service/tnb/api_op_ValidateSolNetworkPackageContent.go index ab21ddf43a2..a752e97110f 100644 --- a/service/tnb/api_op_ValidateSolNetworkPackageContent.go +++ b/service/tnb/api_op_ValidateSolNetworkPackageContent.go @@ -12,10 +12,9 @@ import ( ) // Validates network package content. This can be used as a dry run before -// uploading network package content with PutSolNetworkPackageContent -// (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html). -// A network package is a .zip file in CSAR (Cloud Service Archive) format defines -// the function packages you want to deploy and the Amazon Web Services +// uploading network package content with PutSolNetworkPackageContent (https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html) +// . A network package is a .zip file in CSAR (Cloud Service Archive) format +// defines the function packages you want to deploy and the Amazon Web Services // infrastructure you want to deploy them on. func (c *Client) ValidateSolNetworkPackageContent(ctx context.Context, params *ValidateSolNetworkPackageContentInput, optFns ...func(*Options)) (*ValidateSolNetworkPackageContentOutput, error) { if params == nil { diff --git a/service/tnb/document/document.go b/service/tnb/document/document.go index 9bc08777570..eded7416680 100644 --- a/service/tnb/document/document.go +++ b/service/tnb/document/document.go @@ -11,9 +11,9 @@ import ( // precision numbers, booleans, nulls, a list of these values, and a map of UTF-8 // strings to these values. // -// You create a document type using the NewLazyDocument function and passing it the -// Go type to marshal. When receiving a document in an API response, you use the -// document's UnmarshalSmithyDocument function to decode the response to your +// You create a document type using the NewLazyDocument function and passing it +// the Go type to marshal. When receiving a document in an API response, you use +// the document's UnmarshalSmithyDocument function to decode the response to your // desired Go type. Unless documented specifically generated structure types in // client packages or client types packages are not supported at this time. Such // types embed a noSmithyDocumentSerde and will cause an error to be returned when diff --git a/service/tnb/types/enums.go b/service/tnb/types/enums.go index 74f4f9ac613..4f5af13b0ed 100644 --- a/service/tnb/types/enums.go +++ b/service/tnb/types/enums.go @@ -9,8 +9,8 @@ const ( DescriptorContentTypeTextPlain DescriptorContentType = "text/plain" ) -// Values returns all known values for DescriptorContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DescriptorContentType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DescriptorContentType) Values() []DescriptorContentType { return []DescriptorContentType{ @@ -272,8 +272,8 @@ const ( VnfInstantiationStateNotInstantiated VnfInstantiationState = "NOT_INSTANTIATED" ) -// Values returns all known values for VnfInstantiationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for VnfInstantiationState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (VnfInstantiationState) Values() []VnfInstantiationState { return []VnfInstantiationState{ diff --git a/service/tnb/types/types.go b/service/tnb/types/types.go index 7b7eb27897b..0fb5113dbc6 100644 --- a/service/tnb/types/types.go +++ b/service/tnb/types/types.go @@ -219,8 +219,8 @@ type LcmOperationInfo struct { noSmithyDocumentSerde } -// Lists information about a network function instance. A network function instance -// is a function in a function package . +// Lists information about a network function instance. A network function +// instance is a function in a function package . type ListSolFunctionInstanceInfo struct { // Network function instance ARN. @@ -351,9 +351,9 @@ type ListSolFunctionPackageMetadata struct { noSmithyDocumentSerde } -// Info about the specific network instance. A network instance is a single network -// created in Amazon Web Services TNB that can be deployed and on which life-cycle -// operations (like terminate, update, and delete) can be performed. +// Info about the specific network instance. A network instance is a single +// network created in Amazon Web Services TNB that can be deployed and on which +// life-cycle operations (like terminate, update, and delete) can be performed. type ListSolNetworkInstanceInfo struct { // Network instance ARN. @@ -571,8 +571,8 @@ type ProblemDetails struct { noSmithyDocumentSerde } -// Update metadata in a function package. A function package is a .zip file in CSAR -// (Cloud Service Archive) format that contains a network function (an ETSI +// Update metadata in a function package. A function package is a .zip file in +// CSAR (Cloud Service Archive) format that contains a network function (an ETSI // standard telecommunication application) and function package descriptor that // uses the TOSCA standard to describe how the network functions should run on your // network. @@ -613,8 +613,8 @@ type ToscaOverride struct { // function. A network function instance is a function in a function package . type UpdateSolNetworkModify struct { - // Provides values for the configurable properties declared in the function package - // descriptor. + // Provides values for the configurable properties declared in the function + // package descriptor. // // This member is required. VnfConfigurableProperties document.Interface diff --git a/service/transcribe/api_client.go b/service/transcribe/api_client.go index b5baf05f944..74be9ee2ba9 100644 --- a/service/transcribe/api_client.go +++ b/service/transcribe/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/transcribe/api_op_CreateCallAnalyticsCategory.go b/service/transcribe/api_op_CreateCallAnalyticsCategory.go index c2fdf59e266..698131ca69a 100644 --- a/service/transcribe/api_op_CreateCallAnalyticsCategory.go +++ b/service/transcribe/api_op_CreateCallAnalyticsCategory.go @@ -18,15 +18,14 @@ import ( // category, you can use the InputType parameter to label the category as a // POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to // post-call transcriptions and REAL_TIME categories can only be applied to -// real-time transcriptions. If you do not include InputType, your category is +// real-time transcriptions. If you do not include InputType , your category is // created as a POST_CALL category by default. Call Analytics categories are // composed of rules. For each category, you must create between 1 and 20 rules. // Rules can include these parameters: , , , and . To update an existing category, -// see . To learn more about Call Analytics categories, see Creating categories for -// post-call transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and -// Creating categories for real-time transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html). +// see . To learn more about Call Analytics categories, see Creating categories +// for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) +// and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html) +// . func (c *Client) CreateCallAnalyticsCategory(ctx context.Context, params *CreateCallAnalyticsCategoryInput, optFns ...func(*Options)) (*CreateCallAnalyticsCategoryOutput, error) { if params == nil { params = &CreateCallAnalyticsCategoryInput{} @@ -46,8 +45,8 @@ type CreateCallAnalyticsCategoryInput struct { // A unique name, chosen by you, for your Call Analytics category. It's helpful to // use a detailed naming system that will make sense to you in the future. For - // example, it's better to use sentiment-positive-last30seconds for a category over - // a generic name like test-category. Category names are case sensitive. + // example, it's better to use sentiment-positive-last30seconds for a category + // over a generic name like test-category . Category names are case sensitive. // // This member is required. CategoryName *string @@ -64,10 +63,10 @@ type CreateCallAnalyticsCategoryInput struct { // Choose whether you want to create a real-time or a post-call category for your // Call Analytics transcription. Specifying POST_CALL assigns your category to // post-call transcriptions; categories with this input type cannot be applied to - // streaming (real-time) transcriptions. Specifying REAL_TIME assigns your category - // to streaming transcriptions; categories with this input type cannot be applied - // to post-call transcriptions. If you do not include InputType, your category is - // created as a post-call category by default. + // streaming (real-time) transcriptions. Specifying REAL_TIME assigns your + // category to streaming transcriptions; categories with this input type cannot be + // applied to post-call transcriptions. If you do not include InputType , your + // category is created as a post-call category by default. InputType types.InputType noSmithyDocumentSerde diff --git a/service/transcribe/api_op_CreateLanguageModel.go b/service/transcribe/api_op_CreateLanguageModel.go index 150e208893e..9cc97ddc8b2 100644 --- a/service/transcribe/api_op_CreateLanguageModel.go +++ b/service/transcribe/api_op_CreateLanguageModel.go @@ -13,17 +13,12 @@ import ( // Creates a new custom language model. When creating a new custom language model, // you must specify: -// -// * If you want a Wideband (audio sample rates over 16,000 Hz) -// or Narrowband (audio sample rates under 16,000 Hz) base model -// -// * The location of -// your training and tuning files (this must be an Amazon S3 URI) -// -// * The language -// of your model -// -// * A unique name for your model +// - If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband +// (audio sample rates under 16,000 Hz) base model +// - The location of your training and tuning files (this must be an Amazon S3 +// URI) +// - The language of your model +// - A unique name for your model func (c *Client) CreateLanguageModel(ctx context.Context, params *CreateLanguageModelInput, optFns ...func(*Options)) (*CreateLanguageModelOutput, error) { if params == nil { params = &CreateLanguageModelInput{} @@ -44,18 +39,18 @@ type CreateLanguageModelInput struct { // The Amazon Transcribe standard language model, or base model, used to create // your custom language model. Amazon Transcribe offers two options for base // models: Wideband and Narrowband. If the audio you want to transcribe has a - // sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a - // sample rate less than 16,000 Hz, choose NarrowBand. + // sample rate of 16,000 Hz or greater, choose WideBand . To transcribe audio with + // a sample rate less than 16,000 Hz, choose NarrowBand . // // This member is required. BaseModelName types.BaseModelName - // Contains the Amazon S3 location of the training data you want to use to create a - // new custom language model, and permissions to access this location. When using - // InputDataConfig, you must include these sub-parameters: S3Uri, which is the - // Amazon S3 location of your training data, and DataAccessRoleArn, which is the + // Contains the Amazon S3 location of the training data you want to use to create + // a new custom language model, and permissions to access this location. When using + // InputDataConfig , you must include these sub-parameters: S3Uri , which is the + // Amazon S3 location of your training data, and DataAccessRoleArn , which is the // Amazon Resource Name (ARN) of the role that has permission to access your - // specified Amazon S3 location. You can optionally include TuningDataS3Uri, which + // specified Amazon S3 location. You can optionally include TuningDataS3Uri , which // is the Amazon S3 location of your tuning data. If you specify different Amazon // S3 locations for training and tuning data, the ARN you use must have permissions // to access both locations. @@ -67,12 +62,11 @@ type CreateLanguageModelInput struct { // language model must contain terms in only one language, and the language you // select for your custom language model must match the language of your training // and tuning data. For a list of supported languages and their associated language - // codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // table. Note that US English (en-US) is the only language supported with Amazon + // codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. Note that US English ( en-US ) is the only language supported with Amazon // Transcribe Medical. A custom language model can only be used to transcribe files // in the same language as the model. For example, if you create a custom language - // model using US English (en-US), you can only apply this model to files that + // model using US English ( en-US ), you can only apply this model to files that // contain English audio. // // This member is required. @@ -88,8 +82,8 @@ type CreateLanguageModelInput struct { // Adds one or more custom tags, each in the form of a key:value pair, to a new // custom language model at the time you create this new model. To learn more about - // using tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -97,13 +91,13 @@ type CreateLanguageModelInput struct { type CreateLanguageModelOutput struct { - // The Amazon Transcribe standard language model, or base model, you specified when - // creating your custom language model. + // The Amazon Transcribe standard language model, or base model, you specified + // when creating your custom language model. BaseModelName types.BaseModelName // Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 - // locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) - // data. + // locations you provided for your training ( S3Uri ) and tuning ( TuningDataS3Uri + // ) data. InputDataConfig *types.InputDataConfig // The language code you selected for your custom language model. @@ -112,8 +106,8 @@ type CreateLanguageModelOutput struct { // The name of your custom language model. ModelName *string - // The status of your custom language model. When the status displays as COMPLETED, - // your model is ready to use. + // The status of your custom language model. When the status displays as COMPLETED + // , your model is ready to use. ModelStatus types.ModelStatus // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_CreateMedicalVocabulary.go b/service/transcribe/api_op_CreateMedicalVocabulary.go index 7fbad030c60..cf36802cd12 100644 --- a/service/transcribe/api_op_CreateMedicalVocabulary.go +++ b/service/transcribe/api_op_CreateMedicalVocabulary.go @@ -20,10 +20,10 @@ import ( // vocabularies in table format. Each language has a character set that contains // all allowed characters for that specific language. If you use unsupported // characters, your custom vocabulary request fails. Refer to Character Sets for -// Custom Vocabularies -// (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the -// character set for your language. For more information, see Custom vocabularies -// (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). +// Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. For more information, see Custom +// vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) +// . func (c *Client) CreateMedicalVocabulary(ctx context.Context, params *CreateMedicalVocabularyInput, optFns ...func(*Options)) (*CreateMedicalVocabularyOutput, error) { if params == nil { params = &CreateMedicalVocabularyInput{} @@ -42,7 +42,7 @@ func (c *Client) CreateMedicalVocabulary(ctx context.Context, params *CreateMedi type CreateMedicalVocabularyInput struct { // The language code that represents the language of the entries in your custom - // vocabulary. US English (en-US) is the only language supported with Amazon + // vocabulary. US English ( en-US ) is the only language supported with Amazon // Transcribe Medical. // // This member is required. @@ -67,8 +67,8 @@ type CreateMedicalVocabularyInput struct { // Adds one or more custom tags, each in the form of a key:value pair, to a new // custom medical vocabulary at the time you create this new custom vocabulary. To - // learn more about using tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // learn more about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -76,24 +76,24 @@ type CreateMedicalVocabularyInput struct { type CreateMedicalVocabularyOutput struct { - // If VocabularyState is FAILED, FailureReason contains information about why the - // medical transcription job request failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If VocabularyState is FAILED , FailureReason contains information about why the + // medical transcription job request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string - // The language code you selected for your custom medical vocabulary. US English - // (en-US) is the only language supported with Amazon Transcribe Medical. + // The language code you selected for your custom medical vocabulary. US English ( + // en-US ) is the only language supported with Amazon Transcribe Medical. LanguageCode types.LanguageCode // The date and time you created your custom medical vocabulary. Timestamps are in - // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name you chose for your custom medical vocabulary. VocabularyName *string - // The processing state of your custom medical vocabulary. If the state is READY, + // The processing state of your custom medical vocabulary. If the state is READY , // you can use the custom vocabulary in a StartMedicalTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_CreateVocabulary.go b/service/transcribe/api_op_CreateVocabulary.go index bc7e30d5967..9a16750230f 100644 --- a/service/transcribe/api_op_CreateVocabulary.go +++ b/service/transcribe/api_op_CreateVocabulary.go @@ -18,10 +18,10 @@ import ( // a list of terms directly in your request using the Phrases flag. Each language // has a character set that contains all allowed characters for that specific // language. If you use unsupported characters, your custom vocabulary request -// fails. Refer to Character Sets for Custom Vocabularies -// (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the -// character set for your language. For more information, see Custom vocabularies -// (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). +// fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. For more information, see Custom +// vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) +// . func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyInput, optFns ...func(*Options)) (*CreateVocabularyOutput, error) { if params == nil { params = &CreateVocabularyInput{} @@ -43,10 +43,9 @@ type CreateVocabularyInput struct { // vocabulary. Each custom vocabulary must contain terms in only one language. A // custom vocabulary can only be used to transcribe files in the same language as // the custom vocabulary. For example, if you create a custom vocabulary using US - // English (en-US), you can only apply this custom vocabulary to files that contain - // English audio. For a list of supported languages and their associated language - // codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // English ( en-US ), you can only apply this custom vocabulary to files that + // contain English audio. For a list of supported languages and their associated + // language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. // // This member is required. @@ -60,33 +59,32 @@ type CreateVocabularyInput struct { // This member is required. VocabularyName *string - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files (in this case, your custom + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files (in this case, your custom // vocabulary). If the role that you specify doesn’t have the appropriate // permissions to access the specified Amazon S3 location, your request fails. IAM - // role ARNs have the format arn:partition:iam::account:role/role-name-with-path. - // For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM - // ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // role ARNs have the format arn:partition:iam::account:role/role-name-with-path . + // For example: arn:aws:iam::111122223333:role/Admin . For more information, see + // IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . DataAccessRoleArn *string - // Use this parameter if you want to create your custom vocabulary by including all - // desired terms, as comma-separated values, within your request. The other option - // for creating your custom vocabulary is to save your entries in a text file and - // upload them to an Amazon S3 bucket, then specify the location of your file using - // the VocabularyFileUri parameter. Note that if you include Phrases in your - // request, you cannot use VocabularyFileUri; you must choose one or the other. - // Each language has a character set that contains all allowed characters for that - // specific language. If you use unsupported characters, your custom vocabulary - // filter request fails. Refer to Character Sets for Custom Vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the - // character set for your language. + // Use this parameter if you want to create your custom vocabulary by including + // all desired terms, as comma-separated values, within your request. The other + // option for creating your custom vocabulary is to save your entries in a text + // file and upload them to an Amazon S3 bucket, then specify the location of your + // file using the VocabularyFileUri parameter. Note that if you include Phrases in + // your request, you cannot use VocabularyFileUri ; you must choose one or the + // other. Each language has a character set that contains all allowed characters + // for that specific language. If you use unsupported characters, your custom + // vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. Phrases []string // Adds one or more custom tags, each in the form of a key:value pair, to a new // custom vocabulary at the time you create this new custom vocabulary. To learn - // more about using tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // more about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag // The Amazon S3 location of the text file that contains your custom vocabulary. @@ -102,23 +100,23 @@ type CreateVocabularyInput struct { type CreateVocabularyOutput struct { - // If VocabularyState is FAILED, FailureReason contains information about why the - // custom vocabulary request failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If VocabularyState is FAILED , FailureReason contains information about why the + // custom vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string // The language code you selected for your custom vocabulary. LanguageCode types.LanguageCode // The date and time you created your custom vocabulary. Timestamps are in the - // format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name you chose for your custom vocabulary. VocabularyName *string - // The processing state of your custom vocabulary. If the state is READY, you can + // The processing state of your custom vocabulary. If the state is READY , you can // use the custom vocabulary in a StartTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_CreateVocabularyFilter.go b/service/transcribe/api_op_CreateVocabularyFilter.go index cb37949fe8d..3efb02ca689 100644 --- a/service/transcribe/api_op_CreateVocabularyFilter.go +++ b/service/transcribe/api_op_CreateVocabularyFilter.go @@ -12,15 +12,15 @@ import ( "time" ) -// Creates a new custom vocabulary filter. You can use custom vocabulary filters to -// mask, delete, or flag specific words from your transcript. Custom vocabulary +// Creates a new custom vocabulary filter. You can use custom vocabulary filters +// to mask, delete, or flag specific words from your transcript. Custom vocabulary // filters are commonly used to mask profanity in transcripts. Each language has a // character set that contains all allowed characters for that specific language. // If you use unsupported characters, your custom vocabulary filter request fails. -// Refer to Character Sets for Custom Vocabularies -// (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the -// character set for your language. For more information, see Vocabulary filtering -// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). +// Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. For more information, see +// Vocabulary filtering (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) +// . func (c *Client) CreateVocabularyFilter(ctx context.Context, params *CreateVocabularyFilterInput, optFns ...func(*Options)) (*CreateVocabularyFilterOutput, error) { if params == nil { params = &CreateVocabularyFilterInput{} @@ -38,14 +38,13 @@ func (c *Client) CreateVocabularyFilter(ctx context.Context, params *CreateVocab type CreateVocabularyFilterInput struct { - // The language code that represents the language of the entries in your vocabulary - // filter. Each custom vocabulary filter must contain terms in only one language. A - // custom vocabulary filter can only be used to transcribe files in the same - // language as the filter. For example, if you create a custom vocabulary filter - // using US English (en-US), you can only apply this filter to files that contain - // English audio. For a list of supported languages and their associated language - // codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // The language code that represents the language of the entries in your + // vocabulary filter. Each custom vocabulary filter must contain terms in only one + // language. A custom vocabulary filter can only be used to transcribe files in the + // same language as the filter. For example, if you create a custom vocabulary + // filter using US English ( en-US ), you can only apply this filter to files that + // contain English audio. For a list of supported languages and their associated + // language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. // // This member is required. @@ -60,27 +59,27 @@ type CreateVocabularyFilterInput struct { // This member is required. VocabularyFilterName *string - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files (in this case, your custom + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files (in this case, your custom // vocabulary filter). If the role that you specify doesn’t have the appropriate // permissions to access the specified Amazon S3 location, your request fails. IAM - // role ARNs have the format arn:partition:iam::account:role/role-name-with-path. - // For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM - // ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // role ARNs have the format arn:partition:iam::account:role/role-name-with-path . + // For example: arn:aws:iam::111122223333:role/Admin . For more information, see + // IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . DataAccessRoleArn *string // Adds one or more custom tags, each in the form of a key:value pair, to a new // custom vocabulary filter at the time you create this new vocabulary filter. To - // learn more about using tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // learn more about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag // The Amazon S3 location of the text file that contains your custom vocabulary // filter terms. The URI must be located in the same Amazon Web Services Region as // the resource you're calling. Here's an example URI path: // s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include - // VocabularyFilterFileUri in your request, you cannot use Words; you must choose + // VocabularyFilterFileUri in your request, you cannot use Words ; you must choose // one or the other. VocabularyFilterFileUri *string @@ -89,7 +88,7 @@ type CreateVocabularyFilterInput struct { // other option for creating your vocabulary filter is to save your entries in a // text file and upload them to an Amazon S3 bucket, then specify the location of // your file using the VocabularyFilterFileUri parameter. Note that if you include - // Words in your request, you cannot use VocabularyFilterFileUri; you must choose + // Words in your request, you cannot use VocabularyFilterFileUri ; you must choose // one or the other. Each language has a character set that contains all allowed // characters for that specific language. If you use unsupported characters, your // custom vocabulary filter request fails. Refer to Character Sets for Custom @@ -106,7 +105,7 @@ type CreateVocabularyFilterOutput struct { LanguageCode types.LanguageCode // The date and time you created your custom vocabulary filter. Timestamps are in - // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time diff --git a/service/transcribe/api_op_DeleteCallAnalyticsCategory.go b/service/transcribe/api_op_DeleteCallAnalyticsCategory.go index a8feb3dd64b..bea5268a82a 100644 --- a/service/transcribe/api_op_DeleteCallAnalyticsCategory.go +++ b/service/transcribe/api_op_DeleteCallAnalyticsCategory.go @@ -11,7 +11,7 @@ import ( ) // Deletes a Call Analytics category. To use this operation, specify the name of -// the category you want to delete using CategoryName. Category names are case +// the category you want to delete using CategoryName . Category names are case // sensitive. func (c *Client) DeleteCallAnalyticsCategory(ctx context.Context, params *DeleteCallAnalyticsCategoryInput, optFns ...func(*Options)) (*DeleteCallAnalyticsCategoryOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_DeleteCallAnalyticsJob.go b/service/transcribe/api_op_DeleteCallAnalyticsJob.go index 36b40f7c288..8b6c8716faa 100644 --- a/service/transcribe/api_op_DeleteCallAnalyticsJob.go +++ b/service/transcribe/api_op_DeleteCallAnalyticsJob.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Call Analytics job. To use this operation, specify the name of the job -// you want to delete using CallAnalyticsJobName. Job names are case sensitive. +// Deletes a Call Analytics job. To use this operation, specify the name of the +// job you want to delete using CallAnalyticsJobName . Job names are case sensitive. func (c *Client) DeleteCallAnalyticsJob(ctx context.Context, params *DeleteCallAnalyticsJobInput, optFns ...func(*Options)) (*DeleteCallAnalyticsJobOutput, error) { if params == nil { params = &DeleteCallAnalyticsJobInput{} diff --git a/service/transcribe/api_op_DeleteLanguageModel.go b/service/transcribe/api_op_DeleteLanguageModel.go index b7a5cace468..f3bfd3f4c57 100644 --- a/service/transcribe/api_op_DeleteLanguageModel.go +++ b/service/transcribe/api_op_DeleteLanguageModel.go @@ -11,7 +11,7 @@ import ( ) // Deletes a custom language model. To use this operation, specify the name of the -// language model you want to delete using ModelName. custom language model names +// language model you want to delete using ModelName . custom language model names // are case sensitive. func (c *Client) DeleteLanguageModel(ctx context.Context, params *DeleteLanguageModelInput, optFns ...func(*Options)) (*DeleteLanguageModelOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_DeleteMedicalTranscriptionJob.go b/service/transcribe/api_op_DeleteMedicalTranscriptionJob.go index 796eb7f6bd7..566fcbf84fd 100644 --- a/service/transcribe/api_op_DeleteMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_DeleteMedicalTranscriptionJob.go @@ -11,8 +11,8 @@ import ( ) // Deletes a medical transcription job. To use this operation, specify the name of -// the job you want to delete using MedicalTranscriptionJobName. Job names are case -// sensitive. +// the job you want to delete using MedicalTranscriptionJobName . Job names are +// case sensitive. func (c *Client) DeleteMedicalTranscriptionJob(ctx context.Context, params *DeleteMedicalTranscriptionJobInput, optFns ...func(*Options)) (*DeleteMedicalTranscriptionJobOutput, error) { if params == nil { params = &DeleteMedicalTranscriptionJobInput{} @@ -30,8 +30,8 @@ func (c *Client) DeleteMedicalTranscriptionJob(ctx context.Context, params *Dele type DeleteMedicalTranscriptionJobInput struct { - // The name of the medical transcription job you want to delete. Job names are case - // sensitive. + // The name of the medical transcription job you want to delete. Job names are + // case sensitive. // // This member is required. MedicalTranscriptionJobName *string diff --git a/service/transcribe/api_op_DeleteMedicalVocabulary.go b/service/transcribe/api_op_DeleteMedicalVocabulary.go index 660de552238..d932739de71 100644 --- a/service/transcribe/api_op_DeleteMedicalVocabulary.go +++ b/service/transcribe/api_op_DeleteMedicalVocabulary.go @@ -11,8 +11,8 @@ import ( ) // Deletes a custom medical vocabulary. To use this operation, specify the name of -// the custom vocabulary you want to delete using VocabularyName. Custom vocabulary -// names are case sensitive. +// the custom vocabulary you want to delete using VocabularyName . Custom +// vocabulary names are case sensitive. func (c *Client) DeleteMedicalVocabulary(ctx context.Context, params *DeleteMedicalVocabularyInput, optFns ...func(*Options)) (*DeleteMedicalVocabularyOutput, error) { if params == nil { params = &DeleteMedicalVocabularyInput{} diff --git a/service/transcribe/api_op_DeleteTranscriptionJob.go b/service/transcribe/api_op_DeleteTranscriptionJob.go index 95545e570b5..2cae43c91ca 100644 --- a/service/transcribe/api_op_DeleteTranscriptionJob.go +++ b/service/transcribe/api_op_DeleteTranscriptionJob.go @@ -11,7 +11,7 @@ import ( ) // Deletes a transcription job. To use this operation, specify the name of the job -// you want to delete using TranscriptionJobName. Job names are case sensitive. +// you want to delete using TranscriptionJobName . Job names are case sensitive. func (c *Client) DeleteTranscriptionJob(ctx context.Context, params *DeleteTranscriptionJobInput, optFns ...func(*Options)) (*DeleteTranscriptionJobOutput, error) { if params == nil { params = &DeleteTranscriptionJobInput{} diff --git a/service/transcribe/api_op_DeleteVocabulary.go b/service/transcribe/api_op_DeleteVocabulary.go index a599fa127e2..66c10d4a040 100644 --- a/service/transcribe/api_op_DeleteVocabulary.go +++ b/service/transcribe/api_op_DeleteVocabulary.go @@ -11,7 +11,7 @@ import ( ) // Deletes a custom vocabulary. To use this operation, specify the name of the -// custom vocabulary you want to delete using VocabularyName. Custom vocabulary +// custom vocabulary you want to delete using VocabularyName . Custom vocabulary // names are case sensitive. func (c *Client) DeleteVocabulary(ctx context.Context, params *DeleteVocabularyInput, optFns ...func(*Options)) (*DeleteVocabularyOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_DeleteVocabularyFilter.go b/service/transcribe/api_op_DeleteVocabularyFilter.go index 39bd86f1b07..04b03c34ed0 100644 --- a/service/transcribe/api_op_DeleteVocabularyFilter.go +++ b/service/transcribe/api_op_DeleteVocabularyFilter.go @@ -11,7 +11,7 @@ import ( ) // Deletes a custom vocabulary filter. To use this operation, specify the name of -// the custom vocabulary filter you want to delete using VocabularyFilterName. +// the custom vocabulary filter you want to delete using VocabularyFilterName . // Custom vocabulary filter names are case sensitive. func (c *Client) DeleteVocabularyFilter(ctx context.Context, params *DeleteVocabularyFilterInput, optFns ...func(*Options)) (*DeleteVocabularyFilterOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_GetCallAnalyticsCategory.go b/service/transcribe/api_op_GetCallAnalyticsCategory.go index c58d7e2e21d..6a0d215980c 100644 --- a/service/transcribe/api_op_GetCallAnalyticsCategory.go +++ b/service/transcribe/api_op_GetCallAnalyticsCategory.go @@ -41,8 +41,8 @@ type GetCallAnalyticsCategoryInput struct { type GetCallAnalyticsCategoryOutput struct { - // Provides you with the properties of the Call Analytics category you specified in - // your GetCallAnalyticsCategory request. + // Provides you with the properties of the Call Analytics category you specified + // in your GetCallAnalyticsCategory request. CategoryProperties *types.CategoryProperties // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_GetCallAnalyticsJob.go b/service/transcribe/api_op_GetCallAnalyticsJob.go index 552f513722b..138de083117 100644 --- a/service/transcribe/api_op_GetCallAnalyticsJob.go +++ b/service/transcribe/api_op_GetCallAnalyticsJob.go @@ -12,14 +12,14 @@ import ( ) // Provides information about the specified Call Analytics job. To view the job's -// status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is -// finished. You can find your completed transcript at the URI specified in -// TranscriptFileUri. If the status is FAILED, FailureReason provides details on +// status, refer to CallAnalyticsJobStatus . If the status is COMPLETED , the job +// is finished. You can find your completed transcript at the URI specified in +// TranscriptFileUri . If the status is FAILED , FailureReason provides details on // why your transcription job failed. If you enabled personally identifiable // information (PII) redaction, the redacted transcript appears at the location -// specified in RedactedTranscriptFileUri. If you chose to redact the audio in your -// media file, you can find your redacted media file at the location specified in -// RedactedMediaFileUri. To get a list of your Call Analytics jobs, use the +// specified in RedactedTranscriptFileUri . If you chose to redact the audio in +// your media file, you can find your redacted media file at the location specified +// in RedactedMediaFileUri . To get a list of your Call Analytics jobs, use the // operation. func (c *Client) GetCallAnalyticsJob(ctx context.Context, params *GetCallAnalyticsJobInput, optFns ...func(*Options)) (*GetCallAnalyticsJobOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_GetMedicalTranscriptionJob.go b/service/transcribe/api_op_GetMedicalTranscriptionJob.go index b6f4a3711e5..996aa5c1cca 100644 --- a/service/transcribe/api_op_GetMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_GetMedicalTranscriptionJob.go @@ -13,9 +13,9 @@ import ( // Provides information about the specified medical transcription job. To view the // status of the specified medical transcription job, check the -// TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. -// You can find the results at the location specified in TranscriptFileUri. If the -// status is FAILED, FailureReason provides details on why your transcription job +// TranscriptionJobStatus field. If the status is COMPLETED , the job is finished. +// You can find the results at the location specified in TranscriptFileUri . If the +// status is FAILED , FailureReason provides details on why your transcription job // failed. To get a list of your medical transcription jobs, use the operation. func (c *Client) GetMedicalTranscriptionJob(ctx context.Context, params *GetMedicalTranscriptionJobInput, optFns ...func(*Options)) (*GetMedicalTranscriptionJobOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_GetMedicalVocabulary.go b/service/transcribe/api_op_GetMedicalVocabulary.go index dae450b3fd5..97b225f2fee 100644 --- a/service/transcribe/api_op_GetMedicalVocabulary.go +++ b/service/transcribe/api_op_GetMedicalVocabulary.go @@ -14,8 +14,8 @@ import ( // Provides information about the specified custom medical vocabulary. To view the // status of the specified custom medical vocabulary, check the VocabularyState -// field. If the status is READY, your custom vocabulary is available to use. If -// the status is FAILED, FailureReason provides details on why your vocabulary +// field. If the status is READY , your custom vocabulary is available to use. If +// the status is FAILED , FailureReason provides details on why your vocabulary // failed. To get a list of your custom medical vocabularies, use the operation. func (c *Client) GetMedicalVocabulary(ctx context.Context, params *GetMedicalVocabularyInput, optFns ...func(*Options)) (*GetMedicalVocabularyOutput, error) { if params == nil { @@ -49,24 +49,24 @@ type GetMedicalVocabularyOutput struct { // this URI to view or download the custom vocabulary. DownloadUri *string - // If VocabularyState is FAILED, FailureReason contains information about why the - // custom medical vocabulary request failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If VocabularyState is FAILED , FailureReason contains information about why the + // custom medical vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string - // The language code you selected for your custom medical vocabulary. US English - // (en-US) is the only language supported with Amazon Transcribe Medical. + // The language code you selected for your custom medical vocabulary. US English ( + // en-US ) is the only language supported with Amazon Transcribe Medical. LanguageCode types.LanguageCode // The date and time the specified custom medical vocabulary was last modified. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name of the custom medical vocabulary you requested information about. VocabularyName *string - // The processing state of your custom medical vocabulary. If the state is READY, + // The processing state of your custom medical vocabulary. If the state is READY , // you can use the custom vocabulary in a StartMedicalTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_GetTranscriptionJob.go b/service/transcribe/api_op_GetTranscriptionJob.go index 0373e0f929e..19f102c35ea 100644 --- a/service/transcribe/api_op_GetTranscriptionJob.go +++ b/service/transcribe/api_op_GetTranscriptionJob.go @@ -13,12 +13,12 @@ import ( // Provides information about the specified transcription job. To view the status // of the specified transcription job, check the TranscriptionJobStatus field. If -// the status is COMPLETED, the job is finished. You can find the results at the -// location specified in TranscriptFileUri. If the status is FAILED, FailureReason -// provides details on why your transcription job failed. If you enabled content -// redaction, the redacted transcript can be found at the location specified in -// RedactedTranscriptFileUri. To get a list of your transcription jobs, use the -// operation. +// the status is COMPLETED , the job is finished. You can find the results at the +// location specified in TranscriptFileUri . If the status is FAILED , +// FailureReason provides details on why your transcription job failed. If you +// enabled content redaction, the redacted transcript can be found at the location +// specified in RedactedTranscriptFileUri . To get a list of your transcription +// jobs, use the operation. func (c *Client) GetTranscriptionJob(ctx context.Context, params *GetTranscriptionJobInput, optFns ...func(*Options)) (*GetTranscriptionJobOutput, error) { if params == nil { params = &GetTranscriptionJobInput{} @@ -36,8 +36,8 @@ func (c *Client) GetTranscriptionJob(ctx context.Context, params *GetTranscripti type GetTranscriptionJobInput struct { - // The name of the transcription job you want information about. Job names are case - // sensitive. + // The name of the transcription job you want information about. Job names are + // case sensitive. // // This member is required. TranscriptionJobName *string diff --git a/service/transcribe/api_op_GetVocabulary.go b/service/transcribe/api_op_GetVocabulary.go index be1b99d7b5e..f2175837e83 100644 --- a/service/transcribe/api_op_GetVocabulary.go +++ b/service/transcribe/api_op_GetVocabulary.go @@ -14,9 +14,9 @@ import ( // Provides information about the specified custom vocabulary. To view the status // of the specified custom vocabulary, check the VocabularyState field. If the -// status is READY, your custom vocabulary is available to use. If the status is -// FAILED, FailureReason provides details on why your custom vocabulary failed. To -// get a list of your custom vocabularies, use the operation. +// status is READY , your custom vocabulary is available to use. If the status is +// FAILED , FailureReason provides details on why your custom vocabulary failed. +// To get a list of your custom vocabularies, use the operation. func (c *Client) GetVocabulary(ctx context.Context, params *GetVocabularyInput, optFns ...func(*Options)) (*GetVocabularyOutput, error) { if params == nil { params = &GetVocabularyInput{} @@ -49,23 +49,23 @@ type GetVocabularyOutput struct { // download the custom vocabulary. DownloadUri *string - // If VocabularyState is FAILED, FailureReason contains information about why the - // custom vocabulary request failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If VocabularyState is FAILED , FailureReason contains information about why the + // custom vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string // The language code you selected for your custom vocabulary. LanguageCode types.LanguageCode // The date and time the specified custom vocabulary was last modified. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name of the custom vocabulary you requested information about. VocabularyName *string - // The processing state of your custom vocabulary. If the state is READY, you can + // The processing state of your custom vocabulary. If the state is READY , you can // use the custom vocabulary in a StartTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_GetVocabularyFilter.go b/service/transcribe/api_op_GetVocabularyFilter.go index ca299ab203b..d7de317b726 100644 --- a/service/transcribe/api_op_GetVocabularyFilter.go +++ b/service/transcribe/api_op_GetVocabularyFilter.go @@ -12,8 +12,8 @@ import ( "time" ) -// Provides information about the specified custom vocabulary filter. To get a list -// of your custom vocabulary filters, use the operation. +// Provides information about the specified custom vocabulary filter. To get a +// list of your custom vocabulary filters, use the operation. func (c *Client) GetVocabularyFilter(ctx context.Context, params *GetVocabularyFilterInput, optFns ...func(*Options)) (*GetVocabularyFilterOutput, error) { if params == nil { params = &GetVocabularyFilterInput{} @@ -50,7 +50,7 @@ type GetVocabularyFilterOutput struct { LanguageCode types.LanguageCode // The date and time the specified custom vocabulary filter was last modified. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time diff --git a/service/transcribe/api_op_ListCallAnalyticsJobs.go b/service/transcribe/api_op_ListCallAnalyticsJobs.go index 1ffcfd84bc5..4bf0658ca6c 100644 --- a/service/transcribe/api_op_ListCallAnalyticsJobs.go +++ b/service/transcribe/api_op_ListCallAnalyticsJobs.go @@ -49,7 +49,7 @@ type ListCallAnalyticsJobsInput struct { NextToken *string // Returns only Call Analytics jobs with the specified status. Jobs are ordered by - // creation date, with the newest job first. If you don't include Status, all Call + // creation date, with the newest job first. If you don't include Status , all Call // Analytics jobs are returned. Status types.CallAnalyticsJobStatus diff --git a/service/transcribe/api_op_ListLanguageModels.go b/service/transcribe/api_op_ListLanguageModels.go index 1fd1dbb5d66..f39169ffbb7 100644 --- a/service/transcribe/api_op_ListLanguageModels.go +++ b/service/transcribe/api_op_ListLanguageModels.go @@ -50,7 +50,7 @@ type ListLanguageModelsInput struct { // Returns only custom language models with the specified status. Language models // are ordered by creation date, with the newest model first. If you don't include - // StatusEquals, all custom language models are returned. + // StatusEquals , all custom language models are returned. StatusEquals types.ModelStatus noSmithyDocumentSerde diff --git a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go index b9ba73806cd..f2489486a6d 100644 --- a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go +++ b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides a list of medical transcription jobs that match the specified criteria. -// If no criteria are specified, all medical transcription jobs are returned. To -// get detailed information about a specific medical transcription job, use the -// operation. +// Provides a list of medical transcription jobs that match the specified +// criteria. If no criteria are specified, all medical transcription jobs are +// returned. To get detailed information about a specific medical transcription +// job, use the operation. func (c *Client) ListMedicalTranscriptionJobs(ctx context.Context, params *ListMedicalTranscriptionJobsInput, optFns ...func(*Options)) (*ListMedicalTranscriptionJobsOutput, error) { if params == nil { params = &ListMedicalTranscriptionJobsInput{} @@ -51,8 +51,8 @@ type ListMedicalTranscriptionJobsInput struct { NextToken *string // Returns only medical transcription jobs with the specified status. Jobs are - // ordered by creation date, with the newest job first. If you don't include - // Status, all medical transcription jobs are returned. + // ordered by creation date, with the newest job first. If you don't include Status + // , all medical transcription jobs are returned. Status types.TranscriptionJobStatus noSmithyDocumentSerde diff --git a/service/transcribe/api_op_ListMedicalVocabularies.go b/service/transcribe/api_op_ListMedicalVocabularies.go index e0cc1215dd8..b488f2dcb3f 100644 --- a/service/transcribe/api_op_ListMedicalVocabularies.go +++ b/service/transcribe/api_op_ListMedicalVocabularies.go @@ -52,7 +52,7 @@ type ListMedicalVocabulariesInput struct { // Returns only custom medical vocabularies with the specified state. Custom // vocabularies are ordered by creation date, with the newest vocabulary first. If - // you don't include StateEquals, all custom medical vocabularies are returned. + // you don't include StateEquals , all custom medical vocabularies are returned. StateEquals types.VocabularyState noSmithyDocumentSerde diff --git a/service/transcribe/api_op_ListTagsForResource.go b/service/transcribe/api_op_ListTagsForResource.go index 0f561ba0b74..136b69b6b2b 100644 --- a/service/transcribe/api_op_ListTagsForResource.go +++ b/service/transcribe/api_op_ListTagsForResource.go @@ -13,8 +13,8 @@ import ( // Lists all tags associated with the specified transcription job, vocabulary, // model, or resource. To learn more about using tags with Amazon Transcribe, refer -// to Tagging resources -// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). +// to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -34,11 +34,11 @@ type ListTagsForResourceInput struct { // Returns a list of all tags associated with the specified Amazon Resource Name // (ARN). ARNs have the format - // arn:partition:service:region:account-id:resource-type/resource-id. For example, - // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. - // Valid values for resource-type are: transcription-job, - // medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, - // and language-model. + // arn:partition:service:region:account-id:resource-type/resource-id . For example, + // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name + // . Valid values for resource-type are: transcription-job , + // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter + // , and language-model . // // This member is required. ResourceArn *string diff --git a/service/transcribe/api_op_ListTranscriptionJobs.go b/service/transcribe/api_op_ListTranscriptionJobs.go index 6ee8ce41981..d35987d8510 100644 --- a/service/transcribe/api_op_ListTranscriptionJobs.go +++ b/service/transcribe/api_op_ListTranscriptionJobs.go @@ -49,7 +49,7 @@ type ListTranscriptionJobsInput struct { NextToken *string // Returns only transcription jobs with the specified status. Jobs are ordered by - // creation date, with the newest job first. If you don't include Status, all + // creation date, with the newest job first. If you don't include Status , all // transcription jobs are returned. Status types.TranscriptionJobStatus diff --git a/service/transcribe/api_op_ListVocabularies.go b/service/transcribe/api_op_ListVocabularies.go index 903f5ccb064..6c0475f0659 100644 --- a/service/transcribe/api_op_ListVocabularies.go +++ b/service/transcribe/api_op_ListVocabularies.go @@ -50,7 +50,7 @@ type ListVocabulariesInput struct { // Returns only custom vocabularies with the specified state. Vocabularies are // ordered by creation date, with the newest vocabulary first. If you don't include - // StateEquals, all custom medical vocabularies are returned. + // StateEquals , all custom medical vocabularies are returned. StateEquals types.VocabularyState noSmithyDocumentSerde diff --git a/service/transcribe/api_op_ListVocabularyFilters.go b/service/transcribe/api_op_ListVocabularyFilters.go index 9fd8bc0de76..dce7228c80c 100644 --- a/service/transcribe/api_op_ListVocabularyFilters.go +++ b/service/transcribe/api_op_ListVocabularyFilters.go @@ -62,8 +62,8 @@ type ListVocabularyFiltersOutput struct { // view all your results. NextToken *string - // Provides information about the custom vocabulary filters that match the criteria - // specified in your request. + // Provides information about the custom vocabulary filters that match the + // criteria specified in your request. VocabularyFilters []types.VocabularyFilterInfo // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_StartCallAnalyticsJob.go b/service/transcribe/api_op_StartCallAnalyticsJob.go index d7eebd3982a..b817bba176b 100644 --- a/service/transcribe/api_op_StartCallAnalyticsJob.go +++ b/service/transcribe/api_op_StartCallAnalyticsJob.go @@ -17,43 +17,34 @@ import ( // characteristics, call summarization, speaker sentiment, and optional redaction // of your text transcript and your audio file. You can also apply custom // categories to flag specified conditions. To learn more about these features and -// insights, refer to Analyzing call center audio with Call Analytics -// (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html). If you -// want to apply categories to your Call Analytics job, you must create them before -// submitting your job request. Categories cannot be retroactively applied to a -// job. To create a new category, use the operation. To learn more about Call -// Analytics categories, see Creating categories for post-call transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and -// Creating categories for real-time transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html). -// To make a StartCallAnalyticsJob request, you must first upload your media file -// into an Amazon S3 bucket; you can then specify the Amazon S3 location of the -// file using the Media parameter. Note that job queuing is enabled by default for -// Call Analytics jobs. You must include the following parameters in your +// insights, refer to Analyzing call center audio with Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) +// . If you want to apply categories to your Call Analytics job, you must create +// them before submitting your job request. Categories cannot be retroactively +// applied to a job. To create a new category, use the operation. To learn more +// about Call Analytics categories, see Creating categories for post-call +// transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) +// and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html) +// . To make a StartCallAnalyticsJob request, you must first upload your media +// file into an Amazon S3 bucket; you can then specify the Amazon S3 location of +// the file using the Media parameter. Note that job queuing is enabled by default +// for Call Analytics jobs. You must include the following parameters in your // StartCallAnalyticsJob request: +// - region : The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html) +// . +// - CallAnalyticsJobName : A custom name that you create for your transcription +// job that's unique within your Amazon Web Services account. +// - DataAccessRoleArn : The Amazon Resource Name (ARN) of an IAM role that has +// permissions to access the Amazon S3 bucket that contains your input files. +// - Media ( MediaFileUri or RedactedMediaFileUri ): The Amazon S3 location of +// your media file. // -// * region: The Amazon Web Services Region where -// you are making your request. For a list of Amazon Web Services Regions supported -// with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). -// -// * -// CallAnalyticsJobName: A custom name that you create for your transcription job -// that's unique within your Amazon Web Services account. -// -// * DataAccessRoleArn: The -// Amazon Resource Name (ARN) of an IAM role that has permissions to access the -// Amazon S3 bucket that contains your input files. -// -// * Media (MediaFileUri or -// RedactedMediaFileUri): The Amazon S3 location of your media file. -// -// With Call -// Analytics, you can redact the audio contained in your media file by including -// RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your -// input audio. If you choose to redact your audio, you can find your redacted -// media at the location specified in the RedactedMediaFileUri field of your -// response. +// With Call Analytics, you can redact the audio contained in your media file by +// including RedactedMediaFileUri , instead of MediaFileUri , to specify the +// location of your input audio. If you choose to redact your audio, you can find +// your redacted media at the location specified in the RedactedMediaFileUri field +// of your response. func (c *Client) StartCallAnalyticsJob(ctx context.Context, params *StartCallAnalyticsJobInput, optFns ...func(*Options)) (*StartCallAnalyticsJobOutput, error) { if params == nil { params = &StartCallAnalyticsJobInput{} @@ -91,72 +82,53 @@ type StartCallAnalyticsJobInput struct { // the agent speaking). ChannelDefinitions []types.ChannelDefinition - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files. If the role that you specify - // doesn’t have the appropriate permissions to access the specified Amazon S3 - // location, your request fails. IAM role ARNs have the format - // arn:partition:iam::account:role/role-name-with-path. For example: - // arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role that you + // specify doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. IAM role ARNs have the format + // arn:partition:iam::account:role/role-name-with-path . For example: + // arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . DataAccessRoleArn *string // The KMS key you want to use to encrypt your Call Analytics output. If using a // key located in the current Amazon Web Services account, you can specify your KMS // key in one of four ways: - // - // * Use the KMS key ID itself. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use an alias for the KMS key ID. For - // example, alias/ExampleAlias. - // - // * Use the Amazon Resource Name (ARN) for the KMS - // key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If using a key located in a - // different Amazon Web Services account than the current Amazon Web Services - // account, you can specify your KMS key in one of two ways: - // - // * Use the ARN for the - // KMS key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If you don't specify an - // encryption key, your output is encrypted with the default Amazon S3 key - // (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify - // an output location using the OutputLocation parameter. Note that the role making - // the request must have permission to use the specified KMS key. + // - Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab + // . + // - Use an alias for the KMS key ID. For example, alias/ExampleAlias . + // - Use the Amazon Resource Name (ARN) for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one of two + // ways: + // - Use the ARN for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, + // you must also specify an output location using the OutputLocation parameter. + // Note that the role making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string // The Amazon S3 location where you want your Call Analytics transcription output - // stored. You can use any of the following formats to specify the output - // location: - // - // * s3://DOC-EXAMPLE-BUCKET - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-output-folder/ - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json + // stored. You can use any of the following formats to specify the output location: // - // Unless you - // specify a file name (option 3), the name of your output file has a default value - // that matches the name you specified for your transcription job using the - // CallAnalyticsJobName parameter. You can specify a KMS key to encrypt your output - // using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, - // Amazon Transcribe uses the default Amazon S3 key for server-side encryption. If - // you don't specify OutputLocation, your transcript is placed in a service-managed - // Amazon S3 bucket and you are provided with a URI to access your transcript. + // - s3://DOC-EXAMPLE-BUCKET + // - s3://DOC-EXAMPLE-BUCKET/my-output-folder/ + // - s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json + // Unless you specify a file name (option 3), the name of your output file has a + // default value that matches the name you specified for your transcription job + // using the CallAnalyticsJobName parameter. You can specify a KMS key to encrypt + // your output using the OutputEncryptionKMSKeyId parameter. If you don't specify + // a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side + // encryption. If you don't specify OutputLocation , your transcript is placed in a + // service-managed Amazon S3 bucket and you are provided with a URI to access your + // transcript. OutputLocation *string // Specify additional optional settings in your request, including content diff --git a/service/transcribe/api_op_StartMedicalTranscriptionJob.go b/service/transcribe/api_op_StartMedicalTranscriptionJob.go index ac47ef6a114..dac68c232ba 100644 --- a/service/transcribe/api_op_StartMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_StartMedicalTranscriptionJob.go @@ -16,36 +16,24 @@ import ( // to many standard transcription features, Amazon Transcribe Medical provides you // with a robust medical vocabulary and, optionally, content identification, which // adds flags to personal health information (PHI). To learn more about these -// features, refer to How Amazon Transcribe Medical works -// (https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html). To -// make a StartMedicalTranscriptionJob request, you must first upload your media -// file into an Amazon S3 bucket; you can then specify the S3 location of the file -// using the Media parameter. You must include the following parameters in your -// StartMedicalTranscriptionJob request: -// -// * region: The Amazon Web Services Region -// where you are making your request. For a list of Amazon Web Services Regions -// supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and -// quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). -// -// * -// MedicalTranscriptionJobName: A custom name you create for your transcription job -// that is unique within your Amazon Web Services account. -// -// * Media (MediaFileUri): -// The Amazon S3 location of your media file. -// -// * LanguageCode: This must be -// en-US. -// -// * OutputBucketName: The Amazon S3 bucket where you want your transcript -// stored. If you want your output stored in a sub-folder of this bucket, you must -// also include OutputKey. -// -// * Specialty: This must be PRIMARYCARE. -// -// * Type: Choose -// whether your audio is a conversation or a dictation. +// features, refer to How Amazon Transcribe Medical works (https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html) +// . To make a StartMedicalTranscriptionJob request, you must first upload your +// media file into an Amazon S3 bucket; you can then specify the S3 location of the +// file using the Media parameter. You must include the following parameters in +// your StartMedicalTranscriptionJob request: +// - region : The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html) +// . +// - MedicalTranscriptionJobName : A custom name you create for your +// transcription job that is unique within your Amazon Web Services account. +// - Media ( MediaFileUri ): The Amazon S3 location of your media file. +// - LanguageCode : This must be en-US . +// - OutputBucketName : The Amazon S3 bucket where you want your transcript +// stored. If you want your output stored in a sub-folder of this bucket, you must +// also include OutputKey . +// - Specialty : This must be PRIMARYCARE . +// - Type : Choose whether your audio is a conversation or a dictation. func (c *Client) StartMedicalTranscriptionJob(ctx context.Context, params *StartMedicalTranscriptionJobInput, optFns ...func(*Options)) (*StartMedicalTranscriptionJobOutput, error) { if params == nil { params = &StartMedicalTranscriptionJobInput{} @@ -64,17 +52,15 @@ func (c *Client) StartMedicalTranscriptionJob(ctx context.Context, params *Start type StartMedicalTranscriptionJobInput struct { // The language code that represents the language spoken in the input media file. - // US English (en-US) is the only valid value for medical transcription jobs. Any + // US English ( en-US ) is the only valid value for medical transcription jobs. Any // other value you enter for language code results in a BadRequestException error. // // This member is required. LanguageCode types.LanguageCode // Describes the Amazon S3 location of the media file you want to use in your - // request. For information on supported media formats, refer to the MediaFormat - // (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) - // parameter or the Media formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // request. For information on supported media formats, refer to the MediaFormat (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) + // parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) // section in the Amazon S3 Developer Guide. // // This member is required. @@ -94,15 +80,14 @@ type StartMedicalTranscriptionJobInput struct { // output stored. Do not include the S3:// prefix of the specified bucket. If you // want your output to go to a sub-folder of this bucket, specify it using the // OutputKey parameter; OutputBucketName only accepts the name of a bucket. For - // example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set - // OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored - // in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to - // DOC-EXAMPLE-BUCKET and OutputKey to test-files/. Note that Amazon Transcribe + // example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET , set + // OutputBucketName to DOC-EXAMPLE-BUCKET . However, if you want your output stored + // in S3://DOC-EXAMPLE-BUCKET/test-files/ , set OutputBucketName to + // DOC-EXAMPLE-BUCKET and OutputKey to test-files/ . Note that Amazon Transcribe // must have permission to use the specified location. You can change Amazon S3 - // permissions using the Amazon Web Services Management Console - // (https://console.aws.amazon.com/s3). See also Permissions Required for IAM User - // Roles - // (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). + // permissions using the Amazon Web Services Management Console (https://console.aws.amazon.com/s3) + // . See also Permissions Required for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user) + // . // // This member is required. OutputBucketName *string @@ -114,8 +99,8 @@ type StartMedicalTranscriptionJobInput struct { // This member is required. Specialty types.Specialty - // Specify whether your input media contains only one person (DICTATION) or - // contains a conversation between two people (CONVERSATION). For example, + // Specify whether your input media contains only one person ( DICTATION ) or + // contains a conversation between two people ( CONVERSATION ). For example, // DICTATION could be used for a medical professional wanting to transcribe voice // memos; CONVERSATION could be used for transcribing the doctor-patient dialogue // during the patient's office visit. @@ -125,15 +110,14 @@ type StartMedicalTranscriptionJobInput struct { // Labels all personal health information (PHI) identified in your transcript. For // more information, see Identifying personal health information (PHI) in a - // transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). + // transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html) . ContentIdentificationType types.MedicalContentIdentificationType // A map of plain text, non-secret key:value pairs, known as encryption context // pairs, that provide an added layer of security for your data. For more - // information, see KMS encryption context - // (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) - // and Asymmetric keys in KMS - // (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html). + // information, see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) + // and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html) + // . KMSEncryptionContext map[string]string // Specify the format of your input media file. @@ -144,77 +128,55 @@ type StartMedicalTranscriptionJobInput struct { // you. If you specify the sample rate, it must match the rate detected by Amazon // Transcribe Medical; if there's a mismatch between the value that you specify and // the value detected, your job fails. Therefore, in most cases, it's advised to - // omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample - // rate. + // omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the + // sample rate. MediaSampleRateHertz *int32 // The KMS key you want to use to encrypt your medical transcription output. If // using a key located in the current Amazon Web Services account, you can specify // your KMS key in one of four ways: - // - // * Use the KMS key ID itself. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use an alias for the KMS key ID. For - // example, alias/ExampleAlias. - // - // * Use the Amazon Resource Name (ARN) for the KMS - // key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If using a key located in a - // different Amazon Web Services account than the current Amazon Web Services - // account, you can specify your KMS key in one of two ways: - // - // * Use the ARN for the - // KMS key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If you don't specify an - // encryption key, your output is encrypted with the default Amazon S3 key - // (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify - // an output location using the OutputLocation parameter. Note that the role making - // the request must have permission to use the specified KMS key. + // - Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab + // . + // - Use an alias for the KMS key ID. For example, alias/ExampleAlias . + // - Use the Amazon Resource Name (ARN) for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one of two + // ways: + // - Use the ARN for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, + // you must also specify an output location using the OutputLocation parameter. + // Note that the role making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string // Use in combination with OutputBucketName to specify the output location of your // transcript and, optionally, a unique name for your output file. The default name // for your transcription output is the same as the name you specified for your - // medical transcription job (MedicalTranscriptionJobName). Here are some examples - // of how you can use OutputKey: - // - // * If you specify 'DOC-EXAMPLE-BUCKET' as the - // OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription - // output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json. - // - // * If you specify - // 'my-first-transcription' as the MedicalTranscriptionJobName, - // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the - // OutputKey, your transcription output path is - // s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. - // - // * If you - // specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and - // 'test-files/my-transcript.json' as the OutputKey, your transcription output path - // is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. - // - // * If you specify - // 'my-first-transcription' as the MedicalTranscriptionJobName, - // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as - // the OutputKey, your transcription output path is - // s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. - // - // If - // you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one - // is created for you. + // medical transcription job ( MedicalTranscriptionJobName ). Here are some + // examples of how you can use OutputKey : + // - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and + // 'my-transcript.json' as the OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/my-transcript.json . + // - If you specify 'my-first-transcription' as the MedicalTranscriptionJobName , + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName , and 'my-transcript' as the + // OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json . + // - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and + // 'test-files/my-transcript.json' as the OutputKey , your transcription output + // path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json . + // - If you specify 'my-first-transcription' as the MedicalTranscriptionJobName , + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName , and 'test-files/my-transcript' + // as the OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json . + // If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, + // one is created for you. OutputKey *string // Specify additional optional settings in your request, including channel @@ -224,8 +186,8 @@ type StartMedicalTranscriptionJobInput struct { // Adds one or more custom tags, each in the form of a key:value pair, to a new // medical transcription job at the time you start this new job. To learn more - // about using tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/transcribe/api_op_StartTranscriptionJob.go b/service/transcribe/api_op_StartTranscriptionJob.go index 6dcc5a16d80..dbaeb12320b 100644 --- a/service/transcribe/api_op_StartTranscriptionJob.go +++ b/service/transcribe/api_op_StartTranscriptionJob.go @@ -17,27 +17,19 @@ import ( // Amazon S3 bucket; you can then specify the Amazon S3 location of the file using // the Media parameter. You must include the following parameters in your // StartTranscriptionJob request: -// -// * region: The Amazon Web Services Region where -// you are making your request. For a list of Amazon Web Services Regions supported -// with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). -// -// * -// TranscriptionJobName: A custom name you create for your transcription job that -// is unique within your Amazon Web Services account. -// -// * Media (MediaFileUri): The -// Amazon S3 location of your media file. -// -// * One of LanguageCode, IdentifyLanguage, -// or IdentifyMultipleLanguages: If you know the language of your media file, -// specify it using the LanguageCode parameter; you can find all valid language -// codes in the Supported languages -// (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) -// table. If you don't know the languages spoken in your media, use either -// IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify -// the languages for you. +// - region : The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html) +// . +// - TranscriptionJobName : A custom name you create for your transcription job +// that is unique within your Amazon Web Services account. +// - Media ( MediaFileUri ): The Amazon S3 location of your media file. +// - One of LanguageCode , IdentifyLanguage , or IdentifyMultipleLanguages : If +// you know the language of your media file, specify it using the LanguageCode +// parameter; you can find all valid language codes in the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) +// table. If you don't know the languages spoken in your media, use either +// IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe +// identify the languages for you. func (c *Client) StartTranscriptionJob(ctx context.Context, params *StartTranscriptionJobInput, optFns ...func(*Options)) (*StartTranscriptionJobOutput, error) { if params == nil { params = &StartTranscriptionJobInput{} @@ -72,90 +64,91 @@ type StartTranscriptionJobInput struct { TranscriptionJobName *string // Makes it possible to redact or flag specified personally identifiable - // information (PII) in your transcript. If you use ContentRedaction, you must also - // include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. + // information (PII) in your transcript. If you use ContentRedaction , you must + // also include the sub-parameters: PiiEntityTypes , RedactionOutput , and + // RedactionType . ContentRedaction *types.ContentRedaction - // Enables automatic language identification in your transcription job request. Use - // this parameter if your media file contains only one language. If your media + // Enables automatic language identification in your transcription job request. + // Use this parameter if your media file contains only one language. If your media // contains multiple languages, use IdentifyMultipleLanguages instead. If you - // include IdentifyLanguage, you can optionally include a list of language codes, - // using LanguageOptions, that you think may be present in your media file. + // include IdentifyLanguage , you can optionally include a list of language codes, + // using LanguageOptions , that you think may be present in your media file. // Including LanguageOptions restricts IdentifyLanguage to only the language // options that you specify, which can improve transcription accuracy. If you want // to apply a custom language model, a custom vocabulary, or a custom vocabulary // filter to your automatic language identification request, include - // LanguageIdSettings with the relevant sub-parameters (VocabularyName, - // LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, - // also include LanguageOptions. Note that you must include one of LanguageCode, - // IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include - // more than one of these parameters, your transcription job fails. + // LanguageIdSettings with the relevant sub-parameters ( VocabularyName , + // LanguageModelName , and VocabularyFilterName ). If you include + // LanguageIdSettings , also include LanguageOptions . Note that you must include + // one of LanguageCode , IdentifyLanguage , or IdentifyMultipleLanguages in your + // request. If you include more than one of these parameters, your transcription + // job fails. IdentifyLanguage *bool // Enables automatic multi-language identification in your transcription job // request. Use this parameter if your media file contains more than one language. // If your media contains only one language, use IdentifyLanguage instead. If you - // include IdentifyMultipleLanguages, you can optionally include a list of language - // codes, using LanguageOptions, that you think may be present in your media file. - // Including LanguageOptions restricts IdentifyLanguage to only the language - // options that you specify, which can improve transcription accuracy. If you want - // to apply a custom vocabulary or a custom vocabulary filter to your automatic - // language identification request, include LanguageIdSettings with the relevant - // sub-parameters (VocabularyName and VocabularyFilterName). If you include - // LanguageIdSettings, also include LanguageOptions. Note that you must include one - // of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. - // If you include more than one of these parameters, your transcription job fails. + // include IdentifyMultipleLanguages , you can optionally include a list of + // language codes, using LanguageOptions , that you think may be present in your + // media file. Including LanguageOptions restricts IdentifyLanguage to only the + // language options that you specify, which can improve transcription accuracy. If + // you want to apply a custom vocabulary or a custom vocabulary filter to your + // automatic language identification request, include LanguageIdSettings with the + // relevant sub-parameters ( VocabularyName and VocabularyFilterName ). If you + // include LanguageIdSettings , also include LanguageOptions . Note that you must + // include one of LanguageCode , IdentifyLanguage , or IdentifyMultipleLanguages + // in your request. If you include more than one of these parameters, your + // transcription job fails. IdentifyMultipleLanguages *bool - // Makes it possible to control how your transcription job is processed. Currently, - // the only JobExecutionSettings modification you can choose is enabling job - // queueing using the AllowDeferredExecution sub-parameter. If you include - // JobExecutionSettings in your request, you must also include the sub-parameters: - // AllowDeferredExecution and DataAccessRoleArn. + // Makes it possible to control how your transcription job is processed. + // Currently, the only JobExecutionSettings modification you can choose is + // enabling job queueing using the AllowDeferredExecution sub-parameter. If you + // include JobExecutionSettings in your request, you must also include the + // sub-parameters: AllowDeferredExecution and DataAccessRoleArn . JobExecutionSettings *types.JobExecutionSettings // A map of plain text, non-secret key:value pairs, known as encryption context // pairs, that provide an added layer of security for your data. For more - // information, see KMS encryption context - // (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) - // and Asymmetric keys in KMS - // (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html). + // information, see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) + // and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html) + // . KMSEncryptionContext map[string]string // The language code that represents the language spoken in the input media file. // If you're unsure of the language spoken in your media file, consider using // IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language - // identification. Note that you must include one of LanguageCode, - // IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include + // identification. Note that you must include one of LanguageCode , + // IdentifyLanguage , or IdentifyMultipleLanguages in your request. If you include // more than one of these parameters, your transcription job fails. For a list of // supported languages and their associated language codes, refer to the Supported - // languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // table. To transcribe speech in Modern Standard Arabic (ar-SA), your media file + // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. To transcribe speech in Modern Standard Arabic ( ar-SA ), your media file // must be encoded at a sample rate of 16,000 Hz or higher. LanguageCode types.LanguageCode - // If using automatic language identification in your request and you want to apply - // a custom language model, a custom vocabulary, or a custom vocabulary filter, - // include LanguageIdSettings with the relevant sub-parameters (VocabularyName, - // LanguageModelName, and VocabularyFilterName). Note that multi-language - // identification (IdentifyMultipleLanguages) doesn't support custom language - // models. LanguageIdSettings supports two to five language codes. Each language - // code you include can have an associated custom language model, custom - // vocabulary, and custom vocabulary filter. The language codes that you specify - // must match the languages of the associated custom language models, custom - // vocabularies, and custom vocabulary filters. It's recommended that you include - // LanguageOptions when using LanguageIdSettings to ensure that the correct - // language dialect is identified. For example, if you specify a custom vocabulary - // that is in en-US but Amazon Transcribe determines that the language spoken in - // your media is en-AU, your custom vocabulary is not applied to your + // If using automatic language identification in your request and you want to + // apply a custom language model, a custom vocabulary, or a custom vocabulary + // filter, include LanguageIdSettings with the relevant sub-parameters ( + // VocabularyName , LanguageModelName , and VocabularyFilterName ). Note that + // multi-language identification ( IdentifyMultipleLanguages ) doesn't support + // custom language models. LanguageIdSettings supports two to five language codes. + // Each language code you include can have an associated custom language model, + // custom vocabulary, and custom vocabulary filter. The language codes that you + // specify must match the languages of the associated custom language models, + // custom vocabularies, and custom vocabulary filters. It's recommended that you + // include LanguageOptions when using LanguageIdSettings to ensure that the + // correct language dialect is identified. For example, if you specify a custom + // vocabulary that is in en-US but Amazon Transcribe determines that the language + // spoken in your media is en-AU , your custom vocabulary is not applied to your // transcription. If you include LanguageOptions and include en-US as the only // English language dialect, your custom vocabulary is applied to your // transcription. If you want to include a custom language model with your request // but do not want to use automatic language identification, use instead the // parameter with the LanguageModelName sub-parameter. If you want to include a // custom vocabulary or a custom vocabulary filter (or both) with your request but - // do not want to use automatic language identification, use instead the parameter + // do not want to use automatic language identification, use instead the parameter // with the VocabularyName or VocabularyFilterName (or both) sub-parameter. LanguageIdSettings map[string]types.LanguageIdSettings @@ -163,10 +156,9 @@ type StartTranscriptionJobInput struct { // think may be present in your media. Including more than five is not recommended. // If you're unsure what languages are present, do not include this parameter. If // you include LanguageOptions in your request, you must also include - // IdentifyLanguage. For more information, refer to Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). To - // transcribe speech in Modern Standard Arabic (ar-SA), your media file must be - // encoded at a sample rate of 16,000 Hz or higher. + // IdentifyLanguage . For more information, refer to Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // . To transcribe speech in Modern Standard Arabic ( ar-SA ), your media file must + // be encoded at a sample rate of 16,000 Hz or higher. LanguageOptions []types.LanguageCode // Specify the format of your input media file. @@ -183,94 +175,71 @@ type StartTranscriptionJobInput struct { // Specify the custom language model you want to include with your transcription // job. If you include ModelSettings in your request, you must include the // LanguageModelName sub-parameter. For more information, see Custom language - // models - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). + // models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) + // . ModelSettings *types.ModelSettings // The name of the Amazon S3 bucket where you want your transcription output // stored. Do not include the S3:// prefix of the specified bucket. If you want // your output to go to a sub-folder of this bucket, specify it using the OutputKey // parameter; OutputBucketName only accepts the name of a bucket. For example, if - // you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to - // DOC-EXAMPLE-BUCKET. However, if you want your output stored in - // S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET - // and OutputKey to test-files/. Note that Amazon Transcribe must have permission + // you want your output stored in S3://DOC-EXAMPLE-BUCKET , set OutputBucketName + // to DOC-EXAMPLE-BUCKET . However, if you want your output stored in + // S3://DOC-EXAMPLE-BUCKET/test-files/ , set OutputBucketName to DOC-EXAMPLE-BUCKET + // and OutputKey to test-files/ . Note that Amazon Transcribe must have permission // to use the specified location. You can change Amazon S3 permissions using the - // Amazon Web Services Management Console (https://console.aws.amazon.com/s3). See - // also Permissions Required for IAM User Roles - // (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). - // If you don't specify OutputBucketName, your transcript is placed in a + // Amazon Web Services Management Console (https://console.aws.amazon.com/s3) . See + // also Permissions Required for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user) + // . If you don't specify OutputBucketName , your transcript is placed in a // service-managed Amazon S3 bucket and you are provided with a URI to access your // transcript. OutputBucketName *string - // The KMS key you want to use to encrypt your transcription output. If using a key - // located in the current Amazon Web Services account, you can specify your KMS key - // in one of four ways: - // - // * Use the KMS key ID itself. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use an alias for the KMS key ID. For - // example, alias/ExampleAlias. - // - // * Use the Amazon Resource Name (ARN) for the KMS - // key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If using a key located in a - // different Amazon Web Services account than the current Amazon Web Services - // account, you can specify your KMS key in one of two ways: - // - // * Use the ARN for the - // KMS key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If you don't specify an - // encryption key, your output is encrypted with the default Amazon S3 key - // (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify - // an output location using the OutputLocation parameter. Note that the role making - // the request must have permission to use the specified KMS key. + // The KMS key you want to use to encrypt your transcription output. If using a + // key located in the current Amazon Web Services account, you can specify your KMS + // key in one of four ways: + // - Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab + // . + // - Use an alias for the KMS key ID. For example, alias/ExampleAlias . + // - Use the Amazon Resource Name (ARN) for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one of two + // ways: + // - Use the ARN for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, + // you must also specify an output location using the OutputLocation parameter. + // Note that the role making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string // Use in combination with OutputBucketName to specify the output location of your // transcript and, optionally, a unique name for your output file. The default name // for your transcription output is the same as the name you specified for your - // transcription job (TranscriptionJobName). Here are some examples of how you can - // use OutputKey: - // - // * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName - // and 'my-transcript.json' as the OutputKey, your transcription output path is - // s3://DOC-EXAMPLE-BUCKET/my-transcript.json. - // - // * If you specify - // 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as - // the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription - // output path is - // s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. - // - // * If you - // specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and - // 'test-files/my-transcript.json' as the OutputKey, your transcription output path - // is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. - // - // * If you specify - // 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as - // the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your - // transcription output path is - // s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. - // - // If - // you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one - // is created for you. + // transcription job ( TranscriptionJobName ). Here are some examples of how you + // can use OutputKey : + // - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and + // 'my-transcript.json' as the OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/my-transcript.json . + // - If you specify 'my-first-transcription' as the TranscriptionJobName , + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName , and 'my-transcript' as the + // OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json . + // - If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and + // 'test-files/my-transcript.json' as the OutputKey , your transcription output + // path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json . + // - If you specify 'my-first-transcription' as the TranscriptionJobName , + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName , and 'test-files/my-transcript' + // as the OutputKey , your transcription output path is + // s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json . + // If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, + // one is created for you. OutputKey *string // Specify additional optional settings in your request, including channel @@ -281,18 +250,18 @@ type StartTranscriptionJobInput struct { // VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using // automatic language identification with your request and want to include a custom // language model, a custom vocabulary, or a custom vocabulary filter, use instead - // the parameter with the LanguageModelName, VocabularyName or + // the parameter with the LanguageModelName , VocabularyName or // VocabularyFilterName sub-parameters. Settings *types.Settings - // Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and - // SubRip (*.srt) formats. + // Produces subtitle files for your input media. You can specify WebVTT (*.vtt) + // and SubRip (*.srt) formats. Subtitles *types.Subtitles // Adds one or more custom tags, each in the form of a key:value pair, to a new // transcription job at the time you start this new job. To learn more about using - // tags with Amazon Transcribe, refer to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -300,8 +269,8 @@ type StartTranscriptionJobInput struct { type StartTranscriptionJobOutput struct { - // Provides detailed information about the current transcription job, including job - // status and, if applicable, failure reason. + // Provides detailed information about the current transcription job, including + // job status and, if applicable, failure reason. TranscriptionJob *types.TranscriptionJob // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_TagResource.go b/service/transcribe/api_op_TagResource.go index 242513c0a71..3f770850331 100644 --- a/service/transcribe/api_op_TagResource.go +++ b/service/transcribe/api_op_TagResource.go @@ -13,8 +13,8 @@ import ( // Adds one or more custom tags, each in the form of a key:value pair, to the // specified resource. To learn more about using tags with Amazon Transcribe, refer -// to Tagging resources -// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). +// to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -33,20 +33,20 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the - // format arn:partition:service:region:account-id:resource-type/resource-id. For + // format arn:partition:service:region:account-id:resource-type/resource-id . For // example, - // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. - // Valid values for resource-type are: transcription-job, - // medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, - // and language-model. + // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name + // . Valid values for resource-type are: transcription-job , + // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter + // , and language-model . // // This member is required. ResourceArn *string // Adds one or more custom tags, each in the form of a key:value pair, to the // specified resource. To learn more about using tags with Amazon Transcribe, refer - // to Tagging resources - // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). + // to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) + // . // // This member is required. Tags []types.Tag diff --git a/service/transcribe/api_op_UntagResource.go b/service/transcribe/api_op_UntagResource.go index f0a7f5335c0..318c89d145a 100644 --- a/service/transcribe/api_op_UntagResource.go +++ b/service/transcribe/api_op_UntagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified tags from the specified Amazon Transcribe resource. If you -// include UntagResource in your request, you must also include ResourceArn and -// TagKeys. +// Removes the specified tags from the specified Amazon Transcribe resource. If +// you include UntagResource in your request, you must also include ResourceArn +// and TagKeys . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -32,11 +32,11 @@ type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to // remove tags from. ARNs have the format - // arn:partition:service:region:account-id:resource-type/resource-id. For example, - // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. - // Valid values for resource-type are: transcription-job, - // medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, - // and language-model. + // arn:partition:service:region:account-id:resource-type/resource-id . For example, + // arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name + // . Valid values for resource-type are: transcription-job , + // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter + // , and language-model . // // This member is required. ResourceArn *string diff --git a/service/transcribe/api_op_UpdateCallAnalyticsCategory.go b/service/transcribe/api_op_UpdateCallAnalyticsCategory.go index d96b2cf20b9..ea2ba3884bd 100644 --- a/service/transcribe/api_op_UpdateCallAnalyticsCategory.go +++ b/service/transcribe/api_op_UpdateCallAnalyticsCategory.go @@ -38,15 +38,15 @@ type UpdateCallAnalyticsCategoryInput struct { // This member is required. CategoryName *string - // The rules used for the updated Call Analytics category. The rules you provide in - // this field replace the ones that are currently being used in the specified + // The rules used for the updated Call Analytics category. The rules you provide + // in this field replace the ones that are currently being used in the specified // category. // // This member is required. Rules []types.Rule - // Choose whether you want to update a real-time or a post-call category. The input - // type you specify must match the input type specified when the category was + // Choose whether you want to update a real-time or a post-call category. The + // input type you specify must match the input type specified when the category was // created. For example, if you created a category with the POST_CALL input type, // you must use POST_CALL as the input type when updating this category. InputType types.InputType @@ -56,8 +56,8 @@ type UpdateCallAnalyticsCategoryInput struct { type UpdateCallAnalyticsCategoryOutput struct { - // Provides you with the properties of the Call Analytics category you specified in - // your UpdateCallAnalyticsCategory request. + // Provides you with the properties of the Call Analytics category you specified + // in your UpdateCallAnalyticsCategory request. CategoryProperties *types.CategoryProperties // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_UpdateMedicalVocabulary.go b/service/transcribe/api_op_UpdateMedicalVocabulary.go index 5452fe0d1b6..e67304c4ffe 100644 --- a/service/transcribe/api_op_UpdateMedicalVocabulary.go +++ b/service/transcribe/api_op_UpdateMedicalVocabulary.go @@ -33,8 +33,8 @@ func (c *Client) UpdateMedicalVocabulary(ctx context.Context, params *UpdateMedi type UpdateMedicalVocabularyInput struct { // The language code that represents the language of the entries in the custom - // vocabulary you want to update. US English (en-US) is the only language supported - // with Amazon Transcribe Medical. + // vocabulary you want to update. US English ( en-US ) is the only language + // supported with Amazon Transcribe Medical. // // This member is required. LanguageCode types.LanguageCode @@ -58,19 +58,19 @@ type UpdateMedicalVocabularyInput struct { type UpdateMedicalVocabularyOutput struct { - // The language code you selected for your custom medical vocabulary. US English - // (en-US) is the only language supported with Amazon Transcribe Medical. + // The language code you selected for your custom medical vocabulary. US English ( + // en-US ) is the only language supported with Amazon Transcribe Medical. LanguageCode types.LanguageCode // The date and time the specified custom medical vocabulary was last updated. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name of the updated custom medical vocabulary. VocabularyName *string - // The processing state of your custom medical vocabulary. If the state is READY, + // The processing state of your custom medical vocabulary. If the state is READY , // you can use the custom vocabulary in a StartMedicalTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_UpdateVocabulary.go b/service/transcribe/api_op_UpdateVocabulary.go index 99faa0d2738..473ecf1396e 100644 --- a/service/transcribe/api_op_UpdateVocabulary.go +++ b/service/transcribe/api_op_UpdateVocabulary.go @@ -12,9 +12,9 @@ import ( "time" ) -// Updates an existing custom vocabulary with new values. This operation overwrites -// all existing information with your new values; you cannot append new terms onto -// an existing custom vocabulary. +// Updates an existing custom vocabulary with new values. This operation +// overwrites all existing information with your new values; you cannot append new +// terms onto an existing custom vocabulary. func (c *Client) UpdateVocabulary(ctx context.Context, params *UpdateVocabularyInput, optFns ...func(*Options)) (*UpdateVocabularyOutput, error) { if params == nil { params = &UpdateVocabularyInput{} @@ -36,10 +36,9 @@ type UpdateVocabularyInput struct { // vocabulary you want to update. Each custom vocabulary must contain terms in only // one language. A custom vocabulary can only be used to transcribe files in the // same language as the custom vocabulary. For example, if you create a custom - // vocabulary using US English (en-US), you can only apply this custom vocabulary + // vocabulary using US English ( en-US ), you can only apply this custom vocabulary // to files that contain English audio. For a list of supported languages and their - // associated language codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // associated language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. // // This member is required. @@ -51,27 +50,26 @@ type UpdateVocabularyInput struct { // This member is required. VocabularyName *string - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files (in this case, your custom + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files (in this case, your custom // vocabulary). If the role that you specify doesn’t have the appropriate // permissions to access the specified Amazon S3 location, your request fails. IAM - // role ARNs have the format arn:partition:iam::account:role/role-name-with-path. - // For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM - // ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // role ARNs have the format arn:partition:iam::account:role/role-name-with-path . + // For example: arn:aws:iam::111122223333:role/Admin . For more information, see + // IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . DataAccessRoleArn *string - // Use this parameter if you want to update your custom vocabulary by including all - // desired terms, as comma-separated values, within your request. The other option - // for updating your custom vocabulary is to save your entries in a text file and - // upload them to an Amazon S3 bucket, then specify the location of your file using - // the VocabularyFileUri parameter. Note that if you include Phrases in your - // request, you cannot use VocabularyFileUri; you must choose one or the other. - // Each language has a character set that contains all allowed characters for that - // specific language. If you use unsupported characters, your custom vocabulary - // filter request fails. Refer to Character Sets for Custom Vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the - // character set for your language. + // Use this parameter if you want to update your custom vocabulary by including + // all desired terms, as comma-separated values, within your request. The other + // option for updating your custom vocabulary is to save your entries in a text + // file and upload them to an Amazon S3 bucket, then specify the location of your + // file using the VocabularyFileUri parameter. Note that if you include Phrases in + // your request, you cannot use VocabularyFileUri ; you must choose one or the + // other. Each language has a character set that contains all allowed characters + // for that specific language. If you use unsupported characters, your custom + // vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. Phrases []string // The Amazon S3 location of the text file that contains your custom vocabulary. @@ -91,14 +89,14 @@ type UpdateVocabularyOutput struct { LanguageCode types.LanguageCode // The date and time the specified custom vocabulary was last updated. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time // The name of the updated custom vocabulary. VocabularyName *string - // The processing state of your custom vocabulary. If the state is READY, you can + // The processing state of your custom vocabulary. If the state is READY , you can // use the custom vocabulary in a StartTranscriptionJob request. VocabularyState types.VocabularyState diff --git a/service/transcribe/api_op_UpdateVocabularyFilter.go b/service/transcribe/api_op_UpdateVocabularyFilter.go index 93f040d6438..4d70b963d9d 100644 --- a/service/transcribe/api_op_UpdateVocabularyFilter.go +++ b/service/transcribe/api_op_UpdateVocabularyFilter.go @@ -38,21 +38,21 @@ type UpdateVocabularyFilterInput struct { // This member is required. VocabularyFilterName *string - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files (in this case, your custom + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files (in this case, your custom // vocabulary filter). If the role that you specify doesn’t have the appropriate // permissions to access the specified Amazon S3 location, your request fails. IAM - // role ARNs have the format arn:partition:iam::account:role/role-name-with-path. - // For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM - // ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // role ARNs have the format arn:partition:iam::account:role/role-name-with-path . + // For example: arn:aws:iam::111122223333:role/Admin . For more information, see + // IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . DataAccessRoleArn *string // The Amazon S3 location of the text file that contains your custom vocabulary // filter terms. The URI must be located in the same Amazon Web Services Region as // the resource you're calling. Here's an example URI path: // s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include - // VocabularyFilterFileUri in your request, you cannot use Words; you must choose + // VocabularyFilterFileUri in your request, you cannot use Words ; you must choose // one or the other. VocabularyFilterFileUri *string @@ -61,7 +61,7 @@ type UpdateVocabularyFilterInput struct { // other option for updating your vocabulary filter is to save your entries in a // text file and upload them to an Amazon S3 bucket, then specify the location of // your file using the VocabularyFilterFileUri parameter. Note that if you include - // Words in your request, you cannot use VocabularyFilterFileUri; you must choose + // Words in your request, you cannot use VocabularyFilterFileUri ; you must choose // one or the other. Each language has a character set that contains all allowed // characters for that specific language. If you use unsupported characters, your // custom vocabulary filter request fails. Refer to Character Sets for Custom @@ -78,7 +78,7 @@ type UpdateVocabularyFilterOutput struct { LanguageCode types.LanguageCode // The date and time the specified custom vocabulary filter was last updated. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time diff --git a/service/transcribe/doc.go b/service/transcribe/doc.go index 7ec5446b406..dd56b20a148 100644 --- a/service/transcribe/doc.go +++ b/service/transcribe/doc.go @@ -5,16 +5,11 @@ // // Amazon Transcribe offers three main types of batch transcription: Standard, // Medical, and Call Analytics. -// -// * Standard transcriptions are the most common -// option. Refer to for details. -// -// * Medical transcriptions are tailored to medical -// professionals and incorporate medical terms. A common use case for this service -// is transcribing doctor-patient dialogue into after-visit notes. Refer to for -// details. -// -// * Call Analytics transcriptions are designed for use with call center -// audio on two different channels; if you're looking for insight into customer -// service calls, use this option. Refer to for details. +// - Standard transcriptions are the most common option. Refer to for details. +// - Medical transcriptions are tailored to medical professionals and +// incorporate medical terms. A common use case for this service is transcribing +// doctor-patient dialogue into after-visit notes. Refer to for details. +// - Call Analytics transcriptions are designed for use with call center audio +// on two different channels; if you're looking for insight into customer service +// calls, use this option. Refer to for details. package transcribe diff --git a/service/transcribe/types/enums.go b/service/transcribe/types/enums.go index 311c88bd490..8c3beb63c4c 100644 --- a/service/transcribe/types/enums.go +++ b/service/transcribe/types/enums.go @@ -78,9 +78,9 @@ const ( InputTypePostCall InputType = "POST_CALL" ) -// Values returns all known values for InputType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for InputType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (InputType) Values() []InputType { return []InputType{ "REAL_TIME", @@ -133,9 +133,9 @@ const ( LanguageCodeSvSe LanguageCode = "sv-SE" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "af-ZA", @@ -382,9 +382,9 @@ const ( SpecialtyPrimarycare Specialty = "PRIMARYCARE" ) -// Values returns all known values for Specialty. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Specialty. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Specialty) Values() []Specialty { return []Specialty{ "PRIMARYCARE", diff --git a/service/transcribe/types/errors.go b/service/transcribe/types/errors.go index 50ba920794d..cb78e45ec10 100644 --- a/service/transcribe/types/errors.go +++ b/service/transcribe/types/errors.go @@ -9,7 +9,7 @@ import ( // Your request didn't pass one or more validation tests. This can occur when the // entity you're trying to delete doesn't exist or if it's in a non-terminal state -// (such as IN PROGRESS). See the exception message field for more information. +// (such as IN PROGRESS ). See the exception message field for more information. type BadRequestException struct { Message *string @@ -62,8 +62,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was an internal error. Check the error message, correct the issue, and try -// your request again. +// There was an internal error. Check the error message, correct the issue, and +// try your request again. type InternalFailureException struct { Message *string @@ -89,8 +89,8 @@ func (e *InternalFailureException) ErrorCode() string { } func (e *InternalFailureException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// You've either sent too many requests or your input file is too long. Wait before -// retrying your request, or use a smaller file and try your request again. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request again. type LimitExceededException struct { Message *string diff --git a/service/transcribe/types/types.go b/service/transcribe/types/types.go index a60c7477d36..aa0e20a27e8 100644 --- a/service/transcribe/types/types.go +++ b/service/transcribe/types/types.go @@ -15,20 +15,20 @@ import ( // as a set; that is, if you include one, you must include both. You can use also // First to search from the start of the audio until the time that you specify, or // Last to search from the time that you specify until the end of the audio. For -// example, setting First to 50000 only searches for your specified criteria in the -// audio contained between the start of the media file to the 50,000 millisecond -// mark. You can use First and Last independently of each other. If you prefer to -// use percentage instead of milliseconds, see . +// example, setting First to 50000 only searches for your specified criteria in +// the audio contained between the start of the media file to the 50,000 +// millisecond mark. You can use First and Last independently of each other. If +// you prefer to use percentage instead of milliseconds, see . type AbsoluteTimeRange struct { // The time, in milliseconds, when Amazon Transcribe stops searching for the // specified criteria in your audio. If you include EndTime in your request, you - // must also include StartTime. + // must also include StartTime . EndTime *int64 - // The time, in milliseconds, from the start of your media file until the specified - // value. Amazon Transcribe searches for your specified criteria in this time - // segment. + // The time, in milliseconds, from the start of your media file until the + // specified value. Amazon Transcribe searches for your specified criteria in this + // time segment. First *int64 // The time, in milliseconds, from the specified value until the end of your media @@ -38,21 +38,21 @@ type AbsoluteTimeRange struct { // The time, in milliseconds, when Amazon Transcribe starts searching for the // specified criteria in your audio. If you include StartTime in your request, you - // must also include EndTime. + // must also include EndTime . StartTime *int64 noSmithyDocumentSerde } // Provides detailed information about a Call Analytics job. To view the job's -// status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is -// finished. You can find your completed transcript at the URI specified in -// TranscriptFileUri. If the status is FAILED, FailureReason provides details on +// status, refer to CallAnalyticsJobStatus . If the status is COMPLETED , the job +// is finished. You can find your completed transcript at the URI specified in +// TranscriptFileUri . If the status is FAILED , FailureReason provides details on // why your transcription job failed. If you enabled personally identifiable // information (PII) redaction, the redacted transcript appears at the location -// specified in RedactedTranscriptFileUri. If you chose to redact the audio in your -// media file, you can find your redacted media file at the location specified in -// the RedactedMediaFileUri field of your response. +// specified in RedactedTranscriptFileUri . If you chose to redact the audio in +// your media file, you can find your redacted media file at the location specified +// in the RedactedMediaFileUri field of your response. type CallAnalyticsJob struct { // The name of the Call Analytics job. Job names are case sensitive and must be @@ -60,9 +60,9 @@ type CallAnalyticsJob struct { CallAnalyticsJobName *string // Provides the status of the specified Call Analytics job. If the status is - // COMPLETED, the job is finished and you can find the results at the location - // specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested - // transcript redaction). If the status is FAILED, FailureReason provides details + // COMPLETED , the job is finished and you can find the results at the location + // specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested + // transcript redaction). If the status is FAILED , FailureReason provides details // on why your transcription job failed. CallAnalyticsJobStatus CallAnalyticsJobStatus @@ -70,13 +70,13 @@ type CallAnalyticsJob struct { ChannelDefinitions []ChannelDefinition // The date and time the specified Call Analytics job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time // The date and time the specified Call Analytics job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time @@ -84,50 +84,41 @@ type CallAnalyticsJob struct { // The Amazon Resource Name (ARN) you included in your request. DataAccessRoleArn *string - // If CallAnalyticsJobStatus is FAILED, FailureReason contains information about + // If CallAnalyticsJobStatus is FAILED , FailureReason contains information about // why the Call Analytics job request failed. The FailureReason field contains one // of the following values: + // - Unsupported media format . The media format specified in MediaFormat isn't + // valid. Refer to MediaFormat for a list of supported formats. + // - The media format provided does not match the detected media format . The + // media format specified in MediaFormat doesn't match the format of the input + // file. Check the media format of your media file and correct the specified value. // - // * Unsupported media format. The media format specified - // in MediaFormat isn't valid. Refer to MediaFormat for a list of supported - // formats. - // - // * The media format provided does not match the detected media format. - // The media format specified in MediaFormat doesn't match the format of the input - // file. Check the media format of your media file and correct the specified - // value. - // - // * Invalid sample rate for audio file. The sample rate specified in - // MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and - // 48,000 hertz. - // - // * The sample rate provided does not match the detected sample - // rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample - // rate detected in your input media file. Check the sample rate of your media file - // and correct the specified value. - // - // * Invalid file size: file size too large. The - // size of your media file is larger than what Amazon Transcribe can process. For - // more information, refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). - // - // * - // Invalid number of channels: number of channels too large. Your audio contains - // more channels than Amazon Transcribe is able to process. For more information, - // refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). + // - Invalid sample rate for audio file . The sample rate specified in + // MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and + // 48,000 hertz. + // - The sample rate provided does not match the detected sample rate . The + // sample rate specified in MediaSampleRateHertz doesn't match the sample rate + // detected in your input media file. Check the sample rate of your media file and + // correct the specified value. + // - Invalid file size: file size too large . The size of your media file is + // larger than what Amazon Transcribe can process. For more information, refer to + // Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . + // - Invalid number of channels: number of channels too large . Your audio + // contains more channels than Amazon Transcribe is able to process. For more + // information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . FailureReason *string - // The confidence score associated with the language identified in your media file. - // Confidence scores are values between 0 and 1; a larger value indicates a higher - // probability that the identified language correctly matches the language spoken - // in your media. + // The confidence score associated with the language identified in your media + // file. Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float32 // The language code used to create your Call Analytics job. For a list of // supported languages and their associated language codes, refer to the Supported - // languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. If you don't know the language spoken in your media file, you can omit // this field and let Amazon Transcribe automatically identify the language of your // media. To improve the accuracy of language identification, you can include @@ -151,7 +142,7 @@ type CallAnalyticsJob struct { Settings *CallAnalyticsJobSettings // The date and time the specified Call Analytics job began processing. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -168,31 +159,32 @@ type CallAnalyticsJob struct { type CallAnalyticsJobSettings struct { // Makes it possible to redact or flag specified personally identifiable - // information (PII) in your transcript. If you use ContentRedaction, you must also - // include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. + // information (PII) in your transcript. If you use ContentRedaction , you must + // also include the sub-parameters: PiiEntityTypes , RedactionOutput , and + // RedactionType . ContentRedaction *ContentRedaction - // If using automatic language identification in your request and you want to apply - // a custom language model, a custom vocabulary, or a custom vocabulary filter, - // include LanguageIdSettings with the relevant sub-parameters (VocabularyName, - // LanguageModelName, and VocabularyFilterName). LanguageIdSettings supports two to - // five language codes. Each language code you include can have an associated - // custom language model, custom vocabulary, and custom vocabulary filter. The - // language codes that you specify must match the languages of the associated - // custom language models, custom vocabularies, and custom vocabulary filters. It's - // recommended that you include LanguageOptions when using LanguageIdSettings to - // ensure that the correct language dialect is identified. For example, if you - // specify a custom vocabulary that is in en-US but Amazon Transcribe determines - // that the language spoken in your media is en-AU, your custom vocabulary is not - // applied to your transcription. If you include LanguageOptions and include en-US - // as the only English language dialect, your custom vocabulary is applied to your - // transcription. If you want to include a custom language model, custom - // vocabulary, or custom vocabulary filter with your request but do not want to use - // automatic language identification, use instead the parameter with the - // LanguageModelName, VocabularyName, or VocabularyFilterName sub-parameters. For a - // list of languages supported with Call Analytics, refer to Supported languages - // and language-specific features - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). + // If using automatic language identification in your request and you want to + // apply a custom language model, a custom vocabulary, or a custom vocabulary + // filter, include LanguageIdSettings with the relevant sub-parameters ( + // VocabularyName , LanguageModelName , and VocabularyFilterName ). + // LanguageIdSettings supports two to five language codes. Each language code you + // include can have an associated custom language model, custom vocabulary, and + // custom vocabulary filter. The language codes that you specify must match the + // languages of the associated custom language models, custom vocabularies, and + // custom vocabulary filters. It's recommended that you include LanguageOptions + // when using LanguageIdSettings to ensure that the correct language dialect is + // identified. For example, if you specify a custom vocabulary that is in en-US + // but Amazon Transcribe determines that the language spoken in your media is en-AU + // , your custom vocabulary is not applied to your transcription. If you include + // LanguageOptions and include en-US as the only English language dialect, your + // custom vocabulary is applied to your transcription. If you want to include a + // custom language model, custom vocabulary, or custom vocabulary filter with your + // request but do not want to use automatic language identification, use instead + // the parameter with the LanguageModelName , VocabularyName , or + // VocabularyFilterName sub-parameters. For a list of languages supported with Call + // Analytics, refer to Supported languages and language-specific features (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // . LanguageIdSettings map[string]LanguageIdSettings // The name of the custom language model you want to use when processing your Call @@ -208,21 +200,20 @@ type CallAnalyticsJobSettings struct { // If you're unsure what languages are present, do not include this parameter. // Including language options can improve the accuracy of language identification. // For a list of languages supported with Call Analytics, refer to the Supported - // languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // table. To transcribe speech in Modern Standard Arabic (ar-SA), your media file + // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. To transcribe speech in Modern Standard Arabic ( ar-SA ), your media file // must be encoded at a sample rate of 16,000 Hz or higher. LanguageOptions []LanguageCode // Specify how you want your custom vocabulary filter applied to your transcript. - // To replace words with ***, choose mask. To delete words, choose remove. To flag - // words without changing them, choose tag. + // To replace words with *** , choose mask . To delete words, choose remove . To + // flag words without changing them, choose tag . VocabularyFilterMethod VocabularyFilterMethod // The name of the custom vocabulary filter you want to include in your Call // Analytics transcription request. Custom vocabulary filter names are case // sensitive. Note that if you include VocabularyFilterName in your request, you - // must also include VocabularyFilterMethod. + // must also include VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to include in your Call Analytics @@ -239,35 +230,35 @@ type CallAnalyticsJobSummary struct { // unique within an Amazon Web Services account. CallAnalyticsJobName *string - // Provides the status of your Call Analytics job. If the status is COMPLETED, the + // Provides the status of your Call Analytics job. If the status is COMPLETED , the // job is finished and you can find the results at the location specified in - // TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript - // redaction). If the status is FAILED, FailureReason provides details on why your - // transcription job failed. + // TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript + // redaction). If the status is FAILED , FailureReason provides details on why + // your transcription job failed. CallAnalyticsJobStatus CallAnalyticsJobStatus // The date and time the specified Call Analytics job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time // The date and time the specified Call Analytics job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time - // If CallAnalyticsJobStatus is FAILED, FailureReason contains information about - // why the Call Analytics job failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If CallAnalyticsJobStatus is FAILED , FailureReason contains information about + // why the Call Analytics job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string // The language code used to create your Call Analytics transcription. LanguageCode LanguageCode // The date and time your Call Analytics job began processing. Timestamps are in - // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -275,8 +266,8 @@ type CallAnalyticsJobSummary struct { noSmithyDocumentSerde } -// Provides you with the properties of the Call Analytics category you specified in -// your request. This includes the list of rules that define the specified +// Provides you with the properties of the Call Analytics category you specified +// in your request. This includes the list of rules that define the specified // category. type CategoryProperties struct { @@ -285,17 +276,17 @@ type CategoryProperties struct { CategoryName *string // The date and time the specified Call Analytics category was created. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. CreateTime *time.Time // The input type associated with the specified category. POST_CALL refers to a - // category that is applied to batch transcriptions; REAL_TIME refers to a category - // that is applied to streaming transcriptions. + // category that is applied to batch transcriptions; REAL_TIME refers to a + // category that is applied to streaming transcriptions. InputType InputType // The date and time the specified Call Analytics category was last updated. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022. LastUpdateTime *time.Time @@ -315,54 +306,56 @@ type ChannelDefinition struct { // Specify the audio channel you want to define. ChannelId int32 - // Specify the speaker you want to define. Omitting this parameter is equivalent to - // specifying both participants. + // Specify the speaker you want to define. Omitting this parameter is equivalent + // to specifying both participants. ParticipantRole ParticipantRole noSmithyDocumentSerde } // Makes it possible to redact or flag specified personally identifiable -// information (PII) in your transcript. If you use ContentRedaction, you must also -// include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. +// information (PII) in your transcript. If you use ContentRedaction , you must +// also include the sub-parameters: PiiEntityTypes , RedactionOutput , and +// RedactionType . type ContentRedaction struct { - // Specify if you want only a redacted transcript, or if you want a redacted and an - // unredacted transcript. When you choose redacted Amazon Transcribe creates only a - // redacted transcript. When you choose redacted_and_unredacted Amazon Transcribe - // creates a redacted and an unredacted transcript (as two separate files). + // Specify if you want only a redacted transcript, or if you want a redacted and + // an unredacted transcript. When you choose redacted Amazon Transcribe creates + // only a redacted transcript. When you choose redacted_and_unredacted Amazon + // Transcribe creates a redacted and an unredacted transcript (as two separate + // files). // // This member is required. RedactionOutput RedactionOutput // Specify the category of information you want to redact; PII (personally - // identifiable information) is the only valid value. You can use PiiEntityTypes to - // choose which types of PII you want to redact. + // identifiable information) is the only valid value. You can use PiiEntityTypes + // to choose which types of PII you want to redact. // // This member is required. RedactionType RedactionType // Specify which types of personally identifiable information (PII) you want to // redact in your transcript. You can include as many types as you'd like, or you - // can select ALL. + // can select ALL . PiiEntityTypes []PiiEntityType noSmithyDocumentSerde } -// Contains the Amazon S3 location of the training data you want to use to create a -// new custom language model, and permissions to access this location. When using -// InputDataConfig, you must include these sub-parameters: S3Uri and -// DataAccessRoleArn. You can optionally include TuningDataS3Uri. +// Contains the Amazon S3 location of the training data you want to use to create +// a new custom language model, and permissions to access this location. When using +// InputDataConfig , you must include these sub-parameters: S3Uri and +// DataAccessRoleArn . You can optionally include TuningDataS3Uri . type InputDataConfig struct { - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files. If the role that you specify - // doesn’t have the appropriate permissions to access the specified Amazon S3 - // location, your request fails. IAM role ARNs have the format - // arn:partition:iam::account:role/role-name-with-path. For example: - // arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role that you + // specify doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. IAM role ARNs have the format + // arn:partition:iam::account:role/role-name-with-path . For example: + // arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . // // This member is required. DataAccessRoleArn *string @@ -384,20 +377,12 @@ type InputDataConfig struct { // Flag the presence or absence of interruptions in your Call Analytics // transcription output. Rules using InterruptionFilter are designed to match: +// - Instances where an agent interrupts a customer +// - Instances where a customer interrupts an agent +// - Either participant interrupting the other +// - A lack of interruptions // -// * -// Instances where an agent interrupts a customer -// -// * Instances where a customer -// interrupts an agent -// -// * Either participant interrupting the other -// -// * A lack of -// interruptions -// -// See Rule criteria for post-call categories -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) +// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) // for usage examples. type InterruptionFilter struct { @@ -424,31 +409,30 @@ type InterruptionFilter struct { noSmithyDocumentSerde } -// Makes it possible to control how your transcription job is processed. Currently, -// the only JobExecutionSettings modification you can choose is enabling job -// queueing using the AllowDeferredExecution sub-parameter. If you include -// JobExecutionSettings in your request, you must also include the sub-parameters: -// AllowDeferredExecution and DataAccessRoleArn. +// Makes it possible to control how your transcription job is processed. +// Currently, the only JobExecutionSettings modification you can choose is +// enabling job queueing using the AllowDeferredExecution sub-parameter. If you +// include JobExecutionSettings in your request, you must also include the +// sub-parameters: AllowDeferredExecution and DataAccessRoleArn . type JobExecutionSettings struct { // Makes it possible to enable job queuing when your concurrent request limit is - // exceeded. When AllowDeferredExecution is set to true, transcription job requests - // are placed in a queue until the number of jobs falls below the concurrent - // request limit. If AllowDeferredExecution is set to false and the number of - // transcription job requests exceed the concurrent request limit, you get a - // LimitExceededException error. If you include AllowDeferredExecution in your - // request, you must also include DataAccessRoleArn. + // exceeded. When AllowDeferredExecution is set to true , transcription job + // requests are placed in a queue until the number of jobs falls below the + // concurrent request limit. If AllowDeferredExecution is set to false and the + // number of transcription job requests exceed the concurrent request limit, you + // get a LimitExceededException error. If you include AllowDeferredExecution in + // your request, you must also include DataAccessRoleArn . AllowDeferredExecution *bool - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files. If the role that you specify - // doesn’t have the appropriate permissions to access the specified Amazon S3 - // location, your request fails. IAM role ARNs have the format - // arn:partition:iam::account:role/role-name-with-path. For example: - // arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). - // Note that if you include DataAccessRoleArn in your request, you must also - // include AllowDeferredExecution. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role that you + // specify doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. IAM role ARNs have the format + // arn:partition:iam::account:role/role-name-with-path . For example: + // arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . Note that if you include DataAccessRoleArn in your request, you must also + // include AllowDeferredExecution . DataAccessRoleArn *string noSmithyDocumentSerde @@ -470,27 +454,27 @@ type LanguageCodeItem struct { noSmithyDocumentSerde } -// If using automatic language identification in your request and you want to apply -// a custom language model, a custom vocabulary, or a custom vocabulary filter, -// include LanguageIdSettings with the relevant sub-parameters (VocabularyName, -// LanguageModelName, and VocabularyFilterName). Note that multi-language -// identification (IdentifyMultipleLanguages) doesn't support custom language -// models. LanguageIdSettings supports two to five language codes. Each language -// code you include can have an associated custom language model, custom -// vocabulary, and custom vocabulary filter. The language codes that you specify -// must match the languages of the associated custom language models, custom -// vocabularies, and custom vocabulary filters. It's recommended that you include -// LanguageOptions when using LanguageIdSettings to ensure that the correct -// language dialect is identified. For example, if you specify a custom vocabulary -// that is in en-US but Amazon Transcribe determines that the language spoken in -// your media is en-AU, your custom vocabulary is not applied to your +// If using automatic language identification in your request and you want to +// apply a custom language model, a custom vocabulary, or a custom vocabulary +// filter, include LanguageIdSettings with the relevant sub-parameters ( +// VocabularyName , LanguageModelName , and VocabularyFilterName ). Note that +// multi-language identification ( IdentifyMultipleLanguages ) doesn't support +// custom language models. LanguageIdSettings supports two to five language codes. +// Each language code you include can have an associated custom language model, +// custom vocabulary, and custom vocabulary filter. The language codes that you +// specify must match the languages of the associated custom language models, +// custom vocabularies, and custom vocabulary filters. It's recommended that you +// include LanguageOptions when using LanguageIdSettings to ensure that the +// correct language dialect is identified. For example, if you specify a custom +// vocabulary that is in en-US but Amazon Transcribe determines that the language +// spoken in your media is en-AU , your custom vocabulary is not applied to your // transcription. If you include LanguageOptions and include en-US as the only // English language dialect, your custom vocabulary is applied to your // transcription. If you want to include a custom language model with your request // but do not want to use automatic language identification, use instead the // parameter with the LanguageModelName sub-parameter. If you want to include a // custom vocabulary or a custom vocabulary filter (or both) with your request but -// do not want to use automatic language identification, use instead the parameter +// do not want to use automatic language identification, use instead the parameter // with the VocabularyName or VocabularyFilterName (or both) sub-parameter. type LanguageIdSettings struct { @@ -509,7 +493,7 @@ type LanguageIdSettings struct { // the custom vocabulary filter isn't applied. There are no errors or warnings // associated with a language mismatch. Note that if you include // VocabularyFilterName in your request, you must also include - // VocabularyFilterMethod. + // VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to use when processing your @@ -524,26 +508,14 @@ type LanguageIdSettings struct { } // Provides information about a custom language model, including: -// -// * The base model -// name -// -// * When the model was created -// -// * The location of the files used to train -// the model -// -// * When the model was last modified -// -// * The name you chose for the -// model -// -// * The model's language -// -// * The model's processing state -// -// * Any available -// upgrades for the base model +// - The base model name +// - When the model was created +// - The location of the files used to train the model +// - When the model was last modified +// - The name you chose for the model +// - The model's language +// - The model's processing state +// - Any available upgrades for the base model type LanguageModel struct { // The Amazon Transcribe standard language model, or base model, used to create @@ -551,13 +523,13 @@ type LanguageModel struct { BaseModelName BaseModelName // The date and time the specified custom language model was created. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. CreateTime *time.Time - // If ModelStatus is FAILED, FailureReason contains information about why the - // custom language model request failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If ModelStatus is FAILED , FailureReason contains information about why the + // custom language model request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string // The Amazon S3 location of the input files used to train and tune your custom @@ -569,14 +541,13 @@ type LanguageModel struct { // language model must contain terms in only one language, and the language you // select for your custom language model must match the language of your training // and tuning data. For a list of supported languages and their associated language - // codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // table. Note that U.S. English (en-US) is the only language supported with Amazon - // Transcribe Medical. + // codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. Note that U.S. English ( en-US ) is the only language supported with + // Amazon Transcribe Medical. LanguageCode CLMLanguageCode // The date and time the specified custom language model was last modified. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time @@ -590,8 +561,8 @@ type LanguageModel struct { ModelStatus ModelStatus // Shows if a more current base model is available for use with the specified - // custom language model. If false, your custom language model is using the most - // up-to-date base model. If true, there is a newer base model available than the + // custom language model. If false , your custom language model is using the most + // up-to-date base model. If true , there is a newer base model available than the // one your language model is using. Note that to update a base model, you must // recreate the custom language model using the new base model. Base model upgrades // for existing custom language models are not supported. @@ -601,40 +572,27 @@ type LanguageModel struct { } // Describes the Amazon S3 location of the media file you want to use in your -// request. For information on supported media formats, refer to the MediaFormat -// (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) -// parameter or the Media formats -// (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) +// request. For information on supported media formats, refer to the MediaFormat (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) +// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) // section in the Amazon S3 Developer Guide. type Media struct { // The Amazon S3 location of the media file you want to transcribe. For example: - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-media-file.flac - // - // * - // s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac - // - // Note that the Amazon S3 - // bucket that contains your input media must be located in the same Amazon Web - // Services Region where you're making your transcription request. + // - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac + // - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac + // Note that the Amazon S3 bucket that contains your input media must be located + // in the same Amazon Web Services Region where you're making your transcription + // request. MediaFileUri *string // The Amazon S3 location of the media file you want to redact. For example: - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-media-file.flac - // - // * - // s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac - // - // Note that the Amazon S3 - // bucket that contains your input media must be located in the same Amazon Web - // Services Region where you're making your transcription request. - // RedactedMediaFileUri produces a redacted audio file in addition to a redacted - // transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) - // transcription requests. + // - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac + // - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac + // Note that the Amazon S3 bucket that contains your input media must be located + // in the same Amazon Web Services Region where you're making your transcription + // request. RedactedMediaFileUri produces a redacted audio file in addition to a + // redacted transcript. It is only supported for Call Analytics ( + // StartCallAnalyticsJob ) transcription requests. RedactedMediaFileUri *string noSmithyDocumentSerde @@ -653,14 +611,14 @@ type MedicalTranscript struct { // Provides detailed information about a medical transcription job. To view the // status of the specified medical transcription job, check the -// TranscriptionJobStatus field. If the status is COMPLETED, the job is finished -// and you can find the results at the location specified in TranscriptFileUri. If -// the status is FAILED, FailureReason provides details on why your transcription +// TranscriptionJobStatus field. If the status is COMPLETED , the job is finished +// and you can find the results at the location specified in TranscriptFileUri . If +// the status is FAILED , FailureReason provides details on why your transcription // job failed. type MedicalTranscriptionJob struct { // The date and time the specified medical transcription job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time @@ -670,54 +628,44 @@ type MedicalTranscriptionJob struct { ContentIdentificationType MedicalContentIdentificationType // The date and time the specified medical transcription job request was made. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time - // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // If TranscriptionJobStatus is FAILED , FailureReason contains information about // why the transcription job request failed. The FailureReason field contains one // of the following values: + // - Unsupported media format . The media format specified in MediaFormat isn't + // valid. Refer to MediaFormat for a list of supported formats. + // - The media format provided does not match the detected media format . The + // media format specified in MediaFormat doesn't match the format of the input + // file. Check the media format of your media file and correct the specified value. // - // * Unsupported media format. The media format specified - // in MediaFormat isn't valid. Refer to MediaFormat for a list of supported - // formats. - // - // * The media format provided does not match the detected media format. - // The media format specified in MediaFormat doesn't match the format of the input - // file. Check the media format of your media file and correct the specified - // value. - // - // * Invalid sample rate for audio file. The sample rate specified in - // MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and - // 48,000 hertz. - // - // * The sample rate provided does not match the detected sample - // rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample - // rate detected in your input media file. Check the sample rate of your media file - // and correct the specified value. - // - // * Invalid file size: file size too large. The - // size of your media file is larger than what Amazon Transcribe can process. For - // more information, refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). - // - // * - // Invalid number of channels: number of channels too large. Your audio contains - // more channels than Amazon Transcribe is able to process. For more information, - // refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). + // - Invalid sample rate for audio file . The sample rate specified in + // MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and + // 48,000 hertz. + // - The sample rate provided does not match the detected sample rate . The + // sample rate specified in MediaSampleRateHertz doesn't match the sample rate + // detected in your input media file. Check the sample rate of your media file and + // correct the specified value. + // - Invalid file size: file size too large . The size of your media file is + // larger than what Amazon Transcribe can process. For more information, refer to + // Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . + // - Invalid number of channels: number of channels too large . Your audio + // contains more channels than Amazon Transcribe is able to process. For more + // information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . FailureReason *string - // The language code used to create your medical transcription job. US English - // (en-US) is the only supported language for medical transcriptions. + // The language code used to create your medical transcription job. US English ( + // en-US ) is the only supported language for medical transcriptions. LanguageCode LanguageCode // Describes the Amazon S3 location of the media file you want to use in your - // request. For information on supported media formats, refer to the MediaFormat - // (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) - // parameter or the Media formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // request. For information on supported media formats, refer to the MediaFormat (https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat) + // parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) // section in the Amazon S3 Developer Guide. Media *Media @@ -727,8 +675,8 @@ type MedicalTranscriptionJob struct { // The sample rate, in hertz, of the audio track in your input media file. MediaSampleRateHertz *int32 - // The name of the medical transcription job. Job names are case sensitive and must - // be unique within an Amazon Web Services account. + // The name of the medical transcription job. Job names are case sensitive and + // must be unique within an Amazon Web Services account. MedicalTranscriptionJobName *string // Provides information on any additional settings that were included in your @@ -741,7 +689,7 @@ type MedicalTranscriptionJob struct { Specialty Specialty // The date and time the specified medical transcription job began processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -753,14 +701,14 @@ type MedicalTranscriptionJob struct { // Provides you with the Amazon S3 URI you can use to access your transcript. Transcript *MedicalTranscript - // Provides the status of the specified medical transcription job. If the status is - // COMPLETED, the job is finished and you can find the results at the location - // specified in TranscriptFileUri. If the status is FAILED, FailureReason provides - // details on why your transcription job failed. + // Provides the status of the specified medical transcription job. If the status + // is COMPLETED , the job is finished and you can find the results at the location + // specified in TranscriptFileUri . If the status is FAILED , FailureReason + // provides details on why your transcription job failed. TranscriptionJobStatus TranscriptionJobStatus - // Indicates whether the input media is a dictation or a conversation, as specified - // in the StartMedicalTranscriptionJob request. + // Indicates whether the input media is a dictation or a conversation, as + // specified in the StartMedicalTranscriptionJob request. Type Type noSmithyDocumentSerde @@ -770,40 +718,40 @@ type MedicalTranscriptionJob struct { type MedicalTranscriptionJobSummary struct { // The date and time the specified medical transcription job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time // Labels all personal health information (PHI) identified in your transcript. For // more information, see Identifying personal health information (PHI) in a - // transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). + // transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html) . ContentIdentificationType MedicalContentIdentificationType // The date and time the specified medical transcription job request was made. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time - // If TranscriptionJobStatus is FAILED, FailureReason contains information about - // why the transcription job failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If TranscriptionJobStatus is FAILED , FailureReason contains information about + // why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string - // The language code used to create your medical transcription. US English (en-US) - // is the only supported language for medical transcriptions. + // The language code used to create your medical transcription. US English ( en-US + // ) is the only supported language for medical transcriptions. LanguageCode LanguageCode - // The name of the medical transcription job. Job names are case sensitive and must - // be unique within an Amazon Web Services account. + // The name of the medical transcription job. Job names are case sensitive and + // must be unique within an Amazon Web Services account. MedicalTranscriptionJobName *string // Indicates where the specified medical transcription output is stored. If the - // value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified + // value is CUSTOMER_BUCKET , the location is the Amazon S3 bucket you specified // using the OutputBucketName parameter in your request. If you also included // OutputKey in your request, your output is located in the path you specified in - // your request. If the value is SERVICE_BUCKET, the location is a service-managed + // your request. If the value is SERVICE_BUCKET , the location is a service-managed // Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use // the URI shown in the TranscriptFileUri field. OutputLocationType OutputLocationType @@ -812,19 +760,19 @@ type MedicalTranscriptionJobSummary struct { Specialty Specialty // The date and time your medical transcription job began processing. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time // Provides the status of your medical transcription job. If the status is - // COMPLETED, the job is finished and you can find the results at the location - // specified in TranscriptFileUri. If the status is FAILED, FailureReason provides - // details on why your transcription job failed. + // COMPLETED , the job is finished and you can find the results at the location + // specified in TranscriptFileUri . If the status is FAILED , FailureReason + // provides details on why your transcription job failed. TranscriptionJobStatus TranscriptionJobStatus - // Indicates whether the input media is a dictation or a conversation, as specified - // in the StartMedicalTranscriptionJob request. + // Indicates whether the input media is a dictation or a conversation, as + // specified in the StartMedicalTranscriptionJob request. Type Type noSmithyDocumentSerde @@ -841,9 +789,9 @@ type MedicalTranscriptionSetting struct { // enable channel identification, your audio is transcribed in a continuous manner // and your transcript does not separate the speech by channel. You can't include // both ShowSpeakerLabels and ChannelIdentification in the same request. Including - // both parameters returns a BadRequestException. For more information, see - // Transcribing multi-channel audio - // (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). + // both parameters returns a BadRequestException . For more information, see + // Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) + // . ChannelIdentification *bool // Indicate the maximum number of alternative transcriptions you want Amazon @@ -851,32 +799,32 @@ type MedicalTranscriptionSetting struct { // than the number of alternative transcriptions generated by Amazon Transcribe // Medical, only the actual number of alternative transcriptions are included. If // you include MaxAlternatives in your request, you must also include - // ShowAlternatives with a value of true. For more information, see Alternative - // transcriptions - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). + // ShowAlternatives with a value of true . For more information, see Alternative + // transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html) + // . MaxAlternatives *int32 - // Specify the maximum number of speakers you want to partition in your media. Note - // that if your media contains more speakers than the specified number, multiple - // speakers are treated as a single speaker. If you specify the MaxSpeakerLabels - // field, you must set the ShowSpeakerLabels field to true. + // Specify the maximum number of speakers you want to partition in your media. + // Note that if your media contains more speakers than the specified number, + // multiple speakers are treated as a single speaker. If you specify the + // MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true. MaxSpeakerLabels *int32 // To include alternative transcriptions within your transcription output, include - // ShowAlternatives in your transcription request. If you include ShowAlternatives, - // you must also include MaxAlternatives, which is the maximum number of + // ShowAlternatives in your transcription request. If you include ShowAlternatives + // , you must also include MaxAlternatives , which is the maximum number of // alternative transcriptions you want Amazon Transcribe Medical to generate. For - // more information, see Alternative transcriptions - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). + // more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html) + // . ShowAlternatives *bool - // Enables speaker partitioning (diarization) in your transcription output. Speaker - // partitioning labels the speech from individual speakers in your media file. If - // you enable ShowSpeakerLabels in your request, you must also include - // MaxSpeakerLabels. You can't include ShowSpeakerLabels and ChannelIdentification - // in the same request. Including both parameters returns a BadRequestException. - // For more information, see Partitioning speakers (diarization) - // (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. If you enable ShowSpeakerLabels in your request, you must also include + // MaxSpeakerLabels . You can't include ShowSpeakerLabels and ChannelIdentification + // in the same request. Including both parameters returns a BadRequestException . + // For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) + // . ShowSpeakerLabels *bool // The name of the custom vocabulary you want to use when processing your medical @@ -884,7 +832,7 @@ type MedicalTranscriptionSetting struct { // the specified custom vocabulary must match the language code that you specify in // your transcription request. If the languages don't match, the custom vocabulary // isn't applied. There are no errors or warnings associated with a language - // mismatch. US English (en-US) is the only valid language for Amazon Transcribe + // mismatch. US English ( en-US ) is the only valid language for Amazon Transcribe // Medical. VocabularyName *string @@ -893,9 +841,9 @@ type MedicalTranscriptionSetting struct { // Provides the name of the custom language model that was included in the // specified transcription job. Only use ModelSettings with the LanguageModelName -// sub-parameter if you're not using automatic language identification (). If using -// LanguageIdSettings in your request, this parameter contains a LanguageModelName -// sub-parameter. +// sub-parameter if you're not using automatic language identification ( ). If +// using LanguageIdSettings in your request, this parameter contains a +// LanguageModelName sub-parameter. type ModelSettings struct { // The name of the custom language model you want to use when processing your @@ -911,16 +859,10 @@ type ModelSettings struct { // Flag the presence or absence of periods of silence in your Call Analytics // transcription output. Rules using NonTalkTimeFilter are designed to match: +// - The presence of silence at specified periods throughout the call +// - The presence of speech at specified periods throughout the call // -// * -// The presence of silence at specified periods throughout the call -// -// * The presence -// of speech at specified periods throughout the call -// -// See Rule criteria for -// post-call categories -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) +// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) // for usage examples. type NonTalkTimeFilter struct { @@ -935,8 +877,9 @@ type NonTalkTimeFilter struct { // during which you want to search for a period of silence. See for more detail. RelativeTimeRange *RelativeTimeRange - // Specify the duration, in milliseconds, of the period of silence that you want to - // flag. For example, you can flag a silent period that lasts 30,000 milliseconds. + // Specify the duration, in milliseconds, of the period of silence that you want + // to flag. For example, you can flag a silent period that lasts 30,000 + // milliseconds. Threshold *int64 noSmithyDocumentSerde @@ -946,17 +889,17 @@ type NonTalkTimeFilter struct { // StartPercentage and EndPercentage to search a custom segment. For example, // setting StartPercentage to 10 and EndPercentage to 50 only searches for your // specified criteria in the audio contained between the 10 percent mark and the 50 -// percent mark of your media file. You can use also First to search from the start -// of the media file until the time that you specify. Or use Last to search from -// the time that you specify until the end of the media file. For example, setting -// First to 10 only searches for your specified criteria in the audio contained in -// the first 10 percent of the media file. If you prefer to use milliseconds -// instead of percentage, see . +// percent mark of your media file. You can use also First to search from the +// start of the media file until the time that you specify. Or use Last to search +// from the time that you specify until the end of the media file. For example, +// setting First to 10 only searches for your specified criteria in the audio +// contained in the first 10 percent of the media file. If you prefer to use +// milliseconds instead of percentage, see . type RelativeTimeRange struct { // The time, in percentage, when Amazon Transcribe stops searching for the // specified criteria in your media file. If you include EndPercentage in your - // request, you must also include StartPercentage. + // request, you must also include StartPercentage . EndPercentage *int32 // The time, in percentage, from the start of your media file until the specified @@ -971,7 +914,7 @@ type RelativeTimeRange struct { // The time, in percentage, when Amazon Transcribe starts searching for the // specified criteria in your media file. If you include StartPercentage in your - // request, you must also include EndPercentage. + // request, you must also include EndPercentage . StartPercentage *int32 noSmithyDocumentSerde @@ -980,13 +923,11 @@ type RelativeTimeRange struct { // A rule is a set of criteria that you can specify to flag an attribute in your // Call Analytics output. Rules define a Call Analytics category. Rules can include // these parameters: , , , and . To learn more about Call Analytics rules and -// categories, see Creating categories for post-call transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and -// Creating categories for real-time transcriptions -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html). -// To learn more about Call Analytics, see Analyzing call center audio with Call -// Analytics -// (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html). +// categories, see Creating categories for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) +// and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html) +// . To learn more about Call Analytics, see Analyzing call center audio with Call +// Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) +// . // // The following types satisfy this interface: // @@ -1028,8 +969,8 @@ type RuleMemberSentimentFilter struct { func (*RuleMemberSentimentFilter) isRule() {} -// Flag the presence or absence of specific words or phrases in your Call Analytics -// transcription output. Refer to for more detail. +// Flag the presence or absence of specific words or phrases in your Call +// Analytics transcription output. Refer to for more detail. type RuleMemberTranscriptFilter struct { Value TranscriptFilter @@ -1041,23 +982,16 @@ func (*RuleMemberTranscriptFilter) isRule() {} // Flag the presence or absence of specific sentiments detected in your Call // Analytics transcription output. Rules using SentimentFilter are designed to // match: +// - The presence or absence of a positive sentiment felt by the customer, +// agent, or both at specified points in the call +// - The presence or absence of a negative sentiment felt by the customer, +// agent, or both at specified points in the call +// - The presence or absence of a neutral sentiment felt by the customer, agent, +// or both at specified points in the call +// - The presence or absence of a mixed sentiment felt by the customer, the +// agent, or both at specified points in the call // -// * The presence or absence of a positive sentiment felt by the customer, -// agent, or both at specified points in the call -// -// * The presence or absence of a -// negative sentiment felt by the customer, agent, or both at specified points in -// the call -// -// * The presence or absence of a neutral sentiment felt by the customer, -// agent, or both at specified points in the call -// -// * The presence or absence of a -// mixed sentiment felt by the customer, the agent, or both at specified points in -// the call -// -// See Rule criteria for post-call categories -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) +// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) // for usage examples. type SentimentFilter struct { @@ -1096,8 +1030,8 @@ type Settings struct { // transcribes the audio on each channel independently, then appends the output for // each channel into one transcript. You can't include both ShowSpeakerLabels and // ChannelIdentification in the same request. Including both parameters returns a - // BadRequestException. For more information, see Transcribing multi-channel audio - // (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). + // BadRequestException . For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) + // . ChannelIdentification *bool // Indicate the maximum number of alternative transcriptions you want Amazon @@ -1105,46 +1039,46 @@ type Settings struct { // the number of alternative transcriptions generated by Amazon Transcribe, only // the actual number of alternative transcriptions are included. If you include // MaxAlternatives in your request, you must also include ShowAlternatives with a - // value of true. For more information, see Alternative transcriptions - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). + // value of true . For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html) + // . MaxAlternatives *int32 - // Specify the maximum number of speakers you want to partition in your media. Note - // that if your media contains more speakers than the specified number, multiple - // speakers are treated as a single speaker. If you specify the MaxSpeakerLabels - // field, you must set the ShowSpeakerLabels field to true. + // Specify the maximum number of speakers you want to partition in your media. + // Note that if your media contains more speakers than the specified number, + // multiple speakers are treated as a single speaker. If you specify the + // MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true. MaxSpeakerLabels *int32 // To include alternative transcriptions within your transcription output, include // ShowAlternatives in your transcription request. If you have multi-channel audio // and do not enable channel identification, your audio is transcribed in a // continuous manner and your transcript does not separate the speech by channel. - // If you include ShowAlternatives, you must also include MaxAlternatives, which is - // the maximum number of alternative transcriptions you want Amazon Transcribe to - // generate. For more information, see Alternative transcriptions - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). + // If you include ShowAlternatives , you must also include MaxAlternatives , which + // is the maximum number of alternative transcriptions you want Amazon Transcribe + // to generate. For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html) + // . ShowAlternatives *bool - // Enables speaker partitioning (diarization) in your transcription output. Speaker - // partitioning labels the speech from individual speakers in your media file. If - // you enable ShowSpeakerLabels in your request, you must also include - // MaxSpeakerLabels. You can't include both ShowSpeakerLabels and + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. If you enable ShowSpeakerLabels in your request, you must also include + // MaxSpeakerLabels . You can't include both ShowSpeakerLabels and // ChannelIdentification in the same request. Including both parameters returns a - // BadRequestException. For more information, see Partitioning speakers - // (diarization) - // (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). + // BadRequestException . For more information, see Partitioning speakers + // (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) + // . ShowSpeakerLabels *bool // Specify how you want your custom vocabulary filter applied to your transcript. - // To replace words with ***, choose mask. To delete words, choose remove. To flag - // words without changing them, choose tag. + // To replace words with *** , choose mask . To delete words, choose remove . To + // flag words without changing them, choose tag . VocabularyFilterMethod VocabularyFilterMethod // The name of the custom vocabulary filter you want to use in your transcription // job request. This name is case sensitive, cannot contain spaces, and must be // unique within an Amazon Web Services account. Note that if you include // VocabularyFilterName in your request, you must also include - // VocabularyFilterMethod. + // VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to use in your transcription job @@ -1161,14 +1095,14 @@ type Settings struct { // same location as your transcription output. type Subtitles struct { - // Specify the output format for your subtitle file; if you select both WebVTT - // (vtt) and SubRip (srt) formats, two output files are generated. + // Specify the output format for your subtitle file; if you select both WebVTT ( vtt + // ) and SubRip ( srt ) formats, two output files are generated. Formats []SubtitleFormat // Specify the starting value that is assigned to the first subtitle segment. The - // default start index for Amazon Transcribe is 0, which differs from the more - // widely used standard of 1. If you're uncertain which value to use, we recommend - // choosing 1, as this may improve compatibility with other services. + // default start index for Amazon Transcribe is 0 , which differs from the more + // widely used standard of 1 . If you're uncertain which value to use, we recommend + // choosing 1 , as this may improve compatibility with other services. OutputStartIndex *int32 noSmithyDocumentSerde @@ -1178,12 +1112,12 @@ type Subtitles struct { // and Amazon S3 location. type SubtitlesOutput struct { - // Provides the format of your subtitle files. If your request included both WebVTT - // (vtt) and SubRip (srt) formats, both formats are shown. + // Provides the format of your subtitle files. If your request included both + // WebVTT ( vtt ) and SubRip ( srt ) formats, both formats are shown. Formats []SubtitleFormat - // Provides the start index value for your subtitle files. If you did not specify a - // value in your request, the default value of 0 is used. + // Provides the start index value for your subtitle files. If you did not specify + // a value in your request, the default value of 0 is used. OutputStartIndex *int32 // The Amazon S3 location of your transcript. You can use this URI to access or @@ -1206,18 +1140,18 @@ type SubtitlesOutput struct { // Adds metadata, in the form of a key:value pair, to the specified resource. For // example, you could add the tag Department:Sales to a resource to indicate that // it pertains to your organization's sales department. You can also use tags for -// tag-based access control. To learn more about tagging, see Tagging resources -// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). +// tag-based access control. To learn more about tagging, see Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) +// . type Tag struct { // The first part of a key:value pair that forms a tag associated with a given - // resource. For example, in the tag Department:Sales, the key is 'Department'. + // resource. For example, in the tag Department:Sales , the key is 'Department'. // // This member is required. Key *string // The second part of a key:value pair that forms a tag associated with a given - // resource. For example, in the tag Department:Sales, the value is 'Sales'. Note + // resource. For example, in the tag Department:Sales , the value is 'Sales'. Note // that you can set the value of a tag to an empty string, but you can't set the // value of a tag to null. Omitting the tag value is the same as using an empty // string. @@ -1245,15 +1179,16 @@ type Transcript struct { RedactedTranscriptFileUri *string // The Amazon S3 location of your transcript. You can use this URI to access or - // download your transcript. If you included OutputBucketName in your transcription - // job request, this is the URI of that bucket. If you also included OutputKey in - // your request, your output is located in the path you specified in your request. - // If you didn't include OutputBucketName in your transcription job request, your - // transcript is stored in a service-managed bucket, and TranscriptFileUri provides - // you with a temporary URI you can use for secure access to your transcript. - // Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 - // minutes. If you get an AccesDenied error, you can get a new temporary URI by - // running a GetTranscriptionJob or ListTranscriptionJob request. + // download your transcript. If you included OutputBucketName in your + // transcription job request, this is the URI of that bucket. If you also included + // OutputKey in your request, your output is located in the path you specified in + // your request. If you didn't include OutputBucketName in your transcription job + // request, your transcript is stored in a service-managed bucket, and + // TranscriptFileUri provides you with a temporary URI you can use for secure + // access to your transcript. Temporary URIs for service-managed Amazon S3 buckets + // are only valid for 15 minutes. If you get an AccesDenied error, you can get a + // new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob + // request. TranscriptFileUri *string noSmithyDocumentSerde @@ -1262,20 +1197,12 @@ type Transcript struct { // Flag the presence or absence of specific words or phrases detected in your Call // Analytics transcription output. Rules using TranscriptFilter are designed to // match: +// - Custom words or phrases spoken by the agent, the customer, or both +// - Custom words or phrases not spoken by the agent, the customer, or either +// - Custom words or phrases that occur at a specific time frame // -// * Custom words or phrases spoken by the agent, the customer, or both -// -// * -// Custom words or phrases not spoken by the agent, the customer, or either -// -// * -// Custom words or phrases that occur at a specific time frame -// -// See Rule criteria -// for post-call categories -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) -// and Rule criteria for streaming categories -// (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream) +// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) +// and Rule criteria for streaming categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream) // for usage examples. type TranscriptFilter struct { @@ -1317,15 +1244,15 @@ type TranscriptFilter struct { // Provides detailed information about a transcription job. To view the status of // the specified transcription job, check the TranscriptionJobStatus field. If the -// status is COMPLETED, the job is finished and you can find the results at the -// location specified in TranscriptFileUri. If the status is FAILED, FailureReason -// provides details on why your transcription job failed. If you enabled content -// redaction, the redacted transcript can be found at the location specified in -// RedactedTranscriptFileUri. +// status is COMPLETED , the job is finished and you can find the results at the +// location specified in TranscriptFileUri . If the status is FAILED , +// FailureReason provides details on why your transcription job failed. If you +// enabled content redaction, the redacted transcript can be found at the location +// specified in RedactedTranscriptFileUri . type TranscriptionJob struct { // The date and time the specified transcription job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time @@ -1334,57 +1261,49 @@ type TranscriptionJob struct { ContentRedaction *ContentRedaction // The date and time the specified transcription job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time - // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // If TranscriptionJobStatus is FAILED , FailureReason contains information about // why the transcription job request failed. The FailureReason field contains one // of the following values: + // - Unsupported media format . The media format specified in MediaFormat isn't + // valid. Refer to MediaFormat for a list of supported formats. + // - The media format provided does not match the detected media format . The + // media format specified in MediaFormat doesn't match the format of the input + // file. Check the media format of your media file and correct the specified value. // - // * Unsupported media format. The media format specified - // in MediaFormat isn't valid. Refer to MediaFormat for a list of supported - // formats. - // - // * The media format provided does not match the detected media format. - // The media format specified in MediaFormat doesn't match the format of the input - // file. Check the media format of your media file and correct the specified - // value. - // - // * Invalid sample rate for audio file. The sample rate specified in - // MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and - // 48,000 hertz. - // - // * The sample rate provided does not match the detected sample - // rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample - // rate detected in your input media file. Check the sample rate of your media file - // and correct the specified value. - // - // * Invalid file size: file size too large. The - // size of your media file is larger than what Amazon Transcribe can process. For - // more information, refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). - // - // * - // Invalid number of channels: number of channels too large. Your audio contains - // more channels than Amazon Transcribe is able to process. For more information, - // refer to Guidelines and quotas - // (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). + // - Invalid sample rate for audio file . The sample rate specified in + // MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and + // 48,000 hertz. + // - The sample rate provided does not match the detected sample rate . The + // sample rate specified in MediaSampleRateHertz doesn't match the sample rate + // detected in your input media file. Check the sample rate of your media file and + // correct the specified value. + // - Invalid file size: file size too large . The size of your media file is + // larger than what Amazon Transcribe can process. For more information, refer to + // Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . + // - Invalid number of channels: number of channels too large . Your audio + // contains more channels than Amazon Transcribe is able to process. For more + // information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) + // . FailureReason *string - // The confidence score associated with the language identified in your media file. - // Confidence scores are values between 0 and 1; a larger value indicates a higher - // probability that the identified language correctly matches the language spoken - // in your media. + // The confidence score associated with the language identified in your media + // file. Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float32 - // Indicates whether automatic language identification was enabled (TRUE) for the + // Indicates whether automatic language identification was enabled ( TRUE ) for the // specified transcription job. IdentifyLanguage *bool - // Indicates whether automatic multi-language identification was enabled (TRUE) for - // the specified transcription job. + // Indicates whether automatic multi-language identification was enabled ( TRUE ) + // for the specified transcription job. IdentifyMultipleLanguages *bool // Provides information about how your transcription job was processed. This @@ -1393,12 +1312,12 @@ type TranscriptionJob struct { // The language code used to create your transcription job. This parameter is used // with single-language identification. For multi-language identification requests, - // refer to the plural version of this parameter, LanguageCodes. + // refer to the plural version of this parameter, LanguageCodes . LanguageCode LanguageCode - // The language codes used to create your transcription job. This parameter is used - // with multi-language identification. For single-language identification requests, - // refer to the singular version of this parameter, LanguageCode. + // The language codes used to create your transcription job. This parameter is + // used with multi-language identification. For single-language identification + // requests, refer to the singular version of this parameter, LanguageCode . LanguageCodes []LanguageCodeItem // Provides the name and language of all custom language models, custom @@ -1427,7 +1346,7 @@ type TranscriptionJob struct { Settings *Settings // The date and time the specified transcription job began processing. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -1447,9 +1366,9 @@ type TranscriptionJob struct { TranscriptionJobName *string // Provides the status of the specified transcription job. If the status is - // COMPLETED, the job is finished and you can find the results at the location - // specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested - // transcript redaction). If the status is FAILED, FailureReason provides details + // COMPLETED , the job is finished and you can find the results at the location + // specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested + // transcript redaction). If the status is FAILED , FailureReason provides details // on why your transcription job failed. TranscriptionJobStatus TranscriptionJobStatus @@ -1460,7 +1379,7 @@ type TranscriptionJob struct { type TranscriptionJobSummary struct { // The date and time the specified transcription job finished processing. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time @@ -1469,56 +1388,56 @@ type TranscriptionJobSummary struct { ContentRedaction *ContentRedaction // The date and time the specified transcription job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time - // If TranscriptionJobStatus is FAILED, FailureReason contains information about - // why the transcription job failed. See also: Common Errors - // (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). + // If TranscriptionJobStatus is FAILED , FailureReason contains information about + // why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) + // . FailureReason *string - // The confidence score associated with the language identified in your media file. - // Confidence scores are values between 0 and 1; a larger value indicates a higher - // probability that the identified language correctly matches the language spoken - // in your media. + // The confidence score associated with the language identified in your media + // file. Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float32 - // Indicates whether automatic language identification was enabled (TRUE) for the + // Indicates whether automatic language identification was enabled ( TRUE ) for the // specified transcription job. IdentifyLanguage *bool - // Indicates whether automatic multi-language identification was enabled (TRUE) for - // the specified transcription job. + // Indicates whether automatic multi-language identification was enabled ( TRUE ) + // for the specified transcription job. IdentifyMultipleLanguages *bool // The language code used to create your transcription. LanguageCode LanguageCode - // The language codes used to create your transcription job. This parameter is used - // with multi-language identification. For single-language identification, the - // singular version of this parameter, LanguageCode, is present. + // The language codes used to create your transcription job. This parameter is + // used with multi-language identification. For single-language identification, the + // singular version of this parameter, LanguageCode , is present. LanguageCodes []LanguageCodeItem // Provides the name of the custom language model that was included in the // specified transcription job. Only use ModelSettings with the LanguageModelName - // sub-parameter if you're not using automatic language identification (). If using - // LanguageIdSettings in your request, this parameter contains a LanguageModelName - // sub-parameter. + // sub-parameter if you're not using automatic language identification ( ). If + // using LanguageIdSettings in your request, this parameter contains a + // LanguageModelName sub-parameter. ModelSettings *ModelSettings // Indicates where the specified transcription output is stored. If the value is - // CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the + // CUSTOMER_BUCKET , the location is the Amazon S3 bucket you specified using the // OutputBucketName parameter in your request. If you also included OutputKey in // your request, your output is located in the path you specified in your request. - // If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 + // If the value is SERVICE_BUCKET , the location is a service-managed Amazon S3 // bucket. To access a transcript stored in a service-managed bucket, use the URI // shown in the TranscriptFileUri or RedactedTranscriptFileUri field. OutputLocationType OutputLocationType - // The date and time your transcription job began processing. Timestamps are in the - // format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // The date and time your transcription job began processing. Timestamps are in + // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -1527,33 +1446,32 @@ type TranscriptionJobSummary struct { // unique within an Amazon Web Services account. TranscriptionJobName *string - // Provides the status of your transcription job. If the status is COMPLETED, the + // Provides the status of your transcription job. If the status is COMPLETED , the // job is finished and you can find the results at the location specified in - // TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript - // redaction). If the status is FAILED, FailureReason provides details on why your - // transcription job failed. + // TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript + // redaction). If the status is FAILED , FailureReason provides details on why + // your transcription job failed. TranscriptionJobStatus TranscriptionJobStatus noSmithyDocumentSerde } -// Provides information about a custom vocabulary filter, including the language of -// the filter, when it was last modified, and its name. +// Provides information about a custom vocabulary filter, including the language +// of the filter, when it was last modified, and its name. type VocabularyFilterInfo struct { - // The language code that represents the language of the entries in your vocabulary - // filter. Each custom vocabulary filter must contain terms in only one language. A - // custom vocabulary filter can only be used to transcribe files in the same - // language as the filter. For example, if you create a custom vocabulary filter - // using US English (en-US), you can only apply this filter to files that contain - // English audio. For a list of supported languages and their associated language - // codes, refer to the Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // The language code that represents the language of the entries in your + // vocabulary filter. Each custom vocabulary filter must contain terms in only one + // language. A custom vocabulary filter can only be used to transcribe files in the + // same language as the filter. For example, if you create a custom vocabulary + // filter using US English ( en-US ), you can only apply this filter to files that + // contain English audio. For a list of supported languages and their associated + // language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. LanguageCode LanguageCode // The date and time the specified custom vocabulary filter was last modified. - // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time @@ -1573,12 +1491,12 @@ type VocabularyInfo struct { // The language code used to create your custom vocabulary. Each custom vocabulary // must contain terms in only one language. A custom vocabulary can only be used to // transcribe files in the same language as the custom vocabulary. For example, if - // you create a custom vocabulary using US English (en-US), you can only apply this - // custom vocabulary to files that contain English audio. + // you create a custom vocabulary using US English ( en-US ), you can only apply + // this custom vocabulary to files that contain English audio. LanguageCode LanguageCode // The date and time the specified custom vocabulary was last modified. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time @@ -1587,7 +1505,7 @@ type VocabularyInfo struct { // Services account. VocabularyName *string - // The processing state of your custom vocabulary. If the state is READY, you can + // The processing state of your custom vocabulary. If the state is READY , you can // use the custom vocabulary in a StartTranscriptionJob request. VocabularyState VocabularyState diff --git a/service/transcribestreaming/api_client.go b/service/transcribestreaming/api_client.go index 38ddc33d530..3bc7a4fd8eb 100644 --- a/service/transcribestreaming/api_client.go +++ b/service/transcribestreaming/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go b/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go index 0b45170ec0b..f733fa5c6c5 100644 --- a/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go @@ -17,20 +17,15 @@ import ( // Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to // Amazon Transcribe and the transcription results are streamed to your -// application. Use this operation for Call Analytics -// (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) +// application. Use this operation for Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) // transcriptions. The following parameters are required: +// - language-code +// - media-encoding +// - sample-rate // -// * language-code -// -// * -// media-encoding -// -// * sample-rate -// -// For more information on streaming with Amazon -// Transcribe, see Transcribing streaming audio -// (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). +// For more information on streaming with Amazon Transcribe, see Transcribing +// streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html) +// . func (c *Client) StartCallAnalyticsStreamTranscription(ctx context.Context, params *StartCallAnalyticsStreamTranscriptionInput, optFns ...func(*Options)) (*StartCallAnalyticsStreamTranscriptionOutput, error) { if params == nil { params = &StartCallAnalyticsStreamTranscriptionInput{} @@ -52,26 +47,19 @@ type StartCallAnalyticsStreamTranscriptionInput struct { // you're unsure of the language spoken in your audio, consider using // IdentifyLanguage to enable automatic language identification. For a list of // languages supported with streaming Call Analytics, refer to the Supported - // languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. // // This member is required. LanguageCode types.CallAnalyticsLanguageCode // Specify the encoding of your input audio. Supported formats are: - // - // * FLAC - // - // * - // OPUS-encoded audio in an Ogg container - // - // * PCM (only signed 16-bit little-endian - // audio formats, which does not include WAV) - // - // For more information, see Media - // formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). + // - FLAC + // - OPUS-encoded audio in an Ogg container + // - PCM (only signed 16-bit little-endian audio formats, which does not include + // WAV) + // For more information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // . // // This member is required. MediaEncoding types.MediaEncoding @@ -87,26 +75,26 @@ type StartCallAnalyticsStreamTranscriptionInput struct { // Labels all personally identifiable information (PII) identified in your // transcript. Content identification is performed at the segment level; PII // specified in PiiEntityTypes is flagged upon complete transcription of an audio - // segment. You can’t set ContentIdentificationType and ContentRedactionType in the - // same request. If you set both, your request returns a BadRequestException. For - // more information, see Redacting or identifying personally identifiable - // information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). + // segment. You can’t set ContentIdentificationType and ContentRedactionType in + // the same request. If you set both, your request returns a BadRequestException . + // For more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // . ContentIdentificationType types.ContentIdentificationType // Redacts all personally identifiable information (PII) identified in your // transcript. Content redaction is performed at the segment level; PII specified // in PiiEntityTypes is redacted upon complete transcription of an audio segment. // You can’t set ContentRedactionType and ContentIdentificationType in the same - // request. If you set both, your request returns a BadRequestException. For more - // information, see Redacting or identifying personally identifiable information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). + // request. If you set both, your request returns a BadRequestException . For more + // information, see Redacting or identifying personally identifiable information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // . ContentRedactionType types.ContentRedactionType // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. For - // more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). + // more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // . EnablePartialResultsStabilization bool // Specify the name of the custom language model that you want to use when @@ -115,24 +103,24 @@ type StartCallAnalyticsStreamTranscriptionInput struct { // code you specify in your transcription request. If the languages don't match, // the custom language model isn't applied. There are no errors or warnings // associated with a language mismatch. For more information, see Custom language - // models - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). + // models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) + // . LanguageModelName *string // Specify the level of stability to use when you enable partial results - // stabilization (EnablePartialResultsStabilization). Low stability provides the + // stabilization ( EnablePartialResultsStabilization ). Low stability provides the // highest accuracy. High stability transcribes faster, but with slightly lower - // accuracy. For more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). + // accuracy. For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // . PartialResultsStability types.PartialResultsStability // Specify which types of personally identifiable information (PII) you want to // redact in your transcript. You can include as many types as you'd like, or you - // can select ALL. To include PiiEntityTypes in your Call Analytics request, you - // must also include either ContentIdentificationType or ContentRedactionType. - // Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, - // EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL. + // can select ALL . To include PiiEntityTypes in your Call Analytics request, you + // must also include either ContentIdentificationType or ContentRedactionType . + // Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER , + // BANK_ROUTING , CREDIT_DEBIT_NUMBER , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , + // PIN , EMAIL , ADDRESS , NAME , PHONE , SSN , or ALL . PiiEntityTypes *string // Specify a name for your Call Analytics transcription session. If you don't @@ -142,8 +130,8 @@ type StartCallAnalyticsStreamTranscriptionInput struct { SessionId *string // Specify how you want your vocabulary filter applied to your transcript. To - // replace words with ***, choose mask. To delete words, choose remove. To flag - // words without changing them, choose tag. + // replace words with *** , choose mask . To delete words, choose remove . To flag + // words without changing them, choose tag . VocabularyFilterMethod types.VocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when @@ -151,16 +139,16 @@ type StartCallAnalyticsStreamTranscriptionInput struct { // sensitive. If the language of the specified custom vocabulary filter doesn't // match the language identified in your media, the vocabulary filter is not // applied to your transcription. For more information, see Using vocabulary - // filtering with unwanted words - // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). + // filtering with unwanted words (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) + // . VocabularyFilterName *string // Specify the name of the custom vocabulary that you want to use when processing // your transcription. Note that vocabulary names are case sensitive. If the // language of the specified custom vocabulary doesn't match the language // identified in your media, the custom vocabulary is not applied to your - // transcription. For more information, see Custom vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). + // transcription. For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) + // . VocabularyName *string noSmithyDocumentSerde diff --git a/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go b/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go index 1a7acd95d85..c48b2d713ff 100644 --- a/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go @@ -18,17 +18,13 @@ import ( // Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to // Amazon Transcribe Medical and the transcription results are streamed to your // application. The following parameters are required: +// - language-code +// - media-encoding +// - sample-rate // -// * language-code -// -// * -// media-encoding -// -// * sample-rate -// -// For more information on streaming with Amazon -// Transcribe Medical, see Transcribing streaming audio -// (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). +// For more information on streaming with Amazon Transcribe Medical, see +// Transcribing streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html) +// . func (c *Client) StartMedicalStreamTranscription(ctx context.Context, params *StartMedicalStreamTranscriptionInput, optFns ...func(*Options)) (*StartMedicalStreamTranscriptionOutput, error) { if params == nil { params = &StartMedicalStreamTranscriptionInput{} @@ -47,24 +43,18 @@ func (c *Client) StartMedicalStreamTranscription(ctx context.Context, params *St type StartMedicalStreamTranscriptionInput struct { // Specify the language code that represents the language spoken in your audio. - // Amazon Transcribe Medical only supports US English (en-US). + // Amazon Transcribe Medical only supports US English ( en-US ). // // This member is required. LanguageCode types.LanguageCode // Specify the encoding used for the input audio. Supported formats are: - // - // * FLAC - // - // * - // OPUS-encoded audio in an Ogg container - // - // * PCM (only signed 16-bit little-endian - // audio formats, which does not include WAV) - // - // For more information, see Media - // formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). + // - FLAC + // - OPUS-encoded audio in an Ogg container + // - PCM (only signed 16-bit little-endian audio formats, which does not include + // WAV) + // For more information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // . // // This member is required. MediaEncoding types.MediaEncoding @@ -91,8 +81,8 @@ type StartMedicalStreamTranscriptionInput struct { // Labels all personal health information (PHI) identified in your transcript. // Content identification is performed at the segment level; PHI is flagged upon // complete transcription of an audio segment. For more information, see - // Identifying personal health information (PHI) in a transcription - // (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). + // Identifying personal health information (PHI) in a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html) + // . ContentIdentificationType types.MedicalContentIdentificationType // Enables channel identification in multi-channel audio. Channel identification @@ -100,8 +90,8 @@ type StartMedicalStreamTranscriptionInput struct { // each channel into one transcript. If you have multi-channel audio and do not // enable channel identification, your audio is transcribed in a continuous manner // and your transcript is not separated by channel. For more information, see - // Transcribing multi-channel audio - // (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). + // Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) + // . EnableChannelIdentification bool // Specify the number of channels in your audio stream. Up to two channels are @@ -113,10 +103,10 @@ type StartMedicalStreamTranscriptionInput struct { // it in the response. You can use a session ID to retry a streaming session. SessionId *string - // Enables speaker partitioning (diarization) in your transcription output. Speaker - // partitioning labels the speech from individual speakers in your media file. For - // more information, see Partitioning speakers (diarization) - // (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) + // . ShowSpeakerLabel bool // Specify the name of the custom vocabulary that you want to use when processing @@ -135,7 +125,7 @@ type StartMedicalStreamTranscriptionOutput struct { EnableChannelIdentification bool // Provides the language code that you specified in your request. This must be - // en-US. + // en-US . LanguageCode types.LanguageCode // Provides the media encoding you specified in your request. diff --git a/service/transcribestreaming/api_op_StartStreamTranscription.go b/service/transcribestreaming/api_op_StartStreamTranscription.go index 0f264670319..7fce967109f 100644 --- a/service/transcribestreaming/api_op_StartStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartStreamTranscription.go @@ -18,17 +18,13 @@ import ( // Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to // Amazon Transcribe and the transcription results are streamed to your // application. The following parameters are required: +// - language-code or identify-language +// - media-encoding +// - sample-rate // -// * language-code or -// identify-language -// -// * media-encoding -// -// * sample-rate -// -// For more information on -// streaming with Amazon Transcribe, see Transcribing streaming audio -// (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). +// For more information on streaming with Amazon Transcribe, see Transcribing +// streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html) +// . func (c *Client) StartStreamTranscription(ctx context.Context, params *StartStreamTranscriptionInput, optFns ...func(*Options)) (*StartStreamTranscriptionOutput, error) { if params == nil { params = &StartStreamTranscriptionInput{} @@ -47,18 +43,12 @@ func (c *Client) StartStreamTranscription(ctx context.Context, params *StartStre type StartStreamTranscriptionInput struct { // Specify the encoding of your input audio. Supported formats are: - // - // * FLAC - // - // * - // OPUS-encoded audio in an Ogg container - // - // * PCM (only signed 16-bit little-endian - // audio formats, which does not include WAV) - // - // For more information, see Media - // formats - // (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). + // - FLAC + // - OPUS-encoded audio in an Ogg container + // - PCM (only signed 16-bit little-endian audio formats, which does not include + // WAV) + // For more information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) + // . // // This member is required. MediaEncoding types.MediaEncoding @@ -74,20 +64,20 @@ type StartStreamTranscriptionInput struct { // Labels all personally identifiable information (PII) identified in your // transcript. Content identification is performed at the segment level; PII // specified in PiiEntityTypes is flagged upon complete transcription of an audio - // segment. You can’t set ContentIdentificationType and ContentRedactionType in the - // same request. If you set both, your request returns a BadRequestException. For - // more information, see Redacting or identifying personally identifiable - // information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). + // segment. You can’t set ContentIdentificationType and ContentRedactionType in + // the same request. If you set both, your request returns a BadRequestException . + // For more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // . ContentIdentificationType types.ContentIdentificationType // Redacts all personally identifiable information (PII) identified in your // transcript. Content redaction is performed at the segment level; PII specified // in PiiEntityTypes is redacted upon complete transcription of an audio segment. // You can’t set ContentRedactionType and ContentIdentificationType in the same - // request. If you set both, your request returns a BadRequestException. For more - // information, see Redacting or identifying personally identifiable information - // (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). + // request. If you set both, your request returns a BadRequestException . For more + // information, see Redacting or identifying personally identifiable information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html) + // . ContentRedactionType types.ContentRedactionType // Enables channel identification in multi-channel audio. Channel identification @@ -95,36 +85,35 @@ type StartStreamTranscriptionInput struct { // each channel into one transcript. If you have multi-channel audio and do not // enable channel identification, your audio is transcribed in a continuous manner // and your transcript is not separated by channel. For more information, see - // Transcribing multi-channel audio - // (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). + // Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) + // . EnableChannelIdentification bool // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. For - // more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). + // more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // . EnablePartialResultsStabilization bool - // Enables automatic language identification for your transcription. If you include - // IdentifyLanguage, you can optionally include a list of language codes, using - // LanguageOptions, that you think may be present in your audio stream. Including - // language options can improve transcription accuracy. You can also include a - // preferred language using PreferredLanguage. Adding a preferred language can help - // Amazon Transcribe identify the language faster than if you omit this parameter. - // If you have multi-channel audio that contains different languages on each - // channel, and you've enabled channel identification, automatic language - // identification identifies the dominant language on each audio channel. Note that - // you must include either LanguageCode or IdentifyLanguage in your request. If you - // include both parameters, your request fails. Streaming language identification - // can't be combined with custom language models or redaction. + // Enables automatic language identification for your transcription. If you + // include IdentifyLanguage , you can optionally include a list of language codes, + // using LanguageOptions , that you think may be present in your audio stream. + // Including language options can improve transcription accuracy. You can also + // include a preferred language using PreferredLanguage . Adding a preferred + // language can help Amazon Transcribe identify the language faster than if you + // omit this parameter. If you have multi-channel audio that contains different + // languages on each channel, and you've enabled channel identification, automatic + // language identification identifies the dominant language on each audio channel. + // Note that you must include either LanguageCode or IdentifyLanguage in your + // request. If you include both parameters, your request fails. Streaming language + // identification can't be combined with custom language models or redaction. IdentifyLanguage bool // Specify the language code that represents the language spoken in your audio. If // you're unsure of the language spoken in your audio, consider using // IdentifyLanguage to enable automatic language identification. For a list of // languages supported with Amazon Transcribe streaming, refer to the Supported - // languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. LanguageCode types.LanguageCode @@ -134,18 +123,17 @@ type StartStreamTranscriptionInput struct { // code you specify in your transcription request. If the languages don't match, // the custom language model isn't applied. There are no errors or warnings // associated with a language mismatch. For more information, see Custom language - // models - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). + // models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) + // . LanguageModelName *string - // Specify two or more language codes that represent the languages you think may be - // present in your media; including more than five is not recommended. If you're + // Specify two or more language codes that represent the languages you think may + // be present in your media; including more than five is not recommended. If you're // unsure what languages are present, do not include this parameter. Including // language options can improve the accuracy of language identification. If you - // include LanguageOptions in your request, you must also include IdentifyLanguage. - // For a list of languages supported with Amazon Transcribe streaming, refer to the - // Supported languages - // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // include LanguageOptions in your request, you must also include IdentifyLanguage + // . For a list of languages supported with Amazon Transcribe streaming, refer to + // the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) // table. You can only include one language dialect per language per stream. For // example, you cannot include en-US and en-AU in the same request. LanguageOptions *string @@ -155,23 +143,23 @@ type StartStreamTranscriptionInput struct { NumberOfChannels *int32 // Specify the level of stability to use when you enable partial results - // stabilization (EnablePartialResultsStabilization). Low stability provides the + // stabilization ( EnablePartialResultsStabilization ). Low stability provides the // highest accuracy. High stability transcribes faster, but with slightly lower - // accuracy. For more information, see Partial-result stabilization - // (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). + // accuracy. For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization) + // . PartialResultsStability types.PartialResultsStability // Specify which types of personally identifiable information (PII) you want to // redact in your transcript. You can include as many types as you'd like, or you - // can select ALL. To include PiiEntityTypes in your request, you must also include - // either ContentIdentificationType or ContentRedactionType. Values must be - // comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, - // CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, - // NAME, PHONE, SSN, or ALL. + // can select ALL . To include PiiEntityTypes in your request, you must also + // include either ContentIdentificationType or ContentRedactionType . Values must + // be comma-separated and can include: BANK_ACCOUNT_NUMBER , BANK_ROUTING , + // CREDIT_DEBIT_NUMBER , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , PIN , EMAIL , + // ADDRESS , NAME , PHONE , SSN , or ALL . PiiEntityTypes *string - // Specify a preferred language from the subset of languages codes you specified in - // LanguageOptions. You can only use this parameter if you've included + // Specify a preferred language from the subset of languages codes you specified + // in LanguageOptions . You can only use this parameter if you've included // IdentifyLanguage and LanguageOptions in your request. PreferredLanguage types.LanguageCode @@ -180,15 +168,15 @@ type StartStreamTranscriptionInput struct { // the response. You can use a session ID to retry a streaming session. SessionId *string - // Enables speaker partitioning (diarization) in your transcription output. Speaker - // partitioning labels the speech from individual speakers in your media file. For - // more information, see Partitioning speakers (diarization) - // (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) + // . ShowSpeakerLabel bool // Specify how you want your vocabulary filter applied to your transcript. To - // replace words with ***, choose mask. To delete words, choose remove. To flag - // words without changing them, choose tag. + // replace words with *** , choose mask . To delete words, choose remove . To flag + // words without changing them, choose tag . VocabularyFilterMethod types.VocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when @@ -196,11 +184,11 @@ type StartStreamTranscriptionInput struct { // sensitive. If the language of the specified custom vocabulary filter doesn't // match the language identified in your media, the vocabulary filter is not // applied to your transcription. This parameter is not intended for use with the - // IdentifyLanguage parameter. If you're including IdentifyLanguage in your request - // and want to use one or more vocabulary filters with your transcription, use the - // VocabularyFilterNames parameter instead. For more information, see Using - // vocabulary filtering with unwanted words - // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). + // IdentifyLanguage parameter. If you're including IdentifyLanguage in your + // request and want to use one or more vocabulary filters with your transcription, + // use the VocabularyFilterNames parameter instead. For more information, see + // Using vocabulary filtering with unwanted words (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) + // . VocabularyFilterName *string // Specify the names of the custom vocabulary filters that you want to use when @@ -210,8 +198,8 @@ type StartStreamTranscriptionInput struct { // only intended for use with the IdentifyLanguage parameter. If you're not // including IdentifyLanguage in your request and want to use a custom vocabulary // filter with your transcription, use the VocabularyFilterName parameter instead. - // For more information, see Using vocabulary filtering with unwanted words - // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). + // For more information, see Using vocabulary filtering with unwanted words (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html) + // . VocabularyFilterNames *string // Specify the name of the custom vocabulary that you want to use when processing @@ -221,8 +209,8 @@ type StartStreamTranscriptionInput struct { // transcription. This parameter is not intended for use with the IdentifyLanguage // parameter. If you're including IdentifyLanguage in your request and want to use // one or more custom vocabularies with your transcription, use the VocabularyNames - // parameter instead. For more information, see Custom vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). + // parameter instead. For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) + // . VocabularyName *string // Specify the names of the custom vocabularies that you want to use when @@ -232,8 +220,8 @@ type StartStreamTranscriptionInput struct { // use with the IdentifyLanguage parameter. If you're not including // IdentifyLanguage in your request and want to use a custom vocabulary with your // transcription, use the VocabularyName parameter instead. For more information, - // see Custom vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). + // see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html) + // . VocabularyNames *string noSmithyDocumentSerde diff --git a/service/transcribestreaming/doc.go b/service/transcribestreaming/doc.go index e91d3b30e72..51d89cf428d 100644 --- a/service/transcribestreaming/doc.go +++ b/service/transcribestreaming/doc.go @@ -5,17 +5,12 @@ // // Amazon Transcribe streaming offers three main types of real-time transcription: // Standard, Medical, and Call Analytics. -// -// * Standard transcriptions are the most -// common option. Refer to for details. -// -// * Medical transcriptions are tailored to -// medical professionals and incorporate medical terms. A common use case for this -// service is transcribing doctor-patient dialogue in real time, so doctors can -// focus on their patient instead of taking notes. Refer to for details. -// -// * Call -// Analytics transcriptions are designed for use with call center audio on two -// different channels; if you're looking for insight into customer service calls, -// use this option. Refer to for details. +// - Standard transcriptions are the most common option. Refer to for details. +// - Medical transcriptions are tailored to medical professionals and +// incorporate medical terms. A common use case for this service is transcribing +// doctor-patient dialogue in real time, so doctors can focus on their patient +// instead of taking notes. Refer to for details. +// - Call Analytics transcriptions are designed for use with call center audio +// on two different channels; if you're looking for insight into customer service +// calls, use this option. Refer to for details. package transcribestreaming diff --git a/service/transcribestreaming/types/enums.go b/service/transcribestreaming/types/enums.go index 7785706d3cc..7126e5b9436 100644 --- a/service/transcribestreaming/types/enums.go +++ b/service/transcribestreaming/types/enums.go @@ -122,9 +122,9 @@ const ( LanguageCodeThTh LanguageCode = "th-TH" ) -// Values returns all known values for LanguageCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for LanguageCode. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (LanguageCode) Values() []LanguageCode { return []LanguageCode{ "en-US", @@ -229,9 +229,9 @@ const ( SentimentNeutral Sentiment = "NEUTRAL" ) -// Values returns all known values for Sentiment. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Sentiment. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Sentiment) Values() []Sentiment { return []Sentiment{ "POSITIVE", @@ -253,9 +253,9 @@ const ( SpecialtyUrology Specialty = "UROLOGY" ) -// Values returns all known values for Specialty. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Specialty. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Specialty) Values() []Specialty { return []Specialty{ "PRIMARYCARE", diff --git a/service/transcribestreaming/types/errors.go b/service/transcribestreaming/types/errors.go index 1242cac65e0..6e4276cb965 100644 --- a/service/transcribestreaming/types/errors.go +++ b/service/transcribestreaming/types/errors.go @@ -7,8 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// One or more arguments to the StartStreamTranscription, -// StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription +// One or more arguments to the StartStreamTranscription , +// StartMedicalStreamTranscription , or StartCallAnalyticsStreamTranscription // operation was not valid. For example, MediaEncoding or LanguageCode used not // valid values. Check the specified parameters and try your request again. type BadRequestException struct { diff --git a/service/transcribestreaming/types/types.go b/service/transcribestreaming/types/types.go index c486cfb3238..d07821f2b7a 100644 --- a/service/transcribestreaming/types/types.go +++ b/service/transcribestreaming/types/types.go @@ -7,7 +7,7 @@ import ( ) // A list of possible alternative transcriptions for the input audio. Each -// alternative may contain one or more of Items, Entities, or Transcript. +// alternative may contain one or more of Items , Entities , or Transcript . type Alternative struct { // Contains entities identified as personally identifiable information (PII) in @@ -23,10 +23,10 @@ type Alternative struct { noSmithyDocumentSerde } -// A wrapper for your audio chunks. Your audio stream consists of one or more audio -// events, which consist of one or more audio chunks. For more information, see -// Event stream encoding -// (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). +// A wrapper for your audio chunks. Your audio stream consists of one or more +// audio events, which consist of one or more audio chunks. For more information, +// see Event stream encoding (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html) +// . type AudioEvent struct { // An audio blob that contains the next part of the audio that you want to @@ -37,8 +37,8 @@ type AudioEvent struct { } // An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or -// WebSocket data frames. For more information, see Transcribing streaming audio -// (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). +// WebSocket data frames. For more information, see Transcribing streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html) +// . // // The following types satisfy this interface: // @@ -48,9 +48,9 @@ type AudioStream interface { isAudioStream() } -// A blob of audio from your application. Your audio stream consists of one or more -// audio events. For more information, see Event stream encoding -// (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). +// A blob of audio from your application. Your audio stream consists of one or +// more audio events. For more information, see Event stream encoding (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html) +// . type AudioStreamMemberAudioEvent struct { Value AudioEvent @@ -77,7 +77,7 @@ type CallAnalyticsEntity struct { // of the identified entity. BeginOffsetMillis *int64 - // The category of information identified. For example, PII. + // The category of information identified. For example, PII . Category *string // The confidence score associated with the identification of an entity in your @@ -93,15 +93,15 @@ type CallAnalyticsEntity struct { // the identified entity. EndOffsetMillis *int64 - // The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER. + // The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER . Type *string noSmithyDocumentSerde } -// A word, phrase, or punctuation mark in your Call Analytics transcription output, -// along with various associated attributes, such as confidence score, type, and -// start and end times. +// A word, phrase, or punctuation mark in your Call Analytics transcription +// output, along with various associated attributes, such as confidence score, +// type, and start and end times. type CallAnalyticsItem struct { // The time, in milliseconds, from the beginning of the audio stream to the start @@ -122,24 +122,24 @@ type CallAnalyticsItem struct { EndOffsetMillis *int64 // If partial result stabilization is enabled, Stable indicates whether the - // specified item is stable (true) or if it may change when the segment is complete - // (false). + // specified item is stable ( true ) or if it may change when the segment is + // complete ( false ). Stable *bool // The type of item identified. Options are: PRONUNCIATION (spoken words) and - // PUNCTUATION. + // PUNCTUATION . Type ItemType // Indicates whether the specified item matches a word in the vocabulary filter - // included in your Call Analytics request. If true, there is a vocabulary filter + // included in your Call Analytics request. If true , there is a vocabulary filter // match. VocabularyFilterMatch bool noSmithyDocumentSerde } -// Contains detailed information about your Call Analytics streaming session. These -// details are provided in the UtteranceEvent and CategoryEvent objects. +// Contains detailed information about your Call Analytics streaming session. +// These details are provided in the UtteranceEvent and CategoryEvent objects. // // The following types satisfy this interface: // @@ -199,8 +199,8 @@ type ChannelDefinition struct { // This member is required. ChannelId int32 - // Specify the speaker you want to define. Omitting this parameter is equivalent to - // specifying both participants. + // Specify the speaker you want to define. Omitting this parameter is equivalent + // to specifying both participants. // // This member is required. ParticipantRole ParticipantRole @@ -213,9 +213,9 @@ type ChannelDefinition struct { // a segment. type CharacterOffsets struct { - // Provides the character count of the first character where a match is identified. - // For example, the first character associated with an issue or a category match in - // a segment transcript. + // Provides the character count of the first character where a match is + // identified. For example, the first character associated with an issue or a + // category match in a segment transcript. Begin *int32 // Provides the character count of the last character where a match is identified. @@ -232,9 +232,9 @@ type ConfigurationEvent struct { // Indicates which speaker is on which audio channel. ChannelDefinitions []ChannelDefinition - // Provides additional optional settings for your Call Analytics post-call request, - // including encryption and output locations for your redacted and unredacted - // transcript. + // Provides additional optional settings for your Call Analytics post-call + // request, including encryption and output locations for your redacted and + // unredacted transcript. PostCallAnalyticsSettings *PostCallAnalyticsSettings noSmithyDocumentSerde @@ -246,7 +246,7 @@ type ConfigurationEvent struct { // times. type Entity struct { - // The category of information identified. The only category is PII. + // The category of information identified. The only category is PII . Category *string // The confidence score associated with the identified PII entity in your audio. @@ -264,7 +264,7 @@ type Entity struct { // The start time, in milliseconds, of the utterance that was identified as PII. StartTime float64 - // The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER. + // The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER . Type *string noSmithyDocumentSerde @@ -302,19 +302,19 @@ type Item struct { Speaker *string // If partial result stabilization is enabled, Stable indicates whether the - // specified item is stable (true) or if it may change when the segment is complete - // (false). + // specified item is stable ( true ) or if it may change when the segment is + // complete ( false ). Stable *bool // The start time, in milliseconds, of the transcribed item. StartTime float64 // The type of item identified. Options are: PRONUNCIATION (spoken words) and - // PUNCTUATION. + // PUNCTUATION . Type ItemType // Indicates whether the specified item matches a word in the vocabulary filter - // included in your request. If true, there is a vocabulary filter match. + // included in your request. If true , there is a vocabulary filter match. VocabularyFilterMatch bool noSmithyDocumentSerde @@ -338,7 +338,7 @@ type LanguageWithScore struct { } // A list of possible alternative transcriptions for the input audio. Each -// alternative may contain one or more of Items, Entities, or Transcript. +// alternative may contain one or more of Items , Entities , or Transcript . type MedicalAlternative struct { // Contains entities identified as personal health information (PHI) in your @@ -359,7 +359,7 @@ type MedicalAlternative struct { // category, confidence score, type, stability score, and start and end times. type MedicalEntity struct { - // The category of information identified. The only category is PHI. + // The category of information identified. The only category is PHI . Category *string // The confidence score associated with the identified PHI entity in your audio. @@ -405,7 +405,7 @@ type MedicalItem struct { StartTime float64 // The type of item identified. Options are: PRONUNCIATION (spoken words) and - // PUNCTUATION. + // PUNCTUATION . Type ItemType noSmithyDocumentSerde @@ -419,29 +419,29 @@ type MedicalItem struct { type MedicalResult struct { // A list of possible alternative transcriptions for the input audio. Each - // alternative may contain one or more of Items, Entities, or Transcript. + // alternative may contain one or more of Items , Entities , or Transcript . Alternatives []MedicalAlternative - // Indicates the channel identified for the Result. + // Indicates the channel identified for the Result . ChannelId *string - // The end time, in milliseconds, of the Result. + // The end time, in milliseconds, of the Result . EndTime float64 - // Indicates if the segment is complete. If IsPartial is true, the segment is not - // complete. If IsPartial is false, the segment is complete. + // Indicates if the segment is complete. If IsPartial is true , the segment is not + // complete. If IsPartial is false , the segment is complete. IsPartial bool - // Provides a unique identifier for the Result. + // Provides a unique identifier for the Result . ResultId *string - // The start time, in milliseconds, of the Result. + // The start time, in milliseconds, of the Result . StartTime float64 noSmithyDocumentSerde } -// The MedicalTranscript associated with a . MedicalTranscript contains Results, +// The MedicalTranscript associated with a . MedicalTranscript contains Results , // which contains a set of transcription results from one or more audio segments, // along with additional information per your request parameters. type MedicalTranscript struct { @@ -456,16 +456,16 @@ type MedicalTranscript struct { noSmithyDocumentSerde } -// The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. +// The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream . // Contains a set of transcription results from one or more audio segments, along // with additional information per your request parameters. type MedicalTranscriptEvent struct { - // Contains Results, which contains a set of transcription results from one or more - // audio segments, along with additional information per your request parameters. - // This can include information relating to alternative transcriptions, channel - // identification, partial result stabilization, language identification, and other - // transcription-related data. + // Contains Results , which contains a set of transcription results from one or + // more audio segments, along with additional information per your request + // parameters. This can include information relating to alternative transcriptions, + // channel identification, partial result stabilization, language identification, + // and other transcription-related data. Transcript *MedicalTranscript noSmithyDocumentSerde @@ -480,7 +480,7 @@ type MedicalTranscriptResultStream interface { isMedicalTranscriptResultStream() } -// The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. +// The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream . // Contains a set of transcription results from one or more audio segments, along // with additional information per your request parameters. This can include // information relating to alternative transcriptions, channel identification, @@ -507,17 +507,17 @@ type PointsOfInterest struct { // Allows you to specify additional settings for your streaming Call Analytics // post-call request, including output locations for your redacted and unredacted // transcript, which IAM role to use, and, optionally, which encryption key to use. -// ContentRedactionOutput, DataAccessRoleArn, and OutputLocation are required +// ContentRedactionOutput , DataAccessRoleArn , and OutputLocation are required // fields. type PostCallAnalyticsSettings struct { - // The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - // Amazon S3 bucket that contains your input files. If the role that you specify - // doesn’t have the appropriate permissions to access the specified Amazon S3 - // location, your request fails. IAM role ARNs have the format - // arn:partition:iam::account:role/role-name-with-path. For example: - // arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role that you + // specify doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. IAM role ARNs have the format + // arn:partition:iam::account:role/role-name-with-path . For example: + // arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) + // . // // This member is required. DataAccessRoleArn *string @@ -525,14 +525,9 @@ type PostCallAnalyticsSettings struct { // The Amazon S3 location where you want your Call Analytics post-call // transcription output stored. You can use any of the following formats to specify // the output location: - // - // * s3://DOC-EXAMPLE-BUCKET - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-output-folder/ - // - // * - // s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json + // - s3://DOC-EXAMPLE-BUCKET + // - s3://DOC-EXAMPLE-BUCKET/my-output-folder/ + // - s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json // // This member is required. OutputLocation *string @@ -541,41 +536,28 @@ type PostCallAnalyticsSettings struct { // unredacted transcript. If you choose redacted and unredacted, two JSON files are // generated and stored in the Amazon S3 output location you specify. Note that to // include ContentRedactionOutput in your request, you must enable content - // redaction (ContentRedactionType). + // redaction ( ContentRedactionType ). ContentRedactionOutput ContentRedactionOutput // The KMS key you want to use to encrypt your Call Analytics post-call output. If // using a key located in the current Amazon Web Services account, you can specify // your KMS key in one of four ways: - // - // * Use the KMS key ID itself. For example, - // 1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use an alias for the KMS key ID. For - // example, alias/ExampleAlias. - // - // * Use the Amazon Resource Name (ARN) for the KMS - // key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // If using a key located in a - // different Amazon Web Services account than the current Amazon Web Services - // account, you can specify your KMS key in one of two ways: - // - // * Use the ARN for the - // KMS key ID. For example, - // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - // - // * Use - // the ARN for the KMS key alias. For example, - // arn:aws:kms:region:account-ID:alias/ExampleAlias. - // - // Note that the user making the - // request must have permission to use the specified KMS key. + // - Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab + // . + // - Use an alias for the KMS key ID. For example, alias/ExampleAlias . + // - Use the Amazon Resource Name (ARN) for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one of two + // ways: + // - Use the ARN for the KMS key ID. For example, + // arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab . + // - Use the ARN for the KMS key alias. For example, + // arn:aws:kms:region:account-ID:alias/ExampleAlias . + // Note that the user making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string noSmithyDocumentSerde @@ -589,17 +571,17 @@ type PostCallAnalyticsSettings struct { type Result struct { // A list of possible alternative transcriptions for the input audio. Each - // alternative may contain one or more of Items, Entities, or Transcript. + // alternative may contain one or more of Items , Entities , or Transcript . Alternatives []Alternative - // Indicates which audio channel is associated with the Result. + // Indicates which audio channel is associated with the Result . ChannelId *string - // The end time, in milliseconds, of the Result. + // The end time, in milliseconds, of the Result . EndTime float64 - // Indicates if the segment is complete. If IsPartial is true, the segment is not - // complete. If IsPartial is false, the segment is complete. + // Indicates if the segment is complete. If IsPartial is true , the segment is not + // complete. If IsPartial is false , the segment is complete. IsPartial bool // The language code that represents the language spoken in your audio stream. @@ -610,10 +592,10 @@ type Result struct { // different language, you may have more than one result. LanguageIdentification []LanguageWithScore - // Provides a unique identifier for the Result. + // Provides a unique identifier for the Result . ResultId *string - // The start time, in milliseconds, of the Result. + // The start time, in milliseconds, of the Result . StartTime float64 noSmithyDocumentSerde @@ -634,8 +616,8 @@ type TimestampRange struct { noSmithyDocumentSerde } -// The Transcript associated with a . Transcript contains Results, which contains a -// set of transcription results from one or more audio segments, along with +// The Transcript associated with a . Transcript contains Results , which contains +// a set of transcription results from one or more audio segments, along with // additional information per your request parameters. type Transcript struct { @@ -649,16 +631,16 @@ type Transcript struct { noSmithyDocumentSerde } -// The TranscriptEvent associated with a TranscriptResultStream. Contains a set of +// The TranscriptEvent associated with a TranscriptResultStream . Contains a set of // transcription results from one or more audio segments, along with additional // information per your request parameters. type TranscriptEvent struct { - // Contains Results, which contains a set of transcription results from one or more - // audio segments, along with additional information per your request parameters. - // This can include information relating to alternative transcriptions, channel - // identification, partial result stabilization, language identification, and other - // transcription-related data. + // Contains Results , which contains a set of transcription results from one or + // more audio segments, along with additional information per your request + // parameters. This can include information relating to alternative transcriptions, + // channel identification, partial result stabilization, language identification, + // and other transcription-related data. Transcript *Transcript noSmithyDocumentSerde @@ -673,7 +655,7 @@ type TranscriptResultStream interface { isTranscriptResultStream() } -// Contains Transcript, which contains Results. The object contains a set of +// Contains Transcript , which contains Results . The object contains a set of // transcription results from one or more audio segments, along with additional // information per your request parameters. type TranscriptResultStreamMemberTranscriptEvent struct { @@ -691,30 +673,30 @@ func (*TranscriptResultStreamMemberTranscriptEvent) isTranscriptResultStream() { type UtteranceEvent struct { // The time, in milliseconds, from the beginning of the audio stream to the start - // of the UtteranceEvent. + // of the UtteranceEvent . BeginOffsetMillis *int64 // The time, in milliseconds, from the beginning of the audio stream to the start - // of the UtteranceEvent. + // of the UtteranceEvent . EndOffsetMillis *int64 // Contains entities identified as personally identifiable information (PII) in // your transcription output. Entities []CallAnalyticsEntity - // Indicates whether the segment in the UtteranceEvent is complete (FALSE) or - // partial (TRUE). + // Indicates whether the segment in the UtteranceEvent is complete ( FALSE ) or + // partial ( TRUE ). IsPartial bool // Provides the issue that was detected in the specified segment. IssuesDetected []IssueDetected // Contains words, phrases, or punctuation marks that are associated with the - // specified UtteranceEvent. + // specified UtteranceEvent . Items []CallAnalyticsItem // Provides the role of the speaker for each audio channel, either CUSTOMER or - // AGENT. + // AGENT . ParticipantRole ParticipantRole // Provides the sentiment that was detected in the specified segment. @@ -723,7 +705,7 @@ type UtteranceEvent struct { // Contains transcribed text. Transcript *string - // The unique identifier that is associated with the specified UtteranceEvent. + // The unique identifier that is associated with the specified UtteranceEvent . UtteranceId *string noSmithyDocumentSerde diff --git a/service/transfer/api_client.go b/service/transfer/api_client.go index 0592b9fb0ee..0a67ef9146b 100644 --- a/service/transfer/api_client.go +++ b/service/transfer/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/transfer/api_op_CreateAccess.go b/service/transfer/api_op_CreateAccess.go index b5f4eeceb1a..480c471bf06 100644 --- a/service/transfer/api_op_CreateAccess.go +++ b/service/transfer/api_op_CreateAccess.go @@ -15,8 +15,8 @@ import ( // access to upload and download files over the enabled protocols using Transfer // Family. For example, a Microsoft Active Directory might contain 50,000 users, // but only a small fraction might need the ability to transfer files to the -// server. An administrator can use CreateAccess to limit the access to the correct -// set of users who need this ability. +// server. An administrator can use CreateAccess to limit the access to the +// correct set of users who need this ability. func (c *Client) CreateAccess(ctx context.Context, params *CreateAccessInput, optFns ...func(*Options)) (*CreateAccessOutput, error) { if params == nil { params = &CreateAccessInput{} @@ -66,7 +66,7 @@ type CreateAccessInput struct { ServerId *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -74,20 +74,21 @@ type CreateAccessInput struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value + // and Access Management (IAM) role provides access to paths in Target . This value // can be set only when HomeDirectoryType is set to LOGICAL. The following is an // Entry and Target pair example. [ { "Entry": "/directory1", "Target": // "/bucket_name/home/mydirectory" } ] In most cases, you can use this value // instead of the session policy to lock down your user to the designated home - // directory ("chroot"). To do this, you can set Entry to / and set Target to the - // HomeDirectory parameter value. The following is an Entry and Target pair example - // for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] + // directory (" chroot "). To do this, you can set Entry to / and set Target to + // the HomeDirectory parameter value. The following is an Entry and Target pair + // example for chroot . [ { "Entry": "/", "Target": + // "/bucket_name/home/mydirectory" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType types.HomeDirectoryType @@ -95,20 +96,18 @@ type CreateAccessInput struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is - // Amazon S3. Amazon EFS does not use session policies. For session policies, + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . This policy applies only when the domain of ServerId + // is Amazon S3. Amazon EFS does not use session policies. For session policies, // Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource // Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the - // Policy argument. For an example of a session policy, see Example session policy - // (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html). For - // more information, see AssumeRole - // (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the - // Security Token Service API Reference. + // Policy argument. For an example of a session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html) + // . For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) + // in the Security Token Service API Reference. Policy *string - // The full POSIX identity, including user ID (Uid), group ID (Gid), and any - // secondary groups IDs (SecondaryGids), that controls your users' access to your + // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any + // secondary groups IDs ( SecondaryGids ), that controls your users' access to your // Amazon EFS file systems. The POSIX permissions that are set on files and // directories in your file system determine the level of access your users get // when transferring files into and out of your Amazon EFS file systems. diff --git a/service/transfer/api_op_CreateAgreement.go b/service/transfer/api_op_CreateAgreement.go index 63016f51d5c..9449b7adc36 100644 --- a/service/transfer/api_op_CreateAgreement.go +++ b/service/transfer/api_op_CreateAgreement.go @@ -16,8 +16,8 @@ import ( // defines the file and message transfer relationship between the server and the // AS2 process. To define an agreement, Transfer Family combines a server, local // profile, partner profile, certificate, and other attributes. The partner is -// identified with the PartnerProfileId, and the AS2 process is identified with the -// LocalProfileId. +// identified with the PartnerProfileId , and the AS2 process is identified with +// the LocalProfileId . func (c *Client) CreateAgreement(ctx context.Context, params *CreateAgreementInput, optFns ...func(*Options)) (*CreateAgreementOutput, error) { if params == nil { params = &CreateAgreementInput{} @@ -36,21 +36,21 @@ func (c *Client) CreateAgreement(ctx context.Context, params *CreateAgreementInp type CreateAgreementInput struct { // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . // // This member is required. AccessRole *string // The landing directory (folder) for files transferred by using the AS2 protocol. - // A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory. + // A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory . // // This member is required. BaseDirectory *string @@ -74,7 +74,7 @@ type CreateAgreementInput struct { // A name or short description to identify the agreement. Description *string - // The status of the agreement. The agreement can be either ACTIVE or INACTIVE. + // The status of the agreement. The agreement can be either ACTIVE or INACTIVE . Status types.AgreementStatusType // Key-value pairs that can be used to group and search for agreements. diff --git a/service/transfer/api_op_CreateConnector.go b/service/transfer/api_op_CreateConnector.go index 3694611a43e..3e7e6b1b596 100644 --- a/service/transfer/api_op_CreateConnector.go +++ b/service/transfer/api_op_CreateConnector.go @@ -14,8 +14,8 @@ import ( // Creates the connector, which captures the parameters for an outbound connection // for the AS2 protocol. The connector is required for sending files to an // externally hosted AS2 server. For more details about connectors, see Create AS2 -// connectors -// (https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector). +// connectors (https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector) +// . func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInput, optFns ...func(*Options)) (*CreateConnectorOutput, error) { if params == nil { params = &CreateConnectorInput{} @@ -34,15 +34,15 @@ func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInp type CreateConnectorInput struct { // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . // // This member is required. AccessRole *string diff --git a/service/transfer/api_op_CreateProfile.go b/service/transfer/api_op_CreateProfile.go index 4c111b43e43..b977a4e2456 100644 --- a/service/transfer/api_op_CreateProfile.go +++ b/service/transfer/api_op_CreateProfile.go @@ -29,23 +29,20 @@ func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, type CreateProfileInput struct { - // The As2Id is the AS2-name, as defined in the RFC 4130 - // (https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is - // the AS2-From header for the AS2 messages sent from the partner. For outbound - // connectors, this is the AS2-To header for the AS2 messages sent to the partner - // using the StartFileTransfer API operation. This ID cannot include spaces. + // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130) + // . For inbound transfers, this is the AS2-From header for the AS2 messages sent + // from the partner. For outbound connectors, this is the AS2-To header for the + // AS2 messages sent to the partner using the StartFileTransfer API operation. + // This ID cannot include spaces. // // This member is required. As2Id *string // Determines the type of profile to create: - // - // * Specify LOCAL to create a local - // profile. A local profile represents the AS2-enabled Transfer Family server - // organization or party. - // - // * Specify PARTNER to create a partner profile. A partner - // profile represents a remote organization, external to Transfer Family. + // - Specify LOCAL to create a local profile. A local profile represents the + // AS2-enabled Transfer Family server organization or party. + // - Specify PARTNER to create a partner profile. A partner profile represents a + // remote organization, external to Transfer Family. // // This member is required. ProfileType types.ProfileType diff --git a/service/transfer/api_op_CreateServer.go b/service/transfer/api_op_CreateServer.go index 0fd9cd0eeba..7a678897ed0 100644 --- a/service/transfer/api_op_CreateServer.go +++ b/service/transfer/api_op_CreateServer.go @@ -33,34 +33,21 @@ func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, op type CreateServerInput struct { // The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. - // Required when Protocols is set to FTPS. To request a new public certificate, see - // Request a public certificate - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) in - // the Certificate Manager User Guide. To import an existing certificate into ACM, - // see Importing certificates into ACM - // (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in - // the Certificate Manager User Guide. To request a private certificate to use FTPS - // through private IP addresses, see Request a private certificate - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) + // Required when Protocols is set to FTPS . To request a new public certificate, + // see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) + // in the Certificate Manager User Guide. To import an existing certificate into + // ACM, see Importing certificates into ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) + // in the Certificate Manager User Guide. To request a private certificate to use + // FTPS through private IP addresses, see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) // in the Certificate Manager User Guide. Certificates with the following // cryptographic algorithms and key sizes are supported: - // - // * 2048-bit RSA - // (RSA_2048) - // - // * 4096-bit RSA (RSA_4096) - // - // * Elliptic Prime Curve 256 bit - // (EC_prime256v1) - // - // * Elliptic Prime Curve 384 bit (EC_secp384r1) - // - // * Elliptic Prime - // Curve 521 bit (EC_secp521r1) - // - // The certificate must be a valid SSL/TLS X.509 - // version 3 certificate with FQDN or IP address specified and information about - // the issuer. + // - 2048-bit RSA (RSA_2048) + // - 4096-bit RSA (RSA_4096) + // - Elliptic Prime Curve 256 bit (EC_prime256v1) + // - Elliptic Prime Curve 384 bit (EC_secp384r1) + // - Elliptic Prime Curve 521 bit (EC_secp521r1) + // The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN + // or IP address specified and information about the issuer. Certificate *string // The domain of the storage system that is used for file transfers. There are two @@ -85,42 +72,41 @@ type CreateServerInput struct { // Services account if your account hasn't already done so before May 19, 2021. If // you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon // Web Services account on or before May 19, 2021, you will not be affected. After - // this date, use EndpointType=VPC. For more information, see + // this date, use EndpointType = VPC . For more information, see // https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. - // It is recommended that you use VPC as the EndpointType. With this endpoint type, - // you have the option to directly associate up to three Elastic IPv4 addresses - // (BYO IP included) with your server's endpoint and use VPC security groups to - // restrict traffic by the client's public IP address. This is not possible with - // EndpointType set to VPC_ENDPOINT. + // It is recommended that you use VPC as the EndpointType . With this endpoint + // type, you have the option to directly associate up to three Elastic IPv4 + // addresses (BYO IP included) with your server's endpoint and use VPC security + // groups to restrict traffic by the client's public IP address. This is not + // possible with EndpointType set to VPC_ENDPOINT . EndpointType types.EndpointType // The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You // can add multiple host keys, in case you want to rotate keys, or have a set of // active keys that use different algorithms. Use the following command to generate // an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM - // -f my-new-server-key. Use a minimum value of 2048 for the -b option. You can + // -f my-new-server-key . Use a minimum value of 2048 for the -b option. You can // create a stronger key by using 3072 or 4096. Use the following command to // generate an ECDSA 256 bit key with no passphrase: ssh-keygen -t ecdsa -b 256 -N - // "" -m PEM -f my-new-server-key. Valid values for the -b option for ECDSA are + // "" -m PEM -f my-new-server-key . Valid values for the -b option for ECDSA are // 256, 384, and 521. Use the following command to generate an ED25519 key with no - // passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key. For all of these + // passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key . For all of these // commands, you can replace my-new-server-key with a string of your choice. If you // aren't planning to migrate existing users from an existing SFTP-enabled server // to a new server, don't update the host key. Accidentally changing a server's // host key can be disruptive. For more information, see Manage host keys for your - // SFTP-enabled server - // (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key) + // SFTP-enabled server (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key) // in the Transfer Family User Guide. HostKey *string // Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or - // API_GATEWAY. Accepts an array containing all of the information required to use + // API_GATEWAY . Accepts an array containing all of the information required to use // a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied // authentication API, including the API Gateway URL. Not required when - // IdentityProviderType is set to SERVICE_MANAGED. + // IdentityProviderType is set to SERVICE_MANAGED . IdentityProviderDetails *types.IdentityProviderDetails - // The mode of authentication for a server. The default value is SERVICE_MANAGED, + // The mode of authentication for a server. The default value is SERVICE_MANAGED , // which allows you to store and access user credentials within the Transfer Family // service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups // in Directory Service for Microsoft Active Directory or Microsoft Active @@ -154,63 +140,45 @@ type CreateServerInput struct { PreAuthenticationLoginBanner *string // The protocol settings that are configured for your server. - // - // * To indicate - // passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a - // single dotted-quad IPv4 address, such as the external IP address of a firewall, - // router, or load balancer. - // - // * To ignore the error that is generated when the - // client attempts to use the SETSTAT command on a file that you are uploading to - // an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer - // Family server ignore the SETSTAT command and upload files without needing to - // make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set - // the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log - // entry to Amazon CloudWatch Logs, so that you can determine when the client is - // making a SETSTAT call. - // - // * To determine whether your Transfer Family server - // resumes recent, negotiated sessions through a unique session ID, use the - // TlsSessionResumptionMode parameter. - // - // * As2Transports indicates the transport - // method for the AS2 messages. Currently, only HTTP is supported. + // - To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp + // parameter. Enter a single dotted-quad IPv4 address, such as the external IP + // address of a firewall, router, or load balancer. + // - To ignore the error that is generated when the client attempts to use the + // SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use + // the SetStatOption parameter. To have the Transfer Family server ignore the + // SETSTAT command and upload files without needing to make any changes to your + // SFTP client, set the value to ENABLE_NO_OP . If you set the SetStatOption + // parameter to ENABLE_NO_OP , Transfer Family generates a log entry to Amazon + // CloudWatch Logs, so that you can determine when the client is making a SETSTAT + // call. + // - To determine whether your Transfer Family server resumes recent, negotiated + // sessions through a unique session ID, use the TlsSessionResumptionMode + // parameter. + // - As2Transports indicates the transport method for the AS2 messages. + // Currently, only HTTP is supported. ProtocolDetails *types.ProtocolDetails // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are: + // - SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH + // - FTPS (File Transfer Protocol Secure): File transfer with TLS encryption + // - FTP (File Transfer Protocol): Unencrypted file transfer + // - AS2 (Applicability Statement 2): used for transporting structured + // business-to-business data // - // * SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over - // SSH - // - // * FTPS (File Transfer Protocol Secure): File transfer with TLS - // encryption - // - // * FTP (File Transfer Protocol): Unencrypted file transfer - // - // * AS2 - // (Applicability Statement 2): used for transporting structured - // business-to-business data - // - // * If you select FTPS, you must choose a certificate - // stored in Certificate Manager (ACM) which is used to identify your server when - // clients connect to it over FTPS. - // - // * If Protocol includes either FTP or FTPS, - // then the EndpointType must be VPC and the IdentityProviderType must be either - // AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes FTP, - // then AddressAllocationIds cannot be associated. - // - // * If Protocol is set only to - // SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be - // set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, - // AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes AS2, then the EndpointType - // must be VPC, and domain must be Amazon S3. + // - If you select FTPS , you must choose a certificate stored in Certificate + // Manager (ACM) which is used to identify your server when clients connect to it + // over FTPS. + // - If Protocol includes either FTP or FTPS , then the EndpointType must be VPC + // and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE , AWS_LAMBDA + // , or API_GATEWAY . + // - If Protocol includes FTP , then AddressAllocationIds cannot be associated. + // - If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and + // the IdentityProviderType can be set any of the supported identity types: + // SERVICE_MANAGED , AWS_DIRECTORY_SERVICE , AWS_LAMBDA , or API_GATEWAY . + // - If Protocol includes AS2 , then the EndpointType must be VPC , and domain + // must be Amazon S3. Protocols []types.Protocol // Specifies the name of the security policy that is attached to the server. diff --git a/service/transfer/api_op_CreateUser.go b/service/transfer/api_op_CreateUser.go index 703c4f54d9b..7000eaa1262 100644 --- a/service/transfer/api_op_CreateUser.go +++ b/service/transfer/api_op_CreateUser.go @@ -13,8 +13,8 @@ import ( // Creates a user and associates them with an existing file transfer // protocol-enabled server. You can only create and associate users with servers -// that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for -// CreateUser, you can specify the user name, set the home directory, store the +// that have the IdentityProviderType set to SERVICE_MANAGED . Using parameters for +// CreateUser , you can specify the user name, set the home directory, store the // user's public key, and assign the user's Identity and Access Management (IAM) // role. You can also optionally add a session policy, and assign metadata with // tags that can be used to group and search for users. @@ -52,7 +52,7 @@ type CreateUserInput struct { // This member is required. ServerId *string - // A unique string that identifies a user and is associated with a ServerId. This + // A unique string that identifies a user and is associated with a ServerId . This // user name must be a minimum of 3 and a maximum of 100 characters long. The // following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', // period '.', and at sign '@'. The user name can't start with a hyphen, period, or @@ -62,7 +62,7 @@ type CreateUserInput struct { UserName *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -70,20 +70,21 @@ type CreateUserInput struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value + // and Access Management (IAM) role provides access to paths in Target . This value // can be set only when HomeDirectoryType is set to LOGICAL. The following is an // Entry and Target pair example. [ { "Entry": "/directory1", "Target": // "/bucket_name/home/mydirectory" } ] In most cases, you can use this value // instead of the session policy to lock your user down to the designated home - // directory ("chroot"). To do this, you can set Entry to / and set Target to the - // HomeDirectory parameter value. The following is an Entry and Target pair example - // for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] + // directory (" chroot "). To do this, you can set Entry to / and set Target to + // the HomeDirectory parameter value. The following is an Entry and Target pair + // example for chroot . [ { "Entry": "/", "Target": + // "/bucket_name/home/mydirectory" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType types.HomeDirectoryType @@ -91,38 +92,32 @@ type CreateUserInput struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is - // Amazon S3. Amazon EFS does not use session policies. For session policies, + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . This policy applies only when the domain of ServerId + // is Amazon S3. Amazon EFS does not use session policies. For session policies, // Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource // Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the - // Policy argument. For an example of a session policy, see Example session policy - // (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html). For - // more information, see AssumeRole - // (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the - // Amazon Web Services Security Token Service API Reference. + // Policy argument. For an example of a session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html) + // . For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) + // in the Amazon Web Services Security Token Service API Reference. Policy *string - // Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and - // any secondary groups IDs (SecondaryGids), that controls your users' access to - // your Amazon EFS file systems. The POSIX permissions that are set on files and + // Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), + // and any secondary groups IDs ( SecondaryGids ), that controls your users' access + // to your Amazon EFS file systems. The POSIX permissions that are set on files and // directories in Amazon EFS determine the level of access your users get when // transferring files into and out of your Amazon EFS file systems. PosixProfile *types.PosixProfile // The public portion of the Secure Shell (SSH) key used to authenticate the user // to the server. The three standard SSH public key format elements are , , and an - // optional , with spaces between each element. Transfer Family accepts RSA, ECDSA, - // and ED25519 keys. - // - // * For RSA keys, the key type is ssh-rsa. - // - // * For ED25519 keys, - // the key type is ssh-ed25519. - // - // * For ECDSA keys, the key type is either - // ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on - // the size of the key you generated. + // optional , with spaces between each element. Transfer Family accepts RSA, + // ECDSA, and ED25519 keys. + // - For RSA keys, the key type is ssh-rsa . + // - For ED25519 keys, the key type is ssh-ed25519 . + // - For ECDSA keys, the key type is either ecdsa-sha2-nistp256 , + // ecdsa-sha2-nistp384 , or ecdsa-sha2-nistp521 , depending on the size of the + // key you generated. SshPublicKeyBody *string // Key-value pairs that can be used to group and search for users. Tags are diff --git a/service/transfer/api_op_CreateWorkflow.go b/service/transfer/api_op_CreateWorkflow.go index 893a6ca77d2..010af3b9f45 100644 --- a/service/transfer/api_op_CreateWorkflow.go +++ b/service/transfer/api_op_CreateWorkflow.go @@ -34,24 +34,14 @@ type CreateWorkflowInput struct { // Specifies the details for the steps that are in the specified workflow. The TYPE // specifies which of the following actions is being taken for this step. - // - // * COPY - - // Copy the file to another location. - // - // * CUSTOM - Perform a custom step with an - // Lambda function target. - // - // * DECRYPT - Decrypt a file that was encrypted before it - // was uploaded. - // - // * DELETE - Delete the file. - // - // * TAG - Add a tag to the - // file. - // - // Currently, copying and tagging are supported only on S3. For file - // location, you specify either the Amazon S3 bucket and key, or the Amazon EFS - // file system ID and path. + // - COPY - Copy the file to another location. + // - CUSTOM - Perform a custom step with an Lambda function target. + // - DECRYPT - Decrypt a file that was encrypted before it was uploaded. + // - DELETE - Delete the file. + // - TAG - Add a tag to the file. + // Currently, copying and tagging are supported only on S3. For file location, you + // specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID + // and path. // // This member is required. Steps []types.WorkflowStep @@ -59,10 +49,11 @@ type CreateWorkflowInput struct { // A textual description for the workflow. Description *string - // Specifies the steps (actions) to take if errors are encountered during execution - // of the workflow. For custom steps, the lambda function needs to send FAILURE to - // the call back API to kick off the exception steps. Additionally, if the lambda - // does not send SUCCESS before it times out, the exception steps are executed. + // Specifies the steps (actions) to take if errors are encountered during + // execution of the workflow. For custom steps, the lambda function needs to send + // FAILURE to the call back API to kick off the exception steps. Additionally, if + // the lambda does not send SUCCESS before it times out, the exception steps are + // executed. OnExceptionSteps []types.WorkflowStep // Key-value pairs that can be used to group and search for workflows. Tags are diff --git a/service/transfer/api_op_DeleteAgreement.go b/service/transfer/api_op_DeleteAgreement.go index f18f24ac144..ed5d4dd451a 100644 --- a/service/transfer/api_op_DeleteAgreement.go +++ b/service/transfer/api_op_DeleteAgreement.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete the agreement that's specified in the provided AgreementId. +// Delete the agreement that's specified in the provided AgreementId . func (c *Client) DeleteAgreement(ctx context.Context, params *DeleteAgreementInput, optFns ...func(*Options)) (*DeleteAgreementOutput, error) { if params == nil { params = &DeleteAgreementInput{} diff --git a/service/transfer/api_op_DeleteConnector.go b/service/transfer/api_op_DeleteConnector.go index f5e21461944..73a1c025f05 100644 --- a/service/transfer/api_op_DeleteConnector.go +++ b/service/transfer/api_op_DeleteConnector.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the agreement that's specified in the provided ConnectorId. +// Deletes the agreement that's specified in the provided ConnectorId . func (c *Client) DeleteConnector(ctx context.Context, params *DeleteConnectorInput, optFns ...func(*Options)) (*DeleteConnectorOutput, error) { if params == nil { params = &DeleteConnectorInput{} diff --git a/service/transfer/api_op_DescribeAccess.go b/service/transfer/api_op_DescribeAccess.go index 70ff0c1d80e..36a567f33c2 100644 --- a/service/transfer/api_op_DescribeAccess.go +++ b/service/transfer/api_op_DescribeAccess.go @@ -13,7 +13,7 @@ import ( // Describes the access that is assigned to the specific file transfer // protocol-enabled server, as identified by its ServerId property and its -// ExternalId. The response from this call returns the properties of the access +// ExternalId . The response from this call returns the properties of the access // that is associated with the ServerId value that was specified. func (c *Client) DescribeAccess(ctx context.Context, params *DescribeAccessInput, optFns ...func(*Options)) (*DescribeAccessOutput, error) { if params == nil { diff --git a/service/transfer/api_op_DescribeAgreement.go b/service/transfer/api_op_DescribeAgreement.go index 03f30c35083..45dad9b23a7 100644 --- a/service/transfer/api_op_DescribeAgreement.go +++ b/service/transfer/api_op_DescribeAgreement.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the agreement that's identified by the AgreementId. +// Describes the agreement that's identified by the AgreementId . func (c *Client) DescribeAgreement(ctx context.Context, params *DescribeAgreementInput, optFns ...func(*Options)) (*DescribeAgreementOutput, error) { if params == nil { params = &DescribeAgreementInput{} diff --git a/service/transfer/api_op_DescribeCertificate.go b/service/transfer/api_op_DescribeCertificate.go index c7a070fa0c0..48d06284f1e 100644 --- a/service/transfer/api_op_DescribeCertificate.go +++ b/service/transfer/api_op_DescribeCertificate.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the certificate that's identified by the CertificateId. +// Describes the certificate that's identified by the CertificateId . func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error) { if params == nil { params = &DescribeCertificateInput{} diff --git a/service/transfer/api_op_DescribeHostKey.go b/service/transfer/api_op_DescribeHostKey.go index b0cbdd3b8cb..8e1b5bddde3 100644 --- a/service/transfer/api_op_DescribeHostKey.go +++ b/service/transfer/api_op_DescribeHostKey.go @@ -12,7 +12,7 @@ import ( ) // Returns the details of the host key that's specified by the HostKeyId and -// ServerId. +// ServerId . func (c *Client) DescribeHostKey(ctx context.Context, params *DescribeHostKeyInput, optFns ...func(*Options)) (*DescribeHostKeyOutput, error) { if params == nil { params = &DescribeHostKeyInput{} diff --git a/service/transfer/api_op_DescribeProfile.go b/service/transfer/api_op_DescribeProfile.go index 124bd213e03..c393cd75db7 100644 --- a/service/transfer/api_op_DescribeProfile.go +++ b/service/transfer/api_op_DescribeProfile.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the details of the profile that's specified by the ProfileId. +// Returns the details of the profile that's specified by the ProfileId . func (c *Client) DescribeProfile(ctx context.Context, params *DescribeProfileInput, optFns ...func(*Options)) (*DescribeProfileOutput, error) { if params == nil { params = &DescribeProfileInput{} diff --git a/service/transfer/api_op_DescribeSecurityPolicy.go b/service/transfer/api_op_DescribeSecurityPolicy.go index 0e9d40e0992..53006128cae 100644 --- a/service/transfer/api_op_DescribeSecurityPolicy.go +++ b/service/transfer/api_op_DescribeSecurityPolicy.go @@ -14,8 +14,8 @@ import ( // Describes the security policy that is attached to your file transfer // protocol-enabled server. The response contains a description of the security // policy's properties. For more information about security policies, see Working -// with security policies -// (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html). +// with security policies (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) +// . func (c *Client) DescribeSecurityPolicy(ctx context.Context, params *DescribeSecurityPolicyInput, optFns ...func(*Options)) (*DescribeSecurityPolicyOutput, error) { if params == nil { params = &DescribeSecurityPolicyInput{} diff --git a/service/transfer/api_op_DescribeServer.go b/service/transfer/api_op_DescribeServer.go index a45eb321e29..ac85fc50558 100644 --- a/service/transfer/api_op_DescribeServer.go +++ b/service/transfer/api_op_DescribeServer.go @@ -19,7 +19,7 @@ import ( // Describes a file transfer protocol-enabled server that you specify by passing // the ServerId parameter. The response contains a description of a server's // properties. When you set EndpointType to VPC, the response will contain the -// EndpointDetails. +// EndpointDetails . func (c *Client) DescribeServer(ctx context.Context, params *DescribeServerInput, optFns ...func(*Options)) (*DescribeServerOutput, error) { if params == nil { params = &DescribeServerInput{} @@ -142,8 +142,8 @@ type ServerOfflineWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServerOfflineWaiter will use default max delay of 120 seconds. Note + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServerOfflineWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration @@ -192,9 +192,10 @@ func (w *ServerOfflineWaiter) Wait(ctx context.Context, params *DescribeServerIn return err } -// WaitForOutput calls the waiter function for ServerOffline waiter and returns the -// output of the successful operation. The maxWaitDur is the maximum wait duration -// the waiter will wait. The maxWaitDur is required and must be greater than zero. +// WaitForOutput calls the waiter function for ServerOffline waiter and returns +// the output of the successful operation. The maxWaitDur is the maximum wait +// duration the waiter will wait. The maxWaitDur is required and must be greater +// than zero. func (w *ServerOfflineWaiter) WaitForOutput(ctx context.Context, params *DescribeServerInput, maxWaitDur time.Duration, optFns ...func(*ServerOfflineWaiterOptions)) (*DescribeServerOutput, error) { if maxWaitDur <= 0 { return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero") @@ -318,9 +319,9 @@ type ServerOnlineWaiterOptions struct { // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration - // MaxDelay is the maximum amount of time to delay between retries. If unset or set - // to zero, ServerOnlineWaiter will use default max delay of 120 seconds. Note that - // MaxDelay must resolve to value greater than or equal to the MinDelay. + // MaxDelay is the maximum amount of time to delay between retries. If unset or + // set to zero, ServerOnlineWaiter will use default max delay of 120 seconds. Note + // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts diff --git a/service/transfer/api_op_DescribeUser.go b/service/transfer/api_op_DescribeUser.go index ba17147590d..eaf87fbb6c9 100644 --- a/service/transfer/api_op_DescribeUser.go +++ b/service/transfer/api_op_DescribeUser.go @@ -37,9 +37,9 @@ type DescribeUserInput struct { // This member is required. ServerId *string - // The name of the user assigned to one or more servers. User names are part of the - // sign-in credentials to use the Transfer Family service and perform file transfer - // tasks. + // The name of the user assigned to one or more servers. User names are part of + // the sign-in credentials to use the Transfer Family service and perform file + // transfer tasks. // // This member is required. UserName *string diff --git a/service/transfer/api_op_ImportCertificate.go b/service/transfer/api_op_ImportCertificate.go index c348a26740c..6d0ad05816b 100644 --- a/service/transfer/api_op_ImportCertificate.go +++ b/service/transfer/api_op_ImportCertificate.go @@ -31,12 +31,11 @@ func (c *Client) ImportCertificate(ctx context.Context, params *ImportCertificat type ImportCertificateInput struct { - // * For the CLI, provide a file path for a certificate in URI format. For example, - // --certificate file://encryption-cert.pem. Alternatively, you can provide the raw - // content. - // - // * For the SDK, specify the raw content of a certificate file. For - // example, --certificate "`cat encryption-cert.pem`". + // - For the CLI, provide a file path for a certificate in URI format. For + // example, --certificate file://encryption-cert.pem . Alternatively, you can + // provide the raw content. + // - For the SDK, specify the raw content of a certificate file. For example, + // --certificate "`cat encryption-cert.pem`" . // // This member is required. Certificate *string @@ -59,12 +58,11 @@ type ImportCertificateInput struct { // An optional date that specifies when the certificate becomes inactive. InactiveDate *time.Time - // * For the CLI, provide a file path for a private key in URI format.For example, - // --private-key file://encryption-key.pem. Alternatively, you can provide the raw - // content of the private key file. - // - // * For the SDK, specify the raw content of a - // private key file. For example, --private-key "`cat encryption-key.pem`" + // - For the CLI, provide a file path for a private key in URI format.For + // example, --private-key file://encryption-key.pem . Alternatively, you can + // provide the raw content of the private key file. + // - For the SDK, specify the raw content of a private key file. For example, + // --private-key "`cat encryption-key.pem`" PrivateKey *string // Key-value pairs that can be used to group and search for certificates. diff --git a/service/transfer/api_op_ImportSshPublicKey.go b/service/transfer/api_op_ImportSshPublicKey.go index 42957788296..fb483736344 100644 --- a/service/transfer/api_op_ImportSshPublicKey.go +++ b/service/transfer/api_op_ImportSshPublicKey.go @@ -12,8 +12,8 @@ import ( // Adds a Secure Shell (SSH) public key to a user account identified by a UserName // value assigned to the specific file transfer protocol-enabled server, identified -// by ServerId. The response returns the UserName value, the ServerId value, and -// the name of the SshPublicKeyId. +// by ServerId . The response returns the UserName value, the ServerId value, and +// the name of the SshPublicKeyId . func (c *Client) ImportSshPublicKey(ctx context.Context, params *ImportSshPublicKeyInput, optFns ...func(*Options)) (*ImportSshPublicKeyOutput, error) { if params == nil { params = &ImportSshPublicKeyInput{} diff --git a/service/transfer/api_op_ListAgreements.go b/service/transfer/api_op_ListAgreements.go index 91e11f7aaab..c2406a3031f 100644 --- a/service/transfer/api_op_ListAgreements.go +++ b/service/transfer/api_op_ListAgreements.go @@ -15,7 +15,7 @@ import ( // Returns a list of the agreements for the server that's identified by the // ServerId that you supply. If you want to limit the results to a certain number, // supply a value for the MaxResults parameter. If you ran the command previously -// and received a value for NextToken, you can supply that value to continue +// and received a value for NextToken , you can supply that value to continue // listing agreements from where you left off. func (c *Client) ListAgreements(ctx context.Context, params *ListAgreementsInput, optFns ...func(*Options)) (*ListAgreementsOutput, error) { if params == nil { diff --git a/service/transfer/api_op_ListCertificates.go b/service/transfer/api_op_ListCertificates.go index 890fb96aefe..cc95e890e4a 100644 --- a/service/transfer/api_op_ListCertificates.go +++ b/service/transfer/api_op_ListCertificates.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the current certificates that have been imported into Transfer -// Family. If you want to limit the results to a certain number, supply a value for -// the MaxResults parameter. If you ran the command previously and received a value -// for the NextToken parameter, you can supply that value to continue listing -// certificates from where you left off. +// Returns a list of the current certificates that have been imported into +// Transfer Family. If you want to limit the results to a certain number, supply a +// value for the MaxResults parameter. If you ran the command previously and +// received a value for the NextToken parameter, you can supply that value to +// continue listing certificates from where you left off. func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error) { if params == nil { params = &ListCertificatesInput{} diff --git a/service/transfer/api_op_ListExecutions.go b/service/transfer/api_op_ListExecutions.go index 6d835a342de..7b9f6035139 100644 --- a/service/transfer/api_op_ListExecutions.go +++ b/service/transfer/api_op_ListExecutions.go @@ -42,9 +42,9 @@ type ListExecutionsInput struct { // the NextToken parameter in a subsequent command to continue listing additional // executions. This is useful for pagination, for instance. If you have 100 // executions for a workflow, you might only want to list first 10. If so, call the - // API by specifying the max-results: aws transfer list-executions --max-results 10 - // This returns details for the first 10 executions, as well as the pointer - // (NextToken) to the eleventh execution. You can now call the API again, supplying + // API by specifying the max-results : aws transfer list-executions --max-results + // 10 This returns details for the first 10 executions, as well as the pointer ( + // NextToken ) to the eleventh execution. You can now call the API again, supplying // the NextToken value you received: aws transfer list-executions --max-results 10 // --next-token $somePointerReturnedFromPreviousListResult This call returns the // next 10 executions, the 11th through the 20th. You can then repeat the call @@ -57,19 +57,13 @@ type ListExecutionsInput struct { type ListExecutionsOutput struct { // Returns the details for each execution. - // - // * NextToken: returned from a call to - // several APIs, you can use pass it to a subsequent command to continue listing - // additional executions. - // - // * StartTime: timestamp indicating when the execution - // began. - // - // * Executions: details of the execution, including the execution ID, - // initial file location, and Service metadata. - // - // * Status: one of the following - // values: IN_PROGRESS, COMPLETED, EXCEPTION, HANDLING_EXEPTION. + // - NextToken: returned from a call to several APIs, you can use pass it to a + // subsequent command to continue listing additional executions. + // - StartTime: timestamp indicating when the execution began. + // - Executions: details of the execution, including the execution ID, initial + // file location, and Service metadata. + // - Status: one of the following values: IN_PROGRESS , COMPLETED , EXCEPTION , + // HANDLING_EXEPTION . // // This member is required. Executions []types.ListedExecution diff --git a/service/transfer/api_op_ListProfiles.go b/service/transfer/api_op_ListProfiles.go index 2648b47ac78..8d58d67327b 100644 --- a/service/transfer/api_op_ListProfiles.go +++ b/service/transfer/api_op_ListProfiles.go @@ -12,10 +12,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the profiles for your system. If you want to limit the results -// to a certain number, supply a value for the MaxResults parameter. If you ran the -// command previously and received a value for NextToken, you can supply that value -// to continue listing profiles from where you left off. +// Returns a list of the profiles for your system. If you want to limit the +// results to a certain number, supply a value for the MaxResults parameter. If +// you ran the command previously and received a value for NextToken , you can +// supply that value to continue listing profiles from where you left off. func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error) { if params == nil { params = &ListProfilesInput{} diff --git a/service/transfer/api_op_ListTagsForResource.go b/service/transfer/api_op_ListTagsForResource.go index acff29050a8..4e4a76d663e 100644 --- a/service/transfer/api_op_ListTagsForResource.go +++ b/service/transfer/api_op_ListTagsForResource.go @@ -133,8 +133,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/transfer/api_op_ListWorkflows.go b/service/transfer/api_op_ListWorkflows.go index 73433f42713..f178fbd1a7d 100644 --- a/service/transfer/api_op_ListWorkflows.go +++ b/service/transfer/api_op_ListWorkflows.go @@ -43,7 +43,7 @@ type ListWorkflowsInput struct { type ListWorkflowsOutput struct { - // Returns the Arn, WorkflowId, and Description for each workflow. + // Returns the Arn , WorkflowId , and Description for each workflow. // // This member is required. Workflows []types.ListedWorkflow diff --git a/service/transfer/api_op_SendWorkflowStepState.go b/service/transfer/api_op_SendWorkflowStepState.go index 7691414df3d..fdfe376e517 100644 --- a/service/transfer/api_op_SendWorkflowStepState.go +++ b/service/transfer/api_op_SendWorkflowStepState.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sends a callback for asynchronous custom steps. The ExecutionId, WorkflowId, and -// Token are passed to the target resource during execution of a custom step of a -// workflow. You must include those with their callback as well as providing a +// Sends a callback for asynchronous custom steps. The ExecutionId , WorkflowId , +// and Token are passed to the target resource during execution of a custom step +// of a workflow. You must include those with their callback as well as providing a // status. func (c *Client) SendWorkflowStepState(ctx context.Context, params *SendWorkflowStepStateInput, optFns ...func(*Options)) (*SendWorkflowStepStateOutput, error) { if params == nil { diff --git a/service/transfer/api_op_StartFileTransfer.go b/service/transfer/api_op_StartFileTransfer.go index 37207f41ebb..6fa74b992d9 100644 --- a/service/transfer/api_op_StartFileTransfer.go +++ b/service/transfer/api_op_StartFileTransfer.go @@ -35,7 +35,7 @@ type StartFileTransferInput struct { ConnectorId *string // An array of strings. Each string represents the absolute path for one outbound - // file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt . + // file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt . // // This member is required. SendFilePaths []string diff --git a/service/transfer/api_op_StartServer.go b/service/transfer/api_op_StartServer.go index 2832613fbd1..3a41b207eea 100644 --- a/service/transfer/api_op_StartServer.go +++ b/service/transfer/api_op_StartServer.go @@ -11,7 +11,7 @@ import ( ) // Changes the state of a file transfer protocol-enabled server from OFFLINE to -// ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server +// ONLINE . It has no impact on a server that is already ONLINE . An ONLINE server // can accept and process file transfer jobs. The state of STARTING indicates that // the server is in an intermediate state, either not fully able to respond, or not // fully online. The values of START_FAILED can indicate an error condition. No diff --git a/service/transfer/api_op_StopServer.go b/service/transfer/api_op_StopServer.go index 2f4abb12b22..7af1237b117 100644 --- a/service/transfer/api_op_StopServer.go +++ b/service/transfer/api_op_StopServer.go @@ -11,7 +11,7 @@ import ( ) // Changes the state of a file transfer protocol-enabled server from ONLINE to -// OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. +// OFFLINE . An OFFLINE server cannot accept and process file transfer jobs. // Information tied to your server, such as server and user properties, are not // affected by stopping your server. Stopping the server does not reduce or impact // your file transfer protocol endpoint billing; you must delete the server to stop diff --git a/service/transfer/api_op_TestIdentityProvider.go b/service/transfer/api_op_TestIdentityProvider.go index 04cb0d21132..39351c7ef9c 100644 --- a/service/transfer/api_op_TestIdentityProvider.go +++ b/service/transfer/api_op_TestIdentityProvider.go @@ -12,27 +12,26 @@ import ( ) // If the IdentityProviderType of a file transfer protocol-enabled server is -// AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is +// AWS_DIRECTORY_SERVICE or API_Gateway , tests whether your identity provider is // set up successfully. We highly recommend that you call this operation to test // your authentication method as soon as you create your server. By doing so, you // can troubleshoot issues with the identity provider integration to ensure that // your users can successfully use the service. The ServerId and UserName -// parameters are required. The ServerProtocol, SourceIp, and UserPassword are all -// optional. You cannot use TestIdentityProvider if the IdentityProviderType of -// your server is SERVICE_MANAGED. +// parameters are required. The ServerProtocol , SourceIp , and UserPassword are +// all optional. You cannot use TestIdentityProvider if the IdentityProviderType +// of your server is SERVICE_MANAGED . // -// * If you provide any incorrect values for any -// parameters, the Response field is empty. +// - If you provide any incorrect values for any parameters, the Response field +// is empty. // -// * If you provide a server ID for a -// server that uses service-managed users, you get an error: An error occurred -// (InvalidRequestException) when calling the TestIdentityProvider operation: -// s-server-ID not configured for external auth +// - If you provide a server ID for a server that uses service-managed users, +// you get an error: An error occurred (InvalidRequestException) when calling +// the TestIdentityProvider operation: s-server-ID not configured for external auth // -// * If you enter a Server ID for the -// --server-id parameter that does not identify an actual Transfer server, you -// receive the following error: An error occurred (ResourceNotFoundException) when -// calling the TestIdentityProvider operation: Unknown server +// - If you enter a Server ID for the --server-id parameter that does not +// identify an actual Transfer server, you receive the following error: An error +// occurred (ResourceNotFoundException) when calling the TestIdentityProvider +// operation: Unknown server func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityProviderInput, optFns ...func(*Options)) (*TestIdentityProviderOutput, error) { if params == nil { params = &TestIdentityProviderInput{} @@ -62,14 +61,9 @@ type TestIdentityProviderInput struct { UserName *string // The type of file transfer protocol to be tested. The available protocols are: - // - // * - // Secure Shell (SSH) File Transfer Protocol (SFTP) - // - // * File Transfer Protocol - // Secure (FTPS) - // - // * File Transfer Protocol (FTP) + // - Secure Shell (SSH) File Transfer Protocol (SFTP) + // - File Transfer Protocol Secure (FTPS) + // - File Transfer Protocol (FTP) ServerProtocol types.Protocol // The source IP address of the user account to be tested. diff --git a/service/transfer/api_op_UpdateAccess.go b/service/transfer/api_op_UpdateAccess.go index a21733b37ed..626b0f96a15 100644 --- a/service/transfer/api_op_UpdateAccess.go +++ b/service/transfer/api_op_UpdateAccess.go @@ -51,7 +51,7 @@ type UpdateAccessInput struct { ServerId *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -59,20 +59,21 @@ type UpdateAccessInput struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value + // and Access Management (IAM) role provides access to paths in Target . This value // can be set only when HomeDirectoryType is set to LOGICAL. The following is an // Entry and Target pair example. [ { "Entry": "/directory1", "Target": // "/bucket_name/home/mydirectory" } ] In most cases, you can use this value // instead of the session policy to lock down your user to the designated home - // directory ("chroot"). To do this, you can set Entry to / and set Target to the - // HomeDirectory parameter value. The following is an Entry and Target pair example - // for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] + // directory (" chroot "). To do this, you can set Entry to / and set Target to + // the HomeDirectory parameter value. The following is an Entry and Target pair + // example for chroot . [ { "Entry": "/", "Target": + // "/bucket_name/home/mydirectory" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType types.HomeDirectoryType @@ -80,20 +81,18 @@ type UpdateAccessInput struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is - // Amazon S3. Amazon EFS does not use session policies. For session policies, + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . This policy applies only when the domain of ServerId + // is Amazon S3. Amazon EFS does not use session policies. For session policies, // Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource // Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the - // Policy argument. For an example of a session policy, see Example session policy - // (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html). For - // more information, see AssumeRole - // (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the - // Amazon Web ServicesSecurity Token Service API Reference. + // Policy argument. For an example of a session policy, see Example session policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html) + // . For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) + // in the Amazon Web ServicesSecurity Token Service API Reference. Policy *string - // The full POSIX identity, including user ID (Uid), group ID (Gid), and any - // secondary groups IDs (SecondaryGids), that controls your users' access to your + // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any + // secondary groups IDs ( SecondaryGids ), that controls your users' access to your // Amazon EFS file systems. The POSIX permissions that are set on files and // directories in your file system determine the level of access your users get // when transferring files into and out of your Amazon EFS file systems. diff --git a/service/transfer/api_op_UpdateAgreement.go b/service/transfer/api_op_UpdateAgreement.go index 4b477e6e0ed..56a9509eb2d 100644 --- a/service/transfer/api_op_UpdateAgreement.go +++ b/service/transfer/api_op_UpdateAgreement.go @@ -44,19 +44,19 @@ type UpdateAgreementInput struct { ServerId *string // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . AccessRole *string - // To change the landing directory (folder) for files that are transferred, provide - // the bucket folder that you want to use; for example, + // To change the landing directory (folder) for files that are transferred, + // provide the bucket folder that you want to use; for example, // /DOC-EXAMPLE-BUCKET/home/mydirectory . BaseDirectory *string diff --git a/service/transfer/api_op_UpdateConnector.go b/service/transfer/api_op_UpdateConnector.go index c0ea09b4c54..2e44f29adce 100644 --- a/service/transfer/api_op_UpdateConnector.go +++ b/service/transfer/api_op_UpdateConnector.go @@ -37,15 +37,15 @@ type UpdateConnectorInput struct { ConnectorId *string // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . AccessRole *string // A structure that contains the parameters for a connector object. diff --git a/service/transfer/api_op_UpdateServer.go b/service/transfer/api_op_UpdateServer.go index e98e7423e4a..780289fdc80 100644 --- a/service/transfer/api_op_UpdateServer.go +++ b/service/transfer/api_op_UpdateServer.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the file transfer protocol-enabled server's properties after that server -// has been created. The UpdateServer call returns the ServerId of the server you -// updated. +// Updates the file transfer protocol-enabled server's properties after that +// server has been created. The UpdateServer call returns the ServerId of the +// server you updated. func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, optFns ...func(*Options)) (*UpdateServerOutput, error) { if params == nil { params = &UpdateServerInput{} @@ -38,35 +38,22 @@ type UpdateServerInput struct { ServerId *string // The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager - // (ACM) certificate. Required when Protocols is set to FTPS. To request a new - // public certificate, see Request a public certificate - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) in - // the Amazon Web ServicesCertificate Manager User Guide. To import an existing - // certificate into ACM, see Importing certificates into ACM - // (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in - // the Amazon Web ServicesCertificate Manager User Guide. To request a private + // (ACM) certificate. Required when Protocols is set to FTPS . To request a new + // public certificate, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) + // in the Amazon Web ServicesCertificate Manager User Guide. To import an existing + // certificate into ACM, see Importing certificates into ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) + // in the Amazon Web ServicesCertificate Manager User Guide. To request a private // certificate to use FTPS through private IP addresses, see Request a private - // certificate - // (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) + // certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) // in the Amazon Web ServicesCertificate Manager User Guide. Certificates with the // following cryptographic algorithms and key sizes are supported: - // - // * 2048-bit RSA - // (RSA_2048) - // - // * 4096-bit RSA (RSA_4096) - // - // * Elliptic Prime Curve 256 bit - // (EC_prime256v1) - // - // * Elliptic Prime Curve 384 bit (EC_secp384r1) - // - // * Elliptic Prime - // Curve 521 bit (EC_secp521r1) - // - // The certificate must be a valid SSL/TLS X.509 - // version 3 certificate with FQDN or IP address specified and information about - // the issuer. + // - 2048-bit RSA (RSA_2048) + // - 4096-bit RSA (RSA_4096) + // - Elliptic Prime Curve 256 bit (EC_prime256v1) + // - Elliptic Prime Curve 384 bit (EC_secp384r1) + // - Elliptic Prime Curve 521 bit (EC_secp521r1) + // The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN + // or IP address specified and information about the issuer. Certificate *string // The virtual private cloud (VPC) endpoint settings that are configured for your @@ -85,31 +72,30 @@ type UpdateServerInput struct { // Servicesaccount if your account hasn't already done so before May 19, 2021. If // you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon // Web Servicesaccount on or before May 19, 2021, you will not be affected. After - // this date, use EndpointType=VPC. For more information, see + // this date, use EndpointType = VPC . For more information, see // https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. - // It is recommended that you use VPC as the EndpointType. With this endpoint type, - // you have the option to directly associate up to three Elastic IPv4 addresses - // (BYO IP included) with your server's endpoint and use VPC security groups to - // restrict traffic by the client's public IP address. This is not possible with - // EndpointType set to VPC_ENDPOINT. + // It is recommended that you use VPC as the EndpointType . With this endpoint + // type, you have the option to directly associate up to three Elastic IPv4 + // addresses (BYO IP included) with your server's endpoint and use VPC security + // groups to restrict traffic by the client's public IP address. This is not + // possible with EndpointType set to VPC_ENDPOINT . EndpointType types.EndpointType // The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You // can add multiple host keys, in case you want to rotate keys, or have a set of // active keys that use different algorithms. Use the following command to generate // an RSA 2048 bit key with no passphrase: ssh-keygen -t rsa -b 2048 -N "" -m PEM - // -f my-new-server-key. Use a minimum value of 2048 for the -b option. You can + // -f my-new-server-key . Use a minimum value of 2048 for the -b option. You can // create a stronger key by using 3072 or 4096. Use the following command to // generate an ECDSA 256 bit key with no passphrase: ssh-keygen -t ecdsa -b 256 -N - // "" -m PEM -f my-new-server-key. Valid values for the -b option for ECDSA are + // "" -m PEM -f my-new-server-key . Valid values for the -b option for ECDSA are // 256, 384, and 521. Use the following command to generate an ED25519 key with no - // passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key. For all of these + // passphrase: ssh-keygen -t ed25519 -N "" -f my-new-server-key . For all of these // commands, you can replace my-new-server-key with a string of your choice. If you // aren't planning to migrate existing users from an existing SFTP-enabled server // to a new server, don't update the host key. Accidentally changing a server's // host key can be disruptive. For more information, see Manage host keys for your - // SFTP-enabled server - // (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key) + // SFTP-enabled server (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key) // in the Transfer Family User Guide. HostKey *string @@ -136,63 +122,45 @@ type UpdateServerInput struct { PreAuthenticationLoginBanner *string // The protocol settings that are configured for your server. - // - // * To indicate - // passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a - // single dotted-quad IPv4 address, such as the external IP address of a firewall, - // router, or load balancer. - // - // * To ignore the error that is generated when the - // client attempts to use the SETSTAT command on a file that you are uploading to - // an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer - // Family server ignore the SETSTAT command and upload files without needing to - // make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set - // the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log - // entry to Amazon CloudWatch Logs, so that you can determine when the client is - // making a SETSTAT call. - // - // * To determine whether your Transfer Family server - // resumes recent, negotiated sessions through a unique session ID, use the - // TlsSessionResumptionMode parameter. - // - // * As2Transports indicates the transport - // method for the AS2 messages. Currently, only HTTP is supported. + // - To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp + // parameter. Enter a single dotted-quad IPv4 address, such as the external IP + // address of a firewall, router, or load balancer. + // - To ignore the error that is generated when the client attempts to use the + // SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use + // the SetStatOption parameter. To have the Transfer Family server ignore the + // SETSTAT command and upload files without needing to make any changes to your + // SFTP client, set the value to ENABLE_NO_OP . If you set the SetStatOption + // parameter to ENABLE_NO_OP , Transfer Family generates a log entry to Amazon + // CloudWatch Logs, so that you can determine when the client is making a SETSTAT + // call. + // - To determine whether your Transfer Family server resumes recent, negotiated + // sessions through a unique session ID, use the TlsSessionResumptionMode + // parameter. + // - As2Transports indicates the transport method for the AS2 messages. + // Currently, only HTTP is supported. ProtocolDetails *types.ProtocolDetails // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are: + // - SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH + // - FTPS (File Transfer Protocol Secure): File transfer with TLS encryption + // - FTP (File Transfer Protocol): Unencrypted file transfer + // - AS2 (Applicability Statement 2): used for transporting structured + // business-to-business data // - // * SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over - // SSH - // - // * FTPS (File Transfer Protocol Secure): File transfer with TLS - // encryption - // - // * FTP (File Transfer Protocol): Unencrypted file transfer - // - // * AS2 - // (Applicability Statement 2): used for transporting structured - // business-to-business data - // - // * If you select FTPS, you must choose a certificate - // stored in Certificate Manager (ACM) which is used to identify your server when - // clients connect to it over FTPS. - // - // * If Protocol includes either FTP or FTPS, - // then the EndpointType must be VPC and the IdentityProviderType must be either - // AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes FTP, - // then AddressAllocationIds cannot be associated. - // - // * If Protocol is set only to - // SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be - // set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, - // AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes AS2, then the EndpointType - // must be VPC, and domain must be Amazon S3. + // - If you select FTPS , you must choose a certificate stored in Certificate + // Manager (ACM) which is used to identify your server when clients connect to it + // over FTPS. + // - If Protocol includes either FTP or FTPS , then the EndpointType must be VPC + // and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE , AWS_LAMBDA + // , or API_GATEWAY . + // - If Protocol includes FTP , then AddressAllocationIds cannot be associated. + // - If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and + // the IdentityProviderType can be set any of the supported identity types: + // SERVICE_MANAGED , AWS_DIRECTORY_SERVICE , AWS_LAMBDA , or API_GATEWAY . + // - If Protocol includes AS2 , then the EndpointType must be VPC , and domain + // must be Amazon S3. Protocols []types.Protocol // Specifies the name of the security policy that is attached to the server. diff --git a/service/transfer/api_op_UpdateUser.go b/service/transfer/api_op_UpdateUser.go index 0d6bf9e9974..ba9a24e6e1b 100644 --- a/service/transfer/api_op_UpdateUser.go +++ b/service/transfer/api_op_UpdateUser.go @@ -39,7 +39,7 @@ type UpdateUserInput struct { ServerId *string // A unique string that identifies a user and is associated with a server as - // specified by the ServerId. This user name must be a minimum of 3 and a maximum + // specified by the ServerId . This user name must be a minimum of 3 and a maximum // of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, // underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't // start with a hyphen, period, or at sign. @@ -48,7 +48,7 @@ type UpdateUserInput struct { UserName *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -56,20 +56,21 @@ type UpdateUserInput struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value + // and Access Management (IAM) role provides access to paths in Target . This value // can be set only when HomeDirectoryType is set to LOGICAL. The following is an // Entry and Target pair example. [ { "Entry": "/directory1", "Target": // "/bucket_name/home/mydirectory" } ] In most cases, you can use this value // instead of the session policy to lock down your user to the designated home - // directory ("chroot"). To do this, you can set Entry to '/' and set Target to the - // HomeDirectory parameter value. The following is an Entry and Target pair example - // for chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] + // directory (" chroot "). To do this, you can set Entry to '/' and set Target to + // the HomeDirectory parameter value. The following is an Entry and Target pair + // example for chroot . [ { "Entry": "/", "Target": + // "/bucket_name/home/mydirectory" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType types.HomeDirectoryType @@ -77,21 +78,20 @@ type UpdateUserInput struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. This policy applies only when the domain of ServerId is - // Amazon S3. Amazon EFS does not use session policies. For session policies, + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . This policy applies only when the domain of ServerId + // is Amazon S3. Amazon EFS does not use session policies. For session policies, // Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource // Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the // Policy argument. For an example of a session policy, see Creating a session - // policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy). - // For more information, see AssumeRole - // (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the - // Amazon Web Services Security Token Service API Reference. + // policy (https://docs.aws.amazon.com/transfer/latest/userguide/session-policy) . + // For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) + // in the Amazon Web Services Security Token Service API Reference. Policy *string - // Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and - // any secondary groups IDs (SecondaryGids), that controls your users' access to - // your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are + // Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), + // and any secondary groups IDs ( SecondaryGids ), that controls your users' access + // to your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are // set on files and directories in your file system determines the level of access // your users get when transferring files into and out of your Amazon EFS file // systems. diff --git a/service/transfer/types/enums.go b/service/transfer/types/enums.go index 7d8e5b73a07..339dc86bc02 100644 --- a/service/transfer/types/enums.go +++ b/service/transfer/types/enums.go @@ -27,9 +27,9 @@ const ( As2TransportHttp As2Transport = "HTTP" ) -// Values returns all known values for As2Transport. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for As2Transport. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (As2Transport) Values() []As2Transport { return []As2Transport{ "HTTP", @@ -45,8 +45,8 @@ const ( CertificateStatusTypeInactive CertificateStatusType = "INACTIVE" ) -// Values returns all known values for CertificateStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CertificateStatusType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CertificateStatusType) Values() []CertificateStatusType { return []CertificateStatusType{ @@ -193,9 +193,9 @@ const ( EndpointTypeVpcEndpoint EndpointType = "VPC_ENDPOINT" ) -// Values returns all known values for EndpointType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for EndpointType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (EndpointType) Values() []EndpointType { return []EndpointType{ "PUBLIC", @@ -452,8 +452,8 @@ const ( StateStopFailed State = "STOP_FAILED" ) -// Values returns all known values for State. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for State. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (State) Values() []State { return []State{ @@ -475,9 +475,9 @@ const ( TlsSessionResumptionModeEnforced TlsSessionResumptionMode = "ENFORCED" ) -// Values returns all known values for TlsSessionResumptionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for TlsSessionResumptionMode. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (TlsSessionResumptionMode) Values() []TlsSessionResumptionMode { return []TlsSessionResumptionMode{ "DISABLED", diff --git a/service/transfer/types/errors.go b/service/transfer/types/errors.go index f153614fbed..2395f76a1ca 100644 --- a/service/transfer/types/errors.go +++ b/service/transfer/types/errors.go @@ -61,8 +61,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer -// Family service. +// This exception is thrown when an error occurs in the Amazon Web +// ServicesTransfer Family service. type InternalServiceError struct { Message *string @@ -199,8 +199,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request has failed because the Amazon Web ServicesTransfer Family service is -// not available. +// The request has failed because the Amazon Web ServicesTransfer Family service +// is not available. type ServiceUnavailableException struct { Message *string diff --git a/service/transfer/types/types.go b/service/transfer/types/types.go index 7a48b178afd..216cc9a8027 100644 --- a/service/transfer/types/types.go +++ b/service/transfer/types/types.go @@ -15,9 +15,9 @@ type As2ConnectorConfig struct { // Specifies whether the AS2 file is compressed. Compression CompressionEnum - // The algorithm that is used to encrypt the file. You can only specify NONE if the - // URL for your connector uses HTTPS. This ensures that no traffic is sent in clear - // text. + // The algorithm that is used to encrypt the file. You can only specify NONE if + // the URL for your connector uses HTTPS. This ensures that no traffic is sent in + // clear text. EncryptionAlgorithm EncryptionAlg // A unique identifier for the AS2 local profile. @@ -26,12 +26,9 @@ type As2ConnectorConfig struct { // Used for outbound requests (from an Transfer Family server to a partner AS2 // server) to determine whether the partner response for transfers is synchronous // or asynchronous. Specify either of the following values: - // - // * SYNC: The system - // expects a synchronous MDN response, confirming that the file was transferred - // successfully (or not). - // - // * NONE: Specifies that no MDN response is required. + // - SYNC : The system expects a synchronous MDN response, confirming that the + // file was transferred successfully (or not). + // - NONE : Specifies that no MDN response is required. MdnResponse MdnResponse // The signing algorithm for the MDN response. If set to DEFAULT (or not set at @@ -57,35 +54,29 @@ type CopyStepDetails struct { // Specifies the location for the file being copied. Use ${Transfer:username} or // ${Transfer:UploadDate} in this field to parametrize the destination prefix by // username or uploaded date. - // - // * Set the value of DestinationFileLocation to - // ${Transfer:username} to copy uploaded files to an Amazon S3 bucket that is - // prefixed with the name of the Transfer Family user that uploaded the file. - // - // * - // Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy - // uploaded files to an Amazon S3 bucket that is prefixed with the date of the - // upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based on - // the date the file is uploaded. + // - Set the value of DestinationFileLocation to ${Transfer:username} to copy + // uploaded files to an Amazon S3 bucket that is prefixed with the name of the + // Transfer Family user that uploaded the file. + // - Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy + // uploaded files to an Amazon S3 bucket that is prefixed with the date of the + // upload. The system resolves UploadDate to a date format of YYYY-MM-DD, based + // on the date the file is uploaded. DestinationFileLocation *InputFileLocation // The name of the step, used as an identifier. Name *string // A flag that indicates whether to overwrite an existing file of the same name. - // The default is FALSE. + // The default is FALSE . OverwriteExisting OverwriteExisting // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. - // - // * To - // use the previous file as the input, enter ${previous.file}. In this case, this - // workflow step uses the output file from the previous workflow step as input. - // This is the default value. - // - // * To use the originally uploaded file location as - // input for this step, enter ${original.file}. + // - To use the previous file as the input, enter ${previous.file} . In this + // case, this workflow step uses the output file from the previous workflow step as + // input. This is the default value. + // - To use the originally uploaded file location as input for this step, enter + // ${original.file} . SourceFileLocation *string noSmithyDocumentSerde @@ -99,14 +90,11 @@ type CustomStepDetails struct { // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. - // - // * To - // use the previous file as the input, enter ${previous.file}. In this case, this - // workflow step uses the output file from the previous workflow step as input. - // This is the default value. - // - // * To use the originally uploaded file location as - // input for this step, enter ${original.file}. + // - To use the previous file as the input, enter ${previous.file} . In this + // case, this workflow step uses the output file from the previous workflow step as + // input. This is the default value. + // - To use the originally uploaded file location as input for this step, enter + // ${original.file} . SourceFileLocation *string // The ARN for the lambda function that is being called. @@ -126,7 +114,7 @@ type DecryptStepDetails struct { // This member is required. DestinationFileLocation *InputFileLocation - // The type of encryption used. Currently, this value must be PGP. + // The type of encryption used. Currently, this value must be PGP . // // This member is required. Type EncryptionType @@ -135,19 +123,16 @@ type DecryptStepDetails struct { Name *string // A flag that indicates whether to overwrite an existing file of the same name. - // The default is FALSE. + // The default is FALSE . OverwriteExisting OverwriteExisting // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. - // - // * To - // use the previous file as the input, enter ${previous.file}. In this case, this - // workflow step uses the output file from the previous workflow step as input. - // This is the default value. - // - // * To use the originally uploaded file location as - // input for this step, enter ${original.file}. + // - To use the previous file as the input, enter ${previous.file} . In this + // case, this workflow step uses the output file from the previous workflow step as + // input. This is the default value. + // - To use the originally uploaded file location as input for this step, enter + // ${original.file} . SourceFileLocation *string noSmithyDocumentSerde @@ -161,14 +146,11 @@ type DeleteStepDetails struct { // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. - // - // * To - // use the previous file as the input, enter ${previous.file}. In this case, this - // workflow step uses the output file from the previous workflow step as input. - // This is the default value. - // - // * To use the originally uploaded file location as - // input for this step, enter ${original.file}. + // - To use the previous file as the input, enter ${previous.file} . In this + // case, this workflow step uses the output file from the previous workflow step as + // input. This is the default value. + // - To use the originally uploaded file location as input for this step, enter + // ${original.file} . SourceFileLocation *string noSmithyDocumentSerde @@ -190,7 +172,7 @@ type DescribedAccess struct { ExternalId *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -198,17 +180,17 @@ type DescribedAccess struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value - // can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can - // use this value instead of the session policy to lock down the associated access - // to the designated home directory ("chroot"). To do this, you can set Entry to - // '/' and set Target to the HomeDirectory parameter value. + // and Access Management (IAM) role provides access to paths in Target . This value + // can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you + // can use this value instead of the session policy to lock down the associated + // access to the designated home directory (" chroot "). To do this, you can set + // Entry to '/' and set Target to the HomeDirectory parameter value. HomeDirectoryMappings []HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType HomeDirectoryType @@ -216,12 +198,12 @@ type DescribedAccess struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . Policy *string - // The full POSIX identity, including user ID (Uid), group ID (Gid), and any - // secondary groups IDs (SecondaryGids), that controls your users' access to your + // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any + // secondary groups IDs ( SecondaryGids ), that controls your users' access to your // Amazon EFS file systems. The POSIX permissions that are set on files and // directories in your file system determine the level of access your users get // when transferring files into and out of your Amazon EFS file systems. @@ -248,15 +230,15 @@ type DescribedAgreement struct { Arn *string // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . AccessRole *string // A unique identifier for the agreement. This identifier is returned when you @@ -280,7 +262,7 @@ type DescribedAgreement struct { // indicates the specific server that the agreement uses. ServerId *string - // The current status of the agreement, either ACTIVE or INACTIVE. + // The current status of the agreement, either ACTIVE or INACTIVE . Status AgreementStatusType // Key-value pairs that can be used to group and search for agreements. @@ -325,7 +307,7 @@ type DescribedCertificate struct { // The serial number for the certificate. Serial *string - // The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. + // The certificate can be either ACTIVE , PENDING_ROTATION , or INACTIVE . // PENDING_ROTATION means that this certificate will replace the current // certificate when it expires. Status CertificateStatusType @@ -334,8 +316,8 @@ type DescribedCertificate struct { Tags []Tag // If a private key has been specified for the certificate, its type is - // CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is - // CERTIFICATE. + // CERTIFICATE_WITH_PRIVATE_KEY . If there is no private key, the type is + // CERTIFICATE . Type CertificateType // Specifies whether this certificate is used for signing or encryption. @@ -344,7 +326,7 @@ type DescribedCertificate struct { noSmithyDocumentSerde } -// Describes the parameters for the connector, as identified by the ConnectorId. +// Describes the parameters for the connector, as identified by the ConnectorId . type DescribedConnector struct { // The unique Amazon Resource Name (ARN) for the connector. @@ -353,15 +335,15 @@ type DescribedConnector struct { Arn *string // With AS2, you can send files by calling StartFileTransfer and specifying the - // file paths in the request parameter, SendFilePaths. We use the file’s parent - // directory (for example, for --send-file-paths /bucket/dir/file.txt, parent - // directory is /bucket/dir/) to temporarily store a processed AS2 message file, + // file paths in the request parameter, SendFilePaths . We use the file’s parent + // directory (for example, for --send-file-paths /bucket/dir/file.txt , parent + // directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, // store the MDN when we receive them from the partner, and write a final JSON file // containing relevant metadata of the transmission. So, the AccessRole needs to // provide read and write access to the parent directory of the file location used // in the StartFileTransfer request. Additionally, you need to provide read and // write access to the parent directory of the files that you intend to send with - // StartFileTransfer. + // StartFileTransfer . AccessRole *string // A structure that contains the parameters for a connector object. @@ -401,8 +383,8 @@ type DescribedExecution struct { // The IAM logging role associated with the execution. LoggingConfiguration *LoggingConfiguration - // The full POSIX identity, including user ID (Uid), group ID (Gid), and any - // secondary groups IDs (SecondaryGids), that controls your users' access to your + // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any + // secondary groups IDs ( SecondaryGids ), that controls your users' access to your // Amazon EFS file systems. The POSIX permissions that are set on files and // directories in your file system determine the level of access your users get // when transferring files into and out of your Amazon EFS file systems. @@ -449,17 +431,11 @@ type DescribedHostKey struct { // The encryption algorithm that is used for the host key. The Type parameter is // specified by using one of the following values: - // - // * ssh-rsa - // - // * ssh-ed25519 - // - // * - // ecdsa-sha2-nistp256 - // - // * ecdsa-sha2-nistp384 - // - // * ecdsa-sha2-nistp521 + // - ssh-rsa + // - ssh-ed25519 + // - ecdsa-sha2-nistp256 + // - ecdsa-sha2-nistp384 + // - ecdsa-sha2-nistp521 Type *string noSmithyDocumentSerde @@ -473,11 +449,11 @@ type DescribedProfile struct { // This member is required. Arn *string - // The As2Id is the AS2-name, as defined in the RFC 4130 - // (https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is - // the AS2-From header for the AS2 messages sent from the partner. For outbound - // connectors, this is the AS2-To header for the AS2 messages sent to the partner - // using the StartFileTransfer API operation. This ID cannot include spaces. + // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130) + // . For inbound transfers, this is the AS2-From header for the AS2 messages sent + // from the partner. For outbound connectors, this is the AS2-To header for the + // AS2 messages sent to the partner using the StartFileTransfer API operation. + // This ID cannot include spaces. As2Id *string // An array of identifiers for the imported certificates. You use this identifier @@ -499,8 +475,8 @@ type DescribedProfile struct { } // Describes the properties of a security policy that was specified. For more -// information about security policies, see Working with security policies -// (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html). +// information about security policies, see Working with security policies (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) +// . type DescribedSecurityPolicy struct { // Specifies the name of the security policy that is attached to the server. @@ -541,7 +517,7 @@ type DescribedServer struct { Arn *string // Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) - // certificate. Required when Protocols is set to FTPS. + // certificate. Required when Protocols is set to FTPS . Certificate *string // Specifies the domain of the storage system that is used for file transfers. @@ -554,8 +530,8 @@ type DescribedServer struct { // VPC's default security groups are automatically assigned to your endpoint. EndpointDetails *EndpointDetails - // Defines the type of endpoint that your server is connected to. If your server is - // connected to a VPC endpoint, your server isn't accessible over the public + // Defines the type of endpoint that your server is connected to. If your server + // is connected to a VPC endpoint, your server isn't accessible over the public // internet. EndpointType EndpointType @@ -564,12 +540,12 @@ type DescribedServer struct { // command. HostKeyFingerprint *string - // Specifies information to call a customer-supplied authentication API. This field - // is not populated when the IdentityProviderType of a server is - // AWS_DIRECTORY_SERVICE or SERVICE_MANAGED. + // Specifies information to call a customer-supplied authentication API. This + // field is not populated when the IdentityProviderType of a server is + // AWS_DIRECTORY_SERVICE or SERVICE_MANAGED . IdentityProviderDetails *IdentityProviderDetails - // The mode of authentication for a server. The default value is SERVICE_MANAGED, + // The mode of authentication for a server. The default value is SERVICE_MANAGED , // which allows you to store and access user credentials within the Transfer Family // service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups // in Directory Service for Microsoft Active Directory or Microsoft Active @@ -603,63 +579,45 @@ type DescribedServer struct { PreAuthenticationLoginBanner *string // The protocol settings that are configured for your server. - // - // * To indicate - // passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a - // single dotted-quad IPv4 address, such as the external IP address of a firewall, - // router, or load balancer. - // - // * To ignore the error that is generated when the - // client attempts to use the SETSTAT command on a file that you are uploading to - // an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer - // Family server ignore the SETSTAT command and upload files without needing to - // make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set - // the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log - // entry to Amazon CloudWatch Logs, so that you can determine when the client is - // making a SETSTAT call. - // - // * To determine whether your Transfer Family server - // resumes recent, negotiated sessions through a unique session ID, use the - // TlsSessionResumptionMode parameter. - // - // * As2Transports indicates the transport - // method for the AS2 messages. Currently, only HTTP is supported. + // - To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp + // parameter. Enter a single dotted-quad IPv4 address, such as the external IP + // address of a firewall, router, or load balancer. + // - To ignore the error that is generated when the client attempts to use the + // SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use + // the SetStatOption parameter. To have the Transfer Family server ignore the + // SETSTAT command and upload files without needing to make any changes to your + // SFTP client, set the value to ENABLE_NO_OP . If you set the SetStatOption + // parameter to ENABLE_NO_OP , Transfer Family generates a log entry to Amazon + // CloudWatch Logs, so that you can determine when the client is making a SETSTAT + // call. + // - To determine whether your Transfer Family server resumes recent, negotiated + // sessions through a unique session ID, use the TlsSessionResumptionMode + // parameter. + // - As2Transports indicates the transport method for the AS2 messages. + // Currently, only HTTP is supported. ProtocolDetails *ProtocolDetails // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are: - // - // * SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over - // SSH - // - // * FTPS (File Transfer Protocol Secure): File transfer with TLS - // encryption - // - // * FTP (File Transfer Protocol): Unencrypted file transfer - // - // * AS2 - // (Applicability Statement 2): used for transporting structured - // business-to-business data - // - // * If you select FTPS, you must choose a certificate - // stored in Certificate Manager (ACM) which is used to identify your server when - // clients connect to it over FTPS. - // - // * If Protocol includes either FTP or FTPS, - // then the EndpointType must be VPC and the IdentityProviderType must be either - // AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes FTP, - // then AddressAllocationIds cannot be associated. - // - // * If Protocol is set only to - // SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be - // set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, - // AWS_LAMBDA, or API_GATEWAY. - // - // * If Protocol includes AS2, then the EndpointType - // must be VPC, and domain must be Amazon S3. + // - SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH + // - FTPS (File Transfer Protocol Secure): File transfer with TLS encryption + // - FTP (File Transfer Protocol): Unencrypted file transfer + // - AS2 (Applicability Statement 2): used for transporting structured + // business-to-business data + // + // - If you select FTPS , you must choose a certificate stored in Certificate + // Manager (ACM) which is used to identify your server when clients connect to it + // over FTPS. + // - If Protocol includes either FTP or FTPS , then the EndpointType must be VPC + // and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE , AWS_LAMBDA + // , or API_GATEWAY . + // - If Protocol includes FTP , then AddressAllocationIds cannot be associated. + // - If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and + // the IdentityProviderType can be set any of the supported identity types: + // SERVICE_MANAGED , AWS_DIRECTORY_SERVICE , AWS_LAMBDA , or API_GATEWAY . + // - If Protocol includes AS2 , then the EndpointType must be VPC , and domain + // must be Amazon S3. Protocols []Protocol // Specifies the name of the security policy that is attached to the server. @@ -669,12 +627,12 @@ type DescribedServer struct { // instantiate. ServerId *string - // The condition of the server that was described. A value of ONLINE indicates that - // the server can accept jobs and transfer files. A State value of OFFLINE means - // that the server cannot perform file transfer operations. The states of STARTING - // and STOPPING indicate that the server is in an intermediate state, either not - // fully able to respond, or not fully offline. The values of START_FAILED or - // STOP_FAILED can indicate an error condition. + // The condition of the server that was described. A value of ONLINE indicates + // that the server can accept jobs and transfer files. A State value of OFFLINE + // means that the server cannot perform file transfer operations. The states of + // STARTING and STOPPING indicate that the server is in an intermediate state, + // either not fully able to respond, or not fully offline. The values of + // START_FAILED or STOP_FAILED can indicate an error condition. State State // Specifies the key-value pairs that you can use to search for and group servers @@ -682,7 +640,7 @@ type DescribedServer struct { Tags []Tag // Specifies the number of users that are assigned to a server you specified with - // the ServerId. + // the ServerId . UserCount *int32 // Specifies the workflow ID for the workflow to assign and the execution role @@ -705,7 +663,7 @@ type DescribedUser struct { Arn *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -713,17 +671,17 @@ type DescribedUser struct { // must specify the Entry and Target pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 or Amazon EFS path. If you only // specify a target, it is displayed as is. You also must ensure that your Identity - // and Access Management (IAM) role provides access to paths in Target. This value - // can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can - // use this value instead of the session policy to lock your user down to the - // designated home directory ("chroot"). To do this, you can set Entry to '/' and - // set Target to the HomeDirectory parameter value. + // and Access Management (IAM) role provides access to paths in Target . This value + // can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you + // can use this value instead of the session policy to lock your user down to the + // designated home directory (" chroot "). To do this, you can set Entry to '/' + // and set Target to the HomeDirectory parameter value. HomeDirectoryMappings []HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType HomeDirectoryType @@ -731,16 +689,16 @@ type DescribedUser struct { // A session policy for your user so that you can use the same Identity and Access // Management (IAM) role across multiple users. This policy scopes down a user's // access to portions of their Amazon S3 bucket. Variables that you can use inside - // this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and - // ${Transfer:HomeBucket}. + // this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and + // ${Transfer:HomeBucket} . Policy *string - // Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and - // any secondary groups IDs (SecondaryGids), that controls your users' access to - // your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions - // that are set on files and directories in your file system determine the level of - // access your users get when transferring files into and out of your Amazon EFS - // file systems. + // Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), + // and any secondary groups IDs ( SecondaryGids ), that controls your users' access + // to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX + // permissions that are set on files and directories in your file system determine + // the level of access your users get when transferring files into and out of your + // Amazon EFS file systems. PosixProfile *PosixProfile // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -779,8 +737,8 @@ type DescribedWorkflow struct { // Specifies the text description for the workflow. Description *string - // Specifies the steps (actions) to take if errors are encountered during execution - // of the workflow. + // Specifies the steps (actions) to take if errors are encountered during + // execution of the workflow. OnExceptionSteps []WorkflowStep // Specifies the details for the steps that are in the specified workflow. @@ -819,7 +777,7 @@ type EfsFileLocation struct { // your account hasn't already done so before May 19, 2021. If you have already // created servers with EndpointType=VPC_ENDPOINT in your Amazon Web // Servicesaccount on or before May 19, 2021, you will not be affected. After this -// date, use EndpointType=VPC. For more information, see +// date, use EndpointType = VPC . For more information, see // https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. type EndpointDetails struct { @@ -829,27 +787,25 @@ type EndpointDetails struct { AddressAllocationIds []string // A list of security groups IDs that are available to attach to your server's - // endpoint. This property can only be set when EndpointType is set to VPC. You can - // edit the SecurityGroupIds property in the UpdateServer - // (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) - // API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to - // VPC. To change security groups associated with your server's VPC endpoint after - // creation, use the Amazon EC2 ModifyVpcEndpoint - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) + // endpoint. This property can only be set when EndpointType is set to VPC . You + // can edit the SecurityGroupIds property in the UpdateServer (https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html) + // API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC + // . To change security groups associated with your server's VPC endpoint after + // creation, use the Amazon EC2 ModifyVpcEndpoint (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html) // API. SecurityGroupIds []string - // A list of subnet IDs that are required to host your server endpoint in your VPC. - // This property can only be set when EndpointType is set to VPC. + // A list of subnet IDs that are required to host your server endpoint in your + // VPC. This property can only be set when EndpointType is set to VPC . SubnetIds []string // The identifier of the VPC endpoint. This property can only be set when - // EndpointType is set to VPC_ENDPOINT. For more information, see + // EndpointType is set to VPC_ENDPOINT . For more information, see // https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. VpcEndpointId *string // The VPC identifier of the VPC in which a server's endpoint will be hosted. This - // property can only be set when EndpointType is set to VPC. + // property can only be set when EndpointType is set to VPC . VpcId *string noSmithyDocumentSerde @@ -859,40 +815,29 @@ type EndpointDetails struct { // execution of the workflow. type ExecutionError struct { - // Specifies the descriptive message that corresponds to the ErrorType. + // Specifies the descriptive message that corresponds to the ErrorType . // // This member is required. Message *string // Specifies the error type. - // - // * ALREADY_EXISTS: occurs for a copy step, if the - // overwrite option is not selected and a file with the same name already exists in - // the target location. - // - // * BAD_REQUEST: a general bad request: for example, a step - // that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be - // tagged. - // - // * CUSTOM_STEP_FAILED: occurs when the custom step provided a callback - // that indicates failure. - // - // * INTERNAL_SERVER_ERROR: a catch-all error that can - // occur for a variety of reasons. - // - // * NOT_FOUND: occurs when a requested entity, - // for example a source file for a copy step, does not exist. - // - // * PERMISSION_DENIED: - // occurs if your policy does not contain the correct permissions to complete one - // or more of the steps in the workflow. - // - // * TIMEOUT: occurs when the execution - // times out. You can set the TimeoutSeconds for a custom step, anywhere from 1 - // second to 1800 seconds (30 minutes). - // - // * THROTTLED: occurs if you exceed the new - // execution refill rate of one workflow per second. + // - ALREADY_EXISTS : occurs for a copy step, if the overwrite option is not + // selected and a file with the same name already exists in the target location. + // - BAD_REQUEST : a general bad request: for example, a step that attempts to + // tag an EFS file returns BAD_REQUEST , as only S3 files can be tagged. + // - CUSTOM_STEP_FAILED : occurs when the custom step provided a callback that + // indicates failure. + // - INTERNAL_SERVER_ERROR : a catch-all error that can occur for a variety of + // reasons. + // - NOT_FOUND : occurs when a requested entity, for example a source file for a + // copy step, does not exist. + // - PERMISSION_DENIED : occurs if your policy does not contain the correct + // permissions to complete one or more of the steps in the workflow. + // - TIMEOUT : occurs when the execution times out. You can set the + // TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 + // minutes). + // - THROTTLED : occurs if you exceed the new execution refill rate of one + // workflow per second. // // This member is required. Type ExecutionErrorType @@ -904,8 +849,8 @@ type ExecutionError struct { // any errors during workflow execution. type ExecutionResults struct { - // Specifies the steps (actions) to take if errors are encountered during execution - // of the workflow. + // Specifies the steps (actions) to take if errors are encountered during + // execution of the workflow. OnExceptionSteps []ExecutionStepResult // Specifies the details for the steps that are in the specified workflow. @@ -923,23 +868,15 @@ type ExecutionStepResult struct { Error *ExecutionError // The values for the key/value pair applied as a tag to the file. Only applicable - // if the step type is TAG. + // if the step type is TAG . Outputs *string // One of the available step types. - // - // * COPY - Copy the file to another location. - // - // * - // CUSTOM - Perform a custom step with an Lambda function target. - // - // * DECRYPT - - // Decrypt a file that was encrypted before it was uploaded. - // - // * DELETE - Delete the - // file. - // - // * TAG - Add a tag to the file. + // - COPY - Copy the file to another location. + // - CUSTOM - Perform a custom step with an Lambda function target. + // - DECRYPT - Decrypt a file that was encrypted before it was uploaded. + // - DELETE - Delete the file. + // - TAG - Add a tag to the file. StepType WorkflowStepType noSmithyDocumentSerde @@ -958,17 +895,17 @@ type FileLocation struct { noSmithyDocumentSerde } -// Represents an object that contains entries and targets for -// HomeDirectoryMappings. The following is an Entry and Target pair example for -// chroot. [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ] +// Represents an object that contains entries and targets for HomeDirectoryMappings +// . The following is an Entry and Target pair example for chroot . [ { "Entry": +// "/", "Target": "/bucket_name/home/mydirectory" } ] type HomeDirectoryMapEntry struct { - // Represents an entry for HomeDirectoryMappings. + // Represents an entry for HomeDirectoryMappings . // // This member is required. Entry *string - // Represents the map target that is used in a HomeDirectorymapEntry. + // Represents the map target that is used in a HomeDirectorymapEntry . // // This member is required. Target *string @@ -1025,13 +962,13 @@ type ListedAccess struct { ExternalId *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType HomeDirectoryType @@ -1071,7 +1008,7 @@ type ListedAgreement struct { // The unique identifier for the agreement. ServerId *string - // The agreement can be either ACTIVE or INACTIVE. + // The agreement can be either ACTIVE or INACTIVE . Status AgreementStatusType noSmithyDocumentSerde @@ -1096,14 +1033,14 @@ type ListedCertificate struct { // An optional date that specifies when the certificate becomes inactive. InactiveDate *time.Time - // The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. + // The certificate can be either ACTIVE , PENDING_ROTATION , or INACTIVE . // PENDING_ROTATION means that this certificate will replace the current // certificate when it expires. Status CertificateStatusType // The type for the certificate. If a private key has been specified for the - // certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private - // key, the type is CERTIFICATE. + // certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY . If there is no private + // key, the type is CERTIFICATE . Type CertificateType // Specifies whether this certificate is used for signing or encryption. @@ -1172,17 +1109,11 @@ type ListedHostKey struct { // The encryption algorithm that is used for the host key. The Type parameter is // specified by using one of the following values: - // - // * ssh-rsa - // - // * ssh-ed25519 - // - // * - // ecdsa-sha2-nistp256 - // - // * ecdsa-sha2-nistp384 - // - // * ecdsa-sha2-nistp521 + // - ssh-rsa + // - ssh-ed25519 + // - ecdsa-sha2-nistp256 + // - ecdsa-sha2-nistp384 + // - ecdsa-sha2-nistp521 Type *string noSmithyDocumentSerde @@ -1194,11 +1125,11 @@ type ListedProfile struct { // The Amazon Resource Name (ARN) of the specified profile. Arn *string - // The As2Id is the AS2-name, as defined in the RFC 4130 - // (https://datatracker.ietf.org/doc/html/rfc4130). For inbound transfers, this is - // the AS2-From header for the AS2 messages sent from the partner. For outbound - // connectors, this is the AS2-To header for the AS2 messages sent to the partner - // using the StartFileTransfer API operation. This ID cannot include spaces. + // The As2Id is the AS2-name, as defined in the RFC 4130 (https://datatracker.ietf.org/doc/html/rfc4130) + // . For inbound transfers, this is the AS2-From header for the AS2 messages sent + // from the partner. For outbound connectors, this is the AS2-To header for the + // AS2 messages sent to the partner using the StartFileTransfer API operation. + // This ID cannot include spaces. As2Id *string // A unique identifier for the local or partner AS2 profile. @@ -1229,7 +1160,7 @@ type ListedServer struct { // public internet. EndpointType EndpointType - // The mode of authentication for a server. The default value is SERVICE_MANAGED, + // The mode of authentication for a server. The default value is SERVICE_MANAGED , // which allows you to store and access user credentials within the Transfer Family // service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups // in Directory Service for Microsoft Active Directory or Microsoft Active @@ -1253,16 +1184,16 @@ type ListedServer struct { // listed. ServerId *string - // The condition of the server that was described. A value of ONLINE indicates that - // the server can accept jobs and transfer files. A State value of OFFLINE means - // that the server cannot perform file transfer operations. The states of STARTING - // and STOPPING indicate that the server is in an intermediate state, either not - // fully able to respond, or not fully offline. The values of START_FAILED or - // STOP_FAILED can indicate an error condition. + // The condition of the server that was described. A value of ONLINE indicates + // that the server can accept jobs and transfer files. A State value of OFFLINE + // means that the server cannot perform file transfer operations. The states of + // STARTING and STOPPING indicate that the server is in an intermediate state, + // either not fully able to respond, or not fully offline. The values of + // START_FAILED or STOP_FAILED can indicate an error condition. State State // Specifies the number of users that are assigned to a server you specified with - // the ServerId. + // the ServerId . UserCount *int32 noSmithyDocumentSerde @@ -1278,13 +1209,13 @@ type ListedUser struct { Arn *string // The landing directory (folder) for a user when they log in to the server using - // the client. A HomeDirectory example is /bucket_name/home/mydirectory. + // the client. A HomeDirectory example is /bucket_name/home/mydirectory . HomeDirectory *string // The type of landing directory (folder) that you want your users' home directory - // to be when they log in to the server. If you set it to PATH, the user will see + // to be when they log in to the server. If you set it to PATH , the user will see // the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol - // clients. If you set it LOGICAL, you need to provide mappings in the + // clients. If you set it LOGICAL , you need to provide mappings in the // HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths // visible to your users. HomeDirectoryType HomeDirectoryType @@ -1296,10 +1227,10 @@ type ListedUser struct { // Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a // trust relationship that allows the server to access your resources when // servicing your users' transfer requests. The IAM role that controls your users' - // access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file - // system for servers with Domain=EFS. The policies attached to this role determine - // the level of access you want to provide your users when transferring files into - // and out of your S3 buckets or EFS file systems. + // access to your Amazon S3 bucket for servers with Domain=S3 , or your EFS file + // system for servers with Domain=EFS . The policies attached to this role + // determine the level of access you want to provide your users when transferring + // files into and out of your S3 buckets or EFS file systems. Role *string // Specifies the number of SSH public keys stored for the user you specified. @@ -1331,8 +1262,8 @@ type ListedWorkflow struct { // Consists of the logging role and the log group name. type LoggingConfiguration struct { - // The name of the CloudWatch logging group for the Transfer Family server to which - // this workflow belongs. + // The name of the CloudWatch logging group for the Transfer Family server to + // which this workflow belongs. LogGroupName *string // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -1343,8 +1274,8 @@ type LoggingConfiguration struct { noSmithyDocumentSerde } -// The full POSIX identity, including user ID (Uid), group ID (Gid), and any -// secondary groups IDs (SecondaryGids), that controls your users' access to your +// The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any +// secondary groups IDs ( SecondaryGids ), that controls your users' access to your // Amazon EFS file systems. The POSIX permissions that are set on files and // directories in your file system determine the level of access your users get // when transferring files into and out of your Amazon EFS file systems. @@ -1373,16 +1304,15 @@ type ProtocolDetails struct { // supported. As2Transports []As2Transport - // Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, - // such as the public IP address of a firewall, router, or load balancer. For - // example: aws transfer update-server --protocol-details PassiveIp=0.0.0.0 Replace - // 0.0.0.0 in the example above with the actual IP address you want to use. If you - // change the PassiveIp value, you must stop and then restart your Transfer Family - // server for the change to take effect. For details on using passive mode (PASV) - // in a NAT environment, see Configuring your FTPS server behind a firewall or NAT - // with Transfer Family - // (http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/). - // Special values The AUTO and 0.0.0.0 are special values for the PassiveIp + // Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 + // address, such as the public IP address of a firewall, router, or load balancer. + // For example: aws transfer update-server --protocol-details PassiveIp=0.0.0.0 + // Replace 0.0.0.0 in the example above with the actual IP address you want to + // use. If you change the PassiveIp value, you must stop and then restart your + // Transfer Family server for the change to take effect. For details on using + // passive mode (PASV) in a NAT environment, see Configuring your FTPS server + // behind a firewall or NAT with Transfer Family (http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/) + // . Special values The AUTO and 0.0.0.0 are special values for the PassiveIp // parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type // servers. In this case, the server automatically responds with one of the // endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique @@ -1390,7 +1320,7 @@ type ProtocolDetails struct { // Network Load Balancer (NLB) environment, where you have 3 subnets, you can only // specify a single IP address using the PassiveIp parameter. This reduces the // effectiveness of having High Availability. In this case, you can specify - // PassiveIp=0.0.0.0. This tells the client to use the same IP address as the + // PassiveIp=0.0.0.0 . This tells the client to use the same IP address as the // Control connection and utilize all AZs for their connections. Note, however, // that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and // WinSCP do support it. If you are using other clients, check to see if your @@ -1404,13 +1334,14 @@ type ProtocolDetails struct { // uploading the file. However, these commands are not compatible with object // storage systems, such as Amazon S3. Due to this incompatibility, file uploads // from these clients can result in errors even when the file is otherwise - // successfully uploaded. Set the value to ENABLE_NO_OP to have the Transfer Family - // server ignore the SETSTAT command, and upload files without needing to make any - // changes to your SFTP client. While the SetStatOptionENABLE_NO_OP setting ignores - // the error, it does generate a log entry in Amazon CloudWatch Logs, so you can - // determine when the client is making a SETSTAT call. If you want to preserve the - // original timestamp for your file, and modify other file attributes using - // SETSTAT, you can use Amazon EFS as backend storage with Transfer Family. + // successfully uploaded. Set the value to ENABLE_NO_OP to have the Transfer + // Family server ignore the SETSTAT command, and upload files without needing to + // make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP + // setting ignores the error, it does generate a log entry in Amazon CloudWatch + // Logs, so you can determine when the client is making a SETSTAT call. If you + // want to preserve the original timestamp for your file, and modify other file + // attributes using SETSTAT , you can use Amazon EFS as backend storage with + // Transfer Family. SetStatOption SetStatOption // A property used with Transfer Family servers that use the FTPS protocol. TLS @@ -1419,25 +1350,20 @@ type ProtocolDetails struct { // TlsSessionResumptionMode determines whether or not the server resumes recent, // negotiated sessions through a unique session ID. This property is available // during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value - // is not specified during CreateServer, it is set to ENFORCED by default. - // - // * - // DISABLED: the server does not process TLS session resumption client requests and - // creates a new TLS session for each request. - // - // * ENABLED: the server processes and - // accepts clients that are performing TLS session resumption. The server doesn't - // reject client data connections that do not perform the TLS session resumption - // client processing. - // - // * ENFORCED: the server processes and accepts clients that - // are performing TLS session resumption. The server rejects client data - // connections that do not perform the TLS session resumption client processing. - // Before you set the value to ENFORCED, test your clients. Not all FTPS clients - // perform TLS session resumption. So, if you choose to enforce TLS session - // resumption, you prevent any connections from FTPS clients that don't perform the - // protocol negotiation. To determine whether or not you can use the ENFORCED - // value, you need to test your clients. + // is not specified during CreateServer , it is set to ENFORCED by default. + // - DISABLED : the server does not process TLS session resumption client + // requests and creates a new TLS session for each request. + // - ENABLED : the server processes and accepts clients that are performing TLS + // session resumption. The server doesn't reject client data connections that do + // not perform the TLS session resumption client processing. + // - ENFORCED : the server processes and accepts clients that are performing TLS + // session resumption. The server rejects client data connections that do not + // perform the TLS session resumption client processing. Before you set the value + // to ENFORCED , test your clients. Not all FTPS clients perform TLS session + // resumption. So, if you choose to enforce TLS session resumption, you prevent any + // connections from FTPS clients that don't perform the protocol negotiation. To + // determine whether or not you can use the ENFORCED value, you need to test your + // clients. TlsSessionResumptionMode TlsSessionResumptionMode noSmithyDocumentSerde @@ -1465,16 +1391,16 @@ type S3FileLocation struct { } // Specifies the customer input Amazon S3 file location. If it is used inside -// copyStepDetails.DestinationFileLocation, it should be the S3 copy destination. +// copyStepDetails.DestinationFileLocation , it should be the S3 copy destination. // You need to provide the bucket and key. The key can represent either a path or a // file. This is determined by whether or not you end the key value with the // forward slash (/) character. If the final character is "/", then your file is // copied to the folder, and its name does not change. If, rather, the final // character is alphanumeric, your uploaded file is renamed to the path value. In // this case, if a file with that name already exists, it is overwritten. For -// example, if your path is shared-files/bob/, your uploaded files are copied to -// the shared-files/bob/, folder. If your path is shared-files/today, each uploaded -// file is copied to the shared-files folder and named today: each upload +// example, if your path is shared-files/bob/ , your uploaded files are copied to +// the shared-files/bob/ , folder. If your path is shared-files/today , each +// uploaded file is copied to the shared-files folder and named today : each upload // overwrites the previous version of the bob file. type S3InputFileLocation struct { @@ -1488,8 +1414,8 @@ type S3InputFileLocation struct { noSmithyDocumentSerde } -// Specifies the key-value pair that are assigned to a file during the execution of -// a Tagging step. +// Specifies the key-value pair that are assigned to a file during the execution +// of a Tagging step. type S3Tag struct { // The name assigned to the tag that you create. @@ -1508,8 +1434,8 @@ type S3Tag struct { // A container object for the session details that are associated with a workflow. type ServiceMetadata struct { - // The Server ID (ServerId), Session ID (SessionId) and user (UserName) make up the - // UserDetails. + // The Server ID ( ServerId ), Session ID ( SessionId ) and user ( UserName ) make + // up the UserDetails . // // This member is required. UserDetails *UserDetails @@ -1519,7 +1445,7 @@ type ServiceMetadata struct { // Provides information about the public Secure Shell (SSH) key that is associated // with a user account for the specific file transfer protocol-enabled server (as -// identified by ServerId). The information returned includes the date the key was +// identified by ServerId ). The information returned includes the date the key was // imported, the public key contents, and the public key ID. A user can store more // than one SSH public key associated with their user name on a specific server. type SshPublicKey struct { @@ -1529,7 +1455,7 @@ type SshPublicKey struct { // This member is required. DateImported *time.Time - // Specifies the content of the SSH public key as specified by the PublicKeyId. + // Specifies the content of the SSH public key as specified by the PublicKeyId . // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // This member is required. @@ -1544,9 +1470,9 @@ type SshPublicKey struct { noSmithyDocumentSerde } -// Creates a key-value pair for a specific resource. Tags are metadata that you can -// use to search for and group a resource for various purposes. You can apply tags -// to servers, users, and roles. A tag key can take more than one value. For +// Creates a key-value pair for a specific resource. Tags are metadata that you +// can use to search for and group a resource for various purposes. You can apply +// tags to servers, users, and roles. A tag key can take more than one value. For // example, to group servers for accounting purposes, you might create a tag called // Group and assign the values Research and Accounting to that group. type Tag struct { @@ -1573,14 +1499,11 @@ type TagStepDetails struct { // Specifies which file to use as input to the workflow step: either the output // from the previous step, or the originally uploaded file for the workflow. - // - // * To - // use the previous file as the input, enter ${previous.file}. In this case, this - // workflow step uses the output file from the previous workflow step as input. - // This is the default value. - // - // * To use the originally uploaded file location as - // input for this step, enter ${original.file}. + // - To use the previous file as the input, enter ${previous.file} . In this + // case, this workflow step uses the output file from the previous workflow step as + // input. This is the default value. + // - To use the originally uploaded file location as input for this step, enter + // ${original.file} . SourceFileLocation *string // Array that contains from 1 to 10 key/value pairs. @@ -1631,8 +1554,8 @@ type WorkflowDetail struct { noSmithyDocumentSerde } -// Container for the WorkflowDetail data type. It is used by actions that trigger a -// workflow to begin execution. +// Container for the WorkflowDetail data type. It is used by actions that trigger +// a workflow to begin execution. type WorkflowDetails struct { // A trigger that starts a workflow if a file is only partially uploaded. You can @@ -1640,8 +1563,8 @@ type WorkflowDetails struct { // A partial upload occurs when a file is open when the session disconnects. OnPartialUpload []WorkflowDetail - // A trigger that starts a workflow: the workflow begins to execute after a file is - // uploaded. To remove an associated workflow from a server, you can provide an + // A trigger that starts a workflow: the workflow begins to execute after a file + // is uploaded. To remove an associated workflow from a server, you can provide an // empty OnUpload object, as in the following example. aws transfer update-server // --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}' OnUpload []WorkflowDetail @@ -1652,16 +1575,11 @@ type WorkflowDetails struct { // The basic building block of a workflow. type WorkflowStep struct { - // Details for a step that performs a file copy. Consists of the following - // values: - // - // * A description - // - // * An Amazon S3 location for the destination of the - // file copy. - // - // * A flag that indicates whether to overwrite an existing file of the - // same name. The default is FALSE. + // Details for a step that performs a file copy. Consists of the following values: + // - A description + // - An Amazon S3 location for the destination of the file copy. + // - A flag that indicates whether to overwrite an existing file of the same + // name. The default is FALSE . CopyStepDetails *CopyStepDetails // Details for a step that invokes an Lambda function. Consists of the Lambda @@ -1670,20 +1588,14 @@ type WorkflowStep struct { // Details for a step that decrypts an encrypted file. Consists of the following // values: - // - // * A descriptive name - // - // * An Amazon S3 or Amazon Elastic File System - // (Amazon EFS) location for the source file to decrypt. - // - // * An S3 or Amazon EFS - // location for the destination of the file decryption. - // - // * A flag that indicates - // whether to overwrite an existing file of the same name. The default is FALSE. - // - // * - // The type of encryption that's used. Currently, only PGP encryption is supported. + // - A descriptive name + // - An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the + // source file to decrypt. + // - An S3 or Amazon EFS location for the destination of the file decryption. + // - A flag that indicates whether to overwrite an existing file of the same + // name. The default is FALSE . + // - The type of encryption that's used. Currently, only PGP encryption is + // supported. DecryptStepDetails *DecryptStepDetails // Details for a step that deletes the file. @@ -1694,19 +1606,11 @@ type WorkflowStep struct { TagStepDetails *TagStepDetails // Currently, the following step types are supported. - // - // * COPY - Copy the file to - // another location. - // - // * CUSTOM - Perform a custom step with an Lambda function - // target. - // - // * DECRYPT - Decrypt a file that was encrypted before it was - // uploaded. - // - // * DELETE - Delete the file. - // - // * TAG - Add a tag to the file. + // - COPY - Copy the file to another location. + // - CUSTOM - Perform a custom step with an Lambda function target. + // - DECRYPT - Decrypt a file that was encrypted before it was uploaded. + // - DELETE - Delete the file. + // - TAG - Add a tag to the file. Type WorkflowStepType noSmithyDocumentSerde diff --git a/service/translate/api_client.go b/service/translate/api_client.go index 517d3eac4ea..54f1fbdb657 100644 --- a/service/translate/api_client.go +++ b/service/translate/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/translate/api_op_CreateParallelData.go b/service/translate/api_op_CreateParallelData.go index e9572cdfacb..52903d83246 100644 --- a/service/translate/api_op_CreateParallelData.go +++ b/service/translate/api_op_CreateParallelData.go @@ -58,8 +58,8 @@ type CreateParallelDataInput struct { // Tags to be associated with this resource. A tag is a key-value pair that adds // metadata to a resource. Each tag key for the resource must be unique. For more - // information, see Tagging your resources - // (https://docs.aws.amazon.com/translate/latest/dg/tagging.html). + // information, see Tagging your resources (https://docs.aws.amazon.com/translate/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde @@ -71,7 +71,7 @@ type CreateParallelDataOutput struct { Name *string // The status of the parallel data resource. When the resource is ready for you to - // use, the status is ACTIVE. + // use, the status is ACTIVE . Status types.ParallelDataStatus // Metadata pertaining to the operation's result. diff --git a/service/translate/api_op_GetTerminology.go b/service/translate/api_op_GetTerminology.go index e97e64de763..1e714b2113d 100644 --- a/service/translate/api_op_GetTerminology.go +++ b/service/translate/api_op_GetTerminology.go @@ -53,8 +53,8 @@ type GetTerminologyOutput struct { // presigned URL to that has a 30-minute expiration. AuxiliaryDataLocation *types.TerminologyDataLocation - // The Amazon S3 location of the most recent custom terminology input file that was - // successfully imported into Amazon Translate. The location is returned as a + // The Amazon S3 location of the most recent custom terminology input file that + // was successfully imported into Amazon Translate. The location is returned as a // presigned URL that has a 30-minute expiration. Amazon Translate doesn't scan all // input files for the risk of CSV injection attacks. CSV injection occurs when a // .csv or .tsv file is altered so that a record contains malicious code. The diff --git a/service/translate/api_op_ImportTerminology.go b/service/translate/api_op_ImportTerminology.go index 03f04ad89b6..bc58457694b 100644 --- a/service/translate/api_op_ImportTerminology.go +++ b/service/translate/api_op_ImportTerminology.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates a custom terminology, depending on whether one already exists -// for the given terminology name. Importing a terminology with the same name as an -// existing one will merge the terminologies based on the chosen merge strategy. -// The only supported merge strategy is OVERWRITE, where the imported terminology -// overwrites the existing terminology of the same name. If you import a -// terminology that overwrites an existing one, the new terminology takes up to 10 -// minutes to fully propagate. After that, translations have access to the new +// Creates or updates a custom terminology, depending on whether one already +// exists for the given terminology name. Importing a terminology with the same +// name as an existing one will merge the terminologies based on the chosen merge +// strategy. The only supported merge strategy is OVERWRITE, where the imported +// terminology overwrites the existing terminology of the same name. If you import +// a terminology that overwrites an existing one, the new terminology takes up to +// 10 minutes to fully propagate. After that, translations have access to the new // terminology. func (c *Client) ImportTerminology(ctx context.Context, params *ImportTerminologyInput, optFns ...func(*Options)) (*ImportTerminologyOutput, error) { if params == nil { @@ -36,9 +36,9 @@ func (c *Client) ImportTerminology(ctx context.Context, params *ImportTerminolog type ImportTerminologyInput struct { - // The merge strategy of the custom terminology being imported. Currently, only the - // OVERWRITE merge strategy is supported. In this case, the imported terminology - // will overwrite an existing terminology of the same name. + // The merge strategy of the custom terminology being imported. Currently, only + // the OVERWRITE merge strategy is supported. In this case, the imported + // terminology will overwrite an existing terminology of the same name. // // This member is required. MergeStrategy types.MergeStrategy @@ -61,8 +61,8 @@ type ImportTerminologyInput struct { // Tags to be associated with this resource. A tag is a key-value pair that adds // metadata to a resource. Each tag key for the resource must be unique. For more - // information, see Tagging your resources - // (https://docs.aws.amazon.com/translate/latest/dg/tagging.html). + // information, see Tagging your resources (https://docs.aws.amazon.com/translate/latest/dg/tagging.html) + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/translate/api_op_ListLanguages.go b/service/translate/api_op_ListLanguages.go index 29ec532d0dc..0de5a623eaf 100644 --- a/service/translate/api_op_ListLanguages.go +++ b/service/translate/api_op_ListLanguages.go @@ -52,8 +52,8 @@ type ListLanguagesOutput struct { // The list of supported languages. Languages []types.Language - // If the response does not include all remaining results, use the NextToken in the - // next request to fetch the next group of supported languages. + // If the response does not include all remaining results, use the NextToken in + // the next request to fetch the next group of supported languages. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/translate/api_op_ListTagsForResource.go b/service/translate/api_op_ListTagsForResource.go index baf45b0932c..5fad23bc519 100644 --- a/service/translate/api_op_ListTagsForResource.go +++ b/service/translate/api_op_ListTagsForResource.go @@ -12,8 +12,8 @@ import ( ) // Lists all tags associated with a given Amazon Translate resource. For more -// information, see Tagging your resources -// (https://docs.aws.amazon.com/translate/latest/dg/tagging.html). +// information, see Tagging your resources (https://docs.aws.amazon.com/translate/latest/dg/tagging.html) +// . func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/translate/api_op_StartTextTranslationJob.go b/service/translate/api_op_StartTextTranslationJob.go index 1c4cc2086cd..26a3dc93bb1 100644 --- a/service/translate/api_op_StartTextTranslationJob.go +++ b/service/translate/api_op_StartTextTranslationJob.go @@ -17,11 +17,10 @@ import ( // translation, you can input documents with different source languages (specify // auto as the source language). You can specify one or more target languages. // Batch translation translates each input document into each of the target -// languages. For more information, see Asynchronous batch processing -// (https://docs.aws.amazon.com/translate/latest/dg/async.html). Batch translation -// jobs can be described with the DescribeTextTranslationJob operation, listed with -// the ListTextTranslationJobs operation, and stopped with the -// StopTextTranslationJob operation. +// languages. For more information, see Asynchronous batch processing (https://docs.aws.amazon.com/translate/latest/dg/async.html) +// . Batch translation jobs can be described with the DescribeTextTranslationJob +// operation, listed with the ListTextTranslationJobs operation, and stopped with +// the StopTextTranslationJob operation. func (c *Client) StartTextTranslationJob(ctx context.Context, params *StartTextTranslationJobInput, optFns ...func(*Options)) (*StartTextTranslationJobOutput, error) { if params == nil { params = &StartTextTranslationJobInput{} @@ -47,8 +46,8 @@ type StartTextTranslationJobInput struct { // The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) // role that grants Amazon Translate read access to your input data. For more - // information, see Identity and access management - // (https://docs.aws.amazon.com/translate/latest/dg/identity-and-access-management.html). + // information, see Identity and access management (https://docs.aws.amazon.com/translate/latest/dg/identity-and-access-management.html) + // . // // This member is required. DataAccessRoleArn *string @@ -66,18 +65,18 @@ type StartTextTranslationJobInput struct { // The language code of the input language. Specify the language if all input // documents share the same language. If you don't know the language of the source - // files, or your input documents contains different source languages, select auto. - // Amazon Translate auto detects the source language for each input document. For a - // list of supported language codes, see Supported languages - // (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html). + // files, or your input documents contains different source languages, select auto + // . Amazon Translate auto detects the source language for each input document. For + // a list of supported language codes, see Supported languages (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) + // . // // This member is required. SourceLanguageCode *string - // The target languages of the translation job. Enter up to 10 language codes. Each - // input file is translated into each target language. Each language code is 2 or 5 - // characters long. For a list of language codes, see Supported languages - // (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html). + // The target languages of the translation job. Enter up to 10 language codes. + // Each input file is translated into each target language. Each language code is 2 + // or 5 characters long. For a list of language codes, see Supported languages (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) + // . // // This member is required. TargetLanguageCodes []string @@ -92,11 +91,11 @@ type StartTextTranslationJobInput struct { // parallel data to a translation job, you create an Active Custom Translation job. // This parameter accepts only one parallel data resource. Active Custom // Translation jobs are priced at a higher rate than other jobs that don't use - // parallel data. For more information, see Amazon Translate pricing - // (http://aws.amazon.com/translate/pricing/). For a list of available parallel - // data resources, use the ListParallelData operation. For more information, see - // Customizing your translations with parallel data - // (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-parallel-data.html). + // parallel data. For more information, see Amazon Translate pricing (http://aws.amazon.com/translate/pricing/) + // . For a list of available parallel data resources, use the ListParallelData + // operation. For more information, see Customizing your translations with + // parallel data (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-parallel-data.html) + // . ParallelDataNames []string // Settings to configure your translation output, including the option to set the @@ -110,8 +109,8 @@ type StartTextTranslationJobInput struct { // multiple target languages for the job, translate uses the designated terminology // for each requested target language that has an entry for the source term in the // terminology file. For a list of available custom terminology resources, use the - // ListTerminologies operation. For more information, see Custom terminology - // (https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html). + // ListTerminologies operation. For more information, see Custom terminology (https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html) + // . TerminologyNames []string noSmithyDocumentSerde @@ -124,27 +123,16 @@ type StartTextTranslationJobOutput struct { JobId *string // The status of the job. Possible values include: - // - // * SUBMITTED - The job has been - // received and is queued for processing. - // - // * IN_PROGRESS - Amazon Translate is - // processing the job. - // - // * COMPLETED - The job was successfully completed and the - // output is available. - // - // * COMPLETED_WITH_ERROR - The job was completed with - // errors. The errors can be analyzed in the job's output. - // - // * FAILED - The job did - // not complete. To get details, use the DescribeTextTranslationJob operation. - // - // * - // STOP_REQUESTED - The user who started the job has requested that it be - // stopped. - // - // * STOPPED - The job has been stopped. + // - SUBMITTED - The job has been received and is queued for processing. + // - IN_PROGRESS - Amazon Translate is processing the job. + // - COMPLETED - The job was successfully completed and the output is available. + // - COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be + // analyzed in the job's output. + // - FAILED - The job did not complete. To get details, use the + // DescribeTextTranslationJob operation. + // - STOP_REQUESTED - The user who started the job has requested that it be + // stopped. + // - STOPPED - The job has been stopped. JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/translate/api_op_StopTextTranslationJob.go b/service/translate/api_op_StopTextTranslationJob.go index dbace2a22fe..4de5a94bdc5 100644 --- a/service/translate/api_op_StopTextTranslationJob.go +++ b/service/translate/api_op_StopTextTranslationJob.go @@ -12,12 +12,12 @@ import ( ) // Stops an asynchronous batch translation job that is in progress. If the job's -// state is IN_PROGRESS, the job will be marked for termination and put into the +// state is IN_PROGRESS , the job will be marked for termination and put into the // STOP_REQUESTED state. If the job completes before it can be stopped, it is put // into the COMPLETED state. Otherwise, the job is put into the STOPPED state. // Asynchronous batch translation jobs are started with the StartTextTranslationJob // operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs -// operations to get a batch translation job's JobId. +// operations to get a batch translation job's JobId . func (c *Client) StopTextTranslationJob(ctx context.Context, params *StopTextTranslationJobInput, optFns ...func(*Options)) (*StopTextTranslationJobOutput, error) { if params == nil { params = &StopTextTranslationJobInput{} @@ -49,7 +49,7 @@ type StopTextTranslationJobOutput struct { JobId *string // The status of the designated job. Upon successful completion, the job's status - // will be STOPPED. + // will be STOPPED . JobStatus types.JobStatus // Metadata pertaining to the operation's result. diff --git a/service/translate/api_op_TagResource.go b/service/translate/api_op_TagResource.go index e8386b5bb14..2e70ebda3df 100644 --- a/service/translate/api_op_TagResource.go +++ b/service/translate/api_op_TagResource.go @@ -12,8 +12,8 @@ import ( ) // Associates a specific tag with a resource. A tag is a key-value pair that adds -// as a metadata to a resource. For more information, see Tagging your resources -// (https://docs.aws.amazon.com/translate/latest/dg/tagging.html). +// as a metadata to a resource. For more information, see Tagging your resources (https://docs.aws.amazon.com/translate/latest/dg/tagging.html) +// . func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/translate/api_op_TranslateText.go b/service/translate/api_op_TranslateText.go index 682db2f6d50..6d4fc803e1c 100644 --- a/service/translate/api_op_TranslateText.go +++ b/service/translate/api_op_TranslateText.go @@ -12,8 +12,8 @@ import ( ) // Translates input text from the source language to the target language. For a -// list of available languages and language codes, see Supported languages -// (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html). +// list of available languages and language codes, see Supported languages (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) +// . func (c *Client) TranslateText(ctx context.Context, params *TranslateTextInput, optFns ...func(*Options)) (*TranslateTextOutput, error) { if params == nil { params = &TranslateTextInput{} @@ -33,13 +33,11 @@ type TranslateTextInput struct { // The language code for the language of the source text. The language must be a // language supported by Amazon Translate. For a list of language codes, see - // Supported languages - // (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html). To - // have Amazon Translate determine the source language of your text, you can - // specify auto in the SourceLanguageCode field. If you specify auto, Amazon - // Translate will call Amazon Comprehend - // (https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html) to - // determine the source language. If you specify auto, you must send the + // Supported languages (https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) + // . To have Amazon Translate determine the source language of your text, you can + // specify auto in the SourceLanguageCode field. If you specify auto , Amazon + // Translate will call Amazon Comprehend (https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html) + // to determine the source language. If you specify auto , you must send the // TranslateText request in a region that supports Amazon Comprehend. Otherwise, // the request returns an error indicating that autodetect is not supported. // diff --git a/service/translate/api_op_UntagResource.go b/service/translate/api_op_UntagResource.go index 6d2a71d326a..a9326b956fb 100644 --- a/service/translate/api_op_UntagResource.go +++ b/service/translate/api_op_UntagResource.go @@ -11,8 +11,8 @@ import ( ) // Removes a specific tag associated with an Amazon Translate resource. For more -// information, see Tagging your resources -// (https://docs.aws.amazon.com/translate/latest/dg/tagging.html). +// information, see Tagging your resources (https://docs.aws.amazon.com/translate/latest/dg/tagging.html) +// . func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -30,14 +30,14 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the given Amazon Translate resource from which - // you want to remove the tags. + // The Amazon Resource Name (ARN) of the given Amazon Translate resource from + // which you want to remove the tags. // // This member is required. ResourceArn *string - // The initial part of a key-value pair that forms a tag being removed from a given - // resource. Keys must be unique and cannot be duplicated for a particular + // The initial part of a key-value pair that forms a tag being removed from a + // given resource. Keys must be unique and cannot be duplicated for a particular // resource. // // This member is required. diff --git a/service/translate/api_op_UpdateParallelData.go b/service/translate/api_op_UpdateParallelData.go index 7c5be8c7380..a15003c1e34 100644 --- a/service/translate/api_op_UpdateParallelData.go +++ b/service/translate/api_op_UpdateParallelData.go @@ -60,14 +60,14 @@ type UpdateParallelDataOutput struct { LatestUpdateAttemptAt *time.Time // The status of the parallel data update attempt. When the updated parallel data - // resource is ready for you to use, the status is ACTIVE. + // resource is ready for you to use, the status is ACTIVE . LatestUpdateAttemptStatus types.ParallelDataStatus // The name of the parallel data resource being updated. Name *string - // The status of the parallel data resource that you are attempting to update. Your - // update request is accepted only if this status is either ACTIVE or FAILED. + // The status of the parallel data resource that you are attempting to update. + // Your update request is accepted only if this status is either ACTIVE or FAILED . Status types.ParallelDataStatus // Metadata pertaining to the operation's result. diff --git a/service/translate/doc.go b/service/translate/doc.go index 43343a0d113..39abba6f982 100644 --- a/service/translate/doc.go +++ b/service/translate/doc.go @@ -3,6 +3,6 @@ // Package translate provides the API client, operations, and parameter types for // Amazon Translate. // -// Provides translation of the input content from the source language to the target -// language. +// Provides translation of the input content from the source language to the +// target language. package translate diff --git a/service/translate/types/enums.go b/service/translate/types/enums.go index a255d4084f9..0bd7def3b27 100644 --- a/service/translate/types/enums.go +++ b/service/translate/types/enums.go @@ -78,9 +78,9 @@ const ( FormalityInformal Formality = "INFORMAL" ) -// Values returns all known values for Formality. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Formality. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Formality) Values() []Formality { return []Formality{ "FORMAL", @@ -101,9 +101,9 @@ const ( JobStatusStopped JobStatus = "STOPPED" ) -// Values returns all known values for JobStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for JobStatus. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (JobStatus) Values() []JobStatus { return []JobStatus{ "SUBMITTED", @@ -183,9 +183,9 @@ const ( ProfanityMask Profanity = "MASK" ) -// Values returns all known values for Profanity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for Profanity. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (Profanity) Values() []Profanity { return []Profanity{ "MASK", @@ -201,8 +201,8 @@ const ( TerminologyDataFormatTsv TerminologyDataFormat = "TSV" ) -// Values returns all known values for TerminologyDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for TerminologyDataFormat. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (TerminologyDataFormat) Values() []TerminologyDataFormat { return []TerminologyDataFormat{ diff --git a/service/translate/types/errors.go b/service/translate/types/errors.go index 7816966c16c..febc4bef044 100644 --- a/service/translate/types/errors.go +++ b/service/translate/types/errors.go @@ -60,11 +60,10 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The confidence that Amazon Comprehend accurately detected the source language is -// low. If a low confidence level is acceptable for your application, you can use -// the language in the exception to call Amazon Translate again. For more -// information, see the DetectDominantLanguage -// (https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html) +// The confidence that Amazon Comprehend accurately detected the source language +// is low. If a low confidence level is acceptable for your application, you can +// use the language in the exception to call Amazon Translate again. For more +// information, see the DetectDominantLanguage (https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html) // operation in the Amazon Comprehend Developer Guide. type DetectedLanguageLowConfidenceException struct { Message *string @@ -174,8 +173,8 @@ func (e *InvalidParameterValueException) ErrorCode() string { } func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request that you made is not valid. Check your request to determine why it's -// not valid and then retry the request. +// The request that you made is not valid. Check your request to determine why +// it's not valid and then retry the request. type InvalidRequestException struct { Message *string @@ -397,8 +396,8 @@ func (e *UnsupportedDisplayLanguageCodeException) ErrorFault() smithy.ErrorFault // Amazon Translate does not support translation from the language of the source // text into the requested target language. For more information, see Error -// messages -// (https://docs.aws.amazon.com/translate/latest/dg/how-to-error-msg.html). +// messages (https://docs.aws.amazon.com/translate/latest/dg/how-to-error-msg.html) +// . type UnsupportedLanguagePairException struct { Message *string diff --git a/service/translate/types/types.go b/service/translate/types/types.go index a548dddb6ae..a9e683ad80f 100644 --- a/service/translate/types/types.go +++ b/service/translate/types/types.go @@ -13,13 +13,13 @@ import ( // terminology can be applied per TranslateText request. type AppliedTerminology struct { - // The name of the custom terminology applied to the input text by Amazon Translate - // for the translated text response. + // The name of the custom terminology applied to the input text by Amazon + // Translate for the translated text response. Name *string - // The specific terms of the custom terminology applied to the input text by Amazon - // Translate for the translated text response. A maximum of 250 terms will be - // returned, and the specific terms applied will be the first 250 terms in the + // The specific terms of the custom terminology applied to the input text by + // Amazon Translate for the translated text response. A maximum of 250 terms will + // be returned, and the specific terms applied will be the first 250 terms in the // source text. Terms []Term @@ -49,36 +49,24 @@ type InputDataConfig struct { // Describes the format of the data that you submit to Amazon Translate as input. // You can specify one of the following multipurpose internet mail extension (MIME) // types: - // - // * text/html: The input data consists of one or more HTML files. Amazon - // Translate translates only the text that resides in the html element in each - // file. - // - // * text/plain: The input data consists of one or more unformatted text - // files. Amazon Translate translates every character in this type of input. - // - // * - // application/vnd.openxmlformats-officedocument.wordprocessingml.document: The - // input data consists of one or more Word documents (.docx). - // - // * - // application/vnd.openxmlformats-officedocument.presentationml.presentation: The - // input data consists of one or more PowerPoint Presentation files (.pptx). - // - // * - // application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input - // data consists of one or more Excel Workbook files (.xlsx). - // - // * - // application/x-xliff+xml: The input data consists of one or more XML Localization - // Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only - // XLIFF version 1.2. - // - // If you structure your input data as HTML, ensure that you - // set this parameter to text/html. By doing so, you cut costs by limiting the - // translation to the contents of the html element in each file. Otherwise, if you - // set this parameter to text/plain, your costs will cover the translation of every - // character. + // - text/html : The input data consists of one or more HTML files. Amazon + // Translate translates only the text that resides in the html element in each + // file. + // - text/plain : The input data consists of one or more unformatted text files. + // Amazon Translate translates every character in this type of input. + // - application/vnd.openxmlformats-officedocument.wordprocessingml.document : + // The input data consists of one or more Word documents (.docx). + // - application/vnd.openxmlformats-officedocument.presentationml.presentation : + // The input data consists of one or more PowerPoint Presentation files (.pptx). + // - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The + // input data consists of one or more Excel Workbook files (.xlsx). + // - application/x-xliff+xml : The input data consists of one or more XML + // Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate + // supports only XLIFF version 1.2. + // If you structure your input data as HTML, ensure that you set this parameter to + // text/html . By doing so, you cut costs by limiting the translation to the + // contents of the html element in each file. Otherwise, if you set this parameter + // to text/plain , your costs will cover the translation of every character. // // This member is required. ContentType *string @@ -161,14 +149,14 @@ type ParallelDataConfig struct { // imported into Amazon Translate. type ParallelDataDataLocation struct { - // The Amazon S3 location of the parallel data input file. The location is returned - // as a presigned URL to that has a 30-minute expiration. Amazon Translate doesn't - // scan all input files for the risk of CSV injection attacks. CSV injection occurs - // when a .csv or .tsv file is altered so that a record contains malicious code. - // The record begins with a special character, such as =, +, -, or @. When the file - // is opened in a spreadsheet program, the program might interpret the record as a - // formula and run the code within it. Before you download an input file from - // Amazon S3, ensure that you recognize the file and trust its creator. + // The Amazon S3 location of the parallel data input file. The location is + // returned as a presigned URL to that has a 30-minute expiration. Amazon Translate + // doesn't scan all input files for the risk of CSV injection attacks. CSV + // injection occurs when a .csv or .tsv file is altered so that a record contains + // malicious code. The record begins with a special character, such as =, +, -, or + // @. When the file is opened in a spreadsheet program, the program might interpret + // the record as a formula and run the code within it. Before you download an input + // file from Amazon S3, ensure that you recognize the file and trust its creator. // // This member is required. Location *string @@ -236,11 +224,11 @@ type ParallelDataProperties struct { SourceLanguageCode *string // The status of the parallel data resource. When the parallel data is ready for - // you to use, the status is ACTIVE. + // you to use, the status is ACTIVE . Status ParallelDataStatus - // The language codes for the target languages available in the parallel data file. - // All possible target languages are returned as an array. + // The language codes for the target languages available in the parallel data + // file. All possible target languages are returned as an array. TargetLanguageCodes []string noSmithyDocumentSerde @@ -277,8 +265,8 @@ type Term struct { } // The data associated with the custom terminology. For information about the -// custom terminology file, see Creating a Custom Terminology -// (https://docs.aws.amazon.com/translate/latest/dg/creating-custom-terminology.html). +// custom terminology file, see Creating a Custom Terminology (https://docs.aws.amazon.com/translate/latest/dg/creating-custom-terminology.html) +// . type TerminologyData struct { // The file containing the custom terminology data. Your version of the AWS SDK @@ -312,8 +300,8 @@ type TerminologyData struct { // The location of the custom terminology data. type TerminologyDataLocation struct { - // The Amazon S3 location of the most recent custom terminology input file that was - // successfully imported into Amazon Translate. The location is returned as a + // The Amazon S3 location of the most recent custom terminology input file that + // was successfully imported into Amazon Translate. The location is returned as a // presigned URL that has a 30-minute expiration . Amazon Translate doesn't scan // all input files for the risk of CSV injection attacks. CSV injection occurs when // a .csv or .tsv file is altered so that a record contains malicious code. The @@ -390,7 +378,7 @@ type TerminologyProperties struct { } // Provides information for filtering a list of translation jobs. For more -// information, see ListTextTranslationJobs. +// information, see ListTextTranslationJobs . type TextTranslationJobFilter struct { // Filters the list of jobs by name. @@ -478,26 +466,23 @@ type TranslationSettings struct { // You can optionally specify the desired level of formality for translations to // supported target languages. The formality setting controls the level of formal - // language usage (also known as register - // (https://en.wikipedia.org/wiki/Register_(sociolinguistics))) in the translation - // output. You can set the value to informal or formal. If you don't specify a - // value for formality, or if the target language doesn't support formality, the - // translation will ignore the formality setting. If you specify multiple target - // languages for the job, translate ignores the formality setting for any - // unsupported target language. For a list of target languages that support - // formality, see Supported languages - // (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html#customizing-translations-formality-languages) + // language usage (also known as register (https://en.wikipedia.org/wiki/Register_(sociolinguistics)) + // ) in the translation output. You can set the value to informal or formal. If you + // don't specify a value for formality, or if the target language doesn't support + // formality, the translation will ignore the formality setting. If you specify + // multiple target languages for the job, translate ignores the formality setting + // for any unsupported target language. For a list of target languages that support + // formality, see Supported languages (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html#customizing-translations-formality-languages) // in the Amazon Translate Developer Guide. Formality Formality // Enable the profanity setting if you want Amazon Translate to mask profane words // and phrases in your translation output. To mask profane words and phrases, - // Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character - // sequence is used for each profane word or phrase, regardless of the length or - // number of words. Amazon Translate doesn't detect profanity in all of its - // supported languages. For languages that don't support profanity detection, see - // Unsupported languages - // (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-profanity.html#customizing-translations-profanity-languages) + // Amazon Translate replaces them with the grawlix string “?$#@$“. This + // 5-character sequence is used for each profane word or phrase, regardless of the + // length or number of words. Amazon Translate doesn't detect profanity in all of + // its supported languages. For languages that don't support profanity detection, + // see Unsupported languages (https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-profanity.html#customizing-translations-profanity-languages) // in the Amazon Translate Developer Guide. If you specify multiple target // languages for the job, all the target languages must support profanity masking. // If any of the target languages don't support profanity masking, the translation diff --git a/service/voiceid/api_client.go b/service/voiceid/api_client.go index 909fafbc7cd..d1f5e78b4b5 100644 --- a/service/voiceid/api_client.go +++ b/service/voiceid/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/voiceid/api_op_CreateDomain.go b/service/voiceid/api_op_CreateDomain.go index 90d204cccb5..84394285a28 100644 --- a/service/voiceid/api_op_CreateDomain.go +++ b/service/voiceid/api_op_CreateDomain.go @@ -37,10 +37,9 @@ type CreateDomainInput struct { // This member is required. Name *string - // The configuration, containing the KMS key identifier, to be used by Voice ID for - // the server-side encryption of your data. Refer to Amazon Connect Voice ID - // encryption at rest - // (https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid) + // The configuration, containing the KMS key identifier, to be used by Voice ID + // for the server-side encryption of your data. Refer to Amazon Connect Voice ID + // encryption at rest (https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid) // for more details on how the KMS key is used. // // This member is required. @@ -49,8 +48,8 @@ type CreateDomainInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A brief description of this domain. diff --git a/service/voiceid/api_op_CreateWatchlist.go b/service/voiceid/api_op_CreateWatchlist.go index 9366115a5c8..c293bb9ed4d 100644 --- a/service/voiceid/api_op_CreateWatchlist.go +++ b/service/voiceid/api_op_CreateWatchlist.go @@ -43,8 +43,8 @@ type CreateWatchlistInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A brief description of this watchlist. diff --git a/service/voiceid/api_op_DeleteWatchlist.go b/service/voiceid/api_op_DeleteWatchlist.go index 7e6a10f5c7c..d0db01d9b76 100644 --- a/service/voiceid/api_op_DeleteWatchlist.go +++ b/service/voiceid/api_op_DeleteWatchlist.go @@ -10,10 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified watchlist from Voice ID. This API throws an exception when -// there are fraudsters in the watchlist that you are trying to delete. You must -// delete the fraudsters, and then delete the watchlist. Every domain has a default -// watchlist which cannot be deleted. +// Deletes the specified watchlist from Voice ID. This API throws an exception +// when there are fraudsters in the watchlist that you are trying to delete. You +// must delete the fraudsters, and then delete the watchlist. Every domain has a +// default watchlist which cannot be deleted. func (c *Client) DeleteWatchlist(ctx context.Context, params *DeleteWatchlistInput, optFns ...func(*Options)) (*DeleteWatchlistOutput, error) { if params == nil { params = &DeleteWatchlistInput{} diff --git a/service/voiceid/api_op_EvaluateSession.go b/service/voiceid/api_op_EvaluateSession.go index 25fb689da86..f8f8d0cb34b 100644 --- a/service/voiceid/api_op_EvaluateSession.go +++ b/service/voiceid/api_op_EvaluateSession.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Evaluates a specified session based on audio data accumulated during a streaming -// Amazon Connect Voice ID call. +// Evaluates a specified session based on audio data accumulated during a +// streaming Amazon Connect Voice ID call. func (c *Client) EvaluateSession(ctx context.Context, params *EvaluateSessionInput, optFns ...func(*Options)) (*EvaluateSessionOutput, error) { if params == nil { params = &EvaluateSessionInput{} @@ -65,11 +65,11 @@ type EvaluateSessionOutput struct { // The current status of audio streaming for this session. This field is useful to // infer next steps when the Authentication or Fraud Detection results are empty or - // the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is - // ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API - // again later, after Voice ID has enough audio to produce a result. If the - // decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means - // that the previously streamed session did not have enough speech to perform + // the decision is NOT_ENOUGH_SPEECH . In this situation, if the StreamingStatus + // is ONGOING/PENDING_CONFIGURATION , it can mean that the client should call the + // API again later, after Voice ID has enough audio to produce a result. If the + // decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED , it + // means that the previously streamed session did not have enough speech to perform // evaluation, and a new streaming session is needed to try again. StreamingStatus types.StreamingStatus diff --git a/service/voiceid/api_op_ListFraudsterRegistrationJobs.go b/service/voiceid/api_op_ListFraudsterRegistrationJobs.go index 9b28284a9db..ea850e1379d 100644 --- a/service/voiceid/api_op_ListFraudsterRegistrationJobs.go +++ b/service/voiceid/api_op_ListFraudsterRegistrationJobs.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the fraudster registration jobs in the domain with the given -// JobStatus. If JobStatus is not provided, this lists all fraudster registration -// jobs in the given domain. +// Lists all the fraudster registration jobs in the domain with the given JobStatus +// . If JobStatus is not provided, this lists all fraudster registration jobs in +// the given domain. func (c *Client) ListFraudsterRegistrationJobs(ctx context.Context, params *ListFraudsterRegistrationJobsInput, optFns ...func(*Options)) (*ListFraudsterRegistrationJobsOutput, error) { if params == nil { params = &ListFraudsterRegistrationJobsInput{} diff --git a/service/voiceid/api_op_ListSpeakerEnrollmentJobs.go b/service/voiceid/api_op_ListSpeakerEnrollmentJobs.go index 06d7f3ccd7a..072a3ba6c1c 100644 --- a/service/voiceid/api_op_ListSpeakerEnrollmentJobs.go +++ b/service/voiceid/api_op_ListSpeakerEnrollmentJobs.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the speaker enrollment jobs in the domain with the specified -// JobStatus. If JobStatus is not provided, this lists all jobs with all possible -// speaker enrollment job statuses. +// Lists all the speaker enrollment jobs in the domain with the specified JobStatus +// . If JobStatus is not provided, this lists all jobs with all possible speaker +// enrollment job statuses. func (c *Client) ListSpeakerEnrollmentJobs(ctx context.Context, params *ListSpeakerEnrollmentJobsInput, optFns ...func(*Options)) (*ListSpeakerEnrollmentJobsOutput, error) { if params == nil { params = &ListSpeakerEnrollmentJobsInput{} diff --git a/service/voiceid/api_op_StartFraudsterRegistrationJob.go b/service/voiceid/api_op_StartFraudsterRegistrationJob.go index 858591bda4c..8aae7ce4043 100644 --- a/service/voiceid/api_op_StartFraudsterRegistrationJob.go +++ b/service/voiceid/api_op_StartFraudsterRegistrationJob.go @@ -32,15 +32,14 @@ type StartFraudsterRegistrationJobInput struct { // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to // access customer's buckets to read the input manifest file and write the Job - // output file. Refer to the Create and edit a fraudster watchlist - // (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html) + // output file. Refer to the Create and edit a fraudster watchlist (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html) // documentation for the permissions needed in this role. // // This member is required. DataAccessRoleArn *string - // The identifier of the domain that contains the fraudster registration job and in - // which the fraudsters are registered. + // The identifier of the domain that contains the fraudster registration job and + // in which the fraudsters are registered. // // This member is required. DomainId *string @@ -60,8 +59,8 @@ type StartFraudsterRegistrationJobInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The name of the new fraudster registration job. diff --git a/service/voiceid/api_op_StartSpeakerEnrollmentJob.go b/service/voiceid/api_op_StartSpeakerEnrollmentJob.go index a1e4129fa5b..8d97c407fc1 100644 --- a/service/voiceid/api_op_StartSpeakerEnrollmentJob.go +++ b/service/voiceid/api_op_StartSpeakerEnrollmentJob.go @@ -32,8 +32,7 @@ type StartSpeakerEnrollmentJobInput struct { // The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to // access customer's buckets to read the input manifest file and write the job - // output file. Refer to Batch enrollment using audio data from prior calls - // (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html) + // output file. Refer to Batch enrollment using audio data from prior calls (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html) // for the permissions needed in this role. // // This member is required. @@ -60,8 +59,8 @@ type StartSpeakerEnrollmentJobInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The enrollment config that contains details such as the action to take when a diff --git a/service/voiceid/api_op_UpdateDomain.go b/service/voiceid/api_op_UpdateDomain.go index 33d06bc583f..5720e280ddb 100644 --- a/service/voiceid/api_op_UpdateDomain.go +++ b/service/voiceid/api_op_UpdateDomain.go @@ -41,12 +41,12 @@ type UpdateDomainInput struct { // This member is required. Name *string - // The configuration, containing the KMS key identifier, to be used by Voice ID for - // the server-side encryption of your data. Changing the domain's associated KMS - // key immediately triggers an asynchronous process to remove dependency on the old - // KMS key, such that the domain's data can only be accessed using the new KMS key. - // The domain's ServerSideEncryptionUpdateDetails contains the details for this - // process. + // The configuration, containing the KMS key identifier, to be used by Voice ID + // for the server-side encryption of your data. Changing the domain's associated + // KMS key immediately triggers an asynchronous process to remove dependency on the + // old KMS key, such that the domain's data can only be accessed using the new KMS + // key. The domain's ServerSideEncryptionUpdateDetails contains the details for + // this process. // // This member is required. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration diff --git a/service/voiceid/types/enums.go b/service/voiceid/types/enums.go index 688e7d7ad43..f9c70beb036 100644 --- a/service/voiceid/types/enums.go +++ b/service/voiceid/types/enums.go @@ -46,9 +46,9 @@ const ( ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist ConflictType = "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST" ) -// Values returns all known values for ConflictType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ConflictType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ConflictType) Values() []ConflictType { return []ConflictType{ "ANOTHER_ACTIVE_STREAM", @@ -73,9 +73,9 @@ const ( DomainStatusSuspended DomainStatus = "SUSPENDED" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "ACTIVE", @@ -110,9 +110,9 @@ const ( ExistingEnrollmentActionOverwrite ExistingEnrollmentAction = "OVERWRITE" ) -// Values returns all known values for ExistingEnrollmentAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ExistingEnrollmentAction. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ExistingEnrollmentAction) Values() []ExistingEnrollmentAction { return []ExistingEnrollmentAction{ "SKIP", @@ -214,9 +214,9 @@ const ( ResourceTypeWatchlist ResourceType = "WATCHLIST" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "BATCH_JOB", diff --git a/service/voiceid/types/errors.go b/service/voiceid/types/errors.go index 4008b3b9ff9..1f66bae05c4 100644 --- a/service/voiceid/types/errors.go +++ b/service/voiceid/types/errors.go @@ -89,8 +89,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The specified resource cannot be found. Check the ResourceType and error message -// for more details. +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. type ResourceNotFoundException struct { Message *string @@ -118,8 +118,7 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request exceeded the service quota. Refer to Voice ID Service Quotas -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) // and try your request again. type ServiceQuotaExceededException struct { Message *string @@ -147,8 +146,7 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was denied due to request throttling. Please slow down your request -// rate. Refer to Amazon Connect Voice ID Service API throttling quotas -// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) // and try your request again. type ThrottlingException struct { Message *string diff --git a/service/voiceid/types/types.go b/service/voiceid/types/types.go index 11bd7915493..1d956018331 100644 --- a/service/voiceid/types/types.go +++ b/service/voiceid/types/types.go @@ -53,7 +53,7 @@ type AuthenticationResult struct { // The authentication score for the speaker whose authentication result is // produced. This value is only present if the authentication decision is either - // ACCEPT or REJECT. + // ACCEPT or REJECT . Score *int32 noSmithyDocumentSerde @@ -134,7 +134,7 @@ type DomainSummary struct { // The timestamp of when the domain was last updated. UpdatedAt *time.Time - // Provides information about watchlistDetails and DefaultWatchlistID. + // Provides information about watchlistDetails and DefaultWatchlistID . WatchlistDetails *WatchlistDetails noSmithyDocumentSerde @@ -144,7 +144,7 @@ type DomainSummary struct { type EnrollmentConfig struct { // The action to take when the specified speaker is already enrolled in the - // specified domain. The default value is SKIP, which skips the enrollment for the + // specified domain. The default value is SKIP , which skips the enrollment for the // existing speaker. Setting the value to OVERWRITE replaces the existing voice // prints and enrollment audio stored for that speaker with new data generated from // the latest audio. @@ -156,12 +156,12 @@ type EnrollmentConfig struct { noSmithyDocumentSerde } -// The fraud detection configuration to be used during the batch speaker enrollment -// job. +// The fraud detection configuration to be used during the batch speaker +// enrollment job. type EnrollmentJobFraudDetectionConfig struct { // The action to take when the given speaker is flagged by the fraud detection - // system. The default value is FAIL, which fails the speaker enrollment. Changing + // system. The default value is FAIL , which fails the speaker enrollment. Changing // this value to IGNORE results in the speaker being enrolled even if they are // flagged by the fraud detection system. FraudDetectionAction FraudDetectionAction @@ -217,8 +217,8 @@ type FraudDetectionResult struct { // The FraudDetectionConfiguration used to generate this fraud detection result. Configuration *FraudDetectionConfiguration - // The fraud detection decision produced by Voice ID, processed against the current - // session state and streamed audio of the speaker. + // The fraud detection decision produced by Voice ID, processed against the + // current session state and streamed audio of the speaker. Decision FraudDetectionDecision // The unique identifier for this fraud detection result. Given there can be @@ -229,8 +229,8 @@ type FraudDetectionResult struct { FraudDetectionResultId *string // The reason speaker was flagged by the fraud detection system. This is only be - // populated if fraud detection Decision is HIGH_RISK, and the following possible - // values: KNOWN_FRAUDSTER and VOICE_SPOOFING. + // populated if fraud detection Decision is HIGH_RISK , and the following possible + // values: KNOWN_FRAUDSTER and VOICE_SPOOFING . Reasons []FraudDetectionReason // Details about each risk analyzed for this speaker. Currently, this contains @@ -294,7 +294,7 @@ type FraudsterRegistrationJob struct { // Contains details that are populated when an entire batch job fails. In cases of // individual registration job failures, the batch job as a whole doesn't fail; it - // is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job + // is completed with a JobStatus of COMPLETED_WITH_ERRORS . You can use the job // output file to identify the individual registration requests that failed. FailureDetails *FailureDetails @@ -342,7 +342,7 @@ type FraudsterRegistrationJobSummary struct { // Contains details that are populated when an entire batch job fails. In cases of // individual registration job failures, the batch job as a whole doesn't fail; it - // is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job + // is completed with a JobStatus of COMPLETED_WITH_ERRORS . You can use the job // output file to identify the individual registration requests that failed. FailureDetails *FailureDetails @@ -383,8 +383,8 @@ type FraudsterSummary struct { // The configuration containing input file information for a batch job. type InputDataConfig struct { - // The S3 location for the input manifest file that contains the list of individual - // enrollment or registration job requests. + // The S3 location for the input manifest file that contains the list of + // individual enrollment or registration job requests. // // This member is required. S3Uri *string @@ -413,7 +413,7 @@ type KnownFraudsterRisk struct { // The identifier of the fraudster that is the closest match to the speaker. If // there are no fraudsters registered in a given domain, or if there are no - // fraudsters with a non-zero RiskScore, this value is null. + // fraudsters with a non-zero RiskScore, this value is null . GeneratedFraudsterId *string noSmithyDocumentSerde @@ -424,8 +424,8 @@ type OutputDataConfig struct { // The S3 path of the folder where Voice ID writes the job output file. It has a // *.out extension. For example, if the input file name is input-file.json and the - // output folder path is s3://output-bucket/output-folder, the full output file - // path is s3://output-bucket/output-folder/job-Id/input-file.json.out. + // output folder path is s3://output-bucket/output-folder , the full output file + // path is s3://output-bucket/output-folder/job-Id/input-file.json.out . // // This member is required. S3Uri *string @@ -442,7 +442,7 @@ type OutputDataConfig struct { type RegistrationConfig struct { // The action to take when a fraudster is identified as a duplicate. The default - // action is SKIP, which skips registering the duplicate fraudster. Setting the + // action is SKIP , which skips registering the duplicate fraudster. Setting the // value to REGISTER_AS_NEW always registers a new fraudster into the specified // domain. DuplicateRegistrationAction DuplicateRegistrationAction @@ -458,8 +458,8 @@ type RegistrationConfig struct { noSmithyDocumentSerde } -// The configuration containing information about the customer managed key used for -// encrypting customer data. +// The configuration containing information about the customer managed key used +// for encrypting customer data. type ServerSideEncryptionConfiguration struct { // The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice @@ -547,7 +547,7 @@ type SpeakerEnrollmentJob struct { // Contains details that are populated when an entire batch job fails. In cases of // individual registration job failures, the batch job as a whole doesn't fail; it - // is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job + // is completed with a JobStatus of COMPLETED_WITH_ERRORS . You can use the job // output file to identify the individual registration requests that failed. FailureDetails *FailureDetails @@ -589,7 +589,7 @@ type SpeakerEnrollmentJobSummary struct { // Contains details that are populated when an entire batch job fails. In cases of // individual registration job failures, the batch job as a whole doesn't fail; it - // is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job + // is completed with a JobStatus of COMPLETED_WITH_ERRORS . You can use the job // output file to identify the individual registration requests that failed. FailureDetails *FailureDetails diff --git a/service/vpclattice/api_client.go b/service/vpclattice/api_client.go index 04a2111074d..f385147eac3 100644 --- a/service/vpclattice/api_client.go +++ b/service/vpclattice/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/vpclattice/api_op_CreateAccessLogSubscription.go b/service/vpclattice/api_op_CreateAccessLogSubscription.go index 0786cd77d10..ab6ec1f864c 100644 --- a/service/vpclattice/api_op_CreateAccessLogSubscription.go +++ b/service/vpclattice/api_op_CreateAccessLogSubscription.go @@ -16,8 +16,7 @@ import ( // audit the services in the network. The service network owner will only see // access logs from clients and services that are associated with their service // network. Access log entries represent traffic originated from VPCs associated -// with that network. For more information, see Access logs -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html) +// with that network. For more information, see Access logs (https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html) // in the Amazon VPC Lattice User Guide. func (c *Client) CreateAccessLogSubscription(ctx context.Context, params *CreateAccessLogSubscriptionInput, optFns ...func(*Options)) (*CreateAccessLogSubscriptionOutput, error) { if params == nil { diff --git a/service/vpclattice/api_op_CreateListener.go b/service/vpclattice/api_op_CreateListener.go index 5ac6abc93ee..94a921d74d5 100644 --- a/service/vpclattice/api_op_CreateListener.go +++ b/service/vpclattice/api_op_CreateListener.go @@ -12,11 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a listener for a service. Before you start using your Amazon VPC Lattice -// service, you must add one or more listeners. A listener is a process that checks -// for connection requests to your services. For more information, see Listeners -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html) in the Amazon -// VPC Lattice User Guide. +// Creates a listener for a service. Before you start using your Amazon VPC +// Lattice service, you must add one or more listeners. A listener is a process +// that checks for connection requests to your services. For more information, see +// Listeners (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html) in +// the Amazon VPC Lattice User Guide. func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error) { if params == nil { params = &CreateListenerInput{} @@ -37,8 +37,8 @@ type CreateListenerInput struct { // The action for the default rule. Each listener has a default rule. Each rule // consists of a priority, one or more actions, and one or more conditions. The // default rule is the rule that's used if no other rules match. Each rule must - // include exactly one of the following types of actions: forward or - // fixed-response, and it must be the last action to be performed. + // include exactly one of the following types of actions: forward or fixed-response + // , and it must be the last action to be performed. // // This member is required. DefaultAction types.RuleAction @@ -66,8 +66,8 @@ type CreateListenerInput struct { // actions. If the parameters aren't identical, the retry fails. ClientToken *string - // The listener port. You can specify a value from 1 to 65535. For HTTP, the - // default is 80. For HTTPS, the default is 443. + // The listener port. You can specify a value from 1 to 65535 . For HTTP, the + // default is 80 . For HTTPS, the default is 443 . Port *int32 // The tags for the listener. diff --git a/service/vpclattice/api_op_CreateRule.go b/service/vpclattice/api_op_CreateRule.go index c2244e483ea..0a68d87680d 100644 --- a/service/vpclattice/api_op_CreateRule.go +++ b/service/vpclattice/api_op_CreateRule.go @@ -15,8 +15,7 @@ import ( // Creates a listener rule. Each listener has a default rule for checking // connection requests, but you can define additional rules. Each rule consists of // a priority, one or more actions, and one or more conditions. For more -// information, see Listener rules -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) +// information, see Listener rules (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) // in the Amazon VPC Lattice User Guide. func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { @@ -57,8 +56,8 @@ type CreateRuleInput struct { // This member is required. Name *string - // The priority assigned to the rule. Each rule for a specific listener must have a - // unique priority. The lower the priority number the higher the priority. + // The priority assigned to the rule. Each rule for a specific listener must have + // a unique priority. The lower the priority number the higher the priority. // // This member is required. Priority *int32 @@ -83,7 +82,7 @@ type CreateRuleInput struct { type CreateRuleOutput struct { // The rule action. Each rule must include exactly one of the following types of - // actions: forward or fixed-response, and it must be the last action to be + // actions: forward or fixed-response , and it must be the last action to be // performed. Action types.RuleAction @@ -93,7 +92,7 @@ type CreateRuleOutput struct { // The ID of the rule. Id *string - // The rule match. The RuleMatch must be an HttpMatch. This means that the rule + // The rule match. The RuleMatch must be an HttpMatch . This means that the rule // should be an exact match on HTTP constraints which are made up of the HTTP // method, path, and header. Match types.RuleMatch diff --git a/service/vpclattice/api_op_CreateService.go b/service/vpclattice/api_op_CreateService.go index db9b4b59d22..67958a97fec 100644 --- a/service/vpclattice/api_op_CreateService.go +++ b/service/vpclattice/api_op_CreateService.go @@ -14,9 +14,8 @@ import ( // Creates a service. A service is any software application that can run on // instances containers, or serverless functions within an account or virtual -// private cloud (VPC). For more information, see Services -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) in the Amazon -// VPC Lattice User Guide. +// private cloud (VPC). For more information, see Services (https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) +// in the Amazon VPC Lattice User Guide. func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -42,12 +41,9 @@ type CreateServiceInput struct { Name *string // The type of IAM policy. - // - // * NONE: The resource does not use an IAM policy. This - // is the default. - // - // * AWS_IAM: The resource uses an IAM policy. When this type is - // used, auth is enabled and an auth policy is required. + // - NONE : The resource does not use an IAM policy. This is the default. + // - AWS_IAM : The resource uses an IAM policy. When this type is used, auth is + // enabled and an auth policy is required. AuthType types.AuthType // The Amazon Resource Name (ARN) of the certificate. @@ -91,8 +87,8 @@ type CreateServiceOutput struct { // The name of the service. Name *string - // The status. If the status is CREATE_FAILED, you will have to delete and recreate - // the service. + // The status. If the status is CREATE_FAILED , you will have to delete and + // recreate the service. Status types.ServiceStatus // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_CreateServiceNetwork.go b/service/vpclattice/api_op_CreateServiceNetwork.go index fadf35c6d31..e5471d27ce1 100644 --- a/service/vpclattice/api_op_CreateServiceNetwork.go +++ b/service/vpclattice/api_op_CreateServiceNetwork.go @@ -14,9 +14,8 @@ import ( // Creates a service network. A service network is a logical boundary for a // collection of services. You can associate services and VPCs with a service -// network. For more information, see Service networks -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html) in the -// Amazon VPC Lattice User Guide. +// network. For more information, see Service networks (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html) +// in the Amazon VPC Lattice User Guide. func (c *Client) CreateServiceNetwork(ctx context.Context, params *CreateServiceNetworkInput, optFns ...func(*Options)) (*CreateServiceNetworkOutput, error) { if params == nil { params = &CreateServiceNetworkInput{} @@ -42,12 +41,9 @@ type CreateServiceNetworkInput struct { Name *string // The type of IAM policy. - // - // * NONE: The resource does not use an IAM policy. This - // is the default. - // - // * AWS_IAM: The resource uses an IAM policy. When this type is - // used, auth is enabled and an auth policy is required. + // - NONE : The resource does not use an IAM policy. This is the default. + // - AWS_IAM : The resource uses an IAM policy. When this type is used, auth is + // enabled and an auth policy is required. AuthType types.AuthType // A unique, case-sensitive identifier that you provide to ensure the idempotency diff --git a/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go b/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go index 45d1d20c0b8..8cebd572971 100644 --- a/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go +++ b/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a service with a service network. You can't use this operation if the -// service and service network are already associated or if there is a +// Associates a service with a service network. You can't use this operation if +// the service and service network are already associated or if there is a // disassociation or deletion in progress. If the association fails, you can retry // the operation by deleting the association and recreating it. You cannot // associate a service and service network that are shared with a caller. The diff --git a/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go b/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go index 4e7e65d0916..8d53ea47e19 100644 --- a/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go +++ b/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go @@ -15,8 +15,7 @@ import ( // Associates a VPC with a service network. When you associate a VPC with the // service network, it enables all the resources within that VPC to be clients and // communicate with other services in the service network. For more information, -// see Manage VPC associations -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-vpc-associations) +// see Manage VPC associations (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-vpc-associations) // in the Amazon VPC Lattice User Guide. You can't use this operation if there is a // disassociation in progress. If the association fails, retry by deleting the // association and recreating it. As a result of this operation, the association @@ -59,12 +58,11 @@ type CreateServiceNetworkVpcAssociationInput struct { // actions. If the parameters aren't identical, the retry fails. ClientToken *string - // The IDs of the security groups. Security groups aren't added by default. You can - // add a security group to apply network level controls to control which resources - // in a VPC are allowed to access the service network and its services. For more - // information, see Control traffic to resources using security groups - // (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in - // the Amazon VPC User Guide. + // The IDs of the security groups. Security groups aren't added by default. You + // can add a security group to apply network level controls to control which + // resources in a VPC are allowed to access the service network and its services. + // For more information, see Control traffic to resources using security groups (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) + // in the Amazon VPC User Guide. SecurityGroupIds []string // The tags for the association. diff --git a/service/vpclattice/api_op_CreateTargetGroup.go b/service/vpclattice/api_op_CreateTargetGroup.go index 5bfae2fe9bc..db38df7147f 100644 --- a/service/vpclattice/api_op_CreateTargetGroup.go +++ b/service/vpclattice/api_op_CreateTargetGroup.go @@ -14,9 +14,8 @@ import ( // Creates a target group. A target group is a collection of targets, or compute // resources, that run your application or service. A target group can only be used -// by a single service. For more information, see Target groups -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html) in the -// Amazon VPC Lattice User Guide. +// by a single service. For more information, see Target groups (https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html) +// in the Amazon VPC Lattice User Guide. func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGroupInput, optFns ...func(*Options)) (*CreateTargetGroupOutput, error) { if params == nil { params = &CreateTargetGroupInput{} @@ -52,8 +51,8 @@ type CreateTargetGroupInput struct { // actions. If the parameters aren't identical, the retry fails. ClientToken *string - // The target group configuration. If type is set to LAMBDA, this parameter doesn't - // apply. + // The target group configuration. If type is set to LAMBDA , this parameter + // doesn't apply. Config *types.TargetGroupConfig // The tags for the target group. @@ -67,8 +66,8 @@ type CreateTargetGroupOutput struct { // The Amazon Resource Name (ARN) of the target group. Arn *string - // The target group configuration. If type is set to LAMBDA, this parameter doesn't - // apply. + // The target group configuration. If type is set to LAMBDA , this parameter + // doesn't apply. Config *types.TargetGroupConfig // The ID of the target group. @@ -78,8 +77,8 @@ type CreateTargetGroupOutput struct { Name *string // The operation's status. You can retry the operation if the status is - // CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, - // there is no change in the status. + // CREATE_FAILED . However, if you retry it while the status is CREATE_IN_PROGRESS + // , there is no change in the status. Status types.TargetGroupStatus // The type of target group. diff --git a/service/vpclattice/api_op_DeleteAuthPolicy.go b/service/vpclattice/api_op_DeleteAuthPolicy.go index be7f2c77371..af6934fb700 100644 --- a/service/vpclattice/api_op_DeleteAuthPolicy.go +++ b/service/vpclattice/api_op_DeleteAuthPolicy.go @@ -12,7 +12,7 @@ import ( // Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth // policy is deleted, all requests will be denied by default. If you are trying to -// remove the auth policy completely, you must set the auth_type to NONE. If auth +// remove the auth policy completely, you must set the auth_type to NONE . If auth // is enabled on the resource, but no auth policy is set, all requests will be // denied. func (c *Client) DeleteAuthPolicy(ctx context.Context, params *DeleteAuthPolicyInput, optFns ...func(*Options)) (*DeleteAuthPolicyOutput, error) { diff --git a/service/vpclattice/api_op_DeleteRule.go b/service/vpclattice/api_op_DeleteRule.go index 13a42b6c06c..020a0da4269 100644 --- a/service/vpclattice/api_op_DeleteRule.go +++ b/service/vpclattice/api_op_DeleteRule.go @@ -14,8 +14,7 @@ import ( // connection requests, but you can define additional rules. Each rule consists of // a priority, one or more actions, and one or more conditions. You can delete // additional listener rules, but you cannot delete the default rule. For more -// information, see Listener rules -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) +// information, see Listener rules (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) // in the Amazon VPC Lattice User Guide. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { diff --git a/service/vpclattice/api_op_DeleteService.go b/service/vpclattice/api_op_DeleteService.go index 6e3831cc48f..6124c320742 100644 --- a/service/vpclattice/api_op_DeleteService.go +++ b/service/vpclattice/api_op_DeleteService.go @@ -14,8 +14,7 @@ import ( // Deletes a service. A service can't be deleted if it's associated with a service // network. If you delete a service, all resources related to the service, such as // the resource policy, auth policy, listeners, listener rules, and access log -// subscriptions, are also deleted. For more information, see Delete a service -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html#delete-service) +// subscriptions, are also deleted. For more information, see Delete a service (https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html#delete-service) // in the Amazon VPC Lattice User Guide. func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error) { if params == nil { @@ -53,9 +52,9 @@ type DeleteServiceOutput struct { // The name of the service. Name *string - // The status. You can retry the operation if the status is DELETE_FAILED. However, - // if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't - // change. + // The status. You can retry the operation if the status is DELETE_FAILED . + // However, if you retry it while the status is DELETE_IN_PROGRESS , the status + // doesn't change. Status types.ServiceStatus // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_DeleteServiceNetwork.go b/service/vpclattice/api_op_DeleteServiceNetwork.go index a52ae49e05d..d1ea91c441b 100644 --- a/service/vpclattice/api_op_DeleteServiceNetwork.go +++ b/service/vpclattice/api_op_DeleteServiceNetwork.go @@ -14,8 +14,7 @@ import ( // no service or VPC associated with it. If you delete a service network, all // resources related to the service network, such as the resource policy, auth // policy, and access log subscriptions, are also deleted. For more information, -// see Delete a service network -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#delete-service-network) +// see Delete a service network (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#delete-service-network) // in the Amazon VPC Lattice User Guide. func (c *Client) DeleteServiceNetwork(ctx context.Context, params *DeleteServiceNetworkInput, optFns ...func(*Options)) (*DeleteServiceNetworkOutput, error) { if params == nil { diff --git a/service/vpclattice/api_op_DeleteServiceNetworkServiceAssociation.go b/service/vpclattice/api_op_DeleteServiceNetworkServiceAssociation.go index 295ad95c2c5..0848857c9ee 100644 --- a/service/vpclattice/api_op_DeleteServiceNetworkServiceAssociation.go +++ b/service/vpclattice/api_op_DeleteServiceNetworkServiceAssociation.go @@ -47,7 +47,7 @@ type DeleteServiceNetworkServiceAssociationOutput struct { Id *string // The operation's status. You can retry the operation if the status is - // DELETE_FAILED. However, if you retry it when the status is DELETE_IN_PROGRESS, + // DELETE_FAILED . However, if you retry it when the status is DELETE_IN_PROGRESS , // there is no change in the status. Status types.ServiceNetworkServiceAssociationStatus diff --git a/service/vpclattice/api_op_DeleteServiceNetworkVpcAssociation.go b/service/vpclattice/api_op_DeleteServiceNetworkVpcAssociation.go index bc89ff7947e..a20615f0315 100644 --- a/service/vpclattice/api_op_DeleteServiceNetworkVpcAssociation.go +++ b/service/vpclattice/api_op_DeleteServiceNetworkVpcAssociation.go @@ -46,9 +46,9 @@ type DeleteServiceNetworkVpcAssociationOutput struct { // The ID of the association. Id *string - // The status. You can retry the operation if the status is DELETE_FAILED. However, - // if you retry it when the status is DELETE_IN_PROGRESS, there is no change in the - // status. + // The status. You can retry the operation if the status is DELETE_FAILED . + // However, if you retry it when the status is DELETE_IN_PROGRESS , there is no + // change in the status. Status types.ServiceNetworkVpcAssociationStatus // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_DeleteTargetGroup.go b/service/vpclattice/api_op_DeleteTargetGroup.go index 2d270b36f1d..c2c8a77b143 100644 --- a/service/vpclattice/api_op_DeleteTargetGroup.go +++ b/service/vpclattice/api_op_DeleteTargetGroup.go @@ -46,9 +46,9 @@ type DeleteTargetGroupOutput struct { // The ID of the target group. Id *string - // The status. You can retry the operation if the status is DELETE_FAILED. However, - // if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't - // change. + // The status. You can retry the operation if the status is DELETE_FAILED . + // However, if you retry it while the status is DELETE_IN_PROGRESS , the status + // doesn't change. Status types.TargetGroupStatus // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_GetAuthPolicy.go b/service/vpclattice/api_op_GetAuthPolicy.go index e98c3723bb7..4d3084d1fcf 100644 --- a/service/vpclattice/api_op_GetAuthPolicy.go +++ b/service/vpclattice/api_op_GetAuthPolicy.go @@ -12,8 +12,8 @@ import ( "time" ) -// Retrieves information about the auth policy for the specified service or service -// network. +// Retrieves information about the auth policy for the specified service or +// service network. func (c *Client) GetAuthPolicy(ctx context.Context, params *GetAuthPolicyInput, optFns ...func(*Options)) (*GetAuthPolicyOutput, error) { if params == nil { params = &GetAuthPolicyInput{} @@ -53,11 +53,10 @@ type GetAuthPolicyOutput struct { Policy *string // The state of the auth policy. The auth policy is only active when the auth type - // is set to AWS_IAM. If you provide a policy, then authentication and + // is set to AWS_IAM . If you provide a policy, then authentication and // authorization decisions are made based on this policy and the client's IAM - // policy. If the auth type is NONE, then any auth policy you provide will remain - // inactive. For more information, see Create a service network - // (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network) + // policy. If the auth type is NONE , then any auth policy you provide will remain + // inactive. For more information, see Create a service network (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network) // in the Amazon VPC Lattice User Guide. State types.AuthPolicyState diff --git a/service/vpclattice/api_op_GetRule.go b/service/vpclattice/api_op_GetRule.go index 605899da856..574a83779a8 100644 --- a/service/vpclattice/api_op_GetRule.go +++ b/service/vpclattice/api_op_GetRule.go @@ -13,8 +13,7 @@ import ( ) // Retrieves information about listener rules. You can also retrieve information -// about the default listener rule. For more information, see Listener rules -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) +// about the default listener rule. For more information, see Listener rules (https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) // in the Amazon VPC Lattice User Guide. func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { @@ -69,8 +68,8 @@ type GetRuleOutput struct { // Indicates whether this is the default rule. IsDefault *bool - // The date and time that the listener rule was last updated, specified in ISO-8601 - // format. + // The date and time that the listener rule was last updated, specified in + // ISO-8601 format. LastUpdatedAt *time.Time // The rule match. diff --git a/service/vpclattice/api_op_ListServiceNetworks.go b/service/vpclattice/api_op_ListServiceNetworks.go index 10d47bbb55f..1c1b66b4f65 100644 --- a/service/vpclattice/api_op_ListServiceNetworks.go +++ b/service/vpclattice/api_op_ListServiceNetworks.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the service networks owned by the caller account or shared with the caller -// account. Also includes the account ID in the ARN to show which account owns the -// service network. +// Lists the service networks owned by the caller account or shared with the +// caller account. Also includes the account ID in the ARN to show which account +// owns the service network. func (c *Client) ListServiceNetworks(ctx context.Context, params *ListServiceNetworksInput, optFns ...func(*Options)) (*ListServiceNetworksOutput, error) { if params == nil { params = &ListServiceNetworksInput{} @@ -118,8 +118,8 @@ func (c *Client) addOperationListServiceNetworksMiddlewares(stack *middleware.St return nil } -// ListServiceNetworksAPIClient is a client that implements the ListServiceNetworks -// operation. +// ListServiceNetworksAPIClient is a client that implements the +// ListServiceNetworks operation. type ListServiceNetworksAPIClient interface { ListServiceNetworks(context.Context, *ListServiceNetworksInput, ...func(*Options)) (*ListServiceNetworksOutput, error) } diff --git a/service/vpclattice/api_op_PutAuthPolicy.go b/service/vpclattice/api_op_PutAuthPolicy.go index fd6e2462543..d2f9cdc3330 100644 --- a/service/vpclattice/api_op_PutAuthPolicy.go +++ b/service/vpclattice/api_op_PutAuthPolicy.go @@ -36,8 +36,8 @@ type PutAuthPolicyInput struct { // This member is required. Policy *string - // The ID or Amazon Resource Name (ARN) of the service network or service for which - // the policy is created. + // The ID or Amazon Resource Name (ARN) of the service network or service for + // which the policy is created. // // This member is required. ResourceIdentifier *string @@ -52,11 +52,10 @@ type PutAuthPolicyOutput struct { Policy *string // The state of the auth policy. The auth policy is only active when the auth type - // is set to AWS_IAM. If you provide a policy, then authentication and + // is set to AWS_IAM . If you provide a policy, then authentication and // authorization decisions are made based on this policy and the client's IAM - // policy. If the Auth type is NONE, then, any auth policy you provide will remain - // inactive. For more information, see Create a service network - // (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network) + // policy. If the Auth type is NONE , then, any auth policy you provide will remain + // inactive. For more information, see Create a service network (https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network) // in the Amazon VPC Lattice User Guide. State types.AuthPolicyState diff --git a/service/vpclattice/api_op_PutResourcePolicy.go b/service/vpclattice/api_op_PutResourcePolicy.go index 32a8f02f550..65ba2400ba0 100644 --- a/service/vpclattice/api_op_PutResourcePolicy.go +++ b/service/vpclattice/api_op_PutResourcePolicy.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a resource-based permission policy to a service or service network. The -// policy must contain the same actions and condition statements as the Amazon Web -// Services Resource Access Manager permission for sharing services and service +// Attaches a resource-based permission policy to a service or service network. +// The policy must contain the same actions and condition statements as the Amazon +// Web Services Resource Access Manager permission for sharing services and service // networks. func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { @@ -37,8 +37,8 @@ type PutResourcePolicyInput struct { // This member is required. Policy *string - // The ID or Amazon Resource Name (ARN) of the service network or service for which - // the policy is created. + // The ID or Amazon Resource Name (ARN) of the service network or service for + // which the policy is created. // // This member is required. ResourceArn *string diff --git a/service/vpclattice/api_op_UpdateRule.go b/service/vpclattice/api_op_UpdateRule.go index 3e097ee00d5..6b440257e71 100644 --- a/service/vpclattice/api_op_UpdateRule.go +++ b/service/vpclattice/api_op_UpdateRule.go @@ -12,7 +12,7 @@ import ( ) // Updates a rule for the listener. You can't modify a default listener rule. To -// modify a default listener rule, use UpdateListener. +// modify a default listener rule, use UpdateListener . func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { params = &UpdateRuleInput{} diff --git a/service/vpclattice/api_op_UpdateService.go b/service/vpclattice/api_op_UpdateService.go index 191aee42485..ef38c851049 100644 --- a/service/vpclattice/api_op_UpdateService.go +++ b/service/vpclattice/api_op_UpdateService.go @@ -35,12 +35,9 @@ type UpdateServiceInput struct { ServiceIdentifier *string // The type of IAM policy. - // - // * NONE: The resource does not use an IAM policy. This - // is the default. - // - // * AWS_IAM: The resource uses an IAM policy. When this type is - // used, auth is enabled and an auth policy is required. + // - NONE : The resource does not use an IAM policy. This is the default. + // - AWS_IAM : The resource uses an IAM policy. When this type is used, auth is + // enabled and an auth policy is required. AuthType types.AuthType // The Amazon Resource Name (ARN) of the certificate. diff --git a/service/vpclattice/api_op_UpdateServiceNetwork.go b/service/vpclattice/api_op_UpdateServiceNetwork.go index fa2a0526f97..c4789c9768a 100644 --- a/service/vpclattice/api_op_UpdateServiceNetwork.go +++ b/service/vpclattice/api_op_UpdateServiceNetwork.go @@ -30,12 +30,9 @@ func (c *Client) UpdateServiceNetwork(ctx context.Context, params *UpdateService type UpdateServiceNetworkInput struct { // The type of IAM policy. - // - // * NONE: The resource does not use an IAM policy. This - // is the default. - // - // * AWS_IAM: The resource uses an IAM policy. When this type is - // used, auth is enabled and an auth policy is required. + // - NONE : The resource does not use an IAM policy. This is the default. + // - AWS_IAM : The resource uses an IAM policy. When this type is used, auth is + // enabled and an auth policy is required. // // This member is required. AuthType types.AuthType diff --git a/service/vpclattice/api_op_UpdateServiceNetworkVpcAssociation.go b/service/vpclattice/api_op_UpdateServiceNetworkVpcAssociation.go index 2110ff6733d..0b162679a23 100644 --- a/service/vpclattice/api_op_UpdateServiceNetworkVpcAssociation.go +++ b/service/vpclattice/api_op_UpdateServiceNetworkVpcAssociation.go @@ -60,9 +60,9 @@ type UpdateServiceNetworkVpcAssociationOutput struct { // The IDs of the security groups. SecurityGroupIds []string - // The status. You can retry the operation if the status is DELETE_FAILED. However, - // if you retry it while the status is DELETE_IN_PROGRESS, there is no change in - // the status. + // The status. You can retry the operation if the status is DELETE_FAILED . + // However, if you retry it while the status is DELETE_IN_PROGRESS , there is no + // change in the status. Status types.ServiceNetworkVpcAssociationStatus // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/doc.go b/service/vpclattice/doc.go index 06344ed84cb..45d8ef681d0 100644 --- a/service/vpclattice/doc.go +++ b/service/vpclattice/doc.go @@ -8,6 +8,5 @@ // accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects // your microservices and legacy services within a logical boundary, so that you // can discover and manage them more efficiently. For more information, see the -// Amazon VPC Lattice User Guide -// (https://docs.aws.amazon.com/vpc-lattice/latest/ug/) +// Amazon VPC Lattice User Guide (https://docs.aws.amazon.com/vpc-lattice/latest/ug/) package vpclattice diff --git a/service/vpclattice/types/enums.go b/service/vpclattice/types/enums.go index 39527a1c1f3..89652c92a6f 100644 --- a/service/vpclattice/types/enums.go +++ b/service/vpclattice/types/enums.go @@ -114,9 +114,9 @@ const ( ServiceNetworkServiceAssociationStatusDeleteFailed ServiceNetworkServiceAssociationStatus = "DELETE_FAILED" ) -// Values returns all known values for ServiceNetworkServiceAssociationStatus. Note -// that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across +// Values returns all known values for ServiceNetworkServiceAssociationStatus. +// Note that this can be expanded in the future, and so it is only as up to date as +// the client. The ordering of this slice is not guaranteed to be stable across // updates. func (ServiceNetworkServiceAssociationStatus) Values() []ServiceNetworkServiceAssociationStatus { return []ServiceNetworkServiceAssociationStatus{ @@ -309,9 +309,9 @@ const ( TargetStatusUnused TargetStatus = "UNUSED" ) -// Values returns all known values for TargetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for TargetStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (TargetStatus) Values() []TargetStatus { return []TargetStatus{ "DRAINING", diff --git a/service/vpclattice/types/types.go b/service/vpclattice/types/types.go index 350d8da7840..4b88b5614b4 100644 --- a/service/vpclattice/types/types.go +++ b/service/vpclattice/types/types.go @@ -73,8 +73,8 @@ type FixedResponseAction struct { noSmithyDocumentSerde } -// Describes a forward action. You can use forward actions to route requests to one -// or more target groups. +// Describes a forward action. You can use forward actions to route requests to +// one or more target groups. type ForwardAction struct { // The target groups. Traffic matching the rule is forwarded to the specified @@ -174,9 +174,9 @@ type HealthCheckConfig struct { Matcher Matcher // The destination for health checks on the targets. If the protocol version is - // HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default - // path is /. Health checks are not supported if the protocol version is gRPC, - // however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI. + // HTTP/1.1 or HTTP/2 , specify a valid URI (for example, /path?query ). The + // default path is / . Health checks are not supported if the protocol version is + // gRPC , however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI. Path *string // The port used when performing health checks on targets. The default setting is @@ -184,11 +184,11 @@ type HealthCheckConfig struct { Port *int32 // The protocol used when performing health checks on targets. The possible - // protocols are HTTP and HTTPS. The default is HTTP. + // protocols are HTTP and HTTPS . The default is HTTP . Protocol TargetGroupProtocol - // The protocol version used when performing health checks on targets. The possible - // protocol versions are HTTP1 and HTTP2. + // The protocol version used when performing health checks on targets. The + // possible protocol versions are HTTP1 and HTTP2 . ProtocolVersion HealthCheckProtocolVersion // The number of consecutive failed health checks required before considering a @@ -306,7 +306,7 @@ type PathMatchTypeMemberPrefix struct { func (*PathMatchTypeMemberPrefix) isPathMatchType() {} // Describes the action for a rule. Each rule must include exactly one of the -// following types of actions: forward or fixed-response, and it must be the last +// following types of actions: forward or fixed-response , and it must be the last // action to be performed. // // The following types satisfy this interface: @@ -372,8 +372,8 @@ type RuleSummary struct { // requests. IsDefault *bool - // The date and time that the listener rule was last updated, specified in ISO-8601 - // format. + // The date and time that the listener rule was last updated, specified in + // ISO-8601 format. LastUpdatedAt *time.Time // The name of the rule. @@ -594,16 +594,16 @@ type ServiceSummary struct { // Describes a target. type Target struct { - // The ID of the target. If the target type of the target group is INSTANCE, this + // The ID of the target. If the target type of the target group is INSTANCE , this // is an instance ID. If the target type is IP , this is an IP address. If the - // target type is LAMBDA, this is the ARN of the Lambda function. If the target - // type is ALB, this is the ARN of the Application Load Balancer. + // target type is LAMBDA , this is the ARN of the Lambda function. If the target + // type is ALB , this is the ARN of the Application Load Balancer. // // This member is required. Id *string - // The port on which the target is listening. For HTTP, the default is 80. For - // HTTPS, the default is 443. + // The port on which the target is listening. For HTTP, the default is 80 . For + // HTTPS, the default is 443 . Port *int32 noSmithyDocumentSerde @@ -618,10 +618,10 @@ type TargetFailure struct { // The failure message. FailureMessage *string - // The ID of the target. If the target type of the target group is INSTANCE, this + // The ID of the target. If the target type of the target group is INSTANCE , this // is an instance ID. If the target type is IP , this is an IP address. If the - // target type is LAMBDA, this is the ARN of the Lambda function. If the target - // type is ALB, this is the ARN of the Application Load Balancer. + // target type is LAMBDA , this is the ARN of the Lambda function. If the target + // type is ALB , this is the ARN of the Application Load Balancer. Id *string // The port on which the target is listening. This parameter doesn't apply if the @@ -635,7 +635,7 @@ type TargetFailure struct { // target group configuration. type TargetGroupConfig struct { - // The port on which the targets are listening. For HTTP, the default is 80. For + // The port on which the targets are listening. For HTTP, the default is 80 . For // HTTPS, the default is 443 // // This member is required. @@ -656,11 +656,11 @@ type TargetGroupConfig struct { HealthCheck *HealthCheckConfig // The type of IP address used for the target group. The possible values are ipv4 - // and ipv6. This is an optional parameter. If not specified, the IP address type - // defaults to ipv4. + // and ipv6 . This is an optional parameter. If not specified, the IP address type + // defaults to ipv4 . IpAddressType IpAddressType - // The protocol version. Default value is HTTP1. + // The protocol version. Default value is HTTP1 . ProtocolVersion TargetGroupProtocolVersion noSmithyDocumentSerde @@ -680,8 +680,8 @@ type TargetGroupSummary struct { Id *string // The type of IP address used for the target group. The possible values are ipv4 - // and ipv6. This is an optional parameter. If not specified, the IP address type - // defaults to ipv4. + // and ipv6 . This is an optional parameter. If not specified, the IP address type + // defaults to ipv4 . IpAddressType IpAddressType // The date and time that the target group was last updated, specified in ISO-8601 @@ -715,10 +715,10 @@ type TargetGroupSummary struct { // Summary information about a target. type TargetSummary struct { - // The ID of the target. If the target type of the target group is INSTANCE, this + // The ID of the target. If the target type of the target group is INSTANCE , this // is an instance ID. If the target type is IP , this is an IP address. If the - // target type is LAMBDA, this is the ARN of the Lambda function. If the target - // type is ALB, this is the ARN of the Application Load Balancer. + // target type is LAMBDA , this is the ARN of the Lambda function. If the target + // type is ALB , this is the ARN of the Application Load Balancer. Id *string // The port on which the target is listening. @@ -728,23 +728,14 @@ type TargetSummary struct { ReasonCode *string // The status of the target. - // - // * Draining: The target is being deregistered. No new - // connections will be sent to this target while current connections are being - // drained. Default draining time is 5 minutes. - // - // * Unavailable: Health checks are - // unavailable for the target group. - // - // * Healthy: The target is healthy. - // - // * - // Unhealthy: The target is unhealthy. - // - // * Initial: Initial health checks on the - // target are being performed. - // - // * Unused: Target group is not used in a service. + // - Draining : The target is being deregistered. No new connections will be sent + // to this target while current connections are being drained. Default draining + // time is 5 minutes. + // - Unavailable : Health checks are unavailable for the target group. + // - Healthy : The target is healthy. + // - Unhealthy : The target is unhealthy. + // - Initial : Initial health checks on the target are being performed. + // - Unused : Target group is not used in a service. Status TargetStatus noSmithyDocumentSerde diff --git a/service/waf/api_client.go b/service/waf/api_client.go index bb8dc109b8a..5e6063585c7 100644 --- a/service/waf/api_client.go +++ b/service/waf/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/waf/api_op_CreateByteMatchSet.go b/service/waf/api_op_CreateByteMatchSet.go index ef9e51f7ac6..3aff528d17d 100644 --- a/service/waf/api_op_CreateByteMatchSet.go +++ b/service/waf/api_op_CreateByteMatchSet.go @@ -11,37 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify -// the part of a web request that you want AWS WAF to inspect, such as the values -// of the User-Agent header or the query string. For example, you can create a -// ByteMatchSet that matches any requests with User-Agent headers that contain the -// string BadBot. You can then configure AWS WAF to reject those requests. To -// create and configure a ByteMatchSet, perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a ByteMatchSet . You then use UpdateByteMatchSet to +// identify the part of a web request that you want AWS WAF to inspect, such as the +// values of the User-Agent header or the query string. For example, you can +// create a ByteMatchSet that matches any requests with User-Agent headers that +// contain the string BadBot . You can then configure AWS WAF to reject those +// requests. To create and configure a ByteMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateByteMatchSet request. +// - Submit a CreateByteMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateByteMatchSet request. +// - Submit an UpdateByteMatchSet request to specify the part of the request that +// you want AWS WAF to inspect (for example, the header or the URI) and the value +// that you want AWS WAF to watch for. // -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateByteMatchSet request. -// -// * Submit a CreateByteMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateByteMatchSet request. -// -// * Submit an -// UpdateByteMatchSet request to specify the part of the request that you want AWS -// WAF to inspect (for example, the header or the URI) and the value that you want -// AWS WAF to watch for. -// -// For more information about how to use the AWS WAF API to -// allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateByteMatchSet(ctx context.Context, params *CreateByteMatchSetInput, optFns ...func(*Options)) (*CreateByteMatchSetOutput, error) { if params == nil { params = &CreateByteMatchSetInput{} @@ -59,13 +50,13 @@ func (c *Client) CreateByteMatchSet(ctx context.Context, params *CreateByteMatch type CreateByteMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . // // This member is required. Name *string @@ -80,7 +71,7 @@ type CreateByteMatchSetOutput struct { // The ChangeToken that you used to submit the CreateByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_CreateGeoMatchSet.go b/service/waf/api_op_CreateGeoMatchSet.go index efc07c8f0ac..1c9eee36397 100644 --- a/service/waf/api_op_CreateGeoMatchSet.go +++ b/service/waf/api_op_CreateGeoMatchSet.go @@ -11,36 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an GeoMatchSet, which you use to specify which web requests -// you want to allow or block based on the country that the requests originate -// from. For example, if you're receiving a lot of requests from one or more -// countries and you want to block the requests, you can create an GeoMatchSet that -// contains those countries and then configure AWS WAF to block the requests. To -// create and configure a GeoMatchSet, perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an GeoMatchSet , which you use to specify which web +// requests you want to allow or block based on the country that the requests +// originate from. For example, if you're receiving a lot of requests from one or +// more countries and you want to block the requests, you can create an GeoMatchSet +// that contains those countries and then configure AWS WAF to block the requests. +// To create and configure a GeoMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateGeoMatchSet request. +// - Submit a CreateGeoMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateGeoMatchSet request. +// - Submit an UpdateGeoMatchSetSet request to specify the countries that you +// want AWS WAF to watch for. // -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateGeoMatchSet request. -// -// * Submit a CreateGeoMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateGeoMatchSet request. -// -// * Submit an -// UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to -// watch for. -// -// For more information about how to use the AWS WAF API to allow or -// block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateGeoMatchSet(ctx context.Context, params *CreateGeoMatchSetInput, optFns ...func(*Options)) (*CreateGeoMatchSetOutput, error) { if params == nil { params = &CreateGeoMatchSetInput{} @@ -58,13 +49,13 @@ func (c *Client) CreateGeoMatchSet(ctx context.Context, params *CreateGeoMatchSe type CreateGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the GeoMatchSet. You can't change Name after - // you create the GeoMatchSet. + // A friendly name or description of the GeoMatchSet . You can't change Name after + // you create the GeoMatchSet . // // This member is required. Name *string @@ -76,11 +67,11 @@ type CreateGeoMatchSetOutput struct { // The ChangeToken that you used to submit the CreateGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet - // contains no GeoMatchConstraints. + // contains no GeoMatchConstraints . GeoMatchSet *types.GeoMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_CreateIPSet.go b/service/waf/api_op_CreateIPSet.go index e74117f2394..ca5bbd6f7a5 100644 --- a/service/waf/api_op_CreateIPSet.go +++ b/service/waf/api_op_CreateIPSet.go @@ -11,36 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an IPSet, which you use to specify which web requests that -// you want to allow or block based on the IP addresses that the requests originate -// from. For example, if you're receiving a lot of requests from one or more -// individual IP addresses or one or more ranges of IP addresses and you want to -// block the requests, you can create an IPSet that contains those IP addresses and -// then configure AWS WAF to block the requests. To create and configure an IPSet, -// perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an IPSet , which you use to specify which web requests +// that you want to allow or block based on the IP addresses that the requests +// originate from. For example, if you're receiving a lot of requests from one or +// more individual IP addresses or one or more ranges of IP addresses and you want +// to block the requests, you can create an IPSet that contains those IP addresses +// and then configure AWS WAF to block the requests. To create and configure an +// IPSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateIPSet request. +// - Submit a CreateIPSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateIPSet request to specify the IP addresses that you want AWS +// WAF to watch for. // -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateIPSet request. -// -// * Submit a -// CreateIPSet request. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateIPSet request. -// -// * Submit an -// UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch -// for. -// -// For more information about how to use the AWS WAF API to allow or block -// HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optFns ...func(*Options)) (*CreateIPSetOutput, error) { if params == nil { params = &CreateIPSetInput{} @@ -58,13 +50,13 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the IPSet. You can't change Name after you - // create the IPSet. + // A friendly name or description of the IPSet . You can't change Name after you + // create the IPSet . // // This member is required. Name *string @@ -76,7 +68,7 @@ type CreateIPSetOutput struct { // The ChangeToken that you used to submit the CreateIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // The IPSet returned in the CreateIPSet response. diff --git a/service/waf/api_op_CreateRateBasedRule.go b/service/waf/api_op_CreateRateBasedRule.go index 13d407ae7f0..2053d21b51f 100644 --- a/service/waf/api_op_CreateRateBasedRule.go +++ b/service/waf/api_op_CreateRateBasedRule.go @@ -11,75 +11,56 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit, -// which specifies the maximum number of requests that AWS WAF allows from a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RateBasedRule . The RateBasedRule contains a RateLimit +// , which specifies the maximum number of requests that AWS WAF allows from a // specified IP address in a five-minute period. The RateBasedRule also contains // the IPSet objects, ByteMatchSet objects, and other predicates that identify the -// requests that you want to count or block if these requests exceed the RateLimit. -// If you add more than one predicate to a RateBasedRule, a request not only must -// exceed the RateLimit, but it also must match all the conditions to be counted or -// blocked. For example, suppose you add the following to a RateBasedRule: +// requests that you want to count or block if these requests exceed the RateLimit +// . If you add more than one predicate to a RateBasedRule , a request not only +// must exceed the RateLimit , but it also must match all the conditions to be +// counted or blocked. For example, suppose you add the following to a +// RateBasedRule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An -// IPSet that matches the IP address 192.0.2.44/32 +// Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a +// WebACL and specify that you want to block requests that meet the conditions in +// the rule. For a request to be blocked, it must come from the IP address +// 192.0.2.44 and the User-Agent header in the request must contain the value +// BadBot . Further, requests that match these two conditions must be received at a +// rate of more than 1,000 requests every five minutes. If both conditions are met +// and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below +// 1,000 for a five-minute period, AWS WAF no longer blocks the requests. As a +// second example, suppose you want to limit requests to a particular page on your +// site. To do this, you could add the following to a RateBasedRule : +// - A ByteMatchSet with FieldToMatch of URI +// - A PositionalConstraint of STARTS_WITH +// - A TargetString of login // -// * A ByteMatchSet that matches -// BadBot in the User-Agent header +// Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a +// WebACL , you could limit requests to your login page without affecting the rest +// of your site. To create and configure a RateBasedRule , perform the following +// steps: +// - Create and update the predicates that you want to include in the rule. For +// more information, see CreateByteMatchSet , CreateIPSet , and +// CreateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRule request. +// - Submit a CreateRateBasedRule request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRateBasedRule request to specify the predicates that you +// want to include in the rule. +// - Create and update a WebACL that contains the RateBasedRule . For more +// information, see CreateWebACL . // -// Further, you specify a RateLimit of 1,000. You -// then add the RateBasedRule to a WebACL and specify that you want to block -// requests that meet the conditions in the rule. For a request to be blocked, it -// must come from the IP address 192.0.2.44 and the User-Agent header in the -// request must contain the value BadBot. Further, requests that match these two -// conditions must be received at a rate of more than 1,000 requests every five -// minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the -// requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no -// longer blocks the requests. As a second example, suppose you want to limit -// requests to a particular page on your site. To do this, you could add the -// following to a RateBasedRule: -// -// * A ByteMatchSet with FieldToMatch of URI -// -// * A -// PositionalConstraint of STARTS_WITH -// -// * A TargetString of login -// -// Further, you -// specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you -// could limit requests to your login page without affecting the rest of your site. -// To create and configure a RateBasedRule, perform the following steps: -// -// * Create -// and update the predicates that you want to include in the rule. For more -// information, see CreateByteMatchSet, CreateIPSet, and -// CreateSqlInjectionMatchSet. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateRule request. -// -// * Submit a -// CreateRateBasedRule request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateRule request. -// -// * Submit an -// UpdateRateBasedRule request to specify the predicates that you want to include -// in the rule. -// -// * Create and update a WebACL that contains the RateBasedRule. For -// more information, see CreateWebACL. -// -// For more information about how to use the -// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBasedRuleInput, optFns ...func(*Options)) (*CreateRateBasedRuleOutput, error) { if params == nil { params = &CreateRateBasedRuleInput{} @@ -97,23 +78,23 @@ func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBase type CreateRateBasedRuleInput struct { - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this RateBasedRule. The name + // A friendly name or description for the metrics for this RateBasedRule . The name // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length // 128 and minimum length one. It can't contain whitespace or metric names reserved // for AWS WAF, including "All" and "Default_Action." You can't change the name of - // the metric after you create the RateBasedRule. + // the metric after you create the RateBasedRule . // // This member is required. MetricName *string - // A friendly name or description of the RateBasedRule. You can't change the name + // A friendly name or description of the RateBasedRule . You can't change the name // of a RateBasedRule after you create it. // // This member is required. @@ -121,14 +102,14 @@ type CreateRateBasedRuleInput struct { // The field that AWS WAF uses to determine if requests are likely arriving from a // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests that arrive from the same IP address - // are subject to the RateLimit that is specified in the RateBasedRule. + // RateKey is IP . IP indicates that requests that arrive from the same IP address + // are subject to the RateLimit that is specified in the RateBasedRule . // // This member is required. RateKey types.RateKey // The maximum number of requests, which have an identical value in the field that - // is specified by RateKey, allowed in a five-minute period. If the number of + // is specified by RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // @@ -143,9 +124,9 @@ type CreateRateBasedRuleInput struct { type CreateRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // The RateBasedRule that is returned in the CreateRateBasedRule response. diff --git a/service/waf/api_op_CreateRegexMatchSet.go b/service/waf/api_op_CreateRegexMatchSet.go index 8e75abc3ae2..133e0ae19f7 100644 --- a/service/waf/api_op_CreateRegexMatchSet.go +++ b/service/waf/api_op_CreateRegexMatchSet.go @@ -11,38 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RegexMatchSet . You then use UpdateRegexMatchSet to // identify the part of a web request that you want AWS WAF to inspect, such as the -// values of the User-Agent header or the query string. For example, you can create -// a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with -// User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You -// can then configure AWS WAF to reject those requests. To create and configure a -// RegexMatchSet, perform the following steps: +// values of the User-Agent header or the query string. For example, you can +// create a RegexMatchSet that contains a RegexMatchTuple that looks for any +// requests with User-Agent headers that match a RegexPatternSet with pattern +// B[a@]dB[o0]t . You can then configure AWS WAF to reject those requests. To +// create and configure a RegexMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRegexMatchSet request. +// - Submit a CreateRegexMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexMatchSet request. +// - Submit an UpdateRegexMatchSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value, using a RegexPatternSet , that you want AWS WAF to watch for. // -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of a -// CreateRegexMatchSet request. -// -// * Submit a CreateRegexMatchSet request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateRegexMatchSet request. -// -// * Submit an UpdateRegexMatchSet -// request to specify the part of the request that you want AWS WAF to inspect (for -// example, the header or the URI) and the value, using a RegexPatternSet, that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRegexMatchSet(ctx context.Context, params *CreateRegexMatchSetInput, optFns ...func(*Options)) (*CreateRegexMatchSetOutput, error) { if params == nil { params = &CreateRegexMatchSetInput{} @@ -60,13 +51,13 @@ func (c *Client) CreateRegexMatchSet(ctx context.Context, params *CreateRegexMat type CreateRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . // // This member is required. Name *string @@ -76,9 +67,9 @@ type CreateRegexMatchSetInput struct { type CreateRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the CreateRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // A RegexMatchSet that contains no RegexMatchTuple objects. diff --git a/service/waf/api_op_CreateRegexPatternSet.go b/service/waf/api_op_CreateRegexPatternSet.go index c73aac344e7..1efffb0843d 100644 --- a/service/waf/api_op_CreateRegexPatternSet.go +++ b/service/waf/api_op_CreateRegexPatternSet.go @@ -11,34 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to -// specify the regular expression (regex) pattern that you want AWS WAF to search -// for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those -// requests. To create and configure a RegexPatternSet, perform the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RegexPatternSet . You then use UpdateRegexPatternSet +// to specify the regular expression (regex) pattern that you want AWS WAF to +// search for, such as B[a@]dB[o0]t . You can then configure AWS WAF to reject +// those requests. To create and configure a RegexPatternSet , perform the +// following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRegexPatternSet request. +// - Submit a CreateRegexPatternSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexPatternSet request. +// - Submit an UpdateRegexPatternSet request to specify the string that you want +// AWS WAF to watch for. // -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateRegexPatternSet request. -// -// * Submit a -// CreateRegexPatternSet request. -// -// * Use GetChangeToken to get the change token -// that you provide in the ChangeToken parameter of an UpdateRegexPatternSet -// request. -// -// * Submit an UpdateRegexPatternSet request to specify the string that -// you want AWS WAF to watch for. -// -// For more information about how to use the AWS -// WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexPatternSetInput, optFns ...func(*Options)) (*CreateRegexPatternSetOutput, error) { if params == nil { params = &CreateRegexPatternSetInput{} @@ -56,13 +48,13 @@ func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexP type CreateRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . // // This member is required. Name *string @@ -74,7 +66,7 @@ type CreateRegexPatternSetOutput struct { // The ChangeToken that you used to submit the CreateRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // A RegexPatternSet that contains no objects. diff --git a/service/waf/api_op_CreateRule.go b/service/waf/api_op_CreateRule.go index 276f2991b6e..e289a31f7c4 100644 --- a/service/waf/api_op_CreateRule.go +++ b/service/waf/api_op_CreateRule.go @@ -11,53 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a Rule , which contains the IPSet objects, ByteMatchSet // objects, and other predicates that identify the requests that you want to block. -// If you add more than one predicate to a Rule, a request must match all of the +// If you add more than one predicate to a Rule , a request must match all of the // specifications to be allowed or blocked. For example, suppose that you add the -// following to a Rule: +// following to a Rule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An IPSet that matches the IP address 192.0.2.44/32 +// You then add the Rule to a WebACL and specify that you want to blocks requests +// that satisfy the Rule . For a request to be blocked, it must come from the IP +// address 192.0.2.44 and the User-Agent header in the request must contain the +// value BadBot . To create and configure a Rule , perform the following steps: +// - Create and update the predicates that you want to include in the Rule . For +// more information, see CreateByteMatchSet , CreateIPSet , and +// CreateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRule request. +// - Submit a CreateRule request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRule request to specify the predicates that you want to +// include in the Rule . +// - Create and update a WebACL that contains the Rule . For more information, +// see CreateWebACL . // -// * A -// ByteMatchSet that matches BadBot in the User-Agent header -// -// You then add the Rule -// to a WebACL and specify that you want to blocks requests that satisfy the Rule. -// For a request to be blocked, it must come from the IP address 192.0.2.44 and the -// User-Agent header in the request must contain the value BadBot. To create and -// configure a Rule, perform the following steps: -// -// * Create and update the -// predicates that you want to include in the Rule. For more information, see -// CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateRule request. -// -// * Submit a CreateRule request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateRule request. -// -// * Submit an UpdateRule request to specify -// the predicates that you want to include in the Rule. -// -// * Create and update a -// WebACL that contains the Rule. For more information, see CreateWebACL. -// -// For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} @@ -75,21 +60,21 @@ func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns type CreateRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this Rule. The name can + // A friendly name or description for the metrics for this Rule . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the Rule. + // metric after you create the Rule . // // This member is required. MetricName *string - // A friendly name or description of the Rule. You can't change the name of a Rule + // A friendly name or description of the Rule . You can't change the name of a Rule // after you create it. // // This member is required. @@ -103,9 +88,9 @@ type CreateRuleInput struct { type CreateRuleOutput struct { - // The ChangeToken that you used to submit the CreateRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // The Rule returned in the CreateRule response. diff --git a/service/waf/api_op_CreateRuleGroup.go b/service/waf/api_op_CreateRuleGroup.go index a260217e4e2..acfa07e77f3 100644 --- a/service/waf/api_op_CreateRuleGroup.go +++ b/service/waf/api_op_CreateRuleGroup.go @@ -11,28 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RuleGroup. A rule group is a collection of predefined +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RuleGroup . A rule group is a collection of predefined // rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the // rule group. Rule groups are subject to the following limits: +// - Three rule groups per account. You can request an increase to this limit by +// contacting customer support. +// - One rule group per web ACL. +// - Ten rules per rule group. // -// * Three rule -// groups per account. You can request an increase to this limit by contacting -// customer support. -// -// * One rule group per web ACL. -// -// * Ten rules per rule -// group. -// -// For more information about how to use the AWS WAF API to allow or block -// HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) { if params == nil { params = &CreateRuleGroupInput{} @@ -50,22 +43,22 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp type CreateRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . // // This member is required. MetricName *string - // A friendly name or description of the RuleGroup. You can't change Name after you - // create a RuleGroup. + // A friendly name or description of the RuleGroup . You can't change Name after + // you create a RuleGroup . // // This member is required. Name *string @@ -80,10 +73,10 @@ type CreateRuleGroupOutput struct { // The ChangeToken that you used to submit the CreateRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string - // An empty RuleGroup. + // An empty RuleGroup . RuleGroup *types.RuleGroup // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_CreateSizeConstraintSet.go b/service/waf/api_op_CreateSizeConstraintSet.go index efec1bc4e32..fc7e81edb90 100644 --- a/service/waf/api_op_CreateSizeConstraintSet.go +++ b/service/waf/api_op_CreateSizeConstraintSet.go @@ -11,38 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to -// identify the part of a web request that you want AWS WAF to check for length, -// such as the length of the User-Agent header or the length of the query string. -// For example, you can create a SizeConstraintSet that matches any requests that -// have a query string that is longer than 100 bytes. You can then configure AWS -// WAF to reject those requests. To create and configure a SizeConstraintSet, -// perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a SizeConstraintSet . You then use +// UpdateSizeConstraintSet to identify the part of a web request that you want AWS +// WAF to check for length, such as the length of the User-Agent header or the +// length of the query string. For example, you can create a SizeConstraintSet +// that matches any requests that have a query string that is longer than 100 +// bytes. You can then configure AWS WAF to reject those requests. To create and +// configure a SizeConstraintSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateSizeConstraintSet request. +// - Submit a CreateSizeConstraintSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSizeConstraintSet request. +// - Submit an UpdateSizeConstraintSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value that you want AWS WAF to watch for. // -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateSizeConstraintSet -// request. -// -// * Submit a CreateSizeConstraintSet request. -// -// * Use GetChangeToken to -// get the change token that you provide in the ChangeToken parameter of an -// UpdateSizeConstraintSet request. -// -// * Submit an UpdateSizeConstraintSet request to -// specify the part of the request that you want AWS WAF to inspect (for example, -// the header or the URI) and the value that you want AWS WAF to watch for. -// -// For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSizeConstraintSetInput, optFns ...func(*Options)) (*CreateSizeConstraintSetOutput, error) { if params == nil { params = &CreateSizeConstraintSetInput{} @@ -60,13 +51,13 @@ func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSize type CreateSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the SizeConstraintSet. You can't change Name - // after you create a SizeConstraintSet. + // A friendly name or description of the SizeConstraintSet . You can't change Name + // after you create a SizeConstraintSet . // // This member is required. Name *string @@ -76,9 +67,9 @@ type CreateSizeConstraintSetInput struct { type CreateSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the CreateSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // A SizeConstraintSet that contains no SizeConstraint objects. diff --git a/service/waf/api_op_CreateSqlInjectionMatchSet.go b/service/waf/api_op_CreateSqlInjectionMatchSet.go index c9a073584f4..0cbbf52328e 100644 --- a/service/waf/api_op_CreateSqlInjectionMatchSet.go +++ b/service/waf/api_op_CreateSqlInjectionMatchSet.go @@ -11,35 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a SqlInjectionMatchSet, which you use to allow, block, or -// count requests that contain snippets of SQL code in a specified part of web +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a SqlInjectionMatchSet , which you use to allow, block, +// or count requests that contain snippets of SQL code in a specified part of web // requests. AWS WAF searches for character sequences that are likely to be -// malicious strings. To create and configure a SqlInjectionMatchSet, perform the +// malicious strings. To create and configure a SqlInjectionMatchSet , perform the // following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateSqlInjectionMatchSet request. +// - Submit a CreateSqlInjectionMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSqlInjectionMatchSet request. +// - Submit an UpdateSqlInjectionMatchSet request to specify the parts of web +// requests in which you want to allow, block, or count malicious SQL code. // -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. -// -// * Submit -// a CreateSqlInjectionMatchSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an -// UpdateSqlInjectionMatchSet request. -// -// * Submit an UpdateSqlInjectionMatchSet -// request to specify the parts of web requests in which you want to allow, block, -// or count malicious SQL code. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateSqlInjectionMatchSet(ctx context.Context, params *CreateSqlInjectionMatchSetInput, optFns ...func(*Options)) (*CreateSqlInjectionMatchSetOutput, error) { if params == nil { params = &CreateSqlInjectionMatchSetInput{} @@ -55,16 +46,16 @@ func (c *Client) CreateSqlInjectionMatchSet(ctx context.Context, params *CreateS return out, nil } -// A request to create a SqlInjectionMatchSet. +// A request to create a SqlInjectionMatchSet . type CreateSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // A friendly name or description for the SqlInjectionMatchSet that you're - // creating. You can't change Name after you create the SqlInjectionMatchSet. + // creating. You can't change Name after you create the SqlInjectionMatchSet . // // This member is required. Name *string @@ -77,10 +68,10 @@ type CreateSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string - // A SqlInjectionMatchSet. + // A SqlInjectionMatchSet . SqlInjectionMatchSet *types.SqlInjectionMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_CreateWebACL.go b/service/waf/api_op_CreateWebACL.go index 93380572d80..9db0f3eeba6 100644 --- a/service/waf/api_op_CreateWebACL.go +++ b/service/waf/api_op_CreateWebACL.go @@ -11,45 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a WebACL, which contains the Rules that identify the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a WebACL , which contains the Rules that identify the // CloudFront web requests that you want to allow, block, or count. AWS WAF -// evaluates Rules in order based on the value of Priority for each Rule. You also -// specify a default action, either ALLOW or BLOCK. If a web request doesn't match -// any of the Rules in a WebACL, AWS WAF responds to the request with the default -// action. To create and configure a WebACL, perform the following steps: +// evaluates Rules in order based on the value of Priority for each Rule . You also +// specify a default action, either ALLOW or BLOCK . If a web request doesn't match +// any of the Rules in a WebACL , AWS WAF responds to the request with the default +// action. To create and configure a WebACL , perform the following steps: +// - Create and update the ByteMatchSet objects and other predicates that you +// want to include in Rules . For more information, see CreateByteMatchSet , +// UpdateByteMatchSet , CreateIPSet , UpdateIPSet , CreateSqlInjectionMatchSet , +// and UpdateSqlInjectionMatchSet . +// - Create and update the Rules that you want to include in the WebACL . For +// more information, see CreateRule and UpdateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateWebACL request. +// - Submit a CreateWebACL request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateWebACL request. +// - Submit an UpdateWebACL request to specify the Rules that you want to include +// in the WebACL , to specify the default action, and to associate the WebACL +// with a CloudFront distribution. // -// * Create -// and update the ByteMatchSet objects and other predicates that you want to -// include in Rules. For more information, see CreateByteMatchSet, -// UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and -// UpdateSqlInjectionMatchSet. -// -// * Create and update the Rules that you want to -// include in the WebACL. For more information, see CreateRule and UpdateRule. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateWebACL request. -// -// * Submit a CreateWebACL request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateWebACL request. -// -// * Submit an UpdateWebACL request to -// specify the Rules that you want to include in the WebACL, to specify the default -// action, and to associate the WebACL with a CloudFront distribution. -// -// For more -// information about how to use the AWS WAF API, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, optFns ...func(*Options)) (*CreateWebACLOutput, error) { if params == nil { params = &CreateWebACLInput{} @@ -67,29 +55,29 @@ func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, op type CreateWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The action that you want AWS WAF to take when a request doesn't match the // criteria specified in any of the Rule objects that are associated with the - // WebACL. + // WebACL . // // This member is required. DefaultAction *types.WafAction - // A friendly name or description for the metrics for this WebACL.The name can + // A friendly name or description for the metrics for this WebACL .The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the WebACL. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the WebACL . // // This member is required. MetricName *string - // A friendly name or description of the WebACL. You can't change Name after you - // create the WebACL. + // A friendly name or description of the WebACL . You can't change Name after you + // create the WebACL . // // This member is required. Name *string @@ -104,7 +92,7 @@ type CreateWebACLOutput struct { // The ChangeToken that you used to submit the CreateWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // The WebACL returned in the CreateWebACL response. diff --git a/service/waf/api_op_CreateWebACLMigrationStack.go b/service/waf/api_op_CreateWebACLMigrationStack.go index 3ef9564ddc8..b7335cc7023 100644 --- a/service/waf/api_op_CreateWebACLMigrationStack.go +++ b/service/waf/api_op_CreateWebACLMigrationStack.go @@ -17,10 +17,9 @@ import ( // part of a larger migration procedure for web ACLs from AWS WAF Classic to the // latest version of AWS WAF. For the full procedure, including caveats and manual // steps to complete the migration and switch over to the new web ACL, see -// Migrating your AWS WAF Classic resources to AWS WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html) -// in the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). +// Migrating your AWS WAF Classic resources to AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html) +// in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . func (c *Client) CreateWebACLMigrationStack(ctx context.Context, params *CreateWebACLMigrationStackInput, optFns ...func(*Options)) (*CreateWebACLMigrationStackOutput, error) { if params == nil { params = &CreateWebACLMigrationStackInput{} @@ -46,20 +45,15 @@ type CreateWebACLMigrationStackInput struct { // This member is required. IgnoreUnsupportedType *bool - // The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 - // bucket must be configured as follows for the migration: - // - // * The bucket name must - // start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl. - // - // * The - // bucket must be in the Region where you are deploying the template. For example, - // for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and - // you must deploy the template stack to us-west-2. - // - // * The bucket policies must - // permit the migration process to write data. For listings of the bucket policies, - // see the Examples section. + // The name of the Amazon S3 bucket to store the CloudFormation template in. The + // S3 bucket must be configured as follows for the migration: + // - The bucket name must start with aws-waf-migration- . For example, + // aws-waf-migration-my-web-acl . + // - The bucket must be in the Region where you are deploying the template. For + // example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in + // us-west-2 and you must deploy the template stack to us-west-2. + // - The bucket policies must permit the migration process to write data. For + // listings of the bucket policies, see the Examples section. // // This member is required. S3BucketName *string diff --git a/service/waf/api_op_CreateXssMatchSet.go b/service/waf/api_op_CreateXssMatchSet.go index 514476a1123..d1477886b81 100644 --- a/service/waf/api_op_CreateXssMatchSet.go +++ b/service/waf/api_op_CreateXssMatchSet.go @@ -11,35 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an XssMatchSet, which you use to allow, block, or count +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an XssMatchSet , which you use to allow, block, or count // requests that contain cross-site scripting attacks in the specified part of web // requests. AWS WAF searches for character sequences that are likely to be -// malicious strings. To create and configure an XssMatchSet, perform the following -// steps: +// malicious strings. To create and configure an XssMatchSet , perform the +// following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateXssMatchSet request. +// - Submit a CreateXssMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateXssMatchSet request. +// - Submit an UpdateXssMatchSet request to specify the parts of web requests in +// which you want to allow, block, or count cross-site scripting attacks. // -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateXssMatchSet request. -// -// * Submit a -// CreateXssMatchSet request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateXssMatchSet request. -// -// * -// Submit an UpdateXssMatchSet request to specify the parts of web requests in -// which you want to allow, block, or count cross-site scripting attacks. -// -// For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSetInput, optFns ...func(*Options)) (*CreateXssMatchSetOutput, error) { if params == nil { params = &CreateXssMatchSetInput{} @@ -55,16 +46,16 @@ func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSe return out, nil } -// A request to create an XssMatchSet. +// A request to create an XssMatchSet . type CreateXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // A friendly name or description for the XssMatchSet that you're creating. You - // can't change Name after you create the XssMatchSet. + // can't change Name after you create the XssMatchSet . // // This member is required. Name *string @@ -77,10 +68,10 @@ type CreateXssMatchSetOutput struct { // The ChangeToken that you used to submit the CreateXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string - // An XssMatchSet. + // An XssMatchSet . XssMatchSet *types.XssMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteByteMatchSet.go b/service/waf/api_op_DeleteByteMatchSet.go index 37b16bbdb30..653991444b8 100644 --- a/service/waf/api_op_DeleteByteMatchSet.go +++ b/service/waf/api_op_DeleteByteMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet -// if it's still used in any Rules or if it still includes any ByteMatchTuple -// objects (any filters). If you just want to remove a ByteMatchSet from a Rule, -// use UpdateRule. To permanently delete a ByteMatchSet, perform the following -// steps: -// -// * Update the ByteMatchSet to remove filters, if any. For more -// information, see UpdateByteMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of a DeleteByteMatchSet -// request. -// -// * Submit a DeleteByteMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a ByteMatchSet . You can't delete a +// ByteMatchSet if it's still used in any Rules or if it still includes any +// ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet +// from a Rule , use UpdateRule . To permanently delete a ByteMatchSet , perform +// the following steps: +// - Update the ByteMatchSet to remove filters, if any. For more information, see +// UpdateByteMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteByteMatchSet request. +// - Submit a DeleteByteMatchSet request. func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatchSetInput, optFns ...func(*Options)) (*DeleteByteMatchSetOutput, error) { if params == nil { params = &DeleteByteMatchSetInput{} @@ -48,12 +42,12 @@ func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatch type DeleteByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId - // is returned by CreateByteMatchSet and by ListByteMatchSets. + // is returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string @@ -65,7 +59,7 @@ type DeleteByteMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteGeoMatchSet.go b/service/waf/api_op_DeleteGeoMatchSet.go index d6943ce5aa7..95672acdae0 100644 --- a/service/waf/api_op_DeleteGeoMatchSet.go +++ b/service/waf/api_op_DeleteGeoMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if -// it's still used in any Rules or if it still includes any countries. If you just -// want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete -// a GeoMatchSet from AWS WAF, perform the following steps: -// -// * Update the -// GeoMatchSet to remove any countries. For more information, see -// UpdateGeoMatchSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of a DeleteGeoMatchSet request. -// -// * Submit a -// DeleteGeoMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a GeoMatchSet . You can't delete a +// GeoMatchSet if it's still used in any Rules or if it still includes any +// countries. If you just want to remove a GeoMatchSet from a Rule , use UpdateRule +// . To permanently delete a GeoMatchSet from AWS WAF, perform the following +// steps: +// - Update the GeoMatchSet to remove any countries. For more information, see +// UpdateGeoMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteGeoMatchSet request. +// - Submit a DeleteGeoMatchSet request. func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSetInput, optFns ...func(*Options)) (*DeleteGeoMatchSetOutput, error) { if params == nil { params = &DeleteGeoMatchSetInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSe type DeleteGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string @@ -65,7 +59,7 @@ type DeleteGeoMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteIPSet.go b/service/waf/api_op_DeleteIPSet.go index 9c6918f5db2..4e0e8f7c792 100644 --- a/service/waf/api_op_DeleteIPSet.go +++ b/service/waf/api_op_DeleteIPSet.go @@ -10,25 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an IPSet. You can't delete an IPSet if it's -// still used in any Rules or if it still includes any IP addresses. If you just -// want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an -// IPSet from AWS WAF, perform the following steps: -// -// * Update the IPSet to remove -// IP address ranges, if any. For more information, see UpdateIPSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteIPSet request. -// -// * Submit a DeleteIPSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an IPSet . You can't delete an IPSet if +// it's still used in any Rules or if it still includes any IP addresses. If you +// just want to remove an IPSet from a Rule , use UpdateRule . To permanently +// delete an IPSet from AWS WAF, perform the following steps: +// - Update the IPSet to remove IP address ranges, if any. For more information, +// see UpdateIPSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteIPSet request. +// - Submit a DeleteIPSet request. func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { params = &DeleteIPSetInput{} @@ -46,13 +40,13 @@ func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optF type DeleteIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The IPSetId of the IPSet that you want to delete. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string @@ -64,7 +58,7 @@ type DeleteIPSetOutput struct { // The ChangeToken that you used to submit the DeleteIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteLoggingConfiguration.go b/service/waf/api_op_DeleteLoggingConfiguration.go index c2fecbd31f5..3203d8041d4 100644 --- a/service/waf/api_op_DeleteLoggingConfiguration.go +++ b/service/waf/api_op_DeleteLoggingConfiguration.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes the LoggingConfiguration from the specified web -// ACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes the LoggingConfiguration from the specified +// web ACL. func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error) { if params == nil { params = &DeleteLoggingConfigurationInput{} @@ -36,7 +34,7 @@ func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteL type DeleteLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/waf/api_op_DeletePermissionPolicy.go b/service/waf/api_op_DeletePermissionPolicy.go index 3f33408497e..81b0e311c84 100644 --- a/service/waf/api_op_DeletePermissionPolicy.go +++ b/service/waf/api_op_DeletePermissionPolicy.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an IAM policy from the specified RuleGroup. The -// user making the request must be the owner of the RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an IAM policy from the specified RuleGroup. +// The user making the request must be the owner of the RuleGroup. func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error) { if params == nil { params = &DeletePermissionPolicyInput{} diff --git a/service/waf/api_op_DeleteRateBasedRule.go b/service/waf/api_op_DeleteRateBasedRule.go index 9f6908cb49f..ce4dcaf7e6e 100644 --- a/service/waf/api_op_DeleteRateBasedRule.go +++ b/service/waf/api_op_DeleteRateBasedRule.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RateBasedRule. You can't delete a rule if it's -// still used in any WebACL objects or if it still includes any predicates, such as -// ByteMatchSet objects. If you just want to remove a rule from a WebACL, use -// UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the -// following steps: -// -// * Update the RateBasedRule to remove predicates, if any. For -// more information, see UpdateRateBasedRule. -// -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of a -// DeleteRateBasedRule request. -// -// * Submit a DeleteRateBasedRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RateBasedRule . You can't delete a rule if +// it's still used in any WebACL objects or if it still includes any predicates, +// such as ByteMatchSet objects. If you just want to remove a rule from a WebACL , +// use UpdateWebACL . To permanently delete a RateBasedRule from AWS WAF, perform +// the following steps: +// - Update the RateBasedRule to remove predicates, if any. For more information, +// see UpdateRateBasedRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRateBasedRule request. +// - Submit a DeleteRateBasedRule request. func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBasedRuleInput, optFns ...func(*Options)) (*DeleteRateBasedRuleOutput, error) { if params == nil { params = &DeleteRateBasedRuleInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBase type DeleteRateBasedRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the RateBasedRule that you want to delete. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string @@ -63,9 +57,9 @@ type DeleteRateBasedRuleInput struct { type DeleteRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the DeleteRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteRegexMatchSet.go b/service/waf/api_op_DeleteRegexMatchSet.go index 2cdacfb373e..37e6cf4e4a5 100644 --- a/service/waf/api_op_DeleteRegexMatchSet.go +++ b/service/waf/api_op_DeleteRegexMatchSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RegexMatchSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RegexMatchSet . You can't delete a // RegexMatchSet if it's still used in any Rules or if it still includes any // RegexMatchTuples objects (any filters). If you just want to remove a -// RegexMatchSet from a Rule, use UpdateRule. To permanently delete a -// RegexMatchSet, perform the following steps: -// -// * Update the RegexMatchSet to -// remove filters, if any. For more information, see UpdateRegexMatchSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteRegexMatchSet request. -// -// * Submit a DeleteRegexMatchSet -// request. +// RegexMatchSet from a Rule , use UpdateRule . To permanently delete a +// RegexMatchSet , perform the following steps: +// - Update the RegexMatchSet to remove filters, if any. For more information, +// see UpdateRegexMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRegexMatchSet request. +// - Submit a DeleteRegexMatchSet request. func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMatchSetInput, optFns ...func(*Options)) (*DeleteRegexMatchSetOutput, error) { if params == nil { params = &DeleteRegexMatchSetInput{} @@ -48,13 +41,13 @@ func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMat type DeleteRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexMatchSetId of the RegexMatchSet that you want to delete. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -64,9 +57,9 @@ type DeleteRegexMatchSetInput struct { type DeleteRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteRegexPatternSet.go b/service/waf/api_op_DeleteRegexPatternSet.go index d8d0e136a30..d1f4a126243 100644 --- a/service/waf/api_op_DeleteRegexPatternSet.go +++ b/service/waf/api_op_DeleteRegexPatternSet.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RegexPatternSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RegexPatternSet . You can't delete a // RegexPatternSet if it's still used in any RegexMatchSet or if the // RegexPatternSet is not empty. func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error) { @@ -36,14 +34,14 @@ func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexP type DeleteRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexPatternSetId of the RegexPatternSet that you want to delete. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string @@ -55,7 +53,7 @@ type DeleteRegexPatternSetOutput struct { // The ChangeToken that you used to submit the DeleteRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteRule.go b/service/waf/api_op_DeleteRule.go index e9d999a91c4..3f8f7323ed8 100644 --- a/service/waf/api_op_DeleteRule.go +++ b/service/waf/api_op_DeleteRule.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a Rule. You can't delete a Rule if it's still -// used in any WebACL objects or if it still includes any predicates, such as -// ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use -// UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a Rule . You can't delete a Rule if it's +// still used in any WebACL objects or if it still includes any predicates, such +// as ByteMatchSet objects. If you just want to remove a Rule from a WebACL , use +// UpdateWebACL . To permanently delete a Rule from AWS WAF, perform the following // steps: -// -// * Update the Rule to remove predicates, if any. For more information, -// see UpdateRule. -// -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of a DeleteRule request. -// -// * Submit a DeleteRule -// request. +// - Update the Rule to remove predicates, if any. For more information, see +// UpdateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRule request. +// - Submit a DeleteRule request. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns type DeleteRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string @@ -63,9 +57,9 @@ type DeleteRuleInput struct { type DeleteRuleOutput struct { - // The ChangeToken that you used to submit the DeleteRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteRuleGroup.go b/service/waf/api_op_DeleteRuleGroup.go index c09c66ec1f4..5b7e0de6cef 100644 --- a/service/waf/api_op_DeleteRuleGroup.go +++ b/service/waf/api_op_DeleteRuleGroup.go @@ -10,25 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if -// it's still used in any WebACL objects or if it still includes any rules. If you -// just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently -// delete a RuleGroup from AWS WAF, perform the following steps: -// -// * Update the -// RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteRuleGroup request. -// -// * Submit a DeleteRuleGroup request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RuleGroup . You can't delete a RuleGroup +// if it's still used in any WebACL objects or if it still includes any rules. If +// you just want to remove a RuleGroup from a WebACL , use UpdateWebACL . To +// permanently delete a RuleGroup from AWS WAF, perform the following steps: +// - Update the RuleGroup to remove rules, if any. For more information, see +// UpdateRuleGroup . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRuleGroup request. +// - Submit a DeleteRuleGroup request. func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -46,13 +40,13 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string @@ -64,7 +58,7 @@ type DeleteRuleGroupOutput struct { // The ChangeToken that you used to submit the DeleteRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteSizeConstraintSet.go b/service/waf/api_op_DeleteSizeConstraintSet.go index 908724c82d3..a3d3b399e2e 100644 --- a/service/waf/api_op_DeleteSizeConstraintSet.go +++ b/service/waf/api_op_DeleteSizeConstraintSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a SizeConstraintSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a SizeConstraintSet . You can't delete a // SizeConstraintSet if it's still used in any Rules or if it still includes any // SizeConstraint objects (any filters). If you just want to remove a -// SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a -// SizeConstraintSet, perform the following steps: -// -// * Update the SizeConstraintSet -// to remove filters, if any. For more information, see UpdateSizeConstraintSet. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteSizeConstraintSet request. -// -// * Submit a -// DeleteSizeConstraintSet request. +// SizeConstraintSet from a Rule , use UpdateRule . To permanently delete a +// SizeConstraintSet , perform the following steps: +// - Update the SizeConstraintSet to remove filters, if any. For more +// information, see UpdateSizeConstraintSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteSizeConstraintSet request. +// - Submit a DeleteSizeConstraintSet request. func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSizeConstraintSetInput, optFns ...func(*Options)) (*DeleteSizeConstraintSetOutput, error) { if params == nil { params = &DeleteSizeConstraintSetInput{} @@ -48,14 +41,14 @@ func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSize type DeleteSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SizeConstraintSetId of the SizeConstraintSet that you want to delete. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -65,9 +58,9 @@ type DeleteSizeConstraintSetInput struct { type DeleteSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteSqlInjectionMatchSet.go b/service/waf/api_op_DeleteSqlInjectionMatchSet.go index cb69b7df9ce..c6c1a5459cb 100644 --- a/service/waf/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/waf/api_op_DeleteSqlInjectionMatchSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a -// SqlInjectionMatchSet if it's still used in any Rules or if it still contains any -// SqlInjectionMatchTuple objects. If you just want to remove a -// SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a SqlInjectionMatchSet . You can't delete a +// SqlInjectionMatchSet if it's still used in any Rules or if it still contains +// any SqlInjectionMatchTuple objects. If you just want to remove a +// SqlInjectionMatchSet from a Rule , use UpdateRule . To permanently delete a // SqlInjectionMatchSet from AWS WAF, perform the following steps: -// -// * Update the -// SqlInjectionMatchSet to remove filters, if any. For more information, see -// UpdateSqlInjectionMatchSet. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet -// request. -// -// * Submit a DeleteSqlInjectionMatchSet request. +// - Update the SqlInjectionMatchSet to remove filters, if any. For more +// information, see UpdateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteSqlInjectionMatchSet request. +// - Submit a DeleteSqlInjectionMatchSet request. func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteSqlInjectionMatchSetInput, optFns ...func(*Options)) (*DeleteSqlInjectionMatchSetOutput, error) { if params == nil { params = &DeleteSqlInjectionMatchSetInput{} @@ -49,14 +42,14 @@ func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteS // A request to delete a SqlInjectionMatchSet from AWS WAF. type DeleteSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -69,7 +62,7 @@ type DeleteSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteWebACL.go b/service/waf/api_op_DeleteWebACL.go index aa1130f9f96..677736b3e3e 100644 --- a/service/waf/api_op_DeleteWebACL.go +++ b/service/waf/api_op_DeleteWebACL.go @@ -10,23 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a WebACL. You can't delete a WebACL if it still -// contains any Rules. To delete a WebACL, perform the following steps: -// -// * Update -// the WebACL to remove Rules, if any. For more information, see UpdateWebACL. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteWebACL request. -// -// * Submit a DeleteWebACL request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a WebACL . You can't delete a WebACL if it +// still contains any Rules . To delete a WebACL , perform the following steps: +// - Update the WebACL to remove Rules , if any. For more information, see +// UpdateWebACL . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteWebACL request. +// - Submit a DeleteWebACL request. func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error) { if params == nil { params = &DeleteWebACLInput{} @@ -44,13 +38,13 @@ func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, op type DeleteWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The WebACLId of the WebACL that you want to delete. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -62,7 +56,7 @@ type DeleteWebACLOutput struct { // The ChangeToken that you used to submit the DeleteWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_DeleteXssMatchSet.go b/service/waf/api_op_DeleteXssMatchSet.go index ca004195a8e..1f6b838d780 100644 --- a/service/waf/api_op_DeleteXssMatchSet.go +++ b/service/waf/api_op_DeleteXssMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an XssMatchSet. You can't delete an XssMatchSet -// if it's still used in any Rules or if it still contains any XssMatchTuple -// objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. -// To permanently delete an XssMatchSet from AWS WAF, perform the following -// steps: -// -// * Update the XssMatchSet to remove filters, if any. For more -// information, see UpdateXssMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of a DeleteXssMatchSet -// request. -// -// * Submit a DeleteXssMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an XssMatchSet . You can't delete an +// XssMatchSet if it's still used in any Rules or if it still contains any +// XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule , +// use UpdateRule . To permanently delete an XssMatchSet from AWS WAF, perform the +// following steps: +// - Update the XssMatchSet to remove filters, if any. For more information, see +// UpdateXssMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteXssMatchSet request. +// - Submit a DeleteXssMatchSet request. func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSetInput, optFns ...func(*Options)) (*DeleteXssMatchSetOutput, error) { if params == nil { params = &DeleteXssMatchSetInput{} @@ -48,13 +42,13 @@ func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSe // A request to delete an XssMatchSet from AWS WAF. type DeleteXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -67,7 +61,7 @@ type DeleteXssMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetByteMatchSet.go b/service/waf/api_op_GetByteMatchSet.go index 99c24b145e7..b009ff24458 100644 --- a/service/waf/api_op_GetByteMatchSet.go +++ b/service/waf/api_op_GetByteMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the ByteMatchSet specified by ByteMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the ByteMatchSet specified by ByteMatchSetId . func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInput, optFns ...func(*Options)) (*GetByteMatchSetOutput, error) { if params == nil { params = &GetByteMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInp type GetByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is - // returned by CreateByteMatchSet and by ListByteMatchSets. + // returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string @@ -48,16 +46,11 @@ type GetByteMatchSetOutput struct { // Information about the ByteMatchSet that you specified in the GetByteMatchSet // request. For more information, see the following topics: - // - // * ByteMatchSet: - // Contains ByteMatchSetId, ByteMatchTuples, and Name - // - // * ByteMatchTuples: Contains - // an array of ByteMatchTuple objects. Each ByteMatchTuple object contains - // FieldToMatch, PositionalConstraint, TargetString, and TextTransformation - // - // * - // FieldToMatch: Contains Data and Type + // - ByteMatchSet : Contains ByteMatchSetId , ByteMatchTuples , and Name + // - ByteMatchTuples : Contains an array of ByteMatchTuple objects. Each + // ByteMatchTuple object contains FieldToMatch , PositionalConstraint , + // TargetString , and TextTransformation + // - FieldToMatch : Contains Data and Type ByteMatchSet *types.ByteMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetChangeToken.go b/service/waf/api_op_GetChangeToken.go index 490928f67fd..53277949823 100644 --- a/service/waf/api_op_GetChangeToken.go +++ b/service/waf/api_op_GetChangeToken.go @@ -10,21 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. When you want to create, update, or delete AWS WAF objects, get a -// change token and include the change token in the create, update, or delete +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. When you want to create, update, or delete AWS WAF objects, get +// a change token and include the change token in the create, update, or delete // request. Change tokens ensure that your application doesn't submit conflicting // requests to AWS WAF. Each create, update, or delete request must use a unique // change token. If your application submits a GetChangeToken request and then // submits a second GetChangeToken request before submitting a create, update, or // delete request, the second GetChangeToken request returns the same value as the // first GetChangeToken request. When you use a change token in a create, update, -// or delete request, the status of the change token changes to PENDING, which +// or delete request, the status of the change token changes to PENDING , which // indicates that AWS WAF is propagating the change to all AWS WAF servers. Use // GetChangeTokenStatus to determine the status of your change token. func (c *Client) GetChangeToken(ctx context.Context, params *GetChangeTokenInput, optFns ...func(*Options)) (*GetChangeTokenOutput, error) { diff --git a/service/waf/api_op_GetChangeTokenStatus.go b/service/waf/api_op_GetChangeTokenStatus.go index 1712e7c71e1..c24dd2dbec4 100644 --- a/service/waf/api_op_GetChangeTokenStatus.go +++ b/service/waf/api_op_GetChangeTokenStatus.go @@ -11,24 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the status of a ChangeToken that you got by calling -// GetChangeToken. ChangeTokenStatus is one of the following values: -// -// * -// PROVISIONED: You requested the change token by calling GetChangeToken, but you -// haven't used it yet in a call to create, update, or delete an AWS WAF object. -// -// * -// PENDING: AWS WAF is propagating the create, update, or delete request to all AWS -// WAF servers. -// -// * INSYNC: Propagation is complete. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the status of a ChangeToken that you got by calling +// GetChangeToken . ChangeTokenStatus is one of the following values: +// - PROVISIONED : You requested the change token by calling GetChangeToken , but +// you haven't used it yet in a call to create, update, or delete an AWS WAF +// object. +// - PENDING : AWS WAF is propagating the create, update, or delete request to +// all AWS WAF servers. +// - INSYNC : Propagation is complete. func (c *Client) GetChangeTokenStatus(ctx context.Context, params *GetChangeTokenStatusInput, optFns ...func(*Options)) (*GetChangeTokenStatusOutput, error) { if params == nil { params = &GetChangeTokenStatusInput{} diff --git a/service/waf/api_op_GetGeoMatchSet.go b/service/waf/api_op_GetGeoMatchSet.go index a37a8b67837..06a91da3321 100644 --- a/service/waf/api_op_GetGeoMatchSet.go +++ b/service/waf/api_op_GetGeoMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the GeoMatchSet that is specified by GeoMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId . func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput, optFns ...func(*Options)) (*GetGeoMatchSetOutput, error) { if params == nil { params = &GetGeoMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput type GetGeoMatchSetInput struct { // The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string @@ -47,8 +45,8 @@ type GetGeoMatchSetInput struct { type GetGeoMatchSetOutput struct { // Information about the GeoMatchSet that you specified in the GetGeoMatchSet - // request. This includes the Type, which for a GeoMatchContraint is always - // Country, as well as the Value, which is the identifier for a specific country. + // request. This includes the Type , which for a GeoMatchContraint is always + // Country , as well as the Value , which is the identifier for a specific country. GeoMatchSet *types.GeoMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetIPSet.go b/service/waf/api_op_GetIPSet.go index 2c5837f043b..06806eebbe0 100644 --- a/service/waf/api_op_GetIPSet.go +++ b/service/waf/api_op_GetIPSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the IPSet that is specified by IPSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the IPSet that is specified by IPSetId . func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ... type GetIPSetInput struct { // The IPSetId of the IPSet that you want to get. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string @@ -46,14 +44,11 @@ type GetIPSetInput struct { type GetIPSetOutput struct { - // Information about the IPSet that you specified in the GetIPSet request. For more - // information, see the following topics: - // - // * IPSet: Contains IPSetDescriptors, - // IPSetId, and Name - // - // * IPSetDescriptors: Contains an array of IPSetDescriptor - // objects. Each IPSetDescriptor object contains Type and Value + // Information about the IPSet that you specified in the GetIPSet request. For + // more information, see the following topics: + // - IPSet : Contains IPSetDescriptors , IPSetId , and Name + // - IPSetDescriptors : Contains an array of IPSetDescriptor objects. Each + // IPSetDescriptor object contains Type and Value IPSet *types.IPSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetLoggingConfiguration.go b/service/waf/api_op_GetLoggingConfiguration.go index fc51c089369..b0f8bc0a890 100644 --- a/service/waf/api_op_GetLoggingConfiguration.go +++ b/service/waf/api_op_GetLoggingConfiguration.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the LoggingConfiguration for the specified web ACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the LoggingConfiguration for the specified web ACL. func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error) { if params == nil { params = &GetLoggingConfigurationInput{} @@ -36,7 +34,7 @@ func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLogging type GetLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL for which you want to get the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/waf/api_op_GetPermissionPolicy.go b/service/waf/api_op_GetPermissionPolicy.go index 4a993128dca..85e44ae8010 100644 --- a/service/waf/api_op_GetPermissionPolicy.go +++ b/service/waf/api_op_GetPermissionPolicy.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the IAM policy attached to the RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the IAM policy attached to the RuleGroup. func (c *Client) GetPermissionPolicy(ctx context.Context, params *GetPermissionPolicyInput, optFns ...func(*Options)) (*GetPermissionPolicyOutput, error) { if params == nil { params = &GetPermissionPolicyInput{} diff --git a/service/waf/api_op_GetRateBasedRule.go b/service/waf/api_op_GetRateBasedRule.go index 813c3db5559..4b11c263bf5 100644 --- a/service/waf/api_op_GetRateBasedRule.go +++ b/service/waf/api_op_GetRateBasedRule.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RateBasedRule that is specified by the RuleId that you -// included in the GetRateBasedRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RateBasedRule that is specified by the RuleId that +// you included in the GetRateBasedRule request. func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleInput, optFns ...func(*Options)) (*GetRateBasedRuleOutput, error) { if params == nil { params = &GetRateBasedRuleInput{} @@ -37,7 +35,7 @@ func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleI type GetRateBasedRuleInput struct { // The RuleId of the RateBasedRule that you want to get. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string diff --git a/service/waf/api_op_GetRateBasedRuleManagedKeys.go b/service/waf/api_op_GetRateBasedRuleManagedKeys.go index 413b880f33f..269e5697a60 100644 --- a/service/waf/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/waf/api_op_GetRateBasedRuleManagedKeys.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of IP addresses currently being blocked by the -// RateBasedRule that is specified by the RuleId. The maximum number of managed +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of IP addresses currently being blocked by the +// RateBasedRule that is specified by the RuleId . The maximum number of managed // keys that will be blocked is 10,000. If more than 10,000 addresses exceed the // rate limit, the 10,000 addresses with the highest rates will be blocked. func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRateBasedRuleManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedRuleManagedKeysOutput, error) { @@ -37,8 +35,8 @@ func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRat type GetRateBasedRuleManagedKeysInput struct { - // The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. - // RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + // The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys + // . RuleId is returned by CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string @@ -52,7 +50,7 @@ type GetRateBasedRuleManagedKeysInput struct { type GetRateBasedRuleManagedKeysOutput struct { // An array of IP addresses that currently are blocked by the specified - // RateBasedRule. + // RateBasedRule . ManagedKeys []string // A null value and not currently used. diff --git a/service/waf/api_op_GetRegexMatchSet.go b/service/waf/api_op_GetRegexMatchSet.go index 4226c222be9..6a18902e2f6 100644 --- a/service/waf/api_op_GetRegexMatchSet.go +++ b/service/waf/api_op_GetRegexMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RegexMatchSet specified by RegexMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RegexMatchSet specified by RegexMatchSetId . func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetInput, optFns ...func(*Options)) (*GetRegexMatchSetOutput, error) { if params == nil { params = &GetRegexMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetI type GetRegexMatchSetInput struct { // The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId - // is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -47,7 +45,7 @@ type GetRegexMatchSetInput struct { type GetRegexMatchSetOutput struct { // Information about the RegexMatchSet that you specified in the GetRegexMatchSet - // request. For more information, see RegexMatchTuple. + // request. For more information, see RegexMatchTuple . RegexMatchSet *types.RegexMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetRegexPatternSet.go b/service/waf/api_op_GetRegexPatternSet.go index 1c97e15eab2..a58b9935d42 100644 --- a/service/waf/api_op_GetRegexPatternSet.go +++ b/service/waf/api_op_GetRegexPatternSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RegexPatternSet specified by RegexPatternSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RegexPatternSet specified by RegexPatternSetId . func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error) { if params == nil { params = &GetRegexPatternSetInput{} @@ -37,7 +35,7 @@ type GetRegexPatternSetInput struct { // The RegexPatternSetId of the RegexPatternSet that you want to get. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string diff --git a/service/waf/api_op_GetRule.go b/service/waf/api_op_GetRule.go index 3d9574d7c91..f3510ce1be9 100644 --- a/service/waf/api_op_GetRule.go +++ b/service/waf/api_op_GetRule.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the Rule that is specified by the RuleId that you included -// in the GetRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the Rule that is specified by the RuleId that you +// included in the GetRule request. func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { params = &GetRuleInput{} @@ -37,7 +35,7 @@ func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...fu type GetRuleInput struct { // The RuleId of the Rule that you want to get. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string @@ -49,12 +47,9 @@ type GetRuleOutput struct { // Information about the Rule that you specified in the GetRule request. For more // information, see the following topics: - // - // * Rule: Contains MetricName, Name, an - // array of Predicate objects, and RuleId - // - // * Predicate: Each Predicate object - // contains DataId, Negated, and Type + // - Rule : Contains MetricName , Name , an array of Predicate objects, and + // RuleId + // - Predicate : Each Predicate object contains DataId , Negated , and Type Rule *types.Rule // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetRuleGroup.go b/service/waf/api_op_GetRuleGroup.go index 6612973935e..b544cb15abd 100644 --- a/service/waf/api_op_GetRuleGroup.go +++ b/service/waf/api_op_GetRuleGroup.go @@ -11,15 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RuleGroup that is specified by the RuleGroupId that you -// included in the GetRuleGroup request. To view the rules in a rule group, use -// ListActivatedRulesInRuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RuleGroup that is specified by the RuleGroupId that +// you included in the GetRuleGroup request. To view the rules in a rule group, +// use ListActivatedRulesInRuleGroup . func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) { if params == nil { params = &GetRuleGroupInput{} @@ -38,7 +36,7 @@ func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, op type GetRuleGroupInput struct { // The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned - // by CreateRuleGroup and by ListRuleGroups. + // by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string diff --git a/service/waf/api_op_GetSampledRequests.go b/service/waf/api_op_GetSampledRequests.go index 606b1d74913..6933da9b93e 100644 --- a/service/waf/api_op_GetSampledRequests.go +++ b/service/waf/api_op_GetSampledRequests.go @@ -11,22 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Gets detailed information about a specified number of requests--a -// sample--that AWS WAF randomly selects from among the first 5,000 requests that -// your AWS resource received during a time range that you choose. You can specify -// a sample size of up to 500 requests, and you can specify any time range in the -// previous three hours. GetSampledRequests returns a time range, which is usually -// the time range that you specified. However, if your resource (such as a -// CloudFront distribution) received 5,000 requests before the specified time range -// elapsed, GetSampledRequests returns an updated time range. This new time range -// indicates the actual period during which AWS WAF selected the requests in the -// sample. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Gets detailed information about a specified number of +// requests--a sample--that AWS WAF randomly selects from among the first 5,000 +// requests that your AWS resource received during a time range that you choose. +// You can specify a sample size of up to 500 requests, and you can specify any +// time range in the previous three hours. GetSampledRequests returns a time +// range, which is usually the time range that you specified. However, if your +// resource (such as a CloudFront distribution) received 5,000 requests before the +// specified time range elapsed, GetSampledRequests returns an updated time range. +// This new time range indicates the actual period during which AWS WAF selected +// the requests in the sample. func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error) { if params == nil { params = &GetSampledRequestsInput{} @@ -46,20 +44,17 @@ type GetSampledRequestsInput struct { // The number of requests that you want AWS WAF to return from among the first // 5,000 requests that your AWS resource received during the time range. If your - // resource received fewer requests than the value of MaxItems, GetSampledRequests + // resource received fewer requests than the value of MaxItems , GetSampledRequests // returns information about all of them. // // This member is required. MaxItems int64 // RuleId is one of three values: - // - // * The RuleId of the Rule or the RuleGroupId of - // the RuleGroup for which you want GetSampledRequests to return a sample of - // requests. - // - // * Default_Action, which causes GetSampledRequests to return a sample - // of the requests that didn't match any of the rules in the specified WebACL. + // - The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you + // want GetSampledRequests to return a sample of requests. + // - Default_Action , which causes GetSampledRequests to return a sample of the + // requests that didn't match any of the rules in the specified WebACL . // // This member is required. RuleId *string @@ -67,7 +62,7 @@ type GetSampledRequestsInput struct { // The start date and time and the end date and time of the range for which you // want GetSampledRequests to return a sample of requests. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // special designator, Z . For example, "2016-09-27T14:50Z" . You can specify any // time range in the previous three hours. // // This member is required. @@ -85,7 +80,7 @@ type GetSampledRequestsInput struct { type GetSampledRequestsOutput struct { // The total number of requests from which GetSampledRequests got a sample of - // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes + // MaxItems requests. If PopulationSize is less than MaxItems , the sample includes // every request that your AWS resource received during the specified time range. PopulationSize int64 diff --git a/service/waf/api_op_GetSizeConstraintSet.go b/service/waf/api_op_GetSizeConstraintSet.go index eff70826562..19b24259a92 100644 --- a/service/waf/api_op_GetSizeConstraintSet.go +++ b/service/waf/api_op_GetSizeConstraintSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the SizeConstraintSet specified by SizeConstraintSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId . func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstraintSetInput, optFns ...func(*Options)) (*GetSizeConstraintSetOutput, error) { if params == nil { params = &GetSizeConstraintSetInput{} @@ -37,7 +35,7 @@ type GetSizeConstraintSetInput struct { // The SizeConstraintSetId of the SizeConstraintSet that you want to get. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -49,16 +47,12 @@ type GetSizeConstraintSetOutput struct { // Information about the SizeConstraintSet that you specified in the // GetSizeConstraintSet request. For more information, see the following topics: - // - // * - // SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name - // - // * - // SizeConstraints: Contains an array of SizeConstraint objects. Each - // SizeConstraint object contains FieldToMatch, TextTransformation, - // ComparisonOperator, and Size - // - // * FieldToMatch: Contains Data and Type + // - SizeConstraintSet : Contains SizeConstraintSetId , SizeConstraints , and + // Name + // - SizeConstraints : Contains an array of SizeConstraint objects. Each + // SizeConstraint object contains FieldToMatch , TextTransformation , + // ComparisonOperator , and Size + // - FieldToMatch : Contains Data and Type SizeConstraintSet *types.SizeConstraintSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetSqlInjectionMatchSet.go b/service/waf/api_op_GetSqlInjectionMatchSet.go index c8b0326d3d5..5acb375bdc3 100644 --- a/service/waf/api_op_GetSqlInjectionMatchSet.go +++ b/service/waf/api_op_GetSqlInjectionMatchSet.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the SqlInjectionMatchSet that is specified by -// SqlInjectionMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the SqlInjectionMatchSet that is specified by +// SqlInjectionMatchSetId . func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInjectionMatchSetInput, optFns ...func(*Options)) (*GetSqlInjectionMatchSetOutput, error) { if params == nil { params = &GetSqlInjectionMatchSetInput{} @@ -34,12 +32,12 @@ func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInje return out, nil } -// A request to get a SqlInjectionMatchSet. +// A request to get a SqlInjectionMatchSet . type GetSqlInjectionMatchSetInput struct { // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -51,17 +49,12 @@ type GetSqlInjectionMatchSetInput struct { type GetSqlInjectionMatchSetOutput struct { // Information about the SqlInjectionMatchSet that you specified in the - // GetSqlInjectionMatchSet request. For more information, see the following - // topics: - // - // * SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an - // array of SqlInjectionMatchTuple objects - // - // * SqlInjectionMatchTuple: Each - // SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation - // - // * - // FieldToMatch: Contains Data and Type + // GetSqlInjectionMatchSet request. For more information, see the following topics: + // - SqlInjectionMatchSet : Contains Name , SqlInjectionMatchSetId , and an array + // of SqlInjectionMatchTuple objects + // - SqlInjectionMatchTuple : Each SqlInjectionMatchTuple object contains + // FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type SqlInjectionMatchSet *types.SqlInjectionMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetWebACL.go b/service/waf/api_op_GetWebACL.go index 003688b0808..380b37afeea 100644 --- a/service/waf/api_op_GetWebACL.go +++ b/service/waf/api_op_GetWebACL.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the WebACL that is specified by WebACLId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the WebACL that is specified by WebACLId . func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error) { if params == nil { params = &GetWebACLInput{} @@ -36,7 +34,7 @@ func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns . type GetWebACLInput struct { // The WebACLId of the WebACL that you want to get. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -48,17 +46,12 @@ type GetWebACLOutput struct { // Information about the WebACL that you specified in the GetWebACL request. For // more information, see the following topics: - // - // * WebACL: Contains DefaultAction, - // MetricName, Name, an array of Rule objects, and WebACLId - // - // * DefaultAction (Data - // type is WafAction): Contains Type - // - // * Rules: Contains an array of ActivatedRule - // objects, which contain Action, Priority, and RuleId - // - // * Action: Contains Type + // - WebACL : Contains DefaultAction , MetricName , Name , an array of Rule + // objects, and WebACLId + // - DefaultAction (Data type is WafAction ): Contains Type + // - Rules : Contains an array of ActivatedRule objects, which contain Action , + // Priority , and RuleId + // - Action : Contains Type WebACL *types.WebACL // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetXssMatchSet.go b/service/waf/api_op_GetXssMatchSet.go index 8532b2b3175..dfbfcbbc42c 100644 --- a/service/waf/api_op_GetXssMatchSet.go +++ b/service/waf/api_op_GetXssMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the XssMatchSet that is specified by XssMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the XssMatchSet that is specified by XssMatchSetId . func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput, optFns ...func(*Options)) (*GetXssMatchSetOutput, error) { if params == nil { params = &GetXssMatchSetInput{} @@ -33,11 +31,11 @@ func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput return out, nil } -// A request to get an XssMatchSet. +// A request to get an XssMatchSet . type GetXssMatchSetInput struct { // The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -50,15 +48,11 @@ type GetXssMatchSetOutput struct { // Information about the XssMatchSet that you specified in the GetXssMatchSet // request. For more information, see the following topics: - // - // * XssMatchSet: - // Contains Name, XssMatchSetId, and an array of XssMatchTuple objects - // - // * - // XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // - XssMatchSet : Contains Name , XssMatchSetId , and an array of XssMatchTuple + // objects + // - XssMatchTuple : Each XssMatchTuple object contains FieldToMatch and + // TextTransformation + // - FieldToMatch : Contains Data and Type XssMatchSet *types.XssMatchSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_ListActivatedRulesInRuleGroup.go b/service/waf/api_op_ListActivatedRulesInRuleGroup.go index 065e3fb4d90..897992c394c 100644 --- a/service/waf/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/waf/api_op_ListActivatedRulesInRuleGroup.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of ActivatedRule objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of ActivatedRule objects. func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *ListActivatedRulesInRuleGroupInput, optFns ...func(*Options)) (*ListActivatedRulesInRuleGroupOutput, error) { if params == nil { params = &ListActivatedRulesInRuleGroupInput{} @@ -37,15 +35,15 @@ type ListActivatedRulesInRuleGroupInput struct { // Specifies the number of ActivatedRules that you want AWS WAF to return for this // request. If you have more ActivatedRules than the number that you specify for - // Limit, the response includes a NextMarker value that you can use to get another - // batch of ActivatedRules. + // Limit , the response includes a NextMarker value that you can use to get + // another batch of ActivatedRules . Limit int32 - // If you specify a value for Limit and you have more ActivatedRules than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of ActivatedRules. For the second and subsequent - // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the - // previous response to get information about another batch of ActivatedRules. + // If you specify a value for Limit and you have more ActivatedRules than the + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of ActivatedRules . For the second and subsequent + // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from + // the previous response to get information about another batch of ActivatedRules . NextMarker *string // The RuleGroupId of the RuleGroup for which you want to get a list of @@ -62,7 +60,7 @@ type ListActivatedRulesInRuleGroupOutput struct { // If you have more ActivatedRules than the number that you specified for Limit in // the request, the response includes a NextMarker value. To list more - // ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and + // ActivatedRules , submit another ListActivatedRulesInRuleGroup request, and // specify the NextMarker value from the response in the NextMarker value in the // next request. NextMarker *string diff --git a/service/waf/api_op_ListByteMatchSets.go b/service/waf/api_op_ListByteMatchSets.go index 90a8910b372..78c191d7b34 100644 --- a/service/waf/api_op_ListByteMatchSets.go +++ b/service/waf/api_op_ListByteMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of ByteMatchSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of ByteMatchSetSummary objects. func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSetsInput, optFns ...func(*Options)) (*ListByteMatchSetsOutput, error) { if params == nil { params = &ListByteMatchSetsInput{} @@ -35,17 +33,17 @@ func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSet type ListByteMatchSetsInput struct { - // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for - // this request. If you have more ByteMatchSets objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of ByteMatchSet objects. + // Specifies the number of ByteMatchSet objects that you want AWS WAF to return + // for this request. If you have more ByteMatchSets objects than the number you + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of ByteMatchSet objects. Limit int32 // If you specify a value for Limit and you have more ByteMatchSets than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of ByteMatchSets. For the second and subsequent + // of Limit , AWS WAF returns a NextMarker value in the response that allows you + // to list another group of ByteMatchSets . For the second and subsequent // ListByteMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of ByteMatchSets. + // response to get information about another batch of ByteMatchSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/waf/api_op_ListGeoMatchSets.go b/service/waf/api_op_ListGeoMatchSets.go index b309a29bc63..4586a50422a 100644 --- a/service/waf/api_op_ListGeoMatchSets.go +++ b/service/waf/api_op_ListGeoMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of GeoMatchSetSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of GeoMatchSetSummary objects in the response. func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsInput, optFns ...func(*Options)) (*ListGeoMatchSetsOutput, error) { if params == nil { params = &ListGeoMatchSetsInput{} @@ -37,13 +35,13 @@ type ListGeoMatchSetsInput struct { // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for // this request. If you have more GeoMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get + // for Limit , the response includes a NextMarker value that you can use to get // another batch of GeoMatchSet objects. Limit int32 - // If you specify a value for Limit and you have more GeoMatchSets than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of GeoMatchSet objects. For the second and subsequent + // If you specify a value for Limit and you have more GeoMatchSet s than the value + // of Limit , AWS WAF returns a NextMarker value in the response that allows you + // to list another group of GeoMatchSet objects. For the second and subsequent // ListGeoMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of GeoMatchSet objects. NextMarker *string diff --git a/service/waf/api_op_ListIPSets.go b/service/waf/api_op_ListIPSets.go index b2936cd1c6f..e7325010223 100644 --- a/service/waf/api_op_ListIPSets.go +++ b/service/waf/api_op_ListIPSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of IPSetSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of IPSetSummary objects in the response. func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error) { if params == nil { params = &ListIPSetsInput{} @@ -36,15 +34,15 @@ func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns type ListIPSetsInput struct { // Specifies the number of IPSet objects that you want AWS WAF to return for this - // request. If you have more IPSet objects than the number you specify for Limit, + // request. If you have more IPSet objects than the number you specify for Limit , // the response includes a NextMarker value that you can use to get another batch // of IPSet objects. Limit int32 // AWS WAF returns a NextMarker value in the response that allows you to list - // another group of IPSets. For the second and subsequent ListIPSets requests, + // another group of IPSets . For the second and subsequent ListIPSets requests, // specify the value of NextMarker from the previous response to get information - // about another batch of IPSets. + // about another batch of IPSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/waf/api_op_ListLoggingConfigurations.go b/service/waf/api_op_ListLoggingConfigurations.go index 8e779e83050..6b942b1d7d9 100644 --- a/service/waf/api_op_ListLoggingConfigurations.go +++ b/service/waf/api_op_ListLoggingConfigurations.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of LoggingConfiguration objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of LoggingConfiguration objects. func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error) { if params == nil { params = &ListLoggingConfigurationsInput{} @@ -37,16 +35,16 @@ type ListLoggingConfigurationsInput struct { // Specifies the number of LoggingConfigurations that you want AWS WAF to return // for this request. If you have more LoggingConfigurations than the number that - // you specify for Limit, the response includes a NextMarker value that you can use - // to get another batch of LoggingConfigurations. + // you specify for Limit , the response includes a NextMarker value that you can + // use to get another batch of LoggingConfigurations . Limit int32 // If you specify a value for Limit and you have more LoggingConfigurations than - // the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of LoggingConfigurations. For the second and + // the value of Limit , AWS WAF returns a NextMarker value in the response that + // allows you to list another group of LoggingConfigurations . For the second and // subsequent ListLoggingConfigurations requests, specify the value of NextMarker // from the previous response to get information about another batch of - // ListLoggingConfigurations. + // ListLoggingConfigurations . NextMarker *string noSmithyDocumentSerde @@ -59,7 +57,7 @@ type ListLoggingConfigurationsOutput struct { // If you have more LoggingConfigurations than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more - // LoggingConfigurations, submit another ListLoggingConfigurations request, and + // LoggingConfigurations , submit another ListLoggingConfigurations request, and // specify the NextMarker value from the response in the NextMarker value in the // next request. NextMarker *string diff --git a/service/waf/api_op_ListRateBasedRules.go b/service/waf/api_op_ListRateBasedRules.go index 0cac2e26db7..edcf2c9d783 100644 --- a/service/waf/api_op_ListRateBasedRules.go +++ b/service/waf/api_op_ListRateBasedRules.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleSummary objects. func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRulesInput, optFns ...func(*Options)) (*ListRateBasedRulesOutput, error) { if params == nil { params = &ListRateBasedRulesInput{} @@ -36,15 +34,15 @@ func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRu type ListRateBasedRulesInput struct { // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. + // If you have more Rules than the number that you specify for Limit , the response + // includes a NextMarker value that you can use to get another batch of Rules . Limit int32 - // If you specify a value for Limit and you have more Rules than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of Rules. For the second and subsequent ListRateBasedRules + // If you specify a value for Limit and you have more Rules than the value of Limit + // , AWS WAF returns a NextMarker value in the response that allows you to list + // another group of Rules . For the second and subsequent ListRateBasedRules // requests, specify the value of NextMarker from the previous response to get - // information about another batch of Rules. + // information about another batch of Rules . NextMarker *string noSmithyDocumentSerde @@ -53,7 +51,7 @@ type ListRateBasedRulesInput struct { type ListRateBasedRulesOutput struct { // If you have more Rules than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more Rules, submit + // request, the response includes a NextMarker value. To list more Rules , submit // another ListRateBasedRules request, and specify the NextMarker value from the // response in the NextMarker value in the next request. NextMarker *string diff --git a/service/waf/api_op_ListRegexMatchSets.go b/service/waf/api_op_ListRegexMatchSets.go index b9f257ef299..717119f1234 100644 --- a/service/waf/api_op_ListRegexMatchSets.go +++ b/service/waf/api_op_ListRegexMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RegexMatchSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RegexMatchSetSummary objects. func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchSetsInput, optFns ...func(*Options)) (*ListRegexMatchSetsOutput, error) { if params == nil { params = &ListRegexMatchSetsInput{} @@ -37,15 +35,16 @@ type ListRegexMatchSetsInput struct { // Specifies the number of RegexMatchSet objects that you want AWS WAF to return // for this request. If you have more RegexMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexMatchSet objects. + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of RegexMatchSet objects. Limit int32 // If you specify a value for Limit and you have more RegexMatchSet objects than - // the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of ByteMatchSets. For the second and subsequent - // ListRegexMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of RegexMatchSet objects. + // the value of Limit , AWS WAF returns a NextMarker value in the response that + // allows you to list another group of ByteMatchSets . For the second and + // subsequent ListRegexMatchSets requests, specify the value of NextMarker from + // the previous response to get information about another batch of RegexMatchSet + // objects. NextMarker *string noSmithyDocumentSerde diff --git a/service/waf/api_op_ListRegexPatternSets.go b/service/waf/api_op_ListRegexPatternSets.go index 8afaed2b295..ee2dc211d27 100644 --- a/service/waf/api_op_ListRegexPatternSets.go +++ b/service/waf/api_op_ListRegexPatternSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RegexPatternSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RegexPatternSetSummary objects. func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error) { if params == nil { params = &ListRegexPatternSetsInput{} @@ -37,12 +35,12 @@ type ListRegexPatternSetsInput struct { // Specifies the number of RegexPatternSet objects that you want AWS WAF to return // for this request. If you have more RegexPatternSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexPatternSet objects. + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of RegexPatternSet objects. Limit int32 // If you specify a value for Limit and you have more RegexPatternSet objects than - // the value of Limit, AWS WAF returns a NextMarker value in the response that + // the value of Limit , AWS WAF returns a NextMarker value in the response that // allows you to list another group of RegexPatternSet objects. For the second and // subsequent ListRegexPatternSets requests, specify the value of NextMarker from // the previous response to get information about another batch of RegexPatternSet diff --git a/service/waf/api_op_ListRuleGroups.go b/service/waf/api_op_ListRuleGroups.go index 61eea0ad486..9e2355efde5 100644 --- a/service/waf/api_op_ListRuleGroups.go +++ b/service/waf/api_op_ListRuleGroups.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleGroup objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleGroup objects. func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error) { if params == nil { params = &ListRuleGroupsInput{} @@ -36,16 +34,16 @@ func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput type ListRuleGroupsInput struct { // Specifies the number of RuleGroups that you want AWS WAF to return for this - // request. If you have more RuleGroups than the number that you specify for Limit, - // the response includes a NextMarker value that you can use to get another batch - // of RuleGroups. + // request. If you have more RuleGroups than the number that you specify for Limit + // , the response includes a NextMarker value that you can use to get another + // batch of RuleGroups . Limit int32 // If you specify a value for Limit and you have more RuleGroups than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of RuleGroups. For the second and subsequent ListRuleGroups + // Limit , AWS WAF returns a NextMarker value in the response that allows you to + // list another group of RuleGroups . For the second and subsequent ListRuleGroups // requests, specify the value of NextMarker from the previous response to get - // information about another batch of RuleGroups. + // information about another batch of RuleGroups . NextMarker *string noSmithyDocumentSerde @@ -54,9 +52,9 @@ type ListRuleGroupsInput struct { type ListRuleGroupsOutput struct { // If you have more RuleGroups than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more RuleGroups, - // submit another ListRuleGroups request, and specify the NextMarker value from the - // response in the NextMarker value in the next request. + // request, the response includes a NextMarker value. To list more RuleGroups , + // submit another ListRuleGroups request, and specify the NextMarker value from + // the response in the NextMarker value in the next request. NextMarker *string // An array of RuleGroup objects. diff --git a/service/waf/api_op_ListRules.go b/service/waf/api_op_ListRules.go index cfd2fe67792..c6d6da406c4 100644 --- a/service/waf/api_op_ListRules.go +++ b/service/waf/api_op_ListRules.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleSummary objects. func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} @@ -36,15 +34,15 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. + // If you have more Rules than the number that you specify for Limit , the response + // includes a NextMarker value that you can use to get another batch of Rules . Limit int32 - // If you specify a value for Limit and you have more Rules than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of Rules. For the second and subsequent ListRules requests, + // If you specify a value for Limit and you have more Rules than the value of Limit + // , AWS WAF returns a NextMarker value in the response that allows you to list + // another group of Rules . For the second and subsequent ListRules requests, // specify the value of NextMarker from the previous response to get information - // about another batch of Rules. + // about another batch of Rules . NextMarker *string noSmithyDocumentSerde @@ -53,9 +51,9 @@ type ListRulesInput struct { type ListRulesOutput struct { // If you have more Rules than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more Rules, submit - // another ListRules request, and specify the NextMarker value from the response in - // the NextMarker value in the next request. + // request, the response includes a NextMarker value. To list more Rules , submit + // another ListRules request, and specify the NextMarker value from the response + // in the NextMarker value in the next request. NextMarker *string // An array of RuleSummary objects. diff --git a/service/waf/api_op_ListSizeConstraintSets.go b/service/waf/api_op_ListSizeConstraintSets.go index 90a06f6eddb..22e61ec3f26 100644 --- a/service/waf/api_op_ListSizeConstraintSets.go +++ b/service/waf/api_op_ListSizeConstraintSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of SizeConstraintSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of SizeConstraintSetSummary objects. func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeConstraintSetsInput, optFns ...func(*Options)) (*ListSizeConstraintSetsOutput, error) { if params == nil { params = &ListSizeConstraintSetsInput{} @@ -37,15 +35,15 @@ type ListSizeConstraintSetsInput struct { // Specifies the number of SizeConstraintSet objects that you want AWS WAF to // return for this request. If you have more SizeConstraintSets objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of SizeConstraintSet objects. + // number you specify for Limit , the response includes a NextMarker value that + // you can use to get another batch of SizeConstraintSet objects. Limit int32 // If you specify a value for Limit and you have more SizeConstraintSets than the - // value of Limit, AWS WAF returns a NextMarker value in the response that allows - // you to list another group of SizeConstraintSets. For the second and subsequent + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of SizeConstraintSets . For the second and subsequent // ListSizeConstraintSets requests, specify the value of NextMarker from the - // previous response to get information about another batch of SizeConstraintSets. + // previous response to get information about another batch of SizeConstraintSets . NextMarker *string noSmithyDocumentSerde @@ -54,10 +52,10 @@ type ListSizeConstraintSetsInput struct { type ListSizeConstraintSetsOutput struct { // If you have more SizeConstraintSet objects than the number that you specified - // for Limit in the request, the response includes a NextMarker value. To list more - // SizeConstraintSet objects, submit another ListSizeConstraintSets request, and - // specify the NextMarker value from the response in the NextMarker value in the - // next request. + // for Limit in the request, the response includes a NextMarker value. To list + // more SizeConstraintSet objects, submit another ListSizeConstraintSets request, + // and specify the NextMarker value from the response in the NextMarker value in + // the next request. NextMarker *string // An array of SizeConstraintSetSummary objects. diff --git a/service/waf/api_op_ListSqlInjectionMatchSets.go b/service/waf/api_op_ListSqlInjectionMatchSets.go index 8e1e134f4ad..f619c1acbc2 100644 --- a/service/waf/api_op_ListSqlInjectionMatchSets.go +++ b/service/waf/api_op_ListSqlInjectionMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of SqlInjectionMatchSet objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of SqlInjectionMatchSet objects. func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlInjectionMatchSetsInput, optFns ...func(*Options)) (*ListSqlInjectionMatchSetsOutput, error) { if params == nil { params = &ListSqlInjectionMatchSetsInput{} @@ -39,16 +37,16 @@ type ListSqlInjectionMatchSetsInput struct { // Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to // return for this request. If you have more SqlInjectionMatchSet objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of Rules. + // number you specify for Limit , the response includes a NextMarker value that + // you can use to get another batch of Rules . Limit int32 // If you specify a value for Limit and you have more SqlInjectionMatchSet objects - // than the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of SqlInjectionMatchSets. For the second and - // subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker - // from the previous response to get information about another batch of - // SqlInjectionMatchSets. + // than the value of Limit , AWS WAF returns a NextMarker value in the response + // that allows you to list another group of SqlInjectionMatchSets . For the second + // and subsequent ListSqlInjectionMatchSets requests, specify the value of + // NextMarker from the previous response to get information about another batch of + // SqlInjectionMatchSets . NextMarker *string noSmithyDocumentSerde @@ -57,11 +55,11 @@ type ListSqlInjectionMatchSetsInput struct { // The response to a ListSqlInjectionMatchSets request. type ListSqlInjectionMatchSetsOutput struct { - // If you have more SqlInjectionMatchSet objects than the number that you specified - // for Limit in the request, the response includes a NextMarker value. To list more - // SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, - // and specify the NextMarker value from the response in the NextMarker value in - // the next request. + // If you have more SqlInjectionMatchSet objects than the number that you + // specified for Limit in the request, the response includes a NextMarker value. + // To list more SqlInjectionMatchSet objects, submit another + // ListSqlInjectionMatchSets request, and specify the NextMarker value from the + // response in the NextMarker value in the next request. NextMarker *string // An array of SqlInjectionMatchSetSummary objects. diff --git a/service/waf/api_op_ListSubscribedRuleGroups.go b/service/waf/api_op_ListSubscribedRuleGroups.go index 1ae5bea4812..c8dba141ebd 100644 --- a/service/waf/api_op_ListSubscribedRuleGroups.go +++ b/service/waf/api_op_ListSubscribedRuleGroups.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleGroup objects that you are subscribed to. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleGroup objects that you are subscribed +// to. func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubscribedRuleGroupsInput, optFns ...func(*Options)) (*ListSubscribedRuleGroupsOutput, error) { if params == nil { params = &ListSubscribedRuleGroupsInput{} @@ -36,13 +35,13 @@ func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubsc type ListSubscribedRuleGroupsInput struct { // Specifies the number of subscribed rule groups that you want AWS WAF to return - // for this request. If you have more objects than the number you specify for - // Limit, the response includes a NextMarker value that you can use to get another + // for this request. If you have more objects than the number you specify for Limit + // , the response includes a NextMarker value that you can use to get another // batch of objects. Limit int32 - // If you specify a value for Limit and you have more ByteMatchSetssubscribed rule - // groups than the value of Limit, AWS WAF returns a NextMarker value in the + // If you specify a value for Limit and you have more ByteMatchSets subscribed rule + // groups than the value of Limit , AWS WAF returns a NextMarker value in the // response that allows you to list another group of subscribed rule groups. For // the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the // value of NextMarker from the previous response to get information about another diff --git a/service/waf/api_op_ListTagsForResource.go b/service/waf/api_op_ListTagsForResource.go index 02697ff257c..2d99e9b99d0 100644 --- a/service/waf/api_op_ListTagsForResource.go +++ b/service/waf/api_op_ListTagsForResource.go @@ -11,17 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Retrieves the tags associated with the specified AWS resource. Tags -// are key:value pairs that you can use to categorize and manage your resources, -// for purposes like billing. For example, you might set the tag key to "customer" -// and the value to the customer name or ID. You can specify one or more tags to -// add to each AWS resource, up to 50 tags for a resource. Tagging is only +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Retrieves the tags associated with the specified AWS resource. +// Tags are key:value pairs that you can use to categorize and manage your +// resources, for purposes like billing. For example, you might set the tag key to +// "customer" and the value to the customer name or ID. You can specify one or more +// tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only // available through the API, SDKs, and CLI. You can't manage or view tags through // the AWS WAF Classic console. You can tag the AWS resources that you manage // through AWS WAF Classic: web ACLs, rule groups, and rules. diff --git a/service/waf/api_op_ListWebACLs.go b/service/waf/api_op_ListWebACLs.go index 8283c0b8a6e..7affb905611 100644 --- a/service/waf/api_op_ListWebACLs.go +++ b/service/waf/api_op_ListWebACLs.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of WebACLSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of WebACLSummary objects in the response. func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error) { if params == nil { params = &ListWebACLsInput{} @@ -37,15 +35,16 @@ type ListWebACLsInput struct { // Specifies the number of WebACL objects that you want AWS WAF to return for this // request. If you have more WebACL objects than the number that you specify for - // Limit, the response includes a NextMarker value that you can use to get another - // batch of WebACL objects. + // Limit , the response includes a NextMarker value that you can use to get + // another batch of WebACL objects. Limit int32 // If you specify a value for Limit and you have more WebACL objects than the - // number that you specify for Limit, AWS WAF returns a NextMarker value in the - // response that allows you to list another group of WebACL objects. For the second - // and subsequent ListWebACLs requests, specify the value of NextMarker from the - // previous response to get information about another batch of WebACL objects. + // number that you specify for Limit , AWS WAF returns a NextMarker value in the + // response that allows you to list another group of WebACL objects. For the + // second and subsequent ListWebACLs requests, specify the value of NextMarker + // from the previous response to get information about another batch of WebACL + // objects. NextMarker *string noSmithyDocumentSerde diff --git a/service/waf/api_op_ListXssMatchSets.go b/service/waf/api_op_ListXssMatchSets.go index 45579195db9..b9e33a60b81 100644 --- a/service/waf/api_op_ListXssMatchSets.go +++ b/service/waf/api_op_ListXssMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of XssMatchSet objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of XssMatchSet objects. func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsInput, optFns ...func(*Options)) (*ListXssMatchSetsOutput, error) { if params == nil { params = &ListXssMatchSetsInput{} @@ -38,15 +36,15 @@ type ListXssMatchSetsInput struct { // Specifies the number of XssMatchSet objects that you want AWS WAF to return for // this request. If you have more XssMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of Rules. + // for Limit , the response includes a NextMarker value that you can use to get + // another batch of Rules . Limit int32 // If you specify a value for Limit and you have more XssMatchSet objects than the - // value of Limit, AWS WAF returns a NextMarker value in the response that allows - // you to list another group of XssMatchSets. For the second and subsequent + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of XssMatchSets . For the second and subsequent // ListXssMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of XssMatchSets. + // response to get information about another batch of XssMatchSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/waf/api_op_PutLoggingConfiguration.go b/service/waf/api_op_PutLoggingConfiguration.go index a8ab5bf4419..849fc08d44a 100644 --- a/service/waf/api_op_PutLoggingConfiguration.go +++ b/service/waf/api_op_PutLoggingConfiguration.go @@ -11,31 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Associates a LoggingConfiguration with a specified web ACL. You can -// access information about all traffic that AWS WAF inspects using the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Associates a LoggingConfiguration with a specified web ACL. You +// can access information about all traffic that AWS WAF inspects using the +// following steps: +// - Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT +// source and in the region that you are operating. However, if you are capturing +// logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). +// Do not create the data firehose using a Kinesis stream as your source. +// - Associate that firehose to your web ACL using a PutLoggingConfiguration +// request. // -// * Create an Amazon Kinesis Data Firehose. Create the data firehose with -// a PUT source and in the region that you are operating. However, if you are -// capturing logs for Amazon CloudFront, always create the firehose in US East (N. -// Virginia). Do not create the data firehose using a Kinesis stream as your -// source. -// -// * Associate that firehose to your web ACL using a -// PutLoggingConfiguration request. -// -// When you successfully enable logging using a -// PutLoggingConfiguration request, AWS WAF will create a service linked role with -// the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For -// more information, see Logging Web ACL Traffic Information -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the AWS -// WAF Developer Guide. +// When you successfully enable logging using a PutLoggingConfiguration request, +// AWS WAF will create a service linked role with the necessary permissions to +// write logs to the Amazon Kinesis Data Firehose. For more information, see +// Logging Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the AWS WAF Developer Guide. func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error) { if params == nil { params = &PutLoggingConfigurationInput{} @@ -55,8 +49,8 @@ type PutLoggingConfigurationInput struct { // The Amazon Kinesis Data Firehose that contains the inspected traffic // information, the redacted fields details, and the Amazon Resource Name (ARN) of - // the web ACL to monitor. When specifying Type in RedactedFields, you must use one - // of the following values: URI, QUERY_STRING, HEADER, or METHOD. + // the web ACL to monitor. When specifying Type in RedactedFields , you must use + // one of the following values: URI , QUERY_STRING , HEADER , or METHOD . // // This member is required. LoggingConfiguration *types.LoggingConfiguration diff --git a/service/waf/api_op_PutPermissionPolicy.go b/service/waf/api_op_PutPermissionPolicy.go index 348518ea8b0..fb49af04d43 100644 --- a/service/waf/api_op_PutPermissionPolicy.go +++ b/service/waf/api_op_PutPermissionPolicy.go @@ -10,44 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Attaches an IAM policy to the specified resource. The only supported -// use for this action is to share a RuleGroup across accounts. The +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Attaches an IAM policy to the specified resource. The only +// supported use for this action is to share a RuleGroup across accounts. The // PutPermissionPolicy is subject to the following restrictions: +// - You can attach only one policy with each PutPermissionPolicy request. +// - The policy must include an Effect , Action and Principal . +// - Effect must specify Allow . +// - The Action in the policy must be waf:UpdateWebACL , +// waf-regional:UpdateWebACL , waf:GetRuleGroup and waf-regional:GetRuleGroup . +// Any extra or wildcard actions in the policy will be rejected. +// - The policy cannot include a Resource parameter. +// - The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup +// must exist in the same region. +// - The user making the request must be the owner of the RuleGroup. +// - Your policy must be composed using IAM Policy version 2012-10-17. // -// * You can attach -// only one policy with each PutPermissionPolicy request. -// -// * The policy must -// include an Effect, Action and Principal. -// -// * Effect must specify Allow. -// -// * The -// Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, -// waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions -// in the policy will be rejected. -// -// * The policy cannot include a Resource -// parameter. -// -// * The ARN in the request must be a valid WAF RuleGroup ARN and the -// RuleGroup must exist in the same region. -// -// * The user making the request must be -// the owner of the RuleGroup. -// -// * Your policy must be composed using IAM Policy -// version 2012-10-17. -// -// For more information, see IAM Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). An -// example of a valid policy parameter is shown in the Examples section below. +// For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) +// . An example of a valid policy parameter is shown in the Examples section below. func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionPolicyInput, optFns ...func(*Options)) (*PutPermissionPolicyOutput, error) { if params == nil { params = &PutPermissionPolicyInput{} diff --git a/service/waf/api_op_TagResource.go b/service/waf/api_op_TagResource.go index 569ef43f0a6..1a69787ebb5 100644 --- a/service/waf/api_op_TagResource.go +++ b/service/waf/api_op_TagResource.go @@ -11,20 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Associates tags with the specified AWS resource. Tags are key:value -// pairs that you can use to categorize and manage your resources, for purposes -// like billing. For example, you might set the tag key to "customer" and the value -// to the customer name or ID. You can specify one or more tags to add to each AWS -// resource, up to 50 tags for a resource. Tagging is only available through the -// API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic -// console. You can use this action to tag the AWS resources that you manage -// through AWS WAF Classic: web ACLs, rule groups, and rules. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Associates tags with the specified AWS resource. Tags are +// key:value pairs that you can use to categorize and manage your resources, for +// purposes like billing. For example, you might set the tag key to "customer" and +// the value to the customer name or ID. You can specify one or more tags to add to +// each AWS resource, up to 50 tags for a resource. Tagging is only available +// through the API, SDKs, and CLI. You can't manage or view tags through the AWS +// WAF Classic console. You can use this action to tag the AWS resources that you +// manage through AWS WAF Classic: web ACLs, rule groups, and rules. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/waf/api_op_UntagResource.go b/service/waf/api_op_UntagResource.go index 5f6d294ef91..260ed702ffa 100644 --- a/service/waf/api_op_UntagResource.go +++ b/service/waf/api_op_UntagResource.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/waf/api_op_UpdateByteMatchSet.go b/service/waf/api_op_UpdateByteMatchSet.go index 424cf9ffa8e..24b05efd90e 100644 --- a/service/waf/api_op_UpdateByteMatchSet.go +++ b/service/waf/api_op_UpdateByteMatchSet.go @@ -11,55 +11,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ByteMatchTuple objects (filters) in a -// ByteMatchSet. For each ByteMatchTuple object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ByteMatchTuple objects (filters) in a +// ByteMatchSet . For each ByteMatchTuple object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a ByteMatchSetUpdate object, you delete the existing object and add a +// new one. +// - The part of a web request that you want AWS WAF to inspect, such as a query +// string or the value of the User-Agent header. +// - The bytes (typically a string that corresponds with ASCII characters) that +// you want AWS WAF to look for. For more information, including how you specify +// the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in +// the ByteMatchTuple data type. +// - Where to look, such as at the beginning or the end of a query string. +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. // -// * Whether to insert or delete the object from the array. If you want to -// change a ByteMatchSetUpdate object, you delete the existing object and add a new -// one. +// For example, you can add a ByteMatchSetUpdate object that matches web requests +// in which User-Agent headers contain the string BadBot . You can then configure +// AWS WAF to block those requests. To create and configure a ByteMatchSet , +// perform the following steps: +// - Create a ByteMatchSet. For more information, see CreateByteMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateByteMatchSet request. +// - Submit an UpdateByteMatchSet request to specify the part of the request that +// you want AWS WAF to inspect (for example, the header or the URI) and the value +// that you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to inspect, such as a -// query string or the value of the User-Agent header. -// -// * The bytes (typically a -// string that corresponds with ASCII characters) that you want AWS WAF to look -// for. For more information, including how you specify the values for the AWS WAF -// API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data -// type. -// -// * Where to look, such as at the beginning or the end of a query -// string. -// -// * Whether to perform any conversions on the request, such as converting -// it to lowercase, before inspecting it for the specified string. -// -// For example, -// you can add a ByteMatchSetUpdate object that matches web requests in which -// User-Agent headers contain the string BadBot. You can then configure AWS WAF to -// block those requests. To create and configure a ByteMatchSet, perform the -// following steps: -// -// * Create a ByteMatchSet. For more information, see -// CreateByteMatchSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateByteMatchSet request. -// -// * Submit -// an UpdateByteMatchSet request to specify the part of the request that you want -// AWS WAF to inspect (for example, the header or the URI) and the value that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatchSetInput, optFns ...func(*Options)) (*UpdateByteMatchSetOutput, error) { if params == nil { params = &UpdateByteMatchSetInput{} @@ -78,27 +63,22 @@ func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatch type UpdateByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId - // is returned by CreateByteMatchSet and by ListByteMatchSets. + // is returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // An array of ByteMatchSetUpdate objects that you want to insert into or delete - // from a ByteMatchSet. For more information, see the applicable data types: - // - // * - // ByteMatchSetUpdate: Contains Action and ByteMatchTuple - // - // * ByteMatchTuple: - // Contains FieldToMatch, PositionalConstraint, TargetString, and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // from a ByteMatchSet . For more information, see the applicable data types: + // - ByteMatchSetUpdate : Contains Action and ByteMatchTuple + // - ByteMatchTuple : Contains FieldToMatch , PositionalConstraint , TargetString + // , and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.ByteMatchSetUpdate @@ -110,7 +90,7 @@ type UpdateByteMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateGeoMatchSet.go b/service/waf/api_op_UpdateGeoMatchSet.go index b3e61cb32df..7e4df3d0735 100644 --- a/service/waf/api_op_UpdateGeoMatchSet.go +++ b/service/waf/api_op_UpdateGeoMatchSet.go @@ -11,44 +11,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For -// each GeoMatchConstraint object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet +// . For each GeoMatchConstraint object, you specify the following values: +// - Whether to insert or delete the object from the array. If you want to +// change an GeoMatchConstraint object, you delete the existing object and add a +// new one. +// - The Type . The only valid value for Type is Country . +// - The Value , which is a two character code for the country to add to the +// GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value +// . // -// * Whether to -// insert or delete the object from the array. If you want to change an -// GeoMatchConstraint object, you delete the existing object and add a new one. +// To create and configure an GeoMatchSet , perform the following steps: +// - Submit a CreateGeoMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateGeoMatchSet request. +// - Submit an UpdateGeoMatchSet request to specify the country that you want AWS +// WAF to watch for. // -// * -// The Type. The only valid value for Type is Country. -// -// * The Value, which is a two -// character code for the country to add to the GeoMatchConstraint object. Valid -// codes are listed in GeoMatchConstraint$Value. -// -// To create and configure an -// GeoMatchSet, perform the following steps: -// -// * Submit a CreateGeoMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateGeoMatchSet request. -// -// * Submit an -// UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch -// for. -// -// When you update an GeoMatchSet, you specify the country that you want to -// add and/or the country that you want to delete. If you want to change a country, -// you delete the existing country and add the new one. For more information about -// how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF -// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// When you update an GeoMatchSet , you specify the country that you want to add +// and/or the country that you want to delete. If you want to change a country, you +// delete the existing country and add the new one. For more information about how +// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSetInput, optFns ...func(*Options)) (*UpdateGeoMatchSetOutput, error) { if params == nil { params = &UpdateGeoMatchSetInput{} @@ -66,27 +54,23 @@ func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSe type UpdateGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string // An array of GeoMatchSetUpdate objects that you want to insert into or delete - // from an GeoMatchSet. For more information, see the applicable data types: - // - // * - // GeoMatchSetUpdate: Contains Action and GeoMatchConstraint - // - // * GeoMatchConstraint: - // Contains Type and Value You can have only one Type and Value per - // GeoMatchConstraint. To add multiple countries, include multiple - // GeoMatchSetUpdate objects in your request. + // from an GeoMatchSet . For more information, see the applicable data types: + // - GeoMatchSetUpdate : Contains Action and GeoMatchConstraint + // - GeoMatchConstraint : Contains Type and Value You can have only one Type and + // Value per GeoMatchConstraint . To add multiple countries, include multiple + // GeoMatchSetUpdate objects in your request. // // This member is required. Updates []types.GeoMatchSetUpdate @@ -98,7 +82,7 @@ type UpdateGeoMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateIPSet.go b/service/waf/api_op_UpdateIPSet.go index 021d8d9079d..116d2c9542f 100644 --- a/service/waf/api_op_UpdateIPSet.go +++ b/service/waf/api_op_UpdateIPSet.go @@ -11,67 +11,48 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each -// IPSetDescriptor object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes IPSetDescriptor objects in an IPSet . For +// each IPSetDescriptor object, you specify the following values: +// - Whether to insert or delete the object from the array. If you want to +// change an IPSetDescriptor object, you delete the existing object and add a new +// one. +// - The IP address version, IPv4 or IPv6 . +// - The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of +// IP addresses from 192.0.2.0 to 192.0.2.255 ) or 192.0.2.44/32 (for the +// individual IP address 192.0.2.44 ). // -// * Whether to insert -// or delete the object from the array. If you want to change an IPSetDescriptor -// object, you delete the existing object and add a new one. +// AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. +// AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For +// more information about CIDR notation, see the Wikipedia entry Classless +// Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . IPv6 addresses can be represented using any of the following formats: +// - 1111:0000:0000:0000:0000:0000:0000:0111/128 +// - 1111:0:0:0:0:0:0:0111/128 +// - 1111::0111/128 +// - 1111::111/128 // -// * The IP address -// version, IPv4 or IPv6. +// You use an IPSet to specify which web requests you want to allow or block based +// on the IP addresses that the requests originated from. For example, if you're +// receiving a lot of requests from one or a small number of IP addresses and you +// want to block the requests, you can create an IPSet that specifies those IP +// addresses, and then configure AWS WAF to block the requests. To create and +// configure an IPSet , perform the following steps: +// - Submit a CreateIPSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateIPSet request to specify the IP addresses that you want AWS +// WAF to watch for. // -// * The IP address in CIDR notation, for example, -// 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or -// 192.0.2.44/32 (for the individual IP address 192.0.2.44). -// -// AWS WAF supports IPv4 -// address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 -// address ranges: /24, /32, /48, /56, /64, and /128. For more information about -// CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing -// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). IPv6 addresses -// can be represented using any of the following formats: -// -// * -// 1111:0000:0000:0000:0000:0000:0000:0111/128 -// -// * 1111:0:0:0:0:0:0:0111/128 -// -// * -// 1111::0111/128 -// -// * 1111::111/128 -// -// You use an IPSet to specify which web requests -// you want to allow or block based on the IP addresses that the requests -// originated from. For example, if you're receiving a lot of requests from one or -// a small number of IP addresses and you want to block the requests, you can -// create an IPSet that specifies those IP addresses, and then configure AWS WAF to -// block the requests. To create and configure an IPSet, perform the following -// steps: -// -// * Submit a CreateIPSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateIPSet -// request. -// -// * Submit an UpdateIPSet request to specify the IP addresses that you -// want AWS WAF to watch for. -// -// When you update an IPSet, you specify the IP -// addresses that you want to add and/or the IP addresses that you want to delete. -// If you want to change an IP address, you delete the existing IP address and add -// the new one. You can insert a maximum of 1000 addresses in a single request. For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// When you update an IPSet , you specify the IP addresses that you want to add +// and/or the IP addresses that you want to delete. If you want to change an IP +// address, you delete the existing IP address and add the new one. You can insert +// a maximum of 1000 addresses in a single request. For more information about how +// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { if params == nil { params = &UpdateIPSetInput{} @@ -89,26 +70,21 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The IPSetId of the IPSet that you want to update. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string // An array of IPSetUpdate objects that you want to insert into or delete from an - // IPSet. For more information, see the applicable data types: - // - // * IPSetUpdate: - // Contains Action and IPSetDescriptor - // - // * IPSetDescriptor: Contains Type and - // Value - // + // IPSet . For more information, see the applicable data types: + // - IPSetUpdate : Contains Action and IPSetDescriptor + // - IPSetDescriptor : Contains Type and Value // You can insert a maximum of 1000 addresses in a single request. // // This member is required. @@ -121,7 +97,7 @@ type UpdateIPSetOutput struct { // The ChangeToken that you used to submit the UpdateIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateRateBasedRule.go b/service/waf/api_op_UpdateRateBasedRule.go index 1e5a843f37d..b605d10af9a 100644 --- a/service/waf/api_op_UpdateRateBasedRule.go +++ b/service/waf/api_op_UpdateRateBasedRule.go @@ -11,47 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes Predicate objects in a rule and updates the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes Predicate objects in a rule and updates the // RateLimit in the rule. Each Predicate object identifies a predicate, such as a -// ByteMatchSet or an IPSet, that specifies the web requests that you want to block -// or count. The RateLimit specifies the number of requests every five minutes that -// triggers the rule. If you add more than one predicate to a RateBasedRule, a -// request must match all the predicates and exceed the RateLimit to be counted or -// blocked. For example, suppose you add the following to a RateBasedRule: +// ByteMatchSet or an IPSet , that specifies the web requests that you want to +// block or count. The RateLimit specifies the number of requests every five +// minutes that triggers the rule. If you add more than one predicate to a +// RateBasedRule , a request must match all the predicates and exceed the RateLimit +// to be counted or blocked. For example, suppose you add the following to a +// RateBasedRule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An -// IPSet that matches the IP address 192.0.2.44/32 +// Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a +// WebACL and specify that you want to block requests that satisfy the rule. For a +// request to be blocked, it must come from the IP address 192.0.2.44 and the +// User-Agent header in the request must contain the value BadBot . Further, +// requests that match these two conditions much be received at a rate of more than +// 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer +// blocks the requests. As a second example, suppose you want to limit requests to +// a particular page on your site. To do this, you could add the following to a +// RateBasedRule : +// - A ByteMatchSet with FieldToMatch of URI +// - A PositionalConstraint of STARTS_WITH +// - A TargetString of login // -// * A ByteMatchSet that matches -// BadBot in the User-Agent header -// -// Further, you specify a RateLimit of 1,000. You -// then add the RateBasedRule to a WebACL and specify that you want to block -// requests that satisfy the rule. For a request to be blocked, it must come from -// the IP address 192.0.2.44 and the User-Agent header in the request must contain -// the value BadBot. Further, requests that match these two conditions much be -// received at a rate of more than 1,000 every five minutes. If the rate drops -// below this limit, AWS WAF no longer blocks the requests. As a second example, -// suppose you want to limit requests to a particular page on your site. To do -// this, you could add the following to a RateBasedRule: -// -// * A ByteMatchSet with -// FieldToMatch of URI -// -// * A PositionalConstraint of STARTS_WITH -// -// * A TargetString -// of login -// -// Further, you specify a RateLimit of 1,000. By adding this -// RateBasedRule to a WebACL, you could limit requests to your login page without -// affecting the rest of your site. +// Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a +// WebACL , you could limit requests to your login page without affecting the rest +// of your site. func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBasedRuleInput, optFns ...func(*Options)) (*UpdateRateBasedRuleOutput, error) { if params == nil { params = &UpdateRateBasedRuleInput{} @@ -69,13 +59,13 @@ func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBase type UpdateRateBasedRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The maximum number of requests, which have an identical value in the field - // specified by the RateKey, allowed in a five-minute period. If the number of + // specified by the RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // @@ -83,13 +73,13 @@ type UpdateRateBasedRuleInput struct { RateLimit int64 // The RuleId of the RateBasedRule that you want to update. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string // An array of RuleUpdate objects that you want to insert into or delete from a - // RateBasedRule. + // RateBasedRule . // // This member is required. Updates []types.RuleUpdate @@ -99,9 +89,9 @@ type UpdateRateBasedRuleInput struct { type UpdateRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the UpdateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateRegexMatchSet.go b/service/waf/api_op_UpdateRegexMatchSet.go index d49f155bf02..0f27340ed1f 100644 --- a/service/waf/api_op_UpdateRegexMatchSet.go +++ b/service/waf/api_op_UpdateRegexMatchSet.go @@ -11,51 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes RegexMatchTuple objects (filters) in a -// RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes RegexMatchTuple objects (filters) in a +// RegexMatchSet . For each RegexMatchSetUpdate object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a RegexMatchSetUpdate object, you delete the existing object and add a +// new one. +// - The part of a web request that you want AWS WAF to inspectupdate, such as a +// query string or the value of the User-Agent header. +// - The identifier of the pattern (a regular expression) that you want AWS WAF +// to look for. For more information, see RegexPatternSet . +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. // -// * Whether to insert or delete the object from the array. If you want to -// change a RegexMatchSetUpdate object, you delete the existing object and add a -// new one. +// For example, you can create a RegexPatternSet that matches any requests with +// User-Agent headers that contain the string B[a@]dB[o0]t . You can then configure +// AWS WAF to reject those requests. To create and configure a RegexMatchSet , +// perform the following steps: +// - Create a RegexMatchSet. For more information, see CreateRegexMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexMatchSet request. +// - Submit an UpdateRegexMatchSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// identifier of the RegexPatternSet that contain the regular expression patters +// you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to inspectupdate, -// such as a query string or the value of the User-Agent header. -// -// * The identifier -// of the pattern (a regular expression) that you want AWS WAF to look for. For -// more information, see RegexPatternSet. -// -// * Whether to perform any conversions on -// the request, such as converting it to lowercase, before inspecting it for the -// specified string. -// -// For example, you can create a RegexPatternSet that matches -// any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You -// can then configure AWS WAF to reject those requests. To create and configure a -// RegexMatchSet, perform the following steps: -// -// * Create a RegexMatchSet. For more -// information, see CreateRegexMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet -// request. -// -// * Submit an UpdateRegexMatchSet request to specify the part of the -// request that you want AWS WAF to inspect (for example, the header or the URI) -// and the identifier of the RegexPatternSet that contain the regular expression -// patters you want AWS WAF to watch for. -// -// For more information about how to use -// the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMatchSetInput, optFns ...func(*Options)) (*UpdateRegexMatchSetOutput, error) { if params == nil { params = &UpdateRegexMatchSetInput{} @@ -73,19 +60,19 @@ func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMat type UpdateRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexMatchSetId of the RegexMatchSet that you want to update. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string // An array of RegexMatchSetUpdate objects that you want to insert into or delete - // from a RegexMatchSet. For more information, see RegexMatchTuple. + // from a RegexMatchSet . For more information, see RegexMatchTuple . // // This member is required. Updates []types.RegexMatchSetUpdate @@ -95,9 +82,9 @@ type UpdateRegexMatchSetInput struct { type UpdateRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateRegexPatternSet.go b/service/waf/api_op_UpdateRegexPatternSet.go index 127211beefc..38e9486a2ae 100644 --- a/service/waf/api_op_UpdateRegexPatternSet.go +++ b/service/waf/api_op_UpdateRegexPatternSet.go @@ -11,50 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes RegexPatternString objects in a RegexPatternSet. -// For each RegexPatternString object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes RegexPatternString objects in a +// RegexPatternSet . For each RegexPatternString object, you specify the following +// values: +// - Whether to insert or delete the RegexPatternString . +// - The regular expression pattern that you want to insert or delete. For more +// information, see RegexPatternSet . // -// * Whether -// to insert or delete the RegexPatternString. +// For example, you can create a RegexPatternString such as B[a@]dB[o0]t . AWS WAF +// will match this RegexPatternString to: +// - BadBot +// - BadB0t +// - B@dBot +// - B@dB0t // -// * The regular expression pattern -// that you want to insert or delete. For more information, see -// RegexPatternSet. +// To create and configure a RegexPatternSet , perform the following steps: +// - Create a RegexPatternSet. For more information, see CreateRegexPatternSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexPatternSet request. +// - Submit an UpdateRegexPatternSet request to specify the regular expression +// pattern that you want AWS WAF to watch for. // -// For example, you can create a RegexPatternString such as -// B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: -// -// * BadBot -// -// * -// BadB0t -// -// * B@dBot -// -// * B@dB0t -// -// To create and configure a RegexPatternSet, perform -// the following steps: -// -// * Create a RegexPatternSet. For more information, see -// CreateRegexPatternSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateRegexPatternSet request. -// -// * -// Submit an UpdateRegexPatternSet request to specify the regular expression -// pattern that you want AWS WAF to watch for. -// -// For more information about how to -// use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer -// Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexPatternSetInput, optFns ...func(*Options)) (*UpdateRegexPatternSetOutput, error) { if params == nil { params = &UpdateRegexPatternSetInput{} @@ -72,20 +56,20 @@ func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexP type UpdateRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexPatternSetId of the RegexPatternSet that you want to update. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string - // An array of RegexPatternSetUpdate objects that you want to insert into or delete - // from a RegexPatternSet. + // An array of RegexPatternSetUpdate objects that you want to insert into or + // delete from a RegexPatternSet . // // This member is required. Updates []types.RegexPatternSetUpdate @@ -97,7 +81,7 @@ type UpdateRegexPatternSetOutput struct { // The ChangeToken that you used to submit the UpdateRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateRule.go b/service/waf/api_op_UpdateRule.go index 83ee20c0b63..b1ea67d3e5a 100644 --- a/service/waf/api_op_UpdateRule.go +++ b/service/waf/api_op_UpdateRule.go @@ -11,50 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes Predicate objects in a Rule. Each Predicate -// object identifies a predicate, such as a ByteMatchSet or an IPSet, that +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes Predicate objects in a Rule . Each Predicate +// object identifies a predicate, such as a ByteMatchSet or an IPSet , that // specifies the web requests that you want to allow, block, or count. If you add -// more than one predicate to a Rule, a request must match all of the +// more than one predicate to a Rule , a request must match all of the // specifications to be allowed, blocked, or counted. For example, suppose that you -// add the following to a Rule: +// add the following to a Rule : +// - A ByteMatchSet that matches the value BadBot in the User-Agent header +// - An IPSet that matches the IP address 192.0.2.44 // -// * A ByteMatchSet that matches the value BadBot in -// the User-Agent header +// You then add the Rule to a WebACL and specify that you want to block requests +// that satisfy the Rule . For a request to be blocked, the User-Agent header in +// the request must contain the value BadBot and the request must originate from +// the IP address 192.0.2.44. To create and configure a Rule , perform the +// following steps: +// - Create and update the predicates that you want to include in the Rule . +// - Create the Rule . See CreateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRule request to add predicates to the Rule . +// - Create and update a WebACL that contains the Rule . See CreateWebACL . // -// * An IPSet that matches the IP address 192.0.2.44 -// -// You -// then add the Rule to a WebACL and specify that you want to block requests that -// satisfy the Rule. For a request to be blocked, the User-Agent header in the -// request must contain the value BadBot and the request must originate from the IP -// address 192.0.2.44. To create and configure a Rule, perform the following -// steps: -// -// * Create and update the predicates that you want to include in the -// Rule. -// -// * Create the Rule. See CreateRule. -// -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of an UpdateRule -// request. -// -// * Submit an UpdateRule request to add predicates to the Rule. -// -// * -// Create and update a WebACL that contains the Rule. See CreateWebACL. -// -// If you -// want to replace one ByteMatchSet or IPSet with another, you delete the existing -// one and add the new one. For more information about how to use the AWS WAF API -// to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// If you want to replace one ByteMatchSet or IPSet with another, you delete the +// existing one and add the new one. For more information about how to use the AWS +// WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { params = &UpdateRuleInput{} @@ -72,27 +57,22 @@ func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns type UpdateRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string // An array of RuleUpdate objects that you want to insert into or delete from a - // Rule. For more information, see the applicable data types: - // - // * RuleUpdate: - // Contains Action and Predicate - // - // * Predicate: Contains DataId, Negated, and - // Type - // - // * FieldToMatch: Contains Data and Type + // Rule . For more information, see the applicable data types: + // - RuleUpdate : Contains Action and Predicate + // - Predicate : Contains DataId , Negated , and Type + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.RuleUpdate @@ -102,9 +82,9 @@ type UpdateRuleInput struct { type UpdateRuleOutput struct { - // The ChangeToken that you used to submit the UpdateRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateRuleGroup.go b/service/waf/api_op_UpdateRuleGroup.go index be948b724d3..e88f61eedd1 100644 --- a/service/waf/api_op_UpdateRuleGroup.go +++ b/service/waf/api_op_UpdateRuleGroup.go @@ -11,34 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can -// only insert REGULAR rules into a rule group. You can have a maximum of ten rules -// per rule group. To create and configure a RuleGroup, perform the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ActivatedRule objects in a RuleGroup . You +// can only insert REGULAR rules into a rule group. You can have a maximum of ten +// rules per rule group. To create and configure a RuleGroup , perform the +// following steps: +// - Create and update the Rules that you want to include in the RuleGroup . See +// CreateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRuleGroup request. +// - Submit an UpdateRuleGroup request to add Rules to the RuleGroup . +// - Create and update a WebACL that contains the RuleGroup . See CreateWebACL . // -// * Create and update the Rules that you want to include in the RuleGroup. -// See CreateRule. -// -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of an UpdateRuleGroup request. -// -// * Submit an -// UpdateRuleGroup request to add Rules to the RuleGroup. -// -// * Create and update a -// WebACL that contains the RuleGroup. See CreateWebACL. -// -// If you want to replace -// one Rule with another, you delete the existing one and add the new one. For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// If you want to replace one Rule with another, you delete the existing one and +// add the new one. For more information about how to use the AWS WAF API to allow +// or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) { if params == nil { params = &UpdateRuleGroupInput{} @@ -56,22 +47,23 @@ func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInp type UpdateRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string // An array of RuleGroupUpdate objects that you want to insert into or delete from - // a RuleGroup. You can only insert REGULAR rules into a rule group. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // a RuleGroup . You can only insert REGULAR rules into a rule group. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . // // This member is required. Updates []types.RuleGroupUpdate @@ -83,7 +75,7 @@ type UpdateRuleGroupOutput struct { // The ChangeToken that you used to submit the UpdateRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateSizeConstraintSet.go b/service/waf/api_op_UpdateSizeConstraintSet.go index ea51a3360c0..5befbb01910 100644 --- a/service/waf/api_op_UpdateSizeConstraintSet.go +++ b/service/waf/api_op_UpdateSizeConstraintSet.go @@ -11,58 +11,44 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes SizeConstraint objects (filters) in a -// SizeConstraintSet. For each SizeConstraint object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes SizeConstraint objects (filters) in a +// SizeConstraintSet . For each SizeConstraint object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a SizeConstraintSetUpdate object, you delete the existing object and +// add a new one. +// - The part of a web request that you want AWS WAF to evaluate, such as the +// length of a query string or the length of the User-Agent header. +// - Whether to perform any transformations on the request, such as converting +// it to lowercase, before checking its length. Note that transformations of the +// request body are not supported because the AWS resource forwards only the first +// 8192 bytes of your request to AWS WAF. You can only specify a single type of +// TextTransformation. +// - A ComparisonOperator used for evaluating the selected part of the request +// against the specified Size , such as equals, greater than, less than, and so +// on. +// - The length, in bytes, that you want AWS WAF to watch for in selected part +// of the request. The length is computed after applying the transformation. // -// * Whether to insert or delete the object from the array. If you want to -// change a SizeConstraintSetUpdate object, you delete the existing object and add -// a new one. +// For example, you can add a SizeConstraintSetUpdate object that matches web +// requests in which the length of the User-Agent header is greater than 100 +// bytes. You can then configure AWS WAF to block those requests. To create and +// configure a SizeConstraintSet , perform the following steps: +// - Create a SizeConstraintSet. For more information, see +// CreateSizeConstraintSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSizeConstraintSet request. +// - Submit an UpdateSizeConstraintSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value that you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to evaluate, such -// as the length of a query string or the length of the User-Agent header. -// -// * -// Whether to perform any transformations on the request, such as converting it to -// lowercase, before checking its length. Note that transformations of the request -// body are not supported because the AWS resource forwards only the first 8192 -// bytes of your request to AWS WAF. You can only specify a single type of -// TextTransformation. -// -// * A ComparisonOperator used for evaluating the selected -// part of the request against the specified Size, such as equals, greater than, -// less than, and so on. -// -// * The length, in bytes, that you want AWS WAF to watch -// for in selected part of the request. The length is computed after applying the -// transformation. -// -// For example, you can add a SizeConstraintSetUpdate object that -// matches web requests in which the length of the User-Agent header is greater -// than 100 bytes. You can then configure AWS WAF to block those requests. To -// create and configure a SizeConstraintSet, perform the following steps: -// -// * Create -// a SizeConstraintSet. For more information, see CreateSizeConstraintSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateSizeConstraintSet request. -// -// * Submit an -// UpdateSizeConstraintSet request to specify the part of the request that you want -// AWS WAF to inspect (for example, the header or the URI) and the value that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSizeConstraintSetInput, optFns ...func(*Options)) (*UpdateSizeConstraintSetOutput, error) { if params == nil { params = &UpdateSizeConstraintSetInput{} @@ -80,29 +66,25 @@ func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSize type UpdateSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SizeConstraintSetId of the SizeConstraintSet that you want to update. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string // An array of SizeConstraintSetUpdate objects that you want to insert into or - // delete from a SizeConstraintSet. For more information, see the applicable data + // delete from a SizeConstraintSet . For more information, see the applicable data // types: - // - // * SizeConstraintSetUpdate: Contains Action and SizeConstraint - // - // * - // SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, - // and Size - // - // * FieldToMatch: Contains Data and Type + // - SizeConstraintSetUpdate : Contains Action and SizeConstraint + // - SizeConstraint : Contains FieldToMatch , TextTransformation , + // ComparisonOperator , and Size + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.SizeConstraintSetUpdate @@ -112,9 +94,9 @@ type UpdateSizeConstraintSetInput struct { type UpdateSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateSqlInjectionMatchSet.go b/service/waf/api_op_UpdateSqlInjectionMatchSet.go index c3247710773..472282dad66 100644 --- a/service/waf/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/waf/api_op_UpdateSqlInjectionMatchSet.go @@ -11,51 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a -// SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the -// following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in +// a SqlInjectionMatchSet . For each SqlInjectionMatchTuple object, you specify +// the following values: +// - Action : Whether to insert the object into or delete the object from the +// array. To change a SqlInjectionMatchTuple , you delete the existing object and +// add a new one. +// - FieldToMatch : The part of web requests that you want AWS WAF to inspect +// and, if you want AWS WAF to inspect a header or custom query parameter, the name +// of the header or parameter. +// - TextTransformation : Which text transformation, if any, to perform on the +// web request before inspecting the request for snippets of malicious SQL code. +// You can only specify a single type of TextTransformation. // -// * Action: Whether to insert the object into or delete the -// object from the array. To change a SqlInjectionMatchTuple, you delete the -// existing object and add a new one. -// -// * FieldToMatch: The part of web requests -// that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or -// custom query parameter, the name of the header or parameter. -// -// * -// TextTransformation: Which text transformation, if any, to perform on the web -// request before inspecting the request for snippets of malicious SQL code. You -// can only specify a single type of TextTransformation. -// -// You use -// SqlInjectionMatchSet objects to specify which CloudFront requests that you want -// to allow, block, or count. For example, if you're receiving requests that -// contain snippets of SQL code in the query string and you want to block the +// You use SqlInjectionMatchSet objects to specify which CloudFront requests that +// you want to allow, block, or count. For example, if you're receiving requests +// that contain snippets of SQL code in the query string and you want to block the // requests, you can create a SqlInjectionMatchSet with the applicable settings, // and then configure AWS WAF to block the requests. To create and configure a -// SqlInjectionMatchSet, perform the following steps: -// -// * Submit a -// CreateSqlInjectionMatchSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateIPSet -// request. +// SqlInjectionMatchSet , perform the following steps: +// - Submit a CreateSqlInjectionMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateSqlInjectionMatchSet request to specify the parts of web +// requests that you want AWS WAF to inspect for snippets of SQL code. // -// * Submit an UpdateSqlInjectionMatchSet request to specify the parts of -// web requests that you want AWS WAF to inspect for snippets of SQL code. -// -// For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateSqlInjectionMatchSetInput, optFns ...func(*Options)) (*UpdateSqlInjectionMatchSetOutput, error) { if params == nil { params = &UpdateSqlInjectionMatchSetInput{} @@ -71,32 +58,27 @@ func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateS return out, nil } -// A request to update a SqlInjectionMatchSet. +// A request to update a SqlInjectionMatchSet . type UpdateSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string // An array of SqlInjectionMatchSetUpdate objects that you want to insert into or - // delete from a SqlInjectionMatchSet. For more information, see the applicable + // delete from a SqlInjectionMatchSet . For more information, see the applicable // data types: - // - // * SqlInjectionMatchSetUpdate: Contains Action and - // SqlInjectionMatchTuple - // - // * SqlInjectionMatchTuple: Contains FieldToMatch and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // - SqlInjectionMatchSetUpdate : Contains Action and SqlInjectionMatchTuple + // - SqlInjectionMatchTuple : Contains FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.SqlInjectionMatchSetUpdate @@ -109,7 +91,7 @@ type UpdateSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateWebACL.go b/service/waf/api_op_UpdateWebACL.go index 2f42e3a38e1..72978861f49 100644 --- a/service/waf/api_op_UpdateWebACL.go +++ b/service/waf/api_op_UpdateWebACL.go @@ -11,71 +11,53 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ActivatedRule objects in a WebACL . Each Rule // identifies web requests that you want to allow, block, or count. When you update -// a WebACL, you specify the following values: +// a WebACL , you specify the following values: +// - A default action for the WebACL , either ALLOW or BLOCK . AWS WAF performs +// the default action if a request doesn't match the criteria in any of the Rules +// in a WebACL . +// - The Rules that you want to add or delete. If you want to replace one Rule +// with another, you delete the existing Rule and add the new one. +// - For each Rule , whether you want AWS WAF to allow requests, block requests, +// or count requests that match the conditions in the Rule . +// - The order in which you want AWS WAF to evaluate the Rules in a WebACL . If +// you add more than one Rule to a WebACL , AWS WAF evaluates each request +// against the Rules in order based on the value of Priority . (The Rule that has +// the lowest value for Priority is evaluated first.) When a web request matches +// all the predicates (such as ByteMatchSets and IPSets ) in a Rule , AWS WAF +// immediately takes the corresponding action, allow or block, and doesn't evaluate +// the request against the remaining Rules in the WebACL , if any. // -// * A default action for the WebACL, -// either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't -// match the criteria in any of the Rules in a WebACL. +// To create and configure a WebACL , perform the following steps: +// - Create and update the predicates that you want to include in Rules . For +// more information, see CreateByteMatchSet , UpdateByteMatchSet , CreateIPSet , +// UpdateIPSet , CreateSqlInjectionMatchSet , and UpdateSqlInjectionMatchSet . +// - Create and update the Rules that you want to include in the WebACL . For +// more information, see CreateRule and UpdateRule . +// - Create a WebACL . See CreateWebACL . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateWebACL request. +// - Submit an UpdateWebACL request to specify the Rules that you want to include +// in the WebACL , to specify the default action, and to associate the WebACL +// with a CloudFront distribution. The ActivatedRule can be a rule group. If you +// specify a rule group as your ActivatedRule , you can exclude specific rules +// from that rule group. If you already have a rule group associated with a web ACL +// and want to submit an UpdateWebACL request to exclude certain rules from that +// rule group, you must first remove the rule group from the web ACL, the re-insert +// it again, specifying the excluded rules. For details, see +// ActivatedRule$ExcludedRules . // -// * The Rules that you want -// to add or delete. If you want to replace one Rule with another, you delete the -// existing Rule and add the new one. -// -// * For each Rule, whether you want AWS WAF to -// allow requests, block requests, or count requests that match the conditions in -// the Rule. -// -// * The order in which you want AWS WAF to evaluate the Rules in a -// WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each -// request against the Rules in order based on the value of Priority. (The Rule -// that has the lowest value for Priority is evaluated first.) When a web request -// matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF -// immediately takes the corresponding action, allow or block, and doesn't evaluate -// the request against the remaining Rules in the WebACL, if any. -// -// To create and -// configure a WebACL, perform the following steps: -// -// * Create and update the -// predicates that you want to include in Rules. For more information, see -// CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, -// CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -// -// * Create and update -// the Rules that you want to include in the WebACL. For more information, see -// CreateRule and UpdateRule. -// -// * Create a WebACL. See CreateWebACL. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateWebACL request. -// -// * Submit an UpdateWebACL request to -// specify the Rules that you want to include in the WebACL, to specify the default -// action, and to associate the WebACL with a CloudFront distribution. The -// ActivatedRule can be a rule group. If you specify a rule group as your -// ActivatedRule , you can exclude specific rules from that rule group. If you -// already have a rule group associated with a web ACL and want to submit an -// UpdateWebACL request to exclude certain rules from that rule group, you must -// first remove the rule group from the web ACL, the re-insert it again, specifying -// the excluded rules. For details, see ActivatedRule$ExcludedRules . -// -// Be aware -// that if you try to add a RATE_BASED rule to a web ACL without setting the rule -// type when first creating the rule, the UpdateWebACL request will fail because -// the request tries to add a REGULAR rule (the default rule type) with the +// Be aware that if you try to add a RATE_BASED rule to a web ACL without setting +// the rule type when first creating the rule, the UpdateWebACL request will fail +// because the request tries to add a REGULAR rule (the default rule type) with the // specified ID, which does not exist. For more information about how to use the -// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error) { if params == nil { params = &UpdateWebACLInput{} @@ -93,13 +75,13 @@ func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, op type UpdateWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The WebACLId of the WebACL that you want to update. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -109,20 +91,16 @@ type UpdateWebACLInput struct { // web ACL. DefaultAction *types.WafAction - // An array of updates to make to the WebACL. An array of WebACLUpdate objects that - // you want to insert into or delete from a WebACL. For more information, see the - // applicable data types: - // - // * WebACLUpdate: Contains Action and ActivatedRule - // - // * - // ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case, you do not use ActivatedRule|Action. For all other - // update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. - // - // * WafAction: Contains Type + // An array of updates to make to the WebACL . An array of WebACLUpdate objects + // that you want to insert into or delete from a WebACL . For more information, see + // the applicable data types: + // - WebACLUpdate : Contains Action and ActivatedRule + // - ActivatedRule : Contains Action , OverrideAction , Priority , RuleId , and + // Type . ActivatedRule|OverrideAction applies only when updating or adding a + // RuleGroup to a WebACL . In this case, you do not use ActivatedRule|Action . + // For all other update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . + // - WafAction : Contains Type Updates []types.WebACLUpdate noSmithyDocumentSerde @@ -132,7 +110,7 @@ type UpdateWebACLOutput struct { // The ChangeToken that you used to submit the UpdateWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_UpdateXssMatchSet.go b/service/waf/api_op_UpdateXssMatchSet.go index ed43ee2b8eb..a7fd6cce15a 100644 --- a/service/waf/api_op_UpdateXssMatchSet.go +++ b/service/waf/api_op_UpdateXssMatchSet.go @@ -11,49 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes XssMatchTuple objects (filters) in an -// XssMatchSet. For each XssMatchTuple object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes XssMatchTuple objects (filters) in an +// XssMatchSet . For each XssMatchTuple object, you specify the following values: +// - Action : Whether to insert the object into or delete the object from the +// array. To change an XssMatchTuple , you delete the existing object and add a +// new one. +// - FieldToMatch : The part of web requests that you want AWS WAF to inspect +// and, if you want AWS WAF to inspect a header or custom query parameter, the name +// of the header or parameter. +// - TextTransformation : Which text transformation, if any, to perform on the +// web request before inspecting the request for cross-site scripting attacks. You +// can only specify a single type of TextTransformation. // -// * -// Action: Whether to insert the object into or delete the object from the array. -// To change an XssMatchTuple, you delete the existing object and add a new one. +// You use XssMatchSet objects to specify which CloudFront requests that you want +// to allow, block, or count. For example, if you're receiving requests that +// contain cross-site scripting attacks in the request body and you want to block +// the requests, you can create an XssMatchSet with the applicable settings, and +// then configure AWS WAF to block the requests. To create and configure an +// XssMatchSet , perform the following steps: +// - Submit a CreateXssMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateXssMatchSet request to specify the parts of web requests +// that you want AWS WAF to inspect for cross-site scripting attacks. // -// * -// FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if -// you want AWS WAF to inspect a header or custom query parameter, the name of the -// header or parameter. -// -// * TextTransformation: Which text transformation, if any, -// to perform on the web request before inspecting the request for cross-site -// scripting attacks. You can only specify a single type of -// TextTransformation. -// -// You use XssMatchSet objects to specify which CloudFront -// requests that you want to allow, block, or count. For example, if you're -// receiving requests that contain cross-site scripting attacks in the request body -// and you want to block the requests, you can create an XssMatchSet with the -// applicable settings, and then configure AWS WAF to block the requests. To create -// and configure an XssMatchSet, perform the following steps: -// -// * Submit a -// CreateXssMatchSet request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateIPSet request. -// -// * Submit an -// UpdateXssMatchSet request to specify the parts of web requests that you want AWS -// WAF to inspect for cross-site scripting attacks. -// -// For more information about how -// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF -// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSetInput, optFns ...func(*Options)) (*UpdateXssMatchSetOutput, error) { if params == nil { params = &UpdateXssMatchSetInput{} @@ -69,30 +57,25 @@ func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSe return out, nil } -// A request to update an XssMatchSet. +// A request to update an XssMatchSet . type UpdateXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // An array of XssMatchSetUpdate objects that you want to insert into or delete - // from an XssMatchSet. For more information, see the applicable data types: - // - // * - // XssMatchSetUpdate: Contains Action and XssMatchTuple - // - // * XssMatchTuple: Contains - // FieldToMatch and TextTransformation - // - // * FieldToMatch: Contains Data and Type + // from an XssMatchSet . For more information, see the applicable data types: + // - XssMatchSetUpdate : Contains Action and XssMatchTuple + // - XssMatchTuple : Contains FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.XssMatchSetUpdate // The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -105,7 +88,7 @@ type UpdateXssMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/waf/doc.go b/service/waf/doc.go index a4afc765def..ed019f995be 100644 --- a/service/waf/doc.go +++ b/service/waf/doc.go @@ -3,20 +3,17 @@ // Package waf provides the API client, operations, and parameter types for AWS // WAF. // -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. This is the AWS WAF Classic API Reference for using AWS WAF Classic -// with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the -// reference are available for protecting Amazon CloudFront distributions. You can -// use these actions and data types via the endpoint waf.amazonaws.com. This guide -// is for developers who need detailed information about the AWS WAF Classic API -// actions, data types, and errors. For detailed information about AWS WAF Classic -// features and an overview of how to use the AWS WAF Classic API, see the AWS WAF -// Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. This is the AWS WAF Classic API Reference for using AWS WAF +// Classic with Amazon CloudFront. The AWS WAF Classic actions and data types +// listed in the reference are available for protecting Amazon CloudFront +// distributions. You can use these actions and data types via the endpoint +// waf.amazonaws.com. This guide is for developers who need detailed information +// about the AWS WAF Classic API actions, data types, and errors. For detailed +// information about AWS WAF Classic features and an overview of how to use the AWS +// WAF Classic API, see the AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. package waf diff --git a/service/waf/types/enums.go b/service/waf/types/enums.go index 58ae3339a83..42c45e0ef18 100644 --- a/service/waf/types/enums.go +++ b/service/waf/types/enums.go @@ -10,9 +10,9 @@ const ( ChangeActionDelete ChangeAction = "DELETE" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "INSERT", @@ -728,9 +728,9 @@ const ( ParameterExceptionReasonInvalidTagKey ParameterExceptionReason = "INVALID_TAG_KEY" ) -// Values returns all known values for ParameterExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ParameterExceptionReason. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterExceptionReason) Values() []ParameterExceptionReason { return []ParameterExceptionReason{ "INVALID_OPTION", @@ -862,8 +862,8 @@ const ( WafOverrideActionTypeCount WafOverrideActionType = "COUNT" ) -// Values returns all known values for WafOverrideActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for WafOverrideActionType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (WafOverrideActionType) Values() []WafOverrideActionType { return []WafOverrideActionType{ diff --git a/service/waf/types/errors.go b/service/waf/types/errors.go index e8d6ca371e2..898ad54504a 100644 --- a/service/waf/types/errors.go +++ b/service/waf/types/errors.go @@ -59,30 +59,19 @@ func (e *WAFDisallowedNameException) ErrorCode() string { func (e *WAFDisallowedNameException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed due to a problem with the migration. The failure cause is -// provided in the exception, in the MigrationErrorType: -// -// * ENTITY_NOT_SUPPORTED - -// The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set -// to true. -// -// * ENTITY_NOT_FOUND - The web ACL doesn't exist. -// -// * -// S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject -// action to the specified Amazon S3 bucket. -// -// * S3_BUCKET_NOT_ACCESSIBLE - The -// bucket policy doesn't allow AWS WAF to perform the PutObject action in the -// bucket. -// -// * S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist. -// -// * -// S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web -// ACL. -// -// * S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 -// bucket for another reason. +// provided in the exception, in the MigrationErrorType : +// - ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the +// IgnoreUnsupportedType is not set to true. +// - ENTITY_NOT_FOUND - The web ACL doesn't exist. +// - S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject +// action to the specified Amazon S3 bucket. +// - S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to +// perform the PutObject action in the bucket. +// - S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist. +// - S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the +// web ACL. +// - S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket +// for another reason. type WAFEntityMigrationException struct { Message *string @@ -138,8 +127,8 @@ func (e *WAFInternalErrorException) ErrorCode() string { } func (e *WAFInternalErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The operation failed because you tried to create, update, or delete an object by -// using an invalid account identifier. +// The operation failed because you tried to create, update, or delete an object +// by using an invalid account identifier. type WAFInvalidAccountException struct { Message *string @@ -166,23 +155,16 @@ func (e *WAFInvalidAccountException) ErrorCode() string { func (e *WAFInvalidAccountException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed because there was nothing to do. For example: -// -// * You tried -// to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. -// -// * -// You tried to remove an IP address from an IPSet, but the IP address isn't in the -// specified IPSet. -// -// * You tried to remove a ByteMatchTuple from a ByteMatchSet, -// but the ByteMatchTuple isn't in the specified WebACL. -// -// * You tried to add a Rule -// to a WebACL, but the Rule already exists in the specified WebACL. -// -// * You tried -// to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists -// in the specified WebACL. +// - You tried to remove a Rule from a WebACL , but the Rule isn't in the +// specified WebACL . +// - You tried to remove an IP address from an IPSet , but the IP address isn't +// in the specified IPSet . +// - You tried to remove a ByteMatchTuple from a ByteMatchSet , but the +// ByteMatchTuple isn't in the specified WebACL . +// - You tried to add a Rule to a WebACL , but the Rule already exists in the +// specified WebACL . +// - You tried to add a ByteMatchTuple to a ByteMatchSet , but the ByteMatchTuple +// already exists in the specified WebACL . type WAFInvalidOperationException struct { Message *string @@ -210,34 +192,21 @@ func (e *WAFInvalidOperationException) ErrorFault() smithy.ErrorFault { return s // The operation failed because AWS WAF didn't recognize a parameter in the // request. For example: -// -// * You specified an invalid parameter name. -// -// * You -// specified an invalid value. -// -// * You tried to update an object (ByteMatchSet, -// IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. -// -// * You -// tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or -// COUNT. -// -// * You tried to create a RateBasedRule with a RateKey value other than -// IP. -// -// * You tried to update a WebACL with a WafActionType other than ALLOW, -// BLOCK, or COUNT. -// -// * You tried to update a ByteMatchSet with a FieldToMatchType -// other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -// -// * You tried to update a -// ByteMatchSet with a Field of HEADER but no value for Data. -// -// * Your request -// references an ARN that is malformed, or corresponds to a resource with which a -// web ACL cannot be associated. +// - You specified an invalid parameter name. +// - You specified an invalid value. +// - You tried to update an object ( ByteMatchSet , IPSet , Rule , or WebACL ) +// using an action other than INSERT or DELETE . +// - You tried to create a WebACL with a DefaultAction Type other than ALLOW , +// BLOCK , or COUNT . +// - You tried to create a RateBasedRule with a RateKey value other than IP . +// - You tried to update a WebACL with a WafAction Type other than ALLOW , BLOCK +// , or COUNT . +// - You tried to update a ByteMatchSet with a FieldToMatch Type other than +// HEADER, METHOD, QUERY_STRING, URI, or BODY. +// - You tried to update a ByteMatchSet with a Field of HEADER but no value for +// Data . +// - Your request references an ARN that is malformed, or corresponds to a +// resource with which a web ACL cannot be associated. type WAFInvalidParameterException struct { Message *string @@ -269,30 +238,17 @@ func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return s // The operation failed because the specified policy is not in the proper format. // The policy is subject to the following restrictions: -// -// * You can attach only one -// policy with each PutPermissionPolicy request. -// -// * The policy must include an -// Effect, Action and Principal. -// -// * Effect must specify Allow. -// -// * The Action in the -// policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and -// waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be -// rejected. -// -// * The policy cannot include a Resource parameter. -// -// * The ARN in the -// request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the -// same region. -// -// * The user making the request must be the owner of the -// RuleGroup. -// -// * Your policy must be composed using IAM Policy version 2012-10-17. +// - You can attach only one policy with each PutPermissionPolicy request. +// - The policy must include an Effect , Action and Principal . +// - Effect must specify Allow . +// - The Action in the policy must be waf:UpdateWebACL , +// waf-regional:UpdateWebACL , waf:GetRuleGroup and waf-regional:GetRuleGroup . +// Any extra or wildcard actions in the policy will be rejected. +// - The policy cannot include a Resource parameter. +// - The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup +// must exist in the same region. +// - The user making the request must be the owner of the RuleGroup. +// - Your policy must be composed using IAM Policy version 2012-10-17. type WAFInvalidPermissionPolicyException struct { Message *string @@ -375,20 +331,14 @@ func (e *WAFLimitsExceededException) ErrorCode() string { } func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to delete an object that isn't empty. For -// example: -// -// * You tried to delete a WebACL that still contains one or more Rule -// objects. -// -// * You tried to delete a Rule that still contains one or more -// ByteMatchSet objects or other predicates. -// -// * You tried to delete a ByteMatchSet -// that contains one or more ByteMatchTuple objects. -// -// * You tried to delete an -// IPSet that references one or more IP addresses. +// The operation failed because you tried to delete an object that isn't empty. +// For example: +// - You tried to delete a WebACL that still contains one or more Rule objects. +// - You tried to delete a Rule that still contains one or more ByteMatchSet +// objects or other predicates. +// - You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple +// objects. +// - You tried to delete an IPSet that references one or more IP addresses. type WAFNonEmptyEntityException struct { Message *string @@ -416,19 +366,14 @@ func (e *WAFNonEmptyEntityException) ErrorFault() smithy.ErrorFault { return smi // The operation failed because you tried to add an object to or delete an object // from another object that doesn't exist. For example: -// -// * You tried to add a Rule -// to or delete a Rule from a WebACL that doesn't exist. -// -// * You tried to add a -// ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. -// -// * You -// tried to add an IP address to or delete an IP address from an IPSet that doesn't -// exist. -// -// * You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a -// ByteMatchSet that doesn't exist. +// - You tried to add a Rule to or delete a Rule from a WebACL that doesn't +// exist. +// - You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that +// doesn't exist. +// - You tried to add an IP address to or delete an IP address from an IPSet that +// doesn't exist. +// - You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a +// ByteMatchSet that doesn't exist. type WAFNonexistentContainerException struct { Message *string @@ -480,13 +425,10 @@ func (e *WAFNonexistentItemException) ErrorCode() string { } func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to delete an object that is still in use. -// For example: -// -// * You tried to delete a ByteMatchSet that is still referenced by a -// Rule. -// -// * You tried to delete a Rule that is still referenced by a WebACL. +// The operation failed because you tried to delete an object that is still in +// use. For example: +// - You tried to delete a ByteMatchSet that is still referenced by a Rule . +// - You tried to delete a Rule that is still referenced by a WebACL . type WAFReferencedItemException struct { Message *string @@ -513,13 +455,13 @@ func (e *WAFReferencedItemException) ErrorCode() string { func (e *WAFReferencedItemException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // AWS WAF is not able to access the service linked role. This can be caused by a -// previous PutLoggingConfiguration request, which can lock the service linked role -// for about 20 seconds. Please try your request again. The service linked role can -// also be locked by a previous DeleteServiceLinkedRole request, which can lock the -// role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, -// wait at least 15 minutes and try the request again. If you receive this same -// exception again, you will have to wait additional time until the role is -// unlocked. +// previous PutLoggingConfiguration request, which can lock the service linked +// role for about 20 seconds. Please try your request again. The service linked +// role can also be locked by a previous DeleteServiceLinkedRole request, which +// can lock the role for 15 minutes or more. If you recently made a +// DeleteServiceLinkedRole , wait at least 15 minutes and try the request again. If +// you receive this same exception again, you will have to wait additional time +// until the role is unlocked. type WAFServiceLinkedRoleErrorException struct { Message *string @@ -547,8 +489,8 @@ func (e *WAFServiceLinkedRoleErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to create, update, or delete an object by -// using a change token that has already been used. +// The operation failed because you tried to create, update, or delete an object +// by using a change token that has already been used. type WAFStaleDataException struct { Message *string diff --git a/service/waf/types/types.go b/service/waf/types/types.go index b44f8c0267d..e709c4f1ddd 100644 --- a/service/waf/types/types.go +++ b/service/waf/types/types.go @@ -7,103 +7,91 @@ import ( "time" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The ActivatedRule object in an UpdateWebACL request specifies a Rule -// that you want to insert or delete, the priority of the Rule in the WebACL, and -// the action that you want AWS WAF to take when a web request matches the Rule -// (ALLOW, BLOCK, or COUNT). To specify whether to insert or delete a Rule, use the -// Action parameter in the WebACLUpdate data type. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The ActivatedRule object in an UpdateWebACL request specifies a +// Rule that you want to insert or delete, the priority of the Rule in the WebACL , +// and the action that you want AWS WAF to take when a web request matches the Rule +// ( ALLOW , BLOCK , or COUNT ). To specify whether to insert or delete a Rule , +// use the Action parameter in the WebACLUpdate data type. type ActivatedRule struct { // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a // lower value for Priority are evaluated before Rules with a higher value. The - // value must be a unique integer. If you add multiple Rules to a WebACL, the + // value must be a unique integer. If you add multiple Rules to a WebACL , the // values don't need to be consecutive. // // This member is required. Priority *int32 - // The RuleId for a Rule. You use RuleId to get more information about a Rule (see - // GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete - // a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see - // DeleteRule). RuleId is returned by CreateRule and by ListRules. + // The RuleId for a Rule . You use RuleId to get more information about a Rule + // (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a WebACL or + // delete a one from a WebACL (see UpdateWebACL ), or delete a Rule from AWS WAF + // (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string - // Specifies the action that CloudFront or AWS WAF takes when a web request matches - // the conditions in the Rule. Valid values for Action include the following: - // - // * - // ALLOW: CloudFront responds with the requested object. - // - // * BLOCK: CloudFront - // responds with an HTTP 403 (Forbidden) status code. - // - // * COUNT: AWS WAF increments - // a counter of requests that match the conditions in the rule and then continues - // to inspect the web request based on the remaining rules in the web - // ACL. - // - // ActivatedRule|OverrideAction applies only when updating or adding a - // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For - // all other update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. + // Specifies the action that CloudFront or AWS WAF takes when a web request + // matches the conditions in the Rule . Valid values for Action include the + // following: + // - ALLOW : CloudFront responds with the requested object. + // - BLOCK : CloudFront responds with an HTTP 403 (Forbidden) status code. + // - COUNT : AWS WAF increments a counter of requests that match the conditions + // in the rule and then continues to inspect the web request based on the remaining + // rules in the web ACL. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case, you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . Action *WafAction - // An array of rules to exclude from a rule group. This is applicable only when the - // ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot - // rule groups that are blocking traffic unexpectedly (false positives). One - // troubleshooting technique is to identify the specific rule within the rule group - // that is blocking the legitimate traffic and then disable (exclude) that - // particular rule. You can exclude rules from both your own rule groups and AWS - // Marketplace rule groups that have been associated with a web ACL. Specifying - // ExcludedRules does not remove those rules from the rule group. Rather, it - // changes the action for the rules to COUNT. Therefore, requests that match an - // ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT - // metrics for each ExcludedRule. If you want to exclude rules from a rule group - // that is already associated with a web ACL, perform the following steps: - // - // * Use - // the AWS WAF logs to identify the IDs of the rules that you want to exclude. For - // more information about the logs, see Logging Web ACL Traffic Information - // (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html). - // - // * Submit - // an UpdateWebACL request that has two actions: - // - // * The first action deletes the - // existing rule group from the web ACL. That is, in the UpdateWebACL request, the - // first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be - // the rule group that contains the rules that you want to exclude. - // - // * The second - // action inserts the same rule group back in, but specifying the rules to exclude. - // That is, the second Updates:Action should be INSERT, - // Updates:ActivatedRule:RuleId should be the rule group that you just removed, and - // ExcludedRules should contain the rules that you want to exclude. + // An array of rules to exclude from a rule group. This is applicable only when + // the ActivatedRule refers to a RuleGroup . Sometimes it is necessary to + // troubleshoot rule groups that are blocking traffic unexpectedly (false + // positives). One troubleshooting technique is to identify the specific rule + // within the rule group that is blocking the legitimate traffic and then disable + // (exclude) that particular rule. You can exclude rules from both your own rule + // groups and AWS Marketplace rule groups that have been associated with a web ACL. + // Specifying ExcludedRules does not remove those rules from the rule group. + // Rather, it changes the action for the rules to COUNT . Therefore, requests that + // match an ExcludedRule are counted but not blocked. The RuleGroup owner will + // receive COUNT metrics for each ExcludedRule . If you want to exclude rules from + // a rule group that is already associated with a web ACL, perform the following + // steps: + // - Use the AWS WAF logs to identify the IDs of the rules that you want to + // exclude. For more information about the logs, see Logging Web ACL Traffic + // Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) + // . + // - Submit an UpdateWebACL request that has two actions: + // - The first action deletes the existing rule group from the web ACL. That is, + // in the UpdateWebACL request, the first Updates:Action should be DELETE and + // Updates:ActivatedRule:RuleId should be the rule group that contains the rules + // that you want to exclude. + // - The second action inserts the same rule group back in, but specifying the + // rules to exclude. That is, the second Updates:Action should be INSERT , + // Updates:ActivatedRule:RuleId should be the rule group that you just removed, + // and ExcludedRules should contain the rules that you want to exclude. ExcludedRules []ExcludedRule - // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can - // potentially block a request. If you set the OverrideAction to None, the + // Use the OverrideAction to test your RuleGroup . Any rule in a RuleGroup can + // potentially block a request. If you set the OverrideAction to None , the // RuleGroup will block a request if any individual rule in the RuleGroup matches // the request and is configured to block that request. However if you first want - // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then - // override any block action specified by individual rules contained within the - // group. Instead of blocking matching requests, those requests will be counted. - // You can view a record of counted requests using GetSampledRequests. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // to test the RuleGroup , set the OverrideAction to Count . The RuleGroup will + // then override any block action specified by individual rules contained within + // the group. Instead of blocking matching requests, those requests will be + // counted. You can view a record of counted requests using GetSampledRequests . + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . OverrideAction *WafOverrideAction - // The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by - // RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. + // The rule type, either REGULAR , as defined by Rule , RATE_BASED , as defined by + // RateBasedRule , or GROUP , as defined by RuleGroup . The default is REGULAR. // Although this field is optional, be aware that if you try to add a RATE_BASED // rule to a web ACL without setting the type, the UpdateWebACL request will fail // because the request tries to add a REGULAR rule with the specified ID, which @@ -113,27 +101,25 @@ type ActivatedRule struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetByteMatchSet request, ByteMatchSet is a complex type that -// contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you -// specified when you updated the ByteMatchSet. A complex type that contains -// ByteMatchTuple objects, which specify the parts of web requests that you want -// AWS WAF to inspect and the values that you want AWS WAF to search for. If a -// ByteMatchSet contains more than one ByteMatchTuple object, a request needs to -// match the settings in only one ByteMatchTuple to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetByteMatchSet request, ByteMatchSet is a complex type +// that contains the ByteMatchSetId and Name of a ByteMatchSet , and the values +// that you specified when you updated the ByteMatchSet . A complex type that +// contains ByteMatchTuple objects, which specify the parts of web requests that +// you want AWS WAF to inspect and the values that you want AWS WAF to search for. +// If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs +// to match the settings in only one ByteMatchTuple to be considered a match. type ByteMatchSet struct { - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see - // UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see - // DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by - // ListByteMatchSets. + // The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get + // information about a ByteMatchSet (see GetByteMatchSet ), update a ByteMatchSet + // (see UpdateByteMatchSet ), insert a ByteMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete a ByteMatchSet from AWS WAF (see + // DeleteByteMatchSet ). ByteMatchSetId is returned by CreateByteMatchSet and by + // ListByteMatchSets . // // This member is required. ByteMatchSetId *string @@ -145,33 +131,31 @@ type ByteMatchSet struct { // This member is required. ByteMatchTuples []ByteMatchTuple - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListByteMatchSets. Each ByteMatchSetSummary object -// includes the Name and ByteMatchSetId for one ByteMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListByteMatchSets . Each ByteMatchSetSummary object +// includes the Name and ByteMatchSetId for one ByteMatchSet . type ByteMatchSetSummary struct { - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, - // and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by - // CreateByteMatchSet and by ListByteMatchSets. + // The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get + // information about a ByteMatchSet , update a ByteMatchSet , remove a ByteMatchSet + // from a Rule , and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is + // returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . // // This member is required. Name *string @@ -179,26 +163,24 @@ type ByteMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies // whether to insert or delete a ByteMatchTuple and includes the settings for the -// ByteMatchTuple. +// ByteMatchTuple . type ByteMatchSetUpdate struct { - // Specifies whether to insert or delete a ByteMatchTuple. + // Specifies whether to insert or delete a ByteMatchTuple . // // This member is required. Action ChangeAction - // Information about the part of a web request that you want AWS WAF to inspect and - // the value that you want AWS WAF to search for. If you specify DELETE for the - // value of Action, the ByteMatchTuple values must exactly match the values in the - // ByteMatchTuple that you want to delete from the ByteMatchSet. + // Information about the part of a web request that you want AWS WAF to inspect + // and the value that you want AWS WAF to search for. If you specify DELETE for + // the value of Action , the ByteMatchTuple values must exactly match the values + // in the ByteMatchTuple that you want to delete from the ByteMatchSet . // // This member is required. ByteMatchTuple *ByteMatchTuple @@ -206,176 +188,122 @@ type ByteMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The bytes (typically a string that corresponds with ASCII +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The bytes (typically a string that corresponds with ASCII // characters) that you want AWS WAF to search for in web requests, the location in // requests that you want AWS WAF to search, and other settings. type ByteMatchTuple struct { // The part of a web request that you want AWS WAF to search, such as a specified - // header or a query string. For more information, see FieldToMatch. + // header or a query string. For more information, see FieldToMatch . // // This member is required. FieldToMatch *FieldToMatch - // Within the portion of a web request that you want to search (for example, in the - // query string, if any), specify where you want AWS WAF to search. Valid values - // include the following: CONTAINS The specified part of the web request must - // include the value of TargetString, but the location doesn't matter. + // Within the portion of a web request that you want to search (for example, in + // the query string, if any), specify where you want AWS WAF to search. Valid + // values include the following: CONTAINS The specified part of the web request + // must include the value of TargetString , but the location doesn't matter. // CONTAINS_WORD The specified part of the web request must include the value of - // TargetString, and TargetString must contain only alphanumeric characters or + // TargetString , and TargetString must contain only alphanumeric characters or // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, // which means one of the following: - // - // * TargetString exactly matches the value of - // the specified part of the web request, such as the value of a header. - // - // * - // TargetString is at the beginning of the specified part of the web request and is - // followed by a character other than an alphanumeric character or underscore (_), - // for example, BadBot;. - // - // * TargetString is at the end of the specified part of the - // web request and is preceded by a character other than an alphanumeric character - // or underscore (_), for example, ;BadBot. - // - // * TargetString is in the middle of the - // specified part of the web request and is preceded and followed by characters - // other than alphanumeric characters or underscore (_), for example, - // -BadBot;. - // - // EXACTLY The value of the specified part of the web request must - // exactly match the value of TargetString. STARTS_WITH The value of TargetString - // must appear at the beginning of the specified part of the web request. ENDS_WITH - // The value of TargetString must appear at the end of the specified part of the - // web request. + // - TargetString exactly matches the value of the specified part of the web + // request, such as the value of a header. + // - TargetString is at the beginning of the specified part of the web request + // and is followed by a character other than an alphanumeric character or + // underscore (_), for example, BadBot; . + // - TargetString is at the end of the specified part of the web request and is + // preceded by a character other than an alphanumeric character or underscore (_), + // for example, ;BadBot . + // - TargetString is in the middle of the specified part of the web request and + // is preceded and followed by characters other than alphanumeric characters or + // underscore (_), for example, -BadBot; . + // EXACTLY The value of the specified part of the web request must exactly match + // the value of TargetString . STARTS_WITH The value of TargetString must appear + // at the beginning of the specified part of the web request. ENDS_WITH The value + // of TargetString must appear at the end of the specified part of the web request. // // This member is required. PositionalConstraint PositionalConstraint // The value that you want AWS WAF to search for. AWS WAF searches for the - // specified string in the part of web requests that you specified in FieldToMatch. - // The maximum length of the value is 50 bytes. Valid values depend on the values - // that you specified for FieldToMatch: - // - // * HEADER: The value that you want AWS WAF - // to search for in the request header that you specified in FieldToMatch, for - // example, the value of the User-Agent or Referer header. - // - // * METHOD: The HTTP - // method, which indicates the type of operation specified in the request. - // CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, - // POST, and PUT. - // - // * QUERY_STRING: The value that you want AWS WAF to search for in - // the query string, which is the part of a URL that appears after a ? - // character. - // - // * URI: The value that you want AWS WAF to search for in the part of - // a URL that identifies a resource, for example, /images/daily-ad.jpg. - // - // * BODY: - // The part of a request that contains any additional data that you want to send to - // your web server as the HTTP request body, such as data from a form. The request - // body immediately follows the request headers. Note that only the first 8192 - // bytes of the request body are forwarded to AWS WAF for inspection. To allow or - // block requests based on the length of the body, you can create a size constraint - // set. For more information, see CreateSizeConstraintSet. - // - // * SINGLE_QUERY_ARG: The - // parameter in the query string that you will inspect, such as UserName or - // SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. - // - // * - // ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single - // parameter, AWS WAF inspects all parameters within the query string for the value - // or regex pattern that you specify in TargetString. - // - // If TargetString includes - // alphabetic characters A-Z and a-z, note that the value is case sensitive. If - // you're using the AWS WAF API Specify a base64-encoded version of the value. The - // maximum length of the value before you base64-encode it is 50 bytes. For - // example, suppose the value of Type is HEADER and the value of Data is - // User-Agent. If you want to search the User-Agent header for the value BadBot, - // you base64-encode BadBot using MIME base64-encoding and include the resulting - // value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or - // one of the AWS SDKs The value that you want AWS WAF to search for. The SDK - // automatically base64 encodes the value. + // specified string in the part of web requests that you specified in FieldToMatch + // . The maximum length of the value is 50 bytes. Valid values depend on the values + // that you specified for FieldToMatch : + // - HEADER : The value that you want AWS WAF to search for in the request header + // that you specified in FieldToMatch , for example, the value of the User-Agent + // or Referer header. + // - METHOD : The HTTP method, which indicates the type of operation specified in + // the request. CloudFront supports the following methods: DELETE , GET , HEAD , + // OPTIONS , PATCH , POST , and PUT . + // - QUERY_STRING : The value that you want AWS WAF to search for in the query + // string, which is the part of a URL that appears after a ? character. + // - URI : The value that you want AWS WAF to search for in the part of a URL + // that identifies a resource, for example, /images/daily-ad.jpg . + // - BODY : The part of a request that contains any additional data that you want + // to send to your web server as the HTTP request body, such as data from a form. + // The request body immediately follows the request headers. Note that only the + // first 8192 bytes of the request body are forwarded to AWS WAF for inspection. + // To allow or block requests based on the length of the body, you can create a + // size constraint set. For more information, see CreateSizeConstraintSet . + // - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, + // such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 + // characters. + // - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but instead of inspecting a + // single parameter, AWS WAF inspects all parameters within the query string for + // the value or regex pattern that you specify in TargetString . + // If TargetString includes alphabetic characters A-Z and a-z, note that the value + // is case sensitive. If you're using the AWS WAF API Specify a base64-encoded + // version of the value. The maximum length of the value before you base64-encode + // it is 50 bytes. For example, suppose the value of Type is HEADER and the value + // of Data is User-Agent . If you want to search the User-Agent header for the + // value BadBot , you base64-encode BadBot using MIME base64-encoding and include + // the resulting value, QmFkQm90 , in the value of TargetString . If you're using + // the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search + // for. The SDK automatically base64 encodes the value. // // This member is required. TargetString []byte - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -383,15 +311,13 @@ type ByteMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The rule to exclude from a rule group. This is applicable only when -// the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup -// that is specified by the ActivatedRule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The rule to exclude from a rule group. This is applicable only +// when the ActivatedRule refers to a RuleGroup . The rule must belong to the +// RuleGroup that is specified by the ActivatedRule . type ExcludedRule struct { // The unique identifier for the rule to exclude from the rule group. @@ -402,73 +328,58 @@ type ExcludedRule struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies where in a web request to look for TargetString. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies where in a web request to look for TargetString . type FieldToMatch struct { // The part of the web request that you want AWS WAF to search for a specified // string. Parts of a request that you can search include the following: - // - // * HEADER: - // A specified request header, for example, the value of the User-Agent or Referer - // header. If you choose HEADER for the type, specify the name of the header in - // Data. - // - // * METHOD: The HTTP method, which indicated the type of operation that the - // request is asking the origin to perform. Amazon CloudFront supports the - // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. - // - // * - // QUERY_STRING: A query string, which is the part of a URL that appears after a ? - // character, if any. - // - // * URI: The part of a web request that identifies a resource, - // for example, /images/daily-ad.jpg. - // - // * BODY: The part of a request that contains - // any additional data that you want to send to your web server as the HTTP request - // body, such as data from a form. The request body immediately follows the request - // headers. Note that only the first 8192 bytes of the request body are forwarded - // to AWS WAF for inspection. To allow or block requests based on the length of the - // body, you can create a size constraint set. For more information, see - // CreateSizeConstraintSet. - // - // * SINGLE_QUERY_ARG: The parameter in the query string - // that you will inspect, such as UserName or SalesRegion. The maximum length for - // SINGLE_QUERY_ARG is 30 characters. - // - // * ALL_QUERY_ARGS: Similar to - // SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will - // inspect all parameters within the query for the value or regex pattern that you - // specify in TargetString. + // - HEADER : A specified request header, for example, the value of the + // User-Agent or Referer header. If you choose HEADER for the type, specify the + // name of the header in Data . + // - METHOD : The HTTP method, which indicated the type of operation that the + // request is asking the origin to perform. Amazon CloudFront supports the + // following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . + // - QUERY_STRING : A query string, which is the part of a URL that appears after + // a ? character, if any. + // - URI : The part of a web request that identifies a resource, for example, + // /images/daily-ad.jpg . + // - BODY : The part of a request that contains any additional data that you want + // to send to your web server as the HTTP request body, such as data from a form. + // The request body immediately follows the request headers. Note that only the + // first 8192 bytes of the request body are forwarded to AWS WAF for inspection. + // To allow or block requests based on the length of the body, you can create a + // size constraint set. For more information, see CreateSizeConstraintSet . + // - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, + // such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 + // characters. + // - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a + // single parameter, AWS WAF will inspect all parameters within the query for the + // value or regex pattern that you specify in TargetString . // // This member is required. Type MatchFieldType - // When the value of Type is HEADER, enter the name of the header that you want AWS - // WAF to search, for example, User-Agent or Referer. The name of the header is not - // case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of - // the parameter that you want AWS WAF to search, for example, UserName or - // SalesRegion. The parameter name is not case sensitive. If the value of Type is - // any other value, omit Data. + // When the value of Type is HEADER , enter the name of the header that you want + // AWS WAF to search, for example, User-Agent or Referer . The name of the header + // is not case sensitive. When the value of Type is SINGLE_QUERY_ARG , enter the + // name of the parameter that you want AWS WAF to search, for example, UserName or + // SalesRegion . The parameter name is not case sensitive. If the value of Type is + // any other value, omit Data . Data *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The country from which web requests originate that you want AWS WAF -// to search for. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The country from which web requests originate that you want AWS +// WAF to search for. type GeoMatchConstraint struct { // The type of geographical area you want AWS WAF to search for. Currently Country @@ -485,13 +396,11 @@ type GeoMatchConstraint struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains one or more countries that AWS WAF will search for. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains one or more countries that AWS WAF will search for. type GeoMatchSet struct { // An array of GeoMatchConstraint objects, which contain the country that you want @@ -500,38 +409,36 @@ type GeoMatchSet struct { // This member is required. GeoMatchConstraints []GeoMatchConstraint - // The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information - // about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see - // UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). - // GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + // The GeoMatchSetId for an GeoMatchSet . You use GeoMatchSetId to get information + // about a GeoMatchSet (see GeoMatchSet ), update a GeoMatchSet (see + // UpdateGeoMatchSet ), insert a GeoMatchSet into a Rule or delete one from a Rule + // (see UpdateRule ), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet + // ). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string - // A friendly name or description of the GeoMatchSet. You can't change the name of + // A friendly name or description of the GeoMatchSet . You can't change the name of // an GeoMatchSet after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name of the GeoMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name of the GeoMatchSet . type GeoMatchSetSummary struct { - // The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a - // GetGeoMatchSet request to get detailed information about an GeoMatchSet. + // The GeoMatchSetId for an GeoMatchSet . You can use GeoMatchSetId in a + // GetGeoMatchSet request to get detailed information about an GeoMatchSet . // // This member is required. GeoMatchSetId *string - // A friendly name or description of the GeoMatchSet. You can't change the name of + // A friendly name or description of the GeoMatchSet . You can't change the name of // an GeoMatchSet after you create it. // // This member is required. @@ -540,17 +447,15 @@ type GeoMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the type of update to perform to an GeoMatchSet with -// UpdateGeoMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the type of update to perform to an GeoMatchSet with +// UpdateGeoMatchSet . type GeoMatchSetUpdate struct { - // Specifies whether to insert or delete a country with UpdateGeoMatchSet. + // Specifies whether to insert or delete a country with UpdateGeoMatchSet . // // This member is required. Action ChangeAction @@ -564,16 +469,14 @@ type GeoMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes an +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes an // HTTPHeader complex type that appears as Headers in the response syntax. // HTTPHeader contains the names and values of all of the headers that appear in -// one of the web requests that were returned by GetSampledRequests. +// one of the web requests that were returned by GetSampledRequests . type HTTPHeader struct { // The name of one of the headers in the sampled web request. @@ -585,35 +488,31 @@ type HTTPHeader struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes an +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes an // HTTPRequest complex type that appears as Request in the response syntax. // HTTPRequest contains information about one of the web requests that were -// returned by GetSampledRequests. +// returned by GetSampledRequests . type HTTPRequest struct { // The IP address that the request originated from. If the WebACL is associated // with a CloudFront distribution, this is the value of one of the following fields // in CloudFront access logs: - // - // * c-ip, if the viewer did not use an HTTP proxy or a - // load balancer to send the request - // - // * x-forwarded-for, if the viewer did use an - // HTTP proxy or a load balancer to send the request + // - c-ip , if the viewer did not use an HTTP proxy or a load balancer to send + // the request + // - x-forwarded-for , if the viewer did use an HTTP proxy or a load balancer to + // send the request ClientIP *string // The two-letter country code for the country that the request originated from. - // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 - // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + // . Country *string - // The HTTP version specified in the sampled web request, for example, HTTP/1.1. + // The HTTP version specified in the sampled web request, for example, HTTP/1.1 . HTTPVersion *string // A complex type that contains two values for each header in the sampled web @@ -621,35 +520,33 @@ type HTTPRequest struct { Headers []HTTPHeader // The HTTP method specified in the sampled web request. CloudFront supports the - // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + // following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . Method *string // The part of a web request that identifies the resource, for example, - // /images/daily-ad.jpg. + // /images/daily-ad.jpg . URI *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains one or more IP addresses or blocks of IP addresses +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains one or more IP addresses or blocks of IP addresses // specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports // IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports // IPv6 address ranges: /24, /32, /48, /56, /64, and /128. To specify an individual -// IP address, you specify the four-part IP address followed by a /32, for example, -// 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range -// between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for -// IPv6). For more information about CIDR notation, see the Wikipedia entry -// Classless Inter-Domain Routing -// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). +// IP address, you specify the four-part IP address followed by a /32 , for +// example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or +// any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 +// (for IPv6). For more information about CIDR notation, see the Wikipedia entry +// Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . type IPSet struct { - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) // that web requests originate from. If the WebACL is associated with a CloudFront // distribution and the viewer did not use an HTTP proxy or a load balancer to send // the request, this is the value of the c-ip field in the CloudFront access logs. @@ -657,61 +554,49 @@ type IPSet struct { // This member is required. IPSetDescriptors []IPSetDescriptor - // The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see - // GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or - // delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see - // DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets. + // The IPSetId for an IPSet . You use IPSetId to get information about an IPSet + // (see GetIPSet ), update an IPSet (see UpdateIPSet ), insert an IPSet into a Rule + // or delete one from a Rule (see UpdateRule ), and delete an IPSet from AWS WAF + // (see DeleteIPSet ). IPSetId is returned by CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string - // A friendly name or description of the IPSet. You can't change the name of an + // A friendly name or description of the IPSet . You can't change the name of an // IPSet after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the IP address type (IPV4 or IPV6) and the IP address -// range (in CIDR format) that web requests originate from. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the IP address type ( IPV4 or IPV6 ) and the IP +// address range (in CIDR format) that web requests originate from. type IPSetDescriptor struct { - // Specify IPV4 or IPV6. + // Specify IPV4 or IPV6 . // // This member is required. Type IPSetDescriptorType // Specify an IPv4 address by using CIDR notation. For example: - // - // * To configure AWS - // WAF to allow, block, or count requests that originated from the IP address - // 192.0.2.44, specify 192.0.2.44/32. - // - // * To configure AWS WAF to allow, block, or - // count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, - // specify 192.0.2.0/24. - // - // For more information about CIDR notation, see the - // Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Specify an IPv6 - // address by using CIDR notation. For example: - // - // * To configure AWS WAF to allow, - // block, or count requests that originated from the IP address - // 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure AWS WAF to allow, - // block, or count requests that originated from IP addresses - // 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. + // - To configure AWS WAF to allow, block, or count requests that originated + // from the IP address 192.0.2.44, specify 192.0.2.44/32 . + // - To configure AWS WAF to allow, block, or count requests that originated + // from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . Specify an IPv6 address by using CIDR notation. For example: + // - To configure AWS WAF to allow, block, or count requests that originated + // from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure AWS WAF to allow, block, or count requests that originated + // from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . // // This member is required. Value *string @@ -719,22 +604,20 @@ type IPSetDescriptor struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name of the IPSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name of the IPSet . type IPSetSummary struct { - // The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get - // detailed information about an IPSet. + // The IPSetId for an IPSet . You can use IPSetId in a GetIPSet request to get + // detailed information about an IPSet . // // This member is required. IPSetId *string - // A friendly name or description of the IPSet. You can't change the name of an + // A friendly name or description of the IPSet . You can't change the name of an // IPSet after you create it. // // This member is required. @@ -743,22 +626,20 @@ type IPSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the type of update to perform to an IPSet with -// UpdateIPSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the type of update to perform to an IPSet with +// UpdateIPSet . type IPSetUpdate struct { - // Specifies whether to insert or delete an IP address with UpdateIPSet. + // Specifies whether to insert or delete an IP address with UpdateIPSet . // // This member is required. Action ChangeAction - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) // that web requests originate from. // // This member is required. @@ -767,14 +648,12 @@ type IPSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Amazon Kinesis Data Firehose, RedactedFields information, and -// the web ACL Amazon Resource Name (ARN). +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Amazon Kinesis Data Firehose, RedactedFields information, +// and the web ACL Amazon Resource Name (ARN). type LoggingConfiguration struct { // An array of Amazon Kinesis Data Firehose ARNs. @@ -783,52 +662,50 @@ type LoggingConfiguration struct { LogDestinationConfigs []string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with - // LogDestinationConfigs. + // LogDestinationConfigs . // // This member is required. ResourceArn *string // The parts of the request that you want redacted from the logs. For example, if - // you redact the cookie field, the cookie field in the firehose will be xxx. + // you redact the cookie field, the cookie field in the firehose will be xxx . RedactedFields []FieldToMatch noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, -// XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you -// want to add to a Rule and, for each object, indicates whether you want to negate -// the settings, for example, requests that do NOT originate from the IP address -// 192.0.2.44. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , +// XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that +// you want to add to a Rule and, for each object, indicates whether you want to +// negate the settings, for example, requests that do NOT originate from the IP +// address 192.0.2.44. type Predicate struct { - // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or - // IPSetId. The ID is returned by the corresponding Create or List command. + // A unique identifier for a predicate in a Rule , such as ByteMatchSetId or + // IPSetId . The ID is returned by the corresponding Create or List command. // // This member is required. DataId *string // Set Negated to False if you want AWS WAF to allow, block, or count requests - // based on the settings in the specified ByteMatchSet, IPSet, - // SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or - // SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, - // AWS WAF will allow or block requests based on that IP address. Set Negated to + // based on the settings in the specified ByteMatchSet , IPSet , + // SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or + // SizeConstraintSet . For example, if an IPSet includes the IP address 192.0.2.44 + // , AWS WAF will allow or block requests based on that IP address. Set Negated to // True if you want AWS WAF to allow or block a request based on the negation of - // the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet - // includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests - // based on all IP addresses except 192.0.2.44. + // the settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if an IPSet + // includes the IP address 192.0.2.44 , AWS WAF will allow, block, or count + // requests based on all IP addresses except 192.0.2.44 . // // This member is required. Negated *bool - // The type of predicate in a Rule, such as ByteMatch or IPSet. + // The type of predicate in a Rule , such as ByteMatch or IPSet . // // This member is required. Type PredicateType @@ -836,140 +713,125 @@ type Predicate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A RateBasedRule is identical to a regular Rule, with one addition: a -// RateBasedRule counts the number of requests that arrive from a specified IP -// address every five minutes. For example, based on recent requests that you've -// seen from an attacker, you might create a RateBasedRule that includes the -// following conditions: -// -// * The requests come from 192.0.2.44. -// -// * They contain the -// value BadBot in the User-Agent header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A RateBasedRule is identical to a regular Rule , with one +// addition: a RateBasedRule counts the number of requests that arrive from a +// specified IP address every five minutes. For example, based on recent requests +// that you've seen from an attacker, you might create a RateBasedRule that +// includes the following conditions: +// - The requests come from 192.0.2.44. +// - They contain the value BadBot in the User-Agent header. // -// In the rule, you also define the rate -// limit as 1,000. Requests that meet both of these conditions and exceed 1,000 -// requests every five minutes trigger the rule's action (block or count), which is -// defined in the web ACL. +// In the rule, you also define the rate limit as 1,000. Requests that meet both +// of these conditions and exceed 1,000 requests every five minutes trigger the +// rule's action (block or count), which is defined in the web ACL. type RateBasedRule struct { - // The Predicates object contains one Predicate element for each ByteMatchSet, - // IPSet, or SqlInjectionMatchSet object that you want to include in a - // RateBasedRule. + // The Predicates object contains one Predicate element for each ByteMatchSet , + // IPSet , or SqlInjectionMatchSet object that you want to include in a + // RateBasedRule . // // This member is required. MatchPredicates []Predicate // The field that AWS WAF uses to determine if requests are likely arriving from // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests arriving from the same IP address are - // subject to the RateLimit that is specified in the RateBasedRule. + // RateKey is IP . IP indicates that requests arriving from the same IP address + // are subject to the RateLimit that is specified in the RateBasedRule . // // This member is required. RateKey RateKey // The maximum number of requests, which have an identical value in the field - // specified by the RateKey, allowed in a five-minute period. If the number of + // specified by the RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // // This member is required. RateLimit int64 - // A unique identifier for a RateBasedRule. You use RuleId to get more information - // about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see - // UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a - // WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see - // DeleteRateBasedRule). + // A unique identifier for a RateBasedRule . You use RuleId to get more + // information about a RateBasedRule (see GetRateBasedRule ), update a + // RateBasedRule (see UpdateRateBasedRule ), insert a RateBasedRule into a WebACL + // or delete one from a WebACL (see UpdateWebACL ), or delete a RateBasedRule from + // AWS WAF (see DeleteRateBasedRule ). // // This member is required. RuleId *string - // A friendly name or description for the metrics for a RateBasedRule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RateBasedRule. + // A friendly name or description for the metrics for a RateBasedRule . The name + // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length + // 128 and minimum length one. It can't contain whitespace or metric names reserved + // for AWS WAF, including "All" and "Default_Action." You can't change the name of + // the metric after you create the RateBasedRule . MetricName *string - // A friendly name or description for a RateBasedRule. You can't change the name of - // a RateBasedRule after you create it. + // A friendly name or description for a RateBasedRule . You can't change the name + // of a RateBasedRule after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetRegexMatchSet request, RegexMatchSet is a complex type that -// contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that -// you specified when you updated the RegexMatchSet. The values are contained in a -// RegexMatchTuple object, which specify the parts of web requests that you want -// AWS WAF to inspect and the values that you want AWS WAF to search for. If a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetRegexMatchSet request, RegexMatchSet is a complex type +// that contains the RegexMatchSetId and Name of a RegexMatchSet , and the values +// that you specified when you updated the RegexMatchSet . The values are contained +// in a RegexMatchTuple object, which specify the parts of web requests that you +// want AWS WAF to inspect and the values that you want AWS WAF to search for. If a // RegexMatchSet contains more than one RegexMatchTuple object, a request needs to // match the settings in only one ByteMatchTuple to be considered a match. type RegexMatchSet struct { - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . Name *string - // The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get - // information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet - // (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from - // a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see - // DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by - // ListRegexMatchSets. + // The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get + // information about a RegexMatchSet (see GetRegexMatchSet ), update a + // RegexMatchSet (see UpdateRegexMatchSet ), insert a RegexMatchSet into a Rule or + // delete one from a Rule (see UpdateRule ), and delete a RegexMatchSet from AWS + // WAF (see DeleteRegexMatchSet ). RegexMatchSetId is returned by + // CreateRegexMatchSet and by ListRegexMatchSets . RegexMatchSetId *string // Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object // contains: - // - // * The part of a web request that you want AWS WAF to inspect, such as - // a query string or the value of the User-Agent header. - // - // * The identifier of the - // pattern (a regular expression) that you want AWS WAF to look for. For more - // information, see RegexPatternSet. - // - // * Whether to perform any conversions on the - // request, such as converting it to lowercase, before inspecting it for the - // specified string. + // - The part of a web request that you want AWS WAF to inspect, such as a query + // string or the value of the User-Agent header. + // - The identifier of the pattern (a regular expression) that you want AWS WAF + // to look for. For more information, see RegexPatternSet . + // - Whether to perform any conversions on the request, such as converting it to + // lowercase, before inspecting it for the specified string. RegexMatchTuples []RegexMatchTuple noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListRegexMatchSets. Each RegexMatchSetSummary object -// includes the Name and RegexMatchSetId for one RegexMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListRegexMatchSets . Each RegexMatchSetSummary +// object includes the Name and RegexMatchSetId for one RegexMatchSet . type RegexMatchSetSummary struct { - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . // // This member is required. Name *string - // The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get - // information about a RegexMatchSet, update a RegexMatchSet, remove a - // RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get + // information about a RegexMatchSet , update a RegexMatchSet , remove a + // RegexMatchSet from a Rule , and delete a RegexMatchSet from AWS WAF. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -977,27 +839,25 @@ type RegexMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies -// whether to insert or delete a RegexMatchTuple and includes the settings for the -// RegexMatchTuple. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateRegexMatchSet request, RegexMatchSetUpdate +// specifies whether to insert or delete a RegexMatchTuple and includes the +// settings for the RegexMatchTuple . type RegexMatchSetUpdate struct { - // Specifies whether to insert or delete a RegexMatchTuple. + // Specifies whether to insert or delete a RegexMatchTuple . // // This member is required. Action ChangeAction - // Information about the part of a web request that you want AWS WAF to inspect and - // the identifier of the regular expression (regex) pattern that you want AWS WAF - // to search for. If you specify DELETE for the value of Action, the - // RegexMatchTuple values must exactly match the values in the RegexMatchTuple that - // you want to delete from the RegexMatchSet. + // Information about the part of a web request that you want AWS WAF to inspect + // and the identifier of the regular expression (regex) pattern that you want AWS + // WAF to search for. If you specify DELETE for the value of Action , the + // RegexMatchTuple values must exactly match the values in the RegexMatchTuple + // that you want to delete from the RegexMatchSet . // // This member is required. RegexMatchTuple *RegexMatchTuple @@ -1005,110 +865,72 @@ type RegexMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The regular expression pattern that you want AWS WAF to search for -// in web requests, the location in requests that you want AWS WAF to search, and -// other settings. Each RegexMatchTuple object contains: -// -// * The part of a web -// request that you want AWS WAF to inspect, such as a query string or the value of -// the User-Agent header. -// -// * The identifier of the pattern (a regular expression) -// that you want AWS WAF to look for. For more information, see RegexPatternSet. -// -// * -// Whether to perform any conversions on the request, such as converting it to -// lowercase, before inspecting it for the specified string. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The regular expression pattern that you want AWS WAF to search +// for in web requests, the location in requests that you want AWS WAF to search, +// and other settings. Each RegexMatchTuple object contains: +// - The part of a web request that you want AWS WAF to inspect, such as a query +// string or the value of the User-Agent header. +// - The identifier of the pattern (a regular expression) that you want AWS WAF +// to look for. For more information, see RegexPatternSet . +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. type RegexMatchTuple struct { - // Specifies where in a web request to look for the RegexPatternSet. + // Specifies where in a web request to look for the RegexPatternSet . // // This member is required. FieldToMatch *FieldToMatch - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet (see GetRegexPatternSet), update a - // RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a - // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and - // delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). + // The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet (see GetRegexPatternSet ), update a + // RegexPatternSet (see UpdateRegexPatternSet ), insert a RegexPatternSet into a + // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ), and + // delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ). // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on RegexPatternSet before inspecting a - // request for a match. You can only specify a single type of TextTransformation. - // CMD_LINE When you're concerned that attackers are injecting an operating system - // commandline command and using unusual formatting to disguise some or all of the - // command, use this option to perform the following transformations: - // - // * Delete the - // following characters: \ " ' ^ - // - // * Delete spaces before the following characters: - // / ( - // - // * Replace the following characters with a space: , ; - // - // * Replace multiple - // spaces with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on RegexPatternSet before + // inspecting a request for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system commandline command and using unusual formatting to disguise + // some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -1116,60 +938,56 @@ type RegexMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The RegexPatternSet specifies the regular expression (regex) pattern -// that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The RegexPatternSet specifies the regular expression (regex) +// pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t . You can then // configure AWS WAF to reject those requests. type RegexPatternSet struct { - // The identifier for the RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // The identifier for the RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet , update a RegexPatternSet , remove a + // RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS + // WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string // Specifies the regular expression (regex) patterns that you want AWS WAF to - // search for, such as B[a@]dB[o0]t. + // search for, such as B[a@]dB[o0]t . // // This member is required. RegexPatternStrings []string - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListRegexPatternSets. Each RegexPatternSetSummary object -// includes the Name and RegexPatternSetId for one RegexPatternSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListRegexPatternSets . Each RegexPatternSetSummary +// object includes the Name and RegexPatternSetId for one RegexPatternSet . type RegexPatternSetSummary struct { - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . // // This member is required. Name *string - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet , update a RegexPatternSet , remove a + // RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS + // WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string @@ -1177,24 +995,22 @@ type RegexPatternSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies -// whether to insert or delete a RegexPatternString and includes the settings for -// the RegexPatternString. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateRegexPatternSet request, RegexPatternSetUpdate +// specifies whether to insert or delete a RegexPatternString and includes the +// settings for the RegexPatternString . type RegexPatternSetUpdate struct { - // Specifies whether to insert or delete a RegexPatternString. + // Specifies whether to insert or delete a RegexPatternString . // // This member is required. Action ChangeAction - // Specifies the regular expression (regex) pattern that you want AWS WAF to search - // for, such as B[a@]dB[o0]t. + // Specifies the regular expression (regex) pattern that you want AWS WAF to + // search for, such as B[a@]dB[o0]t . // // This member is required. RegexPatternString *string @@ -1202,118 +1018,106 @@ type RegexPatternSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet -// objects that identify the web requests that you want to allow, block, or count. -// For example, you might create a Rule that includes the following predicates: -// -// * -// An IPSet that causes AWS WAF to search for web requests that originate from the -// IP address 192.0.2.44 +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A combination of ByteMatchSet , IPSet , and/or +// SqlInjectionMatchSet objects that identify the web requests that you want to +// allow, block, or count. For example, you might create a Rule that includes the +// following predicates: +// - An IPSet that causes AWS WAF to search for web requests that originate from +// the IP address 192.0.2.44 +// - A ByteMatchSet that causes AWS WAF to search for web requests for which the +// value of the User-Agent header is BadBot . // -// * A ByteMatchSet that causes AWS WAF to search for web -// requests for which the value of the User-Agent header is BadBot. -// -// To match the -// settings in this Rule, a request must originate from 192.0.2.44 AND include a -// User-Agent header for which the value is BadBot. +// To match the settings in this Rule , a request must originate from 192.0.2.44 +// AND include a User-Agent header for which the value is BadBot . type Rule struct { - // The Predicates object contains one Predicate element for each ByteMatchSet, - // IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + // The Predicates object contains one Predicate element for each ByteMatchSet , + // IPSet , or SqlInjectionMatchSet object that you want to include in a Rule . // // This member is required. Predicates []Predicate - // A unique identifier for a Rule. You use RuleId to get more information about a - // Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL - // or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF - // (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + // A unique identifier for a Rule . You use RuleId to get more information about a + // Rule (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a + // WebACL or delete a one from a WebACL (see UpdateWebACL ), or delete a Rule from + // AWS WAF (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string - // A friendly name or description for the metrics for this Rule. The name can + // A friendly name or description for the metrics for this Rule . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the Rule. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the Rule . MetricName *string - // The friendly name or description for the Rule. You can't change the name of a + // The friendly name or description for the Rule . You can't change the name of a // Rule after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A collection of predefined rules that you can add to a web ACL. Rule -// groups are subject to the following limits: -// -// * Three rule groups per account. -// You can request an increase to this limit by contacting customer support. -// -// * One -// rule group per web ACL. -// -// * Ten rules per rule group. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A collection of predefined rules that you can add to a web ACL. +// Rule groups are subject to the following limits: +// - Three rule groups per account. You can request an increase to this limit by +// contacting customer support. +// - One rule group per web ACL. +// - Ten rules per rule group. type RuleGroup struct { - // A unique identifier for a RuleGroup. You use RuleGroupId to get more information - // about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), - // insert a RuleGroup into a WebACL or delete a one from a WebACL (see - // UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). - // RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + // A unique identifier for a RuleGroup . You use RuleGroupId to get more + // information about a RuleGroup (see GetRuleGroup ), update a RuleGroup (see + // UpdateRuleGroup ), insert a RuleGroup into a WebACL or delete a one from a + // WebACL (see UpdateWebACL ), or delete a RuleGroup from AWS WAF (see + // DeleteRuleGroup ). RuleGroupId is returned by CreateRuleGroup and by + // ListRuleGroups . // // This member is required. RuleGroupId *string - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . MetricName *string - // The friendly name or description for the RuleGroup. You can't change the name of - // a RuleGroup after you create it. + // The friendly name or description for the RuleGroup . You can't change the name + // of a RuleGroup after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the friendly name or description of the -// RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the friendly name or description of +// the RuleGroup . type RuleGroupSummary struct { - // A friendly name or description of the RuleGroup. You can't change the name of a + // A friendly name or description of the RuleGroup . You can't change the name of a // RuleGroup after you create it. // // This member is required. Name *string - // A unique identifier for a RuleGroup. You use RuleGroupId to get more information - // about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), - // insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), - // or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // A unique identifier for a RuleGroup . You use RuleGroupId to get more + // information about a RuleGroup (see GetRuleGroup ), update a RuleGroup (see + // UpdateRuleGroup ), insert a RuleGroup into a WebACL or delete one from a WebACL + // (see UpdateWebACL ), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup ). + // RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string @@ -1321,25 +1125,23 @@ type RuleGroupSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies an ActivatedRule and indicates whether you want to add it -// to a RuleGroup or delete it from a RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies an ActivatedRule and indicates whether you want to +// add it to a RuleGroup or delete it from a RuleGroup . type RuleGroupUpdate struct { - // Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an - // ActivatedRule from a RuleGroup. + // Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an + // ActivatedRule from a RuleGroup . // // This member is required. Action ChangeAction - // The ActivatedRule object specifies a Rule that you want to insert or delete, the - // priority of the Rule in the WebACL, and the action that you want AWS WAF to take - // when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + // The ActivatedRule object specifies a Rule that you want to insert or delete, + // the priority of the Rule in the WebACL , and the action that you want AWS WAF to + // take when a web request matches the Rule ( ALLOW , BLOCK , or COUNT ). // // This member is required. ActivatedRule *ActivatedRule @@ -1347,26 +1149,24 @@ type RuleGroupUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the friendly name or description of the -// Rule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the friendly name or description of +// the Rule . type RuleSummary struct { - // A friendly name or description of the Rule. You can't change the name of a Rule + // A friendly name or description of the Rule . You can't change the name of a Rule // after you create it. // // This member is required. Name *string - // A unique identifier for a Rule. You use RuleId to get more information about a - // Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL - // or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF - // (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + // A unique identifier for a Rule . You use RuleId to get more information about a + // Rule (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a + // WebACL or delete one from a WebACL (see UpdateWebACL ), or delete a Rule from + // AWS WAF (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string @@ -1374,23 +1174,21 @@ type RuleSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies a Predicate (such as an IPSet) and indicates whether you -// want to add it to a Rule or delete it from a Rule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies a Predicate (such as an IPSet ) and indicates whether +// you want to add it to a Rule or delete it from a Rule . type RuleUpdate struct { - // Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate - // from a Rule. + // Specify INSERT to add a Predicate to a Rule . Use DELETE to remove a Predicate + // from a Rule . // // This member is required. Action ChangeAction - // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + // The ID of the Predicate (such as an IPSet ) that you want to add to a Rule . // // This member is required. Predicate *Predicate @@ -1398,16 +1196,14 @@ type RuleUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes a -// SampledHTTPRequests complex type that appears as SampledRequests in the response -// syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web -// request that is returned by GetSampledRequests. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes a +// SampledHTTPRequests complex type that appears as SampledRequests in the +// response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for +// each web request that is returned by GetSampledRequests . type SampledHTTPRequest struct { // A complex type that contains detailed information about the request. @@ -1417,13 +1213,13 @@ type SampledHTTPRequest struct { // A value that indicates how one result in the response relates proportionally to // other results in the response. A result that has a weight of 2 represents - // roughly twice as many CloudFront web requests as a result that has a weight of - // 1. + // roughly twice as many CloudFront web requests as a result that has a weight of 1 + // . // // This member is required. Weight int64 - // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + // The action for the Rule that the request matched: ALLOW , BLOCK , or COUNT . Action *string // This value is returned if the GetSampledRequests request specifies the ID of a @@ -1439,21 +1235,20 @@ type SampledHTTPRequest struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies a constraint on the size of a part of the web request. AWS -// WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression -// in the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that -// expression is true, the SizeConstraint is considered to match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies a constraint on the size of a part of the web request. +// AWS WAF uses the Size , ComparisonOperator , and FieldToMatch to build an +// expression in the form of " Size ComparisonOperator size in bytes of +// FieldToMatch ". If that expression is true, the SizeConstraint is considered to +// match. type SizeConstraint struct { // The type of comparison you want AWS WAF to perform. AWS WAF uses this in // combination with the provided Size and FieldToMatch to build an expression in - // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // the form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that // expression is true, the SizeConstraint is considered to match. EQ: Used to test // if the Size is equal to the size of the FieldToMatch NE: Used to test if the // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size @@ -1471,84 +1266,54 @@ type SizeConstraint struct { FieldToMatch *FieldToMatch // The size in bytes that you want AWS WAF to compare against the size of the - // specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator - // and FieldToMatch to build an expression in the form of "SizeComparisonOperator - // size in bytes of FieldToMatch". If that expression is true, the SizeConstraint - // is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 - // GB). If you specify URI for the value of Type, the / in the URI counts as one - // character. For example, the URI /logo.jpg is nine characters long. + // specified FieldToMatch . AWS WAF uses this in combination with + // ComparisonOperator and FieldToMatch to build an expression in the form of " Size + // ComparisonOperator size in bytes of FieldToMatch ". If that expression is true, + // the SizeConstraint is considered to match. Valid values for size are 0 - + // 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type , the / + // in the URI counts as one character. For example, the URI /logo.jpg is nine + // characters long. // // This member is required. Size int64 - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. Note that if - // you choose BODY for the value of Type, you must choose NONE for - // TextTransformation because CloudFront forwards only the first 8192 bytes for - // inspection. NONE Specify NONE if you don't want to perform any text - // transformations. CMD_LINE When you're concerned that attackers are injecting an - // operating system command line command and using unusual formatting to disguise - // some or all of the command, use this option to perform the following + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. Note that if you choose BODY for the value of Type , you + // must choose NONE for TextTransformation because CloudFront forwards only the + // first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform + // any text transformations. CMD_LINE When you're concerned that attackers are + // injecting an operating system command line command and using unusual formatting + // to disguise some or all of the command, use this option to perform the following // transformations: - // - // * Delete the following characters: \ " ' ^ - // - // * Delete spaces - // before the following characters: / ( - // - // * Replace the following characters with a - // space: , ; - // - // * Replace multiple spaces with one space - // - // * Convert uppercase - // letters (A-Z) to lowercase (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to - // replace the following characters with a space character (decimal 32): - // - // * \f, - // formfeed, decimal 12 - // - // * \t, tab, decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, - // carriage return, decimal 13 - // - // * \v, vertical tab, decimal 11 - // - // * non-breaking - // space, decimal 160 - // - // COMPRESS_WHITE_SPACE also replaces multiple spaces with one - // space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters - // with unencoded characters. HTML_ENTITY_DECODE performs the following - // operations: - // - // * Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; - // with a non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less - // than" symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 + // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. + // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with + // unencoded characters. HTML_ENTITY_DECODE performs the following operations: + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. // // This member is required. TextTransformation TextTransformation @@ -1556,25 +1321,23 @@ type SizeConstraint struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains SizeConstraint objects, which specify -// the parts of web requests that you want AWS WAF to inspect the size of. If a -// SizeConstraintSet contains more than one SizeConstraint object, a request only -// needs to match one constraint to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains SizeConstraint objects, which +// specify the parts of web requests that you want AWS WAF to inspect the size of. +// If a SizeConstraintSet contains more than one SizeConstraint object, a request +// only needs to match one constraint to be considered a match. type SizeConstraintSet struct { - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get - // information about a SizeConstraintSet (see GetSizeConstraintSet), update a - // SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into - // a Rule or delete one from a Rule (see UpdateRule), and delete a - // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). + // A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to + // get information about a SizeConstraintSet (see GetSizeConstraintSet ), update a + // SizeConstraintSet (see UpdateSizeConstraintSet ), insert a SizeConstraintSet + // into a Rule or delete one from a Rule (see UpdateRule ), and delete a + // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet ). // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -1584,33 +1347,31 @@ type SizeConstraintSet struct { // This member is required. SizeConstraints []SizeConstraint - // The name, if any, of the SizeConstraintSet. + // The name, if any, of the SizeConstraintSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of a SizeConstraintSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of a SizeConstraintSet . type SizeConstraintSetSummary struct { - // The name of the SizeConstraintSet, if any. + // The name of the SizeConstraintSet , if any. // // This member is required. Name *string - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get - // information about a SizeConstraintSet (see GetSizeConstraintSet), update a - // SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into - // a Rule or delete one from a Rule (see UpdateRule), and delete a - // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). + // A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to + // get information about a SizeConstraintSet (see GetSizeConstraintSet ), update a + // SizeConstraintSet (see UpdateSizeConstraintSet ), insert a SizeConstraintSet + // into a Rule or delete one from a Rule (see UpdateRule ), and delete a + // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet ). // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -1618,26 +1379,24 @@ type SizeConstraintSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect the // size of and indicates whether you want to add the specification to a -// SizeConstraintSet or delete it from a SizeConstraintSet. +// SizeConstraintSet or delete it from a SizeConstraintSet . type SizeConstraintSetUpdate struct { - // Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use - // DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. + // Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet . Use + // DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet . // // This member is required. Action ChangeAction // Specifies a constraint on the size of a part of the web request. AWS WAF uses - // the Size, ComparisonOperator, and FieldToMatch to build an expression in the - // form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // the Size , ComparisonOperator , and FieldToMatch to build an expression in the + // form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that // expression is true, the SizeConstraint is considered to match. // // This member is required. @@ -1646,27 +1405,25 @@ type SizeConstraintSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains SqlInjectionMatchTuple objects, which -// specify the parts of web requests that you want AWS WAF to inspect for snippets -// of malicious SQL code and, if you want AWS WAF to inspect a header, the name of -// the header. If a SqlInjectionMatchSet contains more than one +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains SqlInjectionMatchTuple objects, +// which specify the parts of web requests that you want AWS WAF to inspect for +// snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the +// name of the header. If a SqlInjectionMatchSet contains more than one // SqlInjectionMatchTuple object, a request needs to include snippets of SQL code // in only one of the specified parts of the request to be considered a match. type SqlInjectionMatchSet struct { - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId - // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), - // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a - // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and - // delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). - // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId + // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet ), + // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ), insert a + // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule ), + // and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet + // ). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -1677,33 +1434,31 @@ type SqlInjectionMatchSet struct { // This member is required. SqlInjectionMatchTuples []SqlInjectionMatchTuple - // The name, if any, of the SqlInjectionMatchSet. + // The name, if any, of the SqlInjectionMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of a SqlInjectionMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of a SqlInjectionMatchSet . type SqlInjectionMatchSetSummary struct { - // The name of the SqlInjectionMatchSet, if any, specified by Id. + // The name of the SqlInjectionMatchSet , if any, specified by Id . // // This member is required. Name *string - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId - // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), - // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a - // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and - // delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). - // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId + // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet ), + // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ), insert a + // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule ), + // and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet + // ). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -1711,20 +1466,18 @@ type SqlInjectionMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect for +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect for // snippets of malicious SQL code and indicates whether you want to add the -// specification to a SqlInjectionMatchSet or delete it from a -// SqlInjectionMatchSet. +// specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet +// . type SqlInjectionMatchSetUpdate struct { - // Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. - // Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. + // Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet . + // Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet . // // This member is required. Action ChangeAction @@ -1739,15 +1492,13 @@ type SqlInjectionMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want AWS WAF to inspect -// for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, -// the name of the header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want AWS WAF to +// inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a +// header, the name of the header. type SqlInjectionMatchTuple struct { // Specifies where in a web request to look for snippets of malicious SQL code. @@ -1755,72 +1506,41 @@ type SqlInjectionMatchTuple struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -1828,31 +1548,29 @@ type SqlInjectionMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A summary of the rule groups you are subscribed to. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A summary of the rule groups you are subscribed to. type SubscribedRuleGroupSummary struct { - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . // // This member is required. MetricName *string - // A friendly name or description of the RuleGroup. You can't change the name of a + // A friendly name or description of the RuleGroup . You can't change the name of a // RuleGroup after you create it. // // This member is required. Name *string - // A unique identifier for a RuleGroup. + // A unique identifier for a RuleGroup . // // This member is required. RuleGroupId *string @@ -1860,16 +1578,14 @@ type SubscribedRuleGroupSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A tag associated with an AWS resource. Tags are key:value pairs that -// you can use to categorize and manage your resources, for purposes like billing. -// For example, you might set the tag key to "customer" and the value to the -// customer name or ID. You can specify one or more tags to add to each AWS +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A tag associated with an AWS resource. Tags are key:value pairs +// that you can use to categorize and manage your resources, for purposes like +// billing. For example, you might set the tag key to "customer" and the value to +// the customer name or ID. You can specify one or more tags to add to each AWS // resource, up to 50 tags for a resource. Tagging is only available through the // API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic // console. You can tag the AWS resources that you manage through AWS WAF Classic: @@ -1889,13 +1605,11 @@ type Tag struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Information for a tag associated with an AWS resource. Tags are +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Information for a tag associated with an AWS resource. Tags are // key:value pairs that you can use to categorize and manage your resources, for // purposes like billing. For example, you might set the tag key to "customer" and // the value to the customer name or ID. You can specify one or more tags to add to @@ -1914,39 +1628,37 @@ type TagInfoForResource struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetSampledRequests request, the StartTime and EndTime objects -// specify the time range for which you want AWS WAF to return a sample of web -// requests. You must specify the times in Coordinated Universal Time (UTC) format. -// UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". -// In a GetSampledRequests response, the StartTime and EndTime objects specify the -// time range for which AWS WAF actually returned a sample of web requests. AWS WAF -// gets the specified number of requests from among the first 5,000 requests that -// your AWS resource receives during the specified time period. If your resource -// receives more than 5,000 requests during that period, AWS WAF stops sampling -// after the 5,000th request. In that case, EndTime is the time that AWS WAF -// received the 5,000th request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetSampledRequests request, the StartTime and EndTime +// objects specify the time range for which you want AWS WAF to return a sample of +// web requests. You must specify the times in Coordinated Universal Time (UTC) +// format. UTC format includes the special designator, Z . For example, +// "2016-09-27T14:50Z" . In a GetSampledRequests response, the StartTime and +// EndTime objects specify the time range for which AWS WAF actually returned a +// sample of web requests. AWS WAF gets the specified number of requests from among +// the first 5,000 requests that your AWS resource receives during the specified +// time period. If your resource receives more than 5,000 requests during that +// period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime +// is the time that AWS WAF received the 5,000th request. type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a // sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes - // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. + // the special designator, Z . For example, "2016-09-27T14:50Z" . You can specify + // any time range in the previous three hours. // // This member is required. EndTime *time.Time - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your AWS resource received. You must specify the - // date and time in Coordinated Universal Time (UTC) format. UTC format includes - // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. + // The beginning of the time range from which you want GetSampledRequests to + // return a sample of the requests that your AWS resource received. You must + // specify the date and time in Coordinated Universal Time (UTC) format. UTC format + // includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can + // specify any time range in the previous three hours. // // This member is required. StartTime *time.Time @@ -1954,31 +1666,25 @@ type TimeWindow struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. For the action that is associated with a rule in a WebACL, specifies -// the action that you want AWS WAF to perform when a web request matches all of -// the conditions in a rule. For the default action in a WebACL, specifies the -// action that you want AWS WAF to take when a web request doesn't match all of the -// conditions in any of the rules in a WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. For the action that is associated with a rule in a WebACL , +// specifies the action that you want AWS WAF to perform when a web request matches +// all of the conditions in a rule. For the default action in a WebACL , specifies +// the action that you want AWS WAF to take when a web request doesn't match all of +// the conditions in any of the rules in a WebACL . type WafAction struct { - // Specifies how you want AWS WAF to respond to requests that match the settings in - // a Rule. Valid settings include the following: - // - // * ALLOW: AWS WAF allows - // requests - // - // * BLOCK: AWS WAF blocks requests - // - // * COUNT: AWS WAF increments a - // counter of the requests that match all of the conditions in the rule. AWS WAF - // then continues to inspect the web request based on the remaining rules in the - // web ACL. You can't specify COUNT for the default action for a WebACL. + // Specifies how you want AWS WAF to respond to requests that match the settings + // in a Rule . Valid settings include the following: + // - ALLOW : AWS WAF allows requests + // - BLOCK : AWS WAF blocks requests + // - COUNT : AWS WAF increments a counter of the requests that match all of the + // conditions in the rule. AWS WAF then continues to inspect the web request based + // on the remaining rules in the web ACL. You can't specify COUNT for the default + // action for a WebACL . // // This member is required. Type WafActionType @@ -1986,18 +1692,16 @@ type WafAction struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The action to take if any rule within the RuleGroup matches a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The action to take if any rule within the RuleGroup matches a // request. type WafOverrideAction struct { - // COUNT overrides the action specified by the individual rule within a RuleGroup . - // If set to NONE, the rule's action will take place. + // COUNT overrides the action specified by the individual rule within a RuleGroup + // . If set to NONE , the rule's action will take place. // // This member is required. Type WafOverrideActionType @@ -2005,20 +1709,18 @@ type WafOverrideAction struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the Rules that identify the requests that you want to -// allow, block, or count. In a WebACL, you also specify a default action (ALLOW or -// BLOCK), and the action for each Rule that you add to a WebACL, for example, +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the Rules that identify the requests that you want to +// allow, block, or count. In a WebACL , you also specify a default action ( ALLOW +// or BLOCK ), and the action for each Rule that you add to a WebACL , for example, // block requests from specified IP addresses or block requests from specified // referrers. You also associate the WebACL with a CloudFront distribution to // identify the requests that you want AWS WAF to filter. If you add more than one -// Rule to a WebACL, a request needs to match only one of the specifications to be -// allowed, blocked, or counted. For more information, see UpdateWebACL. +// Rule to a WebACL , a request needs to match only one of the specifications to be +// allowed, blocked, or counted. For more information, see UpdateWebACL . type WebACL struct { // The action to perform if none of the Rules contained in the WebACL match. The @@ -2027,28 +1729,28 @@ type WebACL struct { // This member is required. DefaultAction *WafAction - // An array that contains the action for each Rule in a WebACL, the priority of the - // Rule, and the ID of the Rule. + // An array that contains the action for each Rule in a WebACL , the priority of + // the Rule , and the ID of the Rule . // // This member is required. Rules []ActivatedRule - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL - // from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by - // ListWebACLs. + // A unique identifier for a WebACL . You use WebACLId to get information about a + // WebACL (see GetWebACL ), update a WebACL (see UpdateWebACL ), and delete a + // WebACL from AWS WAF (see DeleteWebACL ). WebACLId is returned by CreateWebACL + // and by ListWebACLs . // // This member is required. WebACLId *string - // A friendly name or description for the metrics for this WebACL. The name can + // A friendly name or description for the metrics for this WebACL . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the WebACL. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the WebACL . MetricName *string - // A friendly name or description of the WebACL. You can't change the name of a + // A friendly name or description of the WebACL . You can't change the name of a // WebACL after you create it. Name *string @@ -2058,25 +1760,24 @@ type WebACL struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name or description of the WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name or description of the +// WebACL . type WebACLSummary struct { - // A friendly name or description of the WebACL. You can't change the name of a + // A friendly name or description of the WebACL . You can't change the name of a // WebACL after you create it. // // This member is required. Name *string - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL - // from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by - // ListWebACLs. + // A unique identifier for a WebACL . You use WebACLId to get information about a + // WebACL (see GetWebACL ), update a WebACL (see UpdateWebACL ), and delete a + // WebACL from AWS WAF (see DeleteWebACL ). WebACLId is returned by CreateWebACL + // and by ListWebACLs . // // This member is required. WebACLId *string @@ -2084,25 +1785,23 @@ type WebACLSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies whether to insert a Rule into or delete a Rule from a -// WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies whether to insert a Rule into or delete a Rule from a +// WebACL . type WebACLUpdate struct { - // Specifies whether to insert a Rule into or delete a Rule from a WebACL. + // Specifies whether to insert a Rule into or delete a Rule from a WebACL . // // This member is required. Action ChangeAction // The ActivatedRule object in an UpdateWebACL request specifies a Rule that you - // want to insert or delete, the priority of the Rule in the WebACL, and the action - // that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, - // or COUNT). + // want to insert or delete, the priority of the Rule in the WebACL , and the + // action that you want AWS WAF to take when a web request matches the Rule ( ALLOW + // , BLOCK , or COUNT ). // // This member is required. ActivatedRule *ActivatedRule @@ -2110,26 +1809,24 @@ type WebACLUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains XssMatchTuple objects, which specify -// the parts of web requests that you want AWS WAF to inspect for cross-site -// scripting attacks and, if you want AWS WAF to inspect a header, the name of the -// header. If a XssMatchSet contains more than one XssMatchTuple object, a request -// needs to include cross-site scripting attacks in only one of the specified parts -// of the request to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains XssMatchTuple objects, which +// specify the parts of web requests that you want AWS WAF to inspect for +// cross-site scripting attacks and, if you want AWS WAF to inspect a header, the +// name of the header. If a XssMatchSet contains more than one XssMatchTuple +// object, a request needs to include cross-site scripting attacks in only one of +// the specified parts of the request to be considered a match. type XssMatchSet struct { - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information - // about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see - // UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete an XssMatchSet from AWS WAF (see - // DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by - // ListXssMatchSets. + // A unique identifier for an XssMatchSet . You use XssMatchSetId to get + // information about an XssMatchSet (see GetXssMatchSet ), update an XssMatchSet + // (see UpdateXssMatchSet ), insert an XssMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete an XssMatchSet from AWS WAF (see + // DeleteXssMatchSet ). XssMatchSetId is returned by CreateXssMatchSet and by + // ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -2140,32 +1837,30 @@ type XssMatchSet struct { // This member is required. XssMatchTuples []XssMatchTuple - // The name, if any, of the XssMatchSet. + // The name, if any, of the XssMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of an XssMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of an XssMatchSet . type XssMatchSetSummary struct { - // The name of the XssMatchSet, if any, specified by Id. + // The name of the XssMatchSet , if any, specified by Id . // // This member is required. Name *string - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information - // about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see - // UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete an XssMatchSet from AWS WAF (see - // DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by - // ListXssMatchSets. + // A unique identifier for an XssMatchSet . You use XssMatchSetId to get + // information about a XssMatchSet (see GetXssMatchSet ), update an XssMatchSet + // (see UpdateXssMatchSet ), insert an XssMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete an XssMatchSet from AWS WAF (see + // DeleteXssMatchSet ). XssMatchSetId is returned by CreateXssMatchSet and by + // ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -2173,19 +1868,17 @@ type XssMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect for +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect for // cross-site scripting attacks and indicates whether you want to add the -// specification to an XssMatchSet or delete it from an XssMatchSet. +// specification to an XssMatchSet or delete it from an XssMatchSet . type XssMatchSetUpdate struct { - // Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to - // remove an XssMatchSetUpdate from an XssMatchSet. + // Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet . Use DELETE to + // remove an XssMatchSetUpdate from an XssMatchSet . // // This member is required. Action ChangeAction @@ -2200,15 +1893,13 @@ type XssMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want AWS WAF to inspect -// for cross-site scripting attacks and, if you want AWS WAF to inspect a header, -// the name of the header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want AWS WAF to +// inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a +// header, the name of the header. type XssMatchTuple struct { // Specifies where in a web request to look for cross-site scripting attacks. @@ -2216,72 +1907,41 @@ type XssMatchTuple struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation diff --git a/service/wafregional/api_client.go b/service/wafregional/api_client.go index 305e37b999b..45bd87bface 100644 --- a/service/wafregional/api_client.go +++ b/service/wafregional/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/wafregional/api_op_AssociateWebACL.go b/service/wafregional/api_op_AssociateWebACL.go index f16e758f25e..93e307b77c9 100644 --- a/service/wafregional/api_op_AssociateWebACL.go +++ b/service/wafregional/api_op_AssociateWebACL.go @@ -11,13 +11,11 @@ import ( ) // This is AWS WAF Classic Regional documentation. For more information, see AWS -// WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Associates a web ACL with a resource, either an application load +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Associates a web ACL with a resource, either an application load // balancer or Amazon API Gateway stage. func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInput, optFns ...func(*Options)) (*AssociateWebACLOutput, error) { if params == nil { @@ -39,13 +37,11 @@ type AssociateWebACLInput struct { // The ARN (Amazon Resource Name) of the resource to be protected, either an // application load balancer or Amazon API Gateway stage. The ARN should be in one // of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway stage: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an Amazon API Gateway stage: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_CreateByteMatchSet.go b/service/wafregional/api_op_CreateByteMatchSet.go index 4b87c425fd6..01b2cba1fe9 100644 --- a/service/wafregional/api_op_CreateByteMatchSet.go +++ b/service/wafregional/api_op_CreateByteMatchSet.go @@ -11,37 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify -// the part of a web request that you want AWS WAF to inspect, such as the values -// of the User-Agent header or the query string. For example, you can create a -// ByteMatchSet that matches any requests with User-Agent headers that contain the -// string BadBot. You can then configure AWS WAF to reject those requests. To -// create and configure a ByteMatchSet, perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a ByteMatchSet . You then use UpdateByteMatchSet to +// identify the part of a web request that you want AWS WAF to inspect, such as the +// values of the User-Agent header or the query string. For example, you can +// create a ByteMatchSet that matches any requests with User-Agent headers that +// contain the string BadBot . You can then configure AWS WAF to reject those +// requests. To create and configure a ByteMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateByteMatchSet request. +// - Submit a CreateByteMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateByteMatchSet request. +// - Submit an UpdateByteMatchSet request to specify the part of the request that +// you want AWS WAF to inspect (for example, the header or the URI) and the value +// that you want AWS WAF to watch for. // -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateByteMatchSet request. -// -// * Submit a CreateByteMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateByteMatchSet request. -// -// * Submit an -// UpdateByteMatchSet request to specify the part of the request that you want AWS -// WAF to inspect (for example, the header or the URI) and the value that you want -// AWS WAF to watch for. -// -// For more information about how to use the AWS WAF API to -// allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateByteMatchSet(ctx context.Context, params *CreateByteMatchSetInput, optFns ...func(*Options)) (*CreateByteMatchSetOutput, error) { if params == nil { params = &CreateByteMatchSetInput{} @@ -59,13 +50,13 @@ func (c *Client) CreateByteMatchSet(ctx context.Context, params *CreateByteMatch type CreateByteMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . // // This member is required. Name *string @@ -80,7 +71,7 @@ type CreateByteMatchSetOutput struct { // The ChangeToken that you used to submit the CreateByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_CreateGeoMatchSet.go b/service/wafregional/api_op_CreateGeoMatchSet.go index 3b3c8a64b69..8d8d1c4ff57 100644 --- a/service/wafregional/api_op_CreateGeoMatchSet.go +++ b/service/wafregional/api_op_CreateGeoMatchSet.go @@ -11,36 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an GeoMatchSet, which you use to specify which web requests -// you want to allow or block based on the country that the requests originate -// from. For example, if you're receiving a lot of requests from one or more -// countries and you want to block the requests, you can create an GeoMatchSet that -// contains those countries and then configure AWS WAF to block the requests. To -// create and configure a GeoMatchSet, perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an GeoMatchSet , which you use to specify which web +// requests you want to allow or block based on the country that the requests +// originate from. For example, if you're receiving a lot of requests from one or +// more countries and you want to block the requests, you can create an GeoMatchSet +// that contains those countries and then configure AWS WAF to block the requests. +// To create and configure a GeoMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateGeoMatchSet request. +// - Submit a CreateGeoMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateGeoMatchSet request. +// - Submit an UpdateGeoMatchSetSet request to specify the countries that you +// want AWS WAF to watch for. // -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateGeoMatchSet request. -// -// * Submit a CreateGeoMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateGeoMatchSet request. -// -// * Submit an -// UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to -// watch for. -// -// For more information about how to use the AWS WAF API to allow or -// block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateGeoMatchSet(ctx context.Context, params *CreateGeoMatchSetInput, optFns ...func(*Options)) (*CreateGeoMatchSetOutput, error) { if params == nil { params = &CreateGeoMatchSetInput{} @@ -58,13 +49,13 @@ func (c *Client) CreateGeoMatchSet(ctx context.Context, params *CreateGeoMatchSe type CreateGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the GeoMatchSet. You can't change Name after - // you create the GeoMatchSet. + // A friendly name or description of the GeoMatchSet . You can't change Name after + // you create the GeoMatchSet . // // This member is required. Name *string @@ -76,11 +67,11 @@ type CreateGeoMatchSetOutput struct { // The ChangeToken that you used to submit the CreateGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet - // contains no GeoMatchConstraints. + // contains no GeoMatchConstraints . GeoMatchSet *types.GeoMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_CreateIPSet.go b/service/wafregional/api_op_CreateIPSet.go index 515edf024a6..fd91d23810d 100644 --- a/service/wafregional/api_op_CreateIPSet.go +++ b/service/wafregional/api_op_CreateIPSet.go @@ -11,36 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an IPSet, which you use to specify which web requests that -// you want to allow or block based on the IP addresses that the requests originate -// from. For example, if you're receiving a lot of requests from one or more -// individual IP addresses or one or more ranges of IP addresses and you want to -// block the requests, you can create an IPSet that contains those IP addresses and -// then configure AWS WAF to block the requests. To create and configure an IPSet, -// perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an IPSet , which you use to specify which web requests +// that you want to allow or block based on the IP addresses that the requests +// originate from. For example, if you're receiving a lot of requests from one or +// more individual IP addresses or one or more ranges of IP addresses and you want +// to block the requests, you can create an IPSet that contains those IP addresses +// and then configure AWS WAF to block the requests. To create and configure an +// IPSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateIPSet request. +// - Submit a CreateIPSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateIPSet request to specify the IP addresses that you want AWS +// WAF to watch for. // -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateIPSet request. -// -// * Submit a -// CreateIPSet request. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateIPSet request. -// -// * Submit an -// UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch -// for. -// -// For more information about how to use the AWS WAF API to allow or block -// HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optFns ...func(*Options)) (*CreateIPSetOutput, error) { if params == nil { params = &CreateIPSetInput{} @@ -58,13 +50,13 @@ func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optF type CreateIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the IPSet. You can't change Name after you - // create the IPSet. + // A friendly name or description of the IPSet . You can't change Name after you + // create the IPSet . // // This member is required. Name *string @@ -76,7 +68,7 @@ type CreateIPSetOutput struct { // The ChangeToken that you used to submit the CreateIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // The IPSet returned in the CreateIPSet response. diff --git a/service/wafregional/api_op_CreateRateBasedRule.go b/service/wafregional/api_op_CreateRateBasedRule.go index 6f12c5b4b92..6161e4e3a1e 100644 --- a/service/wafregional/api_op_CreateRateBasedRule.go +++ b/service/wafregional/api_op_CreateRateBasedRule.go @@ -11,75 +11,56 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit, -// which specifies the maximum number of requests that AWS WAF allows from a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RateBasedRule . The RateBasedRule contains a RateLimit +// , which specifies the maximum number of requests that AWS WAF allows from a // specified IP address in a five-minute period. The RateBasedRule also contains // the IPSet objects, ByteMatchSet objects, and other predicates that identify the -// requests that you want to count or block if these requests exceed the RateLimit. -// If you add more than one predicate to a RateBasedRule, a request not only must -// exceed the RateLimit, but it also must match all the conditions to be counted or -// blocked. For example, suppose you add the following to a RateBasedRule: +// requests that you want to count or block if these requests exceed the RateLimit +// . If you add more than one predicate to a RateBasedRule , a request not only +// must exceed the RateLimit , but it also must match all the conditions to be +// counted or blocked. For example, suppose you add the following to a +// RateBasedRule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An -// IPSet that matches the IP address 192.0.2.44/32 +// Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a +// WebACL and specify that you want to block requests that meet the conditions in +// the rule. For a request to be blocked, it must come from the IP address +// 192.0.2.44 and the User-Agent header in the request must contain the value +// BadBot . Further, requests that match these two conditions must be received at a +// rate of more than 1,000 requests every five minutes. If both conditions are met +// and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below +// 1,000 for a five-minute period, AWS WAF no longer blocks the requests. As a +// second example, suppose you want to limit requests to a particular page on your +// site. To do this, you could add the following to a RateBasedRule : +// - A ByteMatchSet with FieldToMatch of URI +// - A PositionalConstraint of STARTS_WITH +// - A TargetString of login // -// * A ByteMatchSet that matches -// BadBot in the User-Agent header +// Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a +// WebACL , you could limit requests to your login page without affecting the rest +// of your site. To create and configure a RateBasedRule , perform the following +// steps: +// - Create and update the predicates that you want to include in the rule. For +// more information, see CreateByteMatchSet , CreateIPSet , and +// CreateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRule request. +// - Submit a CreateRateBasedRule request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRateBasedRule request to specify the predicates that you +// want to include in the rule. +// - Create and update a WebACL that contains the RateBasedRule . For more +// information, see CreateWebACL . // -// Further, you specify a RateLimit of 1,000. You -// then add the RateBasedRule to a WebACL and specify that you want to block -// requests that meet the conditions in the rule. For a request to be blocked, it -// must come from the IP address 192.0.2.44 and the User-Agent header in the -// request must contain the value BadBot. Further, requests that match these two -// conditions must be received at a rate of more than 1,000 requests every five -// minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the -// requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no -// longer blocks the requests. As a second example, suppose you want to limit -// requests to a particular page on your site. To do this, you could add the -// following to a RateBasedRule: -// -// * A ByteMatchSet with FieldToMatch of URI -// -// * A -// PositionalConstraint of STARTS_WITH -// -// * A TargetString of login -// -// Further, you -// specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you -// could limit requests to your login page without affecting the rest of your site. -// To create and configure a RateBasedRule, perform the following steps: -// -// * Create -// and update the predicates that you want to include in the rule. For more -// information, see CreateByteMatchSet, CreateIPSet, and -// CreateSqlInjectionMatchSet. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateRule request. -// -// * Submit a -// CreateRateBasedRule request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateRule request. -// -// * Submit an -// UpdateRateBasedRule request to specify the predicates that you want to include -// in the rule. -// -// * Create and update a WebACL that contains the RateBasedRule. For -// more information, see CreateWebACL. -// -// For more information about how to use the -// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBasedRuleInput, optFns ...func(*Options)) (*CreateRateBasedRuleOutput, error) { if params == nil { params = &CreateRateBasedRuleInput{} @@ -97,23 +78,23 @@ func (c *Client) CreateRateBasedRule(ctx context.Context, params *CreateRateBase type CreateRateBasedRuleInput struct { - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this RateBasedRule. The name + // A friendly name or description for the metrics for this RateBasedRule . The name // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length // 128 and minimum length one. It can't contain whitespace or metric names reserved // for AWS WAF, including "All" and "Default_Action." You can't change the name of - // the metric after you create the RateBasedRule. + // the metric after you create the RateBasedRule . // // This member is required. MetricName *string - // A friendly name or description of the RateBasedRule. You can't change the name + // A friendly name or description of the RateBasedRule . You can't change the name // of a RateBasedRule after you create it. // // This member is required. @@ -121,14 +102,14 @@ type CreateRateBasedRuleInput struct { // The field that AWS WAF uses to determine if requests are likely arriving from a // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests that arrive from the same IP address - // are subject to the RateLimit that is specified in the RateBasedRule. + // RateKey is IP . IP indicates that requests that arrive from the same IP address + // are subject to the RateLimit that is specified in the RateBasedRule . // // This member is required. RateKey types.RateKey // The maximum number of requests, which have an identical value in the field that - // is specified by RateKey, allowed in a five-minute period. If the number of + // is specified by RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // @@ -143,9 +124,9 @@ type CreateRateBasedRuleInput struct { type CreateRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the CreateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // The RateBasedRule that is returned in the CreateRateBasedRule response. diff --git a/service/wafregional/api_op_CreateRegexMatchSet.go b/service/wafregional/api_op_CreateRegexMatchSet.go index bb66b700575..c3713a2ba70 100644 --- a/service/wafregional/api_op_CreateRegexMatchSet.go +++ b/service/wafregional/api_op_CreateRegexMatchSet.go @@ -11,38 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RegexMatchSet . You then use UpdateRegexMatchSet to // identify the part of a web request that you want AWS WAF to inspect, such as the -// values of the User-Agent header or the query string. For example, you can create -// a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with -// User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You -// can then configure AWS WAF to reject those requests. To create and configure a -// RegexMatchSet, perform the following steps: +// values of the User-Agent header or the query string. For example, you can +// create a RegexMatchSet that contains a RegexMatchTuple that looks for any +// requests with User-Agent headers that match a RegexPatternSet with pattern +// B[a@]dB[o0]t . You can then configure AWS WAF to reject those requests. To +// create and configure a RegexMatchSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRegexMatchSet request. +// - Submit a CreateRegexMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexMatchSet request. +// - Submit an UpdateRegexMatchSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value, using a RegexPatternSet , that you want AWS WAF to watch for. // -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of a -// CreateRegexMatchSet request. -// -// * Submit a CreateRegexMatchSet request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateRegexMatchSet request. -// -// * Submit an UpdateRegexMatchSet -// request to specify the part of the request that you want AWS WAF to inspect (for -// example, the header or the URI) and the value, using a RegexPatternSet, that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRegexMatchSet(ctx context.Context, params *CreateRegexMatchSetInput, optFns ...func(*Options)) (*CreateRegexMatchSetOutput, error) { if params == nil { params = &CreateRegexMatchSetInput{} @@ -60,13 +51,13 @@ func (c *Client) CreateRegexMatchSet(ctx context.Context, params *CreateRegexMat type CreateRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . // // This member is required. Name *string @@ -76,9 +67,9 @@ type CreateRegexMatchSetInput struct { type CreateRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the CreateRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // A RegexMatchSet that contains no RegexMatchTuple objects. diff --git a/service/wafregional/api_op_CreateRegexPatternSet.go b/service/wafregional/api_op_CreateRegexPatternSet.go index d379c54cd6a..feedda44d83 100644 --- a/service/wafregional/api_op_CreateRegexPatternSet.go +++ b/service/wafregional/api_op_CreateRegexPatternSet.go @@ -11,34 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to -// specify the regular expression (regex) pattern that you want AWS WAF to search -// for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those -// requests. To create and configure a RegexPatternSet, perform the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RegexPatternSet . You then use UpdateRegexPatternSet +// to specify the regular expression (regex) pattern that you want AWS WAF to +// search for, such as B[a@]dB[o0]t . You can then configure AWS WAF to reject +// those requests. To create and configure a RegexPatternSet , perform the +// following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRegexPatternSet request. +// - Submit a CreateRegexPatternSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexPatternSet request. +// - Submit an UpdateRegexPatternSet request to specify the string that you want +// AWS WAF to watch for. // -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateRegexPatternSet request. -// -// * Submit a -// CreateRegexPatternSet request. -// -// * Use GetChangeToken to get the change token -// that you provide in the ChangeToken parameter of an UpdateRegexPatternSet -// request. -// -// * Submit an UpdateRegexPatternSet request to specify the string that -// you want AWS WAF to watch for. -// -// For more information about how to use the AWS -// WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexPatternSetInput, optFns ...func(*Options)) (*CreateRegexPatternSetOutput, error) { if params == nil { params = &CreateRegexPatternSetInput{} @@ -56,13 +48,13 @@ func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexP type CreateRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . // // This member is required. Name *string @@ -74,7 +66,7 @@ type CreateRegexPatternSetOutput struct { // The ChangeToken that you used to submit the CreateRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // A RegexPatternSet that contains no objects. diff --git a/service/wafregional/api_op_CreateRule.go b/service/wafregional/api_op_CreateRule.go index b18304a71ec..e027bcdb7af 100644 --- a/service/wafregional/api_op_CreateRule.go +++ b/service/wafregional/api_op_CreateRule.go @@ -11,53 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a Rule , which contains the IPSet objects, ByteMatchSet // objects, and other predicates that identify the requests that you want to block. -// If you add more than one predicate to a Rule, a request must match all of the +// If you add more than one predicate to a Rule , a request must match all of the // specifications to be allowed or blocked. For example, suppose that you add the -// following to a Rule: +// following to a Rule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An IPSet that matches the IP address 192.0.2.44/32 +// You then add the Rule to a WebACL and specify that you want to blocks requests +// that satisfy the Rule . For a request to be blocked, it must come from the IP +// address 192.0.2.44 and the User-Agent header in the request must contain the +// value BadBot . To create and configure a Rule , perform the following steps: +// - Create and update the predicates that you want to include in the Rule . For +// more information, see CreateByteMatchSet , CreateIPSet , and +// CreateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateRule request. +// - Submit a CreateRule request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRule request to specify the predicates that you want to +// include in the Rule . +// - Create and update a WebACL that contains the Rule . For more information, +// see CreateWebACL . // -// * A -// ByteMatchSet that matches BadBot in the User-Agent header -// -// You then add the Rule -// to a WebACL and specify that you want to blocks requests that satisfy the Rule. -// For a request to be blocked, it must come from the IP address 192.0.2.44 and the -// User-Agent header in the request must contain the value BadBot. To create and -// configure a Rule, perform the following steps: -// -// * Create and update the -// predicates that you want to include in the Rule. For more information, see -// CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateRule request. -// -// * Submit a CreateRule request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateRule request. -// -// * Submit an UpdateRule request to specify -// the predicates that you want to include in the Rule. -// -// * Create and update a -// WebACL that contains the Rule. For more information, see CreateWebACL. -// -// For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} @@ -75,21 +60,21 @@ func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns type CreateRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this Rule. The name can + // A friendly name or description for the metrics for this Rule . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the Rule. + // metric after you create the Rule . // // This member is required. MetricName *string - // A friendly name or description of the Rule. You can't change the name of a Rule + // A friendly name or description of the Rule . You can't change the name of a Rule // after you create it. // // This member is required. @@ -103,9 +88,9 @@ type CreateRuleInput struct { type CreateRuleOutput struct { - // The ChangeToken that you used to submit the CreateRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // The Rule returned in the CreateRule response. diff --git a/service/wafregional/api_op_CreateRuleGroup.go b/service/wafregional/api_op_CreateRuleGroup.go index ffb64d55f4b..88e0b540602 100644 --- a/service/wafregional/api_op_CreateRuleGroup.go +++ b/service/wafregional/api_op_CreateRuleGroup.go @@ -11,28 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a RuleGroup. A rule group is a collection of predefined +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a RuleGroup . A rule group is a collection of predefined // rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the // rule group. Rule groups are subject to the following limits: +// - Three rule groups per account. You can request an increase to this limit by +// contacting customer support. +// - One rule group per web ACL. +// - Ten rules per rule group. // -// * Three rule -// groups per account. You can request an increase to this limit by contacting -// customer support. -// -// * One rule group per web ACL. -// -// * Ten rules per rule -// group. -// -// For more information about how to use the AWS WAF API to allow or block -// HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) { if params == nil { params = &CreateRuleGroupInput{} @@ -50,22 +43,22 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp type CreateRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . // // This member is required. MetricName *string - // A friendly name or description of the RuleGroup. You can't change Name after you - // create a RuleGroup. + // A friendly name or description of the RuleGroup . You can't change Name after + // you create a RuleGroup . // // This member is required. Name *string @@ -80,10 +73,10 @@ type CreateRuleGroupOutput struct { // The ChangeToken that you used to submit the CreateRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string - // An empty RuleGroup. + // An empty RuleGroup . RuleGroup *types.RuleGroup // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_CreateSizeConstraintSet.go b/service/wafregional/api_op_CreateSizeConstraintSet.go index b8b4c2c7342..41e2c27f246 100644 --- a/service/wafregional/api_op_CreateSizeConstraintSet.go +++ b/service/wafregional/api_op_CreateSizeConstraintSet.go @@ -11,38 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to -// identify the part of a web request that you want AWS WAF to check for length, -// such as the length of the User-Agent header or the length of the query string. -// For example, you can create a SizeConstraintSet that matches any requests that -// have a query string that is longer than 100 bytes. You can then configure AWS -// WAF to reject those requests. To create and configure a SizeConstraintSet, -// perform the following steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a SizeConstraintSet . You then use +// UpdateSizeConstraintSet to identify the part of a web request that you want AWS +// WAF to check for length, such as the length of the User-Agent header or the +// length of the query string. For example, you can create a SizeConstraintSet +// that matches any requests that have a query string that is longer than 100 +// bytes. You can then configure AWS WAF to reject those requests. To create and +// configure a SizeConstraintSet , perform the following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateSizeConstraintSet request. +// - Submit a CreateSizeConstraintSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSizeConstraintSet request. +// - Submit an UpdateSizeConstraintSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value that you want AWS WAF to watch for. // -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a CreateSizeConstraintSet -// request. -// -// * Submit a CreateSizeConstraintSet request. -// -// * Use GetChangeToken to -// get the change token that you provide in the ChangeToken parameter of an -// UpdateSizeConstraintSet request. -// -// * Submit an UpdateSizeConstraintSet request to -// specify the part of the request that you want AWS WAF to inspect (for example, -// the header or the URI) and the value that you want AWS WAF to watch for. -// -// For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSizeConstraintSetInput, optFns ...func(*Options)) (*CreateSizeConstraintSetOutput, error) { if params == nil { params = &CreateSizeConstraintSetInput{} @@ -60,13 +51,13 @@ func (c *Client) CreateSizeConstraintSet(ctx context.Context, params *CreateSize type CreateSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string - // A friendly name or description of the SizeConstraintSet. You can't change Name - // after you create a SizeConstraintSet. + // A friendly name or description of the SizeConstraintSet . You can't change Name + // after you create a SizeConstraintSet . // // This member is required. Name *string @@ -76,9 +67,9 @@ type CreateSizeConstraintSetInput struct { type CreateSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the CreateSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the CreateSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // A SizeConstraintSet that contains no SizeConstraint objects. diff --git a/service/wafregional/api_op_CreateSqlInjectionMatchSet.go b/service/wafregional/api_op_CreateSqlInjectionMatchSet.go index 5d3b9acda00..e732f050ec8 100644 --- a/service/wafregional/api_op_CreateSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_CreateSqlInjectionMatchSet.go @@ -11,35 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a SqlInjectionMatchSet, which you use to allow, block, or -// count requests that contain snippets of SQL code in a specified part of web +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a SqlInjectionMatchSet , which you use to allow, block, +// or count requests that contain snippets of SQL code in a specified part of web // requests. AWS WAF searches for character sequences that are likely to be -// malicious strings. To create and configure a SqlInjectionMatchSet, perform the +// malicious strings. To create and configure a SqlInjectionMatchSet , perform the // following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateSqlInjectionMatchSet request. +// - Submit a CreateSqlInjectionMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSqlInjectionMatchSet request. +// - Submit an UpdateSqlInjectionMatchSet request to specify the parts of web +// requests in which you want to allow, block, or count malicious SQL code. // -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. -// -// * Submit -// a CreateSqlInjectionMatchSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an -// UpdateSqlInjectionMatchSet request. -// -// * Submit an UpdateSqlInjectionMatchSet -// request to specify the parts of web requests in which you want to allow, block, -// or count malicious SQL code. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateSqlInjectionMatchSet(ctx context.Context, params *CreateSqlInjectionMatchSetInput, optFns ...func(*Options)) (*CreateSqlInjectionMatchSetOutput, error) { if params == nil { params = &CreateSqlInjectionMatchSetInput{} @@ -55,16 +46,16 @@ func (c *Client) CreateSqlInjectionMatchSet(ctx context.Context, params *CreateS return out, nil } -// A request to create a SqlInjectionMatchSet. +// A request to create a SqlInjectionMatchSet . type CreateSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // A friendly name or description for the SqlInjectionMatchSet that you're - // creating. You can't change Name after you create the SqlInjectionMatchSet. + // creating. You can't change Name after you create the SqlInjectionMatchSet . // // This member is required. Name *string @@ -77,10 +68,10 @@ type CreateSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string - // A SqlInjectionMatchSet. + // A SqlInjectionMatchSet . SqlInjectionMatchSet *types.SqlInjectionMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_CreateWebACL.go b/service/wafregional/api_op_CreateWebACL.go index b5cc342a2c0..32e1e348efb 100644 --- a/service/wafregional/api_op_CreateWebACL.go +++ b/service/wafregional/api_op_CreateWebACL.go @@ -11,45 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates a WebACL, which contains the Rules that identify the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates a WebACL , which contains the Rules that identify the // CloudFront web requests that you want to allow, block, or count. AWS WAF -// evaluates Rules in order based on the value of Priority for each Rule. You also -// specify a default action, either ALLOW or BLOCK. If a web request doesn't match -// any of the Rules in a WebACL, AWS WAF responds to the request with the default -// action. To create and configure a WebACL, perform the following steps: +// evaluates Rules in order based on the value of Priority for each Rule . You also +// specify a default action, either ALLOW or BLOCK . If a web request doesn't match +// any of the Rules in a WebACL , AWS WAF responds to the request with the default +// action. To create and configure a WebACL , perform the following steps: +// - Create and update the ByteMatchSet objects and other predicates that you +// want to include in Rules . For more information, see CreateByteMatchSet , +// UpdateByteMatchSet , CreateIPSet , UpdateIPSet , CreateSqlInjectionMatchSet , +// and UpdateSqlInjectionMatchSet . +// - Create and update the Rules that you want to include in the WebACL . For +// more information, see CreateRule and UpdateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateWebACL request. +// - Submit a CreateWebACL request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateWebACL request. +// - Submit an UpdateWebACL request to specify the Rules that you want to include +// in the WebACL , to specify the default action, and to associate the WebACL +// with a CloudFront distribution. // -// * Create -// and update the ByteMatchSet objects and other predicates that you want to -// include in Rules. For more information, see CreateByteMatchSet, -// UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and -// UpdateSqlInjectionMatchSet. -// -// * Create and update the Rules that you want to -// include in the WebACL. For more information, see CreateRule and UpdateRule. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a CreateWebACL request. -// -// * Submit a CreateWebACL request. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateWebACL request. -// -// * Submit an UpdateWebACL request to -// specify the Rules that you want to include in the WebACL, to specify the default -// action, and to associate the WebACL with a CloudFront distribution. -// -// For more -// information about how to use the AWS WAF API, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, optFns ...func(*Options)) (*CreateWebACLOutput, error) { if params == nil { params = &CreateWebACLInput{} @@ -67,29 +55,29 @@ func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, op type CreateWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The action that you want AWS WAF to take when a request doesn't match the // criteria specified in any of the Rule objects that are associated with the - // WebACL. + // WebACL . // // This member is required. DefaultAction *types.WafAction - // A friendly name or description for the metrics for this WebACL.The name can + // A friendly name or description for the metrics for this WebACL .The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the WebACL. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the WebACL . // // This member is required. MetricName *string - // A friendly name or description of the WebACL. You can't change Name after you - // create the WebACL. + // A friendly name or description of the WebACL . You can't change Name after you + // create the WebACL . // // This member is required. Name *string @@ -104,7 +92,7 @@ type CreateWebACLOutput struct { // The ChangeToken that you used to submit the CreateWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // The WebACL returned in the CreateWebACL response. diff --git a/service/wafregional/api_op_CreateWebACLMigrationStack.go b/service/wafregional/api_op_CreateWebACLMigrationStack.go index 17081ddd406..c9732595afa 100644 --- a/service/wafregional/api_op_CreateWebACLMigrationStack.go +++ b/service/wafregional/api_op_CreateWebACLMigrationStack.go @@ -17,10 +17,9 @@ import ( // part of a larger migration procedure for web ACLs from AWS WAF Classic to the // latest version of AWS WAF. For the full procedure, including caveats and manual // steps to complete the migration and switch over to the new web ACL, see -// Migrating your AWS WAF Classic resources to AWS WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html) -// in the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). +// Migrating your AWS WAF Classic resources to AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html) +// in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . func (c *Client) CreateWebACLMigrationStack(ctx context.Context, params *CreateWebACLMigrationStackInput, optFns ...func(*Options)) (*CreateWebACLMigrationStackOutput, error) { if params == nil { params = &CreateWebACLMigrationStackInput{} @@ -46,20 +45,15 @@ type CreateWebACLMigrationStackInput struct { // This member is required. IgnoreUnsupportedType *bool - // The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 - // bucket must be configured as follows for the migration: - // - // * The bucket name must - // start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl. - // - // * The - // bucket must be in the Region where you are deploying the template. For example, - // for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and - // you must deploy the template stack to us-west-2. - // - // * The bucket policies must - // permit the migration process to write data. For listings of the bucket policies, - // see the Examples section. + // The name of the Amazon S3 bucket to store the CloudFormation template in. The + // S3 bucket must be configured as follows for the migration: + // - The bucket name must start with aws-waf-migration- . For example, + // aws-waf-migration-my-web-acl . + // - The bucket must be in the Region where you are deploying the template. For + // example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in + // us-west-2 and you must deploy the template stack to us-west-2. + // - The bucket policies must permit the migration process to write data. For + // listings of the bucket policies, see the Examples section. // // This member is required. S3BucketName *string diff --git a/service/wafregional/api_op_CreateXssMatchSet.go b/service/wafregional/api_op_CreateXssMatchSet.go index b478b4fe4d7..00c47a27d32 100644 --- a/service/wafregional/api_op_CreateXssMatchSet.go +++ b/service/wafregional/api_op_CreateXssMatchSet.go @@ -11,35 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Creates an XssMatchSet, which you use to allow, block, or count +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Creates an XssMatchSet , which you use to allow, block, or count // requests that contain cross-site scripting attacks in the specified part of web // requests. AWS WAF searches for character sequences that are likely to be -// malicious strings. To create and configure an XssMatchSet, perform the following -// steps: +// malicious strings. To create and configure an XssMatchSet , perform the +// following steps: +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a CreateXssMatchSet request. +// - Submit a CreateXssMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateXssMatchSet request. +// - Submit an UpdateXssMatchSet request to specify the parts of web requests in +// which you want to allow, block, or count cross-site scripting attacks. // -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateXssMatchSet request. -// -// * Submit a -// CreateXssMatchSet request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateXssMatchSet request. -// -// * -// Submit an UpdateXssMatchSet request to specify the parts of web requests in -// which you want to allow, block, or count cross-site scripting attacks. -// -// For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSetInput, optFns ...func(*Options)) (*CreateXssMatchSetOutput, error) { if params == nil { params = &CreateXssMatchSetInput{} @@ -55,16 +46,16 @@ func (c *Client) CreateXssMatchSet(ctx context.Context, params *CreateXssMatchSe return out, nil } -// A request to create an XssMatchSet. +// A request to create an XssMatchSet . type CreateXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // A friendly name or description for the XssMatchSet that you're creating. You - // can't change Name after you create the XssMatchSet. + // can't change Name after you create the XssMatchSet . // // This member is required. Name *string @@ -77,10 +68,10 @@ type CreateXssMatchSetOutput struct { // The ChangeToken that you used to submit the CreateXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string - // An XssMatchSet. + // An XssMatchSet . XssMatchSet *types.XssMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteByteMatchSet.go b/service/wafregional/api_op_DeleteByteMatchSet.go index bfcf35896e7..08e03d265be 100644 --- a/service/wafregional/api_op_DeleteByteMatchSet.go +++ b/service/wafregional/api_op_DeleteByteMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet -// if it's still used in any Rules or if it still includes any ByteMatchTuple -// objects (any filters). If you just want to remove a ByteMatchSet from a Rule, -// use UpdateRule. To permanently delete a ByteMatchSet, perform the following -// steps: -// -// * Update the ByteMatchSet to remove filters, if any. For more -// information, see UpdateByteMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of a DeleteByteMatchSet -// request. -// -// * Submit a DeleteByteMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a ByteMatchSet . You can't delete a +// ByteMatchSet if it's still used in any Rules or if it still includes any +// ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet +// from a Rule , use UpdateRule . To permanently delete a ByteMatchSet , perform +// the following steps: +// - Update the ByteMatchSet to remove filters, if any. For more information, see +// UpdateByteMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteByteMatchSet request. +// - Submit a DeleteByteMatchSet request. func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatchSetInput, optFns ...func(*Options)) (*DeleteByteMatchSetOutput, error) { if params == nil { params = &DeleteByteMatchSetInput{} @@ -48,12 +42,12 @@ func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatch type DeleteByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId - // is returned by CreateByteMatchSet and by ListByteMatchSets. + // is returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string @@ -65,7 +59,7 @@ type DeleteByteMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteGeoMatchSet.go b/service/wafregional/api_op_DeleteGeoMatchSet.go index ab76cad50a9..ee0f62549dd 100644 --- a/service/wafregional/api_op_DeleteGeoMatchSet.go +++ b/service/wafregional/api_op_DeleteGeoMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if -// it's still used in any Rules or if it still includes any countries. If you just -// want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete -// a GeoMatchSet from AWS WAF, perform the following steps: -// -// * Update the -// GeoMatchSet to remove any countries. For more information, see -// UpdateGeoMatchSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of a DeleteGeoMatchSet request. -// -// * Submit a -// DeleteGeoMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a GeoMatchSet . You can't delete a +// GeoMatchSet if it's still used in any Rules or if it still includes any +// countries. If you just want to remove a GeoMatchSet from a Rule , use UpdateRule +// . To permanently delete a GeoMatchSet from AWS WAF, perform the following +// steps: +// - Update the GeoMatchSet to remove any countries. For more information, see +// UpdateGeoMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteGeoMatchSet request. +// - Submit a DeleteGeoMatchSet request. func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSetInput, optFns ...func(*Options)) (*DeleteGeoMatchSetOutput, error) { if params == nil { params = &DeleteGeoMatchSetInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSe type DeleteGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string @@ -65,7 +59,7 @@ type DeleteGeoMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteIPSet.go b/service/wafregional/api_op_DeleteIPSet.go index b0a91afef19..69add9810fa 100644 --- a/service/wafregional/api_op_DeleteIPSet.go +++ b/service/wafregional/api_op_DeleteIPSet.go @@ -10,25 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an IPSet. You can't delete an IPSet if it's -// still used in any Rules or if it still includes any IP addresses. If you just -// want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an -// IPSet from AWS WAF, perform the following steps: -// -// * Update the IPSet to remove -// IP address ranges, if any. For more information, see UpdateIPSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteIPSet request. -// -// * Submit a DeleteIPSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an IPSet . You can't delete an IPSet if +// it's still used in any Rules or if it still includes any IP addresses. If you +// just want to remove an IPSet from a Rule , use UpdateRule . To permanently +// delete an IPSet from AWS WAF, perform the following steps: +// - Update the IPSet to remove IP address ranges, if any. For more information, +// see UpdateIPSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteIPSet request. +// - Submit a DeleteIPSet request. func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { params = &DeleteIPSetInput{} @@ -46,13 +40,13 @@ func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optF type DeleteIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The IPSetId of the IPSet that you want to delete. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string @@ -64,7 +58,7 @@ type DeleteIPSetOutput struct { // The ChangeToken that you used to submit the DeleteIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteLoggingConfiguration.go b/service/wafregional/api_op_DeleteLoggingConfiguration.go index 8e36cc6f8f3..2c11cf19913 100644 --- a/service/wafregional/api_op_DeleteLoggingConfiguration.go +++ b/service/wafregional/api_op_DeleteLoggingConfiguration.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes the LoggingConfiguration from the specified web -// ACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes the LoggingConfiguration from the specified +// web ACL. func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error) { if params == nil { params = &DeleteLoggingConfigurationInput{} @@ -36,7 +34,7 @@ func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteL type DeleteLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_DeletePermissionPolicy.go b/service/wafregional/api_op_DeletePermissionPolicy.go index a7fff2a00f8..ee46c52a2bc 100644 --- a/service/wafregional/api_op_DeletePermissionPolicy.go +++ b/service/wafregional/api_op_DeletePermissionPolicy.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an IAM policy from the specified RuleGroup. The -// user making the request must be the owner of the RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an IAM policy from the specified RuleGroup. +// The user making the request must be the owner of the RuleGroup. func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error) { if params == nil { params = &DeletePermissionPolicyInput{} diff --git a/service/wafregional/api_op_DeleteRateBasedRule.go b/service/wafregional/api_op_DeleteRateBasedRule.go index 199dd662873..77673b3052a 100644 --- a/service/wafregional/api_op_DeleteRateBasedRule.go +++ b/service/wafregional/api_op_DeleteRateBasedRule.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RateBasedRule. You can't delete a rule if it's -// still used in any WebACL objects or if it still includes any predicates, such as -// ByteMatchSet objects. If you just want to remove a rule from a WebACL, use -// UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the -// following steps: -// -// * Update the RateBasedRule to remove predicates, if any. For -// more information, see UpdateRateBasedRule. -// -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of a -// DeleteRateBasedRule request. -// -// * Submit a DeleteRateBasedRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RateBasedRule . You can't delete a rule if +// it's still used in any WebACL objects or if it still includes any predicates, +// such as ByteMatchSet objects. If you just want to remove a rule from a WebACL , +// use UpdateWebACL . To permanently delete a RateBasedRule from AWS WAF, perform +// the following steps: +// - Update the RateBasedRule to remove predicates, if any. For more information, +// see UpdateRateBasedRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRateBasedRule request. +// - Submit a DeleteRateBasedRule request. func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBasedRuleInput, optFns ...func(*Options)) (*DeleteRateBasedRuleOutput, error) { if params == nil { params = &DeleteRateBasedRuleInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBase type DeleteRateBasedRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the RateBasedRule that you want to delete. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string @@ -63,9 +57,9 @@ type DeleteRateBasedRuleInput struct { type DeleteRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the DeleteRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteRegexMatchSet.go b/service/wafregional/api_op_DeleteRegexMatchSet.go index 45bb9957b05..fed5aab675d 100644 --- a/service/wafregional/api_op_DeleteRegexMatchSet.go +++ b/service/wafregional/api_op_DeleteRegexMatchSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RegexMatchSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RegexMatchSet . You can't delete a // RegexMatchSet if it's still used in any Rules or if it still includes any // RegexMatchTuples objects (any filters). If you just want to remove a -// RegexMatchSet from a Rule, use UpdateRule. To permanently delete a -// RegexMatchSet, perform the following steps: -// -// * Update the RegexMatchSet to -// remove filters, if any. For more information, see UpdateRegexMatchSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteRegexMatchSet request. -// -// * Submit a DeleteRegexMatchSet -// request. +// RegexMatchSet from a Rule , use UpdateRule . To permanently delete a +// RegexMatchSet , perform the following steps: +// - Update the RegexMatchSet to remove filters, if any. For more information, +// see UpdateRegexMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRegexMatchSet request. +// - Submit a DeleteRegexMatchSet request. func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMatchSetInput, optFns ...func(*Options)) (*DeleteRegexMatchSetOutput, error) { if params == nil { params = &DeleteRegexMatchSetInput{} @@ -48,13 +41,13 @@ func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMat type DeleteRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexMatchSetId of the RegexMatchSet that you want to delete. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -64,9 +57,9 @@ type DeleteRegexMatchSetInput struct { type DeleteRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteRegexPatternSet.go b/service/wafregional/api_op_DeleteRegexPatternSet.go index ce3ac60ed47..8ea2b45186c 100644 --- a/service/wafregional/api_op_DeleteRegexPatternSet.go +++ b/service/wafregional/api_op_DeleteRegexPatternSet.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RegexPatternSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RegexPatternSet . You can't delete a // RegexPatternSet if it's still used in any RegexMatchSet or if the // RegexPatternSet is not empty. func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error) { @@ -36,14 +34,14 @@ func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexP type DeleteRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexPatternSetId of the RegexPatternSet that you want to delete. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string @@ -55,7 +53,7 @@ type DeleteRegexPatternSetOutput struct { // The ChangeToken that you used to submit the DeleteRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteRule.go b/service/wafregional/api_op_DeleteRule.go index 97ef720eab5..015785d4ebd 100644 --- a/service/wafregional/api_op_DeleteRule.go +++ b/service/wafregional/api_op_DeleteRule.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a Rule. You can't delete a Rule if it's still -// used in any WebACL objects or if it still includes any predicates, such as -// ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use -// UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a Rule . You can't delete a Rule if it's +// still used in any WebACL objects or if it still includes any predicates, such +// as ByteMatchSet objects. If you just want to remove a Rule from a WebACL , use +// UpdateWebACL . To permanently delete a Rule from AWS WAF, perform the following // steps: -// -// * Update the Rule to remove predicates, if any. For more information, -// see UpdateRule. -// -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of a DeleteRule request. -// -// * Submit a DeleteRule -// request. +// - Update the Rule to remove predicates, if any. For more information, see +// UpdateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRule request. +// - Submit a DeleteRule request. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} @@ -47,13 +41,13 @@ func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns type DeleteRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string @@ -63,9 +57,9 @@ type DeleteRuleInput struct { type DeleteRuleOutput struct { - // The ChangeToken that you used to submit the DeleteRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteRuleGroup.go b/service/wafregional/api_op_DeleteRuleGroup.go index 0ecf35829e4..2c6d020cd91 100644 --- a/service/wafregional/api_op_DeleteRuleGroup.go +++ b/service/wafregional/api_op_DeleteRuleGroup.go @@ -10,25 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if -// it's still used in any WebACL objects or if it still includes any rules. If you -// just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently -// delete a RuleGroup from AWS WAF, perform the following steps: -// -// * Update the -// RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteRuleGroup request. -// -// * Submit a DeleteRuleGroup request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a RuleGroup . You can't delete a RuleGroup +// if it's still used in any WebACL objects or if it still includes any rules. If +// you just want to remove a RuleGroup from a WebACL , use UpdateWebACL . To +// permanently delete a RuleGroup from AWS WAF, perform the following steps: +// - Update the RuleGroup to remove rules, if any. For more information, see +// UpdateRuleGroup . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteRuleGroup request. +// - Submit a DeleteRuleGroup request. func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -46,13 +40,13 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string @@ -64,7 +58,7 @@ type DeleteRuleGroupOutput struct { // The ChangeToken that you used to submit the DeleteRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteSizeConstraintSet.go b/service/wafregional/api_op_DeleteSizeConstraintSet.go index 3553554bce0..7a529bdb187 100644 --- a/service/wafregional/api_op_DeleteSizeConstraintSet.go +++ b/service/wafregional/api_op_DeleteSizeConstraintSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a SizeConstraintSet. You can't delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a SizeConstraintSet . You can't delete a // SizeConstraintSet if it's still used in any Rules or if it still includes any // SizeConstraint objects (any filters). If you just want to remove a -// SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a -// SizeConstraintSet, perform the following steps: -// -// * Update the SizeConstraintSet -// to remove filters, if any. For more information, see UpdateSizeConstraintSet. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteSizeConstraintSet request. -// -// * Submit a -// DeleteSizeConstraintSet request. +// SizeConstraintSet from a Rule , use UpdateRule . To permanently delete a +// SizeConstraintSet , perform the following steps: +// - Update the SizeConstraintSet to remove filters, if any. For more +// information, see UpdateSizeConstraintSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteSizeConstraintSet request. +// - Submit a DeleteSizeConstraintSet request. func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSizeConstraintSetInput, optFns ...func(*Options)) (*DeleteSizeConstraintSetOutput, error) { if params == nil { params = &DeleteSizeConstraintSetInput{} @@ -48,14 +41,14 @@ func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSize type DeleteSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SizeConstraintSetId of the SizeConstraintSet that you want to delete. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -65,9 +58,9 @@ type DeleteSizeConstraintSetInput struct { type DeleteSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the DeleteSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go b/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go index 172edbe8f97..5c9269e7554 100644 --- a/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go @@ -10,27 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a -// SqlInjectionMatchSet if it's still used in any Rules or if it still contains any -// SqlInjectionMatchTuple objects. If you just want to remove a -// SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a SqlInjectionMatchSet . You can't delete a +// SqlInjectionMatchSet if it's still used in any Rules or if it still contains +// any SqlInjectionMatchTuple objects. If you just want to remove a +// SqlInjectionMatchSet from a Rule , use UpdateRule . To permanently delete a // SqlInjectionMatchSet from AWS WAF, perform the following steps: -// -// * Update the -// SqlInjectionMatchSet to remove filters, if any. For more information, see -// UpdateSqlInjectionMatchSet. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet -// request. -// -// * Submit a DeleteSqlInjectionMatchSet request. +// - Update the SqlInjectionMatchSet to remove filters, if any. For more +// information, see UpdateSqlInjectionMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteSqlInjectionMatchSet request. +// - Submit a DeleteSqlInjectionMatchSet request. func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteSqlInjectionMatchSetInput, optFns ...func(*Options)) (*DeleteSqlInjectionMatchSetOutput, error) { if params == nil { params = &DeleteSqlInjectionMatchSetInput{} @@ -49,14 +42,14 @@ func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteS // A request to delete a SqlInjectionMatchSet from AWS WAF. type DeleteSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -69,7 +62,7 @@ type DeleteSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteWebACL.go b/service/wafregional/api_op_DeleteWebACL.go index 0517b1e1856..123efd0e5be 100644 --- a/service/wafregional/api_op_DeleteWebACL.go +++ b/service/wafregional/api_op_DeleteWebACL.go @@ -10,23 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes a WebACL. You can't delete a WebACL if it still -// contains any Rules. To delete a WebACL, perform the following steps: -// -// * Update -// the WebACL to remove Rules, if any. For more information, see UpdateWebACL. -// -// * -// Use GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of a DeleteWebACL request. -// -// * Submit a DeleteWebACL request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes a WebACL . You can't delete a WebACL if it +// still contains any Rules . To delete a WebACL , perform the following steps: +// - Update the WebACL to remove Rules , if any. For more information, see +// UpdateWebACL . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteWebACL request. +// - Submit a DeleteWebACL request. func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error) { if params == nil { params = &DeleteWebACLInput{} @@ -44,13 +38,13 @@ func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, op type DeleteWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The WebACLId of the WebACL that you want to delete. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -62,7 +56,7 @@ type DeleteWebACLOutput struct { // The ChangeToken that you used to submit the DeleteWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DeleteXssMatchSet.go b/service/wafregional/api_op_DeleteXssMatchSet.go index a625dcc9642..b209021ccc8 100644 --- a/service/wafregional/api_op_DeleteXssMatchSet.go +++ b/service/wafregional/api_op_DeleteXssMatchSet.go @@ -10,26 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Permanently deletes an XssMatchSet. You can't delete an XssMatchSet -// if it's still used in any Rules or if it still contains any XssMatchTuple -// objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. -// To permanently delete an XssMatchSet from AWS WAF, perform the following -// steps: -// -// * Update the XssMatchSet to remove filters, if any. For more -// information, see UpdateXssMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of a DeleteXssMatchSet -// request. -// -// * Submit a DeleteXssMatchSet request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Permanently deletes an XssMatchSet . You can't delete an +// XssMatchSet if it's still used in any Rules or if it still contains any +// XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule , +// use UpdateRule . To permanently delete an XssMatchSet from AWS WAF, perform the +// following steps: +// - Update the XssMatchSet to remove filters, if any. For more information, see +// UpdateXssMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of a DeleteXssMatchSet request. +// - Submit a DeleteXssMatchSet request. func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSetInput, optFns ...func(*Options)) (*DeleteXssMatchSetOutput, error) { if params == nil { params = &DeleteXssMatchSetInput{} @@ -48,13 +42,13 @@ func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSe // A request to delete an XssMatchSet from AWS WAF. type DeleteXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -67,7 +61,7 @@ type DeleteXssMatchSetOutput struct { // The ChangeToken that you used to submit the DeleteXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_DisassociateWebACL.go b/service/wafregional/api_op_DisassociateWebACL.go index 15e89b3f1d0..b60b1f28d4d 100644 --- a/service/wafregional/api_op_DisassociateWebACL.go +++ b/service/wafregional/api_op_DisassociateWebACL.go @@ -11,14 +11,12 @@ import ( ) // This is AWS WAF Classic Regional documentation. For more information, see AWS -// WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Removes a web ACL from the specified resource, either an application -// load balancer or Amazon API Gateway stage. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Removes a web ACL from the specified resource, either an +// application load balancer or Amazon API Gateway stage. func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWebACLInput, optFns ...func(*Options)) (*DisassociateWebACLOutput, error) { if params == nil { params = &DisassociateWebACLInput{} @@ -39,14 +37,11 @@ type DisassociateWebACLInput struct { // The ARN (Amazon Resource Name) of the resource from which the web ACL is being // removed, either an application load balancer or Amazon API Gateway stage. The // ARN should be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load - // Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway stage: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an Amazon API Gateway stage: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_GetByteMatchSet.go b/service/wafregional/api_op_GetByteMatchSet.go index 987ff56f556..cfb57e1b894 100644 --- a/service/wafregional/api_op_GetByteMatchSet.go +++ b/service/wafregional/api_op_GetByteMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the ByteMatchSet specified by ByteMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the ByteMatchSet specified by ByteMatchSetId . func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInput, optFns ...func(*Options)) (*GetByteMatchSetOutput, error) { if params == nil { params = &GetByteMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInp type GetByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is - // returned by CreateByteMatchSet and by ListByteMatchSets. + // returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string @@ -48,16 +46,11 @@ type GetByteMatchSetOutput struct { // Information about the ByteMatchSet that you specified in the GetByteMatchSet // request. For more information, see the following topics: - // - // * ByteMatchSet: - // Contains ByteMatchSetId, ByteMatchTuples, and Name - // - // * ByteMatchTuples: Contains - // an array of ByteMatchTuple objects. Each ByteMatchTuple object contains - // FieldToMatch, PositionalConstraint, TargetString, and TextTransformation - // - // * - // FieldToMatch: Contains Data and Type + // - ByteMatchSet : Contains ByteMatchSetId , ByteMatchTuples , and Name + // - ByteMatchTuples : Contains an array of ByteMatchTuple objects. Each + // ByteMatchTuple object contains FieldToMatch , PositionalConstraint , + // TargetString , and TextTransformation + // - FieldToMatch : Contains Data and Type ByteMatchSet *types.ByteMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetChangeToken.go b/service/wafregional/api_op_GetChangeToken.go index f208b726018..d13885b97c3 100644 --- a/service/wafregional/api_op_GetChangeToken.go +++ b/service/wafregional/api_op_GetChangeToken.go @@ -10,21 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. When you want to create, update, or delete AWS WAF objects, get a -// change token and include the change token in the create, update, or delete +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. When you want to create, update, or delete AWS WAF objects, get +// a change token and include the change token in the create, update, or delete // request. Change tokens ensure that your application doesn't submit conflicting // requests to AWS WAF. Each create, update, or delete request must use a unique // change token. If your application submits a GetChangeToken request and then // submits a second GetChangeToken request before submitting a create, update, or // delete request, the second GetChangeToken request returns the same value as the // first GetChangeToken request. When you use a change token in a create, update, -// or delete request, the status of the change token changes to PENDING, which +// or delete request, the status of the change token changes to PENDING , which // indicates that AWS WAF is propagating the change to all AWS WAF servers. Use // GetChangeTokenStatus to determine the status of your change token. func (c *Client) GetChangeToken(ctx context.Context, params *GetChangeTokenInput, optFns ...func(*Options)) (*GetChangeTokenOutput, error) { diff --git a/service/wafregional/api_op_GetChangeTokenStatus.go b/service/wafregional/api_op_GetChangeTokenStatus.go index e87b3a5c251..03c68a3bac4 100644 --- a/service/wafregional/api_op_GetChangeTokenStatus.go +++ b/service/wafregional/api_op_GetChangeTokenStatus.go @@ -11,24 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the status of a ChangeToken that you got by calling -// GetChangeToken. ChangeTokenStatus is one of the following values: -// -// * -// PROVISIONED: You requested the change token by calling GetChangeToken, but you -// haven't used it yet in a call to create, update, or delete an AWS WAF object. -// -// * -// PENDING: AWS WAF is propagating the create, update, or delete request to all AWS -// WAF servers. -// -// * INSYNC: Propagation is complete. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the status of a ChangeToken that you got by calling +// GetChangeToken . ChangeTokenStatus is one of the following values: +// - PROVISIONED : You requested the change token by calling GetChangeToken , but +// you haven't used it yet in a call to create, update, or delete an AWS WAF +// object. +// - PENDING : AWS WAF is propagating the create, update, or delete request to +// all AWS WAF servers. +// - INSYNC : Propagation is complete. func (c *Client) GetChangeTokenStatus(ctx context.Context, params *GetChangeTokenStatusInput, optFns ...func(*Options)) (*GetChangeTokenStatusOutput, error) { if params == nil { params = &GetChangeTokenStatusInput{} diff --git a/service/wafregional/api_op_GetGeoMatchSet.go b/service/wafregional/api_op_GetGeoMatchSet.go index 65915df4bf5..902c5b72d40 100644 --- a/service/wafregional/api_op_GetGeoMatchSet.go +++ b/service/wafregional/api_op_GetGeoMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the GeoMatchSet that is specified by GeoMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId . func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput, optFns ...func(*Options)) (*GetGeoMatchSetOutput, error) { if params == nil { params = &GetGeoMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput type GetGeoMatchSetInput struct { // The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string @@ -47,8 +45,8 @@ type GetGeoMatchSetInput struct { type GetGeoMatchSetOutput struct { // Information about the GeoMatchSet that you specified in the GetGeoMatchSet - // request. This includes the Type, which for a GeoMatchContraint is always - // Country, as well as the Value, which is the identifier for a specific country. + // request. This includes the Type , which for a GeoMatchContraint is always + // Country , as well as the Value , which is the identifier for a specific country. GeoMatchSet *types.GeoMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetIPSet.go b/service/wafregional/api_op_GetIPSet.go index 37a661051d6..d1eecb91559 100644 --- a/service/wafregional/api_op_GetIPSet.go +++ b/service/wafregional/api_op_GetIPSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the IPSet that is specified by IPSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the IPSet that is specified by IPSetId . func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ... type GetIPSetInput struct { // The IPSetId of the IPSet that you want to get. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string @@ -46,14 +44,11 @@ type GetIPSetInput struct { type GetIPSetOutput struct { - // Information about the IPSet that you specified in the GetIPSet request. For more - // information, see the following topics: - // - // * IPSet: Contains IPSetDescriptors, - // IPSetId, and Name - // - // * IPSetDescriptors: Contains an array of IPSetDescriptor - // objects. Each IPSetDescriptor object contains Type and Value + // Information about the IPSet that you specified in the GetIPSet request. For + // more information, see the following topics: + // - IPSet : Contains IPSetDescriptors , IPSetId , and Name + // - IPSetDescriptors : Contains an array of IPSetDescriptor objects. Each + // IPSetDescriptor object contains Type and Value IPSet *types.IPSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetLoggingConfiguration.go b/service/wafregional/api_op_GetLoggingConfiguration.go index fa7bf74cab3..8b6edaf7e6f 100644 --- a/service/wafregional/api_op_GetLoggingConfiguration.go +++ b/service/wafregional/api_op_GetLoggingConfiguration.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the LoggingConfiguration for the specified web ACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the LoggingConfiguration for the specified web ACL. func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error) { if params == nil { params = &GetLoggingConfigurationInput{} @@ -36,7 +34,7 @@ func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLogging type GetLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL for which you want to get the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_GetPermissionPolicy.go b/service/wafregional/api_op_GetPermissionPolicy.go index 7637c6d8d8b..3f581a7500c 100644 --- a/service/wafregional/api_op_GetPermissionPolicy.go +++ b/service/wafregional/api_op_GetPermissionPolicy.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the IAM policy attached to the RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the IAM policy attached to the RuleGroup. func (c *Client) GetPermissionPolicy(ctx context.Context, params *GetPermissionPolicyInput, optFns ...func(*Options)) (*GetPermissionPolicyOutput, error) { if params == nil { params = &GetPermissionPolicyInput{} diff --git a/service/wafregional/api_op_GetRateBasedRule.go b/service/wafregional/api_op_GetRateBasedRule.go index 676bba262ac..9c78e72d25e 100644 --- a/service/wafregional/api_op_GetRateBasedRule.go +++ b/service/wafregional/api_op_GetRateBasedRule.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RateBasedRule that is specified by the RuleId that you -// included in the GetRateBasedRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RateBasedRule that is specified by the RuleId that +// you included in the GetRateBasedRule request. func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleInput, optFns ...func(*Options)) (*GetRateBasedRuleOutput, error) { if params == nil { params = &GetRateBasedRuleInput{} @@ -37,7 +35,7 @@ func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleI type GetRateBasedRuleInput struct { // The RuleId of the RateBasedRule that you want to get. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string diff --git a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go index a8345db7d2b..6730a6263d7 100644 --- a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go @@ -10,14 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of IP addresses currently being blocked by the -// RateBasedRule that is specified by the RuleId. The maximum number of managed +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of IP addresses currently being blocked by the +// RateBasedRule that is specified by the RuleId . The maximum number of managed // keys that will be blocked is 10,000. If more than 10,000 addresses exceed the // rate limit, the 10,000 addresses with the highest rates will be blocked. func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRateBasedRuleManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedRuleManagedKeysOutput, error) { @@ -37,8 +35,8 @@ func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRat type GetRateBasedRuleManagedKeysInput struct { - // The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. - // RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. + // The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys + // . RuleId is returned by CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string @@ -52,7 +50,7 @@ type GetRateBasedRuleManagedKeysInput struct { type GetRateBasedRuleManagedKeysOutput struct { // An array of IP addresses that currently are blocked by the specified - // RateBasedRule. + // RateBasedRule . ManagedKeys []string // A null value and not currently used. diff --git a/service/wafregional/api_op_GetRegexMatchSet.go b/service/wafregional/api_op_GetRegexMatchSet.go index 520c83b10b7..3575e4eb3b0 100644 --- a/service/wafregional/api_op_GetRegexMatchSet.go +++ b/service/wafregional/api_op_GetRegexMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RegexMatchSet specified by RegexMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RegexMatchSet specified by RegexMatchSetId . func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetInput, optFns ...func(*Options)) (*GetRegexMatchSetOutput, error) { if params == nil { params = &GetRegexMatchSetInput{} @@ -36,7 +34,7 @@ func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetI type GetRegexMatchSetInput struct { // The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId - // is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -47,7 +45,7 @@ type GetRegexMatchSetInput struct { type GetRegexMatchSetOutput struct { // Information about the RegexMatchSet that you specified in the GetRegexMatchSet - // request. For more information, see RegexMatchTuple. + // request. For more information, see RegexMatchTuple . RegexMatchSet *types.RegexMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetRegexPatternSet.go b/service/wafregional/api_op_GetRegexPatternSet.go index f08e4f3ff6f..9402981e1cf 100644 --- a/service/wafregional/api_op_GetRegexPatternSet.go +++ b/service/wafregional/api_op_GetRegexPatternSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RegexPatternSet specified by RegexPatternSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RegexPatternSet specified by RegexPatternSetId . func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error) { if params == nil { params = &GetRegexPatternSetInput{} @@ -37,7 +35,7 @@ type GetRegexPatternSetInput struct { // The RegexPatternSetId of the RegexPatternSet that you want to get. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string diff --git a/service/wafregional/api_op_GetRule.go b/service/wafregional/api_op_GetRule.go index c1e0d74aa0f..aad735d9384 100644 --- a/service/wafregional/api_op_GetRule.go +++ b/service/wafregional/api_op_GetRule.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the Rule that is specified by the RuleId that you included -// in the GetRule request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the Rule that is specified by the RuleId that you +// included in the GetRule request. func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { params = &GetRuleInput{} @@ -37,7 +35,7 @@ func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...fu type GetRuleInput struct { // The RuleId of the Rule that you want to get. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string @@ -49,12 +47,9 @@ type GetRuleOutput struct { // Information about the Rule that you specified in the GetRule request. For more // information, see the following topics: - // - // * Rule: Contains MetricName, Name, an - // array of Predicate objects, and RuleId - // - // * Predicate: Each Predicate object - // contains DataId, Negated, and Type + // - Rule : Contains MetricName , Name , an array of Predicate objects, and + // RuleId + // - Predicate : Each Predicate object contains DataId , Negated , and Type Rule *types.Rule // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetRuleGroup.go b/service/wafregional/api_op_GetRuleGroup.go index 1b9979b2302..df92feb235a 100644 --- a/service/wafregional/api_op_GetRuleGroup.go +++ b/service/wafregional/api_op_GetRuleGroup.go @@ -11,15 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the RuleGroup that is specified by the RuleGroupId that you -// included in the GetRuleGroup request. To view the rules in a rule group, use -// ListActivatedRulesInRuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the RuleGroup that is specified by the RuleGroupId that +// you included in the GetRuleGroup request. To view the rules in a rule group, +// use ListActivatedRulesInRuleGroup . func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) { if params == nil { params = &GetRuleGroupInput{} @@ -38,7 +36,7 @@ func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, op type GetRuleGroupInput struct { // The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned - // by CreateRuleGroup and by ListRuleGroups. + // by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string diff --git a/service/wafregional/api_op_GetSampledRequests.go b/service/wafregional/api_op_GetSampledRequests.go index 91398a94ea6..a6a943121e9 100644 --- a/service/wafregional/api_op_GetSampledRequests.go +++ b/service/wafregional/api_op_GetSampledRequests.go @@ -11,22 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Gets detailed information about a specified number of requests--a -// sample--that AWS WAF randomly selects from among the first 5,000 requests that -// your AWS resource received during a time range that you choose. You can specify -// a sample size of up to 500 requests, and you can specify any time range in the -// previous three hours. GetSampledRequests returns a time range, which is usually -// the time range that you specified. However, if your resource (such as a -// CloudFront distribution) received 5,000 requests before the specified time range -// elapsed, GetSampledRequests returns an updated time range. This new time range -// indicates the actual period during which AWS WAF selected the requests in the -// sample. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Gets detailed information about a specified number of +// requests--a sample--that AWS WAF randomly selects from among the first 5,000 +// requests that your AWS resource received during a time range that you choose. +// You can specify a sample size of up to 500 requests, and you can specify any +// time range in the previous three hours. GetSampledRequests returns a time +// range, which is usually the time range that you specified. However, if your +// resource (such as a CloudFront distribution) received 5,000 requests before the +// specified time range elapsed, GetSampledRequests returns an updated time range. +// This new time range indicates the actual period during which AWS WAF selected +// the requests in the sample. func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error) { if params == nil { params = &GetSampledRequestsInput{} @@ -46,20 +44,17 @@ type GetSampledRequestsInput struct { // The number of requests that you want AWS WAF to return from among the first // 5,000 requests that your AWS resource received during the time range. If your - // resource received fewer requests than the value of MaxItems, GetSampledRequests + // resource received fewer requests than the value of MaxItems , GetSampledRequests // returns information about all of them. // // This member is required. MaxItems int64 // RuleId is one of three values: - // - // * The RuleId of the Rule or the RuleGroupId of - // the RuleGroup for which you want GetSampledRequests to return a sample of - // requests. - // - // * Default_Action, which causes GetSampledRequests to return a sample - // of the requests that didn't match any of the rules in the specified WebACL. + // - The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you + // want GetSampledRequests to return a sample of requests. + // - Default_Action , which causes GetSampledRequests to return a sample of the + // requests that didn't match any of the rules in the specified WebACL . // // This member is required. RuleId *string @@ -67,7 +62,7 @@ type GetSampledRequestsInput struct { // The start date and time and the end date and time of the range for which you // want GetSampledRequests to return a sample of requests. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // special designator, Z . For example, "2016-09-27T14:50Z" . You can specify any // time range in the previous three hours. // // This member is required. @@ -85,7 +80,7 @@ type GetSampledRequestsInput struct { type GetSampledRequestsOutput struct { // The total number of requests from which GetSampledRequests got a sample of - // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes + // MaxItems requests. If PopulationSize is less than MaxItems , the sample includes // every request that your AWS resource received during the specified time range. PopulationSize int64 diff --git a/service/wafregional/api_op_GetSizeConstraintSet.go b/service/wafregional/api_op_GetSizeConstraintSet.go index 91167f30422..b1f7f600607 100644 --- a/service/wafregional/api_op_GetSizeConstraintSet.go +++ b/service/wafregional/api_op_GetSizeConstraintSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the SizeConstraintSet specified by SizeConstraintSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId . func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstraintSetInput, optFns ...func(*Options)) (*GetSizeConstraintSetOutput, error) { if params == nil { params = &GetSizeConstraintSetInput{} @@ -37,7 +35,7 @@ type GetSizeConstraintSetInput struct { // The SizeConstraintSetId of the SizeConstraintSet that you want to get. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -49,16 +47,12 @@ type GetSizeConstraintSetOutput struct { // Information about the SizeConstraintSet that you specified in the // GetSizeConstraintSet request. For more information, see the following topics: - // - // * - // SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name - // - // * - // SizeConstraints: Contains an array of SizeConstraint objects. Each - // SizeConstraint object contains FieldToMatch, TextTransformation, - // ComparisonOperator, and Size - // - // * FieldToMatch: Contains Data and Type + // - SizeConstraintSet : Contains SizeConstraintSetId , SizeConstraints , and + // Name + // - SizeConstraints : Contains an array of SizeConstraint objects. Each + // SizeConstraint object contains FieldToMatch , TextTransformation , + // ComparisonOperator , and Size + // - FieldToMatch : Contains Data and Type SizeConstraintSet *types.SizeConstraintSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetSqlInjectionMatchSet.go b/service/wafregional/api_op_GetSqlInjectionMatchSet.go index 7c0c635747e..1fdec67a14e 100644 --- a/service/wafregional/api_op_GetSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_GetSqlInjectionMatchSet.go @@ -11,14 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the SqlInjectionMatchSet that is specified by -// SqlInjectionMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the SqlInjectionMatchSet that is specified by +// SqlInjectionMatchSetId . func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInjectionMatchSetInput, optFns ...func(*Options)) (*GetSqlInjectionMatchSetOutput, error) { if params == nil { params = &GetSqlInjectionMatchSetInput{} @@ -34,12 +32,12 @@ func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInje return out, nil } -// A request to get a SqlInjectionMatchSet. +// A request to get a SqlInjectionMatchSet . type GetSqlInjectionMatchSetInput struct { // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -51,17 +49,12 @@ type GetSqlInjectionMatchSetInput struct { type GetSqlInjectionMatchSetOutput struct { // Information about the SqlInjectionMatchSet that you specified in the - // GetSqlInjectionMatchSet request. For more information, see the following - // topics: - // - // * SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an - // array of SqlInjectionMatchTuple objects - // - // * SqlInjectionMatchTuple: Each - // SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation - // - // * - // FieldToMatch: Contains Data and Type + // GetSqlInjectionMatchSet request. For more information, see the following topics: + // - SqlInjectionMatchSet : Contains Name , SqlInjectionMatchSetId , and an array + // of SqlInjectionMatchTuple objects + // - SqlInjectionMatchTuple : Each SqlInjectionMatchTuple object contains + // FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type SqlInjectionMatchSet *types.SqlInjectionMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetWebACL.go b/service/wafregional/api_op_GetWebACL.go index c0193e3d9bd..ec4f2cd0e58 100644 --- a/service/wafregional/api_op_GetWebACL.go +++ b/service/wafregional/api_op_GetWebACL.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the WebACL that is specified by WebACLId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the WebACL that is specified by WebACLId . func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error) { if params == nil { params = &GetWebACLInput{} @@ -36,7 +34,7 @@ func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns . type GetWebACLInput struct { // The WebACLId of the WebACL that you want to get. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -48,17 +46,12 @@ type GetWebACLOutput struct { // Information about the WebACL that you specified in the GetWebACL request. For // more information, see the following topics: - // - // * WebACL: Contains DefaultAction, - // MetricName, Name, an array of Rule objects, and WebACLId - // - // * DefaultAction (Data - // type is WafAction): Contains Type - // - // * Rules: Contains an array of ActivatedRule - // objects, which contain Action, Priority, and RuleId - // - // * Action: Contains Type + // - WebACL : Contains DefaultAction , MetricName , Name , an array of Rule + // objects, and WebACLId + // - DefaultAction (Data type is WafAction ): Contains Type + // - Rules : Contains an array of ActivatedRule objects, which contain Action , + // Priority , and RuleId + // - Action : Contains Type WebACL *types.WebACL // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetWebACLForResource.go b/service/wafregional/api_op_GetWebACLForResource.go index bc48c627206..3f7e976b180 100644 --- a/service/wafregional/api_op_GetWebACLForResource.go +++ b/service/wafregional/api_op_GetWebACLForResource.go @@ -12,13 +12,11 @@ import ( ) // This is AWS WAF Classic Regional documentation. For more information, see AWS -// WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the web ACL for the specified resource, either an +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the web ACL for the specified resource, either an // application load balancer or Amazon API Gateway stage. func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForResourceInput, optFns ...func(*Options)) (*GetWebACLForResourceOutput, error) { if params == nil { @@ -40,13 +38,11 @@ type GetWebACLForResourceInput struct { // The ARN (Amazon Resource Name) of the resource for which to get the web ACL, // either an application load balancer or Amazon API Gateway stage. The ARN should // be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway stage: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an Amazon API Gateway stage: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_GetXssMatchSet.go b/service/wafregional/api_op_GetXssMatchSet.go index 0bd8ca1563a..052c77186a0 100644 --- a/service/wafregional/api_op_GetXssMatchSet.go +++ b/service/wafregional/api_op_GetXssMatchSet.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns the XssMatchSet that is specified by XssMatchSetId. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns the XssMatchSet that is specified by XssMatchSetId . func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput, optFns ...func(*Options)) (*GetXssMatchSetOutput, error) { if params == nil { params = &GetXssMatchSetInput{} @@ -33,11 +31,11 @@ func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput return out, nil } -// A request to get an XssMatchSet. +// A request to get an XssMatchSet . type GetXssMatchSetInput struct { // The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -50,15 +48,11 @@ type GetXssMatchSetOutput struct { // Information about the XssMatchSet that you specified in the GetXssMatchSet // request. For more information, see the following topics: - // - // * XssMatchSet: - // Contains Name, XssMatchSetId, and an array of XssMatchTuple objects - // - // * - // XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // - XssMatchSet : Contains Name , XssMatchSetId , and an array of XssMatchTuple + // objects + // - XssMatchTuple : Each XssMatchTuple object contains FieldToMatch and + // TextTransformation + // - FieldToMatch : Contains Data and Type XssMatchSet *types.XssMatchSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go b/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go index e4f02efa90d..d8c45443357 100644 --- a/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of ActivatedRule objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of ActivatedRule objects. func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *ListActivatedRulesInRuleGroupInput, optFns ...func(*Options)) (*ListActivatedRulesInRuleGroupOutput, error) { if params == nil { params = &ListActivatedRulesInRuleGroupInput{} @@ -37,15 +35,15 @@ type ListActivatedRulesInRuleGroupInput struct { // Specifies the number of ActivatedRules that you want AWS WAF to return for this // request. If you have more ActivatedRules than the number that you specify for - // Limit, the response includes a NextMarker value that you can use to get another - // batch of ActivatedRules. + // Limit , the response includes a NextMarker value that you can use to get + // another batch of ActivatedRules . Limit int32 - // If you specify a value for Limit and you have more ActivatedRules than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of ActivatedRules. For the second and subsequent - // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the - // previous response to get information about another batch of ActivatedRules. + // If you specify a value for Limit and you have more ActivatedRules than the + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of ActivatedRules . For the second and subsequent + // ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from + // the previous response to get information about another batch of ActivatedRules . NextMarker *string // The RuleGroupId of the RuleGroup for which you want to get a list of @@ -62,7 +60,7 @@ type ListActivatedRulesInRuleGroupOutput struct { // If you have more ActivatedRules than the number that you specified for Limit in // the request, the response includes a NextMarker value. To list more - // ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and + // ActivatedRules , submit another ListActivatedRulesInRuleGroup request, and // specify the NextMarker value from the response in the NextMarker value in the // next request. NextMarker *string diff --git a/service/wafregional/api_op_ListByteMatchSets.go b/service/wafregional/api_op_ListByteMatchSets.go index d4b469201a6..9bea7729d76 100644 --- a/service/wafregional/api_op_ListByteMatchSets.go +++ b/service/wafregional/api_op_ListByteMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of ByteMatchSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of ByteMatchSetSummary objects. func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSetsInput, optFns ...func(*Options)) (*ListByteMatchSetsOutput, error) { if params == nil { params = &ListByteMatchSetsInput{} @@ -35,17 +33,17 @@ func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSet type ListByteMatchSetsInput struct { - // Specifies the number of ByteMatchSet objects that you want AWS WAF to return for - // this request. If you have more ByteMatchSets objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of ByteMatchSet objects. + // Specifies the number of ByteMatchSet objects that you want AWS WAF to return + // for this request. If you have more ByteMatchSets objects than the number you + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of ByteMatchSet objects. Limit int32 // If you specify a value for Limit and you have more ByteMatchSets than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of ByteMatchSets. For the second and subsequent + // of Limit , AWS WAF returns a NextMarker value in the response that allows you + // to list another group of ByteMatchSets . For the second and subsequent // ListByteMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of ByteMatchSets. + // response to get information about another batch of ByteMatchSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_ListGeoMatchSets.go b/service/wafregional/api_op_ListGeoMatchSets.go index 21bd86499ff..a3960c04d61 100644 --- a/service/wafregional/api_op_ListGeoMatchSets.go +++ b/service/wafregional/api_op_ListGeoMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of GeoMatchSetSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of GeoMatchSetSummary objects in the response. func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsInput, optFns ...func(*Options)) (*ListGeoMatchSetsOutput, error) { if params == nil { params = &ListGeoMatchSetsInput{} @@ -37,13 +35,13 @@ type ListGeoMatchSetsInput struct { // Specifies the number of GeoMatchSet objects that you want AWS WAF to return for // this request. If you have more GeoMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get + // for Limit , the response includes a NextMarker value that you can use to get // another batch of GeoMatchSet objects. Limit int32 - // If you specify a value for Limit and you have more GeoMatchSets than the value - // of Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of GeoMatchSet objects. For the second and subsequent + // If you specify a value for Limit and you have more GeoMatchSet s than the value + // of Limit , AWS WAF returns a NextMarker value in the response that allows you + // to list another group of GeoMatchSet objects. For the second and subsequent // ListGeoMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of GeoMatchSet objects. NextMarker *string diff --git a/service/wafregional/api_op_ListIPSets.go b/service/wafregional/api_op_ListIPSets.go index adc392d9a16..791fc0a93ca 100644 --- a/service/wafregional/api_op_ListIPSets.go +++ b/service/wafregional/api_op_ListIPSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of IPSetSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of IPSetSummary objects in the response. func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error) { if params == nil { params = &ListIPSetsInput{} @@ -36,15 +34,15 @@ func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns type ListIPSetsInput struct { // Specifies the number of IPSet objects that you want AWS WAF to return for this - // request. If you have more IPSet objects than the number you specify for Limit, + // request. If you have more IPSet objects than the number you specify for Limit , // the response includes a NextMarker value that you can use to get another batch // of IPSet objects. Limit int32 // AWS WAF returns a NextMarker value in the response that allows you to list - // another group of IPSets. For the second and subsequent ListIPSets requests, + // another group of IPSets . For the second and subsequent ListIPSets requests, // specify the value of NextMarker from the previous response to get information - // about another batch of IPSets. + // about another batch of IPSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_ListLoggingConfigurations.go b/service/wafregional/api_op_ListLoggingConfigurations.go index f3f480e9efe..e5cb523a67f 100644 --- a/service/wafregional/api_op_ListLoggingConfigurations.go +++ b/service/wafregional/api_op_ListLoggingConfigurations.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of LoggingConfiguration objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of LoggingConfiguration objects. func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error) { if params == nil { params = &ListLoggingConfigurationsInput{} @@ -37,16 +35,16 @@ type ListLoggingConfigurationsInput struct { // Specifies the number of LoggingConfigurations that you want AWS WAF to return // for this request. If you have more LoggingConfigurations than the number that - // you specify for Limit, the response includes a NextMarker value that you can use - // to get another batch of LoggingConfigurations. + // you specify for Limit , the response includes a NextMarker value that you can + // use to get another batch of LoggingConfigurations . Limit int32 // If you specify a value for Limit and you have more LoggingConfigurations than - // the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of LoggingConfigurations. For the second and + // the value of Limit , AWS WAF returns a NextMarker value in the response that + // allows you to list another group of LoggingConfigurations . For the second and // subsequent ListLoggingConfigurations requests, specify the value of NextMarker // from the previous response to get information about another batch of - // ListLoggingConfigurations. + // ListLoggingConfigurations . NextMarker *string noSmithyDocumentSerde @@ -59,7 +57,7 @@ type ListLoggingConfigurationsOutput struct { // If you have more LoggingConfigurations than the number that you specified for // Limit in the request, the response includes a NextMarker value. To list more - // LoggingConfigurations, submit another ListLoggingConfigurations request, and + // LoggingConfigurations , submit another ListLoggingConfigurations request, and // specify the NextMarker value from the response in the NextMarker value in the // next request. NextMarker *string diff --git a/service/wafregional/api_op_ListRateBasedRules.go b/service/wafregional/api_op_ListRateBasedRules.go index 0c771a18532..15f13a5d218 100644 --- a/service/wafregional/api_op_ListRateBasedRules.go +++ b/service/wafregional/api_op_ListRateBasedRules.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleSummary objects. func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRulesInput, optFns ...func(*Options)) (*ListRateBasedRulesOutput, error) { if params == nil { params = &ListRateBasedRulesInput{} @@ -36,15 +34,15 @@ func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRu type ListRateBasedRulesInput struct { // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. + // If you have more Rules than the number that you specify for Limit , the response + // includes a NextMarker value that you can use to get another batch of Rules . Limit int32 - // If you specify a value for Limit and you have more Rules than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of Rules. For the second and subsequent ListRateBasedRules + // If you specify a value for Limit and you have more Rules than the value of Limit + // , AWS WAF returns a NextMarker value in the response that allows you to list + // another group of Rules . For the second and subsequent ListRateBasedRules // requests, specify the value of NextMarker from the previous response to get - // information about another batch of Rules. + // information about another batch of Rules . NextMarker *string noSmithyDocumentSerde @@ -53,7 +51,7 @@ type ListRateBasedRulesInput struct { type ListRateBasedRulesOutput struct { // If you have more Rules than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more Rules, submit + // request, the response includes a NextMarker value. To list more Rules , submit // another ListRateBasedRules request, and specify the NextMarker value from the // response in the NextMarker value in the next request. NextMarker *string diff --git a/service/wafregional/api_op_ListRegexMatchSets.go b/service/wafregional/api_op_ListRegexMatchSets.go index ce39f49b753..e9db77f3d1c 100644 --- a/service/wafregional/api_op_ListRegexMatchSets.go +++ b/service/wafregional/api_op_ListRegexMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RegexMatchSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RegexMatchSetSummary objects. func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchSetsInput, optFns ...func(*Options)) (*ListRegexMatchSetsOutput, error) { if params == nil { params = &ListRegexMatchSetsInput{} @@ -37,15 +35,16 @@ type ListRegexMatchSetsInput struct { // Specifies the number of RegexMatchSet objects that you want AWS WAF to return // for this request. If you have more RegexMatchSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexMatchSet objects. + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of RegexMatchSet objects. Limit int32 // If you specify a value for Limit and you have more RegexMatchSet objects than - // the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of ByteMatchSets. For the second and subsequent - // ListRegexMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of RegexMatchSet objects. + // the value of Limit , AWS WAF returns a NextMarker value in the response that + // allows you to list another group of ByteMatchSets . For the second and + // subsequent ListRegexMatchSets requests, specify the value of NextMarker from + // the previous response to get information about another batch of RegexMatchSet + // objects. NextMarker *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_ListRegexPatternSets.go b/service/wafregional/api_op_ListRegexPatternSets.go index 6aa4173834f..c1850dd3ebb 100644 --- a/service/wafregional/api_op_ListRegexPatternSets.go +++ b/service/wafregional/api_op_ListRegexPatternSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RegexPatternSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RegexPatternSetSummary objects. func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error) { if params == nil { params = &ListRegexPatternSetsInput{} @@ -37,12 +35,12 @@ type ListRegexPatternSetsInput struct { // Specifies the number of RegexPatternSet objects that you want AWS WAF to return // for this request. If you have more RegexPatternSet objects than the number you - // specify for Limit, the response includes a NextMarker value that you can use to - // get another batch of RegexPatternSet objects. + // specify for Limit , the response includes a NextMarker value that you can use + // to get another batch of RegexPatternSet objects. Limit int32 // If you specify a value for Limit and you have more RegexPatternSet objects than - // the value of Limit, AWS WAF returns a NextMarker value in the response that + // the value of Limit , AWS WAF returns a NextMarker value in the response that // allows you to list another group of RegexPatternSet objects. For the second and // subsequent ListRegexPatternSets requests, specify the value of NextMarker from // the previous response to get information about another batch of RegexPatternSet diff --git a/service/wafregional/api_op_ListResourcesForWebACL.go b/service/wafregional/api_op_ListResourcesForWebACL.go index c42e2b9ee5f..73a8c4035df 100644 --- a/service/wafregional/api_op_ListResourcesForWebACL.go +++ b/service/wafregional/api_op_ListResourcesForWebACL.go @@ -12,13 +12,12 @@ import ( ) // This is AWS WAF Classic Regional documentation. For more information, see AWS -// WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of resources associated with the specified web ACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of resources associated with the specified web +// ACL. func (c *Client) ListResourcesForWebACL(ctx context.Context, params *ListResourcesForWebACLInput, optFns ...func(*Options)) (*ListResourcesForWebACLOutput, error) { if params == nil { params = &ListResourcesForWebACLInput{} diff --git a/service/wafregional/api_op_ListRuleGroups.go b/service/wafregional/api_op_ListRuleGroups.go index c9c1ba0a4f2..0358ad630d8 100644 --- a/service/wafregional/api_op_ListRuleGroups.go +++ b/service/wafregional/api_op_ListRuleGroups.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleGroup objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleGroup objects. func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error) { if params == nil { params = &ListRuleGroupsInput{} @@ -36,16 +34,16 @@ func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput type ListRuleGroupsInput struct { // Specifies the number of RuleGroups that you want AWS WAF to return for this - // request. If you have more RuleGroups than the number that you specify for Limit, - // the response includes a NextMarker value that you can use to get another batch - // of RuleGroups. + // request. If you have more RuleGroups than the number that you specify for Limit + // , the response includes a NextMarker value that you can use to get another + // batch of RuleGroups . Limit int32 // If you specify a value for Limit and you have more RuleGroups than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of RuleGroups. For the second and subsequent ListRuleGroups + // Limit , AWS WAF returns a NextMarker value in the response that allows you to + // list another group of RuleGroups . For the second and subsequent ListRuleGroups // requests, specify the value of NextMarker from the previous response to get - // information about another batch of RuleGroups. + // information about another batch of RuleGroups . NextMarker *string noSmithyDocumentSerde @@ -54,9 +52,9 @@ type ListRuleGroupsInput struct { type ListRuleGroupsOutput struct { // If you have more RuleGroups than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more RuleGroups, - // submit another ListRuleGroups request, and specify the NextMarker value from the - // response in the NextMarker value in the next request. + // request, the response includes a NextMarker value. To list more RuleGroups , + // submit another ListRuleGroups request, and specify the NextMarker value from + // the response in the NextMarker value in the next request. NextMarker *string // An array of RuleGroup objects. diff --git a/service/wafregional/api_op_ListRules.go b/service/wafregional/api_op_ListRules.go index 2b7d56ea763..c7aa7339def 100644 --- a/service/wafregional/api_op_ListRules.go +++ b/service/wafregional/api_op_ListRules.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleSummary objects. func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} @@ -36,15 +34,15 @@ func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns . type ListRulesInput struct { // Specifies the number of Rules that you want AWS WAF to return for this request. - // If you have more Rules than the number that you specify for Limit, the response - // includes a NextMarker value that you can use to get another batch of Rules. + // If you have more Rules than the number that you specify for Limit , the response + // includes a NextMarker value that you can use to get another batch of Rules . Limit int32 - // If you specify a value for Limit and you have more Rules than the value of - // Limit, AWS WAF returns a NextMarker value in the response that allows you to - // list another group of Rules. For the second and subsequent ListRules requests, + // If you specify a value for Limit and you have more Rules than the value of Limit + // , AWS WAF returns a NextMarker value in the response that allows you to list + // another group of Rules . For the second and subsequent ListRules requests, // specify the value of NextMarker from the previous response to get information - // about another batch of Rules. + // about another batch of Rules . NextMarker *string noSmithyDocumentSerde @@ -53,9 +51,9 @@ type ListRulesInput struct { type ListRulesOutput struct { // If you have more Rules than the number that you specified for Limit in the - // request, the response includes a NextMarker value. To list more Rules, submit - // another ListRules request, and specify the NextMarker value from the response in - // the NextMarker value in the next request. + // request, the response includes a NextMarker value. To list more Rules , submit + // another ListRules request, and specify the NextMarker value from the response + // in the NextMarker value in the next request. NextMarker *string // An array of RuleSummary objects. diff --git a/service/wafregional/api_op_ListSizeConstraintSets.go b/service/wafregional/api_op_ListSizeConstraintSets.go index 817d0033c84..970c1ee6b85 100644 --- a/service/wafregional/api_op_ListSizeConstraintSets.go +++ b/service/wafregional/api_op_ListSizeConstraintSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of SizeConstraintSetSummary objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of SizeConstraintSetSummary objects. func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeConstraintSetsInput, optFns ...func(*Options)) (*ListSizeConstraintSetsOutput, error) { if params == nil { params = &ListSizeConstraintSetsInput{} @@ -37,15 +35,15 @@ type ListSizeConstraintSetsInput struct { // Specifies the number of SizeConstraintSet objects that you want AWS WAF to // return for this request. If you have more SizeConstraintSets objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of SizeConstraintSet objects. + // number you specify for Limit , the response includes a NextMarker value that + // you can use to get another batch of SizeConstraintSet objects. Limit int32 // If you specify a value for Limit and you have more SizeConstraintSets than the - // value of Limit, AWS WAF returns a NextMarker value in the response that allows - // you to list another group of SizeConstraintSets. For the second and subsequent + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of SizeConstraintSets . For the second and subsequent // ListSizeConstraintSets requests, specify the value of NextMarker from the - // previous response to get information about another batch of SizeConstraintSets. + // previous response to get information about another batch of SizeConstraintSets . NextMarker *string noSmithyDocumentSerde @@ -54,10 +52,10 @@ type ListSizeConstraintSetsInput struct { type ListSizeConstraintSetsOutput struct { // If you have more SizeConstraintSet objects than the number that you specified - // for Limit in the request, the response includes a NextMarker value. To list more - // SizeConstraintSet objects, submit another ListSizeConstraintSets request, and - // specify the NextMarker value from the response in the NextMarker value in the - // next request. + // for Limit in the request, the response includes a NextMarker value. To list + // more SizeConstraintSet objects, submit another ListSizeConstraintSets request, + // and specify the NextMarker value from the response in the NextMarker value in + // the next request. NextMarker *string // An array of SizeConstraintSetSummary objects. diff --git a/service/wafregional/api_op_ListSqlInjectionMatchSets.go b/service/wafregional/api_op_ListSqlInjectionMatchSets.go index 1b10fb98762..0b45cfe90f4 100644 --- a/service/wafregional/api_op_ListSqlInjectionMatchSets.go +++ b/service/wafregional/api_op_ListSqlInjectionMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of SqlInjectionMatchSet objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of SqlInjectionMatchSet objects. func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlInjectionMatchSetsInput, optFns ...func(*Options)) (*ListSqlInjectionMatchSetsOutput, error) { if params == nil { params = &ListSqlInjectionMatchSetsInput{} @@ -39,16 +37,16 @@ type ListSqlInjectionMatchSetsInput struct { // Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to // return for this request. If you have more SqlInjectionMatchSet objects than the - // number you specify for Limit, the response includes a NextMarker value that you - // can use to get another batch of Rules. + // number you specify for Limit , the response includes a NextMarker value that + // you can use to get another batch of Rules . Limit int32 // If you specify a value for Limit and you have more SqlInjectionMatchSet objects - // than the value of Limit, AWS WAF returns a NextMarker value in the response that - // allows you to list another group of SqlInjectionMatchSets. For the second and - // subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker - // from the previous response to get information about another batch of - // SqlInjectionMatchSets. + // than the value of Limit , AWS WAF returns a NextMarker value in the response + // that allows you to list another group of SqlInjectionMatchSets . For the second + // and subsequent ListSqlInjectionMatchSets requests, specify the value of + // NextMarker from the previous response to get information about another batch of + // SqlInjectionMatchSets . NextMarker *string noSmithyDocumentSerde @@ -57,11 +55,11 @@ type ListSqlInjectionMatchSetsInput struct { // The response to a ListSqlInjectionMatchSets request. type ListSqlInjectionMatchSetsOutput struct { - // If you have more SqlInjectionMatchSet objects than the number that you specified - // for Limit in the request, the response includes a NextMarker value. To list more - // SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, - // and specify the NextMarker value from the response in the NextMarker value in - // the next request. + // If you have more SqlInjectionMatchSet objects than the number that you + // specified for Limit in the request, the response includes a NextMarker value. + // To list more SqlInjectionMatchSet objects, submit another + // ListSqlInjectionMatchSets request, and specify the NextMarker value from the + // response in the NextMarker value in the next request. NextMarker *string // An array of SqlInjectionMatchSetSummary objects. diff --git a/service/wafregional/api_op_ListSubscribedRuleGroups.go b/service/wafregional/api_op_ListSubscribedRuleGroups.go index 75d7e6bf1d6..0cb109c436a 100644 --- a/service/wafregional/api_op_ListSubscribedRuleGroups.go +++ b/service/wafregional/api_op_ListSubscribedRuleGroups.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of RuleGroup objects that you are subscribed to. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of RuleGroup objects that you are subscribed +// to. func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubscribedRuleGroupsInput, optFns ...func(*Options)) (*ListSubscribedRuleGroupsOutput, error) { if params == nil { params = &ListSubscribedRuleGroupsInput{} @@ -36,13 +35,13 @@ func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubsc type ListSubscribedRuleGroupsInput struct { // Specifies the number of subscribed rule groups that you want AWS WAF to return - // for this request. If you have more objects than the number you specify for - // Limit, the response includes a NextMarker value that you can use to get another + // for this request. If you have more objects than the number you specify for Limit + // , the response includes a NextMarker value that you can use to get another // batch of objects. Limit int32 - // If you specify a value for Limit and you have more ByteMatchSetssubscribed rule - // groups than the value of Limit, AWS WAF returns a NextMarker value in the + // If you specify a value for Limit and you have more ByteMatchSets subscribed rule + // groups than the value of Limit , AWS WAF returns a NextMarker value in the // response that allows you to list another group of subscribed rule groups. For // the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the // value of NextMarker from the previous response to get information about another diff --git a/service/wafregional/api_op_ListTagsForResource.go b/service/wafregional/api_op_ListTagsForResource.go index 7b6c5f167f2..ec20d03f4b0 100644 --- a/service/wafregional/api_op_ListTagsForResource.go +++ b/service/wafregional/api_op_ListTagsForResource.go @@ -11,17 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Retrieves the tags associated with the specified AWS resource. Tags -// are key:value pairs that you can use to categorize and manage your resources, -// for purposes like billing. For example, you might set the tag key to "customer" -// and the value to the customer name or ID. You can specify one or more tags to -// add to each AWS resource, up to 50 tags for a resource. Tagging is only +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Retrieves the tags associated with the specified AWS resource. +// Tags are key:value pairs that you can use to categorize and manage your +// resources, for purposes like billing. For example, you might set the tag key to +// "customer" and the value to the customer name or ID. You can specify one or more +// tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only // available through the API, SDKs, and CLI. You can't manage or view tags through // the AWS WAF Classic console. You can tag the AWS resources that you manage // through AWS WAF Classic: web ACLs, rule groups, and rules. diff --git a/service/wafregional/api_op_ListWebACLs.go b/service/wafregional/api_op_ListWebACLs.go index a2b6e82fd7f..156f34ba190 100644 --- a/service/wafregional/api_op_ListWebACLs.go +++ b/service/wafregional/api_op_ListWebACLs.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of WebACLSummary objects in the response. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of WebACLSummary objects in the response. func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error) { if params == nil { params = &ListWebACLsInput{} @@ -37,15 +35,16 @@ type ListWebACLsInput struct { // Specifies the number of WebACL objects that you want AWS WAF to return for this // request. If you have more WebACL objects than the number that you specify for - // Limit, the response includes a NextMarker value that you can use to get another - // batch of WebACL objects. + // Limit , the response includes a NextMarker value that you can use to get + // another batch of WebACL objects. Limit int32 // If you specify a value for Limit and you have more WebACL objects than the - // number that you specify for Limit, AWS WAF returns a NextMarker value in the - // response that allows you to list another group of WebACL objects. For the second - // and subsequent ListWebACLs requests, specify the value of NextMarker from the - // previous response to get information about another batch of WebACL objects. + // number that you specify for Limit , AWS WAF returns a NextMarker value in the + // response that allows you to list another group of WebACL objects. For the + // second and subsequent ListWebACLs requests, specify the value of NextMarker + // from the previous response to get information about another batch of WebACL + // objects. NextMarker *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_ListXssMatchSets.go b/service/wafregional/api_op_ListXssMatchSets.go index d3ef5b6c98e..be5d9a05ef0 100644 --- a/service/wafregional/api_op_ListXssMatchSets.go +++ b/service/wafregional/api_op_ListXssMatchSets.go @@ -11,13 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returns an array of XssMatchSet objects. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returns an array of XssMatchSet objects. func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsInput, optFns ...func(*Options)) (*ListXssMatchSetsOutput, error) { if params == nil { params = &ListXssMatchSetsInput{} @@ -38,15 +36,15 @@ type ListXssMatchSetsInput struct { // Specifies the number of XssMatchSet objects that you want AWS WAF to return for // this request. If you have more XssMatchSet objects than the number you specify - // for Limit, the response includes a NextMarker value that you can use to get - // another batch of Rules. + // for Limit , the response includes a NextMarker value that you can use to get + // another batch of Rules . Limit int32 // If you specify a value for Limit and you have more XssMatchSet objects than the - // value of Limit, AWS WAF returns a NextMarker value in the response that allows - // you to list another group of XssMatchSets. For the second and subsequent + // value of Limit , AWS WAF returns a NextMarker value in the response that allows + // you to list another group of XssMatchSets . For the second and subsequent // ListXssMatchSets requests, specify the value of NextMarker from the previous - // response to get information about another batch of XssMatchSets. + // response to get information about another batch of XssMatchSets . NextMarker *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_PutLoggingConfiguration.go b/service/wafregional/api_op_PutLoggingConfiguration.go index 35a3de97f85..e5a9adf0cde 100644 --- a/service/wafregional/api_op_PutLoggingConfiguration.go +++ b/service/wafregional/api_op_PutLoggingConfiguration.go @@ -11,31 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Associates a LoggingConfiguration with a specified web ACL. You can -// access information about all traffic that AWS WAF inspects using the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Associates a LoggingConfiguration with a specified web ACL. You +// can access information about all traffic that AWS WAF inspects using the +// following steps: +// - Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT +// source and in the region that you are operating. However, if you are capturing +// logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). +// Do not create the data firehose using a Kinesis stream as your source. +// - Associate that firehose to your web ACL using a PutLoggingConfiguration +// request. // -// * Create an Amazon Kinesis Data Firehose. Create the data firehose with -// a PUT source and in the region that you are operating. However, if you are -// capturing logs for Amazon CloudFront, always create the firehose in US East (N. -// Virginia). Do not create the data firehose using a Kinesis stream as your -// source. -// -// * Associate that firehose to your web ACL using a -// PutLoggingConfiguration request. -// -// When you successfully enable logging using a -// PutLoggingConfiguration request, AWS WAF will create a service linked role with -// the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For -// more information, see Logging Web ACL Traffic Information -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the AWS -// WAF Developer Guide. +// When you successfully enable logging using a PutLoggingConfiguration request, +// AWS WAF will create a service linked role with the necessary permissions to +// write logs to the Amazon Kinesis Data Firehose. For more information, see +// Logging Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the AWS WAF Developer Guide. func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error) { if params == nil { params = &PutLoggingConfigurationInput{} @@ -55,8 +49,8 @@ type PutLoggingConfigurationInput struct { // The Amazon Kinesis Data Firehose that contains the inspected traffic // information, the redacted fields details, and the Amazon Resource Name (ARN) of - // the web ACL to monitor. When specifying Type in RedactedFields, you must use one - // of the following values: URI, QUERY_STRING, HEADER, or METHOD. + // the web ACL to monitor. When specifying Type in RedactedFields , you must use + // one of the following values: URI , QUERY_STRING , HEADER , or METHOD . // // This member is required. LoggingConfiguration *types.LoggingConfiguration diff --git a/service/wafregional/api_op_PutPermissionPolicy.go b/service/wafregional/api_op_PutPermissionPolicy.go index 59cc2f8fc9a..c13133c06af 100644 --- a/service/wafregional/api_op_PutPermissionPolicy.go +++ b/service/wafregional/api_op_PutPermissionPolicy.go @@ -10,44 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Attaches an IAM policy to the specified resource. The only supported -// use for this action is to share a RuleGroup across accounts. The +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Attaches an IAM policy to the specified resource. The only +// supported use for this action is to share a RuleGroup across accounts. The // PutPermissionPolicy is subject to the following restrictions: +// - You can attach only one policy with each PutPermissionPolicy request. +// - The policy must include an Effect , Action and Principal . +// - Effect must specify Allow . +// - The Action in the policy must be waf:UpdateWebACL , +// waf-regional:UpdateWebACL , waf:GetRuleGroup and waf-regional:GetRuleGroup . +// Any extra or wildcard actions in the policy will be rejected. +// - The policy cannot include a Resource parameter. +// - The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup +// must exist in the same region. +// - The user making the request must be the owner of the RuleGroup. +// - Your policy must be composed using IAM Policy version 2012-10-17. // -// * You can attach -// only one policy with each PutPermissionPolicy request. -// -// * The policy must -// include an Effect, Action and Principal. -// -// * Effect must specify Allow. -// -// * The -// Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, -// waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions -// in the policy will be rejected. -// -// * The policy cannot include a Resource -// parameter. -// -// * The ARN in the request must be a valid WAF RuleGroup ARN and the -// RuleGroup must exist in the same region. -// -// * The user making the request must be -// the owner of the RuleGroup. -// -// * Your policy must be composed using IAM Policy -// version 2012-10-17. -// -// For more information, see IAM Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). An -// example of a valid policy parameter is shown in the Examples section below. +// For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) +// . An example of a valid policy parameter is shown in the Examples section below. func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionPolicyInput, optFns ...func(*Options)) (*PutPermissionPolicyOutput, error) { if params == nil { params = &PutPermissionPolicyInput{} diff --git a/service/wafregional/api_op_TagResource.go b/service/wafregional/api_op_TagResource.go index f6ef47acd7a..7a959185e88 100644 --- a/service/wafregional/api_op_TagResource.go +++ b/service/wafregional/api_op_TagResource.go @@ -11,20 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Associates tags with the specified AWS resource. Tags are key:value -// pairs that you can use to categorize and manage your resources, for purposes -// like billing. For example, you might set the tag key to "customer" and the value -// to the customer name or ID. You can specify one or more tags to add to each AWS -// resource, up to 50 tags for a resource. Tagging is only available through the -// API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic -// console. You can use this action to tag the AWS resources that you manage -// through AWS WAF Classic: web ACLs, rule groups, and rules. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Associates tags with the specified AWS resource. Tags are +// key:value pairs that you can use to categorize and manage your resources, for +// purposes like billing. For example, you might set the tag key to "customer" and +// the value to the customer name or ID. You can specify one or more tags to add to +// each AWS resource, up to 50 tags for a resource. Tagging is only available +// through the API, SDKs, and CLI. You can't manage or view tags through the AWS +// WAF Classic console. You can use this action to tag the AWS resources that you +// manage through AWS WAF Classic: web ACLs, rule groups, and rules. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/wafregional/api_op_UntagResource.go b/service/wafregional/api_op_UntagResource.go index 4e747d33448..d4d5b5a0db1 100644 --- a/service/wafregional/api_op_UntagResource.go +++ b/service/wafregional/api_op_UntagResource.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/wafregional/api_op_UpdateByteMatchSet.go b/service/wafregional/api_op_UpdateByteMatchSet.go index abd04ce2dea..21b202a4fad 100644 --- a/service/wafregional/api_op_UpdateByteMatchSet.go +++ b/service/wafregional/api_op_UpdateByteMatchSet.go @@ -11,55 +11,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ByteMatchTuple objects (filters) in a -// ByteMatchSet. For each ByteMatchTuple object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ByteMatchTuple objects (filters) in a +// ByteMatchSet . For each ByteMatchTuple object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a ByteMatchSetUpdate object, you delete the existing object and add a +// new one. +// - The part of a web request that you want AWS WAF to inspect, such as a query +// string or the value of the User-Agent header. +// - The bytes (typically a string that corresponds with ASCII characters) that +// you want AWS WAF to look for. For more information, including how you specify +// the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in +// the ByteMatchTuple data type. +// - Where to look, such as at the beginning or the end of a query string. +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. // -// * Whether to insert or delete the object from the array. If you want to -// change a ByteMatchSetUpdate object, you delete the existing object and add a new -// one. +// For example, you can add a ByteMatchSetUpdate object that matches web requests +// in which User-Agent headers contain the string BadBot . You can then configure +// AWS WAF to block those requests. To create and configure a ByteMatchSet , +// perform the following steps: +// - Create a ByteMatchSet. For more information, see CreateByteMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateByteMatchSet request. +// - Submit an UpdateByteMatchSet request to specify the part of the request that +// you want AWS WAF to inspect (for example, the header or the URI) and the value +// that you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to inspect, such as a -// query string or the value of the User-Agent header. -// -// * The bytes (typically a -// string that corresponds with ASCII characters) that you want AWS WAF to look -// for. For more information, including how you specify the values for the AWS WAF -// API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data -// type. -// -// * Where to look, such as at the beginning or the end of a query -// string. -// -// * Whether to perform any conversions on the request, such as converting -// it to lowercase, before inspecting it for the specified string. -// -// For example, -// you can add a ByteMatchSetUpdate object that matches web requests in which -// User-Agent headers contain the string BadBot. You can then configure AWS WAF to -// block those requests. To create and configure a ByteMatchSet, perform the -// following steps: -// -// * Create a ByteMatchSet. For more information, see -// CreateByteMatchSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateByteMatchSet request. -// -// * Submit -// an UpdateByteMatchSet request to specify the part of the request that you want -// AWS WAF to inspect (for example, the header or the URI) and the value that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatchSetInput, optFns ...func(*Options)) (*UpdateByteMatchSetOutput, error) { if params == nil { params = &UpdateByteMatchSetInput{} @@ -78,27 +63,22 @@ func (c *Client) UpdateByteMatchSet(ctx context.Context, params *UpdateByteMatch type UpdateByteMatchSetInput struct { // The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId - // is returned by CreateByteMatchSet and by ListByteMatchSets. + // is returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // An array of ByteMatchSetUpdate objects that you want to insert into or delete - // from a ByteMatchSet. For more information, see the applicable data types: - // - // * - // ByteMatchSetUpdate: Contains Action and ByteMatchTuple - // - // * ByteMatchTuple: - // Contains FieldToMatch, PositionalConstraint, TargetString, and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // from a ByteMatchSet . For more information, see the applicable data types: + // - ByteMatchSetUpdate : Contains Action and ByteMatchTuple + // - ByteMatchTuple : Contains FieldToMatch , PositionalConstraint , TargetString + // , and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.ByteMatchSetUpdate @@ -110,7 +90,7 @@ type UpdateByteMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateByteMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateGeoMatchSet.go b/service/wafregional/api_op_UpdateGeoMatchSet.go index 2ba5286f835..19d0166ff80 100644 --- a/service/wafregional/api_op_UpdateGeoMatchSet.go +++ b/service/wafregional/api_op_UpdateGeoMatchSet.go @@ -11,44 +11,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For -// each GeoMatchConstraint object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet +// . For each GeoMatchConstraint object, you specify the following values: +// - Whether to insert or delete the object from the array. If you want to +// change an GeoMatchConstraint object, you delete the existing object and add a +// new one. +// - The Type . The only valid value for Type is Country . +// - The Value , which is a two character code for the country to add to the +// GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value +// . // -// * Whether to -// insert or delete the object from the array. If you want to change an -// GeoMatchConstraint object, you delete the existing object and add a new one. +// To create and configure an GeoMatchSet , perform the following steps: +// - Submit a CreateGeoMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateGeoMatchSet request. +// - Submit an UpdateGeoMatchSet request to specify the country that you want AWS +// WAF to watch for. // -// * -// The Type. The only valid value for Type is Country. -// -// * The Value, which is a two -// character code for the country to add to the GeoMatchConstraint object. Valid -// codes are listed in GeoMatchConstraint$Value. -// -// To create and configure an -// GeoMatchSet, perform the following steps: -// -// * Submit a CreateGeoMatchSet -// request. -// -// * Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateGeoMatchSet request. -// -// * Submit an -// UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch -// for. -// -// When you update an GeoMatchSet, you specify the country that you want to -// add and/or the country that you want to delete. If you want to change a country, -// you delete the existing country and add the new one. For more information about -// how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF -// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// When you update an GeoMatchSet , you specify the country that you want to add +// and/or the country that you want to delete. If you want to change a country, you +// delete the existing country and add the new one. For more information about how +// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSetInput, optFns ...func(*Options)) (*UpdateGeoMatchSetOutput, error) { if params == nil { params = &UpdateGeoMatchSetInput{} @@ -66,27 +54,23 @@ func (c *Client) UpdateGeoMatchSet(ctx context.Context, params *UpdateGeoMatchSe type UpdateGeoMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is - // returned by CreateGeoMatchSet and by ListGeoMatchSets. + // returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string // An array of GeoMatchSetUpdate objects that you want to insert into or delete - // from an GeoMatchSet. For more information, see the applicable data types: - // - // * - // GeoMatchSetUpdate: Contains Action and GeoMatchConstraint - // - // * GeoMatchConstraint: - // Contains Type and Value You can have only one Type and Value per - // GeoMatchConstraint. To add multiple countries, include multiple - // GeoMatchSetUpdate objects in your request. + // from an GeoMatchSet . For more information, see the applicable data types: + // - GeoMatchSetUpdate : Contains Action and GeoMatchConstraint + // - GeoMatchConstraint : Contains Type and Value You can have only one Type and + // Value per GeoMatchConstraint . To add multiple countries, include multiple + // GeoMatchSetUpdate objects in your request. // // This member is required. Updates []types.GeoMatchSetUpdate @@ -98,7 +82,7 @@ type UpdateGeoMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateIPSet.go b/service/wafregional/api_op_UpdateIPSet.go index d5824da4235..e300b5262ba 100644 --- a/service/wafregional/api_op_UpdateIPSet.go +++ b/service/wafregional/api_op_UpdateIPSet.go @@ -11,67 +11,48 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each -// IPSetDescriptor object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes IPSetDescriptor objects in an IPSet . For +// each IPSetDescriptor object, you specify the following values: +// - Whether to insert or delete the object from the array. If you want to +// change an IPSetDescriptor object, you delete the existing object and add a new +// one. +// - The IP address version, IPv4 or IPv6 . +// - The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of +// IP addresses from 192.0.2.0 to 192.0.2.255 ) or 192.0.2.44/32 (for the +// individual IP address 192.0.2.44 ). // -// * Whether to insert -// or delete the object from the array. If you want to change an IPSetDescriptor -// object, you delete the existing object and add a new one. +// AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. +// AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For +// more information about CIDR notation, see the Wikipedia entry Classless +// Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . IPv6 addresses can be represented using any of the following formats: +// - 1111:0000:0000:0000:0000:0000:0000:0111/128 +// - 1111:0:0:0:0:0:0:0111/128 +// - 1111::0111/128 +// - 1111::111/128 // -// * The IP address -// version, IPv4 or IPv6. +// You use an IPSet to specify which web requests you want to allow or block based +// on the IP addresses that the requests originated from. For example, if you're +// receiving a lot of requests from one or a small number of IP addresses and you +// want to block the requests, you can create an IPSet that specifies those IP +// addresses, and then configure AWS WAF to block the requests. To create and +// configure an IPSet , perform the following steps: +// - Submit a CreateIPSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateIPSet request to specify the IP addresses that you want AWS +// WAF to watch for. // -// * The IP address in CIDR notation, for example, -// 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or -// 192.0.2.44/32 (for the individual IP address 192.0.2.44). -// -// AWS WAF supports IPv4 -// address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 -// address ranges: /24, /32, /48, /56, /64, and /128. For more information about -// CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing -// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). IPv6 addresses -// can be represented using any of the following formats: -// -// * -// 1111:0000:0000:0000:0000:0000:0000:0111/128 -// -// * 1111:0:0:0:0:0:0:0111/128 -// -// * -// 1111::0111/128 -// -// * 1111::111/128 -// -// You use an IPSet to specify which web requests -// you want to allow or block based on the IP addresses that the requests -// originated from. For example, if you're receiving a lot of requests from one or -// a small number of IP addresses and you want to block the requests, you can -// create an IPSet that specifies those IP addresses, and then configure AWS WAF to -// block the requests. To create and configure an IPSet, perform the following -// steps: -// -// * Submit a CreateIPSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateIPSet -// request. -// -// * Submit an UpdateIPSet request to specify the IP addresses that you -// want AWS WAF to watch for. -// -// When you update an IPSet, you specify the IP -// addresses that you want to add and/or the IP addresses that you want to delete. -// If you want to change an IP address, you delete the existing IP address and add -// the new one. You can insert a maximum of 1000 addresses in a single request. For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// When you update an IPSet , you specify the IP addresses that you want to add +// and/or the IP addresses that you want to delete. If you want to change an IP +// address, you delete the existing IP address and add the new one. You can insert +// a maximum of 1000 addresses in a single request. For more information about how +// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF +// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) . func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { if params == nil { params = &UpdateIPSetInput{} @@ -89,26 +70,21 @@ func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optF type UpdateIPSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The IPSetId of the IPSet that you want to update. IPSetId is returned by - // CreateIPSet and by ListIPSets. + // CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string // An array of IPSetUpdate objects that you want to insert into or delete from an - // IPSet. For more information, see the applicable data types: - // - // * IPSetUpdate: - // Contains Action and IPSetDescriptor - // - // * IPSetDescriptor: Contains Type and - // Value - // + // IPSet . For more information, see the applicable data types: + // - IPSetUpdate : Contains Action and IPSetDescriptor + // - IPSetDescriptor : Contains Type and Value // You can insert a maximum of 1000 addresses in a single request. // // This member is required. @@ -121,7 +97,7 @@ type UpdateIPSetOutput struct { // The ChangeToken that you used to submit the UpdateIPSet request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateRateBasedRule.go b/service/wafregional/api_op_UpdateRateBasedRule.go index 4b3a62464e1..3f717e75488 100644 --- a/service/wafregional/api_op_UpdateRateBasedRule.go +++ b/service/wafregional/api_op_UpdateRateBasedRule.go @@ -11,47 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes Predicate objects in a rule and updates the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes Predicate objects in a rule and updates the // RateLimit in the rule. Each Predicate object identifies a predicate, such as a -// ByteMatchSet or an IPSet, that specifies the web requests that you want to block -// or count. The RateLimit specifies the number of requests every five minutes that -// triggers the rule. If you add more than one predicate to a RateBasedRule, a -// request must match all the predicates and exceed the RateLimit to be counted or -// blocked. For example, suppose you add the following to a RateBasedRule: +// ByteMatchSet or an IPSet , that specifies the web requests that you want to +// block or count. The RateLimit specifies the number of requests every five +// minutes that triggers the rule. If you add more than one predicate to a +// RateBasedRule , a request must match all the predicates and exceed the RateLimit +// to be counted or blocked. For example, suppose you add the following to a +// RateBasedRule : +// - An IPSet that matches the IP address 192.0.2.44/32 +// - A ByteMatchSet that matches BadBot in the User-Agent header // -// * An -// IPSet that matches the IP address 192.0.2.44/32 +// Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a +// WebACL and specify that you want to block requests that satisfy the rule. For a +// request to be blocked, it must come from the IP address 192.0.2.44 and the +// User-Agent header in the request must contain the value BadBot . Further, +// requests that match these two conditions much be received at a rate of more than +// 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer +// blocks the requests. As a second example, suppose you want to limit requests to +// a particular page on your site. To do this, you could add the following to a +// RateBasedRule : +// - A ByteMatchSet with FieldToMatch of URI +// - A PositionalConstraint of STARTS_WITH +// - A TargetString of login // -// * A ByteMatchSet that matches -// BadBot in the User-Agent header -// -// Further, you specify a RateLimit of 1,000. You -// then add the RateBasedRule to a WebACL and specify that you want to block -// requests that satisfy the rule. For a request to be blocked, it must come from -// the IP address 192.0.2.44 and the User-Agent header in the request must contain -// the value BadBot. Further, requests that match these two conditions much be -// received at a rate of more than 1,000 every five minutes. If the rate drops -// below this limit, AWS WAF no longer blocks the requests. As a second example, -// suppose you want to limit requests to a particular page on your site. To do -// this, you could add the following to a RateBasedRule: -// -// * A ByteMatchSet with -// FieldToMatch of URI -// -// * A PositionalConstraint of STARTS_WITH -// -// * A TargetString -// of login -// -// Further, you specify a RateLimit of 1,000. By adding this -// RateBasedRule to a WebACL, you could limit requests to your login page without -// affecting the rest of your site. +// Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a +// WebACL , you could limit requests to your login page without affecting the rest +// of your site. func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBasedRuleInput, optFns ...func(*Options)) (*UpdateRateBasedRuleOutput, error) { if params == nil { params = &UpdateRateBasedRuleInput{} @@ -69,13 +59,13 @@ func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBase type UpdateRateBasedRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The maximum number of requests, which have an identical value in the field - // specified by the RateKey, allowed in a five-minute period. If the number of + // specified by the RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // @@ -83,13 +73,13 @@ type UpdateRateBasedRuleInput struct { RateLimit int64 // The RuleId of the RateBasedRule that you want to update. RuleId is returned by - // CreateRateBasedRule and by ListRateBasedRules. + // CreateRateBasedRule and by ListRateBasedRules . // // This member is required. RuleId *string // An array of RuleUpdate objects that you want to insert into or delete from a - // RateBasedRule. + // RateBasedRule . // // This member is required. Updates []types.RuleUpdate @@ -99,9 +89,9 @@ type UpdateRateBasedRuleInput struct { type UpdateRateBasedRuleOutput struct { - // The ChangeToken that you used to submit the UpdateRateBasedRule request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRateBasedRule request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateRegexMatchSet.go b/service/wafregional/api_op_UpdateRegexMatchSet.go index e853ac46a20..e7263f25d60 100644 --- a/service/wafregional/api_op_UpdateRegexMatchSet.go +++ b/service/wafregional/api_op_UpdateRegexMatchSet.go @@ -11,51 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes RegexMatchTuple objects (filters) in a -// RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes RegexMatchTuple objects (filters) in a +// RegexMatchSet . For each RegexMatchSetUpdate object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a RegexMatchSetUpdate object, you delete the existing object and add a +// new one. +// - The part of a web request that you want AWS WAF to inspectupdate, such as a +// query string or the value of the User-Agent header. +// - The identifier of the pattern (a regular expression) that you want AWS WAF +// to look for. For more information, see RegexPatternSet . +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. // -// * Whether to insert or delete the object from the array. If you want to -// change a RegexMatchSetUpdate object, you delete the existing object and add a -// new one. +// For example, you can create a RegexPatternSet that matches any requests with +// User-Agent headers that contain the string B[a@]dB[o0]t . You can then configure +// AWS WAF to reject those requests. To create and configure a RegexMatchSet , +// perform the following steps: +// - Create a RegexMatchSet. For more information, see CreateRegexMatchSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexMatchSet request. +// - Submit an UpdateRegexMatchSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// identifier of the RegexPatternSet that contain the regular expression patters +// you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to inspectupdate, -// such as a query string or the value of the User-Agent header. -// -// * The identifier -// of the pattern (a regular expression) that you want AWS WAF to look for. For -// more information, see RegexPatternSet. -// -// * Whether to perform any conversions on -// the request, such as converting it to lowercase, before inspecting it for the -// specified string. -// -// For example, you can create a RegexPatternSet that matches -// any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You -// can then configure AWS WAF to reject those requests. To create and configure a -// RegexMatchSet, perform the following steps: -// -// * Create a RegexMatchSet. For more -// information, see CreateRegexMatchSet. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet -// request. -// -// * Submit an UpdateRegexMatchSet request to specify the part of the -// request that you want AWS WAF to inspect (for example, the header or the URI) -// and the identifier of the RegexPatternSet that contain the regular expression -// patters you want AWS WAF to watch for. -// -// For more information about how to use -// the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMatchSetInput, optFns ...func(*Options)) (*UpdateRegexMatchSetOutput, error) { if params == nil { params = &UpdateRegexMatchSetInput{} @@ -73,19 +60,19 @@ func (c *Client) UpdateRegexMatchSet(ctx context.Context, params *UpdateRegexMat type UpdateRegexMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexMatchSetId of the RegexMatchSet that you want to update. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string // An array of RegexMatchSetUpdate objects that you want to insert into or delete - // from a RegexMatchSet. For more information, see RegexMatchTuple. + // from a RegexMatchSet . For more information, see RegexMatchTuple . // // This member is required. Updates []types.RegexMatchSetUpdate @@ -95,9 +82,9 @@ type UpdateRegexMatchSetInput struct { type UpdateRegexMatchSetOutput struct { - // The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can - // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRegexMatchSet request. You + // can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateRegexPatternSet.go b/service/wafregional/api_op_UpdateRegexPatternSet.go index b04823ddadd..bb3b345f492 100644 --- a/service/wafregional/api_op_UpdateRegexPatternSet.go +++ b/service/wafregional/api_op_UpdateRegexPatternSet.go @@ -11,50 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes RegexPatternString objects in a RegexPatternSet. -// For each RegexPatternString object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes RegexPatternString objects in a +// RegexPatternSet . For each RegexPatternString object, you specify the following +// values: +// - Whether to insert or delete the RegexPatternString . +// - The regular expression pattern that you want to insert or delete. For more +// information, see RegexPatternSet . // -// * Whether -// to insert or delete the RegexPatternString. +// For example, you can create a RegexPatternString such as B[a@]dB[o0]t . AWS WAF +// will match this RegexPatternString to: +// - BadBot +// - BadB0t +// - B@dBot +// - B@dB0t // -// * The regular expression pattern -// that you want to insert or delete. For more information, see -// RegexPatternSet. +// To create and configure a RegexPatternSet , perform the following steps: +// - Create a RegexPatternSet. For more information, see CreateRegexPatternSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRegexPatternSet request. +// - Submit an UpdateRegexPatternSet request to specify the regular expression +// pattern that you want AWS WAF to watch for. // -// For example, you can create a RegexPatternString such as -// B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: -// -// * BadBot -// -// * -// BadB0t -// -// * B@dBot -// -// * B@dB0t -// -// To create and configure a RegexPatternSet, perform -// the following steps: -// -// * Create a RegexPatternSet. For more information, see -// CreateRegexPatternSet. -// -// * Use GetChangeToken to get the change token that you -// provide in the ChangeToken parameter of an UpdateRegexPatternSet request. -// -// * -// Submit an UpdateRegexPatternSet request to specify the regular expression -// pattern that you want AWS WAF to watch for. -// -// For more information about how to -// use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer -// Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexPatternSetInput, optFns ...func(*Options)) (*UpdateRegexPatternSetOutput, error) { if params == nil { params = &UpdateRegexPatternSetInput{} @@ -72,20 +56,20 @@ func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexP type UpdateRegexPatternSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RegexPatternSetId of the RegexPatternSet that you want to update. // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string - // An array of RegexPatternSetUpdate objects that you want to insert into or delete - // from a RegexPatternSet. + // An array of RegexPatternSetUpdate objects that you want to insert into or + // delete from a RegexPatternSet . // // This member is required. Updates []types.RegexPatternSetUpdate @@ -97,7 +81,7 @@ type UpdateRegexPatternSetOutput struct { // The ChangeToken that you used to submit the UpdateRegexPatternSet request. You // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateRule.go b/service/wafregional/api_op_UpdateRule.go index c08270890d8..8f9e7f1ef27 100644 --- a/service/wafregional/api_op_UpdateRule.go +++ b/service/wafregional/api_op_UpdateRule.go @@ -11,50 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes Predicate objects in a Rule. Each Predicate -// object identifies a predicate, such as a ByteMatchSet or an IPSet, that +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes Predicate objects in a Rule . Each Predicate +// object identifies a predicate, such as a ByteMatchSet or an IPSet , that // specifies the web requests that you want to allow, block, or count. If you add -// more than one predicate to a Rule, a request must match all of the +// more than one predicate to a Rule , a request must match all of the // specifications to be allowed, blocked, or counted. For example, suppose that you -// add the following to a Rule: +// add the following to a Rule : +// - A ByteMatchSet that matches the value BadBot in the User-Agent header +// - An IPSet that matches the IP address 192.0.2.44 // -// * A ByteMatchSet that matches the value BadBot in -// the User-Agent header +// You then add the Rule to a WebACL and specify that you want to block requests +// that satisfy the Rule . For a request to be blocked, the User-Agent header in +// the request must contain the value BadBot and the request must originate from +// the IP address 192.0.2.44. To create and configure a Rule , perform the +// following steps: +// - Create and update the predicates that you want to include in the Rule . +// - Create the Rule . See CreateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRule request. +// - Submit an UpdateRule request to add predicates to the Rule . +// - Create and update a WebACL that contains the Rule . See CreateWebACL . // -// * An IPSet that matches the IP address 192.0.2.44 -// -// You -// then add the Rule to a WebACL and specify that you want to block requests that -// satisfy the Rule. For a request to be blocked, the User-Agent header in the -// request must contain the value BadBot and the request must originate from the IP -// address 192.0.2.44. To create and configure a Rule, perform the following -// steps: -// -// * Create and update the predicates that you want to include in the -// Rule. -// -// * Create the Rule. See CreateRule. -// -// * Use GetChangeToken to get the -// change token that you provide in the ChangeToken parameter of an UpdateRule -// request. -// -// * Submit an UpdateRule request to add predicates to the Rule. -// -// * -// Create and update a WebACL that contains the Rule. See CreateWebACL. -// -// If you -// want to replace one ByteMatchSet or IPSet with another, you delete the existing -// one and add the new one. For more information about how to use the AWS WAF API -// to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// If you want to replace one ByteMatchSet or IPSet with another, you delete the +// existing one and add the new one. For more information about how to use the AWS +// WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { params = &UpdateRuleInput{} @@ -72,27 +57,22 @@ func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns type UpdateRuleInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleId of the Rule that you want to update. RuleId is returned by CreateRule - // and by ListRules. + // and by ListRules . // // This member is required. RuleId *string // An array of RuleUpdate objects that you want to insert into or delete from a - // Rule. For more information, see the applicable data types: - // - // * RuleUpdate: - // Contains Action and Predicate - // - // * Predicate: Contains DataId, Negated, and - // Type - // - // * FieldToMatch: Contains Data and Type + // Rule . For more information, see the applicable data types: + // - RuleUpdate : Contains Action and Predicate + // - Predicate : Contains DataId , Negated , and Type + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.RuleUpdate @@ -102,9 +82,9 @@ type UpdateRuleInput struct { type UpdateRuleOutput struct { - // The ChangeToken that you used to submit the UpdateRule request. You can also use - // this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateRule request. You can also + // use this value to query the status of the request. For more information, see + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateRuleGroup.go b/service/wafregional/api_op_UpdateRuleGroup.go index de2876d69cb..134fdc09304 100644 --- a/service/wafregional/api_op_UpdateRuleGroup.go +++ b/service/wafregional/api_op_UpdateRuleGroup.go @@ -11,34 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can -// only insert REGULAR rules into a rule group. You can have a maximum of ten rules -// per rule group. To create and configure a RuleGroup, perform the following -// steps: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ActivatedRule objects in a RuleGroup . You +// can only insert REGULAR rules into a rule group. You can have a maximum of ten +// rules per rule group. To create and configure a RuleGroup , perform the +// following steps: +// - Create and update the Rules that you want to include in the RuleGroup . See +// CreateRule . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateRuleGroup request. +// - Submit an UpdateRuleGroup request to add Rules to the RuleGroup . +// - Create and update a WebACL that contains the RuleGroup . See CreateWebACL . // -// * Create and update the Rules that you want to include in the RuleGroup. -// See CreateRule. -// -// * Use GetChangeToken to get the change token that you provide -// in the ChangeToken parameter of an UpdateRuleGroup request. -// -// * Submit an -// UpdateRuleGroup request to add Rules to the RuleGroup. -// -// * Create and update a -// WebACL that contains the RuleGroup. See CreateWebACL. -// -// If you want to replace -// one Rule with another, you delete the existing one and add the new one. For more -// information about how to use the AWS WAF API to allow or block HTTP requests, -// see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// If you want to replace one Rule with another, you delete the existing one and +// add the new one. For more information about how to use the AWS WAF API to allow +// or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) { if params == nil { params = &UpdateRuleGroupInput{} @@ -56,22 +47,23 @@ func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInp type UpdateRuleGroupInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string // An array of RuleGroupUpdate objects that you want to insert into or delete from - // a RuleGroup. You can only insert REGULAR rules into a rule group. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // a RuleGroup . You can only insert REGULAR rules into a rule group. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . // // This member is required. Updates []types.RuleGroupUpdate @@ -83,7 +75,7 @@ type UpdateRuleGroupOutput struct { // The ChangeToken that you used to submit the UpdateRuleGroup request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateSizeConstraintSet.go b/service/wafregional/api_op_UpdateSizeConstraintSet.go index bf4e626431f..b98710b7d51 100644 --- a/service/wafregional/api_op_UpdateSizeConstraintSet.go +++ b/service/wafregional/api_op_UpdateSizeConstraintSet.go @@ -11,58 +11,44 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes SizeConstraint objects (filters) in a -// SizeConstraintSet. For each SizeConstraint object, you specify the following +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes SizeConstraint objects (filters) in a +// SizeConstraintSet . For each SizeConstraint object, you specify the following // values: +// - Whether to insert or delete the object from the array. If you want to +// change a SizeConstraintSetUpdate object, you delete the existing object and +// add a new one. +// - The part of a web request that you want AWS WAF to evaluate, such as the +// length of a query string or the length of the User-Agent header. +// - Whether to perform any transformations on the request, such as converting +// it to lowercase, before checking its length. Note that transformations of the +// request body are not supported because the AWS resource forwards only the first +// 8192 bytes of your request to AWS WAF. You can only specify a single type of +// TextTransformation. +// - A ComparisonOperator used for evaluating the selected part of the request +// against the specified Size , such as equals, greater than, less than, and so +// on. +// - The length, in bytes, that you want AWS WAF to watch for in selected part +// of the request. The length is computed after applying the transformation. // -// * Whether to insert or delete the object from the array. If you want to -// change a SizeConstraintSetUpdate object, you delete the existing object and add -// a new one. +// For example, you can add a SizeConstraintSetUpdate object that matches web +// requests in which the length of the User-Agent header is greater than 100 +// bytes. You can then configure AWS WAF to block those requests. To create and +// configure a SizeConstraintSet , perform the following steps: +// - Create a SizeConstraintSet. For more information, see +// CreateSizeConstraintSet . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateSizeConstraintSet request. +// - Submit an UpdateSizeConstraintSet request to specify the part of the request +// that you want AWS WAF to inspect (for example, the header or the URI) and the +// value that you want AWS WAF to watch for. // -// * The part of a web request that you want AWS WAF to evaluate, such -// as the length of a query string or the length of the User-Agent header. -// -// * -// Whether to perform any transformations on the request, such as converting it to -// lowercase, before checking its length. Note that transformations of the request -// body are not supported because the AWS resource forwards only the first 8192 -// bytes of your request to AWS WAF. You can only specify a single type of -// TextTransformation. -// -// * A ComparisonOperator used for evaluating the selected -// part of the request against the specified Size, such as equals, greater than, -// less than, and so on. -// -// * The length, in bytes, that you want AWS WAF to watch -// for in selected part of the request. The length is computed after applying the -// transformation. -// -// For example, you can add a SizeConstraintSetUpdate object that -// matches web requests in which the length of the User-Agent header is greater -// than 100 bytes. You can then configure AWS WAF to block those requests. To -// create and configure a SizeConstraintSet, perform the following steps: -// -// * Create -// a SizeConstraintSet. For more information, see CreateSizeConstraintSet. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateSizeConstraintSet request. -// -// * Submit an -// UpdateSizeConstraintSet request to specify the part of the request that you want -// AWS WAF to inspect (for example, the header or the URI) and the value that you -// want AWS WAF to watch for. -// -// For more information about how to use the AWS WAF -// API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSizeConstraintSetInput, optFns ...func(*Options)) (*UpdateSizeConstraintSetOutput, error) { if params == nil { params = &UpdateSizeConstraintSetInput{} @@ -80,29 +66,25 @@ func (c *Client) UpdateSizeConstraintSet(ctx context.Context, params *UpdateSize type UpdateSizeConstraintSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SizeConstraintSetId of the SizeConstraintSet that you want to update. // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string // An array of SizeConstraintSetUpdate objects that you want to insert into or - // delete from a SizeConstraintSet. For more information, see the applicable data + // delete from a SizeConstraintSet . For more information, see the applicable data // types: - // - // * SizeConstraintSetUpdate: Contains Action and SizeConstraint - // - // * - // SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, - // and Size - // - // * FieldToMatch: Contains Data and Type + // - SizeConstraintSetUpdate : Contains Action and SizeConstraint + // - SizeConstraint : Contains FieldToMatch , TextTransformation , + // ComparisonOperator , and Size + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.SizeConstraintSetUpdate @@ -112,9 +94,9 @@ type UpdateSizeConstraintSetInput struct { type UpdateSizeConstraintSetOutput struct { - // The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You - // can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // The ChangeToken that you used to submit the UpdateSizeConstraintSet request. + // You can also use this value to query the status of the request. For more + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go b/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go index c2c4cade4f1..c8b2ff45361 100644 --- a/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go @@ -11,51 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a -// SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the -// following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in +// a SqlInjectionMatchSet . For each SqlInjectionMatchTuple object, you specify +// the following values: +// - Action : Whether to insert the object into or delete the object from the +// array. To change a SqlInjectionMatchTuple , you delete the existing object and +// add a new one. +// - FieldToMatch : The part of web requests that you want AWS WAF to inspect +// and, if you want AWS WAF to inspect a header or custom query parameter, the name +// of the header or parameter. +// - TextTransformation : Which text transformation, if any, to perform on the +// web request before inspecting the request for snippets of malicious SQL code. +// You can only specify a single type of TextTransformation. // -// * Action: Whether to insert the object into or delete the -// object from the array. To change a SqlInjectionMatchTuple, you delete the -// existing object and add a new one. -// -// * FieldToMatch: The part of web requests -// that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or -// custom query parameter, the name of the header or parameter. -// -// * -// TextTransformation: Which text transformation, if any, to perform on the web -// request before inspecting the request for snippets of malicious SQL code. You -// can only specify a single type of TextTransformation. -// -// You use -// SqlInjectionMatchSet objects to specify which CloudFront requests that you want -// to allow, block, or count. For example, if you're receiving requests that -// contain snippets of SQL code in the query string and you want to block the +// You use SqlInjectionMatchSet objects to specify which CloudFront requests that +// you want to allow, block, or count. For example, if you're receiving requests +// that contain snippets of SQL code in the query string and you want to block the // requests, you can create a SqlInjectionMatchSet with the applicable settings, // and then configure AWS WAF to block the requests. To create and configure a -// SqlInjectionMatchSet, perform the following steps: -// -// * Submit a -// CreateSqlInjectionMatchSet request. -// -// * Use GetChangeToken to get the change -// token that you provide in the ChangeToken parameter of an UpdateIPSet -// request. +// SqlInjectionMatchSet , perform the following steps: +// - Submit a CreateSqlInjectionMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateSqlInjectionMatchSet request to specify the parts of web +// requests that you want AWS WAF to inspect for snippets of SQL code. // -// * Submit an UpdateSqlInjectionMatchSet request to specify the parts of -// web requests that you want AWS WAF to inspect for snippets of SQL code. -// -// For -// more information about how to use the AWS WAF API to allow or block HTTP -// requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateSqlInjectionMatchSetInput, optFns ...func(*Options)) (*UpdateSqlInjectionMatchSetOutput, error) { if params == nil { params = &UpdateSqlInjectionMatchSetInput{} @@ -71,32 +58,27 @@ func (c *Client) UpdateSqlInjectionMatchSet(ctx context.Context, params *UpdateS return out, nil } -// A request to update a SqlInjectionMatchSet. +// A request to update a SqlInjectionMatchSet . type UpdateSqlInjectionMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string // An array of SqlInjectionMatchSetUpdate objects that you want to insert into or - // delete from a SqlInjectionMatchSet. For more information, see the applicable + // delete from a SqlInjectionMatchSet . For more information, see the applicable // data types: - // - // * SqlInjectionMatchSetUpdate: Contains Action and - // SqlInjectionMatchTuple - // - // * SqlInjectionMatchTuple: Contains FieldToMatch and - // TextTransformation - // - // * FieldToMatch: Contains Data and Type + // - SqlInjectionMatchSetUpdate : Contains Action and SqlInjectionMatchTuple + // - SqlInjectionMatchTuple : Contains FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.SqlInjectionMatchSetUpdate @@ -109,7 +91,7 @@ type UpdateSqlInjectionMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. // You can also use this value to query the status of the request. For more - // information, see GetChangeTokenStatus. + // information, see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateWebACL.go b/service/wafregional/api_op_UpdateWebACL.go index 14e48148d1e..2085086fe1a 100644 --- a/service/wafregional/api_op_UpdateWebACL.go +++ b/service/wafregional/api_op_UpdateWebACL.go @@ -11,71 +11,53 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes ActivatedRule objects in a WebACL . Each Rule // identifies web requests that you want to allow, block, or count. When you update -// a WebACL, you specify the following values: +// a WebACL , you specify the following values: +// - A default action for the WebACL , either ALLOW or BLOCK . AWS WAF performs +// the default action if a request doesn't match the criteria in any of the Rules +// in a WebACL . +// - The Rules that you want to add or delete. If you want to replace one Rule +// with another, you delete the existing Rule and add the new one. +// - For each Rule , whether you want AWS WAF to allow requests, block requests, +// or count requests that match the conditions in the Rule . +// - The order in which you want AWS WAF to evaluate the Rules in a WebACL . If +// you add more than one Rule to a WebACL , AWS WAF evaluates each request +// against the Rules in order based on the value of Priority . (The Rule that has +// the lowest value for Priority is evaluated first.) When a web request matches +// all the predicates (such as ByteMatchSets and IPSets ) in a Rule , AWS WAF +// immediately takes the corresponding action, allow or block, and doesn't evaluate +// the request against the remaining Rules in the WebACL , if any. // -// * A default action for the WebACL, -// either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't -// match the criteria in any of the Rules in a WebACL. +// To create and configure a WebACL , perform the following steps: +// - Create and update the predicates that you want to include in Rules . For +// more information, see CreateByteMatchSet , UpdateByteMatchSet , CreateIPSet , +// UpdateIPSet , CreateSqlInjectionMatchSet , and UpdateSqlInjectionMatchSet . +// - Create and update the Rules that you want to include in the WebACL . For +// more information, see CreateRule and UpdateRule . +// - Create a WebACL . See CreateWebACL . +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateWebACL request. +// - Submit an UpdateWebACL request to specify the Rules that you want to include +// in the WebACL , to specify the default action, and to associate the WebACL +// with a CloudFront distribution. The ActivatedRule can be a rule group. If you +// specify a rule group as your ActivatedRule , you can exclude specific rules +// from that rule group. If you already have a rule group associated with a web ACL +// and want to submit an UpdateWebACL request to exclude certain rules from that +// rule group, you must first remove the rule group from the web ACL, the re-insert +// it again, specifying the excluded rules. For details, see +// ActivatedRule$ExcludedRules . // -// * The Rules that you want -// to add or delete. If you want to replace one Rule with another, you delete the -// existing Rule and add the new one. -// -// * For each Rule, whether you want AWS WAF to -// allow requests, block requests, or count requests that match the conditions in -// the Rule. -// -// * The order in which you want AWS WAF to evaluate the Rules in a -// WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each -// request against the Rules in order based on the value of Priority. (The Rule -// that has the lowest value for Priority is evaluated first.) When a web request -// matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF -// immediately takes the corresponding action, allow or block, and doesn't evaluate -// the request against the remaining Rules in the WebACL, if any. -// -// To create and -// configure a WebACL, perform the following steps: -// -// * Create and update the -// predicates that you want to include in Rules. For more information, see -// CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, -// CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. -// -// * Create and update -// the Rules that you want to include in the WebACL. For more information, see -// CreateRule and UpdateRule. -// -// * Create a WebACL. See CreateWebACL. -// -// * Use -// GetChangeToken to get the change token that you provide in the ChangeToken -// parameter of an UpdateWebACL request. -// -// * Submit an UpdateWebACL request to -// specify the Rules that you want to include in the WebACL, to specify the default -// action, and to associate the WebACL with a CloudFront distribution. The -// ActivatedRule can be a rule group. If you specify a rule group as your -// ActivatedRule , you can exclude specific rules from that rule group. If you -// already have a rule group associated with a web ACL and want to submit an -// UpdateWebACL request to exclude certain rules from that rule group, you must -// first remove the rule group from the web ACL, the re-insert it again, specifying -// the excluded rules. For details, see ActivatedRule$ExcludedRules . -// -// Be aware -// that if you try to add a RATE_BASED rule to a web ACL without setting the rule -// type when first creating the rule, the UpdateWebACL request will fail because -// the request tries to add a REGULAR rule (the default rule type) with the +// Be aware that if you try to add a RATE_BASED rule to a web ACL without setting +// the rule type when first creating the rule, the UpdateWebACL request will fail +// because the request tries to add a REGULAR rule (the default rule type) with the // specified ID, which does not exist. For more information about how to use the -// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/). +// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error) { if params == nil { params = &UpdateWebACLInput{} @@ -93,13 +75,13 @@ func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, op type UpdateWebACLInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // The WebACLId of the WebACL that you want to update. WebACLId is returned by - // CreateWebACL and by ListWebACLs. + // CreateWebACL and by ListWebACLs . // // This member is required. WebACLId *string @@ -109,20 +91,16 @@ type UpdateWebACLInput struct { // web ACL. DefaultAction *types.WafAction - // An array of updates to make to the WebACL. An array of WebACLUpdate objects that - // you want to insert into or delete from a WebACL. For more information, see the - // applicable data types: - // - // * WebACLUpdate: Contains Action and ActivatedRule - // - // * - // ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case, you do not use ActivatedRule|Action. For all other - // update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. - // - // * WafAction: Contains Type + // An array of updates to make to the WebACL . An array of WebACLUpdate objects + // that you want to insert into or delete from a WebACL . For more information, see + // the applicable data types: + // - WebACLUpdate : Contains Action and ActivatedRule + // - ActivatedRule : Contains Action , OverrideAction , Priority , RuleId , and + // Type . ActivatedRule|OverrideAction applies only when updating or adding a + // RuleGroup to a WebACL . In this case, you do not use ActivatedRule|Action . + // For all other update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . + // - WafAction : Contains Type Updates []types.WebACLUpdate noSmithyDocumentSerde @@ -132,7 +110,7 @@ type UpdateWebACLOutput struct { // The ChangeToken that you used to submit the UpdateWebACL request. You can also // use this value to query the status of the request. For more information, see - // GetChangeTokenStatus. + // GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_UpdateXssMatchSet.go b/service/wafregional/api_op_UpdateXssMatchSet.go index 3abf7784d2f..dce9fc93d32 100644 --- a/service/wafregional/api_op_UpdateXssMatchSet.go +++ b/service/wafregional/api_op_UpdateXssMatchSet.go @@ -11,49 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Inserts or deletes XssMatchTuple objects (filters) in an -// XssMatchSet. For each XssMatchTuple object, you specify the following values: +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Inserts or deletes XssMatchTuple objects (filters) in an +// XssMatchSet . For each XssMatchTuple object, you specify the following values: +// - Action : Whether to insert the object into or delete the object from the +// array. To change an XssMatchTuple , you delete the existing object and add a +// new one. +// - FieldToMatch : The part of web requests that you want AWS WAF to inspect +// and, if you want AWS WAF to inspect a header or custom query parameter, the name +// of the header or parameter. +// - TextTransformation : Which text transformation, if any, to perform on the +// web request before inspecting the request for cross-site scripting attacks. You +// can only specify a single type of TextTransformation. // -// * -// Action: Whether to insert the object into or delete the object from the array. -// To change an XssMatchTuple, you delete the existing object and add a new one. +// You use XssMatchSet objects to specify which CloudFront requests that you want +// to allow, block, or count. For example, if you're receiving requests that +// contain cross-site scripting attacks in the request body and you want to block +// the requests, you can create an XssMatchSet with the applicable settings, and +// then configure AWS WAF to block the requests. To create and configure an +// XssMatchSet , perform the following steps: +// - Submit a CreateXssMatchSet request. +// - Use GetChangeToken to get the change token that you provide in the +// ChangeToken parameter of an UpdateIPSet request. +// - Submit an UpdateXssMatchSet request to specify the parts of web requests +// that you want AWS WAF to inspect for cross-site scripting attacks. // -// * -// FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if -// you want AWS WAF to inspect a header or custom query parameter, the name of the -// header or parameter. -// -// * TextTransformation: Which text transformation, if any, -// to perform on the web request before inspecting the request for cross-site -// scripting attacks. You can only specify a single type of -// TextTransformation. -// -// You use XssMatchSet objects to specify which CloudFront -// requests that you want to allow, block, or count. For example, if you're -// receiving requests that contain cross-site scripting attacks in the request body -// and you want to block the requests, you can create an XssMatchSet with the -// applicable settings, and then configure AWS WAF to block the requests. To create -// and configure an XssMatchSet, perform the following steps: -// -// * Submit a -// CreateXssMatchSet request. -// -// * Use GetChangeToken to get the change token that -// you provide in the ChangeToken parameter of an UpdateIPSet request. -// -// * Submit an -// UpdateXssMatchSet request to specify the parts of web requests that you want AWS -// WAF to inspect for cross-site scripting attacks. -// -// For more information about how -// to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF -// Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/). +// For more information about how to use the AWS WAF API to allow or block HTTP +// requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/) +// . func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSetInput, optFns ...func(*Options)) (*UpdateXssMatchSetOutput, error) { if params == nil { params = &UpdateXssMatchSetInput{} @@ -69,30 +57,25 @@ func (c *Client) UpdateXssMatchSet(ctx context.Context, params *UpdateXssMatchSe return out, nil } -// A request to update an XssMatchSet. +// A request to update an XssMatchSet . type UpdateXssMatchSetInput struct { - // The value returned by the most recent call to GetChangeToken. + // The value returned by the most recent call to GetChangeToken . // // This member is required. ChangeToken *string // An array of XssMatchSetUpdate objects that you want to insert into or delete - // from an XssMatchSet. For more information, see the applicable data types: - // - // * - // XssMatchSetUpdate: Contains Action and XssMatchTuple - // - // * XssMatchTuple: Contains - // FieldToMatch and TextTransformation - // - // * FieldToMatch: Contains Data and Type + // from an XssMatchSet . For more information, see the applicable data types: + // - XssMatchSetUpdate : Contains Action and XssMatchTuple + // - XssMatchTuple : Contains FieldToMatch and TextTransformation + // - FieldToMatch : Contains Data and Type // // This member is required. Updates []types.XssMatchSetUpdate // The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is - // returned by CreateXssMatchSet and by ListXssMatchSets. + // returned by CreateXssMatchSet and by ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -105,7 +88,7 @@ type UpdateXssMatchSetOutput struct { // The ChangeToken that you used to submit the UpdateXssMatchSet request. You can // also use this value to query the status of the request. For more information, - // see GetChangeTokenStatus. + // see GetChangeTokenStatus . ChangeToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafregional/doc.go b/service/wafregional/doc.go index a41a2be4b6e..6e574a74bf6 100644 --- a/service/wafregional/doc.go +++ b/service/wafregional/doc.go @@ -1,26 +1,22 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package wafregional provides the API client, operations, and parameter types for -// AWS WAF Regional. +// Package wafregional provides the API client, operations, and parameter types +// for AWS WAF Regional. // // This is AWS WAF Classic Regional documentation. For more information, see AWS -// WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. This is the AWS WAF Regional Classic API Reference for using AWS WAF -// Classic with the AWS resources, Elastic Load Balancing (ELB) Application Load -// Balancers and API Gateway APIs. The AWS WAF Classic actions and data types +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. This is the AWS WAF Regional Classic API Reference for using AWS +// WAF Classic with the AWS resources, Elastic Load Balancing (ELB) Application +// Load Balancers and API Gateway APIs. The AWS WAF Classic actions and data types // listed in the reference are available for protecting Elastic Load Balancing // (ELB) Application Load Balancers and API Gateway APIs. You can use these actions -// and data types by means of the endpoints listed in AWS Regions and Endpoints -// (https://docs.aws.amazon.com/general/latest/gr/rande.html#waf_region). This -// guide is for developers who need detailed information about the AWS WAF Classic -// API actions, data types, and errors. For detailed information about AWS WAF -// Classic features and an overview of how to use the AWS WAF Classic API, see the -// AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// and data types by means of the endpoints listed in AWS Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#waf_region) +// . This guide is for developers who need detailed information about the AWS WAF +// Classic API actions, data types, and errors. For detailed information about AWS +// WAF Classic features and an overview of how to use the AWS WAF Classic API, see +// the AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. package wafregional diff --git a/service/wafregional/types/enums.go b/service/wafregional/types/enums.go index cdc053c7fff..00c6dc5b5ef 100644 --- a/service/wafregional/types/enums.go +++ b/service/wafregional/types/enums.go @@ -10,9 +10,9 @@ const ( ChangeActionDelete ChangeAction = "DELETE" ) -// Values returns all known values for ChangeAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChangeAction. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChangeAction) Values() []ChangeAction { return []ChangeAction{ "INSERT", @@ -728,9 +728,9 @@ const ( ParameterExceptionReasonInvalidTagKey ParameterExceptionReason = "INVALID_TAG_KEY" ) -// Values returns all known values for ParameterExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ParameterExceptionReason. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterExceptionReason) Values() []ParameterExceptionReason { return []ParameterExceptionReason{ "INVALID_OPTION", @@ -816,9 +816,9 @@ const ( ResourceTypeApiGateway ResourceType = "API_GATEWAY" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "APPLICATION_LOAD_BALANCER", @@ -880,8 +880,8 @@ const ( WafOverrideActionTypeCount WafOverrideActionType = "COUNT" ) -// Values returns all known values for WafOverrideActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for WafOverrideActionType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (WafOverrideActionType) Values() []WafOverrideActionType { return []WafOverrideActionType{ diff --git a/service/wafregional/types/errors.go b/service/wafregional/types/errors.go index 826cd2f24a7..de06e1620d2 100644 --- a/service/wafregional/types/errors.go +++ b/service/wafregional/types/errors.go @@ -59,30 +59,19 @@ func (e *WAFDisallowedNameException) ErrorCode() string { func (e *WAFDisallowedNameException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed due to a problem with the migration. The failure cause is -// provided in the exception, in the MigrationErrorType: -// -// * ENTITY_NOT_SUPPORTED - -// The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set -// to true. -// -// * ENTITY_NOT_FOUND - The web ACL doesn't exist. -// -// * -// S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject -// action to the specified Amazon S3 bucket. -// -// * S3_BUCKET_NOT_ACCESSIBLE - The -// bucket policy doesn't allow AWS WAF to perform the PutObject action in the -// bucket. -// -// * S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist. -// -// * -// S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web -// ACL. -// -// * S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 -// bucket for another reason. +// provided in the exception, in the MigrationErrorType : +// - ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the +// IgnoreUnsupportedType is not set to true. +// - ENTITY_NOT_FOUND - The web ACL doesn't exist. +// - S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject +// action to the specified Amazon S3 bucket. +// - S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to +// perform the PutObject action in the bucket. +// - S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist. +// - S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the +// web ACL. +// - S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket +// for another reason. type WAFEntityMigrationException struct { Message *string @@ -138,8 +127,8 @@ func (e *WAFInternalErrorException) ErrorCode() string { } func (e *WAFInternalErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The operation failed because you tried to create, update, or delete an object by -// using an invalid account identifier. +// The operation failed because you tried to create, update, or delete an object +// by using an invalid account identifier. type WAFInvalidAccountException struct { Message *string @@ -166,23 +155,16 @@ func (e *WAFInvalidAccountException) ErrorCode() string { func (e *WAFInvalidAccountException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed because there was nothing to do. For example: -// -// * You tried -// to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. -// -// * -// You tried to remove an IP address from an IPSet, but the IP address isn't in the -// specified IPSet. -// -// * You tried to remove a ByteMatchTuple from a ByteMatchSet, -// but the ByteMatchTuple isn't in the specified WebACL. -// -// * You tried to add a Rule -// to a WebACL, but the Rule already exists in the specified WebACL. -// -// * You tried -// to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists -// in the specified WebACL. +// - You tried to remove a Rule from a WebACL , but the Rule isn't in the +// specified WebACL . +// - You tried to remove an IP address from an IPSet , but the IP address isn't +// in the specified IPSet . +// - You tried to remove a ByteMatchTuple from a ByteMatchSet , but the +// ByteMatchTuple isn't in the specified WebACL . +// - You tried to add a Rule to a WebACL , but the Rule already exists in the +// specified WebACL . +// - You tried to add a ByteMatchTuple to a ByteMatchSet , but the ByteMatchTuple +// already exists in the specified WebACL . type WAFInvalidOperationException struct { Message *string @@ -210,34 +192,21 @@ func (e *WAFInvalidOperationException) ErrorFault() smithy.ErrorFault { return s // The operation failed because AWS WAF didn't recognize a parameter in the // request. For example: -// -// * You specified an invalid parameter name. -// -// * You -// specified an invalid value. -// -// * You tried to update an object (ByteMatchSet, -// IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. -// -// * You -// tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or -// COUNT. -// -// * You tried to create a RateBasedRule with a RateKey value other than -// IP. -// -// * You tried to update a WebACL with a WafActionType other than ALLOW, -// BLOCK, or COUNT. -// -// * You tried to update a ByteMatchSet with a FieldToMatchType -// other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -// -// * You tried to update a -// ByteMatchSet with a Field of HEADER but no value for Data. -// -// * Your request -// references an ARN that is malformed, or corresponds to a resource with which a -// web ACL cannot be associated. +// - You specified an invalid parameter name. +// - You specified an invalid value. +// - You tried to update an object ( ByteMatchSet , IPSet , Rule , or WebACL ) +// using an action other than INSERT or DELETE . +// - You tried to create a WebACL with a DefaultAction Type other than ALLOW , +// BLOCK , or COUNT . +// - You tried to create a RateBasedRule with a RateKey value other than IP . +// - You tried to update a WebACL with a WafAction Type other than ALLOW , BLOCK +// , or COUNT . +// - You tried to update a ByteMatchSet with a FieldToMatch Type other than +// HEADER, METHOD, QUERY_STRING, URI, or BODY. +// - You tried to update a ByteMatchSet with a Field of HEADER but no value for +// Data . +// - Your request references an ARN that is malformed, or corresponds to a +// resource with which a web ACL cannot be associated. type WAFInvalidParameterException struct { Message *string @@ -269,30 +238,17 @@ func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return s // The operation failed because the specified policy is not in the proper format. // The policy is subject to the following restrictions: -// -// * You can attach only one -// policy with each PutPermissionPolicy request. -// -// * The policy must include an -// Effect, Action and Principal. -// -// * Effect must specify Allow. -// -// * The Action in the -// policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and -// waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be -// rejected. -// -// * The policy cannot include a Resource parameter. -// -// * The ARN in the -// request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the -// same region. -// -// * The user making the request must be the owner of the -// RuleGroup. -// -// * Your policy must be composed using IAM Policy version 2012-10-17. +// - You can attach only one policy with each PutPermissionPolicy request. +// - The policy must include an Effect , Action and Principal . +// - Effect must specify Allow . +// - The Action in the policy must be waf:UpdateWebACL , +// waf-regional:UpdateWebACL , waf:GetRuleGroup and waf-regional:GetRuleGroup . +// Any extra or wildcard actions in the policy will be rejected. +// - The policy cannot include a Resource parameter. +// - The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup +// must exist in the same region. +// - The user making the request must be the owner of the RuleGroup. +// - Your policy must be composed using IAM Policy version 2012-10-17. type WAFInvalidPermissionPolicyException struct { Message *string @@ -375,20 +331,14 @@ func (e *WAFLimitsExceededException) ErrorCode() string { } func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to delete an object that isn't empty. For -// example: -// -// * You tried to delete a WebACL that still contains one or more Rule -// objects. -// -// * You tried to delete a Rule that still contains one or more -// ByteMatchSet objects or other predicates. -// -// * You tried to delete a ByteMatchSet -// that contains one or more ByteMatchTuple objects. -// -// * You tried to delete an -// IPSet that references one or more IP addresses. +// The operation failed because you tried to delete an object that isn't empty. +// For example: +// - You tried to delete a WebACL that still contains one or more Rule objects. +// - You tried to delete a Rule that still contains one or more ByteMatchSet +// objects or other predicates. +// - You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple +// objects. +// - You tried to delete an IPSet that references one or more IP addresses. type WAFNonEmptyEntityException struct { Message *string @@ -416,19 +366,14 @@ func (e *WAFNonEmptyEntityException) ErrorFault() smithy.ErrorFault { return smi // The operation failed because you tried to add an object to or delete an object // from another object that doesn't exist. For example: -// -// * You tried to add a Rule -// to or delete a Rule from a WebACL that doesn't exist. -// -// * You tried to add a -// ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. -// -// * You -// tried to add an IP address to or delete an IP address from an IPSet that doesn't -// exist. -// -// * You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a -// ByteMatchSet that doesn't exist. +// - You tried to add a Rule to or delete a Rule from a WebACL that doesn't +// exist. +// - You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that +// doesn't exist. +// - You tried to add an IP address to or delete an IP address from an IPSet that +// doesn't exist. +// - You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a +// ByteMatchSet that doesn't exist. type WAFNonexistentContainerException struct { Message *string @@ -480,13 +425,10 @@ func (e *WAFNonexistentItemException) ErrorCode() string { } func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to delete an object that is still in use. -// For example: -// -// * You tried to delete a ByteMatchSet that is still referenced by a -// Rule. -// -// * You tried to delete a Rule that is still referenced by a WebACL. +// The operation failed because you tried to delete an object that is still in +// use. For example: +// - You tried to delete a ByteMatchSet that is still referenced by a Rule . +// - You tried to delete a Rule that is still referenced by a WebACL . type WAFReferencedItemException struct { Message *string @@ -513,13 +455,13 @@ func (e *WAFReferencedItemException) ErrorCode() string { func (e *WAFReferencedItemException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // AWS WAF is not able to access the service linked role. This can be caused by a -// previous PutLoggingConfiguration request, which can lock the service linked role -// for about 20 seconds. Please try your request again. The service linked role can -// also be locked by a previous DeleteServiceLinkedRole request, which can lock the -// role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, -// wait at least 15 minutes and try the request again. If you receive this same -// exception again, you will have to wait additional time until the role is -// unlocked. +// previous PutLoggingConfiguration request, which can lock the service linked +// role for about 20 seconds. Please try your request again. The service linked +// role can also be locked by a previous DeleteServiceLinkedRole request, which +// can lock the role for 15 minutes or more. If you recently made a +// DeleteServiceLinkedRole , wait at least 15 minutes and try the request again. If +// you receive this same exception again, you will have to wait additional time +// until the role is unlocked. type WAFServiceLinkedRoleErrorException struct { Message *string @@ -547,8 +489,8 @@ func (e *WAFServiceLinkedRoleErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because you tried to create, update, or delete an object by -// using a change token that has already been used. +// The operation failed because you tried to create, update, or delete an object +// by using a change token that has already been used. type WAFStaleDataException struct { Message *string diff --git a/service/wafregional/types/types.go b/service/wafregional/types/types.go index b44f8c0267d..e709c4f1ddd 100644 --- a/service/wafregional/types/types.go +++ b/service/wafregional/types/types.go @@ -7,103 +7,91 @@ import ( "time" ) -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The ActivatedRule object in an UpdateWebACL request specifies a Rule -// that you want to insert or delete, the priority of the Rule in the WebACL, and -// the action that you want AWS WAF to take when a web request matches the Rule -// (ALLOW, BLOCK, or COUNT). To specify whether to insert or delete a Rule, use the -// Action parameter in the WebACLUpdate data type. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The ActivatedRule object in an UpdateWebACL request specifies a +// Rule that you want to insert or delete, the priority of the Rule in the WebACL , +// and the action that you want AWS WAF to take when a web request matches the Rule +// ( ALLOW , BLOCK , or COUNT ). To specify whether to insert or delete a Rule , +// use the Action parameter in the WebACLUpdate data type. type ActivatedRule struct { // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a // lower value for Priority are evaluated before Rules with a higher value. The - // value must be a unique integer. If you add multiple Rules to a WebACL, the + // value must be a unique integer. If you add multiple Rules to a WebACL , the // values don't need to be consecutive. // // This member is required. Priority *int32 - // The RuleId for a Rule. You use RuleId to get more information about a Rule (see - // GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete - // a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see - // DeleteRule). RuleId is returned by CreateRule and by ListRules. + // The RuleId for a Rule . You use RuleId to get more information about a Rule + // (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a WebACL or + // delete a one from a WebACL (see UpdateWebACL ), or delete a Rule from AWS WAF + // (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string - // Specifies the action that CloudFront or AWS WAF takes when a web request matches - // the conditions in the Rule. Valid values for Action include the following: - // - // * - // ALLOW: CloudFront responds with the requested object. - // - // * BLOCK: CloudFront - // responds with an HTTP 403 (Forbidden) status code. - // - // * COUNT: AWS WAF increments - // a counter of requests that match the conditions in the rule and then continues - // to inspect the web request based on the remaining rules in the web - // ACL. - // - // ActivatedRule|OverrideAction applies only when updating or adding a - // RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For - // all other update requests, ActivatedRule|Action is used instead of - // ActivatedRule|OverrideAction. + // Specifies the action that CloudFront or AWS WAF takes when a web request + // matches the conditions in the Rule . Valid values for Action include the + // following: + // - ALLOW : CloudFront responds with the requested object. + // - BLOCK : CloudFront responds with an HTTP 403 (Forbidden) status code. + // - COUNT : AWS WAF increments a counter of requests that match the conditions + // in the rule and then continues to inspect the web request based on the remaining + // rules in the web ACL. + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case, you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . Action *WafAction - // An array of rules to exclude from a rule group. This is applicable only when the - // ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot - // rule groups that are blocking traffic unexpectedly (false positives). One - // troubleshooting technique is to identify the specific rule within the rule group - // that is blocking the legitimate traffic and then disable (exclude) that - // particular rule. You can exclude rules from both your own rule groups and AWS - // Marketplace rule groups that have been associated with a web ACL. Specifying - // ExcludedRules does not remove those rules from the rule group. Rather, it - // changes the action for the rules to COUNT. Therefore, requests that match an - // ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT - // metrics for each ExcludedRule. If you want to exclude rules from a rule group - // that is already associated with a web ACL, perform the following steps: - // - // * Use - // the AWS WAF logs to identify the IDs of the rules that you want to exclude. For - // more information about the logs, see Logging Web ACL Traffic Information - // (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html). - // - // * Submit - // an UpdateWebACL request that has two actions: - // - // * The first action deletes the - // existing rule group from the web ACL. That is, in the UpdateWebACL request, the - // first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be - // the rule group that contains the rules that you want to exclude. - // - // * The second - // action inserts the same rule group back in, but specifying the rules to exclude. - // That is, the second Updates:Action should be INSERT, - // Updates:ActivatedRule:RuleId should be the rule group that you just removed, and - // ExcludedRules should contain the rules that you want to exclude. + // An array of rules to exclude from a rule group. This is applicable only when + // the ActivatedRule refers to a RuleGroup . Sometimes it is necessary to + // troubleshoot rule groups that are blocking traffic unexpectedly (false + // positives). One troubleshooting technique is to identify the specific rule + // within the rule group that is blocking the legitimate traffic and then disable + // (exclude) that particular rule. You can exclude rules from both your own rule + // groups and AWS Marketplace rule groups that have been associated with a web ACL. + // Specifying ExcludedRules does not remove those rules from the rule group. + // Rather, it changes the action for the rules to COUNT . Therefore, requests that + // match an ExcludedRule are counted but not blocked. The RuleGroup owner will + // receive COUNT metrics for each ExcludedRule . If you want to exclude rules from + // a rule group that is already associated with a web ACL, perform the following + // steps: + // - Use the AWS WAF logs to identify the IDs of the rules that you want to + // exclude. For more information about the logs, see Logging Web ACL Traffic + // Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) + // . + // - Submit an UpdateWebACL request that has two actions: + // - The first action deletes the existing rule group from the web ACL. That is, + // in the UpdateWebACL request, the first Updates:Action should be DELETE and + // Updates:ActivatedRule:RuleId should be the rule group that contains the rules + // that you want to exclude. + // - The second action inserts the same rule group back in, but specifying the + // rules to exclude. That is, the second Updates:Action should be INSERT , + // Updates:ActivatedRule:RuleId should be the rule group that you just removed, + // and ExcludedRules should contain the rules that you want to exclude. ExcludedRules []ExcludedRule - // Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can - // potentially block a request. If you set the OverrideAction to None, the + // Use the OverrideAction to test your RuleGroup . Any rule in a RuleGroup can + // potentially block a request. If you set the OverrideAction to None , the // RuleGroup will block a request if any individual rule in the RuleGroup matches // the request and is configured to block that request. However if you first want - // to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then - // override any block action specified by individual rules contained within the - // group. Instead of blocking matching requests, those requests will be counted. - // You can view a record of counted requests using GetSampledRequests. - // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to - // a WebACL. In this case you do not use ActivatedRule|Action. For all other update - // requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. + // to test the RuleGroup , set the OverrideAction to Count . The RuleGroup will + // then override any block action specified by individual rules contained within + // the group. Instead of blocking matching requests, those requests will be + // counted. You can view a record of counted requests using GetSampledRequests . + // ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup + // to a WebACL . In this case you do not use ActivatedRule|Action . For all other + // update requests, ActivatedRule|Action is used instead of + // ActivatedRule|OverrideAction . OverrideAction *WafOverrideAction - // The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by - // RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. + // The rule type, either REGULAR , as defined by Rule , RATE_BASED , as defined by + // RateBasedRule , or GROUP , as defined by RuleGroup . The default is REGULAR. // Although this field is optional, be aware that if you try to add a RATE_BASED // rule to a web ACL without setting the type, the UpdateWebACL request will fail // because the request tries to add a REGULAR rule with the specified ID, which @@ -113,27 +101,25 @@ type ActivatedRule struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetByteMatchSet request, ByteMatchSet is a complex type that -// contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you -// specified when you updated the ByteMatchSet. A complex type that contains -// ByteMatchTuple objects, which specify the parts of web requests that you want -// AWS WAF to inspect and the values that you want AWS WAF to search for. If a -// ByteMatchSet contains more than one ByteMatchTuple object, a request needs to -// match the settings in only one ByteMatchTuple to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetByteMatchSet request, ByteMatchSet is a complex type +// that contains the ByteMatchSetId and Name of a ByteMatchSet , and the values +// that you specified when you updated the ByteMatchSet . A complex type that +// contains ByteMatchTuple objects, which specify the parts of web requests that +// you want AWS WAF to inspect and the values that you want AWS WAF to search for. +// If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs +// to match the settings in only one ByteMatchTuple to be considered a match. type ByteMatchSet struct { - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see - // UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see - // DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by - // ListByteMatchSets. + // The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get + // information about a ByteMatchSet (see GetByteMatchSet ), update a ByteMatchSet + // (see UpdateByteMatchSet ), insert a ByteMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete a ByteMatchSet from AWS WAF (see + // DeleteByteMatchSet ). ByteMatchSetId is returned by CreateByteMatchSet and by + // ListByteMatchSets . // // This member is required. ByteMatchSetId *string @@ -145,33 +131,31 @@ type ByteMatchSet struct { // This member is required. ByteMatchTuples []ByteMatchTuple - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListByteMatchSets. Each ByteMatchSetSummary object -// includes the Name and ByteMatchSetId for one ByteMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListByteMatchSets . Each ByteMatchSetSummary object +// includes the Name and ByteMatchSetId for one ByteMatchSet . type ByteMatchSetSummary struct { - // The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information - // about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, - // and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by - // CreateByteMatchSet and by ListByteMatchSets. + // The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get + // information about a ByteMatchSet , update a ByteMatchSet , remove a ByteMatchSet + // from a Rule , and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is + // returned by CreateByteMatchSet and by ListByteMatchSets . // // This member is required. ByteMatchSetId *string - // A friendly name or description of the ByteMatchSet. You can't change Name after - // you create a ByteMatchSet. + // A friendly name or description of the ByteMatchSet . You can't change Name + // after you create a ByteMatchSet . // // This member is required. Name *string @@ -179,26 +163,24 @@ type ByteMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies // whether to insert or delete a ByteMatchTuple and includes the settings for the -// ByteMatchTuple. +// ByteMatchTuple . type ByteMatchSetUpdate struct { - // Specifies whether to insert or delete a ByteMatchTuple. + // Specifies whether to insert or delete a ByteMatchTuple . // // This member is required. Action ChangeAction - // Information about the part of a web request that you want AWS WAF to inspect and - // the value that you want AWS WAF to search for. If you specify DELETE for the - // value of Action, the ByteMatchTuple values must exactly match the values in the - // ByteMatchTuple that you want to delete from the ByteMatchSet. + // Information about the part of a web request that you want AWS WAF to inspect + // and the value that you want AWS WAF to search for. If you specify DELETE for + // the value of Action , the ByteMatchTuple values must exactly match the values + // in the ByteMatchTuple that you want to delete from the ByteMatchSet . // // This member is required. ByteMatchTuple *ByteMatchTuple @@ -206,176 +188,122 @@ type ByteMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The bytes (typically a string that corresponds with ASCII +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The bytes (typically a string that corresponds with ASCII // characters) that you want AWS WAF to search for in web requests, the location in // requests that you want AWS WAF to search, and other settings. type ByteMatchTuple struct { // The part of a web request that you want AWS WAF to search, such as a specified - // header or a query string. For more information, see FieldToMatch. + // header or a query string. For more information, see FieldToMatch . // // This member is required. FieldToMatch *FieldToMatch - // Within the portion of a web request that you want to search (for example, in the - // query string, if any), specify where you want AWS WAF to search. Valid values - // include the following: CONTAINS The specified part of the web request must - // include the value of TargetString, but the location doesn't matter. + // Within the portion of a web request that you want to search (for example, in + // the query string, if any), specify where you want AWS WAF to search. Valid + // values include the following: CONTAINS The specified part of the web request + // must include the value of TargetString , but the location doesn't matter. // CONTAINS_WORD The specified part of the web request must include the value of - // TargetString, and TargetString must contain only alphanumeric characters or + // TargetString , and TargetString must contain only alphanumeric characters or // underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, // which means one of the following: - // - // * TargetString exactly matches the value of - // the specified part of the web request, such as the value of a header. - // - // * - // TargetString is at the beginning of the specified part of the web request and is - // followed by a character other than an alphanumeric character or underscore (_), - // for example, BadBot;. - // - // * TargetString is at the end of the specified part of the - // web request and is preceded by a character other than an alphanumeric character - // or underscore (_), for example, ;BadBot. - // - // * TargetString is in the middle of the - // specified part of the web request and is preceded and followed by characters - // other than alphanumeric characters or underscore (_), for example, - // -BadBot;. - // - // EXACTLY The value of the specified part of the web request must - // exactly match the value of TargetString. STARTS_WITH The value of TargetString - // must appear at the beginning of the specified part of the web request. ENDS_WITH - // The value of TargetString must appear at the end of the specified part of the - // web request. + // - TargetString exactly matches the value of the specified part of the web + // request, such as the value of a header. + // - TargetString is at the beginning of the specified part of the web request + // and is followed by a character other than an alphanumeric character or + // underscore (_), for example, BadBot; . + // - TargetString is at the end of the specified part of the web request and is + // preceded by a character other than an alphanumeric character or underscore (_), + // for example, ;BadBot . + // - TargetString is in the middle of the specified part of the web request and + // is preceded and followed by characters other than alphanumeric characters or + // underscore (_), for example, -BadBot; . + // EXACTLY The value of the specified part of the web request must exactly match + // the value of TargetString . STARTS_WITH The value of TargetString must appear + // at the beginning of the specified part of the web request. ENDS_WITH The value + // of TargetString must appear at the end of the specified part of the web request. // // This member is required. PositionalConstraint PositionalConstraint // The value that you want AWS WAF to search for. AWS WAF searches for the - // specified string in the part of web requests that you specified in FieldToMatch. - // The maximum length of the value is 50 bytes. Valid values depend on the values - // that you specified for FieldToMatch: - // - // * HEADER: The value that you want AWS WAF - // to search for in the request header that you specified in FieldToMatch, for - // example, the value of the User-Agent or Referer header. - // - // * METHOD: The HTTP - // method, which indicates the type of operation specified in the request. - // CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, - // POST, and PUT. - // - // * QUERY_STRING: The value that you want AWS WAF to search for in - // the query string, which is the part of a URL that appears after a ? - // character. - // - // * URI: The value that you want AWS WAF to search for in the part of - // a URL that identifies a resource, for example, /images/daily-ad.jpg. - // - // * BODY: - // The part of a request that contains any additional data that you want to send to - // your web server as the HTTP request body, such as data from a form. The request - // body immediately follows the request headers. Note that only the first 8192 - // bytes of the request body are forwarded to AWS WAF for inspection. To allow or - // block requests based on the length of the body, you can create a size constraint - // set. For more information, see CreateSizeConstraintSet. - // - // * SINGLE_QUERY_ARG: The - // parameter in the query string that you will inspect, such as UserName or - // SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. - // - // * - // ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single - // parameter, AWS WAF inspects all parameters within the query string for the value - // or regex pattern that you specify in TargetString. - // - // If TargetString includes - // alphabetic characters A-Z and a-z, note that the value is case sensitive. If - // you're using the AWS WAF API Specify a base64-encoded version of the value. The - // maximum length of the value before you base64-encode it is 50 bytes. For - // example, suppose the value of Type is HEADER and the value of Data is - // User-Agent. If you want to search the User-Agent header for the value BadBot, - // you base64-encode BadBot using MIME base64-encoding and include the resulting - // value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or - // one of the AWS SDKs The value that you want AWS WAF to search for. The SDK - // automatically base64 encodes the value. + // specified string in the part of web requests that you specified in FieldToMatch + // . The maximum length of the value is 50 bytes. Valid values depend on the values + // that you specified for FieldToMatch : + // - HEADER : The value that you want AWS WAF to search for in the request header + // that you specified in FieldToMatch , for example, the value of the User-Agent + // or Referer header. + // - METHOD : The HTTP method, which indicates the type of operation specified in + // the request. CloudFront supports the following methods: DELETE , GET , HEAD , + // OPTIONS , PATCH , POST , and PUT . + // - QUERY_STRING : The value that you want AWS WAF to search for in the query + // string, which is the part of a URL that appears after a ? character. + // - URI : The value that you want AWS WAF to search for in the part of a URL + // that identifies a resource, for example, /images/daily-ad.jpg . + // - BODY : The part of a request that contains any additional data that you want + // to send to your web server as the HTTP request body, such as data from a form. + // The request body immediately follows the request headers. Note that only the + // first 8192 bytes of the request body are forwarded to AWS WAF for inspection. + // To allow or block requests based on the length of the body, you can create a + // size constraint set. For more information, see CreateSizeConstraintSet . + // - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, + // such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 + // characters. + // - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but instead of inspecting a + // single parameter, AWS WAF inspects all parameters within the query string for + // the value or regex pattern that you specify in TargetString . + // If TargetString includes alphabetic characters A-Z and a-z, note that the value + // is case sensitive. If you're using the AWS WAF API Specify a base64-encoded + // version of the value. The maximum length of the value before you base64-encode + // it is 50 bytes. For example, suppose the value of Type is HEADER and the value + // of Data is User-Agent . If you want to search the User-Agent header for the + // value BadBot , you base64-encode BadBot using MIME base64-encoding and include + // the resulting value, QmFkQm90 , in the value of TargetString . If you're using + // the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search + // for. The SDK automatically base64 encodes the value. // // This member is required. TargetString []byte - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -383,15 +311,13 @@ type ByteMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The rule to exclude from a rule group. This is applicable only when -// the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup -// that is specified by the ActivatedRule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The rule to exclude from a rule group. This is applicable only +// when the ActivatedRule refers to a RuleGroup . The rule must belong to the +// RuleGroup that is specified by the ActivatedRule . type ExcludedRule struct { // The unique identifier for the rule to exclude from the rule group. @@ -402,73 +328,58 @@ type ExcludedRule struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies where in a web request to look for TargetString. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies where in a web request to look for TargetString . type FieldToMatch struct { // The part of the web request that you want AWS WAF to search for a specified // string. Parts of a request that you can search include the following: - // - // * HEADER: - // A specified request header, for example, the value of the User-Agent or Referer - // header. If you choose HEADER for the type, specify the name of the header in - // Data. - // - // * METHOD: The HTTP method, which indicated the type of operation that the - // request is asking the origin to perform. Amazon CloudFront supports the - // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. - // - // * - // QUERY_STRING: A query string, which is the part of a URL that appears after a ? - // character, if any. - // - // * URI: The part of a web request that identifies a resource, - // for example, /images/daily-ad.jpg. - // - // * BODY: The part of a request that contains - // any additional data that you want to send to your web server as the HTTP request - // body, such as data from a form. The request body immediately follows the request - // headers. Note that only the first 8192 bytes of the request body are forwarded - // to AWS WAF for inspection. To allow or block requests based on the length of the - // body, you can create a size constraint set. For more information, see - // CreateSizeConstraintSet. - // - // * SINGLE_QUERY_ARG: The parameter in the query string - // that you will inspect, such as UserName or SalesRegion. The maximum length for - // SINGLE_QUERY_ARG is 30 characters. - // - // * ALL_QUERY_ARGS: Similar to - // SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will - // inspect all parameters within the query for the value or regex pattern that you - // specify in TargetString. + // - HEADER : A specified request header, for example, the value of the + // User-Agent or Referer header. If you choose HEADER for the type, specify the + // name of the header in Data . + // - METHOD : The HTTP method, which indicated the type of operation that the + // request is asking the origin to perform. Amazon CloudFront supports the + // following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . + // - QUERY_STRING : A query string, which is the part of a URL that appears after + // a ? character, if any. + // - URI : The part of a web request that identifies a resource, for example, + // /images/daily-ad.jpg . + // - BODY : The part of a request that contains any additional data that you want + // to send to your web server as the HTTP request body, such as data from a form. + // The request body immediately follows the request headers. Note that only the + // first 8192 bytes of the request body are forwarded to AWS WAF for inspection. + // To allow or block requests based on the length of the body, you can create a + // size constraint set. For more information, see CreateSizeConstraintSet . + // - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, + // such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 + // characters. + // - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a + // single parameter, AWS WAF will inspect all parameters within the query for the + // value or regex pattern that you specify in TargetString . // // This member is required. Type MatchFieldType - // When the value of Type is HEADER, enter the name of the header that you want AWS - // WAF to search, for example, User-Agent or Referer. The name of the header is not - // case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of - // the parameter that you want AWS WAF to search, for example, UserName or - // SalesRegion. The parameter name is not case sensitive. If the value of Type is - // any other value, omit Data. + // When the value of Type is HEADER , enter the name of the header that you want + // AWS WAF to search, for example, User-Agent or Referer . The name of the header + // is not case sensitive. When the value of Type is SINGLE_QUERY_ARG , enter the + // name of the parameter that you want AWS WAF to search, for example, UserName or + // SalesRegion . The parameter name is not case sensitive. If the value of Type is + // any other value, omit Data . Data *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The country from which web requests originate that you want AWS WAF -// to search for. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The country from which web requests originate that you want AWS +// WAF to search for. type GeoMatchConstraint struct { // The type of geographical area you want AWS WAF to search for. Currently Country @@ -485,13 +396,11 @@ type GeoMatchConstraint struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains one or more countries that AWS WAF will search for. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains one or more countries that AWS WAF will search for. type GeoMatchSet struct { // An array of GeoMatchConstraint objects, which contain the country that you want @@ -500,38 +409,36 @@ type GeoMatchSet struct { // This member is required. GeoMatchConstraints []GeoMatchConstraint - // The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information - // about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see - // UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). - // GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. + // The GeoMatchSetId for an GeoMatchSet . You use GeoMatchSetId to get information + // about a GeoMatchSet (see GeoMatchSet ), update a GeoMatchSet (see + // UpdateGeoMatchSet ), insert a GeoMatchSet into a Rule or delete one from a Rule + // (see UpdateRule ), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet + // ). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets . // // This member is required. GeoMatchSetId *string - // A friendly name or description of the GeoMatchSet. You can't change the name of + // A friendly name or description of the GeoMatchSet . You can't change the name of // an GeoMatchSet after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name of the GeoMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name of the GeoMatchSet . type GeoMatchSetSummary struct { - // The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a - // GetGeoMatchSet request to get detailed information about an GeoMatchSet. + // The GeoMatchSetId for an GeoMatchSet . You can use GeoMatchSetId in a + // GetGeoMatchSet request to get detailed information about an GeoMatchSet . // // This member is required. GeoMatchSetId *string - // A friendly name or description of the GeoMatchSet. You can't change the name of + // A friendly name or description of the GeoMatchSet . You can't change the name of // an GeoMatchSet after you create it. // // This member is required. @@ -540,17 +447,15 @@ type GeoMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the type of update to perform to an GeoMatchSet with -// UpdateGeoMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the type of update to perform to an GeoMatchSet with +// UpdateGeoMatchSet . type GeoMatchSetUpdate struct { - // Specifies whether to insert or delete a country with UpdateGeoMatchSet. + // Specifies whether to insert or delete a country with UpdateGeoMatchSet . // // This member is required. Action ChangeAction @@ -564,16 +469,14 @@ type GeoMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes an +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes an // HTTPHeader complex type that appears as Headers in the response syntax. // HTTPHeader contains the names and values of all of the headers that appear in -// one of the web requests that were returned by GetSampledRequests. +// one of the web requests that were returned by GetSampledRequests . type HTTPHeader struct { // The name of one of the headers in the sampled web request. @@ -585,35 +488,31 @@ type HTTPHeader struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes an +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes an // HTTPRequest complex type that appears as Request in the response syntax. // HTTPRequest contains information about one of the web requests that were -// returned by GetSampledRequests. +// returned by GetSampledRequests . type HTTPRequest struct { // The IP address that the request originated from. If the WebACL is associated // with a CloudFront distribution, this is the value of one of the following fields // in CloudFront access logs: - // - // * c-ip, if the viewer did not use an HTTP proxy or a - // load balancer to send the request - // - // * x-forwarded-for, if the viewer did use an - // HTTP proxy or a load balancer to send the request + // - c-ip , if the viewer did not use an HTTP proxy or a load balancer to send + // the request + // - x-forwarded-for , if the viewer did use an HTTP proxy or a load balancer to + // send the request ClientIP *string // The two-letter country code for the country that the request originated from. - // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 - // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + // . Country *string - // The HTTP version specified in the sampled web request, for example, HTTP/1.1. + // The HTTP version specified in the sampled web request, for example, HTTP/1.1 . HTTPVersion *string // A complex type that contains two values for each header in the sampled web @@ -621,35 +520,33 @@ type HTTPRequest struct { Headers []HTTPHeader // The HTTP method specified in the sampled web request. CloudFront supports the - // following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. + // following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . Method *string // The part of a web request that identifies the resource, for example, - // /images/daily-ad.jpg. + // /images/daily-ad.jpg . URI *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains one or more IP addresses or blocks of IP addresses +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains one or more IP addresses or blocks of IP addresses // specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports // IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports // IPv6 address ranges: /24, /32, /48, /56, /64, and /128. To specify an individual -// IP address, you specify the four-part IP address followed by a /32, for example, -// 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range -// between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for -// IPv6). For more information about CIDR notation, see the Wikipedia entry -// Classless Inter-Domain Routing -// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). +// IP address, you specify the four-part IP address followed by a /32 , for +// example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or +// any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 +// (for IPv6). For more information about CIDR notation, see the Wikipedia entry +// Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . type IPSet struct { - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) // that web requests originate from. If the WebACL is associated with a CloudFront // distribution and the viewer did not use an HTTP proxy or a load balancer to send // the request, this is the value of the c-ip field in the CloudFront access logs. @@ -657,61 +554,49 @@ type IPSet struct { // This member is required. IPSetDescriptors []IPSetDescriptor - // The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see - // GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or - // delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see - // DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets. + // The IPSetId for an IPSet . You use IPSetId to get information about an IPSet + // (see GetIPSet ), update an IPSet (see UpdateIPSet ), insert an IPSet into a Rule + // or delete one from a Rule (see UpdateRule ), and delete an IPSet from AWS WAF + // (see DeleteIPSet ). IPSetId is returned by CreateIPSet and by ListIPSets . // // This member is required. IPSetId *string - // A friendly name or description of the IPSet. You can't change the name of an + // A friendly name or description of the IPSet . You can't change the name of an // IPSet after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the IP address type (IPV4 or IPV6) and the IP address -// range (in CIDR format) that web requests originate from. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the IP address type ( IPV4 or IPV6 ) and the IP +// address range (in CIDR format) that web requests originate from. type IPSetDescriptor struct { - // Specify IPV4 or IPV6. + // Specify IPV4 or IPV6 . // // This member is required. Type IPSetDescriptorType // Specify an IPv4 address by using CIDR notation. For example: - // - // * To configure AWS - // WAF to allow, block, or count requests that originated from the IP address - // 192.0.2.44, specify 192.0.2.44/32. - // - // * To configure AWS WAF to allow, block, or - // count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, - // specify 192.0.2.0/24. - // - // For more information about CIDR notation, see the - // Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Specify an IPv6 - // address by using CIDR notation. For example: - // - // * To configure AWS WAF to allow, - // block, or count requests that originated from the IP address - // 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure AWS WAF to allow, - // block, or count requests that originated from IP addresses - // 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. + // - To configure AWS WAF to allow, block, or count requests that originated + // from the IP address 192.0.2.44, specify 192.0.2.44/32 . + // - To configure AWS WAF to allow, block, or count requests that originated + // from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . Specify an IPv6 address by using CIDR notation. For example: + // - To configure AWS WAF to allow, block, or count requests that originated + // from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure AWS WAF to allow, block, or count requests that originated + // from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . // // This member is required. Value *string @@ -719,22 +604,20 @@ type IPSetDescriptor struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name of the IPSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name of the IPSet . type IPSetSummary struct { - // The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get - // detailed information about an IPSet. + // The IPSetId for an IPSet . You can use IPSetId in a GetIPSet request to get + // detailed information about an IPSet . // // This member is required. IPSetId *string - // A friendly name or description of the IPSet. You can't change the name of an + // A friendly name or description of the IPSet . You can't change the name of an // IPSet after you create it. // // This member is required. @@ -743,22 +626,20 @@ type IPSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the type of update to perform to an IPSet with -// UpdateIPSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the type of update to perform to an IPSet with +// UpdateIPSet . type IPSetUpdate struct { - // Specifies whether to insert or delete an IP address with UpdateIPSet. + // Specifies whether to insert or delete an IP address with UpdateIPSet . // // This member is required. Action ChangeAction - // The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) + // The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation) // that web requests originate from. // // This member is required. @@ -767,14 +648,12 @@ type IPSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Amazon Kinesis Data Firehose, RedactedFields information, and -// the web ACL Amazon Resource Name (ARN). +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Amazon Kinesis Data Firehose, RedactedFields information, +// and the web ACL Amazon Resource Name (ARN). type LoggingConfiguration struct { // An array of Amazon Kinesis Data Firehose ARNs. @@ -783,52 +662,50 @@ type LoggingConfiguration struct { LogDestinationConfigs []string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with - // LogDestinationConfigs. + // LogDestinationConfigs . // // This member is required. ResourceArn *string // The parts of the request that you want redacted from the logs. For example, if - // you redact the cookie field, the cookie field in the firehose will be xxx. + // you redact the cookie field, the cookie field in the firehose will be xxx . RedactedFields []FieldToMatch noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, -// XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you -// want to add to a Rule and, for each object, indicates whether you want to negate -// the settings, for example, requests that do NOT originate from the IP address -// 192.0.2.44. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , +// XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that +// you want to add to a Rule and, for each object, indicates whether you want to +// negate the settings, for example, requests that do NOT originate from the IP +// address 192.0.2.44. type Predicate struct { - // A unique identifier for a predicate in a Rule, such as ByteMatchSetId or - // IPSetId. The ID is returned by the corresponding Create or List command. + // A unique identifier for a predicate in a Rule , such as ByteMatchSetId or + // IPSetId . The ID is returned by the corresponding Create or List command. // // This member is required. DataId *string // Set Negated to False if you want AWS WAF to allow, block, or count requests - // based on the settings in the specified ByteMatchSet, IPSet, - // SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or - // SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, - // AWS WAF will allow or block requests based on that IP address. Set Negated to + // based on the settings in the specified ByteMatchSet , IPSet , + // SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or + // SizeConstraintSet . For example, if an IPSet includes the IP address 192.0.2.44 + // , AWS WAF will allow or block requests based on that IP address. Set Negated to // True if you want AWS WAF to allow or block a request based on the negation of - // the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, - // RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet - // includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests - // based on all IP addresses except 192.0.2.44. + // the settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , + // RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if an IPSet + // includes the IP address 192.0.2.44 , AWS WAF will allow, block, or count + // requests based on all IP addresses except 192.0.2.44 . // // This member is required. Negated *bool - // The type of predicate in a Rule, such as ByteMatch or IPSet. + // The type of predicate in a Rule , such as ByteMatch or IPSet . // // This member is required. Type PredicateType @@ -836,140 +713,125 @@ type Predicate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A RateBasedRule is identical to a regular Rule, with one addition: a -// RateBasedRule counts the number of requests that arrive from a specified IP -// address every five minutes. For example, based on recent requests that you've -// seen from an attacker, you might create a RateBasedRule that includes the -// following conditions: -// -// * The requests come from 192.0.2.44. -// -// * They contain the -// value BadBot in the User-Agent header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A RateBasedRule is identical to a regular Rule , with one +// addition: a RateBasedRule counts the number of requests that arrive from a +// specified IP address every five minutes. For example, based on recent requests +// that you've seen from an attacker, you might create a RateBasedRule that +// includes the following conditions: +// - The requests come from 192.0.2.44. +// - They contain the value BadBot in the User-Agent header. // -// In the rule, you also define the rate -// limit as 1,000. Requests that meet both of these conditions and exceed 1,000 -// requests every five minutes trigger the rule's action (block or count), which is -// defined in the web ACL. +// In the rule, you also define the rate limit as 1,000. Requests that meet both +// of these conditions and exceed 1,000 requests every five minutes trigger the +// rule's action (block or count), which is defined in the web ACL. type RateBasedRule struct { - // The Predicates object contains one Predicate element for each ByteMatchSet, - // IPSet, or SqlInjectionMatchSet object that you want to include in a - // RateBasedRule. + // The Predicates object contains one Predicate element for each ByteMatchSet , + // IPSet , or SqlInjectionMatchSet object that you want to include in a + // RateBasedRule . // // This member is required. MatchPredicates []Predicate // The field that AWS WAF uses to determine if requests are likely arriving from // single source and thus subject to rate monitoring. The only valid value for - // RateKey is IP. IP indicates that requests arriving from the same IP address are - // subject to the RateLimit that is specified in the RateBasedRule. + // RateKey is IP . IP indicates that requests arriving from the same IP address + // are subject to the RateLimit that is specified in the RateBasedRule . // // This member is required. RateKey RateKey // The maximum number of requests, which have an identical value in the field - // specified by the RateKey, allowed in a five-minute period. If the number of + // specified by the RateKey , allowed in a five-minute period. If the number of // requests exceeds the RateLimit and the other predicates specified in the rule // are also met, AWS WAF triggers the action that is specified for this rule. // // This member is required. RateLimit int64 - // A unique identifier for a RateBasedRule. You use RuleId to get more information - // about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see - // UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a - // WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see - // DeleteRateBasedRule). + // A unique identifier for a RateBasedRule . You use RuleId to get more + // information about a RateBasedRule (see GetRateBasedRule ), update a + // RateBasedRule (see UpdateRateBasedRule ), insert a RateBasedRule into a WebACL + // or delete one from a WebACL (see UpdateWebACL ), or delete a RateBasedRule from + // AWS WAF (see DeleteRateBasedRule ). // // This member is required. RuleId *string - // A friendly name or description for the metrics for a RateBasedRule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 - // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RateBasedRule. + // A friendly name or description for the metrics for a RateBasedRule . The name + // can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length + // 128 and minimum length one. It can't contain whitespace or metric names reserved + // for AWS WAF, including "All" and "Default_Action." You can't change the name of + // the metric after you create the RateBasedRule . MetricName *string - // A friendly name or description for a RateBasedRule. You can't change the name of - // a RateBasedRule after you create it. + // A friendly name or description for a RateBasedRule . You can't change the name + // of a RateBasedRule after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetRegexMatchSet request, RegexMatchSet is a complex type that -// contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that -// you specified when you updated the RegexMatchSet. The values are contained in a -// RegexMatchTuple object, which specify the parts of web requests that you want -// AWS WAF to inspect and the values that you want AWS WAF to search for. If a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetRegexMatchSet request, RegexMatchSet is a complex type +// that contains the RegexMatchSetId and Name of a RegexMatchSet , and the values +// that you specified when you updated the RegexMatchSet . The values are contained +// in a RegexMatchTuple object, which specify the parts of web requests that you +// want AWS WAF to inspect and the values that you want AWS WAF to search for. If a // RegexMatchSet contains more than one RegexMatchTuple object, a request needs to // match the settings in only one ByteMatchTuple to be considered a match. type RegexMatchSet struct { - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . Name *string - // The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get - // information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet - // (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from - // a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see - // DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by - // ListRegexMatchSets. + // The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get + // information about a RegexMatchSet (see GetRegexMatchSet ), update a + // RegexMatchSet (see UpdateRegexMatchSet ), insert a RegexMatchSet into a Rule or + // delete one from a Rule (see UpdateRule ), and delete a RegexMatchSet from AWS + // WAF (see DeleteRegexMatchSet ). RegexMatchSetId is returned by + // CreateRegexMatchSet and by ListRegexMatchSets . RegexMatchSetId *string // Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object // contains: - // - // * The part of a web request that you want AWS WAF to inspect, such as - // a query string or the value of the User-Agent header. - // - // * The identifier of the - // pattern (a regular expression) that you want AWS WAF to look for. For more - // information, see RegexPatternSet. - // - // * Whether to perform any conversions on the - // request, such as converting it to lowercase, before inspecting it for the - // specified string. + // - The part of a web request that you want AWS WAF to inspect, such as a query + // string or the value of the User-Agent header. + // - The identifier of the pattern (a regular expression) that you want AWS WAF + // to look for. For more information, see RegexPatternSet . + // - Whether to perform any conversions on the request, such as converting it to + // lowercase, before inspecting it for the specified string. RegexMatchTuples []RegexMatchTuple noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListRegexMatchSets. Each RegexMatchSetSummary object -// includes the Name and RegexMatchSetId for one RegexMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListRegexMatchSets . Each RegexMatchSetSummary +// object includes the Name and RegexMatchSetId for one RegexMatchSet . type RegexMatchSetSummary struct { - // A friendly name or description of the RegexMatchSet. You can't change Name after - // you create a RegexMatchSet. + // A friendly name or description of the RegexMatchSet . You can't change Name + // after you create a RegexMatchSet . // // This member is required. Name *string - // The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get - // information about a RegexMatchSet, update a RegexMatchSet, remove a - // RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. + // The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get + // information about a RegexMatchSet , update a RegexMatchSet , remove a + // RegexMatchSet from a Rule , and delete a RegexMatchSet from AWS WAF. + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets . // // This member is required. RegexMatchSetId *string @@ -977,27 +839,25 @@ type RegexMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies -// whether to insert or delete a RegexMatchTuple and includes the settings for the -// RegexMatchTuple. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateRegexMatchSet request, RegexMatchSetUpdate +// specifies whether to insert or delete a RegexMatchTuple and includes the +// settings for the RegexMatchTuple . type RegexMatchSetUpdate struct { - // Specifies whether to insert or delete a RegexMatchTuple. + // Specifies whether to insert or delete a RegexMatchTuple . // // This member is required. Action ChangeAction - // Information about the part of a web request that you want AWS WAF to inspect and - // the identifier of the regular expression (regex) pattern that you want AWS WAF - // to search for. If you specify DELETE for the value of Action, the - // RegexMatchTuple values must exactly match the values in the RegexMatchTuple that - // you want to delete from the RegexMatchSet. + // Information about the part of a web request that you want AWS WAF to inspect + // and the identifier of the regular expression (regex) pattern that you want AWS + // WAF to search for. If you specify DELETE for the value of Action , the + // RegexMatchTuple values must exactly match the values in the RegexMatchTuple + // that you want to delete from the RegexMatchSet . // // This member is required. RegexMatchTuple *RegexMatchTuple @@ -1005,110 +865,72 @@ type RegexMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The regular expression pattern that you want AWS WAF to search for -// in web requests, the location in requests that you want AWS WAF to search, and -// other settings. Each RegexMatchTuple object contains: -// -// * The part of a web -// request that you want AWS WAF to inspect, such as a query string or the value of -// the User-Agent header. -// -// * The identifier of the pattern (a regular expression) -// that you want AWS WAF to look for. For more information, see RegexPatternSet. -// -// * -// Whether to perform any conversions on the request, such as converting it to -// lowercase, before inspecting it for the specified string. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The regular expression pattern that you want AWS WAF to search +// for in web requests, the location in requests that you want AWS WAF to search, +// and other settings. Each RegexMatchTuple object contains: +// - The part of a web request that you want AWS WAF to inspect, such as a query +// string or the value of the User-Agent header. +// - The identifier of the pattern (a regular expression) that you want AWS WAF +// to look for. For more information, see RegexPatternSet . +// - Whether to perform any conversions on the request, such as converting it to +// lowercase, before inspecting it for the specified string. type RegexMatchTuple struct { - // Specifies where in a web request to look for the RegexPatternSet. + // Specifies where in a web request to look for the RegexPatternSet . // // This member is required. FieldToMatch *FieldToMatch - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet (see GetRegexPatternSet), update a - // RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a - // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and - // delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). + // The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet (see GetRegexPatternSet ), update a + // RegexPatternSet (see UpdateRegexPatternSet ), insert a RegexPatternSet into a + // RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet ), and + // delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet ). // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on RegexPatternSet before inspecting a - // request for a match. You can only specify a single type of TextTransformation. - // CMD_LINE When you're concerned that attackers are injecting an operating system - // commandline command and using unusual formatting to disguise some or all of the - // command, use this option to perform the following transformations: - // - // * Delete the - // following characters: \ " ' ^ - // - // * Delete spaces before the following characters: - // / ( - // - // * Replace the following characters with a space: , ; - // - // * Replace multiple - // spaces with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on RegexPatternSet before + // inspecting a request for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system commandline command and using unusual formatting to disguise + // some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -1116,60 +938,56 @@ type RegexMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The RegexPatternSet specifies the regular expression (regex) pattern -// that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The RegexPatternSet specifies the regular expression (regex) +// pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t . You can then // configure AWS WAF to reject those requests. type RegexPatternSet struct { - // The identifier for the RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexMatchSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // The identifier for the RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet , update a RegexPatternSet , remove a + // RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS + // WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string // Specifies the regular expression (regex) patterns that you want AWS WAF to - // search for, such as B[a@]dB[o0]t. + // search for, such as B[a@]dB[o0]t . // // This member is required. RegexPatternStrings []string - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Returned by ListRegexPatternSets. Each RegexPatternSetSummary object -// includes the Name and RegexPatternSetId for one RegexPatternSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Returned by ListRegexPatternSets . Each RegexPatternSetSummary +// object includes the Name and RegexPatternSetId for one RegexPatternSet . type RegexPatternSetSummary struct { - // A friendly name or description of the RegexPatternSet. You can't change Name - // after you create a RegexPatternSet. + // A friendly name or description of the RegexPatternSet . You can't change Name + // after you create a RegexPatternSet . // // This member is required. Name *string - // The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get - // information about a RegexPatternSet, update a RegexPatternSet, remove a - // RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets. + // The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get + // information about a RegexPatternSet , update a RegexPatternSet , remove a + // RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS + // WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by + // ListRegexPatternSets . // // This member is required. RegexPatternSetId *string @@ -1177,24 +995,22 @@ type RegexPatternSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies -// whether to insert or delete a RegexPatternString and includes the settings for -// the RegexPatternString. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In an UpdateRegexPatternSet request, RegexPatternSetUpdate +// specifies whether to insert or delete a RegexPatternString and includes the +// settings for the RegexPatternString . type RegexPatternSetUpdate struct { - // Specifies whether to insert or delete a RegexPatternString. + // Specifies whether to insert or delete a RegexPatternString . // // This member is required. Action ChangeAction - // Specifies the regular expression (regex) pattern that you want AWS WAF to search - // for, such as B[a@]dB[o0]t. + // Specifies the regular expression (regex) pattern that you want AWS WAF to + // search for, such as B[a@]dB[o0]t . // // This member is required. RegexPatternString *string @@ -1202,118 +1018,106 @@ type RegexPatternSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet -// objects that identify the web requests that you want to allow, block, or count. -// For example, you might create a Rule that includes the following predicates: -// -// * -// An IPSet that causes AWS WAF to search for web requests that originate from the -// IP address 192.0.2.44 +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A combination of ByteMatchSet , IPSet , and/or +// SqlInjectionMatchSet objects that identify the web requests that you want to +// allow, block, or count. For example, you might create a Rule that includes the +// following predicates: +// - An IPSet that causes AWS WAF to search for web requests that originate from +// the IP address 192.0.2.44 +// - A ByteMatchSet that causes AWS WAF to search for web requests for which the +// value of the User-Agent header is BadBot . // -// * A ByteMatchSet that causes AWS WAF to search for web -// requests for which the value of the User-Agent header is BadBot. -// -// To match the -// settings in this Rule, a request must originate from 192.0.2.44 AND include a -// User-Agent header for which the value is BadBot. +// To match the settings in this Rule , a request must originate from 192.0.2.44 +// AND include a User-Agent header for which the value is BadBot . type Rule struct { - // The Predicates object contains one Predicate element for each ByteMatchSet, - // IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. + // The Predicates object contains one Predicate element for each ByteMatchSet , + // IPSet , or SqlInjectionMatchSet object that you want to include in a Rule . // // This member is required. Predicates []Predicate - // A unique identifier for a Rule. You use RuleId to get more information about a - // Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL - // or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF - // (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + // A unique identifier for a Rule . You use RuleId to get more information about a + // Rule (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a + // WebACL or delete a one from a WebACL (see UpdateWebACL ), or delete a Rule from + // AWS WAF (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string - // A friendly name or description for the metrics for this Rule. The name can + // A friendly name or description for the metrics for this Rule . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the Rule. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the Rule . MetricName *string - // The friendly name or description for the Rule. You can't change the name of a + // The friendly name or description for the Rule . You can't change the name of a // Rule after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A collection of predefined rules that you can add to a web ACL. Rule -// groups are subject to the following limits: -// -// * Three rule groups per account. -// You can request an increase to this limit by contacting customer support. -// -// * One -// rule group per web ACL. -// -// * Ten rules per rule group. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A collection of predefined rules that you can add to a web ACL. +// Rule groups are subject to the following limits: +// - Three rule groups per account. You can request an increase to this limit by +// contacting customer support. +// - One rule group per web ACL. +// - Ten rules per rule group. type RuleGroup struct { - // A unique identifier for a RuleGroup. You use RuleGroupId to get more information - // about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), - // insert a RuleGroup into a WebACL or delete a one from a WebACL (see - // UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). - // RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. + // A unique identifier for a RuleGroup . You use RuleGroupId to get more + // information about a RuleGroup (see GetRuleGroup ), update a RuleGroup (see + // UpdateRuleGroup ), insert a RuleGroup into a WebACL or delete a one from a + // WebACL (see UpdateWebACL ), or delete a RuleGroup from AWS WAF (see + // DeleteRuleGroup ). RuleGroupId is returned by CreateRuleGroup and by + // ListRuleGroups . // // This member is required. RuleGroupId *string - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . MetricName *string - // The friendly name or description for the RuleGroup. You can't change the name of - // a RuleGroup after you create it. + // The friendly name or description for the RuleGroup . You can't change the name + // of a RuleGroup after you create it. Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the friendly name or description of the -// RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the friendly name or description of +// the RuleGroup . type RuleGroupSummary struct { - // A friendly name or description of the RuleGroup. You can't change the name of a + // A friendly name or description of the RuleGroup . You can't change the name of a // RuleGroup after you create it. // // This member is required. Name *string - // A unique identifier for a RuleGroup. You use RuleGroupId to get more information - // about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), - // insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), - // or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is - // returned by CreateRuleGroup and by ListRuleGroups. + // A unique identifier for a RuleGroup . You use RuleGroupId to get more + // information about a RuleGroup (see GetRuleGroup ), update a RuleGroup (see + // UpdateRuleGroup ), insert a RuleGroup into a WebACL or delete one from a WebACL + // (see UpdateWebACL ), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup ). + // RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups . // // This member is required. RuleGroupId *string @@ -1321,25 +1125,23 @@ type RuleGroupSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies an ActivatedRule and indicates whether you want to add it -// to a RuleGroup or delete it from a RuleGroup. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies an ActivatedRule and indicates whether you want to +// add it to a RuleGroup or delete it from a RuleGroup . type RuleGroupUpdate struct { - // Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an - // ActivatedRule from a RuleGroup. + // Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an + // ActivatedRule from a RuleGroup . // // This member is required. Action ChangeAction - // The ActivatedRule object specifies a Rule that you want to insert or delete, the - // priority of the Rule in the WebACL, and the action that you want AWS WAF to take - // when a web request matches the Rule (ALLOW, BLOCK, or COUNT). + // The ActivatedRule object specifies a Rule that you want to insert or delete, + // the priority of the Rule in the WebACL , and the action that you want AWS WAF to + // take when a web request matches the Rule ( ALLOW , BLOCK , or COUNT ). // // This member is required. ActivatedRule *ActivatedRule @@ -1347,26 +1149,24 @@ type RuleGroupUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the friendly name or description of the -// Rule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the friendly name or description of +// the Rule . type RuleSummary struct { - // A friendly name or description of the Rule. You can't change the name of a Rule + // A friendly name or description of the Rule . You can't change the name of a Rule // after you create it. // // This member is required. Name *string - // A unique identifier for a Rule. You use RuleId to get more information about a - // Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL - // or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF - // (see DeleteRule). RuleId is returned by CreateRule and by ListRules. + // A unique identifier for a Rule . You use RuleId to get more information about a + // Rule (see GetRule ), update a Rule (see UpdateRule ), insert a Rule into a + // WebACL or delete one from a WebACL (see UpdateWebACL ), or delete a Rule from + // AWS WAF (see DeleteRule ). RuleId is returned by CreateRule and by ListRules . // // This member is required. RuleId *string @@ -1374,23 +1174,21 @@ type RuleSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies a Predicate (such as an IPSet) and indicates whether you -// want to add it to a Rule or delete it from a Rule. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies a Predicate (such as an IPSet ) and indicates whether +// you want to add it to a Rule or delete it from a Rule . type RuleUpdate struct { - // Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate - // from a Rule. + // Specify INSERT to add a Predicate to a Rule . Use DELETE to remove a Predicate + // from a Rule . // // This member is required. Action ChangeAction - // The ID of the Predicate (such as an IPSet) that you want to add to a Rule. + // The ID of the Predicate (such as an IPSet ) that you want to add to a Rule . // // This member is required. Predicate *Predicate @@ -1398,16 +1196,14 @@ type RuleUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The response from a GetSampledRequests request includes a -// SampledHTTPRequests complex type that appears as SampledRequests in the response -// syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web -// request that is returned by GetSampledRequests. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The response from a GetSampledRequests request includes a +// SampledHTTPRequests complex type that appears as SampledRequests in the +// response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for +// each web request that is returned by GetSampledRequests . type SampledHTTPRequest struct { // A complex type that contains detailed information about the request. @@ -1417,13 +1213,13 @@ type SampledHTTPRequest struct { // A value that indicates how one result in the response relates proportionally to // other results in the response. A result that has a weight of 2 represents - // roughly twice as many CloudFront web requests as a result that has a weight of - // 1. + // roughly twice as many CloudFront web requests as a result that has a weight of 1 + // . // // This member is required. Weight int64 - // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. + // The action for the Rule that the request matched: ALLOW , BLOCK , or COUNT . Action *string // This value is returned if the GetSampledRequests request specifies the ID of a @@ -1439,21 +1235,20 @@ type SampledHTTPRequest struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies a constraint on the size of a part of the web request. AWS -// WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression -// in the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that -// expression is true, the SizeConstraint is considered to match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies a constraint on the size of a part of the web request. +// AWS WAF uses the Size , ComparisonOperator , and FieldToMatch to build an +// expression in the form of " Size ComparisonOperator size in bytes of +// FieldToMatch ". If that expression is true, the SizeConstraint is considered to +// match. type SizeConstraint struct { // The type of comparison you want AWS WAF to perform. AWS WAF uses this in // combination with the provided Size and FieldToMatch to build an expression in - // the form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // the form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that // expression is true, the SizeConstraint is considered to match. EQ: Used to test // if the Size is equal to the size of the FieldToMatch NE: Used to test if the // Size is not equal to the size of the FieldToMatch LE: Used to test if the Size @@ -1471,84 +1266,54 @@ type SizeConstraint struct { FieldToMatch *FieldToMatch // The size in bytes that you want AWS WAF to compare against the size of the - // specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator - // and FieldToMatch to build an expression in the form of "SizeComparisonOperator - // size in bytes of FieldToMatch". If that expression is true, the SizeConstraint - // is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 - // GB). If you specify URI for the value of Type, the / in the URI counts as one - // character. For example, the URI /logo.jpg is nine characters long. + // specified FieldToMatch . AWS WAF uses this in combination with + // ComparisonOperator and FieldToMatch to build an expression in the form of " Size + // ComparisonOperator size in bytes of FieldToMatch ". If that expression is true, + // the SizeConstraint is considered to match. Valid values for size are 0 - + // 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type , the / + // in the URI counts as one character. For example, the URI /logo.jpg is nine + // characters long. // // This member is required. Size int64 - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. Note that if - // you choose BODY for the value of Type, you must choose NONE for - // TextTransformation because CloudFront forwards only the first 8192 bytes for - // inspection. NONE Specify NONE if you don't want to perform any text - // transformations. CMD_LINE When you're concerned that attackers are injecting an - // operating system command line command and using unusual formatting to disguise - // some or all of the command, use this option to perform the following + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. Note that if you choose BODY for the value of Type , you + // must choose NONE for TextTransformation because CloudFront forwards only the + // first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform + // any text transformations. CMD_LINE When you're concerned that attackers are + // injecting an operating system command line command and using unusual formatting + // to disguise some or all of the command, use this option to perform the following // transformations: - // - // * Delete the following characters: \ " ' ^ - // - // * Delete spaces - // before the following characters: / ( - // - // * Replace the following characters with a - // space: , ; - // - // * Replace multiple spaces with one space - // - // * Convert uppercase - // letters (A-Z) to lowercase (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to - // replace the following characters with a space character (decimal 32): - // - // * \f, - // formfeed, decimal 12 - // - // * \t, tab, decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, - // carriage return, decimal 13 - // - // * \v, vertical tab, decimal 11 - // - // * non-breaking - // space, decimal 160 - // - // COMPRESS_WHITE_SPACE also replaces multiple spaces with one - // space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters - // with unencoded characters. HTML_ENTITY_DECODE performs the following - // operations: - // - // * Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; - // with a non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less - // than" symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 + // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. + // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with + // unencoded characters. HTML_ENTITY_DECODE performs the following operations: + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. // // This member is required. TextTransformation TextTransformation @@ -1556,25 +1321,23 @@ type SizeConstraint struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains SizeConstraint objects, which specify -// the parts of web requests that you want AWS WAF to inspect the size of. If a -// SizeConstraintSet contains more than one SizeConstraint object, a request only -// needs to match one constraint to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains SizeConstraint objects, which +// specify the parts of web requests that you want AWS WAF to inspect the size of. +// If a SizeConstraintSet contains more than one SizeConstraint object, a request +// only needs to match one constraint to be considered a match. type SizeConstraintSet struct { - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get - // information about a SizeConstraintSet (see GetSizeConstraintSet), update a - // SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into - // a Rule or delete one from a Rule (see UpdateRule), and delete a - // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). + // A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to + // get information about a SizeConstraintSet (see GetSizeConstraintSet ), update a + // SizeConstraintSet (see UpdateSizeConstraintSet ), insert a SizeConstraintSet + // into a Rule or delete one from a Rule (see UpdateRule ), and delete a + // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet ). // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -1584,33 +1347,31 @@ type SizeConstraintSet struct { // This member is required. SizeConstraints []SizeConstraint - // The name, if any, of the SizeConstraintSet. + // The name, if any, of the SizeConstraintSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of a SizeConstraintSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of a SizeConstraintSet . type SizeConstraintSetSummary struct { - // The name of the SizeConstraintSet, if any. + // The name of the SizeConstraintSet , if any. // // This member is required. Name *string - // A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get - // information about a SizeConstraintSet (see GetSizeConstraintSet), update a - // SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into - // a Rule or delete one from a Rule (see UpdateRule), and delete a - // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). + // A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to + // get information about a SizeConstraintSet (see GetSizeConstraintSet ), update a + // SizeConstraintSet (see UpdateSizeConstraintSet ), insert a SizeConstraintSet + // into a Rule or delete one from a Rule (see UpdateRule ), and delete a + // SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet ). // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets. + // ListSizeConstraintSets . // // This member is required. SizeConstraintSetId *string @@ -1618,26 +1379,24 @@ type SizeConstraintSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect the +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect the // size of and indicates whether you want to add the specification to a -// SizeConstraintSet or delete it from a SizeConstraintSet. +// SizeConstraintSet or delete it from a SizeConstraintSet . type SizeConstraintSetUpdate struct { - // Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use - // DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. + // Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet . Use + // DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet . // // This member is required. Action ChangeAction // Specifies a constraint on the size of a part of the web request. AWS WAF uses - // the Size, ComparisonOperator, and FieldToMatch to build an expression in the - // form of "SizeComparisonOperator size in bytes of FieldToMatch". If that + // the Size , ComparisonOperator , and FieldToMatch to build an expression in the + // form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that // expression is true, the SizeConstraint is considered to match. // // This member is required. @@ -1646,27 +1405,25 @@ type SizeConstraintSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains SqlInjectionMatchTuple objects, which -// specify the parts of web requests that you want AWS WAF to inspect for snippets -// of malicious SQL code and, if you want AWS WAF to inspect a header, the name of -// the header. If a SqlInjectionMatchSet contains more than one +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains SqlInjectionMatchTuple objects, +// which specify the parts of web requests that you want AWS WAF to inspect for +// snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the +// name of the header. If a SqlInjectionMatchSet contains more than one // SqlInjectionMatchTuple object, a request needs to include snippets of SQL code // in only one of the specified parts of the request to be considered a match. type SqlInjectionMatchSet struct { - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId - // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), - // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a - // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and - // delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). - // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId + // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet ), + // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ), insert a + // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule ), + // and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet + // ). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -1677,33 +1434,31 @@ type SqlInjectionMatchSet struct { // This member is required. SqlInjectionMatchTuples []SqlInjectionMatchTuple - // The name, if any, of the SqlInjectionMatchSet. + // The name, if any, of the SqlInjectionMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of a SqlInjectionMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of a SqlInjectionMatchSet . type SqlInjectionMatchSetSummary struct { - // The name of the SqlInjectionMatchSet, if any, specified by Id. + // The name of the SqlInjectionMatchSet , if any, specified by Id . // // This member is required. Name *string - // A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId - // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), - // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a - // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and - // delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). - // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by - // ListSqlInjectionMatchSets. + // A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId + // to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet ), + // update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet ), insert a + // SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule ), + // and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet + // ). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by + // ListSqlInjectionMatchSets . // // This member is required. SqlInjectionMatchSetId *string @@ -1711,20 +1466,18 @@ type SqlInjectionMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect for +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect for // snippets of malicious SQL code and indicates whether you want to add the -// specification to a SqlInjectionMatchSet or delete it from a -// SqlInjectionMatchSet. +// specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet +// . type SqlInjectionMatchSetUpdate struct { - // Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. - // Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. + // Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet . + // Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet . // // This member is required. Action ChangeAction @@ -1739,15 +1492,13 @@ type SqlInjectionMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want AWS WAF to inspect -// for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, -// the name of the header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want AWS WAF to +// inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a +// header, the name of the header. type SqlInjectionMatchTuple struct { // Specifies where in a web request to look for snippets of malicious SQL code. @@ -1755,72 +1506,41 @@ type SqlInjectionMatchTuple struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation @@ -1828,31 +1548,29 @@ type SqlInjectionMatchTuple struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A summary of the rule groups you are subscribed to. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A summary of the rule groups you are subscribed to. type SubscribedRuleGroupSummary struct { - // A friendly name or description for the metrics for this RuleGroup. The name can + // A friendly name or description for the metrics for this RuleGroup . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for // AWS WAF, including "All" and "Default_Action." You can't change the name of the - // metric after you create the RuleGroup. + // metric after you create the RuleGroup . // // This member is required. MetricName *string - // A friendly name or description of the RuleGroup. You can't change the name of a + // A friendly name or description of the RuleGroup . You can't change the name of a // RuleGroup after you create it. // // This member is required. Name *string - // A unique identifier for a RuleGroup. + // A unique identifier for a RuleGroup . // // This member is required. RuleGroupId *string @@ -1860,16 +1578,14 @@ type SubscribedRuleGroupSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A tag associated with an AWS resource. Tags are key:value pairs that -// you can use to categorize and manage your resources, for purposes like billing. -// For example, you might set the tag key to "customer" and the value to the -// customer name or ID. You can specify one or more tags to add to each AWS +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A tag associated with an AWS resource. Tags are key:value pairs +// that you can use to categorize and manage your resources, for purposes like +// billing. For example, you might set the tag key to "customer" and the value to +// the customer name or ID. You can specify one or more tags to add to each AWS // resource, up to 50 tags for a resource. Tagging is only available through the // API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic // console. You can tag the AWS resources that you manage through AWS WAF Classic: @@ -1889,13 +1605,11 @@ type Tag struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Information for a tag associated with an AWS resource. Tags are +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Information for a tag associated with an AWS resource. Tags are // key:value pairs that you can use to categorize and manage your resources, for // purposes like billing. For example, you might set the tag key to "customer" and // the value to the customer name or ID. You can specify one or more tags to add to @@ -1914,39 +1628,37 @@ type TagInfoForResource struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. In a GetSampledRequests request, the StartTime and EndTime objects -// specify the time range for which you want AWS WAF to return a sample of web -// requests. You must specify the times in Coordinated Universal Time (UTC) format. -// UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". -// In a GetSampledRequests response, the StartTime and EndTime objects specify the -// time range for which AWS WAF actually returned a sample of web requests. AWS WAF -// gets the specified number of requests from among the first 5,000 requests that -// your AWS resource receives during the specified time period. If your resource -// receives more than 5,000 requests during that period, AWS WAF stops sampling -// after the 5,000th request. In that case, EndTime is the time that AWS WAF -// received the 5,000th request. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. In a GetSampledRequests request, the StartTime and EndTime +// objects specify the time range for which you want AWS WAF to return a sample of +// web requests. You must specify the times in Coordinated Universal Time (UTC) +// format. UTC format includes the special designator, Z . For example, +// "2016-09-27T14:50Z" . In a GetSampledRequests response, the StartTime and +// EndTime objects specify the time range for which AWS WAF actually returned a +// sample of web requests. AWS WAF gets the specified number of requests from among +// the first 5,000 requests that your AWS resource receives during the specified +// time period. If your resource receives more than 5,000 requests during that +// period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime +// is the time that AWS WAF received the 5,000th request. type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a // sample of the requests that your AWS resource received. You must specify the // date and time in Coordinated Universal Time (UTC) format. UTC format includes - // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. + // the special designator, Z . For example, "2016-09-27T14:50Z" . You can specify + // any time range in the previous three hours. // // This member is required. EndTime *time.Time - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your AWS resource received. You must specify the - // date and time in Coordinated Universal Time (UTC) format. UTC format includes - // the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any - // time range in the previous three hours. + // The beginning of the time range from which you want GetSampledRequests to + // return a sample of the requests that your AWS resource received. You must + // specify the date and time in Coordinated Universal Time (UTC) format. UTC format + // includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can + // specify any time range in the previous three hours. // // This member is required. StartTime *time.Time @@ -1954,31 +1666,25 @@ type TimeWindow struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. For the action that is associated with a rule in a WebACL, specifies -// the action that you want AWS WAF to perform when a web request matches all of -// the conditions in a rule. For the default action in a WebACL, specifies the -// action that you want AWS WAF to take when a web request doesn't match all of the -// conditions in any of the rules in a WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. For the action that is associated with a rule in a WebACL , +// specifies the action that you want AWS WAF to perform when a web request matches +// all of the conditions in a rule. For the default action in a WebACL , specifies +// the action that you want AWS WAF to take when a web request doesn't match all of +// the conditions in any of the rules in a WebACL . type WafAction struct { - // Specifies how you want AWS WAF to respond to requests that match the settings in - // a Rule. Valid settings include the following: - // - // * ALLOW: AWS WAF allows - // requests - // - // * BLOCK: AWS WAF blocks requests - // - // * COUNT: AWS WAF increments a - // counter of the requests that match all of the conditions in the rule. AWS WAF - // then continues to inspect the web request based on the remaining rules in the - // web ACL. You can't specify COUNT for the default action for a WebACL. + // Specifies how you want AWS WAF to respond to requests that match the settings + // in a Rule . Valid settings include the following: + // - ALLOW : AWS WAF allows requests + // - BLOCK : AWS WAF blocks requests + // - COUNT : AWS WAF increments a counter of the requests that match all of the + // conditions in the rule. AWS WAF then continues to inspect the web request based + // on the remaining rules in the web ACL. You can't specify COUNT for the default + // action for a WebACL . // // This member is required. Type WafActionType @@ -1986,18 +1692,16 @@ type WafAction struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The action to take if any rule within the RuleGroup matches a +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The action to take if any rule within the RuleGroup matches a // request. type WafOverrideAction struct { - // COUNT overrides the action specified by the individual rule within a RuleGroup . - // If set to NONE, the rule's action will take place. + // COUNT overrides the action specified by the individual rule within a RuleGroup + // . If set to NONE , the rule's action will take place. // // This member is required. Type WafOverrideActionType @@ -2005,20 +1709,18 @@ type WafOverrideAction struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the Rules that identify the requests that you want to -// allow, block, or count. In a WebACL, you also specify a default action (ALLOW or -// BLOCK), and the action for each Rule that you add to a WebACL, for example, +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the Rules that identify the requests that you want to +// allow, block, or count. In a WebACL , you also specify a default action ( ALLOW +// or BLOCK ), and the action for each Rule that you add to a WebACL , for example, // block requests from specified IP addresses or block requests from specified // referrers. You also associate the WebACL with a CloudFront distribution to // identify the requests that you want AWS WAF to filter. If you add more than one -// Rule to a WebACL, a request needs to match only one of the specifications to be -// allowed, blocked, or counted. For more information, see UpdateWebACL. +// Rule to a WebACL , a request needs to match only one of the specifications to be +// allowed, blocked, or counted. For more information, see UpdateWebACL . type WebACL struct { // The action to perform if none of the Rules contained in the WebACL match. The @@ -2027,28 +1729,28 @@ type WebACL struct { // This member is required. DefaultAction *WafAction - // An array that contains the action for each Rule in a WebACL, the priority of the - // Rule, and the ID of the Rule. + // An array that contains the action for each Rule in a WebACL , the priority of + // the Rule , and the ID of the Rule . // // This member is required. Rules []ActivatedRule - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL - // from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by - // ListWebACLs. + // A unique identifier for a WebACL . You use WebACLId to get information about a + // WebACL (see GetWebACL ), update a WebACL (see UpdateWebACL ), and delete a + // WebACL from AWS WAF (see DeleteWebACL ). WebACLId is returned by CreateWebACL + // and by ListWebACLs . // // This member is required. WebACLId *string - // A friendly name or description for the metrics for this WebACL. The name can + // A friendly name or description for the metrics for this WebACL . The name can // contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 // and minimum length one. It can't contain whitespace or metric names reserved for - // AWS WAF, including "All" and "Default_Action." You can't change MetricName after - // you create the WebACL. + // AWS WAF, including "All" and "Default_Action." You can't change MetricName + // after you create the WebACL . MetricName *string - // A friendly name or description of the WebACL. You can't change the name of a + // A friendly name or description of the WebACL . You can't change the name of a // WebACL after you create it. Name *string @@ -2058,25 +1760,24 @@ type WebACL struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Contains the identifier and the name or description of the WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Contains the identifier and the name or description of the +// WebACL . type WebACLSummary struct { - // A friendly name or description of the WebACL. You can't change the name of a + // A friendly name or description of the WebACL . You can't change the name of a // WebACL after you create it. // // This member is required. Name *string - // A unique identifier for a WebACL. You use WebACLId to get information about a - // WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL - // from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by - // ListWebACLs. + // A unique identifier for a WebACL . You use WebACLId to get information about a + // WebACL (see GetWebACL ), update a WebACL (see UpdateWebACL ), and delete a + // WebACL from AWS WAF (see DeleteWebACL ). WebACLId is returned by CreateWebACL + // and by ListWebACLs . // // This member is required. WebACLId *string @@ -2084,25 +1785,23 @@ type WebACLSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies whether to insert a Rule into or delete a Rule from a -// WebACL. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies whether to insert a Rule into or delete a Rule from a +// WebACL . type WebACLUpdate struct { - // Specifies whether to insert a Rule into or delete a Rule from a WebACL. + // Specifies whether to insert a Rule into or delete a Rule from a WebACL . // // This member is required. Action ChangeAction // The ActivatedRule object in an UpdateWebACL request specifies a Rule that you - // want to insert or delete, the priority of the Rule in the WebACL, and the action - // that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, - // or COUNT). + // want to insert or delete, the priority of the Rule in the WebACL , and the + // action that you want AWS WAF to take when a web request matches the Rule ( ALLOW + // , BLOCK , or COUNT ). // // This member is required. ActivatedRule *ActivatedRule @@ -2110,26 +1809,24 @@ type WebACLUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. A complex type that contains XssMatchTuple objects, which specify -// the parts of web requests that you want AWS WAF to inspect for cross-site -// scripting attacks and, if you want AWS WAF to inspect a header, the name of the -// header. If a XssMatchSet contains more than one XssMatchTuple object, a request -// needs to include cross-site scripting attacks in only one of the specified parts -// of the request to be considered a match. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. A complex type that contains XssMatchTuple objects, which +// specify the parts of web requests that you want AWS WAF to inspect for +// cross-site scripting attacks and, if you want AWS WAF to inspect a header, the +// name of the header. If a XssMatchSet contains more than one XssMatchTuple +// object, a request needs to include cross-site scripting attacks in only one of +// the specified parts of the request to be considered a match. type XssMatchSet struct { - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information - // about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see - // UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete an XssMatchSet from AWS WAF (see - // DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by - // ListXssMatchSets. + // A unique identifier for an XssMatchSet . You use XssMatchSetId to get + // information about an XssMatchSet (see GetXssMatchSet ), update an XssMatchSet + // (see UpdateXssMatchSet ), insert an XssMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete an XssMatchSet from AWS WAF (see + // DeleteXssMatchSet ). XssMatchSetId is returned by CreateXssMatchSet and by + // ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -2140,32 +1837,30 @@ type XssMatchSet struct { // This member is required. XssMatchTuples []XssMatchTuple - // The name, if any, of the XssMatchSet. + // The name, if any, of the XssMatchSet . Name *string noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. The Id and Name of an XssMatchSet. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. The Id and Name of an XssMatchSet . type XssMatchSetSummary struct { - // The name of the XssMatchSet, if any, specified by Id. + // The name of the XssMatchSet , if any, specified by Id . // // This member is required. Name *string - // A unique identifier for an XssMatchSet. You use XssMatchSetId to get information - // about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see - // UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule - // (see UpdateRule), and delete an XssMatchSet from AWS WAF (see - // DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by - // ListXssMatchSets. + // A unique identifier for an XssMatchSet . You use XssMatchSetId to get + // information about a XssMatchSet (see GetXssMatchSet ), update an XssMatchSet + // (see UpdateXssMatchSet ), insert an XssMatchSet into a Rule or delete one from + // a Rule (see UpdateRule ), and delete an XssMatchSet from AWS WAF (see + // DeleteXssMatchSet ). XssMatchSetId is returned by CreateXssMatchSet and by + // ListXssMatchSets . // // This member is required. XssMatchSetId *string @@ -2173,19 +1868,17 @@ type XssMatchSetSummary struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want to inspect for +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want to inspect for // cross-site scripting attacks and indicates whether you want to add the -// specification to an XssMatchSet or delete it from an XssMatchSet. +// specification to an XssMatchSet or delete it from an XssMatchSet . type XssMatchSetUpdate struct { - // Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to - // remove an XssMatchSetUpdate from an XssMatchSet. + // Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet . Use DELETE to + // remove an XssMatchSetUpdate from an XssMatchSet . // // This member is required. Action ChangeAction @@ -2200,15 +1893,13 @@ type XssMatchSetUpdate struct { noSmithyDocumentSerde } -// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic -// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) +// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) // in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With -// the latest version, AWS WAF has a single set of endpoints for regional and -// global use. Specifies the part of a web request that you want AWS WAF to inspect -// for cross-site scripting attacks and, if you want AWS WAF to inspect a header, -// the name of the header. +// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . With the latest version, AWS WAF has a single set of endpoints for regional +// and global use. Specifies the part of a web request that you want AWS WAF to +// inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a +// header, the name of the header. type XssMatchTuple struct { // Specifies where in a web request to look for cross-site scripting attacks. @@ -2216,72 +1907,41 @@ type XssMatchTuple struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass AWS WAF. If you specify a transformation, - // AWS WAF performs the transformation on FieldToMatch before inspecting it for a - // match. You can only specify a single type of TextTransformation. CMD_LINE When - // you're concerned that attackers are injecting an operating system command line - // command and using unusual formatting to disguise some or all of the command, use - // this option to perform the following transformations: - // - // * Delete the following - // characters: \ " ' ^ - // - // * Delete spaces before the following characters: / ( - // - // * - // Replace the following characters with a space: , ; - // - // * Replace multiple spaces - // with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE Use this option to replace the following characters - // with a space character (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, - // decimal 9 - // - // * \n, newline, decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, - // vertical tab, decimal 11 - // - // * non-breaking space, decimal - // 160 - // + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass AWS WAF. If you specify a + // transformation, AWS WAF performs the transformation on FieldToMatch before + // inspecting it for a match. You can only specify a single type of + // TextTransformation. CMD_LINE When you're concerned that attackers are injecting + // an operating system command line command and using unusual formatting to + // disguise some or all of the command, use this option to perform the following + // transformations: + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE Use this option to replace the following characters with a + // space character (decimal 32): + // - \f, formfeed, decimal 12 + // - \t, tab, decimal 9 + // - \n, newline, decimal 10 + // - \r, carriage return, decimal 13 + // - \v, vertical tab, decimal 11 + // - non-breaking space, decimal 160 // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: - // - // * - // Replaces (ampersand)quot; with " - // - // * Replaces (ampersand)nbsp; with a - // non-breaking space, decimal 160 - // - // * Replaces (ampersand)lt; with a "less than" - // symbol - // - // * Replaces (ampersand)gt; with > - // - // * Replaces characters that are - // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding - // characters - // - // * Replaces characters that are represented in decimal format, - // (ampersand)#nnnn;, with the corresponding characters - // - // LOWERCASE Use this option - // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this - // option to decode a URL-encoded value. NONE Specify NONE if you don't want to - // perform any text transformations. + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase + // (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify + // NONE if you don't want to perform any text transformations. // // This member is required. TextTransformation TextTransformation diff --git a/service/wafv2/api_client.go b/service/wafv2/api_client.go index 90e965435db..22d8dccb8c4 100644 --- a/service/wafv2/api_client.go +++ b/service/wafv2/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/wafv2/api_op_AssociateWebACL.go b/service/wafv2/api_op_AssociateWebACL.go index abc479158fe..6636d4e4eff 100644 --- a/service/wafv2/api_op_AssociateWebACL.go +++ b/service/wafv2/api_op_AssociateWebACL.go @@ -15,10 +15,9 @@ import ( // Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, // or an App Runner service. For Amazon CloudFront, don't use this call. Instead, // use your CloudFront distribution configuration. To associate a web ACL, in the -// CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource -// Name (ARN) of the web ACL. For information, see UpdateDistribution -// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html). -// When you make changes to web ACLs or web ACL components, like rules and rule +// CloudFront call UpdateDistribution , set the web ACL ID to the Amazon Resource +// Name (ARN) of the web ACL. For information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) +// . When you make changes to web ACLs or web ACL components, like rules and rule // groups, WAF propagates the changes everywhere that the web ACL and its // components are stored and used. Your changes are applied within seconds, but // there might be a brief period of inconsistency when the changes have arrived in @@ -49,25 +48,17 @@ type AssociateWebACLInput struct { // The Amazon Resource Name (ARN) of the resource to associate with the web ACL. // The ARN must be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load - // Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway REST API: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name - // - // * For an AppSync - // GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId - // - // * For an - // Amazon Cognito user pool: - // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id - // - // * For an App Runner - // service: - // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id + // - For an Amazon API Gateway REST API: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an AppSync GraphQL API: + // arn:aws:appsync:region:account-id:apis/GraphQLApiId + // - For an Amazon Cognito user pool: + // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id + // - For an App Runner service: + // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_CheckCapacity.go b/service/wafv2/api_op_CheckCapacity.go index 24b62f3415c..053d7729311 100644 --- a/service/wafv2/api_op_CheckCapacity.go +++ b/service/wafv2/api_op_CheckCapacity.go @@ -13,13 +13,13 @@ import ( // Returns the web ACL capacity unit (WCU) requirements for a specified scope and // set of rules. You can use this to check the capacity requirements for the rules -// you want to use in a RuleGroup or WebACL. WAF uses WCUs to calculate and control -// the operating resources that are used to run your rules, rule groups, and web -// ACLs. WAF calculates capacity differently for each rule type, to reflect the -// relative cost of each rule. Simple rules that cost little to run use fewer WCUs -// than more complex rules that use more processing power. Rule group capacity is -// fixed at creation, which helps users plan their web ACL WCU usage when they use -// a rule group. The WCU limit for web ACLs is 1,500. +// you want to use in a RuleGroup or WebACL . WAF uses WCUs to calculate and +// control the operating resources that are used to run your rules, rule groups, +// and web ACLs. WAF calculates capacity differently for each rule type, to reflect +// the relative cost of each rule. Simple rules that cost little to run use fewer +// WCUs than more complex rules that use more processing power. Rule group capacity +// is fixed at creation, which helps users plan their web ACL WCU usage when they +// use a rule group. The WCU limit for web ACLs is 1,500. func (c *Client) CheckCapacity(ctx context.Context, params *CheckCapacityInput, optFns ...func(*Options)) (*CheckCapacityOutput, error) { if params == nil { params = &CheckCapacityInput{} @@ -47,12 +47,9 @@ type CheckCapacityInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_CreateIPSet.go b/service/wafv2/api_op_CreateIPSet.go index 38822c0bd51..2eb7cbc43c4 100644 --- a/service/wafv2/api_op_CreateIPSet.go +++ b/service/wafv2/api_op_CreateIPSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an IPSet, which you use to identify web requests that originate from +// Creates an IPSet , which you use to identify web requests that originate from // specific IP addresses or ranges of IP addresses. For example, if you're // receiving a lot of requests from a ranges of IP addresses, you can configure WAF // to block them using an IPSet that lists those IP addresses. @@ -35,46 +35,31 @@ type CreateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses. All addresses must be specified using Classless Inter-Domain // Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for - // /0. Example address strings: - // - // * To configure WAF to allow, block, or count - // requests that originated from the IP address 192.0.2.44, specify - // 192.0.2.44/32. - // - // * To configure WAF to allow, block, or count requests that - // originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify - // 192.0.2.0/24. - // - // * To configure WAF to allow, block, or count requests that - // originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure WAF to allow, - // block, or count requests that originated from IP addresses - // 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Example JSON - // Addresses specifications: - // - // * Empty array: "Addresses": [] - // - // * Array with one - // address: "Addresses": ["192.0.2.44/32"] - // - // * Array with three addresses: - // "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] - // - // * INVALID - // specification: "Addresses": [""] INVALID + // /0 . Example address strings: + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 192.0.2.44, specify 192.0.2.44/32 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . Example JSON Addresses specifications: + // - Empty array: "Addresses": [] + // - Array with one address: "Addresses": ["192.0.2.44/32"] + // - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", + // "192.0.0.0/16"] + // - INVALID specification: "Addresses": [""] INVALID // // This member is required. Addresses []string - // The version of the IP addresses, either IPV4 or IPV6. + // The version of the IP addresses, either IPV4 or IPV6 . // // This member is required. IPAddressVersion types.IPAddressVersion @@ -90,12 +75,9 @@ type CreateIPSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -111,10 +93,10 @@ type CreateIPSetInput struct { type CreateIPSetOutput struct { - // High-level information about an IPSet, returned by operations like create and + // High-level information about an IPSet , returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and - // manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to - // use the address set in a Rule. + // manage an IPSet , and the ARN, that you provide to the IPSetReferenceStatement + // to use the address set in a Rule . Summary *types.IPSetSummary // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_CreateRegexPatternSet.go b/service/wafv2/api_op_CreateRegexPatternSet.go index 1b2e606a5f2..7cc74e9e073 100644 --- a/service/wafv2/api_op_CreateRegexPatternSet.go +++ b/service/wafv2/api_op_CreateRegexPatternSet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a RegexPatternSet, which you reference in a -// RegexPatternSetReferenceStatement, to have WAF inspect a web request component +// Creates a RegexPatternSet , which you reference in a +// RegexPatternSetReferenceStatement , to have WAF inspect a web request component // for the specified patterns. func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexPatternSetInput, optFns ...func(*Options)) (*CreateRegexPatternSetOutput, error) { if params == nil { @@ -46,12 +46,9 @@ type CreateRegexPatternSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -67,10 +64,10 @@ type CreateRegexPatternSetInput struct { type CreateRegexPatternSetOutput struct { - // High-level information about a RegexPatternSet, returned by operations like + // High-level information about a RegexPatternSet , returned by operations like // create and list. This provides information like the ID, that you can use to - // retrieve and manage a RegexPatternSet, and the ARN, that you provide to the - // RegexPatternSetReferenceStatement to use the pattern set in a Rule. + // retrieve and manage a RegexPatternSet , and the ARN, that you provide to the + // RegexPatternSetReferenceStatement to use the pattern set in a Rule . Summary *types.RegexPatternSetSummary // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_CreateRuleGroup.go b/service/wafv2/api_op_CreateRuleGroup.go index c2f66eea19c..b4d85eaf6d3 100644 --- a/service/wafv2/api_op_CreateRuleGroup.go +++ b/service/wafv2/api_op_CreateRuleGroup.go @@ -13,9 +13,9 @@ import ( // Creates a RuleGroup per the specifications provided. A rule group defines a // collection of rules to inspect and control web requests that you can use in a -// WebACL. When you create a rule group, you define an immutable capacity limit. If -// you update a rule group, you must stay within the capacity. This allows others -// to reuse the rule group with confidence in its capacity requirements. +// WebACL . When you create a rule group, you define an immutable capacity limit. +// If you update a rule group, you must stay within the capacity. This allows +// others to reuse the rule group with confidence in its capacity requirements. func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) { if params == nil { params = &CreateRuleGroupInput{} @@ -36,7 +36,7 @@ type CreateRuleGroupInput struct { // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, WAF enforces this limit. You - // can check the capacity for a set of rules using CheckCapacity. WAF uses WCUs to + // can check the capacity for a set of rules using CheckCapacity . WAF uses WCUs to // calculate and control the operating resources that are used to run your rules, // rule groups, and web ACLs. WAF calculates capacity differently for each rule // type, to reflect the relative cost of each rule. Simple rules that cost little @@ -47,8 +47,8 @@ type CreateRuleGroupInput struct { // This member is required. Capacity int64 - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. // // This member is required. Name *string @@ -58,12 +58,9 @@ type CreateRuleGroupInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -77,15 +74,12 @@ type CreateRuleGroupInput struct { // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see - // Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. @@ -104,10 +98,10 @@ type CreateRuleGroupInput struct { type CreateRuleGroupOutput struct { - // High-level information about a RuleGroup, returned by operations like create and - // list. This provides information like the ID, that you can use to retrieve and - // manage a RuleGroup, and the ARN, that you provide to the - // RuleGroupReferenceStatement to use the rule group in a Rule. + // High-level information about a RuleGroup , returned by operations like create + // and list. This provides information like the ID, that you can use to retrieve + // and manage a RuleGroup , and the ARN, that you provide to the + // RuleGroupReferenceStatement to use the rule group in a Rule . Summary *types.RuleGroupSummary // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_CreateWebACL.go b/service/wafv2/api_op_CreateWebACL.go index 5306b58b28a..8493cd9e2a5 100644 --- a/service/wafv2/api_op_CreateWebACL.go +++ b/service/wafv2/api_op_CreateWebACL.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a WebACL per the specifications provided. A web ACL defines a collection -// of rules to use to inspect and control web requests. Each rule has an action -// defined (allow, block, or count) for requests that match the statement of the -// rule. In the web ACL, you assign a default action to take (allow, block) for any -// request that does not match any of the rules. The rules in a web ACL can be a -// combination of the types Rule, RuleGroup, and managed rule group. You can +// Creates a WebACL per the specifications provided. A web ACL defines a +// collection of rules to use to inspect and control web requests. Each rule has an +// action defined (allow, block, or count) for requests that match the statement of +// the rule. In the web ACL, you assign a default action to take (allow, block) for +// any request that does not match any of the rules. The rules in a web ACL can be +// a combination of the types Rule , RuleGroup , and managed rule group. You can // associate a web ACL with one or more Amazon Web Services resources to protect. // The resources can be an Amazon CloudFront distribution, an Amazon API Gateway // REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito @@ -54,12 +54,9 @@ type CreateWebACLInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -71,27 +68,24 @@ type CreateWebACLInput struct { // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. If you don't specify this, WAF uses its - // default settings for CaptchaConfig. + // default settings for CaptchaConfig . CaptchaConfig *types.CaptchaConfig // Specifies how WAF should handle challenge evaluations for rules that don't have // their own ChallengeConfig settings. If you don't specify this, WAF uses its - // default settings for ChallengeConfig. + // default settings for ChallengeConfig . ChallengeConfig *types.ChallengeConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and - // responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. @@ -121,10 +115,10 @@ type CreateWebACLInput struct { type CreateWebACLOutput struct { - // High-level information about a WebACL, returned by operations like create and + // High-level information about a WebACL , returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and - // manage a WebACL, and the ARN, that you provide to operations like - // AssociateWebACL. + // manage a WebACL , and the ARN, that you provide to operations like + // AssociateWebACL . Summary *types.WebACLSummary // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go b/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go index d4346eb2115..afe4cd286ca 100644 --- a/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go +++ b/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go @@ -12,7 +12,7 @@ import ( // Deletes all rule groups that are managed by Firewall Manager for the specified // web ACL. You can only use this if ManagedByFirewallManager is false in the -// specified WebACL. +// specified WebACL . func (c *Client) DeleteFirewallManagerRuleGroups(ctx context.Context, params *DeleteFirewallManagerRuleGroupsInput, optFns ...func(*Options)) (*DeleteFirewallManagerRuleGroupsOutput, error) { if params == nil { params = &DeleteFirewallManagerRuleGroupsInput{} @@ -38,10 +38,10 @@ type DeleteFirewallManagerRuleGroupsInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. WebACLLockToken *string @@ -54,10 +54,10 @@ type DeleteFirewallManagerRuleGroupsOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. NextWebACLLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_DeleteIPSet.go b/service/wafv2/api_op_DeleteIPSet.go index ce8febd1626..a19cfcbae06 100644 --- a/service/wafv2/api_op_DeleteIPSet.go +++ b/service/wafv2/api_op_DeleteIPSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified IPSet. +// Deletes the specified IPSet . func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { params = &DeleteIPSetInput{} @@ -38,10 +38,10 @@ type DeleteIPSetInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -57,12 +57,9 @@ type DeleteIPSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_DeleteLoggingConfiguration.go b/service/wafv2/api_op_DeleteLoggingConfiguration.go index ebbcfb472cd..1d5b6d7ddcf 100644 --- a/service/wafv2/api_op_DeleteLoggingConfiguration.go +++ b/service/wafv2/api_op_DeleteLoggingConfiguration.go @@ -29,7 +29,7 @@ func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteL type DeleteLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_DeletePermissionPolicy.go b/service/wafv2/api_op_DeletePermissionPolicy.go index c337b97999c..c1e2e12a3af 100644 --- a/service/wafv2/api_op_DeletePermissionPolicy.go +++ b/service/wafv2/api_op_DeletePermissionPolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently deletes an IAM policy from the specified rule group. You must be the -// owner of the rule group to perform this operation. +// Permanently deletes an IAM policy from the specified rule group. You must be +// the owner of the rule group to perform this operation. func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error) { if params == nil { params = &DeletePermissionPolicyInput{} diff --git a/service/wafv2/api_op_DeleteRegexPatternSet.go b/service/wafv2/api_op_DeleteRegexPatternSet.go index 29bd780993f..f1ee9dfe32a 100644 --- a/service/wafv2/api_op_DeleteRegexPatternSet.go +++ b/service/wafv2/api_op_DeleteRegexPatternSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified RegexPatternSet. +// Deletes the specified RegexPatternSet . func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error) { if params == nil { params = &DeleteRegexPatternSetInput{} @@ -38,10 +38,10 @@ type DeleteRegexPatternSetInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -56,12 +56,9 @@ type DeleteRegexPatternSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_DeleteRuleGroup.go b/service/wafv2/api_op_DeleteRuleGroup.go index 5d4e36a4bfa..e3476bfad76 100644 --- a/service/wafv2/api_op_DeleteRuleGroup.go +++ b/service/wafv2/api_op_DeleteRuleGroup.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified RuleGroup. +// Deletes the specified RuleGroup . func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -38,16 +38,16 @@ type DeleteRuleGroupInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. // // This member is required. Name *string @@ -57,12 +57,9 @@ type DeleteRuleGroupInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_DeleteWebACL.go b/service/wafv2/api_op_DeleteWebACL.go index 515907f3921..34be662bb34 100644 --- a/service/wafv2/api_op_DeleteWebACL.go +++ b/service/wafv2/api_op_DeleteWebACL.go @@ -11,31 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified WebACL. You can only use this if ManagedByFirewallManager -// is false in the specified WebACL. Before deleting any web ACL, first +// Deletes the specified WebACL . You can only use this if ManagedByFirewallManager +// is false in the specified WebACL . Before deleting any web ACL, first // disassociate it from all resources. -// -// * To retrieve a list of the resources that -// are associated with a web ACL, use the following calls: -// -// * For regional -// resources, call ListResourcesForWebACL. -// -// * For Amazon CloudFront distributions, -// use the CloudFront call ListDistributionsByWebACLId. For information, see -// ListDistributionsByWebACLId -// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html). -// -// * -// To disassociate a resource from a web ACL, use the following calls: -// -// * For -// regional resources, call DisassociateWebACL. -// -// * For Amazon CloudFront -// distributions, provide an empty web ACL ID in the CloudFront call -// UpdateDistribution. For information, see UpdateDistribution -// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html). +// - To retrieve a list of the resources that are associated with a web ACL, use +// the following calls: +// - For regional resources, call ListResourcesForWebACL . +// - For Amazon CloudFront distributions, use the CloudFront call +// ListDistributionsByWebACLId . For information, see ListDistributionsByWebACLId (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) +// . +// - To disassociate a resource from a web ACL, use the following calls: +// - For regional resources, call DisassociateWebACL . +// - For Amazon CloudFront distributions, provide an empty web ACL ID in the +// CloudFront call UpdateDistribution . For information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) +// . func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error) { if params == nil { params = &DeleteWebACLInput{} @@ -62,10 +51,10 @@ type DeleteWebACLInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -81,12 +70,9 @@ type DeleteWebACLInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_DescribeManagedRuleGroup.go b/service/wafv2/api_op_DescribeManagedRuleGroup.go index a0c05c1cf6e..f599ee73c5a 100644 --- a/service/wafv2/api_op_DescribeManagedRuleGroup.go +++ b/service/wafv2/api_op_DescribeManagedRuleGroup.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides high-level information for a managed rule group, including descriptions -// of the rules. +// Provides high-level information for a managed rule group, including +// descriptions of the rules. func (c *Client) DescribeManagedRuleGroup(ctx context.Context, params *DescribeManagedRuleGroupInput, optFns ...func(*Options)) (*DescribeManagedRuleGroupOutput, error) { if params == nil { params = &DescribeManagedRuleGroupInput{} @@ -30,8 +30,8 @@ func (c *Client) DescribeManagedRuleGroup(ctx context.Context, params *DescribeM type DescribeManagedRuleGroupInput struct { - // The name of the managed rule group. You use this, along with the vendor name, to - // identify the rule group. + // The name of the managed rule group. You use this, along with the vendor name, + // to identify the rule group. // // This member is required. Name *string @@ -41,12 +41,9 @@ type DescribeManagedRuleGroupInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -68,12 +65,12 @@ type DescribeManagedRuleGroupInput struct { type DescribeManagedRuleGroupOutput struct { // The labels that one or more rules in this rule group add to matching web - // requests. These labels are defined in the RuleLabels for a Rule. + // requests. These labels are defined in the RuleLabels for a Rule . AvailableLabels []types.LabelSummary - // The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL - // capacity units (WCU) to calculate and control the operating resources that are - // used to run your rules, rule groups, and web ACLs. WAF calculates capacity + // The web ACL capacity units (WCUs) required for this rule group. WAF uses web + // ACL capacity units (WCU) to calculate and control the operating resources that + // are used to run your rules, rule groups, and web ACLs. WAF calculates capacity // differently for each rule type, to reflect each rule's relative cost. Rule group // capacity is fixed at creation, so users can plan their web ACL WCU usage when // they use a rule group. The WCU limit for web ACLs is 1,500. @@ -86,15 +83,12 @@ type DescribeManagedRuleGroupOutput struct { // The label namespace prefix for this rule group. All labels added by rules in // this rule group have this prefix. - // - // * The syntax for the label namespace prefix - // for a managed rule group is the following: awswaf:managed::: - // - // * When a rule with - // a label matches a web request, WAF adds the fully qualified label to the - // request. A fully qualified label is made up of the label namespace from the rule - // group or web ACL where the rule is defined and the label from the rule, - // separated by a colon: : + // - The syntax for the label namespace prefix for a managed rule group is the + // following: awswaf:managed:: : + // - When a rule with a label matches a web request, WAF adds the fully + // qualified label to the request. A fully qualified label is made up of the label + // namespace from the rule group or web ACL where the rule is defined and the label + // from the rule, separated by a colon: : LabelNamespace *string // @@ -104,8 +98,8 @@ type DescribeManagedRuleGroupOutput struct { // topic that's used to record changes to the managed rule group. You can subscribe // to the SNS topic to receive notifications when the managed rule group is // modified, such as for new versions and for version expiration. For more - // information, see the Amazon Simple Notification Service Developer Guide - // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). + // information, see the Amazon Simple Notification Service Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/welcome.html) + // . SnsTopicArn *string // The managed rule group's version. diff --git a/service/wafv2/api_op_DisassociateWebACL.go b/service/wafv2/api_op_DisassociateWebACL.go index 72a50a2140d..fbd59e3ccdb 100644 --- a/service/wafv2/api_op_DisassociateWebACL.go +++ b/service/wafv2/api_op_DisassociateWebACL.go @@ -16,9 +16,9 @@ import ( // REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner // service. For Amazon CloudFront, don't use this call. Instead, use your // CloudFront distribution configuration. To disassociate a web ACL, provide an -// empty web ACL ID in the CloudFront call UpdateDistribution. For information, see -// UpdateDistribution -// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html). +// empty web ACL ID in the CloudFront call UpdateDistribution . For information, +// see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) +// . func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWebACLInput, optFns ...func(*Options)) (*DisassociateWebACLOutput, error) { if params == nil { params = &DisassociateWebACLInput{} @@ -36,27 +36,19 @@ func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWeb type DisassociateWebACLInput struct { - // The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. - // The ARN must be in one of the following formats: + // The Amazon Resource Name (ARN) of the resource to disassociate from the web + // ACL. The ARN must be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application Load - // Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway REST API: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name - // - // * For an AppSync - // GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId - // - // * For an - // Amazon Cognito user pool: - // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id - // - // * For an App Runner - // service: - // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id + // - For an Amazon API Gateway REST API: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an AppSync GraphQL API: + // arn:aws:appsync:region:account-id:apis/GraphQLApiId + // - For an Amazon Cognito user pool: + // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id + // - For an App Runner service: + // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go b/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go index 4238066d56b..47d2185600c 100644 --- a/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go +++ b/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go @@ -15,8 +15,7 @@ import ( // The mobile SDK is not generally available. Customers who have access to the // mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) // requests from a mobile device to WAF. For more information, see WAF client -// application integration -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) +// application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. func (c *Client) GenerateMobileSdkReleaseUrl(ctx context.Context, params *GenerateMobileSdkReleaseUrlInput, optFns ...func(*Options)) (*GenerateMobileSdkReleaseUrlOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type GenerateMobileSdkReleaseUrlInput struct { // This member is required. Platform types.Platform - // The release version. For the latest available version, specify LATEST. + // The release version. For the latest available version, specify LATEST . // // This member is required. ReleaseVersion *string diff --git a/service/wafv2/api_op_GetIPSet.go b/service/wafv2/api_op_GetIPSet.go index 9f48e633f3d..3c33141d0c4 100644 --- a/service/wafv2/api_op_GetIPSet.go +++ b/service/wafv2/api_op_GetIPSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified IPSet. +// Retrieves the specified IPSet . func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} @@ -46,12 +46,9 @@ type GetIPSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -67,10 +64,10 @@ type GetIPSetOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_GetLoggingConfiguration.go b/service/wafv2/api_op_GetLoggingConfiguration.go index 16cfb94bdf0..d2a68f42f45 100644 --- a/service/wafv2/api_op_GetLoggingConfiguration.go +++ b/service/wafv2/api_op_GetLoggingConfiguration.go @@ -30,7 +30,7 @@ func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLogging type GetLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL for which you want to get the - // LoggingConfiguration. + // LoggingConfiguration . // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_GetManagedRuleSet.go b/service/wafv2/api_op_GetManagedRuleSet.go index 29b29be9630..b75dd870f13 100644 --- a/service/wafv2/api_op_GetManagedRuleSet.go +++ b/service/wafv2/api_op_GetManagedRuleSet.go @@ -15,8 +15,8 @@ import ( // vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web // Services Marketplace sellers. Vendors, you can use the managed rule set APIs to // provide controlled rollout of your versioned managed rule group offerings for -// your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, -// PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. +// your customers. The APIs are ListManagedRuleSets , GetManagedRuleSet , +// PutManagedRuleSetVersions , and UpdateManagedRuleSetVersionExpiryDate . func (c *Client) GetManagedRuleSet(ctx context.Context, params *GetManagedRuleSetInput, optFns ...func(*Options)) (*GetManagedRuleSetOutput, error) { if params == nil { params = &GetManagedRuleSetInput{} @@ -35,8 +35,8 @@ func (c *Client) GetManagedRuleSet(ctx context.Context, params *GetManagedRuleSe type GetManagedRuleSetInput struct { // A unique identifier for the managed rule set. The ID is returned in the - // responses to commands like list. You provide it to operations like get and - // update. + // responses to commands like list . You provide it to operations like get and + // update . // // This member is required. Id *string @@ -53,12 +53,9 @@ type GetManagedRuleSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -71,10 +68,10 @@ type GetManagedRuleSetOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The managed rule set that you requested. diff --git a/service/wafv2/api_op_GetMobileSdkRelease.go b/service/wafv2/api_op_GetMobileSdkRelease.go index 3c45612de35..21d7d5ceb8b 100644 --- a/service/wafv2/api_op_GetMobileSdkRelease.go +++ b/service/wafv2/api_op_GetMobileSdkRelease.go @@ -15,8 +15,7 @@ import ( // notes and tags. The mobile SDK is not generally available. Customers who have // access to the mobile SDK can use it to establish and manage WAF tokens for use // in HTTP(S) requests from a mobile device to WAF. For more information, see WAF -// client application integration -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) +// client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. func (c *Client) GetMobileSdkRelease(ctx context.Context, params *GetMobileSdkReleaseInput, optFns ...func(*Options)) (*GetMobileSdkReleaseOutput, error) { if params == nil { @@ -40,7 +39,7 @@ type GetMobileSdkReleaseInput struct { // This member is required. Platform types.Platform - // The release version. For the latest available version, specify LATEST. + // The release version. For the latest available version, specify LATEST . // // This member is required. ReleaseVersion *string diff --git a/service/wafv2/api_op_GetPermissionPolicy.go b/service/wafv2/api_op_GetPermissionPolicy.go index 7522183e2ba..3e2546b43e1 100644 --- a/service/wafv2/api_op_GetPermissionPolicy.go +++ b/service/wafv2/api_op_GetPermissionPolicy.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the IAM policy that is attached to the specified rule group. You must be -// the owner of the rule group to perform this operation. +// Returns the IAM policy that is attached to the specified rule group. You must +// be the owner of the rule group to perform this operation. func (c *Client) GetPermissionPolicy(ctx context.Context, params *GetPermissionPolicyInput, optFns ...func(*Options)) (*GetPermissionPolicyOutput, error) { if params == nil { params = &GetPermissionPolicyInput{} diff --git a/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go b/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go index 9049ad94dfd..7614f1e01f0 100644 --- a/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go +++ b/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go @@ -11,19 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the keys that are currently blocked by a rate-based rule instance. The -// maximum number of managed keys that can be blocked for a single rate-based rule -// instance is 10,000. If more than 10,000 addresses exceed the rate limit, those -// with the highest rates are blocked. For a rate-based rule that you've defined -// inside a rule group, provide the name of the rule group reference statement in -// your request, in addition to the rate-based rule name and the web ACL name. WAF -// monitors web requests and manages keys independently for each unique combination -// of web ACL, optional rule group, and rate-based rule. For example, if you define -// a rate-based rule inside a rule group, and then use the rule group in a web ACL, -// WAF monitors web requests and manages keys for that web ACL, rule group -// reference statement, and rate-based rule instance. If you use the same rule -// group in a second web ACL, WAF monitors web requests and manages keys for this -// second usage completely independent of your first. +// Retrieves the keys that are currently blocked by a rate-based rule instance. +// The maximum number of managed keys that can be blocked for a single rate-based +// rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, +// those with the highest rates are blocked. For a rate-based rule that you've +// defined inside a rule group, provide the name of the rule group reference +// statement in your request, in addition to the rate-based rule name and the web +// ACL name. WAF monitors web requests and manages keys independently for each +// unique combination of web ACL, optional rule group, and rate-based rule. For +// example, if you define a rate-based rule inside a rule group, and then use the +// rule group in a web ACL, WAF monitors web requests and manages keys for that web +// ACL, rule group reference statement, and rate-based rule instance. If you use +// the same rule group in a second web ACL, WAF monitors web requests and manages +// keys for this second usage completely independent of your first. func (c *Client) GetRateBasedStatementManagedKeys(ctx context.Context, params *GetRateBasedStatementManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedStatementManagedKeysOutput, error) { if params == nil { params = &GetRateBasedStatementManagedKeysInput{} @@ -44,7 +44,7 @@ type GetRateBasedStatementManagedKeysInput struct { // The name of the rate-based rule to get the keys for. If you have the rule // defined inside a rule group that you're using in your web ACL, also provide the // name of the rule group reference statement in the request parameter - // RuleGroupRuleName. + // RuleGroupRuleName . // // This member is required. RuleName *string @@ -54,12 +54,9 @@ type GetRateBasedStatementManagedKeysInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -76,8 +73,8 @@ type GetRateBasedStatementManagedKeysInput struct { // This member is required. WebACLName *string - // The name of the rule group reference statement in your web ACL. This is required - // only when you have the rate-based rule nested inside a rule group. + // The name of the rule group reference statement in your web ACL. This is + // required only when you have the rate-based rule nested inside a rule group. RuleGroupRuleName *string noSmithyDocumentSerde diff --git a/service/wafv2/api_op_GetRegexPatternSet.go b/service/wafv2/api_op_GetRegexPatternSet.go index 85c57fe6cd5..9f7857aa591 100644 --- a/service/wafv2/api_op_GetRegexPatternSet.go +++ b/service/wafv2/api_op_GetRegexPatternSet.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified RegexPatternSet. +// Retrieves the specified RegexPatternSet . func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error) { if params == nil { params = &GetRegexPatternSetInput{} @@ -45,12 +45,9 @@ type GetRegexPatternSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -63,10 +60,10 @@ type GetRegexPatternSetOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // diff --git a/service/wafv2/api_op_GetRuleGroup.go b/service/wafv2/api_op_GetRuleGroup.go index c5be49b49cd..d34fe250ca6 100644 --- a/service/wafv2/api_op_GetRuleGroup.go +++ b/service/wafv2/api_op_GetRuleGroup.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified RuleGroup. +// Retrieves the specified RuleGroup . func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) { if params == nil { params = &GetRuleGroupInput{} @@ -36,8 +36,8 @@ type GetRuleGroupInput struct { // create and list commands. You provide it to operations like update and delete. Id *string - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. Name *string // Specifies whether this is for an Amazon CloudFront distribution or for a @@ -45,12 +45,9 @@ type GetRuleGroupInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. Scope types.Scope noSmithyDocumentSerde @@ -61,10 +58,10 @@ type GetRuleGroupOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // diff --git a/service/wafv2/api_op_GetSampledRequests.go b/service/wafv2/api_op_GetSampledRequests.go index 205b6ca1a56..5eea28a292b 100644 --- a/service/wafv2/api_op_GetSampledRequests.go +++ b/service/wafv2/api_op_GetSampledRequests.go @@ -40,14 +40,14 @@ type GetSampledRequestsInput struct { // The number of requests that you want WAF to return from among the first 5,000 // requests that your Amazon Web Services resource received during the time range. - // If your resource received fewer requests than the value of MaxItems, + // If your resource received fewer requests than the value of MaxItems , // GetSampledRequests returns information about all of them. // // This member is required. MaxItems int64 - // The metric name assigned to the Rule or RuleGroup dimension for which you want a - // sample of requests. + // The metric name assigned to the Rule or RuleGroup dimension for which you want + // a sample of requests. // // This member is required. RuleMetricName *string @@ -57,12 +57,9 @@ type GetSampledRequestsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -70,7 +67,7 @@ type GetSampledRequestsInput struct { // The start date and time and the end date and time of the range for which you // want GetSampledRequests to return a sample of requests. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the - // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any + // special designator, Z . For example, "2016-09-27T14:50Z" . You can specify any // time range in the previous three hours. If you specify a start time that's // earlier than three hours ago, WAF sets it to three hours ago. // @@ -89,7 +86,7 @@ type GetSampledRequestsInput struct { type GetSampledRequestsOutput struct { // The total number of requests from which GetSampledRequests got a sample of - // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes + // MaxItems requests. If PopulationSize is less than MaxItems , the sample includes // every request that your Amazon Web Services resource received during the // specified time range. PopulationSize int64 diff --git a/service/wafv2/api_op_GetWebACL.go b/service/wafv2/api_op_GetWebACL.go index 664ae1caf00..8ba1182f172 100644 --- a/service/wafv2/api_op_GetWebACL.go +++ b/service/wafv2/api_op_GetWebACL.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified WebACL. +// Retrieves the specified WebACL . func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error) { if params == nil { params = &GetWebACLInput{} @@ -46,12 +46,9 @@ type GetWebACLInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -61,23 +58,22 @@ type GetWebACLInput struct { type GetWebACLOutput struct { - // The URL to use in SDK integrations with Amazon Web Services managed rule groups. - // For example, you can use the integration SDKs with the account takeover - // prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated + // The URL to use in SDK integrations with Amazon Web Services managed rule + // groups. For example, you can use the integration SDKs with the account takeover + // prevention managed rule group AWSManagedRulesATPRuleSet . This is only populated // if you are using a rule group in your web ACL that integrates with your // applications in this way. For more information, see WAF client application - // integration - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) + // integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. ApplicationIntegrationURL *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The web ACL specification. You can modify the settings in this web ACL and use diff --git a/service/wafv2/api_op_GetWebACLForResource.go b/service/wafv2/api_op_GetWebACLForResource.go index 700535d735a..380522184ea 100644 --- a/service/wafv2/api_op_GetWebACLForResource.go +++ b/service/wafv2/api_op_GetWebACLForResource.go @@ -31,25 +31,17 @@ type GetWebACLForResourceInput struct { // The Amazon Resource Name (ARN) of the resource whose web ACL you want to // retrieve. The ARN must be in one of the following formats: + // - For an Application Load Balancer: + // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // - // * For an Application - // Load Balancer: - // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id - // - // * - // For an Amazon API Gateway REST API: - // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name - // - // * For an AppSync - // GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId - // - // * For an - // Amazon Cognito user pool: - // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id - // - // * For an App Runner - // service: - // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id + // - For an Amazon API Gateway REST API: + // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name + // - For an AppSync GraphQL API: + // arn:aws:appsync:region:account-id:apis/GraphQLApiId + // - For an Amazon Cognito user pool: + // arn:aws:cognito-idp:region:account-id:userpool/user-pool-id + // - For an App Runner service: + // arn:aws:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go b/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go index 9bd05314360..a3e6fa2e973 100644 --- a/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go +++ b/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go @@ -29,8 +29,8 @@ func (c *Client) ListAvailableManagedRuleGroupVersions(ctx context.Context, para type ListAvailableManagedRuleGroupVersionsInput struct { - // The name of the managed rule group. You use this, along with the vendor name, to - // identify the rule group. + // The name of the managed rule group. You use this, along with the vendor name, + // to identify the rule group. // // This member is required. Name *string @@ -40,12 +40,9 @@ type ListAvailableManagedRuleGroupVersionsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListAvailableManagedRuleGroups.go b/service/wafv2/api_op_ListAvailableManagedRuleGroups.go index ac6ddccde71..3aaa66844a2 100644 --- a/service/wafv2/api_op_ListAvailableManagedRuleGroups.go +++ b/service/wafv2/api_op_ListAvailableManagedRuleGroups.go @@ -37,12 +37,9 @@ type ListAvailableManagedRuleGroupsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListIPSets.go b/service/wafv2/api_op_ListIPSets.go index c3d9fe2c896..dcdcc5be286 100644 --- a/service/wafv2/api_op_ListIPSets.go +++ b/service/wafv2/api_op_ListIPSets.go @@ -34,12 +34,9 @@ type ListIPSetsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListLoggingConfigurations.go b/service/wafv2/api_op_ListLoggingConfigurations.go index 639ecfa0ee7..bed738d40f0 100644 --- a/service/wafv2/api_op_ListLoggingConfigurations.go +++ b/service/wafv2/api_op_ListLoggingConfigurations.go @@ -34,12 +34,9 @@ type ListLoggingConfigurationsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListManagedRuleSets.go b/service/wafv2/api_op_ListManagedRuleSets.go index af2bff59bdd..fb1cf76f315 100644 --- a/service/wafv2/api_op_ListManagedRuleSets.go +++ b/service/wafv2/api_op_ListManagedRuleSets.go @@ -15,8 +15,8 @@ import ( // vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web // Services Marketplace sellers. Vendors, you can use the managed rule set APIs to // provide controlled rollout of your versioned managed rule group offerings for -// your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, -// PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. +// your customers. The APIs are ListManagedRuleSets , GetManagedRuleSet , +// PutManagedRuleSetVersions , and UpdateManagedRuleSetVersionExpiryDate . func (c *Client) ListManagedRuleSets(ctx context.Context, params *ListManagedRuleSetsInput, optFns ...func(*Options)) (*ListManagedRuleSetsOutput, error) { if params == nil { params = &ListManagedRuleSetsInput{} @@ -39,12 +39,9 @@ type ListManagedRuleSetsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListMobileSdkReleases.go b/service/wafv2/api_op_ListMobileSdkReleases.go index de55c34835d..f2f6cc85137 100644 --- a/service/wafv2/api_op_ListMobileSdkReleases.go +++ b/service/wafv2/api_op_ListMobileSdkReleases.go @@ -15,8 +15,7 @@ import ( // device platform. The mobile SDK is not generally available. Customers who have // access to the mobile SDK can use it to establish and manage WAF tokens for use // in HTTP(S) requests from a mobile device to WAF. For more information, see WAF -// client application integration -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) +// client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. func (c *Client) ListMobileSdkReleases(ctx context.Context, params *ListMobileSdkReleasesInput, optFns ...func(*Options)) (*ListMobileSdkReleasesOutput, error) { if params == nil { diff --git a/service/wafv2/api_op_ListRegexPatternSets.go b/service/wafv2/api_op_ListRegexPatternSets.go index 86c0494ccb6..0e7708de4e5 100644 --- a/service/wafv2/api_op_ListRegexPatternSets.go +++ b/service/wafv2/api_op_ListRegexPatternSets.go @@ -35,12 +35,9 @@ type ListRegexPatternSetsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListResourcesForWebACL.go b/service/wafv2/api_op_ListResourcesForWebACL.go index 74195dbd398..df8316f530e 100644 --- a/service/wafv2/api_op_ListResourcesForWebACL.go +++ b/service/wafv2/api_op_ListResourcesForWebACL.go @@ -14,7 +14,7 @@ import ( // Retrieves an array of the Amazon Resource Names (ARNs) for the regional // resources that are associated with the specified web ACL. If you want the list // of Amazon CloudFront resources, use the CloudFront call -// ListDistributionsByWebACLId. +// ListDistributionsByWebACLId . func (c *Client) ListResourcesForWebACL(ctx context.Context, params *ListResourcesForWebACLInput, optFns ...func(*Options)) (*ListResourcesForWebACLOutput, error) { if params == nil { params = &ListResourcesForWebACLInput{} @@ -41,7 +41,7 @@ type ListResourcesForWebACLInput struct { // application can be an Application Load Balancer (ALB), an Amazon API Gateway // REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner // service. If you don't provide a resource type, the call uses the resource type - // APPLICATION_LOAD_BALANCER. Default: APPLICATION_LOAD_BALANCER + // APPLICATION_LOAD_BALANCER . Default: APPLICATION_LOAD_BALANCER ResourceType types.ResourceType noSmithyDocumentSerde diff --git a/service/wafv2/api_op_ListRuleGroups.go b/service/wafv2/api_op_ListRuleGroups.go index 6b5c9baa2ce..d9ebc50e5b6 100644 --- a/service/wafv2/api_op_ListRuleGroups.go +++ b/service/wafv2/api_op_ListRuleGroups.go @@ -35,12 +35,9 @@ type ListRuleGroupsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_ListWebACLs.go b/service/wafv2/api_op_ListWebACLs.go index 6289c9145f6..8fa5f86694e 100644 --- a/service/wafv2/api_op_ListWebACLs.go +++ b/service/wafv2/api_op_ListWebACLs.go @@ -34,12 +34,9 @@ type ListWebACLsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope diff --git a/service/wafv2/api_op_PutLoggingConfiguration.go b/service/wafv2/api_op_PutLoggingConfiguration.go index 1ca4fe4d4d2..f2f21c51132 100644 --- a/service/wafv2/api_op_PutLoggingConfiguration.go +++ b/service/wafv2/api_op_PutLoggingConfiguration.go @@ -11,46 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the specified LoggingConfiguration, to start logging from a web ACL, +// Enables the specified LoggingConfiguration , to start logging from a web ACL, // according to the configuration provided. This operation completely replaces any // mutable specifications that you already have for a logging configuration with // the ones that you provide to this call. To modify an existing logging // configuration, do the following: +// - Retrieve it by calling GetLoggingConfiguration +// - Update its settings as needed +// - Provide the complete logging configuration specification to this call // -// * Retrieve it by calling -// GetLoggingConfiguration +// You can define one logging destination per web ACL. You can access information +// about the traffic that WAF inspects using the following steps: +// - Create your logging destination. You can use an Amazon CloudWatch Logs log +// group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis +// Data Firehose. The name that you give the destination must start with +// aws-waf-logs- . Depending on the type of destination, you might need to +// configure additional settings or permissions. For configuration requirements and +// pricing information for each destination type, see Logging web ACL traffic (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the WAF Developer Guide. +// - Associate your logging destination to your web ACL using a +// PutLoggingConfiguration request. // -// * Update its settings as needed -// -// * Provide the complete -// logging configuration specification to this call -// -// You can define one logging -// destination per web ACL. You can access information about the traffic that WAF -// inspects using the following steps: -// -// * Create your logging destination. You can -// use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service -// (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. The name that you give -// the destination must start with aws-waf-logs-. Depending on the type of -// destination, you might need to configure additional settings or permissions. For -// configuration requirements and pricing information for each destination type, -// see Logging web ACL traffic -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF -// Developer Guide. -// -// * Associate your logging destination to your web ACL using a -// PutLoggingConfiguration request. -// -// When you successfully enable logging using a -// PutLoggingConfiguration request, WAF creates an additional role or policy that -// is required to write logs to the logging destination. For an Amazon CloudWatch -// Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 -// bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF -// creates a service-linked role. For additional information about web ACL logging, -// see Logging web ACL traffic information -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF -// Developer Guide. +// When you successfully enable logging using a PutLoggingConfiguration request, +// WAF creates an additional role or policy that is required to write logs to the +// logging destination. For an Amazon CloudWatch Logs log group, WAF creates a +// resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket +// policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role. +// For additional information about web ACL logging, see Logging web ACL traffic +// information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the WAF Developer Guide. func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error) { if params == nil { params = &PutLoggingConfigurationInput{} diff --git a/service/wafv2/api_op_PutManagedRuleSetVersions.go b/service/wafv2/api_op_PutManagedRuleSetVersions.go index c6964b71166..81c2efb982d 100644 --- a/service/wafv2/api_op_PutManagedRuleSetVersions.go +++ b/service/wafv2/api_op_PutManagedRuleSetVersions.go @@ -17,15 +17,15 @@ import ( // Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you // can use the managed rule set APIs to provide controlled rollout of your // versioned managed rule group offerings for your customers. The APIs are -// ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and -// UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule -// group list by calling ListAvailableManagedRuleGroups. The name that you provide +// ListManagedRuleSets , GetManagedRuleSet , PutManagedRuleSetVersions , and +// UpdateManagedRuleSetVersionExpiryDate . Customers retrieve their managed rule +// group list by calling ListAvailableManagedRuleGroups . The name that you provide // here for your managed rule set is the name the customer sees for the // corresponding managed rule group. Customers can retrieve the available versions -// for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You +// for a managed rule group by calling ListAvailableManagedRuleGroupVersions . You // provide a rule group specification for each version. For each managed rule set, // you must specify a version that you recommend using. To initiate the expiration -// of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. +// of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate . func (c *Client) PutManagedRuleSetVersions(ctx context.Context, params *PutManagedRuleSetVersionsInput, optFns ...func(*Options)) (*PutManagedRuleSetVersionsOutput, error) { if params == nil { params = &PutManagedRuleSetVersionsInput{} @@ -44,8 +44,8 @@ func (c *Client) PutManagedRuleSetVersions(ctx context.Context, params *PutManag type PutManagedRuleSetVersionsInput struct { // A unique identifier for the managed rule set. The ID is returned in the - // responses to commands like list. You provide it to operations like get and - // update. + // responses to commands like list . You provide it to operations like get and + // update . // // This member is required. Id *string @@ -53,10 +53,10 @@ type PutManagedRuleSetVersionsInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -73,12 +73,9 @@ type PutManagedRuleSetVersionsInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -99,10 +96,10 @@ type PutManagedRuleSetVersionsOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_PutPermissionPolicy.go b/service/wafv2/api_op_PutPermissionPolicy.go index e107ceb1475..1d3773023bd 100644 --- a/service/wafv2/api_op_PutPermissionPolicy.go +++ b/service/wafv2/api_op_PutPermissionPolicy.go @@ -10,18 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches an IAM policy to the specified resource. Use this to share a rule group -// across accounts. You must be the owner of the rule group to perform this +// Attaches an IAM policy to the specified resource. Use this to share a rule +// group across accounts. You must be the owner of the rule group to perform this // operation. This action is subject to the following restrictions: -// -// * You can -// attach only one policy with each PutPermissionPolicy request. -// -// * The ARN in the -// request must be a valid WAF RuleGroup ARN and the rule group must exist in the -// same Region. -// -// * The user making the request must be the owner of the rule group. +// - You can attach only one policy with each PutPermissionPolicy request. +// - The ARN in the request must be a valid WAF RuleGroup ARN and the rule group +// must exist in the same Region. +// - The user making the request must be the owner of the rule group. func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionPolicyInput, optFns ...func(*Options)) (*PutPermissionPolicyOutput, error) { if params == nil { params = &PutPermissionPolicyInput{} @@ -39,28 +34,19 @@ func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionP type PutPermissionPolicyInput struct { - // The policy to attach to the specified rule group. The policy specifications must - // conform to the following: - // - // * The policy must be composed using IAM Policy - // version 2012-10-17 or version 2015-01-01. - // - // * The policy must include - // specifications for Effect, Action, and Principal. - // - // * Effect must specify - // Allow. - // - // * Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and - // wafv2:PutFirewallManagerRuleGroups and may optionally specify - // wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the - // policy. - // - // * The policy must not include a Resource parameter. - // - // For more - // information, see IAM Policies - // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). + // The policy to attach to the specified rule group. The policy specifications + // must conform to the following: + // - The policy must be composed using IAM Policy version 2012-10-17 or version + // 2015-01-01. + // - The policy must include specifications for Effect , Action , and Principal . + // - Effect must specify Allow . + // - Action must specify wafv2:CreateWebACL , wafv2:UpdateWebACL , and + // wafv2:PutFirewallManagerRuleGroups and may optionally specify + // wafv2:GetRuleGroup . WAF rejects any extra actions or wildcard actions in the + // policy. + // - The policy must not include a Resource parameter. + // For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) + // . // // This member is required. Policy *string diff --git a/service/wafv2/api_op_UpdateIPSet.go b/service/wafv2/api_op_UpdateIPSet.go index 70dce959152..58b336112ee 100644 --- a/service/wafv2/api_op_UpdateIPSet.go +++ b/service/wafv2/api_op_UpdateIPSet.go @@ -11,30 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified IPSet. This operation completely replaces the mutable +// Updates the specified IPSet . This operation completely replaces the mutable // specifications that you already have for the IP set with the ones that you // provide to this call. To modify an IP set, do the following: +// - Retrieve it by calling GetIPSet +// - Update its settings as needed +// - Provide the complete IP set specification to this call // -// * Retrieve it by -// calling GetIPSet -// -// * Update its settings as needed -// -// * Provide the complete IP set -// specification to this call -// -// When you make changes to web ACLs or web ACL -// components, like rules and rule groups, WAF propagates the changes everywhere -// that the web ACL and its components are stored and used. Your changes are -// applied within seconds, but there might be a brief period of inconsistency when -// the changes have arrived in some places and not in others. So, for example, if -// you change a rule action setting, the action might be the old action in one area -// and the new action in another area. Or if you add an IP address to an IP set -// used in a blocking rule, the new address might briefly be blocked in one area -// while still allowed in another. This temporary inconsistency can occur when you -// first associate a web ACL with an Amazon Web Services resource and when you -// change a web ACL that is already associated with a resource. Generally, any -// inconsistencies of this type last only a few seconds. +// When you make changes to web ACLs or web ACL components, like rules and rule +// groups, WAF propagates the changes everywhere that the web ACL and its +// components are stored and used. Your changes are applied within seconds, but +// there might be a brief period of inconsistency when the changes have arrived in +// some places and not in others. So, for example, if you change a rule action +// setting, the action might be the old action in one area and the new action in +// another area. Or if you add an IP address to an IP set used in a blocking rule, +// the new address might briefly be blocked in one area while still allowed in +// another. This temporary inconsistency can occur when you first associate a web +// ACL with an Amazon Web Services resource and when you change a web ACL that is +// already associated with a resource. Generally, any inconsistencies of this type +// last only a few seconds. func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { if params == nil { params = &UpdateIPSetInput{} @@ -55,41 +50,26 @@ type UpdateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses. All addresses must be specified using Classless Inter-Domain // Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for - // /0. Example address strings: - // - // * To configure WAF to allow, block, or count - // requests that originated from the IP address 192.0.2.44, specify - // 192.0.2.44/32. - // - // * To configure WAF to allow, block, or count requests that - // originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify - // 192.0.2.0/24. - // - // * To configure WAF to allow, block, or count requests that - // originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure WAF to allow, - // block, or count requests that originated from IP addresses - // 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Example JSON - // Addresses specifications: - // - // * Empty array: "Addresses": [] - // - // * Array with one - // address: "Addresses": ["192.0.2.44/32"] - // - // * Array with three addresses: - // "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] - // - // * INVALID - // specification: "Addresses": [""] INVALID + // /0 . Example address strings: + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 192.0.2.44, specify 192.0.2.44/32 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . Example JSON Addresses specifications: + // - Empty array: "Addresses": [] + // - Array with one address: "Addresses": ["192.0.2.44/32"] + // - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", + // "192.0.0.0/16"] + // - INVALID specification: "Addresses": [""] INVALID // // This member is required. Addresses []string @@ -103,10 +83,10 @@ type UpdateIPSetInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -122,12 +102,9 @@ type UpdateIPSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -141,7 +118,7 @@ type UpdateIPSetInput struct { type UpdateIPSetOutput struct { // A token used for optimistic locking. WAF returns this token to your update - // requests. You use NextLockToken in the same manner as you use LockToken. + // requests. You use NextLockToken in the same manner as you use LockToken . NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go b/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go index 8eddec1576c..45a13e60f93 100644 --- a/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go +++ b/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go @@ -19,9 +19,9 @@ import ( // intended for use only by vendors of managed rule sets. Vendors are Amazon Web // Services and Amazon Web Services Marketplace sellers. Vendors, you can use the // managed rule set APIs to provide controlled rollout of your versioned managed -// rule group offerings for your customers. The APIs are ListManagedRuleSets, -// GetManagedRuleSet, PutManagedRuleSetVersions, and -// UpdateManagedRuleSetVersionExpiryDate. +// rule group offerings for your customers. The APIs are ListManagedRuleSets , +// GetManagedRuleSet , PutManagedRuleSetVersions , and +// UpdateManagedRuleSetVersionExpiryDate . func (c *Client) UpdateManagedRuleSetVersionExpiryDate(ctx context.Context, params *UpdateManagedRuleSetVersionExpiryDateInput, optFns ...func(*Options)) (*UpdateManagedRuleSetVersionExpiryDateOutput, error) { if params == nil { params = &UpdateManagedRuleSetVersionExpiryDateInput{} @@ -39,16 +39,16 @@ func (c *Client) UpdateManagedRuleSetVersionExpiryDate(ctx context.Context, para type UpdateManagedRuleSetVersionExpiryDateInput struct { - // The time that you want the version to expire. Times are in Coordinated Universal - // Time (UTC) format. UTC format includes the special designator, Z. For example, - // "2016-09-27T14:50Z". + // The time that you want the version to expire. Times are in Coordinated + // Universal Time (UTC) format. UTC format includes the special designator, Z. For + // example, "2016-09-27T14:50Z". // // This member is required. ExpiryTimestamp *time.Time // A unique identifier for the managed rule set. The ID is returned in the - // responses to commands like list. You provide it to operations like get and - // update. + // responses to commands like list . You provide it to operations like get and + // update . // // This member is required. Id *string @@ -56,10 +56,10 @@ type UpdateManagedRuleSetVersionExpiryDateInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -76,12 +76,9 @@ type UpdateManagedRuleSetVersionExpiryDateInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -108,10 +105,10 @@ type UpdateManagedRuleSetVersionExpiryDateOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_UpdateRegexPatternSet.go b/service/wafv2/api_op_UpdateRegexPatternSet.go index 96adc2d4b17..0c273dcd0a5 100644 --- a/service/wafv2/api_op_UpdateRegexPatternSet.go +++ b/service/wafv2/api_op_UpdateRegexPatternSet.go @@ -11,21 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified RegexPatternSet. This operation completely replaces the +// Updates the specified RegexPatternSet . This operation completely replaces the // mutable specifications that you already have for the regex pattern set with the // ones that you provide to this call. To modify a regex pattern set, do the // following: +// - Retrieve it by calling GetRegexPatternSet +// - Update its settings as needed +// - Provide the complete regex pattern set specification to this call // -// * Retrieve it by calling GetRegexPatternSet -// -// * Update its settings -// as needed -// -// * Provide the complete regex pattern set specification to this -// call -// -// When you make changes to web ACLs or web ACL components, like rules and -// rule groups, WAF propagates the changes everywhere that the web ACL and its +// When you make changes to web ACLs or web ACL components, like rules and rule +// groups, WAF propagates the changes everywhere that the web ACL and its // components are stored and used. Your changes are applied within seconds, but // there might be a brief period of inconsistency when the changes have arrived in // some places and not in others. So, for example, if you change a rule action @@ -62,10 +57,10 @@ type UpdateRegexPatternSetInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -85,12 +80,9 @@ type UpdateRegexPatternSetInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -104,7 +96,7 @@ type UpdateRegexPatternSetInput struct { type UpdateRegexPatternSetOutput struct { // A token used for optimistic locking. WAF returns this token to your update - // requests. You use NextLockToken in the same manner as you use LockToken. + // requests. You use NextLockToken in the same manner as you use LockToken . NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_UpdateRuleGroup.go b/service/wafv2/api_op_UpdateRuleGroup.go index 7d3563aa585..5801f64584e 100644 --- a/service/wafv2/api_op_UpdateRuleGroup.go +++ b/service/wafv2/api_op_UpdateRuleGroup.go @@ -11,34 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified RuleGroup. This operation completely replaces the mutable +// Updates the specified RuleGroup . This operation completely replaces the mutable // specifications that you already have for the rule group with the ones that you // provide to this call. To modify a rule group, do the following: +// - Retrieve it by calling GetRuleGroup +// - Update its settings as needed +// - Provide the complete rule group specification to this call // -// * Retrieve it -// by calling GetRuleGroup -// -// * Update its settings as needed -// -// * Provide the complete -// rule group specification to this call -// -// When you make changes to web ACLs or web -// ACL components, like rules and rule groups, WAF propagates the changes -// everywhere that the web ACL and its components are stored and used. Your changes -// are applied within seconds, but there might be a brief period of inconsistency -// when the changes have arrived in some places and not in others. So, for example, -// if you change a rule action setting, the action might be the old action in one -// area and the new action in another area. Or if you add an IP address to an IP -// set used in a blocking rule, the new address might briefly be blocked in one -// area while still allowed in another. This temporary inconsistency can occur when -// you first associate a web ACL with an Amazon Web Services resource and when you -// change a web ACL that is already associated with a resource. Generally, any -// inconsistencies of this type last only a few seconds. A rule group defines a -// collection of rules to inspect and control web requests that you can use in a -// WebACL. When you create a rule group, you define an immutable capacity limit. If -// you update a rule group, you must stay within the capacity. This allows others -// to reuse the rule group with confidence in its capacity requirements. +// When you make changes to web ACLs or web ACL components, like rules and rule +// groups, WAF propagates the changes everywhere that the web ACL and its +// components are stored and used. Your changes are applied within seconds, but +// there might be a brief period of inconsistency when the changes have arrived in +// some places and not in others. So, for example, if you change a rule action +// setting, the action might be the old action in one area and the new action in +// another area. Or if you add an IP address to an IP set used in a blocking rule, +// the new address might briefly be blocked in one area while still allowed in +// another. This temporary inconsistency can occur when you first associate a web +// ACL with an Amazon Web Services resource and when you change a web ACL that is +// already associated with a resource. Generally, any inconsistencies of this type +// last only a few seconds. A rule group defines a collection of rules to inspect +// and control web requests that you can use in a WebACL . When you create a rule +// group, you define an immutable capacity limit. If you update a rule group, you +// must stay within the capacity. This allows others to reuse the rule group with +// confidence in its capacity requirements. func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) { if params == nil { params = &UpdateRuleGroupInput{} @@ -65,16 +60,16 @@ type UpdateRuleGroupInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. // // This member is required. Name *string @@ -84,12 +79,9 @@ type UpdateRuleGroupInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -103,15 +95,12 @@ type UpdateRuleGroupInput struct { // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see - // Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. @@ -128,7 +117,7 @@ type UpdateRuleGroupInput struct { type UpdateRuleGroupOutput struct { // A token used for optimistic locking. WAF returns this token to your update - // requests. You use NextLockToken in the same manner as you use LockToken. + // requests. You use NextLockToken in the same manner as you use LockToken . NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_UpdateWebACL.go b/service/wafv2/api_op_UpdateWebACL.go index 729a1b82ef7..2957f897ea0 100644 --- a/service/wafv2/api_op_UpdateWebACL.go +++ b/service/wafv2/api_op_UpdateWebACL.go @@ -11,22 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified WebACL. While updating a web ACL, WAF provides continuous +// Updates the specified WebACL . While updating a web ACL, WAF provides continuous // coverage to the resources that you have associated with the web ACL. This // operation completely replaces the mutable specifications that you already have // for the web ACL with the ones that you provide to this call. To modify a web // ACL, do the following: +// - Retrieve it by calling GetWebACL +// - Update its settings as needed +// - Provide the complete web ACL specification to this call // -// * Retrieve it by calling GetWebACL -// -// * Update its -// settings as needed -// -// * Provide the complete web ACL specification to this -// call -// -// When you make changes to web ACLs or web ACL components, like rules and -// rule groups, WAF propagates the changes everywhere that the web ACL and its +// When you make changes to web ACLs or web ACL components, like rules and rule +// groups, WAF propagates the changes everywhere that the web ACL and its // components are stored and used. Your changes are applied within seconds, but // there might be a brief period of inconsistency when the changes have arrived in // some places and not in others. So, for example, if you change a rule action @@ -41,8 +36,8 @@ import ( // or count) for requests that match the statement of the rule. In the web ACL, you // assign a default action to take (allow, block) for any request that does not // match any of the rules. The rules in a web ACL can be a combination of the types -// Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or -// more Amazon Web Services resources to protect. The resources can be an Amazon +// Rule , RuleGroup , and managed rule group. You can associate a web ACL with one +// or more Amazon Web Services resources to protect. The resources can be an Amazon // CloudFront distribution, an Amazon API Gateway REST API, an Application Load // Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner // service. @@ -77,10 +72,10 @@ type UpdateWebACLInput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. // // This member is required. LockToken *string @@ -96,12 +91,9 @@ type UpdateWebACLInput struct { // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito // user pool, or an App Runner service. To work with CloudFront, you must also // specify the Region US East (N. Virginia) as follows: - // - // * CLI - Specify the Region - // when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. - // - // * API - // and SDKs - For all calls, use the Region endpoint us-east-1. + // - CLI - Specify the Region when you use the CloudFront scope: + // --scope=CLOUDFRONT --region=us-east-1 . + // - API and SDKs - For all calls, use the Region endpoint us-east-1. // // This member is required. Scope types.Scope @@ -113,27 +105,24 @@ type UpdateWebACLInput struct { // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. If you don't specify this, WAF uses its - // default settings for CaptchaConfig. + // default settings for CaptchaConfig . CaptchaConfig *types.CaptchaConfig // Specifies how WAF should handle challenge evaluations for rules that don't have // their own ChallengeConfig settings. If you don't specify this, WAF uses its - // default settings for ChallengeConfig. + // default settings for ChallengeConfig . ChallengeConfig *types.ChallengeConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and - // responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. @@ -161,7 +150,7 @@ type UpdateWebACLInput struct { type UpdateWebACLOutput struct { // A token used for optimistic locking. WAF returns this token to your update - // requests. You use NextLockToken in the same manner as you use LockToken. + // requests. You use NextLockToken in the same manner as you use LockToken . NextLockToken *string // Metadata pertaining to the operation's result. diff --git a/service/wafv2/doc.go b/service/wafv2/doc.go index 589f1b0b286..781b225e265 100644 --- a/service/wafv2/doc.go +++ b/service/wafv2/doc.go @@ -12,51 +12,41 @@ // resources that you created before. You can access your old rules, web ACLs, and // other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have // retained the prior names, endpoints, and namespaces. For information, including -// how to migrate your WAF resources to this version, see the WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). WAF is -// a web application firewall that lets you monitor the HTTP and HTTPS requests -// that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST -// API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, -// or App Runner service. WAF also lets you control access to your content, to -// protect the Amazon Web Services resource that WAF is monitoring. Based on -// conditions that you specify, such as the IP addresses that requests originate -// from or the values of query strings, the protected resource responds to requests -// with either the requested content, an HTTP 403 status code (Forbidden), or with -// a custom response. This API guide is for developers who need detailed -// information about WAF API actions, data types, and errors. For detailed -// information about WAF features and guidance for configuring and using WAF, see -// the WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). -// You can make calls using the endpoints listed in WAF endpoints and quotas -// (https://docs.aws.amazon.com/general/latest/gr/waf.html). +// how to migrate your WAF resources to this version, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . WAF is a web application firewall that lets you monitor the HTTP and HTTPS +// requests that are forwarded to an Amazon CloudFront distribution, Amazon API +// Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito +// user pool, or App Runner service. WAF also lets you control access to your +// content, to protect the Amazon Web Services resource that WAF is monitoring. +// Based on conditions that you specify, such as the IP addresses that requests +// originate from or the values of query strings, the protected resource responds +// to requests with either the requested content, an HTTP 403 status code +// (Forbidden), or with a custom response. This API guide is for developers who +// need detailed information about WAF API actions, data types, and errors. For +// detailed information about WAF features and guidance for configuring and using +// WAF, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html) +// . You can make calls using the endpoints listed in WAF endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/waf.html) +// . +// - For regional applications, you can use any of the endpoints in the list. A +// regional application can be an Application Load Balancer (ALB), an Amazon API +// Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App +// Runner service. +// - For Amazon CloudFront applications, you must use the API endpoint listed +// for US East (N. Virginia): us-east-1. // -// * For regional -// applications, you can use any of the endpoints in the list. A regional -// application can be an Application Load Balancer (ALB), an Amazon API Gateway -// REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner -// service. -// -// * For Amazon CloudFront applications, you must use the API endpoint -// listed for US East (N. Virginia): us-east-1. -// -// Alternatively, you can use one of -// the Amazon Web Services SDKs to access an API that's tailored to the programming -// language or platform that you're using. For more information, see Amazon Web -// Services SDKs (http://aws.amazon.com/tools/#SDKs). We currently provide two -// versions of the WAF API: this API and the prior versions, the classic WAF APIs. -// This new API provides the same functionality as the older versions, with the -// following major improvements: -// -// * You use one API for both global and regional -// applications. Where you need to distinguish the scope, you specify a Scope -// parameter and set it to CLOUDFRONT or REGIONAL. -// -// * You can define a web ACL or -// rule group with a single call, and update it with a single call. You define all -// rule specifications in JSON format, and pass them to your rule group or web ACL -// calls. -// -// * The limits WAF places on the use of rules more closely reflects the -// cost of running each type of rule. Rule groups include capacity settings, so you -// know the maximum cost of a rule group when you use it. +// Alternatively, you can use one of the Amazon Web Services SDKs to access an API +// that's tailored to the programming language or platform that you're using. For +// more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs) +// . We currently provide two versions of the WAF API: this API and the prior +// versions, the classic WAF APIs. This new API provides the same functionality as +// the older versions, with the following major improvements: +// - You use one API for both global and regional applications. Where you need +// to distinguish the scope, you specify a Scope parameter and set it to +// CLOUDFRONT or REGIONAL . +// - You can define a web ACL or rule group with a single call, and update it +// with a single call. You define all rule specifications in JSON format, and pass +// them to your rule group or web ACL calls. +// - The limits WAF places on the use of rules more closely reflects the cost of +// running each type of rule. Rule groups include capacity settings, so you know +// the maximum cost of a rule group when you use it. package wafv2 diff --git a/service/wafv2/types/enums.go b/service/wafv2/types/enums.go index 7357af8ff6e..59ad658f7b3 100644 --- a/service/wafv2/types/enums.go +++ b/service/wafv2/types/enums.go @@ -1034,9 +1034,9 @@ const ( ResourceTypeAppRunnerService ResourceType = "APP_RUNNER_SERVICE" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "APPLICATION_LOAD_BALANCER", @@ -1075,8 +1075,8 @@ const ( ScopeRegional Scope = "REGIONAL" ) -// Values returns all known values for Scope. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this +// Values returns all known values for Scope. Note that this can be expanded in +// the future, and so it is only as up to date as the client. The ordering of this // slice is not guaranteed to be stable across updates. func (Scope) Values() []Scope { return []Scope{ diff --git a/service/wafv2/types/errors.go b/service/wafv2/types/errors.go index 2e8e79a1cf0..a28cb1df866 100644 --- a/service/wafv2/types/errors.go +++ b/service/wafv2/types/errors.go @@ -41,8 +41,8 @@ func (e *WAFAssociatedItemException) ErrorFault() smithy.ErrorFault { return smi // being too large. Rules that inspect the headers or cookies must provide an // OversizeHandling configuration. Provide the handling configuration and retry // your operation. Alternately, you can suppress this warning by adding the -// following tag to the resource that you provide to this operation: Tag -// (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true). +// following tag to the resource that you provide to this operation: Tag (key: +// WAF:OversizeFieldsHandlingConstraintOptOut , value: true ). type WAFConfigurationWarningException struct { Message *string @@ -97,7 +97,7 @@ func (e *WAFDuplicateItemException) ErrorFault() smithy.ErrorFault { return smit // The operation failed because the specified version for the managed rule group // has expired. You can retrieve the available versions for the managed rule group -// by calling ListAvailableManagedRuleGroupVersions. +// by calling ListAvailableManagedRuleGroupVersions . type WAFExpiredManagedRuleGroupVersionException struct { Message *string @@ -180,19 +180,13 @@ func (e *WAFInvalidOperationException) ErrorFault() smithy.ErrorFault { return s // The operation failed because WAF didn't recognize a parameter in the request. // For example: -// -// * You specified a parameter name or value that isn't valid. -// -// * -// Your nested statement isn't valid. You might have tried to nest a statement that -// can’t be nested. -// -// * You tried to update a WebACL with a DefaultAction that isn't -// among the types available at DefaultAction. -// -// * Your request references an ARN -// that is malformed, or corresponds to a resource with which a web ACL can't be -// associated. +// - You specified a parameter name or value that isn't valid. +// - Your nested statement isn't valid. You might have tried to nest a statement +// that can’t be nested. +// - You tried to update a WebACL with a DefaultAction that isn't among the types +// available at DefaultAction . +// - Your request references an ARN that is malformed, or corresponds to a +// resource with which a web ACL can't be associated. type WAFInvalidParameterException struct { Message *string @@ -224,26 +218,18 @@ func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return s // The operation failed because the specified policy isn't in the proper format. // The policy specifications must conform to the following: +// - The policy must be composed using IAM Policy version 2012-10-17 or version +// 2015-01-01. +// - The policy must include specifications for Effect , Action , and Principal . +// - Effect must specify Allow . +// - Action must specify wafv2:CreateWebACL , wafv2:UpdateWebACL , and +// wafv2:PutFirewallManagerRuleGroups and may optionally specify +// wafv2:GetRuleGroup . WAF rejects any extra actions or wildcard actions in the +// policy. +// - The policy must not include a Resource parameter. // -// * The policy must be -// composed using IAM Policy version 2012-10-17 or version 2015-01-01. -// -// * The -// policy must include specifications for Effect, Action, and Principal. -// -// * Effect -// must specify Allow. -// -// * Action must specify wafv2:CreateWebACL, -// wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally -// specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in -// the policy. -// -// * The policy must not include a Resource parameter. -// -// For more -// information, see IAM Policies -// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). +// For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html) +// . type WAFInvalidPermissionPolicyException struct { Message *string @@ -271,8 +257,8 @@ func (e *WAFInvalidPermissionPolicyException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// WAF couldn’t perform the operation because the resource that you requested isn’t -// valid. Check the resource, and try again. +// WAF couldn’t perform the operation because the resource that you requested +// isn’t valid. Check the resource, and try again. type WAFInvalidResourceException struct { Message *string @@ -298,11 +284,10 @@ func (e *WAFInvalidResourceException) ErrorCode() string { } func (e *WAFInvalidResourceException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// WAF couldn’t perform the operation because you exceeded your resource limit. For -// example, the maximum number of WebACL objects that you can create for an Amazon -// Web Services account. For more information, see WAF quotas -// (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF -// Developer Guide. +// WAF couldn’t perform the operation because you exceeded your resource limit. +// For example, the maximum number of WebACL objects that you can create for an +// Amazon Web Services account. For more information, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) +// in the WAF Developer Guide. type WAFLimitsExceededException struct { Message *string @@ -329,9 +314,8 @@ func (e *WAFLimitsExceededException) ErrorCode() string { func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation failed because you don't have the permissions that your logging -// configuration requires. For information, see Logging web ACL traffic information -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF -// Developer Guide. +// configuration requires. For information, see Logging web ACL traffic information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the WAF Developer Guide. type WAFLogDestinationPermissionIssueException struct { Message *string @@ -417,11 +401,11 @@ func (e *WAFOptimisticLockException) ErrorCode() string { func (e *WAFOptimisticLockException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // WAF is not able to access the service linked role. This can be caused by a -// previous PutLoggingConfiguration request, which can lock the service linked role -// for about 20 seconds. Please try your request again. The service linked role can -// also be locked by a previous DeleteServiceLinkedRole request, which can lock the -// role for 15 minutes or more. If you recently made a call to -// DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If +// previous PutLoggingConfiguration request, which can lock the service linked +// role for about 20 seconds. Please try your request again. The service linked +// role can also be locked by a previous DeleteServiceLinkedRole request, which +// can lock the role for 15 minutes or more. If you recently made a call to +// DeleteServiceLinkedRole , wait at least 15 minutes and try the request again. If // you receive this same exception again, you will have to wait additional time // until the role is unlocked. type WAFServiceLinkedRoleErrorException struct { diff --git a/service/wafv2/types/types.go b/service/wafv2/types/types.go index d475a8da751..a1e146479cc 100644 --- a/service/wafv2/types/types.go +++ b/service/wafv2/types/types.go @@ -33,14 +33,13 @@ type All struct { // Specifies that WAF should allow the request and optionally defines additional // custom handling for the request. This is used in the context of other settings, -// for example to specify values for RuleAction and web ACL DefaultAction. +// for example to specify values for RuleAction and web ACL DefaultAction . type AllowAction struct { // Defines custom handling for the web request. For information about customizing - // web requests and responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // web requests and responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde @@ -54,11 +53,11 @@ type AllQueryArguments struct { } // A logical rule statement used to combine other rule statements with AND logic. -// You provide more than one Statement within the AndStatement. +// You provide more than one Statement within the AndStatement . type AndStatement struct { - // The statements to combine with AND logic. You can use any statements that can be - // nested. + // The statements to combine with AND logic. You can use any statements that can + // be nested. // // This member is required. Statements []Statement @@ -67,11 +66,12 @@ type AndStatement struct { } // Details for your use of the account takeover prevention managed rule group, -// AWSManagedRulesATPRuleSet. This configuration is used in ManagedRuleGroupConfig. +// AWSManagedRulesATPRuleSet . This configuration is used in ManagedRuleGroupConfig +// . type AWSManagedRulesATPRuleSet struct { // The path of the login endpoint for your application. For example, for the URL - // https://example.com/web/login, you would provide the path /web/login. The rule + // https://example.com/web/login , you would provide the path /web/login . The rule // group inspects only HTTP POST requests to your specified login endpoint. // // This member is required. @@ -95,15 +95,15 @@ type AWSManagedRulesATPRuleSet struct { } // Details for your use of the Bot Control managed rule group, -// AWSManagedRulesBotControlRuleSet. This configuration is used in -// ManagedRuleGroupConfig. +// AWSManagedRulesBotControlRuleSet . This configuration is used in +// ManagedRuleGroupConfig . type AWSManagedRulesBotControlRuleSet struct { // The inspection level to use for the Bot Control rule group. The common level is // the least expensive. The targeted level includes all common level rules and adds // rules with more advanced inspection criteria. For details, see WAF Bot Control - // rule group - // (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html). + // rule group (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) + // . // // This member is required. InspectionLevel InspectionLevel @@ -114,14 +114,14 @@ type AWSManagedRulesBotControlRuleSet struct { // Specifies that WAF should block the request and optionally defines additional // custom handling for the response to the web request. This is used in the context // of other settings, for example to specify values for RuleAction and web ACL -// DefaultAction. +// DefaultAction . type BlockAction struct { - // Defines a custom response for the web request. For information about customizing - // web requests and responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // Defines a custom response for the web request. For information about + // customizing web requests and responses, see Customizing web requests and + // responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponse *CustomResponse noSmithyDocumentSerde @@ -137,20 +137,14 @@ type Body struct { // body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are // forwarded to WAF by the underlying host service. The options for oversize // handling are the following: - // - // * CONTINUE - Inspect the body normally, according - // to the rule inspection criteria. - // - // * MATCH - Treat the web request as matching - // the rule statement. WAF applies the rule action to the request. - // - // * NO_MATCH - - // Treat the web request as not matching the rule statement. - // - // You can combine the - // MATCH or NO_MATCH settings for oversize handling with your rule and web ACL - // action settings, so that you block any request whose body is over 8 KB. Default: - // CONTINUE + // - CONTINUE - Inspect the body normally, according to the rule inspection + // criteria. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. + // You can combine the MATCH or NO_MATCH settings for oversize handling with your + // rule and web ACL action settings, so that you block any request whose body is + // over 8 KB. Default: CONTINUE OversizeHandling OversizeHandling noSmithyDocumentSerde @@ -170,62 +164,51 @@ type ByteMatchStatement struct { FieldToMatch *FieldToMatch // The area within the portion of the web request that you want WAF to search for - // SearchString. Valid values include the following: CONTAINS The specified part of - // the web request must include the value of SearchString, but the location doesn't - // matter. CONTAINS_WORD The specified part of the web request must include the - // value of SearchString, and SearchString must contain only alphanumeric + // SearchString . Valid values include the following: CONTAINS The specified part + // of the web request must include the value of SearchString , but the location + // doesn't matter. CONTAINS_WORD The specified part of the web request must include + // the value of SearchString , and SearchString must contain only alphanumeric // characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must // be a word, which means that both of the following are true: - // - // * SearchString is - // at the beginning of the specified part of the web request or is preceded by a - // character other than an alphanumeric character or underscore (_). Examples - // include the value of a header and ;BadBot. - // - // * SearchString is at the end of the - // specified part of the web request or is followed by a character other than an - // alphanumeric character or underscore (_), for example, BadBot; and - // -BadBot;. - // - // EXACTLY The value of the specified part of the web request must - // exactly match the value of SearchString. STARTS_WITH The value of SearchString - // must appear at the beginning of the specified part of the web request. ENDS_WITH - // The value of SearchString must appear at the end of the specified part of the - // web request. + // - SearchString is at the beginning of the specified part of the web request or + // is preceded by a character other than an alphanumeric character or underscore + // (_). Examples include the value of a header and ;BadBot . + // - SearchString is at the end of the specified part of the web request or is + // followed by a character other than an alphanumeric character or underscore (_), + // for example, BadBot; and -BadBot; . + // EXACTLY The value of the specified part of the web request must exactly match + // the value of SearchString . STARTS_WITH The value of SearchString must appear + // at the beginning of the specified part of the web request. ENDS_WITH The value + // of SearchString must appear at the end of the specified part of the web request. // // This member is required. PositionalConstraint PositionalConstraint - // A string value that you want WAF to search for. WAF searches only in the part of - // web requests that you designate for inspection in FieldToMatch. The maximum + // A string value that you want WAF to search for. WAF searches only in the part + // of web requests that you designate for inspection in FieldToMatch . The maximum // length of the value is 200 bytes. Valid values depend on the component that you - // specify for inspection in FieldToMatch: - // - // * Method: The HTTP method that you want - // WAF to search for. This indicates the type of operation specified in the - // request. - // - // * UriPath: The value that you want WAF to search for in the URI path, - // for example, /images/daily-ad.jpg. - // - // If SearchString includes alphabetic - // characters A-Z and a-z, note that the value is case sensitive. If you're using - // the WAF API Specify a base64-encoded version of the value. The maximum length of - // the value before you base64-encode it is 200 bytes. For example, suppose the - // value of Type is HEADER and the value of Data is User-Agent. If you want to - // search the User-Agent header for the value BadBot, you base64-encode BadBot - // using MIME base64-encoding and include the resulting value, QmFkQm90, in the - // value of SearchString. If you're using the CLI or one of the Amazon Web Services - // SDKs The value that you want WAF to search for. The SDK automatically base64 - // encodes the value. + // specify for inspection in FieldToMatch : + // - Method : The HTTP method that you want WAF to search for. This indicates the + // type of operation specified in the request. + // - UriPath : The value that you want WAF to search for in the URI path, for + // example, /images/daily-ad.jpg . + // If SearchString includes alphabetic characters A-Z and a-z, note that the value + // is case sensitive. If you're using the WAF API Specify a base64-encoded version + // of the value. The maximum length of the value before you base64-encode it is 200 + // bytes. For example, suppose the value of Type is HEADER and the value of Data + // is User-Agent . If you want to search the User-Agent header for the value BadBot + // , you base64-encode BadBot using MIME base64-encoding and include the resulting + // value, QmFkQm90 , in the value of SearchString . If you're using the CLI or one + // of the Amazon Web Services SDKs The value that you want WAF to search for. The + // SDK automatically base64 encodes the value. // // This member is required. SearchString []byte - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. @@ -235,40 +218,30 @@ type ByteMatchStatement struct { } // Specifies that WAF should run a CAPTCHA check against the request: +// - If the request includes a valid, unexpired CAPTCHA token, WAF applies any +// custom request handling and labels that you've configured and then allows the +// web request inspection to proceed to the next rule, similar to a CountAction . +// - If the request doesn't include a valid, unexpired token, WAF discontinues +// the web ACL evaluation of the request and blocks it from going to its intended +// destination. WAF generates a response that it sends back to the client, which +// includes the following: +// - The header x-amzn-waf-action with a value of captcha . +// - The HTTP status code 405 Method Not Allowed . +// - If the request contains an Accept header with a value of text/html , the +// response includes a CAPTCHA JavaScript page interstitial. // -// * If the -// request includes a valid, unexpired CAPTCHA token, WAF applies any custom -// request handling and labels that you've configured and then allows the web -// request inspection to proceed to the next rule, similar to a CountAction. -// -// * If -// the request doesn't include a valid, unexpired token, WAF discontinues the web -// ACL evaluation of the request and blocks it from going to its intended -// destination. WAF generates a response that it sends back to the client, which -// includes the following: -// -// * The header x-amzn-waf-action with a value of -// captcha. -// -// * The HTTP status code 405 Method Not Allowed. -// -// * If the request -// contains an Accept header with a value of text/html, the response includes a -// CAPTCHA JavaScript page interstitial. -// -// You can configure the expiration time in -// the CaptchaConfigImmunityTimeProperty setting at the rule and web ACL level. The -// rule setting overrides the web ACL setting. This action option is available for -// rules. It isn't available for web ACL default actions. +// You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty +// setting at the rule and web ACL level. The rule setting overrides the web ACL +// setting. This action option is available for rules. It isn't available for web +// ACL default actions. type CaptchaAction struct { // Defines custom handling for the web request, used when the CAPTCHA inspection // determines that the request's token is valid and unexpired. For information // about customizing web requests and responses, see Customizing web requests and - // responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde @@ -293,7 +266,7 @@ type CaptchaResponse struct { // The HTTP response code indicating the status of the CAPTCHA token in the web // request. If the token is missing, invalid, or expired, this code is 405 Method - // Not Allowed. + // Not Allowed . ResponseCode *int32 // The time that the CAPTCHA was last solved for the supplied token. @@ -304,49 +277,37 @@ type CaptchaResponse struct { // Specifies that WAF should run a Challenge check against the request to verify // that the request is coming from a legitimate client session: +// - If the request includes a valid, unexpired challenge token, WAF applies any +// custom request handling and labels that you've configured and then allows the +// web request inspection to proceed to the next rule, similar to a CountAction . +// - If the request doesn't include a valid, unexpired challenge token, WAF +// discontinues the web ACL evaluation of the request and blocks it from going to +// its intended destination. WAF then generates a challenge response that it sends +// back to the client, which includes the following: +// - The header x-amzn-waf-action with a value of challenge . +// - The HTTP status code 202 Request Accepted . +// - If the request contains an Accept header with a value of text/html , the +// response includes a JavaScript page interstitial with a challenge script. +// Challenges run silent browser interrogations in the background, and don't +// generally affect the end user experience. A challenge enforces token acquisition +// using an interstitial JavaScript challenge that inspects the client session for +// legitimate behavior. The challenge blocks bots or at least increases the cost of +// operating sophisticated bots. After the client session successfully responds to +// the challenge, it receives a new token from WAF, which the challenge script uses +// to resubmit the original request. // -// * If the request -// includes a valid, unexpired challenge token, WAF applies any custom request -// handling and labels that you've configured and then allows the web request -// inspection to proceed to the next rule, similar to a CountAction. -// -// * If the -// request doesn't include a valid, unexpired challenge token, WAF discontinues the -// web ACL evaluation of the request and blocks it from going to its intended -// destination. WAF then generates a challenge response that it sends back to the -// client, which includes the following: -// -// * The header x-amzn-waf-action with a -// value of challenge. -// -// * The HTTP status code 202 Request Accepted. -// -// * If the -// request contains an Accept header with a value of text/html, the response -// includes a JavaScript page interstitial with a challenge script. -// -// Challenges run -// silent browser interrogations in the background, and don't generally affect the -// end user experience. A challenge enforces token acquisition using an -// interstitial JavaScript challenge that inspects the client session for -// legitimate behavior. The challenge blocks bots or at least increases the cost of -// operating sophisticated bots. After the client session successfully responds to -// the challenge, it receives a new token from WAF, which the challenge script uses -// to resubmit the original request. -// -// You can configure the expiration time in the -// ChallengeConfigImmunityTimeProperty setting at the rule and web ACL level. The -// rule setting overrides the web ACL setting. This action option is available for -// rules. It isn't available for web ACL default actions. +// You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty +// setting at the rule and web ACL level. The rule setting overrides the web ACL +// setting. This action option is available for rules. It isn't available for web +// ACL default actions. type ChallengeAction struct { // Defines custom handling for the web request, used when the challenge inspection // determines that the request's token is valid and unexpired. For information // about customizing web requests and responses, see Customizing web requests and - // responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde @@ -371,7 +332,7 @@ type ChallengeResponse struct { // The HTTP response code indicating the status of the challenge token in the web // request. If the token is missing, invalid, or expired, this code is 202 Request - // Accepted. + // Accepted . ResponseCode *int32 // The time that the challenge was last solved for the supplied token. @@ -380,25 +341,25 @@ type ChallengeResponse struct { noSmithyDocumentSerde } -// A single match condition for a Filter. +// A single match condition for a Filter . type Condition struct { // A single action condition. This is the action setting that a log record must // contain in order to meet the condition. ActionCondition *ActionCondition - // A single label name condition. This is the fully qualified label name that a log - // record must contain in order to meet the condition. Fully qualified labels have - // a prefix, optional namespaces, and label name. The prefix identifies the rule - // group or web ACL context of the rule that added the label. + // A single label name condition. This is the fully qualified label name that a + // log record must contain in order to meet the condition. Fully qualified labels + // have a prefix, optional namespaces, and label name. The prefix identifies the + // rule group or web ACL context of the rule that added the label. LabelNameCondition *LabelNameCondition noSmithyDocumentSerde } -// The filter to use to identify the subset of cookies to inspect in a web request. -// You must specify exactly one setting: either All, IncludedCookies, or -// ExcludedCookies. Example JSON: "MatchPattern": { "IncludedCookies": +// The filter to use to identify the subset of cookies to inspect in a web +// request. You must specify exactly one setting: either All , IncludedCookies , or +// ExcludedCookies . Example JSON: "MatchPattern": { "IncludedCookies": // {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} } type CookieMatchPattern struct { @@ -416,24 +377,24 @@ type CookieMatchPattern struct { noSmithyDocumentSerde } -// Inspect the cookies in the web request. You can specify the parts of the cookies -// to inspect and you can narrow the set of cookies to inspect by including or -// excluding specific keys. This is used to indicate the web request component to -// inspect, in the FieldToMatch specification. Example JSON: "Cookies": { +// Inspect the cookies in the web request. You can specify the parts of the +// cookies to inspect and you can narrow the set of cookies to inspect by including +// or excluding specific keys. This is used to indicate the web request component +// to inspect, in the FieldToMatch specification. Example JSON: "Cookies": { // "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" // } type Cookies struct { - // The filter to use to identify the subset of cookies to inspect in a web request. - // You must specify exactly one setting: either All, IncludedCookies, or - // ExcludedCookies. Example JSON: "MatchPattern": { "IncludedCookies": + // The filter to use to identify the subset of cookies to inspect in a web + // request. You must specify exactly one setting: either All , IncludedCookies , or + // ExcludedCookies . Example JSON: "MatchPattern": { "IncludedCookies": // {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} } // // This member is required. MatchPattern *CookieMatchPattern // The parts of the cookies to inspect with the rule inspection criteria. If you - // specify All, WAF inspects both keys and values. + // specify All , WAF inspects both keys and values. // // This member is required. MatchScope MapMatchScope @@ -443,16 +404,11 @@ type Cookies struct { // when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host // service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to // WAF. The options for oversize handling are the following: - // - // * CONTINUE - Inspect - // the cookies normally, according to the rule inspection criteria. - // - // * MATCH - - // Treat the web request as matching the rule statement. WAF applies the rule - // action to the request. - // - // * NO_MATCH - Treat the web request as not matching the - // rule statement. + // - CONTINUE - Inspect the cookies normally, according to the rule inspection + // criteria. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. OversizeHandling OversizeHandling @@ -462,27 +418,26 @@ type Cookies struct { // Specifies that WAF should count the request. Optionally defines additional // custom handling for the request. This is used in the context of other settings, -// for example to specify values for RuleAction and web ACL DefaultAction. +// for example to specify values for RuleAction and web ACL DefaultAction . type CountAction struct { // Defines custom handling for the web request. For information about customizing - // web requests and responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // web requests and responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde } // A custom header for custom request and response handling. This is used in -// CustomResponse and CustomRequestHandling. +// CustomResponse and CustomRequestHandling . type CustomHTTPHeader struct { // The name of the custom header. For custom request header insertion, when WAF - // inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid - // confusion with the headers that are already in the request. For example, for the - // header name sample, WAF inserts the header x-amzn-waf-sample. + // inserts the header into the request, it prefixes this name x-amzn-waf- , to + // avoid confusion with the headers that are already in the request. For example, + // for the header name sample , WAF inserts the header x-amzn-waf-sample . // // This member is required. Name *string @@ -495,22 +450,20 @@ type CustomHTTPHeader struct { noSmithyDocumentSerde } -// Custom request handling behavior that inserts custom headers into a web request. -// You can add custom request handling for WAF to use when the rule action doesn't -// block the request. For example, CaptchaAction for requests with valid t okens, -// and AllowAction. For information about customizing web requests and responses, -// see Customizing web requests and responses in WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) -// in the WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). +// Custom request handling behavior that inserts custom headers into a web +// request. You can add custom request handling for WAF to use when the rule action +// doesn't block the request. For example, CaptchaAction for requests with valid t +// okens, and AllowAction . For information about customizing web requests and +// responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) +// in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . type CustomRequestHandling struct { // The HTTP headers to insert into the request. Duplicate header names are not // allowed. For information about the limits on count and size for custom request - // and response settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // and response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . // // This member is required. InsertHeaders []CustomHTTPHeader @@ -519,20 +472,18 @@ type CustomRequestHandling struct { } // A custom response to send to the client. You can define a custom response for -// rule actions and default web ACL actions that are set to BlockAction. For +// rule actions and default web ACL actions that are set to BlockAction . For // information about customizing web requests and responses, see Customizing web -// requests and responses in WAF -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) -// in the WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). +// requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) +// in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . type CustomResponse struct { // The HTTP status code to return to the client. For a list of status codes that // you can use in your custom responses, see Supported status codes for custom - // response - // (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // response (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . // // This member is required. ResponseCode *int32 @@ -545,28 +496,26 @@ type CustomResponse struct { // BlockAction setting, you reference the response body using this key. CustomResponseBodyKey *string - // The HTTP headers to use in the response. Duplicate header names are not allowed. - // For information about the limits on count and size for custom request and - // response settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // The HTTP headers to use in the response. Duplicate header names are not + // allowed. For information about the limits on count and size for custom request + // and response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . ResponseHeaders []CustomHTTPHeader noSmithyDocumentSerde } // The response body to use in a custom response to a web request. This is -// referenced by key from CustomResponseCustomResponseBodyKey. +// referenced by key from CustomResponse CustomResponseBodyKey . type CustomResponseBody struct { // The payload of the custom response. You can use JSON escape strings in JSON // content. To do this, you must specify JSON content in the ContentType setting. // For information about the limits on count and size for custom request and - // response settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . // // This member is required. Content *string @@ -579,8 +528,8 @@ type CustomResponseBody struct { noSmithyDocumentSerde } -// In a WebACL, this is the action that you want WAF to perform when a web request -// doesn't match any of the rules in the WebACL. The default action must be a +// In a WebACL , this is the action that you want WAF to perform when a web request +// doesn't match any of the rules in the WebACL . The default action must be a // terminating action. type DefaultAction struct { @@ -594,11 +543,11 @@ type DefaultAction struct { } // Specifies a single rule in a rule group whose action you want to override to -// Count. Instead of this option, use RuleActionOverrides. It accepts any valid -// action setting, including Count. +// Count . Instead of this option, use RuleActionOverrides . It accepts any valid +// action setting, including Count . type ExcludedRule struct { - // The name of the rule whose action you want to override to Count. + // The name of the rule whose action you want to override to Count . // // This member is required. Name *string @@ -619,17 +568,17 @@ type FieldToMatch struct { // Inspect all query arguments. AllQueryArguments *AllQueryArguments - // Inspect the request body as plain text. The request body immediately follows the - // request headers. This is the part of a request that contains any additional data - // that you want to send to your web server as the HTTP request body, such as data - // from a form. Only the first 8 KB (8192 bytes) of the request body are forwarded - // to WAF for inspection by the underlying host service. For information about how - // to handle oversized request bodies, see the Body object configuration. + // Inspect the request body as plain text. The request body immediately follows + // the request headers. This is the part of a request that contains any additional + // data that you want to send to your web server as the HTTP request body, such as + // data from a form. Only the first 8 KB (8192 bytes) of the request body are + // forwarded to WAF for inspection by the underlying host service. For information + // about how to handle oversized request bodies, see the Body object configuration. Body *Body // Inspect the request cookies. You must configure scope and pattern matching - // filters in the Cookies object, to define the set of cookies and the parts of the - // cookies that WAF inspects. Only the first 8 KB (8192 bytes) of a request's + // filters in the Cookies object, to define the set of cookies and the parts of + // the cookies that WAF inspects. Only the first 8 KB (8192 bytes) of a request's // cookies and only the first 200 cookies are forwarded to WAF for inspection by // the underlying host service. You must configure how to handle any oversize // cookie content in the Cookies object. WAF applies the pattern matching filters @@ -661,10 +610,10 @@ type FieldToMatch struct { // character, if any. QueryString *QueryString - // Inspect a single header. Provide the name of the header to inspect, for example, - // User-Agent or Referer. This setting isn't case sensitive. Example JSON: - // "SingleHeader": { "Name": "haystack" } Alternately, you can filter and inspect - // all headers with the HeadersFieldToMatch setting. + // Inspect a single header. Provide the name of the header to inspect, for + // example, User-Agent or Referer . This setting isn't case sensitive. Example + // JSON: "SingleHeader": { "Name": "haystack" } Alternately, you can filter and + // inspect all headers with the Headers FieldToMatch setting. SingleHeader *SingleHeader // Inspect a single query argument. Provide the name of the query argument to @@ -674,13 +623,13 @@ type FieldToMatch struct { SingleQueryArgument *SingleQueryArgument // Inspect the request URI path. This is the part of the web request that - // identifies a resource, for example, /images/daily-ad.jpg. + // identifies a resource, for example, /images/daily-ad.jpg . UriPath *UriPath noSmithyDocumentSerde } -// A single logging filter, used in LoggingFilter. +// A single logging filter, used in LoggingFilter . type Filter struct { // How to handle logs that satisfy the filter's conditions and requirement. @@ -707,13 +656,13 @@ type Filter struct { type FirewallManagerRuleGroup struct { // The processing guidance for an Firewall Manager rule. This is like a regular - // rule Statement, but it can only contain a rule group reference. + // rule Statement , but it can only contain a rule group reference. // // This member is required. FirewallManagerStatement *FirewallManagerStatement - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. // // This member is required. Name *string @@ -722,7 +671,7 @@ type FirewallManagerRuleGroup struct { // evaluation. Set the override action to none to leave the result of the rule // group alone. Set it to count to override the result to count only. You can only // use this for rule statements that reference a rule group, like - // RuleGroupReferenceStatement and ManagedRuleGroupStatement. This option is + // RuleGroupReferenceStatement and ManagedRuleGroupStatement . This option is // usually set to none. It does not affect how the rules in the rule group are // evaluated. If you want the rules in the rule group to only count matches, do not // use this and instead use the rule action override option, with Count action, in @@ -748,25 +697,25 @@ type FirewallManagerRuleGroup struct { } // The processing guidance for an Firewall Manager rule. This is like a regular -// rule Statement, but it can only contain a rule group reference. +// rule Statement , but it can only contain a rule group reference. type FirewallManagerStatement struct { - // A rule statement used to run the rules that are defined in a managed rule group. - // To use this, provide the vendor name and the name of the rule group in this - // statement. You can retrieve the required names by calling - // ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for - // example for use inside a NotStatement or OrStatement. It can only be referenced - // as a top-level statement within a rule. You are charged additional fees when you - // use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or - // the WAF Fraud Control account takeover prevention (ATP) managed rule group - // AWSManagedRulesATPRuleSet. For more information, see WAF Pricing - // (http://aws.amazon.com/waf/pricing/). + // A rule statement used to run the rules that are defined in a managed rule + // group. To use this, provide the vendor name and the name of the rule group in + // this statement. You can retrieve the required names by calling + // ListAvailableManagedRuleGroups . You cannot nest a ManagedRuleGroupStatement , + // for example for use inside a NotStatement or OrStatement . It can only be + // referenced as a top-level statement within a rule. You are charged additional + // fees when you use the WAF Bot Control managed rule group + // AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover + // prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more + // information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) . ManagedRuleGroupStatement *ManagedRuleGroupStatement - // A rule statement used to run the rules that are defined in a RuleGroup. To use + // A rule statement used to run the rules that are defined in a RuleGroup . To use // this, create a rule group with your rules, then provide the ARN of the rule - // group in this statement. You cannot nest a RuleGroupReferenceStatement, for - // example for use inside a NotStatement or OrStatement. You can only use a rule + // group in this statement. You cannot nest a RuleGroupReferenceStatement , for + // example for use inside a NotStatement or OrStatement . You can only use a rule // group reference statement at the top level inside a web ACL. RuleGroupReferenceStatement *RuleGroupReferenceStatement @@ -778,7 +727,7 @@ type FirewallManagerStatement struct { // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, WAF // doesn't apply the rule to the web request at all. This configuration is used for -// GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use +// GeoMatchStatement and RateBasedStatement . For IPSetReferenceStatement , use // IPSetForwardedIPConfig instead. WAF only evaluates the first IP address found in // the specified HTTP header. type ForwardedIPConfig struct { @@ -787,18 +736,15 @@ type ForwardedIPConfig struct { // valid IP address in the specified position. If the specified header isn't // present in the request, WAF doesn't apply the rule to the web request at all. // You can specify the following fallback behaviors: - // - // * MATCH - Treat the web - // request as matching the rule statement. WAF applies the rule action to the - // request. - // - // * NO_MATCH - Treat the web request as not matching the rule statement. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. FallbackBehavior FallbackBehavior // The name of the HTTP header to use for the IP address. For example, to use the - // X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified + // X-Forwarded-For (XFF) header, set this to X-Forwarded-For . If the specified // header isn't present in the request, WAF doesn't apply the rule to the web // request at all. // @@ -808,36 +754,31 @@ type ForwardedIPConfig struct { noSmithyDocumentSerde } -// A rule statement that labels web requests by country and region and that matches -// against web requests based on country code. A geo match rule labels every -// request that it inspects regardless of whether it finds a match. -// -// * To manage -// requests only by country, you can use this statement by itself and specify the -// countries that you want to match against in the CountryCodes array. -// -// * -// Otherwise, configure your geo match rule with Count action so that it only -// labels requests. Then, add one or more label match rules to run after the geo -// match rule and configure them to match against the geographic labels and handle -// the requests as needed. +// A rule statement that labels web requests by country and region and that +// matches against web requests based on country code. A geo match rule labels +// every request that it inspects regardless of whether it finds a match. +// - To manage requests only by country, you can use this statement by itself +// and specify the countries that you want to match against in the CountryCodes +// array. +// - Otherwise, configure your geo match rule with Count action so that it only +// labels requests. Then, add one or more label match rules to run after the geo +// match rule and configure them to match against the geographic labels and handle +// the requests as needed. // -// WAF labels requests using the alpha-2 country and -// region codes from the International Organization for Standardization (ISO) 3166 -// standard. WAF determines the codes using either the IP address in the web -// request origin or, if you specify it, the address in the geo match -// ForwardedIPConfig. If you use the web request origin, the label formats are -// awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:. If you use a -// forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and -// awswaf:forwardedip:geo:country:. For additional details, see Geographic match -// rule statement -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) -// in the WAF Developer Guide -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). +// WAF labels requests using the alpha-2 country and region codes from the +// International Organization for Standardization (ISO) 3166 standard. WAF +// determines the codes using either the IP address in the web request origin or, +// if you specify it, the address in the geo match ForwardedIPConfig . If you use +// the web request origin, the label formats are awswaf:clientip:geo:region:- and +// awswaf:clientip:geo:country: . If you use a forwarded IP address, the label +// formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country: +// . For additional details, see Geographic match rule statement (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) +// in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) +// . type GeoMatchStatement struct { // An array of two-character country codes that you want to match against, for - // example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 + // example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 // international standard. When you use a geo match statement just for the region // and country labels that it adds to requests, you still have to supply a country // code for the rule to evaluate. In this case, you configure the rule to only @@ -856,9 +797,9 @@ type GeoMatchStatement struct { noSmithyDocumentSerde } -// The filter to use to identify the subset of headers to inspect in a web request. -// You must specify exactly one setting: either All, IncludedHeaders, or -// ExcludedHeaders. Example JSON: "MatchPattern": { "ExcludedHeaders": +// The filter to use to identify the subset of headers to inspect in a web +// request. You must specify exactly one setting: either All , IncludedHeaders , or +// ExcludedHeaders . Example JSON: "MatchPattern": { "ExcludedHeaders": // {"KeyToExclude1", "KeyToExclude2"} } type HeaderMatchPattern struct { @@ -876,25 +817,25 @@ type HeaderMatchPattern struct { noSmithyDocumentSerde } -// Inspect all headers in the web request. You can specify the parts of the headers -// to inspect and you can narrow the set of headers to inspect by including or -// excluding specific keys. This is used to indicate the web request component to -// inspect, in the FieldToMatch specification. If you want to inspect just the -// value of a single header, use the SingleHeaderFieldToMatch setting instead. +// Inspect all headers in the web request. You can specify the parts of the +// headers to inspect and you can narrow the set of headers to inspect by including +// or excluding specific keys. This is used to indicate the web request component +// to inspect, in the FieldToMatch specification. If you want to inspect just the +// value of a single header, use the SingleHeader FieldToMatch setting instead. // Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", // "OversizeHandling": "MATCH" } type Headers struct { - // The filter to use to identify the subset of headers to inspect in a web request. - // You must specify exactly one setting: either All, IncludedHeaders, or - // ExcludedHeaders. Example JSON: "MatchPattern": { "ExcludedHeaders": + // The filter to use to identify the subset of headers to inspect in a web + // request. You must specify exactly one setting: either All , IncludedHeaders , or + // ExcludedHeaders . Example JSON: "MatchPattern": { "ExcludedHeaders": // {"KeyToExclude1", "KeyToExclude2"} } // // This member is required. MatchPattern *HeaderMatchPattern // The parts of the headers to match with the rule inspection criteria. If you - // specify All, WAF inspects both keys and values. + // specify All , WAF inspects both keys and values. // // This member is required. MatchScope MapMatchScope @@ -904,16 +845,11 @@ type Headers struct { // when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host // service forwards a maximum of 200 headers and at most 8 KB of header contents to // WAF. The options for oversize handling are the following: - // - // * CONTINUE - Inspect - // the headers normally, according to the rule inspection criteria. - // - // * MATCH - - // Treat the web request as matching the rule statement. WAF applies the rule - // action to the request. - // - // * NO_MATCH - Treat the web request as not matching the - // rule statement. + // - CONTINUE - Inspect the headers normally, according to the rule inspection + // criteria. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. OversizeHandling OversizeHandling @@ -921,7 +857,7 @@ type Headers struct { noSmithyDocumentSerde } -// Part of the response from GetSampledRequests. This is a complex type that +// Part of the response from GetSampledRequests . This is a complex type that // appears as Headers in the response syntax. HTTPHeader contains the names and // values of all of the headers that appear in one of the web requests. type HTTPHeader struct { @@ -935,7 +871,7 @@ type HTTPHeader struct { noSmithyDocumentSerde } -// Part of the response from GetSampledRequests. This is a complex type that +// Part of the response from GetSampledRequests . This is a complex type that // appears as Request in the response syntax. HTTPRequest contains information // about one of the web requests. type HTTPRequest struct { @@ -943,20 +879,18 @@ type HTTPRequest struct { // The IP address that the request originated from. If the web ACL is associated // with a CloudFront distribution, this is the value of one of the following fields // in CloudFront access logs: - // - // * c-ip, if the viewer did not use an HTTP proxy or a - // load balancer to send the request - // - // * x-forwarded-for, if the viewer did use an - // HTTP proxy or a load balancer to send the request + // - c-ip , if the viewer did not use an HTTP proxy or a load balancer to send + // the request + // - x-forwarded-for , if the viewer did use an HTTP proxy or a load balancer to + // send the request ClientIP *string // The two-letter country code for the country that the request originated from. - // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 - // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + // . Country *string - // The HTTP version specified in the sampled web request, for example, HTTP/1.1. + // The HTTP version specified in the sampled web request, for example, HTTP/1.1 . HTTPVersion *string // A complex type that contains the name and value for each header in the sampled @@ -967,7 +901,7 @@ type HTTPRequest struct { Method *string // The URI path of the request, which identifies the resource, for example, - // /images/daily-ad.jpg. + // /images/daily-ad.jpg . URI *string noSmithyDocumentSerde @@ -991,10 +925,9 @@ type ImmunityTimeProperty struct { // Contains zero or more IP addresses or blocks of IP addresses specified in // Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 // CIDR ranges except for /0. For information about CIDR notation, see the -// Wikipedia entry Classless Inter-Domain Routing -// (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). WAF assigns an -// ARN to each IPSet that you create. To use an IP set in a rule, you provide the -// ARN to the Rule statement IPSetReferenceStatement. +// Wikipedia entry Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) +// . WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, +// you provide the ARN to the Rule statement IPSetReferenceStatement . type IPSet struct { // The Amazon Resource Name (ARN) of the entity. @@ -1005,46 +938,31 @@ type IPSet struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses. All addresses must be specified using Classless Inter-Domain // Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for - // /0. Example address strings: - // - // * To configure WAF to allow, block, or count - // requests that originated from the IP address 192.0.2.44, specify - // 192.0.2.44/32. - // - // * To configure WAF to allow, block, or count requests that - // originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify - // 192.0.2.0/24. - // - // * To configure WAF to allow, block, or count requests that - // originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify - // 1111:0000:0000:0000:0000:0000:0000:0111/128. - // - // * To configure WAF to allow, - // block, or count requests that originated from IP addresses - // 1111:0000:0000:0000:0000:0000:0000:0000 to - // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify - // 1111:0000:0000:0000:0000:0000:0000:0000/64. - // - // For more information about CIDR - // notation, see the Wikipedia entry Classless Inter-Domain Routing - // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Example JSON - // Addresses specifications: - // - // * Empty array: "Addresses": [] - // - // * Array with one - // address: "Addresses": ["192.0.2.44/32"] - // - // * Array with three addresses: - // "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] - // - // * INVALID - // specification: "Addresses": [""] INVALID + // /0 . Example address strings: + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 192.0.2.44, specify 192.0.2.44/32 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . + // - To configure WAF to allow, block, or count requests that originated from + // the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify + // 1111:0000:0000:0000:0000:0000:0000:0111/128 . + // - To configure WAF to allow, block, or count requests that originated from IP + // addresses 1111:0000:0000:0000:0000:0000:0000:0000 to + // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify + // 1111:0000:0000:0000:0000:0000:0000:0000/64 . + // For more information about CIDR notation, see the Wikipedia entry Classless + // Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + // . Example JSON Addresses specifications: + // - Empty array: "Addresses": [] + // - Array with one address: "Addresses": ["192.0.2.44/32"] + // - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", + // "192.0.0.0/16"] + // - INVALID specification: "Addresses": [""] INVALID // // This member is required. Addresses []string - // The version of the IP addresses, either IPV4 or IPV6. + // The version of the IP addresses, either IPV4 or IPV6 . // // This member is required. IPAddressVersion IPAddressVersion @@ -1072,26 +990,23 @@ type IPSet struct { // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, WAF // doesn't apply the rule to the web request at all. This configuration is used -// only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, -// use ForwardedIPConfig instead. +// only for IPSetReferenceStatement . For GeoMatchStatement and RateBasedStatement +// , use ForwardedIPConfig instead. type IPSetForwardedIPConfig struct { // The match status to assign to the web request if the request doesn't have a // valid IP address in the specified position. If the specified header isn't // present in the request, WAF doesn't apply the rule to the web request at all. // You can specify the following fallback behaviors: - // - // * MATCH - Treat the web - // request as matching the rule statement. WAF applies the rule action to the - // request. - // - // * NO_MATCH - Treat the web request as not matching the rule statement. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. FallbackBehavior FallbackBehavior // The name of the HTTP header to use for the IP address. For example, to use the - // X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified + // X-Forwarded-For (XFF) header, set this to X-Forwarded-For . If the specified // header isn't present in the request, WAF doesn't apply the rule to the web // request at all. // @@ -1103,17 +1018,12 @@ type IPSetForwardedIPConfig struct { // value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address // identifies the original client and the rest identify proxies that the request // went through. The options for this setting are the following: - // - // * FIRST - Inspect - // the first IP address in the list of IP addresses in the header. This is usually - // the client's original IP. - // - // * LAST - Inspect the last IP address in the list of - // IP addresses in the header. - // - // * ANY - Inspect all IP addresses in the header for - // a match. If the header contains more than 10 IP addresses, WAF inspects the last - // 10. + // - FIRST - Inspect the first IP address in the list of IP addresses in the + // header. This is usually the client's original IP. + // - LAST - Inspect the last IP address in the list of IP addresses in the + // header. + // - ANY - Inspect all IP addresses in the header for a match. If the header + // contains more than 10 IP addresses, WAF inspects the last 10. // // This member is required. Position ForwardedIPPosition @@ -1121,12 +1031,12 @@ type IPSetForwardedIPConfig struct { noSmithyDocumentSerde } -// A rule statement used to detect web requests coming from particular IP addresses -// or address ranges. To use this, create an IPSet that specifies the addresses you -// want to detect, then use the ARN of that set in this statement. To create an IP -// set, see CreateIPSet. Each IP set rule statement references an IP set. You -// create and maintain the set independent of your rules. This allows you to use -// the single set in multiple rules. When you update the referenced set, WAF +// A rule statement used to detect web requests coming from particular IP +// addresses or address ranges. To use this, create an IPSet that specifies the +// addresses you want to detect, then use the ARN of that set in this statement. To +// create an IP set, see CreateIPSet . Each IP set rule statement references an IP +// set. You create and maintain the set independent of your rules. This allows you +// to use the single set in multiple rules. When you update the referenced set, WAF // automatically updates all rules that reference it. type IPSetReferenceStatement struct { @@ -1145,10 +1055,10 @@ type IPSetReferenceStatement struct { noSmithyDocumentSerde } -// High-level information about an IPSet, returned by operations like create and +// High-level information about an IPSet , returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and -// manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to -// use the address set in a Rule. +// manage an IPSet , and the ARN, that you provide to the IPSetReferenceStatement +// to use the address set in a Rule . type IPSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -1164,10 +1074,10 @@ type IPSetSummary struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The name of the IP set. You cannot change the name of an IPSet after you create @@ -1192,40 +1102,29 @@ type JsonBody struct { // This member is required. MatchPattern *JsonMatchPattern - // The parts of the JSON to match against using the MatchPattern. If you specify - // All, WAF matches against keys and values. + // The parts of the JSON to match against using the MatchPattern . If you specify + // All , WAF matches against keys and values. // // This member is required. MatchScope JsonMatchScope // What WAF should do if it fails to completely parse the JSON body. The options // are the following: - // - // * EVALUATE_AS_STRING - Inspect the body as plain text. WAF - // applies the text transformations and inspection criteria that you defined for - // the JSON inspection to the body text string. - // - // * MATCH - Treat the web request as - // matching the rule statement. WAF applies the rule action to the request. - // - // * - // NO_MATCH - Treat the web request as not matching the rule statement. - // - // If you - // don't provide this setting, WAF parses and evaluates the content only up to the - // first parsing failure that it encounters. WAF does its best to parse the entire - // JSON body, but might be forced to stop for reasons such as invalid characters, - // duplicate keys, truncation, and any content whose root node isn't an object or - // an array. WAF parses the JSON in the following examples as two valid key, value - // pairs: - // - // * Missing comma: {"key1":"value1""key2":"value2"} - // - // * Missing colon: - // {"key1":"value1","key2""value2"} - // - // * Extra colons: - // {"key1"::"value1","key2""value2"} + // - EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text + // transformations and inspection criteria that you defined for the JSON inspection + // to the body text string. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. + // If you don't provide this setting, WAF parses and evaluates the content only up + // to the first parsing failure that it encounters. WAF does its best to parse the + // entire JSON body, but might be forced to stop for reasons such as invalid + // characters, duplicate keys, truncation, and any content whose root node isn't an + // object or an array. WAF parses the JSON in the following examples as two valid + // key, value pairs: + // - Missing comma: {"key1":"value1""key2":"value2"} + // - Missing colon: {"key1":"value1","key2""value2"} + // - Extra colons: {"key1"::"value1","key2""value2"} InvalidFallbackBehavior BodyParsingFallbackBehavior // What WAF should do if the body is larger than WAF can inspect. WAF does not @@ -1233,20 +1132,14 @@ type JsonBody struct { // body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are // forwarded to WAF by the underlying host service. The options for oversize // handling are the following: - // - // * CONTINUE - Inspect the body normally, according - // to the rule inspection criteria. - // - // * MATCH - Treat the web request as matching - // the rule statement. WAF applies the rule action to the request. - // - // * NO_MATCH - - // Treat the web request as not matching the rule statement. - // - // You can combine the - // MATCH or NO_MATCH settings for oversize handling with your rule and web ACL - // action settings, so that you block any request whose body is over 8 KB. Default: - // CONTINUE + // - CONTINUE - Inspect the body normally, according to the rule inspection + // criteria. + // - MATCH - Treat the web request as matching the rule statement. WAF applies + // the rule action to the request. + // - NO_MATCH - Treat the web request as not matching the rule statement. + // You can combine the MATCH or NO_MATCH settings for oversize handling with your + // rule and web ACL action settings, so that you block any request whose body is + // over 8 KB. Default: CONTINUE OversizeHandling OversizeHandling noSmithyDocumentSerde @@ -1254,28 +1147,28 @@ type JsonBody struct { // The patterns to look for in the JSON body. WAF inspects the results of these // pattern matches against the rule inspection criteria. This is used with the -// FieldToMatch option JsonBody. +// FieldToMatch option JsonBody . type JsonMatchPattern struct { - // Match all of the elements. See also MatchScope in JsonBody. You must specify + // Match all of the elements. See also MatchScope in JsonBody . You must specify // either this setting or the IncludedPaths setting, but not both. All *All - // Match only the specified include paths. See also MatchScope in JsonBody. Provide - // the include paths using JSON Pointer syntax. For example, "IncludedPaths": - // ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the - // Internet Engineering Task Force (IETF) documentation JavaScript Object Notation - // (JSON) Pointer (https://tools.ietf.org/html/rfc6901). You must specify either - // this setting or the All setting, but not both. Don't use this option to include - // all paths. Instead, use the All setting. + // Match only the specified include paths. See also MatchScope in JsonBody . + // Provide the include paths using JSON Pointer syntax. For example, + // "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] . For information about this + // syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript + // Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901) . You must + // specify either this setting or the All setting, but not both. Don't use this + // option to include all paths. Instead, use the All setting. IncludedPaths []string noSmithyDocumentSerde } // A single label container. This is used as an element of a label array in -// multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside -// a SampledHTTPRequest. +// multiple contexts, for example, in RuleLabels inside a Rule and in Labels +// inside a SampledHTTPRequest . type Label struct { // The label string. @@ -1286,8 +1179,8 @@ type Label struct { noSmithyDocumentSerde } -// A rule statement to match against labels that have been added to the web request -// by rules that have already run in the web ACL. The label match statement +// A rule statement to match against labels that have been added to the web +// request by rules that have already run in the web ACL. The label match statement // provides the label or namespace string to search for. The label string can // represent a part or all of the fully qualified label name that had been added to // the web request. Fully qualified labels have a prefix, optional namespaces, and @@ -1299,19 +1192,14 @@ type LabelMatchStatement struct { // The string to match against. The setting you provide for this depends on the // match statement's Scope setting: - // - // * If the Scope indicates LABEL, then this - // specification must include the name and can include any number of preceding - // namespace specifications and prefix up to providing the fully qualified label - // name. - // - // * If the Scope indicates NAMESPACE, then this specification can include - // any number of contiguous namespace strings, and can include the entire label - // namespace prefix from the rule group or web ACL where the label - // originates. - // - // Labels are case sensitive and components of a label must be - // separated by colon, for example NS1:NS2:name. + // - If the Scope indicates LABEL , then this specification must include the name + // and can include any number of preceding namespace specifications and prefix up + // to providing the fully qualified label name. + // - If the Scope indicates NAMESPACE , then this specification can include any + // number of contiguous namespace strings, and can include the entire label + // namespace prefix from the rule group or web ACL where the label originates. + // Labels are case sensitive and components of a label must be separated by colon, + // for example NS1:NS2:name . // // This member is required. Key *string @@ -1338,16 +1226,12 @@ type LabelNameCondition struct { noSmithyDocumentSerde } -// List of labels used by one or more of the rules of a RuleGroup. This summary +// List of labels used by one or more of the rules of a RuleGroup . This summary // object is used for the following rule group lists: -// -// * AvailableLabels - Labels -// that rules add to matching requests. These labels are defined in the RuleLabels -// for a Rule. -// -// * ConsumedLabels - Labels that rules match against. These labels -// are defined in a LabelMatchStatement specification, in the Statement definition -// of a rule. +// - AvailableLabels - Labels that rules add to matching requests. These labels +// are defined in the RuleLabels for a Rule . +// - ConsumedLabels - Labels that rules match against. These labels are defined +// in a LabelMatchStatement specification, in the Statement definition of a rule. type LabelSummary struct { // An individual label specification. @@ -1362,29 +1246,24 @@ type LabelSummary struct { // that you log only a subset of the logging records. You can define one logging // destination per web ACL. You can access information about the traffic that WAF // inspects using the following steps: +// - Create your logging destination. You can use an Amazon CloudWatch Logs log +// group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis +// Data Firehose. The name that you give the destination must start with +// aws-waf-logs- . Depending on the type of destination, you might need to +// configure additional settings or permissions. For configuration requirements and +// pricing information for each destination type, see Logging web ACL traffic (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the WAF Developer Guide. +// - Associate your logging destination to your web ACL using a +// PutLoggingConfiguration request. // -// * Create your logging destination. You can -// use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service -// (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. The name that you give -// the destination must start with aws-waf-logs-. Depending on the type of -// destination, you might need to configure additional settings or permissions. For -// configuration requirements and pricing information for each destination type, -// see Logging web ACL traffic -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF -// Developer Guide. -// -// * Associate your logging destination to your web ACL using a -// PutLoggingConfiguration request. -// -// When you successfully enable logging using a -// PutLoggingConfiguration request, WAF creates an additional role or policy that -// is required to write logs to the logging destination. For an Amazon CloudWatch -// Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 -// bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF -// creates a service-linked role. For additional information about web ACL logging, -// see Logging web ACL traffic information -// (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF -// Developer Guide. +// When you successfully enable logging using a PutLoggingConfiguration request, +// WAF creates an additional role or policy that is required to write logs to the +// logging destination. For an Amazon CloudWatch Logs log group, WAF creates a +// resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket +// policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role. +// For additional information about web ACL logging, see Logging web ACL traffic +// information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) +// in the WAF Developer Guide. type LoggingConfiguration struct { // The logging destination configuration that you want to associate with the web @@ -1394,7 +1273,7 @@ type LoggingConfiguration struct { LogDestinationConfigs []string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with - // LogDestinationConfigs. + // LogDestinationConfigs . // // This member is required. ResourceArn *string @@ -1410,16 +1289,16 @@ type LoggingConfiguration struct { ManagedByFirewallManager bool // The parts of the request that you want to keep out of the logs. For example, if - // you redact the SingleHeader field, the HEADER field in the logs will be - // REDACTED. You can specify only the following fields for redaction: UriPath, - // QueryString, SingleHeader, Method, and JsonBody. + // you redact the SingleHeader field, the HEADER field in the logs will be REDACTED + // . You can specify only the following fields for redaction: UriPath , QueryString + // , SingleHeader , Method , and JsonBody . RedactedFields []FieldToMatch noSmithyDocumentSerde } // Filtering that specifies which web requests are kept in the logs and which are -// dropped, defined for a web ACL's LoggingConfiguration. You can filter on the +// dropped, defined for a web ACL's LoggingConfiguration . You can filter on the // rule action and on the web request labels that were applied by matching rules // during web ACL evaluation. type LoggingFilter struct { @@ -1445,54 +1324,50 @@ type LoggingFilter struct { // to accept or reject from the client. Use the AWSManagedRulesBotControlRuleSet // configuration object to configure the protection level that you want the Bot // Control rule group to use. For example specifications, see the examples section -// of CreateWebACL. +// of CreateWebACL . type ManagedRuleGroupConfig struct { - // Additional configuration for using the account takeover prevention (ATP) managed - // rule group, AWSManagedRulesATPRuleSet. Use this to provide login request - // information to the rule group. For web ACLs that protect CloudFront + // Additional configuration for using the account takeover prevention (ATP) + // managed rule group, AWSManagedRulesATPRuleSet . Use this to provide login + // request information to the rule group. For web ACLs that protect CloudFront // distributions, use this to also provide the information about how your // distribution responds to login requests. This configuration replaces the // individual configuration fields in ManagedRuleGroupConfig and provides // additional feature configuration. For information about using the ATP managed - // rule group, see WAF Fraud Control account takeover prevention (ATP) rule group - // (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html) - // and WAF Fraud Control account takeover prevention (ATP) - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html) in the WAF - // Developer Guide. + // rule group, see WAF Fraud Control account takeover prevention (ATP) rule group (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html) + // and WAF Fraud Control account takeover prevention (ATP) (https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html) + // in the WAF Developer Guide. AWSManagedRulesATPRuleSet *AWSManagedRulesATPRuleSet // Additional configuration for using the Bot Control managed rule group. Use this // to specify the inspection level that you want to use. For information about - // using the Bot Control managed rule group, see WAF Bot Control rule group - // (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) - // and WAF Bot Control - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) in - // the WAF Developer Guide. + // using the Bot Control managed rule group, see WAF Bot Control rule group (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) + // and WAF Bot Control (https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) + // in the WAF Developer Guide. AWSManagedRulesBotControlRuleSet *AWSManagedRulesBotControlRuleSet // Instead of this setting, provide your configuration under - // AWSManagedRulesATPRuleSet. + // AWSManagedRulesATPRuleSet . // // Deprecated: Deprecated. Use AWSManagedRulesATPRuleSet LoginPath LoginPath *string // Instead of this setting, provide your configuration under - // AWSManagedRulesATPRuleSetRequestInspection. + // AWSManagedRulesATPRuleSet RequestInspection . // // Deprecated: Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection // PasswordField PasswordField *PasswordField // Instead of this setting, provide your configuration under - // AWSManagedRulesATPRuleSetRequestInspection. + // AWSManagedRulesATPRuleSet RequestInspection . // // Deprecated: Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection // PayloadType PayloadType PayloadType // Instead of this setting, provide your configuration under - // AWSManagedRulesATPRuleSetRequestInspection. + // AWSManagedRulesATPRuleSet RequestInspection . // // Deprecated: Deprecated. Use AWSManagedRulesATPRuleSet RequestInspection // UsernameField @@ -1501,20 +1376,20 @@ type ManagedRuleGroupConfig struct { noSmithyDocumentSerde } -// A rule statement used to run the rules that are defined in a managed rule group. -// To use this, provide the vendor name and the name of the rule group in this -// statement. You can retrieve the required names by calling -// ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for -// example for use inside a NotStatement or OrStatement. It can only be referenced -// as a top-level statement within a rule. You are charged additional fees when you -// use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or -// the WAF Fraud Control account takeover prevention (ATP) managed rule group -// AWSManagedRulesATPRuleSet. For more information, see WAF Pricing -// (http://aws.amazon.com/waf/pricing/). +// A rule statement used to run the rules that are defined in a managed rule +// group. To use this, provide the vendor name and the name of the rule group in +// this statement. You can retrieve the required names by calling +// ListAvailableManagedRuleGroups . You cannot nest a ManagedRuleGroupStatement , +// for example for use inside a NotStatement or OrStatement . It can only be +// referenced as a top-level statement within a rule. You are charged additional +// fees when you use the WAF Bot Control managed rule group +// AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover +// prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more +// information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) . type ManagedRuleGroupStatement struct { - // The name of the managed rule group. You use this, along with the vendor name, to - // identify the rule group. + // The name of the managed rule group. You use this, along with the vendor name, + // to identify the rule group. // // This member is required. Name *string @@ -1525,9 +1400,9 @@ type ManagedRuleGroupStatement struct { // This member is required. VendorName *string - // Rules in the referenced rule group whose actions are set to Count. Instead of - // this option, use RuleActionOverrides. It accepts any valid action setting, - // including Count. + // Rules in the referenced rule group whose actions are set to Count . Instead of + // this option, use RuleActionOverrides . It accepts any valid action setting, + // including Count . ExcludedRules []ExcludedRule // Additional information that's used by a managed rule group. Many managed rule @@ -1548,8 +1423,8 @@ type ManagedRuleGroupStatement struct { // your web traffic. RuleActionOverrides []RuleActionOverride - // An optional nested statement that narrows the scope of the web requests that are - // evaluated by the managed rule group. Requests are only evaluated by the rule + // An optional nested statement that narrows the scope of the web requests that + // are evaluated by the managed rule group. Requests are only evaluated by the rule // group if they match the scope-down statement. You can use any nestable Statement // in the scope-down statement, and you can nest statements at any level, the same // as you can for a rule statement. @@ -1565,7 +1440,7 @@ type ManagedRuleGroupStatement struct { } // High-level information about a managed rule group, returned by -// ListAvailableManagedRuleGroups. This provides information like the name and +// ListAvailableManagedRuleGroups . This provides information like the name and // vendor name, that you provide when you add a ManagedRuleGroupStatement to a web // ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, // which are free of charge to WAF customers, and Amazon Web Services Marketplace @@ -1577,8 +1452,8 @@ type ManagedRuleGroupSummary struct { // Managed Rules or the Amazon Web Services Marketplace seller who manages it. Description *string - // The name of the managed rule group. You use this, along with the vendor name, to - // identify the rule group. + // The name of the managed rule group. You use this, along with the vendor name, + // to identify the rule group. Name *string // The name of the managed rule group vendor. You use this, along with the rule @@ -1586,7 +1461,7 @@ type ManagedRuleGroupSummary struct { VendorName *string // Indicates whether the managed rule group is versioned. If it is, you can - // retrieve the versions list by calling ListAvailableManagedRuleGroupVersions. + // retrieve the versions list by calling ListAvailableManagedRuleGroupVersions . VersioningSupported bool noSmithyDocumentSerde @@ -1611,8 +1486,8 @@ type ManagedRuleGroupVersion struct { // Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you // can use the managed rule set APIs to provide controlled rollout of your // versioned managed rule group offerings for your customers. The APIs are -// ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and -// UpdateManagedRuleSetVersionExpiryDate. +// ListManagedRuleSets , GetManagedRuleSet , PutManagedRuleSetVersions , and +// UpdateManagedRuleSetVersionExpiryDate . type ManagedRuleSet struct { // The Amazon Resource Name (ARN) of the entity. @@ -1621,8 +1496,8 @@ type ManagedRuleSet struct { ARN *string // A unique identifier for the managed rule set. The ID is returned in the - // responses to commands like list. You provide it to operations like get and - // update. + // responses to commands like list . You provide it to operations like get and + // update . // // This member is required. Id *string @@ -1640,15 +1515,12 @@ type ManagedRuleSet struct { // The label namespace prefix for the managed rule groups that are offered to // customers from this managed rule set. All labels that are added by rules in the // managed rule group have this prefix. - // - // * The syntax for the label namespace - // prefix for a managed rule group is the following: awswaf:managed::: - // - // * When a - // rule with a label matches a web request, WAF adds the fully qualified label to - // the request. A fully qualified label is made up of the label namespace from the - // rule group or web ACL where the rule is defined and the label from the rule, - // separated by a colon: : + // - The syntax for the label namespace prefix for a managed rule group is the + // following: awswaf:managed:: : + // - When a rule with a label matches a web request, WAF adds the fully + // qualified label to the request. A fully qualified label is made up of the label + // namespace from the rule group or web ACL where the rule is defined and the label + // from the rule, separated by a colon: : LabelNamespace *string // The versions of this managed rule set that are available for use by customers. @@ -1664,8 +1536,8 @@ type ManagedRuleSet struct { // vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web // Services Marketplace sellers. Vendors, you can use the managed rule set APIs to // provide controlled rollout of your versioned managed rule group offerings for -// your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, -// PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. +// your customers. The APIs are ListManagedRuleSets , GetManagedRuleSet , +// PutManagedRuleSetVersions , and UpdateManagedRuleSetVersionExpiryDate . type ManagedRuleSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -1675,31 +1547,28 @@ type ManagedRuleSetSummary struct { Description *string // A unique identifier for the managed rule set. The ID is returned in the - // responses to commands like list. You provide it to operations like get and - // update. + // responses to commands like list . You provide it to operations like get and + // update . Id *string // The label namespace prefix for the managed rule groups that are offered to // customers from this managed rule set. All labels that are added by rules in the // managed rule group have this prefix. - // - // * The syntax for the label namespace - // prefix for a managed rule group is the following: awswaf:managed::: - // - // * When a - // rule with a label matches a web request, WAF adds the fully qualified label to - // the request. A fully qualified label is made up of the label namespace from the - // rule group or web ACL where the rule is defined and the label from the rule, - // separated by a colon: : + // - The syntax for the label namespace prefix for a managed rule group is the + // following: awswaf:managed:: : + // - When a rule with a label matches a web request, WAF adds the fully + // qualified label to the request. A fully qualified label is made up of the label + // namespace from the rule group or web ACL where the rule is defined and the label + // from the rule, separated by a colon: : LabelNamespace *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to @@ -1710,25 +1579,27 @@ type ManagedRuleSetSummary struct { noSmithyDocumentSerde } -// Information for a single version of a managed rule set. This is intended for use -// only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon -// Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs -// to provide controlled rollout of your versioned managed rule group offerings for -// your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, -// PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. +// Information for a single version of a managed rule set. This is intended for +// use only by vendors of managed rule sets. Vendors are Amazon Web Services and +// Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule +// set APIs to provide controlled rollout of your versioned managed rule group +// offerings for your customers. The APIs are ListManagedRuleSets , +// GetManagedRuleSet , PutManagedRuleSetVersions , and +// UpdateManagedRuleSetVersionExpiryDate . type ManagedRuleSetVersion struct { // The Amazon Resource Name (ARN) of the vendor rule group that's used to define // the published version of your managed rule group. AssociatedRuleGroupArn *string - // The web ACL capacity units (WCUs) required for this rule group. WAF uses WCUs to - // calculate and control the operating resources that are used to run your rules, - // rule groups, and web ACLs. WAF calculates capacity differently for each rule - // type, to reflect the relative cost of each rule. Simple rules that cost little - // to run use fewer WCUs than more complex rules that use more processing power. - // Rule group capacity is fixed at creation, which helps users plan their web ACL - // WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. + // The web ACL capacity units (WCUs) required for this rule group. WAF uses WCUs + // to calculate and control the operating resources that are used to run your + // rules, rule groups, and web ACLs. WAF calculates capacity differently for each + // rule type, to reflect the relative cost of each rule. Simple rules that cost + // little to run use fewer WCUs than more complex rules that use more processing + // power. Rule group capacity is fixed at creation, which helps users plan their + // web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is + // 1,500. Capacity int64 // The time that this version is set to expire. Times are in Coordinated Universal @@ -1765,8 +1636,7 @@ type Method struct { // The mobile SDK is not generally available. Customers who have access to the // mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) // requests from a mobile device to WAF. For more information, see WAF client -// application integration -// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) +// application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. type MobileSdkRelease struct { @@ -1788,13 +1658,13 @@ type MobileSdkRelease struct { // Specifies that WAF should do nothing. This is used for the OverrideAction // setting on a Rule when the rule uses a rule group reference statement. This is // used in the context of other settings, for example to specify values for -// RuleAction and web ACL DefaultAction. JSON specification: "None": {} +// RuleAction and web ACL DefaultAction . JSON specification: "None": {} type NoneAction struct { noSmithyDocumentSerde } // A logical rule statement used to negate the results of another rule statement. -// You provide one Statement within the NotStatement. +// You provide one Statement within the NotStatement . type NotStatement struct { // The statement to negate. You can use any statement that can be nested. @@ -1806,7 +1676,7 @@ type NotStatement struct { } // A logical rule statement used to combine other rule statements with OR logic. -// You provide more than one Statement within the OrStatement. +// You provide more than one Statement within the OrStatement . type OrStatement struct { // The statements to combine with OR logic. You can use any statements that can be @@ -1822,7 +1692,7 @@ type OrStatement struct { // evaluation. Set the override action to none to leave the result of the rule // group alone. Set it to count to override the result to count only. You can only // use this for rule statements that reference a rule group, like -// RuleGroupReferenceStatement and ManagedRuleGroupStatement. This option is +// RuleGroupReferenceStatement and ManagedRuleGroupStatement . This option is // usually set to none. It does not affect how the rules in the rule group are // evaluated. If you want the rules in the rule group to only count matches, do not // use this and instead use the rule action override option, with Count action, in @@ -1832,8 +1702,8 @@ type OverrideAction struct { // Override the rule group evaluation result to count only. This option is usually // set to none. It does not affect how the rules in the rule group are evaluated. // If you want the rules in the rule group to only count matches, do not use this - // and instead use the rule action override option, with Count action, in your rule - // group reference statement settings. + // and instead use the rule action override option, with Count action, in your + // rule group reference statement settings. Count *CountAction // Don't override the rule group evaluation result. This is the most common @@ -1843,11 +1713,11 @@ type OverrideAction struct { noSmithyDocumentSerde } -// Details about your login page password field for request inspection, used in the -// AWSManagedRulesATPRuleSetRequestInspection configuration. +// Details about your login page password field for request inspection, used in +// the AWSManagedRulesATPRuleSet RequestInspection configuration. type PasswordField struct { - // The name of the password field. For example /form/password. + // The name of the password field. For example /form/password . // // This member is required. Identifier *string @@ -1881,39 +1751,33 @@ type QueryString struct { // on recent requests that you have seen from an attacker, you might create a // rate-based rule with a nested AND rule statement that contains the following // nested statements: +// - An IP match statement with an IP set that specifies the address 192.0.2.44. +// - A string match statement that searches in the User-Agent header for the +// string BadBot. // -// * An IP match statement with an IP set that specifies the -// address 192.0.2.44. -// -// * A string match statement that searches in the User-Agent -// header for the string BadBot. -// -// In this rate-based rule, you also define a rate -// limit. For this example, the rate limit is 1,000. Requests that meet the -// criteria of both of the nested statements are counted. If the count exceeds -// 1,000 requests per five minutes, the rule action triggers. Requests that do not -// meet the criteria of both of the nested statements are not counted towards the -// rate limit and are not affected by this rule. You cannot nest a -// RateBasedStatement inside another statement, for example inside a NotStatement -// or OrStatement. You can define a RateBasedStatement inside a web ACL and inside -// a rule group. +// In this rate-based rule, you also define a rate limit. For this example, the +// rate limit is 1,000. Requests that meet the criteria of both of the nested +// statements are counted. If the count exceeds 1,000 requests per five minutes, +// the rule action triggers. Requests that do not meet the criteria of both of the +// nested statements are not counted towards the rate limit and are not affected by +// this rule. You cannot nest a RateBasedStatement inside another statement, for +// example inside a NotStatement or OrStatement . You can define a +// RateBasedStatement inside a web ACL and inside a rule group. type RateBasedStatement struct { // Setting that indicates how to aggregate the request counts. The options are the // following: - // - // * IP - Aggregate the request counts on the IP address from the web - // request origin. - // - // * FORWARDED_IP - Aggregate the request counts on the first IP - // address in an HTTP header. If you use this, configure the ForwardedIPConfig, to - // specify the header to use. + // - IP - Aggregate the request counts on the IP address from the web request + // origin. + // - FORWARDED_IP - Aggregate the request counts on the first IP address in an + // HTTP header. If you use this, configure the ForwardedIPConfig , to specify the + // header to use. // // This member is required. AggregateKeyType RateBasedStatementAggregateKeyType // The limit on requests per 5-minute period for a single originating IP address. - // If the statement includes a ScopeDownStatement, this limit is applied only to + // If the statement includes a ScopeDownStatement , this limit is applied only to // the requests that match the statement. // // This member is required. @@ -1924,11 +1788,11 @@ type RateBasedStatement struct { // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, WAF // doesn't apply the rule to the web request at all. This is required if - // AggregateKeyType is set to FORWARDED_IP. + // AggregateKeyType is set to FORWARDED_IP . ForwardedIPConfig *ForwardedIPConfig - // An optional nested statement that narrows the scope of the web requests that are - // evaluated by the rate-based statement. Requests are only tracked by the + // An optional nested statement that narrows the scope of the web requests that + // are evaluated by the rate-based statement. Requests are only tracked by the // rate-based statement if they match the scope-down statement. You can use any // nestable Statement in the scope-down statement, and you can nest statements at // any level, the same as you can for a rule statement. @@ -1937,19 +1801,19 @@ type RateBasedStatement struct { noSmithyDocumentSerde } -// The set of IP addresses that are currently blocked for a RateBasedStatement. +// The set of IP addresses that are currently blocked for a RateBasedStatement . type RateBasedStatementManagedKeysIPSet struct { // The IP addresses that are currently blocked. Addresses []string - // The version of the IP addresses, either IPV4 or IPV6. + // The version of the IP addresses, either IPV4 or IPV6 . IPAddressVersion IPAddressVersion noSmithyDocumentSerde } -// A single regular expression. This is used in a RegexPatternSet. +// A single regular expression. This is used in a RegexPatternSet . type Regex struct { // The string representing the regular expression. @@ -1972,10 +1836,10 @@ type RegexMatchStatement struct { // This member is required. RegexString *string - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. @@ -1986,7 +1850,7 @@ type RegexMatchStatement struct { // Contains one or more regular expressions. WAF assigns an ARN to each // RegexPatternSet that you create. To use a set in a rule, you provide the ARN to -// the Rule statement RegexPatternSetReferenceStatement. +// the Rule statement RegexPatternSetReferenceStatement . type RegexPatternSet struct { // The Amazon Resource Name (ARN) of the entity. @@ -2013,7 +1877,7 @@ type RegexPatternSet struct { // expressions that you want to detect, then use the ARN of that set in this // statement. A web request matches the pattern set rule statement if the request // component matches any of the patterns in the set. To create a regex pattern set, -// see CreateRegexPatternSet. Each regex pattern set rule statement references a +// see CreateRegexPatternSet . Each regex pattern set rule statement references a // regex pattern set. You create and maintain the set independent of your rules. // This allows you to use the single set in multiple rules. When you update the // referenced set, WAF automatically updates all rules that reference it. @@ -2030,10 +1894,10 @@ type RegexPatternSetReferenceStatement struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. @@ -2042,10 +1906,10 @@ type RegexPatternSetReferenceStatement struct { noSmithyDocumentSerde } -// High-level information about a RegexPatternSet, returned by operations like +// High-level information about a RegexPatternSet , returned by operations like // create and list. This provides information like the ID, that you can use to -// retrieve and manage a RegexPatternSet, and the ARN, that you provide to the -// RegexPatternSetReferenceStatement to use the pattern set in a Rule. +// retrieve and manage a RegexPatternSet , and the ARN, that you provide to the +// RegexPatternSetReferenceStatement to use the pattern set in a Rule . type RegexPatternSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -2061,10 +1925,10 @@ type RegexPatternSetSummary struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The name of the data type instance. You cannot change the name after you create @@ -2088,27 +1952,24 @@ type ReleaseSummary struct { // The criteria for inspecting login requests, used by the ATP rule group to // validate credentials usage. This is part of the AWSManagedRulesATPRuleSet -// configuration in ManagedRuleGroupConfig. In these settings, you specify how your -// application accepts login attempts by providing the request payload type and the -// names of the fields within the request body where the username and password are -// provided. +// configuration in ManagedRuleGroupConfig . In these settings, you specify how +// your application accepts login attempts by providing the request payload type +// and the names of the fields within the request body where the username and +// password are provided. type RequestInspection struct { // Details about your login page password field. How you specify this depends on // the payload type. - // - // * For JSON payloads, specify the field name in JSON pointer - // syntax. For information about the JSON Pointer syntax, see the Internet - // Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) - // Pointer (https://tools.ietf.org/html/rfc6901). For example, for the JSON payload - // { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the - // username field specification is /login/username and the password field - // specification is /login/password. - // - // * For form encoded payload types, use the - // HTML form names. For example, for an HTML form with input elements named - // username1 and password1, the username field specification is username1 and the - // password field specification is password1. + // - For JSON payloads, specify the field name in JSON pointer syntax. For + // information about the JSON Pointer syntax, see the Internet Engineering Task + // Force (IETF) documentation JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901) + // . For example, for the JSON payload { "login": { "username": "THE_USERNAME", + // "password": "THE_PASSWORD" } } , the username field specification is + // /login/username and the password field specification is /login/password . + // - For form encoded payload types, use the HTML form names. For example, for + // an HTML form with input elements named username1 and password1 , the username + // field specification is username1 and the password field specification is + // password1 . // // This member is required. PasswordField *PasswordField @@ -2120,19 +1981,16 @@ type RequestInspection struct { // Details about your login page username field. How you specify this depends on // the payload type. - // - // * For JSON payloads, specify the field name in JSON pointer - // syntax. For information about the JSON Pointer syntax, see the Internet - // Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) - // Pointer (https://tools.ietf.org/html/rfc6901). For example, for the JSON payload - // { "login": { "username": "THE_USERNAME", "password": "THE_PASSWORD" } }, the - // username field specification is /login/username and the password field - // specification is /login/password. - // - // * For form encoded payload types, use the - // HTML form names. For example, for an HTML form with input elements named - // username1 and password1, the username field specification is username1 and the - // password field specification is password1. + // - For JSON payloads, specify the field name in JSON pointer syntax. For + // information about the JSON Pointer syntax, see the Internet Engineering Task + // Force (IETF) documentation JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901) + // . For example, for the JSON payload { "login": { "username": "THE_USERNAME", + // "password": "THE_PASSWORD" } } , the username field specification is + // /login/username and the password field specification is /login/password . + // - For form encoded payload types, use the HTML form names. For example, for + // an HTML form with input elements named username1 and password1 , the username + // field specification is username1 and the password field specification is + // password1 . // // This member is required. UsernameField *UsernameField @@ -2148,7 +2006,7 @@ type RequestInspection struct { // sessions and IP addresses that submit too many failed login attempts in a short // amount of time. Response inspection is available only in web ACLs that protect // Amazon CloudFront distributions. This is part of the AWSManagedRulesATPRuleSet -// configuration in ManagedRuleGroupConfig. Enable login response inspection by +// configuration in ManagedRuleGroupConfig . Enable login response inspection by // configuring exactly one component of the response to inspect. You can't // configure more than one. If you don't configure any of the response inspection // options, response inspection is disabled. @@ -2173,7 +2031,7 @@ type ResponseInspection struct { // Configures inspection of the response body. WAF can inspect the first 65,536 // bytes (64 KB) of the response body. This is part of the ResponseInspection -// configuration for AWSManagedRulesATPRuleSet. Response inspection is available +// configuration for AWSManagedRulesATPRuleSet . Response inspection is available // only in web ACLs that protect Amazon CloudFront distributions. type ResponseInspectionBodyContains struct { @@ -2185,8 +2043,8 @@ type ResponseInspectionBodyContains struct { // This member is required. FailureStrings []string - // Strings in the body of the response that indicate a successful login attempt. To - // be counted as a successful login, the string can be anywhere in the body and + // Strings in the body of the response that indicate a successful login attempt. + // To be counted as a successful login, the string can be anywhere in the body and // must be an exact match, including case. Each string must be unique among the // success and failure strings. JSON example: "SuccessStrings": [ "Login // successful", "Welcome to our site!" ] @@ -2198,7 +2056,7 @@ type ResponseInspectionBodyContains struct { } // Configures inspection of the response header. This is part of the -// ResponseInspection configuration for AWSManagedRulesATPRuleSet. Response +// ResponseInspection configuration for AWSManagedRulesATPRuleSet . Response // inspection is available only in web ACLs that protect Amazon CloudFront // distributions. type ResponseInspectionHeader struct { @@ -2217,10 +2075,11 @@ type ResponseInspectionHeader struct { // This member is required. Name *string - // Values in the response header with the specified name that indicate a successful - // login attempt. To be counted as a successful login, the value must be an exact - // match, including case. Each value must be unique among the success and failure - // values. JSON example: "SuccessValues": [ "LoginPassed", "Successful login" ] + // Values in the response header with the specified name that indicate a + // successful login attempt. To be counted as a successful login, the value must be + // an exact match, including case. Each value must be unique among the success and + // failure values. JSON example: "SuccessValues": [ "LoginPassed", "Successful + // login" ] // // This member is required. SuccessValues []string @@ -2230,7 +2089,7 @@ type ResponseInspectionHeader struct { // Configures inspection of the response JSON. WAF can inspect the first 65,536 // bytes (64 KB) of the response JSON. This is part of the ResponseInspection -// configuration for AWSManagedRulesATPRuleSet. Response inspection is available +// configuration for AWSManagedRulesATPRuleSet . Response inspection is available // only in web ACLs that protect Amazon CloudFront distributions. type ResponseInspectionJson struct { @@ -2261,15 +2120,15 @@ type ResponseInspectionJson struct { } // Configures inspection of the response status code. This is part of the -// ResponseInspection configuration for AWSManagedRulesATPRuleSet. Response +// ResponseInspection configuration for AWSManagedRulesATPRuleSet . Response // inspection is available only in web ACLs that protect Amazon CloudFront // distributions. type ResponseInspectionStatusCode struct { - // Status codes in the response that indicate a failed login attempt. To be counted - // as a failed login, the response status code must match one of these. Each code - // must be unique among the success and failure status codes. JSON example: - // "FailureCodes": [ 400, 404 ] + // Status codes in the response that indicate a failed login attempt. To be + // counted as a failed login, the response status code must match one of these. + // Each code must be unique among the success and failure status codes. JSON + // example: "FailureCodes": [ 400, 404 ] // // This member is required. FailureCodes []int32 @@ -2296,16 +2155,16 @@ type Rule struct { // This member is required. Name *string - // If you define more than one Rule in a WebACL, WAF evaluates each request against - // the Rules in order based on the value of Priority. WAF processes rules with - // lower priority first. The priorities don't need to be consecutive, but they must - // all be different. + // If you define more than one Rule in a WebACL , WAF evaluates each request + // against the Rules in order based on the value of Priority . WAF processes rules + // with lower priority first. The priorities don't need to be consecutive, but they + // must all be different. // // This member is required. Priority int32 // The WAF processing statement for the rule, for example ByteMatchStatement or - // SizeConstraintStatement. + // SizeConstraintStatement . // // This member is required. Statement *Statement @@ -2319,15 +2178,12 @@ type Rule struct { // statement. Settings at the web ACL level can override the rule action setting. // This is used only for rules whose statements do not reference a rule group. Rule // statements that reference a rule group include RuleGroupReferenceStatement and - // ManagedRuleGroupStatement. You must specify either this Action setting or the + // ManagedRuleGroupStatement . You must specify either this Action setting or the // rule OverrideAction setting, but not both: - // - // * If the rule statement does not - // reference a rule group, use this rule action setting and not the rule override - // action setting. - // - // * If the rule statement references a rule group, use the - // override action setting and not this action setting. + // - If the rule statement does not reference a rule group, use this rule action + // setting and not the rule override action setting. + // - If the rule statement references a rule group, use the override action + // setting and not this action setting. Action *RuleAction // Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, @@ -2342,35 +2198,26 @@ type Rule struct { // evaluation. Set the override action to none to leave the result of the rule // group alone. Set it to count to override the result to count only. You can only // use this for rule statements that reference a rule group, like - // RuleGroupReferenceStatement and ManagedRuleGroupStatement. This option is + // RuleGroupReferenceStatement and ManagedRuleGroupStatement . This option is // usually set to none. It does not affect how the rules in the rule group are // evaluated. If you want the rules in the rule group to only count matches, do not // use this and instead use the rule action override option, with Count action, in // your rule group reference statement settings. OverrideAction *OverrideAction - // Labels to apply to web requests that match the rule match statement. WAF applies - // fully qualified labels to matching web requests. A fully qualified label is the - // concatenation of a label namespace and a rule label. The rule's rule group or - // web ACL defines the label namespace. Rules that run after this rule in the web - // ACL can match against these labels using a LabelMatchStatement. For each label, - // provide a case-sensitive string containing optional namespaces and a label name, - // according to the following guidelines: - // - // * Separate each component of the label - // with a colon. - // - // * Each namespace or name can have up to 128 characters. - // - // * You - // can specify up to 5 namespaces in a label. - // - // * Don't use the following reserved - // words in your label specification: aws, waf, managed, rulegroup, webacl, - // regexpatternset, or ipset. - // - // For example, myLabelName or - // nameSpace1:nameSpace2:myLabelName. + // Labels to apply to web requests that match the rule match statement. WAF + // applies fully qualified labels to matching web requests. A fully qualified label + // is the concatenation of a label namespace and a rule label. The rule's rule + // group or web ACL defines the label namespace. Rules that run after this rule in + // the web ACL can match against these labels using a LabelMatchStatement . For + // each label, provide a case-sensitive string containing optional namespaces and a + // label name, according to the following guidelines: + // - Separate each component of the label with a colon. + // - Each namespace or name can have up to 128 characters. + // - You can specify up to 5 namespaces in a label. + // - Don't use the following reserved words in your label specification: aws , + // waf , managed , rulegroup , webacl , regexpatternset , or ipset . + // For example, myLabelName or nameSpace1:nameSpace2:myLabelName . RuleLabels []Label noSmithyDocumentSerde @@ -2402,14 +2249,14 @@ type RuleAction struct { // Action setting to use in the place of a rule action that is configured inside // the rule group. You specify one override for each rule whose action you want to // change. You can use overrides for testing, for example you can override all of -// rule actions to Count and then monitor the resulting count metrics to understand -// how the rule group would handle your web traffic. You can also permanently -// override some or all actions, to modify how the rule group manages your web -// traffic. +// rule actions to Count and then monitor the resulting count metrics to +// understand how the rule group would handle your web traffic. You can also +// permanently override some or all actions, to modify how the rule group manages +// your web traffic. type RuleActionOverride struct { - // The override action to use, in place of the configured action of the rule in the - // rule group. + // The override action to use, in place of the configured action of the rule in + // the rule group. // // This member is required. ActionToUse *RuleAction @@ -2423,7 +2270,7 @@ type RuleActionOverride struct { } // A rule group defines a collection of rules to inspect and control web requests -// that you can use in a WebACL. When you create a rule group, you define an +// that you can use in a WebACL . When you create a rule group, you define an // immutable capacity limit. If you update a rule group, you must stay within the // capacity. This allows others to reuse the rule group with confidence in its // capacity requirements. @@ -2437,7 +2284,7 @@ type RuleGroup struct { // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, WAF enforces this limit. You - // can check the capacity for a set of rules using CheckCapacity. WAF uses WCUs to + // can check the capacity for a set of rules using CheckCapacity . WAF uses WCUs to // calculate and control the operating resources that are used to run your rules, // rule groups, and web ACLs. WAF calculates capacity differently for each rule // type, to reflect the relative cost of each rule. Simple rules that cost little @@ -2454,8 +2301,8 @@ type RuleGroup struct { // This member is required. Id *string - // The name of the rule group. You cannot change the name of a rule group after you - // create it. + // The name of the rule group. You cannot change the name of a rule group after + // you create it. // // This member is required. Name *string @@ -2466,7 +2313,7 @@ type RuleGroup struct { VisibilityConfig *VisibilityConfig // The labels that one or more rules in this rule group add to matching web - // requests. These labels are defined in the RuleLabels for a Rule. + // requests. These labels are defined in the RuleLabels for a Rule . AvailableLabels []LabelSummary // The labels that one or more rules in this rule group match against in label @@ -2478,15 +2325,12 @@ type RuleGroup struct { // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see - // Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]CustomResponseBody // A description of the rule group that helps with identification. @@ -2494,15 +2338,12 @@ type RuleGroup struct { // The label namespace prefix for this rule group. All labels added by rules in // this rule group have this prefix. - // - // * The syntax for the label namespace prefix - // for your rule groups is the following: awswaf::rulegroup:: - // - // * When a rule with a - // label matches a web request, WAF adds the fully qualified label to the request. - // A fully qualified label is made up of the label namespace from the rule group or - // web ACL where the rule is defined and the label from the rule, separated by a - // colon: : + // - The syntax for the label namespace prefix for your rule groups is the + // following: awswaf::rulegroup:: + // - When a rule with a label matches a web request, WAF adds the fully + // qualified label to the request. A fully qualified label is made up of the label + // namespace from the rule group or web ACL where the rule is defined and the label + // from the rule, separated by a colon: : LabelNamespace *string // The Rule statements used to identify the web requests that you want to allow, @@ -2513,10 +2354,10 @@ type RuleGroup struct { noSmithyDocumentSerde } -// A rule statement used to run the rules that are defined in a RuleGroup. To use +// A rule statement used to run the rules that are defined in a RuleGroup . To use // this, create a rule group with your rules, then provide the ARN of the rule -// group in this statement. You cannot nest a RuleGroupReferenceStatement, for -// example for use inside a NotStatement or OrStatement. You can only use a rule +// group in this statement. You cannot nest a RuleGroupReferenceStatement , for +// example for use inside a NotStatement or OrStatement . You can only use a rule // group reference statement at the top level inside a web ACL. type RuleGroupReferenceStatement struct { @@ -2525,9 +2366,9 @@ type RuleGroupReferenceStatement struct { // This member is required. ARN *string - // Rules in the referenced rule group whose actions are set to Count. Instead of - // this option, use RuleActionOverrides. It accepts any valid action setting, - // including Count. + // Rules in the referenced rule group whose actions are set to Count . Instead of + // this option, use RuleActionOverrides . It accepts any valid action setting, + // including Count . ExcludedRules []ExcludedRule // Action settings to use in the place of the rule actions that are configured @@ -2542,10 +2383,10 @@ type RuleGroupReferenceStatement struct { noSmithyDocumentSerde } -// High-level information about a RuleGroup, returned by operations like create and -// list. This provides information like the ID, that you can use to retrieve and -// manage a RuleGroup, and the ARN, that you provide to the -// RuleGroupReferenceStatement to use the rule group in a Rule. +// High-level information about a RuleGroup , returned by operations like create +// and list. This provides information like the ID, that you can use to retrieve +// and manage a RuleGroup , and the ARN, that you provide to the +// RuleGroupReferenceStatement to use the rule group in a Rule . type RuleGroupSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -2561,10 +2402,10 @@ type RuleGroupSummary struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The name of the data type instance. You cannot change the name after you create @@ -2574,10 +2415,10 @@ type RuleGroupSummary struct { noSmithyDocumentSerde } -// High-level information about a Rule, returned by operations like -// DescribeManagedRuleGroup. This provides information like the ID, that you can -// use to retrieve and manage a RuleGroup, and the ARN, that you provide to the -// RuleGroupReferenceStatement to use the rule group in a Rule. +// High-level information about a Rule , returned by operations like +// DescribeManagedRuleGroup . This provides information like the ID, that you can +// use to retrieve and manage a RuleGroup , and the ARN, that you provide to the +// RuleGroupReferenceStatement to use the rule group in a Rule . type RuleSummary struct { // The action that WAF should take on a web request when it matches a rule's @@ -2603,8 +2444,8 @@ type SampledHTTPRequest struct { // A value that indicates how one result in the response relates proportionally to // other results in the response. For example, a result that has a weight of 2 - // represents roughly twice as many web requests as a result that has a weight of - // 1. + // represents roughly twice as many web requests as a result that has a weight of 1 + // . // // This member is required. Weight int64 @@ -2618,12 +2459,12 @@ type SampledHTTPRequest struct { // The Challenge response for the request. ChallengeResponse *ChallengeResponse - // Labels applied to the web request by matching rules. WAF applies fully qualified - // labels to matching web requests. A fully qualified label is the concatenation of - // a label namespace and a rule label. The rule's rule group or web ACL defines the - // label namespace. For example, + // Labels applied to the web request by matching rules. WAF applies fully + // qualified labels to matching web requests. A fully qualified label is the + // concatenation of a label namespace and a rule label. The rule's rule group or + // web ACL defines the label namespace. For example, // awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or - // awswaf:managed:aws:managed-rule-set:header:encoding:utf8. + // awswaf:managed:aws:managed-rule-set:header:encoding:utf8 . Labels []Label // Used only for rule group rules that have a rule action override in place in the @@ -2632,16 +2473,16 @@ type SampledHTTPRequest struct { // Action value. OverriddenAction *string - // Custom request headers inserted by WAF into the request, according to the custom - // request configuration for the matching rule action. + // Custom request headers inserted by WAF into the request, according to the + // custom request configuration for the matching rule action. RequestHeadersInserted []HTTPHeader // The response code that was sent for the request. ResponseCodeSent *int32 // The name of the Rule that the request matched. For managed rule groups, the - // format for this name is ##. For your own rule groups, the format for this name - // is #. If the rule is not in a rule group, this field is absent. + // format for this name is ## . For your own rule groups, the format for this name + // is # . If the rule is not in a rule group, this field is absent. RuleNameWithinRuleGroup *string // The time at which WAF received the request from your Amazon Web Services @@ -2652,10 +2493,10 @@ type SampledHTTPRequest struct { } // Inspect one of the headers in the web request, identified by name, for example, -// User-Agent or Referer. The name isn't case sensitive. You can filter and inspect -// all headers with the FieldToMatch setting Headers. This is used to indicate the -// web request component to inspect, in the FieldToMatch specification. Example -// JSON: "SingleHeader": { "Name": "haystack" } +// User-Agent or Referer . The name isn't case sensitive. You can filter and +// inspect all headers with the FieldToMatch setting Headers . This is used to +// indicate the web request component to inspect, in the FieldToMatch +// specification. Example JSON: "SingleHeader": { "Name": "haystack" } type SingleHeader struct { // The name of the query header to inspect. @@ -2668,8 +2509,8 @@ type SingleHeader struct { // Inspect one query argument in the web request, identified by name, for example // UserName or SalesRegion. The name isn't case sensitive. This is used to indicate -// the web request component to inspect, in the FieldToMatch specification. Example -// JSON: "SingleQueryArgument": { "Name": "myArgument" } +// the web request component to inspect, in the FieldToMatch specification. +// Example JSON: "SingleQueryArgument": { "Name": "myArgument" } type SingleQueryArgument struct { // The name of the query argument to inspect. @@ -2707,10 +2548,10 @@ type SizeConstraintStatement struct { // This member is required. Size int64 - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. @@ -2729,10 +2570,10 @@ type SqliMatchStatement struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. @@ -2741,9 +2582,8 @@ type SqliMatchStatement struct { // The sensitivity that you want WAF to use to inspect for SQL injection attacks. // HIGH detects more attacks, but might generate more false positives, especially // if your web requests frequently contain unusual strings. For information about - // identifying and mitigating false positives, see Testing and tuning - // (https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in - // the WAF Developer Guide. LOW is generally a better choice for resources that + // identifying and mitigating false positives, see Testing and tuning (https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) + // in the WAF Developer Guide. LOW is generally a better choice for resources that // already have other protections against SQL injection attacks or that have a low // tolerance for false positives. Default: LOW SensitivityLevel SensitivityLevel @@ -2751,13 +2591,13 @@ type SqliMatchStatement struct { noSmithyDocumentSerde } -// The processing guidance for a Rule, used by WAF to determine whether a web +// The processing guidance for a Rule , used by WAF to determine whether a web // request matches the rule. For example specifications, see the examples section -// of CreateWebACL. +// of CreateWebACL . type Statement struct { // A logical rule statement used to combine other rule statements with AND logic. - // You provide more than one Statement within the AndStatement. + // You provide more than one Statement within the AndStatement . AndStatement *AndStatement // A rule statement that defines a string match search for WAF to apply to web @@ -2768,45 +2608,39 @@ type Statement struct { // statement. ByteMatchStatement *ByteMatchStatement - // A rule statement that labels web requests by country and region and that matches - // against web requests based on country code. A geo match rule labels every - // request that it inspects regardless of whether it finds a match. - // - // * To manage - // requests only by country, you can use this statement by itself and specify the - // countries that you want to match against in the CountryCodes array. - // - // * - // Otherwise, configure your geo match rule with Count action so that it only - // labels requests. Then, add one or more label match rules to run after the geo - // match rule and configure them to match against the geographic labels and handle - // the requests as needed. - // - // WAF labels requests using the alpha-2 country and - // region codes from the International Organization for Standardization (ISO) 3166 - // standard. WAF determines the codes using either the IP address in the web - // request origin or, if you specify it, the address in the geo match - // ForwardedIPConfig. If you use the web request origin, the label formats are - // awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:. If you use a - // forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and - // awswaf:forwardedip:geo:country:. For additional details, see Geographic match - // rule statement - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // A rule statement that labels web requests by country and region and that + // matches against web requests based on country code. A geo match rule labels + // every request that it inspects regardless of whether it finds a match. + // - To manage requests only by country, you can use this statement by itself + // and specify the countries that you want to match against in the CountryCodes + // array. + // - Otherwise, configure your geo match rule with Count action so that it only + // labels requests. Then, add one or more label match rules to run after the geo + // match rule and configure them to match against the geographic labels and handle + // the requests as needed. + // WAF labels requests using the alpha-2 country and region codes from the + // International Organization for Standardization (ISO) 3166 standard. WAF + // determines the codes using either the IP address in the web request origin or, + // if you specify it, the address in the geo match ForwardedIPConfig . If you use + // the web request origin, the label formats are awswaf:clientip:geo:region:- and + // awswaf:clientip:geo:country: . If you use a forwarded IP address, the label + // formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country: + // . For additional details, see Geographic match rule statement (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . GeoMatchStatement *GeoMatchStatement - // A rule statement used to detect web requests coming from particular IP addresses - // or address ranges. To use this, create an IPSet that specifies the addresses you - // want to detect, then use the ARN of that set in this statement. To create an IP - // set, see CreateIPSet. Each IP set rule statement references an IP set. You - // create and maintain the set independent of your rules. This allows you to use - // the single set in multiple rules. When you update the referenced set, WAF + // A rule statement used to detect web requests coming from particular IP + // addresses or address ranges. To use this, create an IPSet that specifies the + // addresses you want to detect, then use the ARN of that set in this statement. To + // create an IP set, see CreateIPSet . Each IP set rule statement references an IP + // set. You create and maintain the set independent of your rules. This allows you + // to use the single set in multiple rules. When you update the referenced set, WAF // automatically updates all rules that reference it. IPSetReferenceStatement *IPSetReferenceStatement - // A rule statement to match against labels that have been added to the web request - // by rules that have already run in the web ACL. The label match statement + // A rule statement to match against labels that have been added to the web + // request by rules that have already run in the web ACL. The label match statement // provides the label or namespace string to search for. The label string can // represent a part or all of the fully qualified label name that had been added to // the web request. Fully qualified labels have a prefix, optional namespaces, and @@ -2816,24 +2650,24 @@ type Statement struct { // same context as the label match statement. LabelMatchStatement *LabelMatchStatement - // A rule statement used to run the rules that are defined in a managed rule group. - // To use this, provide the vendor name and the name of the rule group in this - // statement. You can retrieve the required names by calling - // ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for - // example for use inside a NotStatement or OrStatement. It can only be referenced - // as a top-level statement within a rule. You are charged additional fees when you - // use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or - // the WAF Fraud Control account takeover prevention (ATP) managed rule group - // AWSManagedRulesATPRuleSet. For more information, see WAF Pricing - // (http://aws.amazon.com/waf/pricing/). + // A rule statement used to run the rules that are defined in a managed rule + // group. To use this, provide the vendor name and the name of the rule group in + // this statement. You can retrieve the required names by calling + // ListAvailableManagedRuleGroups . You cannot nest a ManagedRuleGroupStatement , + // for example for use inside a NotStatement or OrStatement . It can only be + // referenced as a top-level statement within a rule. You are charged additional + // fees when you use the WAF Bot Control managed rule group + // AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover + // prevention (ATP) managed rule group AWSManagedRulesATPRuleSet . For more + // information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) . ManagedRuleGroupStatement *ManagedRuleGroupStatement // A logical rule statement used to negate the results of another rule statement. - // You provide one Statement within the NotStatement. + // You provide one Statement within the NotStatement . NotStatement *NotStatement // A logical rule statement used to combine other rule statements with OR logic. - // You provide more than one Statement within the OrStatement. + // You provide more than one Statement within the OrStatement . OrStatement *OrStatement // A rate-based rule tracks the rate of requests for each originating IP address, @@ -2854,22 +2688,17 @@ type Statement struct { // on recent requests that you have seen from an attacker, you might create a // rate-based rule with a nested AND rule statement that contains the following // nested statements: - // - // * An IP match statement with an IP set that specifies the - // address 192.0.2.44. - // - // * A string match statement that searches in the User-Agent - // header for the string BadBot. - // - // In this rate-based rule, you also define a rate - // limit. For this example, the rate limit is 1,000. Requests that meet the - // criteria of both of the nested statements are counted. If the count exceeds - // 1,000 requests per five minutes, the rule action triggers. Requests that do not - // meet the criteria of both of the nested statements are not counted towards the - // rate limit and are not affected by this rule. You cannot nest a - // RateBasedStatement inside another statement, for example inside a NotStatement - // or OrStatement. You can define a RateBasedStatement inside a web ACL and inside - // a rule group. + // - An IP match statement with an IP set that specifies the address 192.0.2.44. + // - A string match statement that searches in the User-Agent header for the + // string BadBot. + // In this rate-based rule, you also define a rate limit. For this example, the + // rate limit is 1,000. Requests that meet the criteria of both of the nested + // statements are counted. If the count exceeds 1,000 requests per five minutes, + // the rule action triggers. Requests that do not meet the criteria of both of the + // nested statements are not counted towards the rate limit and are not affected by + // this rule. You cannot nest a RateBasedStatement inside another statement, for + // example inside a NotStatement or OrStatement . You can define a + // RateBasedStatement inside a web ACL and inside a rule group. RateBasedStatement *RateBasedStatement // A rule statement used to search web request components for a match against a @@ -2881,16 +2710,16 @@ type Statement struct { // expressions that you want to detect, then use the ARN of that set in this // statement. A web request matches the pattern set rule statement if the request // component matches any of the patterns in the set. To create a regex pattern set, - // see CreateRegexPatternSet. Each regex pattern set rule statement references a + // see CreateRegexPatternSet . Each regex pattern set rule statement references a // regex pattern set. You create and maintain the set independent of your rules. // This allows you to use the single set in multiple rules. When you update the // referenced set, WAF automatically updates all rules that reference it. RegexPatternSetReferenceStatement *RegexPatternSetReferenceStatement - // A rule statement used to run the rules that are defined in a RuleGroup. To use + // A rule statement used to run the rules that are defined in a RuleGroup . To use // this, create a rule group with your rules, then provide the ARN of the rule - // group in this statement. You cannot nest a RuleGroupReferenceStatement, for - // example for use inside a NotStatement or OrStatement. You can only use a rule + // group in this statement. You cannot nest a RuleGroupReferenceStatement , for + // example for use inside a NotStatement or OrStatement . You can only use a rule // group reference statement at the top level inside a web ACL. RuleGroupReferenceStatement *RuleGroupReferenceStatement @@ -2931,8 +2760,9 @@ type Statement struct { // manage or view tags through the WAF console. type Tag struct { - // Part of the key:value pair that defines a tag. You can use a tag key to describe - // a category of information, such as "customer." Tag keys are case-sensitive. + // Part of the key:value pair that defines a tag. You can use a tag key to + // describe a category of information, such as "customer." Tag keys are + // case-sensitive. // // This member is required. Key *string @@ -2968,114 +2798,82 @@ type TagInfoForResource struct { noSmithyDocumentSerde } -// Text transformations eliminate some of the unusual formatting that attackers use -// in web requests in an effort to bypass detection. +// Text transformations eliminate some of the unusual formatting that attackers +// use in web requests in an effort to bypass detection. type TextTransformation struct { - // Sets the relative processing order for multiple transformations that are defined - // for a rule statement. WAF processes all transformations, from lowest priority to - // highest, before inspecting the transformed content. The priorities don't need to - // be consecutive, but they must all be different. + // Sets the relative processing order for multiple transformations that are + // defined for a rule statement. WAF processes all transformations, from lowest + // priority to highest, before inspecting the transformed content. The priorities + // don't need to be consecutive, but they must all be different. // // This member is required. Priority int32 // You can specify the following transformation types: BASE64_DECODE - Decode a - // Base64-encoded string. BASE64_DECODE_EXT - Decode a Base64-encoded string, but + // Base64 -encoded string. BASE64_DECODE_EXT - Decode a Base64 -encoded string, but // use a forgiving implementation that ignores characters that aren't valid. // CMD_LINE - Command-line transformations. These are helpful in reducing // effectiveness of attackers who inject an operating system command-line command // and use unusual formatting to disguise some or all of the command. - // - // * Delete the - // following characters: \ " ' ^ - // - // * Delete spaces before the following characters: - // / ( - // - // * Replace the following characters with a space: , ; - // - // * Replace multiple - // spaces with one space - // - // * Convert uppercase letters (A-Z) to lowercase - // (a-z) - // - // COMPRESS_WHITE_SPACE - Replace these characters with a space character - // (decimal 32): - // - // * \f, formfeed, decimal 12 - // - // * \t, tab, decimal 9 - // - // * \n, newline, - // decimal 10 - // - // * \r, carriage return, decimal 13 - // - // * \v, vertical tab, decimal 11 - // - // * - // Non-breaking space, decimal 160 - // - // COMPRESS_WHITE_SPACE also replaces multiple - // spaces with one space. CSS_DECODE - Decode characters that were encoded using - // CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes - // in the decoding process, so it can help to uncover ASCII characters that were - // encoded using CSS encoding that wouldn’t typically be encoded. It's also useful - // in countering evasion, which is a combination of a backslash and non-hexadecimal - // characters. For example, ja\vascript for javascript. ESCAPE_SEQ_DECODE - Decode - // the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \\, \?, \', - // \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the - // output. HEX_DECODE - Decode a string of hexadecimal characters into a binary. - // HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. - // HTML_ENTITY_DECODE performs these operations: - // - // * Replaces (ampersand)quot; with - // " - // - // * Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 - // - // * - // Replaces (ampersand)lt; with a "less than" symbol - // - // * Replaces (ampersand)gt; - // with > - // - // * Replaces characters that are represented in hexadecimal format, - // (ampersand)#xhhhh;, with the corresponding characters - // - // * Replaces characters - // that are represented in decimal format, (ampersand)#nnnn;, with the - // corresponding characters - // - // JS_DECODE - Decode JavaScript escape sequences. If a - // \ + // - Delete the following characters: \ " ' ^ + // - Delete spaces before the following characters: / ( + // - Replace the following characters with a space: , ; + // - Replace multiple spaces with one space + // - Convert uppercase letters (A-Z) to lowercase (a-z) + // COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal + // 32): + // - \f , formfeed, decimal 12 + // - \t , tab, decimal 9 + // - \n , newline, decimal 10 + // - \r , carriage return, decimal 13 + // - \v , vertical tab, decimal 11 + // - Non-breaking space, decimal 160 + // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. CSS_DECODE - + // Decode characters that were encoded using CSS 2.x escape rules + // syndata.html#characters . This function uses up to two bytes in the decoding + // process, so it can help to uncover ASCII characters that were encoded using CSS + // encoding that wouldn’t typically be encoded. It's also useful in countering + // evasion, which is a combination of a backslash and non-hexadecimal characters. + // For example, ja\vascript for javascript. ESCAPE_SEQ_DECODE - Decode the + // following ANSI C escape sequences: \a , \b , \f , \n , \r , \t , \v , \\ , \? , + // \' , \" , \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain + // in the output. HEX_DECODE - Decode a string of hexadecimal characters into a + // binary. HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded + // characters. HTML_ENTITY_DECODE performs these operations: + // - Replaces (ampersand)quot; with " + // - Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 + // - Replaces (ampersand)lt; with a "less than" symbol + // - Replaces (ampersand)gt; with > + // - Replaces characters that are represented in hexadecimal format, + // (ampersand)#xhhhh; , with the corresponding characters + // - Replaces characters that are represented in decimal format, + // (ampersand)#nnnn; , with the corresponding characters + // JS_DECODE - Decode JavaScript escape sequences. If a \ // u - // - // HHHH code is in the full-width ASCII code range of FF01-FF5E, then the - // higher byte is used to detect and adjust the lower byte. If not, only the lower - // byte is used and the higher byte is zeroed, causing a possible loss of - // information. LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z). MD5 - // - Calculate an MD5 hash from the data in the input. The computed hash is in a - // raw binary form. NONE - Specify NONE if you don't want any text transformations. + // HHHH code is in the full-width ASCII code range of FF01-FF5E , then the higher + // byte is used to detect and adjust the lower byte. If not, only the lower byte is + // used and the higher byte is zeroed, causing a possible loss of information. + // LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z). MD5 - Calculate + // an MD5 hash from the data in the input. The computed hash is in a raw binary + // form. NONE - Specify NONE if you don't want any text transformations. // NORMALIZE_PATH - Remove multiple slashes, directory self-references, and // directory back-references that are not at the beginning of the input from an - // input string. NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first - // converts backslash characters to forward slashes. REMOVE_NULLS - Remove all NULL - // bytes from the input. REPLACE_COMMENTS - Replace each occurrence of a C-style - // comment (/* ... */) with a single space. Multiple consecutive occurrences are - // not compressed. Unterminated comments are also replaced with a space (ASCII - // 0x20). However, a standalone termination of a comment (*/) is not acted upon. - // REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII - // 0x20). SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded - // to (ABC). URL_DECODE - Decode a URL-encoded value. URL_DECODE_UNI - Like - // URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is - // in the full-width ASCII code range of FF01-FF5E, the higher byte is used to - // detect and adjust the lower byte. Otherwise, only the lower byte is used and the - // higher byte is zeroed. UTF8_TO_UNICODE - Convert all UTF-8 character sequences - // to Unicode. This helps input normalization, and minimizing false-positives and - // false-negatives for non-English languages. + // input string. NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH , but + // first converts backslash characters to forward slashes. REMOVE_NULLS - Remove + // all NULL bytes from the input. REPLACE_COMMENTS - Replace each occurrence of a + // C-style comment ( /* ... */ ) with a single space. Multiple consecutive + // occurrences are not compressed. Unterminated comments are also replaced with a + // space (ASCII 0x20). However, a standalone termination of a comment ( */ ) is not + // acted upon. REPLACE_NULLS - Replace NULL bytes in the input with space + // characters (ASCII 0x20 ). SQL_HEX_DECODE - Decode SQL hex data. Example ( + // 0x414243 ) will be decoded to ( ABC ). URL_DECODE - Decode a URL-encoded value. + // URL_DECODE_UNI - Like URL_DECODE , but with support for Microsoft-specific %u + // encoding. If the code is in the full-width ASCII code range of FF01-FF5E , the + // higher byte is used to detect and adjust the lower byte. Otherwise, only the + // lower byte is used and the higher byte is zeroed. UTF8_TO_UNICODE - Convert all + // UTF-8 character sequences to Unicode. This helps input normalization, and + // minimizing false-positives and false-negatives for non-English languages. // // This member is required. Type TextTransformationType @@ -3086,31 +2884,31 @@ type TextTransformation struct { // In a GetSampledRequests request, the StartTime and EndTime objects specify the // time range for which you want WAF to return a sample of web requests. You must // specify the times in Coordinated Universal Time (UTC) format. UTC format -// includes the special designator, Z. For example, "2016-09-27T14:50Z". You can +// includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can // specify any time range in the previous three hours. In a GetSampledRequests -// response, the StartTime and EndTime objects specify the time range for which WAF -// actually returned a sample of web requests. WAF gets the specified number of +// response, the StartTime and EndTime objects specify the time range for which +// WAF actually returned a sample of web requests. WAF gets the specified number of // requests from among the first 5,000 requests that your Amazon Web Services // resource receives during the specified time period. If your resource receives // more than 5,000 requests during that period, WAF stops sampling after the -// 5,000th request. In that case, EndTime is the time that WAF received the 5,000th -// request. +// 5,000th request. In that case, EndTime is the time that WAF received the +// 5,000th request. type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a // sample of the requests that your Amazon Web Services resource received. You must // specify the times in Coordinated Universal Time (UTC) format. UTC format - // includes the special designator, Z. For example, "2016-09-27T14:50Z". You can + // includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can // specify any time range in the previous three hours. // // This member is required. EndTime *time.Time - // The beginning of the time range from which you want GetSampledRequests to return - // a sample of the requests that your Amazon Web Services resource received. You - // must specify the times in Coordinated Universal Time (UTC) format. UTC format - // includes the special designator, Z. For example, "2016-09-27T14:50Z". You can - // specify any time range in the previous three hours. + // The beginning of the time range from which you want GetSampledRequests to + // return a sample of the requests that your Amazon Web Services resource received. + // You must specify the times in Coordinated Universal Time (UTC) format. UTC + // format includes the special designator, Z . For example, "2016-09-27T14:50Z" . + // You can specify any time range in the previous three hours. // // This member is required. StartTime *time.Time @@ -3119,18 +2917,18 @@ type TimeWindow struct { } // Inspect the path component of the URI of the web request. This is the part of -// the web request that identifies a resource. For example, /images/daily-ad.jpg. +// the web request that identifies a resource. For example, /images/daily-ad.jpg . // This is used only in the FieldToMatch specification for some web request // component types. JSON specification: "UriPath": {} type UriPath struct { noSmithyDocumentSerde } -// Details about your login page username field for request inspection, used in the -// AWSManagedRulesATPRuleSetRequestInspection configuration. +// Details about your login page username field for request inspection, used in +// the AWSManagedRulesATPRuleSet RequestInspection configuration. type UsernameField struct { - // The name of the username field. For example /form/username. + // The name of the username field. For example /form/username . // // This member is required. Identifier *string @@ -3143,8 +2941,8 @@ type UsernameField struct { // managed rule sets. Vendors are Amazon Web Services and Amazon Web Services // Marketplace sellers. Vendors, you can use the managed rule set APIs to provide // controlled rollout of your versioned managed rule group offerings for your -// customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, -// PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. +// customers. The APIs are ListManagedRuleSets , GetManagedRuleSet , +// PutManagedRuleSetVersions , and UpdateManagedRuleSetVersionExpiryDate . type VersionToPublish struct { // The Amazon Resource Name (ARN) of the vendor's rule group that's used in the @@ -3162,8 +2960,8 @@ type VersionToPublish struct { type VisibilityConfig struct { // A boolean indicating whether the associated resource sends metrics to Amazon - // CloudWatch. For the list of available metrics, see WAF Metrics - // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics). + // CloudWatch. For the list of available metrics, see WAF Metrics (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) + // . // // This member is required. CloudWatchMetricsEnabled bool @@ -3171,7 +2969,7 @@ type VisibilityConfig struct { // A name of the Amazon CloudWatch metric dimension. The name can contain only the // characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from // one to 128 characters long. It can't contain whitespace or metric names that are - // reserved for WAF, for example All and Default_Action. + // reserved for WAF, for example All and Default_Action . // // This member is required. MetricName *string @@ -3189,9 +2987,9 @@ type VisibilityConfig struct { // requests. Each rule has an action defined (allow, block, or count) for requests // that match the statement of the rule. In the web ACL, you assign a default // action to take (allow, block) for any request that does not match any of the -// rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, -// and managed rule group. You can associate a web ACL with one or more Amazon Web -// Services resources to protect. The resources can be an Amazon CloudFront +// rules. The rules in a web ACL can be a combination of the types Rule , RuleGroup +// , and managed rule group. You can associate a web ACL with one or more Amazon +// Web Services resources to protect. The resources can be an Amazon CloudFront // distribution, an Amazon API Gateway REST API, an Application Load Balancer, an // AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service. type WebACL struct { @@ -3207,9 +3005,9 @@ type WebACL struct { // This member is required. DefaultAction *DefaultAction - // A unique identifier for the WebACL. This ID is returned in the responses to + // A unique identifier for the WebACL . This ID is returned in the responses to // create and list commands. You use this ID to do things like get, update, and - // delete a WebACL. + // delete a WebACL . // // This member is required. Id *string @@ -3225,39 +3023,36 @@ type WebACL struct { // This member is required. VisibilityConfig *VisibilityConfig - // The web ACL capacity units (WCUs) currently being used by this web ACL. WAF uses - // WCUs to calculate and control the operating resources that are used to run your - // rules, rule groups, and web ACLs. WAF calculates capacity differently for each - // rule type, to reflect the relative cost of each rule. Simple rules that cost - // little to run use fewer WCUs than more complex rules that use more processing - // power. Rule group capacity is fixed at creation, which helps users plan their - // web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is - // 1,500. + // The web ACL capacity units (WCUs) currently being used by this web ACL. WAF + // uses WCUs to calculate and control the operating resources that are used to run + // your rules, rule groups, and web ACLs. WAF calculates capacity differently for + // each rule type, to reflect the relative cost of each rule. Simple rules that + // cost little to run use fewer WCUs than more complex rules that use more + // processing power. Rule group capacity is fixed at creation, which helps users + // plan their web ACL WCU usage when they use a rule group. The WCU limit for web + // ACLs is 1,500. Capacity int64 // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. If you don't specify this, WAF uses its - // default settings for CaptchaConfig. + // default settings for CaptchaConfig . CaptchaConfig *CaptchaConfig // Specifies how WAF should handle challenge evaluations for rules that don't have // their own ChallengeConfig settings. If you don't specify this, WAF uses its - // default settings for ChallengeConfig. + // default settings for ChallengeConfig . ChallengeConfig *ChallengeConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and - // responses, see Customizing web requests and responses in WAF - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) - // in the WAF Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For - // information about the limits on count and size for custom request and response - // settings, see WAF quotas - // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF - // Developer Guide - // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). + // responses, see Customizing web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . For information about the limits on count and size for custom request and + // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) + // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) + // . CustomResponseBodies map[string]CustomResponseBody // A description of the web ACL that helps with identification. @@ -3265,14 +3060,12 @@ type WebACL struct { // The label namespace prefix for this web ACL. All labels added by rules in this // web ACL have this prefix. - // - // * The syntax for the label namespace prefix for a web - // ACL is the following: awswaf::webacl:: - // - // * When a rule with a label matches a web - // request, WAF adds the fully qualified label to the request. A fully qualified - // label is made up of the label namespace from the rule group or web ACL where the - // rule is defined and the label from the rule, separated by a colon: : + // - The syntax for the label namespace prefix for a web ACL is the following: + // awswaf::webacl:: + // - When a rule with a label matches a web request, WAF adds the fully + // qualified label to the request. A fully qualified label is made up of the label + // namespace from the rule group or web ACL where the rule is defined and the label + // from the rule, separated by a colon: : LabelNamespace *string // Indicates whether this web ACL is managed by Firewall Manager. If true, then @@ -3315,10 +3108,10 @@ type WebACL struct { noSmithyDocumentSerde } -// High-level information about a WebACL, returned by operations like create and +// High-level information about a WebACL , returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and -// manage a WebACL, and the ARN, that you provide to operations like -// AssociateWebACL. +// manage a WebACL , and the ARN, that you provide to operations like +// AssociateWebACL . type WebACLSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -3334,10 +3127,10 @@ type WebACLSummary struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to - // operations like update and delete. WAF uses the token to ensure that no changes + // operations like update and delete . WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been - // made, the update fails with a WAFOptimisticLockException. If this happens, - // perform another get, and use the new token returned by that operation. + // made, the update fails with a WAFOptimisticLockException . If this happens, + // perform another get , and use the new token returned by that operation. LockToken *string // The name of the web ACL. You cannot change the name of a web ACL after you @@ -3357,10 +3150,10 @@ type XssMatchStatement struct { // This member is required. FieldToMatch *FieldToMatch - // Text transformations eliminate some of the unusual formatting that attackers use - // in web requests in an effort to bypass detection. If you specify one or more + // Text transformations eliminate some of the unusual formatting that attackers + // use in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, WAF performs all transformations on the - // content of the request component identified by FieldToMatch, starting from the + // content of the request component identified by FieldToMatch , starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. diff --git a/service/wellarchitected/api_client.go b/service/wellarchitected/api_client.go index 54b5ae12d36..8be1527aeae 100644 --- a/service/wellarchitected/api_client.go +++ b/service/wellarchitected/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/wellarchitected/api_op_AssociateLenses.go b/service/wellarchitected/api_op_AssociateLenses.go index 7fec5c49cb2..75567f7b1e6 100644 --- a/service/wellarchitected/api_op_AssociateLenses.go +++ b/service/wellarchitected/api_op_AssociateLenses.go @@ -35,13 +35,13 @@ func (c *Client) AssociateLenses(ctx context.Context, params *AssociateLensesInp type AssociateLensesInput struct { // List of lens aliases to associate or disassociate with a workload. Up to 10 - // lenses can be specified. Identify a lens using its LensSummary$LensAlias. + // lenses can be specified. Identify a lens using its LensSummary$LensAlias . // // This member is required. LensAliases []string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_CreateLensShare.go b/service/wellarchitected/api_op_CreateLensShare.go index ac35aad6e3d..50af68f65ef 100644 --- a/service/wellarchitected/api_op_CreateLensShare.go +++ b/service/wellarchitected/api_op_CreateLensShare.go @@ -17,8 +17,7 @@ import ( // Web Services Official Content) cannot be shared. Shared access to a lens is not // removed until the lens invitation is deleted. If you share a lens with an // organization or OU, all accounts in the organization or OU are granted access to -// the lens. For more information, see Sharing a custom lens -// (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html) +// the lens. For more information, see Sharing a custom lens (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html) // in the Well-Architected Tool User Guide. Disclaimer By sharing your custom // lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web // Services will make your custom lenses available to those other accounts. Those @@ -55,18 +54,18 @@ type CreateLensShareInput struct { ClientRequestToken *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. // // This member is required. SharedWith *string diff --git a/service/wellarchitected/api_op_CreateLensVersion.go b/service/wellarchitected/api_op_CreateLensVersion.go index 1fc64f1362b..a2faafa7da0 100644 --- a/service/wellarchitected/api_op_CreateLensVersion.go +++ b/service/wellarchitected/api_op_CreateLensVersion.go @@ -46,12 +46,12 @@ type CreateLensVersionInput struct { ClientRequestToken *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_CreateMilestone.go b/service/wellarchitected/api_op_CreateMilestone.go index 7caa79c9736..881b78b50b6 100644 --- a/service/wellarchitected/api_op_CreateMilestone.go +++ b/service/wellarchitected/api_op_CreateMilestone.go @@ -42,14 +42,14 @@ type CreateMilestoneInput struct { // This member is required. ClientRequestToken *string - // The name of the milestone in a workload. Milestone names must be unique within a - // workload. + // The name of the milestone in a workload. Milestone names must be unique within + // a workload. // // This member is required. MilestoneName *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -63,8 +63,8 @@ type CreateMilestoneOutput struct { // The milestone number. A workload can have a maximum of 100 milestones. MilestoneNumber int32 - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_CreateWorkload.go b/service/wellarchitected/api_op_CreateWorkload.go index 246da1456f5..7f0c518b265 100644 --- a/service/wellarchitected/api_op_CreateWorkload.go +++ b/service/wellarchitected/api_op_CreateWorkload.go @@ -12,14 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new workload. The owner of a workload can share the workload with other -// Amazon Web Services accounts, users, an organization, and organizational units -// (OUs) in the same Amazon Web Services Region. Only the owner of a workload can -// delete it. For more information, see Defining a Workload -// (https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html) -// in the Well-Architected Tool User Guide. Either AwsRegions, NonAwsRegions, or +// Create a new workload. The owner of a workload can share the workload with +// other Amazon Web Services accounts, users, an organization, and organizational +// units (OUs) in the same Amazon Web Services Region. Only the owner of a workload +// can delete it. For more information, see Defining a Workload (https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html) +// in the Well-Architected Tool User Guide. Either AwsRegions , NonAwsRegions , or // both must be specified when creating a workload. You also must specify -// ReviewOwner, even though the parameter is listed as not being required in the +// ReviewOwner , even though the parameter is listed as not being required in the // following section. func (c *Client) CreateWorkload(ctx context.Context, params *CreateWorkloadInput, optFns ...func(*Options)) (*CreateWorkloadOutput, error) { if params == nil { @@ -62,7 +61,7 @@ type CreateWorkloadInput struct { Environment types.WorkloadEnvironment // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias. + // LensSummary$LensAlias . // // This member is required. Lenses []string @@ -84,7 +83,7 @@ type CreateWorkloadInput struct { ArchitecturalDesign *string // The list of Amazon Web Services Regions associated with the workload, for - // example, us-east-2, or ca-central-1. + // example, us-east-2 , or ca-central-1 . AwsRegions []string // Well-Architected discovery configuration settings associated to the workload. @@ -93,69 +92,34 @@ type CreateWorkloadInput struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the - // following: - // - // * Agriculture - // - // * Automobile - // - // * Defense - // - // * Design and Engineering - // - // * - // Digital Advertising - // - // * Education - // - // * Environmental Protection - // - // * Financial - // Services - // - // * Gaming - // - // * General Public Services - // - // * Healthcare - // - // * Hospitality - // - // * - // InfoTech - // - // * Justice and Public Safety - // - // * Life Sciences - // - // * Manufacturing - // - // * Media - // & Entertainment - // - // * Mining & Resources - // - // * Oil & Gas - // - // * Power & Utilities - // - // * - // Professional Services - // - // * Real Estate & Construction - // - // * Retail & Wholesale - // - // * - // Social Protection - // - // * Telecommunications - // - // * Travel, Transportation & Logistics - // - // * - // Other + // The industry type for the workload. If specified, must be one of the following: + // - Agriculture + // - Automobile + // - Defense + // - Design and Engineering + // - Digital Advertising + // - Education + // - Environmental Protection + // - Financial Services + // - Gaming + // - General Public Services + // - Healthcare + // - Hospitality + // - InfoTech + // - Justice and Public Safety + // - Life Sciences + // - Manufacturing + // - Media & Entertainment + // - Mining & Resources + // - Oil & Gas + // - Power & Utilities + // - Professional Services + // - Real Estate & Construction + // - Retail & Wholesale + // - Social Protection + // - Telecommunications + // - Travel, Transportation & Logistics + // - Other IndustryType *string // The list of non-Amazon Web Services Regions associated with the workload. @@ -165,11 +129,11 @@ type CreateWorkloadInput struct { Notes *string // The priorities of the pillars, which are used to order items in the improvement - // plan. Each pillar is represented by its PillarReviewSummary$PillarId. + // plan. Each pillar is represented by its PillarReviewSummary$PillarId . PillarPriorities []string - // The review owner of the workload. The name, email address, or identifier for the - // primary group or individual that owns the workload review process. + // The review owner of the workload. The name, email address, or identifier for + // the primary group or individual that owns the workload review process. ReviewOwner *string // The tags to be associated with the workload. @@ -184,8 +148,8 @@ type CreateWorkloadOutput struct { // The ARN for the workload. WorkloadArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_CreateWorkloadShare.go b/service/wellarchitected/api_op_CreateWorkloadShare.go index 207927dff09..9df33006331 100644 --- a/service/wellarchitected/api_op_CreateWorkloadShare.go +++ b/service/wellarchitected/api_op_CreateWorkloadShare.go @@ -17,8 +17,7 @@ import ( // access to a workload is not removed until the workload invitation is deleted. If // you share a workload with an organization or OU, all accounts in the // organization or OU are granted access to the workload. For more information, see -// Sharing a workload -// (https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html) +// Sharing a workload (https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html) // in the Well-Architected Tool User Guide. func (c *Client) CreateWorkloadShare(ctx context.Context, params *CreateWorkloadShareInput, optFns ...func(*Options)) (*CreateWorkloadShareOutput, error) { if params == nil { @@ -55,14 +54,14 @@ type CreateWorkloadShareInput struct { // This member is required. PermissionType types.PermissionType - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. // // This member is required. SharedWith *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -76,8 +75,8 @@ type CreateWorkloadShareOutput struct { // The ID associated with the workload share. ShareId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_DeleteLens.go b/service/wellarchitected/api_op_DeleteLens.go index 5c70c6c235c..69871203f15 100644 --- a/service/wellarchitected/api_op_DeleteLens.go +++ b/service/wellarchitected/api_op_DeleteLens.go @@ -51,12 +51,12 @@ type DeleteLensInput struct { ClientRequestToken *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_DeleteLensShare.go b/service/wellarchitected/api_op_DeleteLensShare.go index 4f4ae7e40d5..eeae82b80eb 100644 --- a/service/wellarchitected/api_op_DeleteLensShare.go +++ b/service/wellarchitected/api_op_DeleteLensShare.go @@ -50,12 +50,12 @@ type DeleteLensShareInput struct { ClientRequestToken *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_DeleteWorkload.go b/service/wellarchitected/api_op_DeleteWorkload.go index 53afa8c0327..1858e2226e6 100644 --- a/service/wellarchitected/api_op_DeleteWorkload.go +++ b/service/wellarchitected/api_op_DeleteWorkload.go @@ -42,8 +42,8 @@ type DeleteWorkloadInput struct { // This member is required. ClientRequestToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_DeleteWorkloadShare.go b/service/wellarchitected/api_op_DeleteWorkloadShare.go index c9df610da5e..11e9b22ceeb 100644 --- a/service/wellarchitected/api_op_DeleteWorkloadShare.go +++ b/service/wellarchitected/api_op_DeleteWorkloadShare.go @@ -47,8 +47,8 @@ type DeleteWorkloadShareInput struct { // This member is required. ShareId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_DisassociateLenses.go b/service/wellarchitected/api_op_DisassociateLenses.go index 99f62d521b0..66c7d1b3590 100644 --- a/service/wellarchitected/api_op_DisassociateLenses.go +++ b/service/wellarchitected/api_op_DisassociateLenses.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a -// workload in a single API operation. The Amazon Web Services Well-Architected -// Framework lens (wellarchitected) cannot be removed from a workload. +// Disassociate a lens from a workload. Up to 10 lenses can be disassociated from +// a workload in a single API operation. The Amazon Web Services Well-Architected +// Framework lens ( wellarchitected ) cannot be removed from a workload. func (c *Client) DisassociateLenses(ctx context.Context, params *DisassociateLensesInput, optFns ...func(*Options)) (*DisassociateLensesOutput, error) { if params == nil { params = &DisassociateLensesInput{} @@ -32,13 +32,13 @@ func (c *Client) DisassociateLenses(ctx context.Context, params *DisassociateLen type DisassociateLensesInput struct { // List of lens aliases to associate or disassociate with a workload. Up to 10 - // lenses can be specified. Identify a lens using its LensSummary$LensAlias. + // lenses can be specified. Identify a lens using its LensSummary$LensAlias . // // This member is required. LensAliases []string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_ExportLens.go b/service/wellarchitected/api_op_ExportLens.go index c8073f48058..16fd24aa903 100644 --- a/service/wellarchitected/api_op_ExportLens.go +++ b/service/wellarchitected/api_op_ExportLens.go @@ -10,11 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Export an existing lens. Only the owner of a lens can export it. Lenses provided -// by Amazon Web Services (Amazon Web Services Official Content) cannot be +// Export an existing lens. Only the owner of a lens can export it. Lenses +// provided by Amazon Web Services (Amazon Web Services Official Content) cannot be // exported. Lenses are defined in JSON. For more information, see JSON format -// specification -// (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) +// specification (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) // in the Well-Architected Tool User Guide. Disclaimer Do not include or gather // personal identifiable information (PII) of end users or other identifiable // individuals in or via your custom lenses. If your custom lens or those shared @@ -40,12 +39,12 @@ func (c *Client) ExportLens(ctx context.Context, params *ExportLensInput, optFns type ExportLensInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_GetAnswer.go b/service/wellarchitected/api_op_GetAnswer.go index 6446f4fbea1..d0a49597534 100644 --- a/service/wellarchitected/api_op_GetAnswer.go +++ b/service/wellarchitected/api_op_GetAnswer.go @@ -31,12 +31,12 @@ func (c *Client) GetAnswer(ctx context.Context, params *GetAnswerInput, optFns . type GetAnswerInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string @@ -46,8 +46,8 @@ type GetAnswerInput struct { // This member is required. QuestionId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -65,12 +65,12 @@ type GetAnswerOutput struct { Answer *types.Answer // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -79,8 +79,8 @@ type GetAnswerOutput struct { // The milestone number. A workload can have a maximum of 100 milestones. MilestoneNumber int32 - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_GetConsolidatedReport.go b/service/wellarchitected/api_op_GetConsolidatedReport.go index dfd2e2c40f1..e07177c7e2c 100644 --- a/service/wellarchitected/api_op_GetConsolidatedReport.go +++ b/service/wellarchitected/api_op_GetConsolidatedReport.go @@ -31,8 +31,8 @@ func (c *Client) GetConsolidatedReport(ctx context.Context, params *GetConsolida type GetConsolidatedReportInput struct { - // The format of the consolidated report. For PDF, Base64String is returned. For - // JSON, Metrics is returned. + // The format of the consolidated report. For PDF , Base64String is returned. For + // JSON , Metrics is returned. // // This member is required. Format types.ReportFormat @@ -56,8 +56,8 @@ type GetConsolidatedReportOutput struct { // format is requested. Base64String *string - // The metrics that make up the consolidated report. Only returned when JSON format - // is requested. + // The metrics that make up the consolidated report. Only returned when JSON + // format is requested. Metrics []types.ConsolidatedReportMetric // The token to use to retrieve the next set of results. diff --git a/service/wellarchitected/api_op_GetLens.go b/service/wellarchitected/api_op_GetLens.go index 88a7483410b..e57a9174fc4 100644 --- a/service/wellarchitected/api_op_GetLens.go +++ b/service/wellarchitected/api_op_GetLens.go @@ -30,12 +30,12 @@ func (c *Client) GetLens(ctx context.Context, params *GetLensInput, optFns ...fu type GetLensInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_GetLensReview.go b/service/wellarchitected/api_op_GetLensReview.go index 5ef666f16bd..cad85d3efa3 100644 --- a/service/wellarchitected/api_op_GetLensReview.go +++ b/service/wellarchitected/api_op_GetLensReview.go @@ -31,18 +31,18 @@ func (c *Client) GetLensReview(ctx context.Context, params *GetLensReviewInput, type GetLensReviewInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -62,8 +62,8 @@ type GetLensReviewOutput struct { // The milestone number. A workload can have a maximum of 100 milestones. MilestoneNumber int32 - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_GetLensReviewReport.go b/service/wellarchitected/api_op_GetLensReviewReport.go index 7fa09b6509f..cc2fc8926ef 100644 --- a/service/wellarchitected/api_op_GetLensReviewReport.go +++ b/service/wellarchitected/api_op_GetLensReviewReport.go @@ -31,18 +31,18 @@ func (c *Client) GetLensReviewReport(ctx context.Context, params *GetLensReviewR type GetLensReviewReportInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -62,8 +62,8 @@ type GetLensReviewReportOutput struct { // The milestone number. A workload can have a maximum of 100 milestones. MilestoneNumber int32 - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_GetLensVersionDifference.go b/service/wellarchitected/api_op_GetLensVersionDifference.go index 618054bcb5f..bd82157cc46 100644 --- a/service/wellarchitected/api_op_GetLensVersionDifference.go +++ b/service/wellarchitected/api_op_GetLensVersionDifference.go @@ -30,12 +30,12 @@ func (c *Client) GetLensVersionDifference(ctx context.Context, params *GetLensVe type GetLensVersionDifferenceInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string @@ -58,12 +58,12 @@ type GetLensVersionDifferenceOutput struct { LatestLensVersion *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. diff --git a/service/wellarchitected/api_op_GetMilestone.go b/service/wellarchitected/api_op_GetMilestone.go index 1704c602f46..15166fe1328 100644 --- a/service/wellarchitected/api_op_GetMilestone.go +++ b/service/wellarchitected/api_op_GetMilestone.go @@ -35,8 +35,8 @@ type GetMilestoneInput struct { // This member is required. MilestoneNumber int32 - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -50,8 +50,8 @@ type GetMilestoneOutput struct { // A milestone return object. Milestone *types.Milestone - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_GetWorkload.go b/service/wellarchitected/api_op_GetWorkload.go index 0a77bbba885..c78bea6ad52 100644 --- a/service/wellarchitected/api_op_GetWorkload.go +++ b/service/wellarchitected/api_op_GetWorkload.go @@ -30,8 +30,8 @@ func (c *Client) GetWorkload(ctx context.Context, params *GetWorkloadInput, optF // Input to get a workload. type GetWorkloadInput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_ImportLens.go b/service/wellarchitected/api_op_ImportLens.go index b5d297df2c7..73359ee6e9e 100644 --- a/service/wellarchitected/api_op_ImportLens.go +++ b/service/wellarchitected/api_op_ImportLens.go @@ -13,12 +13,11 @@ import ( ) // Import a new custom lens or update an existing custom lens. To update an -// existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, +// existing custom lens, specify its ARN as the LensAlias . If no ARN is specified, // a new custom lens is created. The new or updated lens will have a status of -// DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web -// Services accounts until it's published with CreateLensVersion. Lenses are -// defined in JSON. For more information, see JSON format specification -// (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) +// DRAFT . The lens cannot be applied to workloads or shared with other Amazon Web +// Services accounts until it's published with CreateLensVersion . Lenses are +// defined in JSON. For more information, see JSON format specification (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) // in the Well-Architected Tool User Guide. A custom lens cannot exceed 500 KB in // size. Disclaimer Do not include or gather personal identifiable information // (PII) of end users or other identifiable individuals in or via your custom @@ -61,12 +60,12 @@ type ImportLensInput struct { JSONString *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // Tags to associate to a lens. diff --git a/service/wellarchitected/api_op_ListAnswers.go b/service/wellarchitected/api_op_ListAnswers.go index 43dd8027cd2..3c21ac40adc 100644 --- a/service/wellarchitected/api_op_ListAnswers.go +++ b/service/wellarchitected/api_op_ListAnswers.go @@ -32,18 +32,18 @@ func (c *Client) ListAnswers(ctx context.Context, params *ListAnswersInput, optF type ListAnswersInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -57,8 +57,8 @@ type ListAnswersInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string noSmithyDocumentSerde @@ -71,12 +71,12 @@ type ListAnswersOutput struct { AnswerSummaries []types.AnswerSummary // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -88,8 +88,8 @@ type ListAnswersOutput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_ListCheckDetails.go b/service/wellarchitected/api_op_ListCheckDetails.go index 123346275a2..32cbf77db79 100644 --- a/service/wellarchitected/api_op_ListCheckDetails.go +++ b/service/wellarchitected/api_op_ListCheckDetails.go @@ -40,8 +40,8 @@ type ListCheckDetailsInput struct { // This member is required. LensArn *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . // // This member is required. PillarId *string @@ -51,8 +51,8 @@ type ListCheckDetailsInput struct { // This member is required. QuestionId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_ListCheckSummaries.go b/service/wellarchitected/api_op_ListCheckSummaries.go index ddcd19b3970..a903c1865d5 100644 --- a/service/wellarchitected/api_op_ListCheckSummaries.go +++ b/service/wellarchitected/api_op_ListCheckSummaries.go @@ -41,8 +41,8 @@ type ListCheckSummariesInput struct { // This member is required. LensArn *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . // // This member is required. PillarId *string @@ -52,8 +52,8 @@ type ListCheckSummariesInput struct { // This member is required. QuestionId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/api_op_ListLensReviewImprovements.go b/service/wellarchitected/api_op_ListLensReviewImprovements.go index 1f9641eb2d4..a183ecf60b1 100644 --- a/service/wellarchitected/api_op_ListLensReviewImprovements.go +++ b/service/wellarchitected/api_op_ListLensReviewImprovements.go @@ -32,18 +32,18 @@ func (c *Client) ListLensReviewImprovements(ctx context.Context, params *ListLen type ListLensReviewImprovementsInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -57,8 +57,8 @@ type ListLensReviewImprovementsInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string noSmithyDocumentSerde @@ -71,12 +71,12 @@ type ListLensReviewImprovementsOutput struct { ImprovementSummaries []types.ImprovementSummary // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -88,8 +88,8 @@ type ListLensReviewImprovementsOutput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_ListLensReviews.go b/service/wellarchitected/api_op_ListLensReviews.go index d51a250980d..3408f7e06fa 100644 --- a/service/wellarchitected/api_op_ListLensReviews.go +++ b/service/wellarchitected/api_op_ListLensReviews.go @@ -31,8 +31,8 @@ func (c *Client) ListLensReviews(ctx context.Context, params *ListLensReviewsInp // Input to list lens reviews. type ListLensReviewsInput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -61,8 +61,8 @@ type ListLensReviewsOutput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_ListLensShares.go b/service/wellarchitected/api_op_ListLensShares.go index 08e4c9a1b7e..f90cfc1b341 100644 --- a/service/wellarchitected/api_op_ListLensShares.go +++ b/service/wellarchitected/api_op_ListLensShares.go @@ -31,12 +31,12 @@ func (c *Client) ListLensShares(ctx context.Context, params *ListLensSharesInput type ListLensSharesInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string @@ -47,8 +47,8 @@ type ListLensSharesInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the lens is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the lens is shared. SharedWithPrefix *string // The status of a workload share. diff --git a/service/wellarchitected/api_op_ListMilestones.go b/service/wellarchitected/api_op_ListMilestones.go index e814e3dabf3..3120a9a89ef 100644 --- a/service/wellarchitected/api_op_ListMilestones.go +++ b/service/wellarchitected/api_op_ListMilestones.go @@ -31,8 +31,8 @@ func (c *Client) ListMilestones(ctx context.Context, params *ListMilestonesInput // Input to list all milestones for a workload. type ListMilestonesInput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -55,8 +55,8 @@ type ListMilestonesOutput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_ListNotifications.go b/service/wellarchitected/api_op_ListNotifications.go index 29dec0abf79..126da5de31e 100644 --- a/service/wellarchitected/api_op_ListNotifications.go +++ b/service/wellarchitected/api_op_ListNotifications.go @@ -36,8 +36,8 @@ type ListNotificationsInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_ListTagsForResource.go b/service/wellarchitected/api_op_ListTagsForResource.go index bf805a09bf9..5ff142c05c1 100644 --- a/service/wellarchitected/api_op_ListTagsForResource.go +++ b/service/wellarchitected/api_op_ListTagsForResource.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the tags for a resource. The WorkloadArn parameter can be either a workload -// ARN or a custom lens ARN. +// List the tags for a resource. The WorkloadArn parameter can be either a +// workload ARN or a custom lens ARN. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/wellarchitected/api_op_ListWorkloadShares.go b/service/wellarchitected/api_op_ListWorkloadShares.go index 3ff141d6ccb..46d0e7bdaf5 100644 --- a/service/wellarchitected/api_op_ListWorkloadShares.go +++ b/service/wellarchitected/api_op_ListWorkloadShares.go @@ -31,8 +31,8 @@ func (c *Client) ListWorkloadShares(ctx context.Context, params *ListWorkloadSha // Input for List Workload Share type ListWorkloadSharesInput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -43,8 +43,8 @@ type ListWorkloadSharesInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. SharedWithPrefix *string // The status of a workload share. @@ -59,8 +59,8 @@ type ListWorkloadSharesOutput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // A list of workload share summaries. diff --git a/service/wellarchitected/api_op_UntagResource.go b/service/wellarchitected/api_op_UntagResource.go index 280df1db629..41c533bc77b 100644 --- a/service/wellarchitected/api_op_UntagResource.go +++ b/service/wellarchitected/api_op_UntagResource.go @@ -31,8 +31,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // A list of tag keys. Existing tags of the resource whose keys are members of this - // list are removed from the resource. + // A list of tag keys. Existing tags of the resource whose keys are members of + // this list are removed from the resource. // // This member is required. TagKeys []string diff --git a/service/wellarchitected/api_op_UpdateAnswer.go b/service/wellarchitected/api_op_UpdateAnswer.go index 0ad41267e89..bb6e364b59b 100644 --- a/service/wellarchitected/api_op_UpdateAnswer.go +++ b/service/wellarchitected/api_op_UpdateAnswer.go @@ -31,12 +31,12 @@ func (c *Client) UpdateAnswer(ctx context.Context, params *UpdateAnswerInput, op type UpdateAnswerInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string @@ -46,8 +46,8 @@ type UpdateAnswerInput struct { // This member is required. QuestionId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -65,8 +65,8 @@ type UpdateAnswerInput struct { // The reason why a question is not applicable to your workload. Reason types.AnswerReason - // List of selected choice IDs in a question answer. The values entered replace the - // previously selected choices. + // List of selected choice IDs in a question answer. The values entered replace + // the previously selected choices. SelectedChoices []string noSmithyDocumentSerde @@ -79,19 +79,19 @@ type UpdateAnswerOutput struct { Answer *types.Answer // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. LensArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_UpdateLensReview.go b/service/wellarchitected/api_op_UpdateLensReview.go index cdb9ca92620..f438b43a220 100644 --- a/service/wellarchitected/api_op_UpdateLensReview.go +++ b/service/wellarchitected/api_op_UpdateLensReview.go @@ -31,18 +31,18 @@ func (c *Client) UpdateLensReview(ctx context.Context, params *UpdateLensReviewI type UpdateLensReviewInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -62,8 +62,8 @@ type UpdateLensReviewOutput struct { // A lens review of a question. LensReview *types.LensReview - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // Metadata pertaining to the operation's result. diff --git a/service/wellarchitected/api_op_UpdateWorkload.go b/service/wellarchitected/api_op_UpdateWorkload.go index 5eea45ce9ca..fc451250e4a 100644 --- a/service/wellarchitected/api_op_UpdateWorkload.go +++ b/service/wellarchitected/api_op_UpdateWorkload.go @@ -30,8 +30,8 @@ func (c *Client) UpdateWorkload(ctx context.Context, params *UpdateWorkloadInput // Input to update a workload. type UpdateWorkloadInput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -46,7 +46,7 @@ type UpdateWorkloadInput struct { ArchitecturalDesign *string // The list of Amazon Web Services Regions associated with the workload, for - // example, us-east-2, or ca-central-1. + // example, us-east-2 , or ca-central-1 . AwsRegions []string // The description for the workload. @@ -64,69 +64,34 @@ type UpdateWorkloadInput struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the - // following: - // - // * Agriculture - // - // * Automobile - // - // * Defense - // - // * Design and Engineering - // - // * - // Digital Advertising - // - // * Education - // - // * Environmental Protection - // - // * Financial - // Services - // - // * Gaming - // - // * General Public Services - // - // * Healthcare - // - // * Hospitality - // - // * - // InfoTech - // - // * Justice and Public Safety - // - // * Life Sciences - // - // * Manufacturing - // - // * Media - // & Entertainment - // - // * Mining & Resources - // - // * Oil & Gas - // - // * Power & Utilities - // - // * - // Professional Services - // - // * Real Estate & Construction - // - // * Retail & Wholesale - // - // * - // Social Protection - // - // * Telecommunications - // - // * Travel, Transportation & Logistics - // - // * - // Other + // The industry type for the workload. If specified, must be one of the following: + // - Agriculture + // - Automobile + // - Defense + // - Design and Engineering + // - Digital Advertising + // - Education + // - Environmental Protection + // - Financial Services + // - Gaming + // - General Public Services + // - Healthcare + // - Hospitality + // - InfoTech + // - Justice and Public Safety + // - Life Sciences + // - Manufacturing + // - Media & Entertainment + // - Mining & Resources + // - Oil & Gas + // - Power & Utilities + // - Professional Services + // - Real Estate & Construction + // - Retail & Wholesale + // - Social Protection + // - Telecommunications + // - Travel, Transportation & Logistics + // - Other IndustryType *string // Flag indicating whether the workload owner has acknowledged that the Review @@ -142,11 +107,11 @@ type UpdateWorkloadInput struct { Notes *string // The priorities of the pillars, which are used to order items in the improvement - // plan. Each pillar is represented by its PillarReviewSummary$PillarId. + // plan. Each pillar is represented by its PillarReviewSummary$PillarId . PillarPriorities []string - // The review owner of the workload. The name, email address, or identifier for the - // primary group or individual that owns the workload review process. + // The review owner of the workload. The name, email address, or identifier for + // the primary group or individual that owns the workload review process. ReviewOwner *string // The name of the workload. The name must be unique within an account within an diff --git a/service/wellarchitected/api_op_UpdateWorkloadShare.go b/service/wellarchitected/api_op_UpdateWorkloadShare.go index d6b46b50817..baf41babe7a 100644 --- a/service/wellarchitected/api_op_UpdateWorkloadShare.go +++ b/service/wellarchitected/api_op_UpdateWorkloadShare.go @@ -40,8 +40,8 @@ type UpdateWorkloadShareInput struct { // This member is required. ShareId *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string @@ -52,8 +52,8 @@ type UpdateWorkloadShareInput struct { // Input for Update Workload Share type UpdateWorkloadShareOutput struct { - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // A workload share return object. diff --git a/service/wellarchitected/api_op_UpgradeLensReview.go b/service/wellarchitected/api_op_UpgradeLensReview.go index e194bd97f3e..56f0d078abf 100644 --- a/service/wellarchitected/api_op_UpgradeLensReview.go +++ b/service/wellarchitected/api_op_UpgradeLensReview.go @@ -29,24 +29,24 @@ func (c *Client) UpgradeLensReview(ctx context.Context, params *UpgradeLensRevie type UpgradeLensReviewInput struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . // // This member is required. LensAlias *string - // The name of the milestone in a workload. Milestone names must be unique within a - // workload. + // The name of the milestone in a workload. Milestone names must be unique within + // a workload. // // This member is required. MilestoneName *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. // // This member is required. WorkloadId *string diff --git a/service/wellarchitected/doc.go b/service/wellarchitected/doc.go index a40af065553..715e986249b 100644 --- a/service/wellarchitected/doc.go +++ b/service/wellarchitected/doc.go @@ -1,12 +1,12 @@ // Code generated by smithy-go-codegen DO NOT EDIT. -// Package wellarchitected provides the API client, operations, and parameter types -// for AWS Well-Architected Tool. +// Package wellarchitected provides the API client, operations, and parameter +// types for AWS Well-Architected Tool. // // Well-Architected Tool This is the Well-Architected Tool API Reference. The WA -// Tool API provides programmatic access to the Well-Architected Tool -// (http://aws.amazon.com/well-architected-tool) in the Amazon Web Services -// Management Console (https://console.aws.amazon.com/wellarchitected). For -// information about the Well-Architected Tool, see the Well-Architected Tool User -// Guide (https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html). +// Tool API provides programmatic access to the Well-Architected Tool (http://aws.amazon.com/well-architected-tool) +// in the Amazon Web Services Management Console (https://console.aws.amazon.com/wellarchitected) +// . For information about the Well-Architected Tool, see the Well-Architected +// Tool User Guide (https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html) +// . package wellarchitected diff --git a/service/wellarchitected/types/enums.go b/service/wellarchitected/types/enums.go index b4ab68b59d5..2e9aad23bf1 100644 --- a/service/wellarchitected/types/enums.go +++ b/service/wellarchitected/types/enums.go @@ -31,9 +31,9 @@ const ( AnswerReasonNone AnswerReason = "NONE" ) -// Values returns all known values for AnswerReason. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AnswerReason. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AnswerReason) Values() []AnswerReason { return []AnswerReason{ "OUT_OF_SCOPE", @@ -117,9 +117,9 @@ const ( ChoiceReasonNone ChoiceReason = "NONE" ) -// Values returns all known values for ChoiceReason. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChoiceReason. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChoiceReason) Values() []ChoiceReason { return []ChoiceReason{ "OUT_OF_SCOPE", @@ -139,9 +139,9 @@ const ( ChoiceStatusUnselected ChoiceStatus = "UNSELECTED" ) -// Values returns all known values for ChoiceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ChoiceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ChoiceStatus) Values() []ChoiceStatus { return []ChoiceStatus{ "SELECTED", @@ -332,9 +332,9 @@ const ( ReportFormatJson ReportFormat = "JSON" ) -// Values returns all known values for ReportFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ReportFormat. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ReportFormat) Values() []ReportFormat { return []ReportFormat{ "PDF", @@ -374,8 +374,8 @@ const ( ShareInvitationActionReject ShareInvitationAction = "REJECT" ) -// Values returns all known values for ShareInvitationAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ShareInvitationAction. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ShareInvitationAction) Values() []ShareInvitationAction { return []ShareInvitationAction{ diff --git a/service/wellarchitected/types/types.go b/service/wellarchitected/types/types.go index 678da5d4eb3..8f225f3e315 100644 --- a/service/wellarchitected/types/types.go +++ b/service/wellarchitected/types/types.go @@ -30,8 +30,8 @@ type Answer struct { // List of choices available for a question. Choices []Choice - // The helpful resource text to be displayed for a custom lens. This field does not - // apply to Amazon Web Services official lenses. + // The helpful resource text to be displayed for a custom lens. This field does + // not apply to Amazon Web Services official lenses. HelpfulResourceDisplayText *string // The helpful resource URL. For Amazon Web Services official lenses, this is the @@ -51,8 +51,8 @@ type Answer struct { // The notes associated with the workload. Notes *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The description of the question. @@ -70,8 +70,8 @@ type Answer struct { // The risk for a given workload, lens review, pillar, or question. Risk Risk - // List of selected choice IDs in a question answer. The values entered replace the - // previously selected choices. + // List of selected choice IDs in a question answer. The values entered replace + // the previously selected choices. SelectedChoices []string noSmithyDocumentSerde @@ -89,8 +89,8 @@ type AnswerSummary struct { // Defines whether this question is applicable to a lens review. IsApplicable bool - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The ID of the question. @@ -105,8 +105,8 @@ type AnswerSummary struct { // The risk for a given workload, lens review, pillar, or question. Risk Risk - // List of selected choice IDs in a question answer. The values entered replace the - // previously selected choices. + // List of selected choice IDs in a question answer. The values entered replace + // the previously selected choices. SelectedChoices []string noSmithyDocumentSerde @@ -150,8 +150,8 @@ type CheckDetail struct { // Trusted Advisor check name. Name *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // Provider of the check related to the best practice. @@ -193,8 +193,8 @@ type CheckSummary struct { // Trusted Advisor check name. Name *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // Provider of the check related to the best practice. @@ -216,8 +216,8 @@ type CheckSummary struct { type Choice struct { // The additional resources for a choice in a custom lens. A choice can have up to - // two additional resources: one of type HELPFUL_RESOURCE, one of type - // IMPROVEMENT_PLAN, or both. + // two additional resources: one of type HELPFUL_RESOURCE , one of type + // IMPROVEMENT_PLAN , or both. AdditionalResources []AdditionalResources // The ID of a choice. @@ -341,8 +341,8 @@ type ConsolidatedReportMetric struct { // The ARN for the workload. WorkloadArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an @@ -364,8 +364,8 @@ type ImprovementSummary struct { // The improvement plan details. ImprovementPlans []ChoiceImprovementPlan - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The ID of the question. @@ -426,12 +426,12 @@ type LensMetric struct { type LensReview struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -473,12 +473,12 @@ type LensReviewReport struct { Base64String *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -491,12 +491,12 @@ type LensReviewReport struct { type LensReviewSummary struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -526,8 +526,8 @@ type LensShareSummary struct { // The ID associated with the workload share. ShareId *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. SharedWith *string // The status of a workload share. @@ -549,12 +549,12 @@ type LensSummary struct { Description *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN of the lens. @@ -591,19 +591,19 @@ type LensUpgradeSummary struct { LatestLensVersion *string // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. LensArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an @@ -617,8 +617,8 @@ type LensUpgradeSummary struct { // A milestone return object. type Milestone struct { - // The name of the milestone in a workload. Milestone names must be unique within a - // workload. + // The name of the milestone in a workload. Milestone names must be unique within + // a workload. MilestoneName *string // The milestone number. A workload can have a maximum of 100 milestones. @@ -636,8 +636,8 @@ type Milestone struct { // A milestone summary return object. type MilestoneSummary struct { - // The name of the milestone in a workload. Milestone names must be unique within a - // workload. + // The name of the milestone in a workload. Milestone names must be unique within + // a workload. MilestoneName *string // The milestone number. A workload can have a maximum of 100 milestones. @@ -670,8 +670,8 @@ type PillarDifference struct { // Indicates the type of change to the pillar. DifferenceStatus DifferenceStatus - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The name of the pillar. @@ -686,8 +686,8 @@ type PillarDifference struct { // A metric for a particular pillar in a lens. type PillarMetric struct { - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The questions that have been identified as risks in the pillar. @@ -705,8 +705,8 @@ type PillarReviewSummary struct { // The notes associated with the workload. Notes *string - // The ID used to identify a pillar, for example, security. A pillar is identified - // by its PillarReviewSummary$PillarId. + // The ID used to identify a pillar, for example, security . A pillar is identified + // by its PillarReviewSummary$PillarId . PillarId *string // The name of the pillar. @@ -753,12 +753,12 @@ type QuestionMetric struct { type ShareInvitation struct { // The alias of the lens. For Amazon Web Services official lenses, this is either - // the lens alias, such as serverless, or the lens ARN, such as - // arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations + // the lens alias, such as serverless , or the lens ARN, such as + // arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web // Services official lenses. For custom lenses, this is the lens ARN, such as - // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. - // Each lens is identified by its LensSummary$LensAlias. + // arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef + // . Each lens is identified by its LensSummary$LensAlias . LensAlias *string // The ARN for the lens. @@ -770,8 +770,8 @@ type ShareInvitation struct { // The resource type of the share invitation. ShareResourceType ShareResourceType - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string noSmithyDocumentSerde @@ -798,12 +798,12 @@ type ShareInvitationSummary struct { // An Amazon Web Services account ID. SharedBy *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. SharedWith *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an @@ -853,7 +853,7 @@ type Workload struct { ArchitecturalDesign *string // The list of Amazon Web Services Regions associated with the workload, for - // example, us-east-2, or ca-central-1. + // example, us-east-2 , or ca-central-1 . AwsRegions []string // The description for the workload. @@ -871,69 +871,34 @@ type Workload struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the - // following: - // - // * Agriculture - // - // * Automobile - // - // * Defense - // - // * Design and Engineering - // - // * - // Digital Advertising - // - // * Education - // - // * Environmental Protection - // - // * Financial - // Services - // - // * Gaming - // - // * General Public Services - // - // * Healthcare - // - // * Hospitality - // - // * - // InfoTech - // - // * Justice and Public Safety - // - // * Life Sciences - // - // * Manufacturing - // - // * Media - // & Entertainment - // - // * Mining & Resources - // - // * Oil & Gas - // - // * Power & Utilities - // - // * - // Professional Services - // - // * Real Estate & Construction - // - // * Retail & Wholesale - // - // * - // Social Protection - // - // * Telecommunications - // - // * Travel, Transportation & Logistics - // - // * - // Other + // The industry type for the workload. If specified, must be one of the following: + // - Agriculture + // - Automobile + // - Defense + // - Design and Engineering + // - Digital Advertising + // - Education + // - Environmental Protection + // - Financial Services + // - Gaming + // - General Public Services + // - Healthcare + // - Hospitality + // - InfoTech + // - Justice and Public Safety + // - Life Sciences + // - Manufacturing + // - Media & Entertainment + // - Mining & Resources + // - Oil & Gas + // - Power & Utilities + // - Professional Services + // - Real Estate & Construction + // - Retail & Wholesale + // - Social Protection + // - Telecommunications + // - Travel, Transportation & Logistics + // - Other IndustryType *string // Flag indicating whether the workload owner has acknowledged that the Review @@ -943,7 +908,7 @@ type Workload struct { IsReviewOwnerUpdateAcknowledged bool // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias. + // LensSummary$LensAlias . Lenses []string // The list of non-Amazon Web Services Regions associated with the workload. @@ -956,11 +921,11 @@ type Workload struct { Owner *string // The priorities of the pillars, which are used to order items in the improvement - // plan. Each pillar is represented by its PillarReviewSummary$PillarId. + // plan. Each pillar is represented by its PillarReviewSummary$PillarId . PillarPriorities []string - // The review owner of the workload. The name, email address, or identifier for the - // primary group or individual that owns the workload review process. + // The review owner of the workload. The name, email address, or identifier for + // the primary group or individual that owns the workload review process. ReviewOwner *string // The date and time recorded. @@ -981,8 +946,8 @@ type Workload struct { // The ARN for the workload. WorkloadArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an @@ -1014,15 +979,15 @@ type WorkloadShare struct { // An Amazon Web Services account ID. SharedBy *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. SharedWith *string // The status of a workload share. Status ShareStatus - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an @@ -1042,8 +1007,8 @@ type WorkloadShareSummary struct { // The ID associated with the workload share. ShareId *string - // The Amazon Web Services account ID, IAM role, organization ID, or organizational - // unit (OU) ID with which the workload is shared. + // The Amazon Web Services account ID, IAM role, organization ID, or + // organizational unit (OU) ID with which the workload is shared. SharedWith *string // The status of a workload share. @@ -1062,7 +1027,7 @@ type WorkloadSummary struct { ImprovementStatus WorkloadImprovementStatus // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias. + // LensSummary$LensAlias . Lenses []string // An Amazon Web Services account ID. @@ -1077,8 +1042,8 @@ type WorkloadSummary struct { // The ARN for the workload. WorkloadArn *string - // The ID assigned to the workload. This ID is unique within an Amazon Web Services - // Region. + // The ID assigned to the workload. This ID is unique within an Amazon Web + // Services Region. WorkloadId *string // The name of the workload. The name must be unique within an account within an diff --git a/service/wisdom/api_client.go b/service/wisdom/api_client.go index 8a82f57bad5..037f0a90204 100644 --- a/service/wisdom/api_client.go +++ b/service/wisdom/api_client.go @@ -26,8 +26,8 @@ import ( const ServiceID = "Wisdom" const ServiceAPIVersion = "2020-10-19" -// Client provides the API client to make operations call for Amazon Connect Wisdom -// Service. +// Client provides the API client to make operations call for Amazon Connect +// Wisdom Service. type Client struct { options Options } @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/wisdom/api_op_CreateAssistant.go b/service/wisdom/api_op_CreateAssistant.go index 53322924b27..5cf95384509 100644 --- a/service/wisdom/api_op_CreateAssistant.go +++ b/service/wisdom/api_op_CreateAssistant.go @@ -43,8 +43,8 @@ type CreateAssistantInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The description of the assistant. diff --git a/service/wisdom/api_op_CreateAssistantAssociation.go b/service/wisdom/api_op_CreateAssistantAssociation.go index d68746e751a..1cbc954ca66 100644 --- a/service/wisdom/api_op_CreateAssistantAssociation.go +++ b/service/wisdom/api_op_CreateAssistantAssociation.go @@ -51,8 +51,8 @@ type CreateAssistantAssociationInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The tags used to organize, track, or control access for this resource. diff --git a/service/wisdom/api_op_CreateContent.go b/service/wisdom/api_op_CreateContent.go index 4970c4f5d70..c759a55542b 100644 --- a/service/wisdom/api_op_CreateContent.go +++ b/service/wisdom/api_op_CreateContent.go @@ -12,8 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates Wisdom content. Before to calling this API, use StartContentUpload -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) +// Creates Wisdom content. Before to calling this API, use StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) // to upload an asset. func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error) { if params == nil { @@ -40,15 +39,14 @@ type CreateContentInput struct { // The name of the content. Each piece of content in a knowledge base must have a // unique name. You can retrieve a piece of content using only its knowledge base - // and its name with the SearchContent - // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html) + // and its name with the SearchContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html) // API. // // This member is required. Name *string - // A pointer to the uploaded asset. This value is returned by StartContentUpload - // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html). + // A pointer to the uploaded asset. This value is returned by StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) + // . // // This member is required. UploadId *string @@ -56,8 +54,8 @@ type CreateContentInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // A key/value map to store attributes without affecting tagging or diff --git a/service/wisdom/api_op_CreateKnowledgeBase.go b/service/wisdom/api_op_CreateKnowledgeBase.go index 98ea0c353c9..145cd2a2551 100644 --- a/service/wisdom/api_op_CreateKnowledgeBase.go +++ b/service/wisdom/api_op_CreateKnowledgeBase.go @@ -13,28 +13,19 @@ import ( ) // Creates a knowledge base. When using this API, you cannot reuse Amazon -// AppIntegrations -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) +// AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) // DataIntegrations with external knowledge bases such as Salesforce and -// ServiceNow. If you do, you'll get an InvalidRequestException error. For example, -// you're programmatically managing your external knowledge base, and you want to -// add or remove one of the fields that is being ingested from Salesforce. Do the -// following: -// -// * Call DeleteKnowledgeBase -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html). -// -// * -// Call DeleteDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html). -// -// * -// Call CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) -// to recreate the DataIntegration or a create different one. -// -// * Call -// CreateKnowledgeBase. +// ServiceNow. If you do, you'll get an InvalidRequestException error. For +// example, you're programmatically managing your external knowledge base, and you +// want to add or remove one of the fields that is being ingested from Salesforce. +// Do the following: +// - Call DeleteKnowledgeBase (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html) +// . +// - Call DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) +// . +// - Call CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// to recreate the DataIntegration or a create different one. +// - Call CreateKnowledgeBase. func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error) { if params == nil { params = &CreateKnowledgeBaseInput{} @@ -52,8 +43,8 @@ func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledg type CreateKnowledgeBaseInput struct { - // The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your - // own content. EXTERNAL knowledge bases support integrations with third-party + // The type of knowledge base. Only CUSTOM knowledge bases allow you to upload + // your own content. EXTERNAL knowledge bases support integrations with third-party // systems whose content is synchronized automatically. // // This member is required. @@ -67,8 +58,8 @@ type CreateKnowledgeBaseInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The description. diff --git a/service/wisdom/api_op_CreateSession.go b/service/wisdom/api_op_CreateSession.go index af9c85be50a..80822f72fac 100644 --- a/service/wisdom/api_op_CreateSession.go +++ b/service/wisdom/api_op_CreateSession.go @@ -46,8 +46,8 @@ type CreateSessionInput struct { // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with - // idempotent APIs - // (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) + // . ClientToken *string // The description. diff --git a/service/wisdom/api_op_DeleteKnowledgeBase.go b/service/wisdom/api_op_DeleteKnowledgeBase.go index aa3af8c9626..c544241156b 100644 --- a/service/wisdom/api_op_DeleteKnowledgeBase.go +++ b/service/wisdom/api_op_DeleteKnowledgeBase.go @@ -11,15 +11,12 @@ import ( ) // Deletes the knowledge base. When you use this API to delete an external -// knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon -// AppIntegrations -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) +// knowledge base such as Salesforce or ServiceNow, you must also delete the +// Amazon AppIntegrations (https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) // DataIntegration. This is because you can't reuse the DataIntegration after it's // been associated with an external knowledge base. However, you can delete and -// recreate it. See DeleteDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) -// and CreateDataIntegration -// (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) +// recreate it. See DeleteDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) +// and CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) // in the Amazon AppIntegrations API Reference. func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error) { if params == nil { @@ -38,8 +35,8 @@ func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledg type DeleteKnowledgeBaseInput struct { - // The knowledge base to delete content from. Can be either the ID or the ARN. URLs - // cannot contain the ARN. + // The knowledge base to delete content from. Can be either the ID or the ARN. + // URLs cannot contain the ARN. // // This member is required. KnowledgeBaseId *string diff --git a/service/wisdom/api_op_GetRecommendations.go b/service/wisdom/api_op_GetRecommendations.go index 48d2040b227..dd33e243f6d 100644 --- a/service/wisdom/api_op_GetRecommendations.go +++ b/service/wisdom/api_op_GetRecommendations.go @@ -12,12 +12,11 @@ import ( ) // Retrieves recommendations for the specified session. To avoid retrieving the -// same recommendations in subsequent calls, use NotifyRecommendationsReceived -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html). -// This API supports long-polling behavior with the waitTimeSeconds parameter. +// same recommendations in subsequent calls, use NotifyRecommendationsReceived (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html) +// . This API supports long-polling behavior with the waitTimeSeconds parameter. // Short poll is the default behavior and only returns recommendations already -// available. To perform a manual query against an assistant, use QueryAssistant -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html). +// available. To perform a manual query against an assistant, use QueryAssistant (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html) +// . func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { if params == nil { params = &GetRecommendationsInput{} @@ -52,7 +51,7 @@ type GetRecommendationsInput struct { // The duration (in seconds) for which the call waits for a recommendation to be // made available before returning. If a recommendation is available, the call - // returns sooner than WaitTimeSeconds. If no messages are available and the wait + // returns sooner than WaitTimeSeconds . If no messages are available and the wait // time expires, the call returns successfully with an empty list. WaitTimeSeconds int32 diff --git a/service/wisdom/api_op_NotifyRecommendationsReceived.go b/service/wisdom/api_op_NotifyRecommendationsReceived.go index 0d2ddd0a7e9..8af5c5b7696 100644 --- a/service/wisdom/api_op_NotifyRecommendationsReceived.go +++ b/service/wisdom/api_op_NotifyRecommendationsReceived.go @@ -13,8 +13,7 @@ import ( // Removes the specified recommendations from the specified assistant's queue of // newly available recommendations. You can use this API in conjunction with -// GetRecommendations -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html) +// GetRecommendations (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html) // and a waitTimeSeconds input for long-polling behavior and avoiding duplicate // recommendations. func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, optFns ...func(*Options)) (*NotifyRecommendationsReceivedOutput, error) { diff --git a/service/wisdom/api_op_QueryAssistant.go b/service/wisdom/api_op_QueryAssistant.go index 7dc1a564b90..f9fc7a46f6e 100644 --- a/service/wisdom/api_op_QueryAssistant.go +++ b/service/wisdom/api_op_QueryAssistant.go @@ -13,8 +13,8 @@ import ( ) // Performs a manual search against the specified assistant. To retrieve -// recommendations for an assistant, use GetRecommendations -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html). +// recommendations for an assistant, use GetRecommendations (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html) +// . func (c *Client) QueryAssistant(ctx context.Context, params *QueryAssistantInput, optFns ...func(*Options)) (*QueryAssistantOutput, error) { if params == nil { params = &QueryAssistantInput{} diff --git a/service/wisdom/api_op_StartContentUpload.go b/service/wisdom/api_op_StartContentUpload.go index 21fb466fdf1..87dd7d74061 100644 --- a/service/wisdom/api_op_StartContentUpload.go +++ b/service/wisdom/api_op_StartContentUpload.go @@ -11,12 +11,10 @@ import ( "time" ) -// Get a URL to upload content to a knowledge base. To upload content, first make a -// PUT request to the returned URL with your file, making sure to include the -// required headers. Then use CreateContent -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html) -// to finalize the content creation process or UpdateContent -// (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html) +// Get a URL to upload content to a knowledge base. To upload content, first make +// a PUT request to the returned URL with your file, making sure to include the +// required headers. Then use CreateContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html) +// to finalize the content creation process or UpdateContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html) // to modify an existing resource. You can only upload content to a knowledge base // of type CUSTOM. func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error) { diff --git a/service/wisdom/api_op_UpdateContent.go b/service/wisdom/api_op_UpdateContent.go index 8c766c249ab..4662b0aa7ce 100644 --- a/service/wisdom/api_op_UpdateContent.go +++ b/service/wisdom/api_op_UpdateContent.go @@ -48,7 +48,7 @@ type UpdateContentInput struct { // The URI for the article. If the knowledge base has a templateUri, setting this // argument overrides it for this piece of content. To remove an existing - // overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to + // overrideLinkOurUri , exclude this argument and set removeOverrideLinkOutUri to // true. OverrideLinkOutUri *string @@ -56,17 +56,17 @@ type UpdateContentInput struct { RemoveOverrideLinkOutUri *bool // The revisionId of the content resource to update, taken from an earlier call to - // GetContent, GetContentSummary, SearchContent, or ListContents. If included, this - // argument acts as an optimistic lock to ensure content was not modified since it - // was last read. If it has been modified, this API throws a - // PreconditionFailedException. + // GetContent , GetContentSummary , SearchContent , or ListContents . If included, + // this argument acts as an optimistic lock to ensure content was not modified + // since it was last read. If it has been modified, this API throws a + // PreconditionFailedException . RevisionId *string // The title of the content. Title *string - // A pointer to the uploaded asset. This value is returned by StartContentUpload - // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html). + // A pointer to the uploaded asset. This value is returned by StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) + // . UploadId *string noSmithyDocumentSerde diff --git a/service/wisdom/api_op_UpdateKnowledgeBaseTemplateUri.go b/service/wisdom/api_op_UpdateKnowledgeBaseTemplateUri.go index db33b57a5f4..b32ebe79ce7 100644 --- a/service/wisdom/api_op_UpdateKnowledgeBaseTemplateUri.go +++ b/service/wisdom/api_op_UpdateKnowledgeBaseTemplateUri.go @@ -16,7 +16,8 @@ import ( // format; this interpolated by Wisdom using ingested content. For example, if you // ingest a Salesforce article, it has an Id value, and you can set the template // URI to -// https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view. +// https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view +// . func (c *Client) UpdateKnowledgeBaseTemplateUri(ctx context.Context, params *UpdateKnowledgeBaseTemplateUriInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseTemplateUriOutput, error) { if params == nil { params = &UpdateKnowledgeBaseTemplateUriInput{} diff --git a/service/wisdom/types/enums.go b/service/wisdom/types/enums.go index 655dc9ac9cd..30af06a6bae 100644 --- a/service/wisdom/types/enums.go +++ b/service/wisdom/types/enums.go @@ -173,9 +173,9 @@ const ( RecommendationSourceTypeOther RecommendationSourceType = "OTHER" ) -// Values returns all known values for RecommendationSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for RecommendationSourceType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationSourceType) Values() []RecommendationSourceType { return []RecommendationSourceType{ "ISSUE_DETECTION", diff --git a/service/wisdom/types/errors.go b/service/wisdom/types/errors.go index 155928b89db..6f8e4a1ceb1 100644 --- a/service/wisdom/types/errors.go +++ b/service/wisdom/types/errors.go @@ -34,9 +34,9 @@ func (e *AccessDeniedException) ErrorCode() string { func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request could not be processed because of conflict in the current state of -// the resource. For example, if you're using a Create API (such as -// CreateAssistant) that accepts name, a conflicting resource (usually with the -// same name) is being created or mutated. +// the resource. For example, if you're using a Create API (such as CreateAssistant +// ) that accepts name, a conflicting resource (usually with the same name) is +// being created or mutated. type ConflictException struct { Message *string @@ -62,8 +62,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The provided revisionId does not match, indicating the content has been modified -// since it was last read. +// The provided revisionId does not match, indicating the content has been +// modified since it was last read. type PreconditionFailedException struct { Message *string @@ -117,8 +117,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've exceeded your service quota. To perform the requested action, remove some -// of the relevant resources, or use service quotas to request a service quota +// You've exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use service quotas to request a service quota // increase. type ServiceQuotaExceededException struct { Message *string diff --git a/service/wisdom/types/types.go b/service/wisdom/types/types.go index 9076661537d..79f5f647e6d 100644 --- a/service/wisdom/types/types.go +++ b/service/wisdom/types/types.go @@ -11,57 +11,39 @@ import ( // content. type AppIntegrationsConfiguration struct { - // The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for - // ingesting content. - // - // * For Salesforce - // (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm), - // your AppIntegrations DataIntegration must have an ObjectConfiguration if - // objectFields is not provided, including at least Id, ArticleNumber, - // VersionNumber, Title, PublishStatus, and IsDeleted as source fields. - // - // * For - // ServiceNow - // (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api), - // your AppIntegrations DataIntegration must have an ObjectConfiguration if - // objectFields is not provided, including at least number, short_description, - // sys_mod_count, workflow_state, and active as source fields. - // - // * For Zendesk - // (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/), - // your AppIntegrations DataIntegration must have an ObjectConfiguration if - // objectFields is not provided, including at least id, title, updated_at, and - // draft as source fields. - // - // * For SharePoint - // (https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index), - // your AppIntegrations DataIntegration must have a FileConfiguration, including - // only file extensions that are among docx, pdf, html, htm, and txt. + // The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use + // for ingesting content. + // - For Salesforce (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm) + // , your AppIntegrations DataIntegration must have an ObjectConfiguration if + // objectFields is not provided, including at least Id , ArticleNumber , + // VersionNumber , Title , PublishStatus , and IsDeleted as source fields. + // - For ServiceNow (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api) + // , your AppIntegrations DataIntegration must have an ObjectConfiguration if + // objectFields is not provided, including at least number , short_description , + // sys_mod_count , workflow_state , and active as source fields. + // - For Zendesk (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/) + // , your AppIntegrations DataIntegration must have an ObjectConfiguration if + // objectFields is not provided, including at least id , title , updated_at , and + // draft as source fields. + // - For SharePoint (https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index) + // , your AppIntegrations DataIntegration must have a FileConfiguration, including + // only file extensions that are among docx , pdf , html , htm , and txt . // // This member is required. AppIntegrationArn *string // The fields from the source that are made available to your agents in Wisdom. // Optional if ObjectConfiguration is included in the provided DataIntegration. - // - // * - // For Salesforce - // (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm), - // you must include at least Id, ArticleNumber, VersionNumber, Title, - // PublishStatus, and IsDeleted. - // - // * For ServiceNow - // (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api), - // you must include at least number, short_description, sys_mod_count, - // workflow_state, and active. - // - // * For Zendesk - // (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/), - // you must include at least id, title, updated_at, and draft. - // - // Make sure to - // include additional fields. These fields are indexed and used to source - // recommendations. + // - For Salesforce (https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm) + // , you must include at least Id , ArticleNumber , VersionNumber , Title , + // PublishStatus , and IsDeleted . + // - For ServiceNow (https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api) + // , you must include at least number , short_description , sys_mod_count , + // workflow_state , and active . + // - For Zendesk (https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/) + // , you must include at least id , title , updated_at , and draft . + // Make sure to include additional fields. These fields are indexed and used to + // source recommendations. ObjectFields []string noSmithyDocumentSerde @@ -467,8 +449,8 @@ type Filter struct { noSmithyDocumentSerde } -// Offset specification to describe highlighting of document excerpts for rendering -// search results and recommendations. +// Offset specification to describe highlighting of document excerpts for +// rendering search results and recommendations. type Highlight struct { // The offset for the start of the highlight. @@ -655,12 +637,10 @@ type RecommendationTrigger struct { RecommendationIds []string // The source of the recommendation trigger. - // - // * ISSUE_DETECTION: The corresponding - // recommendations were triggered by a Contact Lens issue. - // - // * RULE_EVALUATION: The - // corresponding recommendations were triggered by a Contact Lens rule. + // - ISSUE_DETECTION: The corresponding recommendations were triggered by a + // Contact Lens issue. + // - RULE_EVALUATION: The corresponding recommendations were triggered by a + // Contact Lens rule. // // This member is required. Source RecommendationSourceType @@ -697,19 +677,14 @@ type RenderingConfiguration struct { // A URI template containing exactly one variable in ${variableName} format. This // can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and // Zendesk, the variable must be one of the following: - // - // * Salesforce: Id, - // ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted - // - // * ServiceNow: - // number, short_description, sys_mod_count, workflow_state, or active - // - // * Zendesk: - // id, title, updated_at, or draft - // - // The variable is replaced with the actual value - // for a piece of content when calling GetContent - // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html). + // - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or + // IsDeleted + // - ServiceNow: number , short_description , sys_mod_count , workflow_state , or + // active + // - Zendesk: id , title , updated_at , or draft + // The variable is replaced with the actual value for a piece of content when + // calling GetContent (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html) + // . TemplateUri *string noSmithyDocumentSerde @@ -748,8 +723,8 @@ type SearchExpression struct { // The KMS key used for encryption. type ServerSideEncryptionConfiguration struct { - // The KMS key. For information about valid ID values, see Key identifiers (KeyId) - // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id). + // The KMS key. For information about valid ID values, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) + // . KmsKeyId *string noSmithyDocumentSerde diff --git a/service/workdocs/api_client.go b/service/workdocs/api_client.go index 64e61340d5c..6d56b81f472 100644 --- a/service/workdocs/api_client.go +++ b/service/workdocs/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/workdocs/api_op_AbortDocumentVersionUpload.go b/service/workdocs/api_op_AbortDocumentVersionUpload.go index e3f5e2126f7..c7fa4ab9ed8 100644 --- a/service/workdocs/api_op_AbortDocumentVersionUpload.go +++ b/service/workdocs/api_op_AbortDocumentVersionUpload.go @@ -11,7 +11,7 @@ import ( ) // Aborts the upload of the specified document version that was previously -// initiated by InitiateDocumentVersionUpload. The client should make this call +// initiated by InitiateDocumentVersionUpload . The client should make this call // only when it no longer intends to upload the document version, or fails to do // so. func (c *Client) AbortDocumentVersionUpload(ctx context.Context, params *AbortDocumentVersionUploadInput, optFns ...func(*Options)) (*AbortDocumentVersionUploadOutput, error) { diff --git a/service/workdocs/api_op_CreateNotificationSubscription.go b/service/workdocs/api_op_CreateNotificationSubscription.go index f2c5854053d..b9f02083871 100644 --- a/service/workdocs/api_op_CreateNotificationSubscription.go +++ b/service/workdocs/api_op_CreateNotificationSubscription.go @@ -11,10 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives -// a confirmation message, and must confirm the subscription. For more information, -// see Setting up notifications for an IAM user or role -// (https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html) +// Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint +// receives a confirmation message, and must confirm the subscription. For more +// information, see Setting up notifications for an IAM user or role (https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html) // in the Amazon WorkDocs Developer Guide. func (c *Client) CreateNotificationSubscription(ctx context.Context, params *CreateNotificationSubscriptionInput, optFns ...func(*Options)) (*CreateNotificationSubscriptionOutput, error) { if params == nil { @@ -34,7 +33,7 @@ func (c *Client) CreateNotificationSubscription(ctx context.Context, params *Cre type CreateNotificationSubscriptionInput struct { // The endpoint to receive the notifications. If the protocol is HTTPS, the - // endpoint is a URL that begins with https. + // endpoint is a URL that begins with https . // // This member is required. Endpoint *string diff --git a/service/workdocs/api_op_DescribeActivities.go b/service/workdocs/api_op_DescribeActivities.go index adabc1a421c..26691754e48 100644 --- a/service/workdocs/api_op_DescribeActivities.go +++ b/service/workdocs/api_op_DescribeActivities.go @@ -31,8 +31,8 @@ func (c *Client) DescribeActivities(ctx context.Context, params *DescribeActivit type DescribeActivitiesInput struct { - // Specifies which activity types to include in the response. If this field is left - // empty, all activity types are returned. + // Specifies which activity types to include in the response. If this field is + // left empty, all activity types are returned. ActivityTypes *string // Amazon WorkDocs authentication token. Not required when using Amazon Web diff --git a/service/workdocs/api_op_DescribeComments.go b/service/workdocs/api_op_DescribeComments.go index e54ee1246a9..a89bfc47408 100644 --- a/service/workdocs/api_op_DescribeComments.go +++ b/service/workdocs/api_op_DescribeComments.go @@ -47,8 +47,8 @@ type DescribeCommentsInput struct { // The maximum number of items to return. Limit *int32 - // The marker for the next set of results. This marker was received from a previous - // call. + // The marker for the next set of results. This marker was received from a + // previous call. Marker *string noSmithyDocumentSerde @@ -59,8 +59,8 @@ type DescribeCommentsOutput struct { // The list of comments for the specified document version. Comments []types.Comment - // The marker for the next set of results. This marker was received from a previous - // call. + // The marker for the next set of results. This marker was received from a + // previous call. Marker *string // Metadata pertaining to the operation's result. diff --git a/service/workdocs/api_op_DescribeFolderContents.go b/service/workdocs/api_op_DescribeFolderContents.go index 807f10e1e51..08f1e0ab3a3 100644 --- a/service/workdocs/api_op_DescribeFolderContents.go +++ b/service/workdocs/api_op_DescribeFolderContents.go @@ -49,8 +49,8 @@ type DescribeFolderContentsInput struct { // The maximum number of items to return with this call. Limit *int32 - // The marker for the next set of results. This marker was received from a previous - // call. + // The marker for the next set of results. This marker was received from a + // previous call. Marker *string // The order for the contents of the folder. diff --git a/service/workdocs/api_op_DescribeRootFolders.go b/service/workdocs/api_op_DescribeRootFolders.go index b7ca6323b76..196c99cca33 100644 --- a/service/workdocs/api_op_DescribeRootFolders.go +++ b/service/workdocs/api_op_DescribeRootFolders.go @@ -12,13 +12,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the current user's special folders; the RootFolder and the RecycleBin. -// RootFolder is the root of user's files and folders and RecycleBin is the root of -// recycled items. This is not a valid action for SigV4 (administrative API) +// Describes the current user's special folders; the RootFolder and the RecycleBin +// . RootFolder is the root of user's files and folders and RecycleBin is the root +// of recycled items. This is not a valid action for SigV4 (administrative API) // clients. This action requires an authentication token. To get an authentication // token, register an application with Amazon WorkDocs. For more information, see -// Authentication and Access Control for User Applications -// (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) +// Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) // in the Amazon WorkDocs Developer Guide. func (c *Client) DescribeRootFolders(ctx context.Context, params *DescribeRootFoldersInput, optFns ...func(*Options)) (*DescribeRootFoldersOutput, error) { if params == nil { @@ -129,8 +128,8 @@ func (c *Client) addOperationDescribeRootFoldersMiddlewares(stack *middleware.St return nil } -// DescribeRootFoldersAPIClient is a client that implements the DescribeRootFolders -// operation. +// DescribeRootFoldersAPIClient is a client that implements the +// DescribeRootFolders operation. type DescribeRootFoldersAPIClient interface { DescribeRootFolders(context.Context, *DescribeRootFoldersInput, ...func(*Options)) (*DescribeRootFoldersOutput, error) } diff --git a/service/workdocs/api_op_DescribeUsers.go b/service/workdocs/api_op_DescribeUsers.go index 58cb5076ecd..53ddfd75d39 100644 --- a/service/workdocs/api_op_DescribeUsers.go +++ b/service/workdocs/api_op_DescribeUsers.go @@ -37,8 +37,8 @@ type DescribeUsersInput struct { // Services administrator credentials to access the API. AuthenticationToken *string - // A comma-separated list of values. Specify "STORAGE_METADATA" to include the user - // storage quota and utilization information. + // A comma-separated list of values. Specify "STORAGE_METADATA" to include the + // user storage quota and utilization information. Fields *string // The state of the users. Specify "ALL" to include inactive users. @@ -59,24 +59,17 @@ type DescribeUsersInput struct { // A query to filter users by user name. Remember the following about the Userids // and Query parameters: - // - // * If you don't use either parameter, the API returns a - // paginated list of all users on the site. - // - // * If you use both parameters, the API - // ignores the Query parameter. - // - // * The Userid parameter only returns user names - // that match a corresponding user ID. - // - // * The Query parameter runs a "prefix" - // search for users by the GivenName, SurName, or UserName fields included in a - // CreateUser - // (https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html) - // API call. For example, querying on Ma returns Márcia Oliveira, María García, and - // Mateo Jackson. If you use multiple characters, the API only returns data that - // matches all characters. For example, querying on Ma J only returns Mateo - // Jackson. + // - If you don't use either parameter, the API returns a paginated list of all + // users on the site. + // - If you use both parameters, the API ignores the Query parameter. + // - The Userid parameter only returns user names that match a corresponding user + // ID. + // - The Query parameter runs a "prefix" search for users by the GivenName , + // SurName , or UserName fields included in a CreateUser (https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html) + // API call. For example, querying on Ma returns Márcia Oliveira, María García, + // and Mateo Jackson. If you use multiple characters, the API only returns data + // that matches all characters. For example, querying on Ma J only returns Mateo + // Jackson. Query *string // The sorting criteria. diff --git a/service/workdocs/api_op_GetCurrentUser.go b/service/workdocs/api_op_GetCurrentUser.go index ba8053dc2f8..61a5ddfc21a 100644 --- a/service/workdocs/api_op_GetCurrentUser.go +++ b/service/workdocs/api_op_GetCurrentUser.go @@ -15,8 +15,7 @@ import ( // generated. This is not a valid action for SigV4 (administrative API) clients. // This action requires an authentication token. To get an authentication token, // register an application with Amazon WorkDocs. For more information, see -// Authentication and Access Control for User Applications -// (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) +// Authentication and Access Control for User Applications (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html) // in the Amazon WorkDocs Developer Guide. func (c *Client) GetCurrentUser(ctx context.Context, params *GetCurrentUserInput, optFns ...func(*Options)) (*GetCurrentUserOutput, error) { if params == nil { diff --git a/service/workdocs/api_op_GetResources.go b/service/workdocs/api_op_GetResources.go index 86eae83586c..dc74bb86efa 100644 --- a/service/workdocs/api_op_GetResources.go +++ b/service/workdocs/api_op_GetResources.go @@ -12,7 +12,7 @@ import ( ) // Retrieves a collection of resources, including folders and documents. The only -// CollectionType supported is SHARED_WITH_ME. +// CollectionType supported is SHARED_WITH_ME . func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, optFns ...func(*Options)) (*GetResourcesOutput, error) { if params == nil { params = &GetResourcesInput{} @@ -40,8 +40,8 @@ type GetResourcesInput struct { // The maximum number of resources to return. Limit *int32 - // The marker for the next set of results. This marker was received from a previous - // call. + // The marker for the next set of results. This marker was received from a + // previous call. Marker *string // The user ID for the resource collection. This is a required field for accessing diff --git a/service/workdocs/api_op_InitiateDocumentVersionUpload.go b/service/workdocs/api_op_InitiateDocumentVersionUpload.go index 19bc34dbf38..e93acdb5477 100644 --- a/service/workdocs/api_op_InitiateDocumentVersionUpload.go +++ b/service/workdocs/api_op_InitiateDocumentVersionUpload.go @@ -16,8 +16,8 @@ import ( // parent folder ID and name of the document to upload. The ID is optionally // specified when creating a new version of an existing document. This is the first // step to upload a document. Next, upload the document to the URL returned from -// the call, and then call UpdateDocumentVersion. To cancel the document upload, -// call AbortDocumentVersionUpload. +// the call, and then call UpdateDocumentVersion . To cancel the document upload, +// call AbortDocumentVersionUpload . func (c *Client) InitiateDocumentVersionUpload(ctx context.Context, params *InitiateDocumentVersionUploadInput, optFns ...func(*Options)) (*InitiateDocumentVersionUploadOutput, error) { if params == nil { params = &InitiateDocumentVersionUploadInput{} diff --git a/service/workdocs/api_op_SearchResources.go b/service/workdocs/api_op_SearchResources.go index f370a8b5b7b..c68da78c6c7 100644 --- a/service/workdocs/api_op_SearchResources.go +++ b/service/workdocs/api_op_SearchResources.go @@ -31,8 +31,8 @@ func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInp type SearchResourcesInput struct { - // A list of attributes to include in the response. Used to request fields that are - // not normally returned in a standard response. + // A list of attributes to include in the response. Used to request fields that + // are not normally returned in a standard response. AdditionalResponseFields []types.AdditionalResponseFieldType // Amazon WorkDocs authentication token. Not required when using Amazon Web @@ -60,8 +60,9 @@ type SearchResourcesInput struct { // and content QueryScopes []types.SearchQueryScopeType - // The String to search for. Searches across different text fields based on request - // parameters. Use double quotes around the query string for exact phrase matches. + // The String to search for. Searches across different text fields based on + // request parameters. Use double quotes around the query string for exact phrase + // matches. QueryText *string noSmithyDocumentSerde diff --git a/service/workdocs/api_op_UpdateDocumentVersion.go b/service/workdocs/api_op_UpdateDocumentVersion.go index 46027f85380..881952e3ea6 100644 --- a/service/workdocs/api_op_UpdateDocumentVersion.go +++ b/service/workdocs/api_op_UpdateDocumentVersion.go @@ -14,7 +14,7 @@ import ( // Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets // its document container to ACTIVE. This is the last step in a document upload, // after the client uploads the document to an S3-presigned URL returned by -// InitiateDocumentVersionUpload. +// InitiateDocumentVersionUpload . func (c *Client) UpdateDocumentVersion(ctx context.Context, params *UpdateDocumentVersionInput, optFns ...func(*Options)) (*UpdateDocumentVersionOutput, error) { if params == nil { params = &UpdateDocumentVersionInput{} diff --git a/service/workdocs/doc.go b/service/workdocs/doc.go index 854b81b36ec..75a2ab75d9e 100644 --- a/service/workdocs/doc.go +++ b/service/workdocs/doc.go @@ -4,49 +4,38 @@ // Amazon WorkDocs. // // The Amazon WorkDocs API is designed for the following use cases: -// -// * File -// Migration: File migration applications are supported for users who want to -// migrate their files from an on-premises or off-premises file system or service. -// Users can insert files into a user directory structure, as well as allow for -// basic metadata changes, such as modifications to the permissions of files. -// -// * -// Security: Support security applications are supported for users who have -// additional security needs, such as antivirus or data loss prevention. The API -// actions, along with CloudTrail, allow these applications to detect when changes -// occur in Amazon WorkDocs. Then, the application can take the necessary actions -// and replace the target file. If the target file violates the policy, the -// application can also choose to email the user. -// -// * eDiscovery/Analytics: General -// administrative applications are supported, such as eDiscovery and analytics. -// These applications can choose to mimic or record the actions in an Amazon -// WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, -// or analytical applications. -// -// All Amazon WorkDocs API actions are Amazon -// authenticated and certificate-signed. They not only require the use of the -// Amazon Web Services SDK, but also allow for the exclusive use of IAM users and -// roles to help facilitate access, trust, and permission policies. By creating a -// role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user -// gains full administrative visibility into the entire Amazon WorkDocs site (or as -// set in the IAM policy). This includes, but is not limited to, the ability to -// modify file permissions and upload any file to any user. This allows developers -// to perform the three use cases above, as well as give users the ability to grant -// access on a selective basis using the IAM model. The pricing for Amazon WorkDocs -// APIs varies depending on the API call type for these actions: -// -// * READ (Get*) -// -// * -// WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) -// -// * LIST -// (Describe*) -// -// * DELETE*, CANCEL -// -// For information about Amazon WorkDocs API -// pricing, see Amazon WorkDocs Pricing (https://aws.amazon.com/workdocs/pricing/). +// - File Migration: File migration applications are supported for users who +// want to migrate their files from an on-premises or off-premises file system or +// service. Users can insert files into a user directory structure, as well as +// allow for basic metadata changes, such as modifications to the permissions of +// files. +// - Security: Support security applications are supported for users who have +// additional security needs, such as antivirus or data loss prevention. The API +// actions, along with CloudTrail, allow these applications to detect when changes +// occur in Amazon WorkDocs. Then, the application can take the necessary actions +// and replace the target file. If the target file violates the policy, the +// application can also choose to email the user. +// - eDiscovery/Analytics: General administrative applications are supported, +// such as eDiscovery and analytics. These applications can choose to mimic or +// record the actions in an Amazon WorkDocs site, along with CloudTrail, to +// replicate data for eDiscovery, backup, or analytical applications. +// +// All Amazon WorkDocs API actions are Amazon authenticated and +// certificate-signed. They not only require the use of the Amazon Web Services +// SDK, but also allow for the exclusive use of IAM users and roles to help +// facilitate access, trust, and permission policies. By creating a role and +// allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full +// administrative visibility into the entire Amazon WorkDocs site (or as set in the +// IAM policy). This includes, but is not limited to, the ability to modify file +// permissions and upload any file to any user. This allows developers to perform +// the three use cases above, as well as give users the ability to grant access on +// a selective basis using the IAM model. The pricing for Amazon WorkDocs APIs +// varies depending on the API call type for these actions: +// - READ (Get*) +// - WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*) +// - LIST (Describe*) +// - DELETE*, CANCEL +// +// For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing (https://aws.amazon.com/workdocs/pricing/) +// . package workdocs diff --git a/service/workdocs/types/enums.go b/service/workdocs/types/enums.go index 2fbc8a63ce6..da6e960ed2f 100644 --- a/service/workdocs/types/enums.go +++ b/service/workdocs/types/enums.go @@ -41,9 +41,9 @@ const ( ActivityTypeFolderMoved ActivityType = "FOLDER_MOVED" ) -// Values returns all known values for ActivityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ActivityType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ActivityType) Values() []ActivityType { return []ActivityType{ "DOCUMENT_CHECKED_IN", @@ -144,8 +144,8 @@ const ( CommentVisibilityTypePrivate CommentVisibilityType = "PRIVATE" ) -// Values returns all known values for CommentVisibilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for CommentVisibilityType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (CommentVisibilityType) Values() []CommentVisibilityType { return []CommentVisibilityType{ @@ -231,8 +231,8 @@ const ( DocumentThumbnailTypeLarge DocumentThumbnailType = "LARGE" ) -// Values returns all known values for DocumentThumbnailType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DocumentThumbnailType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DocumentThumbnailType) Values() []DocumentThumbnailType { return []DocumentThumbnailType{ @@ -249,8 +249,8 @@ const ( DocumentVersionStatusActive DocumentVersionStatus = "ACTIVE" ) -// Values returns all known values for DocumentVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DocumentVersionStatus. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DocumentVersionStatus) Values() []DocumentVersionStatus { return []DocumentVersionStatus{ @@ -422,9 +422,9 @@ const ( OrderTypeDescending OrderType = "DESCENDING" ) -// Values returns all known values for OrderType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for OrderType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (OrderType) Values() []OrderType { return []OrderType{ "ASCENDING", @@ -542,9 +542,9 @@ const ( ResourceTypeDocument ResourceType = "DOCUMENT" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "FOLDER", @@ -698,9 +698,9 @@ const ( SortOrderDesc SortOrder = "DESC" ) -// Values returns all known values for SortOrder. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for SortOrder. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (SortOrder) Values() []SortOrder { return []SortOrder{ "ASC", @@ -734,9 +734,9 @@ const ( SubscriptionProtocolTypeSqs SubscriptionProtocolType = "SQS" ) -// Values returns all known values for SubscriptionProtocolType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for SubscriptionProtocolType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionProtocolType) Values() []SubscriptionProtocolType { return []SubscriptionProtocolType{ "HTTPS", @@ -789,9 +789,9 @@ const ( UserSortTypeStorageUsed UserSortType = "STORAGE_USED" ) -// Values returns all known values for UserSortType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for UserSortType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (UserSortType) Values() []UserSortType { return []UserSortType{ "USER_NAME", diff --git a/service/workdocs/types/errors.go b/service/workdocs/types/errors.go index 532636edf5e..b0676defc94 100644 --- a/service/workdocs/types/errors.go +++ b/service/workdocs/types/errors.go @@ -33,8 +33,8 @@ func (e *ConcurrentModificationException) ErrorCode() string { } func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Another operation is in progress on the resource that conflicts with the current -// operation. +// Another operation is in progress on the resource that conflicts with the +// current operation. type ConflictingOperationException struct { Message *string @@ -119,8 +119,8 @@ func (e *DeactivatingLastSystemUserException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the document is locked for comments and user tries -// to create or delete a comment on that document. +// This exception is thrown when the document is locked for comments and user +// tries to create or delete a comment on that document. type DocumentLockedForCommentsException struct { Message *string @@ -440,8 +440,8 @@ func (e *ProhibitedStateException) ErrorCode() string { } func (e *ProhibitedStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The response is too large to return. The request must include a filter to reduce -// the size of the response. +// The response is too large to return. The request must include a filter to +// reduce the size of the response. type RequestedEntityTooLargeException struct { Message *string diff --git a/service/workdocs/types/types.go b/service/workdocs/types/types.go index 306a4a5571a..46a81287909 100644 --- a/service/workdocs/types/types.go +++ b/service/workdocs/types/types.go @@ -10,8 +10,8 @@ import ( // Describes the activity information. type Activity struct { - // Metadata of the commenting activity. This is an optional field and is filled for - // commenting activities. + // Metadata of the commenting activity. This is an optional field and is filled + // for commenting activities. CommentMetadata *CommentMetadata // The user who performed the action. @@ -26,8 +26,8 @@ type Activity struct { // The ID of the organization. OrganizationId *string - // The original parent of the resource. This is an optional field and is filled for - // move activities. + // The original parent of the resource. This is an optional field and is filled + // for move activities. OriginalParent *ResourceMetadata // The list of users or groups impacted by this action. This is an optional field diff --git a/service/worklink/api_client.go b/service/worklink/api_client.go index 8cbd37ca6e3..160cdc5c6dd 100644 --- a/service/worklink/api_client.go +++ b/service/worklink/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go b/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go index aae9d4d6032..42eb28fa414 100644 --- a/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go +++ b/service/worklink/api_op_AssociateWebsiteAuthorizationProvider.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a website authorization provider with a specified fleet. This is used -// to authorize users against associated websites in the company network. +// Associates a website authorization provider with a specified fleet. This is +// used to authorize users against associated websites in the company network. // // Deprecated: Amazon WorkLink is no longer supported. This will be removed in a // future version of the SDK. diff --git a/service/worklink/api_op_DescribeFleetMetadata.go b/service/worklink/api_op_DescribeFleetMetadata.go index e58eef19355..d81a9aa6809 100644 --- a/service/worklink/api_op_DescribeFleetMetadata.go +++ b/service/worklink/api_op_DescribeFleetMetadata.go @@ -12,8 +12,8 @@ import ( "time" ) -// Provides basic information for the specified fleet, excluding identity provider, -// networking, and device configuration details. +// Provides basic information for the specified fleet, excluding identity +// provider, networking, and device configuration details. // // Deprecated: Amazon WorkLink is no longer supported. This will be removed in a // future version of the SDK. diff --git a/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go b/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go index 6f47d604d0c..1cc40e8ab40 100644 --- a/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go +++ b/service/worklink/api_op_DisassociateWebsiteAuthorizationProvider.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a website authorization provider from a specified fleet. After the -// disassociation, users can't load any associated websites that require this +// Disassociates a website authorization provider from a specified fleet. After +// the disassociation, users can't load any associated websites that require this // authorization provider. // // Deprecated: Amazon WorkLink is no longer supported. This will be removed in a diff --git a/service/worklink/api_op_SignOutUser.go b/service/worklink/api_op_SignOutUser.go index b05347b91ee..e509e68db3d 100644 --- a/service/worklink/api_op_SignOutUser.go +++ b/service/worklink/api_op_SignOutUser.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Signs the user out from all of their devices. The user can sign in again if they -// have valid credentials. +// Signs the user out from all of their devices. The user can sign in again if +// they have valid credentials. // // Deprecated: Amazon WorkLink is no longer supported. This will be removed in a // future version of the SDK. diff --git a/service/worklink/api_op_TagResource.go b/service/worklink/api_op_TagResource.go index 26b6e7fbabc..37b912f75dc 100644 --- a/service/worklink/api_op_TagResource.go +++ b/service/worklink/api_op_TagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or overwrites one or more tags for the specified resource, such as a fleet. -// Each tag consists of a key and an optional value. If a resource already has a -// tag with the same key, this operation updates its value. +// Adds or overwrites one or more tags for the specified resource, such as a +// fleet. Each tag consists of a key and an optional value. If a resource already +// has a tag with the same key, this operation updates its value. // // Deprecated: Amazon WorkLink is no longer supported. This will be removed in a // future version of the SDK. diff --git a/service/worklink/doc.go b/service/worklink/doc.go index b026571d5ea..83d7355adcd 100644 --- a/service/worklink/doc.go +++ b/service/worklink/doc.go @@ -3,12 +3,12 @@ // Package worklink provides the API client, operations, and parameter types for // Amazon WorkLink. // -// Amazon WorkLink is a cloud-based service that provides secure access to internal -// websites and web apps from iOS and Android phones. In a single step, your users, -// such as employees, can access internal websites as efficiently as they access -// any other public website. They enter a URL in their web browser, or choose a -// link to an internal website in an email. Amazon WorkLink authenticates the -// user's access and securely renders authorized internal web content in a secure -// rendering service in the AWS cloud. Amazon WorkLink doesn't download or store -// any internal web content on mobile devices. +// Amazon WorkLink is a cloud-based service that provides secure access to +// internal websites and web apps from iOS and Android phones. In a single step, +// your users, such as employees, can access internal websites as efficiently as +// they access any other public website. They enter a URL in their web browser, or +// choose a link to an internal website in an email. Amazon WorkLink authenticates +// the user's access and securely renders authorized internal web content in a +// secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or +// store any internal web content on mobile devices. package worklink diff --git a/service/worklink/types/enums.go b/service/worklink/types/enums.go index b83b62571a4..82eb133259a 100644 --- a/service/worklink/types/enums.go +++ b/service/worklink/types/enums.go @@ -26,9 +26,9 @@ const ( DeviceStatusSignedOut DeviceStatus = "SIGNED_OUT" ) -// Values returns all known values for DeviceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DeviceStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DeviceStatus) Values() []DeviceStatus { return []DeviceStatus{ "ACTIVE", @@ -50,9 +50,9 @@ const ( DomainStatusFailedToDisassociate DomainStatus = "FAILED_TO_DISASSOCIATE" ) -// Values returns all known values for DomainStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for DomainStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (DomainStatus) Values() []DomainStatus { return []DomainStatus{ "PENDING_VALIDATION", diff --git a/service/workmail/api_client.go b/service/workmail/api_client.go index eee62e53751..4bde8994389 100644 --- a/service/workmail/api_client.go +++ b/service/workmail/api_client.go @@ -122,7 +122,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/workmail/api_op_CreateAvailabilityConfiguration.go b/service/workmail/api_op_CreateAvailabilityConfiguration.go index 675236be5b2..93f8f7b15ce 100644 --- a/service/workmail/api_op_CreateAvailabilityConfiguration.go +++ b/service/workmail/api_op_CreateAvailabilityConfiguration.go @@ -46,11 +46,11 @@ type CreateAvailabilityConfigurationInput struct { ClientToken *string // Exchange Web Services (EWS) availability provider definition. The request must - // contain exactly one provider definition, either EwsProvider or LambdaProvider. + // contain exactly one provider definition, either EwsProvider or LambdaProvider . EwsProvider *types.EwsAvailabilityProvider // Lambda availability provider definition. The request must contain exactly one - // provider definition, either EwsProvider or LambdaProvider. + // provider definition, either EwsProvider or LambdaProvider . LambdaProvider *types.LambdaAvailabilityProvider noSmithyDocumentSerde diff --git a/service/workmail/api_op_CreateImpersonationRole.go b/service/workmail/api_op_CreateImpersonationRole.go index b302a3edc0d..46ea7a590be 100644 --- a/service/workmail/api_op_CreateImpersonationRole.go +++ b/service/workmail/api_op_CreateImpersonationRole.go @@ -49,7 +49,7 @@ type CreateImpersonationRoleInput struct { Rules []types.ImpersonationRule // The impersonation role's type. The available impersonation role types are - // READ_ONLY or FULL_ACCESS. + // READ_ONLY or FULL_ACCESS . // // This member is required. Type types.ImpersonationRoleType diff --git a/service/workmail/api_op_CreateMobileDeviceAccessRule.go b/service/workmail/api_op_CreateMobileDeviceAccessRule.go index 84fff3cd36e..0afd8a38dac 100644 --- a/service/workmail/api_op_CreateMobileDeviceAccessRule.go +++ b/service/workmail/api_op_CreateMobileDeviceAccessRule.go @@ -30,7 +30,7 @@ func (c *Client) CreateMobileDeviceAccessRule(ctx context.Context, params *Creat type CreateMobileDeviceAccessRuleInput struct { - // The effect of the rule when it matches. Allowed values are ALLOW or DENY. + // The effect of the rule when it matches. Allowed values are ALLOW or DENY . // // This member is required. Effect types.MobileDeviceAccessRuleEffect diff --git a/service/workmail/api_op_CreateOrganization.go b/service/workmail/api_op_CreateOrganization.go index 6df359e5c7c..ed350b5fe17 100644 --- a/service/workmail/api_op_CreateOrganization.go +++ b/service/workmail/api_op_CreateOrganization.go @@ -17,17 +17,14 @@ import ( // Directory Service directory ID is specified, the organization alias must match // the directory alias. If you choose not to associate an existing directory with // your organization, then we create a new WorkMail directory for you. For more -// information, see Adding an organization -// (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html) +// information, see Adding an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html) // in the WorkMail Administrator Guide. You can associate multiple email domains // with an organization, then choose your default email domain from the WorkMail // console. You can also associate a domain that is managed in an Amazon Route 53 -// public hosted zone. For more information, see Adding a domain -// (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) and -// Choosing the default domain -// (https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html) in -// the WorkMail Administrator Guide. Optionally, you can use a customer managed key -// from AWS Key Management Service (AWS KMS) to encrypt email for your +// public hosted zone. For more information, see Adding a domain (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) +// and Choosing the default domain (https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html) +// in the WorkMail Administrator Guide. Optionally, you can use a customer managed +// key from AWS Key Management Service (AWS KMS) to encrypt email for your // organization. If you don't associate an AWS KMS key, WorkMail creates a default, // AWS managed key for you. func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error) { @@ -61,8 +58,8 @@ type CreateOrganizationInput struct { // The email domains to associate with the organization. Domains []types.Domain - // When true, allows organization interoperability between WorkMail and Microsoft - // Exchange. If true, you must include a AD Connector directory ID in the request. + // When true , allows organization interoperability between WorkMail and Microsoft + // Exchange. If true , you must include a AD Connector directory ID in the request. EnableInteroperability bool // The Amazon Resource Name (ARN) of a customer managed key from AWS KMS. diff --git a/service/workmail/api_op_CreateResource.go b/service/workmail/api_op_CreateResource.go index d06d675eba4..3fa8acf0d0b 100644 --- a/service/workmail/api_op_CreateResource.go +++ b/service/workmail/api_op_CreateResource.go @@ -40,7 +40,7 @@ type CreateResourceInput struct { // This member is required. OrganizationId *string - // The type of the new resource. The available types are equipment and room. + // The type of the new resource. The available types are equipment and room . // // This member is required. Type types.ResourceType diff --git a/service/workmail/api_op_DeleteAccessControlRule.go b/service/workmail/api_op_DeleteAccessControlRule.go index dd033123a3e..0223ee570f6 100644 --- a/service/workmail/api_op_DeleteAccessControlRule.go +++ b/service/workmail/api_op_DeleteAccessControlRule.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an access control rule for the specified WorkMail organization. Deleting -// already deleted and non-existing rules does not produce an error. In those -// cases, the service sends back an HTTP 200 response with an empty HTTP body. +// Deletes an access control rule for the specified WorkMail organization. +// Deleting already deleted and non-existing rules does not produce an error. In +// those cases, the service sends back an HTTP 200 response with an empty HTTP +// body. func (c *Client) DeleteAccessControlRule(ctx context.Context, params *DeleteAccessControlRuleInput, optFns ...func(*Options)) (*DeleteAccessControlRuleOutput, error) { if params == nil { params = &DeleteAccessControlRuleInput{} diff --git a/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go b/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go index 1a455087398..270edcdc79c 100644 --- a/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go @@ -44,15 +44,10 @@ type DeleteMobileDeviceAccessOverrideInput struct { // The WorkMail user for which you want to delete the override. Accepts the // following types of user identities: - // - // * User ID: - // 12345678-1234-1234-1234-123456789012 or - // S-1-1-12-1234567890-123456789-123456789-1234 - // - // * Email address: - // user@domain.tld - // - // * User name: user + // - User ID: 12345678-1234-1234-1234-123456789012 or + // S-1-1-12-1234567890-123456789-123456789-1234 + // - Email address: user@domain.tld + // - User name: user // // This member is required. UserId *string diff --git a/service/workmail/api_op_DeleteOrganization.go b/service/workmail/api_op_DeleteOrganization.go index b0161535723..32f182a9e14 100644 --- a/service/workmail/api_op_DeleteOrganization.go +++ b/service/workmail/api_op_DeleteOrganization.go @@ -13,8 +13,7 @@ import ( // Deletes an WorkMail organization and all underlying AWS resources managed by // WorkMail as part of the organization. You can choose whether to delete the -// associated directory. For more information, see Removing an organization -// (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html) +// associated directory. For more information, see Removing an organization (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html) // in the WorkMail Administrator Guide. func (c *Client) DeleteOrganization(ctx context.Context, params *DeleteOrganizationInput, optFns ...func(*Options)) (*DeleteOrganizationOutput, error) { if params == nil { diff --git a/service/workmail/api_op_DeleteUser.go b/service/workmail/api_op_DeleteUser.go index b8deefb614f..09465907210 100644 --- a/service/workmail/api_op_DeleteUser.go +++ b/service/workmail/api_op_DeleteUser.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a user from WorkMail and all subsequent systems. Before you can delete a -// user, the user state must be DISABLED. Use the DescribeUser action to confirm -// the user state. Deleting a user is permanent and cannot be undone. WorkMail -// archives user mailboxes for 30 days before they are permanently removed. +// Deletes a user from WorkMail and all subsequent systems. Before you can delete +// a user, the user state must be DISABLED . Use the DescribeUser action to +// confirm the user state. Deleting a user is permanent and cannot be undone. +// WorkMail archives user mailboxes for 30 days before they are permanently +// removed. func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/workmail/api_op_DeregisterMailDomain.go b/service/workmail/api_op_DeregisterMailDomain.go index 3d56fb29b54..612d0f92689 100644 --- a/service/workmail/api_op_DeregisterMailDomain.go +++ b/service/workmail/api_op_DeregisterMailDomain.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a domain from WorkMail, stops email routing to WorkMail, and removes the -// authorization allowing WorkMail use. SES keeps the domain because other +// Removes a domain from WorkMail, stops email routing to WorkMail, and removes +// the authorization allowing WorkMail use. SES keeps the domain because other // applications may use it. You must first remove any email address used by // WorkMail entities before you remove the domain. func (c *Client) DeregisterMailDomain(ctx context.Context, params *DeregisterMailDomainInput, optFns ...func(*Options)) (*DeregisterMailDomainOutput, error) { diff --git a/service/workmail/api_op_DescribeGroup.go b/service/workmail/api_op_DescribeGroup.go index 239a27669c2..6a6c6b284eb 100644 --- a/service/workmail/api_op_DescribeGroup.go +++ b/service/workmail/api_op_DescribeGroup.go @@ -45,8 +45,8 @@ type DescribeGroupInput struct { type DescribeGroupOutput struct { - // The date and time when a user was deregistered from WorkMail, in UNIX epoch time - // format. + // The date and time when a user was deregistered from WorkMail, in UNIX epoch + // time format. DisabledDate *time.Time // The email of the described group. diff --git a/service/workmail/api_op_DescribeResource.go b/service/workmail/api_op_DescribeResource.go index b93c66278e6..5254517605c 100644 --- a/service/workmail/api_op_DescribeResource.go +++ b/service/workmail/api_op_DescribeResource.go @@ -49,8 +49,8 @@ type DescribeResourceOutput struct { // The booking options for the described resource. BookingOptions *types.BookingOptions - // The date and time when a resource was disabled from WorkMail, in UNIX epoch time - // format. + // The date and time when a resource was disabled from WorkMail, in UNIX epoch + // time format. DisabledDate *time.Time // The email of the described resource. diff --git a/service/workmail/api_op_DescribeUser.go b/service/workmail/api_op_DescribeUser.go index 125b6900ea1..77d097a260b 100644 --- a/service/workmail/api_op_DescribeUser.go +++ b/service/workmail/api_op_DescribeUser.go @@ -55,8 +55,8 @@ type DescribeUserOutput struct { // The email of the user. Email *string - // The date and time at which the user was enabled for WorkMailusage, in UNIX epoch - // time format. + // The date and time at which the user was enabled for WorkMailusage, in UNIX + // epoch time format. EnabledDate *time.Time // The name for the user. diff --git a/service/workmail/api_op_GetAccessControlEffect.go b/service/workmail/api_op_GetAccessControlEffect.go index 098d2ba13e5..be997f00745 100644 --- a/service/workmail/api_op_GetAccessControlEffect.go +++ b/service/workmail/api_op_GetAccessControlEffect.go @@ -32,8 +32,8 @@ func (c *Client) GetAccessControlEffect(ctx context.Context, params *GetAccessCo type GetAccessControlEffectInput struct { - // The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, - // IMAP, SMTP, WindowsOutlook, and WebMail. + // The access protocol action. Valid values include ActiveSync , AutoDiscover , EWS + // , IMAP , SMTP , WindowsOutlook , and WebMail . // // This member is required. Action *string diff --git a/service/workmail/api_op_GetImpersonationRoleEffect.go b/service/workmail/api_op_GetImpersonationRoleEffect.go index c69c8c2e928..606145a194a 100644 --- a/service/workmail/api_op_GetImpersonationRoleEffect.go +++ b/service/workmail/api_op_GetImpersonationRoleEffect.go @@ -41,15 +41,10 @@ type GetImpersonationRoleEffectInput struct { // The WorkMail organization user chosen to test the impersonation role. The // following identity formats are available: - // - // * User ID: - // 12345678-1234-1234-1234-123456789012 or - // S-1-1-12-1234567890-123456789-123456789-1234 - // - // * Email address: - // user@domain.tld - // - // * User name: user + // - User ID: 12345678-1234-1234-1234-123456789012 or + // S-1-1-12-1234567890-123456789-123456789-1234 + // - Email address: user@domain.tld + // - User name: user // // This member is required. TargetUser *string @@ -60,7 +55,7 @@ type GetImpersonationRoleEffectInput struct { type GetImpersonationRoleEffectOutput struct { // Effect of the impersonation role on the target user based on its rules. - // Available effects are ALLOW or DENY. + // Available effects are ALLOW or DENY . Effect types.AccessEffect // A list of the rules that match the input and produce the configured effect. diff --git a/service/workmail/api_op_GetMailboxDetails.go b/service/workmail/api_op_GetMailboxDetails.go index 4055643d311..7069d86c774 100644 --- a/service/workmail/api_op_GetMailboxDetails.go +++ b/service/workmail/api_op_GetMailboxDetails.go @@ -28,8 +28,8 @@ func (c *Client) GetMailboxDetails(ctx context.Context, params *GetMailboxDetail type GetMailboxDetailsInput struct { - // The identifier for the organization that contains the user whose mailbox details - // are being requested. + // The identifier for the organization that contains the user whose mailbox + // details are being requested. // // This member is required. OrganizationId *string diff --git a/service/workmail/api_op_GetMobileDeviceAccessEffect.go b/service/workmail/api_op_GetMobileDeviceAccessEffect.go index 3f7ba2f6ab7..bada596fa43 100644 --- a/service/workmail/api_op_GetMobileDeviceAccessEffect.go +++ b/service/workmail/api_op_GetMobileDeviceAccessEffect.go @@ -54,7 +54,7 @@ type GetMobileDeviceAccessEffectInput struct { type GetMobileDeviceAccessEffectOutput struct { - // The effect of the simulated access, ALLOW or DENY, after evaluating mobile + // The effect of the simulated access, ALLOW or DENY , after evaluating mobile // device access rules in the WorkMail organization for the simulated user // parameters. Effect types.MobileDeviceAccessRuleEffect diff --git a/service/workmail/api_op_GetMobileDeviceAccessOverride.go b/service/workmail/api_op_GetMobileDeviceAccessOverride.go index 211f18c7fa0..13af78acde1 100644 --- a/service/workmail/api_op_GetMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_GetMobileDeviceAccessOverride.go @@ -43,14 +43,10 @@ type GetMobileDeviceAccessOverrideInput struct { // Identifies the WorkMail user for the override. Accepts the following types of // user identities: - // - // * User ID: 12345678-1234-1234-1234-123456789012 or - // S-1-1-12-1234567890-123456789-123456789-1234 - // - // * Email address: - // user@domain.tld - // - // * User name: user + // - User ID: 12345678-1234-1234-1234-123456789012 or + // S-1-1-12-1234567890-123456789-123456789-1234 + // - Email address: user@domain.tld + // - User name: user // // This member is required. UserId *string @@ -72,7 +68,7 @@ type GetMobileDeviceAccessOverrideOutput struct { // The device to which the access override applies. DeviceId *string - // The effect of the override, ALLOW or DENY. + // The effect of the override, ALLOW or DENY . Effect types.MobileDeviceAccessRuleEffect // The WorkMail user to which the access override applies. diff --git a/service/workmail/api_op_ListAvailabilityConfigurations.go b/service/workmail/api_op_ListAvailabilityConfigurations.go index 8e98b44e134..357c97c2158 100644 --- a/service/workmail/api_op_ListAvailabilityConfigurations.go +++ b/service/workmail/api_op_ListAvailabilityConfigurations.go @@ -12,7 +12,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all the AvailabilityConfiguration's for the given WorkMail organization. +// List all the AvailabilityConfiguration 's for the given WorkMail organization. func (c *Client) ListAvailabilityConfigurations(ctx context.Context, params *ListAvailabilityConfigurationsInput, optFns ...func(*Options)) (*ListAvailabilityConfigurationsOutput, error) { if params == nil { params = &ListAvailabilityConfigurationsInput{} @@ -30,7 +30,7 @@ func (c *Client) ListAvailabilityConfigurations(ctx context.Context, params *Lis type ListAvailabilityConfigurationsInput struct { - // The WorkMail organization for which the AvailabilityConfiguration's will be + // The WorkMail organization for which the AvailabilityConfiguration 's will be // listed. // // This member is required. @@ -48,7 +48,7 @@ type ListAvailabilityConfigurationsInput struct { type ListAvailabilityConfigurationsOutput struct { - // The list of AvailabilityConfiguration's that exist for the specified WorkMail + // The list of AvailabilityConfiguration 's that exist for the specified WorkMail // organization. AvailabilityConfigurations []types.AvailabilityConfiguration diff --git a/service/workmail/api_op_ListImpersonationRoles.go b/service/workmail/api_op_ListImpersonationRoles.go index b6f73634f37..57caccc5e49 100644 --- a/service/workmail/api_op_ListImpersonationRoles.go +++ b/service/workmail/api_op_ListImpersonationRoles.go @@ -47,8 +47,8 @@ type ListImpersonationRolesInput struct { type ListImpersonationRolesOutput struct { - // The token to retrieve the next page of results. The value is null when there are - // no results to return. + // The token to retrieve the next page of results. The value is null when there + // are no results to return. NextToken *string // The list of impersonation roles under the given WorkMail organization. diff --git a/service/workmail/api_op_ListMobileDeviceAccessOverrides.go b/service/workmail/api_op_ListMobileDeviceAccessOverrides.go index 14c23258d41..652173fc4c6 100644 --- a/service/workmail/api_op_ListMobileDeviceAccessOverrides.go +++ b/service/workmail/api_op_ListMobileDeviceAccessOverrides.go @@ -48,15 +48,10 @@ type ListMobileDeviceAccessOverridesInput struct { // The WorkMail user under which you list the mobile device access overrides. // Accepts the following types of user identities: - // - // * User ID: - // 12345678-1234-1234-1234-123456789012 or - // S-1-1-12-1234567890-123456789-123456789-1234 - // - // * Email address: - // user@domain.tld - // - // * User name: user + // - User ID: 12345678-1234-1234-1234-123456789012 or + // S-1-1-12-1234567890-123456789-123456789-1234 + // - Email address: user@domain.tld + // - User name: user UserId *string noSmithyDocumentSerde @@ -68,8 +63,8 @@ type ListMobileDeviceAccessOverridesOutput struct { // there are no more results to return. NextToken *string - // The list of mobile device access overrides that exist for the specified WorkMail - // organization and user. + // The list of mobile device access overrides that exist for the specified + // WorkMail organization and user. Overrides []types.MobileDeviceAccessOverride // Metadata pertaining to the operation's result. diff --git a/service/workmail/api_op_ListResourceDelegates.go b/service/workmail/api_op_ListResourceDelegates.go index ae51165d845..06b68dd62f7 100644 --- a/service/workmail/api_op_ListResourceDelegates.go +++ b/service/workmail/api_op_ListResourceDelegates.go @@ -12,8 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the delegates associated with a resource. Users and groups can be resource -// delegates and answer requests on behalf of the resource. +// Lists the delegates associated with a resource. Users and groups can be +// resource delegates and answer requests on behalf of the resource. func (c *Client) ListResourceDelegates(ctx context.Context, params *ListResourceDelegatesInput, optFns ...func(*Options)) (*ListResourceDelegatesOutput, error) { if params == nil { params = &ListResourceDelegatesInput{} diff --git a/service/workmail/api_op_ListUsers.go b/service/workmail/api_op_ListUsers.go index fd0a9049d94..2eeda1496e8 100644 --- a/service/workmail/api_op_ListUsers.go +++ b/service/workmail/api_op_ListUsers.go @@ -47,8 +47,8 @@ type ListUsersInput struct { type ListUsersOutput struct { - // The token to use to retrieve the next page of results. This value is `null` when - // there are no more results to return. + // 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 // The overview of users for an organization. diff --git a/service/workmail/api_op_PutAccessControlRule.go b/service/workmail/api_op_PutAccessControlRule.go index 8f73e9970bc..243cf197bb9 100644 --- a/service/workmail/api_op_PutAccessControlRule.go +++ b/service/workmail/api_op_PutAccessControlRule.go @@ -52,8 +52,8 @@ type PutAccessControlRuleInput struct { // This member is required. OrganizationId *string - // Access protocol actions to include in the rule. Valid values include ActiveSync, - // AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. + // Access protocol actions to include in the rule. Valid values include ActiveSync + // , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail . Actions []string // Impersonation role IDs to include in the rule. @@ -63,7 +63,7 @@ type PutAccessControlRuleInput struct { IpRanges []string // Access protocol actions to exclude from the rule. Valid values include - // ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. + // ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail . NotActions []string // Impersonation role IDs to exclude from the rule. diff --git a/service/workmail/api_op_PutMailboxPermissions.go b/service/workmail/api_op_PutMailboxPermissions.go index 32248314b81..4e88d9551f1 100644 --- a/service/workmail/api_op_PutMailboxPermissions.go +++ b/service/workmail/api_op_PutMailboxPermissions.go @@ -48,12 +48,12 @@ type PutMailboxPermissionsInput struct { // This member is required. OrganizationId *string - // The permissions granted to the grantee. SEND_AS allows the grantee to send email - // as the owner of the mailbox (the grantee is not mentioned on these emails). - // SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the - // mailbox (the grantee is not mentioned as the physical sender of these emails). - // FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other - // folder-level permissions set on the mailbox. + // The permissions granted to the grantee. SEND_AS allows the grantee to send + // email as the owner of the mailbox (the grantee is not mentioned on these + // emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner + // of the mailbox (the grantee is not mentioned as the physical sender of these + // emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective + // of other folder-level permissions set on the mailbox. // // This member is required. PermissionValues []types.PermissionType diff --git a/service/workmail/api_op_PutMobileDeviceAccessOverride.go b/service/workmail/api_op_PutMobileDeviceAccessOverride.go index 562b0eb82c9..023659f96e1 100644 --- a/service/workmail/api_op_PutMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_PutMobileDeviceAccessOverride.go @@ -36,7 +36,7 @@ type PutMobileDeviceAccessOverrideInput struct { // This member is required. DeviceId *string - // The effect of the override, ALLOW or DENY. + // The effect of the override, ALLOW or DENY . // // This member is required. Effect types.MobileDeviceAccessRuleEffect @@ -46,16 +46,12 @@ type PutMobileDeviceAccessOverrideInput struct { // This member is required. OrganizationId *string - // The WorkMail user for which you create the override. Accepts the following types - // of user identities: - // - // * User ID: 12345678-1234-1234-1234-123456789012 or - // S-1-1-12-1234567890-123456789-123456789-1234 - // - // * Email address: - // user@domain.tld - // - // * User name: user + // The WorkMail user for which you create the override. Accepts the following + // types of user identities: + // - User ID: 12345678-1234-1234-1234-123456789012 or + // S-1-1-12-1234567890-123456789-123456789-1234 + // - Email address: user@domain.tld + // - User name: user // // This member is required. UserId *string diff --git a/service/workmail/api_op_RegisterToWorkMail.go b/service/workmail/api_op_RegisterToWorkMail.go index 25bde2cb4ed..d020521d21a 100644 --- a/service/workmail/api_op_RegisterToWorkMail.go +++ b/service/workmail/api_op_RegisterToWorkMail.go @@ -14,10 +14,10 @@ import ( // associating a mailbox and calendaring capabilities. It performs no change if the // user, group, or resource is enabled and fails if the user, group, or resource is // deleted. This operation results in the accumulation of costs. For more -// information, see Pricing (https://aws.amazon.com/workmail/pricing). The +// information, see Pricing (https://aws.amazon.com/workmail/pricing) . The // equivalent console functionality for this operation is Enable. Users can either // be created by calling the CreateUser API operation or they can be synchronized -// from your directory. For more information, see DeregisterFromWorkMail. +// from your directory. For more information, see DeregisterFromWorkMail . func (c *Client) RegisterToWorkMail(ctx context.Context, params *RegisterToWorkMailInput, optFns ...func(*Options)) (*RegisterToWorkMailOutput, error) { if params == nil { params = &RegisterToWorkMailInput{} diff --git a/service/workmail/api_op_ResetPassword.go b/service/workmail/api_op_ResetPassword.go index 9e0b44a779f..b20aa5fca4b 100644 --- a/service/workmail/api_op_ResetPassword.go +++ b/service/workmail/api_op_ResetPassword.go @@ -28,8 +28,8 @@ func (c *Client) ResetPassword(ctx context.Context, params *ResetPasswordInput, type ResetPasswordInput struct { - // The identifier of the organization that contains the user for which the password - // is reset. + // The identifier of the organization that contains the user for which the + // password is reset. // // This member is required. OrganizationId *string diff --git a/service/workmail/api_op_StartMailboxExportJob.go b/service/workmail/api_op_StartMailboxExportJob.go index f13c5a3b43a..4af2cea4c83 100644 --- a/service/workmail/api_op_StartMailboxExportJob.go +++ b/service/workmail/api_op_StartMailboxExportJob.go @@ -13,9 +13,8 @@ import ( // Starts a mailbox export job to export MIME-format email messages and calendar // items from the specified mailbox to the specified Amazon Simple Storage Service -// (Amazon S3) bucket. For more information, see Exporting mailbox content -// (https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html) in the -// WorkMail Administrator Guide. +// (Amazon S3) bucket. For more information, see Exporting mailbox content (https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html) +// in the WorkMail Administrator Guide. func (c *Client) StartMailboxExportJob(ctx context.Context, params *StartMailboxExportJobInput, optFns ...func(*Options)) (*StartMailboxExportJobOutput, error) { if params == nil { params = &StartMailboxExportJobInput{} diff --git a/service/workmail/api_op_TestAvailabilityConfiguration.go b/service/workmail/api_op_TestAvailabilityConfiguration.go index 2c21a7d74da..a782453ee3d 100644 --- a/service/workmail/api_op_TestAvailabilityConfiguration.go +++ b/service/workmail/api_op_TestAvailabilityConfiguration.go @@ -16,8 +16,8 @@ import ( // in. For Lambda, it verifies that the Lambda function can be invoked and that the // resource access policy was configured to deny anonymous access. An anonymous // invocation is one done without providing either a SourceArn or SourceAccount -// header. The request must contain either one provider definition (EwsProvider or -// LambdaProvider) or the DomainName parameter. If the DomainName parameter is +// header. The request must contain either one provider definition ( EwsProvider +// or LambdaProvider ) or the DomainName parameter. If the DomainName parameter is // provided, the configuration stored under the DomainName will be tested. func (c *Client) TestAvailabilityConfiguration(ctx context.Context, params *TestAvailabilityConfigurationInput, optFns ...func(*Options)) (*TestAvailabilityConfigurationOutput, error) { if params == nil { diff --git a/service/workmail/api_op_UpdateAvailabilityConfiguration.go b/service/workmail/api_op_UpdateAvailabilityConfiguration.go index cef923acbdf..a2e7a06d8e0 100644 --- a/service/workmail/api_op_UpdateAvailabilityConfiguration.go +++ b/service/workmail/api_op_UpdateAvailabilityConfiguration.go @@ -42,12 +42,12 @@ type UpdateAvailabilityConfigurationInput struct { OrganizationId *string // The EWS availability provider definition. The request must contain exactly one - // provider definition, either EwsProvider or LambdaProvider. The previously stored - // provider will be overridden by the one provided. + // provider definition, either EwsProvider or LambdaProvider . The previously + // stored provider will be overridden by the one provided. EwsProvider *types.EwsAvailabilityProvider // The Lambda availability provider definition. The request must contain exactly - // one provider definition, either EwsProvider or LambdaProvider. The previously + // one provider definition, either EwsProvider or LambdaProvider . The previously // stored provider will be overridden by the one provided. LambdaProvider *types.LambdaAvailabilityProvider diff --git a/service/workmail/api_op_UpdateMobileDeviceAccessRule.go b/service/workmail/api_op_UpdateMobileDeviceAccessRule.go index 87b863b8264..52b343bc467 100644 --- a/service/workmail/api_op_UpdateMobileDeviceAccessRule.go +++ b/service/workmail/api_op_UpdateMobileDeviceAccessRule.go @@ -29,7 +29,7 @@ func (c *Client) UpdateMobileDeviceAccessRule(ctx context.Context, params *Updat type UpdateMobileDeviceAccessRuleInput struct { - // The effect of the rule when it matches. Allowed values are ALLOW or DENY. + // The effect of the rule when it matches. Allowed values are ALLOW or DENY . // // This member is required. Effect types.MobileDeviceAccessRuleEffect @@ -64,8 +64,8 @@ type UpdateMobileDeviceAccessRuleInput struct { // User agents that the updated rule will match. DeviceUserAgents []string - // Device models that the updated rule will not match. All other device models will - // match. + // Device models that the updated rule will not match. All other device models + // will match. NotDeviceModels []string // Device operating systems that the updated rule will not match. All other device diff --git a/service/workmail/doc.go b/service/workmail/doc.go index 423ff08bd14..c30998986d9 100644 --- a/service/workmail/doc.go +++ b/service/workmail/doc.go @@ -11,23 +11,22 @@ // and the location in which your data is stored. The WorkMail API is designed for // the following scenarios: // -// * Listing and describing organizations +// - Listing and describing organizations // -// * Managing -// users +// - Managing users // -// * Managing groups +// - Managing groups // -// * Managing resources +// - Managing resources // -// All WorkMail API operations are -// Amazon-authenticated and certificate-signed. They not only require the use of -// the AWS SDK, but also allow for the exclusive use of AWS Identity and Access -// Management users and roles to help facilitate access, trust, and permission -// policies. By creating a role and allowing an IAM user to access the WorkMail -// site, the IAM user gains full administrative visibility into the entire WorkMail -// organization (or as set in the IAM policy). This includes, but is not limited -// to, the ability to create, update, and delete users, groups, and resources. This -// allows developers to perform the scenarios listed above, as well as give users -// the ability to grant access on a selective basis using the IAM model. +// All WorkMail API operations are Amazon-authenticated and certificate-signed. +// They not only require the use of the AWS SDK, but also allow for the exclusive +// use of AWS Identity and Access Management users and roles to help facilitate +// access, trust, and permission policies. By creating a role and allowing an IAM +// user to access the WorkMail site, the IAM user gains full administrative +// visibility into the entire WorkMail organization (or as set in the IAM policy). +// This includes, but is not limited to, the ability to create, update, and delete +// users, groups, and resources. This allows developers to perform the scenarios +// listed above, as well as give users the ability to grant access on a selective +// basis using the IAM model. package workmail diff --git a/service/workmail/types/enums.go b/service/workmail/types/enums.go index 2924256d1bc..17d1d94b79b 100644 --- a/service/workmail/types/enums.go +++ b/service/workmail/types/enums.go @@ -28,9 +28,9 @@ const ( AccessEffectDeny AccessEffect = "DENY" ) -// Values returns all known values for AccessEffect. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for AccessEffect. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (AccessEffect) Values() []AccessEffect { return []AccessEffect{ "ALLOW", @@ -46,9 +46,9 @@ const ( AvailabilityProviderTypeLambda AvailabilityProviderType = "LAMBDA" ) -// Values returns all known values for AvailabilityProviderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for AvailabilityProviderType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (AvailabilityProviderType) Values() []AvailabilityProviderType { return []AvailabilityProviderType{ "EWS", @@ -128,8 +128,8 @@ const ( ImpersonationRoleTypeReadOnly ImpersonationRoleType = "READ_ONLY" ) -// Values returns all known values for ImpersonationRoleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ImpersonationRoleType. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ImpersonationRoleType) Values() []ImpersonationRoleType { return []ImpersonationRoleType{ @@ -148,8 +148,8 @@ const ( MailboxExportJobStateCancelled MailboxExportJobState = "CANCELLED" ) -// Values returns all known values for MailboxExportJobState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for MailboxExportJobState. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (MailboxExportJobState) Values() []MailboxExportJobState { return []MailboxExportJobState{ @@ -186,9 +186,10 @@ const ( MobileDeviceAccessRuleEffectDeny MobileDeviceAccessRuleEffect = "DENY" ) -// Values returns all known values for MobileDeviceAccessRuleEffect. Note that this -// can be expanded in the future, and so it is only as up to date as the client. -// The ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for MobileDeviceAccessRuleEffect. Note that +// this can be expanded in the future, and so it is only as up to date as the +// client. The ordering of this slice is not guaranteed to be stable across +// updates. func (MobileDeviceAccessRuleEffect) Values() []MobileDeviceAccessRuleEffect { return []MobileDeviceAccessRuleEffect{ "ALLOW", @@ -224,9 +225,9 @@ const ( ResourceTypeEquipment ResourceType = "EQUIPMENT" ) -// Values returns all known values for ResourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for ResourceType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (ResourceType) Values() []ResourceType { return []ResourceType{ "ROOM", diff --git a/service/workmail/types/errors.go b/service/workmail/types/errors.go index d2e79628244..1595393ab78 100644 --- a/service/workmail/types/errors.go +++ b/service/workmail/types/errors.go @@ -226,8 +226,8 @@ func (e *InvalidConfigurationException) ErrorFault() smithy.ErrorFault { return // You SES configuration has customizations that WorkMail cannot save. The error // message lists the invalid setting. For examples of invalid settings, refer to -// CreateReceiptRule -// (https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html). +// CreateReceiptRule (https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html) +// . type InvalidCustomSesConfigurationException struct { Message *string @@ -440,8 +440,8 @@ func (e *NameAvailabilityException) ErrorCode() string { } func (e *NameAvailabilityException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An operation received a valid organization identifier that either doesn't belong -// or exist in the system. +// An operation received a valid organization identifier that either doesn't +// belong or exist in the system. type OrganizationNotFoundException struct { Message *string diff --git a/service/workmail/types/types.go b/service/workmail/types/types.go index 61254d04aad..1b28af2b55c 100644 --- a/service/workmail/types/types.go +++ b/service/workmail/types/types.go @@ -10,8 +10,8 @@ import ( // A rule that controls access to an WorkMail organization. type AccessControlRule struct { - // Access protocol actions to include in the rule. Valid values include ActiveSync, - // AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. + // Access protocol actions to include in the rule. Valid values include ActiveSync + // , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail . Actions []string // The date that the rule was created. @@ -36,7 +36,7 @@ type AccessControlRule struct { Name *string // Access protocol actions to exclude from the rule. Valid values include - // ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail. + // ActiveSync , AutoDiscover , EWS , IMAP , SMTP , WindowsOutlook , and WebMail . NotActions []string // Impersonation role IDs to exclude from the rule. @@ -54,7 +54,7 @@ type AccessControlRule struct { noSmithyDocumentSerde } -// List all the AvailabilityConfiguration's for the given WorkMail organization. +// List all the AvailabilityConfiguration 's for the given WorkMail organization. type AvailabilityConfiguration struct { // The date and time at which the availability configuration was created. @@ -66,11 +66,11 @@ type AvailabilityConfiguration struct { // Displays the domain to which the provider applies. DomainName *string - // If ProviderType is EWS, then this field contains - // RedactedEwsAvailabilityProvider. Otherwise, it is not required. + // If ProviderType is EWS , then this field contains + // RedactedEwsAvailabilityProvider . Otherwise, it is not required. EwsProvider *RedactedEwsAvailabilityProvider - // If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider. + // If ProviderType is LAMBDA then this field contains LambdaAvailabilityProvider . // Otherwise, it is not required. LambdaProvider *LambdaAvailabilityProvider @@ -117,10 +117,10 @@ type Delegate struct { // A DNS record uploaded to your DNS provider. type DnsRecord struct { - // The DNS hostname.- For example, domain.example.com. + // The DNS hostname.- For example, domain.example.com . Hostname *string - // The RFC 1035 record type. Possible values: CNAME, A, MX. + // The RFC 1035 record type. Possible values: CNAME , A , MX . Type *string // The value returned by the DNS for a query to that hostname and record type. @@ -131,8 +131,8 @@ type DnsRecord struct { // The domain to associate with an WorkMail organization. When you configure a // domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are -// added to the organization when you create it. For more information, see Adding a -// domain (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) +// added to the organization when you create it. For more information, see Adding +// a domain (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html) // in the WorkMail Administrator Guide. type Domain struct { @@ -171,8 +171,8 @@ type EwsAvailabilityProvider struct { // The configuration applied to an organization's folders by its retention policy. type FolderConfiguration struct { - // The action to take on the folder contents at the end of the folder configuration - // period. + // The action to take on the folder contents at the end of the folder + // configuration period. // // This member is required. Action RetentionAction @@ -249,7 +249,7 @@ type ImpersonationRole struct { type ImpersonationRule struct { // The effect of the rule when it matches the input. Allowed effect values are - // ALLOW or DENY. + // ALLOW or DENY . // // This member is required. Effect AccessEffect @@ -384,7 +384,7 @@ type MobileDeviceAccessOverride struct { // The device to which the override applies. DeviceId *string - // The effect of the override, ALLOW or DENY. + // The effect of the override, ALLOW or DENY . Effect MobileDeviceAccessRuleEffect // The WorkMail user to which the access override applies. @@ -417,7 +417,7 @@ type MobileDeviceAccessRule struct { // Device user agents that a rule will match. DeviceUserAgents []string - // The effect of the rule when it matches. Allowed values are ALLOW or DENY. + // The effect of the rule when it matches. Allowed values are ALLOW or DENY . Effect MobileDeviceAccessRuleEffect // The ID assigned to a mobile access rule. @@ -429,15 +429,15 @@ type MobileDeviceAccessRule struct { // Device models that a rule will not match. All other device models will match. NotDeviceModels []string - // Device operating systems that a rule will not match. All other device types will - // match. + // Device operating systems that a rule will not match. All other device types + // will match. NotDeviceOperatingSystems []string // Device types that a rule will not match. All other device types will match. NotDeviceTypes []string - // Device user agents that a rule will not match. All other device user agents will - // match. + // Device user agents that a rule will not match. All other device user agents + // will match. NotDeviceUserAgents []string noSmithyDocumentSerde @@ -481,12 +481,12 @@ type Permission struct { // This member is required. GranteeType MemberType - // The permissions granted to the grantee. SEND_AS allows the grantee to send email - // as the owner of the mailbox (the grantee is not mentioned on these emails). - // SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the - // mailbox (the grantee is not mentioned as the physical sender of these emails). - // FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other - // folder-level permissions set on the mailbox. + // The permissions granted to the grantee. SEND_AS allows the grantee to send + // email as the owner of the mailbox (the grantee is not mentioned on these + // emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner + // of the mailbox (the grantee is not mentioned as the physical sender of these + // emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective + // of other folder-level permissions set on the mailbox. // // This member is required. PermissionValues []PermissionType diff --git a/service/workmailmessageflow/api_client.go b/service/workmailmessageflow/api_client.go index 3ca133f14fc..38a48414e46 100644 --- a/service/workmailmessageflow/api_client.go +++ b/service/workmailmessageflow/api_client.go @@ -115,7 +115,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/workmailmessageflow/api_op_PutRawMessageContent.go b/service/workmailmessageflow/api_op_PutRawMessageContent.go index 945841e6729..fbb14bc6b1f 100644 --- a/service/workmailmessageflow/api_op_PutRawMessageContent.go +++ b/service/workmailmessageflow/api_op_PutRawMessageContent.go @@ -13,14 +13,12 @@ import ( // Updates the raw content of an in-transit email message, in MIME format. This // example describes how to update in-transit email message. For more information -// and examples for using this API, see Updating message content with AWS Lambda -// (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html). -// Updates to an in-transit message only appear when you call PutRawMessageContent -// from an AWS Lambda function configured with a synchronous Run Lambda -// (https://docs.aws.amazon.com/workmail/latest/adminguide/lambda.html#synchronous-rules) +// and examples for using this API, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html) +// . Updates to an in-transit message only appear when you call +// PutRawMessageContent from an AWS Lambda function configured with a synchronous +// Run Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/lambda.html#synchronous-rules) // rule. If you call PutRawMessageContent on a delivered or sent message, the -// message remains unchanged, even though GetRawMessageContent -// (https://docs.aws.amazon.com/workmail/latest/APIReference/API_messageflow_GetRawMessageContent.html) +// message remains unchanged, even though GetRawMessageContent (https://docs.aws.amazon.com/workmail/latest/APIReference/API_messageflow_GetRawMessageContent.html) // returns an updated message. func (c *Client) PutRawMessageContent(ctx context.Context, params *PutRawMessageContentInput, optFns ...func(*Options)) (*PutRawMessageContentOutput, error) { if params == nil { diff --git a/service/workmailmessageflow/types/errors.go b/service/workmailmessageflow/types/errors.go index 2a2eb377d59..50dd816f7db 100644 --- a/service/workmailmessageflow/types/errors.go +++ b/service/workmailmessageflow/types/errors.go @@ -8,20 +8,12 @@ import ( ) // WorkMail could not access the updated email content. Possible reasons: -// -// * You -// made the request in a region other than your S3 bucket region. -// -// * The S3 bucket -// owner -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-owner-condition.html) is -// not the same as the calling AWS account. -// -// * You have an incomplete or missing S3 -// bucket policy. For more information about policies, see Updating message -// content with AWS Lambda -// (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html) -// in the WorkMail Administrator Guide. +// - You made the request in a region other than your S3 bucket region. +// - The S3 bucket owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-owner-condition.html) +// is not the same as the calling AWS account. +// - You have an incomplete or missing S3 bucket policy. For more information +// about policies, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html) +// in the WorkMail Administrator Guide. type InvalidContentLocation struct { Message *string diff --git a/service/workmailmessageflow/types/types.go b/service/workmailmessageflow/types/types.go index 08d70bbfd30..9472852e718 100644 --- a/service/workmailmessageflow/types/types.go +++ b/service/workmailmessageflow/types/types.go @@ -6,34 +6,23 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// Provides the MIME content of the updated email message as an S3 object. All MIME -// content must meet the following criteria: -// -// * Each part of a multipart MIME -// message must be formatted properly. -// -// * Attachments must be of a content type -// that Amazon SES supports. For more information, see Unsupported Attachment Types -// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types-appendix.html). -// -// * -// If any of the MIME parts in a message contain content that is outside of the -// 7-bit ASCII character range, we recommend encoding that content. -// -// * Per RFC 5321 -// (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6), the maximum length of -// each line of text, including the , must not exceed 1,000 characters. -// -// * The -// message must contain all the required header fields. Check the returned error -// message for more information. -// -// * The value of immutable headers must remain -// unchanged. Check the returned error message for more information. -// -// * Certain -// unique headers can only appear once. Check the returned error message for more -// information. +// Provides the MIME content of the updated email message as an S3 object. All +// MIME content must meet the following criteria: +// - Each part of a multipart MIME message must be formatted properly. +// - Attachments must be of a content type that Amazon SES supports. For more +// information, see Unsupported Attachment Types (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types-appendix.html) +// . +// - If any of the MIME parts in a message contain content that is outside of +// the 7-bit ASCII character range, we recommend encoding that content. +// - Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6) , the +// maximum length of each line of text, including the , must not exceed 1,000 +// characters. +// - The message must contain all the required header fields. Check the returned +// error message for more information. +// - The value of immutable headers must remain unchanged. Check the returned +// error message for more information. +// - Certain unique headers can only appear once. Check the returned error +// message for more information. type RawMessageContent struct { // The S3 reference of an email message. @@ -47,9 +36,9 @@ type RawMessageContent struct { // Amazon S3 object representing the updated message content, in MIME format. The // region for the S3 bucket containing the S3 object must match the region used for // WorkMail operations. Also, for WorkMail to process an S3 object, it must have -// permission to access that object. For more information, see Updating message -// content with AWS Lambda -// (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html). +// permission to access that object. For more information, see Updating message +// content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html) +// . type S3Reference struct { // The S3 bucket name. diff --git a/service/workspaces/api_client.go b/service/workspaces/api_client.go index ce3466c6927..bfaeb3a816a 100644 --- a/service/workspaces/api_client.go +++ b/service/workspaces/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/workspaces/api_op_AssociateConnectionAlias.go b/service/workspaces/api_op_AssociateConnectionAlias.go index 9ae1a5491d6..598c3111b05 100644 --- a/service/workspaces/api_op_AssociateConnectionAlias.go +++ b/service/workspaces/api_op_AssociateConnectionAlias.go @@ -10,13 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified connection alias with the specified directory to enable -// cross-Region redirection. For more information, see Cross-Region Redirection -// for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -// Before performing this operation, call DescribeConnectionAliases -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) -// to make sure that the current state of the connection alias is CREATED. +// Associates the specified connection alias with the specified directory to +// enable cross-Region redirection. For more information, see Cross-Region +// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) +// to make sure that the current state of the connection alias is CREATED . func (c *Client) AssociateConnectionAlias(ctx context.Context, params *AssociateConnectionAliasInput, optFns ...func(*Options)) (*AssociateConnectionAliasOutput, error) { if params == nil { params = &AssociateConnectionAliasInput{} diff --git a/service/workspaces/api_op_CopyWorkspaceImage.go b/service/workspaces/api_op_CopyWorkspaceImage.go index 3e895747018..12a32e17b9c 100644 --- a/service/workspaces/api_op_CopyWorkspaceImage.go +++ b/service/workspaces/api_op_CopyWorkspaceImage.go @@ -12,17 +12,14 @@ import ( ) // Copies the specified image from the specified Region to the current Region. For -// more information about copying images, see Copy a Custom WorkSpaces Image -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html). -// In the China (Ningxia) Region, you can copy images only within the same Region. -// In Amazon Web Services GovCloud (US), to copy images to and from other Regions, -// contact Amazon Web Services Support. Before copying a shared image, be sure to -// verify that it has been shared from the correct Amazon Web Services account. To -// determine if an image has been shared and to see the ID of the Amazon Web -// Services account that owns an image, use the DescribeWorkSpaceImages -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) -// and DescribeWorkspaceImagePermissions -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) +// more information about copying images, see Copy a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html) +// . In the China (Ningxia) Region, you can copy images only within the same +// Region. In Amazon Web Services GovCloud (US), to copy images to and from other +// Regions, contact Amazon Web Services Support. Before copying a shared image, be +// sure to verify that it has been shared from the correct Amazon Web Services +// account. To determine if an image has been shared and to see the ID of the +// Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) +// and DescribeWorkspaceImagePermissions (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) // API operations. func (c *Client) CopyWorkspaceImage(ctx context.Context, params *CopyWorkspaceImageInput, optFns ...func(*Options)) (*CopyWorkspaceImageOutput, error) { if params == nil { diff --git a/service/workspaces/api_op_CreateConnectionAlias.go b/service/workspaces/api_op_CreateConnectionAlias.go index 46e753b5cf3..4e8c06a71f1 100644 --- a/service/workspaces/api_op_CreateConnectionAlias.go +++ b/service/workspaces/api_op_CreateConnectionAlias.go @@ -12,8 +12,8 @@ import ( ) // Creates the specified connection alias for use with cross-Region redirection. -// For more information, see Cross-Region Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . func (c *Client) CreateConnectionAlias(ctx context.Context, params *CreateConnectionAliasInput, optFns ...func(*Options)) (*CreateConnectionAliasOutput, error) { if params == nil { params = &CreateConnectionAliasInput{} @@ -31,11 +31,12 @@ func (c *Client) CreateConnectionAlias(ctx context.Context, params *CreateConnec type CreateConnectionAliasInput struct { - // A connection string in the form of a fully qualified domain name (FQDN), such as - // www.example.com. After you create a connection string, it is always associated - // to your Amazon Web Services account. You cannot recreate the same connection - // string with a different account, even if you delete all instances of it from the - // original account. The connection string is globally reserved for your account. + // A connection string in the form of a fully qualified domain name (FQDN), such + // as www.example.com . After you create a connection string, it is always + // associated to your Amazon Web Services account. You cannot recreate the same + // connection string with a different account, even if you delete all instances of + // it from the original account. The connection string is globally reserved for + // your account. // // This member is required. ConnectionString *string diff --git a/service/workspaces/api_op_CreateIpGroup.go b/service/workspaces/api_op_CreateIpGroup.go index ca63fd62373..76a5d7ecb71 100644 --- a/service/workspaces/api_op_CreateIpGroup.go +++ b/service/workspaces/api_op_CreateIpGroup.go @@ -11,13 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an IP access control group. An IP access control group provides you with -// the ability to control the IP addresses from which users are allowed to access -// their WorkSpaces. To specify the CIDR address ranges, add rules to your IP -// access control group and then associate the group with your directory. You can -// add rules when you create the group or at any time using AuthorizeIpRules. There -// is a default IP access control group associated with your directory. If you -// don't associate an IP access control group with your directory, the default +// Creates an IP access control group. An IP access control group provides you +// with the ability to control the IP addresses from which users are allowed to +// access their WorkSpaces. To specify the CIDR address ranges, add rules to your +// IP access control group and then associate the group with your directory. You +// can add rules when you create the group or at any time using AuthorizeIpRules . +// There is a default IP access control group associated with your directory. If +// you don't associate an IP access control group with your directory, the default // group is used. The default group includes a default rule that allows users to // access their WorkSpaces from anywhere. You cannot modify the default IP access // control group for your directory. diff --git a/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go b/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go index 53a7d798a2e..da1d30c713b 100644 --- a/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go +++ b/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go @@ -15,19 +15,14 @@ import ( // new updated WorkSpace image has the latest drivers and other updates required by // the Amazon WorkSpaces components. To determine which WorkSpace images need to be // updated with the latest Amazon WorkSpaces requirements, use -// DescribeWorkspaceImages -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html). -// -// * -// Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images -// can be programmatically updated at this time. -// -// * Microsoft Windows updates and -// other application updates are not included in the update process. -// -// * The source -// WorkSpace image is not deleted. You can delete the source image after you've -// verified your new updated image and created a new bundle. +// DescribeWorkspaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) +// . +// - Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace +// images can be programmatically updated at this time. +// - Microsoft Windows updates and other application updates are not included in +// the update process. +// - The source WorkSpace image is not deleted. You can delete the source image +// after you've verified your new updated image and created a new bundle. func (c *Client) CreateUpdatedWorkspaceImage(ctx context.Context, params *CreateUpdatedWorkspaceImageInput, optFns ...func(*Options)) (*CreateUpdatedWorkspaceImageOutput, error) { if params == nil { params = &CreateUpdatedWorkspaceImageInput{} @@ -60,9 +55,9 @@ type CreateUpdatedWorkspaceImageInput struct { // This member is required. SourceImageId *string - // The tags that you want to add to the new updated WorkSpace image. To add tags at - // the same time when you're creating the updated image, you must create an IAM - // policy that grants your IAM user permissions to use workspaces:CreateTags. + // The tags that you want to add to the new updated WorkSpace image. To add tags + // at the same time when you're creating the updated image, you must create an IAM + // policy that grants your IAM user permissions to use workspaces:CreateTags . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/workspaces/api_op_CreateWorkspaceBundle.go b/service/workspaces/api_op_CreateWorkspaceBundle.go index 7c4954e5b61..103691da8fc 100644 --- a/service/workspaces/api_op_CreateWorkspaceBundle.go +++ b/service/workspaces/api_op_CreateWorkspaceBundle.go @@ -12,8 +12,8 @@ import ( ) // Creates the specified WorkSpace bundle. For more information about creating -// WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html). +// WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html) +// . func (c *Client) CreateWorkspaceBundle(ctx context.Context, params *CreateWorkspaceBundleInput, optFns ...func(*Options)) (*CreateWorkspaceBundleOutput, error) { if params == nil { params = &CreateWorkspaceBundleInput{} @@ -61,7 +61,7 @@ type CreateWorkspaceBundleInput struct { // The tags associated with the bundle. To add tags at the same time when you're // creating the bundle, you must create an IAM policy that grants your IAM user - // permissions to use workspaces:CreateTags. + // permissions to use workspaces:CreateTags . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/workspaces/api_op_CreateWorkspaceImage.go b/service/workspaces/api_op_CreateWorkspaceImage.go index 419cb0159fc..2885505beea 100644 --- a/service/workspaces/api_op_CreateWorkspaceImage.go +++ b/service/workspaces/api_op_CreateWorkspaceImage.go @@ -47,7 +47,7 @@ type CreateWorkspaceImageInput struct { // The tags that you want to add to the new WorkSpace image. To add tags when // you're creating the image, you must create an IAM policy that grants your IAM - // user permission to use workspaces:CreateTags. + // user permission to use workspaces:CreateTags . Tags []types.Tag noSmithyDocumentSerde @@ -75,8 +75,8 @@ type CreateWorkspaceImageOutput struct { // Specifies whether the image is running on dedicated hardware. When Bring Your // Own License (BYOL) is enabled, this value is set to DEDICATED. For more - // information, see Bring Your Own Windows Desktop Images. - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm). + // information, see Bring Your Own Windows Desktop Images. (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm) + // . RequiredTenancy types.WorkspaceImageRequiredTenancy // The availability status of the image. diff --git a/service/workspaces/api_op_CreateWorkspaces.go b/service/workspaces/api_op_CreateWorkspaces.go index 40fd551fe04..4d3b4413dc3 100644 --- a/service/workspaces/api_op_CreateWorkspaces.go +++ b/service/workspaces/api_op_CreateWorkspaces.go @@ -14,8 +14,8 @@ import ( // Creates one or more WorkSpaces. This operation is asynchronous and returns // before the WorkSpaces are created. The MANUAL running mode value is only // supported by Amazon WorkSpaces Core. Contact your account team to be -// allow-listed to use this value. For more information, see Amazon WorkSpaces Core -// (http://aws.amazon.com/workspaces/core/). +// allow-listed to use this value. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) +// . func (c *Client) CreateWorkspaces(ctx context.Context, params *CreateWorkspacesInput, optFns ...func(*Options)) (*CreateWorkspacesOutput, error) { if params == nil { params = &CreateWorkspacesInput{} diff --git a/service/workspaces/api_op_DeleteClientBranding.go b/service/workspaces/api_op_DeleteClientBranding.go index d4e1ee532cc..ecf2c7afee9 100644 --- a/service/workspaces/api_op_DeleteClientBranding.go +++ b/service/workspaces/api_op_DeleteClientBranding.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes customized client branding. Client branding allows you to customize your -// WorkSpace's client login portal. You can tailor your login portal company logo, -// the support email address, support link, link to reset password, and a custom -// message for users trying to sign in. After you delete your customized client -// branding, your login portal reverts to the default client branding. +// Deletes customized client branding. Client branding allows you to customize +// your WorkSpace's client login portal. You can tailor your login portal company +// logo, the support email address, support link, link to reset password, and a +// custom message for users trying to sign in. After you delete your customized +// client branding, your login portal reverts to the default client branding. func (c *Client) DeleteClientBranding(ctx context.Context, params *DeleteClientBrandingInput, optFns ...func(*Options)) (*DeleteClientBrandingOutput, error) { if params == nil { params = &DeleteClientBrandingInput{} diff --git a/service/workspaces/api_op_DeleteConnectionAlias.go b/service/workspaces/api_op_DeleteConnectionAlias.go index 71ce6afb908..ddcfa953e9b 100644 --- a/service/workspaces/api_op_DeleteConnectionAlias.go +++ b/service/workspaces/api_op_DeleteConnectionAlias.go @@ -11,18 +11,16 @@ import ( ) // Deletes the specified connection alias. For more information, see Cross-Region -// Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -// If you will no longer be using a fully qualified domain name (FQDN) as the +// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . If you will no longer be using a fully qualified domain name (FQDN) as the // registration code for your WorkSpaces users, you must take certain precautions -// to prevent potential security issues. For more information, see Security -// Considerations if You Stop Using Cross-Region Redirection -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations). -// To delete a connection alias that has been shared, the shared account must first -// disassociate the connection alias from any directories it has been associated -// with. Then you must unshare the connection alias from the account it has been -// shared with. You can delete a connection alias only after it is no longer shared -// with any accounts or associated with any directories. +// to prevent potential security issues. For more information, see Security +// Considerations if You Stop Using Cross-Region Redirection (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations) +// . To delete a connection alias that has been shared, the shared account must +// first disassociate the connection alias from any directories it has been +// associated with. Then you must unshare the connection alias from the account it +// has been shared with. You can delete a connection alias only after it is no +// longer shared with any accounts or associated with any directories. func (c *Client) DeleteConnectionAlias(ctx context.Context, params *DeleteConnectionAliasInput, optFns ...func(*Options)) (*DeleteConnectionAliasOutput, error) { if params == nil { params = &DeleteConnectionAliasInput{} diff --git a/service/workspaces/api_op_DeleteWorkspaceBundle.go b/service/workspaces/api_op_DeleteWorkspaceBundle.go index e87e89e1ad6..7ec763ff315 100644 --- a/service/workspaces/api_op_DeleteWorkspaceBundle.go +++ b/service/workspaces/api_op_DeleteWorkspaceBundle.go @@ -11,8 +11,8 @@ import ( ) // Deletes the specified WorkSpace bundle. For more information about deleting -// WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html). +// WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html) +// . func (c *Client) DeleteWorkspaceBundle(ctx context.Context, params *DeleteWorkspaceBundleInput, optFns ...func(*Options)) (*DeleteWorkspaceBundleOutput, error) { if params == nil { params = &DeleteWorkspaceBundleInput{} diff --git a/service/workspaces/api_op_DeregisterWorkspaceDirectory.go b/service/workspaces/api_op_DeregisterWorkspaceDirectory.go index f43a291e161..418c569e5a2 100644 --- a/service/workspaces/api_op_DeregisterWorkspaceDirectory.go +++ b/service/workspaces/api_op_DeregisterWorkspaceDirectory.go @@ -17,12 +17,10 @@ import ( // WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD // Connector directory for 30 consecutive days, this directory will be // automatically deregistered for use with Amazon WorkSpaces, and you will be -// charged for this directory as per the Directory Service pricing terms -// (http://aws.amazon.com/directoryservice/pricing/). To delete empty directories, -// see Delete the Directory for Your WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). -// If you delete your Simple AD or AD Connector directory, you can always create a -// new one when you want to start using WorkSpaces again. +// charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/) +// . To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html) +// . If you delete your Simple AD or AD Connector directory, you can always create +// a new one when you want to start using WorkSpaces again. func (c *Client) DeregisterWorkspaceDirectory(ctx context.Context, params *DeregisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*DeregisterWorkspaceDirectoryOutput, error) { if params == nil { params = &DeregisterWorkspaceDirectoryInput{} diff --git a/service/workspaces/api_op_DescribeAccountModifications.go b/service/workspaces/api_op_DescribeAccountModifications.go index d7c6594c253..17f49659dd1 100644 --- a/service/workspaces/api_op_DescribeAccountModifications.go +++ b/service/workspaces/api_op_DescribeAccountModifications.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list that describes modifications to the configuration of Bring Your -// Own License (BYOL) for the specified account. +// Retrieves a list that describes modifications to the configuration of Bring +// Your Own License (BYOL) for the specified account. func (c *Client) DescribeAccountModifications(ctx context.Context, params *DescribeAccountModificationsInput, optFns ...func(*Options)) (*DescribeAccountModificationsOutput, error) { if params == nil { params = &DescribeAccountModificationsInput{} diff --git a/service/workspaces/api_op_DescribeClientBranding.go b/service/workspaces/api_op_DescribeClientBranding.go index d92b77b2759..8e7f74626a5 100644 --- a/service/workspaces/api_op_DescribeClientBranding.go +++ b/service/workspaces/api_op_DescribeClientBranding.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified client branding. Client branding allows you to customize -// the log in page of various device types for your users. You can add your company -// logo, the support email address, support link, link to reset password, and a -// custom message for users trying to sign in. Only device types that have branding -// information configured will be shown in the response. +// Describes the specified client branding. Client branding allows you to +// customize the log in page of various device types for your users. You can add +// your company logo, the support email address, support link, link to reset +// password, and a custom message for users trying to sign in. Only device types +// that have branding information configured will be shown in the response. func (c *Client) DescribeClientBranding(ctx context.Context, params *DescribeClientBrandingInput, optFns ...func(*Options)) (*DescribeClientBrandingOutput, error) { if params == nil { params = &DescribeClientBrandingInput{} diff --git a/service/workspaces/api_op_DescribeConnectionAliasPermissions.go b/service/workspaces/api_op_DescribeConnectionAliasPermissions.go index 67f28e07cd7..9a29ccf2796 100644 --- a/service/workspaces/api_op_DescribeConnectionAliasPermissions.go +++ b/service/workspaces/api_op_DescribeConnectionAliasPermissions.go @@ -13,8 +13,8 @@ import ( // Describes the permissions that the owner of a connection alias has granted to // another Amazon Web Services account for the specified connection alias. For more -// information, see Cross-Region Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . func (c *Client) DescribeConnectionAliasPermissions(ctx context.Context, params *DescribeConnectionAliasPermissionsInput, optFns ...func(*Options)) (*DescribeConnectionAliasPermissionsOutput, error) { if params == nil { params = &DescribeConnectionAliasPermissionsInput{} diff --git a/service/workspaces/api_op_DescribeConnectionAliases.go b/service/workspaces/api_op_DescribeConnectionAliases.go index 2919004992c..72876a8b5dd 100644 --- a/service/workspaces/api_op_DescribeConnectionAliases.go +++ b/service/workspaces/api_op_DescribeConnectionAliases.go @@ -12,9 +12,9 @@ import ( ) // Retrieves a list that describes the connection aliases used for cross-Region -// redirection. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// redirection. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . func (c *Client) DescribeConnectionAliases(ctx context.Context, params *DescribeConnectionAliasesInput, optFns ...func(*Options)) (*DescribeConnectionAliasesOutput, error) { if params == nil { params = &DescribeConnectionAliasesInput{} diff --git a/service/workspaces/api_op_DescribeWorkspaceBundles.go b/service/workspaces/api_op_DescribeWorkspaceBundles.go index 1929c962d22..6c14444a5dd 100644 --- a/service/workspaces/api_op_DescribeWorkspaceBundles.go +++ b/service/workspaces/api_op_DescribeWorkspaceBundles.go @@ -31,8 +31,8 @@ func (c *Client) DescribeWorkspaceBundles(ctx context.Context, params *DescribeW type DescribeWorkspaceBundlesInput struct { - // The identifiers of the bundles. You cannot combine this parameter with any other - // filter. + // The identifiers of the bundles. You cannot combine this parameter with any + // other filter. BundleIds []string // The token for the next set of results. (You received this token from a previous @@ -40,8 +40,8 @@ type DescribeWorkspaceBundlesInput struct { NextToken *string // The owner of the bundles. You cannot combine this parameter with any other - // filter. To describe the bundles provided by Amazon Web Services, specify AMAZON. - // To describe the bundles that belong to your account, don't specify a value. + // filter. To describe the bundles provided by Amazon Web Services, specify AMAZON + // . To describe the bundles that belong to your account, don't specify a value. Owner *string noSmithyDocumentSerde diff --git a/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go b/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go index 8ac967787bf..e593a346056 100644 --- a/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go +++ b/service/workspaces/api_op_DescribeWorkspaceImagePermissions.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the permissions that the owner of an image has granted to other Amazon -// Web Services accounts for an image. +// Describes the permissions that the owner of an image has granted to other +// Amazon Web Services accounts for an image. func (c *Client) DescribeWorkspaceImagePermissions(ctx context.Context, params *DescribeWorkspaceImagePermissionsInput, optFns ...func(*Options)) (*DescribeWorkspaceImagePermissionsOutput, error) { if params == nil { params = &DescribeWorkspaceImagePermissionsInput{} diff --git a/service/workspaces/api_op_DescribeWorkspaces.go b/service/workspaces/api_op_DescribeWorkspaces.go index f18c4939fce..a7d0c1fa13f 100644 --- a/service/workspaces/api_op_DescribeWorkspaces.go +++ b/service/workspaces/api_op_DescribeWorkspaces.go @@ -37,7 +37,7 @@ type DescribeWorkspacesInput struct { BundleId *string // The identifier of the directory. In addition, you can optionally specify a - // specific directory user (see UserName). You cannot combine this parameter with + // specific directory user (see UserName ). You cannot combine this parameter with // any other filter. DirectoryId *string @@ -48,8 +48,8 @@ type DescribeWorkspacesInput struct { // this token to receive the next set of results. NextToken *string - // The name of the directory user. You must specify this parameter with - // DirectoryId. + // The name of the directory user. You must specify this parameter with DirectoryId + // . UserName *string // The identifiers of the WorkSpaces. You cannot combine this parameter with any diff --git a/service/workspaces/api_op_DisassociateConnectionAlias.go b/service/workspaces/api_op_DisassociateConnectionAlias.go index d8066548d4a..1fba51b2998 100644 --- a/service/workspaces/api_op_DisassociateConnectionAlias.go +++ b/service/workspaces/api_op_DisassociateConnectionAlias.go @@ -12,12 +12,10 @@ import ( // Disassociates a connection alias from a directory. Disassociating a connection // alias disables cross-Region redirection between two directories in different -// Regions. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -// Before performing this operation, call DescribeConnectionAliases -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) -// to make sure that the current state of the connection alias is CREATED. +// Regions. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) +// to make sure that the current state of the connection alias is CREATED . func (c *Client) DisassociateConnectionAlias(ctx context.Context, params *DisassociateConnectionAliasInput, optFns ...func(*Options)) (*DisassociateConnectionAliasOutput, error) { if params == nil { params = &DisassociateConnectionAliasInput{} diff --git a/service/workspaces/api_op_ImportClientBranding.go b/service/workspaces/api_op_ImportClientBranding.go index 0cabc7043ee..170545e334b 100644 --- a/service/workspaces/api_op_ImportClientBranding.go +++ b/service/workspaces/api_op_ImportClientBranding.go @@ -17,20 +17,14 @@ import ( // message for users trying to sign in. After you import client branding, the // default branding experience for the specified platform type is replaced with the // imported experience -// -// * You must specify at least one platform type when -// importing client branding. -// -// * You can import up to 6 MB of data with each -// request. If your request exceeds this limit, you can import client branding for -// different platform types using separate requests. -// -// * In each platform type, the -// SupportEmail and SupportLink parameters are mutually exclusive. You can specify -// only one parameter for each platform type, but not both. -// -// * Imported data can -// take up to a minute to appear in the WorkSpaces client. +// - You must specify at least one platform type when importing client branding. +// - You can import up to 6 MB of data with each request. If your request +// exceeds this limit, you can import client branding for different platform types +// using separate requests. +// - In each platform type, the SupportEmail and SupportLink parameters are +// mutually exclusive. You can specify only one parameter for each platform type, +// but not both. +// - Imported data can take up to a minute to appear in the WorkSpaces client. func (c *Client) ImportClientBranding(ctx context.Context, params *ImportClientBrandingInput, optFns ...func(*Options)) (*ImportClientBrandingOutput, error) { if params == nil { params = &ImportClientBrandingInput{} diff --git a/service/workspaces/api_op_ImportWorkspaceImage.go b/service/workspaces/api_op_ImportWorkspaceImage.go index 88863d21277..5a345f237bb 100644 --- a/service/workspaces/api_op_ImportWorkspaceImage.go +++ b/service/workspaces/api_op_ImportWorkspaceImage.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon -// WorkSpaces. The image must be an already licensed Amazon EC2 image that is in -// your Amazon Web Services account, and you must own the image. For more -// information about creating BYOL images, see Bring Your Own Windows Desktop -// Licenses -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). +// Imports the specified Windows 10 Bring Your Own License (BYOL) image into +// Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that +// is in your Amazon Web Services account, and you must own the image. For more +// information about creating BYOL images, see Bring Your Own Windows Desktop +// Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) +// . func (c *Client) ImportWorkspaceImage(ctx context.Context, params *ImportWorkspaceImageInput, optFns ...func(*Options)) (*ImportWorkspaceImageOutput, error) { if params == nil { params = &ImportWorkspaceImageInput{} @@ -52,23 +52,22 @@ type ImportWorkspaceImageInput struct { // The ingestion process to be used when importing the image, depending on which // protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces // Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify - // a value that ends in _WSP. To use PCoIP, specify a value that does not end in - // _WSP. To use BYOP, specify a value that ends in _BYOP. For non-GPU-enabled - // bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, - // BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol. The + // a value that ends in _WSP . To use PCoIP, specify a value that does not end in + // _WSP . To use BYOP, specify a value that ends in _BYOP . For non-GPU-enabled + // bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR , + // BYOL_REGULAR_WSP , or BYOL_REGULAR_BYOP , depending on the protocol. The // BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by // Amazon WorkSpaces Core. Contact your account team to be allow-listed to use - // these values. For more information, see Amazon WorkSpaces Core - // (http://aws.amazon.com/workspaces/core/). + // these values. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) + // . // // This member is required. IngestionProcess types.WorkspaceImageIngestionProcess // If specified, the version of Microsoft Office to subscribe to. Valid only for // Windows 10 BYOL images. For more information about subscribing to Office for - // BYOL images, see Bring Your Own Windows Desktop Licenses - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). - // Although this parameter is an array, only one item is allowed at this time. + // BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) + // . Although this parameter is an array, only one item is allowed at this time. Applications []types.Application // The tags. Each WorkSpaces resource can have a maximum of 50 tags. diff --git a/service/workspaces/api_op_MigrateWorkspace.go b/service/workspaces/api_op_MigrateWorkspace.go index 4be706ccd1d..1214a4593fb 100644 --- a/service/workspaces/api_op_MigrateWorkspace.go +++ b/service/workspaces/api_op_MigrateWorkspace.go @@ -15,11 +15,11 @@ import ( // WorkSpace by using a new root volume from the target bundle image and the user // volume from the last available snapshot of the original WorkSpace. During // migration, the original D:\Users\%USERNAME% user profile folder is renamed to -// D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder -// is generated by the new OS. Certain files in the old user profile are moved to -// the new user profile. For available migration scenarios, details about what -// happens during migration, and best practices, see Migrate a WorkSpace -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html). +// D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated . A new D:\Users\%USERNAME%\ +// folder is generated by the new OS. Certain files in the old user profile are +// moved to the new user profile. For available migration scenarios, details about +// what happens during migration, and best practices, see Migrate a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html) +// . func (c *Client) MigrateWorkspace(ctx context.Context, params *MigrateWorkspaceInput, optFns ...func(*Options)) (*MigrateWorkspaceOutput, error) { if params == nil { params = &MigrateWorkspaceInput{} diff --git a/service/workspaces/api_op_ModifySamlProperties.go b/service/workspaces/api_op_ModifySamlProperties.go index 9f7bee26459..6b2565256d2 100644 --- a/service/workspaces/api_op_ModifySamlProperties.go +++ b/service/workspaces/api_op_ModifySamlProperties.go @@ -38,12 +38,9 @@ type ModifySamlPropertiesInput struct { // The SAML properties to delete as part of your request. Specify one of the // following options: - // - // * SAML_PROPERTIES_USER_ACCESS_URL to delete the user access - // URL. - // - // * SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state - // parameter name. + // - SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL. + // - SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state + // parameter name. PropertiesToDelete []types.DeletableSamlProperty // The properties for configuring SAML 2.0 authentication. diff --git a/service/workspaces/api_op_ModifySelfservicePermissions.go b/service/workspaces/api_op_ModifySelfservicePermissions.go index 7d653614cc7..413a3847f21 100644 --- a/service/workspaces/api_op_ModifySelfservicePermissions.go +++ b/service/workspaces/api_op_ModifySelfservicePermissions.go @@ -13,8 +13,8 @@ import ( // Modifies the self-service WorkSpace management capabilities for your users. For // more information, see Enable Self-Service WorkSpace Management Capabilities for -// Your Users -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html). +// Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html) +// . func (c *Client) ModifySelfservicePermissions(ctx context.Context, params *ModifySelfservicePermissionsInput, optFns ...func(*Options)) (*ModifySelfservicePermissionsOutput, error) { if params == nil { params = &ModifySelfservicePermissionsInput{} diff --git a/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go b/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go index 776eb843dba..29f22e5709e 100644 --- a/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go +++ b/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go @@ -12,8 +12,8 @@ import ( ) // Specifies which devices and operating systems users can use to access their -// WorkSpaces. For more information, see Control Device Access -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access). +// WorkSpaces. For more information, see Control Device Access (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access) +// . func (c *Client) ModifyWorkspaceAccessProperties(ctx context.Context, params *ModifyWorkspaceAccessPropertiesInput, optFns ...func(*Options)) (*ModifyWorkspaceAccessPropertiesOutput, error) { if params == nil { params = &ModifyWorkspaceAccessPropertiesInput{} diff --git a/service/workspaces/api_op_ModifyWorkspaceProperties.go b/service/workspaces/api_op_ModifyWorkspaceProperties.go index a32f300e9c1..59d5bae7ccd 100644 --- a/service/workspaces/api_op_ModifyWorkspaceProperties.go +++ b/service/workspaces/api_op_ModifyWorkspaceProperties.go @@ -11,13 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified WorkSpace properties. For important information about how -// to modify the size of the root and user volumes, see Modify a WorkSpace -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). -// The MANUAL running mode value is only supported by Amazon WorkSpaces Core. +// Modifies the specified WorkSpace properties. For important information about +// how to modify the size of the root and user volumes, see Modify a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) +// . The MANUAL running mode value is only supported by Amazon WorkSpaces Core. // Contact your account team to be allow-listed to use this value. For more -// information, see Amazon WorkSpaces Core -// (http://aws.amazon.com/workspaces/core/). +// information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) +// . func (c *Client) ModifyWorkspaceProperties(ctx context.Context, params *ModifyWorkspacePropertiesInput, optFns ...func(*Options)) (*ModifyWorkspacePropertiesOutput, error) { if params == nil { params = &ModifyWorkspacePropertiesInput{} diff --git a/service/workspaces/api_op_ModifyWorkspaceState.go b/service/workspaces/api_op_ModifyWorkspaceState.go index a226cc3e62d..e761d014053 100644 --- a/service/workspaces/api_op_ModifyWorkspaceState.go +++ b/service/workspaces/api_op_ModifyWorkspaceState.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the state of the specified WorkSpace. 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, rebuild, or restore. An -// AutoStop WorkSpace in this state is not stopped. Users cannot log into a -// WorkSpace in the ADMIN_MAINTENANCE state. +// Sets the state of the specified WorkSpace. 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, rebuild, or +// restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log +// into a WorkSpace in the ADMIN_MAINTENANCE state. func (c *Client) ModifyWorkspaceState(ctx context.Context, params *ModifyWorkspaceStateInput, optFns ...func(*Options)) (*ModifyWorkspaceStateOutput, error) { if params == nil { params = &ModifyWorkspaceStateInput{} diff --git a/service/workspaces/api_op_RebootWorkspaces.go b/service/workspaces/api_op_RebootWorkspaces.go index 1d5ef2233a5..0646c6faab9 100644 --- a/service/workspaces/api_op_RebootWorkspaces.go +++ b/service/workspaces/api_op_RebootWorkspaces.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state -// is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the -// WorkSpaces have rebooted. +// Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its +// state is AVAILABLE or UNHEALTHY . This operation is asynchronous and returns +// before the WorkSpaces have rebooted. func (c *Client) RebootWorkspaces(ctx context.Context, params *RebootWorkspacesInput, optFns ...func(*Options)) (*RebootWorkspacesOutput, error) { if params == nil { params = &RebootWorkspacesInput{} diff --git a/service/workspaces/api_op_RebuildWorkspaces.go b/service/workspaces/api_op_RebuildWorkspaces.go index a903c85ec74..5630b186a32 100644 --- a/service/workspaces/api_op_RebuildWorkspaces.go +++ b/service/workspaces/api_op_RebuildWorkspaces.go @@ -12,11 +12,10 @@ import ( ) // Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its -// state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. Rebuilding a +// state is AVAILABLE , ERROR , UNHEALTHY , STOPPED , or REBOOTING . Rebuilding a // WorkSpace is a potentially destructive action that can result in the loss of -// data. For more information, see Rebuild a WorkSpace -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html). -// This operation is asynchronous and returns before the WorkSpaces have been +// data. For more information, see Rebuild a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html) +// . This operation is asynchronous and returns before the WorkSpaces have been // completely rebuilt. func (c *Client) RebuildWorkspaces(ctx context.Context, params *RebuildWorkspacesInput, optFns ...func(*Options)) (*RebuildWorkspacesOutput, error) { if params == nil { diff --git a/service/workspaces/api_op_RegisterWorkspaceDirectory.go b/service/workspaces/api_op_RegisterWorkspaceDirectory.go index 8bc77cc42f5..95e76361b85 100644 --- a/service/workspaces/api_op_RegisterWorkspaceDirectory.go +++ b/service/workspaces/api_op_RegisterWorkspaceDirectory.go @@ -14,9 +14,9 @@ import ( // Registers the specified directory. This operation is asynchronous and returns // before the WorkSpace directory is registered. If this is the first time you are // registering a directory, you will need to create the workspaces_DefaultRole role -// before you can register a directory. For more information, see Creating the -// workspaces_DefaultRole Role -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). +// before you can register a directory. For more information, see Creating the +// workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role) +// . func (c *Client) RegisterWorkspaceDirectory(ctx context.Context, params *RegisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*RegisterWorkspaceDirectoryOutput, error) { if params == nil { params = &RegisterWorkspaceDirectoryInput{} @@ -69,8 +69,8 @@ type RegisterWorkspaceDirectoryInput struct { // Amazon Web Services account must be enabled for BYOL. If your account has not // been enabled for BYOL, you will receive an InvalidParameterValuesException // error. For more information about BYOL images, see Bring Your Own Windows - // Desktop Images - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + // Desktop Images (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) + // . Tenancy types.Tenancy noSmithyDocumentSerde diff --git a/service/workspaces/api_op_RestoreWorkspace.go b/service/workspaces/api_op_RestoreWorkspace.go index a57e83dc7bb..1d726da78f4 100644 --- a/service/workspaces/api_op_RestoreWorkspace.go +++ b/service/workspaces/api_op_RestoreWorkspace.go @@ -11,11 +11,10 @@ import ( ) // Restores the specified WorkSpace to its last known healthy state. You cannot -// restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or -// STOPPED. Restoring a WorkSpace is a potentially destructive action that can -// result in the loss of data. For more information, see Restore a WorkSpace -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html). -// This operation is asynchronous and returns before the WorkSpace is completely +// restore a WorkSpace unless its state is AVAILABLE , ERROR , UNHEALTHY , or +// STOPPED . Restoring a WorkSpace is a potentially destructive action that can +// result in the loss of data. For more information, see Restore a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html) +// . This operation is asynchronous and returns before the WorkSpace is completely // restored. func (c *Client) RestoreWorkspace(ctx context.Context, params *RestoreWorkspaceInput, optFns ...func(*Options)) (*RestoreWorkspaceOutput, error) { if params == nil { diff --git a/service/workspaces/api_op_StartWorkspaces.go b/service/workspaces/api_op_StartWorkspaces.go index 05201b18efc..10fb46c0054 100644 --- a/service/workspaces/api_op_StartWorkspaces.go +++ b/service/workspaces/api_op_StartWorkspaces.go @@ -12,7 +12,7 @@ import ( ) // Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a -// running mode of AutoStop and a state of STOPPED. +// running mode of AutoStop and a state of STOPPED . func (c *Client) StartWorkspaces(ctx context.Context, params *StartWorkspacesInput, optFns ...func(*Options)) (*StartWorkspacesOutput, error) { if params == nil { params = &StartWorkspacesInput{} diff --git a/service/workspaces/api_op_StopWorkspaces.go b/service/workspaces/api_op_StopWorkspaces.go index 5d48d0792c0..e6eae139461 100644 --- a/service/workspaces/api_op_StopWorkspaces.go +++ b/service/workspaces/api_op_StopWorkspaces.go @@ -12,8 +12,8 @@ import ( ) // Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a -// running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or -// ERROR. +// running mode of AutoStop and a state of AVAILABLE , IMPAIRED , UNHEALTHY , or +// ERROR . func (c *Client) StopWorkspaces(ctx context.Context, params *StopWorkspacesInput, optFns ...func(*Options)) (*StopWorkspacesOutput, error) { if params == nil { params = &StopWorkspacesInput{} diff --git a/service/workspaces/api_op_TerminateWorkspaces.go b/service/workspaces/api_op_TerminateWorkspaces.go index 79c888f1679..3ccb5e4a682 100644 --- a/service/workspaces/api_op_TerminateWorkspaces.go +++ b/service/workspaces/api_op_TerminateWorkspaces.go @@ -15,23 +15,20 @@ import ( // action and cannot be undone. The user's data is destroyed. If you need to // archive any user data, contact Amazon Web Services Support before terminating // the WorkSpace. You can terminate a WorkSpace that is in any state except -// SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have -// been completely terminated. After a WorkSpace is terminated, the TERMINATED +// SUSPENDED . This operation is asynchronous and returns before the WorkSpaces +// have been completely terminated. After a WorkSpace is terminated, the TERMINATED // state is returned only briefly before the WorkSpace directory metadata is // cleaned up, so this state is rarely returned. To confirm that a WorkSpace is -// terminated, check for the WorkSpace ID by using DescribeWorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). -// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully +// terminated, check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) +// . If the WorkSpace ID isn't returned, then the WorkSpace has been successfully // terminated. Simple AD and AD Connector are made available to you free of charge // to use with WorkSpaces. If there are no WorkSpaces being used with your Simple // AD or AD Connector directory for 30 consecutive days, this directory will be // automatically deregistered for use with Amazon WorkSpaces, and you will be -// charged for this directory as per the Directory Service pricing terms -// (http://aws.amazon.com/directoryservice/pricing/). To delete empty directories, -// see Delete the Directory for Your WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). -// If you delete your Simple AD or AD Connector directory, you can always create a -// new one when you want to start using WorkSpaces again. +// charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/) +// . To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html) +// . If you delete your Simple AD or AD Connector directory, you can always create +// a new one when you want to start using WorkSpaces again. func (c *Client) TerminateWorkspaces(ctx context.Context, params *TerminateWorkspacesInput, optFns ...func(*Options)) (*TerminateWorkspacesOutput, error) { if params == nil { params = &TerminateWorkspacesInput{} diff --git a/service/workspaces/api_op_UpdateConnectionAliasPermission.go b/service/workspaces/api_op_UpdateConnectionAliasPermission.go index bf8b07845df..e68569056d6 100644 --- a/service/workspaces/api_op_UpdateConnectionAliasPermission.go +++ b/service/workspaces/api_op_UpdateConnectionAliasPermission.go @@ -15,21 +15,16 @@ import ( // that account has permission to associate the connection alias with a directory. // If the association permission is granted, the connection alias is shared with // that account. If the association permission is revoked, the connection alias is -// unshared with the account. For more information, see Cross-Region Redirection -// for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). -// -// * -// Before performing this operation, call DescribeConnectionAliases -// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) -// to make sure that the current state of the connection alias is CREATED. -// -// * To -// delete a connection alias that has been shared, the shared account must first -// disassociate the connection alias from any directories it has been associated -// with. Then you must unshare the connection alias from the account it has been -// shared with. You can delete a connection alias only after it is no longer shared -// with any accounts or associated with any directories. +// unshared with the account. For more information, see Cross-Region Redirection +// for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . +// - Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) +// to make sure that the current state of the connection alias is CREATED . +// - To delete a connection alias that has been shared, the shared account must +// first disassociate the connection alias from any directories it has been +// associated with. Then you must unshare the connection alias from the account it +// has been shared with. You can delete a connection alias only after it is no +// longer shared with any accounts or associated with any directories. func (c *Client) UpdateConnectionAliasPermission(ctx context.Context, params *UpdateConnectionAliasPermissionInput, optFns ...func(*Options)) (*UpdateConnectionAliasPermissionOutput, error) { if params == nil { params = &UpdateConnectionAliasPermissionInput{} diff --git a/service/workspaces/api_op_UpdateWorkspaceBundle.go b/service/workspaces/api_op_UpdateWorkspaceBundle.go index e385f9a3b8b..a6c050e6dbf 100644 --- a/service/workspaces/api_op_UpdateWorkspaceBundle.go +++ b/service/workspaces/api_op_UpdateWorkspaceBundle.go @@ -10,13 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a WorkSpace bundle with a new image. For more information about updating -// WorkSpace bundles, see Update a Custom WorkSpaces Bundle -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html). -// Existing WorkSpaces aren't automatically updated when you update the bundle that -// they're based on. To update existing WorkSpaces that are based on a bundle that -// you've updated, you must either rebuild the WorkSpaces or delete and recreate -// them. +// Updates a WorkSpace bundle with a new image. For more information about +// updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html) +// . Existing WorkSpaces aren't automatically updated when you update the bundle +// that they're based on. To update existing WorkSpaces that are based on a bundle +// that you've updated, you must either rebuild the WorkSpaces or delete and +// recreate them. func (c *Client) UpdateWorkspaceBundle(ctx context.Context, params *UpdateWorkspaceBundleInput, optFns ...func(*Options)) (*UpdateWorkspaceBundleOutput, error) { if params == nil { params = &UpdateWorkspaceBundleInput{} diff --git a/service/workspaces/api_op_UpdateWorkspaceImagePermission.go b/service/workspaces/api_op_UpdateWorkspaceImagePermission.go index d6cf63d0880..b7758f4adbd 100644 --- a/service/workspaces/api_op_UpdateWorkspaceImagePermission.go +++ b/service/workspaces/api_op_UpdateWorkspaceImagePermission.go @@ -18,18 +18,14 @@ import ( // other Regions as needed. In the China (Ningxia) Region, you can copy images only // within the same Region. In Amazon Web Services GovCloud (US), to copy images to // and from other Regions, contact Amazon Web Services Support. For more -// information about sharing images, see Share or Unshare a Custom WorkSpaces -// Image -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html). -// -// * -// To delete an image that has been shared, you must unshare the image before you -// delete it. -// -// * Sharing Bring Your Own License (BYOL) images across Amazon Web -// Services accounts isn't supported at this time in Amazon Web Services GovCloud -// (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), -// contact Amazon Web Services Support. +// information about sharing images, see Share or Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html) +// . +// - To delete an image that has been shared, you must unshare the image before +// you delete it. +// - Sharing Bring Your Own License (BYOL) images across Amazon Web Services +// accounts isn't supported at this time in Amazon Web Services GovCloud (US). To +// share BYOL images across accounts in Amazon Web Services GovCloud (US), contact +// Amazon Web Services Support. func (c *Client) UpdateWorkspaceImagePermission(ctx context.Context, params *UpdateWorkspaceImagePermissionInput, optFns ...func(*Options)) (*UpdateWorkspaceImagePermissionOutput, error) { if params == nil { params = &UpdateWorkspaceImagePermissionInput{} diff --git a/service/workspaces/doc.go b/service/workspaces/doc.go index 32fa91af7a0..b3cabce04d2 100644 --- a/service/workspaces/doc.go +++ b/service/workspaces/doc.go @@ -16,12 +16,11 @@ // Web Services General Reference. You can also manage your WorkSpaces resources // using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more // information about administering WorkSpaces, see the Amazon WorkSpaces -// Administration Guide -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/). For more -// information about using the Amazon WorkSpaces client application or web browser -// to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide -// (https://docs.aws.amazon.com/workspaces/latest/userguide/). For more information -// about using the CLI to manage your WorkSpaces resources, see the WorkSpaces -// section of the CLI Reference -// (https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html). +// Administration Guide (https://docs.aws.amazon.com/workspaces/latest/adminguide/) +// . For more information about using the Amazon WorkSpaces client application or +// web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User +// Guide (https://docs.aws.amazon.com/workspaces/latest/userguide/) . For more +// information about using the CLI to manage your WorkSpaces resources, see the +// WorkSpaces section of the CLI Reference (https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html) +// . package workspaces diff --git a/service/workspaces/types/enums.go b/service/workspaces/types/enums.go index e5188adc96e..15f062cb71f 100644 --- a/service/workspaces/types/enums.go +++ b/service/workspaces/types/enums.go @@ -242,8 +242,8 @@ const ( DedicatedTenancySupportResultEnumDisabled DedicatedTenancySupportResultEnum = "DISABLED" ) -// Values returns all known values for DedicatedTenancySupportResultEnum. Note that -// this can be expanded in the future, and so it is only as up to date as the +// Values returns all known values for DedicatedTenancySupportResultEnum. Note +// that this can be expanded in the future, and so it is only as up to date as the // client. The ordering of this slice is not guaranteed to be stable across // updates. func (DedicatedTenancySupportResultEnum) Values() []DedicatedTenancySupportResultEnum { @@ -278,8 +278,8 @@ const ( DeletableSamlPropertySamlPropertiesRelayStateParameterName DeletableSamlProperty = "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME" ) -// Values returns all known values for DeletableSamlProperty. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for DeletableSamlProperty. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (DeletableSamlProperty) Values() []DeletableSamlProperty { return []DeletableSamlProperty{ @@ -296,9 +296,9 @@ const ( ImageTypeShared ImageType = "SHARED" ) -// Values returns all known values for ImageType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// Values returns all known values for ImageType. Note that this can be expanded +// in the future, and so it is only as up to date as the client. The ordering of +// this slice is not guaranteed to be stable across updates. func (ImageType) Values() []ImageType { return []ImageType{ "OWNED", @@ -333,9 +333,9 @@ const ( ModificationResourceEnumComputeType ModificationResourceEnum = "COMPUTE_TYPE" ) -// Values returns all known values for ModificationResourceEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// Values returns all known values for ModificationResourceEnum. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. func (ModificationResourceEnum) Values() []ModificationResourceEnum { return []ModificationResourceEnum{ "ROOT_VOLUME", @@ -352,8 +352,8 @@ const ( ModificationStateEnumUpdateInProgress ModificationStateEnum = "UPDATE_IN_PROGRESS" ) -// Values returns all known values for ModificationStateEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The +// Values returns all known values for ModificationStateEnum. Note that this can +// be expanded in the future, and so it is only as up to date as the client. The // ordering of this slice is not guaranteed to be stable across updates. func (ModificationStateEnum) Values() []ModificationStateEnum { return []ModificationStateEnum{ diff --git a/service/workspaces/types/errors.go b/service/workspaces/types/errors.go index b9688fa0f5b..6db1ceb9ac0 100644 --- a/service/workspaces/types/errors.go +++ b/service/workspaces/types/errors.go @@ -302,8 +302,8 @@ func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault { return s // The configuration of this network is not supported for this operation, or your // network configuration conflicts with the Amazon WorkSpaces management network IP -// range. For more information, see Configure a VPC for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). +// range. For more information, see Configure a VPC for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html) +// . type UnsupportedNetworkConfigurationException struct { Message *string @@ -333,8 +333,8 @@ func (e *UnsupportedNetworkConfigurationException) ErrorFault() smithy.ErrorFaul // The configuration of this WorkSpace is not supported for this operation. For // more information, see Required Configuration and Service Components for -// WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html). +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html) +// . type UnsupportedWorkspaceConfigurationException struct { Message *string @@ -365,8 +365,8 @@ func (e *UnsupportedWorkspaceConfigurationException) ErrorFault() smithy.ErrorFa // The workspaces_DefaultRole role could not be found. If this is the first time // you are registering a directory, you will need to create the // workspaces_DefaultRole role before you can register a directory. For more -// information, see Creating the workspaces_DefaultRole Role -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). +// information, see Creating the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role) +// . type WorkspacesDefaultRoleNotFoundException struct { Message *string diff --git a/service/workspaces/types/types.go b/service/workspaces/types/types.go index e42726b3774..36e8fd2d07d 100644 --- a/service/workspaces/types/types.go +++ b/service/workspaces/types/types.go @@ -34,8 +34,8 @@ type AccountModification struct { noSmithyDocumentSerde } -// Describes the properties of the certificate-based authentication you want to use -// with your WorkSpaces. +// Describes the properties of the certificate-based authentication you want to +// use with your WorkSpaces. type CertificateBasedAuthProperties struct { // The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager @@ -105,9 +105,9 @@ type ConnectClientAddIn struct { } // Describes a connection alias. Connection aliases are used for cross-Region -// redirection. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// redirection. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . type ConnectionAlias struct { // The identifier of the connection alias. @@ -118,7 +118,7 @@ type ConnectionAlias struct { // The connection string specified for the connection alias. The connection string // must be in the form of a fully qualified domain name (FQDN), such as - // www.example.com. + // www.example.com . ConnectionString *string // The identifier of the Amazon Web Services account that owns the connection @@ -132,13 +132,13 @@ type ConnectionAlias struct { } // Describes a connection alias association that is used for cross-Region -// redirection. For more information, see Cross-Region Redirection for Amazon -// WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// redirection. For more information, see Cross-Region Redirection for Amazon +// WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . type ConnectionAliasAssociation struct { - // The identifier of the Amazon Web Services account that associated the connection - // alias with a directory. + // The identifier of the Amazon Web Services account that associated the + // connection alias with a directory. AssociatedAccountId *string // The association status of the connection alias. @@ -156,9 +156,9 @@ type ConnectionAliasAssociation struct { } // Describes the permissions for a connection alias. Connection aliases are used -// for cross-Region redirection. For more information, see Cross-Region -// Redirection for Amazon WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). +// for cross-Region redirection. For more information, see Cross-Region +// Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) +// . type ConnectionAliasPermission struct { // Indicates whether the specified Amazon Web Services account is allowed to @@ -187,9 +187,9 @@ type DefaultClientBrandingAttributes struct { // The login message. Specified as a key value pair, in which the key is a locale // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, br, + // is en_US . The HTML tags supported include the following: a, b, blockquote, br, // cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. + // strong, sub, sup, u, ul . LoginMessage map[string]string // The logo. The only image format accepted is a binary data object that is @@ -197,23 +197,18 @@ type DefaultClientBrandingAttributes struct { LogoUrl *string // The support email. The company's customer support email address. - // - // * In each - // platform type, the SupportEmail and SupportLink parameters are mutually - // exclusive. You can specify one parameter for each platform type, but not - // both. - // - // * The default email is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default email is workspaces-feedback@amazon.com . SupportEmail *string // The support link. The link for the company's customer support page for their // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters - // are mutually exclusive.You can specify one parameter for each platform type, but - // not both. - // - // * The default support link is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive.You can specify one parameter for each platform type, but not + // both. + // - The default support link is workspaces-feedback@amazon.com . SupportLink *string noSmithyDocumentSerde @@ -230,9 +225,9 @@ type DefaultImportClientBrandingAttributes struct { // The login message. Specified as a key value pair, in which the key is a locale // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, br, + // is en_US . The HTML tags supported include the following: a, b, blockquote, br, // cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. + // strong, sub, sup, u, ul . LoginMessage map[string]string // The logo. The only image format accepted is a binary data object that is @@ -240,36 +235,31 @@ type DefaultImportClientBrandingAttributes struct { Logo []byte // The support email. The company's customer support email address. - // - // * In each - // platform type, the SupportEmail and SupportLink parameters are mutually - // exclusive. You can specify one parameter for each platform type, but not - // both. - // - // * The default email is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default email is workspaces-feedback@amazon.com . SupportEmail *string // The support link. The link for the company's customer support page for their // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters - // are mutually exclusive. You can specify one parameter for each platform type, - // but not both. - // - // * The default support link is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default support link is workspaces-feedback@amazon.com . SupportLink *string noSmithyDocumentSerde } // Describes the default values that are used to create WorkSpaces. For more -// information, see Update Directory Details for Your WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html). +// information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html) +// . type DefaultWorkspaceCreationProperties struct { // The identifier of the default security group to apply to WorkSpaces when they - // are created. For more information, see Security Groups for Your WorkSpaces - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html). + // are created. For more information, see Security Groups for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html) + // . CustomSecurityGroupId *string // The organizational unit (OU) in the directory for the WorkSpace machine @@ -284,13 +274,13 @@ type DefaultWorkspaceCreationProperties struct { // access from your VPC, or if your WorkSpaces are in public subnets and you // manually assign them Elastic IP addresses, you should disable this setting. This // setting applies to new WorkSpaces that you launch or to existing WorkSpaces that - // you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). + // you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html) + // . EnableInternetAccess *bool // Specifies whether maintenance mode is enabled for WorkSpaces. For more - // information, see WorkSpace Maintenance - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). + // information, see WorkSpace Maintenance (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html) + // . EnableMaintenanceMode *bool // Specifies whether the directory is enabled for Amazon WorkDocs. @@ -334,9 +324,10 @@ type FailedCreateWorkspaceRequest struct { noSmithyDocumentSerde } -// Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt -// (RebuildWorkspaces), restored (RestoreWorkspace), terminated -// (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces). +// Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( +// RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( +// TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces +// ). type FailedWorkspaceChangeRequest struct { // The error code that is returned if the WorkSpace cannot be rebooted. @@ -353,9 +344,9 @@ type FailedWorkspaceChangeRequest struct { } // Describes the Amazon Web Services accounts that have been granted permission to -// use a shared image. For more information about sharing images, see Share or -// Unshare a Custom WorkSpaces Image -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html). +// use a shared image. For more information about sharing images, see Share or +// Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html) +// . type ImagePermission struct { // The identifier of the Amazon Web Services account that an image has been shared @@ -376,24 +367,22 @@ type IosClientBrandingAttributes struct { // The login message. Specified as a key value pair, in which the key is a locale // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, br, + // is en_US . The HTML tags supported include the following: a, b, blockquote, br, // cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. + // strong, sub, sup, u, ul . LoginMessage map[string]string - // The @2x version of the logo. This is the higher resolution display that offers a - // scale factor of 2.0 (or @2x). The only image format accepted is a binary data + // The @2x version of the logo. This is the higher resolution display that offers + // a scale factor of 2.0 (or @2x). The only image format accepted is a binary data // object that is converted from a .png file. For more information about iOS image - // size and resolution, see Image Size and Resolution - // (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) + // size and resolution, see Image Size and Resolution (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) // in the Apple Human Interface Guidelines. Logo2xUrl *string - // The @3x version of the logo. This is the higher resolution display that offers a - // scale factor of 3.0 (or @3x).The only image format accepted is a binary data + // The @3x version of the logo. This is the higher resolution display that offers + // a scale factor of 3.0 (or @3x).The only image format accepted is a binary data // object that is converted from a .png file. For more information about iOS image - // size and resolution, see Image Size and Resolution - // (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) + // size and resolution, see Image Size and Resolution (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) // in the Apple Human Interface Guidelines. Logo3xUrl *string @@ -403,23 +392,18 @@ type IosClientBrandingAttributes struct { LogoUrl *string // The support email. The company's customer support email address. - // - // * In each - // platform type, the SupportEmail and SupportLink parameters are mutually - // exclusive. You can specify one parameter for each platform type, but not - // both. - // - // * The default email is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default email is workspaces-feedback@amazon.com . SupportEmail *string // The support link. The link for the company's customer support page for their // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters - // are mutually exclusive. You can specify one parameter for each platform type, - // but not both. - // - // * The default support link is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default support link is workspaces-feedback@amazon.com . SupportLink *string noSmithyDocumentSerde @@ -436,9 +420,9 @@ type IosImportClientBrandingAttributes struct { // The login message. Specified as a key value pair, in which the key is a locale // and the value is the localized message for that locale. The only key supported - // is en_US. The HTML tags supported include the following: a, b, blockquote, br, + // is en_US . The HTML tags supported include the following: a, b, blockquote, br, // cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, - // strong, sub, sup, u, ul. + // strong, sub, sup, u, ul . LoginMessage map[string]string // The logo. This is the standard-resolution display that has a 1:1 pixel density @@ -446,40 +430,33 @@ type IosImportClientBrandingAttributes struct { // is a binary data object that is converted from a .png file. Logo []byte - // The @2x version of the logo. This is the higher resolution display that offers a - // scale factor of 2.0 (or @2x). The only image format accepted is a binary data + // The @2x version of the logo. This is the higher resolution display that offers + // a scale factor of 2.0 (or @2x). The only image format accepted is a binary data // object that is converted from a .png file. For more information about iOS image - // size and resolution, see Image Size and Resolution - // (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) + // size and resolution, see Image Size and Resolution (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) // in the Apple Human Interface Guidelines. Logo2x []byte - // The @3x version of the logo. This is the higher resolution display that offers a - // scale factor of 3.0 (or @3x). The only image format accepted is a binary data + // The @3x version of the logo. This is the higher resolution display that offers + // a scale factor of 3.0 (or @3x). The only image format accepted is a binary data // object that is converted from a .png file. For more information about iOS image - // size and resolution, see Image Size and Resolution - // (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) + // size and resolution, see Image Size and Resolution (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/) // in the Apple Human Interface Guidelines. Logo3x []byte // The support email. The company's customer support email address. - // - // * In each - // platform type, the SupportEmail and SupportLink parameters are mutually - // exclusive. You can specify one parameter for each platform type, but not - // both. - // - // * The default email is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default email is workspaces-feedback@amazon.com . SupportEmail *string // The support link. The link for the company's customer support page for their // WorkSpace. - // - // * In each platform type, the SupportEmail and SupportLink parameters - // are mutually exclusive. You can specify one parameter for each platform type, - // but not both. - // - // * The default support link is workspaces-feedback@amazon.com. + // - In each platform type, the SupportEmail and SupportLink parameters are + // mutually exclusive. You can specify one parameter for each platform type, but + // not both. + // - The default support link is workspaces-feedback@amazon.com . SupportLink *string noSmithyDocumentSerde @@ -529,8 +506,7 @@ type PendingCreateStandbyWorkspacesRequest struct { // Describes the standby WorkSpace that was created. Because this operation is // asynchronous, the identifier returned is not immediately available for use with - // other operations. For example, if you call DescribeWorkspaces - // (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) + // other operations. For example, if you call DescribeWorkspaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) // before the WorkSpace is created, the information returned can be incomplete. UserName *string @@ -590,8 +566,9 @@ type RootStorage struct { noSmithyDocumentSerde } -// Describes the enablement status, user access URL, and relay state parameter name -// that are used for configuring federation with an SAML 2.0 identity provider. +// Describes the enablement status, user access URL, and relay state parameter +// name that are used for configuring federation with an SAML 2.0 identity +// provider. type SamlProperties struct { // The relay state parameter name supported by the SAML 2.0 identity provider @@ -605,20 +582,15 @@ type SamlProperties struct { // Indicates the status of SAML 2.0 authentication. These statuses include the // following. - // - // * If the setting is DISABLED, end users will be directed to login - // with their directory credentials. - // - // * If the setting is ENABLED, end users will - // be directed to login via the user access URL. Users attempting to connect to - // WorkSpaces from a client application that does not support SAML 2.0 - // authentication will not be able to connect. - // - // * If the setting is - // ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via - // the user access URL on supported client applications, but will not prevent - // clients that do not support SAML 2.0 authentication from connecting as if SAML - // 2.0 authentication was disabled. + // - If the setting is DISABLED , end users will be directed to login with their + // directory credentials. + // - If the setting is ENABLED , end users will be directed to login via the user + // access URL. Users attempting to connect to WorkSpaces from a client application + // that does not support SAML 2.0 authentication will not be able to connect. + // - If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be + // directed to login via the user access URL on supported client applications, but + // will not prevent clients that do not support SAML 2.0 authentication from + // connecting as if SAML 2.0 authentication was disabled. Status SamlStatusEnum // The SAML 2.0 identity provider (IdP) user access URL is the URL a user would @@ -630,8 +602,8 @@ type SamlProperties struct { } // Describes the self-service permissions for a directory. For more information, -// see Enable Self-Service WorkSpace Management Capabilities for Your Users -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html). +// see Enable Self-Service WorkSpace Management Capabilities for Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html) +// . type SelfservicePermissions struct { // Specifies whether users can change the compute type (bundle) for their @@ -761,8 +733,8 @@ type Workspace struct { BundleId *string // The name of the WorkSpace, as seen by the operating system. The format of this - // name varies. For more information, see Launch a WorkSpace - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html). + // name varies. For more information, see Launch a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) + // . ComputerName *string // The identifier of the Directory Service directory for the WorkSpace. @@ -790,9 +762,8 @@ type Workspace struct { // The operational state of the WorkSpace. After a WorkSpace is terminated, the // TERMINATED state is returned only briefly before the WorkSpace directory // metadata is cleaned up, so this state is rarely returned. To confirm that a - // WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces - // (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). - // If the WorkSpace ID isn't returned, then the WorkSpace has been successfully + // WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) + // . If the WorkSpace ID isn't returned, then the WorkSpace has been successfully // terminated. State WorkspaceState @@ -819,12 +790,12 @@ type Workspace struct { } // The device types and operating systems that can be used to access a WorkSpace. -// For more information, see Amazon WorkSpaces Client Network Requirements -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html). +// For more information, see Amazon WorkSpaces Client Network Requirements (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html) +// . type WorkspaceAccessProperties struct { - // Indicates whether users can use Android and Android-compatible Chrome OS devices - // to access their WorkSpaces. + // Indicates whether users can use Android and Android-compatible Chrome OS + // devices to access their WorkSpaces. DeviceTypeAndroid AccessPropertyValue // Indicates whether users can use Chromebooks to access their WorkSpaces. @@ -861,7 +832,7 @@ type WorkspaceBundle struct { BundleType BundleType // The compute type of the bundle. For more information, see Amazon WorkSpaces - // Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). + // Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) . ComputeType *ComputeType // The time when the bundle was created. @@ -914,9 +885,9 @@ type WorkspaceConnectionStatus struct { noSmithyDocumentSerde } -// Describes the default properties that are used for creating WorkSpaces. For more -// information, see Update Directory Details for Your WorkSpaces -// (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html). +// Describes the default properties that are used for creating WorkSpaces. For +// more information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html) +// . type WorkspaceCreationProperties struct { // The identifier of your custom security group. @@ -925,41 +896,34 @@ type WorkspaceCreationProperties struct { // The default organizational unit (OU) for your WorkSpaces directories. This // string must be the full Lightweight Directory Access Protocol (LDAP) // distinguished name for the target domain and OU. It must be in the form - // "OU=value,DC=value,DC=value", where value is any string of characters, and the + // "OU=value,DC=value,DC=value" , where value is any string of characters, and the // number of domain components (DCs) is two or more. For example, - // OU=WorkSpaces_machines,DC=machines,DC=example,DC=com. - // - // * To avoid errors, - // certain characters in the distinguished name must be escaped. For more - // information, see Distinguished Names - // (https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names) - // in the Microsoft documentation. - // - // * The API doesn't validate whether the OU - // exists. + // OU=WorkSpaces_machines,DC=machines,DC=example,DC=com . + // - To avoid errors, certain characters in the distinguished name must be + // escaped. For more information, see Distinguished Names (https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names) + // in the Microsoft documentation. + // - The API doesn't validate whether the OU exists. DefaultOu *string // Indicates whether internet access is enabled for your WorkSpaces. EnableInternetAccess *bool // Indicates whether maintenance mode is enabled for your WorkSpaces. For more - // information, see WorkSpace Maintenance - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). + // information, see WorkSpace Maintenance (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html) + // . EnableMaintenanceMode *bool - // Indicates whether Amazon WorkDocs is enabled for your WorkSpaces. If WorkDocs is - // already enabled for a WorkSpaces directory and you disable it, new WorkSpaces + // Indicates whether Amazon WorkDocs is enabled for your WorkSpaces. If WorkDocs + // is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces // launched in the directory will not have WorkDocs enabled. However, WorkDocs // remains enabled for any existing WorkSpaces, unless you either disable users' // access to WorkDocs or you delete the WorkDocs site. To disable users' access to - // WorkDocs, see Disabling Users - // (https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html) in - // the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see - // Deleting a Site - // (https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html) in - // the Amazon WorkDocs Administration Guide. If you enable WorkDocs on a directory - // that already has existing WorkSpaces, the existing WorkSpaces and any new - // WorkSpaces that are launched in the directory will have WorkDocs enabled. + // WorkDocs, see Disabling Users (https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html) + // in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see + // Deleting a Site (https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html) + // in the Amazon WorkDocs Administration Guide. If you enable WorkDocs on a + // directory that already has existing WorkSpaces, the existing WorkSpaces and any + // new WorkSpaces that are launched in the directory will have WorkDocs enabled. EnableWorkDocs *bool // Indicates whether users are local administrators of their WorkSpaces. @@ -1005,8 +969,9 @@ type WorkspaceDirectory struct { // their Amazon WorkSpaces client application to connect to the directory. RegistrationCode *string - // Describes the enablement status, user access URL, and relay state parameter name - // that are used for configuring federation with an SAML 2.0 identity provider. + // Describes the enablement status, user access URL, and relay state parameter + // name that are used for configuring federation with an SAML 2.0 identity + // provider. SamlProperties *SamlProperties // The default self-service permissions for WorkSpaces in the directory. @@ -1016,9 +981,8 @@ type WorkspaceDirectory struct { // directory is deregistered, the DEREGISTERED state is returned very briefly // before the directory metadata is cleaned up, so this state is rarely returned. // To confirm that a directory is deregistered, check for the directory ID by using - // DescribeWorkspaceDirectories - // (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html). - // If the directory ID isn't returned, then the directory has been successfully + // DescribeWorkspaceDirectories (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html) + // . If the directory ID isn't returned, then the directory has been successfully // deregistered. State WorkspaceDirectoryState @@ -1026,9 +990,9 @@ type WorkspaceDirectory struct { SubnetIds []string // Specifies whether the directory is dedicated or shared. To use Bring Your Own - // License (BYOL), this value must be set to DEDICATED. For more information, see - // Bring Your Own Windows Desktop Images - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + // License (BYOL), this value must be set to DEDICATED . For more information, see + // Bring Your Own Windows Desktop Images (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) + // . Tenancy Tenancy // The devices and operating systems that users can use to access WorkSpaces. @@ -1073,9 +1037,9 @@ type WorkspaceImage struct { OwnerAccountId *string // Specifies whether the image is running on dedicated hardware. When Bring Your - // Own License (BYOL) is enabled, this value is set to DEDICATED. For more - // information, see Bring Your Own Windows Desktop Images - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + // Own License (BYOL) is enabled, this value is set to DEDICATED . For more + // information, see Bring Your Own Windows Desktop Images (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) + // . RequiredTenancy WorkspaceImageRequiredTenancy // The status of the image. @@ -1090,34 +1054,27 @@ type WorkspaceImage struct { // Describes a WorkSpace. type WorkspaceProperties struct { - // The compute type. For more information, see Amazon WorkSpaces Bundles - // (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). + // The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) + // . ComputeTypeName Compute - // The protocol. For more information, see Protocols for Amazon WorkSpaces - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html). - // - // * - // Only available for WorkSpaces created with PCoIP bundles. - // - // * The Protocols - // property is case sensitive. Ensure you use PCOIP or WSP. - // - // * Unavailable for - // Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, - // GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn). + // The protocol. For more information, see Protocols for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html) + // . + // - Only available for WorkSpaces created with PCoIP bundles. + // - The Protocols property is case sensitive. Ensure you use PCOIP or WSP . + // - Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles + // (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn). Protocols []Protocol // The size of the root volume. For important information about how to modify the - // size of the root and user volumes, see Modify a WorkSpace - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). + // size of the root and user volumes, see Modify a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) + // . RootVolumeSizeGib *int32 - // The running mode. For more information, see Manage the WorkSpace Running Mode - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). - // The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your + // The running mode. For more information, see Manage the WorkSpace Running Mode (https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html) + // . The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your // account team to be allow-listed to use this value. For more information, see - // Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/). + // Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) . RunningMode RunningMode // The time after a user logs off when WorkSpaces are automatically stopped. @@ -1125,8 +1082,8 @@ type WorkspaceProperties struct { RunningModeAutoStopTimeoutInMinutes *int32 // The size of the user storage. For important information about how to modify the - // size of the root and user volumes, see Modify a WorkSpace - // (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). + // size of the root and user volumes, see Modify a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) + // . UserVolumeSizeGib *int32 noSmithyDocumentSerde @@ -1141,8 +1098,8 @@ type WorkspaceRequest struct { // This member is required. BundleId *string - // The identifier of the Directory Service directory for the WorkSpace. You can use - // DescribeWorkspaceDirectories to list the available directories. + // The identifier of the Directory Service directory for the WorkSpace. You can + // use DescribeWorkspaceDirectories to list the available directories. // // This member is required. DirectoryId *string diff --git a/service/workspacesweb/api_client.go b/service/workspacesweb/api_client.go index d6488311b0a..9e48316b4ae 100644 --- a/service/workspacesweb/api_client.go +++ b/service/workspacesweb/api_client.go @@ -123,7 +123,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/workspacesweb/api_op_CreateIdentityProvider.go b/service/workspacesweb/api_op_CreateIdentityProvider.go index 8002efad2ca..67e11eb2934 100644 --- a/service/workspacesweb/api_op_CreateIdentityProvider.go +++ b/service/workspacesweb/api_op_CreateIdentityProvider.go @@ -32,72 +32,36 @@ type CreateIdentityProviderInput struct { // The identity provider details. The following list describes the provider detail // keys for each identity provider type. - // - // * For Google and Login with Amazon: - // - // * - // client_id - // - // * client_secret - // - // * authorize_scopes - // - // * For Facebook: - // - // * client_id - // - // * - // client_secret - // - // * authorize_scopes - // - // * api_version - // - // * For Sign in with Apple: - // - // * - // client_id - // - // * team_id - // - // * key_id - // - // * private_key - // - // * authorize_scopes - // - // * For OIDC - // providers: - // - // * client_id - // - // * client_secret - // - // * attributes_request_method - // - // * - // oidc_issuer - // - // * authorize_scopes - // - // * authorize_url if not available from discovery - // URL specified by oidc_issuer key - // - // * token_url if not available from discovery - // URL specified by oidc_issuer key - // - // * attributes_url if not available from - // discovery URL specified by oidc_issuer key - // - // * jwks_uri if not available from - // discovery URL specified by oidc_issuer key - // - // * For SAML providers: - // - // * - // MetadataFile OR MetadataURL - // - // * IDPSignout (boolean) optional + // - For Google and Login with Amazon: + // - client_id + // - client_secret + // - authorize_scopes + // - For Facebook: + // - client_id + // - client_secret + // - authorize_scopes + // - api_version + // - For Sign in with Apple: + // - client_id + // - team_id + // - key_id + // - private_key + // - authorize_scopes + // - For OIDC providers: + // - client_id + // - client_secret + // - attributes_request_method + // - oidc_issuer + // - authorize_scopes + // - authorize_url if not available from discovery URL specified by oidc_issuer + // key + // - token_url if not available from discovery URL specified by oidc_issuer key + // - attributes_url if not available from discovery URL specified by oidc_issuer + // key + // - jwks_uri if not available from discovery URL specified by oidc_issuer key + // - For SAML providers: + // - MetadataFile OR MetadataURL + // - IDPSignout (boolean) optional // // This member is required. IdentityProviderDetails map[string]string diff --git a/service/workspacesweb/api_op_CreatePortal.go b/service/workspacesweb/api_op_CreatePortal.go index 0c50d4dfa66..b4b5d6981a5 100644 --- a/service/workspacesweb/api_op_CreatePortal.go +++ b/service/workspacesweb/api_op_CreatePortal.go @@ -34,7 +34,7 @@ type CreatePortalInput struct { AdditionalEncryptionContext map[string]string // The type of authentication integration points used when signing into the web - // portal. Defaults to Standard. Standard web portals are authenticated directly + // portal. Defaults to Standard . Standard web portals are authenticated directly // through your identity provider. You need to call CreateIdentityProvider to // integrate your identity provider with your web portal. User and group access to // your web portal is controlled through your identity provider. @@ -73,8 +73,8 @@ type CreatePortalOutput struct { // This member is required. PortalArn *string - // The endpoint URL of the web portal that users access in order to start streaming - // sessions. + // The endpoint URL of the web portal that users access in order to start + // streaming sessions. // // This member is required. PortalEndpoint *string diff --git a/service/workspacesweb/api_op_CreateUserSettings.go b/service/workspacesweb/api_op_CreateUserSettings.go index 8ee514a10ba..5ed7c48b3c5 100644 --- a/service/workspacesweb/api_op_CreateUserSettings.go +++ b/service/workspacesweb/api_op_CreateUserSettings.go @@ -32,8 +32,8 @@ func (c *Client) CreateUserSettings(ctx context.Context, params *CreateUserSetti type CreateUserSettingsInput struct { - // Specifies whether the user can copy text from the streaming session to the local - // device. + // Specifies whether the user can copy text from the streaming session to the + // local device. // // This member is required. CopyAllowed types.EnabledType @@ -44,8 +44,8 @@ type CreateUserSettingsInput struct { // This member is required. DownloadAllowed types.EnabledType - // Specifies whether the user can paste text from the local device to the streaming - // session. + // Specifies whether the user can paste text from the local device to the + // streaming session. // // This member is required. PasteAllowed types.EnabledType diff --git a/service/workspacesweb/api_op_ListBrowserSettings.go b/service/workspacesweb/api_op_ListBrowserSettings.go index b2d03be0c28..6973801f25f 100644 --- a/service/workspacesweb/api_op_ListBrowserSettings.go +++ b/service/workspacesweb/api_op_ListBrowserSettings.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListBrowserSettingsMiddlewares(stack *middleware.St return nil } -// ListBrowserSettingsAPIClient is a client that implements the ListBrowserSettings -// operation. +// ListBrowserSettingsAPIClient is a client that implements the +// ListBrowserSettings operation. type ListBrowserSettingsAPIClient interface { ListBrowserSettings(context.Context, *ListBrowserSettingsInput, ...func(*Options)) (*ListBrowserSettingsOutput, error) } diff --git a/service/workspacesweb/api_op_ListNetworkSettings.go b/service/workspacesweb/api_op_ListNetworkSettings.go index d017db33f1d..37fd5659905 100644 --- a/service/workspacesweb/api_op_ListNetworkSettings.go +++ b/service/workspacesweb/api_op_ListNetworkSettings.go @@ -115,8 +115,8 @@ func (c *Client) addOperationListNetworkSettingsMiddlewares(stack *middleware.St return nil } -// ListNetworkSettingsAPIClient is a client that implements the ListNetworkSettings -// operation. +// ListNetworkSettingsAPIClient is a client that implements the +// ListNetworkSettings operation. type ListNetworkSettingsAPIClient interface { ListNetworkSettings(context.Context, *ListNetworkSettingsInput, ...func(*Options)) (*ListNetworkSettingsOutput, error) } diff --git a/service/workspacesweb/api_op_UpdateIdentityProvider.go b/service/workspacesweb/api_op_UpdateIdentityProvider.go index 50f23e7cca6..a56aaf4cc71 100644 --- a/service/workspacesweb/api_op_UpdateIdentityProvider.go +++ b/service/workspacesweb/api_op_UpdateIdentityProvider.go @@ -45,72 +45,36 @@ type UpdateIdentityProviderInput struct { // The details of the identity provider. The following list describes the provider // detail keys for each identity provider type. - // - // * For Google and Login with - // Amazon: - // - // * client_id - // - // * client_secret - // - // * authorize_scopes - // - // * For Facebook: - // - // * - // client_id - // - // * client_secret - // - // * authorize_scopes - // - // * api_version - // - // * For Sign in - // with Apple: - // - // * client_id - // - // * team_id - // - // * key_id - // - // * private_key - // - // * - // authorize_scopes - // - // * For OIDC providers: - // - // * client_id - // - // * client_secret - // - // * - // attributes_request_method - // - // * oidc_issuer - // - // * authorize_scopes - // - // * authorize_url if - // not available from discovery URL specified by oidc_issuer key - // - // * token_url if - // not available from discovery URL specified by oidc_issuer key - // - // * attributes_url - // if not available from discovery URL specified by oidc_issuer key - // - // * jwks_uri if - // not available from discovery URL specified by oidc_issuer key - // - // * For SAML - // providers: - // - // * MetadataFile OR MetadataURL - // - // * IDPSignout (boolean) optional + // - For Google and Login with Amazon: + // - client_id + // - client_secret + // - authorize_scopes + // - For Facebook: + // - client_id + // - client_secret + // - authorize_scopes + // - api_version + // - For Sign in with Apple: + // - client_id + // - team_id + // - key_id + // - private_key + // - authorize_scopes + // - For OIDC providers: + // - client_id + // - client_secret + // - attributes_request_method + // - oidc_issuer + // - authorize_scopes + // - authorize_url if not available from discovery URL specified by oidc_issuer + // key + // - token_url if not available from discovery URL specified by oidc_issuer key + // - attributes_url if not available from discovery URL specified by oidc_issuer + // key + // - jwks_uri if not available from discovery URL specified by oidc_issuer key + // - For SAML providers: + // - MetadataFile OR MetadataURL + // - IDPSignout (boolean) optional IdentityProviderDetails map[string]string // The name of the identity provider. diff --git a/service/workspacesweb/api_op_UpdatePortal.go b/service/workspacesweb/api_op_UpdatePortal.go index 4c75b2a4e0b..b60f8c7aada 100644 --- a/service/workspacesweb/api_op_UpdatePortal.go +++ b/service/workspacesweb/api_op_UpdatePortal.go @@ -35,7 +35,7 @@ type UpdatePortalInput struct { PortalArn *string // The type of authentication integration points used when signing into the web - // portal. Defaults to Standard. Standard web portals are authenticated directly + // portal. Defaults to Standard . Standard web portals are authenticated directly // through your identity provider. You need to call CreateIdentityProvider to // integrate your identity provider with your web portal. User and group access to // your web portal is controlled through your identity provider. diff --git a/service/workspacesweb/api_op_UpdateUserSettings.go b/service/workspacesweb/api_op_UpdateUserSettings.go index 86d044dffa1..940f847841f 100644 --- a/service/workspacesweb/api_op_UpdateUserSettings.go +++ b/service/workspacesweb/api_op_UpdateUserSettings.go @@ -43,8 +43,8 @@ type UpdateUserSettingsInput struct { // automatically generated by the AWS SDK. ClientToken *string - // Specifies whether the user can copy text from the streaming session to the local - // device. + // Specifies whether the user can copy text from the streaming session to the + // local device. CopyAllowed types.EnabledType // The amount of time that a streaming session remains active after users @@ -60,8 +60,8 @@ type UpdateUserSettingsInput struct { // begins. IdleDisconnectTimeoutInMinutes *int32 - // Specifies whether the user can paste text from the local device to the streaming - // session. + // Specifies whether the user can paste text from the local device to the + // streaming session. PasteAllowed types.EnabledType // Specifies whether the user can print to the local device. diff --git a/service/workspacesweb/types/enums.go b/service/workspacesweb/types/enums.go index 375e6eac1cd..6f37fa50bc6 100644 --- a/service/workspacesweb/types/enums.go +++ b/service/workspacesweb/types/enums.go @@ -89,9 +89,9 @@ const ( PortalStatusActive PortalStatus = "Active" ) -// Values returns all known values for PortalStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for PortalStatus. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (PortalStatus) Values() []PortalStatus { return []PortalStatus{ "Incomplete", @@ -107,9 +107,9 @@ const ( RendererTypeAppstream RendererType = "AppStream" ) -// Values returns all known values for RendererType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for RendererType. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (RendererType) Values() []RendererType { return []RendererType{ "AppStream", diff --git a/service/workspacesweb/types/types.go b/service/workspacesweb/types/types.go index 8c839b0c713..e1d0808fcb3 100644 --- a/service/workspacesweb/types/types.go +++ b/service/workspacesweb/types/types.go @@ -91,72 +91,36 @@ type IdentityProvider struct { // The identity provider details. The following list describes the provider detail // keys for each identity provider type. - // - // * For Google and Login with Amazon: - // - // * - // client_id - // - // * client_secret - // - // * authorize_scopes - // - // * For Facebook: - // - // * client_id - // - // * - // client_secret - // - // * authorize_scopes - // - // * api_version - // - // * For Sign in with Apple: - // - // * - // client_id - // - // * team_id - // - // * key_id - // - // * private_key - // - // * authorize_scopes - // - // * For OIDC - // providers: - // - // * client_id - // - // * client_secret - // - // * attributes_request_method - // - // * - // oidc_issuer - // - // * authorize_scopes - // - // * authorize_url if not available from discovery - // URL specified by oidc_issuer key - // - // * token_url if not available from discovery - // URL specified by oidc_issuer key - // - // * attributes_url if not available from - // discovery URL specified by oidc_issuer key - // - // * jwks_uri if not available from - // discovery URL specified by oidc_issuer key - // - // * For SAML providers: - // - // * - // MetadataFile OR MetadataURL - // - // * IDPSignout optional + // - For Google and Login with Amazon: + // - client_id + // - client_secret + // - authorize_scopes + // - For Facebook: + // - client_id + // - client_secret + // - authorize_scopes + // - api_version + // - For Sign in with Apple: + // - client_id + // - team_id + // - key_id + // - private_key + // - authorize_scopes + // - For OIDC providers: + // - client_id + // - client_secret + // - attributes_request_method + // - oidc_issuer + // - authorize_scopes + // - authorize_url if not available from discovery URL specified by oidc_issuer + // key + // - token_url if not available from discovery URL specified by oidc_issuer key + // - attributes_url if not available from discovery URL specified by oidc_issuer + // key + // - jwks_uri if not available from discovery URL specified by oidc_issuer key + // - For SAML providers: + // - MetadataFile OR MetadataURL + // - IDPSignout optional IdentityProviderDetails map[string]string // The identity provider name. @@ -227,7 +191,7 @@ type NetworkSettingsSummary struct { type Portal struct { // The type of authentication integration points used when signing into the web - // portal. Defaults to Standard. Standard web portals are authenticated directly + // portal. Defaults to Standard . Standard web portals are authenticated directly // through your identity provider. You need to call CreateIdentityProvider to // integrate your identity provider with your web portal. User and group access to // your web portal is controlled through your identity provider. @@ -256,8 +220,8 @@ type Portal struct { // The ARN of the web portal. PortalArn *string - // The endpoint URL of the web portal that users access in order to start streaming - // sessions. + // The endpoint URL of the web portal that users access in order to start + // streaming sessions. PortalEndpoint *string // The status of the web portal. @@ -286,7 +250,7 @@ type Portal struct { type PortalSummary struct { // The type of authentication integration points used when signing into the web - // portal. Defaults to Standard. Standard web portals are authenticated directly + // portal. Defaults to Standard . Standard web portals are authenticated directly // through your identity provider. You need to call CreateIdentityProvider to // integrate your identity provider with your web portal. User and group access to // your web portal is controlled through your identity provider. @@ -315,8 +279,8 @@ type PortalSummary struct { // The ARN of the web portal. PortalArn *string - // The endpoint URL of the web portal that users access in order to start streaming - // sessions. + // The endpoint URL of the web portal that users access in order to start + // streaming sessions. PortalEndpoint *string // The status of the web portal. @@ -424,8 +388,8 @@ type UserSettings struct { // A list of web portal ARNs that this user settings is associated with. AssociatedPortalArns []string - // Specifies whether the user can copy text from the streaming session to the local - // device. + // Specifies whether the user can copy text from the streaming session to the + // local device. CopyAllowed EnabledType // The amount of time that a streaming session remains active after users @@ -441,8 +405,8 @@ type UserSettings struct { // begins. IdleDisconnectTimeoutInMinutes *int32 - // Specifies whether the user can paste text from the local device to the streaming - // session. + // Specifies whether the user can paste text from the local device to the + // streaming session. PasteAllowed EnabledType // Specifies whether the user can print to the local device. @@ -458,8 +422,8 @@ type UserSettings struct { // The summary of user settings. type UserSettingsSummary struct { - // Specifies whether the user can copy text from the streaming session to the local - // device. + // Specifies whether the user can copy text from the streaming session to the + // local device. CopyAllowed EnabledType // The amount of time that a streaming session remains active after users @@ -475,8 +439,8 @@ type UserSettingsSummary struct { // begins. IdleDisconnectTimeoutInMinutes *int32 - // Specifies whether the user can paste text from the local device to the streaming - // session. + // Specifies whether the user can paste text from the local device to the + // streaming session. PasteAllowed EnabledType // Specifies whether the user can print to the local device. diff --git a/service/xray/api_client.go b/service/xray/api_client.go index d2ab0e7edd8..e7bf65050fe 100644 --- a/service/xray/api_client.go +++ b/service/xray/api_client.go @@ -114,7 +114,7 @@ type Options struct { Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set - // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You + // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment diff --git a/service/xray/api_op_CreateGroup.go b/service/xray/api_op_CreateGroup.go index 5621ea1be26..89930cd2314 100644 --- a/service/xray/api_op_CreateGroup.go +++ b/service/xray/api_op_CreateGroup.go @@ -39,38 +39,26 @@ type CreateGroupInput struct { FilterExpression *string // The structure containing configurations related to insights. - // - // * The - // InsightsEnabled boolean can be set to true to enable insights for the new group - // or false to disable insights for the new group. - // - // * The NotificationsEnabled - // boolean can be set to true to enable insights notifications for the new group. - // Notifications may only be enabled on a group with InsightsEnabled set to true. + // - The InsightsEnabled boolean can be set to true to enable insights for the + // new group or false to disable insights for the new group. + // - The NotificationsEnabled boolean can be set to true to enable insights + // notifications for the new group. Notifications may only be enabled on a group + // with InsightsEnabled set to true. InsightsConfiguration *types.InsightsConfiguration // A map that contains one or more tag keys and tag values to attach to an X-Ray // group. For more information about ways to use tags, see Tagging Amazon Web - // Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. The following restrictions apply to tags: - // - // * - // Maximum number of user-applied tags per resource: 50 - // - // * Maximum tag key length: - // 128 Unicode characters - // - // * Maximum tag value length: 256 Unicode characters - // - // * - // Valid values for key and value: a-z, A-Z, 0-9, space, and the following - // characters: _ . : / = + - and @ - // - // * Tag keys and values are case sensitive. - // - // * - // Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. + // Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. The following restrictions apply + // to tags: + // - Maximum number of user-applied tags per resource: 50 + // - Maximum tag key length: 128 Unicode characters + // - Maximum tag value length: 256 Unicode characters + // - Valid values for key and value: a-z, A-Z, 0-9, space, and the following + // characters: _ . : / = + - and @ + // - Tag keys and values are case sensitive. + // - Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services + // use. Tags []types.Tag noSmithyDocumentSerde @@ -78,10 +66,10 @@ type CreateGroupInput struct { type CreateGroupOutput struct { - // The group that was created. Contains the name of the group that was created, the - // Amazon Resource Name (ARN) of the group that was generated based on the group - // name, the filter expression, and the insight configuration that was assigned to - // the group. + // The group that was created. Contains the name of the group that was created, + // the Amazon Resource Name (ARN) of the group that was generated based on the + // group name, the filter expression, and the insight configuration that was + // assigned to the group. Group *types.Group // Metadata pertaining to the operation's result. diff --git a/service/xray/api_op_CreateSamplingRule.go b/service/xray/api_op_CreateSamplingRule.go index be0c89eb154..24ad8d6859a 100644 --- a/service/xray/api_op_CreateSamplingRule.go +++ b/service/xray/api_op_CreateSamplingRule.go @@ -12,14 +12,12 @@ import ( ) // Creates a rule to control sampling behavior for instrumented applications. -// Services retrieve rules with GetSamplingRules -// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html), and -// evaluate each rule in ascending order of priority for each request. If a rule -// matches, the service records a trace, borrowing it from the reservoir size. -// After 10 seconds, the service reports back to X-Ray with GetSamplingTargets -// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) to get -// updated versions of each in-use rule. The updated rule contains a trace quota -// that the service can use instead of borrowing from the reservoir. +// Services retrieve rules with GetSamplingRules (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html) +// , and evaluate each rule in ascending order of priority for each request. If a +// rule matches, the service records a trace, borrowing it from the reservoir size. +// After 10 seconds, the service reports back to X-Ray with GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) +// to get updated versions of each in-use rule. The updated rule contains a trace +// quota that the service can use instead of borrowing from the reservoir. func (c *Client) CreateSamplingRule(ctx context.Context, params *CreateSamplingRuleInput, optFns ...func(*Options)) (*CreateSamplingRuleOutput, error) { if params == nil { params = &CreateSamplingRuleInput{} @@ -44,26 +42,17 @@ type CreateSamplingRuleInput struct { // A map that contains one or more tag keys and tag values to attach to an X-Ray // sampling rule. For more information about ways to use tags, see Tagging Amazon - // Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. The following restrictions apply to tags: - // - // * - // Maximum number of user-applied tags per resource: 50 - // - // * Maximum tag key length: - // 128 Unicode characters - // - // * Maximum tag value length: 256 Unicode characters - // - // * - // Valid values for key and value: a-z, A-Z, 0-9, space, and the following - // characters: _ . : / = + - and @ - // - // * Tag keys and values are case sensitive. - // - // * - // Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. + // Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. The following restrictions apply + // to tags: + // - Maximum number of user-applied tags per resource: 50 + // - Maximum tag key length: 128 Unicode characters + // - Maximum tag value length: 256 Unicode characters + // - Valid values for key and value: a-z, A-Z, 0-9, space, and the following + // characters: _ . : / = + - and @ + // - Tag keys and values are case sensitive. + // - Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services + // use. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/xray/api_op_GetInsight.go b/service/xray/api_op_GetInsight.go index 70c2ee92ceb..d0b4735593a 100644 --- a/service/xray/api_op_GetInsight.go +++ b/service/xray/api_op_GetInsight.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the summary information of an insight. This includes impact to clients -// and root cause services, the top anomalous services, the category, the state of -// the insight, and the start and end time of the insight. +// Retrieves the summary information of an insight. This includes impact to +// clients and root cause services, the top anomalous services, the category, the +// state of the insight, and the start and end time of the insight. func (c *Client) GetInsight(ctx context.Context, params *GetInsightInput, optFns ...func(*Options)) (*GetInsightOutput, error) { if params == nil { params = &GetInsightInput{} diff --git a/service/xray/api_op_GetInsightEvents.go b/service/xray/api_op_GetInsightEvents.go index 089dea3c7de..0fbfcce7b34 100644 --- a/service/xray/api_op_GetInsightEvents.go +++ b/service/xray/api_op_GetInsightEvents.go @@ -12,9 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// X-Ray reevaluates insights periodically until they're resolved, and records each -// intermediate state as an event. You can review an insight's events in the Impact -// Timeline on the Inspect page in the X-Ray console. +// X-Ray reevaluates insights periodically until they're resolved, and records +// each intermediate state as an event. You can review an insight's events in the +// Impact Timeline on the Inspect page in the X-Ray console. func (c *Client) GetInsightEvents(ctx context.Context, params *GetInsightEventsInput, optFns ...func(*Options)) (*GetInsightEventsOutput, error) { if params == nil { params = &GetInsightEventsInput{} @@ -41,8 +41,8 @@ type GetInsightEventsInput struct { // Used to retrieve at most the specified value of events. MaxResults *int32 - // Specify the pagination token returned by a previous request to retrieve the next - // page of events. + // Specify the pagination token returned by a previous request to retrieve the + // next page of events. NextToken *string noSmithyDocumentSerde @@ -50,9 +50,9 @@ type GetInsightEventsInput struct { type GetInsightEventsOutput struct { - // A detailed description of the event. This includes the time of the event, client - // and root cause impact statistics, and the top anomalous service at the time of - // the event. + // A detailed description of the event. This includes the time of the event, + // client and root cause impact statistics, and the top anomalous service at the + // time of the event. InsightEvents []types.InsightEvent // Use this token to retrieve the next page of insight events. diff --git a/service/xray/api_op_GetInsightImpactGraph.go b/service/xray/api_op_GetInsightImpactGraph.go index b85bd2bb6d8..99b06f8bd3e 100644 --- a/service/xray/api_op_GetInsightImpactGraph.go +++ b/service/xray/api_op_GetInsightImpactGraph.go @@ -51,8 +51,8 @@ type GetInsightImpactGraphInput struct { // This member is required. StartTime *time.Time - // Specify the pagination token returned by a previous request to retrieve the next - // page of results. + // Specify the pagination token returned by a previous request to retrieve the + // next page of results. NextToken *string noSmithyDocumentSerde diff --git a/service/xray/api_op_GetInsightSummaries.go b/service/xray/api_op_GetInsightSummaries.go index 28953f5614a..de97c2ddfa9 100644 --- a/service/xray/api_op_GetInsightSummaries.go +++ b/service/xray/api_op_GetInsightSummaries.go @@ -143,8 +143,8 @@ func (c *Client) addOperationGetInsightSummariesMiddlewares(stack *middleware.St return nil } -// GetInsightSummariesAPIClient is a client that implements the GetInsightSummaries -// operation. +// GetInsightSummariesAPIClient is a client that implements the +// GetInsightSummaries operation. type GetInsightSummariesAPIClient interface { GetInsightSummaries(context.Context, *GetInsightSummariesInput, ...func(*Options)) (*GetInsightSummariesOutput, error) } diff --git a/service/xray/api_op_GetSamplingTargets.go b/service/xray/api_op_GetSamplingTargets.go index a29dd7414ef..08e7a481e5f 100644 --- a/service/xray/api_op_GetSamplingTargets.go +++ b/service/xray/api_op_GetSamplingTargets.go @@ -43,16 +43,14 @@ type GetSamplingTargetsOutput struct { // The last time a user changed the sampling rule configuration. If the sampling // rule configuration changed since the service last retrieved it, the service - // should call GetSamplingRules - // (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html) to get - // the latest version. + // should call GetSamplingRules (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html) + // to get the latest version. LastRuleModification *time.Time // Updated rules that the service should use to sample requests. SamplingTargetDocuments []types.SamplingTargetDocument - // Information about SamplingStatisticsDocument - // (https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html) + // Information about SamplingStatisticsDocument (https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html) // that X-Ray could not process. UnprocessedStatistics []types.UnprocessedStatistics diff --git a/service/xray/api_op_GetServiceGraph.go b/service/xray/api_op_GetServiceGraph.go index ce0344d5124..cfc4ca22b9b 100644 --- a/service/xray/api_op_GetServiceGraph.go +++ b/service/xray/api_op_GetServiceGraph.go @@ -13,12 +13,12 @@ import ( "time" ) -// Retrieves a document that describes services that process incoming requests, and -// downstream services that they call as a result. Root services process incoming -// requests and make calls to downstream services. Root services are applications -// that use the Amazon Web Services X-Ray SDK -// (https://docs.aws.amazon.com/xray/index.html). Downstream services can be other -// applications, Amazon Web Services resources, HTTP web APIs, or SQL databases. +// Retrieves a document that describes services that process incoming requests, +// and downstream services that they call as a result. Root services process +// incoming requests and make calls to downstream services. Root services are +// applications that use the Amazon Web Services X-Ray SDK (https://docs.aws.amazon.com/xray/index.html) +// . Downstream services can be other applications, Amazon Web Services resources, +// HTTP web APIs, or SQL databases. func (c *Client) GetServiceGraph(ctx context.Context, params *GetServiceGraphInput, optFns ...func(*Options)) (*GetServiceGraphOutput, error) { if params == nil { params = &GetServiceGraphInput{} diff --git a/service/xray/api_op_GetTraceSummaries.go b/service/xray/api_op_GetTraceSummaries.go index 2e2d05965c2..3f5e12955bb 100644 --- a/service/xray/api_op_GetTraceSummaries.go +++ b/service/xray/api_op_GetTraceSummaries.go @@ -15,15 +15,14 @@ import ( // Retrieves IDs and annotations for traces available for a specified time frame // using an optional filter. To get the full traces, pass the trace IDs to -// BatchGetTraces. A filter expression can target traced requests that hit specific -// service nodes or edges, have errors, or come from a known user. For example, the -// following filter expression targets traces that pass through api.example.com: -// service("api.example.com") This filter expression finds traces that have an -// annotation named account with the value 12345: annotation.account = "12345" For -// a full list of indexed fields and keywords that you can use in filter -// expressions, see Using Filter Expressions -// (https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html) in -// the Amazon Web Services X-Ray Developer Guide. +// BatchGetTraces . A filter expression can target traced requests that hit +// specific service nodes or edges, have errors, or come from a known user. For +// example, the following filter expression targets traces that pass through +// api.example.com : service("api.example.com") This filter expression finds +// traces that have an annotation named account with the value 12345 : +// annotation.account = "12345" For a full list of indexed fields and keywords that +// you can use in filter expressions, see Using Filter Expressions (https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html) +// in the Amazon Web Services X-Ray Developer Guide. func (c *Client) GetTraceSummaries(ctx context.Context, params *GetTraceSummariesInput, optFns ...func(*Options)) (*GetTraceSummariesOutput, error) { if params == nil { params = &GetTraceSummariesInput{} @@ -51,12 +50,12 @@ type GetTraceSummariesInput struct { // This member is required. StartTime *time.Time - // Specify a filter expression to retrieve trace summaries for services or requests - // that meet certain requirements. + // Specify a filter expression to retrieve trace summaries for services or + // requests that meet certain requirements. FilterExpression *string - // Specify the pagination token returned by a previous request to retrieve the next - // page of results. + // Specify the pagination token returned by a previous request to retrieve the + // next page of results. NextToken *string // Set to true to get summaries for only a subset of available traces. @@ -78,9 +77,9 @@ type GetTraceSummariesOutput struct { // The start time of this page of results. ApproximateTime *time.Time - // If the requested time frame contained more than one page of results, you can use - // this token to retrieve the next page. The first page contains the most recent - // results, closest to the end of the time frame. + // If the requested time frame contained more than one page of results, you can + // use this token to retrieve the next page. The first page contains the most + // recent results, closest to the end of the time frame. NextToken *string // Trace IDs and annotations for traces that were found in the specified time diff --git a/service/xray/api_op_ListTagsForResource.go b/service/xray/api_op_ListTagsForResource.go index f6d8bca184a..3a9becbc620 100644 --- a/service/xray/api_op_ListTagsForResource.go +++ b/service/xray/api_op_ListTagsForResource.go @@ -123,8 +123,8 @@ func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.St return nil } -// ListTagsForResourceAPIClient is a client that implements the ListTagsForResource -// operation. +// ListTagsForResourceAPIClient is a client that implements the +// ListTagsForResource operation. type ListTagsForResourceAPIClient interface { ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error) } diff --git a/service/xray/api_op_PutEncryptionConfig.go b/service/xray/api_op_PutEncryptionConfig.go index a86897eb229..fab75769269 100644 --- a/service/xray/api_op_PutEncryptionConfig.go +++ b/service/xray/api_op_PutEncryptionConfig.go @@ -36,21 +36,14 @@ type PutEncryptionConfigInput struct { Type types.EncryptionType // An Amazon Web Services KMS key in one of the following formats: - // - // * Alias - The - // name of the key. For example, alias/MyKey. - // - // * Key ID - The KMS key ID of the - // key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services - // X-Ray does not support asymmetric KMS keys. - // - // * ARN - The full Amazon Resource - // Name of the key ID or alias. For example, - // arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. - // Use this format to specify a key in a different account. - // - // Omit this key if you - // set Type to NONE. + // - Alias - The name of the key. For example, alias/MyKey . + // - Key ID - The KMS key ID of the key. For example, + // ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . Amazon Web Services X-Ray does not + // support asymmetric KMS keys. + // - ARN - The full Amazon Resource Name of the key ID or alias. For example, + // arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456 . + // Use this format to specify a key in a different account. + // Omit this key if you set Type to NONE . KeyId *string noSmithyDocumentSerde diff --git a/service/xray/api_op_PutResourcePolicy.go b/service/xray/api_op_PutResourcePolicy.go index 7bd73572acb..bd3225f278f 100644 --- a/service/xray/api_op_PutResourcePolicy.go +++ b/service/xray/api_op_PutResourcePolicy.go @@ -57,9 +57,9 @@ type PutResourcePolicyInput struct { // incremented revision id. The revision id is unique to each policy in the // account. If the policy revision id does not match the latest revision id, the // operation will fail with an InvalidPolicyRevisionIdException exception. You can - // also provide a PolicyRevisionId of 0. In this case, the operation will fail with - // an InvalidPolicyRevisionIdException exception if a resource policy with the same - // name already exists. + // also provide a PolicyRevisionId of 0. In this case, the operation will fail + // with an InvalidPolicyRevisionIdException exception if a resource policy with + // the same name already exists. PolicyRevisionId *string noSmithyDocumentSerde @@ -67,7 +67,7 @@ type PutResourcePolicyInput struct { type PutResourcePolicyOutput struct { - // The resource policy document, as provided in the PutResourcePolicyRequest. + // The resource policy document, as provided in the PutResourcePolicyRequest . ResourcePolicy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/xray/api_op_PutTraceSegments.go b/service/xray/api_op_PutTraceSegments.go index 95d0f818b1f..2b63e2dff92 100644 --- a/service/xray/api_op_PutTraceSegments.go +++ b/service/xray/api_op_PutTraceSegments.go @@ -11,53 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK -// (https://docs.aws.amazon.com/xray/index.html) generates segment documents and -// sends them to the X-Ray daemon, which uploads them in batches. A segment -// document can be a completed segment, an in-progress segment, or an array of -// subsegments. Segments must include the following fields. For the full segment -// document schema, see Amazon Web Services X-Ray Segment Documents -// (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) +// Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK (https://docs.aws.amazon.com/xray/index.html) +// generates segment documents and sends them to the X-Ray daemon, which uploads +// them in batches. A segment document can be a completed segment, an in-progress +// segment, or an array of subsegments. Segments must include the following fields. +// For the full segment document schema, see Amazon Web Services X-Ray Segment +// Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) // in the Amazon Web Services X-Ray Developer Guide. Required segment document // fields +// - name - The name of the service that handled the request. +// - id - A 64-bit identifier for the segment, unique among segments in the same +// trace, in 16 hexadecimal digits. +// - trace_id - A unique identifier that connects all segments and subsegments +// originating from a single client request. +// - start_time - Time the segment or subsegment was created, in floating point +// seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 +// or 1.480615200010E9 . +// - end_time - Time the segment or subsegment was closed. For example, +// 1480615200.090 or 1.480615200090E9 . Specify either an end_time or in_progress +// . +// - in_progress - Set to true instead of specifying an end_time to record that a +// segment has been started, but is not complete. Send an in-progress segment when +// your application receives a request that will take a long time to serve, to +// trace that the request was received. When the response is sent, send the +// complete segment to overwrite the in-progress segment. // -// * name - The name of the service that handled the request. -// -// * id - A -// 64-bit identifier for the segment, unique among segments in the same trace, in -// 16 hexadecimal digits. -// -// * trace_id - A unique identifier that connects all -// segments and subsegments originating from a single client request. -// -// * start_time -// - Time the segment or subsegment was created, in floating point seconds in epoch -// time, accurate to milliseconds. For example, 1480615200.010 or -// 1.480615200010E9. -// -// * end_time - Time the segment or subsegment was closed. For -// example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or -// in_progress. -// -// * in_progress - Set to true instead of specifying an end_time to -// record that a segment has been started, but is not complete. Send an in-progress -// segment when your application receives a request that will take a long time to -// serve, to trace that the request was received. When the response is sent, send -// the complete segment to overwrite the in-progress segment. -// -// A trace_id consists -// of three numbers separated by hyphens. For example, +// A trace_id consists of three numbers separated by hyphens. For example, // 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format -// -// * The -// version number, for instance, 1. -// -// * The time of the original request, in Unix -// epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST -// in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. -// -// * A 96-bit -// identifier for the trace, globally unique, in 24 hexadecimal digits. +// - The version number, for instance, 1 . +// - The time of the original request, in Unix epoch time, in 8 hexadecimal +// digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is +// 1480615200 seconds, or 58406520 in hexadecimal. +// - A 96-bit identifier for the trace, globally unique, in 24 hexadecimal +// digits. func (c *Client) PutTraceSegments(ctx context.Context, params *PutTraceSegmentsInput, optFns ...func(*Options)) (*PutTraceSegmentsOutput, error) { if params == nil { params = &PutTraceSegmentsInput{} diff --git a/service/xray/api_op_TagResource.go b/service/xray/api_op_TagResource.go index 9d0534a1c4e..6a8996719fc 100644 --- a/service/xray/api_op_TagResource.go +++ b/service/xray/api_op_TagResource.go @@ -35,28 +35,18 @@ type TagResourceInput struct { ResourceARN *string // A map that contains one or more tag keys and tag values to attach to an X-Ray - // group or sampling rule. For more information about ways to use tags, see Tagging - // Amazon Web Services resources - // (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon - // Web Services General Reference. The following restrictions apply to tags: - // - // * - // Maximum number of user-applied tags per resource: 50 - // - // * Maximum tag key length: - // 128 Unicode characters - // - // * Maximum tag value length: 256 Unicode characters - // - // * - // Valid values for key and value: a-z, A-Z, 0-9, space, and the following - // characters: _ . : / = + - and @ - // - // * Tag keys and values are case sensitive. - // - // * - // Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. - // You cannot edit or delete system tags. + // group or sampling rule. For more information about ways to use tags, see + // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // in the Amazon Web Services General Reference. The following restrictions apply + // to tags: + // - Maximum number of user-applied tags per resource: 50 + // - Maximum tag key length: 128 Unicode characters + // - Maximum tag value length: 256 Unicode characters + // - Valid values for key and value: a-z, A-Z, 0-9, space, and the following + // characters: _ . : / = + - and @ + // - Tag keys and values are case sensitive. + // - Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services + // use. You cannot edit or delete system tags. // // This member is required. Tags []types.Tag diff --git a/service/xray/api_op_UpdateGroup.go b/service/xray/api_op_UpdateGroup.go index 2fd90e7d5a6..4b274b1af1e 100644 --- a/service/xray/api_op_UpdateGroup.go +++ b/service/xray/api_op_UpdateGroup.go @@ -39,14 +39,11 @@ type UpdateGroupInput struct { GroupName *string // The structure containing configurations related to insights. - // - // * The - // InsightsEnabled boolean can be set to true to enable insights for the group or - // false to disable insights for the group. - // - // * The NotificationsEnabled boolean can - // be set to true to enable insights notifications for the group. Notifications can - // only be enabled on a group with InsightsEnabled set to true. + // - The InsightsEnabled boolean can be set to true to enable insights for the + // group or false to disable insights for the group. + // - The NotificationsEnabled boolean can be set to true to enable insights + // notifications for the group. Notifications can only be enabled on a group with + // InsightsEnabled set to true. InsightsConfiguration *types.InsightsConfiguration noSmithyDocumentSerde @@ -54,8 +51,8 @@ type UpdateGroupInput struct { type UpdateGroupOutput struct { - // The group that was updated. Contains the name of the group that was updated, the - // ARN of the group that was updated, the updated filter expression, and the + // The group that was updated. Contains the name of the group that was updated, + // the ARN of the group that was updated, the updated filter expression, and the // updated insight configuration assigned to the group. Group *types.Group diff --git a/service/xray/doc.go b/service/xray/doc.go index 6c2b947c231..6cb417ba4f4 100644 --- a/service/xray/doc.go +++ b/service/xray/doc.go @@ -3,6 +3,6 @@ // Package xray provides the API client, operations, and parameter types for AWS // X-Ray. // -// Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving -// service maps and other data created by processing those traces. +// Amazon Web Services X-Ray provides APIs for managing debug traces and +// retrieving service maps and other data created by processing those traces. package xray diff --git a/service/xray/types/enums.go b/service/xray/types/enums.go index e5a97ebbddd..9c63dcce815 100644 --- a/service/xray/types/enums.go +++ b/service/xray/types/enums.go @@ -62,9 +62,9 @@ const ( InsightStateClosed InsightState = "CLOSED" ) -// Values returns all known values for InsightState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// Values returns all known values for InsightState. Note that this can be +// expanded in the future, and so it is only as up to date as the client. The +// ordering of this slice is not guaranteed to be stable across updates. func (InsightState) Values() []InsightState { return []InsightState{ "ACTIVE", diff --git a/service/xray/types/types.go b/service/xray/types/types.go index d1b3971751d..c478fb8009e 100644 --- a/service/xray/types/types.go +++ b/service/xray/types/types.go @@ -22,8 +22,8 @@ type Alias struct { noSmithyDocumentSerde } -// Value of a segment annotation. Has one of three value types: Number, Boolean, or -// String. +// Value of a segment annotation. Has one of three value types: Number, Boolean, +// or String. // // The following types satisfy this interface: // @@ -111,14 +111,15 @@ type Edge struct { // Aliases for the edge. Aliases []Alias - // Describes an asynchronous connection, with a value of link. + // Describes an asynchronous connection, with a value of link . EdgeType *string // The end time of the last segment on the edge. EndTime *time.Time - // A histogram that maps the spread of event age when received by consumers. Age is - // calculated each time an event is received. Only populated when EdgeType is link. + // A histogram that maps the spread of event age when received by consumers. Age + // is calculated each time an event is received. Only populated when EdgeType is + // link . ReceivedEventAgeHistogram []HistogramEntry // Identifier of the edge. Unique within a service map. @@ -164,12 +165,12 @@ type EncryptionConfig struct { // The ID of the KMS key used for encryption, if applicable. KeyId *string - // The encryption status. While the status is UPDATING, X-Ray may encrypt data with - // a combination of the new and old settings. + // The encryption status. While the status is UPDATING , X-Ray may encrypt data + // with a combination of the new and old settings. Status EncryptionStatus - // The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for - // default encryption. + // The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE + // for default encryption. Type EncryptionType noSmithyDocumentSerde @@ -181,8 +182,8 @@ type ErrorRootCause struct { // A flag that denotes that the root cause impacts the trace client. ClientImpacting *bool - // A list of services corresponding to an error. A service identifies a segment and - // it contains a name, account ID, type, and inferred flag. + // A list of services corresponding to an error. A service identifies a segment + // and it contains a name, account ID, type, and inferred flag. Services []ErrorRootCauseService noSmithyDocumentSerde @@ -249,8 +250,8 @@ type FaultRootCause struct { // A flag that denotes that the root cause impacts the trace client. ClientImpacting *bool - // A list of corresponding services. A service identifies a segment and it contains - // a name, account ID, type, and inferred flag. + // A list of corresponding services. A service identifies a segment and it + // contains a name, account ID, type, and inferred flag. Services []FaultRootCauseService noSmithyDocumentSerde @@ -334,14 +335,10 @@ type Group struct { GroupName *string // The structure containing configurations related to insights. - // - // * The - // InsightsEnabled boolean can be set to true to enable insights for the group or - // false to disable insights for the group. - // - // * The NotificationsEnabled boolean can - // be set to true to enable insights notifications through Amazon EventBridge for - // the group. + // - The InsightsEnabled boolean can be set to true to enable insights for the + // group or false to disable insights for the group. + // - The NotificationsEnabled boolean can be set to true to enable insights + // notifications through Amazon EventBridge for the group. InsightsConfiguration *InsightsConfiguration noSmithyDocumentSerde @@ -360,14 +357,11 @@ type GroupSummary struct { GroupName *string // The structure containing configurations related to insights. - // - // * The - // InsightsEnabled boolean can be set to true to enable insights for the group or - // false to disable insights for the group. - // - // * The NotificationsEnabled boolean can - // be set to true to enable insights notifications. Notifications can only be - // enabled on a group with InsightsEnabled set to true. + // - The InsightsEnabled boolean can be set to true to enable insights for the + // group or false to disable insights for the group. + // - The NotificationsEnabled boolean can be set to true to enable insights + // notifications. Notifications can only be enabled on a group with InsightsEnabled + // set to true. InsightsConfiguration *InsightsConfiguration noSmithyDocumentSerde @@ -507,23 +501,16 @@ type InsightImpactGraphService struct { ReferenceId *int32 // Identifier for the service. Unique within the service map. - // - // * Amazon Web - // Services Resource - The type of an Amazon Web Services resource. For example, - // AWS::EC2::Instance for an application running on Amazon EC2 or - // AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. - // - // * - // Amazon Web Services Service - The type of an Amazon Web Services service. For - // example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't - // target a specific table. - // - // * Amazon Web Services Service - The type of an Amazon - // Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon - // DynamoDB that didn't target a specific table. - // - // * remote - A downstream service - // of indeterminate type. + // - Amazon Web Services Resource - The type of an Amazon Web Services resource. + // For example, AWS::EC2::Instance for an application running on Amazon EC2 or + // AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. + // - Amazon Web Services Service - The type of an Amazon Web Services service. + // For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't + // target a specific table. + // - Amazon Web Services Service - The type of an Amazon Web Services service. + // For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't + // target a specific table. + // - remote - A downstream service of indeterminate type. Type *string noSmithyDocumentSerde @@ -762,7 +749,7 @@ type SamplingRule struct { // This member is required. URLPath *string - // The version of the sampling rule format (1). + // The version of the sampling rule format ( 1 ). // // This member is required. Version int32 @@ -781,9 +768,8 @@ type SamplingRule struct { noSmithyDocumentSerde } -// A SamplingRule -// (https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html) and its -// metadata. +// A SamplingRule (https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html) +// and its metadata. type SamplingRuleRecord struct { // When the rule was created. @@ -847,8 +833,8 @@ type SamplingRuleUpdate struct { // Request sampling results for a single rule from a service. Results are for the // last 10 seconds unless the service has been assigned a longer reporting interval -// after a previous call to GetSamplingTargets -// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html). +// after a previous call to GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) +// . type SamplingStatisticsDocument struct { // A unique identifier for the service in hexadecimal. @@ -918,8 +904,8 @@ type SamplingStrategy struct { // Temporary changes to a sampling rule configuration. To meet the global sampling // target for a rule, X-Ray calculates a new reservoir for each service based on -// the recent sampling results of all services that called GetSamplingTargets -// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html). +// the recent sampling results of all services that called GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) +// . type SamplingTargetDocument struct { // The percentage of matching requests to instrument, after the reservoir is @@ -943,12 +929,10 @@ type SamplingTargetDocument struct { } // A segment from a trace that has been ingested by the X-Ray service. The segment -// can be compiled from documents uploaded with PutTraceSegments -// (https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html), or an -// inferred segment for a downstream service, generated from a subsegment sent by -// the service that called it. For the full segment document schema, see Amazon Web -// Services X-Ray Segment Documents -// (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) +// can be compiled from documents uploaded with PutTraceSegments (https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html) +// , or an inferred segment for a downstream service, generated from a subsegment +// sent by the service that called it. For the full segment document schema, see +// Amazon Web Services X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) // in the Amazon Web Services X-Ray Developer Guide. type Segment struct { @@ -1003,21 +987,14 @@ type Service struct { SummaryStatistics *ServiceStatistics // The type of service. - // - // * Amazon Web Services Resource - The type of an Amazon Web - // Services resource. For example, AWS::EC2::Instance for an application running on - // Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the - // application used. - // - // * Amazon Web Services Service - The type of an Amazon Web - // Services service. For example, AWS::DynamoDB for downstream calls to Amazon - // DynamoDB that didn't target a specific table. - // - // * client - Represents the clients - // that sent requests to a root service. - // - // * remote - A downstream service of - // indeterminate type. + // - Amazon Web Services Resource - The type of an Amazon Web Services resource. + // For example, AWS::EC2::Instance for an application running on Amazon EC2 or + // AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. + // - Amazon Web Services Service - The type of an Amazon Web Services service. + // For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't + // target a specific table. + // - client - Represents the clients that sent requests to a root service. + // - remote - A downstream service of indeterminate type. Type *string noSmithyDocumentSerde @@ -1063,28 +1040,23 @@ type ServiceStatistics struct { // A map that contains tag keys and tag values to attach to an Amazon Web Services // X-Ray group or sampling rule. For more information about ways to use tags, see -// Tagging Amazon Web Services resources -// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon -// Web Services General Reference. The following restrictions apply to tags: -// -// * -// Maximum number of user-applied tags per resource: 50 -// -// * Tag keys and values are -// case sensitive. -// -// * Don't use aws: as a prefix for keys; it's reserved for Amazon -// Web Services use. You cannot edit or delete system tags. +// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// in the Amazon Web Services General Reference. The following restrictions apply +// to tags: +// - Maximum number of user-applied tags per resource: 50 +// - Tag keys and values are case sensitive. +// - Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services +// use. You cannot edit or delete system tags. type Tag struct { - // A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a + // A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a // maximum of 128 characters, and can contain only Unicode letters, numbers, or // separators, or the following special characters: + - = . _ : / // // This member is required. Key *string - // An optional tag value, such as Production or test-only. The value can be a + // An optional tag value, such as Production or test-only . The value can be a // maximum of 255 characters, and contain only Unicode letters, numbers, or // separators, or the following special characters: + - = . _ : / // @@ -1143,8 +1115,8 @@ type TimeSeriesServiceStatistics struct { // A collection of segment documents with matching trace IDs. type Trace struct { - // The length of time in seconds between the start time of the root segment and the - // end time of the last segment that completed. + // The length of time in seconds between the start time of the root segment and + // the end time of the last segment that completed. Duration *float64 // The unique identifier for the request that generated the trace's segments and @@ -1153,8 +1125,8 @@ type Trace struct { // LimitExceeded is set to true when the trace has exceeded the Trace document size // limit. For more information about this limit and other X-Ray limits and quotas, - // see Amazon Web Services X-Ray endpoints and quotas - // (https://docs.aws.amazon.com/general/latest/gr/xray.html). + // see Amazon Web Services X-Ray endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/xray.html) + // . LimitExceeded *bool // Segment documents for the segments and subsegments that comprise the trace. @@ -1172,8 +1144,8 @@ type TraceSummary struct { // A list of Availability Zones for any zone corresponding to the trace segments. AvailabilityZones []AvailabilityZoneDetail - // The length of time in seconds between the start time of the root segment and the - // end time of the last segment that completed. + // The length of time in seconds between the start time of the root segment and + // the end time of the last segment that completed. Duration *float64 // The root of a trace. @@ -1247,9 +1219,8 @@ type TraceUser struct { noSmithyDocumentSerde } -// Sampling statistics from a call to GetSamplingTargets -// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) that -// X-Ray could not process. +// Sampling statistics from a call to GetSamplingTargets (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) +// that X-Ray could not process. type UnprocessedStatistics struct { // The error code.